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