clang  9.0.0svn
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
clang::driver::toolchains::HIPToolChain Class Reference

#include "/opt/doxygen-docs/src/llvm/tools/clang/lib/Driver/ToolChains/HIP.h"

Inheritance diagram for clang::driver::toolchains::HIPToolChain:
Inheritance graph
[legend]
Collaboration diagram for clang::driver::toolchains::HIPToolChain:
Collaboration graph
[legend]

Public Member Functions

 HIPToolChain (const Driver &D, const llvm::Triple &Triple, const ToolChain &HostTC, const llvm::opt::ArgList &Args)
 
const llvm::Triple * getAuxTriple () const override
 Get the toolchain's aux triple, if it has one. More...
 
llvm::opt::DerivedArgList * TranslateArgs (const llvm::opt::DerivedArgList &Args, StringRef BoundArch, Action::OffloadKind DeviceOffloadKind) const override
 TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may wish to perform, or 0 if no tool chain specific translations are needed. More...
 
void addClangTargetOptions (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, Action::OffloadKind DeviceOffloadKind) const override
 Add options that need to be passed to cc1 for this target. More...
 
bool useIntegratedAs () const override
 Check if the toolchain should use the integrated assembler. More...
 
bool isCrossCompiling () const override
 Returns true if the toolchain is targeting a non-native architecture. More...
 
bool isPICDefault () const override
 Test whether this toolchain defaults to PIC. More...
 
bool isPIEDefault () const override
 Test whether this toolchain defaults to PIE. More...
 
bool isPICDefaultForced () const override
 Tests whether this toolchain forces its default for PIC, PIE or non-PIC. More...
 
bool SupportsProfiling () const override
 SupportsProfiling - Does this tool chain support -pg. More...
 
bool IsMathErrnoDefault () const override
 IsMathErrnoDefault - Does this tool chain use -fmath-errno by default. More...
 
void addClangWarningOptions (llvm::opt::ArgStringList &CC1Args) const override
 Add warning options that need to be passed to cc1 for this target. More...
 
CXXStdlibType GetCXXStdlibType (const llvm::opt::ArgList &Args) const override
 
