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 void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
121                                    const InputInfo &Output,
122                                    const InputInfoList &Inputs,
123                                    const ArgList &Args,
124                                    const char *LinkingOutput) const {
125   const toolchains::FreeBSD &ToolChain =
126       static_cast<const toolchains::FreeBSD &>(getToolChain());
127   const Driver &D = ToolChain.getDriver();
128   const llvm::Triple::ArchType Arch = ToolChain.getArch();
129   const bool IsPIE =
130       !Args.hasArg(options::OPT_shared) &&
131       (Args.hasArg(options::OPT_pie) || ToolChain.isPIEDefault());
132   ArgStringList CmdArgs;
133 
134   // Silence warning for "clang -g foo.o -o foo"
135   Args.ClaimAllArgs(options::OPT_g_Group);
136   // and "clang -emit-llvm foo.o -o foo"
137   Args.ClaimAllArgs(options::OPT_emit_llvm);
138   // and for "clang -w foo.o -o foo". Other warning options are already
139   // handled somewhere else.
140   Args.ClaimAllArgs(options::OPT_w);
141 
142   if (!D.SysRoot.empty())
143     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
144 
145   if (IsPIE)
146     CmdArgs.push_back("-pie");
147 
148   CmdArgs.push_back("--eh-frame-hdr");
149   if (Args.hasArg(options::OPT_static)) {
150     CmdArgs.push_back("-Bstatic");
151   } else {
152     if (Args.hasArg(options::OPT_rdynamic))
153       CmdArgs.push_back("-export-dynamic");
154     if (Args.hasArg(options::OPT_shared)) {
155       CmdArgs.push_back("-Bshareable");
156     } else {
157       CmdArgs.push_back("-dynamic-linker");
158       CmdArgs.push_back("/libexec/ld-elf.so.1");
159     }
160     if (ToolChain.getTriple().getOSMajorVersion() >= 9) {
161       if (Arch == llvm::Triple::arm || Arch == llvm::Triple::sparc ||
162           Arch == llvm::Triple::x86 || Arch == llvm::Triple::x86_64) {
163         CmdArgs.push_back("--hash-style=both");
164       }
165     }
166     CmdArgs.push_back("--enable-new-dtags");
167   }
168 
169   // When building 32-bit code on FreeBSD/amd64, we have to explicitly
170   // instruct ld in the base system to link 32-bit code.
171   if (Arch == llvm::Triple::x86) {
172     CmdArgs.push_back("-m");
173     CmdArgs.push_back("elf_i386_fbsd");
174   }
175 
176   if (Arch == llvm::Triple::ppc) {
177     CmdArgs.push_back("-m");
178     CmdArgs.push_back("elf32ppc_fbsd");
179   }
180 
181   if (Arg *A = Args.getLastArg(options::OPT_G)) {
182     if (ToolChain.getArch() == llvm::Triple::mips ||
183       ToolChain.getArch() == llvm::Triple::mipsel ||
184       ToolChain.getArch() == llvm::Triple::mips64 ||
185       ToolChain.getArch() == llvm::Triple::mips64el) {
186       StringRef v = A->getValue();
187       CmdArgs.push_back(Args.MakeArgString("-G" + v));
188       A->claim();
189     }
190   }
191 
192   if (Output.isFilename()) {
193     CmdArgs.push_back("-o");
194     CmdArgs.push_back(Output.getFilename());
195   } else {
196     assert(Output.isNothing() && "Invalid output.");
197   }
198 
199   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
200     const char *crt1 = nullptr;
201     if (!Args.hasArg(options::OPT_shared)) {
202       if (Args.hasArg(options::OPT_pg))
203         crt1 = "gcrt1.o";
204       else if (IsPIE)
205         crt1 = "Scrt1.o";
206       else
207         crt1 = "crt1.o";
208     }
209     if (crt1)
210       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt1)));
211 
212     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o")));
213 
214     const char *crtbegin = nullptr;
215     if (Args.hasArg(options::OPT_static))
216       crtbegin = "crtbeginT.o";
217     else if (Args.hasArg(options::OPT_shared) || IsPIE)
218       crtbegin = "crtbeginS.o";
219     else
220       crtbegin = "crtbegin.o";
221 
222     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
223   }
224 
225   Args.AddAllArgs(CmdArgs, options::OPT_L);
226   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
227   Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
228   Args.AddAllArgs(CmdArgs, options::OPT_e);
229   Args.AddAllArgs(CmdArgs, options::OPT_s);
230   Args.AddAllArgs(CmdArgs, options::OPT_t);
231   Args.AddAllArgs(CmdArgs, options::OPT_Z_Flag);
232   Args.AddAllArgs(CmdArgs, options::OPT_r);
233 
234   if (D.isUsingLTO()) {
235     assert(!Inputs.empty() && "Must have at least one input.");
236     AddGoldPlugin(ToolChain, Args, CmdArgs, Output, Inputs[0],
237                   D.getLTOMode() == LTOK_Thin);
238   }
239 
240   bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
241   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
242   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
243 
244   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
245     addOpenMPRuntime(CmdArgs, ToolChain, Args);
246     if (D.CCCIsCXX()) {
247       if (ToolChain.ShouldLinkCXXStdlib(Args))
248         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
249       if (Args.hasArg(options::OPT_pg))
250         CmdArgs.push_back("-lm_p");
251       else
252         CmdArgs.push_back("-lm");
253     }
254     if (NeedsSanitizerDeps)
255       linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
256     if (NeedsXRayDeps)
257       linkXRayRuntimeDeps(ToolChain, CmdArgs);
258     // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding
259     // the default system libraries. Just mimic this for now.
260     if (Args.hasArg(options::OPT_pg))
261       CmdArgs.push_back("-lgcc_p");
262     else
263       CmdArgs.push_back("-lgcc");
264     if (Args.hasArg(options::OPT_static)) {
265       CmdArgs.push_back("-lgcc_eh");
266     } else if (Args.hasArg(options::OPT_pg)) {
267       CmdArgs.push_back("-lgcc_eh_p");
268     } else {
269       CmdArgs.push_back("--as-needed");
270       CmdArgs.push_back("-lgcc_s");
271       CmdArgs.push_back("--no-as-needed");
272     }
273 
274     if (Args.hasArg(options::OPT_pthread)) {
275       if (Args.hasArg(options::OPT_pg))
276         CmdArgs.push_back("-lpthread_p");
277       else
278         CmdArgs.push_back("-lpthread");
279     }
280 
281     if (Args.hasArg(options::OPT_pg)) {
282       if (Args.hasArg(options::OPT_shared))
283         CmdArgs.push_back("-lc");
284       else
285         CmdArgs.push_back("-lc_p");
286       CmdArgs.push_back("-lgcc_p");
287     } else {
288       CmdArgs.push_back("-lc");
289       CmdArgs.push_back("-lgcc");
290     }
291 
292     if (Args.hasArg(options::OPT_static)) {
293       CmdArgs.push_back("-lgcc_eh");
294     } else if (Args.hasArg(options::OPT_pg)) {
295       CmdArgs.push_back("-lgcc_eh_p");
296     } else {
297       CmdArgs.push_back("--as-needed");
298       CmdArgs.push_back("-lgcc_s");
299       CmdArgs.push_back("--no-as-needed");
300     }
301   }
302 
303   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
304     if (Args.hasArg(options::OPT_shared) || IsPIE)
305       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtendS.o")));
306     else
307       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtend.o")));
308     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));
309   }
310 
311   ToolChain.addProfileRTLibs(Args, CmdArgs);
312 
313   const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
314   C.addCommand(llvm::make_unique<Command>(JA, *this, Exec, CmdArgs, Inputs));
315 }
316 
317 /// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly.
318 
319 FreeBSD::FreeBSD(const Driver &D, const llvm::Triple &Triple,
320                  const ArgList &Args)
321     : Generic_ELF(D, Triple, Args) {
322 
323   // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall
324   // back to '/usr/lib' if it doesn't exist.
325   if ((Triple.getArch() == llvm::Triple::x86 ||
326        Triple.getArch() == llvm::Triple::mips ||
327        Triple.getArch() == llvm::Triple::mipsel ||
328        Triple.getArch() == llvm::Triple::ppc) &&
329       D.getVFS().exists(getDriver().SysRoot + "/usr/lib32/crt1.o"))
330     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib32");
331   else
332     getFilePaths().push_back(getDriver().SysRoot + "/usr/lib");
333 }
334 
335 ToolChain::CXXStdlibType FreeBSD::GetDefaultCXXStdlibType() const {
336   if (getTriple().getOSMajorVersion() >= 10)
337     return ToolChain::CST_Libcxx;
338   return ToolChain::CST_Libstdcxx;
339 }
340 
341 void FreeBSD::addLibStdCxxIncludePaths(
342     const llvm::opt::ArgList &DriverArgs,
343     llvm::opt::ArgStringList &CC1Args) const {
344   addLibStdCXXIncludePaths(getDriver().SysRoot, "/usr/include/c++/4.2", "", "",
345                            "", "", DriverArgs, CC1Args);
346 }
347 
348 void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args,
349                                   ArgStringList &CmdArgs) const {
350   CXXStdlibType Type = GetCXXStdlibType(Args);
351   bool Profiling = Args.hasArg(options::OPT_pg);
352 
353   switch (Type) {
354   case ToolChain::CST_Libcxx:
355     CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");
356     break;
357 
358   case ToolChain::CST_Libstdcxx:
359     CmdArgs.push_back(Profiling ? "-lstdc++_p" : "-lstdc++");
360     break;
361   }
362 }
363 
364 Tool *FreeBSD::buildAssembler() const {
365   return new tools::freebsd::Assembler(*this);
366 }
367 
368 Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); }
369 
370 llvm::ExceptionHandling FreeBSD::GetExceptionModel(const ArgList &Args) const {
371   // FreeBSD uses SjLj exceptions on ARM oabi.
372   switch (getTriple().getEnvironment()) {
373   case llvm::Triple::GNUEABIHF:
374   case llvm::Triple::GNUEABI:
375   case llvm::Triple::EABI:
376     return llvm::ExceptionHandling::None;
377   default:
378     if (getTriple().getArch() == llvm::Triple::arm ||
379         getTriple().getArch() == llvm::Triple::thumb)
380       return llvm::ExceptionHandling::SjLj;
381     return llvm::ExceptionHandling::None;
382   }
383 }
384 
385 bool FreeBSD::HasNativeLLVMSupport() const { return true; }
386 
387 bool FreeBSD::isPIEDefault() const { return getSanitizerArgs().requiresPIE(); }
388 
389 SanitizerMask FreeBSD::getSupportedSanitizers() const {
390   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
391   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
392   const bool IsMIPS64 = getTriple().getArch() == llvm::Triple::mips64 ||
393                         getTriple().getArch() == llvm::Triple::mips64el;
394   SanitizerMask Res = ToolChain::getSupportedSanitizers();
395   Res |= SanitizerKind::Address;
396   Res |= SanitizerKind::Vptr;
397   if (IsX86_64 || IsMIPS64) {
398     Res |= SanitizerKind::Leak;
399     Res |= SanitizerKind::Thread;
400   }
401   if (IsX86 || IsX86_64) {
402     Res |= SanitizerKind::SafeStack;
403     Res |= SanitizerKind::Fuzzer;
404     Res |= SanitizerKind::FuzzerNoLink;
405   }
406   if (IsX86_64)
407     Res |= SanitizerKind::Memory;
408   return Res;
409 }
410