Coverage Report

Created: 2020-09-15 12:33

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Driver/Compilation.cpp
Line
Count
Source (jump to first uncovered line)
1
//===- Compilation.cpp - Compilation Task Implementation ------------------===//
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
#include "clang/Driver/Compilation.h"
10
#include "clang/Basic/LLVM.h"
11
#include "clang/Driver/Action.h"
12
#include "clang/Driver/Driver.h"
13
#include "clang/Driver/DriverDiagnostic.h"
14
#include "clang/Driver/Job.h"
15
#include "clang/Driver/Options.h"
16
#include "clang/Driver/ToolChain.h"
17
#include "clang/Driver/Util.h"
18
#include "llvm/ADT/None.h"
19
#include "llvm/ADT/STLExtras.h"
20
#include "llvm/ADT/SmallVector.h"
21
#include "llvm/ADT/Triple.h"
22
#include "llvm/Option/ArgList.h"
23
#include "llvm/Option/OptSpecifier.h"
24
#include "llvm/Option/Option.h"
25
#include "llvm/Support/FileSystem.h"
26
#include "llvm/Support/raw_ostream.h"
27
#include <cassert>
28
#include <string>
29
#include <system_error>
30
#include <utility>
31
32
using namespace clang;
33
using namespace driver;
34
using namespace llvm::opt;
35
36
Compilation::Compilation(const Driver &D, const ToolChain &_DefaultToolChain,
37
                         InputArgList *_Args, DerivedArgList *_TranslatedArgs,
38
                         bool ContainsError)
39
    : TheDriver(D), DefaultToolChain(_DefaultToolChain), Args(_Args),
