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