1//===--- Solaris.cpp - Solaris 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 "Solaris.h"
10#include "CommonArgs.h"
11#include "clang/Basic/LangStandard.h"
12#include "clang/Config/config.h"
13#include "clang/Driver/Compilation.h"
14#include "clang/Driver/Driver.h"
15#include "clang/Driver/DriverDiagnostic.h"
16#include "clang/Driver/Options.h"
17#include "llvm/Option/ArgList.h"
18#include "llvm/Support/FileSystem.h"
19#include "llvm/Support/Path.h"
20
21using namespace clang::driver;
22using namespace clang::driver::tools;
23using namespace clang::driver::toolchains;
24using namespace clang;
25using namespace llvm::opt;
26
27void solaris::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
28                                      const InputInfo &Output,
29                                      const InputInfoList &Inputs,
30                                      const ArgList &Args,
31                                      const char *LinkingOutput) const {
32  claimNoWarnArgs(Args);
33  ArgStringList CmdArgs;
34
35  Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
36
37  CmdArgs.push_back("-o");
38  CmdArgs.push_back(Output.getFilename());
39
40  for (const auto &II : Inputs)
41    CmdArgs.push_back(II.getFilename());
42
43  const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
44  C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
45                                         Exec, CmdArgs, Inputs, Output));
46}
47
48void solaris::Linker::ConstructJob(Compilation &C, const JobAction &JA,
49                                   const InputInfo &Output,
50                                   const InputInfoList &Inputs,
51                                   const ArgList &Args,
52                                   const char *LinkingOutput) const {
53  ArgStringList CmdArgs;
54
55  // Demangle C++ names in errors
56  CmdArgs.push_back("-C");
57
58  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_shared)) {
59    CmdArgs.push_back("-e");
60    CmdArgs.push_back("_start");
61  }
62
63  if (Args.hasArg(options::OPT_static)) {
64    CmdArgs.push_back("-Bstatic");
65    CmdArgs.push_back("-dn");
66  } else {
67    CmdArgs.push_back("-Bdynamic");
68    if (Args.hasArg(options::OPT_shared)) {
69      CmdArgs.push_back("-shared");
70    }
71
72    // libpthread has been folded into libc since Solaris 10, no need to do
73    // anything for pthreads. Claim argument to avoid warning.
74    Args.ClaimAllArgs(options::OPT_pthread);
75    Args.ClaimAllArgs(options::OPT_pthreads);
76  }
77
78  if (Output.isFilename()) {
79    CmdArgs.push_back("-o");
80    CmdArgs.push_back(Output.getFilename());
81  } else {
82    assert(Output.isNothing() && "Invalid output.");
83  }
84
85  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
86    if (!Args.hasArg(options::OPT_shared))
87      CmdArgs.push_back(
88          Args.MakeArgString(getToolChain().GetFilePath("crt1.o")));
89
90    CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath("crti.o")));
91
92    const Arg *Std = Args.getLastArg(options::OPT_std_EQ, options::OPT_ansi);
93    bool HaveAnsi = false;
94    const LangStandard *LangStd = nullptr;
95    if (Std) {
96      HaveAnsi = Std->getOption().matches(options::OPT_ansi);
97      if (!HaveAnsi)
98        LangStd = LangStandard::getLangStandardForName(Std->getValue());
99    }
100
101    const char *values_X = "values-Xa.o";
102    // Use values-Xc.o for -ansi, -std=c*, -std=iso9899:199409.
103    if (HaveAnsi || (LangStd && !LangStd->isGNUMode()))
104      values_X = "values-Xc.o";
105    CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath(values_X)));
106
107    const char *values_xpg = "values-xpg6.o";
108    // Use values-xpg4.o for -std=c90, -std=gnu90, -std=iso9899:199409.
109    if (LangStd && LangStd->getLanguage() == Language::C && !LangStd->isC99())
110      values_xpg = "values-xpg4.o";
111    CmdArgs.push_back(
112        Args.MakeArgString(getToolChain().GetFilePath(values_xpg)));
113    CmdArgs.push_back(
114        Args.MakeArgString(getToolChain().GetFilePath("crtbegin.o")));
115  }
116
117  getToolChain().AddFilePathLibArgs(Args, CmdArgs);
118
119  Args.AddAllArgs(CmdArgs, {options::OPT_L, options::OPT_T_Group,
120                            options::OPT_e, options::OPT_r});
121
122  bool NeedsSanitizerDeps = addSanitizerRuntimes(getToolChain(), Args, CmdArgs);
123  AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
124
125  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
126    if (getToolChain().ShouldLinkCXXStdlib(Args))
127      getToolChain().AddCXXStdlibLibArgs(Args, CmdArgs);
128    if (Args.hasArg(options::OPT_fstack_protector) ||
129        Args.hasArg(options::OPT_fstack_protector_strong) ||
130        Args.hasArg(options::OPT_fstack_protector_all)) {
131      // Explicitly link ssp libraries, not folded into Solaris libc.
132      CmdArgs.push_back("-lssp_nonshared");
133      CmdArgs.push_back("-lssp");
134    }
135    CmdArgs.push_back("-lgcc_s");
136    CmdArgs.push_back("-lc");
137    if (!Args.hasArg(options::OPT_shared)) {
138      CmdArgs.push_back("-lgcc");
139      CmdArgs.push_back("-lm");
140    }
141    if (NeedsSanitizerDeps)
142      linkSanitizerRuntimeDeps(getToolChain(), CmdArgs);
143  }
144
145  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
146    CmdArgs.push_back(
147        Args.MakeArgString(getToolChain().GetFilePath("crtend.o")));
148  }
149  CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath("crtn.o")));
150
151  getToolChain().addProfileRTLibs(Args, CmdArgs);
152
153  const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
154  C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
155                                         Exec, CmdArgs, Inputs, Output));
156}
157
158static StringRef getSolarisLibSuffix(const llvm::Triple &Triple) {
159  switch (Triple.getArch()) {
160  case llvm::Triple::x86:
161  case llvm::Triple::sparc:
162    break;
163  case llvm::Triple::x86_64:
164    return "/amd64";
165  case llvm::Triple::sparcv9:
166    return "/sparcv9";
167  default:
168    llvm_unreachable("Unsupported architecture");
169  }
170  return "";
171}
172
173/// Solaris - Solaris tool chain which can call as(1) and ld(1) directly.
174
175Solaris::Solaris(const Driver &D, const llvm::Triple &Triple,
176                 const ArgList &Args)
177    : Generic_ELF(D, Triple, Args) {
178
179  GCCInstallation.init(Triple, Args);
180
181  StringRef LibSuffix = getSolarisLibSuffix(Triple);
182  path_list &Paths = getFilePaths();
183  if (GCCInstallation.isValid()) {
184    // On Solaris gcc uses both an architecture-specific path with triple in it
185    // as well as a more generic lib path (+arch suffix).
186    addPathIfExists(D,
187                    GCCInstallation.getInstallPath() +
188                        GCCInstallation.getMultilib().gccSuffix(),
189                    Paths);
190    addPathIfExists(D, GCCInstallation.getParentLibPath() + LibSuffix, Paths);
191  }
192
193  // If we are currently running Clang inside of the requested system root,
194  // add its parent library path to those searched.
195  if (StringRef(D.Dir).startswith(D.SysRoot))
196    addPathIfExists(D, D.Dir + "/../lib", Paths);
197
198  addPathIfExists(D, D.SysRoot + "/usr/lib" + LibSuffix, Paths);
199}
200
201SanitizerMask Solaris::getSupportedSanitizers() const {
202  const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
203  const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
204  SanitizerMask Res = ToolChain::getSupportedSanitizers();
205  // FIXME: Omit X86_64 until 64-bit support is figured out.
206  if (IsX86) {
207    Res |= SanitizerKind::Address;
208    Res |= SanitizerKind::PointerCompare;
209    Res |= SanitizerKind::PointerSubtract;
210  }
211  if (IsX86 || IsX86_64)
212    Res |= SanitizerKind::Function;
213  Res |= SanitizerKind::Vptr;
214  return Res;
215}
216
217Tool *Solaris::buildAssembler() const {
218  return new tools::solaris::Assembler(*this);
219}
220
221Tool *Solaris::buildLinker() const { return new tools::solaris::Linker(*this); }
222
223void Solaris::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
224                                        ArgStringList &CC1Args) const {
225  const Driver &D = getDriver();
226
227  if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
228    return;
229
230  if (!DriverArgs.hasArg(options::OPT_nostdlibinc))
231    addSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/local/include");
232
233  if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
234    SmallString<128> P(D.ResourceDir);
235    llvm::sys::path::append(P, "include");
236    addSystemInclude(DriverArgs, CC1Args, P);
237  }
238
239  if (DriverArgs.hasArg(options::OPT_nostdlibinc))
240    return;
241
242  // Check for configure-time C include directories.
243  StringRef CIncludeDirs(C_INCLUDE_DIRS);
244  if (CIncludeDirs != "") {
245    SmallVector<StringRef, 5> dirs;
246    CIncludeDirs.split(dirs, ":");
247    for (StringRef dir : dirs) {
248      StringRef Prefix =
249          llvm::sys::path::is_absolute(dir) ? "" : StringRef(D.SysRoot);
250      addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
251    }
252    return;
253  }
254
255  // Add include directories specific to the selected multilib set and multilib.
256  if (GCCInstallation.isValid()) {
257    const MultilibSet::IncludeDirsFunc &Callback =
258        Multilibs.includeDirsCallback();
259    if (Callback) {
260      for (const auto &Path : Callback(GCCInstallation.getMultilib()))
261        addExternCSystemIncludeIfExists(
262            DriverArgs, CC1Args, GCCInstallation.getInstallPath() + Path);
263    }
264  }
265
266  addExternCSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/include");
267}
268
269void Solaris::addLibStdCxxIncludePaths(
270    const llvm::opt::ArgList &DriverArgs,
271    llvm::opt::ArgStringList &CC1Args) const {
272  // We need a detected GCC installation on Solaris (similar to Linux)
273  // to provide libstdc++'s headers.
274  if (!GCCInstallation.isValid())
275    return;
276
277  // By default, look for the C++ headers in an include directory adjacent to
278  // the lib directory of the GCC installation.
279  // On Solaris this usually looks like /usr/gcc/X.Y/include/c++/X.Y.Z
280  StringRef LibDir = GCCInstallation.getParentLibPath();
281  StringRef TripleStr = GCCInstallation.getTriple().str();
282  const Multilib &Multilib = GCCInstallation.getMultilib();
283  const GCCVersion &Version = GCCInstallation.getVersion();
284
285  // The primary search for libstdc++ supports multiarch variants.
286  addLibStdCXXIncludePaths(LibDir.str() + "/../include/c++/" + Version.Text,
287                           TripleStr, Multilib.includeSuffix(), DriverArgs,
288                           CC1Args);
289}
290