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