clang 17.0.0git
Solaris.cpp
Go to the documentation of this file.
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"
12#include "clang/Config/config.h"
14#include "clang/Driver/Driver.h"
19#include "llvm/Option/ArgList.h"
20#include "llvm/Support/FileSystem.h"
21#include "llvm/Support/Path.h"
22
23using namespace clang::driver;
24using namespace clang::driver::tools;
25using namespace clang::driver::toolchains;
26using namespace clang;
27using namespace llvm::opt;
28
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
51 const InputInfo &Output,
52 const InputInfoList &Inputs,
53 const ArgList &Args,
54 const char *LinkingOutput) const {
55 ArgStringList CmdArgs;
56
57 // Demangle C++ names in errors
58 CmdArgs.push_back("-C");
59
60 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_shared)) {
61 CmdArgs.push_back("-e");
62 CmdArgs.push_back("_start");
63 }
64
65 if (Args.hasArg(options::OPT_static)) {
66 CmdArgs.push_back("-Bstatic");
67 CmdArgs.push_back("-dn");
68 } else {
69 CmdArgs.push_back("-Bdynamic");
70 if (Args.hasArg(options::OPT_shared)) {
71 CmdArgs.push_back("-shared");
72 }
73
74 // libpthread has been folded into libc since Solaris 10, no need to do
75 // anything for pthreads. Claim argument to avoid warning.
76 Args.ClaimAllArgs(options::OPT_pthread);
77 Args.ClaimAllArgs(options::OPT_pthreads);
78 }
79
80 if (Output.isFilename()) {
81 CmdArgs.push_back("-o");
82 CmdArgs.push_back(Output.getFilename());
83 } else {
84 assert(Output.isNothing() && "Invalid output.");
85 }
86
87 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,
88 options::OPT_r)) {
89 if (!Args.hasArg(options::OPT_shared))
90 CmdArgs.push_back(
91 Args.MakeArgString(getToolChain().GetFilePath("crt1.o")));
92
93 CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath("crti.o")));
94
95 const Arg *Std = Args.getLastArg(options::OPT_std_EQ, options::OPT_ansi);
96 bool HaveAnsi = false;
97 const LangStandard *LangStd = nullptr;
98 if (Std) {
99 HaveAnsi = Std->getOption().matches(options::OPT_ansi);
100 if (!HaveAnsi)
101 LangStd = LangStandard::getLangStandardForName(Std->getValue());
102 }
103
104 const char *values_X = "values-Xa.o";
105 // Use values-Xc.o for -ansi, -std=c*, -std=iso9899:199409.
106 if (HaveAnsi || (LangStd && !LangStd->isGNUMode()))
107 values_X = "values-Xc.o";
108 CmdArgs.push_back(Args.MakeArgString(getToolChain().GetFilePath(values_X)));
109
110 const char *values_xpg = "values-xpg6.o";
111 // Use values-xpg4.o for -std=c90, -std=gnu90, -std=iso9899:199409.
112 if (LangStd && LangStd->getLanguage() == Language::C && !LangStd->isC99())
113 values_xpg = "values-xpg4.o";
114 CmdArgs.push_back(
115 Args.MakeArgString(getToolChain().GetFilePath(values_xpg)));
116 CmdArgs.push_back(
117 Args.MakeArgString(getToolChain().GetFilePath("crtbegin.o")));
118 // Add crtfastmath.o if available and fast math is enabled.
119 getToolChain().addFastMathRuntimeIfAvailable(Args, CmdArgs);
120 }
121
122 getToolChain().AddFilePathLibArgs(Args, CmdArgs);
123
124 Args.AddAllArgs(CmdArgs, {options::OPT_L, options::OPT_T_Group,
125 options::OPT_e, options::OPT_r});
126
127 bool NeedsSanitizerDeps = addSanitizerRuntimes(getToolChain(), Args, CmdArgs);
128 AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
129
130 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs,
131 options::OPT_r)) {
132 if (getToolChain().ShouldLinkCXXStdlib(Args))
133 getToolChain().AddCXXStdlibLibArgs(Args, CmdArgs);
134 if (Args.hasArg(options::OPT_fstack_protector) ||
135 Args.hasArg(options::OPT_fstack_protector_strong) ||
136 Args.hasArg(options::OPT_fstack_protector_all)) {
137 // Explicitly link ssp libraries, not folded into Solaris libc.
138 CmdArgs.push_back("-lssp_nonshared");
139 CmdArgs.push_back("-lssp");
140 }
141 // LLVM support for atomics on 32-bit SPARC V8+ is incomplete, so
142 // forcibly link with libatomic as a workaround.
143 if (getToolChain().getTriple().getArch() == llvm::Triple::sparc) {
144 CmdArgs.push_back(getAsNeededOption(getToolChain(), true));
145 CmdArgs.push_back("-latomic");
146 CmdArgs.push_back(getAsNeededOption(getToolChain(), false));
147 }
148 CmdArgs.push_back("-lgcc_s");
149 CmdArgs.push_back("-lc");
150 if (!Args.hasArg(options::OPT_shared)) {
151 CmdArgs.push_back("-lgcc");
152 CmdArgs.push_back("-lm");
153 }
154 if (NeedsSanitizerDeps) {
155 linkSanitizerRuntimeDeps(getToolChain(), CmdArgs);
156
157 // Work around Solaris/amd64 ld bug when calling __tls_get_addr directly.
158 // However, ld -z relax=transtls is available since Solaris 11.2, but not
159 // in Illumos.
160 const SanitizerArgs &SA = getToolChain().getSanitizerArgs(Args);
161 if (getToolChain().getTriple().getArch() == llvm::Triple::x86_64 &&
162 (SA.needsAsanRt() || SA.needsStatsRt() ||
163 (SA.needsUbsanRt() && !SA.requiresMinimalRuntime())))
164 CmdArgs.push_back("-zrelax=transtls");
165 }
166 }
167
168 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles,
169 options::OPT_r)) {
170 CmdArgs.push_back(
171 Args.MakeArgString(getToolChain().GetFilePath("crtend.o")));
172 CmdArgs.push_back(
173 Args.MakeArgString(getToolChain().GetFilePath("crtn.o")));
174 }
175
176 getToolChain().addProfileRTLibs(Args, CmdArgs);
177
178 const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath());
179 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
180 Exec, CmdArgs, Inputs, Output));
181}
182
183static StringRef getSolarisLibSuffix(const llvm::Triple &Triple) {
184 switch (Triple.getArch()) {
185 case llvm::Triple::x86:
186 case llvm::Triple::sparc:
187 break;
188 case llvm::Triple::x86_64:
189 return "/amd64";
190 case llvm::Triple::sparcv9:
191 return "/sparcv9";
192 default:
193 llvm_unreachable("Unsupported architecture");
194 }
195 return "";
196}
197
198/// Solaris - Solaris tool chain which can call as(1) and ld(1) directly.
199
200Solaris::Solaris(const Driver &D, const llvm::Triple &Triple,
201 const ArgList &Args)
202 : Generic_ELF(D, Triple, Args) {
203
204 GCCInstallation.init(Triple, Args);
205
206 StringRef LibSuffix = getSolarisLibSuffix(Triple);
207 path_list &Paths = getFilePaths();
208 if (GCCInstallation.isValid()) {
209 // On Solaris gcc uses both an architecture-specific path with triple in it
210 // as well as a more generic lib path (+arch suffix).
214 Paths);
215 addPathIfExists(D, GCCInstallation.getParentLibPath() + LibSuffix, Paths);
216 }
217
218 // If we are currently running Clang inside of the requested system root,
219 // add its parent library path to those searched.
220 if (StringRef(D.Dir).startswith(D.SysRoot))
221 addPathIfExists(D, D.Dir + "/../lib", Paths);
222
223 addPathIfExists(D, D.SysRoot + "/usr/lib" + LibSuffix, Paths);
224}
225
227 const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
228 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
230 // FIXME: Omit X86_64 until 64-bit support is figured out.
231 if (IsX86) {
232 Res |= SanitizerKind::Address;
233 Res |= SanitizerKind::PointerCompare;
234 Res |= SanitizerKind::PointerSubtract;
235 }
236 if (IsX86 || IsX86_64)
237 Res |= SanitizerKind::Function;
238 Res |= SanitizerKind::Vptr;
239 return Res;
240}
241
243 return new tools::solaris::Assembler(*this);
244}
245
246Tool *Solaris::buildLinker() const { return new tools::solaris::Linker(*this); }
247
248void Solaris::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
249 ArgStringList &CC1Args) const {
250 const Driver &D = getDriver();
251
252 if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
253 return;
254
255 if (!DriverArgs.hasArg(options::OPT_nostdlibinc))
256 addSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/local/include");
257
258 if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
260 llvm::sys::path::append(P, "include");
261 addSystemInclude(DriverArgs, CC1Args, P);
262 }
263
264 if (DriverArgs.hasArg(options::OPT_nostdlibinc))
265 return;
266
267 // Check for configure-time C include directories.
268 StringRef CIncludeDirs(C_INCLUDE_DIRS);
269 if (CIncludeDirs != "") {
271 CIncludeDirs.split(dirs, ":");
272 for (StringRef dir : dirs) {
273 StringRef Prefix =
274 llvm::sys::path::is_absolute(dir) ? "" : StringRef(D.SysRoot);
275 addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
276 }
277 return;
278 }
279
280 // Add include directories specific to the selected multilib set and multilib.
281 if (GCCInstallation.isValid()) {
282 const MultilibSet::IncludeDirsFunc &Callback =
284 if (Callback) {
285 for (const auto &Path : Callback(GCCInstallation.getMultilib()))
287 DriverArgs, CC1Args, GCCInstallation.getInstallPath() + Path);
288 }
289 }
290
291 addExternCSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/include");
292}
293
295 const llvm::opt::ArgList &DriverArgs,
296 llvm::opt::ArgStringList &CC1Args) const {
297 // We need a detected GCC installation on Solaris (similar to Linux)
298 // to provide libstdc++'s headers.
300 return;
301
302 // By default, look for the C++ headers in an include directory adjacent to
303 // the lib directory of the GCC installation.
304 // On Solaris this usually looks like /usr/gcc/X.Y/include/c++/X.Y.Z
305 StringRef LibDir = GCCInstallation.getParentLibPath();
306 StringRef TripleStr = GCCInstallation.getTriple().str();
308 const GCCVersion &Version = GCCInstallation.getVersion();
309
310 // The primary search for libstdc++ supports multiarch variants.
311 addLibStdCXXIncludePaths(LibDir.str() + "/../include/c++/" + Version.Text,
312 TripleStr, Multilib.includeSuffix(), DriverArgs,
313 CC1Args);
314}
StringRef P
LangStandard::Kind Std
static StringRef getSolarisLibSuffix(const llvm::Triple &Triple)
Definition: Solaris.cpp:183
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
std::string SysRoot
sysroot, if present
Definition: Driver.h:183
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:167
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:155
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getFilename() const
Definition: InputInfo.h:83
bool isNothing() const
Definition: InputInfo.h:74
bool isFilename() const
Definition: InputInfo.h:75
const IncludeDirsFunc & includeDirsCallback() const
Definition: Multilib.h:122
std::function< std::vector< std::string >(const Multilib &M)> IncludeDirsFunc
Definition: Multilib.h:83
This corresponds to a single GCC Multilib, or a segment of one controlled by a command line flag.
Definition: Multilib.h:30
const std::string & gccSuffix() const
Get the detected GCC installation path suffix for the multi-arch target variant.
Definition: Multilib.h:50
const std::string & includeSuffix() const
Get the include directory suffix.
Definition: Multilib.h:58
bool requiresMinimalRuntime() const
Definition: SanitizerArgs.h:97
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
Definition: ToolChain.cpp:969
static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory with extern "C" semantics to CC1 arguments.
Definition: ToolChain.cpp:984
path_list & getFilePaths()
Definition: ToolChain.h:278
const Driver & getDriver() const
Definition: ToolChain.h:236
static void addExternCSystemIncludeIfExists(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Definition: ToolChain.cpp:991
const llvm::Triple & getTriple() const
Definition: ToolChain.h:238
virtual SanitizerMask getSupportedSanitizers() const
Return sanitizers which are available in this toolchain.
Definition: ToolChain.cpp:1144
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const ToolChain & getToolChain() const
Definition: Tool.h:52
const Multilib & getMultilib() const
Get the detected Multilib.
Definition: Gnu.h:237
const llvm::Triple & getTriple() const
Get the GCC triple for the detected install.
Definition: Gnu.h:228
bool isValid() const
Check whether we detected a valid GCC install.
Definition: Gnu.h:225
StringRef getParentLibPath() const
Get the detected GCC parent lib path.
Definition: Gnu.h:234
StringRef getInstallPath() const
Get the detected GCC installation path.
Definition: Gnu.h:231
void init(const llvm::Triple &TargetTriple, const llvm::opt::ArgList &Args, ArrayRef< std::string > ExtraTripleAliases=std::nullopt)
Initialize a GCCInstallationDetector from the driver.
Definition: Gnu.cpp:2041
const GCCVersion & getVersion() const
Get the detected GCC version string.
Definition: Gnu.h:247
GCCInstallationDetector GCCInstallation
Definition: Gnu.h:289
bool addLibStdCXXIncludePaths(Twine IncludeDir, StringRef Triple, Twine IncludeSuffix, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, bool DetectDebian=false) const
Definition: Gnu.cpp:3094
SanitizerMask getSupportedSanitizers() const override
Return sanitizers which are available in this toolchain.
Definition: Solaris.cpp:226
Solaris(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Solaris - Solaris tool chain which can call as(1) and ld(1) directly.
Definition: Solaris.cpp:200
Tool * buildLinker() const override
Definition: Solaris.cpp:246
Tool * buildAssembler() const override
Definition: Solaris.cpp:242
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: Solaris.cpp:248
void addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Definition: Solaris.cpp:294
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: Solaris.cpp:29
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: Solaris.cpp:50
const char * getAsNeededOption(const ToolChain &TC, bool as_needed)
Definition: CommonArgs.cpp:943
bool addSanitizerRuntimes(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:134
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
void linkSanitizerRuntimeDeps(const ToolChain &TC, llvm::opt::ArgStringList &CmdArgs)
@ C
Languages that the frontend can parse and compile.
LangStandard - Information about the properties of a particular language standard.
Definition: LangStandard.h:68
static const LangStandard * getLangStandardForName(StringRef Name)
clang::Language getLanguage() const
Get the language that this standard describes.
Definition: LangStandard.h:89
bool isGNUMode() const
isGNUMode - Language includes GNU extensions.
Definition: LangStandard.h:128
bool isC99() const
isC99 - Language is a superset of C99.
Definition: LangStandard.h:95
static constexpr ResponseFileSupport None()
Returns a ResponseFileSupport indicating that response files are not supported.
Definition: Job.h:78
Struct to store and manipulate GCC versions.
Definition: Gnu.h:162
std::string Text
The unparsed text of the version.
Definition: Gnu.h:164