1 //===--- CommonArgs.cpp - Args handling for multiple toolchains -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "CommonArgs.h"
10 #include "Arch/AArch64.h"
11 #include "Arch/ARM.h"
12 #include "Arch/Mips.h"
13 #include "Arch/PPC.h"
14 #include "Arch/SystemZ.h"
15 #include "Arch/X86.h"
16 #include "HIP.h"
17 #include "Hexagon.h"
18 #include "InputInfo.h"
19 #include "clang/Basic/CharInfo.h"
20 #include "clang/Basic/LangOptions.h"
21 #include "clang/Basic/ObjCRuntime.h"
22 #include "clang/Basic/Version.h"
23 #include "clang/Config/config.h"
24 #include "clang/Driver/Action.h"
25 #include "clang/Driver/Compilation.h"
26 #include "clang/Driver/Driver.h"
27 #include "clang/Driver/DriverDiagnostic.h"
28 #include "clang/Driver/Job.h"
29 #include "clang/Driver/Options.h"
30 #include "clang/Driver/SanitizerArgs.h"
31 #include "clang/Driver/ToolChain.h"
32 #include "clang/Driver/Util.h"
33 #include "clang/Driver/XRayArgs.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/ADT/SmallString.h"
36 #include "llvm/ADT/StringExtras.h"
37 #include "llvm/ADT/StringSwitch.h"
38 #include "llvm/ADT/Twine.h"
39 #include "llvm/Option/Arg.h"
40 #include "llvm/Option/ArgList.h"
41 #include "llvm/Option/Option.h"
42 #include "llvm/Support/CodeGen.h"
43 #include "llvm/Support/Compression.h"
44 #include "llvm/Support/Debug.h"
45 #include "llvm/Support/ErrorHandling.h"
46 #include "llvm/Support/FileSystem.h"
47 #include "llvm/Support/Host.h"
48 #include "llvm/Support/Path.h"
49 #include "llvm/Support/Process.h"
50 #include "llvm/Support/Program.h"
51 #include "llvm/Support/ScopedPrinter.h"
52 #include "llvm/Support/TargetParser.h"
53 #include "llvm/Support/Threading.h"
54 #include "llvm/Support/VirtualFileSystem.h"
55 #include "llvm/Support/YAMLParser.h"
56 
57 using namespace clang::driver;
58 using namespace clang::driver::tools;
59 using namespace clang;
60 using namespace llvm::opt;
61 
62 void tools::addPathIfExists(const Driver &D, const Twine &Path,
63                             ToolChain::path_list &Paths) {
64   if (D.getVFS().exists(Path))
65     Paths.push_back(Path.str());
66 }
67 
68 void tools::handleTargetFeaturesGroup(const ArgList &Args,
69                                       std::vector<StringRef> &Features,
70                                       OptSpecifier Group) {
71   for (const Arg *A : Args.filtered(Group)) {
72     StringRef Name = A->getOption().getName();
73     A->claim();
74 
75     // Skip over "-m".
76     assert(Name.startswith("m") && "Invalid feature name.");
77     Name = Name.substr(1);
78 
79     bool IsNegative = Name.startswith("no-");
80     if (IsNegative)
81       Name = Name.substr(3);
82     Features.push_back(Args.MakeArgString((IsNegative ? "-" : "+") + Name));
83   }
84 }
85 
86 void tools::addDirectoryList(const ArgList &Args, ArgStringList &CmdArgs,
87                              const char *ArgName, const char *EnvVar) {
88   const char *DirList = ::getenv(EnvVar);
89   bool CombinedArg = false;
90 
91   if (!DirList)
92     return; // Nothing to do.
93 
94   StringRef Name(ArgName);
95   if (Name.equals("-I") || Name.equals("-L") || Name.empty())
96     CombinedArg = true;
97 
98   StringRef Dirs(DirList);
99   if (Dirs.empty()) // Empty string should not add '.'.
100     return;
101 
102   StringRef::size_type Delim;
103   while ((Delim = Dirs.find(llvm::sys::EnvPathSeparator)) != StringRef::npos) {
104     if (Delim == 0) { // Leading colon.
105       if (CombinedArg) {
106         CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
107       } else {
108         CmdArgs.push_back(ArgName);
109         CmdArgs.push_back(".");
110       }
111     } else {
112       if (CombinedArg) {
113         CmdArgs.push_back(
114             Args.MakeArgString(std::string(ArgName) + Dirs.substr(0, Delim)));
115       } else {
116         CmdArgs.push_back(ArgName);
117         CmdArgs.push_back(Args.MakeArgString(Dirs.substr(0, Delim)));
118       }
119     }
120     Dirs = Dirs.substr(Delim + 1);
121   }
122 
123   if (Dirs.empty()) { // Trailing colon.
124     if (CombinedArg) {
125       CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
126     } else {
127       CmdArgs.push_back(ArgName);
128       CmdArgs.push_back(".");
129     }
130   } else { // Add the last path.
131     if (CombinedArg) {
132       CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + Dirs));
133     } else {
134       CmdArgs.push_back(ArgName);
135       CmdArgs.push_back(Args.MakeArgString(Dirs));
136     }
137   }
138 }
139 
140 void tools::AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
141                             const ArgList &Args, ArgStringList &CmdArgs,
142                             const JobAction &JA) {
143   const Driver &D = TC.getDriver();
144 
145   // Add extra linker input arguments which are not treated as inputs
146   // (constructed via -Xarch_).
147   Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
148 
149   // LIBRARY_PATH are included before user inputs and only supported on native
150   // toolchains.
151   if (!TC.isCrossCompiling())
152     addDirectoryList(Args, CmdArgs, "-L", "LIBRARY_PATH");
153 
154   for (const auto &II : Inputs) {
155     // If the current tool chain refers to an OpenMP or HIP offloading host, we
156     // should ignore inputs that refer to OpenMP or HIP offloading devices -
157     // they will be embedded according to a proper linker script.
158     if (auto *IA = II.getAction())
159       if ((JA.isHostOffloading(Action::OFK_OpenMP) &&
160            IA->isDeviceOffloading(Action::OFK_OpenMP)) ||
161           (JA.isHostOffloading(Action::OFK_HIP) &&
162            IA->isDeviceOffloading(Action::OFK_HIP)))
163         continue;
164 
165     if (!TC.HasNativeLLVMSupport() && types::isLLVMIR(II.getType()))
166       // Don't try to pass LLVM inputs unless we have native support.
167       D.Diag(diag::err_drv_no_linker_llvm_support) << TC.getTripleString();
168 
169     // Add filenames immediately.
170     if (II.isFilename()) {
171       CmdArgs.push_back(II.getFilename());
172       continue;
173     }
174 
175     // Otherwise, this is a linker input argument.
176     const Arg &A = II.getInputArg();
177 
178     // Handle reserved library options.
179     if (A.getOption().matches(options::OPT_Z_reserved_lib_stdcxx))
180       TC.AddCXXStdlibLibArgs(Args, CmdArgs);
181     else if (A.getOption().matches(options::OPT_Z_reserved_lib_cckext))
182       TC.AddCCKextLibArgs(Args, CmdArgs);
183     else if (A.getOption().matches(options::OPT_z)) {
184       // Pass -z prefix for gcc linker compatibility.
185       A.claim();
186       A.render(Args, CmdArgs);
187     } else {
188       A.renderAsInput(Args, CmdArgs);
189     }
190   }
191 }
192 
193 void tools::AddTargetFeature(const ArgList &Args,
194                              std::vector<StringRef> &Features,
195                              OptSpecifier OnOpt, OptSpecifier OffOpt,
196                              StringRef FeatureName) {
197   if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
198     if (A->getOption().matches(OnOpt))
199       Features.push_back(Args.MakeArgString("+" + FeatureName));
200     else
201       Features.push_back(Args.MakeArgString("-" + FeatureName));
202   }
203 }
204 
205 /// Get the (LLVM) name of the R600 gpu we are targeting.
206 static std::string getR600TargetGPU(const ArgList &Args) {
207   if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
208     const char *GPUName = A->getValue();
209     return llvm::StringSwitch<const char *>(GPUName)
210         .Cases("rv630", "rv635", "r600")
211         .Cases("rv610", "rv620", "rs780", "rs880")
212         .Case("rv740", "rv770")
213         .Case("palm", "cedar")
214         .Cases("sumo", "sumo2", "sumo")
215         .Case("hemlock", "cypress")
216         .Case("aruba", "cayman")
217         .Default(GPUName);
218   }
219   return "";
220 }
221 
222 static std::string getLanaiTargetCPU(const ArgList &Args) {
223   if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
224     return A->getValue();
225   }
226   return "";
227 }
228 
229 /// Get the (LLVM) name of the WebAssembly cpu we are targeting.
230 static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
231   // If we have -mcpu=, use that.
232   if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
233     StringRef CPU = A->getValue();
234 
235 #ifdef __wasm__
236     // Handle "native" by examining the host. "native" isn't meaningful when
237     // cross compiling, so only support this when the host is also WebAssembly.
238     if (CPU == "native")
239       return llvm::sys::getHostCPUName();
240 #endif
241 
242     return CPU;
243   }
244 
245   return "generic";
246 }
247 
248 std::string tools::getCPUName(const ArgList &Args, const llvm::Triple &T,
249                               bool FromAs) {
250   Arg *A;
251 
252   switch (T.getArch()) {
253   default:
254     return "";
255 
256   case llvm::Triple::aarch64:
257   case llvm::Triple::aarch64_32:
258   case llvm::Triple::aarch64_be:
259     return aarch64::getAArch64TargetCPU(Args, T, A);
260 
261   case llvm::Triple::arm:
262   case llvm::Triple::armeb:
263   case llvm::Triple::thumb:
264   case llvm::Triple::thumbeb: {
265     StringRef MArch, MCPU;
266     arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
267     return arm::getARMTargetCPU(MCPU, MArch, T);
268   }
269 
270   case llvm::Triple::avr:
271     if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
272       return A->getValue();
273     return "";
274 
275   case llvm::Triple::mips:
276   case llvm::Triple::mipsel:
277   case llvm::Triple::mips64:
278   case llvm::Triple::mips64el: {
279     StringRef CPUName;
280     StringRef ABIName;
281     mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
282     return std::string(CPUName);
283   }
284 
285   case llvm::Triple::nvptx:
286   case llvm::Triple::nvptx64:
287     if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
288       return A->getValue();
289     return "";
290 
291   case llvm::Triple::ppc:
292   case llvm::Triple::ppc64:
293   case llvm::Triple::ppc64le: {
294     std::string TargetCPUName = ppc::getPPCTargetCPU(Args);
295     // LLVM may default to generating code for the native CPU,
296     // but, like gcc, we default to a more generic option for
297     // each architecture. (except on Darwin)
298     if (TargetCPUName.empty() && !T.isOSDarwin()) {
299       if (T.getArch() == llvm::Triple::ppc64)
300         TargetCPUName = "ppc64";
301       else if (T.getArch() == llvm::Triple::ppc64le)
302         TargetCPUName = "ppc64le";
303       else
304         TargetCPUName = "ppc";
305     }
306     return TargetCPUName;
307   }
308 
309   case llvm::Triple::bpfel:
310   case llvm::Triple::bpfeb:
311   case llvm::Triple::sparc:
312   case llvm::Triple::sparcel:
313   case llvm::Triple::sparcv9:
314     if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
315       return A->getValue();
316     return "";
317 
318   case llvm::Triple::x86:
319   case llvm::Triple::x86_64:
320     return x86::getX86TargetCPU(Args, T);
321 
322   case llvm::Triple::hexagon:
323     return "hexagon" +
324            toolchains::HexagonToolChain::GetTargetCPUVersion(Args).str();
325 
326   case llvm::Triple::lanai:
327     return getLanaiTargetCPU(Args);
328 
329   case llvm::Triple::systemz:
330     return systemz::getSystemZTargetCPU(Args);
331 
332   case llvm::Triple::r600:
333   case llvm::Triple::amdgcn:
334     return getR600TargetGPU(Args);
335 
336   case llvm::Triple::wasm32:
337   case llvm::Triple::wasm64:
338     return std::string(getWebAssemblyTargetCPU(Args));
339   }
340 }
341 
342 llvm::StringRef tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
343   Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
344   if (!LtoJobsArg)
345     return {};
346   if (!llvm::get_threadpool_strategy(LtoJobsArg->getValue()))
347     D.Diag(diag::err_drv_invalid_int_value)
348         << LtoJobsArg->getAsString(Args) << LtoJobsArg->getValue();
349   return LtoJobsArg->getValue();
350 }
351 
352 // CloudABI uses -ffunction-sections and -fdata-sections by default.
353 bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
354   return Triple.getOS() == llvm::Triple::CloudABI;
355 }
356 
357 void tools::addLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
358                           ArgStringList &CmdArgs, const InputInfo &Output,
359                           const InputInfo &Input, bool IsThinLTO) {
360   const char *Linker = Args.MakeArgString(ToolChain.GetLinkerPath());
361   if (llvm::sys::path::filename(Linker) != "ld.lld" &&
362       llvm::sys::path::stem(Linker) != "ld.lld") {
363     // Tell the linker to load the plugin. This has to come before
364     // AddLinkerInputs as gold requires -plugin to come before any -plugin-opt
365     // that -Wl might forward.
366     CmdArgs.push_back("-plugin");
367 
368 #if defined(_WIN32)
369     const char *Suffix = ".dll";
370 #elif defined(__APPLE__)
371     const char *Suffix = ".dylib";
372 #else
373     const char *Suffix = ".so";
374 #endif
375 
376     SmallString<1024> Plugin;
377     llvm::sys::path::native(Twine(ToolChain.getDriver().Dir) +
378                                 "/../lib" CLANG_LIBDIR_SUFFIX "/LLVMgold" +
379                                 Suffix,
380                             Plugin);
381     CmdArgs.push_back(Args.MakeArgString(Plugin));
382   }
383 
384   // Try to pass driver level flags relevant to LTO code generation down to
385   // the plugin.
386 
387   // Handle flags for selecting CPU variants.
388   std::string CPU = getCPUName(Args, ToolChain.getTriple());
389   if (!CPU.empty())
390     CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=mcpu=") + CPU));
391 
392   if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
393     // The optimization level matches
394     // CompilerInvocation.cpp:getOptimizationLevel().
395     StringRef OOpt;
396     if (A->getOption().matches(options::OPT_O4) ||
397         A->getOption().matches(options::OPT_Ofast))
398       OOpt = "3";
399     else if (A->getOption().matches(options::OPT_O)) {
400       OOpt = A->getValue();
401       if (OOpt == "g")
402         OOpt = "1";
403       else if (OOpt == "s" || OOpt == "z")
404         OOpt = "2";
405     } else if (A->getOption().matches(options::OPT_O0))
406       OOpt = "0";
407     if (!OOpt.empty())
408       CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=O") + OOpt));
409   }
410 
411   if (Args.hasArg(options::OPT_gsplit_dwarf)) {
412     CmdArgs.push_back(
413         Args.MakeArgString(Twine("-plugin-opt=dwo_dir=") +
414             Output.getFilename() + "_dwo"));
415   }
416 
417   if (IsThinLTO)
418     CmdArgs.push_back("-plugin-opt=thinlto");
419 
420   StringRef Parallelism = getLTOParallelism(Args, ToolChain.getDriver());
421   if (!Parallelism.empty())
422     CmdArgs.push_back(
423         Args.MakeArgString("-plugin-opt=jobs=" + Twine(Parallelism)));
424 
425   // If an explicit debugger tuning argument appeared, pass it along.
426   if (Arg *A = Args.getLastArg(options::OPT_gTune_Group,
427                                options::OPT_ggdbN_Group)) {
428     if (A->getOption().matches(options::OPT_glldb))
429       CmdArgs.push_back("-plugin-opt=-debugger-tune=lldb");
430     else if (A->getOption().matches(options::OPT_gsce))
431       CmdArgs.push_back("-plugin-opt=-debugger-tune=sce");
432     else
433       CmdArgs.push_back("-plugin-opt=-debugger-tune=gdb");
434   }
435 
436   bool UseSeparateSections =
437       isUseSeparateSections(ToolChain.getEffectiveTriple());
438 
439   if (Args.hasFlag(options::OPT_ffunction_sections,
440                    options::OPT_fno_function_sections, UseSeparateSections)) {
441     CmdArgs.push_back("-plugin-opt=-function-sections");
442   }
443 
444   if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
445                    UseSeparateSections)) {
446     CmdArgs.push_back("-plugin-opt=-data-sections");
447   }
448 
449   if (Arg *A = getLastProfileSampleUseArg(Args)) {
450     StringRef FName = A->getValue();
451     if (!llvm::sys::fs::exists(FName))
452       ToolChain.getDriver().Diag(diag::err_drv_no_such_file) << FName;
453     else
454       CmdArgs.push_back(
455           Args.MakeArgString(Twine("-plugin-opt=sample-profile=") + FName));
456   }
457 
458   auto *CSPGOGenerateArg = Args.getLastArg(options::OPT_fcs_profile_generate,
459                                            options::OPT_fcs_profile_generate_EQ,
460                                            options::OPT_fno_profile_generate);
461   if (CSPGOGenerateArg &&
462       CSPGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
463     CSPGOGenerateArg = nullptr;
464 
465   auto *ProfileUseArg = getLastProfileUseArg(Args);
466 
467   if (CSPGOGenerateArg) {
468     CmdArgs.push_back(Args.MakeArgString("-plugin-opt=cs-profile-generate"));
469     if (CSPGOGenerateArg->getOption().matches(
470             options::OPT_fcs_profile_generate_EQ)) {
471       SmallString<128> Path(CSPGOGenerateArg->getValue());
472       llvm::sys::path::append(Path, "default_%m.profraw");
473       CmdArgs.push_back(
474           Args.MakeArgString(Twine("-plugin-opt=cs-profile-path=") + Path));
475     } else
476       CmdArgs.push_back(
477           Args.MakeArgString("-plugin-opt=cs-profile-path=default_%m.profraw"));
478   } else if (ProfileUseArg) {
479     SmallString<128> Path(
480         ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
481     if (Path.empty() || llvm::sys::fs::is_directory(Path))
482       llvm::sys::path::append(Path, "default.profdata");
483     CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=cs-profile-path=") +
484                                          Path));
485   }
486 
487   // Need this flag to turn on new pass manager via Gold plugin.
488   if (Args.hasFlag(options::OPT_fexperimental_new_pass_manager,
489                    options::OPT_fno_experimental_new_pass_manager,
490                    /* Default */ ENABLE_EXPERIMENTAL_NEW_PASS_MANAGER)) {
491     CmdArgs.push_back("-plugin-opt=new-pass-manager");
492   }
493 
494   // Setup statistics file output.
495   SmallString<128> StatsFile =
496       getStatsFileName(Args, Output, Input, ToolChain.getDriver());
497   if (!StatsFile.empty())
498     CmdArgs.push_back(
499         Args.MakeArgString(Twine("-plugin-opt=stats-file=") + StatsFile));
500 }
501 
502 void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
503                                  ArgStringList &CmdArgs) {
504   if (!Args.hasFlag(options::OPT_frtlib_add_rpath,
505                     options::OPT_fno_rtlib_add_rpath, false))
506     return;
507 
508   std::string CandidateRPath = TC.getArchSpecificLibPath();
509   if (TC.getVFS().exists(CandidateRPath)) {
510     CmdArgs.push_back("-rpath");
511     CmdArgs.push_back(Args.MakeArgString(CandidateRPath.c_str()));
512   }
513 }
514 
515 bool tools::addOpenMPRuntime(ArgStringList &CmdArgs, const ToolChain &TC,
516                              const ArgList &Args, bool ForceStaticHostRuntime,
517                              bool IsOffloadingHost, bool GompNeedsRT) {
518   if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
519                     options::OPT_fno_openmp, false))
520     return false;
521 
522   Driver::OpenMPRuntimeKind RTKind = TC.getDriver().getOpenMPRuntime(Args);
523 
524   if (RTKind == Driver::OMPRT_Unknown)
525     // Already diagnosed.
526     return false;
527 
528   if (ForceStaticHostRuntime)
529     CmdArgs.push_back("-Bstatic");
530 
531   switch (RTKind) {
532   case Driver::OMPRT_OMP:
533     CmdArgs.push_back("-lomp");
534     break;
535   case Driver::OMPRT_GOMP:
536     CmdArgs.push_back("-lgomp");
537     break;
538   case Driver::OMPRT_IOMP5:
539     CmdArgs.push_back("-liomp5");
540     break;
541   case Driver::OMPRT_Unknown:
542     break;
543   }
544 
545   if (ForceStaticHostRuntime)
546     CmdArgs.push_back("-Bdynamic");
547 
548   if (RTKind == Driver::OMPRT_GOMP && GompNeedsRT)
549       CmdArgs.push_back("-lrt");
550 
551   if (IsOffloadingHost)
552     CmdArgs.push_back("-lomptarget");
553 
554   addArchSpecificRPath(TC, Args, CmdArgs);
555 
556   return true;
557 }
558 
559 static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
560                                 ArgStringList &CmdArgs, StringRef Sanitizer,
561                                 bool IsShared, bool IsWhole) {
562   // Wrap any static runtimes that must be forced into executable in
563   // whole-archive.
564   if (IsWhole) CmdArgs.push_back("--whole-archive");
565   CmdArgs.push_back(TC.getCompilerRTArgString(
566       Args, Sanitizer, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static));
567   if (IsWhole) CmdArgs.push_back("--no-whole-archive");
568 
569   if (IsShared) {
570     addArchSpecificRPath(TC, Args, CmdArgs);
571   }
572 }
573 
574 // Tries to use a file with the list of dynamic symbols that need to be exported
575 // from the runtime library. Returns true if the file was found.
576 static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
577                                     ArgStringList &CmdArgs,
578                                     StringRef Sanitizer) {
579   // Solaris ld defaults to --export-dynamic behaviour but doesn't support
580   // the option, so don't try to pass it.
581   if (TC.getTriple().getOS() == llvm::Triple::Solaris)
582     return true;
583   // Myriad is static linking only.  Furthermore, some versions of its
584   // linker have the bug where --export-dynamic overrides -static, so
585   // don't use --export-dynamic on that platform.
586   if (TC.getTriple().getVendor() == llvm::Triple::Myriad)
587     return true;
588   SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
589   if (llvm::sys::fs::exists(SanRT + ".syms")) {
590     CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
591     return true;
592   }
593   return false;
594 }
595 
596 void tools::linkSanitizerRuntimeDeps(const ToolChain &TC,
597                                      ArgStringList &CmdArgs) {
598   // Fuchsia never needs these.  Any sanitizer runtimes with system
599   // dependencies use the `.deplibs` feature instead.
600   if (TC.getTriple().isOSFuchsia())
601     return;
602 
603   // Force linking against the system libraries sanitizers depends on
604   // (see PR15823 why this is necessary).
605   CmdArgs.push_back("--no-as-needed");
606   // There's no libpthread or librt on RTEMS & Android.
607   if (TC.getTriple().getOS() != llvm::Triple::RTEMS &&
608       !TC.getTriple().isAndroid()) {
609     CmdArgs.push_back("-lpthread");
610     if (!TC.getTriple().isOSOpenBSD())
611       CmdArgs.push_back("-lrt");
612   }
613   CmdArgs.push_back("-lm");
614   // There's no libdl on all OSes.
615   if (!TC.getTriple().isOSFreeBSD() &&
616       !TC.getTriple().isOSNetBSD() &&
617       !TC.getTriple().isOSOpenBSD() &&
618        TC.getTriple().getOS() != llvm::Triple::RTEMS)
619     CmdArgs.push_back("-ldl");
620   // Required for backtrace on some OSes
621   if (TC.getTriple().isOSFreeBSD() ||
622       TC.getTriple().isOSNetBSD())
623     CmdArgs.push_back("-lexecinfo");
624 }
625 
626 static void
627 collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
628                          SmallVectorImpl<StringRef> &SharedRuntimes,
629                          SmallVectorImpl<StringRef> &StaticRuntimes,
630                          SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
631                          SmallVectorImpl<StringRef> &HelperStaticRuntimes,
632                          SmallVectorImpl<StringRef> &RequiredSymbols) {
633   const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
634   // Collect shared runtimes.
635   if (SanArgs.needsSharedRt()) {
636     if (SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
637       SharedRuntimes.push_back("asan");
638       if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
639         HelperStaticRuntimes.push_back("asan-preinit");
640     }
641     if (SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
642       if (SanArgs.requiresMinimalRuntime())
643         SharedRuntimes.push_back("ubsan_minimal");
644       else
645         SharedRuntimes.push_back("ubsan_standalone");
646     }
647     if (SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
648       if (SanArgs.requiresMinimalRuntime())
649         SharedRuntimes.push_back("scudo_minimal");
650       else
651         SharedRuntimes.push_back("scudo");
652     }
653     if (SanArgs.needsHwasanRt() && SanArgs.linkRuntimes())
654       SharedRuntimes.push_back("hwasan");
655   }
656 
657   // The stats_client library is also statically linked into DSOs.
658   if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes())
659     StaticRuntimes.push_back("stats_client");
660 
661   // Collect static runtimes.
662   if (Args.hasArg(options::OPT_shared)) {
663     // Don't link static runtimes into DSOs.
664     return;
665   }
666 
667   // Each static runtime that has a DSO counterpart above is excluded below,
668   // but runtimes that exist only as static are not affected by needsSharedRt.
669 
670   if (!SanArgs.needsSharedRt() && SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
671     StaticRuntimes.push_back("asan");
672     if (SanArgs.linkCXXRuntimes())
673       StaticRuntimes.push_back("asan_cxx");
674   }
675 
676   if (!SanArgs.needsSharedRt() && SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
677     StaticRuntimes.push_back("hwasan");
678     if (SanArgs.linkCXXRuntimes())
679       StaticRuntimes.push_back("hwasan_cxx");
680   }
681   if (SanArgs.needsDfsanRt() && SanArgs.linkRuntimes())
682     StaticRuntimes.push_back("dfsan");
683   if (SanArgs.needsLsanRt() && SanArgs.linkRuntimes())
684     StaticRuntimes.push_back("lsan");
685   if (SanArgs.needsMsanRt() && SanArgs.linkRuntimes()) {
686     StaticRuntimes.push_back("msan");
687     if (SanArgs.linkCXXRuntimes())
688       StaticRuntimes.push_back("msan_cxx");
689   }
690   if (SanArgs.needsTsanRt() && SanArgs.linkRuntimes()) {
691     StaticRuntimes.push_back("tsan");
692     if (SanArgs.linkCXXRuntimes())
693       StaticRuntimes.push_back("tsan_cxx");
694   }
695   if (!SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
696     if (SanArgs.requiresMinimalRuntime()) {
697       StaticRuntimes.push_back("ubsan_minimal");
698     } else {
699       StaticRuntimes.push_back("ubsan_standalone");
700       if (SanArgs.linkCXXRuntimes())
701         StaticRuntimes.push_back("ubsan_standalone_cxx");
702     }
703   }
704   if (SanArgs.needsSafeStackRt() && SanArgs.linkRuntimes()) {
705     NonWholeStaticRuntimes.push_back("safestack");
706     RequiredSymbols.push_back("__safestack_init");
707   }
708   if (!(SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes())) {
709     if (SanArgs.needsCfiRt() && SanArgs.linkRuntimes())
710       StaticRuntimes.push_back("cfi");
711     if (SanArgs.needsCfiDiagRt() && SanArgs.linkRuntimes()) {
712       StaticRuntimes.push_back("cfi_diag");
713       if (SanArgs.linkCXXRuntimes())
714         StaticRuntimes.push_back("ubsan_standalone_cxx");
715     }
716   }
717   if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes()) {
718     NonWholeStaticRuntimes.push_back("stats");
719     RequiredSymbols.push_back("__sanitizer_stats_register");
720   }
721   if (!SanArgs.needsSharedRt() && SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
722     if (SanArgs.requiresMinimalRuntime()) {
723       StaticRuntimes.push_back("scudo_minimal");
724       if (SanArgs.linkCXXRuntimes())
725         StaticRuntimes.push_back("scudo_cxx_minimal");
726     } else {
727       StaticRuntimes.push_back("scudo");
728       if (SanArgs.linkCXXRuntimes())
729         StaticRuntimes.push_back("scudo_cxx");
730     }
731   }
732 }
733 
734 // Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
735 // C runtime, etc). Returns true if sanitizer system deps need to be linked in.
736 bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
737                                  ArgStringList &CmdArgs) {
738   SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
739       NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
740   collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
741                            NonWholeStaticRuntimes, HelperStaticRuntimes,
742                            RequiredSymbols);
743 
744   const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
745   // Inject libfuzzer dependencies.
746   if (SanArgs.needsFuzzer() && SanArgs.linkRuntimes() &&
747       !Args.hasArg(options::OPT_shared)) {
748 
749     addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
750     if (!Args.hasArg(clang::driver::options::OPT_nostdlibxx))
751       TC.AddCXXStdlibLibArgs(Args, CmdArgs);
752   }
753 
754   for (auto RT : SharedRuntimes)
755     addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
756   for (auto RT : HelperStaticRuntimes)
757     addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
758   bool AddExportDynamic = false;
759   for (auto RT : StaticRuntimes) {
760     addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
761     AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
762   }
763   for (auto RT : NonWholeStaticRuntimes) {
764     addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
765     AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
766   }
767   for (auto S : RequiredSymbols) {
768     CmdArgs.push_back("-u");
769     CmdArgs.push_back(Args.MakeArgString(S));
770   }
771   // If there is a static runtime with no dynamic list, force all the symbols
772   // to be dynamic to be sure we export sanitizer interface functions.
773   if (AddExportDynamic)
774     CmdArgs.push_back("--export-dynamic");
775 
776   if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
777     CmdArgs.push_back("--export-dynamic-symbol=__cfi_check");
778 
779   return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty();
780 }
781 
782 bool tools::addXRayRuntime(const ToolChain&TC, const ArgList &Args, ArgStringList &CmdArgs) {
783   if (Args.hasArg(options::OPT_shared))
784     return false;
785 
786   if (TC.getXRayArgs().needsXRayRt()) {
787     CmdArgs.push_back("-whole-archive");
788     CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray"));
789     for (const auto &Mode : TC.getXRayArgs().modeList())
790       CmdArgs.push_back(TC.getCompilerRTArgString(Args, Mode));
791     CmdArgs.push_back("-no-whole-archive");
792     return true;
793   }
794 
795   return false;
796 }
797 
798 void tools::linkXRayRuntimeDeps(const ToolChain &TC, ArgStringList &CmdArgs) {
799   CmdArgs.push_back("--no-as-needed");
800   CmdArgs.push_back("-lpthread");
801   if (!TC.getTriple().isOSOpenBSD())
802     CmdArgs.push_back("-lrt");
803   CmdArgs.push_back("-lm");
804 
805   if (!TC.getTriple().isOSFreeBSD() &&
806       !TC.getTriple().isOSNetBSD() &&
807       !TC.getTriple().isOSOpenBSD())
808     CmdArgs.push_back("-ldl");
809 }
810 
811 bool tools::areOptimizationsEnabled(const ArgList &Args) {
812   // Find the last -O arg and see if it is non-zero.
813   if (Arg *A = Args.getLastArg(options::OPT_O_Group))
814     return !A->getOption().matches(options::OPT_O0);
815   // Defaults to -O0.
816   return false;
817 }
818 
819 const char *tools::SplitDebugName(const ArgList &Args, const InputInfo &Input,
820                                   const InputInfo &Output) {
821   if (Arg *A = Args.getLastArg(options::OPT_gsplit_dwarf_EQ))
822     if (StringRef(A->getValue()) == "single")
823       return Args.MakeArgString(Output.getFilename());
824 
825   Arg *FinalOutput = Args.getLastArg(options::OPT_o);
826   if (FinalOutput && Args.hasArg(options::OPT_c)) {
827     SmallString<128> T(FinalOutput->getValue());
828     llvm::sys::path::replace_extension(T, "dwo");
829     return Args.MakeArgString(T);
830   } else {
831     // Use the compilation dir.
832     SmallString<128> T(
833         Args.getLastArgValue(options::OPT_fdebug_compilation_dir));
834     SmallString<128> F(llvm::sys::path::stem(Input.getBaseInput()));
835     llvm::sys::path::replace_extension(F, "dwo");
836     T += F;
837     return Args.MakeArgString(F);
838   }
839 }
840 
841 void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
842                            const JobAction &JA, const ArgList &Args,
843                            const InputInfo &Output, const char *OutFile) {
844   ArgStringList ExtractArgs;
845   ExtractArgs.push_back("--extract-dwo");
846 
847   ArgStringList StripArgs;
848   StripArgs.push_back("--strip-dwo");
849 
850   // Grabbing the output of the earlier compile step.
851   StripArgs.push_back(Output.getFilename());
852   ExtractArgs.push_back(Output.getFilename());
853   ExtractArgs.push_back(OutFile);
854 
855   const char *Exec =
856       Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
857   InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
858 
859   // First extract the dwo sections.
860   C.addCommand(std::make_unique<Command>(JA, T, Exec, ExtractArgs, II));
861 
862   // Then remove them from the original .o file.
863   C.addCommand(std::make_unique<Command>(JA, T, Exec, StripArgs, II));
864 }
865 
866 // Claim options we don't want to warn if they are unused. We do this for
867 // options that build systems might add but are unused when assembling or only
868 // running the preprocessor for example.
869 void tools::claimNoWarnArgs(const ArgList &Args) {
870   // Don't warn about unused -f(no-)?lto.  This can happen when we're
871   // preprocessing, precompiling or assembling.
872   Args.ClaimAllArgs(options::OPT_flto_EQ);
873   Args.ClaimAllArgs(options::OPT_flto);
874   Args.ClaimAllArgs(options::OPT_fno_lto);
875 }
876 
877 Arg *tools::getLastProfileUseArg(const ArgList &Args) {
878   auto *ProfileUseArg = Args.getLastArg(
879       options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
880       options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
881       options::OPT_fno_profile_instr_use);
882 
883   if (ProfileUseArg &&
884       ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
885     ProfileUseArg = nullptr;
886 
887   return ProfileUseArg;
888 }
889 
890 Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
891   auto *ProfileSampleUseArg = Args.getLastArg(
892       options::OPT_fprofile_sample_use, options::OPT_fprofile_sample_use_EQ,
893       options::OPT_fauto_profile, options::OPT_fauto_profile_EQ,
894       options::OPT_fno_profile_sample_use, options::OPT_fno_auto_profile);
895 
896   if (ProfileSampleUseArg &&
897       (ProfileSampleUseArg->getOption().matches(
898            options::OPT_fno_profile_sample_use) ||
899        ProfileSampleUseArg->getOption().matches(options::OPT_fno_auto_profile)))
900     return nullptr;
901 
902   return Args.getLastArg(options::OPT_fprofile_sample_use_EQ,
903                          options::OPT_fauto_profile_EQ);
904 }
905 
906 /// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments.  Then,
907 /// smooshes them together with platform defaults, to decide whether
908 /// this compile should be using PIC mode or not. Returns a tuple of
909 /// (RelocationModel, PICLevel, IsPIE).
910 std::tuple<llvm::Reloc::Model, unsigned, bool>
911 tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
912   const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
913   const llvm::Triple &Triple = ToolChain.getTriple();
914 
915   bool PIE = ToolChain.isPIEDefault();
916   bool PIC = PIE || ToolChain.isPICDefault();
917   // The Darwin/MachO default to use PIC does not apply when using -static.
918   if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
919     PIE = PIC = false;
920   bool IsPICLevelTwo = PIC;
921 
922   bool KernelOrKext =
923       Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
924 
925   // Android-specific defaults for PIC/PIE
926   if (Triple.isAndroid()) {
927     switch (Triple.getArch()) {
928     case llvm::Triple::arm:
929     case llvm::Triple::armeb:
930     case llvm::Triple::thumb:
931     case llvm::Triple::thumbeb:
932     case llvm::Triple::aarch64:
933     case llvm::Triple::mips:
934     case llvm::Triple::mipsel:
935     case llvm::Triple::mips64:
936     case llvm::Triple::mips64el:
937       PIC = true; // "-fpic"
938       break;
939 
940     case llvm::Triple::x86:
941     case llvm::Triple::x86_64:
942       PIC = true; // "-fPIC"
943       IsPICLevelTwo = true;
944       break;
945 
946     default:
947       break;
948     }
949   }
950 
951   // OpenBSD-specific defaults for PIE
952   if (Triple.isOSOpenBSD()) {
953     switch (ToolChain.getArch()) {
954     case llvm::Triple::arm:
955     case llvm::Triple::aarch64:
956     case llvm::Triple::mips64:
957     case llvm::Triple::mips64el:
958     case llvm::Triple::x86:
959     case llvm::Triple::x86_64:
960       IsPICLevelTwo = false; // "-fpie"
961       break;
962 
963     case llvm::Triple::ppc:
964     case llvm::Triple::sparc:
965     case llvm::Triple::sparcel:
966     case llvm::Triple::sparcv9:
967       IsPICLevelTwo = true; // "-fPIE"
968       break;
969 
970     default:
971       break;
972     }
973   }
974 
975   // AMDGPU-specific defaults for PIC.
976   if (Triple.getArch() == llvm::Triple::amdgcn)
977     PIC = true;
978 
979   // The last argument relating to either PIC or PIE wins, and no
980   // other argument is used. If the last argument is any flavor of the
981   // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
982   // option implicitly enables PIC at the same level.
983   Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
984                                     options::OPT_fpic, options::OPT_fno_pic,
985                                     options::OPT_fPIE, options::OPT_fno_PIE,
986                                     options::OPT_fpie, options::OPT_fno_pie);
987   if (Triple.isOSWindows() && LastPICArg &&
988       LastPICArg ==
989           Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
990                           options::OPT_fPIE, options::OPT_fpie)) {
991     ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
992         << LastPICArg->getSpelling() << Triple.str();
993     if (Triple.getArch() == llvm::Triple::x86_64)
994       return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
995     return std::make_tuple(llvm::Reloc::Static, 0U, false);
996   }
997 
998   // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
999   // is forced, then neither PIC nor PIE flags will have no effect.
1000   if (!ToolChain.isPICDefaultForced()) {
1001     if (LastPICArg) {
1002       Option O = LastPICArg->getOption();
1003       if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
1004           O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
1005         PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
1006         PIC =
1007             PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
1008         IsPICLevelTwo =
1009             O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
1010       } else {
1011         PIE = PIC = false;
1012         if (EffectiveTriple.isPS4CPU()) {
1013           Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
1014           StringRef Model = ModelArg ? ModelArg->getValue() : "";
1015           if (Model != "kernel") {
1016             PIC = true;
1017             ToolChain.getDriver().Diag(diag::warn_drv_ps4_force_pic)
1018                 << LastPICArg->getSpelling();
1019           }
1020         }
1021       }
1022     }
1023   }
1024 
1025   // Introduce a Darwin and PS4-specific hack. If the default is PIC, but the
1026   // PIC level would've been set to level 1, force it back to level 2 PIC
1027   // instead.
1028   if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS4CPU()))
1029     IsPICLevelTwo |= ToolChain.isPICDefault();
1030 
1031   // This kernel flags are a trump-card: they will disable PIC/PIE
1032   // generation, independent of the argument order.
1033   if (KernelOrKext &&
1034       ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
1035        !EffectiveTriple.isWatchOS()))
1036     PIC = PIE = false;
1037 
1038   if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
1039     // This is a very special mode. It trumps the other modes, almost no one
1040     // uses it, and it isn't even valid on any OS but Darwin.
1041     if (!Triple.isOSDarwin())
1042       ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1043           << A->getSpelling() << Triple.str();
1044 
1045     // FIXME: Warn when this flag trumps some other PIC or PIE flag.
1046 
1047     // Only a forced PIC mode can cause the actual compile to have PIC defines
1048     // etc., no flags are sufficient. This behavior was selected to closely
1049     // match that of llvm-gcc and Apple GCC before that.
1050     PIC = ToolChain.isPICDefault() && ToolChain.isPICDefaultForced();
1051 
1052     return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
1053   }
1054 
1055   bool EmbeddedPISupported;
1056   switch (Triple.getArch()) {
1057     case llvm::Triple::arm:
1058     case llvm::Triple::armeb:
1059     case llvm::Triple::thumb:
1060     case llvm::Triple::thumbeb:
1061       EmbeddedPISupported = true;
1062       break;
1063     default:
1064       EmbeddedPISupported = false;
1065       break;
1066   }
1067 
1068   bool ROPI = false, RWPI = false;
1069   Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
1070   if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
1071     if (!EmbeddedPISupported)
1072       ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1073           << LastROPIArg->getSpelling() << Triple.str();
1074     ROPI = true;
1075   }
1076   Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
1077   if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
1078     if (!EmbeddedPISupported)
1079       ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1080           << LastRWPIArg->getSpelling() << Triple.str();
1081     RWPI = true;
1082   }
1083 
1084   // ROPI and RWPI are not compatible with PIC or PIE.
1085   if ((ROPI || RWPI) && (PIC || PIE))
1086     ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
1087 
1088   if (Triple.isMIPS()) {
1089     StringRef CPUName;
1090     StringRef ABIName;
1091     mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
1092     // When targeting the N64 ABI, PIC is the default, except in the case
1093     // when the -mno-abicalls option is used. In that case we exit
1094     // at next check regardless of PIC being set below.
1095     if (ABIName == "n64")
1096       PIC = true;
1097     // When targettng MIPS with -mno-abicalls, it's always static.
1098     if(Args.hasArg(options::OPT_mno_abicalls))
1099       return std::make_tuple(llvm::Reloc::Static, 0U, false);
1100     // Unlike other architectures, MIPS, even with -fPIC/-mxgot/multigot,
1101     // does not use PIC level 2 for historical reasons.
1102     IsPICLevelTwo = false;
1103   }
1104 
1105   if (PIC)
1106     return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
1107 
1108   llvm::Reloc::Model RelocM = llvm::Reloc::Static;
1109   if (ROPI && RWPI)
1110     RelocM = llvm::Reloc::ROPI_RWPI;
1111   else if (ROPI)
1112     RelocM = llvm::Reloc::ROPI;
1113   else if (RWPI)
1114     RelocM = llvm::Reloc::RWPI;
1115 
1116   return std::make_tuple(RelocM, 0U, false);
1117 }
1118 
1119 // `-falign-functions` indicates that the functions should be aligned to a
1120 // 16-byte boundary.
1121 //
1122 // `-falign-functions=1` is the same as `-fno-align-functions`.
1123 //
1124 // The scalar `n` in `-falign-functions=n` must be an integral value between
1125 // [0, 65536].  If the value is not a power-of-two, it will be rounded up to
1126 // the nearest power-of-two.
1127 //
1128 // If we return `0`, the frontend will default to the backend's preferred
1129 // alignment.
1130 //
1131 // NOTE: icc only allows values between [0, 4096].  icc uses `-falign-functions`
1132 // to mean `-falign-functions=16`.  GCC defaults to the backend's preferred
1133 // alignment.  For unaligned functions, we default to the backend's preferred
1134 // alignment.
1135 unsigned tools::ParseFunctionAlignment(const ToolChain &TC,
1136                                        const ArgList &Args) {
1137   const Arg *A = Args.getLastArg(options::OPT_falign_functions,
1138                                  options::OPT_falign_functions_EQ,
1139                                  options::OPT_fno_align_functions);
1140   if (!A || A->getOption().matches(options::OPT_fno_align_functions))
1141     return 0;
1142 
1143   if (A->getOption().matches(options::OPT_falign_functions))
1144     return 0;
1145 
1146   unsigned Value = 0;
1147   if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 65536)
1148     TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1149         << A->getAsString(Args) << A->getValue();
1150   return Value ? llvm::Log2_32_Ceil(std::min(Value, 65536u)) : Value;
1151 }
1152 
1153 unsigned tools::ParseDebugDefaultVersion(const ToolChain &TC,
1154                                          const ArgList &Args) {
1155   const Arg *A = Args.getLastArg(options::OPT_fdebug_default_version);
1156 
1157   if (!A)
1158     return 0;
1159 
1160   unsigned Value = 0;
1161   if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 5 ||
1162       Value < 2)
1163     TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1164         << A->getAsString(Args) << A->getValue();
1165   return Value;
1166 }
1167 
1168 void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
1169                              ArgStringList &CmdArgs) {
1170   llvm::Reloc::Model RelocationModel;
1171   unsigned PICLevel;
1172   bool IsPIE;
1173   std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
1174 
1175   if (RelocationModel != llvm::Reloc::Static)
1176     CmdArgs.push_back("-KPIC");
1177 }
1178 
1179 /// Determine whether Objective-C automated reference counting is
1180 /// enabled.
1181 bool tools::isObjCAutoRefCount(const ArgList &Args) {
1182   return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
1183 }
1184 
1185 enum class LibGccType { UnspecifiedLibGcc, StaticLibGcc, SharedLibGcc };
1186 
1187 static LibGccType getLibGccType(const Driver &D, const ArgList &Args) {
1188   if (Args.hasArg(options::OPT_static_libgcc) ||
1189       Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_static_pie))
1190     return LibGccType::StaticLibGcc;
1191   if (Args.hasArg(options::OPT_shared_libgcc) || D.CCCIsCXX())
1192     return LibGccType::SharedLibGcc;
1193   return LibGccType::UnspecifiedLibGcc;
1194 }
1195 
1196 // Gcc adds libgcc arguments in various ways:
1197 //
1198 // gcc <none>:     -lgcc --as-needed -lgcc_s --no-as-needed
1199 // g++ <none>:                       -lgcc_s               -lgcc
1200 // gcc shared:                       -lgcc_s               -lgcc
1201 // g++ shared:                       -lgcc_s               -lgcc
1202 // gcc static:     -lgcc             -lgcc_eh
1203 // g++ static:     -lgcc             -lgcc_eh
1204 // gcc static-pie: -lgcc             -lgcc_eh
1205 // g++ static-pie: -lgcc             -lgcc_eh
1206 //
1207 // Also, certain targets need additional adjustments.
1208 
1209 static void AddUnwindLibrary(const ToolChain &TC, const Driver &D,
1210                              ArgStringList &CmdArgs, const ArgList &Args) {
1211   ToolChain::UnwindLibType UNW = TC.GetUnwindLibType(Args);
1212   // Targets that don't use unwind libraries.
1213   if (TC.getTriple().isAndroid() || TC.getTriple().isOSIAMCU() ||
1214       TC.getTriple().isOSBinFormatWasm() ||
1215       UNW == ToolChain::UNW_None)
1216     return;
1217 
1218   LibGccType LGT = getLibGccType(D, Args);
1219   bool AsNeeded = LGT == LibGccType::UnspecifiedLibGcc &&
1220                   !TC.getTriple().isAndroid() && !TC.getTriple().isOSCygMing();
1221   if (AsNeeded)
1222     CmdArgs.push_back("--as-needed");
1223 
1224   switch (UNW) {
1225   case ToolChain::UNW_None:
1226     return;
1227   case ToolChain::UNW_Libgcc: {
1228     if (LGT == LibGccType::StaticLibGcc)
1229       CmdArgs.push_back("-lgcc_eh");
1230     else
1231       CmdArgs.push_back("-lgcc_s");
1232     break;
1233   }
1234   case ToolChain::UNW_CompilerRT:
1235     if (LGT == LibGccType::StaticLibGcc)
1236       CmdArgs.push_back("-l:libunwind.a");
1237     else
1238       CmdArgs.push_back("-l:libunwind.so");
1239     break;
1240   }
1241 
1242   if (AsNeeded)
1243     CmdArgs.push_back("--no-as-needed");
1244 }
1245 
1246 static void AddLibgcc(const ToolChain &TC, const Driver &D,
1247                       ArgStringList &CmdArgs, const ArgList &Args) {
1248   LibGccType LGT = getLibGccType(D, Args);
1249   if (LGT != LibGccType::SharedLibGcc)
1250     CmdArgs.push_back("-lgcc");
1251   AddUnwindLibrary(TC, D, CmdArgs, Args);
1252   if (LGT == LibGccType::SharedLibGcc)
1253     CmdArgs.push_back("-lgcc");
1254 
1255   // According to Android ABI, we have to link with libdl if we are
1256   // linking with non-static libgcc.
1257   //
1258   // NOTE: This fixes a link error on Android MIPS as well.  The non-static
1259   // libgcc for MIPS relies on _Unwind_Find_FDE and dl_iterate_phdr from libdl.
1260   if (TC.getTriple().isAndroid() && LGT != LibGccType::StaticLibGcc)
1261     CmdArgs.push_back("-ldl");
1262 }
1263 
1264 void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
1265                            ArgStringList &CmdArgs, const ArgList &Args) {
1266   // Make use of compiler-rt if --rtlib option is used
1267   ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(Args);
1268 
1269   switch (RLT) {
1270   case ToolChain::RLT_CompilerRT:
1271     CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
1272     AddUnwindLibrary(TC, D, CmdArgs, Args);
1273     break;
1274   case ToolChain::RLT_Libgcc:
1275     // Make sure libgcc is not used under MSVC environment by default
1276     if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
1277       // Issue error diagnostic if libgcc is explicitly specified
1278       // through command line as --rtlib option argument.
1279       if (Args.hasArg(options::OPT_rtlib_EQ)) {
1280         TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
1281             << Args.getLastArg(options::OPT_rtlib_EQ)->getValue() << "MSVC";
1282       }
1283     } else
1284       AddLibgcc(TC, D, CmdArgs, Args);
1285     break;
1286   }
1287 }
1288 
1289 /// Add HIP linker script arguments at the end of the argument list so that
1290 /// the fat binary is built by embedding the device images into the host. The
1291 /// linker script also defines a symbol required by the code generation so that
1292 /// the image can be retrieved at runtime. This should be used only in tool
1293 /// chains that support linker scripts.
1294 void tools::AddHIPLinkerScript(const ToolChain &TC, Compilation &C,
1295                                const InputInfo &Output,
1296                                const InputInfoList &Inputs, const ArgList &Args,
1297                                ArgStringList &CmdArgs, const JobAction &JA,
1298                                const Tool &T) {
1299 
1300   // If this is not a HIP host toolchain, we don't need to do anything.
1301   if (!JA.isHostOffloading(Action::OFK_HIP))
1302     return;
1303 
1304   InputInfoList DeviceInputs;
1305   for (const auto &II : Inputs) {
1306     const Action *A = II.getAction();
1307     // Is this a device linking action?
1308     if (A && isa<LinkJobAction>(A) && A->isDeviceOffloading(Action::OFK_HIP)) {
1309       DeviceInputs.push_back(II);
1310     }
1311   }
1312 
1313   if (DeviceInputs.empty())
1314     return;
1315 
1316   // Create temporary linker script. Keep it if save-temps is enabled.
1317   const char *LKS;
1318   std::string Name =
1319       std::string(llvm::sys::path::filename(Output.getFilename()));
1320   if (C.getDriver().isSaveTempsEnabled()) {
1321     LKS = C.getArgs().MakeArgString(Name + ".lk");
1322   } else {
1323     auto TmpName = C.getDriver().GetTemporaryPath(Name, "lk");
1324     LKS = C.addTempFile(C.getArgs().MakeArgString(TmpName));
1325   }
1326 
1327   // Add linker script option to the command.
1328   CmdArgs.push_back("-T");
1329   CmdArgs.push_back(LKS);
1330 
1331   // Create a buffer to write the contents of the linker script.
1332   std::string LksBuffer;
1333   llvm::raw_string_ostream LksStream(LksBuffer);
1334 
1335   // Get the HIP offload tool chain.
1336   auto *HIPTC = static_cast<const toolchains::HIPToolChain *>(
1337       C.getSingleOffloadToolChain<Action::OFK_HIP>());
1338   assert(HIPTC->getTriple().getArch() == llvm::Triple::amdgcn &&
1339          "Wrong platform");
1340   (void)HIPTC;
1341 
1342   const char *BundleFile;
1343   if (C.getDriver().isSaveTempsEnabled()) {
1344     BundleFile = C.getArgs().MakeArgString(Name + ".hipfb");
1345   } else {
1346     auto TmpName = C.getDriver().GetTemporaryPath(Name, "hipfb");
1347     BundleFile = C.addTempFile(C.getArgs().MakeArgString(TmpName));
1348   }
1349   AMDGCN::constructHIPFatbinCommand(C, JA, BundleFile, DeviceInputs, Args, T);
1350 
1351   // Add commands to embed target binaries. We ensure that each section and
1352   // image is 16-byte aligned. This is not mandatory, but increases the
1353   // likelihood of data to be aligned with a cache block in several main host
1354   // machines.
1355   LksStream << "/*\n";
1356   LksStream << "       HIP Offload Linker Script\n";
1357   LksStream << " *** Automatically generated by Clang ***\n";
1358   LksStream << "*/\n";
1359   LksStream << "TARGET(binary)\n";
1360   LksStream << "INPUT(" << BundleFile << ")\n";
1361   LksStream << "SECTIONS\n";
1362   LksStream << "{\n";
1363   LksStream << "  .hip_fatbin :\n";
1364   LksStream << "  ALIGN(0x10)\n";
1365   LksStream << "  {\n";
1366   LksStream << "    PROVIDE_HIDDEN(__hip_fatbin = .);\n";
1367   LksStream << "    " << BundleFile << "\n";
1368   LksStream << "  }\n";
1369   LksStream << "  /DISCARD/ :\n";
1370   LksStream << "  {\n";
1371   LksStream << "    * ( __CLANG_OFFLOAD_BUNDLE__* )\n";
1372   LksStream << "  }\n";
1373   LksStream << "}\n";
1374   LksStream << "INSERT BEFORE .data\n";
1375   LksStream.flush();
1376 
1377   // Dump the contents of the linker script if the user requested that. We
1378   // support this option to enable testing of behavior with -###.
1379   if (C.getArgs().hasArg(options::OPT_fhip_dump_offload_linker_script))
1380     llvm::errs() << LksBuffer;
1381 
1382   // If this is a dry run, do not create the linker script file.
1383   if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH))
1384     return;
1385 
1386   // Open script file and write the contents.
1387   std::error_code EC;
1388   llvm::raw_fd_ostream Lksf(LKS, EC, llvm::sys::fs::OF_None);
1389 
1390   if (EC) {
1391     C.getDriver().Diag(clang::diag::err_unable_to_make_temp) << EC.message();
1392     return;
1393   }
1394 
1395   Lksf << LksBuffer;
1396 }
1397 
1398 SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
1399                                          const InputInfo &Output,
1400                                          const InputInfo &Input,
1401                                          const Driver &D) {
1402   const Arg *A = Args.getLastArg(options::OPT_save_stats_EQ);
1403   if (!A)
1404     return {};
1405 
1406   StringRef SaveStats = A->getValue();
1407   SmallString<128> StatsFile;
1408   if (SaveStats == "obj" && Output.isFilename()) {
1409     StatsFile.assign(Output.getFilename());
1410     llvm::sys::path::remove_filename(StatsFile);
1411   } else if (SaveStats != "cwd") {
1412     D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
1413     return {};
1414   }
1415 
1416   StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
1417   llvm::sys::path::append(StatsFile, BaseName);
1418   llvm::sys::path::replace_extension(StatsFile, "stats");
1419   return StatsFile;
1420 }
1421 
1422 void tools::addMultilibFlag(bool Enabled, const char *const Flag,
1423                             Multilib::flags_list &Flags) {
1424   Flags.push_back(std::string(Enabled ? "+" : "-") + Flag);
1425 }
1426