Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like command line arguments. More...

#include "clang/Driver/Driver.h"

Classes
struct	CompilationDiagnosticReport
	Contains the files in the compilation diagnostic report generated by generateCompilationDiagnostics. More...

Public Types
enum	OpenMPRuntimeKind { OMPRT_Unknown , OMPRT_OMP , OMPRT_GOMP , OMPRT_IOMP5 }

typedef SmallVector< std::string, 4 >	prefix_list
	A prefix directory used to emulate a limited subset of GCC's '-Bprefix' functionality. More...

using	InputTy = std::pair< types::ID, const llvm::opt::Arg * >
	An input type and its arguments. More...

using	InputList = SmallVector< InputTy, 16 >
	A list of inputs and their types for the given arguments. More...

using	CC1ToolFunc = llvm::function_ref< int(SmallVectorImpl< const char * > &ArgV)>
	Pointer to the ExecuteCC1Tool function, if available. More...

Public Member Functions
DiagnosticBuilder	Diag (unsigned DiagID) const

bool	CCCIsCXX () const
	Whether the driver should follow g++ like behavior. More...

bool	CCCIsCPP () const
	Whether the driver is just the preprocessor. More...

bool	CCCIsCC () const
	Whether the driver should follow gcc like behavior. More...

bool	IsCLMode () const
	Whether the driver should follow cl.exe like behavior. More...

bool	IsFlangMode () const
	Whether the driver should invoke flang for fortran inputs. More...

bool	IsDXCMode () const
	Whether the driver should follow dxc.exe like behavior. More...

phases::ID	getFinalPhase (const llvm::opt::DerivedArgList &DAL, llvm::opt::Arg **FinalPhaseArg=nullptr) const

	Driver (StringRef ClangExecutable, StringRef TargetTriple, DiagnosticsEngine &Diags, std::string Title="clang LLVM compiler", IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)

bool	getOffloadStaticLibSeen () const

bool	getUseNewOffloadingDriver () const
	getUseNewOffloadingDriver - use the new offload driver for OpenMP. More...

void	addFPGATempDepFile (const std::string &DepName, const std::string &FileName) const
	addFPGATempDepFile - Add a file to be added to the bundling step of an FPGA object. More...

const std::string	getFPGATempDepFile (const std::string &FileName) const
	getFPGATempDepFile - Get a file to be added to the bundling step of an FPGA object. More...

bool	isSYCLDefaultTripleImplied () const
	isSYCLDefaultTripleImplied - The default SYCL triple (spir64) has been added or should be added given proper criteria. More...

void	addIntegrationFiles (StringRef IntHeaderName, StringRef IntFooterName, StringRef FileName) const
	addIntegrationFiles - Add the integration files that will be populated by the device compilation and used by the host compile. More...

StringRef	getIntegrationHeader (StringRef FileName) const
	getIntegrationHeader - Get the integration header file More...

StringRef	getIntegrationFooter (StringRef FileName) const
	getIntegrationFooter - Get the integration footer file More...

void	createAppendedFooterInput (Action *&Input, Compilation &C, const llvm::opt::ArgList &Args) const
	createAppendedFooterInput - Create new source file. More...

void	addSYCLTargetMacroArg (const llvm::opt::ArgList &Args, StringRef Macro) const
	addSYCLTargetMacroArg - Add the given macro to the vector of args to be added to the host compilation step. More...

llvm::ArrayRef< std::string >	getSYCLTargetMacroArgs () const
	getSYCLTargetMacroArgs - return the previously gathered macro target args. More...

void	addSYCLUniqueID (StringRef UniqueID, StringRef FileName) const
	setSYCLUniqueID - set the Unique ID that is used for all FE invocations when performing compilations for SYCL. More...

StringRef	getSYCLUniqueID (StringRef FileName) const
	getSYCLUniqueID - Get the Unique ID associated with the file. More...

void	addSYCLDeviceTraitsMacroArg (const llvm::opt::ArgList &Args, StringRef Macro) const
	SYCLDeviceTraitMacroArg - Add the given macro to the vector of args to be added to the device compilation step. More...

llvm::opt::ArgStringList	getDeviceTraitsMacrosArgs () const

Accessors
const std::string &	getCCCGenericGCCName () const
	Name to use when invoking gcc/g++. More...

llvm::ArrayRef< std::string >	getConfigFiles () const

const llvm::opt::OptTable &	getOpts () const

DiagnosticsEngine &	getDiags () const

llvm::vfs::FileSystem &	getVFS () const

bool	getCheckInputsExist () const

void	setCheckInputsExist (bool Value)

bool	getProbePrecompiled () const

void	setProbePrecompiled (bool Value)

const char *	getPrependArg () const

void	setPrependArg (const char *Value)

void	setTargetAndMode (const ParsedClangName &TM)

const std::string &	getTitle ()

void	setTitle (std::string Value)

std::string	getTargetTriple () const

const char *	getClangProgramPath () const
	Get the path to the main clang executable. More...

bool	isDumpDeviceCodeEnabled () const

bool	isSaveTempsEnabled () const

bool	isSaveTempsObj () const

bool	embedBitcodeEnabled () const

bool	embedBitcodeInObject () const

bool	embedBitcodeMarkerOnly () const

bool	offloadHostOnly () const

bool	offloadDeviceOnly () const

void	setFlangF128MathLibrary (std::string name)

StringRef	getFlangF128MathLibrary () const

OpenMPRuntimeKind	getOpenMPRuntime (const llvm::opt::ArgList &Args) const
	Compute the desired OpenMP runtime from the flags provided. More...

Static Public Member Functions
static std::string	GetResourcesPath (StringRef BinaryPath, StringRef CustomResourceDir="")
	Takes the path to a binary that's either in bin/ or lib/ and returns the path to clang's resource directory. More...

