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/Threads.h" 47 #include "lld/Common/Version.h" 48 #include "llvm/ADT/SetVector.h" 49 #include "llvm/ADT/StringExtras.h" 50 #include "llvm/ADT/StringSwitch.h" 51 #include "llvm/LTO/LTO.h" 52 #include "llvm/Support/CommandLine.h" 53 #include "llvm/Support/Compression.h" 54 #include "llvm/Support/GlobPattern.h" 55 #include "llvm/Support/LEB128.h" 56 #include "llvm/Support/Path.h" 57 #include "llvm/Support/TarWriter.h" 58 #include "llvm/Support/TargetSelect.h" 59 #include "llvm/Support/raw_ostream.h" 60 #include <cstdlib> 61 #include <utility> 62 63 using namespace llvm; 64 using namespace llvm::ELF; 65 using namespace llvm::object; 66 using namespace llvm::sys; 67 using namespace llvm::support; 68 69 namespace lld { 70 namespace elf { 71 72 Configuration *config; 73 LinkerDriver *driver; 74 75 static void setConfigs(opt::InputArgList &args); 76 static void readConfigs(opt::InputArgList &args); 77 78 bool link(ArrayRef<const char *> args, bool canExitEarly, raw_ostream &error) { 79 errorHandler().logName = args::getFilenameWithoutExe(args[0]); 80 errorHandler().errorLimitExceededMsg = 81 "too many errors emitted, stopping now (use " 82 "-error-limit=0 to see all errors)"; 83 errorHandler().errorOS = &error; 84 errorHandler().exitEarly = canExitEarly; 85 enableColors(error.has_colors()); 86 87 inputSections.clear(); 88 outputSections.clear(); 89 binaryFiles.clear(); 90 bitcodeFiles.clear(); 91 objectFiles.clear(); 92 sharedFiles.clear(); 93 94 config = make<Configuration>(); 95 driver = make<LinkerDriver>(); 96 script = make<LinkerScript>(); 97 symtab = make<SymbolTable>(); 98 99 tar = nullptr; 100 memset(&in, 0, sizeof(in)); 101 102 partitions = {Partition()}; 103 104 SharedFile::vernauxNum = 0; 105 106 config->progName = args[0]; 107 108 driver->main(args); 109 110 // Exit immediately if we don't need to return to the caller. 111 // This saves time because the overhead of calling destructors 112 // for all globally-allocated objects is not negligible. 113 if (canExitEarly) 114 exitLld(errorCount() ? 1 : 0); 115 116 freeArena(); 117 return !errorCount(); 118 } 119 120 // Parses a linker -m option. 121 static std::tuple<ELFKind, uint16_t, uint8_t> parseEmulation(StringRef emul) { 122 uint8_t osabi = 0; 123 StringRef s = emul; 124 if (s.endswith("_fbsd")) { 125 s = s.drop_back(5); 126 osabi = ELFOSABI_FREEBSD; 127 } 128 129 std::pair<ELFKind, uint16_t> ret = 130 StringSwitch<std::pair<ELFKind, uint16_t>>(s) 131 .Cases("aarch64elf", "aarch64linux", "aarch64_elf64_le_vec", 132 {ELF64LEKind, EM_AARCH64}) 133 .Cases("armelf", "armelf_linux_eabi", {ELF32LEKind, EM_ARM}) 134 .Case("elf32_x86_64", {ELF32LEKind, EM_X86_64}) 135 .Cases("elf32btsmip", "elf32btsmipn32", {ELF32BEKind, EM_MIPS}) 136 .Cases("elf32ltsmip", "elf32ltsmipn32", {ELF32LEKind, EM_MIPS}) 137 .Case("elf32lriscv", {ELF32LEKind, EM_RISCV}) 138 .Cases("elf32ppc", "elf32ppclinux", {ELF32BEKind, EM_PPC}) 139 .Case("elf64btsmip", {ELF64BEKind, EM_MIPS}) 140 .Case("elf64ltsmip", {ELF64LEKind, EM_MIPS}) 141 .Case("elf64lriscv", {ELF64LEKind, EM_RISCV}) 142 .Case("elf64ppc", {ELF64BEKind, EM_PPC64}) 143 .Case("elf64lppc", {ELF64LEKind, EM_PPC64}) 144 .Cases("elf_amd64", "elf_x86_64", {ELF64LEKind, EM_X86_64}) 145 .Case("elf_i386", {ELF32LEKind, EM_386}) 146 .Case("elf_iamcu", {ELF32LEKind, EM_IAMCU}) 147 .Default({ELFNoneKind, EM_NONE}); 148 149 if (ret.first == ELFNoneKind) 150 error("unknown emulation: " + emul); 151 return std::make_tuple(ret.first, ret.second, osabi); 152 } 153 154 // Returns slices of MB by parsing MB as an archive file. 155 // Each slice consists of a member file in the archive. 156 std::vector<std::pair<MemoryBufferRef, uint64_t>> static getArchiveMembers( 157 MemoryBufferRef mb) { 158 std::unique_ptr<Archive> file = 159 CHECK(Archive::create(mb), 160 mb.getBufferIdentifier() + ": failed to parse archive"); 161 162 std::vector<std::pair<MemoryBufferRef, uint64_t>> v; 163 Error err = Error::success(); 164 bool addToTar = file->isThin() && tar; 165 for (const ErrorOr<Archive::Child> &cOrErr : file->children(err)) { 166 Archive::Child c = 167 CHECK(cOrErr, mb.getBufferIdentifier() + 168 ": could not get the child of the archive"); 169 MemoryBufferRef mbref = 170 CHECK(c.getMemoryBufferRef(), 171 mb.getBufferIdentifier() + 172 ": could not get the buffer for a child of the archive"); 173 if (addToTar) 174 tar->append(relativeToRoot(check(c.getFullName())), mbref.getBuffer()); 175 v.push_back(std::make_pair(mbref, c.getChildOffset())); 176 } 177 if (err) 178 fatal(mb.getBufferIdentifier() + ": Archive::children failed: " + 179 toString(std::move(err))); 180 181 // Take ownership of memory buffers created for members of thin archives. 182 for (std::unique_ptr<MemoryBuffer> &mb : file->takeThinBuffers()) 183 make<std::unique_ptr<MemoryBuffer>>(std::move(mb)); 184 185 return v; 186 } 187 188 // Opens a file and create a file object. Path has to be resolved already. 189 void LinkerDriver::addFile(StringRef path, bool withLOption) { 190 using namespace sys::fs; 191 192 Optional<MemoryBufferRef> buffer = readFile(path); 193 if (!buffer.hasValue()) 194 return; 195 MemoryBufferRef mbref = *buffer; 196 197 if (config->formatBinary) { 198 files.push_back(make<BinaryFile>(mbref)); 199 return; 200 } 201 202 switch (identify_magic(mbref.getBuffer())) { 203 case file_magic::unknown: 204 readLinkerScript(mbref); 205 return; 206 case file_magic::archive: { 207 // Handle -whole-archive. 208 if (inWholeArchive) { 209 for (const auto &p : getArchiveMembers(mbref)) 210 files.push_back(createObjectFile(p.first, path, p.second)); 211 return; 212 } 213 214 std::unique_ptr<Archive> file = 215 CHECK(Archive::create(mbref), path + ": failed to parse archive"); 216 217 // If an archive file has no symbol table, it is likely that a user 218 // is attempting LTO and using a default ar command that doesn't 219 // understand the LLVM bitcode file. It is a pretty common error, so 220 // we'll handle it as if it had a symbol table. 221 if (!file->isEmpty() && !file->hasSymbolTable()) { 222 // Check if all members are bitcode files. If not, ignore, which is the 223 // default action without the LTO hack described above. 224 for (const std::pair<MemoryBufferRef, uint64_t> &p : 225 getArchiveMembers(mbref)) 226 if (identify_magic(p.first.getBuffer()) != file_magic::bitcode) { 227 error(path + ": archive has no index; run ranlib to add one"); 228 return; 229 } 230 231 for (const std::pair<MemoryBufferRef, uint64_t> &p : 232 getArchiveMembers(mbref)) 233 files.push_back(make<LazyObjFile>(p.first, path, p.second)); 234 return; 235 } 236 237 // Handle the regular case. 238 files.push_back(make<ArchiveFile>(std::move(file))); 239 return; 240 } 241 case file_magic::elf_shared_object: 242 if (config->isStatic || config->relocatable) { 243 error("attempted static link of dynamic object " + path); 244 return; 245 } 246 247 // DSOs usually have DT_SONAME tags in their ELF headers, and the 248 // sonames are used to identify DSOs. But if they are missing, 249 // they are identified by filenames. We don't know whether the new 250 // file has a DT_SONAME or not because we haven't parsed it yet. 251 // Here, we set the default soname for the file because we might 252 // need it later. 253 // 254 // If a file was specified by -lfoo, the directory part is not 255 // significant, as a user did not specify it. This behavior is 256 // compatible with GNU. 257 files.push_back( 258 make<SharedFile>(mbref, withLOption ? path::filename(path) : path)); 259 return; 260 case file_magic::bitcode: 261 case file_magic::elf_relocatable: 262 if (inLib) 263 files.push_back(make<LazyObjFile>(mbref, "", 0)); 264 else 265 files.push_back(createObjectFile(mbref)); 266 break; 267 default: 268 error(path + ": unknown file type"); 269 } 270 } 271 272 // Add a given library by searching it from input search paths. 273 void LinkerDriver::addLibrary(StringRef name) { 274 if (Optional<std::string> path = searchLibrary(name)) 275 addFile(*path, /*withLOption=*/true); 276 else 277 error("unable to find library -l" + name); 278 } 279 280 // This function is called on startup. We need this for LTO since 281 // LTO calls LLVM functions to compile bitcode files to native code. 282 // Technically this can be delayed until we read bitcode files, but 283 // we don't bother to do lazily because the initialization is fast. 284 static void initLLVM() { 285 InitializeAllTargets(); 286 InitializeAllTargetMCs(); 287 InitializeAllAsmPrinters(); 288 InitializeAllAsmParsers(); 289 } 290 291 // Some command line options or some combinations of them are not allowed. 292 // This function checks for such errors. 293 static void checkOptions() { 294 // The MIPS ABI as of 2016 does not support the GNU-style symbol lookup 295 // table which is a relatively new feature. 296 if (config->emachine == EM_MIPS && config->gnuHash) 297 error("the .gnu.hash section is not compatible with the MIPS target"); 298 299 if (config->fixCortexA53Errata843419 && config->emachine != EM_AARCH64) 300 error("--fix-cortex-a53-843419 is only supported on AArch64 targets"); 301 302 if (config->fixCortexA8 && config->emachine != EM_ARM) 303 error("--fix-cortex-a8 is only supported on ARM targets"); 304 305 if (config->tocOptimize && config->emachine != EM_PPC64) 306 error("--toc-optimize is only supported on the PowerPC64 target"); 307 308 if (config->pie && config->shared) 309 error("-shared and -pie may not be used together"); 310 311 if (!config->shared && !config->filterList.empty()) 312 error("-F may not be used without -shared"); 313 314 if (!config->shared && !config->auxiliaryList.empty()) 315 error("-f may not be used without -shared"); 316 317 if (!config->relocatable && !config->defineCommon) 318 error("-no-define-common not supported in non relocatable output"); 319 320 if (config->strip == StripPolicy::All && config->emitRelocs) 321 error("--strip-all and --emit-relocs may not be used together"); 322 323 if (config->zText && config->zIfuncNoplt) 324 error("-z text and -z ifunc-noplt may not be used together"); 325 326 if (config->relocatable) { 327 if (config->shared) 328 error("-r and -shared may not be used together"); 329 if (config->gcSections) 330 error("-r and --gc-sections may not be used together"); 331 if (config->gdbIndex) 332 error("-r and --gdb-index may not be used together"); 333 if (config->icf != ICFLevel::None) 334 error("-r and --icf may not be used together"); 335 if (config->pie) 336 error("-r and -pie may not be used together"); 337 if (config->exportDynamic) 338 error("-r and --export-dynamic may not be used together"); 339 } 340 341 if (config->executeOnly) { 342 if (config->emachine != EM_AARCH64) 343 error("-execute-only is only supported on AArch64 targets"); 344 345 if (config->singleRoRx && !script->hasSectionsCommand) 346 error("-execute-only and -no-rosegment cannot be used together"); 347 } 348 349 if (config->zRetpolineplt && config->requireCET) 350 error("--require-cet may not be used with -z retpolineplt"); 351 352 if (config->emachine != EM_AARCH64) { 353 if (config->pacPlt) 354 error("--pac-plt only supported on AArch64"); 355 if (config->forceBTI) 356 error("--force-bti only supported on AArch64"); 357 } 358 } 359 360 static const char *getReproduceOption(opt::InputArgList &args) { 361 if (auto *arg = args.getLastArg(OPT_reproduce)) 362 return arg->getValue(); 363 return getenv("LLD_REPRODUCE"); 364 } 365 366 static bool hasZOption(opt::InputArgList &args, StringRef key) { 367 for (auto *arg : args.filtered(OPT_z)) 368 if (key == arg->getValue()) 369 return true; 370 return false; 371 } 372 373 static bool getZFlag(opt::InputArgList &args, StringRef k1, StringRef k2, 374 bool Default) { 375 for (auto *arg : args.filtered_reverse(OPT_z)) { 376 if (k1 == arg->getValue()) 377 return true; 378 if (k2 == arg->getValue()) 379 return false; 380 } 381 return Default; 382 } 383 384 static SeparateSegmentKind getZSeparate(opt::InputArgList &args) { 385 for (auto *arg : args.filtered_reverse(OPT_z)) { 386 StringRef v = arg->getValue(); 387 if (v == "noseparate-code") 388 return SeparateSegmentKind::None; 389 if (v == "separate-code") 390 return SeparateSegmentKind::Code; 391 if (v == "separate-loadable-segments") 392 return SeparateSegmentKind::Loadable; 393 } 394 return SeparateSegmentKind::None; 395 } 396 397 static bool isKnownZFlag(StringRef s) { 398 return s == "combreloc" || s == "copyreloc" || s == "defs" || 399 s == "execstack" || s == "global" || s == "hazardplt" || 400 s == "ifunc-noplt" || s == "initfirst" || s == "interpose" || 401 s == "keep-text-section-prefix" || s == "lazy" || s == "muldefs" || 402 s == "separate-code" || s == "separate-loadable-segments" || 403 s == "nocombreloc" || s == "nocopyreloc" || s == "nodefaultlib" || 404 s == "nodelete" || s == "nodlopen" || s == "noexecstack" || 405 s == "nokeep-text-section-prefix" || s == "norelro" || 406 s == "noseparate-code" || s == "notext" || s == "now" || 407 s == "origin" || s == "relro" || s == "retpolineplt" || 408 s == "rodynamic" || s == "text" || s == "undefs" || s == "wxneeded" || 409 s.startswith("common-page-size=") || s.startswith("max-page-size=") || 410 s.startswith("stack-size="); 411 } 412 413 // Report an error for an unknown -z option. 414 static void checkZOptions(opt::InputArgList &args) { 415 for (auto *arg : args.filtered(OPT_z)) 416 if (!isKnownZFlag(arg->getValue())) 417 error("unknown -z value: " + StringRef(arg->getValue())); 418 } 419 420 void LinkerDriver::main(ArrayRef<const char *> argsArr) { 421 ELFOptTable parser; 422 opt::InputArgList args = parser.parse(argsArr.slice(1)); 423 424 // Interpret this flag early because error() depends on them. 425 errorHandler().errorLimit = args::getInteger(args, OPT_error_limit, 20); 426 checkZOptions(args); 427 428 // Handle -help 429 if (args.hasArg(OPT_help)) { 430 printHelp(); 431 return; 432 } 433 434 // Handle -v or -version. 435 // 436 // A note about "compatible with GNU linkers" message: this is a hack for 437 // scripts generated by GNU Libtool 2.4.6 (released in February 2014 and 438 // still the newest version in March 2017) or earlier to recognize LLD as 439 // a GNU compatible linker. As long as an output for the -v option 440 // contains "GNU" or "with BFD", they recognize us as GNU-compatible. 441 // 442 // This is somewhat ugly hack, but in reality, we had no choice other 443 // than doing this. Considering the very long release cycle of Libtool, 444 // it is not easy to improve it to recognize LLD as a GNU compatible 445 // linker in a timely manner. Even if we can make it, there are still a 446 // lot of "configure" scripts out there that are generated by old version 447 // of Libtool. We cannot convince every software developer to migrate to 448 // the latest version and re-generate scripts. So we have this hack. 449 if (args.hasArg(OPT_v) || args.hasArg(OPT_version)) 450 message(getLLDVersion() + " (compatible with GNU linkers)"); 451 452 if (const char *path = getReproduceOption(args)) { 453 // Note that --reproduce is a debug option so you can ignore it 454 // if you are trying to understand the whole picture of the code. 455 Expected<std::unique_ptr<TarWriter>> errOrWriter = 456 TarWriter::create(path, path::stem(path)); 457 if (errOrWriter) { 458 tar = std::move(*errOrWriter); 459 tar->append("response.txt", createResponseFile(args)); 460 tar->append("version.txt", getLLDVersion() + "\n"); 461 } else { 462 error("--reproduce: " + toString(errOrWriter.takeError())); 463 } 464 } 465 466 readConfigs(args); 467 468 // The behavior of -v or --version is a bit strange, but this is 469 // needed for compatibility with GNU linkers. 470 if (args.hasArg(OPT_v) && !args.hasArg(OPT_INPUT)) 471 return; 472 if (args.hasArg(OPT_version)) 473 return; 474 475 initLLVM(); 476 createFiles(args); 477 if (errorCount()) 478 return; 479 480 inferMachineType(); 481 setConfigs(args); 482 checkOptions(); 483 if (errorCount()) 484 return; 485 486 // The Target instance handles target-specific stuff, such as applying 487 // relocations or writing a PLT section. It also contains target-dependent 488 // values such as a default image base address. 489 target = getTarget(); 490 491 switch (config->ekind) { 492 case ELF32LEKind: 493 link<ELF32LE>(args); 494 return; 495 case ELF32BEKind: 496 link<ELF32BE>(args); 497 return; 498 case ELF64LEKind: 499 link<ELF64LE>(args); 500 return; 501 case ELF64BEKind: 502 link<ELF64BE>(args); 503 return; 504 default: 505 llvm_unreachable("unknown Config->EKind"); 506 } 507 } 508 509 static std::string getRpath(opt::InputArgList &args) { 510 std::vector<StringRef> v = args::getStrings(args, OPT_rpath); 511 return llvm::join(v.begin(), v.end(), ":"); 512 } 513 514 // Determines what we should do if there are remaining unresolved 515 // symbols after the name resolution. 516 static UnresolvedPolicy getUnresolvedSymbolPolicy(opt::InputArgList &args) { 517 UnresolvedPolicy errorOrWarn = args.hasFlag(OPT_error_unresolved_symbols, 518 OPT_warn_unresolved_symbols, true) 519 ? UnresolvedPolicy::ReportError 520 : UnresolvedPolicy::Warn; 521 522 // Process the last of -unresolved-symbols, -no-undefined or -z defs. 523 for (auto *arg : llvm::reverse(args)) { 524 switch (arg->getOption().getID()) { 525 case OPT_unresolved_symbols: { 526 StringRef s = arg->getValue(); 527 if (s == "ignore-all" || s == "ignore-in-object-files") 528 return UnresolvedPolicy::Ignore; 529 if (s == "ignore-in-shared-libs" || s == "report-all") 530 return errorOrWarn; 531 error("unknown --unresolved-symbols value: " + s); 532 continue; 533 } 534 case OPT_no_undefined: 535 return errorOrWarn; 536 case OPT_z: 537 if (StringRef(arg->getValue()) == "defs") 538 return errorOrWarn; 539 if (StringRef(arg->getValue()) == "undefs") 540 return UnresolvedPolicy::Ignore; 541 continue; 542 } 543 } 544 545 // -shared implies -unresolved-symbols=ignore-all because missing 546 // symbols are likely to be resolved at runtime using other DSOs. 547 if (config->shared) 548 return UnresolvedPolicy::Ignore; 549 return errorOrWarn; 550 } 551 552 static Target2Policy getTarget2(opt::InputArgList &args) { 553 StringRef s = args.getLastArgValue(OPT_target2, "got-rel"); 554 if (s == "rel") 555 return Target2Policy::Rel; 556 if (s == "abs") 557 return Target2Policy::Abs; 558 if (s == "got-rel") 559 return Target2Policy::GotRel; 560 error("unknown --target2 option: " + s); 561 return Target2Policy::GotRel; 562 } 563 564 static bool isOutputFormatBinary(opt::InputArgList &args) { 565 StringRef s = args.getLastArgValue(OPT_oformat, "elf"); 566 if (s == "binary") 567 return true; 568 if (!s.startswith("elf")) 569 error("unknown --oformat value: " + s); 570 return false; 571 } 572 573 static DiscardPolicy getDiscard(opt::InputArgList &args) { 574 if (args.hasArg(OPT_relocatable)) 575 return DiscardPolicy::None; 576 577 auto *arg = 578 args.getLastArg(OPT_discard_all, OPT_discard_locals, OPT_discard_none); 579 if (!arg) 580 return DiscardPolicy::Default; 581 if (arg->getOption().getID() == OPT_discard_all) 582 return DiscardPolicy::All; 583 if (arg->getOption().getID() == OPT_discard_locals) 584 return DiscardPolicy::Locals; 585 return DiscardPolicy::None; 586 } 587 588 static StringRef getDynamicLinker(opt::InputArgList &args) { 589 auto *arg = args.getLastArg(OPT_dynamic_linker, OPT_no_dynamic_linker); 590 if (!arg || arg->getOption().getID() == OPT_no_dynamic_linker) 591 return ""; 592 return arg->getValue(); 593 } 594 595 static ICFLevel getICF(opt::InputArgList &args) { 596 auto *arg = args.getLastArg(OPT_icf_none, OPT_icf_safe, OPT_icf_all); 597 if (!arg || arg->getOption().getID() == OPT_icf_none) 598 return ICFLevel::None; 599 if (arg->getOption().getID() == OPT_icf_safe) 600 return ICFLevel::Safe; 601 return ICFLevel::All; 602 } 603 604 static StripPolicy getStrip(opt::InputArgList &args) { 605 if (args.hasArg(OPT_relocatable)) 606 return StripPolicy::None; 607 608 auto *arg = args.getLastArg(OPT_strip_all, OPT_strip_debug); 609 if (!arg) 610 return StripPolicy::None; 611 if (arg->getOption().getID() == OPT_strip_all) 612 return StripPolicy::All; 613 return StripPolicy::Debug; 614 } 615 616 static uint64_t parseSectionAddress(StringRef s, opt::InputArgList &args, 617 const opt::Arg &arg) { 618 uint64_t va = 0; 619 if (s.startswith("0x")) 620 s = s.drop_front(2); 621 if (!to_integer(s, va, 16)) 622 error("invalid argument: " + arg.getAsString(args)); 623 return va; 624 } 625 626 static StringMap<uint64_t> getSectionStartMap(opt::InputArgList &args) { 627 StringMap<uint64_t> ret; 628 for (auto *arg : args.filtered(OPT_section_start)) { 629 StringRef name; 630 StringRef addr; 631 std::tie(name, addr) = StringRef(arg->getValue()).split('='); 632 ret[name] = parseSectionAddress(addr, args, *arg); 633 } 634 635 if (auto *arg = args.getLastArg(OPT_Ttext)) 636 ret[".text"] = parseSectionAddress(arg->getValue(), args, *arg); 637 if (auto *arg = args.getLastArg(OPT_Tdata)) 638 ret[".data"] = parseSectionAddress(arg->getValue(), args, *arg); 639 if (auto *arg = args.getLastArg(OPT_Tbss)) 640 ret[".bss"] = parseSectionAddress(arg->getValue(), args, *arg); 641 return ret; 642 } 643 644 static SortSectionPolicy getSortSection(opt::InputArgList &args) { 645 StringRef s = args.getLastArgValue(OPT_sort_section); 646 if (s == "alignment") 647 return SortSectionPolicy::Alignment; 648 if (s == "name") 649 return SortSectionPolicy::Name; 650 if (!s.empty()) 651 error("unknown --sort-section rule: " + s); 652 return SortSectionPolicy::Default; 653 } 654 655 static OrphanHandlingPolicy getOrphanHandling(opt::InputArgList &args) { 656 StringRef s = args.getLastArgValue(OPT_orphan_handling, "place"); 657 if (s == "warn") 658 return OrphanHandlingPolicy::Warn; 659 if (s == "error") 660 return OrphanHandlingPolicy::Error; 661 if (s != "place") 662 error("unknown --orphan-handling mode: " + s); 663 return OrphanHandlingPolicy::Place; 664 } 665 666 // Parse --build-id or --build-id=<style>. We handle "tree" as a 667 // synonym for "sha1" because all our hash functions including 668 // -build-id=sha1 are actually tree hashes for performance reasons. 669 static std::pair<BuildIdKind, std::vector<uint8_t>> 670 getBuildId(opt::InputArgList &args) { 671 auto *arg = args.getLastArg(OPT_build_id, OPT_build_id_eq); 672 if (!arg) 673 return {BuildIdKind::None, {}}; 674 675 if (arg->getOption().getID() == OPT_build_id) 676 return {BuildIdKind::Fast, {}}; 677 678 StringRef s = arg->getValue(); 679 if (s == "fast") 680 return {BuildIdKind::Fast, {}}; 681 if (s == "md5") 682 return {BuildIdKind::Md5, {}}; 683 if (s == "sha1" || s == "tree") 684 return {BuildIdKind::Sha1, {}}; 685 if (s == "uuid") 686 return {BuildIdKind::Uuid, {}}; 687 if (s.startswith("0x")) 688 return {BuildIdKind::Hexstring, parseHex(s.substr(2))}; 689 690 if (s != "none") 691 error("unknown --build-id style: " + s); 692 return {BuildIdKind::None, {}}; 693 } 694 695 static std::pair<bool, bool> getPackDynRelocs(opt::InputArgList &args) { 696 StringRef s = args.getLastArgValue(OPT_pack_dyn_relocs, "none"); 697 if (s == "android") 698 return {true, false}; 699 if (s == "relr") 700 return {false, true}; 701 if (s == "android+relr") 702 return {true, true}; 703 704 if (s != "none") 705 error("unknown -pack-dyn-relocs format: " + s); 706 return {false, false}; 707 } 708 709 static void readCallGraph(MemoryBufferRef mb) { 710 // Build a map from symbol name to section 711 DenseMap<StringRef, Symbol *> map; 712 for (InputFile *file : objectFiles) 713 for (Symbol *sym : file->getSymbols()) 714 map[sym->getName()] = sym; 715 716 auto findSection = [&](StringRef name) -> InputSectionBase * { 717 Symbol *sym = map.lookup(name); 718 if (!sym) { 719 if (config->warnSymbolOrdering) 720 warn(mb.getBufferIdentifier() + ": no such symbol: " + name); 721 return nullptr; 722 } 723 maybeWarnUnorderableSymbol(sym); 724 725 if (Defined *dr = dyn_cast_or_null<Defined>(sym)) 726 return dyn_cast_or_null<InputSectionBase>(dr->section); 727 return nullptr; 728 }; 729 730 for (StringRef line : args::getLines(mb)) { 731 SmallVector<StringRef, 3> fields; 732 line.split(fields, ' '); 733 uint64_t count; 734 735 if (fields.size() != 3 || !to_integer(fields[2], count)) { 736 error(mb.getBufferIdentifier() + ": parse error"); 737 return; 738 } 739 740 if (InputSectionBase *from = findSection(fields[0])) 741 if (InputSectionBase *to = findSection(fields[1])) 742 config->callGraphProfile[std::make_pair(from, to)] += count; 743 } 744 } 745 746 template <class ELFT> static void readCallGraphsFromObjectFiles() { 747 for (auto file : objectFiles) { 748 auto *obj = cast<ObjFile<ELFT>>(file); 749 750 for (const Elf_CGProfile_Impl<ELFT> &cgpe : obj->cgProfile) { 751 auto *fromSym = dyn_cast<Defined>(&obj->getSymbol(cgpe.cgp_from)); 752 auto *toSym = dyn_cast<Defined>(&obj->getSymbol(cgpe.cgp_to)); 753 if (!fromSym || !toSym) 754 continue; 755 756 auto *from = dyn_cast_or_null<InputSectionBase>(fromSym->section); 757 auto *to = dyn_cast_or_null<InputSectionBase>(toSym->section); 758 if (from && to) 759 config->callGraphProfile[{from, to}] += cgpe.cgp_weight; 760 } 761 } 762 } 763 764 static bool getCompressDebugSections(opt::InputArgList &args) { 765 StringRef s = args.getLastArgValue(OPT_compress_debug_sections, "none"); 766 if (s == "none") 767 return false; 768 if (s != "zlib") 769 error("unknown --compress-debug-sections value: " + s); 770 if (!zlib::isAvailable()) 771 error("--compress-debug-sections: zlib is not available"); 772 return true; 773 } 774 775 static StringRef getAliasSpelling(opt::Arg *arg) { 776 if (const opt::Arg *alias = arg->getAlias()) 777 return alias->getSpelling(); 778 return arg->getSpelling(); 779 } 780 781 static std::pair<StringRef, StringRef> getOldNewOptions(opt::InputArgList &args, 782 unsigned id) { 783 auto *arg = args.getLastArg(id); 784 if (!arg) 785 return {"", ""}; 786 787 StringRef s = arg->getValue(); 788 std::pair<StringRef, StringRef> ret = s.split(';'); 789 if (ret.second.empty()) 790 error(getAliasSpelling(arg) + " expects 'old;new' format, but got " + s); 791 return ret; 792 } 793 794 // Parse the symbol ordering file and warn for any duplicate entries. 795 static std::vector<StringRef> getSymbolOrderingFile(MemoryBufferRef mb) { 796 SetVector<StringRef> names; 797 for (StringRef s : args::getLines(mb)) 798 if (!names.insert(s) && config->warnSymbolOrdering) 799 warn(mb.getBufferIdentifier() + ": duplicate ordered symbol: " + s); 800 801 return names.takeVector(); 802 } 803 804 static void parseClangOption(StringRef opt, const Twine &msg) { 805 std::string err; 806 raw_string_ostream os(err); 807 808 const char *argv[] = {config->progName.data(), opt.data()}; 809 if (cl::ParseCommandLineOptions(2, argv, "", &os)) 810 return; 811 os.flush(); 812 error(msg + ": " + StringRef(err).trim()); 813 } 814 815 // Initializes Config members by the command line options. 816 static void readConfigs(opt::InputArgList &args) { 817 errorHandler().verbose = args.hasArg(OPT_verbose); 818 errorHandler().fatalWarnings = 819 args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false); 820 errorHandler().vsDiagnostics = 821 args.hasArg(OPT_visual_studio_diagnostics_format, false); 822 threadsEnabled = args.hasFlag(OPT_threads, OPT_no_threads, true); 823 824 config->allowMultipleDefinition = 825 args.hasFlag(OPT_allow_multiple_definition, 826 OPT_no_allow_multiple_definition, false) || 827 hasZOption(args, "muldefs"); 828 config->allowShlibUndefined = 829 args.hasFlag(OPT_allow_shlib_undefined, OPT_no_allow_shlib_undefined, 830 args.hasArg(OPT_shared)); 831 config->auxiliaryList = args::getStrings(args, OPT_auxiliary); 832 config->bsymbolic = args.hasArg(OPT_Bsymbolic); 833 config->bsymbolicFunctions = args.hasArg(OPT_Bsymbolic_functions); 834 config->checkSections = 835 args.hasFlag(OPT_check_sections, OPT_no_check_sections, true); 836 config->chroot = args.getLastArgValue(OPT_chroot); 837 config->compressDebugSections = getCompressDebugSections(args); 838 config->cref = args.hasFlag(OPT_cref, OPT_no_cref, false); 839 config->defineCommon = args.hasFlag(OPT_define_common, OPT_no_define_common, 840 !args.hasArg(OPT_relocatable)); 841 config->demangle = args.hasFlag(OPT_demangle, OPT_no_demangle, true); 842 config->dependentLibraries = args.hasFlag(OPT_dependent_libraries, OPT_no_dependent_libraries, true); 843 config->disableVerify = args.hasArg(OPT_disable_verify); 844 config->discard = getDiscard(args); 845 config->dwoDir = args.getLastArgValue(OPT_plugin_opt_dwo_dir_eq); 846 config->dynamicLinker = getDynamicLinker(args); 847 config->ehFrameHdr = 848 args.hasFlag(OPT_eh_frame_hdr, OPT_no_eh_frame_hdr, false); 849 config->emitLLVM = args.hasArg(OPT_plugin_opt_emit_llvm, false); 850 config->emitRelocs = args.hasArg(OPT_emit_relocs); 851 config->callGraphProfileSort = args.hasFlag( 852 OPT_call_graph_profile_sort, OPT_no_call_graph_profile_sort, true); 853 config->enableNewDtags = 854 args.hasFlag(OPT_enable_new_dtags, OPT_disable_new_dtags, true); 855 config->entry = args.getLastArgValue(OPT_entry); 856 config->executeOnly = 857 args.hasFlag(OPT_execute_only, OPT_no_execute_only, false); 858 config->exportDynamic = 859 args.hasFlag(OPT_export_dynamic, OPT_no_export_dynamic, false); 860 config->filterList = args::getStrings(args, OPT_filter); 861 config->fini = args.getLastArgValue(OPT_fini, "_fini"); 862 config->fixCortexA53Errata843419 = args.hasArg(OPT_fix_cortex_a53_843419); 863 config->fixCortexA8 = args.hasArg(OPT_fix_cortex_a8); 864 config->forceBTI = args.hasArg(OPT_force_bti); 865 config->requireCET = args.hasArg(OPT_require_cet); 866 config->gcSections = args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, false); 867 config->gnuUnique = args.hasFlag(OPT_gnu_unique, OPT_no_gnu_unique, true); 868 config->gdbIndex = args.hasFlag(OPT_gdb_index, OPT_no_gdb_index, false); 869 config->icf = getICF(args); 870 config->ignoreDataAddressEquality = 871 args.hasArg(OPT_ignore_data_address_equality); 872 config->ignoreFunctionAddressEquality = 873 args.hasArg(OPT_ignore_function_address_equality); 874 config->init = args.getLastArgValue(OPT_init, "_init"); 875 config->ltoAAPipeline = args.getLastArgValue(OPT_lto_aa_pipeline); 876 config->ltoCSProfileGenerate = args.hasArg(OPT_lto_cs_profile_generate); 877 config->ltoCSProfileFile = args.getLastArgValue(OPT_lto_cs_profile_file); 878 config->ltoDebugPassManager = args.hasArg(OPT_lto_debug_pass_manager); 879 config->ltoNewPassManager = args.hasArg(OPT_lto_new_pass_manager); 880 config->ltoNewPmPasses = args.getLastArgValue(OPT_lto_newpm_passes); 881 config->ltoo = args::getInteger(args, OPT_lto_O, 2); 882 config->ltoObjPath = args.getLastArgValue(OPT_lto_obj_path_eq); 883 config->ltoPartitions = args::getInteger(args, OPT_lto_partitions, 1); 884 config->ltoSampleProfile = args.getLastArgValue(OPT_lto_sample_profile); 885 config->mapFile = args.getLastArgValue(OPT_Map); 886 config->mipsGotSize = args::getInteger(args, OPT_mips_got_size, 0xfff0); 887 config->mergeArmExidx = 888 args.hasFlag(OPT_merge_exidx_entries, OPT_no_merge_exidx_entries, true); 889 config->nmagic = args.hasFlag(OPT_nmagic, OPT_no_nmagic, false); 890 config->noinhibitExec = args.hasArg(OPT_noinhibit_exec); 891 config->nostdlib = args.hasArg(OPT_nostdlib); 892 config->oFormatBinary = isOutputFormatBinary(args); 893 config->omagic = args.hasFlag(OPT_omagic, OPT_no_omagic, false); 894 config->optRemarksFilename = args.getLastArgValue(OPT_opt_remarks_filename); 895 config->optRemarksPasses = args.getLastArgValue(OPT_opt_remarks_passes); 896 config->optRemarksWithHotness = args.hasArg(OPT_opt_remarks_with_hotness); 897 config->optRemarksFormat = args.getLastArgValue(OPT_opt_remarks_format); 898 config->optimize = args::getInteger(args, OPT_O, 1); 899 config->orphanHandling = getOrphanHandling(args); 900 config->outputFile = args.getLastArgValue(OPT_o); 901 config->pacPlt = args.hasArg(OPT_pac_plt); 902 config->pie = args.hasFlag(OPT_pie, OPT_no_pie, false); 903 config->printIcfSections = 904 args.hasFlag(OPT_print_icf_sections, OPT_no_print_icf_sections, false); 905 config->printGcSections = 906 args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false); 907 config->printSymbolOrder = 908 args.getLastArgValue(OPT_print_symbol_order); 909 config->rpath = getRpath(args); 910 config->relocatable = args.hasArg(OPT_relocatable); 911 config->saveTemps = args.hasArg(OPT_save_temps); 912 config->searchPaths = args::getStrings(args, OPT_library_path); 913 config->sectionStartMap = getSectionStartMap(args); 914 config->shared = args.hasArg(OPT_shared); 915 config->singleRoRx = args.hasArg(OPT_no_rosegment); 916 config->soName = args.getLastArgValue(OPT_soname); 917 config->sortSection = getSortSection(args); 918 config->splitStackAdjustSize = args::getInteger(args, OPT_split_stack_adjust_size, 16384); 919 config->strip = getStrip(args); 920 config->sysroot = args.getLastArgValue(OPT_sysroot); 921 config->target1Rel = args.hasFlag(OPT_target1_rel, OPT_target1_abs, false); 922 config->target2 = getTarget2(args); 923 config->thinLTOCacheDir = args.getLastArgValue(OPT_thinlto_cache_dir); 924 config->thinLTOCachePolicy = CHECK( 925 parseCachePruningPolicy(args.getLastArgValue(OPT_thinlto_cache_policy)), 926 "--thinlto-cache-policy: invalid cache policy"); 927 config->thinLTOEmitImportsFiles = args.hasArg(OPT_thinlto_emit_imports_files); 928 config->thinLTOIndexOnly = args.hasArg(OPT_thinlto_index_only) || 929 args.hasArg(OPT_thinlto_index_only_eq); 930 config->thinLTOIndexOnlyArg = args.getLastArgValue(OPT_thinlto_index_only_eq); 931 config->thinLTOJobs = args::getInteger(args, OPT_thinlto_jobs, -1u); 932 config->thinLTOObjectSuffixReplace = 933 getOldNewOptions(args, OPT_thinlto_object_suffix_replace_eq); 934 config->thinLTOPrefixReplace = 935 getOldNewOptions(args, OPT_thinlto_prefix_replace_eq); 936 config->trace = args.hasArg(OPT_trace); 937 config->undefined = args::getStrings(args, OPT_undefined); 938 config->undefinedVersion = 939 args.hasFlag(OPT_undefined_version, OPT_no_undefined_version, true); 940 config->useAndroidRelrTags = args.hasFlag( 941 OPT_use_android_relr_tags, OPT_no_use_android_relr_tags, false); 942 config->unresolvedSymbols = getUnresolvedSymbolPolicy(args); 943 config->warnBackrefs = 944 args.hasFlag(OPT_warn_backrefs, OPT_no_warn_backrefs, false); 945 config->warnCommon = args.hasFlag(OPT_warn_common, OPT_no_warn_common, false); 946 config->warnIfuncTextrel = 947 args.hasFlag(OPT_warn_ifunc_textrel, OPT_no_warn_ifunc_textrel, false); 948 config->warnSymbolOrdering = 949 args.hasFlag(OPT_warn_symbol_ordering, OPT_no_warn_symbol_ordering, true); 950 config->zCombreloc = getZFlag(args, "combreloc", "nocombreloc", true); 951 config->zCopyreloc = getZFlag(args, "copyreloc", "nocopyreloc", true); 952 config->zExecstack = getZFlag(args, "execstack", "noexecstack", false); 953 config->zGlobal = hasZOption(args, "global"); 954 config->zHazardplt = hasZOption(args, "hazardplt"); 955 config->zIfuncNoplt = hasZOption(args, "ifunc-noplt"); 956 config->zInitfirst = hasZOption(args, "initfirst"); 957 config->zInterpose = hasZOption(args, "interpose"); 958 config->zKeepTextSectionPrefix = getZFlag( 959 args, "keep-text-section-prefix", "nokeep-text-section-prefix", false); 960 config->zNodefaultlib = hasZOption(args, "nodefaultlib"); 961 config->zNodelete = hasZOption(args, "nodelete"); 962 config->zNodlopen = hasZOption(args, "nodlopen"); 963 config->zNow = getZFlag(args, "now", "lazy", false); 964 config->zOrigin = hasZOption(args, "origin"); 965 config->zRelro = getZFlag(args, "relro", "norelro", true); 966 config->zRetpolineplt = hasZOption(args, "retpolineplt"); 967 config->zRodynamic = hasZOption(args, "rodynamic"); 968 config->zSeparate = getZSeparate(args); 969 config->zStackSize = args::getZOptionValue(args, OPT_z, "stack-size", 0); 970 config->zText = getZFlag(args, "text", "notext", true); 971 config->zWxneeded = hasZOption(args, "wxneeded"); 972 973 // Parse LTO options. 974 if (auto *arg = args.getLastArg(OPT_plugin_opt_mcpu_eq)) 975 parseClangOption(saver.save("-mcpu=" + StringRef(arg->getValue())), 976 arg->getSpelling()); 977 978 for (auto *arg : args.filtered(OPT_plugin_opt)) 979 parseClangOption(arg->getValue(), arg->getSpelling()); 980 981 // Parse -mllvm options. 982 for (auto *arg : args.filtered(OPT_mllvm)) 983 parseClangOption(arg->getValue(), arg->getSpelling()); 984 985 if (config->ltoo > 3) 986 error("invalid optimization level for LTO: " + Twine(config->ltoo)); 987 if (config->ltoPartitions == 0) 988 error("--lto-partitions: number of threads must be > 0"); 989 if (config->thinLTOJobs == 0) 990 error("--thinlto-jobs: number of threads must be > 0"); 991 992 if (config->splitStackAdjustSize < 0) 993 error("--split-stack-adjust-size: size must be >= 0"); 994 995 // Parse ELF{32,64}{LE,BE} and CPU type. 996 if (auto *arg = args.getLastArg(OPT_m)) { 997 StringRef s = arg->getValue(); 998 std::tie(config->ekind, config->emachine, config->osabi) = 999 parseEmulation(s); 1000 config->mipsN32Abi = 1001 (s.startswith("elf32btsmipn32") || s.startswith("elf32ltsmipn32")); 1002 config->emulation = s; 1003 } 1004 1005 // Parse -hash-style={sysv,gnu,both}. 1006 if (auto *arg = args.getLastArg(OPT_hash_style)) { 1007 StringRef s = arg->getValue(); 1008 if (s == "sysv") 1009 config->sysvHash = true; 1010 else if (s == "gnu") 1011 config->gnuHash = true; 1012 else if (s == "both") 1013 config->sysvHash = config->gnuHash = true; 1014 else 1015 error("unknown -hash-style: " + s); 1016 } 1017 1018 if (args.hasArg(OPT_print_map)) 1019 config->mapFile = "-"; 1020 1021 // Page alignment can be disabled by the -n (--nmagic) and -N (--omagic). 1022 // As PT_GNU_RELRO relies on Paging, do not create it when we have disabled 1023 // it. 1024 if (config->nmagic || config->omagic) 1025 config->zRelro = false; 1026 1027 std::tie(config->buildId, config->buildIdVector) = getBuildId(args); 1028 1029 std::tie(config->androidPackDynRelocs, config->relrPackDynRelocs) = 1030 getPackDynRelocs(args); 1031 1032 if (auto *arg = args.getLastArg(OPT_symbol_ordering_file)){ 1033 if (args.hasArg(OPT_call_graph_ordering_file)) 1034 error("--symbol-ordering-file and --call-graph-order-file " 1035 "may not be used together"); 1036 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())){ 1037 config->symbolOrderingFile = getSymbolOrderingFile(*buffer); 1038 // Also need to disable CallGraphProfileSort to prevent 1039 // LLD order symbols with CGProfile 1040 config->callGraphProfileSort = false; 1041 } 1042 } 1043 1044 assert(config->versionDefinitions.empty()); 1045 config->versionDefinitions.push_back({"local", (uint16_t)VER_NDX_LOCAL, {}}); 1046 config->versionDefinitions.push_back( 1047 {"global", (uint16_t)VER_NDX_GLOBAL, {}}); 1048 1049 // If --retain-symbol-file is used, we'll keep only the symbols listed in 1050 // the file and discard all others. 1051 if (auto *arg = args.getLastArg(OPT_retain_symbols_file)) { 1052 config->versionDefinitions[VER_NDX_LOCAL].patterns.push_back( 1053 {"*", /*isExternCpp=*/false, /*hasWildcard=*/true}); 1054 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 1055 for (StringRef s : args::getLines(*buffer)) 1056 config->versionDefinitions[VER_NDX_GLOBAL].patterns.push_back( 1057 {s, /*isExternCpp=*/false, /*hasWildcard=*/false}); 1058 } 1059 1060 // Parses -dynamic-list and -export-dynamic-symbol. They make some 1061 // symbols private. Note that -export-dynamic takes precedence over them 1062 // as it says all symbols should be exported. 1063 if (!config->exportDynamic) { 1064 for (auto *arg : args.filtered(OPT_dynamic_list)) 1065 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 1066 readDynamicList(*buffer); 1067 1068 for (auto *arg : args.filtered(OPT_export_dynamic_symbol)) 1069 config->dynamicList.push_back( 1070 {arg->getValue(), /*isExternCpp=*/false, /*hasWildcard=*/false}); 1071 } 1072 1073 // If --export-dynamic-symbol=foo is given and symbol foo is defined in 1074 // an object file in an archive file, that object file should be pulled 1075 // out and linked. (It doesn't have to behave like that from technical 1076 // point of view, but this is needed for compatibility with GNU.) 1077 for (auto *arg : args.filtered(OPT_export_dynamic_symbol)) 1078 config->undefined.push_back(arg->getValue()); 1079 1080 for (auto *arg : args.filtered(OPT_version_script)) 1081 if (Optional<std::string> path = searchScript(arg->getValue())) { 1082 if (Optional<MemoryBufferRef> buffer = readFile(*path)) 1083 readVersionScript(*buffer); 1084 } else { 1085 error(Twine("cannot find version script ") + arg->getValue()); 1086 } 1087 } 1088 1089 // Some Config members do not directly correspond to any particular 1090 // command line options, but computed based on other Config values. 1091 // This function initialize such members. See Config.h for the details 1092 // of these values. 1093 static void setConfigs(opt::InputArgList &args) { 1094 ELFKind k = config->ekind; 1095 uint16_t m = config->emachine; 1096 1097 config->copyRelocs = (config->relocatable || config->emitRelocs); 1098 config->is64 = (k == ELF64LEKind || k == ELF64BEKind); 1099 config->isLE = (k == ELF32LEKind || k == ELF64LEKind); 1100 config->endianness = config->isLE ? endianness::little : endianness::big; 1101 config->isMips64EL = (k == ELF64LEKind && m == EM_MIPS); 1102 config->isPic = config->pie || config->shared; 1103 config->picThunk = args.hasArg(OPT_pic_veneer, config->isPic); 1104 config->wordsize = config->is64 ? 8 : 4; 1105 1106 // ELF defines two different ways to store relocation addends as shown below: 1107 // 1108 // Rel: Addends are stored to the location where relocations are applied. 1109 // Rela: Addends are stored as part of relocation entry. 1110 // 1111 // In other words, Rela makes it easy to read addends at the price of extra 1112 // 4 or 8 byte for each relocation entry. We don't know why ELF defined two 1113 // different mechanisms in the first place, but this is how the spec is 1114 // defined. 1115 // 1116 // You cannot choose which one, Rel or Rela, you want to use. Instead each 1117 // ABI defines which one you need to use. The following expression expresses 1118 // that. 1119 config->isRela = m == EM_AARCH64 || m == EM_AMDGPU || m == EM_HEXAGON || 1120 m == EM_PPC || m == EM_PPC64 || m == EM_RISCV || 1121 m == EM_X86_64; 1122 1123 // If the output uses REL relocations we must store the dynamic relocation 1124 // addends to the output sections. We also store addends for RELA relocations 1125 // if --apply-dynamic-relocs is used. 1126 // We default to not writing the addends when using RELA relocations since 1127 // any standard conforming tool can find it in r_addend. 1128 config->writeAddends = args.hasFlag(OPT_apply_dynamic_relocs, 1129 OPT_no_apply_dynamic_relocs, false) || 1130 !config->isRela; 1131 1132 config->tocOptimize = 1133 args.hasFlag(OPT_toc_optimize, OPT_no_toc_optimize, m == EM_PPC64); 1134 } 1135 1136 // Returns a value of "-format" option. 1137 static bool isFormatBinary(StringRef s) { 1138 if (s == "binary") 1139 return true; 1140 if (s == "elf" || s == "default") 1141 return false; 1142 error("unknown -format value: " + s + 1143 " (supported formats: elf, default, binary)"); 1144 return false; 1145 } 1146 1147 void LinkerDriver::createFiles(opt::InputArgList &args) { 1148 // For --{push,pop}-state. 1149 std::vector<std::tuple<bool, bool, bool>> stack; 1150 1151 // Iterate over argv to process input files and positional arguments. 1152 for (auto *arg : args) { 1153 switch (arg->getOption().getID()) { 1154 case OPT_library: 1155 addLibrary(arg->getValue()); 1156 break; 1157 case OPT_INPUT: 1158 addFile(arg->getValue(), /*withLOption=*/false); 1159 break; 1160 case OPT_defsym: { 1161 StringRef from; 1162 StringRef to; 1163 std::tie(from, to) = StringRef(arg->getValue()).split('='); 1164 if (from.empty() || to.empty()) 1165 error("-defsym: syntax error: " + StringRef(arg->getValue())); 1166 else 1167 readDefsym(from, MemoryBufferRef(to, "-defsym")); 1168 break; 1169 } 1170 case OPT_script: 1171 if (Optional<std::string> path = searchScript(arg->getValue())) { 1172 if (Optional<MemoryBufferRef> mb = readFile(*path)) 1173 readLinkerScript(*mb); 1174 break; 1175 } 1176 error(Twine("cannot find linker script ") + arg->getValue()); 1177 break; 1178 case OPT_as_needed: 1179 config->asNeeded = true; 1180 break; 1181 case OPT_format: 1182 config->formatBinary = isFormatBinary(arg->getValue()); 1183 break; 1184 case OPT_no_as_needed: 1185 config->asNeeded = false; 1186 break; 1187 case OPT_Bstatic: 1188 case OPT_omagic: 1189 case OPT_nmagic: 1190 config->isStatic = true; 1191 break; 1192 case OPT_Bdynamic: 1193 config->isStatic = false; 1194 break; 1195 case OPT_whole_archive: 1196 inWholeArchive = true; 1197 break; 1198 case OPT_no_whole_archive: 1199 inWholeArchive = false; 1200 break; 1201 case OPT_just_symbols: 1202 if (Optional<MemoryBufferRef> mb = readFile(arg->getValue())) { 1203 files.push_back(createObjectFile(*mb)); 1204 files.back()->justSymbols = true; 1205 } 1206 break; 1207 case OPT_start_group: 1208 if (InputFile::isInGroup) 1209 error("nested --start-group"); 1210 InputFile::isInGroup = true; 1211 break; 1212 case OPT_end_group: 1213 if (!InputFile::isInGroup) 1214 error("stray --end-group"); 1215 InputFile::isInGroup = false; 1216 ++InputFile::nextGroupId; 1217 break; 1218 case OPT_start_lib: 1219 if (inLib) 1220 error("nested --start-lib"); 1221 if (InputFile::isInGroup) 1222 error("may not nest --start-lib in --start-group"); 1223 inLib = true; 1224 InputFile::isInGroup = true; 1225 break; 1226 case OPT_end_lib: 1227 if (!inLib) 1228 error("stray --end-lib"); 1229 inLib = false; 1230 InputFile::isInGroup = false; 1231 ++InputFile::nextGroupId; 1232 break; 1233 case OPT_push_state: 1234 stack.emplace_back(config->asNeeded, config->isStatic, inWholeArchive); 1235 break; 1236 case OPT_pop_state: 1237 if (stack.empty()) { 1238 error("unbalanced --push-state/--pop-state"); 1239 break; 1240 } 1241 std::tie(config->asNeeded, config->isStatic, inWholeArchive) = stack.back(); 1242 stack.pop_back(); 1243 break; 1244 } 1245 } 1246 1247 if (files.empty() && errorCount() == 0) 1248 error("no input files"); 1249 } 1250 1251 // If -m <machine_type> was not given, infer it from object files. 1252 void LinkerDriver::inferMachineType() { 1253 if (config->ekind != ELFNoneKind) 1254 return; 1255 1256 for (InputFile *f : files) { 1257 if (f->ekind == ELFNoneKind) 1258 continue; 1259 config->ekind = f->ekind; 1260 config->emachine = f->emachine; 1261 config->osabi = f->osabi; 1262 config->mipsN32Abi = config->emachine == EM_MIPS && isMipsN32Abi(f); 1263 return; 1264 } 1265 error("target emulation unknown: -m or at least one .o file required"); 1266 } 1267 1268 // Parse -z max-page-size=<value>. The default value is defined by 1269 // each target. 1270 static uint64_t getMaxPageSize(opt::InputArgList &args) { 1271 uint64_t val = args::getZOptionValue(args, OPT_z, "max-page-size", 1272 target->defaultMaxPageSize); 1273 if (!isPowerOf2_64(val)) 1274 error("max-page-size: value isn't a power of 2"); 1275 if (config->nmagic || config->omagic) { 1276 if (val != target->defaultMaxPageSize) 1277 warn("-z max-page-size set, but paging disabled by omagic or nmagic"); 1278 return 1; 1279 } 1280 return val; 1281 } 1282 1283 // Parse -z common-page-size=<value>. The default value is defined by 1284 // each target. 1285 static uint64_t getCommonPageSize(opt::InputArgList &args) { 1286 uint64_t val = args::getZOptionValue(args, OPT_z, "common-page-size", 1287 target->defaultCommonPageSize); 1288 if (!isPowerOf2_64(val)) 1289 error("common-page-size: value isn't a power of 2"); 1290 if (config->nmagic || config->omagic) { 1291 if (val != target->defaultCommonPageSize) 1292 warn("-z common-page-size set, but paging disabled by omagic or nmagic"); 1293 return 1; 1294 } 1295 // commonPageSize can't be larger than maxPageSize. 1296 if (val > config->maxPageSize) 1297 val = config->maxPageSize; 1298 return val; 1299 } 1300 1301 // Parses -image-base option. 1302 static Optional<uint64_t> getImageBase(opt::InputArgList &args) { 1303 // Because we are using "Config->maxPageSize" here, this function has to be 1304 // called after the variable is initialized. 1305 auto *arg = args.getLastArg(OPT_image_base); 1306 if (!arg) 1307 return None; 1308 1309 StringRef s = arg->getValue(); 1310 uint64_t v; 1311 if (!to_integer(s, v)) { 1312 error("-image-base: number expected, but got " + s); 1313 return 0; 1314 } 1315 if ((v % config->maxPageSize) != 0) 1316 warn("-image-base: address isn't multiple of page size: " + s); 1317 return v; 1318 } 1319 1320 // Parses `--exclude-libs=lib,lib,...`. 1321 // The library names may be delimited by commas or colons. 1322 static DenseSet<StringRef> getExcludeLibs(opt::InputArgList &args) { 1323 DenseSet<StringRef> ret; 1324 for (auto *arg : args.filtered(OPT_exclude_libs)) { 1325 StringRef s = arg->getValue(); 1326 for (;;) { 1327 size_t pos = s.find_first_of(",:"); 1328 if (pos == StringRef::npos) 1329 break; 1330 ret.insert(s.substr(0, pos)); 1331 s = s.substr(pos + 1); 1332 } 1333 ret.insert(s); 1334 } 1335 return ret; 1336 } 1337 1338 // Handles the -exclude-libs option. If a static library file is specified 1339 // by the -exclude-libs option, all public symbols from the archive become 1340 // private unless otherwise specified by version scripts or something. 1341 // A special library name "ALL" means all archive files. 1342 // 1343 // This is not a popular option, but some programs such as bionic libc use it. 1344 static void excludeLibs(opt::InputArgList &args) { 1345 DenseSet<StringRef> libs = getExcludeLibs(args); 1346 bool all = libs.count("ALL"); 1347 1348 auto visit = [&](InputFile *file) { 1349 if (!file->archiveName.empty()) 1350 if (all || libs.count(path::filename(file->archiveName))) 1351 for (Symbol *sym : file->getSymbols()) 1352 if (!sym->isLocal() && sym->file == file) 1353 sym->versionId = VER_NDX_LOCAL; 1354 }; 1355 1356 for (InputFile *file : objectFiles) 1357 visit(file); 1358 1359 for (BitcodeFile *file : bitcodeFiles) 1360 visit(file); 1361 } 1362 1363 // Force Sym to be entered in the output. Used for -u or equivalent. 1364 static void handleUndefined(Symbol *sym) { 1365 // Since a symbol may not be used inside the program, LTO may 1366 // eliminate it. Mark the symbol as "used" to prevent it. 1367 sym->isUsedInRegularObj = true; 1368 1369 if (sym->isLazy()) 1370 sym->fetch(); 1371 } 1372 1373 // As an extention to GNU linkers, lld supports a variant of `-u` 1374 // which accepts wildcard patterns. All symbols that match a given 1375 // pattern are handled as if they were given by `-u`. 1376 static void handleUndefinedGlob(StringRef arg) { 1377 Expected<GlobPattern> pat = GlobPattern::create(arg); 1378 if (!pat) { 1379 error("--undefined-glob: " + toString(pat.takeError())); 1380 return; 1381 } 1382 1383 std::vector<Symbol *> syms; 1384 symtab->forEachSymbol([&](Symbol *sym) { 1385 // Calling Sym->fetch() from here is not safe because it may 1386 // add new symbols to the symbol table, invalidating the 1387 // current iterator. So we just keep a note. 1388 if (pat->match(sym->getName())) 1389 syms.push_back(sym); 1390 }); 1391 1392 for (Symbol *sym : syms) 1393 handleUndefined(sym); 1394 } 1395 1396 static void handleLibcall(StringRef name) { 1397 Symbol *sym = symtab->find(name); 1398 if (!sym || !sym->isLazy()) 1399 return; 1400 1401 MemoryBufferRef mb; 1402 if (auto *lo = dyn_cast<LazyObject>(sym)) 1403 mb = lo->file->mb; 1404 else 1405 mb = cast<LazyArchive>(sym)->getMemberBuffer(); 1406 1407 if (isBitcode(mb)) 1408 sym->fetch(); 1409 } 1410 1411 // Replaces common symbols with defined symbols reside in .bss sections. 1412 // This function is called after all symbol names are resolved. As a 1413 // result, the passes after the symbol resolution won't see any 1414 // symbols of type CommonSymbol. 1415 static void replaceCommonSymbols() { 1416 symtab->forEachSymbol([](Symbol *sym) { 1417 auto *s = dyn_cast<CommonSymbol>(sym); 1418 if (!s) 1419 return; 1420 1421 auto *bss = make<BssSection>("COMMON", s->size, s->alignment); 1422 bss->file = s->file; 1423 bss->markDead(); 1424 inputSections.push_back(bss); 1425 s->replace(Defined{s->file, s->getName(), s->binding, s->stOther, s->type, 1426 /*value=*/0, s->size, bss}); 1427 }); 1428 } 1429 1430 // If all references to a DSO happen to be weak, the DSO is not added 1431 // to DT_NEEDED. If that happens, we need to eliminate shared symbols 1432 // created from the DSO. Otherwise, they become dangling references 1433 // that point to a non-existent DSO. 1434 static void demoteSharedSymbols() { 1435 symtab->forEachSymbol([](Symbol *sym) { 1436 auto *s = dyn_cast<SharedSymbol>(sym); 1437 if (!s || s->getFile().isNeeded) 1438 return; 1439 1440 bool used = s->used; 1441 s->replace(Undefined{nullptr, s->getName(), STB_WEAK, s->stOther, s->type}); 1442 s->used = used; 1443 }); 1444 } 1445 1446 // The section referred to by `s` is considered address-significant. Set the 1447 // keepUnique flag on the section if appropriate. 1448 static void markAddrsig(Symbol *s) { 1449 if (auto *d = dyn_cast_or_null<Defined>(s)) 1450 if (d->section) 1451 // We don't need to keep text sections unique under --icf=all even if they 1452 // are address-significant. 1453 if (config->icf == ICFLevel::Safe || !(d->section->flags & SHF_EXECINSTR)) 1454 d->section->keepUnique = true; 1455 } 1456 1457 // Record sections that define symbols mentioned in --keep-unique <symbol> 1458 // and symbols referred to by address-significance tables. These sections are 1459 // ineligible for ICF. 1460 template <class ELFT> 1461 static void findKeepUniqueSections(opt::InputArgList &args) { 1462 for (auto *arg : args.filtered(OPT_keep_unique)) { 1463 StringRef name = arg->getValue(); 1464 auto *d = dyn_cast_or_null<Defined>(symtab->find(name)); 1465 if (!d || !d->section) { 1466 warn("could not find symbol " + name + " to keep unique"); 1467 continue; 1468 } 1469 d->section->keepUnique = true; 1470 } 1471 1472 // --icf=all --ignore-data-address-equality means that we can ignore 1473 // the dynsym and address-significance tables entirely. 1474 if (config->icf == ICFLevel::All && config->ignoreDataAddressEquality) 1475 return; 1476 1477 // Symbols in the dynsym could be address-significant in other executables 1478 // or DSOs, so we conservatively mark them as address-significant. 1479 symtab->forEachSymbol([&](Symbol *sym) { 1480 if (sym->includeInDynsym()) 1481 markAddrsig(sym); 1482 }); 1483 1484 // Visit the address-significance table in each object file and mark each 1485 // referenced symbol as address-significant. 1486 for (InputFile *f : objectFiles) { 1487 auto *obj = cast<ObjFile<ELFT>>(f); 1488 ArrayRef<Symbol *> syms = obj->getSymbols(); 1489 if (obj->addrsigSec) { 1490 ArrayRef<uint8_t> contents = 1491 check(obj->getObj().getSectionContents(obj->addrsigSec)); 1492 const uint8_t *cur = contents.begin(); 1493 while (cur != contents.end()) { 1494 unsigned size; 1495 const char *err; 1496 uint64_t symIndex = decodeULEB128(cur, &size, contents.end(), &err); 1497 if (err) 1498 fatal(toString(f) + ": could not decode addrsig section: " + err); 1499 markAddrsig(syms[symIndex]); 1500 cur += size; 1501 } 1502 } else { 1503 // If an object file does not have an address-significance table, 1504 // conservatively mark all of its symbols as address-significant. 1505 for (Symbol *s : syms) 1506 markAddrsig(s); 1507 } 1508 } 1509 } 1510 1511 // This function reads a symbol partition specification section. These sections 1512 // are used to control which partition a symbol is allocated to. See 1513 // https://lld.llvm.org/Partitions.html for more details on partitions. 1514 template <typename ELFT> 1515 static void readSymbolPartitionSection(InputSectionBase *s) { 1516 // Read the relocation that refers to the partition's entry point symbol. 1517 Symbol *sym; 1518 if (s->areRelocsRela) 1519 sym = &s->getFile<ELFT>()->getRelocTargetSym(s->template relas<ELFT>()[0]); 1520 else 1521 sym = &s->getFile<ELFT>()->getRelocTargetSym(s->template rels<ELFT>()[0]); 1522 if (!isa<Defined>(sym) || !sym->includeInDynsym()) 1523 return; 1524 1525 StringRef partName = reinterpret_cast<const char *>(s->data().data()); 1526 for (Partition &part : partitions) { 1527 if (part.name == partName) { 1528 sym->partition = part.getNumber(); 1529 return; 1530 } 1531 } 1532 1533 // Forbid partitions from being used on incompatible targets, and forbid them 1534 // from being used together with various linker features that assume a single 1535 // set of output sections. 1536 if (script->hasSectionsCommand) 1537 error(toString(s->file) + 1538 ": partitions cannot be used with the SECTIONS command"); 1539 if (script->hasPhdrsCommands()) 1540 error(toString(s->file) + 1541 ": partitions cannot be used with the PHDRS command"); 1542 if (!config->sectionStartMap.empty()) 1543 error(toString(s->file) + ": partitions cannot be used with " 1544 "--section-start, -Ttext, -Tdata or -Tbss"); 1545 if (config->emachine == EM_MIPS) 1546 error(toString(s->file) + ": partitions cannot be used on this target"); 1547 1548 // Impose a limit of no more than 254 partitions. This limit comes from the 1549 // sizes of the Partition fields in InputSectionBase and Symbol, as well as 1550 // the amount of space devoted to the partition number in RankFlags. 1551 if (partitions.size() == 254) 1552 fatal("may not have more than 254 partitions"); 1553 1554 partitions.emplace_back(); 1555 Partition &newPart = partitions.back(); 1556 newPart.name = partName; 1557 sym->partition = newPart.getNumber(); 1558 } 1559 1560 static Symbol *addUndefined(StringRef name) { 1561 return symtab->addSymbol( 1562 Undefined{nullptr, name, STB_GLOBAL, STV_DEFAULT, 0}); 1563 } 1564 1565 // This function is where all the optimizations of link-time 1566 // optimization takes place. When LTO is in use, some input files are 1567 // not in native object file format but in the LLVM bitcode format. 1568 // This function compiles bitcode files into a few big native files 1569 // using LLVM functions and replaces bitcode symbols with the results. 1570 // Because all bitcode files that the program consists of are passed to 1571 // the compiler at once, it can do a whole-program optimization. 1572 template <class ELFT> void LinkerDriver::compileBitcodeFiles() { 1573 // Compile bitcode files and replace bitcode symbols. 1574 lto.reset(new BitcodeCompiler); 1575 for (BitcodeFile *file : bitcodeFiles) 1576 lto->add(*file); 1577 1578 for (InputFile *file : lto->compile()) { 1579 auto *obj = cast<ObjFile<ELFT>>(file); 1580 obj->parse(/*ignoreComdats=*/true); 1581 for (Symbol *sym : obj->getGlobalSymbols()) 1582 sym->parseSymbolVersion(); 1583 objectFiles.push_back(file); 1584 } 1585 } 1586 1587 // The --wrap option is a feature to rename symbols so that you can write 1588 // wrappers for existing functions. If you pass `-wrap=foo`, all 1589 // occurrences of symbol `foo` are resolved to `wrap_foo` (so, you are 1590 // expected to write `wrap_foo` function as a wrapper). The original 1591 // symbol becomes accessible as `real_foo`, so you can call that from your 1592 // wrapper. 1593 // 1594 // This data structure is instantiated for each -wrap option. 1595 struct WrappedSymbol { 1596 Symbol *sym; 1597 Symbol *real; 1598 Symbol *wrap; 1599 }; 1600 1601 // Handles -wrap option. 1602 // 1603 // This function instantiates wrapper symbols. At this point, they seem 1604 // like they are not being used at all, so we explicitly set some flags so 1605 // that LTO won't eliminate them. 1606 static std::vector<WrappedSymbol> addWrappedSymbols(opt::InputArgList &args) { 1607 std::vector<WrappedSymbol> v; 1608 DenseSet<StringRef> seen; 1609 1610 for (auto *arg : args.filtered(OPT_wrap)) { 1611 StringRef name = arg->getValue(); 1612 if (!seen.insert(name).second) 1613 continue; 1614 1615 Symbol *sym = symtab->find(name); 1616 if (!sym) 1617 continue; 1618 1619 Symbol *real = addUndefined(saver.save("__real_" + name)); 1620 Symbol *wrap = addUndefined(saver.save("__wrap_" + name)); 1621 v.push_back({sym, real, wrap}); 1622 1623 // We want to tell LTO not to inline symbols to be overwritten 1624 // because LTO doesn't know the final symbol contents after renaming. 1625 real->canInline = false; 1626 sym->canInline = false; 1627 1628 // Tell LTO not to eliminate these symbols. 1629 sym->isUsedInRegularObj = true; 1630 wrap->isUsedInRegularObj = true; 1631 } 1632 return v; 1633 } 1634 1635 // Do renaming for -wrap by updating pointers to symbols. 1636 // 1637 // When this function is executed, only InputFiles and symbol table 1638 // contain pointers to symbol objects. We visit them to replace pointers, 1639 // so that wrapped symbols are swapped as instructed by the command line. 1640 static void wrapSymbols(ArrayRef<WrappedSymbol> wrapped) { 1641 DenseMap<Symbol *, Symbol *> map; 1642 for (const WrappedSymbol &w : wrapped) { 1643 map[w.sym] = w.wrap; 1644 map[w.real] = w.sym; 1645 } 1646 1647 // Update pointers in input files. 1648 parallelForEach(objectFiles, [&](InputFile *file) { 1649 MutableArrayRef<Symbol *> syms = file->getMutableSymbols(); 1650 for (size_t i = 0, e = syms.size(); i != e; ++i) 1651 if (Symbol *s = map.lookup(syms[i])) 1652 syms[i] = s; 1653 }); 1654 1655 // Update pointers in the symbol table. 1656 for (const WrappedSymbol &w : wrapped) 1657 symtab->wrap(w.sym, w.real, w.wrap); 1658 } 1659 1660 // To enable CET (x86's hardware-assited control flow enforcement), each 1661 // source file must be compiled with -fcf-protection. Object files compiled 1662 // with the flag contain feature flags indicating that they are compatible 1663 // with CET. We enable the feature only when all object files are compatible 1664 // with CET. 1665 // 1666 // This function returns the merged feature flags. If 0, we cannot enable CET. 1667 // This is also the case with AARCH64's BTI and PAC which use the similar 1668 // GNU_PROPERTY_AARCH64_FEATURE_1_AND mechanism. 1669 // 1670 // Note that the CET-aware PLT is not implemented yet. We do error 1671 // check only. 1672 template <class ELFT> static uint32_t getAndFeatures() { 1673 if (config->emachine != EM_386 && config->emachine != EM_X86_64 && 1674 config->emachine != EM_AARCH64) 1675 return 0; 1676 1677 uint32_t ret = -1; 1678 for (InputFile *f : objectFiles) { 1679 uint32_t features = cast<ObjFile<ELFT>>(f)->andFeatures; 1680 if (config->forceBTI && !(features & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)) { 1681 warn(toString(f) + ": --force-bti: file does not have BTI property"); 1682 features |= GNU_PROPERTY_AARCH64_FEATURE_1_BTI; 1683 } else if (!features && config->requireCET) 1684 error(toString(f) + ": --require-cet: file is not compatible with CET"); 1685 ret &= features; 1686 } 1687 1688 // Force enable pointer authentication Plt, we don't warn in this case as 1689 // this does not require support in the object for correctness. 1690 if (config->pacPlt) 1691 ret |= GNU_PROPERTY_AARCH64_FEATURE_1_PAC; 1692 1693 return ret; 1694 } 1695 1696 // Do actual linking. Note that when this function is called, 1697 // all linker scripts have already been parsed. 1698 template <class ELFT> void LinkerDriver::link(opt::InputArgList &args) { 1699 // If a -hash-style option was not given, set to a default value, 1700 // which varies depending on the target. 1701 if (!args.hasArg(OPT_hash_style)) { 1702 if (config->emachine == EM_MIPS) 1703 config->sysvHash = true; 1704 else 1705 config->sysvHash = config->gnuHash = true; 1706 } 1707 1708 // Default output filename is "a.out" by the Unix tradition. 1709 if (config->outputFile.empty()) 1710 config->outputFile = "a.out"; 1711 1712 // Fail early if the output file or map file is not writable. If a user has a 1713 // long link, e.g. due to a large LTO link, they do not wish to run it and 1714 // find that it failed because there was a mistake in their command-line. 1715 if (auto e = tryCreateFile(config->outputFile)) 1716 error("cannot open output file " + config->outputFile + ": " + e.message()); 1717 if (auto e = tryCreateFile(config->mapFile)) 1718 error("cannot open map file " + config->mapFile + ": " + e.message()); 1719 if (errorCount()) 1720 return; 1721 1722 // Use default entry point name if no name was given via the command 1723 // line nor linker scripts. For some reason, MIPS entry point name is 1724 // different from others. 1725 config->warnMissingEntry = 1726 (!config->entry.empty() || (!config->shared && !config->relocatable)); 1727 if (config->entry.empty() && !config->relocatable) 1728 config->entry = (config->emachine == EM_MIPS) ? "__start" : "_start"; 1729 1730 // Handle --trace-symbol. 1731 for (auto *arg : args.filtered(OPT_trace_symbol)) 1732 symtab->insert(arg->getValue())->traced = true; 1733 1734 // Add all files to the symbol table. This will add almost all 1735 // symbols that we need to the symbol table. This process might 1736 // add files to the link, via autolinking, these files are always 1737 // appended to the Files vector. 1738 for (size_t i = 0; i < files.size(); ++i) 1739 parseFile(files[i]); 1740 1741 // Now that we have every file, we can decide if we will need a 1742 // dynamic symbol table. 1743 // We need one if we were asked to export dynamic symbols or if we are 1744 // producing a shared library. 1745 // We also need one if any shared libraries are used and for pie executables 1746 // (probably because the dynamic linker needs it). 1747 config->hasDynSymTab = 1748 !sharedFiles.empty() || config->isPic || config->exportDynamic; 1749 1750 // Some symbols (such as __ehdr_start) are defined lazily only when there 1751 // are undefined symbols for them, so we add these to trigger that logic. 1752 for (StringRef name : script->referencedSymbols) 1753 addUndefined(name); 1754 1755 // Handle the `--undefined <sym>` options. 1756 for (StringRef arg : config->undefined) 1757 if (Symbol *sym = symtab->find(arg)) 1758 handleUndefined(sym); 1759 1760 // If an entry symbol is in a static archive, pull out that file now. 1761 if (Symbol *sym = symtab->find(config->entry)) 1762 handleUndefined(sym); 1763 1764 // Handle the `--undefined-glob <pattern>` options. 1765 for (StringRef pat : args::getStrings(args, OPT_undefined_glob)) 1766 handleUndefinedGlob(pat); 1767 1768 // If any of our inputs are bitcode files, the LTO code generator may create 1769 // references to certain library functions that might not be explicit in the 1770 // bitcode file's symbol table. If any of those library functions are defined 1771 // in a bitcode file in an archive member, we need to arrange to use LTO to 1772 // compile those archive members by adding them to the link beforehand. 1773 // 1774 // However, adding all libcall symbols to the link can have undesired 1775 // consequences. For example, the libgcc implementation of 1776 // __sync_val_compare_and_swap_8 on 32-bit ARM pulls in an .init_array entry 1777 // that aborts the program if the Linux kernel does not support 64-bit 1778 // atomics, which would prevent the program from running even if it does not 1779 // use 64-bit atomics. 1780 // 1781 // Therefore, we only add libcall symbols to the link before LTO if we have 1782 // to, i.e. if the symbol's definition is in bitcode. Any other required 1783 // libcall symbols will be added to the link after LTO when we add the LTO 1784 // object file to the link. 1785 if (!bitcodeFiles.empty()) 1786 for (auto *s : lto::LTO::getRuntimeLibcallSymbols()) 1787 handleLibcall(s); 1788 1789 // Return if there were name resolution errors. 1790 if (errorCount()) 1791 return; 1792 1793 // Now when we read all script files, we want to finalize order of linker 1794 // script commands, which can be not yet final because of INSERT commands. 1795 script->processInsertCommands(); 1796 1797 // We want to declare linker script's symbols early, 1798 // so that we can version them. 1799 // They also might be exported if referenced by DSOs. 1800 script->declareSymbols(); 1801 1802 // Handle the -exclude-libs option. 1803 if (args.hasArg(OPT_exclude_libs)) 1804 excludeLibs(args); 1805 1806 // Create elfHeader early. We need a dummy section in 1807 // addReservedSymbols to mark the created symbols as not absolute. 1808 Out::elfHeader = make<OutputSection>("", 0, SHF_ALLOC); 1809 Out::elfHeader->size = sizeof(typename ELFT::Ehdr); 1810 1811 // Create wrapped symbols for -wrap option. 1812 std::vector<WrappedSymbol> wrapped = addWrappedSymbols(args); 1813 1814 // We need to create some reserved symbols such as _end. Create them. 1815 if (!config->relocatable) 1816 addReservedSymbols(); 1817 1818 // Apply version scripts. 1819 // 1820 // For a relocatable output, version scripts don't make sense, and 1821 // parsing a symbol version string (e.g. dropping "@ver1" from a symbol 1822 // name "foo@ver1") rather do harm, so we don't call this if -r is given. 1823 if (!config->relocatable) 1824 symtab->scanVersionScript(); 1825 1826 // Do link-time optimization if given files are LLVM bitcode files. 1827 // This compiles bitcode files into real object files. 1828 // 1829 // With this the symbol table should be complete. After this, no new names 1830 // except a few linker-synthesized ones will be added to the symbol table. 1831 compileBitcodeFiles<ELFT>(); 1832 if (errorCount()) 1833 return; 1834 1835 // If -thinlto-index-only is given, we should create only "index 1836 // files" and not object files. Index file creation is already done 1837 // in addCombinedLTOObject, so we are done if that's the case. 1838 if (config->thinLTOIndexOnly) 1839 return; 1840 1841 // Likewise, --plugin-opt=emit-llvm is an option to make LTO create 1842 // an output file in bitcode and exit, so that you can just get a 1843 // combined bitcode file. 1844 if (config->emitLLVM) 1845 return; 1846 1847 // Apply symbol renames for -wrap. 1848 if (!wrapped.empty()) 1849 wrapSymbols(wrapped); 1850 1851 // Now that we have a complete list of input files. 1852 // Beyond this point, no new files are added. 1853 // Aggregate all input sections into one place. 1854 for (InputFile *f : objectFiles) 1855 for (InputSectionBase *s : f->getSections()) 1856 if (s && s != &InputSection::discarded) 1857 inputSections.push_back(s); 1858 for (BinaryFile *f : binaryFiles) 1859 for (InputSectionBase *s : f->getSections()) 1860 inputSections.push_back(cast<InputSection>(s)); 1861 1862 llvm::erase_if(inputSections, [](InputSectionBase *s) { 1863 if (s->type == SHT_LLVM_SYMPART) { 1864 readSymbolPartitionSection<ELFT>(s); 1865 return true; 1866 } 1867 1868 // We do not want to emit debug sections if --strip-all 1869 // or -strip-debug are given. 1870 return config->strip != StripPolicy::None && 1871 (s->name.startswith(".debug") || s->name.startswith(".zdebug")); 1872 }); 1873 1874 // Now that the number of partitions is fixed, save a pointer to the main 1875 // partition. 1876 mainPart = &partitions[0]; 1877 1878 // Read .note.gnu.property sections from input object files which 1879 // contain a hint to tweak linker's and loader's behaviors. 1880 config->andFeatures = getAndFeatures<ELFT>(); 1881 1882 // The Target instance handles target-specific stuff, such as applying 1883 // relocations or writing a PLT section. It also contains target-dependent 1884 // values such as a default image base address. 1885 target = getTarget(); 1886 1887 config->eflags = target->calcEFlags(); 1888 // maxPageSize (sometimes called abi page size) is the maximum page size that 1889 // the output can be run on. For example if the OS can use 4k or 64k page 1890 // sizes then maxPageSize must be 64k for the output to be useable on both. 1891 // All important alignment decisions must use this value. 1892 config->maxPageSize = getMaxPageSize(args); 1893 // commonPageSize is the most common page size that the output will be run on. 1894 // For example if an OS can use 4k or 64k page sizes and 4k is more common 1895 // than 64k then commonPageSize is set to 4k. commonPageSize can be used for 1896 // optimizations such as DATA_SEGMENT_ALIGN in linker scripts. LLD's use of it 1897 // is limited to writing trap instructions on the last executable segment. 1898 config->commonPageSize = getCommonPageSize(args); 1899 1900 config->imageBase = getImageBase(args); 1901 1902 if (config->emachine == EM_ARM) { 1903 // FIXME: These warnings can be removed when lld only uses these features 1904 // when the input objects have been compiled with an architecture that 1905 // supports them. 1906 if (config->armHasBlx == false) 1907 warn("lld uses blx instruction, no object with architecture supporting " 1908 "feature detected"); 1909 } 1910 1911 // This adds a .comment section containing a version string. 1912 if (!config->relocatable) 1913 inputSections.push_back(createCommentSection()); 1914 1915 // Replace common symbols with regular symbols. 1916 replaceCommonSymbols(); 1917 1918 // Split SHF_MERGE and .eh_frame sections into pieces in preparation for garbage collection. 1919 splitSections<ELFT>(); 1920 1921 // Garbage collection and removal of shared symbols from unused shared objects. 1922 markLive<ELFT>(); 1923 demoteSharedSymbols(); 1924 1925 // Make copies of any input sections that need to be copied into each 1926 // partition. 1927 copySectionsIntoPartitions(); 1928 1929 // Create synthesized sections such as .got and .plt. This is called before 1930 // processSectionCommands() so that they can be placed by SECTIONS commands. 1931 createSyntheticSections<ELFT>(); 1932 1933 // Some input sections that are used for exception handling need to be moved 1934 // into synthetic sections. Do that now so that they aren't assigned to 1935 // output sections in the usual way. 1936 if (!config->relocatable) 1937 combineEhSections(); 1938 1939 // Create output sections described by SECTIONS commands. 1940 script->processSectionCommands(); 1941 1942 // Linker scripts control how input sections are assigned to output sections. 1943 // Input sections that were not handled by scripts are called "orphans", and 1944 // they are assigned to output sections by the default rule. Process that. 1945 script->addOrphanSections(); 1946 1947 // Migrate InputSectionDescription::sectionBases to sections. This includes 1948 // merging MergeInputSections into a single MergeSyntheticSection. From this 1949 // point onwards InputSectionDescription::sections should be used instead of 1950 // sectionBases. 1951 for (BaseCommand *base : script->sectionCommands) 1952 if (auto *sec = dyn_cast<OutputSection>(base)) 1953 sec->finalizeInputSections(); 1954 llvm::erase_if(inputSections, 1955 [](InputSectionBase *s) { return isa<MergeInputSection>(s); }); 1956 1957 // Two input sections with different output sections should not be folded. 1958 // ICF runs after processSectionCommands() so that we know the output sections. 1959 if (config->icf != ICFLevel::None) { 1960 findKeepUniqueSections<ELFT>(args); 1961 doIcf<ELFT>(); 1962 } 1963 1964 // Read the callgraph now that we know what was gced or icfed 1965 if (config->callGraphProfileSort) { 1966 if (auto *arg = args.getLastArg(OPT_call_graph_ordering_file)) 1967 if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())) 1968 readCallGraph(*buffer); 1969 readCallGraphsFromObjectFiles<ELFT>(); 1970 } 1971 1972 // Write the result to the file. 1973 writeResult<ELFT>(); 1974 } 1975 1976 } // namespace elf 1977 } // namespace lld 1978