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