static bool	GetReleaseVersion (StringRef Str, unsigned &Major, unsigned &Minor, unsigned &Micro, bool &HadExtra)
	GetReleaseVersion - Parse (([0-9]+)(. More...

static bool	GetReleaseVersion (StringRef Str, MutableArrayRef< unsigned > Digits)
	Parse digits from a string `Str` and fulfill `Digits` with the parsed numbers. More...

static bool	getDefaultModuleCachePath (SmallVectorImpl< char > &Result)
	Compute the default -fmodule-cache-path. More...

Public Attributes
std::string	Name
	The name the driver was invoked as. More...

std::string	Dir
	The path the driver executable was in, as invoked from the command line. More...

std::string	ClangExecutable
	The original path to the clang executable. More...

ParsedClangName	ClangNameParts
	Target and driver mode components extracted from clang executable name. More...

std::string	ResourceDir
	The path to the compiler resource directory. More...

std::string	SystemConfigDir
	System directory for config files. More...

std::string	UserConfigDir
	User directory for config files. More...

prefix_list	PrefixDirs

std::string	SysRoot
	sysroot, if present More...

std::string	DyldPrefix
	Dynamic loader prefix, if present. More...

std::string	DriverTitle
	Driver title to use with help. More...

std::string	HostBits
	Information about the host which can be overridden by the user. More...

std::string	HostMachine

std::string	HostSystem

std::string	HostRelease

std::string	CCPrintStatReportFilename
	The file to log CC_PRINT_PROC_STAT_FILE output to, if enabled. More...

std::string	CCPrintInternalStatReportFilename
	The file to log CC_PRINT_INTERNAL_STAT_FILE output to, if enabled. More...

std::string	CCPrintOptionsFilename
	The file to log CC_PRINT_OPTIONS output to, if enabled. More...

std::string	CCPrintHeadersFilename
	The file to log CC_PRINT_HEADERS output to, if enabled. More...

std::string	CCLogDiagnosticsFilename
	The file to log CC_LOG_DIAGNOSTICS output to, if enabled. More...

unsigned	CCCPrintBindings: 1
	Only print tool bindings, don't build any jobs. More...

unsigned	CCPrintOptions: 1
	Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to CCPrintOptionsFilename or to stderr. More...

HeaderIncludeFormatKind	CCPrintHeadersFormat = HIFMT_None
	The format of the header information that is emitted. More...

HeaderIncludeFilteringKind	CCPrintHeadersFiltering = HIFIL_None
	This flag determines whether clang should filter the header information that is emitted. More...

std::string	FlangF128MathLibrary
	Name of the library that provides implementations of IEEE-754 128-bit float math functions used by Fortran F128 runtime library. More...

unsigned	CCLogDiagnostics: 1
	Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics to CCLogDiagnosticsFilename or to stderr, in a stable machine readable format. More...

unsigned	CCGenDiagnostics: 1
	Whether the driver is generating diagnostics for debugging purposes. More...

unsigned	CCPrintProcessStats: 1
	Set CC_PRINT_PROC_STAT mode, which causes the driver to dump performance report to CC_PRINT_PROC_STAT_FILE or to stdout. More...

unsigned	CCPrintInternalStats: 1
	Set CC_PRINT_INTERNAL_STAT mode, which causes the driver to dump internal performance report to CC_PRINT_INTERNAL_STAT_FILE or to stdout. More...

CC1ToolFunc	CC1Main = nullptr

Primary Functionality
enum class	CommandStatus { Crash = 1 , Error , Ok }

enum class	ReproLevel { Off = 0 , OnCrash = static_cast<int>(CommandStatus::Crash) , OnError = static_cast<int>(CommandStatus::Error) , Always = static_cast<int>(CommandStatus::Ok) }

void	CreateOffloadingDeviceToolChains (Compilation &C, InputList &Inputs)
	CreateOffloadingDeviceToolChains - create all the toolchains required to support offloading devices given the programming models specified in the current compilation. More...

Compilation *	BuildCompilation (ArrayRef< const char * > Args)
	BuildCompilation - Construct a compilation object for a command line argument vector. More...

llvm::opt::InputArgList	ParseArgStrings (ArrayRef< const char * > Args, bool UseDriverMode, bool &ContainsError)
	ParseArgStrings - Parse the given list of strings into an ArgList. More...

void	BuildInputs (const ToolChain &TC, llvm::opt::DerivedArgList &Args, InputList &Inputs) const
	BuildInputs - Construct the list of inputs and their types from the given arguments. More...

void	BuildActions (Compilation &C, llvm::opt::DerivedArgList &Args, const InputList &Inputs, ActionList &Actions) const
	BuildActions - Construct the list of actions to perform for the given arguments, which are only done for a single architecture. More...

void	BuildUniversalActions (Compilation &C, const ToolChain &TC, const InputList &BAInputs) const
	BuildUniversalActions - Construct the list of actions to perform for the given arguments, which may require a universal build. More...

Action *	BuildOffloadingActions (Compilation &C, llvm::opt::DerivedArgList &Args, const InputTy &Input, Action *HostAction) const
	BuildOffloadingActions - Construct the list of actions to perform for the offloading toolchain that will be embedded in the host. More...

llvm::DenseSet< StringRef >	getOffloadArchs (Compilation &C, const llvm::opt::DerivedArgList &Args, Action::OffloadKind Kind, const ToolChain *TC, bool SuppressError=false) const
	Returns the set of bound architectures active for this offload kind. More...

bool	DiagnoseInputExistence (const llvm::opt::DerivedArgList &Args, StringRef Value, types::ID Ty, bool TypoCorrect) const
	Check that the file referenced by Value exists. More...

void	BuildJobs (Compilation &C) const
	BuildJobs - Bind actions to concrete tools and translate arguments to form the list of jobs to run. More...

int	ExecuteCompilation (Compilation &C, SmallVectorImpl< std::pair< int, const Command * > > &FailingCommands)
	ExecuteCompilation - Execute the compilation according to the command line arguments and return an appropriate exit code. More...

void	generateCompilationDiagnostics (Compilation &C, const Command &FailingCommand, StringRef AdditionalInformation="", CompilationDiagnosticReport *GeneratedReport=nullptr)
	generateCompilationDiagnostics - Generate diagnostics information including preprocessed source file(s). More...

bool	maybeGenerateCompilationDiagnostics (CommandStatus CS, ReproLevel Level, Compilation &C, const Command &FailingCommand, StringRef AdditionalInformation="", CompilationDiagnosticReport *GeneratedReport=nullptr)

Helper Methods
enum	DeviceMode { UnsetDeviceMode , FPGAHWMode , FPGAEmulationMode }

enum clang::driver::Driver::DeviceMode	OffloadCompileMode = UnsetDeviceMode

llvm::Triple	MakeSYCLDeviceTriple (StringRef TargetArch="spir64") const
	MakeSYCLDeviceTriple - Returns the SYCL device triple for the specified subarch. More...

void	PrintActions (const Compilation &C) const
	PrintActions - Print the list of actions. More...

void	PrintHelp (bool ShowHidden) const
	PrintHelp - Print the help text. More...

void	PrintSYCLToolHelp (const Compilation &C) const
	PrintSYCLToolHelp - Print help text from offline compiler tools. More...

void	PrintVersion (const Compilation &C, raw_ostream &OS) const
	PrintVersion - Print the driver version. More...

std::string	GetFilePath (StringRef Name, const ToolChain &TC) const
	GetFilePath - Lookup `Name` in the list of file search paths. More...

std::string	GetProgramPath (StringRef Name, const ToolChain &TC) const
	GetProgramPath - Lookup `Name` in the list of program search paths. More...

std::string	GetStdModuleManifestPath (const Compilation &C, const ToolChain &TC) const
	Lookup the path to the Standard library module manifest. More...

void	HandleAutocompletions (StringRef PassedFlags) const
	HandleAutocompletions - Handle –autocomplete by searching and printing possible flags, descriptions, and its arguments. More...

bool	HandleImmediateArgs (const Compilation &C)
	HandleImmediateArgs - Handle any arguments which should be treated before building actions or binding tools. More...

Action *	ConstructPhaseAction (Compilation &C, const llvm::opt::ArgList &Args, phases::ID Phase, Action *Input, Action::OffloadKind TargetDeviceOffloadKind=Action::OFK_None) const
	ConstructAction - Construct the appropriate action to do for `Phase` on the `Input`, taking in to account arguments like -fsyntax-only or –analyze. More...

InputInfoList	BuildJobsForAction (Compilation &C, const Action A, const ToolChain TC, StringRef BoundArch, bool AtTopLevel, bool MultipleArchs, const char LinkingOutput, std::map< std::pair< const Action , std::string >, InputInfoList > &CachedResults, Action::OffloadKind TargetDeviceOffloadKind) const
	BuildJobsForAction - Construct the jobs to perform for the action `A` and return an InputInfo for the result of running `A`. More...

const char *	getDefaultImageName () const
	Returns the default name for linked images (e.g., "a.out"). More...

const char *	CreateTempFile (Compilation &C, StringRef Prefix, StringRef Suffix, bool MultipleArchs=false, StringRef BoundArch={}, types::ID Type=types::TY_Nothing, bool NeedUniqueDirectory=false) const
	Creates a temp file. More...

const char *	GetNamedOutputPath (Compilation &C, const JobAction &JA, const char *BaseInput, StringRef BoundArch, bool AtTopLevel, bool MultipleArchs, StringRef NormalizedTriple) const
	GetNamedOutputPath - Return the name to use for the output of the action `JA`. More...

std::string	GetTemporaryPath (StringRef Prefix, StringRef Suffix) const
	GetTemporaryPath - Return the pathname of a temporary file to use as part of compilation; the file will have the given prefix and suffix. More...

std::string	GetUniquePath (StringRef BaseName, StringRef Ext) const
	GetUniquePath = Return the pathname of a unique file to use as part of compilation. More...

std::string	GetTemporaryDirectory (StringRef Prefix) const
	GetTemporaryDirectory - Return the pathname of a temporary directory to use as part of compilation; the directory will have the given prefix. More...

std::string	GetClPchPath (Compilation &C, StringRef BaseName) const
	Return the pathname of the pch file in clang-cl mode. More...

bool	ShouldUseClangCompiler (const JobAction &JA) const
	ShouldUseClangCompiler - Should the clang compiler be used to handle this action. More...

bool	ShouldUseFlangCompiler (const JobAction &JA) const
	ShouldUseFlangCompiler - Should the flang compiler be used to handle this action. More...

bool	ShouldEmitStaticLibrary (const llvm::opt::ArgList &Args) const
	ShouldEmitStaticLibrary - Should the linker emit a static library. More...

bool	hasHeaderMode () const
	Returns true if the user has indicated a C++20 header unit mode. More...

ModuleHeaderMode	getModuleHeaderMode () const
	Get the mode for handling headers as set by fmodule-header{=}. More...

bool	isUsingLTO (bool IsOffload=false) const
	Returns true if we are performing any kind of LTO. More...

LTOKind	getLTOMode (bool IsOffload=false) const
	Get the specific kind of LTO being performed. More...

bool	IsFPGAHWMode () const

bool	IsFPGAEmulationMode () const

void	setOffloadCompileMode (DeviceMode ModeValue)

DeviceMode	getOffloadCompileMode ()

Detailed Description

Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like command line arguments.

Definition at line 77 of file Driver.h.

Member Typedef Documentation

◆ CC1ToolFunc

using clang::driver::Driver::CC1ToolFunc = llvm::function_ref<int(SmallVectorImpl<const char *> &ArgV)>

Pointer to the ExecuteCC1Tool function, if available.

When the clangDriver lib is used through clang.exe, this provides a shortcut for executing the -cc1 command-line directly, in the same process.

Definition at line 282 of file Driver.h.

◆ InputList

using clang::driver::Driver::InputList = SmallVector<InputTy, 16>

A list of inputs and their types for the given arguments.

Definition at line 212 of file Driver.h.

◆ InputTy

using clang::driver::Driver::InputTy = std::pair<types::ID, const llvm::opt::Arg *>

An input type and its arguments.

Definition at line 209 of file Driver.h.

◆ prefix_list

typedef SmallVector<std::string, 4> clang::driver::Driver::prefix_list

A prefix directory used to emulate a limited subset of GCC's '-Bprefix' functionality.

FIXME: This type of customization should be removed in favor of the universal driver when it is ready.

Definition at line 178 of file Driver.h.

Member Enumeration Documentation

◆ CommandStatus

enum clang::driver::Driver::CommandStatus

strong

Enumerator
Crash
Error
Ok

Definition at line 557 of file Driver.h.

◆ DeviceMode

enum clang::driver::Driver::DeviceMode

Enumerator
UnsetDeviceMode
FPGAHWMode
FPGAEmulationMode

Definition at line 744 of file Driver.h.

◆ OpenMPRuntimeKind

enum clang::driver::Driver::OpenMPRuntimeKind

Enumerator
OMPRT_Unknown	An unknown OpenMP runtime. We can't generate effective OpenMP code without knowing what runtime to target.
OMPRT_OMP	The LLVM OpenMP runtime. When completed and integrated, this will become the default for Clang.
OMPRT_GOMP	The GNU OpenMP runtime. Clang doesn't support generating OpenMP code for this runtime but can swallow the pragmas, and find and link against the runtime library itself.
OMPRT_IOMP5	The legacy name for the LLVM OpenMP runtime from when it was the Intel OpenMP runtime. We support this mode for users with existing dependencies on this runtime library name.

Definition at line 125 of file Driver.h.

◆ ReproLevel

enum clang::driver::Driver::ReproLevel

strong

Enumerator
Off
OnCrash
OnError
Always

Definition at line 563 of file Driver.h.

Constructor & Destructor Documentation

◆ Driver()

Driver::Driver	(	StringRef	ClangExecutable,
		StringRef	TargetTriple,
		DiagnosticsEngine &	Diags,
		std::string	Title = `"clang LLVM compiler"`,
		IntrusiveRefCntPtr< llvm::vfs::FileSystem >	VFS = `nullptr`
	)

Definition at line 201 of file Driver.cpp.

References ClangExecutable, Dir, Name, P, SysRoot, SystemConfigDir, and UserConfigDir.

Member Function Documentation

◆ addFPGATempDepFile()

void clang::driver::Driver::addFPGATempDepFile	(	const std::string &	DepName,
		const std::string &	FileName
	)		const

inline

addFPGATempDepFile - Add a file to be added to the bundling step of an FPGA object.

Definition at line 921 of file Driver.h.

References clang::FileName.

◆ addIntegrationFiles()

void clang::driver::Driver::addIntegrationFiles	(	StringRef	IntHeaderName,
		StringRef	IntFooterName,
		StringRef	FileName
	)		const

inline

addIntegrationFiles - Add the integration files that will be populated by the device compilation and used by the host compile.

Definition at line 937 of file Driver.h.

References clang::FileName.

Referenced by BuildActions().

◆ addSYCLDeviceTraitsMacroArg()

void clang::driver::Driver::addSYCLDeviceTraitsMacroArg	(	const llvm::opt::ArgList &	Args,
		StringRef	Macro
	)		const

inline

SYCLDeviceTraitMacroArg - Add the given macro to the vector of args to be added to the device compilation step.

Definition at line 977 of file Driver.h.

◆ addSYCLTargetMacroArg()

void clang::driver::Driver::addSYCLTargetMacroArg	(	const llvm::opt::ArgList &	Args,
		StringRef	Macro
	)		const

inline

addSYCLTargetMacroArg - Add the given macro to the vector of args to be added to the host compilation step.

Definition at line 956 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ addSYCLUniqueID()

void clang::driver::Driver::addSYCLUniqueID	(	StringRef	UniqueID,
		StringRef	FileName
	)		const

inline

setSYCLUniqueID - set the Unique ID that is used for all FE invocations when performing compilations for SYCL.

Definition at line 967 of file Driver.h.

References clang::FileName.

Referenced by BuildActions().

◆ BuildActions()

void Driver::BuildActions	(	Compilation &	C,
		llvm::opt::DerivedArgList &	Args,
		const InputList &	Inputs,
		ActionList &	Actions
	)		const

BuildActions - Construct the list of actions to perform for the given arguments, which are only done for a single architecture.

Parameters

C	- The compilation that is being built.
Args	- The input arguments.
Actions	- The list to store the resulting actions onto.

Definition at line 7284 of file Driver.cpp.

References addIntegrationFiles(), addSYCLUniqueID(), Diag(), clang::driver::types::getCompilationPhases(), getOpts(), isSaveTempsEnabled(), clang::driver::types::isSrcFile(), clang::driver::Action::OFK_OpenMP, and V.

Referenced by BuildUniversalActions(), and generateCompilationDiagnostics().

◆ BuildCompilation()

Compilation * Driver::BuildCompilation ( ArrayRef< const char * > Args )

BuildCompilation - Construct a compilation object for a command line argument vector.

Returns: A compilation, or 0 if none was built for the given argument vector. A null return value does not necessarily indicate an error condition, the diagnostics should be queried to determine if an error occurred.

Definition at line 1559 of file Driver.cpp.

References appendOneArg(), CCCIsCC(), CCCPrintBindings, CCPrintProcessStats, CCPrintStatReportFilename, ClangExecutable, Diag(), Dir, DyldPrefix, clang::driver::getDriverMode(), IsCLMode(), IsDXCMode(), Name, ParseArgStrings(), clang::driver::toolchains::HLSLToolChain::parseTargetProfile(), PrefixDirs, ResourceDir, SysRoot, and clang::T.

Referenced by clang::createInvocation().

◆ BuildInputs()

void Driver::BuildInputs	(	const ToolChain &	TC,
		llvm::opt::DerivedArgList &	Args,
		InputList &	Inputs
	)		const

BuildInputs - Construct the list of inputs and their types from the given arguments.

Parameters

TC	- The default host tool chain.
Args	- The input arguments.
Inputs	- The list to store the resulting compilation inputs onto.

Definition at line 3106 of file Driver.cpp.

References CCCIsCPP(), CCCIsCXX(), CCGenDiagnostics, CXXHeaderUnitType(), Diag(), DiagnoseInputExistence(), clang::driver::Action::getKind(), getOpts(), clang::driver::types::getTypeName(), hasHeaderMode(), IsCLMode(), IsDXCMode(), IsFlangMode(), clang::driver::options::LinkerInput, clang::driver::types::lookupCXXTypeForCType(), clang::driver::ToolChain::LookupTypeForExtension(), clang::driver::types::lookupTypeForTypeSpecifier(), MakeInputArg(), Previous, and clang::driver::types::TY_INVALID.

Referenced by generateCompilationDiagnostics().

◆ BuildJobs()

void Driver::BuildJobs ( Compilation & C ) const

BuildJobs - Bind actions to concrete tools and translate arguments to form the list of jobs to run.

Parameters

C	- The compilation that is being built.

Definition at line 8224 of file Driver.cpp.

References clang::driver::Action::BindArchClass, BuildJobsForAction(), CCPrintProcessStats, CCPrintStatReportFilename, Cmd, clang::driver::Action::CompileJobClass, Diag(), getDefaultImageName(), clang::driver::Action::getInputs(), clang::driver::Action::getKind(), clang::driver::Action::getType(), clang::if(), clang::driver::Action::IfsMergeJobClass, clang::driver::Action::OffloadClass, clang::driver::Action::OFK_None, and clang::driver::Action::size().

Referenced by generateCompilationDiagnostics().

◆ BuildJobsForAction()

InputInfoList Driver::BuildJobsForAction	(	Compilation &	C,
		const Action *	A,
		const ToolChain *	TC,
		StringRef	BoundArch,
		bool	AtTopLevel,
		bool	MultipleArchs,
		const char *	LinkingOutput,
		std::map< std::pair< const Action *, std::string >, InputInfoList > &	CachedResults,
		Action::OffloadKind	TargetDeviceOffloadKind
	)		const

BuildJobsForAction - Construct the jobs to perform for the action A and return an InputInfo for the result of running A.

Will only construct jobs for a given (Action, ToolChain, BoundArch, DeviceKind) tuple once.

Definition at line 8782 of file Driver.cpp.

References GetTriplePlusArchString().

Referenced by BuildJobs().

◆ BuildOffloadingActions()

Action * Driver::BuildOffloadingActions	(	Compilation &	C,
		llvm::opt::DerivedArgList &	Args,
		const InputTy &	Input,
		Action *	HostAction
	)		const

BuildOffloadingActions - Construct the list of actions to perform for the offloading toolchain that will be embedded in the host.

Parameters

C	- The compilation that is being built.
Args	- The input arguments.
Input	- The input type and arguments
HostAction	- The host action used in the offloading toolchain.

Definition at line 7873 of file Driver.cpp.

◆ BuildUniversalActions()

void Driver::BuildUniversalActions	(	Compilation &	C,
		const ToolChain &	TC,
		const InputList &	BAInputs
	)		const

BuildUniversalActions - Construct the list of actions to perform for the given arguments, which may require a universal build.

Parameters

C	- The compilation that is being built.
TC	- The default host tool chain.

Definition at line 2927 of file Driver.cpp.

References BuildActions(), clang::driver::types::canLipoType(), ContainsCompileOrAssembleAction(), Diag(), clang::driver::tools::darwin::getArchTypeForMachOArchName(), clang::driver::ToolChain::getDefaultUniversalArchName(), clang::driver::types::getTypeName(), and clang::driver::willEmitRemarks().

Referenced by generateCompilationDiagnostics().

◆ CCCIsCC()

bool clang::driver::Driver::CCCIsCC ( ) const

inline

Whether the driver should follow gcc like behavior.

Definition at line 221 of file Driver.h.

Referenced by BuildCompilation().

◆ CCCIsCPP()

bool clang::driver::Driver::CCCIsCPP ( ) const

inline

Whether the driver is just the preprocessor.

Definition at line 218 of file Driver.h.

Referenced by BuildInputs(), CheckPreprocessingOptions(), and getFinalPhase().

◆ CCCIsCXX()

bool clang::driver::Driver::CCCIsCXX ( ) const

inline

Whether the driver should follow g++ like behavior.

Definition at line 215 of file Driver.h.

◆ ConstructPhaseAction()

Action * Driver::ConstructPhaseAction	(	Compilation &	C,
		const llvm::opt::ArgList &	Args,
		phases::ID	Phase,
		Action *	Input,
		Action::OffloadKind	TargetDeviceOffloadKind = `Action::OFK_None`
	)		const

ConstructAction - Construct the appropriate action to do for Phase on the Input, taking in to account arguments like -fsyntax-only or –analyze.

Definition at line 8060 of file Driver.cpp.

References clang::driver::phases::Assemble, clang::driver::phases::Backend, CCGenDiagnostics, clang::driver::phases::Compile, clang::driver::Action::getOffloadingToolChain(), clang::driver::types::getPrecompiledType(), clang::driver::types::getPreprocessedType(), clang::driver::ToolChain::getTriple(), clang::driver::Action::getType(), clang::driver::phases::IfsMerge, isUsingLTO(), clang::driver::phases::Link, offloadDeviceOnly(), clang::driver::Action::OFK_HIP, clang::driver::Action::OFK_None, clang::driver::Action::OFK_OpenMP, clang::driver::Action::OFK_SYCL, clang::driver::phases::Precompile, clang::driver::phases::Preprocess, and clang::driver::types::TY_INVALID.

Referenced by BuildOffloadingActions().

◆ createAppendedFooterInput()

void clang::driver::Driver::createAppendedFooterInput	(	Action *&	Input,
		Compilation &	C,
		const llvm::opt::ArgList &	Args
	)		const

createAppendedFooterInput - Create new source file.

◆ CreateOffloadingDeviceToolChains()

void Driver::CreateOffloadingDeviceToolChains	(	Compilation &	C,
		InputList &	Inputs
	)

CreateOffloadingDeviceToolChains - create all the toolchains required to support offloading devices given the programming models specified in the current compilation.

Also, update the host tool chain kind accordingly.

Definition at line 866 of file Driver.cpp.

References addSYCLDefaultTriple(), clang::driver::toolchains::NVPTXToolChain::CudaInstallation, clang::Device, Diag(), getDefaultSYCLArch(), getHIPOffloadTargetTriple(), getNVIDIAOffloadTargetTriple(), getOffloadArchs(), getOpenMPRuntime(), clang::driver::ToolChain::getOpenMPTriple(), clang::getProcessorFromTargetID(), clang::driver::ToolChain::getTriple(), clang::IsAMDGpuArch(), clang::driver::types::isCuda(), clang::driver::types::isHIP(), clang::IsNVIDIAGpuArch(), clang::driver::CudaInstallationDetector::isValid(), isValidSYCLTriple(), MakeSYCLDeviceTriple(), clang::driver::Action::OFK_Cuda, clang::driver::Action::OFK_HIP, clang::driver::Action::OFK_Host, clang::driver::Action::OFK_None, clang::driver::Action::OFK_OpenMP, clang::driver::Action::OFK_SYCL, OMPRT_IOMP5, OMPRT_OMP, clang::StringToCudaArch(), clang::T, and clang::driver::CudaInstallationDetector::WarnIfUnsupportedVersion().

◆ CreateTempFile()

const char * Driver::CreateTempFile	(	Compilation &	C,
		StringRef	Prefix,
		StringRef	Suffix,
		bool	MultipleArchs = `false`,
		StringRef	BoundArch = `{}`,
		types::ID	Type = `types::TY_Nothing`,
		bool	NeedUniqueDirectory = `false`
	)		const

Creates a temp file.

If MultipleArch is false or BoundArch is empty, the temp file is in the temporary directory with name $Prefix-%%%%%%.$Suffix.
If MultipleArch is true and BoundArch is not empty, 2a. If NeedUniqueDirectory is false, the temp file is in the temporary directory with name $Prefix-$BoundArch-%%%%%.$Suffix. 2b. If NeedUniqueDirectory is true, the temp file is in a unique subdiretory with random name under the temporary directory, and the temp file itself has name $Prefix-$BoundArch.$Suffix.

Definition at line 9377 of file Driver.cpp.

References CCGenDiagnostics, Diag(), GetTemporaryDirectory(), GetTemporaryPath(), and getVFS().

Referenced by generateCompilationDiagnostics(), and GetNamedOutputPath().

◆ Diag()

DiagnosticBuilder clang::driver::Driver::Diag ( unsigned DiagID ) const

inline

Definition at line 146 of file Driver.h.

References clang::DiagnosticsEngine::Report().

◆ DiagnoseInputExistence()

bool Driver::DiagnoseInputExistence	(	const llvm::opt::DerivedArgList &	Args,
		StringRef	Value,
		types::ID	Ty,
		bool	TypoCorrect
	)		const

Check that the file referenced by Value exists.

If it doesn't, issue a diagnostic and return false. If TypoCorrect is true and the file does not exist, see if it looks like a likely typo for a flag and if so print a "did you mean" blurb.

Definition at line 3015 of file Driver.cpp.

References Diag(), getCheckInputsExist(), getOpts(), getVFS(), and IsCLMode().

Referenced by BuildInputs().

◆ embedBitcodeEnabled()

bool clang::driver::Driver::embedBitcodeEnabled ( ) const

inline

Definition at line 434 of file Driver.h.

◆ embedBitcodeInObject()

bool clang::driver::Driver::embedBitcodeInObject ( ) const

inline

Definition at line 435 of file Driver.h.

◆ embedBitcodeMarkerOnly()

bool clang::driver::Driver::embedBitcodeMarkerOnly ( ) const

inline

Definition at line 436 of file Driver.h.

◆ ExecuteCompilation()

int Driver::ExecuteCompilation	(	Compilation &	C,
		SmallVectorImpl< std::pair< int, const Command * > > &	FailingCommands
	)

ExecuteCompilation - Execute the compilation according to the command line arguments and return an appropriate exit code.

This routine handles additional processing that must be done in addition to just running the subprocesses, for example reporting errors, setting up response files, removing temporary files, etc.

Definition at line 2313 of file Driver.cpp.

References Diag(), clang::driver::Command::getCreator(), clang::driver::Command::getDiagForErrorCode(), clang::driver::Tool::getShortName(), clang::driver::Command::getSource(), clang::DiagnosticsEngine::hasErrorOccurred(), clang::driver::Tool::hasGoodDiagnostics(), and isSaveTempsEnabled().

◆ generateCompilationDiagnostics()

void Driver::generateCompilationDiagnostics	(	Compilation &	C,
		const Command &	FailingCommand,
		StringRef	AdditionalInformation = `""`,
		CompilationDiagnosticReport *	GeneratedReport = `nullptr`
	)

generateCompilationDiagnostics - Generate diagnostics information including preprocessed source file(s).

Definition at line 2067 of file Driver.cpp.

References BugReporMsg, BuildActions(), BuildInputs(), BuildJobs(), BuildUniversalActions(), CCGenDiagnostics, Cmd, CreateTempFile(), Diag(), clang::driver::Command::Execute(), clang::driver::CrashReportInfo::Filename, clang::driver::Command::getArguments(), clang::getClangFullVersion(), clang::driver::Command::getCreator(), clang::driver::types::getPreprocessedType(), clang::driver::ToolChain::getTriple(), clang::DiagnosticErrorTrap::hasErrorOccurred(), clang::driver::Tool::isDsymutilJob(), clang::driver::Tool::isLinkJob(), Name, printArgList(), PrintVersion(), clang::driver::Command::replaceArguments(), clang::driver::Driver::CompilationDiagnosticReport::TemporaryFiles, and clang::driver::types::TY_INVALID.

Referenced by maybeGenerateCompilationDiagnostics().

◆ getCCCGenericGCCName()

const std::string& clang::driver::Driver::getCCCGenericGCCName ( ) const

inline

Name to use when invoking gcc/g++.

Definition at line 395 of file Driver.h.

Referenced by clang::driver::tools::gcc::Common::ConstructJob().

◆ getCheckInputsExist()

bool clang::driver::Driver::getCheckInputsExist ( ) const

inline

Definition at line 407 of file Driver.h.

Referenced by DiagnoseInputExistence().

◆ getClangProgramPath()

const char* clang::driver::Driver::getClangProgramPath ( ) const

inline

Get the path to the main clang executable.

Definition at line 425 of file Driver.h.

References ClangExecutable.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ GetClPchPath()

std::string Driver::GetClPchPath	(	Compilation &	C,
		StringRef	BaseName
	)		const

Return the pathname of the pch file in clang-cl mode.

Definition at line 9957 of file Driver.cpp.

Referenced by GetNamedOutputPath().

◆ getConfigFiles()

llvm::ArrayRef<std::string> clang::driver::Driver::getConfigFiles ( ) const

inline

Definition at line 397 of file Driver.h.

◆ getDefaultImageName()

const char * Driver::getDefaultImageName ( ) const

Returns the default name for linked images (e.g., "a.out").

Definition at line 9328 of file Driver.cpp.

References normalize().

Referenced by BuildJobs(), and GetNamedOutputPath().

◆ getDefaultModuleCachePath()

bool Driver::getDefaultModuleCachePath ( SmallVectorImpl< char > & Result )

static

Compute the default -fmodule-cache-path.

Returns: True if the system provides a default cache directory.

Definition at line 3950 of file Clang.cpp.

Referenced by RenderModulesOptions().

◆ getDeviceTraitsMacrosArgs()

llvm::opt::ArgStringList clang::driver::Driver::getDeviceTraitsMacrosArgs ( ) const

inline

Definition at line 981 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getDiags()

DiagnosticsEngine& clang::driver::Driver::getDiags ( ) const

inline

Definition at line 403 of file Driver.h.

Referenced by clang::driver::tools::Flang::ConstructJob(), clang::driver::toolchains::HIPAMDToolChain::getDeviceLibs(), clang::driver::toolchains::HIPAMDToolChain::HIPAMDToolChain(), RenderDiagnosticsOptions(), and shouldSkipSanitizeOption().

◆ GetFilePath()

std::string Driver::GetFilePath	(	StringRef	Name,
		const ToolChain &	TC
	)		const

GetFilePath - Lookup Name in the list of file search paths.

Parameters

TC	- The tool chain for additional information on directories to search.

Definition at line 9776 of file Driver.cpp.

References Dir, clang::driver::ToolChain::getCompilerRTPath(), clang::driver::ToolChain::getFilePaths(), clang::driver::ToolChain::getLibraryPaths(), Name, P, PrefixDirs, ResourceDir, and SysRoot.

Referenced by GetStdModuleManifestPath(), and HandleImmediateArgs().

◆ getFinalPhase()

phases::ID Driver::getFinalPhase	(	const llvm::opt::DerivedArgList &	DAL,
		llvm::opt::Arg **	FinalPhaseArg = `nullptr`
	)		const

Definition at line 370 of file Driver.cpp.

References clang::driver::phases::Assemble, clang::driver::phases::Backend, CCCIsCPP(), CCGenDiagnostics, clang::driver::phases::Compile, clang::driver::phases::IfsMerge, clang::driver::phases::Link, clang::driver::phases::Precompile, and clang::driver::phases::Preprocess.

Referenced by BuildOffloadingActions(), and clang::driver::types::getCompilationPhases().

◆ getFlangF128MathLibrary()

StringRef clang::driver::Driver::getFlangF128MathLibrary ( ) const

inline

Definition at line 444 of file Driver.h.

References FlangF128MathLibrary.

◆ getFPGATempDepFile()

const std::string clang::driver::Driver::getFPGATempDepFile ( const std::string & FileName ) const

inline

getFPGATempDepFile - Get a file to be added to the bundling step of an FPGA object.

Definition at line 927 of file Driver.h.

References clang::FileName.

◆ getIntegrationFooter()

StringRef clang::driver::Driver::getIntegrationFooter ( StringRef FileName ) const

inline

getIntegrationFooter - Get the integration footer file

Definition at line 947 of file Driver.h.

References clang::FileName.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getIntegrationHeader()

StringRef clang::driver::Driver::getIntegrationHeader ( StringRef FileName ) const

inline

getIntegrationHeader - Get the integration header file

Definition at line 943 of file Driver.h.

References clang::FileName.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getLTOMode()

LTOKind clang::driver::Driver::getLTOMode ( bool IsOffload = false ) const

inline

Get the specific kind of LTO being performed.

Definition at line 739 of file Driver.h.

◆ getModuleHeaderMode()

ModuleHeaderMode clang::driver::Driver::getModuleHeaderMode ( ) const

inline

Get the mode for handling headers as set by fmodule-header{=}.

Definition at line 731 of file Driver.h.

◆ GetNamedOutputPath()

const char * Driver::GetNamedOutputPath	(	Compilation &	C,
		const JobAction &	JA,
		const char *	BaseInput,
		StringRef	BoundArch,
		bool	AtTopLevel,
		bool	MultipleArchs,
		StringRef	NormalizedTriple
	)		const

GetNamedOutputPath - Return the name to use for the output of the action JA.

The result is appended to the compilation's list of temporary or result files, as appropriate.

Parameters

C	- The compilation.
JA	- The action of interest.
BaseInput	- The original input file that this action was triggered by.
BoundArch	- The bound architecture.
AtTopLevel	- Whether this is a "top-level" action.
MultipleArchs	- Whether multiple -arch options were supplied.
NormalizedTriple	- The normalized triple of the relevant target.

Definition at line 9440 of file Driver.cpp.

◆ getOffloadArchs()

llvm::DenseSet< StringRef > Driver::getOffloadArchs	(	Compilation &	C,
		const llvm::opt::DerivedArgList &	Args,
		Action::OffloadKind	Kind,
		const ToolChain *	TC,
		bool	SuppressError = `false`
	)		const

Returns the set of bound architectures active for this offload kind.

If there are no bound architctures we return a set containing only the empty string. The SuppressError option is used to suppress errors.

Definition at line 7769 of file Driver.cpp.

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

Referenced by BuildOffloadingActions(), and CreateOffloadingDeviceToolChains().

◆ getOffloadCompileMode()

DeviceMode clang::driver::Driver::getOffloadCompileMode ( )

inline

Definition at line 760 of file Driver.h.

References OffloadCompileMode.

◆ getOffloadStaticLibSeen()

bool clang::driver::Driver::getOffloadStaticLibSeen ( ) const

inline

Definition at line 914 of file Driver.h.

◆ getOpenMPRuntime()

Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime ( const llvm::opt::ArgList & Args ) const

Compute the desired OpenMP runtime from the flags provided.

Definition at line 791 of file Driver.cpp.

References Diag(), OMPRT_GOMP, OMPRT_IOMP5, OMPRT_OMP, and OMPRT_Unknown.

Referenced by clang::driver::tools::aix::Linker::ConstructJob(), clang::driver::tools::Flang::ConstructJob(), clang::driver::tools::MinGW::Linker::ConstructJob(), and CreateOffloadingDeviceToolChains().

◆ getOpts()

const llvm::opt::OptTable& clang::driver::Driver::getOpts ( ) const

inline

Definition at line 401 of file Driver.h.

References clang::driver::getDriverOptTable().

◆ getPrependArg()

const char* clang::driver::Driver::getPrependArg ( ) const

inline

Definition at line 414 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getProbePrecompiled()

bool clang::driver::Driver::getProbePrecompiled ( ) const

inline

Definition at line 411 of file Driver.h.

◆ GetProgramPath()

std::string Driver::GetProgramPath	(	StringRef	Name,
		const ToolChain &	TC
	)		const

GetProgramPath - Lookup Name in the list of program search paths.

Parameters

TC	- The provided tool chain for additional information on directories to search.

Definition at line 9836 of file Driver.cpp.

References Name, P, PrefixDirs, and ScanDirForExecutable().

Referenced by clang::driver::tools::Flang::ConstructJob(), and HandleImmediateArgs().

◆ GetReleaseVersion() [1/2]

bool Driver::GetReleaseVersion	(	StringRef	Str,
		MutableArrayRef< unsigned >	Digits
	)

static

Parse digits from a string Str and fulfill Digits with the parsed numbers.

This method assumes that the max number of digits to look for is equal to Digits.size().

Returns: True if the entire string was parsed and there are no extra characters remaining at the end.

Definition at line 10310 of file Driver.cpp.

◆ GetReleaseVersion() [2/2]

bool Driver::GetReleaseVersion	(	StringRef	Str,
		unsigned &	Major,
		unsigned &	Minor,
		unsigned &	Micro,
		bool &	HadExtra
	)

static

GetReleaseVersion - Parse (([0-9]+)(.

([0-9]+)(.([0-9]+)?))?)? and return the grouped values as integers. Numbers which are not provided are set to 0.

Returns: True if the entire string was parsed (9.2), or all groups were parsed (10.3.5extrastuff). HadExtra is true if all groups were parsed but extra characters remain at the end.

([0-9]+)(.([0-9]+)?))?)? and return the grouped values as integers. Numbers which are not provided are set to 0.

