clang
13.0.0git
|
Compilation - A set of tasks to perform for a single driver invocation. More...
#include "clang/Driver/Compilation.h"
Public Types | |
using | const_offload_toolchains_iterator = const std::multimap< Action::OffloadKind, const ToolChain * >::const_iterator |
Iterator that visits device toolchains of a given kind. More... | |
using | const_offload_toolchains_range = std::pair< const_offload_toolchains_iterator, const_offload_toolchains_iterator > |
Public Member Functions | |
Compilation (const Driver &D, const ToolChain &DefaultToolChain, llvm::opt::InputArgList *Args, llvm::opt::DerivedArgList *TranslatedArgs, bool ContainsError) | |
~Compilation () | |
const Driver & | getDriver () const |
const ToolChain & | getDefaultToolChain () const |
unsigned | isOffloadingHostKind (Action::OffloadKind Kind) const |
template<Action::OffloadKind Kind> | |
const_offload_toolchains_range | getOffloadToolChains () const |
template<Action::OffloadKind Kind> | |
bool | hasOffloadToolChain () const |
Return true if an offloading tool chain of a given kind exists. More... | |
template<Action::OffloadKind Kind> | |
const ToolChain * | getSingleOffloadToolChain () const |
Return an offload toolchain of the provided kind. More... | |
void | addOffloadDeviceToolChain (const ToolChain *DeviceToolChain, Action::OffloadKind OffloadKind) |
const llvm::opt::InputArgList & | getInputArgs () const |
const llvm::opt::DerivedArgList & | getArgs () const |
llvm::opt::DerivedArgList & | getArgs () |
ActionList & | getActions () |
const ActionList & | getActions () const |
template<typename T , typename... Args> | |
T * | MakeAction (Args &&... Arg) |
Creates a new Action owned by this Compilation. More... | |
JobList & | getJobs () |
const JobList & | getJobs () const |
void | addCommand (std::unique_ptr< Command > C) |
const llvm::opt::ArgStringList & | getTempFiles () const |
const ArgStringMap & | getResultFiles () const |
const ArgStringMap & | getFailureResultFiles () const |
void | setPostCallback (const std::function< void(const Command &, int)> &CB) |
Installs a handler that is executed when a compilation job is finished. More... | |
StringRef | getSysRoot () const |
Returns the sysroot path. More... | |
const llvm::opt::DerivedArgList & | getArgsForToolChain (const ToolChain *TC, StringRef BoundArch, Action::OffloadKind DeviceOffloadKind) |
getArgsForToolChain - Return the derived argument list for the tool chain TC (or the default tool chain, if TC is not specified). More... | |
const char * | addTempFile (const char *Name) |
addTempFile - Add a file to remove on exit, and returns its argument. More... | |
const char * | addResultFile (const char *Name, const JobAction *JA) |
addResultFile - Add a file to remove on failure, and returns its argument. More... | |
const char * | addFailureResultFile (const char *Name, const JobAction *JA) |
addFailureResultFile - Add a file to remove if we crash, and returns its argument. More... | |
bool | CleanupFile (const char *File, bool IssueErrors=false) const |
CleanupFile - Delete a given file. More... | |
bool | CleanupFileList (const llvm::opt::ArgStringList &Files, bool IssueErrors=false) const |
CleanupFileList - Remove the files in the given list. More... | |
bool | CleanupFileMap (const ArgStringMap &Files, const JobAction *JA, bool IssueErrors=false) const |
CleanupFileMap - Remove the files in the given map. More... | |
int | ExecuteCommand (const Command &C, const Command *&FailingCommand) const |
ExecuteCommand - Execute an actual command. More... | |
void | ExecuteJobs (const JobList &Jobs, SmallVectorImpl< std::pair< int, const Command * >> &FailingCommands) const |
ExecuteJob - Execute a single job. More... | |
void | initCompilationForDiagnostics () |
initCompilationForDiagnostics - Remove stale state and suppress output so compilation can be reexecuted to generate additional diagnostic information (e.g., preprocessed source(s)). More... | |
bool | isForDiagnostics () const |
Return true if we're compiling for diagnostics. More... | |
bool | containsError () const |
Return whether an error during the parsing of the input args. More... | |
void | setContainsError () |
Force driver to fail before toolchain is created. More... | |
void | Redirect (ArrayRef< Optional< StringRef >> Redirects) |
Redirect - Redirect output of this compilation. More... | |
Compilation - A set of tasks to perform for a single driver invocation.
Definition at line 45 of file Compilation.h.
using clang::driver::Compilation::const_offload_toolchains_iterator = const std::multimap<Action::OffloadKind, const ToolChain *>::const_iterator |
Iterator that visits device toolchains of a given kind.
Definition at line 149 of file Compilation.h.
using clang::driver::Compilation::const_offload_toolchains_range = std::pair<const_offload_toolchains_iterator, const_offload_toolchains_iterator> |
Definition at line 152 of file Compilation.h.
Compilation::Compilation | ( | const Driver & | D, |
const ToolChain & | DefaultToolChain, | ||
llvm::opt::InputArgList * | Args, | ||
llvm::opt::DerivedArgList * | TranslatedArgs, | ||
bool | ContainsError | ||
) |
Definition at line 36 of file Compilation.cpp.
References clang::driver::Action::OFK_Host.
Compilation::~Compilation | ( | ) |
Definition at line 46 of file Compilation.cpp.
References CleanupFileList(), and clang::driver::Driver::isSaveTempsEnabled().
|
inline |
Definition at line 210 of file Compilation.h.
References clang::driver::JobList::addJob().
|
inline |
addFailureResultFile - Add a file to remove if we crash, and returns its argument.
Definition at line 259 of file Compilation.h.
|
inline |
Definition at line 178 of file Compilation.h.
References clang::driver::Action::OFK_Host, and clang::driver::Action::OFK_None.
|
inline |
addResultFile - Add a file to remove on failure, and returns its argument.
Definition at line 252 of file Compilation.h.
|
inline |
addTempFile - Add a file to remove on exit, and returns its argument.
Definition at line 245 of file Compilation.h.
CleanupFile - Delete a given file.
IssueErrors | - Report failures as errors. |
Definition at line 112 of file Compilation.cpp.
References clang::driver::Driver::Diag(), clang::File, getDriver(), and clang::transformer::remove().
Referenced by CleanupFileList(), and CleanupFileMap().
bool Compilation::CleanupFileList | ( | const llvm::opt::ArgStringList & | Files, |
bool | IssueErrors = false |
||
) | const |
CleanupFileList - Remove the files in the given list.
IssueErrors | - Report failures as errors. |
Definition at line 142 of file Compilation.cpp.
References CleanupFile(), and clang::File.
Referenced by initCompilationForDiagnostics(), and ~Compilation().
bool Compilation::CleanupFileMap | ( | const ArgStringMap & | Files, |
const JobAction * | JA, | ||
bool | IssueErrors = false |
||
) | const |
CleanupFileMap - Remove the files in the given map.
JA | - If specified, only delete the files associated with this JobAction. Otherwise, delete all files in the map. |
IssueErrors | - Report failures as errors. |
Definition at line 150 of file Compilation.cpp.
References CleanupFile(), and clang::File.
|
inline |
Return whether an error during the parsing of the input args.
Definition at line 311 of file Compilation.h.
ExecuteCommand - Execute an actual command.
FailingCommand | - For non-zero results, this will be set to the Command which failed, if any. |
Definition at line 164 of file Compilation.cpp.
References clang::driver::Driver::Diag(), getArgs(), getDriver(), and string().
Referenced by ExecuteJobs().
void Compilation::ExecuteJobs | ( | const JobList & | Jobs, |
SmallVectorImpl< std::pair< int, const Command * >> & | FailingCommands | ||
) | const |
ExecuteJob - Execute a single job.
FailingCommands | - For non-zero results, this will be a vector of failing commands and their associated result code. |
Definition at line 239 of file Compilation.cpp.
References ExecuteCommand(), InputsOk(), and clang::driver::Driver::IsCLMode().
|
inline |
Definition at line 195 of file Compilation.h.
Referenced by getCC1Arguments().
|
inline |
Definition at line 196 of file Compilation.h.
|
inline |
Definition at line 193 of file Compilation.h.
|
inline |
Definition at line 191 of file Compilation.h.
Referenced by ExecuteCommand().
const DerivedArgList & Compilation::getArgsForToolChain | ( | const ToolChain * | TC, |
StringRef | BoundArch, | ||
Action::OffloadKind | DeviceOffloadKind | ||
) |
getArgsForToolChain - Return the derived argument list for the tool chain TC
(or the default tool chain, if TC is not specified).
If a device offloading kind is specified, a translation specific for that kind is performed, if any.
BoundArch | - The bound architecture name, or 0. |
DeviceOffloadKind | - The offload device kind that should be used in the translation, if any. |
Definition at line 62 of file Compilation.cpp.
References clang::driver::ToolChain::getTriple(), clang::driver::Action::OFK_OpenMP, clang::driver::ToolChain::TranslateArgs(), clang::driver::ToolChain::TranslateOpenMPTargetArgs(), and clang::driver::ToolChain::TranslateXarchArgs().
|
inline |
Definition at line 140 of file Compilation.h.
|
inline |
Definition at line 138 of file Compilation.h.
Referenced by CleanupFile(), ExecuteCommand(), and getSysRoot().
|
inline |
Definition at line 216 of file Compilation.h.
|
inline |
Definition at line 189 of file Compilation.h.
|
inline |
Definition at line 207 of file Compilation.h.
Referenced by getCC1Arguments().
|
inline |
Definition at line 208 of file Compilation.h.
|
inline |
Definition at line 155 of file Compilation.h.
|
inline |
Definition at line 214 of file Compilation.h.
|
inline |
Return an offload toolchain of the provided kind.
Only one is expected to exist.
Definition at line 168 of file Compilation.h.
StringRef Compilation::getSysRoot | ( | ) | const |
Returns the sysroot path.
Definition at line 301 of file Compilation.cpp.
References getDriver(), and clang::driver::Driver::SysRoot.
|
inline |
Definition at line 212 of file Compilation.h.
|
inline |
Return true if an offloading tool chain of a given kind exists.
Definition at line 160 of file Compilation.h.
void Compilation::initCompilationForDiagnostics | ( | ) |
initCompilationForDiagnostics - Remove stale state and suppress output so compilation can be reexecuted to generate additional diagnostic information (e.g., preprocessed source(s)).
Definition at line 258 of file Compilation.cpp.
References CleanupFileList(), clang::driver::JobList::clear(), and clang::driver::Driver::isSaveTempsEnabled().
|
inline |
Return true if we're compiling for diagnostics.
Definition at line 308 of file Compilation.h.
|
inline |
Definition at line 142 of file Compilation.h.
|
inline |
Creates a new Action owned by this Compilation.
The new Action is not added to the list returned by getActions().
Definition at line 201 of file Compilation.h.
Redirect - Redirect output of this compilation.
Can only be done once.
Redirects | - array of optional paths. The array should have a size of three. The inferior process's stdin(0), stdout(1), and stderr(2) will be redirected to the corresponding paths, if provided (not llvm::None). |
Definition at line 305 of file Compilation.cpp.
|
inline |
Force driver to fail before toolchain is created.
This is necessary when error happens in action builder.
Definition at line 315 of file Compilation.h.
|
inline |
Installs a handler that is executed when a compilation job is finished.
The arguments of the callback specify the compilation job as an instance of class Command and the exit status of the child process executed that job.
Definition at line 224 of file Compilation.h.