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