1 //===- ToolChain.cpp - Collections of tools for one platform --------------===//
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/ToolChain.h"
10 #include "ToolChains/Arch/ARM.h"
11 #include "ToolChains/Clang.h"
12 #include "ToolChains/Flang.h"
13 #include "ToolChains/InterfaceStubs.h"
14 #include "clang/Basic/ObjCRuntime.h"
15 #include "clang/Basic/Sanitizers.h"
16 #include "clang/Config/config.h"
17 #include "clang/Driver/Action.h"
18 #include "clang/Driver/Driver.h"
19 #include "clang/Driver/DriverDiagnostic.h"
20 #include "clang/Driver/InputInfo.h"
21 #include "clang/Driver/Job.h"
22 #include "clang/Driver/Options.h"
23 #include "clang/Driver/SanitizerArgs.h"
24 #include "clang/Driver/XRayArgs.h"
25 #include "llvm/ADT/STLExtras.h"
26 #include "llvm/ADT/SmallString.h"
27 #include "llvm/ADT/StringRef.h"
28 #include "llvm/ADT/Triple.h"
29 #include "llvm/ADT/Twine.h"
30 #include "llvm/Config/llvm-config.h"
31 #include "llvm/MC/MCTargetOptions.h"
32 #include "llvm/MC/TargetRegistry.h"
33 #include "llvm/Option/Arg.h"
34 #include "llvm/Option/ArgList.h"
35 #include "llvm/Option/OptTable.h"
36 #include "llvm/Option/Option.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/FileSystem.h"
39 #include "llvm/Support/Path.h"
40 #include "llvm/Support/TargetParser.h"
41 #include "llvm/Support/VersionTuple.h"
42 #include "llvm/Support/VirtualFileSystem.h"
43 #include <cassert>
44 #include <cstddef>
45 #include <cstring>
46 #include <string>
47
48 using namespace clang;
49 using namespace driver;
50 using namespace tools;
51 using namespace llvm;
52 using namespace llvm::opt;
53
GetRTTIArgument(const ArgList & Args)54 static llvm::opt::Arg *GetRTTIArgument(const ArgList &Args) {
55 return Args.getLastArg(options::OPT_mkernel, options::OPT_fapple_kext,
56 options::OPT_fno_rtti, options::OPT_frtti);
57 }
58
CalculateRTTIMode(const ArgList & Args,const llvm::Triple & Triple,const Arg * CachedRTTIArg)59 static ToolChain::RTTIMode CalculateRTTIMode(const ArgList &Args,
60 const llvm::Triple &Triple,
61 const Arg *CachedRTTIArg) {
62 // Explicit rtti/no-rtti args
63 if (CachedRTTIArg) {
64 if (CachedRTTIArg->getOption().matches(options::OPT_frtti))
65 return ToolChain::RM_Enabled;
66 else
67 return ToolChain::RM_Disabled;
68 }
69
70 // -frtti is default, except for the PS4 CPU.
71 return (Triple.isPS4CPU()) ? ToolChain::RM_Disabled : ToolChain::RM_Enabled;
72 }
73
ToolChain(const Driver & D,const llvm::Triple & T,const ArgList & Args)74 ToolChain::ToolChain(const Driver &D, const llvm::Triple &T,
75 const ArgList &Args)
76 : D(D), Triple(T), Args(Args), CachedRTTIArg(GetRTTIArgument(Args)),
77 CachedRTTIMode(CalculateRTTIMode(Args, Triple, CachedRTTIArg)) {
78 std::string RuntimePath = getRuntimePath();
79 if (getVFS().exists(RuntimePath))
80 getLibraryPaths().push_back(RuntimePath);
81
82 std::string StdlibPath = getStdlibPath();
83 if (getVFS().exists(StdlibPath))
84 getFilePaths().push_back(StdlibPath);
85
86 std::string CandidateLibPath = getArchSpecificLibPath();
87 if (getVFS().exists(CandidateLibPath))
88 getFilePaths().push_back(CandidateLibPath);
89 }
90
setTripleEnvironment(llvm::Triple::EnvironmentType Env)91 void ToolChain::setTripleEnvironment(llvm::Triple::EnvironmentType Env) {
92 Triple.setEnvironment(Env);
93 if (EffectiveTriple != llvm::Triple())
94 EffectiveTriple.setEnvironment(Env);
95 }
96
97 ToolChain::~ToolChain() = default;
98
getVFS() const99 llvm::vfs::FileSystem &ToolChain::getVFS() const {
100 return getDriver().getVFS();
101 }
102
useIntegratedAs() const103 bool ToolChain::useIntegratedAs() const {
104 return Args.hasFlag(options::OPT_fintegrated_as,
105 options::OPT_fno_integrated_as,
106 IsIntegratedAssemblerDefault());
107 }
108
useRelaxRelocations() const109 bool ToolChain::useRelaxRelocations() const {
110 return ENABLE_X86_RELAX_RELOCATIONS;
111 }
112
isNoExecStackDefault() const113 bool ToolChain::isNoExecStackDefault() const {
114 return false;
115 }
116
getSanitizerArgs() const117 const SanitizerArgs& ToolChain::getSanitizerArgs() const {
118 if (!SanitizerArguments.get())
119 SanitizerArguments.reset(new SanitizerArgs(*this, Args));
120 return *SanitizerArguments.get();
121 }
122
getXRayArgs() const123 const XRayArgs& ToolChain::getXRayArgs() const {
124 if (!XRayArguments.get())
125 XRayArguments.reset(new XRayArgs(*this, Args));
126 return *XRayArguments.get();
127 }
128
129 namespace {
130
131 struct DriverSuffix {
132 const char *Suffix;
133 const char *ModeFlag;
134 };
135
136 } // namespace
137
FindDriverSuffix(StringRef ProgName,size_t & Pos)138 static const DriverSuffix *FindDriverSuffix(StringRef ProgName, size_t &Pos) {
139 // A list of known driver suffixes. Suffixes are compared against the
140 // program name in order. If there is a match, the frontend type is updated as
141 // necessary by applying the ModeFlag.
142 static const DriverSuffix DriverSuffixes[] = {
143 {"clang", nullptr},
144 {"clang++", "--driver-mode=g++"},
145 {"clang-c++", "--driver-mode=g++"},
146 {"clang-cc", nullptr},
147 {"clang-cpp", "--driver-mode=cpp"},
148 {"clang-g++", "--driver-mode=g++"},
149 {"clang-gcc", nullptr},
150 {"clang-cl", "--driver-mode=cl"},
151 {"cc", nullptr},
152 {"cpp", "--driver-mode=cpp"},
153 {"cl", "--driver-mode=cl"},
154 {"++", "--driver-mode=g++"},
155 {"flang", "--driver-mode=flang"},
156 };
157
158 for (size_t i = 0; i < llvm::array_lengthof(DriverSuffixes); ++i) {
159 StringRef Suffix(DriverSuffixes[i].Suffix);
160 if (ProgName.endswith(Suffix)) {
161 Pos = ProgName.size() - Suffix.size();
162 return &DriverSuffixes[i];
163 }
164 }
165 return nullptr;
166 }
167
168 /// Normalize the program name from argv[0] by stripping the file extension if
169 /// present and lower-casing the string on Windows.
normalizeProgramName(llvm::StringRef Argv0)170 static std::string normalizeProgramName(llvm::StringRef Argv0) {
171 std::string ProgName = std::string(llvm::sys::path::stem(Argv0));
172 #ifdef _WIN32
173 // Transform to lowercase for case insensitive file systems.
174 std::transform(ProgName.begin(), ProgName.end(), ProgName.begin(), ::tolower);
175 #endif
176 return ProgName;
177 }
178
parseDriverSuffix(StringRef ProgName,size_t & Pos)179 static const DriverSuffix *parseDriverSuffix(StringRef ProgName, size_t &Pos) {
180 // Try to infer frontend type and default target from the program name by
181 // comparing it against DriverSuffixes in order.
182
183 // If there is a match, the function tries to identify a target as prefix.
184 // E.g. "x86_64-linux-clang" as interpreted as suffix "clang" with target
185 // prefix "x86_64-linux". If such a target prefix is found, it may be
186 // added via -target as implicit first argument.
187 const DriverSuffix *DS = FindDriverSuffix(ProgName, Pos);
188
189 if (!DS) {
190 // Try again after stripping any trailing version number:
191 // clang++3.5 -> clang++
192 ProgName = ProgName.rtrim("0123456789.");
193 DS = FindDriverSuffix(ProgName, Pos);
194 }
195
196 if (!DS) {
197 // Try again after stripping trailing -component.
198 // clang++-tot -> clang++
199 ProgName = ProgName.slice(0, ProgName.rfind('-'));
200 DS = FindDriverSuffix(ProgName, Pos);
201 }
202 return DS;
203 }
204
205 ParsedClangName
getTargetAndModeFromProgramName(StringRef PN)206 ToolChain::getTargetAndModeFromProgramName(StringRef PN) {
207 std::string ProgName = normalizeProgramName(PN);
208 size_t SuffixPos;
209 const DriverSuffix *DS = parseDriverSuffix(ProgName, SuffixPos);
210 if (!DS)
211 return {};
212 size_t SuffixEnd = SuffixPos + strlen(DS->Suffix);
213
214 size_t LastComponent = ProgName.rfind('-', SuffixPos);
215 if (LastComponent == std::string::npos)
216 return ParsedClangName(ProgName.substr(0, SuffixEnd), DS->ModeFlag);
217 std::string ModeSuffix = ProgName.substr(LastComponent + 1,
218 SuffixEnd - LastComponent - 1);
219
220 // Infer target from the prefix.
221 StringRef Prefix(ProgName);
222 Prefix = Prefix.slice(0, LastComponent);
223 std::string IgnoredError;
224 bool IsRegistered =
225 llvm::TargetRegistry::lookupTarget(std::string(Prefix), IgnoredError);
226 return ParsedClangName{std::string(Prefix), ModeSuffix, DS->ModeFlag,
227 IsRegistered};
228 }
229
getDefaultUniversalArchName() const230 StringRef ToolChain::getDefaultUniversalArchName() const {
231 // In universal driver terms, the arch name accepted by -arch isn't exactly
232 // the same as the ones that appear in the triple. Roughly speaking, this is
233 // an inverse of the darwin::getArchTypeForDarwinArchName() function.
234 switch (Triple.getArch()) {
235 case llvm::Triple::aarch64: {
236 if (getTriple().isArm64e())
237 return "arm64e";
238 return "arm64";
239 }
240 case llvm::Triple::aarch64_32:
241 return "arm64_32";
242 case llvm::Triple::ppc:
243 return "ppc";
244 case llvm::Triple::ppcle:
245 return "ppcle";
246 case llvm::Triple::ppc64:
247 return "ppc64";
248 case llvm::Triple::ppc64le:
249 return "ppc64le";
250 default:
251 return Triple.getArchName();
252 }
253 }
254
getInputFilename(const InputInfo & Input) const255 std::string ToolChain::getInputFilename(const InputInfo &Input) const {
256 return Input.getFilename();
257 }
258
IsUnwindTablesDefault(const ArgList & Args) const259 bool ToolChain::IsUnwindTablesDefault(const ArgList &Args) const {
260 return false;
261 }
262
getClang() const263 Tool *ToolChain::getClang() const {
264 if (!Clang)
265 Clang.reset(new tools::Clang(*this));
266 return Clang.get();
267 }
268
getFlang() const269 Tool *ToolChain::getFlang() const {
270 if (!Flang)
271 Flang.reset(new tools::Flang(*this));
272 return Flang.get();
273 }
274
buildAssembler() const275 Tool *ToolChain::buildAssembler() const {
276 return new tools::ClangAs(*this);
277 }
278
buildLinker() const279 Tool *ToolChain::buildLinker() const {
280 llvm_unreachable("Linking is not supported by this toolchain");
281 }
282
buildStaticLibTool() const283 Tool *ToolChain::buildStaticLibTool() const {
284 llvm_unreachable("Creating static lib is not supported by this toolchain");
285 }
286
getAssemble() const287 Tool *ToolChain::getAssemble() const {
288 if (!Assemble)
289 Assemble.reset(buildAssembler());
290 return Assemble.get();
291 }
292
getClangAs() const293 Tool *ToolChain::getClangAs() const {
294 if (!Assemble)
295 Assemble.reset(new tools::ClangAs(*this));
296 return Assemble.get();
297 }
298
getLink() const299 Tool *ToolChain::getLink() const {
300 if (!Link)
301 Link.reset(buildLinker());
302 return Link.get();
303 }
304
getStaticLibTool() const305 Tool *ToolChain::getStaticLibTool() const {
306 if (!StaticLibTool)
307 StaticLibTool.reset(buildStaticLibTool());
308 return StaticLibTool.get();
309 }
310
getIfsMerge() const311 Tool *ToolChain::getIfsMerge() const {
312 if (!IfsMerge)
313 IfsMerge.reset(new tools::ifstool::Merger(*this));
314 return IfsMerge.get();
315 }
316
getOffloadBundler() const317 Tool *ToolChain::getOffloadBundler() const {
318 if (!OffloadBundler)
319 OffloadBundler.reset(new tools::OffloadBundler(*this));
320 return OffloadBundler.get();
321 }
322
getOffloadWrapper() const323 Tool *ToolChain::getOffloadWrapper() const {
324 if (!OffloadWrapper)
325 OffloadWrapper.reset(new tools::OffloadWrapper(*this));
326 return OffloadWrapper.get();
327 }
328
getTool(Action::ActionClass AC) const329 Tool *ToolChain::getTool(Action::ActionClass AC) const {
330 switch (AC) {
331 case Action::AssembleJobClass:
332 return getAssemble();
333
334 case Action::IfsMergeJobClass:
335 return getIfsMerge();
336
337 case Action::LinkJobClass:
338 return getLink();
339
340 case Action::StaticLibJobClass:
341 return getStaticLibTool();
342
343 case Action::InputClass:
344 case Action::BindArchClass:
345 case Action::OffloadClass:
346 case Action::LipoJobClass:
347 case Action::DsymutilJobClass:
348 case Action::VerifyDebugInfoJobClass:
349 llvm_unreachable("Invalid tool kind.");
350
351 case Action::CompileJobClass:
352 case Action::PrecompileJobClass:
353 case Action::HeaderModulePrecompileJobClass:
354 case Action::PreprocessJobClass:
355 case Action::AnalyzeJobClass:
356 case Action::MigrateJobClass:
357 case Action::VerifyPCHJobClass:
358 case Action::BackendJobClass:
359 return getClang();
360
361 case Action::OffloadBundlingJobClass:
362 case Action::OffloadUnbundlingJobClass:
363 return getOffloadBundler();
364
365 case Action::OffloadWrapperJobClass:
366 return getOffloadWrapper();
367 }
368
369 llvm_unreachable("Invalid tool kind.");
370 }
371
getArchNameForCompilerRTLib(const ToolChain & TC,const ArgList & Args)372 static StringRef getArchNameForCompilerRTLib(const ToolChain &TC,
373 const ArgList &Args) {
374 const llvm::Triple &Triple = TC.getTriple();
375 bool IsWindows = Triple.isOSWindows();
376
377 if (TC.getArch() == llvm::Triple::arm || TC.getArch() == llvm::Triple::armeb)
378 return (arm::getARMFloatABI(TC, Args) == arm::FloatABI::Hard && !IsWindows)
379 ? "armhf"
380 : "arm";
381
382 // For historic reasons, Android library is using i686 instead of i386.
383 if (TC.getArch() == llvm::Triple::x86 && Triple.isAndroid())
384 return "i686";
385
386 if (TC.getArch() == llvm::Triple::x86_64 && Triple.isX32())
387 return "x32";
388
389 return llvm::Triple::getArchTypeName(TC.getArch());
390 }
391
getOSLibName() const392 StringRef ToolChain::getOSLibName() const {
393 if (Triple.isOSDarwin())
394 return "darwin";
395
396 switch (Triple.getOS()) {
397 case llvm::Triple::FreeBSD:
398 return "freebsd";
399 case llvm::Triple::NetBSD:
400 return "netbsd";
401 case llvm::Triple::OpenBSD:
402 return "openbsd";
403 case llvm::Triple::Solaris:
404 return "sunos";
405 case llvm::Triple::AIX:
406 return "aix";
407 default:
408 return getOS();
409 }
410 }
411
getCompilerRTPath() const412 std::string ToolChain::getCompilerRTPath() const {
413 SmallString<128> Path(getDriver().ResourceDir);
414 if (Triple.isOSUnknown()) {
415 llvm::sys::path::append(Path, "lib");
416 } else {
417 llvm::sys::path::append(Path, "lib", getOSLibName());
418 }
419 return std::string(Path.str());
420 }
421
getCompilerRTBasename(const ArgList & Args,StringRef Component,FileType Type) const422 std::string ToolChain::getCompilerRTBasename(const ArgList &Args,
423 StringRef Component,
424 FileType Type) const {
425 std::string CRTAbsolutePath = getCompilerRT(Args, Component, Type);
426 return llvm::sys::path::filename(CRTAbsolutePath).str();
427 }
428
buildCompilerRTBasename(const llvm::opt::ArgList & Args,StringRef Component,FileType Type,bool AddArch) const429 std::string ToolChain::buildCompilerRTBasename(const llvm::opt::ArgList &Args,
430 StringRef Component,
431 FileType Type,
432 bool AddArch) const {
433 const llvm::Triple &TT = getTriple();
434 bool IsITANMSVCWindows =
435 TT.isWindowsMSVCEnvironment() || TT.isWindowsItaniumEnvironment();
436
437 const char *Prefix =
438 IsITANMSVCWindows || Type == ToolChain::FT_Object ? "" : "lib";
439 const char *Suffix;
440 switch (Type) {
441 case ToolChain::FT_Object:
442 Suffix = IsITANMSVCWindows ? ".obj" : ".o";
443 break;
444 case ToolChain::FT_Static:
445 Suffix = IsITANMSVCWindows ? ".lib" : ".a";
446 break;
447 case ToolChain::FT_Shared:
448 Suffix = TT.isOSWindows()
449 ? (TT.isWindowsGNUEnvironment() ? ".dll.a" : ".lib")
450 : ".so";
451 break;
452 }
453
454 std::string ArchAndEnv;
455 if (AddArch) {
456 StringRef Arch = getArchNameForCompilerRTLib(*this, Args);
457 const char *Env = TT.isAndroid() ? "-android" : "";
458 ArchAndEnv = ("-" + Arch + Env).str();
459 }
460 return (Prefix + Twine("clang_rt.") + Component + ArchAndEnv + Suffix).str();
461 }
462
getCompilerRT(const ArgList & Args,StringRef Component,FileType Type) const463 std::string ToolChain::getCompilerRT(const ArgList &Args, StringRef Component,
464 FileType Type) const {
465 // Check for runtime files in the new layout without the architecture first.
466 std::string CRTBasename =
467 buildCompilerRTBasename(Args, Component, Type, /*AddArch=*/false);
468 for (const auto &LibPath : getLibraryPaths()) {
469 SmallString<128> P(LibPath);
470 llvm::sys::path::append(P, CRTBasename);
471 if (getVFS().exists(P))
472 return std::string(P.str());
473 }
474
475 // Fall back to the old expected compiler-rt name if the new one does not
476 // exist.
477 CRTBasename =
478 buildCompilerRTBasename(Args, Component, Type, /*AddArch=*/true);
479 SmallString<128> Path(getCompilerRTPath());
480 llvm::sys::path::append(Path, CRTBasename);
481 return std::string(Path.str());
482 }
483
getCompilerRTArgString(const llvm::opt::ArgList & Args,StringRef Component,FileType Type) const484 const char *ToolChain::getCompilerRTArgString(const llvm::opt::ArgList &Args,
485 StringRef Component,
486 FileType Type) const {
487 return Args.MakeArgString(getCompilerRT(Args, Component, Type));
488 }
489
getRuntimePath() const490 std::string ToolChain::getRuntimePath() const {
491 SmallString<128> P(D.ResourceDir);
492 llvm::sys::path::append(P, "lib", getTripleString());
493 return std::string(P.str());
494 }
495
getStdlibPath() const496 std::string ToolChain::getStdlibPath() const {
497 SmallString<128> P(D.Dir);
498 llvm::sys::path::append(P, "..", "lib", getTripleString());
499 return std::string(P.str());
500 }
501
getArchSpecificLibPath() const502 std::string ToolChain::getArchSpecificLibPath() const {
503 SmallString<128> Path(getDriver().ResourceDir);
504 llvm::sys::path::append(Path, "lib", getOSLibName(),
505 llvm::Triple::getArchTypeName(getArch()));
506 return std::string(Path.str());
507 }
508
needsProfileRT(const ArgList & Args)509 bool ToolChain::needsProfileRT(const ArgList &Args) {
510 if (Args.hasArg(options::OPT_noprofilelib))
511 return false;
512
513 return Args.hasArg(options::OPT_fprofile_generate) ||
514 Args.hasArg(options::OPT_fprofile_generate_EQ) ||
515 Args.hasArg(options::OPT_fcs_profile_generate) ||
516 Args.hasArg(options::OPT_fcs_profile_generate_EQ) ||
517 Args.hasArg(options::OPT_fprofile_instr_generate) ||
518 Args.hasArg(options::OPT_fprofile_instr_generate_EQ) ||
519 Args.hasArg(options::OPT_fcreate_profile) ||
520 Args.hasArg(options::OPT_forder_file_instrumentation);
521 }
522
needsGCovInstrumentation(const llvm::opt::ArgList & Args)523 bool ToolChain::needsGCovInstrumentation(const llvm::opt::ArgList &Args) {
524 return Args.hasArg(options::OPT_coverage) ||
525 Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
526 false);
527 }
528
SelectTool(const JobAction & JA) const529 Tool *ToolChain::SelectTool(const JobAction &JA) const {
530 if (D.IsFlangMode() && getDriver().ShouldUseFlangCompiler(JA)) return getFlang();
531 if (getDriver().ShouldUseClangCompiler(JA)) return getClang();
532 Action::ActionClass AC = JA.getKind();
533 if (AC == Action::AssembleJobClass && useIntegratedAs())
534 return getClangAs();
535 return getTool(AC);
536 }
537
GetFilePath(const char * Name) const538 std::string ToolChain::GetFilePath(const char *Name) const {
539 return D.GetFilePath(Name, *this);
540 }
541
GetProgramPath(const char * Name) const542 std::string ToolChain::GetProgramPath(const char *Name) const {
543 return D.GetProgramPath(Name, *this);
544 }
545
GetLinkerPath(bool * LinkerIsLLD,bool * LinkerIsLLDDarwinNew) const546 std::string ToolChain::GetLinkerPath(bool *LinkerIsLLD,
547 bool *LinkerIsLLDDarwinNew) const {
548 if (LinkerIsLLD)
549 *LinkerIsLLD = false;
550 if (LinkerIsLLDDarwinNew)
551 *LinkerIsLLDDarwinNew = false;
552
553 // Get -fuse-ld= first to prevent -Wunused-command-line-argument. -fuse-ld= is
554 // considered as the linker flavor, e.g. "bfd", "gold", or "lld".
555 const Arg* A = Args.getLastArg(options::OPT_fuse_ld_EQ);
556 StringRef UseLinker = A ? A->getValue() : CLANG_DEFAULT_LINKER;
557
558 // --ld-path= takes precedence over -fuse-ld= and specifies the executable
559 // name. -B, COMPILER_PATH and PATH and consulted if the value does not
560 // contain a path component separator.
561 if (const Arg *A = Args.getLastArg(options::OPT_ld_path_EQ)) {
562 std::string Path(A->getValue());
563 if (!Path.empty()) {
564 if (llvm::sys::path::parent_path(Path).empty())
565 Path = GetProgramPath(A->getValue());
566 if (llvm::sys::fs::can_execute(Path))
567 return std::string(Path);
568 }
569 getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
570 return GetProgramPath(getDefaultLinker());
571 }
572 // If we're passed -fuse-ld= with no argument, or with the argument ld,
573 // then use whatever the default system linker is.
574 if (UseLinker.empty() || UseLinker == "ld") {
575 const char *DefaultLinker = getDefaultLinker();
576 if (llvm::sys::path::is_absolute(DefaultLinker))
577 return std::string(DefaultLinker);
578 else
579 return GetProgramPath(DefaultLinker);
580 }
581
582 // Extending -fuse-ld= to an absolute or relative path is unexpected. Checking
583 // for the linker flavor is brittle. In addition, prepending "ld." or "ld64."
584 // to a relative path is surprising. This is more complex due to priorities
585 // among -B, COMPILER_PATH and PATH. --ld-path= should be used instead.
586 if (UseLinker.find('/') != StringRef::npos)
587 getDriver().Diag(diag::warn_drv_fuse_ld_path);
588
589 if (llvm::sys::path::is_absolute(UseLinker)) {
590 // If we're passed what looks like an absolute path, don't attempt to
591 // second-guess that.
592 if (llvm::sys::fs::can_execute(UseLinker))
593 return std::string(UseLinker);
594 } else {
595 llvm::SmallString<8> LinkerName;
596 if (Triple.isOSDarwin())
597 LinkerName.append("ld64.");
598 else
599 LinkerName.append("ld.");
600 LinkerName.append(UseLinker);
601
602 std::string LinkerPath(GetProgramPath(LinkerName.c_str()));
603 if (llvm::sys::fs::can_execute(LinkerPath)) {
604 // FIXME: Remove LinkerIsLLDDarwinNew once there's only one MachO lld.
605 if (LinkerIsLLD)
606 *LinkerIsLLD = UseLinker == "lld" || UseLinker == "lld.darwinold";
607 if (LinkerIsLLDDarwinNew)
608 *LinkerIsLLDDarwinNew = UseLinker == "lld";
609 return LinkerPath;
610 }
611 }
612
613 if (A)
614 getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
615
616 return GetProgramPath(getDefaultLinker());
617 }
618
GetStaticLibToolPath() const619 std::string ToolChain::GetStaticLibToolPath() const {
620 // TODO: Add support for static lib archiving on Windows
621 if (Triple.isOSDarwin())
622 return GetProgramPath("libtool");
623 return GetProgramPath("llvm-ar");
624 }
625
LookupTypeForExtension(StringRef Ext) const626 types::ID ToolChain::LookupTypeForExtension(StringRef Ext) const {
627 types::ID id = types::lookupTypeForExtension(Ext);
628
629 // Flang always runs the preprocessor and has no notion of "preprocessed
630 // fortran". Here, TY_PP_Fortran is coerced to TY_Fortran to avoid treating
631 // them differently.
632 if (D.IsFlangMode() && id == types::TY_PP_Fortran)
633 id = types::TY_Fortran;
634
635 return id;
636 }
637
HasNativeLLVMSupport() const638 bool ToolChain::HasNativeLLVMSupport() const {
639 return false;
640 }
641
isCrossCompiling() const642 bool ToolChain::isCrossCompiling() const {
643 llvm::Triple HostTriple(LLVM_HOST_TRIPLE);
644 switch (HostTriple.getArch()) {
645 // The A32/T32/T16 instruction sets are not separate architectures in this
646 // context.
647 case llvm::Triple::arm:
648 case llvm::Triple::armeb:
649 case llvm::Triple::thumb:
650 case llvm::Triple::thumbeb:
651 return getArch() != llvm::Triple::arm && getArch() != llvm::Triple::thumb &&
652 getArch() != llvm::Triple::armeb && getArch() != llvm::Triple::thumbeb;
653 default:
654 return HostTriple.getArch() != getArch();
655 }
656 }
657
getDefaultObjCRuntime(bool isNonFragile) const658 ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
659 return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
660 VersionTuple());
661 }
662
663 llvm::ExceptionHandling
GetExceptionModel(const llvm::opt::ArgList & Args) const664 ToolChain::GetExceptionModel(const llvm::opt::ArgList &Args) const {
665 return llvm::ExceptionHandling::None;
666 }
667
isThreadModelSupported(const StringRef Model) const668 bool ToolChain::isThreadModelSupported(const StringRef Model) const {
669 if (Model == "single") {
670 // FIXME: 'single' is only supported on ARM and WebAssembly so far.
671 return Triple.getArch() == llvm::Triple::arm ||
672 Triple.getArch() == llvm::Triple::armeb ||
673 Triple.getArch() == llvm::Triple::thumb ||
674 Triple.getArch() == llvm::Triple::thumbeb || Triple.isWasm();
675 } else if (Model == "posix")
676 return true;
677
678 return false;
679 }
680
ComputeLLVMTriple(const ArgList & Args,types::ID InputType) const681 std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
682 types::ID InputType) const {
683 switch (getTriple().getArch()) {
684 default:
685 return getTripleString();
686
687 case llvm::Triple::x86_64: {
688 llvm::Triple Triple = getTriple();
689 if (!Triple.isOSBinFormatMachO())
690 return getTripleString();
691
692 if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
693 // x86_64h goes in the triple. Other -march options just use the
694 // vanilla triple we already have.
695 StringRef MArch = A->getValue();
696 if (MArch == "x86_64h")
697 Triple.setArchName(MArch);
698 }
699 return Triple.getTriple();
700 }
701 case llvm::Triple::aarch64: {
702 llvm::Triple Triple = getTriple();
703 if (!Triple.isOSBinFormatMachO())
704 return getTripleString();
705
706 if (Triple.isArm64e())
707 return getTripleString();
708
709 // FIXME: older versions of ld64 expect the "arm64" component in the actual
710 // triple string and query it to determine whether an LTO file can be
711 // handled. Remove this when we don't care any more.
712 Triple.setArchName("arm64");
713 return Triple.getTriple();
714 }
715 case llvm::Triple::aarch64_32:
716 return getTripleString();
717 case llvm::Triple::arm:
718 case llvm::Triple::armeb:
719 case llvm::Triple::thumb:
720 case llvm::Triple::thumbeb: {
721 llvm::Triple Triple = getTriple();
722 tools::arm::setArchNameInTriple(getDriver(), Args, InputType, Triple);
723 tools::arm::setFloatABIInTriple(getDriver(), Args, Triple);
724 return Triple.getTriple();
725 }
726 }
727 }
728
ComputeEffectiveClangTriple(const ArgList & Args,types::ID InputType) const729 std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
730 types::ID InputType) const {
731 return ComputeLLVMTriple(Args, InputType);
732 }
733
computeSysRoot() const734 std::string ToolChain::computeSysRoot() const {
735 return D.SysRoot;
736 }
737
AddClangSystemIncludeArgs(const ArgList & DriverArgs,ArgStringList & CC1Args) const738 void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
739 ArgStringList &CC1Args) const {
740 // Each toolchain should provide the appropriate include flags.
741 }
742
addClangTargetOptions(const ArgList & DriverArgs,ArgStringList & CC1Args,Action::OffloadKind DeviceOffloadKind) const743 void ToolChain::addClangTargetOptions(
744 const ArgList &DriverArgs, ArgStringList &CC1Args,
745 Action::OffloadKind DeviceOffloadKind) const {}
746
addClangWarningOptions(ArgStringList & CC1Args) const747 void ToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {}
748
addProfileRTLibs(const llvm::opt::ArgList & Args,llvm::opt::ArgStringList & CmdArgs) const749 void ToolChain::addProfileRTLibs(const llvm::opt::ArgList &Args,
750 llvm::opt::ArgStringList &CmdArgs) const {
751 if (!needsProfileRT(Args) && !needsGCovInstrumentation(Args))
752 return;
753
754 CmdArgs.push_back(getCompilerRTArgString(Args, "profile"));
755 }
756
GetRuntimeLibType(const ArgList & Args) const757 ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
758 const ArgList &Args) const {
759 if (runtimeLibType)
760 return *runtimeLibType;
761
762 const Arg* A = Args.getLastArg(options::OPT_rtlib_EQ);
763 StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_RTLIB;
764
765 // Only use "platform" in tests to override CLANG_DEFAULT_RTLIB!
766 if (LibName == "compiler-rt")
767 runtimeLibType = ToolChain::RLT_CompilerRT;
768 else if (LibName == "libgcc")
769 runtimeLibType = ToolChain::RLT_Libgcc;
770 else if (LibName == "platform")
771 runtimeLibType = GetDefaultRuntimeLibType();
772 else {
773 if (A)
774 getDriver().Diag(diag::err_drv_invalid_rtlib_name)
775 << A->getAsString(Args);
776
777 runtimeLibType = GetDefaultRuntimeLibType();
778 }
779
780 return *runtimeLibType;
781 }
782
GetUnwindLibType(const ArgList & Args) const783 ToolChain::UnwindLibType ToolChain::GetUnwindLibType(
784 const ArgList &Args) const {
785 if (unwindLibType)
786 return *unwindLibType;
787
788 const Arg *A = Args.getLastArg(options::OPT_unwindlib_EQ);
789 StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_UNWINDLIB;
790
791 if (LibName == "none")
792 unwindLibType = ToolChain::UNW_None;
793 else if (LibName == "platform" || LibName == "") {
794 ToolChain::RuntimeLibType RtLibType = GetRuntimeLibType(Args);
795 if (RtLibType == ToolChain::RLT_CompilerRT) {
796 if (getTriple().isAndroid() || getTriple().isOSAIX())
797 unwindLibType = ToolChain::UNW_CompilerRT;
798 else
799 unwindLibType = ToolChain::UNW_None;
800 } else if (RtLibType == ToolChain::RLT_Libgcc)
801 unwindLibType = ToolChain::UNW_Libgcc;
802 } else if (LibName == "libunwind") {
803 if (GetRuntimeLibType(Args) == RLT_Libgcc)
804 getDriver().Diag(diag::err_drv_incompatible_unwindlib);
805 unwindLibType = ToolChain::UNW_CompilerRT;
806 } else if (LibName == "libgcc")
807 unwindLibType = ToolChain::UNW_Libgcc;
808 else {
809 if (A)
810 getDriver().Diag(diag::err_drv_invalid_unwindlib_name)
811 << A->getAsString(Args);
812
813 unwindLibType = GetDefaultUnwindLibType();
814 }
815
816 return *unwindLibType;
817 }
818
GetCXXStdlibType(const ArgList & Args) const819 ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
820 if (cxxStdlibType)
821 return *cxxStdlibType;
822
823 const Arg *A = Args.getLastArg(options::OPT_stdlib_EQ);
824 StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_CXX_STDLIB;
825
826 // Only use "platform" in tests to override CLANG_DEFAULT_CXX_STDLIB!
827 if (LibName == "libc++")
828 cxxStdlibType = ToolChain::CST_Libcxx;
829 else if (LibName == "libstdc++")
830 cxxStdlibType = ToolChain::CST_Libstdcxx;
831 else if (LibName == "platform")
832 cxxStdlibType = GetDefaultCXXStdlibType();
833 else {
834 if (A)
835 getDriver().Diag(diag::err_drv_invalid_stdlib_name)
836 << A->getAsString(Args);
837
838 cxxStdlibType = GetDefaultCXXStdlibType();
839 }
840
841 return *cxxStdlibType;
842 }
843
844 /// Utility function to add a system include directory to CC1 arguments.
addSystemInclude(const ArgList & DriverArgs,ArgStringList & CC1Args,const Twine & Path)845 /*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
846 ArgStringList &CC1Args,
847 const Twine &Path) {
848 CC1Args.push_back("-internal-isystem");
849 CC1Args.push_back(DriverArgs.MakeArgString(Path));
850 }
851
852 /// Utility function to add a system include directory with extern "C"
853 /// semantics to CC1 arguments.
854 ///
855 /// Note that this should be used rarely, and only for directories that
856 /// historically and for legacy reasons are treated as having implicit extern
857 /// "C" semantics. These semantics are *ignored* by and large today, but its
858 /// important to preserve the preprocessor changes resulting from the
859 /// classification.
addExternCSystemInclude(const ArgList & DriverArgs,ArgStringList & CC1Args,const Twine & Path)860 /*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
861 ArgStringList &CC1Args,
862 const Twine &Path) {
863 CC1Args.push_back("-internal-externc-isystem");
864 CC1Args.push_back(DriverArgs.MakeArgString(Path));
865 }
866
addExternCSystemIncludeIfExists(const ArgList & DriverArgs,ArgStringList & CC1Args,const Twine & Path)867 void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
868 ArgStringList &CC1Args,
869 const Twine &Path) {
870 if (llvm::sys::fs::exists(Path))
871 addExternCSystemInclude(DriverArgs, CC1Args, Path);
872 }
873
874 /// Utility function to add a list of system include directories to CC1.
addSystemIncludes(const ArgList & DriverArgs,ArgStringList & CC1Args,ArrayRef<StringRef> Paths)875 /*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
876 ArgStringList &CC1Args,
877 ArrayRef<StringRef> Paths) {
878 for (const auto &Path : Paths) {
879 CC1Args.push_back("-internal-isystem");
880 CC1Args.push_back(DriverArgs.MakeArgString(Path));
881 }
882 }
883
detectLibcxxVersion(StringRef IncludePath) const884 std::string ToolChain::detectLibcxxVersion(StringRef IncludePath) const {
885 std::error_code EC;
886 int MaxVersion = 0;
887 std::string MaxVersionString;
888 SmallString<128> Path(IncludePath);
889 llvm::sys::path::append(Path, "c++");
890 for (llvm::vfs::directory_iterator LI = getVFS().dir_begin(Path, EC), LE;
891 !EC && LI != LE; LI = LI.increment(EC)) {
892 StringRef VersionText = llvm::sys::path::filename(LI->path());
893 int Version;
894 if (VersionText[0] == 'v' &&
895 !VersionText.slice(1, StringRef::npos).getAsInteger(10, Version)) {
896 if (Version > MaxVersion) {
897 MaxVersion = Version;
898 MaxVersionString = std::string(VersionText);
899 }
900 }
901 }
902 if (!MaxVersion)
903 return "";
904 return MaxVersionString;
905 }
906
AddClangCXXStdlibIncludeArgs(const ArgList & DriverArgs,ArgStringList & CC1Args) const907 void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
908 ArgStringList &CC1Args) const {
909 // Header search paths should be handled by each of the subclasses.
910 // Historically, they have not been, and instead have been handled inside of
911 // the CC1-layer frontend. As the logic is hoisted out, this generic function
912 // will slowly stop being called.
913 //
914 // While it is being called, replicate a bit of a hack to propagate the
915 // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
916 // header search paths with it. Once all systems are overriding this
917 // function, the CC1 flag and this line can be removed.
918 DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
919 }
920
AddClangCXXStdlibIsystemArgs(const llvm::opt::ArgList & DriverArgs,llvm::opt::ArgStringList & CC1Args) const921 void ToolChain::AddClangCXXStdlibIsystemArgs(
922 const llvm::opt::ArgList &DriverArgs,
923 llvm::opt::ArgStringList &CC1Args) const {
924 DriverArgs.ClaimAllArgs(options::OPT_stdlibxx_isystem);
925 if (!DriverArgs.hasArg(options::OPT_nostdinc, options::OPT_nostdincxx,
926 options::OPT_nostdlibinc))
927 for (const auto &P :
928 DriverArgs.getAllArgValues(options::OPT_stdlibxx_isystem))
929 addSystemInclude(DriverArgs, CC1Args, P);
930 }
931
ShouldLinkCXXStdlib(const llvm::opt::ArgList & Args) const932 bool ToolChain::ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const {
933 return getDriver().CCCIsCXX() &&
934 !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,
935 options::OPT_nostdlibxx);
936 }
937
AddCXXStdlibLibArgs(const ArgList & Args,ArgStringList & CmdArgs) const938 void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
939 ArgStringList &CmdArgs) const {
940 assert(!Args.hasArg(options::OPT_nostdlibxx) &&
941 "should not have called this");
942 CXXStdlibType Type = GetCXXStdlibType(Args);
943
944 switch (Type) {
945 case ToolChain::CST_Libcxx:
946 CmdArgs.push_back("-lc++");
947 break;
948
949 case ToolChain::CST_Libstdcxx:
950 CmdArgs.push_back("-lstdc++");
951 break;
952 }
953 }
954
AddFilePathLibArgs(const ArgList & Args,ArgStringList & CmdArgs) const955 void ToolChain::AddFilePathLibArgs(const ArgList &Args,
956 ArgStringList &CmdArgs) const {
957 for (const auto &LibPath : getFilePaths())
958 if(LibPath.length() > 0)
959 CmdArgs.push_back(Args.MakeArgString(StringRef("-L") + LibPath));
960 }
961
AddCCKextLibArgs(const ArgList & Args,ArgStringList & CmdArgs) const962 void ToolChain::AddCCKextLibArgs(const ArgList &Args,
963 ArgStringList &CmdArgs) const {
964 CmdArgs.push_back("-lcc_kext");
965 }
966
isFastMathRuntimeAvailable(const ArgList & Args,std::string & Path) const967 bool ToolChain::isFastMathRuntimeAvailable(const ArgList &Args,
968 std::string &Path) const {
969 // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
970 // (to keep the linker options consistent with gcc and clang itself).
971 if (!isOptimizationLevelFast(Args)) {
972 // Check if -ffast-math or -funsafe-math.
973 Arg *A =
974 Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
975 options::OPT_funsafe_math_optimizations,
976 options::OPT_fno_unsafe_math_optimizations);
977
978 if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
979 A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
980 return false;
981 }
982 // If crtfastmath.o exists add it to the arguments.
983 Path = GetFilePath("crtfastmath.o");
984 return (Path != "crtfastmath.o"); // Not found.
985 }
986
addFastMathRuntimeIfAvailable(const ArgList & Args,ArgStringList & CmdArgs) const987 bool ToolChain::addFastMathRuntimeIfAvailable(const ArgList &Args,
988 ArgStringList &CmdArgs) const {
989 std::string Path;
990 if (isFastMathRuntimeAvailable(Args, Path)) {
991 CmdArgs.push_back(Args.MakeArgString(Path));
992 return true;
993 }
994
995 return false;
996 }
997
getSupportedSanitizers() const998 SanitizerMask ToolChain::getSupportedSanitizers() const {
999 // Return sanitizers which don't require runtime support and are not
1000 // platform dependent.
1001
1002 SanitizerMask Res =
1003 (SanitizerKind::Undefined & ~SanitizerKind::Vptr &
1004 ~SanitizerKind::Function) |
1005 (SanitizerKind::CFI & ~SanitizerKind::CFIICall) |
1006 SanitizerKind::CFICastStrict | SanitizerKind::FloatDivideByZero |
1007 SanitizerKind::UnsignedIntegerOverflow |
1008 SanitizerKind::UnsignedShiftBase | SanitizerKind::ImplicitConversion |
1009 SanitizerKind::Nullability | SanitizerKind::LocalBounds;
1010 if (getTriple().getArch() == llvm::Triple::x86 ||
1011 getTriple().getArch() == llvm::Triple::x86_64 ||
1012 getTriple().getArch() == llvm::Triple::arm || getTriple().isWasm() ||
1013 getTriple().isAArch64())
1014 Res |= SanitizerKind::CFIICall;
1015 if (getTriple().getArch() == llvm::Triple::x86_64 ||
1016 getTriple().isAArch64(64) || getTriple().isRISCV())
1017 Res |= SanitizerKind::ShadowCallStack;
1018 if (getTriple().isAArch64(64))
1019 Res |= SanitizerKind::MemTag;
1020 return Res;
1021 }
1022
AddCudaIncludeArgs(const ArgList & DriverArgs,ArgStringList & CC1Args) const1023 void ToolChain::AddCudaIncludeArgs(const ArgList &DriverArgs,
1024 ArgStringList &CC1Args) const {}
1025
AddHIPIncludeArgs(const ArgList & DriverArgs,ArgStringList & CC1Args) const1026 void ToolChain::AddHIPIncludeArgs(const ArgList &DriverArgs,
1027 ArgStringList &CC1Args) const {}
1028
1029 llvm::SmallVector<ToolChain::BitCodeLibraryInfo, 12>
getHIPDeviceLibs(const ArgList & DriverArgs) const1030 ToolChain::getHIPDeviceLibs(const ArgList &DriverArgs) const {
1031 return {};
1032 }
1033
AddIAMCUIncludeArgs(const ArgList & DriverArgs,ArgStringList & CC1Args) const1034 void ToolChain::AddIAMCUIncludeArgs(const ArgList &DriverArgs,
1035 ArgStringList &CC1Args) const {}
1036
separateMSVCFullVersion(unsigned Version)1037 static VersionTuple separateMSVCFullVersion(unsigned Version) {
1038 if (Version < 100)
1039 return VersionTuple(Version);
1040
1041 if (Version < 10000)
1042 return VersionTuple(Version / 100, Version % 100);
1043
1044 unsigned Build = 0, Factor = 1;
1045 for (; Version > 10000; Version = Version / 10, Factor = Factor * 10)
1046 Build = Build + (Version % 10) * Factor;
1047 return VersionTuple(Version / 100, Version % 100, Build);
1048 }
1049
1050 VersionTuple
computeMSVCVersion(const Driver * D,const llvm::opt::ArgList & Args) const1051 ToolChain::computeMSVCVersion(const Driver *D,
1052 const llvm::opt::ArgList &Args) const {
1053 const Arg *MSCVersion = Args.getLastArg(options::OPT_fmsc_version);
1054 const Arg *MSCompatibilityVersion =
1055 Args.getLastArg(options::OPT_fms_compatibility_version);
1056
1057 if (MSCVersion && MSCompatibilityVersion) {
1058 if (D)
1059 D->Diag(diag::err_drv_argument_not_allowed_with)
1060 << MSCVersion->getAsString(Args)
1061 << MSCompatibilityVersion->getAsString(Args);
1062 return VersionTuple();
1063 }
1064
1065 if (MSCompatibilityVersion) {
1066 VersionTuple MSVT;
1067 if (MSVT.tryParse(MSCompatibilityVersion->getValue())) {
1068 if (D)
1069 D->Diag(diag::err_drv_invalid_value)
1070 << MSCompatibilityVersion->getAsString(Args)
1071 << MSCompatibilityVersion->getValue();
1072 } else {
1073 return MSVT;
1074 }
1075 }
1076
1077 if (MSCVersion) {
1078 unsigned Version = 0;
1079 if (StringRef(MSCVersion->getValue()).getAsInteger(10, Version)) {
1080 if (D)
1081 D->Diag(diag::err_drv_invalid_value)
1082 << MSCVersion->getAsString(Args) << MSCVersion->getValue();
1083 } else {
1084 return separateMSVCFullVersion(Version);
1085 }
1086 }
1087
1088 return VersionTuple();
1089 }
1090
TranslateOpenMPTargetArgs(const llvm::opt::DerivedArgList & Args,bool SameTripleAsHost,SmallVectorImpl<llvm::opt::Arg * > & AllocatedArgs) const1091 llvm::opt::DerivedArgList *ToolChain::TranslateOpenMPTargetArgs(
1092 const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost,
1093 SmallVectorImpl<llvm::opt::Arg *> &AllocatedArgs) const {
1094 DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
1095 const OptTable &Opts = getDriver().getOpts();
1096 bool Modified = false;
1097
1098 // Handle -Xopenmp-target flags
1099 for (auto *A : Args) {
1100 // Exclude flags which may only apply to the host toolchain.
1101 // Do not exclude flags when the host triple (AuxTriple)
1102 // matches the current toolchain triple. If it is not present
1103 // at all, target and host share a toolchain.
1104 if (A->getOption().matches(options::OPT_m_Group)) {
1105 if (SameTripleAsHost)
1106 DAL->append(A);
1107 else
1108 Modified = true;
1109 continue;
1110 }
1111
1112 unsigned Index;
1113 unsigned Prev;
1114 bool XOpenMPTargetNoTriple =
1115 A->getOption().matches(options::OPT_Xopenmp_target);
1116
1117 if (A->getOption().matches(options::OPT_Xopenmp_target_EQ)) {
1118 // Passing device args: -Xopenmp-target=<triple> -opt=val.
1119 if (A->getValue(0) == getTripleString())
1120 Index = Args.getBaseArgs().MakeIndex(A->getValue(1));
1121 else
1122 continue;
1123 } else if (XOpenMPTargetNoTriple) {
1124 // Passing device args: -Xopenmp-target -opt=val.
1125 Index = Args.getBaseArgs().MakeIndex(A->getValue(0));
1126 } else {
1127 DAL->append(A);
1128 continue;
1129 }
1130
1131 // Parse the argument to -Xopenmp-target.
1132 Prev = Index;
1133 std::unique_ptr<Arg> XOpenMPTargetArg(Opts.ParseOneArg(Args, Index));
1134 if (!XOpenMPTargetArg || Index > Prev + 1) {
1135 getDriver().Diag(diag::err_drv_invalid_Xopenmp_target_with_args)
1136 << A->getAsString(Args);
1137 continue;
1138 }
1139 if (XOpenMPTargetNoTriple && XOpenMPTargetArg &&
1140 Args.getAllArgValues(options::OPT_fopenmp_targets_EQ).size() != 1) {
1141 getDriver().Diag(diag::err_drv_Xopenmp_target_missing_triple);
1142 continue;
1143 }
1144 XOpenMPTargetArg->setBaseArg(A);
1145 A = XOpenMPTargetArg.release();
1146 AllocatedArgs.push_back(A);
1147 DAL->append(A);
1148 Modified = true;
1149 }
1150
1151 if (Modified)
1152 return DAL;
1153
1154 delete DAL;
1155 return nullptr;
1156 }
1157
1158 // TODO: Currently argument values separated by space e.g.
1159 // -Xclang -mframe-pointer=no cannot be passed by -Xarch_. This should be
1160 // fixed.
TranslateXarchArgs(const llvm::opt::DerivedArgList & Args,llvm::opt::Arg * & A,llvm::opt::DerivedArgList * DAL,SmallVectorImpl<llvm::opt::Arg * > * AllocatedArgs) const1161 void ToolChain::TranslateXarchArgs(
1162 const llvm::opt::DerivedArgList &Args, llvm::opt::Arg *&A,
1163 llvm::opt::DerivedArgList *DAL,
1164 SmallVectorImpl<llvm::opt::Arg *> *AllocatedArgs) const {
1165 const OptTable &Opts = getDriver().getOpts();
1166 unsigned ValuePos = 1;
1167 if (A->getOption().matches(options::OPT_Xarch_device) ||
1168 A->getOption().matches(options::OPT_Xarch_host))
1169 ValuePos = 0;
1170
1171 unsigned Index = Args.getBaseArgs().MakeIndex(A->getValue(ValuePos));
1172 unsigned Prev = Index;
1173 std::unique_ptr<llvm::opt::Arg> XarchArg(Opts.ParseOneArg(Args, Index));
1174
1175 // If the argument parsing failed or more than one argument was
1176 // consumed, the -Xarch_ argument's parameter tried to consume
1177 // extra arguments. Emit an error and ignore.
1178 //
1179 // We also want to disallow any options which would alter the
1180 // driver behavior; that isn't going to work in our model. We
1181 // use options::NoXarchOption to control this.
1182 if (!XarchArg || Index > Prev + 1) {
1183 getDriver().Diag(diag::err_drv_invalid_Xarch_argument_with_args)
1184 << A->getAsString(Args);
1185 return;
1186 } else if (XarchArg->getOption().hasFlag(options::NoXarchOption)) {
1187 auto &Diags = getDriver().getDiags();
1188 unsigned DiagID =
1189 Diags.getCustomDiagID(DiagnosticsEngine::Error,
1190 "invalid Xarch argument: '%0', not all driver "
1191 "options can be forwared via Xarch argument");
1192 Diags.Report(DiagID) << A->getAsString(Args);
1193 return;
1194 }
1195 XarchArg->setBaseArg(A);
1196 A = XarchArg.release();
1197 if (!AllocatedArgs)
1198 DAL->AddSynthesizedArg(A);
1199 else
1200 AllocatedArgs->push_back(A);
1201 }
1202
TranslateXarchArgs(const llvm::opt::DerivedArgList & Args,StringRef BoundArch,Action::OffloadKind OFK,SmallVectorImpl<llvm::opt::Arg * > * AllocatedArgs) const1203 llvm::opt::DerivedArgList *ToolChain::TranslateXarchArgs(
1204 const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
1205 Action::OffloadKind OFK,
1206 SmallVectorImpl<llvm::opt::Arg *> *AllocatedArgs) const {
1207 DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
1208 bool Modified = false;
1209
1210 bool IsGPU = OFK == Action::OFK_Cuda || OFK == Action::OFK_HIP;
1211 for (Arg *A : Args) {
1212 bool NeedTrans = false;
1213 bool Skip = false;
1214 if (A->getOption().matches(options::OPT_Xarch_device)) {
1215 NeedTrans = IsGPU;
1216 Skip = !IsGPU;
1217 } else if (A->getOption().matches(options::OPT_Xarch_host)) {
1218 NeedTrans = !IsGPU;
1219 Skip = IsGPU;
1220 } else if (A->getOption().matches(options::OPT_Xarch__) && IsGPU) {
1221 // Do not translate -Xarch_ options for non CUDA/HIP toolchain since
1222 // they may need special translation.
1223 // Skip this argument unless the architecture matches BoundArch
1224 if (BoundArch.empty() || A->getValue(0) != BoundArch)
1225 Skip = true;
1226 else
1227 NeedTrans = true;
1228 }
1229 if (NeedTrans || Skip)
1230 Modified = true;
1231 if (NeedTrans)
1232 TranslateXarchArgs(Args, A, DAL, AllocatedArgs);
1233 if (!Skip)
1234 DAL->append(A);
1235 }
1236
1237 if (Modified)
1238 return DAL;
1239
1240 delete DAL;
1241 return nullptr;
1242 }
1243