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