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