]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - tools/driver/driver.cpp
Vendor import of clang trunk r321017:
[FreeBSD/FreeBSD.git] / tools / driver / driver.cpp
1 //===-- driver.cpp - Clang GCC-Compatible Driver --------------------------===//
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 // This is the entry point to the clang driver; it is a thin wrapper
11 // for functionality in the Driver clang library.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "clang/Basic/DiagnosticOptions.h"
16 #include "clang/Driver/Compilation.h"
17 #include "clang/Driver/Driver.h"
18 #include "clang/Driver/DriverDiagnostic.h"
19 #include "clang/Driver/Options.h"
20 #include "clang/Driver/ToolChain.h"
21 #include "clang/Frontend/ChainedDiagnosticConsumer.h"
22 #include "clang/Frontend/CompilerInvocation.h"
23 #include "clang/Frontend/SerializedDiagnosticPrinter.h"
24 #include "clang/Frontend/TextDiagnosticPrinter.h"
25 #include "clang/Frontend/Utils.h"
26 #include "llvm/ADT/ArrayRef.h"
27 #include "llvm/ADT/SmallString.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/Config/llvm-config.h"
30 #include "llvm/Option/ArgList.h"
31 #include "llvm/Option/OptTable.h"
32 #include "llvm/Option/Option.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/FileSystem.h"
36 #include "llvm/Support/Host.h"
37 #include "llvm/Support/ManagedStatic.h"
38 #include "llvm/Support/Path.h"
39 #include "llvm/Support/PrettyStackTrace.h"
40 #include "llvm/Support/Process.h"
41 #include "llvm/Support/Program.h"
42 #include "llvm/Support/Regex.h"
43 #include "llvm/Support/Signals.h"
44 #include "llvm/Support/StringSaver.h"
45 #include "llvm/Support/TargetSelect.h"
46 #include "llvm/Support/Timer.h"
47 #include "llvm/Support/raw_ostream.h"
48 #include <memory>
49 #include <set>
50 #include <system_error>
51 using namespace clang;
52 using namespace clang::driver;
53 using namespace llvm::opt;
54
55 std::string GetExecutablePath(const char *Argv0, bool CanonicalPrefixes) {
56   if (!CanonicalPrefixes) {
57     SmallString<128> ExecutablePath(Argv0);
58     // Do a PATH lookup if Argv0 isn't a valid path.
59     if (!llvm::sys::fs::exists(ExecutablePath))
60       if (llvm::ErrorOr<std::string> P =
61               llvm::sys::findProgramByName(ExecutablePath))
62         ExecutablePath = *P;
63     return ExecutablePath.str();
64   }
65
66   // This just needs to be some symbol in the binary; C++ doesn't
67   // allow taking the address of ::main however.
68   void *P = (void*) (intptr_t) GetExecutablePath;
69   return llvm::sys::fs::getMainExecutable(Argv0, P);
70 }
71
72 static const char *GetStableCStr(std::set<std::string> &SavedStrings,
73                                  StringRef S) {
74   return SavedStrings.insert(S).first->c_str();
75 }
76
77 /// ApplyQAOverride - Apply a list of edits to the input argument lists.
78 ///
79 /// The input string is a space separate list of edits to perform,
80 /// they are applied in order to the input argument lists. Edits
81 /// should be one of the following forms:
82 ///
83 ///  '#': Silence information about the changes to the command line arguments.
84 ///
85 ///  '^': Add FOO as a new argument at the beginning of the command line.
86 ///
87 ///  '+': Add FOO as a new argument at the end of the command line.
88 ///
89 ///  's/XXX/YYY/': Substitute the regular expression XXX with YYY in the command
90 ///  line.
91 ///
92 ///  'xOPTION': Removes all instances of the literal argument OPTION.
93 ///
94 ///  'XOPTION': Removes all instances of the literal argument OPTION,
95 ///  and the following argument.
96 ///
97 ///  'Ox': Removes all flags matching 'O' or 'O[sz0-9]' and adds 'Ox'
98 ///  at the end of the command line.
99 ///
100 /// \param OS - The stream to write edit information to.
101 /// \param Args - The vector of command line arguments.
102 /// \param Edit - The override command to perform.
103 /// \param SavedStrings - Set to use for storing string representations.
104 static void ApplyOneQAOverride(raw_ostream &OS,
105                                SmallVectorImpl<const char*> &Args,
106                                StringRef Edit,
107                                std::set<std::string> &SavedStrings) {
108   // This does not need to be efficient.
109
110   if (Edit[0] == '^') {
111     const char *Str =
112       GetStableCStr(SavedStrings, Edit.substr(1));
113     OS << "### Adding argument " << Str << " at beginning\n";
114     Args.insert(Args.begin() + 1, Str);
115   } else if (Edit[0] == '+') {
116     const char *Str =
117       GetStableCStr(SavedStrings, Edit.substr(1));
118     OS << "### Adding argument " << Str << " at end\n";
119     Args.push_back(Str);
120   } else if (Edit[0] == 's' && Edit[1] == '/' && Edit.endswith("/") &&
121              Edit.slice(2, Edit.size()-1).find('/') != StringRef::npos) {
122     StringRef MatchPattern = Edit.substr(2).split('/').first;
123     StringRef ReplPattern = Edit.substr(2).split('/').second;
124     ReplPattern = ReplPattern.slice(0, ReplPattern.size()-1);
125
126     for (unsigned i = 1, e = Args.size(); i != e; ++i) {
127       // Ignore end-of-line response file markers
128       if (Args[i] == nullptr)
129         continue;
130       std::string Repl = llvm::Regex(MatchPattern).sub(ReplPattern, Args[i]);
131
132       if (Repl != Args[i]) {
133         OS << "### Replacing '" << Args[i] << "' with '" << Repl << "'\n";
134         Args[i] = GetStableCStr(SavedStrings, Repl);
135       }
136     }
137   } else if (Edit[0] == 'x' || Edit[0] == 'X') {
138     auto Option = Edit.substr(1);
139     for (unsigned i = 1; i < Args.size();) {
140       if (Option == Args[i]) {
141         OS << "### Deleting argument " << Args[i] << '\n';
142         Args.erase(Args.begin() + i);
143         if (Edit[0] == 'X') {
144           if (i < Args.size()) {
145             OS << "### Deleting argument " << Args[i] << '\n';
146             Args.erase(Args.begin() + i);
147           } else
148             OS << "### Invalid X edit, end of command line!\n";
149         }
150       } else
151         ++i;
152     }
153   } else if (Edit[0] == 'O') {
154     for (unsigned i = 1; i < Args.size();) {
155       const char *A = Args[i];
156       // Ignore end-of-line response file markers
157       if (A == nullptr)
158         continue;
159       if (A[0] == '-' && A[1] == 'O' &&
160           (A[2] == '\0' ||
161            (A[3] == '\0' && (A[2] == 's' || A[2] == 'z' ||
162                              ('0' <= A[2] && A[2] <= '9'))))) {
163         OS << "### Deleting argument " << Args[i] << '\n';
164         Args.erase(Args.begin() + i);
165       } else
166         ++i;
167     }
168     OS << "### Adding argument " << Edit << " at end\n";
169     Args.push_back(GetStableCStr(SavedStrings, '-' + Edit.str()));
170   } else {
171     OS << "### Unrecognized edit: " << Edit << "\n";
172   }
173 }
174
175 /// ApplyQAOverride - Apply a comma separate list of edits to the
176 /// input argument lists. See ApplyOneQAOverride.
177 static void ApplyQAOverride(SmallVectorImpl<const char*> &Args,
178                             const char *OverrideStr,
179                             std::set<std::string> &SavedStrings) {
180   raw_ostream *OS = &llvm::errs();
181
182   if (OverrideStr[0] == '#') {
183     ++OverrideStr;
184     OS = &llvm::nulls();
185   }
186
187   *OS << "### CCC_OVERRIDE_OPTIONS: " << OverrideStr << "\n";
188
189   // This does not need to be efficient.
190
191   const char *S = OverrideStr;
192   while (*S) {
193     const char *End = ::strchr(S, ' ');
194     if (!End)
195       End = S + strlen(S);
196     if (End != S)
197       ApplyOneQAOverride(*OS, Args, std::string(S, End), SavedStrings);
198     S = End;
199     if (*S != '\0')
200       ++S;
201   }
202 }
203
204 extern int cc1_main(ArrayRef<const char *> Argv, const char *Argv0,
205                     void *MainAddr);
206 extern int cc1as_main(ArrayRef<const char *> Argv, const char *Argv0,
207                       void *MainAddr);
208
209 static void insertTargetAndModeArgs(const ParsedClangName &NameParts,
210                                     SmallVectorImpl<const char *> &ArgVector,
211                                     std::set<std::string> &SavedStrings) {
212   // Put target and mode arguments at the start of argument list so that
213   // arguments specified in command line could override them. Avoid putting
214   // them at index 0, as an option like '-cc1' must remain the first.
215   auto InsertionPoint = ArgVector.begin();
216   if (InsertionPoint != ArgVector.end())
217     ++InsertionPoint;
218
219   if (NameParts.DriverMode) {
220     // Add the mode flag to the arguments.
221     ArgVector.insert(InsertionPoint,
222                      GetStableCStr(SavedStrings, NameParts.DriverMode));
223   }
224
225   if (NameParts.TargetIsValid) {
226     const char *arr[] = {"-target", GetStableCStr(SavedStrings,
227                                                   NameParts.TargetPrefix)};
228     ArgVector.insert(InsertionPoint, std::begin(arr), std::end(arr));
229   }
230 }
231
232 static void getCLEnvVarOptions(std::string &EnvValue, llvm::StringSaver &Saver,
233                                SmallVectorImpl<const char *> &Opts) {
234   llvm::cl::TokenizeWindowsCommandLine(EnvValue, Saver, Opts);
235   // The first instance of '#' should be replaced with '=' in each option.
236   for (const char *Opt : Opts)
237     if (char *NumberSignPtr = const_cast<char *>(::strchr(Opt, '#')))
238       *NumberSignPtr = '=';
239 }
240
241 static void SetBackdoorDriverOutputsFromEnvVars(Driver &TheDriver) {
242   // Handle CC_PRINT_OPTIONS and CC_PRINT_OPTIONS_FILE.
243   TheDriver.CCPrintOptions = !!::getenv("CC_PRINT_OPTIONS");
244   if (TheDriver.CCPrintOptions)
245     TheDriver.CCPrintOptionsFilename = ::getenv("CC_PRINT_OPTIONS_FILE");
246
247   // Handle CC_PRINT_HEADERS and CC_PRINT_HEADERS_FILE.
248   TheDriver.CCPrintHeaders = !!::getenv("CC_PRINT_HEADERS");
249   if (TheDriver.CCPrintHeaders)
250     TheDriver.CCPrintHeadersFilename = ::getenv("CC_PRINT_HEADERS_FILE");
251
252   // Handle CC_LOG_DIAGNOSTICS and CC_LOG_DIAGNOSTICS_FILE.
253   TheDriver.CCLogDiagnostics = !!::getenv("CC_LOG_DIAGNOSTICS");
254   if (TheDriver.CCLogDiagnostics)
255     TheDriver.CCLogDiagnosticsFilename = ::getenv("CC_LOG_DIAGNOSTICS_FILE");
256 }
257
258 static void FixupDiagPrefixExeName(TextDiagnosticPrinter *DiagClient,
259                                    const std::string &Path) {
260   // If the clang binary happens to be named cl.exe for compatibility reasons,
261   // use clang-cl.exe as the prefix to avoid confusion between clang and MSVC.
262   StringRef ExeBasename(llvm::sys::path::filename(Path));
263   if (ExeBasename.equals_lower("cl.exe"))
264     ExeBasename = "clang-cl.exe";
265   DiagClient->setPrefix(ExeBasename);
266 }
267
268 // This lets us create the DiagnosticsEngine with a properly-filled-out
269 // DiagnosticOptions instance.
270 static DiagnosticOptions *
271 CreateAndPopulateDiagOpts(ArrayRef<const char *> argv) {
272   auto *DiagOpts = new DiagnosticOptions;
273   std::unique_ptr<OptTable> Opts(createDriverOptTable());
274   unsigned MissingArgIndex, MissingArgCount;
275   InputArgList Args =
276       Opts->ParseArgs(argv.slice(1), MissingArgIndex, MissingArgCount);
277   // We ignore MissingArgCount and the return value of ParseDiagnosticArgs.
278   // Any errors that would be diagnosed here will also be diagnosed later,
279   // when the DiagnosticsEngine actually exists.
280   (void)ParseDiagnosticArgs(*DiagOpts, Args);
281   return DiagOpts;
282 }
283
284 static void SetInstallDir(SmallVectorImpl<const char *> &argv,
285                           Driver &TheDriver, bool CanonicalPrefixes) {
286   // Attempt to find the original path used to invoke the driver, to determine
287   // the installed path. We do this manually, because we want to support that
288   // path being a symlink.
289   SmallString<128> InstalledPath(argv[0]);
290
291   // Do a PATH lookup, if there are no directory components.
292   if (llvm::sys::path::filename(InstalledPath) == InstalledPath)
293     if (llvm::ErrorOr<std::string> Tmp = llvm::sys::findProgramByName(
294             llvm::sys::path::filename(InstalledPath.str())))
295       InstalledPath = *Tmp;
296
297   // FIXME: We don't actually canonicalize this, we just make it absolute.
298   if (CanonicalPrefixes)
299     llvm::sys::fs::make_absolute(InstalledPath);
300
301   StringRef InstalledPathParent(llvm::sys::path::parent_path(InstalledPath));
302   if (llvm::sys::fs::exists(InstalledPathParent))
303     TheDriver.setInstalledDir(InstalledPathParent);
304 }
305
306 static int ExecuteCC1Tool(ArrayRef<const char *> argv, StringRef Tool) {
307   void *GetExecutablePathVP = (void *)(intptr_t) GetExecutablePath;
308   if (Tool == "")
309     return cc1_main(argv.slice(2), argv[0], GetExecutablePathVP);
310   if (Tool == "as")
311     return cc1as_main(argv.slice(2), argv[0], GetExecutablePathVP);
312
313   // Reject unknown tools.
314   llvm::errs() << "error: unknown integrated tool '" << Tool << "'\n";
315   return 1;
316 }
317
318 int main(int argc_, const char **argv_) {
319   llvm::sys::PrintStackTraceOnErrorSignal(argv_[0]);
320   llvm::PrettyStackTraceProgram X(argc_, argv_);
321   llvm::llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
322
323   if (llvm::sys::Process::FixupStandardFileDescriptors())
324     return 1;
325
326   SmallVector<const char *, 256> argv;
327   llvm::SpecificBumpPtrAllocator<char> ArgAllocator;
328   std::error_code EC = llvm::sys::Process::GetArgumentVector(
329       argv, llvm::makeArrayRef(argv_, argc_), ArgAllocator);
330   if (EC) {
331     llvm::errs() << "error: couldn't get arguments: " << EC.message() << '\n';
332     return 1;
333   }
334
335   llvm::InitializeAllTargets();
336   auto TargetAndMode = ToolChain::getTargetAndModeFromProgramName(argv[0]);
337
338   llvm::BumpPtrAllocator A;
339   llvm::StringSaver Saver(A);
340
341   // Parse response files using the GNU syntax, unless we're in CL mode. There
342   // are two ways to put clang in CL compatibility mode: argv[0] is either
343   // clang-cl or cl, or --driver-mode=cl is on the command line. The normal
344   // command line parsing can't happen until after response file parsing, so we
345   // have to manually search for a --driver-mode=cl argument the hard way.
346   // Finally, our -cc1 tools don't care which tokenization mode we use because
347   // response files written by clang will tokenize the same way in either mode.
348   bool ClangCLMode = false;
349   if (StringRef(TargetAndMode.DriverMode).equals("--driver-mode=cl") ||
350       std::find_if(argv.begin(), argv.end(), [](const char *F) {
351         return F && strcmp(F, "--driver-mode=cl") == 0;
352       }) != argv.end()) {
353     ClangCLMode = true;
354   }
355   enum { Default, POSIX, Windows } RSPQuoting = Default;
356   for (const char *F : argv) {
357     if (strcmp(F, "--rsp-quoting=posix") == 0)
358       RSPQuoting = POSIX;
359     else if (strcmp(F, "--rsp-quoting=windows") == 0)
360       RSPQuoting = Windows;
361   }
362
363   // Determines whether we want nullptr markers in argv to indicate response
364   // files end-of-lines. We only use this for the /LINK driver argument with
365   // clang-cl.exe on Windows.
366   bool MarkEOLs = ClangCLMode;
367
368   llvm::cl::TokenizerCallback Tokenizer;
369   if (RSPQuoting == Windows || (RSPQuoting == Default && ClangCLMode))
370     Tokenizer = &llvm::cl::TokenizeWindowsCommandLine;
371   else
372     Tokenizer = &llvm::cl::TokenizeGNUCommandLine;
373
374   if (MarkEOLs && argv.size() > 1 && StringRef(argv[1]).startswith("-cc1"))
375     MarkEOLs = false;
376   llvm::cl::ExpandResponseFiles(Saver, Tokenizer, argv, MarkEOLs);
377
378   // Handle -cc1 integrated tools, even if -cc1 was expanded from a response
379   // file.
380   auto FirstArg = std::find_if(argv.begin() + 1, argv.end(),
381                                [](const char *A) { return A != nullptr; });
382   if (FirstArg != argv.end() && StringRef(*FirstArg).startswith("-cc1")) {
383     // If -cc1 came from a response file, remove the EOL sentinels.
384     if (MarkEOLs) {
385       auto newEnd = std::remove(argv.begin(), argv.end(), nullptr);
386       argv.resize(newEnd - argv.begin());
387     }
388     return ExecuteCC1Tool(argv, argv[1] + 4);
389   }
390
391   bool CanonicalPrefixes = true;
392   for (int i = 1, size = argv.size(); i < size; ++i) {
393     // Skip end-of-line response file markers
394     if (argv[i] == nullptr)
395       continue;
396     if (StringRef(argv[i]) == "-no-canonical-prefixes") {
397       CanonicalPrefixes = false;
398       break;
399     }
400   }
401
402   // Handle CL and _CL_ which permits additional command line options to be
403   // prepended or appended.
404   if (ClangCLMode) {
405     // Arguments in "CL" are prepended.
406     llvm::Optional<std::string> OptCL = llvm::sys::Process::GetEnv("CL");
407     if (OptCL.hasValue()) {
408       SmallVector<const char *, 8> PrependedOpts;
409       getCLEnvVarOptions(OptCL.getValue(), Saver, PrependedOpts);
410
411       // Insert right after the program name to prepend to the argument list.
412       argv.insert(argv.begin() + 1, PrependedOpts.begin(), PrependedOpts.end());
413     }
414     // Arguments in "_CL_" are appended.
415     llvm::Optional<std::string> Opt_CL_ = llvm::sys::Process::GetEnv("_CL_");
416     if (Opt_CL_.hasValue()) {
417       SmallVector<const char *, 8> AppendedOpts;
418       getCLEnvVarOptions(Opt_CL_.getValue(), Saver, AppendedOpts);
419
420       // Insert at the end of the argument list to append.
421       argv.append(AppendedOpts.begin(), AppendedOpts.end());
422     }
423   }
424
425   std::set<std::string> SavedStrings;
426   // Handle CCC_OVERRIDE_OPTIONS, used for editing a command line behind the
427   // scenes.
428   if (const char *OverrideStr = ::getenv("CCC_OVERRIDE_OPTIONS")) {
429     // FIXME: Driver shouldn't take extra initial argument.
430     ApplyQAOverride(argv, OverrideStr, SavedStrings);
431   }
432
433   std::string Path = GetExecutablePath(argv[0], CanonicalPrefixes);
434
435   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts =
436       CreateAndPopulateDiagOpts(argv);
437
438   TextDiagnosticPrinter *DiagClient
439     = new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts);
440   FixupDiagPrefixExeName(DiagClient, Path);
441
442   IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
443
444   DiagnosticsEngine Diags(DiagID, &*DiagOpts, DiagClient);
445
446   if (!DiagOpts->DiagnosticSerializationFile.empty()) {
447     auto SerializedConsumer =
448         clang::serialized_diags::create(DiagOpts->DiagnosticSerializationFile,
449                                         &*DiagOpts, /*MergeChildRecords=*/true);
450     Diags.setClient(new ChainedDiagnosticConsumer(
451         Diags.takeClient(), std::move(SerializedConsumer)));
452   }
453
454   ProcessWarningOptions(Diags, *DiagOpts, /*ReportDiags=*/false);
455
456   Driver TheDriver(Path, llvm::sys::getDefaultTargetTriple(), Diags);
457   SetInstallDir(argv, TheDriver, CanonicalPrefixes);
458   TheDriver.setTargetAndMode(TargetAndMode);
459
460   insertTargetAndModeArgs(TargetAndMode, argv, SavedStrings);
461
462   SetBackdoorDriverOutputsFromEnvVars(TheDriver);
463
464   std::unique_ptr<Compilation> C(TheDriver.BuildCompilation(argv));
465   int Res = 1;
466   if (C && !C->containsError()) {
467     SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
468     Res = TheDriver.ExecuteCompilation(*C, FailingCommands);
469
470     // Force a crash to test the diagnostics.
471     if (TheDriver.GenReproducer) {
472       Diags.Report(diag::err_drv_force_crash)
473         << !::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH");
474
475       // Pretend that every command failed.
476       FailingCommands.clear();
477       for (const auto &J : C->getJobs())
478         if (const Command *C = dyn_cast<Command>(&J))
479           FailingCommands.push_back(std::make_pair(-1, C));
480     }
481
482     for (const auto &P : FailingCommands) {
483       int CommandRes = P.first;
484       const Command *FailingCommand = P.second;
485       if (!Res)
486         Res = CommandRes;
487
488       // If result status is < 0, then the driver command signalled an error.
489       // If result status is 70, then the driver command reported a fatal error.
490       // On Windows, abort will return an exit code of 3.  In these cases,
491       // generate additional diagnostic information if possible.
492       bool DiagnoseCrash = CommandRes < 0 || CommandRes == 70;
493 #ifdef LLVM_ON_WIN32
494       DiagnoseCrash |= CommandRes == 3;
495 #endif
496       if (DiagnoseCrash) {
497         TheDriver.generateCompilationDiagnostics(*C, *FailingCommand);
498         break;
499       }
500     }
501   }
502
503   Diags.getClient()->finish();
504
505   // If any timers were active but haven't been destroyed yet, print their
506   // results now.  This happens in -disable-free mode.
507   llvm::TimerGroup::printAll(llvm::errs());
508
509 #ifdef LLVM_ON_WIN32
510   // Exit status should not be negative on Win32, unless abnormal termination.
511   // Once abnormal termiation was caught, negative status should not be
512   // propagated.
513   if (Res < 0)
514     Res = 1;
515 #endif
516
517   // If we have multiple failing commands, we return the result of the first
518   // failing command.
519   return Res;
520 }