xref: /freebsd/contrib/llvm-project/clang/lib/Driver/ToolChains/Solaris.cpp (revision bc7512cc58af2e8bbe5bbf5ca0059b1daa1da897)
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, ResponseFileSupport::None(),
45                                          Exec, CmdArgs, Inputs, Output));
46 }
47 
48 void 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     // LLVM support for atomics on 32-bit SPARC V8+ is incomplete, so
136     // forcibly link with libatomic as a workaround.
137     if (getToolChain().getTriple().getArch() == llvm::Triple::sparc) {
138       CmdArgs.push_back(getAsNeededOption(getToolChain(), true));
139       CmdArgs.push_back("-latomic");
140       CmdArgs.push_back(getAsNeededOption(getToolChain(), false));
141     }
142     CmdArgs.push_back("-lgcc_s");
143     CmdArgs.push_back("-lc");
144     if (!Args.hasArg(options::OPT_shared)) {
145       CmdArgs.push_back("-lgcc");
146       CmdArgs.push_back("-lm");
147     }
148     if (NeedsSanitizerDeps)
149       linkSanitizerRuntimeDeps(getToolChain(), CmdArgs);
150   }
151 
152   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
153     CmdArgs.push_back(
154         Args.MakeArgString(getToolChain().GetFilePath("crtend.o")));
155   }
156   CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath("crtn.o")));
157 
158   getToolChain().addProfileRTLibs(Args, CmdArgs);
159 
160   const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
161   C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
162                                          Exec, CmdArgs, Inputs, Output));
163 }
164 
165 static StringRef getSolarisLibSuffix(const llvm::Triple &Triple) {
166   switch (Triple.getArch()) {
167   case llvm::Triple::x86:
168   case llvm::Triple::sparc:
169     break;
170   case llvm::Triple::x86_64:
171     return "/amd64";
172   case llvm::Triple::sparcv9:
173     return "/sparcv9";
174   default:
175     llvm_unreachable("Unsupported architecture");
176   }
177   return "";
178 }
179 
180 /// Solaris - Solaris tool chain which can call as(1) and ld(1) directly.
181 
182 Solaris::Solaris(const Driver &D, const llvm::Triple &Triple,
183                  const ArgList &Args)
184     : Generic_ELF(D, Triple, Args) {
185 
186   GCCInstallation.init(Triple, Args);
187 
188   StringRef LibSuffix = getSolarisLibSuffix(Triple);
189   path_list &Paths = getFilePaths();
190   if (GCCInstallation.isValid()) {
191     // On Solaris gcc uses both an architecture-specific path with triple in it
192     // as well as a more generic lib path (+arch suffix).
193     addPathIfExists(D,
194                     GCCInstallation.getInstallPath() +
195                         GCCInstallation.getMultilib().gccSuffix(),
196                     Paths);
197     addPathIfExists(D, GCCInstallation.getParentLibPath() + LibSuffix, Paths);
198   }
199 
200   // If we are currently running Clang inside of the requested system root,
201   // add its parent library path to those searched.
202   if (StringRef(D.Dir).startswith(D.SysRoot))
203     addPathIfExists(D, D.Dir + "/../lib", Paths);
204 
205   addPathIfExists(D, D.SysRoot + "/usr/lib" + LibSuffix, Paths);
206 }
207 
208 SanitizerMask Solaris::getSupportedSanitizers() const {
209   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
210   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
211   SanitizerMask Res = ToolChain::getSupportedSanitizers();
212   // FIXME: Omit X86_64 until 64-bit support is figured out.
213   if (IsX86) {
214     Res |= SanitizerKind::Address;
215     Res |= SanitizerKind::PointerCompare;
216     Res |= SanitizerKind::PointerSubtract;
217   }
218   if (IsX86 || IsX86_64)
219     Res |= SanitizerKind::Function;
220   Res |= SanitizerKind::Vptr;
221   return Res;
222 }
223 
224 Tool *Solaris::buildAssembler() const {
225   return new tools::solaris::Assembler(*this);
226 }
227 
228 Tool *Solaris::buildLinker() const { return new tools::solaris::Linker(*this); }
229 
230 void Solaris::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
231                                         ArgStringList &CC1Args) const {
232   const Driver &D = getDriver();
233 
234   if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
235     return;
236 
237   if (!DriverArgs.hasArg(options::OPT_nostdlibinc))
238     addSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/local/include");
239 
240   if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
241     SmallString<128> P(D.ResourceDir);
242     llvm::sys::path::append(P, "include");
243     addSystemInclude(DriverArgs, CC1Args, P);
244   }
245 
246   if (DriverArgs.hasArg(options::OPT_nostdlibinc))
247     return;
248 
249   // Check for configure-time C include directories.
250   StringRef CIncludeDirs(C_INCLUDE_DIRS);
251   if (CIncludeDirs != "") {
252     SmallVector<StringRef, 5> dirs;
253     CIncludeDirs.split(dirs, ":");
254     for (StringRef dir : dirs) {
255       StringRef Prefix =
256           llvm::sys::path::is_absolute(dir) ? "" : StringRef(D.SysRoot);
257       addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
258     }
259     return;
260   }
261 
262   // Add include directories specific to the selected multilib set and multilib.
263   if (GCCInstallation.isValid()) {
264     const MultilibSet::IncludeDirsFunc &Callback =
265         Multilibs.includeDirsCallback();
266     if (Callback) {
267       for (const auto &Path : Callback(GCCInstallation.getMultilib()))
268         addExternCSystemIncludeIfExists(
269             DriverArgs, CC1Args, GCCInstallation.getInstallPath() + Path);
270     }
271   }
272 
273   addExternCSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/include");
274 }
275 
276 void Solaris::addLibStdCxxIncludePaths(
277     const llvm::opt::ArgList &DriverArgs,
278     llvm::opt::ArgStringList &CC1Args) const {
279   // We need a detected GCC installation on Solaris (similar to Linux)
280   // to provide libstdc++'s headers.
281   if (!GCCInstallation.isValid())
282     return;
283 
284   // By default, look for the C++ headers in an include directory adjacent to
285   // the lib directory of the GCC installation.
286   // On Solaris this usually looks like /usr/gcc/X.Y/include/c++/X.Y.Z
287   StringRef LibDir = GCCInstallation.getParentLibPath();
288   StringRef TripleStr = GCCInstallation.getTriple().str();
289   const Multilib &Multilib = GCCInstallation.getMultilib();
290   const GCCVersion &Version = GCCInstallation.getVersion();
291 
292   // The primary search for libstdc++ supports multiarch variants.
293   addLibStdCXXIncludePaths(LibDir.str() + "/../include/c++/" + Version.Text,
294                            TripleStr, Multilib.includeSuffix(), DriverArgs,
295                            CC1Args);
296 }
297