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