1 //===- Driver.cpp ---------------------------------------------------------===// 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 // The driver drives the entire linking process. It is responsible for 10 // parsing command line options and doing whatever it is instructed to do. 11 // 12 // One notable thing in the LLD's driver when compared to other linkers is 13 // that the LLD's driver is agnostic on the host operating system. 14 // Other linkers usually have implicit default values (such as a dynamic 15 // linker path or library paths) for each host OS. 16 // 17 // I don't think implicit default values are useful because they are 18 // usually explicitly specified by the compiler driver. They can even 19 // be harmful when you are doing cross-linking. Therefore, in LLD, we 20 // simply trust the compiler driver to pass all required options and 21 // don't try to make effort on our side. 22 // 23 //===----------------------------------------------------------------------===// 24 25 #include "Driver.h" 26 #include "Config.h" 27 #include "ICF.h" 28 #include "InputFiles.h" 29 #include "InputSection.h" 30 #include "LinkerScript.h" 31 #include "MarkLive.h" 32 #include "OutputSections.h" 33 #include "ScriptParser.h" 34 #include "SymbolTable.h" 35 #include "Symbols.h" 36 #include "SyntheticSections.h" 37 #include "Target.h" 38 #include "Writer.h" 39 #include "lld/Common/Args.h" 40 #include "lld/Common/Driver.h" 41 #include "lld/Common/ErrorHandler.h" 42 #include "lld/Common/Filesystem.h" 43 #include "lld/Common/Memory.h" 44 #include "lld/Common/Strings.h" 45 #include "lld/Common/TargetOptionsCommandFlags.h" 46 #include "lld/Common/Version.h" 47 #include "llvm/ADT/SetVector.h" 48 #include "llvm/ADT/StringExtras.h" 49 #include "llvm/ADT/StringSwitch.h" 50 #include "llvm/Config/llvm-config.h" 51 #include "llvm/LTO/LTO.h" 52 #include "llvm/Object/Archive.h" 53 #include "llvm/Remarks/HotnessThresholdParser.h" 54 #include "llvm/Support/CommandLine.h" 55 #include "llvm/Support/Compression.h" 56 #include "llvm/Support/FileSystem.h" 57 #include "llvm/Support/GlobPattern.h" 58 #include "llvm/Support/LEB128.h" 59 #include "llvm/Support/Parallel.h" 60 #include "llvm/Support/Path.h" 61 #include "llvm/Support/TarWriter.h" 62 #include "llvm/Support/TargetSelect.h" 63 #include "llvm/Support/TimeProfiler.h" 64 #include "llvm/Support/raw_ostream.h" 65 #include <cstdlib> 66 #include <utility> 67 68 using namespace llvm; 69 using namespace llvm::ELF; 70 using namespace llvm::object; 71 using namespace llvm::sys; 72 using namespace llvm::support; 73 using namespace lld; 74 using namespace lld::elf; 75 76 std::unique_ptr<Configuration> elf::config; 77 std::unique_ptr<LinkerDriver> elf::driver; 78 79 static void setConfigs(opt::InputArgList &args); 80 static void readConfigs(opt::InputArgList &args); 81 82 void elf::errorOrWarn(const Twine &msg) { 83 if (config->noinhibitExec) 84 warn(msg); 85 else 86 error(msg); 87 } 88 89 bool elf::link(ArrayRef<const char *> args, llvm::raw_ostream &stdoutOS, 90 llvm::raw_ostream &stderrOS, bool exitEarly, 91 bool disableOutput) { 92 // This driver-specific context will be freed later by lldMain(). 93 auto *ctx = new CommonLinkerContext; 94 95 ctx->e.initialize(stdoutOS, stderrOS, exitEarly, disableOutput); 96 ctx->e.cleanupCallback = []() { 97 inputSections.clear(); 98 outputSections.clear(); 99 memoryBuffers.clear(); 100 binaryFiles.clear(); 101 bitcodeFiles.clear(); 102 lazyBitcodeFiles.clear(); 103 objectFiles.clear(); 104 sharedFiles.clear(); 105 backwardReferences.clear(); 106 whyExtract.clear(); 107 symAux.clear(); 108 109 tar = nullptr; 110 in.reset(); 111 112 partitions.clear(); 113 partitions.emplace_back(); 114 115 SharedFile::vernauxNum = 0; 116 }; 117 ctx->e.logName = args::getFilenameWithoutExe(args[0]); 118 ctx->e.errorLimitExceededMsg = "too many errors emitted, stopping now (use " 119 "-error-limit=0 to see all errors)"; 120 121 config = std::make_unique<Configuration>(); 122 driver = std::make_unique<LinkerDriver>(); 123 script = std::make_unique<LinkerScript>(); 124 symtab = std::make_unique<SymbolTable>(); 125 126 partitions.clear(); 127 partitions.emplace_back(); 128 129 config->progName = args[0]; 130 131 driver->linkerMain(args); 132 133 return errorCount() == 0; 134 } 135 136 // Parses a linker -m option. 137 static std::tuple<ELFKind, uint16_t, uint8_t> parseEmulation(StringRef emul) { 138 uint8_t osabi = 0; 139 StringRef s = emul; 140 if (s.endswith("_fbsd")) { 141 s = s.drop_back(5); 142 osabi = ELFOSABI_FREEBSD; 143 } 144 145 std::pair<ELFKind, uint16_t> ret = 146 StringSwitch<std::pair<ELFKind, uint16_t>>(s) 147 .Cases("aarch64elf", "aarch64linux", {ELF64LEKind, EM_AARCH64}) 148 .Cases("aarch64elfb", "aarch64linuxb", {ELF64BEKind, EM_AARCH64}) 149 .Cases("armelf", "armelf_linux_eabi", {ELF32LEKind, EM_ARM}) 150 .Case("elf32_x86_64", {ELF32LEKind, EM_X86_64}) 151 .Cases("elf32btsmip", "elf32btsmipn32", {ELF32BEKind, EM_MIPS}) 152 .Cases("elf32ltsmip", "elf32ltsmipn32", {ELF32LEKind, EM_MIPS}) 153 .Case("elf32lriscv", {ELF32LEKind, EM_RISCV}) 154 .Cases("elf32ppc", "elf32ppclinux", {ELF32BEKind, EM_PPC}) 155 .Cases("elf32lppc", "elf32lppclinux", {ELF32LEKind, EM_PPC}) 156 .Case("elf64btsmip", {ELF64BEKind, EM_MIPS}) 157 .Case("elf64ltsmip", {ELF64LEKind, EM_MIPS}) 158 .Case("elf64lriscv", {ELF64LEKind, EM_RISCV}) 159 .Case("elf64ppc", {ELF64BEKind, EM_PPC64}) 160 .Case("elf64lppc", {ELF64LEKind, EM_PPC64}) 161 .Cases("elf_amd64", "elf_x86_64", {ELF64LEKind, EM_X86_64}) 162 .Case("elf_i386", {ELF32LEKind, EM_386}) 163 .Case("elf_iamcu", {ELF32LEKind, EM_IAMCU}) 164 .Case("elf64_sparc", {ELF64BEKind, EM_SPARCV9}) 165 .Case("msp430elf", {ELF32LEKind, EM_MSP430}) 166 .Default({ELFNoneKind, EM_NONE}); 167 168 if (ret.first == ELFNoneKind) 169 error("unknown emulation: " + emul); 170 if (ret.second == EM_MSP430) 171 osabi = ELFOSABI_STANDALONE; 172 return std::make_tuple(ret.first, ret.second, osabi); 173 } 174 175 // Returns slices of MB by parsing MB as an archive file. 176 // Each slice consists of a member file in the archive. 177 std::vector<std::pair<MemoryBufferRef, uint64_t>> static getArchiveMembers( 178 MemoryBufferRef mb) { 179 std::unique_ptr<Archive> file = 180 CHECK(Archive::create(mb), 181 mb.getBufferIdentifier() + ": failed to parse archive"); 182 183 std::vector<std::pair<MemoryBufferRef, uint64_t>> v; 184 Error err = Error::success(); 185 bool addToTar = file->isThin() && tar; 186 for (const Archive::Child &c : file->children(err)) { 187 MemoryBufferRef mbref = 188 CHECK(c.getMemoryBufferRef(), 189 mb.getBufferIdentifier() + 190 ": could not get the buffer for a child of the archive"); 191 if (addToTar) 192 tar->append(relativeToRoot(check(c.getFullName())), mbref.getBuffer()); 193 v.push_back(std::make_pair(mbref, c.getChildOffset())); 194 } 195 if (err) 196 fatal(mb.getBufferIdentifier() + ": Archive::children failed: " + 197 toString(std::move(err))); 198 199 // Take ownership of memory buffers created for members of thin archives. 200 std::vector<std::unique_ptr<MemoryBuffer>> mbs = file->takeThinBuffers(); 201 std::move(mbs.begin(), mbs.end(), std::back_inserter(memoryBuffers)); 202 203 return v; 204 } 205 206 // Opens a file and create a file object. Path has to be resolved already. 207 void LinkerDriver::addFile(StringRef path, bool withLOption) { 208 using namespace sys::fs; 209 210 Optional<MemoryBufferRef> buffer = readFile(path); 211 if (!buffer.hasValue()) 212 return; 213 MemoryBufferRef mbref = *buffer; 214 215 if (config->formatBinary) { 216 files.push_back(make<BinaryFile>(mbref)); 217 return; 218 } 219 220 switch (identify_magic(mbref.getBuffer())) { 221 case file_magic::unknown: 222 readLinkerScript(mbref); 223 return; 224 case file_magic::archive: { 225 if (inWholeArchive) { 226 for (const auto &p : getArchiveMembers(mbref)) 227 files.push_back(createObjectFile(p.first, path, p.second)); 228 return; 229 } 230 231 auto members = getArchiveMembers(mbref); 232 archiveFiles.emplace_back(path, members.size()); 233 234 // Handle archives and --start-lib/--end-lib using the same code path. This 235 // scans all the ELF relocatable object files and bitcode files in the 236 // archive rather than just the index file, with the benefit that the 237 // symbols are only loaded once. For many projects archives see high 238 // utilization rates and it is a net performance win. --start-lib scans 239 // symbols in the same order that llvm-ar adds them to the index, so in the 240 // common case the semantics are identical. If the archive symbol table was 241 // created in a different order, or is incomplete, this strategy has 242 // different semantics. Such output differences are considered user error. 243 // 244 // All files within the archive get the same group ID to allow mutual 245 // references for --warn-backrefs. 246 bool saved = InputFile::isInGroup; 247 InputFile::isInGroup = true; 248 for (const std::pair<MemoryBufferRef, uint64_t> &p : members) { 249 auto magic = identify_magic(p.first.getBuffer()); 250 if (magic == file_magic::bitcode || magic == file_magic::elf_relocatable) 251 files.push_back(createLazyFile(p.first, path, p.second)); 252 else 253 warn(path + ": archive member '" + p.first.getBufferIdentifier() + 254 "' is neither ET_REL nor LLVM bitcode"); 255 } 256 InputFile::isInGroup = saved; 257 if (!saved) 258 ++InputFile::nextGroupId; 259 return; 260 } 261 case file_magic::elf_shared_object: 262 if (config->isStatic || config->relocatable) { 263 error("attempted static link of dynamic object " + path); 264 return; 265 } 266 267 // Shared objects are identified by soname. soname is (if specified) 268 // DT_SONAME and falls back to filename. If a file was specified by -lfoo, 269 // the directory part is ignored. Note that path may be a temporary and 270 // cannot be stored into SharedFile::soName. 271 path = mbref.getBufferIdentifier(); 272 files.push_back( 273 make<SharedFile>(mbref, withLOption ? path::filename(path) : path)); 274 return; 275 case file_magic::bitcode: 276 case file_magic::elf_relocatable: 277 if (inLib) 278 files.push_back(createLazyFile(mbref, "", 0)); 279 else 280 files.push_back(createObjectFile(mbref)); 281 break; 282 default: 283 error(path + ": unknown file type"); 284 } 285 } 286 287 // Add a given library by searching it from input search paths. 288 void LinkerDriver::addLibrary(StringRef name) { 289 if (Optional<std::string> path = searchLibrary(name)) 290 addFile(*path, /*withLOption=*/true); 291 else 292 error("unable to find library -l" + name, ErrorTag::LibNotFound, {name}); 293 } 294 295 // This function is called on startup. We need this for LTO since 296 // LTO calls LLVM functions to compile bitcode files to native code. 297 // Technically this can be delayed until we read bitcode files, but 298 // we don't bother to do lazily because the initialization is fast. 299 static void initLLVM() { 300 InitializeAllTargets(); 301 InitializeAllTargetMCs(); 302 InitializeAllAsmPrinters(); 303 InitializeAllAsmParsers(); 304 } 305 306 // Some command line options or some combinations of them are not allowed. 307 // This function checks for such errors. 308 static void checkOptions() { 309 // The MIPS ABI as of 2016 does not support the GNU-style symbol lookup 310 // table which is a relatively new feature. 311 if (config->emachine == EM_MIPS && config->gnuHash) 312 error("the .gnu.hash section is not compatible with the MIPS target"); 313 314 if (config->fixCortexA53Errata843419 && config->emachine != EM_AARCH64) 315 error("--fix-cortex-a53-843419 is only supported on AArch64 targets"); 316 317 if (config->fixCortexA8 && config->emachine != EM_ARM) 318 error("--fix-cortex-a8 is only supported on ARM targets"); 319 320 if (config->tocOptimize && config->emachine != EM_PPC64) 321 error("--toc-optimize is only supported on PowerPC64 targets"); 322 323 if (config->pcRelOptimize && config->emachine != EM_PPC64) 324 error("--pcrel-optimize is only supported on PowerPC64 targets"); 325 326 if (config->pie && config->shared) 327 error("-shared and -pie may not be used together"); 328 329 if (!config->shared && !config->filterList.empty()) 330 error("-F may not be used without -shared"); 331 332 if (!config->shared && !config->auxiliaryList.empty()) 333 error("-f may not be used without -shared"); 334 335 if (config->strip == StripPolicy::All && config->emitRelocs) 336 error("--strip-all and --emit-relocs may not be used together"); 337 338 if (config->zText && config->zIfuncNoplt) 339 error("-z text and -z ifunc-noplt may not be used together"); 340 341 if (config->relocatable) { 342 if (config->shared) 343 error("-r and -shared may not be used together"); 344 if (config->gdbIndex) 345 error("-r and --gdb-index may not be used together"); 346 if (config->icf != ICFLevel::None) 347 error("-r and --icf may not be used together"); 348 if (config->pie) 349 error("-r and -pie may not be used together"); 350 if (config->exportDynamic) 351 error("-r and --export-dynamic may not be used together"); 352 } 353 354 if (config->executeOnly) { 355 if (config->emachine != EM_AARCH64) 356 error("--execute-only is only supported on AArch64 targets"); 357 358 if (config->singleRoRx && !script->hasSectionsCommand) 359 error("--execute-only and --no-rosegment cannot be used together"); 360 } 361 362 if (config->zRetpolineplt && config->zForceIbt) 363 error("-z force-ibt may not be used with -z retpolineplt"); 364 365 if (config->emachine != EM_AARCH64) { 366 if (config->zPacPlt) 367 error("-z pac-plt only supported on AArch64"); 368 if (config->zForceBti) 369 error("-z force-bti only supported on AArch64"); 370 if (config->zBtiReport != "none") 371 error("-z bti-report only supported on AArch64"); 372 } 373 374 if (config->emachine != EM_386 && config->emachine != EM_X86_64 && 375 config->zCetReport != "none") 376 error("-z cet-report only supported on X86 and X86_64"); 377 } 378 379 static const char *getReproduceOption(opt::InputArgList &args) { 380 if (auto *arg = args.getLastArg(OPT_reproduce)) 381 return arg->getValue(); 382 return getenv("LLD_REPRODUCE"); 383 } 384 385 static bool hasZOption(opt::InputArgList &args, StringRef key) { 386 for (auto *arg : args.filtered(OPT_z)) 387 if (key == arg->getValue()) 388 return true; 389 return false; 390 } 391 392 static bool getZFlag(opt::InputArgList &args, StringRef k1, StringRef k2, 393 bool Default) { 394 for (auto *arg : args.filtered_reverse(OPT_z)) { 395 if (k1 == arg->getValue()) 396 return true; 397 if (k2 == arg->getValue()) 398 return false; 399 } 400 return Default; 401 } 402 403 static SeparateSegmentKind getZSeparate(opt::InputArgList &args) { 404 for (auto *arg : args.filtered_reverse(OPT_z)) { 405 StringRef v = arg->getValue(); 406 if (v == "noseparate-code") 407 return SeparateSegmentKind::None; 408 if (v == "separate-code") 409 return SeparateSegmentKind::Code; 410 if (v == "separate-loadable-segments") 411 return SeparateSegmentKind::Loadable; 412 } 413 return SeparateSegmentKind::None; 414 } 415 416 static GnuStackKind getZGnuStack(opt::InputArgList &args) { 417 for (auto *arg : args.filtered_reverse(OPT_z)) { 418 if (StringRef("execstack") == arg->getValue()) 419 return GnuStackKind::Exec; 420 if (StringRef("noexecstack") == arg->getValue()) 421 return GnuStackKind::NoExec; 422 if (StringRef("nognustack") == arg->getValue()) 423 return GnuStackKind::None; 424 } 425 426 return GnuStackKind::NoExec; 427 } 428 429 static uint8_t getZStartStopVisibility(opt::InputArgList &args) { 430 for (auto *arg : args.filtered_reverse(OPT_z)) { 431 std::pair<StringRef, StringRef> kv = StringRef(arg->getValue()).split('='); 432 if (kv.first == "start-stop-visibility") { 433 if (kv.second == "default") 434 return STV_DEFAULT; 435 else if (kv.second == "internal") 436 return STV_INTERNAL; 437 else if (kv.second == "hidden") 438 return STV_HIDDEN; 439 else if (kv.second == "protected") 440 return STV_PROTECTED; 441 error("unknown -z start-stop-visibility= value: " + StringRef(kv.second)); 442 } 443 } 444 return STV_PROTECTED; 445 } 446 447 static bool isKnownZFlag(StringRef s) { 448 return s == "combreloc" || s == "copyreloc" || s == "defs" || 449 s == "execstack" || s == "force-bti" || s == "force-ibt" || 450 s == "global" || s == "hazardplt" || s == "ifunc-noplt" || 451 s == "initfirst" || s == "interpose" || 452 s == "keep-text-section-prefix" || s == "lazy" || s == "muldefs" || 453 s == "separate-code" || s == "separate-loadable-segments" || 454 s == "start-stop-gc" || s == "nocombreloc" || s == "nocopyreloc" || 455 s == "nodefaultlib" || s == "nodelete" || s == "nodlopen" || 456 s == "noexecstack" || s == "nognustack" || 457 s == "nokeep-text-section-prefix" || s == "norelro" || 458 s == "noseparate-code" || s == "nostart-stop-gc" || s == "notext" || 459 s == "now" || s == "origin" || s == "pac-plt" || s == "rel" || 460 s == "rela" || s == "relro" || s == "retpolineplt" || 461 s == "rodynamic" || s == "shstk" || s == "text" || s == "undefs" || 462 s == "wxneeded" || s.startswith("common-page-size=") || 463 s.startswith("bti-report=") || s.startswith("cet-report=") || 464 s.startswith("dead-reloc-in-nonalloc=") || 465 s.startswith("max-page-size=") || s.startswith("stack-size=") || 466 s.startswith("start-stop-visibility="); 467 } 468 469 // Report a warning for an unknown -z option. 470 static void checkZOptions(opt::InputArgList &args) { 471 for (auto *arg : args.filtered(OPT_z)) 472 if (!isKnownZFlag(arg->getValue())) 473 warn("unknown -z value: " + StringRef(arg->getValue())); 474 } 475 476 void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) { 477 ELFOptTable parser; 478 opt::InputArgList args = parser.parse(argsArr.slice(1)); 479 480 // Interpret the flags early because error()/warn() depend on them. 481 errorHandler().errorLimit = args::getInteger(args, OPT_error_limit, 20); 482 errorHandler().fatalWarnings = 483 args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false); 484 checkZOptions(args); 485 486 // Handle -help 487 if (args.hasArg(OPT_help)) { 488 printHelp(); 489 return; 490 } 491 492 // Handle -v or -version. 493 // 494 // A note about "compatible with GNU linkers" message: this is a hack for 495 // scripts generated by GNU Libtool up to 2021-10 to recognize LLD as 496 // a GNU compatible linker. See 497 // <https://lists.gnu.org/archive/html/libtool/2017-01/msg00007.html>. 498 // 499 // This is somewhat ugly hack, but in reality, we had no choice other 500 // than doing this. Considering the very long release cycle of Libtool, 501 // it is not easy to improve it to recognize LLD as a GNU compatible 502 // linker in a timely manner. Even if we can make it, there are still a 503 // lot of "configure" scripts out there that are generated by old version 504 // of Libtool. We cannot convince every software developer to migrate to 505 // the latest version and re-generate scripts. So we have this hack. 506 if (args.hasArg(OPT_v) || args.hasArg(OPT_version)) 507 message(getLLDVersion() + " (compatible with GNU linkers)"); 508 509 if (const char *path = getReproduceOption(args)) { 510 // Note that --reproduce is a debug option so you can ignore it 511 // if you are trying to understand the whole picture of the code. 512 Expected<std::unique_ptr<TarWriter>> errOrWriter = 513 TarWriter::create(path, path::stem(path)); 514 if (errOrWriter) { 515 tar = std::move(*errOrWriter); 516 tar->append("response.txt", createResponseFile(args)); 517 tar->append("version.txt", getLLDVersion() + "\n"); 518 StringRef ltoSampleProfile = args.getLastArgValue(OPT_lto_sample_profile); 519 if (!ltoSampleProfile.empty()) 520 readFile(ltoSampleProfile); 521 } else { 522 error("--reproduce: " + toString(errOrWriter.takeError())); 523 } 524 } 525 526 readConfigs(args); 527 528 // The behavior of -v or --version is a bit strange, but this is 529 // needed for compatibility with GNU linkers. 530 if (args.hasArg(OPT_v) && !args.hasArg(OPT_INPUT)) 531 return; 532 if (args.hasArg(OPT_version)) 533 return; 534 535 // Initialize time trace profiler. 536 if (config->timeTraceEnabled) 537 timeTraceProfilerInitialize(config->timeTraceGranularity, config->progName); 538 539 { 540 llvm::TimeTraceScope timeScope("ExecuteLinker"); 541 542 initLLVM(); 543 createFiles(args); 544 if (errorCount()) 545 return; 546 547 inferMachineType(); 548 setConfigs(args); 549 checkOptions(); 550 if (errorCount()) 551 return; 552 553 // The Target instance handles target-specific stuff, such as applying 554 // relocations or writing a PLT section. It also contains target-dependent 555 // values such as a default image base address. 556 target = getTarget(); 557 558 link(args); 559 } 560 561 if (config->timeTraceEnabled) { 562 checkError(timeTraceProfilerWrite( 563 args.getLastArgValue(OPT_time_trace_file_eq).str(), 564 config->outputFile)); 565 timeTraceProfilerCleanup(); 566 } 567 } 568 569 static std::string getRpath(opt::InputArgList &args) { 570 std::vector<StringRef> v = args::getStrings(args, OPT_rpath); 571 return llvm::join(v.begin(), v.end(), ":"); 572 } 573 574 // Determines what we should do if there are remaining unresolved 575 // symbols after the name resolution. 576 static void setUnresolvedSymbolPolicy(opt::InputArgList &args) { 577 UnresolvedPolicy errorOrWarn = args.hasFlag(OPT_error_unresolved_symbols, 578 OPT_warn_unresolved_symbols, true) 579 ? UnresolvedPolicy::ReportError 580 : UnresolvedPolicy::Warn; 581 // -shared implies --unresolved-symbols=ignore-all because missing 582 // symbols are likely to be resolved at runtime. 583 bool diagRegular = !config->shared, diagShlib = !config->shared; 584 585 for (const opt::Arg *arg : args) { 586 switch (arg->getOption().getID()) { 587 case OPT_unresolved_symbols: { 588 StringRef s = arg->getValue(); 589 if (s == "ignore-all") { 590 diagRegular = false; 591 diagShlib = false; 592 } else if (s == "ignore-in-object-files") { 593 diagRegular = false; 594 diagShlib = true; 595 } else if (s == "ignore-in-shared-libs") { 596 diagRegular = true; 597 diagShlib = false; 598 } else if (s == "report-all") { 599 diagRegular = true; 600 diagShlib = true; 601 } else { 602 error("unknown --unresolved-symbols value: " + s); 603 } 604 break; 605 } 606 case OPT_no_undefined: 607 diagRegular = true; 608 break; 609 case OPT_z: 610 if (StringRef(arg->getValue()) == "defs") 611 diagRegular = true; 612 else if (StringRef(arg->getValue()) == "undefs") 613 diagRegular = false; 614 break; 615 case OPT_allow_shlib_undefined: 616 diagShlib = false; 617 break; 618 case OPT_no_allow_shlib_undefined: 619 diagShlib = true; 620 break; 621 } 622 } 623 624 config->unresolvedSymbols = 625 diagRegular ? errorOrWarn : UnresolvedPolicy::Ignore; 626 config->unresolvedSymbolsInShlib = 627 diagShlib ? errorOrWarn : UnresolvedPolicy::Ignore; 628 } 629 630 static Target2Policy getTarget2(opt::InputArgList &args) { 631 StringRef s = args.getLastArgValue(OPT_target2, "got-rel"); 632 if (s == "rel") 633 return Target2Policy::Rel; 634 if (s == "abs") 635 return Target2Policy::Abs; 636 if (s == "got-rel") 637 return Target2Policy::GotRel; 638 error("unknown --target2 option: " + s); 639 return Target2Policy::GotRel; 640 } 641 642 static bool isOutputFormatBinary(opt::InputArgList &args) { 643 StringRef s = args.getLastArgValue(OPT_oformat, "elf"); 644 if (s == "binary") 645 return true; 646 if (!s.startswith("elf")) 647 error("unknown --oformat value: " + s); 648 return false; 649 } 650 651 static DiscardPolicy getDiscard(opt::InputArgList &args) { 652 auto *arg = 653 args.getLastArg(OPT_discard_all, OPT_discard_locals, OPT_discard_none); 654 if (!arg) 655 return DiscardPolicy::Default; 656 if (arg->getOption().getID() == OPT_discard_all) 657 return DiscardPolicy::All; 658 if (arg->getOption().getID() == OPT_discard_locals) 659 return DiscardPolicy::Locals; 660 return DiscardPolicy::None; 661 } 662 663 static StringRef getDynamicLinker(opt::InputArgList &args) { 664 auto *arg = args.getLastArg(OPT_dynamic_linker, OPT_no_dynamic_linker); 665 if (!arg) 666 return ""; 667 if (arg->getOption().getID() == OPT_no_dynamic_linker) { 668 // --no-dynamic-linker suppresses undefined weak symbols in .dynsym 669 config->noDynamicLinker = true; 670 return ""; 671 } 672 return arg->getValue(); 673 } 674 675 static ICFLevel getICF(opt::InputArgList &args) { 676 auto *arg = args.getLastArg(OPT_icf_none, OPT_icf_safe, OPT_icf_all); 677 if (!arg || arg->getOption().getID() == OPT_icf_none) 678 return ICFLevel::None; 679 if (arg->getOption().getID() == OPT_icf_safe) 680 return ICFLevel::Safe; 681 return ICFLevel::All; 682 } 683 684 static StripPolicy getStrip(opt::InputArgList &args) { 685 if (args.hasArg(OPT_relocatable)) 686 return StripPolicy::None; 687 688 auto *arg = args.getLastArg(OPT_strip_all, OPT_strip_debug); 689 if (!arg) 690 return StripPolicy::None; 691 if (arg->getOption().getID() == OPT_strip_all) 692 return StripPolicy::All; 693 return StripPolicy::Debug; 694 } 695 696 static uint64_t parseSectionAddress(StringRef s, opt::InputArgList &args, 697 const opt::Arg &arg) { 698 uint64_t va = 0; 699 if (s.startswith("0x")) 700 s = s.drop_front(2); 701 if (!to_integer(s, va, 16)) 702 error("invalid argument: " + arg.getAsString(args)); 703 return va; 704 } 705 706 static StringMap<uint64_t> getSectionStartMap(opt::InputArgList &args) { 707 StringMap<uint64_t> ret; 708 for (auto *arg : args.filtered(OPT_section_start)) { 709 StringRef name; 710 StringRef addr; 711 std::tie(name, addr) = StringRef(arg->getValue()).split('='); 712 ret[name] = parseSectionAddress(addr, args, *arg); 713 } 714 715 if (auto *arg = args.getLastArg(OPT_Ttext)) 716 ret[".text"] = parseSectionAddress(arg->getValue(), args, *arg); 717 if (auto *arg = args.getLastArg(OPT_Tdata)) 718 ret[".data"] = parseSectionAddress(arg->getValue(), args, *arg); 719 if (auto *arg = args.getLastArg(OPT_Tbss)) 720 ret[".bss"] = parseSectionAddress(arg->getValue(), args, *arg); 721 return ret; 722 } 723 724 static SortSectionPolicy getSortSection(opt::InputArgList &args) { 725 StringRef s = args.getLastArgValue(OPT_sort_section); 726 if (s == "alignment") 727 return SortSectionPolicy::Alignment; 728 if (s == "name") 729 return SortSectionPolicy::Name; 730 if (!s.empty()) 731 error("unknown --sort-section rule: " + s); 732 return SortSectionPolicy::Default; 733 } 734 735 static OrphanHandlingPolicy getOrphanHandling(opt::InputArgList &args) { 736 StringRef s = args.getLastArgValue(OPT_orphan_handling, "place"); 737 if (s == "warn") 738 return OrphanHandlingPolicy::Warn; 739 if (s == "error") 740 return OrphanHandlingPolicy::Error; 741 if (s != "place") 742 error("unknown --orphan-handling mode: " + s); 743 return OrphanHandlingPolicy::Place; 744 } 745 746 // Parse --build-id or --build-id=<style>. We handle "tree" as a 747 // synonym for "sha1" because all our hash functions including 748 // --build-id=sha1 are actually tree hashes for performance reasons. 749 static std::pair<BuildIdKind, std::vector<uint8_t>> 750 getBuildId(opt::InputArgList &args) { 751 auto *arg = args.getLastArg(OPT_build_id, OPT_build_id_eq); 752 if (!arg) 753 return {BuildIdKind::None, {}}; 754 755 if (arg->getOption().getID() == OPT_build_id) 756 return {BuildIdKind::Fast, {}}; 757 758 StringRef s = arg->getValue(); 759 if (s == "fast") 760 return {BuildIdKind::Fast, {}}; 761 if (s == "md5") 762 return {BuildIdKind::Md5, {}}; 763 if (s == "sha1" || s == "tree") 764 return {BuildIdKind::Sha1, {}}; 765 if (s == "uuid") 766 return {BuildIdKind::Uuid, {}}; 767 if (s.startswith("0x")) 768 return {BuildIdKind::Hexstring, parseHex(s.substr(2))}; 769 770 if (s != "none") 771 error("unknown --build-id style: " + s); 772 return {BuildIdKind::None, {}}; 773 } 774 775 static std::pair<bool, bool> getPackDynRelocs(opt::InputArgList &args) { 776 StringRef s = args.getLastArgValue(OPT_pack_dyn_relocs, "none"); 777 if (s == "android") 778 return {true, false}; 779 if (s == "relr") 780 return {false, true}; 781 if (s == "android+relr") 782 return {true, true}; 783 784 if (s != "none") 785 error("unknown --pack-dyn-relocs format: " + s); 786 return {false, false}; 787 } 788 789 static void readCallGraph(MemoryBufferRef mb) { 790 // Build a map from symbol name to section 791 DenseMap<StringRef, Symbol *> map; 792 for (ELFFileBase *file : objectFiles) 793 for (Symbol *sym : file->getSymbols()) 794 map[sym->getName()] = sym; 795 796 auto findSection = [&](StringRef name) -> InputSectionBase * { 797 Symbol *sym = map.lookup(name); 798 if (!sym) { 799 if (config->warnSymbolOrdering) 800 warn(mb.getBufferIdentifier() + ": no such symbol: " + name); 801 return nullptr; 802 } 803 maybeWarnUnorderableSymbol(sym); 804 805 if (Defined *dr = dyn_cast_or_null<Defined>(sym)) 806 return dyn_cast_or_null<InputSectionBase>(dr->section); 807 return nullptr; 808 }; 809 810 for (StringRef line : args::getLines(mb)) { 811 SmallVector<StringRef, 3> fields; 812 line.split(fields, ' '); 813 uint64_t count; 814 815 if (fields.size() != 3 || !to_integer(fields[2], count)) { 816 error(mb.getBufferIdentifier() + ": parse error"); 817 return; 818 } 819 820 if (InputSectionBase *from = findSection(fields[0])) 821 if (InputSectionBase *to = findSection(fields[1])) 822 config->callGraphProfile[std::make_pair(from, to)] += count; 823 } 824 } 825 826 // If SHT_LLVM_CALL_GRAPH_PROFILE and its relocation section exist, returns 827 // true and populates cgProfile and symbolIndices. 828 template <class ELFT> 829 static bool 830 processCallGraphRelocations(SmallVector<uint32_t, 32> &symbolIndices, 831 ArrayRef<typename ELFT::CGProfile> &cgProfile, 832 ObjFile<ELFT> *inputObj) { 833 if (inputObj->cgProfileSectionIndex == SHN_UNDEF) 834 return false; 835 836 ArrayRef<Elf_Shdr_Impl<ELFT>> objSections = 837 inputObj->template getELFShdrs<ELFT>(); 838 symbolIndices.clear(); 839 const ELFFile<ELFT> &obj = inputObj->getObj(); 840 cgProfile = 841 check(obj.template getSectionContentsAsArray<typename ELFT::CGProfile>( 842 objSections[inputObj->cgProfileSectionIndex])); 843 844 for (size_t i = 0, e = objSections.size(); i < e; ++i) { 845 const Elf_Shdr_Impl<ELFT> &sec = objSections[i]; 846 if (sec.sh_info == inputObj->cgProfileSectionIndex) { 847 if (sec.sh_type == SHT_RELA) { 848 ArrayRef<typename ELFT::Rela> relas = 849 CHECK(obj.relas(sec), "could not retrieve cg profile rela section"); 850 for (const typename ELFT::Rela &rel : relas) 851 symbolIndices.push_back(rel.getSymbol(config->isMips64EL)); 852 break; 853 } 854 if (sec.sh_type == SHT_REL) { 855 ArrayRef<typename ELFT::Rel> rels = 856 CHECK(obj.rels(sec), "could not retrieve cg profile rel section"); 857 for (const typename ELFT::Rel &rel : rels) 858 symbolIndices.push_back(rel.getSymbol(config->isMips64EL)); 859 break; 860 } 861 } 862 } 863 if (symbolIndices.empty()) 864 warn("SHT_LLVM_CALL_GRAPH_PROFILE exists, but relocation section doesn't"); 865 return !symbolIndices.empty(); 866 } 867 868 template <class ELFT> static void readCallGraphsFromObjectFiles() { 869 SmallVector<uint32_t, 32> symbolIndices; 870 ArrayRef<typename ELFT::CGProfile> cgProfile; 871 for (auto file : objectFiles) { 872 auto *obj = cast<ObjFile<ELFT>>(file); 873 if (!processCallGraphRelocations(symbolIndices, cgProfile, obj)) 874 continue; 875 876 if (symbolIndices.size() != cgProfile.size() * 2) 877 fatal("number of relocations doesn't match Weights"); 878 879 for (uint32_t i = 0, size = cgProfile.size(); i < size; ++i) { 880 const Elf_CGProfile_Impl<ELFT> &cgpe = cgProfile[i]; 881 uint32_t fromIndex = symbolIndices[i * 2]; 882 uint32_t toIndex = symbolIndices[i * 2 + 1]; 883 auto *fromSym = dyn_cast<Defined>(&obj->getSymbol(fromIndex)); 884 auto *toSym = dyn_cast<Defined>(&obj->getSymbol(toIndex)); 885 if (!fromSym || !toSym) 886 continue; 887 888 auto *from = dyn_cast_or_null<InputSectionBase>(fromSym->section); 889 auto *to = dyn_cast_or_null<InputSectionBase>(toSym->section); 890 if (from && to) 891 config->callGraphProfile[{from, to}] += cgpe.cgp_weight; 892 } 893 } 894 } 895 896 static bool getCompressDebugSections(opt::InputArgList &args) { 897 StringRef s = args.getLastArgValue(OPT_compress_debug_sections, "none"); 898 if (s == "none") 899 return false; 900 if (s != "zlib") 901 error("unknown --compress-debug-sections value: " + s); 902 if (!zlib::isAvailable()) 903 error("--compress-debug-sections: zlib is not available"); 904 return true; 905 } 906 907 static StringRef getAliasSpelling(opt::Arg *arg) { 908 if (const opt::Arg *alias = arg->getAlias()) 909 return alias->getSpelling(); 910 return arg->getSpelling(); 911 } 912 913 static std::pair<StringRef, StringRef> getOldNewOptions(opt::InputArgList &args, 914 unsigned id) { 915 auto *arg = args.getLastArg(id); 916 if (!arg) 917 return {"", ""}; 918 919 StringRef s = arg->getValue(); 920 std::pair<StringRef, StringRef> ret = s.split(';'); 921 if (ret.second.empty()) 922 error(getAliasSpelling(arg) + " expects 'old;new' format, but got " + s); 923 return ret; 924 } 925 926 // Parse the symbol ordering file and warn for any duplicate entries. 927 static std::vector<StringRef> getSymbolOrderingFile(MemoryBufferRef mb) { 928 SetVector<StringRef> names; 929 for (StringRef s : args::getLines(mb)) 930 if (!names.insert(s) && config->warnSymbolOrdering) 931 warn(mb.getBufferIdentifier() + ": duplicate ordered symbol: " + s); 932 933 return names.takeVector(); 934 } 935 936 static bool getIsRela(opt::InputArgList &args) { 937 // If -z rel or -z rela is specified, use the last option. 938 for (auto *arg : args.filtered_reverse(OPT_z)) { 939 StringRef s(arg->getValue()); 940 if (s == "rel") 941 return false; 942 if (s == "rela") 943 return true; 944 } 945 946 // Otherwise use the psABI defined relocation entry format. 947 uint16_t m = config->emachine; 948 return m == EM_AARCH64 || m == EM_AMDGPU || m == EM_HEXAGON || m == EM_PPC || 949 m == EM_PPC64 || m == EM_RISCV || m == EM_X86_64; 950 } 951 952 static void parseClangOption(StringRef opt, const Twine &msg) { 953 std::string err; 954 raw_string_ostream os(err); 955 956 const char *argv[] = {config->progName.data(), opt.data()}; 957 if (cl::ParseCommandLineOptions(2, argv, "", &os)) 958 return; 959 os.flush(); 960 error(msg + ": " + StringRef(err).trim()); 961 } 962 963 // Checks the parameter of the bti-report and cet-report options. 964 static bool isValidReportString(StringRef arg) { 965 return arg == "none" || arg == "warning" || arg == "error"; 966 } 967 968 // Initializes Config members by the command line options. 969 static void readConfigs(opt::InputArgList &args) { 970 errorHandler().verbose = args.hasArg(OPT_verbose); 971 errorHandler().vsDiagnostics = 972 args.hasArg(OPT_visual_studio_diagnostics_format, false); 973 974 config->allowMultipleDefinition = 975 args.hasFlag(OPT_allow_multiple_definition, 976 OPT_no_allow_multiple_definition, false) || 977 hasZOption(args, "muldefs"); 978 config->auxiliaryList = args::getStrings(args, OPT_auxiliary); 979 if (opt::Arg *arg = 980 args.getLastArg(OPT_Bno_symbolic, OPT_Bsymbolic_non_weak_functions, 981 OPT_Bsymbolic_functions, OPT_Bsymbolic)) { 982 if (arg->getOption().matches(OPT_Bsymbolic_non_weak_functions)) 983 config->bsymbolic = BsymbolicKind::NonWeakFunctions; 984 else if (arg->getOption().matches(OPT_Bsymbolic_functions)) 985 config->bsymbolic = BsymbolicKind::Functions; 986 else if (arg->getOption().matches(OPT_Bsymbolic)) 987 config->bsymbolic = BsymbolicKind::All; 988 } 989 config->checkSections = 990 args.hasFlag(OPT_check_sections, OPT_no_check_sections, true); 991 config->chroot = args.getLastArgValue(OPT_chroot); 992 config->compressDebugSections = getCompressDebugSections(args); 993 config->cref = args.hasArg(OPT_cref); 994 config->optimizeBBJumps = 995 args.hasFlag(OPT_optimize_bb_jumps, OPT_no_optimize_bb_jumps, false); 996 config->demangle = args.hasFlag(OPT_demangle, OPT_no_demangle, true); 997 config->dependencyFile = args.getLastArgValue(OPT_dependency_file); 998 config->dependentLibraries = args.hasFlag(OPT_dependent_libraries, OPT_no_dependent_libraries, true); 999 config->disableVerify = args.hasArg(OPT_disable_verify); 1000 config->discard = getDiscard(args); 1001 config->dwoDir = args.getLastArgValue(OPT_plugin_opt_dwo_dir_eq); 1002 config->dynamicLinker = getDynamicLinker(args); 1003 config->ehFrameHdr = 1004 args.hasFlag(OPT_eh_frame_hdr, OPT_no_eh_frame_hdr, false); 1005 config->emitLLVM = args.hasArg(OPT_plugin_opt_emit_llvm, false); 1006 config->emitRelocs = args.hasArg(OPT_emit_relocs); 1007 config->callGraphProfileSort = args.hasFlag( 1008 OPT_call_graph_profile_sort, OPT_no_call_graph_profile_sort, true); 1009 config->enableNewDtags = 1010 args.hasFlag(OPT_enable_new_dtags, OPT_disable_new_dtags, true); 1011 config->entry = args.getLastArgValue(OPT_entry); 1012 1013 errorHandler().errorHandlingScript = 1014 args.getLastArgValue(OPT_error_handling_script); 1015 1016 config->executeOnly = 1017 args.hasFlag(OPT_execute_only, OPT_no_execute_only, false); 1018 config->exportDynamic = 1019 args.hasFlag(OPT_export_dynamic, OPT_no_export_dynamic, false); 1020 config->filterList = args::getStrings(args, OPT_filter); 1021 config->fini = args.getLastArgValue(OPT_fini, "_fini"); 1022 config->fixCortexA53Errata843419 = args.hasArg(OPT_fix_cortex_a53_843419) && 1023 !args.hasArg(OPT_relocatable); 1024 config->fixCortexA8 = 1025 args.hasArg(OPT_fix_cortex_a8) && !args.hasArg(OPT_relocatable); 1026 config->fortranCommon = 1027 args.hasFlag(OPT_fortran_common, OPT_no_fortran_common, true); 1028 config->gcSections = args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, false); 1029 config->gnuUnique = args.hasFlag(OPT_gnu_unique, OPT_no_gnu_unique, true); 1030 config->gdbIndex = args.hasFlag(OPT_gdb_index, OPT_no_gdb_index, false); 1031 config->icf = getICF(args); 1032 config->ignoreDataAddressEquality = 1033 args.hasArg(OPT_ignore_data_address_equality); 1034 config->ignoreFunctionAddressEquality = 1035 args.hasArg(OPT_ignore_function_address_equality); 1036 config->init = args.getLastArgValue(OPT_init, "_init"); 1037 config->ltoAAPipeline = args.getLastArgValue(OPT_lto_aa_pipeline); 1038 config->ltoCSProfileGenerate = args.hasArg(OPT_lto_cs_profile_generate); 1039 config->ltoCSProfileFile = args.getLastArgValue(OPT_lto_cs_profile_file); 1040 config->ltoPGOWarnMismatch = args.hasFlag(OPT_lto_pgo_warn_mismatch, 1041 OPT_no_lto_pgo_warn_mismatch, true); 1042 config->ltoDebugPassManager = args.hasArg(OPT_lto_debug_pass_manager); 1043 config->ltoEmitAsm = args.hasArg(OPT_lto_emit_asm); 1044 config->ltoNewPassManager = 1045 args.hasFlag(OPT_no_lto_legacy_pass_manager, OPT_lto_legacy_pass_manager, 1046 LLVM_ENABLE_NEW_PASS_MANAGER); 1047 config->ltoNewPmPasses = args.getLastArgValue(OPT_lto_newpm_passes); 1048 config->ltoWholeProgramVisibility = 1049 args.hasFlag(OPT_lto_whole_program_visibility, 1050 OPT_no_lto_whole_program_visibility, false); 1051 config->ltoo = args::getInteger(args, OPT_lto_O, 2); 1052 config->ltoObjPath = args.getLastArgValue(OPT_lto_obj_path_eq); 1053 config->ltoPartitions = args::getInteger(args, OPT_lto_partitions, 1); 1054 config->ltoSampleProfile = args.getLastArgValue(OPT_lto_sample_profile); 1055 config->ltoBasicBlockSections = 1056 args.getLastArgValue(OPT_lto_basic_block_sections); 1057 config->ltoUniqueBasicBlockSectionNames = 1058 args.hasFlag(OPT_lto_unique_basic_block_section_names, 1059 OPT_no_lto_unique_basic_block_section_names, false); 1060 config->mapFile = args.getLastArgValue(OPT_Map); 1061 config->mipsGotSize = args::getInteger(args, OPT_mips_got_size, 0xfff0); 1062 config->mergeArmExidx = 1063 args.hasFlag(OPT_merge_exidx_entries, OPT_no_merge_exidx_entries, true); 1064 config->mmapOutputFile = 1065 args.hasFlag(OPT_mmap_output_file, OPT_no_mmap_output_file, true); 1066 config->nmagic = args.hasFlag(OPT_nmagic, OPT_no_nmagic, false); 1067 config->noinhibitExec = args.hasArg(OPT_noinhibit_exec); 1068 config->nostdlib = args.hasArg(OPT_nostdlib); 1069 config->oFormatBinary = isOutputFormatBinary(args); 1070 config->omagic = args.hasFlag(OPT_omagic, OPT_no_omagic, false); 1071 config->optRemarksFilename = args.getLastArgValue(OPT_opt_remarks_filename); 1072 1073 // Parse remarks hotness threshold. Valid value is either integer or 'auto'. 1074 if (auto *arg = args.getLastArg(OPT_opt_remarks_hotness_threshold)) { 1075 auto resultOrErr = remarks::parseHotnessThresholdOption(arg->getValue()); 1076 if (!resultOrErr) 1077 error(arg->getSpelling() + ": invalid argument '" + arg->getValue() + 1078 "', only integer or 'auto' is supported"); 1079 else 1080 config->optRemarksHotnessThreshold = *resultOrErr; 1081 } 1082 1083 config->optRemarksPasses = args.getLastArgValue(OPT_opt_remarks_passes); 1084 config->optRemarksWithHotness = args.hasArg(OPT_opt_remarks_with_hotness); 1085 config->optRemarksFormat = args.getLastArgValue(OPT_opt_remarks_format); 1086 config->optimize = args::getInteger(args, OPT_O, 1); 1087 config->orphanHandling = getOrphanHandling(args); 1088 config->outputFile = args.getLastArgValue(OPT_o); 1089 config->pie = args.hasFlag(OPT_pie, OPT_no_pie, false); 1090 config->printIcfSections = 1091 args.hasFlag(OPT_print_icf_sections, OPT_no_print_icf_sections, false); 1092 config->printGcSections = 1093 args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false); 1094 config->printArchiveStats = args.getLastArgValue(OPT_print_archive_stats); 1095 config->printSymbolOrder = 1096 args.getLastArgValue(OPT_print_symbol_order); 1097 config->relax = args.hasFlag(OPT_relax, OPT_no_relax, true); 1098 config->rpath = getRpath(args); 1099 config->relocatable = args.hasArg(OPT_relocatable); 1100 config->saveTemps = args.hasArg(OPT_save_temps); 1101 config->searchPaths = args::getStrings(args, OPT_library_path); 1102 config->sectionStartMap = getSectionStartMap(args); 1103 config->shared = args.hasArg(OPT_shared); 1104 config->singleRoRx = !args.hasFlag(OPT_rosegment, OPT_no_rosegment, true); 1105 config->soName = args.getLastArgValue(OPT_soname); 1106 config->sortSection = getSortSection(args); 1107 config->splitStackAdjustSize = args::getInteger(args, OPT_split_stack_adjust_size, 16384); 1108 config->strip = getStrip(args); 1109 config->sysroot = args.getLastArgValue(OPT_sysroot); 1110 config->target1Rel = args.hasFlag(OPT_target1_rel, OPT_target1_abs, false); 1111 config->target2 = getTarget2(args); 1112 config->thinLTOCacheDir = args.getLastArgValue(OPT_thinlto_cache_dir); 1113 config->thinLTOCachePolicy = CHECK( 1114 parseCachePruningPolicy(args.getLastArgValue(OPT_thinlto_cache_policy)), 1115 "--thinlto-cache-policy: invalid cache policy"); 1116 config->thinLTOEmitImportsFiles = args.hasArg(OPT_thinlto_emit_imports_files); 1117 config->thinLTOIndexOnly = args.hasArg(OPT_thinlto_index_only) || 1118 args.hasArg(OPT_thinlto_index_only_eq); 1119 config->thinLTOIndexOnlyArg = args.getLastArgValue(OPT_thinlto_index_only_eq); 1120 config->thinLTOObjectSuffixReplace = 1121 getOldNewOptions(args, OPT_thinlto_object_suffix_replace_eq); 1122 config->thinLTOPrefixReplace = 1123 getOldNewOptions(args, OPT_thinlto_prefix_replace_eq); 1124 config->thinLTOModulesToCompile = 1125 args::getStrings(args, OPT_thinlto_single_module_eq); 1126 config->timeTraceEnabled = args.hasArg(OPT_time_trace); 1127 config->timeTraceGranularity = 1128 args::getInteger(args, OPT_time_trace_granularity, 500); 1129 config->trace = args.hasArg(OPT_trace); 1130 config->undefined = args::getStrings(args, OPT_undefined); 1131 config->undefinedVersion = 1132 args.hasFlag(OPT_undefined_version, OPT_no_undefined_version, true); 1133 config->unique = args.hasArg(OPT_unique); 1134 config->useAndroidRelrTags = args.hasFlag( 1135 OPT_use_android_relr_tags, OPT_no_use_android_relr_tags, false); 1136 config->warnBackrefs = 1137 args.hasFlag(OPT_warn_backrefs, OPT_no_warn_backrefs, false); 1138 config->warnCommon = args.hasFlag(OPT_warn_common, OPT_no_warn_common, false); 1139 config->warnSymbolOrdering = 1140 args.hasFlag(OPT_warn_symbol_ordering, OPT_no_warn_symbol_ordering, true); 1141 config->whyExtract = args.getLastArgValue(OPT_why_extract); 1142 config->zCombreloc = getZFlag(args, "combreloc", "nocombreloc", true); 1143 config->zCopyreloc = getZFlag(args, "copyreloc", "nocopyreloc", true); 1144 config->zForceBti = hasZOption(args, "force-bti"); 1145 config->zForceIbt = hasZOption(args, "force-ibt"); 1146 config->zGlobal = hasZOption(args, "global"); 1147 config->zGnustack = getZGnuStack(args); 1148 config->zHazardplt = hasZOption(args, "hazardplt"); 1149 config->zIfuncNoplt = hasZOption(args, "ifunc-noplt"); 1150 config->zInitfirst = hasZOption(args, "initfirst"); 1151 config->zInterpose = hasZOption(args, "interpose"); 1152 config->zKeepTextSectionPrefix = getZFlag( 1153 args, "keep-text-section-prefix", "nokeep-text-section-prefix", false); 1154 config->zNodefaultlib = hasZOption(args, "nodefaultlib"); 1155 config->zNodelete = hasZOption(args, "nodelete"); 1156 config->zNodlopen = hasZOption(args, "nodlopen"); 1157 config->zNow = getZFlag(args, "now", "lazy", false); 1158 config->zOrigin = hasZOption(args, "origin"); 1159 config->zPacPlt = hasZOption(args, "pac-plt"); 1160 config->zRelro = getZFlag(args, "relro", "norelro", true); 1161 config->zRetpolineplt = hasZOption(args, "retpolineplt"); 1162 config->zRodynamic = hasZOption(args, "rodynamic"); 1163 config->zSeparate = getZSeparate(args); 1164 config->zShstk = hasZOption(args, "shstk"); 1165 config->zStackSize = args::getZOptionValue(args, OPT_z, "stack-size", 0); 1166 config->zStartStopGC = 1167 getZFlag(args, "start-stop-gc", "nostart-stop-gc", true); 1168 config->zStartStopVisibility = getZStartStopVisibility(args); 1169 config->zText = getZFlag(args, "text", "notext", true); 1170 config->zWxneeded = hasZOption(args, "wxneeded"); 1171 setUnresolvedSymbolPolicy(args); 1172 config->power10Stubs = args.getLastArgValue(OPT_power10_stubs_eq) != "no"; 1173 1174 if (opt::Arg *arg = args.getLastArg(OPT_eb, OPT_el)) { 1175 if (arg->getOption().matches(OPT_eb)) 1176 config->optEB = true; 1177 else 1178 config->optEL = true; 1179 } 1180 1181 for (opt::Arg *arg : args.filtered(OPT_shuffle_sections)) { 1182 constexpr StringRef errPrefix = "--shuffle-sections=: "; 1183 std::pair<StringRef, StringRef> kv = StringRef(arg->getValue()).split('='); 1184 if (kv.first.empty() || kv.second.empty()) { 1185 error(errPrefix + "expected <section_glob>=<seed>, but got '" + 1186 arg->getValue() + "'"); 1187 continue; 1188 } 1189 // Signed so that <section_glob>=-1 is allowed. 1190 int64_t v; 1191 if (!to_integer(kv.second, v)) 1192 error(errPrefix + "expected an integer, but got '" + kv.second + "'"); 1193 else if (Expected<GlobPattern> pat = GlobPattern::create(kv.first)) 1194 config->shuffleSections.emplace_back(std::move(*pat), uint32_t(v)); 1195 else 1196 error(errPrefix + toString(pat.takeError())); 1197 } 1198 1199 auto reports = {std::make_pair("bti-report", &config->zBtiReport), 1200 std::make_pair("cet-report", &config->zCetReport)}; 1201 for (opt::Arg *arg : args.filtered(OPT_z)) { 1202 std::pair<StringRef, StringRef> option = 1203 StringRef(arg->getValue()).split('='); 1204 for (auto reportArg : reports) { 1205 if (option.first != reportArg.first) 1206 continue; 1207 if (!isValidReportString(option.second)) { 1208 error(Twine("-z ") + reportArg.first + "= parameter " + option.second + 1209 " is not recognized"); 1210 continue; 1211 } 1212 *reportArg.second = option.second; 1213 } 1214 } 1215 1216 for (opt::Arg *arg : args.filtered(OPT_z)) { 1217 std::pair<StringRef, StringRef> option = 1218 StringRef(arg->getValue()).split('='); 1219 if (option.first != "dead-reloc-in-nonalloc") 1220 continue; 1221 constexpr StringRef errPrefix = "-z dead-reloc-in-nonalloc=: "; 1222 std::pair<StringRef, StringRef> kv = option.second.split('='); 1223 if (kv.first.empty() || kv.second.empty()) { 1224 error(errPrefix + "expected <section_glob>=<value>"); 1225 continue; 1226 } 1227 uint64_t v; 1228 if (!to_integer(kv.second, v)) 1229 error(errPrefix + "expected a non-negative integer, but got '" + 1230 kv.second + "'"); 1231 else if (Expected<GlobPattern> pat = GlobPattern::create(kv.first)) 1232 config->deadRelocInNonAlloc.emplace_back(std::move(*pat), v); 1233 else 1234 error(errPrefix + toString(pat.takeError())); 1235 } 1236 1237 cl::ResetAllOptionOccurrences(); 1238 1239 // Parse LTO options. 1240 if (auto *arg = args.getLastArg(OPT_plugin_opt_mcpu_eq)) 1241 parseClangOption(saver().save("-mcpu=" + StringRef(arg->getValue())), 1242 arg->getSpelling()); 1243 1244 for (opt::Arg *arg : args.filtered(OPT_plugin_opt_eq_minus)) 1245 parseClangOption(std::string("-") + arg->getValue(), arg->getSpelling()); 1246 1247 // GCC collect2 passes -plugin-opt=path/to/lto-wrapper with an absolute or 1248 // relative path. Just ignore. If not ended with "lto-wrapper", consider it an 1249 // unsupported LLVMgold.so option and error. 1250 for (opt::Arg *arg : args.filtered(OPT_plugin_opt_eq)) 1251 if (!StringRef(arg->getValue()).endswith("lto-wrapper")) 1252 error(arg->getSpelling() + ": unknown plugin option '" + arg->getValue() + 1253 "'"); 1254 1255 // Parse -mllvm options. 1256 for (auto *arg : args.filtered(OPT_mllvm)) 1257 parseClangOption(arg->getValue(), arg->getSpelling()); 1258 1259 // --threads= takes a positive integer and provides the default value for 1260 // --thinlto-jobs=. 1261 if (auto *arg = args.getLastArg(OPT_threads)) { 1262 StringRef v(arg->getValue()); 1263 unsigned threads = 0; 1264 if (!llvm::to_integer(v, threads, 0) || threads == 0) 1265 error(arg->getSpelling() + ": expected a positive integer, but got '" + 1266 arg->getValue() + "'"); 1267 parallel::strategy = hardware_concurrency(threads); 1268 config->thinLTOJobs = v; 1269 } 1270 if (auto *arg = args.getLastArg(OPT_thinlto_jobs)) 1271 config->thinLTOJobs = arg->getValue(); 1272 1273 if (config->ltoo > 3) 1274 error("invalid optimization level for LTO: " + Twine(config->ltoo)); 1275 if (config->ltoPartitions == 0) 1276 error("--lto-partitions: number of threads must be > 0"); 1277 if (!get_threadpool_strategy(config->thinLTOJobs)) 1278 error("--thinlto-jobs: invalid job count: " + config->thinLTOJobs); 1279 1280 if (config->splitStackAdjustSize < 0) 1281 error("--split-stack-adjust-size: size must be >= 0"); 1282 1283 // The text segment is traditionally the first segment, whose address equals 1284 // the base address. However, lld places the R PT_LOAD first. -Ttext-segment 1285 // is an old-fashioned option that does not play well with lld's layout. 1286 // Suggest --image-base as a likely alternative. 1287 if (args.hasArg(OPT_Ttext_segment)) 1288 error("-Ttext-segment is not supported. Use --image-base if you " 1289 "intend to set the base address"); 1290 1291 // Parse ELF{32,64}{LE,BE} and CPU type. 1292 if (auto *arg = args.getLastArg(OPT_m)) { 1293 StringRef s = arg->getValue(); 1294 std::tie(config->ekind, config->emachine, config->osabi) = 1295 parseEmulation(s); 1296 config->mipsN32Abi = 1297 (s.startswith("elf32btsmipn32") || s.startswith("elf32ltsmipn32")); 1298 config->emulation = s; 1299 } 1300 1301 // Parse --hash-style={sysv,gnu,both}. 1302 if (auto *arg = args.getLastArg(OPT_hash_style)) { 1303 StringRef s = arg->getValue(); 1304 if (s == "sysv") 1305 config->sysvHash = true; 1306 else if (s == "gnu") 1307 config->gnuHash = true; 1308 else if (s == "both") 1309 config->sysvHash = config->gnuHash = true; 1310 else 1311 error("unknown --hash-style: " + s); 1312 } 1313 1314 if (args.hasArg(OPT_print_map)) 1315 config->mapFile = "-"; 1316 1317 // Page alignment can be disabled by the -n (--nmagic) and -N (--omagic). 1318 // As PT_GNU_RELRO relies on Paging, do not create it when we have disabled 1319 // it. 1320 if (config->nmagic || config->omagic) 1321 config->zRelro = false; 1322 1323 std::tie(config->buildId, config->buildIdVector) = getBuildId(args); 1324 1325 std::tie(config->androidPackDynRelocs, config->relrPackDynRelocs) = 1326 getPackDynRelocs(args); 1327 1328 if (auto *arg = args.getLastArg(OPT_symbol_ordering_file)){ 1329 if (args.hasArg(OPT_call_graph_ordering_file)) 1330 error("--symbol-ordering-file and --call-graph-order-file " 1331 "may not be used together"); 1332 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())){ 1333 config->symbolOrderingFile = getSymbolOrderingFile(*buffer); 1334 // Also need to disable CallGraphProfileSort to prevent 1335 // LLD order symbols with CGProfile 1336 config->callGraphProfileSort = false; 1337 } 1338 } 1339 1340 assert(config->versionDefinitions.empty()); 1341 config->versionDefinitions.push_back( 1342 {"local", (uint16_t)VER_NDX_LOCAL, {}, {}}); 1343 config->versionDefinitions.push_back( 1344 {"global", (uint16_t)VER_NDX_GLOBAL, {}, {}}); 1345 1346 // If --retain-symbol-file is used, we'll keep only the symbols listed in 1347 // the file and discard all others. 1348 if (auto *arg = args.getLastArg(OPT_retain_symbols_file)) { 1349 config->versionDefinitions[VER_NDX_LOCAL].nonLocalPatterns.push_back( 1350 {"*", /*isExternCpp=*/false, /*hasWildcard=*/true}); 1351 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 1352 for (StringRef s : args::getLines(*buffer)) 1353 config->versionDefinitions[VER_NDX_GLOBAL].nonLocalPatterns.push_back( 1354 {s, /*isExternCpp=*/false, /*hasWildcard=*/false}); 1355 } 1356 1357 for (opt::Arg *arg : args.filtered(OPT_warn_backrefs_exclude)) { 1358 StringRef pattern(arg->getValue()); 1359 if (Expected<GlobPattern> pat = GlobPattern::create(pattern)) 1360 config->warnBackrefsExclude.push_back(std::move(*pat)); 1361 else 1362 error(arg->getSpelling() + ": " + toString(pat.takeError())); 1363 } 1364 1365 // For -no-pie and -pie, --export-dynamic-symbol specifies defined symbols 1366 // which should be exported. For -shared, references to matched non-local 1367 // STV_DEFAULT symbols are not bound to definitions within the shared object, 1368 // even if other options express a symbolic intention: -Bsymbolic, 1369 // -Bsymbolic-functions (if STT_FUNC), --dynamic-list. 1370 for (auto *arg : args.filtered(OPT_export_dynamic_symbol)) 1371 config->dynamicList.push_back( 1372 {arg->getValue(), /*isExternCpp=*/false, 1373 /*hasWildcard=*/hasWildcard(arg->getValue())}); 1374 1375 // --export-dynamic-symbol-list specifies a list of --export-dynamic-symbol 1376 // patterns. --dynamic-list is --export-dynamic-symbol-list plus -Bsymbolic 1377 // like semantics. 1378 config->symbolic = 1379 config->bsymbolic == BsymbolicKind::All || args.hasArg(OPT_dynamic_list); 1380 for (auto *arg : 1381 args.filtered(OPT_dynamic_list, OPT_export_dynamic_symbol_list)) 1382 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 1383 readDynamicList(*buffer); 1384 1385 for (auto *arg : args.filtered(OPT_version_script)) 1386 if (Optional<std::string> path = searchScript(arg->getValue())) { 1387 if (Optional<MemoryBufferRef> buffer = readFile(*path)) 1388 readVersionScript(*buffer); 1389 } else { 1390 error(Twine("cannot find version script ") + arg->getValue()); 1391 } 1392 } 1393 1394 // Some Config members do not directly correspond to any particular 1395 // command line options, but computed based on other Config values. 1396 // This function initialize such members. See Config.h for the details 1397 // of these values. 1398 static void setConfigs(opt::InputArgList &args) { 1399 ELFKind k = config->ekind; 1400 uint16_t m = config->emachine; 1401 1402 config->copyRelocs = (config->relocatable || config->emitRelocs); 1403 config->is64 = (k == ELF64LEKind || k == ELF64BEKind); 1404 config->isLE = (k == ELF32LEKind || k == ELF64LEKind); 1405 config->endianness = config->isLE ? endianness::little : endianness::big; 1406 config->isMips64EL = (k == ELF64LEKind && m == EM_MIPS); 1407 config->isPic = config->pie || config->shared; 1408 config->picThunk = args.hasArg(OPT_pic_veneer, config->isPic); 1409 config->wordsize = config->is64 ? 8 : 4; 1410 1411 // ELF defines two different ways to store relocation addends as shown below: 1412 // 1413 // Rel: Addends are stored to the location where relocations are applied. It 1414 // cannot pack the full range of addend values for all relocation types, but 1415 // this only affects relocation types that we don't support emitting as 1416 // dynamic relocations (see getDynRel). 1417 // Rela: Addends are stored as part of relocation entry. 1418 // 1419 // In other words, Rela makes it easy to read addends at the price of extra 1420 // 4 or 8 byte for each relocation entry. 1421 // 1422 // We pick the format for dynamic relocations according to the psABI for each 1423 // processor, but a contrary choice can be made if the dynamic loader 1424 // supports. 1425 config->isRela = getIsRela(args); 1426 1427 // If the output uses REL relocations we must store the dynamic relocation 1428 // addends to the output sections. We also store addends for RELA relocations 1429 // if --apply-dynamic-relocs is used. 1430 // We default to not writing the addends when using RELA relocations since 1431 // any standard conforming tool can find it in r_addend. 1432 config->writeAddends = args.hasFlag(OPT_apply_dynamic_relocs, 1433 OPT_no_apply_dynamic_relocs, false) || 1434 !config->isRela; 1435 // Validation of dynamic relocation addends is on by default for assertions 1436 // builds (for supported targets) and disabled otherwise. Ideally we would 1437 // enable the debug checks for all targets, but currently not all targets 1438 // have support for reading Elf_Rel addends, so we only enable for a subset. 1439 #ifndef NDEBUG 1440 bool checkDynamicRelocsDefault = m == EM_ARM || m == EM_386 || m == EM_MIPS || 1441 m == EM_X86_64 || m == EM_RISCV; 1442 #else 1443 bool checkDynamicRelocsDefault = false; 1444 #endif 1445 config->checkDynamicRelocs = 1446 args.hasFlag(OPT_check_dynamic_relocations, 1447 OPT_no_check_dynamic_relocations, checkDynamicRelocsDefault); 1448 config->tocOptimize = 1449 args.hasFlag(OPT_toc_optimize, OPT_no_toc_optimize, m == EM_PPC64); 1450 config->pcRelOptimize = 1451 args.hasFlag(OPT_pcrel_optimize, OPT_no_pcrel_optimize, m == EM_PPC64); 1452 } 1453 1454 static bool isFormatBinary(StringRef s) { 1455 if (s == "binary") 1456 return true; 1457 if (s == "elf" || s == "default") 1458 return false; 1459 error("unknown --format value: " + s + 1460 " (supported formats: elf, default, binary)"); 1461 return false; 1462 } 1463 1464 void LinkerDriver::createFiles(opt::InputArgList &args) { 1465 llvm::TimeTraceScope timeScope("Load input files"); 1466 // For --{push,pop}-state. 1467 std::vector<std::tuple<bool, bool, bool>> stack; 1468 1469 // Iterate over argv to process input files and positional arguments. 1470 InputFile::isInGroup = false; 1471 bool hasInput = false; 1472 for (auto *arg : args) { 1473 switch (arg->getOption().getID()) { 1474 case OPT_library: 1475 addLibrary(arg->getValue()); 1476 hasInput = true; 1477 break; 1478 case OPT_INPUT: 1479 addFile(arg->getValue(), /*withLOption=*/false); 1480 hasInput = true; 1481 break; 1482 case OPT_defsym: { 1483 StringRef from; 1484 StringRef to; 1485 std::tie(from, to) = StringRef(arg->getValue()).split('='); 1486 if (from.empty() || to.empty()) 1487 error("--defsym: syntax error: " + StringRef(arg->getValue())); 1488 else 1489 readDefsym(from, MemoryBufferRef(to, "--defsym")); 1490 break; 1491 } 1492 case OPT_script: 1493 if (Optional<std::string> path = searchScript(arg->getValue())) { 1494 if (Optional<MemoryBufferRef> mb = readFile(*path)) 1495 readLinkerScript(*mb); 1496 break; 1497 } 1498 error(Twine("cannot find linker script ") + arg->getValue()); 1499 break; 1500 case OPT_as_needed: 1501 config->asNeeded = true; 1502 break; 1503 case OPT_format: 1504 config->formatBinary = isFormatBinary(arg->getValue()); 1505 break; 1506 case OPT_no_as_needed: 1507 config->asNeeded = false; 1508 break; 1509 case OPT_Bstatic: 1510 case OPT_omagic: 1511 case OPT_nmagic: 1512 config->isStatic = true; 1513 break; 1514 case OPT_Bdynamic: 1515 config->isStatic = false; 1516 break; 1517 case OPT_whole_archive: 1518 inWholeArchive = true; 1519 break; 1520 case OPT_no_whole_archive: 1521 inWholeArchive = false; 1522 break; 1523 case OPT_just_symbols: 1524 if (Optional<MemoryBufferRef> mb = readFile(arg->getValue())) { 1525 files.push_back(createObjectFile(*mb)); 1526 files.back()->justSymbols = true; 1527 } 1528 break; 1529 case OPT_start_group: 1530 if (InputFile::isInGroup) 1531 error("nested --start-group"); 1532 InputFile::isInGroup = true; 1533 break; 1534 case OPT_end_group: 1535 if (!InputFile::isInGroup) 1536 error("stray --end-group"); 1537 InputFile::isInGroup = false; 1538 ++InputFile::nextGroupId; 1539 break; 1540 case OPT_start_lib: 1541 if (inLib) 1542 error("nested --start-lib"); 1543 if (InputFile::isInGroup) 1544 error("may not nest --start-lib in --start-group"); 1545 inLib = true; 1546 InputFile::isInGroup = true; 1547 break; 1548 case OPT_end_lib: 1549 if (!inLib) 1550 error("stray --end-lib"); 1551 inLib = false; 1552 InputFile::isInGroup = false; 1553 ++InputFile::nextGroupId; 1554 break; 1555 case OPT_push_state: 1556 stack.emplace_back(config->asNeeded, config->isStatic, inWholeArchive); 1557 break; 1558 case OPT_pop_state: 1559 if (stack.empty()) { 1560 error("unbalanced --push-state/--pop-state"); 1561 break; 1562 } 1563 std::tie(config->asNeeded, config->isStatic, inWholeArchive) = stack.back(); 1564 stack.pop_back(); 1565 break; 1566 } 1567 } 1568 1569 if (files.empty() && !hasInput && errorCount() == 0) 1570 error("no input files"); 1571 } 1572 1573 // If -m <machine_type> was not given, infer it from object files. 1574 void LinkerDriver::inferMachineType() { 1575 if (config->ekind != ELFNoneKind) 1576 return; 1577 1578 for (InputFile *f : files) { 1579 if (f->ekind == ELFNoneKind) 1580 continue; 1581 config->ekind = f->ekind; 1582 config->emachine = f->emachine; 1583 config->osabi = f->osabi; 1584 config->mipsN32Abi = config->emachine == EM_MIPS && isMipsN32Abi(f); 1585 return; 1586 } 1587 error("target emulation unknown: -m or at least one .o file required"); 1588 } 1589 1590 // Parse -z max-page-size=<value>. The default value is defined by 1591 // each target. 1592 static uint64_t getMaxPageSize(opt::InputArgList &args) { 1593 uint64_t val = args::getZOptionValue(args, OPT_z, "max-page-size", 1594 target->defaultMaxPageSize); 1595 if (!isPowerOf2_64(val)) 1596 error("max-page-size: value isn't a power of 2"); 1597 if (config->nmagic || config->omagic) { 1598 if (val != target->defaultMaxPageSize) 1599 warn("-z max-page-size set, but paging disabled by omagic or nmagic"); 1600 return 1; 1601 } 1602 return val; 1603 } 1604 1605 // Parse -z common-page-size=<value>. The default value is defined by 1606 // each target. 1607 static uint64_t getCommonPageSize(opt::InputArgList &args) { 1608 uint64_t val = args::getZOptionValue(args, OPT_z, "common-page-size", 1609 target->defaultCommonPageSize); 1610 if (!isPowerOf2_64(val)) 1611 error("common-page-size: value isn't a power of 2"); 1612 if (config->nmagic || config->omagic) { 1613 if (val != target->defaultCommonPageSize) 1614 warn("-z common-page-size set, but paging disabled by omagic or nmagic"); 1615 return 1; 1616 } 1617 // commonPageSize can't be larger than maxPageSize. 1618 if (val > config->maxPageSize) 1619 val = config->maxPageSize; 1620 return val; 1621 } 1622 1623 // Parses --image-base option. 1624 static Optional<uint64_t> getImageBase(opt::InputArgList &args) { 1625 // Because we are using "Config->maxPageSize" here, this function has to be 1626 // called after the variable is initialized. 1627 auto *arg = args.getLastArg(OPT_image_base); 1628 if (!arg) 1629 return None; 1630 1631 StringRef s = arg->getValue(); 1632 uint64_t v; 1633 if (!to_integer(s, v)) { 1634 error("--image-base: number expected, but got " + s); 1635 return 0; 1636 } 1637 if ((v % config->maxPageSize) != 0) 1638 warn("--image-base: address isn't multiple of page size: " + s); 1639 return v; 1640 } 1641 1642 // Parses `--exclude-libs=lib,lib,...`. 1643 // The library names may be delimited by commas or colons. 1644 static DenseSet<StringRef> getExcludeLibs(opt::InputArgList &args) { 1645 DenseSet<StringRef> ret; 1646 for (auto *arg : args.filtered(OPT_exclude_libs)) { 1647 StringRef s = arg->getValue(); 1648 for (;;) { 1649 size_t pos = s.find_first_of(",:"); 1650 if (pos == StringRef::npos) 1651 break; 1652 ret.insert(s.substr(0, pos)); 1653 s = s.substr(pos + 1); 1654 } 1655 ret.insert(s); 1656 } 1657 return ret; 1658 } 1659 1660 // Handles the --exclude-libs option. If a static library file is specified 1661 // by the --exclude-libs option, all public symbols from the archive become 1662 // private unless otherwise specified by version scripts or something. 1663 // A special library name "ALL" means all archive files. 1664 // 1665 // This is not a popular option, but some programs such as bionic libc use it. 1666 static void excludeLibs(opt::InputArgList &args) { 1667 DenseSet<StringRef> libs = getExcludeLibs(args); 1668 bool all = libs.count("ALL"); 1669 1670 auto visit = [&](InputFile *file) { 1671 if (!file->archiveName.empty()) 1672 if (all || libs.count(path::filename(file->archiveName))) 1673 for (Symbol *sym : file->getSymbols()) 1674 if (!sym->isUndefined() && !sym->isLocal() && sym->file == file) 1675 sym->versionId = VER_NDX_LOCAL; 1676 }; 1677 1678 for (ELFFileBase *file : objectFiles) 1679 visit(file); 1680 1681 for (BitcodeFile *file : bitcodeFiles) 1682 visit(file); 1683 } 1684 1685 // Force Sym to be entered in the output. 1686 static void handleUndefined(Symbol *sym, const char *option) { 1687 // Since a symbol may not be used inside the program, LTO may 1688 // eliminate it. Mark the symbol as "used" to prevent it. 1689 sym->isUsedInRegularObj = true; 1690 1691 if (!sym->isLazy()) 1692 return; 1693 sym->extract(); 1694 if (!config->whyExtract.empty()) 1695 whyExtract.emplace_back(option, sym->file, *sym); 1696 } 1697 1698 // As an extension to GNU linkers, lld supports a variant of `-u` 1699 // which accepts wildcard patterns. All symbols that match a given 1700 // pattern are handled as if they were given by `-u`. 1701 static void handleUndefinedGlob(StringRef arg) { 1702 Expected<GlobPattern> pat = GlobPattern::create(arg); 1703 if (!pat) { 1704 error("--undefined-glob: " + toString(pat.takeError())); 1705 return; 1706 } 1707 1708 // Calling sym->extract() in the loop is not safe because it may add new 1709 // symbols to the symbol table, invalidating the current iterator. 1710 SmallVector<Symbol *, 0> syms; 1711 for (Symbol *sym : symtab->symbols()) 1712 if (!sym->isPlaceholder() && pat->match(sym->getName())) 1713 syms.push_back(sym); 1714 1715 for (Symbol *sym : syms) 1716 handleUndefined(sym, "--undefined-glob"); 1717 } 1718 1719 static void handleLibcall(StringRef name) { 1720 Symbol *sym = symtab->find(name); 1721 if (!sym || !sym->isLazy()) 1722 return; 1723 1724 MemoryBufferRef mb; 1725 mb = cast<LazyObject>(sym)->file->mb; 1726 1727 if (isBitcode(mb)) 1728 sym->extract(); 1729 } 1730 1731 // Handle --dependency-file=<path>. If that option is given, lld creates a 1732 // file at a given path with the following contents: 1733 // 1734 // <output-file>: <input-file> ... 1735 // 1736 // <input-file>: 1737 // 1738 // where <output-file> is a pathname of an output file and <input-file> 1739 // ... is a list of pathnames of all input files. `make` command can read a 1740 // file in the above format and interpret it as a dependency info. We write 1741 // phony targets for every <input-file> to avoid an error when that file is 1742 // removed. 1743 // 1744 // This option is useful if you want to make your final executable to depend 1745 // on all input files including system libraries. Here is why. 1746 // 1747 // When you write a Makefile, you usually write it so that the final 1748 // executable depends on all user-generated object files. Normally, you 1749 // don't make your executable to depend on system libraries (such as libc) 1750 // because you don't know the exact paths of libraries, even though system 1751 // libraries that are linked to your executable statically are technically a 1752 // part of your program. By using --dependency-file option, you can make 1753 // lld to dump dependency info so that you can maintain exact dependencies 1754 // easily. 1755 static void writeDependencyFile() { 1756 std::error_code ec; 1757 raw_fd_ostream os(config->dependencyFile, ec, sys::fs::OF_None); 1758 if (ec) { 1759 error("cannot open " + config->dependencyFile + ": " + ec.message()); 1760 return; 1761 } 1762 1763 // We use the same escape rules as Clang/GCC which are accepted by Make/Ninja: 1764 // * A space is escaped by a backslash which itself must be escaped. 1765 // * A hash sign is escaped by a single backslash. 1766 // * $ is escapes as $$. 1767 auto printFilename = [](raw_fd_ostream &os, StringRef filename) { 1768 llvm::SmallString<256> nativePath; 1769 llvm::sys::path::native(filename.str(), nativePath); 1770 llvm::sys::path::remove_dots(nativePath, /*remove_dot_dot=*/true); 1771 for (unsigned i = 0, e = nativePath.size(); i != e; ++i) { 1772 if (nativePath[i] == '#') { 1773 os << '\\'; 1774 } else if (nativePath[i] == ' ') { 1775 os << '\\'; 1776 unsigned j = i; 1777 while (j > 0 && nativePath[--j] == '\\') 1778 os << '\\'; 1779 } else if (nativePath[i] == '$') { 1780 os << '$'; 1781 } 1782 os << nativePath[i]; 1783 } 1784 }; 1785 1786 os << config->outputFile << ":"; 1787 for (StringRef path : config->dependencyFiles) { 1788 os << " \\\n "; 1789 printFilename(os, path); 1790 } 1791 os << "\n"; 1792 1793 for (StringRef path : config->dependencyFiles) { 1794 os << "\n"; 1795 printFilename(os, path); 1796 os << ":\n"; 1797 } 1798 } 1799 1800 // Replaces common symbols with defined symbols reside in .bss sections. 1801 // This function is called after all symbol names are resolved. As a 1802 // result, the passes after the symbol resolution won't see any 1803 // symbols of type CommonSymbol. 1804 static void replaceCommonSymbols() { 1805 llvm::TimeTraceScope timeScope("Replace common symbols"); 1806 for (ELFFileBase *file : objectFiles) { 1807 if (!file->hasCommonSyms) 1808 continue; 1809 for (Symbol *sym : file->getGlobalSymbols()) { 1810 auto *s = dyn_cast<CommonSymbol>(sym); 1811 if (!s) 1812 continue; 1813 1814 auto *bss = make<BssSection>("COMMON", s->size, s->alignment); 1815 bss->file = s->file; 1816 inputSections.push_back(bss); 1817 s->replace(Defined{s->file, StringRef(), s->binding, s->stOther, s->type, 1818 /*value=*/0, s->size, bss}); 1819 } 1820 } 1821 } 1822 1823 // If all references to a DSO happen to be weak, the DSO is not added to 1824 // DT_NEEDED. If that happens, replace ShardSymbol with Undefined to avoid 1825 // dangling references to an unneeded DSO. Use a weak binding to avoid 1826 // --no-allow-shlib-undefined diagnostics. Similarly, demote lazy symbols. 1827 static void demoteSharedAndLazySymbols() { 1828 llvm::TimeTraceScope timeScope("Demote shared and lazy symbols"); 1829 for (Symbol *sym : symtab->symbols()) { 1830 auto *s = dyn_cast<SharedSymbol>(sym); 1831 if (!(s && !s->getFile().isNeeded) && !sym->isLazy()) 1832 continue; 1833 1834 bool used = sym->used; 1835 uint8_t binding = sym->isLazy() ? sym->binding : uint8_t(STB_WEAK); 1836 sym->replace( 1837 Undefined{nullptr, sym->getName(), binding, sym->stOther, sym->type}); 1838 sym->used = used; 1839 sym->versionId = VER_NDX_GLOBAL; 1840 } 1841 } 1842 1843 // The section referred to by `s` is considered address-significant. Set the 1844 // keepUnique flag on the section if appropriate. 1845 static void markAddrsig(Symbol *s) { 1846 if (auto *d = dyn_cast_or_null<Defined>(s)) 1847 if (d->section) 1848 // We don't need to keep text sections unique under --icf=all even if they 1849 // are address-significant. 1850 if (config->icf == ICFLevel::Safe || !(d->section->flags & SHF_EXECINSTR)) 1851 d->section->keepUnique = true; 1852 } 1853 1854 // Record sections that define symbols mentioned in --keep-unique <symbol> 1855 // and symbols referred to by address-significance tables. These sections are 1856 // ineligible for ICF. 1857 template <class ELFT> 1858 static void findKeepUniqueSections(opt::InputArgList &args) { 1859 for (auto *arg : args.filtered(OPT_keep_unique)) { 1860 StringRef name = arg->getValue(); 1861 auto *d = dyn_cast_or_null<Defined>(symtab->find(name)); 1862 if (!d || !d->section) { 1863 warn("could not find symbol " + name + " to keep unique"); 1864 continue; 1865 } 1866 d->section->keepUnique = true; 1867 } 1868 1869 // --icf=all --ignore-data-address-equality means that we can ignore 1870 // the dynsym and address-significance tables entirely. 1871 if (config->icf == ICFLevel::All && config->ignoreDataAddressEquality) 1872 return; 1873 1874 // Symbols in the dynsym could be address-significant in other executables 1875 // or DSOs, so we conservatively mark them as address-significant. 1876 for (Symbol *sym : symtab->symbols()) 1877 if (sym->includeInDynsym()) 1878 markAddrsig(sym); 1879 1880 // Visit the address-significance table in each object file and mark each 1881 // referenced symbol as address-significant. 1882 for (InputFile *f : objectFiles) { 1883 auto *obj = cast<ObjFile<ELFT>>(f); 1884 ArrayRef<Symbol *> syms = obj->getSymbols(); 1885 if (obj->addrsigSec) { 1886 ArrayRef<uint8_t> contents = 1887 check(obj->getObj().getSectionContents(*obj->addrsigSec)); 1888 const uint8_t *cur = contents.begin(); 1889 while (cur != contents.end()) { 1890 unsigned size; 1891 const char *err; 1892 uint64_t symIndex = decodeULEB128(cur, &size, contents.end(), &err); 1893 if (err) 1894 fatal(toString(f) + ": could not decode addrsig section: " + err); 1895 markAddrsig(syms[symIndex]); 1896 cur += size; 1897 } 1898 } else { 1899 // If an object file does not have an address-significance table, 1900 // conservatively mark all of its symbols as address-significant. 1901 for (Symbol *s : syms) 1902 markAddrsig(s); 1903 } 1904 } 1905 } 1906 1907 // This function reads a symbol partition specification section. These sections 1908 // are used to control which partition a symbol is allocated to. See 1909 // https://lld.llvm.org/Partitions.html for more details on partitions. 1910 template <typename ELFT> 1911 static void readSymbolPartitionSection(InputSectionBase *s) { 1912 // Read the relocation that refers to the partition's entry point symbol. 1913 Symbol *sym; 1914 const RelsOrRelas<ELFT> rels = s->template relsOrRelas<ELFT>(); 1915 if (rels.areRelocsRel()) 1916 sym = &s->getFile<ELFT>()->getRelocTargetSym(rels.rels[0]); 1917 else 1918 sym = &s->getFile<ELFT>()->getRelocTargetSym(rels.relas[0]); 1919 if (!isa<Defined>(sym) || !sym->includeInDynsym()) 1920 return; 1921 1922 StringRef partName = reinterpret_cast<const char *>(s->data().data()); 1923 for (Partition &part : partitions) { 1924 if (part.name == partName) { 1925 sym->partition = part.getNumber(); 1926 return; 1927 } 1928 } 1929 1930 // Forbid partitions from being used on incompatible targets, and forbid them 1931 // from being used together with various linker features that assume a single 1932 // set of output sections. 1933 if (script->hasSectionsCommand) 1934 error(toString(s->file) + 1935 ": partitions cannot be used with the SECTIONS command"); 1936 if (script->hasPhdrsCommands()) 1937 error(toString(s->file) + 1938 ": partitions cannot be used with the PHDRS command"); 1939 if (!config->sectionStartMap.empty()) 1940 error(toString(s->file) + ": partitions cannot be used with " 1941 "--section-start, -Ttext, -Tdata or -Tbss"); 1942 if (config->emachine == EM_MIPS) 1943 error(toString(s->file) + ": partitions cannot be used on this target"); 1944 1945 // Impose a limit of no more than 254 partitions. This limit comes from the 1946 // sizes of the Partition fields in InputSectionBase and Symbol, as well as 1947 // the amount of space devoted to the partition number in RankFlags. 1948 if (partitions.size() == 254) 1949 fatal("may not have more than 254 partitions"); 1950 1951 partitions.emplace_back(); 1952 Partition &newPart = partitions.back(); 1953 newPart.name = partName; 1954 sym->partition = newPart.getNumber(); 1955 } 1956 1957 static Symbol *addUndefined(StringRef name) { 1958 return symtab->addSymbol( 1959 Undefined{nullptr, name, STB_GLOBAL, STV_DEFAULT, 0}); 1960 } 1961 1962 static Symbol *addUnusedUndefined(StringRef name, 1963 uint8_t binding = STB_GLOBAL) { 1964 Undefined sym{nullptr, name, binding, STV_DEFAULT, 0}; 1965 sym.isUsedInRegularObj = false; 1966 return symtab->addSymbol(sym); 1967 } 1968 1969 static void markBuffersAsDontNeed(bool skipLinkedOutput) { 1970 // With --thinlto-index-only, all buffers are nearly unused from now on 1971 // (except symbol/section names used by infrequent passes). Mark input file 1972 // buffers as MADV_DONTNEED so that these pages can be reused by the expensive 1973 // thin link, saving memory. 1974 if (skipLinkedOutput) { 1975 for (MemoryBuffer &mb : llvm::make_pointee_range(memoryBuffers)) 1976 mb.dontNeedIfMmap(); 1977 return; 1978 } 1979 1980 // Otherwise, just mark MemoryBuffers backing BitcodeFiles. 1981 DenseSet<const char *> bufs; 1982 for (BitcodeFile *file : bitcodeFiles) 1983 bufs.insert(file->mb.getBufferStart()); 1984 for (BitcodeFile *file : lazyBitcodeFiles) 1985 bufs.insert(file->mb.getBufferStart()); 1986 for (MemoryBuffer &mb : llvm::make_pointee_range(memoryBuffers)) 1987 if (bufs.count(mb.getBufferStart())) 1988 mb.dontNeedIfMmap(); 1989 } 1990 1991 // This function is where all the optimizations of link-time 1992 // optimization takes place. When LTO is in use, some input files are 1993 // not in native object file format but in the LLVM bitcode format. 1994 // This function compiles bitcode files into a few big native files 1995 // using LLVM functions and replaces bitcode symbols with the results. 1996 // Because all bitcode files that the program consists of are passed to 1997 // the compiler at once, it can do a whole-program optimization. 1998 template <class ELFT> 1999 void LinkerDriver::compileBitcodeFiles(bool skipLinkedOutput) { 2000 llvm::TimeTraceScope timeScope("LTO"); 2001 // Compile bitcode files and replace bitcode symbols. 2002 lto.reset(new BitcodeCompiler); 2003 for (BitcodeFile *file : bitcodeFiles) 2004 lto->add(*file); 2005 2006 if (!bitcodeFiles.empty()) 2007 markBuffersAsDontNeed(skipLinkedOutput); 2008 2009 for (InputFile *file : lto->compile()) { 2010 auto *obj = cast<ObjFile<ELFT>>(file); 2011 obj->parse(/*ignoreComdats=*/true); 2012 2013 // Parse '@' in symbol names for non-relocatable output. 2014 if (!config->relocatable) 2015 for (Symbol *sym : obj->getGlobalSymbols()) 2016 if (sym->hasVersionSuffix) 2017 sym->parseSymbolVersion(); 2018 objectFiles.push_back(obj); 2019 } 2020 } 2021 2022 // The --wrap option is a feature to rename symbols so that you can write 2023 // wrappers for existing functions. If you pass `--wrap=foo`, all 2024 // occurrences of symbol `foo` are resolved to `__wrap_foo` (so, you are 2025 // expected to write `__wrap_foo` function as a wrapper). The original 2026 // symbol becomes accessible as `__real_foo`, so you can call that from your 2027 // wrapper. 2028 // 2029 // This data structure is instantiated for each --wrap option. 2030 struct WrappedSymbol { 2031 Symbol *sym; 2032 Symbol *real; 2033 Symbol *wrap; 2034 }; 2035 2036 // Handles --wrap option. 2037 // 2038 // This function instantiates wrapper symbols. At this point, they seem 2039 // like they are not being used at all, so we explicitly set some flags so 2040 // that LTO won't eliminate them. 2041 static std::vector<WrappedSymbol> addWrappedSymbols(opt::InputArgList &args) { 2042 std::vector<WrappedSymbol> v; 2043 DenseSet<StringRef> seen; 2044 2045 for (auto *arg : args.filtered(OPT_wrap)) { 2046 StringRef name = arg->getValue(); 2047 if (!seen.insert(name).second) 2048 continue; 2049 2050 Symbol *sym = symtab->find(name); 2051 // Avoid wrapping symbols that are lazy and unreferenced at this point, to 2052 // not create undefined references. The isUsedInRegularObj check handles the 2053 // case of a weak reference, which we still want to wrap even though it 2054 // doesn't cause lazy symbols to be extracted. 2055 if (!sym || (sym->isLazy() && !sym->isUsedInRegularObj)) 2056 continue; 2057 2058 Symbol *real = addUnusedUndefined(saver().save("__real_" + name)); 2059 Symbol *wrap = 2060 addUnusedUndefined(saver().save("__wrap_" + name), sym->binding); 2061 v.push_back({sym, real, wrap}); 2062 2063 // We want to tell LTO not to inline symbols to be overwritten 2064 // because LTO doesn't know the final symbol contents after renaming. 2065 real->scriptDefined = true; 2066 sym->scriptDefined = true; 2067 2068 // Tell LTO not to eliminate these symbols. 2069 sym->isUsedInRegularObj = true; 2070 // If sym is referenced in any object file, bitcode file or shared object, 2071 // retain wrap which is the redirection target of sym. If the object file 2072 // defining sym has sym references, we cannot easily distinguish the case 2073 // from cases where sym is not referenced. Retain wrap because we choose to 2074 // wrap sym references regardless of whether sym is defined 2075 // (https://sourceware.org/bugzilla/show_bug.cgi?id=26358). 2076 if (sym->referenced || sym->isDefined()) 2077 wrap->isUsedInRegularObj = true; 2078 } 2079 return v; 2080 } 2081 2082 // Do renaming for --wrap and foo@v1 by updating pointers to symbols. 2083 // 2084 // When this function is executed, only InputFiles and symbol table 2085 // contain pointers to symbol objects. We visit them to replace pointers, 2086 // so that wrapped symbols are swapped as instructed by the command line. 2087 static void redirectSymbols(ArrayRef<WrappedSymbol> wrapped) { 2088 llvm::TimeTraceScope timeScope("Redirect symbols"); 2089 DenseMap<Symbol *, Symbol *> map; 2090 for (const WrappedSymbol &w : wrapped) { 2091 map[w.sym] = w.wrap; 2092 map[w.real] = w.sym; 2093 } 2094 for (Symbol *sym : symtab->symbols()) { 2095 // Enumerate symbols with a non-default version (foo@v1). hasVersionSuffix 2096 // filters out most symbols but is not sufficient. 2097 if (!sym->hasVersionSuffix) 2098 continue; 2099 const char *suffix1 = sym->getVersionSuffix(); 2100 if (suffix1[0] != '@' || suffix1[1] == '@') 2101 continue; 2102 2103 // Check the existing symbol foo. We have two special cases to handle: 2104 // 2105 // * There is a definition of foo@v1 and foo@@v1. 2106 // * There is a definition of foo@v1 and foo. 2107 Defined *sym2 = dyn_cast_or_null<Defined>(symtab->find(sym->getName())); 2108 if (!sym2) 2109 continue; 2110 const char *suffix2 = sym2->getVersionSuffix(); 2111 if (suffix2[0] == '@' && suffix2[1] == '@' && 2112 strcmp(suffix1 + 1, suffix2 + 2) == 0) { 2113 // foo@v1 and foo@@v1 should be merged, so redirect foo@v1 to foo@@v1. 2114 map.try_emplace(sym, sym2); 2115 // If both foo@v1 and foo@@v1 are defined and non-weak, report a duplicate 2116 // definition error. 2117 sym2->resolve(*sym); 2118 // Eliminate foo@v1 from the symbol table. 2119 sym->symbolKind = Symbol::PlaceholderKind; 2120 sym->isUsedInRegularObj = false; 2121 } else if (auto *sym1 = dyn_cast<Defined>(sym)) { 2122 if (sym2->versionId > VER_NDX_GLOBAL 2123 ? config->versionDefinitions[sym2->versionId].name == suffix1 + 1 2124 : sym1->section == sym2->section && sym1->value == sym2->value) { 2125 // Due to an assembler design flaw, if foo is defined, .symver foo, 2126 // foo@v1 defines both foo and foo@v1. Unless foo is bound to a 2127 // different version, GNU ld makes foo@v1 canonical and eliminates foo. 2128 // Emulate its behavior, otherwise we would have foo or foo@@v1 beside 2129 // foo@v1. foo@v1 and foo combining does not apply if they are not 2130 // defined in the same place. 2131 map.try_emplace(sym2, sym); 2132 sym2->symbolKind = Symbol::PlaceholderKind; 2133 sym2->isUsedInRegularObj = false; 2134 } 2135 } 2136 } 2137 2138 if (map.empty()) 2139 return; 2140 2141 // Update pointers in input files. 2142 parallelForEach(objectFiles, [&](ELFFileBase *file) { 2143 for (Symbol *&sym : file->getMutableGlobalSymbols()) 2144 if (Symbol *s = map.lookup(sym)) 2145 sym = s; 2146 }); 2147 2148 // Update pointers in the symbol table. 2149 for (const WrappedSymbol &w : wrapped) 2150 symtab->wrap(w.sym, w.real, w.wrap); 2151 } 2152 2153 static void checkAndReportMissingFeature(StringRef config, uint32_t features, 2154 uint32_t mask, const Twine &report) { 2155 if (!(features & mask)) { 2156 if (config == "error") 2157 error(report); 2158 else if (config == "warning") 2159 warn(report); 2160 } 2161 } 2162 2163 // To enable CET (x86's hardware-assited control flow enforcement), each 2164 // source file must be compiled with -fcf-protection. Object files compiled 2165 // with the flag contain feature flags indicating that they are compatible 2166 // with CET. We enable the feature only when all object files are compatible 2167 // with CET. 2168 // 2169 // This is also the case with AARCH64's BTI and PAC which use the similar 2170 // GNU_PROPERTY_AARCH64_FEATURE_1_AND mechanism. 2171 static uint32_t getAndFeatures() { 2172 if (config->emachine != EM_386 && config->emachine != EM_X86_64 && 2173 config->emachine != EM_AARCH64) 2174 return 0; 2175 2176 uint32_t ret = -1; 2177 for (ELFFileBase *f : objectFiles) { 2178 uint32_t features = f->andFeatures; 2179 2180 checkAndReportMissingFeature( 2181 config->zBtiReport, features, GNU_PROPERTY_AARCH64_FEATURE_1_BTI, 2182 toString(f) + ": -z bti-report: file does not have " 2183 "GNU_PROPERTY_AARCH64_FEATURE_1_BTI property"); 2184 2185 checkAndReportMissingFeature( 2186 config->zCetReport, features, GNU_PROPERTY_X86_FEATURE_1_IBT, 2187 toString(f) + ": -z cet-report: file does not have " 2188 "GNU_PROPERTY_X86_FEATURE_1_IBT property"); 2189 2190 checkAndReportMissingFeature( 2191 config->zCetReport, features, GNU_PROPERTY_X86_FEATURE_1_SHSTK, 2192 toString(f) + ": -z cet-report: file does not have " 2193 "GNU_PROPERTY_X86_FEATURE_1_SHSTK property"); 2194 2195 if (config->zForceBti && !(features & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)) { 2196 features |= GNU_PROPERTY_AARCH64_FEATURE_1_BTI; 2197 if (config->zBtiReport == "none") 2198 warn(toString(f) + ": -z force-bti: file does not have " 2199 "GNU_PROPERTY_AARCH64_FEATURE_1_BTI property"); 2200 } else if (config->zForceIbt && 2201 !(features & GNU_PROPERTY_X86_FEATURE_1_IBT)) { 2202 if (config->zCetReport == "none") 2203 warn(toString(f) + ": -z force-ibt: file does not have " 2204 "GNU_PROPERTY_X86_FEATURE_1_IBT property"); 2205 features |= GNU_PROPERTY_X86_FEATURE_1_IBT; 2206 } 2207 if (config->zPacPlt && !(features & GNU_PROPERTY_AARCH64_FEATURE_1_PAC)) { 2208 warn(toString(f) + ": -z pac-plt: file does not have " 2209 "GNU_PROPERTY_AARCH64_FEATURE_1_PAC property"); 2210 features |= GNU_PROPERTY_AARCH64_FEATURE_1_PAC; 2211 } 2212 ret &= features; 2213 } 2214 2215 // Force enable Shadow Stack. 2216 if (config->zShstk) 2217 ret |= GNU_PROPERTY_X86_FEATURE_1_SHSTK; 2218 2219 return ret; 2220 } 2221 2222 // Do actual linking. Note that when this function is called, 2223 // all linker scripts have already been parsed. 2224 void LinkerDriver::link(opt::InputArgList &args) { 2225 llvm::TimeTraceScope timeScope("Link", StringRef("LinkerDriver::Link")); 2226 // If a --hash-style option was not given, set to a default value, 2227 // which varies depending on the target. 2228 if (!args.hasArg(OPT_hash_style)) { 2229 if (config->emachine == EM_MIPS) 2230 config->sysvHash = true; 2231 else 2232 config->sysvHash = config->gnuHash = true; 2233 } 2234 2235 // Default output filename is "a.out" by the Unix tradition. 2236 if (config->outputFile.empty()) 2237 config->outputFile = "a.out"; 2238 2239 // Fail early if the output file or map file is not writable. If a user has a 2240 // long link, e.g. due to a large LTO link, they do not wish to run it and 2241 // find that it failed because there was a mistake in their command-line. 2242 { 2243 llvm::TimeTraceScope timeScope("Create output files"); 2244 if (auto e = tryCreateFile(config->outputFile)) 2245 error("cannot open output file " + config->outputFile + ": " + 2246 e.message()); 2247 if (auto e = tryCreateFile(config->mapFile)) 2248 error("cannot open map file " + config->mapFile + ": " + e.message()); 2249 if (auto e = tryCreateFile(config->whyExtract)) 2250 error("cannot open --why-extract= file " + config->whyExtract + ": " + 2251 e.message()); 2252 } 2253 if (errorCount()) 2254 return; 2255 2256 // Use default entry point name if no name was given via the command 2257 // line nor linker scripts. For some reason, MIPS entry point name is 2258 // different from others. 2259 config->warnMissingEntry = 2260 (!config->entry.empty() || (!config->shared && !config->relocatable)); 2261 if (config->entry.empty() && !config->relocatable) 2262 config->entry = (config->emachine == EM_MIPS) ? "__start" : "_start"; 2263 2264 // Handle --trace-symbol. 2265 for (auto *arg : args.filtered(OPT_trace_symbol)) 2266 symtab->insert(arg->getValue())->traced = true; 2267 2268 // Handle -u/--undefined before input files. If both a.a and b.so define foo, 2269 // -u foo a.a b.so will extract a.a. 2270 for (StringRef name : config->undefined) 2271 addUnusedUndefined(name)->referenced = true; 2272 2273 // Add all files to the symbol table. This will add almost all 2274 // symbols that we need to the symbol table. This process might 2275 // add files to the link, via autolinking, these files are always 2276 // appended to the Files vector. 2277 { 2278 llvm::TimeTraceScope timeScope("Parse input files"); 2279 for (size_t i = 0; i < files.size(); ++i) { 2280 llvm::TimeTraceScope timeScope("Parse input files", files[i]->getName()); 2281 parseFile(files[i]); 2282 } 2283 } 2284 2285 // Now that we have every file, we can decide if we will need a 2286 // dynamic symbol table. 2287 // We need one if we were asked to export dynamic symbols or if we are 2288 // producing a shared library. 2289 // We also need one if any shared libraries are used and for pie executables 2290 // (probably because the dynamic linker needs it). 2291 config->hasDynSymTab = 2292 !sharedFiles.empty() || config->isPic || config->exportDynamic; 2293 2294 // Some symbols (such as __ehdr_start) are defined lazily only when there 2295 // are undefined symbols for them, so we add these to trigger that logic. 2296 for (StringRef name : script->referencedSymbols) 2297 addUndefined(name); 2298 2299 // Prevent LTO from removing any definition referenced by -u. 2300 for (StringRef name : config->undefined) 2301 if (Defined *sym = dyn_cast_or_null<Defined>(symtab->find(name))) 2302 sym->isUsedInRegularObj = true; 2303 2304 // If an entry symbol is in a static archive, pull out that file now. 2305 if (Symbol *sym = symtab->find(config->entry)) 2306 handleUndefined(sym, "--entry"); 2307 2308 // Handle the `--undefined-glob <pattern>` options. 2309 for (StringRef pat : args::getStrings(args, OPT_undefined_glob)) 2310 handleUndefinedGlob(pat); 2311 2312 // Mark -init and -fini symbols so that the LTO doesn't eliminate them. 2313 if (Symbol *sym = dyn_cast_or_null<Defined>(symtab->find(config->init))) 2314 sym->isUsedInRegularObj = true; 2315 if (Symbol *sym = dyn_cast_or_null<Defined>(symtab->find(config->fini))) 2316 sym->isUsedInRegularObj = true; 2317 2318 // If any of our inputs are bitcode files, the LTO code generator may create 2319 // references to certain library functions that might not be explicit in the 2320 // bitcode file's symbol table. If any of those library functions are defined 2321 // in a bitcode file in an archive member, we need to arrange to use LTO to 2322 // compile those archive members by adding them to the link beforehand. 2323 // 2324 // However, adding all libcall symbols to the link can have undesired 2325 // consequences. For example, the libgcc implementation of 2326 // __sync_val_compare_and_swap_8 on 32-bit ARM pulls in an .init_array entry 2327 // that aborts the program if the Linux kernel does not support 64-bit 2328 // atomics, which would prevent the program from running even if it does not 2329 // use 64-bit atomics. 2330 // 2331 // Therefore, we only add libcall symbols to the link before LTO if we have 2332 // to, i.e. if the symbol's definition is in bitcode. Any other required 2333 // libcall symbols will be added to the link after LTO when we add the LTO 2334 // object file to the link. 2335 if (!bitcodeFiles.empty()) 2336 for (auto *s : lto::LTO::getRuntimeLibcallSymbols()) 2337 handleLibcall(s); 2338 2339 // Return if there were name resolution errors. 2340 if (errorCount()) 2341 return; 2342 2343 // We want to declare linker script's symbols early, 2344 // so that we can version them. 2345 // They also might be exported if referenced by DSOs. 2346 script->declareSymbols(); 2347 2348 // Handle --exclude-libs. This is before scanVersionScript() due to a 2349 // workaround for Android ndk: for a defined versioned symbol in an archive 2350 // without a version node in the version script, Android does not expect a 2351 // 'has undefined version' error in -shared --exclude-libs=ALL mode (PR36295). 2352 // GNU ld errors in this case. 2353 if (args.hasArg(OPT_exclude_libs)) 2354 excludeLibs(args); 2355 2356 // Create elfHeader early. We need a dummy section in 2357 // addReservedSymbols to mark the created symbols as not absolute. 2358 Out::elfHeader = make<OutputSection>("", 0, SHF_ALLOC); 2359 2360 std::vector<WrappedSymbol> wrapped = addWrappedSymbols(args); 2361 2362 // We need to create some reserved symbols such as _end. Create them. 2363 if (!config->relocatable) 2364 addReservedSymbols(); 2365 2366 // Apply version scripts. 2367 // 2368 // For a relocatable output, version scripts don't make sense, and 2369 // parsing a symbol version string (e.g. dropping "@ver1" from a symbol 2370 // name "foo@ver1") rather do harm, so we don't call this if -r is given. 2371 if (!config->relocatable) { 2372 llvm::TimeTraceScope timeScope("Process symbol versions"); 2373 symtab->scanVersionScript(); 2374 } 2375 2376 // Skip the normal linked output if some LTO options are specified. 2377 // 2378 // For --thinlto-index-only, index file creation is performed in 2379 // compileBitcodeFiles, so we are done afterwards. --plugin-opt=emit-llvm and 2380 // --plugin-opt=emit-asm create output files in bitcode or assembly code, 2381 // respectively. When only certain thinLTO modules are specified for 2382 // compilation, the intermediate object file are the expected output. 2383 const bool skipLinkedOutput = config->thinLTOIndexOnly || config->emitLLVM || 2384 config->ltoEmitAsm || 2385 !config->thinLTOModulesToCompile.empty(); 2386 2387 // Do link-time optimization if given files are LLVM bitcode files. 2388 // This compiles bitcode files into real object files. 2389 // 2390 // With this the symbol table should be complete. After this, no new names 2391 // except a few linker-synthesized ones will be added to the symbol table. 2392 invokeELFT(compileBitcodeFiles, skipLinkedOutput); 2393 2394 // Symbol resolution finished. Report backward reference problems. 2395 reportBackrefs(); 2396 if (errorCount()) 2397 return; 2398 2399 // Bail out if normal linked output is skipped due to LTO. 2400 if (skipLinkedOutput) 2401 return; 2402 2403 // Handle --exclude-libs again because lto.tmp may reference additional 2404 // libcalls symbols defined in an excluded archive. This may override 2405 // versionId set by scanVersionScript(). 2406 if (args.hasArg(OPT_exclude_libs)) 2407 excludeLibs(args); 2408 2409 // Apply symbol renames for --wrap and combine foo@v1 and foo@@v1. 2410 redirectSymbols(wrapped); 2411 2412 // Replace common symbols with regular symbols. 2413 replaceCommonSymbols(); 2414 2415 { 2416 llvm::TimeTraceScope timeScope("Aggregate sections"); 2417 // Now that we have a complete list of input files. 2418 // Beyond this point, no new files are added. 2419 // Aggregate all input sections into one place. 2420 for (InputFile *f : objectFiles) 2421 for (InputSectionBase *s : f->getSections()) 2422 if (s && s != &InputSection::discarded) 2423 inputSections.push_back(s); 2424 for (BinaryFile *f : binaryFiles) 2425 for (InputSectionBase *s : f->getSections()) 2426 inputSections.push_back(cast<InputSection>(s)); 2427 } 2428 2429 { 2430 llvm::TimeTraceScope timeScope("Strip sections"); 2431 llvm::erase_if(inputSections, [](InputSectionBase *s) { 2432 if (s->type == SHT_LLVM_SYMPART) { 2433 invokeELFT(readSymbolPartitionSection, s); 2434 return true; 2435 } 2436 2437 // We do not want to emit debug sections if --strip-all 2438 // or --strip-debug are given. 2439 if (config->strip == StripPolicy::None) 2440 return false; 2441 2442 if (isDebugSection(*s)) 2443 return true; 2444 if (auto *isec = dyn_cast<InputSection>(s)) 2445 if (InputSectionBase *rel = isec->getRelocatedSection()) 2446 if (isDebugSection(*rel)) 2447 return true; 2448 2449 return false; 2450 }); 2451 } 2452 2453 // Since we now have a complete set of input files, we can create 2454 // a .d file to record build dependencies. 2455 if (!config->dependencyFile.empty()) 2456 writeDependencyFile(); 2457 2458 // Now that the number of partitions is fixed, save a pointer to the main 2459 // partition. 2460 mainPart = &partitions[0]; 2461 2462 // Read .note.gnu.property sections from input object files which 2463 // contain a hint to tweak linker's and loader's behaviors. 2464 config->andFeatures = getAndFeatures(); 2465 2466 // The Target instance handles target-specific stuff, such as applying 2467 // relocations or writing a PLT section. It also contains target-dependent 2468 // values such as a default image base address. 2469 target = getTarget(); 2470 2471 config->eflags = target->calcEFlags(); 2472 // maxPageSize (sometimes called abi page size) is the maximum page size that 2473 // the output can be run on. For example if the OS can use 4k or 64k page 2474 // sizes then maxPageSize must be 64k for the output to be useable on both. 2475 // All important alignment decisions must use this value. 2476 config->maxPageSize = getMaxPageSize(args); 2477 // commonPageSize is the most common page size that the output will be run on. 2478 // For example if an OS can use 4k or 64k page sizes and 4k is more common 2479 // than 64k then commonPageSize is set to 4k. commonPageSize can be used for 2480 // optimizations such as DATA_SEGMENT_ALIGN in linker scripts. LLD's use of it 2481 // is limited to writing trap instructions on the last executable segment. 2482 config->commonPageSize = getCommonPageSize(args); 2483 2484 config->imageBase = getImageBase(args); 2485 2486 if (config->emachine == EM_ARM) { 2487 // FIXME: These warnings can be removed when lld only uses these features 2488 // when the input objects have been compiled with an architecture that 2489 // supports them. 2490 if (config->armHasBlx == false) 2491 warn("lld uses blx instruction, no object with architecture supporting " 2492 "feature detected"); 2493 } 2494 2495 // This adds a .comment section containing a version string. 2496 if (!config->relocatable) 2497 inputSections.push_back(createCommentSection()); 2498 2499 // Split SHF_MERGE and .eh_frame sections into pieces in preparation for garbage collection. 2500 invokeELFT(splitSections); 2501 2502 // Garbage collection and removal of shared symbols from unused shared objects. 2503 invokeELFT(markLive); 2504 demoteSharedAndLazySymbols(); 2505 2506 // Make copies of any input sections that need to be copied into each 2507 // partition. 2508 copySectionsIntoPartitions(); 2509 2510 // Create synthesized sections such as .got and .plt. This is called before 2511 // processSectionCommands() so that they can be placed by SECTIONS commands. 2512 invokeELFT(createSyntheticSections); 2513 2514 // Some input sections that are used for exception handling need to be moved 2515 // into synthetic sections. Do that now so that they aren't assigned to 2516 // output sections in the usual way. 2517 if (!config->relocatable) 2518 combineEhSections(); 2519 2520 { 2521 llvm::TimeTraceScope timeScope("Assign sections"); 2522 2523 // Create output sections described by SECTIONS commands. 2524 script->processSectionCommands(); 2525 2526 // Linker scripts control how input sections are assigned to output 2527 // sections. Input sections that were not handled by scripts are called 2528 // "orphans", and they are assigned to output sections by the default rule. 2529 // Process that. 2530 script->addOrphanSections(); 2531 } 2532 2533 { 2534 llvm::TimeTraceScope timeScope("Merge/finalize input sections"); 2535 2536 // Migrate InputSectionDescription::sectionBases to sections. This includes 2537 // merging MergeInputSections into a single MergeSyntheticSection. From this 2538 // point onwards InputSectionDescription::sections should be used instead of 2539 // sectionBases. 2540 for (SectionCommand *cmd : script->sectionCommands) 2541 if (auto *sec = dyn_cast<OutputSection>(cmd)) 2542 sec->finalizeInputSections(); 2543 llvm::erase_if(inputSections, [](InputSectionBase *s) { 2544 return isa<MergeInputSection>(s); 2545 }); 2546 } 2547 2548 // Two input sections with different output sections should not be folded. 2549 // ICF runs after processSectionCommands() so that we know the output sections. 2550 if (config->icf != ICFLevel::None) { 2551 invokeELFT(findKeepUniqueSections, args); 2552 invokeELFT(doIcf); 2553 } 2554 2555 // Read the callgraph now that we know what was gced or icfed 2556 if (config->callGraphProfileSort) { 2557 if (auto *arg = args.getLastArg(OPT_call_graph_ordering_file)) 2558 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 2559 readCallGraph(*buffer); 2560 invokeELFT(readCallGraphsFromObjectFiles); 2561 } 2562 2563 // Write the result to the file. 2564 invokeELFT(writeResult); 2565 } 2566