1 //===--- NetBSD.cpp - NetBSD 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 "NetBSD.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/Driver.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 netbsd::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 Driver &D = getToolChain().getDriver();
33 
34   claimNoWarnArgs(Args);
35   ArgStringList CmdArgs;
36 
37   // GNU as needs different flags for creating the correct output format
38   // on architectures with different ABIs or optional feature sets.
39   switch (getToolChain().getArch()) {
40   case llvm::Triple::x86:
41     CmdArgs.push_back("--32");
42     break;
43   case llvm::Triple::arm:
44   case llvm::Triple::armeb:
45   case llvm::Triple::thumb:
46   case llvm::Triple::thumbeb: {
47     StringRef MArch, MCPU;
48     arm::getARMArchCPUFromArgs(Args, MArch, MCPU, /*FromAs*/ true);
49     std::string Arch =
50         arm::getARMTargetCPU(MCPU, MArch, getToolChain().getTriple());
51     CmdArgs.push_back(Args.MakeArgString("-mcpu=" + Arch));
52     break;
53   }
54 
55   case llvm::Triple::mips:
56   case llvm::Triple::mipsel:
57   case llvm::Triple::mips64:
58   case llvm::Triple::mips64el: {
59     StringRef CPUName;
60     StringRef ABIName;
61     mips::getMipsCPUAndABI(Args, getToolChain().getTriple(), CPUName, ABIName);
62 
63     CmdArgs.push_back("-march");
64     CmdArgs.push_back(CPUName.data());
65 
66     CmdArgs.push_back("-mabi");
67     CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());
68 
69     if (getToolChain().getTriple().isLittleEndian())
70       CmdArgs.push_back("-EL");
71     else
72       CmdArgs.push_back("-EB");
73 
74     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
75     break;
76   }
77 
78   case llvm::Triple::sparc:
79   case llvm::Triple::sparcel: {
80     CmdArgs.push_back("-32");
81     std::string CPU = getCPUName(D, Args, getToolChain().getTriple());
82     CmdArgs.push_back(
83         sparc::getSparcAsmModeForCPU(CPU, getToolChain().getTriple()));
84     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
85     break;
86   }
87 
88   case llvm::Triple::sparcv9: {
89     CmdArgs.push_back("-64");
90     std::string CPU = getCPUName(D, Args, getToolChain().getTriple());
91     CmdArgs.push_back(
92         sparc::getSparcAsmModeForCPU(CPU, getToolChain().getTriple()));
93     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
94     break;
95   }
96 
97   default:
98     break;
99   }
100 
101   Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
102 
103   CmdArgs.push_back("-o");
104   CmdArgs.push_back(Output.getFilename());
105 
106   for (const auto &II : Inputs)
107     CmdArgs.push_back(II.getFilename());
108 
109   const char *Exec = Args.MakeArgString((getToolChain().GetProgramPath("as")));
110   C.addCommand(std::make_unique<Command>(JA, *this,
111                                          ResponseFileSupport::AtFileCurCP(),
112                                          Exec, CmdArgs, Inputs, Output));
113 }
114 
115 void netbsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
116                                   const InputInfo &Output,
117                                   const InputInfoList &Inputs,
118                                   const ArgList &Args,
119                                   const char *LinkingOutput) const {
120   const toolchains::NetBSD &ToolChain =
121     static_cast<const toolchains::NetBSD &>(getToolChain());
122   const Driver &D = ToolChain.getDriver();
123   ArgStringList CmdArgs;
124 
125   if (!D.SysRoot.empty())
126     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
127 
128   CmdArgs.push_back("--eh-frame-hdr");
129   if (Args.hasArg(options::OPT_static)) {
130     CmdArgs.push_back("-Bstatic");
131     if (Args.hasArg(options::OPT_pie)) {
132       Args.AddAllArgs(CmdArgs, options::OPT_pie);
133       CmdArgs.push_back("--no-dynamic-linker");
134     }
135   } else {
136     if (Args.hasArg(options::OPT_rdynamic))
137       CmdArgs.push_back("-export-dynamic");
138     if (Args.hasArg(options::OPT_shared)) {
139       CmdArgs.push_back("-Bshareable");
140     } else {
141       Args.AddAllArgs(CmdArgs, options::OPT_pie);
142       CmdArgs.push_back("-dynamic-linker");
143       CmdArgs.push_back("/libexec/ld.elf_so");
144     }
145   }
146 
147   // Many NetBSD architectures support more than one ABI.
148   // Determine the correct emulation for ld.
149   switch (ToolChain.getArch()) {
150   case llvm::Triple::x86:
151     CmdArgs.push_back("-m");
152     CmdArgs.push_back("elf_i386");
153     break;
154   case llvm::Triple::arm:
155   case llvm::Triple::thumb:
156     CmdArgs.push_back("-m");
157     switch (ToolChain.getTriple().getEnvironment()) {
158     case llvm::Triple::EABI:
159     case llvm::Triple::GNUEABI:
160       CmdArgs.push_back("armelf_nbsd_eabi");
161       break;
162     case llvm::Triple::EABIHF:
163     case llvm::Triple::GNUEABIHF:
164       CmdArgs.push_back("armelf_nbsd_eabihf");
165       break;
166     default:
167       CmdArgs.push_back("armelf_nbsd");
168       break;
169     }
170     break;
171   case llvm::Triple::armeb:
172   case llvm::Triple::thumbeb:
173     arm::appendBE8LinkFlag(Args, CmdArgs, ToolChain.getEffectiveTriple());
174     CmdArgs.push_back("-m");
175     switch (ToolChain.getTriple().getEnvironment()) {
176     case llvm::Triple::EABI:
177     case llvm::Triple::GNUEABI:
178       CmdArgs.push_back("armelfb_nbsd_eabi");
179       break;
180     case llvm::Triple::EABIHF:
181     case llvm::Triple::GNUEABIHF:
182       CmdArgs.push_back("armelfb_nbsd_eabihf");
183       break;
184     default:
185       CmdArgs.push_back("armelfb_nbsd");
186       break;
187     }
188     break;
189   case llvm::Triple::mips64:
190   case llvm::Triple::mips64el:
191     if (mips::hasMipsAbiArg(Args, "32")) {
192       CmdArgs.push_back("-m");
193       if (ToolChain.getArch() == llvm::Triple::mips64)
194         CmdArgs.push_back("elf32btsmip");
195       else
196         CmdArgs.push_back("elf32ltsmip");
197     } else if (mips::hasMipsAbiArg(Args, "64")) {
198       CmdArgs.push_back("-m");
199       if (ToolChain.getArch() == llvm::Triple::mips64)
200         CmdArgs.push_back("elf64btsmip");
201       else
202         CmdArgs.push_back("elf64ltsmip");
203     }
204     break;
205   case llvm::Triple::ppc:
206     CmdArgs.push_back("-m");
207     CmdArgs.push_back("elf32ppc_nbsd");
208     break;
209 
210   case llvm::Triple::ppc64:
211   case llvm::Triple::ppc64le:
212     CmdArgs.push_back("-m");
213     CmdArgs.push_back("elf64ppc");
214     break;
215 
216   case llvm::Triple::sparc:
217     CmdArgs.push_back("-m");
218     CmdArgs.push_back("elf32_sparc");
219     break;
220 
221   case llvm::Triple::sparcv9:
222     CmdArgs.push_back("-m");
223     CmdArgs.push_back("elf64_sparc");
224     break;
225 
226   default:
227     break;
228   }
229 
230   if (Output.isFilename()) {
231     CmdArgs.push_back("-o");
232     CmdArgs.push_back(Output.getFilename());
233   } else {
234     assert(Output.isNothing() && "Invalid output.");
235   }
236 
237   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
238     if (!Args.hasArg(options::OPT_shared)) {
239       CmdArgs.push_back(
240           Args.MakeArgString(ToolChain.GetFilePath("crt0.o")));
241     }
242     CmdArgs.push_back(
243         Args.MakeArgString(ToolChain.GetFilePath("crti.o")));
244     if (Args.hasArg(options::OPT_shared) || Args.hasArg(options::OPT_pie)) {
245       CmdArgs.push_back(
246           Args.MakeArgString(ToolChain.GetFilePath("crtbeginS.o")));
247     } else {
248       CmdArgs.push_back(
249           Args.MakeArgString(ToolChain.GetFilePath("crtbegin.o")));
250     }
251   }
252 
253   Args.AddAllArgs(CmdArgs, options::OPT_L);
254   Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
255   Args.AddAllArgs(CmdArgs, options::OPT_e);
256   Args.AddAllArgs(CmdArgs, options::OPT_s);
257   Args.AddAllArgs(CmdArgs, options::OPT_t);
258   Args.AddAllArgs(CmdArgs, options::OPT_Z_Flag);
259   Args.AddAllArgs(CmdArgs, options::OPT_r);
260 
261   bool NeedsSanitizerDeps = addSanitizerRuntimes(getToolChain(), Args, CmdArgs);
262   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
263   AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
264 
265   const SanitizerArgs &SanArgs = ToolChain.getSanitizerArgs();
266   if (SanArgs.needsSharedRt()) {
267     CmdArgs.push_back("-rpath");
268     CmdArgs.push_back(Args.MakeArgString(ToolChain.getCompilerRTPath()));
269   }
270 
271   unsigned Major, Minor, Micro;
272   ToolChain.getTriple().getOSVersion(Major, Minor, Micro);
273   bool useLibgcc = true;
274   if (Major >= 7 || Major == 0) {
275     switch (ToolChain.getArch()) {
276     case llvm::Triple::aarch64:
277     case llvm::Triple::aarch64_be:
278     case llvm::Triple::arm:
279     case llvm::Triple::armeb:
280     case llvm::Triple::thumb:
281     case llvm::Triple::thumbeb:
282     case llvm::Triple::ppc:
283     case llvm::Triple::ppc64:
284     case llvm::Triple::ppc64le:
285     case llvm::Triple::sparc:
286     case llvm::Triple::sparcv9:
287     case llvm::Triple::x86:
288     case llvm::Triple::x86_64:
289       useLibgcc = false;
290       break;
291     default:
292       break;
293     }
294   }
295 
296   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
297     // Use the static OpenMP runtime with -static-openmp
298     bool StaticOpenMP = Args.hasArg(options::OPT_static_openmp) &&
299                         !Args.hasArg(options::OPT_static);
300     addOpenMPRuntime(CmdArgs, getToolChain(), Args, StaticOpenMP);
301 
302     if (D.CCCIsCXX()) {
303       if (ToolChain.ShouldLinkCXXStdlib(Args))
304         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
305       CmdArgs.push_back("-lm");
306     }
307     if (NeedsSanitizerDeps)
308       linkSanitizerRuntimeDeps(getToolChain(), CmdArgs);
309     if (NeedsXRayDeps)
310       linkXRayRuntimeDeps(ToolChain, CmdArgs);
311     if (Args.hasArg(options::OPT_pthread))
312       CmdArgs.push_back("-lpthread");
313     CmdArgs.push_back("-lc");
314 
315     if (useLibgcc) {
316       if (Args.hasArg(options::OPT_static)) {
317         // libgcc_eh depends on libc, so resolve as much as possible,
318         // pull in any new requirements from libc and then get the rest
319         // of libgcc.
320         CmdArgs.push_back("-lgcc_eh");
321         CmdArgs.push_back("-lc");
322         CmdArgs.push_back("-lgcc");
323       } else {
324         CmdArgs.push_back("-lgcc");
325         CmdArgs.push_back("--as-needed");
326         CmdArgs.push_back("-lgcc_s");
327         CmdArgs.push_back("--no-as-needed");
328       }
329     }
330   }
331 
332   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
333     if (Args.hasArg(options::OPT_shared) || Args.hasArg(options::OPT_pie))
334       CmdArgs.push_back(
335           Args.MakeArgString(ToolChain.GetFilePath("crtendS.o")));
336     else
337       CmdArgs.push_back(
338           Args.MakeArgString(ToolChain.GetFilePath("crtend.o")));
339     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));
340   }
341 
342   ToolChain.addProfileRTLibs(Args, CmdArgs);
343 
344   const char *Exec = Args.MakeArgString(ToolChain.GetLinkerPath());
345   C.addCommand(std::make_unique<Command>(JA, *this,
346                                          ResponseFileSupport::AtFileCurCP(),
347                                          Exec, CmdArgs, Inputs, Output));
348 }
349 
350 /// NetBSD - NetBSD tool chain which can call as(1) and ld(1) directly.
351 
352 NetBSD::NetBSD(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
353     : Generic_ELF(D, Triple, Args) {
354   if (!Args.hasArg(options::OPT_nostdlib)) {
355     // When targeting a 32-bit platform, try the special directory used on
356     // 64-bit hosts, and only fall back to the main library directory if that
357     // doesn't work.
358     // FIXME: It'd be nicer to test if this directory exists, but I'm not sure
359     // what all logic is needed to emulate the '=' prefix here.
360     switch (Triple.getArch()) {
361     case llvm::Triple::x86:
362       getFilePaths().push_back("=/usr/lib/i386");
363       break;
364     case llvm::Triple::arm:
365     case llvm::Triple::armeb:
366     case llvm::Triple::thumb:
367     case llvm::Triple::thumbeb:
368       switch (Triple.getEnvironment()) {
369       case llvm::Triple::EABI:
370       case llvm::Triple::GNUEABI:
371         getFilePaths().push_back("=/usr/lib/eabi");
372         break;
373       case llvm::Triple::EABIHF:
374       case llvm::Triple::GNUEABIHF:
375         getFilePaths().push_back("=/usr/lib/eabihf");
376         break;
377       default:
378         getFilePaths().push_back("=/usr/lib/oabi");
379         break;
380       }
381       break;
382     case llvm::Triple::mips64:
383     case llvm::Triple::mips64el:
384       if (tools::mips::hasMipsAbiArg(Args, "o32"))
385         getFilePaths().push_back("=/usr/lib/o32");
386       else if (tools::mips::hasMipsAbiArg(Args, "64"))
387         getFilePaths().push_back("=/usr/lib/64");
388       break;
389     case llvm::Triple::ppc:
390       getFilePaths().push_back("=/usr/lib/powerpc");
391       break;
392     case llvm::Triple::sparc:
393       getFilePaths().push_back("=/usr/lib/sparc");
394       break;
395     default:
396       break;
397     }
398 
399     getFilePaths().push_back("=/usr/lib");
400   }
401 }
402 
403 Tool *NetBSD::buildAssembler() const {
404   return new tools::netbsd::Assembler(*this);
405 }
406 
407 Tool *NetBSD::buildLinker() const { return new tools::netbsd::Linker(*this); }
408 
409 ToolChain::CXXStdlibType NetBSD::GetDefaultCXXStdlibType() const {
410   unsigned Major, Minor, Micro;
411   getTriple().getOSVersion(Major, Minor, Micro);
412   if (Major >= 7 || Major == 0) {
413     switch (getArch()) {
414     case llvm::Triple::aarch64:
415     case llvm::Triple::aarch64_be:
416     case llvm::Triple::arm:
417     case llvm::Triple::armeb:
418     case llvm::Triple::thumb:
419     case llvm::Triple::thumbeb:
420     case llvm::Triple::ppc:
421     case llvm::Triple::ppc64:
422     case llvm::Triple::ppc64le:
423     case llvm::Triple::sparc:
424     case llvm::Triple::sparcv9:
425     case llvm::Triple::x86:
426     case llvm::Triple::x86_64:
427       return ToolChain::CST_Libcxx;
428     default:
429       break;
430     }
431   }
432   return ToolChain::CST_Libstdcxx;
433 }
434 
435 void NetBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
436                                    llvm::opt::ArgStringList &CC1Args) const {
437   const std::string Candidates[] = {
438     // directory relative to build tree
439     getDriver().Dir + "/../include/c++/v1",
440     // system install with full upstream path
441     getDriver().SysRoot + "/usr/include/c++/v1",
442     // system install from src
443     getDriver().SysRoot + "/usr/include/c++",
444   };
445 
446   for (const auto &IncludePath : Candidates) {
447     if (!getVFS().exists(IncludePath + "/__config"))
448       continue;
449 
450     // Use the first candidate that looks valid.
451     addSystemInclude(DriverArgs, CC1Args, IncludePath);
452     return;
453   }
454 }
455 
456 void NetBSD::addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
457                                       llvm::opt::ArgStringList &CC1Args) const {
458   addLibStdCXXIncludePaths(getDriver().SysRoot + "/usr/include/g++", "", "",
459                            DriverArgs, CC1Args);
460 }
461 
462 llvm::ExceptionHandling NetBSD::GetExceptionModel(const ArgList &Args) const {
463   // NetBSD uses Dwarf exceptions on ARM.
464   llvm::Triple::ArchType TArch = getTriple().getArch();
465   if (TArch == llvm::Triple::arm || TArch == llvm::Triple::armeb ||
466       TArch == llvm::Triple::thumb || TArch == llvm::Triple::thumbeb)
467     return llvm::ExceptionHandling::DwarfCFI;
468   return llvm::ExceptionHandling::None;
469 }
470 
471 SanitizerMask NetBSD::getSupportedSanitizers() const {
472   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
473   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
474   SanitizerMask Res = ToolChain::getSupportedSanitizers();
475   if (IsX86 || IsX86_64) {
476     Res |= SanitizerKind::Address;
477     Res |= SanitizerKind::PointerCompare;
478     Res |= SanitizerKind::PointerSubtract;
479     Res |= SanitizerKind::Function;
480     Res |= SanitizerKind::Leak;
481     Res |= SanitizerKind::SafeStack;
482     Res |= SanitizerKind::Scudo;
483     Res |= SanitizerKind::Vptr;
484   }
485   if (IsX86_64) {
486     Res |= SanitizerKind::DataFlow;
487     Res |= SanitizerKind::Fuzzer;
488     Res |= SanitizerKind::FuzzerNoLink;
489     Res |= SanitizerKind::HWAddress;
490     Res |= SanitizerKind::KernelAddress;
491     Res |= SanitizerKind::KernelHWAddress;
492     Res |= SanitizerKind::KernelMemory;
493     Res |= SanitizerKind::Memory;
494     Res |= SanitizerKind::Thread;
495   }
496   return Res;
497 }
498 
499 void NetBSD::addClangTargetOptions(const ArgList &DriverArgs,
500                                    ArgStringList &CC1Args,
501                                    Action::OffloadKind) const {
502   const SanitizerArgs &SanArgs = getSanitizerArgs();
503   if (SanArgs.hasAnySanitizer())
504     CC1Args.push_back("-D_REENTRANT");
505 
506   unsigned Major, Minor, Micro;
507   getTriple().getOSVersion(Major, Minor, Micro);
508   bool UseInitArrayDefault =
509     Major >= 9 || Major == 0 ||
510     getTriple().getArch() == llvm::Triple::aarch64 ||
511     getTriple().getArch() == llvm::Triple::aarch64_be ||
512     getTriple().getArch() == llvm::Triple::arm ||
513     getTriple().getArch() == llvm::Triple::armeb;
514 
515   if (!DriverArgs.hasFlag(options::OPT_fuse_init_array,
516                           options::OPT_fno_use_init_array, UseInitArrayDefault))
517     CC1Args.push_back("-fno-use-init-array");
518 }
519