Returns: True if the entire string was parsed (9.2), or all groups were parsed (10.3.5extrastuff).

Definition at line 10275 of file Driver.cpp.

Referenced by getSystemOrSDKMacOSVersion().

◆ GetResourcesPath()

std::string Driver::GetResourcesPath	(	StringRef	BinaryPath,
		StringRef	CustomResourceDir = `""`
	)

static

Takes the path to a binary that's either in bin/ or lib/ and returns the path to clang's resource directory.

Definition at line 173 of file Driver.cpp.

References P.

◆ GetStdModuleManifestPath()

std::string Driver::GetStdModuleManifestPath	(	const Compilation &	C,
		const ToolChain &	TC
	)		const

Lookup the path to the Standard library module manifest.

Parameters

C	- The compilation.
TC	- The tool chain for additional information on directories to search.

Definition at line 9878 of file Driver.cpp.

References clang::driver::ToolChain::CST_Libcxx, clang::driver::ToolChain::CST_Libstdcxx, clang::driver::ToolChain::GetCXXStdlibType(), GetFilePath(), and clang::driver::ToolChain::getVFS().

Referenced by HandleImmediateArgs().

◆ getSYCLTargetMacroArgs()

llvm::ArrayRef<std::string> clang::driver::Driver::getSYCLTargetMacroArgs ( ) const

