Go to the documentation of this file.
9 #ifndef LLVM_CLANG_DRIVER_COMPILATION_H
10 #define LLVM_CLANG_DRIVER_COMPILATION_H
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Option/Option.h"
54 unsigned ActiveOffloadMask = 0;
60 std::multimap<Action::OffloadKind, const ToolChain *>
61 OrderedOffloadingToolchains;
64 llvm::opt::InputArgList *Args;
68 llvm::opt::DerivedArgList *TranslatedArgs;
72 std::vector<std::unique_ptr<Action>> AllActions;
83 struct TCArgsKey final {
88 TCArgsKey(
const ToolChain *TC, StringRef BoundArch,
90 : TC(TC), BoundArch(BoundArch), DeviceOffloadKind(DeviceOffloadKind) {}
92 bool operator<(
const TCArgsKey &K)
const {
95 else if (TC == K.TC && BoundArch < K.BoundArch)
97 else if (TC == K.TC && BoundArch == K.BoundArch &&
98 DeviceOffloadKind < K.DeviceOffloadKind)
103 std::map<TCArgsKey, llvm::opt::DerivedArgList *> TCArgs;
106 llvm::opt::ArgStringList TempFiles;
116 std::vector<Optional<StringRef>> Redirects;
121 std::function<void(
const Command &,
int)> PostCallback;
124 bool ForDiagnostics =
false;
130 bool ForceKeepTempFiles =
false;
134 llvm::opt::InputArgList *Args,
135 llvm::opt::DerivedArgList *TranslatedArgs,
bool ContainsError);
143 return ActiveOffloadMask &
Kind;
156 template <Action::OffloadKind Kind>
158 return OrderedOffloadingToolchains.equal_range(
Kind);
163 return OrderedOffloadingToolchains.equal_range(
Kind);
168 return OrderedOffloadingToolchains.find(
Kind) !=
169 OrderedOffloadingToolchains.end();
174 template <Action::OffloadKind Kind>
176 auto TCs = getOffloadToolChains<Kind>();
178 assert(TCs.first != TCs.second &&
179 "No tool chains of the selected kind exist!");
180 assert(std::next(TCs.first) == TCs.second &&
181 "More than one tool chain of the this kind exist.");
182 return TCs.first->second;
188 "This is not a device tool chain!");
191 ActiveOffloadMask |= OffloadKind;
192 OrderedOffloadingToolchains.insert(
193 std::make_pair(OffloadKind, DeviceToolChain));
198 const llvm::opt::DerivedArgList &
getArgs()
const {
return *TranslatedArgs; }
200 llvm::opt::DerivedArgList &
getArgs() {
return *TranslatedArgs; }
208 template <
typename T,
typename... Args> T *
MakeAction(Args &&... Arg) {
209 T *RawPtr =
new T(std::forward<Args>(Arg)...);
210 AllActions.push_back(std::unique_ptr<Action>(RawPtr));
219 const llvm::opt::ArgStringList &
getTempFiles()
const {
return TempFiles; }
224 return FailureResultFiles;
246 const llvm::opt::DerivedArgList &
253 TempFiles.push_back(Name);
260 ResultFiles[JA] = Name;
267 FailureResultFiles[JA] = Name;
275 bool CleanupFile(
const char *File,
bool IssueErrors =
false)
const;
282 bool IssueErrors =
false)
const;
292 bool IssueErrors =
false)
const;
302 bool LogOnly =
false)
const;
313 bool LogOnly =
false)
const;
341 #endif // LLVM_CLANG_DRIVER_COMPILATION_H
void initCompilationForDiagnostics()
initCompilationForDiagnostics - Remove stale state and suppress output so compilation can be reexecut...
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 cha...
YAML serialization mapping.
void setPostCallback(const std::function< void(const Command &, int)> &CB)
Installs a handler that is executed when a compilation job is finished.
unsigned getActiveOffloadKinds() const
const_offload_toolchains_range getOffloadToolChains(Action::OffloadKind Kind) const
bool isForDiagnostics() const
Return true if we're compiling for diagnostics.
ActionList & getActions()
const ActionList & getActions() const
const ArgStringMap & getFailureResultFiles() const
void addCommand(std::unique_ptr< Command > C)
int ExecuteCommand(const Command &C, const Command *&FailingCommand, bool LogOnly=false) const
ExecuteCommand - Execute an actual command.
const Driver & getDriver() const
void setContainsError()
Force driver to fail before toolchain is created.
bool hasOffloadToolChain() const
Return true if an offloading tool chain of a given kind exists.
const llvm::opt::InputArgList & getInputArgs() const
const llvm::opt::ArgStringList & getTempFiles() const
const ArgStringMap & getResultFiles() const
llvm::opt::DerivedArgList & getArgs()
void addOffloadDeviceToolChain(const ToolChain *DeviceToolChain, Action::OffloadKind OffloadKind)
const std::multimap< Action::OffloadKind, const ToolChain * >::const_iterator const_offload_toolchains_iterator
Iterator that visits device toolchains of a given kind.
Compilation(const Driver &D, const ToolChain &DefaultToolChain, llvm::opt::InputArgList *Args, llvm::opt::DerivedArgList *TranslatedArgs, bool ContainsError)
JobList - A sequence of jobs to perform.
const ToolChain * getSingleOffloadToolChain() const
Return an offload toolchain of the provided kind.
T * MakeAction(Args &&... Arg)
Creates a new Action owned by this Compilation.
const char * addFailureResultFile(const char *Name, const JobAction *JA)
addFailureResultFile - Add a file to remove if we crash, and returns its argument.
void Redirect(ArrayRef< Optional< StringRef >> Redirects)
Redirect - Redirect output of this compilation.
const JobList & getJobs() const
const llvm::opt::DerivedArgList & getArgs() const
bool containsError() const
Return whether an error during the parsing of the input args.
const ToolChain & getDefaultToolChain() const
void ExecuteJobs(const JobList &Jobs, SmallVectorImpl< std::pair< int, const Command * >> &FailingCommands, bool LogOnly=false) const
ExecuteJob - Execute a single job.
Command - An executable path/name and argument vector to execute.
std::pair< const_offload_toolchains_iterator, const_offload_toolchains_iterator > const_offload_toolchains_range
const char * addTempFile(const char *Name)
addTempFile - Add a file to remove on exit, and returns its argument.
const_offload_toolchains_range getOffloadToolChains() const
llvm::DenseMap< const JobAction *, const char * > ArgStringMap
ArgStringMap - Type used to map a JobAction to its result file.
bool CleanupFileMap(const ArgStringMap &Files, const JobAction *JA, bool IssueErrors=false) const
CleanupFileMap - Remove the files in the given map.
unsigned isOffloadingHostKind(Action::OffloadKind Kind) const
const char * addResultFile(const char *Name, const JobAction *JA)
addResultFile - Add a file to remove on failure, and returns its argument.
bool CleanupFile(const char *File, bool IssueErrors=false) const
CleanupFile - Delete a given file.
Compilation - A set of tasks to perform for a single driver invocation.
bool CleanupFileList(const llvm::opt::ArgStringList &Files, bool IssueErrors=false) const
CleanupFileList - Remove the files in the given list.
void addJob(std::unique_ptr< Command > J)
Add a job to the list (taking ownership).
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
StringRef getSysRoot() const
Returns the sysroot path.