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