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