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