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