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 #include "clang/Driver/Driver.h"
11 #include "InputInfo.h"
12 #include "ToolChains.h"
13 #include "clang/Basic/Version.h"
14 #include "clang/Basic/VirtualFileSystem.h"
15 #include "clang/Config/config.h"
16 #include "clang/Driver/Action.h"
17 #include "clang/Driver/Compilation.h"
18 #include "clang/Driver/DriverDiagnostic.h"
19 #include "clang/Driver/Job.h"
20 #include "clang/Driver/Options.h"
21 #include "clang/Driver/SanitizerArgs.h"
22 #include "clang/Driver/Tool.h"
23 #include "clang/Driver/ToolChain.h"
24 #include "llvm/ADT/ArrayRef.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/ADT/StringExtras.h"
27 #include "llvm/ADT/StringSet.h"
28 #include "llvm/ADT/StringSwitch.h"
29 #include "llvm/Option/Arg.h"
30 #include "llvm/Option/ArgList.h"
31 #include "llvm/Option/OptSpecifier.h"
32 #include "llvm/Option/OptTable.h"
33 #include "llvm/Option/Option.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/PrettyStackTrace.h"
39 #include "llvm/Support/Process.h"
40 #include "llvm/Support/Program.h"
41 #include "llvm/Support/raw_ostream.h"
42 #include <map>
43 #include <memory>
44 
45 using namespace clang::driver;
46 using namespace clang;
47 using namespace llvm::opt;
48 
49 Driver::Driver(StringRef ClangExecutable, StringRef DefaultTargetTriple,
50                DiagnosticsEngine &Diags,
51                IntrusiveRefCntPtr<vfs::FileSystem> VFS)
52     : Opts(createDriverOptTable()), Diags(Diags), VFS(VFS), Mode(GCCMode),
53       SaveTemps(SaveTempsNone), LTOMode(LTOK_None),
54       ClangExecutable(ClangExecutable),
55       SysRoot(DEFAULT_SYSROOT), UseStdLib(true),
56       DefaultTargetTriple(DefaultTargetTriple),
57       DriverTitle("clang LLVM compiler"), CCPrintOptionsFilename(nullptr),
58       CCPrintHeadersFilename(nullptr), CCLogDiagnosticsFilename(nullptr),
59       CCCPrintBindings(false), CCPrintHeaders(false), CCLogDiagnostics(false),
60       CCGenDiagnostics(false), CCCGenericGCCName(""), CheckInputsExist(true),
61       CCCUsePCH(true), SuppressMissingInputWarning(false) {
62 
63   // Provide a sane fallback if no VFS is specified.
64   if (!this->VFS)
65     this->VFS = vfs::getRealFileSystem();
66 
67   Name = llvm::sys::path::filename(ClangExecutable);
68   Dir = llvm::sys::path::parent_path(ClangExecutable);
69   InstalledDir = Dir; // Provide a sensible default installed dir.
70 
71   // Compute the path to the resource directory.
72   StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
73   SmallString<128> P(Dir);
74   if (ClangResourceDir != "") {
75     llvm::sys::path::append(P, ClangResourceDir);
76   } else {
77     StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
78     llvm::sys::path::append(P, "..", Twine("lib") + ClangLibdirSuffix, "clang",
79                             CLANG_VERSION_STRING);
80   }
81   ResourceDir = P.str();
82 }
83 
84 Driver::~Driver() {
85   delete Opts;
86 
87   llvm::DeleteContainerSeconds(ToolChains);
88 }
89 
90 void Driver::ParseDriverMode(ArrayRef<const char *> Args) {
91   const std::string OptName =
92       getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
93 
94   for (const char *ArgPtr : Args) {
95     // Ingore nullptrs, they are response file's EOL markers
96     if (ArgPtr == nullptr)
97       continue;
98     const StringRef Arg = ArgPtr;
99     if (!Arg.startswith(OptName))
100       continue;
101 
102     const StringRef Value = Arg.drop_front(OptName.size());
103     const unsigned M = llvm::StringSwitch<unsigned>(Value)
104                            .Case("gcc", GCCMode)
105                            .Case("g++", GXXMode)
106                            .Case("cpp", CPPMode)
107                            .Case("cl", CLMode)
108                            .Default(~0U);
109 
110     if (M != ~0U)
111       Mode = static_cast<DriverMode>(M);
112     else
113       Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
114   }
115 }
116 
117 InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings) {
118   llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
119 
120   unsigned IncludedFlagsBitmask;
121   unsigned ExcludedFlagsBitmask;
122   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
123       getIncludeExcludeOptionFlagMasks();
124 
125   unsigned MissingArgIndex, MissingArgCount;
126   InputArgList Args =
127       getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
128                           IncludedFlagsBitmask, ExcludedFlagsBitmask);
129 
130   // Check for missing argument error.
131   if (MissingArgCount)
132     Diag(clang::diag::err_drv_missing_argument)
133         << Args.getArgString(MissingArgIndex) << MissingArgCount;
134 
135   // Check for unsupported options.
136   for (const Arg *A : Args) {
137     if (A->getOption().hasFlag(options::Unsupported)) {
138       Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(Args);
139       continue;
140     }
141 
142     // Warn about -mcpu= without an argument.
143     if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
144       Diag(clang::diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
145     }
146   }
147 
148   for (const Arg *A : Args.filtered(options::OPT_UNKNOWN))
149     Diags.Report(IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl :
150                               diag::err_drv_unknown_argument)
151       << A->getAsString(Args);
152 
153   return Args;
154 }
155 
156 // Determine which compilation mode we are in. We look for options which
157 // affect the phase, starting with the earliest phases, and record which
158 // option we used to determine the final phase.
159 phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
160                                  Arg **FinalPhaseArg) const {
161   Arg *PhaseArg = nullptr;
162   phases::ID FinalPhase;
163 
164   // -{E,EP,P,M,MM} only run the preprocessor.
165   if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
166       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
167       (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
168       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
169     FinalPhase = phases::Preprocess;
170 
171     // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
172   } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
173              (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
174              (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
175              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
176              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
177              (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
178              (PhaseArg = DAL.getLastArg(options::OPT__analyze,
179                                         options::OPT__analyze_auto)) ||
180              (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
181     FinalPhase = phases::Compile;
182 
183     // -S only runs up to the backend.
184   } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
185     FinalPhase = phases::Backend;
186 
187     // -c compilation only runs up to the assembler.
188   } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
189     FinalPhase = phases::Assemble;
190 
191     // Otherwise do everything.
192   } else
193     FinalPhase = phases::Link;
194 
195   if (FinalPhaseArg)
196     *FinalPhaseArg = PhaseArg;
197 
198   return FinalPhase;
199 }
200 
201 static Arg *MakeInputArg(DerivedArgList &Args, OptTable *Opts,
202                          StringRef Value) {
203   Arg *A = new Arg(Opts->getOption(options::OPT_INPUT), Value,
204                    Args.getBaseArgs().MakeIndex(Value), Value.data());
205   Args.AddSynthesizedArg(A);
206   A->claim();
207   return A;
208 }
209 
210 DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
211   DerivedArgList *DAL = new DerivedArgList(Args);
212 
213   bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
214   bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
215   for (Arg *A : Args) {
216     // Unfortunately, we have to parse some forwarding options (-Xassembler,
217     // -Xlinker, -Xpreprocessor) because we either integrate their functionality
218     // (assembler and preprocessor), or bypass a previous driver ('collect2').
219 
220     // Rewrite linker options, to replace --no-demangle with a custom internal
221     // option.
222     if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
223          A->getOption().matches(options::OPT_Xlinker)) &&
224         A->containsValue("--no-demangle")) {
225       // Add the rewritten no-demangle argument.
226       DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
227 
228       // Add the remaining values as Xlinker arguments.
229       for (StringRef Val : A->getValues())
230         if (Val != "--no-demangle")
231           DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
232 
233       continue;
234     }
235 
236     // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
237     // some build systems. We don't try to be complete here because we don't
238     // care to encourage this usage model.
239     if (A->getOption().matches(options::OPT_Wp_COMMA) &&
240         (A->getValue(0) == StringRef("-MD") ||
241          A->getValue(0) == StringRef("-MMD"))) {
242       // Rewrite to -MD/-MMD along with -MF.
243       if (A->getValue(0) == StringRef("-MD"))
244         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
245       else
246         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
247       if (A->getNumValues() == 2)
248         DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
249                             A->getValue(1));
250       continue;
251     }
252 
253     // Rewrite reserved library names.
254     if (A->getOption().matches(options::OPT_l)) {
255       StringRef Value = A->getValue();
256 
257       // Rewrite unless -nostdlib is present.
258       if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
259         DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
260         continue;
261       }
262 
263       // Rewrite unconditionally.
264       if (Value == "cc_kext") {
265         DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
266         continue;
267       }
268     }
269 
270     // Pick up inputs via the -- option.
271     if (A->getOption().matches(options::OPT__DASH_DASH)) {
272       A->claim();
273       for (StringRef Val : A->getValues())
274         DAL->append(MakeInputArg(*DAL, Opts, Val));
275       continue;
276     }
277 
278     DAL->append(A);
279   }
280 
281 // Add a default value of -mlinker-version=, if one was given and the user
282 // didn't specify one.
283 #if defined(HOST_LINK_VERSION)
284   if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
285       strlen(HOST_LINK_VERSION) > 0) {
286     DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
287                       HOST_LINK_VERSION);
288     DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
289   }
290 #endif
291 
292   return DAL;
293 }
294 
295 /// \brief Compute target triple from args.
296 ///
297 /// This routine provides the logic to compute a target triple from various
298 /// args passed to the driver and the default triple string.
299 static llvm::Triple computeTargetTriple(StringRef DefaultTargetTriple,
300                                         const ArgList &Args,
301                                         StringRef DarwinArchName = "") {
302   // FIXME: Already done in Compilation *Driver::BuildCompilation
303   if (const Arg *A = Args.getLastArg(options::OPT_target))
304     DefaultTargetTriple = A->getValue();
305 
306   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
307 
308   // Handle Apple-specific options available here.
309   if (Target.isOSBinFormatMachO()) {
310     // If an explict Darwin arch name is given, that trumps all.
311     if (!DarwinArchName.empty()) {
312       tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
313       return Target;
314     }
315 
316     // Handle the Darwin '-arch' flag.
317     if (Arg *A = Args.getLastArg(options::OPT_arch)) {
318       StringRef ArchName = A->getValue();
319       tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
320     }
321   }
322 
323   // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
324   // '-mbig-endian'/'-EB'.
325   if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
326                                options::OPT_mbig_endian)) {
327     if (A->getOption().matches(options::OPT_mlittle_endian)) {
328       llvm::Triple LE = Target.getLittleEndianArchVariant();
329       if (LE.getArch() != llvm::Triple::UnknownArch)
330         Target = std::move(LE);
331     } else {
332       llvm::Triple BE = Target.getBigEndianArchVariant();
333       if (BE.getArch() != llvm::Triple::UnknownArch)
334         Target = std::move(BE);
335     }
336   }
337 
338   // Skip further flag support on OSes which don't support '-m32' or '-m64'.
339   if (Target.getArch() == llvm::Triple::tce ||
340       Target.getOS() == llvm::Triple::Minix)
341     return Target;
342 
343   // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
344   if (Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
345                                options::OPT_m32, options::OPT_m16)) {
346     llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
347 
348     if (A->getOption().matches(options::OPT_m64)) {
349       AT = Target.get64BitArchVariant().getArch();
350       if (Target.getEnvironment() == llvm::Triple::GNUX32)
351         Target.setEnvironment(llvm::Triple::GNU);
352     } else if (A->getOption().matches(options::OPT_mx32) &&
353                Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
354       AT = llvm::Triple::x86_64;
355       Target.setEnvironment(llvm::Triple::GNUX32);
356     } else if (A->getOption().matches(options::OPT_m32)) {
357       AT = Target.get32BitArchVariant().getArch();
358       if (Target.getEnvironment() == llvm::Triple::GNUX32)
359         Target.setEnvironment(llvm::Triple::GNU);
360     } else if (A->getOption().matches(options::OPT_m16) &&
361                Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
362       AT = llvm::Triple::x86;
363       Target.setEnvironment(llvm::Triple::CODE16);
364     }
365 
366     if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
367       Target.setArch(AT);
368   }
369 
370   return Target;
371 }
372 
373 // \brief Parse the LTO options and record the type of LTO compilation
374 // based on which -f(no-)?lto(=.*)? option occurs last.
375 void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
376   LTOMode = LTOK_None;
377   if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
378                     options::OPT_fno_lto, false))
379     return;
380 
381   StringRef LTOName("full");
382 
383   const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
384   if (A)
385     LTOName = A->getValue();
386 
387   LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
388                 .Case("full", LTOK_Full)
389                 .Case("thin", LTOK_Thin)
390                 .Default(LTOK_Unknown);
391 
392   if (LTOMode == LTOK_Unknown) {
393     assert(A);
394     Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
395                                                     << A->getValue();
396   }
397 }
398 
399 Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
400   llvm::PrettyStackTraceString CrashInfo("Compilation construction");
401 
402   // FIXME: Handle environment options which affect driver behavior, somewhere
403   // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
404 
405   if (char *env = ::getenv("COMPILER_PATH")) {
406     StringRef CompilerPath = env;
407     while (!CompilerPath.empty()) {
408       std::pair<StringRef, StringRef> Split =
409           CompilerPath.split(llvm::sys::EnvPathSeparator);
410       PrefixDirs.push_back(Split.first);
411       CompilerPath = Split.second;
412     }
413   }
414 
415   // We look for the driver mode option early, because the mode can affect
416   // how other options are parsed.
417   ParseDriverMode(ArgList.slice(1));
418 
419   // FIXME: What are we going to do with -V and -b?
420 
421   // FIXME: This stuff needs to go into the Compilation, not the driver.
422   bool CCCPrintPhases;
423 
424   InputArgList Args = ParseArgStrings(ArgList.slice(1));
425 
426   // Silence driver warnings if requested
427   Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
428 
429   // -no-canonical-prefixes is used very early in main.
430   Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
431 
432   // Ignore -pipe.
433   Args.ClaimAllArgs(options::OPT_pipe);
434 
435   // Extract -ccc args.
436   //
437   // FIXME: We need to figure out where this behavior should live. Most of it
438   // should be outside in the client; the parts that aren't should have proper
439   // options, either by introducing new ones or by overloading gcc ones like -V
440   // or -b.
441   CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
442   CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
443   if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
444     CCCGenericGCCName = A->getValue();
445   CCCUsePCH =
446       Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
447   // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld
448   // and getToolChain is const.
449   if (IsCLMode()) {
450     // clang-cl targets MSVC-style Win32.
451     llvm::Triple T(DefaultTargetTriple);
452     T.setOS(llvm::Triple::Win32);
453     T.setVendor(llvm::Triple::PC);
454     T.setEnvironment(llvm::Triple::MSVC);
455     DefaultTargetTriple = T.str();
456   }
457   if (const Arg *A = Args.getLastArg(options::OPT_target))
458     DefaultTargetTriple = A->getValue();
459   if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
460     Dir = InstalledDir = A->getValue();
461   for (const Arg *A : Args.filtered(options::OPT_B)) {
462     A->claim();
463     PrefixDirs.push_back(A->getValue(0));
464   }
465   if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
466     SysRoot = A->getValue();
467   if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
468     DyldPrefix = A->getValue();
469   if (Args.hasArg(options::OPT_nostdlib))
470     UseStdLib = false;
471 
472   if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
473     ResourceDir = A->getValue();
474 
475   if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
476     SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
477                     .Case("cwd", SaveTempsCwd)
478                     .Case("obj", SaveTempsObj)
479                     .Default(SaveTempsCwd);
480   }
481 
482   setLTOMode(Args);
483 
484   std::unique_ptr<llvm::opt::InputArgList> UArgs =
485       llvm::make_unique<InputArgList>(std::move(Args));
486 
487   // Perform the default argument translations.
488   DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
489 
490   // Owned by the host.
491   const ToolChain &TC =
492       getToolChain(*UArgs, computeTargetTriple(DefaultTargetTriple, *UArgs));
493 
494   // The compilation takes ownership of Args.
495   Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs);
496 
497   C->setCudaDeviceToolChain(
498       &getToolChain(C->getArgs(), llvm::Triple(TC.getTriple().isArch64Bit()
499                                                    ? "nvptx64-nvidia-cuda"
500                                                    : "nvptx-nvidia-cuda")));
501   if (!HandleImmediateArgs(*C))
502     return C;
503 
504   // Construct the list of inputs.
505   InputList Inputs;
506   BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
507 
508   // Construct the list of abstract actions to perform for this compilation. On
509   // MachO targets this uses the driver-driver and universal actions.
510   if (TC.getTriple().isOSBinFormatMachO())
511     BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
512   else
513     BuildActions(*C, C->getArgs(), Inputs, C->getActions());
514 
515   if (CCCPrintPhases) {
516     PrintActions(*C);
517     return C;
518   }
519 
520   BuildJobs(*C);
521 
522   return C;
523 }
524 
525 static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
526   llvm::opt::ArgStringList ASL;
527   for (const auto *A : Args)
528     A->render(Args, ASL);
529 
530   for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
531     if (I != ASL.begin())
532       OS << ' ';
533     Command::printArg(OS, *I, true);
534   }
535   OS << '\n';
536 }
537 
538 // When clang crashes, produce diagnostic information including the fully
539 // preprocessed source file(s).  Request that the developer attach the
540 // diagnostic information to a bug report.
541 void Driver::generateCompilationDiagnostics(Compilation &C,
542                                             const Command &FailingCommand) {
543   if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
544     return;
545 
546   // Don't try to generate diagnostics for link or dsymutil jobs.
547   if (FailingCommand.getCreator().isLinkJob() ||
548       FailingCommand.getCreator().isDsymutilJob())
549     return;
550 
551   // Print the version of the compiler.
552   PrintVersion(C, llvm::errs());
553 
554   Diag(clang::diag::note_drv_command_failed_diag_msg)
555       << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
556          "crash backtrace, preprocessed source, and associated run script.";
557 
558   // Suppress driver output and emit preprocessor output to temp file.
559   Mode = CPPMode;
560   CCGenDiagnostics = true;
561 
562   // Save the original job command(s).
563   Command Cmd = FailingCommand;
564 
565   // Keep track of whether we produce any errors while trying to produce
566   // preprocessed sources.
567   DiagnosticErrorTrap Trap(Diags);
568 
569   // Suppress tool output.
570   C.initCompilationForDiagnostics();
571 
572   // Construct the list of inputs.
573   InputList Inputs;
574   BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
575 
576   for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
577     bool IgnoreInput = false;
578 
579     // Ignore input from stdin or any inputs that cannot be preprocessed.
580     // Check type first as not all linker inputs have a value.
581     if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
582       IgnoreInput = true;
583     } else if (!strcmp(it->second->getValue(), "-")) {
584       Diag(clang::diag::note_drv_command_failed_diag_msg)
585           << "Error generating preprocessed source(s) - "
586              "ignoring input from stdin.";
587       IgnoreInput = true;
588     }
589 
590     if (IgnoreInput) {
591       it = Inputs.erase(it);
592       ie = Inputs.end();
593     } else {
594       ++it;
595     }
596   }
597 
598   if (Inputs.empty()) {
599     Diag(clang::diag::note_drv_command_failed_diag_msg)
600         << "Error generating preprocessed source(s) - "
601            "no preprocessable inputs.";
602     return;
603   }
604 
605   // Don't attempt to generate preprocessed files if multiple -arch options are
606   // used, unless they're all duplicates.
607   llvm::StringSet<> ArchNames;
608   for (const Arg *A : C.getArgs()) {
609     if (A->getOption().matches(options::OPT_arch)) {
610       StringRef ArchName = A->getValue();
611       ArchNames.insert(ArchName);
612     }
613   }
614   if (ArchNames.size() > 1) {
615     Diag(clang::diag::note_drv_command_failed_diag_msg)
616         << "Error generating preprocessed source(s) - cannot generate "
617            "preprocessed source with multiple -arch options.";
618     return;
619   }
620 
621   // Construct the list of abstract actions to perform for this compilation. On
622   // Darwin OSes this uses the driver-driver and builds universal actions.
623   const ToolChain &TC = C.getDefaultToolChain();
624   if (TC.getTriple().isOSBinFormatMachO())
625     BuildUniversalActions(C, TC, Inputs);
626   else
627     BuildActions(C, C.getArgs(), Inputs, C.getActions());
628 
629   BuildJobs(C);
630 
631   // If there were errors building the compilation, quit now.
632   if (Trap.hasErrorOccurred()) {
633     Diag(clang::diag::note_drv_command_failed_diag_msg)
634         << "Error generating preprocessed source(s).";
635     return;
636   }
637 
638   // Generate preprocessed output.
639   SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
640   C.ExecuteJobs(C.getJobs(), FailingCommands);
641 
642   // If any of the preprocessing commands failed, clean up and exit.
643   if (!FailingCommands.empty()) {
644     if (!isSaveTempsEnabled())
645       C.CleanupFileList(C.getTempFiles(), true);
646 
647     Diag(clang::diag::note_drv_command_failed_diag_msg)
648         << "Error generating preprocessed source(s).";
649     return;
650   }
651 
652   const ArgStringList &TempFiles = C.getTempFiles();
653   if (TempFiles.empty()) {
654     Diag(clang::diag::note_drv_command_failed_diag_msg)
655         << "Error generating preprocessed source(s).";
656     return;
657   }
658 
659   Diag(clang::diag::note_drv_command_failed_diag_msg)
660       << "\n********************\n\n"
661          "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
662          "Preprocessed source(s) and associated run script(s) are located at:";
663 
664   SmallString<128> VFS;
665   for (const char *TempFile : TempFiles) {
666     Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
667     if (StringRef(TempFile).endswith(".cache")) {
668       // In some cases (modules) we'll dump extra data to help with reproducing
669       // the crash into a directory next to the output.
670       VFS = llvm::sys::path::filename(TempFile);
671       llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
672     }
673   }
674 
675   // Assume associated files are based off of the first temporary file.
676   CrashReportInfo CrashInfo(TempFiles[0], VFS);
677 
678   std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh";
679   std::error_code EC;
680   llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
681   if (EC) {
682     Diag(clang::diag::note_drv_command_failed_diag_msg)
683         << "Error generating run script: " + Script + " " + EC.message();
684   } else {
685     ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
686              << "# Driver args: ";
687     printArgList(ScriptOS, C.getInputArgs());
688     ScriptOS << "# Original command: ";
689     Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
690     Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
691     Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
692   }
693 
694   for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
695                                             options::OPT_frewrite_map_file_EQ))
696     Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
697 
698   Diag(clang::diag::note_drv_command_failed_diag_msg)
699       << "\n\n********************";
700 }
701 
702 void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
703   // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
704   // if the tool does not support response files, there is a chance/ that things
705   // will just work without a response file, so we silently just skip it.
706   if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
707       llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
708     return;
709 
710   std::string TmpName = GetTemporaryPath("response", "txt");
711   Cmd.setResponseFile(
712       C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str())));
713 }
714 
715 int Driver::ExecuteCompilation(
716     Compilation &C,
717     SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
718   // Just print if -### was present.
719   if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
720     C.getJobs().Print(llvm::errs(), "\n", true);
721     return 0;
722   }
723 
724   // If there were errors building the compilation, quit now.
725   if (Diags.hasErrorOccurred())
726     return 1;
727 
728   // Set up response file names for each command, if necessary
729   for (auto &Job : C.getJobs())
730     setUpResponseFiles(C, Job);
731 
732   C.ExecuteJobs(C.getJobs(), FailingCommands);
733 
734   // Remove temp files.
735   C.CleanupFileList(C.getTempFiles());
736 
737   // If the command succeeded, we are done.
738   if (FailingCommands.empty())
739     return 0;
740 
741   // Otherwise, remove result files and print extra information about abnormal
742   // failures.
743   for (const auto &CmdPair : FailingCommands) {
744     int Res = CmdPair.first;
745     const Command *FailingCommand = CmdPair.second;
746 
747     // Remove result files if we're not saving temps.
748     if (!isSaveTempsEnabled()) {
749       const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
750       C.CleanupFileMap(C.getResultFiles(), JA, true);
751 
752       // Failure result files are valid unless we crashed.
753       if (Res < 0)
754         C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
755     }
756 
757     // Print extra information about abnormal failures, if possible.
758     //
759     // This is ad-hoc, but we don't want to be excessively noisy. If the result
760     // status was 1, assume the command failed normally. In particular, if it
761     // was the compiler then assume it gave a reasonable error code. Failures
762     // in other tools are less common, and they generally have worse
763     // diagnostics, so always print the diagnostic there.
764     const Tool &FailingTool = FailingCommand->getCreator();
765 
766     if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
767       // FIXME: See FIXME above regarding result code interpretation.
768       if (Res < 0)
769         Diag(clang::diag::err_drv_command_signalled)
770             << FailingTool.getShortName();
771       else
772         Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
773                                                   << Res;
774     }
775   }
776   return 0;
777 }
778 
779 void Driver::PrintHelp(bool ShowHidden) const {
780   unsigned IncludedFlagsBitmask;
781   unsigned ExcludedFlagsBitmask;
782   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
783       getIncludeExcludeOptionFlagMasks();
784 
785   ExcludedFlagsBitmask |= options::NoDriverOption;
786   if (!ShowHidden)
787     ExcludedFlagsBitmask |= HelpHidden;
788 
789   getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
790                       IncludedFlagsBitmask, ExcludedFlagsBitmask);
791 }
792 
793 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
794   // FIXME: The following handlers should use a callback mechanism, we don't
795   // know what the client would like to do.
796   OS << getClangFullVersion() << '\n';
797   const ToolChain &TC = C.getDefaultToolChain();
798   OS << "Target: " << TC.getTripleString() << '\n';
799 
800   // Print the threading model.
801   if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
802     // Don't print if the ToolChain would have barfed on it already
803     if (TC.isThreadModelSupported(A->getValue()))
804       OS << "Thread model: " << A->getValue();
805   } else
806     OS << "Thread model: " << TC.getThreadModel();
807   OS << '\n';
808 
809   // Print out the install directory.
810   OS << "InstalledDir: " << InstalledDir << '\n';
811 }
812 
813 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
814 /// option.
815 static void PrintDiagnosticCategories(raw_ostream &OS) {
816   // Skip the empty category.
817   for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
818        ++i)
819     OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
820 }
821 
822 bool Driver::HandleImmediateArgs(const Compilation &C) {
823   // The order these options are handled in gcc is all over the place, but we
824   // don't expect inconsistencies w.r.t. that to matter in practice.
825 
826   if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
827     llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
828     return false;
829   }
830 
831   if (C.getArgs().hasArg(options::OPT_dumpversion)) {
832     // Since -dumpversion is only implemented for pedantic GCC compatibility, we
833     // return an answer which matches our definition of __VERSION__.
834     //
835     // If we want to return a more correct answer some day, then we should
836     // introduce a non-pedantically GCC compatible mode to Clang in which we
837     // provide sensible definitions for -dumpversion, __VERSION__, etc.
838     llvm::outs() << "4.2.1\n";
839     return false;
840   }
841 
842   if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
843     PrintDiagnosticCategories(llvm::outs());
844     return false;
845   }
846 
847   if (C.getArgs().hasArg(options::OPT_help) ||
848       C.getArgs().hasArg(options::OPT__help_hidden)) {
849     PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
850     return false;
851   }
852 
853   if (C.getArgs().hasArg(options::OPT__version)) {
854     // Follow gcc behavior and use stdout for --version and stderr for -v.
855     PrintVersion(C, llvm::outs());
856     return false;
857   }
858 
859   if (C.getArgs().hasArg(options::OPT_v) ||
860       C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
861     PrintVersion(C, llvm::errs());
862     SuppressMissingInputWarning = true;
863   }
864 
865   const ToolChain &TC = C.getDefaultToolChain();
866 
867   if (C.getArgs().hasArg(options::OPT_v))
868     TC.printVerboseInfo(llvm::errs());
869 
870   if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
871     llvm::outs() << "programs: =";
872     bool separator = false;
873     for (const std::string &Path : TC.getProgramPaths()) {
874       if (separator)
875         llvm::outs() << ':';
876       llvm::outs() << Path;
877       separator = true;
878     }
879     llvm::outs() << "\n";
880     llvm::outs() << "libraries: =" << ResourceDir;
881 
882     StringRef sysroot = C.getSysRoot();
883 
884     for (const std::string &Path : TC.getFilePaths()) {
885       // Always print a separator. ResourceDir was the first item shown.
886       llvm::outs() << ':';
887       // Interpretation of leading '=' is needed only for NetBSD.
888       if (Path[0] == '=')
889         llvm::outs() << sysroot << Path.substr(1);
890       else
891         llvm::outs() << Path;
892     }
893     llvm::outs() << "\n";
894     return false;
895   }
896 
897   // FIXME: The following handlers should use a callback mechanism, we don't
898   // know what the client would like to do.
899   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
900     llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
901     return false;
902   }
903 
904   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
905     llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
906     return false;
907   }
908 
909   if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
910     llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
911     return false;
912   }
913 
914   if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
915     for (const Multilib &Multilib : TC.getMultilibs())
916       llvm::outs() << Multilib << "\n";
917     return false;
918   }
919 
920   if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
921     for (const Multilib &Multilib : TC.getMultilibs()) {
922       if (Multilib.gccSuffix().empty())
923         llvm::outs() << ".\n";
924       else {
925         StringRef Suffix(Multilib.gccSuffix());
926         assert(Suffix.front() == '/');
927         llvm::outs() << Suffix.substr(1) << "\n";
928       }
929     }
930     return false;
931   }
932   return true;
933 }
934 
935 // Display an action graph human-readably.  Action A is the "sink" node
936 // and latest-occuring action. Traversal is in pre-order, visiting the
937 // inputs to each action before printing the action itself.
938 static unsigned PrintActions1(const Compilation &C, Action *A,
939                               std::map<Action *, unsigned> &Ids) {
940   if (Ids.count(A)) // A was already visited.
941     return Ids[A];
942 
943   std::string str;
944   llvm::raw_string_ostream os(str);
945 
946   os << Action::getClassName(A->getKind()) << ", ";
947   if (InputAction *IA = dyn_cast<InputAction>(A)) {
948     os << "\"" << IA->getInputArg().getValue() << "\"";
949   } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
950     os << '"' << BIA->getArchName() << '"' << ", {"
951        << PrintActions1(C, *BIA->begin(), Ids) << "}";
952   } else if (CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) {
953     os << '"'
954        << (CDA->getGpuArchName() ? CDA->getGpuArchName() : "(multiple archs)")
955        << '"' << ", {" << PrintActions1(C, *CDA->begin(), Ids) << "}";
956   } else {
957     const ActionList *AL;
958     if (CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) {
959       os << "{" << PrintActions1(C, *CHA->begin(), Ids) << "}"
960          << ", gpu binaries ";
961       AL = &CHA->getDeviceActions();
962     } else
963       AL = &A->getInputs();
964 
965     if (AL->size()) {
966       const char *Prefix = "{";
967       for (Action *PreRequisite : *AL) {
968         os << Prefix << PrintActions1(C, PreRequisite, Ids);
969         Prefix = ", ";
970       }
971       os << "}";
972     } else
973       os << "{}";
974   }
975 
976   unsigned Id = Ids.size();
977   Ids[A] = Id;
978   llvm::errs() << Id << ": " << os.str() << ", "
979                << types::getTypeName(A->getType()) << "\n";
980 
981   return Id;
982 }
983 
984 // Print the action graphs in a compilation C.
985 // For example "clang -c file1.c file2.c" is composed of two subgraphs.
986 void Driver::PrintActions(const Compilation &C) const {
987   std::map<Action *, unsigned> Ids;
988   for (Action *A : C.getActions())
989     PrintActions1(C, A, Ids);
990 }
991 
992 /// \brief Check whether the given input tree contains any compilation or
993 /// assembly actions.
994 static bool ContainsCompileOrAssembleAction(const Action *A) {
995   if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
996       isa<AssembleJobAction>(A))
997     return true;
998 
999   for (const Action *Input : *A)
1000     if (ContainsCompileOrAssembleAction(Input))
1001       return true;
1002 
1003   return false;
1004 }
1005 
1006 void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1007                                    const InputList &BAInputs) const {
1008   DerivedArgList &Args = C.getArgs();
1009   ActionList &Actions = C.getActions();
1010   llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1011   // Collect the list of architectures. Duplicates are allowed, but should only
1012   // be handled once (in the order seen).
1013   llvm::StringSet<> ArchNames;
1014   SmallVector<const char *, 4> Archs;
1015   for (Arg *A : Args) {
1016     if (A->getOption().matches(options::OPT_arch)) {
1017       // Validate the option here; we don't save the type here because its
1018       // particular spelling may participate in other driver choices.
1019       llvm::Triple::ArchType Arch =
1020           tools::darwin::getArchTypeForMachOArchName(A->getValue());
1021       if (Arch == llvm::Triple::UnknownArch) {
1022         Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
1023         continue;
1024       }
1025 
1026       A->claim();
1027       if (ArchNames.insert(A->getValue()).second)
1028         Archs.push_back(A->getValue());
1029     }
1030   }
1031 
1032   // When there is no explicit arch for this platform, make sure we still bind
1033   // the architecture (to the default) so that -Xarch_ is handled correctly.
1034   if (!Archs.size())
1035     Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
1036 
1037   ActionList SingleActions;
1038   BuildActions(C, Args, BAInputs, SingleActions);
1039 
1040   // Add in arch bindings for every top level action, as well as lipo and
1041   // dsymutil steps if needed.
1042   for (Action* Act : SingleActions) {
1043     // Make sure we can lipo this kind of output. If not (and it is an actual
1044     // output) then we disallow, since we can't create an output file with the
1045     // right name without overwriting it. We could remove this oddity by just
1046     // changing the output names to include the arch, which would also fix
1047     // -save-temps. Compatibility wins for now.
1048 
1049     if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
1050       Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
1051           << types::getTypeName(Act->getType());
1052 
1053     ActionList Inputs;
1054     for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1055       Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
1056 
1057     // Lipo if necessary, we do it this way because we need to set the arch flag
1058     // so that -Xarch_ gets overwritten.
1059     if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1060       Actions.append(Inputs.begin(), Inputs.end());
1061     else
1062       Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
1063 
1064     // Handle debug info queries.
1065     Arg *A = Args.getLastArg(options::OPT_g_Group);
1066     if (A && !A->getOption().matches(options::OPT_g0) &&
1067         !A->getOption().matches(options::OPT_gstabs) &&
1068         ContainsCompileOrAssembleAction(Actions.back())) {
1069 
1070       // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1071       // have a compile input. We need to run 'dsymutil' ourselves in such cases
1072       // because the debug info will refer to a temporary object file which
1073       // will be removed at the end of the compilation process.
1074       if (Act->getType() == types::TY_Image) {
1075         ActionList Inputs;
1076         Inputs.push_back(Actions.back());
1077         Actions.pop_back();
1078         Actions.push_back(
1079             C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
1080       }
1081 
1082       // Verify the debug info output.
1083       if (Args.hasArg(options::OPT_verify_debug_info)) {
1084         Action* LastAction = Actions.back();
1085         Actions.pop_back();
1086         Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1087             LastAction, types::TY_Nothing));
1088       }
1089     }
1090   }
1091 }
1092 
1093 /// \brief Check that the file referenced by Value exists. If it doesn't,
1094 /// issue a diagnostic and return false.
1095 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
1096                                    StringRef Value) {
1097   if (!D.getCheckInputsExist())
1098     return true;
1099 
1100   // stdin always exists.
1101   if (Value == "-")
1102     return true;
1103 
1104   SmallString<64> Path(Value);
1105   if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
1106     if (!llvm::sys::path::is_absolute(Path)) {
1107       SmallString<64> Directory(WorkDir->getValue());
1108       llvm::sys::path::append(Directory, Value);
1109       Path.assign(Directory);
1110     }
1111   }
1112 
1113   if (llvm::sys::fs::exists(Twine(Path)))
1114     return true;
1115 
1116   if (D.IsCLMode() && !llvm::sys::path::is_absolute(Twine(Path)) &&
1117       llvm::sys::Process::FindInEnvPath("LIB", Value))
1118     return true;
1119 
1120   D.Diag(clang::diag::err_drv_no_such_file) << Path;
1121   return false;
1122 }
1123 
1124 // Construct a the list of inputs and their types.
1125 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
1126                          InputList &Inputs) const {
1127   // Track the current user specified (-x) input. We also explicitly track the
1128   // argument used to set the type; we only want to claim the type when we
1129   // actually use it, so we warn about unused -x arguments.
1130   types::ID InputType = types::TY_Nothing;
1131   Arg *InputTypeArg = nullptr;
1132 
1133   // The last /TC or /TP option sets the input type to C or C++ globally.
1134   if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1135                                          options::OPT__SLASH_TP)) {
1136     InputTypeArg = TCTP;
1137     InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
1138                     ? types::TY_C
1139                     : types::TY_CXX;
1140 
1141     arg_iterator it =
1142         Args.filtered_begin(options::OPT__SLASH_TC, options::OPT__SLASH_TP);
1143     const arg_iterator ie = Args.filtered_end();
1144     Arg *Previous = *it++;
1145     bool ShowNote = false;
1146     while (it != ie) {
1147       Diag(clang::diag::warn_drv_overriding_flag_option)
1148           << Previous->getSpelling() << (*it)->getSpelling();
1149       Previous = *it++;
1150       ShowNote = true;
1151     }
1152     if (ShowNote)
1153       Diag(clang::diag::note_drv_t_option_is_global);
1154 
1155     // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1156     assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1157   }
1158 
1159   for (Arg *A : Args) {
1160     if (A->getOption().getKind() == Option::InputClass) {
1161       const char *Value = A->getValue();
1162       types::ID Ty = types::TY_INVALID;
1163 
1164       // Infer the input type if necessary.
1165       if (InputType == types::TY_Nothing) {
1166         // If there was an explicit arg for this, claim it.
1167         if (InputTypeArg)
1168           InputTypeArg->claim();
1169 
1170         // stdin must be handled specially.
1171         if (memcmp(Value, "-", 2) == 0) {
1172           // If running with -E, treat as a C input (this changes the builtin
1173           // macros, for example). This may be overridden by -ObjC below.
1174           //
1175           // Otherwise emit an error but still use a valid type to avoid
1176           // spurious errors (e.g., no inputs).
1177           if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
1178             Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1179                             : clang::diag::err_drv_unknown_stdin_type);
1180           Ty = types::TY_C;
1181         } else {
1182           // Otherwise lookup by extension.
1183           // Fallback is C if invoked as C preprocessor or Object otherwise.
1184           // We use a host hook here because Darwin at least has its own
1185           // idea of what .s is.
1186           if (const char *Ext = strrchr(Value, '.'))
1187             Ty = TC.LookupTypeForExtension(Ext + 1);
1188 
1189           if (Ty == types::TY_INVALID) {
1190             if (CCCIsCPP())
1191               Ty = types::TY_C;
1192             else
1193               Ty = types::TY_Object;
1194           }
1195 
1196           // If the driver is invoked as C++ compiler (like clang++ or c++) it
1197           // should autodetect some input files as C++ for g++ compatibility.
1198           if (CCCIsCXX()) {
1199             types::ID OldTy = Ty;
1200             Ty = types::lookupCXXTypeForCType(Ty);
1201 
1202             if (Ty != OldTy)
1203               Diag(clang::diag::warn_drv_treating_input_as_cxx)
1204                   << getTypeName(OldTy) << getTypeName(Ty);
1205           }
1206         }
1207 
1208         // -ObjC and -ObjC++ override the default language, but only for "source
1209         // files". We just treat everything that isn't a linker input as a
1210         // source file.
1211         //
1212         // FIXME: Clean this up if we move the phase sequence into the type.
1213         if (Ty != types::TY_Object) {
1214           if (Args.hasArg(options::OPT_ObjC))
1215             Ty = types::TY_ObjC;
1216           else if (Args.hasArg(options::OPT_ObjCXX))
1217             Ty = types::TY_ObjCXX;
1218         }
1219       } else {
1220         assert(InputTypeArg && "InputType set w/o InputTypeArg");
1221         if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1222           // If emulating cl.exe, make sure that /TC and /TP don't affect input
1223           // object files.
1224           const char *Ext = strrchr(Value, '.');
1225           if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1226             Ty = types::TY_Object;
1227         }
1228         if (Ty == types::TY_INVALID) {
1229           Ty = InputType;
1230           InputTypeArg->claim();
1231         }
1232       }
1233 
1234       if (DiagnoseInputExistence(*this, Args, Value))
1235         Inputs.push_back(std::make_pair(Ty, A));
1236 
1237     } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1238       StringRef Value = A->getValue();
1239       if (DiagnoseInputExistence(*this, Args, Value)) {
1240         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1241         Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1242       }
1243       A->claim();
1244     } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1245       StringRef Value = A->getValue();
1246       if (DiagnoseInputExistence(*this, Args, Value)) {
1247         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1248         Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1249       }
1250       A->claim();
1251     } else if (A->getOption().hasFlag(options::LinkerInput)) {
1252       // Just treat as object type, we could make a special type for this if
1253       // necessary.
1254       Inputs.push_back(std::make_pair(types::TY_Object, A));
1255 
1256     } else if (A->getOption().matches(options::OPT_x)) {
1257       InputTypeArg = A;
1258       InputType = types::lookupTypeForTypeSpecifier(A->getValue());
1259       A->claim();
1260 
1261       // Follow gcc behavior and treat as linker input for invalid -x
1262       // options. Its not clear why we shouldn't just revert to unknown; but
1263       // this isn't very important, we might as well be bug compatible.
1264       if (!InputType) {
1265         Diag(clang::diag::err_drv_unknown_language) << A->getValue();
1266         InputType = types::TY_Object;
1267       }
1268     }
1269   }
1270   if (CCCIsCPP() && Inputs.empty()) {
1271     // If called as standalone preprocessor, stdin is processed
1272     // if no other input is present.
1273     Arg *A = MakeInputArg(Args, Opts, "-");
1274     Inputs.push_back(std::make_pair(types::TY_C, A));
1275   }
1276 }
1277 
1278 // For each unique --cuda-gpu-arch= argument creates a TY_CUDA_DEVICE
1279 // input action and then wraps each in CudaDeviceAction paired with
1280 // appropriate GPU arch name. In case of partial (i.e preprocessing
1281 // only) or device-only compilation, each device action is added to /p
1282 // Actions and /p Current is released. Otherwise the function creates
1283 // and returns a new CudaHostAction which wraps /p Current and device
1284 // side actions.
1285 static Action *buildCudaActions(Compilation &C, DerivedArgList &Args,
1286                                 const Arg *InputArg, Action *HostAction,
1287                                 ActionList &Actions) {
1288   Arg *PartialCompilationArg = Args.getLastArg(options::OPT_cuda_host_only,
1289                                                options::OPT_cuda_device_only);
1290   // Host-only compilation case.
1291   if (PartialCompilationArg &&
1292       PartialCompilationArg->getOption().matches(options::OPT_cuda_host_only))
1293     return C.MakeAction<CudaHostAction>(HostAction, ActionList());
1294 
1295   // Collect all cuda_gpu_arch parameters, removing duplicates.
1296   SmallVector<const char *, 4> GpuArchList;
1297   llvm::StringSet<> GpuArchNames;
1298   for (Arg *A : Args) {
1299     if (!A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
1300       continue;
1301     A->claim();
1302 
1303     const auto& Arch = A->getValue();
1304     if (!CudaDeviceAction::IsValidGpuArchName(Arch))
1305       C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << Arch;
1306     else if (GpuArchNames.insert(Arch).second)
1307       GpuArchList.push_back(Arch);
1308   }
1309 
1310   // Default to sm_20 which is the lowest common denominator for supported GPUs.
1311   // sm_20 code should work correctly, if suboptimally, on all newer GPUs.
1312   if (GpuArchList.empty())
1313     GpuArchList.push_back("sm_20");
1314 
1315   // Replicate inputs for each GPU architecture.
1316   Driver::InputList CudaDeviceInputs;
1317   for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1318     CudaDeviceInputs.push_back(std::make_pair(types::TY_CUDA_DEVICE, InputArg));
1319 
1320   // Build actions for all device inputs.
1321   assert(C.getCudaDeviceToolChain() &&
1322          "Missing toolchain for device-side compilation.");
1323   ActionList CudaDeviceActions;
1324   C.getDriver().BuildActions(C, Args, CudaDeviceInputs, CudaDeviceActions);
1325   assert(GpuArchList.size() == CudaDeviceActions.size() &&
1326          "Failed to create actions for all devices");
1327 
1328   // Check whether any of device actions stopped before they could generate PTX.
1329   bool PartialCompilation =
1330       llvm::any_of(CudaDeviceActions, [](const Action *a) {
1331         return a->getKind() != Action::AssembleJobClass;
1332       });
1333 
1334   // Figure out what to do with device actions -- pass them as inputs to the
1335   // host action or run each of them independently.
1336   bool DeviceOnlyCompilation = PartialCompilationArg != nullptr;
1337   if (PartialCompilation || DeviceOnlyCompilation) {
1338     // In case of partial or device-only compilation results of device actions
1339     // are not consumed by the host action device actions have to be added to
1340     // top-level actions list with AtTopLevel=true and run independently.
1341 
1342     // -o is ambiguous if we have more than one top-level action.
1343     if (Args.hasArg(options::OPT_o) &&
1344         (!DeviceOnlyCompilation || GpuArchList.size() > 1)) {
1345       C.getDriver().Diag(
1346           clang::diag::err_drv_output_argument_with_multiple_files);
1347       return nullptr;
1348     }
1349 
1350     for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1351       Actions.push_back(C.MakeAction<CudaDeviceAction>(CudaDeviceActions[I],
1352                                                        GpuArchList[I],
1353                                                        /* AtTopLevel */ true));
1354     // Kill host action in case of device-only compilation.
1355     if (DeviceOnlyCompilation)
1356       return nullptr;
1357     return HostAction;
1358   }
1359 
1360   // If we're not a partial or device-only compilation, we compile each arch to
1361   // ptx and assemble to cubin, then feed the cubin *and* the ptx into a device
1362   // "link" action, which uses fatbinary to combine these cubins into one
1363   // fatbin.  The fatbin is then an input to the host compilation.
1364   ActionList DeviceActions;
1365   for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
1366     Action* AssembleAction = CudaDeviceActions[I];
1367     assert(AssembleAction->getType() == types::TY_Object);
1368     assert(AssembleAction->getInputs().size() == 1);
1369 
1370     Action* BackendAction = AssembleAction->getInputs()[0];
1371     assert(BackendAction->getType() == types::TY_PP_Asm);
1372 
1373     for (const auto& A : {AssembleAction, BackendAction}) {
1374       DeviceActions.push_back(C.MakeAction<CudaDeviceAction>(
1375           A, GpuArchList[I], /* AtTopLevel */ false));
1376     }
1377   }
1378   auto FatbinAction = C.MakeAction<CudaDeviceAction>(
1379       C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN),
1380       /* GpuArchName = */ nullptr,
1381       /* AtTopLevel = */ false);
1382   // Return a new host action that incorporates original host action and all
1383   // device actions.
1384   return C.MakeAction<CudaHostAction>(std::move(HostAction),
1385                                       ActionList({FatbinAction}));
1386 }
1387 
1388 void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
1389                           const InputList &Inputs, ActionList &Actions) const {
1390   llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
1391 
1392   if (!SuppressMissingInputWarning && Inputs.empty()) {
1393     Diag(clang::diag::err_drv_no_input_files);
1394     return;
1395   }
1396 
1397   Arg *FinalPhaseArg;
1398   phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
1399 
1400   if (FinalPhase == phases::Link && Args.hasArg(options::OPT_emit_llvm)) {
1401     Diag(clang::diag::err_drv_emit_llvm_link);
1402   }
1403 
1404   // Reject -Z* at the top level, these options should never have been exposed
1405   // by gcc.
1406   if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
1407     Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
1408 
1409   // Diagnose misuse of /Fo.
1410   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
1411     StringRef V = A->getValue();
1412     if (Inputs.size() > 1 && !V.empty() &&
1413         !llvm::sys::path::is_separator(V.back())) {
1414       // Check whether /Fo tries to name an output file for multiple inputs.
1415       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1416           << A->getSpelling() << V;
1417       Args.eraseArg(options::OPT__SLASH_Fo);
1418     }
1419   }
1420 
1421   // Diagnose misuse of /Fa.
1422   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
1423     StringRef V = A->getValue();
1424     if (Inputs.size() > 1 && !V.empty() &&
1425         !llvm::sys::path::is_separator(V.back())) {
1426       // Check whether /Fa tries to name an asm file for multiple inputs.
1427       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1428           << A->getSpelling() << V;
1429       Args.eraseArg(options::OPT__SLASH_Fa);
1430     }
1431   }
1432 
1433   // Diagnose misuse of /o.
1434   if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
1435     if (A->getValue()[0] == '\0') {
1436       // It has to have a value.
1437       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
1438       Args.eraseArg(options::OPT__SLASH_o);
1439     }
1440   }
1441 
1442   // Construct the actions to perform.
1443   ActionList LinkerInputs;
1444 
1445   llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
1446   for (auto &I : Inputs) {
1447     types::ID InputType = I.first;
1448     const Arg *InputArg = I.second;
1449 
1450     PL.clear();
1451     types::getCompilationPhases(InputType, PL);
1452 
1453     // If the first step comes after the final phase we are doing as part of
1454     // this compilation, warn the user about it.
1455     phases::ID InitialPhase = PL[0];
1456     if (InitialPhase > FinalPhase) {
1457       // Claim here to avoid the more general unused warning.
1458       InputArg->claim();
1459 
1460       // Suppress all unused style warnings with -Qunused-arguments
1461       if (Args.hasArg(options::OPT_Qunused_arguments))
1462         continue;
1463 
1464       // Special case when final phase determined by binary name, rather than
1465       // by a command-line argument with a corresponding Arg.
1466       if (CCCIsCPP())
1467         Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
1468             << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
1469       // Special case '-E' warning on a previously preprocessed file to make
1470       // more sense.
1471       else if (InitialPhase == phases::Compile &&
1472                FinalPhase == phases::Preprocess &&
1473                getPreprocessedType(InputType) == types::TY_INVALID)
1474         Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
1475             << InputArg->getAsString(Args) << !!FinalPhaseArg
1476             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1477       else
1478         Diag(clang::diag::warn_drv_input_file_unused)
1479             << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
1480             << !!FinalPhaseArg
1481             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1482       continue;
1483     }
1484 
1485     phases::ID CudaInjectionPhase =
1486         (phases::Compile < FinalPhase &&
1487          llvm::find(PL, phases::Compile) != PL.end())
1488             ? phases::Compile
1489             : FinalPhase;
1490 
1491     // Build the pipeline for this file.
1492     Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
1493     for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
1494          i != e; ++i) {
1495       phases::ID Phase = *i;
1496 
1497       // We are done if this step is past what the user requested.
1498       if (Phase > FinalPhase)
1499         break;
1500 
1501       // Queue linker inputs.
1502       if (Phase == phases::Link) {
1503         assert((i + 1) == e && "linking must be final compilation step.");
1504         LinkerInputs.push_back(Current);
1505         Current = nullptr;
1506         break;
1507       }
1508 
1509       // Some types skip the assembler phase (e.g., llvm-bc), but we can't
1510       // encode this in the steps because the intermediate type depends on
1511       // arguments. Just special case here.
1512       if (Phase == phases::Assemble && Current->getType() != types::TY_PP_Asm)
1513         continue;
1514 
1515       // Otherwise construct the appropriate action.
1516       Current = ConstructPhaseAction(C, Args, Phase, Current);
1517 
1518       if (InputType == types::TY_CUDA && Phase == CudaInjectionPhase) {
1519         Current = buildCudaActions(C, Args, InputArg, Current, Actions);
1520         if (!Current)
1521           break;
1522       }
1523 
1524       if (Current->getType() == types::TY_Nothing)
1525         break;
1526     }
1527 
1528     // If we ended with something, add to the output list.
1529     if (Current)
1530       Actions.push_back(Current);
1531   }
1532 
1533   // Add a link action if necessary.
1534   if (!LinkerInputs.empty())
1535     Actions.push_back(
1536         C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image));
1537 
1538   // If we are linking, claim any options which are obviously only used for
1539   // compilation.
1540   if (FinalPhase == phases::Link && PL.size() == 1) {
1541     Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
1542     Args.ClaimAllArgs(options::OPT_cl_compile_Group);
1543   }
1544 
1545   // Claim ignored clang-cl options.
1546   Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
1547 
1548   // Claim --cuda-host-only arg which may be passed to non-CUDA
1549   // compilations and should not trigger warnings there.
1550   Args.ClaimAllArgs(options::OPT_cuda_host_only);
1551 }
1552 
1553 Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args,
1554                                      phases::ID Phase, Action *Input) const {
1555   llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
1556   // Build the appropriate action.
1557   switch (Phase) {
1558   case phases::Link:
1559     llvm_unreachable("link action invalid here.");
1560   case phases::Preprocess: {
1561     types::ID OutputTy;
1562     // -{M, MM} alter the output type.
1563     if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
1564       OutputTy = types::TY_Dependencies;
1565     } else {
1566       OutputTy = Input->getType();
1567       if (!Args.hasFlag(options::OPT_frewrite_includes,
1568                         options::OPT_fno_rewrite_includes, false) &&
1569           !CCGenDiagnostics)
1570         OutputTy = types::getPreprocessedType(OutputTy);
1571       assert(OutputTy != types::TY_INVALID &&
1572              "Cannot preprocess this input type!");
1573     }
1574     return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
1575   }
1576   case phases::Precompile: {
1577     types::ID OutputTy = types::TY_PCH;
1578     if (Args.hasArg(options::OPT_fsyntax_only)) {
1579       // Syntax checks should not emit a PCH file
1580       OutputTy = types::TY_Nothing;
1581     }
1582     return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
1583   }
1584   case phases::Compile: {
1585     if (Args.hasArg(options::OPT_fsyntax_only))
1586       return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
1587     if (Args.hasArg(options::OPT_rewrite_objc))
1588       return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
1589     if (Args.hasArg(options::OPT_rewrite_legacy_objc))
1590       return C.MakeAction<CompileJobAction>(Input,
1591                                             types::TY_RewrittenLegacyObjC);
1592     if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
1593       return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
1594     if (Args.hasArg(options::OPT__migrate))
1595       return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
1596     if (Args.hasArg(options::OPT_emit_ast))
1597       return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
1598     if (Args.hasArg(options::OPT_module_file_info))
1599       return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
1600     if (Args.hasArg(options::OPT_verify_pch))
1601       return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
1602     return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
1603   }
1604   case phases::Backend: {
1605     if (isUsingLTO()) {
1606       types::ID Output =
1607           Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
1608       return C.MakeAction<BackendJobAction>(Input, Output);
1609     }
1610     if (Args.hasArg(options::OPT_emit_llvm)) {
1611       types::ID Output =
1612           Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
1613       return C.MakeAction<BackendJobAction>(Input, Output);
1614     }
1615     return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
1616   }
1617   case phases::Assemble:
1618     return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
1619   }
1620 
1621   llvm_unreachable("invalid phase in ConstructPhaseAction");
1622 }
1623 
1624 void Driver::BuildJobs(Compilation &C) const {
1625   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1626 
1627   Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
1628 
1629   // It is an error to provide a -o option if we are making multiple output
1630   // files.
1631   if (FinalOutput) {
1632     unsigned NumOutputs = 0;
1633     for (const Action *A : C.getActions())
1634       if (A->getType() != types::TY_Nothing)
1635         ++NumOutputs;
1636 
1637     if (NumOutputs > 1) {
1638       Diag(clang::diag::err_drv_output_argument_with_multiple_files);
1639       FinalOutput = nullptr;
1640     }
1641   }
1642 
1643   // Collect the list of architectures.
1644   llvm::StringSet<> ArchNames;
1645   if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
1646     for (const Arg *A : C.getArgs())
1647       if (A->getOption().matches(options::OPT_arch))
1648         ArchNames.insert(A->getValue());
1649 
1650   // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
1651   std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
1652   for (Action *A : C.getActions()) {
1653     // If we are linking an image for multiple archs then the linker wants
1654     // -arch_multiple and -final_output <final image name>. Unfortunately, this
1655     // doesn't fit in cleanly because we have to pass this information down.
1656     //
1657     // FIXME: This is a hack; find a cleaner way to integrate this into the
1658     // process.
1659     const char *LinkingOutput = nullptr;
1660     if (isa<LipoJobAction>(A)) {
1661       if (FinalOutput)
1662         LinkingOutput = FinalOutput->getValue();
1663       else
1664         LinkingOutput = getDefaultImageName();
1665     }
1666 
1667     BuildJobsForAction(C, A, &C.getDefaultToolChain(),
1668                        /*BoundArch*/ nullptr,
1669                        /*AtTopLevel*/ true,
1670                        /*MultipleArchs*/ ArchNames.size() > 1,
1671                        /*LinkingOutput*/ LinkingOutput, CachedResults);
1672   }
1673 
1674   // If the user passed -Qunused-arguments or there were errors, don't warn
1675   // about any unused arguments.
1676   if (Diags.hasErrorOccurred() ||
1677       C.getArgs().hasArg(options::OPT_Qunused_arguments))
1678     return;
1679 
1680   // Claim -### here.
1681   (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
1682 
1683   // Claim --driver-mode, it was handled earlier.
1684   (void)C.getArgs().hasArg(options::OPT_driver_mode);
1685 
1686   for (Arg *A : C.getArgs()) {
1687     // FIXME: It would be nice to be able to send the argument to the
1688     // DiagnosticsEngine, so that extra values, position, and so on could be
1689     // printed.
1690     if (!A->isClaimed()) {
1691       if (A->getOption().hasFlag(options::NoArgumentUnused))
1692         continue;
1693 
1694       // Suppress the warning automatically if this is just a flag, and it is an
1695       // instance of an argument we already claimed.
1696       const Option &Opt = A->getOption();
1697       if (Opt.getKind() == Option::FlagClass) {
1698         bool DuplicateClaimed = false;
1699 
1700         for (const Arg *AA : C.getArgs().filtered(&Opt)) {
1701           if (AA->isClaimed()) {
1702             DuplicateClaimed = true;
1703             break;
1704           }
1705         }
1706 
1707         if (DuplicateClaimed)
1708           continue;
1709       }
1710 
1711       // In clang-cl, don't mention unknown arguments here since they have
1712       // already been warned about.
1713       if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
1714         Diag(clang::diag::warn_drv_unused_argument)
1715             << A->getAsString(C.getArgs());
1716     }
1717   }
1718 }
1719 
1720 // Returns a Tool for a given JobAction.  In case the action and its
1721 // predecessors can be combined, updates Inputs with the inputs of the
1722 // first combined action. If one of the collapsed actions is a
1723 // CudaHostAction, updates CollapsedCHA with the pointer to it so the
1724 // caller can deal with extra handling such action requires.
1725 static const Tool *selectToolForJob(Compilation &C, bool SaveTemps,
1726                                     const ToolChain *TC, const JobAction *JA,
1727                                     const ActionList *&Inputs,
1728                                     const CudaHostAction *&CollapsedCHA) {
1729   const Tool *ToolForJob = nullptr;
1730   CollapsedCHA = nullptr;
1731 
1732   // See if we should look for a compiler with an integrated assembler. We match
1733   // bottom up, so what we are actually looking for is an assembler job with a
1734   // compiler input.
1735 
1736   if (TC->useIntegratedAs() && !SaveTemps &&
1737       !C.getArgs().hasArg(options::OPT_via_file_asm) &&
1738       !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
1739       !C.getArgs().hasArg(options::OPT__SLASH_Fa) &&
1740       isa<AssembleJobAction>(JA) && Inputs->size() == 1 &&
1741       isa<BackendJobAction>(*Inputs->begin())) {
1742     // A BackendJob is always preceded by a CompileJob, and without
1743     // -save-temps they will always get combined together, so instead of
1744     // checking the backend tool, check if the tool for the CompileJob
1745     // has an integrated assembler.
1746     const ActionList *BackendInputs = &(*Inputs)[0]->getInputs();
1747     // Compile job may be wrapped in CudaHostAction, extract it if
1748     // that's the case and update CollapsedCHA if we combine phases.
1749     CudaHostAction *CHA = dyn_cast<CudaHostAction>(*BackendInputs->begin());
1750     JobAction *CompileJA =
1751         cast<CompileJobAction>(CHA ? *CHA->begin() : *BackendInputs->begin());
1752     assert(CompileJA && "Backend job is not preceeded by compile job.");
1753     const Tool *Compiler = TC->SelectTool(*CompileJA);
1754     if (!Compiler)
1755       return nullptr;
1756     if (Compiler->hasIntegratedAssembler()) {
1757       Inputs = &CompileJA->getInputs();
1758       ToolForJob = Compiler;
1759       CollapsedCHA = CHA;
1760     }
1761   }
1762 
1763   // A backend job should always be combined with the preceding compile job
1764   // unless OPT_save_temps is enabled and the compiler is capable of emitting
1765   // LLVM IR as an intermediate output.
1766   if (isa<BackendJobAction>(JA)) {
1767     // Check if the compiler supports emitting LLVM IR.
1768     assert(Inputs->size() == 1);
1769     // Compile job may be wrapped in CudaHostAction, extract it if
1770     // that's the case and update CollapsedCHA if we combine phases.
1771     CudaHostAction *CHA = dyn_cast<CudaHostAction>(*Inputs->begin());
1772     JobAction *CompileJA =
1773         cast<CompileJobAction>(CHA ? *CHA->begin() : *Inputs->begin());
1774     assert(CompileJA && "Backend job is not preceeded by compile job.");
1775     const Tool *Compiler = TC->SelectTool(*CompileJA);
1776     if (!Compiler)
1777       return nullptr;
1778     if (!Compiler->canEmitIR() || !SaveTemps) {
1779       Inputs = &CompileJA->getInputs();
1780       ToolForJob = Compiler;
1781       CollapsedCHA = CHA;
1782     }
1783   }
1784 
1785   // Otherwise use the tool for the current job.
1786   if (!ToolForJob)
1787     ToolForJob = TC->SelectTool(*JA);
1788 
1789   // See if we should use an integrated preprocessor. We do so when we have
1790   // exactly one input, since this is the only use case we care about
1791   // (irrelevant since we don't support combine yet).
1792   if (Inputs->size() == 1 && isa<PreprocessJobAction>(*Inputs->begin()) &&
1793       !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
1794       !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
1795       !C.getArgs().hasArg(options::OPT_rewrite_objc) &&
1796       ToolForJob->hasIntegratedCPP())
1797     Inputs = &(*Inputs)[0]->getInputs();
1798 
1799   return ToolForJob;
1800 }
1801 
1802 InputInfo Driver::BuildJobsForAction(
1803     Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch,
1804     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
1805     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults)
1806     const {
1807   // The bound arch is not necessarily represented in the toolchain's triple --
1808   // for example, armv7 and armv7s both map to the same triple -- so we need
1809   // both in our map.
1810   std::string TriplePlusArch = TC->getTriple().normalize();
1811   if (BoundArch) {
1812     TriplePlusArch += "-";
1813     TriplePlusArch += BoundArch;
1814   }
1815   std::pair<const Action *, std::string> ActionTC = {A, TriplePlusArch};
1816   auto CachedResult = CachedResults.find(ActionTC);
1817   if (CachedResult != CachedResults.end()) {
1818     return CachedResult->second;
1819   }
1820   InputInfo Result =
1821       BuildJobsForActionNoCache(C, A, TC, BoundArch, AtTopLevel, MultipleArchs,
1822                                 LinkingOutput, CachedResults);
1823   CachedResults[ActionTC] = Result;
1824   return Result;
1825 }
1826 
1827 InputInfo Driver::BuildJobsForActionNoCache(
1828     Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch,
1829     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
1830     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults)
1831     const {
1832   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1833 
1834   InputInfoList CudaDeviceInputInfos;
1835   if (const CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) {
1836     // Append outputs of device jobs to the input list.
1837     for (const Action *DA : CHA->getDeviceActions()) {
1838       CudaDeviceInputInfos.push_back(BuildJobsForAction(
1839           C, DA, TC, nullptr, AtTopLevel,
1840           /*MultipleArchs*/ false, LinkingOutput, CachedResults));
1841     }
1842     // Override current action with a real host compile action and continue
1843     // processing it.
1844     A = *CHA->begin();
1845   }
1846 
1847   if (const InputAction *IA = dyn_cast<InputAction>(A)) {
1848     // FIXME: It would be nice to not claim this here; maybe the old scheme of
1849     // just using Args was better?
1850     const Arg &Input = IA->getInputArg();
1851     Input.claim();
1852     if (Input.getOption().matches(options::OPT_INPUT)) {
1853       const char *Name = Input.getValue();
1854       return InputInfo(A, Name, /* BaseInput = */ Name);
1855     }
1856     return InputInfo(A, &Input, /* BaseInput = */ "");
1857   }
1858 
1859   if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
1860     const ToolChain *TC;
1861     const char *ArchName = BAA->getArchName();
1862 
1863     if (ArchName)
1864       TC = &getToolChain(
1865           C.getArgs(),
1866           computeTargetTriple(DefaultTargetTriple, C.getArgs(), ArchName));
1867     else
1868       TC = &C.getDefaultToolChain();
1869 
1870     return BuildJobsForAction(C, *BAA->begin(), TC, ArchName, AtTopLevel,
1871                               MultipleArchs, LinkingOutput, CachedResults);
1872   }
1873 
1874   if (const CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) {
1875     // Initial processing of CudaDeviceAction carries host params.
1876     // Call BuildJobsForAction() again, now with correct device parameters.
1877     InputInfo II = BuildJobsForAction(
1878         C, *CDA->begin(), C.getCudaDeviceToolChain(), CDA->getGpuArchName(),
1879         CDA->isAtTopLevel(), /*MultipleArchs*/ true, LinkingOutput,
1880         CachedResults);
1881     // Currently II's Action is *CDA->begin().  Set it to CDA instead, so that
1882     // one can retrieve II's GPU arch.
1883     II.setAction(A);
1884     return II;
1885   }
1886 
1887   const ActionList *Inputs = &A->getInputs();
1888 
1889   const JobAction *JA = cast<JobAction>(A);
1890   const CudaHostAction *CollapsedCHA = nullptr;
1891   const Tool *T =
1892       selectToolForJob(C, isSaveTempsEnabled(), TC, JA, Inputs, CollapsedCHA);
1893   if (!T)
1894     return InputInfo();
1895 
1896   // If we've collapsed action list that contained CudaHostAction we
1897   // need to build jobs for device-side inputs it may have held.
1898   if (CollapsedCHA) {
1899     for (const Action *DA : CollapsedCHA->getDeviceActions()) {
1900       CudaDeviceInputInfos.push_back(BuildJobsForAction(
1901           C, DA, TC, "", AtTopLevel,
1902           /*MultipleArchs*/ false, LinkingOutput, CachedResults));
1903     }
1904   }
1905 
1906   // Only use pipes when there is exactly one input.
1907   InputInfoList InputInfos;
1908   for (const Action *Input : *Inputs) {
1909     // Treat dsymutil and verify sub-jobs as being at the top-level too, they
1910     // shouldn't get temporary output names.
1911     // FIXME: Clean this up.
1912     bool SubJobAtTopLevel =
1913         AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
1914     InputInfos.push_back(BuildJobsForAction(C, Input, TC, BoundArch,
1915                                             SubJobAtTopLevel, MultipleArchs,
1916                                             LinkingOutput, CachedResults));
1917   }
1918 
1919   // Always use the first input as the base input.
1920   const char *BaseInput = InputInfos[0].getBaseInput();
1921 
1922   // ... except dsymutil actions, which use their actual input as the base
1923   // input.
1924   if (JA->getType() == types::TY_dSYM)
1925     BaseInput = InputInfos[0].getFilename();
1926 
1927   // Append outputs of cuda device jobs to the input list
1928   if (CudaDeviceInputInfos.size())
1929     InputInfos.append(CudaDeviceInputInfos.begin(), CudaDeviceInputInfos.end());
1930 
1931   // Determine the place to write output to, if any.
1932   InputInfo Result;
1933   if (JA->getType() == types::TY_Nothing)
1934     Result = InputInfo(A, BaseInput);
1935   else
1936     Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
1937                                              AtTopLevel, MultipleArchs),
1938                        BaseInput);
1939 
1940   if (CCCPrintBindings && !CCGenDiagnostics) {
1941     llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
1942                  << " - \"" << T->getName() << "\", inputs: [";
1943     for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
1944       llvm::errs() << InputInfos[i].getAsString();
1945       if (i + 1 != e)
1946         llvm::errs() << ", ";
1947     }
1948     llvm::errs() << "], output: " << Result.getAsString() << "\n";
1949   } else {
1950     T->ConstructJob(C, *JA, Result, InputInfos,
1951                     C.getArgsForToolChain(TC, BoundArch), LinkingOutput);
1952   }
1953   return Result;
1954 }
1955 
1956 const char *Driver::getDefaultImageName() const {
1957   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
1958   return Target.isOSWindows() ? "a.exe" : "a.out";
1959 }
1960 
1961 /// \brief Create output filename based on ArgValue, which could either be a
1962 /// full filename, filename without extension, or a directory. If ArgValue
1963 /// does not provide a filename, then use BaseName, and use the extension
1964 /// suitable for FileType.
1965 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
1966                                         StringRef BaseName,
1967                                         types::ID FileType) {
1968   SmallString<128> Filename = ArgValue;
1969 
1970   if (ArgValue.empty()) {
1971     // If the argument is empty, output to BaseName in the current dir.
1972     Filename = BaseName;
1973   } else if (llvm::sys::path::is_separator(Filename.back())) {
1974     // If the argument is a directory, output to BaseName in that dir.
1975     llvm::sys::path::append(Filename, BaseName);
1976   }
1977 
1978   if (!llvm::sys::path::has_extension(ArgValue)) {
1979     // If the argument didn't provide an extension, then set it.
1980     const char *Extension = types::getTypeTempSuffix(FileType, true);
1981 
1982     if (FileType == types::TY_Image &&
1983         Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
1984       // The output file is a dll.
1985       Extension = "dll";
1986     }
1987 
1988     llvm::sys::path::replace_extension(Filename, Extension);
1989   }
1990 
1991   return Args.MakeArgString(Filename.c_str());
1992 }
1993 
1994 const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
1995                                        const char *BaseInput,
1996                                        const char *BoundArch, bool AtTopLevel,
1997                                        bool MultipleArchs) const {
1998   llvm::PrettyStackTraceString CrashInfo("Computing output path");
1999   // Output to a user requested destination?
2000   if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
2001     if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
2002       return C.addResultFile(FinalOutput->getValue(), &JA);
2003   }
2004 
2005   // For /P, preprocess to file named after BaseInput.
2006   if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
2007     assert(AtTopLevel && isa<PreprocessJobAction>(JA));
2008     StringRef BaseName = llvm::sys::path::filename(BaseInput);
2009     StringRef NameArg;
2010     if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
2011       NameArg = A->getValue();
2012     return C.addResultFile(
2013         MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
2014         &JA);
2015   }
2016 
2017   // Default to writing to stdout?
2018   if (AtTopLevel && !CCGenDiagnostics &&
2019       (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
2020     return "-";
2021 
2022   // Is this the assembly listing for /FA?
2023   if (JA.getType() == types::TY_PP_Asm &&
2024       (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
2025        C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
2026     // Use /Fa and the input filename to determine the asm file name.
2027     StringRef BaseName = llvm::sys::path::filename(BaseInput);
2028     StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
2029     return C.addResultFile(
2030         MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
2031         &JA);
2032   }
2033 
2034   // Output to a temporary file?
2035   if ((!AtTopLevel && !isSaveTempsEnabled() &&
2036        !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
2037       CCGenDiagnostics) {
2038     StringRef Name = llvm::sys::path::filename(BaseInput);
2039     std::pair<StringRef, StringRef> Split = Name.split('.');
2040     std::string TmpName = GetTemporaryPath(
2041         Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
2042     return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
2043   }
2044 
2045   SmallString<128> BasePath(BaseInput);
2046   StringRef BaseName;
2047 
2048   // Dsymutil actions should use the full path.
2049   if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
2050     BaseName = BasePath;
2051   else
2052     BaseName = llvm::sys::path::filename(BasePath);
2053 
2054   // Determine what the derived output name should be.
2055   const char *NamedOutput;
2056 
2057   if (JA.getType() == types::TY_Object &&
2058       C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
2059     // The /Fo or /o flag decides the object filename.
2060     StringRef Val =
2061         C.getArgs()
2062             .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
2063             ->getValue();
2064     NamedOutput =
2065         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
2066   } else if (JA.getType() == types::TY_Image &&
2067              C.getArgs().hasArg(options::OPT__SLASH_Fe,
2068                                 options::OPT__SLASH_o)) {
2069     // The /Fe or /o flag names the linked file.
2070     StringRef Val =
2071         C.getArgs()
2072             .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
2073             ->getValue();
2074     NamedOutput =
2075         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
2076   } else if (JA.getType() == types::TY_Image) {
2077     if (IsCLMode()) {
2078       // clang-cl uses BaseName for the executable name.
2079       NamedOutput =
2080           MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
2081     } else if (MultipleArchs && BoundArch) {
2082       SmallString<128> Output(getDefaultImageName());
2083       Output += "-";
2084       Output.append(BoundArch);
2085       NamedOutput = C.getArgs().MakeArgString(Output.c_str());
2086     } else
2087       NamedOutput = getDefaultImageName();
2088   } else {
2089     const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
2090     assert(Suffix && "All types used for output should have a suffix.");
2091 
2092     std::string::size_type End = std::string::npos;
2093     if (!types::appendSuffixForType(JA.getType()))
2094       End = BaseName.rfind('.');
2095     SmallString<128> Suffixed(BaseName.substr(0, End));
2096     if (MultipleArchs && BoundArch) {
2097       Suffixed += "-";
2098       Suffixed.append(BoundArch);
2099     }
2100     // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
2101     // the unoptimized bitcode so that it does not get overwritten by the ".bc"
2102     // optimized bitcode output.
2103     if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
2104         JA.getType() == types::TY_LLVM_BC)
2105       Suffixed += ".tmp";
2106     Suffixed += '.';
2107     Suffixed += Suffix;
2108     NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
2109   }
2110 
2111   // Prepend object file path if -save-temps=obj
2112   if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
2113       JA.getType() != types::TY_PCH) {
2114     Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
2115     SmallString<128> TempPath(FinalOutput->getValue());
2116     llvm::sys::path::remove_filename(TempPath);
2117     StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
2118     llvm::sys::path::append(TempPath, OutputFileName);
2119     NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
2120   }
2121 
2122   // If we're saving temps and the temp file conflicts with the input file,
2123   // then avoid overwriting input file.
2124   if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
2125     bool SameFile = false;
2126     SmallString<256> Result;
2127     llvm::sys::fs::current_path(Result);
2128     llvm::sys::path::append(Result, BaseName);
2129     llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
2130     // Must share the same path to conflict.
2131     if (SameFile) {
2132       StringRef Name = llvm::sys::path::filename(BaseInput);
2133       std::pair<StringRef, StringRef> Split = Name.split('.');
2134       std::string TmpName = GetTemporaryPath(
2135           Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
2136       return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
2137     }
2138   }
2139 
2140   // As an annoying special case, PCH generation doesn't strip the pathname.
2141   if (JA.getType() == types::TY_PCH) {
2142     llvm::sys::path::remove_filename(BasePath);
2143     if (BasePath.empty())
2144       BasePath = NamedOutput;
2145     else
2146       llvm::sys::path::append(BasePath, NamedOutput);
2147     return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
2148   } else {
2149     return C.addResultFile(NamedOutput, &JA);
2150   }
2151 }
2152 
2153 std::string Driver::GetFilePath(const char *Name, const ToolChain &TC) const {
2154   // Respect a limited subset of the '-Bprefix' functionality in GCC by
2155   // attempting to use this prefix when looking for file paths.
2156   for (const std::string &Dir : PrefixDirs) {
2157     if (Dir.empty())
2158       continue;
2159     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
2160     llvm::sys::path::append(P, Name);
2161     if (llvm::sys::fs::exists(Twine(P)))
2162       return P.str();
2163   }
2164 
2165   SmallString<128> P(ResourceDir);
2166   llvm::sys::path::append(P, Name);
2167   if (llvm::sys::fs::exists(Twine(P)))
2168     return P.str();
2169 
2170   for (const std::string &Dir : TC.getFilePaths()) {
2171     if (Dir.empty())
2172       continue;
2173     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
2174     llvm::sys::path::append(P, Name);
2175     if (llvm::sys::fs::exists(Twine(P)))
2176       return P.str();
2177   }
2178 
2179   return Name;
2180 }
2181 
2182 void Driver::generatePrefixedToolNames(
2183     const char *Tool, const ToolChain &TC,
2184     SmallVectorImpl<std::string> &Names) const {
2185   // FIXME: Needs a better variable than DefaultTargetTriple
2186   Names.emplace_back(DefaultTargetTriple + "-" + Tool);
2187   Names.emplace_back(Tool);
2188 
2189   // Allow the discovery of tools prefixed with LLVM's default target triple.
2190   std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
2191   if (LLVMDefaultTargetTriple != DefaultTargetTriple)
2192     Names.emplace_back(LLVMDefaultTargetTriple + "-" + Tool);
2193 }
2194 
2195 static bool ScanDirForExecutable(SmallString<128> &Dir,
2196                                  ArrayRef<std::string> Names) {
2197   for (const auto &Name : Names) {
2198     llvm::sys::path::append(Dir, Name);
2199     if (llvm::sys::fs::can_execute(Twine(Dir)))
2200       return true;
2201     llvm::sys::path::remove_filename(Dir);
2202   }
2203   return false;
2204 }
2205 
2206 std::string Driver::GetProgramPath(const char *Name,
2207                                    const ToolChain &TC) const {
2208   SmallVector<std::string, 2> TargetSpecificExecutables;
2209   generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
2210 
2211   // Respect a limited subset of the '-Bprefix' functionality in GCC by
2212   // attempting to use this prefix when looking for program paths.
2213   for (const auto &PrefixDir : PrefixDirs) {
2214     if (llvm::sys::fs::is_directory(PrefixDir)) {
2215       SmallString<128> P(PrefixDir);
2216       if (ScanDirForExecutable(P, TargetSpecificExecutables))
2217         return P.str();
2218     } else {
2219       SmallString<128> P(PrefixDir + Name);
2220       if (llvm::sys::fs::can_execute(Twine(P)))
2221         return P.str();
2222     }
2223   }
2224 
2225   const ToolChain::path_list &List = TC.getProgramPaths();
2226   for (const auto &Path : List) {
2227     SmallString<128> P(Path);
2228     if (ScanDirForExecutable(P, TargetSpecificExecutables))
2229       return P.str();
2230   }
2231 
2232   // If all else failed, search the path.
2233   for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
2234     if (llvm::ErrorOr<std::string> P =
2235             llvm::sys::findProgramByName(TargetSpecificExecutable))
2236       return *P;
2237 
2238   return Name;
2239 }
2240 
2241 std::string Driver::GetTemporaryPath(StringRef Prefix,
2242                                      const char *Suffix) const {
2243   SmallString<128> Path;
2244   std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
2245   if (EC) {
2246     Diag(clang::diag::err_unable_to_make_temp) << EC.message();
2247     return "";
2248   }
2249 
2250   return Path.str();
2251 }
2252 
2253 const ToolChain &Driver::getToolChain(const ArgList &Args,
2254                                       const llvm::Triple &Target) const {
2255 
2256   ToolChain *&TC = ToolChains[Target.str()];
2257   if (!TC) {
2258     switch (Target.getOS()) {
2259     case llvm::Triple::CloudABI:
2260       TC = new toolchains::CloudABI(*this, Target, Args);
2261       break;
2262     case llvm::Triple::Darwin:
2263     case llvm::Triple::MacOSX:
2264     case llvm::Triple::IOS:
2265     case llvm::Triple::TvOS:
2266     case llvm::Triple::WatchOS:
2267       TC = new toolchains::DarwinClang(*this, Target, Args);
2268       break;
2269     case llvm::Triple::DragonFly:
2270       TC = new toolchains::DragonFly(*this, Target, Args);
2271       break;
2272     case llvm::Triple::OpenBSD:
2273       TC = new toolchains::OpenBSD(*this, Target, Args);
2274       break;
2275     case llvm::Triple::Bitrig:
2276       TC = new toolchains::Bitrig(*this, Target, Args);
2277       break;
2278     case llvm::Triple::NetBSD:
2279       TC = new toolchains::NetBSD(*this, Target, Args);
2280       break;
2281     case llvm::Triple::FreeBSD:
2282       TC = new toolchains::FreeBSD(*this, Target, Args);
2283       break;
2284     case llvm::Triple::Minix:
2285       TC = new toolchains::Minix(*this, Target, Args);
2286       break;
2287     case llvm::Triple::Linux:
2288       if (Target.getArch() == llvm::Triple::hexagon)
2289         TC = new toolchains::HexagonToolChain(*this, Target, Args);
2290       else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
2291                !Target.hasEnvironment())
2292         TC = new toolchains::MipsLLVMToolChain(*this, Target, Args);
2293       else
2294         TC = new toolchains::Linux(*this, Target, Args);
2295       break;
2296     case llvm::Triple::NaCl:
2297       TC = new toolchains::NaClToolChain(*this, Target, Args);
2298       break;
2299     case llvm::Triple::Solaris:
2300       TC = new toolchains::Solaris(*this, Target, Args);
2301       break;
2302     case llvm::Triple::AMDHSA:
2303       TC = new toolchains::AMDGPUToolChain(*this, Target, Args);
2304       break;
2305     case llvm::Triple::Win32:
2306       switch (Target.getEnvironment()) {
2307       default:
2308         if (Target.isOSBinFormatELF())
2309           TC = new toolchains::Generic_ELF(*this, Target, Args);
2310         else if (Target.isOSBinFormatMachO())
2311           TC = new toolchains::MachO(*this, Target, Args);
2312         else
2313           TC = new toolchains::Generic_GCC(*this, Target, Args);
2314         break;
2315       case llvm::Triple::GNU:
2316         TC = new toolchains::MinGW(*this, Target, Args);
2317         break;
2318       case llvm::Triple::Itanium:
2319         TC = new toolchains::CrossWindowsToolChain(*this, Target, Args);
2320         break;
2321       case llvm::Triple::MSVC:
2322       case llvm::Triple::UnknownEnvironment:
2323         TC = new toolchains::MSVCToolChain(*this, Target, Args);
2324         break;
2325       }
2326       break;
2327     case llvm::Triple::CUDA:
2328       TC = new toolchains::CudaToolChain(*this, Target, Args);
2329       break;
2330     case llvm::Triple::PS4:
2331       TC = new toolchains::PS4CPU(*this, Target, Args);
2332       break;
2333     default:
2334       // Of these targets, Hexagon is the only one that might have
2335       // an OS of Linux, in which case it got handled above already.
2336       switch (Target.getArch()) {
2337       case llvm::Triple::tce:
2338         TC = new toolchains::TCEToolChain(*this, Target, Args);
2339         break;
2340       case llvm::Triple::hexagon:
2341         TC = new toolchains::HexagonToolChain(*this, Target, Args);
2342         break;
2343       case llvm::Triple::xcore:
2344         TC = new toolchains::XCoreToolChain(*this, Target, Args);
2345         break;
2346       case llvm::Triple::wasm32:
2347       case llvm::Triple::wasm64:
2348         TC = new toolchains::WebAssembly(*this, Target, Args);
2349         break;
2350       default:
2351         if (Target.getVendor() == llvm::Triple::Myriad)
2352           TC = new toolchains::MyriadToolChain(*this, Target, Args);
2353         else if (Target.isOSBinFormatELF())
2354           TC = new toolchains::Generic_ELF(*this, Target, Args);
2355         else if (Target.isOSBinFormatMachO())
2356           TC = new toolchains::MachO(*this, Target, Args);
2357         else
2358           TC = new toolchains::Generic_GCC(*this, Target, Args);
2359       }
2360     }
2361   }
2362   return *TC;
2363 }
2364 
2365 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
2366   // Say "no" if there is not exactly one input of a type clang understands.
2367   if (JA.size() != 1 || !types::isAcceptedByClang((*JA.begin())->getType()))
2368     return false;
2369 
2370   // And say "no" if this is not a kind of action clang understands.
2371   if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
2372       !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
2373     return false;
2374 
2375   return true;
2376 }
2377 
2378 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
2379 /// grouped values as integers. Numbers which are not provided are set to 0.
2380 ///
2381 /// \return True if the entire string was parsed (9.2), or all groups were
2382 /// parsed (10.3.5extrastuff).
2383 bool Driver::GetReleaseVersion(const char *Str, unsigned &Major,
2384                                unsigned &Minor, unsigned &Micro,
2385                                bool &HadExtra) {
2386   HadExtra = false;
2387 
2388   Major = Minor = Micro = 0;
2389   if (*Str == '\0')
2390     return false;
2391 
2392   char *End;
2393   Major = (unsigned)strtol(Str, &End, 10);
2394   if (*Str != '\0' && *End == '\0')
2395     return true;
2396   if (*End != '.')
2397     return false;
2398 
2399   Str = End + 1;
2400   Minor = (unsigned)strtol(Str, &End, 10);
2401   if (*Str != '\0' && *End == '\0')
2402     return true;
2403   if (*End != '.')
2404     return false;
2405 
2406   Str = End + 1;
2407   Micro = (unsigned)strtol(Str, &End, 10);
2408   if (*Str != '\0' && *End == '\0')
2409     return true;
2410   if (Str == End)
2411     return false;
2412   HadExtra = true;
2413   return true;
2414 }
2415 
2416 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
2417   unsigned IncludedFlagsBitmask = 0;
2418   unsigned ExcludedFlagsBitmask = options::NoDriverOption;
2419 
2420   if (Mode == CLMode) {
2421     // Include CL and Core options.
2422     IncludedFlagsBitmask |= options::CLOption;
2423     IncludedFlagsBitmask |= options::CoreOption;
2424   } else {
2425     ExcludedFlagsBitmask |= options::CLOption;
2426   }
2427 
2428   return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
2429 }
2430 
2431 bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
2432   return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
2433 }
2434