contrib/llvm/tools/clang/lib/Driver/Driver.cpp

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