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