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 "CommonArgs.h"
14 #include "clang/Driver/Compilation.h"
15 #include "clang/Driver/DriverDiagnostic.h"
16 #include "clang/Driver/Options.h"
17 #include "clang/Driver/SanitizerArgs.h"
18 #include "llvm/Option/ArgList.h"
19 #include "llvm/Support/VirtualFileSystem.h"
20 
21 using namespace clang::driver;
22 using namespace clang::driver::tools;
23 using namespace clang::driver::toolchains;
24 using namespace clang;
25 using namespace llvm::opt;
26 
27 void 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   claimNoWarnArgs(Args);
33   ArgStringList CmdArgs;
34   const auto &D = getToolChain().getDriver();
35 
36   // When building 32-bit code on FreeBSD/amd64, we have to explicitly
37   // instruct as in the base system to assemble 32-bit code.
38   switch (getToolChain().getArch()) {
39   default:
40     break;
41   case llvm::Triple::x86:
42     CmdArgs.push_back("--32");
43     break;
44   case llvm::Triple::ppc:
45     CmdArgs.push_back("-a32");
46     break;
47   case llvm::Triple::mips:
48   case llvm::Triple::mipsel:
49   case llvm::Triple::mips64:
50   case llvm::Triple::mips64el: {
51     StringRef CPUName;
52     StringRef ABIName;
53     mips::getMipsCPUAndABI(Args, getToolChain().getTriple(), CPUName, ABIName);
54 
55     CmdArgs.push_back("-march");
56     CmdArgs.push_back(CPUName.data());
57 
58     CmdArgs.push_back("-mabi");
59     CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());
60 
61     if (getToolChain().getTriple().isLittleEndian())
62       CmdArgs.push_back("-EL");
63     else
64       CmdArgs.push_back("-EB");
65 
66     if (Arg *A = Args.getLastArg(options::OPT_G)) {
67       StringRef v = A->getValue();
68       CmdArgs.push_back(Args.MakeArgString("-G" + v));
69       A->claim();
70     }
71 
72     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
73     break;
74   }
75   case llvm::Triple::arm:
76   case llvm::Triple::armeb:
77   case llvm::Triple::thumb:
78   case llvm::Triple::thumbeb: {
79     arm::FloatABI ABI = arm::getARMFloatABI(getToolChain(), Args);
80 
81     if (ABI == arm::FloatABI::Hard)
82       CmdArgs.push_back("-mfpu=vfp");
83     else
84       CmdArgs.push_back("-mfpu=softvfp");
85 
86     switch (getToolChain().getTriple().getEnvironment()) {
87     case llvm::Triple::GNUEABIHF:
88     case llvm::Triple::GNUEABI:
89     case llvm::Triple::EABI:
90       CmdArgs.push_back("-meabi=5");
91       break;
92 
93     default:
94       CmdArgs.push_back("-matpcs");
95     }
96     break;
97   }
98   case llvm::Triple::sparc:
99   case llvm::Triple::sparcel:
100   case llvm::Triple::sparcv9: {
101     std::string CPU = getCPUName(Args, getToolChain().getTriple());
102     CmdArgs.push_back(
103         sparc::getSparcAsmModeForCPU(CPU, getToolChain().getTriple()));
104     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
105     break;
106   }
107   }
108 
109   for (const Arg *A : Args.filtered(options::OPT_ffile_prefix_map_EQ,
110                                     options::OPT_fdebug_prefix_map_EQ)) {
111     StringRef Map = A->getValue();
112     if (Map.find('=') == StringRef::npos)
113       D.Diag(diag::err_drv_invalid_argument_to_option)
114           << Map << A->getOption().getName();
115     else {
116       CmdArgs.push_back(Args.MakeArgString("--debug-prefix-map"));
117       CmdArgs.push_back(Args.MakeArgString(Map));
118     }
119     A->claim();
120   }
121 
122   Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
123 
124   CmdArgs.push_back("-o");
125   CmdArgs.push_back(Output.getFilename());
126 
127   for (const auto &II : Inputs)
128     CmdArgs.push_back(II.getFilename());
129 
130   const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
131   C.addCommand(std::make_unique<Command>(JA, *this,
132                                          ResponseFileSupport::AtFileCurCP(),
133                                          Exec, CmdArgs, Inputs, Output));
134 }
135 
136 void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
137                                    const InputInfo &Output,
138                                    const InputInfoList &Inputs,
139                                    const ArgList &Args,
140                                    const char *LinkingOutput) const {
141   const toolchains::FreeBSD &ToolChain =
142       static_cast<const toolchains::FreeBSD &>(getToolChain());
143   const Driver &D = ToolChain.getDriver();
144   const llvm::Triple::ArchType Arch = ToolChain.getArch();
145   const bool IsPIE =
146       !Args.hasArg(options::OPT_shared) &&
147       (Args.hasArg(options::OPT_pie) || ToolChain.isPIEDefault());
148   ArgStringList CmdArgs;
149 
150   // Silence warning for "clang -g foo.o -o foo"
151   Args.ClaimAllArgs(options::OPT_g_Group);
152   // and "clang -emit-llvm foo.o -o foo"
153   Args.ClaimAllArgs(options::OPT_emit_llvm);
154   // and for "clang -w foo.o -o foo". Other warning options are already
155   // handled somewhere else.
156   Args.ClaimAllArgs(options::OPT_w);
157 
158   if (!D.SysRoot.empty())
159     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
160 
161   if (IsPIE)
162     CmdArgs.push_back("-pie");
163 
164   CmdArgs.push_back("--eh-frame-hdr");
165   if (Args.hasArg(options::OPT_static)) {
166     CmdArgs.push_back("-Bstatic");
167   } else {
168     if (Args.hasArg(options::OPT_rdynamic))
169       CmdArgs.push_back("-export-dynamic");
170     if (Args.hasArg(options::OPT_shared)) {
171       CmdArgs.push_back("-Bshareable");
172     } else {
173       CmdArgs.push_back("-dynamic-linker");
174       CmdArgs.push_back("/libexec/ld-elf.so.1");
175     }
176     const llvm::Triple &T = ToolChain.getTriple();
177     if (T.getOSMajorVersion() >= 9) {
178       if (Arch == llvm::Triple::arm || Arch == llvm::Triple::sparc || T.isX86())
179         CmdArgs.push_back("--hash-style=both");
180     }
181     CmdArgs.push_back("--enable-new-dtags");
182   }
183 
184   // Explicitly set the linker emulation for platforms that might not
185   // be the default emulation for the linker.
186   switch (Arch) {
187   case llvm::Triple::x86:
188     CmdArgs.push_back("-m");
189     CmdArgs.push_back("elf_i386_fbsd");
190     break;
191   case llvm::Triple::ppc:
192     CmdArgs.push_back("-m");
193     CmdArgs.push_back("elf32ppc_fbsd");
194     break;
195   case llvm::Triple::mips:
196     CmdArgs.push_back("-m");
197     CmdArgs.push_back("elf32btsmip_fbsd");
198     break;
199   case llvm::Triple::mipsel:
200     CmdArgs.push_back("-m");
201     CmdArgs.push_back("elf32ltsmip_fbsd");
202     break;
203   case llvm::Triple::mips64:
204     CmdArgs.push_back("-m");
205     if (tools::mips::hasMipsAbiArg(Args, "n32"))
206       CmdArgs.push_back("elf32btsmipn32_fbsd");
207     else
208       CmdArgs.push_back("elf64btsmip_fbsd");
209     break;
210   case llvm::Triple::mips64el:
211     CmdArgs.push_back("-m");
212     if (tools::mips::hasMipsAbiArg(Args, "n32"))
213       CmdArgs.push_back("elf32ltsmipn32_fbsd");
214     else
215       CmdArgs.push_back("elf64ltsmip_fbsd");
216     break;
217   case llvm::Triple::riscv32:
218     CmdArgs.push_back("-m");
219     CmdArgs.push_back("elf32lriscv");
220     break;
221   case llvm::Triple::riscv64:
222     CmdArgs.push_back("-m");
223     CmdArgs.push_back("elf64lriscv");
224     break;
225   default:
226     break;
227   }
228 
229   if (Arg *A = Args.getLastArg(options::OPT_G)) {
230     if (ToolChain.getTriple().isMIPS()) {
231       StringRef v = A->getValue();
232       CmdArgs.push_back(Args.MakeArgString("-G" + v));
233       A->claim();
234     }
235   }
236 
237   if (Output.isFilename()) {
238     CmdArgs.push_back("-o");
239     CmdArgs.push_back(Output.getFilename());
240   } else {
241     assert(Output.isNothing() && "Invalid output.");
242   }
243 
244   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
245     const char *crt1 = nullptr;
246     if (!Args.hasArg(options::OPT_shared)) {
247       if (Args.hasArg(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(Args.MakeArgString(ToolChain.GetFilePath(crt1)));
256 
257     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o")));
258 
259     const char *crtbegin = nullptr;
260     if (Args.hasArg(options::OPT_static))
261       crtbegin = "crtbeginT.o";
262     else if (Args.hasArg(options::OPT_shared) || IsPIE)
263       crtbegin = "crtbeginS.o";
264     else
265       crtbegin = "crtbegin.o";
266 
267     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
268   }
269 
270   Args.AddAllArgs(CmdArgs, options::OPT_L);
271   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
272   Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
273   Args.AddAllArgs(CmdArgs, options::OPT_e);
274   Args.AddAllArgs(CmdArgs, options::OPT_s);
275   Args.AddAllArgs(CmdArgs, options::OPT_t);
276   Args.AddAllArgs(CmdArgs, options::OPT_Z_Flag);
277   Args.AddAllArgs(CmdArgs, options::OPT_r);
278 
279   if (D.isUsingLTO()) {
280     assert(!Inputs.empty() && "Must have at least one input.");
281     addLTOOptions(ToolChain, Args, CmdArgs, Output, Inputs[0],
282                   D.getLTOMode() == LTOK_Thin);
283   }
284 
285   bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
286   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
287   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
288 
289   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
290     // Use the static OpenMP runtime with -static-openmp
291     bool StaticOpenMP = Args.hasArg(options::OPT_static_openmp) &&
292                         !Args.hasArg(options::OPT_static);
293     addOpenMPRuntime(CmdArgs, ToolChain, Args, StaticOpenMP);
294 
295     if (D.CCCIsCXX()) {
296       if (ToolChain.ShouldLinkCXXStdlib(Args))
297         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
298       if (Args.hasArg(options::OPT_pg))
299         CmdArgs.push_back("-lm_p");
300       else
301         CmdArgs.push_back("-lm");
302     }
303     if (NeedsSanitizerDeps)
304       linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
305     if (NeedsXRayDeps)
306       linkXRayRuntimeDeps(ToolChain, CmdArgs);
307     // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding
308     // the default system libraries. Just mimic this for now.
309     if (Args.hasArg(options::OPT_pg))
310       CmdArgs.push_back("-lgcc_p");
311     else
312       CmdArgs.push_back("-lgcc");
313     if (Args.hasArg(options::OPT_static)) {
314       CmdArgs.push_back("-lgcc_eh");
315     } else if (Args.hasArg(options::OPT_pg)) {
316       CmdArgs.push_back("-lgcc_eh_p");
317     } else {
318       CmdArgs.push_back("--as-needed");
319       CmdArgs.push_back("-lgcc_s");
320       CmdArgs.push_back("--no-as-needed");
321     }
322 
323     if (Args.hasArg(options::OPT_pthread)) {
324       if (Args.hasArg(options::OPT_pg))
325         CmdArgs.push_back("-lpthread_p");
326       else
327         CmdArgs.push_back("-lpthread");
328     }
329 
330     if (Args.hasArg(options::OPT_pg)) {
331       if (Args.hasArg(options::OPT_shared))
332         CmdArgs.push_back("-lc");
333       else
334         CmdArgs.push_back("-lc_p");
335       CmdArgs.push_back("-lgcc_p");
336     } else {
337       CmdArgs.push_back("-lc");
338       CmdArgs.push_back("-lgcc");
339     }
340 
341     if (Args.hasArg(options::OPT_static)) {
342       CmdArgs.push_back("-lgcc_eh");
343     } else if (Args.hasArg(options::OPT_pg)) {
344       CmdArgs.push_back("-lgcc_eh_p");
345     } else {
346       CmdArgs.push_back("--as-needed");
347       CmdArgs.push_back("-lgcc_s");
348       CmdArgs.push_back("--no-as-needed");
349     }
350   }
351 
352   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
353     if (Args.hasArg(options::OPT_shared) || IsPIE)
354       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtendS.o")));
355     else
356       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtend.o")));
357     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));
358   }
359 
360   ToolChain.addProfileRTLibs(Args, CmdArgs);
361 
362   const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
363   C.addCommand(std::make_unique<Command>(JA, *this,
364                                          ResponseFileSupport::AtFileCurCP(),
365                                          Exec, CmdArgs, Inputs, Output));
366 }
367 
368 /// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly.
369 
370 FreeBSD::FreeBSD(const Driver &D, const llvm::Triple &Triple,
371                  const ArgList &Args)
372     : Generic_ELF(D, Triple, Args) {
373 
374   // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall
375   // back to '/usr/lib' if it doesn't exist.
376   if ((Triple.getArch() == llvm::Triple::x86 || Triple.isMIPS32() ||
377        Triple.getArch() == llvm::Triple::ppc) &&
378       D.getVFS().exists(getDriver().SysRoot + "/usr/lib32/crt1.o"))
379     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib32");
380   else
381     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib");
382 }
383 
384 ToolChain::CXXStdlibType FreeBSD::GetDefaultCXXStdlibType() const {
385   if (getTriple().getOSMajorVersion() >= 10)
386     return ToolChain::CST_Libcxx;
387   return ToolChain::CST_Libstdcxx;
388 }
389 
390 unsigned FreeBSD::GetDefaultDwarfVersion() const {
391   if (getTriple().getOSMajorVersion() < 12)
392     return 2;
393   return 4;
394 }
395 
396 void FreeBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
397                                     llvm::opt::ArgStringList &CC1Args) const {
398   addSystemInclude(DriverArgs, CC1Args,
399                    getDriver().SysRoot + "/usr/include/c++/v1");
400 }
401 
402 void FreeBSD::addLibStdCxxIncludePaths(
403     const llvm::opt::ArgList &DriverArgs,
404     llvm::opt::ArgStringList &CC1Args) const {
405   addLibStdCXXIncludePaths(getDriver().SysRoot, "/usr/include/c++/4.2", "", "",
406                            "", "", DriverArgs, CC1Args);
407 }
408 
409 void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args,
410                                   ArgStringList &CmdArgs) const {
411   CXXStdlibType Type = GetCXXStdlibType(Args);
412   bool Profiling = Args.hasArg(options::OPT_pg);
413 
414   switch (Type) {
415   case ToolChain::CST_Libcxx:
416     CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");
417     break;
418 
419   case ToolChain::CST_Libstdcxx:
420     CmdArgs.push_back(Profiling ? "-lstdc++_p" : "-lstdc++");
421     break;
422   }
423 }
424 
425 void FreeBSD::AddCudaIncludeArgs(const ArgList &DriverArgs,
426                                  ArgStringList &CC1Args) const {
427   CudaInstallation.AddCudaIncludeArgs(DriverArgs, CC1Args);
428 }
429 
430 void FreeBSD::AddHIPIncludeArgs(const ArgList &DriverArgs,
431                                 ArgStringList &CC1Args) const {
432   RocmInstallation.AddHIPIncludeArgs(DriverArgs, CC1Args);
433 }
434 
435 Tool *FreeBSD::buildAssembler() const {
436   return new tools::freebsd::Assembler(*this);
437 }
438 
439 Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); }
440 
441 llvm::ExceptionHandling FreeBSD::GetExceptionModel(const ArgList &Args) const {
442   // FreeBSD uses SjLj exceptions on ARM oabi.
443   switch (getTriple().getEnvironment()) {
444   case llvm::Triple::GNUEABIHF:
445   case llvm::Triple::GNUEABI:
446   case llvm::Triple::EABI:
447     return llvm::ExceptionHandling::None;
448   default:
449     if (getTriple().getArch() == llvm::Triple::arm ||
450         getTriple().getArch() == llvm::Triple::thumb)
451       return llvm::ExceptionHandling::SjLj;
452     return llvm::ExceptionHandling::None;
453   }
454 }
455 
456 bool FreeBSD::HasNativeLLVMSupport() const { return true; }
457 
458 bool FreeBSD::IsUnwindTablesDefault(const ArgList &Args) const { return true; }
459 
460 bool FreeBSD::isPIEDefault() const { return getSanitizerArgs().requiresPIE(); }
461 
462 SanitizerMask FreeBSD::getSupportedSanitizers() const {
463   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
464   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
465   const bool IsMIPS64 = getTriple().isMIPS64();
466   SanitizerMask Res = ToolChain::getSupportedSanitizers();
467   Res |= SanitizerKind::Address;
468   Res |= SanitizerKind::PointerCompare;
469   Res |= SanitizerKind::PointerSubtract;
470   Res |= SanitizerKind::Vptr;
471   if (IsX86_64 || IsMIPS64) {
472     Res |= SanitizerKind::Leak;
473     Res |= SanitizerKind::Thread;
474   }
475   if (IsX86 || IsX86_64) {
476     Res |= SanitizerKind::Function;
477     Res |= SanitizerKind::SafeStack;
478     Res |= SanitizerKind::Fuzzer;
479     Res |= SanitizerKind::FuzzerNoLink;
480   }
481   if (IsX86_64)
482     Res |= SanitizerKind::Memory;
483   return Res;
484 }
485 
486 void FreeBSD::addClangTargetOptions(const ArgList &DriverArgs,
487                                     ArgStringList &CC1Args,
488                                     Action::OffloadKind) const {
489   if (!DriverArgs.hasFlag(options::OPT_fuse_init_array,
490                           options::OPT_fno_use_init_array,
491                           getTriple().getOSMajorVersion() >= 12))
492     CC1Args.push_back("-fno-use-init-array");
493 }
494