Bug Summary

File:llvm/include/llvm/ADT/Twine.h
Warning:line 268, column 11
Array access (from variable 'Str') results in a null pointer dereference

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name Driver.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -mframe-pointer=none -relaxed-aliasing -fmath-errno -fno-rounding-math -masm-verbose -mconstructor-aliases -munwind-tables -target-cpu x86-64 -dwarf-column-info -fno-split-dwarf-inlining -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-11/lib/clang/11.0.0 -D CLANG_VENDOR="Debian " -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/build-llvm/tools/clang/lib/Driver -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/clang/lib/Driver -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/clang/include -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/build-llvm/include -I /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/llvm/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-11/lib/clang/11.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/build-llvm/tools/clang/lib/Driver -fdebug-prefix-map=/build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fobjc-runtime=gcc -fno-common -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2020-03-09-184146-41876-1 -x c++ /build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/clang/lib/Driver/Driver.cpp

/build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/clang/lib/Driver/Driver.cpp

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

/build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/clang/include/clang/Driver/Driver.h

1//===--- Driver.h - Clang GCC Compatible Driver -----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_CLANG_DRIVER_DRIVER_H
10#define LLVM_CLANG_DRIVER_DRIVER_H
11
12#include "clang/Basic/Diagnostic.h"
13#include "clang/Basic/LLVM.h"
14#include "clang/Driver/Action.h"
15#include "clang/Driver/Options.h"
16#include "clang/Driver/Phases.h"
17#include "clang/Driver/ToolChain.h"
18#include "clang/Driver/Types.h"
19#include "clang/Driver/Util.h"
20#include "llvm/ADT/StringMap.h"
21#include "llvm/ADT/StringRef.h"
22#include "llvm/Option/Arg.h"
23#include "llvm/Option/ArgList.h"
24#include "llvm/Support/StringSaver.h"
25
26#include <list>
27#include <map>
28#include <string>
29
30namespace llvm {
31class Triple;
32namespace vfs {
33class FileSystem;
34}
35} // namespace llvm
36
37namespace clang {
38
39namespace driver {
40
41 class Command;
42 class Compilation;
43 class InputInfo;
44 class JobList;
45 class JobAction;
46 class SanitizerArgs;
47 class ToolChain;
48
49/// Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
50enum LTOKind {
51 LTOK_None,
52 LTOK_Full,
53 LTOK_Thin,
54 LTOK_Unknown
55};
56
57/// Driver - Encapsulate logic for constructing compilation processes
58/// from a set of gcc-driver-like command line arguments.
59class Driver {
60 DiagnosticsEngine &Diags;
61
62 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS;
63
64 enum DriverMode {
65 GCCMode,
66 GXXMode,
67 CPPMode,
68 CLMode,
69 FlangMode
70 } Mode;
71
72 enum SaveTempsMode {
73 SaveTempsNone,
74 SaveTempsCwd,
75 SaveTempsObj
76 } SaveTemps;
77
78 enum BitcodeEmbedMode {
79 EmbedNone,
80 EmbedMarker,
81 EmbedBitcode
82 } BitcodeEmbed;
83
84 /// LTO mode selected via -f(no-)?lto(=.*)? options.
85 LTOKind LTOMode;
86
87public:
88 enum OpenMPRuntimeKind {
89 /// An unknown OpenMP runtime. We can't generate effective OpenMP code
90 /// without knowing what runtime to target.
91 OMPRT_Unknown,
92
93 /// The LLVM OpenMP runtime. When completed and integrated, this will become
94 /// the default for Clang.
95 OMPRT_OMP,
96
97 /// The GNU OpenMP runtime. Clang doesn't support generating OpenMP code for
98 /// this runtime but can swallow the pragmas, and find and link against the
99 /// runtime library itself.
100 OMPRT_GOMP,
101
102 /// The legacy name for the LLVM OpenMP runtime from when it was the Intel
103 /// OpenMP runtime. We support this mode for users with existing
104 /// dependencies on this runtime library name.
105 OMPRT_IOMP5
106 };
107
108 // Diag - Forwarding function for diagnostics.
109 DiagnosticBuilder Diag(unsigned DiagID) const {
110 return Diags.Report(DiagID);
111 }
112
113 // FIXME: Privatize once interface is stable.
114public:
115 /// The name the driver was invoked as.
116 std::string Name;
117
118 /// The path the driver executable was in, as invoked from the
119 /// command line.
120 std::string Dir;
121
122 /// The original path to the clang executable.
123 std::string ClangExecutable;
124
125 /// Target and driver mode components extracted from clang executable name.
126 ParsedClangName ClangNameParts;
127
128 /// The path to the installed clang directory, if any.
129 std::string InstalledDir;
130
131 /// The path to the compiler resource directory.
132 std::string ResourceDir;
133
134 /// System directory for config files.
135 std::string SystemConfigDir;
136
137 /// User directory for config files.
138 std::string UserConfigDir;
139
140 /// A prefix directory used to emulate a limited subset of GCC's '-Bprefix'
141 /// functionality.
142 /// FIXME: This type of customization should be removed in favor of the
143 /// universal driver when it is ready.
144 typedef SmallVector<std::string, 4> prefix_list;
145 prefix_list PrefixDirs;
146
147 /// sysroot, if present
148 std::string SysRoot;
149
150 /// Dynamic loader prefix, if present
151 std::string DyldPrefix;
152
153 /// Driver title to use with help.
154 std::string DriverTitle;
155
156 /// Information about the host which can be overridden by the user.
157 std::string HostBits, HostMachine, HostSystem, HostRelease;
158
159 /// The file to log CC_PRINT_OPTIONS output to, if enabled.
160 const char *CCPrintOptionsFilename;
161
162 /// The file to log CC_PRINT_HEADERS output to, if enabled.
163 const char *CCPrintHeadersFilename;
164
165 /// The file to log CC_LOG_DIAGNOSTICS output to, if enabled.
166 const char *CCLogDiagnosticsFilename;
167
168 /// A list of inputs and their types for the given arguments.
169 typedef SmallVector<std::pair<types::ID, const llvm::opt::Arg *>, 16>
170 InputList;
171
172 /// Whether the driver should follow g++ like behavior.
173 bool CCCIsCXX() const { return Mode == GXXMode; }
174
175 /// Whether the driver is just the preprocessor.
176 bool CCCIsCPP() const { return Mode == CPPMode; }
177
178 /// Whether the driver should follow gcc like behavior.
179 bool CCCIsCC() const { return Mode == GCCMode; }
180
181 /// Whether the driver should follow cl.exe like behavior.
182 bool IsCLMode() const { return Mode == CLMode; }
183
184 /// Whether the driver should invoke flang for fortran inputs.
185 /// Other modes fall back to calling gcc which in turn calls gfortran.
186 bool IsFlangMode() const { return Mode == FlangMode; }
187
188 /// Only print tool bindings, don't build any jobs.
189 unsigned CCCPrintBindings : 1;
190
191 /// Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to
192 /// CCPrintOptionsFilename or to stderr.
193 unsigned CCPrintOptions : 1;
194
195 /// Set CC_PRINT_HEADERS mode, which causes the frontend to log header include
196 /// information to CCPrintHeadersFilename or to stderr.
197 unsigned CCPrintHeaders : 1;
198
199 /// Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics
200 /// to CCLogDiagnosticsFilename or to stderr, in a stable machine readable
201 /// format.
202 unsigned CCLogDiagnostics : 1;
203
204 /// Whether the driver is generating diagnostics for debugging purposes.
205 unsigned CCGenDiagnostics : 1;
206
207 /// Pointer to the ExecuteCC1Tool function, if available.
208 /// When the clangDriver lib is used through clang.exe, this provides a
209 /// shortcut for executing the -cc1 command-line directly, in the same
210 /// process.
211 typedef int (*CC1ToolFunc)(SmallVectorImpl<const char *> &ArgV);
212 CC1ToolFunc CC1Main = nullptr;
213
214private:
215 /// Raw target triple.
216 std::string TargetTriple;
217
218 /// Name to use when invoking gcc/g++.
219 std::string CCCGenericGCCName;
220
221 /// Name of configuration file if used.
222 std::string ConfigFile;
223
224 /// Allocator for string saver.
225 llvm::BumpPtrAllocator Alloc;
226
227 /// Object that stores strings read from configuration file.
228 llvm::StringSaver Saver;
229
230 /// Arguments originated from configuration file.
231 std::unique_ptr<llvm::opt::InputArgList> CfgOptions;
232
233 /// Arguments originated from command line.
234 std::unique_ptr<llvm::opt::InputArgList> CLOptions;
235
236 /// Whether to check that input files exist when constructing compilation
237 /// jobs.
238 unsigned CheckInputsExist : 1;
239
240public:
241 /// Force clang to emit reproducer for driver invocation. This is enabled
242 /// indirectly by setting FORCE_CLANG_DIAGNOSTICS_CRASH environment variable
243 /// or when using the -gen-reproducer driver flag.
244 unsigned GenReproducer : 1;
245
246private:
247 /// Certain options suppress the 'no input files' warning.
248 unsigned SuppressMissingInputWarning : 1;
249
250 /// Cache of all the ToolChains in use by the driver.
251 ///
252 /// This maps from the string representation of a triple to a ToolChain
253 /// created targeting that triple. The driver owns all the ToolChain objects
254 /// stored in it, and will clean them up when torn down.
255 mutable llvm::StringMap<std::unique_ptr<ToolChain>> ToolChains;
256
257private:
258 /// TranslateInputArgs - Create a new derived argument list from the input
259 /// arguments, after applying the standard argument translations.
260 llvm::opt::DerivedArgList *
261 TranslateInputArgs(const llvm::opt::InputArgList &Args) const;
262
263 // getFinalPhase - Determine which compilation mode we are in and record
264 // which option we used to determine the final phase.
265 // TODO: Much of what getFinalPhase returns are not actually true compiler
266 // modes. Fold this functionality into Types::getCompilationPhases and
267 // handleArguments.
268 phases::ID getFinalPhase(const llvm::opt::DerivedArgList &DAL,
269 llvm::opt::Arg **FinalPhaseArg = nullptr) const;
270
271 // handleArguments - All code related to claiming and printing diagnostics
272 // related to arguments to the driver are done here.
273 void handleArguments(Compilation &C, llvm::opt::DerivedArgList &Args,
274 const InputList &Inputs, ActionList &Actions) const;
275
276 // Before executing jobs, sets up response files for commands that need them.
277 void setUpResponseFiles(Compilation &C, Command &Cmd);
278
279 void generatePrefixedToolNames(StringRef Tool, const ToolChain &TC,
280 SmallVectorImpl<std::string> &Names) const;
281
282 /// Find the appropriate .crash diagonostic file for the child crash
283 /// under this driver and copy it out to a temporary destination with the
284 /// other reproducer related files (.sh, .cache, etc). If not found, suggest a
285 /// directory for the user to look at.
286 ///
287 /// \param ReproCrashFilename The file path to copy the .crash to.
288 /// \param CrashDiagDir The suggested directory for the user to look at
289 /// in case the search or copy fails.
290 ///
291 /// \returns If the .crash is found and successfully copied return true,
292 /// otherwise false and return the suggested directory in \p CrashDiagDir.
293 bool getCrashDiagnosticFile(StringRef ReproCrashFilename,
294 SmallString<128> &CrashDiagDir);
295
296public:
297
298 /// Takes the path to a binary that's either in bin/ or lib/ and returns
299 /// the path to clang's resource directory.
300 static std::string GetResourcesPath(StringRef BinaryPath,
301 StringRef CustomResourceDir = "");
302
303 Driver(StringRef ClangExecutable, StringRef TargetTriple,
304 DiagnosticsEngine &Diags,
305 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS = nullptr);
306
307 /// @name Accessors
308 /// @{
309
310 /// Name to use when invoking gcc/g++.
311 const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; }
312
313 const std::string &getConfigFile() const { return ConfigFile; }
314
315 const llvm::opt::OptTable &getOpts() const { return getDriverOptTable(); }
316
317 const DiagnosticsEngine &getDiags() const { return Diags; }
318
319 llvm::vfs::FileSystem &getVFS() const { return *VFS; }
320
321 bool getCheckInputsExist() const { return CheckInputsExist; }
322
323 void setCheckInputsExist(bool Value) { CheckInputsExist = Value; }
324
325 void setTargetAndMode(const ParsedClangName &TM) { ClangNameParts = TM; }
326
327 const std::string &getTitle() { return DriverTitle; }
328 void setTitle(std::string Value) { DriverTitle = std::move(Value); }
329
330 std::string getTargetTriple() const { return TargetTriple; }
331
332 /// Get the path to the main clang executable.
333 const char *getClangProgramPath() const {
334 return ClangExecutable.c_str();
335 }
336
337 /// Get the path to where the clang executable was installed.
338 const char *getInstalledDir() const {
339 if (!InstalledDir.empty())
340 return InstalledDir.c_str();
341 return Dir.c_str();
342 }
343 void setInstalledDir(StringRef Value) { InstalledDir = std::string(Value); }
344
345 bool isSaveTempsEnabled() const { return SaveTemps != SaveTempsNone; }
71
Returning zero, which participates in a condition later
346 bool isSaveTempsObj() const { return SaveTemps == SaveTempsObj; }
347
348 bool embedBitcodeEnabled() const { return BitcodeEmbed != EmbedNone; }
349 bool embedBitcodeInObject() const { return (BitcodeEmbed == EmbedBitcode); }
350 bool embedBitcodeMarkerOnly() const { return (BitcodeEmbed == EmbedMarker); }
351
352 /// Compute the desired OpenMP runtime from the flags provided.
353 OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const;
354
355 /// @}
356 /// @name Primary Functionality
357 /// @{
358
359 /// CreateOffloadingDeviceToolChains - create all the toolchains required to
360 /// support offloading devices given the programming models specified in the
361 /// current compilation. Also, update the host tool chain kind accordingly.
362 void CreateOffloadingDeviceToolChains(Compilation &C, InputList &Inputs);
363
364 /// BuildCompilation - Construct a compilation object for a command
365 /// line argument vector.
366 ///
367 /// \return A compilation, or 0 if none was built for the given
368 /// argument vector. A null return value does not necessarily
369 /// indicate an error condition, the diagnostics should be queried
370 /// to determine if an error occurred.
371 Compilation *BuildCompilation(ArrayRef<const char *> Args);
372
373 /// @name Driver Steps
374 /// @{
375
376 /// ParseDriverMode - Look for and handle the driver mode option in Args.
377 void ParseDriverMode(StringRef ProgramName, ArrayRef<const char *> Args);
378
379 /// ParseArgStrings - Parse the given list of strings into an
380 /// ArgList.
381 llvm::opt::InputArgList ParseArgStrings(ArrayRef<const char *> Args,
382 bool IsClCompatMode,
383 bool &ContainsError);
384
385 /// BuildInputs - Construct the list of inputs and their types from
386 /// the given arguments.
387 ///
388 /// \param TC - The default host tool chain.
389 /// \param Args - The input arguments.
390 /// \param Inputs - The list to store the resulting compilation
391 /// inputs onto.
392 void BuildInputs(const ToolChain &TC, llvm::opt::DerivedArgList &Args,
393 InputList &Inputs) const;
394
395 /// BuildActions - Construct the list of actions to perform for the
396 /// given arguments, which are only done for a single architecture.
397 ///
398 /// \param C - The compilation that is being built.
399 /// \param Args - The input arguments.
400 /// \param Actions - The list to store the resulting actions onto.
401 void BuildActions(Compilation &C, llvm::opt::DerivedArgList &Args,
402 const InputList &Inputs, ActionList &Actions) const;
403
404 /// BuildUniversalActions - Construct the list of actions to perform
405 /// for the given arguments, which may require a universal build.
406 ///
407 /// \param C - The compilation that is being built.
408 /// \param TC - The default host tool chain.
409 void BuildUniversalActions(Compilation &C, const ToolChain &TC,
410 const InputList &BAInputs) const;
411
412 /// Check that the file referenced by Value exists. If it doesn't,
413 /// issue a diagnostic and return false.
414 /// If TypoCorrect is true and the file does not exist, see if it looks
415 /// like a likely typo for a flag and if so print a "did you mean" blurb.
416 bool DiagnoseInputExistence(const llvm::opt::DerivedArgList &Args,
417 StringRef Value, types::ID Ty,
418 bool TypoCorrect) const;
419
420 /// BuildJobs - Bind actions to concrete tools and translate
421 /// arguments to form the list of jobs to run.
422 ///
423 /// \param C - The compilation that is being built.
424 void BuildJobs(Compilation &C) const;
425
426 /// ExecuteCompilation - Execute the compilation according to the command line
427 /// arguments and return an appropriate exit code.
428 ///
429 /// This routine handles additional processing that must be done in addition
430 /// to just running the subprocesses, for example reporting errors, setting
431 /// up response files, removing temporary files, etc.
432 int ExecuteCompilation(Compilation &C,
433 SmallVectorImpl< std::pair<int, const Command *> > &FailingCommands);
434
435 /// Contains the files in the compilation diagnostic report generated by
436 /// generateCompilationDiagnostics.
437 struct CompilationDiagnosticReport {
438 llvm::SmallVector<std::string, 4> TemporaryFiles;
439 };
440
441 /// generateCompilationDiagnostics - Generate diagnostics information
442 /// including preprocessed source file(s).
443 ///
444 void generateCompilationDiagnostics(
445 Compilation &C, const Command &FailingCommand,
446 StringRef AdditionalInformation = "",
447 CompilationDiagnosticReport *GeneratedReport = nullptr);
448
449 /// @}
450 /// @name Helper Methods
451 /// @{
452
453 /// PrintActions - Print the list of actions.
454 void PrintActions(const Compilation &C) const;
455
456 /// PrintHelp - Print the help text.
457 ///
458 /// \param ShowHidden - Show hidden options.
459 void PrintHelp(bool ShowHidden) const;
460
461 /// PrintVersion - Print the driver version.
462 void PrintVersion(const Compilation &C, raw_ostream &OS) const;
463
464 /// GetFilePath - Lookup \p Name in the list of file search paths.
465 ///
466 /// \param TC - The tool chain for additional information on
467 /// directories to search.
468 //
469 // FIXME: This should be in CompilationInfo.
470 std::string GetFilePath(StringRef Name, const ToolChain &TC) const;
471
472 /// GetProgramPath - Lookup \p Name in the list of program search paths.
473 ///
474 /// \param TC - The provided tool chain for additional information on
475 /// directories to search.
476 //
477 // FIXME: This should be in CompilationInfo.
478 std::string GetProgramPath(StringRef Name, const ToolChain &TC) const;
479
480 /// HandleAutocompletions - Handle --autocomplete by searching and printing
481 /// possible flags, descriptions, and its arguments.
482 void HandleAutocompletions(StringRef PassedFlags) const;
483
484 /// HandleImmediateArgs - Handle any arguments which should be
485 /// treated before building actions or binding tools.
486 ///
487 /// \return Whether any compilation should be built for this
488 /// invocation.
489 bool HandleImmediateArgs(const Compilation &C);
490
491 /// ConstructAction - Construct the appropriate action to do for
492 /// \p Phase on the \p Input, taking in to account arguments
493 /// like -fsyntax-only or --analyze.
494 Action *ConstructPhaseAction(
495 Compilation &C, const llvm::opt::ArgList &Args, phases::ID Phase,
496 Action *Input,
497 Action::OffloadKind TargetDeviceOffloadKind = Action::OFK_None) const;
498
499 /// BuildJobsForAction - Construct the jobs to perform for the action \p A and
500 /// return an InputInfo for the result of running \p A. Will only construct
501 /// jobs for a given (Action, ToolChain, BoundArch, DeviceKind) tuple once.
502 InputInfo
503 BuildJobsForAction(Compilation &C, const Action *A, const ToolChain *TC,
504 StringRef BoundArch, bool AtTopLevel, bool MultipleArchs,
505 const char *LinkingOutput,
506 std::map<std::pair<const Action *, std::string>, InputInfo>
507 &CachedResults,
508 Action::OffloadKind TargetDeviceOffloadKind) const;
509
510 /// Returns the default name for linked images (e.g., "a.out").
511 const char *getDefaultImageName() const;
512
513 /// GetNamedOutputPath - Return the name to use for the output of
514 /// the action \p JA. The result is appended to the compilation's
515 /// list of temporary or result files, as appropriate.
516 ///
517 /// \param C - The compilation.
518 /// \param JA - The action of interest.
519 /// \param BaseInput - The original input file that this action was
520 /// triggered by.
521 /// \param BoundArch - The bound architecture.
522 /// \param AtTopLevel - Whether this is a "top-level" action.
523 /// \param MultipleArchs - Whether multiple -arch options were supplied.
524 /// \param NormalizedTriple - The normalized triple of the relevant target.
525 const char *GetNamedOutputPath(Compilation &C, const JobAction &JA,
526 const char *BaseInput, StringRef BoundArch,
527 bool AtTopLevel, bool MultipleArchs,
528 StringRef NormalizedTriple) const;
529
530 /// GetTemporaryPath - Return the pathname of a temporary file to use
531 /// as part of compilation; the file will have the given prefix and suffix.
532 ///
533 /// GCC goes to extra lengths here to be a bit more robust.
534 std::string GetTemporaryPath(StringRef Prefix, StringRef Suffix) const;
535
536 /// GetTemporaryDirectory - Return the pathname of a temporary directory to
537 /// use as part of compilation; the directory will have the given prefix.
538 std::string GetTemporaryDirectory(StringRef Prefix) const;
539
540 /// Return the pathname of the pch file in clang-cl mode.
541 std::string GetClPchPath(Compilation &C, StringRef BaseName) const;
542
543 /// ShouldUseClangCompiler - Should the clang compiler be used to
544 /// handle this action.
545 bool ShouldUseClangCompiler(const JobAction &JA) const;
546
547 /// ShouldUseFlangCompiler - Should the flang compiler be used to
548 /// handle this action.
549 bool ShouldUseFlangCompiler(const JobAction &JA) const;
550
551 /// Returns true if we are performing any kind of LTO.
552 bool isUsingLTO() const { return LTOMode != LTOK_None; }
553
554 /// Get the specific kind of LTO being performed.
555 LTOKind getLTOMode() const { return LTOMode; }
556
557private:
558
559 /// Tries to load options from configuration file.
560 ///
561 /// \returns true if error occurred.
562 bool loadConfigFile();
563
564 /// Read options from the specified file.
565 ///
566 /// \param [in] FileName File to read.
567 /// \returns true, if error occurred while reading.
568 bool readConfigFile(StringRef FileName);
569
570 /// Set the driver mode (cl, gcc, etc) from an option string of the form
571 /// --driver-mode=<mode>.
572 void setDriverModeFromOption(StringRef Opt);
573
574 /// Parse the \p Args list for LTO options and record the type of LTO
575 /// compilation based on which -f(no-)?lto(=.*)? option occurs last.
576 void setLTOMode(const llvm::opt::ArgList &Args);
577
578 /// Retrieves a ToolChain for a particular \p Target triple.
579 ///
580 /// Will cache ToolChains for the life of the driver object, and create them
581 /// on-demand.
582 const ToolChain &getToolChain(const llvm::opt::ArgList &Args,
583 const llvm::Triple &Target) const;
584
585 /// @}
586
587 /// Get bitmasks for which option flags to include and exclude based on
588 /// the driver mode.
589 std::pair<unsigned, unsigned> getIncludeExcludeOptionFlagMasks(bool IsClCompatMode) const;
590
591 /// Helper used in BuildJobsForAction. Doesn't use the cache when building
592 /// jobs specifically for the given action, but will use the cache when
593 /// building jobs for the Action's inputs.
594 InputInfo BuildJobsForActionNoCache(
595 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
596 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
597 std::map<std::pair<const Action *, std::string>, InputInfo>
598 &CachedResults,
599 Action::OffloadKind TargetDeviceOffloadKind) const;
600
601public:
602 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and
603 /// return the grouped values as integers. Numbers which are not
604 /// provided are set to 0.
605 ///
606 /// \return True if the entire string was parsed (9.2), or all
607 /// groups were parsed (10.3.5extrastuff). HadExtra is true if all
608 /// groups were parsed but extra characters remain at the end.
609 static bool GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
610 unsigned &Micro, bool &HadExtra);
611
612 /// Parse digits from a string \p Str and fulfill \p Digits with
613 /// the parsed numbers. This method assumes that the max number of
614 /// digits to look for is equal to Digits.size().
615 ///
616 /// \return True if the entire string was parsed and there are
617 /// no extra characters remaining at the end.
618 static bool GetReleaseVersion(StringRef Str,
619 MutableArrayRef<unsigned> Digits);
620 /// Compute the default -fmodule-cache-path.
621 static void getDefaultModuleCachePath(SmallVectorImpl<char> &Result);
622};
623
624/// \return True if the last defined optimization level is -Ofast.
625/// And False otherwise.
626bool isOptimizationLevelFast(const llvm::opt::ArgList &Args);
627
628/// \return True if the argument combination will end up generating remarks.
629bool willEmitRemarks(const llvm::opt::ArgList &Args);
630
631} // end namespace driver
632} // end namespace clang
633
634#endif

/build/llvm-toolchain-snapshot-11~++20200309111110+2c36c23f347/llvm/include/llvm/ADT/Twine.h

1//===- Twine.h - Fast Temporary String Concatenation ------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6