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/AMDGPU.h"
13 #include "ToolChains/AVR.h"
14 #include "ToolChains/Ananas.h"
15 #include "ToolChains/Clang.h"
16 #include "ToolChains/CloudABI.h"
17 #include "ToolChains/Contiki.h"
18 #include "ToolChains/CrossWindows.h"
19 #include "ToolChains/Cuda.h"
20 #include "ToolChains/Darwin.h"
21 #include "ToolChains/DragonFly.h"
22 #include "ToolChains/FreeBSD.h"
23 #include "ToolChains/Fuchsia.h"
24 #include "ToolChains/Gnu.h"
25 #include "ToolChains/BareMetal.h"
26 #include "ToolChains/Haiku.h"
27 #include "ToolChains/Hexagon.h"
28 #include "ToolChains/Lanai.h"
29 #include "ToolChains/Linux.h"
30 #include "ToolChains/MinGW.h"
31 #include "ToolChains/Minix.h"
32 #include "ToolChains/MipsLinux.h"
33 #include "ToolChains/MSVC.h"
34 #include "ToolChains/Myriad.h"
35 #include "ToolChains/NaCl.h"
36 #include "ToolChains/NetBSD.h"
37 #include "ToolChains/OpenBSD.h"
38 #include "ToolChains/PS4CPU.h"
39 #include "ToolChains/Solaris.h"
40 #include "ToolChains/TCE.h"
41 #include "ToolChains/WebAssembly.h"
42 #include "ToolChains/XCore.h"
43 #include "clang/Basic/Version.h"
44 #include "clang/Basic/VirtualFileSystem.h"
45 #include "clang/Config/config.h"
46 #include "clang/Driver/Action.h"
47 #include "clang/Driver/Compilation.h"
48 #include "clang/Driver/DriverDiagnostic.h"
49 #include "clang/Driver/Job.h"
50 #include "clang/Driver/Options.h"
51 #include "clang/Driver/SanitizerArgs.h"
52 #include "clang/Driver/Tool.h"
53 #include "clang/Driver/ToolChain.h"
54 #include "llvm/ADT/ArrayRef.h"
55 #include "llvm/ADT/STLExtras.h"
56 #include "llvm/ADT/SmallSet.h"
57 #include "llvm/ADT/StringExtras.h"
58 #include "llvm/ADT/StringSet.h"
59 #include "llvm/ADT/StringSwitch.h"
60 #include "llvm/Option/Arg.h"
61 #include "llvm/Option/ArgList.h"
62 #include "llvm/Option/OptSpecifier.h"
63 #include "llvm/Option/OptTable.h"
64 #include "llvm/Option/Option.h"
65 #include "llvm/Support/ErrorHandling.h"
66 #include "llvm/Support/FileSystem.h"
67 #include "llvm/Support/Path.h"
68 #include "llvm/Support/PrettyStackTrace.h"
69 #include "llvm/Support/Process.h"
70 #include "llvm/Support/Program.h"
71 #include "llvm/Support/TargetRegistry.h"
72 #include "llvm/Support/raw_ostream.h"
73 #include <map>
74 #include <memory>
75 #include <utility>
76 #if LLVM_ON_UNIX
77 #include <unistd.h> // getpid
78 #endif
79 
80 using namespace clang::driver;
81 using namespace clang;
82 using namespace llvm::opt;
83 
84 Driver::Driver(StringRef ClangExecutable, StringRef DefaultTargetTriple,
85                DiagnosticsEngine &Diags,
86                IntrusiveRefCntPtr<vfs::FileSystem> VFS)
87     : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
88       Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
89       LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
90       SysRoot(DEFAULT_SYSROOT),
91       DriverTitle("clang LLVM compiler"), CCPrintOptionsFilename(nullptr),
92       CCPrintHeadersFilename(nullptr), CCLogDiagnosticsFilename(nullptr),
93       CCCPrintBindings(false), CCPrintHeaders(false), CCLogDiagnostics(false),
94       CCGenDiagnostics(false), DefaultTargetTriple(DefaultTargetTriple),
95       CCCGenericGCCName(""), CheckInputsExist(true), CCCUsePCH(true),
96       GenReproducer(false), SuppressMissingInputWarning(false) {
97 
98   // Provide a sane fallback if no VFS is specified.
99   if (!this->VFS)
100     this->VFS = vfs::getRealFileSystem();
101 
102   Name = llvm::sys::path::filename(ClangExecutable);
103   Dir = llvm::sys::path::parent_path(ClangExecutable);
104   InstalledDir = Dir; // Provide a sensible default installed dir.
105 
106   // Compute the path to the resource directory.
107   StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
108   SmallString<128> P(Dir);
109   if (ClangResourceDir != "") {
110     llvm::sys::path::append(P, ClangResourceDir);
111   } else {
112     StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
113     P = llvm::sys::path::parent_path(Dir);
114     llvm::sys::path::append(P, Twine("lib") + ClangLibdirSuffix, "clang",
115                             CLANG_VERSION_STRING);
116   }
117   ResourceDir = P.str();
118 }
119 
120 void Driver::ParseDriverMode(StringRef ProgramName,
121                              ArrayRef<const char *> Args) {
122   auto Default = ToolChain::getTargetAndModeFromProgramName(ProgramName);
123   StringRef DefaultMode(Default.second);
124   setDriverModeFromOption(DefaultMode);
125 
126   for (const char *ArgPtr : Args) {
127     // Ingore nullptrs, they are response file's EOL markers
128     if (ArgPtr == nullptr)
129       continue;
130     const StringRef Arg = ArgPtr;
131     setDriverModeFromOption(Arg);
132   }
133 }
134 
135 void Driver::setDriverModeFromOption(StringRef Opt) {
136   const std::string OptName =
137       getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
138   if (!Opt.startswith(OptName))
139     return;
140   StringRef Value = Opt.drop_front(OptName.size());
141 
142   const unsigned M = llvm::StringSwitch<unsigned>(Value)
143                          .Case("gcc", GCCMode)
144                          .Case("g++", GXXMode)
145                          .Case("cpp", CPPMode)
146                          .Case("cl", CLMode)
147                          .Default(~0U);
148 
149   if (M != ~0U)
150     Mode = static_cast<DriverMode>(M);
151   else
152     Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
153 }
154 
155 InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings,
156                                      bool &ContainsError) {
157   llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
158   ContainsError = false;
159 
160   unsigned IncludedFlagsBitmask;
161   unsigned ExcludedFlagsBitmask;
162   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
163       getIncludeExcludeOptionFlagMasks();
164 
165   unsigned MissingArgIndex, MissingArgCount;
166   InputArgList Args =
167       getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
168                           IncludedFlagsBitmask, ExcludedFlagsBitmask);
169 
170   // Check for missing argument error.
171   if (MissingArgCount) {
172     Diag(diag::err_drv_missing_argument)
173         << Args.getArgString(MissingArgIndex) << MissingArgCount;
174     ContainsError |=
175         Diags.getDiagnosticLevel(diag::err_drv_missing_argument,
176                                  SourceLocation()) > DiagnosticsEngine::Warning;
177   }
178 
179   // Check for unsupported options.
180   for (const Arg *A : Args) {
181     if (A->getOption().hasFlag(options::Unsupported)) {
182       Diag(diag::err_drv_unsupported_opt) << A->getAsString(Args);
183       ContainsError |= Diags.getDiagnosticLevel(diag::err_drv_unsupported_opt,
184                                                 SourceLocation()) >
185                        DiagnosticsEngine::Warning;
186       continue;
187     }
188 
189     // Warn about -mcpu= without an argument.
190     if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
191       Diag(diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
192       ContainsError |= Diags.getDiagnosticLevel(
193                            diag::warn_drv_empty_joined_argument,
194                            SourceLocation()) > DiagnosticsEngine::Warning;
195     }
196   }
197 
198   for (const Arg *A : Args.filtered(options::OPT_UNKNOWN)) {
199     auto ID = IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl
200                          : diag::err_drv_unknown_argument;
201 
202     Diags.Report(ID) << A->getAsString(Args);
203     ContainsError |= Diags.getDiagnosticLevel(ID, SourceLocation()) >
204                      DiagnosticsEngine::Warning;
205   }
206 
207   return Args;
208 }
209 
210 // Determine which compilation mode we are in. We look for options which
211 // affect the phase, starting with the earliest phases, and record which
212 // option we used to determine the final phase.
213 phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
214                                  Arg **FinalPhaseArg) const {
215   Arg *PhaseArg = nullptr;
216   phases::ID FinalPhase;
217 
218   // -{E,EP,P,M,MM} only run the preprocessor.
219   if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
220       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
221       (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
222       (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
223     FinalPhase = phases::Preprocess;
224 
225     // --precompile only runs up to precompilation.
226   } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
227     FinalPhase = phases::Precompile;
228 
229     // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
230   } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
231              (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
232              (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
233              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
234              (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
235              (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
236              (PhaseArg = DAL.getLastArg(options::OPT__analyze,
237                                         options::OPT__analyze_auto)) ||
238              (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
239     FinalPhase = phases::Compile;
240 
241     // -S only runs up to the backend.
242   } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
243     FinalPhase = phases::Backend;
244 
245     // -c compilation only runs up to the assembler.
246   } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
247     FinalPhase = phases::Assemble;
248 
249     // Otherwise do everything.
250   } else
251     FinalPhase = phases::Link;
252 
253   if (FinalPhaseArg)
254     *FinalPhaseArg = PhaseArg;
255 
256   return FinalPhase;
257 }
258 
259 static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
260                          StringRef Value) {
261   Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
262                    Args.getBaseArgs().MakeIndex(Value), Value.data());
263   Args.AddSynthesizedArg(A);
264   A->claim();
265   return A;
266 }
267 
268 DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
269   DerivedArgList *DAL = new DerivedArgList(Args);
270 
271   bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
272   bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
273   for (Arg *A : Args) {
274     // Unfortunately, we have to parse some forwarding options (-Xassembler,
275     // -Xlinker, -Xpreprocessor) because we either integrate their functionality
276     // (assembler and preprocessor), or bypass a previous driver ('collect2').
277 
278     // Rewrite linker options, to replace --no-demangle with a custom internal
279     // option.
280     if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
281          A->getOption().matches(options::OPT_Xlinker)) &&
282         A->containsValue("--no-demangle")) {
283       // Add the rewritten no-demangle argument.
284       DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
285 
286       // Add the remaining values as Xlinker arguments.
287       for (StringRef Val : A->getValues())
288         if (Val != "--no-demangle")
289           DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
290 
291       continue;
292     }
293 
294     // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
295     // some build systems. We don't try to be complete here because we don't
296     // care to encourage this usage model.
297     if (A->getOption().matches(options::OPT_Wp_COMMA) &&
298         (A->getValue(0) == StringRef("-MD") ||
299          A->getValue(0) == StringRef("-MMD"))) {
300       // Rewrite to -MD/-MMD along with -MF.
301       if (A->getValue(0) == StringRef("-MD"))
302         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
303       else
304         DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
305       if (A->getNumValues() == 2)
306         DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
307                             A->getValue(1));
308       continue;
309     }
310 
311     // Rewrite reserved library names.
312     if (A->getOption().matches(options::OPT_l)) {
313       StringRef Value = A->getValue();
314 
315       // Rewrite unless -nostdlib is present.
316       if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
317         DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
318         continue;
319       }
320 
321       // Rewrite unconditionally.
322       if (Value == "cc_kext") {
323         DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
324         continue;
325       }
326     }
327 
328     // Pick up inputs via the -- option.
329     if (A->getOption().matches(options::OPT__DASH_DASH)) {
330       A->claim();
331       for (StringRef Val : A->getValues())
332         DAL->append(MakeInputArg(*DAL, *Opts, Val));
333       continue;
334     }
335 
336     DAL->append(A);
337   }
338 
339   // Enforce -static if -miamcu is present.
340   if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
341     DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
342 
343 // Add a default value of -mlinker-version=, if one was given and the user
344 // didn't specify one.
345 #if defined(HOST_LINK_VERSION)
346   if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
347       strlen(HOST_LINK_VERSION) > 0) {
348     DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
349                       HOST_LINK_VERSION);
350     DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
351   }
352 #endif
353 
354   return DAL;
355 }
356 
357 /// \brief Compute target triple from args.
358 ///
359 /// This routine provides the logic to compute a target triple from various
360 /// args passed to the driver and the default triple string.
361 static llvm::Triple computeTargetTriple(const Driver &D,
362                                         StringRef DefaultTargetTriple,
363                                         const ArgList &Args,
364                                         StringRef DarwinArchName = "") {
365   // FIXME: Already done in Compilation *Driver::BuildCompilation
366   if (const Arg *A = Args.getLastArg(options::OPT_target))
367     DefaultTargetTriple = A->getValue();
368 
369   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
370 
371   // Handle Apple-specific options available here.
372   if (Target.isOSBinFormatMachO()) {
373     // If an explict Darwin arch name is given, that trumps all.
374     if (!DarwinArchName.empty()) {
375       tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
376       return Target;
377     }
378 
379     // Handle the Darwin '-arch' flag.
380     if (Arg *A = Args.getLastArg(options::OPT_arch)) {
381       StringRef ArchName = A->getValue();
382       tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
383     }
384   }
385 
386   // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
387   // '-mbig-endian'/'-EB'.
388   if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
389                                options::OPT_mbig_endian)) {
390     if (A->getOption().matches(options::OPT_mlittle_endian)) {
391       llvm::Triple LE = Target.getLittleEndianArchVariant();
392       if (LE.getArch() != llvm::Triple::UnknownArch)
393         Target = std::move(LE);
394     } else {
395       llvm::Triple BE = Target.getBigEndianArchVariant();
396       if (BE.getArch() != llvm::Triple::UnknownArch)
397         Target = std::move(BE);
398     }
399   }
400 
401   // Skip further flag support on OSes which don't support '-m32' or '-m64'.
402   if (Target.getArch() == llvm::Triple::tce ||
403       Target.getOS() == llvm::Triple::Minix)
404     return Target;
405 
406   // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
407   Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
408                            options::OPT_m32, options::OPT_m16);
409   if (A) {
410     llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
411 
412     if (A->getOption().matches(options::OPT_m64)) {
413       AT = Target.get64BitArchVariant().getArch();
414       if (Target.getEnvironment() == llvm::Triple::GNUX32)
415         Target.setEnvironment(llvm::Triple::GNU);
416     } else if (A->getOption().matches(options::OPT_mx32) &&
417                Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
418       AT = llvm::Triple::x86_64;
419       Target.setEnvironment(llvm::Triple::GNUX32);
420     } else if (A->getOption().matches(options::OPT_m32)) {
421       AT = Target.get32BitArchVariant().getArch();
422       if (Target.getEnvironment() == llvm::Triple::GNUX32)
423         Target.setEnvironment(llvm::Triple::GNU);
424     } else if (A->getOption().matches(options::OPT_m16) &&
425                Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
426       AT = llvm::Triple::x86;
427       Target.setEnvironment(llvm::Triple::CODE16);
428     }
429 
430     if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
431       Target.setArch(AT);
432   }
433 
434   // Handle -miamcu flag.
435   if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
436     if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
437       D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
438                                                        << Target.str();
439 
440     if (A && !A->getOption().matches(options::OPT_m32))
441       D.Diag(diag::err_drv_argument_not_allowed_with)
442           << "-miamcu" << A->getBaseArg().getAsString(Args);
443 
444     Target.setArch(llvm::Triple::x86);
445     Target.setArchName("i586");
446     Target.setEnvironment(llvm::Triple::UnknownEnvironment);
447     Target.setEnvironmentName("");
448     Target.setOS(llvm::Triple::ELFIAMCU);
449     Target.setVendor(llvm::Triple::UnknownVendor);
450     Target.setVendorName("intel");
451   }
452 
453   return Target;
454 }
455 
456 // \brief Parse the LTO options and record the type of LTO compilation
457 // based on which -f(no-)?lto(=.*)? option occurs last.
458 void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
459   LTOMode = LTOK_None;
460   if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
461                     options::OPT_fno_lto, false))
462     return;
463 
464   StringRef LTOName("full");
465 
466   const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
467   if (A)
468     LTOName = A->getValue();
469 
470   LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
471                 .Case("full", LTOK_Full)
472                 .Case("thin", LTOK_Thin)
473                 .Default(LTOK_Unknown);
474 
475   if (LTOMode == LTOK_Unknown) {
476     assert(A);
477     Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
478                                                     << A->getValue();
479   }
480 }
481 
482 /// Compute the desired OpenMP runtime from the flags provided.
483 Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
484   StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
485 
486   const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
487   if (A)
488     RuntimeName = A->getValue();
489 
490   auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
491                 .Case("libomp", OMPRT_OMP)
492                 .Case("libgomp", OMPRT_GOMP)
493                 .Case("libiomp5", OMPRT_IOMP5)
494                 .Default(OMPRT_Unknown);
495 
496   if (RT == OMPRT_Unknown) {
497     if (A)
498       Diag(diag::err_drv_unsupported_option_argument)
499           << A->getOption().getName() << A->getValue();
500     else
501       // FIXME: We could use a nicer diagnostic here.
502       Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
503   }
504 
505   return RT;
506 }
507 
508 void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
509                                               InputList &Inputs) {
510 
511   //
512   // CUDA
513   //
514   // We need to generate a CUDA toolchain if any of the inputs has a CUDA type.
515   if (llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
516         return types::isCuda(I.first);
517       })) {
518     const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
519     const llvm::Triple &HostTriple = HostTC->getTriple();
520     llvm::Triple CudaTriple(HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda"
521                                                      : "nvptx-nvidia-cuda");
522     // Use the CUDA and host triples as the key into the ToolChains map, because
523     // the device toolchain we create depends on both.
524     auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
525     if (!CudaTC) {
526       CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
527           *this, CudaTriple, *HostTC, C.getInputArgs());
528     }
529     C.addOffloadDeviceToolChain(CudaTC.get(), Action::OFK_Cuda);
530   }
531 
532   //
533   // OpenMP
534   //
535   // We need to generate an OpenMP toolchain if the user specified targets with
536   // the -fopenmp-targets option.
537   if (Arg *OpenMPTargets =
538           C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
539     if (OpenMPTargets->getNumValues()) {
540       // We expect that -fopenmp-targets is always used in conjunction with the
541       // option -fopenmp specifying a valid runtime with offloading support,
542       // i.e. libomp or libiomp.
543       bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
544           options::OPT_fopenmp, options::OPT_fopenmp_EQ,
545           options::OPT_fno_openmp, false);
546       if (HasValidOpenMPRuntime) {
547         OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
548         HasValidOpenMPRuntime =
549             OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
550       }
551 
552       if (HasValidOpenMPRuntime) {
553         llvm::StringMap<const char *> FoundNormalizedTriples;
554         for (const char *Val : OpenMPTargets->getValues()) {
555           llvm::Triple TT(Val);
556           std::string NormalizedName = TT.normalize();
557 
558           // Make sure we don't have a duplicate triple.
559           auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
560           if (Duplicate != FoundNormalizedTriples.end()) {
561             Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
562                 << Val << Duplicate->second;
563             continue;
564           }
565 
566           // Store the current triple so that we can check for duplicates in the
567           // following iterations.
568           FoundNormalizedTriples[NormalizedName] = Val;
569 
570           // If the specified target is invalid, emit a diagnostic.
571           if (TT.getArch() == llvm::Triple::UnknownArch)
572             Diag(clang::diag::err_drv_invalid_omp_target) << Val;
573           else {
574             const ToolChain *TC;
575             // CUDA toolchains have to be selected differently. They pair host
576             // and device in their implementation.
577             if (TT.isNVPTX()) {
578               const ToolChain *HostTC =
579                   C.getSingleOffloadToolChain<Action::OFK_Host>();
580               assert(HostTC && "Host toolchain should be always defined.");
581               auto &CudaTC =
582                   ToolChains[TT.str() + "/" + HostTC->getTriple().str()];
583               if (!CudaTC)
584                 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
585                     *this, TT, *HostTC, C.getInputArgs());
586               TC = CudaTC.get();
587             } else
588               TC = &getToolChain(C.getInputArgs(), TT);
589             C.addOffloadDeviceToolChain(TC, Action::OFK_OpenMP);
590           }
591         }
592       } else
593         Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
594     } else
595       Diag(clang::diag::warn_drv_empty_joined_argument)
596           << OpenMPTargets->getAsString(C.getInputArgs());
597   }
598 
599   //
600   // TODO: Add support for other offloading programming models here.
601   //
602 
603   return;
604 }
605 
606 Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
607   llvm::PrettyStackTraceString CrashInfo("Compilation construction");
608 
609   // FIXME: Handle environment options which affect driver behavior, somewhere
610   // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
611 
612   if (Optional<std::string> CompilerPathValue =
613           llvm::sys::Process::GetEnv("COMPILER_PATH")) {
614     StringRef CompilerPath = *CompilerPathValue;
615     while (!CompilerPath.empty()) {
616       std::pair<StringRef, StringRef> Split =
617           CompilerPath.split(llvm::sys::EnvPathSeparator);
618       PrefixDirs.push_back(Split.first);
619       CompilerPath = Split.second;
620     }
621   }
622 
623   // We look for the driver mode option early, because the mode can affect
624   // how other options are parsed.
625   ParseDriverMode(ClangExecutable, ArgList.slice(1));
626 
627   // FIXME: What are we going to do with -V and -b?
628 
629   // FIXME: This stuff needs to go into the Compilation, not the driver.
630   bool CCCPrintPhases;
631 
632   bool ContainsError;
633   InputArgList Args = ParseArgStrings(ArgList.slice(1), ContainsError);
634 
635   // Silence driver warnings if requested
636   Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
637 
638   // -no-canonical-prefixes is used very early in main.
639   Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
640 
641   // Ignore -pipe.
642   Args.ClaimAllArgs(options::OPT_pipe);
643 
644   // Extract -ccc args.
645   //
646   // FIXME: We need to figure out where this behavior should live. Most of it
647   // should be outside in the client; the parts that aren't should have proper
648   // options, either by introducing new ones or by overloading gcc ones like -V
649   // or -b.
650   CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
651   CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
652   if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
653     CCCGenericGCCName = A->getValue();
654   CCCUsePCH =
655       Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
656   GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
657                                options::OPT_fno_crash_diagnostics,
658                                !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
659   // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld
660   // and getToolChain is const.
661   if (IsCLMode()) {
662     // clang-cl targets MSVC-style Win32.
663     llvm::Triple T(DefaultTargetTriple);
664     T.setOS(llvm::Triple::Win32);
665     T.setVendor(llvm::Triple::PC);
666     T.setEnvironment(llvm::Triple::MSVC);
667     DefaultTargetTriple = T.str();
668   }
669   if (const Arg *A = Args.getLastArg(options::OPT_target))
670     DefaultTargetTriple = A->getValue();
671   if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
672     Dir = InstalledDir = A->getValue();
673   for (const Arg *A : Args.filtered(options::OPT_B)) {
674     A->claim();
675     PrefixDirs.push_back(A->getValue(0));
676   }
677   if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
678     SysRoot = A->getValue();
679   if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
680     DyldPrefix = A->getValue();
681 
682   if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
683     ResourceDir = A->getValue();
684 
685   if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
686     SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
687                     .Case("cwd", SaveTempsCwd)
688                     .Case("obj", SaveTempsObj)
689                     .Default(SaveTempsCwd);
690   }
691 
692   setLTOMode(Args);
693 
694   // Process -fembed-bitcode= flags.
695   if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
696     StringRef Name = A->getValue();
697     unsigned Model = llvm::StringSwitch<unsigned>(Name)
698         .Case("off", EmbedNone)
699         .Case("all", EmbedBitcode)
700         .Case("bitcode", EmbedBitcode)
701         .Case("marker", EmbedMarker)
702         .Default(~0U);
703     if (Model == ~0U) {
704       Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
705                                                 << Name;
706     } else
707       BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
708   }
709 
710   std::unique_ptr<llvm::opt::InputArgList> UArgs =
711       llvm::make_unique<InputArgList>(std::move(Args));
712 
713   // Perform the default argument translations.
714   DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
715 
716   // Owned by the host.
717   const ToolChain &TC = getToolChain(
718       *UArgs, computeTargetTriple(*this, DefaultTargetTriple, *UArgs));
719 
720   // The compilation takes ownership of Args.
721   Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs,
722                                    ContainsError);
723 
724   if (!HandleImmediateArgs(*C))
725     return C;
726 
727   // Construct the list of inputs.
728   InputList Inputs;
729   BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
730 
731   // Populate the tool chains for the offloading devices, if any.
732   CreateOffloadingDeviceToolChains(*C, Inputs);
733 
734   // Construct the list of abstract actions to perform for this compilation. On
735   // MachO targets this uses the driver-driver and universal actions.
736   if (TC.getTriple().isOSBinFormatMachO())
737     BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
738   else
739     BuildActions(*C, C->getArgs(), Inputs, C->getActions());
740 
741   if (CCCPrintPhases) {
742     PrintActions(*C);
743     return C;
744   }
745 
746   BuildJobs(*C);
747 
748   return C;
749 }
750 
751 static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
752   llvm::opt::ArgStringList ASL;
753   for (const auto *A : Args)
754     A->render(Args, ASL);
755 
756   for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
757     if (I != ASL.begin())
758       OS << ' ';
759     Command::printArg(OS, *I, true);
760   }
761   OS << '\n';
762 }
763 
764 bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
765                                     SmallString<128> &CrashDiagDir) {
766   using namespace llvm::sys;
767   assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
768          "Only knows about .crash files on Darwin");
769 
770   // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
771   // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
772   // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
773   path::home_directory(CrashDiagDir);
774   if (CrashDiagDir.startswith("/var/root"))
775     CrashDiagDir = "/";
776   path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
777   int PID =
778 #if LLVM_ON_UNIX
779       getpid();
780 #else
781       0;
782 #endif
783   std::error_code EC;
784   fs::file_status FileStatus;
785   TimePoint<> LastAccessTime;
786   SmallString<128> CrashFilePath;
787   // Lookup the .crash files and get the one generated by a subprocess spawned
788   // by this driver invocation.
789   for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
790        File != FileEnd && !EC; File.increment(EC)) {
791     StringRef FileName = path::filename(File->path());
792     if (!FileName.startswith(Name))
793       continue;
794     if (fs::status(File->path(), FileStatus))
795       continue;
796     llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
797         llvm::MemoryBuffer::getFile(File->path());
798     if (!CrashFile)
799       continue;
800     // The first line should start with "Process:", otherwise this isn't a real
801     // .crash file.
802     StringRef Data = CrashFile.get()->getBuffer();
803     if (!Data.startswith("Process:"))
804       continue;
805     // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
806     size_t ParentProcPos = Data.find("Parent Process:");
807     if (ParentProcPos == StringRef::npos)
808       continue;
809     size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
810     if (LineEnd == StringRef::npos)
811       continue;
812     StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
813     int OpenBracket = -1, CloseBracket = -1;
814     for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
815       if (ParentProcess[i] == '[')
816         OpenBracket = i;
817       if (ParentProcess[i] == ']')
818         CloseBracket = i;
819     }
820     // Extract the parent process PID from the .crash file and check whether
821     // it matches this driver invocation pid.
822     int CrashPID;
823     if (OpenBracket < 0 || CloseBracket < 0 ||
824         ParentProcess.slice(OpenBracket + 1, CloseBracket)
825             .getAsInteger(10, CrashPID) || CrashPID != PID) {
826       continue;
827     }
828 
829     // Found a .crash file matching the driver pid. To avoid getting an older
830     // and misleading crash file, continue looking for the most recent.
831     // FIXME: the driver can dispatch multiple cc1 invocations, leading to
832     // multiple crashes poiting to the same parent process. Since the driver
833     // does not collect pid information for the dispatched invocation there's
834     // currently no way to distinguish among them.
835     const auto FileAccessTime = FileStatus.getLastModificationTime();
836     if (FileAccessTime > LastAccessTime) {
837       CrashFilePath.assign(File->path());
838       LastAccessTime = FileAccessTime;
839     }
840   }
841 
842   // If found, copy it over to the location of other reproducer files.
843   if (!CrashFilePath.empty()) {
844     EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
845     if (EC)
846       return false;
847     return true;
848   }
849 
850   return false;
851 }
852 
853 // When clang crashes, produce diagnostic information including the fully
854 // preprocessed source file(s).  Request that the developer attach the
855 // diagnostic information to a bug report.
856 void Driver::generateCompilationDiagnostics(Compilation &C,
857                                             const Command &FailingCommand) {
858   if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
859     return;
860 
861   // Don't try to generate diagnostics for link or dsymutil jobs.
862   if (FailingCommand.getCreator().isLinkJob() ||
863       FailingCommand.getCreator().isDsymutilJob())
864     return;
865 
866   // Print the version of the compiler.
867   PrintVersion(C, llvm::errs());
868 
869   Diag(clang::diag::note_drv_command_failed_diag_msg)
870       << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
871          "crash backtrace, preprocessed source, and associated run script.";
872 
873   // Suppress driver output and emit preprocessor output to temp file.
874   Mode = CPPMode;
875   CCGenDiagnostics = true;
876 
877   // Save the original job command(s).
878   Command Cmd = FailingCommand;
879 
880   // Keep track of whether we produce any errors while trying to produce
881   // preprocessed sources.
882   DiagnosticErrorTrap Trap(Diags);
883 
884   // Suppress tool output.
885   C.initCompilationForDiagnostics();
886 
887   // Construct the list of inputs.
888   InputList Inputs;
889   BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
890 
891   for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
892     bool IgnoreInput = false;
893 
894     // Ignore input from stdin or any inputs that cannot be preprocessed.
895     // Check type first as not all linker inputs have a value.
896     if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
897       IgnoreInput = true;
898     } else if (!strcmp(it->second->getValue(), "-")) {
899       Diag(clang::diag::note_drv_command_failed_diag_msg)
900           << "Error generating preprocessed source(s) - "
901              "ignoring input from stdin.";
902       IgnoreInput = true;
903     }
904 
905     if (IgnoreInput) {
906       it = Inputs.erase(it);
907       ie = Inputs.end();
908     } else {
909       ++it;
910     }
911   }
912 
913   if (Inputs.empty()) {
914     Diag(clang::diag::note_drv_command_failed_diag_msg)
915         << "Error generating preprocessed source(s) - "
916            "no preprocessable inputs.";
917     return;
918   }
919 
920   // Don't attempt to generate preprocessed files if multiple -arch options are
921   // used, unless they're all duplicates.
922   llvm::StringSet<> ArchNames;
923   for (const Arg *A : C.getArgs()) {
924     if (A->getOption().matches(options::OPT_arch)) {
925       StringRef ArchName = A->getValue();
926       ArchNames.insert(ArchName);
927     }
928   }
929   if (ArchNames.size() > 1) {
930     Diag(clang::diag::note_drv_command_failed_diag_msg)
931         << "Error generating preprocessed source(s) - cannot generate "
932            "preprocessed source with multiple -arch options.";
933     return;
934   }
935 
936   // Construct the list of abstract actions to perform for this compilation. On
937   // Darwin OSes this uses the driver-driver and builds universal actions.
938   const ToolChain &TC = C.getDefaultToolChain();
939   if (TC.getTriple().isOSBinFormatMachO())
940     BuildUniversalActions(C, TC, Inputs);
941   else
942     BuildActions(C, C.getArgs(), Inputs, C.getActions());
943 
944   BuildJobs(C);
945 
946   // If there were errors building the compilation, quit now.
947   if (Trap.hasErrorOccurred()) {
948     Diag(clang::diag::note_drv_command_failed_diag_msg)
949         << "Error generating preprocessed source(s).";
950     return;
951   }
952 
953   // Generate preprocessed output.
954   SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
955   C.ExecuteJobs(C.getJobs(), FailingCommands);
956 
957   // If any of the preprocessing commands failed, clean up and exit.
958   if (!FailingCommands.empty()) {
959     if (!isSaveTempsEnabled())
960       C.CleanupFileList(C.getTempFiles(), true);
961 
962     Diag(clang::diag::note_drv_command_failed_diag_msg)
963         << "Error generating preprocessed source(s).";
964     return;
965   }
966 
967   const ArgStringList &TempFiles = C.getTempFiles();
968   if (TempFiles.empty()) {
969     Diag(clang::diag::note_drv_command_failed_diag_msg)
970         << "Error generating preprocessed source(s).";
971     return;
972   }
973 
974   Diag(clang::diag::note_drv_command_failed_diag_msg)
975       << "\n********************\n\n"
976          "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
977          "Preprocessed source(s) and associated run script(s) are located at:";
978 
979   SmallString<128> VFS;
980   SmallString<128> ReproCrashFilename;
981   for (const char *TempFile : TempFiles) {
982     Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
983     if (ReproCrashFilename.empty()) {
984       ReproCrashFilename = TempFile;
985       llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
986     }
987     if (StringRef(TempFile).endswith(".cache")) {
988       // In some cases (modules) we'll dump extra data to help with reproducing
989       // the crash into a directory next to the output.
990       VFS = llvm::sys::path::filename(TempFile);
991       llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
992     }
993   }
994 
995   // Assume associated files are based off of the first temporary file.
996   CrashReportInfo CrashInfo(TempFiles[0], VFS);
997 
998   std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh";
999   std::error_code EC;
1000   llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
1001   if (EC) {
1002     Diag(clang::diag::note_drv_command_failed_diag_msg)
1003         << "Error generating run script: " + Script + " " + EC.message();
1004   } else {
1005     ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
1006              << "# Driver args: ";
1007     printArgList(ScriptOS, C.getInputArgs());
1008     ScriptOS << "# Original command: ";
1009     Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
1010     Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
1011     Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
1012   }
1013 
1014   // On darwin, provide information about the .crash diagnostic report.
1015   if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
1016     SmallString<128> CrashDiagDir;
1017     if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
1018       Diag(clang::diag::note_drv_command_failed_diag_msg)
1019           << ReproCrashFilename.str();
1020     } else { // Suggest a directory for the user to look for .crash files.
1021       llvm::sys::path::append(CrashDiagDir, Name);
1022       CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
1023       Diag(clang::diag::note_drv_command_failed_diag_msg)
1024           << "Crash backtrace is located in";
1025       Diag(clang::diag::note_drv_command_failed_diag_msg)
1026           << CrashDiagDir.str();
1027       Diag(clang::diag::note_drv_command_failed_diag_msg)
1028           << "(choose the .crash file that corresponds to your crash)";
1029     }
1030   }
1031 
1032   for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1033                                             options::OPT_frewrite_map_file_EQ))
1034     Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1035 
1036   Diag(clang::diag::note_drv_command_failed_diag_msg)
1037       << "\n\n********************";
1038 }
1039 
1040 void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
1041   // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
1042   // if the tool does not support response files, there is a chance/ that things
1043   // will just work without a response file, so we silently just skip it.
1044   if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
1045       llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
1046     return;
1047 
1048   std::string TmpName = GetTemporaryPath("response", "txt");
1049   Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
1050 }
1051 
1052 int Driver::ExecuteCompilation(
1053     Compilation &C,
1054     SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
1055   // Just print if -### was present.
1056   if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
1057     C.getJobs().Print(llvm::errs(), "\n", true);
1058     return 0;
1059   }
1060 
1061   // If there were errors building the compilation, quit now.
1062   if (Diags.hasErrorOccurred())
1063     return 1;
1064 
1065   // Set up response file names for each command, if necessary
1066   for (auto &Job : C.getJobs())
1067     setUpResponseFiles(C, Job);
1068 
1069   C.ExecuteJobs(C.getJobs(), FailingCommands);
1070 
1071   // Remove temp files.
1072   C.CleanupFileList(C.getTempFiles());
1073 
1074   // If the command succeeded, we are done.
1075   if (FailingCommands.empty())
1076     return 0;
1077 
1078   // Otherwise, remove result files and print extra information about abnormal
1079   // failures.
1080   for (const auto &CmdPair : FailingCommands) {
1081     int Res = CmdPair.first;
1082     const Command *FailingCommand = CmdPair.second;
1083 
1084     // Remove result files if we're not saving temps.
1085     if (!isSaveTempsEnabled()) {
1086       const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1087       C.CleanupFileMap(C.getResultFiles(), JA, true);
1088 
1089       // Failure result files are valid unless we crashed.
1090       if (Res < 0)
1091         C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1092     }
1093 
1094     // Print extra information about abnormal failures, if possible.
1095     //
1096     // This is ad-hoc, but we don't want to be excessively noisy. If the result
1097     // status was 1, assume the command failed normally. In particular, if it
1098     // was the compiler then assume it gave a reasonable error code. Failures
1099     // in other tools are less common, and they generally have worse
1100     // diagnostics, so always print the diagnostic there.
1101     const Tool &FailingTool = FailingCommand->getCreator();
1102 
1103     if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
1104       // FIXME: See FIXME above regarding result code interpretation.
1105       if (Res < 0)
1106         Diag(clang::diag::err_drv_command_signalled)
1107             << FailingTool.getShortName();
1108       else
1109         Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
1110                                                   << Res;
1111     }
1112   }
1113   return 0;
1114 }
1115 
1116 void Driver::PrintHelp(bool ShowHidden) const {
1117   unsigned IncludedFlagsBitmask;
1118   unsigned ExcludedFlagsBitmask;
1119   std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
1120       getIncludeExcludeOptionFlagMasks();
1121 
1122   ExcludedFlagsBitmask |= options::NoDriverOption;
1123   if (!ShowHidden)
1124     ExcludedFlagsBitmask |= HelpHidden;
1125 
1126   getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
1127                       IncludedFlagsBitmask, ExcludedFlagsBitmask,
1128                       /*ShowAllAliases=*/false);
1129 }
1130 
1131 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
1132   // FIXME: The following handlers should use a callback mechanism, we don't
1133   // know what the client would like to do.
1134   OS << getClangFullVersion() << '\n';
1135   const ToolChain &TC = C.getDefaultToolChain();
1136   OS << "Target: " << TC.getTripleString() << '\n';
1137 
1138   // Print the threading model.
1139   if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1140     // Don't print if the ToolChain would have barfed on it already
1141     if (TC.isThreadModelSupported(A->getValue()))
1142       OS << "Thread model: " << A->getValue();
1143   } else
1144     OS << "Thread model: " << TC.getThreadModel();
1145   OS << '\n';
1146 
1147   // Print out the install directory.
1148   OS << "InstalledDir: " << InstalledDir << '\n';
1149 }
1150 
1151 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1152 /// option.
1153 static void PrintDiagnosticCategories(raw_ostream &OS) {
1154   // Skip the empty category.
1155   for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1156        ++i)
1157     OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
1158 }
1159 
1160 bool Driver::HandleImmediateArgs(const Compilation &C) {
1161   // The order these options are handled in gcc is all over the place, but we
1162   // don't expect inconsistencies w.r.t. that to matter in practice.
1163 
1164   if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1165     llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1166     return false;
1167   }
1168 
1169   if (C.getArgs().hasArg(options::OPT_dumpversion)) {
1170     // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1171     // return an answer which matches our definition of __VERSION__.
1172     //
1173     // If we want to return a more correct answer some day, then we should
1174     // introduce a non-pedantically GCC compatible mode to Clang in which we
1175     // provide sensible definitions for -dumpversion, __VERSION__, etc.
1176     llvm::outs() << "4.2.1\n";
1177     return false;
1178   }
1179 
1180   if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1181     PrintDiagnosticCategories(llvm::outs());
1182     return false;
1183   }
1184 
1185   if (C.getArgs().hasArg(options::OPT_help) ||
1186       C.getArgs().hasArg(options::OPT__help_hidden)) {
1187     PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
1188     return false;
1189   }
1190 
1191   if (C.getArgs().hasArg(options::OPT__version)) {
1192     // Follow gcc behavior and use stdout for --version and stderr for -v.
1193     PrintVersion(C, llvm::outs());
1194 
1195     // Print registered targets.
1196     llvm::outs() << '\n';
1197     llvm::TargetRegistry::printRegisteredTargetsForVersion(llvm::outs());
1198     return false;
1199   }
1200 
1201   if (C.getArgs().hasArg(options::OPT_v) ||
1202       C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
1203     PrintVersion(C, llvm::errs());
1204     SuppressMissingInputWarning = true;
1205   }
1206 
1207   const ToolChain &TC = C.getDefaultToolChain();
1208 
1209   if (C.getArgs().hasArg(options::OPT_v))
1210     TC.printVerboseInfo(llvm::errs());
1211 
1212   if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
1213     llvm::outs() << ResourceDir << '\n';
1214     return false;
1215   }
1216 
1217   if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1218     llvm::outs() << "programs: =";
1219     bool separator = false;
1220     for (const std::string &Path : TC.getProgramPaths()) {
1221       if (separator)
1222         llvm::outs() << ':';
1223       llvm::outs() << Path;
1224       separator = true;
1225     }
1226     llvm::outs() << "\n";
1227     llvm::outs() << "libraries: =" << ResourceDir;
1228 
1229     StringRef sysroot = C.getSysRoot();
1230 
1231     for (const std::string &Path : TC.getFilePaths()) {
1232       // Always print a separator. ResourceDir was the first item shown.
1233       llvm::outs() << ':';
1234       // Interpretation of leading '=' is needed only for NetBSD.
1235       if (Path[0] == '=')
1236         llvm::outs() << sysroot << Path.substr(1);
1237       else
1238         llvm::outs() << Path;
1239     }
1240     llvm::outs() << "\n";
1241     return false;
1242   }
1243 
1244   // FIXME: The following handlers should use a callback mechanism, we don't
1245   // know what the client would like to do.
1246   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
1247     llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
1248     return false;
1249   }
1250 
1251   if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
1252     llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
1253     return false;
1254   }
1255 
1256   if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
1257     // Print out all options that start with a given argument. This is used for
1258     // shell autocompletion.
1259     StringRef PassedFlags = A->getValue();
1260     std::vector<std::string> SuggestedCompletions;
1261 
1262     unsigned short DisableFlags = options::NoDriverOption | options::Unsupported | options::Ignored;
1263     // We want to show cc1-only options only when clang is invoked as "clang -cc1".
1264     // When clang is invoked as "clang -cc1", we add "#" to the beginning of an --autocomplete
1265     // option so that the clang driver can distinguish whether it is requested to show cc1-only options or not.
1266     if (PassedFlags[0] == '#') {
1267       DisableFlags &= ~options::NoDriverOption;
1268       PassedFlags = PassedFlags.substr(1);
1269     }
1270 
1271     if (PassedFlags.find(',') == StringRef::npos) {
1272       // If the flag is in the form of "--autocomplete=-foo",
1273       // we were requested to print out all option names that start with "-foo".
1274       // For example, "--autocomplete=-fsyn" is expanded to "-fsyntax-only".
1275       SuggestedCompletions = Opts->findByPrefix(PassedFlags, DisableFlags);
1276 
1277       // We have to query the -W flags manually as they're not in the OptTable.
1278       // TODO: Find a good way to add them to OptTable instead and them remove
1279       // this code.
1280       for (StringRef S : DiagnosticIDs::getDiagnosticFlags())
1281         if (S.startswith(PassedFlags))
1282           SuggestedCompletions.push_back(S);
1283     } else {
1284       // If the flag is in the form of "--autocomplete=foo,bar", we were
1285       // requested to print out all option values for "-foo" that start with
1286       // "bar". For example,
1287       // "--autocomplete=-stdlib=,l" is expanded to "libc++" and "libstdc++".
1288       StringRef Option, Arg;
1289       std::tie(Option, Arg) = PassedFlags.split(',');
1290       SuggestedCompletions = Opts->suggestValueCompletions(Option, Arg);
1291     }
1292 
1293     // Sort the autocomplete candidates so that shells print them out in a
1294     // deterministic order. We could sort in any way, but we chose
1295     // case-insensitive sorting for consistency with the -help option
1296     // which prints out options in the case-insensitive alphabetical order.
1297     std::sort(SuggestedCompletions.begin(), SuggestedCompletions.end(),
1298               [](StringRef A, StringRef B) { return A.compare_lower(B) < 0; });
1299 
1300     llvm::outs() << llvm::join(SuggestedCompletions, "\n") << '\n';
1301     return false;
1302   }
1303 
1304   if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
1305     ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
1306     switch (RLT) {
1307     case ToolChain::RLT_CompilerRT:
1308       llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1309       break;
1310     case ToolChain::RLT_Libgcc:
1311       llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1312       break;
1313     }
1314     return false;
1315   }
1316 
1317   if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
1318     for (const Multilib &Multilib : TC.getMultilibs())
1319       llvm::outs() << Multilib << "\n";
1320     return false;
1321   }
1322 
1323   if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
1324     for (const Multilib &Multilib : TC.getMultilibs()) {
1325       if (Multilib.gccSuffix().empty())
1326         llvm::outs() << ".\n";
1327       else {
1328         StringRef Suffix(Multilib.gccSuffix());
1329         assert(Suffix.front() == '/');
1330         llvm::outs() << Suffix.substr(1) << "\n";
1331       }
1332     }
1333     return false;
1334   }
1335   return true;
1336 }
1337 
1338 // Display an action graph human-readably.  Action A is the "sink" node
1339 // and latest-occuring action. Traversal is in pre-order, visiting the
1340 // inputs to each action before printing the action itself.
1341 static unsigned PrintActions1(const Compilation &C, Action *A,
1342                               std::map<Action *, unsigned> &Ids) {
1343   if (Ids.count(A)) // A was already visited.
1344     return Ids[A];
1345 
1346   std::string str;
1347   llvm::raw_string_ostream os(str);
1348 
1349   os << Action::getClassName(A->getKind()) << ", ";
1350   if (InputAction *IA = dyn_cast<InputAction>(A)) {
1351     os << "\"" << IA->getInputArg().getValue() << "\"";
1352   } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
1353     os << '"' << BIA->getArchName() << '"' << ", {"
1354        << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
1355   } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1356     bool IsFirst = true;
1357     OA->doOnEachDependence(
1358         [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1359           // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1360           // sm_35 this will generate:
1361           // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1362           // (nvptx64-nvidia-cuda:sm_35) {#ID}
1363           if (!IsFirst)
1364             os << ", ";
1365           os << '"';
1366           if (TC)
1367             os << A->getOffloadingKindPrefix();
1368           else
1369             os << "host";
1370           os << " (";
1371           os << TC->getTriple().normalize();
1372 
1373           if (BoundArch)
1374             os << ":" << BoundArch;
1375           os << ")";
1376           os << '"';
1377           os << " {" << PrintActions1(C, A, Ids) << "}";
1378           IsFirst = false;
1379         });
1380   } else {
1381     const ActionList *AL = &A->getInputs();
1382 
1383     if (AL->size()) {
1384       const char *Prefix = "{";
1385       for (Action *PreRequisite : *AL) {
1386         os << Prefix << PrintActions1(C, PreRequisite, Ids);
1387         Prefix = ", ";
1388       }
1389       os << "}";
1390     } else
1391       os << "{}";
1392   }
1393 
1394   // Append offload info for all options other than the offloading action
1395   // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1396   std::string offload_str;
1397   llvm::raw_string_ostream offload_os(offload_str);
1398   if (!isa<OffloadAction>(A)) {
1399     auto S = A->getOffloadingKindPrefix();
1400     if (!S.empty()) {
1401       offload_os << ", (" << S;
1402       if (A->getOffloadingArch())
1403         offload_os << ", " << A->getOffloadingArch();
1404       offload_os << ")";
1405     }
1406   }
1407 
1408   unsigned Id = Ids.size();
1409   Ids[A] = Id;
1410   llvm::errs() << Id << ": " << os.str() << ", "
1411                << types::getTypeName(A->getType()) << offload_os.str() << "\n";
1412 
1413   return Id;
1414 }
1415 
1416 // Print the action graphs in a compilation C.
1417 // For example "clang -c file1.c file2.c" is composed of two subgraphs.
1418 void Driver::PrintActions(const Compilation &C) const {
1419   std::map<Action *, unsigned> Ids;
1420   for (Action *A : C.getActions())
1421     PrintActions1(C, A, Ids);
1422 }
1423 
1424 /// \brief Check whether the given input tree contains any compilation or
1425 /// assembly actions.
1426 static bool ContainsCompileOrAssembleAction(const Action *A) {
1427   if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
1428       isa<AssembleJobAction>(A))
1429     return true;
1430 
1431   for (const Action *Input : A->inputs())
1432     if (ContainsCompileOrAssembleAction(Input))
1433       return true;
1434 
1435   return false;
1436 }
1437 
1438 void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1439                                    const InputList &BAInputs) const {
1440   DerivedArgList &Args = C.getArgs();
1441   ActionList &Actions = C.getActions();
1442   llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1443   // Collect the list of architectures. Duplicates are allowed, but should only
1444   // be handled once (in the order seen).
1445   llvm::StringSet<> ArchNames;
1446   SmallVector<const char *, 4> Archs;
1447   for (Arg *A : Args) {
1448     if (A->getOption().matches(options::OPT_arch)) {
1449       // Validate the option here; we don't save the type here because its
1450       // particular spelling may participate in other driver choices.
1451       llvm::Triple::ArchType Arch =
1452           tools::darwin::getArchTypeForMachOArchName(A->getValue());
1453       if (Arch == llvm::Triple::UnknownArch) {
1454         Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
1455         continue;
1456       }
1457 
1458       A->claim();
1459       if (ArchNames.insert(A->getValue()).second)
1460         Archs.push_back(A->getValue());
1461     }
1462   }
1463 
1464   // When there is no explicit arch for this platform, make sure we still bind
1465   // the architecture (to the default) so that -Xarch_ is handled correctly.
1466   if (!Archs.size())
1467     Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
1468 
1469   ActionList SingleActions;
1470   BuildActions(C, Args, BAInputs, SingleActions);
1471 
1472   // Add in arch bindings for every top level action, as well as lipo and
1473   // dsymutil steps if needed.
1474   for (Action* Act : SingleActions) {
1475     // Make sure we can lipo this kind of output. If not (and it is an actual
1476     // output) then we disallow, since we can't create an output file with the
1477     // right name without overwriting it. We could remove this oddity by just
1478     // changing the output names to include the arch, which would also fix
1479     // -save-temps. Compatibility wins for now.
1480 
1481     if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
1482       Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
1483           << types::getTypeName(Act->getType());
1484 
1485     ActionList Inputs;
1486     for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1487       Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
1488 
1489     // Lipo if necessary, we do it this way because we need to set the arch flag
1490     // so that -Xarch_ gets overwritten.
1491     if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1492       Actions.append(Inputs.begin(), Inputs.end());
1493     else
1494       Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
1495 
1496     // Handle debug info queries.
1497     Arg *A = Args.getLastArg(options::OPT_g_Group);
1498     if (A && !A->getOption().matches(options::OPT_g0) &&
1499         !A->getOption().matches(options::OPT_gstabs) &&
1500         ContainsCompileOrAssembleAction(Actions.back())) {
1501 
1502       // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1503       // have a compile input. We need to run 'dsymutil' ourselves in such cases
1504       // because the debug info will refer to a temporary object file which
1505       // will be removed at the end of the compilation process.
1506       if (Act->getType() == types::TY_Image) {
1507         ActionList Inputs;
1508         Inputs.push_back(Actions.back());
1509         Actions.pop_back();
1510         Actions.push_back(
1511             C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
1512       }
1513 
1514       // Verify the debug info output.
1515       if (Args.hasArg(options::OPT_verify_debug_info)) {
1516         Action* LastAction = Actions.back();
1517         Actions.pop_back();
1518         Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1519             LastAction, types::TY_Nothing));
1520       }
1521     }
1522   }
1523 }
1524 
1525 /// \brief Check that the file referenced by Value exists. If it doesn't,
1526 /// issue a diagnostic and return false.
1527 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
1528                                    StringRef Value, types::ID Ty) {
1529   if (!D.getCheckInputsExist())
1530     return true;
1531 
1532   // stdin always exists.
1533   if (Value == "-")
1534     return true;
1535 
1536   SmallString<64> Path(Value);
1537   if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
1538     if (!llvm::sys::path::is_absolute(Path)) {
1539       SmallString<64> Directory(WorkDir->getValue());
1540       llvm::sys::path::append(Directory, Value);
1541       Path.assign(Directory);
1542     }
1543   }
1544 
1545   if (llvm::sys::fs::exists(Twine(Path)))
1546     return true;
1547 
1548   if (D.IsCLMode()) {
1549     if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1550         llvm::sys::Process::FindInEnvPath("LIB", Value))
1551       return true;
1552 
1553     if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1554       // Arguments to the /link flag might cause the linker to search for object
1555       // and library files in paths we don't know about. Don't error in such
1556       // cases.
1557       return true;
1558     }
1559   }
1560 
1561   D.Diag(clang::diag::err_drv_no_such_file) << Path;
1562   return false;
1563 }
1564 
1565 // Construct a the list of inputs and their types.
1566 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
1567                          InputList &Inputs) const {
1568   // Track the current user specified (-x) input. We also explicitly track the
1569   // argument used to set the type; we only want to claim the type when we
1570   // actually use it, so we warn about unused -x arguments.
1571   types::ID InputType = types::TY_Nothing;
1572   Arg *InputTypeArg = nullptr;
1573 
1574   // The last /TC or /TP option sets the input type to C or C++ globally.
1575   if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1576                                          options::OPT__SLASH_TP)) {
1577     InputTypeArg = TCTP;
1578     InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
1579                     ? types::TY_C
1580                     : types::TY_CXX;
1581 
1582     Arg *Previous = nullptr;
1583     bool ShowNote = false;
1584     for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
1585       if (Previous) {
1586         Diag(clang::diag::warn_drv_overriding_flag_option)
1587           << Previous->getSpelling() << A->getSpelling();
1588         ShowNote = true;
1589       }
1590       Previous = A;
1591     }
1592     if (ShowNote)
1593       Diag(clang::diag::note_drv_t_option_is_global);
1594 
1595     // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1596     assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1597   }
1598 
1599   for (Arg *A : Args) {
1600     if (A->getOption().getKind() == Option::InputClass) {
1601       const char *Value = A->getValue();
1602       types::ID Ty = types::TY_INVALID;
1603 
1604       // Infer the input type if necessary.
1605       if (InputType == types::TY_Nothing) {
1606         // If there was an explicit arg for this, claim it.
1607         if (InputTypeArg)
1608           InputTypeArg->claim();
1609 
1610         // stdin must be handled specially.
1611         if (memcmp(Value, "-", 2) == 0) {
1612           // If running with -E, treat as a C input (this changes the builtin
1613           // macros, for example). This may be overridden by -ObjC below.
1614           //
1615           // Otherwise emit an error but still use a valid type to avoid
1616           // spurious errors (e.g., no inputs).
1617           if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
1618             Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1619                             : clang::diag::err_drv_unknown_stdin_type);
1620           Ty = types::TY_C;
1621         } else {
1622           // Otherwise lookup by extension.
1623           // Fallback is C if invoked as C preprocessor or Object otherwise.
1624           // We use a host hook here because Darwin at least has its own
1625           // idea of what .s is.
1626           if (const char *Ext = strrchr(Value, '.'))
1627             Ty = TC.LookupTypeForExtension(Ext + 1);
1628 
1629           if (Ty == types::TY_INVALID) {
1630             if (CCCIsCPP())
1631               Ty = types::TY_C;
1632             else
1633               Ty = types::TY_Object;
1634           }
1635 
1636           // If the driver is invoked as C++ compiler (like clang++ or c++) it
1637           // should autodetect some input files as C++ for g++ compatibility.
1638           if (CCCIsCXX()) {
1639             types::ID OldTy = Ty;
1640             Ty = types::lookupCXXTypeForCType(Ty);
1641 
1642             if (Ty != OldTy)
1643               Diag(clang::diag::warn_drv_treating_input_as_cxx)
1644                   << getTypeName(OldTy) << getTypeName(Ty);
1645           }
1646         }
1647 
1648         // -ObjC and -ObjC++ override the default language, but only for "source
1649         // files". We just treat everything that isn't a linker input as a
1650         // source file.
1651         //
1652         // FIXME: Clean this up if we move the phase sequence into the type.
1653         if (Ty != types::TY_Object) {
1654           if (Args.hasArg(options::OPT_ObjC))
1655             Ty = types::TY_ObjC;
1656           else if (Args.hasArg(options::OPT_ObjCXX))
1657             Ty = types::TY_ObjCXX;
1658         }
1659       } else {
1660         assert(InputTypeArg && "InputType set w/o InputTypeArg");
1661         if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1662           // If emulating cl.exe, make sure that /TC and /TP don't affect input
1663           // object files.
1664           const char *Ext = strrchr(Value, '.');
1665           if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1666             Ty = types::TY_Object;
1667         }
1668         if (Ty == types::TY_INVALID) {
1669           Ty = InputType;
1670           InputTypeArg->claim();
1671         }
1672       }
1673 
1674       if (DiagnoseInputExistence(*this, Args, Value, Ty))
1675         Inputs.push_back(std::make_pair(Ty, A));
1676 
1677     } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1678       StringRef Value = A->getValue();
1679       if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
1680         Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
1681         Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1682       }
1683       A->claim();
1684     } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1685       StringRef Value = A->getValue();
1686       if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
1687         Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
1688         Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1689       }
1690       A->claim();
1691     } else if (A->getOption().hasFlag(options::LinkerInput)) {
1692       // Just treat as object type, we could make a special type for this if
1693       // necessary.
1694       Inputs.push_back(std::make_pair(types::TY_Object, A));
1695 
1696     } else if (A->getOption().matches(options::OPT_x)) {
1697       InputTypeArg = A;
1698       InputType = types::lookupTypeForTypeSpecifier(A->getValue());
1699       A->claim();
1700 
1701       // Follow gcc behavior and treat as linker input for invalid -x
1702       // options. Its not clear why we shouldn't just revert to unknown; but
1703       // this isn't very important, we might as well be bug compatible.
1704       if (!InputType) {
1705         Diag(clang::diag::err_drv_unknown_language) << A->getValue();
1706         InputType = types::TY_Object;
1707       }
1708     } else if (A->getOption().getID() == options::OPT__SLASH_U) {
1709       assert(A->getNumValues() == 1 && "The /U option has one value.");
1710       StringRef Val = A->getValue(0);
1711       if (Val.find_first_of("/\\") != StringRef::npos) {
1712         // Warn about e.g. "/Users/me/myfile.c".
1713         Diag(diag::warn_slash_u_filename) << Val;
1714         Diag(diag::note_use_dashdash);
1715       }
1716     }
1717   }
1718   if (CCCIsCPP() && Inputs.empty()) {
1719     // If called as standalone preprocessor, stdin is processed
1720     // if no other input is present.
1721     Arg *A = MakeInputArg(Args, *Opts, "-");
1722     Inputs.push_back(std::make_pair(types::TY_C, A));
1723   }
1724 }
1725 
1726 namespace {
1727 /// Provides a convenient interface for different programming models to generate
1728 /// the required device actions.
1729 class OffloadingActionBuilder final {
1730   /// Flag used to trace errors in the builder.
1731   bool IsValid = false;
1732 
1733   /// The compilation that is using this builder.
1734   Compilation &C;
1735 
1736   /// Map between an input argument and the offload kinds used to process it.
1737   std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
1738 
1739   /// Builder interface. It doesn't build anything or keep any state.
1740   class DeviceActionBuilder {
1741   public:
1742     typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
1743 
1744     enum ActionBuilderReturnCode {
1745       // The builder acted successfully on the current action.
1746       ABRT_Success,
1747       // The builder didn't have to act on the current action.
1748       ABRT_Inactive,
1749       // The builder was successful and requested the host action to not be
1750       // generated.
1751       ABRT_Ignore_Host,
1752     };
1753 
1754   protected:
1755     /// Compilation associated with this builder.
1756     Compilation &C;
1757 
1758     /// Tool chains associated with this builder. The same programming
1759     /// model may have associated one or more tool chains.
1760     SmallVector<const ToolChain *, 2> ToolChains;
1761 
1762     /// The derived arguments associated with this builder.
1763     DerivedArgList &Args;
1764 
1765     /// The inputs associated with this builder.
1766     const Driver::InputList &Inputs;
1767 
1768     /// The associated offload kind.
1769     Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
1770 
1771   public:
1772     DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
1773                         const Driver::InputList &Inputs,
1774                         Action::OffloadKind AssociatedOffloadKind)
1775         : C(C), Args(Args), Inputs(Inputs),
1776           AssociatedOffloadKind(AssociatedOffloadKind) {}
1777     virtual ~DeviceActionBuilder() {}
1778 
1779     /// Fill up the array \a DA with all the device dependences that should be
1780     /// added to the provided host action \a HostAction. By default it is
1781     /// inactive.
1782     virtual ActionBuilderReturnCode
1783     getDeviceDependences(OffloadAction::DeviceDependences &DA,
1784                          phases::ID CurPhase, phases::ID FinalPhase,
1785                          PhasesTy &Phases) {
1786       return ABRT_Inactive;
1787     }
1788 
1789     /// Update the state to include the provided host action \a HostAction as a
1790     /// dependency of the current device action. By default it is inactive.
1791     virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
1792       return ABRT_Inactive;
1793     }
1794 
1795     /// Append top level actions generated by the builder. Return true if errors
1796     /// were found.
1797     virtual void appendTopLevelActions(ActionList &AL) {}
1798 
1799     /// Append linker actions generated by the builder. Return true if errors
1800     /// were found.
1801     virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
1802 
1803     /// Initialize the builder. Return true if any initialization errors are
1804     /// found.
1805     virtual bool initialize() { return false; }
1806 
1807     /// Return true if the builder can use bundling/unbundling.
1808     virtual bool canUseBundlerUnbundler() const { return false; }
1809 
1810     /// Return true if this builder is valid. We have a valid builder if we have
1811     /// associated device tool chains.
1812     bool isValid() { return !ToolChains.empty(); }
1813 
1814     /// Return the associated offload kind.
1815     Action::OffloadKind getAssociatedOffloadKind() {
1816       return AssociatedOffloadKind;
1817     }
1818   };
1819 
1820   /// \brief CUDA action builder. It injects device code in the host backend
1821   /// action.
1822   class CudaActionBuilder final : public DeviceActionBuilder {
1823     /// Flags to signal if the user requested host-only or device-only
1824     /// compilation.
1825     bool CompileHostOnly = false;
1826     bool CompileDeviceOnly = false;
1827 
1828     /// List of GPU architectures to use in this compilation.
1829     SmallVector<CudaArch, 4> GpuArchList;
1830 
1831     /// The CUDA actions for the current input.
1832     ActionList CudaDeviceActions;
1833 
1834     /// The CUDA fat binary if it was generated for the current input.
1835     Action *CudaFatBinary = nullptr;
1836 
1837     /// Flag that is set to true if this builder acted on the current input.
1838     bool IsActive = false;
1839 
1840   public:
1841     CudaActionBuilder(Compilation &C, DerivedArgList &Args,
1842                       const Driver::InputList &Inputs)
1843         : DeviceActionBuilder(C, Args, Inputs, Action::OFK_Cuda) {}
1844 
1845     ActionBuilderReturnCode
1846     getDeviceDependences(OffloadAction::DeviceDependences &DA,
1847                          phases::ID CurPhase, phases::ID FinalPhase,
1848                          PhasesTy &Phases) override {
1849       if (!IsActive)
1850         return ABRT_Inactive;
1851 
1852       // If we don't have more CUDA actions, we don't have any dependences to
1853       // create for the host.
1854       if (CudaDeviceActions.empty())
1855         return ABRT_Success;
1856 
1857       assert(CudaDeviceActions.size() == GpuArchList.size() &&
1858              "Expecting one action per GPU architecture.");
1859       assert(!CompileHostOnly &&
1860              "Not expecting CUDA actions in host-only compilation.");
1861 
1862       // If we are generating code for the device or we are in a backend phase,
1863       // we attempt to generate the fat binary. We compile each arch to ptx and
1864       // assemble to cubin, then feed the cubin *and* the ptx into a device
1865       // "link" action, which uses fatbinary to combine these cubins into one
1866       // fatbin.  The fatbin is then an input to the host action if not in
1867       // device-only mode.
1868       if (CompileDeviceOnly || CurPhase == phases::Backend) {
1869         ActionList DeviceActions;
1870         for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
1871           // Produce the device action from the current phase up to the assemble
1872           // phase.
1873           for (auto Ph : Phases) {
1874             // Skip the phases that were already dealt with.
1875             if (Ph < CurPhase)
1876               continue;
1877             // We have to be consistent with the host final phase.
1878             if (Ph > FinalPhase)
1879               break;
1880 
1881             CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
1882                 C, Args, Ph, CudaDeviceActions[I]);
1883 
1884             if (Ph == phases::Assemble)
1885               break;
1886           }
1887 
1888           // If we didn't reach the assemble phase, we can't generate the fat
1889           // binary. We don't need to generate the fat binary if we are not in
1890           // device-only mode.
1891           if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
1892               CompileDeviceOnly)
1893             continue;
1894 
1895           Action *AssembleAction = CudaDeviceActions[I];
1896           assert(AssembleAction->getType() == types::TY_Object);
1897           assert(AssembleAction->getInputs().size() == 1);
1898 
1899           Action *BackendAction = AssembleAction->getInputs()[0];
1900           assert(BackendAction->getType() == types::TY_PP_Asm);
1901 
1902           for (auto &A : {AssembleAction, BackendAction}) {
1903             OffloadAction::DeviceDependences DDep;
1904             DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
1905                      Action::OFK_Cuda);
1906             DeviceActions.push_back(
1907                 C.MakeAction<OffloadAction>(DDep, A->getType()));
1908           }
1909         }
1910 
1911         // We generate the fat binary if we have device input actions.
1912         if (!DeviceActions.empty()) {
1913           CudaFatBinary =
1914               C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
1915 
1916           if (!CompileDeviceOnly) {
1917             DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
1918                    Action::OFK_Cuda);
1919             // Clear the fat binary, it is already a dependence to an host
1920             // action.
1921             CudaFatBinary = nullptr;
1922           }
1923 
1924           // Remove the CUDA actions as they are already connected to an host
1925           // action or fat binary.
1926           CudaDeviceActions.clear();
1927         }
1928 
1929         // We avoid creating host action in device-only mode.
1930         return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
1931       } else if (CurPhase > phases::Backend) {
1932         // If we are past the backend phase and still have a device action, we
1933         // don't have to do anything as this action is already a device
1934         // top-level action.
1935         return ABRT_Success;
1936       }
1937 
1938       assert(CurPhase < phases::Backend && "Generating single CUDA "
1939                                            "instructions should only occur "
1940                                            "before the backend phase!");
1941 
1942       // By default, we produce an action for each device arch.
1943       for (Action *&A : CudaDeviceActions)
1944         A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
1945 
1946       return ABRT_Success;
1947     }
1948 
1949     ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
1950       // While generating code for CUDA, we only depend on the host input action
1951       // to trigger the creation of all the CUDA device actions.
1952 
1953       // If we are dealing with an input action, replicate it for each GPU
1954       // architecture. If we are in host-only mode we return 'success' so that
1955       // the host uses the CUDA offload kind.
1956       if (auto *IA = dyn_cast<InputAction>(HostAction)) {
1957         assert(!GpuArchList.empty() &&
1958                "We should have at least one GPU architecture.");
1959 
1960         // If the host input is not CUDA, we don't need to bother about this
1961         // input.
1962         if (IA->getType() != types::TY_CUDA) {
1963           // The builder will ignore this input.
1964           IsActive = false;
1965           return ABRT_Inactive;
1966         }
1967 
1968         // Set the flag to true, so that the builder acts on the current input.
1969         IsActive = true;
1970 
1971         if (CompileHostOnly)
1972           return ABRT_Success;
1973 
1974         // Replicate inputs for each GPU architecture.
1975         for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1976           CudaDeviceActions.push_back(C.MakeAction<InputAction>(
1977               IA->getInputArg(), types::TY_CUDA_DEVICE));
1978 
1979         return ABRT_Success;
1980       }
1981 
1982       return IsActive ? ABRT_Success : ABRT_Inactive;
1983     }
1984 
1985     void appendTopLevelActions(ActionList &AL) override {
1986       // Utility to append actions to the top level list.
1987       auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
1988         OffloadAction::DeviceDependences Dep;
1989         Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
1990                 Action::OFK_Cuda);
1991         AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
1992       };
1993 
1994       // If we have a fat binary, add it to the list.
1995       if (CudaFatBinary) {
1996         AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
1997         CudaDeviceActions.clear();
1998         CudaFatBinary = nullptr;
1999         return;
2000       }
2001 
2002       if (CudaDeviceActions.empty())
2003         return;
2004 
2005       // If we have CUDA actions at this point, that's because we have a have
2006       // partial compilation, so we should have an action for each GPU
2007       // architecture.
2008       assert(CudaDeviceActions.size() == GpuArchList.size() &&
2009              "Expecting one action per GPU architecture.");
2010       assert(ToolChains.size() == 1 &&
2011              "Expecting to have a sing CUDA toolchain.");
2012       for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
2013         AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
2014 
2015       CudaDeviceActions.clear();
2016     }
2017 
2018     bool initialize() override {
2019       // We don't need to support CUDA.
2020       if (!C.hasOffloadToolChain<Action::OFK_Cuda>())
2021         return false;
2022 
2023       const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
2024       assert(HostTC && "No toolchain for host compilation.");
2025       if (HostTC->getTriple().isNVPTX()) {
2026         // We do not support targeting NVPTX for host compilation. Throw
2027         // an error and abort pipeline construction early so we don't trip
2028         // asserts that assume device-side compilation.
2029         C.getDriver().Diag(diag::err_drv_cuda_nvptx_host);
2030         return true;
2031       }
2032 
2033       ToolChains.push_back(C.getSingleOffloadToolChain<Action::OFK_Cuda>());
2034 
2035       Arg *PartialCompilationArg = Args.getLastArg(
2036           options::OPT_cuda_host_only, options::OPT_cuda_device_only,
2037           options::OPT_cuda_compile_host_device);
2038       CompileHostOnly = PartialCompilationArg &&
2039                         PartialCompilationArg->getOption().matches(
2040                             options::OPT_cuda_host_only);
2041       CompileDeviceOnly = PartialCompilationArg &&
2042                           PartialCompilationArg->getOption().matches(
2043                               options::OPT_cuda_device_only);
2044 
2045       // Collect all cuda_gpu_arch parameters, removing duplicates.
2046       std::set<CudaArch> GpuArchs;
2047       bool Error = false;
2048       for (Arg *A : Args) {
2049         if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
2050               A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
2051           continue;
2052         A->claim();
2053 
2054         const StringRef ArchStr = A->getValue();
2055         if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
2056             ArchStr == "all") {
2057           GpuArchs.clear();
2058           continue;
2059         }
2060         CudaArch Arch = StringToCudaArch(ArchStr);
2061         if (Arch == CudaArch::UNKNOWN) {
2062           C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
2063           Error = true;
2064         } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
2065           GpuArchs.insert(Arch);
2066         else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
2067           GpuArchs.erase(Arch);
2068         else
2069           llvm_unreachable("Unexpected option.");
2070       }
2071 
2072       // Collect list of GPUs remaining in the set.
2073       for (CudaArch Arch : GpuArchs)
2074         GpuArchList.push_back(Arch);
2075 
2076       // Default to sm_20 which is the lowest common denominator for
2077       // supported GPUs.  sm_20 code should work correctly, if
2078       // suboptimally, on all newer GPUs.
2079       if (GpuArchList.empty())
2080         GpuArchList.push_back(CudaArch::SM_20);
2081 
2082       return Error;
2083     }
2084   };
2085 
2086   /// OpenMP action builder. The host bitcode is passed to the device frontend
2087   /// and all the device linked images are passed to the host link phase.
2088   class OpenMPActionBuilder final : public DeviceActionBuilder {
2089     /// The OpenMP actions for the current input.
2090     ActionList OpenMPDeviceActions;
2091 
2092     /// The linker inputs obtained for each toolchain.
2093     SmallVector<ActionList, 8> DeviceLinkerInputs;
2094 
2095   public:
2096     OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2097                         const Driver::InputList &Inputs)
2098         : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2099 
2100     ActionBuilderReturnCode
2101     getDeviceDependences(OffloadAction::DeviceDependences &DA,
2102                          phases::ID CurPhase, phases::ID FinalPhase,
2103                          PhasesTy &Phases) override {
2104 
2105       // We should always have an action for each input.
2106       assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2107              "Number of OpenMP actions and toolchains do not match.");
2108 
2109       // The host only depends on device action in the linking phase, when all
2110       // the device images have to be embedded in the host image.
2111       if (CurPhase == phases::Link) {
2112         assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2113                "Toolchains and linker inputs sizes do not match.");
2114         auto LI = DeviceLinkerInputs.begin();
2115         for (auto *A : OpenMPDeviceActions) {
2116           LI->push_back(A);
2117           ++LI;
2118         }
2119 
2120         // We passed the device action as a host dependence, so we don't need to
2121         // do anything else with them.
2122         OpenMPDeviceActions.clear();
2123         return ABRT_Success;
2124       }
2125 
2126       // By default, we produce an action for each device arch.
2127       for (Action *&A : OpenMPDeviceActions)
2128         A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2129 
2130       return ABRT_Success;
2131     }
2132 
2133     ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2134 
2135       // If this is an input action replicate it for each OpenMP toolchain.
2136       if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2137         OpenMPDeviceActions.clear();
2138         for (unsigned I = 0; I < ToolChains.size(); ++I)
2139           OpenMPDeviceActions.push_back(
2140               C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2141         return ABRT_Success;
2142       }
2143 
2144       // If this is an unbundling action use it as is for each OpenMP toolchain.
2145       if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2146         OpenMPDeviceActions.clear();
2147         for (unsigned I = 0; I < ToolChains.size(); ++I) {
2148           OpenMPDeviceActions.push_back(UA);
2149           UA->registerDependentActionInfo(
2150               ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2151         }
2152         return ABRT_Success;
2153       }
2154 
2155       // When generating code for OpenMP we use the host compile phase result as
2156       // a dependence to the device compile phase so that it can learn what
2157       // declarations should be emitted. However, this is not the only use for
2158       // the host action, so we prevent it from being collapsed.
2159       if (isa<CompileJobAction>(HostAction)) {
2160         HostAction->setCannotBeCollapsedWithNextDependentAction();
2161         assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2162                "Toolchains and device action sizes do not match.");
2163         OffloadAction::HostDependence HDep(
2164             *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2165             /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2166         auto TC = ToolChains.begin();
2167         for (Action *&A : OpenMPDeviceActions) {
2168           assert(isa<CompileJobAction>(A));
2169           OffloadAction::DeviceDependences DDep;
2170           DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2171           A = C.MakeAction<OffloadAction>(HDep, DDep);
2172           ++TC;
2173         }
2174       }
2175       return ABRT_Success;
2176     }
2177 
2178     void appendTopLevelActions(ActionList &AL) override {
2179       if (OpenMPDeviceActions.empty())
2180         return;
2181 
2182       // We should always have an action for each input.
2183       assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2184              "Number of OpenMP actions and toolchains do not match.");
2185 
2186       // Append all device actions followed by the proper offload action.
2187       auto TI = ToolChains.begin();
2188       for (auto *A : OpenMPDeviceActions) {
2189         OffloadAction::DeviceDependences Dep;
2190         Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2191         AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2192         ++TI;
2193       }
2194       // We no longer need the action stored in this builder.
2195       OpenMPDeviceActions.clear();
2196     }
2197 
2198     void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2199       assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2200              "Toolchains and linker inputs sizes do not match.");
2201 
2202       // Append a new link action for each device.
2203       auto TC = ToolChains.begin();
2204       for (auto &LI : DeviceLinkerInputs) {
2205         auto *DeviceLinkAction =
2206             C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2207         DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2208                Action::OFK_OpenMP);
2209         ++TC;
2210       }
2211     }
2212 
2213     bool initialize() override {
2214       // Get the OpenMP toolchains. If we don't get any, the action builder will
2215       // know there is nothing to do related to OpenMP offloading.
2216       auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2217       for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2218            ++TI)
2219         ToolChains.push_back(TI->second);
2220 
2221       DeviceLinkerInputs.resize(ToolChains.size());
2222       return false;
2223     }
2224 
2225     bool canUseBundlerUnbundler() const override {
2226       // OpenMP should use bundled files whenever possible.
2227       return true;
2228     }
2229   };
2230 
2231   ///
2232   /// TODO: Add the implementation for other specialized builders here.
2233   ///
2234 
2235   /// Specialized builders being used by this offloading action builder.
2236   SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2237 
2238   /// Flag set to true if all valid builders allow file bundling/unbundling.
2239   bool CanUseBundler;
2240 
2241 public:
2242   OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2243                           const Driver::InputList &Inputs)
2244       : C(C) {
2245     // Create a specialized builder for each device toolchain.
2246 
2247     IsValid = true;
2248 
2249     // Create a specialized builder for CUDA.
2250     SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2251 
2252     // Create a specialized builder for OpenMP.
2253     SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2254 
2255     //
2256     // TODO: Build other specialized builders here.
2257     //
2258 
2259     // Initialize all the builders, keeping track of errors. If all valid
2260     // builders agree that we can use bundling, set the flag to true.
2261     unsigned ValidBuilders = 0u;
2262     unsigned ValidBuildersSupportingBundling = 0u;
2263     for (auto *SB : SpecializedBuilders) {
2264       IsValid = IsValid && !SB->initialize();
2265 
2266       // Update the counters if the builder is valid.
2267       if (SB->isValid()) {
2268         ++ValidBuilders;
2269         if (SB->canUseBundlerUnbundler())
2270           ++ValidBuildersSupportingBundling;
2271       }
2272     }
2273     CanUseBundler =
2274         ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
2275   }
2276 
2277   ~OffloadingActionBuilder() {
2278     for (auto *SB : SpecializedBuilders)
2279       delete SB;
2280   }
2281 
2282   /// Generate an action that adds device dependences (if any) to a host action.
2283   /// If no device dependence actions exist, just return the host action \a
2284   /// HostAction. If an error is found or if no builder requires the host action
2285   /// to be generated, return nullptr.
2286   Action *
2287   addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2288                                    phases::ID CurPhase, phases::ID FinalPhase,
2289                                    DeviceActionBuilder::PhasesTy &Phases) {
2290     if (!IsValid)
2291       return nullptr;
2292 
2293     if (SpecializedBuilders.empty())
2294       return HostAction;
2295 
2296     assert(HostAction && "Invalid host action!");
2297 
2298     OffloadAction::DeviceDependences DDeps;
2299     // Check if all the programming models agree we should not emit the host
2300     // action. Also, keep track of the offloading kinds employed.
2301     auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2302     unsigned InactiveBuilders = 0u;
2303     unsigned IgnoringBuilders = 0u;
2304     for (auto *SB : SpecializedBuilders) {
2305       if (!SB->isValid()) {
2306         ++InactiveBuilders;
2307         continue;
2308       }
2309 
2310       auto RetCode =
2311           SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
2312 
2313       // If the builder explicitly says the host action should be ignored,
2314       // we need to increment the variable that tracks the builders that request
2315       // the host object to be ignored.
2316       if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2317         ++IgnoringBuilders;
2318 
2319       // Unless the builder was inactive for this action, we have to record the
2320       // offload kind because the host will have to use it.
2321       if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2322         OffloadKind |= SB->getAssociatedOffloadKind();
2323     }
2324 
2325     // If all builders agree that the host object should be ignored, just return
2326     // nullptr.
2327     if (IgnoringBuilders &&
2328         SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2329       return nullptr;
2330 
2331     if (DDeps.getActions().empty())
2332       return HostAction;
2333 
2334     // We have dependences we need to bundle together. We use an offload action
2335     // for that.
2336     OffloadAction::HostDependence HDep(
2337         *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2338         /*BoundArch=*/nullptr, DDeps);
2339     return C.MakeAction<OffloadAction>(HDep, DDeps);
2340   }
2341 
2342   /// Generate an action that adds a host dependence to a device action. The
2343   /// results will be kept in this action builder. Return true if an error was
2344   /// found.
2345   bool addHostDependenceToDeviceActions(Action *&HostAction,
2346                                         const Arg *InputArg) {
2347     if (!IsValid)
2348       return true;
2349 
2350     // If we are supporting bundling/unbundling and the current action is an
2351     // input action of non-source file, we replace the host action by the
2352     // unbundling action. The bundler tool has the logic to detect if an input
2353     // is a bundle or not and if the input is not a bundle it assumes it is a
2354     // host file. Therefore it is safe to create an unbundling action even if
2355     // the input is not a bundle.
2356     if (CanUseBundler && isa<InputAction>(HostAction) &&
2357         InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2358         !types::isSrcFile(HostAction->getType())) {
2359       auto UnbundlingHostAction =
2360           C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2361       UnbundlingHostAction->registerDependentActionInfo(
2362           C.getSingleOffloadToolChain<Action::OFK_Host>(),
2363           /*BoundArch=*/StringRef(), Action::OFK_Host);
2364       HostAction = UnbundlingHostAction;
2365     }
2366 
2367     assert(HostAction && "Invalid host action!");
2368 
2369     // Register the offload kinds that are used.
2370     auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2371     for (auto *SB : SpecializedBuilders) {
2372       if (!SB->isValid())
2373         continue;
2374 
2375       auto RetCode = SB->addDeviceDepences(HostAction);
2376 
2377       // Host dependences for device actions are not compatible with that same
2378       // action being ignored.
2379       assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2380              "Host dependence not expected to be ignored.!");
2381 
2382       // Unless the builder was inactive for this action, we have to record the
2383       // offload kind because the host will have to use it.
2384       if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2385         OffloadKind |= SB->getAssociatedOffloadKind();
2386     }
2387 
2388     return false;
2389   }
2390 
2391   /// Add the offloading top level actions to the provided action list. This
2392   /// function can replace the host action by a bundling action if the
2393   /// programming models allow it.
2394   bool appendTopLevelActions(ActionList &AL, Action *HostAction,
2395                              const Arg *InputArg) {
2396     // Get the device actions to be appended.
2397     ActionList OffloadAL;
2398     for (auto *SB : SpecializedBuilders) {
2399       if (!SB->isValid())
2400         continue;
2401       SB->appendTopLevelActions(OffloadAL);
2402     }
2403 
2404     // If we can use the bundler, replace the host action by the bundling one in
2405     // the resulting list. Otherwise, just append the device actions.
2406     if (CanUseBundler && !OffloadAL.empty()) {
2407       // Add the host action to the list in order to create the bundling action.
2408       OffloadAL.push_back(HostAction);
2409 
2410       // We expect that the host action was just appended to the action list
2411       // before this method was called.
2412       assert(HostAction == AL.back() && "Host action not in the list??");
2413       HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
2414       AL.back() = HostAction;
2415     } else
2416       AL.append(OffloadAL.begin(), OffloadAL.end());
2417 
2418     // Propagate to the current host action (if any) the offload information
2419     // associated with the current input.
2420     if (HostAction)
2421       HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
2422                                            /*BoundArch=*/nullptr);
2423     return false;
2424   }
2425 
2426   /// Processes the host linker action. This currently consists of replacing it
2427   /// with an offload action if there are device link objects and propagate to
2428   /// the host action all the offload kinds used in the current compilation. The
2429   /// resulting action is returned.
2430   Action *processHostLinkAction(Action *HostAction) {
2431     // Add all the dependences from the device linking actions.
2432     OffloadAction::DeviceDependences DDeps;
2433     for (auto *SB : SpecializedBuilders) {
2434       if (!SB->isValid())
2435         continue;
2436 
2437       SB->appendLinkDependences(DDeps);
2438     }
2439 
2440     // Calculate all the offload kinds used in the current compilation.
2441     unsigned ActiveOffloadKinds = 0u;
2442     for (auto &I : InputArgToOffloadKindMap)
2443       ActiveOffloadKinds |= I.second;
2444 
2445     // If we don't have device dependencies, we don't have to create an offload
2446     // action.
2447     if (DDeps.getActions().empty()) {
2448       // Propagate all the active kinds to host action. Given that it is a link
2449       // action it is assumed to depend on all actions generated so far.
2450       HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
2451                                            /*BoundArch=*/nullptr);
2452       return HostAction;
2453     }
2454 
2455     // Create the offload action with all dependences. When an offload action
2456     // is created the kinds are propagated to the host action, so we don't have
2457     // to do that explicitly here.
2458     OffloadAction::HostDependence HDep(
2459         *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2460         /*BoundArch*/ nullptr, ActiveOffloadKinds);
2461     return C.MakeAction<OffloadAction>(HDep, DDeps);
2462   }
2463 };
2464 } // anonymous namespace.
2465 
2466 void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
2467                           const InputList &Inputs, ActionList &Actions) const {
2468   llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
2469 
2470   if (!SuppressMissingInputWarning && Inputs.empty()) {
2471     Diag(clang::diag::err_drv_no_input_files);
2472     return;
2473   }
2474 
2475   Arg *FinalPhaseArg;
2476   phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
2477 
2478   if (FinalPhase == phases::Link) {
2479     if (Args.hasArg(options::OPT_emit_llvm))
2480       Diag(clang::diag::err_drv_emit_llvm_link);
2481     if (IsCLMode() && LTOMode != LTOK_None &&
2482         !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
2483       Diag(clang::diag::err_drv_lto_without_lld);
2484   }
2485 
2486   // Reject -Z* at the top level, these options should never have been exposed
2487   // by gcc.
2488   if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
2489     Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
2490 
2491   // Diagnose misuse of /Fo.
2492   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
2493     StringRef V = A->getValue();
2494     if (Inputs.size() > 1 && !V.empty() &&
2495         !llvm::sys::path::is_separator(V.back())) {
2496       // Check whether /Fo tries to name an output file for multiple inputs.
2497       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
2498           << A->getSpelling() << V;
2499       Args.eraseArg(options::OPT__SLASH_Fo);
2500     }
2501   }
2502 
2503   // Diagnose misuse of /Fa.
2504   if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
2505     StringRef V = A->getValue();
2506     if (Inputs.size() > 1 && !V.empty() &&
2507         !llvm::sys::path::is_separator(V.back())) {
2508       // Check whether /Fa tries to name an asm file for multiple inputs.
2509       Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
2510           << A->getSpelling() << V;
2511       Args.eraseArg(options::OPT__SLASH_Fa);
2512     }
2513   }
2514 
2515   // Diagnose misuse of /o.
2516   if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
2517     if (A->getValue()[0] == '\0') {
2518       // It has to have a value.
2519       Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
2520       Args.eraseArg(options::OPT__SLASH_o);
2521     }
2522   }
2523 
2524   // Diagnose unsupported forms of /Yc /Yu. Ignore /Yc/Yu for now if:
2525   // * no filename after it
2526   // * both /Yc and /Yu passed but with different filenames
2527   // * corresponding file not also passed as /FI
2528   Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
2529   Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
2530   if (YcArg && YcArg->getValue()[0] == '\0') {
2531     Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YcArg->getSpelling();
2532     Args.eraseArg(options::OPT__SLASH_Yc);
2533     YcArg = nullptr;
2534   }
2535   if (YuArg && YuArg->getValue()[0] == '\0') {
2536     Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YuArg->getSpelling();
2537     Args.eraseArg(options::OPT__SLASH_Yu);
2538     YuArg = nullptr;
2539   }
2540   if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
2541     Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
2542     Args.eraseArg(options::OPT__SLASH_Yc);
2543     Args.eraseArg(options::OPT__SLASH_Yu);
2544     YcArg = YuArg = nullptr;
2545   }
2546   if (YcArg || YuArg) {
2547     StringRef Val = YcArg ? YcArg->getValue() : YuArg->getValue();
2548     bool FoundMatchingInclude = false;
2549     for (const Arg *Inc : Args.filtered(options::OPT_include)) {
2550       // FIXME: Do case-insensitive matching and consider / and \ as equal.
2551       if (Inc->getValue() == Val)
2552         FoundMatchingInclude = true;
2553     }
2554     if (!FoundMatchingInclude) {
2555       Diag(clang::diag::warn_drv_ycyu_no_fi_arg_clang_cl)
2556           << (YcArg ? YcArg : YuArg)->getSpelling();
2557       Args.eraseArg(options::OPT__SLASH_Yc);
2558       Args.eraseArg(options::OPT__SLASH_Yu);
2559       YcArg = YuArg = nullptr;
2560     }
2561   }
2562   if (YcArg && Inputs.size() > 1) {
2563     Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
2564     Args.eraseArg(options::OPT__SLASH_Yc);
2565     YcArg = nullptr;
2566   }
2567   if (Args.hasArg(options::OPT__SLASH_Y_)) {
2568     // /Y- disables all pch handling.  Rather than check for it everywhere,
2569     // just remove clang-cl pch-related flags here.
2570     Args.eraseArg(options::OPT__SLASH_Fp);
2571     Args.eraseArg(options::OPT__SLASH_Yc);
2572     Args.eraseArg(options::OPT__SLASH_Yu);
2573     YcArg = YuArg = nullptr;
2574   }
2575 
2576   // Builder to be used to build offloading actions.
2577   OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
2578 
2579   // Construct the actions to perform.
2580   ActionList LinkerInputs;
2581 
2582   llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
2583   for (auto &I : Inputs) {
2584     types::ID InputType = I.first;
2585     const Arg *InputArg = I.second;
2586 
2587     PL.clear();
2588     types::getCompilationPhases(InputType, PL);
2589 
2590     // If the first step comes after the final phase we are doing as part of
2591     // this compilation, warn the user about it.
2592     phases::ID InitialPhase = PL[0];
2593     if (InitialPhase > FinalPhase) {
2594       // Claim here to avoid the more general unused warning.
2595       InputArg->claim();
2596 
2597       // Suppress all unused style warnings with -Qunused-arguments
2598       if (Args.hasArg(options::OPT_Qunused_arguments))
2599         continue;
2600 
2601       // Special case when final phase determined by binary name, rather than
2602       // by a command-line argument with a corresponding Arg.
2603       if (CCCIsCPP())
2604         Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
2605             << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
2606       // Special case '-E' warning on a previously preprocessed file to make
2607       // more sense.
2608       else if (InitialPhase == phases::Compile &&
2609                FinalPhase == phases::Preprocess &&
2610                getPreprocessedType(InputType) == types::TY_INVALID)
2611         Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
2612             << InputArg->getAsString(Args) << !!FinalPhaseArg
2613             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
2614       else
2615         Diag(clang::diag::warn_drv_input_file_unused)
2616             << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
2617             << !!FinalPhaseArg
2618             << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
2619       continue;
2620     }
2621 
2622     if (YcArg) {
2623       // Add a separate precompile phase for the compile phase.
2624       if (FinalPhase >= phases::Compile) {
2625         const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
2626         llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
2627         types::getCompilationPhases(HeaderType, PCHPL);
2628         Arg *PchInputArg = MakeInputArg(Args, *Opts, YcArg->getValue());
2629 
2630         // Build the pipeline for the pch file.
2631         Action *ClangClPch =
2632             C.MakeAction<InputAction>(*PchInputArg, HeaderType);
2633         for (phases::ID Phase : PCHPL)
2634           ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
2635         assert(ClangClPch);
2636         Actions.push_back(ClangClPch);
2637         // The driver currently exits after the first failed command.  This
2638         // relies on that behavior, to make sure if the pch generation fails,
2639         // the main compilation won't run.
2640       }
2641     }
2642 
2643     // Build the pipeline for this file.
2644     Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
2645 
2646     // Use the current host action in any of the offloading actions, if
2647     // required.
2648     if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2649       break;
2650 
2651     for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
2652          i != e; ++i) {
2653       phases::ID Phase = *i;
2654 
2655       // We are done if this step is past what the user requested.
2656       if (Phase > FinalPhase)
2657         break;
2658 
2659       // Add any offload action the host action depends on.
2660       Current = OffloadBuilder.addDeviceDependencesToHostAction(
2661           Current, InputArg, Phase, FinalPhase, PL);
2662       if (!Current)
2663         break;
2664 
2665       // Queue linker inputs.
2666       if (Phase == phases::Link) {
2667         assert((i + 1) == e && "linking must be final compilation step.");
2668         LinkerInputs.push_back(Current);
2669         Current = nullptr;
2670         break;
2671       }
2672 
2673       // Otherwise construct the appropriate action.
2674       auto *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
2675 
2676       // We didn't create a new action, so we will just move to the next phase.
2677       if (NewCurrent == Current)
2678         continue;
2679 
2680       Current = NewCurrent;
2681 
2682       // Use the current host action in any of the offloading actions, if
2683       // required.
2684       if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2685         break;
2686 
2687       if (Current->getType() == types::TY_Nothing)
2688         break;
2689     }
2690 
2691     // If we ended with something, add to the output list.
2692     if (Current)
2693       Actions.push_back(Current);
2694 
2695     // Add any top level actions generated for offloading.
2696     OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
2697   }
2698 
2699   // Add a link action if necessary.
2700   if (!LinkerInputs.empty()) {
2701     Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
2702     LA = OffloadBuilder.processHostLinkAction(LA);
2703     Actions.push_back(LA);
2704   }
2705 
2706   // If we are linking, claim any options which are obviously only used for
2707   // compilation.
2708   if (FinalPhase == phases::Link && PL.size() == 1) {
2709     Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
2710     Args.ClaimAllArgs(options::OPT_cl_compile_Group);
2711   }
2712 
2713   // Claim ignored clang-cl options.
2714   Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
2715 
2716   // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
2717   // to non-CUDA compilations and should not trigger warnings there.
2718   Args.ClaimAllArgs(options::OPT_cuda_host_only);
2719   Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
2720 }
2721 
2722 Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args,
2723                                      phases::ID Phase, Action *Input) const {
2724   llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
2725 
2726   // Some types skip the assembler phase (e.g., llvm-bc), but we can't
2727   // encode this in the steps because the intermediate type depends on
2728   // arguments. Just special case here.
2729   if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
2730     return Input;
2731 
2732   // Build the appropriate action.
2733   switch (Phase) {
2734   case phases::Link:
2735     llvm_unreachable("link action invalid here.");
2736   case phases::Preprocess: {
2737     types::ID OutputTy;
2738     // -{M, MM} alter the output type.
2739     if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
2740       OutputTy = types::TY_Dependencies;
2741     } else {
2742       OutputTy = Input->getType();
2743       if (!Args.hasFlag(options::OPT_frewrite_includes,
2744                         options::OPT_fno_rewrite_includes, false) &&
2745           !Args.hasFlag(options::OPT_frewrite_imports,
2746                         options::OPT_fno_rewrite_imports, false) &&
2747           !CCGenDiagnostics)
2748         OutputTy = types::getPreprocessedType(OutputTy);
2749       assert(OutputTy != types::TY_INVALID &&
2750              "Cannot preprocess this input type!");
2751     }
2752     return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
2753   }
2754   case phases::Precompile: {
2755     types::ID OutputTy = getPrecompiledType(Input->getType());
2756     assert(OutputTy != types::TY_INVALID &&
2757            "Cannot precompile this input type!");
2758     if (Args.hasArg(options::OPT_fsyntax_only)) {
2759       // Syntax checks should not emit a PCH file
2760       OutputTy = types::TY_Nothing;
2761     }
2762     return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
2763   }
2764   case phases::Compile: {
2765     if (Args.hasArg(options::OPT_fsyntax_only))
2766       return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
2767     if (Args.hasArg(options::OPT_rewrite_objc))
2768       return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
2769     if (Args.hasArg(options::OPT_rewrite_legacy_objc))
2770       return C.MakeAction<CompileJobAction>(Input,
2771                                             types::TY_RewrittenLegacyObjC);
2772     if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
2773       return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
2774     if (Args.hasArg(options::OPT__migrate))
2775       return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
2776     if (Args.hasArg(options::OPT_emit_ast))
2777       return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
2778     if (Args.hasArg(options::OPT_module_file_info))
2779       return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
2780     if (Args.hasArg(options::OPT_verify_pch))
2781       return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
2782     return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
2783   }
2784   case phases::Backend: {
2785     if (isUsingLTO()) {
2786       types::ID Output =
2787           Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
2788       return C.MakeAction<BackendJobAction>(Input, Output);
2789     }
2790     if (Args.hasArg(options::OPT_emit_llvm)) {
2791       types::ID Output =
2792           Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
2793       return C.MakeAction<BackendJobAction>(Input, Output);
2794     }
2795     return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
2796   }
2797   case phases::Assemble:
2798     return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
2799   }
2800 
2801   llvm_unreachable("invalid phase in ConstructPhaseAction");
2802 }
2803 
2804 void Driver::BuildJobs(Compilation &C) const {
2805   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
2806 
2807   Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
2808 
2809   // It is an error to provide a -o option if we are making multiple output
2810   // files.
2811   if (FinalOutput) {
2812     unsigned NumOutputs = 0;
2813     for (const Action *A : C.getActions())
2814       if (A->getType() != types::TY_Nothing)
2815         ++NumOutputs;
2816 
2817     if (NumOutputs > 1) {
2818       Diag(clang::diag::err_drv_output_argument_with_multiple_files);
2819       FinalOutput = nullptr;
2820     }
2821   }
2822 
2823   // Collect the list of architectures.
2824   llvm::StringSet<> ArchNames;
2825   if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
2826     for (const Arg *A : C.getArgs())
2827       if (A->getOption().matches(options::OPT_arch))
2828         ArchNames.insert(A->getValue());
2829 
2830   // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
2831   std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
2832   for (Action *A : C.getActions()) {
2833     // If we are linking an image for multiple archs then the linker wants
2834     // -arch_multiple and -final_output <final image name>. Unfortunately, this
2835     // doesn't fit in cleanly because we have to pass this information down.
2836     //
2837     // FIXME: This is a hack; find a cleaner way to integrate this into the
2838     // process.
2839     const char *LinkingOutput = nullptr;
2840     if (isa<LipoJobAction>(A)) {
2841       if (FinalOutput)
2842         LinkingOutput = FinalOutput->getValue();
2843       else
2844         LinkingOutput = getDefaultImageName();
2845     }
2846 
2847     BuildJobsForAction(C, A, &C.getDefaultToolChain(),
2848                        /*BoundArch*/ StringRef(),
2849                        /*AtTopLevel*/ true,
2850                        /*MultipleArchs*/ ArchNames.size() > 1,
2851                        /*LinkingOutput*/ LinkingOutput, CachedResults,
2852                        /*TargetDeviceOffloadKind*/ Action::OFK_None);
2853   }
2854 
2855   // If the user passed -Qunused-arguments or there were errors, don't warn
2856   // about any unused arguments.
2857   if (Diags.hasErrorOccurred() ||
2858       C.getArgs().hasArg(options::OPT_Qunused_arguments))
2859     return;
2860 
2861   // Claim -### here.
2862   (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
2863 
2864   // Claim --driver-mode, --rsp-quoting, it was handled earlier.
2865   (void)C.getArgs().hasArg(options::OPT_driver_mode);
2866   (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
2867 
2868   for (Arg *A : C.getArgs()) {
2869     // FIXME: It would be nice to be able to send the argument to the
2870     // DiagnosticsEngine, so that extra values, position, and so on could be
2871     // printed.
2872     if (!A->isClaimed()) {
2873       if (A->getOption().hasFlag(options::NoArgumentUnused))
2874         continue;
2875 
2876       // Suppress the warning automatically if this is just a flag, and it is an
2877       // instance of an argument we already claimed.
2878       const Option &Opt = A->getOption();
2879       if (Opt.getKind() == Option::FlagClass) {
2880         bool DuplicateClaimed = false;
2881 
2882         for (const Arg *AA : C.getArgs().filtered(&Opt)) {
2883           if (AA->isClaimed()) {
2884             DuplicateClaimed = true;
2885             break;
2886           }
2887         }
2888 
2889         if (DuplicateClaimed)
2890           continue;
2891       }
2892 
2893       // In clang-cl, don't mention unknown arguments here since they have
2894       // already been warned about.
2895       if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
2896         Diag(clang::diag::warn_drv_unused_argument)
2897             << A->getAsString(C.getArgs());
2898     }
2899   }
2900 }
2901 
2902 namespace {
2903 /// Utility class to control the collapse of dependent actions and select the
2904 /// tools accordingly.
2905 class ToolSelector final {
2906   /// The tool chain this selector refers to.
2907   const ToolChain &TC;
2908 
2909   /// The compilation this selector refers to.
2910   const Compilation &C;
2911 
2912   /// The base action this selector refers to.
2913   const JobAction *BaseAction;
2914 
2915   /// Set to true if the current toolchain refers to host actions.
2916   bool IsHostSelector;
2917 
2918   /// Set to true if save-temps and embed-bitcode functionalities are active.
2919   bool SaveTemps;
2920   bool EmbedBitcode;
2921 
2922   /// Get previous dependent action or null if that does not exist. If
2923   /// \a CanBeCollapsed is false, that action must be legal to collapse or
2924   /// null will be returned.
2925   const JobAction *getPrevDependentAction(const ActionList &Inputs,
2926                                           ActionList &SavedOffloadAction,
2927                                           bool CanBeCollapsed = true) {
2928     // An option can be collapsed only if it has a single input.
2929     if (Inputs.size() != 1)
2930       return nullptr;
2931 
2932     Action *CurAction = *Inputs.begin();
2933     if (CanBeCollapsed &&
2934         !CurAction->isCollapsingWithNextDependentActionLegal())
2935       return nullptr;
2936 
2937     // If the input action is an offload action. Look through it and save any
2938     // offload action that can be dropped in the event of a collapse.
2939     if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
2940       // If the dependent action is a device action, we will attempt to collapse
2941       // only with other device actions. Otherwise, we would do the same but
2942       // with host actions only.
2943       if (!IsHostSelector) {
2944         if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
2945           CurAction =
2946               OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
2947           if (CanBeCollapsed &&
2948               !CurAction->isCollapsingWithNextDependentActionLegal())
2949             return nullptr;
2950           SavedOffloadAction.push_back(OA);
2951           return dyn_cast<JobAction>(CurAction);
2952         }
2953       } else if (OA->hasHostDependence()) {
2954         CurAction = OA->getHostDependence();
2955         if (CanBeCollapsed &&
2956             !CurAction->isCollapsingWithNextDependentActionLegal())
2957           return nullptr;
2958         SavedOffloadAction.push_back(OA);
2959         return dyn_cast<JobAction>(CurAction);
2960       }
2961       return nullptr;
2962     }
2963 
2964     return dyn_cast<JobAction>(CurAction);
2965   }
2966 
2967   /// Return true if an assemble action can be collapsed.
2968   bool canCollapseAssembleAction() const {
2969     return TC.useIntegratedAs() && !SaveTemps &&
2970            !C.getArgs().hasArg(options::OPT_via_file_asm) &&
2971            !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
2972            !C.getArgs().hasArg(options::OPT__SLASH_Fa);
2973   }
2974 
2975   /// Return true if a preprocessor action can be collapsed.
2976   bool canCollapsePreprocessorAction() const {
2977     return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
2978            !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
2979            !C.getArgs().hasArg(options::OPT_rewrite_objc);
2980   }
2981 
2982   /// Struct that relates an action with the offload actions that would be
2983   /// collapsed with it.
2984   struct JobActionInfo final {
2985     /// The action this info refers to.
2986     const JobAction *JA = nullptr;
2987     /// The offload actions we need to take care off if this action is
2988     /// collapsed.
2989     ActionList SavedOffloadAction;
2990   };
2991 
2992   /// Append collapsed offload actions from the give nnumber of elements in the
2993   /// action info array.
2994   static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
2995                                            ArrayRef<JobActionInfo> &ActionInfo,
2996                                            unsigned ElementNum) {
2997     assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
2998     for (unsigned I = 0; I < ElementNum; ++I)
2999       CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
3000                                     ActionInfo[I].SavedOffloadAction.end());
3001   }
3002 
3003   /// Functions that attempt to perform the combining. They detect if that is
3004   /// legal, and if so they update the inputs \a Inputs and the offload action
3005   /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
3006   /// the combined action is returned. If the combining is not legal or if the
3007   /// tool does not exist, null is returned.
3008   /// Currently three kinds of collapsing are supported:
3009   ///  - Assemble + Backend + Compile;
3010   ///  - Assemble + Backend ;
3011   ///  - Backend + Compile.
3012   const Tool *
3013   combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
3014                                 const ActionList *&Inputs,
3015                                 ActionList &CollapsedOffloadAction) {
3016     if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
3017       return nullptr;
3018     auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3019     auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3020     auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
3021     if (!AJ || !BJ || !CJ)
3022       return nullptr;
3023 
3024     // Get compiler tool.
3025     const Tool *T = TC.SelectTool(*CJ);
3026     if (!T)
3027       return nullptr;
3028 
3029     // When using -fembed-bitcode, it is required to have the same tool (clang)
3030     // for both CompilerJA and BackendJA. Otherwise, combine two stages.
3031     if (EmbedBitcode) {
3032       const Tool *BT = TC.SelectTool(*BJ);
3033       if (BT == T)
3034         return nullptr;
3035     }
3036 
3037     if (!T->hasIntegratedAssembler())
3038       return nullptr;
3039 
3040     Inputs = &CJ->getInputs();
3041     AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3042                                  /*NumElements=*/3);
3043     return T;
3044   }
3045   const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
3046                                      const ActionList *&Inputs,
3047                                      ActionList &CollapsedOffloadAction) {
3048     if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
3049       return nullptr;
3050     auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
3051     auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
3052     if (!AJ || !BJ)
3053       return nullptr;
3054 
3055     // Retrieve the compile job, backend action must always be preceded by one.
3056     ActionList CompileJobOffloadActions;
3057     auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
3058                                       /*CanBeCollapsed=*/false);
3059     if (!AJ || !BJ || !CJ)
3060       return nullptr;
3061 
3062     assert(isa<CompileJobAction>(CJ) &&
3063            "Expecting compile job preceding backend job.");
3064 
3065     // Get compiler tool.
3066     const Tool *T = TC.SelectTool(*CJ);
3067     if (!T)
3068       return nullptr;
3069 
3070     if (!T->hasIntegratedAssembler())
3071       return nullptr;
3072 
3073     Inputs = &BJ->getInputs();
3074     AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3075                                  /*NumElements=*/2);
3076     return T;
3077   }
3078   const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
3079                                     const ActionList *&Inputs,
3080                                     ActionList &CollapsedOffloadAction) {
3081     if (ActionInfo.size() < 2 || !canCollapsePreprocessorAction())
3082       return nullptr;
3083     auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3084     auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3085     if (!BJ || !CJ)
3086       return nullptr;
3087 
3088     // Get compiler tool.
3089     const Tool *T = TC.SelectTool(*CJ);
3090     if (!T)
3091       return nullptr;
3092 
3093     if (T->canEmitIR() && (SaveTemps || EmbedBitcode))
3094       return nullptr;
3095 
3096     Inputs = &CJ->getInputs();
3097     AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3098                                  /*NumElements=*/2);
3099     return T;
3100   }
3101 
3102   /// Updates the inputs if the obtained tool supports combining with
3103   /// preprocessor action, and the current input is indeed a preprocessor
3104   /// action. If combining results in the collapse of offloading actions, those
3105   /// are appended to \a CollapsedOffloadAction.
3106   void combineWithPreprocessor(const Tool *T, const ActionList *&Inputs,
3107                                ActionList &CollapsedOffloadAction) {
3108     if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3109       return;
3110 
3111     // Attempt to get a preprocessor action dependence.
3112     ActionList PreprocessJobOffloadActions;
3113     auto *PJ = getPrevDependentAction(*Inputs, PreprocessJobOffloadActions);
3114     if (!PJ || !isa<PreprocessJobAction>(PJ))
3115       return;
3116 
3117     // This is legal to combine. Append any offload action we found and set the
3118     // current inputs to preprocessor inputs.
3119     CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3120                                   PreprocessJobOffloadActions.end());
3121     Inputs = &PJ->getInputs();
3122   }
3123 
3124 public:
3125   ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3126                const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3127       : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3128         EmbedBitcode(EmbedBitcode) {
3129     assert(BaseAction && "Invalid base action.");
3130     IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3131   }
3132 
3133   /// Check if a chain of actions can be combined and return the tool that can
3134   /// handle the combination of actions. The pointer to the current inputs \a
3135   /// Inputs and the list of offload actions \a CollapsedOffloadActions
3136   /// connected to collapsed actions are updated accordingly. The latter enables
3137   /// the caller of the selector to process them afterwards instead of just
3138   /// dropping them. If no suitable tool is found, null will be returned.
3139   const Tool *getTool(const ActionList *&Inputs,
3140                       ActionList &CollapsedOffloadAction) {
3141     //
3142     // Get the largest chain of actions that we could combine.
3143     //
3144 
3145     SmallVector<JobActionInfo, 5> ActionChain(1);
3146     ActionChain.back().JA = BaseAction;
3147     while (ActionChain.back().JA) {
3148       const Action *CurAction = ActionChain.back().JA;
3149 
3150       // Grow the chain by one element.
3151       ActionChain.resize(ActionChain.size() + 1);
3152       JobActionInfo &AI = ActionChain.back();
3153 
3154       // Attempt to fill it with the
3155       AI.JA =
3156           getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
3157     }
3158 
3159     // Pop the last action info as it could not be filled.
3160     ActionChain.pop_back();
3161 
3162     //
3163     // Attempt to combine actions. If all combining attempts failed, just return
3164     // the tool of the provided action. At the end we attempt to combine the
3165     // action with any preprocessor action it may depend on.
3166     //
3167 
3168     const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3169                                                   CollapsedOffloadAction);
3170     if (!T)
3171       T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3172     if (!T)
3173       T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3174     if (!T) {
3175       Inputs = &BaseAction->getInputs();
3176       T = TC.SelectTool(*BaseAction);
3177     }
3178 
3179     combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3180     return T;
3181   }
3182 };
3183 }
3184 
3185 /// Return a string that uniquely identifies the result of a job. The bound arch
3186 /// is not necessarily represented in the toolchain's triple -- for example,
3187 /// armv7 and armv7s both map to the same triple -- so we need both in our map.
3188 /// Also, we need to add the offloading device kind, as the same tool chain can
3189 /// be used for host and device for some programming models, e.g. OpenMP.
3190 static std::string GetTriplePlusArchString(const ToolChain *TC,
3191                                            StringRef BoundArch,
3192                                            Action::OffloadKind OffloadKind) {
3193   std::string TriplePlusArch = TC->getTriple().normalize();
3194   if (!BoundArch.empty()) {
3195     TriplePlusArch += "-";
3196     TriplePlusArch += BoundArch;
3197   }
3198   TriplePlusArch += "-";
3199   TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3200   return TriplePlusArch;
3201 }
3202 
3203 InputInfo Driver::BuildJobsForAction(
3204     Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3205     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3206     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3207     Action::OffloadKind TargetDeviceOffloadKind) const {
3208   std::pair<const Action *, std::string> ActionTC = {
3209       A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3210   auto CachedResult = CachedResults.find(ActionTC);
3211   if (CachedResult != CachedResults.end()) {
3212     return CachedResult->second;
3213   }
3214   InputInfo Result = BuildJobsForActionNoCache(
3215       C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
3216       CachedResults, TargetDeviceOffloadKind);
3217   CachedResults[ActionTC] = Result;
3218   return Result;
3219 }
3220 
3221 InputInfo Driver::BuildJobsForActionNoCache(
3222     Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3223     bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3224     std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3225     Action::OffloadKind TargetDeviceOffloadKind) const {
3226   llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
3227 
3228   InputInfoList OffloadDependencesInputInfo;
3229   bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
3230   if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
3231     // The offload action is expected to be used in four different situations.
3232     //
3233     // a) Set a toolchain/architecture/kind for a host action:
3234     //    Host Action 1 -> OffloadAction -> Host Action 2
3235     //
3236     // b) Set a toolchain/architecture/kind for a device action;
3237     //    Device Action 1 -> OffloadAction -> Device Action 2
3238     //
3239     // c) Specify a device dependence to a host action;
3240     //    Device Action 1  _
3241     //                      \
3242     //      Host Action 1  ---> OffloadAction -> Host Action 2
3243     //
3244     // d) Specify a host dependence to a device action.
3245     //      Host Action 1  _
3246     //                      \
3247     //    Device Action 1  ---> OffloadAction -> Device Action 2
3248     //
3249     // For a) and b), we just return the job generated for the dependence. For
3250     // c) and d) we override the current action with the host/device dependence
3251     // if the current toolchain is host/device and set the offload dependences
3252     // info with the jobs obtained from the device/host dependence(s).
3253 
3254     // If there is a single device option, just generate the job for it.
3255     if (OA->hasSingleDeviceDependence()) {
3256       InputInfo DevA;
3257       OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3258                                        const char *DepBoundArch) {
3259         DevA =
3260             BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3261                                /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
3262                                CachedResults, DepA->getOffloadingDeviceKind());
3263       });
3264       return DevA;
3265     }
3266 
3267     // If 'Action 2' is host, we generate jobs for the device dependences and
3268     // override the current action with the host dependence. Otherwise, we
3269     // generate the host dependences and override the action with the device
3270     // dependence. The dependences can't therefore be a top-level action.
3271     OA->doOnEachDependence(
3272         /*IsHostDependence=*/BuildingForOffloadDevice,
3273         [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3274           OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3275               C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3276               /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
3277               DepA->getOffloadingDeviceKind()));
3278         });
3279 
3280     A = BuildingForOffloadDevice
3281             ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3282             : OA->getHostDependence();
3283   }
3284 
3285   if (const InputAction *IA = dyn_cast<InputAction>(A)) {
3286     // FIXME: It would be nice to not claim this here; maybe the old scheme of
3287     // just using Args was better?
3288     const Arg &Input = IA->getInputArg();
3289     Input.claim();
3290     if (Input.getOption().matches(options::OPT_INPUT)) {
3291       const char *Name = Input.getValue();
3292       return InputInfo(A, Name, /* BaseInput = */ Name);
3293     }
3294     return InputInfo(A, &Input, /* BaseInput = */ "");
3295   }
3296 
3297   if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
3298     const ToolChain *TC;
3299     StringRef ArchName = BAA->getArchName();
3300 
3301     if (!ArchName.empty())
3302       TC = &getToolChain(C.getArgs(),
3303                          computeTargetTriple(*this, DefaultTargetTriple,
3304                                              C.getArgs(), ArchName));
3305     else
3306       TC = &C.getDefaultToolChain();
3307 
3308     return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
3309                               MultipleArchs, LinkingOutput, CachedResults,
3310                               TargetDeviceOffloadKind);
3311   }
3312 
3313 
3314   const ActionList *Inputs = &A->getInputs();
3315 
3316   const JobAction *JA = cast<JobAction>(A);
3317   ActionList CollapsedOffloadActions;
3318 
3319   ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3320                   embedBitcodeInObject() && !isUsingLTO());
3321   const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3322 
3323   if (!T)
3324     return InputInfo();
3325 
3326   // If we've collapsed action list that contained OffloadAction we
3327   // need to build jobs for host/device-side inputs it may have held.
3328   for (const auto *OA : CollapsedOffloadActions)
3329     cast<OffloadAction>(OA)->doOnEachDependence(
3330         /*IsHostDependence=*/BuildingForOffloadDevice,
3331         [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3332           OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3333               C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
3334               /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
3335               DepA->getOffloadingDeviceKind()));
3336         });
3337 
3338   // Only use pipes when there is exactly one input.
3339   InputInfoList InputInfos;
3340   for (const Action *Input : *Inputs) {
3341     // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3342     // shouldn't get temporary output names.
3343     // FIXME: Clean this up.
3344     bool SubJobAtTopLevel =
3345         AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
3346     InputInfos.push_back(BuildJobsForAction(
3347         C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
3348         CachedResults, A->getOffloadingDeviceKind()));
3349   }
3350 
3351   // Always use the first input as the base input.
3352   const char *BaseInput = InputInfos[0].getBaseInput();
3353 
3354   // ... except dsymutil actions, which use their actual input as the base
3355   // input.
3356   if (JA->getType() == types::TY_dSYM)
3357     BaseInput = InputInfos[0].getFilename();
3358 
3359   // Append outputs of offload device jobs to the input list
3360   if (!OffloadDependencesInputInfo.empty())
3361     InputInfos.append(OffloadDependencesInputInfo.begin(),
3362                       OffloadDependencesInputInfo.end());
3363 
3364   // Set the effective triple of the toolchain for the duration of this job.
3365   llvm::Triple EffectiveTriple;
3366   const ToolChain &ToolTC = T->getToolChain();
3367   const ArgList &Args =
3368       C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
3369   if (InputInfos.size() != 1) {
3370     EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
3371   } else {
3372     // Pass along the input type if it can be unambiguously determined.
3373     EffectiveTriple = llvm::Triple(
3374         ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
3375   }
3376   RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
3377 
3378   // Determine the place to write output to, if any.
3379   InputInfo Result;
3380   InputInfoList UnbundlingResults;
3381   if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
3382     // If we have an unbundling job, we need to create results for all the
3383     // outputs. We also update the results cache so that other actions using
3384     // this unbundling action can get the right results.
3385     for (auto &UI : UA->getDependentActionsInfo()) {
3386       assert(UI.DependentOffloadKind != Action::OFK_None &&
3387              "Unbundling with no offloading??");
3388 
3389       // Unbundling actions are never at the top level. When we generate the
3390       // offloading prefix, we also do that for the host file because the
3391       // unbundling action does not change the type of the output which can
3392       // cause a overwrite.
3393       std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3394           UI.DependentOffloadKind,
3395           UI.DependentToolChain->getTriple().normalize(),
3396           /*CreatePrefixForHost=*/true);
3397       auto CurI = InputInfo(
3398           UA, GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
3399                                  /*AtTopLevel=*/false, MultipleArchs,
3400                                  OffloadingPrefix),
3401           BaseInput);
3402       // Save the unbundling result.
3403       UnbundlingResults.push_back(CurI);
3404 
3405       // Get the unique string identifier for this dependence and cache the
3406       // result.
3407       CachedResults[{A, GetTriplePlusArchString(
3408                             UI.DependentToolChain, UI.DependentBoundArch,
3409                             UI.DependentOffloadKind)}] = CurI;
3410     }
3411 
3412     // Now that we have all the results generated, select the one that should be
3413     // returned for the current depending action.
3414     std::pair<const Action *, std::string> ActionTC = {
3415         A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3416     assert(CachedResults.find(ActionTC) != CachedResults.end() &&
3417            "Result does not exist??");
3418     Result = CachedResults[ActionTC];
3419   } else if (JA->getType() == types::TY_Nothing)
3420     Result = InputInfo(A, BaseInput);
3421   else {
3422     // We only have to generate a prefix for the host if this is not a top-level
3423     // action.
3424     std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3425         A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
3426         /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
3427             !AtTopLevel);
3428     Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
3429                                              AtTopLevel, MultipleArchs,
3430                                              OffloadingPrefix),
3431                        BaseInput);
3432   }
3433 
3434   if (CCCPrintBindings && !CCGenDiagnostics) {
3435     llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
3436                  << " - \"" << T->getName() << "\", inputs: [";
3437     for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
3438       llvm::errs() << InputInfos[i].getAsString();
3439       if (i + 1 != e)
3440         llvm::errs() << ", ";
3441     }
3442     if (UnbundlingResults.empty())
3443       llvm::errs() << "], output: " << Result.getAsString() << "\n";
3444     else {
3445       llvm::errs() << "], outputs: [";
3446       for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
3447         llvm::errs() << UnbundlingResults[i].getAsString();
3448         if (i + 1 != e)
3449           llvm::errs() << ", ";
3450       }
3451       llvm::errs() << "] \n";
3452     }
3453   } else {
3454     if (UnbundlingResults.empty())
3455       T->ConstructJob(
3456           C, *JA, Result, InputInfos,
3457           C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3458           LinkingOutput);
3459     else
3460       T->ConstructJobMultipleOutputs(
3461           C, *JA, UnbundlingResults, InputInfos,
3462           C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3463           LinkingOutput);
3464   }
3465   return Result;
3466 }
3467 
3468 const char *Driver::getDefaultImageName() const {
3469   llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
3470   return Target.isOSWindows() ? "a.exe" : "a.out";
3471 }
3472 
3473 /// \brief Create output filename based on ArgValue, which could either be a
3474 /// full filename, filename without extension, or a directory. If ArgValue
3475 /// does not provide a filename, then use BaseName, and use the extension
3476 /// suitable for FileType.
3477 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
3478                                         StringRef BaseName,
3479                                         types::ID FileType) {
3480   SmallString<128> Filename = ArgValue;
3481 
3482   if (ArgValue.empty()) {
3483     // If the argument is empty, output to BaseName in the current dir.
3484     Filename = BaseName;
3485   } else if (llvm::sys::path::is_separator(Filename.back())) {
3486     // If the argument is a directory, output to BaseName in that dir.
3487     llvm::sys::path::append(Filename, BaseName);
3488   }
3489 
3490   if (!llvm::sys::path::has_extension(ArgValue)) {
3491     // If the argument didn't provide an extension, then set it.
3492     const char *Extension = types::getTypeTempSuffix(FileType, true);
3493 
3494     if (FileType == types::TY_Image &&
3495         Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
3496       // The output file is a dll.
3497       Extension = "dll";
3498     }
3499 
3500     llvm::sys::path::replace_extension(Filename, Extension);
3501   }
3502 
3503   return Args.MakeArgString(Filename.c_str());
3504 }
3505 
3506 const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
3507                                        const char *BaseInput,
3508                                        StringRef BoundArch, bool AtTopLevel,
3509                                        bool MultipleArchs,
3510                                        StringRef OffloadingPrefix) const {
3511   llvm::PrettyStackTraceString CrashInfo("Computing output path");
3512   // Output to a user requested destination?
3513   if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
3514     if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
3515       return C.addResultFile(FinalOutput->getValue(), &JA);
3516   }
3517 
3518   // For /P, preprocess to file named after BaseInput.
3519   if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
3520     assert(AtTopLevel && isa<PreprocessJobAction>(JA));
3521     StringRef BaseName = llvm::sys::path::filename(BaseInput);
3522     StringRef NameArg;
3523     if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
3524       NameArg = A->getValue();
3525     return C.addResultFile(
3526         MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
3527         &JA);
3528   }
3529 
3530   // Default to writing to stdout?
3531   if (AtTopLevel && !CCGenDiagnostics &&
3532       (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
3533     return "-";
3534 
3535   // Is this the assembly listing for /FA?
3536   if (JA.getType() == types::TY_PP_Asm &&
3537       (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
3538        C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
3539     // Use /Fa and the input filename to determine the asm file name.
3540     StringRef BaseName = llvm::sys::path::filename(BaseInput);
3541     StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
3542     return C.addResultFile(
3543         MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
3544         &JA);
3545   }
3546 
3547   // Output to a temporary file?
3548   if ((!AtTopLevel && !isSaveTempsEnabled() &&
3549        !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
3550       CCGenDiagnostics) {
3551     StringRef Name = llvm::sys::path::filename(BaseInput);
3552     std::pair<StringRef, StringRef> Split = Name.split('.');
3553     std::string TmpName = GetTemporaryPath(
3554         Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
3555     return C.addTempFile(C.getArgs().MakeArgString(TmpName));
3556   }
3557 
3558   SmallString<128> BasePath(BaseInput);
3559   StringRef BaseName;
3560 
3561   // Dsymutil actions should use the full path.
3562   if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
3563     BaseName = BasePath;
3564   else
3565     BaseName = llvm::sys::path::filename(BasePath);
3566 
3567   // Determine what the derived output name should be.
3568   const char *NamedOutput;
3569 
3570   if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
3571       C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
3572     // The /Fo or /o flag decides the object filename.
3573     StringRef Val =
3574         C.getArgs()
3575             .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
3576             ->getValue();
3577     NamedOutput =
3578         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
3579   } else if (JA.getType() == types::TY_Image &&
3580              C.getArgs().hasArg(options::OPT__SLASH_Fe,
3581                                 options::OPT__SLASH_o)) {
3582     // The /Fe or /o flag names the linked file.
3583     StringRef Val =
3584         C.getArgs()
3585             .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
3586             ->getValue();
3587     NamedOutput =
3588         MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
3589   } else if (JA.getType() == types::TY_Image) {
3590     if (IsCLMode()) {
3591       // clang-cl uses BaseName for the executable name.
3592       NamedOutput =
3593           MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
3594     } else {
3595       SmallString<128> Output(getDefaultImageName());
3596       Output += OffloadingPrefix;
3597       if (MultipleArchs && !BoundArch.empty()) {
3598         Output += "-";
3599         Output.append(BoundArch);
3600       }
3601       NamedOutput = C.getArgs().MakeArgString(Output.c_str());
3602     }
3603   } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
3604     NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
3605   } else {
3606     const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
3607     assert(Suffix && "All types used for output should have a suffix.");
3608 
3609     std::string::size_type End = std::string::npos;
3610     if (!types::appendSuffixForType(JA.getType()))
3611       End = BaseName.rfind('.');
3612     SmallString<128> Suffixed(BaseName.substr(0, End));
3613     Suffixed += OffloadingPrefix;
3614     if (MultipleArchs && !BoundArch.empty()) {
3615       Suffixed += "-";
3616       Suffixed.append(BoundArch);
3617     }
3618     // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
3619     // the unoptimized bitcode so that it does not get overwritten by the ".bc"
3620     // optimized bitcode output.
3621     if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
3622         JA.getType() == types::TY_LLVM_BC)
3623       Suffixed += ".tmp";
3624     Suffixed += '.';
3625     Suffixed += Suffix;
3626     NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
3627   }
3628 
3629   // Prepend object file path if -save-temps=obj
3630   if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
3631       JA.getType() != types::TY_PCH) {
3632     Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3633     SmallString<128> TempPath(FinalOutput->getValue());
3634     llvm::sys::path::remove_filename(TempPath);
3635     StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
3636     llvm::sys::path::append(TempPath, OutputFileName);
3637     NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
3638   }
3639 
3640   // If we're saving temps and the temp file conflicts with the input file,
3641   // then avoid overwriting input file.
3642   if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
3643     bool SameFile = false;
3644     SmallString<256> Result;
3645     llvm::sys::fs::current_path(Result);
3646     llvm::sys::path::append(Result, BaseName);
3647     llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
3648     // Must share the same path to conflict.
3649     if (SameFile) {
3650       StringRef Name = llvm::sys::path::filename(BaseInput);
3651       std::pair<StringRef, StringRef> Split = Name.split('.');
3652       std::string TmpName = GetTemporaryPath(
3653           Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
3654       return C.addTempFile(C.getArgs().MakeArgString(TmpName));
3655     }
3656   }
3657 
3658   // As an annoying special case, PCH generation doesn't strip the pathname.
3659   if (JA.getType() == types::TY_PCH && !IsCLMode()) {
3660     llvm::sys::path::remove_filename(BasePath);
3661     if (BasePath.empty())
3662       BasePath = NamedOutput;
3663     else
3664       llvm::sys::path::append(BasePath, NamedOutput);
3665     return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
3666   } else {
3667     return C.addResultFile(NamedOutput, &JA);
3668   }
3669 }
3670 
3671 std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
3672   // Respect a limited subset of the '-Bprefix' functionality in GCC by
3673   // attempting to use this prefix when looking for file paths.
3674   for (const std::string &Dir : PrefixDirs) {
3675     if (Dir.empty())
3676       continue;
3677     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
3678     llvm::sys::path::append(P, Name);
3679     if (llvm::sys::fs::exists(Twine(P)))
3680       return P.str();
3681   }
3682 
3683   SmallString<128> P(ResourceDir);
3684   llvm::sys::path::append(P, Name);
3685   if (llvm::sys::fs::exists(Twine(P)))
3686     return P.str();
3687 
3688   for (const std::string &Dir : TC.getFilePaths()) {
3689     if (Dir.empty())
3690       continue;
3691     SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
3692     llvm::sys::path::append(P, Name);
3693     if (llvm::sys::fs::exists(Twine(P)))
3694       return P.str();
3695   }
3696 
3697   return Name;
3698 }
3699 
3700 void Driver::generatePrefixedToolNames(
3701     StringRef Tool, const ToolChain &TC,
3702     SmallVectorImpl<std::string> &Names) const {
3703   // FIXME: Needs a better variable than DefaultTargetTriple
3704   Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
3705   Names.emplace_back(Tool);
3706 
3707   // Allow the discovery of tools prefixed with LLVM's default target triple.
3708   std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
3709   if (LLVMDefaultTargetTriple != DefaultTargetTriple)
3710     Names.emplace_back((LLVMDefaultTargetTriple + "-" + Tool).str());
3711 }
3712 
3713 static bool ScanDirForExecutable(SmallString<128> &Dir,
3714                                  ArrayRef<std::string> Names) {
3715   for (const auto &Name : Names) {
3716     llvm::sys::path::append(Dir, Name);
3717     if (llvm::sys::fs::can_execute(Twine(Dir)))
3718       return true;
3719     llvm::sys::path::remove_filename(Dir);
3720   }
3721   return false;
3722 }
3723 
3724 std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
3725   SmallVector<std::string, 2> TargetSpecificExecutables;
3726   generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
3727 
3728   // Respect a limited subset of the '-Bprefix' functionality in GCC by
3729   // attempting to use this prefix when looking for program paths.
3730   for (const auto &PrefixDir : PrefixDirs) {
3731     if (llvm::sys::fs::is_directory(PrefixDir)) {
3732       SmallString<128> P(PrefixDir);
3733       if (ScanDirForExecutable(P, TargetSpecificExecutables))
3734         return P.str();
3735     } else {
3736       SmallString<128> P((PrefixDir + Name).str());
3737       if (llvm::sys::fs::can_execute(Twine(P)))
3738         return P.str();
3739     }
3740   }
3741 
3742   const ToolChain::path_list &List = TC.getProgramPaths();
3743   for (const auto &Path : List) {
3744     SmallString<128> P(Path);
3745     if (ScanDirForExecutable(P, TargetSpecificExecutables))
3746       return P.str();
3747   }
3748 
3749   // If all else failed, search the path.
3750   for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
3751     if (llvm::ErrorOr<std::string> P =
3752             llvm::sys::findProgramByName(TargetSpecificExecutable))
3753       return *P;
3754 
3755   return Name;
3756 }
3757 
3758 std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
3759   SmallString<128> Path;
3760   std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
3761   if (EC) {
3762     Diag(clang::diag::err_unable_to_make_temp) << EC.message();
3763     return "";
3764   }
3765 
3766   return Path.str();
3767 }
3768 
3769 std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
3770   SmallString<128> Output;
3771   if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
3772     // FIXME: If anybody needs it, implement this obscure rule:
3773     // "If you specify a directory without a file name, the default file name
3774     // is VCx0.pch., where x is the major version of Visual C++ in use."
3775     Output = FpArg->getValue();
3776 
3777     // "If you do not specify an extension as part of the path name, an
3778     // extension of .pch is assumed. "
3779     if (!llvm::sys::path::has_extension(Output))
3780       Output += ".pch";
3781   } else {
3782     Output = BaseName;
3783     llvm::sys::path::replace_extension(Output, ".pch");
3784   }
3785   return Output.str();
3786 }
3787 
3788 const ToolChain &Driver::getToolChain(const ArgList &Args,
3789                                       const llvm::Triple &Target) const {
3790 
3791   auto &TC = ToolChains[Target.str()];
3792   if (!TC) {
3793     switch (Target.getOS()) {
3794     case llvm::Triple::Haiku:
3795       TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
3796       break;
3797     case llvm::Triple::Ananas:
3798       TC = llvm::make_unique<toolchains::Ananas>(*this, Target, Args);
3799       break;
3800     case llvm::Triple::CloudABI:
3801       TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
3802       break;
3803     case llvm::Triple::Darwin:
3804     case llvm::Triple::MacOSX:
3805     case llvm::Triple::IOS:
3806     case llvm::Triple::TvOS:
3807     case llvm::Triple::WatchOS:
3808       TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
3809       break;
3810     case llvm::Triple::DragonFly:
3811       TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
3812       break;
3813     case llvm::Triple::OpenBSD:
3814       TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
3815       break;
3816     case llvm::Triple::NetBSD:
3817       TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
3818       break;
3819     case llvm::Triple::FreeBSD:
3820       TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
3821       break;
3822     case llvm::Triple::Minix:
3823       TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
3824       break;
3825     case llvm::Triple::Linux:
3826     case llvm::Triple::ELFIAMCU:
3827       if (Target.getArch() == llvm::Triple::hexagon)
3828         TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3829                                                              Args);
3830       else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
3831                !Target.hasEnvironment())
3832         TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
3833                                                               Args);
3834       else
3835         TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
3836       break;
3837     case llvm::Triple::NaCl:
3838       TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
3839       break;
3840     case llvm::Triple::Fuchsia:
3841       TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
3842       break;
3843     case llvm::Triple::Solaris:
3844       TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
3845       break;
3846     case llvm::Triple::AMDHSA:
3847       TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
3848       break;
3849     case llvm::Triple::Win32:
3850       switch (Target.getEnvironment()) {
3851       default:
3852         if (Target.isOSBinFormatELF())
3853           TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
3854         else if (Target.isOSBinFormatMachO())
3855           TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
3856         else
3857           TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
3858         break;
3859       case llvm::Triple::GNU:
3860         TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
3861         break;
3862       case llvm::Triple::Itanium:
3863         TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
3864                                                                   Args);
3865         break;
3866       case llvm::Triple::MSVC:
3867       case llvm::Triple::UnknownEnvironment:
3868         TC = llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
3869         break;
3870       }
3871       break;
3872     case llvm::Triple::PS4:
3873       TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
3874       break;
3875     case llvm::Triple::Contiki:
3876       TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
3877       break;
3878     default:
3879       // Of these targets, Hexagon is the only one that might have
3880       // an OS of Linux, in which case it got handled above already.
3881       switch (Target.getArch()) {
3882       case llvm::Triple::tce:
3883         TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
3884         break;
3885       case llvm::Triple::tcele:
3886         TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
3887         break;
3888       case llvm::Triple::hexagon:
3889         TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3890                                                              Args);
3891         break;
3892       case llvm::Triple::lanai:
3893         TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
3894         break;
3895       case llvm::Triple::xcore:
3896         TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
3897         break;
3898       case llvm::Triple::wasm32:
3899       case llvm::Triple::wasm64:
3900         TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
3901         break;
3902       case llvm::Triple::avr:
3903         TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
3904         break;
3905       default:
3906         if (Target.getVendor() == llvm::Triple::Myriad)
3907           TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
3908                                                               Args);
3909         else if (toolchains::BareMetal::handlesTarget(Target))
3910           TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
3911         else if (Target.isOSBinFormatELF())
3912           TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
3913         else if (Target.isOSBinFormatMachO())
3914           TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
3915         else
3916           TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
3917       }
3918     }
3919   }
3920 
3921   // Intentionally omitted from the switch above: llvm::Triple::CUDA.  CUDA
3922   // compiles always need two toolchains, the CUDA toolchain and the host
3923   // toolchain.  So the only valid way to create a CUDA toolchain is via
3924   // CreateOffloadingDeviceToolChains.
3925 
3926   return *TC;
3927 }
3928 
3929 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
3930   // Say "no" if there is not exactly one input of a type clang understands.
3931   if (JA.size() != 1 ||
3932       !types::isAcceptedByClang((*JA.input_begin())->getType()))
3933     return false;
3934 
3935   // And say "no" if this is not a kind of action clang understands.
3936   if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
3937       !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
3938     return false;
3939 
3940   return true;
3941 }
3942 
3943 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
3944 /// grouped values as integers. Numbers which are not provided are set to 0.
3945 ///
3946 /// \return True if the entire string was parsed (9.2), or all groups were
3947 /// parsed (10.3.5extrastuff).
3948 bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
3949                                unsigned &Micro, bool &HadExtra) {
3950   HadExtra = false;
3951 
3952   Major = Minor = Micro = 0;
3953   if (Str.empty())
3954     return false;
3955 
3956   if (Str.consumeInteger(10, Major))
3957     return false;
3958   if (Str.empty())
3959     return true;
3960   if (Str[0] != '.')
3961     return false;
3962 
3963   Str = Str.drop_front(1);
3964 
3965   if (Str.consumeInteger(10, Minor))
3966     return false;
3967   if (Str.empty())
3968     return true;
3969   if (Str[0] != '.')
3970     return false;
3971   Str = Str.drop_front(1);
3972 
3973   if (Str.consumeInteger(10, Micro))
3974     return false;
3975   if (!Str.empty())
3976     HadExtra = true;
3977   return true;
3978 }
3979 
3980 /// Parse digits from a string \p Str and fulfill \p Digits with
3981 /// the parsed numbers. This method assumes that the max number of
3982 /// digits to look for is equal to Digits.size().
3983 ///
3984 /// \return True if the entire string was parsed and there are
3985 /// no extra characters remaining at the end.
3986 bool Driver::GetReleaseVersion(StringRef Str,
3987                                MutableArrayRef<unsigned> Digits) {
3988   if (Str.empty())
3989     return false;
3990 
3991   unsigned CurDigit = 0;
3992   while (CurDigit < Digits.size()) {
3993     unsigned Digit;
3994     if (Str.consumeInteger(10, Digit))
3995       return false;
3996     Digits[CurDigit] = Digit;
3997     if (Str.empty())
3998       return true;
3999     if (Str[0] != '.')
4000       return false;
4001     Str = Str.drop_front(1);
4002     CurDigit++;
4003   }
4004 
4005   // More digits than requested, bail out...
4006   return false;
4007 }
4008 
4009 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
4010   unsigned IncludedFlagsBitmask = 0;
4011   unsigned ExcludedFlagsBitmask = options::NoDriverOption;
4012 
4013   if (Mode == CLMode) {
4014     // Include CL and Core options.
4015     IncludedFlagsBitmask |= options::CLOption;
4016     IncludedFlagsBitmask |= options::CoreOption;
4017   } else {
4018     ExcludedFlagsBitmask |= options::CLOption;
4019   }
4020 
4021   return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
4022 }
4023 
4024 bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
4025   return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);
4026 }
4027