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