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