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;
49 /// ToolChain - Access to tools for a single platform.
52 typedef SmallVector<std::string, 16> path_list;
67 RM_DisabledExplicitly,
73 const llvm::Triple Triple;
74 const llvm::opt::ArgList &Args;
75 // We need to initialize CachedRTTIArg before CachedRTTIMode
76 const llvm::opt::Arg *const CachedRTTIArg;
77 const RTTIMode CachedRTTIMode;
79 /// The list of toolchain specific path prefixes to search for
83 /// The list of toolchain specific path prefixes to search for
85 path_list ProgramPaths;
87 mutable std::unique_ptr<Tool> Clang;
88 mutable std::unique_ptr<Tool> Assemble;
89 mutable std::unique_ptr<Tool> Link;
90 mutable std::unique_ptr<Tool> OffloadBundler;
91 Tool *getClang() const;
92 Tool *getAssemble() const;
93 Tool *getLink() const;
94 Tool *getClangAs() const;
95 Tool *getOffloadBundler() const;
97 mutable std::unique_ptr<SanitizerArgs> SanitizerArguments;
98 mutable std::unique_ptr<XRayArgs> XRayArguments;
100 /// The effective clang triple for the current Job.
101 mutable llvm::Triple EffectiveTriple;
103 /// Set the toolchain's effective clang triple.
104 void setEffectiveTriple(llvm::Triple ET) const {
105 EffectiveTriple = std::move(ET);
108 friend class RegisterEffectiveTriple;
111 MultilibSet Multilibs;
113 ToolChain(const Driver &D, const llvm::Triple &T,
114 const llvm::opt::ArgList &Args);
116 virtual Tool *buildAssembler() const;
117 virtual Tool *buildLinker() const;
118 virtual Tool *getTool(Action::ActionClass AC) const;
120 /// \name Utilities for implementing subclasses.
122 static void addSystemInclude(const llvm::opt::ArgList &DriverArgs,
123 llvm::opt::ArgStringList &CC1Args,
125 static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs,
126 llvm::opt::ArgStringList &CC1Args,
129 addExternCSystemIncludeIfExists(const llvm::opt::ArgList &DriverArgs,
130 llvm::opt::ArgStringList &CC1Args,
132 static void addSystemIncludes(const llvm::opt::ArgList &DriverArgs,
133 llvm::opt::ArgStringList &CC1Args,
134 ArrayRef<StringRef> Paths);
138 virtual ~ToolChain();
142 const Driver &getDriver() const { return D; }
143 vfs::FileSystem &getVFS() const;
144 const llvm::Triple &getTriple() const { return Triple; }
146 /// Get the toolchain's aux triple, if it has one.
148 /// Exactly what the aux triple represents depends on the toolchain, but for
149 /// example when compiling CUDA code for the GPU, the triple might be NVPTX,
150 /// while the aux triple is the host (CPU) toolchain, e.g. x86-linux-gnu.
151 virtual const llvm::Triple *getAuxTriple() const { return nullptr; }
153 llvm::Triple::ArchType getArch() const { return Triple.getArch(); }
154 StringRef getArchName() const { return Triple.getArchName(); }
155 StringRef getPlatform() const { return Triple.getVendorName(); }
156 StringRef getOS() const { return Triple.getOSName(); }
158 /// \brief Provide the default architecture name (as expected by -arch) for
160 StringRef getDefaultUniversalArchName() const;
162 std::string getTripleString() const {
163 return Triple.getTriple();
166 /// Get the toolchain's effective clang triple.
167 const llvm::Triple &getEffectiveTriple() const {
168 assert(!EffectiveTriple.getTriple().empty() && "No effective triple");
169 return EffectiveTriple;
172 path_list &getFilePaths() { return FilePaths; }
173 const path_list &getFilePaths() const { return FilePaths; }
175 path_list &getProgramPaths() { return ProgramPaths; }
176 const path_list &getProgramPaths() const { return ProgramPaths; }
178 const MultilibSet &getMultilibs() const { return Multilibs; }
180 const SanitizerArgs& getSanitizerArgs() const;
182 const XRayArgs& getXRayArgs() const;
184 // Returns the Arg * that explicitly turned on/off rtti, or nullptr.
185 const llvm::opt::Arg *getRTTIArg() const { return CachedRTTIArg; }
187 // Returns the RTTIMode for the toolchain with the current arguments.
188 RTTIMode getRTTIMode() const { return CachedRTTIMode; }
190 /// \brief Return any implicit target and/or mode flag for an invocation of
191 /// the compiler driver as `ProgName`.
193 /// For example, when called with i686-linux-android-g++, the first element
194 /// of the return value will be set to `"i686-linux-android"` and the second
195 /// will be set to "--driver-mode=g++"`.
197 /// \pre `llvm::InitializeAllTargets()` has been called.
198 /// \param ProgName The name the Clang driver was invoked with (from,
200 /// \return A pair of (`target`, `mode-flag`), where one or both may be empty.
201 static std::pair<std::string, std::string>
202 getTargetAndModeFromProgramName(StringRef ProgName);
206 /// TranslateArgs - Create a new derived argument list for any argument
207 /// translations this ToolChain may wish to perform, or 0 if no tool chain
208 /// specific translations are needed. If \p DeviceOffloadKind is specified
209 /// the translation specific for that offload kind is performed.
211 /// \param BoundArch - The bound architecture name, or 0.
212 /// \param DeviceOffloadKind - The device offload kind used for the
214 virtual llvm::opt::DerivedArgList *
215 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
216 Action::OffloadKind DeviceOffloadKind) const {
220 /// Choose a tool to use to handle the action \p JA.
222 /// This can be overridden when a particular ToolChain needs to use
223 /// a compiler other than Clang.
224 virtual Tool *SelectTool(const JobAction &JA) const;
228 std::string GetFilePath(const char *Name) const;
229 std::string GetProgramPath(const char *Name) const;
231 /// Returns the linker path, respecting the -fuse-ld= argument to determine
232 /// the linker suffix or name.
233 std::string GetLinkerPath() const;
235 /// \brief Dispatch to the specific toolchain for verbose printing.
237 /// This is used when handling the verbose option to print detailed,
238 /// toolchain-specific information useful for understanding the behavior of
239 /// the driver on a specific platform.
240 virtual void printVerboseInfo(raw_ostream &OS) const {}
242 // Platform defaults information
244 /// \brief Returns true if the toolchain is targeting a non-native
246 virtual bool isCrossCompiling() const;
248 /// HasNativeLTOLinker - Check whether the linker and related tools have
249 /// native LLVM support.
250 virtual bool HasNativeLLVMSupport() const;
252 /// LookupTypeForExtension - Return the default language type to use for the
254 virtual types::ID LookupTypeForExtension(StringRef Ext) const;
256 /// IsBlocksDefault - Does this tool chain enable -fblocks by default.
257 virtual bool IsBlocksDefault() const { return false; }
259 /// IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as
261 virtual bool IsIntegratedAssemblerDefault() const { return false; }
263 /// \brief Check if the toolchain should use the integrated assembler.
264 virtual bool useIntegratedAs() const;
266 /// IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.
267 virtual bool IsMathErrnoDefault() const { return true; }
269 /// IsEncodeExtendedBlockSignatureDefault - Does this tool chain enable
270 /// -fencode-extended-block-signature by default.
271 virtual bool IsEncodeExtendedBlockSignatureDefault() const { return false; }
273 /// IsObjCNonFragileABIDefault - Does this tool chain set
274 /// -fobjc-nonfragile-abi by default.
275 virtual bool IsObjCNonFragileABIDefault() const { return false; }
277 /// UseObjCMixedDispatchDefault - When using non-legacy dispatch, should the
278 /// mixed dispatch method be used?
279 virtual bool UseObjCMixedDispatch() const { return false; }
281 /// GetDefaultStackProtectorLevel - Get the default stack protector level for
282 /// this tool chain (0=off, 1=on, 2=strong, 3=all).
283 virtual unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const {
287 /// GetDefaultLinker - Get the default linker to use.
288 virtual const char *getDefaultLinker() const {
292 /// GetDefaultRuntimeLibType - Get the default runtime library variant to use.
293 virtual RuntimeLibType GetDefaultRuntimeLibType() const {
294 return ToolChain::RLT_Libgcc;
297 virtual CXXStdlibType GetDefaultCXXStdlibType() const {
298 return ToolChain::CST_Libstdcxx;
301 virtual std::string getCompilerRT(const llvm::opt::ArgList &Args,
303 bool Shared = false) const;
305 const char *getCompilerRTArgString(const llvm::opt::ArgList &Args,
307 bool Shared = false) const;
309 // Returns <ResourceDir>/lib/<OSName>/<arch>. This is used by runtimes (such
310 // as OpenMP) to find arch-specific libraries.
311 std::string getArchSpecificLibPath() const;
313 /// needsProfileRT - returns true if instrumentation profile is on.
314 static bool needsProfileRT(const llvm::opt::ArgList &Args);
316 /// IsUnwindTablesDefault - Does this tool chain use -funwind-tables
318 virtual bool IsUnwindTablesDefault() const;
320 /// \brief Test whether this toolchain defaults to PIC.
321 virtual bool isPICDefault() const = 0;
323 /// \brief Test whether this toolchain defaults to PIE.
324 virtual bool isPIEDefault() const = 0;
326 /// \brief Tests whether this toolchain forces its default for PIC, PIE or
327 /// non-PIC. If this returns true, any PIC related flags should be ignored
328 /// and instead the results of \c isPICDefault() and \c isPIEDefault() are
329 /// used exclusively.
330 virtual bool isPICDefaultForced() const = 0;
332 /// SupportsProfiling - Does this tool chain support -pg.
333 virtual bool SupportsProfiling() const { return true; }
335 /// Does this tool chain support Objective-C garbage collection.
336 virtual bool SupportsObjCGC() const { return true; }
338 /// Complain if this tool chain doesn't support Objective-C ARC.
339 virtual void CheckObjCARC() const {}
341 /// UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf
342 /// compile unit information.
343 virtual bool UseDwarfDebugFlags() const { return false; }
345 // Return the DWARF version to emit, in the absence of arguments
347 virtual unsigned GetDefaultDwarfVersion() const { return 4; }
349 // True if the driver should assume "-fstandalone-debug"
350 // in the absence of an option specifying otherwise,
351 // provided that debugging was requested in the first place.
352 // i.e. a value of 'true' does not imply that debugging is wanted.
353 virtual bool GetDefaultStandaloneDebug() const { return false; }
355 // Return the default debugger "tuning."
356 virtual llvm::DebuggerKind getDefaultDebuggerTuning() const {
357 return llvm::DebuggerKind::GDB;
360 /// UseSjLjExceptions - Does this tool chain use SjLj exceptions.
361 virtual bool UseSjLjExceptions(const llvm::opt::ArgList &Args) const {
365 /// SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode.
366 virtual bool SupportsEmbeddedBitcode() const {
370 /// getThreadModel() - Which thread model does this target use?
371 virtual std::string getThreadModel() const { return "posix"; }
373 /// isThreadModelSupported() - Does this target support a thread model?
374 virtual bool isThreadModelSupported(const StringRef Model) const;
376 /// ComputeLLVMTriple - Return the LLVM target triple to use, after taking
377 /// command line arguments into account.
379 ComputeLLVMTriple(const llvm::opt::ArgList &Args,
380 types::ID InputType = types::TY_INVALID) const;
382 /// ComputeEffectiveClangTriple - Return the Clang triple to use for this
383 /// target, which may take into account the command line arguments. For
384 /// example, on Darwin the -mmacosx-version-min= command line argument (which
385 /// sets the deployment target) determines the version in the triple passed to
387 virtual std::string ComputeEffectiveClangTriple(
388 const llvm::opt::ArgList &Args,
389 types::ID InputType = types::TY_INVALID) const;
391 /// getDefaultObjCRuntime - Return the default Objective-C runtime
392 /// for this platform.
394 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
395 virtual ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const;
397 /// hasBlocksRuntime - Given that the user is compiling with
398 /// -fblocks, does this tool chain guarantee the existence of a
401 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
402 virtual bool hasBlocksRuntime() const { return true; }
404 /// \brief Add the clang cc1 arguments for system include paths.
406 /// This routine is responsible for adding the necessary cc1 arguments to
407 /// include headers from standard system header directories.
409 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
410 llvm::opt::ArgStringList &CC1Args) const;
412 /// \brief Add options that need to be passed to cc1 for this target.
413 virtual void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
414 llvm::opt::ArgStringList &CC1Args) const;
416 /// \brief Add warning options that need to be passed to cc1 for this target.
417 virtual void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const;
419 // GetRuntimeLibType - Determine the runtime library type to use with the
420 // given compilation arguments.
421 virtual RuntimeLibType
422 GetRuntimeLibType(const llvm::opt::ArgList &Args) const;
424 // GetCXXStdlibType - Determine the C++ standard library type to use with the
425 // given compilation arguments.
426 virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const;
428 /// AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set
429 /// the include paths to use for the given C++ standard library type.
431 AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs,
432 llvm::opt::ArgStringList &CC1Args) const;
434 /// AddCXXStdlibLibArgs - Add the system specific linker arguments to use
435 /// for the given C++ standard library type.
436 virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
437 llvm::opt::ArgStringList &CmdArgs) const;
439 /// AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
440 void AddFilePathLibArgs(const llvm::opt::ArgList &Args,
441 llvm::opt::ArgStringList &CmdArgs) const;
443 /// AddCCKextLibArgs - Add the system specific linker arguments to use
444 /// for kernel extensions (Darwin-specific).
445 virtual void AddCCKextLibArgs(const llvm::opt::ArgList &Args,
446 llvm::opt::ArgStringList &CmdArgs) const;
448 /// AddFastMathRuntimeIfAvailable - If a runtime library exists that sets
449 /// global flags for unsafe floating point math, add it and return true.
451 /// This checks for presence of the -Ofast, -ffast-math or -funsafe-math flags.
452 virtual bool AddFastMathRuntimeIfAvailable(
453 const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const;
454 /// addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass
455 /// a suitable profile runtime library to the linker.
456 virtual void addProfileRTLibs(const llvm::opt::ArgList &Args,
457 llvm::opt::ArgStringList &CmdArgs) const;
459 /// \brief Add arguments to use system-specific CUDA includes.
460 virtual void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
461 llvm::opt::ArgStringList &CC1Args) const;
463 /// \brief Add arguments to use MCU GCC toolchain includes.
464 virtual void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
465 llvm::opt::ArgStringList &CC1Args) const;
467 /// \brief On Windows, returns the MSVC compatibility version.
468 virtual VersionTuple computeMSVCVersion(const Driver *D,
469 const llvm::opt::ArgList &Args) const;
471 /// \brief Return sanitizers which are available in this toolchain.
472 virtual SanitizerMask getSupportedSanitizers() const;
474 /// \brief Return sanitizers which are enabled by default.
475 virtual SanitizerMask getDefaultSanitizers() const { return 0; }
478 /// Set a ToolChain's effective triple. Reset it when the registration object
480 class RegisterEffectiveTriple {
484 RegisterEffectiveTriple(const ToolChain &TC, llvm::Triple T) : TC(TC) {
485 TC.setEffectiveTriple(std::move(T));
488 ~RegisterEffectiveTriple() { TC.setEffectiveTriple(llvm::Triple()); }
491 } // end namespace driver
492 } // end namespace clang