clang 10.0.0git

Compilation.h
Go to the documentation of this file.
1 //===- Compilation.h - Compilation Task Data Structure ----------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #ifndef LLVM_CLANG_DRIVER_COMPILATION_H
10 #define LLVM_CLANG_DRIVER_COMPILATION_H
11
12 #include "clang/Basic/LLVM.h"
13 #include "clang/Driver/Action.h"
14 #include "clang/Driver/Job.h"
15 #include "clang/Driver/Util.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"
21 #include <cassert>
22 #include <iterator>
23 #include <map>
24 #include <memory>
25 #include <utility>
26 #include <vector>
27
28 namespace llvm {
29 namespace opt {
30
31 class DerivedArgList;
32 class InputArgList;
33
34 } // namespace opt
35 } // namespace llvm
36
37 namespace clang {
38 namespace driver {
39
40 class Driver;
41 class ToolChain;
42
43 /// Compilation - A set of tasks to perform for a single driver
44 /// invocation.
45 class Compilation {
46 /// The driver we were created by.
47 const Driver &TheDriver;
48
49 /// The default tool chain.
50 const ToolChain &DefaultToolChain;
51
52 /// A mask of all the programming models the host has to support in the
53 /// current compilation.
54 unsigned ActiveOffloadMask = 0;
55
56 /// Array with the toolchains of offloading host and devices in the order they
57 /// were requested by the user. We are preserving that order in case the code
58 /// generation needs to derive a programming-model-specific semantic out of
59 /// it.
60 std::multimap<Action::OffloadKind, const ToolChain *>
61 OrderedOffloadingToolchains;
62
63 /// The original (untranslated) input argument list.
64 llvm::opt::InputArgList *Args;
65
66 /// The driver translated arguments. Note that toolchains may perform their
67 /// own argument translation.
68 llvm::opt::DerivedArgList *TranslatedArgs;
69
70 /// The list of actions we've created via MakeAction. This is not accessible
71 /// to consumers; it's here just to manage ownership.
72 std::vector<std::unique_ptr<Action>> AllActions;
73
74 /// The list of actions. This is maintained and modified by consumers, via
75 /// getActions().
76 ActionList Actions;
77
78 /// The root list of jobs.
79 JobList Jobs;
80
81 /// Cache of translated arguments for a particular tool chain, bound
82 /// architecture, and device offload kind.
83 struct TCArgsKey final {
84 const ToolChain *TC = nullptr;
85 StringRef BoundArch;
86 Action::OffloadKind DeviceOffloadKind = Action::OFK_None;
87
88 TCArgsKey(const ToolChain *TC, StringRef BoundArch,
89 Action::OffloadKind DeviceOffloadKind)
90 : TC(TC), BoundArch(BoundArch), DeviceOffloadKind(DeviceOffloadKind) {}
91
92 bool operator<(const TCArgsKey &K) const {
93 if (TC < K.TC)
94 return true;
95 else if (TC == K.TC && BoundArch < K.BoundArch)
96 return true;
97 else if (TC == K.TC && BoundArch == K.BoundArch &&
98 DeviceOffloadKind < K.DeviceOffloadKind)
99 return true;
100 return false;
101 }
102 };
103 std::map<TCArgsKey, llvm::opt::DerivedArgList *> TCArgs;
104
105 /// Temporary files which should be removed on exit.
106 llvm::opt::ArgStringList TempFiles;
107
108 /// Result files which should be removed on failure.
109 ArgStringMap ResultFiles;
110
111 /// Result files which are generated correctly on failure, and which should
112 /// only be removed if we crash.
113 ArgStringMap FailureResultFiles;
114
115 /// Optional redirection for stdin, stdout, stderr.
116 std::vector<Optional<StringRef>> Redirects;
117
118 /// Whether we're compiling for diagnostic purposes.
119 bool ForDiagnostics = false;
120
121 /// Whether an error during the parsing of the input args.
122 bool ContainsError;
123
124 /// Whether to keep temporary files regardless of -save-temps.
125 bool ForceKeepTempFiles = false;
126
127 public:
128 Compilation(const Driver &D, const ToolChain &DefaultToolChain,
129 llvm::opt::InputArgList *Args,
130 llvm::opt::DerivedArgList *TranslatedArgs, bool ContainsError);
131 ~Compilation();
132
133 const Driver &getDriver() const { return TheDriver; }
134
135 const ToolChain &getDefaultToolChain() const { return DefaultToolChain; }
136
137 unsigned isOffloadingHostKind(Action::OffloadKind Kind) const {
138 return ActiveOffloadMask & Kind;
139 }
140
141 /// Iterator that visits device toolchains of a given kind.
142 using const_offload_toolchains_iterator =
143 const std::multimap<Action::OffloadKind,
144 const ToolChain *>::const_iterator;
145 using const_offload_toolchains_range =
146 std::pair<const_offload_toolchains_iterator,
147 const_offload_toolchains_iterator>;
148
149 template <Action::OffloadKind Kind>
150 const_offload_toolchains_range getOffloadToolChains() const {
151 return OrderedOffloadingToolchains.equal_range(Kind);
152 }
153
154 /// Return true if an offloading tool chain of a given kind exists.
155 template <Action::OffloadKind Kind> bool hasOffloadToolChain() const {
156 return OrderedOffloadingToolchains.find(Kind) !=
157 OrderedOffloadingToolchains.end();
158 }
159
160 /// Return an offload toolchain of the provided kind. Only one is expected to
161 /// exist.
162 template <Action::OffloadKind Kind>
163 const ToolChain *getSingleOffloadToolChain() const {
164 auto TCs = getOffloadToolChains<Kind>();
165
166 assert(TCs.first != TCs.second &&
167 "No tool chains of the selected kind exist!");
168 assert(std::next(TCs.first) == TCs.second &&
169 "More than one tool chain of the this kind exist.");
170 return TCs.first->second;
171 }
172
173 void addOffloadDeviceToolChain(const ToolChain *DeviceToolChain,
174 Action::OffloadKind OffloadKind) {
175 assert(OffloadKind != Action::OFK_Host && OffloadKind != Action::OFK_None &&
176 "This is not a device tool chain!");
177
178 // Update the host offload kind to also contain this kind.
179 ActiveOffloadMask |= OffloadKind;
180 OrderedOffloadingToolchains.insert(
181 std::make_pair(OffloadKind, DeviceToolChain));
182 }
183
184 const llvm::opt::InputArgList &getInputArgs() const { return *Args; }
185
186 const llvm::opt::DerivedArgList &getArgs() const { return *TranslatedArgs; }
187
188 llvm::opt::DerivedArgList &getArgs() { return *TranslatedArgs; }
189
190 ActionList &getActions() { return Actions; }
191 const ActionList &getActions() const { return Actions; }
192
193 /// Creates a new Action owned by this Compilation.
194 ///
195 /// The new Action is *not* added to the list returned by getActions().
196 template <typename T, typename... Args> T *MakeAction(Args &&... Arg) {
197 T *RawPtr = new T(std::forward<Args>(Arg)...);
198 AllActions.push_back(std::unique_ptr<Action>(RawPtr));
199 return RawPtr;
200 }
201
202 JobList &getJobs() { return Jobs; }
203 const JobList &getJobs() const { return Jobs; }
204
205 void addCommand(std::unique_ptr<Command> C) { Jobs.addJob(std::move(C)); }
206
207 const llvm::opt::ArgStringList &getTempFiles() const { return TempFiles; }
208
209 const ArgStringMap &getResultFiles() const { return ResultFiles; }
210
211 const ArgStringMap &getFailureResultFiles() const {
212 return FailureResultFiles;
213 }
214
215 /// Returns the sysroot path.
216 StringRef getSysRoot() const;
217
218 /// getArgsForToolChain - Return the derived argument list for the
219 /// tool chain \p TC (or the default tool chain, if TC is not specified).
220 /// If a device offloading kind is specified, a translation specific for that
221 /// kind is performed, if any.
222 ///
223 /// \param BoundArch - The bound architecture name, or 0.
224 /// \param DeviceOffloadKind - The offload device kind that should be used in
225 /// the translation, if any.
226 const llvm::opt::DerivedArgList &
227 getArgsForToolChain(const ToolChain *TC, StringRef BoundArch,
228 Action::OffloadKind DeviceOffloadKind);
229
230 /// addTempFile - Add a file to remove on exit, and returns its
231 /// argument.
232 const char *addTempFile(const char *Name) {
233 TempFiles.push_back(Name);
234 return Name;
235 }
236
237 /// addResultFile - Add a file to remove on failure, and returns its
238 /// argument.
239 const char *addResultFile(const char *Name, const JobAction *JA) {
240 ResultFiles[JA] = Name;
241 return Name;
242 }
243
244 /// addFailureResultFile - Add a file to remove if we crash, and returns its
245 /// argument.
246 const char *addFailureResultFile(const char *Name, const JobAction *JA) {
247 FailureResultFiles[JA] = Name;
248 return Name;
249 }
250
251 /// CleanupFile - Delete a given file.
252 ///
253 /// \param IssueErrors - Report failures as errors.
254 /// \return Whether the file was removed successfully.
255 bool CleanupFile(const char *File, bool IssueErrors = false) const;
256
257 /// CleanupFileList - Remove the files in the given list.
258 ///
259 /// \param IssueErrors - Report failures as errors.
260 /// \return Whether all files were removed successfully.
261 bool CleanupFileList(const llvm::opt::ArgStringList &Files,
262 bool IssueErrors = false) const;
263
264 /// CleanupFileMap - Remove the files in the given map.
265 ///
266 /// \param JA - If specified, only delete the files associated with this
267 /// JobAction. Otherwise, delete all files in the map.
268 /// \param IssueErrors - Report failures as errors.
269 /// \return Whether all files were removed successfully.
270 bool CleanupFileMap(const ArgStringMap &Files,
271 const JobAction *JA,
272 bool IssueErrors = false) const;
273
274 /// ExecuteCommand - Execute an actual command.
275 ///
276 /// \param FailingCommand - For non-zero results, this will be set to the
277 /// Command which failed, if any.
278 /// \return The result code of the subprocess.
279 int ExecuteCommand(const Command &C, const Command *&FailingCommand) const;
280
281 /// ExecuteJob - Execute a single job.
282 ///
283 /// \param FailingCommands - For non-zero results, this will be a vector of
284 /// failing commands and their associated result code.
285 void ExecuteJobs(
286 const JobList &Jobs,
287 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) const;
288
289 /// initCompilationForDiagnostics - Remove stale state and suppress output
290 /// so compilation can be reexecuted to generate additional diagnostic
291 /// information (e.g., preprocessed source(s)).
292 void initCompilationForDiagnostics();
293
294 /// Return true if we're compiling for diagnostics.
295 bool isForDiagnostics() const { return ForDiagnostics; }
296
297 /// Return whether an error during the parsing of the input args.
298 bool containsError() const { return ContainsError; }
299
300 /// Redirect - Redirect output of this compilation. Can only be done once.
301 ///
302 /// \param Redirects - array of optional paths. The array should have a size
303 /// of three. The inferior process's stdin(0), stdout(1), and stderr(2) will
304 /// be redirected to the corresponding paths, if provided (not llvm::None).
305 void Redirect(ArrayRef<Optional<StringRef>> Redirects);
306 };
307
308 } // namespace driver
309 } // namespace clang
310
311 #endif // LLVM_CLANG_DRIVER_COMPILATION_H
clang::driver::Compilation::getJobs
const JobList & getJobs() const
Definition: Compilation.h:203
clang::driver::Compilation::getTempFiles
const llvm::opt::ArgStringList & getTempFiles() const
Definition: Compilation.h:207
llvm
Specialize PointerLikeTypeTraits to allow LazyGenerationalUpdatePtr to be placed into a PointerUnion...
Definition: Dominators.h:30
clang::driver::Compilation::MakeAction
T * MakeAction(Args &&... Arg)
Creates a new Action owned by this Compilation.
Definition: Compilation.h:196
Job.h
clang::driver::Compilation::const_offload_toolchains_iterator
const std::multimap< Action::OffloadKind, const ToolChain * >::const_iterator const_offload_toolchains_iterator
Iterator that visits device toolchains of a given kind.
Definition: Compilation.h:144
clang::driver::Compilation::const_offload_toolchains_range
std::pair< const_offload_toolchains_iterator, const_offload_toolchains_iterator > const_offload_toolchains_range
Definition: Compilation.h:147
clang::driver::Compilation::getJobs
JobList & getJobs()
Definition: Compilation.h:202
clang::driver::Compilation::getFailureResultFiles
const ArgStringMap & getFailureResultFiles() const
Definition: Compilation.h:211
Action.h
clang::driver::Compilation::containsError
bool containsError() const
Return whether an error during the parsing of the input args.
Definition: Compilation.h:298
clang::driver::Compilation::addOffloadDeviceToolChain
void addOffloadDeviceToolChain(const ToolChain *DeviceToolChain, Action::OffloadKind OffloadKind)
Definition: Compilation.h:173
llvm::Optional
Definition: LLVM.h:37
clang::driver::JobAction
Definition: Action.h:375
llvm::SmallVectorImpl
Definition: LLVM.h:36
LLVM.h
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
clang::driver::Compilation::getActions
const ActionList & getActions() const
Definition: Compilation.h:191
clang::driver::Driver
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:59
clang::driver::Compilation::getInputArgs
const llvm::opt::InputArgList & getInputArgs() const
Definition: Compilation.h:184
llvm::ArrayRef
Definition: LLVM.h:31
clang::driver::Compilation::hasOffloadToolChain
bool hasOffloadToolChain() const
Return true if an offloading tool chain of a given kind exists.
Definition: Compilation.h:155
clang::driver::Compilation::getDefaultToolChain
const ToolChain & getDefaultToolChain() const
Definition: Compilation.h:135
clang::driver::Compilation::getArgs
llvm::opt::DerivedArgList & getArgs()
Definition: Compilation.h:188
clang::driver::Compilation::getResultFiles
const ArgStringMap & getResultFiles() const
Definition: Compilation.h:209
clang::driver::Compilation::isForDiagnostics
bool isForDiagnostics() const
Return true if we&#39;re compiling for diagnostics.
Definition: Compilation.h:295
clang::driver::Compilation::isOffloadingHostKind
unsigned isOffloadingHostKind(Action::OffloadKind Kind) const
Definition: Compilation.h:137
clang::driver::Compilation::addCommand
void addCommand(std::unique_ptr< Command > C)
Definition: Compilation.h:205
clang::driver::JobList
JobList - A sequence of jobs to perform.
Definition: Job.h:189
clang::driver::JobList::addJob
void addJob(std::unique_ptr< Command > J)
Add a job to the list (taking ownership).
Definition: Job.h:204
clang::driver::ArgStringMap
llvm::DenseMap< const JobAction *, const char * > ArgStringMap
ArgStringMap - Type used to map a JobAction to its result file.
Definition: Util.h:20
clang::driver::Compilation::getOffloadToolChains
const_offload_toolchains_range getOffloadToolChains() const
Definition: Compilation.h:150
Kind
Kind
Definition: ChrootChecker.cpp:29
clang::driver::Compilation::getArgs
const llvm::opt::DerivedArgList & getArgs() const
Definition: Compilation.h:186
clang::driver::Command
Command - An executable path/name and argument vector to execute.
Definition: Job.h:41
clang::driver::Compilation::addResultFile
const char * addResultFile(const char *Name, const JobAction *JA)
addResultFile - Add a file to remove on failure, and returns its argument.
Definition: Compilation.h:239
Util.h
llvm::SmallVector< Action *, 3 >
clang::operator<
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
Definition: DeclarationName.h:540
clang::driver::Action::OffloadKind
OffloadKind
Definition: Action.h:84
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:21
clang::driver::Compilation::getActions
ActionList & getActions()
Definition: Compilation.h:190
clang::driver::Compilation
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
clang::driver::Compilation::getDriver
const Driver & getDriver() const
Definition: Compilation.h:133
clang::driver::Compilation::addFailureResultFile
const char * addFailureResultFile(const char *Name, const JobAction *JA)
addFailureResultFile - Add a file to remove if we crash, and returns its argument.
Definition: Compilation.h:246
clang::driver::Compilation::addTempFile
const char * addTempFile(const char *Name)
addTempFile - Add a file to remove on exit, and returns its argument.
Definition: Compilation.h:232
clang::driver::Compilation::getSingleOffloadToolChain
const ToolChain * getSingleOffloadToolChain() const
Return an offload toolchain of the provided kind.
Definition: Compilation.h:163
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:88