1 //===--- CommonArgs.cpp - Args handling for multiple toolchains -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "CommonArgs.h"
11 #include "InputInfo.h"
13 #include "Arch/AArch64.h"
15 #include "Arch/Mips.h"
17 #include "Arch/SystemZ.h"
19 #include "clang/Basic/CharInfo.h"
20 #include "clang/Basic/LangOptions.h"
21 #include "clang/Basic/ObjCRuntime.h"
22 #include "clang/Basic/Version.h"
23 #include "clang/Basic/VirtualFileSystem.h"
24 #include "clang/Config/config.h"
25 #include "clang/Driver/Action.h"
26 #include "clang/Driver/Compilation.h"
27 #include "clang/Driver/Driver.h"
28 #include "clang/Driver/DriverDiagnostic.h"
29 #include "clang/Driver/Job.h"
30 #include "clang/Driver/Options.h"
31 #include "clang/Driver/SanitizerArgs.h"
32 #include "clang/Driver/ToolChain.h"
33 #include "clang/Driver/Util.h"
34 #include "llvm/ADT/STLExtras.h"
35 #include "llvm/ADT/SmallString.h"
36 #include "llvm/ADT/StringExtras.h"
37 #include "llvm/ADT/StringSwitch.h"
38 #include "llvm/ADT/Twine.h"
39 #include "llvm/Option/Arg.h"
40 #include "llvm/Option/ArgList.h"
41 #include "llvm/Option/Option.h"
42 #include "llvm/Support/CodeGen.h"
43 #include "llvm/Support/Compression.h"
44 #include "llvm/Support/ErrorHandling.h"
45 #include "llvm/Support/FileSystem.h"
46 #include "llvm/Support/Host.h"
47 #include "llvm/Support/Path.h"
48 #include "llvm/Support/Process.h"
49 #include "llvm/Support/Program.h"
50 #include "llvm/Support/ScopedPrinter.h"
51 #include "llvm/Support/TargetParser.h"
52 #include "llvm/Support/YAMLParser.h"
54 using namespace clang::driver;
55 using namespace clang::driver::tools;
56 using namespace clang;
57 using namespace llvm::opt;
59 void tools::addPathIfExists(const Driver &D, const Twine &Path,
60 ToolChain::path_list &Paths) {
61 if (D.getVFS().exists(Path))
62 Paths.push_back(Path.str());
65 void tools::handleTargetFeaturesGroup(const ArgList &Args,
66 std::vector<StringRef> &Features,
68 for (const Arg *A : Args.filtered(Group)) {
69 StringRef Name = A->getOption().getName();
73 assert(Name.startswith("m") && "Invalid feature name.");
74 Name = Name.substr(1);
76 bool IsNegative = Name.startswith("no-");
78 Name = Name.substr(3);
79 Features.push_back(Args.MakeArgString((IsNegative ? "-" : "+") + Name));
83 void tools::addDirectoryList(const ArgList &Args, ArgStringList &CmdArgs,
84 const char *ArgName, const char *EnvVar) {
85 const char *DirList = ::getenv(EnvVar);
86 bool CombinedArg = false;
89 return; // Nothing to do.
91 StringRef Name(ArgName);
92 if (Name.equals("-I") || Name.equals("-L"))
95 StringRef Dirs(DirList);
96 if (Dirs.empty()) // Empty string should not add '.'.
99 StringRef::size_type Delim;
100 while ((Delim = Dirs.find(llvm::sys::EnvPathSeparator)) != StringRef::npos) {
101 if (Delim == 0) { // Leading colon.
103 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
105 CmdArgs.push_back(ArgName);
106 CmdArgs.push_back(".");
111 Args.MakeArgString(std::string(ArgName) + Dirs.substr(0, Delim)));
113 CmdArgs.push_back(ArgName);
114 CmdArgs.push_back(Args.MakeArgString(Dirs.substr(0, Delim)));
117 Dirs = Dirs.substr(Delim + 1);
120 if (Dirs.empty()) { // Trailing colon.
122 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + "."));
124 CmdArgs.push_back(ArgName);
125 CmdArgs.push_back(".");
127 } else { // Add the last path.
129 CmdArgs.push_back(Args.MakeArgString(std::string(ArgName) + Dirs));
131 CmdArgs.push_back(ArgName);
132 CmdArgs.push_back(Args.MakeArgString(Dirs));
137 void tools::AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs,
138 const ArgList &Args, ArgStringList &CmdArgs,
139 const JobAction &JA) {
140 const Driver &D = TC.getDriver();
142 // Add extra linker input arguments which are not treated as inputs
143 // (constructed via -Xarch_).
144 Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
146 for (const auto &II : Inputs) {
147 // If the current tool chain refers to an OpenMP offloading host, we should
148 // ignore inputs that refer to OpenMP offloading devices - they will be
149 // embedded according to a proper linker script.
150 if (auto *IA = II.getAction())
151 if (JA.isHostOffloading(Action::OFK_OpenMP) &&
152 IA->isDeviceOffloading(Action::OFK_OpenMP))
155 if (!TC.HasNativeLLVMSupport() && types::isLLVMIR(II.getType()))
156 // Don't try to pass LLVM inputs unless we have native support.
157 D.Diag(diag::err_drv_no_linker_llvm_support) << TC.getTripleString();
159 // Add filenames immediately.
160 if (II.isFilename()) {
161 CmdArgs.push_back(II.getFilename());
165 // Otherwise, this is a linker input argument.
166 const Arg &A = II.getInputArg();
168 // Handle reserved library options.
169 if (A.getOption().matches(options::OPT_Z_reserved_lib_stdcxx))
170 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
171 else if (A.getOption().matches(options::OPT_Z_reserved_lib_cckext))
172 TC.AddCCKextLibArgs(Args, CmdArgs);
173 else if (A.getOption().matches(options::OPT_z)) {
174 // Pass -z prefix for gcc linker compatibility.
176 A.render(Args, CmdArgs);
178 A.renderAsInput(Args, CmdArgs);
182 // LIBRARY_PATH - included following the user specified library paths.
183 // and only supported on native toolchains.
184 if (!TC.isCrossCompiling()) {
185 addDirectoryList(Args, CmdArgs, "-L", "LIBRARY_PATH");
189 void tools::AddTargetFeature(const ArgList &Args,
190 std::vector<StringRef> &Features,
191 OptSpecifier OnOpt, OptSpecifier OffOpt,
192 StringRef FeatureName) {
193 if (Arg *A = Args.getLastArg(OnOpt, OffOpt)) {
194 if (A->getOption().matches(OnOpt))
195 Features.push_back(Args.MakeArgString("+" + FeatureName));
197 Features.push_back(Args.MakeArgString("-" + FeatureName));
201 /// Get the (LLVM) name of the R600 gpu we are targeting.
202 static std::string getR600TargetGPU(const ArgList &Args) {
203 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
204 const char *GPUName = A->getValue();
205 return llvm::StringSwitch<const char *>(GPUName)
206 .Cases("rv630", "rv635", "r600")
207 .Cases("rv610", "rv620", "rs780", "rs880")
208 .Case("rv740", "rv770")
209 .Case("palm", "cedar")
210 .Cases("sumo", "sumo2", "sumo")
211 .Case("hemlock", "cypress")
212 .Case("aruba", "cayman")
218 static std::string getNios2TargetCPU(const ArgList &Args) {
219 Arg *A = Args.getLastArg(options::OPT_mcpu_EQ);
221 A = Args.getLastArg(options::OPT_march_EQ);
226 const char *name = A->getValue();
227 return llvm::StringSwitch<const char *>(name)
228 .Case("r1", "nios2r1")
229 .Case("r2", "nios2r2")
233 static std::string getLanaiTargetCPU(const ArgList &Args) {
234 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
235 return A->getValue();
240 /// Get the (LLVM) name of the WebAssembly cpu we are targeting.
241 static StringRef getWebAssemblyTargetCPU(const ArgList &Args) {
242 // If we have -mcpu=, use that.
243 if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ)) {
244 StringRef CPU = A->getValue();
247 // Handle "native" by examining the host. "native" isn't meaningful when
248 // cross compiling, so only support this when the host is also WebAssembly.
250 return llvm::sys::getHostCPUName();
259 std::string tools::getCPUName(const ArgList &Args, const llvm::Triple &T,
263 switch (T.getArch()) {
267 case llvm::Triple::aarch64:
268 case llvm::Triple::aarch64_be:
269 return aarch64::getAArch64TargetCPU(Args, A);
271 case llvm::Triple::arm:
272 case llvm::Triple::armeb:
273 case llvm::Triple::thumb:
274 case llvm::Triple::thumbeb: {
275 StringRef MArch, MCPU;
276 arm::getARMArchCPUFromArgs(Args, MArch, MCPU, FromAs);
277 return arm::getARMTargetCPU(MCPU, MArch, T);
280 case llvm::Triple::avr:
281 if (const Arg *A = Args.getLastArg(options::OPT_mmcu_EQ))
282 return A->getValue();
285 case llvm::Triple::nios2: {
286 return getNios2TargetCPU(Args);
289 case llvm::Triple::mips:
290 case llvm::Triple::mipsel:
291 case llvm::Triple::mips64:
292 case llvm::Triple::mips64el: {
295 mips::getMipsCPUAndABI(Args, T, CPUName, ABIName);
299 case llvm::Triple::nvptx:
300 case llvm::Triple::nvptx64:
301 if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
302 return A->getValue();
305 case llvm::Triple::ppc:
306 case llvm::Triple::ppc64:
307 case llvm::Triple::ppc64le: {
308 std::string TargetCPUName = ppc::getPPCTargetCPU(Args);
309 // LLVM may default to generating code for the native CPU,
310 // but, like gcc, we default to a more generic option for
311 // each architecture. (except on Darwin)
312 if (TargetCPUName.empty() && !T.isOSDarwin()) {
313 if (T.getArch() == llvm::Triple::ppc64)
314 TargetCPUName = "ppc64";
315 else if (T.getArch() == llvm::Triple::ppc64le)
316 TargetCPUName = "ppc64le";
318 TargetCPUName = "ppc";
320 return TargetCPUName;
323 case llvm::Triple::bpfel:
324 case llvm::Triple::bpfeb:
325 case llvm::Triple::sparc:
326 case llvm::Triple::sparcel:
327 case llvm::Triple::sparcv9:
328 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
329 return A->getValue();
332 case llvm::Triple::x86:
333 case llvm::Triple::x86_64:
334 return x86::getX86TargetCPU(Args, T);
336 case llvm::Triple::hexagon:
338 toolchains::HexagonToolChain::GetTargetCPUVersion(Args).str();
340 case llvm::Triple::lanai:
341 return getLanaiTargetCPU(Args);
343 case llvm::Triple::systemz:
344 return systemz::getSystemZTargetCPU(Args);
346 case llvm::Triple::r600:
347 case llvm::Triple::amdgcn:
348 return getR600TargetGPU(Args);
350 case llvm::Triple::wasm32:
351 case llvm::Triple::wasm64:
352 return getWebAssemblyTargetCPU(Args);
356 unsigned tools::getLTOParallelism(const ArgList &Args, const Driver &D) {
357 unsigned Parallelism = 0;
358 Arg *LtoJobsArg = Args.getLastArg(options::OPT_flto_jobs_EQ);
360 StringRef(LtoJobsArg->getValue()).getAsInteger(10, Parallelism))
361 D.Diag(diag::err_drv_invalid_int_value) << LtoJobsArg->getAsString(Args)
362 << LtoJobsArg->getValue();
366 // CloudABI and WebAssembly use -ffunction-sections and -fdata-sections by
368 bool tools::isUseSeparateSections(const llvm::Triple &Triple) {
369 return Triple.getOS() == llvm::Triple::CloudABI ||
370 Triple.getArch() == llvm::Triple::wasm32 ||
371 Triple.getArch() == llvm::Triple::wasm64;
374 void tools::AddGoldPlugin(const ToolChain &ToolChain, const ArgList &Args,
375 ArgStringList &CmdArgs, bool IsThinLTO,
377 // Tell the linker to load the plugin. This has to come before AddLinkerInputs
378 // as gold requires -plugin to come before any -plugin-opt that -Wl might
380 CmdArgs.push_back("-plugin");
382 #if defined(LLVM_ON_WIN32)
383 const char *Suffix = ".dll";
384 #elif defined(__APPLE__)
385 const char *Suffix = ".dylib";
387 const char *Suffix = ".so";
390 SmallString<1024> Plugin;
391 llvm::sys::path::native(Twine(ToolChain.getDriver().Dir) +
392 "/../lib" CLANG_LIBDIR_SUFFIX "/LLVMgold" +
395 CmdArgs.push_back(Args.MakeArgString(Plugin));
397 // Try to pass driver level flags relevant to LTO code generation down to
400 // Handle flags for selecting CPU variants.
401 std::string CPU = getCPUName(Args, ToolChain.getTriple());
403 CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=mcpu=") + CPU));
405 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
407 if (A->getOption().matches(options::OPT_O4) ||
408 A->getOption().matches(options::OPT_Ofast))
410 else if (A->getOption().matches(options::OPT_O))
411 OOpt = A->getValue();
412 else if (A->getOption().matches(options::OPT_O0))
415 CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=O") + OOpt));
419 CmdArgs.push_back("-plugin-opt=thinlto");
421 if (unsigned Parallelism = getLTOParallelism(Args, D))
423 Args.MakeArgString("-plugin-opt=jobs=" + Twine(Parallelism)));
425 // If an explicit debugger tuning argument appeared, pass it along.
426 if (Arg *A = Args.getLastArg(options::OPT_gTune_Group,
427 options::OPT_ggdbN_Group)) {
428 if (A->getOption().matches(options::OPT_glldb))
429 CmdArgs.push_back("-plugin-opt=-debugger-tune=lldb");
430 else if (A->getOption().matches(options::OPT_gsce))
431 CmdArgs.push_back("-plugin-opt=-debugger-tune=sce");
433 CmdArgs.push_back("-plugin-opt=-debugger-tune=gdb");
436 bool UseSeparateSections =
437 isUseSeparateSections(ToolChain.getEffectiveTriple());
439 if (Args.hasFlag(options::OPT_ffunction_sections,
440 options::OPT_fno_function_sections, UseSeparateSections)) {
441 CmdArgs.push_back("-plugin-opt=-function-sections");
444 if (Args.hasFlag(options::OPT_fdata_sections, options::OPT_fno_data_sections,
445 UseSeparateSections)) {
446 CmdArgs.push_back("-plugin-opt=-data-sections");
449 if (Arg *A = getLastProfileSampleUseArg(Args)) {
450 StringRef FName = A->getValue();
451 if (!llvm::sys::fs::exists(FName))
452 D.Diag(diag::err_drv_no_such_file) << FName;
455 Args.MakeArgString(Twine("-plugin-opt=sample-profile=") + FName));
458 // Need this flag to turn on new pass manager via Gold plugin.
459 if (Args.hasFlag(options::OPT_fexperimental_new_pass_manager,
460 options::OPT_fno_experimental_new_pass_manager,
461 /* Default */ false)) {
462 CmdArgs.push_back("-plugin-opt=new-pass-manager");
467 void tools::addArchSpecificRPath(const ToolChain &TC, const ArgList &Args,
468 ArgStringList &CmdArgs) {
469 std::string CandidateRPath = TC.getArchSpecificLibPath();
470 if (TC.getVFS().exists(CandidateRPath)) {
471 CmdArgs.push_back("-rpath");
472 CmdArgs.push_back(Args.MakeArgString(CandidateRPath.c_str()));
476 bool tools::addOpenMPRuntime(ArgStringList &CmdArgs, const ToolChain &TC,
477 const ArgList &Args, bool IsOffloadingHost,
479 if (!Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
480 options::OPT_fno_openmp, false))
483 switch (TC.getDriver().getOpenMPRuntime(Args)) {
484 case Driver::OMPRT_OMP:
485 CmdArgs.push_back("-lomp");
487 case Driver::OMPRT_GOMP:
488 CmdArgs.push_back("-lgomp");
491 CmdArgs.push_back("-lrt");
493 case Driver::OMPRT_IOMP5:
494 CmdArgs.push_back("-liomp5");
496 case Driver::OMPRT_Unknown:
497 // Already diagnosed.
501 if (IsOffloadingHost)
502 CmdArgs.push_back("-lomptarget");
504 addArchSpecificRPath(TC, Args, CmdArgs);
509 static void addSanitizerRuntime(const ToolChain &TC, const ArgList &Args,
510 ArgStringList &CmdArgs, StringRef Sanitizer,
511 bool IsShared, bool IsWhole) {
512 // Wrap any static runtimes that must be forced into executable in
514 if (IsWhole) CmdArgs.push_back("-whole-archive");
515 CmdArgs.push_back(TC.getCompilerRTArgString(Args, Sanitizer, IsShared));
516 if (IsWhole) CmdArgs.push_back("-no-whole-archive");
519 addArchSpecificRPath(TC, Args, CmdArgs);
523 // Tries to use a file with the list of dynamic symbols that need to be exported
524 // from the runtime library. Returns true if the file was found.
525 static bool addSanitizerDynamicList(const ToolChain &TC, const ArgList &Args,
526 ArgStringList &CmdArgs,
527 StringRef Sanitizer) {
528 SmallString<128> SanRT(TC.getCompilerRT(Args, Sanitizer));
529 if (llvm::sys::fs::exists(SanRT + ".syms")) {
530 CmdArgs.push_back(Args.MakeArgString("--dynamic-list=" + SanRT + ".syms"));
536 void tools::linkSanitizerRuntimeDeps(const ToolChain &TC,
537 ArgStringList &CmdArgs) {
538 // Force linking against the system libraries sanitizers depends on
539 // (see PR15823 why this is necessary).
540 CmdArgs.push_back("--no-as-needed");
541 // There's no libpthread or librt on RTEMS.
542 if (TC.getTriple().getOS() != llvm::Triple::RTEMS) {
543 CmdArgs.push_back("-lpthread");
544 CmdArgs.push_back("-lrt");
546 CmdArgs.push_back("-lm");
547 // There's no libdl on all OSes.
548 if (TC.getTriple().getOS() != llvm::Triple::FreeBSD &&
549 TC.getTriple().getOS() != llvm::Triple::NetBSD &&
550 TC.getTriple().getOS() != llvm::Triple::RTEMS)
551 CmdArgs.push_back("-ldl");
552 // Required for forkpty on some OSes
553 if (TC.getTriple().getOS() == llvm::Triple::NetBSD)
554 CmdArgs.push_back("-lutil");
555 // Required for backtrace on some OSes
556 if (TC.getTriple().getOS() == llvm::Triple::NetBSD)
557 CmdArgs.push_back("-lexecinfo");
561 collectSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
562 SmallVectorImpl<StringRef> &SharedRuntimes,
563 SmallVectorImpl<StringRef> &StaticRuntimes,
564 SmallVectorImpl<StringRef> &NonWholeStaticRuntimes,
565 SmallVectorImpl<StringRef> &HelperStaticRuntimes,
566 SmallVectorImpl<StringRef> &RequiredSymbols) {
567 const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
568 // Collect shared runtimes.
569 if (SanArgs.needsSharedRt()) {
570 if (SanArgs.needsAsanRt()) {
571 SharedRuntimes.push_back("asan");
572 if (!Args.hasArg(options::OPT_shared) && !TC.getTriple().isAndroid())
573 HelperStaticRuntimes.push_back("asan-preinit");
575 if (SanArgs.needsUbsanRt()) {
576 if (SanArgs.requiresMinimalRuntime()) {
577 SharedRuntimes.push_back("ubsan_minimal");
579 SharedRuntimes.push_back("ubsan_standalone");
582 if (SanArgs.needsScudoRt())
583 SharedRuntimes.push_back("scudo");
584 if (SanArgs.needsHwasanRt())
585 SharedRuntimes.push_back("hwasan");
588 // The stats_client library is also statically linked into DSOs.
589 if (SanArgs.needsStatsRt())
590 StaticRuntimes.push_back("stats_client");
592 // Collect static runtimes.
593 if (Args.hasArg(options::OPT_shared) || SanArgs.needsSharedRt()) {
594 // Don't link static runtimes into DSOs or if -shared-libasan.
597 if (SanArgs.needsAsanRt()) {
598 StaticRuntimes.push_back("asan");
599 if (SanArgs.linkCXXRuntimes())
600 StaticRuntimes.push_back("asan_cxx");
603 if (SanArgs.needsHwasanRt()) {
604 StaticRuntimes.push_back("hwasan");
605 if (SanArgs.linkCXXRuntimes())
606 StaticRuntimes.push_back("hwasan_cxx");
608 if (SanArgs.needsDfsanRt())
609 StaticRuntimes.push_back("dfsan");
610 if (SanArgs.needsLsanRt())
611 StaticRuntimes.push_back("lsan");
612 if (SanArgs.needsMsanRt()) {
613 StaticRuntimes.push_back("msan");
614 if (SanArgs.linkCXXRuntimes())
615 StaticRuntimes.push_back("msan_cxx");
617 if (SanArgs.needsTsanRt()) {
618 StaticRuntimes.push_back("tsan");
619 if (SanArgs.linkCXXRuntimes())
620 StaticRuntimes.push_back("tsan_cxx");
622 if (SanArgs.needsUbsanRt()) {
623 if (SanArgs.requiresMinimalRuntime()) {
624 StaticRuntimes.push_back("ubsan_minimal");
626 StaticRuntimes.push_back("ubsan_standalone");
627 if (SanArgs.linkCXXRuntimes())
628 StaticRuntimes.push_back("ubsan_standalone_cxx");
631 if (SanArgs.needsSafeStackRt()) {
632 NonWholeStaticRuntimes.push_back("safestack");
633 RequiredSymbols.push_back("__safestack_init");
635 if (SanArgs.needsCfiRt())
636 StaticRuntimes.push_back("cfi");
637 if (SanArgs.needsCfiDiagRt()) {
638 StaticRuntimes.push_back("cfi_diag");
639 if (SanArgs.linkCXXRuntimes())
640 StaticRuntimes.push_back("ubsan_standalone_cxx");
642 if (SanArgs.needsStatsRt()) {
643 NonWholeStaticRuntimes.push_back("stats");
644 RequiredSymbols.push_back("__sanitizer_stats_register");
646 if (SanArgs.needsEsanRt())
647 StaticRuntimes.push_back("esan");
648 if (SanArgs.needsScudoRt()) {
649 StaticRuntimes.push_back("scudo");
650 if (SanArgs.linkCXXRuntimes())
651 StaticRuntimes.push_back("scudo_cxx");
655 // Should be called before we add system libraries (C++ ABI, libstdc++/libc++,
656 // C runtime, etc). Returns true if sanitizer system deps need to be linked in.
657 bool tools::addSanitizerRuntimes(const ToolChain &TC, const ArgList &Args,
658 ArgStringList &CmdArgs) {
659 SmallVector<StringRef, 4> SharedRuntimes, StaticRuntimes,
660 NonWholeStaticRuntimes, HelperStaticRuntimes, RequiredSymbols;
661 collectSanitizerRuntimes(TC, Args, SharedRuntimes, StaticRuntimes,
662 NonWholeStaticRuntimes, HelperStaticRuntimes,
665 // Inject libfuzzer dependencies.
666 if (TC.getSanitizerArgs().needsFuzzer()
667 && !Args.hasArg(options::OPT_shared)) {
669 addSanitizerRuntime(TC, Args, CmdArgs, "fuzzer", false, true);
670 if (!Args.hasArg(clang::driver::options::OPT_nostdlibxx))
671 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
674 for (auto RT : SharedRuntimes)
675 addSanitizerRuntime(TC, Args, CmdArgs, RT, true, false);
676 for (auto RT : HelperStaticRuntimes)
677 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
678 bool AddExportDynamic = false;
679 for (auto RT : StaticRuntimes) {
680 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, true);
681 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
683 for (auto RT : NonWholeStaticRuntimes) {
684 addSanitizerRuntime(TC, Args, CmdArgs, RT, false, false);
685 AddExportDynamic |= !addSanitizerDynamicList(TC, Args, CmdArgs, RT);
687 for (auto S : RequiredSymbols) {
688 CmdArgs.push_back("-u");
689 CmdArgs.push_back(Args.MakeArgString(S));
691 // If there is a static runtime with no dynamic list, force all the symbols
692 // to be dynamic to be sure we export sanitizer interface functions.
693 if (AddExportDynamic)
694 CmdArgs.push_back("-export-dynamic");
696 const SanitizerArgs &SanArgs = TC.getSanitizerArgs();
697 if (SanArgs.hasCrossDsoCfi() && !AddExportDynamic)
698 CmdArgs.push_back("-export-dynamic-symbol=__cfi_check");
700 return !StaticRuntimes.empty() || !NonWholeStaticRuntimes.empty();
703 bool tools::areOptimizationsEnabled(const ArgList &Args) {
704 // Find the last -O arg and see if it is non-zero.
705 if (Arg *A = Args.getLastArg(options::OPT_O_Group))
706 return !A->getOption().matches(options::OPT_O0);
711 const char *tools::SplitDebugName(const ArgList &Args, const InputInfo &Input) {
712 Arg *FinalOutput = Args.getLastArg(options::OPT_o);
713 if (FinalOutput && Args.hasArg(options::OPT_c)) {
714 SmallString<128> T(FinalOutput->getValue());
715 llvm::sys::path::replace_extension(T, "dwo");
716 return Args.MakeArgString(T);
718 // Use the compilation dir.
720 Args.getLastArgValue(options::OPT_fdebug_compilation_dir));
721 SmallString<128> F(llvm::sys::path::stem(Input.getBaseInput()));
722 llvm::sys::path::replace_extension(F, "dwo");
724 return Args.MakeArgString(F);
728 void tools::SplitDebugInfo(const ToolChain &TC, Compilation &C, const Tool &T,
729 const JobAction &JA, const ArgList &Args,
730 const InputInfo &Output, const char *OutFile) {
731 ArgStringList ExtractArgs;
732 ExtractArgs.push_back("--extract-dwo");
734 ArgStringList StripArgs;
735 StripArgs.push_back("--strip-dwo");
737 // Grabbing the output of the earlier compile step.
738 StripArgs.push_back(Output.getFilename());
739 ExtractArgs.push_back(Output.getFilename());
740 ExtractArgs.push_back(OutFile);
743 Args.MakeArgString(TC.GetProgramPath(CLANG_DEFAULT_OBJCOPY));
744 InputInfo II(types::TY_Object, Output.getFilename(), Output.getFilename());
746 // First extract the dwo sections.
747 C.addCommand(llvm::make_unique<Command>(JA, T, Exec, ExtractArgs, II));
749 // Then remove them from the original .o file.
750 C.addCommand(llvm::make_unique<Command>(JA, T, Exec, StripArgs, II));
753 // Claim options we don't want to warn if they are unused. We do this for
754 // options that build systems might add but are unused when assembling or only
755 // running the preprocessor for example.
756 void tools::claimNoWarnArgs(const ArgList &Args) {
757 // Don't warn about unused -f(no-)?lto. This can happen when we're
758 // preprocessing, precompiling or assembling.
759 Args.ClaimAllArgs(options::OPT_flto_EQ);
760 Args.ClaimAllArgs(options::OPT_flto);
761 Args.ClaimAllArgs(options::OPT_fno_lto);
764 Arg *tools::getLastProfileUseArg(const ArgList &Args) {
765 auto *ProfileUseArg = Args.getLastArg(
766 options::OPT_fprofile_instr_use, options::OPT_fprofile_instr_use_EQ,
767 options::OPT_fprofile_use, options::OPT_fprofile_use_EQ,
768 options::OPT_fno_profile_instr_use);
771 ProfileUseArg->getOption().matches(options::OPT_fno_profile_instr_use))
772 ProfileUseArg = nullptr;
774 return ProfileUseArg;
777 Arg *tools::getLastProfileSampleUseArg(const ArgList &Args) {
778 auto *ProfileSampleUseArg = Args.getLastArg(
779 options::OPT_fprofile_sample_use, options::OPT_fprofile_sample_use_EQ,
780 options::OPT_fauto_profile, options::OPT_fauto_profile_EQ,
781 options::OPT_fno_profile_sample_use, options::OPT_fno_auto_profile);
783 if (ProfileSampleUseArg &&
784 (ProfileSampleUseArg->getOption().matches(
785 options::OPT_fno_profile_sample_use) ||
786 ProfileSampleUseArg->getOption().matches(options::OPT_fno_auto_profile)))
789 return Args.getLastArg(options::OPT_fprofile_sample_use_EQ,
790 options::OPT_fauto_profile_EQ);
793 /// Parses the various -fpic/-fPIC/-fpie/-fPIE arguments. Then,
794 /// smooshes them together with platform defaults, to decide whether
795 /// this compile should be using PIC mode or not. Returns a tuple of
796 /// (RelocationModel, PICLevel, IsPIE).
797 std::tuple<llvm::Reloc::Model, unsigned, bool>
798 tools::ParsePICArgs(const ToolChain &ToolChain, const ArgList &Args) {
799 const llvm::Triple &EffectiveTriple = ToolChain.getEffectiveTriple();
800 const llvm::Triple &Triple = ToolChain.getTriple();
802 bool PIE = ToolChain.isPIEDefault();
803 bool PIC = PIE || ToolChain.isPICDefault();
804 // The Darwin/MachO default to use PIC does not apply when using -static.
805 if (Triple.isOSBinFormatMachO() && Args.hasArg(options::OPT_static))
807 bool IsPICLevelTwo = PIC;
810 Args.hasArg(options::OPT_mkernel, options::OPT_fapple_kext);
812 // Android-specific defaults for PIC/PIE
813 if (Triple.isAndroid()) {
814 switch (Triple.getArch()) {
815 case llvm::Triple::arm:
816 case llvm::Triple::armeb:
817 case llvm::Triple::thumb:
818 case llvm::Triple::thumbeb:
819 case llvm::Triple::aarch64:
820 case llvm::Triple::mips:
821 case llvm::Triple::mipsel:
822 case llvm::Triple::mips64:
823 case llvm::Triple::mips64el:
824 PIC = true; // "-fpic"
827 case llvm::Triple::x86:
828 case llvm::Triple::x86_64:
829 PIC = true; // "-fPIC"
830 IsPICLevelTwo = true;
838 // OpenBSD-specific defaults for PIE
839 if (Triple.getOS() == llvm::Triple::OpenBSD) {
840 switch (ToolChain.getArch()) {
841 case llvm::Triple::arm:
842 case llvm::Triple::aarch64:
843 case llvm::Triple::mips64:
844 case llvm::Triple::mips64el:
845 case llvm::Triple::x86:
846 case llvm::Triple::x86_64:
847 IsPICLevelTwo = false; // "-fpie"
850 case llvm::Triple::ppc:
851 case llvm::Triple::sparc:
852 case llvm::Triple::sparcel:
853 case llvm::Triple::sparcv9:
854 IsPICLevelTwo = true; // "-fPIE"
862 // The last argument relating to either PIC or PIE wins, and no
863 // other argument is used. If the last argument is any flavor of the
864 // '-fno-...' arguments, both PIC and PIE are disabled. Any PIE
865 // option implicitly enables PIC at the same level.
866 Arg *LastPICArg = Args.getLastArg(options::OPT_fPIC, options::OPT_fno_PIC,
867 options::OPT_fpic, options::OPT_fno_pic,
868 options::OPT_fPIE, options::OPT_fno_PIE,
869 options::OPT_fpie, options::OPT_fno_pie);
870 if (Triple.isOSWindows() && LastPICArg &&
872 Args.getLastArg(options::OPT_fPIC, options::OPT_fpic,
873 options::OPT_fPIE, options::OPT_fpie)) {
874 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
875 << LastPICArg->getSpelling() << Triple.str();
876 if (Triple.getArch() == llvm::Triple::x86_64)
877 return std::make_tuple(llvm::Reloc::PIC_, 2U, false);
878 return std::make_tuple(llvm::Reloc::Static, 0U, false);
881 // Check whether the tool chain trumps the PIC-ness decision. If the PIC-ness
882 // is forced, then neither PIC nor PIE flags will have no effect.
883 if (!ToolChain.isPICDefaultForced()) {
885 Option O = LastPICArg->getOption();
886 if (O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic) ||
887 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie)) {
888 PIE = O.matches(options::OPT_fPIE) || O.matches(options::OPT_fpie);
890 PIE || O.matches(options::OPT_fPIC) || O.matches(options::OPT_fpic);
892 O.matches(options::OPT_fPIE) || O.matches(options::OPT_fPIC);
895 if (EffectiveTriple.isPS4CPU()) {
896 Arg *ModelArg = Args.getLastArg(options::OPT_mcmodel_EQ);
897 StringRef Model = ModelArg ? ModelArg->getValue() : "";
898 if (Model != "kernel") {
900 ToolChain.getDriver().Diag(diag::warn_drv_ps4_force_pic)
901 << LastPICArg->getSpelling();
908 // Introduce a Darwin and PS4-specific hack. If the default is PIC, but the
909 // PIC level would've been set to level 1, force it back to level 2 PIC
911 if (PIC && (Triple.isOSDarwin() || EffectiveTriple.isPS4CPU()))
912 IsPICLevelTwo |= ToolChain.isPICDefault();
914 // This kernel flags are a trump-card: they will disable PIC/PIE
915 // generation, independent of the argument order.
917 ((!EffectiveTriple.isiOS() || EffectiveTriple.isOSVersionLT(6)) &&
918 !EffectiveTriple.isWatchOS()))
921 if (Arg *A = Args.getLastArg(options::OPT_mdynamic_no_pic)) {
922 // This is a very special mode. It trumps the other modes, almost no one
923 // uses it, and it isn't even valid on any OS but Darwin.
924 if (!Triple.isOSDarwin())
925 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
926 << A->getSpelling() << Triple.str();
928 // FIXME: Warn when this flag trumps some other PIC or PIE flag.
930 // Only a forced PIC mode can cause the actual compile to have PIC defines
931 // etc., no flags are sufficient. This behavior was selected to closely
932 // match that of llvm-gcc and Apple GCC before that.
933 PIC = ToolChain.isPICDefault() && ToolChain.isPICDefaultForced();
935 return std::make_tuple(llvm::Reloc::DynamicNoPIC, PIC ? 2U : 0U, false);
938 bool EmbeddedPISupported;
939 switch (Triple.getArch()) {
940 case llvm::Triple::arm:
941 case llvm::Triple::armeb:
942 case llvm::Triple::thumb:
943 case llvm::Triple::thumbeb:
944 EmbeddedPISupported = true;
947 EmbeddedPISupported = false;
951 bool ROPI = false, RWPI = false;
952 Arg* LastROPIArg = Args.getLastArg(options::OPT_fropi, options::OPT_fno_ropi);
953 if (LastROPIArg && LastROPIArg->getOption().matches(options::OPT_fropi)) {
954 if (!EmbeddedPISupported)
955 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
956 << LastROPIArg->getSpelling() << Triple.str();
959 Arg *LastRWPIArg = Args.getLastArg(options::OPT_frwpi, options::OPT_fno_rwpi);
960 if (LastRWPIArg && LastRWPIArg->getOption().matches(options::OPT_frwpi)) {
961 if (!EmbeddedPISupported)
962 ToolChain.getDriver().Diag(diag::err_drv_unsupported_opt_for_target)
963 << LastRWPIArg->getSpelling() << Triple.str();
967 // ROPI and RWPI are not comaptible with PIC or PIE.
968 if ((ROPI || RWPI) && (PIC || PIE))
969 ToolChain.getDriver().Diag(diag::err_drv_ropi_rwpi_incompatible_with_pic);
971 // When targettng MIPS64 with N64, the default is PIC, unless -mno-abicalls is
973 if ((Triple.getArch() == llvm::Triple::mips64 ||
974 Triple.getArch() == llvm::Triple::mips64el) &&
975 Args.hasArg(options::OPT_mno_abicalls))
976 return std::make_tuple(llvm::Reloc::Static, 0U, false);
979 return std::make_tuple(llvm::Reloc::PIC_, IsPICLevelTwo ? 2U : 1U, PIE);
981 llvm::Reloc::Model RelocM = llvm::Reloc::Static;
983 RelocM = llvm::Reloc::ROPI_RWPI;
985 RelocM = llvm::Reloc::ROPI;
987 RelocM = llvm::Reloc::RWPI;
989 return std::make_tuple(RelocM, 0U, false);
992 void tools::AddAssemblerKPIC(const ToolChain &ToolChain, const ArgList &Args,
993 ArgStringList &CmdArgs) {
994 llvm::Reloc::Model RelocationModel;
997 std::tie(RelocationModel, PICLevel, IsPIE) = ParsePICArgs(ToolChain, Args);
999 if (RelocationModel != llvm::Reloc::Static)
1000 CmdArgs.push_back("-KPIC");
1003 /// \brief Determine whether Objective-C automated reference counting is
1005 bool tools::isObjCAutoRefCount(const ArgList &Args) {
1006 return Args.hasFlag(options::OPT_fobjc_arc, options::OPT_fno_objc_arc, false);
1009 static void AddLibgcc(const llvm::Triple &Triple, const Driver &D,
1010 ArgStringList &CmdArgs, const ArgList &Args) {
1011 bool isAndroid = Triple.isAndroid();
1012 bool isCygMing = Triple.isOSCygMing();
1013 bool IsIAMCU = Triple.isOSIAMCU();
1014 bool StaticLibgcc = Args.hasArg(options::OPT_static_libgcc) ||
1015 Args.hasArg(options::OPT_static);
1017 CmdArgs.push_back("-lgcc");
1019 if (StaticLibgcc || isAndroid) {
1021 CmdArgs.push_back("-lgcc");
1023 if (!D.CCCIsCXX() && !isCygMing)
1024 CmdArgs.push_back("--as-needed");
1025 CmdArgs.push_back("-lgcc_s");
1026 if (!D.CCCIsCXX() && !isCygMing)
1027 CmdArgs.push_back("--no-as-needed");
1030 if (StaticLibgcc && !isAndroid && !IsIAMCU)
1031 CmdArgs.push_back("-lgcc_eh");
1032 else if (!Args.hasArg(options::OPT_shared) && D.CCCIsCXX())
1033 CmdArgs.push_back("-lgcc");
1035 // According to Android ABI, we have to link with libdl if we are
1036 // linking with non-static libgcc.
1038 // NOTE: This fixes a link error on Android MIPS as well. The non-static
1039 // libgcc for MIPS relies on _Unwind_Find_FDE and dl_iterate_phdr from libdl.
1040 if (isAndroid && !StaticLibgcc)
1041 CmdArgs.push_back("-ldl");
1044 void tools::AddRunTimeLibs(const ToolChain &TC, const Driver &D,
1045 ArgStringList &CmdArgs, const ArgList &Args) {
1046 // Make use of compiler-rt if --rtlib option is used
1047 ToolChain::RuntimeLibType RLT = TC.GetRuntimeLibType(Args);
1050 case ToolChain::RLT_CompilerRT:
1051 CmdArgs.push_back(TC.getCompilerRTArgString(Args, "builtins"));
1053 case ToolChain::RLT_Libgcc:
1054 // Make sure libgcc is not used under MSVC environment by default
1055 if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
1056 // Issue error diagnostic if libgcc is explicitly specified
1057 // through command line as --rtlib option argument.
1058 if (Args.hasArg(options::OPT_rtlib_EQ)) {
1059 TC.getDriver().Diag(diag::err_drv_unsupported_rtlib_for_platform)
1060 << Args.getLastArg(options::OPT_rtlib_EQ)->getValue() << "MSVC";
1063 AddLibgcc(TC.getTriple(), D, CmdArgs, Args);
1068 /// Add OpenMP linker script arguments at the end of the argument list so that
1069 /// the fat binary is built by embedding each of the device images into the
1070 /// host. The linker script also defines a few symbols required by the code
1071 /// generation so that the images can be easily retrieved at runtime by the
1072 /// offloading library. This should be used only in tool chains that support
1074 void tools::AddOpenMPLinkerScript(const ToolChain &TC, Compilation &C,
1075 const InputInfo &Output,
1076 const InputInfoList &Inputs,
1077 const ArgList &Args, ArgStringList &CmdArgs,
1078 const JobAction &JA) {
1080 // If this is not an OpenMP host toolchain, we don't need to do anything.
1081 if (!JA.isHostOffloading(Action::OFK_OpenMP))
1084 // Create temporary linker script. Keep it if save-temps is enabled.
1086 SmallString<256> Name = llvm::sys::path::filename(Output.getFilename());
1087 if (C.getDriver().isSaveTempsEnabled()) {
1088 llvm::sys::path::replace_extension(Name, "lk");
1089 LKS = C.getArgs().MakeArgString(Name.c_str());
1091 llvm::sys::path::replace_extension(Name, "");
1092 Name = C.getDriver().GetTemporaryPath(Name, "lk");
1093 LKS = C.addTempFile(C.getArgs().MakeArgString(Name.c_str()));
1096 // Add linker script option to the command.
1097 CmdArgs.push_back("-T");
1098 CmdArgs.push_back(LKS);
1100 // Create a buffer to write the contents of the linker script.
1101 std::string LksBuffer;
1102 llvm::raw_string_ostream LksStream(LksBuffer);
1104 // Get the OpenMP offload tool chains so that we can extract the triple
1105 // associated with each device input.
1106 auto OpenMPToolChains = C.getOffloadToolChains<Action::OFK_OpenMP>();
1107 assert(OpenMPToolChains.first != OpenMPToolChains.second &&
1108 "No OpenMP toolchains??");
1110 // Track the input file name and device triple in order to build the script,
1111 // inserting binaries in the designated sections.
1112 SmallVector<std::pair<std::string, const char *>, 8> InputBinaryInfo;
1114 // Add commands to embed target binaries. We ensure that each section and
1115 // image is 16-byte aligned. This is not mandatory, but increases the
1116 // likelihood of data to be aligned with a cache block in several main host
1118 LksStream << "/*\n";
1119 LksStream << " OpenMP Offload Linker Script\n";
1120 LksStream << " *** Automatically generated by Clang ***\n";
1121 LksStream << "*/\n";
1122 LksStream << "TARGET(binary)\n";
1123 auto DTC = OpenMPToolChains.first;
1124 for (auto &II : Inputs) {
1125 const Action *A = II.getAction();
1126 // Is this a device linking action?
1127 if (A && isa<LinkJobAction>(A) &&
1128 A->isDeviceOffloading(Action::OFK_OpenMP)) {
1129 assert(DTC != OpenMPToolChains.second &&
1130 "More device inputs than device toolchains??");
1131 InputBinaryInfo.push_back(std::make_pair(
1132 DTC->second->getTriple().normalize(), II.getFilename()));
1134 LksStream << "INPUT(" << II.getFilename() << ")\n";
1138 assert(DTC == OpenMPToolChains.second &&
1139 "Less device inputs than device toolchains??");
1141 LksStream << "SECTIONS\n";
1144 // Put each target binary into a separate section.
1145 for (const auto &BI : InputBinaryInfo) {
1146 LksStream << " .omp_offloading." << BI.first << " :\n";
1147 LksStream << " ALIGN(0x10)\n";
1148 LksStream << " {\n";
1149 LksStream << " PROVIDE_HIDDEN(.omp_offloading.img_start." << BI.first
1151 LksStream << " " << BI.second << "\n";
1152 LksStream << " PROVIDE_HIDDEN(.omp_offloading.img_end." << BI.first
1154 LksStream << " }\n";
1157 // Add commands to define host entries begin and end. We use 1-byte subalign
1158 // so that the linker does not add any padding and the elements in this
1159 // section form an array.
1160 LksStream << " .omp_offloading.entries :\n";
1161 LksStream << " ALIGN(0x10)\n";
1162 LksStream << " SUBALIGN(0x01)\n";
1163 LksStream << " {\n";
1164 LksStream << " PROVIDE_HIDDEN(.omp_offloading.entries_begin = .);\n";
1165 LksStream << " *(.omp_offloading.entries)\n";
1166 LksStream << " PROVIDE_HIDDEN(.omp_offloading.entries_end = .);\n";
1167 LksStream << " }\n";
1169 LksStream << "INSERT BEFORE .data\n";
1172 // Dump the contents of the linker script if the user requested that. We
1173 // support this option to enable testing of behavior with -###.
1174 if (C.getArgs().hasArg(options::OPT_fopenmp_dump_offload_linker_script))
1175 llvm::errs() << LksBuffer;
1177 // If this is a dry run, do not create the linker script file.
1178 if (C.getArgs().hasArg(options::OPT__HASH_HASH_HASH))
1181 // Open script file and write the contents.
1183 llvm::raw_fd_ostream Lksf(LKS, EC, llvm::sys::fs::F_None);
1186 C.getDriver().Diag(clang::diag::err_unable_to_make_temp) << EC.message();