clang  6.0.0svn
Public Types | Public Member Functions | Protected Member Functions | List of all members
clang::driver::toolchains::MSVCToolChain Class Reference

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

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

Public Types

enum  SubDirectoryType { SubDirectoryType::Bin, SubDirectoryType::Include, SubDirectoryType::Lib }
 
enum  ToolsetLayout { ToolsetLayout::OlderVS, ToolsetLayout::VS2017OrNewer, ToolsetLayout::DevDivInternal }
 
- Public Types inherited from clang::driver::ToolChain
enum  CXXStdlibType { CST_Libcxx, CST_Libstdcxx }
 
enum  RuntimeLibType { RLT_CompilerRT, RLT_Libgcc }
 
enum  RTTIMode { RM_EnabledExplicitly, RM_EnabledImplicitly, RM_DisabledExplicitly, RM_DisabledImplicitly }
 
typedef SmallVector< std::string, 16 > path_list
 

Public Member Functions

 MSVCToolChain (const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
 
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...
 
bool IsIntegratedAssemblerDefault () const override
 IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as by default. More...
 
bool IsUnwindTablesDefault (const llvm::opt::ArgList &Args) const override
 IsUnwindTablesDefault - Does this tool chain use -funwind-tables by default. 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...
 
std::string getSubDirectoryPath (SubDirectoryType Type, llvm::Triple::ArchType TargetArch) const
 
std::string getSubDirectoryPath (SubDirectoryType Type) const
 
bool getIsVS2017OrNewer () const
 
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 &DriverArgs, 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 AddCudaIncludeArgs (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
 Add arguments to use system-specific CUDA includes. More...
 
bool getWindowsSDKLibraryPath (std::string &path) const
 
bool getUniversalCRTLibraryPath (std::string &path) const
 Check if Universal CRT should be used if available. More...
 
bool useUniversalCRT () const
 
VersionTuple computeMSVCVersion (const Driver *D, const llvm::opt::ArgList &Args) const override
 On Windows, returns the MSVC compatibility version. More...
 
std::string ComputeEffectiveClangTriple (const llvm::opt::ArgList &Args, types::ID InputType) const override
 ComputeEffectiveClangTriple - Return the Clang triple to use for this target, which may take into account the command line arguments. More...
 
SanitizerMask getSupportedSanitizers () const override
 Return sanitizers which are available in this toolchain. More...
 
void printVerboseInfo (raw_ostream &OS) const override
 Dispatch to the specific toolchain for verbose printing. More...
 
- Public Member Functions inherited from clang::driver::ToolChain
virtual ~ToolChain ()
 
const DrivergetDriver () const
 
vfs::FileSystemgetVFS () const
 
const llvm::Triple & getTriple () const
 
virtual const llvm::Triple * getAuxTriple () const
 Get the toolchain's aux triple, if it has one. More...
 
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_listgetFilePaths ()
 
const path_listgetFilePaths () const
 
path_listgetProgramPaths ()
 
const path_listgetProgramPaths () const
 
const MultilibSetgetMultilibs () 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 bool isCrossCompiling () const
 Returns true if the toolchain is targeting a non-native architecture. 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 useIntegratedAs () const
 Check if the toolchain should use the integrated assembler. More...
 
virtual bool IsMathErrnoDefault () const
 IsMathErrnoDefault - Does this tool chain use -fmath-errno 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 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 std::string getCompilerRTPath () const
 
virtual std::string getCompilerRT (const llvm::opt::ArgList &Args, StringRef Component, bool Shared=false) const
 
const char * getCompilerRTArgString (const llvm::opt::ArgList &Args, StringRef Component, bool Shared=false) const
 
std::string getArchSpecificLibPath () const
 
virtual bool SupportsProfiling () const
 SupportsProfiling - Does this tool chain support -pg. More...
 
virtual void CheckObjCARC () const
 Complain if this tool chain doesn't support Objective-C ARC. More...
 
virtual bool UseDwarfDebugFlags () const
 UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf compile unit information. More...
 
virtual unsigned GetDefaultDwarfVersion () const
 
virtual bool GetDefaultStandaloneDebug () const
 
virtual llvm::DebuggerKind getDefaultDebuggerTuning () const
 
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 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 void addClangTargetOptions (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, Action::OffloadKind DeviceOffloadKind) const
 Add options that need to be passed to cc1 for this target. More...
 
virtual void addClangWarningOptions (llvm::opt::ArgStringList &CC1Args) const
 Add warning options that need to be passed to cc1 for this target. More...
 
virtual RuntimeLibType GetRuntimeLibType (const llvm::opt::ArgList &Args) const
 
virtual CXXStdlibType GetCXXStdlibType (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 AddIAMCUIncludeArgs (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
 Add arguments to use MCU GCC toolchain includes. More...
 
virtual SanitizerMask getDefaultSanitizers () const
 Return sanitizers which are enabled by default. More...
 

Protected Member Functions

void AddSystemIncludeWithSubfolder (const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const std::string &folder, const Twine &subfolder1, const Twine &subfolder2="", const Twine &subfolder3="") const
 
ToolbuildLinker () const override
 
ToolbuildAssembler () 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 ToolgetTool (Action::ActionClass AC) const
 

Additional Inherited Members

- 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 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
 

Detailed Description

Definition at line 66 of file MSVC.h.

Member Enumeration Documentation

◆ SubDirectoryType

Enumerator
Bin 
Include 
Lib 

Definition at line 81 of file MSVC.h.

◆ ToolsetLayout

Enumerator
OlderVS 
VS2017OrNewer 
DevDivInternal 

Definition at line 95 of file MSVC.h.

Constructor & Destructor Documentation

◆ MSVCToolChain()

MSVCToolChain::MSVCToolChain ( const Driver D,
const llvm::Triple &  Triple,
const llvm::opt::ArgList &  Args 
)

Member Function Documentation

◆ AddClangCXXStdlibIncludeArgs()

void MSVCToolChain::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 1253 of file MSVC.cpp.

◆ AddClangSystemIncludeArgs()

void MSVCToolChain::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 1168 of file MSVC.cpp.

References clang::driver::ToolChain::addSystemInclude(), clang::driver::ToolChain::addSystemIncludes(), AddSystemIncludeWithSubfolder(), clang::driver::ToolChain::getDriver(), getSubDirectoryPath(), getUniversalCRTSdkDir(), getWindowsSDKDir(), Include, and useUniversalCRT().

◆ AddCudaIncludeArgs()

void MSVCToolChain::AddCudaIncludeArgs ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args 
) const
overridevirtual

Add arguments to use system-specific CUDA includes.

Reimplemented from clang::driver::ToolChain.

Definition at line 734 of file MSVC.cpp.

References clang::driver::CudaInstallationDetector::AddCudaIncludeArgs().

◆ AddSystemIncludeWithSubfolder()

void MSVCToolChain::AddSystemIncludeWithSubfolder ( const llvm::opt::ArgList &  DriverArgs,
llvm::opt::ArgStringList &  CC1Args,
const std::string &  folder,
const Twine &  subfolder1,
const Twine &  subfolder2 = "",
const Twine &  subfolder3 = "" 
) const
protected

Definition at line 1159 of file MSVC.cpp.

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

Referenced by AddClangSystemIncludeArgs().

◆ buildAssembler()

Tool * MSVCToolChain::buildAssembler ( ) const
overrideprotectedvirtual

◆ buildLinker()

Tool * MSVCToolChain::buildLinker ( ) const
overrideprotectedvirtual

Reimplemented from clang::driver::ToolChain.

Definition at line 693 of file MSVC.cpp.

References clang::driver::Driver::Diag(), and clang::driver::ToolChain::getDriver().

◆ ComputeEffectiveClangTriple()

std::string MSVCToolChain::ComputeEffectiveClangTriple ( const llvm::opt::ArgList &  Args,
types::ID  InputType 
) const
overridevirtual

ComputeEffectiveClangTriple - Return the Clang triple to use for this target, which may take into account the command line arguments.

For example, on Darwin the -mmacosx-version-min= command line argument (which sets the deployment target) determines the version in the triple passed to Clang.

Reimplemented from clang::driver::ToolChain.

Definition at line 1276 of file MSVC.cpp.

References clang::driver::ToolChain::ComputeEffectiveClangTriple(), computeMSVCVersion(), clang::VersionTuple::getAsString(), clang::VersionTuple::getMajor(), clang::VersionTuple::getMinor(), and clang::VersionTuple::getSubminor().

◆ computeMSVCVersion()

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

◆ getIsVS2017OrNewer()

bool clang::driver::toolchains::MSVCToolChain::getIsVS2017OrNewer ( ) const
inline

Definition at line 100 of file MSVC.h.

◆ getSubDirectoryPath() [1/2]

std::string MSVCToolChain::getSubDirectoryPath ( SubDirectoryType  Type,
llvm::Triple::ArchType  TargetArch 
) const

◆ getSubDirectoryPath() [2/2]

std::string clang::driver::toolchains::MSVCToolChain::getSubDirectoryPath ( SubDirectoryType  Type) const
inline

Definition at line 91 of file MSVC.h.

◆ getSupportedSanitizers()

SanitizerMask MSVCToolChain::getSupportedSanitizers ( ) const
overridevirtual

Return sanitizers which are available in this toolchain.

Reimplemented from clang::driver::ToolChain.

Definition at line 1298 of file MSVC.cpp.

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

◆ getUniversalCRTLibraryPath()

bool MSVCToolChain::getUniversalCRTLibraryPath ( std::string &  path) const

Check if Universal CRT should be used if available.

Definition at line 1096 of file MSVC.cpp.

References clang::driver::ToolChain::getArch(), getUniversalCRTSdkDir(), and llvmArchToWindowsSDKArch().

◆ getWindowsSDKLibraryPath()

bool MSVCToolChain::getWindowsSDKLibraryPath ( std::string &  path) const

◆ IsIntegratedAssemblerDefault()

bool MSVCToolChain::IsIntegratedAssemblerDefault ( ) const
overridevirtual

IsIntegratedAssemblerDefault - Does this tool chain enable -integrated-as by default.

Reimplemented from clang::driver::ToolChain.

Definition at line 706 of file MSVC.cpp.

◆ isPICDefault()

bool MSVCToolChain::isPICDefault ( ) const
overridevirtual

Test whether this toolchain defaults to PIC.

Implements clang::driver::ToolChain.

Definition at line 722 of file MSVC.cpp.

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

◆ isPICDefaultForced()

bool MSVCToolChain::isPICDefaultForced ( ) const
overridevirtual

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 730 of file MSVC.cpp.

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

◆ isPIEDefault()

bool MSVCToolChain::isPIEDefault ( ) const
overridevirtual

Test whether this toolchain defaults to PIE.

Implements clang::driver::ToolChain.

Definition at line 726 of file MSVC.cpp.

◆ IsUnwindTablesDefault()

bool MSVCToolChain::IsUnwindTablesDefault ( const llvm::opt::ArgList &  Args) const
overridevirtual

IsUnwindTablesDefault - Does this tool chain use -funwind-tables by default.

Reimplemented from clang::driver::ToolChain.

Definition at line 710 of file MSVC.cpp.

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

◆ printVerboseInfo()

void MSVCToolChain::printVerboseInfo ( raw_ostream &  OS) const
overridevirtual

Dispatch to the specific toolchain for verbose printing.

This is used when handling the verbose option to print detailed, toolchain-specific information useful for understanding the behavior of the driver on a specific platform.

Reimplemented from clang::driver::ToolChain.

Definition at line 739 of file MSVC.cpp.

References clang::driver::CudaInstallationDetector::print().

◆ TranslateArgs()

llvm::opt::DerivedArgList * MSVCToolChain::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 1416 of file MSVC.cpp.

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

◆ useUniversalCRT()

bool MSVCToolChain::useUniversalCRT ( ) const

Definition at line 1078 of file MSVC.cpp.

References getSubDirectoryPath(), and Include.

Referenced by AddClangSystemIncludeArgs().


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