1 //===--- ToolChain.h - Collections of tools for one platform ----*- 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_DRIVER_TOOLCHAIN_H
11 #define LLVM_CLANG_DRIVER_TOOLCHAIN_H
13 #include "clang/Basic/Sanitizers.h"
14 #include "clang/Basic/VersionTuple.h"
15 #include "clang/Driver/Action.h"
16 #include "clang/Driver/Multilib.h"
17 #include "clang/Driver/Types.h"
18 #include "clang/Driver/Util.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/Target/TargetOptions.h"
41 class CudaInstallationDetector;
44 class RegisterEffectiveTriple;
48 /// ToolChain - Access to tools for a single platform.
51 typedef SmallVector<std::string, 16> path_list;
66 RM_DisabledExplicitly,
72 const llvm::Triple Triple;
73 const llvm::opt::ArgList &Args;
74 // We need to initialize CachedRTTIArg before CachedRTTIMode
75 const llvm::opt::Arg *const CachedRTTIArg;
76 const RTTIMode CachedRTTIMode;
78 /// The list of toolchain specific path prefixes to search for
82 /// The list of toolchain specific path prefixes to search for
84 path_list ProgramPaths;
86 mutable std::unique_ptr<Tool> Clang;
87 mutable std::unique_ptr<Tool> Assemble;
88 mutable std::unique_ptr<Tool> Link;
89 mutable std::unique_ptr<Tool> OffloadBundler;
90 Tool *getClang() const;
91 Tool *getAssemble() const;
92 Tool *getLink() const;
93 Tool *getClangAs() const;
94 Tool *getOffloadBundler() const;
96 mutable std::unique_ptr<SanitizerArgs> SanitizerArguments;
98 /// The effective clang triple for the current Job.
99 mutable llvm::Triple EffectiveTriple;
101 /// Set the toolchain's effective clang triple.
102 void setEffectiveTriple(llvm::Triple ET) const { EffectiveTriple = ET; }
104 friend class RegisterEffectiveTriple;
107 MultilibSet Multilibs;
109 ToolChain(const Driver &D, const llvm::Triple &T,
110 const llvm::opt::ArgList &Args);
112 virtual Tool *buildAssembler() const;
113 virtual Tool *buildLinker() const;
114 virtual Tool *getTool(Action::ActionClass AC) const;
116 /// \name Utilities for implementing subclasses.
118 static void addSystemInclude(const llvm::opt::ArgList &DriverArgs,
119 llvm::opt::ArgStringList &CC1Args,
121 static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs,
122 llvm::opt::ArgStringList &CC1Args,
125 addExternCSystemIncludeIfExists(const llvm::opt::ArgList &DriverArgs,
126 llvm::opt::ArgStringList &CC1Args,
128 static void addSystemIncludes(const llvm::opt::ArgList &DriverArgs,
129 llvm::opt::ArgStringList &CC1Args,
130 ArrayRef<StringRef> Paths);
134 virtual ~ToolChain();
138 const Driver &getDriver() const { return D; }
139 vfs::FileSystem &getVFS() const;
140 const llvm::Triple &getTriple() const { return Triple; }
142 /// Get the toolchain's aux triple, if it has one.
144 /// Exactly what the aux triple represents depends on the toolchain, but for
145 /// example when compiling CUDA code for the GPU, the triple might be NVPTX,
146 /// while the aux triple is the host (CPU) toolchain, e.g. x86-linux-gnu.
147 virtual const llvm::Triple *getAuxTriple() const { return nullptr; }
149 llvm::Triple::ArchType getArch() const { return Triple.getArch(); }
150 StringRef getArchName() const { return Triple.getArchName(); }
151 StringRef getPlatform() const { return Triple.getVendorName(); }
152 StringRef getOS() const { return Triple.getOSName(); }
154 /// \brief Provide the default architecture name (as expected by -arch) for
156 StringRef getDefaultUniversalArchName() const;
158 std::string getTripleString() const {
159 return Triple.getTriple();
162 /// Get the toolchain's effective clang triple.
163 const llvm::Triple &getEffectiveTriple() const {
164 assert(!EffectiveTriple.getTriple().empty() && "No effective triple");
165 return EffectiveTriple;
168 path_list &getFilePaths() { return FilePaths; }
169 const path_list &getFilePaths() const { return FilePaths; }
171 path_list &getProgramPaths() { return ProgramPaths; }
172 const path_list &getProgramPaths() const { return ProgramPaths; }
174 const MultilibSet &getMultilibs() const { return Multilibs; }
176 const SanitizerArgs& getSanitizerArgs() const;
178 // Returns the Arg * that explicitly turned on/off rtti, or nullptr.
179 const llvm::opt::Arg *getRTTIArg() const { return CachedRTTIArg; }
181 // Returns the RTTIMode for the toolchain with the current arguments.
182 RTTIMode getRTTIMode() const { return CachedRTTIMode; }
184 /// \brief Return any implicit target and/or mode flag for an invocation of
185 /// the compiler driver as `ProgName`.
187 /// For example, when called with i686-linux-android-g++, the first element
188 /// of the return value will be set to `"i686-linux-android"` and the second
189 /// will be set to "--driver-mode=g++"`.
191 /// \pre `llvm::InitializeAllTargets()` has been called.
192 /// \param ProgName The name the Clang driver was invoked with (from,
194 /// \return A pair of (`target`, `mode-flag`), where one or both may be empty.
195 static std::pair<std::string, std::string>
196 getTargetAndModeFromProgramName(StringRef ProgName);
200 /// TranslateArgs - Create a new derived argument list for any argument
201 /// translations this ToolChain may wish to perform, or 0 if no tool chain
202 /// specific translations are needed. If \p DeviceOffloadKind is specified
203 /// the translation specific for that offload kind is performed.
205 /// \param BoundArch - The bound architecture name, or 0.
206 /// \param DeviceOffloadKind - The device offload kind used for the
208 virtual llvm::opt::DerivedArgList *
209 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
210 Action::OffloadKind DeviceOffloadKind) const {
214 /// Choose a tool to use to handle the action \p JA.
216 /// This can be overridden when a particular ToolChain needs to use
217 /// a compiler other than Clang.
218 virtual Tool *SelectTool(const JobAction &JA) const;
222 std::string GetFilePath(const char *Name) const;
223 std::string GetProgramPath(const char *Name) const;
225 /// Returns the linker path, respecting the -fuse-ld= argument to determine
226 /// the linker suffix or name.
227 std::string GetLinkerPath() const;
229 /// \brief Dispatch to the specific toolchain for verbose printing.
231 /// This is used when handling the verbose option to print detailed,
232 /// toolchain-specific information useful for understanding the behavior of
233 /// the driver on a specific platform.
234 virtual void printVerboseInfo(raw_ostream &OS) const {}
236 // Platform defaults information
238 /// \brief Returns true if the toolchain is targeting a non-native
240 virtual bool isCrossCompiling() const;
242 /// HasNativeLTOLinker - Check whether the linker and related tools have
243 /// native LLVM support.
244 virtual bool HasNativeLLVMSupport() const;
246 /// LookupTypeForExtension - Return the default language type to use for the
248 virtual types::ID LookupTypeForExtension(StringRef Ext) const;
250 /// IsBlocksDefault - Does this tool chain enable -fblocks by default.
251 virtual bool IsBlocksDefault() const { return false; }
253 /// IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as
255 virtual bool IsIntegratedAssemblerDefault() const { return false; }
257 /// \brief Check if the toolchain should use the integrated assembler.
258 virtual bool useIntegratedAs() const;
260 /// IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.
261 virtual bool IsMathErrnoDefault() const { return true; }
263 /// IsEncodeExtendedBlockSignatureDefault - Does this tool chain enable
264 /// -fencode-extended-block-signature by default.
265 virtual bool IsEncodeExtendedBlockSignatureDefault() const { return false; }
267 /// IsObjCNonFragileABIDefault - Does this tool chain set
268 /// -fobjc-nonfragile-abi by default.
269 virtual bool IsObjCNonFragileABIDefault() const { return false; }
271 /// UseObjCMixedDispatchDefault - When using non-legacy dispatch, should the
272 /// mixed dispatch method be used?
273 virtual bool UseObjCMixedDispatch() const { return false; }
275 /// GetDefaultStackProtectorLevel - Get the default stack protector level for
276 /// this tool chain (0=off, 1=on, 2=strong, 3=all).
277 virtual unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const {
281 /// GetDefaultLinker - Get the default linker to use.
282 virtual const char *getDefaultLinker() const {
286 /// GetDefaultRuntimeLibType - Get the default runtime library variant to use.
287 virtual RuntimeLibType GetDefaultRuntimeLibType() const {
288 return ToolChain::RLT_Libgcc;
291 virtual CXXStdlibType GetDefaultCXXStdlibType() const {
292 return ToolChain::CST_Libstdcxx;
295 virtual std::string getCompilerRT(const llvm::opt::ArgList &Args,
297 bool Shared = false) const;
299 const char *getCompilerRTArgString(const llvm::opt::ArgList &Args,
301 bool Shared = false) const;
302 /// needsProfileRT - returns true if instrumentation profile is on.
303 static bool needsProfileRT(const llvm::opt::ArgList &Args);
305 /// IsUnwindTablesDefault - Does this tool chain use -funwind-tables
307 virtual bool IsUnwindTablesDefault() const;
309 /// \brief Test whether this toolchain defaults to PIC.
310 virtual bool isPICDefault() const = 0;
312 /// \brief Test whether this toolchain defaults to PIE.
313 virtual bool isPIEDefault() const = 0;
315 /// \brief Tests whether this toolchain forces its default for PIC, PIE or
316 /// non-PIC. If this returns true, any PIC related flags should be ignored
317 /// and instead the results of \c isPICDefault() and \c isPIEDefault() are
318 /// used exclusively.
319 virtual bool isPICDefaultForced() const = 0;
321 /// SupportsProfiling - Does this tool chain support -pg.
322 virtual bool SupportsProfiling() const { return true; }
324 /// Does this tool chain support Objective-C garbage collection.
325 virtual bool SupportsObjCGC() const { return true; }
327 /// Complain if this tool chain doesn't support Objective-C ARC.
328 virtual void CheckObjCARC() const {}
330 /// UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf
331 /// compile unit information.
332 virtual bool UseDwarfDebugFlags() const { return false; }
334 // Return the DWARF version to emit, in the absence of arguments
336 virtual unsigned GetDefaultDwarfVersion() const { return 4; }
338 // True if the driver should assume "-fstandalone-debug"
339 // in the absence of an option specifying otherwise,
340 // provided that debugging was requested in the first place.
341 // i.e. a value of 'true' does not imply that debugging is wanted.
342 virtual bool GetDefaultStandaloneDebug() const { return false; }
344 // Return the default debugger "tuning."
345 virtual llvm::DebuggerKind getDefaultDebuggerTuning() const {
346 return llvm::DebuggerKind::GDB;
349 /// UseSjLjExceptions - Does this tool chain use SjLj exceptions.
350 virtual bool UseSjLjExceptions(const llvm::opt::ArgList &Args) const {
354 /// SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode.
355 virtual bool SupportsEmbeddedBitcode() const {
359 /// getThreadModel() - Which thread model does this target use?
360 virtual std::string getThreadModel() const { return "posix"; }
362 /// isThreadModelSupported() - Does this target support a thread model?
363 virtual bool isThreadModelSupported(const StringRef Model) const;
365 /// ComputeLLVMTriple - Return the LLVM target triple to use, after taking
366 /// command line arguments into account.
368 ComputeLLVMTriple(const llvm::opt::ArgList &Args,
369 types::ID InputType = types::TY_INVALID) const;
371 /// ComputeEffectiveClangTriple - Return the Clang triple to use for this
372 /// target, which may take into account the command line arguments. For
373 /// example, on Darwin the -mmacosx-version-min= command line argument (which
374 /// sets the deployment target) determines the version in the triple passed to
376 virtual std::string ComputeEffectiveClangTriple(
377 const llvm::opt::ArgList &Args,
378 types::ID InputType = types::TY_INVALID) const;
380 /// getDefaultObjCRuntime - Return the default Objective-C runtime
381 /// for this platform.
383 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
384 virtual ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const;
386 /// hasBlocksRuntime - Given that the user is compiling with
387 /// -fblocks, does this tool chain guarantee the existence of a
390 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
391 virtual bool hasBlocksRuntime() const { return true; }
393 /// \brief Add the clang cc1 arguments for system include paths.
395 /// This routine is responsible for adding the necessary cc1 arguments to
396 /// include headers from standard system header directories.
398 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
399 llvm::opt::ArgStringList &CC1Args) const;
401 /// \brief Add options that need to be passed to cc1 for this target.
402 virtual void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
403 llvm::opt::ArgStringList &CC1Args) const;
405 /// \brief Add warning options that need to be passed to cc1 for this target.
406 virtual void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const;
408 // GetRuntimeLibType - Determine the runtime library type to use with the
409 // given compilation arguments.
410 virtual RuntimeLibType
411 GetRuntimeLibType(const llvm::opt::ArgList &Args) const;
413 // GetCXXStdlibType - Determine the C++ standard library type to use with the
414 // given compilation arguments.
415 virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const;
417 /// AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set
418 /// the include paths to use for the given C++ standard library type.
420 AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs,
421 llvm::opt::ArgStringList &CC1Args) const;
423 /// AddCXXStdlibLibArgs - Add the system specific linker arguments to use
424 /// for the given C++ standard library type.
425 virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
426 llvm::opt::ArgStringList &CmdArgs) const;
428 /// AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
429 void AddFilePathLibArgs(const llvm::opt::ArgList &Args,
430 llvm::opt::ArgStringList &CmdArgs) const;
432 /// AddCCKextLibArgs - Add the system specific linker arguments to use
433 /// for kernel extensions (Darwin-specific).
434 virtual void AddCCKextLibArgs(const llvm::opt::ArgList &Args,
435 llvm::opt::ArgStringList &CmdArgs) const;
437 /// AddFastMathRuntimeIfAvailable - If a runtime library exists that sets
438 /// global flags for unsafe floating point math, add it and return true.
440 /// This checks for presence of the -Ofast, -ffast-math or -funsafe-math flags.
441 virtual bool AddFastMathRuntimeIfAvailable(
442 const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const;
443 /// addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass
444 /// a suitable profile runtime library to the linker.
445 virtual void addProfileRTLibs(const llvm::opt::ArgList &Args,
446 llvm::opt::ArgStringList &CmdArgs) const;
448 /// \brief Add arguments to use system-specific CUDA includes.
449 virtual void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
450 llvm::opt::ArgStringList &CC1Args) const;
452 /// \brief Add arguments to use MCU GCC toolchain includes.
453 virtual void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
454 llvm::opt::ArgStringList &CC1Args) const;
456 /// \brief On Windows, returns the MSVC compatibility version.
457 virtual VersionTuple computeMSVCVersion(const Driver *D,
458 const llvm::opt::ArgList &Args) const;
460 /// \brief Return sanitizers which are available in this toolchain.
461 virtual SanitizerMask getSupportedSanitizers() const;
463 /// \brief Return sanitizers which are enabled by default.
464 virtual SanitizerMask getDefaultSanitizers() const { return 0; }
467 /// Set a ToolChain's effective triple. Reset it when the registration object
469 class RegisterEffectiveTriple {
473 RegisterEffectiveTriple(const ToolChain &TC, llvm::Triple T) : TC(TC) {
474 TC.setEffectiveTriple(T);
477 ~RegisterEffectiveTriple() { TC.setEffectiveTriple(llvm::Triple()); }
480 } // end namespace driver
481 } // end namespace clang