1//===--- FreeBSD.cpp - FreeBSD 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 "FreeBSD.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/VirtualFileSystem.h"
20
21using namespace clang::driver;
22using namespace clang::driver::tools;
23using namespace clang::driver::toolchains;
24using namespace clang;
25using namespace llvm::opt;
26
27void freebsd::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
28 const InputInfo &Output,
29 const InputInfoList &Inputs,
30 const ArgList &Args,
31 const char *LinkingOutput) const {
32 const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain());
33 const auto &D = getToolChain().getDriver();
34 const llvm::Triple &Triple = ToolChain.getTriple();
35 ArgStringList CmdArgs;
36
37 claimNoWarnArgs(Args);
38
39 // When building 32-bit code on FreeBSD/amd64, we have to explicitly
40 // instruct as in the base system to assemble 32-bit code.
41 switch (ToolChain.getArch()) {
42 default:
43 break;
44 case llvm::Triple::x86:
45 CmdArgs.push_back(Elt: "--32");
46 break;
47 case llvm::Triple::ppc:
48 case llvm::Triple::ppcle:
49 CmdArgs.push_back(Elt: "-a32");
50 break;
51 case llvm::Triple::mips:
52 case llvm::Triple::mipsel:
53 case llvm::Triple::mips64:
54 case llvm::Triple::mips64el: {
55 StringRef CPUName;
56 StringRef ABIName;
57 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
58
59 CmdArgs.push_back(Elt: "-march");
60 CmdArgs.push_back(Elt: CPUName.data());
61
62 CmdArgs.push_back(Elt: "-mabi");
63 CmdArgs.push_back(Elt: mips::getGnuCompatibleMipsABIName(ABI: ABIName).data());
64
65 if (Triple.isLittleEndian())
66 CmdArgs.push_back(Elt: "-EL");
67 else
68 CmdArgs.push_back(Elt: "-EB");
69
70 if (Arg *A = Args.getLastArg(Ids: options::OPT_G)) {
71 StringRef v = A->getValue();
72 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-G" + v));
73 A->claim();
74 }
75
76 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
77 break;
78 }
79 case llvm::Triple::arm:
80 case llvm::Triple::armeb:
81 case llvm::Triple::thumb:
82 case llvm::Triple::thumbeb: {
83 arm::FloatABI ABI = arm::getARMFloatABI(TC: ToolChain, Args);
84
85 if (ABI == arm::FloatABI::Hard)
86 CmdArgs.push_back(Elt: "-mfpu=vfp");
87 else
88 CmdArgs.push_back(Elt: "-mfpu=softvfp");
89
90 CmdArgs.push_back(Elt: "-meabi=5");
91 break;
92 }
93 case llvm::Triple::sparcv9: {
94 std::string CPU = getCPUName(D, Args, T: Triple);
95 CmdArgs.push_back(Elt: sparc::getSparcAsmModeForCPU(Name: CPU, Triple));
96 AddAssemblerKPIC(ToolChain, Args, CmdArgs);
97 break;
98 }
99 }
100
101 for (const Arg *A : Args.filtered(Ids: options::OPT_ffile_prefix_map_EQ,
102 Ids: options::OPT_fdebug_prefix_map_EQ)) {
103 StringRef Map = A->getValue();
104 if (!Map.contains(C: '='))
105 D.Diag(DiagID: diag::err_drv_invalid_argument_to_option)
106 << Map << A->getOption().getName();
107 else {
108 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "--debug-prefix-map"));
109 CmdArgs.push_back(Elt: Args.MakeArgString(Str: Map));
110 }
111 A->claim();
112 }
113
114 Args.AddAllArgValues(Output&: CmdArgs, Id0: options::OPT_Wa_COMMA, Id1: options::OPT_Xassembler);
115
116 CmdArgs.push_back(Elt: "-o");
117 CmdArgs.push_back(Elt: Output.getFilename());
118
119 for (const auto &II : Inputs)
120 CmdArgs.push_back(Elt: II.getFilename());
121
122 const char *Exec = Args.MakeArgString(Str: ToolChain.GetProgramPath(Name: "as"));
123 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this,
124 args: ResponseFileSupport::AtFileCurCP(),
125 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
126}
127
128void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
129 const InputInfo &Output,
130 const InputInfoList &Inputs,
131 const ArgList &Args,
132 const char *LinkingOutput) const {
133 const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain());
134 const Driver &D = ToolChain.getDriver();
135 const llvm::Triple &Triple = ToolChain.getTriple();
136 const llvm::Triple::ArchType Arch = ToolChain.getArch();
137 ArgStringList CmdArgs;
138
139 // Silence warning for "clang -g foo.o -o foo"
140 Args.ClaimAllArgs(Id0: options::OPT_g_Group);
141 // and "clang -emit-llvm foo.o -o foo"
142 Args.ClaimAllArgs(Id0: options::OPT_emit_llvm);
143 // and for "clang -w foo.o -o foo". Other warning options are already
144 // handled somewhere else.
145 Args.ClaimAllArgs(Id0: options::OPT_w);
146
147 if (!D.SysRoot.empty())
148 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "--sysroot=" + D.SysRoot));
149
150 CmdArgs.push_back(Elt: "--eh-frame-hdr");
151
152 // Explicitly set the linker emulation for platforms that might not
153 // be the default emulation for the linker.
154 switch (Arch) {
155 case llvm::Triple::x86:
156 CmdArgs.push_back(Elt: "-m");
157 CmdArgs.push_back(Elt: "elf_i386_fbsd");
158 break;
159 case llvm::Triple::ppc:
160 CmdArgs.push_back(Elt: "-m");
161 CmdArgs.push_back(Elt: "elf32ppc_fbsd");
162 break;
163 case llvm::Triple::ppcle:
164 CmdArgs.push_back(Elt: "-m");
165 // Use generic -- only usage is for freestanding.
166 CmdArgs.push_back(Elt: "elf32lppc");
167 break;
168 case llvm::Triple::mips:
169 CmdArgs.push_back(Elt: "-m");
170 CmdArgs.push_back(Elt: "elf32btsmip_fbsd");
171 break;
172 case llvm::Triple::mipsel:
173 CmdArgs.push_back(Elt: "-m");
174 CmdArgs.push_back(Elt: "elf32ltsmip_fbsd");
175 break;
176 case llvm::Triple::mips64:
177 CmdArgs.push_back(Elt: "-m");
178 if (tools::mips::hasMipsAbiArg(Args, Value: "n32"))
179 CmdArgs.push_back(Elt: "elf32btsmipn32_fbsd");
180 else
181 CmdArgs.push_back(Elt: "elf64btsmip_fbsd");
182 break;
183 case llvm::Triple::mips64el:
184 CmdArgs.push_back(Elt: "-m");
185 if (tools::mips::hasMipsAbiArg(Args, Value: "n32"))
186 CmdArgs.push_back(Elt: "elf32ltsmipn32_fbsd");
187 else
188 CmdArgs.push_back(Elt: "elf64ltsmip_fbsd");
189 break;
190 case llvm::Triple::riscv64:
191 CmdArgs.push_back(Elt: "-m");
192 CmdArgs.push_back(Elt: "elf64lriscv");
193 break;
194 case llvm::Triple::loongarch64:
195 CmdArgs.push_back(Elt: "-m");
196 CmdArgs.push_back(Elt: "elf64loongarch");
197 break;
198 default:
199 break;
200 }
201
202 if (Triple.isLoongArch64() || Triple.isRISCV64()) {
203 CmdArgs.push_back(Elt: "-X");
204 if (Args.hasArg(Ids: options::OPT_mno_relax))
205 CmdArgs.push_back(Elt: "--no-relax");
206 }
207
208 const bool IsShared = Args.hasArg(Ids: options::OPT_shared);
209 if (IsShared)
210 CmdArgs.push_back(Elt: "-shared");
211 bool IsPIE = false;
212 if (Args.hasArg(Ids: options::OPT_static)) {
213 CmdArgs.push_back(Elt: "-static");
214 } else if (!Args.hasArg(Ids: options::OPT_r)) {
215 if (Args.hasArg(Ids: options::OPT_rdynamic))
216 CmdArgs.push_back(Elt: "-export-dynamic");
217 if (!IsShared) {
218 IsPIE = Args.hasFlag(Pos: options::OPT_pie, Neg: options::OPT_no_pie,
219 Default: ToolChain.isPIEDefault(Args));
220 if (IsPIE)
221 CmdArgs.push_back(Elt: "-pie");
222 CmdArgs.push_back(Elt: "-dynamic-linker");
223 CmdArgs.push_back(Elt: "/libexec/ld-elf.so.1");
224 }
225 if (Arch == llvm::Triple::arm || Triple.isX86())
226 CmdArgs.push_back(Elt: "--hash-style=both");
227 }
228
229 if (Arg *A = Args.getLastArg(Ids: options::OPT_G)) {
230 if (ToolChain.getTriple().isMIPS()) {
231 StringRef v = A->getValue();
232 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-G" + v));
233 A->claim();
234 }
235 }
236
237 assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
238 if (Output.isFilename()) {
239 CmdArgs.push_back(Elt: "-o");
240 CmdArgs.push_back(Elt: Output.getFilename());
241 }
242
243 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nostartfiles,
244 Ids: options::OPT_r)) {
245 const char *crt1 = nullptr;
246 if (!Args.hasArg(Ids: options::OPT_shared)) {
247 if (Args.hasArg(Ids: options::OPT_pg))
248 crt1 = "gcrt1.o";
249 else if (IsPIE)
250 crt1 = "Scrt1.o";
251 else
252 crt1 = "crt1.o";
253 }
254 if (crt1)
255 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crt1)));
256
257 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: "crti.o")));
258
259 const char *crtbegin = nullptr;
260 if (Args.hasArg(Ids: options::OPT_static))
261 crtbegin = "crtbeginT.o";
262 else if (Args.hasArg(Ids: options::OPT_shared) || IsPIE)
263 crtbegin = "crtbeginS.o";
264 else
265 crtbegin = "crtbegin.o";
266
267 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crtbegin)));
268 }
269
270 Args.AddAllArgs(Output&: CmdArgs, Id0: options::OPT_L);
271 ToolChain.AddFilePathLibArgs(Args, CmdArgs);
272 Args.addAllArgs(Output&: CmdArgs,
273 Ids: {options::OPT_T_Group, options::OPT_s, options::OPT_t});
274
275 if (auto LTO = ToolChain.getLTOMode(Args); LTO != LTOK_None)
276 addLTOOptions(ToolChain, Args, CmdArgs, Output, Inputs, IsThinLTO: LTO == LTOK_Thin);
277
278 bool NeedsSanitizerDeps = addSanitizerRuntimes(TC: ToolChain, Args, CmdArgs);
279 bool NeedsXRayDeps = addXRayRuntime(TC: ToolChain, Args, CmdArgs);
280 addLinkerCompressDebugSectionsOption(TC: ToolChain, Args, CmdArgs);
281 AddLinkerInputs(TC: ToolChain, Inputs, Args, CmdArgs, JA);
282
283 unsigned Major = ToolChain.getTriple().getOSMajorVersion();
284 bool Profiling = Args.hasArg(Ids: options::OPT_pg) && Major != 0 && Major < 14;
285 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nodefaultlibs,
286 Ids: options::OPT_r)) {
287 // Use the static OpenMP runtime with -static-openmp
288 bool StaticOpenMP = Args.hasArg(Ids: options::OPT_static_openmp) &&
289 !Args.hasArg(Ids: options::OPT_static);
290 addOpenMPRuntime(C, CmdArgs, TC: ToolChain, Args, ForceStaticHostRuntime: StaticOpenMP);
291
292 if (D.CCCIsCXX()) {
293 if (ToolChain.ShouldLinkCXXStdlib(Args))
294 ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
295 if (Profiling)
296 CmdArgs.push_back(Elt: "-lm_p");
297 else
298 CmdArgs.push_back(Elt: "-lm");
299 }
300
301 // Silence warnings when linking C code with a C++ '-stdlib' argument.
302 Args.ClaimAllArgs(Id0: options::OPT_stdlib_EQ);
303
304 // Additional linker set-up and flags for Fortran. This is required in order
305 // to generate executables. As Fortran runtime depends on the C runtime,
306 // these dependencies need to be listed before the C runtime below (i.e.
307 // AddRunTimeLibs).
308 if (D.IsFlangMode() &&
309 !Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nodefaultlibs)) {
310 ToolChain.addFortranRuntimeLibraryPath(Args, CmdArgs);
311 ToolChain.addFortranRuntimeLibs(Args, CmdArgs);
312 if (Profiling)
313 CmdArgs.push_back(Elt: "-lm_p");
314 else
315 CmdArgs.push_back(Elt: "-lm");
316 }
317
318 if (NeedsSanitizerDeps)
319 linkSanitizerRuntimeDeps(TC: ToolChain, Args, CmdArgs);
320 if (NeedsXRayDeps)
321 linkXRayRuntimeDeps(TC: ToolChain, Args, CmdArgs);
322 // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding
323 // the default system libraries. Just mimic this for now.
324 if (Profiling)
325 CmdArgs.push_back(Elt: "-lgcc_p");
326 else
327 CmdArgs.push_back(Elt: "-lgcc");
328 if (Args.hasArg(Ids: options::OPT_static)) {
329 CmdArgs.push_back(Elt: "-lgcc_eh");
330 } else if (Profiling) {
331 CmdArgs.push_back(Elt: "-lgcc_eh_p");
332 } else {
333 CmdArgs.push_back(Elt: "--as-needed");
334 CmdArgs.push_back(Elt: "-lgcc_s");
335 CmdArgs.push_back(Elt: "--no-as-needed");
336 }
337
338 if (Args.hasArg(Ids: options::OPT_pthread)) {
339 if (Profiling)
340 CmdArgs.push_back(Elt: "-lpthread_p");
341 else
342 CmdArgs.push_back(Elt: "-lpthread");
343 }
344
345 if (Profiling) {
346 if (Args.hasArg(Ids: options::OPT_shared))
347 CmdArgs.push_back(Elt: "-lc");
348 else
349 CmdArgs.push_back(Elt: "-lc_p");
350 CmdArgs.push_back(Elt: "-lgcc_p");
351 } else {
352 CmdArgs.push_back(Elt: "-lc");
353 CmdArgs.push_back(Elt: "-lgcc");
354 }
355
356 if (Args.hasArg(Ids: options::OPT_static)) {
357 CmdArgs.push_back(Elt: "-lgcc_eh");
358 } else if (Profiling) {
359 CmdArgs.push_back(Elt: "-lgcc_eh_p");
360 } else {
361 CmdArgs.push_back(Elt: "--as-needed");
362 CmdArgs.push_back(Elt: "-lgcc_s");
363 CmdArgs.push_back(Elt: "--no-as-needed");
364 }
365 }
366
367 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nostartfiles,
368 Ids: options::OPT_r)) {
369 const char *crtend = nullptr;
370 if (Args.hasArg(Ids: options::OPT_shared) || IsPIE)
371 crtend = "crtendS.o";
372 else
373 crtend = "crtend.o";
374 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: crtend)));
375 CmdArgs.push_back(Elt: Args.MakeArgString(Str: ToolChain.GetFilePath(Name: "crtn.o")));
376 }
377
378 ToolChain.addProfileRTLibs(Args, CmdArgs);
379
380 const char *Exec = Args.MakeArgString(Str: getToolChain().GetLinkerPath());
381 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this,
382 args: ResponseFileSupport::AtFileCurCP(),
383 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
384}
385
386/// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly.
387
388FreeBSD::FreeBSD(const Driver &D, const llvm::Triple &Triple,
389 const ArgList &Args)
390 : Generic_ELF(D, Triple, Args) {
391
392 // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall
393 // back to '/usr/lib' if it doesn't exist.
394 if (Triple.isArch32Bit() &&
395 D.getVFS().exists(Path: concat(Path: getDriver().SysRoot, A: "/usr/lib32/crt1.o")))
396 getFilePaths().push_back(Elt: concat(Path: getDriver().SysRoot, A: "/usr/lib32"));
397 else
398 getFilePaths().push_back(Elt: concat(Path: getDriver().SysRoot, A: "/usr/lib"));
399}
400
401void FreeBSD::AddClangSystemIncludeArgs(
402 const llvm::opt::ArgList &DriverArgs,
403 llvm::opt::ArgStringList &CC1Args) const {
404 const Driver &D = getDriver();
405
406 if (DriverArgs.hasArg(Ids: options::OPT_nostdinc))
407 return;
408
409 if (!DriverArgs.hasArg(Ids: options::OPT_nobuiltininc)) {
410 SmallString<128> Dir(D.ResourceDir);
411 llvm::sys::path::append(path&: Dir, a: "include");
412 addSystemInclude(DriverArgs, CC1Args, Path: Dir.str());
413 }
414
415 if (DriverArgs.hasArg(Ids: options::OPT_nostdlibinc))
416 return;
417
418 // Check for configure-time C include directories.
419 StringRef CIncludeDirs(C_INCLUDE_DIRS);
420 if (CIncludeDirs != "") {
421 SmallVector<StringRef, 5> dirs;
422 CIncludeDirs.split(A&: dirs, Separator: ":");
423 for (StringRef dir : dirs) {
424 StringRef Prefix =
425 llvm::sys::path::is_absolute(path: dir) ? StringRef(D.SysRoot) : "";
426 addExternCSystemInclude(DriverArgs, CC1Args, Path: Prefix + dir);
427 }
428 return;
429 }
430
431 addExternCSystemInclude(DriverArgs, CC1Args,
432 Path: concat(Path: D.SysRoot, A: "/usr/include"));
433}
434
435void FreeBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
436 llvm::opt::ArgStringList &CC1Args) const {
437 addSystemInclude(DriverArgs, CC1Args,
438 Path: concat(Path: getDriver().SysRoot, A: "/usr/include/c++/v1"));
439}
440
441void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args,
442 ArgStringList &CmdArgs) const {
443 Generic_ELF::AddCXXStdlibLibArgs(Args, CmdArgs);
444 unsigned Major = getTriple().getOSMajorVersion();
445 bool SuffixedLib = Args.hasArg(Ids: options::OPT_pg) && Major != 0 && Major < 14;
446 if (SuffixedLib && GetCXXStdlibType(Args) == CST_Libcxx)
447 std::replace_if(
448 first: CmdArgs.begin(), last: CmdArgs.end(),
449 pred: [](const char *S) { return StringRef(S) == "-lc++"; }, new_value: "-lc++_p");
450}
451
452void FreeBSD::AddCudaIncludeArgs(const ArgList &DriverArgs,
453 ArgStringList &CC1Args) const {
454 CudaInstallation->AddCudaIncludeArgs(DriverArgs, CC1Args);
455}
456
457void FreeBSD::AddHIPIncludeArgs(const ArgList &DriverArgs,
458 ArgStringList &CC1Args) const {
459 RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args);
460}
461
462Tool *FreeBSD::buildAssembler() const {
463 return new tools::freebsd::Assembler(*this);
464}
465
466Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); }
467
468bool FreeBSD::HasNativeLLVMSupport() const { return true; }
469
470ToolChain::UnwindTableLevel
471FreeBSD::getDefaultUnwindTableLevel(const ArgList &Args) const {
472 return UnwindTableLevel::Asynchronous;
473}
474
475bool FreeBSD::isPIEDefault(const llvm::opt::ArgList &Args) const {
476 // The FreeBSD base system builds with PIE by default since 13.1.
477 VersionTuple OSVersion = getTriple().getOSVersion();
478 if (OSVersion.getMajor() != 0 && OSVersion < VersionTuple(13, 1))
479 return getSanitizerArgs(JobArgs: Args).requiresPIE();
480 return true;
481}
482
483SanitizerMask
484FreeBSD::getSupportedSanitizers(BoundArch BA,
485 Action::OffloadKind DeviceOffloadKind) const {
486 const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64;
487 const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
488 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
489 const bool IsMIPS64 = getTriple().isMIPS64();
490 SanitizerMask Res = ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
491 Res |= SanitizerKind::Address;
492 Res |= SanitizerKind::PointerCompare;
493 Res |= SanitizerKind::PointerSubtract;
494 Res |= SanitizerKind::Vptr;
495 if (IsAArch64 || IsX86_64 || IsMIPS64) {
496 Res |= SanitizerKind::Leak;
497 Res |= SanitizerKind::Thread;
498 }
499 if (IsAArch64 || IsX86 || IsX86_64) {
500 Res |= SanitizerKind::SafeStack;
501 Res |= SanitizerKind::Fuzzer;
502 Res |= SanitizerKind::FuzzerNoLink;
503 }
504 if (IsAArch64 || IsX86_64) {
505 Res |= SanitizerKind::KernelAddress;
506 Res |= SanitizerKind::KernelMemory;
507 Res |= SanitizerKind::Memory;
508 }
509 return Res;
510}
511