void AddClangSystemIncludeArgs (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
 Add the clang cc1 arguments for system include paths. More...
 
void AddClangCXXStdlibIncludeArgs (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1Args) const override
 AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for the given C++ standard library type. More...
 
void AddIAMCUIncludeArgs (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
 Add arguments to use MCU GCC toolchain includes. More...
 
SanitizerMask getSupportedSanitizers () const override
 Return sanitizers which are available in this toolchain. More...
 
VersionTuple computeMSVCVersion (const Driver *D, const llvm::opt::ArgList &Args) const override
 On Windows, returns the MSVC compatibility version. More...
 
unsigned GetDefaultDwarfVersion () const override
 
- Public Member Functions inherited from clang::driver::ToolChain
virtual ~ToolChain ()
 
const DrivergetDriver () const
 
llvm::vfs::FileSystem & getVFS () const
 
const llvm::Triple & getTriple () const
 
virtual std::string getInputFilename (const InputInfo &Input) const
 Some toolchains need to modify the file name, for example to replace the extension for object files with .cubin for OpenMP offloading to Nvidia GPUs. More...
 
llvm::Triple::ArchType getArch () const
 
StringRef getArchName () const
 
StringRef getPlatform () const
 
StringRef getOS () const
 
StringRef getDefaultUniversalArchName () const
 Provide the default architecture name (as expected by -arch) for this toolchain. More...
 
std::string getTripleString () const
 
const llvm::Triple & getEffectiveTriple () const
 Get the toolchain's effective clang triple. More...
 
path_listgetLibraryPaths ()
 
const path_listgetLibraryPaths () const
 
path_listgetFilePaths ()
 
const path_listgetFilePaths () const
 
path_listgetProgramPaths ()
 
const path_listgetProgramPaths () const
 
const MultilibSetgetMultilibs () const
 
const MultilibgetMultilib () const
 
const SanitizerArgsgetSanitizerArgs () const
 
const XRayArgsgetXRayArgs () const
 
const llvm::opt::Arg * getRTTIArg () const
 
RTTIMode getRTTIMode () const
 
virtual llvm::opt::DerivedArgList * TranslateOpenMPTargetArgs (const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost, SmallVectorImpl< llvm::opt::Arg *> &AllocatedArgs) const
 TranslateOpenMPTargetArgs - Create a new derived argument list for that contains the OpenMP target specific flags passed via -Xopenmp-target -opt=val OR -Xopenmp-target=<triple> -opt=val. More...
 
virtual ToolSelectTool (const JobAction &JA) const
 Choose a tool to use to handle the action JA. More...
 
std::string GetFilePath (const char *Name) const
 
std::string GetProgramPath (const char *Name) const
 
std::string GetLinkerPath () const
 Returns the linker path, respecting the -fuse-ld= argument to determine the linker suffix or name. More...
 
virtual void printVerboseInfo (raw_ostream &OS) const
 Dispatch to the specific toolchain for verbose printing. More...
 
virtual bool HasNativeLLVMSupport () const
 HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support. More...
 
virtual types::ID LookupTypeForExtension (StringRef Ext) const
 LookupTypeForExtension - Return the default language type to use for the given extension. More...
 
virtual bool IsBlocksDefault () const
 IsBlocksDefault - Does this tool chain enable -fblocks by default. More...
 
virtual bool IsIntegratedAssemblerDefault () const
 IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as by default. More...
 
virtual bool IsEncodeExtendedBlockSignatureDefault () const
 IsEncodeExtendedBlockSignatureDefault - Does this tool chain enable -fencode-extended-block-signature by default. More...
 
virtual bool IsObjCNonFragileABIDefault () const
 IsObjCNonFragileABIDefault - Does this tool chain set -fobjc-nonfragile-abi by default. More...
 
virtual bool UseObjCMixedDispatch () const
 UseObjCMixedDispatchDefault - When using non-legacy dispatch, should the mixed dispatch method be used? More...
 
virtual bool useRelaxRelocations () const
 Check whether to enable x86 relax relocations by default. More...
 
virtual unsigned GetDefaultStackProtectorLevel (bool KernelOrKext) const
 GetDefaultStackProtectorLevel - Get the default stack protector level for this tool chain (0=off, 1=on, 2=strong, 3=all). More...
 
virtual LangOptions::TrivialAutoVarInitKind GetDefaultTrivialAutoVarInit () const
 Get the default trivial automatic variable initialization. More...
 
virtual const char * getDefaultLinker () const
 GetDefaultLinker - Get the default linker to use. More...
 
virtual RuntimeLibType GetDefaultRuntimeLibType () const
 GetDefaultRuntimeLibType - Get the default runtime library variant to use. More...
 
virtual CXXStdlibType GetDefaultCXXStdlibType () const
 
virtual UnwindLibType GetDefaultUnwindLibType () const
 
virtual std::string getCompilerRTPath () const
 
virtual std::string getCompilerRT (const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
 
const char * getCompilerRTArgString (const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
 
std::string getArchSpecificLibPath () const
 
StringRef getOSLibName () const
 
virtual bool IsUnwindTablesDefault (const llvm::opt::ArgList &Args) const
 IsUnwindTablesDefault - Does this tool chain use -funwind-tables by default. More...
 
virtual bool isNoExecStackDefault () const
 Test whether this toolchaind defaults to non-executable stacks. More...
 
virtual void CheckObjCARC () const
 Complain if this tool chain doesn't support Objective-C ARC. More...
 
virtual codegenoptions::DebugInfoFormat getDefaultDebugFormat () const
 Get the default debug info format. Typically, this is DWARF. More...
 
virtual bool UseDwarfDebugFlags () const
 UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf compile unit information. More...
 
virtual bool GetDefaultStandaloneDebug () const
 
virtual llvm::DebuggerKind getDefaultDebuggerTuning () const
 
virtual bool supportsDebugInfoOption (const llvm::opt::Arg *) const
 Does this toolchain supports given debug info option or not. More...
 
virtual void adjustDebugInfoKind (codegenoptions::DebugInfoKind &DebugInfoKind, const llvm::opt::ArgList &Args) const
 Adjust debug information kind considering all passed options. More...
 
virtual llvm::ExceptionHandling GetExceptionModel (const llvm::opt::ArgList &Args) const
 GetExceptionModel - Return the tool chain exception model. More...
 
virtual bool SupportsEmbeddedBitcode () const
 SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode. More...
 
virtual std::string getThreadModel () const
 getThreadModel() - Which thread model does this target use? More...
 
virtual bool isThreadModelSupported (const StringRef Model) const
 isThreadModelSupported() - Does this target support a thread model? More...
 
virtual std::string ComputeLLVMTriple (const llvm::opt::ArgList &Args, types::ID InputType=types::TY_INVALID) const
 ComputeLLVMTriple - Return the LLVM target triple to use, after taking command line arguments into account. More...
 
virtual std::string ComputeEffectiveClangTriple (const llvm::opt::ArgList &Args, types::ID InputType=types::TY_INVALID) const
 ComputeEffectiveClangTriple - Return the Clang triple to use for this target, which may take into account the command line arguments. More...
 
virtual ObjCRuntime getDefaultObjCRuntime (bool isNonFragile) const
 getDefaultObjCRuntime - Return the default Objective-C runtime for this platform. More...
 
virtual bool hasBlocksRuntime () const
 hasBlocksRuntime - Given that the user is compiling with -fblocks, does this tool chain guarantee the existence of a blocks runtime? More...
 
virtual RuntimeLibType GetRuntimeLibType (const llvm::opt::ArgList &Args) const
 
virtual UnwindLibType GetUnwindLibType (const llvm::opt::ArgList &Args) const
 
bool ShouldLinkCXXStdlib (const llvm::opt::ArgList &Args) const
 Returns if the C++ standard library should be linked in. More...
 
virtual void AddCXXStdlibLibArgs (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
 AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard library type. More...
 
void AddFilePathLibArgs (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
 AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option. More...
 
virtual void AddCCKextLibArgs (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
 AddCCKextLibArgs - Add the system specific linker arguments to use for kernel extensions (Darwin-specific). More...
 
virtual bool AddFastMathRuntimeIfAvailable (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
 AddFastMathRuntimeIfAvailable - If a runtime library exists that sets global flags for unsafe floating point math, add it and return true. More...
 
virtual void addProfileRTLibs (const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
 addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass a suitable profile runtime library to the linker. More...
 
virtual void AddCudaIncludeArgs (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
 Add arguments to use system-specific CUDA includes. More...
 
virtual SanitizerMask getDefaultSanitizers () const
 Return sanitizers which are enabled by default. More...
 

Public Attributes

const ToolChainHostTC
 

Protected Member Functions

ToolbuildLinker () const override
 
- Protected Member Functions inherited from clang::driver::ToolChain
 ToolChain (const Driver &D, const llvm::Triple &T, const llvm::opt::ArgList &Args)
 
void setTripleEnvironment (llvm::Triple::EnvironmentType Env)
 
virtual ToolbuildAssembler () const
 
virtual ToolgetTool (Action::ActionClass AC) const
 

Additional Inherited Members

- Public Types inherited from clang::driver::ToolChain
enum  CXXStdlibType { CST_Libcxx, CST_Libstdcxx }
 
enum  RuntimeLibType { RLT_CompilerRT, RLT_Libgcc }
 
enum  UnwindLibType { UNW_None, UNW_CompilerRT, UNW_Libgcc }
 
enum  RTTIMode { RM_Enabled, RM_Disabled }
 
enum  FileType { FT_Object, FT_Static, FT_Shared }
 
using path_list = SmallVector< std::string, 16 >
 
- Static Public Member Functions inherited from clang::driver::ToolChain
static ParsedClangName getTargetAndModeFromProgramName (StringRef ProgName)
 Return any implicit target and/or mode flag for an invocation of the compiler driver as ProgName. More...
 
static bool needsProfileRT (const llvm::opt::ArgList &Args)
 needsProfileRT - returns true if instrumentation profile is on. More...
 
static bool needsGCovInstrumentation (const llvm::opt::ArgList &Args)
 Returns true if gcov instrumentation (-fprofile-arcs or –coverage) is on. More...
 
- Static Protected Member Functions inherited from clang::driver::ToolChain
static void addSystemInclude (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
 Utility function to add a system include directory to CC1 arguments. More...
 
static void addExternCSystemInclude (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
 Utility function to add a system include directory with extern "C" semantics to CC1 arguments. More...
 
static void addExternCSystemIncludeIfExists (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
 
static void addSystemIncludes (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, ArrayRef< StringRef > Paths)
 Utility function to add a list of system include directories to CC1. More...
 
- Protected Attributes inherited from clang::driver::ToolChain
MultilibSet Multilibs
 
Multilib SelectedMultilib
 

Detailed Description

Definition at line 74 of file HIP.h.

Constructor & Destructor Documentation

◆ HIPToolChain()

HIPToolChain::HIPToolChain ( const Driver D,
const llvm::Triple &  Triple,
const ToolChain HostTC,
const llvm::opt::ArgList &  Args 
)

Member Function Documentation

◆ AddClangCXXStdlibIncludeArgs()

void HIPToolChain::AddClangCXXStdlibIncludeArgs ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args 
) const
overridevirtual

AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for the given C++ standard library type.

Reimplemented from clang::driver::ToolChain.

Definition at line 402 of file HIP.cpp.

References clang::driver::ToolChain::AddClangCXXStdlibIncludeArgs(), and HostTC.

◆ AddClangSystemIncludeArgs()

void HIPToolChain::AddClangSystemIncludeArgs ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args 
) const
overridevirtual

Add the clang cc1 arguments for system include paths.

This routine is responsible for adding the necessary cc1 arguments to include headers from standard system header directories.

Reimplemented from clang::driver::ToolChain.

Definition at line 397 of file HIP.cpp.

References clang::driver::ToolChain::AddClangSystemIncludeArgs(), and HostTC.

◆ addClangTargetOptions()

void HIPToolChain::addClangTargetOptions ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args,
Action::OffloadKind  DeviceOffloadKind 
) const
overridevirtual

Add options that need to be passed to cc1 for this target.

Reimplemented from clang::driver::ToolChain.

Definition at line 255 of file HIP.cpp.

References clang::driver::ToolChain::addClangTargetOptions(), clang::driver::tools::addDirectoryList(), clang::driver::ToolChain::getDriver(), HostTC, and clang::driver::Action::OFK_HIP.

◆ addClangWarningOptions()

void HIPToolChain::addClangWarningOptions ( llvm::opt::ArgStringList &  CC1Args) const
overridevirtual

Add warning options that need to be passed to cc1 for this target.

Reimplemented from clang::driver::ToolChain.

Definition at line 388 of file HIP.cpp.

References clang::driver::ToolChain::addClangWarningOptions(), and HostTC.

◆ AddIAMCUIncludeArgs()

void HIPToolChain::AddIAMCUIncludeArgs ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args 
) const
overridevirtual

Add arguments to use MCU GCC toolchain includes.

Reimplemented from clang::driver::ToolChain.

Definition at line 407 of file HIP.cpp.

References clang::driver::ToolChain::AddIAMCUIncludeArgs(), and HostTC.

◆ buildLinker()

Tool * HIPToolChain::buildLinker ( ) const
overrideprotectedvirtual

Reimplemented from clang::driver::ToolChain.

Definition at line 383 of file HIP.cpp.

References clang::driver::ToolChain::getArch(), and clang::driver::ToolChain::getTriple().

◆ computeMSVCVersion()

VersionTuple HIPToolChain::computeMSVCVersion ( const Driver D,
const llvm::opt::ArgList &  Args 
) const
overridevirtual

On Windows, returns the MSVC compatibility version.

Reimplemented from clang::driver::ToolChain.

Definition at line 425 of file HIP.cpp.

References clang::driver::ToolChain::computeMSVCVersion(), and HostTC.

◆ getAuxTriple()

const llvm::Triple* clang::driver::toolchains::HIPToolChain::getAuxTriple ( ) const
inlineoverridevirtual

Get the toolchain's aux triple, if it has one.

Exactly what the aux triple represents depends on the toolchain, but for example when compiling CUDA code for the GPU, the triple might be NVPTX, while the aux triple is the host (CPU) toolchain, e.g. x86-linux-gnu.

Reimplemented from clang::driver::ToolChain.

Definition at line 79 of file HIP.h.

References clang::driver::ToolChain::getTriple().

◆ GetCXXStdlibType()

ToolChain::CXXStdlibType HIPToolChain::GetCXXStdlibType ( const llvm::opt::ArgList &  Args) const
overridevirtual

Reimplemented from clang::driver::ToolChain.

Definition at line 393 of file HIP.cpp.

References clang::driver::ToolChain::GetCXXStdlibType(), and HostTC.

◆ GetDefaultDwarfVersion()

unsigned clang::driver::toolchains::HIPToolChain::GetDefaultDwarfVersion ( ) const
inlineoverridevirtual

Reimplemented from clang::driver::ToolChain.

Definition at line 115 of file HIP.h.

◆ getSupportedSanitizers()

SanitizerMask HIPToolChain::getSupportedSanitizers ( ) const
overridevirtual

Return sanitizers which are available in this toolchain.

Reimplemented from clang::driver::ToolChain.

Definition at line 412 of file HIP.cpp.

References clang::driver::ToolChain::getSupportedSanitizers(), and HostTC.

◆ isCrossCompiling()

bool clang::driver::toolchains::HIPToolChain::isCrossCompiling ( ) const
inlineoverridevirtual

Returns true if the toolchain is targeting a non-native architecture.

Reimplemented from clang::driver::ToolChain.

Definition at line 91 of file HIP.h.

◆ IsMathErrnoDefault()

bool clang::driver::toolchains::HIPToolChain::IsMathErrnoDefault ( ) const
inlineoverridevirtual

IsMathErrnoDefault - Does this tool chain use -fmath-errno by default.

Reimplemented from clang::driver::ToolChain.

Definition at line 96 of file HIP.h.

◆ isPICDefault()

bool clang::driver::toolchains::HIPToolChain::isPICDefault ( ) const
inlineoverridevirtual

Test whether this toolchain defaults to PIC.

Implements clang::driver::ToolChain.

Definition at line 92 of file HIP.h.

◆ isPICDefaultForced()

bool clang::driver::toolchains::HIPToolChain::isPICDefaultForced ( ) const
inlineoverridevirtual

Tests whether this toolchain forces its default for PIC, PIE or non-PIC.

If this returns true, any PIC related flags should be ignored and instead the results of isPICDefault() and isPIEDefault() are used exclusively.

Implements clang::driver::ToolChain.

Definition at line 94 of file HIP.h.

◆ isPIEDefault()

bool clang::driver::toolchains::HIPToolChain::isPIEDefault ( ) const
inlineoverridevirtual

Test whether this toolchain defaults to PIE.

Implements clang::driver::ToolChain.

Definition at line 93 of file HIP.h.

◆ SupportsProfiling()

bool clang::driver::toolchains::HIPToolChain::SupportsProfiling ( ) const
inlineoverridevirtual

SupportsProfiling - Does this tool chain support -pg.

Reimplemented from clang::driver::ToolChain.

Definition at line 95 of file HIP.h.

◆ TranslateArgs()

llvm::opt::DerivedArgList * HIPToolChain::TranslateArgs ( const llvm::opt::DerivedArgList &  Args,
StringRef  BoundArch,
Action::OffloadKind  DeviceOffloadKind 
) const
overridevirtual

TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may wish to perform, or 0 if no tool chain specific translations are needed.

If DeviceOffloadKind is specified the translation specific for that offload kind is performed.

Parameters
BoundArch- The bound architecture name, or 0.
DeviceOffloadKind- The device offload kind used for the translation.

Reimplemented from clang::driver::ToolChain.

Definition at line 331 of file HIP.cpp.

References clang::driver::ToolChain::getDriver(), clang::driver::Driver::getOpts(), HostTC, and clang::driver::ToolChain::TranslateArgs().

◆ useIntegratedAs()

bool clang::driver::toolchains::HIPToolChain::useIntegratedAs ( ) const
inlineoverridevirtual

Check if the toolchain should use the integrated assembler.

Reimplemented from clang::driver::ToolChain.

Definition at line 90 of file HIP.h.

Member Data Documentation

◆ HostTC

const ToolChain& clang::driver::toolchains::HIPToolChain::HostTC

The documentation for this class was generated from the following files: