1 //===- ToolChain.h - Collections of tools for one platform ------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_CLANG_DRIVER_TOOLCHAIN_H
10 #define LLVM_CLANG_DRIVER_TOOLCHAIN_H
12 #include "clang/Basic/DebugInfoOptions.h"
13 #include "clang/Basic/LLVM.h"
14 #include "clang/Basic/LangOptions.h"
15 #include "clang/Basic/Sanitizers.h"
16 #include "clang/Driver/Action.h"
17 #include "clang/Driver/Multilib.h"
18 #include "clang/Driver/Types.h"
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/MC/MCTargetOptions.h"
24 #include "llvm/Option/Option.h"
25 #include "llvm/Support/VersionTuple.h"
26 #include "llvm/Target/TargetOptions.h"
59 /// Helper structure used to pass information extracted from clang executable
60 /// name such as `i686-linux-android-g++`.
61 struct ParsedClangName {
62 /// Target part of the executable name, as `i686-linux-android`.
63 std::string TargetPrefix;
65 /// Driver mode part of the executable name, as `g++`.
66 std::string ModeSuffix;
68 /// Corresponding driver mode argument, as '--driver-mode=g++'
69 const char *DriverMode = nullptr;
71 /// True if TargetPrefix is recognized as a registered target name.
72 bool TargetIsValid = false;
74 ParsedClangName() = default;
75 ParsedClangName(std::string Suffix, const char *Mode)
76 : ModeSuffix(Suffix), DriverMode(Mode) {}
77 ParsedClangName(std::string Target, std::string Suffix, const char *Mode,
79 : TargetPrefix(Target), ModeSuffix(Suffix), DriverMode(Mode),
80 TargetIsValid(IsRegistered) {}
82 bool isEmpty() const {
83 return TargetPrefix.empty() && ModeSuffix.empty() && DriverMode == nullptr;
87 /// ToolChain - Access to tools for a single platform.
90 using path_list = SmallVector<std::string, 16>;
113 enum FileType { FT_Object, FT_Static, FT_Shared };
116 friend class RegisterEffectiveTriple;
120 const llvm::opt::ArgList &Args;
122 // We need to initialize CachedRTTIArg before CachedRTTIMode
123 const llvm::opt::Arg *const CachedRTTIArg;
125 const RTTIMode CachedRTTIMode;
127 /// The list of toolchain specific path prefixes to search for libraries.
128 path_list LibraryPaths;
130 /// The list of toolchain specific path prefixes to search for files.
133 /// The list of toolchain specific path prefixes to search for programs.
134 path_list ProgramPaths;
136 mutable std::unique_ptr<Tool> Clang;
137 mutable std::unique_ptr<Tool> Assemble;
138 mutable std::unique_ptr<Tool> Link;
139 mutable std::unique_ptr<Tool> OffloadBundler;
141 Tool *getClang() const;
142 Tool *getAssemble() const;
143 Tool *getLink() const;
144 Tool *getClangAs() const;
145 Tool *getOffloadBundler() const;
147 mutable std::unique_ptr<SanitizerArgs> SanitizerArguments;
148 mutable std::unique_ptr<XRayArgs> XRayArguments;
150 /// The effective clang triple for the current Job.
151 mutable llvm::Triple EffectiveTriple;
153 /// Set the toolchain's effective clang triple.
154 void setEffectiveTriple(llvm::Triple ET) const {
155 EffectiveTriple = std::move(ET);
159 MultilibSet Multilibs;
160 Multilib SelectedMultilib;
162 ToolChain(const Driver &D, const llvm::Triple &T,
163 const llvm::opt::ArgList &Args);
165 void setTripleEnvironment(llvm::Triple::EnvironmentType Env);
167 virtual Tool *buildAssembler() const;
168 virtual Tool *buildLinker() const;
169 virtual Tool *getTool(Action::ActionClass AC) const;
171 /// \name Utilities for implementing subclasses.
173 static void addSystemInclude(const llvm::opt::ArgList &DriverArgs,
174 llvm::opt::ArgStringList &CC1Args,
176 static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs,
177 llvm::opt::ArgStringList &CC1Args,
180 addExternCSystemIncludeIfExists(const llvm::opt::ArgList &DriverArgs,
181 llvm::opt::ArgStringList &CC1Args,
183 static void addSystemIncludes(const llvm::opt::ArgList &DriverArgs,
184 llvm::opt::ArgStringList &CC1Args,
185 ArrayRef<StringRef> Paths);
189 virtual ~ToolChain();
193 const Driver &getDriver() const { return D; }
194 llvm::vfs::FileSystem &getVFS() const;
195 const llvm::Triple &getTriple() const { return Triple; }
197 /// Get the toolchain's aux triple, if it has one.
199 /// Exactly what the aux triple represents depends on the toolchain, but for
200 /// example when compiling CUDA code for the GPU, the triple might be NVPTX,
201 /// while the aux triple is the host (CPU) toolchain, e.g. x86-linux-gnu.
202 virtual const llvm::Triple *getAuxTriple() const { return nullptr; }
204 /// Some toolchains need to modify the file name, for example to replace the
205 /// extension for object files with .cubin for OpenMP offloading to Nvidia
207 virtual std::string getInputFilename(const InputInfo &Input) const;
209 llvm::Triple::ArchType getArch() const { return Triple.getArch(); }
210 StringRef getArchName() const { return Triple.getArchName(); }
211 StringRef getPlatform() const { return Triple.getVendorName(); }
212 StringRef getOS() const { return Triple.getOSName(); }
214 /// Provide the default architecture name (as expected by -arch) for
216 StringRef getDefaultUniversalArchName() const;
218 std::string getTripleString() const {
219 return Triple.getTriple();
222 /// Get the toolchain's effective clang triple.
223 const llvm::Triple &getEffectiveTriple() const {
224 assert(!EffectiveTriple.getTriple().empty() && "No effective triple");
225 return EffectiveTriple;
228 path_list &getLibraryPaths() { return LibraryPaths; }
229 const path_list &getLibraryPaths() const { return LibraryPaths; }
231 path_list &getFilePaths() { return FilePaths; }
232 const path_list &getFilePaths() const { return FilePaths; }
234 path_list &getProgramPaths() { return ProgramPaths; }
235 const path_list &getProgramPaths() const { return ProgramPaths; }
237 const MultilibSet &getMultilibs() const { return Multilibs; }
239 const Multilib &getMultilib() const { return SelectedMultilib; }
241 const SanitizerArgs& getSanitizerArgs() const;
243 const XRayArgs& getXRayArgs() const;
245 // Returns the Arg * that explicitly turned on/off rtti, or nullptr.
246 const llvm::opt::Arg *getRTTIArg() const { return CachedRTTIArg; }
248 // Returns the RTTIMode for the toolchain with the current arguments.
249 RTTIMode getRTTIMode() const { return CachedRTTIMode; }
251 /// Return any implicit target and/or mode flag for an invocation of
252 /// the compiler driver as `ProgName`.
254 /// For example, when called with i686-linux-android-g++, the first element
255 /// of the return value will be set to `"i686-linux-android"` and the second
256 /// will be set to "--driver-mode=g++"`.
257 /// It is OK if the target name is not registered. In this case the return
258 /// value contains false in the field TargetIsValid.
260 /// \pre `llvm::InitializeAllTargets()` has been called.
261 /// \param ProgName The name the Clang driver was invoked with (from,
263 /// \return A structure of type ParsedClangName that contains the executable
265 static ParsedClangName getTargetAndModeFromProgramName(StringRef ProgName);
269 /// TranslateArgs - Create a new derived argument list for any argument
270 /// translations this ToolChain may wish to perform, or 0 if no tool chain
271 /// specific translations are needed. If \p DeviceOffloadKind is specified
272 /// the translation specific for that offload kind is performed.
274 /// \param BoundArch - The bound architecture name, or 0.
275 /// \param DeviceOffloadKind - The device offload kind used for the
277 virtual llvm::opt::DerivedArgList *
278 TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
279 Action::OffloadKind DeviceOffloadKind) const {
283 /// TranslateOpenMPTargetArgs - Create a new derived argument list for
284 /// that contains the OpenMP target specific flags passed via
285 /// -Xopenmp-target -opt=val OR -Xopenmp-target=<triple> -opt=val
286 virtual llvm::opt::DerivedArgList *TranslateOpenMPTargetArgs(
287 const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost,
288 SmallVectorImpl<llvm::opt::Arg *> &AllocatedArgs) const;
290 /// Choose a tool to use to handle the action \p JA.
292 /// This can be overridden when a particular ToolChain needs to use
293 /// a compiler other than Clang.
294 virtual Tool *SelectTool(const JobAction &JA) const;
298 std::string GetFilePath(const char *Name) const;
299 std::string GetProgramPath(const char *Name) const;
301 /// Returns the linker path, respecting the -fuse-ld= argument to determine
302 /// the linker suffix or name.
303 std::string GetLinkerPath() const;
305 /// Dispatch to the specific toolchain for verbose printing.
307 /// This is used when handling the verbose option to print detailed,
308 /// toolchain-specific information useful for understanding the behavior of
309 /// the driver on a specific platform.
310 virtual void printVerboseInfo(raw_ostream &OS) const {}
312 // Platform defaults information
314 /// Returns true if the toolchain is targeting a non-native
316 virtual bool isCrossCompiling() const;
318 /// HasNativeLTOLinker - Check whether the linker and related tools have
319 /// native LLVM support.
320 virtual bool HasNativeLLVMSupport() const;
322 /// LookupTypeForExtension - Return the default language type to use for the
324 virtual types::ID LookupTypeForExtension(StringRef Ext) const;
326 /// IsBlocksDefault - Does this tool chain enable -fblocks by default.
327 virtual bool IsBlocksDefault() const { return false; }
329 /// IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as
331 virtual bool IsIntegratedAssemblerDefault() const { return false; }
333 /// Check if the toolchain should use the integrated assembler.
334 virtual bool useIntegratedAs() const;
336 /// IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.
337 virtual bool IsMathErrnoDefault() const { return true; }
339 /// IsEncodeExtendedBlockSignatureDefault - Does this tool chain enable
340 /// -fencode-extended-block-signature by default.
341 virtual bool IsEncodeExtendedBlockSignatureDefault() const { return false; }
343 /// IsObjCNonFragileABIDefault - Does this tool chain set
344 /// -fobjc-nonfragile-abi by default.
345 virtual bool IsObjCNonFragileABIDefault() const { return false; }
347 /// UseObjCMixedDispatchDefault - When using non-legacy dispatch, should the
348 /// mixed dispatch method be used?
349 virtual bool UseObjCMixedDispatch() const { return false; }
351 /// Check whether to enable x86 relax relocations by default.
352 virtual bool useRelaxRelocations() const;
354 /// GetDefaultStackProtectorLevel - Get the default stack protector level for
355 /// this tool chain (0=off, 1=on, 2=strong, 3=all).
356 virtual unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const {
360 /// Get the default trivial automatic variable initialization.
361 virtual LangOptions::TrivialAutoVarInitKind
362 GetDefaultTrivialAutoVarInit() const {
363 return LangOptions::TrivialAutoVarInitKind::Uninitialized;
366 /// GetDefaultLinker - Get the default linker to use.
367 virtual const char *getDefaultLinker() const { return "ld"; }
369 /// GetDefaultRuntimeLibType - Get the default runtime library variant to use.
370 virtual RuntimeLibType GetDefaultRuntimeLibType() const {
371 return ToolChain::RLT_Libgcc;
374 virtual CXXStdlibType GetDefaultCXXStdlibType() const {
375 return ToolChain::CST_Libstdcxx;
378 virtual UnwindLibType GetDefaultUnwindLibType() const {
379 return ToolChain::UNW_None;
382 virtual std::string getCompilerRTPath() const;
384 virtual std::string getCompilerRT(const llvm::opt::ArgList &Args,
386 FileType Type = ToolChain::FT_Static) const;
389 getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component,
390 FileType Type = ToolChain::FT_Static) const;
392 // Returns target specific runtime path if it exists.
393 virtual Optional<std::string> getRuntimePath() const;
395 // Returns target specific C++ library path if it exists.
396 virtual Optional<std::string> getCXXStdlibPath() const;
398 // Returns <ResourceDir>/lib/<OSName>/<arch>. This is used by runtimes (such
399 // as OpenMP) to find arch-specific libraries.
400 std::string getArchSpecificLibPath() const;
402 // Returns <OSname> part of above.
403 StringRef getOSLibName() const;
405 /// needsProfileRT - returns true if instrumentation profile is on.
406 static bool needsProfileRT(const llvm::opt::ArgList &Args);
408 /// Returns true if gcov instrumentation (-fprofile-arcs or --coverage) is on.
409 static bool needsGCovInstrumentation(const llvm::opt::ArgList &Args);
411 /// IsUnwindTablesDefault - Does this tool chain use -funwind-tables
413 virtual bool IsUnwindTablesDefault(const llvm::opt::ArgList &Args) const;
415 /// Test whether this toolchain defaults to PIC.
416 virtual bool isPICDefault() const = 0;
418 /// Test whether this toolchain defaults to PIE.
419 virtual bool isPIEDefault() const = 0;
421 /// Test whether this toolchaind defaults to non-executable stacks.
422 virtual bool isNoExecStackDefault() const;
424 /// Tests whether this toolchain forces its default for PIC, PIE or
425 /// non-PIC. If this returns true, any PIC related flags should be ignored
426 /// and instead the results of \c isPICDefault() and \c isPIEDefault() are
427 /// used exclusively.
428 virtual bool isPICDefaultForced() const = 0;
430 /// SupportsProfiling - Does this tool chain support -pg.
431 virtual bool SupportsProfiling() const { return true; }
433 /// Complain if this tool chain doesn't support Objective-C ARC.
434 virtual void CheckObjCARC() const {}
436 /// Get the default debug info format. Typically, this is DWARF.
437 virtual codegenoptions::DebugInfoFormat getDefaultDebugFormat() const {
438 return codegenoptions::DIF_DWARF;
441 /// UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf
442 /// compile unit information.
443 virtual bool UseDwarfDebugFlags() const { return false; }
445 // Return the DWARF version to emit, in the absence of arguments
447 virtual unsigned GetDefaultDwarfVersion() const { return 4; }
449 // True if the driver should assume "-fstandalone-debug"
450 // in the absence of an option specifying otherwise,
451 // provided that debugging was requested in the first place.
452 // i.e. a value of 'true' does not imply that debugging is wanted.
453 virtual bool GetDefaultStandaloneDebug() const { return false; }
455 // Return the default debugger "tuning."
456 virtual llvm::DebuggerKind getDefaultDebuggerTuning() const {
457 return llvm::DebuggerKind::GDB;
460 /// Does this toolchain supports given debug info option or not.
461 virtual bool supportsDebugInfoOption(const llvm::opt::Arg *) const {
465 /// Adjust debug information kind considering all passed options.
466 virtual void adjustDebugInfoKind(codegenoptions::DebugInfoKind &DebugInfoKind,
467 const llvm::opt::ArgList &Args) const {}
469 /// GetExceptionModel - Return the tool chain exception model.
470 virtual llvm::ExceptionHandling
471 GetExceptionModel(const llvm::opt::ArgList &Args) const;
473 /// SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode.
474 virtual bool SupportsEmbeddedBitcode() const { return false; }
476 /// getThreadModel() - Which thread model does this target use?
477 virtual std::string getThreadModel() const { return "posix"; }
479 /// isThreadModelSupported() - Does this target support a thread model?
480 virtual bool isThreadModelSupported(const StringRef Model) const;
482 /// ComputeLLVMTriple - Return the LLVM target triple to use, after taking
483 /// command line arguments into account.
485 ComputeLLVMTriple(const llvm::opt::ArgList &Args,
486 types::ID InputType = types::TY_INVALID) const;
488 /// ComputeEffectiveClangTriple - Return the Clang triple to use for this
489 /// target, which may take into account the command line arguments. For
490 /// example, on Darwin the -mmacosx-version-min= command line argument (which
491 /// sets the deployment target) determines the version in the triple passed to
493 virtual std::string ComputeEffectiveClangTriple(
494 const llvm::opt::ArgList &Args,
495 types::ID InputType = types::TY_INVALID) const;
497 /// getDefaultObjCRuntime - Return the default Objective-C runtime
498 /// for this platform.
500 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
501 virtual ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const;
503 /// hasBlocksRuntime - Given that the user is compiling with
504 /// -fblocks, does this tool chain guarantee the existence of a
507 /// FIXME: this really belongs on some sort of DeploymentTarget abstraction
508 virtual bool hasBlocksRuntime() const { return true; }
510 /// Add the clang cc1 arguments for system include paths.
512 /// This routine is responsible for adding the necessary cc1 arguments to
513 /// include headers from standard system header directories.
515 AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
516 llvm::opt::ArgStringList &CC1Args) const;
518 /// Add options that need to be passed to cc1 for this target.
519 virtual void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
520 llvm::opt::ArgStringList &CC1Args,
521 Action::OffloadKind DeviceOffloadKind) const;
523 /// Add warning options that need to be passed to cc1 for this target.
524 virtual void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const;
526 // GetRuntimeLibType - Determine the runtime library type to use with the
527 // given compilation arguments.
528 virtual RuntimeLibType
529 GetRuntimeLibType(const llvm::opt::ArgList &Args) const;
531 // GetCXXStdlibType - Determine the C++ standard library type to use with the
532 // given compilation arguments.
533 virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const;
535 // GetUnwindLibType - Determine the unwind library type to use with the
536 // given compilation arguments.
537 virtual UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const;
539 /// AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set
540 /// the include paths to use for the given C++ standard library type.
542 AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs,
543 llvm::opt::ArgStringList &CC1Args) const;
545 /// Returns if the C++ standard library should be linked in.
546 /// Note that e.g. -lm should still be linked even if this returns false.
547 bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const;
549 /// AddCXXStdlibLibArgs - Add the system specific linker arguments to use
550 /// for the given C++ standard library type.
551 virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
552 llvm::opt::ArgStringList &CmdArgs) const;
554 /// AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
555 void AddFilePathLibArgs(const llvm::opt::ArgList &Args,
556 llvm::opt::ArgStringList &CmdArgs) const;
558 /// AddCCKextLibArgs - Add the system specific linker arguments to use
559 /// for kernel extensions (Darwin-specific).
560 virtual void AddCCKextLibArgs(const llvm::opt::ArgList &Args,
561 llvm::opt::ArgStringList &CmdArgs) const;
563 /// AddFastMathRuntimeIfAvailable - If a runtime library exists that sets
564 /// global flags for unsafe floating point math, add it and return true.
566 /// This checks for presence of the -Ofast, -ffast-math or -funsafe-math flags.
567 virtual bool AddFastMathRuntimeIfAvailable(
568 const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const;
570 /// addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass
571 /// a suitable profile runtime library to the linker.
572 virtual void addProfileRTLibs(const llvm::opt::ArgList &Args,
573 llvm::opt::ArgStringList &CmdArgs) const;
575 /// Add arguments to use system-specific CUDA includes.
576 virtual void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs,
577 llvm::opt::ArgStringList &CC1Args) const;
579 /// Add arguments to use MCU GCC toolchain includes.
580 virtual void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
581 llvm::opt::ArgStringList &CC1Args) const;
583 /// On Windows, returns the MSVC compatibility version.
584 virtual VersionTuple computeMSVCVersion(const Driver *D,
585 const llvm::opt::ArgList &Args) const;
587 /// Return sanitizers which are available in this toolchain.
588 virtual SanitizerMask getSupportedSanitizers() const;
590 /// Return sanitizers which are enabled by default.
591 virtual SanitizerMask getDefaultSanitizers() const {
592 return SanitizerMask();
596 /// Set a ToolChain's effective triple. Reset it when the registration object
598 class RegisterEffectiveTriple {
602 RegisterEffectiveTriple(const ToolChain &TC, llvm::Triple T) : TC(TC) {
603 TC.setEffectiveTriple(std::move(T));
606 ~RegisterEffectiveTriple() { TC.setEffectiveTriple(llvm::Triple()); }
609 } // namespace driver
613 #endif // LLVM_CLANG_DRIVER_TOOLCHAIN_H