1 //===--- ToolChain.cpp - Collections of tools for one platform ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 #include "clang/Basic/ObjCRuntime.h"
12 #include "clang/Driver/Action.h"
13 #include "clang/Driver/Driver.h"
14 #include "clang/Driver/DriverDiagnostic.h"
15 #include "clang/Driver/Options.h"
16 #include "clang/Driver/SanitizerArgs.h"
17 #include "clang/Driver/ToolChain.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringSwitch.h"
20 #include "llvm/Option/Arg.h"
21 #include "llvm/Option/ArgList.h"
22 #include "llvm/Option/Option.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/FileSystem.h"
25 #include "llvm/Support/TargetRegistry.h"
26 #include "llvm/Support/TargetParser.h"
28 using namespace clang::driver;
29 using namespace clang::driver::tools;
30 using namespace clang;
32 using namespace llvm::opt;
34 static llvm::opt::Arg *GetRTTIArgument(const ArgList &Args) {
35 return Args.getLastArg(options::OPT_mkernel, options::OPT_fapple_kext,
36 options::OPT_fno_rtti, options::OPT_frtti);
39 static ToolChain::RTTIMode CalculateRTTIMode(const ArgList &Args,
40 const llvm::Triple &Triple,
41 const Arg *CachedRTTIArg) {
42 // Explicit rtti/no-rtti args
44 if (CachedRTTIArg->getOption().matches(options::OPT_frtti))
45 return ToolChain::RM_EnabledExplicitly;
47 return ToolChain::RM_DisabledExplicitly;
50 // -frtti is default, except for the PS4 CPU.
51 if (!Triple.isPS4CPU())
52 return ToolChain::RM_EnabledImplicitly;
54 // On the PS4, turning on c++ exceptions turns on rtti.
55 // We're assuming that, if we see -fexceptions, rtti gets turned on.
56 Arg *Exceptions = Args.getLastArgNoClaim(
57 options::OPT_fcxx_exceptions, options::OPT_fno_cxx_exceptions,
58 options::OPT_fexceptions, options::OPT_fno_exceptions);
60 (Exceptions->getOption().matches(options::OPT_fexceptions) ||
61 Exceptions->getOption().matches(options::OPT_fcxx_exceptions)))
62 return ToolChain::RM_EnabledImplicitly;
64 return ToolChain::RM_DisabledImplicitly;
67 ToolChain::ToolChain(const Driver &D, const llvm::Triple &T,
69 : D(D), Triple(T), Args(Args), CachedRTTIArg(GetRTTIArgument(Args)),
70 CachedRTTIMode(CalculateRTTIMode(Args, Triple, CachedRTTIArg)) {
71 if (Arg *A = Args.getLastArg(options::OPT_mthread_model))
72 if (!isThreadModelSupported(A->getValue()))
73 D.Diag(diag::err_drv_invalid_thread_model_for_target)
74 << A->getValue() << A->getAsString(Args);
77 ToolChain::~ToolChain() {
80 vfs::FileSystem &ToolChain::getVFS() const { return getDriver().getVFS(); }
82 bool ToolChain::useIntegratedAs() const {
83 return Args.hasFlag(options::OPT_fintegrated_as,
84 options::OPT_fno_integrated_as,
85 IsIntegratedAssemblerDefault());
88 const SanitizerArgs& ToolChain::getSanitizerArgs() const {
89 if (!SanitizerArguments.get())
90 SanitizerArguments.reset(new SanitizerArgs(*this, Args));
91 return *SanitizerArguments.get();
100 const DriverSuffix *FindDriverSuffix(StringRef ProgName) {
101 // A list of known driver suffixes. Suffixes are compared against the
102 // program name in order. If there is a match, the frontend type is updated as
103 // necessary by applying the ModeFlag.
104 static const DriverSuffix DriverSuffixes[] = {
106 {"clang++", "--driver-mode=g++"},
107 {"clang-c++", "--driver-mode=g++"},
108 {"clang-cc", nullptr},
109 {"clang-cpp", "--driver-mode=cpp"},
110 {"clang-g++", "--driver-mode=g++"},
111 {"clang-gcc", nullptr},
112 {"clang-cl", "--driver-mode=cl"},
114 {"cpp", "--driver-mode=cpp"},
115 {"cl", "--driver-mode=cl"},
116 {"++", "--driver-mode=g++"},
119 for (size_t i = 0; i < llvm::array_lengthof(DriverSuffixes); ++i)
120 if (ProgName.endswith(DriverSuffixes[i].Suffix))
121 return &DriverSuffixes[i];
125 /// Normalize the program name from argv[0] by stripping the file extension if
126 /// present and lower-casing the string on Windows.
127 std::string normalizeProgramName(llvm::StringRef Argv0) {
128 std::string ProgName = llvm::sys::path::stem(Argv0);
130 // Transform to lowercase for case insensitive file systems.
131 std::transform(ProgName.begin(), ProgName.end(), ProgName.begin(), ::tolower);
136 const DriverSuffix *parseDriverSuffix(StringRef ProgName) {
137 // Try to infer frontend type and default target from the program name by
138 // comparing it against DriverSuffixes in order.
140 // If there is a match, the function tries to identify a target as prefix.
141 // E.g. "x86_64-linux-clang" as interpreted as suffix "clang" with target
142 // prefix "x86_64-linux". If such a target prefix is found, it may be
143 // added via -target as implicit first argument.
144 const DriverSuffix *DS = FindDriverSuffix(ProgName);
147 // Try again after stripping any trailing version number:
148 // clang++3.5 -> clang++
149 ProgName = ProgName.rtrim("0123456789.");
150 DS = FindDriverSuffix(ProgName);
154 // Try again after stripping trailing -component.
155 // clang++-tot -> clang++
156 ProgName = ProgName.slice(0, ProgName.rfind('-'));
157 DS = FindDriverSuffix(ProgName);
161 } // anonymous namespace
163 std::pair<std::string, std::string>
164 ToolChain::getTargetAndModeFromProgramName(StringRef PN) {
165 std::string ProgName = normalizeProgramName(PN);
166 const DriverSuffix *DS = parseDriverSuffix(ProgName);
168 return std::make_pair("", "");
169 std::string ModeFlag = DS->ModeFlag == nullptr ? "" : DS->ModeFlag;
171 std::string::size_type LastComponent =
172 ProgName.rfind('-', ProgName.size() - strlen(DS->Suffix));
173 if (LastComponent == std::string::npos)
174 return std::make_pair("", ModeFlag);
176 // Infer target from the prefix.
177 StringRef Prefix(ProgName);
178 Prefix = Prefix.slice(0, LastComponent);
179 std::string IgnoredError;
181 if (llvm::TargetRegistry::lookupTarget(Prefix, IgnoredError)) {
184 return std::make_pair(Target, ModeFlag);
187 StringRef ToolChain::getDefaultUniversalArchName() const {
188 // In universal driver terms, the arch name accepted by -arch isn't exactly
189 // the same as the ones that appear in the triple. Roughly speaking, this is
190 // an inverse of the darwin::getArchTypeForDarwinArchName() function, but the
191 // only interesting special case is powerpc.
192 switch (Triple.getArch()) {
193 case llvm::Triple::ppc:
195 case llvm::Triple::ppc64:
197 case llvm::Triple::ppc64le:
200 return Triple.getArchName();
204 bool ToolChain::IsUnwindTablesDefault() const {
208 Tool *ToolChain::getClang() const {
210 Clang.reset(new tools::Clang(*this));
214 Tool *ToolChain::buildAssembler() const {
215 return new tools::ClangAs(*this);
218 Tool *ToolChain::buildLinker() const {
219 llvm_unreachable("Linking is not supported by this toolchain");
222 Tool *ToolChain::getAssemble() const {
224 Assemble.reset(buildAssembler());
225 return Assemble.get();
228 Tool *ToolChain::getClangAs() const {
230 Assemble.reset(new tools::ClangAs(*this));
231 return Assemble.get();
234 Tool *ToolChain::getLink() const {
236 Link.reset(buildLinker());
240 Tool *ToolChain::getTool(Action::ActionClass AC) const {
242 case Action::AssembleJobClass:
243 return getAssemble();
245 case Action::LinkJobClass:
248 case Action::InputClass:
249 case Action::BindArchClass:
250 case Action::CudaDeviceClass:
251 case Action::CudaHostClass:
252 case Action::LipoJobClass:
253 case Action::DsymutilJobClass:
254 case Action::VerifyDebugInfoJobClass:
255 llvm_unreachable("Invalid tool kind.");
257 case Action::CompileJobClass:
258 case Action::PrecompileJobClass:
259 case Action::PreprocessJobClass:
260 case Action::AnalyzeJobClass:
261 case Action::MigrateJobClass:
262 case Action::VerifyPCHJobClass:
263 case Action::BackendJobClass:
267 llvm_unreachable("Invalid tool kind.");
270 static StringRef getArchNameForCompilerRTLib(const ToolChain &TC,
271 const ArgList &Args) {
272 const llvm::Triple &Triple = TC.getTriple();
273 bool IsWindows = Triple.isOSWindows();
275 if (Triple.isWindowsMSVCEnvironment() && TC.getArch() == llvm::Triple::x86)
278 if (TC.getArch() == llvm::Triple::arm || TC.getArch() == llvm::Triple::armeb)
279 return (arm::getARMFloatABI(TC, Args) == arm::FloatABI::Hard && !IsWindows)
283 return TC.getArchName();
286 std::string ToolChain::getCompilerRT(const ArgList &Args, StringRef Component,
288 const llvm::Triple &TT = getTriple();
289 const char *Env = TT.isAndroid() ? "-android" : "";
290 bool IsITANMSVCWindows =
291 TT.isWindowsMSVCEnvironment() || TT.isWindowsItaniumEnvironment();
293 StringRef Arch = getArchNameForCompilerRTLib(*this, Args);
294 const char *Prefix = IsITANMSVCWindows ? "" : "lib";
295 const char *Suffix = Shared ? (Triple.isOSWindows() ? ".dll" : ".so")
296 : (IsITANMSVCWindows ? ".lib" : ".a");
298 SmallString<128> Path(getDriver().ResourceDir);
299 StringRef OSLibName = Triple.isOSFreeBSD() ? "freebsd" : getOS();
300 llvm::sys::path::append(Path, "lib", OSLibName);
301 llvm::sys::path::append(Path, Prefix + Twine("clang_rt.") + Component + "-" +
302 Arch + Env + Suffix);
306 const char *ToolChain::getCompilerRTArgString(const llvm::opt::ArgList &Args,
309 return Args.MakeArgString(getCompilerRT(Args, Component, Shared));
312 bool ToolChain::needsProfileRT(const ArgList &Args) {
313 if (Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
315 Args.hasArg(options::OPT_fprofile_generate) ||
316 Args.hasArg(options::OPT_fprofile_generate_EQ) ||
317 Args.hasArg(options::OPT_fprofile_instr_generate) ||
318 Args.hasArg(options::OPT_fprofile_instr_generate_EQ) ||
319 Args.hasArg(options::OPT_fcreate_profile) ||
320 Args.hasArg(options::OPT_coverage))
326 Tool *ToolChain::SelectTool(const JobAction &JA) const {
327 if (getDriver().ShouldUseClangCompiler(JA)) return getClang();
328 Action::ActionClass AC = JA.getKind();
329 if (AC == Action::AssembleJobClass && useIntegratedAs())
334 std::string ToolChain::GetFilePath(const char *Name) const {
335 return D.GetFilePath(Name, *this);
338 std::string ToolChain::GetProgramPath(const char *Name) const {
339 return D.GetProgramPath(Name, *this);
342 std::string ToolChain::GetLinkerPath() const {
343 if (Arg *A = Args.getLastArg(options::OPT_fuse_ld_EQ)) {
344 StringRef Suffix = A->getValue();
346 // If we're passed -fuse-ld= with no argument, or with the argument ld,
347 // then use whatever the default system linker is.
348 if (Suffix.empty() || Suffix == "ld")
349 return GetProgramPath("ld");
351 llvm::SmallString<8> LinkerName("ld.");
352 LinkerName.append(Suffix);
354 std::string LinkerPath(GetProgramPath(LinkerName.c_str()));
355 if (llvm::sys::fs::exists(LinkerPath))
358 getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
362 return GetProgramPath(DefaultLinker);
365 types::ID ToolChain::LookupTypeForExtension(const char *Ext) const {
366 return types::lookupTypeForExtension(Ext);
369 bool ToolChain::HasNativeLLVMSupport() const {
373 bool ToolChain::isCrossCompiling() const {
374 llvm::Triple HostTriple(LLVM_HOST_TRIPLE);
375 switch (HostTriple.getArch()) {
376 // The A32/T32/T16 instruction sets are not separate architectures in this
378 case llvm::Triple::arm:
379 case llvm::Triple::armeb:
380 case llvm::Triple::thumb:
381 case llvm::Triple::thumbeb:
382 return getArch() != llvm::Triple::arm && getArch() != llvm::Triple::thumb &&
383 getArch() != llvm::Triple::armeb && getArch() != llvm::Triple::thumbeb;
385 return HostTriple.getArch() != getArch();
389 ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
390 return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
394 bool ToolChain::isThreadModelSupported(const StringRef Model) const {
395 if (Model == "single") {
396 // FIXME: 'single' is only supported on ARM and WebAssembly so far.
397 return Triple.getArch() == llvm::Triple::arm ||
398 Triple.getArch() == llvm::Triple::armeb ||
399 Triple.getArch() == llvm::Triple::thumb ||
400 Triple.getArch() == llvm::Triple::thumbeb ||
401 Triple.getArch() == llvm::Triple::wasm32 ||
402 Triple.getArch() == llvm::Triple::wasm64;
403 } else if (Model == "posix")
409 std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
410 types::ID InputType) const {
411 switch (getTriple().getArch()) {
413 return getTripleString();
415 case llvm::Triple::x86_64: {
416 llvm::Triple Triple = getTriple();
417 if (!Triple.isOSBinFormatMachO())
418 return getTripleString();
420 if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
421 // x86_64h goes in the triple. Other -march options just use the
422 // vanilla triple we already have.
423 StringRef MArch = A->getValue();
424 if (MArch == "x86_64h")
425 Triple.setArchName(MArch);
427 return Triple.getTriple();
429 case llvm::Triple::aarch64: {
430 llvm::Triple Triple = getTriple();
431 if (!Triple.isOSBinFormatMachO())
432 return getTripleString();
434 // FIXME: older versions of ld64 expect the "arm64" component in the actual
435 // triple string and query it to determine whether an LTO file can be
436 // handled. Remove this when we don't care any more.
437 Triple.setArchName("arm64");
438 return Triple.getTriple();
440 case llvm::Triple::arm:
441 case llvm::Triple::armeb:
442 case llvm::Triple::thumb:
443 case llvm::Triple::thumbeb: {
444 // FIXME: Factor into subclasses.
445 llvm::Triple Triple = getTriple();
446 bool IsBigEndian = getTriple().getArch() == llvm::Triple::armeb ||
447 getTriple().getArch() == llvm::Triple::thumbeb;
449 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
450 // '-mbig-endian'/'-EB'.
451 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
452 options::OPT_mbig_endian)) {
453 IsBigEndian = !A->getOption().matches(options::OPT_mlittle_endian);
456 // Thumb2 is the default for V7 on Darwin.
458 // FIXME: Thumb should just be another -target-feaure, not in the triple.
459 StringRef MCPU, MArch;
460 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
461 MCPU = A->getValue();
462 if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
463 MArch = A->getValue();
465 Triple.isOSBinFormatMachO()
466 ? tools::arm::getARMCPUForMArch(MArch, Triple).str()
467 : tools::arm::getARMTargetCPU(MCPU, MArch, Triple);
469 tools::arm::getLLVMArchSuffixForARM(CPU, MArch, Triple);
470 bool IsMProfile = ARM::parseArchProfile(Suffix) == ARM::PK_M;
471 bool ThumbDefault = IsMProfile || (ARM::parseArchVersion(Suffix) == 7 &&
472 getTriple().isOSBinFormatMachO());
473 // FIXME: this is invalid for WindowsCE
474 if (getTriple().isOSWindows())
476 std::string ArchName;
482 // Assembly files should start in ARM mode, unless arch is M-profile.
483 if ((InputType != types::TY_PP_Asm && Args.hasFlag(options::OPT_mthumb,
484 options::OPT_mno_thumb, ThumbDefault)) || IsMProfile) {
486 ArchName = "thumbeb";
490 Triple.setArchName(ArchName + Suffix.str());
492 return Triple.getTriple();
497 std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
498 types::ID InputType) const {
499 return ComputeLLVMTriple(Args, InputType);
502 void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
503 ArgStringList &CC1Args) const {
504 // Each toolchain should provide the appropriate include flags.
507 void ToolChain::addClangTargetOptions(const ArgList &DriverArgs,
508 ArgStringList &CC1Args) const {
511 void ToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {}
513 void ToolChain::addProfileRTLibs(const llvm::opt::ArgList &Args,
514 llvm::opt::ArgStringList &CmdArgs) const {
515 if (!needsProfileRT(Args)) return;
517 CmdArgs.push_back(getCompilerRTArgString(Args, "profile"));
521 ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
522 const ArgList &Args) const {
523 if (Arg *A = Args.getLastArg(options::OPT_rtlib_EQ)) {
524 StringRef Value = A->getValue();
525 if (Value == "compiler-rt")
526 return ToolChain::RLT_CompilerRT;
527 if (Value == "libgcc")
528 return ToolChain::RLT_Libgcc;
529 getDriver().Diag(diag::err_drv_invalid_rtlib_name)
530 << A->getAsString(Args);
533 return GetDefaultRuntimeLibType();
536 ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
537 if (Arg *A = Args.getLastArg(options::OPT_stdlib_EQ)) {
538 StringRef Value = A->getValue();
539 if (Value == "libc++")
540 return ToolChain::CST_Libcxx;
541 if (Value == "libstdc++")
542 return ToolChain::CST_Libstdcxx;
543 getDriver().Diag(diag::err_drv_invalid_stdlib_name)
544 << A->getAsString(Args);
547 return ToolChain::CST_Libstdcxx;
550 /// \brief Utility function to add a system include directory to CC1 arguments.
551 /*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
552 ArgStringList &CC1Args,
554 CC1Args.push_back("-internal-isystem");
555 CC1Args.push_back(DriverArgs.MakeArgString(Path));
558 /// \brief Utility function to add a system include directory with extern "C"
559 /// semantics to CC1 arguments.
561 /// Note that this should be used rarely, and only for directories that
562 /// historically and for legacy reasons are treated as having implicit extern
563 /// "C" semantics. These semantics are *ignored* by and large today, but its
564 /// important to preserve the preprocessor changes resulting from the
566 /*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
567 ArgStringList &CC1Args,
569 CC1Args.push_back("-internal-externc-isystem");
570 CC1Args.push_back(DriverArgs.MakeArgString(Path));
573 void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
574 ArgStringList &CC1Args,
576 if (llvm::sys::fs::exists(Path))
577 addExternCSystemInclude(DriverArgs, CC1Args, Path);
580 /// \brief Utility function to add a list of system include directories to CC1.
581 /*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
582 ArgStringList &CC1Args,
583 ArrayRef<StringRef> Paths) {
584 for (StringRef Path : Paths) {
585 CC1Args.push_back("-internal-isystem");
586 CC1Args.push_back(DriverArgs.MakeArgString(Path));
590 void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
591 ArgStringList &CC1Args) const {
592 // Header search paths should be handled by each of the subclasses.
593 // Historically, they have not been, and instead have been handled inside of
594 // the CC1-layer frontend. As the logic is hoisted out, this generic function
595 // will slowly stop being called.
597 // While it is being called, replicate a bit of a hack to propagate the
598 // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
599 // header search paths with it. Once all systems are overriding this
600 // function, the CC1 flag and this line can be removed.
601 DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
604 void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
605 ArgStringList &CmdArgs) const {
606 CXXStdlibType Type = GetCXXStdlibType(Args);
609 case ToolChain::CST_Libcxx:
610 CmdArgs.push_back("-lc++");
613 case ToolChain::CST_Libstdcxx:
614 CmdArgs.push_back("-lstdc++");
619 void ToolChain::AddFilePathLibArgs(const ArgList &Args,
620 ArgStringList &CmdArgs) const {
621 for (const auto &LibPath : getFilePaths())
622 if(LibPath.length() > 0)
623 CmdArgs.push_back(Args.MakeArgString(StringRef("-L") + LibPath));
626 void ToolChain::AddCCKextLibArgs(const ArgList &Args,
627 ArgStringList &CmdArgs) const {
628 CmdArgs.push_back("-lcc_kext");
631 bool ToolChain::AddFastMathRuntimeIfAvailable(const ArgList &Args,
632 ArgStringList &CmdArgs) const {
633 // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
634 // (to keep the linker options consistent with gcc and clang itself).
635 if (!isOptimizationLevelFast(Args)) {
636 // Check if -ffast-math or -funsafe-math.
638 Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
639 options::OPT_funsafe_math_optimizations,
640 options::OPT_fno_unsafe_math_optimizations);
642 if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
643 A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
646 // If crtfastmath.o exists add it to the arguments.
647 std::string Path = GetFilePath("crtfastmath.o");
648 if (Path == "crtfastmath.o") // Not found.
651 CmdArgs.push_back(Args.MakeArgString(Path));
655 SanitizerMask ToolChain::getSupportedSanitizers() const {
656 // Return sanitizers which don't require runtime support and are not
657 // platform dependent.
658 using namespace SanitizerKind;
659 SanitizerMask Res = (Undefined & ~Vptr & ~Function) | (CFI & ~CFIICall) |
660 CFICastStrict | UnsignedIntegerOverflow | LocalBounds;
661 if (getTriple().getArch() == llvm::Triple::x86 ||
662 getTriple().getArch() == llvm::Triple::x86_64)
667 void ToolChain::AddCudaIncludeArgs(const ArgList &DriverArgs,
668 ArgStringList &CC1Args) const {}