1 //===--- ToolChain.cpp - Collections of tools for one platform ------------===//
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 "clang/Driver/ToolChain.h"
11 #include "ToolChains/CommonArgs.h"
12 #include "ToolChains/Arch/ARM.h"
13 #include "ToolChains/Clang.h"
14 #include "clang/Basic/ObjCRuntime.h"
15 #include "clang/Basic/VirtualFileSystem.h"
16 #include "clang/Config/config.h"
17 #include "clang/Driver/Action.h"
18 #include "clang/Driver/Driver.h"
19 #include "clang/Driver/DriverDiagnostic.h"
20 #include "clang/Driver/Options.h"
21 #include "clang/Driver/SanitizerArgs.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/Option/Arg.h"
24 #include "llvm/Option/ArgList.h"
25 #include "llvm/Option/Option.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/TargetParser.h"
30 #include "llvm/Support/TargetRegistry.h"
31 
32 using namespace clang::driver;
33 using namespace clang::driver::tools;
34 using namespace clang;
35 using namespace llvm;
36 using namespace llvm::opt;
37 
38 static llvm::opt::Arg *GetRTTIArgument(const ArgList &Args) {
39   return Args.getLastArg(options::OPT_mkernel, options::OPT_fapple_kext,
40                          options::OPT_fno_rtti, options::OPT_frtti);
41 }
42 
43 static ToolChain::RTTIMode CalculateRTTIMode(const ArgList &Args,
44                                              const llvm::Triple &Triple,
45                                              const Arg *CachedRTTIArg) {
46   // Explicit rtti/no-rtti args
47   if (CachedRTTIArg) {
48     if (CachedRTTIArg->getOption().matches(options::OPT_frtti))
49       return ToolChain::RM_EnabledExplicitly;
50     else
51       return ToolChain::RM_DisabledExplicitly;
52   }
53 
54   // -frtti is default, except for the PS4 CPU.
55   if (!Triple.isPS4CPU())
56     return ToolChain::RM_EnabledImplicitly;
57 
58   // On the PS4, turning on c++ exceptions turns on rtti.
59   // We're assuming that, if we see -fexceptions, rtti gets turned on.
60   Arg *Exceptions = Args.getLastArgNoClaim(
61       options::OPT_fcxx_exceptions, options::OPT_fno_cxx_exceptions,
62       options::OPT_fexceptions, options::OPT_fno_exceptions);
63   if (Exceptions &&
64       (Exceptions->getOption().matches(options::OPT_fexceptions) ||
65        Exceptions->getOption().matches(options::OPT_fcxx_exceptions)))
66     return ToolChain::RM_EnabledImplicitly;
67 
68   return ToolChain::RM_DisabledImplicitly;
69 }
70 
71 ToolChain::ToolChain(const Driver &D, const llvm::Triple &T,
72                      const ArgList &Args)
73     : D(D), Triple(T), Args(Args), CachedRTTIArg(GetRTTIArgument(Args)),
74       CachedRTTIMode(CalculateRTTIMode(Args, Triple, CachedRTTIArg)),
75       EffectiveTriple() {
76   if (Arg *A = Args.getLastArg(options::OPT_mthread_model))
77     if (!isThreadModelSupported(A->getValue()))
78       D.Diag(diag::err_drv_invalid_thread_model_for_target)
79           << A->getValue() << A->getAsString(Args);
80 
81   std::string CandidateLibPath = getArchSpecificLibPath();
82   if (getVFS().exists(CandidateLibPath))
83     getFilePaths().push_back(CandidateLibPath);
84 }
85 
86 ToolChain::~ToolChain() {
87 }
88 
89 vfs::FileSystem &ToolChain::getVFS() const { return getDriver().getVFS(); }
90 
91 bool ToolChain::useIntegratedAs() const {
92   return Args.hasFlag(options::OPT_fintegrated_as,
93                       options::OPT_fno_integrated_as,
94                       IsIntegratedAssemblerDefault());
95 }
96 
97 const SanitizerArgs& ToolChain::getSanitizerArgs() const {
98   if (!SanitizerArguments.get())
99     SanitizerArguments.reset(new SanitizerArgs(*this, Args));
100   return *SanitizerArguments.get();
101 }
102 
103 namespace {
104 struct DriverSuffix {
105   const char *Suffix;
106   const char *ModeFlag;
107 };
108 
109 const DriverSuffix *FindDriverSuffix(StringRef ProgName) {
110   // A list of known driver suffixes. Suffixes are compared against the
111   // program name in order. If there is a match, the frontend type is updated as
112   // necessary by applying the ModeFlag.
113   static const DriverSuffix DriverSuffixes[] = {
114       {"clang", nullptr},
115       {"clang++", "--driver-mode=g++"},
116       {"clang-c++", "--driver-mode=g++"},
117       {"clang-cc", nullptr},
118       {"clang-cpp", "--driver-mode=cpp"},
119       {"clang-g++", "--driver-mode=g++"},
120       {"clang-gcc", nullptr},
121       {"clang-cl", "--driver-mode=cl"},
122       {"cc", nullptr},
123       {"cpp", "--driver-mode=cpp"},
124       {"cl", "--driver-mode=cl"},
125       {"++", "--driver-mode=g++"},
126   };
127 
128   for (size_t i = 0; i < llvm::array_lengthof(DriverSuffixes); ++i)
129     if (ProgName.endswith(DriverSuffixes[i].Suffix))
130       return &DriverSuffixes[i];
131   return nullptr;
132 }
133 
134 /// Normalize the program name from argv[0] by stripping the file extension if
135 /// present and lower-casing the string on Windows.
136 std::string normalizeProgramName(llvm::StringRef Argv0) {
137   std::string ProgName = llvm::sys::path::stem(Argv0);
138 #ifdef LLVM_ON_WIN32
139   // Transform to lowercase for case insensitive file systems.
140   std::transform(ProgName.begin(), ProgName.end(), ProgName.begin(), ::tolower);
141 #endif
142   return ProgName;
143 }
144 
145 const DriverSuffix *parseDriverSuffix(StringRef ProgName) {
146   // Try to infer frontend type and default target from the program name by
147   // comparing it against DriverSuffixes in order.
148 
149   // If there is a match, the function tries to identify a target as prefix.
150   // E.g. "x86_64-linux-clang" as interpreted as suffix "clang" with target
151   // prefix "x86_64-linux". If such a target prefix is found, it may be
152   // added via -target as implicit first argument.
153   const DriverSuffix *DS = FindDriverSuffix(ProgName);
154 
155   if (!DS) {
156     // Try again after stripping any trailing version number:
157     // clang++3.5 -> clang++
158     ProgName = ProgName.rtrim("0123456789.");
159     DS = FindDriverSuffix(ProgName);
160   }
161 
162   if (!DS) {
163     // Try again after stripping trailing -component.
164     // clang++-tot -> clang++
165     ProgName = ProgName.slice(0, ProgName.rfind('-'));
166     DS = FindDriverSuffix(ProgName);
167   }
168   return DS;
169 }
170 } // anonymous namespace
171 
172 std::pair<std::string, std::string>
173 ToolChain::getTargetAndModeFromProgramName(StringRef PN) {
174   std::string ProgName = normalizeProgramName(PN);
175   const DriverSuffix *DS = parseDriverSuffix(ProgName);
176   if (!DS)
177     return std::make_pair("", "");
178   std::string ModeFlag = DS->ModeFlag == nullptr ? "" : DS->ModeFlag;
179 
180   std::string::size_type LastComponent =
181       ProgName.rfind('-', ProgName.size() - strlen(DS->Suffix));
182   if (LastComponent == std::string::npos)
183     return std::make_pair("", ModeFlag);
184 
185   // Infer target from the prefix.
186   StringRef Prefix(ProgName);
187   Prefix = Prefix.slice(0, LastComponent);
188   std::string IgnoredError;
189   std::string Target;
190   if (llvm::TargetRegistry::lookupTarget(Prefix, IgnoredError)) {
191     Target = Prefix;
192   }
193   return std::make_pair(Target, ModeFlag);
194 }
195 
196 StringRef ToolChain::getDefaultUniversalArchName() const {
197   // In universal driver terms, the arch name accepted by -arch isn't exactly
198   // the same as the ones that appear in the triple. Roughly speaking, this is
199   // an inverse of the darwin::getArchTypeForDarwinArchName() function, but the
200   // only interesting special case is powerpc.
201   switch (Triple.getArch()) {
202   case llvm::Triple::ppc:
203     return "ppc";
204   case llvm::Triple::ppc64:
205     return "ppc64";
206   case llvm::Triple::ppc64le:
207     return "ppc64le";
208   default:
209     return Triple.getArchName();
210   }
211 }
212 
213 bool ToolChain::IsUnwindTablesDefault() const {
214   return false;
215 }
216 
217 Tool *ToolChain::getClang() const {
218   if (!Clang)
219     Clang.reset(new tools::Clang(*this));
220   return Clang.get();
221 }
222 
223 Tool *ToolChain::buildAssembler() const {
224   return new tools::ClangAs(*this);
225 }
226 
227 Tool *ToolChain::buildLinker() const {
228   llvm_unreachable("Linking is not supported by this toolchain");
229 }
230 
231 Tool *ToolChain::getAssemble() const {
232   if (!Assemble)
233     Assemble.reset(buildAssembler());
234   return Assemble.get();
235 }
236 
237 Tool *ToolChain::getClangAs() const {
238   if (!Assemble)
239     Assemble.reset(new tools::ClangAs(*this));
240   return Assemble.get();
241 }
242 
243 Tool *ToolChain::getLink() const {
244   if (!Link)
245     Link.reset(buildLinker());
246   return Link.get();
247 }
248 
249 Tool *ToolChain::getOffloadBundler() const {
250   if (!OffloadBundler)
251     OffloadBundler.reset(new tools::OffloadBundler(*this));
252   return OffloadBundler.get();
253 }
254 
255 Tool *ToolChain::getTool(Action::ActionClass AC) const {
256   switch (AC) {
257   case Action::AssembleJobClass:
258     return getAssemble();
259 
260   case Action::LinkJobClass:
261     return getLink();
262 
263   case Action::InputClass:
264   case Action::BindArchClass:
265   case Action::OffloadClass:
266   case Action::LipoJobClass:
267   case Action::DsymutilJobClass:
268   case Action::VerifyDebugInfoJobClass:
269     llvm_unreachable("Invalid tool kind.");
270 
271   case Action::CompileJobClass:
272   case Action::PrecompileJobClass:
273   case Action::PreprocessJobClass:
274   case Action::AnalyzeJobClass:
275   case Action::MigrateJobClass:
276   case Action::VerifyPCHJobClass:
277   case Action::BackendJobClass:
278     return getClang();
279 
280   case Action::OffloadBundlingJobClass:
281   case Action::OffloadUnbundlingJobClass:
282     return getOffloadBundler();
283   }
284 
285   llvm_unreachable("Invalid tool kind.");
286 }
287 
288 static StringRef getArchNameForCompilerRTLib(const ToolChain &TC,
289                                              const ArgList &Args) {
290   const llvm::Triple &Triple = TC.getTriple();
291   bool IsWindows = Triple.isOSWindows();
292 
293   if (Triple.isWindowsMSVCEnvironment() && TC.getArch() == llvm::Triple::x86)
294     return "i386";
295 
296   if (TC.getArch() == llvm::Triple::arm || TC.getArch() == llvm::Triple::armeb)
297     return (arm::getARMFloatABI(TC, Args) == arm::FloatABI::Hard && !IsWindows)
298                ? "armhf"
299                : "arm";
300 
301   return TC.getArchName();
302 }
303 
304 std::string ToolChain::getCompilerRT(const ArgList &Args, StringRef Component,
305                                      bool Shared) const {
306   const llvm::Triple &TT = getTriple();
307   const char *Env = TT.isAndroid() ? "-android" : "";
308   bool IsITANMSVCWindows =
309       TT.isWindowsMSVCEnvironment() || TT.isWindowsItaniumEnvironment();
310 
311   StringRef Arch = getArchNameForCompilerRTLib(*this, Args);
312   const char *Prefix = IsITANMSVCWindows ? "" : "lib";
313   const char *Suffix = Shared ? (Triple.isOSWindows() ? ".dll" : ".so")
314                               : (IsITANMSVCWindows ? ".lib" : ".a");
315 
316   SmallString<128> Path(getDriver().ResourceDir);
317   StringRef OSLibName = Triple.isOSFreeBSD() ? "freebsd" : getOS();
318   llvm::sys::path::append(Path, "lib", OSLibName);
319   llvm::sys::path::append(Path, Prefix + Twine("clang_rt.") + Component + "-" +
320                                     Arch + Env + Suffix);
321   return Path.str();
322 }
323 
324 const char *ToolChain::getCompilerRTArgString(const llvm::opt::ArgList &Args,
325                                               StringRef Component,
326                                               bool Shared) const {
327   return Args.MakeArgString(getCompilerRT(Args, Component, Shared));
328 }
329 
330 std::string ToolChain::getArchSpecificLibPath() const {
331   SmallString<128> Path(getDriver().ResourceDir);
332   StringRef OSLibName = getTriple().isOSFreeBSD() ? "freebsd" : getOS();
333   llvm::sys::path::append(Path, "lib", OSLibName,
334                           llvm::Triple::getArchTypeName(getArch()));
335   return Path.str();
336 }
337 
338 bool ToolChain::needsProfileRT(const ArgList &Args) {
339   if (Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
340                    false) ||
341       Args.hasArg(options::OPT_fprofile_generate) ||
342       Args.hasArg(options::OPT_fprofile_generate_EQ) ||
343       Args.hasArg(options::OPT_fprofile_instr_generate) ||
344       Args.hasArg(options::OPT_fprofile_instr_generate_EQ) ||
345       Args.hasArg(options::OPT_fcreate_profile) ||
346       Args.hasArg(options::OPT_coverage))
347     return true;
348 
349   return false;
350 }
351 
352 Tool *ToolChain::SelectTool(const JobAction &JA) const {
353   if (getDriver().ShouldUseClangCompiler(JA)) return getClang();
354   Action::ActionClass AC = JA.getKind();
355   if (AC == Action::AssembleJobClass && useIntegratedAs())
356     return getClangAs();
357   return getTool(AC);
358 }
359 
360 std::string ToolChain::GetFilePath(const char *Name) const {
361   return D.GetFilePath(Name, *this);
362 }
363 
364 std::string ToolChain::GetProgramPath(const char *Name) const {
365   return D.GetProgramPath(Name, *this);
366 }
367 
368 std::string ToolChain::GetLinkerPath() const {
369   const Arg* A = Args.getLastArg(options::OPT_fuse_ld_EQ);
370   StringRef UseLinker = A ? A->getValue() : CLANG_DEFAULT_LINKER;
371 
372   if (llvm::sys::path::is_absolute(UseLinker)) {
373     // If we're passed what looks like an absolute path, don't attempt to
374     // second-guess that.
375     if (llvm::sys::fs::exists(UseLinker))
376       return UseLinker;
377   } else if (UseLinker.empty() || UseLinker == "ld") {
378     // If we're passed -fuse-ld= with no argument, or with the argument ld,
379     // then use whatever the default system linker is.
380     return GetProgramPath(getDefaultLinker());
381   } else {
382     llvm::SmallString<8> LinkerName("ld.");
383     LinkerName.append(UseLinker);
384 
385     std::string LinkerPath(GetProgramPath(LinkerName.c_str()));
386     if (llvm::sys::fs::exists(LinkerPath))
387       return LinkerPath;
388   }
389 
390   if (A)
391     getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
392 
393   return GetProgramPath(getDefaultLinker());
394 }
395 
396 types::ID ToolChain::LookupTypeForExtension(StringRef Ext) const {
397   return types::lookupTypeForExtension(Ext);
398 }
399 
400 bool ToolChain::HasNativeLLVMSupport() const {
401   return false;
402 }
403 
404 bool ToolChain::isCrossCompiling() const {
405   llvm::Triple HostTriple(LLVM_HOST_TRIPLE);
406   switch (HostTriple.getArch()) {
407   // The A32/T32/T16 instruction sets are not separate architectures in this
408   // context.
409   case llvm::Triple::arm:
410   case llvm::Triple::armeb:
411   case llvm::Triple::thumb:
412   case llvm::Triple::thumbeb:
413     return getArch() != llvm::Triple::arm && getArch() != llvm::Triple::thumb &&
414            getArch() != llvm::Triple::armeb && getArch() != llvm::Triple::thumbeb;
415   default:
416     return HostTriple.getArch() != getArch();
417   }
418 }
419 
420 ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
421   return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
422                      VersionTuple());
423 }
424 
425 bool ToolChain::isThreadModelSupported(const StringRef Model) const {
426   if (Model == "single") {
427     // FIXME: 'single' is only supported on ARM and WebAssembly so far.
428     return Triple.getArch() == llvm::Triple::arm ||
429            Triple.getArch() == llvm::Triple::armeb ||
430            Triple.getArch() == llvm::Triple::thumb ||
431            Triple.getArch() == llvm::Triple::thumbeb ||
432            Triple.getArch() == llvm::Triple::wasm32 ||
433            Triple.getArch() == llvm::Triple::wasm64;
434   } else if (Model == "posix")
435     return true;
436 
437   return false;
438 }
439 
440 std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
441                                          types::ID InputType) const {
442   switch (getTriple().getArch()) {
443   default:
444     return getTripleString();
445 
446   case llvm::Triple::x86_64: {
447     llvm::Triple Triple = getTriple();
448     if (!Triple.isOSBinFormatMachO())
449       return getTripleString();
450 
451     if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
452       // x86_64h goes in the triple. Other -march options just use the
453       // vanilla triple we already have.
454       StringRef MArch = A->getValue();
455       if (MArch == "x86_64h")
456         Triple.setArchName(MArch);
457     }
458     return Triple.getTriple();
459   }
460   case llvm::Triple::aarch64: {
461     llvm::Triple Triple = getTriple();
462     if (!Triple.isOSBinFormatMachO())
463       return getTripleString();
464 
465     // FIXME: older versions of ld64 expect the "arm64" component in the actual
466     // triple string and query it to determine whether an LTO file can be
467     // handled. Remove this when we don't care any more.
468     Triple.setArchName("arm64");
469     return Triple.getTriple();
470   }
471   case llvm::Triple::arm:
472   case llvm::Triple::armeb:
473   case llvm::Triple::thumb:
474   case llvm::Triple::thumbeb: {
475     // FIXME: Factor into subclasses.
476     llvm::Triple Triple = getTriple();
477     bool IsBigEndian = getTriple().getArch() == llvm::Triple::armeb ||
478                        getTriple().getArch() == llvm::Triple::thumbeb;
479 
480     // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
481     // '-mbig-endian'/'-EB'.
482     if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
483                                  options::OPT_mbig_endian)) {
484       IsBigEndian = !A->getOption().matches(options::OPT_mlittle_endian);
485     }
486 
487     // Thumb2 is the default for V7 on Darwin.
488     //
489     // FIXME: Thumb should just be another -target-feaure, not in the triple.
490     StringRef MCPU, MArch;
491     if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
492       MCPU = A->getValue();
493     if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
494       MArch = A->getValue();
495     std::string CPU =
496         Triple.isOSBinFormatMachO()
497             ? tools::arm::getARMCPUForMArch(MArch, Triple).str()
498             : tools::arm::getARMTargetCPU(MCPU, MArch, Triple);
499     StringRef Suffix =
500       tools::arm::getLLVMArchSuffixForARM(CPU, MArch, Triple);
501     bool IsMProfile = ARM::parseArchProfile(Suffix) == ARM::PK_M;
502     bool ThumbDefault = IsMProfile || (ARM::parseArchVersion(Suffix) == 7 &&
503                                        getTriple().isOSBinFormatMachO());
504     // FIXME: this is invalid for WindowsCE
505     if (getTriple().isOSWindows())
506       ThumbDefault = true;
507     std::string ArchName;
508     if (IsBigEndian)
509       ArchName = "armeb";
510     else
511       ArchName = "arm";
512 
513     // Assembly files should start in ARM mode, unless arch is M-profile.
514     // Windows is always thumb.
515     if ((InputType != types::TY_PP_Asm && Args.hasFlag(options::OPT_mthumb,
516          options::OPT_mno_thumb, ThumbDefault)) || IsMProfile ||
517          getTriple().isOSWindows()) {
518       if (IsBigEndian)
519         ArchName = "thumbeb";
520       else
521         ArchName = "thumb";
522     }
523     Triple.setArchName(ArchName + Suffix.str());
524 
525     return Triple.getTriple();
526   }
527   }
528 }
529 
530 std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
531                                                    types::ID InputType) const {
532   return ComputeLLVMTriple(Args, InputType);
533 }
534 
535 void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
536                                           ArgStringList &CC1Args) const {
537   // Each toolchain should provide the appropriate include flags.
538 }
539 
540 void ToolChain::addClangTargetOptions(const ArgList &DriverArgs,
541                                       ArgStringList &CC1Args) const {
542 }
543 
544 void ToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {}
545 
546 void ToolChain::addProfileRTLibs(const llvm::opt::ArgList &Args,
547                                  llvm::opt::ArgStringList &CmdArgs) const {
548   if (!needsProfileRT(Args)) return;
549 
550   CmdArgs.push_back(getCompilerRTArgString(Args, "profile"));
551 }
552 
553 ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
554     const ArgList &Args) const {
555   const Arg* A = Args.getLastArg(options::OPT_rtlib_EQ);
556   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_RTLIB;
557 
558   // Only use "platform" in tests to override CLANG_DEFAULT_RTLIB!
559   if (LibName == "compiler-rt")
560     return ToolChain::RLT_CompilerRT;
561   else if (LibName == "libgcc")
562     return ToolChain::RLT_Libgcc;
563   else if (LibName == "platform")
564     return GetDefaultRuntimeLibType();
565 
566   if (A)
567     getDriver().Diag(diag::err_drv_invalid_rtlib_name) << A->getAsString(Args);
568 
569   return GetDefaultRuntimeLibType();
570 }
571 
572 ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
573   const Arg *A = Args.getLastArg(options::OPT_stdlib_EQ);
574   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_CXX_STDLIB;
575 
576   // Only use "platform" in tests to override CLANG_DEFAULT_CXX_STDLIB!
577   if (LibName == "libc++")
578     return ToolChain::CST_Libcxx;
579   else if (LibName == "libstdc++")
580     return ToolChain::CST_Libstdcxx;
581   else if (LibName == "platform")
582     return GetDefaultCXXStdlibType();
583 
584   if (A)
585     getDriver().Diag(diag::err_drv_invalid_stdlib_name) << A->getAsString(Args);
586 
587   return GetDefaultCXXStdlibType();
588 }
589 
590 /// \brief Utility function to add a system include directory to CC1 arguments.
591 /*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
592                                             ArgStringList &CC1Args,
593                                             const Twine &Path) {
594   CC1Args.push_back("-internal-isystem");
595   CC1Args.push_back(DriverArgs.MakeArgString(Path));
596 }
597 
598 /// \brief Utility function to add a system include directory with extern "C"
599 /// semantics to CC1 arguments.
600 ///
601 /// Note that this should be used rarely, and only for directories that
602 /// historically and for legacy reasons are treated as having implicit extern
603 /// "C" semantics. These semantics are *ignored* by and large today, but its
604 /// important to preserve the preprocessor changes resulting from the
605 /// classification.
606 /*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
607                                                    ArgStringList &CC1Args,
608                                                    const Twine &Path) {
609   CC1Args.push_back("-internal-externc-isystem");
610   CC1Args.push_back(DriverArgs.MakeArgString(Path));
611 }
612 
613 void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
614                                                 ArgStringList &CC1Args,
615                                                 const Twine &Path) {
616   if (llvm::sys::fs::exists(Path))
617     addExternCSystemInclude(DriverArgs, CC1Args, Path);
618 }
619 
620 /// \brief Utility function to add a list of system include directories to CC1.
621 /*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
622                                              ArgStringList &CC1Args,
623                                              ArrayRef<StringRef> Paths) {
624   for (StringRef Path : Paths) {
625     CC1Args.push_back("-internal-isystem");
626     CC1Args.push_back(DriverArgs.MakeArgString(Path));
627   }
628 }
629 
630 void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
631                                              ArgStringList &CC1Args) const {
632   // Header search paths should be handled by each of the subclasses.
633   // Historically, they have not been, and instead have been handled inside of
634   // the CC1-layer frontend. As the logic is hoisted out, this generic function
635   // will slowly stop being called.
636   //
637   // While it is being called, replicate a bit of a hack to propagate the
638   // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
639   // header search paths with it. Once all systems are overriding this
640   // function, the CC1 flag and this line can be removed.
641   DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
642 }
643 
644 void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
645                                     ArgStringList &CmdArgs) const {
646   CXXStdlibType Type = GetCXXStdlibType(Args);
647 
648   switch (Type) {
649   case ToolChain::CST_Libcxx:
650     CmdArgs.push_back("-lc++");
651     break;
652 
653   case ToolChain::CST_Libstdcxx:
654     CmdArgs.push_back("-lstdc++");
655     break;
656   }
657 }
658 
659 void ToolChain::AddFilePathLibArgs(const ArgList &Args,
660                                    ArgStringList &CmdArgs) const {
661   for (const auto &LibPath : getFilePaths())
662     if(LibPath.length() > 0)
663       CmdArgs.push_back(Args.MakeArgString(StringRef("-L") + LibPath));
664 }
665 
666 void ToolChain::AddCCKextLibArgs(const ArgList &Args,
667                                  ArgStringList &CmdArgs) const {
668   CmdArgs.push_back("-lcc_kext");
669 }
670 
671 bool ToolChain::AddFastMathRuntimeIfAvailable(const ArgList &Args,
672                                               ArgStringList &CmdArgs) const {
673   // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
674   // (to keep the linker options consistent with gcc and clang itself).
675   if (!isOptimizationLevelFast(Args)) {
676     // Check if -ffast-math or -funsafe-math.
677     Arg *A =
678         Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
679                         options::OPT_funsafe_math_optimizations,
680                         options::OPT_fno_unsafe_math_optimizations);
681 
682     if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
683         A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
684       return false;
685   }
686   // If crtfastmath.o exists add it to the arguments.
687   std::string Path = GetFilePath("crtfastmath.o");
688   if (Path == "crtfastmath.o") // Not found.
689     return false;
690 
691   CmdArgs.push_back(Args.MakeArgString(Path));
692   return true;
693 }
694 
695 SanitizerMask ToolChain::getSupportedSanitizers() const {
696   // Return sanitizers which don't require runtime support and are not
697   // platform dependent.
698   using namespace SanitizerKind;
699   SanitizerMask Res = (Undefined & ~Vptr & ~Function) | (CFI & ~CFIICall) |
700                       CFICastStrict | UnsignedIntegerOverflow | Nullability |
701                       LocalBounds;
702   if (getTriple().getArch() == llvm::Triple::x86 ||
703       getTriple().getArch() == llvm::Triple::x86_64 ||
704       getTriple().getArch() == llvm::Triple::arm ||
705       getTriple().getArch() == llvm::Triple::aarch64 ||
706       getTriple().getArch() == llvm::Triple::wasm32 ||
707       getTriple().getArch() == llvm::Triple::wasm64)
708     Res |= CFIICall;
709   return Res;
710 }
711 
712 void ToolChain::AddCudaIncludeArgs(const ArgList &DriverArgs,
713                                    ArgStringList &CC1Args) const {}
714 
715 void ToolChain::AddIAMCUIncludeArgs(const ArgList &DriverArgs,
716                                     ArgStringList &CC1Args) const {}
717 
718 static VersionTuple separateMSVCFullVersion(unsigned Version) {
719   if (Version < 100)
720     return VersionTuple(Version);
721 
722   if (Version < 10000)
723     return VersionTuple(Version / 100, Version % 100);
724 
725   unsigned Build = 0, Factor = 1;
726   for (; Version > 10000; Version = Version / 10, Factor = Factor * 10)
727     Build = Build + (Version % 10) * Factor;
728   return VersionTuple(Version / 100, Version % 100, Build);
729 }
730 
731 VersionTuple
732 ToolChain::computeMSVCVersion(const Driver *D,
733                               const llvm::opt::ArgList &Args) const {
734   const Arg *MSCVersion = Args.getLastArg(options::OPT_fmsc_version);
735   const Arg *MSCompatibilityVersion =
736       Args.getLastArg(options::OPT_fms_compatibility_version);
737 
738   if (MSCVersion && MSCompatibilityVersion) {
739     if (D)
740       D->Diag(diag::err_drv_argument_not_allowed_with)
741           << MSCVersion->getAsString(Args)
742           << MSCompatibilityVersion->getAsString(Args);
743     return VersionTuple();
744   }
745 
746   if (MSCompatibilityVersion) {
747     VersionTuple MSVT;
748     if (MSVT.tryParse(MSCompatibilityVersion->getValue())) {
749       if (D)
750         D->Diag(diag::err_drv_invalid_value)
751             << MSCompatibilityVersion->getAsString(Args)
752             << MSCompatibilityVersion->getValue();
753     } else {
754       return MSVT;
755     }
756   }
757 
758   if (MSCVersion) {
759     unsigned Version = 0;
760     if (StringRef(MSCVersion->getValue()).getAsInteger(10, Version)) {
761       if (D)
762         D->Diag(diag::err_drv_invalid_value)
763             << MSCVersion->getAsString(Args) << MSCVersion->getValue();
764     } else {
765       return separateMSVCFullVersion(Version);
766     }
767   }
768 
769   return VersionTuple();
770 }
771