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.h" 13 #include "clang/Basic/Version.h" 14 #include "clang/Basic/VirtualFileSystem.h" 15 #include "clang/Config/config.h" 16 #include "clang/Driver/Action.h" 17 #include "clang/Driver/Compilation.h" 18 #include "clang/Driver/DriverDiagnostic.h" 19 #include "clang/Driver/Job.h" 20 #include "clang/Driver/Options.h" 21 #include "clang/Driver/SanitizerArgs.h" 22 #include "clang/Driver/Tool.h" 23 #include "clang/Driver/ToolChain.h" 24 #include "llvm/ADT/ArrayRef.h" 25 #include "llvm/ADT/STLExtras.h" 26 #include "llvm/ADT/StringExtras.h" 27 #include "llvm/ADT/StringSet.h" 28 #include "llvm/ADT/StringSwitch.h" 29 #include "llvm/Option/Arg.h" 30 #include "llvm/Option/ArgList.h" 31 #include "llvm/Option/OptSpecifier.h" 32 #include "llvm/Option/OptTable.h" 33 #include "llvm/Option/Option.h" 34 #include "llvm/Support/Debug.h" 35 #include "llvm/Support/ErrorHandling.h" 36 #include "llvm/Support/FileSystem.h" 37 #include "llvm/Support/Path.h" 38 #include "llvm/Support/PrettyStackTrace.h" 39 #include "llvm/Support/Process.h" 40 #include "llvm/Support/Program.h" 41 #include "llvm/Support/raw_ostream.h" 42 #include <map> 43 #include <memory> 44 45 using namespace clang::driver; 46 using namespace clang; 47 using namespace llvm::opt; 48 49 Driver::Driver(StringRef ClangExecutable, StringRef DefaultTargetTriple, 50 DiagnosticsEngine &Diags, 51 IntrusiveRefCntPtr<vfs::FileSystem> VFS) 52 : Opts(createDriverOptTable()), Diags(Diags), VFS(VFS), Mode(GCCMode), 53 SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone), LTOMode(LTOK_None), 54 ClangExecutable(ClangExecutable), 55 SysRoot(DEFAULT_SYSROOT), UseStdLib(true), 56 DefaultTargetTriple(DefaultTargetTriple), 57 DriverTitle("clang LLVM compiler"), CCPrintOptionsFilename(nullptr), 58 CCPrintHeadersFilename(nullptr), CCLogDiagnosticsFilename(nullptr), 59 CCCPrintBindings(false), CCPrintHeaders(false), CCLogDiagnostics(false), 60 CCGenDiagnostics(false), CCCGenericGCCName(""), CheckInputsExist(true), 61 CCCUsePCH(true), SuppressMissingInputWarning(false) { 62 63 // Provide a sane fallback if no VFS is specified. 64 if (!this->VFS) 65 this->VFS = vfs::getRealFileSystem(); 66 67 Name = llvm::sys::path::filename(ClangExecutable); 68 Dir = llvm::sys::path::parent_path(ClangExecutable); 69 InstalledDir = Dir; // Provide a sensible default installed dir. 70 71 // Compute the path to the resource directory. 72 StringRef ClangResourceDir(CLANG_RESOURCE_DIR); 73 SmallString<128> P(Dir); 74 if (ClangResourceDir != "") { 75 llvm::sys::path::append(P, ClangResourceDir); 76 } else { 77 StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX); 78 llvm::sys::path::append(P, "..", Twine("lib") + ClangLibdirSuffix, "clang", 79 CLANG_VERSION_STRING); 80 } 81 ResourceDir = P.str(); 82 } 83 84 Driver::~Driver() { 85 delete Opts; 86 87 llvm::DeleteContainerSeconds(ToolChains); 88 } 89 90 void Driver::ParseDriverMode(ArrayRef<const char *> Args) { 91 const std::string OptName = 92 getOpts().getOption(options::OPT_driver_mode).getPrefixedName(); 93 94 for (const char *ArgPtr : Args) { 95 // Ingore nullptrs, they are response file's EOL markers 96 if (ArgPtr == nullptr) 97 continue; 98 const StringRef Arg = ArgPtr; 99 if (!Arg.startswith(OptName)) 100 continue; 101 102 const StringRef Value = Arg.drop_front(OptName.size()); 103 const unsigned M = llvm::StringSwitch<unsigned>(Value) 104 .Case("gcc", GCCMode) 105 .Case("g++", GXXMode) 106 .Case("cpp", CPPMode) 107 .Case("cl", CLMode) 108 .Default(~0U); 109 110 if (M != ~0U) 111 Mode = static_cast<DriverMode>(M); 112 else 113 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value; 114 } 115 } 116 117 InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings) { 118 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing"); 119 120 unsigned IncludedFlagsBitmask; 121 unsigned ExcludedFlagsBitmask; 122 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) = 123 getIncludeExcludeOptionFlagMasks(); 124 125 unsigned MissingArgIndex, MissingArgCount; 126 InputArgList Args = 127 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount, 128 IncludedFlagsBitmask, ExcludedFlagsBitmask); 129 130 // Check for missing argument error. 131 if (MissingArgCount) 132 Diag(clang::diag::err_drv_missing_argument) 133 << Args.getArgString(MissingArgIndex) << MissingArgCount; 134 135 // Check for unsupported options. 136 for (const Arg *A : Args) { 137 if (A->getOption().hasFlag(options::Unsupported)) { 138 Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(Args); 139 continue; 140 } 141 142 // Warn about -mcpu= without an argument. 143 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) { 144 Diag(clang::diag::warn_drv_empty_joined_argument) << A->getAsString(Args); 145 } 146 } 147 148 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN)) 149 Diags.Report(IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl : 150 diag::err_drv_unknown_argument) 151 << A->getAsString(Args); 152 153 return Args; 154 } 155 156 // Determine which compilation mode we are in. We look for options which 157 // affect the phase, starting with the earliest phases, and record which 158 // option we used to determine the final phase. 159 phases::ID Driver::getFinalPhase(const DerivedArgList &DAL, 160 Arg **FinalPhaseArg) const { 161 Arg *PhaseArg = nullptr; 162 phases::ID FinalPhase; 163 164 // -{E,EP,P,M,MM} only run the preprocessor. 165 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) || 166 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) || 167 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) || 168 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) { 169 FinalPhase = phases::Preprocess; 170 171 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler. 172 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) || 173 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) || 174 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) || 175 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) || 176 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) || 177 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) || 178 (PhaseArg = DAL.getLastArg(options::OPT__analyze, 179 options::OPT__analyze_auto)) || 180 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) { 181 FinalPhase = phases::Compile; 182 183 // -S only runs up to the backend. 184 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) { 185 FinalPhase = phases::Backend; 186 187 // -c compilation only runs up to the assembler. 188 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) { 189 FinalPhase = phases::Assemble; 190 191 // Otherwise do everything. 192 } else 193 FinalPhase = phases::Link; 194 195 if (FinalPhaseArg) 196 *FinalPhaseArg = PhaseArg; 197 198 return FinalPhase; 199 } 200 201 static Arg *MakeInputArg(DerivedArgList &Args, OptTable *Opts, 202 StringRef Value) { 203 Arg *A = new Arg(Opts->getOption(options::OPT_INPUT), Value, 204 Args.getBaseArgs().MakeIndex(Value), Value.data()); 205 Args.AddSynthesizedArg(A); 206 A->claim(); 207 return A; 208 } 209 210 DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const { 211 DerivedArgList *DAL = new DerivedArgList(Args); 212 213 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib); 214 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs); 215 for (Arg *A : Args) { 216 // Unfortunately, we have to parse some forwarding options (-Xassembler, 217 // -Xlinker, -Xpreprocessor) because we either integrate their functionality 218 // (assembler and preprocessor), or bypass a previous driver ('collect2'). 219 220 // Rewrite linker options, to replace --no-demangle with a custom internal 221 // option. 222 if ((A->getOption().matches(options::OPT_Wl_COMMA) || 223 A->getOption().matches(options::OPT_Xlinker)) && 224 A->containsValue("--no-demangle")) { 225 // Add the rewritten no-demangle argument. 226 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle)); 227 228 // Add the remaining values as Xlinker arguments. 229 for (StringRef Val : A->getValues()) 230 if (Val != "--no-demangle") 231 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val); 232 233 continue; 234 } 235 236 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by 237 // some build systems. We don't try to be complete here because we don't 238 // care to encourage this usage model. 239 if (A->getOption().matches(options::OPT_Wp_COMMA) && 240 (A->getValue(0) == StringRef("-MD") || 241 A->getValue(0) == StringRef("-MMD"))) { 242 // Rewrite to -MD/-MMD along with -MF. 243 if (A->getValue(0) == StringRef("-MD")) 244 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD)); 245 else 246 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD)); 247 if (A->getNumValues() == 2) 248 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF), 249 A->getValue(1)); 250 continue; 251 } 252 253 // Rewrite reserved library names. 254 if (A->getOption().matches(options::OPT_l)) { 255 StringRef Value = A->getValue(); 256 257 // Rewrite unless -nostdlib is present. 258 if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") { 259 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx)); 260 continue; 261 } 262 263 // Rewrite unconditionally. 264 if (Value == "cc_kext") { 265 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext)); 266 continue; 267 } 268 } 269 270 // Pick up inputs via the -- option. 271 if (A->getOption().matches(options::OPT__DASH_DASH)) { 272 A->claim(); 273 for (StringRef Val : A->getValues()) 274 DAL->append(MakeInputArg(*DAL, Opts, Val)); 275 continue; 276 } 277 278 DAL->append(A); 279 } 280 281 // Add a default value of -mlinker-version=, if one was given and the user 282 // didn't specify one. 283 #if defined(HOST_LINK_VERSION) 284 if (!Args.hasArg(options::OPT_mlinker_version_EQ) && 285 strlen(HOST_LINK_VERSION) > 0) { 286 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ), 287 HOST_LINK_VERSION); 288 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim(); 289 } 290 #endif 291 292 return DAL; 293 } 294 295 /// \brief Compute target triple from args. 296 /// 297 /// This routine provides the logic to compute a target triple from various 298 /// args passed to the driver and the default triple string. 299 static llvm::Triple computeTargetTriple(StringRef DefaultTargetTriple, 300 const ArgList &Args, 301 StringRef DarwinArchName = "") { 302 // FIXME: Already done in Compilation *Driver::BuildCompilation 303 if (const Arg *A = Args.getLastArg(options::OPT_target)) 304 DefaultTargetTriple = A->getValue(); 305 306 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple)); 307 308 // Handle Apple-specific options available here. 309 if (Target.isOSBinFormatMachO()) { 310 // If an explict Darwin arch name is given, that trumps all. 311 if (!DarwinArchName.empty()) { 312 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName); 313 return Target; 314 } 315 316 // Handle the Darwin '-arch' flag. 317 if (Arg *A = Args.getLastArg(options::OPT_arch)) { 318 StringRef ArchName = A->getValue(); 319 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName); 320 } 321 } 322 323 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and 324 // '-mbig-endian'/'-EB'. 325 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian, 326 options::OPT_mbig_endian)) { 327 if (A->getOption().matches(options::OPT_mlittle_endian)) { 328 llvm::Triple LE = Target.getLittleEndianArchVariant(); 329 if (LE.getArch() != llvm::Triple::UnknownArch) 330 Target = std::move(LE); 331 } else { 332 llvm::Triple BE = Target.getBigEndianArchVariant(); 333 if (BE.getArch() != llvm::Triple::UnknownArch) 334 Target = std::move(BE); 335 } 336 } 337 338 // Skip further flag support on OSes which don't support '-m32' or '-m64'. 339 if (Target.getArch() == llvm::Triple::tce || 340 Target.getOS() == llvm::Triple::Minix) 341 return Target; 342 343 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'. 344 if (Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32, 345 options::OPT_m32, options::OPT_m16)) { 346 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch; 347 348 if (A->getOption().matches(options::OPT_m64)) { 349 AT = Target.get64BitArchVariant().getArch(); 350 if (Target.getEnvironment() == llvm::Triple::GNUX32) 351 Target.setEnvironment(llvm::Triple::GNU); 352 } else if (A->getOption().matches(options::OPT_mx32) && 353 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) { 354 AT = llvm::Triple::x86_64; 355 Target.setEnvironment(llvm::Triple::GNUX32); 356 } else if (A->getOption().matches(options::OPT_m32)) { 357 AT = Target.get32BitArchVariant().getArch(); 358 if (Target.getEnvironment() == llvm::Triple::GNUX32) 359 Target.setEnvironment(llvm::Triple::GNU); 360 } else if (A->getOption().matches(options::OPT_m16) && 361 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) { 362 AT = llvm::Triple::x86; 363 Target.setEnvironment(llvm::Triple::CODE16); 364 } 365 366 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch()) 367 Target.setArch(AT); 368 } 369 370 return Target; 371 } 372 373 // \brief Parse the LTO options and record the type of LTO compilation 374 // based on which -f(no-)?lto(=.*)? option occurs last. 375 void Driver::setLTOMode(const llvm::opt::ArgList &Args) { 376 LTOMode = LTOK_None; 377 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ, 378 options::OPT_fno_lto, false)) 379 return; 380 381 StringRef LTOName("full"); 382 383 const Arg *A = Args.getLastArg(options::OPT_flto_EQ); 384 if (A) 385 LTOName = A->getValue(); 386 387 LTOMode = llvm::StringSwitch<LTOKind>(LTOName) 388 .Case("full", LTOK_Full) 389 .Case("thin", LTOK_Thin) 390 .Default(LTOK_Unknown); 391 392 if (LTOMode == LTOK_Unknown) { 393 assert(A); 394 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName() 395 << A->getValue(); 396 } 397 } 398 399 Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) { 400 llvm::PrettyStackTraceString CrashInfo("Compilation construction"); 401 402 // FIXME: Handle environment options which affect driver behavior, somewhere 403 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS. 404 405 if (char *env = ::getenv("COMPILER_PATH")) { 406 StringRef CompilerPath = env; 407 while (!CompilerPath.empty()) { 408 std::pair<StringRef, StringRef> Split = 409 CompilerPath.split(llvm::sys::EnvPathSeparator); 410 PrefixDirs.push_back(Split.first); 411 CompilerPath = Split.second; 412 } 413 } 414 415 // We look for the driver mode option early, because the mode can affect 416 // how other options are parsed. 417 ParseDriverMode(ArgList.slice(1)); 418 419 // FIXME: What are we going to do with -V and -b? 420 421 // FIXME: This stuff needs to go into the Compilation, not the driver. 422 bool CCCPrintPhases; 423 424 InputArgList Args = ParseArgStrings(ArgList.slice(1)); 425 426 // Silence driver warnings if requested 427 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w)); 428 429 // -no-canonical-prefixes is used very early in main. 430 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes); 431 432 // Ignore -pipe. 433 Args.ClaimAllArgs(options::OPT_pipe); 434 435 // Extract -ccc args. 436 // 437 // FIXME: We need to figure out where this behavior should live. Most of it 438 // should be outside in the client; the parts that aren't should have proper 439 // options, either by introducing new ones or by overloading gcc ones like -V 440 // or -b. 441 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases); 442 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings); 443 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name)) 444 CCCGenericGCCName = A->getValue(); 445 CCCUsePCH = 446 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth); 447 // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld 448 // and getToolChain is const. 449 if (IsCLMode()) { 450 // clang-cl targets MSVC-style Win32. 451 llvm::Triple T(DefaultTargetTriple); 452 T.setOS(llvm::Triple::Win32); 453 T.setVendor(llvm::Triple::PC); 454 T.setEnvironment(llvm::Triple::MSVC); 455 DefaultTargetTriple = T.str(); 456 } 457 if (const Arg *A = Args.getLastArg(options::OPT_target)) 458 DefaultTargetTriple = A->getValue(); 459 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir)) 460 Dir = InstalledDir = A->getValue(); 461 for (const Arg *A : Args.filtered(options::OPT_B)) { 462 A->claim(); 463 PrefixDirs.push_back(A->getValue(0)); 464 } 465 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ)) 466 SysRoot = A->getValue(); 467 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ)) 468 DyldPrefix = A->getValue(); 469 if (Args.hasArg(options::OPT_nostdlib)) 470 UseStdLib = false; 471 472 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir)) 473 ResourceDir = A->getValue(); 474 475 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) { 476 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue()) 477 .Case("cwd", SaveTempsCwd) 478 .Case("obj", SaveTempsObj) 479 .Default(SaveTempsCwd); 480 } 481 482 // Ignore -fembed-bitcode options with LTO 483 // since the output will be bitcode anyway. 484 if (!Args.hasFlag(options::OPT_flto, options::OPT_fno_lto, false)) { 485 if (Args.hasArg(options::OPT_fembed_bitcode)) 486 BitcodeEmbed = EmbedBitcode; 487 else if (Args.hasArg(options::OPT_fembed_bitcode_marker)) 488 BitcodeEmbed = EmbedMarker; 489 } else { 490 // claim the bitcode option under LTO so no warning is issued. 491 Args.ClaimAllArgs(options::OPT_fembed_bitcode); 492 Args.ClaimAllArgs(options::OPT_fembed_bitcode_marker); 493 } 494 495 setLTOMode(Args); 496 497 std::unique_ptr<llvm::opt::InputArgList> UArgs = 498 llvm::make_unique<InputArgList>(std::move(Args)); 499 500 // Perform the default argument translations. 501 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs); 502 503 // Owned by the host. 504 const ToolChain &TC = 505 getToolChain(*UArgs, computeTargetTriple(DefaultTargetTriple, *UArgs)); 506 507 // The compilation takes ownership of Args. 508 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs); 509 510 if (!HandleImmediateArgs(*C)) 511 return C; 512 513 // Construct the list of inputs. 514 InputList Inputs; 515 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs); 516 517 // Initialize the CUDA device TC only if we have any CUDA Inputs. This is 518 // necessary so that we don't break compilations that pass flags that are 519 // incompatible with the NVPTX TC (e.g. -mthread-model single). 520 if (llvm::any_of(Inputs, [](const std::pair<types::ID, const Arg *> &I) { 521 return I.first == types::TY_CUDA || I.first == types::TY_PP_CUDA || 522 I.first == types::TY_CUDA_DEVICE; 523 })) { 524 C->setCudaDeviceToolChain( 525 &getToolChain(C->getArgs(), llvm::Triple(TC.getTriple().isArch64Bit() 526 ? "nvptx64-nvidia-cuda" 527 : "nvptx-nvidia-cuda"))); 528 } 529 530 // Construct the list of abstract actions to perform for this compilation. On 531 // MachO targets this uses the driver-driver and universal actions. 532 if (TC.getTriple().isOSBinFormatMachO()) 533 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs); 534 else 535 BuildActions(*C, C->getArgs(), Inputs, C->getActions()); 536 537 if (CCCPrintPhases) { 538 PrintActions(*C); 539 return C; 540 } 541 542 BuildJobs(*C); 543 544 return C; 545 } 546 547 static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) { 548 llvm::opt::ArgStringList ASL; 549 for (const auto *A : Args) 550 A->render(Args, ASL); 551 552 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) { 553 if (I != ASL.begin()) 554 OS << ' '; 555 Command::printArg(OS, *I, true); 556 } 557 OS << '\n'; 558 } 559 560 // When clang crashes, produce diagnostic information including the fully 561 // preprocessed source file(s). Request that the developer attach the 562 // diagnostic information to a bug report. 563 void Driver::generateCompilationDiagnostics(Compilation &C, 564 const Command &FailingCommand) { 565 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics)) 566 return; 567 568 // Don't try to generate diagnostics for link or dsymutil jobs. 569 if (FailingCommand.getCreator().isLinkJob() || 570 FailingCommand.getCreator().isDsymutilJob()) 571 return; 572 573 // Print the version of the compiler. 574 PrintVersion(C, llvm::errs()); 575 576 Diag(clang::diag::note_drv_command_failed_diag_msg) 577 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the " 578 "crash backtrace, preprocessed source, and associated run script."; 579 580 // Suppress driver output and emit preprocessor output to temp file. 581 Mode = CPPMode; 582 CCGenDiagnostics = true; 583 584 // Save the original job command(s). 585 Command Cmd = FailingCommand; 586 587 // Keep track of whether we produce any errors while trying to produce 588 // preprocessed sources. 589 DiagnosticErrorTrap Trap(Diags); 590 591 // Suppress tool output. 592 C.initCompilationForDiagnostics(); 593 594 // Construct the list of inputs. 595 InputList Inputs; 596 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs); 597 598 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) { 599 bool IgnoreInput = false; 600 601 // Ignore input from stdin or any inputs that cannot be preprocessed. 602 // Check type first as not all linker inputs have a value. 603 if (types::getPreprocessedType(it->first) == types::TY_INVALID) { 604 IgnoreInput = true; 605 } else if (!strcmp(it->second->getValue(), "-")) { 606 Diag(clang::diag::note_drv_command_failed_diag_msg) 607 << "Error generating preprocessed source(s) - " 608 "ignoring input from stdin."; 609 IgnoreInput = true; 610 } 611 612 if (IgnoreInput) { 613 it = Inputs.erase(it); 614 ie = Inputs.end(); 615 } else { 616 ++it; 617 } 618 } 619 620 if (Inputs.empty()) { 621 Diag(clang::diag::note_drv_command_failed_diag_msg) 622 << "Error generating preprocessed source(s) - " 623 "no preprocessable inputs."; 624 return; 625 } 626 627 // Don't attempt to generate preprocessed files if multiple -arch options are 628 // used, unless they're all duplicates. 629 llvm::StringSet<> ArchNames; 630 for (const Arg *A : C.getArgs()) { 631 if (A->getOption().matches(options::OPT_arch)) { 632 StringRef ArchName = A->getValue(); 633 ArchNames.insert(ArchName); 634 } 635 } 636 if (ArchNames.size() > 1) { 637 Diag(clang::diag::note_drv_command_failed_diag_msg) 638 << "Error generating preprocessed source(s) - cannot generate " 639 "preprocessed source with multiple -arch options."; 640 return; 641 } 642 643 // Construct the list of abstract actions to perform for this compilation. On 644 // Darwin OSes this uses the driver-driver and builds universal actions. 645 const ToolChain &TC = C.getDefaultToolChain(); 646 if (TC.getTriple().isOSBinFormatMachO()) 647 BuildUniversalActions(C, TC, Inputs); 648 else 649 BuildActions(C, C.getArgs(), Inputs, C.getActions()); 650 651 BuildJobs(C); 652 653 // If there were errors building the compilation, quit now. 654 if (Trap.hasErrorOccurred()) { 655 Diag(clang::diag::note_drv_command_failed_diag_msg) 656 << "Error generating preprocessed source(s)."; 657 return; 658 } 659 660 // Generate preprocessed output. 661 SmallVector<std::pair<int, const Command *>, 4> FailingCommands; 662 C.ExecuteJobs(C.getJobs(), FailingCommands); 663 664 // If any of the preprocessing commands failed, clean up and exit. 665 if (!FailingCommands.empty()) { 666 if (!isSaveTempsEnabled()) 667 C.CleanupFileList(C.getTempFiles(), true); 668 669 Diag(clang::diag::note_drv_command_failed_diag_msg) 670 << "Error generating preprocessed source(s)."; 671 return; 672 } 673 674 const ArgStringList &TempFiles = C.getTempFiles(); 675 if (TempFiles.empty()) { 676 Diag(clang::diag::note_drv_command_failed_diag_msg) 677 << "Error generating preprocessed source(s)."; 678 return; 679 } 680 681 Diag(clang::diag::note_drv_command_failed_diag_msg) 682 << "\n********************\n\n" 683 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n" 684 "Preprocessed source(s) and associated run script(s) are located at:"; 685 686 SmallString<128> VFS; 687 for (const char *TempFile : TempFiles) { 688 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile; 689 if (StringRef(TempFile).endswith(".cache")) { 690 // In some cases (modules) we'll dump extra data to help with reproducing 691 // the crash into a directory next to the output. 692 VFS = llvm::sys::path::filename(TempFile); 693 llvm::sys::path::append(VFS, "vfs", "vfs.yaml"); 694 } 695 } 696 697 // Assume associated files are based off of the first temporary file. 698 CrashReportInfo CrashInfo(TempFiles[0], VFS); 699 700 std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh"; 701 std::error_code EC; 702 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl); 703 if (EC) { 704 Diag(clang::diag::note_drv_command_failed_diag_msg) 705 << "Error generating run script: " + Script + " " + EC.message(); 706 } else { 707 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n" 708 << "# Driver args: "; 709 printArgList(ScriptOS, C.getInputArgs()); 710 ScriptOS << "# Original command: "; 711 Cmd.Print(ScriptOS, "\n", /*Quote=*/true); 712 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo); 713 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script; 714 } 715 716 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file, 717 options::OPT_frewrite_map_file_EQ)) 718 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue(); 719 720 Diag(clang::diag::note_drv_command_failed_diag_msg) 721 << "\n\n********************"; 722 } 723 724 void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) { 725 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity 726 // if the tool does not support response files, there is a chance/ that things 727 // will just work without a response file, so we silently just skip it. 728 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None || 729 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments())) 730 return; 731 732 std::string TmpName = GetTemporaryPath("response", "txt"); 733 Cmd.setResponseFile( 734 C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str()))); 735 } 736 737 int Driver::ExecuteCompilation( 738 Compilation &C, 739 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) { 740 // Just print if -### was present. 741 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) { 742 C.getJobs().Print(llvm::errs(), "\n", true); 743 return 0; 744 } 745 746 // If there were errors building the compilation, quit now. 747 if (Diags.hasErrorOccurred()) 748 return 1; 749 750 // Set up response file names for each command, if necessary 751 for (auto &Job : C.getJobs()) 752 setUpResponseFiles(C, Job); 753 754 C.ExecuteJobs(C.getJobs(), FailingCommands); 755 756 // Remove temp files. 757 C.CleanupFileList(C.getTempFiles()); 758 759 // If the command succeeded, we are done. 760 if (FailingCommands.empty()) 761 return 0; 762 763 // Otherwise, remove result files and print extra information about abnormal 764 // failures. 765 for (const auto &CmdPair : FailingCommands) { 766 int Res = CmdPair.first; 767 const Command *FailingCommand = CmdPair.second; 768 769 // Remove result files if we're not saving temps. 770 if (!isSaveTempsEnabled()) { 771 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource()); 772 C.CleanupFileMap(C.getResultFiles(), JA, true); 773 774 // Failure result files are valid unless we crashed. 775 if (Res < 0) 776 C.CleanupFileMap(C.getFailureResultFiles(), JA, true); 777 } 778 779 // Print extra information about abnormal failures, if possible. 780 // 781 // This is ad-hoc, but we don't want to be excessively noisy. If the result 782 // status was 1, assume the command failed normally. In particular, if it 783 // was the compiler then assume it gave a reasonable error code. Failures 784 // in other tools are less common, and they generally have worse 785 // diagnostics, so always print the diagnostic there. 786 const Tool &FailingTool = FailingCommand->getCreator(); 787 788 if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) { 789 // FIXME: See FIXME above regarding result code interpretation. 790 if (Res < 0) 791 Diag(clang::diag::err_drv_command_signalled) 792 << FailingTool.getShortName(); 793 else 794 Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName() 795 << Res; 796 } 797 } 798 return 0; 799 } 800 801 void Driver::PrintHelp(bool ShowHidden) const { 802 unsigned IncludedFlagsBitmask; 803 unsigned ExcludedFlagsBitmask; 804 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) = 805 getIncludeExcludeOptionFlagMasks(); 806 807 ExcludedFlagsBitmask |= options::NoDriverOption; 808 if (!ShowHidden) 809 ExcludedFlagsBitmask |= HelpHidden; 810 811 getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(), 812 IncludedFlagsBitmask, ExcludedFlagsBitmask); 813 } 814 815 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const { 816 // FIXME: The following handlers should use a callback mechanism, we don't 817 // know what the client would like to do. 818 OS << getClangFullVersion() << '\n'; 819 const ToolChain &TC = C.getDefaultToolChain(); 820 OS << "Target: " << TC.getTripleString() << '\n'; 821 822 // Print the threading model. 823 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) { 824 // Don't print if the ToolChain would have barfed on it already 825 if (TC.isThreadModelSupported(A->getValue())) 826 OS << "Thread model: " << A->getValue(); 827 } else 828 OS << "Thread model: " << TC.getThreadModel(); 829 OS << '\n'; 830 831 // Print out the install directory. 832 OS << "InstalledDir: " << InstalledDir << '\n'; 833 } 834 835 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories 836 /// option. 837 static void PrintDiagnosticCategories(raw_ostream &OS) { 838 // Skip the empty category. 839 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max; 840 ++i) 841 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n'; 842 } 843 844 bool Driver::HandleImmediateArgs(const Compilation &C) { 845 // The order these options are handled in gcc is all over the place, but we 846 // don't expect inconsistencies w.r.t. that to matter in practice. 847 848 if (C.getArgs().hasArg(options::OPT_dumpmachine)) { 849 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n'; 850 return false; 851 } 852 853 if (C.getArgs().hasArg(options::OPT_dumpversion)) { 854 // Since -dumpversion is only implemented for pedantic GCC compatibility, we 855 // return an answer which matches our definition of __VERSION__. 856 // 857 // If we want to return a more correct answer some day, then we should 858 // introduce a non-pedantically GCC compatible mode to Clang in which we 859 // provide sensible definitions for -dumpversion, __VERSION__, etc. 860 llvm::outs() << "4.2.1\n"; 861 return false; 862 } 863 864 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) { 865 PrintDiagnosticCategories(llvm::outs()); 866 return false; 867 } 868 869 if (C.getArgs().hasArg(options::OPT_help) || 870 C.getArgs().hasArg(options::OPT__help_hidden)) { 871 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden)); 872 return false; 873 } 874 875 if (C.getArgs().hasArg(options::OPT__version)) { 876 // Follow gcc behavior and use stdout for --version and stderr for -v. 877 PrintVersion(C, llvm::outs()); 878 return false; 879 } 880 881 if (C.getArgs().hasArg(options::OPT_v) || 882 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) { 883 PrintVersion(C, llvm::errs()); 884 SuppressMissingInputWarning = true; 885 } 886 887 const ToolChain &TC = C.getDefaultToolChain(); 888 889 if (C.getArgs().hasArg(options::OPT_v)) 890 TC.printVerboseInfo(llvm::errs()); 891 892 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) { 893 llvm::outs() << "programs: ="; 894 bool separator = false; 895 for (const std::string &Path : TC.getProgramPaths()) { 896 if (separator) 897 llvm::outs() << ':'; 898 llvm::outs() << Path; 899 separator = true; 900 } 901 llvm::outs() << "\n"; 902 llvm::outs() << "libraries: =" << ResourceDir; 903 904 StringRef sysroot = C.getSysRoot(); 905 906 for (const std::string &Path : TC.getFilePaths()) { 907 // Always print a separator. ResourceDir was the first item shown. 908 llvm::outs() << ':'; 909 // Interpretation of leading '=' is needed only for NetBSD. 910 if (Path[0] == '=') 911 llvm::outs() << sysroot << Path.substr(1); 912 else 913 llvm::outs() << Path; 914 } 915 llvm::outs() << "\n"; 916 return false; 917 } 918 919 // FIXME: The following handlers should use a callback mechanism, we don't 920 // know what the client would like to do. 921 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) { 922 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n"; 923 return false; 924 } 925 926 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) { 927 llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n"; 928 return false; 929 } 930 931 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) { 932 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n"; 933 return false; 934 } 935 936 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) { 937 for (const Multilib &Multilib : TC.getMultilibs()) 938 llvm::outs() << Multilib << "\n"; 939 return false; 940 } 941 942 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) { 943 for (const Multilib &Multilib : TC.getMultilibs()) { 944 if (Multilib.gccSuffix().empty()) 945 llvm::outs() << ".\n"; 946 else { 947 StringRef Suffix(Multilib.gccSuffix()); 948 assert(Suffix.front() == '/'); 949 llvm::outs() << Suffix.substr(1) << "\n"; 950 } 951 } 952 return false; 953 } 954 return true; 955 } 956 957 // Display an action graph human-readably. Action A is the "sink" node 958 // and latest-occuring action. Traversal is in pre-order, visiting the 959 // inputs to each action before printing the action itself. 960 static unsigned PrintActions1(const Compilation &C, Action *A, 961 std::map<Action *, unsigned> &Ids) { 962 if (Ids.count(A)) // A was already visited. 963 return Ids[A]; 964 965 std::string str; 966 llvm::raw_string_ostream os(str); 967 968 os << Action::getClassName(A->getKind()) << ", "; 969 if (InputAction *IA = dyn_cast<InputAction>(A)) { 970 os << "\"" << IA->getInputArg().getValue() << "\""; 971 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) { 972 os << '"' << BIA->getArchName() << '"' << ", {" 973 << PrintActions1(C, *BIA->input_begin(), Ids) << "}"; 974 } else if (CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) { 975 os << '"' 976 << (CDA->getGpuArchName() ? CDA->getGpuArchName() : "(multiple archs)") 977 << '"' << ", {" << PrintActions1(C, *CDA->input_begin(), Ids) << "}"; 978 } else { 979 const ActionList *AL; 980 if (CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) { 981 os << "{" << PrintActions1(C, *CHA->input_begin(), Ids) << "}" 982 << ", gpu binaries "; 983 AL = &CHA->getDeviceActions(); 984 } else 985 AL = &A->getInputs(); 986 987 if (AL->size()) { 988 const char *Prefix = "{"; 989 for (Action *PreRequisite : *AL) { 990 os << Prefix << PrintActions1(C, PreRequisite, Ids); 991 Prefix = ", "; 992 } 993 os << "}"; 994 } else 995 os << "{}"; 996 } 997 998 unsigned Id = Ids.size(); 999 Ids[A] = Id; 1000 llvm::errs() << Id << ": " << os.str() << ", " 1001 << types::getTypeName(A->getType()) << "\n"; 1002 1003 return Id; 1004 } 1005 1006 // Print the action graphs in a compilation C. 1007 // For example "clang -c file1.c file2.c" is composed of two subgraphs. 1008 void Driver::PrintActions(const Compilation &C) const { 1009 std::map<Action *, unsigned> Ids; 1010 for (Action *A : C.getActions()) 1011 PrintActions1(C, A, Ids); 1012 } 1013 1014 /// \brief Check whether the given input tree contains any compilation or 1015 /// assembly actions. 1016 static bool ContainsCompileOrAssembleAction(const Action *A) { 1017 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) || 1018 isa<AssembleJobAction>(A)) 1019 return true; 1020 1021 for (const Action *Input : A->inputs()) 1022 if (ContainsCompileOrAssembleAction(Input)) 1023 return true; 1024 1025 return false; 1026 } 1027 1028 void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC, 1029 const InputList &BAInputs) const { 1030 DerivedArgList &Args = C.getArgs(); 1031 ActionList &Actions = C.getActions(); 1032 llvm::PrettyStackTraceString CrashInfo("Building universal build actions"); 1033 // Collect the list of architectures. Duplicates are allowed, but should only 1034 // be handled once (in the order seen). 1035 llvm::StringSet<> ArchNames; 1036 SmallVector<const char *, 4> Archs; 1037 for (Arg *A : Args) { 1038 if (A->getOption().matches(options::OPT_arch)) { 1039 // Validate the option here; we don't save the type here because its 1040 // particular spelling may participate in other driver choices. 1041 llvm::Triple::ArchType Arch = 1042 tools::darwin::getArchTypeForMachOArchName(A->getValue()); 1043 if (Arch == llvm::Triple::UnknownArch) { 1044 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args); 1045 continue; 1046 } 1047 1048 A->claim(); 1049 if (ArchNames.insert(A->getValue()).second) 1050 Archs.push_back(A->getValue()); 1051 } 1052 } 1053 1054 // When there is no explicit arch for this platform, make sure we still bind 1055 // the architecture (to the default) so that -Xarch_ is handled correctly. 1056 if (!Archs.size()) 1057 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName())); 1058 1059 ActionList SingleActions; 1060 BuildActions(C, Args, BAInputs, SingleActions); 1061 1062 // Add in arch bindings for every top level action, as well as lipo and 1063 // dsymutil steps if needed. 1064 for (Action* Act : SingleActions) { 1065 // Make sure we can lipo this kind of output. If not (and it is an actual 1066 // output) then we disallow, since we can't create an output file with the 1067 // right name without overwriting it. We could remove this oddity by just 1068 // changing the output names to include the arch, which would also fix 1069 // -save-temps. Compatibility wins for now. 1070 1071 if (Archs.size() > 1 && !types::canLipoType(Act->getType())) 1072 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs) 1073 << types::getTypeName(Act->getType()); 1074 1075 ActionList Inputs; 1076 for (unsigned i = 0, e = Archs.size(); i != e; ++i) 1077 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i])); 1078 1079 // Lipo if necessary, we do it this way because we need to set the arch flag 1080 // so that -Xarch_ gets overwritten. 1081 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing) 1082 Actions.append(Inputs.begin(), Inputs.end()); 1083 else 1084 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType())); 1085 1086 // Handle debug info queries. 1087 Arg *A = Args.getLastArg(options::OPT_g_Group); 1088 if (A && !A->getOption().matches(options::OPT_g0) && 1089 !A->getOption().matches(options::OPT_gstabs) && 1090 ContainsCompileOrAssembleAction(Actions.back())) { 1091 1092 // Add a 'dsymutil' step if necessary, when debug info is enabled and we 1093 // have a compile input. We need to run 'dsymutil' ourselves in such cases 1094 // because the debug info will refer to a temporary object file which 1095 // will be removed at the end of the compilation process. 1096 if (Act->getType() == types::TY_Image) { 1097 ActionList Inputs; 1098 Inputs.push_back(Actions.back()); 1099 Actions.pop_back(); 1100 Actions.push_back( 1101 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM)); 1102 } 1103 1104 // Verify the debug info output. 1105 if (Args.hasArg(options::OPT_verify_debug_info)) { 1106 Action* LastAction = Actions.back(); 1107 Actions.pop_back(); 1108 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>( 1109 LastAction, types::TY_Nothing)); 1110 } 1111 } 1112 } 1113 } 1114 1115 /// \brief Check that the file referenced by Value exists. If it doesn't, 1116 /// issue a diagnostic and return false. 1117 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args, 1118 StringRef Value, types::ID Ty) { 1119 if (!D.getCheckInputsExist()) 1120 return true; 1121 1122 // stdin always exists. 1123 if (Value == "-") 1124 return true; 1125 1126 SmallString<64> Path(Value); 1127 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) { 1128 if (!llvm::sys::path::is_absolute(Path)) { 1129 SmallString<64> Directory(WorkDir->getValue()); 1130 llvm::sys::path::append(Directory, Value); 1131 Path.assign(Directory); 1132 } 1133 } 1134 1135 if (llvm::sys::fs::exists(Twine(Path))) 1136 return true; 1137 1138 if (D.IsCLMode()) { 1139 if (!llvm::sys::path::is_absolute(Twine(Path)) && 1140 llvm::sys::Process::FindInEnvPath("LIB", Value)) 1141 return true; 1142 1143 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) { 1144 // Arguments to the /link flag might cause the linker to search for object 1145 // and library files in paths we don't know about. Don't error in such 1146 // cases. 1147 return true; 1148 } 1149 } 1150 1151 D.Diag(clang::diag::err_drv_no_such_file) << Path; 1152 return false; 1153 } 1154 1155 // Construct a the list of inputs and their types. 1156 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args, 1157 InputList &Inputs) const { 1158 // Track the current user specified (-x) input. We also explicitly track the 1159 // argument used to set the type; we only want to claim the type when we 1160 // actually use it, so we warn about unused -x arguments. 1161 types::ID InputType = types::TY_Nothing; 1162 Arg *InputTypeArg = nullptr; 1163 1164 // The last /TC or /TP option sets the input type to C or C++ globally. 1165 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC, 1166 options::OPT__SLASH_TP)) { 1167 InputTypeArg = TCTP; 1168 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC) 1169 ? types::TY_C 1170 : types::TY_CXX; 1171 1172 arg_iterator it = 1173 Args.filtered_begin(options::OPT__SLASH_TC, options::OPT__SLASH_TP); 1174 const arg_iterator ie = Args.filtered_end(); 1175 Arg *Previous = *it++; 1176 bool ShowNote = false; 1177 while (it != ie) { 1178 Diag(clang::diag::warn_drv_overriding_flag_option) 1179 << Previous->getSpelling() << (*it)->getSpelling(); 1180 Previous = *it++; 1181 ShowNote = true; 1182 } 1183 if (ShowNote) 1184 Diag(clang::diag::note_drv_t_option_is_global); 1185 1186 // No driver mode exposes -x and /TC or /TP; we don't support mixing them. 1187 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed"); 1188 } 1189 1190 for (Arg *A : Args) { 1191 if (A->getOption().getKind() == Option::InputClass) { 1192 const char *Value = A->getValue(); 1193 types::ID Ty = types::TY_INVALID; 1194 1195 // Infer the input type if necessary. 1196 if (InputType == types::TY_Nothing) { 1197 // If there was an explicit arg for this, claim it. 1198 if (InputTypeArg) 1199 InputTypeArg->claim(); 1200 1201 // stdin must be handled specially. 1202 if (memcmp(Value, "-", 2) == 0) { 1203 // If running with -E, treat as a C input (this changes the builtin 1204 // macros, for example). This may be overridden by -ObjC below. 1205 // 1206 // Otherwise emit an error but still use a valid type to avoid 1207 // spurious errors (e.g., no inputs). 1208 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP()) 1209 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl 1210 : clang::diag::err_drv_unknown_stdin_type); 1211 Ty = types::TY_C; 1212 } else { 1213 // Otherwise lookup by extension. 1214 // Fallback is C if invoked as C preprocessor or Object otherwise. 1215 // We use a host hook here because Darwin at least has its own 1216 // idea of what .s is. 1217 if (const char *Ext = strrchr(Value, '.')) 1218 Ty = TC.LookupTypeForExtension(Ext + 1); 1219 1220 if (Ty == types::TY_INVALID) { 1221 if (CCCIsCPP()) 1222 Ty = types::TY_C; 1223 else 1224 Ty = types::TY_Object; 1225 } 1226 1227 // If the driver is invoked as C++ compiler (like clang++ or c++) it 1228 // should autodetect some input files as C++ for g++ compatibility. 1229 if (CCCIsCXX()) { 1230 types::ID OldTy = Ty; 1231 Ty = types::lookupCXXTypeForCType(Ty); 1232 1233 if (Ty != OldTy) 1234 Diag(clang::diag::warn_drv_treating_input_as_cxx) 1235 << getTypeName(OldTy) << getTypeName(Ty); 1236 } 1237 } 1238 1239 // -ObjC and -ObjC++ override the default language, but only for "source 1240 // files". We just treat everything that isn't a linker input as a 1241 // source file. 1242 // 1243 // FIXME: Clean this up if we move the phase sequence into the type. 1244 if (Ty != types::TY_Object) { 1245 if (Args.hasArg(options::OPT_ObjC)) 1246 Ty = types::TY_ObjC; 1247 else if (Args.hasArg(options::OPT_ObjCXX)) 1248 Ty = types::TY_ObjCXX; 1249 } 1250 } else { 1251 assert(InputTypeArg && "InputType set w/o InputTypeArg"); 1252 if (!InputTypeArg->getOption().matches(options::OPT_x)) { 1253 // If emulating cl.exe, make sure that /TC and /TP don't affect input 1254 // object files. 1255 const char *Ext = strrchr(Value, '.'); 1256 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object) 1257 Ty = types::TY_Object; 1258 } 1259 if (Ty == types::TY_INVALID) { 1260 Ty = InputType; 1261 InputTypeArg->claim(); 1262 } 1263 } 1264 1265 if (DiagnoseInputExistence(*this, Args, Value, Ty)) 1266 Inputs.push_back(std::make_pair(Ty, A)); 1267 1268 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) { 1269 StringRef Value = A->getValue(); 1270 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) { 1271 Arg *InputArg = MakeInputArg(Args, Opts, A->getValue()); 1272 Inputs.push_back(std::make_pair(types::TY_C, InputArg)); 1273 } 1274 A->claim(); 1275 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) { 1276 StringRef Value = A->getValue(); 1277 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) { 1278 Arg *InputArg = MakeInputArg(Args, Opts, A->getValue()); 1279 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg)); 1280 } 1281 A->claim(); 1282 } else if (A->getOption().hasFlag(options::LinkerInput)) { 1283 // Just treat as object type, we could make a special type for this if 1284 // necessary. 1285 Inputs.push_back(std::make_pair(types::TY_Object, A)); 1286 1287 } else if (A->getOption().matches(options::OPT_x)) { 1288 InputTypeArg = A; 1289 InputType = types::lookupTypeForTypeSpecifier(A->getValue()); 1290 A->claim(); 1291 1292 // Follow gcc behavior and treat as linker input for invalid -x 1293 // options. Its not clear why we shouldn't just revert to unknown; but 1294 // this isn't very important, we might as well be bug compatible. 1295 if (!InputType) { 1296 Diag(clang::diag::err_drv_unknown_language) << A->getValue(); 1297 InputType = types::TY_Object; 1298 } 1299 } 1300 } 1301 if (CCCIsCPP() && Inputs.empty()) { 1302 // If called as standalone preprocessor, stdin is processed 1303 // if no other input is present. 1304 Arg *A = MakeInputArg(Args, Opts, "-"); 1305 Inputs.push_back(std::make_pair(types::TY_C, A)); 1306 } 1307 } 1308 1309 // For each unique --cuda-gpu-arch= argument creates a TY_CUDA_DEVICE 1310 // input action and then wraps each in CudaDeviceAction paired with 1311 // appropriate GPU arch name. In case of partial (i.e preprocessing 1312 // only) or device-only compilation, each device action is added to /p 1313 // Actions and /p Current is released. Otherwise the function creates 1314 // and returns a new CudaHostAction which wraps /p Current and device 1315 // side actions. 1316 static Action *buildCudaActions(Compilation &C, DerivedArgList &Args, 1317 const Arg *InputArg, Action *HostAction, 1318 ActionList &Actions) { 1319 Arg *PartialCompilationArg = Args.getLastArg( 1320 options::OPT_cuda_host_only, options::OPT_cuda_device_only, 1321 options::OPT_cuda_compile_host_device); 1322 bool CompileHostOnly = 1323 PartialCompilationArg && 1324 PartialCompilationArg->getOption().matches(options::OPT_cuda_host_only); 1325 bool CompileDeviceOnly = 1326 PartialCompilationArg && 1327 PartialCompilationArg->getOption().matches(options::OPT_cuda_device_only); 1328 1329 if (CompileHostOnly) 1330 return C.MakeAction<CudaHostAction>(HostAction, ActionList()); 1331 1332 // Collect all cuda_gpu_arch parameters, removing duplicates. 1333 SmallVector<const char *, 4> GpuArchList; 1334 llvm::StringSet<> GpuArchNames; 1335 for (Arg *A : Args) { 1336 if (!A->getOption().matches(options::OPT_cuda_gpu_arch_EQ)) 1337 continue; 1338 A->claim(); 1339 1340 const auto& Arch = A->getValue(); 1341 if (!CudaDeviceAction::IsValidGpuArchName(Arch)) 1342 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << Arch; 1343 else if (GpuArchNames.insert(Arch).second) 1344 GpuArchList.push_back(Arch); 1345 } 1346 1347 // Default to sm_20 which is the lowest common denominator for supported GPUs. 1348 // sm_20 code should work correctly, if suboptimally, on all newer GPUs. 1349 if (GpuArchList.empty()) 1350 GpuArchList.push_back("sm_20"); 1351 1352 // Replicate inputs for each GPU architecture. 1353 Driver::InputList CudaDeviceInputs; 1354 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) 1355 CudaDeviceInputs.push_back(std::make_pair(types::TY_CUDA_DEVICE, InputArg)); 1356 1357 // Build actions for all device inputs. 1358 assert(C.getCudaDeviceToolChain() && 1359 "Missing toolchain for device-side compilation."); 1360 ActionList CudaDeviceActions; 1361 C.getDriver().BuildActions(C, Args, CudaDeviceInputs, CudaDeviceActions); 1362 assert(GpuArchList.size() == CudaDeviceActions.size() && 1363 "Failed to create actions for all devices"); 1364 1365 // Check whether any of device actions stopped before they could generate PTX. 1366 bool PartialCompilation = 1367 llvm::any_of(CudaDeviceActions, [](const Action *a) { 1368 return a->getKind() != Action::AssembleJobClass; 1369 }); 1370 1371 // Figure out what to do with device actions -- pass them as inputs to the 1372 // host action or run each of them independently. 1373 if (PartialCompilation || CompileDeviceOnly) { 1374 // In case of partial or device-only compilation results of device actions 1375 // are not consumed by the host action device actions have to be added to 1376 // top-level actions list with AtTopLevel=true and run independently. 1377 1378 // -o is ambiguous if we have more than one top-level action. 1379 if (Args.hasArg(options::OPT_o) && 1380 (!CompileDeviceOnly || GpuArchList.size() > 1)) { 1381 C.getDriver().Diag( 1382 clang::diag::err_drv_output_argument_with_multiple_files); 1383 return nullptr; 1384 } 1385 1386 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) 1387 Actions.push_back(C.MakeAction<CudaDeviceAction>(CudaDeviceActions[I], 1388 GpuArchList[I], 1389 /* AtTopLevel */ true)); 1390 // Kill host action in case of device-only compilation. 1391 if (CompileDeviceOnly) 1392 return nullptr; 1393 return HostAction; 1394 } 1395 1396 // If we're not a partial or device-only compilation, we compile each arch to 1397 // ptx and assemble to cubin, then feed the cubin *and* the ptx into a device 1398 // "link" action, which uses fatbinary to combine these cubins into one 1399 // fatbin. The fatbin is then an input to the host compilation. 1400 ActionList DeviceActions; 1401 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) { 1402 Action* AssembleAction = CudaDeviceActions[I]; 1403 assert(AssembleAction->getType() == types::TY_Object); 1404 assert(AssembleAction->getInputs().size() == 1); 1405 1406 Action* BackendAction = AssembleAction->getInputs()[0]; 1407 assert(BackendAction->getType() == types::TY_PP_Asm); 1408 1409 for (const auto& A : {AssembleAction, BackendAction}) { 1410 DeviceActions.push_back(C.MakeAction<CudaDeviceAction>( 1411 A, GpuArchList[I], /* AtTopLevel */ false)); 1412 } 1413 } 1414 auto FatbinAction = C.MakeAction<CudaDeviceAction>( 1415 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN), 1416 /* GpuArchName = */ nullptr, 1417 /* AtTopLevel = */ false); 1418 // Return a new host action that incorporates original host action and all 1419 // device actions. 1420 return C.MakeAction<CudaHostAction>(std::move(HostAction), 1421 ActionList({FatbinAction})); 1422 } 1423 1424 void Driver::BuildActions(Compilation &C, DerivedArgList &Args, 1425 const InputList &Inputs, ActionList &Actions) const { 1426 llvm::PrettyStackTraceString CrashInfo("Building compilation actions"); 1427 1428 if (!SuppressMissingInputWarning && Inputs.empty()) { 1429 Diag(clang::diag::err_drv_no_input_files); 1430 return; 1431 } 1432 1433 Arg *FinalPhaseArg; 1434 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg); 1435 1436 if (FinalPhase == phases::Link && Args.hasArg(options::OPT_emit_llvm)) { 1437 Diag(clang::diag::err_drv_emit_llvm_link); 1438 } 1439 1440 // Reject -Z* at the top level, these options should never have been exposed 1441 // by gcc. 1442 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined)) 1443 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args); 1444 1445 // Diagnose misuse of /Fo. 1446 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) { 1447 StringRef V = A->getValue(); 1448 if (Inputs.size() > 1 && !V.empty() && 1449 !llvm::sys::path::is_separator(V.back())) { 1450 // Check whether /Fo tries to name an output file for multiple inputs. 1451 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources) 1452 << A->getSpelling() << V; 1453 Args.eraseArg(options::OPT__SLASH_Fo); 1454 } 1455 } 1456 1457 // Diagnose misuse of /Fa. 1458 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) { 1459 StringRef V = A->getValue(); 1460 if (Inputs.size() > 1 && !V.empty() && 1461 !llvm::sys::path::is_separator(V.back())) { 1462 // Check whether /Fa tries to name an asm file for multiple inputs. 1463 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources) 1464 << A->getSpelling() << V; 1465 Args.eraseArg(options::OPT__SLASH_Fa); 1466 } 1467 } 1468 1469 // Diagnose misuse of /o. 1470 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) { 1471 if (A->getValue()[0] == '\0') { 1472 // It has to have a value. 1473 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1; 1474 Args.eraseArg(options::OPT__SLASH_o); 1475 } 1476 } 1477 1478 // Diagnose unsupported forms of /Yc /Yu. Ignore /Yc/Yu for now if: 1479 // * no filename after it 1480 // * both /Yc and /Yu passed but with different filenames 1481 // * corresponding file not also passed as /FI 1482 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc); 1483 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu); 1484 if (YcArg && YcArg->getValue()[0] == '\0') { 1485 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YcArg->getSpelling(); 1486 Args.eraseArg(options::OPT__SLASH_Yc); 1487 YcArg = nullptr; 1488 } 1489 if (YuArg && YuArg->getValue()[0] == '\0') { 1490 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YuArg->getSpelling(); 1491 Args.eraseArg(options::OPT__SLASH_Yu); 1492 YuArg = nullptr; 1493 } 1494 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) { 1495 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl); 1496 Args.eraseArg(options::OPT__SLASH_Yc); 1497 Args.eraseArg(options::OPT__SLASH_Yu); 1498 YcArg = YuArg = nullptr; 1499 } 1500 if (YcArg || YuArg) { 1501 StringRef Val = YcArg ? YcArg->getValue() : YuArg->getValue(); 1502 bool FoundMatchingInclude = false; 1503 for (const Arg *Inc : Args.filtered(options::OPT_include)) { 1504 // FIXME: Do case-insensitive matching and consider / and \ as equal. 1505 if (Inc->getValue() == Val) 1506 FoundMatchingInclude = true; 1507 } 1508 if (!FoundMatchingInclude) { 1509 Diag(clang::diag::warn_drv_ycyu_no_fi_arg_clang_cl) 1510 << (YcArg ? YcArg : YuArg)->getSpelling(); 1511 Args.eraseArg(options::OPT__SLASH_Yc); 1512 Args.eraseArg(options::OPT__SLASH_Yu); 1513 YcArg = YuArg = nullptr; 1514 } 1515 } 1516 if (YcArg && Inputs.size() > 1) { 1517 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl); 1518 Args.eraseArg(options::OPT__SLASH_Yc); 1519 YcArg = nullptr; 1520 } 1521 if (Args.hasArg(options::OPT__SLASH_Y_)) { 1522 // /Y- disables all pch handling. Rather than check for it everywhere, 1523 // just remove clang-cl pch-related flags here. 1524 Args.eraseArg(options::OPT__SLASH_Fp); 1525 Args.eraseArg(options::OPT__SLASH_Yc); 1526 Args.eraseArg(options::OPT__SLASH_Yu); 1527 YcArg = YuArg = nullptr; 1528 } 1529 1530 // Construct the actions to perform. 1531 ActionList LinkerInputs; 1532 1533 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL; 1534 for (auto &I : Inputs) { 1535 types::ID InputType = I.first; 1536 const Arg *InputArg = I.second; 1537 1538 PL.clear(); 1539 types::getCompilationPhases(InputType, PL); 1540 1541 if (YcArg) { 1542 // Add a separate precompile phase for the compile phase. 1543 if (FinalPhase >= phases::Compile) { 1544 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL; 1545 types::getCompilationPhases(types::TY_CXXHeader, PCHPL); 1546 Arg *PchInputArg = MakeInputArg(Args, Opts, YcArg->getValue()); 1547 1548 // Build the pipeline for the pch file. 1549 Action *ClangClPch = C.MakeAction<InputAction>(*PchInputArg, InputType); 1550 for (phases::ID Phase : PCHPL) 1551 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch); 1552 assert(ClangClPch); 1553 Actions.push_back(ClangClPch); 1554 // The driver currently exits after the first failed command. This 1555 // relies on that behavior, to make sure if the pch generation fails, 1556 // the main compilation won't run. 1557 } 1558 } 1559 1560 // If the first step comes after the final phase we are doing as part of 1561 // this compilation, warn the user about it. 1562 phases::ID InitialPhase = PL[0]; 1563 if (InitialPhase > FinalPhase) { 1564 // Claim here to avoid the more general unused warning. 1565 InputArg->claim(); 1566 1567 // Suppress all unused style warnings with -Qunused-arguments 1568 if (Args.hasArg(options::OPT_Qunused_arguments)) 1569 continue; 1570 1571 // Special case when final phase determined by binary name, rather than 1572 // by a command-line argument with a corresponding Arg. 1573 if (CCCIsCPP()) 1574 Diag(clang::diag::warn_drv_input_file_unused_by_cpp) 1575 << InputArg->getAsString(Args) << getPhaseName(InitialPhase); 1576 // Special case '-E' warning on a previously preprocessed file to make 1577 // more sense. 1578 else if (InitialPhase == phases::Compile && 1579 FinalPhase == phases::Preprocess && 1580 getPreprocessedType(InputType) == types::TY_INVALID) 1581 Diag(clang::diag::warn_drv_preprocessed_input_file_unused) 1582 << InputArg->getAsString(Args) << !!FinalPhaseArg 1583 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : ""); 1584 else 1585 Diag(clang::diag::warn_drv_input_file_unused) 1586 << InputArg->getAsString(Args) << getPhaseName(InitialPhase) 1587 << !!FinalPhaseArg 1588 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : ""); 1589 continue; 1590 } 1591 1592 phases::ID CudaInjectionPhase = 1593 (phases::Compile < FinalPhase && 1594 llvm::find(PL, phases::Compile) != PL.end()) 1595 ? phases::Compile 1596 : FinalPhase; 1597 1598 // Build the pipeline for this file. 1599 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType); 1600 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end(); 1601 i != e; ++i) { 1602 phases::ID Phase = *i; 1603 1604 // We are done if this step is past what the user requested. 1605 if (Phase > FinalPhase) 1606 break; 1607 1608 // Queue linker inputs. 1609 if (Phase == phases::Link) { 1610 assert((i + 1) == e && "linking must be final compilation step."); 1611 LinkerInputs.push_back(Current); 1612 Current = nullptr; 1613 break; 1614 } 1615 1616 // Some types skip the assembler phase (e.g., llvm-bc), but we can't 1617 // encode this in the steps because the intermediate type depends on 1618 // arguments. Just special case here. 1619 if (Phase == phases::Assemble && Current->getType() != types::TY_PP_Asm) 1620 continue; 1621 1622 // Otherwise construct the appropriate action. 1623 Current = ConstructPhaseAction(C, Args, Phase, Current); 1624 1625 if (InputType == types::TY_CUDA && Phase == CudaInjectionPhase) { 1626 Current = buildCudaActions(C, Args, InputArg, Current, Actions); 1627 if (!Current) 1628 break; 1629 } 1630 1631 if (Current->getType() == types::TY_Nothing) 1632 break; 1633 } 1634 1635 // If we ended with something, add to the output list. 1636 if (Current) 1637 Actions.push_back(Current); 1638 } 1639 1640 // Add a link action if necessary. 1641 if (!LinkerInputs.empty()) 1642 Actions.push_back( 1643 C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image)); 1644 1645 // If we are linking, claim any options which are obviously only used for 1646 // compilation. 1647 if (FinalPhase == phases::Link && PL.size() == 1) { 1648 Args.ClaimAllArgs(options::OPT_CompileOnly_Group); 1649 Args.ClaimAllArgs(options::OPT_cl_compile_Group); 1650 } 1651 1652 // Claim ignored clang-cl options. 1653 Args.ClaimAllArgs(options::OPT_cl_ignored_Group); 1654 1655 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed 1656 // to non-CUDA compilations and should not trigger warnings there. 1657 Args.ClaimAllArgs(options::OPT_cuda_host_only); 1658 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device); 1659 } 1660 1661 Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args, 1662 phases::ID Phase, Action *Input) const { 1663 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions"); 1664 // Build the appropriate action. 1665 switch (Phase) { 1666 case phases::Link: 1667 llvm_unreachable("link action invalid here."); 1668 case phases::Preprocess: { 1669 types::ID OutputTy; 1670 // -{M, MM} alter the output type. 1671 if (Args.hasArg(options::OPT_M, options::OPT_MM)) { 1672 OutputTy = types::TY_Dependencies; 1673 } else { 1674 OutputTy = Input->getType(); 1675 if (!Args.hasFlag(options::OPT_frewrite_includes, 1676 options::OPT_fno_rewrite_includes, false) && 1677 !CCGenDiagnostics) 1678 OutputTy = types::getPreprocessedType(OutputTy); 1679 assert(OutputTy != types::TY_INVALID && 1680 "Cannot preprocess this input type!"); 1681 } 1682 return C.MakeAction<PreprocessJobAction>(Input, OutputTy); 1683 } 1684 case phases::Precompile: { 1685 types::ID OutputTy = types::TY_PCH; 1686 if (Args.hasArg(options::OPT_fsyntax_only)) { 1687 // Syntax checks should not emit a PCH file 1688 OutputTy = types::TY_Nothing; 1689 } 1690 return C.MakeAction<PrecompileJobAction>(Input, OutputTy); 1691 } 1692 case phases::Compile: { 1693 if (Args.hasArg(options::OPT_fsyntax_only)) 1694 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing); 1695 if (Args.hasArg(options::OPT_rewrite_objc)) 1696 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC); 1697 if (Args.hasArg(options::OPT_rewrite_legacy_objc)) 1698 return C.MakeAction<CompileJobAction>(Input, 1699 types::TY_RewrittenLegacyObjC); 1700 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto)) 1701 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist); 1702 if (Args.hasArg(options::OPT__migrate)) 1703 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap); 1704 if (Args.hasArg(options::OPT_emit_ast)) 1705 return C.MakeAction<CompileJobAction>(Input, types::TY_AST); 1706 if (Args.hasArg(options::OPT_module_file_info)) 1707 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile); 1708 if (Args.hasArg(options::OPT_verify_pch)) 1709 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing); 1710 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC); 1711 } 1712 case phases::Backend: { 1713 if (isUsingLTO()) { 1714 types::ID Output = 1715 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC; 1716 return C.MakeAction<BackendJobAction>(Input, Output); 1717 } 1718 if (Args.hasArg(options::OPT_emit_llvm)) { 1719 types::ID Output = 1720 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC; 1721 return C.MakeAction<BackendJobAction>(Input, Output); 1722 } 1723 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm); 1724 } 1725 case phases::Assemble: 1726 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object); 1727 } 1728 1729 llvm_unreachable("invalid phase in ConstructPhaseAction"); 1730 } 1731 1732 void Driver::BuildJobs(Compilation &C) const { 1733 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs"); 1734 1735 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o); 1736 1737 // It is an error to provide a -o option if we are making multiple output 1738 // files. 1739 if (FinalOutput) { 1740 unsigned NumOutputs = 0; 1741 for (const Action *A : C.getActions()) 1742 if (A->getType() != types::TY_Nothing) 1743 ++NumOutputs; 1744 1745 if (NumOutputs > 1) { 1746 Diag(clang::diag::err_drv_output_argument_with_multiple_files); 1747 FinalOutput = nullptr; 1748 } 1749 } 1750 1751 // Collect the list of architectures. 1752 llvm::StringSet<> ArchNames; 1753 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO()) 1754 for (const Arg *A : C.getArgs()) 1755 if (A->getOption().matches(options::OPT_arch)) 1756 ArchNames.insert(A->getValue()); 1757 1758 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for. 1759 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults; 1760 for (Action *A : C.getActions()) { 1761 // If we are linking an image for multiple archs then the linker wants 1762 // -arch_multiple and -final_output <final image name>. Unfortunately, this 1763 // doesn't fit in cleanly because we have to pass this information down. 1764 // 1765 // FIXME: This is a hack; find a cleaner way to integrate this into the 1766 // process. 1767 const char *LinkingOutput = nullptr; 1768 if (isa<LipoJobAction>(A)) { 1769 if (FinalOutput) 1770 LinkingOutput = FinalOutput->getValue(); 1771 else 1772 LinkingOutput = getDefaultImageName(); 1773 } 1774 1775 BuildJobsForAction(C, A, &C.getDefaultToolChain(), 1776 /*BoundArch*/ nullptr, 1777 /*AtTopLevel*/ true, 1778 /*MultipleArchs*/ ArchNames.size() > 1, 1779 /*LinkingOutput*/ LinkingOutput, CachedResults); 1780 } 1781 1782 // If the user passed -Qunused-arguments or there were errors, don't warn 1783 // about any unused arguments. 1784 if (Diags.hasErrorOccurred() || 1785 C.getArgs().hasArg(options::OPT_Qunused_arguments)) 1786 return; 1787 1788 // Claim -### here. 1789 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH); 1790 1791 // Claim --driver-mode, it was handled earlier. 1792 (void)C.getArgs().hasArg(options::OPT_driver_mode); 1793 1794 for (Arg *A : C.getArgs()) { 1795 // FIXME: It would be nice to be able to send the argument to the 1796 // DiagnosticsEngine, so that extra values, position, and so on could be 1797 // printed. 1798 if (!A->isClaimed()) { 1799 if (A->getOption().hasFlag(options::NoArgumentUnused)) 1800 continue; 1801 1802 // Suppress the warning automatically if this is just a flag, and it is an 1803 // instance of an argument we already claimed. 1804 const Option &Opt = A->getOption(); 1805 if (Opt.getKind() == Option::FlagClass) { 1806 bool DuplicateClaimed = false; 1807 1808 for (const Arg *AA : C.getArgs().filtered(&Opt)) { 1809 if (AA->isClaimed()) { 1810 DuplicateClaimed = true; 1811 break; 1812 } 1813 } 1814 1815 if (DuplicateClaimed) 1816 continue; 1817 } 1818 1819 // In clang-cl, don't mention unknown arguments here since they have 1820 // already been warned about. 1821 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN)) 1822 Diag(clang::diag::warn_drv_unused_argument) 1823 << A->getAsString(C.getArgs()); 1824 } 1825 } 1826 } 1827 1828 // Returns a Tool for a given JobAction. In case the action and its 1829 // predecessors can be combined, updates Inputs with the inputs of the 1830 // first combined action. If one of the collapsed actions is a 1831 // CudaHostAction, updates CollapsedCHA with the pointer to it so the 1832 // caller can deal with extra handling such action requires. 1833 static const Tool *selectToolForJob(Compilation &C, bool SaveTemps, 1834 bool EmbedBitcode, const ToolChain *TC, 1835 const JobAction *JA, 1836 const ActionList *&Inputs, 1837 const CudaHostAction *&CollapsedCHA) { 1838 const Tool *ToolForJob = nullptr; 1839 CollapsedCHA = nullptr; 1840 1841 // See if we should look for a compiler with an integrated assembler. We match 1842 // bottom up, so what we are actually looking for is an assembler job with a 1843 // compiler input. 1844 1845 if (TC->useIntegratedAs() && !SaveTemps && 1846 !C.getArgs().hasArg(options::OPT_via_file_asm) && 1847 !C.getArgs().hasArg(options::OPT__SLASH_FA) && 1848 !C.getArgs().hasArg(options::OPT__SLASH_Fa) && 1849 isa<AssembleJobAction>(JA) && Inputs->size() == 1 && 1850 isa<BackendJobAction>(*Inputs->begin())) { 1851 // A BackendJob is always preceded by a CompileJob, and without -save-temps 1852 // or -fembed-bitcode, they will always get combined together, so instead of 1853 // checking the backend tool, check if the tool for the CompileJob has an 1854 // integrated assembler. For -fembed-bitcode, CompileJob is still used to 1855 // look up tools for BackendJob, but they need to match before we can split 1856 // them. 1857 const ActionList *BackendInputs = &(*Inputs)[0]->getInputs(); 1858 // Compile job may be wrapped in CudaHostAction, extract it if 1859 // that's the case and update CollapsedCHA if we combine phases. 1860 CudaHostAction *CHA = dyn_cast<CudaHostAction>(*BackendInputs->begin()); 1861 JobAction *CompileJA = cast<CompileJobAction>( 1862 CHA ? *CHA->input_begin() : *BackendInputs->begin()); 1863 assert(CompileJA && "Backend job is not preceeded by compile job."); 1864 const Tool *Compiler = TC->SelectTool(*CompileJA); 1865 if (!Compiler) 1866 return nullptr; 1867 // When using -fembed-bitcode, it is required to have the same tool (clang) 1868 // for both CompilerJA and BackendJA. Otherwise, combine two stages. 1869 if (EmbedBitcode) { 1870 JobAction *InputJA = cast<JobAction>(*Inputs->begin()); 1871 const Tool *BackendTool = TC->SelectTool(*InputJA); 1872 if (BackendTool == Compiler) 1873 CompileJA = InputJA; 1874 } 1875 if (Compiler->hasIntegratedAssembler()) { 1876 Inputs = &CompileJA->getInputs(); 1877 ToolForJob = Compiler; 1878 CollapsedCHA = CHA; 1879 } 1880 } 1881 1882 // A backend job should always be combined with the preceding compile job 1883 // unless OPT_save_temps or OPT_fembed_bitcode is enabled and the compiler is 1884 // capable of emitting LLVM IR as an intermediate output. 1885 if (isa<BackendJobAction>(JA)) { 1886 // Check if the compiler supports emitting LLVM IR. 1887 assert(Inputs->size() == 1); 1888 // Compile job may be wrapped in CudaHostAction, extract it if 1889 // that's the case and update CollapsedCHA if we combine phases. 1890 CudaHostAction *CHA = dyn_cast<CudaHostAction>(*Inputs->begin()); 1891 JobAction *CompileJA = 1892 cast<CompileJobAction>(CHA ? *CHA->input_begin() : *Inputs->begin()); 1893 assert(CompileJA && "Backend job is not preceeded by compile job."); 1894 const Tool *Compiler = TC->SelectTool(*CompileJA); 1895 if (!Compiler) 1896 return nullptr; 1897 if (!Compiler->canEmitIR() || 1898 (!SaveTemps && !EmbedBitcode)) { 1899 Inputs = &CompileJA->getInputs(); 1900 ToolForJob = Compiler; 1901 CollapsedCHA = CHA; 1902 } 1903 } 1904 1905 // Otherwise use the tool for the current job. 1906 if (!ToolForJob) 1907 ToolForJob = TC->SelectTool(*JA); 1908 1909 // See if we should use an integrated preprocessor. We do so when we have 1910 // exactly one input, since this is the only use case we care about 1911 // (irrelevant since we don't support combine yet). 1912 if (Inputs->size() == 1 && isa<PreprocessJobAction>(*Inputs->begin()) && 1913 !C.getArgs().hasArg(options::OPT_no_integrated_cpp) && 1914 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps && 1915 !C.getArgs().hasArg(options::OPT_rewrite_objc) && 1916 ToolForJob->hasIntegratedCPP()) 1917 Inputs = &(*Inputs)[0]->getInputs(); 1918 1919 return ToolForJob; 1920 } 1921 1922 InputInfo Driver::BuildJobsForAction( 1923 Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch, 1924 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput, 1925 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults) 1926 const { 1927 // The bound arch is not necessarily represented in the toolchain's triple -- 1928 // for example, armv7 and armv7s both map to the same triple -- so we need 1929 // both in our map. 1930 std::string TriplePlusArch = TC->getTriple().normalize(); 1931 if (BoundArch) { 1932 TriplePlusArch += "-"; 1933 TriplePlusArch += BoundArch; 1934 } 1935 std::pair<const Action *, std::string> ActionTC = {A, TriplePlusArch}; 1936 auto CachedResult = CachedResults.find(ActionTC); 1937 if (CachedResult != CachedResults.end()) { 1938 return CachedResult->second; 1939 } 1940 InputInfo Result = 1941 BuildJobsForActionNoCache(C, A, TC, BoundArch, AtTopLevel, MultipleArchs, 1942 LinkingOutput, CachedResults); 1943 CachedResults[ActionTC] = Result; 1944 return Result; 1945 } 1946 1947 InputInfo Driver::BuildJobsForActionNoCache( 1948 Compilation &C, const Action *A, const ToolChain *TC, const char *BoundArch, 1949 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput, 1950 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults) 1951 const { 1952 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs"); 1953 1954 InputInfoList CudaDeviceInputInfos; 1955 if (const CudaHostAction *CHA = dyn_cast<CudaHostAction>(A)) { 1956 // Append outputs of device jobs to the input list. 1957 for (const Action *DA : CHA->getDeviceActions()) { 1958 CudaDeviceInputInfos.push_back(BuildJobsForAction( 1959 C, DA, TC, nullptr, AtTopLevel, 1960 /*MultipleArchs*/ false, LinkingOutput, CachedResults)); 1961 } 1962 // Override current action with a real host compile action and continue 1963 // processing it. 1964 A = *CHA->input_begin(); 1965 } 1966 1967 if (const InputAction *IA = dyn_cast<InputAction>(A)) { 1968 // FIXME: It would be nice to not claim this here; maybe the old scheme of 1969 // just using Args was better? 1970 const Arg &Input = IA->getInputArg(); 1971 Input.claim(); 1972 if (Input.getOption().matches(options::OPT_INPUT)) { 1973 const char *Name = Input.getValue(); 1974 return InputInfo(A, Name, /* BaseInput = */ Name); 1975 } 1976 return InputInfo(A, &Input, /* BaseInput = */ ""); 1977 } 1978 1979 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) { 1980 const ToolChain *TC; 1981 const char *ArchName = BAA->getArchName(); 1982 1983 if (ArchName) 1984 TC = &getToolChain( 1985 C.getArgs(), 1986 computeTargetTriple(DefaultTargetTriple, C.getArgs(), ArchName)); 1987 else 1988 TC = &C.getDefaultToolChain(); 1989 1990 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel, 1991 MultipleArchs, LinkingOutput, CachedResults); 1992 } 1993 1994 if (const CudaDeviceAction *CDA = dyn_cast<CudaDeviceAction>(A)) { 1995 // Initial processing of CudaDeviceAction carries host params. 1996 // Call BuildJobsForAction() again, now with correct device parameters. 1997 InputInfo II = BuildJobsForAction( 1998 C, *CDA->input_begin(), C.getCudaDeviceToolChain(), 1999 CDA->getGpuArchName(), CDA->isAtTopLevel(), /*MultipleArchs=*/true, 2000 LinkingOutput, CachedResults); 2001 // Currently II's Action is *CDA->input_begin(). Set it to CDA instead, so 2002 // that one can retrieve II's GPU arch. 2003 II.setAction(A); 2004 return II; 2005 } 2006 2007 const ActionList *Inputs = &A->getInputs(); 2008 2009 const JobAction *JA = cast<JobAction>(A); 2010 const CudaHostAction *CollapsedCHA = nullptr; 2011 const Tool *T = 2012 selectToolForJob(C, isSaveTempsEnabled(), embedBitcodeEnabled(), TC, JA, 2013 Inputs, CollapsedCHA); 2014 if (!T) 2015 return InputInfo(); 2016 2017 // If we've collapsed action list that contained CudaHostAction we 2018 // need to build jobs for device-side inputs it may have held. 2019 if (CollapsedCHA) { 2020 for (const Action *DA : CollapsedCHA->getDeviceActions()) { 2021 CudaDeviceInputInfos.push_back(BuildJobsForAction( 2022 C, DA, TC, "", AtTopLevel, 2023 /*MultipleArchs*/ false, LinkingOutput, CachedResults)); 2024 } 2025 } 2026 2027 // Only use pipes when there is exactly one input. 2028 InputInfoList InputInfos; 2029 for (const Action *Input : *Inputs) { 2030 // Treat dsymutil and verify sub-jobs as being at the top-level too, they 2031 // shouldn't get temporary output names. 2032 // FIXME: Clean this up. 2033 bool SubJobAtTopLevel = 2034 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A)); 2035 InputInfos.push_back(BuildJobsForAction(C, Input, TC, BoundArch, 2036 SubJobAtTopLevel, MultipleArchs, 2037 LinkingOutput, CachedResults)); 2038 } 2039 2040 // Always use the first input as the base input. 2041 const char *BaseInput = InputInfos[0].getBaseInput(); 2042 2043 // ... except dsymutil actions, which use their actual input as the base 2044 // input. 2045 if (JA->getType() == types::TY_dSYM) 2046 BaseInput = InputInfos[0].getFilename(); 2047 2048 // Append outputs of cuda device jobs to the input list 2049 if (CudaDeviceInputInfos.size()) 2050 InputInfos.append(CudaDeviceInputInfos.begin(), CudaDeviceInputInfos.end()); 2051 2052 // Determine the place to write output to, if any. 2053 InputInfo Result; 2054 if (JA->getType() == types::TY_Nothing) 2055 Result = InputInfo(A, BaseInput); 2056 else 2057 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch, 2058 AtTopLevel, MultipleArchs), 2059 BaseInput); 2060 2061 if (CCCPrintBindings && !CCGenDiagnostics) { 2062 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"' 2063 << " - \"" << T->getName() << "\", inputs: ["; 2064 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) { 2065 llvm::errs() << InputInfos[i].getAsString(); 2066 if (i + 1 != e) 2067 llvm::errs() << ", "; 2068 } 2069 llvm::errs() << "], output: " << Result.getAsString() << "\n"; 2070 } else { 2071 T->ConstructJob(C, *JA, Result, InputInfos, 2072 C.getArgsForToolChain(TC, BoundArch), LinkingOutput); 2073 } 2074 return Result; 2075 } 2076 2077 const char *Driver::getDefaultImageName() const { 2078 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple)); 2079 return Target.isOSWindows() ? "a.exe" : "a.out"; 2080 } 2081 2082 /// \brief Create output filename based on ArgValue, which could either be a 2083 /// full filename, filename without extension, or a directory. If ArgValue 2084 /// does not provide a filename, then use BaseName, and use the extension 2085 /// suitable for FileType. 2086 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue, 2087 StringRef BaseName, 2088 types::ID FileType) { 2089 SmallString<128> Filename = ArgValue; 2090 2091 if (ArgValue.empty()) { 2092 // If the argument is empty, output to BaseName in the current dir. 2093 Filename = BaseName; 2094 } else if (llvm::sys::path::is_separator(Filename.back())) { 2095 // If the argument is a directory, output to BaseName in that dir. 2096 llvm::sys::path::append(Filename, BaseName); 2097 } 2098 2099 if (!llvm::sys::path::has_extension(ArgValue)) { 2100 // If the argument didn't provide an extension, then set it. 2101 const char *Extension = types::getTypeTempSuffix(FileType, true); 2102 2103 if (FileType == types::TY_Image && 2104 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) { 2105 // The output file is a dll. 2106 Extension = "dll"; 2107 } 2108 2109 llvm::sys::path::replace_extension(Filename, Extension); 2110 } 2111 2112 return Args.MakeArgString(Filename.c_str()); 2113 } 2114 2115 const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA, 2116 const char *BaseInput, 2117 const char *BoundArch, bool AtTopLevel, 2118 bool MultipleArchs) const { 2119 llvm::PrettyStackTraceString CrashInfo("Computing output path"); 2120 // Output to a user requested destination? 2121 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) { 2122 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o)) 2123 return C.addResultFile(FinalOutput->getValue(), &JA); 2124 } 2125 2126 // For /P, preprocess to file named after BaseInput. 2127 if (C.getArgs().hasArg(options::OPT__SLASH_P)) { 2128 assert(AtTopLevel && isa<PreprocessJobAction>(JA)); 2129 StringRef BaseName = llvm::sys::path::filename(BaseInput); 2130 StringRef NameArg; 2131 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi)) 2132 NameArg = A->getValue(); 2133 return C.addResultFile( 2134 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C), 2135 &JA); 2136 } 2137 2138 // Default to writing to stdout? 2139 if (AtTopLevel && !CCGenDiagnostics && 2140 (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile)) 2141 return "-"; 2142 2143 // Is this the assembly listing for /FA? 2144 if (JA.getType() == types::TY_PP_Asm && 2145 (C.getArgs().hasArg(options::OPT__SLASH_FA) || 2146 C.getArgs().hasArg(options::OPT__SLASH_Fa))) { 2147 // Use /Fa and the input filename to determine the asm file name. 2148 StringRef BaseName = llvm::sys::path::filename(BaseInput); 2149 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa); 2150 return C.addResultFile( 2151 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()), 2152 &JA); 2153 } 2154 2155 // Output to a temporary file? 2156 if ((!AtTopLevel && !isSaveTempsEnabled() && 2157 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) || 2158 CCGenDiagnostics) { 2159 StringRef Name = llvm::sys::path::filename(BaseInput); 2160 std::pair<StringRef, StringRef> Split = Name.split('.'); 2161 std::string TmpName = GetTemporaryPath( 2162 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode())); 2163 return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str())); 2164 } 2165 2166 SmallString<128> BasePath(BaseInput); 2167 StringRef BaseName; 2168 2169 // Dsymutil actions should use the full path. 2170 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA)) 2171 BaseName = BasePath; 2172 else 2173 BaseName = llvm::sys::path::filename(BasePath); 2174 2175 // Determine what the derived output name should be. 2176 const char *NamedOutput; 2177 2178 if (JA.getType() == types::TY_Object && 2179 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) { 2180 // The /Fo or /o flag decides the object filename. 2181 StringRef Val = 2182 C.getArgs() 2183 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o) 2184 ->getValue(); 2185 NamedOutput = 2186 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object); 2187 } else if (JA.getType() == types::TY_Image && 2188 C.getArgs().hasArg(options::OPT__SLASH_Fe, 2189 options::OPT__SLASH_o)) { 2190 // The /Fe or /o flag names the linked file. 2191 StringRef Val = 2192 C.getArgs() 2193 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o) 2194 ->getValue(); 2195 NamedOutput = 2196 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image); 2197 } else if (JA.getType() == types::TY_Image) { 2198 if (IsCLMode()) { 2199 // clang-cl uses BaseName for the executable name. 2200 NamedOutput = 2201 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image); 2202 } else if (MultipleArchs && BoundArch) { 2203 SmallString<128> Output(getDefaultImageName()); 2204 Output += "-"; 2205 Output.append(BoundArch); 2206 NamedOutput = C.getArgs().MakeArgString(Output.c_str()); 2207 } else { 2208 NamedOutput = getDefaultImageName(); 2209 } 2210 } else if (JA.getType() == types::TY_PCH && IsCLMode()) { 2211 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName).c_str()); 2212 } else { 2213 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode()); 2214 assert(Suffix && "All types used for output should have a suffix."); 2215 2216 std::string::size_type End = std::string::npos; 2217 if (!types::appendSuffixForType(JA.getType())) 2218 End = BaseName.rfind('.'); 2219 SmallString<128> Suffixed(BaseName.substr(0, End)); 2220 if (MultipleArchs && BoundArch) { 2221 Suffixed += "-"; 2222 Suffixed.append(BoundArch); 2223 } 2224 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for 2225 // the unoptimized bitcode so that it does not get overwritten by the ".bc" 2226 // optimized bitcode output. 2227 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) && 2228 JA.getType() == types::TY_LLVM_BC) 2229 Suffixed += ".tmp"; 2230 Suffixed += '.'; 2231 Suffixed += Suffix; 2232 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str()); 2233 } 2234 2235 // Prepend object file path if -save-temps=obj 2236 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) && 2237 JA.getType() != types::TY_PCH) { 2238 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o); 2239 SmallString<128> TempPath(FinalOutput->getValue()); 2240 llvm::sys::path::remove_filename(TempPath); 2241 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput); 2242 llvm::sys::path::append(TempPath, OutputFileName); 2243 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str()); 2244 } 2245 2246 // If we're saving temps and the temp file conflicts with the input file, 2247 // then avoid overwriting input file. 2248 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) { 2249 bool SameFile = false; 2250 SmallString<256> Result; 2251 llvm::sys::fs::current_path(Result); 2252 llvm::sys::path::append(Result, BaseName); 2253 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile); 2254 // Must share the same path to conflict. 2255 if (SameFile) { 2256 StringRef Name = llvm::sys::path::filename(BaseInput); 2257 std::pair<StringRef, StringRef> Split = Name.split('.'); 2258 std::string TmpName = GetTemporaryPath( 2259 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode())); 2260 return C.addTempFile(C.getArgs().MakeArgString(TmpName.c_str())); 2261 } 2262 } 2263 2264 // As an annoying special case, PCH generation doesn't strip the pathname. 2265 if (JA.getType() == types::TY_PCH && !IsCLMode()) { 2266 llvm::sys::path::remove_filename(BasePath); 2267 if (BasePath.empty()) 2268 BasePath = NamedOutput; 2269 else 2270 llvm::sys::path::append(BasePath, NamedOutput); 2271 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA); 2272 } else { 2273 return C.addResultFile(NamedOutput, &JA); 2274 } 2275 } 2276 2277 std::string Driver::GetFilePath(const char *Name, const ToolChain &TC) const { 2278 // Respect a limited subset of the '-Bprefix' functionality in GCC by 2279 // attempting to use this prefix when looking for file paths. 2280 for (const std::string &Dir : PrefixDirs) { 2281 if (Dir.empty()) 2282 continue; 2283 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir); 2284 llvm::sys::path::append(P, Name); 2285 if (llvm::sys::fs::exists(Twine(P))) 2286 return P.str(); 2287 } 2288 2289 SmallString<128> P(ResourceDir); 2290 llvm::sys::path::append(P, Name); 2291 if (llvm::sys::fs::exists(Twine(P))) 2292 return P.str(); 2293 2294 for (const std::string &Dir : TC.getFilePaths()) { 2295 if (Dir.empty()) 2296 continue; 2297 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir); 2298 llvm::sys::path::append(P, Name); 2299 if (llvm::sys::fs::exists(Twine(P))) 2300 return P.str(); 2301 } 2302 2303 return Name; 2304 } 2305 2306 void Driver::generatePrefixedToolNames( 2307 const char *Tool, const ToolChain &TC, 2308 SmallVectorImpl<std::string> &Names) const { 2309 // FIXME: Needs a better variable than DefaultTargetTriple 2310 Names.emplace_back(DefaultTargetTriple + "-" + Tool); 2311 Names.emplace_back(Tool); 2312 2313 // Allow the discovery of tools prefixed with LLVM's default target triple. 2314 std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple(); 2315 if (LLVMDefaultTargetTriple != DefaultTargetTriple) 2316 Names.emplace_back(LLVMDefaultTargetTriple + "-" + Tool); 2317 } 2318 2319 static bool ScanDirForExecutable(SmallString<128> &Dir, 2320 ArrayRef<std::string> Names) { 2321 for (const auto &Name : Names) { 2322 llvm::sys::path::append(Dir, Name); 2323 if (llvm::sys::fs::can_execute(Twine(Dir))) 2324 return true; 2325 llvm::sys::path::remove_filename(Dir); 2326 } 2327 return false; 2328 } 2329 2330 std::string Driver::GetProgramPath(const char *Name, 2331 const ToolChain &TC) const { 2332 SmallVector<std::string, 2> TargetSpecificExecutables; 2333 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables); 2334 2335 // Respect a limited subset of the '-Bprefix' functionality in GCC by 2336 // attempting to use this prefix when looking for program paths. 2337 for (const auto &PrefixDir : PrefixDirs) { 2338 if (llvm::sys::fs::is_directory(PrefixDir)) { 2339 SmallString<128> P(PrefixDir); 2340 if (ScanDirForExecutable(P, TargetSpecificExecutables)) 2341 return P.str(); 2342 } else { 2343 SmallString<128> P(PrefixDir + Name); 2344 if (llvm::sys::fs::can_execute(Twine(P))) 2345 return P.str(); 2346 } 2347 } 2348 2349 const ToolChain::path_list &List = TC.getProgramPaths(); 2350 for (const auto &Path : List) { 2351 SmallString<128> P(Path); 2352 if (ScanDirForExecutable(P, TargetSpecificExecutables)) 2353 return P.str(); 2354 } 2355 2356 // If all else failed, search the path. 2357 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables) 2358 if (llvm::ErrorOr<std::string> P = 2359 llvm::sys::findProgramByName(TargetSpecificExecutable)) 2360 return *P; 2361 2362 return Name; 2363 } 2364 2365 std::string Driver::GetTemporaryPath(StringRef Prefix, 2366 const char *Suffix) const { 2367 SmallString<128> Path; 2368 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path); 2369 if (EC) { 2370 Diag(clang::diag::err_unable_to_make_temp) << EC.message(); 2371 return ""; 2372 } 2373 2374 return Path.str(); 2375 } 2376 2377 std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const { 2378 SmallString<128> Output; 2379 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) { 2380 // FIXME: If anybody needs it, implement this obscure rule: 2381 // "If you specify a directory without a file name, the default file name 2382 // is VCx0.pch., where x is the major version of Visual C++ in use." 2383 Output = FpArg->getValue(); 2384 2385 // "If you do not specify an extension as part of the path name, an 2386 // extension of .pch is assumed. " 2387 if (!llvm::sys::path::has_extension(Output)) 2388 Output += ".pch"; 2389 } else { 2390 Output = BaseName; 2391 llvm::sys::path::replace_extension(Output, ".pch"); 2392 } 2393 return Output.str(); 2394 } 2395 2396 const ToolChain &Driver::getToolChain(const ArgList &Args, 2397 const llvm::Triple &Target) const { 2398 2399 ToolChain *&TC = ToolChains[Target.str()]; 2400 if (!TC) { 2401 switch (Target.getOS()) { 2402 case llvm::Triple::CloudABI: 2403 TC = new toolchains::CloudABI(*this, Target, Args); 2404 break; 2405 case llvm::Triple::Darwin: 2406 case llvm::Triple::MacOSX: 2407 case llvm::Triple::IOS: 2408 case llvm::Triple::TvOS: 2409 case llvm::Triple::WatchOS: 2410 TC = new toolchains::DarwinClang(*this, Target, Args); 2411 break; 2412 case llvm::Triple::DragonFly: 2413 TC = new toolchains::DragonFly(*this, Target, Args); 2414 break; 2415 case llvm::Triple::OpenBSD: 2416 TC = new toolchains::OpenBSD(*this, Target, Args); 2417 break; 2418 case llvm::Triple::Bitrig: 2419 TC = new toolchains::Bitrig(*this, Target, Args); 2420 break; 2421 case llvm::Triple::NetBSD: 2422 TC = new toolchains::NetBSD(*this, Target, Args); 2423 break; 2424 case llvm::Triple::FreeBSD: 2425 TC = new toolchains::FreeBSD(*this, Target, Args); 2426 break; 2427 case llvm::Triple::Minix: 2428 TC = new toolchains::Minix(*this, Target, Args); 2429 break; 2430 case llvm::Triple::Linux: 2431 if (Target.getArch() == llvm::Triple::hexagon) 2432 TC = new toolchains::HexagonToolChain(*this, Target, Args); 2433 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) && 2434 !Target.hasEnvironment()) 2435 TC = new toolchains::MipsLLVMToolChain(*this, Target, Args); 2436 else 2437 TC = new toolchains::Linux(*this, Target, Args); 2438 break; 2439 case llvm::Triple::NaCl: 2440 TC = new toolchains::NaClToolChain(*this, Target, Args); 2441 break; 2442 case llvm::Triple::Solaris: 2443 TC = new toolchains::Solaris(*this, Target, Args); 2444 break; 2445 case llvm::Triple::AMDHSA: 2446 TC = new toolchains::AMDGPUToolChain(*this, Target, Args); 2447 break; 2448 case llvm::Triple::Win32: 2449 switch (Target.getEnvironment()) { 2450 default: 2451 if (Target.isOSBinFormatELF()) 2452 TC = new toolchains::Generic_ELF(*this, Target, Args); 2453 else if (Target.isOSBinFormatMachO()) 2454 TC = new toolchains::MachO(*this, Target, Args); 2455 else 2456 TC = new toolchains::Generic_GCC(*this, Target, Args); 2457 break; 2458 case llvm::Triple::GNU: 2459 TC = new toolchains::MinGW(*this, Target, Args); 2460 break; 2461 case llvm::Triple::Itanium: 2462 TC = new toolchains::CrossWindowsToolChain(*this, Target, Args); 2463 break; 2464 case llvm::Triple::MSVC: 2465 case llvm::Triple::UnknownEnvironment: 2466 TC = new toolchains::MSVCToolChain(*this, Target, Args); 2467 break; 2468 } 2469 break; 2470 case llvm::Triple::CUDA: 2471 TC = new toolchains::CudaToolChain(*this, Target, Args); 2472 break; 2473 case llvm::Triple::PS4: 2474 TC = new toolchains::PS4CPU(*this, Target, Args); 2475 break; 2476 default: 2477 // Of these targets, Hexagon is the only one that might have 2478 // an OS of Linux, in which case it got handled above already. 2479 switch (Target.getArch()) { 2480 case llvm::Triple::tce: 2481 TC = new toolchains::TCEToolChain(*this, Target, Args); 2482 break; 2483 case llvm::Triple::hexagon: 2484 TC = new toolchains::HexagonToolChain(*this, Target, Args); 2485 break; 2486 case llvm::Triple::lanai: 2487 TC = new toolchains::LanaiToolChain(*this, Target, Args); 2488 break; 2489 case llvm::Triple::xcore: 2490 TC = new toolchains::XCoreToolChain(*this, Target, Args); 2491 break; 2492 case llvm::Triple::wasm32: 2493 case llvm::Triple::wasm64: 2494 TC = new toolchains::WebAssembly(*this, Target, Args); 2495 break; 2496 default: 2497 if (Target.getVendor() == llvm::Triple::Myriad) 2498 TC = new toolchains::MyriadToolChain(*this, Target, Args); 2499 else if (Target.isOSBinFormatELF()) 2500 TC = new toolchains::Generic_ELF(*this, Target, Args); 2501 else if (Target.isOSBinFormatMachO()) 2502 TC = new toolchains::MachO(*this, Target, Args); 2503 else 2504 TC = new toolchains::Generic_GCC(*this, Target, Args); 2505 } 2506 } 2507 } 2508 return *TC; 2509 } 2510 2511 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const { 2512 // Say "no" if there is not exactly one input of a type clang understands. 2513 if (JA.size() != 1 || 2514 !types::isAcceptedByClang((*JA.input_begin())->getType())) 2515 return false; 2516 2517 // And say "no" if this is not a kind of action clang understands. 2518 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) && 2519 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA)) 2520 return false; 2521 2522 return true; 2523 } 2524 2525 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the 2526 /// grouped values as integers. Numbers which are not provided are set to 0. 2527 /// 2528 /// \return True if the entire string was parsed (9.2), or all groups were 2529 /// parsed (10.3.5extrastuff). 2530 bool Driver::GetReleaseVersion(const char *Str, unsigned &Major, 2531 unsigned &Minor, unsigned &Micro, 2532 bool &HadExtra) { 2533 HadExtra = false; 2534 2535 Major = Minor = Micro = 0; 2536 if (*Str == '\0') 2537 return false; 2538 2539 char *End; 2540 Major = (unsigned)strtol(Str, &End, 10); 2541 if (*Str != '\0' && *End == '\0') 2542 return true; 2543 if (*End != '.') 2544 return false; 2545 2546 Str = End + 1; 2547 Minor = (unsigned)strtol(Str, &End, 10); 2548 if (*Str != '\0' && *End == '\0') 2549 return true; 2550 if (*End != '.') 2551 return false; 2552 2553 Str = End + 1; 2554 Micro = (unsigned)strtol(Str, &End, 10); 2555 if (*Str != '\0' && *End == '\0') 2556 return true; 2557 if (Str == End) 2558 return false; 2559 HadExtra = true; 2560 return true; 2561 } 2562 2563 /// Parse digits from a string \p Str and fulfill \p Digits with 2564 /// the parsed numbers. This method assumes that the max number of 2565 /// digits to look for is equal to Digits.size(). 2566 /// 2567 /// \return True if the entire string was parsed and there are 2568 /// no extra characters remaining at the end. 2569 bool Driver::GetReleaseVersion(const char *Str, 2570 MutableArrayRef<unsigned> Digits) { 2571 if (*Str == '\0') 2572 return false; 2573 2574 char *End; 2575 unsigned CurDigit = 0; 2576 while (CurDigit < Digits.size()) { 2577 unsigned Digit = (unsigned)strtol(Str, &End, 10); 2578 Digits[CurDigit] = Digit; 2579 if (*Str != '\0' && *End == '\0') 2580 return true; 2581 if (*End != '.' || Str == End) 2582 return false; 2583 Str = End + 1; 2584 CurDigit++; 2585 } 2586 2587 // More digits than requested, bail out... 2588 return false; 2589 } 2590 2591 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const { 2592 unsigned IncludedFlagsBitmask = 0; 2593 unsigned ExcludedFlagsBitmask = options::NoDriverOption; 2594 2595 if (Mode == CLMode) { 2596 // Include CL and Core options. 2597 IncludedFlagsBitmask |= options::CLOption; 2598 IncludedFlagsBitmask |= options::CoreOption; 2599 } else { 2600 ExcludedFlagsBitmask |= options::CLOption; 2601 } 2602 2603 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask); 2604 } 2605 2606 bool clang::driver::isOptimizationLevelFast(const ArgList &Args) { 2607 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false); 2608 } 2609