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