clang  14.0.0git
CommonArgs.cpp
Go to the documentation of this file.
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/M68k.h"
13 #include "Arch/Mips.h"
14 #include "Arch/PPC.h"
15 #include "Arch/SystemZ.h"
16 #include "Arch/VE.h"
17 #include "Arch/X86.h"
18 #include "HIP.h"
19 #include "Hexagon.h"
20 #include "clang/Basic/CharInfo.h"
23 #include "clang/Basic/Version.h"
24 #include "clang/Config/config.h"
25 #include "clang/Driver/Action.h"
27 #include "clang/Driver/Driver.h"
29 #include "clang/Driver/InputInfo.h"
30 #include "clang/Driver/Job.h"
31 #include "clang/Driver/Options.h"
33 #include "clang/Driver/ToolChain.h"
34 #include "clang/Driver/Util.h"
35 #include "clang/Driver/XRayArgs.h"
36 #include "llvm/ADT/STLExtras.h"
37 #include "llvm/ADT/SmallSet.h"
38 #include "llvm/ADT/SmallString.h"
39 #include "llvm/ADT/StringExtras.h"
40 #include "llvm/ADT/StringSwitch.h"
41 #include "llvm/ADT/Twine.h"
42 #include "llvm/Config/llvm-config.h"
43 #include "llvm/Option/Arg.h"
44 #include "llvm/Option/ArgList.h"
45 #include "llvm/Option/Option.h"
46 #include "llvm/Support/CodeGen.h"
47 #include "llvm/Support/Compression.h"
48 #include "llvm/Support/Debug.h"
49 #include "llvm/Support/ErrorHandling.h"
50 #include "llvm/Support/FileSystem.h"
51 #include "llvm/Support/Host.h"
52 #include "llvm/Support/Path.h"
53 #include "llvm/Support/Process.h"
54 #include "llvm/Support/Program.h"
55 #include "llvm/Support/ScopedPrinter.h"
56 #include "llvm/Support/TargetParser.h"
57 #include "llvm/Support/Threading.h"
58 #include "llvm/Support/VirtualFileSystem.h"
59 #include "llvm/Support/YAMLParser.h"
60 
61 using namespace clang::driver;
62 using namespace clang::driver::tools;
63 using namespace clang;
64 using namespace llvm::opt;
65 
66 static void renderRpassOptions(const ArgList &Args, ArgStringList &CmdArgs) {
67  if (const Arg *A = Args.getLastArg(options::OPT_Rpass_EQ))
68  CmdArgs.push_back(Args.MakeArgString(Twine("--plugin-opt=-pass-remarks=") +
69  A->getValue()));
70 
71  if (const Arg *A = Args.getLastArg(options::OPT_Rpass_missed_EQ))
72  CmdArgs.push_back(Args.MakeArgString(
73  Twine("--plugin-opt=-pass-remarks-missed=") + A->getValue()));
74 
75  if (const Arg *A = Args.getLastArg(options::OPT_Rpass_analysis_EQ))
76  CmdArgs.push_back(Args.MakeArgString(
77  Twine("--plugin-opt=-pass-remarks-analysis=") + A->getValue()));
78 }
79 
80 static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
81  const llvm::Triple &Triple,
82  const InputInfo &Input,
83  const InputInfo &Output) {
84  StringRef Format = "yaml";
85  if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
86  Format = A->getValue();
87 
89  const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
90  if (A)
91  F = A->getValue();
92  else if (Output.isFilename())
93  F = Output.getFilename();
94 
95  assert(!F.empty() && "Cannot determine remarks output name.");
96  // Append "opt.ld.<format>" to the end of the file name.
97  CmdArgs.push_back(
98  Args.MakeArgString(Twine("--plugin-opt=opt-remarks-filename=") + F +
99  Twine(".opt.ld.") + Format));
100 
101  if (const Arg *A =
102  Args.getLastArg(options::OPT_foptimization_record_passes_EQ))
103  CmdArgs.push_back(Args.MakeArgString(
104  Twine("--plugin-opt=opt-remarks-passes=") + A->getValue()));
105 
106  CmdArgs.push_back(Args.MakeArgString(
107  Twine("--plugin-opt=opt-remarks-format=") + Format.data()));
108 }
109 
110 static void renderRemarksHotnessOptions(const ArgList &Args,
111  ArgStringList &CmdArgs) {
112  if (Args.hasFlag(options::OPT_fdiagnostics_show_hotness,
113  options::OPT_fno_diagnostics_show_hotness, false))
114  CmdArgs.push_back("--plugin-opt=opt-remarks-with-hotness");
115 
116  if (const Arg *A =
117  Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ))
118  CmdArgs.push_back(Args.MakeArgString(
119  Twine("--plugin-opt=opt-remarks-hotness-threshold=") + A->getValue()));
120 }
121 
122 void tools::addPathIfExists(const Driver &D, const Twine &Path,
123  ToolChain::path_list &Paths) {
124  if (D.getVFS().exists(Path))
125  Paths.push_back(Path.str());
126 }
127 
128 void tools::handleTargetFeaturesGroup(const ArgList &Args,
129  std::vector<StringRef> &Features,
130  OptSpecifier Group) {
131  for (const Arg *A : Args.filtered(Group)) {
132  StringRef Name = A->getOption().getName();
133  A->claim();
134 
135  // Skip over "-m".
136  assert(Name.startswith("m") && "Invalid feature name.");
137  Name = Name.substr(1);
138 
139  bool IsNegative = Name.startswith("no-");
140  if (IsNegative)
141  Name = Name.substr(3);
142  Features.push_back(Args.MakeArgString((IsNegative ? "-" : "+") + Name));
143  }
144 }
145 
146 std::vector<StringRef>
147 tools::unifyTargetFeatures(const std::vector<StringRef> &Features) {
148  std::vector<StringRef> UnifiedFeatures;
149  // Find the last of each feature.
150  llvm::StringMap<unsigned> LastOpt;
151  for (unsigned I = 0, N = Features.size(); I < N; ++I) {
152  StringRef Name = Features[I];
153  assert(Name[0] == '-' || Name[0] == '+');
154  LastOpt[Name.drop_front(1)] = I;
155  }
156 
157  for (unsigned I = 0, N = Features.size(); I < N; ++I) {
158  // If this feature was overridden, ignore it.
159  StringRef Name = Features[I];
160  llvm::StringMap<unsigned>::iterator LastI = LastOpt.find(Name.drop_front(1));
161  assert(LastI != LastOpt.end());
162  unsigned Last = LastI->second;
163  if (Last != I)
164  continue;
165 
166  UnifiedFeatures.push_back(Name);
167  }
168  return UnifiedFeatures;
169 }
170 
171 void tools::addDirectoryList(const ArgList &Args, ArgStringList &CmdArgs,
172  const char *ArgName, const char *EnvVar) {
173  const char *DirList = ::getenv(EnvVar);
174  bool CombinedArg = false;
175 
176  if (!DirList)
177  return; // Nothing to do.
178 
179  StringRef Name(ArgName);
180  if (Name.equals("-I") || Name.equals("-L") || Name.empty())
181  CombinedArg = true;
182 
183  StringRef Dirs(DirList);
184  if (Dirs.empty()) // Empty string should not add '.'.
185  return;
186 
187  StringRef::size_type Delim;
188  while ((Delim = Dirs.find(llvm::sys::EnvPathSeparator)) != StringRef::npos) {
189  if (Delim == 0) { // Leading colon.
190  if (CombinedArg) {
191  CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
192  } else {
193  CmdArgs.push_back(ArgName);
194  CmdArgs.push_back(".");
195  }
196  } else {
197  if (CombinedArg) {
198  CmdArgs.push_back(
199  Args.MakeArgString(std::string(ArgName) + Dirs.substr(0, Delim)));
200  } else {
201  CmdArgs.push_back(ArgName);
202  CmdArgs.push_back(Args.MakeArgString(Dirs.substr(0, Delim)));
203  }
204  }
205  Dirs = Dirs.substr(Delim + 1);
206  }
207 
208  if (Dirs.empty()) { // Trailing colon.
209  if (CombinedArg) {
210  CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
211  } else {
212  CmdArgs.push_back(ArgName);
213  CmdArgs.push_back(".");
214  }
215  } else { // Add the last path.
216  if (CombinedArg) {
217  CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + Dirs));
218  } else {
219  CmdArgs.push_back(ArgName);
220  CmdArgs.push_back(Args.MakeArgString(Dirs));
221  }
222  }
223 }
224 
225 void tools::AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
226  const ArgList &Args, ArgStringList &CmdArgs,
227  const JobAction &JA) {
228  const Driver &D = TC.getDriver();
229 
230  // Add extra linker input arguments which are not treated as inputs
231  // (constructed via -Xarch_).
232  Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
233 
234  // LIBRARY_PATH are included before user inputs and only supported on native
235  // toolchains.
236  if (!TC.isCrossCompiling())
237  addDirectoryList(Args, CmdArgs, "-L", "LIBRARY_PATH");
238 
239  for (const auto &II : Inputs) {
240  // If the current tool chain refers to an OpenMP offloading host, we
241  // should ignore inputs that refer to OpenMP offloading devices -
242  // they will be embedded according to a proper linker script.
243  if (auto *IA = II.getAction())
245  IA->isDeviceOffloading(Action::OFK_OpenMP)))
246  continue;
247 
248  if (!TC.HasNativeLLVMSupport() && types::isLLVMIR(II.getType()))
249  // Don't try to pass LLVM inputs unless we have native support.
250  D.Diag(diag::err_drv_no_linker_llvm_support) << TC.getTripleString();
251 
252  // Add filenames immediately.
253  if (II.isFilename()) {
254  CmdArgs.push_back(II.getFilename());
255  continue;
256  }
257 
258  // Otherwise, this is a linker input argument.
259  const Arg &A = II.getInputArg();
260 
261  // Handle reserved library options.
262  if (A.getOption().matches(options::OPT_Z_reserved_lib_stdcxx))
263  TC.AddCXXStdlibLibArgs(Args, CmdArgs);
264  else if (A.getOption().matches(options::OPT_Z_reserved_lib_cckext))
265  TC.AddCCKextLibArgs(Args, CmdArgs);
266  else if (A.getOption().matches(options::OPT_z)) {
267  // Pass -z prefix for gcc linker compatibility.
268  A.claim();
269  A.render(Args, CmdArgs);
270  } else if (A.getOption().matches(options::OPT_b)) {
271  const llvm::Triple &T = TC.getTriple();
272  if (!T.isOSAIX()) {
273  TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
274  << A.getSpelling() << T.str();
275  }
276  // Pass -b prefix for AIX linker.
277  A.claim();
278  A.render(Args, CmdArgs);
279  } else {
280  A.renderAsInput(Args, CmdArgs);
281  }
282  }
283 }
284 
286  const ToolChain &TC, const llvm::opt::ArgList &Args,
287  llvm::opt::ArgStringList &CmdArgs) {
288  // GNU ld supports --compress-debug-sections=none|zlib|zlib-gnu|zlib-gabi
289  // whereas zlib is an alias to zlib-gabi. Therefore -gz=none|zlib|zlib-gnu
290  // are translated to --compress-debug-sections=none|zlib|zlib-gnu.
291  // -gz is not translated since ld --compress-debug-sections option requires an
292  // argument.
293  if (const Arg *A = Args.getLastArg(options::OPT_gz_EQ)) {
294  StringRef V = A->getValue();
295  if (V == "none" || V == "zlib" || V == "zlib-gnu")
296  CmdArgs.push_back(Args.MakeArgString("--compress-debug-sections=" + V));
297  else
298  TC.getDriver().Diag(diag::err_drv_unsupported_option_argument)
299  << A->getOption().getName() << V;
300  }
301 }
302 
303 void tools::AddTargetFeature(const ArgList &Args,
304  std::vector<StringRef> &Features,
305  OptSpecifier OnOpt, OptSpecifier OffOpt,
306  StringRef FeatureName) {
307  if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
308  if (A->getOption().matches(OnOpt))
309  Features.push_back(Args.MakeArgString("+" + FeatureName));
310  else
311  Features.push_back(Args.MakeArgString("-" + FeatureName));
312  }
313 }
314 
315 /// Get the (LLVM) name of the AMDGPU gpu we are targeting.
316 static std::string getAMDGPUTargetGPU(const llvm::Triple &T,
317  const ArgList &Args) {
318  if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
319  auto GPUName = getProcessorFromTargetID(T, A->getValue());
320  return llvm::StringSwitch<std::string>(GPUName)
321  .Cases("rv630", "rv635", "r600")
322  .Cases("rv610", "rv620", "rs780", "rs880")
323  .Case("rv740", "rv770")
324  .Case("palm", "cedar")
325  .Cases("sumo", "sumo2", "sumo")
326  .Case("hemlock", "cypress")
327  .Case("aruba", "cayman")
328  .Default(GPUName.str());
329  }
330  return "";
331 }
332 
333 static std::string getLanaiTargetCPU(const ArgList &Args) {
334  if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
335  return A->getValue();
336  }
337  return "";
338 }
339 
340 /// Get the (LLVM) name of the WebAssembly cpu we are targeting.
341 static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
342  // If we have -mcpu=, use that.
343  if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
344  StringRef CPU = A->getValue();
345 
346 #ifdef __wasm__
347  // Handle "native" by examining the host. "native" isn't meaningful when
348  // cross compiling, so only support this when the host is also WebAssembly.
349  if (CPU == "native")
350  return llvm::sys::getHostCPUName();
351 #endif
352 
353  return CPU;
354  }
355 
356  return "generic";
357 }
358 
359 std::string tools::getCPUName(const Driver &D, const ArgList &Args,
360  const llvm::Triple &T, bool FromAs) {
361  Arg *A;
362 
363  switch (T.getArch()) {
364  default:
365  return "";
366 
367  case llvm::Triple::aarch64:
368  case llvm::Triple::aarch64_32:
369  case llvm::Triple::aarch64_be:
370  return aarch64::getAArch64TargetCPU(Args, T, A);
371 
372  case llvm::Triple::arm:
373  case llvm::Triple::armeb:
374  case llvm::Triple::thumb:
375  case llvm::Triple::thumbeb: {
376  StringRef MArch, MCPU;
377  arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
378  return arm::getARMTargetCPU(MCPU, MArch, T);
379  }
380 
381  case llvm::Triple::avr:
382  if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
383  return A->getValue();
384  return "";
385 
386  case llvm::Triple::m68k:
387  return m68k::getM68kTargetCPU(Args);
388 
389  case llvm::Triple::mips:
390  case llvm::Triple::mipsel:
391  case llvm::Triple::mips64:
392  case llvm::Triple::mips64el: {
393  StringRef CPUName;
394  StringRef ABIName;
395  mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
396  return std::string(CPUName);
397  }
398 
399  case llvm::Triple::nvptx:
400  case llvm::Triple::nvptx64:
401  if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
402  return A->getValue();
403  return "";
404 
405  case llvm::Triple::ppc:
406  case llvm::Triple::ppcle:
407  case llvm::Triple::ppc64:
408  case llvm::Triple::ppc64le: {
409  std::string TargetCPUName = ppc::getPPCTargetCPU(Args);
410  // LLVM may default to generating code for the native CPU,
411  // but, like gcc, we default to a more generic option for
412  // each architecture. (except on AIX)
413  if (!TargetCPUName.empty())
414  return TargetCPUName;
415 
416  if (T.isOSAIX())
417  TargetCPUName = "pwr7";
418  else if (T.getArch() == llvm::Triple::ppc64le)
419  TargetCPUName = "ppc64le";
420  else if (T.getArch() == llvm::Triple::ppc64)
421  TargetCPUName = "ppc64";
422  else
423  TargetCPUName = "ppc";
424 
425  return TargetCPUName;
426  }
427  case llvm::Triple::riscv32:
428  case llvm::Triple::riscv64:
429  if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
430  return A->getValue();
431  return "";
432 
433  case llvm::Triple::bpfel:
434  case llvm::Triple::bpfeb:
435  case llvm::Triple::sparc:
436  case llvm::Triple::sparcel:
437  case llvm::Triple::sparcv9:
438  if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
439  return A->getValue();
440  if (T.getArch() == llvm::Triple::sparc && T.isOSSolaris())
441  return "v9";
442  return "";
443 
444  case llvm::Triple::x86:
445  case llvm::Triple::x86_64:
446  return x86::getX86TargetCPU(D, Args, T);
447 
448  case llvm::Triple::hexagon:
449  return "hexagon" +
451 
452  case llvm::Triple::lanai:
453  return getLanaiTargetCPU(Args);
454 
455  case llvm::Triple::systemz:
456  return systemz::getSystemZTargetCPU(Args);
457 
458  case llvm::Triple::r600:
459  case llvm::Triple::amdgcn:
460  return getAMDGPUTargetGPU(T, Args);
461 
462  case llvm::Triple::wasm32:
463  case llvm::Triple::wasm64:
464  return std::string(getWebAssemblyTargetCPU(Args));
465  }
466 }
467 
468 llvm::StringRef tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
469  Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
470  if (!LtoJobsArg)
471  return {};
472  if (!llvm::get_threadpool_strategy(LtoJobsArg->getValue()))
473  D.Diag(diag::err_drv_invalid_int_value)
474  << LtoJobsArg->getAsString(Args) << LtoJobsArg->getValue();
475  return LtoJobsArg->getValue();
476 }
477 
478 // CloudABI uses -ffunction-sections and -fdata-sections by default.
479 bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
480  return Triple.getOS() == llvm::Triple::CloudABI;
481 }
482 
483 void tools::addLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
484  ArgStringList &CmdArgs, const InputInfo &Output,
485  const InputInfo &Input, bool IsThinLTO) {
486  const char *Linker = Args.MakeArgString(ToolChain.GetLinkerPath());
487  const Driver &D = ToolChain.getDriver();
488  if (llvm::sys::path::filename(Linker) != "ld.lld" &&
489  llvm::sys::path::stem(Linker) != "ld.lld") {
490  // Tell the linker to load the plugin. This has to come before
491  // AddLinkerInputs as gold requires -plugin to come before any -plugin-opt
492  // that -Wl might forward.
493  CmdArgs.push_back("-plugin");
494 
495 #if defined(_WIN32)
496  const char *Suffix = ".dll";
497 #elif defined(__APPLE__)
498  const char *Suffix = ".dylib";
499 #else
500  const char *Suffix = ".so";
501 #endif
502 
503  SmallString<1024> Plugin;
504  llvm::sys::path::native(
505  Twine(D.Dir) + "/../lib" CLANG_LIBDIR_SUFFIX "/LLVMgold" + Suffix,
506  Plugin);
507  CmdArgs.push_back(Args.MakeArgString(Plugin));
508  }
509 
510  // Try to pass driver level flags relevant to LTO code generation down to
511  // the plugin.
512 
513  // Handle flags for selecting CPU variants.
514  std::string CPU = getCPUName(D, Args, ToolChain.getTriple());
515  if (!CPU.empty())
516  CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=mcpu=") + CPU));
517 
518  if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
519  // The optimization level matches
520  // CompilerInvocation.cpp:getOptimizationLevel().
521  StringRef OOpt;
522  if (A->getOption().matches(options::OPT_O4) ||
523  A->getOption().matches(options::OPT_Ofast))
524  OOpt = "3";
525  else if (A->getOption().matches(options::OPT_O)) {
526  OOpt = A->getValue();
527  if (OOpt == "g")
528  OOpt = "1";
529  else if (OOpt == "s" || OOpt == "z")
530  OOpt = "2";
531  } else if (A->getOption().matches(options::OPT_O0))
532  OOpt = "0";
533  if (!OOpt.empty())
534  CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=O") + OOpt));
535  }
536 
537  if (Args.hasArg(options::OPT_gsplit_dwarf)) {
538  CmdArgs.push_back(
539  Args.MakeArgString(Twine("-plugin-opt=dwo_dir=") +
540  Output.getFilename() + "_dwo"));
541  }
542 
543  if (IsThinLTO)
544  CmdArgs.push_back("-plugin-opt=thinlto");
545 
546  StringRef Parallelism = getLTOParallelism(Args, D);
547  if (!Parallelism.empty())
548  CmdArgs.push_back(
549  Args.MakeArgString("-plugin-opt=jobs=" + Twine(Parallelism)));
550 
551  // If an explicit debugger tuning argument appeared, pass it along.
552  if (Arg *A = Args.getLastArg(options::OPT_gTune_Group,
553  options::OPT_ggdbN_Group)) {
554  if (A->getOption().matches(options::OPT_glldb))
555  CmdArgs.push_back("-plugin-opt=-debugger-tune=lldb");
556  else if (A->getOption().matches(options::OPT_gsce))
557  CmdArgs.push_back("-plugin-opt=-debugger-tune=sce");
558  else if (A->getOption().matches(options::OPT_gdbx))
559  CmdArgs.push_back("-plugin-opt=-debugger-tune=dbx");
560  else
561  CmdArgs.push_back("-plugin-opt=-debugger-tune=gdb");
562  }
563 
564  bool UseSeparateSections =
566 
567  if (Args.hasFlag(options::OPT_ffunction_sections,
568  options::OPT_fno_function_sections, UseSeparateSections)) {
569  CmdArgs.push_back("-plugin-opt=-function-sections");
570  }
571 
572  if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
573  UseSeparateSections)) {
574  CmdArgs.push_back("-plugin-opt=-data-sections");
575  }
576 
577  if (Arg *A = getLastProfileSampleUseArg(Args)) {
578  StringRef FName = A->getValue();
579  if (!llvm::sys::fs::exists(FName))
580  D.Diag(diag::err_drv_no_such_file) << FName;
581  else
582  CmdArgs.push_back(
583  Args.MakeArgString(Twine("-plugin-opt=sample-profile=") + FName));
584  }
585 
586  auto *CSPGOGenerateArg = Args.getLastArg(options::OPT_fcs_profile_generate,
587  options::OPT_fcs_profile_generate_EQ,
588  options::OPT_fno_profile_generate);
589  if (CSPGOGenerateArg &&
590  CSPGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
591  CSPGOGenerateArg = nullptr;
592 
593  auto *ProfileUseArg = getLastProfileUseArg(Args);
594 
595  if (CSPGOGenerateArg) {
596  CmdArgs.push_back(Args.MakeArgString("-plugin-opt=cs-profile-generate"));
597  if (CSPGOGenerateArg->getOption().matches(
598  options::OPT_fcs_profile_generate_EQ)) {
599  SmallString<128> Path(CSPGOGenerateArg->getValue());
600  llvm::sys::path::append(Path, "default_%m.profraw");
601  CmdArgs.push_back(
602  Args.MakeArgString(Twine("-plugin-opt=cs-profile-path=") + Path));
603  } else
604  CmdArgs.push_back(
605  Args.MakeArgString("-plugin-opt=cs-profile-path=default_%m.profraw"));
606  } else if (ProfileUseArg) {
607  SmallString<128> Path(
608  ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
609  if (Path.empty() || llvm::sys::fs::is_directory(Path))
610  llvm::sys::path::append(Path, "default.profdata");
611  CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=cs-profile-path=") +
612  Path));
613  }
614 
615  // Pass an option to enable/disable the new pass manager.
616  if (auto *A = Args.getLastArg(options::OPT_flegacy_pass_manager,
617  options::OPT_fno_legacy_pass_manager)) {
618  if (A->getOption().matches(options::OPT_flegacy_pass_manager))
619  CmdArgs.push_back("-plugin-opt=legacy-pass-manager");
620  else
621  CmdArgs.push_back("-plugin-opt=new-pass-manager");
622  }
623 
624  // Setup statistics file output.
625  SmallString<128> StatsFile = getStatsFileName(Args, Output, Input, D);
626  if (!StatsFile.empty())
627  CmdArgs.push_back(
628  Args.MakeArgString(Twine("-plugin-opt=stats-file=") + StatsFile));
629 
630  addX86AlignBranchArgs(D, Args, CmdArgs, /*IsLTO=*/true);
631 
632  // Handle remark diagnostics on screen options: '-Rpass-*'.
633  renderRpassOptions(Args, CmdArgs);
634 
635  // Handle serialized remarks options: '-fsave-optimization-record'
636  // and '-foptimization-record-*'.
637  if (willEmitRemarks(Args))
638  renderRemarksOptions(Args, CmdArgs, ToolChain.getEffectiveTriple(), Input,
639  Output);
640 
641  // Handle remarks hotness/threshold related options.
642  renderRemarksHotnessOptions(Args, CmdArgs);
643 
645  /*IsLTO=*/true);
646 }
647 
648 void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
649  ArgStringList &CmdArgs) {
650  // Enable -frtlib-add-rpath by default for the case of VE.
651  const bool IsVE = TC.getTriple().isVE();
652  bool DefaultValue = IsVE;
653  if (!Args.hasFlag(options::OPT_frtlib_add_rpath,
654  options::OPT_fno_rtlib_add_rpath, DefaultValue))
655  return;
656 
657  std::string CandidateRPath = TC.getArchSpecificLibPath();
658  if (TC.getVFS().exists(CandidateRPath)) {
659  CmdArgs.push_back("-rpath");
660  CmdArgs.push_back(Args.MakeArgString(CandidateRPath));
661  }
662 }
663 
664 bool tools::addOpenMPRuntime(ArgStringList &CmdArgs, const ToolChain &TC,
665  const ArgList &Args, bool ForceStaticHostRuntime,
666  bool IsOffloadingHost, bool GompNeedsRT) {
667  if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
668  options::OPT_fno_openmp, false))
669  return false;
670 
672 
673  if (RTKind == Driver::OMPRT_Unknown)
674  // Already diagnosed.
675  return false;
676 
677  if (ForceStaticHostRuntime)
678  CmdArgs.push_back("-Bstatic");
679 
680  switch (RTKind) {
681  case Driver::OMPRT_OMP:
682  CmdArgs.push_back("-lomp");
683  break;
684  case Driver::OMPRT_GOMP:
685  CmdArgs.push_back("-lgomp");
686  break;
687  case Driver::OMPRT_IOMP5:
688  CmdArgs.push_back("-liomp5");
689  break;
691  break;
692  }
693 
694  if (ForceStaticHostRuntime)
695  CmdArgs.push_back("-Bdynamic");
696 
697  if (RTKind == Driver::OMPRT_GOMP && GompNeedsRT)
698  CmdArgs.push_back("-lrt");
699 
700  if (IsOffloadingHost)
701  CmdArgs.push_back("-lomptarget");
702 
703  addArchSpecificRPath(TC, Args, CmdArgs);
704 
705  return true;
706 }
707 
708 static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
709  ArgStringList &CmdArgs, StringRef Sanitizer,
710  bool IsShared, bool IsWhole) {
711  // Wrap any static runtimes that must be forced into executable in
712  // whole-archive.
713  if (IsWhole) CmdArgs.push_back("--whole-archive");
714  CmdArgs.push_back(TC.getCompilerRTArgString(
715  Args, Sanitizer, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static));
716  if (IsWhole) CmdArgs.push_back("--no-whole-archive");
717 
718  if (IsShared) {
719  addArchSpecificRPath(TC, Args, CmdArgs);
720  }
721 }
722 
723 // Tries to use a file with the list of dynamic symbols that need to be exported
724 // from the runtime library. Returns true if the file was found.
725 static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
726  ArgStringList &CmdArgs,
727  StringRef Sanitizer) {
728  // Solaris ld defaults to --export-dynamic behaviour but doesn't support
729  // the option, so don't try to pass it.
730  if (TC.getTriple().getOS() == llvm::Triple::Solaris)
731  return true;
732  SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
733  if (llvm::sys::fs::exists(SanRT + ".syms")) {
734  CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
735  return true;
736  }
737  return false;
738 }
739 
740 static const char *getAsNeededOption(const ToolChain &TC, bool as_needed) {
741  assert(!TC.getTriple().isOSAIX() &&
742  "AIX linker does not support any form of --as-needed option yet.");
743 
744  // While the Solaris 11.2 ld added --as-needed/--no-as-needed as aliases
745  // for the native forms -z ignore/-z record, they are missing in Illumos,
746  // so always use the native form.
747  if (TC.getTriple().isOSSolaris())
748  return as_needed ? "-zignore" : "-zrecord";
749  else
750  return as_needed ? "--as-needed" : "--no-as-needed";
751 }
752 
754  ArgStringList &CmdArgs) {
755  // Fuchsia never needs these. Any sanitizer runtimes with system
756  // dependencies use the `.deplibs` feature instead.
757  if (TC.getTriple().isOSFuchsia())
758  return;
759 
760  // Force linking against the system libraries sanitizers depends on
761  // (see PR15823 why this is necessary).
762  CmdArgs.push_back(getAsNeededOption(TC, false));
763  // There's no libpthread or librt on RTEMS & Android.
764  if (TC.getTriple().getOS() != llvm::Triple::RTEMS &&
765  !TC.getTriple().isAndroid()) {
766  CmdArgs.push_back("-lpthread");
767  if (!TC.getTriple().isOSOpenBSD())
768  CmdArgs.push_back("-lrt");
769  }
770  CmdArgs.push_back("-lm");
771  // There's no libdl on all OSes.
772  if (!TC.getTriple().isOSFreeBSD() && !TC.getTriple().isOSNetBSD() &&
773  !TC.getTriple().isOSOpenBSD() &&
774  TC.getTriple().getOS() != llvm::Triple::RTEMS)
775  CmdArgs.push_back("-ldl");
776  // Required for backtrace on some OSes
777  if (TC.getTriple().isOSFreeBSD() ||
778  TC.getTriple().isOSNetBSD() ||
779  TC.getTriple().isOSOpenBSD())
780  CmdArgs.push_back("-lexecinfo");
781 }
782 
783 static void
784 collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
785  SmallVectorImpl<StringRef> &SharedRuntimes,
786  SmallVectorImpl<StringRef> &StaticRuntimes,
787  SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
788  SmallVectorImpl<StringRef> &HelperStaticRuntimes,
789  SmallVectorImpl<StringRef> &RequiredSymbols) {
790  const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
791  // Collect shared runtimes.
792  if (SanArgs.needsSharedRt()) {
793  if (SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
794  SharedRuntimes.push_back("asan");
795  if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
796  HelperStaticRuntimes.push_back("asan-preinit");
797  }
798  if (SanArgs.needsMemProfRt() && SanArgs.linkRuntimes()) {
799  SharedRuntimes.push_back("memprof");
800  if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
801  HelperStaticRuntimes.push_back("memprof-preinit");
802  }
803  if (SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
804  if (SanArgs.requiresMinimalRuntime())
805  SharedRuntimes.push_back("ubsan_minimal");
806  else
807  SharedRuntimes.push_back("ubsan_standalone");
808  }
809  if (SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
810  if (SanArgs.requiresMinimalRuntime())
811  SharedRuntimes.push_back("scudo_minimal");
812  else
813  SharedRuntimes.push_back("scudo");
814  }
815  if (SanArgs.needsTsanRt() && SanArgs.linkRuntimes())
816  SharedRuntimes.push_back("tsan");
817  if (SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
818  if (SanArgs.needsHwasanAliasesRt())
819  SharedRuntimes.push_back("hwasan_aliases");
820  else
821  SharedRuntimes.push_back("hwasan");
822  }
823  }
824 
825  // The stats_client library is also statically linked into DSOs.
826  if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes())
827  StaticRuntimes.push_back("stats_client");
828 
829  // Collect static runtimes.
830  if (Args.hasArg(options::OPT_shared)) {
831  // Don't link static runtimes into DSOs.
832  return;
833  }
834 
835  // Each static runtime that has a DSO counterpart above is excluded below,
836  // but runtimes that exist only as static are not affected by needsSharedRt.
837 
838  if (!SanArgs.needsSharedRt() && SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
839  StaticRuntimes.push_back("asan");
840  if (SanArgs.linkCXXRuntimes())
841  StaticRuntimes.push_back("asan_cxx");
842  }
843 
844  if (!SanArgs.needsSharedRt() && SanArgs.needsMemProfRt() &&
845  SanArgs.linkRuntimes()) {
846  StaticRuntimes.push_back("memprof");
847  if (SanArgs.linkCXXRuntimes())
848  StaticRuntimes.push_back("memprof_cxx");
849  }
850 
851  if (!SanArgs.needsSharedRt() && SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
852  if (SanArgs.needsHwasanAliasesRt()) {
853  StaticRuntimes.push_back("hwasan_aliases");
854  if (SanArgs.linkCXXRuntimes())
855  StaticRuntimes.push_back("hwasan_aliases_cxx");
856  } else {
857  StaticRuntimes.push_back("hwasan");
858  if (SanArgs.linkCXXRuntimes())
859  StaticRuntimes.push_back("hwasan_cxx");
860  }
861  }
862  if (SanArgs.needsDfsanRt() && SanArgs.linkRuntimes())
863  StaticRuntimes.push_back("dfsan");
864  if (SanArgs.needsLsanRt() && SanArgs.linkRuntimes())
865  StaticRuntimes.push_back("lsan");
866  if (SanArgs.needsMsanRt() && SanArgs.linkRuntimes()) {
867  StaticRuntimes.push_back("msan");
868  if (SanArgs.linkCXXRuntimes())
869  StaticRuntimes.push_back("msan_cxx");
870  }
871  if (!SanArgs.needsSharedRt() && SanArgs.needsTsanRt() &&
872  SanArgs.linkRuntimes()) {
873  StaticRuntimes.push_back("tsan");
874  if (SanArgs.linkCXXRuntimes())
875  StaticRuntimes.push_back("tsan_cxx");
876  }
877  if (!SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
878  if (SanArgs.requiresMinimalRuntime()) {
879  StaticRuntimes.push_back("ubsan_minimal");
880  } else {
881  StaticRuntimes.push_back("ubsan_standalone");
882  if (SanArgs.linkCXXRuntimes())
883  StaticRuntimes.push_back("ubsan_standalone_cxx");
884  }
885  }
886  if (SanArgs.needsSafeStackRt() && SanArgs.linkRuntimes()) {
887  NonWholeStaticRuntimes.push_back("safestack");
888  RequiredSymbols.push_back("__safestack_init");
889  }
890  if (!(SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes())) {
891  if (SanArgs.needsCfiRt() && SanArgs.linkRuntimes())
892  StaticRuntimes.push_back("cfi");
893  if (SanArgs.needsCfiDiagRt() && SanArgs.linkRuntimes()) {
894  StaticRuntimes.push_back("cfi_diag");
895  if (SanArgs.linkCXXRuntimes())
896  StaticRuntimes.push_back("ubsan_standalone_cxx");
897  }
898  }
899  if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes()) {
900  NonWholeStaticRuntimes.push_back("stats");
901  RequiredSymbols.push_back("__sanitizer_stats_register");
902  }
903  if (!SanArgs.needsSharedRt() && SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
904  if (SanArgs.requiresMinimalRuntime()) {
905  StaticRuntimes.push_back("scudo_minimal");
906  if (SanArgs.linkCXXRuntimes())
907  StaticRuntimes.push_back("scudo_cxx_minimal");
908  } else {
909  StaticRuntimes.push_back("scudo");
910  if (SanArgs.linkCXXRuntimes())
911  StaticRuntimes.push_back("scudo_cxx");
912  }
913  }
914 }
915 
916 // Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
917 // C runtime, etc). Returns true if sanitizer system deps need to be linked in.
918 bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
919  ArgStringList &CmdArgs) {
920  SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
921  NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
922  collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
923  NonWholeStaticRuntimes, HelperStaticRuntimes,
924  RequiredSymbols);
925 
926  const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
927  // Inject libfuzzer dependencies.
928  if (SanArgs.needsFuzzer() && SanArgs.linkRuntimes() &&
929  !Args.hasArg(options::OPT_shared)) {
930 
931  addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
932  if (SanArgs.needsFuzzerInterceptors())
933  addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer_interceptors", false,
934  true);
935  if (!Args.hasArg(clang::driver::options::OPT_nostdlibxx)) {
936  bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
937  !Args.hasArg(options::OPT_static);
938  if (OnlyLibstdcxxStatic)
939  CmdArgs.push_back("-Bstatic");
940  TC.AddCXXStdlibLibArgs(Args, CmdArgs);
941  if (OnlyLibstdcxxStatic)
942  CmdArgs.push_back("-Bdynamic");
943  }
944  }
945 
946  for (auto RT : SharedRuntimes)
947  addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
948  for (auto RT : HelperStaticRuntimes)
949  addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
950  bool AddExportDynamic = false;
951  for (auto RT : StaticRuntimes) {
952  addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
953  AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
954  }
955  for (auto RT : NonWholeStaticRuntimes) {
956  addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
957  AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
958  }
959  for (auto S : RequiredSymbols) {
960  CmdArgs.push_back("-u");
961  CmdArgs.push_back(Args.MakeArgString(S));
962  }
963  // If there is a static runtime with no dynamic list, force all the symbols
964  // to be dynamic to be sure we export sanitizer interface functions.
965  if (AddExportDynamic)
966  CmdArgs.push_back("--export-dynamic");
967 
968  if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
969  CmdArgs.push_back("--export-dynamic-symbol=__cfi_check");
970 
971  return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty();
972 }
973 
974 bool tools::addXRayRuntime(const ToolChain&TC, const ArgList &Args, ArgStringList &CmdArgs) {
975  if (Args.hasArg(options::OPT_shared))
976  return false;
977 
978  if (TC.getXRayArgs().needsXRayRt()) {
979  CmdArgs.push_back("-whole-archive");
980  CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray"));
981  for (const auto &Mode : TC.getXRayArgs().modeList())
982  CmdArgs.push_back(TC.getCompilerRTArgString(Args, Mode));
983  CmdArgs.push_back("-no-whole-archive");
984  return true;
985  }
986 
987  return false;
988 }
989 
990 void tools::linkXRayRuntimeDeps(const ToolChain &TC, ArgStringList &CmdArgs) {
991  CmdArgs.push_back(getAsNeededOption(TC, false));
992  CmdArgs.push_back("-lpthread");
993  if (!TC.getTriple().isOSOpenBSD())
994  CmdArgs.push_back("-lrt");
995  CmdArgs.push_back("-lm");
996 
997  if (!TC.getTriple().isOSFreeBSD() &&
998  !TC.getTriple().isOSNetBSD() &&
999  !TC.getTriple().isOSOpenBSD())
1000  CmdArgs.push_back("-ldl");
1001 }
1002 
1003 bool tools::areOptimizationsEnabled(const ArgList &Args) {
1004  // Find the last -O arg and see if it is non-zero.
1005  if (Arg *A = Args.getLastArg(options::OPT_O_Group))
1006  return !A->getOption().matches(options::OPT_O0);
1007  // Defaults to -O0.
1008  return false;
1009 }
1010 
1011 const char *tools::SplitDebugName(const JobAction &JA, const ArgList &Args,
1012  const InputInfo &Input,
1013  const InputInfo &Output) {
1014  auto AddPostfix = [JA](auto &F) {
1016  F += (Twine("_") + JA.getOffloadingArch()).str();
1017  F += ".dwo";
1018  };
1019  if (Arg *A = Args.getLastArg(options::OPT_gsplit_dwarf_EQ))
1020  if (StringRef(A->getValue()) == "single")
1021  return Args.MakeArgString(Output.getFilename());
1022 
1023  Arg *FinalOutput = Args.getLastArg(options::OPT_o);
1024  if (FinalOutput && Args.hasArg(options::OPT_c)) {
1025  SmallString<128> T(FinalOutput->getValue());
1026  llvm::sys::path::remove_filename(T);
1027  llvm::sys::path::append(T, llvm::sys::path::stem(FinalOutput->getValue()));
1028  AddPostfix(T);
1029  return Args.MakeArgString(T);
1030  } else {
1031  // Use the compilation dir.
1032  Arg *A = Args.getLastArg(options::OPT_ffile_compilation_dir_EQ,
1033  options::OPT_fdebug_compilation_dir_EQ);
1034  SmallString<128> T(A ? A->getValue() : "");
1035  SmallString<128> F(llvm::sys::path::stem(Input.getBaseInput()));
1036  AddPostfix(F);
1037  T += F;
1038  return Args.MakeArgString(T);
1039  }
1040 }
1041 
1042 void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
1043  const JobAction &JA, const ArgList &Args,
1044  const InputInfo &Output, const char *OutFile) {
1045  ArgStringList ExtractArgs;
1046  ExtractArgs.push_back("--extract-dwo");
1047 
1048  ArgStringList StripArgs;
1049  StripArgs.push_back("--strip-dwo");
1050 
1051  // Grabbing the output of the earlier compile step.
1052  StripArgs.push_back(Output.getFilename());
1053  ExtractArgs.push_back(Output.getFilename());
1054  ExtractArgs.push_back(OutFile);
1055 
1056  const char *Exec =
1057  Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
1058  InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
1059 
1060  // First extract the dwo sections.
1061  C.addCommand(std::make_unique<Command>(JA, T,
1063  Exec, ExtractArgs, II, Output));
1064 
1065  // Then remove them from the original .o file.
1066  C.addCommand(std::make_unique<Command>(
1067  JA, T, ResponseFileSupport::AtFileCurCP(), Exec, StripArgs, II, Output));
1068 }
1069 
1070 // Claim options we don't want to warn if they are unused. We do this for
1071 // options that build systems might add but are unused when assembling or only
1072 // running the preprocessor for example.
1073 void tools::claimNoWarnArgs(const ArgList &Args) {
1074  // Don't warn about unused -f(no-)?lto. This can happen when we're
1075  // preprocessing, precompiling or assembling.
1076  Args.ClaimAllArgs(options::OPT_flto_EQ);
1077  Args.ClaimAllArgs(options::OPT_flto);
1078  Args.ClaimAllArgs(options::OPT_fno_lto);
1079 }
1080 
1081 Arg *tools::getLastProfileUseArg(const ArgList &Args) {
1082  auto *ProfileUseArg = Args.getLastArg(
1083  options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
1084  options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
1085  options::OPT_fno_profile_instr_use);
1086 
1087  if (ProfileUseArg &&
1088  ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
1089  ProfileUseArg = nullptr;
1090 
1091  return ProfileUseArg;
1092 }
1093 
1094 Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
1095  auto *ProfileSampleUseArg = Args.getLastArg(
1096  options::OPT_fprofile_sample_use, options::OPT_fprofile_sample_use_EQ,
1097  options::OPT_fauto_profile, options::OPT_fauto_profile_EQ,
1098  options::OPT_fno_profile_sample_use, options::OPT_fno_auto_profile);
1099 
1100  if (ProfileSampleUseArg &&
1101  (ProfileSampleUseArg->getOption().matches(
1102  options::OPT_fno_profile_sample_use) ||
1103  ProfileSampleUseArg->getOption().matches(options::OPT_fno_auto_profile)))
1104  return nullptr;
1105 
1106  return Args.getLastArg(options::OPT_fprofile_sample_use_EQ,
1107  options::OPT_fauto_profile_EQ);
1108 }
1109 
1110 /// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments. Then,
1111 /// smooshes them together with platform defaults, to decide whether
1112 /// this compile should be using PIC mode or not. Returns a tuple of
1113 /// (RelocationModel, PICLevel, IsPIE).
1114 std::tuple<llvm::Reloc::Model, unsigned, bool>
1115 tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
1116  const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
1117  const llvm::Triple &Triple = ToolChain.getTriple();
1118 
1119  bool PIE = ToolChain.isPIEDefault();
1120  bool PIC = PIE || ToolChain.isPICDefault();
1121  // The Darwin/MachO default to use PIC does not apply when using -static.
1122  if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
1123  PIE = PIC = false;
1124  bool IsPICLevelTwo = PIC;
1125 
1126  bool KernelOrKext =
1127  Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
1128 
1129  // Android-specific defaults for PIC/PIE
1130  if (Triple.isAndroid()) {
1131  switch (Triple.getArch()) {
1132  case llvm::Triple::arm:
1133  case llvm::Triple::armeb:
1134  case llvm::Triple::thumb:
1135  case llvm::Triple::thumbeb:
1136  case llvm::Triple::aarch64:
1137  case llvm::Triple::mips:
1138  case llvm::Triple::mipsel:
1139  case llvm::Triple::mips64:
1140  case llvm::Triple::mips64el:
1141  PIC = true; // "-fpic"
1142  break;
1143 
1144  case llvm::Triple::x86:
1145  case llvm::Triple::x86_64:
1146  PIC = true; // "-fPIC"
1147  IsPICLevelTwo = true;
1148  break;
1149 
1150  default:
1151  break;
1152  }
1153  }
1154 
1155  // OpenBSD-specific defaults for PIE
1156  if (Triple.isOSOpenBSD()) {
1157  switch (ToolChain.getArch()) {
1158  case llvm::Triple::arm:
1159  case llvm::Triple::aarch64:
1160  case llvm::Triple::mips64:
1161  case llvm::Triple::mips64el:
1162  case llvm::Triple::x86:
1163  case llvm::Triple::x86_64:
1164  IsPICLevelTwo = false; // "-fpie"
1165  break;
1166 
1167  case llvm::Triple::ppc:
1168  case llvm::Triple::sparcv9:
1169  IsPICLevelTwo = true; // "-fPIE"
1170  break;
1171 
1172  default:
1173  break;
1174  }
1175  }
1176 
1177  // AMDGPU-specific defaults for PIC.
1178  if (Triple.getArch() == llvm::Triple::amdgcn)
1179  PIC = true;
1180 
1181  // The last argument relating to either PIC or PIE wins, and no
1182  // other argument is used. If the last argument is any flavor of the
1183  // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
1184  // option implicitly enables PIC at the same level.
1185  Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
1186  options::OPT_fpic, options::OPT_fno_pic,
1187  options::OPT_fPIE, options::OPT_fno_PIE,
1188  options::OPT_fpie, options::OPT_fno_pie);
1189  if (Triple.isOSWindows() && LastPICArg &&
1190  LastPICArg ==
1191  Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
1192  options::OPT_fPIE, options::OPT_fpie)) {
1193  ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1194  << LastPICArg->getSpelling() << Triple.str();
1195  if (Triple.getArch() == llvm::Triple::x86_64)
1196  return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
1197  return std::make_tuple(llvm::Reloc::Static, 0U, false);
1198  }
1199 
1200  // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
1201  // is forced, then neither PIC nor PIE flags will have no effect.
1202  if (!ToolChain.isPICDefaultForced()) {
1203  if (LastPICArg) {
1204  Option O = LastPICArg->getOption();
1205  if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
1206  O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
1207  PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
1208  PIC =
1209  PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
1210  IsPICLevelTwo =
1211  O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
1212  } else {
1213  PIE = PIC = false;
1214  if (EffectiveTriple.isPS4CPU()) {
1215  Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
1216  StringRef Model = ModelArg ? ModelArg->getValue() : "";
1217  if (Model != "kernel") {
1218  PIC = true;
1219  ToolChain.getDriver().Diag(diag::warn_drv_ps4_force_pic)
1220  << LastPICArg->getSpelling();
1221  }
1222  }
1223  }
1224  }
1225  }
1226 
1227  // Introduce a Darwin and PS4-specific hack. If the default is PIC, but the
1228  // PIC level would've been set to level 1, force it back to level 2 PIC
1229  // instead.
1230  if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS4CPU()))
1231  IsPICLevelTwo |= ToolChain.isPICDefault();
1232 
1233  // This kernel flags are a trump-card: they will disable PIC/PIE
1234  // generation, independent of the argument order.
1235  if (KernelOrKext &&
1236  ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
1237  !EffectiveTriple.isWatchOS()))
1238  PIC = PIE = false;
1239 
1240  if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
1241  // This is a very special mode. It trumps the other modes, almost no one
1242  // uses it, and it isn't even valid on any OS but Darwin.
1243  if (!Triple.isOSDarwin())
1244  ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1245  << A->getSpelling() << Triple.str();
1246 
1247  // FIXME: Warn when this flag trumps some other PIC or PIE flag.
1248 
1249  // Only a forced PIC mode can cause the actual compile to have PIC defines
1250  // etc., no flags are sufficient. This behavior was selected to closely
1251  // match that of llvm-gcc and Apple GCC before that.
1253 
1254  return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
1255  }
1256 
1257  bool EmbeddedPISupported;
1258  switch (Triple.getArch()) {
1259  case llvm::Triple::arm:
1260  case llvm::Triple::armeb:
1261  case llvm::Triple::thumb:
1262  case llvm::Triple::thumbeb:
1263  EmbeddedPISupported = true;
1264  break;
1265  default:
1266  EmbeddedPISupported = false;
1267  break;
1268  }
1269 
1270  bool ROPI = false, RWPI = false;
1271  Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
1272  if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
1273  if (!EmbeddedPISupported)
1274  ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1275  << LastROPIArg->getSpelling() << Triple.str();
1276  ROPI = true;
1277  }
1278  Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
1279  if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
1280  if (!EmbeddedPISupported)
1281  ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1282  << LastRWPIArg->getSpelling() << Triple.str();
1283  RWPI = true;
1284  }
1285 
1286  // ROPI and RWPI are not compatible with PIC or PIE.
1287  if ((ROPI || RWPI) && (PIC || PIE))
1288  ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
1289 
1290  if (Triple.isMIPS()) {
1291  StringRef CPUName;
1292  StringRef ABIName;
1293  mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
1294  // When targeting the N64 ABI, PIC is the default, except in the case
1295  // when the -mno-abicalls option is used. In that case we exit
1296  // at next check regardless of PIC being set below.
1297  if (ABIName == "n64")
1298  PIC = true;
1299  // When targettng MIPS with -mno-abicalls, it's always static.
1300  if(Args.hasArg(options::OPT_mno_abicalls))
1301  return std::make_tuple(llvm::Reloc::Static, 0U, false);
1302  // Unlike other architectures, MIPS, even with -fPIC/-mxgot/multigot,
1303  // does not use PIC level 2 for historical reasons.
1304  IsPICLevelTwo = false;
1305  }
1306 
1307  if (PIC)
1308  return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
1309 
1310  llvm::Reloc::Model RelocM = llvm::Reloc::Static;
1311  if (ROPI && RWPI)
1312  RelocM = llvm::Reloc::ROPI_RWPI;
1313  else if (ROPI)
1314  RelocM = llvm::Reloc::ROPI;
1315  else if (RWPI)
1316  RelocM = llvm::Reloc::RWPI;
1317 
1318  return std::make_tuple(RelocM, 0U, false);
1319 }
1320 
1321 // `-falign-functions` indicates that the functions should be aligned to a
1322 // 16-byte boundary.
1323 //
1324 // `-falign-functions=1` is the same as `-fno-align-functions`.
1325 //
1326 // The scalar `n` in `-falign-functions=n` must be an integral value between
1327 // [0, 65536]. If the value is not a power-of-two, it will be rounded up to
1328 // the nearest power-of-two.
1329 //
1330 // If we return `0`, the frontend will default to the backend's preferred
1331 // alignment.
1332 //
1333 // NOTE: icc only allows values between [0, 4096]. icc uses `-falign-functions`
1334 // to mean `-falign-functions=16`. GCC defaults to the backend's preferred
1335 // alignment. For unaligned functions, we default to the backend's preferred
1336 // alignment.
1337 unsigned tools::ParseFunctionAlignment(const ToolChain &TC,
1338  const ArgList &Args) {
1339  const Arg *A = Args.getLastArg(options::OPT_falign_functions,
1340  options::OPT_falign_functions_EQ,
1341  options::OPT_fno_align_functions);
1342  if (!A || A->getOption().matches(options::OPT_fno_align_functions))
1343  return 0;
1344 
1345  if (A->getOption().matches(options::OPT_falign_functions))
1346  return 0;
1347 
1348  unsigned Value = 0;
1349  if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 65536)
1350  TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1351  << A->getAsString(Args) << A->getValue();
1352  return Value ? llvm::Log2_32_Ceil(std::min(Value, 65536u)) : Value;
1353 }
1354 
1355 unsigned tools::ParseDebugDefaultVersion(const ToolChain &TC,
1356  const ArgList &Args) {
1357  const Arg *A = Args.getLastArg(options::OPT_fdebug_default_version);
1358 
1359  if (!A)
1360  return 0;
1361 
1362  unsigned Value = 0;
1363  if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 5 ||
1364  Value < 2)
1365  TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1366  << A->getAsString(Args) << A->getValue();
1367  return Value;
1368 }
1369 
1370 void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
1371  ArgStringList &CmdArgs) {
1372  llvm::Reloc::Model RelocationModel;
1373  unsigned PICLevel;
1374  bool IsPIE;
1375  std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
1376 
1377  if (RelocationModel != llvm::Reloc::Static)
1378  CmdArgs.push_back("-KPIC");
1379 }
1380 
1381 /// Determine whether Objective-C automated reference counting is
1382 /// enabled.
1383 bool tools::isObjCAutoRefCount(const ArgList &Args) {
1384  return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
1385 }
1386 
1388 
1389 static LibGccType getLibGccType(const ToolChain &TC, const Driver &D,
1390  const ArgList &Args) {
1391  if (Args.hasArg(options::OPT_static_libgcc) ||
1392  Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_static_pie))
1393  return LibGccType::StaticLibGcc;
1394  if (Args.hasArg(options::OPT_shared_libgcc))
1395  return LibGccType::SharedLibGcc;
1396  // The Android NDK only provides libunwind.a, not libunwind.so.
1397  if (TC.getTriple().isAndroid())
1398  return LibGccType::StaticLibGcc;
1399  // For MinGW, don't imply a shared libgcc here, we only want to return
1400  // SharedLibGcc if that was explicitly requested.
1401  if (D.CCCIsCXX() && !TC.getTriple().isOSCygMing())
1402  return LibGccType::SharedLibGcc;
1404 }
1405 
1406 // Gcc adds libgcc arguments in various ways:
1407 //
1408 // gcc <none>: -lgcc --as-needed -lgcc_s --no-as-needed
1409 // g++ <none>: -lgcc_s -lgcc
1410 // gcc shared: -lgcc_s -lgcc
1411 // g++ shared: -lgcc_s -lgcc
1412 // gcc static: -lgcc -lgcc_eh
1413 // g++ static: -lgcc -lgcc_eh
1414 // gcc static-pie: -lgcc -lgcc_eh
1415 // g++ static-pie: -lgcc -lgcc_eh
1416 //
1417 // Also, certain targets need additional adjustments.
1418 
1419 static void AddUnwindLibrary(const ToolChain &TC, const Driver &D,
1420  ArgStringList &CmdArgs, const ArgList &Args) {
1422  // Targets that don't use unwind libraries.
1423  if ((TC.getTriple().isAndroid() && UNW == ToolChain::UNW_Libgcc) ||
1424  TC.getTriple().isOSIAMCU() || TC.getTriple().isOSBinFormatWasm() ||
1425  UNW == ToolChain::UNW_None)
1426  return;
1427 
1428  LibGccType LGT = getLibGccType(TC, D, Args);
1429  bool AsNeeded = LGT == LibGccType::UnspecifiedLibGcc &&
1430  !TC.getTriple().isAndroid() &&
1431  !TC.getTriple().isOSCygMing() && !TC.getTriple().isOSAIX();
1432  if (AsNeeded)
1433  CmdArgs.push_back(getAsNeededOption(TC, true));
1434 
1435  switch (UNW) {
1436  case ToolChain::UNW_None:
1437  return;
1438  case ToolChain::UNW_Libgcc: {
1439  if (LGT == LibGccType::StaticLibGcc)
1440  CmdArgs.push_back("-lgcc_eh");
1441  else
1442  CmdArgs.push_back("-lgcc_s");
1443  break;
1444  }
1446  if (TC.getTriple().isOSAIX()) {
1447  // AIX only has libunwind as a shared library. So do not pass
1448  // anything in if -static is specified.
1449  if (LGT != LibGccType::StaticLibGcc)
1450  CmdArgs.push_back("-lunwind");
1451  } else if (LGT == LibGccType::StaticLibGcc) {
1452  CmdArgs.push_back("-l:libunwind.a");
1453  } else if (TC.getTriple().isOSCygMing()) {
1454  if (LGT == LibGccType::SharedLibGcc)
1455  CmdArgs.push_back("-l:libunwind.dll.a");
1456  else
1457  // Let the linker choose between libunwind.dll.a and libunwind.a
1458  // depending on what's available, and depending on the -static flag
1459  CmdArgs.push_back("-lunwind");
1460  } else {
1461  CmdArgs.push_back("-l:libunwind.so");
1462  }
1463  break;
1464  }
1465 
1466  if (AsNeeded)
1467  CmdArgs.push_back(getAsNeededOption(TC, false));
1468 }
1469 
1470 static void AddLibgcc(const ToolChain &TC, const Driver &D,
1471  ArgStringList &CmdArgs, const ArgList &Args) {
1472  LibGccType LGT = getLibGccType(TC, D, Args);
1473  if (LGT != LibGccType::SharedLibGcc)
1474  CmdArgs.push_back("-lgcc");
1475  AddUnwindLibrary(TC, D, CmdArgs, Args);
1476  if (LGT == LibGccType::SharedLibGcc)
1477  CmdArgs.push_back("-lgcc");
1478 }
1479 
1480 void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
1481  ArgStringList &CmdArgs, const ArgList &Args) {
1482  // Make use of compiler-rt if --rtlib option is used
1484 
1485  switch (RLT) {
1487  CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
1488  AddUnwindLibrary(TC, D, CmdArgs, Args);
1489  break;
1490  case ToolChain::RLT_Libgcc:
1491  // Make sure libgcc is not used under MSVC environment by default
1492  if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
1493  // Issue error diagnostic if libgcc is explicitly specified
1494  // through command line as --rtlib option argument.
1495  if (Args.hasArg(options::OPT_rtlib_EQ)) {
1496  TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
1497  << Args.getLastArg(options::OPT_rtlib_EQ)->getValue() << "MSVC";
1498  }
1499  } else
1500  AddLibgcc(TC, D, CmdArgs, Args);
1501  break;
1502  }
1503 
1504  // On Android, the unwinder uses dl_iterate_phdr (or one of
1505  // dl_unwind_find_exidx/__gnu_Unwind_Find_exidx on arm32) from libdl.so. For
1506  // statically-linked executables, these functions come from libc.a instead.
1507  if (TC.getTriple().isAndroid() && !Args.hasArg(options::OPT_static) &&
1508  !Args.hasArg(options::OPT_static_pie))
1509  CmdArgs.push_back("-ldl");
1510 }
1511 
1512 SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
1513  const InputInfo &Output,
1514  const InputInfo &Input,
1515  const Driver &D) {
1516  const Arg *A = Args.getLastArg(options::OPT_save_stats_EQ);
1517  if (!A)
1518  return {};
1519 
1520  StringRef SaveStats = A->getValue();
1521  SmallString<128> StatsFile;
1522  if (SaveStats == "obj" && Output.isFilename()) {
1523  StatsFile.assign(Output.getFilename());
1524  llvm::sys::path::remove_filename(StatsFile);
1525  } else if (SaveStats != "cwd") {
1526  D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
1527  return {};
1528  }
1529 
1530  StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
1531  llvm::sys::path::append(StatsFile, BaseName);
1532  llvm::sys::path::replace_extension(StatsFile, "stats");
1533  return StatsFile;
1534 }
1535 
1536 void tools::addMultilibFlag(bool Enabled, const char *const Flag,
1537  Multilib::flags_list &Flags) {
1538  Flags.push_back(std::string(Enabled ? "+" : "-") + Flag);
1539 }
1540 
1541 void tools::addX86AlignBranchArgs(const Driver &D, const ArgList &Args,
1542  ArgStringList &CmdArgs, bool IsLTO) {
1543  auto addArg = [&, IsLTO](const Twine &Arg) {
1544  if (IsLTO) {
1545  CmdArgs.push_back(Args.MakeArgString("-plugin-opt=" + Arg));
1546  } else {
1547  CmdArgs.push_back("-mllvm");
1548  CmdArgs.push_back(Args.MakeArgString(Arg));
1549  }
1550  };
1551 
1552  if (Args.hasArg(options::OPT_mbranches_within_32B_boundaries)) {
1553  addArg(Twine("-x86-branches-within-32B-boundaries"));
1554  }
1555  if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_boundary_EQ)) {
1556  StringRef Value = A->getValue();
1557  unsigned Boundary;
1558  if (Value.getAsInteger(10, Boundary) || Boundary < 16 ||
1559  !llvm::isPowerOf2_64(Boundary)) {
1560  D.Diag(diag::err_drv_invalid_argument_to_option)
1561  << Value << A->getOption().getName();
1562  } else {
1563  addArg("-x86-align-branch-boundary=" + Twine(Boundary));
1564  }
1565  }
1566  if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_EQ)) {
1567  std::string AlignBranch;
1568  for (StringRef T : A->getValues()) {
1569  if (T != "fused" && T != "jcc" && T != "jmp" && T != "call" &&
1570  T != "ret" && T != "indirect")
1571  D.Diag(diag::err_drv_invalid_malign_branch_EQ)
1572  << T << "fused, jcc, jmp, call, ret, indirect";
1573  if (!AlignBranch.empty())
1574  AlignBranch += '+';
1575  AlignBranch += T;
1576  }
1577  addArg("-x86-align-branch=" + Twine(AlignBranch));
1578  }
1579  if (const Arg *A = Args.getLastArg(options::OPT_mpad_max_prefix_size_EQ)) {
1580  StringRef Value = A->getValue();
1581  unsigned PrefixSize;
1582  if (Value.getAsInteger(10, PrefixSize)) {
1583  D.Diag(diag::err_drv_invalid_argument_to_option)
1584  << Value << A->getOption().getName();
1585  } else {
1586  addArg("-x86-pad-max-prefix-size=" + Twine(PrefixSize));
1587  }
1588  }
1589 }
1590 
1591 /// SDLSearch: Search for Static Device Library
1592 /// The search for SDL bitcode files is consistent with how static host
1593 /// libraries are discovered. That is, the -l option triggers a search for
1594 /// files in a set of directories called the LINKPATH. The host library search
1595 /// procedure looks for a specific filename in the LINKPATH. The filename for
1596 /// a host library is lib<libname>.a or lib<libname>.so. For SDLs, there is an
1597 /// ordered-set of filenames that are searched. We call this ordered-set of
1598 /// filenames as SEARCH-ORDER. Since an SDL can either be device-type specific,
1599 /// architecture specific, or generic across all architectures, a naming
1600 /// convention and search order is used where the file name embeds the
1601 /// architecture name <arch-name> (nvptx or amdgcn) and the GPU device type
1602 /// <device-name> such as sm_30 and gfx906. <device-name> is absent in case of
1603 /// device-independent SDLs. To reduce congestion in host library directories,
1604 /// the search first looks for files in the “libdevice” subdirectory. SDLs that
1605 /// are bc files begin with the prefix “lib”.
1606 ///
1607 /// Machine-code SDLs can also be managed as an archive (*.a file). The
1608 /// convention has been to use the prefix “lib”. To avoid confusion with host
1609 /// archive libraries, we use prefix "libbc-" for the bitcode SDL archives.
1610 ///
1611 bool tools::SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
1612  llvm::opt::ArgStringList &CC1Args,
1613  SmallVector<std::string, 8> LibraryPaths, std::string Lib,
1614  StringRef Arch, StringRef Target, bool isBitCodeSDL,
1615  bool postClangLink) {
1617 
1618  std::string LibDeviceLoc = "/libdevice";
1619  std::string LibBcPrefix = "/libbc-";
1620  std::string LibPrefix = "/lib";
1621 
1622  if (isBitCodeSDL) {
1623  // SEARCH-ORDER for Bitcode SDLs:
1624  // libdevice/libbc-<libname>-<arch-name>-<device-type>.a
1625  // libbc-<libname>-<arch-name>-<device-type>.a
1626  // libdevice/libbc-<libname>-<arch-name>.a
1627  // libbc-<libname>-<arch-name>.a
1628  // libdevice/libbc-<libname>.a
1629  // libbc-<libname>.a
1630  // libdevice/lib<libname>-<arch-name>-<device-type>.bc
1631  // lib<libname>-<arch-name>-<device-type>.bc
1632  // libdevice/lib<libname>-<arch-name>.bc
1633  // lib<libname>-<arch-name>.bc
1634  // libdevice/lib<libname>.bc
1635  // lib<libname>.bc
1636 
1637  for (StringRef Base : {LibBcPrefix, LibPrefix}) {
1638  const auto *Ext = Base.contains(LibBcPrefix) ? ".a" : ".bc";
1639 
1640  for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
1641  Twine(Lib + "-" + Arch).str(), Twine(Lib).str()}) {
1642  SDLs.push_back(Twine(LibDeviceLoc + Base + Suffix + Ext).str());
1643  SDLs.push_back(Twine(Base + Suffix + Ext).str());
1644  }
1645  }
1646  } else {
1647  // SEARCH-ORDER for Machine-code SDLs:
1648  // libdevice/lib<libname>-<arch-name>-<device-type>.a
1649  // lib<libname>-<arch-name>-<device-type>.a
1650  // libdevice/lib<libname>-<arch-name>.a
1651  // lib<libname>-<arch-name>.a
1652 
1653  const auto *Ext = ".a";
1654 
1655  for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
1656  Twine(Lib + "-" + Arch).str()}) {
1657  SDLs.push_back(Twine(LibDeviceLoc + LibPrefix + Suffix + Ext).str());
1658  SDLs.push_back(Twine(LibPrefix + Suffix + Ext).str());
1659  }
1660  }
1661 
1662  // The CUDA toolchain does not use a global device llvm-link before the LLVM
1663  // backend generates ptx. So currently, the use of bitcode SDL for nvptx is
1664  // only possible with post-clang-cc1 linking. Clang cc1 has a feature that
1665  // will link libraries after clang compilation while the LLVM IR is still in
1666  // memory. This utilizes a clang cc1 option called “-mlink-builtin-bitcode”.
1667  // This is a clang -cc1 option that is generated by the clang driver. The
1668  // option value must a full path to an existing file.
1669  bool FoundSDL = false;
1670  for (auto LPath : LibraryPaths) {
1671  for (auto SDL : SDLs) {
1672  auto FullName = Twine(LPath + SDL).str();
1673  if (llvm::sys::fs::exists(FullName)) {
1674  if (postClangLink)
1675  CC1Args.push_back("-mlink-builtin-bitcode");
1676  CC1Args.push_back(DriverArgs.MakeArgString(FullName));
1677  FoundSDL = true;
1678  break;
1679  }
1680  }
1681  if (FoundSDL)
1682  break;
1683  }
1684  return FoundSDL;
1685 }
1686 
1687 /// Search if a user provided archive file lib<libname>.a exists in any of
1688 /// the library paths. If so, add a new command to clang-offload-bundler to
1689 /// unbundle this archive and create a temporary device specific archive. Name
1690 /// of this SDL is passed to the llvm-link (for amdgcn) or to the
1691 /// clang-nvlink-wrapper (for nvptx) commands by the driver.
1693  Compilation &C, const Driver &D, const Tool &T, const JobAction &JA,
1694  const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs,
1695  llvm::opt::ArgStringList &CC1Args, SmallVector<std::string, 8> LibraryPaths,
1696  StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL,
1697  bool postClangLink) {
1698 
1699  // We don't support bitcode archive bundles for nvptx
1700  if (isBitCodeSDL && Arch.contains("nvptx"))
1701  return false;
1702 
1703  bool FoundAOB = false;
1704  SmallVector<std::string, 2> AOBFileNames;
1705  std::string ArchiveOfBundles;
1706  for (auto LPath : LibraryPaths) {
1707  ArchiveOfBundles.clear();
1708 
1709  AOBFileNames.push_back(Twine(LPath + "/libdevice/lib" + Lib + ".a").str());
1710  AOBFileNames.push_back(Twine(LPath + "/lib" + Lib + ".a").str());
1711 
1712  for (auto AOB : AOBFileNames) {
1713  if (llvm::sys::fs::exists(AOB)) {
1714  ArchiveOfBundles = AOB;
1715  FoundAOB = true;
1716  break;
1717  }
1718  }
1719 
1720  if (!FoundAOB)
1721  continue;
1722 
1723  StringRef Prefix = isBitCodeSDL ? "libbc-" : "lib";
1724  std::string OutputLib = D.GetTemporaryPath(
1725  Twine(Prefix + Lib + "-" + Arch + "-" + Target).str(), "a");
1726 
1727  C.addTempFile(C.getArgs().MakeArgString(OutputLib.c_str()));
1728 
1729  ArgStringList CmdArgs;
1730  SmallString<128> DeviceTriple;
1732  DeviceTriple += '-';
1733  std::string NormalizedTriple = T.getToolChain().getTriple().normalize();
1734  DeviceTriple += NormalizedTriple;
1735  if (!Target.empty()) {
1736  DeviceTriple += '-';
1737  DeviceTriple += Target;
1738  }
1739 
1740  std::string UnbundleArg("-unbundle");
1741  std::string TypeArg("-type=a");
1742  std::string InputArg("-inputs=" + ArchiveOfBundles);
1743  std::string OffloadArg("-targets=" + std::string(DeviceTriple));
1744  std::string OutputArg("-outputs=" + OutputLib);
1745 
1746  const char *UBProgram = DriverArgs.MakeArgString(
1747  T.getToolChain().GetProgramPath("clang-offload-bundler"));
1748 
1749  ArgStringList UBArgs;
1750  UBArgs.push_back(C.getArgs().MakeArgString(UnbundleArg.c_str()));
1751  UBArgs.push_back(C.getArgs().MakeArgString(TypeArg.c_str()));
1752  UBArgs.push_back(C.getArgs().MakeArgString(InputArg.c_str()));
1753  UBArgs.push_back(C.getArgs().MakeArgString(OffloadArg.c_str()));
1754  UBArgs.push_back(C.getArgs().MakeArgString(OutputArg.c_str()));
1755 
1756  // Add this flag to not exit from clang-offload-bundler if no compatible
1757  // code object is found in heterogenous archive library.
1758  std::string AdditionalArgs("-allow-missing-bundles");
1759  UBArgs.push_back(C.getArgs().MakeArgString(AdditionalArgs.c_str()));
1760 
1761  C.addCommand(std::make_unique<Command>(
1762  JA, T, ResponseFileSupport::AtFileCurCP(), UBProgram, UBArgs, Inputs,
1763  InputInfo(&JA, C.getArgs().MakeArgString(OutputLib.c_str()))));
1764  if (postClangLink)
1765  CC1Args.push_back("-mlink-builtin-bitcode");
1766 
1767  CC1Args.push_back(DriverArgs.MakeArgString(OutputLib));
1768  break;
1769  }
1770 
1771  return FoundAOB;
1772 }
1773 
1774 // Wrapper function used by driver for adding SDLs during link phase.
1776  const JobAction &JA,
1777  const InputInfoList &Inputs,
1778  const llvm::opt::ArgList &DriverArgs,
1779  llvm::opt::ArgStringList &CC1Args,
1780  StringRef Arch, StringRef Target,
1781  bool isBitCodeSDL, bool postClangLink) {
1782  AddStaticDeviceLibs(&C, &T, &JA, &Inputs, C.getDriver(), DriverArgs, CC1Args,
1783  Arch, Target, isBitCodeSDL, postClangLink);
1784 }
1785 
1786 // Wrapper function used for post clang linking of bitcode SDLS for nvptx by
1787 // the CUDA toolchain.
1789  const llvm::opt::ArgList &DriverArgs,
1790  llvm::opt::ArgStringList &CC1Args,
1791  StringRef Arch, StringRef Target,
1792  bool isBitCodeSDL, bool postClangLink) {
1793  AddStaticDeviceLibs(nullptr, nullptr, nullptr, nullptr, D, DriverArgs,
1794  CC1Args, Arch, Target, isBitCodeSDL, postClangLink);
1795 }
1796 
1797 // User defined Static Device Libraries(SDLs) can be passed to clang for
1798 // offloading GPU compilers. Like static host libraries, the use of a SDL is
1799 // specified with the -l command line option. The primary difference between
1800 // host and SDLs is the filenames for SDLs (refer SEARCH-ORDER for Bitcode SDLs
1801 // and SEARCH-ORDER for Machine-code SDLs for the naming convention).
1802 // SDLs are of following types:
1803 //
1804 // * Bitcode SDLs: They can either be a *.bc file or an archive of *.bc files.
1805 // For NVPTX, these libraries are post-clang linked following each
1806 // compilation. For AMDGPU, these libraries are linked one time
1807 // during the application link phase.
1808 //
1809 // * Machine-code SDLs: They are archive files. For NVPTX, the archive members
1810 // contain cubin for Nvidia GPUs and are linked one time during the
1811 // link phase by the CUDA SDK linker called nvlink. For AMDGPU, the
1812 // process for machine code SDLs is still in development. But they
1813 // will be linked by the LLVM tool lld.
1814 //
1815 // * Bundled objects that contain both host and device codes: Bundled objects
1816 // may also contain library code compiled from source. For NVPTX, the
1817 // bundle contains cubin. For AMDGPU, the bundle contains bitcode.
1818 //
1819 // For Bitcode and Machine-code SDLs, current compiler toolchains hardcode the
1820 // inclusion of specific SDLs such as math libraries and the OpenMP device
1821 // library libomptarget.
1823  const JobAction *JA,
1824  const InputInfoList *Inputs, const Driver &D,
1825  const llvm::opt::ArgList &DriverArgs,
1826  llvm::opt::ArgStringList &CC1Args,
1827  StringRef Arch, StringRef Target,
1828  bool isBitCodeSDL, bool postClangLink) {
1829 
1830  SmallVector<std::string, 8> LibraryPaths;
1831  // Add search directories from LIBRARY_PATH env variable
1832  llvm::Optional<std::string> LibPath =
1833  llvm::sys::Process::GetEnv("LIBRARY_PATH");
1834  if (LibPath) {
1836  const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
1837  llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
1838  for (StringRef Path : Frags)
1839  LibraryPaths.emplace_back(Path.trim());
1840  }
1841 
1842  // Add directories from user-specified -L options
1843  for (std::string Search_Dir : DriverArgs.getAllArgValues(options::OPT_L))
1844  LibraryPaths.emplace_back(Search_Dir);
1845 
1846  // Add path to lib-debug folders
1847  SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
1848  llvm::sys::path::append(DefaultLibPath, Twine("lib") + CLANG_LIBDIR_SUFFIX);
1849  LibraryPaths.emplace_back(DefaultLibPath.c_str());
1850 
1851  // Build list of Static Device Libraries SDLs specified by -l option
1852  llvm::SmallSet<std::string, 16> SDLNames;
1853  static const StringRef HostOnlyArchives[] = {
1854  "omp", "cudart", "m", "gcc", "gcc_s", "pthread", "hip_hcc"};
1855  for (auto SDLName : DriverArgs.getAllArgValues(options::OPT_l)) {
1856  if (!HostOnlyArchives->contains(SDLName)) {
1857  SDLNames.insert(SDLName);
1858  }
1859  }
1860 
1861  // The search stops as soon as an SDL file is found. The driver then provides
1862  // the full filename of the SDL to the llvm-link or clang-nvlink-wrapper
1863  // command. If no SDL is found after searching each LINKPATH with
1864  // SEARCH-ORDER, it is possible that an archive file lib<libname>.a exists
1865  // and may contain bundled object files.
1866  for (auto SDLName : SDLNames) {
1867  // This is the only call to SDLSearch
1868  if (!SDLSearch(D, DriverArgs, CC1Args, LibraryPaths, SDLName, Arch, Target,
1869  isBitCodeSDL, postClangLink)) {
1870  GetSDLFromOffloadArchive(*C, D, *T, *JA, *Inputs, DriverArgs, CC1Args,
1871  LibraryPaths, SDLName, Arch, Target,
1872  isBitCodeSDL, postClangLink);
1873  }
1874  }
1875 }
1876 
1877 static llvm::opt::Arg *
1878 getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args) {
1879  // The last of -mcode-object-v3, -mno-code-object-v3 and
1880  // -mcode-object-version=<version> wins.
1881  return Args.getLastArg(options::OPT_mcode_object_v3_legacy,
1882  options::OPT_mno_code_object_v3_legacy,
1883  options::OPT_mcode_object_version_EQ);
1884 }
1885 
1887  const llvm::opt::ArgList &Args) {
1888  const unsigned MinCodeObjVer = 2;
1889  const unsigned MaxCodeObjVer = 4;
1890 
1891  // Emit warnings for legacy options even if they are overridden.
1892  if (Args.hasArg(options::OPT_mno_code_object_v3_legacy))
1893  D.Diag(diag::warn_drv_deprecated_arg) << "-mno-code-object-v3"
1894  << "-mcode-object-version=2";
1895 
1896  if (Args.hasArg(options::OPT_mcode_object_v3_legacy))
1897  D.Diag(diag::warn_drv_deprecated_arg) << "-mcode-object-v3"
1898  << "-mcode-object-version=3";
1899 
1900  if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
1901  if (CodeObjArg->getOption().getID() ==
1902  options::OPT_mcode_object_version_EQ) {
1903  unsigned CodeObjVer = MaxCodeObjVer;
1904  auto Remnant =
1905  StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
1906  if (Remnant || CodeObjVer < MinCodeObjVer || CodeObjVer > MaxCodeObjVer)
1907  D.Diag(diag::err_drv_invalid_int_value)
1908  << CodeObjArg->getAsString(Args) << CodeObjArg->getValue();
1909  }
1910  }
1911 }
1912 
1914  const llvm::opt::ArgList &Args) {
1915  unsigned CodeObjVer = 4; // default
1916  if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
1917  if (CodeObjArg->getOption().getID() ==
1918  options::OPT_mno_code_object_v3_legacy) {
1919  CodeObjVer = 2;
1920  } else if (CodeObjArg->getOption().getID() ==
1921  options::OPT_mcode_object_v3_legacy) {
1922  CodeObjVer = 3;
1923  } else {
1924  StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
1925  }
1926  }
1927  return CodeObjVer;
1928 }
1929 
1931  const Driver &D, const llvm::opt::ArgList &Args) {
1932  return getAMDGPUCodeObjectArgument(D, Args) != nullptr;
1933 }
1934 
1936  const llvm::opt::ArgList &Args,
1937  llvm::opt::ArgStringList &CmdArgs,
1938  const llvm::Triple &Triple, bool IsLTO) {
1939  auto addArg = [&, IsLTO](const Twine &Arg) {
1940  if (IsLTO) {
1941  CmdArgs.push_back(Args.MakeArgString("-plugin-opt=" + Arg));
1942  } else {
1943  CmdArgs.push_back("-mllvm");
1944  CmdArgs.push_back(Args.MakeArgString(Arg));
1945  }
1946  };
1947 
1948  if (Arg *A = Args.getLastArg(options::OPT_moutline,
1949  options::OPT_mno_outline)) {
1950  if (A->getOption().matches(options::OPT_moutline)) {
1951  // We only support -moutline in AArch64 and ARM targets right now. If
1952  // we're not compiling for these, emit a warning and ignore the flag.
1953  // Otherwise, add the proper mllvm flags.
1954  if (!(Triple.isARM() || Triple.isThumb() ||
1955  Triple.getArch() == llvm::Triple::aarch64 ||
1956  Triple.getArch() == llvm::Triple::aarch64_32)) {
1957  D.Diag(diag::warn_drv_moutline_unsupported_opt) << Triple.getArchName();
1958  } else {
1959  addArg(Twine("-enable-machine-outliner"));
1960  }
1961  } else {
1962  // Disable all outlining behaviour.
1963  addArg(Twine("-enable-machine-outliner=never"));
1964  }
1965  }
1966 }
1967 
1969  const llvm::opt::ArgList &DriverArgs,
1970  llvm::opt::ArgStringList &CC1Args,
1971  StringRef BitcodeSuffix,
1972  const llvm::Triple &Triple) {
1973  SmallVector<StringRef, 8> LibraryPaths;
1974 
1975  // Add path to clang lib / lib64 folder.
1976  SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
1977  llvm::sys::path::append(DefaultLibPath, Twine("lib") + CLANG_LIBDIR_SUFFIX);
1978  LibraryPaths.emplace_back(DefaultLibPath.c_str());
1979 
1980  // Add user defined library paths from LIBRARY_PATH.
1981  llvm::Optional<std::string> LibPath =
1982  llvm::sys::Process::GetEnv("LIBRARY_PATH");
1983  if (LibPath) {
1985  const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
1986  llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
1987  for (StringRef Path : Frags)
1988  LibraryPaths.emplace_back(Path.trim());
1989  }
1990 
1991  OptSpecifier LibomptargetBCPathOpt =
1992  Triple.isAMDGCN() ? options::OPT_libomptarget_amdgcn_bc_path_EQ
1993  : options::OPT_libomptarget_nvptx_bc_path_EQ;
1994 
1995  StringRef ArchPrefix = Triple.isAMDGCN() ? "amdgcn" : "nvptx";
1996  std::string LibOmpTargetName = "libomptarget-" + BitcodeSuffix.str() + ".bc";
1997 
1998  // First check whether user specifies bc library
1999  if (const Arg *A = DriverArgs.getLastArg(LibomptargetBCPathOpt)) {
2000  SmallString<128> LibOmpTargetFile(A->getValue());
2001  if (llvm::sys::fs::exists(LibOmpTargetFile) &&
2002  llvm::sys::fs::is_directory(LibOmpTargetFile)) {
2003  llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
2004  }
2005 
2006  if (llvm::sys::fs::exists(LibOmpTargetFile)) {
2007  CC1Args.push_back("-mlink-builtin-bitcode");
2008  CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
2009  } else {
2010  D.Diag(diag::err_drv_omp_offload_target_bcruntime_not_found)
2011  << LibOmpTargetFile;
2012  }
2013  } else {
2014  bool FoundBCLibrary = false;
2015 
2016  for (StringRef LibraryPath : LibraryPaths) {
2017  SmallString<128> LibOmpTargetFile(LibraryPath);
2018  llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
2019  if (llvm::sys::fs::exists(LibOmpTargetFile)) {
2020  CC1Args.push_back("-mlink-builtin-bitcode");
2021  CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
2022  FoundBCLibrary = true;
2023  break;
2024  }
2025  }
2026 
2027  if (!FoundBCLibrary)
2028  D.Diag(diag::err_drv_omp_offload_target_missingbcruntime)
2029  << LibOmpTargetName << ArchPrefix;
2030  }
2031 }
Mips.h
clang::driver::Multilib::flags_list
std::vector< std::string > flags_list
Definition: Multilib.h:30
clang::driver::SanitizerArgs::hasCrossDsoCfi
bool hasCrossDsoCfi() const
Definition: SanitizerArgs.h:103
clang::driver::tools::ParseFunctionAlignment
unsigned ParseFunctionAlignment(const ToolChain &TC, const llvm::opt::ArgList &Args)
LibGccType::StaticLibGcc
@ StaticLibGcc
Util.h
clang::driver::ToolChain::getSanitizerArgs
const SanitizerArgs & getSanitizerArgs() const
Definition: ToolChain.cpp:117
clang::driver::Action::getOffloadingArch
const char * getOffloadingArch() const
Definition: Action.h:200
clang::driver::tools::AddAssemblerKPIC
void AddAssemblerKPIC(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::ToolChain::getEffectiveTriple
const llvm::Triple & getEffectiveTriple() const
Get the toolchain's effective clang triple.
Definition: ToolChain.h:251
clang::driver::tools::GetSDLFromOffloadArchive
bool GetSDLFromOffloadArchive(Compilation &C, const Driver &D, const Tool &T, const JobAction &JA, const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, SmallVector< std::string, 8 > LibraryPaths, StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Search if a user provided archive file lib<libname>.a exists in any of the library paths.
Definition: CommonArgs.cpp:1692
getLanaiTargetCPU
static std::string getLanaiTargetCPU(const ArgList &Args)
Definition: CommonArgs.cpp:333
clang::driver::ToolChain::getCompilerRT
virtual std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:463
clang::driver::ToolChain::getVFS
llvm::vfs::FileSystem & getVFS() const
Definition: ToolChain.cpp:99
XRayArgs.h
ObjCRuntime.h
Driver.h
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::driver::Driver::Dir
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:123
clang::driver::tools::ParsePICArgs
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
clang::driver::tools::getLastProfileSampleUseArg
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
llvm::SmallVector< std::string, 16 >
clang::driver::toolchains::HexagonToolChain::GetTargetCPUVersion
static StringRef GetTargetCPUVersion(const llvm::opt::ArgList &Args)
Definition: Hexagon.cpp:711
X86.h
addSanitizerDynamicList
static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs, StringRef Sanitizer)
Definition: CommonArgs.cpp:725
collectSanitizerRuntimes
static void collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args, SmallVectorImpl< StringRef > &SharedRuntimes, SmallVectorImpl< StringRef > &StaticRuntimes, SmallVectorImpl< StringRef > &NonWholeStaticRuntimes, SmallVectorImpl< StringRef > &HelperStaticRuntimes, SmallVectorImpl< StringRef > &RequiredSymbols)
Definition: CommonArgs.cpp:784
clang::driver::ToolChain::GetProgramPath
std::string GetProgramPath(const char *Name) const
Definition: ToolChain.cpp:542
HIP.h
clang::MultiVersionKind::Target
@ Target
clang::driver::SanitizerArgs::needsSafeStackRt
bool needsSafeStackRt() const
Definition: SanitizerArgs.h:92
clang::driver::tools
Definition: AIX.h:17
AttributeLangSupport::C
@ C
Definition: SemaDeclAttr.cpp:54
clang::driver::tools::addX86AlignBranchArgs
void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool IsLTO)
clang::driver::tools::AddStaticDeviceLibs
void AddStaticDeviceLibs(Compilation *C, const Tool *T, const JobAction *JA, const InputInfoList *Inputs, const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1822
clang::driver::tools::m68k::getM68kTargetCPU
std::string getM68kTargetCPU(const llvm::opt::ArgList &Args)
clang::driver::ToolChain::getDriver
const Driver & getDriver() const
Definition: ToolChain.h:221
Job.h
clang::driver::SanitizerArgs::needsTsanRt
bool needsTsanRt() const
Definition: SanitizerArgs.h:80
clang::driver::ToolChain::getTripleString
std::string getTripleString() const
Definition: ToolChain.h:246
clang::driver::Action::OFK_HIP
@ OFK_HIP
Definition: Action.h:94
clang::driver::Driver::OpenMPRuntimeKind
OpenMPRuntimeKind
Definition: Driver.h:91
clang::driver::XRayArgs::modeList
llvm::ArrayRef< std::string > modeList() const
Definition: XRayArgs.h:45
clang::driver::tools::getCPUName
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
clang::driver::SanitizerArgs::needsHwasanRt
bool needsHwasanRt() const
Definition: SanitizerArgs.h:74
llvm::Optional< std::string >
getWebAssemblyTargetCPU
static StringRef getWebAssemblyTargetCPU(const ArgList &Args)
Get the (LLVM) name of the WebAssembly cpu we are targeting.
Definition: CommonArgs.cpp:341
clang::driver::ToolChain::isPICDefault
virtual bool isPICDefault() const =0
Test whether this toolchain defaults to PIC.
clang::driver::Driver::getOpenMPRuntime
OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const
Compute the desired OpenMP runtime from the flags provided.
Definition: Driver.cpp:623
clang::driver::ToolChain::HasNativeLLVMSupport
virtual bool HasNativeLLVMSupport() const
HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support.
Definition: ToolChain.cpp:638
clang::driver::Action::isHostOffloading
bool isHostOffloading(OffloadKind OKind) const
Check if this action have any offload kinds.
Definition: Action.h:204
clang::driver::tools::getLastProfileUseArg
llvm::opt::Arg * getLastProfileUseArg(const llvm::opt::ArgList &Args)
AArch64.h
clang::diag::Group
Group
Definition: DiagnosticCategories.h:23
clang::driver::tools::SplitDebugInfo
void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T, const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Output, const char *OutFile)
clang::driver::Action::GetOffloadKindName
static StringRef GetOffloadKindName(OffloadKind Kind)
Return a string containing a offload kind name.
Definition: Action.cpp:148
clang::driver::ToolChain::GetLinkerPath
std::string GetLinkerPath(bool *LinkerIsLLD=nullptr, bool *LinkerIsLLDDarwinNew=nullptr) const
Returns the linker path, respecting the -fuse-ld= argument to determine the linker suffix or name.
Definition: ToolChain.cpp:546
clang::driver::tools::SDLSearch
bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, SmallVector< std::string, 8 > LibraryPaths, std::string Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
SDLSearch: Search for Static Device Library The search for SDL bitcode files is consistent with how s...
Definition: CommonArgs.cpp:1611
clang::driver::InputInfo
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
VE.h
clang::driver::Action::OFK_OpenMP
@ OFK_OpenMP
Definition: Action.h:93
clang::driver::ToolChain::RuntimeLibType
RuntimeLibType
Definition: ToolChain.h:100
SystemZ.h
InputInfo.h
clang::driver::tools::AddLinkerInputs
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
Action.h
U
clang::driver::tools::areOptimizationsEnabled
bool areOptimizationsEnabled(const llvm::opt::ArgList &Args)
V
#define V(N, I)
Definition: ASTContext.h:3121
clang::driver::Driver::Diag
DiagnosticBuilder Diag(unsigned DiagID) const
Definition: Driver.h:112
clang::driver::tools::AddStaticDeviceLibsLinking
void AddStaticDeviceLibsLinking(Compilation &C, const Tool &T, const JobAction &JA, const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1775
clang::driver::SanitizerArgs::requiresMinimalRuntime
bool requiresMinimalRuntime() const
Definition: SanitizerArgs.h:90
min
__DEVICE__ int min(int __a, int __b)
Definition: __clang_cuda_math.h:197
clang::driver::InputInfo::getBaseInput
const char * getBaseInput() const
Definition: InputInfo.h:78
clang::driver::SanitizerArgs::linkRuntimes
bool linkRuntimes() const
Definition: SanitizerArgs.h:101
clang::driver::Tool
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
clang::driver::tools::ParseDebugDefaultVersion
unsigned ParseDebugDefaultVersion(const ToolChain &TC, const llvm::opt::ArgList &Args)
clang::driver::tools::claimNoWarnArgs
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
Options.h
clang::driver::InputInfo::isFilename
bool isFilename() const
Definition: InputInfo.h:75
clang::driver::SanitizerArgs::needsFuzzer
bool needsFuzzer() const
Definition: SanitizerArgs.h:82
clang::driver::XRayArgs::needsXRayRt
bool needsXRayRt() const
Definition: XRayArgs.h:44
clang::driver::tools::aarch64::getAArch64TargetCPU
std::string getAArch64TargetCPU(const llvm::opt::ArgList &Args, const llvm::Triple &Triple, llvm::opt::Arg *&A)
clang::driver::ToolChain::UNW_None
@ UNW_None
Definition: ToolChain.h:106
Version.h
LangOptions.h
llvm::opt
Definition: DiagnosticOptions.h:19
DriverDiagnostic.h
clang::driver::ResponseFileSupport::AtFileCurCP
static constexpr ResponseFileSupport AtFileCurCP()
Definition: Job.h:92
clang::driver::ToolChain::RLT_Libgcc
@ RLT_Libgcc
Definition: ToolChain.h:102
clang::driver::ToolChain::AddCCKextLibArgs
virtual void AddCCKextLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddCCKextLibArgs - Add the system specific linker arguments to use for kernel extensions (Darwin-spec...
Definition: ToolChain.cpp:962
clang::getProcessorFromTargetID
llvm::StringRef getProcessorFromTargetID(const llvm::Triple &T, llvm::StringRef OffloadArch)
Get processor name from target ID.
Definition: TargetID.cpp:53
clang::driver::tools::getLTOParallelism
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
clang::driver::tools::addPathIfExists
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:122
clang::driver::tools::systemz::getSystemZTargetCPU
std::string getSystemZTargetCPU(const llvm::opt::ArgList &Args)
clang::driver::Driver::OMPRT_IOMP5
@ OMPRT_IOMP5
The legacy name for the LLVM OpenMP runtime from when it was the Intel OpenMP runtime.
Definition: Driver.h:108
llvm::SmallString< 128 >
clang::driver::ToolChain::getTriple
const llvm::Triple & getTriple() const
Definition: ToolChain.h:223
clang::driver::SanitizerArgs::needsAsanRt
bool needsAsanRt() const
Definition: SanitizerArgs.h:73
clang::driver::Driver::CCCIsCXX
bool CCCIsCXX() const
Whether the driver should follow g++ like behavior.
Definition: Driver.h:179
clang::driver::Driver::OMPRT_OMP
@ OMPRT_OMP
The LLVM OpenMP runtime.
Definition: Driver.h:98
clang::driver::tools::handleTargetFeaturesGroup
void handleTargetFeaturesGroup(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier Group)
Iterate Args and convert -mxxx to +xxx and -mno-xxx to -xxx and append it to Features.
clang::driver::ToolChain::UNW_CompilerRT
@ UNW_CompilerRT
Definition: ToolChain.h:107
clang::driver::tools::addXRayRuntime
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
getLibGccType
static LibGccType getLibGccType(const ToolChain &TC, const Driver &D, const ArgList &Args)
Definition: CommonArgs.cpp:1389
clang::driver::SanitizerArgs::needsScudoRt
bool needsScudoRt() const
Definition: SanitizerArgs.h:96
clang::driver::types::isLLVMIR
bool isLLVMIR(ID Id)
Is this LLVM IR.
Definition: Types.cpp:222
Base
clang::driver::SanitizerArgs::needsFuzzerInterceptors
bool needsFuzzerInterceptors() const
Definition: SanitizerArgs.cpp:243
clang::driver::tools::addMachineOutlinerArgs
void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple, bool IsLTO)
Definition: CommonArgs.cpp:1935
clang::driver::tools::getAMDGPUCodeObjectVersion
unsigned getAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:1913
clang::driver::SanitizerArgs
Definition: SanitizerArgs.h:24
SanitizerArgs.h
clang::driver::ToolChain::UNW_Libgcc
@ UNW_Libgcc
Definition: ToolChain.h:108
clang::driver::tools::addOpenMPDeviceRTL
void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, StringRef BitcodeSuffix, const llvm::Triple &Triple)
Definition: CommonArgs.cpp:1968
clang::driver::ToolChain::isPIEDefault
virtual bool isPIEDefault() const =0
Test whether this toolchain defaults to PIE.
clang::driver::tools::isUseSeparateSections
bool isUseSeparateSections(const llvm::Triple &Triple)
Definition: CommonArgs.cpp:479
clang::driver::ToolChain::getArch
llvm::Triple::ArchType getArch() const
Definition: ToolChain.h:237
AddLibgcc
static void AddLibgcc(const ToolChain &TC, const Driver &D, ArgStringList &CmdArgs, const ArgList &Args)
Definition: CommonArgs.cpp:1470
clang::driver::tools::haveAMDGPUCodeObjectVersionArgument
bool haveAMDGPUCodeObjectVersionArgument(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:1930
clang::driver::SanitizerArgs::needsLsanRt
bool needsLsanRt() const
Definition: SanitizerArgs.h:83
renderRemarksHotnessOptions
static void renderRemarksHotnessOptions(const ArgList &Args, ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:110
clang::driver::tools::addLTOOptions
void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfo &Input, bool IsThinLTO)
ToolChain.h
clang::driver::ToolChain::FT_Static
@ FT_Static
Definition: ToolChain.h:123
clang::driver::ToolChain::GetUnwindLibType
virtual UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:783
clang::driver::tools::unifyTargetFeatures
std::vector< StringRef > unifyTargetFeatures(const std::vector< StringRef > &Features)
If there are multiple +xxx or -xxx features, keep the last one.
Definition: CommonArgs.cpp:147
CharInfo.h
clang::driver::ToolChain::AddCXXStdlibLibArgs
virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition: ToolChain.cpp:938
clang::driver::ToolChain::getArchSpecificLibPath
std::string getArchSpecificLibPath() const
Definition: ToolChain.cpp:502
clang::driver::ToolChain::GetRuntimeLibType
virtual RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:757
Compilation.h
clang::driver::ToolChain::isPICDefaultForced
virtual bool isPICDefaultForced() const =0
Tests whether this toolchain forces its default for PIC, PIE or non-PIC.
clang::driver::SanitizerArgs::needsHwasanAliasesRt
bool needsHwasanAliasesRt() const
Definition: SanitizerArgs.h:77
addSanitizerRuntime
static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs, StringRef Sanitizer, bool IsShared, bool IsWhole)
Definition: CommonArgs.cpp:708
clang::driver::Driver::GetTemporaryPath
std::string GetTemporaryPath(StringRef Prefix, StringRef Suffix) const
GetTemporaryPath - Return the pathname of a temporary file to use as part of compilation; the file wi...
Definition: Driver.cpp:5216
clang::driver::ToolChain::getCompilerRTArgString
const char * getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:484
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
clang::driver::ToolChain::RLT_CompilerRT
@ RLT_CompilerRT
Definition: ToolChain.h:101
Value
Value
Definition: UninitializedValues.cpp:102
getAsNeededOption
static const char * getAsNeededOption(const ToolChain &TC, bool as_needed)
Definition: CommonArgs.cpp:740
clang::driver::SanitizerArgs::needsCfiRt
bool needsCfiRt() const
Definition: SanitizerArgs.cpp:258
clang::driver::tools::arm::getARMTargetCPU
std::string getARMTargetCPU(StringRef CPU, llvm::StringRef Arch, const llvm::Triple &Triple)
clang::driver::tools::ppc::getPPCTargetCPU
std::string getPPCTargetCPU(const llvm::opt::ArgList &Args)
clang::driver::tools::AddRunTimeLibs
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
clang::driver::Action::getOffloadingDeviceKind
OffloadKind getOffloadingDeviceKind() const
Definition: Action.h:199
clang::driver::SanitizerArgs::needsMemProfRt
bool needsMemProfRt() const
Definition: SanitizerArgs.h:72
clang::driver::SanitizerArgs::needsCfiDiagRt
bool needsCfiDiagRt() const
Definition: SanitizerArgs.cpp:263
clang::driver::tools::AddTargetFeature
void AddTargetFeature(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier OnOpt, llvm::opt::OptSpecifier OffOpt, StringRef FeatureName)
clang::driver::Compilation
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
LibGccType::UnspecifiedLibGcc
@ UnspecifiedLibGcc
clang::driver::tools::arm::getARMArchCPUFromArgs
void getARMArchCPUFromArgs(const llvm::opt::ArgList &Args, llvm::StringRef &Arch, llvm::StringRef &CPU, bool FromAs=false)
AddUnwindLibrary
static void AddUnwindLibrary(const ToolChain &TC, const Driver &D, ArgStringList &CmdArgs, const ArgList &Args)
Definition: CommonArgs.cpp:1419
clang::driver::willEmitRemarks
bool willEmitRemarks(const llvm::opt::ArgList &Args)
renderRemarksOptions
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs, const llvm::Triple &Triple, const InputInfo &Input, const InputInfo &Output)
Definition: CommonArgs.cpp:80
clang::driver::Tool::getToolChain
const ToolChain & getToolChain() const
Definition: Tool.h:52
LibGccType::SharedLibGcc
@ SharedLibGcc
clang::driver::tools::addOpenMPRuntime
bool addOpenMPRuntime(llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC, const llvm::opt::ArgList &Args, bool ForceStaticHostRuntime=false, bool IsOffloadingHost=false, bool GompNeedsRT=false)
Returns true, if an OpenMP runtime has been added.
clang::driver::tools::addArchSpecificRPath
void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::InputInfo::getFilename
const char * getFilename() const
Definition: InputInfo.h:83
clang::driver::tools::mips::getMipsCPUAndABI
void getMipsCPUAndABI(const llvm::opt::ArgList &Args, const llvm::Triple &Triple, StringRef &CPUName, StringRef &ABIName)
clang::driver::tools::linkSanitizerRuntimeDeps
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
CommonArgs.h
clang
Definition: CalledOnceCheck.h:17
M68k.h
clang::driver::Driver
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:59
Hexagon.h
clang::ComparisonCategoryType::Last
@ Last
clang::driver::SanitizerArgs::linkCXXRuntimes
bool linkCXXRuntimes() const
Definition: SanitizerArgs.h:102
clang::driver::Driver::OMPRT_Unknown
@ OMPRT_Unknown
An unknown OpenMP runtime.
Definition: Driver.h:94
clang::driver::tools::addSanitizerRuntimes
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addMultilibFlag
void addMultilibFlag(bool Enabled, const char *const Flag, Multilib::flags_list &Flags)
Flag must be a flag accepted by the driver with its leading '-' removed,
Definition: CommonArgs.cpp:1536
clang::driver::tools::checkAMDGPUCodeObjectVersion
void checkAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:1886
clang::driver::ToolChain::UnwindLibType
UnwindLibType
Definition: ToolChain.h:105
clang::driver::SanitizerArgs::needsUbsanRt
bool needsUbsanRt() const
Definition: SanitizerArgs.cpp:247
clang::driver::tools::linkXRayRuntimeDeps
void linkXRayRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
clang::driver::tools::addDirectoryList
void addDirectoryList(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *ArgName, const char *EnvVar)
EnvVar is split by system delimiter for environment variables.
clang::driver::Driver::getVFS
llvm::vfs::FileSystem & getVFS() const
Definition: Driver.h:329
clang::driver::SanitizerArgs::needsDfsanRt
bool needsDfsanRt() const
Definition: SanitizerArgs.h:91
clang::driver::ToolChain::isCrossCompiling
virtual bool isCrossCompiling() const
Returns true if the toolchain is targeting a non-native architecture.
Definition: ToolChain.cpp:642
clang::driver::tools::addLinkerCompressDebugSectionsOption
void addLinkerCompressDebugSectionsOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:285
ARM.h
clang::driver::ToolChain::getXRayArgs
const XRayArgs & getXRayArgs() const
Definition: ToolChain.cpp:123
clang::driver
Definition: Action.h:31
llvm::SmallVectorImpl
Definition: LLVM.h:39
clang::driver::tools::x86::getX86TargetCPU
std::string getX86TargetCPU(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
clang::driver::tools::AddStaticDeviceLibsPostLinking
void AddStaticDeviceLibsPostLinking(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CmdArgs, StringRef Arch, StringRef Target, bool isBitCodeSDL, bool postClangLink)
Definition: CommonArgs.cpp:1788
clang::driver::SanitizerArgs::needsSharedRt
bool needsSharedRt() const
Definition: SanitizerArgs.h:70
clang::driver::ToolChain::FT_Shared
@ FT_Shared
Definition: ToolChain.h:123
clang::driver::Driver::OMPRT_GOMP
@ OMPRT_GOMP
The GNU OpenMP runtime.
Definition: Driver.h:103
clang::driver::JobAction
Definition: Action.h:380
PPC.h
clang::driver::SanitizerArgs::needsStatsRt
bool needsStatsRt() const
Definition: SanitizerArgs.h:95
LibGccType
LibGccType
Definition: CommonArgs.cpp:1387
getAMDGPUTargetGPU
static std::string getAMDGPUTargetGPU(const llvm::Triple &T, const ArgList &Args)
Get the (LLVM) name of the AMDGPU gpu we are targeting.
Definition: CommonArgs.cpp:316
clang::driver::tools::getStatsFileName
SmallString< 128 > getStatsFileName(const llvm::opt::ArgList &Args, const InputInfo &Output, const InputInfo &Input, const Driver &D)
Handles the -save-stats option and returns the filename to save statistics to.
Definition: CommonArgs.cpp:1512
getAMDGPUCodeObjectArgument
static llvm::opt::Arg * getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args)
Definition: CommonArgs.cpp:1878
renderRpassOptions
static void renderRpassOptions(const ArgList &Args, ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:66
clang::driver::tools::SplitDebugName
const char * SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Input, const InputInfo &Output)
clang::driver::tools::isObjCAutoRefCount
bool isObjCAutoRefCount(const llvm::opt::ArgList &Args)
clang::driver::SanitizerArgs::needsMsanRt
bool needsMsanRt() const
Definition: SanitizerArgs.h:81