40
46.3k
      TranslatedArgs(_TranslatedArgs), ContainsError(ContainsError) {
41
  // The offloading host toolchain is the default toolchain.
42
46.3k
  OrderedOffloadingToolchains.insert(
43
46.3k
      std::make_pair(Action::OFK_Host, &DefaultToolChain));
44
46.3k
}
45
46
46.3k
Compilation::~Compilation() {
47
  // Remove temporary files. This must be done before arguments are freed, as
48
  // the file names might be derived from the input arguments.
49
46.3k
  if (!TheDriver.isSaveTempsEnabled() && 
!ForceKeepTempFiles46.2k
)
50
46.2k
    CleanupFileList(TempFiles);
51
46.3k
52
46.3k
  delete TranslatedArgs;
53
46.3k
  delete Args;
54
46.3k
55
  // Free any derived arg lists.
56
46.3k
  for (auto Arg : TCArgs)
57
46.2k
    if (Arg.second != TranslatedArgs)
58
29.5k
      delete Arg.second;
59
46.3k
}
60
61
const DerivedArgList &
62
Compilation::getArgsForToolChain(const ToolChain *TC, StringRef BoundArch,
63
103k
                                 Action::OffloadKind DeviceOffloadKind) {
64
103k
  if (!TC)
65
439
    TC = &DefaultToolChain;
66
103k
67
103k
  DerivedArgList *&Entry = TCArgs[{TC, BoundArch, DeviceOffloadKind}];
68
103k
  if (!Entry) {
69
46.2k
    SmallVector<Arg *, 4> AllocatedArgs;
70
46.2k
    DerivedArgList *OpenMPArgs = nullptr;
71
    // Translate OpenMP toolchain arguments provided via the -Xopenmp-target flags.
72
46.2k
    if (DeviceOffloadKind == Action::OFK_OpenMP) {
73
85
      const ToolChain *HostTC = getSingleOffloadToolChain<Action::OFK_Host>();
74
85
      bool SameTripleAsHost = (TC->getTriple() == HostTC->getTriple());
75
85
      OpenMPArgs = TC->TranslateOpenMPTargetArgs(
76
85
          *TranslatedArgs, SameTripleAsHost, AllocatedArgs);
77
85
    }
78
46.2k
79
46.2k
    DerivedArgList *NewDAL = nullptr;
80
46.2k
    if (!OpenMPArgs) {
81
46.2k
      NewDAL = TC->TranslateXarchArgs(*TranslatedArgs, BoundArch,
82
46.2k
                                      DeviceOffloadKind, &AllocatedArgs);
83
45
    } else {
84
45
      NewDAL = TC->TranslateXarchArgs(*OpenMPArgs, BoundArch, DeviceOffloadKind,
85
45
                                      &AllocatedArgs);
86
45
      if (!NewDAL)
87
45
        NewDAL = OpenMPArgs;
88
0
      else
89
0
        delete OpenMPArgs;
90
45
    }
91
46.2k
92
46.2k
    if (!NewDAL) {
93
46.1k
      Entry = TC->TranslateArgs(*TranslatedArgs, BoundArch, DeviceOffloadKind);
94
46.1k
      if (!Entry)
95
16.7k
        Entry = TranslatedArgs;
96
53
    } else {
97
53
      Entry = TC->TranslateArgs(*NewDAL, BoundArch, DeviceOffloadKind);
98
53
      if (!Entry)
99
0
        Entry = NewDAL;
100
53
      else
101
53
        delete NewDAL;
102
53
    }
103
46.2k
104
    // Add allocated arguments to the final DAL.
105
46.2k
    for (auto ArgPtr : AllocatedArgs)
106
53
      Entry->AddSynthesizedArg(ArgPtr);
107
46.2k
  }
108
103k
109
103k
  return *Entry;
110
103k
}
111
112
5.75k
bool Compilation::CleanupFile(const char *File, bool IssueErrors) const {
113
  // FIXME: Why are we trying to remove files that we have not created? For
114
  // example we should only try to remove a temporary assembly file if
115
  // "clang -cc1" succeed in writing it. Was this a workaround for when
116
  // clang was writing directly to a .s file and sometimes leaving it behind
117
  // during a failure?
118
5.75k
119
  // FIXME: If this is necessary, we can still try to split
120
  // llvm::sys::fs::remove into a removeFile and a removeDir and avoid the
121
  // duplicated stat from is_regular_file.
122
5.75k
123
  // Don't try to remove files which we don't have write access to (but may be
124
  // able to remove), or non-regular files. Underlying tools may have
125
  // intentionally not overwritten them.
126
5.75k
  if (!llvm::sys::fs::can_write(File) || 
!llvm::sys::fs::is_regular_file(File)5.63k
)
127
138
    return true;
128
5.61k
129
5.61k
  if (std::error_code EC = llvm::sys::fs::remove(File)) {
130
    // Failure is only failure if the file exists and is "regular". We checked
131
    // for it being regular before, and llvm::sys::fs::remove ignores ENOENT,
132
    // so we don't need to check again.
133
0
134
0
    if (IssueErrors)
135
0
      getDriver().Diag(diag::err_drv_unable_to_remove_file)
136
0
        << EC.message();
137
0
    return false;
138
0
  }
139
5.61k
  return true;
140
5.61k
}
141
142
bool Compilation::CleanupFileList(const llvm::opt::ArgStringList &Files,
143
46.2k
                                  bool IssueErrors) const {
144
46.2k
  bool Success = true;
145
46.2k
  for (const auto &File: Files)
146
5.62k
    Success &= CleanupFile(File, IssueErrors);
147
46.2k
  return Success;
148
46.2k
}
149
150
bool Compilation::CleanupFileMap(const ArgStringMap &Files,
151
                                 const JobAction *JA,
152
254
                                 bool IssueErrors) const {
153
254
  bool Success = true;
154
195
  for (const auto &File : Files) {
155
    // If specified, only delete the files associated with the JobAction.
156
    // Otherwise, delete all files in the map.
157
195
    if (JA && File.first != JA)
158
63
      continue;
159
132
    Success &= CleanupFile(File.second, IssueErrors);
160
132
  }
161
254
  return Success;
162
254
}
163
164
int Compilation::ExecuteCommand(const Command &C,
165
11.0k
                                const Command *&FailingCommand) const {
166
11.0k
  if ((getDriver().CCPrintOptions ||
167
11.0k
       getArgs().hasArg(options::OPT_v)) && 
!getDriver().CCGenDiagnostics38
) {
168
38
    raw_ostream *OS = &llvm::errs();
169
38
    std::unique_ptr<llvm::raw_fd_ostream> OwnedStream;
170
38
171
    // Follow gcc implementation of CC_PRINT_OPTIONS; we could also cache the
172
    // output stream.
173
38
    if (getDriver().CCPrintOptions && 
getDriver().CCPrintOptionsFilename1
) {
174
1
      std::error_code EC;
175
1
      OwnedStream.reset(new llvm::raw_fd_ostream(
176
1
          getDriver().CCPrintOptionsFilename, EC,
177
1
          llvm::sys::fs::OF_Append | llvm::sys::fs::OF_Text));
178
1
      if (EC) {
179
0
        getDriver().Diag(diag::err_drv_cc_print_options_failure)
180
0
            << EC.message();
181
0
        FailingCommand = &C;
182
0
        return 1;
183
0
      }
184
1
      OS = OwnedStream.get();
185
1
    }
186
38
187
38
    if (getDriver().CCPrintOptions)
188
1
      *OS << "[Logging clang options]\n";
189
38
190
38
    C.Print(*OS, "\n", /*Quote=*/getDriver().CCPrintOptions);
191
38
  }
192
11.0k
193
11.0k
  std::string Error;
194
11.0k
  bool ExecutionFailed;
195
11.0k
  int Res = C.Execute(Redirects, &Error, &ExecutionFailed);
196
11.0k
  if (!Error.empty()) {
197
1
    assert(Res && "Error string set with 0 result code!");
198
1
    getDriver().Diag(diag::err_drv_command_failure) << Error;
199
1
  }
200
11.0k
201
11.0k
  if (Res)
202
245
    FailingCommand = &C;
203
11.0k
204
11.0k
  return ExecutionFailed ? 
11
: Res;
205
11.0k
}
206
207
using FailingCommandList = SmallVectorImpl<std::pair<int, const Command *>>;
208
209
static bool ActionFailed(const Action *A,
210
11.1k
                         const FailingCommandList &FailingCommands) {
211
11.1k
  if (FailingCommands.empty())
212
11.0k
    return false;
213
144
214
  // CUDA/HIP can have the same input source code compiled multiple times so do
215
  // not compiled again if there are already failures. It is OK to abort the
216
  // CUDA pipeline on errors.
217
144
  if (A->isOffloading(Action::OFK_Cuda) || 
A->isOffloading(Action::OFK_HIP)129
)
218
15
    return true;
219
129
220
129
  for (const auto &CI : FailingCommands)
221
147
    if (A == &(CI.second->getSource()))
222
35
      return true;
223
129
224
94
  for (const auto *AI : A->inputs())
225
75
    if (ActionFailed(AI, FailingCommands))
226
41
      return true;
227
94
228
53
  return false;
229
94
}
230
231
static bool InputsOk(const Command &C,
232
11.0k
                     const FailingCommandList &FailingCommands) {
233
11.0k
  return !ActionFailed(&C.getSource(), FailingCommands);
234
11.0k
}
235
236
void Compilation::ExecuteJobs(const JobList &Jobs,
237
12.0k
                              FailingCommandList &FailingCommands) const {
238
  // According to UNIX standard, driver need to continue compiling all the
239
  // inputs on the command line even one of them failed.
240
  // In all but CLMode, execute all the jobs unless the necessary inputs for the
241
  // job is missing due to previous failures.
242
11.0k
  for (const auto &Job : Jobs) {
243
11.0k
    if (!InputsOk(Job, FailingCommands))
244
50
      continue;
245
11.0k
    const Command *FailingCommand = nullptr;
246
11.0k
    if (int Res = ExecuteCommand(Job, FailingCommand)) {
247
245
      FailingCommands.push_back(std::make_pair(Res, FailingCommand));
248
      // Bail as soon as one command fails in cl driver mode.
249
245
      if (TheDriver.IsCLMode())
250
4
        return;
251
245
    }
252
11.0k
  }
253
12.0k
}
254
255
27
void Compilation::initCompilationForDiagnostics() {
256
27
  ForDiagnostics = true;
257
27
258
  // Free actions and jobs.
259
27
  Actions.clear();
260
27
  AllActions.clear();
261
27
  Jobs.clear();
262
27
263
  // Remove temporary files.
264
27
  if (!TheDriver.isSaveTempsEnabled() && !ForceKeepTempFiles)
265
27
    CleanupFileList(TempFiles);
266
27
267
  // Clear temporary/results file lists.
268
27
  TempFiles.clear();
269
27
  ResultFiles.clear();
270
27
  FailureResultFiles.clear();
271
27
272
  // Remove any user specified output.  Claim any unclaimed arguments, so as
273
  // to avoid emitting warnings about unused args.
274
27
  OptSpecifier OutputOpts[] = {
275
27
      options::OPT_o,  options::OPT_MD, options::OPT_MMD, options::OPT_M,
276
27
      options::OPT_MM, options::OPT_MF, options::OPT_MG,  options::OPT_MJ,
277
27
      options::OPT_MQ, options::OPT_MT, options::OPT_MV};
278
324
  for (unsigned i = 0, e = llvm::array_lengthof(OutputOpts); i != e; 
++i297
) {
279
297
    if (TranslatedArgs->hasArg(OutputOpts[i]))
280
5
      TranslatedArgs->eraseArg(OutputOpts[i]);
281
297
  }
282
27
  TranslatedArgs->ClaimAllArgs();
283
27
284
  // Force re-creation of the toolchain Args, otherwise our modifications just
285
  // above will have no effect.
286
27
  for (auto Arg : TCArgs)
287
27
    if (Arg.second != TranslatedArgs)
288
27
      delete Arg.second;
289
27
  TCArgs.clear();
290
27
291
  // Redirect stdout/stderr to /dev/null.
292
27
  Redirects = {None, {""}, {""}};
293
27
294
  // Temporary files added by diagnostics should be kept.
295
27
  ForceKeepTempFiles = true;
296
27
}
297
298
45.8k
StringRef Compilation::getSysRoot() const {
299
45.8k
  return getDriver().SysRoot;
300
45.8k
}
301
302
0
void Compilation::Redirect(ArrayRef<Optional<StringRef>> Redirects) {
303
0
  this->Redirects = Redirects;
304
0
}