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 "clang/Config/config.h"
14#include "clang/Driver/CommonArgs.h"
15#include "clang/Driver/Compilation.h"
16#include "clang/Driver/SanitizerArgs.h"
17#include "clang/Options/Options.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
28void openbsd::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
29 const InputInfo &Output,
30 const InputInfoList &Inputs,
31 const ArgList &Args,
32 const char *LinkingOutput) const {
33 const auto &ToolChain = static_cast<const OpenBSD &>(getToolChain());
34 const Driver &D = ToolChain.getDriver();
35 const llvm::Triple &Triple = ToolChain.getTriple();
36 ArgStringList CmdArgs;
37
38 claimNoWarnArgs(Args);
39
40 switch (ToolChain.getArch()) {
41 case llvm::Triple::x86:
42 // When building 32-bit code on OpenBSD/amd64, we have to explicitly
43 // instruct as in the base system to assemble 32-bit code.
44 CmdArgs.push_back(Elt: "--32");
45 break;
46
47 case llvm::Triple::arm: {
48 StringRef MArch, MCPU;
49 arm::getARMArchCPUFromArgs(Args, Arch&: MArch, CPU&: MCPU, /*FromAs*/ true);
50 std::string Arch = arm::getARMTargetCPU(CPU: MCPU, Arch: MArch, Triple);
51 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-mcpu=" + Arch));
52 break;
53 }
54
55 case llvm::Triple::ppc:
56 CmdArgs.push_back(Elt: "-mppc");
57 CmdArgs.push_back(Elt: "-many");
58 break;
59
60 case llvm::Triple::sparcv9: {
61 CmdArgs.push_back(Elt: "-64");
62 std::string CPU = getCPUName(D, Args, T: Triple);
63 CmdArgs.push_back(Elt: sparc::getSparcAsmModeForCPU(Name: CPU, Triple));
64 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
65 break;
66 }
67
68 case llvm::Triple::mips64:
69 case llvm::Triple::mips64el: {
70 StringRef CPUName;
71 StringRef ABIName;
72 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
73
74 CmdArgs.push_back(Elt: "-march");
75 CmdArgs.push_back(Elt: CPUName.data());
76
77 CmdArgs.push_back(Elt: "-mabi");
78 CmdArgs.push_back(Elt: mips::getGnuCompatibleMipsABIName(ABI: ABIName).data());
79
80 if (Triple.isLittleEndian())
81 CmdArgs.push_back(Elt: "-EL");
82 else
83 CmdArgs.push_back(Elt: "-EB");
84
85 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
86 break;
87 }
88
89 default:
90 break;
91 }
92
93 Args.AddAllArgValues(Output&: CmdArgs, Id0: options::OPT_Wa_COMMA, Id1: options::OPT_Xassembler);
94
95 CmdArgs.push_back(Elt: "-o");
96 CmdArgs.push_back(Elt: Output.getFilename());
97
98 for (const auto &II : Inputs)
99 CmdArgs.push_back(Elt: II.getFilename());
100
101 const char *Exec = Args.MakeArgString(Str: ToolChain.GetProgramPath(Name: "as"));
102 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this,
103 args: ResponseFileSupport::AtFileCurCP(),
104 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
105}
106
107void openbsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
108 const InputInfo &Output,
109 const InputInfoList &Inputs,
110 const ArgList &Args,
111 const char *LinkingOutput) const {
112 const auto &ToolChain = static_cast<const OpenBSD &>(getToolChain());
113 const Driver &D = ToolChain.getDriver();
114 const llvm::Triple &Triple = ToolChain.getTriple();
115 const llvm::Triple::ArchType Arch = ToolChain.getArch();
116 const bool Static = Args.hasArg(Ids: options::OPT_static);
117 const bool Shared = Args.hasArg(Ids: options::OPT_shared);
118 const bool Profiling = Args.hasArg(Ids: options::OPT_pg);
119 const bool Pie = Args.hasArg(Ids: options::OPT_pie);
120 const bool Nopie = Args.hasArg(Ids: options::OPT_no_pie, Ids: options::OPT_nopie);
121 const bool Relocatable = Args.hasArg(Ids: options::OPT_r);
122 const bool StaticPie =
123 Static && !Shared && !Profiling && !Nopie && !Relocatable;
124 ArgStringList CmdArgs;
125
126 // Silence warning for "clang -g foo.o -o foo"
127 Args.ClaimAllArgs(Id0: options::OPT_g_Group);
128 // and "clang -emit-llvm foo.o -o foo"
129 Args.ClaimAllArgs(Id0: options::OPT_emit_llvm);
130 // and for "clang -w foo.o -o foo". Other warning options are already
131 // handled somewhere else.
132 Args.ClaimAllArgs(Id0: options::OPT_w);
133
134 if (!D.SysRoot.empty())
135 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "--sysroot=" + D.SysRoot));
136
137 if (Arch == llvm::Triple::mips64)
138 CmdArgs.push_back(Elt: "-EB");
139 else if (Arch == llvm::Triple::mips64el)
140 CmdArgs.push_back(Elt: "-EL");
141
142 if (!Args.hasArg(Ids: options::OPT_nostdlib) && !Shared && !Relocatable) {
143 CmdArgs.push_back(Elt: "-e");
144 CmdArgs.push_back(Elt: "__start");
145 }
146
147 CmdArgs.push_back(Elt: "--eh-frame-hdr");
148 if (Static) {
149 CmdArgs.push_back(Elt: "-Bstatic");
150 } else {
151 if (Args.hasArg(Ids: options::OPT_rdynamic))
152 CmdArgs.push_back(Elt: "-export-dynamic");
153 if (Shared) {
154 CmdArgs.push_back(Elt: "-shared");
155 } else if (!Relocatable) {
156 CmdArgs.push_back(Elt: "-dynamic-linker");
157 CmdArgs.push_back(Elt: "/usr/libexec/ld.so");
158 }
159 }
160
161 // OpenBSD's system linker defaults to PIE, but cross-linkers may not.
162 // Explicitly pass -pie so that rcrt0.o's reference to _DYNAMIC is resolved.
163 if (Pie || StaticPie)
164 CmdArgs.push_back(Elt: "-pie");
165 if (Nopie || Profiling)
166 CmdArgs.push_back(Elt: "-nopie");
167
168 if (Triple.isLoongArch64() || Triple.isRISCV64()) {
169 CmdArgs.push_back(Elt: "-X");
170 if (Args.hasArg(Ids: options::OPT_mno_relax))
171 CmdArgs.push_back(Elt: "--no-relax");
172 }
173
174 assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
175 if (Output.isFilename()) {
176 CmdArgs.push_back(Elt: "-o");
177 CmdArgs.push_back(Elt: Output.getFilename());
178 }
179
180 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nostartfiles,
181 Ids: options::OPT_r)) {
182 const char *crt0 = nullptr;
183 const char *crtbegin = nullptr;
184 if (!Shared) {
185 if (Profiling)
186 crt0 = "gcrt0.o";
187 else if (StaticPie)
188 crt0 = "rcrt0.o";
189 else
190 crt0 = "crt0.o";
191 crtbegin = "crtbegin.o";
192 } else {
193 crtbegin = "crtbeginS.o";
194 }
195
196 if (crt0)
197 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crt0)));
198 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crtbegin)));
199 }
200
201 Args.AddAllArgs(Output&: CmdArgs, Id0: options::OPT_L);
202 ToolChain.AddFilePathLibArgs(Args, CmdArgs);
203 Args.addAllArgs(Output&: CmdArgs,
204 Ids: {options::OPT_T_Group, options::OPT_s, options::OPT_t});
205
206 if (auto LTO = ToolChain.getLTOMode(Args); LTO != LTOK_None)
207 addLTOOptions(ToolChain, Args, CmdArgs, Output, Inputs, IsThinLTO: LTO == LTOK_Thin);
208
209 bool NeedsSanitizerDeps = addSanitizerRuntimes(TC: ToolChain, Args, CmdArgs);
210 bool NeedsXRayDeps = addXRayRuntime(TC: ToolChain, Args, CmdArgs);
211 AddLinkerInputs(TC: ToolChain, Inputs, Args, CmdArgs, JA);
212
213 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nodefaultlibs,
214 Ids: options::OPT_r)) {
215 // Use the static OpenMP runtime with -static-openmp
216 bool StaticOpenMP = Args.hasArg(Ids: options::OPT_static_openmp) && !Static;
217 addOpenMPRuntime(C, CmdArgs, TC: ToolChain, Args, ForceStaticHostRuntime: StaticOpenMP);
218
219 if (D.CCCIsCXX()) {
220 if (ToolChain.ShouldLinkCXXStdlib(Args))
221 ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
222 if (Profiling)
223 CmdArgs.push_back(Elt: "-lm_p");
224 else
225 CmdArgs.push_back(Elt: "-lm");
226 }
227
228 // Silence warnings when linking C code with a C++ '-stdlib' argument.
229 Args.ClaimAllArgs(Id0: options::OPT_stdlib_EQ);
230
231 // Additional linker set-up and flags for Fortran. This is required in order
232 // to generate executables. As Fortran runtime depends on the C runtime,
233 // these dependencies need to be listed before the C runtime below (i.e.
234 // AddRunTimeLibs).
235 if (D.IsFlangMode() &&
236 !Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nodefaultlibs)) {
237 ToolChain.addFortranRuntimeLibraryPath(Args, CmdArgs);
238 ToolChain.addFortranRuntimeLibs(Args, CmdArgs);
239 if (Profiling)
240 CmdArgs.push_back(Elt: "-lm_p");
241 else
242 CmdArgs.push_back(Elt: "-lm");
243 }
244
245 if (NeedsSanitizerDeps) {
246 CmdArgs.push_back(Elt: ToolChain.getCompilerRTArgString(Args, Component: "builtins"));
247 linkSanitizerRuntimeDeps(TC: ToolChain, Args, CmdArgs);
248 }
249 if (NeedsXRayDeps) {
250 CmdArgs.push_back(Elt: ToolChain.getCompilerRTArgString(Args, Component: "builtins"));
251 linkXRayRuntimeDeps(TC: ToolChain, Args, CmdArgs);
252 }
253 // FIXME: For some reason GCC passes -lgcc before adding
254 // the default system libraries. Just mimic this for now.
255 CmdArgs.push_back(Elt: "-lcompiler_rt");
256
257 if (Args.hasArg(Ids: options::OPT_pthread)) {
258 if (!Shared && Profiling)
259 CmdArgs.push_back(Elt: "-lpthread_p");
260 else
261 CmdArgs.push_back(Elt: "-lpthread");
262 }
263
264 if (!Shared) {
265 if (Profiling)
266 CmdArgs.push_back(Elt: "-lc_p");
267 else
268 CmdArgs.push_back(Elt: "-lc");
269 }
270
271 CmdArgs.push_back(Elt: "-lcompiler_rt");
272 }
273
274 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nostartfiles,
275 Ids: options::OPT_r)) {
276 const char *crtend = nullptr;
277 if (!Shared)
278 crtend = "crtend.o";
279 else
280 crtend = "crtendS.o";
281
282 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crtend)));
283 }
284
285 ToolChain.addProfileRTLibs(Args, CmdArgs);
286
287 const char *Exec = Args.MakeArgString(Str: ToolChain.GetLinkerPath());
288 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this,
289 args: ResponseFileSupport::AtFileCurCP(),
290 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
291}
292
293SanitizerMask
294OpenBSD::getSupportedSanitizers(BoundArch BA,
295 Action::OffloadKind DeviceOffloadKind) const {
296 const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
297 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
298 SanitizerMask Res = ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
299 if (IsX86 || IsX86_64) {
300 Res |= SanitizerKind::Vptr;
301 Res |= SanitizerKind::Fuzzer;
302 Res |= SanitizerKind::FuzzerNoLink;
303 }
304 if (IsX86_64) {
305 Res |= SanitizerKind::KernelAddress;
306 }
307 return Res;
308}
309
310/// OpenBSD - OpenBSD tool chain which can call as(1) and ld(1) directly.
311
312OpenBSD::OpenBSD(const Driver &D, const llvm::Triple &Triple,
313 const ArgList &Args)
314 : Generic_ELF(D, Triple, Args) {
315 getFilePaths().push_back(Elt: concat(Path: getDriver().SysRoot, A: "/usr/lib"));
316}
317
318void OpenBSD::AddClangSystemIncludeArgs(
319 const llvm::opt::ArgList &DriverArgs,
320 llvm::opt::ArgStringList &CC1Args) const {
321 const Driver &D = getDriver();
322
323 if (DriverArgs.hasArg(Ids: options::OPT_nostdinc))
324 return;
325
326 if (!DriverArgs.hasArg(Ids: options::OPT_nobuiltininc)) {
327 SmallString<128> Dir(D.ResourceDir);
328 llvm::sys::path::append(path&: Dir, a: "include");
329 addSystemInclude(DriverArgs, CC1Args, Path: Dir.str());
330 }
331
332 if (DriverArgs.hasArg(Ids: options::OPT_nostdlibinc))
333 return;
334
335 // Check for configure-time C include directories.
336 StringRef CIncludeDirs(C_INCLUDE_DIRS);
337 if (CIncludeDirs != "") {
338 SmallVector<StringRef, 5> dirs;
339 CIncludeDirs.split(A&: dirs, Separator: ":");
340 for (StringRef dir : dirs) {
341 StringRef Prefix =
342 llvm::sys::path::is_absolute(path: dir) ? StringRef(D.SysRoot) : "";
343 addExternCSystemInclude(DriverArgs, CC1Args, Path: Prefix + dir);
344 }
345 return;
346 }
347
348 addExternCSystemInclude(DriverArgs, CC1Args,
349 Path: concat(Path: D.SysRoot, A: "/usr/include"));
350}
351
352void OpenBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
353 llvm::opt::ArgStringList &CC1Args) const {
354 addSystemInclude(DriverArgs, CC1Args,
355 Path: concat(Path: getDriver().SysRoot, A: "/usr/include/c++/v1"));
356}
357
358void OpenBSD::AddCXXStdlibLibArgs(const ArgList &Args,
359 ArgStringList &CmdArgs) const {
360 bool Profiling = Args.hasArg(Ids: options::OPT_pg);
361
362 CmdArgs.push_back(Elt: Profiling ? "-lc++_p" : "-lc++");
363 if (Args.hasArg(Ids: options::OPT_fexperimental_library))
364 CmdArgs.push_back(Elt: "-lc++experimental");
365 CmdArgs.push_back(Elt: Profiling ? "-lc++abi_p" : "-lc++abi");
366 CmdArgs.push_back(Elt: Profiling ? "-lpthread_p" : "-lpthread");
367}
368
369std::string OpenBSD::getCompilerRT(const ArgList &Args, StringRef Component,
370 FileType Type, bool IsFortran) const {
371 if (Component == "builtins") {
372 SmallString<128> Path(getDriver().SysRoot);
373 llvm::sys::path::append(path&: Path, a: "/usr/lib/libcompiler_rt.a");
374 if (getVFS().exists(Path))
375 return std::string(Path);
376 }
377 SmallString<128> P(getDriver().ResourceDir);
378 std::string CRTBasename = buildCompilerRTBasename(
379 Args, Component, Type, /*AddArch=*/false, IsFortran);
380 llvm::sys::path::append(path&: P, a: "lib", b: CRTBasename);
381 // Checks if this is the base system case which uses a different location.
382 if (getVFS().exists(Path: P))
383 return std::string(P);
384 return ToolChain::getCompilerRT(Args, Component, Type, IsFortran);
385}
386
387Tool *OpenBSD::buildAssembler() const {
388 return new tools::openbsd::Assembler(*this);
389}
390
391Tool *OpenBSD::buildLinker() const { return new tools::openbsd::Linker(*this); }
392
393bool OpenBSD::HasNativeLLVMSupport() const { return true; }
394
395ToolChain::UnwindTableLevel
396OpenBSD::getDefaultUnwindTableLevel(const ArgList &Args) const {
397 switch (getArch()) {
398 case llvm::Triple::arm:
399 return UnwindTableLevel::None;
400 default:
401 return UnwindTableLevel::Asynchronous;
402 }
403}
404