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