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