1 //===--- Compilation.cpp - Compilation Task Implementation ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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"
21 using namespace clang::driver;
22 using namespace clang;
23 using namespace llvm::opt;
25 Compilation::Compilation(const Driver &D, const ToolChain &_DefaultToolChain,
26 InputArgList *_Args, DerivedArgList *_TranslatedArgs)
27 : TheDriver(D), DefaultToolChain(_DefaultToolChain),
28 CudaHostToolChain(&DefaultToolChain), CudaDeviceToolChain(nullptr),
29 Args(_Args), TranslatedArgs(_TranslatedArgs), Redirects(nullptr),
30 ForDiagnostics(false) {}
32 Compilation::~Compilation() {
33 delete TranslatedArgs;
36 // Free any derived arg lists.
37 for (llvm::DenseMap<std::pair<const ToolChain*, const char*>,
38 DerivedArgList*>::iterator it = TCArgs.begin(),
39 ie = TCArgs.end(); it != ie; ++it)
40 if (it->second != TranslatedArgs)
43 // Free redirections of stdout/stderr.
51 const DerivedArgList &Compilation::getArgsForToolChain(const ToolChain *TC,
52 const char *BoundArch) {
54 TC = &DefaultToolChain;
56 DerivedArgList *&Entry = TCArgs[std::make_pair(TC, BoundArch)];
58 Entry = TC->TranslateArgs(*TranslatedArgs, BoundArch);
60 Entry = TranslatedArgs;
66 bool Compilation::CleanupFile(const char *File, bool IssueErrors) const {
67 // FIXME: Why are we trying to remove files that we have not created? For
68 // example we should only try to remove a temporary assembly file if
69 // "clang -cc1" succeed in writing it. Was this a workaround for when
70 // clang was writing directly to a .s file and sometimes leaving it behind
73 // FIXME: If this is necessary, we can still try to split
74 // llvm::sys::fs::remove into a removeFile and a removeDir and avoid the
75 // duplicated stat from is_regular_file.
77 // Don't try to remove files which we don't have write access to (but may be
78 // able to remove), or non-regular files. Underlying tools may have
79 // intentionally not overwritten them.
80 if (!llvm::sys::fs::can_write(File) || !llvm::sys::fs::is_regular_file(File))
83 if (std::error_code EC = llvm::sys::fs::remove(File)) {
84 // Failure is only failure if the file exists and is "regular". We checked
85 // for it being regular before, and llvm::sys::fs::remove ignores ENOENT,
86 // so we don't need to check again.
89 getDriver().Diag(clang::diag::err_drv_unable_to_remove_file)
96 bool Compilation::CleanupFileList(const ArgStringList &Files,
97 bool IssueErrors) const {
99 for (ArgStringList::const_iterator
100 it = Files.begin(), ie = Files.end(); it != ie; ++it)
101 Success &= CleanupFile(*it, IssueErrors);
105 bool Compilation::CleanupFileMap(const ArgStringMap &Files,
107 bool IssueErrors) const {
109 for (ArgStringMap::const_iterator
110 it = Files.begin(), ie = Files.end(); it != ie; ++it) {
112 // If specified, only delete the files associated with the JobAction.
113 // Otherwise, delete all files in the map.
114 if (JA && it->first != JA)
116 Success &= CleanupFile(it->second, IssueErrors);
121 int Compilation::ExecuteCommand(const Command &C,
122 const Command *&FailingCommand) const {
123 if ((getDriver().CCPrintOptions ||
124 getArgs().hasArg(options::OPT_v)) && !getDriver().CCGenDiagnostics) {
125 raw_ostream *OS = &llvm::errs();
127 // Follow gcc implementation of CC_PRINT_OPTIONS; we could also cache the
129 if (getDriver().CCPrintOptions && getDriver().CCPrintOptionsFilename) {
131 OS = new llvm::raw_fd_ostream(getDriver().CCPrintOptionsFilename, EC,
132 llvm::sys::fs::F_Append |
133 llvm::sys::fs::F_Text);
135 getDriver().Diag(clang::diag::err_drv_cc_print_options_failure)
143 if (getDriver().CCPrintOptions)
144 *OS << "[Logging clang options]";
146 C.Print(*OS, "\n", /*Quote=*/getDriver().CCPrintOptions);
148 if (OS != &llvm::errs())
153 bool ExecutionFailed;
154 int Res = C.Execute(Redirects, &Error, &ExecutionFailed);
155 if (!Error.empty()) {
156 assert(Res && "Error string set with 0 result code!");
157 getDriver().Diag(clang::diag::err_drv_command_failure) << Error;
163 return ExecutionFailed ? 1 : Res;
166 typedef SmallVectorImpl< std::pair<int, const Command *> > FailingCommandList;
168 static bool ActionFailed(const Action *A,
169 const FailingCommandList &FailingCommands) {
171 if (FailingCommands.empty())
174 for (FailingCommandList::const_iterator CI = FailingCommands.begin(),
175 CE = FailingCommands.end(); CI != CE; ++CI)
176 if (A == &(CI->second->getSource()))
179 for (Action::const_iterator AI = A->begin(), AE = A->end(); AI != AE; ++AI)
180 if (ActionFailed(*AI, FailingCommands))
186 static bool InputsOk(const Command &C,
187 const FailingCommandList &FailingCommands) {
188 return !ActionFailed(&C.getSource(), FailingCommands);
191 void Compilation::ExecuteJobs(const JobList &Jobs,
192 FailingCommandList &FailingCommands) const {
193 for (const auto &Job : Jobs) {
194 if (!InputsOk(Job, FailingCommands))
196 const Command *FailingCommand = nullptr;
197 if (int Res = ExecuteCommand(Job, FailingCommand))
198 FailingCommands.push_back(std::make_pair(Res, FailingCommand));
202 void Compilation::initCompilationForDiagnostics() {
203 ForDiagnostics = true;
205 // Free actions and jobs.
210 // Clear temporary/results file lists.
213 FailureResultFiles.clear();
215 // Remove any user specified output. Claim any unclaimed arguments, so as
216 // to avoid emitting warnings about unused args.
217 OptSpecifier OutputOpts[] = { options::OPT_o, options::OPT_MD,
219 for (unsigned i = 0, e = llvm::array_lengthof(OutputOpts); i != e; ++i) {
220 if (TranslatedArgs->hasArg(OutputOpts[i]))
221 TranslatedArgs->eraseArg(OutputOpts[i]);
223 TranslatedArgs->ClaimAllArgs();
225 // Redirect stdout/stderr to /dev/null.
226 Redirects = new const StringRef*[3]();
227 Redirects[0] = nullptr;
228 Redirects[1] = new StringRef();
229 Redirects[2] = new StringRef();
232 StringRef Compilation::getSysRoot() const {
233 return getDriver().SysRoot;