1 //===--- FreeBSD.cpp - FreeBSD ToolChain Implementations --------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "FreeBSD.h"
11 #include "Arch/ARM.h"
12 #include "Arch/Mips.h"
13 #include "Arch/Sparc.h"
14 #include "CommonArgs.h"
15 #include "clang/Basic/VirtualFileSystem.h"
16 #include "clang/Driver/Compilation.h"
17 #include "clang/Driver/Options.h"
18 #include "clang/Driver/SanitizerArgs.h"
19 #include "llvm/Option/ArgList.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 
35   // When building 32-bit code on FreeBSD/amd64, we have to explicitly
36   // instruct as in the base system to assemble 32-bit code.
37   switch (getToolChain().getArch()) {
38   default:
39     break;
40   case llvm::Triple::x86:
41     CmdArgs.push_back("--32");
42     break;
43   case llvm::Triple::ppc:
44     CmdArgs.push_back("-a32");
45     break;
46   case llvm::Triple::mips:
47   case llvm::Triple::mipsel:
48   case llvm::Triple::mips64:
49   case llvm::Triple::mips64el: {
50     StringRef CPUName;
51     StringRef ABIName;
52     mips::getMipsCPUAndABI(Args, getToolChain().getTriple(), CPUName, ABIName);
53 
54     CmdArgs.push_back("-march");
55     CmdArgs.push_back(CPUName.data());
56 
57     CmdArgs.push_back("-mabi");
58     CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());
59 
60     if (getToolChain().getArch() == llvm::Triple::mips ||
61         getToolChain().getArch() == llvm::Triple::mips64)
62       CmdArgs.push_back("-EB");
63     else
64       CmdArgs.push_back("-EL");
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(sparc::getSparcAsmModeForCPU(CPU, getToolChain().getTriple()));
103     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
104     break;
105   }
106   }
107 
108   Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
109 
110   CmdArgs.push_back("-o");
111   CmdArgs.push_back(Output.getFilename());
112 
113   for (const auto &II : Inputs)
114     CmdArgs.push_back(II.getFilename());
115 
116   const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
117   C.addCommand(llvm::make_unique<Command>(JA, *this, Exec, CmdArgs, Inputs));
118 }
119 
120 static bool addXRayRuntime(const ToolChain &TC, const ArgList &Args,
121                            ArgStringList &CmdArgs) {
122   if (Args.hasArg(options::OPT_shared))
123     return false;
124 
125   if (Args.hasFlag(options::OPT_fxray_instrument,
126                    options::OPT_fnoxray_instrument, false)) {
127     CmdArgs.push_back("-whole-archive");
128     CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray", false));
129     CmdArgs.push_back("-no-whole-archive");
130     return true;
131   }
132 
133   return false;
134 }
135 
136 static void linkXRayRuntimeDeps(const ToolChain &TC, const ArgList &Args,
137                                 ArgStringList &CmdArgs) {
138   CmdArgs.push_back("--no-as-needed");
139   CmdArgs.push_back("-lrt");
140   CmdArgs.push_back("-lm");
141   CmdArgs.push_back("-lpthread");
142 }
143 
144 void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
145                                    const InputInfo &Output,
146                                    const InputInfoList &Inputs,
147                                    const ArgList &Args,
148                                    const char *LinkingOutput) const {
149   const toolchains::FreeBSD &ToolChain =
150       static_cast<const toolchains::FreeBSD &>(getToolChain());
151   const Driver &D = ToolChain.getDriver();
152   const llvm::Triple::ArchType Arch = ToolChain.getArch();
153   const bool IsPIE =
154       !Args.hasArg(options::OPT_shared) &&
155       (Args.hasArg(options::OPT_pie) || ToolChain.isPIEDefault());
156   ArgStringList CmdArgs;
157 
158   // Silence warning for "clang -g foo.o -o foo"
159   Args.ClaimAllArgs(options::OPT_g_Group);
160   // and "clang -emit-llvm foo.o -o foo"
161   Args.ClaimAllArgs(options::OPT_emit_llvm);
162   // and for "clang -w foo.o -o foo". Other warning options are already
163   // handled somewhere else.
164   Args.ClaimAllArgs(options::OPT_w);
165 
166   if (!D.SysRoot.empty())
167     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
168 
169   if (IsPIE)
170     CmdArgs.push_back("-pie");
171 
172   CmdArgs.push_back("--eh-frame-hdr");
173   if (Args.hasArg(options::OPT_static)) {
174     CmdArgs.push_back("-Bstatic");
175   } else {
176     if (Args.hasArg(options::OPT_rdynamic))
177       CmdArgs.push_back("-export-dynamic");
178     if (Args.hasArg(options::OPT_shared)) {
179       CmdArgs.push_back("-Bshareable");
180     } else {
181       CmdArgs.push_back("-dynamic-linker");
182       CmdArgs.push_back("/libexec/ld-elf.so.1");
183     }
184     if (ToolChain.getTriple().getOSMajorVersion() >= 9) {
185       if (Arch == llvm::Triple::arm || Arch == llvm::Triple::sparc ||
186           Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64) {
187         CmdArgs.push_back("--hash-style=both");
188       }
189     }
190     CmdArgs.push_back("--enable-new-dtags");
191   }
192 
193   // When building 32-bit code on FreeBSD/amd64, we have to explicitly
194   // instruct ld in the base system to link 32-bit code.
195   if (Arch == llvm::Triple::x86) {
196     CmdArgs.push_back("-m");
197     CmdArgs.push_back("elf_i386_fbsd");
198   }
199 
200   if (Arch == llvm::Triple::ppc) {
201     CmdArgs.push_back("-m");
202     CmdArgs.push_back("elf32ppc_fbsd");
203   }
204 
205   if (Arg *A = Args.getLastArg(options::OPT_G)) {
206     if (ToolChain.getArch() == llvm::Triple::mips ||
207       ToolChain.getArch() == llvm::Triple::mipsel ||
208       ToolChain.getArch() == llvm::Triple::mips64 ||
209       ToolChain.getArch() == llvm::Triple::mips64el) {
210       StringRef v = A->getValue();
211       CmdArgs.push_back(Args.MakeArgString("-G" + v));
212       A->claim();
213     }
214   }
215 
216   if (Output.isFilename()) {
217     CmdArgs.push_back("-o");
218     CmdArgs.push_back(Output.getFilename());
219   } else {
220     assert(Output.isNothing() && "Invalid output.");
221   }
222 
223   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
224     const char *crt1 = nullptr;
225     if (!Args.hasArg(options::OPT_shared)) {
226       if (Args.hasArg(options::OPT_pg))
227         crt1 = "gcrt1.o";
228       else if (IsPIE)
229         crt1 = "Scrt1.o";
230       else
231         crt1 = "crt1.o";
232     }
233     if (crt1)
234       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt1)));
235 
236     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o")));
237 
238     const char *crtbegin = nullptr;
239     if (Args.hasArg(options::OPT_static))
240       crtbegin = "crtbeginT.o";
241     else if (Args.hasArg(options::OPT_shared) || IsPIE)
242       crtbegin = "crtbeginS.o";
243     else
244       crtbegin = "crtbegin.o";
245 
246     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
247   }
248 
249   Args.AddAllArgs(CmdArgs, options::OPT_L);
250   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
251   Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
252   Args.AddAllArgs(CmdArgs, options::OPT_e);
253   Args.AddAllArgs(CmdArgs, options::OPT_s);
254   Args.AddAllArgs(CmdArgs, options::OPT_t);
255   Args.AddAllArgs(CmdArgs, options::OPT_Z_Flag);
256   Args.AddAllArgs(CmdArgs, options::OPT_r);
257 
258   if (D.isUsingLTO())
259     AddGoldPlugin(ToolChain, Args, CmdArgs, D.getLTOMode() == LTOK_Thin, D);
260 
261   bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
262   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
263   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
264 
265   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
266     addOpenMPRuntime(CmdArgs, ToolChain, Args);
267     if (D.CCCIsCXX()) {
268       if (ToolChain.ShouldLinkCXXStdlib(Args))
269         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
270       if (Args.hasArg(options::OPT_pg))
271         CmdArgs.push_back("-lm_p");
272       else
273         CmdArgs.push_back("-lm");
274     }
275     if (NeedsSanitizerDeps)
276       linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
277     if (NeedsXRayDeps)
278       linkXRayRuntimeDeps(ToolChain, Args, CmdArgs);
279     // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding
280     // the default system libraries. Just mimic this for now.
281     if (Args.hasArg(options::OPT_pg))
282       CmdArgs.push_back("-lgcc_p");
283     else
284       CmdArgs.push_back("-lgcc");
285     if (Args.hasArg(options::OPT_static)) {
286       CmdArgs.push_back("-lgcc_eh");
287     } else if (Args.hasArg(options::OPT_pg)) {
288       CmdArgs.push_back("-lgcc_eh_p");
289     } else {
290       CmdArgs.push_back("--as-needed");
291       CmdArgs.push_back("-lgcc_s");
292       CmdArgs.push_back("--no-as-needed");
293     }
294 
295     if (Args.hasArg(options::OPT_pthread)) {
296       if (Args.hasArg(options::OPT_pg))
297         CmdArgs.push_back("-lpthread_p");
298       else
299         CmdArgs.push_back("-lpthread");
300     }
301 
302     if (Args.hasArg(options::OPT_pg)) {
303       if (Args.hasArg(options::OPT_shared))
304         CmdArgs.push_back("-lc");
305       else
306         CmdArgs.push_back("-lc_p");
307       CmdArgs.push_back("-lgcc_p");
308     } else {
309       CmdArgs.push_back("-lc");
310       CmdArgs.push_back("-lgcc");
311     }
312 
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 
324   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
325     if (Args.hasArg(options::OPT_shared) || IsPIE)
326       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtendS.o")));
327     else
328       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtend.o")));
329     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));
330   }
331 
332   ToolChain.addProfileRTLibs(Args, CmdArgs);
333 
334   const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
335   C.addCommand(llvm::make_unique<Command>(JA, *this, Exec, CmdArgs, Inputs));
336 }
337 
338 /// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly.
339 
340 FreeBSD::FreeBSD(const Driver &D, const llvm::Triple &Triple,
341                  const ArgList &Args)
342     : Generic_ELF(D, Triple, Args) {
343 
344   // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall
345   // back to '/usr/lib' if it doesn't exist.
346   if ((Triple.getArch() == llvm::Triple::x86 ||
347        Triple.getArch() == llvm::Triple::mips ||
348        Triple.getArch() == llvm::Triple::mipsel ||
349        Triple.getArch() == llvm::Triple::ppc) &&
350       D.getVFS().exists(getDriver().SysRoot + "/usr/lib32/crt1.o"))
351     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib32");
352   else
353     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib");
354 }
355 
356 ToolChain::CXXStdlibType FreeBSD::GetDefaultCXXStdlibType() const {
357   if (getTriple().getOSMajorVersion() >= 10)
358     return ToolChain::CST_Libcxx;
359   return ToolChain::CST_Libstdcxx;
360 }
361 
362 void FreeBSD::addLibStdCxxIncludePaths(
363     const llvm::opt::ArgList &DriverArgs,
364     llvm::opt::ArgStringList &CC1Args) const {
365   addLibStdCXXIncludePaths(getDriver().SysRoot, "/usr/include/c++/4.2", "", "",
366                            "", "", DriverArgs, CC1Args);
367 }
368 
369 void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args,
370                                   ArgStringList &CmdArgs) const {
371   CXXStdlibType Type = GetCXXStdlibType(Args);
372   bool Profiling = Args.hasArg(options::OPT_pg);
373 
374   switch (Type) {
375   case ToolChain::CST_Libcxx:
376     CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");
377     break;
378 
379   case ToolChain::CST_Libstdcxx:
380     CmdArgs.push_back(Profiling ? "-lstdc++_p" : "-lstdc++");
381     break;
382   }
383 }
384 
385 Tool *FreeBSD::buildAssembler() const {
386   return new tools::freebsd::Assembler(*this);
387 }
388 
389 Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); }
390 
391 llvm::ExceptionHandling FreeBSD::GetExceptionModel(const ArgList &Args) const {
392   // FreeBSD uses SjLj exceptions on ARM oabi.
393   switch (getTriple().getEnvironment()) {
394   case llvm::Triple::GNUEABIHF:
395   case llvm::Triple::GNUEABI:
396   case llvm::Triple::EABI:
397     return llvm::ExceptionHandling::None;
398   default:
399     if (getTriple().getArch() == llvm::Triple::arm ||
400         getTriple().getArch() == llvm::Triple::thumb)
401       return llvm::ExceptionHandling::SjLj;
402     return llvm::ExceptionHandling::None;
403   }
404 }
405 
406 bool FreeBSD::HasNativeLLVMSupport() const { return true; }
407 
408 bool FreeBSD::isPIEDefault() const { return getSanitizerArgs().requiresPIE(); }
409 
410 SanitizerMask FreeBSD::getSupportedSanitizers() const {
411   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
412   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
413   const bool IsMIPS64 = getTriple().getArch() == llvm::Triple::mips64 ||
414                         getTriple().getArch() == llvm::Triple::mips64el;
415   SanitizerMask Res = ToolChain::getSupportedSanitizers();
416   Res |= SanitizerKind::Address;
417   Res |= SanitizerKind::Vptr;
418   if (IsX86_64 || IsMIPS64) {
419     Res |= SanitizerKind::Leak;
420     Res |= SanitizerKind::Thread;
421   }
422   if (IsX86 || IsX86_64) {
423     Res |= SanitizerKind::SafeStack;
424     Res |= SanitizerKind::Fuzzer;
425     Res |= SanitizerKind::FuzzerNoLink;
426   }
427   if (IsX86_64)
428     Res |= SanitizerKind::Memory;
429   return Res;
430 }
431