inline

getSYCLTargetMacroArgs - return the previously gathered macro target args.

Definition at line 961 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getSYCLUniqueID()

StringRef clang::driver::Driver::getSYCLUniqueID ( StringRef FileName ) const

inline

getSYCLUniqueID - Get the Unique ID associated with the file.

Definition at line 971 of file Driver.h.

References clang::FileName.

Referenced by clang::driver::tools::Clang::ConstructJob().

◆ getTargetTriple()

std::string clang::driver::Driver::getTargetTriple ( ) const

inline

Definition at line 422 of file Driver.h.

Referenced by computeBaseSysRoot(), clang::driver::tools::aix::Assembler::ConstructJob(), clang::driver::tools::aix::Linker::ConstructJob(), getLiteralTriple(), GetSDLFromOffloadArchive(), and clang::driver::toolchains::RISCVToolChain::hasGCCToolchain().

◆ GetTemporaryDirectory()

std::string Driver::GetTemporaryDirectory ( StringRef Prefix ) const

GetTemporaryDirectory - Return the pathname of a temporary directory to use as part of compilation; the directory will have the given prefix.

Definition at line 9946 of file Driver.cpp.

References Diag().

Referenced by CreateTempFile().

◆ GetTemporaryPath()

std::string Driver::GetTemporaryPath	(	StringRef	Prefix,
		StringRef	Suffix
	)		const

