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