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

#include "clang/Driver/Driver.h"

Collaboration diagram for clang::driver::Driver:

[legend]

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

typedef SmallVector< std::pair< types::ID, const llvm::opt::Arg * >, 16 >	InputList
	A list of inputs and their types for the given arguments. 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...

	Driver (StringRef ClangExecutable, StringRef TargetTriple, DiagnosticsEngine &Diags, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)

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

const std::string &	getConfigFile () const

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

const DiagnosticsEngine &	getDiags () const

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

bool	getCheckInputsExist () const

void	setCheckInputsExist (bool 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...

const char *	getInstalledDir () const
	Get the path to where the clang executable was installed. More...

void	setInstalledDir (StringRef Value)

bool	isSaveTempsEnabled () const

bool	isSaveTempsObj () const

bool	embedBitcodeEnabled () const

bool	embedBitcodeInObject () const

bool	embedBitcodeMarkerOnly () const

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

Primary Functionality
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...

Driver Steps
void	ParseDriverMode (StringRef ProgramName, ArrayRef< const char *> Args)
	ParseDriverMode - Look for and handle the driver mode option in Args. More...

llvm::opt::InputArgList	ParseArgStrings (ArrayRef< const char *> Args, bool IsClCompatMode, 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...

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

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 void	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	InstalledDir
	The path to the installed clang directory, if any. 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

const char *	CCPrintOptionsFilename
	The file to log CC_PRINT_OPTIONS output to, if enabled. More...

const char *	CCPrintHeadersFilename
	The file to log CC_PRINT_HEADERS output to, if enabled. More...

const char *	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...

unsigned	CCPrintHeaders: 1
	Set CC_PRINT_HEADERS mode, which causes the frontend to log header include information to CCPrintHeadersFilename or to stderr. 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	GenReproducer: 1
	Force clang to emit reproducer for driver invocation. More...

Helper Methods
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	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...

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

InputInfo	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 >, InputInfo > &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 *	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	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	isUsingLTO () const
	Returns true if we are performing any kind of LTO. More...

LTOKind	getLTOMode () const
	Get the specific kind of LTO being performed. More...

Detailed Description

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

Definition at line 59 of file Driver.h.

Member Typedef Documentation

◆ InputList

typedef SmallVector<std::pair<types::ID, const llvm::opt::Arg *>, 16> clang::driver::Driver::InputList

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

Definition at line 169 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 143 of file Driver.h.

Member Enumeration Documentation

◆ 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 87 of file Driver.h.

Constructor & Destructor Documentation

◆ Driver()

Driver::Driver	(	StringRef	ClangExecutable,
		StringRef	TargetTriple,
		DiagnosticsEngine &	Diags,
		IntrusiveRefCntPtr< llvm::vfs::FileSystem >	VFS = `nullptr`
	)

Definition at line 120 of file Driver.cpp.

References Dir, GetResourcesPath(), InstalledDir, Name, ResourceDir, SystemConfigDir, and UserConfigDir.

Member Function Documentation

◆ 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 3332 of file Driver.cpp.

References Diag(), clang::driver::types::getCompilationPhases(), 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 934 of file Driver.cpp.

References ClangExecutable, IsCLMode(), ParseArgStrings(), ParseDriverMode(), PrefixDirs, and Split.

Referenced by clang::createInvocationFromCommandLine().

◆ 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 2060 of file Driver.cpp.

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 3617 of file Driver.cpp.

References BuildJobsForAction(), clang::driver::Tool::canEmitIR(), Diag(), clang::EmbedBitcode(), clang::driver::Compilation::getActions(), clang::driver::Compilation::getArgs(), getDefaultImageName(), clang::driver::Compilation::getDefaultToolChain(), clang::driver::Action::getInputs(), clang::driver::Action::getOffloadingDeviceKind(), clang::driver::ToolChain::getTriple(), clang::driver::Action::getType(), clang::driver::Tool::hasIntegratedAssembler(), clang::driver::Tool::hasIntegratedCPP(), IsCLMode(), clang::driver::Action::isCollapsingWithNextDependentActionLegal(), clang::driver::options::NoArgumentUnused, clang::driver::Action::OFK_None, and clang::driver::ToolChain::SelectTool().

Referenced by generateCompilationDiagnostics().

◆ BuildJobsForAction()

InputInfo 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 >, InputInfo > &	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 4027 of file Driver.cpp.

Referenced by BuildJobs().

◆ 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 1924 of file Driver.cpp.

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

Referenced by generateCompilationDiagnostics().

◆ CCCIsCC()

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

inline

Whether the driver should follow gcc like behavior.

Definition at line 178 of file Driver.h.

◆ CCCIsCPP()

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

inline

Whether the driver is just the preprocessor.

Definition at line 175 of file Driver.h.

Referenced by BuildInputs(), CheckPreprocessingOptions(), clang::driver::types::getCompilationPhases(), and ParseArgStrings().

◆ CCCIsCXX()

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

inline

Whether the driver should follow g++ like behavior.

Definition at line 172 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 3513 of file Driver.cpp.

References clang::driver::phases::Assemble, clang::driver::phases::Backend, CCGenDiagnostics, clang::driver::phases::Compile, clang::driver::types::getPrecompiledType(), clang::driver::types::getPreprocessedType(), clang::driver::Action::getType(), clang::driver::phases::IfsMerge, isUsingLTO(), clang::driver::phases::Link, clang::driver::Compilation::MakeAction(), clang::driver::Action::OFK_None, clang::driver::phases::Precompile, clang::driver::phases::Preprocess, and clang::driver::types::TY_INVALID.

Referenced by BuildInputs().

◆ 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 597 of file Driver.cpp.

References clang::driver::Compilation::addOffloadDeviceToolChain(), Diag(), clang::driver::Compilation::getInputArgs(), getOpenMPRuntime(), clang::driver::Compilation::getSingleOffloadToolChain(), clang::driver::ToolChain::getTriple(), clang::driver::types::isCuda(), clang::driver::types::isHIP(), clang::driver::Action::OFK_Cuda, clang::driver::Action::OFK_HIP, clang::driver::Action::OFK_Host, clang::driver::Action::OFK_OpenMP, OMPRT_IOMP5, and OMPRT_OMP.

◆ Diag()

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

inline

Definition at line 108 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 2011 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 338 of file Driver.h.

Referenced by shouldLinkerNotDedup().

◆ embedBitcodeInObject()

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

inline

Definition at line 339 of file Driver.h.

References clang::EmbedBitcode().

Referenced by BuildJobsForAction(), and clang::driver::tools::Clang::ConstructJob().

◆ embedBitcodeMarkerOnly()

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

inline

Definition at line 340 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob(), and shouldLinkerNotDedup().

◆ 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 1447 of file Driver.cpp.

References clang::driver::Compilation::CleanupFileMap(), Diag(), clang::driver::Compilation::ExecuteJobs(), clang::driver::Compilation::getArgs(), clang::driver::Command::getCreator(), clang::driver::Compilation::getFailureResultFiles(), clang::driver::Compilation::getJobs(), clang::driver::Compilation::getResultFiles(), clang::driver::Tool::getShortName(), clang::driver::Command::getSource(), clang::driver::Tool::hasGoodDiagnostics(), isSaveTempsEnabled(), and clang::driver::JobList::Print().

◆ 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 1243 of file Driver.cpp.

◆ getCCCGenericGCCName()

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

inline

Name to use when invoking gcc/g++.

Definition at line 299 of file Driver.h.

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

◆ getCheckInputsExist()

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

inline

Definition at line 309 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 321 of file Driver.h.

Referenced by clang::driver::tools::Clang::ConstructJob(), and clang::driver::tools::ClangAs::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 4674 of file Driver.cpp.

References clang::driver::Compilation::getArgs(), clang::driver::toolchains::BareMetal::handlesTarget(), and clang::Target.

Referenced by GetNamedOutputPath(), and RelocationModelName().

◆ getConfigFile()

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

inline

Definition at line 301 of file Driver.h.

◆ getDefaultImageName()

const char * Driver::getDefaultImageName ( ) const

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

Definition at line 4321 of file Driver.cpp.

References normalize(), and clang::Target.

Referenced by BuildJobs(), BuildJobsForAction(), and GetNamedOutputPath().

◆ getDefaultModuleCachePath()

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

static

Compute the default -fmodule-cache-path.

Definition at line 2691 of file Clang.cpp.

References appendUserToPath().

Referenced by RenderModulesOptions().

◆ getDiags()

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

inline

Definition at line 305 of file Driver.h.

Referenced by RenderDiagnosticsOptions().

◆ 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 4550 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 HandleImmediateArgs().

◆ getInstalledDir()

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

inline

Get the path to where the clang executable was installed.

Definition at line 326 of file Driver.h.

Referenced by clang::driver::toolchains::HexagonToolChain::AddClangSystemIncludeArgs(), clang::driver::toolchains::Linux::computeSysRoot(), clang::driver::toolchains::HexagonToolChain::getHexagonLibraryPaths(), and clang::driver::toolchains::HexagonToolChain::HexagonToolChain().

◆ getLTOMode()

LTOKind clang::driver::Driver::getLTOMode ( ) const

inline

Get the specific kind of LTO being performed.

Definition at line 541 of file Driver.h.

References clang::driver::isOptimizationLevelFast(), and clang::Target.

Referenced by clang::driver::tools::fuchsia::Linker::ConstructJob(), clang::driver::tools::cloudabi::Linker::ConstructJob(), clang::driver::tools::freebsd::Linker::ConstructJob(), clang::driver::tools::ananas::Linker::ConstructJob(), clang::driver::tools::RISCV::Linker::ConstructJob(), clang::driver::tools::gnutools::Linker::ConstructJob(), clang::driver::tools::Clang::ConstructJob(), and shouldLinkerNotDedup().

◆ 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 4359 of file Driver.cpp.

References clang::driver::Compilation::addResultFile(), clang::driver::Compilation::addTempFile(), clang::driver::types::appendSuffixForType(), CCGenDiagnostics, Diag(), End, clang::driver::Compilation::getArgs(), GetClPchPath(), getDefaultImageName(), clang::driver::Action::getOffloadingDeviceKind(), GetTemporaryPath(), clang::driver::Action::getType(), clang::driver::types::getTypeTempSuffix(), getVFS(), IsCLMode(), isSaveTempsEnabled(), isSaveTempsObj(), MakeCLOutputFilename(), Name, clang::driver::Action::OFK_HIP, and Split.

Referenced by BuildJobsForAction().

◆ getOpenMPRuntime()

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

Compute the desired OpenMP runtime from the flags provided.

Definition at line 572 of file Driver.cpp.

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

Referenced by clang::driver::tools::MinGW::Linker::ConstructJob(), clang::driver::tools::Clang::ConstructJob(), CreateOffloadingDeviceToolChains(), and clang::driver::tools::isUseSeparateSections().

◆ getOpts()

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

inline

Definition at line 303 of file Driver.h.

References clang::driver::getDriverOptTable().

Referenced by BuildInputs(), DiagnoseInputExistence(), getStaticPIE(), HandleAutocompletions(), MakeInputArg(), ParseArgStrings(), ParseDriverMode(), PrintHelp(), clang::driver::toolchains::AMDGPUToolChain::TranslateArgs(), clang::driver::toolchains::MSVCToolChain::TranslateArgs(), clang::driver::toolchains::HIPToolChain::TranslateArgs(), clang::driver::toolchains::CudaToolChain::TranslateArgs(), clang::driver::toolchains::MachO::TranslateArgs(), clang::driver::toolchains::Generic_GCC::TranslateArgs(), clang::driver::toolchains::Darwin::TranslateArgs(), and clang::driver::ToolChain::TranslateOpenMPTargetArgs().

◆ 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 4618 of file Driver.cpp.

References P, PrefixDirs, and ScanDirForExecutable().

Referenced by HandleImmediateArgs().

◆ GetReleaseVersion() [1/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 4880 of file Driver.cpp.

Referenced by getSystemOrSDKMacOSVersion(), and shouldLinkerNotDedup().

◆ GetReleaseVersion() [2/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 4918 of file Driver.cpp.

References clang::driver::options::CLOption, clang::driver::options::CoreOption, clang::driver::isOptimizationLevelFast(), and clang::driver::options::NoDriverOption.

◆ 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 94 of file Driver.cpp.

References P.

Referenced by Driver().

◆ getTargetTriple()

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

inline

Definition at line 318 of file Driver.h.

◆ 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 4663 of file Driver.cpp.

References Diag().

Referenced by shouldLinkerNotDedup().

◆ 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 4652 of file Driver.cpp.

References Diag().

Referenced by generateCompilationDiagnostics(), GetNamedOutputPath(), and shouldLinkerNotDedup().

◆ getTitle()

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

inline

Definition at line 315 of file Driver.h.

◆ getVFS()

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

inline

Definition at line 307 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 1567 of file Driver.cpp.

References getOpts(), clang::driver::options::Ignored, clang::driver::options::NoDriverOption, 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 1648 of file Driver.cpp.

◆ IsCLMode()

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

inline

Whether the driver should follow cl.exe like behavior.

Definition at line 181 of file Driver.h.

Referenced by BuildCompilation(), BuildInputs(), BuildJobs(), CheckPreprocessingOptions(), clang::driver::tools::visualstudio::Linker::ConstructJob(), clang::driver::tools::Clang::ConstructJob(), DiagnoseInputExistence(), clang::driver::Compilation::ExecuteJobs(), GetNamedOutputPath(), ParseArgStrings(), PrintHelp(), and searchForFile().

◆ isSaveTempsEnabled()

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

inline

Definition at line 335 of file Driver.h.

Referenced by BuildJobsForAction(), clang::driver::tools::AMDGCN::Linker::ConstructJob(), clang::driver::tools::Clang::ConstructJob(), ExecuteCompilation(), GetNamedOutputPath(), clang::driver::Compilation::initCompilationForDiagnostics(), and clang::driver::Compilation::~Compilation().

◆ isSaveTempsObj()

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

inline

Definition at line 336 of file Driver.h.

Referenced by GetNamedOutputPath().

◆ isUsingLTO()

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

inline

Returns true if we are performing any kind of LTO.

Definition at line 538 of file Driver.h.

References clang::driver::LTOK_None.

Referenced by BuildJobsForAction(), clang::driver::tools::fuchsia::Linker::ConstructJob(), clang::driver::tools::cloudabi::Linker::ConstructJob(), clang::driver::tools::ananas::Linker::ConstructJob(), clang::driver::tools::freebsd::Linker::ConstructJob(), clang::driver::tools::RISCV::Linker::ConstructJob(), clang::driver::tools::gnutools::Linker::ConstructJob(), clang::driver::tools::Clang::ConstructJob(), ConstructPhaseAction(), clang::driver::SanitizerArgs::SanitizerArgs(), and shouldLinkerNotDedup().

◆ ParseArgStrings()

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

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

Definition at line 186 of file Driver.cpp.

References clang::driver::phases::Assemble, clang::driver::phases::Backend, CCCIsCPP(), clang::driver::phases::Compile, Diag(), clang::DiagnosticsEngine::getDiagnosticLevel(), getOpts(), clang::driver::phases::IfsMerge, IsCLMode(), clang::driver::phases::Link, clang::driver::phases::Precompile, clang::driver::phases::Preprocess, clang::DiagnosticsEngine::Report(), clang::driver::options::Unsupported, and clang::DiagnosticsEngine::Warning.

Referenced by BuildCompilation(), and searchForFile().

◆ ParseDriverMode()

void Driver::ParseDriverMode	(	StringRef	ProgramName,
		ArrayRef< const char *>	Args
	)

ParseDriverMode - Look for and handle the driver mode option in Args.

Definition at line 153 of file Driver.cpp.

References ClangNameParts, Diag(), clang::driver::ParsedClangName::DriverMode, getOpts(), clang::driver::ToolChain::getTargetAndModeFromProgramName(), and clang::driver::ParsedClangName::isEmpty().

Referenced by BuildCompilation().

◆ PrintActions()

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

PrintActions - Print the list of actions.

Definition at line 1904 of file Driver.cpp.

References clang::driver::Compilation::getActions(), and PrintActions1().

◆ PrintHelp()

void Driver::PrintHelp ( bool ShowHidden ) const

PrintHelp - Print the help text.

Parameters

ShowHidden - Show hidden options.

Definition at line 1518 of file Driver.cpp.

References DriverTitle, getOpts(), IsCLMode(), Name, and clang::driver::options::NoDriverOption.

Referenced by HandleImmediateArgs().

◆ PrintVersion()

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

PrintVersion - Print the driver version.

Definition at line 1534 of file Driver.cpp.

References clang::driver::Compilation::getArgs(), clang::getClangFullVersion(), clang::driver::Compilation::getDefaultToolChain(), clang::driver::ToolChain::getThreadModel(), clang::driver::ToolChain::getTripleString(), InstalledDir, and clang::driver::ToolChain::isThreadModelSupported().

Referenced by generateCompilationDiagnostics(), and HandleImmediateArgs().

◆ setCheckInputsExist()

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

inline

Definition at line 311 of file Driver.h.

Referenced by clang::createInvocationFromCommandLine().

◆ setInstalledDir()

void clang::driver::Driver::setInstalledDir ( StringRef Value )

inline

Definition at line 331 of file Driver.h.

◆ setTargetAndMode()

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

inline

Definition at line 313 of file Driver.h.

◆ setTitle()

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

inline

Definition at line 316 of file Driver.h.

Referenced by newDriver().

◆ ShouldUseClangCompiler()

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

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

Definition at line 4861 of file Driver.cpp.

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

Member Data Documentation

◆ CCCPrintBindings

unsigned clang::driver::Driver::CCCPrintBindings

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

Definition at line 184 of file Driver.h.

Referenced by BuildJobsForAction().

◆ CCGenDiagnostics

unsigned clang::driver::Driver::CCGenDiagnostics

Whether the driver is generating diagnostics for debugging purposes.

Definition at line 200 of file Driver.h.

Referenced by BuildJobsForAction(), clang::driver::tools::Clang::ConstructJob(), ConstructPhaseAction(), generateCompilationDiagnostics(), 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 197 of file Driver.h.

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

◆ CCLogDiagnosticsFilename

const char* clang::driver::Driver::CCLogDiagnosticsFilename

The file to log CC_LOG_DIAGNOSTICS output to, if enabled.

Definition at line 165 of file Driver.h.

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

◆ CCPrintHeaders

unsigned clang::driver::Driver::CCPrintHeaders

Set CC_PRINT_HEADERS mode, which causes the frontend to log header include information to CCPrintHeadersFilename or to stderr.

Definition at line 192 of file Driver.h.

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

◆ CCPrintHeadersFilename

const char* clang::driver::Driver::CCPrintHeadersFilename

The file to log CC_PRINT_HEADERS output to, if enabled.

Definition at line 162 of file Driver.h.

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

◆ 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 188 of file Driver.h.

◆ CCPrintOptionsFilename

const char* clang::driver::Driver::CCPrintOptionsFilename

The file to log CC_PRINT_OPTIONS output to, if enabled.

Definition at line 159 of file Driver.h.

◆ ClangExecutable

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

The original path to the clang executable.

Definition at line 122 of file Driver.h.

Referenced by BuildCompilation(), and ParseAArch64BranchProtection().

◆ ClangNameParts

ParsedClangName clang::driver::Driver::ClangNameParts

Target and driver mode components extracted from clang executable name.

Definition at line 125 of file Driver.h.

Referenced by ParseDriverMode(), and searchForFile().

◆ Dir

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

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

Definition at line 119 of file Driver.h.

Referenced by clang::driver::toolchains::NaClToolChain::AddClangSystemIncludeArgs(), clang::driver::toolchains::NaClToolChain::addLibCxxIncludePaths(), clang::driver::toolchains::NetBSD::addLibCxxIncludePaths(), clang::driver::tools::AMDGCN::constructHIPFatbinCommand(), Driver(), clang::driver::toolchains::Fuchsia::Fuchsia(), GetFilePath(), clang::driver::tools::isUseSeparateSections(), clang::driver::toolchains::MyriadToolChain::MyriadToolChain(), clang::driver::toolchains::PS4CPU::PS4CPU(), searchForFile(), and shouldLinkerNotDedup().

◆ DriverTitle

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

Driver title to use with help.

Definition at line 153 of file Driver.h.

Referenced by PrintHelp().

◆ DyldPrefix

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

Dynamic loader prefix, if present.

Definition at line 150 of file Driver.h.

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

◆ GenReproducer

unsigned clang::driver::Driver::GenReproducer

Force clang to emit reproducer for driver invocation.

This is enabled indirectly by setting FORCE_CLANG_DIAGNOSTICS_CRASH environment variable or when using the -gen-reproducer driver flag.

Definition at line 232 of file Driver.h.

◆ HostBits

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

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

Definition at line 156 of file Driver.h.

◆ HostMachine

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

Definition at line 156 of file Driver.h.

◆ HostRelease

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

Definition at line 156 of file Driver.h.

◆ HostSystem

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

Definition at line 156 of file Driver.h.

◆ InstalledDir

std::string clang::driver::Driver::InstalledDir

The path to the installed clang directory, if any.

Definition at line 128 of file Driver.h.

Referenced by clang::driver::toolchains::HexagonToolChain::addLibStdCxxIncludePaths(), constructHexagonLinkArgs(), Driver(), clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::init(), and PrintVersion().

◆ Name

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

The name the driver was invoked as.

Definition at line 115 of file Driver.h.

Referenced by BuildJobsForAction(), Driver(), generateCompilationDiagnostics(), GetFilePath(), GetNamedOutputPath(), printArgList(), PrintHelp(), and ScanDirForExecutable().

◆ PrefixDirs

prefix_list clang::driver::Driver::PrefixDirs

Definition at line 144 of file Driver.h.

Referenced by clang::driver::toolchains::HexagonToolChain::AddClangSystemIncludeArgs(), clang::driver::toolchains::HexagonToolChain::addLibStdCxxIncludePaths(), BuildCompilation(), constructHexagonLinkArgs(), GetFilePath(), clang::driver::toolchains::HexagonToolChain::getHexagonLibraryPaths(), GetProgramPath(), clang::driver::toolchains::HexagonToolChain::HexagonToolChain(), and clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::init().

◆ ResourceDir

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

The path to the compiler resource directory.

Definition at line 131 of file Driver.h.

◆ SysRoot

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

sysroot, if present

Definition at line 147 of file Driver.h.

◆ SystemConfigDir

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

System directory for config files.

Definition at line 134 of file Driver.h.

Referenced by Driver(), HandleImmediateArgs(), and searchForFile().

◆ UserConfigDir

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

User directory for config files.

Definition at line 137 of file Driver.h.

Referenced by Driver(), HandleImmediateArgs(), and searchForFile().

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

Helper Methods

Detailed Description

Member Typedef Documentation

◆ InputList

◆ prefix_list

Member Enumeration Documentation

◆ OpenMPRuntimeKind

Constructor & Destructor Documentation

◆ Driver()

Member Function Documentation

◆ BuildActions()

◆ BuildCompilation()

◆ BuildInputs()

◆ BuildJobs()

◆ BuildJobsForAction()

◆ BuildUniversalActions()

◆ CCCIsCC()

◆ CCCIsCPP()

◆ CCCIsCXX()

◆ ConstructPhaseAction()

◆ CreateOffloadingDeviceToolChains()

◆ Diag()

◆ DiagnoseInputExistence()

◆ embedBitcodeEnabled()

◆ embedBitcodeInObject()

◆ embedBitcodeMarkerOnly()

◆ ExecuteCompilation()

◆ generateCompilationDiagnostics()

◆ getCCCGenericGCCName()

◆ getCheckInputsExist()

◆ getClangProgramPath()

◆ GetClPchPath()

◆ getConfigFile()

◆ getDefaultImageName()

◆ getDefaultModuleCachePath()

◆ getDiags()

◆ GetFilePath()

◆ getInstalledDir()

◆ getLTOMode()

◆ GetNamedOutputPath()

◆ getOpenMPRuntime()

◆ getOpts()

◆ GetProgramPath()

◆ GetReleaseVersion() [1/2]

◆ GetReleaseVersion() [2/2]

◆ GetResourcesPath()

◆ getTargetTriple()

◆ GetTemporaryDirectory()

◆ GetTemporaryPath()

◆ getTitle()

◆ getVFS()

◆ HandleAutocompletions()

◆ HandleImmediateArgs()

◆ IsCLMode()

◆ isSaveTempsEnabled()

◆ isSaveTempsObj()

◆ isUsingLTO()

◆ ParseArgStrings()

◆ ParseDriverMode()

◆ PrintActions()

◆ PrintHelp()

◆ PrintVersion()

◆ setCheckInputsExist()

◆ setInstalledDir()

◆ setTargetAndMode()

◆ setTitle()

◆ ShouldUseClangCompiler()

Member Data Documentation

◆ CCCPrintBindings

◆ CCGenDiagnostics

◆ CCLogDiagnostics

◆ CCLogDiagnosticsFilename

◆ CCPrintHeaders

◆ CCPrintHeadersFilename

◆ CCPrintOptions