GetTemporaryPath - Return the pathname of a temporary file to use as part of compilation; the file will have the given prefix and suffix.

GCC goes to extra lengths here to be a bit more robust.

Definition at line 9923 of file Driver.cpp.

References Diag().

Referenced by CreateTempFile(), GetNamedOutputPath(), and GetSDLFromOffloadArchive().

◆ getTitle()

const std::string& clang::driver::Driver::getTitle ( )

inline

Definition at line 419 of file Driver.h.

References DriverTitle.

◆ GetUniquePath()

std::string Driver::GetUniquePath	(	StringRef	BaseName,
		StringRef	Ext
	)		const

GetUniquePath = Return the pathname of a unique file to use as part of compilation.

The file will have the given base name (BaseName) and extension (Ext).

Definition at line 9934 of file Driver.cpp.

References Diag().

Referenced by GetNamedOutputPath().

◆ getUseNewOffloadingDriver()

bool clang::driver::Driver::getUseNewOffloadingDriver ( ) const

inline

getUseNewOffloadingDriver - use the new offload driver for OpenMP.

Definition at line 917 of file Driver.h.

Referenced by clang::driver::tools::LinkerWrapper::ConstructJob().

◆ getVFS()

llvm::vfs::FileSystem& clang::driver::Driver::getVFS ( ) const

