1 //===--- Driver.cpp - Clang GCC Compatible Driver -------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/Driver/Driver.h"
11 #include "InputInfo.h"
12 #include "ToolChains/AMDGPU.h"
13 #include "ToolChains/AVR.h"
14 #include "ToolChains/Bitrig.h"
15 #include "ToolChains/Clang.h"
16 #include "ToolChains/CloudABI.h"
17 #include "ToolChains/Contiki.h"
18 #include "ToolChains/CrossWindows.h"
19 #include "ToolChains/Cuda.h"
20 #include "ToolChains/Darwin.h"
21 #include "ToolChains/DragonFly.h"
22 #include "ToolChains/FreeBSD.h"
23 #include "ToolChains/Fuchsia.h"
24 #include "ToolChains/Gnu.h"
25 #include "ToolChains/BareMetal.h"
26 #include "ToolChains/Haiku.h"
27 #include "ToolChains/Hexagon.h"
28 #include "ToolChains/Lanai.h"
29 #include "ToolChains/Linux.h"
30 #include "ToolChains/MinGW.h"
31 #include "ToolChains/Minix.h"
32 #include "ToolChains/MipsLinux.h"
33 #include "ToolChains/MSVC.h"
34 #include "ToolChains/Myriad.h"
35 #include "ToolChains/NaCl.h"
36 #include "ToolChains/NetBSD.h"
37 #include "ToolChains/OpenBSD.h"
38 #include "ToolChains/PS4CPU.h"
39 #include "ToolChains/Solaris.h"
40 #include "ToolChains/TCE.h"
41 #include "ToolChains/WebAssembly.h"
42 #include "ToolChains/XCore.h"
43 #include "clang/Basic/Version.h"
44 #include "clang/Basic/VirtualFileSystem.h"
45 #include "clang/Config/config.h"
46 #include "clang/Driver/Action.h"
47 #include "clang/Driver/Compilation.h"
48 #include "clang/Driver/DriverDiagnostic.h"
49 #include "clang/Driver/Job.h"
50 #include "clang/Driver/Options.h"
51 #include "clang/Driver/SanitizerArgs.h"
52 #include "clang/Driver/Tool.h"
53 #include "clang/Driver/ToolChain.h"
54 #include "llvm/ADT/ArrayRef.h"
55 #include "llvm/ADT/STLExtras.h"
56 #include "llvm/ADT/SmallSet.h"
57 #include "llvm/ADT/StringExtras.h"
58 #include "llvm/ADT/StringSet.h"
59 #include "llvm/ADT/StringSwitch.h"
60 #include "llvm/Option/Arg.h"
61 #include "llvm/Option/ArgList.h"
62 #include "llvm/Option/OptSpecifier.h"
63 #include "llvm/Option/OptTable.h"
64 #include "llvm/Option/Option.h"
65 #include "llvm/Support/ErrorHandling.h"
66 #include "llvm/Support/FileSystem.h"
67 #include "llvm/Support/Path.h"
68 #include "llvm/Support/PrettyStackTrace.h"
69 #include "llvm/Support/Process.h"
70 #include "llvm/Support/Program.h"
71 #include "llvm/Support/TargetRegistry.h"
72 #include "llvm/Support/raw_ostream.h"
77 #include <unistd.h> // getpid
80 using namespace clang::driver;
81 using namespace clang;
82 using namespace llvm::opt;
84 Driver::Driver(StringRef ClangExecutable, StringRef DefaultTargetTriple,
85 DiagnosticsEngine &Diags,
86 IntrusiveRefCntPtr<vfs::FileSystem> VFS)
87 : Opts(createDriverOptTable()), Diags(Diags), VFS(std::move(VFS)),
88 Mode(GCCMode), SaveTemps(SaveTempsNone), BitcodeEmbed(EmbedNone),
89 LTOMode(LTOK_None), ClangExecutable(ClangExecutable),
90 SysRoot(DEFAULT_SYSROOT), UseStdLib(true),
91 DriverTitle("clang LLVM compiler"), CCPrintOptionsFilename(nullptr),
92 CCPrintHeadersFilename(nullptr), CCLogDiagnosticsFilename(nullptr),
93 CCCPrintBindings(false), CCPrintHeaders(false), CCLogDiagnostics(false),
94 CCGenDiagnostics(false), DefaultTargetTriple(DefaultTargetTriple),
95 CCCGenericGCCName(""), CheckInputsExist(true), CCCUsePCH(true),
96 GenReproducer(false), SuppressMissingInputWarning(false) {
98 // Provide a sane fallback if no VFS is specified.
100 this->VFS = vfs::getRealFileSystem();
102 Name = llvm::sys::path::filename(ClangExecutable);
103 Dir = llvm::sys::path::parent_path(ClangExecutable);
104 InstalledDir = Dir; // Provide a sensible default installed dir.
106 // Compute the path to the resource directory.
107 StringRef ClangResourceDir(CLANG_RESOURCE_DIR);
108 SmallString<128> P(Dir);
109 if (ClangResourceDir != "") {
110 llvm::sys::path::append(P, ClangResourceDir);
112 StringRef ClangLibdirSuffix(CLANG_LIBDIR_SUFFIX);
113 P = llvm::sys::path::parent_path(Dir);
114 llvm::sys::path::append(P, Twine("lib") + ClangLibdirSuffix, "clang",
115 CLANG_VERSION_STRING);
117 ResourceDir = P.str();
120 void Driver::ParseDriverMode(StringRef ProgramName,
121 ArrayRef<const char *> Args) {
122 auto Default = ToolChain::getTargetAndModeFromProgramName(ProgramName);
123 StringRef DefaultMode(Default.second);
124 setDriverModeFromOption(DefaultMode);
126 for (const char *ArgPtr : Args) {
127 // Ingore nullptrs, they are response file's EOL markers
128 if (ArgPtr == nullptr)
130 const StringRef Arg = ArgPtr;
131 setDriverModeFromOption(Arg);
135 void Driver::setDriverModeFromOption(StringRef Opt) {
136 const std::string OptName =
137 getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
138 if (!Opt.startswith(OptName))
140 StringRef Value = Opt.drop_front(OptName.size());
142 const unsigned M = llvm::StringSwitch<unsigned>(Value)
143 .Case("gcc", GCCMode)
144 .Case("g++", GXXMode)
145 .Case("cpp", CPPMode)
150 Mode = static_cast<DriverMode>(M);
152 Diag(diag::err_drv_unsupported_option_argument) << OptName << Value;
155 InputArgList Driver::ParseArgStrings(ArrayRef<const char *> ArgStrings) {
156 llvm::PrettyStackTraceString CrashInfo("Command line argument parsing");
158 unsigned IncludedFlagsBitmask;
159 unsigned ExcludedFlagsBitmask;
160 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
161 getIncludeExcludeOptionFlagMasks();
163 unsigned MissingArgIndex, MissingArgCount;
165 getOpts().ParseArgs(ArgStrings, MissingArgIndex, MissingArgCount,
166 IncludedFlagsBitmask, ExcludedFlagsBitmask);
168 // Check for missing argument error.
170 Diag(clang::diag::err_drv_missing_argument)
171 << Args.getArgString(MissingArgIndex) << MissingArgCount;
173 // Check for unsupported options.
174 for (const Arg *A : Args) {
175 if (A->getOption().hasFlag(options::Unsupported)) {
176 Diag(clang::diag::err_drv_unsupported_opt) << A->getAsString(Args);
180 // Warn about -mcpu= without an argument.
181 if (A->getOption().matches(options::OPT_mcpu_EQ) && A->containsValue("")) {
182 Diag(clang::diag::warn_drv_empty_joined_argument) << A->getAsString(Args);
186 for (const Arg *A : Args.filtered(options::OPT_UNKNOWN))
187 Diags.Report(IsCLMode() ? diag::warn_drv_unknown_argument_clang_cl :
188 diag::err_drv_unknown_argument)
189 << A->getAsString(Args);
194 // Determine which compilation mode we are in. We look for options which
195 // affect the phase, starting with the earliest phases, and record which
196 // option we used to determine the final phase.
197 phases::ID Driver::getFinalPhase(const DerivedArgList &DAL,
198 Arg **FinalPhaseArg) const {
199 Arg *PhaseArg = nullptr;
200 phases::ID FinalPhase;
202 // -{E,EP,P,M,MM} only run the preprocessor.
203 if (CCCIsCPP() || (PhaseArg = DAL.getLastArg(options::OPT_E)) ||
204 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_EP)) ||
205 (PhaseArg = DAL.getLastArg(options::OPT_M, options::OPT_MM)) ||
206 (PhaseArg = DAL.getLastArg(options::OPT__SLASH_P))) {
207 FinalPhase = phases::Preprocess;
209 // --precompile only runs up to precompilation.
210 } else if ((PhaseArg = DAL.getLastArg(options::OPT__precompile))) {
211 FinalPhase = phases::Precompile;
213 // -{fsyntax-only,-analyze,emit-ast} only run up to the compiler.
214 } else if ((PhaseArg = DAL.getLastArg(options::OPT_fsyntax_only)) ||
215 (PhaseArg = DAL.getLastArg(options::OPT_module_file_info)) ||
216 (PhaseArg = DAL.getLastArg(options::OPT_verify_pch)) ||
217 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_objc)) ||
218 (PhaseArg = DAL.getLastArg(options::OPT_rewrite_legacy_objc)) ||
219 (PhaseArg = DAL.getLastArg(options::OPT__migrate)) ||
220 (PhaseArg = DAL.getLastArg(options::OPT__analyze,
221 options::OPT__analyze_auto)) ||
222 (PhaseArg = DAL.getLastArg(options::OPT_emit_ast))) {
223 FinalPhase = phases::Compile;
225 // -S only runs up to the backend.
226 } else if ((PhaseArg = DAL.getLastArg(options::OPT_S))) {
227 FinalPhase = phases::Backend;
229 // -c compilation only runs up to the assembler.
230 } else if ((PhaseArg = DAL.getLastArg(options::OPT_c))) {
231 FinalPhase = phases::Assemble;
233 // Otherwise do everything.
235 FinalPhase = phases::Link;
238 *FinalPhaseArg = PhaseArg;
243 static Arg *MakeInputArg(DerivedArgList &Args, OptTable &Opts,
245 Arg *A = new Arg(Opts.getOption(options::OPT_INPUT), Value,
246 Args.getBaseArgs().MakeIndex(Value), Value.data());
247 Args.AddSynthesizedArg(A);
252 DerivedArgList *Driver::TranslateInputArgs(const InputArgList &Args) const {
253 DerivedArgList *DAL = new DerivedArgList(Args);
255 bool HasNostdlib = Args.hasArg(options::OPT_nostdlib);
256 bool HasNodefaultlib = Args.hasArg(options::OPT_nodefaultlibs);
257 for (Arg *A : Args) {
258 // Unfortunately, we have to parse some forwarding options (-Xassembler,
259 // -Xlinker, -Xpreprocessor) because we either integrate their functionality
260 // (assembler and preprocessor), or bypass a previous driver ('collect2').
262 // Rewrite linker options, to replace --no-demangle with a custom internal
264 if ((A->getOption().matches(options::OPT_Wl_COMMA) ||
265 A->getOption().matches(options::OPT_Xlinker)) &&
266 A->containsValue("--no-demangle")) {
267 // Add the rewritten no-demangle argument.
268 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_Xlinker__no_demangle));
270 // Add the remaining values as Xlinker arguments.
271 for (StringRef Val : A->getValues())
272 if (Val != "--no-demangle")
273 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_Xlinker), Val);
278 // Rewrite preprocessor options, to replace -Wp,-MD,FOO which is used by
279 // some build systems. We don't try to be complete here because we don't
280 // care to encourage this usage model.
281 if (A->getOption().matches(options::OPT_Wp_COMMA) &&
282 (A->getValue(0) == StringRef("-MD") ||
283 A->getValue(0) == StringRef("-MMD"))) {
284 // Rewrite to -MD/-MMD along with -MF.
285 if (A->getValue(0) == StringRef("-MD"))
286 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MD));
288 DAL->AddFlagArg(A, Opts->getOption(options::OPT_MMD));
289 if (A->getNumValues() == 2)
290 DAL->AddSeparateArg(A, Opts->getOption(options::OPT_MF),
295 // Rewrite reserved library names.
296 if (A->getOption().matches(options::OPT_l)) {
297 StringRef Value = A->getValue();
299 // Rewrite unless -nostdlib is present.
300 if (!HasNostdlib && !HasNodefaultlib && Value == "stdc++") {
301 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_stdcxx));
305 // Rewrite unconditionally.
306 if (Value == "cc_kext") {
307 DAL->AddFlagArg(A, Opts->getOption(options::OPT_Z_reserved_lib_cckext));
312 // Pick up inputs via the -- option.
313 if (A->getOption().matches(options::OPT__DASH_DASH)) {
315 for (StringRef Val : A->getValues())
316 DAL->append(MakeInputArg(*DAL, *Opts, Val));
323 // Enforce -static if -miamcu is present.
324 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false))
325 DAL->AddFlagArg(0, Opts->getOption(options::OPT_static));
327 // Add a default value of -mlinker-version=, if one was given and the user
328 // didn't specify one.
329 #if defined(HOST_LINK_VERSION)
330 if (!Args.hasArg(options::OPT_mlinker_version_EQ) &&
331 strlen(HOST_LINK_VERSION) > 0) {
332 DAL->AddJoinedArg(0, Opts->getOption(options::OPT_mlinker_version_EQ),
334 DAL->getLastArg(options::OPT_mlinker_version_EQ)->claim();
341 /// \brief Compute target triple from args.
343 /// This routine provides the logic to compute a target triple from various
344 /// args passed to the driver and the default triple string.
345 static llvm::Triple computeTargetTriple(const Driver &D,
346 StringRef DefaultTargetTriple,
348 StringRef DarwinArchName = "") {
349 // FIXME: Already done in Compilation *Driver::BuildCompilation
350 if (const Arg *A = Args.getLastArg(options::OPT_target))
351 DefaultTargetTriple = A->getValue();
353 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
355 // Handle Apple-specific options available here.
356 if (Target.isOSBinFormatMachO()) {
357 // If an explict Darwin arch name is given, that trumps all.
358 if (!DarwinArchName.empty()) {
359 tools::darwin::setTripleTypeForMachOArchName(Target, DarwinArchName);
363 // Handle the Darwin '-arch' flag.
364 if (Arg *A = Args.getLastArg(options::OPT_arch)) {
365 StringRef ArchName = A->getValue();
366 tools::darwin::setTripleTypeForMachOArchName(Target, ArchName);
370 // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
371 // '-mbig-endian'/'-EB'.
372 if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
373 options::OPT_mbig_endian)) {
374 if (A->getOption().matches(options::OPT_mlittle_endian)) {
375 llvm::Triple LE = Target.getLittleEndianArchVariant();
376 if (LE.getArch() != llvm::Triple::UnknownArch)
377 Target = std::move(LE);
379 llvm::Triple BE = Target.getBigEndianArchVariant();
380 if (BE.getArch() != llvm::Triple::UnknownArch)
381 Target = std::move(BE);
385 // Skip further flag support on OSes which don't support '-m32' or '-m64'.
386 if (Target.getArch() == llvm::Triple::tce ||
387 Target.getOS() == llvm::Triple::Minix)
390 // Handle pseudo-target flags '-m64', '-mx32', '-m32' and '-m16'.
391 Arg *A = Args.getLastArg(options::OPT_m64, options::OPT_mx32,
392 options::OPT_m32, options::OPT_m16);
394 llvm::Triple::ArchType AT = llvm::Triple::UnknownArch;
396 if (A->getOption().matches(options::OPT_m64)) {
397 AT = Target.get64BitArchVariant().getArch();
398 if (Target.getEnvironment() == llvm::Triple::GNUX32)
399 Target.setEnvironment(llvm::Triple::GNU);
400 } else if (A->getOption().matches(options::OPT_mx32) &&
401 Target.get64BitArchVariant().getArch() == llvm::Triple::x86_64) {
402 AT = llvm::Triple::x86_64;
403 Target.setEnvironment(llvm::Triple::GNUX32);
404 } else if (A->getOption().matches(options::OPT_m32)) {
405 AT = Target.get32BitArchVariant().getArch();
406 if (Target.getEnvironment() == llvm::Triple::GNUX32)
407 Target.setEnvironment(llvm::Triple::GNU);
408 } else if (A->getOption().matches(options::OPT_m16) &&
409 Target.get32BitArchVariant().getArch() == llvm::Triple::x86) {
410 AT = llvm::Triple::x86;
411 Target.setEnvironment(llvm::Triple::CODE16);
414 if (AT != llvm::Triple::UnknownArch && AT != Target.getArch())
418 // Handle -miamcu flag.
419 if (Args.hasFlag(options::OPT_miamcu, options::OPT_mno_iamcu, false)) {
420 if (Target.get32BitArchVariant().getArch() != llvm::Triple::x86)
421 D.Diag(diag::err_drv_unsupported_opt_for_target) << "-miamcu"
424 if (A && !A->getOption().matches(options::OPT_m32))
425 D.Diag(diag::err_drv_argument_not_allowed_with)
426 << "-miamcu" << A->getBaseArg().getAsString(Args);
428 Target.setArch(llvm::Triple::x86);
429 Target.setArchName("i586");
430 Target.setEnvironment(llvm::Triple::UnknownEnvironment);
431 Target.setEnvironmentName("");
432 Target.setOS(llvm::Triple::ELFIAMCU);
433 Target.setVendor(llvm::Triple::UnknownVendor);
434 Target.setVendorName("intel");
440 // \brief Parse the LTO options and record the type of LTO compilation
441 // based on which -f(no-)?lto(=.*)? option occurs last.
442 void Driver::setLTOMode(const llvm::opt::ArgList &Args) {
444 if (!Args.hasFlag(options::OPT_flto, options::OPT_flto_EQ,
445 options::OPT_fno_lto, false))
448 StringRef LTOName("full");
450 const Arg *A = Args.getLastArg(options::OPT_flto_EQ);
452 LTOName = A->getValue();
454 LTOMode = llvm::StringSwitch<LTOKind>(LTOName)
455 .Case("full", LTOK_Full)
456 .Case("thin", LTOK_Thin)
457 .Default(LTOK_Unknown);
459 if (LTOMode == LTOK_Unknown) {
461 Diag(diag::err_drv_unsupported_option_argument) << A->getOption().getName()
466 /// Compute the desired OpenMP runtime from the flags provided.
467 Driver::OpenMPRuntimeKind Driver::getOpenMPRuntime(const ArgList &Args) const {
468 StringRef RuntimeName(CLANG_DEFAULT_OPENMP_RUNTIME);
470 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
472 RuntimeName = A->getValue();
474 auto RT = llvm::StringSwitch<OpenMPRuntimeKind>(RuntimeName)
475 .Case("libomp", OMPRT_OMP)
476 .Case("libgomp", OMPRT_GOMP)
477 .Case("libiomp5", OMPRT_IOMP5)
478 .Default(OMPRT_Unknown);
480 if (RT == OMPRT_Unknown) {
482 Diag(diag::err_drv_unsupported_option_argument)
483 << A->getOption().getName() << A->getValue();
485 // FIXME: We could use a nicer diagnostic here.
486 Diag(diag::err_drv_unsupported_opt) << "-fopenmp";
492 void Driver::CreateOffloadingDeviceToolChains(Compilation &C,
498 // We need to generate a CUDA toolchain if any of the inputs has a CUDA type.
499 if (llvm::any_of(Inputs, [](std::pair<types::ID, const llvm::opt::Arg *> &I) {
500 return types::isCuda(I.first);
502 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
503 const llvm::Triple &HostTriple = HostTC->getTriple();
504 llvm::Triple CudaTriple(HostTriple.isArch64Bit() ? "nvptx64-nvidia-cuda"
505 : "nvptx-nvidia-cuda");
506 // Use the CUDA and host triples as the key into the ToolChains map, because
507 // the device toolchain we create depends on both.
508 auto &CudaTC = ToolChains[CudaTriple.str() + "/" + HostTriple.str()];
510 CudaTC = llvm::make_unique<toolchains::CudaToolChain>(
511 *this, CudaTriple, *HostTC, C.getInputArgs());
513 C.addOffloadDeviceToolChain(CudaTC.get(), Action::OFK_Cuda);
519 // We need to generate an OpenMP toolchain if the user specified targets with
520 // the -fopenmp-targets option.
521 if (Arg *OpenMPTargets =
522 C.getInputArgs().getLastArg(options::OPT_fopenmp_targets_EQ)) {
523 if (OpenMPTargets->getNumValues()) {
524 // We expect that -fopenmp-targets is always used in conjunction with the
525 // option -fopenmp specifying a valid runtime with offloading support,
526 // i.e. libomp or libiomp.
527 bool HasValidOpenMPRuntime = C.getInputArgs().hasFlag(
528 options::OPT_fopenmp, options::OPT_fopenmp_EQ,
529 options::OPT_fno_openmp, false);
530 if (HasValidOpenMPRuntime) {
531 OpenMPRuntimeKind OpenMPKind = getOpenMPRuntime(C.getInputArgs());
532 HasValidOpenMPRuntime =
533 OpenMPKind == OMPRT_OMP || OpenMPKind == OMPRT_IOMP5;
536 if (HasValidOpenMPRuntime) {
537 llvm::StringMap<const char *> FoundNormalizedTriples;
538 for (const char *Val : OpenMPTargets->getValues()) {
539 llvm::Triple TT(Val);
540 std::string NormalizedName = TT.normalize();
542 // Make sure we don't have a duplicate triple.
543 auto Duplicate = FoundNormalizedTriples.find(NormalizedName);
544 if (Duplicate != FoundNormalizedTriples.end()) {
545 Diag(clang::diag::warn_drv_omp_offload_target_duplicate)
546 << Val << Duplicate->second;
550 // Store the current triple so that we can check for duplicates in the
551 // following iterations.
552 FoundNormalizedTriples[NormalizedName] = Val;
554 // If the specified target is invalid, emit a diagnostic.
555 if (TT.getArch() == llvm::Triple::UnknownArch)
556 Diag(clang::diag::err_drv_invalid_omp_target) << Val;
558 const ToolChain &TC = getToolChain(C.getInputArgs(), TT);
559 C.addOffloadDeviceToolChain(&TC, Action::OFK_OpenMP);
563 Diag(clang::diag::err_drv_expecting_fopenmp_with_fopenmp_targets);
565 Diag(clang::diag::warn_drv_empty_joined_argument)
566 << OpenMPTargets->getAsString(C.getInputArgs());
570 // TODO: Add support for other offloading programming models here.
576 Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
577 llvm::PrettyStackTraceString CrashInfo("Compilation construction");
579 // FIXME: Handle environment options which affect driver behavior, somewhere
580 // (client?). GCC_EXEC_PREFIX, LPATH, CC_PRINT_OPTIONS.
582 if (Optional<std::string> CompilerPathValue =
583 llvm::sys::Process::GetEnv("COMPILER_PATH")) {
584 StringRef CompilerPath = *CompilerPathValue;
585 while (!CompilerPath.empty()) {
586 std::pair<StringRef, StringRef> Split =
587 CompilerPath.split(llvm::sys::EnvPathSeparator);
588 PrefixDirs.push_back(Split.first);
589 CompilerPath = Split.second;
593 // We look for the driver mode option early, because the mode can affect
594 // how other options are parsed.
595 ParseDriverMode(ClangExecutable, ArgList.slice(1));
597 // FIXME: What are we going to do with -V and -b?
599 // FIXME: This stuff needs to go into the Compilation, not the driver.
602 InputArgList Args = ParseArgStrings(ArgList.slice(1));
603 if (Diags.hasErrorOccurred())
606 // Silence driver warnings if requested
607 Diags.setIgnoreAllWarnings(Args.hasArg(options::OPT_w));
609 // -no-canonical-prefixes is used very early in main.
610 Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
613 Args.ClaimAllArgs(options::OPT_pipe);
615 // Extract -ccc args.
617 // FIXME: We need to figure out where this behavior should live. Most of it
618 // should be outside in the client; the parts that aren't should have proper
619 // options, either by introducing new ones or by overloading gcc ones like -V
621 CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
622 CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
623 if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
624 CCCGenericGCCName = A->getValue();
626 Args.hasFlag(options::OPT_ccc_pch_is_pch, options::OPT_ccc_pch_is_pth);
627 GenReproducer = Args.hasFlag(options::OPT_gen_reproducer,
628 options::OPT_fno_crash_diagnostics,
629 !!::getenv("FORCE_CLANG_DIAGNOSTICS_CRASH"));
630 // FIXME: DefaultTargetTriple is used by the target-prefixed calls to as/ld
631 // and getToolChain is const.
633 // clang-cl targets MSVC-style Win32.
634 llvm::Triple T(DefaultTargetTriple);
635 T.setOS(llvm::Triple::Win32);
636 T.setVendor(llvm::Triple::PC);
637 T.setEnvironment(llvm::Triple::MSVC);
638 DefaultTargetTriple = T.str();
640 if (const Arg *A = Args.getLastArg(options::OPT_target))
641 DefaultTargetTriple = A->getValue();
642 if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
643 Dir = InstalledDir = A->getValue();
644 for (const Arg *A : Args.filtered(options::OPT_B)) {
646 PrefixDirs.push_back(A->getValue(0));
648 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
649 SysRoot = A->getValue();
650 if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
651 DyldPrefix = A->getValue();
652 if (Args.hasArg(options::OPT_nostdlib))
655 if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
656 ResourceDir = A->getValue();
658 if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
659 SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
660 .Case("cwd", SaveTempsCwd)
661 .Case("obj", SaveTempsObj)
662 .Default(SaveTempsCwd);
667 // Process -fembed-bitcode= flags.
668 if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
669 StringRef Name = A->getValue();
670 unsigned Model = llvm::StringSwitch<unsigned>(Name)
671 .Case("off", EmbedNone)
672 .Case("all", EmbedBitcode)
673 .Case("bitcode", EmbedBitcode)
674 .Case("marker", EmbedMarker)
677 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
680 BitcodeEmbed = static_cast<BitcodeEmbedMode>(Model);
683 std::unique_ptr<llvm::opt::InputArgList> UArgs =
684 llvm::make_unique<InputArgList>(std::move(Args));
686 // Perform the default argument translations.
687 DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
689 // Owned by the host.
690 const ToolChain &TC = getToolChain(
691 *UArgs, computeTargetTriple(*this, DefaultTargetTriple, *UArgs));
693 // The compilation takes ownership of Args.
694 Compilation *C = new Compilation(*this, TC, UArgs.release(), TranslatedArgs);
696 if (!HandleImmediateArgs(*C))
699 // Construct the list of inputs.
701 BuildInputs(C->getDefaultToolChain(), *TranslatedArgs, Inputs);
703 // Populate the tool chains for the offloading devices, if any.
704 CreateOffloadingDeviceToolChains(*C, Inputs);
706 // Construct the list of abstract actions to perform for this compilation. On
707 // MachO targets this uses the driver-driver and universal actions.
708 if (TC.getTriple().isOSBinFormatMachO())
709 BuildUniversalActions(*C, C->getDefaultToolChain(), Inputs);
711 BuildActions(*C, C->getArgs(), Inputs, C->getActions());
713 if (CCCPrintPhases) {
723 static void printArgList(raw_ostream &OS, const llvm::opt::ArgList &Args) {
724 llvm::opt::ArgStringList ASL;
725 for (const auto *A : Args)
726 A->render(Args, ASL);
728 for (auto I = ASL.begin(), E = ASL.end(); I != E; ++I) {
729 if (I != ASL.begin())
731 Command::printArg(OS, *I, true);
736 bool Driver::getCrashDiagnosticFile(StringRef ReproCrashFilename,
737 SmallString<128> &CrashDiagDir) {
738 using namespace llvm::sys;
739 assert(llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin() &&
740 "Only knows about .crash files on Darwin");
742 // The .crash file can be found on at ~/Library/Logs/DiagnosticReports/
743 // (or /Library/Logs/DiagnosticReports for root) and has the filename pattern
744 // clang-<VERSION>_<YYYY-MM-DD-HHMMSS>_<hostname>.crash.
745 path::home_directory(CrashDiagDir);
746 if (CrashDiagDir.startswith("/var/root"))
748 path::append(CrashDiagDir, "Library/Logs/DiagnosticReports");
756 fs::file_status FileStatus;
757 TimePoint<> LastAccessTime;
758 SmallString<128> CrashFilePath;
759 // Lookup the .crash files and get the one generated by a subprocess spawned
760 // by this driver invocation.
761 for (fs::directory_iterator File(CrashDiagDir, EC), FileEnd;
762 File != FileEnd && !EC; File.increment(EC)) {
763 StringRef FileName = path::filename(File->path());
764 if (!FileName.startswith(Name))
766 if (fs::status(File->path(), FileStatus))
768 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CrashFile =
769 llvm::MemoryBuffer::getFile(File->path());
772 // The first line should start with "Process:", otherwise this isn't a real
774 StringRef Data = CrashFile.get()->getBuffer();
775 if (!Data.startswith("Process:"))
777 // Parse parent process pid line, e.g: "Parent Process: clang-4.0 [79141]"
778 size_t ParentProcPos = Data.find("Parent Process:");
779 if (ParentProcPos == StringRef::npos)
781 size_t LineEnd = Data.find_first_of("\n", ParentProcPos);
782 if (LineEnd == StringRef::npos)
784 StringRef ParentProcess = Data.slice(ParentProcPos+15, LineEnd).trim();
785 int OpenBracket = -1, CloseBracket = -1;
786 for (size_t i = 0, e = ParentProcess.size(); i < e; ++i) {
787 if (ParentProcess[i] == '[')
789 if (ParentProcess[i] == ']')
792 // Extract the parent process PID from the .crash file and check whether
793 // it matches this driver invocation pid.
795 if (OpenBracket < 0 || CloseBracket < 0 ||
796 ParentProcess.slice(OpenBracket + 1, CloseBracket)
797 .getAsInteger(10, CrashPID) || CrashPID != PID) {
801 // Found a .crash file matching the driver pid. To avoid getting an older
802 // and misleading crash file, continue looking for the most recent.
803 // FIXME: the driver can dispatch multiple cc1 invocations, leading to
804 // multiple crashes poiting to the same parent process. Since the driver
805 // does not collect pid information for the dispatched invocation there's
806 // currently no way to distinguish among them.
807 const auto FileAccessTime = FileStatus.getLastModificationTime();
808 if (FileAccessTime > LastAccessTime) {
809 CrashFilePath.assign(File->path());
810 LastAccessTime = FileAccessTime;
814 // If found, copy it over to the location of other reproducer files.
815 if (!CrashFilePath.empty()) {
816 EC = fs::copy_file(CrashFilePath, ReproCrashFilename);
825 // When clang crashes, produce diagnostic information including the fully
826 // preprocessed source file(s). Request that the developer attach the
827 // diagnostic information to a bug report.
828 void Driver::generateCompilationDiagnostics(Compilation &C,
829 const Command &FailingCommand) {
830 if (C.getArgs().hasArg(options::OPT_fno_crash_diagnostics))
833 // Don't try to generate diagnostics for link or dsymutil jobs.
834 if (FailingCommand.getCreator().isLinkJob() ||
835 FailingCommand.getCreator().isDsymutilJob())
838 // Print the version of the compiler.
839 PrintVersion(C, llvm::errs());
841 Diag(clang::diag::note_drv_command_failed_diag_msg)
842 << "PLEASE submit a bug report to " BUG_REPORT_URL " and include the "
843 "crash backtrace, preprocessed source, and associated run script.";
845 // Suppress driver output and emit preprocessor output to temp file.
847 CCGenDiagnostics = true;
849 // Save the original job command(s).
850 Command Cmd = FailingCommand;
852 // Keep track of whether we produce any errors while trying to produce
853 // preprocessed sources.
854 DiagnosticErrorTrap Trap(Diags);
856 // Suppress tool output.
857 C.initCompilationForDiagnostics();
859 // Construct the list of inputs.
861 BuildInputs(C.getDefaultToolChain(), C.getArgs(), Inputs);
863 for (InputList::iterator it = Inputs.begin(), ie = Inputs.end(); it != ie;) {
864 bool IgnoreInput = false;
866 // Ignore input from stdin or any inputs that cannot be preprocessed.
867 // Check type first as not all linker inputs have a value.
868 if (types::getPreprocessedType(it->first) == types::TY_INVALID) {
870 } else if (!strcmp(it->second->getValue(), "-")) {
871 Diag(clang::diag::note_drv_command_failed_diag_msg)
872 << "Error generating preprocessed source(s) - "
873 "ignoring input from stdin.";
878 it = Inputs.erase(it);
885 if (Inputs.empty()) {
886 Diag(clang::diag::note_drv_command_failed_diag_msg)
887 << "Error generating preprocessed source(s) - "
888 "no preprocessable inputs.";
892 // Don't attempt to generate preprocessed files if multiple -arch options are
893 // used, unless they're all duplicates.
894 llvm::StringSet<> ArchNames;
895 for (const Arg *A : C.getArgs()) {
896 if (A->getOption().matches(options::OPT_arch)) {
897 StringRef ArchName = A->getValue();
898 ArchNames.insert(ArchName);
901 if (ArchNames.size() > 1) {
902 Diag(clang::diag::note_drv_command_failed_diag_msg)
903 << "Error generating preprocessed source(s) - cannot generate "
904 "preprocessed source with multiple -arch options.";
908 // Construct the list of abstract actions to perform for this compilation. On
909 // Darwin OSes this uses the driver-driver and builds universal actions.
910 const ToolChain &TC = C.getDefaultToolChain();
911 if (TC.getTriple().isOSBinFormatMachO())
912 BuildUniversalActions(C, TC, Inputs);
914 BuildActions(C, C.getArgs(), Inputs, C.getActions());
918 // If there were errors building the compilation, quit now.
919 if (Trap.hasErrorOccurred()) {
920 Diag(clang::diag::note_drv_command_failed_diag_msg)
921 << "Error generating preprocessed source(s).";
925 // Generate preprocessed output.
926 SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
927 C.ExecuteJobs(C.getJobs(), FailingCommands);
929 // If any of the preprocessing commands failed, clean up and exit.
930 if (!FailingCommands.empty()) {
931 if (!isSaveTempsEnabled())
932 C.CleanupFileList(C.getTempFiles(), true);
934 Diag(clang::diag::note_drv_command_failed_diag_msg)
935 << "Error generating preprocessed source(s).";
939 const ArgStringList &TempFiles = C.getTempFiles();
940 if (TempFiles.empty()) {
941 Diag(clang::diag::note_drv_command_failed_diag_msg)
942 << "Error generating preprocessed source(s).";
946 Diag(clang::diag::note_drv_command_failed_diag_msg)
947 << "\n********************\n\n"
948 "PLEASE ATTACH THE FOLLOWING FILES TO THE BUG REPORT:\n"
949 "Preprocessed source(s) and associated run script(s) are located at:";
951 SmallString<128> VFS;
952 SmallString<128> ReproCrashFilename;
953 for (const char *TempFile : TempFiles) {
954 Diag(clang::diag::note_drv_command_failed_diag_msg) << TempFile;
955 if (ReproCrashFilename.empty()) {
956 ReproCrashFilename = TempFile;
957 llvm::sys::path::replace_extension(ReproCrashFilename, ".crash");
959 if (StringRef(TempFile).endswith(".cache")) {
960 // In some cases (modules) we'll dump extra data to help with reproducing
961 // the crash into a directory next to the output.
962 VFS = llvm::sys::path::filename(TempFile);
963 llvm::sys::path::append(VFS, "vfs", "vfs.yaml");
967 // Assume associated files are based off of the first temporary file.
968 CrashReportInfo CrashInfo(TempFiles[0], VFS);
970 std::string Script = CrashInfo.Filename.rsplit('.').first.str() + ".sh";
972 llvm::raw_fd_ostream ScriptOS(Script, EC, llvm::sys::fs::F_Excl);
974 Diag(clang::diag::note_drv_command_failed_diag_msg)
975 << "Error generating run script: " + Script + " " + EC.message();
977 ScriptOS << "# Crash reproducer for " << getClangFullVersion() << "\n"
978 << "# Driver args: ";
979 printArgList(ScriptOS, C.getInputArgs());
980 ScriptOS << "# Original command: ";
981 Cmd.Print(ScriptOS, "\n", /*Quote=*/true);
982 Cmd.Print(ScriptOS, "\n", /*Quote=*/true, &CrashInfo);
983 Diag(clang::diag::note_drv_command_failed_diag_msg) << Script;
986 // On darwin, provide information about the .crash diagnostic report.
987 if (llvm::Triple(llvm::sys::getProcessTriple()).isOSDarwin()) {
988 SmallString<128> CrashDiagDir;
989 if (getCrashDiagnosticFile(ReproCrashFilename, CrashDiagDir)) {
990 Diag(clang::diag::note_drv_command_failed_diag_msg)
991 << ReproCrashFilename.str();
992 } else { // Suggest a directory for the user to look for .crash files.
993 llvm::sys::path::append(CrashDiagDir, Name);
994 CrashDiagDir += "_<YYYY-MM-DD-HHMMSS>_<hostname>.crash";
995 Diag(clang::diag::note_drv_command_failed_diag_msg)
996 << "Crash backtrace is located in";
997 Diag(clang::diag::note_drv_command_failed_diag_msg)
998 << CrashDiagDir.str();
999 Diag(clang::diag::note_drv_command_failed_diag_msg)
1000 << "(choose the .crash file that corresponds to your crash)";
1004 for (const auto &A : C.getArgs().filtered(options::OPT_frewrite_map_file,
1005 options::OPT_frewrite_map_file_EQ))
1006 Diag(clang::diag::note_drv_command_failed_diag_msg) << A->getValue();
1008 Diag(clang::diag::note_drv_command_failed_diag_msg)
1009 << "\n\n********************";
1012 void Driver::setUpResponseFiles(Compilation &C, Command &Cmd) {
1013 // Since commandLineFitsWithinSystemLimits() may underestimate system's capacity
1014 // if the tool does not support response files, there is a chance/ that things
1015 // will just work without a response file, so we silently just skip it.
1016 if (Cmd.getCreator().getResponseFilesSupport() == Tool::RF_None ||
1017 llvm::sys::commandLineFitsWithinSystemLimits(Cmd.getExecutable(), Cmd.getArguments()))
1020 std::string TmpName = GetTemporaryPath("response", "txt");
1021 Cmd.setResponseFile(C.addTempFile(C.getArgs().MakeArgString(TmpName)));
1024 int Driver::ExecuteCompilation(
1026 SmallVectorImpl<std::pair<int, const Command *>> &FailingCommands) {
1027 // Just print if -### was present.
1028 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
1029 C.getJobs().Print(llvm::errs(), "\n", true);
1033 // If there were errors building the compilation, quit now.
1034 if (Diags.hasErrorOccurred())
1037 // Set up response file names for each command, if necessary
1038 for (auto &Job : C.getJobs())
1039 setUpResponseFiles(C, Job);
1041 C.ExecuteJobs(C.getJobs(), FailingCommands);
1043 // Remove temp files.
1044 C.CleanupFileList(C.getTempFiles());
1046 // If the command succeeded, we are done.
1047 if (FailingCommands.empty())
1050 // Otherwise, remove result files and print extra information about abnormal
1052 for (const auto &CmdPair : FailingCommands) {
1053 int Res = CmdPair.first;
1054 const Command *FailingCommand = CmdPair.second;
1056 // Remove result files if we're not saving temps.
1057 if (!isSaveTempsEnabled()) {
1058 const JobAction *JA = cast<JobAction>(&FailingCommand->getSource());
1059 C.CleanupFileMap(C.getResultFiles(), JA, true);
1061 // Failure result files are valid unless we crashed.
1063 C.CleanupFileMap(C.getFailureResultFiles(), JA, true);
1066 // Print extra information about abnormal failures, if possible.
1068 // This is ad-hoc, but we don't want to be excessively noisy. If the result
1069 // status was 1, assume the command failed normally. In particular, if it
1070 // was the compiler then assume it gave a reasonable error code. Failures
1071 // in other tools are less common, and they generally have worse
1072 // diagnostics, so always print the diagnostic there.
1073 const Tool &FailingTool = FailingCommand->getCreator();
1075 if (!FailingCommand->getCreator().hasGoodDiagnostics() || Res != 1) {
1076 // FIXME: See FIXME above regarding result code interpretation.
1078 Diag(clang::diag::err_drv_command_signalled)
1079 << FailingTool.getShortName();
1081 Diag(clang::diag::err_drv_command_failed) << FailingTool.getShortName()
1088 void Driver::PrintHelp(bool ShowHidden) const {
1089 unsigned IncludedFlagsBitmask;
1090 unsigned ExcludedFlagsBitmask;
1091 std::tie(IncludedFlagsBitmask, ExcludedFlagsBitmask) =
1092 getIncludeExcludeOptionFlagMasks();
1094 ExcludedFlagsBitmask |= options::NoDriverOption;
1096 ExcludedFlagsBitmask |= HelpHidden;
1098 getOpts().PrintHelp(llvm::outs(), Name.c_str(), DriverTitle.c_str(),
1099 IncludedFlagsBitmask, ExcludedFlagsBitmask);
1102 void Driver::PrintVersion(const Compilation &C, raw_ostream &OS) const {
1103 // FIXME: The following handlers should use a callback mechanism, we don't
1104 // know what the client would like to do.
1105 OS << getClangFullVersion() << '\n';
1106 const ToolChain &TC = C.getDefaultToolChain();
1107 OS << "Target: " << TC.getTripleString() << '\n';
1109 // Print the threading model.
1110 if (Arg *A = C.getArgs().getLastArg(options::OPT_mthread_model)) {
1111 // Don't print if the ToolChain would have barfed on it already
1112 if (TC.isThreadModelSupported(A->getValue()))
1113 OS << "Thread model: " << A->getValue();
1115 OS << "Thread model: " << TC.getThreadModel();
1118 // Print out the install directory.
1119 OS << "InstalledDir: " << InstalledDir << '\n';
1122 /// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
1124 static void PrintDiagnosticCategories(raw_ostream &OS) {
1125 // Skip the empty category.
1126 for (unsigned i = 1, max = DiagnosticIDs::getNumberOfCategories(); i != max;
1128 OS << i << ',' << DiagnosticIDs::getCategoryNameFromID(i) << '\n';
1131 bool Driver::HandleImmediateArgs(const Compilation &C) {
1132 // The order these options are handled in gcc is all over the place, but we
1133 // don't expect inconsistencies w.r.t. that to matter in practice.
1135 if (C.getArgs().hasArg(options::OPT_dumpmachine)) {
1136 llvm::outs() << C.getDefaultToolChain().getTripleString() << '\n';
1140 if (C.getArgs().hasArg(options::OPT_dumpversion)) {
1141 // Since -dumpversion is only implemented for pedantic GCC compatibility, we
1142 // return an answer which matches our definition of __VERSION__.
1144 // If we want to return a more correct answer some day, then we should
1145 // introduce a non-pedantically GCC compatible mode to Clang in which we
1146 // provide sensible definitions for -dumpversion, __VERSION__, etc.
1147 llvm::outs() << "4.2.1\n";
1151 if (C.getArgs().hasArg(options::OPT__print_diagnostic_categories)) {
1152 PrintDiagnosticCategories(llvm::outs());
1156 if (C.getArgs().hasArg(options::OPT_help) ||
1157 C.getArgs().hasArg(options::OPT__help_hidden)) {
1158 PrintHelp(C.getArgs().hasArg(options::OPT__help_hidden));
1162 if (C.getArgs().hasArg(options::OPT__version)) {
1163 // Follow gcc behavior and use stdout for --version and stderr for -v.
1164 PrintVersion(C, llvm::outs());
1166 // Print registered targets.
1167 llvm::outs() << '\n';
1168 llvm::TargetRegistry::printRegisteredTargetsForVersion(llvm::outs());
1172 if (C.getArgs().hasArg(options::OPT_v) ||
1173 C.getArgs().hasArg(options::OPT__HASH_HASH_HASH)) {
1174 PrintVersion(C, llvm::errs());
1175 SuppressMissingInputWarning = true;
1178 const ToolChain &TC = C.getDefaultToolChain();
1180 if (C.getArgs().hasArg(options::OPT_v))
1181 TC.printVerboseInfo(llvm::errs());
1183 if (C.getArgs().hasArg(options::OPT_print_resource_dir)) {
1184 llvm::outs() << ResourceDir << '\n';
1188 if (C.getArgs().hasArg(options::OPT_print_search_dirs)) {
1189 llvm::outs() << "programs: =";
1190 bool separator = false;
1191 for (const std::string &Path : TC.getProgramPaths()) {
1193 llvm::outs() << ':';
1194 llvm::outs() << Path;
1197 llvm::outs() << "\n";
1198 llvm::outs() << "libraries: =" << ResourceDir;
1200 StringRef sysroot = C.getSysRoot();
1202 for (const std::string &Path : TC.getFilePaths()) {
1203 // Always print a separator. ResourceDir was the first item shown.
1204 llvm::outs() << ':';
1205 // Interpretation of leading '=' is needed only for NetBSD.
1207 llvm::outs() << sysroot << Path.substr(1);
1209 llvm::outs() << Path;
1211 llvm::outs() << "\n";
1215 // FIXME: The following handlers should use a callback mechanism, we don't
1216 // know what the client would like to do.
1217 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_file_name_EQ)) {
1218 llvm::outs() << GetFilePath(A->getValue(), TC) << "\n";
1222 if (Arg *A = C.getArgs().getLastArg(options::OPT_print_prog_name_EQ)) {
1223 llvm::outs() << GetProgramPath(A->getValue(), TC) << "\n";
1227 if (Arg *A = C.getArgs().getLastArg(options::OPT_autocomplete)) {
1228 // Print out all options that start with a given argument. This is used for
1229 // shell autocompletion.
1230 llvm::outs() << llvm::join(Opts->findByPrefix(A->getValue()), " ") << '\n';
1234 if (C.getArgs().hasArg(options::OPT_print_libgcc_file_name)) {
1235 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(C.getArgs());
1237 case ToolChain::RLT_CompilerRT:
1238 llvm::outs() << TC.getCompilerRT(C.getArgs(), "builtins") << "\n";
1240 case ToolChain::RLT_Libgcc:
1241 llvm::outs() << GetFilePath("libgcc.a", TC) << "\n";
1247 if (C.getArgs().hasArg(options::OPT_print_multi_lib)) {
1248 for (const Multilib &Multilib : TC.getMultilibs())
1249 llvm::outs() << Multilib << "\n";
1253 if (C.getArgs().hasArg(options::OPT_print_multi_directory)) {
1254 for (const Multilib &Multilib : TC.getMultilibs()) {
1255 if (Multilib.gccSuffix().empty())
1256 llvm::outs() << ".\n";
1258 StringRef Suffix(Multilib.gccSuffix());
1259 assert(Suffix.front() == '/');
1260 llvm::outs() << Suffix.substr(1) << "\n";
1268 // Display an action graph human-readably. Action A is the "sink" node
1269 // and latest-occuring action. Traversal is in pre-order, visiting the
1270 // inputs to each action before printing the action itself.
1271 static unsigned PrintActions1(const Compilation &C, Action *A,
1272 std::map<Action *, unsigned> &Ids) {
1273 if (Ids.count(A)) // A was already visited.
1277 llvm::raw_string_ostream os(str);
1279 os << Action::getClassName(A->getKind()) << ", ";
1280 if (InputAction *IA = dyn_cast<InputAction>(A)) {
1281 os << "\"" << IA->getInputArg().getValue() << "\"";
1282 } else if (BindArchAction *BIA = dyn_cast<BindArchAction>(A)) {
1283 os << '"' << BIA->getArchName() << '"' << ", {"
1284 << PrintActions1(C, *BIA->input_begin(), Ids) << "}";
1285 } else if (OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
1286 bool IsFirst = true;
1287 OA->doOnEachDependence(
1288 [&](Action *A, const ToolChain *TC, const char *BoundArch) {
1289 // E.g. for two CUDA device dependences whose bound arch is sm_20 and
1290 // sm_35 this will generate:
1291 // "cuda-device" (nvptx64-nvidia-cuda:sm_20) {#ID}, "cuda-device"
1292 // (nvptx64-nvidia-cuda:sm_35) {#ID}
1297 os << A->getOffloadingKindPrefix();
1301 os << TC->getTriple().normalize();
1304 os << ":" << BoundArch;
1307 os << " {" << PrintActions1(C, A, Ids) << "}";
1311 const ActionList *AL = &A->getInputs();
1314 const char *Prefix = "{";
1315 for (Action *PreRequisite : *AL) {
1316 os << Prefix << PrintActions1(C, PreRequisite, Ids);
1324 // Append offload info for all options other than the offloading action
1325 // itself (e.g. (cuda-device, sm_20) or (cuda-host)).
1326 std::string offload_str;
1327 llvm::raw_string_ostream offload_os(offload_str);
1328 if (!isa<OffloadAction>(A)) {
1329 auto S = A->getOffloadingKindPrefix();
1331 offload_os << ", (" << S;
1332 if (A->getOffloadingArch())
1333 offload_os << ", " << A->getOffloadingArch();
1338 unsigned Id = Ids.size();
1340 llvm::errs() << Id << ": " << os.str() << ", "
1341 << types::getTypeName(A->getType()) << offload_os.str() << "\n";
1346 // Print the action graphs in a compilation C.
1347 // For example "clang -c file1.c file2.c" is composed of two subgraphs.
1348 void Driver::PrintActions(const Compilation &C) const {
1349 std::map<Action *, unsigned> Ids;
1350 for (Action *A : C.getActions())
1351 PrintActions1(C, A, Ids);
1354 /// \brief Check whether the given input tree contains any compilation or
1355 /// assembly actions.
1356 static bool ContainsCompileOrAssembleAction(const Action *A) {
1357 if (isa<CompileJobAction>(A) || isa<BackendJobAction>(A) ||
1358 isa<AssembleJobAction>(A))
1361 for (const Action *Input : A->inputs())
1362 if (ContainsCompileOrAssembleAction(Input))
1368 void Driver::BuildUniversalActions(Compilation &C, const ToolChain &TC,
1369 const InputList &BAInputs) const {
1370 DerivedArgList &Args = C.getArgs();
1371 ActionList &Actions = C.getActions();
1372 llvm::PrettyStackTraceString CrashInfo("Building universal build actions");
1373 // Collect the list of architectures. Duplicates are allowed, but should only
1374 // be handled once (in the order seen).
1375 llvm::StringSet<> ArchNames;
1376 SmallVector<const char *, 4> Archs;
1377 for (Arg *A : Args) {
1378 if (A->getOption().matches(options::OPT_arch)) {
1379 // Validate the option here; we don't save the type here because its
1380 // particular spelling may participate in other driver choices.
1381 llvm::Triple::ArchType Arch =
1382 tools::darwin::getArchTypeForMachOArchName(A->getValue());
1383 if (Arch == llvm::Triple::UnknownArch) {
1384 Diag(clang::diag::err_drv_invalid_arch_name) << A->getAsString(Args);
1389 if (ArchNames.insert(A->getValue()).second)
1390 Archs.push_back(A->getValue());
1394 // When there is no explicit arch for this platform, make sure we still bind
1395 // the architecture (to the default) so that -Xarch_ is handled correctly.
1397 Archs.push_back(Args.MakeArgString(TC.getDefaultUniversalArchName()));
1399 ActionList SingleActions;
1400 BuildActions(C, Args, BAInputs, SingleActions);
1402 // Add in arch bindings for every top level action, as well as lipo and
1403 // dsymutil steps if needed.
1404 for (Action* Act : SingleActions) {
1405 // Make sure we can lipo this kind of output. If not (and it is an actual
1406 // output) then we disallow, since we can't create an output file with the
1407 // right name without overwriting it. We could remove this oddity by just
1408 // changing the output names to include the arch, which would also fix
1409 // -save-temps. Compatibility wins for now.
1411 if (Archs.size() > 1 && !types::canLipoType(Act->getType()))
1412 Diag(clang::diag::err_drv_invalid_output_with_multiple_archs)
1413 << types::getTypeName(Act->getType());
1416 for (unsigned i = 0, e = Archs.size(); i != e; ++i)
1417 Inputs.push_back(C.MakeAction<BindArchAction>(Act, Archs[i]));
1419 // Lipo if necessary, we do it this way because we need to set the arch flag
1420 // so that -Xarch_ gets overwritten.
1421 if (Inputs.size() == 1 || Act->getType() == types::TY_Nothing)
1422 Actions.append(Inputs.begin(), Inputs.end());
1424 Actions.push_back(C.MakeAction<LipoJobAction>(Inputs, Act->getType()));
1426 // Handle debug info queries.
1427 Arg *A = Args.getLastArg(options::OPT_g_Group);
1428 if (A && !A->getOption().matches(options::OPT_g0) &&
1429 !A->getOption().matches(options::OPT_gstabs) &&
1430 ContainsCompileOrAssembleAction(Actions.back())) {
1432 // Add a 'dsymutil' step if necessary, when debug info is enabled and we
1433 // have a compile input. We need to run 'dsymutil' ourselves in such cases
1434 // because the debug info will refer to a temporary object file which
1435 // will be removed at the end of the compilation process.
1436 if (Act->getType() == types::TY_Image) {
1438 Inputs.push_back(Actions.back());
1441 C.MakeAction<DsymutilJobAction>(Inputs, types::TY_dSYM));
1444 // Verify the debug info output.
1445 if (Args.hasArg(options::OPT_verify_debug_info)) {
1446 Action* LastAction = Actions.back();
1448 Actions.push_back(C.MakeAction<VerifyDebugInfoJobAction>(
1449 LastAction, types::TY_Nothing));
1455 /// \brief Check that the file referenced by Value exists. If it doesn't,
1456 /// issue a diagnostic and return false.
1457 static bool DiagnoseInputExistence(const Driver &D, const DerivedArgList &Args,
1458 StringRef Value, types::ID Ty) {
1459 if (!D.getCheckInputsExist())
1462 // stdin always exists.
1466 SmallString<64> Path(Value);
1467 if (Arg *WorkDir = Args.getLastArg(options::OPT_working_directory)) {
1468 if (!llvm::sys::path::is_absolute(Path)) {
1469 SmallString<64> Directory(WorkDir->getValue());
1470 llvm::sys::path::append(Directory, Value);
1471 Path.assign(Directory);
1475 if (llvm::sys::fs::exists(Twine(Path)))
1479 if (!llvm::sys::path::is_absolute(Twine(Path)) &&
1480 llvm::sys::Process::FindInEnvPath("LIB", Value))
1483 if (Args.hasArg(options::OPT__SLASH_link) && Ty == types::TY_Object) {
1484 // Arguments to the /link flag might cause the linker to search for object
1485 // and library files in paths we don't know about. Don't error in such
1491 D.Diag(clang::diag::err_drv_no_such_file) << Path;
1495 // Construct a the list of inputs and their types.
1496 void Driver::BuildInputs(const ToolChain &TC, DerivedArgList &Args,
1497 InputList &Inputs) const {
1498 // Track the current user specified (-x) input. We also explicitly track the
1499 // argument used to set the type; we only want to claim the type when we
1500 // actually use it, so we warn about unused -x arguments.
1501 types::ID InputType = types::TY_Nothing;
1502 Arg *InputTypeArg = nullptr;
1504 // The last /TC or /TP option sets the input type to C or C++ globally.
1505 if (Arg *TCTP = Args.getLastArgNoClaim(options::OPT__SLASH_TC,
1506 options::OPT__SLASH_TP)) {
1507 InputTypeArg = TCTP;
1508 InputType = TCTP->getOption().matches(options::OPT__SLASH_TC)
1512 Arg *Previous = nullptr;
1513 bool ShowNote = false;
1514 for (Arg *A : Args.filtered(options::OPT__SLASH_TC, options::OPT__SLASH_TP)) {
1516 Diag(clang::diag::warn_drv_overriding_flag_option)
1517 << Previous->getSpelling() << A->getSpelling();
1523 Diag(clang::diag::note_drv_t_option_is_global);
1525 // No driver mode exposes -x and /TC or /TP; we don't support mixing them.
1526 assert(!Args.hasArg(options::OPT_x) && "-x and /TC or /TP is not allowed");
1529 for (Arg *A : Args) {
1530 if (A->getOption().getKind() == Option::InputClass) {
1531 const char *Value = A->getValue();
1532 types::ID Ty = types::TY_INVALID;
1534 // Infer the input type if necessary.
1535 if (InputType == types::TY_Nothing) {
1536 // If there was an explicit arg for this, claim it.
1538 InputTypeArg->claim();
1540 // stdin must be handled specially.
1541 if (memcmp(Value, "-", 2) == 0) {
1542 // If running with -E, treat as a C input (this changes the builtin
1543 // macros, for example). This may be overridden by -ObjC below.
1545 // Otherwise emit an error but still use a valid type to avoid
1546 // spurious errors (e.g., no inputs).
1547 if (!Args.hasArgNoClaim(options::OPT_E) && !CCCIsCPP())
1548 Diag(IsCLMode() ? clang::diag::err_drv_unknown_stdin_type_clang_cl
1549 : clang::diag::err_drv_unknown_stdin_type);
1552 // Otherwise lookup by extension.
1553 // Fallback is C if invoked as C preprocessor or Object otherwise.
1554 // We use a host hook here because Darwin at least has its own
1555 // idea of what .s is.
1556 if (const char *Ext = strrchr(Value, '.'))
1557 Ty = TC.LookupTypeForExtension(Ext + 1);
1559 if (Ty == types::TY_INVALID) {
1563 Ty = types::TY_Object;
1566 // If the driver is invoked as C++ compiler (like clang++ or c++) it
1567 // should autodetect some input files as C++ for g++ compatibility.
1569 types::ID OldTy = Ty;
1570 Ty = types::lookupCXXTypeForCType(Ty);
1573 Diag(clang::diag::warn_drv_treating_input_as_cxx)
1574 << getTypeName(OldTy) << getTypeName(Ty);
1578 // -ObjC and -ObjC++ override the default language, but only for "source
1579 // files". We just treat everything that isn't a linker input as a
1582 // FIXME: Clean this up if we move the phase sequence into the type.
1583 if (Ty != types::TY_Object) {
1584 if (Args.hasArg(options::OPT_ObjC))
1585 Ty = types::TY_ObjC;
1586 else if (Args.hasArg(options::OPT_ObjCXX))
1587 Ty = types::TY_ObjCXX;
1590 assert(InputTypeArg && "InputType set w/o InputTypeArg");
1591 if (!InputTypeArg->getOption().matches(options::OPT_x)) {
1592 // If emulating cl.exe, make sure that /TC and /TP don't affect input
1594 const char *Ext = strrchr(Value, '.');
1595 if (Ext && TC.LookupTypeForExtension(Ext + 1) == types::TY_Object)
1596 Ty = types::TY_Object;
1598 if (Ty == types::TY_INVALID) {
1600 InputTypeArg->claim();
1604 if (DiagnoseInputExistence(*this, Args, Value, Ty))
1605 Inputs.push_back(std::make_pair(Ty, A));
1607 } else if (A->getOption().matches(options::OPT__SLASH_Tc)) {
1608 StringRef Value = A->getValue();
1609 if (DiagnoseInputExistence(*this, Args, Value, types::TY_C)) {
1610 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
1611 Inputs.push_back(std::make_pair(types::TY_C, InputArg));
1614 } else if (A->getOption().matches(options::OPT__SLASH_Tp)) {
1615 StringRef Value = A->getValue();
1616 if (DiagnoseInputExistence(*this, Args, Value, types::TY_CXX)) {
1617 Arg *InputArg = MakeInputArg(Args, *Opts, A->getValue());
1618 Inputs.push_back(std::make_pair(types::TY_CXX, InputArg));
1621 } else if (A->getOption().hasFlag(options::LinkerInput)) {
1622 // Just treat as object type, we could make a special type for this if
1624 Inputs.push_back(std::make_pair(types::TY_Object, A));
1626 } else if (A->getOption().matches(options::OPT_x)) {
1628 InputType = types::lookupTypeForTypeSpecifier(A->getValue());
1631 // Follow gcc behavior and treat as linker input for invalid -x
1632 // options. Its not clear why we shouldn't just revert to unknown; but
1633 // this isn't very important, we might as well be bug compatible.
1635 Diag(clang::diag::err_drv_unknown_language) << A->getValue();
1636 InputType = types::TY_Object;
1638 } else if (A->getOption().getID() == options::OPT__SLASH_U) {
1639 assert(A->getNumValues() == 1 && "The /U option has one value.");
1640 StringRef Val = A->getValue(0);
1641 if (Val.find_first_of("/\\") != StringRef::npos) {
1642 // Warn about e.g. "/Users/me/myfile.c".
1643 Diag(diag::warn_slash_u_filename) << Val;
1644 Diag(diag::note_use_dashdash);
1648 if (CCCIsCPP() && Inputs.empty()) {
1649 // If called as standalone preprocessor, stdin is processed
1650 // if no other input is present.
1651 Arg *A = MakeInputArg(Args, *Opts, "-");
1652 Inputs.push_back(std::make_pair(types::TY_C, A));
1657 /// Provides a convenient interface for different programming models to generate
1658 /// the required device actions.
1659 class OffloadingActionBuilder final {
1660 /// Flag used to trace errors in the builder.
1661 bool IsValid = false;
1663 /// The compilation that is using this builder.
1666 /// Map between an input argument and the offload kinds used to process it.
1667 std::map<const Arg *, unsigned> InputArgToOffloadKindMap;
1669 /// Builder interface. It doesn't build anything or keep any state.
1670 class DeviceActionBuilder {
1672 typedef llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PhasesTy;
1674 enum ActionBuilderReturnCode {
1675 // The builder acted successfully on the current action.
1677 // The builder didn't have to act on the current action.
1679 // The builder was successful and requested the host action to not be
1685 /// Compilation associated with this builder.
1688 /// Tool chains associated with this builder. The same programming
1689 /// model may have associated one or more tool chains.
1690 SmallVector<const ToolChain *, 2> ToolChains;
1692 /// The derived arguments associated with this builder.
1693 DerivedArgList &Args;
1695 /// The inputs associated with this builder.
1696 const Driver::InputList &Inputs;
1698 /// The associated offload kind.
1699 Action::OffloadKind AssociatedOffloadKind = Action::OFK_None;
1702 DeviceActionBuilder(Compilation &C, DerivedArgList &Args,
1703 const Driver::InputList &Inputs,
1704 Action::OffloadKind AssociatedOffloadKind)
1705 : C(C), Args(Args), Inputs(Inputs),
1706 AssociatedOffloadKind(AssociatedOffloadKind) {}
1707 virtual ~DeviceActionBuilder() {}
1709 /// Fill up the array \a DA with all the device dependences that should be
1710 /// added to the provided host action \a HostAction. By default it is
1712 virtual ActionBuilderReturnCode
1713 getDeviceDependences(OffloadAction::DeviceDependences &DA,
1714 phases::ID CurPhase, phases::ID FinalPhase,
1716 return ABRT_Inactive;
1719 /// Update the state to include the provided host action \a HostAction as a
1720 /// dependency of the current device action. By default it is inactive.
1721 virtual ActionBuilderReturnCode addDeviceDepences(Action *HostAction) {
1722 return ABRT_Inactive;
1725 /// Append top level actions generated by the builder. Return true if errors
1727 virtual void appendTopLevelActions(ActionList &AL) {}
1729 /// Append linker actions generated by the builder. Return true if errors
1731 virtual void appendLinkDependences(OffloadAction::DeviceDependences &DA) {}
1733 /// Initialize the builder. Return true if any initialization errors are
1735 virtual bool initialize() { return false; }
1737 /// Return true if the builder can use bundling/unbundling.
1738 virtual bool canUseBundlerUnbundler() const { return false; }
1740 /// Return true if this builder is valid. We have a valid builder if we have
1741 /// associated device tool chains.
1742 bool isValid() { return !ToolChains.empty(); }
1744 /// Return the associated offload kind.
1745 Action::OffloadKind getAssociatedOffloadKind() {
1746 return AssociatedOffloadKind;
1750 /// \brief CUDA action builder. It injects device code in the host backend
1752 class CudaActionBuilder final : public DeviceActionBuilder {
1753 /// Flags to signal if the user requested host-only or device-only
1755 bool CompileHostOnly = false;
1756 bool CompileDeviceOnly = false;
1758 /// List of GPU architectures to use in this compilation.
1759 SmallVector<CudaArch, 4> GpuArchList;
1761 /// The CUDA actions for the current input.
1762 ActionList CudaDeviceActions;
1764 /// The CUDA fat binary if it was generated for the current input.
1765 Action *CudaFatBinary = nullptr;
1767 /// Flag that is set to true if this builder acted on the current input.
1768 bool IsActive = false;
1771 CudaActionBuilder(Compilation &C, DerivedArgList &Args,
1772 const Driver::InputList &Inputs)
1773 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_Cuda) {}
1775 ActionBuilderReturnCode
1776 getDeviceDependences(OffloadAction::DeviceDependences &DA,
1777 phases::ID CurPhase, phases::ID FinalPhase,
1778 PhasesTy &Phases) override {
1780 return ABRT_Inactive;
1782 // If we don't have more CUDA actions, we don't have any dependences to
1783 // create for the host.
1784 if (CudaDeviceActions.empty())
1785 return ABRT_Success;
1787 assert(CudaDeviceActions.size() == GpuArchList.size() &&
1788 "Expecting one action per GPU architecture.");
1789 assert(!CompileHostOnly &&
1790 "Not expecting CUDA actions in host-only compilation.");
1792 // If we are generating code for the device or we are in a backend phase,
1793 // we attempt to generate the fat binary. We compile each arch to ptx and
1794 // assemble to cubin, then feed the cubin *and* the ptx into a device
1795 // "link" action, which uses fatbinary to combine these cubins into one
1796 // fatbin. The fatbin is then an input to the host action if not in
1797 // device-only mode.
1798 if (CompileDeviceOnly || CurPhase == phases::Backend) {
1799 ActionList DeviceActions;
1800 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I) {
1801 // Produce the device action from the current phase up to the assemble
1803 for (auto Ph : Phases) {
1804 // Skip the phases that were already dealt with.
1807 // We have to be consistent with the host final phase.
1808 if (Ph > FinalPhase)
1811 CudaDeviceActions[I] = C.getDriver().ConstructPhaseAction(
1812 C, Args, Ph, CudaDeviceActions[I]);
1814 if (Ph == phases::Assemble)
1818 // If we didn't reach the assemble phase, we can't generate the fat
1819 // binary. We don't need to generate the fat binary if we are not in
1820 // device-only mode.
1821 if (!isa<AssembleJobAction>(CudaDeviceActions[I]) ||
1825 Action *AssembleAction = CudaDeviceActions[I];
1826 assert(AssembleAction->getType() == types::TY_Object);
1827 assert(AssembleAction->getInputs().size() == 1);
1829 Action *BackendAction = AssembleAction->getInputs()[0];
1830 assert(BackendAction->getType() == types::TY_PP_Asm);
1832 for (auto &A : {AssembleAction, BackendAction}) {
1833 OffloadAction::DeviceDependences DDep;
1834 DDep.add(*A, *ToolChains.front(), CudaArchToString(GpuArchList[I]),
1836 DeviceActions.push_back(
1837 C.MakeAction<OffloadAction>(DDep, A->getType()));
1841 // We generate the fat binary if we have device input actions.
1842 if (!DeviceActions.empty()) {
1844 C.MakeAction<LinkJobAction>(DeviceActions, types::TY_CUDA_FATBIN);
1846 if (!CompileDeviceOnly) {
1847 DA.add(*CudaFatBinary, *ToolChains.front(), /*BoundArch=*/nullptr,
1849 // Clear the fat binary, it is already a dependence to an host
1851 CudaFatBinary = nullptr;
1854 // Remove the CUDA actions as they are already connected to an host
1855 // action or fat binary.
1856 CudaDeviceActions.clear();
1859 // We avoid creating host action in device-only mode.
1860 return CompileDeviceOnly ? ABRT_Ignore_Host : ABRT_Success;
1861 } else if (CurPhase > phases::Backend) {
1862 // If we are past the backend phase and still have a device action, we
1863 // don't have to do anything as this action is already a device
1864 // top-level action.
1865 return ABRT_Success;
1868 assert(CurPhase < phases::Backend && "Generating single CUDA "
1869 "instructions should only occur "
1870 "before the backend phase!");
1872 // By default, we produce an action for each device arch.
1873 for (Action *&A : CudaDeviceActions)
1874 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
1876 return ABRT_Success;
1879 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
1880 // While generating code for CUDA, we only depend on the host input action
1881 // to trigger the creation of all the CUDA device actions.
1883 // If we are dealing with an input action, replicate it for each GPU
1884 // architecture. If we are in host-only mode we return 'success' so that
1885 // the host uses the CUDA offload kind.
1886 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
1887 assert(!GpuArchList.empty() &&
1888 "We should have at least one GPU architecture.");
1890 // If the host input is not CUDA, we don't need to bother about this
1892 if (IA->getType() != types::TY_CUDA) {
1893 // The builder will ignore this input.
1895 return ABRT_Inactive;
1898 // Set the flag to true, so that the builder acts on the current input.
1901 if (CompileHostOnly)
1902 return ABRT_Success;
1904 // Replicate inputs for each GPU architecture.
1905 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1906 CudaDeviceActions.push_back(C.MakeAction<InputAction>(
1907 IA->getInputArg(), types::TY_CUDA_DEVICE));
1909 return ABRT_Success;
1912 return IsActive ? ABRT_Success : ABRT_Inactive;
1915 void appendTopLevelActions(ActionList &AL) override {
1916 // Utility to append actions to the top level list.
1917 auto AddTopLevel = [&](Action *A, CudaArch BoundArch) {
1918 OffloadAction::DeviceDependences Dep;
1919 Dep.add(*A, *ToolChains.front(), CudaArchToString(BoundArch),
1921 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
1924 // If we have a fat binary, add it to the list.
1925 if (CudaFatBinary) {
1926 AddTopLevel(CudaFatBinary, CudaArch::UNKNOWN);
1927 CudaDeviceActions.clear();
1928 CudaFatBinary = nullptr;
1932 if (CudaDeviceActions.empty())
1935 // If we have CUDA actions at this point, that's because we have a have
1936 // partial compilation, so we should have an action for each GPU
1938 assert(CudaDeviceActions.size() == GpuArchList.size() &&
1939 "Expecting one action per GPU architecture.");
1940 assert(ToolChains.size() == 1 &&
1941 "Expecting to have a sing CUDA toolchain.");
1942 for (unsigned I = 0, E = GpuArchList.size(); I != E; ++I)
1943 AddTopLevel(CudaDeviceActions[I], GpuArchList[I]);
1945 CudaDeviceActions.clear();
1948 bool initialize() override {
1949 // We don't need to support CUDA.
1950 if (!C.hasOffloadToolChain<Action::OFK_Cuda>())
1953 const ToolChain *HostTC = C.getSingleOffloadToolChain<Action::OFK_Host>();
1954 assert(HostTC && "No toolchain for host compilation.");
1955 if (HostTC->getTriple().isNVPTX()) {
1956 // We do not support targeting NVPTX for host compilation. Throw
1957 // an error and abort pipeline construction early so we don't trip
1958 // asserts that assume device-side compilation.
1959 C.getDriver().Diag(diag::err_drv_cuda_nvptx_host);
1963 ToolChains.push_back(C.getSingleOffloadToolChain<Action::OFK_Cuda>());
1965 Arg *PartialCompilationArg = Args.getLastArg(
1966 options::OPT_cuda_host_only, options::OPT_cuda_device_only,
1967 options::OPT_cuda_compile_host_device);
1968 CompileHostOnly = PartialCompilationArg &&
1969 PartialCompilationArg->getOption().matches(
1970 options::OPT_cuda_host_only);
1971 CompileDeviceOnly = PartialCompilationArg &&
1972 PartialCompilationArg->getOption().matches(
1973 options::OPT_cuda_device_only);
1975 // Collect all cuda_gpu_arch parameters, removing duplicates.
1976 std::set<CudaArch> GpuArchs;
1978 for (Arg *A : Args) {
1979 if (!(A->getOption().matches(options::OPT_cuda_gpu_arch_EQ) ||
1980 A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ)))
1984 const StringRef ArchStr = A->getValue();
1985 if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ) &&
1990 CudaArch Arch = StringToCudaArch(ArchStr);
1991 if (Arch == CudaArch::UNKNOWN) {
1992 C.getDriver().Diag(clang::diag::err_drv_cuda_bad_gpu_arch) << ArchStr;
1994 } else if (A->getOption().matches(options::OPT_cuda_gpu_arch_EQ))
1995 GpuArchs.insert(Arch);
1996 else if (A->getOption().matches(options::OPT_no_cuda_gpu_arch_EQ))
1997 GpuArchs.erase(Arch);
1999 llvm_unreachable("Unexpected option.");
2002 // Collect list of GPUs remaining in the set.
2003 for (CudaArch Arch : GpuArchs)
2004 GpuArchList.push_back(Arch);
2006 // Default to sm_20 which is the lowest common denominator for
2007 // supported GPUs. sm_20 code should work correctly, if
2008 // suboptimally, on all newer GPUs.
2009 if (GpuArchList.empty())
2010 GpuArchList.push_back(CudaArch::SM_20);
2016 /// OpenMP action builder. The host bitcode is passed to the device frontend
2017 /// and all the device linked images are passed to the host link phase.
2018 class OpenMPActionBuilder final : public DeviceActionBuilder {
2019 /// The OpenMP actions for the current input.
2020 ActionList OpenMPDeviceActions;
2022 /// The linker inputs obtained for each toolchain.
2023 SmallVector<ActionList, 8> DeviceLinkerInputs;
2026 OpenMPActionBuilder(Compilation &C, DerivedArgList &Args,
2027 const Driver::InputList &Inputs)
2028 : DeviceActionBuilder(C, Args, Inputs, Action::OFK_OpenMP) {}
2030 ActionBuilderReturnCode
2031 getDeviceDependences(OffloadAction::DeviceDependences &DA,
2032 phases::ID CurPhase, phases::ID FinalPhase,
2033 PhasesTy &Phases) override {
2035 // We should always have an action for each input.
2036 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2037 "Number of OpenMP actions and toolchains do not match.");
2039 // The host only depends on device action in the linking phase, when all
2040 // the device images have to be embedded in the host image.
2041 if (CurPhase == phases::Link) {
2042 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2043 "Toolchains and linker inputs sizes do not match.");
2044 auto LI = DeviceLinkerInputs.begin();
2045 for (auto *A : OpenMPDeviceActions) {
2050 // We passed the device action as a host dependence, so we don't need to
2051 // do anything else with them.
2052 OpenMPDeviceActions.clear();
2053 return ABRT_Success;
2056 // By default, we produce an action for each device arch.
2057 for (Action *&A : OpenMPDeviceActions)
2058 A = C.getDriver().ConstructPhaseAction(C, Args, CurPhase, A);
2060 return ABRT_Success;
2063 ActionBuilderReturnCode addDeviceDepences(Action *HostAction) override {
2065 // If this is an input action replicate it for each OpenMP toolchain.
2066 if (auto *IA = dyn_cast<InputAction>(HostAction)) {
2067 OpenMPDeviceActions.clear();
2068 for (unsigned I = 0; I < ToolChains.size(); ++I)
2069 OpenMPDeviceActions.push_back(
2070 C.MakeAction<InputAction>(IA->getInputArg(), IA->getType()));
2071 return ABRT_Success;
2074 // If this is an unbundling action use it as is for each OpenMP toolchain.
2075 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(HostAction)) {
2076 OpenMPDeviceActions.clear();
2077 for (unsigned I = 0; I < ToolChains.size(); ++I) {
2078 OpenMPDeviceActions.push_back(UA);
2079 UA->registerDependentActionInfo(
2080 ToolChains[I], /*BoundArch=*/StringRef(), Action::OFK_OpenMP);
2082 return ABRT_Success;
2085 // When generating code for OpenMP we use the host compile phase result as
2086 // a dependence to the device compile phase so that it can learn what
2087 // declarations should be emitted. However, this is not the only use for
2088 // the host action, so we prevent it from being collapsed.
2089 if (isa<CompileJobAction>(HostAction)) {
2090 HostAction->setCannotBeCollapsedWithNextDependentAction();
2091 assert(ToolChains.size() == OpenMPDeviceActions.size() &&
2092 "Toolchains and device action sizes do not match.");
2093 OffloadAction::HostDependence HDep(
2094 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2095 /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2096 auto TC = ToolChains.begin();
2097 for (Action *&A : OpenMPDeviceActions) {
2098 assert(isa<CompileJobAction>(A));
2099 OffloadAction::DeviceDependences DDep;
2100 DDep.add(*A, **TC, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2101 A = C.MakeAction<OffloadAction>(HDep, DDep);
2105 return ABRT_Success;
2108 void appendTopLevelActions(ActionList &AL) override {
2109 if (OpenMPDeviceActions.empty())
2112 // We should always have an action for each input.
2113 assert(OpenMPDeviceActions.size() == ToolChains.size() &&
2114 "Number of OpenMP actions and toolchains do not match.");
2116 // Append all device actions followed by the proper offload action.
2117 auto TI = ToolChains.begin();
2118 for (auto *A : OpenMPDeviceActions) {
2119 OffloadAction::DeviceDependences Dep;
2120 Dep.add(*A, **TI, /*BoundArch=*/nullptr, Action::OFK_OpenMP);
2121 AL.push_back(C.MakeAction<OffloadAction>(Dep, A->getType()));
2124 // We no longer need the action stored in this builder.
2125 OpenMPDeviceActions.clear();
2128 void appendLinkDependences(OffloadAction::DeviceDependences &DA) override {
2129 assert(ToolChains.size() == DeviceLinkerInputs.size() &&
2130 "Toolchains and linker inputs sizes do not match.");
2132 // Append a new link action for each device.
2133 auto TC = ToolChains.begin();
2134 for (auto &LI : DeviceLinkerInputs) {
2135 auto *DeviceLinkAction =
2136 C.MakeAction<LinkJobAction>(LI, types::TY_Image);
2137 DA.add(*DeviceLinkAction, **TC, /*BoundArch=*/nullptr,
2138 Action::OFK_OpenMP);
2143 bool initialize() override {
2144 // Get the OpenMP toolchains. If we don't get any, the action builder will
2145 // know there is nothing to do related to OpenMP offloading.
2146 auto OpenMPTCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
2147 for (auto TI = OpenMPTCRange.first, TE = OpenMPTCRange.second; TI != TE;
2149 ToolChains.push_back(TI->second);
2151 DeviceLinkerInputs.resize(ToolChains.size());
2155 bool canUseBundlerUnbundler() const override {
2156 // OpenMP should use bundled files whenever possible.
2162 /// TODO: Add the implementation for other specialized builders here.
2165 /// Specialized builders being used by this offloading action builder.
2166 SmallVector<DeviceActionBuilder *, 4> SpecializedBuilders;
2168 /// Flag set to true if all valid builders allow file bundling/unbundling.
2172 OffloadingActionBuilder(Compilation &C, DerivedArgList &Args,
2173 const Driver::InputList &Inputs)
2175 // Create a specialized builder for each device toolchain.
2179 // Create a specialized builder for CUDA.
2180 SpecializedBuilders.push_back(new CudaActionBuilder(C, Args, Inputs));
2182 // Create a specialized builder for OpenMP.
2183 SpecializedBuilders.push_back(new OpenMPActionBuilder(C, Args, Inputs));
2186 // TODO: Build other specialized builders here.
2189 // Initialize all the builders, keeping track of errors. If all valid
2190 // builders agree that we can use bundling, set the flag to true.
2191 unsigned ValidBuilders = 0u;
2192 unsigned ValidBuildersSupportingBundling = 0u;
2193 for (auto *SB : SpecializedBuilders) {
2194 IsValid = IsValid && !SB->initialize();
2196 // Update the counters if the builder is valid.
2197 if (SB->isValid()) {
2199 if (SB->canUseBundlerUnbundler())
2200 ++ValidBuildersSupportingBundling;
2204 ValidBuilders && ValidBuilders == ValidBuildersSupportingBundling;
2207 ~OffloadingActionBuilder() {
2208 for (auto *SB : SpecializedBuilders)
2212 /// Generate an action that adds device dependences (if any) to a host action.
2213 /// If no device dependence actions exist, just return the host action \a
2214 /// HostAction. If an error is found or if no builder requires the host action
2215 /// to be generated, return nullptr.
2217 addDeviceDependencesToHostAction(Action *HostAction, const Arg *InputArg,
2218 phases::ID CurPhase, phases::ID FinalPhase,
2219 DeviceActionBuilder::PhasesTy &Phases) {
2223 if (SpecializedBuilders.empty())
2226 assert(HostAction && "Invalid host action!");
2228 OffloadAction::DeviceDependences DDeps;
2229 // Check if all the programming models agree we should not emit the host
2230 // action. Also, keep track of the offloading kinds employed.
2231 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2232 unsigned InactiveBuilders = 0u;
2233 unsigned IgnoringBuilders = 0u;
2234 for (auto *SB : SpecializedBuilders) {
2235 if (!SB->isValid()) {
2241 SB->getDeviceDependences(DDeps, CurPhase, FinalPhase, Phases);
2243 // If the builder explicitly says the host action should be ignored,
2244 // we need to increment the variable that tracks the builders that request
2245 // the host object to be ignored.
2246 if (RetCode == DeviceActionBuilder::ABRT_Ignore_Host)
2249 // Unless the builder was inactive for this action, we have to record the
2250 // offload kind because the host will have to use it.
2251 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2252 OffloadKind |= SB->getAssociatedOffloadKind();
2255 // If all builders agree that the host object should be ignored, just return
2257 if (IgnoringBuilders &&
2258 SpecializedBuilders.size() == (InactiveBuilders + IgnoringBuilders))
2261 if (DDeps.getActions().empty())
2264 // We have dependences we need to bundle together. We use an offload action
2266 OffloadAction::HostDependence HDep(
2267 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2268 /*BoundArch=*/nullptr, DDeps);
2269 return C.MakeAction<OffloadAction>(HDep, DDeps);
2272 /// Generate an action that adds a host dependence to a device action. The
2273 /// results will be kept in this action builder. Return true if an error was
2275 bool addHostDependenceToDeviceActions(Action *&HostAction,
2276 const Arg *InputArg) {
2280 // If we are supporting bundling/unbundling and the current action is an
2281 // input action of non-source file, we replace the host action by the
2282 // unbundling action. The bundler tool has the logic to detect if an input
2283 // is a bundle or not and if the input is not a bundle it assumes it is a
2284 // host file. Therefore it is safe to create an unbundling action even if
2285 // the input is not a bundle.
2286 if (CanUseBundler && isa<InputAction>(HostAction) &&
2287 InputArg->getOption().getKind() == llvm::opt::Option::InputClass &&
2288 !types::isSrcFile(HostAction->getType())) {
2289 auto UnbundlingHostAction =
2290 C.MakeAction<OffloadUnbundlingJobAction>(HostAction);
2291 UnbundlingHostAction->registerDependentActionInfo(
2292 C.getSingleOffloadToolChain<Action::OFK_Host>(),
2293 /*BoundArch=*/StringRef(), Action::OFK_Host);
2294 HostAction = UnbundlingHostAction;
2297 assert(HostAction && "Invalid host action!");
2299 // Register the offload kinds that are used.
2300 auto &OffloadKind = InputArgToOffloadKindMap[InputArg];
2301 for (auto *SB : SpecializedBuilders) {
2305 auto RetCode = SB->addDeviceDepences(HostAction);
2307 // Host dependences for device actions are not compatible with that same
2308 // action being ignored.
2309 assert(RetCode != DeviceActionBuilder::ABRT_Ignore_Host &&
2310 "Host dependence not expected to be ignored.!");
2312 // Unless the builder was inactive for this action, we have to record the
2313 // offload kind because the host will have to use it.
2314 if (RetCode != DeviceActionBuilder::ABRT_Inactive)
2315 OffloadKind |= SB->getAssociatedOffloadKind();
2321 /// Add the offloading top level actions to the provided action list. This
2322 /// function can replace the host action by a bundling action if the
2323 /// programming models allow it.
2324 bool appendTopLevelActions(ActionList &AL, Action *HostAction,
2325 const Arg *InputArg) {
2326 // Get the device actions to be appended.
2327 ActionList OffloadAL;
2328 for (auto *SB : SpecializedBuilders) {
2331 SB->appendTopLevelActions(OffloadAL);
2334 // If we can use the bundler, replace the host action by the bundling one in
2335 // the resulting list. Otherwise, just append the device actions.
2336 if (CanUseBundler && !OffloadAL.empty()) {
2337 // Add the host action to the list in order to create the bundling action.
2338 OffloadAL.push_back(HostAction);
2340 // We expect that the host action was just appended to the action list
2341 // before this method was called.
2342 assert(HostAction == AL.back() && "Host action not in the list??");
2343 HostAction = C.MakeAction<OffloadBundlingJobAction>(OffloadAL);
2344 AL.back() = HostAction;
2346 AL.append(OffloadAL.begin(), OffloadAL.end());
2348 // Propagate to the current host action (if any) the offload information
2349 // associated with the current input.
2351 HostAction->propagateHostOffloadInfo(InputArgToOffloadKindMap[InputArg],
2352 /*BoundArch=*/nullptr);
2356 /// Processes the host linker action. This currently consists of replacing it
2357 /// with an offload action if there are device link objects and propagate to
2358 /// the host action all the offload kinds used in the current compilation. The
2359 /// resulting action is returned.
2360 Action *processHostLinkAction(Action *HostAction) {
2361 // Add all the dependences from the device linking actions.
2362 OffloadAction::DeviceDependences DDeps;
2363 for (auto *SB : SpecializedBuilders) {
2367 SB->appendLinkDependences(DDeps);
2370 // Calculate all the offload kinds used in the current compilation.
2371 unsigned ActiveOffloadKinds = 0u;
2372 for (auto &I : InputArgToOffloadKindMap)
2373 ActiveOffloadKinds |= I.second;
2375 // If we don't have device dependencies, we don't have to create an offload
2377 if (DDeps.getActions().empty()) {
2378 // Propagate all the active kinds to host action. Given that it is a link
2379 // action it is assumed to depend on all actions generated so far.
2380 HostAction->propagateHostOffloadInfo(ActiveOffloadKinds,
2381 /*BoundArch=*/nullptr);
2385 // Create the offload action with all dependences. When an offload action
2386 // is created the kinds are propagated to the host action, so we don't have
2387 // to do that explicitly here.
2388 OffloadAction::HostDependence HDep(
2389 *HostAction, *C.getSingleOffloadToolChain<Action::OFK_Host>(),
2390 /*BoundArch*/ nullptr, ActiveOffloadKinds);
2391 return C.MakeAction<OffloadAction>(HDep, DDeps);
2394 } // anonymous namespace.
2396 void Driver::BuildActions(Compilation &C, DerivedArgList &Args,
2397 const InputList &Inputs, ActionList &Actions) const {
2398 llvm::PrettyStackTraceString CrashInfo("Building compilation actions");
2400 if (!SuppressMissingInputWarning && Inputs.empty()) {
2401 Diag(clang::diag::err_drv_no_input_files);
2406 phases::ID FinalPhase = getFinalPhase(Args, &FinalPhaseArg);
2408 if (FinalPhase == phases::Link) {
2409 if (Args.hasArg(options::OPT_emit_llvm))
2410 Diag(clang::diag::err_drv_emit_llvm_link);
2411 if (IsCLMode() && LTOMode != LTOK_None &&
2412 !Args.getLastArgValue(options::OPT_fuse_ld_EQ).equals_lower("lld"))
2413 Diag(clang::diag::err_drv_lto_without_lld);
2416 // Reject -Z* at the top level, these options should never have been exposed
2418 if (Arg *A = Args.getLastArg(options::OPT_Z_Joined))
2419 Diag(clang::diag::err_drv_use_of_Z_option) << A->getAsString(Args);
2421 // Diagnose misuse of /Fo.
2422 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fo)) {
2423 StringRef V = A->getValue();
2424 if (Inputs.size() > 1 && !V.empty() &&
2425 !llvm::sys::path::is_separator(V.back())) {
2426 // Check whether /Fo tries to name an output file for multiple inputs.
2427 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
2428 << A->getSpelling() << V;
2429 Args.eraseArg(options::OPT__SLASH_Fo);
2433 // Diagnose misuse of /Fa.
2434 if (Arg *A = Args.getLastArg(options::OPT__SLASH_Fa)) {
2435 StringRef V = A->getValue();
2436 if (Inputs.size() > 1 && !V.empty() &&
2437 !llvm::sys::path::is_separator(V.back())) {
2438 // Check whether /Fa tries to name an asm file for multiple inputs.
2439 Diag(clang::diag::err_drv_out_file_argument_with_multiple_sources)
2440 << A->getSpelling() << V;
2441 Args.eraseArg(options::OPT__SLASH_Fa);
2445 // Diagnose misuse of /o.
2446 if (Arg *A = Args.getLastArg(options::OPT__SLASH_o)) {
2447 if (A->getValue()[0] == '\0') {
2448 // It has to have a value.
2449 Diag(clang::diag::err_drv_missing_argument) << A->getSpelling() << 1;
2450 Args.eraseArg(options::OPT__SLASH_o);
2454 // Diagnose unsupported forms of /Yc /Yu. Ignore /Yc/Yu for now if:
2455 // * no filename after it
2456 // * both /Yc and /Yu passed but with different filenames
2457 // * corresponding file not also passed as /FI
2458 Arg *YcArg = Args.getLastArg(options::OPT__SLASH_Yc);
2459 Arg *YuArg = Args.getLastArg(options::OPT__SLASH_Yu);
2460 if (YcArg && YcArg->getValue()[0] == '\0') {
2461 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YcArg->getSpelling();
2462 Args.eraseArg(options::OPT__SLASH_Yc);
2465 if (YuArg && YuArg->getValue()[0] == '\0') {
2466 Diag(clang::diag::warn_drv_ycyu_no_arg_clang_cl) << YuArg->getSpelling();
2467 Args.eraseArg(options::OPT__SLASH_Yu);
2470 if (YcArg && YuArg && strcmp(YcArg->getValue(), YuArg->getValue()) != 0) {
2471 Diag(clang::diag::warn_drv_ycyu_different_arg_clang_cl);
2472 Args.eraseArg(options::OPT__SLASH_Yc);
2473 Args.eraseArg(options::OPT__SLASH_Yu);
2474 YcArg = YuArg = nullptr;
2476 if (YcArg || YuArg) {
2477 StringRef Val = YcArg ? YcArg->getValue() : YuArg->getValue();
2478 bool FoundMatchingInclude = false;
2479 for (const Arg *Inc : Args.filtered(options::OPT_include)) {
2480 // FIXME: Do case-insensitive matching and consider / and \ as equal.
2481 if (Inc->getValue() == Val)
2482 FoundMatchingInclude = true;
2484 if (!FoundMatchingInclude) {
2485 Diag(clang::diag::warn_drv_ycyu_no_fi_arg_clang_cl)
2486 << (YcArg ? YcArg : YuArg)->getSpelling();
2487 Args.eraseArg(options::OPT__SLASH_Yc);
2488 Args.eraseArg(options::OPT__SLASH_Yu);
2489 YcArg = YuArg = nullptr;
2492 if (YcArg && Inputs.size() > 1) {
2493 Diag(clang::diag::warn_drv_yc_multiple_inputs_clang_cl);
2494 Args.eraseArg(options::OPT__SLASH_Yc);
2497 if (Args.hasArg(options::OPT__SLASH_Y_)) {
2498 // /Y- disables all pch handling. Rather than check for it everywhere,
2499 // just remove clang-cl pch-related flags here.
2500 Args.eraseArg(options::OPT__SLASH_Fp);
2501 Args.eraseArg(options::OPT__SLASH_Yc);
2502 Args.eraseArg(options::OPT__SLASH_Yu);
2503 YcArg = YuArg = nullptr;
2506 // Builder to be used to build offloading actions.
2507 OffloadingActionBuilder OffloadBuilder(C, Args, Inputs);
2509 // Construct the actions to perform.
2510 ActionList LinkerInputs;
2512 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PL;
2513 for (auto &I : Inputs) {
2514 types::ID InputType = I.first;
2515 const Arg *InputArg = I.second;
2518 types::getCompilationPhases(InputType, PL);
2520 // If the first step comes after the final phase we are doing as part of
2521 // this compilation, warn the user about it.
2522 phases::ID InitialPhase = PL[0];
2523 if (InitialPhase > FinalPhase) {
2524 // Claim here to avoid the more general unused warning.
2527 // Suppress all unused style warnings with -Qunused-arguments
2528 if (Args.hasArg(options::OPT_Qunused_arguments))
2531 // Special case when final phase determined by binary name, rather than
2532 // by a command-line argument with a corresponding Arg.
2534 Diag(clang::diag::warn_drv_input_file_unused_by_cpp)
2535 << InputArg->getAsString(Args) << getPhaseName(InitialPhase);
2536 // Special case '-E' warning on a previously preprocessed file to make
2538 else if (InitialPhase == phases::Compile &&
2539 FinalPhase == phases::Preprocess &&
2540 getPreprocessedType(InputType) == types::TY_INVALID)
2541 Diag(clang::diag::warn_drv_preprocessed_input_file_unused)
2542 << InputArg->getAsString(Args) << !!FinalPhaseArg
2543 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
2545 Diag(clang::diag::warn_drv_input_file_unused)
2546 << InputArg->getAsString(Args) << getPhaseName(InitialPhase)
2548 << (FinalPhaseArg ? FinalPhaseArg->getOption().getName() : "");
2553 // Add a separate precompile phase for the compile phase.
2554 if (FinalPhase >= phases::Compile) {
2555 const types::ID HeaderType = lookupHeaderTypeForSourceType(InputType);
2556 llvm::SmallVector<phases::ID, phases::MaxNumberOfPhases> PCHPL;
2557 types::getCompilationPhases(HeaderType, PCHPL);
2558 Arg *PchInputArg = MakeInputArg(Args, *Opts, YcArg->getValue());
2560 // Build the pipeline for the pch file.
2561 Action *ClangClPch =
2562 C.MakeAction<InputAction>(*PchInputArg, HeaderType);
2563 for (phases::ID Phase : PCHPL)
2564 ClangClPch = ConstructPhaseAction(C, Args, Phase, ClangClPch);
2566 Actions.push_back(ClangClPch);
2567 // The driver currently exits after the first failed command. This
2568 // relies on that behavior, to make sure if the pch generation fails,
2569 // the main compilation won't run.
2573 // Build the pipeline for this file.
2574 Action *Current = C.MakeAction<InputAction>(*InputArg, InputType);
2576 // Use the current host action in any of the offloading actions, if
2578 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2581 for (SmallVectorImpl<phases::ID>::iterator i = PL.begin(), e = PL.end();
2583 phases::ID Phase = *i;
2585 // We are done if this step is past what the user requested.
2586 if (Phase > FinalPhase)
2589 // Add any offload action the host action depends on.
2590 Current = OffloadBuilder.addDeviceDependencesToHostAction(
2591 Current, InputArg, Phase, FinalPhase, PL);
2595 // Queue linker inputs.
2596 if (Phase == phases::Link) {
2597 assert((i + 1) == e && "linking must be final compilation step.");
2598 LinkerInputs.push_back(Current);
2603 // Otherwise construct the appropriate action.
2604 auto *NewCurrent = ConstructPhaseAction(C, Args, Phase, Current);
2606 // We didn't create a new action, so we will just move to the next phase.
2607 if (NewCurrent == Current)
2610 Current = NewCurrent;
2612 // Use the current host action in any of the offloading actions, if
2614 if (OffloadBuilder.addHostDependenceToDeviceActions(Current, InputArg))
2617 if (Current->getType() == types::TY_Nothing)
2621 // If we ended with something, add to the output list.
2623 Actions.push_back(Current);
2625 // Add any top level actions generated for offloading.
2626 OffloadBuilder.appendTopLevelActions(Actions, Current, InputArg);
2629 // Add a link action if necessary.
2630 if (!LinkerInputs.empty()) {
2631 Action *LA = C.MakeAction<LinkJobAction>(LinkerInputs, types::TY_Image);
2632 LA = OffloadBuilder.processHostLinkAction(LA);
2633 Actions.push_back(LA);
2636 // If we are linking, claim any options which are obviously only used for
2638 if (FinalPhase == phases::Link && PL.size() == 1) {
2639 Args.ClaimAllArgs(options::OPT_CompileOnly_Group);
2640 Args.ClaimAllArgs(options::OPT_cl_compile_Group);
2643 // Claim ignored clang-cl options.
2644 Args.ClaimAllArgs(options::OPT_cl_ignored_Group);
2646 // Claim --cuda-host-only and --cuda-compile-host-device, which may be passed
2647 // to non-CUDA compilations and should not trigger warnings there.
2648 Args.ClaimAllArgs(options::OPT_cuda_host_only);
2649 Args.ClaimAllArgs(options::OPT_cuda_compile_host_device);
2652 Action *Driver::ConstructPhaseAction(Compilation &C, const ArgList &Args,
2653 phases::ID Phase, Action *Input) const {
2654 llvm::PrettyStackTraceString CrashInfo("Constructing phase actions");
2656 // Some types skip the assembler phase (e.g., llvm-bc), but we can't
2657 // encode this in the steps because the intermediate type depends on
2658 // arguments. Just special case here.
2659 if (Phase == phases::Assemble && Input->getType() != types::TY_PP_Asm)
2662 // Build the appropriate action.
2665 llvm_unreachable("link action invalid here.");
2666 case phases::Preprocess: {
2668 // -{M, MM} alter the output type.
2669 if (Args.hasArg(options::OPT_M, options::OPT_MM)) {
2670 OutputTy = types::TY_Dependencies;
2672 OutputTy = Input->getType();
2673 if (!Args.hasFlag(options::OPT_frewrite_includes,
2674 options::OPT_fno_rewrite_includes, false) &&
2675 !Args.hasFlag(options::OPT_frewrite_imports,
2676 options::OPT_fno_rewrite_imports, false) &&
2678 OutputTy = types::getPreprocessedType(OutputTy);
2679 assert(OutputTy != types::TY_INVALID &&
2680 "Cannot preprocess this input type!");
2682 return C.MakeAction<PreprocessJobAction>(Input, OutputTy);
2684 case phases::Precompile: {
2685 types::ID OutputTy = getPrecompiledType(Input->getType());
2686 assert(OutputTy != types::TY_INVALID &&
2687 "Cannot precompile this input type!");
2688 if (Args.hasArg(options::OPT_fsyntax_only)) {
2689 // Syntax checks should not emit a PCH file
2690 OutputTy = types::TY_Nothing;
2692 return C.MakeAction<PrecompileJobAction>(Input, OutputTy);
2694 case phases::Compile: {
2695 if (Args.hasArg(options::OPT_fsyntax_only))
2696 return C.MakeAction<CompileJobAction>(Input, types::TY_Nothing);
2697 if (Args.hasArg(options::OPT_rewrite_objc))
2698 return C.MakeAction<CompileJobAction>(Input, types::TY_RewrittenObjC);
2699 if (Args.hasArg(options::OPT_rewrite_legacy_objc))
2700 return C.MakeAction<CompileJobAction>(Input,
2701 types::TY_RewrittenLegacyObjC);
2702 if (Args.hasArg(options::OPT__analyze, options::OPT__analyze_auto))
2703 return C.MakeAction<AnalyzeJobAction>(Input, types::TY_Plist);
2704 if (Args.hasArg(options::OPT__migrate))
2705 return C.MakeAction<MigrateJobAction>(Input, types::TY_Remap);
2706 if (Args.hasArg(options::OPT_emit_ast))
2707 return C.MakeAction<CompileJobAction>(Input, types::TY_AST);
2708 if (Args.hasArg(options::OPT_module_file_info))
2709 return C.MakeAction<CompileJobAction>(Input, types::TY_ModuleFile);
2710 if (Args.hasArg(options::OPT_verify_pch))
2711 return C.MakeAction<VerifyPCHJobAction>(Input, types::TY_Nothing);
2712 return C.MakeAction<CompileJobAction>(Input, types::TY_LLVM_BC);
2714 case phases::Backend: {
2717 Args.hasArg(options::OPT_S) ? types::TY_LTO_IR : types::TY_LTO_BC;
2718 return C.MakeAction<BackendJobAction>(Input, Output);
2720 if (Args.hasArg(options::OPT_emit_llvm)) {
2722 Args.hasArg(options::OPT_S) ? types::TY_LLVM_IR : types::TY_LLVM_BC;
2723 return C.MakeAction<BackendJobAction>(Input, Output);
2725 return C.MakeAction<BackendJobAction>(Input, types::TY_PP_Asm);
2727 case phases::Assemble:
2728 return C.MakeAction<AssembleJobAction>(std::move(Input), types::TY_Object);
2731 llvm_unreachable("invalid phase in ConstructPhaseAction");
2734 void Driver::BuildJobs(Compilation &C) const {
2735 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
2737 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
2739 // It is an error to provide a -o option if we are making multiple output
2742 unsigned NumOutputs = 0;
2743 for (const Action *A : C.getActions())
2744 if (A->getType() != types::TY_Nothing)
2747 if (NumOutputs > 1) {
2748 Diag(clang::diag::err_drv_output_argument_with_multiple_files);
2749 FinalOutput = nullptr;
2753 // Collect the list of architectures.
2754 llvm::StringSet<> ArchNames;
2755 if (C.getDefaultToolChain().getTriple().isOSBinFormatMachO())
2756 for (const Arg *A : C.getArgs())
2757 if (A->getOption().matches(options::OPT_arch))
2758 ArchNames.insert(A->getValue());
2760 // Set of (Action, canonical ToolChain triple) pairs we've built jobs for.
2761 std::map<std::pair<const Action *, std::string>, InputInfo> CachedResults;
2762 for (Action *A : C.getActions()) {
2763 // If we are linking an image for multiple archs then the linker wants
2764 // -arch_multiple and -final_output <final image name>. Unfortunately, this
2765 // doesn't fit in cleanly because we have to pass this information down.
2767 // FIXME: This is a hack; find a cleaner way to integrate this into the
2769 const char *LinkingOutput = nullptr;
2770 if (isa<LipoJobAction>(A)) {
2772 LinkingOutput = FinalOutput->getValue();
2774 LinkingOutput = getDefaultImageName();
2777 BuildJobsForAction(C, A, &C.getDefaultToolChain(),
2778 /*BoundArch*/ StringRef(),
2779 /*AtTopLevel*/ true,
2780 /*MultipleArchs*/ ArchNames.size() > 1,
2781 /*LinkingOutput*/ LinkingOutput, CachedResults,
2782 /*TargetDeviceOffloadKind*/ Action::OFK_None);
2785 // If the user passed -Qunused-arguments or there were errors, don't warn
2786 // about any unused arguments.
2787 if (Diags.hasErrorOccurred() ||
2788 C.getArgs().hasArg(options::OPT_Qunused_arguments))
2792 (void)C.getArgs().hasArg(options::OPT__HASH_HASH_HASH);
2794 // Claim --driver-mode, --rsp-quoting, it was handled earlier.
2795 (void)C.getArgs().hasArg(options::OPT_driver_mode);
2796 (void)C.getArgs().hasArg(options::OPT_rsp_quoting);
2798 for (Arg *A : C.getArgs()) {
2799 // FIXME: It would be nice to be able to send the argument to the
2800 // DiagnosticsEngine, so that extra values, position, and so on could be
2802 if (!A->isClaimed()) {
2803 if (A->getOption().hasFlag(options::NoArgumentUnused))
2806 // Suppress the warning automatically if this is just a flag, and it is an
2807 // instance of an argument we already claimed.
2808 const Option &Opt = A->getOption();
2809 if (Opt.getKind() == Option::FlagClass) {
2810 bool DuplicateClaimed = false;
2812 for (const Arg *AA : C.getArgs().filtered(&Opt)) {
2813 if (AA->isClaimed()) {
2814 DuplicateClaimed = true;
2819 if (DuplicateClaimed)
2823 // In clang-cl, don't mention unknown arguments here since they have
2824 // already been warned about.
2825 if (!IsCLMode() || !A->getOption().matches(options::OPT_UNKNOWN))
2826 Diag(clang::diag::warn_drv_unused_argument)
2827 << A->getAsString(C.getArgs());
2833 /// Utility class to control the collapse of dependent actions and select the
2834 /// tools accordingly.
2835 class ToolSelector final {
2836 /// The tool chain this selector refers to.
2837 const ToolChain &TC;
2839 /// The compilation this selector refers to.
2840 const Compilation &C;
2842 /// The base action this selector refers to.
2843 const JobAction *BaseAction;
2845 /// Set to true if the current toolchain refers to host actions.
2846 bool IsHostSelector;
2848 /// Set to true if save-temps and embed-bitcode functionalities are active.
2852 /// Get previous dependent action or null if that does not exist. If
2853 /// \a CanBeCollapsed is false, that action must be legal to collapse or
2854 /// null will be returned.
2855 const JobAction *getPrevDependentAction(const ActionList &Inputs,
2856 ActionList &SavedOffloadAction,
2857 bool CanBeCollapsed = true) {
2858 // An option can be collapsed only if it has a single input.
2859 if (Inputs.size() != 1)
2862 Action *CurAction = *Inputs.begin();
2863 if (CanBeCollapsed &&
2864 !CurAction->isCollapsingWithNextDependentActionLegal())
2867 // If the input action is an offload action. Look through it and save any
2868 // offload action that can be dropped in the event of a collapse.
2869 if (auto *OA = dyn_cast<OffloadAction>(CurAction)) {
2870 // If the dependent action is a device action, we will attempt to collapse
2871 // only with other device actions. Otherwise, we would do the same but
2872 // with host actions only.
2873 if (!IsHostSelector) {
2874 if (OA->hasSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)) {
2876 OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true);
2877 if (CanBeCollapsed &&
2878 !CurAction->isCollapsingWithNextDependentActionLegal())
2880 SavedOffloadAction.push_back(OA);
2881 return dyn_cast<JobAction>(CurAction);
2883 } else if (OA->hasHostDependence()) {
2884 CurAction = OA->getHostDependence();
2885 if (CanBeCollapsed &&
2886 !CurAction->isCollapsingWithNextDependentActionLegal())
2888 SavedOffloadAction.push_back(OA);
2889 return dyn_cast<JobAction>(CurAction);
2894 return dyn_cast<JobAction>(CurAction);
2897 /// Return true if an assemble action can be collapsed.
2898 bool canCollapseAssembleAction() const {
2899 return TC.useIntegratedAs() && !SaveTemps &&
2900 !C.getArgs().hasArg(options::OPT_via_file_asm) &&
2901 !C.getArgs().hasArg(options::OPT__SLASH_FA) &&
2902 !C.getArgs().hasArg(options::OPT__SLASH_Fa);
2905 /// Return true if a preprocessor action can be collapsed.
2906 bool canCollapsePreprocessorAction() const {
2907 return !C.getArgs().hasArg(options::OPT_no_integrated_cpp) &&
2908 !C.getArgs().hasArg(options::OPT_traditional_cpp) && !SaveTemps &&
2909 !C.getArgs().hasArg(options::OPT_rewrite_objc);
2912 /// Struct that relates an action with the offload actions that would be
2913 /// collapsed with it.
2914 struct JobActionInfo final {
2915 /// The action this info refers to.
2916 const JobAction *JA = nullptr;
2917 /// The offload actions we need to take care off if this action is
2919 ActionList SavedOffloadAction;
2922 /// Append collapsed offload actions from the give nnumber of elements in the
2923 /// action info array.
2924 static void AppendCollapsedOffloadAction(ActionList &CollapsedOffloadAction,
2925 ArrayRef<JobActionInfo> &ActionInfo,
2926 unsigned ElementNum) {
2927 assert(ElementNum <= ActionInfo.size() && "Invalid number of elements.");
2928 for (unsigned I = 0; I < ElementNum; ++I)
2929 CollapsedOffloadAction.append(ActionInfo[I].SavedOffloadAction.begin(),
2930 ActionInfo[I].SavedOffloadAction.end());
2933 /// Functions that attempt to perform the combining. They detect if that is
2934 /// legal, and if so they update the inputs \a Inputs and the offload action
2935 /// that were collapsed in \a CollapsedOffloadAction. A tool that deals with
2936 /// the combined action is returned. If the combining is not legal or if the
2937 /// tool does not exist, null is returned.
2938 /// Currently three kinds of collapsing are supported:
2939 /// - Assemble + Backend + Compile;
2940 /// - Assemble + Backend ;
2941 /// - Backend + Compile.
2943 combineAssembleBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
2944 const ActionList *&Inputs,
2945 ActionList &CollapsedOffloadAction) {
2946 if (ActionInfo.size() < 3 || !canCollapseAssembleAction())
2948 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
2949 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
2950 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[2].JA);
2951 if (!AJ || !BJ || !CJ)
2954 // Get compiler tool.
2955 const Tool *T = TC.SelectTool(*CJ);
2959 // When using -fembed-bitcode, it is required to have the same tool (clang)
2960 // for both CompilerJA and BackendJA. Otherwise, combine two stages.
2962 const Tool *BT = TC.SelectTool(*BJ);
2967 if (!T->hasIntegratedAssembler())
2970 Inputs = &CJ->getInputs();
2971 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
2975 const Tool *combineAssembleBackend(ArrayRef<JobActionInfo> ActionInfo,
2976 const ActionList *&Inputs,
2977 ActionList &CollapsedOffloadAction) {
2978 if (ActionInfo.size() < 2 || !canCollapseAssembleAction())
2980 auto *AJ = dyn_cast<AssembleJobAction>(ActionInfo[0].JA);
2981 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[1].JA);
2985 // Retrieve the compile job, backend action must always be preceded by one.
2986 ActionList CompileJobOffloadActions;
2987 auto *CJ = getPrevDependentAction(BJ->getInputs(), CompileJobOffloadActions,
2988 /*CanBeCollapsed=*/false);
2989 if (!AJ || !BJ || !CJ)
2992 assert(isa<CompileJobAction>(CJ) &&
2993 "Expecting compile job preceding backend job.");
2995 // Get compiler tool.
2996 const Tool *T = TC.SelectTool(*CJ);
3000 if (!T->hasIntegratedAssembler())
3003 Inputs = &BJ->getInputs();
3004 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3008 const Tool *combineBackendCompile(ArrayRef<JobActionInfo> ActionInfo,
3009 const ActionList *&Inputs,
3010 ActionList &CollapsedOffloadAction) {
3011 if (ActionInfo.size() < 2 || !canCollapsePreprocessorAction())
3013 auto *BJ = dyn_cast<BackendJobAction>(ActionInfo[0].JA);
3014 auto *CJ = dyn_cast<CompileJobAction>(ActionInfo[1].JA);
3018 // Get compiler tool.
3019 const Tool *T = TC.SelectTool(*CJ);
3023 if (T->canEmitIR() && (SaveTemps || EmbedBitcode))
3026 Inputs = &CJ->getInputs();
3027 AppendCollapsedOffloadAction(CollapsedOffloadAction, ActionInfo,
3032 /// Updates the inputs if the obtained tool supports combining with
3033 /// preprocessor action, and the current input is indeed a preprocessor
3034 /// action. If combining results in the collapse of offloading actions, those
3035 /// are appended to \a CollapsedOffloadAction.
3036 void combineWithPreprocessor(const Tool *T, const ActionList *&Inputs,
3037 ActionList &CollapsedOffloadAction) {
3038 if (!T || !canCollapsePreprocessorAction() || !T->hasIntegratedCPP())
3041 // Attempt to get a preprocessor action dependence.
3042 ActionList PreprocessJobOffloadActions;
3043 auto *PJ = getPrevDependentAction(*Inputs, PreprocessJobOffloadActions);
3044 if (!PJ || !isa<PreprocessJobAction>(PJ))
3047 // This is legal to combine. Append any offload action we found and set the
3048 // current inputs to preprocessor inputs.
3049 CollapsedOffloadAction.append(PreprocessJobOffloadActions.begin(),
3050 PreprocessJobOffloadActions.end());
3051 Inputs = &PJ->getInputs();
3055 ToolSelector(const JobAction *BaseAction, const ToolChain &TC,
3056 const Compilation &C, bool SaveTemps, bool EmbedBitcode)
3057 : TC(TC), C(C), BaseAction(BaseAction), SaveTemps(SaveTemps),
3058 EmbedBitcode(EmbedBitcode) {
3059 assert(BaseAction && "Invalid base action.");
3060 IsHostSelector = BaseAction->getOffloadingDeviceKind() == Action::OFK_None;
3063 /// Check if a chain of actions can be combined and return the tool that can
3064 /// handle the combination of actions. The pointer to the current inputs \a
3065 /// Inputs and the list of offload actions \a CollapsedOffloadActions
3066 /// connected to collapsed actions are updated accordingly. The latter enables
3067 /// the caller of the selector to process them afterwards instead of just
3068 /// dropping them. If no suitable tool is found, null will be returned.
3069 const Tool *getTool(const ActionList *&Inputs,
3070 ActionList &CollapsedOffloadAction) {
3072 // Get the largest chain of actions that we could combine.
3075 SmallVector<JobActionInfo, 5> ActionChain(1);
3076 ActionChain.back().JA = BaseAction;
3077 while (ActionChain.back().JA) {
3078 const Action *CurAction = ActionChain.back().JA;
3080 // Grow the chain by one element.
3081 ActionChain.resize(ActionChain.size() + 1);
3082 JobActionInfo &AI = ActionChain.back();
3084 // Attempt to fill it with the
3086 getPrevDependentAction(CurAction->getInputs(), AI.SavedOffloadAction);
3089 // Pop the last action info as it could not be filled.
3090 ActionChain.pop_back();
3093 // Attempt to combine actions. If all combining attempts failed, just return
3094 // the tool of the provided action. At the end we attempt to combine the
3095 // action with any preprocessor action it may depend on.
3098 const Tool *T = combineAssembleBackendCompile(ActionChain, Inputs,
3099 CollapsedOffloadAction);
3101 T = combineAssembleBackend(ActionChain, Inputs, CollapsedOffloadAction);
3103 T = combineBackendCompile(ActionChain, Inputs, CollapsedOffloadAction);
3105 Inputs = &BaseAction->getInputs();
3106 T = TC.SelectTool(*BaseAction);
3109 combineWithPreprocessor(T, Inputs, CollapsedOffloadAction);
3115 /// Return a string that uniquely identifies the result of a job. The bound arch
3116 /// is not necessarily represented in the toolchain's triple -- for example,
3117 /// armv7 and armv7s both map to the same triple -- so we need both in our map.
3118 /// Also, we need to add the offloading device kind, as the same tool chain can
3119 /// be used for host and device for some programming models, e.g. OpenMP.
3120 static std::string GetTriplePlusArchString(const ToolChain *TC,
3121 StringRef BoundArch,
3122 Action::OffloadKind OffloadKind) {
3123 std::string TriplePlusArch = TC->getTriple().normalize();
3124 if (!BoundArch.empty()) {
3125 TriplePlusArch += "-";
3126 TriplePlusArch += BoundArch;
3128 TriplePlusArch += "-";
3129 TriplePlusArch += Action::GetOffloadKindName(OffloadKind);
3130 return TriplePlusArch;
3133 InputInfo Driver::BuildJobsForAction(
3134 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3135 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3136 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3137 Action::OffloadKind TargetDeviceOffloadKind) const {
3138 std::pair<const Action *, std::string> ActionTC = {
3139 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3140 auto CachedResult = CachedResults.find(ActionTC);
3141 if (CachedResult != CachedResults.end()) {
3142 return CachedResult->second;
3144 InputInfo Result = BuildJobsForActionNoCache(
3145 C, A, TC, BoundArch, AtTopLevel, MultipleArchs, LinkingOutput,
3146 CachedResults, TargetDeviceOffloadKind);
3147 CachedResults[ActionTC] = Result;
3151 InputInfo Driver::BuildJobsForActionNoCache(
3152 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
3153 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
3154 std::map<std::pair<const Action *, std::string>, InputInfo> &CachedResults,
3155 Action::OffloadKind TargetDeviceOffloadKind) const {
3156 llvm::PrettyStackTraceString CrashInfo("Building compilation jobs");
3158 InputInfoList OffloadDependencesInputInfo;
3159 bool BuildingForOffloadDevice = TargetDeviceOffloadKind != Action::OFK_None;
3160 if (const OffloadAction *OA = dyn_cast<OffloadAction>(A)) {
3161 // The offload action is expected to be used in four different situations.
3163 // a) Set a toolchain/architecture/kind for a host action:
3164 // Host Action 1 -> OffloadAction -> Host Action 2
3166 // b) Set a toolchain/architecture/kind for a device action;
3167 // Device Action 1 -> OffloadAction -> Device Action 2
3169 // c) Specify a device dependence to a host action;
3170 // Device Action 1 _
3172 // Host Action 1 ---> OffloadAction -> Host Action 2
3174 // d) Specify a host dependence to a device action.
3177 // Device Action 1 ---> OffloadAction -> Device Action 2
3179 // For a) and b), we just return the job generated for the dependence. For
3180 // c) and d) we override the current action with the host/device dependence
3181 // if the current toolchain is host/device and set the offload dependences
3182 // info with the jobs obtained from the device/host dependence(s).
3184 // If there is a single device option, just generate the job for it.
3185 if (OA->hasSingleDeviceDependence()) {
3187 OA->doOnEachDeviceDependence([&](Action *DepA, const ToolChain *DepTC,
3188 const char *DepBoundArch) {
3190 BuildJobsForAction(C, DepA, DepTC, DepBoundArch, AtTopLevel,
3191 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput,
3192 CachedResults, DepA->getOffloadingDeviceKind());
3197 // If 'Action 2' is host, we generate jobs for the device dependences and
3198 // override the current action with the host dependence. Otherwise, we
3199 // generate the host dependences and override the action with the device
3200 // dependence. The dependences can't therefore be a top-level action.
3201 OA->doOnEachDependence(
3202 /*IsHostDependence=*/BuildingForOffloadDevice,
3203 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3204 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3205 C, DepA, DepTC, DepBoundArch, /*AtTopLevel=*/false,
3206 /*MultipleArchs*/ !!DepBoundArch, LinkingOutput, CachedResults,
3207 DepA->getOffloadingDeviceKind()));
3210 A = BuildingForOffloadDevice
3211 ? OA->getSingleDeviceDependence(/*DoNotConsiderHostActions=*/true)
3212 : OA->getHostDependence();
3215 if (const InputAction *IA = dyn_cast<InputAction>(A)) {
3216 // FIXME: It would be nice to not claim this here; maybe the old scheme of
3217 // just using Args was better?
3218 const Arg &Input = IA->getInputArg();
3220 if (Input.getOption().matches(options::OPT_INPUT)) {
3221 const char *Name = Input.getValue();
3222 return InputInfo(A, Name, /* BaseInput = */ Name);
3224 return InputInfo(A, &Input, /* BaseInput = */ "");
3227 if (const BindArchAction *BAA = dyn_cast<BindArchAction>(A)) {
3228 const ToolChain *TC;
3229 StringRef ArchName = BAA->getArchName();
3231 if (!ArchName.empty())
3232 TC = &getToolChain(C.getArgs(),
3233 computeTargetTriple(*this, DefaultTargetTriple,
3234 C.getArgs(), ArchName));
3236 TC = &C.getDefaultToolChain();
3238 return BuildJobsForAction(C, *BAA->input_begin(), TC, ArchName, AtTopLevel,
3239 MultipleArchs, LinkingOutput, CachedResults,
3240 TargetDeviceOffloadKind);
3244 const ActionList *Inputs = &A->getInputs();
3246 const JobAction *JA = cast<JobAction>(A);
3247 ActionList CollapsedOffloadActions;
3249 ToolSelector TS(JA, *TC, C, isSaveTempsEnabled(),
3250 embedBitcodeInObject() && !isUsingLTO());
3251 const Tool *T = TS.getTool(Inputs, CollapsedOffloadActions);
3256 // If we've collapsed action list that contained OffloadAction we
3257 // need to build jobs for host/device-side inputs it may have held.
3258 for (const auto *OA : CollapsedOffloadActions)
3259 cast<OffloadAction>(OA)->doOnEachDependence(
3260 /*IsHostDependence=*/BuildingForOffloadDevice,
3261 [&](Action *DepA, const ToolChain *DepTC, const char *DepBoundArch) {
3262 OffloadDependencesInputInfo.push_back(BuildJobsForAction(
3263 C, DepA, DepTC, DepBoundArch, /* AtTopLevel */ false,
3264 /*MultipleArchs=*/!!DepBoundArch, LinkingOutput, CachedResults,
3265 DepA->getOffloadingDeviceKind()));
3268 // Only use pipes when there is exactly one input.
3269 InputInfoList InputInfos;
3270 for (const Action *Input : *Inputs) {
3271 // Treat dsymutil and verify sub-jobs as being at the top-level too, they
3272 // shouldn't get temporary output names.
3273 // FIXME: Clean this up.
3274 bool SubJobAtTopLevel =
3275 AtTopLevel && (isa<DsymutilJobAction>(A) || isa<VerifyJobAction>(A));
3276 InputInfos.push_back(BuildJobsForAction(
3277 C, Input, TC, BoundArch, SubJobAtTopLevel, MultipleArchs, LinkingOutput,
3278 CachedResults, A->getOffloadingDeviceKind()));
3281 // Always use the first input as the base input.
3282 const char *BaseInput = InputInfos[0].getBaseInput();
3284 // ... except dsymutil actions, which use their actual input as the base
3286 if (JA->getType() == types::TY_dSYM)
3287 BaseInput = InputInfos[0].getFilename();
3289 // Append outputs of offload device jobs to the input list
3290 if (!OffloadDependencesInputInfo.empty())
3291 InputInfos.append(OffloadDependencesInputInfo.begin(),
3292 OffloadDependencesInputInfo.end());
3294 // Set the effective triple of the toolchain for the duration of this job.
3295 llvm::Triple EffectiveTriple;
3296 const ToolChain &ToolTC = T->getToolChain();
3297 const ArgList &Args =
3298 C.getArgsForToolChain(TC, BoundArch, A->getOffloadingDeviceKind());
3299 if (InputInfos.size() != 1) {
3300 EffectiveTriple = llvm::Triple(ToolTC.ComputeEffectiveClangTriple(Args));
3302 // Pass along the input type if it can be unambiguously determined.
3303 EffectiveTriple = llvm::Triple(
3304 ToolTC.ComputeEffectiveClangTriple(Args, InputInfos[0].getType()));
3306 RegisterEffectiveTriple TripleRAII(ToolTC, EffectiveTriple);
3308 // Determine the place to write output to, if any.
3310 InputInfoList UnbundlingResults;
3311 if (auto *UA = dyn_cast<OffloadUnbundlingJobAction>(JA)) {
3312 // If we have an unbundling job, we need to create results for all the
3313 // outputs. We also update the results cache so that other actions using
3314 // this unbundling action can get the right results.
3315 for (auto &UI : UA->getDependentActionsInfo()) {
3316 assert(UI.DependentOffloadKind != Action::OFK_None &&
3317 "Unbundling with no offloading??");
3319 // Unbundling actions are never at the top level. When we generate the
3320 // offloading prefix, we also do that for the host file because the
3321 // unbundling action does not change the type of the output which can
3322 // cause a overwrite.
3323 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3324 UI.DependentOffloadKind,
3325 UI.DependentToolChain->getTriple().normalize(),
3326 /*CreatePrefixForHost=*/true);
3327 auto CurI = InputInfo(
3328 UA, GetNamedOutputPath(C, *UA, BaseInput, UI.DependentBoundArch,
3329 /*AtTopLevel=*/false, MultipleArchs,
3332 // Save the unbundling result.
3333 UnbundlingResults.push_back(CurI);
3335 // Get the unique string identifier for this dependence and cache the
3337 CachedResults[{A, GetTriplePlusArchString(
3338 UI.DependentToolChain, UI.DependentBoundArch,
3339 UI.DependentOffloadKind)}] = CurI;
3342 // Now that we have all the results generated, select the one that should be
3343 // returned for the current depending action.
3344 std::pair<const Action *, std::string> ActionTC = {
3345 A, GetTriplePlusArchString(TC, BoundArch, TargetDeviceOffloadKind)};
3346 assert(CachedResults.find(ActionTC) != CachedResults.end() &&
3347 "Result does not exist??");
3348 Result = CachedResults[ActionTC];
3349 } else if (JA->getType() == types::TY_Nothing)
3350 Result = InputInfo(A, BaseInput);
3352 // We only have to generate a prefix for the host if this is not a top-level
3354 std::string OffloadingPrefix = Action::GetOffloadingFileNamePrefix(
3355 A->getOffloadingDeviceKind(), TC->getTriple().normalize(),
3356 /*CreatePrefixForHost=*/!!A->getOffloadingHostActiveKinds() &&
3358 Result = InputInfo(A, GetNamedOutputPath(C, *JA, BaseInput, BoundArch,
3359 AtTopLevel, MultipleArchs,
3364 if (CCCPrintBindings && !CCGenDiagnostics) {
3365 llvm::errs() << "# \"" << T->getToolChain().getTripleString() << '"'
3366 << " - \"" << T->getName() << "\", inputs: [";
3367 for (unsigned i = 0, e = InputInfos.size(); i != e; ++i) {
3368 llvm::errs() << InputInfos[i].getAsString();
3370 llvm::errs() << ", ";
3372 if (UnbundlingResults.empty())
3373 llvm::errs() << "], output: " << Result.getAsString() << "\n";
3375 llvm::errs() << "], outputs: [";
3376 for (unsigned i = 0, e = UnbundlingResults.size(); i != e; ++i) {
3377 llvm::errs() << UnbundlingResults[i].getAsString();
3379 llvm::errs() << ", ";
3381 llvm::errs() << "] \n";
3384 if (UnbundlingResults.empty())
3386 C, *JA, Result, InputInfos,
3387 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3390 T->ConstructJobMultipleOutputs(
3391 C, *JA, UnbundlingResults, InputInfos,
3392 C.getArgsForToolChain(TC, BoundArch, JA->getOffloadingDeviceKind()),
3398 const char *Driver::getDefaultImageName() const {
3399 llvm::Triple Target(llvm::Triple::normalize(DefaultTargetTriple));
3400 return Target.isOSWindows() ? "a.exe" : "a.out";
3403 /// \brief Create output filename based on ArgValue, which could either be a
3404 /// full filename, filename without extension, or a directory. If ArgValue
3405 /// does not provide a filename, then use BaseName, and use the extension
3406 /// suitable for FileType.
3407 static const char *MakeCLOutputFilename(const ArgList &Args, StringRef ArgValue,
3409 types::ID FileType) {
3410 SmallString<128> Filename = ArgValue;
3412 if (ArgValue.empty()) {
3413 // If the argument is empty, output to BaseName in the current dir.
3414 Filename = BaseName;
3415 } else if (llvm::sys::path::is_separator(Filename.back())) {
3416 // If the argument is a directory, output to BaseName in that dir.
3417 llvm::sys::path::append(Filename, BaseName);
3420 if (!llvm::sys::path::has_extension(ArgValue)) {
3421 // If the argument didn't provide an extension, then set it.
3422 const char *Extension = types::getTypeTempSuffix(FileType, true);
3424 if (FileType == types::TY_Image &&
3425 Args.hasArg(options::OPT__SLASH_LD, options::OPT__SLASH_LDd)) {
3426 // The output file is a dll.
3430 llvm::sys::path::replace_extension(Filename, Extension);
3433 return Args.MakeArgString(Filename.c_str());
3436 const char *Driver::GetNamedOutputPath(Compilation &C, const JobAction &JA,
3437 const char *BaseInput,
3438 StringRef BoundArch, bool AtTopLevel,
3440 StringRef OffloadingPrefix) const {
3441 llvm::PrettyStackTraceString CrashInfo("Computing output path");
3442 // Output to a user requested destination?
3443 if (AtTopLevel && !isa<DsymutilJobAction>(JA) && !isa<VerifyJobAction>(JA)) {
3444 if (Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o))
3445 return C.addResultFile(FinalOutput->getValue(), &JA);
3448 // For /P, preprocess to file named after BaseInput.
3449 if (C.getArgs().hasArg(options::OPT__SLASH_P)) {
3450 assert(AtTopLevel && isa<PreprocessJobAction>(JA));
3451 StringRef BaseName = llvm::sys::path::filename(BaseInput);
3453 if (Arg *A = C.getArgs().getLastArg(options::OPT__SLASH_Fi))
3454 NameArg = A->getValue();
3455 return C.addResultFile(
3456 MakeCLOutputFilename(C.getArgs(), NameArg, BaseName, types::TY_PP_C),
3460 // Default to writing to stdout?
3461 if (AtTopLevel && !CCGenDiagnostics &&
3462 (isa<PreprocessJobAction>(JA) || JA.getType() == types::TY_ModuleFile))
3465 // Is this the assembly listing for /FA?
3466 if (JA.getType() == types::TY_PP_Asm &&
3467 (C.getArgs().hasArg(options::OPT__SLASH_FA) ||
3468 C.getArgs().hasArg(options::OPT__SLASH_Fa))) {
3469 // Use /Fa and the input filename to determine the asm file name.
3470 StringRef BaseName = llvm::sys::path::filename(BaseInput);
3471 StringRef FaValue = C.getArgs().getLastArgValue(options::OPT__SLASH_Fa);
3472 return C.addResultFile(
3473 MakeCLOutputFilename(C.getArgs(), FaValue, BaseName, JA.getType()),
3477 // Output to a temporary file?
3478 if ((!AtTopLevel && !isSaveTempsEnabled() &&
3479 !C.getArgs().hasArg(options::OPT__SLASH_Fo)) ||
3481 StringRef Name = llvm::sys::path::filename(BaseInput);
3482 std::pair<StringRef, StringRef> Split = Name.split('.');
3483 std::string TmpName = GetTemporaryPath(
3484 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
3485 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
3488 SmallString<128> BasePath(BaseInput);
3491 // Dsymutil actions should use the full path.
3492 if (isa<DsymutilJobAction>(JA) || isa<VerifyJobAction>(JA))
3493 BaseName = BasePath;
3495 BaseName = llvm::sys::path::filename(BasePath);
3497 // Determine what the derived output name should be.
3498 const char *NamedOutput;
3500 if ((JA.getType() == types::TY_Object || JA.getType() == types::TY_LTO_BC) &&
3501 C.getArgs().hasArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)) {
3502 // The /Fo or /o flag decides the object filename.
3505 .getLastArg(options::OPT__SLASH_Fo, options::OPT__SLASH_o)
3508 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Object);
3509 } else if (JA.getType() == types::TY_Image &&
3510 C.getArgs().hasArg(options::OPT__SLASH_Fe,
3511 options::OPT__SLASH_o)) {
3512 // The /Fe or /o flag names the linked file.
3515 .getLastArg(options::OPT__SLASH_Fe, options::OPT__SLASH_o)
3518 MakeCLOutputFilename(C.getArgs(), Val, BaseName, types::TY_Image);
3519 } else if (JA.getType() == types::TY_Image) {
3521 // clang-cl uses BaseName for the executable name.
3523 MakeCLOutputFilename(C.getArgs(), "", BaseName, types::TY_Image);
3525 SmallString<128> Output(getDefaultImageName());
3526 Output += OffloadingPrefix;
3527 if (MultipleArchs && !BoundArch.empty()) {
3529 Output.append(BoundArch);
3531 NamedOutput = C.getArgs().MakeArgString(Output.c_str());
3533 } else if (JA.getType() == types::TY_PCH && IsCLMode()) {
3534 NamedOutput = C.getArgs().MakeArgString(GetClPchPath(C, BaseName));
3536 const char *Suffix = types::getTypeTempSuffix(JA.getType(), IsCLMode());
3537 assert(Suffix && "All types used for output should have a suffix.");
3539 std::string::size_type End = std::string::npos;
3540 if (!types::appendSuffixForType(JA.getType()))
3541 End = BaseName.rfind('.');
3542 SmallString<128> Suffixed(BaseName.substr(0, End));
3543 Suffixed += OffloadingPrefix;
3544 if (MultipleArchs && !BoundArch.empty()) {
3546 Suffixed.append(BoundArch);
3548 // When using both -save-temps and -emit-llvm, use a ".tmp.bc" suffix for
3549 // the unoptimized bitcode so that it does not get overwritten by the ".bc"
3550 // optimized bitcode output.
3551 if (!AtTopLevel && C.getArgs().hasArg(options::OPT_emit_llvm) &&
3552 JA.getType() == types::TY_LLVM_BC)
3556 NamedOutput = C.getArgs().MakeArgString(Suffixed.c_str());
3559 // Prepend object file path if -save-temps=obj
3560 if (!AtTopLevel && isSaveTempsObj() && C.getArgs().hasArg(options::OPT_o) &&
3561 JA.getType() != types::TY_PCH) {
3562 Arg *FinalOutput = C.getArgs().getLastArg(options::OPT_o);
3563 SmallString<128> TempPath(FinalOutput->getValue());
3564 llvm::sys::path::remove_filename(TempPath);
3565 StringRef OutputFileName = llvm::sys::path::filename(NamedOutput);
3566 llvm::sys::path::append(TempPath, OutputFileName);
3567 NamedOutput = C.getArgs().MakeArgString(TempPath.c_str());
3570 // If we're saving temps and the temp file conflicts with the input file,
3571 // then avoid overwriting input file.
3572 if (!AtTopLevel && isSaveTempsEnabled() && NamedOutput == BaseName) {
3573 bool SameFile = false;
3574 SmallString<256> Result;
3575 llvm::sys::fs::current_path(Result);
3576 llvm::sys::path::append(Result, BaseName);
3577 llvm::sys::fs::equivalent(BaseInput, Result.c_str(), SameFile);
3578 // Must share the same path to conflict.
3580 StringRef Name = llvm::sys::path::filename(BaseInput);
3581 std::pair<StringRef, StringRef> Split = Name.split('.');
3582 std::string TmpName = GetTemporaryPath(
3583 Split.first, types::getTypeTempSuffix(JA.getType(), IsCLMode()));
3584 return C.addTempFile(C.getArgs().MakeArgString(TmpName));
3588 // As an annoying special case, PCH generation doesn't strip the pathname.
3589 if (JA.getType() == types::TY_PCH && !IsCLMode()) {
3590 llvm::sys::path::remove_filename(BasePath);
3591 if (BasePath.empty())
3592 BasePath = NamedOutput;
3594 llvm::sys::path::append(BasePath, NamedOutput);
3595 return C.addResultFile(C.getArgs().MakeArgString(BasePath.c_str()), &JA);
3597 return C.addResultFile(NamedOutput, &JA);
3601 std::string Driver::GetFilePath(StringRef Name, const ToolChain &TC) const {
3602 // Respect a limited subset of the '-Bprefix' functionality in GCC by
3603 // attempting to use this prefix when looking for file paths.
3604 for (const std::string &Dir : PrefixDirs) {
3607 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
3608 llvm::sys::path::append(P, Name);
3609 if (llvm::sys::fs::exists(Twine(P)))
3613 SmallString<128> P(ResourceDir);
3614 llvm::sys::path::append(P, Name);
3615 if (llvm::sys::fs::exists(Twine(P)))
3618 for (const std::string &Dir : TC.getFilePaths()) {
3621 SmallString<128> P(Dir[0] == '=' ? SysRoot + Dir.substr(1) : Dir);
3622 llvm::sys::path::append(P, Name);
3623 if (llvm::sys::fs::exists(Twine(P)))
3630 void Driver::generatePrefixedToolNames(
3631 StringRef Tool, const ToolChain &TC,
3632 SmallVectorImpl<std::string> &Names) const {
3633 // FIXME: Needs a better variable than DefaultTargetTriple
3634 Names.emplace_back((DefaultTargetTriple + "-" + Tool).str());
3635 Names.emplace_back(Tool);
3637 // Allow the discovery of tools prefixed with LLVM's default target triple.
3638 std::string LLVMDefaultTargetTriple = llvm::sys::getDefaultTargetTriple();
3639 if (LLVMDefaultTargetTriple != DefaultTargetTriple)
3640 Names.emplace_back((LLVMDefaultTargetTriple + "-" + Tool).str());
3643 static bool ScanDirForExecutable(SmallString<128> &Dir,
3644 ArrayRef<std::string> Names) {
3645 for (const auto &Name : Names) {
3646 llvm::sys::path::append(Dir, Name);
3647 if (llvm::sys::fs::can_execute(Twine(Dir)))
3649 llvm::sys::path::remove_filename(Dir);
3654 std::string Driver::GetProgramPath(StringRef Name, const ToolChain &TC) const {
3655 SmallVector<std::string, 2> TargetSpecificExecutables;
3656 generatePrefixedToolNames(Name, TC, TargetSpecificExecutables);
3658 // Respect a limited subset of the '-Bprefix' functionality in GCC by
3659 // attempting to use this prefix when looking for program paths.
3660 for (const auto &PrefixDir : PrefixDirs) {
3661 if (llvm::sys::fs::is_directory(PrefixDir)) {
3662 SmallString<128> P(PrefixDir);
3663 if (ScanDirForExecutable(P, TargetSpecificExecutables))
3666 SmallString<128> P((PrefixDir + Name).str());
3667 if (llvm::sys::fs::can_execute(Twine(P)))
3672 const ToolChain::path_list &List = TC.getProgramPaths();
3673 for (const auto &Path : List) {
3674 SmallString<128> P(Path);
3675 if (ScanDirForExecutable(P, TargetSpecificExecutables))
3679 // If all else failed, search the path.
3680 for (const auto &TargetSpecificExecutable : TargetSpecificExecutables)
3681 if (llvm::ErrorOr<std::string> P =
3682 llvm::sys::findProgramByName(TargetSpecificExecutable))
3688 std::string Driver::GetTemporaryPath(StringRef Prefix, StringRef Suffix) const {
3689 SmallString<128> Path;
3690 std::error_code EC = llvm::sys::fs::createTemporaryFile(Prefix, Suffix, Path);
3692 Diag(clang::diag::err_unable_to_make_temp) << EC.message();
3699 std::string Driver::GetClPchPath(Compilation &C, StringRef BaseName) const {
3700 SmallString<128> Output;
3701 if (Arg *FpArg = C.getArgs().getLastArg(options::OPT__SLASH_Fp)) {
3702 // FIXME: If anybody needs it, implement this obscure rule:
3703 // "If you specify a directory without a file name, the default file name
3704 // is VCx0.pch., where x is the major version of Visual C++ in use."
3705 Output = FpArg->getValue();
3707 // "If you do not specify an extension as part of the path name, an
3708 // extension of .pch is assumed. "
3709 if (!llvm::sys::path::has_extension(Output))
3713 llvm::sys::path::replace_extension(Output, ".pch");
3715 return Output.str();
3718 const ToolChain &Driver::getToolChain(const ArgList &Args,
3719 const llvm::Triple &Target) const {
3721 auto &TC = ToolChains[Target.str()];
3723 switch (Target.getOS()) {
3724 case llvm::Triple::Haiku:
3725 TC = llvm::make_unique<toolchains::Haiku>(*this, Target, Args);
3727 case llvm::Triple::CloudABI:
3728 TC = llvm::make_unique<toolchains::CloudABI>(*this, Target, Args);
3730 case llvm::Triple::Darwin:
3731 case llvm::Triple::MacOSX:
3732 case llvm::Triple::IOS:
3733 case llvm::Triple::TvOS:
3734 case llvm::Triple::WatchOS:
3735 TC = llvm::make_unique<toolchains::DarwinClang>(*this, Target, Args);
3737 case llvm::Triple::DragonFly:
3738 TC = llvm::make_unique<toolchains::DragonFly>(*this, Target, Args);
3740 case llvm::Triple::OpenBSD:
3741 TC = llvm::make_unique<toolchains::OpenBSD>(*this, Target, Args);
3743 case llvm::Triple::Bitrig:
3744 TC = llvm::make_unique<toolchains::Bitrig>(*this, Target, Args);
3746 case llvm::Triple::NetBSD:
3747 TC = llvm::make_unique<toolchains::NetBSD>(*this, Target, Args);
3749 case llvm::Triple::FreeBSD:
3750 TC = llvm::make_unique<toolchains::FreeBSD>(*this, Target, Args);
3752 case llvm::Triple::Minix:
3753 TC = llvm::make_unique<toolchains::Minix>(*this, Target, Args);
3755 case llvm::Triple::Linux:
3756 case llvm::Triple::ELFIAMCU:
3757 if (Target.getArch() == llvm::Triple::hexagon)
3758 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3760 else if ((Target.getVendor() == llvm::Triple::MipsTechnologies) &&
3761 !Target.hasEnvironment())
3762 TC = llvm::make_unique<toolchains::MipsLLVMToolChain>(*this, Target,
3765 TC = llvm::make_unique<toolchains::Linux>(*this, Target, Args);
3767 case llvm::Triple::NaCl:
3768 TC = llvm::make_unique<toolchains::NaClToolChain>(*this, Target, Args);
3770 case llvm::Triple::Fuchsia:
3771 TC = llvm::make_unique<toolchains::Fuchsia>(*this, Target, Args);
3773 case llvm::Triple::Solaris:
3774 TC = llvm::make_unique<toolchains::Solaris>(*this, Target, Args);
3776 case llvm::Triple::AMDHSA:
3777 TC = llvm::make_unique<toolchains::AMDGPUToolChain>(*this, Target, Args);
3779 case llvm::Triple::Win32:
3780 switch (Target.getEnvironment()) {
3782 if (Target.isOSBinFormatELF())
3783 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
3784 else if (Target.isOSBinFormatMachO())
3785 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
3787 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
3789 case llvm::Triple::GNU:
3790 TC = llvm::make_unique<toolchains::MinGW>(*this, Target, Args);
3792 case llvm::Triple::Itanium:
3793 TC = llvm::make_unique<toolchains::CrossWindowsToolChain>(*this, Target,
3796 case llvm::Triple::MSVC:
3797 case llvm::Triple::UnknownEnvironment:
3798 TC = llvm::make_unique<toolchains::MSVCToolChain>(*this, Target, Args);
3802 case llvm::Triple::PS4:
3803 TC = llvm::make_unique<toolchains::PS4CPU>(*this, Target, Args);
3805 case llvm::Triple::Contiki:
3806 TC = llvm::make_unique<toolchains::Contiki>(*this, Target, Args);
3809 // Of these targets, Hexagon is the only one that might have
3810 // an OS of Linux, in which case it got handled above already.
3811 switch (Target.getArch()) {
3812 case llvm::Triple::tce:
3813 TC = llvm::make_unique<toolchains::TCEToolChain>(*this, Target, Args);
3815 case llvm::Triple::tcele:
3816 TC = llvm::make_unique<toolchains::TCELEToolChain>(*this, Target, Args);
3818 case llvm::Triple::hexagon:
3819 TC = llvm::make_unique<toolchains::HexagonToolChain>(*this, Target,
3822 case llvm::Triple::lanai:
3823 TC = llvm::make_unique<toolchains::LanaiToolChain>(*this, Target, Args);
3825 case llvm::Triple::xcore:
3826 TC = llvm::make_unique<toolchains::XCoreToolChain>(*this, Target, Args);
3828 case llvm::Triple::wasm32:
3829 case llvm::Triple::wasm64:
3830 TC = llvm::make_unique<toolchains::WebAssembly>(*this, Target, Args);
3832 case llvm::Triple::avr:
3833 TC = llvm::make_unique<toolchains::AVRToolChain>(*this, Target, Args);
3836 if (Target.getVendor() == llvm::Triple::Myriad)
3837 TC = llvm::make_unique<toolchains::MyriadToolChain>(*this, Target,
3839 else if (toolchains::BareMetal::handlesTarget(Target))
3840 TC = llvm::make_unique<toolchains::BareMetal>(*this, Target, Args);
3841 else if (Target.isOSBinFormatELF())
3842 TC = llvm::make_unique<toolchains::Generic_ELF>(*this, Target, Args);
3843 else if (Target.isOSBinFormatMachO())
3844 TC = llvm::make_unique<toolchains::MachO>(*this, Target, Args);
3846 TC = llvm::make_unique<toolchains::Generic_GCC>(*this, Target, Args);
3851 // Intentionally omitted from the switch above: llvm::Triple::CUDA. CUDA
3852 // compiles always need two toolchains, the CUDA toolchain and the host
3853 // toolchain. So the only valid way to create a CUDA toolchain is via
3854 // CreateOffloadingDeviceToolChains.
3859 bool Driver::ShouldUseClangCompiler(const JobAction &JA) const {
3860 // Say "no" if there is not exactly one input of a type clang understands.
3861 if (JA.size() != 1 ||
3862 !types::isAcceptedByClang((*JA.input_begin())->getType()))
3865 // And say "no" if this is not a kind of action clang understands.
3866 if (!isa<PreprocessJobAction>(JA) && !isa<PrecompileJobAction>(JA) &&
3867 !isa<CompileJobAction>(JA) && !isa<BackendJobAction>(JA))
3873 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and return the
3874 /// grouped values as integers. Numbers which are not provided are set to 0.
3876 /// \return True if the entire string was parsed (9.2), or all groups were
3877 /// parsed (10.3.5extrastuff).
3878 bool Driver::GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
3879 unsigned &Micro, bool &HadExtra) {
3882 Major = Minor = Micro = 0;
3886 if (Str.consumeInteger(10, Major))
3893 Str = Str.drop_front(1);
3895 if (Str.consumeInteger(10, Minor))
3901 Str = Str.drop_front(1);
3903 if (Str.consumeInteger(10, Micro))
3910 /// Parse digits from a string \p Str and fulfill \p Digits with
3911 /// the parsed numbers. This method assumes that the max number of
3912 /// digits to look for is equal to Digits.size().
3914 /// \return True if the entire string was parsed and there are
3915 /// no extra characters remaining at the end.
3916 bool Driver::GetReleaseVersion(StringRef Str,
3917 MutableArrayRef<unsigned> Digits) {
3921 unsigned CurDigit = 0;
3922 while (CurDigit < Digits.size()) {
3924 if (Str.consumeInteger(10, Digit))
3926 Digits[CurDigit] = Digit;
3931 Str = Str.drop_front(1);
3935 // More digits than requested, bail out...
3939 std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
3940 unsigned IncludedFlagsBitmask = 0;
3941 unsigned ExcludedFlagsBitmask = options::NoDriverOption;
3943 if (Mode == CLMode) {
3944 // Include CL and Core options.
3945 IncludedFlagsBitmask |= options::CLOption;
3946 IncludedFlagsBitmask |= options::CoreOption;
3948 ExcludedFlagsBitmask |= options::CLOption;
3951 return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
3954 bool clang::driver::isOptimizationLevelFast(const ArgList &Args) {
3955 return Args.hasFlag(options::OPT_Ofast, options::OPT_O_Group, false);