1 //===- Driver.cpp ---------------------------------------------------------===// 2 // 3 // The LLVM Linker 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // The driver drives the entire linking process. It is responsible for 11 // parsing command line options and doing whatever it is instructed to do. 12 // 13 // One notable thing in the LLD's driver when compared to other linkers is 14 // that the LLD's driver is agnostic on the host operating system. 15 // Other linkers usually have implicit default values (such as a dynamic 16 // linker path or library paths) for each host OS. 17 // 18 // I don't think implicit default values are useful because they are 19 // usually explicitly specified by the compiler driver. They can even 20 // be harmful when you are doing cross-linking. Therefore, in LLD, we 21 // simply trust the compiler driver to pass all required options and 22 // don't try to make effort on our side. 23 // 24 //===----------------------------------------------------------------------===// 25 26 #include "Driver.h" 27 #include "Config.h" 28 #include "Filesystem.h" 29 #include "ICF.h" 30 #include "InputFiles.h" 31 #include "InputSection.h" 32 #include "LinkerScript.h" 33 #include "MarkLive.h" 34 #include "OutputSections.h" 35 #include "ScriptParser.h" 36 #include "SymbolTable.h" 37 #include "Symbols.h" 38 #include "SyntheticSections.h" 39 #include "Target.h" 40 #include "Writer.h" 41 #include "lld/Common/Args.h" 42 #include "lld/Common/Driver.h" 43 #include "lld/Common/ErrorHandler.h" 44 #include "lld/Common/Memory.h" 45 #include "lld/Common/Strings.h" 46 #include "lld/Common/TargetOptionsCommandFlags.h" 47 #include "lld/Common/Threads.h" 48 #include "lld/Common/Version.h" 49 #include "llvm/ADT/SetVector.h" 50 #include "llvm/ADT/StringExtras.h" 51 #include "llvm/ADT/StringSwitch.h" 52 #include "llvm/Support/CommandLine.h" 53 #include "llvm/Support/Compression.h" 54 #include "llvm/Support/LEB128.h" 55 #include "llvm/Support/Path.h" 56 #include "llvm/Support/TarWriter.h" 57 #include "llvm/Support/TargetSelect.h" 58 #include "llvm/Support/raw_ostream.h" 59 #include <cstdlib> 60 #include <utility> 61 62 using namespace llvm; 63 using namespace llvm::ELF; 64 using namespace llvm::object; 65 using namespace llvm::sys; 66 67 using namespace lld; 68 using namespace lld::elf; 69 70 Configuration *elf::Config; 71 LinkerDriver *elf::Driver; 72 73 static void setConfigs(opt::InputArgList &Args); 74 75 bool elf::link(ArrayRef<const char *> Args, bool CanExitEarly, 76 raw_ostream &Error) { 77 errorHandler().LogName = sys::path::filename(Args[0]); 78 errorHandler().ErrorLimitExceededMsg = 79 "too many errors emitted, stopping now (use " 80 "-error-limit=0 to see all errors)"; 81 errorHandler().ErrorOS = &Error; 82 errorHandler().ExitEarly = CanExitEarly; 83 errorHandler().ColorDiagnostics = Error.has_colors(); 84 85 InputSections.clear(); 86 OutputSections.clear(); 87 Tar = nullptr; 88 BinaryFiles.clear(); 89 BitcodeFiles.clear(); 90 ObjectFiles.clear(); 91 SharedFiles.clear(); 92 93 Config = make<Configuration>(); 94 Driver = make<LinkerDriver>(); 95 Script = make<LinkerScript>(); 96 Symtab = make<SymbolTable>(); 97 Config->ProgName = Args[0]; 98 99 Driver->main(Args); 100 101 // Exit immediately if we don't need to return to the caller. 102 // This saves time because the overhead of calling destructors 103 // for all globally-allocated objects is not negligible. 104 if (CanExitEarly) 105 exitLld(errorCount() ? 1 : 0); 106 107 freeArena(); 108 return !errorCount(); 109 } 110 111 // Parses a linker -m option. 112 static std::tuple<ELFKind, uint16_t, uint8_t> parseEmulation(StringRef Emul) { 113 uint8_t OSABI = 0; 114 StringRef S = Emul; 115 if (S.endswith("_fbsd")) { 116 S = S.drop_back(5); 117 OSABI = ELFOSABI_FREEBSD; 118 } 119 120 std::pair<ELFKind, uint16_t> Ret = 121 StringSwitch<std::pair<ELFKind, uint16_t>>(S) 122 .Cases("aarch64elf", "aarch64linux", "aarch64_elf64_le_vec", 123 {ELF64LEKind, EM_AARCH64}) 124 .Cases("armelf", "armelf_linux_eabi", {ELF32LEKind, EM_ARM}) 125 .Case("elf32_x86_64", {ELF32LEKind, EM_X86_64}) 126 .Cases("elf32btsmip", "elf32btsmipn32", {ELF32BEKind, EM_MIPS}) 127 .Cases("elf32ltsmip", "elf32ltsmipn32", {ELF32LEKind, EM_MIPS}) 128 .Case("elf32ppc", {ELF32BEKind, EM_PPC}) 129 .Case("elf64btsmip", {ELF64BEKind, EM_MIPS}) 130 .Case("elf64ltsmip", {ELF64LEKind, EM_MIPS}) 131 .Case("elf64ppc", {ELF64BEKind, EM_PPC64}) 132 .Case("elf64lppc", {ELF64LEKind, EM_PPC64}) 133 .Cases("elf_amd64", "elf_x86_64", {ELF64LEKind, EM_X86_64}) 134 .Case("elf_i386", {ELF32LEKind, EM_386}) 135 .Case("elf_iamcu", {ELF32LEKind, EM_IAMCU}) 136 .Default({ELFNoneKind, EM_NONE}); 137 138 if (Ret.first == ELFNoneKind) 139 error("unknown emulation: " + Emul); 140 return std::make_tuple(Ret.first, Ret.second, OSABI); 141 } 142 143 // Returns slices of MB by parsing MB as an archive file. 144 // Each slice consists of a member file in the archive. 145 std::vector<std::pair<MemoryBufferRef, uint64_t>> static getArchiveMembers( 146 MemoryBufferRef MB) { 147 std::unique_ptr<Archive> File = 148 CHECK(Archive::create(MB), 149 MB.getBufferIdentifier() + ": failed to parse archive"); 150 151 std::vector<std::pair<MemoryBufferRef, uint64_t>> V; 152 Error Err = Error::success(); 153 bool AddToTar = File->isThin() && Tar; 154 for (const ErrorOr<Archive::Child> &COrErr : File->children(Err)) { 155 Archive::Child C = 156 CHECK(COrErr, MB.getBufferIdentifier() + 157 ": could not get the child of the archive"); 158 MemoryBufferRef MBRef = 159 CHECK(C.getMemoryBufferRef(), 160 MB.getBufferIdentifier() + 161 ": could not get the buffer for a child of the archive"); 162 if (AddToTar) 163 Tar->append(relativeToRoot(check(C.getFullName())), MBRef.getBuffer()); 164 V.push_back(std::make_pair(MBRef, C.getChildOffset())); 165 } 166 if (Err) 167 fatal(MB.getBufferIdentifier() + ": Archive::children failed: " + 168 toString(std::move(Err))); 169 170 // Take ownership of memory buffers created for members of thin archives. 171 for (std::unique_ptr<MemoryBuffer> &MB : File->takeThinBuffers()) 172 make<std::unique_ptr<MemoryBuffer>>(std::move(MB)); 173 174 return V; 175 } 176 177 // Opens a file and create a file object. Path has to be resolved already. 178 void LinkerDriver::addFile(StringRef Path, bool WithLOption) { 179 using namespace sys::fs; 180 181 Optional<MemoryBufferRef> Buffer = readFile(Path); 182 if (!Buffer.hasValue()) 183 return; 184 MemoryBufferRef MBRef = *Buffer; 185 186 if (InBinary) { 187 Files.push_back(make<BinaryFile>(MBRef)); 188 return; 189 } 190 191 switch (identify_magic(MBRef.getBuffer())) { 192 case file_magic::unknown: 193 readLinkerScript(MBRef); 194 return; 195 case file_magic::archive: { 196 // Handle -whole-archive. 197 if (InWholeArchive) { 198 for (const auto &P : getArchiveMembers(MBRef)) 199 Files.push_back(createObjectFile(P.first, Path, P.second)); 200 return; 201 } 202 203 std::unique_ptr<Archive> File = 204 CHECK(Archive::create(MBRef), Path + ": failed to parse archive"); 205 206 // If an archive file has no symbol table, it is likely that a user 207 // is attempting LTO and using a default ar command that doesn't 208 // understand the LLVM bitcode file. It is a pretty common error, so 209 // we'll handle it as if it had a symbol table. 210 if (!File->isEmpty() && !File->hasSymbolTable()) { 211 for (const auto &P : getArchiveMembers(MBRef)) 212 Files.push_back(make<LazyObjFile>(P.first, Path, P.second)); 213 return; 214 } 215 216 // Handle the regular case. 217 Files.push_back(make<ArchiveFile>(std::move(File))); 218 return; 219 } 220 case file_magic::elf_shared_object: 221 if (Config->Relocatable) { 222 error("attempted static link of dynamic object " + Path); 223 return; 224 } 225 226 // DSOs usually have DT_SONAME tags in their ELF headers, and the 227 // sonames are used to identify DSOs. But if they are missing, 228 // they are identified by filenames. We don't know whether the new 229 // file has a DT_SONAME or not because we haven't parsed it yet. 230 // Here, we set the default soname for the file because we might 231 // need it later. 232 // 233 // If a file was specified by -lfoo, the directory part is not 234 // significant, as a user did not specify it. This behavior is 235 // compatible with GNU. 236 Files.push_back( 237 createSharedFile(MBRef, WithLOption ? path::filename(Path) : Path)); 238 return; 239 case file_magic::bitcode: 240 case file_magic::elf_relocatable: 241 if (InLib) 242 Files.push_back(make<LazyObjFile>(MBRef, "", 0)); 243 else 244 Files.push_back(createObjectFile(MBRef)); 245 break; 246 default: 247 error(Path + ": unknown file type"); 248 } 249 } 250 251 // Add a given library by searching it from input search paths. 252 void LinkerDriver::addLibrary(StringRef Name) { 253 if (Optional<std::string> Path = searchLibrary(Name)) 254 addFile(*Path, /*WithLOption=*/true); 255 else 256 error("unable to find library -l" + Name); 257 } 258 259 // This function is called on startup. We need this for LTO since 260 // LTO calls LLVM functions to compile bitcode files to native code. 261 // Technically this can be delayed until we read bitcode files, but 262 // we don't bother to do lazily because the initialization is fast. 263 static void initLLVM() { 264 InitializeAllTargets(); 265 InitializeAllTargetMCs(); 266 InitializeAllAsmPrinters(); 267 InitializeAllAsmParsers(); 268 } 269 270 // Some command line options or some combinations of them are not allowed. 271 // This function checks for such errors. 272 static void checkOptions(opt::InputArgList &Args) { 273 // The MIPS ABI as of 2016 does not support the GNU-style symbol lookup 274 // table which is a relatively new feature. 275 if (Config->EMachine == EM_MIPS && Config->GnuHash) 276 error("the .gnu.hash section is not compatible with the MIPS target."); 277 278 if (Config->FixCortexA53Errata843419 && Config->EMachine != EM_AARCH64) 279 error("--fix-cortex-a53-843419 is only supported on AArch64 targets."); 280 281 if (Config->Pie && Config->Shared) 282 error("-shared and -pie may not be used together"); 283 284 if (!Config->Shared && !Config->FilterList.empty()) 285 error("-F may not be used without -shared"); 286 287 if (!Config->Shared && !Config->AuxiliaryList.empty()) 288 error("-f may not be used without -shared"); 289 290 if (!Config->Relocatable && !Config->DefineCommon) 291 error("-no-define-common not supported in non relocatable output"); 292 293 if (Config->Relocatable) { 294 if (Config->Shared) 295 error("-r and -shared may not be used together"); 296 if (Config->GcSections) 297 error("-r and --gc-sections may not be used together"); 298 if (Config->GdbIndex) 299 error("-r and --gdb-index may not be used together"); 300 if (Config->ICF != ICFLevel::None) 301 error("-r and --icf may not be used together"); 302 if (Config->Pie) 303 error("-r and -pie may not be used together"); 304 } 305 306 if (Config->ExecuteOnly) { 307 if (Config->EMachine != EM_AARCH64) 308 error("-execute-only is only supported on AArch64 targets"); 309 310 if (Config->SingleRoRx && !Script->HasSectionsCommand) 311 error("-execute-only and -no-rosegment cannot be used together"); 312 } 313 } 314 315 static const char *getReproduceOption(opt::InputArgList &Args) { 316 if (auto *Arg = Args.getLastArg(OPT_reproduce)) 317 return Arg->getValue(); 318 return getenv("LLD_REPRODUCE"); 319 } 320 321 static bool hasZOption(opt::InputArgList &Args, StringRef Key) { 322 for (auto *Arg : Args.filtered(OPT_z)) 323 if (Key == Arg->getValue()) 324 return true; 325 return false; 326 } 327 328 static bool getZFlag(opt::InputArgList &Args, StringRef K1, StringRef K2, 329 bool Default) { 330 for (auto *Arg : Args.filtered_reverse(OPT_z)) { 331 if (K1 == Arg->getValue()) 332 return true; 333 if (K2 == Arg->getValue()) 334 return false; 335 } 336 return Default; 337 } 338 339 static bool isKnown(StringRef S) { 340 return S == "combreloc" || S == "copyreloc" || S == "defs" || 341 S == "execstack" || S == "hazardplt" || S == "ifunc-noplt" || 342 S == "initfirst" || S == "interpose" || 343 S == "keep-text-section-prefix" || S == "lazy" || S == "muldefs" || 344 S == "nocombreloc" || S == "nocopyreloc" || S == "nodelete" || 345 S == "nodlopen" || S == "noexecstack" || 346 S == "nokeep-text-section-prefix" || S == "norelro" || S == "notext" || 347 S == "now" || S == "origin" || S == "relro" || S == "retpolineplt" || 348 S == "rodynamic" || S == "text" || S == "wxneeded" || 349 S.startswith("max-page-size=") || S.startswith("stack-size="); 350 } 351 352 // Report an error for an unknown -z option. 353 static void checkZOptions(opt::InputArgList &Args) { 354 for (auto *Arg : Args.filtered(OPT_z)) 355 if (!isKnown(Arg->getValue())) 356 error("unknown -z value: " + StringRef(Arg->getValue())); 357 } 358 359 void LinkerDriver::main(ArrayRef<const char *> ArgsArr) { 360 ELFOptTable Parser; 361 opt::InputArgList Args = Parser.parse(ArgsArr.slice(1)); 362 363 // Interpret this flag early because error() depends on them. 364 errorHandler().ErrorLimit = args::getInteger(Args, OPT_error_limit, 20); 365 366 // Handle -help 367 if (Args.hasArg(OPT_help)) { 368 printHelp(); 369 return; 370 } 371 372 // Handle -v or -version. 373 // 374 // A note about "compatible with GNU linkers" message: this is a hack for 375 // scripts generated by GNU Libtool 2.4.6 (released in February 2014 and 376 // still the newest version in March 2017) or earlier to recognize LLD as 377 // a GNU compatible linker. As long as an output for the -v option 378 // contains "GNU" or "with BFD", they recognize us as GNU-compatible. 379 // 380 // This is somewhat ugly hack, but in reality, we had no choice other 381 // than doing this. Considering the very long release cycle of Libtool, 382 // it is not easy to improve it to recognize LLD as a GNU compatible 383 // linker in a timely manner. Even if we can make it, there are still a 384 // lot of "configure" scripts out there that are generated by old version 385 // of Libtool. We cannot convince every software developer to migrate to 386 // the latest version and re-generate scripts. So we have this hack. 387 if (Args.hasArg(OPT_v) || Args.hasArg(OPT_version)) 388 message(getLLDVersion() + " (compatible with GNU linkers)"); 389 390 // The behavior of -v or --version is a bit strange, but this is 391 // needed for compatibility with GNU linkers. 392 if (Args.hasArg(OPT_v) && !Args.hasArg(OPT_INPUT)) 393 return; 394 if (Args.hasArg(OPT_version)) 395 return; 396 397 if (const char *Path = getReproduceOption(Args)) { 398 // Note that --reproduce is a debug option so you can ignore it 399 // if you are trying to understand the whole picture of the code. 400 Expected<std::unique_ptr<TarWriter>> ErrOrWriter = 401 TarWriter::create(Path, path::stem(Path)); 402 if (ErrOrWriter) { 403 Tar = ErrOrWriter->get(); 404 Tar->append("response.txt", createResponseFile(Args)); 405 Tar->append("version.txt", getLLDVersion() + "\n"); 406 make<std::unique_ptr<TarWriter>>(std::move(*ErrOrWriter)); 407 } else { 408 error(Twine("--reproduce: failed to open ") + Path + ": " + 409 toString(ErrOrWriter.takeError())); 410 } 411 } 412 413 readConfigs(Args); 414 checkZOptions(Args); 415 initLLVM(); 416 createFiles(Args); 417 if (errorCount()) 418 return; 419 420 inferMachineType(); 421 setConfigs(Args); 422 checkOptions(Args); 423 if (errorCount()) 424 return; 425 426 switch (Config->EKind) { 427 case ELF32LEKind: 428 link<ELF32LE>(Args); 429 return; 430 case ELF32BEKind: 431 link<ELF32BE>(Args); 432 return; 433 case ELF64LEKind: 434 link<ELF64LE>(Args); 435 return; 436 case ELF64BEKind: 437 link<ELF64BE>(Args); 438 return; 439 default: 440 llvm_unreachable("unknown Config->EKind"); 441 } 442 } 443 444 static std::string getRpath(opt::InputArgList &Args) { 445 std::vector<StringRef> V = args::getStrings(Args, OPT_rpath); 446 return llvm::join(V.begin(), V.end(), ":"); 447 } 448 449 // Determines what we should do if there are remaining unresolved 450 // symbols after the name resolution. 451 static UnresolvedPolicy getUnresolvedSymbolPolicy(opt::InputArgList &Args) { 452 if (Args.hasArg(OPT_relocatable)) 453 return UnresolvedPolicy::IgnoreAll; 454 455 UnresolvedPolicy ErrorOrWarn = Args.hasFlag(OPT_error_unresolved_symbols, 456 OPT_warn_unresolved_symbols, true) 457 ? UnresolvedPolicy::ReportError 458 : UnresolvedPolicy::Warn; 459 460 // Process the last of -unresolved-symbols, -no-undefined or -z defs. 461 for (auto *Arg : llvm::reverse(Args)) { 462 switch (Arg->getOption().getID()) { 463 case OPT_unresolved_symbols: { 464 StringRef S = Arg->getValue(); 465 if (S == "ignore-all" || S == "ignore-in-object-files") 466 return UnresolvedPolicy::Ignore; 467 if (S == "ignore-in-shared-libs" || S == "report-all") 468 return ErrorOrWarn; 469 error("unknown --unresolved-symbols value: " + S); 470 continue; 471 } 472 case OPT_no_undefined: 473 return ErrorOrWarn; 474 case OPT_z: 475 if (StringRef(Arg->getValue()) == "defs") 476 return ErrorOrWarn; 477 continue; 478 } 479 } 480 481 // -shared implies -unresolved-symbols=ignore-all because missing 482 // symbols are likely to be resolved at runtime using other DSOs. 483 if (Config->Shared) 484 return UnresolvedPolicy::Ignore; 485 return ErrorOrWarn; 486 } 487 488 static Target2Policy getTarget2(opt::InputArgList &Args) { 489 StringRef S = Args.getLastArgValue(OPT_target2, "got-rel"); 490 if (S == "rel") 491 return Target2Policy::Rel; 492 if (S == "abs") 493 return Target2Policy::Abs; 494 if (S == "got-rel") 495 return Target2Policy::GotRel; 496 error("unknown --target2 option: " + S); 497 return Target2Policy::GotRel; 498 } 499 500 static bool isOutputFormatBinary(opt::InputArgList &Args) { 501 if (auto *Arg = Args.getLastArg(OPT_oformat)) { 502 StringRef S = Arg->getValue(); 503 if (S == "binary") 504 return true; 505 if (S.startswith("elf")) 506 return false; 507 error("unknown --oformat value: " + S); 508 } 509 return false; 510 } 511 512 static DiscardPolicy getDiscard(opt::InputArgList &Args) { 513 if (Args.hasArg(OPT_relocatable)) 514 return DiscardPolicy::None; 515 516 auto *Arg = 517 Args.getLastArg(OPT_discard_all, OPT_discard_locals, OPT_discard_none); 518 if (!Arg) 519 return DiscardPolicy::Default; 520 if (Arg->getOption().getID() == OPT_discard_all) 521 return DiscardPolicy::All; 522 if (Arg->getOption().getID() == OPT_discard_locals) 523 return DiscardPolicy::Locals; 524 return DiscardPolicy::None; 525 } 526 527 static StringRef getDynamicLinker(opt::InputArgList &Args) { 528 auto *Arg = Args.getLastArg(OPT_dynamic_linker, OPT_no_dynamic_linker); 529 if (!Arg || Arg->getOption().getID() == OPT_no_dynamic_linker) 530 return ""; 531 return Arg->getValue(); 532 } 533 534 static ICFLevel getICF(opt::InputArgList &Args) { 535 auto *Arg = Args.getLastArg(OPT_icf_none, OPT_icf_safe, OPT_icf_all); 536 if (!Arg || Arg->getOption().getID() == OPT_icf_none) 537 return ICFLevel::None; 538 if (Arg->getOption().getID() == OPT_icf_safe) 539 return ICFLevel::Safe; 540 return ICFLevel::All; 541 } 542 543 static StripPolicy getStrip(opt::InputArgList &Args) { 544 if (Args.hasArg(OPT_relocatable)) 545 return StripPolicy::None; 546 547 auto *Arg = Args.getLastArg(OPT_strip_all, OPT_strip_debug); 548 if (!Arg) 549 return StripPolicy::None; 550 if (Arg->getOption().getID() == OPT_strip_all) 551 return StripPolicy::All; 552 return StripPolicy::Debug; 553 } 554 555 static uint64_t parseSectionAddress(StringRef S, const opt::Arg &Arg) { 556 uint64_t VA = 0; 557 if (S.startswith("0x")) 558 S = S.drop_front(2); 559 if (!to_integer(S, VA, 16)) 560 error("invalid argument: " + toString(Arg)); 561 return VA; 562 } 563 564 static StringMap<uint64_t> getSectionStartMap(opt::InputArgList &Args) { 565 StringMap<uint64_t> Ret; 566 for (auto *Arg : Args.filtered(OPT_section_start)) { 567 StringRef Name; 568 StringRef Addr; 569 std::tie(Name, Addr) = StringRef(Arg->getValue()).split('='); 570 Ret[Name] = parseSectionAddress(Addr, *Arg); 571 } 572 573 if (auto *Arg = Args.getLastArg(OPT_Ttext)) 574 Ret[".text"] = parseSectionAddress(Arg->getValue(), *Arg); 575 if (auto *Arg = Args.getLastArg(OPT_Tdata)) 576 Ret[".data"] = parseSectionAddress(Arg->getValue(), *Arg); 577 if (auto *Arg = Args.getLastArg(OPT_Tbss)) 578 Ret[".bss"] = parseSectionAddress(Arg->getValue(), *Arg); 579 return Ret; 580 } 581 582 static SortSectionPolicy getSortSection(opt::InputArgList &Args) { 583 StringRef S = Args.getLastArgValue(OPT_sort_section); 584 if (S == "alignment") 585 return SortSectionPolicy::Alignment; 586 if (S == "name") 587 return SortSectionPolicy::Name; 588 if (!S.empty()) 589 error("unknown --sort-section rule: " + S); 590 return SortSectionPolicy::Default; 591 } 592 593 static OrphanHandlingPolicy getOrphanHandling(opt::InputArgList &Args) { 594 StringRef S = Args.getLastArgValue(OPT_orphan_handling, "place"); 595 if (S == "warn") 596 return OrphanHandlingPolicy::Warn; 597 if (S == "error") 598 return OrphanHandlingPolicy::Error; 599 if (S != "place") 600 error("unknown --orphan-handling mode: " + S); 601 return OrphanHandlingPolicy::Place; 602 } 603 604 // Parse --build-id or --build-id=<style>. We handle "tree" as a 605 // synonym for "sha1" because all our hash functions including 606 // -build-id=sha1 are actually tree hashes for performance reasons. 607 static std::pair<BuildIdKind, std::vector<uint8_t>> 608 getBuildId(opt::InputArgList &Args) { 609 auto *Arg = Args.getLastArg(OPT_build_id, OPT_build_id_eq); 610 if (!Arg) 611 return {BuildIdKind::None, {}}; 612 613 if (Arg->getOption().getID() == OPT_build_id) 614 return {BuildIdKind::Fast, {}}; 615 616 StringRef S = Arg->getValue(); 617 if (S == "fast") 618 return {BuildIdKind::Fast, {}}; 619 if (S == "md5") 620 return {BuildIdKind::Md5, {}}; 621 if (S == "sha1" || S == "tree") 622 return {BuildIdKind::Sha1, {}}; 623 if (S == "uuid") 624 return {BuildIdKind::Uuid, {}}; 625 if (S.startswith("0x")) 626 return {BuildIdKind::Hexstring, parseHex(S.substr(2))}; 627 628 if (S != "none") 629 error("unknown --build-id style: " + S); 630 return {BuildIdKind::None, {}}; 631 } 632 633 static std::pair<bool, bool> getPackDynRelocs(opt::InputArgList &Args) { 634 StringRef S = Args.getLastArgValue(OPT_pack_dyn_relocs, "none"); 635 if (S == "android") 636 return {true, false}; 637 if (S == "relr") 638 return {false, true}; 639 if (S == "android+relr") 640 return {true, true}; 641 642 if (S != "none") 643 error("unknown -pack-dyn-relocs format: " + S); 644 return {false, false}; 645 } 646 647 static void readCallGraph(MemoryBufferRef MB) { 648 // Build a map from symbol name to section 649 DenseMap<StringRef, const Symbol *> SymbolNameToSymbol; 650 for (InputFile *File : ObjectFiles) 651 for (Symbol *Sym : File->getSymbols()) 652 SymbolNameToSymbol[Sym->getName()] = Sym; 653 654 for (StringRef L : args::getLines(MB)) { 655 SmallVector<StringRef, 3> Fields; 656 L.split(Fields, ' '); 657 uint64_t Count; 658 if (Fields.size() != 3 || !to_integer(Fields[2], Count)) 659 fatal(MB.getBufferIdentifier() + ": parse error"); 660 const Symbol *FromSym = SymbolNameToSymbol.lookup(Fields[0]); 661 const Symbol *ToSym = SymbolNameToSymbol.lookup(Fields[1]); 662 if (Config->WarnSymbolOrdering) { 663 if (!FromSym) 664 warn(MB.getBufferIdentifier() + ": no such symbol: " + Fields[0]); 665 if (!ToSym) 666 warn(MB.getBufferIdentifier() + ": no such symbol: " + Fields[1]); 667 } 668 if (!FromSym || !ToSym || Count == 0) 669 continue; 670 warnUnorderableSymbol(FromSym); 671 warnUnorderableSymbol(ToSym); 672 const Defined *FromSymD = dyn_cast<Defined>(FromSym); 673 const Defined *ToSymD = dyn_cast<Defined>(ToSym); 674 if (!FromSymD || !ToSymD) 675 continue; 676 const auto *FromSB = dyn_cast_or_null<InputSectionBase>(FromSymD->Section); 677 const auto *ToSB = dyn_cast_or_null<InputSectionBase>(ToSymD->Section); 678 if (!FromSB || !ToSB) 679 continue; 680 Config->CallGraphProfile[std::make_pair(FromSB, ToSB)] += Count; 681 } 682 } 683 684 static bool getCompressDebugSections(opt::InputArgList &Args) { 685 StringRef S = Args.getLastArgValue(OPT_compress_debug_sections, "none"); 686 if (S == "none") 687 return false; 688 if (S != "zlib") 689 error("unknown --compress-debug-sections value: " + S); 690 if (!zlib::isAvailable()) 691 error("--compress-debug-sections: zlib is not available"); 692 return true; 693 } 694 695 static std::pair<StringRef, StringRef> getOldNewOptions(opt::InputArgList &Args, 696 unsigned Id) { 697 auto *Arg = Args.getLastArg(Id); 698 if (!Arg) 699 return {"", ""}; 700 701 StringRef S = Arg->getValue(); 702 std::pair<StringRef, StringRef> Ret = S.split(';'); 703 if (Ret.second.empty()) 704 error(Arg->getSpelling() + " expects 'old;new' format, but got " + S); 705 return Ret; 706 } 707 708 // Parse the symbol ordering file and warn for any duplicate entries. 709 static std::vector<StringRef> getSymbolOrderingFile(MemoryBufferRef MB) { 710 SetVector<StringRef> Names; 711 for (StringRef S : args::getLines(MB)) 712 if (!Names.insert(S) && Config->WarnSymbolOrdering) 713 warn(MB.getBufferIdentifier() + ": duplicate ordered symbol: " + S); 714 715 return Names.takeVector(); 716 } 717 718 static void parseClangOption(StringRef Opt, const Twine &Msg) { 719 std::string Err; 720 raw_string_ostream OS(Err); 721 722 const char *Argv[] = {Config->ProgName.data(), Opt.data()}; 723 if (cl::ParseCommandLineOptions(2, Argv, "", &OS)) 724 return; 725 OS.flush(); 726 error(Msg + ": " + StringRef(Err).trim()); 727 } 728 729 // Initializes Config members by the command line options. 730 void LinkerDriver::readConfigs(opt::InputArgList &Args) { 731 errorHandler().Verbose = Args.hasArg(OPT_verbose); 732 errorHandler().FatalWarnings = 733 Args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false); 734 ThreadsEnabled = Args.hasFlag(OPT_threads, OPT_no_threads, true); 735 736 Config->AllowMultipleDefinition = 737 Args.hasFlag(OPT_allow_multiple_definition, 738 OPT_no_allow_multiple_definition, false) || 739 hasZOption(Args, "muldefs"); 740 Config->AuxiliaryList = args::getStrings(Args, OPT_auxiliary); 741 Config->Bsymbolic = Args.hasArg(OPT_Bsymbolic); 742 Config->BsymbolicFunctions = Args.hasArg(OPT_Bsymbolic_functions); 743 Config->CheckSections = 744 Args.hasFlag(OPT_check_sections, OPT_no_check_sections, true); 745 Config->Chroot = Args.getLastArgValue(OPT_chroot); 746 Config->CompressDebugSections = getCompressDebugSections(Args); 747 Config->Cref = Args.hasFlag(OPT_cref, OPT_no_cref, false); 748 Config->DefineCommon = Args.hasFlag(OPT_define_common, OPT_no_define_common, 749 !Args.hasArg(OPT_relocatable)); 750 Config->Demangle = Args.hasFlag(OPT_demangle, OPT_no_demangle, true); 751 Config->DisableVerify = Args.hasArg(OPT_disable_verify); 752 Config->Discard = getDiscard(Args); 753 Config->DwoDir = Args.getLastArgValue(OPT_plugin_opt_dwo_dir_eq); 754 Config->DynamicLinker = getDynamicLinker(Args); 755 Config->EhFrameHdr = 756 Args.hasFlag(OPT_eh_frame_hdr, OPT_no_eh_frame_hdr, false); 757 Config->EmitRelocs = Args.hasArg(OPT_emit_relocs); 758 Config->EnableNewDtags = 759 Args.hasFlag(OPT_enable_new_dtags, OPT_disable_new_dtags, true); 760 Config->Entry = Args.getLastArgValue(OPT_entry); 761 Config->ExecuteOnly = 762 Args.hasFlag(OPT_execute_only, OPT_no_execute_only, false); 763 Config->ExportDynamic = 764 Args.hasFlag(OPT_export_dynamic, OPT_no_export_dynamic, false); 765 Config->FilterList = args::getStrings(Args, OPT_filter); 766 Config->Fini = Args.getLastArgValue(OPT_fini, "_fini"); 767 Config->FixCortexA53Errata843419 = Args.hasArg(OPT_fix_cortex_a53_843419); 768 Config->GcSections = Args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, false); 769 Config->GnuUnique = Args.hasFlag(OPT_gnu_unique, OPT_no_gnu_unique, true); 770 Config->GdbIndex = Args.hasFlag(OPT_gdb_index, OPT_no_gdb_index, false); 771 Config->ICF = getICF(Args); 772 Config->IgnoreDataAddressEquality = 773 Args.hasArg(OPT_ignore_data_address_equality); 774 Config->IgnoreFunctionAddressEquality = 775 Args.hasArg(OPT_ignore_function_address_equality); 776 Config->Init = Args.getLastArgValue(OPT_init, "_init"); 777 Config->LTOAAPipeline = Args.getLastArgValue(OPT_lto_aa_pipeline); 778 Config->LTODebugPassManager = Args.hasArg(OPT_lto_debug_pass_manager); 779 Config->LTONewPassManager = Args.hasArg(OPT_lto_new_pass_manager); 780 Config->LTONewPmPasses = Args.getLastArgValue(OPT_lto_newpm_passes); 781 Config->LTOO = args::getInteger(Args, OPT_lto_O, 2); 782 Config->LTOObjPath = Args.getLastArgValue(OPT_plugin_opt_obj_path_eq); 783 Config->LTOPartitions = args::getInteger(Args, OPT_lto_partitions, 1); 784 Config->LTOSampleProfile = Args.getLastArgValue(OPT_lto_sample_profile); 785 Config->MapFile = Args.getLastArgValue(OPT_Map); 786 Config->MipsGotSize = args::getInteger(Args, OPT_mips_got_size, 0xfff0); 787 Config->MergeArmExidx = 788 Args.hasFlag(OPT_merge_exidx_entries, OPT_no_merge_exidx_entries, true); 789 Config->NoinhibitExec = Args.hasArg(OPT_noinhibit_exec); 790 Config->Nostdlib = Args.hasArg(OPT_nostdlib); 791 Config->OFormatBinary = isOutputFormatBinary(Args); 792 Config->Omagic = Args.hasFlag(OPT_omagic, OPT_no_omagic, false); 793 Config->OptRemarksFilename = Args.getLastArgValue(OPT_opt_remarks_filename); 794 Config->OptRemarksWithHotness = Args.hasArg(OPT_opt_remarks_with_hotness); 795 Config->Optimize = args::getInteger(Args, OPT_O, 1); 796 Config->OrphanHandling = getOrphanHandling(Args); 797 Config->OutputFile = Args.getLastArgValue(OPT_o); 798 Config->Pie = Args.hasFlag(OPT_pie, OPT_no_pie, false); 799 Config->PrintIcfSections = 800 Args.hasFlag(OPT_print_icf_sections, OPT_no_print_icf_sections, false); 801 Config->PrintGcSections = 802 Args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false); 803 Config->Rpath = getRpath(Args); 804 Config->Relocatable = Args.hasArg(OPT_relocatable); 805 Config->SaveTemps = Args.hasArg(OPT_save_temps); 806 Config->SearchPaths = args::getStrings(Args, OPT_library_path); 807 Config->SectionStartMap = getSectionStartMap(Args); 808 Config->Shared = Args.hasArg(OPT_shared); 809 Config->SingleRoRx = Args.hasArg(OPT_no_rosegment); 810 Config->SoName = Args.getLastArgValue(OPT_soname); 811 Config->SortSection = getSortSection(Args); 812 Config->Strip = getStrip(Args); 813 Config->Sysroot = Args.getLastArgValue(OPT_sysroot); 814 Config->Target1Rel = Args.hasFlag(OPT_target1_rel, OPT_target1_abs, false); 815 Config->Target2 = getTarget2(Args); 816 Config->ThinLTOCacheDir = Args.getLastArgValue(OPT_thinlto_cache_dir); 817 Config->ThinLTOCachePolicy = CHECK( 818 parseCachePruningPolicy(Args.getLastArgValue(OPT_thinlto_cache_policy)), 819 "--thinlto-cache-policy: invalid cache policy"); 820 Config->ThinLTOEmitImportsFiles = 821 Args.hasArg(OPT_plugin_opt_thinlto_emit_imports_files); 822 Config->ThinLTOIndexOnly = Args.hasArg(OPT_plugin_opt_thinlto_index_only) || 823 Args.hasArg(OPT_plugin_opt_thinlto_index_only_eq); 824 Config->ThinLTOIndexOnlyArg = 825 Args.getLastArgValue(OPT_plugin_opt_thinlto_index_only_eq); 826 Config->ThinLTOJobs = args::getInteger(Args, OPT_thinlto_jobs, -1u); 827 Config->ThinLTOObjectSuffixReplace = 828 getOldNewOptions(Args, OPT_plugin_opt_thinlto_object_suffix_replace_eq); 829 Config->ThinLTOPrefixReplace = 830 getOldNewOptions(Args, OPT_plugin_opt_thinlto_prefix_replace_eq); 831 Config->Trace = Args.hasArg(OPT_trace); 832 Config->Undefined = args::getStrings(Args, OPT_undefined); 833 Config->UndefinedVersion = 834 Args.hasFlag(OPT_undefined_version, OPT_no_undefined_version, true); 835 Config->UseAndroidRelrTags = Args.hasFlag( 836 OPT_use_android_relr_tags, OPT_no_use_android_relr_tags, false); 837 Config->UnresolvedSymbols = getUnresolvedSymbolPolicy(Args); 838 Config->WarnBackrefs = 839 Args.hasFlag(OPT_warn_backrefs, OPT_no_warn_backrefs, false); 840 Config->WarnCommon = Args.hasFlag(OPT_warn_common, OPT_no_warn_common, false); 841 Config->WarnSymbolOrdering = 842 Args.hasFlag(OPT_warn_symbol_ordering, OPT_no_warn_symbol_ordering, true); 843 Config->ZCombreloc = getZFlag(Args, "combreloc", "nocombreloc", true); 844 Config->ZCopyreloc = getZFlag(Args, "copyreloc", "nocopyreloc", true); 845 Config->ZExecstack = getZFlag(Args, "execstack", "noexecstack", false); 846 Config->ZHazardplt = hasZOption(Args, "hazardplt"); 847 Config->ZIfuncnoplt = hasZOption(Args, "ifunc-noplt"); 848 Config->ZInitfirst = hasZOption(Args, "initfirst"); 849 Config->ZInterpose = hasZOption(Args, "interpose"); 850 Config->ZKeepTextSectionPrefix = getZFlag( 851 Args, "keep-text-section-prefix", "nokeep-text-section-prefix", false); 852 Config->ZNodelete = hasZOption(Args, "nodelete"); 853 Config->ZNodlopen = hasZOption(Args, "nodlopen"); 854 Config->ZNow = getZFlag(Args, "now", "lazy", false); 855 Config->ZOrigin = hasZOption(Args, "origin"); 856 Config->ZRelro = getZFlag(Args, "relro", "norelro", true); 857 Config->ZRetpolineplt = hasZOption(Args, "retpolineplt"); 858 Config->ZRodynamic = hasZOption(Args, "rodynamic"); 859 Config->ZStackSize = args::getZOptionValue(Args, OPT_z, "stack-size", 0); 860 Config->ZText = getZFlag(Args, "text", "notext", true); 861 Config->ZWxneeded = hasZOption(Args, "wxneeded"); 862 863 // Parse LTO options. 864 if (auto *Arg = Args.getLastArg(OPT_plugin_opt_mcpu_eq)) 865 parseClangOption(Saver.save("-mcpu=" + StringRef(Arg->getValue())), 866 Arg->getSpelling()); 867 868 for (auto *Arg : Args.filtered(OPT_plugin_opt)) 869 parseClangOption(Arg->getValue(), Arg->getSpelling()); 870 871 // Parse -mllvm options. 872 for (auto *Arg : Args.filtered(OPT_mllvm)) 873 parseClangOption(Arg->getValue(), Arg->getSpelling()); 874 875 if (Config->LTOO > 3) 876 error("invalid optimization level for LTO: " + Twine(Config->LTOO)); 877 if (Config->LTOPartitions == 0) 878 error("--lto-partitions: number of threads must be > 0"); 879 if (Config->ThinLTOJobs == 0) 880 error("--thinlto-jobs: number of threads must be > 0"); 881 882 // Parse ELF{32,64}{LE,BE} and CPU type. 883 if (auto *Arg = Args.getLastArg(OPT_m)) { 884 StringRef S = Arg->getValue(); 885 std::tie(Config->EKind, Config->EMachine, Config->OSABI) = 886 parseEmulation(S); 887 Config->MipsN32Abi = (S == "elf32btsmipn32" || S == "elf32ltsmipn32"); 888 Config->Emulation = S; 889 } 890 891 // Parse -hash-style={sysv,gnu,both}. 892 if (auto *Arg = Args.getLastArg(OPT_hash_style)) { 893 StringRef S = Arg->getValue(); 894 if (S == "sysv") 895 Config->SysvHash = true; 896 else if (S == "gnu") 897 Config->GnuHash = true; 898 else if (S == "both") 899 Config->SysvHash = Config->GnuHash = true; 900 else 901 error("unknown -hash-style: " + S); 902 } 903 904 if (Args.hasArg(OPT_print_map)) 905 Config->MapFile = "-"; 906 907 // --omagic is an option to create old-fashioned executables in which 908 // .text segments are writable. Today, the option is still in use to 909 // create special-purpose programs such as boot loaders. It doesn't 910 // make sense to create PT_GNU_RELRO for such executables. 911 if (Config->Omagic) 912 Config->ZRelro = false; 913 914 std::tie(Config->BuildId, Config->BuildIdVector) = getBuildId(Args); 915 916 std::tie(Config->AndroidPackDynRelocs, Config->RelrPackDynRelocs) = 917 getPackDynRelocs(Args); 918 919 if (auto *Arg = Args.getLastArg(OPT_symbol_ordering_file)) 920 if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue())) 921 Config->SymbolOrderingFile = getSymbolOrderingFile(*Buffer); 922 923 // If --retain-symbol-file is used, we'll keep only the symbols listed in 924 // the file and discard all others. 925 if (auto *Arg = Args.getLastArg(OPT_retain_symbols_file)) { 926 Config->DefaultSymbolVersion = VER_NDX_LOCAL; 927 if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue())) 928 for (StringRef S : args::getLines(*Buffer)) 929 Config->VersionScriptGlobals.push_back( 930 {S, /*IsExternCpp*/ false, /*HasWildcard*/ false}); 931 } 932 933 bool HasExportDynamic = 934 Args.hasFlag(OPT_export_dynamic, OPT_no_export_dynamic, false); 935 936 // Parses -dynamic-list and -export-dynamic-symbol. They make some 937 // symbols private. Note that -export-dynamic takes precedence over them 938 // as it says all symbols should be exported. 939 if (!HasExportDynamic) { 940 for (auto *Arg : Args.filtered(OPT_dynamic_list)) 941 if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue())) 942 readDynamicList(*Buffer); 943 944 for (auto *Arg : Args.filtered(OPT_export_dynamic_symbol)) 945 Config->DynamicList.push_back( 946 {Arg->getValue(), /*IsExternCpp*/ false, /*HasWildcard*/ false}); 947 } 948 949 // If --export-dynamic-symbol=foo is given and symbol foo is defined in 950 // an object file in an archive file, that object file should be pulled 951 // out and linked. (It doesn't have to behave like that from technical 952 // point of view, but this is needed for compatibility with GNU.) 953 for (auto *Arg : Args.filtered(OPT_export_dynamic_symbol)) 954 Config->Undefined.push_back(Arg->getValue()); 955 956 for (auto *Arg : Args.filtered(OPT_version_script)) 957 if (Optional<std::string> Path = searchScript(Arg->getValue())) { 958 if (Optional<MemoryBufferRef> Buffer = readFile(*Path)) 959 readVersionScript(*Buffer); 960 } else { 961 error(Twine("cannot find version script ") + Arg->getValue()); 962 } 963 } 964 965 // Some Config members do not directly correspond to any particular 966 // command line options, but computed based on other Config values. 967 // This function initialize such members. See Config.h for the details 968 // of these values. 969 static void setConfigs(opt::InputArgList &Args) { 970 ELFKind Kind = Config->EKind; 971 uint16_t Machine = Config->EMachine; 972 973 Config->CopyRelocs = (Config->Relocatable || Config->EmitRelocs); 974 Config->Is64 = (Kind == ELF64LEKind || Kind == ELF64BEKind); 975 Config->IsLE = (Kind == ELF32LEKind || Kind == ELF64LEKind); 976 Config->Endianness = 977 Config->IsLE ? support::endianness::little : support::endianness::big; 978 Config->IsMips64EL = (Kind == ELF64LEKind && Machine == EM_MIPS); 979 Config->Pic = Config->Pie || Config->Shared; 980 Config->Wordsize = Config->Is64 ? 8 : 4; 981 982 // There is an ILP32 ABI for x86-64, although it's not very popular. 983 // It is called the x32 ABI. 984 bool IsX32 = (Kind == ELF32LEKind && Machine == EM_X86_64); 985 986 // ELF defines two different ways to store relocation addends as shown below: 987 // 988 // Rel: Addends are stored to the location where relocations are applied. 989 // Rela: Addends are stored as part of relocation entry. 990 // 991 // In other words, Rela makes it easy to read addends at the price of extra 992 // 4 or 8 byte for each relocation entry. We don't know why ELF defined two 993 // different mechanisms in the first place, but this is how the spec is 994 // defined. 995 // 996 // You cannot choose which one, Rel or Rela, you want to use. Instead each 997 // ABI defines which one you need to use. The following expression expresses 998 // that. 999 Config->IsRela = 1000 (Config->Is64 || IsX32 || Machine == EM_PPC) && Machine != EM_MIPS; 1001 1002 // If the output uses REL relocations we must store the dynamic relocation 1003 // addends to the output sections. We also store addends for RELA relocations 1004 // if --apply-dynamic-relocs is used. 1005 // We default to not writing the addends when using RELA relocations since 1006 // any standard conforming tool can find it in r_addend. 1007 Config->WriteAddends = Args.hasFlag(OPT_apply_dynamic_relocs, 1008 OPT_no_apply_dynamic_relocs, false) || 1009 !Config->IsRela; 1010 } 1011 1012 // Returns a value of "-format" option. 1013 static bool getBinaryOption(StringRef S) { 1014 if (S == "binary") 1015 return true; 1016 if (S == "elf" || S == "default") 1017 return false; 1018 error("unknown -format value: " + S + 1019 " (supported formats: elf, default, binary)"); 1020 return false; 1021 } 1022 1023 void LinkerDriver::createFiles(opt::InputArgList &Args) { 1024 // For --{push,pop}-state. 1025 std::vector<std::tuple<bool, bool, bool>> Stack; 1026 1027 // Iterate over argv to process input files and positional arguments. 1028 for (auto *Arg : Args) { 1029 switch (Arg->getOption().getUnaliasedOption().getID()) { 1030 case OPT_library: 1031 addLibrary(Arg->getValue()); 1032 break; 1033 case OPT_INPUT: 1034 addFile(Arg->getValue(), /*WithLOption=*/false); 1035 break; 1036 case OPT_defsym: { 1037 StringRef From; 1038 StringRef To; 1039 std::tie(From, To) = StringRef(Arg->getValue()).split('='); 1040 readDefsym(From, MemoryBufferRef(To, "-defsym")); 1041 break; 1042 } 1043 case OPT_script: 1044 if (Optional<std::string> Path = searchScript(Arg->getValue())) { 1045 if (Optional<MemoryBufferRef> MB = readFile(*Path)) 1046 readLinkerScript(*MB); 1047 break; 1048 } 1049 error(Twine("cannot find linker script ") + Arg->getValue()); 1050 break; 1051 case OPT_as_needed: 1052 Config->AsNeeded = true; 1053 break; 1054 case OPT_format: 1055 InBinary = getBinaryOption(Arg->getValue()); 1056 break; 1057 case OPT_no_as_needed: 1058 Config->AsNeeded = false; 1059 break; 1060 case OPT_Bstatic: 1061 Config->Static = true; 1062 break; 1063 case OPT_Bdynamic: 1064 Config->Static = false; 1065 break; 1066 case OPT_whole_archive: 1067 InWholeArchive = true; 1068 break; 1069 case OPT_no_whole_archive: 1070 InWholeArchive = false; 1071 break; 1072 case OPT_just_symbols: 1073 if (Optional<MemoryBufferRef> MB = readFile(Arg->getValue())) { 1074 Files.push_back(createObjectFile(*MB)); 1075 Files.back()->JustSymbols = true; 1076 } 1077 break; 1078 case OPT_start_group: 1079 if (InputFile::IsInGroup) 1080 error("nested --start-group"); 1081 InputFile::IsInGroup = true; 1082 break; 1083 case OPT_end_group: 1084 if (!InputFile::IsInGroup) 1085 error("stray --end-group"); 1086 InputFile::IsInGroup = false; 1087 ++InputFile::NextGroupId; 1088 break; 1089 case OPT_start_lib: 1090 if (InLib) 1091 error("nested --start-lib"); 1092 if (InputFile::IsInGroup) 1093 error("may not nest --start-lib in --start-group"); 1094 InLib = true; 1095 InputFile::IsInGroup = true; 1096 break; 1097 case OPT_end_lib: 1098 if (!InLib) 1099 error("stray --end-lib"); 1100 InLib = false; 1101 InputFile::IsInGroup = false; 1102 ++InputFile::NextGroupId; 1103 break; 1104 case OPT_push_state: 1105 Stack.emplace_back(Config->AsNeeded, Config->Static, InWholeArchive); 1106 break; 1107 case OPT_pop_state: 1108 if (Stack.empty()) { 1109 error("unbalanced --push-state/--pop-state"); 1110 break; 1111 } 1112 std::tie(Config->AsNeeded, Config->Static, InWholeArchive) = Stack.back(); 1113 Stack.pop_back(); 1114 break; 1115 } 1116 } 1117 1118 if (Files.empty() && errorCount() == 0) 1119 error("no input files"); 1120 } 1121 1122 // If -m <machine_type> was not given, infer it from object files. 1123 void LinkerDriver::inferMachineType() { 1124 if (Config->EKind != ELFNoneKind) 1125 return; 1126 1127 for (InputFile *F : Files) { 1128 if (F->EKind == ELFNoneKind) 1129 continue; 1130 Config->EKind = F->EKind; 1131 Config->EMachine = F->EMachine; 1132 Config->OSABI = F->OSABI; 1133 Config->MipsN32Abi = Config->EMachine == EM_MIPS && isMipsN32Abi(F); 1134 return; 1135 } 1136 error("target emulation unknown: -m or at least one .o file required"); 1137 } 1138 1139 // Parse -z max-page-size=<value>. The default value is defined by 1140 // each target. 1141 static uint64_t getMaxPageSize(opt::InputArgList &Args) { 1142 uint64_t Val = args::getZOptionValue(Args, OPT_z, "max-page-size", 1143 Target->DefaultMaxPageSize); 1144 if (!isPowerOf2_64(Val)) 1145 error("max-page-size: value isn't a power of 2"); 1146 return Val; 1147 } 1148 1149 // Parses -image-base option. 1150 static Optional<uint64_t> getImageBase(opt::InputArgList &Args) { 1151 // Because we are using "Config->MaxPageSize" here, this function has to be 1152 // called after the variable is initialized. 1153 auto *Arg = Args.getLastArg(OPT_image_base); 1154 if (!Arg) 1155 return None; 1156 1157 StringRef S = Arg->getValue(); 1158 uint64_t V; 1159 if (!to_integer(S, V)) { 1160 error("-image-base: number expected, but got " + S); 1161 return 0; 1162 } 1163 if ((V % Config->MaxPageSize) != 0) 1164 warn("-image-base: address isn't multiple of page size: " + S); 1165 return V; 1166 } 1167 1168 // Parses `--exclude-libs=lib,lib,...`. 1169 // The library names may be delimited by commas or colons. 1170 static DenseSet<StringRef> getExcludeLibs(opt::InputArgList &Args) { 1171 DenseSet<StringRef> Ret; 1172 for (auto *Arg : Args.filtered(OPT_exclude_libs)) { 1173 StringRef S = Arg->getValue(); 1174 for (;;) { 1175 size_t Pos = S.find_first_of(",:"); 1176 if (Pos == StringRef::npos) 1177 break; 1178 Ret.insert(S.substr(0, Pos)); 1179 S = S.substr(Pos + 1); 1180 } 1181 Ret.insert(S); 1182 } 1183 return Ret; 1184 } 1185 1186 // Handles the -exclude-libs option. If a static library file is specified 1187 // by the -exclude-libs option, all public symbols from the archive become 1188 // private unless otherwise specified by version scripts or something. 1189 // A special library name "ALL" means all archive files. 1190 // 1191 // This is not a popular option, but some programs such as bionic libc use it. 1192 template <class ELFT> 1193 static void excludeLibs(opt::InputArgList &Args) { 1194 DenseSet<StringRef> Libs = getExcludeLibs(Args); 1195 bool All = Libs.count("ALL"); 1196 1197 auto Visit = [&](InputFile *File) { 1198 if (!File->ArchiveName.empty()) 1199 if (All || Libs.count(path::filename(File->ArchiveName))) 1200 for (Symbol *Sym : File->getSymbols()) 1201 if (!Sym->isLocal() && Sym->File == File) 1202 Sym->VersionId = VER_NDX_LOCAL; 1203 }; 1204 1205 for (InputFile *File : ObjectFiles) 1206 Visit(File); 1207 1208 for (BitcodeFile *File : BitcodeFiles) 1209 Visit(File); 1210 } 1211 1212 // Force Sym to be entered in the output. Used for -u or equivalent. 1213 template <class ELFT> static void handleUndefined(StringRef Name) { 1214 Symbol *Sym = Symtab->find(Name); 1215 if (!Sym) 1216 return; 1217 1218 // Since symbol S may not be used inside the program, LTO may 1219 // eliminate it. Mark the symbol as "used" to prevent it. 1220 Sym->IsUsedInRegularObj = true; 1221 1222 if (Sym->isLazy()) 1223 Symtab->fetchLazy<ELFT>(Sym); 1224 } 1225 1226 template <class ELFT> static bool shouldDemote(Symbol &Sym) { 1227 // If all references to a DSO happen to be weak, the DSO is not added to 1228 // DT_NEEDED. If that happens, we need to eliminate shared symbols created 1229 // from the DSO. Otherwise, they become dangling references that point to a 1230 // non-existent DSO. 1231 if (auto *S = dyn_cast<SharedSymbol>(&Sym)) 1232 return !S->getFile<ELFT>().IsNeeded; 1233 1234 // We are done processing archives, so lazy symbols that were used but not 1235 // found can be converted to undefined. We could also just delete the other 1236 // lazy symbols, but that seems to be more work than it is worth. 1237 return Sym.isLazy() && Sym.IsUsedInRegularObj; 1238 } 1239 1240 // Some files, such as .so or files between -{start,end}-lib may be removed 1241 // after their symbols are added to the symbol table. If that happens, we 1242 // need to remove symbols that refer files that no longer exist, so that 1243 // they won't appear in the symbol table of the output file. 1244 // 1245 // We remove symbols by demoting them to undefined symbol. 1246 template <class ELFT> static void demoteSymbols() { 1247 for (Symbol *Sym : Symtab->getSymbols()) { 1248 if (shouldDemote<ELFT>(*Sym)) { 1249 bool Used = Sym->Used; 1250 replaceSymbol<Undefined>(Sym, nullptr, Sym->getName(), Sym->Binding, 1251 Sym->StOther, Sym->Type); 1252 Sym->Used = Used; 1253 } 1254 } 1255 } 1256 1257 // The section referred to by S is considered address-significant. Set the 1258 // KeepUnique flag on the section if appropriate. 1259 static void markAddrsig(Symbol *S) { 1260 if (auto *D = dyn_cast_or_null<Defined>(S)) 1261 if (D->Section) 1262 // We don't need to keep text sections unique under --icf=all even if they 1263 // are address-significant. 1264 if (Config->ICF == ICFLevel::Safe || !(D->Section->Flags & SHF_EXECINSTR)) 1265 D->Section->KeepUnique = true; 1266 } 1267 1268 // Record sections that define symbols mentioned in --keep-unique <symbol> 1269 // and symbols referred to by address-significance tables. These sections are 1270 // ineligible for ICF. 1271 template <class ELFT> 1272 static void findKeepUniqueSections(opt::InputArgList &Args) { 1273 for (auto *Arg : Args.filtered(OPT_keep_unique)) { 1274 StringRef Name = Arg->getValue(); 1275 auto *D = dyn_cast_or_null<Defined>(Symtab->find(Name)); 1276 if (!D || !D->Section) { 1277 warn("could not find symbol " + Name + " to keep unique"); 1278 continue; 1279 } 1280 D->Section->KeepUnique = true; 1281 } 1282 1283 // --icf=all --ignore-data-address-equality means that we can ignore 1284 // the dynsym and address-significance tables entirely. 1285 if (Config->ICF == ICFLevel::All && Config->IgnoreDataAddressEquality) 1286 return; 1287 1288 // Symbols in the dynsym could be address-significant in other executables 1289 // or DSOs, so we conservatively mark them as address-significant. 1290 for (Symbol *S : Symtab->getSymbols()) 1291 if (S->includeInDynsym()) 1292 markAddrsig(S); 1293 1294 // Visit the address-significance table in each object file and mark each 1295 // referenced symbol as address-significant. 1296 for (InputFile *F : ObjectFiles) { 1297 auto *Obj = cast<ObjFile<ELFT>>(F); 1298 ArrayRef<Symbol *> Syms = Obj->getSymbols(); 1299 if (Obj->AddrsigSec) { 1300 ArrayRef<uint8_t> Contents = 1301 check(Obj->getObj().getSectionContents(Obj->AddrsigSec)); 1302 const uint8_t *Cur = Contents.begin(); 1303 while (Cur != Contents.end()) { 1304 unsigned Size; 1305 const char *Err; 1306 uint64_t SymIndex = decodeULEB128(Cur, &Size, Contents.end(), &Err); 1307 if (Err) 1308 fatal(toString(F) + ": could not decode addrsig section: " + Err); 1309 markAddrsig(Syms[SymIndex]); 1310 Cur += Size; 1311 } 1312 } else { 1313 // If an object file does not have an address-significance table, 1314 // conservatively mark all of its symbols as address-significant. 1315 for (Symbol *S : Syms) 1316 markAddrsig(S); 1317 } 1318 } 1319 } 1320 1321 static const char *LibcallRoutineNames[] = { 1322 #define HANDLE_LIBCALL(code, name) name, 1323 #include "llvm/IR/RuntimeLibcalls.def" 1324 #undef HANDLE_LIBCALL 1325 }; 1326 1327 // Do actual linking. Note that when this function is called, 1328 // all linker scripts have already been parsed. 1329 template <class ELFT> void LinkerDriver::link(opt::InputArgList &Args) { 1330 Target = getTarget(); 1331 1332 Config->MaxPageSize = getMaxPageSize(Args); 1333 Config->ImageBase = getImageBase(Args); 1334 1335 // If a -hash-style option was not given, set to a default value, 1336 // which varies depending on the target. 1337 if (!Args.hasArg(OPT_hash_style)) { 1338 if (Config->EMachine == EM_MIPS) 1339 Config->SysvHash = true; 1340 else 1341 Config->SysvHash = Config->GnuHash = true; 1342 } 1343 1344 // Default output filename is "a.out" by the Unix tradition. 1345 if (Config->OutputFile.empty()) 1346 Config->OutputFile = "a.out"; 1347 1348 // Fail early if the output file or map file is not writable. If a user has a 1349 // long link, e.g. due to a large LTO link, they do not wish to run it and 1350 // find that it failed because there was a mistake in their command-line. 1351 if (auto E = tryCreateFile(Config->OutputFile)) 1352 error("cannot open output file " + Config->OutputFile + ": " + E.message()); 1353 if (auto E = tryCreateFile(Config->MapFile)) 1354 error("cannot open map file " + Config->MapFile + ": " + E.message()); 1355 if (errorCount()) 1356 return; 1357 1358 // Use default entry point name if no name was given via the command 1359 // line nor linker scripts. For some reason, MIPS entry point name is 1360 // different from others. 1361 Config->WarnMissingEntry = 1362 (!Config->Entry.empty() || (!Config->Shared && !Config->Relocatable)); 1363 if (Config->Entry.empty() && !Config->Relocatable) 1364 Config->Entry = (Config->EMachine == EM_MIPS) ? "__start" : "_start"; 1365 1366 // Handle --trace-symbol. 1367 for (auto *Arg : Args.filtered(OPT_trace_symbol)) 1368 Symtab->trace(Arg->getValue()); 1369 1370 // Add all files to the symbol table. This will add almost all 1371 // symbols that we need to the symbol table. 1372 for (InputFile *F : Files) 1373 Symtab->addFile<ELFT>(F); 1374 1375 // Now that we have every file, we can decide if we will need a 1376 // dynamic symbol table. 1377 // We need one if we were asked to export dynamic symbols or if we are 1378 // producing a shared library. 1379 // We also need one if any shared libraries are used and for pie executables 1380 // (probably because the dynamic linker needs it). 1381 Config->HasDynSymTab = 1382 !SharedFiles.empty() || Config->Pic || Config->ExportDynamic; 1383 1384 // Some symbols (such as __ehdr_start) are defined lazily only when there 1385 // are undefined symbols for them, so we add these to trigger that logic. 1386 for (StringRef Sym : Script->ReferencedSymbols) 1387 Symtab->addUndefined<ELFT>(Sym); 1388 1389 // Handle the `--undefined <sym>` options. 1390 for (StringRef S : Config->Undefined) 1391 handleUndefined<ELFT>(S); 1392 1393 // If an entry symbol is in a static archive, pull out that file now. 1394 handleUndefined<ELFT>(Config->Entry); 1395 1396 // If any of our inputs are bitcode files, the LTO code generator may create 1397 // references to certain library functions that might not be explicit in the 1398 // bitcode file's symbol table. If any of those library functions are defined 1399 // in a bitcode file in an archive member, we need to arrange to use LTO to 1400 // compile those archive members by adding them to the link beforehand. 1401 // 1402 // With this the symbol table should be complete. After this, no new names 1403 // except a few linker-synthesized ones will be added to the symbol table. 1404 if (!BitcodeFiles.empty()) 1405 for (const char *S : LibcallRoutineNames) 1406 handleUndefined<ELFT>(S); 1407 1408 // Return if there were name resolution errors. 1409 if (errorCount()) 1410 return; 1411 1412 // Now when we read all script files, we want to finalize order of linker 1413 // script commands, which can be not yet final because of INSERT commands. 1414 Script->processInsertCommands(); 1415 1416 // We want to declare linker script's symbols early, 1417 // so that we can version them. 1418 // They also might be exported if referenced by DSOs. 1419 Script->declareSymbols(); 1420 1421 // Handle the -exclude-libs option. 1422 if (Args.hasArg(OPT_exclude_libs)) 1423 excludeLibs<ELFT>(Args); 1424 1425 // Create ElfHeader early. We need a dummy section in 1426 // addReservedSymbols to mark the created symbols as not absolute. 1427 Out::ElfHeader = make<OutputSection>("", 0, SHF_ALLOC); 1428 Out::ElfHeader->Size = sizeof(typename ELFT::Ehdr); 1429 1430 // We need to create some reserved symbols such as _end. Create them. 1431 if (!Config->Relocatable) 1432 addReservedSymbols(); 1433 1434 // Apply version scripts. 1435 // 1436 // For a relocatable output, version scripts don't make sense, and 1437 // parsing a symbol version string (e.g. dropping "@ver1" from a symbol 1438 // name "foo@ver1") rather do harm, so we don't call this if -r is given. 1439 if (!Config->Relocatable) 1440 Symtab->scanVersionScript(); 1441 1442 // Create wrapped symbols for -wrap option. 1443 for (auto *Arg : Args.filtered(OPT_wrap)) 1444 Symtab->addSymbolWrap<ELFT>(Arg->getValue()); 1445 1446 // Do link-time optimization if given files are LLVM bitcode files. 1447 // This compiles bitcode files into real object files. 1448 Symtab->addCombinedLTOObject<ELFT>(); 1449 if (errorCount()) 1450 return; 1451 1452 // If -thinlto-index-only is given, we should create only "index 1453 // files" and not object files. Index file creation is already done 1454 // in addCombinedLTOObject, so we are done if that's the case. 1455 if (Config->ThinLTOIndexOnly) 1456 return; 1457 1458 // Apply symbol renames for -wrap. 1459 Symtab->applySymbolWrap(); 1460 1461 // Now that we have a complete list of input files. 1462 // Beyond this point, no new files are added. 1463 // Aggregate all input sections into one place. 1464 for (InputFile *F : ObjectFiles) 1465 for (InputSectionBase *S : F->getSections()) 1466 if (S && S != &InputSection::Discarded) 1467 InputSections.push_back(S); 1468 for (BinaryFile *F : BinaryFiles) 1469 for (InputSectionBase *S : F->getSections()) 1470 InputSections.push_back(cast<InputSection>(S)); 1471 1472 // We do not want to emit debug sections if --strip-all 1473 // or -strip-debug are given. 1474 if (Config->Strip != StripPolicy::None) 1475 llvm::erase_if(InputSections, [](InputSectionBase *S) { 1476 return S->Name.startswith(".debug") || S->Name.startswith(".zdebug"); 1477 }); 1478 1479 Config->EFlags = Target->calcEFlags(); 1480 1481 if (Config->EMachine == EM_ARM) { 1482 // FIXME: These warnings can be removed when lld only uses these features 1483 // when the input objects have been compiled with an architecture that 1484 // supports them. 1485 if (Config->ARMHasBlx == false) 1486 warn("lld uses blx instruction, no object with architecture supporting " 1487 "feature detected."); 1488 if (Config->ARMJ1J2BranchEncoding == false) 1489 warn("lld uses extended branch encoding, no object with architecture " 1490 "supporting feature detected."); 1491 if (Config->ARMHasMovtMovw == false) 1492 warn("lld may use movt/movw, no object with architecture supporting " 1493 "feature detected."); 1494 } 1495 1496 // This adds a .comment section containing a version string. We have to add it 1497 // before decompressAndMergeSections because the .comment section is a 1498 // mergeable section. 1499 if (!Config->Relocatable) 1500 InputSections.push_back(createCommentSection()); 1501 1502 // Do size optimizations: garbage collection, merging of SHF_MERGE sections 1503 // and identical code folding. 1504 decompressSections(); 1505 splitSections<ELFT>(); 1506 markLive<ELFT>(); 1507 demoteSymbols<ELFT>(); 1508 mergeSections(); 1509 if (Config->ICF != ICFLevel::None) { 1510 findKeepUniqueSections<ELFT>(Args); 1511 doIcf<ELFT>(); 1512 } 1513 1514 // Read the callgraph now that we know what was gced or icfed 1515 if (auto *Arg = Args.getLastArg(OPT_call_graph_ordering_file)) 1516 if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue())) 1517 readCallGraph(*Buffer); 1518 1519 // Write the result to the file. 1520 writeResult<ELFT>(); 1521 } 1522