inline

Definition at line 405 of file Driver.h.

◆ HandleAutocompletions()

void Driver::HandleAutocompletions ( StringRef PassedFlags ) const

HandleAutocompletions - Handle –autocomplete by searching and printing possible flags, descriptions, and its arguments.

Definition at line 2520 of file Driver.cpp.

References clang::driver::options::CC1Option, clang::driver::options::ClangOption, clang::driver::options::FlangOption, getOpts(), clang::driver::options::Ignored, IsFlangMode(), and clang::driver::options::Unsupported.

Referenced by HandleImmediateArgs().

◆ HandleImmediateArgs()

bool Driver::HandleImmediateArgs ( const Compilation & C )

HandleImmediateArgs - Handle any arguments which should be treated before building actions or binding tools.

Returns: Whether any compilation should be built for this invocation.

Definition at line 2607 of file Driver.cpp.

◆ hasHeaderMode()

bool clang::driver::Driver::hasHeaderMode ( ) const

inline

Returns true if the user has indicated a C++20 header unit mode.

Definition at line 728 of file Driver.h.

References clang::driver::HeaderMode_None.

Referenced by BuildInputs().

◆ IsCLMode()

bool clang::driver::Driver::IsCLMode ( ) const

inline

Whether the driver should follow cl.exe like behavior.

Definition at line 224 of file Driver.h.

Referenced by BuildCompilation(), BuildInputs(), CheckPreprocessingOptions(), clang::driver::tools::Clang::ConstructJob(), DiagnoseInputExistence(), clang::driver::Compilation::ExecuteJobs(), GetNamedOutputPath(), ParseArgStrings(), and renderDebugOptions().

◆ isDumpDeviceCodeEnabled()

bool clang::driver::Driver::isDumpDeviceCodeEnabled ( ) const

inline

Definition at line 429 of file Driver.h.

Referenced by clang::driver::Compilation::CleanupFile().

◆ IsDXCMode()

bool clang::driver::Driver::IsDXCMode ( ) const

inline

Whether the driver should follow dxc.exe like behavior.

Definition at line 231 of file Driver.h.

Referenced by BuildCompilation(), BuildInputs(), and GetNamedOutputPath().

◆ IsFlangMode()

bool clang::driver::Driver::IsFlangMode ( ) const

inline

Whether the driver should invoke flang for fortran inputs.

Other modes fall back to calling gcc which in turn calls gfortran.

Definition at line 228 of file Driver.h.

◆ IsFPGAEmulationMode()

bool clang::driver::Driver::IsFPGAEmulationMode ( ) const

inline

Definition at line 752 of file Driver.h.

References FPGAEmulationMode, and OffloadCompileMode.

◆ IsFPGAHWMode()

bool clang::driver::Driver::IsFPGAHWMode ( ) const

inline

Definition at line 750 of file Driver.h.

References FPGAHWMode, and OffloadCompileMode.

◆ isSaveTempsEnabled()

bool clang::driver::Driver::isSaveTempsEnabled ( ) const

inline

Definition at line 431 of file Driver.h.

