clang  15.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  /// Callback called after compilation job has been finished.
119  /// Arguments of the callback are the compilation job as an instance of
120  /// class Command and the exit status of the corresponding child process.
121  std::function<void(const Command &, int)> PostCallback;
122 
123  /// Whether we're compiling for diagnostic purposes.
124  bool ForDiagnostics = false;
125 
126  /// Whether an error during the parsing of the input args.
127  bool ContainsError;
128 
129  /// Whether to keep temporary files regardless of -save-temps.
130  bool ForceKeepTempFiles = false;
131 
132 public:
133  Compilation(const Driver &D, const ToolChain &DefaultToolChain,
134  llvm::opt::InputArgList *Args,
135  llvm::opt::DerivedArgList *TranslatedArgs, bool ContainsError);
136  ~Compilation();
137 
138  const Driver &getDriver() const { return TheDriver; }
139 
140  const ToolChain &getDefaultToolChain() const { return DefaultToolChain; }
141 
143  return ActiveOffloadMask & Kind;
144  }
145 
146  unsigned getActiveOffloadKinds() const { return ActiveOffloadMask; }
147 
148  /// Iterator that visits device toolchains of a given kind.
150  const std::multimap<Action::OffloadKind,
151  const ToolChain *>::const_iterator;
155 
156  template <Action::OffloadKind Kind>
158  return OrderedOffloadingToolchains.equal_range(Kind);
159  }
160 
163  return OrderedOffloadingToolchains.equal_range(Kind);
164  }
165 
166  /// Return true if an offloading tool chain of a given kind exists.
167  template <Action::OffloadKind Kind> bool hasOffloadToolChain() const {
168  return OrderedOffloadingToolchains.find(Kind) !=
169  OrderedOffloadingToolchains.end();
170  }
171 
172  /// Return an offload toolchain of the provided kind. Only one is expected to
173  /// exist.
174  template <Action::OffloadKind Kind>
176  auto TCs = getOffloadToolChains<Kind>();
177 
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;
183  }
184 
185  void addOffloadDeviceToolChain(const ToolChain *DeviceToolChain,
186  Action::OffloadKind OffloadKind) {
187  assert(OffloadKind != Action::OFK_Host && OffloadKind != Action::OFK_None &&
188  "This is not a device tool chain!");
189 
190  // Update the host offload kind to also contain this kind.
191  ActiveOffloadMask |= OffloadKind;
192  OrderedOffloadingToolchains.insert(
193  std::make_pair(OffloadKind, DeviceToolChain));
194  }
195 
196  const llvm::opt::InputArgList &getInputArgs() const { return *Args; }
197 
198  const llvm::opt::DerivedArgList &getArgs() const { return *TranslatedArgs; }
199 
200  llvm::opt::DerivedArgList &getArgs() { return *TranslatedArgs; }
201 
202  ActionList &getActions() { return Actions; }
203  const ActionList &getActions() const { return Actions; }
204 
205  /// Creates a new Action owned by this Compilation.
206  ///
207  /// The new Action is *not* added to the list returned by getActions().
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));
211  return RawPtr;
212  }
213 
214  JobList &getJobs() { return Jobs; }
215  const JobList &getJobs() const { return Jobs; }
216 
217  void addCommand(std::unique_ptr<Command> C) { Jobs.addJob(std::move(C)); }
218 
219  const llvm::opt::ArgStringList &getTempFiles() const { return TempFiles; }
220 
221  const ArgStringMap &getResultFiles() const { return ResultFiles; }
222 
224  return FailureResultFiles;
225  }
226 
227  /// Installs a handler that is executed when a compilation job is finished.
228  /// The arguments of the callback specify the compilation job as an instance
229  /// of class Command and the exit status of the child process executed that
230  /// job.
231  void setPostCallback(const std::function<void(const Command &, int)> &CB) {
232  PostCallback = CB;
233  }
234 
235  /// Returns the sysroot path.
236  StringRef getSysRoot() const;
237 
238  /// getArgsForToolChain - Return the derived argument list for the
239  /// tool chain \p TC (or the default tool chain, if TC is not specified).
240  /// If a device offloading kind is specified, a translation specific for that
241  /// kind is performed, if any.
242  ///
243  /// \param BoundArch - The bound architecture name, or 0.
244  /// \param DeviceOffloadKind - The offload device kind that should be used in
245  /// the translation, if any.
246  const llvm::opt::DerivedArgList &
247  getArgsForToolChain(const ToolChain *TC, StringRef BoundArch,
248  Action::OffloadKind DeviceOffloadKind);
249 
250  /// addTempFile - Add a file to remove on exit, and returns its
251  /// argument.
252  const char *addTempFile(const char *Name) {
253  TempFiles.push_back(Name);
254  return Name;
255  }
256 
257  /// addResultFile - Add a file to remove on failure, and returns its
258  /// argument.
259  const char *addResultFile(const char *Name, const JobAction *JA) {
260  ResultFiles[JA] = Name;
261  return Name;
262  }
263 
264  /// addFailureResultFile - Add a file to remove if we crash, and returns its
265  /// argument.
266  const char *addFailureResultFile(const char *Name, const JobAction *JA) {
267  FailureResultFiles[JA] = Name;
268  return Name;
269  }
270 
271  /// CleanupFile - Delete a given file.
272  ///
273  /// \param IssueErrors - Report failures as errors.
274  /// \return Whether the file was removed successfully.
275  bool CleanupFile(const char *File, bool IssueErrors = false) const;
276 
277  /// CleanupFileList - Remove the files in the given list.
278  ///
279  /// \param IssueErrors - Report failures as errors.
280  /// \return Whether all files were removed successfully.
281  bool CleanupFileList(const llvm::opt::ArgStringList &Files,
282  bool IssueErrors = false) const;
283 
284  /// CleanupFileMap - Remove the files in the given map.
285  ///
286  /// \param JA - If specified, only delete the files associated with this
287  /// JobAction. Otherwise, delete all files in the map.
288  /// \param IssueErrors - Report failures as errors.
289  /// \return Whether all files were removed successfully.
290  bool CleanupFileMap(const ArgStringMap &Files,
291  const JobAction *JA,
292  bool IssueErrors = false) const;
293 
294  /// ExecuteCommand - Execute an actual command.
295  ///
296  /// \param FailingCommand - For non-zero results, this will be set to the
297  /// Command which failed, if any.
298  /// \param LogOnly - When true, only tries to log the command, not actually
299  /// execute it.
300  /// \return The result code of the subprocess.
301  int ExecuteCommand(const Command &C, const Command *&FailingCommand,
302  bool LogOnly = false) const;
303 
304  /// ExecuteJob - Execute a single job.
305  ///
306  /// \param FailingCommands - For non-zero results, this will be a vector of
307  /// failing commands and their associated result code.
308  /// \param LogOnly - When true, only tries to log the command, not actually
309  /// execute it.
310  void
311  ExecuteJobs(const JobList &Jobs,
312  SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands,
313  bool LogOnly = false) const;
314 
315  /// initCompilationForDiagnostics - Remove stale state and suppress output
316  /// so compilation can be reexecuted to generate additional diagnostic
317  /// information (e.g., preprocessed source(s)).
319 
320  /// Return true if we're compiling for diagnostics.
321  bool isForDiagnostics() const { return ForDiagnostics; }
322 
323  /// Return whether an error during the parsing of the input args.
324  bool containsError() const { return ContainsError; }
325 
326  /// Force driver to fail before toolchain is created. This is necessary when
327  /// error happens in action builder.
328  void setContainsError() { ContainsError = true; }
329 
330  /// Redirect - Redirect output of this compilation. Can only be done once.
331  ///
332  /// \param Redirects - array of optional paths. The array should have a size
333  /// of three. The inferior process's stdin(0), stdout(1), and stderr(2) will
334  /// be redirected to the corresponding paths, if provided (not llvm::None).
335  void Redirect(ArrayRef<Optional<StringRef>> Redirects);
336 };
337 
338 } // namespace driver
339 } // namespace clang
340 
341 #endif // LLVM_CLANG_DRIVER_COMPILATION_H
clang::driver::Compilation::initCompilationForDiagnostics
void initCompilationForDiagnostics()
initCompilationForDiagnostics - Remove stale state and suppress output so compilation can be reexecut...
Definition: Compilation.cpp:263
clang::driver::Compilation::getArgsForToolChain
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...
Definition: Compilation.cpp:62
Util.h
llvm
YAML serialization mapping.
Definition: Dominators.h:30
clang::driver::Compilation::setPostCallback
void setPostCallback(const std::function< void(const Command &, int)> &CB)
Installs a handler that is executed when a compilation job is finished.
Definition: Compilation.h:231
clang::driver::Compilation::getActiveOffloadKinds
unsigned getActiveOffloadKinds() const
Definition: Compilation.h:146
clang::driver::Compilation::getOffloadToolChains
const_offload_toolchains_range getOffloadToolChains(Action::OffloadKind Kind) const
Definition: Compilation.h:162
clang::driver::Compilation::isForDiagnostics
bool isForDiagnostics() const
Return true if we're compiling for diagnostics.
Definition: Compilation.h:321
llvm::SmallVector< Action *, 3 >
clang::driver::Compilation::getActions
ActionList & getActions()
Definition: Compilation.h:202
clang::driver::Compilation::getActions
const ActionList & getActions() const
Definition: Compilation.h:203
clang::driver::Compilation::getJobs
JobList & getJobs()
Definition: Compilation.h:214
Job.h
clang::driver::Compilation::getFailureResultFiles
const ArgStringMap & getFailureResultFiles() const
Definition: Compilation.h:223
llvm::Optional
Definition: LLVM.h:40
clang::driver::Compilation::addCommand
void addCommand(std::unique_ptr< Command > C)
Definition: Compilation.h:217
clang::driver::Compilation::ExecuteCommand
int ExecuteCommand(const Command &C, const Command *&FailingCommand, bool LogOnly=false) const
ExecuteCommand - Execute an actual command.
Definition: Compilation.cpp:164
clang::driver::Compilation::getDriver
const Driver & getDriver() const
Definition: Compilation.h:138
clang::driver::Compilation::setContainsError
void setContainsError()
Force driver to fail before toolchain is created.
Definition: Compilation.h:328
Action.h
clang::driver::Compilation::hasOffloadToolChain
bool hasOffloadToolChain() const
Return true if an offloading tool chain of a given kind exists.
Definition: Compilation.h:167
clang::driver::Compilation::getInputArgs
const llvm::opt::InputArgList & getInputArgs() const
Definition: Compilation.h:196
clang::driver::Compilation::getTempFiles
const llvm::opt::ArgStringList & getTempFiles() const
Definition: Compilation.h:219
clang::driver::Compilation::getResultFiles
const ArgStringMap & getResultFiles() const
Definition: Compilation.h:221
clang::driver::Compilation::getArgs
llvm::opt::DerivedArgList & getArgs()
Definition: Compilation.h:200
clang::driver::Compilation::addOffloadDeviceToolChain
void addOffloadDeviceToolChain(const ToolChain *DeviceToolChain, Action::OffloadKind OffloadKind)
Definition: Compilation.h:185
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:151
clang::driver::Compilation::Compilation
Compilation(const Driver &D, const ToolChain &DefaultToolChain, llvm::opt::InputArgList *Args, llvm::opt::DerivedArgList *TranslatedArgs, bool ContainsError)
Definition: Compilation.cpp:36
clang::driver::Compilation::~Compilation
~Compilation()
Definition: Compilation.cpp:46
clang::driver::JobList
JobList - A sequence of jobs to perform.
Definition: Job.h:267
clang::driver::Compilation::getSingleOffloadToolChain
const ToolChain * getSingleOffloadToolChain() const
Return an offload toolchain of the provided kind.
Definition: Compilation.h:175
clang::driver::Action::OFK_Host
@ OFK_Host
Definition: Action.h:92
clang::driver::Compilation::MakeAction
T * MakeAction(Args &&... Arg)
Creates a new Action owned by this Compilation.
Definition: Compilation.h:208
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:266
clang::driver::Action::OFK_None
@ OFK_None
Definition: Action.h:89
clang::driver::Compilation::Redirect
void Redirect(ArrayRef< Optional< StringRef >> Redirects)
Redirect - Redirect output of this compilation.
Definition: Compilation.cpp:310
clang::driver::Compilation::getJobs
const JobList & getJobs() const
Definition: Compilation.h:215
clang::driver::Compilation::getArgs
const llvm::opt::DerivedArgList & getArgs() const
Definition: Compilation.h:198
clang::driver::Compilation::containsError
bool containsError() const
Return whether an error during the parsing of the input args.
Definition: Compilation.h:324
clang::driver::Compilation::getDefaultToolChain
const ToolChain & getDefaultToolChain() const
Definition: Compilation.h:140
clang::driver::Compilation::ExecuteJobs
void ExecuteJobs(const JobList &Jobs, SmallVectorImpl< std::pair< int, const Command * >> &FailingCommands, bool LogOnly=false) const
ExecuteJob - Execute a single job.
Definition: Compilation.cpp:243
clang::driver::Command
Command - An executable path/name and argument vector to execute.
Definition: Job.h:106
clang::driver::Compilation::const_offload_toolchains_range
std::pair< const_offload_toolchains_iterator, const_offload_toolchains_iterator > const_offload_toolchains_range
Definition: Compilation.h:154
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:252
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
llvm::ArrayRef
Definition: LLVM.h:34
clang::driver::Compilation::getOffloadToolChains
const_offload_toolchains_range getOffloadToolChains() const
Definition: Compilation.h:157
clang::driver::ArgStringMap
llvm::DenseMap< const JobAction *, const char * > ArgStringMap
ArgStringMap - Type used to map a JobAction to its result file.
Definition: Util.h:19
clang::driver::Compilation::CleanupFileMap
bool CleanupFileMap(const ArgStringMap &Files, const JobAction *JA, bool IssueErrors=false) const
CleanupFileMap - Remove the files in the given map.
Definition: Compilation.cpp:150
LLVM.h
clang::driver::Compilation::isOffloadingHostKind
unsigned isOffloadingHostKind(Action::OffloadKind Kind) const
Definition: Compilation.h:142
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:259
clang::driver::Compilation::CleanupFile
bool CleanupFile(const char *File, bool IssueErrors=false) const
CleanupFile - Delete a given file.
Definition: Compilation.cpp:112
clang::driver::Compilation
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
clang::driver::Compilation::CleanupFileList
bool CleanupFileList(const llvm::opt::ArgStringList &Files, bool IssueErrors=false) const
CleanupFileList - Remove the files in the given list.
Definition: Compilation.cpp:142
clang::ObjCPropertyAttribute::Kind
Kind
Definition: DeclObjCCommon.h:22
clang::driver::JobList::addJob
void addJob(std::unique_ptr< Command > J)
Add a job to the list (taking ownership).
Definition: Job.h:282
clang
Definition: CalledOnceCheck.h:17
clang::driver::Driver
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:72
clang::operator<
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
Definition: DeclarationName.h:549
clang::driver::Action::OffloadKind
OffloadKind
Definition: Action.h:88
llvm::SmallVectorImpl
Definition: Randstruct.h:18
clang::driver::JobAction
Definition: Action.h:395
clang::driver::Compilation::getSysRoot
StringRef getSysRoot() const
Returns the sysroot path.
Definition: Compilation.cpp:306