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