1 //===--- FreeBSD.cpp - FreeBSD 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 "FreeBSD.h" 10 #include "Arch/ARM.h" 11 #include "Arch/Mips.h" 12 #include "Arch/Sparc.h" 13 #include "CommonArgs.h" 14 #include "clang/Config/config.h" 15 #include "clang/Driver/Compilation.h" 16 #include "clang/Driver/DriverDiagnostic.h" 17 #include "clang/Driver/Options.h" 18 #include "clang/Driver/SanitizerArgs.h" 19 #include "llvm/Option/ArgList.h" 20 #include "llvm/Support/VirtualFileSystem.h" 21 22 using namespace clang::driver; 23 using namespace clang::driver::tools; 24 using namespace clang::driver::toolchains; 25 using namespace clang; 26 using namespace llvm::opt; 27 28 void freebsd::Assembler::ConstructJob(Compilation &C, const JobAction &JA, 29 const InputInfo &Output, 30 const InputInfoList &Inputs, 31 const ArgList &Args, 32 const char *LinkingOutput) const { 33 const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain()); 34 const auto &D = getToolChain().getDriver(); 35 const llvm::Triple &Triple = ToolChain.getTriple(); 36 ArgStringList CmdArgs; 37 38 claimNoWarnArgs(Args); 39 40 // When building 32-bit code on FreeBSD/amd64, we have to explicitly 41 // instruct as in the base system to assemble 32-bit code. 42 switch (ToolChain.getArch()) { 43 default: 44 break; 45 case llvm::Triple::x86: 46 CmdArgs.push_back("--32"); 47 break; 48 case llvm::Triple::ppc: 49 case llvm::Triple::ppcle: 50 CmdArgs.push_back("-a32"); 51 break; 52 case llvm::Triple::mips: 53 case llvm::Triple::mipsel: 54 case llvm::Triple::mips64: 55 case llvm::Triple::mips64el: { 56 StringRef CPUName; 57 StringRef ABIName; 58 mips::getMipsCPUAndABI(Args, Triple, CPUName, ABIName); 59 60 CmdArgs.push_back("-march"); 61 CmdArgs.push_back(CPUName.data()); 62 63 CmdArgs.push_back("-mabi"); 64 CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data()); 65 66 if (Triple.isLittleEndian()) 67 CmdArgs.push_back("-EL"); 68 else 69 CmdArgs.push_back("-EB"); 70 71 if (Arg *A = Args.getLastArg(options::OPT_G)) { 72 StringRef v = A->getValue(); 73 CmdArgs.push_back(Args.MakeArgString("-G" + v)); 74 A->claim(); 75 } 76 77 AddAssemblerKPIC(ToolChain, Args, CmdArgs); 78 break; 79 } 80 case llvm::Triple::arm: 81 case llvm::Triple::armeb: 82 case llvm::Triple::thumb: 83 case llvm::Triple::thumbeb: { 84 arm::FloatABI ABI = arm::getARMFloatABI(ToolChain, Args); 85 86 if (ABI == arm::FloatABI::Hard) 87 CmdArgs.push_back("-mfpu=vfp"); 88 else 89 CmdArgs.push_back("-mfpu=softvfp"); 90 91 CmdArgs.push_back("-meabi=5"); 92 break; 93 } 94 case llvm::Triple::sparcv9: { 95 std::string CPU = getCPUName(D, Args, Triple); 96 CmdArgs.push_back(sparc::getSparcAsmModeForCPU(CPU, Triple)); 97 AddAssemblerKPIC(ToolChain, Args, CmdArgs); 98 break; 99 } 100 } 101 102 for (const Arg *A : Args.filtered(options::OPT_ffile_prefix_map_EQ, 103 options::OPT_fdebug_prefix_map_EQ)) { 104 StringRef Map = A->getValue(); 105 if (!Map.contains('=')) 106 D.Diag(diag::err_drv_invalid_argument_to_option) 107 << Map << A->getOption().getName(); 108 else { 109 CmdArgs.push_back(Args.MakeArgString("--debug-prefix-map")); 110 CmdArgs.push_back(Args.MakeArgString(Map)); 111 } 112 A->claim(); 113 } 114 115 Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler); 116 117 CmdArgs.push_back("-o"); 118 CmdArgs.push_back(Output.getFilename()); 119 120 for (const auto &II : Inputs) 121 CmdArgs.push_back(II.getFilename()); 122 123 const char *Exec = Args.MakeArgString(ToolChain.GetProgramPath("as")); 124 C.addCommand(std::make_unique<Command>(JA, *this, 125 ResponseFileSupport::AtFileCurCP(), 126 Exec, CmdArgs, Inputs, Output)); 127 } 128 129 void freebsd::Linker::ConstructJob(Compilation &C, const JobAction &JA, 130 const InputInfo &Output, 131 const InputInfoList &Inputs, 132 const ArgList &Args, 133 const char *LinkingOutput) const { 134 const auto &ToolChain = static_cast<const FreeBSD &>(getToolChain()); 135 const Driver &D = ToolChain.getDriver(); 136 const llvm::Triple &Triple = ToolChain.getTriple(); 137 const llvm::Triple::ArchType Arch = ToolChain.getArch(); 138 const bool IsPIE = 139 !Args.hasArg(options::OPT_shared) && 140 (Args.hasArg(options::OPT_pie) || ToolChain.isPIEDefault(Args)); 141 ArgStringList CmdArgs; 142 143 // Silence warning for "clang -g foo.o -o foo" 144 Args.ClaimAllArgs(options::OPT_g_Group); 145 // and "clang -emit-llvm foo.o -o foo" 146 Args.ClaimAllArgs(options::OPT_emit_llvm); 147 // and for "clang -w foo.o -o foo". Other warning options are already 148 // handled somewhere else. 149 Args.ClaimAllArgs(options::OPT_w); 150 151 if (!D.SysRoot.empty()) 152 CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot)); 153 154 if (IsPIE) 155 CmdArgs.push_back("-pie"); 156 157 CmdArgs.push_back("--eh-frame-hdr"); 158 if (Args.hasArg(options::OPT_static)) { 159 CmdArgs.push_back("-Bstatic"); 160 } else { 161 if (Args.hasArg(options::OPT_rdynamic)) 162 CmdArgs.push_back("-export-dynamic"); 163 if (Args.hasArg(options::OPT_shared)) { 164 CmdArgs.push_back("-shared"); 165 } else if (!Args.hasArg(options::OPT_r)) { 166 CmdArgs.push_back("-dynamic-linker"); 167 CmdArgs.push_back("/libexec/ld-elf.so.1"); 168 } 169 if (Arch == llvm::Triple::arm || Triple.isX86()) 170 CmdArgs.push_back("--hash-style=both"); 171 CmdArgs.push_back("--enable-new-dtags"); 172 } 173 174 // Explicitly set the linker emulation for platforms that might not 175 // be the default emulation for the linker. 176 switch (Arch) { 177 case llvm::Triple::x86: 178 CmdArgs.push_back("-m"); 179 CmdArgs.push_back("elf_i386_fbsd"); 180 break; 181 case llvm::Triple::ppc: 182 CmdArgs.push_back("-m"); 183 CmdArgs.push_back("elf32ppc_fbsd"); 184 break; 185 case llvm::Triple::ppcle: 186 CmdArgs.push_back("-m"); 187 // Use generic -- only usage is for freestanding. 188 CmdArgs.push_back("elf32lppc"); 189 break; 190 case llvm::Triple::mips: 191 CmdArgs.push_back("-m"); 192 CmdArgs.push_back("elf32btsmip_fbsd"); 193 break; 194 case llvm::Triple::mipsel: 195 CmdArgs.push_back("-m"); 196 CmdArgs.push_back("elf32ltsmip_fbsd"); 197 break; 198 case llvm::Triple::mips64: 199 CmdArgs.push_back("-m"); 200 if (tools::mips::hasMipsAbiArg(Args, "n32")) 201 CmdArgs.push_back("elf32btsmipn32_fbsd"); 202 else 203 CmdArgs.push_back("elf64btsmip_fbsd"); 204 break; 205 case llvm::Triple::mips64el: 206 CmdArgs.push_back("-m"); 207 if (tools::mips::hasMipsAbiArg(Args, "n32")) 208 CmdArgs.push_back("elf32ltsmipn32_fbsd"); 209 else 210 CmdArgs.push_back("elf64ltsmip_fbsd"); 211 break; 212 case llvm::Triple::riscv64: 213 CmdArgs.push_back("-m"); 214 CmdArgs.push_back("elf64lriscv"); 215 break; 216 case llvm::Triple::loongarch64: 217 CmdArgs.push_back("-m"); 218 CmdArgs.push_back("elf64loongarch"); 219 break; 220 default: 221 break; 222 } 223 224 if (Triple.isLoongArch64() || Triple.isRISCV64()) { 225 CmdArgs.push_back("-X"); 226 if (Args.hasArg(options::OPT_mno_relax)) 227 CmdArgs.push_back("--no-relax"); 228 } 229 230 if (Arg *A = Args.getLastArg(options::OPT_G)) { 231 if (ToolChain.getTriple().isMIPS()) { 232 StringRef v = A->getValue(); 233 CmdArgs.push_back(Args.MakeArgString("-G" + v)); 234 A->claim(); 235 } 236 } 237 238 assert((Output.isFilename() || Output.isNothing()) && "Invalid output."); 239 if (Output.isFilename()) { 240 CmdArgs.push_back("-o"); 241 CmdArgs.push_back(Output.getFilename()); 242 } 243 244 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles, 245 options::OPT_r)) { 246 const char *crt1 = nullptr; 247 if (!Args.hasArg(options::OPT_shared)) { 248 if (Args.hasArg(options::OPT_pg)) 249 crt1 = "gcrt1.o"; 250 else if (IsPIE) 251 crt1 = "Scrt1.o"; 252 else 253 crt1 = "crt1.o"; 254 } 255 if (crt1) 256 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt1))); 257 258 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o"))); 259 260 const char *crtbegin = nullptr; 261 if (Args.hasArg(options::OPT_static)) 262 crtbegin = "crtbeginT.o"; 263 else if (Args.hasArg(options::OPT_shared) || IsPIE) 264 crtbegin = "crtbeginS.o"; 265 else 266 crtbegin = "crtbegin.o"; 267 268 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin))); 269 } 270 271 Args.AddAllArgs(CmdArgs, options::OPT_L); 272 ToolChain.AddFilePathLibArgs(Args, CmdArgs); 273 Args.addAllArgs(CmdArgs, 274 {options::OPT_T_Group, options::OPT_s, options::OPT_t}); 275 276 if (D.isUsingLTO()) { 277 assert(!Inputs.empty() && "Must have at least one input."); 278 // Find the first filename InputInfo object. 279 auto Input = llvm::find_if( 280 Inputs, [](const InputInfo &II) -> bool { return II.isFilename(); }); 281 if (Input == Inputs.end()) 282 // For a very rare case, all of the inputs to the linker are 283 // InputArg. If that happens, just use the first InputInfo. 284 Input = Inputs.begin(); 285 286 addLTOOptions(ToolChain, Args, CmdArgs, Output, *Input, 287 D.getLTOMode() == LTOK_Thin); 288 } 289 290 bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs); 291 bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs); 292 addLinkerCompressDebugSectionsOption(ToolChain, Args, CmdArgs); 293 AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA); 294 295 unsigned Major = ToolChain.getTriple().getOSMajorVersion(); 296 bool Profiling = Args.hasArg(options::OPT_pg) && Major != 0 && Major < 14; 297 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs, 298 options::OPT_r)) { 299 // Use the static OpenMP runtime with -static-openmp 300 bool StaticOpenMP = Args.hasArg(options::OPT_static_openmp) && 301 !Args.hasArg(options::OPT_static); 302 addOpenMPRuntime(C, CmdArgs, ToolChain, Args, StaticOpenMP); 303 304 if (D.CCCIsCXX()) { 305 if (ToolChain.ShouldLinkCXXStdlib(Args)) 306 ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs); 307 if (Profiling) 308 CmdArgs.push_back("-lm_p"); 309 else 310 CmdArgs.push_back("-lm"); 311 } 312 313 // Silence warnings when linking C code with a C++ '-stdlib' argument. 314 Args.ClaimAllArgs(options::OPT_stdlib_EQ); 315 316 // Additional linker set-up and flags for Fortran. This is required in order 317 // to generate executables. As Fortran runtime depends on the C runtime, 318 // these dependencies need to be listed before the C runtime below (i.e. 319 // AddRunTimeLibs). 320 if (D.IsFlangMode() && 321 !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) { 322 addFortranRuntimeLibraryPath(ToolChain, Args, CmdArgs); 323 addFortranRuntimeLibs(ToolChain, Args, CmdArgs); 324 if (Profiling) 325 CmdArgs.push_back("-lm_p"); 326 else 327 CmdArgs.push_back("-lm"); 328 } 329 330 if (NeedsSanitizerDeps) 331 linkSanitizerRuntimeDeps(ToolChain, Args, CmdArgs); 332 if (NeedsXRayDeps) 333 linkXRayRuntimeDeps(ToolChain, Args, CmdArgs); 334 // FIXME: For some reason GCC passes -lgcc and -lgcc_s before adding 335 // the default system libraries. Just mimic this for now. 336 if (Profiling) 337 CmdArgs.push_back("-lgcc_p"); 338 else 339 CmdArgs.push_back("-lgcc"); 340 if (Args.hasArg(options::OPT_static)) { 341 CmdArgs.push_back("-lgcc_eh"); 342 } else if (Profiling) { 343 CmdArgs.push_back("-lgcc_eh_p"); 344 } else { 345 CmdArgs.push_back("--as-needed"); 346 CmdArgs.push_back("-lgcc_s"); 347 CmdArgs.push_back("--no-as-needed"); 348 } 349 350 if (Args.hasArg(options::OPT_pthread)) { 351 if (Profiling) 352 CmdArgs.push_back("-lpthread_p"); 353 else 354 CmdArgs.push_back("-lpthread"); 355 } 356 357 if (Profiling) { 358 if (Args.hasArg(options::OPT_shared)) 359 CmdArgs.push_back("-lc"); 360 else 361 CmdArgs.push_back("-lc_p"); 362 CmdArgs.push_back("-lgcc_p"); 363 } else { 364 CmdArgs.push_back("-lc"); 365 CmdArgs.push_back("-lgcc"); 366 } 367 368 if (Args.hasArg(options::OPT_static)) { 369 CmdArgs.push_back("-lgcc_eh"); 370 } else if (Profiling) { 371 CmdArgs.push_back("-lgcc_eh_p"); 372 } else { 373 CmdArgs.push_back("--as-needed"); 374 CmdArgs.push_back("-lgcc_s"); 375 CmdArgs.push_back("--no-as-needed"); 376 } 377 } 378 379 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles, 380 options::OPT_r)) { 381 const char *crtend = nullptr; 382 if (Args.hasArg(options::OPT_shared) || IsPIE) 383 crtend = "crtendS.o"; 384 else 385 crtend = "crtend.o"; 386 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend))); 387 CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o"))); 388 } 389 390 ToolChain.addProfileRTLibs(Args, CmdArgs); 391 392 const char *Exec = Args.MakeArgString(getToolChain().GetLinkerPath()); 393 C.addCommand(std::make_unique<Command>(JA, *this, 394 ResponseFileSupport::AtFileCurCP(), 395 Exec, CmdArgs, Inputs, Output)); 396 } 397 398 /// FreeBSD - FreeBSD tool chain which can call as(1) and ld(1) directly. 399 400 FreeBSD::FreeBSD(const Driver &D, const llvm::Triple &Triple, 401 const ArgList &Args) 402 : Generic_ELF(D, Triple, Args) { 403 404 // When targeting 32-bit platforms, look for '/usr/lib32/crt1.o' and fall 405 // back to '/usr/lib' if it doesn't exist. 406 if (Triple.isArch32Bit() && 407 D.getVFS().exists(concat(getDriver().SysRoot, "/usr/lib32/crt1.o"))) 408 getFilePaths().push_back(concat(getDriver().SysRoot, "/usr/lib32")); 409 else 410 getFilePaths().push_back(concat(getDriver().SysRoot, "/usr/lib")); 411 } 412 413 void FreeBSD::AddClangSystemIncludeArgs( 414 const llvm::opt::ArgList &DriverArgs, 415 llvm::opt::ArgStringList &CC1Args) const { 416 const Driver &D = getDriver(); 417 418 if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc)) 419 return; 420 421 if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) { 422 SmallString<128> Dir(D.ResourceDir); 423 llvm::sys::path::append(Dir, "include"); 424 addSystemInclude(DriverArgs, CC1Args, Dir.str()); 425 } 426 427 if (DriverArgs.hasArg(options::OPT_nostdlibinc)) 428 return; 429 430 // Check for configure-time C include directories. 431 StringRef CIncludeDirs(C_INCLUDE_DIRS); 432 if (CIncludeDirs != "") { 433 SmallVector<StringRef, 5> dirs; 434 CIncludeDirs.split(dirs, ":"); 435 for (StringRef dir : dirs) { 436 StringRef Prefix = 437 llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : ""; 438 addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir); 439 } 440 return; 441 } 442 443 addExternCSystemInclude(DriverArgs, CC1Args, 444 concat(D.SysRoot, "/usr/include")); 445 } 446 447 void FreeBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs, 448 llvm::opt::ArgStringList &CC1Args) const { 449 addSystemInclude(DriverArgs, CC1Args, 450 concat(getDriver().SysRoot, "/usr/include/c++/v1")); 451 } 452 453 void FreeBSD::AddCXXStdlibLibArgs(const ArgList &Args, 454 ArgStringList &CmdArgs) const { 455 unsigned Major = getTriple().getOSMajorVersion(); 456 bool Profiling = Args.hasArg(options::OPT_pg) && Major != 0 && Major < 14; 457 458 CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++"); 459 if (Args.hasArg(options::OPT_fexperimental_library)) 460 CmdArgs.push_back("-lc++experimental"); 461 } 462 463 void FreeBSD::AddCudaIncludeArgs(const ArgList &DriverArgs, 464 ArgStringList &CC1Args) const { 465 CudaInstallation->AddCudaIncludeArgs(DriverArgs, CC1Args); 466 } 467 468 void FreeBSD::AddHIPIncludeArgs(const ArgList &DriverArgs, 469 ArgStringList &CC1Args) const { 470 RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args); 471 } 472 473 Tool *FreeBSD::buildAssembler() const { 474 return new tools::freebsd::Assembler(*this); 475 } 476 477 Tool *FreeBSD::buildLinker() const { return new tools::freebsd::Linker(*this); } 478 479 bool FreeBSD::HasNativeLLVMSupport() const { return true; } 480 481 ToolChain::UnwindTableLevel 482 FreeBSD::getDefaultUnwindTableLevel(const ArgList &Args) const { 483 return UnwindTableLevel::Asynchronous; 484 } 485 486 bool FreeBSD::isPIEDefault(const llvm::opt::ArgList &Args) const { 487 return getSanitizerArgs(Args).requiresPIE(); 488 } 489 490 SanitizerMask FreeBSD::getSupportedSanitizers() const { 491 const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64; 492 const bool IsX86 = getTriple().getArch() == llvm::Triple::x86; 493 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64; 494 const bool IsMIPS64 = getTriple().isMIPS64(); 495 SanitizerMask Res = ToolChain::getSupportedSanitizers(); 496 Res |= SanitizerKind::Address; 497 Res |= SanitizerKind::PointerCompare; 498 Res |= SanitizerKind::PointerSubtract; 499 Res |= SanitizerKind::Vptr; 500 if (IsAArch64 || IsX86_64 || IsMIPS64) { 501 Res |= SanitizerKind::Leak; 502 Res |= SanitizerKind::Thread; 503 } 504 if (IsAArch64 || IsX86 || IsX86_64) { 505 Res |= SanitizerKind::SafeStack; 506 Res |= SanitizerKind::Fuzzer; 507 Res |= SanitizerKind::FuzzerNoLink; 508 } 509 if (IsAArch64 || IsX86_64) { 510 Res |= SanitizerKind::KernelAddress; 511 Res |= SanitizerKind::KernelMemory; 512 Res |= SanitizerKind::Memory; 513 } 514 return Res; 515 } 516