clang  9.0.0
Fuchsia.cpp
Go to the documentation of this file.
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"
13 #include "clang/Driver/Driver.h"
15 #include "clang/Driver/Options.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 
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 {
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  }
55 
56  if (!D.SysRoot.empty())
57  CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
58 
59  if (!Args.hasArg(options::OPT_shared) && !Args.hasArg(options::OPT_r))
60  CmdArgs.push_back("-pie");
61 
62  if (Args.hasArg(options::OPT_rdynamic))
63  CmdArgs.push_back("-export-dynamic");
64 
65  if (Args.hasArg(options::OPT_s))
66  CmdArgs.push_back("-s");
67 
68  if (Args.hasArg(options::OPT_r)) {
69  CmdArgs.push_back("-r");
70  } else {
71  CmdArgs.push_back("--build-id");
72  CmdArgs.push_back("--hash-style=gnu");
73  }
74 
75  CmdArgs.push_back("--eh-frame-hdr");
76 
77  if (Args.hasArg(options::OPT_static))
78  CmdArgs.push_back("-Bstatic");
79  else if (Args.hasArg(options::OPT_shared))
80  CmdArgs.push_back("-shared");
81 
82  const SanitizerArgs &SanArgs = ToolChain.getSanitizerArgs();
83 
84  if (!Args.hasArg(options::OPT_shared)) {
85  std::string Dyld = D.DyldPrefix;
86  if (SanArgs.needsAsanRt() && SanArgs.needsSharedRt())
87  Dyld += "asan/";
88  Dyld += "ld.so.1";
89  CmdArgs.push_back("-dynamic-linker");
90  CmdArgs.push_back(Args.MakeArgString(Dyld));
91  }
92 
93  CmdArgs.push_back("-o");
94  CmdArgs.push_back(Output.getFilename());
95 
96  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
97  if (!Args.hasArg(options::OPT_shared)) {
98  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("Scrt1.o")));
99  }
100  }
101 
102  Args.AddAllArgs(CmdArgs, options::OPT_L);
103  Args.AddAllArgs(CmdArgs, options::OPT_u);
104 
105  ToolChain.AddFilePathLibArgs(Args, CmdArgs);
106 
107  if (D.isUsingLTO()) {
108  assert(!Inputs.empty() && "Must have at least one input.");
109  AddGoldPlugin(ToolChain, Args, CmdArgs, Output, Inputs[0],
110  D.getLTOMode() == LTOK_Thin);
111  }
112 
113  bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
114  bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
115  AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
116  ToolChain.addProfileRTLibs(Args, CmdArgs);
117 
118  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
119  if (Args.hasArg(options::OPT_static))
120  CmdArgs.push_back("-Bdynamic");
121 
122  if (D.CCCIsCXX()) {
123  if (ToolChain.ShouldLinkCXXStdlib(Args)) {
124  bool OnlyLibstdcxxStatic = Args.hasArg(options::OPT_static_libstdcxx) &&
125  !Args.hasArg(options::OPT_static);
126  CmdArgs.push_back("--push-state");
127  CmdArgs.push_back("--as-needed");
128  if (OnlyLibstdcxxStatic)
129  CmdArgs.push_back("-Bstatic");
130  ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
131  if (OnlyLibstdcxxStatic)
132  CmdArgs.push_back("-Bdynamic");
133  CmdArgs.push_back("-lm");
134  CmdArgs.push_back("--pop-state");
135  }
136  }
137 
138  if (NeedsSanitizerDeps)
139  linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
140 
141  if (NeedsXRayDeps)
142  linkXRayRuntimeDeps(ToolChain, CmdArgs);
143 
144  AddRunTimeLibs(ToolChain, D, CmdArgs, Args);
145 
146  if (Args.hasArg(options::OPT_pthread) ||
147  Args.hasArg(options::OPT_pthreads))
148  CmdArgs.push_back("-lpthread");
149 
150  if (Args.hasArg(options::OPT_fsplit_stack))
151  CmdArgs.push_back("--wrap=pthread_create");
152 
153  if (!Args.hasArg(options::OPT_nolibc))
154  CmdArgs.push_back("-lc");
155  }
156 
157  C.addCommand(llvm::make_unique<Command>(JA, *this, Exec, CmdArgs, Inputs));
158 }
159 
160 /// Fuchsia - Fuchsia tool chain which can call as(1) and ld(1) directly.
161 
162 Fuchsia::Fuchsia(const Driver &D, const llvm::Triple &Triple,
163  const ArgList &Args)
164  : ToolChain(D, Triple, Args) {
165  getProgramPaths().push_back(getDriver().getInstalledDir());
166  if (getDriver().getInstalledDir() != D.Dir)
167  getProgramPaths().push_back(D.Dir);
168 
169  if (!D.SysRoot.empty()) {
171  llvm::sys::path::append(P, "lib");
172  getFilePaths().push_back(P.str());
173  }
174 
175  auto FilePaths = [&](const Multilib &M) -> std::vector<std::string> {
176  std::vector<std::string> FP;
177  if (D.CCCIsCXX()) {
178  if (auto CXXStdlibPath = getCXXStdlibPath()) {
179  SmallString<128> P(*CXXStdlibPath);
180  llvm::sys::path::append(P, M.gccSuffix());
181  FP.push_back(P.str());
182  }
183  }
184  return FP;
185  };
186 
188  // Use the noexcept variant with -fno-exceptions to avoid the extra overhead.
189  Multilibs.push_back(Multilib("noexcept", {}, {}, 1)
190  .flag("-fexceptions")
191  .flag("+fno-exceptions"));
192  // ASan has higher priority because we always want the instrumentated version.
193  Multilibs.push_back(Multilib("asan", {}, {}, 2)
194  .flag("+fsanitize=address"));
195  // Use the asan+noexcept variant with ASan and -fno-exceptions.
196  Multilibs.push_back(Multilib("asan+noexcept", {}, {}, 3)
197  .flag("+fsanitize=address")
198  .flag("-fexceptions")
199  .flag("+fno-exceptions"));
200  Multilibs.FilterOut([&](const Multilib &M) {
201  std::vector<std::string> RD = FilePaths(M);
202  return std::all_of(RD.begin(), RD.end(), [&](std::string P) {
203  return !getVFS().exists(P);
204  });
205  });
206 
207  Multilib::flags_list Flags;
209  Args.hasFlag(options::OPT_fexceptions, options::OPT_fno_exceptions, true),
210  "fexceptions", Flags);
211  addMultilibFlag(getSanitizerArgs().needsAsanRt(), "fsanitize=address", Flags);
212  Multilibs.setFilePathsCallback(FilePaths);
213 
214  if (Multilibs.select(Flags, SelectedMultilib))
216  if (const auto &PathsCallback = Multilibs.filePathsCallback())
217  for (const auto &Path : PathsCallback(SelectedMultilib))
218  // Prepend the multilib path to ensure it takes the precedence.
219  getFilePaths().insert(getFilePaths().begin(), Path);
220 }
221 
222 std::string Fuchsia::ComputeEffectiveClangTriple(const ArgList &Args,
223  types::ID InputType) const {
224  llvm::Triple Triple(ComputeLLVMTriple(Args, InputType));
225  return (Triple.getArchName() + "-" + Triple.getOSName()).str();
226 }
227 
229  return new tools::fuchsia::Linker(*this);
230 }
231 
233  const ArgList &Args) const {
234  if (Arg *A = Args.getLastArg(clang::driver::options::OPT_rtlib_EQ)) {
235  StringRef Value = A->getValue();
236  if (Value != "compiler-rt")
237  getDriver().Diag(clang::diag::err_drv_invalid_rtlib_name)
238  << A->getAsString(Args);
239  }
240 
242 }
243 
245 Fuchsia::GetCXXStdlibType(const ArgList &Args) const {
246  if (Arg *A = Args.getLastArg(options::OPT_stdlib_EQ)) {
247  StringRef Value = A->getValue();
248  if (Value != "libc++")
249  getDriver().Diag(diag::err_drv_invalid_stdlib_name)
250  << A->getAsString(Args);
251  }
252 
253  return ToolChain::CST_Libcxx;
254 }
255 
256 void Fuchsia::addClangTargetOptions(const ArgList &DriverArgs,
257  ArgStringList &CC1Args,
258  Action::OffloadKind) const {
259  if (DriverArgs.hasFlag(options::OPT_fuse_init_array,
260  options::OPT_fno_use_init_array, true))
261  CC1Args.push_back("-fuse-init-array");
262 }
263 
264 void Fuchsia::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
265  ArgStringList &CC1Args) const {
266  const Driver &D = getDriver();
267 
268  if (DriverArgs.hasArg(options::OPT_nostdinc))
269  return;
270 
271  if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
273  llvm::sys::path::append(P, "include");
274  addSystemInclude(DriverArgs, CC1Args, P);
275  }
276 
277  if (DriverArgs.hasArg(options::OPT_nostdlibinc))
278  return;
279 
280  // Check for configure-time C include directories.
281  StringRef CIncludeDirs(C_INCLUDE_DIRS);
282  if (CIncludeDirs != "") {
284  CIncludeDirs.split(dirs, ":");
285  for (StringRef dir : dirs) {
286  StringRef Prefix =
287  llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : "";
288  addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
289  }
290  return;
291  }
292 
293  if (!D.SysRoot.empty()) {
295  llvm::sys::path::append(P, "include");
296  addExternCSystemInclude(DriverArgs, CC1Args, P.str());
297  }
298 }
299 
300 void Fuchsia::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
301  ArgStringList &CC1Args) const {
302  if (DriverArgs.hasArg(options::OPT_nostdlibinc) ||
303  DriverArgs.hasArg(options::OPT_nostdincxx))
304  return;
305 
306  switch (GetCXXStdlibType(DriverArgs)) {
307  case ToolChain::CST_Libcxx: {
309  llvm::sys::path::append(P, "..", "include", "c++", "v1");
310  addSystemInclude(DriverArgs, CC1Args, P.str());
311  break;
312  }
313 
314  default:
315  llvm_unreachable("invalid stdlib name");
316  }
317 }
318 
319 void Fuchsia::AddCXXStdlibLibArgs(const ArgList &Args,
320  ArgStringList &CmdArgs) const {
321  switch (GetCXXStdlibType(Args)) {
323  CmdArgs.push_back("-lc++");
324  break;
325 
327  llvm_unreachable("invalid stdlib name");
328  }
329 }
330 
333  Res |= SanitizerKind::Address;
334  Res |= SanitizerKind::PointerCompare;
335  Res |= SanitizerKind::PointerSubtract;
336  Res |= SanitizerKind::Fuzzer;
337  Res |= SanitizerKind::FuzzerNoLink;
338  Res |= SanitizerKind::SafeStack;
339  Res |= SanitizerKind::Scudo;
340  return Res;
341 }
342 
344  return SanitizerKind::SafeStack;
345 }
static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory with extern "C" semantics to CC1 arguments...
Definition: ToolChain.cpp:797
virtual std::string ComputeLLVMTriple(const llvm::opt::ArgList &Args, types::ID InputType=types::TY_INVALID) const
ComputeLLVMTriple - Return the LLVM target triple to use, after taking command line arguments into ac...
Definition: ToolChain.cpp:573
bool addXRayRuntime(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
bool isDefault() const
Check whether the default is selected.
Definition: Multilib.h:106
StringRef P
SanitizerMask getDefaultSanitizers() const override
Return sanitizers which are enabled by default.
Definition: Fuchsia.cpp:343
bool isUsingLTO() const
Returns true if we are performing any kind of LTO.
Definition: Driver.h:530
std::string DyldPrefix
Dynamic loader prefix, if present.
Definition: Driver.h:150
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
const IncludeDirsFunc & filePathsCallback() const
Definition: Multilib.h:186
LTOKind getLTOMode() const
Get the specific kind of LTO being performed.
Definition: Driver.h:533
DiagnosticBuilder Diag(unsigned DiagID) const
Definition: Driver.h:108
void AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for...
Definition: Fuchsia.cpp:300
virtual void addProfileRTLibs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass a suitable profile runtime ...
Definition: ToolChain.cpp:710
std::string GetLinkerPath() const
Returns the linker path, respecting the -fuse-ld= argument to determine the linker suffix or name...
Definition: ToolChain.cpp:492
bool select(const Multilib::flags_list &Flags, Multilib &M) const
Pick the best multilib in the set,.
Definition: Multilib.cpp:244
const char * getFilename() const
Definition: InputInfo.h:83
path_list & getProgramPaths()
Definition: ToolChain.h:234
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:119
void AddGoldPlugin(const ToolChain &ToolChain, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const InputInfo &Output, const InputInfo &Input, bool IsThinLTO)
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addMultilibFlag(bool Enabled, const char *const Flag, Multilib::flags_list &Flags)
Flag must be a flag accepted by the driver with its leading &#39;-&#39; removed,
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
std::string GetFilePath(const char *Name) const
Definition: ToolChain.cpp:484
path_list & getFilePaths()
Definition: ToolChain.h:231
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:57
void linkXRayRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
Tool * buildLinker() const override
Definition: Fuchsia.cpp:228
RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const override
Definition: Fuchsia.cpp:232
virtual Optional< std::string > getCXXStdlibPath() const
Definition: ToolChain.cpp:427
std::vector< std::string > flags_list
Definition: Multilib.h:30
void push_back(const Multilib &M)
Add a completed Multilib to the set.
Definition: Multilib.cpp:232
void addCommand(std::unique_ptr< Command > C)
Definition: Compilation.h:205
This corresponds to a single GCC Multilib, or a segment of one controlled by a command line flag...
Definition: Multilib.h:28
void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition: Fuchsia.cpp:319
SanitizerMask getSupportedSanitizers() const override
Return sanitizers which are available in this toolchain.
Definition: Fuchsia.cpp:331
void AddFilePathLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
Definition: ToolChain.cpp:858
const Driver & getDriver() const
Definition: ToolChain.h:193
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: Fuchsia.cpp:264
bool CCCIsCXX() const
Whether the driver should follow g++ like behavior.
Definition: Driver.h:172
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
Definition: ToolChain.cpp:782
llvm::vfs::FileSystem & getVFS() const
Definition: ToolChain.cpp:97
MultilibSet & setFilePathsCallback(IncludeDirsFunc F)
Definition: Multilib.h:181
bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const
Returns if the C++ standard library should be linked in.
Definition: ToolChain.cpp:835
Dataflow Directional Tag Classes.
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
std::string SysRoot
sysroot, if present
Definition: Driver.h:147
Tool - Information on a specific compilation tool.
Definition: Tool.h:33
const SanitizerArgs & getSanitizerArgs() const
Definition: ToolChain.cpp:115
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
virtual SanitizerMask getSupportedSanitizers() const
Return sanitizers which are available in this toolchain.
Definition: ToolChain.cpp:894
MultilibSet & FilterOut(FilterCallback F)
Filter out some subset of the Multilibs using a user defined callback.
Definition: Multilib.cpp:212
std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args, types::ID InputType) const override
ComputeEffectiveClangTriple - Return the Clang triple to use for this target, which may take into acc...
Definition: Fuchsia.cpp:222
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, Action::OffloadKind DeviceOffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition: Fuchsia.cpp:256
CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override
Definition: Fuchsia.cpp:245
Fuchsia(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Fuchsia - Fuchsia tool chain which can call as(1) and ld(1) directly.
Definition: Fuchsia.cpp:162
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:88
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:131