1//===--- Compilation.cpp - Compilation Task Implementation ----------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "clang/Driver/Compilation.h"
11#include "clang/Driver/Action.h"
12#include "clang/Driver/Driver.h"
13#include "clang/Driver/DriverDiagnostic.h"
14#include "clang/Driver/Options.h"
15#include "clang/Driver/ToolChain.h"
16#include "llvm/ADT/STLExtras.h"
17#include "llvm/Option/ArgList.h"
18#include "llvm/Support/FileSystem.h"
19#include "llvm/Support/raw_ostream.h"
20
21using namespace clang::driver;
22using namespace clang;
23using namespace llvm::opt;
24
25Compilation::Compilation(const Driver &D, const ToolChain &_DefaultToolChain,
26                         InputArgList *_Args, DerivedArgList *_TranslatedArgs)
27    : TheDriver(D), DefaultToolChain(_DefaultToolChain), Args(_Args),
28      TranslatedArgs(_TranslatedArgs), Redirects(nullptr),
29      ForDiagnostics(false) {}
30
31Compilation::~Compilation() {
32  delete TranslatedArgs;
33  delete Args;
34
35  // Free any derived arg lists.
36  for (llvm::DenseMap<std::pair<const ToolChain*, const char*>,
37                      DerivedArgList*>::iterator it = TCArgs.begin(),
38         ie = TCArgs.end(); it != ie; ++it)
39    if (it->second != TranslatedArgs)
40      delete it->second;
41
42  // Free the actions, if built.
43  for (ActionList::iterator it = Actions.begin(), ie = Actions.end();
44       it != ie; ++it)
45    delete *it;
46
47  // Free redirections of stdout/stderr.
48  if (Redirects) {
49    delete Redirects[1];
50    delete Redirects[2];
51    delete [] Redirects;
52  }
53}
54
55const DerivedArgList &Compilation::getArgsForToolChain(const ToolChain *TC,
56                                                       const char *BoundArch) {
57  if (!TC)
58    TC = &DefaultToolChain;
59
60  DerivedArgList *&Entry = TCArgs[std::make_pair(TC, BoundArch)];
61  if (!Entry) {
62    Entry = TC->TranslateArgs(*TranslatedArgs, BoundArch);
63    if (!Entry)
64      Entry = TranslatedArgs;
65  }
66
67  return *Entry;
68}
69
70bool Compilation::CleanupFile(const char *File, bool IssueErrors) const {
71  // FIXME: Why are we trying to remove files that we have not created? For
72  // example we should only try to remove a temporary assembly file if
73  // "clang -cc1" succeed in writing it. Was this a workaround for when
74  // clang was writing directly to a .s file and sometimes leaving it behind
75  // during a failure?
76
77  // FIXME: If this is necessary, we can still try to split
78  // llvm::sys::fs::remove into a removeFile and a removeDir and avoid the
79  // duplicated stat from is_regular_file.
80
81  // Don't try to remove files which we don't have write access to (but may be
82  // able to remove), or non-regular files. Underlying tools may have
83  // intentionally not overwritten them.
84  if (!llvm::sys::fs::can_write(File) || !llvm::sys::fs::is_regular_file(File))
85    return true;
86
87  if (std::error_code EC = llvm::sys::fs::remove(File)) {
88    // Failure is only failure if the file exists and is "regular". We checked
89    // for it being regular before, and llvm::sys::fs::remove ignores ENOENT,
90    // so we don't need to check again.
91
92    if (IssueErrors)
93      getDriver().Diag(clang::diag::err_drv_unable_to_remove_file)
94        << EC.message();
95    return false;
96  }
97  return true;
98}
99
100bool Compilation::CleanupFileList(const ArgStringList &Files,
101                                  bool IssueErrors) const {
102  bool Success = true;
103  for (ArgStringList::const_iterator
104         it = Files.begin(), ie = Files.end(); it != ie; ++it)
105    Success &= CleanupFile(*it, IssueErrors);
106  return Success;
107}
108
109bool Compilation::CleanupFileMap(const ArgStringMap &Files,
110                                 const JobAction *JA,
111                                 bool IssueErrors) const {
112  bool Success = true;
113  for (ArgStringMap::const_iterator
114         it = Files.begin(), ie = Files.end(); it != ie; ++it) {
115
116    // If specified, only delete the files associated with the JobAction.
117    // Otherwise, delete all files in the map.
118    if (JA && it->first != JA)
119      continue;
120    Success &= CleanupFile(it->second, IssueErrors);
121  }
122  return Success;
123}
124
125int Compilation::ExecuteCommand(const Command &C,
126                                const Command *&FailingCommand) const {
127  if ((getDriver().CCPrintOptions ||
128       getArgs().hasArg(options::OPT_v)) && !getDriver().CCGenDiagnostics) {
129    raw_ostream *OS = &llvm::errs();
130
131    // Follow gcc implementation of CC_PRINT_OPTIONS; we could also cache the
132    // output stream.
133    if (getDriver().CCPrintOptions && getDriver().CCPrintOptionsFilename) {
134      std::string Error;
135      OS = new llvm::raw_fd_ostream(getDriver().CCPrintOptionsFilename, Error,
136                                    llvm::sys::fs::F_Append |
137                                        llvm::sys::fs::F_Text);
138      if (!Error.empty()) {
139        getDriver().Diag(clang::diag::err_drv_cc_print_options_failure)
140          << Error;
141        FailingCommand = &C;
142        delete OS;
143        return 1;
144      }
145    }
146
147    if (getDriver().CCPrintOptions)
148      *OS << "[Logging clang options]";
149
150    C.Print(*OS, "\n", /*Quote=*/getDriver().CCPrintOptions);
151
152    if (OS != &llvm::errs())
153      delete OS;
154  }
155
156  std::string Error;
157  bool ExecutionFailed;
158  int Res = C.Execute(Redirects, &Error, &ExecutionFailed);
159  if (!Error.empty()) {
160    assert(Res && "Error string set with 0 result code!");
161    getDriver().Diag(clang::diag::err_drv_command_failure) << Error;
162  }
163
164  if (Res)
165    FailingCommand = &C;
166
167  return ExecutionFailed ? 1 : Res;
168}
169
170typedef SmallVectorImpl< std::pair<int, const Command *> > FailingCommandList;
171
172static bool ActionFailed(const Action *A,
173                         const FailingCommandList &FailingCommands) {
174
175  if (FailingCommands.empty())
176    return false;
177
178  for (FailingCommandList::const_iterator CI = FailingCommands.begin(),
179         CE = FailingCommands.end(); CI != CE; ++CI)
180    if (A == &(CI->second->getSource()))
181      return true;
182
183  for (Action::const_iterator AI = A->begin(), AE = A->end(); AI != AE; ++AI)
184    if (ActionFailed(*AI, FailingCommands))
185      return true;
186
187  return false;
188}
189
190static bool InputsOk(const Command &C,
191                     const FailingCommandList &FailingCommands) {
192  return !ActionFailed(&C.getSource(), FailingCommands);
193}
194
195void Compilation::ExecuteJob(const Job &J,
196                             FailingCommandList &FailingCommands) const {
197  if (const Command *C = dyn_cast<Command>(&J)) {
198    if (!InputsOk(*C, FailingCommands))
199      return;
200    const Command *FailingCommand = nullptr;
201    if (int Res = ExecuteCommand(*C, FailingCommand))
202      FailingCommands.push_back(std::make_pair(Res, FailingCommand));
203  } else {
204    const JobList *Jobs = cast<JobList>(&J);
205    for (JobList::const_iterator it = Jobs->begin(), ie = Jobs->end();
206         it != ie; ++it)
207      ExecuteJob(**it, FailingCommands);
208  }
209}
210
211void Compilation::initCompilationForDiagnostics() {
212  ForDiagnostics = true;
213
214  // Free actions and jobs.
215  DeleteContainerPointers(Actions);
216  Jobs.clear();
217
218  // Clear temporary/results file lists.
219  TempFiles.clear();
220  ResultFiles.clear();
221  FailureResultFiles.clear();
222
223  // Remove any user specified output.  Claim any unclaimed arguments, so as
224  // to avoid emitting warnings about unused args.
225  OptSpecifier OutputOpts[] = { options::OPT_o, options::OPT_MD,
226                                options::OPT_MMD };
227  for (unsigned i = 0, e = llvm::array_lengthof(OutputOpts); i != e; ++i) {
228    if (TranslatedArgs->hasArg(OutputOpts[i]))
229      TranslatedArgs->eraseArg(OutputOpts[i]);
230  }
231  TranslatedArgs->ClaimAllArgs();
232
233  // Redirect stdout/stderr to /dev/null.
234  Redirects = new const StringRef*[3]();
235  Redirects[0] = nullptr;
236  Redirects[1] = new const StringRef();
237  Redirects[2] = new const StringRef();
238}
239
240StringRef Compilation::getSysRoot() const {
241  return getDriver().SysRoot;
242}
243