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), BitcodeEmbed(EmbedNone), 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   // Ignore -fembed-bitcode options with LTO
483   // since the output will be bitcode anyway.
484   if (!Args.hasFlag(options::OPT_flto, options::OPT_fno_lto, false)) {
485     if (Args.hasArg(options::OPT_fembed_bitcode))
486       BitcodeEmbed = EmbedBitcode;
487     else if (Args.hasArg(options::OPT_fembed_bitcode_marker))
488       BitcodeEmbed = EmbedMarker;
489   } else {
490     // claim the bitcode option under LTO so no warning is issued.
491     Args.ClaimAllArgs(options::OPT_fembed_bitcode);
492     Args.ClaimAllArgs(options::OPT_fembed_bitcode_marker);
493   }
494 
495   setLTOMode(Args);
496 
497   std::unique_ptr<llvm::opt::InputArgList> UArgs =
498       llvm::make_unique<InputArgList>(std::move(Args));
499 
500   // Perform the default argument translations.
501   DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
502 
503   // Owned by the host.
504   const ToolChain &TC =
505       getToolChain(*UArgs, computeTargetTriple(DefaultTargetTriple, *UArgs));
506 
507   // The compilation takes ownership of Args.
508   Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs);
509 
510   if (!HandleImmediateArgs(*C))
511     return C;
512 
513   // Construct the list of inputs.
514   InputList Inputs;
515   BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
516 
517   // Initialize the CUDA device TC only if we have any CUDA Inputs.  This is
518   // necessary so that we don't break compilations that pass flags that are
519   // incompatible with the NVPTX TC (e.g. -mthread-model single).
520   if (llvm::any_of(Inputs, [](const std::pair<types::ID, const Arg *> &I) {
521         return I.first == types::TY_CUDA || I.first == types::TY_PP_CUDA ||
522                I.first == types::TY_CUDA_DEVICE;
523       })) {
524     C->setCudaDeviceToolChain(
525         &getToolChain(C->getArgs(), llvm::Triple(TC.getTriple().isArch64Bit()
526                                                      ? "nvptx64-nvidia-cuda"
527                                                      : "nvptx-nvidia-cuda")));
528   }
529 
530   // Construct the list of abstract actions to perform for this compilation. On
531   // MachO targets this uses the driver-driver and universal actions.
532   if (TC.getTriple().isOSBinFormatMachO())
533     BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
534   else
535     BuildActions(*C, C->getArgs(), Inputs, C->getActions());
536 
537   if (CCCPrintPhases) {
538     PrintActions(*C);
539     return C;
540   }
541 
542   BuildJobs(*C);
543 
544   return C;
545 }
546 
547 static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
548   llvm::opt::ArgStringList ASL;
549   for (const auto *A : Args)
550     A->render(Args, ASL);
551 
552   for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
553     if (I != ASL.begin())
554       OS << ' ';
555     Command::printArg(OS, *I, true);
556   }
557   OS << '\n';
558 }
559 
560 // When clang crashes, produce diagnostic information including the fully
561 // preprocessed source file(s).  Request that the developer attach the
562 // diagnostic information to a bug report.
563 void Driver::generateCompilationDiagnostics(Compilation &C,
564                                             const Command &FailingCommand) {
565   if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
566     return;
567 
568   // Don't try to generate diagnostics for link or dsymutil jobs.
569   if (FailingCommand.getCreator().isLinkJob() ||
570       FailingCommand.getCreator().isDsymutilJob())
571     return;
572 
573   // Print the version of the compiler.
574   PrintVersion(C, llvm::errs());
575 
576   Diag(clang::diag::note_drv_command_failed_diag_msg)
577       << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
578          "crash backtrace, preprocessed source, and associated run script.";
579 
580   // Suppress driver output and emit preprocessor output to temp file.
581   Mode = CPPMode;
582   CCGenDiagnostics = true;
583 
584   // Save the original job command(s).
585   Command Cmd = FailingCommand;
586 
587   // Keep track of whether we produce any errors while trying to produce
588   // preprocessed sources.
589   DiagnosticErrorTrap Trap(Diags);
590 
591   // Suppress tool output.
592   C.initCompilationForDiagnostics();
593 
594   // Construct the list of inputs.
595   InputList Inputs;
596   BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
597 
598   for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
599     bool IgnoreInput = false;
600 
601     // Ignore input from stdin or any inputs that cannot be preprocessed.
602     // Check type first as not all linker inputs have a value.
603     if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
604       IgnoreInput = true;
605     } else if (!strcmp(it->second->getValue(), "-")) {
606       Diag(clang::diag::note_drv_command_failed_diag_msg)
607           << "Error generating preprocessed source(s) - "
608              "ignoring input from stdin.";
609       IgnoreInput = true;
610     }
611 
612     if (IgnoreInput) {
613       it = Inputs.erase(it);
614       ie = Inputs.end();
615     } else {
616       ++it;
617     }
618   }
619 
620   if (Inputs.empty()) {
621     Diag(clang::diag::note_drv_command_failed_diag_msg)
622         << "Error generating preprocessed source(s) - "
623            "no preprocessable inputs.";
624     return;
625   }
626 
627   // Don't attempt to generate preprocessed files if multiple -arch options are
628   // used, unless they're all duplicates.
629   llvm::StringSet<> ArchNames;
630   for (const Arg *A : C.getArgs()) {
631     if (A->getOption().matches(options::OPT_arch)) {
632       StringRef ArchName = A->getValue();
633       ArchNames.insert(ArchName);
634     }
635   }
636   if (ArchNames.size() > 1) {
637     Diag(clang::diag::note_drv_command_failed_diag_msg)
638         << "Error generating preprocessed source(s) - cannot generate "
639            "preprocessed source with multiple -arch options.";
640     return;
641   }
642 
643   // Construct the list of abstract actions to perform for this compilation. On
644   // Darwin OSes this uses the driver-driver and builds universal actions.
645   const ToolChain &TC = C.getDefaultToolChain();
646   if (TC.getTriple().isOSBinFormatMachO())
647     BuildUniversalActions(C, TC, Inputs);
648   else
649     BuildActions(C, C.getArgs(), Inputs, C.getActions());
650 
651   BuildJobs(C);
652 
653   // If there were errors building the compilation, quit now.
654   if (Trap.hasErrorOccurred()) {
655     Diag(clang::diag::note_drv_command_failed_diag_msg)
656         << "Error generating preprocessed source(s).";
657     return;
658   }
659 
660   // Generate preprocessed output.
661   SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
662   C.ExecuteJobs(C.getJobs(), FailingCommands);
663 
664   // If any of the preprocessing commands failed, clean up and exit.
665   if (!FailingCommands.empty()) {
666     if (!isSaveTempsEnabled())
667       C.CleanupFileList(C.getTempFiles(), true);
668 
669     Diag(clang::diag::note_drv_command_failed_diag_msg)
670         << "Error generating preprocessed source(s).";
671     return;
672   }
673 
674   const ArgStringList &TempFiles = C.getTempFiles();
675   if (TempFiles.empty()) {
676     Diag(clang::diag::note_drv_command_failed_diag_msg)
677         << "Error generating preprocessed source(s).";
678     return;
679   }
680 
681   Diag(clang::diag::note_drv_command_failed_diag_msg)
682       << "\n********************\n\n"
683          "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
684          "Preprocessed source(s) and associated run script(s) are located at:";
685 
686   SmallString<128> VFS;
687   for (const char *TempFile : TempFiles) {
688     Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
689     if (StringRef(TempFile).endswith(".cache")) {
690       // In some cases (modules) we'll dump extra data to help with reproducing
691       // the crash into a directory next to the output.
692       VFS = llvm::sys::path::filename(TempFile);
693       llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
694     }
695   }
696 
697   // Assume associated files are based off of the first temporary file.
698   CrashReportInfo CrashInfo(TempFiles[0], VFS);
699 
700   std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh";
701   std::error_code EC;
702   llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
703   if (EC) {
704     Diag(clang::diag::note_drv_command_failed_diag_msg)
705         << "Error generating run script: " + Script + " " + EC.message();
706   } else {
707     ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
708              << "# Driver args: ";
709     printArgList(ScriptOS, C.getInputArgs());
710     ScriptOS << "# Original command: ";
711     Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
712     Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
713     Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
714   }
715 
716   for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
717                                             options::OPT_frewrite_map_file_EQ))
718     Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
719 
720   Diag(clang::diag::note_drv_command_failed_diag_msg)
721       << "\n\n********************";
722 }
723 
724 void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
725   // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
726   // if the tool does not support response files, there is a chance/ that things
727   // will just work without a response file, so we silently just skip it.
728   if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
729       llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
730     return;
731 
732   std::string TmpName = GetTemporaryPath("response", "txt");
733   Cmd.setResponseFile(
734       C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str())));
735 }
736 
737 int Driver::ExecuteCompilation(
738     Compilation &C,
739     SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
740   // Just print if -### was present.
741   if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
742     C.getJobs().Print(llvm::errs(), "\n", true);
743     return 0;
744   }
745 
746   // If there were errors building the compilation, quit now.
747   if (Diags.hasErrorOccurred())
748     return 1;
749 
750   // Set up response file names for each command, if necessary
751   for (auto &Job : C.getJobs())
752     setUpResponseFiles(C, Job);
753 
754   C.ExecuteJobs(C.getJobs(), FailingCommands);
755 
756   // Remove temp files.
757   C.CleanupFileList(C.getTempFiles());
758 
759   // If the command succeeded, we are done.
760   if (FailingCommands.empty())
761     return 0;
762 
763   // Otherwise, remove result files and print extra information about abnormal
764   // failures.
765   for (const auto &CmdPair : FailingCommands) {
766     int Res = CmdPair.first;
767     const Command *FailingCommand = CmdPair.second;
768 
769     // Remove result files if we're not saving temps.
770     if (!isSaveTempsEnabled()) {
771       const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
772       C.CleanupFileMap(C.getResultFiles(), JA, true);
773 
774       // Failure result files are valid unless we crashed.
775       if (Res < 0)
776         C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
777     }
778 
779     // Print extra information about abnormal failures, if possible.
780     //
781     // This is ad-hoc, but we don't want to be excessively noisy. If the result
782     // status was 1, assume the command failed normally. In particular, if it
783     // was the compiler then assume it gave a reasonable error code. Failures
784     // in other tools are less common, and they generally have worse
785     // diagnostics, so always print the diagnostic there.
786     const Tool &FailingTool = FailingCommand->getCreator();
787 
788     if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
789       // FIXME: See FIXME above regarding result code interpretation.
790       if (Res < 0)
791         Diag(clang::diag::err_drv_command_signalled)
792             << FailingTool.getShortName();
793       else
794         Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
795                                                   << Res;
796     }
797   }
798   return 0;
799 }
800 
801 void Driver::PrintHelp(bool ShowHidden) const {
802   unsigned IncludedFlagsBitmask;
803   unsigned ExcludedFlagsBitmask;
804   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
805       getIncludeExcludeOptionFlagMasks();
806 
807   ExcludedFlagsBitmask |= options::NoDriverOption;
808   if (!ShowHidden)
809     ExcludedFlagsBitmask |= HelpHidden;
810 
811   getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
812                       IncludedFlagsBitmask, ExcludedFlagsBitmask);
813 }
814 
815 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
816   // FIXME: The following handlers should use a callback mechanism, we don't
817   // know what the client would like to do.
818   OS << getClangFullVersion() << '\n';
819   const ToolChain &TC = C.getDefaultToolChain();
820   OS << "Target: " << TC.getTripleString() << '\n';
821 
822   // Print the threading model.
823   if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
824     // Don't print if the ToolChain would have barfed on it already
825     if (TC.isThreadModelSupported(A->getValue()))
826       OS << "Thread model: " << A->getValue();
827   } else
828     OS << "Thread model: " << TC.getThreadModel();
829   OS << '\n';
830 
831   // Print out the install directory.
832   OS << "InstalledDir: " << InstalledDir << '\n';
833 }
834 
835 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
836 /// option.
837 static void PrintDiagnosticCategories(raw_ostream &OS) {
838   // Skip the empty category.
839   for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
840        ++i)
841     OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
842 }
843 
844 bool Driver::HandleImmediateArgs(const Compilation &C) {
845   // The order these options are handled in gcc is all over the place, but we
846   // don't expect inconsistencies w.r.t. that to matter in practice.
847 
848   if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
849     llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
850     return false;
851   }
852 
853   if (C.getArgs().hasArg(options::OPT_dumpversion)) {
854     // Since -dumpversion is only implemented for pedantic GCC compatibility, we
855     // return an answer which matches our definition of __VERSION__.
856     //
857     // If we want to return a more correct answer some day, then we should
858     // introduce a non-pedantically GCC compatible mode to Clang in which we
859     // provide sensible definitions for -dumpversion, __VERSION__, etc.
860     llvm::outs() << "4.2.1\n";
861     return false;
862   }
863 
864   if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
865     PrintDiagnosticCategories(llvm::outs());
866     return false;
867   }
868 
869   if (C.getArgs().hasArg(options::OPT_help) ||
870       C.getArgs().hasArg(options::OPT__help_hidden)) {
871     PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
872     return false;
873   }
874 
875   if (C.getArgs().hasArg(options::OPT__version)) {
876     // Follow gcc behavior and use stdout for --version and stderr for -v.
877     PrintVersion(C, llvm::outs());
878     return false;
879   }
880 
881   if (C.getArgs().hasArg(options::OPT_v) ||
882       C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
883     PrintVersion(C, llvm::errs());
884     SuppressMissingInputWarning = true;
885   }
886 
887   const ToolChain &TC = C.getDefaultToolChain();
888 
889   if (C.getArgs().hasArg(options::OPT_v))
890     TC.printVerboseInfo(llvm::errs());
891 
892   if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
893     llvm::outs() << "programs: =";
894     bool separator = false;
895     for (const std::string &Path : TC.getProgramPaths()) {
896       if (separator)
897         llvm::outs() << ':';
898       llvm::outs() << Path;
899       separator = true;
900     }
901     llvm::outs() << "\n";
902     llvm::outs() << "libraries: =" << ResourceDir;
903 
904     StringRef sysroot = C.getSysRoot();
905 
906     for (const std::string &Path : TC.getFilePaths()) {
907       // Always print a separator. ResourceDir was the first item shown.
908       llvm::outs() << ':';
909       // Interpretation of leading '=' is needed only for NetBSD.
910       if (Path[0] == '=')
911         llvm::outs() << sysroot << Path.substr(1);
912       else
913         llvm::outs() << Path;
914     }
915     llvm::outs() << "\n";
916     return false;
917   }
918 
919   // FIXME: The following handlers should use a callback mechanism, we don't
920   // know what the client would like to do.
921   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
922     llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
923     return false;
924   }
925 
926   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
927     llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
928     return false;
929   }
930 
931   if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
932     llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
933     return false;
934   }
935 
936   if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
937     for (const Multilib &Multilib : TC.getMultilibs())
938       llvm::outs() << Multilib << "\n";
939     return false;
940   }
941 
942   if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
943     for (const Multilib &Multilib : TC.getMultilibs()) {
944       if (Multilib.gccSuffix().empty())
945         llvm::outs() << ".\n";
946       else {
947         StringRef Suffix(Multilib.gccSuffix());
948         assert(Suffix.front() == '/');
949         llvm::outs() << Suffix.substr(1) << "\n";
950       }
951     }
952     return false;
953   }
954   return true;
955 }
956 
957 // Display an action graph human-readably.  Action A is the "sink" node
958 // and latest-occuring action. Traversal is in pre-order, visiting the
959 // inputs to each action before printing the action itself.
960 static unsigned PrintActions1(const Compilation &C, Action *A,
961                               std::map<Action *, unsigned> &Ids) {
962   if (Ids.count(A)) // A was already visited.
963     return Ids[A];
964 
965   std::string str;
966   llvm::raw_string_ostream os(str);
967 
968   os << Action::getClassName(A->getKind()) << ", ";
969   if (InputAction *IA = dyn_cast<InputAction>(A)) {
970     os << "\"" << IA->getInputArg().getValue() << "\"";
971   } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
972     os << '"' << BIA->getArchName() << '"' << ", {"
973        << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
974   } else if (CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) {
975     os << '"'
976        << (CDA->getGpuArchName() ? CDA->getGpuArchName() : "(multiple archs)")
977        << '"' << ", {" << PrintActions1(C, *CDA->input_begin(), Ids) << "}";
978   } else {
979     const ActionList *AL;
980     if (CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) {
981       os << "{" << PrintActions1(C, *CHA->input_begin(), Ids) << "}"
982          << ", gpu binaries ";
983       AL = &CHA->getDeviceActions();
984     } else
985       AL = &A->getInputs();
986 
987     if (AL->size()) {
988       const char *Prefix = "{";
989       for (Action *PreRequisite : *AL) {
990         os << Prefix << PrintActions1(C, PreRequisite, Ids);
991         Prefix = ", ";
992       }
993       os << "}";
994     } else
995       os << "{}";
996   }
997 
998   unsigned Id = Ids.size();
999   Ids[A] = Id;
1000   llvm::errs() << Id << ": " << os.str() << ", "
1001                << types::getTypeName(A->getType()) << "\n";
1002 
1003   return Id;
1004 }
1005 
1006 // Print the action graphs in a compilation C.
1007 // For example "clang -c file1.c file2.c" is composed of two subgraphs.
1008 void Driver::PrintActions(const Compilation &C) const {
1009   std::map<Action *, unsigned> Ids;
1010   for (Action *A : C.getActions())
1011     PrintActions1(C, A, Ids);
1012 }
1013 
1014 /// \brief Check whether the given input tree contains any compilation or
1015 /// assembly actions.
1016 static bool ContainsCompileOrAssembleAction(const Action *A) {
1017   if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
1018       isa<AssembleJobAction>(A))
1019     return true;
1020 
1021   for (const Action *Input : A->inputs())
1022     if (ContainsCompileOrAssembleAction(Input))
1023       return true;
1024 
1025   return false;
1026 }
1027 
1028 void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1029                                    const InputList &BAInputs) const {
1030   DerivedArgList &Args = C.getArgs();
1031   ActionList &Actions = C.getActions();
1032   llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1033   // Collect the list of architectures. Duplicates are allowed, but should only
1034   // be handled once (in the order seen).
1035   llvm::StringSet<> ArchNames;
1036   SmallVector<const char *, 4> Archs;
1037   for (Arg *A : Args) {
1038     if (A->getOption().matches(options::OPT_arch)) {
1039       // Validate the option here; we don't save the type here because its
1040       // particular spelling may participate in other driver choices.
1041       llvm::Triple::ArchType Arch =
1042           tools::darwin::getArchTypeForMachOArchName(A->getValue());
1043       if (Arch == llvm::Triple::UnknownArch) {
1044         Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
1045         continue;
1046       }
1047 
1048       A->claim();
1049       if (ArchNames.insert(A->getValue()).second)
1050         Archs.push_back(A->getValue());
1051     }
1052   }
1053 
1054   // When there is no explicit arch for this platform, make sure we still bind
1055   // the architecture (to the default) so that -Xarch_ is handled correctly.
1056   if (!Archs.size())
1057     Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
1058 
1059   ActionList SingleActions;
1060   BuildActions(C, Args, BAInputs, SingleActions);
1061 
1062   // Add in arch bindings for every top level action, as well as lipo and
1063   // dsymutil steps if needed.
1064   for (Action* Act : SingleActions) {
1065     // Make sure we can lipo this kind of output. If not (and it is an actual
1066     // output) then we disallow, since we can't create an output file with the
1067     // right name without overwriting it. We could remove this oddity by just
1068     // changing the output names to include the arch, which would also fix
1069     // -save-temps. Compatibility wins for now.
1070 
1071     if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
1072       Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
1073           << types::getTypeName(Act->getType());
1074 
1075     ActionList Inputs;
1076     for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1077       Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
1078 
1079     // Lipo if necessary, we do it this way because we need to set the arch flag
1080     // so that -Xarch_ gets overwritten.
1081     if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1082       Actions.append(Inputs.begin(), Inputs.end());
1083     else
1084       Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
1085 
1086     // Handle debug info queries.
1087     Arg *A = Args.getLastArg(options::OPT_g_Group);
1088     if (A && !A->getOption().matches(options::OPT_g0) &&
1089         !A->getOption().matches(options::OPT_gstabs) &&
1090         ContainsCompileOrAssembleAction(Actions.back())) {
1091 
1092       // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1093       // have a compile input. We need to run 'dsymutil' ourselves in such cases
1094       // because the debug info will refer to a temporary object file which
1095       // will be removed at the end of the compilation process.
1096       if (Act->getType() == types::TY_Image) {
1097         ActionList Inputs;
1098         Inputs.push_back(Actions.back());
1099         Actions.pop_back();
1100         Actions.push_back(
1101             C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
1102       }
1103 
1104       // Verify the debug info output.
1105       if (Args.hasArg(options::OPT_verify_debug_info)) {
1106         Action* LastAction = Actions.back();
1107         Actions.pop_back();
1108         Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1109             LastAction, types::TY_Nothing));
1110       }
1111     }
1112   }
1113 }
1114 
1115 /// \brief Check that the file referenced by Value exists. If it doesn't,
1116 /// issue a diagnostic and return false.
1117 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
1118                                    StringRef Value) {
1119   if (!D.getCheckInputsExist())
1120     return true;
1121 
1122   // stdin always exists.
1123   if (Value == "-")
1124     return true;
1125 
1126   SmallString<64> Path(Value);
1127   if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
1128     if (!llvm::sys::path::is_absolute(Path)) {
1129       SmallString<64> Directory(WorkDir->getValue());
1130       llvm::sys::path::append(Directory, Value);
1131       Path.assign(Directory);
1132     }
1133   }
1134 
1135   if (llvm::sys::fs::exists(Twine(Path)))
1136     return true;
1137 
1138   if (D.IsCLMode() && !llvm::sys::path::is_absolute(Twine(Path)) &&
1139       llvm::sys::Process::FindInEnvPath("LIB", Value))
1140     return true;
1141 
1142   D.Diag(clang::diag::err_drv_no_such_file) << Path;
1143   return false;
1144 }
1145 
1146 // Construct a the list of inputs and their types.
1147 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
1148                          InputList &Inputs) const {
1149   // Track the current user specified (-x) input. We also explicitly track the
1150   // argument used to set the type; we only want to claim the type when we
1151   // actually use it, so we warn about unused -x arguments.
1152   types::ID InputType = types::TY_Nothing;
1153   Arg *InputTypeArg = nullptr;
1154 
1155   // The last /TC or /TP option sets the input type to C or C++ globally.
1156   if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1157                                          options::OPT__SLASH_TP)) {
1158     InputTypeArg = TCTP;
1159     InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
1160                     ? types::TY_C
1161                     : types::TY_CXX;
1162 
1163     arg_iterator it =
1164         Args.filtered_begin(options::OPT__SLASH_TC, options::OPT__SLASH_TP);
1165     const arg_iterator ie = Args.filtered_end();
1166     Arg *Previous = *it++;
1167     bool ShowNote = false;
1168     while (it != ie) {
1169       Diag(clang::diag::warn_drv_overriding_flag_option)
1170           << Previous->getSpelling() << (*it)->getSpelling();
1171       Previous = *it++;
1172       ShowNote = true;
1173     }
1174     if (ShowNote)
1175       Diag(clang::diag::note_drv_t_option_is_global);
1176 
1177     // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1178     assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1179   }
1180 
1181   for (Arg *A : Args) {
1182     if (A->getOption().getKind() == Option::InputClass) {
1183       const char *Value = A->getValue();
1184       types::ID Ty = types::TY_INVALID;
1185 
1186       // Infer the input type if necessary.
1187       if (InputType == types::TY_Nothing) {
1188         // If there was an explicit arg for this, claim it.
1189         if (InputTypeArg)
1190           InputTypeArg->claim();
1191 
1192         // stdin must be handled specially.
1193         if (memcmp(Value, "-", 2) == 0) {
1194           // If running with -E, treat as a C input (this changes the builtin
1195           // macros, for example). This may be overridden by -ObjC below.
1196           //
1197           // Otherwise emit an error but still use a valid type to avoid
1198           // spurious errors (e.g., no inputs).
1199           if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
1200             Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1201                             : clang::diag::err_drv_unknown_stdin_type);
1202           Ty = types::TY_C;
1203         } else {
1204           // Otherwise lookup by extension.
1205           // Fallback is C if invoked as C preprocessor or Object otherwise.
1206           // We use a host hook here because Darwin at least has its own
1207           // idea of what .s is.
1208           if (const char *Ext = strrchr(Value, '.'))
1209             Ty = TC.LookupTypeForExtension(Ext + 1);
1210 
1211           if (Ty == types::TY_INVALID) {
1212             if (CCCIsCPP())
1213               Ty = types::TY_C;
1214             else
1215               Ty = types::TY_Object;
1216           }
1217 
1218           // If the driver is invoked as C++ compiler (like clang++ or c++) it
1219           // should autodetect some input files as C++ for g++ compatibility.
1220           if (CCCIsCXX()) {
1221             types::ID OldTy = Ty;
1222             Ty = types::lookupCXXTypeForCType(Ty);
1223 
1224             if (Ty != OldTy)
1225               Diag(clang::diag::warn_drv_treating_input_as_cxx)
1226                   << getTypeName(OldTy) << getTypeName(Ty);
1227           }
1228         }
1229 
1230         // -ObjC and -ObjC++ override the default language, but only for "source
1231         // files". We just treat everything that isn't a linker input as a
1232         // source file.
1233         //
1234         // FIXME: Clean this up if we move the phase sequence into the type.
1235         if (Ty != types::TY_Object) {
1236           if (Args.hasArg(options::OPT_ObjC))
1237             Ty = types::TY_ObjC;
1238           else if (Args.hasArg(options::OPT_ObjCXX))
1239             Ty = types::TY_ObjCXX;
1240         }
1241       } else {
1242         assert(InputTypeArg && "InputType set w/o InputTypeArg");
1243         if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1244           // If emulating cl.exe, make sure that /TC and /TP don't affect input
1245           // object files.
1246           const char *Ext = strrchr(Value, '.');
1247           if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1248             Ty = types::TY_Object;
1249         }
1250         if (Ty == types::TY_INVALID) {
1251           Ty = InputType;
1252           InputTypeArg->claim();
1253         }
1254       }
1255 
1256       if (DiagnoseInputExistence(*this, Args, Value))
1257         Inputs.push_back(std::make_pair(Ty, A));
1258 
1259     } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1260       StringRef Value = A->getValue();
1261       if (DiagnoseInputExistence(*this, Args, Value)) {
1262         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1263         Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1264       }
1265       A->claim();
1266     } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1267       StringRef Value = A->getValue();
1268       if (DiagnoseInputExistence(*this, Args, Value)) {
1269         Arg *InputArg = MakeInputArg(Args, Opts, A->getValue());
1270         Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1271       }
1272       A->claim();
1273     } else if (A->getOption().hasFlag(options::LinkerInput)) {
1274       // Just treat as object type, we could make a special type for this if
1275       // necessary.
1276       Inputs.push_back(std::make_pair(types::TY_Object, A));
1277 
1278     } else if (A->getOption().matches(options::OPT_x)) {
1279       InputTypeArg = A;
1280       InputType = types::lookupTypeForTypeSpecifier(A->getValue());
1281       A->claim();
1282 
1283       // Follow gcc behavior and treat as linker input for invalid -x
1284       // options. Its not clear why we shouldn't just revert to unknown; but
1285       // this isn't very important, we might as well be bug compatible.
1286       if (!InputType) {
1287         Diag(clang::diag::err_drv_unknown_language) << A->getValue();
1288         InputType = types::TY_Object;
1289       }
1290     }
1291   }
1292   if (CCCIsCPP() && Inputs.empty()) {
1293     // If called as standalone preprocessor, stdin is processed
1294     // if no other input is present.
1295     Arg *A = MakeInputArg(Args, Opts, "-");
1296     Inputs.push_back(std::make_pair(types::TY_C, A));
1297   }
1298 }
1299 
1300 // For each unique --cuda-gpu-arch= argument creates a TY_CUDA_DEVICE
1301 // input action and then wraps each in CudaDeviceAction paired with
1302 // appropriate GPU arch name. In case of partial (i.e preprocessing
1303 // only) or device-only compilation, each device action is added to /p
1304 // Actions and /p Current is released. Otherwise the function creates
1305 // and returns a new CudaHostAction which wraps /p Current and device
1306 // side actions.
1307 static Action *buildCudaActions(Compilation &C, DerivedArgList &Args,
1308                                 const Arg *InputArg, Action *HostAction,
1309                                 ActionList &Actions) {
1310   Arg *PartialCompilationArg = Args.getLastArg(options::OPT_cuda_host_only,
1311                                                options::OPT_cuda_device_only);
1312   // Host-only compilation case.
1313   if (PartialCompilationArg &&
1314       PartialCompilationArg->getOption().matches(options::OPT_cuda_host_only))
1315     return C.MakeAction<CudaHostAction>(HostAction, ActionList());
1316 
1317   // Collect all cuda_gpu_arch parameters, removing duplicates.
1318   SmallVector<const char *, 4> GpuArchList;
1319   llvm::StringSet<> GpuArchNames;
1320   for (Arg *A : Args) {
1321     if (!A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
1322       continue;
1323     A->claim();
1324 
1325     const auto& Arch = A->getValue();
1326     if (!CudaDeviceAction::IsValidGpuArchName(Arch))
1327       C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << Arch;
1328     else if (GpuArchNames.insert(Arch).second)
1329       GpuArchList.push_back(Arch);
1330   }
1331 
1332   // Default to sm_20 which is the lowest common denominator for supported GPUs.
1333   // sm_20 code should work correctly, if suboptimally, on all newer GPUs.
1334   if (GpuArchList.empty())
1335     GpuArchList.push_back("sm_20");
1336 
1337   // Replicate inputs for each GPU architecture.
1338   Driver::InputList CudaDeviceInputs;
1339   for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1340     CudaDeviceInputs.push_back(std::make_pair(types::TY_CUDA_DEVICE, InputArg));
1341 
1342   // Build actions for all device inputs.
1343   assert(C.getCudaDeviceToolChain() &&
1344          "Missing toolchain for device-side compilation.");
1345   ActionList CudaDeviceActions;
1346   C.getDriver().BuildActions(C, Args, CudaDeviceInputs, CudaDeviceActions);
1347   assert(GpuArchList.size() == CudaDeviceActions.size() &&
1348          "Failed to create actions for all devices");
1349 
1350   // Check whether any of device actions stopped before they could generate PTX.
1351   bool PartialCompilation =
1352       llvm::any_of(CudaDeviceActions, [](const Action *a) {
1353         return a->getKind() != Action::AssembleJobClass;
1354       });
1355 
1356   // Figure out what to do with device actions -- pass them as inputs to the
1357   // host action or run each of them independently.
1358   bool DeviceOnlyCompilation = PartialCompilationArg != nullptr;
1359   if (PartialCompilation || DeviceOnlyCompilation) {
1360     // In case of partial or device-only compilation results of device actions
1361     // are not consumed by the host action device actions have to be added to
1362     // top-level actions list with AtTopLevel=true and run independently.
1363 
1364     // -o is ambiguous if we have more than one top-level action.
1365     if (Args.hasArg(options::OPT_o) &&
1366         (!DeviceOnlyCompilation || GpuArchList.size() > 1)) {
1367       C.getDriver().Diag(
1368           clang::diag::err_drv_output_argument_with_multiple_files);
1369       return nullptr;
1370     }
1371 
1372     for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1373       Actions.push_back(C.MakeAction<CudaDeviceAction>(CudaDeviceActions[I],
1374                                                        GpuArchList[I],
1375                                                        /* AtTopLevel */ true));
1376     // Kill host action in case of device-only compilation.
1377     if (DeviceOnlyCompilation)
1378       return nullptr;
1379     return HostAction;
1380   }
1381 
1382   // If we're not a partial or device-only compilation, we compile each arch to
1383   // ptx and assemble to cubin, then feed the cubin *and* the ptx into a device
1384   // "link" action, which uses fatbinary to combine these cubins into one
1385   // fatbin.  The fatbin is then an input to the host compilation.
1386   ActionList DeviceActions;
1387   for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
1388     Action* AssembleAction = CudaDeviceActions[I];
1389     assert(AssembleAction->getType() == types::TY_Object);
1390     assert(AssembleAction->getInputs().size() == 1);
1391 
1392     Action* BackendAction = AssembleAction->getInputs()[0];
1393     assert(BackendAction->getType() == types::TY_PP_Asm);
1394 
1395     for (const auto& A : {AssembleAction, BackendAction}) {
1396       DeviceActions.push_back(C.MakeAction<CudaDeviceAction>(
1397           A, GpuArchList[I], /* AtTopLevel */ false));
1398     }
1399   }
1400   auto FatbinAction = C.MakeAction<CudaDeviceAction>(
1401       C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN),
1402       /* GpuArchName = */ nullptr,
1403       /* AtTopLevel = */ false);
1404   // Return a new host action that incorporates original host action and all
1405   // device actions.
1406   return C.MakeAction<CudaHostAction>(std::move(HostAction),
1407                                       ActionList({FatbinAction}));
1408 }
1409 
1410 void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
1411                           const InputList &Inputs, ActionList &Actions) const {
1412   llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
1413 
1414   if (!SuppressMissingInputWarning && Inputs.empty()) {
1415     Diag(clang::diag::err_drv_no_input_files);
1416     return;
1417   }
1418 
1419   Arg *FinalPhaseArg;
1420   phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
1421 
1422   if (FinalPhase == phases::Link && Args.hasArg(options::OPT_emit_llvm)) {
1423     Diag(clang::diag::err_drv_emit_llvm_link);
1424   }
1425 
1426   // Reject -Z* at the top level, these options should never have been exposed
1427   // by gcc.
1428   if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
1429     Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
1430 
1431   // Diagnose misuse of /Fo.
1432   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
1433     StringRef V = A->getValue();
1434     if (Inputs.size() > 1 && !V.empty() &&
1435         !llvm::sys::path::is_separator(V.back())) {
1436       // Check whether /Fo tries to name an output file for multiple inputs.
1437       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1438           << A->getSpelling() << V;
1439       Args.eraseArg(options::OPT__SLASH_Fo);
1440     }
1441   }
1442 
1443   // Diagnose misuse of /Fa.
1444   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
1445     StringRef V = A->getValue();
1446     if (Inputs.size() > 1 && !V.empty() &&
1447         !llvm::sys::path::is_separator(V.back())) {
1448       // Check whether /Fa tries to name an asm file for multiple inputs.
1449       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
1450           << A->getSpelling() << V;
1451       Args.eraseArg(options::OPT__SLASH_Fa);
1452     }
1453   }
1454 
1455   // Diagnose misuse of /o.
1456   if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
1457     if (A->getValue()[0] == '\0') {
1458       // It has to have a value.
1459       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
1460       Args.eraseArg(options::OPT__SLASH_o);
1461     }
1462   }
1463 
1464   // Diagnose unsupported forms of /Yc /Yu. Ignore /Yc/Yu for now if:
1465   // * no filename after it
1466   // * both /Yc and /Yu passed but with different filenames
1467   // * corresponding file not also passed as /FI
1468   Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
1469   Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
1470   if (YcArg && YcArg->getValue()[0] == '\0') {
1471     Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YcArg->getSpelling();
1472     Args.eraseArg(options::OPT__SLASH_Yc);
1473     YcArg = nullptr;
1474   }
1475   if (YuArg && YuArg->getValue()[0] == '\0') {
1476     Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YuArg->getSpelling();
1477     Args.eraseArg(options::OPT__SLASH_Yu);
1478     YuArg = nullptr;
1479   }
1480   if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
1481     Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
1482     Args.eraseArg(options::OPT__SLASH_Yc);
1483     Args.eraseArg(options::OPT__SLASH_Yu);
1484     YcArg = YuArg = nullptr;
1485   }
1486   if (YcArg || YuArg) {
1487     StringRef Val = YcArg ? YcArg->getValue() : YuArg->getValue();
1488     bool FoundMatchingInclude = false;
1489     for (const Arg *Inc : Args.filtered(options::OPT_include)) {
1490       // FIXME: Do case-insensitive matching and consider / and \ as equal.
1491       if (Inc->getValue() == Val)
1492         FoundMatchingInclude = true;
1493     }
1494     if (!FoundMatchingInclude) {
1495       Diag(clang::diag::warn_drv_ycyu_no_fi_arg_clang_cl)
1496           << (YcArg ? YcArg : YuArg)->getSpelling();
1497       Args.eraseArg(options::OPT__SLASH_Yc);
1498       Args.eraseArg(options::OPT__SLASH_Yu);
1499       YcArg = YuArg = nullptr;
1500     }
1501   }
1502   if (YcArg && Inputs.size() > 1) {
1503     Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
1504     Args.eraseArg(options::OPT__SLASH_Yc);
1505     YcArg = nullptr;
1506   }
1507   if (Args.hasArg(options::OPT__SLASH_Y_)) {
1508     // /Y- disables all pch handling.  Rather than check for it everywhere,
1509     // just remove clang-cl pch-related flags here.
1510     Args.eraseArg(options::OPT__SLASH_Fp);
1511     Args.eraseArg(options::OPT__SLASH_Yc);
1512     Args.eraseArg(options::OPT__SLASH_Yu);
1513     YcArg = YuArg = nullptr;
1514   }
1515 
1516   // Construct the actions to perform.
1517   ActionList LinkerInputs;
1518 
1519   llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
1520   for (auto &I : Inputs) {
1521     types::ID InputType = I.first;
1522     const Arg *InputArg = I.second;
1523 
1524     PL.clear();
1525     types::getCompilationPhases(InputType, PL);
1526 
1527     if (YcArg) {
1528       // Add a separate precompile phase for the compile phase.
1529       if (FinalPhase >= phases::Compile) {
1530         llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
1531         types::getCompilationPhases(types::TY_CXXHeader, PCHPL);
1532         Arg *PchInputArg = MakeInputArg(Args, Opts, YcArg->getValue());
1533 
1534         // Build the pipeline for the pch file.
1535         Action *ClangClPch = C.MakeAction<InputAction>(*PchInputArg, InputType);
1536         for (phases::ID Phase : PCHPL)
1537           ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
1538         assert(ClangClPch);
1539         Actions.push_back(ClangClPch);
1540         // The driver currently exits after the first failed command.  This
1541         // relies on that behavior, to make sure if the pch generation fails,
1542         // the main compilation won't run.
1543       }
1544     }
1545 
1546     // If the first step comes after the final phase we are doing as part of
1547     // this compilation, warn the user about it.
1548     phases::ID InitialPhase = PL[0];
1549     if (InitialPhase > FinalPhase) {
1550       // Claim here to avoid the more general unused warning.
1551       InputArg->claim();
1552 
1553       // Suppress all unused style warnings with -Qunused-arguments
1554       if (Args.hasArg(options::OPT_Qunused_arguments))
1555         continue;
1556 
1557       // Special case when final phase determined by binary name, rather than
1558       // by a command-line argument with a corresponding Arg.
1559       if (CCCIsCPP())
1560         Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
1561             << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
1562       // Special case '-E' warning on a previously preprocessed file to make
1563       // more sense.
1564       else if (InitialPhase == phases::Compile &&
1565                FinalPhase == phases::Preprocess &&
1566                getPreprocessedType(InputType) == types::TY_INVALID)
1567         Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
1568             << InputArg->getAsString(Args) << !!FinalPhaseArg
1569             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1570       else
1571         Diag(clang::diag::warn_drv_input_file_unused)
1572             << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
1573             << !!FinalPhaseArg
1574             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
1575       continue;
1576     }
1577 
1578     phases::ID CudaInjectionPhase =
1579         (phases::Compile < FinalPhase &&
1580          llvm::find(PL, phases::Compile) != PL.end())
1581             ? phases::Compile
1582             : FinalPhase;
1583 
1584     // Build the pipeline for this file.
1585     Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
1586     for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
1587          i != e; ++i) {
1588       phases::ID Phase = *i;
1589 
1590       // We are done if this step is past what the user requested.
1591       if (Phase > FinalPhase)
1592         break;
1593 
1594       // Queue linker inputs.
1595       if (Phase == phases::Link) {
1596         assert((i + 1) == e && "linking must be final compilation step.");
1597         LinkerInputs.push_back(Current);
1598         Current = nullptr;
1599         break;
1600       }
1601 
1602       // Some types skip the assembler phase (e.g., llvm-bc), but we can't
1603       // encode this in the steps because the intermediate type depends on
1604       // arguments. Just special case here.
1605       if (Phase == phases::Assemble && Current->getType() != types::TY_PP_Asm)
1606         continue;
1607 
1608       // Otherwise construct the appropriate action.
1609       Current = ConstructPhaseAction(C, Args, Phase, Current);
1610 
1611       if (InputType == types::TY_CUDA && Phase == CudaInjectionPhase) {
1612         Current = buildCudaActions(C, Args, InputArg, Current, Actions);
1613         if (!Current)
1614           break;
1615       }
1616 
1617       if (Current->getType() == types::TY_Nothing)
1618         break;
1619     }
1620 
1621     // If we ended with something, add to the output list.
1622     if (Current)
1623       Actions.push_back(Current);
1624   }
1625 
1626   // Add a link action if necessary.
1627   if (!LinkerInputs.empty())
1628     Actions.push_back(
1629         C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image));
1630 
1631   // If we are linking, claim any options which are obviously only used for
1632   // compilation.
1633   if (FinalPhase == phases::Link && PL.size() == 1) {
1634     Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
1635     Args.ClaimAllArgs(options::OPT_cl_compile_Group);
1636   }
1637 
1638   // Claim ignored clang-cl options.
1639   Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
1640 
1641   // Claim --cuda-host-only arg which may be passed to non-CUDA
1642   // compilations and should not trigger warnings there.
1643   Args.ClaimAllArgs(options::OPT_cuda_host_only);
1644 }
1645 
1646 Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args,
1647                                      phases::ID Phase, Action *Input) const {
1648   llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
1649   // Build the appropriate action.
1650   switch (Phase) {
1651   case phases::Link:
1652     llvm_unreachable("link action invalid here.");
1653   case phases::Preprocess: {
1654     types::ID OutputTy;
1655     // -{M, MM} alter the output type.
1656     if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
1657       OutputTy = types::TY_Dependencies;
1658     } else {
1659       OutputTy = Input->getType();
1660       if (!Args.hasFlag(options::OPT_frewrite_includes,
1661                         options::OPT_fno_rewrite_includes, false) &&
1662           !CCGenDiagnostics)
1663         OutputTy = types::getPreprocessedType(OutputTy);
1664       assert(OutputTy != types::TY_INVALID &&
1665              "Cannot preprocess this input type!");
1666     }
1667     return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
1668   }
1669   case phases::Precompile: {
1670     types::ID OutputTy = types::TY_PCH;
1671     if (Args.hasArg(options::OPT_fsyntax_only)) {
1672       // Syntax checks should not emit a PCH file
1673       OutputTy = types::TY_Nothing;
1674     }
1675     return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
1676   }
1677   case phases::Compile: {
1678     if (Args.hasArg(options::OPT_fsyntax_only))
1679       return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
1680     if (Args.hasArg(options::OPT_rewrite_objc))
1681       return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
1682     if (Args.hasArg(options::OPT_rewrite_legacy_objc))
1683       return C.MakeAction<CompileJobAction>(Input,
1684                                             types::TY_RewrittenLegacyObjC);
1685     if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
1686       return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
1687     if (Args.hasArg(options::OPT__migrate))
1688       return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
1689     if (Args.hasArg(options::OPT_emit_ast))
1690       return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
1691     if (Args.hasArg(options::OPT_module_file_info))
1692       return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
1693     if (Args.hasArg(options::OPT_verify_pch))
1694       return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
1695     return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
1696   }
1697   case phases::Backend: {
1698     if (isUsingLTO()) {
1699       types::ID Output =
1700           Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
1701       return C.MakeAction<BackendJobAction>(Input, Output);
1702     }
1703     if (Args.hasArg(options::OPT_emit_llvm)) {
1704       types::ID Output =
1705           Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
1706       return C.MakeAction<BackendJobAction>(Input, Output);
1707     }
1708     return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
1709   }
1710   case phases::Assemble:
1711     return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
1712   }
1713 
1714   llvm_unreachable("invalid phase in ConstructPhaseAction");
1715 }
1716 
1717 void Driver::BuildJobs(Compilation &C) const {
1718   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1719 
1720   Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
1721 
1722   // It is an error to provide a -o option if we are making multiple output
1723   // files.
1724   if (FinalOutput) {
1725     unsigned NumOutputs = 0;
1726     for (const Action *A : C.getActions())
1727       if (A->getType() != types::TY_Nothing)
1728         ++NumOutputs;
1729 
1730     if (NumOutputs > 1) {
1731       Diag(clang::diag::err_drv_output_argument_with_multiple_files);
1732       FinalOutput = nullptr;
1733     }
1734   }
1735 
1736   // Collect the list of architectures.
1737   llvm::StringSet<> ArchNames;
1738   if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
1739     for (const Arg *A : C.getArgs())
1740       if (A->getOption().matches(options::OPT_arch))
1741         ArchNames.insert(A->getValue());
1742 
1743   // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
1744   std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
1745   for (Action *A : C.getActions()) {
1746     // If we are linking an image for multiple archs then the linker wants
1747     // -arch_multiple and -final_output <final image name>. Unfortunately, this
1748     // doesn't fit in cleanly because we have to pass this information down.
1749     //
1750     // FIXME: This is a hack; find a cleaner way to integrate this into the
1751     // process.
1752     const char *LinkingOutput = nullptr;
1753     if (isa<LipoJobAction>(A)) {
1754       if (FinalOutput)
1755         LinkingOutput = FinalOutput->getValue();
1756       else
1757         LinkingOutput = getDefaultImageName();
1758     }
1759 
1760     BuildJobsForAction(C, A, &C.getDefaultToolChain(),
1761                        /*BoundArch*/ nullptr,
1762                        /*AtTopLevel*/ true,
1763                        /*MultipleArchs*/ ArchNames.size() > 1,
1764                        /*LinkingOutput*/ LinkingOutput, CachedResults);
1765   }
1766 
1767   // If the user passed -Qunused-arguments or there were errors, don't warn
1768   // about any unused arguments.
1769   if (Diags.hasErrorOccurred() ||
1770       C.getArgs().hasArg(options::OPT_Qunused_arguments))
1771     return;
1772 
1773   // Claim -### here.
1774   (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
1775 
1776   // Claim --driver-mode, it was handled earlier.
1777   (void)C.getArgs().hasArg(options::OPT_driver_mode);
1778 
1779   for (Arg *A : C.getArgs()) {
1780     // FIXME: It would be nice to be able to send the argument to the
1781     // DiagnosticsEngine, so that extra values, position, and so on could be
1782     // printed.
1783     if (!A->isClaimed()) {
1784       if (A->getOption().hasFlag(options::NoArgumentUnused))
1785         continue;
1786 
1787       // Suppress the warning automatically if this is just a flag, and it is an
1788       // instance of an argument we already claimed.
1789       const Option &Opt = A->getOption();
1790       if (Opt.getKind() == Option::FlagClass) {
1791         bool DuplicateClaimed = false;
1792 
1793         for (const Arg *AA : C.getArgs().filtered(&Opt)) {
1794           if (AA->isClaimed()) {
1795             DuplicateClaimed = true;
1796             break;
1797           }
1798         }
1799 
1800         if (DuplicateClaimed)
1801           continue;
1802       }
1803 
1804       // In clang-cl, don't mention unknown arguments here since they have
1805       // already been warned about.
1806       if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
1807         Diag(clang::diag::warn_drv_unused_argument)
1808             << A->getAsString(C.getArgs());
1809     }
1810   }
1811 }
1812 
1813 // Returns a Tool for a given JobAction.  In case the action and its
1814 // predecessors can be combined, updates Inputs with the inputs of the
1815 // first combined action. If one of the collapsed actions is a
1816 // CudaHostAction, updates CollapsedCHA with the pointer to it so the
1817 // caller can deal with extra handling such action requires.
1818 static const Tool *selectToolForJob(Compilation &C, bool SaveTemps,
1819                                     bool EmbedBitcode, const ToolChain *TC,
1820                                     const JobAction *JA,
1821                                     const ActionList *&Inputs,
1822                                     const CudaHostAction *&CollapsedCHA) {
1823   const Tool *ToolForJob = nullptr;
1824   CollapsedCHA = nullptr;
1825 
1826   // See if we should look for a compiler with an integrated assembler. We match
1827   // bottom up, so what we are actually looking for is an assembler job with a
1828   // compiler input.
1829 
1830   if (TC->useIntegratedAs() && !SaveTemps &&
1831       !C.getArgs().hasArg(options::OPT_via_file_asm) &&
1832       !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
1833       !C.getArgs().hasArg(options::OPT__SLASH_Fa) &&
1834       isa<AssembleJobAction>(JA) && Inputs->size() == 1 &&
1835       isa<BackendJobAction>(*Inputs->begin())) {
1836     // A BackendJob is always preceded by a CompileJob, and without -save-temps
1837     // or -fembed-bitcode, they will always get combined together, so instead of
1838     // checking the backend tool, check if the tool for the CompileJob has an
1839     // integrated assembler. For -fembed-bitcode, CompileJob is still used to
1840     // look up tools for BackendJob, but they need to match before we can split
1841     // them.
1842     const ActionList *BackendInputs = &(*Inputs)[0]->getInputs();
1843     // Compile job may be wrapped in CudaHostAction, extract it if
1844     // that's the case and update CollapsedCHA if we combine phases.
1845     CudaHostAction *CHA = dyn_cast<CudaHostAction>(*BackendInputs->begin());
1846     JobAction *CompileJA = cast<CompileJobAction>(
1847         CHA ? *CHA->input_begin() : *BackendInputs->begin());
1848     assert(CompileJA && "Backend job is not preceeded by compile job.");
1849     const Tool *Compiler = TC->SelectTool(*CompileJA);
1850     if (!Compiler)
1851       return nullptr;
1852     // When using -fembed-bitcode, it is required to have the same tool (clang)
1853     // for both CompilerJA and BackendJA. Otherwise, combine two stages.
1854     if (EmbedBitcode) {
1855       JobAction *InputJA = cast<JobAction>(*Inputs->begin());
1856       const Tool *BackendTool = TC->SelectTool(*InputJA);
1857       if (BackendTool == Compiler)
1858         CompileJA = InputJA;
1859     }
1860     if (Compiler->hasIntegratedAssembler()) {
1861       Inputs = &CompileJA->getInputs();
1862       ToolForJob = Compiler;
1863       CollapsedCHA = CHA;
1864     }
1865   }
1866 
1867   // A backend job should always be combined with the preceding compile job
1868   // unless OPT_save_temps or OPT_fembed_bitcode is enabled and the compiler is
1869   // capable of emitting LLVM IR as an intermediate output.
1870   if (isa<BackendJobAction>(JA)) {
1871     // Check if the compiler supports emitting LLVM IR.
1872     assert(Inputs->size() == 1);
1873     // Compile job may be wrapped in CudaHostAction, extract it if
1874     // that's the case and update CollapsedCHA if we combine phases.
1875     CudaHostAction *CHA = dyn_cast<CudaHostAction>(*Inputs->begin());
1876     JobAction *CompileJA =
1877         cast<CompileJobAction>(CHA ? *CHA->input_begin() : *Inputs->begin());
1878     assert(CompileJA && "Backend job is not preceeded by compile job.");
1879     const Tool *Compiler = TC->SelectTool(*CompileJA);
1880     if (!Compiler)
1881       return nullptr;
1882     if (!Compiler->canEmitIR() ||
1883         (!SaveTemps && !EmbedBitcode)) {
1884       Inputs = &CompileJA->getInputs();
1885       ToolForJob = Compiler;
1886       CollapsedCHA = CHA;
1887     }
1888   }
1889 
1890   // Otherwise use the tool for the current job.
1891   if (!ToolForJob)
1892     ToolForJob = TC->SelectTool(*JA);
1893 
1894   // See if we should use an integrated preprocessor. We do so when we have
1895   // exactly one input, since this is the only use case we care about
1896   // (irrelevant since we don't support combine yet).
1897   if (Inputs->size() == 1 && isa<PreprocessJobAction>(*Inputs->begin()) &&
1898       !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
1899       !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
1900       !C.getArgs().hasArg(options::OPT_rewrite_objc) &&
1901       ToolForJob->hasIntegratedCPP())
1902     Inputs = &(*Inputs)[0]->getInputs();
1903 
1904   return ToolForJob;
1905 }
1906 
1907 InputInfo Driver::BuildJobsForAction(
1908     Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch,
1909     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
1910     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults)
1911     const {
1912   // The bound arch is not necessarily represented in the toolchain's triple --
1913   // for example, armv7 and armv7s both map to the same triple -- so we need
1914   // both in our map.
1915   std::string TriplePlusArch = TC->getTriple().normalize();
1916   if (BoundArch) {
1917     TriplePlusArch += "-";
1918     TriplePlusArch += BoundArch;
1919   }
1920   std::pair<const Action *, std::string> ActionTC = {A, TriplePlusArch};
1921   auto CachedResult = CachedResults.find(ActionTC);
1922   if (CachedResult != CachedResults.end()) {
1923     return CachedResult->second;
1924   }
1925   InputInfo Result =
1926       BuildJobsForActionNoCache(C, A, TC, BoundArch, AtTopLevel, MultipleArchs,
1927                                 LinkingOutput, CachedResults);
1928   CachedResults[ActionTC] = Result;
1929   return Result;
1930 }
1931 
1932 InputInfo Driver::BuildJobsForActionNoCache(
1933     Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch,
1934     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
1935     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults)
1936     const {
1937   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
1938 
1939   InputInfoList CudaDeviceInputInfos;
1940   if (const CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) {
1941     // Append outputs of device jobs to the input list.
1942     for (const Action *DA : CHA->getDeviceActions()) {
1943       CudaDeviceInputInfos.push_back(BuildJobsForAction(
1944           C, DA, TC, nullptr, AtTopLevel,
1945           /*MultipleArchs*/ false, LinkingOutput, CachedResults));
1946     }
1947     // Override current action with a real host compile action and continue
1948     // processing it.
1949     A = *CHA->input_begin();
1950   }
1951 
1952   if (const InputAction *IA = dyn_cast<InputAction>(A)) {
1953     // FIXME: It would be nice to not claim this here; maybe the old scheme of
1954     // just using Args was better?
1955     const Arg &Input = IA->getInputArg();
1956     Input.claim();
1957     if (Input.getOption().matches(options::OPT_INPUT)) {
1958       const char *Name = Input.getValue();
1959       return InputInfo(A, Name, /* BaseInput = */ Name);
1960     }
1961     return InputInfo(A, &Input, /* BaseInput = */ "");
1962   }
1963 
1964   if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
1965     const ToolChain *TC;
1966     const char *ArchName = BAA->getArchName();
1967 
1968     if (ArchName)
1969       TC = &getToolChain(
1970           C.getArgs(),
1971           computeTargetTriple(DefaultTargetTriple, C.getArgs(), ArchName));
1972     else
1973       TC = &C.getDefaultToolChain();
1974 
1975     return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
1976                               MultipleArchs, LinkingOutput, CachedResults);
1977   }
1978 
1979   if (const CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) {
1980     // Initial processing of CudaDeviceAction carries host params.
1981     // Call BuildJobsForAction() again, now with correct device parameters.
1982     InputInfo II = BuildJobsForAction(
1983         C, *CDA->input_begin(), C.getCudaDeviceToolChain(),
1984         CDA->getGpuArchName(), CDA->isAtTopLevel(), /*MultipleArchs=*/true,
1985         LinkingOutput, CachedResults);
1986     // Currently II's Action is *CDA->input_begin().  Set it to CDA instead, so
1987     // that one can retrieve II's GPU arch.
1988     II.setAction(A);
1989     return II;
1990   }
1991 
1992   const ActionList *Inputs = &A->getInputs();
1993 
1994   const JobAction *JA = cast<JobAction>(A);
1995   const CudaHostAction *CollapsedCHA = nullptr;
1996   const Tool *T =
1997       selectToolForJob(C, isSaveTempsEnabled(), embedBitcodeEnabled(), TC, JA,
1998                        Inputs, CollapsedCHA);
1999   if (!T)
2000     return InputInfo();
2001 
2002   // If we've collapsed action list that contained CudaHostAction we
2003   // need to build jobs for device-side inputs it may have held.
2004   if (CollapsedCHA) {
2005     for (const Action *DA : CollapsedCHA->getDeviceActions()) {
2006       CudaDeviceInputInfos.push_back(BuildJobsForAction(
2007           C, DA, TC, "", AtTopLevel,
2008           /*MultipleArchs*/ false, LinkingOutput, CachedResults));
2009     }
2010   }
2011 
2012   // Only use pipes when there is exactly one input.
2013   InputInfoList InputInfos;
2014   for (const Action *Input : *Inputs) {
2015     // Treat dsymutil and verify sub-jobs as being at the top-level too, they
2016     // shouldn't get temporary output names.
2017     // FIXME: Clean this up.
2018     bool SubJobAtTopLevel =
2019         AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
2020     InputInfos.push_back(BuildJobsForAction(C, Input, TC, BoundArch,
2021                                             SubJobAtTopLevel, MultipleArchs,
2022                                             LinkingOutput, CachedResults));
2023   }
2024 
2025   // Always use the first input as the base input.
2026   const char *BaseInput = InputInfos[0].getBaseInput();
2027 
2028   // ... except dsymutil actions, which use their actual input as the base
2029   // input.
2030   if (JA->getType() == types::TY_dSYM)
2031     BaseInput = InputInfos[0].getFilename();
2032 
2033   // Append outputs of cuda device jobs to the input list
2034   if (CudaDeviceInputInfos.size())
2035     InputInfos.append(CudaDeviceInputInfos.begin(), CudaDeviceInputInfos.end());
2036 
2037   // Determine the place to write output to, if any.
2038   InputInfo Result;
2039   if (JA->getType() == types::TY_Nothing)
2040     Result = InputInfo(A, BaseInput);
2041   else
2042     Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
2043                                              AtTopLevel, MultipleArchs),
2044                        BaseInput);
2045 
2046   if (CCCPrintBindings && !CCGenDiagnostics) {
2047     llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
2048                  << " - \"" << T->getName() << "\", inputs: [";
2049     for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
2050       llvm::errs() << InputInfos[i].getAsString();
2051       if (i + 1 != e)
2052         llvm::errs() << ", ";
2053     }
2054     llvm::errs() << "], output: " << Result.getAsString() << "\n";
2055   } else {
2056     T->ConstructJob(C, *JA, Result, InputInfos,
2057                     C.getArgsForToolChain(TC, BoundArch), LinkingOutput);
2058   }
2059   return Result;
2060 }
2061 
2062 const char *Driver::getDefaultImageName() const {
2063   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
2064   return Target.isOSWindows() ? "a.exe" : "a.out";
2065 }
2066 
2067 /// \brief Create output filename based on ArgValue, which could either be a
2068 /// full filename, filename without extension, or a directory. If ArgValue
2069 /// does not provide a filename, then use BaseName, and use the extension
2070 /// suitable for FileType.
2071 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
2072                                         StringRef BaseName,
2073                                         types::ID FileType) {
2074   SmallString<128> Filename = ArgValue;
2075 
2076   if (ArgValue.empty()) {
2077     // If the argument is empty, output to BaseName in the current dir.
2078     Filename = BaseName;
2079   } else if (llvm::sys::path::is_separator(Filename.back())) {
2080     // If the argument is a directory, output to BaseName in that dir.
2081     llvm::sys::path::append(Filename, BaseName);
2082   }
2083 
2084   if (!llvm::sys::path::has_extension(ArgValue)) {
2085     // If the argument didn't provide an extension, then set it.
2086     const char *Extension = types::getTypeTempSuffix(FileType, true);
2087 
2088     if (FileType == types::TY_Image &&
2089         Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
2090       // The output file is a dll.
2091       Extension = "dll";
2092     }
2093 
2094     llvm::sys::path::replace_extension(Filename, Extension);
2095   }
2096 
2097   return Args.MakeArgString(Filename.c_str());
2098 }
2099 
2100 const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
2101                                        const char *BaseInput,
2102                                        const char *BoundArch, bool AtTopLevel,
2103                                        bool MultipleArchs) const {
2104   llvm::PrettyStackTraceString CrashInfo("Computing output path");
2105   // Output to a user requested destination?
2106   if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
2107     if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
2108       return C.addResultFile(FinalOutput->getValue(), &JA);
2109   }
2110 
2111   // For /P, preprocess to file named after BaseInput.
2112   if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
2113     assert(AtTopLevel && isa<PreprocessJobAction>(JA));
2114     StringRef BaseName = llvm::sys::path::filename(BaseInput);
2115     StringRef NameArg;
2116     if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
2117       NameArg = A->getValue();
2118     return C.addResultFile(
2119         MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
2120         &JA);
2121   }
2122 
2123   // Default to writing to stdout?
2124   if (AtTopLevel && !CCGenDiagnostics &&
2125       (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
2126     return "-";
2127 
2128   // Is this the assembly listing for /FA?
2129   if (JA.getType() == types::TY_PP_Asm &&
2130       (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
2131        C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
2132     // Use /Fa and the input filename to determine the asm file name.
2133     StringRef BaseName = llvm::sys::path::filename(BaseInput);
2134     StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
2135     return C.addResultFile(
2136         MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
2137         &JA);
2138   }
2139 
2140   // Output to a temporary file?
2141   if ((!AtTopLevel && !isSaveTempsEnabled() &&
2142        !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
2143       CCGenDiagnostics) {
2144     StringRef Name = llvm::sys::path::filename(BaseInput);
2145     std::pair<StringRef, StringRef> Split = Name.split('.');
2146     std::string TmpName = GetTemporaryPath(
2147         Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
2148     return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
2149   }
2150 
2151   SmallString<128> BasePath(BaseInput);
2152   StringRef BaseName;
2153 
2154   // Dsymutil actions should use the full path.
2155   if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
2156     BaseName = BasePath;
2157   else
2158     BaseName = llvm::sys::path::filename(BasePath);
2159 
2160   // Determine what the derived output name should be.
2161   const char *NamedOutput;
2162 
2163   if (JA.getType() == types::TY_Object &&
2164       C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
2165     // The /Fo or /o flag decides the object filename.
2166     StringRef Val =
2167         C.getArgs()
2168             .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
2169             ->getValue();
2170     NamedOutput =
2171         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
2172   } else if (JA.getType() == types::TY_Image &&
2173              C.getArgs().hasArg(options::OPT__SLASH_Fe,
2174                                 options::OPT__SLASH_o)) {
2175     // The /Fe or /o flag names the linked file.
2176     StringRef Val =
2177         C.getArgs()
2178             .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
2179             ->getValue();
2180     NamedOutput =
2181         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
2182   } else if (JA.getType() == types::TY_Image) {
2183     if (IsCLMode()) {
2184       // clang-cl uses BaseName for the executable name.
2185       NamedOutput =
2186           MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
2187     } else if (MultipleArchs && BoundArch) {
2188       SmallString<128> Output(getDefaultImageName());
2189       Output += "-";
2190       Output.append(BoundArch);
2191       NamedOutput = C.getArgs().MakeArgString(Output.c_str());
2192     } else {
2193       NamedOutput = getDefaultImageName();
2194     }
2195   } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
2196     NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName).c_str());
2197   } else {
2198     const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
2199     assert(Suffix && "All types used for output should have a suffix.");
2200 
2201     std::string::size_type End = std::string::npos;
2202     if (!types::appendSuffixForType(JA.getType()))
2203       End = BaseName.rfind('.');
2204     SmallString<128> Suffixed(BaseName.substr(0, End));
2205     if (MultipleArchs && BoundArch) {
2206       Suffixed += "-";
2207       Suffixed.append(BoundArch);
2208     }
2209     // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
2210     // the unoptimized bitcode so that it does not get overwritten by the ".bc"
2211     // optimized bitcode output.
2212     if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
2213         JA.getType() == types::TY_LLVM_BC)
2214       Suffixed += ".tmp";
2215     Suffixed += '.';
2216     Suffixed += Suffix;
2217     NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
2218   }
2219 
2220   // Prepend object file path if -save-temps=obj
2221   if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
2222       JA.getType() != types::TY_PCH) {
2223     Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
2224     SmallString<128> TempPath(FinalOutput->getValue());
2225     llvm::sys::path::remove_filename(TempPath);
2226     StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
2227     llvm::sys::path::append(TempPath, OutputFileName);
2228     NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
2229   }
2230 
2231   // If we're saving temps and the temp file conflicts with the input file,
2232   // then avoid overwriting input file.
2233   if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
2234     bool SameFile = false;
2235     SmallString<256> Result;
2236     llvm::sys::fs::current_path(Result);
2237     llvm::sys::path::append(Result, BaseName);
2238     llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
2239     // Must share the same path to conflict.
2240     if (SameFile) {
2241       StringRef Name = llvm::sys::path::filename(BaseInput);
2242       std::pair<StringRef, StringRef> Split = Name.split('.');
2243       std::string TmpName = GetTemporaryPath(
2244           Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
2245       return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()));
2246     }
2247   }
2248 
2249   // As an annoying special case, PCH generation doesn't strip the pathname.
2250   if (JA.getType() == types::TY_PCH && !IsCLMode()) {
2251     llvm::sys::path::remove_filename(BasePath);
2252     if (BasePath.empty())
2253       BasePath = NamedOutput;
2254     else
2255       llvm::sys::path::append(BasePath, NamedOutput);
2256     return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
2257   } else {
2258     return C.addResultFile(NamedOutput, &JA);
2259   }
2260 }
2261 
2262 std::string Driver::GetFilePath(const char *Name, const ToolChain &TC) const {
2263   // Respect a limited subset of the '-Bprefix' functionality in GCC by
2264   // attempting to use this prefix when looking for file paths.
2265   for (const std::string &Dir : PrefixDirs) {
2266     if (Dir.empty())
2267       continue;
2268     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
2269     llvm::sys::path::append(P, Name);
2270     if (llvm::sys::fs::exists(Twine(P)))
2271       return P.str();
2272   }
2273 
2274   SmallString<128> P(ResourceDir);
2275   llvm::sys::path::append(P, Name);
2276   if (llvm::sys::fs::exists(Twine(P)))
2277     return P.str();
2278 
2279   for (const std::string &Dir : TC.getFilePaths()) {
2280     if (Dir.empty())
2281       continue;
2282     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
2283     llvm::sys::path::append(P, Name);
2284     if (llvm::sys::fs::exists(Twine(P)))
2285       return P.str();
2286   }
2287 
2288   return Name;
2289 }
2290 
2291 void Driver::generatePrefixedToolNames(
2292     const char *Tool, const ToolChain &TC,
2293     SmallVectorImpl<std::string> &Names) const {
2294   // FIXME: Needs a better variable than DefaultTargetTriple
2295   Names.emplace_back(DefaultTargetTriple + "-" + Tool);
2296   Names.emplace_back(Tool);
2297 
2298   // Allow the discovery of tools prefixed with LLVM's default target triple.
2299   std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
2300   if (LLVMDefaultTargetTriple != DefaultTargetTriple)
2301     Names.emplace_back(LLVMDefaultTargetTriple + "-" + Tool);
2302 }
2303 
2304 static bool ScanDirForExecutable(SmallString<128> &Dir,
2305                                  ArrayRef<std::string> Names) {
2306   for (const auto &Name : Names) {
2307     llvm::sys::path::append(Dir, Name);
2308     if (llvm::sys::fs::can_execute(Twine(Dir)))
2309       return true;
2310     llvm::sys::path::remove_filename(Dir);
2311   }
2312   return false;
2313 }
2314 
2315 std::string Driver::GetProgramPath(const char *Name,
2316                                    const ToolChain &TC) const {
2317   SmallVector<std::string, 2> TargetSpecificExecutables;
2318   generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
2319 
2320   // Respect a limited subset of the '-Bprefix' functionality in GCC by
2321   // attempting to use this prefix when looking for program paths.
2322   for (const auto &PrefixDir : PrefixDirs) {
2323     if (llvm::sys::fs::is_directory(PrefixDir)) {
2324       SmallString<128> P(PrefixDir);
2325       if (ScanDirForExecutable(P, TargetSpecificExecutables))
2326         return P.str();
2327     } else {
2328       SmallString<128> P(PrefixDir + Name);
2329       if (llvm::sys::fs::can_execute(Twine(P)))
2330         return P.str();
2331     }
2332   }
2333 
2334   const ToolChain::path_list &List = TC.getProgramPaths();
2335   for (const auto &Path : List) {
2336     SmallString<128> P(Path);
2337     if (ScanDirForExecutable(P, TargetSpecificExecutables))
2338       return P.str();
2339   }
2340 
2341   // If all else failed, search the path.
2342   for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
2343     if (llvm::ErrorOr<std::string> P =
2344             llvm::sys::findProgramByName(TargetSpecificExecutable))
2345       return *P;
2346 
2347   return Name;
2348 }
2349 
2350 std::string Driver::GetTemporaryPath(StringRef Prefix,
2351                                      const char *Suffix) const {
2352   SmallString<128> Path;
2353   std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
2354   if (EC) {
2355     Diag(clang::diag::err_unable_to_make_temp) << EC.message();
2356     return "";
2357   }
2358 
2359   return Path.str();
2360 }
2361 
2362 std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
2363   SmallString<128> Output;
2364   if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
2365     // FIXME: If anybody needs it, implement this obscure rule:
2366     // "If you specify a directory without a file name, the default file name
2367     // is VCx0.pch., where x is the major version of Visual C++ in use."
2368     Output = FpArg->getValue();
2369 
2370     // "If you do not specify an extension as part of the path name, an
2371     // extension of .pch is assumed. "
2372     if (!llvm::sys::path::has_extension(Output))
2373       Output += ".pch";
2374   } else {
2375     Output = BaseName;
2376     llvm::sys::path::replace_extension(Output, ".pch");
2377   }
2378   return Output.str();
2379 }
2380 
2381 const ToolChain &Driver::getToolChain(const ArgList &Args,
2382                                       const llvm::Triple &Target) const {
2383 
2384   ToolChain *&TC = ToolChains[Target.str()];
2385   if (!TC) {
2386     switch (Target.getOS()) {
2387     case llvm::Triple::CloudABI:
2388       TC = new toolchains::CloudABI(*this, Target, Args);
2389       break;
2390     case llvm::Triple::Darwin:
2391     case llvm::Triple::MacOSX:
2392     case llvm::Triple::IOS:
2393     case llvm::Triple::TvOS:
2394     case llvm::Triple::WatchOS:
2395       TC = new toolchains::DarwinClang(*this, Target, Args);
2396       break;
2397     case llvm::Triple::DragonFly:
2398       TC = new toolchains::DragonFly(*this, Target, Args);
2399       break;
2400     case llvm::Triple::OpenBSD:
2401       TC = new toolchains::OpenBSD(*this, Target, Args);
2402       break;
2403     case llvm::Triple::Bitrig:
2404       TC = new toolchains::Bitrig(*this, Target, Args);
2405       break;
2406     case llvm::Triple::NetBSD:
2407       TC = new toolchains::NetBSD(*this, Target, Args);
2408       break;
2409     case llvm::Triple::FreeBSD:
2410       TC = new toolchains::FreeBSD(*this, Target, Args);
2411       break;
2412     case llvm::Triple::Minix:
2413       TC = new toolchains::Minix(*this, Target, Args);
2414       break;
2415     case llvm::Triple::Linux:
2416       if (Target.getArch() == llvm::Triple::hexagon)
2417         TC = new toolchains::HexagonToolChain(*this, Target, Args);
2418       else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
2419                !Target.hasEnvironment())
2420         TC = new toolchains::MipsLLVMToolChain(*this, Target, Args);
2421       else
2422         TC = new toolchains::Linux(*this, Target, Args);
2423       break;
2424     case llvm::Triple::NaCl:
2425       TC = new toolchains::NaClToolChain(*this, Target, Args);
2426       break;
2427     case llvm::Triple::Solaris:
2428       TC = new toolchains::Solaris(*this, Target, Args);
2429       break;
2430     case llvm::Triple::AMDHSA:
2431       TC = new toolchains::AMDGPUToolChain(*this, Target, Args);
2432       break;
2433     case llvm::Triple::Win32:
2434       switch (Target.getEnvironment()) {
2435       default:
2436         if (Target.isOSBinFormatELF())
2437           TC = new toolchains::Generic_ELF(*this, Target, Args);
2438         else if (Target.isOSBinFormatMachO())
2439           TC = new toolchains::MachO(*this, Target, Args);
2440         else
2441           TC = new toolchains::Generic_GCC(*this, Target, Args);
2442         break;
2443       case llvm::Triple::GNU:
2444         TC = new toolchains::MinGW(*this, Target, Args);
2445         break;
2446       case llvm::Triple::Itanium:
2447         TC = new toolchains::CrossWindowsToolChain(*this, Target, Args);
2448         break;
2449       case llvm::Triple::MSVC:
2450       case llvm::Triple::UnknownEnvironment:
2451         TC = new toolchains::MSVCToolChain(*this, Target, Args);
2452         break;
2453       }
2454       break;
2455     case llvm::Triple::CUDA:
2456       TC = new toolchains::CudaToolChain(*this, Target, Args);
2457       break;
2458     case llvm::Triple::PS4:
2459       TC = new toolchains::PS4CPU(*this, Target, Args);
2460       break;
2461     default:
2462       // Of these targets, Hexagon is the only one that might have
2463       // an OS of Linux, in which case it got handled above already.
2464       switch (Target.getArch()) {
2465       case llvm::Triple::tce:
2466         TC = new toolchains::TCEToolChain(*this, Target, Args);
2467         break;
2468       case llvm::Triple::hexagon:
2469         TC = new toolchains::HexagonToolChain(*this, Target, Args);
2470         break;
2471       case llvm::Triple::lanai:
2472         TC = new toolchains::LanaiToolChain(*this, Target, Args);
2473         break;
2474       case llvm::Triple::xcore:
2475         TC = new toolchains::XCoreToolChain(*this, Target, Args);
2476         break;
2477       case llvm::Triple::wasm32:
2478       case llvm::Triple::wasm64:
2479         TC = new toolchains::WebAssembly(*this, Target, Args);
2480         break;
2481       default:
2482         if (Target.getVendor() == llvm::Triple::Myriad)
2483           TC = new toolchains::MyriadToolChain(*this, Target, Args);
2484         else if (Target.isOSBinFormatELF())
2485           TC = new toolchains::Generic_ELF(*this, Target, Args);
2486         else if (Target.isOSBinFormatMachO())
2487           TC = new toolchains::MachO(*this, Target, Args);
2488         else
2489           TC = new toolchains::Generic_GCC(*this, Target, Args);
2490       }
2491     }
2492   }
2493   return *TC;
2494 }
2495 
2496 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
2497   // Say "no" if there is not exactly one input of a type clang understands.
2498   if (JA.size() != 1 ||
2499       !types::isAcceptedByClang((*JA.input_begin())->getType()))
2500     return false;
2501 
2502   // And say "no" if this is not a kind of action clang understands.
2503   if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
2504       !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
2505     return false;
2506 
2507   return true;
2508 }
2509 
2510 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
2511 /// grouped values as integers. Numbers which are not provided are set to 0.
2512 ///
2513 /// \return True if the entire string was parsed (9.2), or all groups were
2514 /// parsed (10.3.5extrastuff).
2515 bool Driver::GetReleaseVersion(const char *Str, unsigned &Major,
2516                                unsigned &Minor, unsigned &Micro,
2517                                bool &HadExtra) {
2518   HadExtra = false;
2519 
2520   Major = Minor = Micro = 0;
2521   if (*Str == '\0')
2522     return false;
2523 
2524   char *End;
2525   Major = (unsigned)strtol(Str, &End, 10);
2526   if (*Str != '\0' && *End == '\0')
2527     return true;
2528   if (*End != '.')
2529     return false;
2530 
2531   Str = End + 1;
2532   Minor = (unsigned)strtol(Str, &End, 10);
2533   if (*Str != '\0' && *End == '\0')
2534     return true;
2535   if (*End != '.')
2536     return false;
2537 
2538   Str = End + 1;
2539   Micro = (unsigned)strtol(Str, &End, 10);
2540   if (*Str != '\0' && *End == '\0')
2541     return true;
2542   if (Str == End)
2543     return false;
2544   HadExtra = true;
2545   return true;
2546 }
2547 
2548 /// Parse digits from a string \p Str and fulfill \p Digits with
2549 /// the parsed numbers. This method assumes that the max number of
2550 /// digits to look for is equal to Digits.size().
2551 ///
2552 /// \return True if the entire string was parsed and there are
2553 /// no extra characters remaining at the end.
2554 bool Driver::GetReleaseVersion(const char *Str,
2555                                MutableArrayRef<unsigned> Digits) {
2556   if (*Str == '\0')
2557     return false;
2558 
2559   char *End;
2560   unsigned CurDigit = 0;
2561   while (CurDigit < Digits.size()) {
2562     unsigned Digit = (unsigned)strtol(Str, &End, 10);
2563     Digits[CurDigit] = Digit;
2564     if (*Str != '\0' && *End == '\0')
2565       return true;
2566     if (*End != '.' || Str == End)
2567       return false;
2568     Str = End + 1;
2569     CurDigit++;
2570   }
2571 
2572   // More digits than requested, bail out...
2573   return false;
2574 }
2575 
2576 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
2577   unsigned IncludedFlagsBitmask = 0;
2578   unsigned ExcludedFlagsBitmask = options::NoDriverOption;
2579 
2580   if (Mode == CLMode) {
2581     // Include CL and Core options.
2582     IncludedFlagsBitmask |= options::CLOption;
2583     IncludedFlagsBitmask |= options::CoreOption;
2584   } else {
2585     ExcludedFlagsBitmask |= options::CLOption;
2586   }
2587 
2588   return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
2589 }
2590 
2591 bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
2592   return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
2593 }
2594