xref: /netbsd-src/external/apache2/llvm/dist/clang/lib/Driver/ToolChains/Fuchsia.cpp (revision 76c7fc5f6b13ed0b1508e6b313e88e59977ed78e) 
1 //===--- Fuchsia.cpp - Fuchsia ToolChain Implementations --------*- 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 "Fuchsia.h"
10 #include "CommonArgs.h"
11 #include "clang/Config/config.h"
12 #include "clang/Driver/Compilation.h"
13 #include "clang/Driver/Driver.h"
14 #include "clang/Driver/DriverDiagnostic.h"
15 #include "clang/Driver/Options.h"
16 #include "clang/Driver/SanitizerArgs.h"
17 #include "llvm/Option/ArgList.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/Path.h"
20 #include "llvm/Support/VirtualFileSystem.h"
21 
22 using namespace clang::driver;
23 using namespace clang::driver::toolchains;
24 using namespace clang::driver::tools;
25 using namespace clang;
26 using namespace llvm::opt;
27 
28 using tools::addMultilibFlag;
29 
30 void fuchsia::Linker::ConstructJob(Compilation &C, const JobAction &JA,
31                                    const InputInfo &Output,
32                                    const InputInfoList &Inputs,
33                                    const ArgList &Args,
34                                    const char *LinkingOutput) const {
35   const toolchains::Fuchsia &ToolChain =
36       static_cast<const toolchains::Fuchsia &>(getToolChain());
37   const Driver &D = ToolChain.getDriver();
38 
39   ArgStringList CmdArgs;
40 
41   // Silence warning for "clang -g foo.o -o foo"
42   Args.ClaimAllArgs(options::OPT_g_Group);
43   // and "clang -emit-llvm foo.o -o foo"
44   Args.ClaimAllArgs(options::OPT_emit_llvm);
45   // and for "clang -w foo.o -o foo". Other warning options are already
46   // handled somewhere else.
47   Args.ClaimAllArgs(options::OPT_w);
48 
49   const char *Exec = Args.MakeArgString(ToolChain.GetLinkerPath());
50   if (llvm::sys::path::filename(Exec).equals_lower("ld.lld") ||
51       llvm::sys::path::stem(Exec).equals_lower("ld.lld")) {
52     CmdArgs.push_back("-z");
53     CmdArgs.push_back("rodynamic");
54     CmdArgs.push_back("-z");
55     CmdArgs.push_back("separate-loadable-segments");
56   }
57 
58   if (!D.SysRoot.empty())
59     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
60 
61   if (!Args.hasArg(options::OPT_shared) && !Args.hasArg(options::OPT_r))
62     CmdArgs.push_back("-pie");
63 
64   if (Args.hasArg(options::OPT_rdynamic))
65     CmdArgs.push_back("-export-dynamic");
66 
67   if (Args.hasArg(options::OPT_s))
68     CmdArgs.push_back("-s");
69 
70   if (Args.hasArg(options::OPT_r)) {
71     CmdArgs.push_back("-r");
72   } else {
73     CmdArgs.push_back("--build-id");
74     CmdArgs.push_back("--hash-style=gnu");
75   }
76 
77   CmdArgs.push_back("--eh-frame-hdr");
78 
79   if (Args.hasArg(options::OPT_static))
80     CmdArgs.push_back("-Bstatic");
81   else if (Args.hasArg(options::OPT_shared))
82     CmdArgs.push_back("-shared");
83 
84   const SanitizerArgs &SanArgs = ToolChain.getSanitizerArgs();
85 
86   if (!Args.hasArg(options::OPT_shared)) {
87     std::string Dyld = D.DyldPrefix;
88     if (SanArgs.needsAsanRt() && SanArgs.needsSharedRt())
89       Dyld += "asan/";
90     Dyld += "ld.so.1";
91     CmdArgs.push_back("-dynamic-linker");
92     CmdArgs.push_back(Args.MakeArgString(Dyld));
93   }
94 
95   CmdArgs.push_back("-o");
96   CmdArgs.push_back(Output.getFilename());
97 
98   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
99     if (!Args.hasArg(options::OPT_shared)) {
100       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("Scrt1.o")));
101     }
102   }
103 
104   Args.AddAllArgs(CmdArgs, options::OPT_L);
105   Args.AddAllArgs(CmdArgs, options::OPT_u);
106 
107   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
108 
109   if (D.isUsingLTO()) {
110     assert(!Inputs.empty() && "Must have at least one input.");
111     AddGoldPlugin(ToolChain, Args, CmdArgs, Output, Inputs[0],
112                   D.getLTOMode() == LTOK_Thin);
113   }
114 
115   bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
116   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
117   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
118   ToolChain.addProfileRTLibs(Args, CmdArgs);
119 
120   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
121     if (Args.hasArg(options::OPT_static))
122       CmdArgs.push_back("-Bdynamic");
123 
124     if (D.CCCIsCXX()) {
125       if (ToolChain.ShouldLinkCXXStdlib(Args)) {
126         bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
127                                    !Args.hasArg(options::OPT_static);
128         CmdArgs.push_back("--push-state");
129         CmdArgs.push_back("--as-needed");
130         if (OnlyLibstdcxxStatic)
131           CmdArgs.push_back("-Bstatic");
132         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
133         if (OnlyLibstdcxxStatic)
134           CmdArgs.push_back("-Bdynamic");
135         CmdArgs.push_back("-lm");
136         CmdArgs.push_back("--pop-state");
137       }
138     }
139 
140     if (NeedsSanitizerDeps)
141       linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
142 
143     if (NeedsXRayDeps)
144       linkXRayRuntimeDeps(ToolChain, CmdArgs);
145 
146     AddRunTimeLibs(ToolChain, D, CmdArgs, Args);
147 
148     if (Args.hasArg(options::OPT_pthread) ||
149         Args.hasArg(options::OPT_pthreads))
150       CmdArgs.push_back("-lpthread");
151 
152     if (Args.hasArg(options::OPT_fsplit_stack))
153       CmdArgs.push_back("--wrap=pthread_create");
154 
155     if (!Args.hasArg(options::OPT_nolibc))
156       CmdArgs.push_back("-lc");
157   }
158 
159   C.addCommand(std::make_unique<Command>(JA, *this, Exec, CmdArgs, Inputs));
160 }
161 
162 /// Fuchsia - Fuchsia tool chain which can call as(1) and ld(1) directly.
163 
164 Fuchsia::Fuchsia(const Driver &D, const llvm::Triple &Triple,
165                  const ArgList &Args)
166     : ToolChain(D, Triple, Args) {
167   getProgramPaths().push_back(getDriver().getInstalledDir());
168   if (getDriver().getInstalledDir() != D.Dir)
169     getProgramPaths().push_back(D.Dir);
170 
171   if (!D.SysRoot.empty()) {
172     SmallString<128> P(D.SysRoot);
173     llvm::sys::path::append(P, "lib");
174     getFilePaths().push_back(P.str());
175   }
176 
177   auto FilePaths = [&](const Multilib &M) -> std::vector<std::string> {
178     std::vector<std::string> FP;
179     if (D.CCCIsCXX()) {
180       if (auto CXXStdlibPath = getCXXStdlibPath()) {
181         SmallString<128> P(*CXXStdlibPath);
182         llvm::sys::path::append(P, M.gccSuffix());
183         FP.push_back(P.str());
184       }
185     }
186     return FP;
187   };
188 
189   Multilibs.push_back(Multilib());
190   // Use the noexcept variant with -fno-exceptions to avoid the extra overhead.
191   Multilibs.push_back(Multilib("noexcept", {}, {}, 1)
192                           .flag("-fexceptions")
193                           .flag("+fno-exceptions"));
194   // ASan has higher priority because we always want the instrumentated version.
195   Multilibs.push_back(Multilib("asan", {}, {}, 2)
196                           .flag("+fsanitize=address"));
197   // Use the asan+noexcept variant with ASan and -fno-exceptions.
198   Multilibs.push_back(Multilib("asan+noexcept", {}, {}, 3)
199                           .flag("+fsanitize=address")
200                           .flag("-fexceptions")
201                           .flag("+fno-exceptions"));
202   Multilibs.FilterOut([&](const Multilib &M) {
203     std::vector<std::string> RD = FilePaths(M);
204     return std::all_of(RD.begin(), RD.end(), [&](std::string P) {
205       return !getVFS().exists(P);
206     });
207   });
208 
209   Multilib::flags_list Flags;
210   addMultilibFlag(
211       Args.hasFlag(options::OPT_fexceptions, options::OPT_fno_exceptions, true),
212       "fexceptions", Flags);
213   addMultilibFlag(getSanitizerArgs().needsAsanRt(), "fsanitize=address", Flags);
214   Multilibs.setFilePathsCallback(FilePaths);
215 
216   if (Multilibs.select(Flags, SelectedMultilib))
217     if (!SelectedMultilib.isDefault())
218       if (const auto &PathsCallback = Multilibs.filePathsCallback())
219         for (const auto &Path : PathsCallback(SelectedMultilib))
220           // Prepend the multilib path to ensure it takes the precedence.
221           getFilePaths().insert(getFilePaths().begin(), Path);
222 }
223 
224 std::string Fuchsia::ComputeEffectiveClangTriple(const ArgList &Args,
225                                                  types::ID InputType) const {
226   llvm::Triple Triple(ComputeLLVMTriple(Args, InputType));
227   return (Triple.getArchName() + "-" + Triple.getOSName()).str();
228 }
229 
230 Tool *Fuchsia::buildLinker() const {
231   return new tools::fuchsia::Linker(*this);
232 }
233 
234 ToolChain::RuntimeLibType Fuchsia::GetRuntimeLibType(
235     const ArgList &Args) const {
236   if (Arg *A = Args.getLastArg(clang::driver::options::OPT_rtlib_EQ)) {
237     StringRef Value = A->getValue();
238     if (Value != "compiler-rt")
239       getDriver().Diag(clang::diag::err_drv_invalid_rtlib_name)
240           << A->getAsString(Args);
241   }
242 
243   return ToolChain::RLT_CompilerRT;
244 }
245 
246 ToolChain::CXXStdlibType
247 Fuchsia::GetCXXStdlibType(const ArgList &Args) const {
248   if (Arg *A = Args.getLastArg(options::OPT_stdlib_EQ)) {
249     StringRef Value = A->getValue();
250     if (Value != "libc++")
251       getDriver().Diag(diag::err_drv_invalid_stdlib_name)
252         << A->getAsString(Args);
253   }
254 
255   return ToolChain::CST_Libcxx;
256 }
257 
258 void Fuchsia::addClangTargetOptions(const ArgList &DriverArgs,
259                                     ArgStringList &CC1Args,
260                                     Action::OffloadKind) const {
261   if (DriverArgs.hasFlag(options::OPT_fuse_init_array,
262                          options::OPT_fno_use_init_array, true))
263     CC1Args.push_back("-fuse-init-array");
264 }
265 
266 void Fuchsia::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
267                                         ArgStringList &CC1Args) const {
268   const Driver &D = getDriver();
269 
270   if (DriverArgs.hasArg(options::OPT_nostdinc))
271     return;
272 
273   if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
274     SmallString<128> P(D.ResourceDir);
275     llvm::sys::path::append(P, "include");
276     addSystemInclude(DriverArgs, CC1Args, P);
277   }
278 
279   if (DriverArgs.hasArg(options::OPT_nostdlibinc))
280     return;
281 
282   // Check for configure-time C include directories.
283   StringRef CIncludeDirs(C_INCLUDE_DIRS);
284   if (CIncludeDirs != "") {
285     SmallVector<StringRef, 5> dirs;
286     CIncludeDirs.split(dirs, ":");
287     for (StringRef dir : dirs) {
288       StringRef Prefix =
289           llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : "";
290       addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
291     }
292     return;
293   }
294 
295   if (!D.SysRoot.empty()) {
296     SmallString<128> P(D.SysRoot);
297     llvm::sys::path::append(P, "include");
298     addExternCSystemInclude(DriverArgs, CC1Args, P.str());
299   }
300 }
301 
302 void Fuchsia::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
303                                            ArgStringList &CC1Args) const {
304   if (DriverArgs.hasArg(options::OPT_nostdlibinc) ||
305       DriverArgs.hasArg(options::OPT_nostdincxx))
306     return;
307 
308   switch (GetCXXStdlibType(DriverArgs)) {
309   case ToolChain::CST_Libcxx: {
310     SmallString<128> P(getDriver().Dir);
311     llvm::sys::path::append(P, "..", "include", "c++", "v1");
312     addSystemInclude(DriverArgs, CC1Args, P.str());
313     break;
314   }
315 
316   default:
317     llvm_unreachable("invalid stdlib name");
318   }
319 }
320 
321 void Fuchsia::AddCXXStdlibLibArgs(const ArgList &Args,
322                                   ArgStringList &CmdArgs) const {
323   switch (GetCXXStdlibType(Args)) {
324   case ToolChain::CST_Libcxx:
325     CmdArgs.push_back("-lc++");
326     break;
327 
328   case ToolChain::CST_Libstdcxx:
329     llvm_unreachable("invalid stdlib name");
330   }
331 }
332 
333 SanitizerMask Fuchsia::getSupportedSanitizers() const {
334   SanitizerMask Res = ToolChain::getSupportedSanitizers();
335   Res |= SanitizerKind::Address;
336   Res |= SanitizerKind::PointerCompare;
337   Res |= SanitizerKind::PointerSubtract;
338   Res |= SanitizerKind::Fuzzer;
339   Res |= SanitizerKind::FuzzerNoLink;
340   Res |= SanitizerKind::SafeStack;
341   Res |= SanitizerKind::Scudo;
342   return Res;
343 }
344 
345 SanitizerMask Fuchsia::getDefaultSanitizers() const {
346   SanitizerMask Res;
347   if (getTriple().getArch() == llvm::Triple::aarch64)
348     Res |= SanitizerKind::ShadowCallStack;
349   else
350     Res |= SanitizerKind::SafeStack;
351   return Res;
352 }
353