1 //===--- Linux.h - Linux 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 "Linux.h"
10 #include "Arch/ARM.h"
11 #include "Arch/Mips.h"
12 #include "Arch/PPC.h"
13 #include "Arch/RISCV.h"
14 #include "CommonArgs.h"
15 #include "clang/Config/config.h"
16 #include "clang/Driver/Distro.h"
17 #include "clang/Driver/Driver.h"
18 #include "clang/Driver/Options.h"
19 #include "clang/Driver/SanitizerArgs.h"
20 #include "llvm/Option/ArgList.h"
21 #include "llvm/ProfileData/InstrProf.h"
22 #include "llvm/Support/Path.h"
23 #include "llvm/Support/ScopedPrinter.h"
24 #include "llvm/Support/VirtualFileSystem.h"
25 #include <system_error>
26 
27 using namespace clang::driver;
28 using namespace clang::driver::toolchains;
29 using namespace clang;
30 using namespace llvm::opt;
31 
32 using tools::addPathIfExists;
33 
34 /// Get our best guess at the multiarch triple for a target.
35 ///
36 /// Debian-based systems are starting to use a multiarch setup where they use
37 /// a target-triple directory in the library and header search paths.
38 /// Unfortunately, this triple does not align with the vanilla target triple,
39 /// so we provide a rough mapping here.
40 std::string Linux::getMultiarchTriple(const Driver &D,
41                                       const llvm::Triple &TargetTriple,
42                                       StringRef SysRoot) const {
43   llvm::Triple::EnvironmentType TargetEnvironment =
44       TargetTriple.getEnvironment();
45   bool IsAndroid = TargetTriple.isAndroid();
46   bool IsMipsR6 = TargetTriple.getSubArch() == llvm::Triple::MipsSubArch_r6;
47   bool IsMipsN32Abi = TargetTriple.getEnvironment() == llvm::Triple::GNUABIN32;
48 
49   // For most architectures, just use whatever we have rather than trying to be
50   // clever.
51   switch (TargetTriple.getArch()) {
52   default:
53     break;
54 
55   // We use the existence of '/lib/<triple>' as a directory to detect some
56   // common linux triples that don't quite match the Clang triple for both
57   // 32-bit and 64-bit targets. Multiarch fixes its install triples to these
58   // regardless of what the actual target triple is.
59   case llvm::Triple::arm:
60   case llvm::Triple::thumb:
61     if (IsAndroid)
62       return "arm-linux-androideabi";
63     if (TargetEnvironment == llvm::Triple::GNUEABIHF)
64       return "arm-linux-gnueabihf";
65     return "arm-linux-gnueabi";
66   case llvm::Triple::armeb:
67   case llvm::Triple::thumbeb:
68     if (TargetEnvironment == llvm::Triple::GNUEABIHF)
69       return "armeb-linux-gnueabihf";
70     return "armeb-linux-gnueabi";
71   case llvm::Triple::x86:
72     if (IsAndroid)
73       return "i686-linux-android";
74     return "i386-linux-gnu";
75   case llvm::Triple::x86_64:
76     if (IsAndroid)
77       return "x86_64-linux-android";
78     if (TargetEnvironment == llvm::Triple::GNUX32)
79       return "x86_64-linux-gnux32";
80     return "x86_64-linux-gnu";
81   case llvm::Triple::aarch64:
82     if (IsAndroid)
83       return "aarch64-linux-android";
84     return "aarch64-linux-gnu";
85   case llvm::Triple::aarch64_be:
86     return "aarch64_be-linux-gnu";
87 
88   case llvm::Triple::m68k:
89     return "m68k-linux-gnu";
90 
91   case llvm::Triple::mips:
92     return IsMipsR6 ? "mipsisa32r6-linux-gnu" : "mips-linux-gnu";
93   case llvm::Triple::mipsel:
94     if (IsAndroid)
95       return "mipsel-linux-android";
96     return IsMipsR6 ? "mipsisa32r6el-linux-gnu" : "mipsel-linux-gnu";
97   case llvm::Triple::mips64: {
98     std::string MT = std::string(IsMipsR6 ? "mipsisa64r6" : "mips64") +
99                      "-linux-" + (IsMipsN32Abi ? "gnuabin32" : "gnuabi64");
100     if (D.getVFS().exists(SysRoot + "/lib/" + MT))
101       return MT;
102     if (D.getVFS().exists(SysRoot + "/lib/mips64-linux-gnu"))
103       return "mips64-linux-gnu";
104     break;
105   }
106   case llvm::Triple::mips64el: {
107     if (IsAndroid)
108       return "mips64el-linux-android";
109     std::string MT = std::string(IsMipsR6 ? "mipsisa64r6el" : "mips64el") +
110                      "-linux-" + (IsMipsN32Abi ? "gnuabin32" : "gnuabi64");
111     if (D.getVFS().exists(SysRoot + "/lib/" + MT))
112       return MT;
113     if (D.getVFS().exists(SysRoot + "/lib/mips64el-linux-gnu"))
114       return "mips64el-linux-gnu";
115     break;
116   }
117   case llvm::Triple::ppc:
118     if (D.getVFS().exists(SysRoot + "/lib/powerpc-linux-gnuspe"))
119       return "powerpc-linux-gnuspe";
120     return "powerpc-linux-gnu";
121   case llvm::Triple::ppcle:
122     return "powerpcle-linux-gnu";
123   case llvm::Triple::ppc64:
124     return "powerpc64-linux-gnu";
125   case llvm::Triple::ppc64le:
126     return "powerpc64le-linux-gnu";
127   case llvm::Triple::sparc:
128     return "sparc-linux-gnu";
129   case llvm::Triple::sparcv9:
130     return "sparc64-linux-gnu";
131   case llvm::Triple::systemz:
132     return "s390x-linux-gnu";
133   }
134   return TargetTriple.str();
135 }
136 
137 static StringRef getOSLibDir(const llvm::Triple &Triple, const ArgList &Args) {
138   if (Triple.isMIPS()) {
139     if (Triple.isAndroid()) {
140       StringRef CPUName;
141       StringRef ABIName;
142       tools::mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
143       if (CPUName == "mips32r6")
144         return "libr6";
145       if (CPUName == "mips32r2")
146         return "libr2";
147     }
148     // lib32 directory has a special meaning on MIPS targets.
149     // It contains N32 ABI binaries. Use this folder if produce
150     // code for N32 ABI only.
151     if (tools::mips::hasMipsAbiArg(Args, "n32"))
152       return "lib32";
153     return Triple.isArch32Bit() ? "lib" : "lib64";
154   }
155 
156   // It happens that only x86, PPC and SPARC use the 'lib32' variant of
157   // oslibdir, and using that variant while targeting other architectures causes
158   // problems because the libraries are laid out in shared system roots that
159   // can't cope with a 'lib32' library search path being considered. So we only
160   // enable them when we know we may need it.
161   //
162   // FIXME: This is a bit of a hack. We should really unify this code for
163   // reasoning about oslibdir spellings with the lib dir spellings in the
164   // GCCInstallationDetector, but that is a more significant refactoring.
165   if (Triple.getArch() == llvm::Triple::x86 || Triple.isPPC32() ||
166       Triple.getArch() == llvm::Triple::sparc)
167     return "lib32";
168 
169   if (Triple.getArch() == llvm::Triple::x86_64 && Triple.isX32())
170     return "libx32";
171 
172   if (Triple.getArch() == llvm::Triple::riscv32)
173     return "lib32";
174 
175   return Triple.isArch32Bit() ? "lib" : "lib64";
176 }
177 
178 Linux::Linux(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
179     : Generic_ELF(D, Triple, Args) {
180   GCCInstallation.init(Triple, Args);
181   Multilibs = GCCInstallation.getMultilibs();
182   SelectedMultilib = GCCInstallation.getMultilib();
183   llvm::Triple::ArchType Arch = Triple.getArch();
184   std::string SysRoot = computeSysRoot();
185   ToolChain::path_list &PPaths = getProgramPaths();
186 
187   Generic_GCC::PushPPaths(PPaths);
188 
189   Distro Distro(D.getVFS(), Triple);
190 
191   if (Distro.IsAlpineLinux() || Triple.isAndroid()) {
192     ExtraOpts.push_back("-z");
193     ExtraOpts.push_back("now");
194   }
195 
196   if (Distro.IsOpenSUSE() || Distro.IsUbuntu() || Distro.IsAlpineLinux() ||
197       Triple.isAndroid()) {
198     ExtraOpts.push_back("-z");
199     ExtraOpts.push_back("relro");
200   }
201 
202   // Android ARM/AArch64 use max-page-size=4096 to reduce VMA usage. Note, lld
203   // from 11 onwards default max-page-size to 65536 for both ARM and AArch64.
204   if ((Triple.isARM() || Triple.isAArch64()) && Triple.isAndroid()) {
205     ExtraOpts.push_back("-z");
206     ExtraOpts.push_back("max-page-size=4096");
207   }
208 
209   if (GCCInstallation.getParentLibPath().contains("opt/rh/"))
210     // With devtoolset on RHEL, we want to add a bin directory that is relative
211     // to the detected gcc install, because if we are using devtoolset gcc then
212     // we want to use other tools from devtoolset (e.g. ld) instead of the
213     // standard system tools.
214     PPaths.push_back(Twine(GCCInstallation.getParentLibPath() +
215                      "/../bin").str());
216 
217   if (Arch == llvm::Triple::arm || Arch == llvm::Triple::thumb)
218     ExtraOpts.push_back("-X");
219 
220   const bool IsAndroid = Triple.isAndroid();
221   const bool IsMips = Triple.isMIPS();
222   const bool IsHexagon = Arch == llvm::Triple::hexagon;
223   const bool IsRISCV = Triple.isRISCV();
224 
225   if (IsMips && !SysRoot.empty())
226     ExtraOpts.push_back("--sysroot=" + SysRoot);
227 
228   // Do not use 'gnu' hash style for Mips targets because .gnu.hash
229   // and the MIPS ABI require .dynsym to be sorted in different ways.
230   // .gnu.hash needs symbols to be grouped by hash code whereas the MIPS
231   // ABI requires a mapping between the GOT and the symbol table.
232   // Android loader does not support .gnu.hash until API 23.
233   // Hexagon linker/loader does not support .gnu.hash
234   if (!IsMips && !IsHexagon) {
235     if (Distro.IsRedhat() || Distro.IsOpenSUSE() || Distro.IsAlpineLinux() ||
236         (Distro.IsUbuntu() && Distro >= Distro::UbuntuMaverick) ||
237         (IsAndroid && !Triple.isAndroidVersionLT(23)))
238       ExtraOpts.push_back("--hash-style=gnu");
239 
240     if (Distro.IsDebian() || Distro.IsOpenSUSE() ||
241         Distro == Distro::UbuntuLucid || Distro == Distro::UbuntuJaunty ||
242         Distro == Distro::UbuntuKarmic ||
243         (IsAndroid && Triple.isAndroidVersionLT(23)))
244       ExtraOpts.push_back("--hash-style=both");
245   }
246 
247 #ifdef ENABLE_LINKER_BUILD_ID
248   ExtraOpts.push_back("--build-id");
249 #endif
250 
251   if (IsAndroid || Distro.IsOpenSUSE())
252     ExtraOpts.push_back("--enable-new-dtags");
253 
254   // The selection of paths to try here is designed to match the patterns which
255   // the GCC driver itself uses, as this is part of the GCC-compatible driver.
256   // This was determined by running GCC in a fake filesystem, creating all
257   // possible permutations of these directories, and seeing which ones it added
258   // to the link paths.
259   path_list &Paths = getFilePaths();
260 
261   const std::string OSLibDir = std::string(getOSLibDir(Triple, Args));
262   const std::string MultiarchTriple = getMultiarchTriple(D, Triple, SysRoot);
263   const std::string &ExtraPath = D.OverlayToolChainPath;
264 
265   if (!D.OverlayToolChainPath.empty()) {
266     addPathIfExists(D, ExtraPath + "/lib/" + MultiarchTriple, Paths);
267     addPathIfExists(D, ExtraPath + "/lib/../" + OSLibDir, Paths);
268     addPathIfExists(D, ExtraPath + "/usr/lib/" + MultiarchTriple, Paths);
269     addPathIfExists(D, ExtraPath + "/usr/lib/../" + OSLibDir, Paths);
270   }
271 
272   // mips32: Debian multilib, we use /libo32, while in other case, /lib is
273   // used. We need add both libo32 and /lib.
274   if (Arch == llvm::Triple::mips || Arch == llvm::Triple::mipsel) {
275     Generic_GCC::AddMultilibPaths(D, SysRoot, "libo32", MultiarchTriple, Paths);
276     addPathIfExists(D, SysRoot + "/libo32", Paths);
277     addPathIfExists(D, SysRoot + "/usr/libo32", Paths);
278   }
279   Generic_GCC::AddMultilibPaths(D, SysRoot, OSLibDir, MultiarchTriple, Paths);
280 
281   addPathIfExists(D, SysRoot + "/lib/" + MultiarchTriple, Paths);
282   addPathIfExists(D, SysRoot + "/lib/../" + OSLibDir, Paths);
283 
284   if (IsAndroid) {
285     // Android sysroots contain a library directory for each supported OS
286     // version as well as some unversioned libraries in the usual multiarch
287     // directory.
288     addPathIfExists(
289         D,
290         SysRoot + "/usr/lib/" + MultiarchTriple + "/" +
291             llvm::to_string(Triple.getEnvironmentVersion().getMajor()),
292         Paths);
293   }
294 
295   addPathIfExists(D, SysRoot + "/usr/lib/" + MultiarchTriple, Paths);
296   // 64-bit OpenEmbedded sysroots may not have a /usr/lib dir. So they cannot
297   // find /usr/lib64 as it is referenced as /usr/lib/../lib64. So we handle
298   // this here.
299   if (Triple.getVendor() == llvm::Triple::OpenEmbedded &&
300       Triple.isArch64Bit())
301     addPathIfExists(D, SysRoot + "/usr/" + OSLibDir, Paths);
302   else
303     addPathIfExists(D, SysRoot + "/usr/lib/../" + OSLibDir, Paths);
304   if (IsRISCV) {
305     StringRef ABIName = tools::riscv::getRISCVABI(Args, Triple);
306     addPathIfExists(D, SysRoot + "/" + OSLibDir + "/" + ABIName, Paths);
307     addPathIfExists(D, SysRoot + "/usr/" + OSLibDir + "/" + ABIName, Paths);
308   }
309 
310   Generic_GCC::AddMultiarchPaths(D, SysRoot, OSLibDir, Paths);
311 
312   // The deprecated -DLLVM_ENABLE_PROJECTS=libcxx configuration installs
313   // libc++.so in D.Dir+"/../lib/". Detect this path.
314   // TODO Remove once LLVM_ENABLE_PROJECTS=libcxx is unsupported.
315   if (StringRef(D.Dir).startswith(SysRoot) &&
316       D.getVFS().exists(D.Dir + "/../lib/libc++.so"))
317     addPathIfExists(D, D.Dir + "/../lib", Paths);
318 
319   if (!D.OverlayToolChainPath.empty()) {
320     addPathIfExists(D, ExtraPath + "/lib", Paths);
321     addPathIfExists(D, ExtraPath + "/usr/lib", Paths);
322   }
323 
324   addPathIfExists(D, SysRoot + "/lib", Paths);
325   addPathIfExists(D, SysRoot + "/usr/lib", Paths);
326 }
327 
328 ToolChain::RuntimeLibType Linux::GetDefaultRuntimeLibType() const {
329   if (getTriple().isAndroid())
330     return ToolChain::RLT_CompilerRT;
331   return Generic_ELF::GetDefaultRuntimeLibType();
332 }
333 
334 unsigned Linux::GetDefaultDwarfVersion() const {
335   if (getTriple().isAndroid())
336     return 4;
337   return ToolChain::GetDefaultDwarfVersion();
338 }
339 
340 ToolChain::CXXStdlibType Linux::GetDefaultCXXStdlibType() const {
341   if (getTriple().isAndroid())
342     return ToolChain::CST_Libcxx;
343   return ToolChain::CST_Libstdcxx;
344 }
345 
346 bool Linux::HasNativeLLVMSupport() const { return true; }
347 
348 Tool *Linux::buildLinker() const { return new tools::gnutools::Linker(*this); }
349 
350 Tool *Linux::buildStaticLibTool() const {
351   return new tools::gnutools::StaticLibTool(*this);
352 }
353 
354 Tool *Linux::buildAssembler() const {
355   return new tools::gnutools::Assembler(*this);
356 }
357 
358 std::string Linux::computeSysRoot() const {
359   if (!getDriver().SysRoot.empty())
360     return getDriver().SysRoot;
361 
362   if (getTriple().isAndroid()) {
363     // Android toolchains typically include a sysroot at ../sysroot relative to
364     // the clang binary.
365     const StringRef ClangDir = getDriver().getInstalledDir();
366     std::string AndroidSysRootPath = (ClangDir + "/../sysroot").str();
367     if (getVFS().exists(AndroidSysRootPath))
368       return AndroidSysRootPath;
369   }
370 
371   if (!GCCInstallation.isValid() || !getTriple().isMIPS())
372     return std::string();
373 
374   // Standalone MIPS toolchains use different names for sysroot folder
375   // and put it into different places. Here we try to check some known
376   // variants.
377 
378   const StringRef InstallDir = GCCInstallation.getInstallPath();
379   const StringRef TripleStr = GCCInstallation.getTriple().str();
380   const Multilib &Multilib = GCCInstallation.getMultilib();
381 
382   std::string Path =
383       (InstallDir + "/../../../../" + TripleStr + "/libc" + Multilib.osSuffix())
384           .str();
385 
386   if (getVFS().exists(Path))
387     return Path;
388 
389   Path = (InstallDir + "/../../../../sysroot" + Multilib.osSuffix()).str();
390 
391   if (getVFS().exists(Path))
392     return Path;
393 
394   return std::string();
395 }
396 
397 std::string Linux::getDynamicLinker(const ArgList &Args) const {
398   const llvm::Triple::ArchType Arch = getArch();
399   const llvm::Triple &Triple = getTriple();
400 
401   const Distro Distro(getDriver().getVFS(), Triple);
402 
403   if (Triple.isAndroid())
404     return Triple.isArch64Bit() ? "/system/bin/linker64" : "/system/bin/linker";
405 
406   if (Triple.isMusl()) {
407     std::string ArchName;
408     bool IsArm = false;
409 
410     switch (Arch) {
411     case llvm::Triple::arm:
412     case llvm::Triple::thumb:
413       ArchName = "arm";
414       IsArm = true;
415       break;
416     case llvm::Triple::armeb:
417     case llvm::Triple::thumbeb:
418       ArchName = "armeb";
419       IsArm = true;
420       break;
421     case llvm::Triple::x86:
422       ArchName = "i386";
423       break;
424     case llvm::Triple::x86_64:
425       ArchName = Triple.isX32() ? "x32" : Triple.getArchName().str();
426       break;
427     default:
428       ArchName = Triple.getArchName().str();
429     }
430     if (IsArm &&
431         (Triple.getEnvironment() == llvm::Triple::MuslEABIHF ||
432          tools::arm::getARMFloatABI(*this, Args) == tools::arm::FloatABI::Hard))
433       ArchName += "hf";
434     if (Arch == llvm::Triple::ppc &&
435         Triple.getSubArch() == llvm::Triple::PPCSubArch_spe)
436       ArchName = "powerpc-sf";
437 
438     return "/lib/ld-musl-" + ArchName + ".so.1";
439   }
440 
441   std::string LibDir;
442   std::string Loader;
443 
444   switch (Arch) {
445   default:
446     llvm_unreachable("unsupported architecture");
447 
448   case llvm::Triple::aarch64:
449     LibDir = "lib";
450     Loader = "ld-linux-aarch64.so.1";
451     break;
452   case llvm::Triple::aarch64_be:
453     LibDir = "lib";
454     Loader = "ld-linux-aarch64_be.so.1";
455     break;
456   case llvm::Triple::arm:
457   case llvm::Triple::thumb:
458   case llvm::Triple::armeb:
459   case llvm::Triple::thumbeb: {
460     const bool HF =
461         Triple.getEnvironment() == llvm::Triple::GNUEABIHF ||
462         tools::arm::getARMFloatABI(*this, Args) == tools::arm::FloatABI::Hard;
463 
464     LibDir = "lib";
465     Loader = HF ? "ld-linux-armhf.so.3" : "ld-linux.so.3";
466     break;
467   }
468   case llvm::Triple::m68k:
469     LibDir = "lib";
470     Loader = "ld.so.1";
471     break;
472   case llvm::Triple::mips:
473   case llvm::Triple::mipsel:
474   case llvm::Triple::mips64:
475   case llvm::Triple::mips64el: {
476     bool IsNaN2008 = tools::mips::isNaN2008(getDriver(), Args, Triple);
477 
478     LibDir = "lib" + tools::mips::getMipsABILibSuffix(Args, Triple);
479 
480     if (tools::mips::isUCLibc(Args))
481       Loader = IsNaN2008 ? "ld-uClibc-mipsn8.so.0" : "ld-uClibc.so.0";
482     else if (!Triple.hasEnvironment() &&
483              Triple.getVendor() == llvm::Triple::VendorType::MipsTechnologies)
484       Loader =
485           Triple.isLittleEndian() ? "ld-musl-mipsel.so.1" : "ld-musl-mips.so.1";
486     else
487       Loader = IsNaN2008 ? "ld-linux-mipsn8.so.1" : "ld.so.1";
488 
489     break;
490   }
491   case llvm::Triple::ppc:
492     LibDir = "lib";
493     Loader = "ld.so.1";
494     break;
495   case llvm::Triple::ppcle:
496     LibDir = "lib";
497     Loader = "ld.so.1";
498     break;
499   case llvm::Triple::ppc64:
500     LibDir = "lib64";
501     Loader =
502         (tools::ppc::hasPPCAbiArg(Args, "elfv2")) ? "ld64.so.2" : "ld64.so.1";
503     break;
504   case llvm::Triple::ppc64le:
505     LibDir = "lib64";
506     Loader =
507         (tools::ppc::hasPPCAbiArg(Args, "elfv1")) ? "ld64.so.1" : "ld64.so.2";
508     break;
509   case llvm::Triple::riscv32: {
510     StringRef ABIName = tools::riscv::getRISCVABI(Args, Triple);
511     LibDir = "lib";
512     Loader = ("ld-linux-riscv32-" + ABIName + ".so.1").str();
513     break;
514   }
515   case llvm::Triple::riscv64: {
516     StringRef ABIName = tools::riscv::getRISCVABI(Args, Triple);
517     LibDir = "lib";
518     Loader = ("ld-linux-riscv64-" + ABIName + ".so.1").str();
519     break;
520   }
521   case llvm::Triple::sparc:
522   case llvm::Triple::sparcel:
523     LibDir = "lib";
524     Loader = "ld-linux.so.2";
525     break;
526   case llvm::Triple::sparcv9:
527     LibDir = "lib64";
528     Loader = "ld-linux.so.2";
529     break;
530   case llvm::Triple::systemz:
531     LibDir = "lib";
532     Loader = "ld64.so.1";
533     break;
534   case llvm::Triple::x86:
535     LibDir = "lib";
536     Loader = "ld-linux.so.2";
537     break;
538   case llvm::Triple::x86_64: {
539     bool X32 = Triple.isX32();
540 
541     LibDir = X32 ? "libx32" : "lib64";
542     Loader = X32 ? "ld-linux-x32.so.2" : "ld-linux-x86-64.so.2";
543     break;
544   }
545   case llvm::Triple::ve:
546     return "/opt/nec/ve/lib/ld-linux-ve.so.1";
547   }
548 
549   if (Distro == Distro::Exherbo &&
550       (Triple.getVendor() == llvm::Triple::UnknownVendor ||
551        Triple.getVendor() == llvm::Triple::PC))
552     return "/usr/" + Triple.str() + "/lib/" + Loader;
553   return "/" + LibDir + "/" + Loader;
554 }
555 
556 void Linux::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
557                                       ArgStringList &CC1Args) const {
558   const Driver &D = getDriver();
559   std::string SysRoot = computeSysRoot();
560 
561   if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
562     return;
563 
564   // Add 'include' in the resource directory, which is similar to
565   // GCC_INCLUDE_DIR (private headers) in GCC. Note: the include directory
566   // contains some files conflicting with system /usr/include. musl systems
567   // prefer the /usr/include copies which are more relevant.
568   SmallString<128> ResourceDirInclude(D.ResourceDir);
569   llvm::sys::path::append(ResourceDirInclude, "include");
570   if (!DriverArgs.hasArg(options::OPT_nobuiltininc) &&
571       (!getTriple().isMusl() || DriverArgs.hasArg(options::OPT_nostdlibinc)))
572     addSystemInclude(DriverArgs, CC1Args, ResourceDirInclude);
573 
574   if (DriverArgs.hasArg(options::OPT_nostdlibinc))
575     return;
576 
577   if (!D.OverlayToolChainPath.empty())
578     addExternCSystemInclude(DriverArgs, CC1Args,
579                             D.OverlayToolChainPath + "/include");
580 
581   // LOCAL_INCLUDE_DIR
582   addSystemInclude(DriverArgs, CC1Args, SysRoot + "/usr/local/include");
583   // TOOL_INCLUDE_DIR
584   AddMultilibIncludeArgs(DriverArgs, CC1Args);
585 
586   // Check for configure-time C include directories.
587   StringRef CIncludeDirs(C_INCLUDE_DIRS);
588   if (CIncludeDirs != "") {
589     SmallVector<StringRef, 5> dirs;
590     CIncludeDirs.split(dirs, ":");
591     for (StringRef dir : dirs) {
592       StringRef Prefix =
593           llvm::sys::path::is_absolute(dir) ? "" : StringRef(SysRoot);
594       addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
595     }
596     return;
597   }
598 
599   // On systems using multiarch and Android, add /usr/include/$triple before
600   // /usr/include.
601   std::string MultiarchIncludeDir = getMultiarchTriple(D, getTriple(), SysRoot);
602   if (!MultiarchIncludeDir.empty() &&
603       D.getVFS().exists(SysRoot + "/usr/include/" + MultiarchIncludeDir))
604     addExternCSystemInclude(DriverArgs, CC1Args,
605                             SysRoot + "/usr/include/" + MultiarchIncludeDir);
606 
607   if (getTriple().getOS() == llvm::Triple::RTEMS)
608     return;
609 
610   // Add an include of '/include' directly. This isn't provided by default by
611   // system GCCs, but is often used with cross-compiling GCCs, and harmless to
612   // add even when Clang is acting as-if it were a system compiler.
613   addExternCSystemInclude(DriverArgs, CC1Args, SysRoot + "/include");
614 
615   addExternCSystemInclude(DriverArgs, CC1Args, SysRoot + "/usr/include");
616 
617   if (!DriverArgs.hasArg(options::OPT_nobuiltininc) && getTriple().isMusl())
618     addSystemInclude(DriverArgs, CC1Args, ResourceDirInclude);
619 }
620 
621 void Linux::addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
622                                      llvm::opt::ArgStringList &CC1Args) const {
623   // We need a detected GCC installation on Linux to provide libstdc++'s
624   // headers in odd Linuxish places.
625   if (!GCCInstallation.isValid())
626     return;
627 
628   // Detect Debian g++-multiarch-incdir.diff.
629   StringRef TripleStr = GCCInstallation.getTriple().str();
630   StringRef DebianMultiarch =
631       GCCInstallation.getTriple().getArch() == llvm::Triple::x86
632           ? "i386-linux-gnu"
633           : TripleStr;
634 
635   // Try generic GCC detection first.
636   if (Generic_GCC::addGCCLibStdCxxIncludePaths(DriverArgs, CC1Args,
637                                                DebianMultiarch))
638     return;
639 
640   StringRef LibDir = GCCInstallation.getParentLibPath();
641   const Multilib &Multilib = GCCInstallation.getMultilib();
642   const GCCVersion &Version = GCCInstallation.getVersion();
643 
644   const std::string LibStdCXXIncludePathCandidates[] = {
645       // Android standalone toolchain has C++ headers in yet another place.
646       LibDir.str() + "/../" + TripleStr.str() + "/include/c++/" + Version.Text,
647       // Freescale SDK C++ headers are directly in <sysroot>/usr/include/c++,
648       // without a subdirectory corresponding to the gcc version.
649       LibDir.str() + "/../include/c++",
650       // Cray's gcc installation puts headers under "g++" without a
651       // version suffix.
652       LibDir.str() + "/../include/g++",
653   };
654 
655   for (const auto &IncludePath : LibStdCXXIncludePathCandidates) {
656     if (addLibStdCXXIncludePaths(IncludePath, TripleStr,
657                                  Multilib.includeSuffix(), DriverArgs, CC1Args))
658       break;
659   }
660 }
661 
662 void Linux::AddCudaIncludeArgs(const ArgList &DriverArgs,
663                                ArgStringList &CC1Args) const {
664   CudaInstallation.AddCudaIncludeArgs(DriverArgs, CC1Args);
665 }
666 
667 void Linux::AddHIPIncludeArgs(const ArgList &DriverArgs,
668                               ArgStringList &CC1Args) const {
669   RocmInstallation.AddHIPIncludeArgs(DriverArgs, CC1Args);
670 }
671 
672 void Linux::AddIAMCUIncludeArgs(const ArgList &DriverArgs,
673                                 ArgStringList &CC1Args) const {
674   if (GCCInstallation.isValid()) {
675     CC1Args.push_back("-isystem");
676     CC1Args.push_back(DriverArgs.MakeArgString(
677         GCCInstallation.getParentLibPath() + "/../" +
678         GCCInstallation.getTriple().str() + "/include"));
679   }
680 }
681 
682 bool Linux::isPIEDefault(const llvm::opt::ArgList &Args) const {
683   return CLANG_DEFAULT_PIE_ON_LINUX || getTriple().isAndroid() ||
684          getTriple().isMusl() || getSanitizerArgs(Args).requiresPIE();
685 }
686 
687 bool Linux::IsAArch64OutlineAtomicsDefault(const ArgList &Args) const {
688   // Outline atomics for AArch64 are supported by compiler-rt
689   // and libgcc since 9.3.1
690   assert(getTriple().isAArch64() && "expected AArch64 target!");
691   ToolChain::RuntimeLibType RtLib = GetRuntimeLibType(Args);
692   if (RtLib == ToolChain::RLT_CompilerRT)
693     return true;
694   assert(RtLib == ToolChain::RLT_Libgcc && "unexpected runtime library type!");
695   if (GCCInstallation.getVersion().isOlderThan(9, 3, 1))
696     return false;
697   return true;
698 }
699 
700 bool Linux::IsMathErrnoDefault() const {
701   if (getTriple().isAndroid() || getTriple().isMusl())
702     return false;
703   return Generic_ELF::IsMathErrnoDefault();
704 }
705 
706 SanitizerMask Linux::getSupportedSanitizers() const {
707   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
708   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
709   const bool IsMIPS = getTriple().isMIPS32();
710   const bool IsMIPS64 = getTriple().isMIPS64();
711   const bool IsPowerPC64 = getTriple().getArch() == llvm::Triple::ppc64 ||
712                            getTriple().getArch() == llvm::Triple::ppc64le;
713   const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64 ||
714                          getTriple().getArch() == llvm::Triple::aarch64_be;
715   const bool IsArmArch = getTriple().getArch() == llvm::Triple::arm ||
716                          getTriple().getArch() == llvm::Triple::thumb ||
717                          getTriple().getArch() == llvm::Triple::armeb ||
718                          getTriple().getArch() == llvm::Triple::thumbeb;
719   const bool IsRISCV64 = getTriple().getArch() == llvm::Triple::riscv64;
720   const bool IsSystemZ = getTriple().getArch() == llvm::Triple::systemz;
721   const bool IsHexagon = getTriple().getArch() == llvm::Triple::hexagon;
722   SanitizerMask Res = ToolChain::getSupportedSanitizers();
723   Res |= SanitizerKind::Address;
724   Res |= SanitizerKind::PointerCompare;
725   Res |= SanitizerKind::PointerSubtract;
726   Res |= SanitizerKind::Fuzzer;
727   Res |= SanitizerKind::FuzzerNoLink;
728   Res |= SanitizerKind::KernelAddress;
729   Res |= SanitizerKind::Memory;
730   Res |= SanitizerKind::Vptr;
731   Res |= SanitizerKind::SafeStack;
732   if (IsX86_64 || IsMIPS64 || IsAArch64)
733     Res |= SanitizerKind::DataFlow;
734   if (IsX86_64 || IsMIPS64 || IsAArch64 || IsX86 || IsArmArch || IsPowerPC64 ||
735       IsRISCV64 || IsSystemZ || IsHexagon)
736     Res |= SanitizerKind::Leak;
737   if (IsX86_64 || IsMIPS64 || IsAArch64 || IsPowerPC64 || IsSystemZ)
738     Res |= SanitizerKind::Thread;
739   if (IsX86_64)
740     Res |= SanitizerKind::KernelMemory;
741   if (IsX86 || IsX86_64)
742     Res |= SanitizerKind::Function;
743   if (IsX86_64 || IsMIPS64 || IsAArch64 || IsX86 || IsMIPS || IsArmArch ||
744       IsPowerPC64 || IsHexagon)
745     Res |= SanitizerKind::Scudo;
746   if (IsX86_64 || IsAArch64) {
747     Res |= SanitizerKind::HWAddress;
748     Res |= SanitizerKind::KernelHWAddress;
749   }
750   return Res;
751 }
752 
753 void Linux::addProfileRTLibs(const llvm::opt::ArgList &Args,
754                              llvm::opt::ArgStringList &CmdArgs) const {
755   // Add linker option -u__llvm_profile_runtime to cause runtime
756   // initialization module to be linked in.
757   if (needsProfileRT(Args))
758     CmdArgs.push_back(Args.MakeArgString(
759         Twine("-u", llvm::getInstrProfRuntimeHookVarName())));
760   ToolChain::addProfileRTLibs(Args, CmdArgs);
761 }
762 
763 llvm::DenormalMode
764 Linux::getDefaultDenormalModeForType(const llvm::opt::ArgList &DriverArgs,
765                                      const JobAction &JA,
766                                      const llvm::fltSemantics *FPType) const {
767   switch (getTriple().getArch()) {
768   case llvm::Triple::x86:
769   case llvm::Triple::x86_64: {
770     std::string Unused;
771     // DAZ and FTZ are turned on in crtfastmath.o
772     if (!DriverArgs.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles) &&
773         isFastMathRuntimeAvailable(DriverArgs, Unused))
774       return llvm::DenormalMode::getPreserveSign();
775     return llvm::DenormalMode::getIEEE();
776   }
777   default:
778     return llvm::DenormalMode::getIEEE();
779   }
780 }
781 
782 void Linux::addExtraOpts(llvm::opt::ArgStringList &CmdArgs) const {
783   for (const auto &Opt : ExtraOpts)
784     CmdArgs.push_back(Opt.c_str());
785 }
786