clang 17.0.0git
OpenBSD.cpp
Go to the documentation of this file.
1//===--- OpenBSD.cpp - OpenBSD ToolChain Implementations --------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "OpenBSD.h"
10#include "Arch/ARM.h"
11#include "Arch/Mips.h"
12#include "Arch/Sparc.h"
13#include "CommonArgs.h"
14#include "clang/Config/config.h"
18#include "llvm/Option/ArgList.h"
19#include "llvm/Support/Path.h"
20#include "llvm/Support/VirtualFileSystem.h"
21
22using namespace clang::driver;
23using namespace clang::driver::tools;
24using namespace clang::driver::toolchains;
25using namespace clang;
26using namespace llvm::opt;
27
29 const InputInfo &Output,
30 const InputInfoList &Inputs,
31 const ArgList &Args,
32 const char *LinkingOutput) const {
34 static_cast<const toolchains::OpenBSD &>(getToolChain());
35 const Driver &D = ToolChain.getDriver();
36 const llvm::Triple &Triple = ToolChain.getTriple();
37
38 claimNoWarnArgs(Args);
39 ArgStringList CmdArgs;
40
41 switch (ToolChain.getArch()) {
42 case llvm::Triple::x86:
43 // When building 32-bit code on OpenBSD/amd64, we have to explicitly
44 // instruct as in the base system to assemble 32-bit code.
45 CmdArgs.push_back("--32");
46 break;
47
48 case llvm::Triple::arm:
49 case llvm::Triple::armeb: {
50 StringRef MArch, MCPU;
51 arm::getARMArchCPUFromArgs(Args, MArch, MCPU, /*FromAs*/ true);
52 std::string Arch = arm::getARMTargetCPU(MCPU, MArch, Triple);
53 CmdArgs.push_back(Args.MakeArgString("-mcpu=" + Arch));
54 break;
55 }
56
57 case llvm::Triple::ppc:
58 CmdArgs.push_back("-mppc");
59 CmdArgs.push_back("-many");
60 break;
61
62 case llvm::Triple::sparcv9: {
63 CmdArgs.push_back("-64");
64 std::string CPU = getCPUName(D, Args, Triple);
65 CmdArgs.push_back(sparc::getSparcAsmModeForCPU(CPU, Triple));
66 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
67 break;
68 }
69
70 case llvm::Triple::mips64:
71 case llvm::Triple::mips64el: {
72 StringRef CPUName;
73 StringRef ABIName;
74 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
75
76 CmdArgs.push_back("-march");
77 CmdArgs.push_back(CPUName.data());
78
79 CmdArgs.push_back("-mabi");
80 CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());
81
82 if (Triple.isLittleEndian())
83 CmdArgs.push_back("-EL");
84 else
85 CmdArgs.push_back("-EB");
86
87 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
88 break;
89 }
90
91 default:
92 break;
93 }
94
95 Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
96
97 CmdArgs.push_back("-o");
98 CmdArgs.push_back(Output.getFilename());
99
100 for (const auto &II : Inputs)
101 CmdArgs.push_back(II.getFilename());
102
103 const char *Exec = Args.MakeArgString(ToolChain.GetProgramPath("as"));
104 C.addCommand(std::make_unique<Command>(JA, *this,
106 Exec, CmdArgs, Inputs, Output));
107}
108
110 const InputInfo &Output,
111 const InputInfoList &Inputs,
112 const ArgList &Args,
113 const char *LinkingOutput) const {
115 static_cast<const toolchains::OpenBSD &>(getToolChain());
116 const Driver &D = ToolChain.getDriver();
117 const llvm::Triple::ArchType Arch = ToolChain.getArch();
118 ArgStringList CmdArgs;
119 bool Static = Args.hasArg(options::OPT_static);
120 bool Shared = Args.hasArg(options::OPT_shared);
121 bool Profiling = Args.hasArg(options::OPT_pg);
122 bool Pie = Args.hasArg(options::OPT_pie);
123 bool Nopie = Args.hasArg(options::OPT_nopie);
124
125 // Silence warning for "clang -g foo.o -o foo"
126 Args.ClaimAllArgs(options::OPT_g_Group);
127 // and "clang -emit-llvm foo.o -o foo"
128 Args.ClaimAllArgs(options::OPT_emit_llvm);
129 // and for "clang -w foo.o -o foo". Other warning options are already
130 // handled somewhere else.
131 Args.ClaimAllArgs(options::OPT_w);
132
133 if (!D.SysRoot.empty())
134 CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
135
136 if (Arch == llvm::Triple::mips64)
137 CmdArgs.push_back("-EB");
138 else if (Arch == llvm::Triple::mips64el)
139 CmdArgs.push_back("-EL");
140
141 if (!Args.hasArg(options::OPT_nostdlib) && !Shared) {
142 CmdArgs.push_back("-e");
143 CmdArgs.push_back("__start");
144 }
145
146 CmdArgs.push_back("--eh-frame-hdr");
147 if (Static) {
148 CmdArgs.push_back("-Bstatic");
149 } else {
150 if (Args.hasArg(options::OPT_rdynamic))
151 CmdArgs.push_back("-export-dynamic");
152 CmdArgs.push_back("-Bdynamic");
153 if (Shared) {
154 CmdArgs.push_back("-shared");
155 } else if (!Args.hasArg(options::OPT_r)) {
156 CmdArgs.push_back("-dynamic-linker");
157 CmdArgs.push_back("/usr/libexec/ld.so");
158 }
159 }
160
161 if (Pie)
162 CmdArgs.push_back("-pie");
163 if (Nopie || Profiling)
164 CmdArgs.push_back("-nopie");
165
166 if (Arch == llvm::Triple::riscv64)
167 CmdArgs.push_back("-X");
168
169 if (Output.isFilename()) {
170 CmdArgs.push_back("-o");
171 CmdArgs.push_back(Output.getFilename());
172 } else {
173 assert(Output.isNothing() && "Invalid output.");
174 }
175
176 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,
177 options::OPT_r)) {
178 const char *crt0 = nullptr;
179 const char *crtbegin = nullptr;
180 if (!Shared) {
181 if (Profiling)
182 crt0 = "gcrt0.o";
183 else if (Static && !Nopie)
184 crt0 = "rcrt0.o";
185 else
186 crt0 = "crt0.o";
187 crtbegin = "crtbegin.o";
188 } else {
189 crtbegin = "crtbeginS.o";
190 }
191
192 if (crt0)
193 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt0)));
194 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
195 }
196
197 Args.AddAllArgs(CmdArgs, options::OPT_L);
198 ToolChain.AddFilePathLibArgs(Args, CmdArgs);
199 Args.AddAllArgs(CmdArgs, {options::OPT_T_Group, options::OPT_e,
200 options::OPT_s, options::OPT_t,
201 options::OPT_Z_Flag, options::OPT_r});
202
203 bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
204 bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
205 AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
206
207 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,
208 options::OPT_r)) {
209 // Use the static OpenMP runtime with -static-openmp
210 bool StaticOpenMP = Args.hasArg(options::OPT_static_openmp) && !Static;
211 addOpenMPRuntime(CmdArgs, ToolChain, Args, StaticOpenMP);
212
213 if (D.CCCIsCXX()) {
215 ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
216 if (Profiling)
217 CmdArgs.push_back("-lm_p");
218 else
219 CmdArgs.push_back("-lm");
220 }
221 if (NeedsSanitizerDeps) {
222 CmdArgs.push_back(ToolChain.getCompilerRTArgString(Args, "builtins"));
224 }
225 if (NeedsXRayDeps) {
226 CmdArgs.push_back(ToolChain.getCompilerRTArgString(Args, "builtins"));
228 }
229 // FIXME: For some reason GCC passes -lgcc before adding
230 // the default system libraries. Just mimic this for now.
231 CmdArgs.push_back("-lcompiler_rt");
232
233 if (Args.hasArg(options::OPT_pthread)) {
234 if (!Shared && Profiling)
235 CmdArgs.push_back("-lpthread_p");
236 else
237 CmdArgs.push_back("-lpthread");
238 }
239
240 if (!Shared) {
241 if (Profiling)
242 CmdArgs.push_back("-lc_p");
243 else
244 CmdArgs.push_back("-lc");
245 }
246
247 CmdArgs.push_back("-lcompiler_rt");
248 }
249
250 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,
251 options::OPT_r)) {
252 const char *crtend = nullptr;
253 if (!Shared)
254 crtend = "crtend.o";
255 else
256 crtend = "crtendS.o";
257
258 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));
259 }
260
261 ToolChain.addProfileRTLibs(Args, CmdArgs);
262
263 const char *Exec = Args.MakeArgString(ToolChain.GetLinkerPath());
264 C.addCommand(std::make_unique<Command>(JA, *this,
266 Exec, CmdArgs, Inputs, Output));
267}
268
270 const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
271 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
272
273 // For future use, only UBsan at the moment
275
276 if (IsX86 || IsX86_64) {
277 Res |= SanitizerKind::Vptr;
278 Res |= SanitizerKind::Fuzzer;
279 Res |= SanitizerKind::FuzzerNoLink;
280 }
281
282 return Res;
283}
284
285/// OpenBSD - OpenBSD tool chain which can call as(1) and ld(1) directly.
286
287OpenBSD::OpenBSD(const Driver &D, const llvm::Triple &Triple,
288 const ArgList &Args)
289 : Generic_ELF(D, Triple, Args) {
290 getFilePaths().push_back(concat(getDriver().SysRoot, "/usr/lib"));
291}
292
294 const llvm::opt::ArgList &DriverArgs,
295 llvm::opt::ArgStringList &CC1Args) const {
296 const Driver &D = getDriver();
297
298 if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
299 return;
300
301 if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
303 llvm::sys::path::append(Dir, "include");
304 addSystemInclude(DriverArgs, CC1Args, Dir.str());
305 }
306
307 if (DriverArgs.hasArg(options::OPT_nostdlibinc))
308 return;
309
310 // Check for configure-time C include directories.
311 StringRef CIncludeDirs(C_INCLUDE_DIRS);
312 if (CIncludeDirs != "") {
314 CIncludeDirs.split(dirs, ":");
315 for (StringRef dir : dirs) {
316 StringRef Prefix =
317 llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : "";
318 addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
319 }
320 return;
321 }
322
323 addExternCSystemInclude(DriverArgs, CC1Args,
324 concat(D.SysRoot, "/usr/include"));
325}
326
327void OpenBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
328 llvm::opt::ArgStringList &CC1Args) const {
329 addSystemInclude(DriverArgs, CC1Args,
330 concat(getDriver().SysRoot, "/usr/include/c++/v1"));
331}
332
333void OpenBSD::AddCXXStdlibLibArgs(const ArgList &Args,
334 ArgStringList &CmdArgs) const {
335 bool Profiling = Args.hasArg(options::OPT_pg);
336
337 CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");
338 if (Args.hasArg(options::OPT_fexperimental_library))
339 CmdArgs.push_back("-lc++experimental");
340 CmdArgs.push_back(Profiling ? "-lc++abi_p" : "-lc++abi");
341 CmdArgs.push_back(Profiling ? "-lpthread_p" : "-lpthread");
342}
343
344std::string OpenBSD::getCompilerRT(const ArgList &Args, StringRef Component,
345 FileType Type) const {
346 if (Component == "builtins") {
347 SmallString<128> Path(getDriver().SysRoot);
348 llvm::sys::path::append(Path, "/usr/lib/libcompiler_rt.a");
349 return std::string(Path.str());
350 }
351 SmallString<128> P(getDriver().ResourceDir);
352 std::string CRTBasename =
353 buildCompilerRTBasename(Args, Component, Type, /*AddArch=*/false);
354 llvm::sys::path::append(P, "lib", CRTBasename);
355 // Checks if this is the base system case which uses a different location.
356 if (getVFS().exists(P))
357 return std::string(P.str());
358 return ToolChain::getCompilerRT(Args, Component, Type);
359}
360
362 return new tools::openbsd::Assembler(*this);
363}
364
365Tool *OpenBSD::buildLinker() const { return new tools::openbsd::Linker(*this); }
366
367bool OpenBSD::HasNativeLLVMSupport() const { return true; }
368
370OpenBSD::getDefaultUnwindTableLevel(const ArgList &Args) const {
371 switch (getArch()) {
372 case llvm::Triple::arm:
374 default:
376 }
377}
StringRef P
The base class of the type hierarchy.
Definition: Type.h:1566
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
std::string SysRoot
sysroot, if present
Definition: Driver.h:183
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:167
bool CCCIsCXX() const
Whether the driver should follow g++ like behavior.
Definition: Driver.h:216
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getFilename() const
Definition: InputInfo.h:83
bool isNothing() const
Definition: InputInfo.h:74
bool isFilename() const
Definition: InputInfo.h:75
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
Definition: ToolChain.cpp:969
const char * getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:566
bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const
Returns if the C++ standard library should be linked in.
Definition: ToolChain.cpp:1071
static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory with extern "C" semantics to CC1 arguments.
Definition: ToolChain.cpp:984
std::string GetFilePath(const char *Name) const
Definition: ToolChain.cpp:660
path_list & getFilePaths()
Definition: ToolChain.h:278
llvm::Triple::ArchType getArch() const
Definition: ToolChain.h:252
const Driver & getDriver() const
Definition: ToolChain.h:236
static std::string concat(StringRef Path, const Twine &A, const Twine &B="", const Twine &C="", const Twine &D="")
Definition: ToolChain.cpp:1008
llvm::vfs::FileSystem & getVFS() const
Definition: ToolChain.cpp:127
virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition: ToolChain.cpp:1077
const llvm::Triple & getTriple() const
Definition: ToolChain.h:238
virtual void addProfileRTLibs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass a suitable profile runtime ...
Definition: ToolChain.cpp:873
virtual std::string buildCompilerRTBasename(const llvm::opt::ArgList &Args, StringRef Component, FileType Type, bool AddArch) const
Definition: ToolChain.cpp:511
std::string GetLinkerPath(bool *LinkerIsLLD=nullptr) const
Returns the linker path, respecting the -fuse-ld= argument to determine the linker suffix or name.
Definition: ToolChain.cpp:668
virtual std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:545
std::string GetProgramPath(const char *Name) const
Definition: ToolChain.cpp:664
void AddFilePathLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
Definition: ToolChain.cpp:1096
virtual SanitizerMask getSupportedSanitizers() const
Return sanitizers which are available in this toolchain.
Definition: ToolChain.cpp:1144
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const ToolChain & getToolChain() const
Definition: Tool.h:52
void addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Definition: OpenBSD.cpp:327
OpenBSD(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
OpenBSD - OpenBSD tool chain which can call as(1) and ld(1) directly.
Definition: OpenBSD.cpp:287
bool HasNativeLLVMSupport() const override
HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support.
Definition: OpenBSD.cpp:367
void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition: OpenBSD.cpp:333
UnwindTableLevel getDefaultUnwindTableLevel(const llvm::opt::ArgList &Args) const override
How detailed should the unwind tables be by default.
Definition: OpenBSD.cpp:370
Tool * buildAssembler() const override
Definition: OpenBSD.cpp:361
Tool * buildLinker() const override
Definition: OpenBSD.cpp:365
SanitizerMask getSupportedSanitizers() const override
Return sanitizers which are available in this toolchain.
Definition: OpenBSD.cpp:269
std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const override
Definition: OpenBSD.cpp:344
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: OpenBSD.cpp:293
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: OpenBSD.cpp:28
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: OpenBSD.cpp:109
void getARMArchCPUFromArgs(const llvm::opt::ArgList &Args, llvm::StringRef &Arch, llvm::StringRef &CPU, bool FromAs=false)
std::string getARMTargetCPU(StringRef CPU, llvm::StringRef Arch, const llvm::Triple &Triple)
StringRef getGnuCompatibleMipsABIName(StringRef ABI)
Definition: Mips.cpp:137
void getMipsCPUAndABI(const llvm::opt::ArgList &Args, const llvm::Triple &Triple, StringRef &CPUName, StringRef &ABIName)
const char * getSparcAsmModeForCPU(llvm::StringRef Name, const llvm::Triple &Triple)
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
void linkXRayRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void AddAssemblerKPIC(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool addOpenMPRuntime(llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC, const llvm::opt::ArgList &Args, bool ForceStaticHostRuntime=false, bool IsOffloadingHost=false, bool GompNeedsRT=false)
Returns true, if an OpenMP runtime has been added.
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
@ C
Languages that the frontend can parse and compile.
static constexpr ResponseFileSupport AtFileCurCP()
Definition: Job.h:92