clang 18.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/CSKY.h"
13#include "Arch/LoongArch.h"
14#include "Arch/M68k.h"
15#include "Arch/Mips.h"
16#include "Arch/PPC.h"
17#include "Arch/RISCV.h"
18#include "Arch/Sparc.h"
19#include "Arch/SystemZ.h"
20#include "Arch/VE.h"
21#include "Arch/X86.h"
22#include "HIPAMD.h"
23#include "Hexagon.h"
24#include "MSP430.h"
25#include "Solaris.h"
30#include "clang/Basic/Version.h"
31#include "clang/Config/config.h"
32#include "clang/Driver/Action.h"
34#include "clang/Driver/Driver.h"
37#include "clang/Driver/Job.h"
41#include "clang/Driver/Util.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/SmallSet.h"
45#include "llvm/ADT/SmallString.h"
46#include "llvm/ADT/StringExtras.h"
47#include "llvm/ADT/StringSwitch.h"
48#include "llvm/ADT/Twine.h"
49#include "llvm/BinaryFormat/Magic.h"
50#include "llvm/Config/llvm-config.h"
51#include "llvm/Option/Arg.h"
52#include "llvm/Option/ArgList.h"
53#include "llvm/Option/Option.h"
54#include "llvm/Support/CodeGen.h"
55#include "llvm/Support/Compression.h"
56#include "llvm/Support/Debug.h"
57#include "llvm/Support/ErrorHandling.h"
58#include "llvm/Support/FileSystem.h"
59#include "llvm/Support/Path.h"
60#include "llvm/Support/Process.h"
61#include "llvm/Support/Program.h"
62#include "llvm/Support/ScopedPrinter.h"
63#include "llvm/Support/Threading.h"
64#include "llvm/Support/VirtualFileSystem.h"
65#include "llvm/Support/YAMLParser.h"
66#include "llvm/TargetParser/Host.h"
67#include "llvm/TargetParser/TargetParser.h"
68#include <optional>
69
70using namespace clang::driver;
71using namespace clang::driver::tools;
72using namespace clang;
73using namespace llvm::opt;
74
75static bool useFramePointerForTargetByDefault(const llvm::opt::ArgList &Args,
76 const llvm::Triple &Triple) {
77 if (Args.hasArg(clang::driver::options::OPT_pg) &&
78 !Args.hasArg(clang::driver::options::OPT_mfentry))
79 return true;
80
81 if (Triple.isAndroid()) {
82 switch (Triple.getArch()) {
83 case llvm::Triple::aarch64:
84 case llvm::Triple::arm:
85 case llvm::Triple::armeb:
86 case llvm::Triple::thumb:
87 case llvm::Triple::thumbeb:
88 case llvm::Triple::riscv64:
89 return true;
90 default:
91 break;
92 }
93 }
94
95 switch (Triple.getArch()) {
96 case llvm::Triple::xcore:
97 case llvm::Triple::wasm32:
98 case llvm::Triple::wasm64:
99 case llvm::Triple::msp430:
100 // XCore never wants frame pointers, regardless of OS.
101 // WebAssembly never wants frame pointers.
102 return false;
103 case llvm::Triple::ppc:
104 case llvm::Triple::ppcle:
105 case llvm::Triple::ppc64:
106 case llvm::Triple::ppc64le:
107 case llvm::Triple::riscv32:
108 case llvm::Triple::riscv64:
109 case llvm::Triple::sparc:
110 case llvm::Triple::sparcel:
111 case llvm::Triple::sparcv9:
112 case llvm::Triple::amdgcn:
113 case llvm::Triple::r600:
114 case llvm::Triple::csky:
115 case llvm::Triple::loongarch32:
116 case llvm::Triple::loongarch64:
118 default:
119 break;
120 }
121
122 if (Triple.isOSFuchsia() || Triple.isOSNetBSD()) {
124 }
125
126 if (Triple.isOSLinux() || Triple.isOSHurd()) {
127 switch (Triple.getArch()) {
128 // Don't use a frame pointer on linux if optimizing for certain targets.
129 case llvm::Triple::arm:
130 case llvm::Triple::armeb:
131 case llvm::Triple::thumb:
132 case llvm::Triple::thumbeb:
133 case llvm::Triple::mips64:
134 case llvm::Triple::mips64el:
135 case llvm::Triple::mips:
136 case llvm::Triple::mipsel:
137 case llvm::Triple::systemz:
138 case llvm::Triple::x86:
139 case llvm::Triple::x86_64:
141 default:
142 return true;
143 }
144 }
145
146 if (Triple.isOSWindows()) {
147 switch (Triple.getArch()) {
148 case llvm::Triple::x86:
150 case llvm::Triple::x86_64:
151 return Triple.isOSBinFormatMachO();
152 case llvm::Triple::arm:
153 case llvm::Triple::thumb:
154 // Windows on ARM builds with FPO disabled to aid fast stack walking
155 return true;
156 default:
157 // All other supported Windows ISAs use xdata unwind information, so frame
158 // pointers are not generally useful.
159 return false;
160 }
161 }
162
163 return true;
164}
165
166static bool mustUseNonLeafFramePointerForTarget(const llvm::Triple &Triple) {
167 switch (Triple.getArch()) {
168 default:
169 return false;
170 case llvm::Triple::arm:
171 case llvm::Triple::thumb:
172 // ARM Darwin targets require a frame pointer to be always present to aid
173 // offline debugging via backtraces.
174 return Triple.isOSDarwin();
175 }
176}
177
179getFramePointerKind(const llvm::opt::ArgList &Args,
180 const llvm::Triple &Triple) {
181 // We have 4 states:
182 //
183 // 00) leaf retained, non-leaf retained
184 // 01) leaf retained, non-leaf omitted (this is invalid)
185 // 10) leaf omitted, non-leaf retained
186 // (what -momit-leaf-frame-pointer was designed for)
187 // 11) leaf omitted, non-leaf omitted
188 //
189 // "omit" options taking precedence over "no-omit" options is the only way
190 // to make 3 valid states representable
191 llvm::opt::Arg *A =
192 Args.getLastArg(clang::driver::options::OPT_fomit_frame_pointer,
193 clang::driver::options::OPT_fno_omit_frame_pointer);
194
195 bool OmitFP = A && A->getOption().matches(
196 clang::driver::options::OPT_fomit_frame_pointer);
197 bool NoOmitFP = A && A->getOption().matches(
198 clang::driver::options::OPT_fno_omit_frame_pointer);
199 bool OmitLeafFP =
200 Args.hasFlag(clang::driver::options::OPT_momit_leaf_frame_pointer,
201 clang::driver::options::OPT_mno_omit_leaf_frame_pointer,
202 Triple.isAArch64() || Triple.isPS() || Triple.isVE() ||
203 (Triple.isAndroid() && Triple.isRISCV64()));
204 if (NoOmitFP || mustUseNonLeafFramePointerForTarget(Triple) ||
205 (!OmitFP && useFramePointerForTargetByDefault(Args, Triple))) {
206 if (OmitLeafFP)
209 }
211}
212
213static void renderRpassOptions(const ArgList &Args, ArgStringList &CmdArgs,
214 const StringRef PluginOptPrefix) {
215 if (const Arg *A = Args.getLastArg(options::OPT_Rpass_EQ))
216 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
217 "-pass-remarks=" + A->getValue()));
218
219 if (const Arg *A = Args.getLastArg(options::OPT_Rpass_missed_EQ))
220 CmdArgs.push_back(Args.MakeArgString(
221 Twine(PluginOptPrefix) + "-pass-remarks-missed=" + A->getValue()));
222
223 if (const Arg *A = Args.getLastArg(options::OPT_Rpass_analysis_EQ))
224 CmdArgs.push_back(Args.MakeArgString(
225 Twine(PluginOptPrefix) + "-pass-remarks-analysis=" + A->getValue()));
226}
227
228static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
229 const llvm::Triple &Triple,
230 const InputInfo &Input,
231 const InputInfo &Output,
232 const StringRef PluginOptPrefix) {
233 StringRef Format = "yaml";
234 if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
235 Format = A->getValue();
236
238 const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
239 if (A)
240 F = A->getValue();
241 else if (Output.isFilename())
242 F = Output.getFilename();
243
244 assert(!F.empty() && "Cannot determine remarks output name.");
245 // Append "opt.ld.<format>" to the end of the file name.
246 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
247 "opt-remarks-filename=" + F +
248 ".opt.ld." + Format));
249
250 if (const Arg *A =
251 Args.getLastArg(options::OPT_foptimization_record_passes_EQ))
252 CmdArgs.push_back(Args.MakeArgString(
253 Twine(PluginOptPrefix) + "opt-remarks-passes=" + A->getValue()));
254
255 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
256 "opt-remarks-format=" + Format.data()));
257}
258
259static void renderRemarksHotnessOptions(const ArgList &Args,
260 ArgStringList &CmdArgs,
261 const StringRef PluginOptPrefix) {
262 if (Args.hasFlag(options::OPT_fdiagnostics_show_hotness,
263 options::OPT_fno_diagnostics_show_hotness, false))
264 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
265 "opt-remarks-with-hotness"));
266
267 if (const Arg *A =
268 Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ))
269 CmdArgs.push_back(
270 Args.MakeArgString(Twine(PluginOptPrefix) +
271 "opt-remarks-hotness-threshold=" + A->getValue()));
272}
273
274static bool shouldIgnoreUnsupportedTargetFeature(const Arg &TargetFeatureArg,
275 llvm::Triple T,
276 StringRef Processor) {
277 // Warn no-cumode for AMDGCN processors not supporing WGP mode.
278 if (!T.isAMDGPU())
279 return false;
280 auto GPUKind = T.isAMDGCN() ? llvm::AMDGPU::parseArchAMDGCN(Processor)
281 : llvm::AMDGPU::parseArchR600(Processor);
282 auto GPUFeatures = T.isAMDGCN() ? llvm::AMDGPU::getArchAttrAMDGCN(GPUKind)
283 : llvm::AMDGPU::getArchAttrR600(GPUKind);
284 if (GPUFeatures & llvm::AMDGPU::FEATURE_WGP)
285 return false;
286 return TargetFeatureArg.getOption().matches(options::OPT_mno_cumode);
287}
288
289void tools::addPathIfExists(const Driver &D, const Twine &Path,
290 ToolChain::path_list &Paths) {
291 if (D.getVFS().exists(Path))
292 Paths.push_back(Path.str());
293}
294
296 const llvm::Triple &Triple,
297 const ArgList &Args,
298 std::vector<StringRef> &Features,
299 OptSpecifier Group) {
300 std::set<StringRef> Warned;
301 for (const Arg *A : Args.filtered(Group)) {
302 StringRef Name = A->getOption().getName();
303 A->claim();
304
305 // Skip over "-m".
306 assert(Name.startswith("m") && "Invalid feature name.");
307 Name = Name.substr(1);
308
309 auto Proc = getCPUName(D, Args, Triple);
310 if (shouldIgnoreUnsupportedTargetFeature(*A, Triple, Proc)) {
311 if (Warned.count(Name) == 0) {
312 D.getDiags().Report(
313 clang::diag::warn_drv_unsupported_option_for_processor)
314 << A->getAsString(Args) << Proc;
315 Warned.insert(Name);
316 }
317 continue;
318 }
319
320 bool IsNegative = Name.startswith("no-");
321 if (IsNegative)
322 Name = Name.substr(3);
323
324 Features.push_back(Args.MakeArgString((IsNegative ? "-" : "+") + Name));
325 }
326}
327
330 // Only add a feature if it hasn't been seen before starting from the end.
331 SmallVector<StringRef> UnifiedFeatures;
332 llvm::DenseSet<StringRef> UsedFeatures;
333 for (StringRef Feature : llvm::reverse(Features)) {
334 if (UsedFeatures.insert(Feature.drop_front()).second)
335 UnifiedFeatures.insert(UnifiedFeatures.begin(), Feature);
336 }
337
338 return UnifiedFeatures;
339}
340
341void tools::addDirectoryList(const ArgList &Args, ArgStringList &CmdArgs,
342 const char *ArgName, const char *EnvVar) {
343 const char *DirList = ::getenv(EnvVar);
344 bool CombinedArg = false;
345
346 if (!DirList)
347 return; // Nothing to do.
348
349 StringRef Name(ArgName);
350 if (Name.equals("-I") || Name.equals("-L") || Name.empty())
351 CombinedArg = true;
352
353 StringRef Dirs(DirList);
354 if (Dirs.empty()) // Empty string should not add '.'.
355 return;
356
357 StringRef::size_type Delim;
358 while ((Delim = Dirs.find(llvm::sys::EnvPathSeparator)) != StringRef::npos) {
359 if (Delim == 0) { // Leading colon.
360 if (CombinedArg) {
361 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
362 } else {
363 CmdArgs.push_back(ArgName);
364 CmdArgs.push_back(".");
365 }
366 } else {
367 if (CombinedArg) {
368 CmdArgs.push_back(
369 Args.MakeArgString(std::string(ArgName) + Dirs.substr(0, Delim)));
370 } else {
371 CmdArgs.push_back(ArgName);
372 CmdArgs.push_back(Args.MakeArgString(Dirs.substr(0, Delim)));
373 }
374 }
375 Dirs = Dirs.substr(Delim + 1);
376 }
377
378 if (Dirs.empty()) { // Trailing colon.
379 if (CombinedArg) {
380 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
381 } else {
382 CmdArgs.push_back(ArgName);
383 CmdArgs.push_back(".");
384 }
385 } else { // Add the last path.
386 if (CombinedArg) {
387 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + Dirs));
388 } else {
389 CmdArgs.push_back(ArgName);
390 CmdArgs.push_back(Args.MakeArgString(Dirs));
391 }
392 }
393}
394
395void tools::AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
396 const ArgList &Args, ArgStringList &CmdArgs,
397 const JobAction &JA) {
398 const Driver &D = TC.getDriver();
399
400 // Add extra linker input arguments which are not treated as inputs
401 // (constructed via -Xarch_).
402 Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
403
404 // LIBRARY_PATH are included before user inputs and only supported on native
405 // toolchains.
406 if (!TC.isCrossCompiling())
407 addDirectoryList(Args, CmdArgs, "-L", "LIBRARY_PATH");
408
409 for (const auto &II : Inputs) {
410 // If the current tool chain refers to an OpenMP offloading host, we
411 // should ignore inputs that refer to OpenMP offloading devices -
412 // they will be embedded according to a proper linker script.
413 if (auto *IA = II.getAction())
415 IA->isDeviceOffloading(Action::OFK_OpenMP)))
416 continue;
417
418 if (!TC.HasNativeLLVMSupport() && types::isLLVMIR(II.getType()))
419 // Don't try to pass LLVM inputs unless we have native support.
420 D.Diag(diag::err_drv_no_linker_llvm_support) << TC.getTripleString();
421
422 // Add filenames immediately.
423 if (II.isFilename()) {
424 CmdArgs.push_back(II.getFilename());
425 continue;
426 }
427
428 // In some error cases, the input could be Nothing; skip those.
429 if (II.isNothing())
430 continue;
431
432 // Otherwise, this is a linker input argument.
433 const Arg &A = II.getInputArg();
434
435 // Handle reserved library options.
436 if (A.getOption().matches(options::OPT_Z_reserved_lib_stdcxx))
437 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
438 else if (A.getOption().matches(options::OPT_Z_reserved_lib_cckext))
439 TC.AddCCKextLibArgs(Args, CmdArgs);
440 else
441 A.renderAsInput(Args, CmdArgs);
442 }
443}
444
446 const ToolChain &TC, const llvm::opt::ArgList &Args,
447 llvm::opt::ArgStringList &CmdArgs) {
448 // GNU ld supports --compress-debug-sections=none|zlib|zlib-gnu|zlib-gabi
449 // whereas zlib is an alias to zlib-gabi and zlib-gnu is obsoleted. Therefore
450 // -gz=none|zlib are translated to --compress-debug-sections=none|zlib. -gz
451 // is not translated since ld --compress-debug-sections option requires an
452 // argument.
453 if (const Arg *A = Args.getLastArg(options::OPT_gz_EQ)) {
454 StringRef V = A->getValue();
455 if (V == "none" || V == "zlib" || V == "zstd")
456 CmdArgs.push_back(Args.MakeArgString("--compress-debug-sections=" + V));
457 else
458 TC.getDriver().Diag(diag::err_drv_unsupported_option_argument)
459 << A->getSpelling() << V;
460 }
461}
462
463void tools::AddTargetFeature(const ArgList &Args,
464 std::vector<StringRef> &Features,
465 OptSpecifier OnOpt, OptSpecifier OffOpt,
466 StringRef FeatureName) {
467 if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
468 if (A->getOption().matches(OnOpt))
469 Features.push_back(Args.MakeArgString("+" + FeatureName));
470 else
471 Features.push_back(Args.MakeArgString("-" + FeatureName));
472 }
473}
474
475/// Get the (LLVM) name of the AMDGPU gpu we are targeting.
476static std::string getAMDGPUTargetGPU(const llvm::Triple &T,
477 const ArgList &Args) {
478 Arg *MArch = Args.getLastArg(options::OPT_march_EQ);
479 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
480 auto GPUName = getProcessorFromTargetID(T, A->getValue());
481 return llvm::StringSwitch<std::string>(GPUName)
482 .Cases("rv630", "rv635", "r600")
483 .Cases("rv610", "rv620", "rs780", "rs880")
484 .Case("rv740", "rv770")
485 .Case("palm", "cedar")
486 .Cases("sumo", "sumo2", "sumo")
487 .Case("hemlock", "cypress")
488 .Case("aruba", "cayman")
489 .Default(GPUName.str());
490 }
491 if (MArch)
492 return getProcessorFromTargetID(T, MArch->getValue()).str();
493 return "";
494}
495
496static std::string getLanaiTargetCPU(const ArgList &Args) {
497 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
498 return A->getValue();
499 }
500 return "";
501}
502
503/// Get the (LLVM) name of the WebAssembly cpu we are targeting.
504static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
505 // If we have -mcpu=, use that.
506 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
507 StringRef CPU = A->getValue();
508
509#ifdef __wasm__
510 // Handle "native" by examining the host. "native" isn't meaningful when
511 // cross compiling, so only support this when the host is also WebAssembly.
512 if (CPU == "native")
513 return llvm::sys::getHostCPUName();
514#endif
515
516 return CPU;
517 }
518
519 return "generic";
520}
521
522std::string tools::getCPUName(const Driver &D, const ArgList &Args,
523 const llvm::Triple &T, bool FromAs) {
524 Arg *A;
525
526 switch (T.getArch()) {
527 default:
528 return "";
529
530 case llvm::Triple::aarch64:
531 case llvm::Triple::aarch64_32:
532 case llvm::Triple::aarch64_be:
533 return aarch64::getAArch64TargetCPU(Args, T, A);
534
535 case llvm::Triple::arm:
536 case llvm::Triple::armeb:
537 case llvm::Triple::thumb:
538 case llvm::Triple::thumbeb: {
539 StringRef MArch, MCPU;
540 arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
541 return arm::getARMTargetCPU(MCPU, MArch, T);
542 }
543
544 case llvm::Triple::avr:
545 if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
546 return A->getValue();
547 return "";
548
549 case llvm::Triple::m68k:
550 return m68k::getM68kTargetCPU(Args);
551
552 case llvm::Triple::mips:
553 case llvm::Triple::mipsel:
554 case llvm::Triple::mips64:
555 case llvm::Triple::mips64el: {
556 StringRef CPUName;
557 StringRef ABIName;
558 mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
559 return std::string(CPUName);
560 }
561
562 case llvm::Triple::nvptx:
563 case llvm::Triple::nvptx64:
564 if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
565 return A->getValue();
566 return "";
567
568 case llvm::Triple::ppc:
569 case llvm::Triple::ppcle:
570 case llvm::Triple::ppc64:
571 case llvm::Triple::ppc64le:
572 return ppc::getPPCTargetCPU(D, Args, T);
573
574 case llvm::Triple::csky:
575 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
576 return A->getValue();
577 else if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
578 return A->getValue();
579 else
580 return "ck810";
581 case llvm::Triple::riscv32:
582 case llvm::Triple::riscv64:
583 return riscv::getRISCVTargetCPU(Args, T);
584
585 case llvm::Triple::bpfel:
586 case llvm::Triple::bpfeb:
587 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
588 return A->getValue();
589 return "";
590
591 case llvm::Triple::sparc:
592 case llvm::Triple::sparcel:
593 case llvm::Triple::sparcv9:
594 return sparc::getSparcTargetCPU(D, Args, T);
595
596 case llvm::Triple::x86:
597 case llvm::Triple::x86_64:
598 return x86::getX86TargetCPU(D, Args, T);
599
600 case llvm::Triple::hexagon:
601 return "hexagon" +
603
604 case llvm::Triple::lanai:
605 return getLanaiTargetCPU(Args);
606
607 case llvm::Triple::systemz:
608 return systemz::getSystemZTargetCPU(Args);
609
610 case llvm::Triple::r600:
611 case llvm::Triple::amdgcn:
612 return getAMDGPUTargetGPU(T, Args);
613
614 case llvm::Triple::wasm32:
615 case llvm::Triple::wasm64:
616 return std::string(getWebAssemblyTargetCPU(Args));
617
618 case llvm::Triple::loongarch32:
619 case llvm::Triple::loongarch64:
620 return loongarch::getLoongArchTargetCPU(Args, T);
621 }
622}
623
625 const llvm::Triple &Triple,
626 const ArgList &Args,
627 std::vector<StringRef> &Features) {
628 handleTargetFeaturesGroup(D, Triple, Args, Features,
629 options::OPT_m_wasm_Features_Group);
630}
631
632void tools::getTargetFeatures(const Driver &D, const llvm::Triple &Triple,
633 const ArgList &Args, ArgStringList &CmdArgs,
634 bool ForAS, bool IsAux) {
635 std::vector<StringRef> Features;
636 switch (Triple.getArch()) {
637 default:
638 break;
639 case llvm::Triple::mips:
640 case llvm::Triple::mipsel:
641 case llvm::Triple::mips64:
642 case llvm::Triple::mips64el:
643 mips::getMIPSTargetFeatures(D, Triple, Args, Features);
644 break;
645 case llvm::Triple::arm:
646 case llvm::Triple::armeb:
647 case llvm::Triple::thumb:
648 case llvm::Triple::thumbeb:
649 arm::getARMTargetFeatures(D, Triple, Args, Features, ForAS);
650 break;
651 case llvm::Triple::ppc:
652 case llvm::Triple::ppcle:
653 case llvm::Triple::ppc64:
654 case llvm::Triple::ppc64le:
655 ppc::getPPCTargetFeatures(D, Triple, Args, Features);
656 break;
657 case llvm::Triple::riscv32:
658 case llvm::Triple::riscv64:
659 riscv::getRISCVTargetFeatures(D, Triple, Args, Features);
660 break;
661 case llvm::Triple::systemz:
662 systemz::getSystemZTargetFeatures(D, Args, Features);
663 break;
664 case llvm::Triple::aarch64:
665 case llvm::Triple::aarch64_32:
666 case llvm::Triple::aarch64_be:
667 aarch64::getAArch64TargetFeatures(D, Triple, Args, Features, ForAS);
668 break;
669 case llvm::Triple::x86:
670 case llvm::Triple::x86_64:
671 x86::getX86TargetFeatures(D, Triple, Args, Features);
672 break;
673 case llvm::Triple::hexagon:
674 hexagon::getHexagonTargetFeatures(D, Triple, Args, Features);
675 break;
676 case llvm::Triple::wasm32:
677 case llvm::Triple::wasm64:
678 getWebAssemblyTargetFeatures(D, Triple, Args, Features);
679 break;
680 case llvm::Triple::sparc:
681 case llvm::Triple::sparcel:
682 case llvm::Triple::sparcv9:
683 sparc::getSparcTargetFeatures(D, Args, Features);
684 break;
685 case llvm::Triple::r600:
686 case llvm::Triple::amdgcn:
687 amdgpu::getAMDGPUTargetFeatures(D, Triple, Args, Features);
688 break;
689 case llvm::Triple::nvptx:
690 case llvm::Triple::nvptx64:
691 NVPTX::getNVPTXTargetFeatures(D, Triple, Args, Features);
692 break;
693 case llvm::Triple::m68k:
694 m68k::getM68kTargetFeatures(D, Triple, Args, Features);
695 break;
696 case llvm::Triple::msp430:
697 msp430::getMSP430TargetFeatures(D, Args, Features);
698 break;
699 case llvm::Triple::ve:
700 ve::getVETargetFeatures(D, Args, Features);
701 break;
702 case llvm::Triple::csky:
703 csky::getCSKYTargetFeatures(D, Triple, Args, CmdArgs, Features);
704 break;
705 case llvm::Triple::loongarch32:
706 case llvm::Triple::loongarch64:
707 loongarch::getLoongArchTargetFeatures(D, Triple, Args, Features);
708 break;
709 }
710
711 for (auto Feature : unifyTargetFeatures(Features)) {
712 CmdArgs.push_back(IsAux ? "-aux-target-feature" : "-target-feature");
713 CmdArgs.push_back(Feature.data());
714 }
715}
716
717llvm::StringRef tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
718 Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
719 if (!LtoJobsArg)
720 return {};
721 if (!llvm::get_threadpool_strategy(LtoJobsArg->getValue()))
722 D.Diag(diag::err_drv_invalid_int_value)
723 << LtoJobsArg->getAsString(Args) << LtoJobsArg->getValue();
724 return LtoJobsArg->getValue();
725}
726
727// PS4/PS5 uses -ffunction-sections and -fdata-sections by default.
728bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
729 return Triple.isPS();
730}
731
732void tools::addLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
733 ArgStringList &CmdArgs, const InputInfo &Output,
734 const InputInfo &Input, bool IsThinLTO) {
735 const bool IsOSAIX = ToolChain.getTriple().isOSAIX();
736 const bool IsAMDGCN = ToolChain.getTriple().isAMDGCN();
737 const char *Linker = Args.MakeArgString(ToolChain.GetLinkerPath());
738 const Driver &D = ToolChain.getDriver();
739 if (llvm::sys::path::filename(Linker) != "ld.lld" &&
740 llvm::sys::path::stem(Linker) != "ld.lld" &&
741 !ToolChain.getTriple().isOSOpenBSD()) {
742 // Tell the linker to load the plugin. This has to come before
743 // AddLinkerInputs as gold requires -plugin and AIX ld requires -bplugin to
744 // come before any -plugin-opt/-bplugin_opt that -Wl might forward.
745 const char *PluginPrefix = IsOSAIX ? "-bplugin:" : "";
746 const char *PluginName = IsOSAIX ? "/libLTO" : "/LLVMgold";
747
748 if (!IsOSAIX)
749 CmdArgs.push_back("-plugin");
750
751#if defined(_WIN32)
752 const char *Suffix = ".dll";
753#elif defined(__APPLE__)
754 const char *Suffix = ".dylib";
755#else
756 const char *Suffix = ".so";
757#endif
758
759 SmallString<1024> Plugin;
760 llvm::sys::path::native(Twine(D.Dir) +
761 "/../" CLANG_INSTALL_LIBDIR_BASENAME +
762 PluginName + Suffix,
763 Plugin);
764 CmdArgs.push_back(Args.MakeArgString(Twine(PluginPrefix) + Plugin));
765 } else {
766 // Tell LLD to find and use .llvm.lto section in regular relocatable object
767 // files
768 if (Args.hasArg(options::OPT_ffat_lto_objects))
769 CmdArgs.push_back("--fat-lto-objects");
770 }
771
772 const char *PluginOptPrefix = IsOSAIX ? "-bplugin_opt:" : "-plugin-opt=";
773 const char *ExtraDash = IsOSAIX ? "-" : "";
774 const char *ParallelismOpt = IsOSAIX ? "-threads=" : "jobs=";
775
776 // Note, this solution is far from perfect, better to encode it into IR
777 // metadata, but this may not be worth it, since it looks like aranges is on
778 // the way out.
779 if (Args.hasArg(options::OPT_gdwarf_aranges)) {
780 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
781 "-generate-arange-section"));
782 }
783
784 // Try to pass driver level flags relevant to LTO code generation down to
785 // the plugin.
786
787 // Handle flags for selecting CPU variants.
788 std::string CPU = getCPUName(D, Args, ToolChain.getTriple());
789 if (!CPU.empty())
790 CmdArgs.push_back(
791 Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash + "mcpu=" + CPU));
792
793 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
794 // The optimization level matches
795 // CompilerInvocation.cpp:getOptimizationLevel().
796 StringRef OOpt;
797 if (A->getOption().matches(options::OPT_O4) ||
798 A->getOption().matches(options::OPT_Ofast))
799 OOpt = "3";
800 else if (A->getOption().matches(options::OPT_O)) {
801 OOpt = A->getValue();
802 if (OOpt == "g")
803 OOpt = "1";
804 else if (OOpt == "s" || OOpt == "z")
805 OOpt = "2";
806 } else if (A->getOption().matches(options::OPT_O0))
807 OOpt = "0";
808 if (!OOpt.empty()) {
809 CmdArgs.push_back(
810 Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash + "O" + OOpt));
811 if (IsAMDGCN)
812 CmdArgs.push_back(Args.MakeArgString(Twine("--lto-CGO") + OOpt));
813 }
814 }
815
816 if (Args.hasArg(options::OPT_gsplit_dwarf))
817 CmdArgs.push_back(Args.MakeArgString(
818 Twine(PluginOptPrefix) + "dwo_dir=" + Output.getFilename() + "_dwo"));
819
820 if (IsThinLTO && !IsOSAIX)
821 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + "thinlto"));
822 else if (IsThinLTO && IsOSAIX)
823 CmdArgs.push_back(Args.MakeArgString(Twine("-bdbg:thinlto")));
824
825 // Matrix intrinsic lowering happens at link time with ThinLTO. Enable
826 // LowerMatrixIntrinsicsPass, which is transitively called by
827 // buildThinLTODefaultPipeline under EnableMatrix.
828 if (IsThinLTO && Args.hasArg(options::OPT_fenable_matrix))
829 CmdArgs.push_back(
830 Args.MakeArgString(Twine(PluginOptPrefix) + "-enable-matrix"));
831
832 StringRef Parallelism = getLTOParallelism(Args, D);
833 if (!Parallelism.empty())
834 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
835 ParallelismOpt + Parallelism));
836
837 // Pass down GlobalISel options.
838 if (Arg *A = Args.getLastArg(options::OPT_fglobal_isel,
839 options::OPT_fno_global_isel)) {
840 // Parsing -fno-global-isel explicitly gives architectures that enable GISel
841 // by default a chance to disable it.
842 CmdArgs.push_back(Args.MakeArgString(
843 Twine(PluginOptPrefix) + "-global-isel=" +
844 (A->getOption().matches(options::OPT_fglobal_isel) ? "1" : "0")));
845 }
846
847 // If an explicit debugger tuning argument appeared, pass it along.
848 if (Arg *A =
849 Args.getLastArg(options::OPT_gTune_Group, options::OPT_ggdbN_Group)) {
850 if (A->getOption().matches(options::OPT_glldb))
851 CmdArgs.push_back(
852 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=lldb"));
853 else if (A->getOption().matches(options::OPT_gsce))
854 CmdArgs.push_back(
855 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=sce"));
856 else if (A->getOption().matches(options::OPT_gdbx))
857 CmdArgs.push_back(
858 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=dbx"));
859 else
860 CmdArgs.push_back(
861 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=gdb"));
862 }
863
864 if (IsOSAIX) {
866 CmdArgs.push_back(
867 Args.MakeArgString(Twine(PluginOptPrefix) + "-no-integrated-as=1"));
868
869 // On AIX, clang assumes strict-dwarf is true if any debug option is
870 // specified, unless it is told explicitly not to assume so.
871 Arg *A = Args.getLastArg(options::OPT_g_Group);
872 bool EnableDebugInfo = A && !A->getOption().matches(options::OPT_g0) &&
873 !A->getOption().matches(options::OPT_ggdb0);
874 if (EnableDebugInfo && Args.hasFlag(options::OPT_gstrict_dwarf,
875 options::OPT_gno_strict_dwarf, true))
876 CmdArgs.push_back(
877 Args.MakeArgString(Twine(PluginOptPrefix) + "-strict-dwarf=true"));
878
879 for (const Arg *A : Args.filtered_reverse(options::OPT_mabi_EQ)) {
880 StringRef V = A->getValue();
881 if (V == "vec-default")
882 break;
883 if (V == "vec-extabi") {
884 CmdArgs.push_back(
885 Args.MakeArgString(Twine(PluginOptPrefix) + "-vec-extabi"));
886 break;
887 }
888 }
889 }
890
891 bool UseSeparateSections =
893
894 if (Args.hasFlag(options::OPT_ffunction_sections,
895 options::OPT_fno_function_sections, UseSeparateSections))
896 CmdArgs.push_back(
897 Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=1"));
898 else if (Args.hasArg(options::OPT_fno_function_sections))
899 CmdArgs.push_back(
900 Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=0"));
901
902 bool DataSectionsTurnedOff = false;
903 if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
904 UseSeparateSections)) {
905 CmdArgs.push_back(
906 Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=1"));
907 } else if (Args.hasArg(options::OPT_fno_data_sections)) {
908 DataSectionsTurnedOff = true;
909 CmdArgs.push_back(
910 Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=0"));
911 }
912
913 if (Args.hasArg(options::OPT_mxcoff_roptr) ||
914 Args.hasArg(options::OPT_mno_xcoff_roptr)) {
915 bool HasRoptr = Args.hasFlag(options::OPT_mxcoff_roptr,
916 options::OPT_mno_xcoff_roptr, false);
917 StringRef OptStr = HasRoptr ? "-mxcoff-roptr" : "-mno-xcoff-roptr";
918
919 if (!IsOSAIX)
920 D.Diag(diag::err_drv_unsupported_opt_for_target)
921 << OptStr << ToolChain.getTriple().str();
922
923 if (HasRoptr) {
924 // The data sections option is on by default on AIX. We only need to error
925 // out when -fno-data-sections is specified explicitly to turn off data
926 // sections.
927 if (DataSectionsTurnedOff)
928 D.Diag(diag::err_roptr_requires_data_sections);
929
930 CmdArgs.push_back(
931 Args.MakeArgString(Twine(PluginOptPrefix) + "-mxcoff-roptr"));
932 }
933 }
934
935 // Pass an option to enable split machine functions.
936 if (auto *A = Args.getLastArg(options::OPT_fsplit_machine_functions,
937 options::OPT_fno_split_machine_functions)) {
938 if (A->getOption().matches(options::OPT_fsplit_machine_functions))
939 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
940 "-split-machine-functions"));
941 }
942
943 if (Arg *A = getLastProfileSampleUseArg(Args)) {
944 StringRef FName = A->getValue();
945 if (!llvm::sys::fs::exists(FName))
946 D.Diag(diag::err_drv_no_such_file) << FName;
947 else
948 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
949 "sample-profile=" + FName));
950 }
951
952 if (auto *CSPGOGenerateArg = getLastCSProfileGenerateArg(Args)) {
953 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
954 "cs-profile-generate"));
955 if (CSPGOGenerateArg->getOption().matches(
956 options::OPT_fcs_profile_generate_EQ)) {
957 SmallString<128> Path(CSPGOGenerateArg->getValue());
958 llvm::sys::path::append(Path, "default_%m.profraw");
959 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
960 "cs-profile-path=" + Path));
961 } else
962 CmdArgs.push_back(
963 Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
964 "cs-profile-path=default_%m.profraw"));
965 } else if (auto *ProfileUseArg = getLastProfileUseArg(Args)) {
966 SmallString<128> Path(
967 ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
968 if (Path.empty() || llvm::sys::fs::is_directory(Path))
969 llvm::sys::path::append(Path, "default.profdata");
970 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
971 "cs-profile-path=" + Path));
972 }
973
974 // This controls whether or not we perform JustMyCode instrumentation.
975 if (Args.hasFlag(options::OPT_fjmc, options::OPT_fno_jmc, false)) {
976 if (ToolChain.getEffectiveTriple().isOSBinFormatELF())
977 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
978 "-enable-jmc-instrument"));
979 else
980 D.Diag(clang::diag::warn_drv_fjmc_for_elf_only);
981 }
982
983 if (Args.hasFlag(options::OPT_femulated_tls, options::OPT_fno_emulated_tls,
984 ToolChain.getTriple().hasDefaultEmulatedTLS())) {
985 CmdArgs.push_back(
986 Args.MakeArgString(Twine(PluginOptPrefix) + "-emulated-tls"));
987 }
988
989 if (Args.hasFlag(options::OPT_fstack_size_section,
990 options::OPT_fno_stack_size_section, false))
991 CmdArgs.push_back(
992 Args.MakeArgString(Twine(PluginOptPrefix) + "-stack-size-section"));
993
994 // Setup statistics file output.
995 SmallString<128> StatsFile = getStatsFileName(Args, Output, Input, D);
996 if (!StatsFile.empty())
997 CmdArgs.push_back(
998 Args.MakeArgString(Twine(PluginOptPrefix) + "stats-file=" + StatsFile));
999
1000 // Setup crash diagnostics dir.
1001 if (Arg *A = Args.getLastArg(options::OPT_fcrash_diagnostics_dir))
1002 CmdArgs.push_back(Args.MakeArgString(
1003 Twine(PluginOptPrefix) + "-crash-diagnostics-dir=" + A->getValue()));
1004
1005 addX86AlignBranchArgs(D, Args, CmdArgs, /*IsLTO=*/true, PluginOptPrefix);
1006
1007 // Handle remark diagnostics on screen options: '-Rpass-*'.
1008 renderRpassOptions(Args, CmdArgs, PluginOptPrefix);
1009
1010 // Handle serialized remarks options: '-fsave-optimization-record'
1011 // and '-foptimization-record-*'.
1012 if (willEmitRemarks(Args))
1013 renderRemarksOptions(Args, CmdArgs, ToolChain.getEffectiveTriple(), Input,
1014 Output, PluginOptPrefix);
1015
1016 // Handle remarks hotness/threshold related options.
1017 renderRemarksHotnessOptions(Args, CmdArgs, PluginOptPrefix);
1018
1020 /*IsLTO=*/true, PluginOptPrefix);
1021}
1022
1023/// Adds the '-lcgpu' and '-lmgpu' libraries to the compilation to include the
1024/// LLVM C library for GPUs.
1025static void addOpenMPDeviceLibC(const ToolChain &TC, const ArgList &Args,
1026 ArgStringList &CmdArgs) {
1027 if (Args.hasArg(options::OPT_nogpulib) || Args.hasArg(options::OPT_nolibc))
1028 return;
1029
1030 // Check the resource directory for the LLVM libc GPU declarations. If it's
1031 // found we can assume that LLVM was built with support for the GPU libc.
1032 SmallString<256> LibCDecls(TC.getDriver().ResourceDir);
1033 llvm::sys::path::append(LibCDecls, "include", "llvm_libc_wrappers",
1034 "llvm-libc-decls");
1035 bool HasLibC = llvm::sys::fs::exists(LibCDecls) &&
1036 llvm::sys::fs::is_directory(LibCDecls);
1037 if (Args.hasFlag(options::OPT_gpulibc, options::OPT_nogpulibc, HasLibC)) {
1038 CmdArgs.push_back("-lcgpu");
1039 CmdArgs.push_back("-lmgpu");
1040 }
1041}
1042
1044 const ArgList &Args,
1045 ArgStringList &CmdArgs) {
1046 // Default to clang lib / lib64 folder, i.e. the same location as device
1047 // runtime.
1048 SmallString<256> DefaultLibPath =
1049 llvm::sys::path::parent_path(TC.getDriver().Dir);
1050 llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
1051 CmdArgs.push_back(Args.MakeArgString("-L" + DefaultLibPath));
1052}
1053
1054void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
1055 ArgStringList &CmdArgs) {
1056 if (!Args.hasFlag(options::OPT_frtlib_add_rpath,
1057 options::OPT_fno_rtlib_add_rpath, false))
1058 return;
1059
1060 for (const auto &CandidateRPath : TC.getArchSpecificLibPaths()) {
1061 if (TC.getVFS().exists(CandidateRPath)) {
1062 CmdArgs.push_back("-rpath");
1063 CmdArgs.push_back(Args.MakeArgString(CandidateRPath));
1064 }
1065 }
1066}
1067
1068bool tools::addOpenMPRuntime(ArgStringList &CmdArgs, const ToolChain &TC,
1069 const ArgList &Args, bool ForceStaticHostRuntime,
1070 bool IsOffloadingHost, bool GompNeedsRT) {
1071 if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
1072 options::OPT_fno_openmp, false))
1073 return false;
1074
1076
1077 if (RTKind == Driver::OMPRT_Unknown)
1078 // Already diagnosed.
1079 return false;
1080
1081 if (ForceStaticHostRuntime)
1082 CmdArgs.push_back("-Bstatic");
1083
1084 switch (RTKind) {
1085 case Driver::OMPRT_OMP:
1086 CmdArgs.push_back("-lomp");
1087 break;
1088 case Driver::OMPRT_GOMP:
1089 CmdArgs.push_back("-lgomp");
1090 break;
1092 CmdArgs.push_back("-liomp5");
1093 break;
1095 break;
1096 }
1097
1098 if (ForceStaticHostRuntime)
1099 CmdArgs.push_back("-Bdynamic");
1100
1101 if (RTKind == Driver::OMPRT_GOMP && GompNeedsRT)
1102 CmdArgs.push_back("-lrt");
1103
1104 if (IsOffloadingHost)
1105 CmdArgs.push_back("-lomptarget");
1106
1107 if (IsOffloadingHost && !Args.hasArg(options::OPT_nogpulib))
1108 CmdArgs.push_back("-lomptarget.devicertl");
1109
1110 if (IsOffloadingHost)
1111 addOpenMPDeviceLibC(TC, Args, CmdArgs);
1112
1113 addArchSpecificRPath(TC, Args, CmdArgs);
1114 addOpenMPRuntimeLibraryPath(TC, Args, CmdArgs);
1115
1116 return true;
1117}
1118
1119void tools::addFortranRuntimeLibs(const ToolChain &TC, const ArgList &Args,
1120 llvm::opt::ArgStringList &CmdArgs) {
1121 // These are handled earlier on Windows by telling the frontend driver to add
1122 // the correct libraries to link against as dependents in the object file.
1123 if (!TC.getTriple().isKnownWindowsMSVCEnvironment()) {
1124 // The --whole-archive option needs to be part of the link line to
1125 // make sure that the main() function from Fortran_main.a is pulled
1126 // in by the linker. Determine if --whole-archive is active when
1127 // flang will try to link Fortran_main.a. If it is, don't add the
1128 // --whole-archive flag to the link line. If it's not, add a proper
1129 // --whole-archive/--no-whole-archive bracket to the link line.
1130 bool WholeArchiveActive = false;
1131 for (auto *Arg : Args.filtered(options::OPT_Wl_COMMA))
1132 if (Arg)
1133 for (StringRef ArgValue : Arg->getValues()) {
1134 if (ArgValue == "--whole-archive")
1135 WholeArchiveActive = true;
1136 if (ArgValue == "--no-whole-archive")
1137 WholeArchiveActive = false;
1138 }
1139
1140 if (!WholeArchiveActive)
1141 CmdArgs.push_back("--whole-archive");
1142 CmdArgs.push_back("-lFortran_main");
1143 if (!WholeArchiveActive)
1144 CmdArgs.push_back("--no-whole-archive");
1145
1146 // Perform regular linkage of the remaining runtime libraries.
1147 CmdArgs.push_back("-lFortranRuntime");
1148 CmdArgs.push_back("-lFortranDecimal");
1149 } else {
1150 unsigned RTOptionID = options::OPT__SLASH_MT;
1151 if (auto *rtl = Args.getLastArg(options::OPT_fms_runtime_lib_EQ)) {
1152 RTOptionID = llvm::StringSwitch<unsigned>(rtl->getValue())
1153 .Case("static", options::OPT__SLASH_MT)
1154 .Case("static_dbg", options::OPT__SLASH_MTd)
1155 .Case("dll", options::OPT__SLASH_MD)
1156 .Case("dll_dbg", options::OPT__SLASH_MDd)
1157 .Default(options::OPT__SLASH_MT);
1158 }
1159 switch (RTOptionID) {
1160 case options::OPT__SLASH_MT:
1161 CmdArgs.push_back("/WHOLEARCHIVE:Fortran_main.static.lib");
1162 break;
1163 case options::OPT__SLASH_MTd:
1164 CmdArgs.push_back("/WHOLEARCHIVE:Fortran_main.static_dbg.lib");
1165 break;
1166 case options::OPT__SLASH_MD:
1167 CmdArgs.push_back("/WHOLEARCHIVE:Fortran_main.dynamic.lib");
1168 break;
1169 case options::OPT__SLASH_MDd:
1170 CmdArgs.push_back("/WHOLEARCHIVE:Fortran_main.dynamic_dbg.lib");
1171 break;
1172 }
1173 }
1174}
1175
1177 const llvm::opt::ArgList &Args,
1178 ArgStringList &CmdArgs) {
1179 // Default to the <driver-path>/../lib directory. This works fine on the
1180 // platforms that we have tested so far. We will probably have to re-fine
1181 // this in the future. In particular, on some platforms, we may need to use
1182 // lib64 instead of lib.
1183 SmallString<256> DefaultLibPath =
1184 llvm::sys::path::parent_path(TC.getDriver().Dir);
1185 llvm::sys::path::append(DefaultLibPath, "lib");
1186 if (TC.getTriple().isKnownWindowsMSVCEnvironment())
1187 CmdArgs.push_back(Args.MakeArgString("-libpath:" + DefaultLibPath));
1188 else
1189 CmdArgs.push_back(Args.MakeArgString("-L" + DefaultLibPath));
1190}
1191
1192static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
1193 ArgStringList &CmdArgs, StringRef Sanitizer,
1194 bool IsShared, bool IsWhole) {
1195 // Wrap any static runtimes that must be forced into executable in
1196 // whole-archive.
1197 if (IsWhole) CmdArgs.push_back("--whole-archive");
1198 CmdArgs.push_back(TC.getCompilerRTArgString(
1199 Args, Sanitizer, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static));
1200 if (IsWhole) CmdArgs.push_back("--no-whole-archive");
1201
1202 if (IsShared) {
1203 addArchSpecificRPath(TC, Args, CmdArgs);
1204 }
1205}
1206
1207// Tries to use a file with the list of dynamic symbols that need to be exported
1208// from the runtime library. Returns true if the file was found.
1209static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
1210 ArgStringList &CmdArgs,
1211 StringRef Sanitizer) {
1212 bool LinkerIsGnuLd = solaris::isLinkerGnuLd(TC, Args);
1213
1214 // Solaris ld defaults to --export-dynamic behaviour but doesn't support
1215 // the option, so don't try to pass it.
1216 if (TC.getTriple().isOSSolaris() && !LinkerIsGnuLd)
1217 return true;
1218 SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
1219 if (llvm::sys::fs::exists(SanRT + ".syms")) {
1220 CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
1221 return true;
1222 }
1223 return false;
1224}
1225
1227 const llvm::opt::ArgList &Args,
1228 llvm::opt::ArgStringList &CmdArgs,
1229 bool as_needed) {
1230 assert(!TC.getTriple().isOSAIX() &&
1231 "AIX linker does not support any form of --as-needed option yet.");
1232 bool LinkerIsGnuLd = solaris::isLinkerGnuLd(TC, Args);
1233
1234 // While the Solaris 11.2 ld added --as-needed/--no-as-needed as aliases
1235 // for the native forms -z ignore/-z record, they are missing in Illumos,
1236 // so always use the native form.
1237 // GNU ld doesn't support -z ignore/-z record, so don't use them even on
1238 // Solaris.
1239 if (TC.getTriple().isOSSolaris() && !LinkerIsGnuLd) {
1240 CmdArgs.push_back("-z");
1241 CmdArgs.push_back(as_needed ? "ignore" : "record");
1242 } else {
1243 CmdArgs.push_back(as_needed ? "--as-needed" : "--no-as-needed");
1244 }
1245}
1246
1248 const llvm::opt::ArgList &Args,
1249 ArgStringList &CmdArgs) {
1250 // Force linking against the system libraries sanitizers depends on
1251 // (see PR15823 why this is necessary).
1252 addAsNeededOption(TC, Args, CmdArgs, false);
1253 // There's no libpthread or librt on RTEMS & Android.
1254 if (TC.getTriple().getOS() != llvm::Triple::RTEMS &&
1255 !TC.getTriple().isAndroid() && !TC.getTriple().isOHOSFamily()) {
1256 CmdArgs.push_back("-lpthread");
1257 if (!TC.getTriple().isOSOpenBSD())
1258 CmdArgs.push_back("-lrt");
1259 }
1260 CmdArgs.push_back("-lm");
1261 // There's no libdl on all OSes.
1262 if (!TC.getTriple().isOSFreeBSD() && !TC.getTriple().isOSNetBSD() &&
1263 !TC.getTriple().isOSOpenBSD() &&
1264 TC.getTriple().getOS() != llvm::Triple::RTEMS)
1265 CmdArgs.push_back("-ldl");
1266 // Required for backtrace on some OSes
1267 if (TC.getTriple().isOSFreeBSD() ||
1268 TC.getTriple().isOSNetBSD() ||
1269 TC.getTriple().isOSOpenBSD())
1270 CmdArgs.push_back("-lexecinfo");
1271 // There is no libresolv on Android, FreeBSD, OpenBSD, etc. On musl
1272 // libresolv.a, even if exists, is an empty archive to satisfy POSIX -lresolv
1273 // requirement.
1274 if (TC.getTriple().isOSLinux() && !TC.getTriple().isAndroid() &&
1275 !TC.getTriple().isMusl())
1276 CmdArgs.push_back("-lresolv");
1277}
1278
1279static void
1280collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
1281 SmallVectorImpl<StringRef> &SharedRuntimes,
1282 SmallVectorImpl<StringRef> &StaticRuntimes,
1283 SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
1284 SmallVectorImpl<StringRef> &HelperStaticRuntimes,
1285 SmallVectorImpl<StringRef> &RequiredSymbols) {
1286 const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
1287 // Collect shared runtimes.
1288 if (SanArgs.needsSharedRt()) {
1289 if (SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
1290 SharedRuntimes.push_back("asan");
1291 if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
1292 HelperStaticRuntimes.push_back("asan-preinit");
1293 }
1294 if (SanArgs.needsMemProfRt() && SanArgs.linkRuntimes()) {
1295 SharedRuntimes.push_back("memprof");
1296 if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
1297 HelperStaticRuntimes.push_back("memprof-preinit");
1298 }
1299 if (SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
1300 if (SanArgs.requiresMinimalRuntime())
1301 SharedRuntimes.push_back("ubsan_minimal");
1302 else
1303 SharedRuntimes.push_back("ubsan_standalone");
1304 }
1305 if (SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
1306 SharedRuntimes.push_back("scudo_standalone");
1307 }
1308 if (SanArgs.needsTsanRt() && SanArgs.linkRuntimes())
1309 SharedRuntimes.push_back("tsan");
1310 if (SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
1311 if (SanArgs.needsHwasanAliasesRt())
1312 SharedRuntimes.push_back("hwasan_aliases");
1313 else
1314 SharedRuntimes.push_back("hwasan");
1315 if (!Args.hasArg(options::OPT_shared))
1316 HelperStaticRuntimes.push_back("hwasan-preinit");
1317 }
1318 }
1319
1320 // The stats_client library is also statically linked into DSOs.
1321 if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes())
1322 StaticRuntimes.push_back("stats_client");
1323
1324 // Always link the static runtime regardless of DSO or executable.
1325 if (SanArgs.needsAsanRt())
1326 HelperStaticRuntimes.push_back("asan_static");
1327
1328 // Collect static runtimes.
1329 if (Args.hasArg(options::OPT_shared)) {
1330 // Don't link static runtimes into DSOs.
1331 return;
1332 }
1333
1334 // Each static runtime that has a DSO counterpart above is excluded below,
1335 // but runtimes that exist only as static are not affected by needsSharedRt.
1336
1337 if (!SanArgs.needsSharedRt() && SanArgs.needsAsanRt() && SanArgs.linkRuntimes()) {
1338 StaticRuntimes.push_back("asan");
1339 if (SanArgs.linkCXXRuntimes())
1340 StaticRuntimes.push_back("asan_cxx");
1341 }
1342
1343 if (!SanArgs.needsSharedRt() && SanArgs.needsMemProfRt() &&
1344 SanArgs.linkRuntimes()) {
1345 StaticRuntimes.push_back("memprof");
1346 if (SanArgs.linkCXXRuntimes())
1347 StaticRuntimes.push_back("memprof_cxx");
1348 }
1349
1350 if (!SanArgs.needsSharedRt() && SanArgs.needsHwasanRt() && SanArgs.linkRuntimes()) {
1351 if (SanArgs.needsHwasanAliasesRt()) {
1352 StaticRuntimes.push_back("hwasan_aliases");
1353 if (SanArgs.linkCXXRuntimes())
1354 StaticRuntimes.push_back("hwasan_aliases_cxx");
1355 } else {
1356 StaticRuntimes.push_back("hwasan");
1357 if (SanArgs.linkCXXRuntimes())
1358 StaticRuntimes.push_back("hwasan_cxx");
1359 }
1360 }
1361 if (SanArgs.needsDfsanRt() && SanArgs.linkRuntimes())
1362 StaticRuntimes.push_back("dfsan");
1363 if (SanArgs.needsLsanRt() && SanArgs.linkRuntimes())
1364 StaticRuntimes.push_back("lsan");
1365 if (SanArgs.needsMsanRt() && SanArgs.linkRuntimes()) {
1366 StaticRuntimes.push_back("msan");
1367 if (SanArgs.linkCXXRuntimes())
1368 StaticRuntimes.push_back("msan_cxx");
1369 }
1370 if (!SanArgs.needsSharedRt() && SanArgs.needsTsanRt() &&
1371 SanArgs.linkRuntimes()) {
1372 StaticRuntimes.push_back("tsan");
1373 if (SanArgs.linkCXXRuntimes())
1374 StaticRuntimes.push_back("tsan_cxx");
1375 }
1376 if (!SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes()) {
1377 if (SanArgs.requiresMinimalRuntime()) {
1378 StaticRuntimes.push_back("ubsan_minimal");
1379 } else {
1380 StaticRuntimes.push_back("ubsan_standalone");
1381 if (SanArgs.linkCXXRuntimes())
1382 StaticRuntimes.push_back("ubsan_standalone_cxx");
1383 }
1384 }
1385 if (SanArgs.needsSafeStackRt() && SanArgs.linkRuntimes()) {
1386 NonWholeStaticRuntimes.push_back("safestack");
1387 RequiredSymbols.push_back("__safestack_init");
1388 }
1389 if (!(SanArgs.needsSharedRt() && SanArgs.needsUbsanRt() && SanArgs.linkRuntimes())) {
1390 if (SanArgs.needsCfiRt() && SanArgs.linkRuntimes())
1391 StaticRuntimes.push_back("cfi");
1392 if (SanArgs.needsCfiDiagRt() && SanArgs.linkRuntimes()) {
1393 StaticRuntimes.push_back("cfi_diag");
1394 if (SanArgs.linkCXXRuntimes())
1395 StaticRuntimes.push_back("ubsan_standalone_cxx");
1396 }
1397 }
1398 if (SanArgs.needsStatsRt() && SanArgs.linkRuntimes()) {
1399 NonWholeStaticRuntimes.push_back("stats");
1400 RequiredSymbols.push_back("__sanitizer_stats_register");
1401 }
1402 if (!SanArgs.needsSharedRt() && SanArgs.needsScudoRt() && SanArgs.linkRuntimes()) {
1403 StaticRuntimes.push_back("scudo_standalone");
1404 if (SanArgs.linkCXXRuntimes())
1405 StaticRuntimes.push_back("scudo_standalone_cxx");
1406 }
1407}
1408
1409// Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
1410// C runtime, etc). Returns true if sanitizer system deps need to be linked in.
1411bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
1412 ArgStringList &CmdArgs) {
1413 SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
1414 NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
1415 collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
1416 NonWholeStaticRuntimes, HelperStaticRuntimes,
1417 RequiredSymbols);
1418
1419 const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
1420 // Inject libfuzzer dependencies.
1421 if (SanArgs.needsFuzzer() && SanArgs.linkRuntimes() &&
1422 !Args.hasArg(options::OPT_shared)) {
1423
1424 addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
1425 if (SanArgs.needsFuzzerInterceptors())
1426 addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer_interceptors", false,
1427 true);
1428 if (!Args.hasArg(clang::driver::options::OPT_nostdlibxx)) {
1429 bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
1430 !Args.hasArg(options::OPT_static);
1431 if (OnlyLibstdcxxStatic)
1432 CmdArgs.push_back("-Bstatic");
1433 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
1434 if (OnlyLibstdcxxStatic)
1435 CmdArgs.push_back("-Bdynamic");
1436 }
1437 }
1438
1439 for (auto RT : SharedRuntimes)
1440 addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
1441 for (auto RT : HelperStaticRuntimes)
1442 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
1443 bool AddExportDynamic = false;
1444 for (auto RT : StaticRuntimes) {
1445 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
1446 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
1447 }
1448 for (auto RT : NonWholeStaticRuntimes) {
1449 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
1450 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
1451 }
1452 for (auto S : RequiredSymbols) {
1453 CmdArgs.push_back("-u");
1454 CmdArgs.push_back(Args.MakeArgString(S));
1455 }
1456 // If there is a static runtime with no dynamic list, force all the symbols
1457 // to be dynamic to be sure we export sanitizer interface functions.
1458 if (AddExportDynamic)
1459 CmdArgs.push_back("--export-dynamic");
1460
1461 if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
1462 CmdArgs.push_back("--export-dynamic-symbol=__cfi_check");
1463
1464 if (SanArgs.hasMemTag()) {
1465 if (!TC.getTriple().isAndroid()) {
1466 TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1467 << "-fsanitize=memtag*" << TC.getTriple().str();
1468 }
1469 CmdArgs.push_back(
1470 Args.MakeArgString("--android-memtag-mode=" + SanArgs.getMemtagMode()));
1471 if (SanArgs.hasMemtagHeap())
1472 CmdArgs.push_back("--android-memtag-heap");
1473 if (SanArgs.hasMemtagStack())
1474 CmdArgs.push_back("--android-memtag-stack");
1475 }
1476
1477 return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty();
1478}
1479
1480bool tools::addXRayRuntime(const ToolChain&TC, const ArgList &Args, ArgStringList &CmdArgs) {
1481 if (Args.hasArg(options::OPT_shared))
1482 return false;
1483
1484 if (TC.getXRayArgs().needsXRayRt()) {
1485 CmdArgs.push_back("--whole-archive");
1486 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray"));
1487 for (const auto &Mode : TC.getXRayArgs().modeList())
1488 CmdArgs.push_back(TC.getCompilerRTArgString(Args, Mode));
1489 CmdArgs.push_back("--no-whole-archive");
1490 return true;
1491 }
1492
1493 return false;
1494}
1495
1497 const llvm::opt::ArgList &Args,
1498 ArgStringList &CmdArgs) {
1499 addAsNeededOption(TC, Args, CmdArgs, false);
1500 CmdArgs.push_back("-lpthread");
1501 if (!TC.getTriple().isOSOpenBSD())
1502 CmdArgs.push_back("-lrt");
1503 CmdArgs.push_back("-lm");
1504
1505 if (!TC.getTriple().isOSFreeBSD() &&
1506 !TC.getTriple().isOSNetBSD() &&
1507 !TC.getTriple().isOSOpenBSD())
1508 CmdArgs.push_back("-ldl");
1509}
1510
1511bool tools::areOptimizationsEnabled(const ArgList &Args) {
1512 // Find the last -O arg and see if it is non-zero.
1513 if (Arg *A = Args.getLastArg(options::OPT_O_Group))
1514 return !A->getOption().matches(options::OPT_O0);
1515 // Defaults to -O0.
1516 return false;
1517}
1518
1519const char *tools::SplitDebugName(const JobAction &JA, const ArgList &Args,
1520 const InputInfo &Input,
1521 const InputInfo &Output) {
1522 auto AddPostfix = [JA](auto &F) {
1524 F += (Twine("_") + JA.getOffloadingArch()).str();
1525 F += ".dwo";
1526 };
1527 if (Arg *A = Args.getLastArg(options::OPT_gsplit_dwarf_EQ))
1528 if (StringRef(A->getValue()) == "single" && Output.isFilename())
1529 return Args.MakeArgString(Output.getFilename());
1530
1532 if (const Arg *A = Args.getLastArg(options::OPT_dumpdir)) {
1533 T = A->getValue();
1534 } else {
1535 Arg *FinalOutput = Args.getLastArg(options::OPT_o, options::OPT__SLASH_o);
1536 if (FinalOutput && Args.hasArg(options::OPT_c)) {
1537 T = FinalOutput->getValue();
1538 llvm::sys::path::remove_filename(T);
1539 llvm::sys::path::append(T,
1540 llvm::sys::path::stem(FinalOutput->getValue()));
1541 AddPostfix(T);
1542 return Args.MakeArgString(T);
1543 }
1544 }
1545
1546 T += llvm::sys::path::stem(Input.getBaseInput());
1547 AddPostfix(T);
1548 return Args.MakeArgString(T);
1549}
1550
1551void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
1552 const JobAction &JA, const ArgList &Args,
1553 const InputInfo &Output, const char *OutFile) {
1554 ArgStringList ExtractArgs;
1555 ExtractArgs.push_back("--extract-dwo");
1556
1557 ArgStringList StripArgs;
1558 StripArgs.push_back("--strip-dwo");
1559
1560 // Grabbing the output of the earlier compile step.
1561 StripArgs.push_back(Output.getFilename());
1562 ExtractArgs.push_back(Output.getFilename());
1563 ExtractArgs.push_back(OutFile);
1564
1565 const char *Exec =
1566 Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
1567 InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
1568
1569 // First extract the dwo sections.
1570 C.addCommand(std::make_unique<Command>(JA, T,
1572 Exec, ExtractArgs, II, Output));
1573
1574 // Then remove them from the original .o file.
1575 C.addCommand(std::make_unique<Command>(
1576 JA, T, ResponseFileSupport::AtFileCurCP(), Exec, StripArgs, II, Output));
1577}
1578
1579// Claim options we don't want to warn if they are unused. We do this for
1580// options that build systems might add but are unused when assembling or only
1581// running the preprocessor for example.
1582void tools::claimNoWarnArgs(const ArgList &Args) {
1583 // Don't warn about unused -f(no-)?lto. This can happen when we're
1584 // preprocessing, precompiling or assembling.
1585 Args.ClaimAllArgs(options::OPT_flto_EQ);
1586 Args.ClaimAllArgs(options::OPT_flto);
1587 Args.ClaimAllArgs(options::OPT_fno_lto);
1588}
1589
1590Arg *tools::getLastCSProfileGenerateArg(const ArgList &Args) {
1591 auto *CSPGOGenerateArg = Args.getLastArg(options::OPT_fcs_profile_generate,
1592 options::OPT_fcs_profile_generate_EQ,
1593 options::OPT_fno_profile_generate);
1594 if (CSPGOGenerateArg &&
1595 CSPGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
1596 CSPGOGenerateArg = nullptr;
1597
1598 return CSPGOGenerateArg;
1599}
1600
1601Arg *tools::getLastProfileUseArg(const ArgList &Args) {
1602 auto *ProfileUseArg = Args.getLastArg(
1603 options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
1604 options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
1605 options::OPT_fno_profile_instr_use);
1606
1607 if (ProfileUseArg &&
1608 ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
1609 ProfileUseArg = nullptr;
1610
1611 return ProfileUseArg;
1612}
1613
1614Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
1615 auto *ProfileSampleUseArg = Args.getLastArg(
1616 options::OPT_fprofile_sample_use, options::OPT_fprofile_sample_use_EQ,
1617 options::OPT_fauto_profile, options::OPT_fauto_profile_EQ,
1618 options::OPT_fno_profile_sample_use, options::OPT_fno_auto_profile);
1619
1620 if (ProfileSampleUseArg &&
1621 (ProfileSampleUseArg->getOption().matches(
1622 options::OPT_fno_profile_sample_use) ||
1623 ProfileSampleUseArg->getOption().matches(options::OPT_fno_auto_profile)))
1624 return nullptr;
1625
1626 return Args.getLastArg(options::OPT_fprofile_sample_use_EQ,
1627 options::OPT_fauto_profile_EQ);
1628}
1629
1630const char *tools::RelocationModelName(llvm::Reloc::Model Model) {
1631 switch (Model) {
1632 case llvm::Reloc::Static:
1633 return "static";
1634 case llvm::Reloc::PIC_:
1635 return "pic";
1636 case llvm::Reloc::DynamicNoPIC:
1637 return "dynamic-no-pic";
1638 case llvm::Reloc::ROPI:
1639 return "ropi";
1640 case llvm::Reloc::RWPI:
1641 return "rwpi";
1642 case llvm::Reloc::ROPI_RWPI:
1643 return "ropi-rwpi";
1644 }
1645 llvm_unreachable("Unknown Reloc::Model kind");
1646}
1647
1648/// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments. Then,
1649/// smooshes them together with platform defaults, to decide whether
1650/// this compile should be using PIC mode or not. Returns a tuple of
1651/// (RelocationModel, PICLevel, IsPIE).
1652std::tuple<llvm::Reloc::Model, unsigned, bool>
1653tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
1654 const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
1655 const llvm::Triple &Triple = ToolChain.getTriple();
1656
1657 bool PIE = ToolChain.isPIEDefault(Args);
1658 bool PIC = PIE || ToolChain.isPICDefault();
1659 // The Darwin/MachO default to use PIC does not apply when using -static.
1660 if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
1661 PIE = PIC = false;
1662 bool IsPICLevelTwo = PIC;
1663
1664 bool KernelOrKext =
1665 Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
1666
1667 // Android-specific defaults for PIC/PIE
1668 if (Triple.isAndroid()) {
1669 switch (Triple.getArch()) {
1670 case llvm::Triple::arm:
1671 case llvm::Triple::armeb:
1672 case llvm::Triple::thumb:
1673 case llvm::Triple::thumbeb:
1674 case llvm::Triple::aarch64:
1675 case llvm::Triple::mips:
1676 case llvm::Triple::mipsel:
1677 case llvm::Triple::mips64:
1678 case llvm::Triple::mips64el:
1679 PIC = true; // "-fpic"
1680 break;
1681
1682 case llvm::Triple::x86:
1683 case llvm::Triple::x86_64:
1684 PIC = true; // "-fPIC"
1685 IsPICLevelTwo = true;
1686 break;
1687
1688 default:
1689 break;
1690 }
1691 }
1692
1693 // OHOS-specific defaults for PIC/PIE
1694 if (Triple.isOHOSFamily() && Triple.getArch() == llvm::Triple::aarch64)
1695 PIC = true;
1696
1697 // OpenBSD-specific defaults for PIE
1698 if (Triple.isOSOpenBSD()) {
1699 switch (ToolChain.getArch()) {
1700 case llvm::Triple::arm:
1701 case llvm::Triple::aarch64:
1702 case llvm::Triple::mips64:
1703 case llvm::Triple::mips64el:
1704 case llvm::Triple::x86:
1705 case llvm::Triple::x86_64:
1706 IsPICLevelTwo = false; // "-fpie"
1707 break;
1708
1709 case llvm::Triple::ppc:
1710 case llvm::Triple::sparcv9:
1711 IsPICLevelTwo = true; // "-fPIE"
1712 break;
1713
1714 default:
1715 break;
1716 }
1717 }
1718
1719 // The last argument relating to either PIC or PIE wins, and no
1720 // other argument is used. If the last argument is any flavor of the
1721 // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
1722 // option implicitly enables PIC at the same level.
1723 Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
1724 options::OPT_fpic, options::OPT_fno_pic,
1725 options::OPT_fPIE, options::OPT_fno_PIE,
1726 options::OPT_fpie, options::OPT_fno_pie);
1727 if (Triple.isOSWindows() && !Triple.isOSCygMing() && LastPICArg &&
1728 LastPICArg == Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
1729 options::OPT_fPIE, options::OPT_fpie)) {
1730 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1731 << LastPICArg->getSpelling() << Triple.str();
1732 if (Triple.getArch() == llvm::Triple::x86_64)
1733 return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
1734 return std::make_tuple(llvm::Reloc::Static, 0U, false);
1735 }
1736
1737 // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
1738 // is forced, then neither PIC nor PIE flags will have no effect.
1740 if (LastPICArg) {
1741 Option O = LastPICArg->getOption();
1742 if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
1743 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
1744 PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
1745 PIC =
1746 PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
1747 IsPICLevelTwo =
1748 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
1749 } else {
1750 PIE = PIC = false;
1751 if (EffectiveTriple.isPS()) {
1752 Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
1753 StringRef Model = ModelArg ? ModelArg->getValue() : "";
1754 if (Model != "kernel") {
1755 PIC = true;
1756 ToolChain.getDriver().Diag(diag::warn_drv_ps_force_pic)
1757 << LastPICArg->getSpelling()
1758 << (EffectiveTriple.isPS4() ? "PS4" : "PS5");
1759 }
1760 }
1761 }
1762 }
1763 }
1764
1765 // Introduce a Darwin and PS4/PS5-specific hack. If the default is PIC, but
1766 // the PIC level would've been set to level 1, force it back to level 2 PIC
1767 // instead.
1768 if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS()))
1769 IsPICLevelTwo |= ToolChain.isPICDefault();
1770
1771 // This kernel flags are a trump-card: they will disable PIC/PIE
1772 // generation, independent of the argument order.
1773 if (KernelOrKext &&
1774 ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
1775 !EffectiveTriple.isWatchOS() && !EffectiveTriple.isDriverKit()))
1776 PIC = PIE = false;
1777
1778 if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
1779 // This is a very special mode. It trumps the other modes, almost no one
1780 // uses it, and it isn't even valid on any OS but Darwin.
1781 if (!Triple.isOSDarwin())
1782 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1783 << A->getSpelling() << Triple.str();
1784
1785 // FIXME: Warn when this flag trumps some other PIC or PIE flag.
1786
1787 // Only a forced PIC mode can cause the actual compile to have PIC defines
1788 // etc., no flags are sufficient. This behavior was selected to closely
1789 // match that of llvm-gcc and Apple GCC before that.
1791
1792 return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
1793 }
1794
1795 bool EmbeddedPISupported;
1796 switch (Triple.getArch()) {
1797 case llvm::Triple::arm:
1798 case llvm::Triple::armeb:
1799 case llvm::Triple::thumb:
1800 case llvm::Triple::thumbeb:
1801 EmbeddedPISupported = true;
1802 break;
1803 default:
1804 EmbeddedPISupported = false;
1805 break;
1806 }
1807
1808 bool ROPI = false, RWPI = false;
1809 Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
1810 if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
1811 if (!EmbeddedPISupported)
1812 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1813 << LastROPIArg->getSpelling() << Triple.str();
1814 ROPI = true;
1815 }
1816 Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
1817 if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
1818 if (!EmbeddedPISupported)
1819 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1820 << LastRWPIArg->getSpelling() << Triple.str();
1821 RWPI = true;
1822 }
1823
1824 // ROPI and RWPI are not compatible with PIC or PIE.
1825 if ((ROPI || RWPI) && (PIC || PIE))
1826 ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
1827
1828 if (Triple.isMIPS()) {
1829 StringRef CPUName;
1830 StringRef ABIName;
1831 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
1832 // When targeting the N64 ABI, PIC is the default, except in the case
1833 // when the -mno-abicalls option is used. In that case we exit
1834 // at next check regardless of PIC being set below.
1835 if (ABIName == "n64")
1836 PIC = true;
1837 // When targettng MIPS with -mno-abicalls, it's always static.
1838 if(Args.hasArg(options::OPT_mno_abicalls))
1839 return std::make_tuple(llvm::Reloc::Static, 0U, false);
1840 // Unlike other architectures, MIPS, even with -fPIC/-mxgot/multigot,
1841 // does not use PIC level 2 for historical reasons.
1842 IsPICLevelTwo = false;
1843 }
1844
1845 if (PIC)
1846 return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
1847
1848 llvm::Reloc::Model RelocM = llvm::Reloc::Static;
1849 if (ROPI && RWPI)
1850 RelocM = llvm::Reloc::ROPI_RWPI;
1851 else if (ROPI)
1852 RelocM = llvm::Reloc::ROPI;
1853 else if (RWPI)
1854 RelocM = llvm::Reloc::RWPI;
1855
1856 return std::make_tuple(RelocM, 0U, false);
1857}
1858
1859// `-falign-functions` indicates that the functions should be aligned to a
1860// 16-byte boundary.
1861//
1862// `-falign-functions=1` is the same as `-fno-align-functions`.
1863//
1864// The scalar `n` in `-falign-functions=n` must be an integral value between
1865// [0, 65536]. If the value is not a power-of-two, it will be rounded up to
1866// the nearest power-of-two.
1867//
1868// If we return `0`, the frontend will default to the backend's preferred
1869// alignment.
1870//
1871// NOTE: icc only allows values between [0, 4096]. icc uses `-falign-functions`
1872// to mean `-falign-functions=16`. GCC defaults to the backend's preferred
1873// alignment. For unaligned functions, we default to the backend's preferred
1874// alignment.
1875unsigned tools::ParseFunctionAlignment(const ToolChain &TC,
1876 const ArgList &Args) {
1877 const Arg *A = Args.getLastArg(options::OPT_falign_functions,
1878 options::OPT_falign_functions_EQ,
1879 options::OPT_fno_align_functions);
1880 if (!A || A->getOption().matches(options::OPT_fno_align_functions))
1881 return 0;
1882
1883 if (A->getOption().matches(options::OPT_falign_functions))
1884 return 0;
1885
1886 unsigned Value = 0;
1887 if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 65536)
1888 TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1889 << A->getAsString(Args) << A->getValue();
1890 return Value ? llvm::Log2_32_Ceil(std::min(Value, 65536u)) : Value;
1891}
1892
1894 ArgStringList &CmdArgs, llvm::codegenoptions::DebugInfoKind DebugInfoKind) {
1895 switch (DebugInfoKind) {
1896 case llvm::codegenoptions::DebugDirectivesOnly:
1897 CmdArgs.push_back("-debug-info-kind=line-directives-only");
1898 break;
1899 case llvm::codegenoptions::DebugLineTablesOnly:
1900 CmdArgs.push_back("-debug-info-kind=line-tables-only");
1901 break;
1902 case llvm::codegenoptions::DebugInfoConstructor:
1903 CmdArgs.push_back("-debug-info-kind=constructor");
1904 break;
1905 case llvm::codegenoptions::LimitedDebugInfo:
1906 CmdArgs.push_back("-debug-info-kind=limited");
1907 break;
1908 case llvm::codegenoptions::FullDebugInfo:
1909 CmdArgs.push_back("-debug-info-kind=standalone");
1910 break;
1911 case llvm::codegenoptions::UnusedTypeInfo:
1912 CmdArgs.push_back("-debug-info-kind=unused-types");
1913 break;
1914 default:
1915 break;
1916 }
1917}
1918
1919// Convert an arg of the form "-gN" or "-ggdbN" or one of their aliases
1920// to the corresponding DebugInfoKind.
1921llvm::codegenoptions::DebugInfoKind tools::debugLevelToInfoKind(const Arg &A) {
1922 assert(A.getOption().matches(options::OPT_gN_Group) &&
1923 "Not a -g option that specifies a debug-info level");
1924 if (A.getOption().matches(options::OPT_g0) ||
1925 A.getOption().matches(options::OPT_ggdb0))
1926 return llvm::codegenoptions::NoDebugInfo;
1927 if (A.getOption().matches(options::OPT_gline_tables_only) ||
1928 A.getOption().matches(options::OPT_ggdb1))
1929 return llvm::codegenoptions::DebugLineTablesOnly;
1930 if (A.getOption().matches(options::OPT_gline_directives_only))
1931 return llvm::codegenoptions::DebugDirectivesOnly;
1932 return llvm::codegenoptions::DebugInfoConstructor;
1933}
1934
1935static unsigned ParseDebugDefaultVersion(const ToolChain &TC,
1936 const ArgList &Args) {
1937 const Arg *A = Args.getLastArg(options::OPT_fdebug_default_version);
1938
1939 if (!A)
1940 return 0;
1941
1942 unsigned Value = 0;
1943 if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 5 ||
1944 Value < 2)
1945 TC.getDriver().Diag(diag::err_drv_invalid_int_value)
1946 << A->getAsString(Args) << A->getValue();
1947 return Value;
1948}
1949
1950unsigned tools::DwarfVersionNum(StringRef ArgValue) {
1951 return llvm::StringSwitch<unsigned>(ArgValue)
1952 .Case("-gdwarf-2", 2)
1953 .Case("-gdwarf-3", 3)
1954 .Case("-gdwarf-4", 4)
1955 .Case("-gdwarf-5", 5)
1956 .Default(0);
1957}
1958
1959const Arg *tools::getDwarfNArg(const ArgList &Args) {
1960 return Args.getLastArg(options::OPT_gdwarf_2, options::OPT_gdwarf_3,
1961 options::OPT_gdwarf_4, options::OPT_gdwarf_5,
1962 options::OPT_gdwarf);
1963}
1964
1966 const llvm::opt::ArgList &Args) {
1967 unsigned DwarfVersion = ParseDebugDefaultVersion(TC, Args);
1968 if (const Arg *GDwarfN = getDwarfNArg(Args))
1969 if (int N = DwarfVersionNum(GDwarfN->getSpelling()))
1970 DwarfVersion = N;
1971 if (DwarfVersion == 0) {
1972 DwarfVersion = TC.GetDefaultDwarfVersion();
1973 assert(DwarfVersion && "toolchain default DWARF version must be nonzero");
1974 }
1975 return DwarfVersion;
1976}
1977
1978void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
1979 ArgStringList &CmdArgs) {
1980 llvm::Reloc::Model RelocationModel;
1981 unsigned PICLevel;
1982 bool IsPIE;
1983 std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
1984
1985 if (RelocationModel != llvm::Reloc::Static)
1986 CmdArgs.push_back("-KPIC");
1987}
1988
1989/// Determine whether Objective-C automated reference counting is
1990/// enabled.
1991bool tools::isObjCAutoRefCount(const ArgList &Args) {
1992 return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
1993}
1994
1996
1997static LibGccType getLibGccType(const ToolChain &TC, const Driver &D,
1998 const ArgList &Args) {
1999 if (Args.hasArg(options::OPT_static_libgcc) ||
2000 Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_static_pie) ||
2001 // The Android NDK only provides libunwind.a, not libunwind.so.
2002 TC.getTriple().isAndroid())
2004 if (Args.hasArg(options::OPT_shared_libgcc))
2007}
2008
2009// Gcc adds libgcc arguments in various ways:
2010//
2011// gcc <none>: -lgcc --as-needed -lgcc_s --no-as-needed
2012// g++ <none>: -lgcc_s -lgcc
2013// gcc shared: -lgcc_s -lgcc
2014// g++ shared: -lgcc_s -lgcc
2015// gcc static: -lgcc -lgcc_eh
2016// g++ static: -lgcc -lgcc_eh
2017// gcc static-pie: -lgcc -lgcc_eh
2018// g++ static-pie: -lgcc -lgcc_eh
2019//
2020// Also, certain targets need additional adjustments.
2021
2022static void AddUnwindLibrary(const ToolChain &TC, const Driver &D,
2023 ArgStringList &CmdArgs, const ArgList &Args) {
2025 // By default OHOS binaries are linked statically to libunwind.
2026 if (TC.getTriple().isOHOSFamily() && UNW == ToolChain::UNW_CompilerRT) {
2027 CmdArgs.push_back("-l:libunwind.a");
2028 return;
2029 }
2030
2031 // Targets that don't use unwind libraries.
2032 if ((TC.getTriple().isAndroid() && UNW == ToolChain::UNW_Libgcc) ||
2033 TC.getTriple().isOSIAMCU() || TC.getTriple().isOSBinFormatWasm() ||
2034 TC.getTriple().isWindowsMSVCEnvironment() || UNW == ToolChain::UNW_None)
2035 return;
2036
2037 LibGccType LGT = getLibGccType(TC, D, Args);
2038 bool AsNeeded = LGT == LibGccType::UnspecifiedLibGcc &&
2039 (UNW == ToolChain::UNW_CompilerRT || !D.CCCIsCXX()) &&
2040 !TC.getTriple().isAndroid() &&
2041 !TC.getTriple().isOSCygMing() && !TC.getTriple().isOSAIX();
2042 if (AsNeeded)
2043 addAsNeededOption(TC, Args, CmdArgs, true);
2044
2045 switch (UNW) {
2047 return;
2048 case ToolChain::UNW_Libgcc: {
2049 if (LGT == LibGccType::StaticLibGcc)
2050 CmdArgs.push_back("-lgcc_eh");
2051 else
2052 CmdArgs.push_back("-lgcc_s");
2053 break;
2054 }
2056 if (TC.getTriple().isOSAIX()) {
2057 // AIX only has libunwind as a shared library. So do not pass
2058 // anything in if -static is specified.
2059 if (LGT != LibGccType::StaticLibGcc)
2060 CmdArgs.push_back("-lunwind");
2061 } else if (LGT == LibGccType::StaticLibGcc) {
2062 CmdArgs.push_back("-l:libunwind.a");
2063 } else if (LGT == LibGccType::SharedLibGcc) {
2064 if (TC.getTriple().isOSCygMing())
2065 CmdArgs.push_back("-l:libunwind.dll.a");
2066 else
2067 CmdArgs.push_back("-l:libunwind.so");
2068 } else {
2069 // Let the linker choose between libunwind.so and libunwind.a
2070 // depending on what's available, and depending on the -static flag
2071 CmdArgs.push_back("-lunwind");
2072 }
2073 break;
2074 }
2075
2076 if (AsNeeded)
2077 addAsNeededOption(TC, Args, CmdArgs, false);
2078}
2079
2080static void AddLibgcc(const ToolChain &TC, const Driver &D,
2081 ArgStringList &CmdArgs, const ArgList &Args) {
2082 LibGccType LGT = getLibGccType(TC, D, Args);
2083 if (LGT == LibGccType::StaticLibGcc ||
2084 (LGT == LibGccType::UnspecifiedLibGcc && !D.CCCIsCXX()))
2085 CmdArgs.push_back("-lgcc");
2086 AddUnwindLibrary(TC, D, CmdArgs, Args);
2087 if (LGT == LibGccType::SharedLibGcc ||
2089 CmdArgs.push_back("-lgcc");
2090}
2091
2092void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
2093 ArgStringList &CmdArgs, const ArgList &Args) {
2094 // Make use of compiler-rt if --rtlib option is used
2096
2097 switch (RLT) {
2099 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
2100 AddUnwindLibrary(TC, D, CmdArgs, Args);
2101 break;
2103 // Make sure libgcc is not used under MSVC environment by default
2104 if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
2105 // Issue error diagnostic if libgcc is explicitly specified
2106 // through command line as --rtlib option argument.
2107 Arg *A = Args.getLastArg(options::OPT_rtlib_EQ);
2108 if (A && A->getValue() != StringRef("platform")) {
2109 TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
2110 << A->getValue() << "MSVC";
2111 }
2112 } else
2113 AddLibgcc(TC, D, CmdArgs, Args);
2114 break;
2115 }
2116
2117 // On Android, the unwinder uses dl_iterate_phdr (or one of
2118 // dl_unwind_find_exidx/__gnu_Unwind_Find_exidx on arm32) from libdl.so. For
2119 // statically-linked executables, these functions come from libc.a instead.
2120 if (TC.getTriple().isAndroid() && !Args.hasArg(options::OPT_static) &&
2121 !Args.hasArg(options::OPT_static_pie))
2122 CmdArgs.push_back("-ldl");
2123}
2124
2125SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
2126 const InputInfo &Output,
2127 const InputInfo &Input,
2128 const Driver &D) {
2129 const Arg *A = Args.getLastArg(options::OPT_save_stats_EQ);
2130 if (!A && !D.CCPrintInternalStats)
2131 return {};
2132
2133 SmallString<128> StatsFile;
2134 if (A) {
2135 StringRef SaveStats = A->getValue();
2136 if (SaveStats == "obj" && Output.isFilename()) {
2137 StatsFile.assign(Output.getFilename());
2138 llvm::sys::path::remove_filename(StatsFile);
2139 } else if (SaveStats != "cwd") {
2140 D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
2141 return {};
2142 }
2143
2144 StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
2145 llvm::sys::path::append(StatsFile, BaseName);
2146 llvm::sys::path::replace_extension(StatsFile, "stats");
2147 } else {
2148 assert(D.CCPrintInternalStats);
2149 StatsFile.assign(D.CCPrintInternalStatReportFilename.empty()
2150 ? "-"
2152 }
2153 return StatsFile;
2154}
2155
2156void tools::addMultilibFlag(bool Enabled, const StringRef Flag,
2157 Multilib::flags_list &Flags) {
2158 assert(Flag.front() == '-');
2159 if (Enabled) {
2160 Flags.push_back(Flag.str());
2161 } else {
2162 Flags.push_back(("!" + Flag.substr(1)).str());
2163 }
2164}
2165
2166void tools::addX86AlignBranchArgs(const Driver &D, const ArgList &Args,
2167 ArgStringList &CmdArgs, bool IsLTO,
2168 const StringRef PluginOptPrefix) {
2169 auto addArg = [&, IsLTO](const Twine &Arg) {
2170 if (IsLTO) {
2171 assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
2172 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
2173 } else {
2174 CmdArgs.push_back("-mllvm");
2175 CmdArgs.push_back(Args.MakeArgString(Arg));
2176 }
2177 };
2178
2179 if (Args.hasArg(options::OPT_mbranches_within_32B_boundaries)) {
2180 addArg(Twine("-x86-branches-within-32B-boundaries"));
2181 }
2182 if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_boundary_EQ)) {
2183 StringRef Value = A->getValue();
2184 unsigned Boundary;
2185 if (Value.getAsInteger(10, Boundary) || Boundary < 16 ||
2186 !llvm::isPowerOf2_64(Boundary)) {
2187 D.Diag(diag::err_drv_invalid_argument_to_option)
2188 << Value << A->getOption().getName();
2189 } else {
2190 addArg("-x86-align-branch-boundary=" + Twine(Boundary));
2191 }
2192 }
2193 if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_EQ)) {
2194 std::string AlignBranch;
2195 for (StringRef T : A->getValues()) {
2196 if (T != "fused" && T != "jcc" && T != "jmp" && T != "call" &&
2197 T != "ret" && T != "indirect")
2198 D.Diag(diag::err_drv_invalid_malign_branch_EQ)
2199 << T << "fused, jcc, jmp, call, ret, indirect";
2200 if (!AlignBranch.empty())
2201 AlignBranch += '+';
2202 AlignBranch += T;
2203 }
2204 addArg("-x86-align-branch=" + Twine(AlignBranch));
2205 }
2206 if (const Arg *A = Args.getLastArg(options::OPT_mpad_max_prefix_size_EQ)) {
2207 StringRef Value = A->getValue();
2208 unsigned PrefixSize;
2209 if (Value.getAsInteger(10, PrefixSize)) {
2210 D.Diag(diag::err_drv_invalid_argument_to_option)
2211 << Value << A->getOption().getName();
2212 } else {
2213 addArg("-x86-pad-max-prefix-size=" + Twine(PrefixSize));
2214 }
2215 }
2216}
2217
2218/// SDLSearch: Search for Static Device Library
2219/// The search for SDL bitcode files is consistent with how static host
2220/// libraries are discovered. That is, the -l option triggers a search for
2221/// files in a set of directories called the LINKPATH. The host library search
2222/// procedure looks for a specific filename in the LINKPATH. The filename for
2223/// a host library is lib<libname>.a or lib<libname>.so. For SDLs, there is an
2224/// ordered-set of filenames that are searched. We call this ordered-set of
2225/// filenames as SEARCH-ORDER. Since an SDL can either be device-type specific,
2226/// architecture specific, or generic across all architectures, a naming
2227/// convention and search order is used where the file name embeds the
2228/// architecture name <arch-name> (nvptx or amdgcn) and the GPU device type
2229/// <device-name> such as sm_30 and gfx906. <device-name> is absent in case of
2230/// device-independent SDLs. To reduce congestion in host library directories,
2231/// the search first looks for files in the “libdevice” subdirectory. SDLs that
2232/// are bc files begin with the prefix “lib”.
2233///
2234/// Machine-code SDLs can also be managed as an archive (*.a file). The
2235/// convention has been to use the prefix “lib”. To avoid confusion with host
2236/// archive libraries, we use prefix "libbc-" for the bitcode SDL archives.
2237///
2238static bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
2239 llvm::opt::ArgStringList &CC1Args,
2240 const SmallVectorImpl<std::string> &LibraryPaths,
2241 StringRef Lib, StringRef Arch, StringRef Target,
2242 bool isBitCodeSDL) {
2244
2245 std::string LibDeviceLoc = "/libdevice";
2246 std::string LibBcPrefix = "/libbc-";
2247 std::string LibPrefix = "/lib";
2248
2249 if (isBitCodeSDL) {
2250 // SEARCH-ORDER for Bitcode SDLs:
2251 // libdevice/libbc-<libname>-<arch-name>-<device-type>.a
2252 // libbc-<libname>-<arch-name>-<device-type>.a
2253 // libdevice/libbc-<libname>-<arch-name>.a
2254 // libbc-<libname>-<arch-name>.a
2255 // libdevice/libbc-<libname>.a
2256 // libbc-<libname>.a
2257 // libdevice/lib<libname>-<arch-name>-<device-type>.bc
2258 // lib<libname>-<arch-name>-<device-type>.bc
2259 // libdevice/lib<libname>-<arch-name>.bc
2260 // lib<libname>-<arch-name>.bc
2261 // libdevice/lib<libname>.bc
2262 // lib<libname>.bc
2263
2264 for (StringRef Base : {LibBcPrefix, LibPrefix}) {
2265 const auto *Ext = Base.contains(LibBcPrefix) ? ".a" : ".bc";
2266
2267 for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
2268 Twine(Lib + "-" + Arch).str(), Twine(Lib).str()}) {
2269 SDLs.push_back(Twine(LibDeviceLoc + Base + Suffix + Ext).str());
2270 SDLs.push_back(Twine(Base + Suffix + Ext).str());
2271 }
2272 }
2273 } else {
2274 // SEARCH-ORDER for Machine-code SDLs:
2275 // libdevice/lib<libname>-<arch-name>-<device-type>.a
2276 // lib<libname>-<arch-name>-<device-type>.a
2277 // libdevice/lib<libname>-<arch-name>.a
2278 // lib<libname>-<arch-name>.a
2279
2280 const auto *Ext = ".a";
2281
2282 for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
2283 Twine(Lib + "-" + Arch).str()}) {
2284 SDLs.push_back(Twine(LibDeviceLoc + LibPrefix + Suffix + Ext).str());
2285 SDLs.push_back(Twine(LibPrefix + Suffix + Ext).str());
2286 }
2287 }
2288
2289 // The CUDA toolchain does not use a global device llvm-link before the LLVM
2290 // backend generates ptx. So currently, the use of bitcode SDL for nvptx is
2291 // only possible with post-clang-cc1 linking. Clang cc1 has a feature that
2292 // will link libraries after clang compilation while the LLVM IR is still in
2293 // memory. This utilizes a clang cc1 option called “-mlink-builtin-bitcode”.
2294 // This is a clang -cc1 option that is generated by the clang driver. The
2295 // option value must a full path to an existing file.
2296 bool FoundSDL = false;
2297 for (auto LPath : LibraryPaths) {
2298 for (auto SDL : SDLs) {
2299 auto FullName = Twine(LPath + SDL).str();
2300 if (llvm::sys::fs::exists(FullName)) {
2301 CC1Args.push_back(DriverArgs.MakeArgString(FullName));
2302 FoundSDL = true;
2303 break;
2304 }
2305 }
2306 if (FoundSDL)
2307 break;
2308 }
2309 return FoundSDL;
2310}
2311
2312/// Search if a user provided archive file lib<libname>.a exists in any of
2313/// the library paths. If so, add a new command to clang-offload-bundler to
2314/// unbundle this archive and create a temporary device specific archive. Name
2315/// of this SDL is passed to the llvm-link tool.
2317 Compilation &C, const Driver &D, const Tool &T, const JobAction &JA,
2318 const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs,
2319 llvm::opt::ArgStringList &CC1Args,
2320 const SmallVectorImpl<std::string> &LibraryPaths, StringRef Lib,
2321 StringRef Arch, StringRef Target, bool isBitCodeSDL) {
2322
2323 // We don't support bitcode archive bundles for nvptx
2324 if (isBitCodeSDL && Arch.contains("nvptx"))
2325 return;
2326
2327 bool FoundAOB = false;
2328 std::string ArchiveOfBundles;
2329
2330 llvm::Triple Triple(D.getTargetTriple());
2331 bool IsMSVC = Triple.isWindowsMSVCEnvironment();
2332 auto Ext = IsMSVC ? ".lib" : ".a";
2333 if (!Lib.startswith(":") && !Lib.startswith("-l")) {
2334 if (llvm::sys::fs::exists(Lib)) {
2335 ArchiveOfBundles = Lib;
2336 FoundAOB = true;
2337 }
2338 } else {
2339 if (Lib.startswith("-l"))
2340 Lib = Lib.drop_front(2);
2341 for (auto LPath : LibraryPaths) {
2342 ArchiveOfBundles.clear();
2343 auto LibFile =
2344 (Lib.startswith(":") ? Lib.drop_front()
2345 : IsMSVC ? Lib + Ext : "lib" + Lib + Ext)
2346 .str();
2347 for (auto Prefix : {"/libdevice/", "/"}) {
2348 auto AOB = Twine(LPath + Prefix + LibFile).str();
2349 if (llvm::sys::fs::exists(AOB)) {
2350 ArchiveOfBundles = AOB;
2351 FoundAOB = true;
2352 break;
2353 }
2354 }
2355 if (FoundAOB)
2356 break;
2357 }
2358 }
2359
2360 if (!FoundAOB)
2361 return;
2362
2363 llvm::file_magic Magic;
2364 auto EC = llvm::identify_magic(ArchiveOfBundles, Magic);
2365 if (EC || Magic != llvm::file_magic::archive)
2366 return;
2367
2368 StringRef Prefix = isBitCodeSDL ? "libbc-" : "lib";
2369 std::string OutputLib =
2370 D.GetTemporaryPath(Twine(Prefix + llvm::sys::path::filename(Lib) + "-" +
2371 Arch + "-" + Target)
2372 .str(),
2373 "a");
2374
2375 C.addTempFile(C.getArgs().MakeArgString(OutputLib));
2376
2377 ArgStringList CmdArgs;
2378 SmallString<128> DeviceTriple;
2380 DeviceTriple += '-';
2381 std::string NormalizedTriple = T.getToolChain().getTriple().normalize();
2382 DeviceTriple += NormalizedTriple;
2383 if (!Target.empty()) {
2384 DeviceTriple += '-';
2385 DeviceTriple += Target;
2386 }
2387
2388 std::string UnbundleArg("-unbundle");
2389 std::string TypeArg("-type=a");
2390 std::string InputArg("-input=" + ArchiveOfBundles);
2391 std::string OffloadArg("-targets=" + std::string(DeviceTriple));
2392 std::string OutputArg("-output=" + OutputLib);
2393
2394 const char *UBProgram = DriverArgs.MakeArgString(
2395 T.getToolChain().GetProgramPath("clang-offload-bundler"));
2396
2397 ArgStringList UBArgs;
2398 UBArgs.push_back(C.getArgs().MakeArgString(UnbundleArg));
2399 UBArgs.push_back(C.getArgs().MakeArgString(TypeArg));
2400 UBArgs.push_back(C.getArgs().MakeArgString(InputArg));
2401 UBArgs.push_back(C.getArgs().MakeArgString(OffloadArg));
2402 UBArgs.push_back(C.getArgs().MakeArgString(OutputArg));
2403
2404 // Add this flag to not exit from clang-offload-bundler if no compatible
2405 // code object is found in heterogenous archive library.
2406 std::string AdditionalArgs("-allow-missing-bundles");
2407 UBArgs.push_back(C.getArgs().MakeArgString(AdditionalArgs));
2408
2409 // Add this flag to treat hip and hipv4 offload kinds as compatible with
2410 // openmp offload kind while extracting code objects from a heterogenous
2411 // archive library. Vice versa is also considered compatible.
2412 std::string HipCompatibleArgs("-hip-openmp-compatible");
2413 UBArgs.push_back(C.getArgs().MakeArgString(HipCompatibleArgs));
2414
2415 C.addCommand(std::make_unique<Command>(
2416 JA, T, ResponseFileSupport::AtFileCurCP(), UBProgram, UBArgs, Inputs,
2417 InputInfo(&JA, C.getArgs().MakeArgString(OutputLib))));
2418
2419 CC1Args.push_back(DriverArgs.MakeArgString(OutputLib));
2420
2421 return;
2422}
2423
2424// Wrapper function used by driver for adding SDLs during link phase.
2426 const JobAction &JA,
2427 const InputInfoList &Inputs,
2428 const llvm::opt::ArgList &DriverArgs,
2429 llvm::opt::ArgStringList &CC1Args,
2430 StringRef Arch, StringRef Target,
2431 bool isBitCodeSDL) {
2432 AddStaticDeviceLibs(&C, &T, &JA, &Inputs, C.getDriver(), DriverArgs, CC1Args,
2433 Arch, Target, isBitCodeSDL);
2434}
2435
2436// User defined Static Device Libraries(SDLs) can be passed to clang for
2437// offloading GPU compilers. Like static host libraries, the use of a SDL is
2438// specified with the -l command line option. The primary difference between
2439// host and SDLs is the filenames for SDLs (refer SEARCH-ORDER for Bitcode SDLs
2440// and SEARCH-ORDER for Machine-code SDLs for the naming convention).
2441// SDLs are of following types:
2442//
2443// * Bitcode SDLs: They can either be a *.bc file or an archive of *.bc files.
2444// For NVPTX, these libraries are post-clang linked following each
2445// compilation. For AMDGPU, these libraries are linked one time
2446// during the application link phase.
2447//
2448// * Machine-code SDLs: They are archive files. For AMDGPU, the process for
2449// machine code SDLs is still in development. But they will be linked
2450// by the LLVM tool lld.
2451//
2452// * Bundled objects that contain both host and device codes: Bundled objects
2453// may also contain library code compiled from source. For NVPTX, the
2454// bundle contains cubin. For AMDGPU, the bundle contains bitcode.
2455//
2456// For Bitcode and Machine-code SDLs, current compiler toolchains hardcode the
2457// inclusion of specific SDLs such as math libraries and the OpenMP device
2458// library libomptarget.
2460 const JobAction *JA,
2461 const InputInfoList *Inputs, const Driver &D,
2462 const llvm::opt::ArgList &DriverArgs,
2463 llvm::opt::ArgStringList &CC1Args,
2464 StringRef Arch, StringRef Target,
2465 bool isBitCodeSDL) {
2466
2467 SmallVector<std::string, 8> LibraryPaths;
2468 // Add search directories from LIBRARY_PATH env variable
2469 std::optional<std::string> LibPath =
2470 llvm::sys::Process::GetEnv("LIBRARY_PATH");
2471 if (LibPath) {
2473 const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
2474 llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
2475 for (StringRef Path : Frags)
2476 LibraryPaths.emplace_back(Path.trim());
2477 }
2478
2479 // Add directories from user-specified -L options
2480 for (std::string Search_Dir : DriverArgs.getAllArgValues(options::OPT_L))
2481 LibraryPaths.emplace_back(Search_Dir);
2482
2483 // Add path to lib-debug folders
2484 SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
2485 llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
2486 LibraryPaths.emplace_back(DefaultLibPath.c_str());
2487
2488 // Build list of Static Device Libraries SDLs specified by -l option
2489 llvm::SmallSet<std::string, 16> SDLNames;
2490 static const StringRef HostOnlyArchives[] = {
2491 "omp", "cudart", "m", "gcc", "gcc_s", "pthread", "hip_hcc"};
2492 for (auto SDLName : DriverArgs.getAllArgValues(options::OPT_l)) {
2493 if (!llvm::is_contained(HostOnlyArchives, SDLName)) {
2494 SDLNames.insert(std::string("-l") + SDLName);
2495 }
2496 }
2497
2498 for (auto Input : DriverArgs.getAllArgValues(options::OPT_INPUT)) {
2499 auto FileName = StringRef(Input);
2500 // Clang treats any unknown file types as archives and passes them to the
2501 // linker. Files with extension 'lib' are classified as TY_Object by clang
2502 // but they are usually archives. It is OK if the file is not really an
2503 // archive since GetSDLFromOffloadArchive will check the magic of the file
2504 // and only unbundle it if it is really an archive.
2505 const StringRef LibFileExt = ".lib";
2506 if (!llvm::sys::path::has_extension(FileName) ||
2508 llvm::sys::path::extension(FileName).drop_front()) ==
2510 llvm::sys::path::extension(FileName) == LibFileExt)
2511 SDLNames.insert(Input);
2512 }
2513
2514 // The search stops as soon as an SDL file is found. The driver then provides
2515 // the full filename of the SDL to the llvm-link command. If no SDL is found
2516 // after searching each LINKPATH with SEARCH-ORDER, it is possible that an
2517 // archive file lib<libname>.a exists and may contain bundled object files.
2518 for (auto SDLName : SDLNames) {
2519 // This is the only call to SDLSearch
2520 if (!SDLSearch(D, DriverArgs, CC1Args, LibraryPaths, SDLName, Arch, Target,
2521 isBitCodeSDL)) {
2522 GetSDLFromOffloadArchive(*C, D, *T, *JA, *Inputs, DriverArgs, CC1Args,
2523 LibraryPaths, SDLName, Arch, Target,
2524 isBitCodeSDL);
2525 }
2526 }
2527}
2528
2529static llvm::opt::Arg *
2530getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args) {
2531 return Args.getLastArg(options::OPT_mcode_object_version_EQ);
2532}
2533
2535 const llvm::opt::ArgList &Args) {
2536 const unsigned MinCodeObjVer = 4;
2537 const unsigned MaxCodeObjVer = 5;
2538
2539 if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
2540 if (CodeObjArg->getOption().getID() ==
2541 options::OPT_mcode_object_version_EQ) {
2542 unsigned CodeObjVer = MaxCodeObjVer;
2543 auto Remnant =
2544 StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
2545 if (Remnant || CodeObjVer < MinCodeObjVer || CodeObjVer > MaxCodeObjVer)
2546 D.Diag(diag::err_drv_invalid_int_value)
2547 << CodeObjArg->getAsString(Args) << CodeObjArg->getValue();
2548 }
2549 }
2550}
2551
2553 const llvm::opt::ArgList &Args) {
2554 unsigned CodeObjVer = 4; // default
2555 if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args))
2556 StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
2557 return CodeObjVer;
2558}
2559
2561 const Driver &D, const llvm::opt::ArgList &Args) {
2562 return getAMDGPUCodeObjectArgument(D, Args) != nullptr;
2563}
2564
2566 const llvm::opt::ArgList &Args,
2567 llvm::opt::ArgStringList &CmdArgs,
2568 const llvm::Triple &Triple, bool IsLTO,
2569 const StringRef PluginOptPrefix) {
2570 auto addArg = [&, IsLTO](const Twine &Arg) {
2571 if (IsLTO) {
2572 assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
2573 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
2574 } else {
2575 CmdArgs.push_back("-mllvm");
2576 CmdArgs.push_back(Args.MakeArgString(Arg));
2577 }
2578 };
2579
2580 if (Arg *A = Args.getLastArg(options::OPT_moutline,
2581 options::OPT_mno_outline)) {
2582 if (A->getOption().matches(options::OPT_moutline)) {
2583 // We only support -moutline in AArch64 and ARM targets right now. If
2584 // we're not compiling for these, emit a warning and ignore the flag.
2585 // Otherwise, add the proper mllvm flags.
2586 if (!(Triple.isARM() || Triple.isThumb() ||
2587 Triple.getArch() == llvm::Triple::aarch64 ||
2588 Triple.getArch() == llvm::Triple::aarch64_32)) {
2589 D.Diag(diag::warn_drv_moutline_unsupported_opt) << Triple.getArchName();
2590 } else {
2591 addArg(Twine("-enable-machine-outliner"));
2592 }
2593 } else {
2594 // Disable all outlining behaviour.
2595 addArg(Twine("-enable-machine-outliner=never"));
2596 }
2597 }
2598}
2599
2601 const llvm::opt::ArgList &DriverArgs,
2602 llvm::opt::ArgStringList &CC1Args,
2603 StringRef BitcodeSuffix,
2604 const llvm::Triple &Triple) {
2605 SmallVector<StringRef, 8> LibraryPaths;
2606
2607 // Add path to clang lib / lib64 folder.
2608 SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
2609 llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
2610 LibraryPaths.emplace_back(DefaultLibPath.c_str());
2611
2612 // Add user defined library paths from LIBRARY_PATH.
2613 std::optional<std::string> LibPath =
2614 llvm::sys::Process::GetEnv("LIBRARY_PATH");
2615 if (LibPath) {
2617 const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
2618 llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
2619 for (StringRef Path : Frags)
2620 LibraryPaths.emplace_back(Path.trim());
2621 }
2622
2623 OptSpecifier LibomptargetBCPathOpt =
2624 Triple.isAMDGCN() ? options::OPT_libomptarget_amdgpu_bc_path_EQ
2625 : options::OPT_libomptarget_nvptx_bc_path_EQ;
2626
2627 StringRef ArchPrefix = Triple.isAMDGCN() ? "amdgpu" : "nvptx";
2628 std::string LibOmpTargetName =
2629 ("libomptarget-" + ArchPrefix + "-" + BitcodeSuffix + ".bc").str();
2630
2631 // First check whether user specifies bc library
2632 if (const Arg *A = DriverArgs.getLastArg(LibomptargetBCPathOpt)) {
2633 SmallString<128> LibOmpTargetFile(A->getValue());
2634 if (llvm::sys::fs::exists(LibOmpTargetFile) &&
2635 llvm::sys::fs::is_directory(LibOmpTargetFile)) {
2636 llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
2637 }
2638
2639 if (llvm::sys::fs::exists(LibOmpTargetFile)) {
2640 CC1Args.push_back("-mlink-builtin-bitcode");
2641 CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
2642 } else {
2643 D.Diag(diag::err_drv_omp_offload_target_bcruntime_not_found)
2644 << LibOmpTargetFile;
2645 }
2646 } else {
2647 bool FoundBCLibrary = false;
2648
2649 for (StringRef LibraryPath : LibraryPaths) {
2650 SmallString<128> LibOmpTargetFile(LibraryPath);
2651 llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
2652 if (llvm::sys::fs::exists(LibOmpTargetFile)) {
2653 CC1Args.push_back("-mlink-builtin-bitcode");
2654 CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
2655 FoundBCLibrary = true;
2656 break;
2657 }
2658 }
2659
2660 if (!FoundBCLibrary)
2661 D.Diag(diag::err_drv_omp_offload_target_missingbcruntime)
2662 << LibOmpTargetName << ArchPrefix;
2663 }
2664}
2666 const llvm::opt::ArgList &Args,
2667 llvm::opt::ArgStringList &CmdArgs) {
2668 if ((C.getActiveOffloadKinds() & Action::OFK_HIP) &&
2669 !Args.hasArg(options::OPT_nostdlib) &&
2670 !Args.hasArg(options::OPT_no_hip_rt)) {
2671 TC.AddHIPRuntimeLibArgs(Args, CmdArgs);
2672 } else {
2673 // Claim "no HIP libraries" arguments if any
2674 for (auto *Arg : Args.filtered(options::OPT_no_hip_rt)) {
2675 Arg->claim();
2676 }
2677 }
2678}
#define V(N, I)
Definition: ASTContext.h:3241
static unsigned ParseDebugDefaultVersion(const ToolChain &TC, const ArgList &Args)
static void getWebAssemblyTargetFeatures(const Driver &D, const llvm::Triple &Triple, const ArgList &Args, std::vector< StringRef > &Features)
Definition: CommonArgs.cpp:624
LibGccType
static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs, StringRef Sanitizer)
static llvm::opt::Arg * getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args)
static void collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args, SmallVectorImpl< StringRef > &SharedRuntimes, SmallVectorImpl< StringRef > &StaticRuntimes, SmallVectorImpl< StringRef > &NonWholeStaticRuntimes, SmallVectorImpl< StringRef > &HelperStaticRuntimes, SmallVectorImpl< StringRef > &RequiredSymbols)
static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs, StringRef Sanitizer, bool IsShared, bool IsWhole)
static void AddUnwindLibrary(const ToolChain &TC, const Driver &D, ArgStringList &CmdArgs, const ArgList &Args)
static bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const SmallVectorImpl< std::string > &LibraryPaths, StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL)
SDLSearch: Search for Static Device Library The search for SDL bitcode files is consistent with how s...
static void renderRpassOptions(const ArgList &Args, ArgStringList &CmdArgs, const StringRef PluginOptPrefix)
Definition: CommonArgs.cpp:213
static StringRef getWebAssemblyTargetCPU(const ArgList &Args)
Get the (LLVM) name of the WebAssembly cpu we are targeting.
Definition: CommonArgs.cpp:504
static void renderRemarksHotnessOptions(const ArgList &Args, ArgStringList &CmdArgs, const StringRef PluginOptPrefix)
Definition: CommonArgs.cpp:259
static void GetSDLFromOffloadArchive(Compilation &C, const Driver &D, const Tool &T, const JobAction &JA, const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const SmallVectorImpl< std::string > &LibraryPaths, StringRef Lib, StringRef Arch, StringRef Target, bool isBitCodeSDL)
Search if a user provided archive file lib<libname>.a exists in any of the library paths.
static std::string getLanaiTargetCPU(const ArgList &Args)
Definition: CommonArgs.cpp:496
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs, const llvm::Triple &Triple, const InputInfo &Input, const InputInfo &Output, const StringRef PluginOptPrefix)
Definition: CommonArgs.cpp:228
static bool useFramePointerForTargetByDefault(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: CommonArgs.cpp:75
static void AddLibgcc(const ToolChain &TC, const Driver &D, ArgStringList &CmdArgs, const ArgList &Args)
static LibGccType getLibGccType(const ToolChain &TC, const Driver &D, const ArgList &Args)
clang::CodeGenOptions::FramePointerKind getFramePointerKind(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: CommonArgs.cpp:179
static void addOpenMPDeviceLibC(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs)
Adds the '-lcgpu' and '-lmgpu' libraries to the compilation to include the LLVM C library for GPUs.
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:476
static bool mustUseNonLeafFramePointerForTarget(const llvm::Triple &Triple)
Definition: CommonArgs.cpp:166
static bool shouldIgnoreUnsupportedTargetFeature(const Arg &TargetFeatureArg, llvm::Triple T, StringRef Processor)
Definition: CommonArgs.cpp:274
Defines the clang::LangOptions interface.
Defines types useful for describing an Objective-C runtime.
Defines version macros and version-related utility functions for Clang.
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1547
const char * getOffloadingArch() const
Definition: Action.h:211
static StringRef GetOffloadKindName(OffloadKind Kind)
Return a string containing a offload kind name.
Definition: Action.cpp:156
OffloadKind getOffloadingDeviceKind() const
Definition: Action.h:210
bool isHostOffloading(unsigned int OKind) const
Check if this action have any offload kinds.
Definition: Action.h:218
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
std::string CCPrintInternalStatReportFilename
The file to log CC_PRINT_INTERNAL_STAT_FILE output to, if enabled.
Definition: Driver.h:198
DiagnosticsEngine & getDiags() const
Definition: Driver.h:390
OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const
Compute the desired OpenMP runtime from the flags provided.
Definition: Driver.cpp:728
DiagnosticBuilder Diag(unsigned DiagID) const
Definition: Driver.h:144
unsigned CCPrintInternalStats
Set CC_PRINT_INTERNAL_STAT mode, which causes the driver to dump internal performance report to CC_PR...
Definition: Driver.h:266
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:167
llvm::vfs::FileSystem & getVFS() const
Definition: Driver.h:392
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:6144
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:155
@ OMPRT_IOMP5
The legacy name for the LLVM OpenMP runtime from when it was the Intel OpenMP runtime.
Definition: Driver.h:140
@ OMPRT_OMP
The LLVM OpenMP runtime.
Definition: Driver.h:130
@ OMPRT_Unknown
An unknown OpenMP runtime.
Definition: Driver.h:126
@ OMPRT_GOMP
The GNU OpenMP runtime.
Definition: Driver.h:135
std::string getTargetTriple() const
Definition: Driver.h:409
bool CCCIsCXX() const
Whether the driver should follow g++ like behavior.
Definition: Driver.h:216
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getBaseInput() const
Definition: InputInfo.h:78
const char * getFilename() const
Definition: InputInfo.h:83
bool isFilename() const
Definition: InputInfo.h:75
std::vector< std::string > flags_list
Definition: Multilib.h:34
bool requiresMinimalRuntime() const
Definition: SanitizerArgs.h:99
const std::string & getMemtagMode() const
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:92
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:1267
virtual bool useIntegratedAs() const
Check if the toolchain should use the integrated assembler.
Definition: ToolChain.cpp:136
virtual void AddHIPRuntimeLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Add the system specific linker arguments to use for the given HIP runtime library type.
Definition: ToolChain.h:766
virtual RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:1045
const char * getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:674
llvm::Triple::ArchType getArch() const
Definition: ToolChain.h:261
const Driver & getDriver() const
Definition: ToolChain.h:245
llvm::vfs::FileSystem & getVFS() const
Definition: ToolChain.cpp:132
const XRayArgs & getXRayArgs() const
Definition: ToolChain.cpp:280
virtual bool isPIEDefault(const llvm::opt::ArgList &Args) const =0
Test whether this toolchain defaults to PIE.
virtual bool isPICDefaultForced() const =0
Tests whether this toolchain forces its default for PIC, PIE or non-PIC.
const llvm::Triple & getEffectiveTriple() const
Get the toolchain's effective clang triple.
Definition: ToolChain.h:275
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:1241
const llvm::Triple & getTriple() const
Definition: ToolChain.h:247
virtual bool HasNativeLLVMSupport() const
HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support.
Definition: ToolChain.cpp:923
virtual UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:1071
std::string GetLinkerPath(bool *LinkerIsLLD=nullptr) const
Returns the linker path, respecting the -fuse-ld= argument to determine the linker suffix or name.
Definition: ToolChain.cpp:832
virtual std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:653
std::string GetProgramPath(const char *Name) const
Definition: ToolChain.cpp:828
std::string getTripleString() const
Definition: ToolChain.h:270
SanitizerArgs getSanitizerArgs(const llvm::opt::ArgList &JobArgs) const
Definition: ToolChain.cpp:274
virtual path_list getArchSpecificLibPaths() const
Definition: ToolChain.cpp:778
virtual bool isCrossCompiling() const
Returns true if the toolchain is targeting a non-native architecture.
Definition: ToolChain.cpp:927
virtual bool isPICDefault() const =0
Test whether this toolchain defaults to PIC.
virtual unsigned GetDefaultDwarfVersion() const
Definition: ToolChain.cpp:430
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const ToolChain & getToolChain() const
Definition: Tool.h:52
bool needsXRayRt() const
Definition: XRayArgs.h:37
llvm::ArrayRef< std::string > modeList() const
Definition: XRayArgs.h:38
static StringRef GetTargetCPUVersion(const llvm::opt::ArgList &Args)
Definition: Hexagon.cpp:798
void getNVPTXTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
Definition: Cuda.cpp:654
void getAArch64TargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features, bool ForAS)
std::string getAArch64TargetCPU(const llvm::opt::ArgList &Args, const llvm::Triple &Triple, llvm::opt::Arg *&A)
void getAMDGPUTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
Definition: AMDGPU.cpp:627
void getARMArchCPUFromArgs(const llvm::opt::ArgList &Args, llvm::StringRef &Arch, llvm::StringRef &CPU, bool FromAs=false)
std::string getARMTargetCPU(StringRef CPU, llvm::StringRef Arch, const llvm::Triple &Triple)
llvm::ARM::FPUKind getARMTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features, bool ForAS, bool ForMultilib=false)
void getCSKYTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, std::vector< llvm::StringRef > &Features)
void getHexagonTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
std::string getLoongArchTargetCPU(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: LoongArch.cpp:225
void getLoongArchTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
void getM68kTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getM68kTargetCPU(const llvm::opt::ArgList &Args)
void getMIPSTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
void getMipsCPUAndABI(const llvm::opt::ArgList &Args, const llvm::Triple &Triple, StringRef &CPUName, StringRef &ABIName)
void getMSP430TargetFeatures(const Driver &D, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getPPCTargetCPU(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T)
void getPPCTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getRISCVTargetCPU(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: RISCV.cpp:335
void getRISCVTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
bool isLinkerGnuLd(const ToolChain &TC, const llvm::opt::ArgList &Args)
void getSparcTargetFeatures(const Driver &D, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getSparcTargetCPU(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
void getSystemZTargetFeatures(const Driver &D, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getSystemZTargetCPU(const llvm::opt::ArgList &Args)
void getVETargetFeatures(const Driver &D, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
std::string getX86TargetCPU(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
void getX86TargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< llvm::StringRef > &Features)
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)
void addX86AlignBranchArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool IsLTO, const StringRef PluginOptPrefix="")
void addMachineOutlinerArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple, bool IsLTO, const StringRef PluginOptPrefix="")
unsigned ParseFunctionAlignment(const ToolChain &TC, const llvm::opt::ArgList &Args)
void addOpenMPDeviceRTL(const Driver &D, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, StringRef BitcodeSuffix, const llvm::Triple &Triple)
void handleTargetFeaturesGroup(const Driver &D, const llvm::Triple &Triple, 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.
SmallVector< StringRef > unifyTargetFeatures(ArrayRef< StringRef > Features)
If there are multiple +xxx or -xxx features, keep the last one.
Definition: CommonArgs.cpp:329
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
const char * SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Input, const InputInfo &Output)
void checkAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
void getTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool ForAS, bool IsAux=false)
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)
void addAsNeededOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool as_needed)
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
void addHIPRuntimeLibArgs(const ToolChain &TC, Compilation &C, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addMultilibFlag(bool Enabled, const StringRef Flag, Multilib::flags_list &Flags)
Flag must be a flag accepted by the driver.
bool isUseSeparateSections(const llvm::Triple &Triple)
Definition: CommonArgs.cpp:728
void linkXRayRuntimeDeps(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
void SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T, const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Output, const char *OutFile)
void linkSanitizerRuntimeDeps(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
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.
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool areOptimizationsEnabled(const llvm::opt::ArgList &Args)
void addOpenMPRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void AddAssemblerKPIC(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool haveAMDGPUCodeObjectVersionArgument(const Driver &D, const llvm::opt::ArgList &Args)
void addDebugInfoKind(llvm::opt::ArgStringList &CmdArgs, llvm::codegenoptions::DebugInfoKind DebugInfoKind)
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:289
llvm::codegenoptions::DebugInfoKind debugLevelToInfoKind(const llvm::opt::Arg &A)
llvm::opt::Arg * getLastCSProfileGenerateArg(const llvm::opt::ArgList &Args)
llvm::opt::Arg * getLastProfileUseArg(const llvm::opt::ArgList &Args)
void addFortranRuntimeLibraryPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Adds the path for the Fortran runtime libraries to CmdArgs.
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
void addLinkerCompressDebugSectionsOption(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Definition: CommonArgs.cpp:445
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.
void addLTOOptions(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfo &Input, bool IsThinLTO)
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
unsigned DwarfVersionNum(StringRef ArgValue)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
unsigned getDwarfVersion(const ToolChain &TC, const llvm::opt::ArgList &Args)
unsigned getAMDGPUCodeObjectVersion(const Driver &D, const llvm::opt::ArgList &Args)
const llvm::opt::Arg * getDwarfNArg(const llvm::opt::ArgList &Args)
void AddTargetFeature(const llvm::opt::ArgList &Args, std::vector< StringRef > &Features, llvm::opt::OptSpecifier OnOpt, llvm::opt::OptSpecifier OffOpt, StringRef FeatureName)
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.
void addArchSpecificRPath(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool isObjCAutoRefCount(const llvm::opt::ArgList &Args)
void addFortranRuntimeLibs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Adds Fortran runtime libraries to CmdArgs.
const char * RelocationModelName(llvm::Reloc::Model Model)
bool isLLVMIR(ID Id)
Is this LLVM IR.
Definition: Types.cpp:252
ID lookupTypeForExtension(llvm::StringRef Ext)
lookupTypeForExtension - Lookup the type to use for the file extension Ext.
Definition: Types.cpp:295
bool willEmitRemarks(const llvm::opt::ArgList &Args)
llvm::StringRef getProcessorFromTargetID(const llvm::Triple &T, llvm::StringRef OffloadArch)
Get processor name from target ID.
Definition: TargetID.cpp:54
static constexpr ResponseFileSupport AtFileCurCP()
Definition: Job.h:92