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