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