xref: /freebsd/contrib/llvm-project/clang/lib/Driver/ToolChain.cpp (revision 0d8fe2373503aeac48492f28073049a8bfa4feb5) 
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 "InputInfo.h"
11 #include "ToolChains/Arch/ARM.h"
12 #include "ToolChains/Clang.h"
13 #include "ToolChains/InterfaceStubs.h"
14 #include "ToolChains/Flang.h"
15 #include "clang/Basic/ObjCRuntime.h"
16 #include "clang/Basic/Sanitizers.h"
17 #include "clang/Config/config.h"
18 #include "clang/Driver/Action.h"
19 #include "clang/Driver/Driver.h"
20 #include "clang/Driver/DriverDiagnostic.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/Option/Arg.h"
33 #include "llvm/Option/ArgList.h"
34 #include "llvm/Option/OptTable.h"
35 #include "llvm/Option/Option.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/FileSystem.h"
38 #include "llvm/Support/Path.h"
39 #include "llvm/Support/TargetParser.h"
40 #include "llvm/Support/TargetRegistry.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 
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 
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 
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   if (D.CCCIsCXX()) {
79     if (auto CXXStdlibPath = getCXXStdlibPath())
80       getFilePaths().push_back(*CXXStdlibPath);
81   }
82 
83   if (auto RuntimePath = getRuntimePath())
84     getLibraryPaths().push_back(*RuntimePath);
85 
86   std::string CandidateLibPath = getArchSpecificLibPath();
87   if (getVFS().exists(CandidateLibPath))
88     getFilePaths().push_back(CandidateLibPath);
89 }
90 
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 
99 llvm::vfs::FileSystem &ToolChain::getVFS() const {
100   return getDriver().getVFS();
101 }
102 
103 bool ToolChain::useIntegratedAs() const {
104   return Args.hasFlag(options::OPT_fintegrated_as,
105                       options::OPT_fno_integrated_as,
106                       IsIntegratedAssemblerDefault());
107 }
108 
109 bool ToolChain::useRelaxRelocations() const {
110   return ENABLE_X86_RELAX_RELOCATIONS;
111 }
112 
113 bool ToolChain::isNoExecStackDefault() const {
114     return false;
115 }
116 
117 const SanitizerArgs& ToolChain::getSanitizerArgs() const {
118   if (!SanitizerArguments.get())
119     SanitizerArguments.reset(new SanitizerArgs(*this, Args));
120   return *SanitizerArguments.get();
121 }
122 
123 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 
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.
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 
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
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 
230 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 
255 std::string ToolChain::getInputFilename(const InputInfo &Input) const {
256   return Input.getFilename();
257 }
258 
259 bool ToolChain::IsUnwindTablesDefault(const ArgList &Args) const {
260   return false;
261 }
262 
263 Tool *ToolChain::getClang() const {
264   if (!Clang)
265     Clang.reset(new tools::Clang(*this));
266   return Clang.get();
267 }
268 
269 Tool *ToolChain::getFlang() const {
270   if (!Flang)
271     Flang.reset(new tools::Flang(*this));
272   return Flang.get();
273 }
274 
275 Tool *ToolChain::buildAssembler() const {
276   return new tools::ClangAs(*this);
277 }
278 
279 Tool *ToolChain::buildLinker() const {
280   llvm_unreachable("Linking is not supported by this toolchain");
281 }
282 
283 Tool *ToolChain::buildStaticLibTool() const {
284   llvm_unreachable("Creating static lib is not supported by this toolchain");
285 }
286 
287 Tool *ToolChain::getAssemble() const {
288   if (!Assemble)
289     Assemble.reset(buildAssembler());
290   return Assemble.get();
291 }
292 
293 Tool *ToolChain::getClangAs() const {
294   if (!Assemble)
295     Assemble.reset(new tools::ClangAs(*this));
296   return Assemble.get();
297 }
298 
299 Tool *ToolChain::getLink() const {
300   if (!Link)
301     Link.reset(buildLinker());
302   return Link.get();
303 }
304 
305 Tool *ToolChain::getStaticLibTool() const {
306   if (!StaticLibTool)
307     StaticLibTool.reset(buildStaticLibTool());
308   return StaticLibTool.get();
309 }
310 
311 Tool *ToolChain::getIfsMerge() const {
312   if (!IfsMerge)
313     IfsMerge.reset(new tools::ifstool::Merger(*this));
314   return IfsMerge.get();
315 }
316 
317 Tool *ToolChain::getOffloadBundler() const {
318   if (!OffloadBundler)
319     OffloadBundler.reset(new tools::OffloadBundler(*this));
320   return OffloadBundler.get();
321 }
322 
323 Tool *ToolChain::getOffloadWrapper() const {
324   if (!OffloadWrapper)
325     OffloadWrapper.reset(new tools::OffloadWrapper(*this));
326   return OffloadWrapper.get();
327 }
328 
329 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 
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   return llvm::Triple::getArchTypeName(TC.getArch());
387 }
388 
389 StringRef ToolChain::getOSLibName() const {
390   switch (Triple.getOS()) {
391   case llvm::Triple::FreeBSD:
392     return "freebsd";
393   case llvm::Triple::NetBSD:
394     return "netbsd";
395   case llvm::Triple::OpenBSD:
396     return "openbsd";
397   case llvm::Triple::Solaris:
398     return "sunos";
399   case llvm::Triple::AIX:
400     return "aix";
401   default:
402     return getOS();
403   }
404 }
405 
406 std::string ToolChain::getCompilerRTPath() const {
407   SmallString<128> Path(getDriver().ResourceDir);
408   if (Triple.isOSUnknown()) {
409     llvm::sys::path::append(Path, "lib");
410   } else {
411     llvm::sys::path::append(Path, "lib", getOSLibName());
412   }
413   return std::string(Path.str());
414 }
415 
416 std::string ToolChain::getCompilerRTBasename(const ArgList &Args,
417                                              StringRef Component, FileType Type,
418                                              bool AddArch) const {
419   const llvm::Triple &TT = getTriple();
420   bool IsITANMSVCWindows =
421       TT.isWindowsMSVCEnvironment() || TT.isWindowsItaniumEnvironment();
422 
423   const char *Prefix =
424       IsITANMSVCWindows || Type == ToolChain::FT_Object ? "" : "lib";
425   const char *Suffix;
426   switch (Type) {
427   case ToolChain::FT_Object:
428     Suffix = IsITANMSVCWindows ? ".obj" : ".o";
429     break;
430   case ToolChain::FT_Static:
431     Suffix = IsITANMSVCWindows ? ".lib" : ".a";
432     break;
433   case ToolChain::FT_Shared:
434     Suffix = Triple.isOSWindows()
435                  ? (Triple.isWindowsGNUEnvironment() ? ".dll.a" : ".lib")
436                  : ".so";
437     break;
438   }
439 
440   std::string ArchAndEnv;
441   if (AddArch) {
442     StringRef Arch = getArchNameForCompilerRTLib(*this, Args);
443     const char *Env = TT.isAndroid() ? "-android" : "";
444     ArchAndEnv = ("-" + Arch + Env).str();
445   }
446   return (Prefix + Twine("clang_rt.") + Component + ArchAndEnv + Suffix).str();
447 }
448 
449 std::string ToolChain::getCompilerRT(const ArgList &Args, StringRef Component,
450                                      FileType Type) const {
451   // Check for runtime files in the new layout without the architecture first.
452   std::string CRTBasename =
453       getCompilerRTBasename(Args, Component, Type, /*AddArch=*/false);
454   for (const auto &LibPath : getLibraryPaths()) {
455     SmallString<128> P(LibPath);
456     llvm::sys::path::append(P, CRTBasename);
457     if (getVFS().exists(P))
458       return std::string(P.str());
459   }
460 
461   // Fall back to the old expected compiler-rt name if the new one does not
462   // exist.
463   CRTBasename = getCompilerRTBasename(Args, Component, Type, /*AddArch=*/true);
464   SmallString<128> Path(getCompilerRTPath());
465   llvm::sys::path::append(Path, CRTBasename);
466   return std::string(Path.str());
467 }
468 
469 const char *ToolChain::getCompilerRTArgString(const llvm::opt::ArgList &Args,
470                                               StringRef Component,
471                                               FileType Type) const {
472   return Args.MakeArgString(getCompilerRT(Args, Component, Type));
473 }
474 
475 
476 Optional<std::string> ToolChain::getRuntimePath() const {
477   SmallString<128> P;
478 
479   // First try the triple passed to driver as --target=<triple>.
480   P.assign(D.ResourceDir);
481   llvm::sys::path::append(P, "lib", D.getTargetTriple());
482   if (getVFS().exists(P))
483     return llvm::Optional<std::string>(std::string(P.str()));
484 
485   // Second try the normalized triple.
486   P.assign(D.ResourceDir);
487   llvm::sys::path::append(P, "lib", Triple.str());
488   if (getVFS().exists(P))
489     return llvm::Optional<std::string>(std::string(P.str()));
490 
491   return None;
492 }
493 
494 Optional<std::string> ToolChain::getCXXStdlibPath() const {
495   SmallString<128> P;
496 
497   // First try the triple passed to driver as --target=<triple>.
498   P.assign(D.Dir);
499   llvm::sys::path::append(P, "..", "lib", D.getTargetTriple(), "c++");
500   if (getVFS().exists(P))
501     return llvm::Optional<std::string>(std::string(P.str()));
502 
503   // Second try the normalized triple.
504   P.assign(D.Dir);
505   llvm::sys::path::append(P, "..", "lib", Triple.str(), "c++");
506   if (getVFS().exists(P))
507     return llvm::Optional<std::string>(std::string(P.str()));
508 
509   return None;
510 }
511 
512 std::string ToolChain::getArchSpecificLibPath() const {
513   SmallString<128> Path(getDriver().ResourceDir);
514   llvm::sys::path::append(Path, "lib", getOSLibName(),
515                           llvm::Triple::getArchTypeName(getArch()));
516   return std::string(Path.str());
517 }
518 
519 bool ToolChain::needsProfileRT(const ArgList &Args) {
520   if (Args.hasArg(options::OPT_noprofilelib))
521     return false;
522 
523   return Args.hasArg(options::OPT_fprofile_generate) ||
524          Args.hasArg(options::OPT_fprofile_generate_EQ) ||
525          Args.hasArg(options::OPT_fcs_profile_generate) ||
526          Args.hasArg(options::OPT_fcs_profile_generate_EQ) ||
527          Args.hasArg(options::OPT_fprofile_instr_generate) ||
528          Args.hasArg(options::OPT_fprofile_instr_generate_EQ) ||
529          Args.hasArg(options::OPT_fcreate_profile) ||
530          Args.hasArg(options::OPT_forder_file_instrumentation);
531 }
532 
533 bool ToolChain::needsGCovInstrumentation(const llvm::opt::ArgList &Args) {
534   return Args.hasArg(options::OPT_coverage) ||
535          Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
536                       false);
537 }
538 
539 Tool *ToolChain::SelectTool(const JobAction &JA) const {
540   if (D.IsFlangMode() && getDriver().ShouldUseFlangCompiler(JA)) return getFlang();
541   if (getDriver().ShouldUseClangCompiler(JA)) return getClang();
542   Action::ActionClass AC = JA.getKind();
543   if (AC == Action::AssembleJobClass && useIntegratedAs())
544     return getClangAs();
545   return getTool(AC);
546 }
547 
548 std::string ToolChain::GetFilePath(const char *Name) const {
549   return D.GetFilePath(Name, *this);
550 }
551 
552 std::string ToolChain::GetProgramPath(const char *Name) const {
553   return D.GetProgramPath(Name, *this);
554 }
555 
556 std::string ToolChain::GetLinkerPath(bool *LinkerIsLLD,
557                                      bool *LinkerIsLLDDarwinNew) const {
558   if (LinkerIsLLD)
559     *LinkerIsLLD = false;
560   if (LinkerIsLLDDarwinNew)
561     *LinkerIsLLDDarwinNew = false;
562 
563   // Get -fuse-ld= first to prevent -Wunused-command-line-argument. -fuse-ld= is
564   // considered as the linker flavor, e.g. "bfd", "gold", or "lld".
565   const Arg* A = Args.getLastArg(options::OPT_fuse_ld_EQ);
566   StringRef UseLinker = A ? A->getValue() : CLANG_DEFAULT_LINKER;
567 
568   // --ld-path= takes precedence over -fuse-ld= and specifies the executable
569   // name. -B, COMPILER_PATH and PATH and consulted if the value does not
570   // contain a path component separator.
571   if (const Arg *A = Args.getLastArg(options::OPT_ld_path_EQ)) {
572     std::string Path(A->getValue());
573     if (!Path.empty()) {
574       if (llvm::sys::path::parent_path(Path).empty())
575         Path = GetProgramPath(A->getValue());
576       if (llvm::sys::fs::can_execute(Path))
577         return std::string(Path);
578     }
579     getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
580     return GetProgramPath(getDefaultLinker());
581   }
582   // If we're passed -fuse-ld= with no argument, or with the argument ld,
583   // then use whatever the default system linker is.
584   if (UseLinker.empty() || UseLinker == "ld") {
585     const char *DefaultLinker = getDefaultLinker();
586     if (llvm::sys::path::is_absolute(DefaultLinker))
587       return std::string(DefaultLinker);
588     else
589       return GetProgramPath(DefaultLinker);
590   }
591 
592   // Extending -fuse-ld= to an absolute or relative path is unexpected. Checking
593   // for the linker flavor is brittle. In addition, prepending "ld." or "ld64."
594   // to a relative path is surprising. This is more complex due to priorities
595   // among -B, COMPILER_PATH and PATH. --ld-path= should be used instead.
596   if (UseLinker.find('/') != StringRef::npos)
597     getDriver().Diag(diag::warn_drv_fuse_ld_path);
598 
599   if (llvm::sys::path::is_absolute(UseLinker)) {
600     // If we're passed what looks like an absolute path, don't attempt to
601     // second-guess that.
602     if (llvm::sys::fs::can_execute(UseLinker))
603       return std::string(UseLinker);
604   } else {
605     llvm::SmallString<8> LinkerName;
606     if (Triple.isOSDarwin())
607       LinkerName.append("ld64.");
608     else
609       LinkerName.append("ld.");
610     LinkerName.append(UseLinker);
611 
612     std::string LinkerPath(GetProgramPath(LinkerName.c_str()));
613     if (llvm::sys::fs::can_execute(LinkerPath)) {
614       // FIXME: Remove lld.darwinnew here once it's the only MachO lld.
615       if (LinkerIsLLD)
616         *LinkerIsLLD = UseLinker == "lld" || UseLinker == "lld.darwinnew";
617       if (LinkerIsLLDDarwinNew)
618         *LinkerIsLLDDarwinNew = UseLinker == "lld.darwinnew";
619       return LinkerPath;
620     }
621   }
622 
623   if (A)
624     getDriver().Diag(diag::err_drv_invalid_linker_name) << A->getAsString(Args);
625 
626   return GetProgramPath(getDefaultLinker());
627 }
628 
629 std::string ToolChain::GetStaticLibToolPath() const {
630   // TODO: Add support for static lib archiving on Windows
631   return GetProgramPath("llvm-ar");
632 }
633 
634 types::ID ToolChain::LookupTypeForExtension(StringRef Ext) const {
635   types::ID id = types::lookupTypeForExtension(Ext);
636 
637   // Flang always runs the preprocessor and has no notion of "preprocessed
638   // fortran". Here, TY_PP_Fortran is coerced to TY_Fortran to avoid treating
639   // them differently.
640   if (D.IsFlangMode() && id == types::TY_PP_Fortran)
641     id = types::TY_Fortran;
642 
643   return id;
644 }
645 
646 bool ToolChain::HasNativeLLVMSupport() const {
647   return false;
648 }
649 
650 bool ToolChain::isCrossCompiling() const {
651   llvm::Triple HostTriple(LLVM_HOST_TRIPLE);
652   switch (HostTriple.getArch()) {
653   // The A32/T32/T16 instruction sets are not separate architectures in this
654   // context.
655   case llvm::Triple::arm:
656   case llvm::Triple::armeb:
657   case llvm::Triple::thumb:
658   case llvm::Triple::thumbeb:
659     return getArch() != llvm::Triple::arm && getArch() != llvm::Triple::thumb &&
660            getArch() != llvm::Triple::armeb && getArch() != llvm::Triple::thumbeb;
661   default:
662     return HostTriple.getArch() != getArch();
663   }
664 }
665 
666 ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
667   return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
668                      VersionTuple());
669 }
670 
671 llvm::ExceptionHandling
672 ToolChain::GetExceptionModel(const llvm::opt::ArgList &Args) const {
673   return llvm::ExceptionHandling::None;
674 }
675 
676 bool ToolChain::isThreadModelSupported(const StringRef Model) const {
677   if (Model == "single") {
678     // FIXME: 'single' is only supported on ARM and WebAssembly so far.
679     return Triple.getArch() == llvm::Triple::arm ||
680            Triple.getArch() == llvm::Triple::armeb ||
681            Triple.getArch() == llvm::Triple::thumb ||
682            Triple.getArch() == llvm::Triple::thumbeb || Triple.isWasm();
683   } else if (Model == "posix")
684     return true;
685 
686   return false;
687 }
688 
689 std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
690                                          types::ID InputType) const {
691   switch (getTriple().getArch()) {
692   default:
693     return getTripleString();
694 
695   case llvm::Triple::x86_64: {
696     llvm::Triple Triple = getTriple();
697     if (!Triple.isOSBinFormatMachO())
698       return getTripleString();
699 
700     if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
701       // x86_64h goes in the triple. Other -march options just use the
702       // vanilla triple we already have.
703       StringRef MArch = A->getValue();
704       if (MArch == "x86_64h")
705         Triple.setArchName(MArch);
706     }
707     return Triple.getTriple();
708   }
709   case llvm::Triple::aarch64: {
710     llvm::Triple Triple = getTriple();
711     if (!Triple.isOSBinFormatMachO())
712       return getTripleString();
713 
714     if (Triple.isArm64e())
715       return getTripleString();
716 
717     // FIXME: older versions of ld64 expect the "arm64" component in the actual
718     // triple string and query it to determine whether an LTO file can be
719     // handled. Remove this when we don't care any more.
720     Triple.setArchName("arm64");
721     return Triple.getTriple();
722   }
723   case llvm::Triple::aarch64_32:
724     return getTripleString();
725   case llvm::Triple::arm:
726   case llvm::Triple::armeb:
727   case llvm::Triple::thumb:
728   case llvm::Triple::thumbeb: {
729     // FIXME: Factor into subclasses.
730     llvm::Triple Triple = getTriple();
731     bool IsBigEndian = getTriple().getArch() == llvm::Triple::armeb ||
732                        getTriple().getArch() == llvm::Triple::thumbeb;
733 
734     // Handle pseudo-target flags '-mlittle-endian'/'-EL' and
735     // '-mbig-endian'/'-EB'.
736     if (Arg *A = Args.getLastArg(options::OPT_mlittle_endian,
737                                  options::OPT_mbig_endian)) {
738       IsBigEndian = !A->getOption().matches(options::OPT_mlittle_endian);
739     }
740 
741     // Thumb2 is the default for V7 on Darwin.
742     //
743     // FIXME: Thumb should just be another -target-feaure, not in the triple.
744     StringRef MCPU, MArch;
745     if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
746       MCPU = A->getValue();
747     if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
748       MArch = A->getValue();
749     std::string CPU =
750         Triple.isOSBinFormatMachO()
751             ? tools::arm::getARMCPUForMArch(MArch, Triple).str()
752             : tools::arm::getARMTargetCPU(MCPU, MArch, Triple);
753     StringRef Suffix =
754       tools::arm::getLLVMArchSuffixForARM(CPU, MArch, Triple);
755     bool IsMProfile = ARM::parseArchProfile(Suffix) == ARM::ProfileKind::M;
756     bool ThumbDefault = IsMProfile || (ARM::parseArchVersion(Suffix) == 7 &&
757                                        getTriple().isOSBinFormatMachO());
758     // FIXME: this is invalid for WindowsCE
759     if (getTriple().isOSWindows())
760       ThumbDefault = true;
761     std::string ArchName;
762     if (IsBigEndian)
763       ArchName = "armeb";
764     else
765       ArchName = "arm";
766 
767     // Check if ARM ISA was explicitly selected (using -mno-thumb or -marm) for
768     // M-Class CPUs/architecture variants, which is not supported.
769     bool ARMModeRequested = !Args.hasFlag(options::OPT_mthumb,
770                                           options::OPT_mno_thumb, ThumbDefault);
771     if (IsMProfile && ARMModeRequested) {
772       if (!MCPU.empty())
773         getDriver().Diag(diag::err_cpu_unsupported_isa) << CPU << "ARM";
774        else
775         getDriver().Diag(diag::err_arch_unsupported_isa)
776           << tools::arm::getARMArch(MArch, getTriple()) << "ARM";
777     }
778 
779     // Check to see if an explicit choice to use thumb has been made via
780     // -mthumb. For assembler files we must check for -mthumb in the options
781     // passed to the assembler via -Wa or -Xassembler.
782     bool IsThumb = false;
783     if (InputType != types::TY_PP_Asm)
784       IsThumb = Args.hasFlag(options::OPT_mthumb, options::OPT_mno_thumb,
785                               ThumbDefault);
786     else {
787       // Ideally we would check for these flags in
788       // CollectArgsForIntegratedAssembler but we can't change the ArchName at
789       // that point. There is no assembler equivalent of -mno-thumb, -marm, or
790       // -mno-arm.
791       for (const auto *A :
792            Args.filtered(options::OPT_Wa_COMMA, options::OPT_Xassembler)) {
793         for (StringRef Value : A->getValues()) {
794           if (Value == "-mthumb")
795             IsThumb = true;
796         }
797       }
798     }
799     // Assembly files should start in ARM mode, unless arch is M-profile, or
800     // -mthumb has been passed explicitly to the assembler. Windows is always
801     // thumb.
802     if (IsThumb || IsMProfile || getTriple().isOSWindows()) {
803       if (IsBigEndian)
804         ArchName = "thumbeb";
805       else
806         ArchName = "thumb";
807     }
808     Triple.setArchName(ArchName + Suffix.str());
809 
810     bool isHardFloat =
811         (arm::getARMFloatABI(getDriver(), Triple, Args) == arm::FloatABI::Hard);
812     switch (Triple.getEnvironment()) {
813     case Triple::GNUEABI:
814     case Triple::GNUEABIHF:
815       Triple.setEnvironment(isHardFloat ? Triple::GNUEABIHF : Triple::GNUEABI);
816       break;
817     case Triple::EABI:
818     case Triple::EABIHF:
819       Triple.setEnvironment(isHardFloat ? Triple::EABIHF : Triple::EABI);
820       break;
821     case Triple::MuslEABI:
822     case Triple::MuslEABIHF:
823       Triple.setEnvironment(isHardFloat ? Triple::MuslEABIHF
824                                         : Triple::MuslEABI);
825       break;
826     default: {
827       arm::FloatABI DefaultABI = arm::getDefaultFloatABI(Triple);
828       if (DefaultABI != arm::FloatABI::Invalid &&
829           isHardFloat != (DefaultABI == arm::FloatABI::Hard)) {
830         Arg *ABIArg =
831             Args.getLastArg(options::OPT_msoft_float, options::OPT_mhard_float,
832                             options::OPT_mfloat_abi_EQ);
833         assert(ABIArg && "Non-default float abi expected to be from arg");
834         D.Diag(diag::err_drv_unsupported_opt_for_target)
835             << ABIArg->getAsString(Args) << Triple.getTriple();
836       }
837       break;
838     }
839     }
840 
841     return Triple.getTriple();
842   }
843   }
844 }
845 
846 std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
847                                                    types::ID InputType) const {
848   return ComputeLLVMTriple(Args, InputType);
849 }
850 
851 std::string ToolChain::computeSysRoot() const {
852   return D.SysRoot;
853 }
854 
855 void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
856                                           ArgStringList &CC1Args) const {
857   // Each toolchain should provide the appropriate include flags.
858 }
859 
860 void ToolChain::addClangTargetOptions(
861     const ArgList &DriverArgs, ArgStringList &CC1Args,
862     Action::OffloadKind DeviceOffloadKind) const {}
863 
864 void ToolChain::addClangWarningOptions(ArgStringList &CC1Args) const {}
865 
866 void ToolChain::addProfileRTLibs(const llvm::opt::ArgList &Args,
867                                  llvm::opt::ArgStringList &CmdArgs) const {
868   if (!needsProfileRT(Args) && !needsGCovInstrumentation(Args))
869     return;
870 
871   CmdArgs.push_back(getCompilerRTArgString(Args, "profile"));
872 }
873 
874 ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
875     const ArgList &Args) const {
876   const Arg* A = Args.getLastArg(options::OPT_rtlib_EQ);
877   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_RTLIB;
878 
879   // Only use "platform" in tests to override CLANG_DEFAULT_RTLIB!
880   if (LibName == "compiler-rt")
881     return ToolChain::RLT_CompilerRT;
882   else if (LibName == "libgcc")
883     return ToolChain::RLT_Libgcc;
884   else if (LibName == "platform")
885     return GetDefaultRuntimeLibType();
886 
887   if (A)
888     getDriver().Diag(diag::err_drv_invalid_rtlib_name) << A->getAsString(Args);
889 
890   return GetDefaultRuntimeLibType();
891 }
892 
893 ToolChain::UnwindLibType ToolChain::GetUnwindLibType(
894     const ArgList &Args) const {
895   const Arg *A = Args.getLastArg(options::OPT_unwindlib_EQ);
896   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_UNWINDLIB;
897 
898   if (LibName == "none")
899     return ToolChain::UNW_None;
900   else if (LibName == "platform" || LibName == "") {
901     ToolChain::RuntimeLibType RtLibType = GetRuntimeLibType(Args);
902     if (RtLibType == ToolChain::RLT_CompilerRT)
903       return ToolChain::UNW_None;
904     else if (RtLibType == ToolChain::RLT_Libgcc)
905       return ToolChain::UNW_Libgcc;
906   } else if (LibName == "libunwind") {
907     if (GetRuntimeLibType(Args) == RLT_Libgcc)
908       getDriver().Diag(diag::err_drv_incompatible_unwindlib);
909     return ToolChain::UNW_CompilerRT;
910   } else if (LibName == "libgcc")
911     return ToolChain::UNW_Libgcc;
912 
913   if (A)
914     getDriver().Diag(diag::err_drv_invalid_unwindlib_name)
915         << A->getAsString(Args);
916 
917   return GetDefaultUnwindLibType();
918 }
919 
920 ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
921   const Arg *A = Args.getLastArg(options::OPT_stdlib_EQ);
922   StringRef LibName = A ? A->getValue() : CLANG_DEFAULT_CXX_STDLIB;
923 
924   // Only use "platform" in tests to override CLANG_DEFAULT_CXX_STDLIB!
925   if (LibName == "libc++")
926     return ToolChain::CST_Libcxx;
927   else if (LibName == "libstdc++")
928     return ToolChain::CST_Libstdcxx;
929   else if (LibName == "platform")
930     return GetDefaultCXXStdlibType();
931 
932   if (A)
933     getDriver().Diag(diag::err_drv_invalid_stdlib_name) << A->getAsString(Args);
934 
935   return GetDefaultCXXStdlibType();
936 }
937 
938 /// Utility function to add a system include directory to CC1 arguments.
939 /*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
940                                             ArgStringList &CC1Args,
941                                             const Twine &Path) {
942   CC1Args.push_back("-internal-isystem");
943   CC1Args.push_back(DriverArgs.MakeArgString(Path));
944 }
945 
946 /// Utility function to add a system include directory with extern "C"
947 /// semantics to CC1 arguments.
948 ///
949 /// Note that this should be used rarely, and only for directories that
950 /// historically and for legacy reasons are treated as having implicit extern
951 /// "C" semantics. These semantics are *ignored* by and large today, but its
952 /// important to preserve the preprocessor changes resulting from the
953 /// classification.
954 /*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
955                                                    ArgStringList &CC1Args,
956                                                    const Twine &Path) {
957   CC1Args.push_back("-internal-externc-isystem");
958   CC1Args.push_back(DriverArgs.MakeArgString(Path));
959 }
960 
961 void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
962                                                 ArgStringList &CC1Args,
963                                                 const Twine &Path) {
964   if (llvm::sys::fs::exists(Path))
965     addExternCSystemInclude(DriverArgs, CC1Args, Path);
966 }
967 
968 /// Utility function to add a list of system include directories to CC1.
969 /*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
970                                              ArgStringList &CC1Args,
971                                              ArrayRef<StringRef> Paths) {
972   for (const auto &Path : Paths) {
973     CC1Args.push_back("-internal-isystem");
974     CC1Args.push_back(DriverArgs.MakeArgString(Path));
975   }
976 }
977 
978 void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
979                                              ArgStringList &CC1Args) const {
980   // Header search paths should be handled by each of the subclasses.
981   // Historically, they have not been, and instead have been handled inside of
982   // the CC1-layer frontend. As the logic is hoisted out, this generic function
983   // will slowly stop being called.
984   //
985   // While it is being called, replicate a bit of a hack to propagate the
986   // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
987   // header search paths with it. Once all systems are overriding this
988   // function, the CC1 flag and this line can be removed.
989   DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
990 }
991 
992 void ToolChain::AddClangCXXStdlibIsystemArgs(
993     const llvm::opt::ArgList &DriverArgs,
994     llvm::opt::ArgStringList &CC1Args) const {
995   DriverArgs.ClaimAllArgs(options::OPT_stdlibxx_isystem);
996   if (!DriverArgs.hasArg(options::OPT_nostdincxx))
997     for (const auto &P :
998          DriverArgs.getAllArgValues(options::OPT_stdlibxx_isystem))
999       addSystemInclude(DriverArgs, CC1Args, P);
1000 }
1001 
1002 bool ToolChain::ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const {
1003   return getDriver().CCCIsCXX() &&
1004          !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,
1005                       options::OPT_nostdlibxx);
1006 }
1007 
1008 void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
1009                                     ArgStringList &CmdArgs) const {
1010   assert(!Args.hasArg(options::OPT_nostdlibxx) &&
1011          "should not have called this");
1012   CXXStdlibType Type = GetCXXStdlibType(Args);
1013 
1014   switch (Type) {
1015   case ToolChain::CST_Libcxx:
1016     CmdArgs.push_back("-lc++");
1017     break;
1018 
1019   case ToolChain::CST_Libstdcxx:
1020     CmdArgs.push_back("-lstdc++");
1021     break;
1022   }
1023 }
1024 
1025 void ToolChain::AddFilePathLibArgs(const ArgList &Args,
1026                                    ArgStringList &CmdArgs) const {
1027   for (const auto &LibPath : getFilePaths())
1028     if(LibPath.length() > 0)
1029       CmdArgs.push_back(Args.MakeArgString(StringRef("-L") + LibPath));
1030 }
1031 
1032 void ToolChain::AddCCKextLibArgs(const ArgList &Args,
1033                                  ArgStringList &CmdArgs) const {
1034   CmdArgs.push_back("-lcc_kext");
1035 }
1036 
1037 bool ToolChain::isFastMathRuntimeAvailable(const ArgList &Args,
1038                                            std::string &Path) const {
1039   // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
1040   // (to keep the linker options consistent with gcc and clang itself).
1041   if (!isOptimizationLevelFast(Args)) {
1042     // Check if -ffast-math or -funsafe-math.
1043     Arg *A =
1044       Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
1045                       options::OPT_funsafe_math_optimizations,
1046                       options::OPT_fno_unsafe_math_optimizations);
1047 
1048     if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
1049         A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
1050       return false;
1051   }
1052   // If crtfastmath.o exists add it to the arguments.
1053   Path = GetFilePath("crtfastmath.o");
1054   return (Path != "crtfastmath.o"); // Not found.
1055 }
1056 
1057 bool ToolChain::addFastMathRuntimeIfAvailable(const ArgList &Args,
1058                                               ArgStringList &CmdArgs) const {
1059   std::string Path;
1060   if (isFastMathRuntimeAvailable(Args, Path)) {
1061     CmdArgs.push_back(Args.MakeArgString(Path));
1062     return true;
1063   }
1064 
1065   return false;
1066 }
1067 
1068 SanitizerMask ToolChain::getSupportedSanitizers() const {
1069   // Return sanitizers which don't require runtime support and are not
1070   // platform dependent.
1071 
1072   SanitizerMask Res =
1073       (SanitizerKind::Undefined & ~SanitizerKind::Vptr &
1074        ~SanitizerKind::Function) |
1075       (SanitizerKind::CFI & ~SanitizerKind::CFIICall) |
1076       SanitizerKind::CFICastStrict | SanitizerKind::FloatDivideByZero |
1077       SanitizerKind::UnsignedIntegerOverflow |
1078       SanitizerKind::UnsignedShiftBase | SanitizerKind::ImplicitConversion |
1079       SanitizerKind::Nullability | SanitizerKind::LocalBounds;
1080   if (getTriple().getArch() == llvm::Triple::x86 ||
1081       getTriple().getArch() == llvm::Triple::x86_64 ||
1082       getTriple().getArch() == llvm::Triple::arm || getTriple().isWasm() ||
1083       getTriple().isAArch64())
1084     Res |= SanitizerKind::CFIICall;
1085   if (getTriple().getArch() == llvm::Triple::x86_64 ||
1086       getTriple().isAArch64(64) || getTriple().isRISCV())
1087     Res |= SanitizerKind::ShadowCallStack;
1088   if (getTriple().isAArch64(64))
1089     Res |= SanitizerKind::MemTag;
1090   return Res;
1091 }
1092 
1093 void ToolChain::AddCudaIncludeArgs(const ArgList &DriverArgs,
1094                                    ArgStringList &CC1Args) const {}
1095 
1096 void ToolChain::AddHIPIncludeArgs(const ArgList &DriverArgs,
1097                                   ArgStringList &CC1Args) const {}
1098 
1099 void ToolChain::AddIAMCUIncludeArgs(const ArgList &DriverArgs,
1100                                     ArgStringList &CC1Args) const {}
1101 
1102 static VersionTuple separateMSVCFullVersion(unsigned Version) {
1103   if (Version < 100)
1104     return VersionTuple(Version);
1105 
1106   if (Version < 10000)
1107     return VersionTuple(Version / 100, Version % 100);
1108 
1109   unsigned Build = 0, Factor = 1;
1110   for (; Version > 10000; Version = Version / 10, Factor = Factor * 10)
1111     Build = Build + (Version % 10) * Factor;
1112   return VersionTuple(Version / 100, Version % 100, Build);
1113 }
1114 
1115 VersionTuple
1116 ToolChain::computeMSVCVersion(const Driver *D,
1117                               const llvm::opt::ArgList &Args) const {
1118   const Arg *MSCVersion = Args.getLastArg(options::OPT_fmsc_version);
1119   const Arg *MSCompatibilityVersion =
1120       Args.getLastArg(options::OPT_fms_compatibility_version);
1121 
1122   if (MSCVersion && MSCompatibilityVersion) {
1123     if (D)
1124       D->Diag(diag::err_drv_argument_not_allowed_with)
1125           << MSCVersion->getAsString(Args)
1126           << MSCompatibilityVersion->getAsString(Args);
1127     return VersionTuple();
1128   }
1129 
1130   if (MSCompatibilityVersion) {
1131     VersionTuple MSVT;
1132     if (MSVT.tryParse(MSCompatibilityVersion->getValue())) {
1133       if (D)
1134         D->Diag(diag::err_drv_invalid_value)
1135             << MSCompatibilityVersion->getAsString(Args)
1136             << MSCompatibilityVersion->getValue();
1137     } else {
1138       return MSVT;
1139     }
1140   }
1141 
1142   if (MSCVersion) {
1143     unsigned Version = 0;
1144     if (StringRef(MSCVersion->getValue()).getAsInteger(10, Version)) {
1145       if (D)
1146         D->Diag(diag::err_drv_invalid_value)
1147             << MSCVersion->getAsString(Args) << MSCVersion->getValue();
1148     } else {
1149       return separateMSVCFullVersion(Version);
1150     }
1151   }
1152 
1153   return VersionTuple();
1154 }
1155 
1156 llvm::opt::DerivedArgList *ToolChain::TranslateOpenMPTargetArgs(
1157     const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost,
1158     SmallVectorImpl<llvm::opt::Arg *> &AllocatedArgs) const {
1159   DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
1160   const OptTable &Opts = getDriver().getOpts();
1161   bool Modified = false;
1162 
1163   // Handle -Xopenmp-target flags
1164   for (auto *A : Args) {
1165     // Exclude flags which may only apply to the host toolchain.
1166     // Do not exclude flags when the host triple (AuxTriple)
1167     // matches the current toolchain triple. If it is not present
1168     // at all, target and host share a toolchain.
1169     if (A->getOption().matches(options::OPT_m_Group)) {
1170       if (SameTripleAsHost)
1171         DAL->append(A);
1172       else
1173         Modified = true;
1174       continue;
1175     }
1176 
1177     unsigned Index;
1178     unsigned Prev;
1179     bool XOpenMPTargetNoTriple =
1180         A->getOption().matches(options::OPT_Xopenmp_target);
1181 
1182     if (A->getOption().matches(options::OPT_Xopenmp_target_EQ)) {
1183       // Passing device args: -Xopenmp-target=<triple> -opt=val.
1184       if (A->getValue(0) == getTripleString())
1185         Index = Args.getBaseArgs().MakeIndex(A->getValue(1));
1186       else
1187         continue;
1188     } else if (XOpenMPTargetNoTriple) {
1189       // Passing device args: -Xopenmp-target -opt=val.
1190       Index = Args.getBaseArgs().MakeIndex(A->getValue(0));
1191     } else {
1192       DAL->append(A);
1193       continue;
1194     }
1195 
1196     // Parse the argument to -Xopenmp-target.
1197     Prev = Index;
1198     std::unique_ptr<Arg> XOpenMPTargetArg(Opts.ParseOneArg(Args, Index));
1199     if (!XOpenMPTargetArg || Index > Prev + 1) {
1200       getDriver().Diag(diag::err_drv_invalid_Xopenmp_target_with_args)
1201           << A->getAsString(Args);
1202       continue;
1203     }
1204     if (XOpenMPTargetNoTriple && XOpenMPTargetArg &&
1205         Args.getAllArgValues(options::OPT_fopenmp_targets_EQ).size() != 1) {
1206       getDriver().Diag(diag::err_drv_Xopenmp_target_missing_triple);
1207       continue;
1208     }
1209     XOpenMPTargetArg->setBaseArg(A);
1210     A = XOpenMPTargetArg.release();
1211     AllocatedArgs.push_back(A);
1212     DAL->append(A);
1213     Modified = true;
1214   }
1215 
1216   if (Modified)
1217     return DAL;
1218 
1219   delete DAL;
1220   return nullptr;
1221 }
1222 
1223 // TODO: Currently argument values separated by space e.g.
1224 // -Xclang -mframe-pointer=no cannot be passed by -Xarch_. This should be
1225 // fixed.
1226 void ToolChain::TranslateXarchArgs(
1227     const llvm::opt::DerivedArgList &Args, llvm::opt::Arg *&A,
1228     llvm::opt::DerivedArgList *DAL,
1229     SmallVectorImpl<llvm::opt::Arg *> *AllocatedArgs) const {
1230   const OptTable &Opts = getDriver().getOpts();
1231   unsigned ValuePos = 1;
1232   if (A->getOption().matches(options::OPT_Xarch_device) ||
1233       A->getOption().matches(options::OPT_Xarch_host))
1234     ValuePos = 0;
1235 
1236   unsigned Index = Args.getBaseArgs().MakeIndex(A->getValue(ValuePos));
1237   unsigned Prev = Index;
1238   std::unique_ptr<llvm::opt::Arg> XarchArg(Opts.ParseOneArg(Args, Index));
1239 
1240   // If the argument parsing failed or more than one argument was
1241   // consumed, the -Xarch_ argument's parameter tried to consume
1242   // extra arguments. Emit an error and ignore.
1243   //
1244   // We also want to disallow any options which would alter the
1245   // driver behavior; that isn't going to work in our model. We
1246   // use options::NoXarchOption to control this.
1247   if (!XarchArg || Index > Prev + 1) {
1248     getDriver().Diag(diag::err_drv_invalid_Xarch_argument_with_args)
1249         << A->getAsString(Args);
1250     return;
1251   } else if (XarchArg->getOption().hasFlag(options::NoXarchOption)) {
1252     auto &Diags = getDriver().getDiags();
1253     unsigned DiagID =
1254         Diags.getCustomDiagID(DiagnosticsEngine::Error,
1255                               "invalid Xarch argument: '%0', not all driver "
1256                               "options can be forwared via Xarch argument");
1257     Diags.Report(DiagID) << A->getAsString(Args);
1258     return;
1259   }
1260   XarchArg->setBaseArg(A);
1261   A = XarchArg.release();
1262   if (!AllocatedArgs)
1263     DAL->AddSynthesizedArg(A);
1264   else
1265     AllocatedArgs->push_back(A);
1266 }
1267 
1268 llvm::opt::DerivedArgList *ToolChain::TranslateXarchArgs(
1269     const llvm::opt::DerivedArgList &Args, StringRef BoundArch,
1270     Action::OffloadKind OFK,
1271     SmallVectorImpl<llvm::opt::Arg *> *AllocatedArgs) const {
1272   DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
1273   bool Modified = false;
1274 
1275   bool IsGPU = OFK == Action::OFK_Cuda || OFK == Action::OFK_HIP;
1276   for (Arg *A : Args) {
1277     bool NeedTrans = false;
1278     bool Skip = false;
1279     if (A->getOption().matches(options::OPT_Xarch_device)) {
1280       NeedTrans = IsGPU;
1281       Skip = !IsGPU;
1282     } else if (A->getOption().matches(options::OPT_Xarch_host)) {
1283       NeedTrans = !IsGPU;
1284       Skip = IsGPU;
1285     } else if (A->getOption().matches(options::OPT_Xarch__) && IsGPU) {
1286       // Do not translate -Xarch_ options for non CUDA/HIP toolchain since
1287       // they may need special translation.
1288       // Skip this argument unless the architecture matches BoundArch
1289       if (BoundArch.empty() || A->getValue(0) != BoundArch)
1290         Skip = true;
1291       else
1292         NeedTrans = true;
1293     }
1294     if (NeedTrans || Skip)
1295       Modified = true;
1296     if (NeedTrans)
1297       TranslateXarchArgs(Args, A, DAL, AllocatedArgs);
1298     if (!Skip)
1299       DAL->append(A);
1300   }
1301 
1302   if (Modified)
1303     return DAL;
1304 
1305   delete DAL;
1306   return nullptr;
1307 }
1308