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