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 if (llvm::AMDGPU::getFeatureBitset(GPUKind).test(
386 llvm::AMDGPU::FEAT_SUPPORTS_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::renderDebugInfoCompressionArgs(const ArgList &Args,
686 ArgStringList &CmdArgs,
687 const Driver &D,
688 const ToolChain &TC) {
689 const Arg *A = Args.getLastArg(options::OPT_gz_EQ);
690 if (!A)
691 return;
692 if (checkDebugInfoOption(A, Args, D, TC)) {
693 StringRef Value = A->getValue();
694 if (Value == "none") {
695 CmdArgs.push_back("--compress-debug-sections=none");
696 } else if (Value == "zlib") {
697 if (llvm::compression::zlib::isAvailable()) {
698 CmdArgs.push_back(
699 Args.MakeArgString("--compress-debug-sections=" + Twine(Value)));
700 } else {
701 D.Diag(diag::warn_debug_compression_unavailable) << "zlib";
702 }
703 } else if (Value == "zstd") {
704 if (llvm::compression::zstd::isAvailable()) {
705 CmdArgs.push_back(
706 Args.MakeArgString("--compress-debug-sections=" + Twine(Value)));
707 } else {
708 D.Diag(diag::warn_debug_compression_unavailable) << "zstd";
709 }
710 } else {
711 D.Diag(diag::err_drv_unsupported_option_argument)
712 << A->getSpelling() << Value;
713 }
714 }
715}
716
717void tools::AddTargetFeature(const ArgList &Args,
718 std::vector<StringRef> &Features,
719 OptSpecifier OnOpt, OptSpecifier OffOpt,
720 StringRef FeatureName) {
721 if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
722 if (A->getOption().matches(OnOpt))
723 Features.push_back(Args.MakeArgString("+" + FeatureName));
724 else
725 Features.push_back(Args.MakeArgString("-" + FeatureName));
726 }
727}
728
729/// Get the (LLVM) name of the AMDGPU gpu we are targeting.
730static StringRef getAMDGPUTargetGPU(const llvm::Triple &T,
731 const ArgList &Args) {
732 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
733 return getProcessorFromTargetID(T, A->getValue());
734 }
735 return "";
736}
737
738static std::string getLanaiTargetCPU(const ArgList &Args) {
739 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
740 return A->getValue();
741 }
742 return "";
743}
744
745/// Get the (LLVM) name of the WebAssembly cpu we are targeting.
746static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
747 // If we have -mcpu=, use that.
748 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
749 StringRef CPU = A->getValue();
750
751#ifdef __wasm__
752 // Handle "native" by examining the host. "native" isn't meaningful when
753 // cross compiling, so only support this when the host is also WebAssembly.
754 if (CPU == "native")
755 return llvm::sys::getHostCPUName();
756#endif
757
758 return CPU;
759 }
760
761 return "generic";
762}
763
764std::string tools::getCPUName(const Driver &D, const ArgList &Args,
765 const llvm::Triple &T, bool FromAs) {
766 Arg *A;
767
768 switch (T.getArch()) {
769 default:
770 return "";
771
772 case llvm::Triple::aarch64:
773 case llvm::Triple::aarch64_32:
774 case llvm::Triple::aarch64_be:
775 return aarch64::getAArch64TargetCPU(Args, T, A);
776
777 case llvm::Triple::arm:
778 case llvm::Triple::armeb:
779 case llvm::Triple::thumb:
780 case llvm::Triple::thumbeb: {
781 StringRef MArch, MCPU;
782 arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
783 return arm::getARMTargetCPU(MCPU, MArch, T);
784 }
785
786 case llvm::Triple::avr:
787 if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
788 return A->getValue();
789 return "";
790
791 case llvm::Triple::m68k:
792 return m68k::getM68kTargetCPU(Args);
793
794 case llvm::Triple::mips:
795 case llvm::Triple::mipsel:
796 case llvm::Triple::mips64:
797 case llvm::Triple::mips64el: {
798 StringRef CPUName;
799 StringRef ABIName;
800 mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
801 return std::string(CPUName);
802 }
803
804 case llvm::Triple::nvptx:
805 case llvm::Triple::nvptx64:
806 if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
807 return A->getValue();
808 return "";
809
810 case llvm::Triple::ppc:
811 case llvm::Triple::ppcle:
812 case llvm::Triple::ppc64:
813 case llvm::Triple::ppc64le:
814 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
815 return std::string(
816 llvm::PPC::getNormalizedPPCTargetCPU(T, A->getValue()));
817 return std::string(llvm::PPC::getNormalizedPPCTargetCPU(T));
818
819 case llvm::Triple::csky:
820 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
821 return A->getValue();
822 else if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
823 return A->getValue();
824 else
825 return "ck810";
826 case llvm::Triple::riscv32:
827 case llvm::Triple::riscv64:
828 case llvm::Triple::riscv32be:
829 case llvm::Triple::riscv64be:
830 return riscv::getRISCVTargetCPU(Args, T);
831
832 case llvm::Triple::bpfel:
833 case llvm::Triple::bpfeb:
834 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
835 return A->getValue();
836 return "";
837
838 case llvm::Triple::sparc:
839 case llvm::Triple::sparcel:
840 case llvm::Triple::sparcv9:
841 return sparc::getSparcTargetCPU(D, Args, T);
842
843 case llvm::Triple::x86:
844 case llvm::Triple::x86_64:
845 return x86::getX86TargetCPU(D, Args, T);
846
847 case llvm::Triple::hexagon:
848 return "hexagon" +
850
851 case llvm::Triple::lanai:
852 return getLanaiTargetCPU(Args);
853
854 case llvm::Triple::systemz:
855 return systemz::getSystemZTargetCPU(Args, T);
856
857 case llvm::Triple::amdgpu:
858 case llvm::Triple::r600:
859 return getAMDGPUTargetGPU(T, Args).str();
860
861 case llvm::Triple::wasm32:
862 case llvm::Triple::wasm64:
863 return std::string(getWebAssemblyTargetCPU(Args));
864
865 case llvm::Triple::loongarch32:
866 case llvm::Triple::loongarch64:
868
869 case llvm::Triple::xtensa:
870 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
871 return A->getValue();
872 return "";
873 }
874}
875
877 const llvm::Triple &Triple,
878 const ArgList &Args,
879 std::vector<StringRef> &Features) {
880 handleTargetFeaturesGroup(D, Triple, Args, Features,
881 options::OPT_m_wasm_Features_Group);
882}
883
884void tools::getTargetFeatures(const Driver &D, const llvm::Triple &Triple,
885 const ArgList &Args, ArgStringList &CmdArgs,
886 bool ForAS, bool IsAux) {
887 std::vector<StringRef> Features;
888 switch (Triple.getArch()) {
889 default:
890 break;
891 case llvm::Triple::mips:
892 case llvm::Triple::mipsel:
893 case llvm::Triple::mips64:
894 case llvm::Triple::mips64el:
895 mips::getMIPSTargetFeatures(D, Triple, Args, Features);
896 break;
897 case llvm::Triple::arm:
898 case llvm::Triple::armeb:
899 case llvm::Triple::thumb:
900 case llvm::Triple::thumbeb:
901 arm::getARMTargetFeatures(D, Triple, Args, Features, ForAS);
902 break;
903 case llvm::Triple::ppc:
904 case llvm::Triple::ppcle:
905 case llvm::Triple::ppc64:
906 case llvm::Triple::ppc64le:
907 ppc::getPPCTargetFeatures(D, Triple, Args, Features);
908 break;
909 case llvm::Triple::riscv32:
910 case llvm::Triple::riscv64:
911 case llvm::Triple::riscv32be:
912 case llvm::Triple::riscv64be:
913 riscv::getRISCVTargetFeatures(D, Triple, Args, Features);
914 break;
915 case llvm::Triple::systemz:
916 systemz::getSystemZTargetFeatures(D, Args, Features);
917 break;
918 case llvm::Triple::aarch64:
919 case llvm::Triple::aarch64_32:
920 case llvm::Triple::aarch64_be:
921 aarch64::getAArch64TargetFeatures(D, Triple, Args, Features, ForAS);
922 break;
923 case llvm::Triple::x86:
924 case llvm::Triple::x86_64:
925 x86::getX86TargetFeatures(D, Triple, Args, Features);
926 break;
927 case llvm::Triple::hexagon:
928 hexagon::getHexagonTargetFeatures(D, Triple, Args, Features);
929 break;
930 case llvm::Triple::wasm32:
931 case llvm::Triple::wasm64:
932 getWebAssemblyTargetFeatures(D, Triple, Args, Features);
933 break;
934 case llvm::Triple::sparc:
935 case llvm::Triple::sparcel:
936 case llvm::Triple::sparcv9:
937 sparc::getSparcTargetFeatures(D, Triple, Args, Features);
938 break;
939 case llvm::Triple::amdgpu:
940 case llvm::Triple::r600:
941 amdgpu::getAMDGPUTargetFeatures(D, Triple, Args, Features, ForAS);
942 break;
943 case llvm::Triple::nvptx:
944 case llvm::Triple::nvptx64:
945 NVPTX::getNVPTXTargetFeatures(D, Triple, Args, Features);
946 break;
947 case llvm::Triple::m68k:
948 m68k::getM68kTargetFeatures(D, Triple, Args, Features);
949 break;
950 case llvm::Triple::msp430:
951 msp430::getMSP430TargetFeatures(D, Args, Features);
952 break;
953 case llvm::Triple::ve:
954 ve::getVETargetFeatures(D, Args, Features);
955 break;
956 case llvm::Triple::csky:
957 csky::getCSKYTargetFeatures(D, Triple, Args, CmdArgs, Features);
958 break;
959 case llvm::Triple::loongarch32:
960 case llvm::Triple::loongarch64:
961 loongarch::getLoongArchTargetFeatures(D, Triple, Args, Features);
962 break;
963 }
964
965 for (auto Feature : unifyTargetFeatures(Features)) {
966 CmdArgs.push_back(IsAux ? "-aux-target-feature" : "-target-feature");
967 CmdArgs.push_back(Feature.data());
968 }
969}
970
971llvm::StringRef tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
972 Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
973 if (!LtoJobsArg)
974 return {};
975 if (!llvm::get_threadpool_strategy(LtoJobsArg->getValue()))
976 D.Diag(diag::err_drv_invalid_int_value)
977 << LtoJobsArg->getAsString(Args) << LtoJobsArg->getValue();
978 return LtoJobsArg->getValue();
979}
980
981// PS4/PS5 uses -ffunction-sections and -fdata-sections by default.
982bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
983 return Triple.isPS();
984}
985
986void tools::addSeparateSectionFlags(const llvm::Triple &Triple,
987 const ArgList &Args,
988 ArgStringList &CmdArgs) {
989 bool UseSeparateSections = isUseSeparateSections(Triple);
990 if (Args.hasFlag(options::OPT_ffunction_sections,
991 options::OPT_fno_function_sections, UseSeparateSections))
992 CmdArgs.push_back("-ffunction-sections");
993
994 bool HasDefaultDataSections = Triple.isOSBinFormatXCOFF();
995 if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
996 UseSeparateSections || HasDefaultDataSections))
997 CmdArgs.push_back("-fdata-sections");
998}
999
1001 const llvm::opt::ArgList &Args) {
1002 const llvm::Triple &Triple = TC.getEffectiveTriple();
1003 Arg *A = Args.getLastArg(options::OPT_mtls_dialect_EQ);
1004 if (!A)
1005 return Triple.hasDefaultTLSDESC();
1006 StringRef V = A->getValue();
1007 bool SupportedArgument = false, EnableTLSDESC = false;
1008 bool Unsupported = !Triple.isOSBinFormatELF();
1009 if (Triple.isLoongArch() || Triple.isRISCV()) {
1010 SupportedArgument = V == "desc" || V == "trad";
1011 EnableTLSDESC = V == "desc";
1012 } else if (Triple.isX86()) {
1013 SupportedArgument = V == "gnu" || V == "gnu2";
1014 EnableTLSDESC = V == "gnu2";
1015 } else {
1016 Unsupported = true;
1017 }
1018 if (Unsupported) {
1019 TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
1020 << A->getSpelling() << Triple.getTriple();
1021 } else if (!SupportedArgument) {
1022 TC.getDriver().Diag(diag::err_drv_unsupported_option_argument_for_target)
1023 << A->getSpelling() << V << Triple.getTriple();
1024 }
1025 return EnableTLSDESC;
1026}
1027
1028void tools::addDTLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
1029 llvm::opt::ArgStringList &CmdArgs) {
1030 if (Arg *A = Args.getLastArg(options::OPT_fthinlto_distributor_EQ)) {
1031 CmdArgs.push_back(
1032 Args.MakeArgString("--thinlto-distributor=" + Twine(A->getValue())));
1033 const Driver &D = ToolChain.getDriver();
1034 CmdArgs.push_back(Args.MakeArgString("--thinlto-remote-compiler=" +
1035 Twine(D.getDriverProgramPath())));
1036 if (auto *PA = D.getPrependArg())
1037 CmdArgs.push_back(Args.MakeArgString(
1038 "--thinlto-remote-compiler-prepend-arg=" + Twine(PA)));
1039
1040 for (const auto &A :
1041 Args.getAllArgValues(options::OPT_Xthinlto_distributor_EQ))
1042 CmdArgs.push_back(Args.MakeArgString("--thinlto-distributor-arg=" + A));
1043 }
1044}
1045
1046void tools::addLTOOptions(const ToolChain &ToolChain, const ArgList &Args,
1047 ArgStringList &CmdArgs, const InputInfo &Output,
1048 const InputInfoList &Inputs, bool IsThinLTO) {
1049 const llvm::Triple &Triple = ToolChain.getTriple();
1050 const bool IsOSAIX = Triple.isOSAIX();
1051 const bool IsAMDGCN = Triple.isAMDGCN();
1052 StringRef Linker = Args.getLastArgValue(options::OPT_fuse_ld_EQ);
1053 const char *LinkerPath = Args.MakeArgString(ToolChain.GetLinkerPath());
1054 const Driver &D = ToolChain.getDriver();
1055 const bool IsFatLTO = Args.hasFlag(options::OPT_ffat_lto_objects,
1056 options::OPT_fno_fat_lto_objects, false);
1057 const bool IsUnifiedLTO = Args.hasArg(options::OPT_funified_lto);
1058
1059 assert(!Inputs.empty() && "Must have at least one input.");
1060
1061 auto Input = llvm::find_if(
1062 Inputs, [](const InputInfo &II) -> bool { return II.isFilename(); });
1063 if (Input == Inputs.end()) {
1064 // For a very rare case, all of the inputs to the linker are
1065 // InputArg. If that happens, just use the first InputInfo.
1066 Input = Inputs.begin();
1067 }
1068
1069 if (Linker != "lld" && Linker != "lld-link" &&
1070 llvm::sys::path::filename(LinkerPath) != "ld.lld" &&
1071 llvm::sys::path::stem(LinkerPath) != "ld.lld" && !Triple.isOSOpenBSD()) {
1072 // Tell the linker to load the plugin. This has to come before
1073 // AddLinkerInputs as gold requires -plugin and AIX ld requires -bplugin to
1074 // come before any -plugin-opt/-bplugin_opt that -Wl might forward.
1075 const char *PluginPrefix = IsOSAIX ? "-bplugin:" : "";
1076 const char *PluginName = IsOSAIX ? "/libLTO" : "/LLVMgold";
1077
1078 if (!IsOSAIX)
1079 CmdArgs.push_back("-plugin");
1080
1081#if defined(_WIN32)
1082 const char *Suffix = ".dll";
1083#elif defined(__APPLE__)
1084 const char *Suffix = ".dylib";
1085#else
1086 const char *Suffix = ".so";
1087#endif
1088
1089 SmallString<1024> Plugin;
1090 llvm::sys::path::native(Twine(D.Dir) +
1091 "/../" CLANG_INSTALL_LIBDIR_BASENAME +
1092 PluginName + Suffix,
1093 Plugin);
1094 CmdArgs.push_back(Args.MakeArgString(Twine(PluginPrefix) + Plugin));
1095 } else {
1096 // Tell LLD to find and use .llvm.lto section in regular relocatable object
1097 // files
1098 if (IsFatLTO)
1099 CmdArgs.push_back("--fat-lto-objects");
1100
1101 if (Args.hasArg(options::OPT_flto_partitions_EQ)) {
1102 int Value = 0;
1103 StringRef A = Args.getLastArgValue(options::OPT_flto_partitions_EQ, "8");
1104 if (A.getAsInteger(10, Value) || (Value < 1)) {
1105 Arg *Arg = Args.getLastArg(options::OPT_flto_partitions_EQ);
1106 D.Diag(diag::err_drv_invalid_int_value)
1107 << Arg->getAsString(Args) << Arg->getValue();
1108 }
1109 CmdArgs.push_back(Args.MakeArgString("--lto-partitions=" + A));
1110 }
1111 }
1112
1113 const char *PluginOptPrefix = IsOSAIX ? "-bplugin_opt:" : "-plugin-opt=";
1114 const char *ExtraDash = IsOSAIX ? "-" : "";
1115 const char *ParallelismOpt = IsOSAIX ? "-threads=" : "jobs=";
1116
1117 // Note, this solution is far from perfect, better to encode it into IR
1118 // metadata, but this may not be worth it, since it looks like aranges is on
1119 // the way out.
1120 if (Args.hasArg(options::OPT_gdwarf_aranges)) {
1121 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1122 "-generate-arange-section"));
1123 }
1124
1125 // Pass vector library arguments to LTO.
1126 Arg *ArgVecLib = Args.getLastArg(options::OPT_fveclib);
1127 if (ArgVecLib && ArgVecLib->getNumValues() == 1) {
1128 // Map the vector library names from clang front-end to opt front-end. The
1129 // values are taken from the TargetLibraryInfo class command line options.
1130 std::optional<StringRef> OptVal =
1131 llvm::StringSwitch<std::optional<StringRef>>(ArgVecLib->getValue())
1132 .Case("Accelerate", "Accelerate")
1133 .Case("libmvec", "LIBMVEC")
1134 .Case("AMDLIBM", "AMDLIBM")
1135 .Case("MASSV", "MASSV")
1136 .Case("SVML", "SVML")
1137 .Case("SLEEF", "sleefgnuabi")
1138 .Case("Darwin_libsystem_m", "Darwin_libsystem_m")
1139 .Case("ArmPL", "ArmPL")
1140 .Case("none", "none")
1141 .Default(std::nullopt);
1142
1143 if (OptVal)
1144 CmdArgs.push_back(Args.MakeArgString(
1145 Twine(PluginOptPrefix) + "-vector-library=" + OptVal.value()));
1146 }
1147
1148 // Try to pass driver level flags relevant to LTO code generation down to
1149 // the plugin.
1150
1151 // Handle flags for selecting CPU variants.
1152 std::string CPU = getCPUName(D, Args, Triple);
1153 if (!CPU.empty())
1154 CmdArgs.push_back(
1155 Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash + "mcpu=" + CPU));
1156
1157 if (Args.getLastArg(options::OPT_O_Group)) {
1158 unsigned OptimizationLevel =
1160 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
1161 "O" + Twine(OptimizationLevel)));
1162 if (IsAMDGCN)
1163 CmdArgs.push_back(
1164 Args.MakeArgString(Twine("--lto-CGO") + Twine(OptimizationLevel)));
1165 }
1166
1167 if (Args.hasArg(options::OPT_gsplit_dwarf)) {
1169 if (const Arg *A = Args.getLastArg(options::OPT_dumpdir)) {
1170 F = A->getValue();
1171 } else {
1172 F = Output.getFilename();
1173 F += "_";
1174 }
1175 CmdArgs.push_back(
1176 Args.MakeArgString(Twine(PluginOptPrefix) + "dwo_dir=" + F + "dwo"));
1177 }
1178
1179 if (IsThinLTO && !IsOSAIX)
1180 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + "thinlto"));
1181 else if (IsThinLTO && IsOSAIX)
1182 CmdArgs.push_back(Args.MakeArgString(Twine("-bdbg:thinlto")));
1183
1184 // Matrix intrinsic lowering happens at link time with ThinLTO. Enable
1185 // LowerMatrixIntrinsicsPass, which is transitively called by
1186 // buildThinLTODefaultPipeline under EnableMatrix.
1187 if ((IsThinLTO || IsFatLTO || IsUnifiedLTO) &&
1188 Args.hasArg(options::OPT_fenable_matrix))
1189 CmdArgs.push_back(
1190 Args.MakeArgString(Twine(PluginOptPrefix) + "-enable-matrix"));
1191
1192 StringRef Parallelism = getLTOParallelism(Args, D);
1193 if (!Parallelism.empty())
1194 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1195 ParallelismOpt + Parallelism));
1196
1197 // Forward the SLP vectorization preference to the LTO backend by toggling
1198 // the existing -vectorize-slp cl::opt, which the pass honors directly. This
1199 // avoids minting dedicated linker options for what is only pipeline tuning.
1200 if (Arg *A = Args.getLastArg(options::OPT_fslp_vectorize,
1201 options::OPT_fno_slp_vectorize))
1202 CmdArgs.push_back(Args.MakeArgString(
1203 Twine(PluginOptPrefix) + "-vectorize-slp=" +
1204 (A->getOption().matches(options::OPT_fslp_vectorize) ? "1" : "0")));
1205
1206 // Pass down GlobalISel options.
1207 if (Arg *A = Args.getLastArg(options::OPT_fglobal_isel,
1208 options::OPT_fno_global_isel)) {
1209 // Parsing -fno-global-isel explicitly gives architectures that enable GISel
1210 // by default a chance to disable it.
1211 CmdArgs.push_back(Args.MakeArgString(
1212 Twine(PluginOptPrefix) + "-global-isel=" +
1213 (A->getOption().matches(options::OPT_fglobal_isel) ? "1" : "0")));
1214 }
1215
1216 // If an explicit debugger tuning argument appeared, pass it along.
1217 if (Arg *A =
1218 Args.getLastArg(options::OPT_gTune_Group, options::OPT_ggdbN_Group)) {
1219 if (A->getOption().matches(options::OPT_glldb))
1220 CmdArgs.push_back(
1221 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=lldb"));
1222 else if (A->getOption().matches(options::OPT_gsce))
1223 CmdArgs.push_back(
1224 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=sce"));
1225 else if (A->getOption().matches(options::OPT_gdbx))
1226 CmdArgs.push_back(
1227 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=dbx"));
1228 else
1229 CmdArgs.push_back(
1230 Args.MakeArgString(Twine(PluginOptPrefix) + "-debugger-tune=gdb"));
1231 }
1232
1233 if (IsOSAIX) {
1235 CmdArgs.push_back(
1236 Args.MakeArgString(Twine(PluginOptPrefix) + "-no-integrated-as=1"));
1237
1238 // On AIX, clang assumes strict-dwarf is true if any debug option is
1239 // specified, unless it is told explicitly not to assume so.
1240 Arg *A = Args.getLastArg(options::OPT_g_Group);
1241 bool EnableDebugInfo = A && !A->getOption().matches(options::OPT_g0) &&
1242 !A->getOption().matches(options::OPT_ggdb0);
1243 if (EnableDebugInfo && Args.hasFlag(options::OPT_gstrict_dwarf,
1244 options::OPT_gno_strict_dwarf, true))
1245 CmdArgs.push_back(
1246 Args.MakeArgString(Twine(PluginOptPrefix) + "-strict-dwarf=true"));
1247
1248 for (const Arg *A : Args.filtered_reverse(options::OPT_mabi_EQ)) {
1249 StringRef V = A->getValue();
1250 if (V == "vec-default")
1251 break;
1252 if (V == "vec-extabi") {
1253 CmdArgs.push_back(
1254 Args.MakeArgString(Twine(PluginOptPrefix) + "-vec-extabi"));
1255 break;
1256 }
1257 }
1258 }
1259
1260 bool UseSeparateSections =
1262
1263 if (Args.hasFlag(options::OPT_ffunction_sections,
1264 options::OPT_fno_function_sections, UseSeparateSections))
1265 CmdArgs.push_back(
1266 Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=1"));
1267 else if (Args.hasArg(options::OPT_fno_function_sections))
1268 CmdArgs.push_back(
1269 Args.MakeArgString(Twine(PluginOptPrefix) + "-function-sections=0"));
1270
1271 bool DataSectionsTurnedOff = false;
1272 if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
1273 UseSeparateSections)) {
1274 CmdArgs.push_back(
1275 Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=1"));
1276 } else if (Args.hasArg(options::OPT_fno_data_sections)) {
1277 DataSectionsTurnedOff = true;
1278 CmdArgs.push_back(
1279 Args.MakeArgString(Twine(PluginOptPrefix) + "-data-sections=0"));
1280 }
1281
1282 if (Args.hasArg(options::OPT_mxcoff_roptr) ||
1283 Args.hasArg(options::OPT_mno_xcoff_roptr)) {
1284 bool HasRoptr = Args.hasFlag(options::OPT_mxcoff_roptr,
1285 options::OPT_mno_xcoff_roptr, false);
1286 StringRef OptStr = HasRoptr ? "-mxcoff-roptr" : "-mno-xcoff-roptr";
1287 if (!IsOSAIX)
1288 D.Diag(diag::err_drv_unsupported_opt_for_target)
1289 << OptStr << Triple.str();
1290
1291 if (HasRoptr) {
1292 // The data sections option is on by default on AIX. We only need to error
1293 // out when -fno-data-sections is specified explicitly to turn off data
1294 // sections.
1295 if (DataSectionsTurnedOff)
1296 D.Diag(diag::err_roptr_requires_data_sections);
1297
1298 CmdArgs.push_back(
1299 Args.MakeArgString(Twine(PluginOptPrefix) + "-mxcoff-roptr"));
1300 }
1301 }
1302
1303 // Pass an option to enable split machine functions.
1304 if (auto *A = Args.getLastArg(options::OPT_fsplit_machine_functions,
1305 options::OPT_fno_split_machine_functions)) {
1306 if (A->getOption().matches(options::OPT_fsplit_machine_functions))
1307 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1308 "-split-machine-functions"));
1309 }
1310
1311 if (auto *A =
1312 Args.getLastArg(options::OPT_fpartition_static_data_sections,
1313 options::OPT_fno_partition_static_data_sections)) {
1314 if (A->getOption().matches(options::OPT_fpartition_static_data_sections)) {
1315 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1316 "-partition-static-data-sections"));
1317 }
1318 }
1319
1320 if (Arg *A = getLastProfileSampleUseArg(Args)) {
1321 StringRef FName = A->getValue();
1322 if (!llvm::sys::fs::exists(FName))
1323 D.Diag(diag::err_drv_no_such_file) << FName;
1324 else
1325 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1326 "sample-profile=" + FName));
1327 }
1328
1329 if (auto *CSPGOGenerateArg = getLastCSProfileGenerateArg(Args)) {
1330 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
1331 "cs-profile-generate"));
1332 if (CSPGOGenerateArg->getOption().matches(
1333 options::OPT_fcs_profile_generate_EQ)) {
1334 SmallString<128> Path(CSPGOGenerateArg->getValue());
1335 llvm::sys::path::append(Path, "default_%m.profraw");
1336 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
1337 "cs-profile-path=" + Path));
1338 } else
1339 CmdArgs.push_back(
1340 Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
1341 "cs-profile-path=default_%m.profraw"));
1342 } else if (auto *ProfileUseArg = getLastProfileUseArg(Args)) {
1343 SmallString<128> Path(
1344 ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
1345 if (Path.empty() || llvm::sys::fs::is_directory(Path))
1346 llvm::sys::path::append(Path, "default.profdata");
1347 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + ExtraDash +
1348 "cs-profile-path=" + Path));
1349 }
1350
1351 // This controls whether or not we perform JustMyCode instrumentation.
1352 if (Args.hasFlag(options::OPT_fjmc, options::OPT_fno_jmc, false)) {
1353 if (ToolChain.getEffectiveTriple().isOSBinFormatELF())
1354 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) +
1355 "-enable-jmc-instrument"));
1356 else
1357 D.Diag(clang::diag::warn_drv_fjmc_for_elf_only);
1358 }
1359
1360 if (Args.hasFlag(options::OPT_femulated_tls, options::OPT_fno_emulated_tls,
1361 Triple.hasDefaultEmulatedTLS())) {
1362 CmdArgs.push_back(
1363 Args.MakeArgString(Twine(PluginOptPrefix) + "-emulated-tls"));
1364 }
1365 if (isTLSDESCEnabled(ToolChain, Args))
1366 CmdArgs.push_back(
1367 Args.MakeArgString(Twine(PluginOptPrefix) + "-enable-tlsdesc"));
1368
1369 if (Args.hasFlag(options::OPT_fstack_size_section,
1370 options::OPT_fno_stack_size_section, false))
1371 CmdArgs.push_back(
1372 Args.MakeArgString(Twine(PluginOptPrefix) + "-stack-size-section"));
1373
1374 if (Args.hasFlag(options::OPT_fexperimental_call_graph_section,
1375 options::OPT_fno_experimental_call_graph_section, false))
1376 CmdArgs.push_back(
1377 Args.MakeArgString(Twine(PluginOptPrefix) + "-call-graph-section"));
1378
1379 // Setup statistics file output.
1380 SmallString<128> StatsFile = getStatsFileName(Args, Output, *Input, D);
1381 if (!StatsFile.empty())
1382 CmdArgs.push_back(
1383 Args.MakeArgString(Twine(PluginOptPrefix) + "stats-file=" + StatsFile));
1384
1385 // Setup crash diagnostics dir.
1386 if (Arg *A = Args.getLastArg(options::OPT_fcrash_diagnostics_dir))
1387 CmdArgs.push_back(Args.MakeArgString(
1388 Twine(PluginOptPrefix) + "-crash-diagnostics-dir=" + A->getValue()));
1389
1390 addX86AlignBranchArgs(D, Args, CmdArgs, /*IsLTO=*/true, PluginOptPrefix);
1391
1392 // Handle remark diagnostics on screen options: '-Rpass-*'.
1393 renderRpassOptions(Args, CmdArgs, PluginOptPrefix);
1394
1395 // Handle serialized remarks options: '-fsave-optimization-record'
1396 // and '-foptimization-record-*'.
1397 if (willEmitRemarks(Args))
1398 renderRemarksOptions(Args, CmdArgs, ToolChain.getEffectiveTriple(), *Input,
1399 Output, PluginOptPrefix);
1400
1401 // Handle remarks hotness/threshold related options.
1402 renderRemarksHotnessOptions(Args, CmdArgs, PluginOptPrefix);
1403
1405 /*IsLTO=*/true, PluginOptPrefix);
1406
1407 bool IsELF = Triple.isOSBinFormatELF();
1408 bool Crel = false;
1409 bool ImplicitMapSyms = false;
1410 for (const Arg *A : Args.filtered(options::OPT_Wa_COMMA)) {
1411 for (StringRef V : A->getValues()) {
1412 auto Equal = V.split('=');
1413 auto checkArg = [&](bool ValidTarget,
1414 std::initializer_list<const char *> Set) {
1415 if (!ValidTarget) {
1416 D.Diag(diag::err_drv_unsupported_opt_for_target)
1417 << (Twine("-Wa,") + Equal.first + "=").str()
1418 << Triple.getTriple();
1419 } else if (!llvm::is_contained(Set, Equal.second)) {
1420 D.Diag(diag::err_drv_unsupported_option_argument)
1421 << (Twine("-Wa,") + Equal.first + "=").str() << Equal.second;
1422 }
1423 };
1424 if (Equal.first == "-mmapsyms") {
1425 ImplicitMapSyms = Equal.second == "implicit";
1426 checkArg(IsELF && Triple.isAArch64(), {"default", "implicit"});
1427 } else if (V == "--crel")
1428 Crel = true;
1429 else if (V == "--no-crel")
1430 Crel = false;
1431 else
1432 continue;
1433 A->claim();
1434 }
1435 }
1436 if (Crel) {
1437 if (IsELF && !Triple.isMIPS()) {
1438 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + "-crel"));
1439 } else {
1440 D.Diag(diag::err_drv_unsupported_opt_for_target)
1441 << "-Wa,--crel" << D.getTargetTriple();
1442 }
1443 }
1444 if (ImplicitMapSyms)
1445 CmdArgs.push_back(
1446 Args.MakeArgString(Twine(PluginOptPrefix) + "-implicit-mapsyms"));
1447
1448 if (Args.hasArg(options::OPT_ftime_report))
1449 CmdArgs.push_back(
1450 Args.MakeArgString(Twine(PluginOptPrefix) + "-time-passes"));
1451
1452 addDTLTOOptions(ToolChain, Args, CmdArgs);
1453}
1454
1456 const ArgList &Args,
1457 ArgStringList &CmdArgs) {
1458 // Default to clang lib / lib64 folder, i.e. the same location as device
1459 // runtime.
1460 SmallString<256> DefaultLibPath =
1461 llvm::sys::path::parent_path(TC.getDriver().Dir);
1462 llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
1463 CmdArgs.push_back(Args.MakeArgString("-L" + DefaultLibPath));
1464}
1465
1466void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
1467 ArgStringList &CmdArgs) {
1468 if (!Args.hasFlag(options::OPT_frtlib_add_rpath,
1469 options::OPT_fno_rtlib_add_rpath, false))
1470 return;
1471
1472 if (TC.getTriple().isOSAIX()) // TODO: AIX doesn't support -rpath option.
1473 return;
1474
1476 if (const auto StdlibPath = TC.getStdlibPath()) {
1477 for (const Multilib &M : llvm::reverse(TC.getSelectedMultilibs())) {
1478 if (M.isDefault())
1479 continue;
1480 SmallString<128> P(*StdlibPath);
1481 llvm::sys::path::append(P, M.gccSuffix());
1482 CandidateRPaths.emplace_back(std::string(P));
1483 }
1484 CandidateRPaths.emplace_back(*StdlibPath);
1485 }
1486 for (const auto &CandidateRPath : CandidateRPaths) {
1487 if (TC.getVFS().exists(CandidateRPath)) {
1488 CmdArgs.push_back("-rpath");
1489 CmdArgs.push_back(Args.MakeArgString(CandidateRPath));
1490 }
1491 }
1492}
1493
1495 ArgStringList &CmdArgs,
1496 const ToolChain &TC, const ArgList &Args) {
1497
1498 if (!Args.hasFlag(options::OPT_foffload_via_llvm,
1499 options::OPT_fno_offload_via_llvm, false))
1500 return false;
1501
1502 CmdArgs.push_back("-lLLVMOffloadKernel");
1503 return true;
1504}
1505
1506bool tools::addOpenMPRuntime(const Compilation &C, ArgStringList &CmdArgs,
1507 const ToolChain &TC, const ArgList &Args,
1508 bool ForceStaticHostRuntime, bool IsOffloadingHost,
1509 bool GompNeedsRT) {
1510 if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
1511 options::OPT_fno_openmp, false))
1512 return false;
1513
1515
1516 if (RTKind == Driver::OMPRT_Unknown)
1517 // Already diagnosed.
1518 return false;
1519
1520 if (ForceStaticHostRuntime)
1521 CmdArgs.push_back("-Bstatic");
1522
1523 switch (RTKind) {
1524 case Driver::OMPRT_OMP:
1525 CmdArgs.push_back("-lomp");
1526 break;
1527 case Driver::OMPRT_GOMP:
1528 CmdArgs.push_back("-lgomp");
1529 break;
1531 CmdArgs.push_back("-liomp5");
1532 break;
1534 break;
1535 }
1536
1537 if (ForceStaticHostRuntime)
1538 CmdArgs.push_back("-Bdynamic");
1539
1540 if (RTKind == Driver::OMPRT_GOMP && GompNeedsRT)
1541 CmdArgs.push_back("-lrt");
1542
1543 if (IsOffloadingHost)
1544 CmdArgs.push_back("-lomptarget");
1545
1546 addArchSpecificRPath(TC, Args, CmdArgs);
1547
1548 addOpenMPRuntimeLibraryPath(TC, Args, CmdArgs);
1549
1550 return true;
1551}
1552
1554 const JobAction &JA,
1555 const llvm::opt::ArgList &Args,
1556 llvm::opt::ArgStringList &CmdArgs) {
1558 return;
1559
1560 // For all the host OpenMP offloading compile jobs we need to pass the targets
1561 // information using -fopenmp-targets= option.
1562 constexpr llvm::StringLiteral Targets("--offload-targets=");
1563
1564 SmallVector<StringRef> Triples;
1565 auto TCRange = C.getOffloadToolChains<Action::OFK_OpenMP>();
1566 std::transform(TCRange.first, TCRange.second, std::back_inserter(Triples),
1567 [](auto TC) { return TC.second->getTripleString(); });
1568 CmdArgs.push_back(
1569 Args.MakeArgString(Twine(Targets) + llvm::join(Triples, ",")));
1570}
1571
1572static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
1573 ArgStringList &CmdArgs, StringRef Sanitizer,
1574 bool IsShared, bool IsWhole) {
1575 // Wrap any static runtimes that must be forced into executable in
1576 // whole-archive.
1577 if (IsWhole) CmdArgs.push_back("--whole-archive");
1578 CmdArgs.push_back(TC.getCompilerRTArgString(
1579 Args, Sanitizer, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static));
1580 if (IsWhole) CmdArgs.push_back("--no-whole-archive");
1581
1582 if (IsShared) {
1583 addArchSpecificRPath(TC, Args, CmdArgs);
1584 }
1585}
1586
1587// Tries to use a file with the list of dynamic symbols that need to be exported
1588// from the runtime library. Returns true if the file was found.
1589static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
1590 ArgStringList &CmdArgs,
1591 StringRef Sanitizer) {
1592 bool LinkerIsGnuLd = solaris::isLinkerGnuLd(TC, Args);
1593
1594 // Solaris ld defaults to --export-dynamic behaviour but doesn't support
1595 // the option, so don't try to pass it.
1596 if (TC.getTriple().isOSSolaris() && !LinkerIsGnuLd)
1597 return true;
1598 SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
1599 if (llvm::sys::fs::exists(SanRT + ".syms")) {
1600 CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
1601 return true;
1602 }
1603 return false;
1604}
1605
1607 const llvm::opt::ArgList &Args,
1608 llvm::opt::ArgStringList &CmdArgs,
1609 bool as_needed) {
1610 assert(!TC.getTriple().isOSAIX() &&
1611 "AIX linker does not support any form of --as-needed option yet.");
1612 bool LinkerIsGnuLd = solaris::isLinkerGnuLd(TC, Args);
1613
1614 // While the Solaris 11.2 ld added --as-needed/--no-as-needed as aliases
1615 // for the native forms -z ignore/-z record, they are missing in Illumos,
1616 // so always use the native form.
1617 // GNU ld doesn't support -z ignore/-z record, so don't use them even on
1618 // Solaris.
1619 if (TC.getTriple().isOSSolaris() && !LinkerIsGnuLd) {
1620 CmdArgs.push_back("-z");
1621 CmdArgs.push_back(as_needed ? "ignore" : "record");
1622 } else {
1623 CmdArgs.push_back(as_needed ? "--as-needed" : "--no-as-needed");
1624 }
1625}
1626
1628 const llvm::opt::ArgList &Args,
1629 ArgStringList &CmdArgs) {
1630 // Force linking against the system libraries sanitizers depends on
1631 // (see PR15823 why this is necessary).
1632 addAsNeededOption(TC, Args, CmdArgs, false);
1633 // There's no libpthread or librt on RTEMS & Android.
1634 if (TC.getTriple().getOS() != llvm::Triple::RTEMS &&
1635 !TC.getTriple().isAndroid() && !TC.getTriple().isOHOSFamily()) {
1636 CmdArgs.push_back("-lpthread");
1637 if (!TC.getTriple().isOSOpenBSD() && !TC.getTriple().isOSHaiku())
1638 CmdArgs.push_back("-lrt");
1639 }
1640 CmdArgs.push_back("-lm");
1641 // There's no libdl on all OSes.
1642 if (!TC.getTriple().isOSFreeBSD() && !TC.getTriple().isOSNetBSD() &&
1643 !TC.getTriple().isOSOpenBSD() && !TC.getTriple().isOSDragonFly() &&
1644 !TC.getTriple().isOSHaiku() &&
1645 TC.getTriple().getOS() != llvm::Triple::RTEMS)
1646 CmdArgs.push_back("-ldl");
1647 // Required for backtrace on some OSes
1648 if (TC.getTriple().isOSFreeBSD() || TC.getTriple().isOSNetBSD() ||
1649 TC.getTriple().isOSOpenBSD() || TC.getTriple().isOSDragonFly())
1650 CmdArgs.push_back("-lexecinfo");
1651 if (TC.getTriple().isOSHaiku())
1652 CmdArgs.push_back("-lbsd");
1653 // There is no libresolv on Android, FreeBSD, OpenBSD, etc. On musl
1654 // libresolv.a, even if exists, is an empty archive to satisfy POSIX -lresolv
1655 // requirement.
1656 if (TC.getTriple().isOSLinux() && !TC.getTriple().isAndroid() &&
1657 !TC.getTriple().isMusl())
1658 CmdArgs.push_back("-lresolv");
1659}
1660
1661static void
1662collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
1663 SmallVectorImpl<StringRef> &SharedRuntimes,
1664 SmallVectorImpl<StringRef> &StaticRuntimes,
1665 SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
1666 SmallVectorImpl<StringRef> &HelperStaticRuntimes,
1667 SmallVectorImpl<StringRef> &RequiredSymbols) {
1668 assert(!TC.getTriple().isOSDarwin() && "it's not used by Darwin");
1669 const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
1670 // Collect shared runtimes.
1671 if (SanArgs.needsSharedRt()) {
1672 if (SanArgs.needsAsanRt()) {
1673 SharedRuntimes.push_back("asan");
1674 if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
1675 HelperStaticRuntimes.push_back("asan-preinit");
1676 }
1677 if (SanArgs.needsMemProfRt()) {
1678 SharedRuntimes.push_back("memprof");
1679 if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
1680 HelperStaticRuntimes.push_back("memprof-preinit");
1681 }
1682 if (SanArgs.needsNsanRt())
1683 SharedRuntimes.push_back("nsan");
1684 if (SanArgs.needsUbsanRt()) {
1685 if (SanArgs.requiresMinimalRuntime())
1686 SharedRuntimes.push_back("ubsan_minimal");
1687 else
1688 SharedRuntimes.push_back("ubsan_standalone");
1689 }
1690 if (SanArgs.needsScudoRt()) {
1691 SharedRuntimes.push_back("scudo_standalone");
1692 }
1693 if (SanArgs.needsTsanRt())
1694 SharedRuntimes.push_back("tsan");
1695 if (SanArgs.needsTysanRt())
1696 SharedRuntimes.push_back("tysan");
1697 if (SanArgs.needsHwasanRt()) {
1698 if (SanArgs.needsHwasanAliasesRt())
1699 SharedRuntimes.push_back("hwasan_aliases");
1700 else
1701 SharedRuntimes.push_back("hwasan");
1702 if (!Args.hasArg(options::OPT_shared))
1703 HelperStaticRuntimes.push_back("hwasan-preinit");
1704 }
1705 if (SanArgs.needsRtsanRt() && SanArgs.linkRuntimes())
1706 SharedRuntimes.push_back("rtsan");
1707 }
1708
1709 // The stats_client library is also statically linked into DSOs.
1710 if (SanArgs.needsStatsRt())
1711 StaticRuntimes.push_back("stats_client");
1712
1713 // Always link the static runtime regardless of DSO or executable.
1714 if (SanArgs.needsAsanRt())
1715 HelperStaticRuntimes.push_back("asan_static");
1716
1717 // Collect static runtimes.
1718 if (Args.hasArg(options::OPT_shared)) {
1719 // Don't link static runtimes into DSOs.
1720 return;
1721 }
1722
1723 // Each static runtime that has a DSO counterpart above is excluded below,
1724 // but runtimes that exist only as static are not affected by needsSharedRt.
1725
1726 if (!SanArgs.needsSharedRt() && SanArgs.needsAsanRt()) {
1727 StaticRuntimes.push_back("asan");
1728 if (SanArgs.linkCXXRuntimes())
1729 StaticRuntimes.push_back("asan_cxx");
1730 }
1731
1732 if (!SanArgs.needsSharedRt() && SanArgs.needsRtsanRt() &&
1733 SanArgs.linkRuntimes())
1734 StaticRuntimes.push_back("rtsan");
1735
1736 if (!SanArgs.needsSharedRt() && SanArgs.needsMemProfRt()) {
1737 StaticRuntimes.push_back("memprof");
1738 if (SanArgs.linkCXXRuntimes())
1739 StaticRuntimes.push_back("memprof_cxx");
1740 }
1741
1742 if (!SanArgs.needsSharedRt() && SanArgs.needsHwasanRt()) {
1743 if (SanArgs.needsHwasanAliasesRt()) {
1744 StaticRuntimes.push_back("hwasan_aliases");
1745 if (SanArgs.linkCXXRuntimes())
1746 StaticRuntimes.push_back("hwasan_aliases_cxx");
1747 } else {
1748 StaticRuntimes.push_back("hwasan");
1749 if (SanArgs.linkCXXRuntimes())
1750 StaticRuntimes.push_back("hwasan_cxx");
1751 }
1752 }
1753 if (SanArgs.needsDfsanRt())
1754 StaticRuntimes.push_back("dfsan");
1755 if (SanArgs.needsLsanRt())
1756 StaticRuntimes.push_back("lsan");
1757 if (SanArgs.needsMsanRt()) {
1758 StaticRuntimes.push_back("msan");
1759 if (SanArgs.linkCXXRuntimes())
1760 StaticRuntimes.push_back("msan_cxx");
1761 }
1762 if (!SanArgs.needsSharedRt() && SanArgs.needsNsanRt())
1763 StaticRuntimes.push_back("nsan");
1764 if (!SanArgs.needsSharedRt() && SanArgs.needsTsanRt()) {
1765 StaticRuntimes.push_back("tsan");
1766 if (SanArgs.linkCXXRuntimes())
1767 StaticRuntimes.push_back("tsan_cxx");
1768 }
1769 if (!SanArgs.needsSharedRt() && SanArgs.needsTysanRt())
1770 StaticRuntimes.push_back("tysan");
1771 if (!SanArgs.needsSharedRt() && SanArgs.needsUbsanRt()) {
1772 if (SanArgs.requiresMinimalRuntime()) {
1773 StaticRuntimes.push_back("ubsan_minimal");
1774 } else {
1775 StaticRuntimes.push_back("ubsan_standalone");
1776 }
1777 }
1778 if (SanArgs.needsSafeStackRt()) {
1779 NonWholeStaticRuntimes.push_back("safestack");
1780 RequiredSymbols.push_back("__safestack_init");
1781 }
1782 if (!(SanArgs.needsSharedRt() && SanArgs.needsUbsanRt())) {
1783 if (SanArgs.needsCfiCrossDsoRt())
1784 StaticRuntimes.push_back("cfi");
1785 if (SanArgs.needsCfiCrossDsoDiagRt())
1786 StaticRuntimes.push_back("cfi_diag");
1787 }
1788 if (SanArgs.linkCXXRuntimes() && !SanArgs.requiresMinimalRuntime() &&
1789 ((!SanArgs.needsSharedRt() && SanArgs.needsUbsanCXXRt()) ||
1790 SanArgs.needsCfiCrossDsoDiagRt())) {
1791 StaticRuntimes.push_back("ubsan_standalone_cxx");
1792 }
1793 if (SanArgs.needsStatsRt()) {
1794 NonWholeStaticRuntimes.push_back("stats");
1795 RequiredSymbols.push_back("__sanitizer_stats_register");
1796 }
1797 if (!SanArgs.needsSharedRt() && SanArgs.needsScudoRt()) {
1798 StaticRuntimes.push_back("scudo_standalone");
1799 if (SanArgs.linkCXXRuntimes())
1800 StaticRuntimes.push_back("scudo_standalone_cxx");
1801 }
1802 if (SanArgs.needsUbsanLoopDetectRt())
1803 NonWholeStaticRuntimes.push_back("ubsan_loop_detect");
1804}
1805
1806// Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
1807// C runtime, etc). Returns true if sanitizer system deps need to be linked in.
1808bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
1809 ArgStringList &CmdArgs) {
1810 const SanitizerArgs &SanArgs = TC.getSanitizerArgs(Args);
1811 SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
1812 NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
1813 if (SanArgs.linkRuntimes()) {
1814 collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
1815 NonWholeStaticRuntimes, HelperStaticRuntimes,
1816 RequiredSymbols);
1817 }
1818
1819 // -u options must be added before the runtime libs that resolve them.
1820 for (auto S : RequiredSymbols) {
1821 CmdArgs.push_back("-u");
1822 CmdArgs.push_back(Args.MakeArgString(S));
1823 }
1824
1825 // Add shared runtimes before adding fuzzer and its dependencies.
1826 for (auto RT : SharedRuntimes)
1827 addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
1828
1829 // Inject libfuzzer dependencies.
1830 bool FuzzerNeedsSanitizerDeps = false;
1831 if (SanArgs.needsFuzzer() && SanArgs.linkRuntimes() &&
1832 !Args.hasArg(options::OPT_shared)) {
1833
1834 addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
1835 FuzzerNeedsSanitizerDeps = true;
1836 if (SanArgs.needsFuzzerInterceptors())
1837 addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer_interceptors", false,
1838 true);
1839 if (!Args.hasArg(options::OPT_nostdlibxx)) {
1840 bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
1841 !Args.hasArg(options::OPT_static);
1842 if (OnlyLibstdcxxStatic)
1843 CmdArgs.push_back("-Bstatic");
1844 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
1845 if (OnlyLibstdcxxStatic)
1846 CmdArgs.push_back("-Bdynamic");
1847 }
1848 }
1849
1850 for (auto RT : HelperStaticRuntimes)
1851 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
1852 bool AddExportDynamic = false;
1853 for (auto RT : StaticRuntimes) {
1854 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
1855 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
1856 }
1857 for (auto RT : NonWholeStaticRuntimes) {
1858 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
1859 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
1860 }
1861 // If there is a static runtime with no dynamic list, force all the symbols
1862 // to be dynamic to be sure we export sanitizer interface functions.
1863 if (AddExportDynamic && !TC.getTriple().isNVPTX())
1864 CmdArgs.push_back("--export-dynamic");
1865
1866 if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
1867 CmdArgs.push_back("--export-dynamic-symbol=__cfi_check");
1868
1869 if (SanArgs.hasMemTag()) {
1870 CmdArgs.push_back("-z");
1871 CmdArgs.push_back(
1872 Args.MakeArgString("memtag-mode=" + SanArgs.getMemtagMode()));
1873
1874 if (SanArgs.hasMemtagHeap()) {
1875 CmdArgs.push_back("-z");
1876 CmdArgs.push_back("memtag-heap");
1877 }
1878
1879 if (SanArgs.hasMemtagStack()) {
1880 CmdArgs.push_back("-z");
1881 CmdArgs.push_back("memtag-stack");
1882 }
1883
1884 if (TC.getTriple().isAndroid())
1885 CmdArgs.push_back("--android-memtag-note");
1886 }
1887
1888 return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty() ||
1889 FuzzerNeedsSanitizerDeps;
1890}
1891
1892bool tools::addXRayRuntime(const ToolChain&TC, const ArgList &Args, ArgStringList &CmdArgs) {
1893 const XRayArgs &XRay = TC.getXRayArgs(Args);
1894 if (Args.hasArg(options::OPT_shared)) {
1895 if (XRay.needsXRayDSORt()) {
1896 CmdArgs.push_back("--whole-archive");
1897 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray-dso"));
1898 CmdArgs.push_back("--no-whole-archive");
1899 return true;
1900 }
1901 } else if (XRay.needsXRayRt()) {
1902 CmdArgs.push_back("--whole-archive");
1903 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "xray"));
1904 for (const auto &Mode : XRay.modeList())
1905 CmdArgs.push_back(TC.getCompilerRTArgString(Args, Mode));
1906 CmdArgs.push_back("--no-whole-archive");
1907 return true;
1908 }
1909
1910 return false;
1911}
1912
1914 const llvm::opt::ArgList &Args,
1915 ArgStringList &CmdArgs) {
1916 addAsNeededOption(TC, Args, CmdArgs, false);
1917 CmdArgs.push_back("-lpthread");
1918 if (!TC.getTriple().isOSOpenBSD())
1919 CmdArgs.push_back("-lrt");
1920 CmdArgs.push_back("-lm");
1921
1922 if (!TC.getTriple().isOSFreeBSD() &&
1923 !TC.getTriple().isOSNetBSD() &&
1924 !TC.getTriple().isOSOpenBSD())
1925 CmdArgs.push_back("-ldl");
1926}
1927
1928bool tools::areOptimizationsEnabled(const ArgList &Args) {
1929 // Find the last -O arg and see if it is non-zero.
1930 if (Arg *A = Args.getLastArg(options::OPT_O_Group))
1931 return !A->getOption().matches(options::OPT_O0);
1932 // Defaults to -O0.
1933 return false;
1934}
1935
1936const char *tools::SplitDebugName(const JobAction &JA, const ArgList &Args,
1937 const InputInfo &Input,
1938 const InputInfo &Output) {
1939 auto AddPostfix = [JA](auto &F) {
1941 F += (Twine("_") + JA.getOffloadingArch().ArchName).str();
1942 F += ".dwo";
1943 };
1944 if (Arg *A = Args.getLastArg(options::OPT_gsplit_dwarf_EQ))
1945 if (StringRef(A->getValue()) == "single" && Output.isFilename())
1946 return Args.MakeArgString(Output.getFilename());
1947
1949 if (const Arg *A = Args.getLastArg(options::OPT_dumpdir)) {
1950 T = A->getValue();
1951 } else {
1952 if (Args.hasArg(options::OPT_o, options::OPT__SLASH_o,
1953 options::OPT__SLASH_Fo) &&
1954 Args.hasArg(options::OPT_c) && Output.isFilename()) {
1955 // The driver has resolved /Fo<dir>/ into a concrete obj path in Output.
1956 StringRef Obj = Output.getFilename();
1957 T = Obj;
1958 llvm::sys::path::remove_filename(T);
1959 llvm::sys::path::append(T, llvm::sys::path::stem(Obj));
1960 AddPostfix(T);
1961 return Args.MakeArgString(T);
1962 }
1963 }
1964
1965 T += llvm::sys::path::stem(Input.getBaseInput());
1966 AddPostfix(T);
1967 return Args.MakeArgString(T);
1968}
1969
1970void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
1971 const JobAction &JA, const ArgList &Args,
1972 const InputInfo &Output, const char *OutFile) {
1973 ArgStringList ExtractArgs;
1974 ExtractArgs.push_back("--extract-dwo");
1975
1976 ArgStringList StripArgs;
1977 StripArgs.push_back("--strip-dwo");
1978
1979 // Grabbing the output of the earlier compile step.
1980 StripArgs.push_back(Output.getFilename());
1981 ExtractArgs.push_back(Output.getFilename());
1982 ExtractArgs.push_back(OutFile);
1983
1984 const char *Exec =
1985 Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
1986 InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
1987
1988 // First extract the dwo sections.
1989 C.addCommand(std::make_unique<Command>(JA, T,
1991 Exec, ExtractArgs, II, Output));
1992
1993 // Then remove them from the original .o file.
1994 C.addCommand(std::make_unique<Command>(
1995 JA, T, ResponseFileSupport::AtFileCurCP(), Exec, StripArgs, II, Output));
1996}
1997
1998// Claim options we don't want to warn if they are unused. We do this for
1999// options that build systems might add but are unused when assembling or only
2000// running the preprocessor for example.
2001void tools::claimNoWarnArgs(const ArgList &Args) {
2002 // Don't warn about unused -f(no-)?lto. This can happen when we're
2003 // preprocessing, precompiling or assembling.
2004 Args.ClaimAllArgs(options::OPT_flto_EQ);
2005 Args.ClaimAllArgs(options::OPT_flto);
2006 Args.ClaimAllArgs(options::OPT_fno_lto);
2007}
2008
2009Arg *tools::getLastCSProfileGenerateArg(const ArgList &Args) {
2010 auto *CSPGOGenerateArg = Args.getLastArg(options::OPT_fcs_profile_generate,
2011 options::OPT_fcs_profile_generate_EQ,
2012 options::OPT_fno_profile_generate);
2013 if (CSPGOGenerateArg &&
2014 CSPGOGenerateArg->getOption().matches(options::OPT_fno_profile_generate))
2015 CSPGOGenerateArg = nullptr;
2016
2017 return CSPGOGenerateArg;
2018}
2019
2020Arg *tools::getLastProfileUseArg(const ArgList &Args) {
2021 auto *ProfileUseArg = Args.getLastArg(
2022 options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
2023 options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
2024 options::OPT_fno_profile_instr_use);
2025
2026 if (ProfileUseArg &&
2027 ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
2028 ProfileUseArg = nullptr;
2029
2030 return ProfileUseArg;
2031}
2032
2033Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
2034 auto *ProfileSampleUseArg = Args.getLastArg(
2035 options::OPT_fprofile_sample_use_EQ, options::OPT_fno_profile_sample_use);
2036
2037 if (ProfileSampleUseArg && (ProfileSampleUseArg->getOption().matches(
2038 options::OPT_fno_profile_sample_use)))
2039 return nullptr;
2040
2041 return Args.getLastArg(options::OPT_fprofile_sample_use_EQ);
2042}
2043
2044const char *tools::RelocationModelName(llvm::Reloc::Model Model) {
2045 switch (Model) {
2046 case llvm::Reloc::Static:
2047 return "static";
2048 case llvm::Reloc::PIC_:
2049 return "pic";
2050 case llvm::Reloc::DynamicNoPIC:
2051 return "dynamic-no-pic";
2052 case llvm::Reloc::ROPI:
2053 return "ropi";
2054 case llvm::Reloc::RWPI:
2055 return "rwpi";
2056 case llvm::Reloc::ROPI_RWPI:
2057 return "ropi-rwpi";
2058 }
2059 llvm_unreachable("Unknown Reloc::Model kind");
2060}
2061
2062/// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments. Then,
2063/// smooshes them together with platform defaults, to decide whether
2064/// this compile should be using PIC mode or not. Returns a tuple of
2065/// (RelocationModel, PICLevel, IsPIE).
2066std::tuple<llvm::Reloc::Model, unsigned, bool>
2067tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
2068 const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
2069 const llvm::Triple &Triple = ToolChain.getTriple();
2070
2071 bool PIE = ToolChain.isPIEDefault(Args);
2072 bool PIC = PIE || ToolChain.isPICDefault();
2073 // The Darwin/MachO default to use PIC does not apply when using -static.
2074 if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
2075 PIE = PIC = false;
2076 bool IsPICLevelTwo = PIC;
2077
2078 bool KernelOrKext =
2079 Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
2080
2081 // Android-specific defaults for PIC/PIE
2082 if (Triple.isAndroid()) {
2083 switch (Triple.getArch()) {
2084 case llvm::Triple::x86:
2085 case llvm::Triple::x86_64:
2086 PIC = true; // "-fPIC"
2087 IsPICLevelTwo = true;
2088 break;
2089
2090 default:
2091 PIC = true; // "-fpic"
2092 break;
2093 }
2094 }
2095
2096 // OHOS-specific defaults for PIC/PIE
2097 if (Triple.isOHOSFamily() && Triple.getArch() == llvm::Triple::aarch64)
2098 PIC = true;
2099
2100 // OpenBSD-specific defaults for PIE
2101 if (Triple.isOSOpenBSD()) {
2102 switch (ToolChain.getArch()) {
2103 case llvm::Triple::arm:
2104 case llvm::Triple::aarch64:
2105 case llvm::Triple::mips64:
2106 case llvm::Triple::mips64el:
2107 case llvm::Triple::x86:
2108 case llvm::Triple::x86_64:
2109 IsPICLevelTwo = false; // "-fpie"
2110 break;
2111
2112 case llvm::Triple::ppc:
2113 case llvm::Triple::sparcv9:
2114 IsPICLevelTwo = true; // "-fPIE"
2115 break;
2116
2117 default:
2118 break;
2119 }
2120 }
2121
2122 // The last argument relating to either PIC or PIE wins, and no
2123 // other argument is used. If the last argument is any flavor of the
2124 // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
2125 // option implicitly enables PIC at the same level.
2126 Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
2127 options::OPT_fpic, options::OPT_fno_pic,
2128 options::OPT_fPIE, options::OPT_fno_PIE,
2129 options::OPT_fpie, options::OPT_fno_pie);
2130 if (Triple.isOSWindows() && !Triple.isOSCygMing() && LastPICArg &&
2131 LastPICArg == Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
2132 options::OPT_fPIE, options::OPT_fpie)) {
2133 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
2134 << LastPICArg->getSpelling() << Triple.str();
2135 if (Triple.getArch() == llvm::Triple::x86_64)
2136 return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
2137 return std::make_tuple(llvm::Reloc::Static, 0U, false);
2138 }
2139
2140 // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
2141 // is forced, then neither PIC nor PIE flags will have no effect.
2143 if (LastPICArg) {
2144 Option O = LastPICArg->getOption();
2145 if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
2146 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
2147 PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
2148 PIC =
2149 PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
2150 IsPICLevelTwo =
2151 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
2152 } else {
2153 PIE = PIC = false;
2154 if (EffectiveTriple.isPS()) {
2155 Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
2156 StringRef Model = ModelArg ? ModelArg->getValue() : "";
2157 if (Model != "kernel") {
2158 PIC = true;
2159 ToolChain.getDriver().Diag(diag::warn_drv_ps_force_pic)
2160 << LastPICArg->getSpelling()
2161 << (EffectiveTriple.isPS4() ? "PS4" : "PS5");
2162 }
2163 }
2164 }
2165 }
2166 }
2167
2168 // Introduce a Darwin and PS4/PS5-specific hack. If the default is PIC, but
2169 // the PIC level would've been set to level 1, force it back to level 2 PIC
2170 // instead.
2171 if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS()))
2172 IsPICLevelTwo |= ToolChain.isPICDefault();
2173
2174 // This kernel flags are a trump-card: they will disable PIC/PIE
2175 // generation, independent of the argument order.
2176 if (KernelOrKext &&
2177 ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
2178 !EffectiveTriple.isWatchOS() && !EffectiveTriple.isDriverKit()))
2179 PIC = PIE = false;
2180
2181 if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
2182 // This is a very special mode. It trumps the other modes, almost no one
2183 // uses it, and it isn't even valid on any OS but Darwin.
2184 if (!Triple.isOSDarwin())
2185 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
2186 << A->getSpelling() << Triple.str();
2187
2188 // FIXME: Warn when this flag trumps some other PIC or PIE flag.
2189
2190 // Only a forced PIC mode can cause the actual compile to have PIC defines
2191 // etc., no flags are sufficient. This behavior was selected to closely
2192 // match that of llvm-gcc and Apple GCC before that.
2194
2195 return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
2196 }
2197
2198 bool EmbeddedPISupported;
2199 switch (Triple.getArch()) {
2200 case llvm::Triple::arm:
2201 case llvm::Triple::armeb:
2202 case llvm::Triple::thumb:
2203 case llvm::Triple::thumbeb:
2204 EmbeddedPISupported = true;
2205 break;
2206 default:
2207 EmbeddedPISupported = false;
2208 break;
2209 }
2210
2211 bool ROPI = false, RWPI = false;
2212 Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
2213 if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
2214 if (!EmbeddedPISupported)
2215 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
2216 << LastROPIArg->getSpelling() << Triple.str();
2217 ROPI = true;
2218 }
2219 Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
2220 if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
2221 if (!EmbeddedPISupported)
2222 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
2223 << LastRWPIArg->getSpelling() << Triple.str();
2224 RWPI = true;
2225 }
2226
2227 // ROPI and RWPI are not compatible with PIC or PIE.
2228 if ((ROPI || RWPI) && (PIC || PIE))
2229 ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
2230
2231 if (Triple.isMIPS()) {
2232 StringRef CPUName;
2233 StringRef ABIName;
2234 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName);
2235 // When targeting the N64 ABI, PIC is the default, except in the case
2236 // when the -mno-abicalls option is used. In that case we exit
2237 // at next check regardless of PIC being set below.
2238 if (ABIName == "n64")
2239 PIC = true;
2240 // When targettng MIPS with -mno-abicalls, it's always static.
2241 if(Args.hasArg(options::OPT_mno_abicalls))
2242 return std::make_tuple(llvm::Reloc::Static, 0U, false);
2243 // Unlike other architectures, MIPS, even with -fPIC/-mxgot/multigot,
2244 // does not use PIC level 2 for historical reasons.
2245 IsPICLevelTwo = false;
2246 }
2247
2248 if (PIC)
2249 return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
2250
2251 llvm::Reloc::Model RelocM = llvm::Reloc::Static;
2252 if (ROPI && RWPI)
2253 RelocM = llvm::Reloc::ROPI_RWPI;
2254 else if (ROPI)
2255 RelocM = llvm::Reloc::ROPI;
2256 else if (RWPI)
2257 RelocM = llvm::Reloc::RWPI;
2258
2259 return std::make_tuple(RelocM, 0U, false);
2260}
2261
2262bool tools::getStaticPIE(const ArgList &Args, const ToolChain &TC) {
2263 bool HasStaticPIE = Args.hasArg(options::OPT_static_pie);
2264 if (HasStaticPIE && Args.hasArg(options::OPT_no_pie)) {
2265 const Driver &D = TC.getDriver();
2266 const llvm::opt::OptTable &Opts = D.getOpts();
2267 StringRef StaticPIEName = Opts.getOptionName(options::OPT_static_pie);
2268 StringRef NoPIEName = Opts.getOptionName(options::OPT_nopie);
2269 D.Diag(diag::err_drv_cannot_mix_options) << StaticPIEName << NoPIEName;
2270 }
2271 return HasStaticPIE;
2272}
2273
2274// `-falign-functions` indicates that the functions should be aligned to the
2275// backend's preferred alignment.
2276//
2277// `-falign-functions=1` is the same as `-fno-align-functions`.
2278//
2279// The scalar `n` in `-falign-functions=n` must be an integral value between
2280// [0, 65536]. If the value is not a power-of-two, it will be rounded up to
2281// the nearest power-of-two.
2282//
2283// If we return `0`, the frontend will default to the backend's preferred
2284// alignment.
2285//
2286// NOTE: icc only allows values between [0, 4096]. icc uses `-falign-functions`
2287// to mean `-falign-functions=16`. GCC defaults to the backend's preferred
2288// alignment. For unaligned functions, we default to the backend's preferred
2289// alignment.
2290unsigned tools::ParseFunctionAlignment(const ToolChain &TC,
2291 const ArgList &Args) {
2292 const Arg *A = Args.getLastArg(options::OPT_falign_functions,
2293 options::OPT_falign_functions_EQ,
2294 options::OPT_fno_align_functions);
2295 if (!A || A->getOption().matches(options::OPT_fno_align_functions))
2296 return 0;
2297
2298 if (A->getOption().matches(options::OPT_falign_functions))
2299 return 0;
2300
2301 unsigned Value = 0;
2302 if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 65536)
2303 TC.getDriver().Diag(diag::err_drv_invalid_int_value)
2304 << A->getAsString(Args) << A->getValue();
2305 return Value ? llvm::Log2_32_Ceil(std::min(Value, 65536u)) : Value;
2306}
2307
2309 ArgStringList &CmdArgs, llvm::codegenoptions::DebugInfoKind DebugInfoKind) {
2310 switch (DebugInfoKind) {
2311 case llvm::codegenoptions::DebugDirectivesOnly:
2312 CmdArgs.push_back("-debug-info-kind=line-directives-only");
2313 break;
2314 case llvm::codegenoptions::DebugLineTablesOnly:
2315 CmdArgs.push_back("-debug-info-kind=line-tables-only");
2316 break;
2317 case llvm::codegenoptions::DebugInfoConstructor:
2318 CmdArgs.push_back("-debug-info-kind=constructor");
2319 break;
2320 case llvm::codegenoptions::LimitedDebugInfo:
2321 CmdArgs.push_back("-debug-info-kind=limited");
2322 break;
2323 case llvm::codegenoptions::FullDebugInfo:
2324 CmdArgs.push_back("-debug-info-kind=standalone");
2325 break;
2326 case llvm::codegenoptions::UnusedTypeInfo:
2327 CmdArgs.push_back("-debug-info-kind=unused-types");
2328 break;
2329 default:
2330 break;
2331 }
2332}
2333
2334// Convert an arg of the form "-gN" or "-ggdbN" or one of their aliases
2335// to the corresponding DebugInfoKind.
2336llvm::codegenoptions::DebugInfoKind tools::debugLevelToInfoKind(const Arg &A) {
2337 assert(A.getOption().matches(options::OPT_gN_Group) &&
2338 "Not a -g option that specifies a debug-info level");
2339 if (A.getOption().matches(options::OPT_g0) ||
2340 A.getOption().matches(options::OPT_ggdb0))
2341 return llvm::codegenoptions::NoDebugInfo;
2342 if (A.getOption().matches(options::OPT_gline_tables_only) ||
2343 A.getOption().matches(options::OPT_ggdb1))
2344 return llvm::codegenoptions::DebugLineTablesOnly;
2345 if (A.getOption().matches(options::OPT_gline_directives_only))
2346 return llvm::codegenoptions::DebugDirectivesOnly;
2347 return llvm::codegenoptions::DebugInfoConstructor;
2348}
2349
2350static unsigned ParseDebugDefaultVersion(const ToolChain &TC,
2351 const ArgList &Args) {
2352 const Arg *A = Args.getLastArg(options::OPT_fdebug_default_version);
2353
2354 if (!A)
2355 return 0;
2356
2357 unsigned Value = 0;
2358 if (StringRef(A->getValue()).getAsInteger(10, Value) || Value > 6 ||
2359 Value < 2)
2360 TC.getDriver().Diag(diag::err_drv_invalid_int_value)
2361 << A->getAsString(Args) << A->getValue();
2362 return Value;
2363}
2364
2365unsigned tools::DwarfVersionNum(StringRef ArgValue) {
2366 return llvm::StringSwitch<unsigned>(ArgValue)
2367 .Case("-gdwarf-2", 2)
2368 .Case("-gdwarf-3", 3)
2369 .Case("-gdwarf-4", 4)
2370 .Case("-gdwarf-5", 5)
2371 .Case("-gdwarf-6", 6)
2372 .Default(0);
2373}
2374
2375const Arg *tools::getDwarfNArg(const ArgList &Args) {
2376 return Args.getLastArg(options::OPT_gdwarf_2, options::OPT_gdwarf_3,
2377 options::OPT_gdwarf_4, options::OPT_gdwarf_5,
2378 options::OPT_gdwarf_6, options::OPT_gdwarf);
2379}
2380
2382 const llvm::opt::ArgList &Args) {
2383 unsigned DwarfVersion = ParseDebugDefaultVersion(TC, Args);
2384 if (const Arg *GDwarfN = getDwarfNArg(Args))
2385 if (int N = DwarfVersionNum(GDwarfN->getSpelling())) {
2386 DwarfVersion = N;
2387 if (DwarfVersion == 5 && TC.getTriple().isOSAIX())
2388 TC.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
2389 << GDwarfN->getSpelling() << TC.getTriple().str();
2390 }
2391 if (DwarfVersion == 0) {
2392 DwarfVersion = TC.GetDefaultDwarfVersion();
2393 assert(DwarfVersion && "toolchain default DWARF version must be nonzero");
2394 }
2395 return DwarfVersion;
2396}
2397
2399 const ArgList &Args, Arg *&Arg) {
2400 Arg = Args.getLastArg(options::OPT_gsplit_dwarf, options::OPT_gsplit_dwarf_EQ,
2401 options::OPT_gno_split_dwarf);
2402 if (!Arg || Arg->getOption().matches(options::OPT_gno_split_dwarf))
2404
2405 if (Arg->getOption().matches(options::OPT_gsplit_dwarf))
2407
2408 StringRef Value = Arg->getValue();
2409 if (Value == "split")
2411 if (Value == "single")
2413
2414 D.Diag(diag::err_drv_unsupported_option_argument)
2415 << Arg->getSpelling() << Arg->getValue();
2417}
2418
2419bool tools::checkDebugInfoOption(const Arg *A, const ArgList &Args,
2420 const Driver &D, const ToolChain &TC) {
2421 assert(A && "Expected non-nullptr argument.");
2422 if (TC.supportsDebugInfoOption(A))
2423 return true;
2424 D.Diag(diag::warn_drv_unsupported_debug_info_opt_for_target)
2425 << A->getAsString(Args) << TC.getTripleString();
2426 return false;
2427}
2428
2430 const ArgList &Args,
2431 ArgStringList &CmdArgs) {
2432 if (Args.hasFlag(options::OPT_fdebug_info_for_profiling,
2433 options::OPT_fno_debug_info_for_profiling, false) &&
2435 Args.getLastArg(options::OPT_fdebug_info_for_profiling), Args, D, TC))
2436 CmdArgs.push_back("-fdebug-info-for-profiling");
2437}
2438
2439void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
2440 ArgStringList &CmdArgs) {
2441 llvm::Reloc::Model RelocationModel;
2442 unsigned PICLevel;
2443 bool IsPIE;
2444 std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
2445
2446 if (RelocationModel != llvm::Reloc::Static)
2447 CmdArgs.push_back("-KPIC");
2448}
2449
2450/// Determine whether Objective-C automated reference counting is
2451/// enabled.
2452bool tools::isObjCAutoRefCount(const ArgList &Args) {
2453 return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
2454}
2455
2457
2458static LibGccType getLibGccType(const ToolChain &TC, const Driver &D,
2459 const ArgList &Args) {
2460 if (Args.hasArg(options::OPT_static_libgcc) ||
2461 Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_static_pie) ||
2462 // The Android NDK only provides libunwind.a, not libunwind.so.
2463 TC.getTriple().isAndroid())
2465 if (Args.hasArg(options::OPT_shared_libgcc))
2468}
2469
2470// Gcc adds libgcc arguments in various ways:
2471//
2472// gcc <none>: -lgcc --as-needed -lgcc_s --no-as-needed
2473// g++ <none>: -lgcc_s -lgcc
2474// gcc shared: -lgcc_s -lgcc
2475// g++ shared: -lgcc_s -lgcc
2476// gcc static: -lgcc -lgcc_eh
2477// g++ static: -lgcc -lgcc_eh
2478// gcc static-pie: -lgcc -lgcc_eh
2479// g++ static-pie: -lgcc -lgcc_eh
2480//
2481// Also, certain targets need additional adjustments.
2482
2483static void AddUnwindLibrary(const ToolChain &TC, const Driver &D,
2484 ArgStringList &CmdArgs, const ArgList &Args) {
2486 // By default OHOS binaries are linked statically to libunwind.
2487 if (TC.getTriple().isOHOSFamily() && UNW == ToolChain::UNW_CompilerRT) {
2488 CmdArgs.push_back("-l:libunwind.a");
2489 return;
2490 }
2491
2492 // Targets that don't use unwind libraries.
2493 if ((TC.getTriple().isAndroid() && UNW == ToolChain::UNW_Libgcc) ||
2494 TC.getTriple().isOSIAMCU() || TC.getTriple().isOSBinFormatWasm() ||
2495 TC.getTriple().isWindowsMSVCEnvironment() || UNW == ToolChain::UNW_None)
2496 return;
2497
2498 LibGccType LGT = getLibGccType(TC, D, Args);
2499 bool AsNeeded = LGT == LibGccType::UnspecifiedLibGcc &&
2500 (UNW == ToolChain::UNW_CompilerRT || !D.CCCIsCXX()) &&
2501 !TC.getTriple().isAndroid() &&
2502 !TC.getTriple().isOSCygMing() && !TC.getTriple().isOSAIX();
2503 if (AsNeeded)
2504 addAsNeededOption(TC, Args, CmdArgs, true);
2505
2506 switch (UNW) {
2508 return;
2509 case ToolChain::UNW_Libgcc: {
2510 if (LGT == LibGccType::StaticLibGcc)
2511 CmdArgs.push_back("-lgcc_eh");
2512 else
2513 CmdArgs.push_back("-lgcc_s");
2514 break;
2515 }
2517 if (TC.getTriple().isOSAIX()) {
2518 // AIX only has libunwind as a shared library. So do not pass
2519 // anything in if -static is specified.
2520 if (LGT != LibGccType::StaticLibGcc)
2521 CmdArgs.push_back("-lunwind");
2522 } else if (LGT == LibGccType::StaticLibGcc) {
2523 CmdArgs.push_back("-l:libunwind.a");
2524 } else if (LGT == LibGccType::SharedLibGcc) {
2525 if (TC.getTriple().isOSCygMing())
2526 CmdArgs.push_back("-l:libunwind.dll.a");
2527 else
2528 CmdArgs.push_back("-l:libunwind.so");
2529 } else {
2530 // Let the linker choose between libunwind.so and libunwind.a
2531 // depending on what's available, and depending on the -static flag
2532 CmdArgs.push_back("-lunwind");
2533 }
2534 break;
2535 }
2536
2537 if (AsNeeded)
2538 addAsNeededOption(TC, Args, CmdArgs, false);
2539}
2540
2541static void AddLibgcc(const ToolChain &TC, const Driver &D,
2542 ArgStringList &CmdArgs, const ArgList &Args) {
2543 LibGccType LGT = getLibGccType(TC, D, Args);
2544 if (LGT == LibGccType::StaticLibGcc ||
2545 (LGT == LibGccType::UnspecifiedLibGcc && !D.CCCIsCXX()))
2546 CmdArgs.push_back("-lgcc");
2547 AddUnwindLibrary(TC, D, CmdArgs, Args);
2548 if (LGT == LibGccType::SharedLibGcc ||
2550 CmdArgs.push_back("-lgcc");
2551 // compiler-rt is needed after libgcc for flang on AArch64 for the
2552 // __trampoline_setup symbol
2553 if (D.IsFlangMode() && TC.getArch() == llvm::Triple::aarch64) {
2554 CmdArgs.push_back("--as-needed");
2555 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
2556 CmdArgs.push_back("--no-as-needed");
2557 }
2558}
2559
2560void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
2561 ArgStringList &CmdArgs, const ArgList &Args) {
2562 // Make use of compiler-rt if --rtlib option is used
2564
2565 switch (RLT) {
2567 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
2568 AddUnwindLibrary(TC, D, CmdArgs, Args);
2569 break;
2571 // Make sure libgcc is not used under MSVC environment by default
2572 if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
2573 // Issue error diagnostic if libgcc is explicitly specified
2574 // through command line as --rtlib option argument.
2575 Arg *A = Args.getLastArg(options::OPT_rtlib_EQ);
2576 if (A && A->getValue() != StringRef("platform")) {
2577 TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
2578 << A->getValue() << "MSVC";
2579 }
2580 } else
2581 AddLibgcc(TC, D, CmdArgs, Args);
2582 break;
2583 }
2584
2585 // On Android, the unwinder uses dl_iterate_phdr (or one of
2586 // dl_unwind_find_exidx/__gnu_Unwind_Find_exidx on arm32) from libdl.so. For
2587 // statically-linked executables, these functions come from libc.a instead.
2588 if (TC.getTriple().isAndroid() && !Args.hasArg(options::OPT_static) &&
2589 !Args.hasArg(options::OPT_static_pie))
2590 CmdArgs.push_back("-ldl");
2591}
2592
2593SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
2594 const InputInfo &Output,
2595 const InputInfo &Input,
2596 const Driver &D) {
2597 const Arg *A = Args.getLastArg(options::OPT_save_stats_EQ);
2598 if (!A && !D.CCPrintInternalStats)
2599 return {};
2600
2601 SmallString<128> StatsFile;
2602 if (A) {
2603 StringRef SaveStats = A->getValue();
2604 if (SaveStats == "obj" && Output.isFilename()) {
2605 StatsFile.assign(Output.getFilename());
2606 llvm::sys::path::remove_filename(StatsFile);
2607 } else if (SaveStats != "cwd") {
2608 D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
2609 return {};
2610 }
2611
2612 StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
2613 llvm::sys::path::append(StatsFile, BaseName);
2614 llvm::sys::path::replace_extension(StatsFile, "stats");
2615 } else {
2616 assert(D.CCPrintInternalStats);
2617 StatsFile.assign(D.CCPrintInternalStatReportFilename.empty()
2618 ? "-"
2620 }
2621 return StatsFile;
2622}
2623
2624void tools::addMultilibFlag(bool Enabled, const StringRef Flag,
2625 Multilib::flags_list &Flags) {
2626 assert(Flag.front() == '-');
2627 if (Enabled) {
2628 Flags.push_back(Flag.str());
2629 } else {
2630 Flags.push_back(("!" + Flag.substr(1)).str());
2631 }
2632}
2633
2634void tools::addX86AlignBranchArgs(const Driver &D, const ArgList &Args,
2635 ArgStringList &CmdArgs, bool IsLTO,
2636 const StringRef PluginOptPrefix) {
2637 auto addArg = [&, IsLTO](const Twine &Arg) {
2638 if (IsLTO) {
2639 assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
2640 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
2641 } else {
2642 CmdArgs.push_back("-mllvm");
2643 CmdArgs.push_back(Args.MakeArgString(Arg));
2644 }
2645 };
2646
2647 if (Args.hasArg(options::OPT_mbranches_within_32B_boundaries)) {
2648 addArg(Twine("-x86-branches-within-32B-boundaries"));
2649 }
2650 if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_boundary_EQ)) {
2651 StringRef Value = A->getValue();
2652 unsigned Boundary;
2653 if (Value.getAsInteger(10, Boundary) || Boundary < 16 ||
2654 !llvm::isPowerOf2_64(Boundary)) {
2655 D.Diag(diag::err_drv_invalid_argument_to_option)
2656 << Value << A->getOption().getName();
2657 } else {
2658 addArg("-x86-align-branch-boundary=" + Twine(Boundary));
2659 }
2660 }
2661 if (const Arg *A = Args.getLastArg(options::OPT_malign_branch_EQ)) {
2662 std::string AlignBranch;
2663 for (StringRef T : A->getValues()) {
2664 if (T != "fused" && T != "jcc" && T != "jmp" && T != "call" &&
2665 T != "ret" && T != "indirect")
2666 D.Diag(diag::err_drv_invalid_malign_branch_EQ)
2667 << T << "fused, jcc, jmp, call, ret, indirect";
2668 if (!AlignBranch.empty())
2669 AlignBranch += '+';
2670 AlignBranch += T;
2671 }
2672 addArg("-x86-align-branch=" + Twine(AlignBranch));
2673 }
2674 if (const Arg *A = Args.getLastArg(options::OPT_mpad_max_prefix_size_EQ)) {
2675 StringRef Value = A->getValue();
2676 unsigned PrefixSize;
2677 if (Value.getAsInteger(10, PrefixSize)) {
2678 D.Diag(diag::err_drv_invalid_argument_to_option)
2679 << Value << A->getOption().getName();
2680 } else {
2681 addArg("-x86-pad-max-prefix-size=" + Twine(PrefixSize));
2682 }
2683 }
2684}
2685
2686/// SDLSearch: Search for Static Device Library
2687/// The search for SDL bitcode files is consistent with how static host
2688/// libraries are discovered. That is, the -l option triggers a search for
2689/// files in a set of directories called the LINKPATH. The host library search
2690/// procedure looks for a specific filename in the LINKPATH. The filename for
2691/// a host library is lib<libname>.a or lib<libname>.so. For SDLs, there is an
2692/// ordered-set of filenames that are searched. We call this ordered-set of
2693/// filenames as SEARCH-ORDER. Since an SDL can either be device-type specific,
2694/// architecture specific, or generic across all architectures, a naming
2695/// convention and search order is used where the file name embeds the
2696/// architecture name <arch-name> (nvptx or amdgcn) and the GPU device type
2697/// <device-name> such as sm_30 and gfx906. <device-name> is absent in case of
2698/// device-independent SDLs. To reduce congestion in host library directories,
2699/// the search first looks for files in the “libdevice” subdirectory. SDLs that
2700/// are bc files begin with the prefix “lib”.
2701///
2702/// Machine-code SDLs can also be managed as an archive (*.a file). The
2703/// convention has been to use the prefix “lib”. To avoid confusion with host
2704/// archive libraries, we use prefix "libbc-" for the bitcode SDL archives.
2705///
2706static bool SDLSearch(const Driver &D, const llvm::opt::ArgList &DriverArgs,
2707 llvm::opt::ArgStringList &CC1Args,
2708 const SmallVectorImpl<std::string> &LibraryPaths,
2709 StringRef Lib, StringRef Arch, StringRef Target,
2710 bool isBitCodeSDL) {
2712
2713 std::string LibDeviceLoc = "/libdevice";
2714 std::string LibBcPrefix = "/libbc-";
2715 std::string LibPrefix = "/lib";
2716
2717 if (isBitCodeSDL) {
2718 // SEARCH-ORDER for Bitcode SDLs:
2719 // libdevice/libbc-<libname>-<arch-name>-<device-type>.a
2720 // libbc-<libname>-<arch-name>-<device-type>.a
2721 // libdevice/libbc-<libname>-<arch-name>.a
2722 // libbc-<libname>-<arch-name>.a
2723 // libdevice/libbc-<libname>.a
2724 // libbc-<libname>.a
2725 // libdevice/lib<libname>-<arch-name>-<device-type>.bc
2726 // lib<libname>-<arch-name>-<device-type>.bc
2727 // libdevice/lib<libname>-<arch-name>.bc
2728 // lib<libname>-<arch-name>.bc
2729 // libdevice/lib<libname>.bc
2730 // lib<libname>.bc
2731
2732 for (StringRef Base : {LibBcPrefix, LibPrefix}) {
2733 const auto *Ext = Base.contains(LibBcPrefix) ? ".a" : ".bc";
2734
2735 for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
2736 Twine(Lib + "-" + Arch).str(), Twine(Lib).str()}) {
2737 SDLs.push_back(Twine(LibDeviceLoc + Base + Suffix + Ext).str());
2738 SDLs.push_back(Twine(Base + Suffix + Ext).str());
2739 }
2740 }
2741 } else {
2742 // SEARCH-ORDER for Machine-code SDLs:
2743 // libdevice/lib<libname>-<arch-name>-<device-type>.a
2744 // lib<libname>-<arch-name>-<device-type>.a
2745 // libdevice/lib<libname>-<arch-name>.a
2746 // lib<libname>-<arch-name>.a
2747
2748 const auto *Ext = ".a";
2749
2750 for (auto Suffix : {Twine(Lib + "-" + Arch + "-" + Target).str(),
2751 Twine(Lib + "-" + Arch).str()}) {
2752 SDLs.push_back(Twine(LibDeviceLoc + LibPrefix + Suffix + Ext).str());
2753 SDLs.push_back(Twine(LibPrefix + Suffix + Ext).str());
2754 }
2755 }
2756
2757 // The CUDA toolchain does not use a global device llvm-link before the LLVM
2758 // backend generates ptx. So currently, the use of bitcode SDL for nvptx is
2759 // only possible with post-clang-cc1 linking. Clang cc1 has a feature that
2760 // will link libraries after clang compilation while the LLVM IR is still in
2761 // memory. This utilizes a clang cc1 option called “-mlink-builtin-bitcode”.
2762 // This is a clang -cc1 option that is generated by the clang driver. The
2763 // option value must a full path to an existing file.
2764 bool FoundSDL = false;
2765 for (auto LPath : LibraryPaths) {
2766 for (auto SDL : SDLs) {
2767 auto FullName = Twine(LPath + SDL).str();
2768 if (llvm::sys::fs::exists(FullName)) {
2769 CC1Args.push_back(DriverArgs.MakeArgString(FullName));
2770 FoundSDL = true;
2771 break;
2772 }
2773 }
2774 if (FoundSDL)
2775 break;
2776 }
2777 return FoundSDL;
2778}
2779
2780/// Search if a user provided archive file lib<libname>.a exists in any of
2781/// the library paths. If so, add a new command to clang-offload-bundler to
2782/// unbundle this archive and create a temporary device specific archive. Name
2783/// of this SDL is passed to the llvm-link tool.
2785 Compilation &C, const Driver &D, const Tool &T, const JobAction &JA,
2786 const InputInfoList &Inputs, const llvm::opt::ArgList &DriverArgs,
2787 llvm::opt::ArgStringList &CC1Args,
2788 const SmallVectorImpl<std::string> &LibraryPaths, StringRef Lib,
2789 StringRef Arch, StringRef Target, bool isBitCodeSDL) {
2790
2791 // We don't support bitcode archive bundles for nvptx
2792 if (isBitCodeSDL && Arch.contains("nvptx"))
2793 return;
2794
2795 bool FoundAOB = false;
2796 std::string ArchiveOfBundles;
2797
2798 llvm::Triple Triple(D.getTargetTriple());
2799 bool IsMSVC = Triple.isWindowsMSVCEnvironment();
2800 auto Ext = IsMSVC ? ".lib" : ".a";
2801 if (!Lib.starts_with(":") && !Lib.starts_with("-l")) {
2802 if (llvm::sys::fs::exists(Lib)) {
2803 ArchiveOfBundles = Lib;
2804 FoundAOB = true;
2805 }
2806 } else {
2807 Lib.consume_front("-l");
2808 for (auto LPath : LibraryPaths) {
2809 ArchiveOfBundles.clear();
2810 auto LibFile = (Lib.starts_with(":") ? Lib.drop_front()
2811 : IsMSVC ? Lib + Ext
2812 : "lib" + Lib + Ext)
2813 .str();
2814 for (auto Prefix : {"/libdevice/", "/"}) {
2815 auto AOB = Twine(LPath + Prefix + LibFile).str();
2816 if (llvm::sys::fs::exists(AOB)) {
2817 ArchiveOfBundles = AOB;
2818 FoundAOB = true;
2819 break;
2820 }
2821 }
2822 if (FoundAOB)
2823 break;
2824 }
2825 }
2826
2827 if (!FoundAOB)
2828 return;
2829
2830 llvm::file_magic Magic;
2831 auto EC = llvm::identify_magic(ArchiveOfBundles, Magic);
2832 if (EC || Magic != llvm::file_magic::archive)
2833 return;
2834
2835 StringRef Prefix = isBitCodeSDL ? "libbc-" : "lib";
2836 std::string OutputLib =
2837 D.GetTemporaryPath(Twine(Prefix + llvm::sys::path::filename(Lib) + "-" +
2838 Arch + "-" + Target)
2839 .str(),
2840 "a");
2841
2842 C.addTempFile(C.getArgs().MakeArgString(OutputLib));
2843
2844 SmallString<128> DeviceTriple;
2846 DeviceTriple += '-';
2847 std::string NormalizedTriple =
2848 T.getToolChain().getEffectiveTriple().normalize(
2849 llvm::Triple::CanonicalForm::FOUR_IDENT);
2850 DeviceTriple += NormalizedTriple;
2851 if (!Target.empty()) {
2852 DeviceTriple += '-';
2853 DeviceTriple += Target;
2854 }
2855
2856 std::string UnbundleArg("-unbundle");
2857 std::string TypeArg("-type=a");
2858 std::string InputArg("-input=" + ArchiveOfBundles);
2859 std::string OffloadArg("-targets=" + std::string(DeviceTriple));
2860 std::string OutputArg("-output=" + OutputLib);
2861
2862 const char *UBProgram = DriverArgs.MakeArgString(
2863 T.getToolChain().GetProgramPath("clang-offload-bundler"));
2864
2865 ArgStringList UBArgs;
2866 UBArgs.push_back(C.getArgs().MakeArgString(UnbundleArg));
2867 UBArgs.push_back(C.getArgs().MakeArgString(TypeArg));
2868 UBArgs.push_back(C.getArgs().MakeArgString(InputArg));
2869 UBArgs.push_back(C.getArgs().MakeArgString(OffloadArg));
2870 UBArgs.push_back(C.getArgs().MakeArgString(OutputArg));
2871
2872 // Add this flag to not exit from clang-offload-bundler if no compatible
2873 // code object is found in heterogenous archive library.
2874 std::string AdditionalArgs("-allow-missing-bundles");
2875 UBArgs.push_back(C.getArgs().MakeArgString(AdditionalArgs));
2876
2877 // Add this flag to treat hip and hipv4 offload kinds as compatible with
2878 // openmp offload kind while extracting code objects from a heterogenous
2879 // archive library. Vice versa is also considered compatible.
2880 std::string HipCompatibleArgs("-hip-openmp-compatible");
2881 UBArgs.push_back(C.getArgs().MakeArgString(HipCompatibleArgs));
2882
2883 C.addCommand(std::make_unique<Command>(
2884 JA, T, ResponseFileSupport::AtFileCurCP(), UBProgram, UBArgs, Inputs,
2885 InputInfo(&JA, C.getArgs().MakeArgString(OutputLib))));
2886
2887 CC1Args.push_back(DriverArgs.MakeArgString(OutputLib));
2888}
2889
2890// Wrapper function used by driver for adding SDLs during link phase.
2892 const JobAction &JA,
2893 const InputInfoList &Inputs,
2894 const llvm::opt::ArgList &DriverArgs,
2895 llvm::opt::ArgStringList &CC1Args,
2896 StringRef Arch, StringRef Target,
2897 bool isBitCodeSDL) {
2898 AddStaticDeviceLibs(&C, &T, &JA, &Inputs, C.getDriver(), DriverArgs, CC1Args,
2899 Arch, Target, isBitCodeSDL);
2900}
2901
2902// User defined Static Device Libraries(SDLs) can be passed to clang for
2903// offloading GPU compilers. Like static host libraries, the use of a SDL is
2904// specified with the -l command line option. The primary difference between
2905// host and SDLs is the filenames for SDLs (refer SEARCH-ORDER for Bitcode SDLs
2906// and SEARCH-ORDER for Machine-code SDLs for the naming convention).
2907// SDLs are of following types:
2908//
2909// * Bitcode SDLs: They can either be a *.bc file or an archive of *.bc files.
2910// For NVPTX, these libraries are post-clang linked following each
2911// compilation. For AMDGPU, these libraries are linked one time
2912// during the application link phase.
2913//
2914// * Machine-code SDLs: They are archive files. For AMDGPU, the process for
2915// machine code SDLs is still in development. But they will be linked
2916// by the LLVM tool lld.
2917//
2918// * Bundled objects that contain both host and device codes: Bundled objects
2919// may also contain library code compiled from source. For NVPTX, the
2920// bundle contains cubin. For AMDGPU, the bundle contains bitcode.
2921//
2922// For Bitcode and Machine-code SDLs, current compiler toolchains hardcode the
2923// inclusion of specific SDLs such as math libraries and the OpenMP device
2924// library libomptarget.
2926 const JobAction *JA,
2927 const InputInfoList *Inputs, const Driver &D,
2928 const llvm::opt::ArgList &DriverArgs,
2929 llvm::opt::ArgStringList &CC1Args,
2930 StringRef Arch, StringRef Target,
2931 bool isBitCodeSDL) {
2932
2933 SmallVector<std::string, 8> LibraryPaths;
2934 // Add search directories from LIBRARY_PATH env variable
2935 std::optional<std::string> LibPath =
2936 llvm::sys::Process::GetEnv("LIBRARY_PATH");
2937 if (LibPath) {
2939 const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
2940 llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
2941 for (StringRef Path : Frags)
2942 LibraryPaths.emplace_back(Path.trim());
2943 }
2944
2945 // Add directories from user-specified -L options
2946 for (std::string Search_Dir : DriverArgs.getAllArgValues(options::OPT_L))
2947 LibraryPaths.emplace_back(Search_Dir);
2948
2949 // Add path to lib-debug folders
2950 SmallString<256> DefaultLibPath = llvm::sys::path::parent_path(D.Dir);
2951 llvm::sys::path::append(DefaultLibPath, CLANG_INSTALL_LIBDIR_BASENAME);
2952 LibraryPaths.emplace_back(DefaultLibPath.c_str());
2953
2954 // Build list of Static Device Libraries SDLs specified by -l option
2955 llvm::SmallSet<std::string, 16> SDLNames;
2956 static const StringRef HostOnlyArchives[] = {
2957 "omp", "cudart", "m", "gcc", "gcc_s", "pthread", "hip_hcc"};
2958 for (auto SDLName : DriverArgs.getAllArgValues(options::OPT_l)) {
2959 if (!llvm::is_contained(HostOnlyArchives, SDLName)) {
2960 SDLNames.insert(std::string("-l") + SDLName);
2961 }
2962 }
2963
2964 for (auto Input : DriverArgs.getAllArgValues(options::OPT_INPUT)) {
2965 auto FileName = StringRef(Input);
2966 // Clang treats any unknown file types as archives and passes them to the
2967 // linker. Files with extension 'lib' are classified as TY_Object by clang
2968 // but they are usually archives. It is OK if the file is not really an
2969 // archive since GetSDLFromOffloadArchive will check the magic of the file
2970 // and only unbundle it if it is really an archive.
2971 const StringRef LibFileExt = ".lib";
2972 if (!llvm::sys::path::has_extension(FileName) ||
2974 llvm::sys::path::extension(FileName).drop_front()) ==
2976 llvm::sys::path::extension(FileName) == LibFileExt)
2977 SDLNames.insert(Input);
2978 }
2979
2980 // The search stops as soon as an SDL file is found. The driver then provides
2981 // the full filename of the SDL to the llvm-link command. If no SDL is found
2982 // after searching each LINKPATH with SEARCH-ORDER, it is possible that an
2983 // archive file lib<libname>.a exists and may contain bundled object files.
2984 for (auto SDLName : SDLNames) {
2985 // This is the only call to SDLSearch
2986 if (!SDLSearch(D, DriverArgs, CC1Args, LibraryPaths, SDLName, Arch, Target,
2987 isBitCodeSDL)) {
2988 GetSDLFromOffloadArchive(*C, D, *T, *JA, *Inputs, DriverArgs, CC1Args,
2989 LibraryPaths, SDLName, Arch, Target,
2990 isBitCodeSDL);
2991 }
2992 }
2993}
2994
2995static llvm::opt::Arg *
2996getAMDGPUCodeObjectArgument(const Driver &D, const llvm::opt::ArgList &Args) {
2997 return Args.getLastArg(options::OPT_mcode_object_version_EQ);
2998}
2999
3001 const llvm::opt::ArgList &Args) {
3002 const unsigned MinCodeObjVer = 4;
3003 const unsigned MaxCodeObjVer = 6;
3004
3005 if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args)) {
3006 if (CodeObjArg->getOption().getID() ==
3007 options::OPT_mcode_object_version_EQ) {
3008 unsigned CodeObjVer = MaxCodeObjVer;
3009 auto Remnant =
3010 StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
3011 if (Remnant || CodeObjVer < MinCodeObjVer || CodeObjVer > MaxCodeObjVer)
3012 D.Diag(diag::err_drv_invalid_int_value)
3013 << CodeObjArg->getAsString(Args) << CodeObjArg->getValue();
3014 }
3015 }
3016}
3017
3019 const llvm::opt::ArgList &Args) {
3020 unsigned CodeObjVer = 6; // default
3021 if (auto *CodeObjArg = getAMDGPUCodeObjectArgument(D, Args))
3022 StringRef(CodeObjArg->getValue()).getAsInteger(0, CodeObjVer);
3023 return CodeObjVer;
3024}
3025
3027 const Driver &D, const llvm::opt::ArgList &Args) {
3028 return getAMDGPUCodeObjectArgument(D, Args) != nullptr;
3029}
3030
3032 const llvm::opt::ArgList &Args,
3033 llvm::opt::ArgStringList &CmdArgs,
3034 const llvm::Triple &Triple, bool IsLTO,
3035 const StringRef PluginOptPrefix) {
3036 auto addArg = [&, IsLTO](const Twine &Arg) {
3037 if (IsLTO) {
3038 assert(!PluginOptPrefix.empty() && "Cannot have empty PluginOptPrefix!");
3039 CmdArgs.push_back(Args.MakeArgString(Twine(PluginOptPrefix) + Arg));
3040 } else {
3041 CmdArgs.push_back("-mllvm");
3042 CmdArgs.push_back(Args.MakeArgString(Arg));
3043 }
3044 };
3045
3046 if (Arg *A = Args.getLastArg(options::OPT_moutline,
3047 options::OPT_mno_outline)) {
3048 if (A->getOption().matches(options::OPT_moutline)) {
3049 // We only support -moutline in AArch64, ARM, RISC-V and X86 targets right
3050 // now. If we're compiling for these, add the proper mllvm flags.
3051 // Otherwise, emit a warning and ignore the flag.
3052 if (Triple.isARM() || Triple.isThumb() || Triple.isAArch64() ||
3053 Triple.isRISCV() || Triple.isX86()) {
3054 addArg(Twine("-enable-machine-outliner"));
3055 } else {
3056 D.Diag(diag::warn_drv_moutline_unsupported_opt) << Triple.getArchName();
3057 }
3058 } else {
3059 if (!IsLTO)
3060 // Disable all outlining behaviour using `nooutline` attribute, in case
3061 // Linker Invocation lacks `-mno-outline`.
3062 CmdArgs.push_back("-mno-outline");
3063
3064 // Disable Pass in Pipeline
3065 addArg(Twine("-enable-machine-outliner=never"));
3066 }
3067 }
3068
3069 auto *CodeGenDataGenArg =
3070 Args.getLastArg(options::OPT_fcodegen_data_generate_EQ);
3071 auto *CodeGenDataUseArg = Args.getLastArg(options::OPT_fcodegen_data_use_EQ);
3072
3073 // We only allow one of them to be specified.
3074 if (CodeGenDataGenArg && CodeGenDataUseArg)
3075 D.Diag(diag::err_drv_argument_not_allowed_with)
3076 << CodeGenDataGenArg->getAsString(Args)
3077 << CodeGenDataUseArg->getAsString(Args);
3078
3079 // For codegen data gen, the output file is passed to the linker
3080 // while a boolean flag is passed to the LLVM backend.
3081 if (CodeGenDataGenArg)
3082 addArg(Twine("-codegen-data-generate"));
3083
3084 // For codegen data use, the input file is passed to the LLVM backend.
3085 if (CodeGenDataUseArg)
3086 addArg(Twine("-codegen-data-use-path=") + CodeGenDataUseArg->getValue());
3087}
3088
3090 const llvm::opt::ArgList &DriverArgs,
3091 llvm::opt::ArgStringList &CC1Args,
3092 StringRef BitcodeSuffix,
3093 const llvm::Triple &Triple,
3094 const ToolChain &HostTC) {
3095 SmallVector<StringRef, 8> LibraryPaths;
3096
3097 // Add user defined library paths from LIBRARY_PATH.
3098 std::optional<std::string> LibPath =
3099 llvm::sys::Process::GetEnv("LIBRARY_PATH");
3100 if (LibPath) {
3102 const char EnvPathSeparatorStr[] = {llvm::sys::EnvPathSeparator, '\0'};
3103 llvm::SplitString(*LibPath, Frags, EnvPathSeparatorStr);
3104 for (StringRef Path : Frags)
3105 LibraryPaths.emplace_back(Path.trim());
3106 }
3107
3108 // Check all of the standard library search paths used by the compiler.
3109 for (const auto &LibPath : HostTC.getFilePaths())
3110 LibraryPaths.emplace_back(LibPath);
3111
3112 // Check the target specific library path for the triple as well.
3113 SmallString<128> P(D.Dir);
3114 llvm::sys::path::append(P, "..", "lib", Triple.getTriple());
3115 LibraryPaths.emplace_back(P);
3116
3117 OptSpecifier LibomptargetBCPathOpt =
3118 Triple.isAMDGCN() ? options::OPT_libomptarget_amdgpu_bc_path_EQ
3119 : Triple.isNVPTX() ? options::OPT_libomptarget_nvptx_bc_path_EQ
3120 : options::OPT_libomptarget_spirv_bc_path_EQ;
3121
3122 StringRef ArchPrefix = Triple.isAMDGCN() ? "amdgpu"
3123 : Triple.isNVPTX() ? "nvptx"
3124 : "spirv";
3125 std::string LibOmpTargetName = ("libomptarget-" + ArchPrefix + ".bc").str();
3126
3127 // First check whether user specifies bc library
3128 if (const Arg *A = DriverArgs.getLastArg(LibomptargetBCPathOpt)) {
3129 SmallString<128> LibOmpTargetFile(A->getValue());
3130 if (llvm::sys::fs::exists(LibOmpTargetFile) &&
3131 llvm::sys::fs::is_directory(LibOmpTargetFile)) {
3132 llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
3133 }
3134
3135 if (llvm::sys::fs::exists(LibOmpTargetFile)) {
3136 CC1Args.push_back("-mlink-builtin-bitcode");
3137 CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
3138 } else {
3139 D.Diag(diag::err_drv_omp_offload_target_bcruntime_not_found)
3140 << LibOmpTargetFile;
3141 }
3142 } else {
3143 bool FoundBCLibrary = false;
3144
3145 for (StringRef LibraryPath : LibraryPaths) {
3146 SmallString<128> LibOmpTargetFile(LibraryPath);
3147 llvm::sys::path::append(LibOmpTargetFile, LibOmpTargetName);
3148 if (llvm::sys::fs::exists(LibOmpTargetFile)) {
3149 CC1Args.push_back("-mlink-builtin-bitcode");
3150 CC1Args.push_back(DriverArgs.MakeArgString(LibOmpTargetFile));
3151 FoundBCLibrary = true;
3152 break;
3153 }
3154 }
3155
3156 if (!FoundBCLibrary)
3157 D.Diag(diag::err_drv_omp_offload_target_missingbcruntime)
3158 << LibOmpTargetName << ArchPrefix;
3159 }
3160}
3161
3162bool tools::addOpenCLBuiltinsLib(const Driver &D, const llvm::Triple &TT,
3163 const llvm::opt::ArgList &DriverArgs,
3164 llvm::opt::ArgStringList &CC1Args) {
3165
3166 StringRef LibclcNamespec;
3167 const Arg *A = DriverArgs.getLastArg(options::OPT_libclc_lib_EQ);
3168 if (A) {
3169 // If the namespec is of the form :filename we use it exactly.
3170 LibclcNamespec = A->getValue();
3171 } else {
3172 if (!TT.isAMDGPU() || TT.getEnvironment() != llvm::Triple::LLVM)
3173 return false;
3174
3175 // TODO: Should this accept following -stdlib to override?
3176 if (DriverArgs.hasArg(options::OPT_no_offloadlib,
3177 options::OPT_nodefaultlibs, options::OPT_nostdlib))
3178 return false;
3179 }
3180
3181 bool FilenameSearch = LibclcNamespec.consume_front(":");
3182 if (FilenameSearch) {
3183 SmallString<128> LibclcFile(LibclcNamespec);
3184 if (D.getVFS().exists(LibclcFile)) {
3185 CC1Args.push_back("-mlink-builtin-bitcode");
3186 CC1Args.push_back(DriverArgs.MakeArgString(LibclcFile));
3187 return true;
3188 }
3189 D.Diag(diag::err_drv_libclc_not_found) << LibclcFile;
3190 return false;
3191 }
3192
3193 // The OpenCL libraries are stored in <ResourceDir>/lib/<triple>.
3194 SmallString<128> BasePath(D.ResourceDir);
3195 llvm::sys::path::append(BasePath, "lib");
3196 llvm::sys::path::append(BasePath, D.getTargetTriple());
3197
3198 // First check for a CPU-specific library in <ResourceDir>/lib/<triple>/<CPU>.
3199 // TODO: Factor this into common logic that checks for valid subtargets.
3200 if (const Arg *CPUArg = DriverArgs.getLastArg(options::OPT_mcpu_EQ)) {
3201 StringRef CPU = CPUArg->getValue();
3202 if (!CPU.empty()) {
3203 SmallString<128> CPUPath(BasePath);
3204 llvm::sys::path::append(CPUPath, CPU, "libclc.bc");
3205 if (D.getVFS().exists(CPUPath)) {
3206 CC1Args.push_back("-mlink-builtin-bitcode");
3207 CC1Args.push_back(DriverArgs.MakeArgString(CPUPath));
3208 return true;
3209 }
3210 }
3211 }
3212
3213 // Fall back to the generic library for the triple.
3214 SmallString<128> GenericPath(BasePath);
3215 llvm::sys::path::append(GenericPath, "libclc.bc");
3216 if (D.getVFS().exists(GenericPath)) {
3217 CC1Args.push_back("-mlink-builtin-bitcode");
3218 CC1Args.push_back(DriverArgs.MakeArgString(GenericPath));
3219 return true;
3220 }
3221
3222 D.Diag(diag::err_drv_libclc_not_found) << "libclc.bc";
3223 return false;
3224}
3225
3227 const llvm::opt::ArgList &Args,
3228 llvm::opt::ArgStringList &CmdArgs,
3229 const llvm::Triple &Triple) {
3230 if (Arg *A = Args.getLastArg(options::OPT_moutline_atomics,
3231 options::OPT_mno_outline_atomics)) {
3232 // Option -moutline-atomics supported for AArch64 target only.
3233 if (!Triple.isAArch64()) {
3234 D.Diag(diag::warn_drv_moutline_atomics_unsupported_opt)
3235 << Triple.getArchName() << A->getOption().getName();
3236 } else {
3237 if (A->getOption().matches(options::OPT_moutline_atomics)) {
3238 CmdArgs.push_back("-target-feature");
3239 CmdArgs.push_back("+outline-atomics");
3240 } else {
3241 CmdArgs.push_back("-target-feature");
3242 CmdArgs.push_back("-outline-atomics");
3243 }
3244 }
3245 } else if (Triple.isAArch64() && TC.IsAArch64OutlineAtomicsDefault(Args)) {
3246 CmdArgs.push_back("-target-feature");
3247 CmdArgs.push_back("+outline-atomics");
3248 }
3249}
3250
3251void tools::addOffloadCompressArgs(const llvm::opt::ArgList &TCArgs,
3252 llvm::opt::ArgStringList &CmdArgs) {
3253 if (TCArgs.hasFlag(options::OPT_offload_compress,
3254 options::OPT_no_offload_compress, false))
3255 CmdArgs.push_back("--compress");
3256 if (TCArgs.hasArg(options::OPT_v))
3257 CmdArgs.push_back("--verbose");
3258 if (auto *Arg = TCArgs.getLastArg(options::OPT_offload_compression_level_EQ))
3259 CmdArgs.push_back(
3260 TCArgs.MakeArgString(Twine("--compression-level=") + Arg->getValue()));
3261}
3262
3263void tools::addMCModel(const Driver &D, const llvm::opt::ArgList &Args,
3264 const llvm::Triple &Triple,
3265 const llvm::Reloc::Model &RelocationModel,
3266 llvm::opt::ArgStringList &CmdArgs) {
3267 if (Arg *A = Args.getLastArg(options::OPT_mcmodel_EQ)) {
3268 StringRef CM = A->getValue();
3269 bool Ok = false;
3270 if (Triple.isOSAIX() && CM == "medium")
3271 CM = "large";
3272 if (Triple.isAArch64(64)) {
3273 Ok = CM == "tiny" || CM == "small" || CM == "large";
3274 if (CM == "large" && !Triple.isOSBinFormatMachO() &&
3275 RelocationModel != llvm::Reloc::Static)
3276 D.Diag(diag::err_drv_argument_only_allowed_with)
3277 << A->getAsString(Args) << "-fno-pic";
3278 } else if (Triple.isLoongArch()) {
3279 if (CM == "extreme" &&
3280 Args.hasFlagNoClaim(options::OPT_fplt, options::OPT_fno_plt, false))
3281 D.Diag(diag::err_drv_argument_not_allowed_with)
3282 << A->getAsString(Args) << "-fplt";
3283 Ok = CM == "normal" || CM == "medium" || CM == "extreme";
3284 // Convert to LLVM recognizable names.
3285 if (Ok)
3286 CM = llvm::StringSwitch<StringRef>(CM)
3287 .Case("normal", "small")
3288 .Case("extreme", "large")
3289 .Default(CM);
3290 } else if (Triple.isPPC64() || Triple.isOSAIX()) {
3291 Ok = CM == "small" || CM == "medium" || CM == "large";
3292 } else if (Triple.isRISCV()) {
3293 // Large code model is disallowed to be used with PIC code model.
3294 if (CM == "large" && RelocationModel != llvm::Reloc::Static)
3295 D.Diag(diag::err_drv_argument_not_allowed_with)
3296 << A->getAsString(Args) << "-fpic";
3297 if (CM == "medlow")
3298 CM = "small";
3299 else if (CM == "medany")
3300 CM = "medium";
3301 Ok = CM == "small" || CM == "medium" ||
3302 (CM == "large" && Triple.isRISCV64());
3303 } else if (Triple.getArch() == llvm::Triple::x86_64) {
3304 Ok = llvm::is_contained({"small", "kernel", "medium", "large"}, CM);
3305 } else if (Triple.isNVPTX() || Triple.isAMDGPU() || Triple.isSPIRV()) {
3306 // NVPTX/AMDGPU/SPIRV does not care about the code model and will accept
3307 // whatever works for the host.
3308 Ok = true;
3309 } else if (Triple.isSPARC64()) {
3310 if (CM == "medlow")
3311 CM = "small";
3312 else if (CM == "medmid")
3313 CM = "medium";
3314 else if (CM == "medany")
3315 CM = "large";
3316 Ok = CM == "small" || CM == "medium" || CM == "large";
3317 } else if (Triple.getArch() == llvm::Triple::lanai) {
3318 Ok = llvm::is_contained({"small", "medium", "large"}, CM);
3319 }
3320 if (Ok) {
3321 CmdArgs.push_back(Args.MakeArgString("-mcmodel=" + CM));
3322 } else {
3323 D.Diag(diag::err_drv_unsupported_option_argument_for_target)
3324 << A->getSpelling() << CM << Triple.getTriple();
3325 }
3326 }
3327
3328 if (Triple.getArch() == llvm::Triple::x86_64) {
3329 bool IsMediumCM = false;
3330 bool IsLargeCM = false;
3331 if (Arg *A = Args.getLastArg(options::OPT_mcmodel_EQ)) {
3332 IsMediumCM = StringRef(A->getValue()) == "medium";
3333 IsLargeCM = StringRef(A->getValue()) == "large";
3334 }
3335 if (Arg *A = Args.getLastArg(options::OPT_mlarge_data_threshold_EQ)) {
3336 if (!IsMediumCM && !IsLargeCM) {
3337 D.Diag(diag::warn_drv_large_data_threshold_invalid_code_model)
3338 << A->getOption().getRenderName();
3339 } else {
3340 A->render(Args, CmdArgs);
3341 }
3342 } else if (IsMediumCM) {
3343 CmdArgs.push_back("-mlarge-data-threshold=65536");
3344 } else if (IsLargeCM) {
3345 CmdArgs.push_back("-mlarge-data-threshold=0");
3346 }
3347 }
3348}
3349
3350void tools::handleColorDiagnosticsArgs(const Driver &D, const ArgList &Args,
3351 ArgStringList &CmdArgs) {
3352 // Color diagnostics are parsed by the driver directly from argv and later
3353 // re-parsed to construct this job; claim any possible color diagnostic here
3354 // to avoid warn_drv_unused_argument and diagnose bad
3355 // OPT_fdiagnostics_color_EQ values.
3356 Args.getLastArg(options::OPT_fcolor_diagnostics,
3357 options::OPT_fno_color_diagnostics);
3358 if (const Arg *A = Args.getLastArg(options::OPT_fdiagnostics_color_EQ)) {
3359 StringRef Value(A->getValue());
3360 if (Value != "always" && Value != "never" && Value != "auto")
3361 D.Diag(diag::err_drv_invalid_argument_to_option)
3362 << Value << A->getOption().getName();
3363 }
3364
3365 switch (D.getDiags().getDiagnosticOptions().getShowColors()) {
3366 case ShowColorsKind::On:
3367 CmdArgs.push_back("-fcolor-diagnostics");
3368 break;
3370 CmdArgs.push_back("-fno-color-diagnostics");
3371 break;
3373 break;
3374 }
3375}
3376
3379 for (; *Arg; ++Arg) {
3380 switch (*Arg) {
3381 default:
3382 break;
3383 case ' ':
3384 case '\\':
3385 Res.push_back('\\');
3386 break;
3387 }
3388 Res.push_back(*Arg);
3389 }
3390}
3391
3393 const llvm::opt::ArgList &Args) {
3394 const Driver &D = TC.getDriver();
3395 const char *Exec = D.getDriverProgramPath();
3396
3397 llvm::opt::ArgStringList OriginalArgs;
3398 for (const auto &Arg : Args)
3399 Arg->render(Args, OriginalArgs);
3400
3402 escapeSpacesAndBackslashes(Exec, Flags);
3403 for (const char *OriginalArg : OriginalArgs) {
3404 llvm::SmallString<128> EscapedArg;
3405 escapeSpacesAndBackslashes(OriginalArg, EscapedArg);
3406 Flags += " ";
3407 Flags += EscapedArg;
3408 }
3409
3410 return Args.MakeArgString(Flags);
3411}
3412
3414 const llvm::opt::ArgList &Args,
3415 bool &FRecordCommandLine,
3416 bool &GRecordCommandLine,
3417 bool &DXRecordCommandLine) {
3418 const Driver &D = TC.getDriver();
3419 const llvm::Triple &Triple = TC.getEffectiveTriple();
3420 const std::string &TripleStr = Triple.getTriple();
3421
3422 FRecordCommandLine =
3423 Args.hasFlag(options::OPT_frecord_command_line,
3424 options::OPT_fno_record_command_line, false);
3425 GRecordCommandLine =
3426 Args.hasFlag(options::OPT_grecord_command_line,
3427 options::OPT_gno_record_command_line, false);
3428 DXRecordCommandLine = Triple.isDXIL() && Args.hasArg(options::OPT_g_Flag);
3429 if (FRecordCommandLine && !Triple.isOSBinFormatELF() &&
3430 !Triple.isOSBinFormatXCOFF() && !Triple.isOSBinFormatMachO())
3431 D.Diag(diag::err_drv_unsupported_opt_for_target)
3432 << Args.getLastArg(options::OPT_frecord_command_line)->getAsString(Args)
3433 << TripleStr;
3434
3435 return FRecordCommandLine || TC.UseDwarfDebugFlags() || GRecordCommandLine ||
3436 DXRecordCommandLine;
3437}
3438
3439void tools::renderGlobalISelOptions(const Driver &D, const ArgList &Args,
3440 ArgStringList &CmdArgs,
3441 const llvm::Triple &Triple) {
3442 if (Arg *A = Args.getLastArg(options::OPT_fglobal_isel,
3443 options::OPT_fno_global_isel)) {
3444 CmdArgs.push_back("-mllvm");
3445 if (A->getOption().matches(options::OPT_fglobal_isel)) {
3446 CmdArgs.push_back("-global-isel=1");
3447
3448 // GISel is on by default on AArch64 -O0, so don't bother adding
3449 // the fallback remarks for it. Other combinations will add a warning of
3450 // some kind.
3451 bool IsArchSupported = Triple.getArch() == llvm::Triple::aarch64;
3452 bool IsOptLevelSupported = false;
3453
3454 Arg *A = Args.getLastArg(options::OPT_O_Group);
3455 if (IsArchSupported) {
3456 if (!A || A->getOption().matches(options::OPT_O0))
3457 IsOptLevelSupported = true;
3458 }
3459 if (!IsArchSupported || !IsOptLevelSupported) {
3460 CmdArgs.push_back("-mllvm");
3461 CmdArgs.push_back("-global-isel-abort=2");
3462
3463 if (!IsArchSupported)
3464 D.Diag(diag::warn_drv_global_isel_incomplete) << Triple.getArchName();
3465 else
3466 D.Diag(diag::warn_drv_global_isel_incomplete_opt);
3467 }
3468 } else {
3469 CmdArgs.push_back("-global-isel=0");
3470 }
3471 }
3472}
3473
3474void tools::renderCommonIntegerOverflowOptions(const ArgList &Args,
3475 ArgStringList &CmdArgs,
3476 bool IsMSVCCompat) {
3477 bool use_fwrapv = IsMSVCCompat;
3478 bool use_fwrapv_pointer = false;
3479 for (const Arg *A : Args.filtered(
3480 options::OPT_fstrict_overflow, options::OPT_fno_strict_overflow,
3481 options::OPT_fwrapv, options::OPT_fno_wrapv,
3482 options::OPT_fwrapv_pointer, options::OPT_fno_wrapv_pointer)) {
3483 A->claim();
3484 switch (A->getOption().getID()) {
3485 case options::OPT_fstrict_overflow:
3486 use_fwrapv = false;
3487 use_fwrapv_pointer = false;
3488 break;
3489 case options::OPT_fno_strict_overflow:
3490 use_fwrapv = true;
3491 use_fwrapv_pointer = true;
3492 break;
3493 case options::OPT_fwrapv:
3494 use_fwrapv = true;
3495 break;
3496 case options::OPT_fno_wrapv:
3497 use_fwrapv = false;
3498 break;
3499 case options::OPT_fwrapv_pointer:
3500 use_fwrapv_pointer = true;
3501 break;
3502 case options::OPT_fno_wrapv_pointer:
3503 use_fwrapv_pointer = false;
3504 break;
3505 }
3506 }
3507
3508 if (use_fwrapv)
3509 CmdArgs.push_back("-fwrapv");
3510 if (!use_fwrapv && IsMSVCCompat)
3511 CmdArgs.push_back("-fno-wrapv");
3512 if (use_fwrapv_pointer)
3513 CmdArgs.push_back("-fwrapv-pointer");
3514}
3515
3516/// Vectorize at all optimization levels greater than 1 except for -Oz.
3517/// For -Oz the loop vectorizer is disabled, while the slp vectorizer is
3518/// enabled.
3519bool tools::shouldEnableVectorizerAtOLevel(const ArgList &Args, bool isSlpVec) {
3520 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
3521 if (A->getOption().matches(options::OPT_O4) ||
3522 A->getOption().matches(options::OPT_Ofast))
3523 return true;
3524
3525 if (A->getOption().matches(options::OPT_O0))
3526 return false;
3527
3528 assert(A->getOption().matches(options::OPT_O) && "Must have a -O flag");
3529
3530 // Vectorize -Os.
3531 StringRef S(A->getValue());
3532 if (S == "s")
3533 return true;
3534
3535 // Don't vectorize -Oz, unless it's the slp vectorizer.
3536 if (S == "z")
3537 return isSlpVec;
3538
3539 unsigned OptLevel = 0;
3540 if (S.getAsInteger(10, OptLevel))
3541 return false;
3542
3543 return OptLevel > 1;
3544 }
3545
3546 return false;
3547}
3548
3549void tools::handleVectorizeLoopsArgs(const ArgList &Args,
3550 ArgStringList &CmdArgs) {
3551 bool EnableVec = shouldEnableVectorizerAtOLevel(Args, false);
3552 if (Args.hasFlag(options::OPT_fvectorize, options::OPT_fno_vectorize,
3553 EnableVec))
3554 CmdArgs.push_back("-vectorize-loops");
3555}
3556
3557void tools::handleVectorizeSLPArgs(const ArgList &Args,
3558 ArgStringList &CmdArgs) {
3559 bool EnableSLPVec = shouldEnableVectorizerAtOLevel(Args, true);
3560 if (Args.hasFlag(options::OPT_fslp_vectorize, options::OPT_fno_slp_vectorize,
3561 EnableSLPVec))
3562 CmdArgs.push_back("-vectorize-slp");
3563}
3564
3565void tools::handleInterchangeLoopsArgs(const ArgList &Args,
3566 ArgStringList &CmdArgs) {
3567 if (Args.hasFlag(options::OPT_floop_interchange,
3568 options::OPT_fno_loop_interchange, false))
3569 CmdArgs.push_back("-floop-interchange");
3570}
3571
3573 switch (Range) {
3575 return "full";
3576 break;
3578 return "basic";
3579 break;
3581 return "improved";
3582 break;
3584 return "promoted";
3585 break;
3587 return "none";
3588 break;
3589 }
3590 llvm_unreachable("Fully covered switch above");
3591}
3592
3593std::string
3595 std::string ComplexRangeStr = complexRangeKindToStr(Range);
3596 if (!ComplexRangeStr.empty())
3597 return "-complex-range=" + ComplexRangeStr;
3598 return ComplexRangeStr;
3599}
3600
3601static void emitComplexRangeDiag(const Driver &D, StringRef LastOpt,
3603 StringRef NewOpt,
3605 // Do not emit a warning if NewOpt overrides LastOpt in the following cases.
3606 //
3607 // | LastOpt | NewOpt |
3608 // |-----------------------|-----------------------|
3609 // | -fcx-limited-range | -fno-cx-limited-range |
3610 // | -fno-cx-limited-range | -fcx-limited-range |
3611 // | -fcx-fortran-rules | -fno-cx-fortran-rules |
3612 // | -fno-cx-fortran-rules | -fcx-fortran-rules |
3613 // | -ffast-math | -fno-fast-math |
3614 // | -ffp-model= | -ffast-math |
3615 // | -ffp-model= | -fno-fast-math |
3616 // | -ffp-model= | -ffp-model= |
3617 // | -fcomplex-arithmetic= | -fcomplex-arithmetic= |
3618 if (LastOpt == NewOpt || NewOpt.empty() || LastOpt.empty() ||
3619 (LastOpt == "-fcx-limited-range" && NewOpt == "-fno-cx-limited-range") ||
3620 (LastOpt == "-fno-cx-limited-range" && NewOpt == "-fcx-limited-range") ||
3621 (LastOpt == "-fcx-fortran-rules" && NewOpt == "-fno-cx-fortran-rules") ||
3622 (LastOpt == "-fno-cx-fortran-rules" && NewOpt == "-fcx-fortran-rules") ||
3623 (LastOpt == "-ffast-math" && NewOpt == "-fno-fast-math") ||
3624 (LastOpt.starts_with("-ffp-model=") && NewOpt == "-ffast-math") ||
3625 (LastOpt.starts_with("-ffp-model=") && NewOpt == "-fno-fast-math") ||
3626 (LastOpt.starts_with("-ffp-model=") &&
3627 NewOpt.starts_with("-ffp-model=")) ||
3628 (LastOpt.starts_with("-fcomplex-arithmetic=") &&
3629 NewOpt.starts_with("-fcomplex-arithmetic=")))
3630 return;
3631
3632 D.Diag(clang::diag::warn_drv_overriding_complex_range)
3633 << LastOpt << NewOpt << complexRangeKindToStr(Range)
3634 << complexRangeKindToStr(NewRange);
3635}
3636
3637void tools::setComplexRange(const Driver &D, StringRef NewOpt,
3639 StringRef &LastOpt,
3641 // Warn if user overrides the previously set complex number
3642 // multiplication/division option.
3643 if (Range != LangOptions::ComplexRangeKind::CX_None && Range != NewRange)
3644 emitComplexRangeDiag(D, LastOpt, Range, NewOpt, NewRange);
3645 LastOpt = NewOpt;
3646 Range = NewRange;
3647}
3648
3650 const JobAction &JA,
3651 const InputInfoList &JobInputs,
3652 const ArgStringList &LinkerInputs,
3653 const InputInfo &Output,
3654 const llvm::opt::ArgList &Args,
3655 const char *OutputFilename) {
3656 // Construct llvm-link command.
3657 // The output from llvm-link is a bitcode file.
3658
3659 assert(!LinkerInputs.empty() && !JobInputs.empty() &&
3660 "Must have at least one input.");
3661
3662 ArgStringList LlvmLinkArgs(
3663 {"-o", OutputFilename ? OutputFilename : Output.getFilename()});
3664
3665 LlvmLinkArgs.append(LinkerInputs);
3666
3667 const ToolChain &TC = T.getToolChain();
3668 const char *LlvmLink = Args.MakeArgString(TC.GetProgramPath("llvm-link"));
3669 C.addCommand(std::make_unique<Command>(JA, T, ResponseFileSupport::None(),
3670 LlvmLink, LlvmLinkArgs, JobInputs,
3671 Output));
3672}
#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:896
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:7062
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:1018
void getNVPTXTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, std::vector< StringRef > &Features)
Definition Cuda.cpp:696
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, bool ForAS=false)
Definition AMDGPU.cpp:690
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:409
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 renderDebugInfoCompressionArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const Driver &D, const ToolChain &TC)
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 addLLVMOffloadingRuntime(const Compilation &C, llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC, const llvm::opt::ArgList &Args)
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)
Top level wrappers for InstallAPI frontend operations.
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