Referenced by BuildActions(), ExecuteCompilation(), GetNamedOutputPath(), clang::driver::Compilation::initCompilationForDiagnostics(), and clang::driver::Compilation::~Compilation().

◆ isSaveTempsObj()

bool clang::driver::Driver::isSaveTempsObj ( ) const

inline

Definition at line 432 of file Driver.h.

Referenced by GetNamedOutputPath().

◆ isSYCLDefaultTripleImplied()

bool clang::driver::Driver::isSYCLDefaultTripleImplied ( ) const

inline

isSYCLDefaultTripleImplied - The default SYCL triple (spir64) has been added or should be added given proper criteria.

Definition at line 933 of file Driver.h.

◆ isUsingLTO()

bool clang::driver::Driver::isUsingLTO ( bool IsOffload = false ) const

inline

Returns true if we are performing any kind of LTO.

Definition at line 734 of file Driver.h.

References getLTOMode(), and clang::driver::LTOK_None.

◆ MakeSYCLDeviceTriple()

llvm::Triple Driver::MakeSYCLDeviceTriple ( StringRef TargetArch = "spir64" ) const

MakeSYCLDeviceTriple - Returns the SYCL device triple for the specified subarch.

Definition at line 2408 of file Driver.cpp.

Referenced by CreateOffloadingDeviceToolChains(), and PrintSYCLToolHelp().

◆ maybeGenerateCompilationDiagnostics()

bool clang::driver::Driver::maybeGenerateCompilationDiagnostics	(	CommandStatus	CS,
		ReproLevel	Level,
		Compilation &	C,
		const Command &	FailingCommand,
		StringRef	AdditionalInformation = `""`,
		CompilationDiagnosticReport *	GeneratedReport = `nullptr`
	)

inline

Definition at line 570 of file Driver.h.

References Crash, generateCompilationDiagnostics(), clang::DiagnosticsEngine::Report(), and clang::DiagnosticsEngine::setLastDiagnosticIgnored().

◆ offloadDeviceOnly()

bool clang::driver::Driver::offloadDeviceOnly ( ) const

inline

Definition at line 439 of file Driver.h.

Referenced by clang::driver::toolchains::CudaToolChain::addClangTargetOptions(), clang::driver::toolchains::HIPAMDToolChain::addClangTargetOptions(), BuildOffloadingActions(), ConstructPhaseAction(), and GetNamedOutputPath().

◆ offloadHostOnly()

bool clang::driver::Driver::offloadHostOnly ( ) const

inline

Definition at line 438 of file Driver.h.

Referenced by BuildOffloadingActions().

◆ ParseArgStrings()

InputArgList Driver::ParseArgStrings	(	ArrayRef< const char * >	Args,
		bool	UseDriverMode,
		bool &	ContainsError
	)

ParseArgStrings - Parse the given list of strings into an ArgList.

Definition at line 275 of file Driver.cpp.

References clang::driver::options::CC1Option, clang::driver::options::Deprecated, Diag(), clang::DiagnosticsEngine::getDiagnosticLevel(), getOpts(), IsCLMode(), clang::DiagnosticsEngine::Report(), clang::driver::options::Unsupported, Used, and clang::DiagnosticsEngine::Warning.

Referenced by BuildCompilation().

◆ PrintActions()

void Driver::PrintActions ( const Compilation & C ) const

PrintActions - Print the list of actions.

Definition at line 2911 of file Driver.cpp.

References PrintActions1().

◆ PrintHelp()

void Driver::PrintHelp ( bool ShowHidden ) const

PrintHelp - Print the help text.

Parameters

ShowHidden - Show hidden options.

Definition at line 2399 of file Driver.cpp.

References DriverTitle, getOpts(), and Name.

Referenced by HandleImmediateArgs().

◆ PrintSYCLToolHelp()

void Driver::PrintSYCLToolHelp ( const Compilation & C ) const

PrintSYCLToolHelp - Print help text from offline compiler tools.

Definition at line 2425 of file Driver.cpp.

References MakeSYCLDeviceTriple(), and clang::T.

Referenced by HandleImmediateArgs().

◆ PrintVersion()

void Driver::PrintVersion	(	const Compilation &	C,
		raw_ostream &	OS
	)		const

PrintVersion - Print the driver version.

Definition at line 2477 of file Driver.cpp.

References Dir, clang::getClangFullVersion(), clang::getClangToolFullVersion(), clang::driver::ToolChain::getThreadModel(), clang::driver::ToolChain::getTripleString(), IsFlangMode(), and clang::driver::ToolChain::isThreadModelSupported().

Referenced by generateCompilationDiagnostics(), and HandleImmediateArgs().

◆ setCheckInputsExist()

void clang::driver::Driver::setCheckInputsExist ( bool Value )

inline

Definition at line 409 of file Driver.h.

Referenced by clang::createInvocation().

◆ setFlangF128MathLibrary()

void clang::driver::Driver::setFlangF128MathLibrary ( std::string name )

inline

Definition at line 441 of file Driver.h.

References FlangF128MathLibrary, and clang::transformer::name().

◆ setOffloadCompileMode()

void clang::driver::Driver::setOffloadCompileMode ( DeviceMode ModeValue )

inline

Definition at line 756 of file Driver.h.

References OffloadCompileMode.

◆ setPrependArg()

void clang::driver::Driver::setPrependArg ( const char * Value )

inline

Definition at line 415 of file Driver.h.

◆ setProbePrecompiled()

void clang::driver::Driver::setProbePrecompiled ( bool Value )

inline

Definition at line 412 of file Driver.h.

Referenced by clang::createInvocation().

◆ setTargetAndMode()

void clang::driver::Driver::setTargetAndMode ( const ParsedClangName & TM )

inline

Definition at line 417 of file Driver.h.

References ClangNameParts.

◆ setTitle()

void clang::driver::Driver::setTitle ( std::string Value )

inline

Definition at line 420 of file Driver.h.

References DriverTitle.

Referenced by newDriver().

◆ ShouldEmitStaticLibrary()

bool Driver::ShouldEmitStaticLibrary ( const llvm::opt::ArgList & Args ) const

ShouldEmitStaticLibrary - Should the linker emit a static library.

Definition at line 10263 of file Driver.cpp.

◆ ShouldUseClangCompiler()

bool Driver::ShouldUseClangCompiler ( const JobAction & JA ) const

ShouldUseClangCompiler - Should the clang compiler be used to handle this action.

Definition at line 10234 of file Driver.cpp.

References clang::driver::Action::input_begin(), clang::driver::types::isAcceptedByClang(), and clang::driver::Action::size().

◆ ShouldUseFlangCompiler()

bool Driver::ShouldUseFlangCompiler ( const JobAction & JA ) const

ShouldUseFlangCompiler - Should the flang compiler be used to handle this action.

Definition at line 10249 of file Driver.cpp.

References clang::driver::Action::input_begin(), clang::driver::types::isAcceptedByFlang(), and clang::driver::Action::size().

Member Data Documentation

◆ CC1Main

CC1ToolFunc clang::driver::Driver::CC1Main = nullptr

Definition at line 284 of file Driver.h.

◆ CCCPrintBindings

unsigned clang::driver::Driver::CCCPrintBindings

Only print tool bindings, don't build any jobs.

Definition at line 235 of file Driver.h.

Referenced by BuildCompilation().

◆ CCGenDiagnostics

unsigned clang::driver::Driver::CCGenDiagnostics

Whether the driver is generating diagnostics for debugging purposes.

Definition at line 266 of file Driver.h.

Referenced by BuildInputs(), ConstructPhaseAction(), CreateTempFile(), generateCompilationDiagnostics(), getFinalPhase(), and GetNamedOutputPath().

◆ CCLogDiagnostics

unsigned clang::driver::Driver::CCLogDiagnostics

Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics to CCLogDiagnosticsFilename or to stderr, in a stable machine readable format.

Definition at line 262 of file Driver.h.

◆ CCLogDiagnosticsFilename

std::string clang::driver::Driver::CCLogDiagnosticsFilename

The file to log CC_LOG_DIAGNOSTICS output to, if enabled.

Definition at line 206 of file Driver.h.

◆ CCPrintHeadersFilename

std::string clang::driver::Driver::CCPrintHeadersFilename

The file to log CC_PRINT_HEADERS output to, if enabled.

Definition at line 203 of file Driver.h.

◆ CCPrintHeadersFiltering

HeaderIncludeFilteringKind clang::driver::Driver::CCPrintHeadersFiltering = HIFIL_None

This flag determines whether clang should filter the header information that is emitted.

If enviroment variable CC_PRINT_HEADERS_FILTERING is set to "only-direct-system", only system headers that are directly included from non-system headers are emitted.

Definition at line 251 of file Driver.h.

