xref: /freebsd/contrib/llvm-project/clang/lib/Driver/ToolChain.cpp (revision 2f513db72b034fd5ef7f080b11be5c711c15186a) 
1 //===- ToolChain.cpp - Collections of tools for one platform --------------===//
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 "clang/Driver/ToolChain.h"
10 #include "InputInfo.h"
11 #include "ToolChains/Arch/ARM.h"
12 #include "ToolChains/Clang.h"
13 #include "clang/Basic/ObjCRuntime.h"
14 #include "clang/Basic/Sanitizers.h"
15 #include "clang/Config/config.h"
16 #include "clang/Driver/Action.h"
17 #include "clang/Driver/Driver.h"
18 #include "clang/Driver/DriverDiagnostic.h"
19 #include "clang/Driver/Job.h"
20 #include "clang/Driver/Options.h"
21 #include "clang/Driver/SanitizerArgs.h"
22 #include "clang/Driver/XRayArgs.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/ADT/SmallString.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/ADT/Triple.h"
27 #include "llvm/ADT/Twine.h"
28 #include "llvm/Config/llvm-config.h"
29 #include "llvm/MC/MCTargetOptions.h"
30 #include "llvm/Option/Arg.h"
31 #include "llvm/Option/ArgList.h"
32 #include "llvm/Option/OptTable.h"
33 #include "llvm/Option/Option.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/FileSystem.h"
36 #include "llvm/Support/Path.h"
37 #include "llvm/Support/TargetParser.h"
38 #include "llvm/Support/TargetRegistry.h"
39 #include "llvm/Support/VersionTuple.h"
40 #include "llvm/Support/VirtualFileSystem.h"
41 #include <cassert>
42 #include <cstddef>
43 #include <cstring>
44 #include <string>
45 
46 using namespace clang;
47 using namespace driver;
48 using namespace tools;
49 using namespace llvm;
50 using namespace llvm::opt;
51 
52 static llvm::opt::Arg *GetRTTIArgument(const ArgList &Args) {
53   return Args.getLastArg(options::OPT_mkernel, options::OPT_fapple_kext,
54                          options::OPT_fno_rtti, options::OPT_frtti);
55 }
56 
57 static ToolChain::RTTIMode CalculateRTTIMode(const ArgList &Args,
58                                              const llvm::Triple &Triple,
59                                              const Arg *CachedRTTIArg) {
60   // Explicit rtti/no-rtti args
61   if (CachedRTTIArg) {
62     if (CachedRTTIArg->getOption().matches(options::OPT_frtti))
63       return ToolChain::RM_Enabled;
64     else
65       return ToolChain::RM_Disabled;
66   }
67 
68   // -frtti is default, except for the PS4 CPU.
69   return (Triple.isPS4CPU()) ? ToolChain::RM_Disabled : ToolChain::RM_Enabled;
70 }
71 
72 ToolChain::ToolChain(const Driver &D, const llvm::Triple &T,
73                      const ArgList &Args)
74     : D(D), Triple(T), Args(Args), CachedRTTIArg(GetRTTIArgument(Args)),
75       CachedRTTIMode(CalculateRTTIMode(Args, Triple, CachedRTTIArg)) {
76   if (D.CCCIsCXX()) {
77     if (auto CXXStdlibPath = getCXXStdlibPath())
78       getFilePaths().push_back(*CXXStdlibPath);
79   }
80 
81   if (auto RuntimePath = getRuntimePath())
82     getLibraryPaths().push_back(*RuntimePath);
83 
84   std::string CandidateLibPath = getArchSpecificLibPath();
85   if (getVFS().exists(CandidateLibPath))
86     getFilePaths().push_back(CandidateLibPath);
87 }
88 
89 void ToolChain::setTripleEnvironment(llvm::Triple::EnvironmentType Env) {
90   Triple.setEnvironment(Env);
91   if (EffectiveTriple != llvm::Triple())
92     EffectiveTriple.setEnvironment(Env);
93 }
94 
95 ToolChain::~ToolChain() = default;
96 
97 llvm::vfs::FileSystem &ToolChain::getVFS() const {
98   return getDriver().getVFS();
99 }
100 
101 bool ToolChain::useIntegratedAs() const {
102   return Args.hasFlag(options::OPT_fintegrated_as,
103                       options::OPT_fno_integrated_as,
104                       IsIntegratedAssemblerDefault());
105 }
106 
107 bool ToolChain::useRelaxRelocations() const {
108   return ENABLE_X86_RELAX_RELOCATIONS;
109 }
110 
111 bool ToolChain::isNoExecStackDefault() const {
112     return false;
113 }
114 
115 const SanitizerArgs& ToolChain::getSanitizerArgs() const {
116   if (!SanitizerArguments.get())
117     SanitizerArguments.reset(new SanitizerArgs(*this, Args));
118   return *SanitizerArguments.get();
119 }
120 
121 const XRayArgs& ToolChain::getXRayArgs() const {
122   if (!XRayArguments.get())
123     XRayArguments.reset(new XRayArgs(*this, Args));
124   return *XRayArguments.get();
125 }
126 
127 namespace {
128 
129 struct DriverSuffix {
130   const char *Suffix;
131   const char *ModeFlag;
132 };
133 
134 } // namespace
135 
136 static const DriverSuffix *FindDriverSuffix(StringRef ProgName, size_t &Pos) {
137   // A list of known driver suffixes. Suffixes are compared against the
138   // program name in order. If there is a match, the frontend type is updated as
139   // necessary by applying the ModeFlag.
140   static const DriverSuffix DriverSuffixes[] = {
141       {"clang", nullptr},
142       {"clang++", "--driver-mode=g++"},
143       {"clang-c++", "--driver-mode=g++"},
144       {"clang-cc", nullptr},
145       {"clang-cpp", "--driver-mode=cpp"},
146       {"clang-g++", "--driver-mode=g++"},
147       {"clang-gcc", nullptr},
148       {"clang-cl", "--driver-mode=cl"},
149       {"cc", nullptr},
150       {"cpp", "--driver-mode=cpp"},
151       {"cl", "--driver-mode=cl"},
152       {"++", "--driver-mode=g++"},
153   };
154 
155   for (size_t i = 0; i < llvm::array_lengthof(DriverSuffixes); ++i) {
156     StringRef Suffix(DriverSuffixes[i].Suffix);
157     if (ProgName.endswith(Suffix)) {
158       Pos = ProgName.size() - Suffix.size();
159       return &DriverSuffixes[i];
160     }
161   }
162   return nullptr;
163 }
164 
165 /// Normalize the program name from argv[0] by stripping the file extension if
166 /// present and lower-casing the string on Windows.
167 static std::string normalizeProgramName(llvm::StringRef Argv0) {
168   std::string ProgName = llvm::sys::path::stem(Argv0);
169 #ifdef _WIN32
170   // Transform to lowercase for case insensitive file systems.
171   std::transform(ProgName.begin(), ProgName.end(), ProgName.begin(), ::tolower);
172 #endif
173   return ProgName;
174 }
175 
176 static const DriverSuffix *parseDriverSuffix(StringRef ProgName, size_t &Pos) {
177   // Try to infer frontend type and default target from the program name by
178   // comparing it against DriverSuffixes in order.
179 
180   // If there is a match, the function tries to identify a target as prefix.
181   // E.g. "x86_64-linux-clang" as interpreted as suffix "clang" with target
182   // prefix "x86_64-linux". If such a target prefix is found, it may be
183   // added via -target as implicit first argument.
184   const DriverSuffix *DS = FindDriverSuffix(ProgName, Pos);
185 
186   if (!DS) {
187     // Try again after stripping any trailing version number:
188     // clang++3.5 -> clang++
189     ProgName = ProgName.rtrim("0123456789.");
190     DS = FindDriverSuffix(ProgName, Pos);
191   }
192 
193   if (!DS) {
194     // Try again after stripping trailing -component.
195     // clang++-tot -> clang++
196     ProgName = ProgName.slice(0, ProgName.rfind('-'));
197     DS = FindDriverSuffix(ProgName, Pos);
198   }
199   return DS;
200 }
201 
202 ParsedClangName
203 ToolChain::getTargetAndModeFromProgramName(StringRef PN) {
204   std::string ProgName = normalizeProgramName(PN);
205   size_t SuffixPos;
206   const DriverSuffix *DS = parseDriverSuffix(ProgName, SuffixPos);
207   if (!DS)
208     return {};
209   size_t SuffixEnd = SuffixPos + strlen(DS->Suffix);
210 
211   size_t LastComponent = ProgName.rfind('-', SuffixPos);
212   if (LastComponent == std::string::npos)
213     return ParsedClangName(ProgName.substr(0, SuffixEnd), DS->ModeFlag);
214   std::string ModeSuffix = ProgName.substr(LastComponent + 1,
215                                            SuffixEnd - LastComponent - 1);
216 
217   // Infer target from the prefix.
218   StringRef Prefix(ProgName);
219   Prefix = Prefix.slice(0, LastComponent);
220   std::string IgnoredError;
221   bool IsRegistered = llvm::TargetRegistry::lookupTarget(Prefix, IgnoredError);
222   return ParsedClangName{Prefix, ModeSuffix, DS->ModeFlag, IsRegistered};
223 }
224 
225 StringRef ToolChain::getDefaultUniversalArchName() const {
226   // In universal driver terms, the arch name accepted by -arch isn't exactly
227   // the same as the ones that appear in the triple. Roughly speaking, this is
228   // an inverse of the darwin::getArchTypeForDarwinArchName() function, but the
229   // only interesting special case is powerpc.
230   switch (Triple.getArch()) {
231   case llvm::Triple::ppc:
232     return "ppc";
233   case llvm::Triple::ppc64:
234     return "ppc64";
235   case llvm::Triple::ppc64le:
236     return "ppc64le";
237   default:
238     return Triple.getArchName();
239   }
240 }
241 
242 std::string ToolChain::getInputFilename(const InputInfo &Input) const {
243   return Input.getFilename();
244 }
245 
246 bool ToolChain::IsUnwindTablesDefault(const ArgList &Args) const {
247   return false;
248 }
249 
250 Tool *ToolChain::getClang() const {
251   if (!Clang)
252     Clang.reset(new tools::Clang(*this));
253   return Clang.get();
254 }
255 
256 Tool *ToolChain::buildAssembler() const {
257   return new tools::ClangAs(*this);
258 }
259 
260 Tool *ToolChain::buildLinker() const {
261   llvm_unreachable("Linking is not supported by this toolchain");
262 }
263 
264 Tool *ToolChain::getAssemble() const {
265   if (!Assemble)
266     Assemble.reset(buildAssembler());
267   return Assemble.get();
268 }
269 
270 Tool *ToolChain::getClangAs() const {
271   if (!Assemble)
272     Assemble.reset(new tools::ClangAs(*this));
273   return Assemble.get();
274 }
275 
276 Tool *ToolChain::getLink() const {
277   if (!Link)
278     Link.reset(buildLinker());
279   return Link.get();
280 }
281 
282 Tool *ToolChain::getOffloadBundler() const {
283   if (!OffloadBundler)
284     OffloadBundler.reset(new tools::OffloadBundler(*this));
285   return OffloadBundler.get();
286 }
287 
288 Tool *ToolChain::getTool(Action::ActionClass AC) const {
289   switch (AC) {
290   case Action::AssembleJobClass:
291     return getAssemble();
292 
293   case Action::LinkJobClass:
294     return getLink();
295 
296   case Action::InputClass:
297   case Action::BindArchClass:
298   case Action::OffloadClass:
299   case Action::LipoJobClass:
300   case Action::DsymutilJobClass:
301   case Action::VerifyDebugInfoJobClass:
302     llvm_unreachable("Invalid tool kind.");
303 
304   case Action::CompileJobClass:
305   case Action::PrecompileJobClass:
306   case Action::HeaderModulePrecompileJobClass:
307   case Action::PreprocessJobClass:
308   case Action::AnalyzeJobClass:
309   case Action::MigrateJobClass:
310   case Action::VerifyPCHJobClass:
311   case Action::BackendJobClass:
312     return getClang();
313 
314   case Action::OffloadBundlingJobClass:
315   case Action::OffloadUnbundlingJobClass:
316     return getOffloadBundler();
317   }
318 
319   llvm_unreachable("Invalid tool kind.");
320 }
321 
322 static StringRef getArchNameForCompilerRTLib(const ToolChain &TC,
323                                              const ArgList &Args) {
324   const llvm::Triple &Triple = TC.getTriple();
325   bool IsWindows = Triple.isOSWindows();
326 
327   if (TC.getArch() == llvm::Triple::arm || TC.getArch() == llvm::Triple::armeb)
328     return (arm::getARMFloatABI(TC, Args) == arm::FloatABI::Hard && !IsWindows)
329                ? "armhf"
330                : "arm";
331 
332   // For historic reasons, Android library is using i686 instead of i386.
333   if (TC.getArch() == llvm::Triple::x86 && Triple.isAndroid())
334     return "i686";
335 
336   return llvm::Triple::getArchTypeName(TC.getArch());
337 }
338 
339 StringRef ToolChain::getOSLibName() const {
340   switch (Triple.getOS()) {
341   case llvm::Triple::FreeBSD:
342     return "freebsd";
343   case llvm::Triple::NetBSD:
344     return "netbsd";
345   case llvm::Triple::OpenBSD:
346     return "openbsd";
347   case llvm::Triple::Solaris:
348     return "sunos";
349   default:
350     return getOS();
351   }
352 }
353 
354 std::string ToolChain::getCompilerRTPath() const {
355   SmallString<128> Path(getDriver().ResourceDir);
356   if (Triple.isOSUnknown()) {
357     llvm::sys::path::append(Path, "lib");
358   } else {
359     llvm::sys::path::append(Path, "lib", getOSLibName());
360   }
361   return Path.str();
362 }
363 
364 std::string ToolChain::getCompilerRT(const ArgList &Args, StringRef Component,
365                                      FileType Type) const {
366   const llvm::Triple &TT = getTriple();
367   bool IsITANMSVCWindows =
368       TT.isWindowsMSVCEnvironment() || TT.isWindowsItaniumEnvironment();
369 
370   const char *Prefix =
371       IsITANMSVCWindows || Type == ToolChain::FT_Object ? "" : "lib";
372   const char *Suffix;
373   switch (Type) {
374   case ToolChain::FT_Object:
375     Suffix = IsITANMSVCWindows ? ".obj" : ".o";
376     break;
377   case ToolChain::FT_Static:
378     Suffix = IsITANMSVCWindows ? ".lib" : ".a";
379     break;
380   case ToolChain::FT_Shared:
381     Suffix = Triple.isOSWindows()
382                  ? (Triple.isWindowsGNUEnvironment() ? ".dll.a" : ".lib")
383                  : ".so";
384     break;
385   }
386 
387   for (const auto &LibPath : getLibraryPaths()) {
388     SmallString<128> P(LibPath);
389     llvm::sys::path::append(P, Prefix + Twine("clang_rt.") + Component + Suffix);
390     if (getVFS().exists(P))
391       return P.str();
392   }
393 
394   StringRef Arch = getArchNameForCompilerRTLib(*this, Args);
395   const char *Env = TT.isAndroid() ? "-android" : "";
396   SmallString<128> Path(getCompilerRTPath());
397   llvm::sys::path::append(Path, Prefix + Twine("clang_rt.") + Component + "-" +
398                                     Arch + Env + Suffix);
399   return Path.str();
400 }
401 
402 const char *ToolChain::getCompilerRTArgString(const llvm::opt::ArgList &Args,
403                                               StringRef Component,
404                                               FileType Type) const {
405   return Args.MakeArgString(getCompilerRT(Args, Component, Type));
406 }
407 
408 
409 Optional<std::string> ToolChain::getRuntimePath() const {
410   SmallString<128> P;
411 
412   // First try the triple passed to driver as --target=<triple>.
413   P.assign(D.ResourceDir);
414   llvm::sys::path::append(P, "lib", D.getTargetTriple());
415   if (getVFS().exists(P))
416     return llvm::Optional<std::string>(P.str());
417 
418   // Second try the normalized triple.
419   P.assign(D.ResourceDir);
420   llvm::sys::path::append(P, "lib", Triple.str());
421   if (getVFS().exists(P))
422     return llvm::Optional<std::string>(P.str());
423 
424   return None;
425 }
426 
427 Optional<std::string> ToolChain::getCXXStdlibPath() const {
428   SmallString<128> P;
429 
430   // First try the triple passed to driver as --target=<triple>.
431   P.assign(D.Dir);
432   llvm::sys::path::append(P, "..", "lib", D.getTargetTriple(), "c++");
433   if (getVFS().exists(P))
434     return llvm::Optional<std::string>(P.str());
435 
436   // Second try the normalized triple.
437   P.assign(D.Dir);
438   llvm::sys::path::append(P, "..", "lib", Triple.str(), "c++");
439   if (getVFS().exists(P))
440     return llvm::Optional<std::string>(P.str());
441 
442   return None;
443 }
444 
445 std::string ToolChain::getArchSpecificLibPath() const {
446   SmallString<128> Path(getDriver().ResourceDir);
447   llvm::sys::path::append(Path, "lib", getOSLibName(),
448                           llvm::Triple::getArchTypeName(getArch()));
449   return Path.str();
450 }
451 
452 bool ToolChain::needsProfileRT(const ArgList &Args) {
453   if (Args.hasArg(options::OPT_noprofilelib))
454     return false;
455 
456   if (needsGCovInstrumentation(Args) ||
457       Args.hasArg(options::OPT_fprofile_generate) ||
458       Args.hasArg(options::OPT_fprofile_generate_EQ) ||
459       Args.hasArg(options::OPT_fcs_profile_generate) ||
460       Args.hasArg(options::OPT_fcs_profile_generate_EQ) ||
461       Args.hasArg(options::OPT_fprofile_instr_generate) ||
462       Args.hasArg(options::OPT_fprofile_instr_generate_EQ) ||
463       Args.hasArg(options::OPT_fcreate_profile) ||
464       Args.hasArg(options::OPT_forder_file_instrumentation))
465     return true;
466 
467   return false;
468 }
469 
470 bool ToolChain::needsGCovInstrumentation(const llvm::opt::ArgList &Args) {
471   return Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
472                       false) ||
473          Args.hasArg(options::OPT_coverage);
474 }
475 
476 Tool *ToolChain::SelectTool(const JobAction &JA) const {
477   if (getDriver().ShouldUseClangCompiler(JA)) return getClang();
478   Action::ActionClass AC = JA.getKind();
479   if (AC == Action::AssembleJobClass && useIntegratedAs())
480     return getClangAs();
481   return getTool(AC);
482 }
483 
484 std::string ToolChain::GetFilePath(const char *Name) const {
485   return D.GetFilePath(Name, *this);
486 }
487 
488 std::string ToolChain::GetProgramPath(const char *Name) const {
489   return D.GetProgramPath(Name, *this);
490 }
491 
492 std::string ToolChain::GetLinkerPath() const {
493   const Arg* A = Args.getLastArg(options::OPT_fuse_ld_EQ);
494   StringRef UseLinker = A ? A->getValue() : CLANG_DEFAULT_LINKER;
495 
496   if (llvm::sys::path::is_absolute(UseLinker)) {
497     // If we're passed what looks like an absolute path, don't attempt to
498     // second-guess that.
499     if (llvm::sys::fs::can_execute(UseLinker))
500       return UseLinker;
501   } else if (UseLinker.empty() || UseLinker == "ld") {
502     // If we're passed -fuse-ld= with no argument, or with the argument ld,
503     // then use whatever the default system linker is.
504     return GetProgramPath(getDefaultLinker());
505   } else {
506     llvm::SmallString<8> LinkerName;
507     if (Triple.isOSDarwin())
508       LinkerName.append("ld64.");
509     else
510       LinkerName.append("ld.");
511     LinkerName.append(UseLinker);
512 
513     std::string LinkerPath(GetProgramPath(LinkerName.c_str()));
514     if (llvm::sys::fs::can_execute(LinkerPath))
515       return LinkerPath;
516   }
517 
518   if (A)
519     getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
520 
521   return GetProgramPath(getDefaultLinker());
522 }
523 
524 types::ID ToolChain::LookupTypeForExtension(StringRef Ext) const {
525   return types::lookupTypeForExtension(Ext);
526 }
527 
528 bool ToolChain::HasNativeLLVMSupport() const {
529   return false;
530 }
531 
532 bool ToolChain::isCrossCompiling() const {
533   llvm::Triple HostTriple(LLVM_HOST_TRIPLE);
534   switch (HostTriple.getArch()) {
535   // The A32/T32/T16 instruction sets are not separate architectures in this
536   // context.
537   case llvm::Triple::arm:
538   case llvm::Triple::armeb:
539   case llvm::Triple::thumb:
540   case llvm::Triple::thumbeb:
541     return getArch() != llvm::Triple::arm && getArch() != llvm::Triple::thumb &&
542            getArch() != llvm::Triple::armeb && getArch() != llvm::Triple::thumbeb;
543   default:
544     return HostTriple.getArch() != getArch();
545   }
546 }
547 
548 ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
549   return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
550                      VersionTuple());
551 }
552 
553 llvm::ExceptionHandling
554 ToolChain::GetExceptionModel(const llvm::opt::ArgList &Args) const {
555   return llvm::ExceptionHandling::None;
556 }
557 
558 bool ToolChain::isThreadModelSupported(const StringRef Model) const {
559   if (Model == "single") {
560     // FIXME: 'single' is only supported on ARM and WebAssembly so far.
561     return Triple.getArch() == llvm::Triple::arm ||
562            Triple.getArch() == llvm::Triple::armeb ||
563            Triple.getArch() == llvm::Triple::thumb ||
564            Triple.getArch() == llvm::Triple::thumbeb ||
565            Triple.getArch() == llvm::Triple::wasm32 ||
566            Triple.getArch() == llvm::Triple::wasm64;
567   } else if (Model == "posix")
568     return true;
569 
570   return false;
571 }
572 
573 std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
574                                          types::ID InputType) const {
575   switch (getTriple().getArch()) {
576   default:
577     return getTripleString();
578 
579   case llvm::Triple::x86_64: {
580     llvm::Triple Triple = getTriple();
581     if (!Triple.isOSBinFormatMachO())
582       return getTripleString();
583 
584     if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
585       // x86_64h goes in the triple. Other -march options just use the
586       // vanilla triple we already have.
587       StringRef MArch = A->getValue();
588       if (MArch == "x86_64h")
589         Triple.setArchName(MArch);
590     }
591     return Triple.getTriple();
592   }
593   case llvm::Triple::aarch64: {
594     llvm::Triple Triple = getTriple();
595     if (!Triple.isOSBinFormatMachO())
596       return getTripleString();
597 
598     // FIXME: older versions of ld64 expect the "arm64" component in the actual
599     // triple string and query it to determine whether an LTO file can be
600     // handled. Remove this when we don't care any more.
601     Triple.setArchName("arm64");
602     return Triple.getTriple();
603   }
604   case llvm::Triple::arm:
605   case llvm::Triple::armeb:
606   case llvm::Triple::thumb:
607   case llvm::Triple::thumbeb: {
608     // FIXME: Factor into subclasses.
609     llvm::Triple Triple = getTriple();
610     bool IsBigEndian = getTriple().getArch() == llvm::Triple::armeb ||
611                        getTriple().getArch() == llvm::Triple::thumbeb;
612 
613     // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
614     // '-mbig-endian'/'-EB'.
615     if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
616                                  options::OPT_mbig_endian)) {
617       IsBigEndian = !A->getOption().matches(options::OPT_mlittle_endian);
618     }
619 
620     // Thumb2 is the default for V7 on Darwin.
621     //
622     // FIXME: Thumb should just be another -target-feaure, not in the triple.
623     StringRef MCPU, MArch;
624     if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
625       MCPU = A->getValue();
626     if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
627       MArch = A->getValue();
628     std::string CPU =
629         Triple.isOSBinFormatMachO()
630             ? tools::arm::getARMCPUForMArch(MArch, Triple).str()
631             : tools::arm::getARMTargetCPU(MCPU, MArch, Triple);
632     StringRef Suffix =
633       tools::arm::getLLVMArchSuffixForARM(CPU, MArch, Triple);
634     bool IsMProfile = ARM::parseArchProfile(Suffix) == ARM::ProfileKind::M;
635     bool ThumbDefault = IsMProfile || (ARM::parseArchVersion(Suffix) == 7 &&
636                                        getTriple().isOSBinFormatMachO());
637     // FIXME: this is invalid for WindowsCE
638     if (getTriple().isOSWindows())
639       ThumbDefault = true;
640     std::string ArchName;
641     if (IsBigEndian)
642       ArchName = "armeb";
643     else
644       ArchName = "arm";
645 
646     // Check if ARM ISA was explicitly selected (using -mno-thumb or -marm) for
647     // M-Class CPUs/architecture variants, which is not supported.
648     bool ARMModeRequested = !Args.hasFlag(options::OPT_mthumb,
649                                           options::OPT_mno_thumb, ThumbDefault);
650     if (IsMProfile && ARMModeRequested) {
651       if (!MCPU.empty())
652         getDriver().Diag(diag::err_cpu_unsupported_isa) << CPU << "ARM";
653        else
654         getDriver().Diag(diag::err_arch_unsupported_isa)
655           << tools::arm::getARMArch(MArch, getTriple()) << "ARM";
656     }
657 
658     // Check to see if an explicit choice to use thumb has been made via
659     // -mthumb. For assembler files we must check for -mthumb in the options
660     // passed to the assembler via -Wa or -Xassembler.
661     bool IsThumb = false;
662     if (InputType != types::TY_PP_Asm)
663       IsThumb = Args.hasFlag(options::OPT_mthumb, options::OPT_mno_thumb,
664                               ThumbDefault);
665     else {
666       // Ideally we would check for these flags in
667       // CollectArgsForIntegratedAssembler but we can't change the ArchName at
668       // that point. There is no assembler equivalent of -mno-thumb, -marm, or
669       // -mno-arm.
670       for (const auto *A :
671            Args.filtered(options::OPT_Wa_COMMA, options::OPT_Xassembler)) {
672         for (StringRef Value : A->getValues()) {
673           if (Value == "-mthumb")
674             IsThumb = true;
675         }
676       }
677     }
678     // Assembly files should start in ARM mode, unless arch is M-profile, or
679     // -mthumb has been passed explicitly to the assembler. Windows is always
680     // thumb.
681     if (IsThumb || IsMProfile || getTriple().isOSWindows()) {
682       if (IsBigEndian)
683         ArchName = "thumbeb";
684       else
685         ArchName = "thumb";
686     }
687     Triple.setArchName(ArchName + Suffix.str());
688 
689     return Triple.getTriple();
690   }
691   }
692 }
693 
694 std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
695                                                    types::ID InputType) const {
696   return ComputeLLVMTriple(Args, InputType);
697 }
698 
699 void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
700                                           ArgStringList &CC1Args) const {
701   // Each toolchain should provide the appropriate include flags.
702 }
703 
704 void ToolChain::addClangTargetOptions(
705     const ArgList &DriverArgs, ArgStringList &CC1Args,
706     Action::OffloadKind DeviceOffloadKind) const {}
707 
708 void ToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {}
709 
710 void ToolChain::addProfileRTLibs(const llvm::opt::ArgList &Args,
711                                  llvm::opt::ArgStringList &CmdArgs) const {
712   if (!needsProfileRT(Args)) return;
713 
714   CmdArgs.push_back(getCompilerRTArgString(Args, "profile"));
715 }
716 
717 ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
718     const ArgList &Args) const {
719   const Arg* A = Args.getLastArg(options::OPT_rtlib_EQ);
720   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_RTLIB;
721 
722   // Only use "platform" in tests to override CLANG_DEFAULT_RTLIB!
723   if (LibName == "compiler-rt")
724     return ToolChain::RLT_CompilerRT;
725   else if (LibName == "libgcc")
726     return ToolChain::RLT_Libgcc;
727   else if (LibName == "platform")
728     return GetDefaultRuntimeLibType();
729 
730   if (A)
731     getDriver().Diag(diag::err_drv_invalid_rtlib_name) << A->getAsString(Args);
732 
733   return GetDefaultRuntimeLibType();
734 }
735 
736 ToolChain::UnwindLibType ToolChain::GetUnwindLibType(
737     const ArgList &Args) const {
738   const Arg *A = Args.getLastArg(options::OPT_unwindlib_EQ);
739   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_UNWINDLIB;
740 
741   if (LibName == "none")
742     return ToolChain::UNW_None;
743   else if (LibName == "platform" || LibName == "") {
744     ToolChain::RuntimeLibType RtLibType = GetRuntimeLibType(Args);
745     if (RtLibType == ToolChain::RLT_CompilerRT)
746       return ToolChain::UNW_None;
747     else if (RtLibType == ToolChain::RLT_Libgcc)
748       return ToolChain::UNW_Libgcc;
749   } else if (LibName == "libunwind") {
750     if (GetRuntimeLibType(Args) == RLT_Libgcc)
751       getDriver().Diag(diag::err_drv_incompatible_unwindlib);
752     return ToolChain::UNW_CompilerRT;
753   } else if (LibName == "libgcc")
754     return ToolChain::UNW_Libgcc;
755 
756   if (A)
757     getDriver().Diag(diag::err_drv_invalid_unwindlib_name)
758         << A->getAsString(Args);
759 
760   return GetDefaultUnwindLibType();
761 }
762 
763 ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
764   const Arg *A = Args.getLastArg(options::OPT_stdlib_EQ);
765   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_CXX_STDLIB;
766 
767   // Only use "platform" in tests to override CLANG_DEFAULT_CXX_STDLIB!
768   if (LibName == "libc++")
769     return ToolChain::CST_Libcxx;
770   else if (LibName == "libstdc++")
771     return ToolChain::CST_Libstdcxx;
772   else if (LibName == "platform")
773     return GetDefaultCXXStdlibType();
774 
775   if (A)
776     getDriver().Diag(diag::err_drv_invalid_stdlib_name) << A->getAsString(Args);
777 
778   return GetDefaultCXXStdlibType();
779 }
780 
781 /// Utility function to add a system include directory to CC1 arguments.
782 /*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
783                                             ArgStringList &CC1Args,
784                                             const Twine &Path) {
785   CC1Args.push_back("-internal-isystem");
786   CC1Args.push_back(DriverArgs.MakeArgString(Path));
787 }
788 
789 /// Utility function to add a system include directory with extern "C"
790 /// semantics to CC1 arguments.
791 ///
792 /// Note that this should be used rarely, and only for directories that
793 /// historically and for legacy reasons are treated as having implicit extern
794 /// "C" semantics. These semantics are *ignored* by and large today, but its
795 /// important to preserve the preprocessor changes resulting from the
796 /// classification.
797 /*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
798                                                    ArgStringList &CC1Args,
799                                                    const Twine &Path) {
800   CC1Args.push_back("-internal-externc-isystem");
801   CC1Args.push_back(DriverArgs.MakeArgString(Path));
802 }
803 
804 void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
805                                                 ArgStringList &CC1Args,
806                                                 const Twine &Path) {
807   if (llvm::sys::fs::exists(Path))
808     addExternCSystemInclude(DriverArgs, CC1Args, Path);
809 }
810 
811 /// Utility function to add a list of system include directories to CC1.
812 /*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
813                                              ArgStringList &CC1Args,
814                                              ArrayRef<StringRef> Paths) {
815   for (const auto Path : Paths) {
816     CC1Args.push_back("-internal-isystem");
817     CC1Args.push_back(DriverArgs.MakeArgString(Path));
818   }
819 }
820 
821 void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
822                                              ArgStringList &CC1Args) const {
823   // Header search paths should be handled by each of the subclasses.
824   // Historically, they have not been, and instead have been handled inside of
825   // the CC1-layer frontend. As the logic is hoisted out, this generic function
826   // will slowly stop being called.
827   //
828   // While it is being called, replicate a bit of a hack to propagate the
829   // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
830   // header search paths with it. Once all systems are overriding this
831   // function, the CC1 flag and this line can be removed.
832   DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
833 }
834 
835 bool ToolChain::ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const {
836   return getDriver().CCCIsCXX() &&
837          !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,
838                       options::OPT_nostdlibxx);
839 }
840 
841 void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
842                                     ArgStringList &CmdArgs) const {
843   assert(!Args.hasArg(options::OPT_nostdlibxx) &&
844          "should not have called this");
845   CXXStdlibType Type = GetCXXStdlibType(Args);
846 
847   switch (Type) {
848   case ToolChain::CST_Libcxx:
849     CmdArgs.push_back("-lc++");
850     break;
851 
852   case ToolChain::CST_Libstdcxx:
853     CmdArgs.push_back("-lstdc++");
854     break;
855   }
856 }
857 
858 void ToolChain::AddFilePathLibArgs(const ArgList &Args,
859                                    ArgStringList &CmdArgs) const {
860   for (const auto &LibPath : getFilePaths())
861     if(LibPath.length() > 0)
862       CmdArgs.push_back(Args.MakeArgString(StringRef("-L") + LibPath));
863 }
864 
865 void ToolChain::AddCCKextLibArgs(const ArgList &Args,
866                                  ArgStringList &CmdArgs) const {
867   CmdArgs.push_back("-lcc_kext");
868 }
869 
870 bool ToolChain::AddFastMathRuntimeIfAvailable(const ArgList &Args,
871                                               ArgStringList &CmdArgs) const {
872   // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
873   // (to keep the linker options consistent with gcc and clang itself).
874   if (!isOptimizationLevelFast(Args)) {
875     // Check if -ffast-math or -funsafe-math.
876     Arg *A =
877         Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
878                         options::OPT_funsafe_math_optimizations,
879                         options::OPT_fno_unsafe_math_optimizations);
880 
881     if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
882         A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
883       return false;
884   }
885   // If crtfastmath.o exists add it to the arguments.
886   std::string Path = GetFilePath("crtfastmath.o");
887   if (Path == "crtfastmath.o") // Not found.
888     return false;
889 
890   CmdArgs.push_back(Args.MakeArgString(Path));
891   return true;
892 }
893 
894 SanitizerMask ToolChain::getSupportedSanitizers() const {
895   // Return sanitizers which don't require runtime support and are not
896   // platform dependent.
897 
898   SanitizerMask Res = (SanitizerKind::Undefined & ~SanitizerKind::Vptr &
899                        ~SanitizerKind::Function) |
900                       (SanitizerKind::CFI & ~SanitizerKind::CFIICall) |
901                       SanitizerKind::CFICastStrict |
902                       SanitizerKind::FloatDivideByZero |
903                       SanitizerKind::UnsignedIntegerOverflow |
904                       SanitizerKind::ImplicitConversion |
905                       SanitizerKind::Nullability | SanitizerKind::LocalBounds;
906   if (getTriple().getArch() == llvm::Triple::x86 ||
907       getTriple().getArch() == llvm::Triple::x86_64 ||
908       getTriple().getArch() == llvm::Triple::arm ||
909       getTriple().getArch() == llvm::Triple::aarch64 ||
910       getTriple().getArch() == llvm::Triple::wasm32 ||
911       getTriple().getArch() == llvm::Triple::wasm64)
912     Res |= SanitizerKind::CFIICall;
913   if (getTriple().getArch() == llvm::Triple::x86_64 ||
914       getTriple().getArch() == llvm::Triple::aarch64)
915     Res |= SanitizerKind::ShadowCallStack;
916   return Res;
917 }
918 
919 void ToolChain::AddCudaIncludeArgs(const ArgList &DriverArgs,
920                                    ArgStringList &CC1Args) const {}
921 
922 void ToolChain::AddIAMCUIncludeArgs(const ArgList &DriverArgs,
923                                     ArgStringList &CC1Args) const {}
924 
925 static VersionTuple separateMSVCFullVersion(unsigned Version) {
926   if (Version < 100)
927     return VersionTuple(Version);
928 
929   if (Version < 10000)
930     return VersionTuple(Version / 100, Version % 100);
931 
932   unsigned Build = 0, Factor = 1;
933   for (; Version > 10000; Version = Version / 10, Factor = Factor * 10)
934     Build = Build + (Version % 10) * Factor;
935   return VersionTuple(Version / 100, Version % 100, Build);
936 }
937 
938 VersionTuple
939 ToolChain::computeMSVCVersion(const Driver *D,
940                               const llvm::opt::ArgList &Args) const {
941   const Arg *MSCVersion = Args.getLastArg(options::OPT_fmsc_version);
942   const Arg *MSCompatibilityVersion =
943       Args.getLastArg(options::OPT_fms_compatibility_version);
944 
945   if (MSCVersion && MSCompatibilityVersion) {
946     if (D)
947       D->Diag(diag::err_drv_argument_not_allowed_with)
948           << MSCVersion->getAsString(Args)
949           << MSCompatibilityVersion->getAsString(Args);
950     return VersionTuple();
951   }
952 
953   if (MSCompatibilityVersion) {
954     VersionTuple MSVT;
955     if (MSVT.tryParse(MSCompatibilityVersion->getValue())) {
956       if (D)
957         D->Diag(diag::err_drv_invalid_value)
958             << MSCompatibilityVersion->getAsString(Args)
959             << MSCompatibilityVersion->getValue();
960     } else {
961       return MSVT;
962     }
963   }
964 
965   if (MSCVersion) {
966     unsigned Version = 0;
967     if (StringRef(MSCVersion->getValue()).getAsInteger(10, Version)) {
968       if (D)
969         D->Diag(diag::err_drv_invalid_value)
970             << MSCVersion->getAsString(Args) << MSCVersion->getValue();
971     } else {
972       return separateMSVCFullVersion(Version);
973     }
974   }
975 
976   return VersionTuple();
977 }
978 
979 llvm::opt::DerivedArgList *ToolChain::TranslateOpenMPTargetArgs(
980     const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost,
981     SmallVectorImpl<llvm::opt::Arg *> &AllocatedArgs) const {
982   DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
983   const OptTable &Opts = getDriver().getOpts();
984   bool Modified = false;
985 
986   // Handle -Xopenmp-target flags
987   for (auto *A : Args) {
988     // Exclude flags which may only apply to the host toolchain.
989     // Do not exclude flags when the host triple (AuxTriple)
990     // matches the current toolchain triple. If it is not present
991     // at all, target and host share a toolchain.
992     if (A->getOption().matches(options::OPT_m_Group)) {
993       if (SameTripleAsHost)
994         DAL->append(A);
995       else
996         Modified = true;
997       continue;
998     }
999 
1000     unsigned Index;
1001     unsigned Prev;
1002     bool XOpenMPTargetNoTriple =
1003         A->getOption().matches(options::OPT_Xopenmp_target);
1004 
1005     if (A->getOption().matches(options::OPT_Xopenmp_target_EQ)) {
1006       // Passing device args: -Xopenmp-target=<triple> -opt=val.
1007       if (A->getValue(0) == getTripleString())
1008         Index = Args.getBaseArgs().MakeIndex(A->getValue(1));
1009       else
1010         continue;
1011     } else if (XOpenMPTargetNoTriple) {
1012       // Passing device args: -Xopenmp-target -opt=val.
1013       Index = Args.getBaseArgs().MakeIndex(A->getValue(0));
1014     } else {
1015       DAL->append(A);
1016       continue;
1017     }
1018 
1019     // Parse the argument to -Xopenmp-target.
1020     Prev = Index;
1021     std::unique_ptr<Arg> XOpenMPTargetArg(Opts.ParseOneArg(Args, Index));
1022     if (!XOpenMPTargetArg || Index > Prev + 1) {
1023       getDriver().Diag(diag::err_drv_invalid_Xopenmp_target_with_args)
1024           << A->getAsString(Args);
1025       continue;
1026     }
1027     if (XOpenMPTargetNoTriple && XOpenMPTargetArg &&
1028         Args.getAllArgValues(options::OPT_fopenmp_targets_EQ).size() != 1) {
1029       getDriver().Diag(diag::err_drv_Xopenmp_target_missing_triple);
1030       continue;
1031     }
1032     XOpenMPTargetArg->setBaseArg(A);
1033     A = XOpenMPTargetArg.release();
1034     AllocatedArgs.push_back(A);
1035     DAL->append(A);
1036     Modified = true;
1037   }
1038 
1039   if (Modified)
1040     return DAL;
1041 
1042   delete DAL;
1043   return nullptr;
1044 }
1045