1 //===--- ToolChains.h - ToolChain Implementations ---------------*- C++ -*-===//
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 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_H
11 #define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_H
14 #include "clang/Basic/Cuda.h"
15 #include "clang/Basic/VersionTuple.h"
16 #include "clang/Driver/Action.h"
17 #include "clang/Driver/Multilib.h"
18 #include "clang/Driver/ToolChain.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/SmallSet.h"
22 #include "llvm/Support/Compiler.h"
28 namespace toolchains {
30 /// Generic_GCC - A tool chain using the 'gcc' command to perform
31 /// all subcommands; this relies on gcc translating the majority of
32 /// command line options.
33 class LLVM_LIBRARY_VISIBILITY Generic_GCC : public ToolChain {
35 /// \brief Struct to store and manipulate GCC versions.
37 /// We rely on assumptions about the form and structure of GCC version
38 /// numbers: they consist of at most three '.'-separated components, and each
39 /// component is a non-negative integer except for the last component. For
40 /// the last component we are very flexible in order to tolerate release
41 /// candidates or 'x' wildcards.
43 /// Note that the ordering established among GCCVersions is based on the
44 /// preferred version string to use. For example we prefer versions without
45 /// a hard-coded patch number to those with a hard coded patch number.
47 /// Currently this doesn't provide any logic for textual suffixes to patches
48 /// in the way that (for example) Debian's version format does. If that ever
49 /// becomes necessary, it can be added.
51 /// \brief The unparsed text of the version.
54 /// \brief The parsed major, minor, and patch numbers.
55 int Major, Minor, Patch;
57 /// \brief The text of the parsed major, and major+minor versions.
58 std::string MajorStr, MinorStr;
60 /// \brief Any textual suffix on the patch number.
61 std::string PatchSuffix;
63 static GCCVersion Parse(StringRef VersionText);
64 bool isOlderThan(int RHSMajor, int RHSMinor, int RHSPatch,
65 StringRef RHSPatchSuffix = StringRef()) const;
66 bool operator<(const GCCVersion &RHS) const {
67 return isOlderThan(RHS.Major, RHS.Minor, RHS.Patch, RHS.PatchSuffix);
69 bool operator>(const GCCVersion &RHS) const { return RHS < *this; }
70 bool operator<=(const GCCVersion &RHS) const { return !(*this > RHS); }
71 bool operator>=(const GCCVersion &RHS) const { return !(*this < RHS); }
74 /// \brief This is a class to find a viable GCC installation for Clang to
77 /// This class tries to find a GCC installation on the system, and report
78 /// information about it. It starts from the host information provided to the
79 /// Driver, and has logic for fuzzing that where appropriate.
80 class GCCInstallationDetector {
82 llvm::Triple GCCTriple;
85 // FIXME: These might be better as path objects.
86 std::string GCCInstallPath;
87 std::string GCCParentLibPath;
89 /// The primary multilib appropriate for the given flags.
90 Multilib SelectedMultilib;
91 /// On Biarch systems, this corresponds to the default multilib when
92 /// targeting the non-default multilib. Otherwise, it is empty.
93 llvm::Optional<Multilib> BiarchSibling;
97 // We retain the list of install paths that were considered and rejected in
98 // order to print out detailed information in verbose mode.
99 std::set<std::string> CandidateGCCInstallPaths;
101 /// The set of multilibs that the detected installation supports.
102 MultilibSet Multilibs;
105 explicit GCCInstallationDetector(const Driver &D) : IsValid(false), D(D) {}
106 void init(const llvm::Triple &TargetTriple, const llvm::opt::ArgList &Args,
107 ArrayRef<std::string> ExtraTripleAliases = None);
109 /// \brief Check whether we detected a valid GCC install.
110 bool isValid() const { return IsValid; }
112 /// \brief Get the GCC triple for the detected install.
113 const llvm::Triple &getTriple() const { return GCCTriple; }
115 /// \brief Get the detected GCC installation path.
116 StringRef getInstallPath() const { return GCCInstallPath; }
118 /// \brief Get the detected GCC parent lib path.
119 StringRef getParentLibPath() const { return GCCParentLibPath; }
121 /// \brief Get the detected Multilib
122 const Multilib &getMultilib() const { return SelectedMultilib; }
124 /// \brief Get the whole MultilibSet
125 const MultilibSet &getMultilibs() const { return Multilibs; }
127 /// Get the biarch sibling multilib (if it exists).
128 /// \return true iff such a sibling exists
129 bool getBiarchSibling(Multilib &M) const;
131 /// \brief Get the detected GCC version string.
132 const GCCVersion &getVersion() const { return Version; }
134 /// \brief Print information about the detected GCC installation.
135 void print(raw_ostream &OS) const;
139 CollectLibDirsAndTriples(const llvm::Triple &TargetTriple,
140 const llvm::Triple &BiarchTriple,
141 SmallVectorImpl<StringRef> &LibDirs,
142 SmallVectorImpl<StringRef> &TripleAliases,
143 SmallVectorImpl<StringRef> &BiarchLibDirs,
144 SmallVectorImpl<StringRef> &BiarchTripleAliases);
146 void ScanLibDirForGCCTriple(const llvm::Triple &TargetArch,
147 const llvm::opt::ArgList &Args,
148 const std::string &LibDir,
149 StringRef CandidateTriple,
150 bool NeedsBiarchSuffix = false);
152 void scanLibDirForGCCTripleSolaris(const llvm::Triple &TargetArch,
153 const llvm::opt::ArgList &Args,
154 const std::string &LibDir,
155 StringRef CandidateTriple,
156 bool NeedsBiarchSuffix = false);
160 GCCInstallationDetector GCCInstallation;
162 // \brief A class to find a viable CUDA installation
163 class CudaInstallationDetector {
166 bool IsValid = false;
167 CudaVersion Version = CudaVersion::UNKNOWN;
168 std::string InstallPath;
171 std::string LibDevicePath;
172 std::string IncludePath;
173 llvm::StringMap<std::string> LibDeviceMap;
175 // CUDA architectures for which we have raised an error in
176 // CheckCudaVersionSupportsArch.
177 mutable llvm::SmallSet<CudaArch, 4> ArchsWithVersionTooLowErrors;
180 CudaInstallationDetector(const Driver &D) : D(D) {}
181 void init(const llvm::Triple &TargetTriple, const llvm::opt::ArgList &Args);
183 /// \brief Emit an error if Version does not support the given Arch.
185 /// If either Version or Arch is unknown, does not emit an error. Emits at
186 /// most one error per Arch.
187 void CheckCudaVersionSupportsArch(CudaArch Arch) const;
189 /// \brief Check whether we detected a valid Cuda install.
190 bool isValid() const { return IsValid; }
191 /// \brief Print information about the detected CUDA installation.
192 void print(raw_ostream &OS) const;
194 /// \brief Get the deteced Cuda install's version.
195 CudaVersion version() const { return Version; }
196 /// \brief Get the detected Cuda installation path.
197 StringRef getInstallPath() const { return InstallPath; }
198 /// \brief Get the detected path to Cuda's bin directory.
199 StringRef getBinPath() const { return BinPath; }
200 /// \brief Get the detected Cuda Include path.
201 StringRef getIncludePath() const { return IncludePath; }
202 /// \brief Get the detected Cuda library path.
203 StringRef getLibPath() const { return LibPath; }
204 /// \brief Get the detected Cuda device library path.
205 StringRef getLibDevicePath() const { return LibDevicePath; }
206 /// \brief Get libdevice file for given architecture
207 std::string getLibDeviceFile(StringRef Gpu) const {
208 return LibDeviceMap.lookup(Gpu);
212 CudaInstallationDetector CudaInstallation;
215 Generic_GCC(const Driver &D, const llvm::Triple &Triple,
216 const llvm::opt::ArgList &Args);
217 ~Generic_GCC() override;
219 void printVerboseInfo(raw_ostream &OS) const override;
221 bool IsUnwindTablesDefault() const override;
222 bool isPICDefault() const override;
223 bool isPIEDefault() const override;
224 bool isPICDefaultForced() const override;
225 bool IsIntegratedAssemblerDefault() const override;
228 Tool *getTool(Action::ActionClass AC) const override;
229 Tool *buildAssembler() const override;
230 Tool *buildLinker() const override;
232 /// \name ToolChain Implementation Helper Functions
235 /// \brief Check whether the target triple's architecture is 64-bits.
236 bool isTarget64Bit() const { return getTriple().isArch64Bit(); }
238 /// \brief Check whether the target triple's architecture is 32-bits.
239 bool isTarget32Bit() const { return getTriple().isArch32Bit(); }
241 bool addLibStdCXXIncludePaths(Twine Base, Twine Suffix, StringRef GCCTriple,
242 StringRef GCCMultiarchTriple,
243 StringRef TargetMultiarchTriple,
245 const llvm::opt::ArgList &DriverArgs,
246 llvm::opt::ArgStringList &CC1Args) const;
251 mutable std::unique_ptr<tools::gcc::Preprocessor> Preprocess;
252 mutable std::unique_ptr<tools::gcc::Compiler> Compile;
255 class LLVM_LIBRARY_VISIBILITY MachO : public ToolChain {
257 Tool *buildAssembler() const override;
258 Tool *buildLinker() const override;
259 Tool *getTool(Action::ActionClass AC) const override;
262 mutable std::unique_ptr<tools::darwin::Lipo> Lipo;
263 mutable std::unique_ptr<tools::darwin::Dsymutil> Dsymutil;
264 mutable std::unique_ptr<tools::darwin::VerifyDebug> VerifyDebug;
267 MachO(const Driver &D, const llvm::Triple &Triple,
268 const llvm::opt::ArgList &Args);
271 /// @name MachO specific toolchain API
274 /// Get the "MachO" arch name for a particular compiler invocation. For
275 /// example, Apple treats different ARM variations as distinct architectures.
276 StringRef getMachOArchName(const llvm::opt::ArgList &Args) const;
278 /// Add the linker arguments to link the ARC runtime library.
279 virtual void AddLinkARCArgs(const llvm::opt::ArgList &Args,
280 llvm::opt::ArgStringList &CmdArgs) const {}
282 /// Add the linker arguments to link the compiler runtime library.
283 virtual void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args,
284 llvm::opt::ArgStringList &CmdArgs) const;
286 virtual void addStartObjectFileArgs(const llvm::opt::ArgList &Args,
287 llvm::opt::ArgStringList &CmdArgs) const {
290 virtual void addMinVersionArgs(const llvm::opt::ArgList &Args,
291 llvm::opt::ArgStringList &CmdArgs) const {}
293 /// On some iOS platforms, kernel and kernel modules were built statically. Is
294 /// this such a target?
295 virtual bool isKernelStatic() const { return false; }
297 /// Is the target either iOS or an iOS simulator?
298 bool isTargetIOSBased() const { return false; }
300 void AddLinkRuntimeLib(const llvm::opt::ArgList &Args,
301 llvm::opt::ArgStringList &CmdArgs,
302 StringRef DarwinLibName, bool AlwaysLink = false,
303 bool IsEmbedded = false, bool AddRPath = false) const;
305 /// Add any profiling runtime libraries that are needed. This is essentially a
306 /// MachO specific version of addProfileRT in Tools.cpp.
307 void addProfileRTLibs(const llvm::opt::ArgList &Args,
308 llvm::opt::ArgStringList &CmdArgs) const override {
309 // There aren't any profiling libs for embedded targets currently.
313 /// @name ToolChain Implementation
316 std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,
317 types::ID InputType) const override;
319 types::ID LookupTypeForExtension(const char *Ext) const override;
321 bool HasNativeLLVMSupport() const override;
323 llvm::opt::DerivedArgList *
324 TranslateArgs(const llvm::opt::DerivedArgList &Args,
325 const char *BoundArch) const override;
327 bool IsBlocksDefault() const override {
328 // Always allow blocks on Apple; users interested in versioning are
329 // expected to use /usr/include/Block.h.
332 bool IsIntegratedAssemblerDefault() const override {
333 // Default integrated assembler to on for Apple's MachO targets.
337 bool IsMathErrnoDefault() const override { return false; }
339 bool IsEncodeExtendedBlockSignatureDefault() const override { return true; }
341 bool IsObjCNonFragileABIDefault() const override {
342 // Non-fragile ABI is default for everything but i386.
343 return getTriple().getArch() != llvm::Triple::x86;
346 bool UseObjCMixedDispatch() const override { return true; }
348 bool IsUnwindTablesDefault() const override;
350 RuntimeLibType GetDefaultRuntimeLibType() const override {
351 return ToolChain::RLT_CompilerRT;
354 bool isPICDefault() const override;
355 bool isPIEDefault() const override;
356 bool isPICDefaultForced() const override;
358 bool SupportsProfiling() const override;
360 bool SupportsObjCGC() const override { return false; }
362 bool UseDwarfDebugFlags() const override;
364 bool UseSjLjExceptions(const llvm::opt::ArgList &Args) const override {
371 /// Darwin - The base Darwin tool chain.
372 class LLVM_LIBRARY_VISIBILITY Darwin : public MachO {
374 /// Whether the information on the target has been initialized.
376 // FIXME: This should be eliminated. What we want to do is make this part of
377 // the "default target for arguments" selection process, once we get out of
378 // the argument translation business.
379 mutable bool TargetInitialized;
381 enum DarwinPlatformKind {
391 mutable DarwinPlatformKind TargetPlatform;
393 /// The OS version we are targeting.
394 mutable VersionTuple TargetVersion;
397 void AddDeploymentTarget(llvm::opt::DerivedArgList &Args) const;
400 Darwin(const Driver &D, const llvm::Triple &Triple,
401 const llvm::opt::ArgList &Args);
404 std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,
405 types::ID InputType) const override;
407 /// @name Apple Specific Toolchain Implementation
410 void addMinVersionArgs(const llvm::opt::ArgList &Args,
411 llvm::opt::ArgStringList &CmdArgs) const override;
413 void addStartObjectFileArgs(const llvm::opt::ArgList &Args,
414 llvm::opt::ArgStringList &CmdArgs) const override;
416 bool isKernelStatic() const override {
417 return (!(isTargetIPhoneOS() && !isIPhoneOSVersionLT(6, 0)) &&
421 void addProfileRTLibs(const llvm::opt::ArgList &Args,
422 llvm::opt::ArgStringList &CmdArgs) const override;
426 /// @name Darwin specific Toolchain functions
429 // FIXME: Eliminate these ...Target functions and derive separate tool chains
430 // for these targets and put version in constructor.
431 void setTarget(DarwinPlatformKind Platform, unsigned Major, unsigned Minor,
432 unsigned Micro) const {
433 // FIXME: For now, allow reinitialization as long as values don't
434 // change. This will go away when we move away from argument translation.
435 if (TargetInitialized && TargetPlatform == Platform &&
436 TargetVersion == VersionTuple(Major, Minor, Micro))
439 assert(!TargetInitialized && "Target already initialized!");
440 TargetInitialized = true;
441 TargetPlatform = Platform;
442 TargetVersion = VersionTuple(Major, Minor, Micro);
445 bool isTargetIPhoneOS() const {
446 assert(TargetInitialized && "Target not initialized!");
447 return TargetPlatform == IPhoneOS || TargetPlatform == TvOS;
450 bool isTargetIOSSimulator() const {
451 assert(TargetInitialized && "Target not initialized!");
452 return TargetPlatform == IPhoneOSSimulator ||
453 TargetPlatform == TvOSSimulator;
456 bool isTargetIOSBased() const {
457 assert(TargetInitialized && "Target not initialized!");
458 return isTargetIPhoneOS() || isTargetIOSSimulator();
461 bool isTargetTvOS() const {
462 assert(TargetInitialized && "Target not initialized!");
463 return TargetPlatform == TvOS;
466 bool isTargetTvOSSimulator() const {
467 assert(TargetInitialized && "Target not initialized!");
468 return TargetPlatform == TvOSSimulator;
471 bool isTargetTvOSBased() const {
472 assert(TargetInitialized && "Target not initialized!");
473 return TargetPlatform == TvOS || TargetPlatform == TvOSSimulator;
476 bool isTargetWatchOS() const {
477 assert(TargetInitialized && "Target not initialized!");
478 return TargetPlatform == WatchOS;
481 bool isTargetWatchOSSimulator() const {
482 assert(TargetInitialized && "Target not initialized!");
483 return TargetPlatform == WatchOSSimulator;
486 bool isTargetWatchOSBased() const {
487 assert(TargetInitialized && "Target not initialized!");
488 return TargetPlatform == WatchOS || TargetPlatform == WatchOSSimulator;
491 bool isTargetMacOS() const {
492 assert(TargetInitialized && "Target not initialized!");
493 return TargetPlatform == MacOS;
496 bool isTargetInitialized() const { return TargetInitialized; }
498 VersionTuple getTargetVersion() const {
499 assert(TargetInitialized && "Target not initialized!");
500 return TargetVersion;
503 bool isIPhoneOSVersionLT(unsigned V0, unsigned V1 = 0,
504 unsigned V2 = 0) const {
505 assert(isTargetIOSBased() && "Unexpected call for non iOS target!");
506 return TargetVersion < VersionTuple(V0, V1, V2);
509 bool isMacosxVersionLT(unsigned V0, unsigned V1 = 0, unsigned V2 = 0) const {
510 assert(isTargetMacOS() && "Unexpected call for non OS X target!");
511 return TargetVersion < VersionTuple(V0, V1, V2);
514 StringRef getPlatformFamily() const;
515 static StringRef getSDKName(StringRef isysroot);
516 StringRef getOSLibraryNameSuffix() const;
520 /// @name ToolChain Implementation
523 // Darwin tools support multiple architecture (e.g., i386 and x86_64) and
524 // most development is done against SDKs, so compiling for a different
525 // architecture should not get any special treatment.
526 bool isCrossCompiling() const override { return false; }
528 llvm::opt::DerivedArgList *
529 TranslateArgs(const llvm::opt::DerivedArgList &Args,
530 const char *BoundArch) const override;
532 CXXStdlibType GetDefaultCXXStdlibType() const override;
533 ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const override;
534 bool hasBlocksRuntime() const override;
536 bool UseObjCMixedDispatch() const override {
537 // This is only used with the non-fragile ABI and non-legacy dispatch.
539 // Mixed dispatch is used everywhere except OS X before 10.6.
540 return !(isTargetMacOS() && isMacosxVersionLT(10, 6));
543 unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const override {
544 // Stack protectors default to on for user code on 10.5,
545 // and for everything in 10.6 and beyond
546 if (isTargetIOSBased() || isTargetWatchOSBased())
548 else if (isTargetMacOS() && !isMacosxVersionLT(10, 6))
550 else if (isTargetMacOS() && !isMacosxVersionLT(10, 5) && !KernelOrKext)
556 bool SupportsObjCGC() const override;
558 void CheckObjCARC() const override;
560 bool UseSjLjExceptions(const llvm::opt::ArgList &Args) const override;
562 bool SupportsEmbeddedBitcode() const override;
564 SanitizerMask getSupportedSanitizers() const override;
567 /// DarwinClang - The Darwin toolchain used by Clang.
568 class LLVM_LIBRARY_VISIBILITY DarwinClang : public Darwin {
570 DarwinClang(const Driver &D, const llvm::Triple &Triple,
571 const llvm::opt::ArgList &Args);
573 /// @name Apple ToolChain Implementation
576 void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args,
577 llvm::opt::ArgStringList &CmdArgs) const override;
579 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
580 llvm::opt::ArgStringList &CmdArgs) const override;
582 void AddCCKextLibArgs(const llvm::opt::ArgList &Args,
583 llvm::opt::ArgStringList &CmdArgs) const override;
585 void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;
587 void AddLinkARCArgs(const llvm::opt::ArgList &Args,
588 llvm::opt::ArgStringList &CmdArgs) const override;
590 unsigned GetDefaultDwarfVersion() const override { return 2; }
591 // Until dtrace (via CTF) and LLDB can deal with distributed debug info,
592 // Darwin defaults to standalone/full debug info.
593 bool GetDefaultStandaloneDebug() const override { return true; }
594 llvm::DebuggerKind getDefaultDebuggerTuning() const override {
595 return llvm::DebuggerKind::LLDB;
601 void AddLinkSanitizerLibArgs(const llvm::opt::ArgList &Args,
602 llvm::opt::ArgStringList &CmdArgs,
603 StringRef Sanitizer) const;
606 class LLVM_LIBRARY_VISIBILITY Generic_ELF : public Generic_GCC {
607 virtual void anchor();
610 Generic_ELF(const Driver &D, const llvm::Triple &Triple,
611 const llvm::opt::ArgList &Args)
612 : Generic_GCC(D, Triple, Args) {}
614 void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
615 llvm::opt::ArgStringList &CC1Args) const override;
618 class LLVM_LIBRARY_VISIBILITY CloudABI : public Generic_ELF {
620 CloudABI(const Driver &D, const llvm::Triple &Triple,
621 const llvm::opt::ArgList &Args);
622 bool HasNativeLLVMSupport() const override { return true; }
624 bool IsMathErrnoDefault() const override { return false; }
625 bool IsObjCNonFragileABIDefault() const override { return true; }
628 GetCXXStdlibType(const llvm::opt::ArgList &Args) const override {
629 return ToolChain::CST_Libcxx;
631 void AddClangCXXStdlibIncludeArgs(
632 const llvm::opt::ArgList &DriverArgs,
633 llvm::opt::ArgStringList &CC1Args) const override;
634 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
635 llvm::opt::ArgStringList &CmdArgs) const override;
637 bool isPIEDefault() const override;
638 SanitizerMask getSupportedSanitizers() const override;
639 SanitizerMask getDefaultSanitizers() const override;
642 Tool *buildLinker() const override;
645 class LLVM_LIBRARY_VISIBILITY Solaris : public Generic_GCC {
647 Solaris(const Driver &D, const llvm::Triple &Triple,
648 const llvm::opt::ArgList &Args);
650 bool IsIntegratedAssemblerDefault() const override { return true; }
652 void AddClangCXXStdlibIncludeArgs(
653 const llvm::opt::ArgList &DriverArgs,
654 llvm::opt::ArgStringList &CC1Args) const override;
656 unsigned GetDefaultDwarfVersion() const override { return 2; }
659 Tool *buildAssembler() const override;
660 Tool *buildLinker() const override;
663 class LLVM_LIBRARY_VISIBILITY MinGW : public ToolChain {
665 MinGW(const Driver &D, const llvm::Triple &Triple,
666 const llvm::opt::ArgList &Args);
668 bool IsIntegratedAssemblerDefault() const override;
669 bool IsUnwindTablesDefault() const override;
670 bool isPICDefault() const override;
671 bool isPIEDefault() const override;
672 bool isPICDefaultForced() const override;
673 bool UseSEHExceptions() const;
676 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
677 llvm::opt::ArgStringList &CC1Args) const override;
678 void AddClangCXXStdlibIncludeArgs(
679 const llvm::opt::ArgList &DriverArgs,
680 llvm::opt::ArgStringList &CC1Args) const override;
683 Tool *getTool(Action::ActionClass AC) const override;
684 Tool *buildLinker() const override;
685 Tool *buildAssembler() const override;
689 std::string GccLibDir;
692 mutable std::unique_ptr<tools::gcc::Preprocessor> Preprocessor;
693 mutable std::unique_ptr<tools::gcc::Compiler> Compiler;
694 void findGccLibDir();
697 class LLVM_LIBRARY_VISIBILITY Haiku : public Generic_ELF {
699 Haiku(const Driver &D, const llvm::Triple &Triple,
700 const llvm::opt::ArgList &Args);
702 bool isPIEDefault() const override { return getTriple().getArch() == llvm::Triple::x86_64; }
705 AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs,
706 llvm::opt::ArgStringList &CC1Args) const override;
709 class LLVM_LIBRARY_VISIBILITY OpenBSD : public Generic_ELF {
711 OpenBSD(const Driver &D, const llvm::Triple &Triple,
712 const llvm::opt::ArgList &Args);
714 bool IsMathErrnoDefault() const override { return false; }
715 bool IsObjCNonFragileABIDefault() const override { return true; }
716 bool isPIEDefault() const override { return true; }
718 unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const override {
721 unsigned GetDefaultDwarfVersion() const override { return 2; }
724 Tool *buildAssembler() const override;
725 Tool *buildLinker() const override;
728 class LLVM_LIBRARY_VISIBILITY Bitrig : public Generic_ELF {
730 Bitrig(const Driver &D, const llvm::Triple &Triple,
731 const llvm::opt::ArgList &Args);
733 bool IsMathErrnoDefault() const override { return false; }
734 bool IsObjCNonFragileABIDefault() const override { return true; }
736 CXXStdlibType GetDefaultCXXStdlibType() const override;
737 void AddClangCXXStdlibIncludeArgs(
738 const llvm::opt::ArgList &DriverArgs,
739 llvm::opt::ArgStringList &CC1Args) const override;
740 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
741 llvm::opt::ArgStringList &CmdArgs) const override;
742 unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const override {
747 Tool *buildAssembler() const override;
748 Tool *buildLinker() const override;
751 class LLVM_LIBRARY_VISIBILITY FreeBSD : public Generic_ELF {
753 FreeBSD(const Driver &D, const llvm::Triple &Triple,
754 const llvm::opt::ArgList &Args);
755 bool HasNativeLLVMSupport() const override;
757 bool IsMathErrnoDefault() const override { return false; }
758 bool IsObjCNonFragileABIDefault() const override { return true; }
760 CXXStdlibType GetDefaultCXXStdlibType() const override;
761 void AddClangCXXStdlibIncludeArgs(
762 const llvm::opt::ArgList &DriverArgs,
763 llvm::opt::ArgStringList &CC1Args) const override;
764 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
765 llvm::opt::ArgStringList &CmdArgs) const override;
767 bool UseSjLjExceptions(const llvm::opt::ArgList &Args) const override;
768 bool isPIEDefault() const override;
769 SanitizerMask getSupportedSanitizers() const override;
770 unsigned GetDefaultDwarfVersion() const override { return 2; }
771 // Until dtrace (via CTF) and LLDB can deal with distributed debug info,
772 // FreeBSD defaults to standalone/full debug info.
773 bool GetDefaultStandaloneDebug() const override { return true; }
776 Tool *buildAssembler() const override;
777 Tool *buildLinker() const override;
780 class LLVM_LIBRARY_VISIBILITY NetBSD : public Generic_ELF {
782 NetBSD(const Driver &D, const llvm::Triple &Triple,
783 const llvm::opt::ArgList &Args);
785 bool IsMathErrnoDefault() const override { return false; }
786 bool IsObjCNonFragileABIDefault() const override { return true; }
788 CXXStdlibType GetDefaultCXXStdlibType() const override;
790 void AddClangCXXStdlibIncludeArgs(
791 const llvm::opt::ArgList &DriverArgs,
792 llvm::opt::ArgStringList &CC1Args) const override;
793 bool IsUnwindTablesDefault() const override { return true; }
796 Tool *buildAssembler() const override;
797 Tool *buildLinker() const override;
800 class LLVM_LIBRARY_VISIBILITY Minix : public Generic_ELF {
802 Minix(const Driver &D, const llvm::Triple &Triple,
803 const llvm::opt::ArgList &Args);
806 Tool *buildAssembler() const override;
807 Tool *buildLinker() const override;
810 class LLVM_LIBRARY_VISIBILITY DragonFly : public Generic_ELF {
812 DragonFly(const Driver &D, const llvm::Triple &Triple,
813 const llvm::opt::ArgList &Args);
815 bool IsMathErrnoDefault() const override { return false; }
818 Tool *buildAssembler() const override;
819 Tool *buildLinker() const override;
822 class LLVM_LIBRARY_VISIBILITY Linux : public Generic_ELF {
824 Linux(const Driver &D, const llvm::Triple &Triple,
825 const llvm::opt::ArgList &Args);
827 bool HasNativeLLVMSupport() const override;
830 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
831 llvm::opt::ArgStringList &CC1Args) const override;
832 void AddClangCXXStdlibIncludeArgs(
833 const llvm::opt::ArgList &DriverArgs,
834 llvm::opt::ArgStringList &CC1Args) const override;
835 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
836 llvm::opt::ArgStringList &CC1Args) const override;
837 void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
838 llvm::opt::ArgStringList &CC1Args) const override;
839 bool isPIEDefault() const override;
840 SanitizerMask getSupportedSanitizers() const override;
841 void addProfileRTLibs(const llvm::opt::ArgList &Args,
842 llvm::opt::ArgStringList &CmdArgs) const override;
843 virtual std::string computeSysRoot() const;
845 virtual std::string getDynamicLinker(const llvm::opt::ArgList &Args) const;
847 std::vector<std::string> ExtraOpts;
850 Tool *buildAssembler() const override;
851 Tool *buildLinker() const override;
854 class LLVM_LIBRARY_VISIBILITY CudaToolChain : public Linux {
856 CudaToolChain(const Driver &D, const llvm::Triple &Triple,
857 const llvm::opt::ArgList &Args);
859 llvm::opt::DerivedArgList *
860 TranslateArgs(const llvm::opt::DerivedArgList &Args,
861 const char *BoundArch) const override;
862 void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
863 llvm::opt::ArgStringList &CC1Args) const override;
865 // Never try to use the integrated assembler with CUDA; always fork out to
867 bool useIntegratedAs() const override { return false; }
869 void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
870 llvm::opt::ArgStringList &CC1Args) const override;
872 const Generic_GCC::CudaInstallationDetector &cudaInstallation() const {
873 return CudaInstallation;
875 Generic_GCC::CudaInstallationDetector &cudaInstallation() {
876 return CudaInstallation;
880 Tool *buildAssembler() const override; // ptxas
881 Tool *buildLinker() const override; // fatbinary (ok, not really a linker)
884 class LLVM_LIBRARY_VISIBILITY MipsLLVMToolChain : public Linux {
886 Tool *buildLinker() const override;
889 MipsLLVMToolChain(const Driver &D, const llvm::Triple &Triple,
890 const llvm::opt::ArgList &Args);
893 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
894 llvm::opt::ArgStringList &CC1Args) const override;
896 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
898 void AddClangCXXStdlibIncludeArgs(
899 const llvm::opt::ArgList &DriverArgs,
900 llvm::opt::ArgStringList &CC1Args) const override;
902 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
903 llvm::opt::ArgStringList &CmdArgs) const override;
905 std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component,
906 bool Shared = false) const override;
908 std::string computeSysRoot() const override;
910 RuntimeLibType GetDefaultRuntimeLibType() const override {
911 return GCCInstallation.isValid() ? RuntimeLibType::RLT_Libgcc
912 : RuntimeLibType::RLT_CompilerRT;
916 Multilib SelectedMultilib;
917 std::string LibSuffix;
920 class LLVM_LIBRARY_VISIBILITY LanaiToolChain : public Generic_ELF {
922 LanaiToolChain(const Driver &D, const llvm::Triple &Triple,
923 const llvm::opt::ArgList &Args)
924 : Generic_ELF(D, Triple, Args) {}
925 bool IsIntegratedAssemblerDefault() const override { return true; }
928 class LLVM_LIBRARY_VISIBILITY HexagonToolChain : public Linux {
930 GCCVersion GCCLibAndIncVersion;
931 Tool *buildAssembler() const override;
932 Tool *buildLinker() const override;
935 HexagonToolChain(const Driver &D, const llvm::Triple &Triple,
936 const llvm::opt::ArgList &Args);
937 ~HexagonToolChain() override;
940 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
941 llvm::opt::ArgStringList &CC1Args) const override;
942 void AddClangCXXStdlibIncludeArgs(
943 const llvm::opt::ArgList &DriverArgs,
944 llvm::opt::ArgStringList &CC1Args) const override;
945 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
947 StringRef GetGCCLibAndIncVersion() const { return GCCLibAndIncVersion.Text; }
948 bool IsIntegratedAssemblerDefault() const override {
952 std::string getHexagonTargetDir(
953 const std::string &InstalledDir,
954 const SmallVectorImpl<std::string> &PrefixDirs) const;
955 void getHexagonLibraryPaths(const llvm::opt::ArgList &Args,
956 ToolChain::path_list &LibPaths) const;
958 static const StringRef GetDefaultCPU();
959 static const StringRef GetTargetCPUVersion(const llvm::opt::ArgList &Args);
961 static Optional<unsigned> getSmallDataThreshold(
962 const llvm::opt::ArgList &Args);
965 class LLVM_LIBRARY_VISIBILITY AMDGPUToolChain : public Generic_ELF {
967 Tool *buildLinker() const override;
970 AMDGPUToolChain(const Driver &D, const llvm::Triple &Triple,
971 const llvm::opt::ArgList &Args);
972 unsigned GetDefaultDwarfVersion() const override { return 2; }
973 bool IsIntegratedAssemblerDefault() const override { return true; }
976 class LLVM_LIBRARY_VISIBILITY NaClToolChain : public Generic_ELF {
978 NaClToolChain(const Driver &D, const llvm::Triple &Triple,
979 const llvm::opt::ArgList &Args);
982 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
983 llvm::opt::ArgStringList &CC1Args) const override;
984 void AddClangCXXStdlibIncludeArgs(
985 const llvm::opt::ArgList &DriverArgs,
986 llvm::opt::ArgStringList &CC1Args) const override;
988 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
990 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
991 llvm::opt::ArgStringList &CmdArgs) const override;
993 bool IsIntegratedAssemblerDefault() const override {
994 return getTriple().getArch() == llvm::Triple::mipsel;
997 // Get the path to the file containing NaCl's ARM macros.
998 // It lives in NaClToolChain because the ARMAssembler tool needs a
999 // const char * that it can pass around,
1000 const char *GetNaClArmMacrosPath() const { return NaClArmMacrosPath.c_str(); }
1002 std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,
1003 types::ID InputType) const override;
1006 Tool *buildLinker() const override;
1007 Tool *buildAssembler() const override;
1010 std::string NaClArmMacrosPath;
1013 /// TCEToolChain - A tool chain using the llvm bitcode tools to perform
1014 /// all subcommands. See http://tce.cs.tut.fi for our peculiar target.
1015 class LLVM_LIBRARY_VISIBILITY TCEToolChain : public ToolChain {
1017 TCEToolChain(const Driver &D, const llvm::Triple &Triple,
1018 const llvm::opt::ArgList &Args);
1019 ~TCEToolChain() override;
1021 bool IsMathErrnoDefault() const override;
1022 bool isPICDefault() const override;
1023 bool isPIEDefault() const override;
1024 bool isPICDefaultForced() const override;
1027 class LLVM_LIBRARY_VISIBILITY MSVCToolChain : public ToolChain {
1029 MSVCToolChain(const Driver &D, const llvm::Triple &Triple,
1030 const llvm::opt::ArgList &Args);
1032 llvm::opt::DerivedArgList *
1033 TranslateArgs(const llvm::opt::DerivedArgList &Args,
1034 const char *BoundArch) const override;
1036 bool IsIntegratedAssemblerDefault() const override;
1037 bool IsUnwindTablesDefault() const override;
1038 bool isPICDefault() const override;
1039 bool isPIEDefault() const override;
1040 bool isPICDefaultForced() const override;
1043 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
1044 llvm::opt::ArgStringList &CC1Args) const override;
1045 void AddClangCXXStdlibIncludeArgs(
1046 const llvm::opt::ArgList &DriverArgs,
1047 llvm::opt::ArgStringList &CC1Args) const override;
1049 bool getWindowsSDKDir(std::string &path, int &major,
1050 std::string &windowsSDKIncludeVersion,
1051 std::string &windowsSDKLibVersion) const;
1052 bool getWindowsSDKLibraryPath(std::string &path) const;
1053 /// \brief Check if Universal CRT should be used if available
1054 bool useUniversalCRT(std::string &visualStudioDir) const;
1055 bool getUniversalCRTSdkDir(std::string &path, std::string &ucrtVersion) const;
1056 bool getUniversalCRTLibraryPath(std::string &path) const;
1057 bool getVisualStudioInstallDir(std::string &path) const;
1058 bool getVisualStudioBinariesFolder(const char *clangProgramPath,
1059 std::string &path) const;
1060 VersionTuple getMSVCVersionFromExe() const override;
1062 std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args,
1063 types::ID InputType) const override;
1064 SanitizerMask getSupportedSanitizers() const override;
1067 void AddSystemIncludeWithSubfolder(const llvm::opt::ArgList &DriverArgs,
1068 llvm::opt::ArgStringList &CC1Args,
1069 const std::string &folder,
1070 const Twine &subfolder1,
1071 const Twine &subfolder2 = "",
1072 const Twine &subfolder3 = "") const;
1074 Tool *buildLinker() const override;
1075 Tool *buildAssembler() const override;
1078 class LLVM_LIBRARY_VISIBILITY CrossWindowsToolChain : public Generic_GCC {
1080 CrossWindowsToolChain(const Driver &D, const llvm::Triple &T,
1081 const llvm::opt::ArgList &Args);
1083 bool IsIntegratedAssemblerDefault() const override { return true; }
1084 bool IsUnwindTablesDefault() const override;
1085 bool isPICDefault() const override;
1086 bool isPIEDefault() const override;
1087 bool isPICDefaultForced() const override;
1089 unsigned int GetDefaultStackProtectorLevel(bool KernelOrKext) const override {
1094 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
1095 llvm::opt::ArgStringList &CC1Args) const override;
1096 void AddClangCXXStdlibIncludeArgs(
1097 const llvm::opt::ArgList &DriverArgs,
1098 llvm::opt::ArgStringList &CC1Args) const override;
1099 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
1100 llvm::opt::ArgStringList &CmdArgs) const override;
1102 SanitizerMask getSupportedSanitizers() const override;
1105 Tool *buildLinker() const override;
1106 Tool *buildAssembler() const override;
1109 class LLVM_LIBRARY_VISIBILITY XCoreToolChain : public ToolChain {
1111 XCoreToolChain(const Driver &D, const llvm::Triple &Triple,
1112 const llvm::opt::ArgList &Args);
1115 Tool *buildAssembler() const override;
1116 Tool *buildLinker() const override;
1119 bool isPICDefault() const override;
1120 bool isPIEDefault() const override;
1121 bool isPICDefaultForced() const override;
1122 bool SupportsProfiling() const override;
1123 bool hasBlocksRuntime() const override;
1125 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
1126 llvm::opt::ArgStringList &CC1Args) const override;
1127 void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
1128 llvm::opt::ArgStringList &CC1Args) const override;
1129 void AddClangCXXStdlibIncludeArgs(
1130 const llvm::opt::ArgList &DriverArgs,
1131 llvm::opt::ArgStringList &CC1Args) const override;
1132 void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
1133 llvm::opt::ArgStringList &CmdArgs) const override;
1136 /// MyriadToolChain - A tool chain using either clang or the external compiler
1137 /// installed by the Movidius SDK to perform all subcommands.
1138 class LLVM_LIBRARY_VISIBILITY MyriadToolChain : public Generic_ELF {
1140 MyriadToolChain(const Driver &D, const llvm::Triple &Triple,
1141 const llvm::opt::ArgList &Args);
1142 ~MyriadToolChain() override;
1145 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
1146 llvm::opt::ArgStringList &CC1Args) const override;
1147 void AddClangCXXStdlibIncludeArgs(
1148 const llvm::opt::ArgList &DriverArgs,
1149 llvm::opt::ArgStringList &CC1Args) const override;
1150 Tool *SelectTool(const JobAction &JA) const override;
1151 unsigned GetDefaultDwarfVersion() const override { return 2; }
1154 Tool *buildLinker() const override;
1155 bool isShaveCompilation(const llvm::Triple &T) const {
1156 return T.getArch() == llvm::Triple::shave;
1160 mutable std::unique_ptr<Tool> Compiler;
1161 mutable std::unique_ptr<Tool> Assembler;
1164 class LLVM_LIBRARY_VISIBILITY WebAssembly final : public ToolChain {
1166 WebAssembly(const Driver &D, const llvm::Triple &Triple,
1167 const llvm::opt::ArgList &Args);
1170 bool IsMathErrnoDefault() const override;
1171 bool IsObjCNonFragileABIDefault() const override;
1172 bool UseObjCMixedDispatch() const override;
1173 bool isPICDefault() const override;
1174 bool isPIEDefault() const override;
1175 bool isPICDefaultForced() const override;
1176 bool IsIntegratedAssemblerDefault() const override;
1177 bool hasBlocksRuntime() const override;
1178 bool SupportsObjCGC() const override;
1179 bool SupportsProfiling() const override;
1180 bool HasNativeLLVMSupport() const override;
1181 void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
1182 llvm::opt::ArgStringList &CC1Args) const override;
1183 RuntimeLibType GetDefaultRuntimeLibType() const override;
1184 CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
1185 void AddClangSystemIncludeArgs(
1186 const llvm::opt::ArgList &DriverArgs,
1187 llvm::opt::ArgStringList &CC1Args) const override;
1188 void AddClangCXXStdlibIncludeArgs(
1189 const llvm::opt::ArgList &DriverArgs,
1190 llvm::opt::ArgStringList &CC1Args) const override;
1192 Tool *buildLinker() const override;
1195 class LLVM_LIBRARY_VISIBILITY PS4CPU : public Generic_ELF {
1197 PS4CPU(const Driver &D, const llvm::Triple &Triple,
1198 const llvm::opt::ArgList &Args);
1200 bool IsMathErrnoDefault() const override { return false; }
1201 bool IsObjCNonFragileABIDefault() const override { return true; }
1202 bool HasNativeLLVMSupport() const override;
1203 bool isPICDefault() const override;
1205 unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const override {
1206 return 2; // SSPStrong
1209 llvm::DebuggerKind getDefaultDebuggerTuning() const override {
1210 return llvm::DebuggerKind::SCE;
1213 SanitizerMask getSupportedSanitizers() const override;
1216 Tool *buildAssembler() const override;
1217 Tool *buildLinker() const override;
1220 } // end namespace toolchains
1221 } // end namespace driver
1222 } // end namespace clang
1224 #endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_H