◆ CCPrintHeadersFormat

HeaderIncludeFormatKind clang::driver::Driver::CCPrintHeadersFormat = HIFMT_None

The format of the header information that is emitted.

If CC_PRINT_HEADERS is set, the format is textual. Otherwise, the format is determined by the enviroment variable CC_PRINT_HEADERS_FORMAT.

Definition at line 245 of file Driver.h.

◆ CCPrintInternalStatReportFilename

std::string clang::driver::Driver::CCPrintInternalStatReportFilename

The file to log CC_PRINT_INTERNAL_STAT_FILE output to, if enabled.

Definition at line 197 of file Driver.h.

Referenced by clang::driver::tools::getStatsFileName().

◆ CCPrintInternalStats

unsigned clang::driver::Driver::CCPrintInternalStats

Set CC_PRINT_INTERNAL_STAT mode, which causes the driver to dump internal performance report to CC_PRINT_INTERNAL_STAT_FILE or to stdout.

Definition at line 276 of file Driver.h.

Referenced by clang::driver::tools::getStatsFileName().

◆ CCPrintOptions

unsigned clang::driver::Driver::CCPrintOptions

Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to CCPrintOptionsFilename or to stderr.

Definition at line 240 of file Driver.h.

◆ CCPrintOptionsFilename

std::string clang::driver::Driver::CCPrintOptionsFilename

The file to log CC_PRINT_OPTIONS output to, if enabled.

Definition at line 200 of file Driver.h.

◆ CCPrintProcessStats

unsigned clang::driver::Driver::CCPrintProcessStats

Set CC_PRINT_PROC_STAT mode, which causes the driver to dump performance report to CC_PRINT_PROC_STAT_FILE or to stdout.

Definition at line 271 of file Driver.h.

Referenced by BuildCompilation(), and BuildJobs().

◆ CCPrintStatReportFilename

std::string clang::driver::Driver::CCPrintStatReportFilename

The file to log CC_PRINT_PROC_STAT_FILE output to, if enabled.

Definition at line 194 of file Driver.h.

Referenced by BuildCompilation(), and BuildJobs().

◆ ClangExecutable

std::string clang::driver::Driver::ClangExecutable

The original path to the clang executable.

Definition at line 160 of file Driver.h.

Referenced by BuildCompilation(), clang::driver::tools::aix::Linker::ConstructJob(), Driver(), and getClangProgramPath().

◆ ClangNameParts

ParsedClangName clang::driver::Driver::ClangNameParts

Target and driver mode components extracted from clang executable name.

Definition at line 163 of file Driver.h.

Referenced by setTargetAndMode().

◆ Dir

std::string clang::driver::Driver::Dir

The path the driver executable was in, as invoked from the command line.

Definition at line 157 of file Driver.h.

◆ DriverTitle

std::string clang::driver::Driver::DriverTitle

Driver title to use with help.

Definition at line 188 of file Driver.h.

Referenced by getTitle(), PrintHelp(), and setTitle().

◆ DyldPrefix

std::string clang::driver::Driver::DyldPrefix

Dynamic loader prefix, if present.

Definition at line 185 of file Driver.h.

Referenced by BuildCompilation(), clang::driver::tools::fuchsia::Linker::ConstructJob(), and clang::driver::tools::gnutools::Linker::ConstructJob().

◆ FlangF128MathLibrary

std::string clang::driver::Driver::FlangF128MathLibrary

Name of the library that provides implementations of IEEE-754 128-bit float math functions used by Fortran F128 runtime library.

It should be linked as needed by the linker job.

Definition at line 256 of file Driver.h.

Referenced by getFlangF128MathLibrary(), and setFlangF128MathLibrary().

◆ HostBits

std::string clang::driver::Driver::HostBits

Information about the host which can be overridden by the user.

Definition at line 191 of file Driver.h.

◆ HostMachine

std::string clang::driver::Driver::HostMachine

Definition at line 191 of file Driver.h.

◆ HostRelease

std::string clang::driver::Driver::HostRelease

Definition at line 191 of file Driver.h.

◆ HostSystem

std::string clang::driver::Driver::HostSystem

Definition at line 191 of file Driver.h.

◆ Name

std::string clang::driver::Driver::Name

The name the driver was invoked as.

Definition at line 153 of file Driver.h.

Referenced by BuildCompilation(), Driver(), generateCompilationDiagnostics(), GetFilePath(), GetNamedOutputPath(), GetProgramPath(), PrintHelp(), and ScanDirForExecutable().

◆ OffloadCompileMode

enum clang::driver::Driver::DeviceMode clang::driver::Driver::OffloadCompileMode = UnsetDeviceMode

Referenced by getOffloadCompileMode(), IsFPGAEmulationMode(), IsFPGAHWMode(), and setOffloadCompileMode().

◆ PrefixDirs

prefix_list clang::driver::Driver::PrefixDirs

Definition at line 179 of file Driver.h.

Referenced by clang::driver::toolchains::HexagonToolChain::AddClangSystemIncludeArgs(), clang::driver::toolchains::HexagonToolChain::addLibCxxIncludePaths(), clang::driver::toolchains::HexagonToolChain::addLibStdCxxIncludePaths(), BuildCompilation(), constructHexagonLinkArgs(), GetFilePath(), clang::driver::toolchains::HexagonToolChain::getHexagonLibraryPaths(), GetProgramPath(), HandleImmediateArgs(), and clang::driver::toolchains::HexagonToolChain::HexagonToolChain().

◆ ResourceDir

std::string clang::driver::Driver::ResourceDir

The path to the compiler resource directory.

Definition at line 166 of file Driver.h.

◆ SysRoot

std::string clang::driver::Driver::SysRoot

sysroot, if present

Definition at line 182 of file Driver.h.

◆ SystemConfigDir

std::string clang::driver::Driver::SystemConfigDir

System directory for config files.

Definition at line 169 of file Driver.h.

Referenced by Driver(), and HandleImmediateArgs().

◆ UserConfigDir

std::string clang::driver::Driver::UserConfigDir

User directory for config files.

Definition at line 172 of file Driver.h.

Referenced by Driver(), and HandleImmediateArgs().

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

include/clang/Driver/Driver.h
lib/Driver/Driver.cpp
lib/Driver/ToolChains/Clang.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Primary Functionality

Helper Methods

Detailed Description

Member Typedef Documentation

◆ CC1ToolFunc

◆ InputList

◆ InputTy

◆ prefix_list

Member Enumeration Documentation

◆ CommandStatus

◆ DeviceMode

◆ OpenMPRuntimeKind

◆ ReproLevel

Constructor & Destructor Documentation

◆ Driver()

Member Function Documentation

◆ addFPGATempDepFile()

◆ addIntegrationFiles()

◆ addSYCLDeviceTraitsMacroArg()

◆ addSYCLTargetMacroArg()

◆ addSYCLUniqueID()

◆ BuildActions()

◆ BuildCompilation()

◆ BuildInputs()

◆ BuildJobs()

◆ BuildJobsForAction()

◆ BuildOffloadingActions()

◆ BuildUniversalActions()

◆ CCCIsCC()

◆ CCCIsCPP()

◆ CCCIsCXX()

◆ ConstructPhaseAction()

◆ createAppendedFooterInput()

◆ CreateOffloadingDeviceToolChains()

◆ CreateTempFile()

◆ Diag()

◆ DiagnoseInputExistence()

◆ embedBitcodeEnabled()

◆ embedBitcodeInObject()

◆ embedBitcodeMarkerOnly()

◆ ExecuteCompilation()

◆ generateCompilationDiagnostics()

◆ getCCCGenericGCCName()

◆ getCheckInputsExist()

◆ getClangProgramPath()

◆ GetClPchPath()

◆ getConfigFiles()

◆ getDefaultImageName()

◆ getDefaultModuleCachePath()

◆ getDeviceTraitsMacrosArgs()

◆ getDiags()

◆ GetFilePath()

◆ getFinalPhase()

◆ getFlangF128MathLibrary()

◆ getFPGATempDepFile()

◆ getIntegrationFooter()

◆ getIntegrationHeader()

◆ getLTOMode()

◆ getModuleHeaderMode()

◆ GetNamedOutputPath()

◆ getOffloadArchs()

◆ getOffloadCompileMode()

◆ getOffloadStaticLibSeen()

◆ getOpenMPRuntime()

◆ getOpts()

◆ getPrependArg()

◆ getProbePrecompiled()

◆ GetProgramPath()

◆ GetReleaseVersion() [1/2]

◆ GetReleaseVersion() [2/2]

◆ GetResourcesPath()

◆ GetStdModuleManifestPath()

◆ getSYCLTargetMacroArgs()

◆ getSYCLUniqueID()

◆ getTargetTriple()