contrib/llvm/tools/lld/ELF/Driver.cpp

   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 "Error.h"
  29 #include "Filesystem.h"
  30 #include "ICF.h"
  31 #include "InputFiles.h"
  32 #include "InputSection.h"
  33 #include "LinkerScript.h"
  34 #include "Memory.h"
  35 #include "OutputSections.h"
  36 #include "ScriptParser.h"
  37 #include "Strings.h"
  38 #include "SymbolTable.h"
  39 #include "SyntheticSections.h"
  40 #include "Target.h"
  41 #include "Threads.h"
  42 #include "Writer.h"
  43 #include "lld/Config/Version.h"
  44 #include "lld/Driver/Driver.h"
  45 #include "llvm/ADT/StringExtras.h"
  46 #include "llvm/ADT/StringSwitch.h"
  47 #include "llvm/Support/CommandLine.h"
  48 #include "llvm/Support/Compression.h"
  49 #include "llvm/Support/Path.h"
  50 #include "llvm/Support/TarWriter.h"
  51 #include "llvm/Support/TargetSelect.h"
  52 #include "llvm/Support/raw_ostream.h"
  53 #include <cstdlib>
  54 #include <utility>
  55
  56 using namespace llvm;
  57 using namespace llvm::ELF;
  58 using namespace llvm::object;
  59 using namespace llvm::sys;
  60
  61 using namespace lld;
  62 using namespace lld::elf;
  63
  64 Configuration *elf::Config;
  65 LinkerDriver *elf::Driver;
  66
  67 BumpPtrAllocator elf::BAlloc;
  68 StringSaver elf::Saver{BAlloc};
  69 std::vector<SpecificAllocBase *> elf::SpecificAllocBase::Instances;
  70
  71 static void setConfigs();
  72
  73 bool elf::link(ArrayRef<const char *> Args, bool CanExitEarly,
  74                raw_ostream &Error) {
  75   ErrorCount = 0;
  76   ErrorOS = &Error;
  77   InputSections.clear();
  78   Tar = nullptr;
  79
  80   Config = make<Configuration>();
  81   Driver = make<LinkerDriver>();
  82   Script = make<LinkerScript>();
  83   Config->Argv = {Args.begin(), Args.end()};
  84
  85   Driver->main(Args, CanExitEarly);
  86   freeArena();
  87   return !ErrorCount;
  88 }
  89
  90 // Parses a linker -m option.
  91 static std::tuple<ELFKind, uint16_t, uint8_t> parseEmulation(StringRef Emul) {
  92   uint8_t OSABI = 0;
  93   StringRef S = Emul;
  94   if (S.endswith("_fbsd")) {
  95     S = S.drop_back(5);
  96     OSABI = ELFOSABI_FREEBSD;
  97   }
  98
  99   std::pair<ELFKind, uint16_t> Ret =
 100       StringSwitch<std::pair<ELFKind, uint16_t>>(S)
 101           .Cases("aarch64elf", "aarch64linux", {ELF64LEKind, EM_AARCH64})
 102           .Cases("armelf", "armelf_linux_eabi", {ELF32LEKind, EM_ARM})
 103           .Case("elf32_x86_64", {ELF32LEKind, EM_X86_64})
 104           .Cases("elf32btsmip", "elf32btsmipn32", {ELF32BEKind, EM_MIPS})
 105           .Cases("elf32ltsmip", "elf32ltsmipn32", {ELF32LEKind, EM_MIPS})
 106           .Case("elf32ppc", {ELF32BEKind, EM_PPC})
 107           .Case("elf64btsmip", {ELF64BEKind, EM_MIPS})
 108           .Case("elf64ltsmip", {ELF64LEKind, EM_MIPS})
 109           .Case("elf64ppc", {ELF64BEKind, EM_PPC64})
 110           .Cases("elf_amd64", "elf_x86_64", {ELF64LEKind, EM_X86_64})
 111           .Case("elf_i386", {ELF32LEKind, EM_386})
 112           .Case("elf_iamcu", {ELF32LEKind, EM_IAMCU})
 113           .Default({ELFNoneKind, EM_NONE});
 114
 115   if (Ret.first == ELFNoneKind) {
 116     if (S == "i386pe" || S == "i386pep" || S == "thumb2pe")
 117       error("Windows targets are not supported on the ELF frontend: " + Emul);
 118     else
 119       error("unknown emulation: " + Emul);
 120   }
 121   return std::make_tuple(Ret.first, Ret.second, OSABI);
 122 }
 123
 124 // Returns slices of MB by parsing MB as an archive file.
 125 // Each slice consists of a member file in the archive.
 126 std::vector<std::pair<MemoryBufferRef, uint64_t>> static getArchiveMembers(
 127     MemoryBufferRef MB) {
 128   std::unique_ptr<Archive> File =
 129       check(Archive::create(MB),
 130             MB.getBufferIdentifier() + ": failed to parse archive");
 131
 132   std::vector<std::pair<MemoryBufferRef, uint64_t>> V;
 133   Error Err = Error::success();
 134   for (const ErrorOr<Archive::Child> &COrErr : File->children(Err)) {
 135     Archive::Child C =
 136         check(COrErr, MB.getBufferIdentifier() +
 137                           ": could not get the child of the archive");
 138     MemoryBufferRef MBRef =
 139         check(C.getMemoryBufferRef(),
 140               MB.getBufferIdentifier() +
 141                   ": could not get the buffer for a child of the archive");
 142     V.push_back(std::make_pair(MBRef, C.getChildOffset()));
 143   }
 144   if (Err)
 145     fatal(MB.getBufferIdentifier() + ": Archive::children failed: " +
 146           toString(std::move(Err)));
 147
 148   // Take ownership of memory buffers created for members of thin archives.
 149   for (std::unique_ptr<MemoryBuffer> &MB : File->takeThinBuffers())
 150     make<std::unique_ptr<MemoryBuffer>>(std::move(MB));
 151
 152   return V;
 153 }
 154
 155 // Opens a file and create a file object. Path has to be resolved already.
 156 void LinkerDriver::addFile(StringRef Path, bool WithLOption) {
 157   using namespace sys::fs;
 158
 159   Optional<MemoryBufferRef> Buffer = readFile(Path);
 160   if (!Buffer.hasValue())
 161     return;
 162   MemoryBufferRef MBRef = *Buffer;
 163
 164   if (InBinary) {
 165     Files.push_back(make<BinaryFile>(MBRef));
 166     return;
 167   }
 168
 169   switch (identify_magic(MBRef.getBuffer())) {
 170   case file_magic::unknown:
 171     readLinkerScript(MBRef);
 172     return;
 173   case file_magic::archive: {
 174     // Handle -whole-archive.
 175     if (InWholeArchive) {
 176       for (const auto &P : getArchiveMembers(MBRef))
 177         Files.push_back(createObjectFile(P.first, Path, P.second));
 178       return;
 179     }
 180
 181     std::unique_ptr<Archive> File =
 182         check(Archive::create(MBRef), Path + ": failed to parse archive");
 183
 184     // If an archive file has no symbol table, it is likely that a user
 185     // is attempting LTO and using a default ar command that doesn't
 186     // understand the LLVM bitcode file. It is a pretty common error, so
 187     // we'll handle it as if it had a symbol table.
 188     if (!File->isEmpty() && !File->hasSymbolTable()) {
 189       for (const auto &P : getArchiveMembers(MBRef))
 190         Files.push_back(make<LazyObjectFile>(P.first, Path, P.second));
 191       return;
 192     }
 193
 194     // Handle the regular case.
 195     Files.push_back(make<ArchiveFile>(std::move(File)));
 196     return;
 197   }
 198   case file_magic::elf_shared_object:
 199     if (Config->Relocatable) {
 200       error("attempted static link of dynamic object " + Path);
 201       return;
 202     }
 203
 204     // DSOs usually have DT_SONAME tags in their ELF headers, and the
 205     // sonames are used to identify DSOs. But if they are missing,
 206     // they are identified by filenames. We don't know whether the new
 207     // file has a DT_SONAME or not because we haven't parsed it yet.
 208     // Here, we set the default soname for the file because we might
 209     // need it later.
 210     //
 211     // If a file was specified by -lfoo, the directory part is not
 212     // significant, as a user did not specify it. This behavior is
 213     // compatible with GNU.
 214     Files.push_back(
 215         createSharedFile(MBRef, WithLOption ? path::filename(Path) : Path));
 216     return;
 217   default:
 218     if (InLib)
 219       Files.push_back(make<LazyObjectFile>(MBRef, "", 0));
 220     else
 221       Files.push_back(createObjectFile(MBRef));
 222   }
 223 }
 224
 225 // Add a given library by searching it from input search paths.
 226 void LinkerDriver::addLibrary(StringRef Name) {
 227   if (Optional<std::string> Path = searchLibrary(Name))
 228     addFile(*Path, /*WithLOption=*/true);
 229   else
 230     error("unable to find library -l" + Name);
 231 }
 232
 233 // This function is called on startup. We need this for LTO since
 234 // LTO calls LLVM functions to compile bitcode files to native code.
 235 // Technically this can be delayed until we read bitcode files, but
 236 // we don't bother to do lazily because the initialization is fast.
 237 static void initLLVM(opt::InputArgList &Args) {
 238   InitializeAllTargets();
 239   InitializeAllTargetMCs();
 240   InitializeAllAsmPrinters();
 241   InitializeAllAsmParsers();
 242
 243   // Parse and evaluate -mllvm options.
 244   std::vector<const char *> V;
 245   V.push_back("lld (LLVM option parsing)");
 246   for (auto *Arg : Args.filtered(OPT_mllvm))
 247     V.push_back(Arg->getValue());
 248   cl::ParseCommandLineOptions(V.size(), V.data());
 249 }
 250
 251 // Some command line options or some combinations of them are not allowed.
 252 // This function checks for such errors.
 253 static void checkOptions(opt::InputArgList &Args) {
 254   // The MIPS ABI as of 2016 does not support the GNU-style symbol lookup
 255   // table which is a relatively new feature.
 256   if (Config->EMachine == EM_MIPS && Config->GnuHash)
 257     error("the .gnu.hash section is not compatible with the MIPS target.");
 258
 259   if (Config->Pie && Config->Shared)
 260     error("-shared and -pie may not be used together");
 261
 262   if (!Config->Shared && !Config->FilterList.empty())
 263     error("-F may not be used without -shared");
 264
 265   if (!Config->Shared && !Config->AuxiliaryList.empty())
 266     error("-f may not be used without -shared");
 267
 268   if (Config->Relocatable) {
 269     if (Config->Shared)
 270       error("-r and -shared may not be used together");
 271     if (Config->GcSections)
 272       error("-r and --gc-sections may not be used together");
 273     if (Config->ICF)
 274       error("-r and --icf may not be used together");
 275     if (Config->Pie)
 276       error("-r and -pie may not be used together");
 277   }
 278 }
 279
 280 static int getInteger(opt::InputArgList &Args, unsigned Key, int Default) {
 281   int V = Default;
 282   if (auto *Arg = Args.getLastArg(Key)) {
 283     StringRef S = Arg->getValue();
 284     if (!to_integer(S, V, 10))
 285       error(Arg->getSpelling() + ": number expected, but got " + S);
 286   }
 287   return V;
 288 }
 289
 290 static const char *getReproduceOption(opt::InputArgList &Args) {
 291   if (auto *Arg = Args.getLastArg(OPT_reproduce))
 292     return Arg->getValue();
 293   return getenv("LLD_REPRODUCE");
 294 }
 295
 296 static bool hasZOption(opt::InputArgList &Args, StringRef Key) {
 297   for (auto *Arg : Args.filtered(OPT_z))
 298     if (Key == Arg->getValue())
 299       return true;
 300   return false;
 301 }
 302
 303 static uint64_t getZOptionValue(opt::InputArgList &Args, StringRef Key,
 304                                 uint64_t Default) {
 305   for (auto *Arg : Args.filtered(OPT_z)) {
 306     std::pair<StringRef, StringRef> KV = StringRef(Arg->getValue()).split('=');
 307     if (KV.first == Key) {
 308       uint64_t Result = Default;
 309       if (!to_integer(KV.second, Result))
 310         error("invalid " + Key + ": " + KV.second);
 311       return Result;
 312     }
 313   }
 314   return Default;
 315 }
 316
 317 void LinkerDriver::main(ArrayRef<const char *> ArgsArr, bool CanExitEarly) {
 318   ELFOptTable Parser;
 319   opt::InputArgList Args = Parser.parse(ArgsArr.slice(1));
 320
 321   // Interpret this flag early because error() depends on them.
 322   Config->ErrorLimit = getInteger(Args, OPT_error_limit, 20);
 323
 324   // Handle -help
 325   if (Args.hasArg(OPT_help)) {
 326     printHelp(ArgsArr[0]);
 327     return;
 328   }
 329
 330   // Handle -v or -version.
 331   //
 332   // A note about "compatible with GNU linkers" message: this is a hack for
 333   // scripts generated by GNU Libtool 2.4.6 (released in February 2014 and
 334   // still the newest version in March 2017) or earlier to recognize LLD as
 335   // a GNU compatible linker. As long as an output for the -v option
 336   // contains "GNU" or "with BFD", they recognize us as GNU-compatible.
 337   //
 338   // This is somewhat ugly hack, but in reality, we had no choice other
 339   // than doing this. Considering the very long release cycle of Libtool,
 340   // it is not easy to improve it to recognize LLD as a GNU compatible
 341   // linker in a timely manner. Even if we can make it, there are still a
 342   // lot of "configure" scripts out there that are generated by old version
 343   // of Libtool. We cannot convince every software developer to migrate to
 344   // the latest version and re-generate scripts. So we have this hack.
 345   if (Args.hasArg(OPT_v) || Args.hasArg(OPT_version))
 346     message(getLLDVersion() + " (compatible with GNU linkers)");
 347
 348   // ld.bfd always exits after printing out the version string.
 349   // ld.gold proceeds if a given option is -v. Because gold's behavior
 350   // is more permissive than ld.bfd, we chose what gold does here.
 351   if (Args.hasArg(OPT_version))
 352     return;
 353
 354   Config->ExitEarly = CanExitEarly && !Args.hasArg(OPT_full_shutdown);
 355
 356   if (const char *Path = getReproduceOption(Args)) {
 357     // Note that --reproduce is a debug option so you can ignore it
 358     // if you are trying to understand the whole picture of the code.
 359     Expected<std::unique_ptr<TarWriter>> ErrOrWriter =
 360         TarWriter::create(Path, path::stem(Path));
 361     if (ErrOrWriter) {
 362       Tar = ErrOrWriter->get();
 363       Tar->append("response.txt", createResponseFile(Args));
 364       Tar->append("version.txt", getLLDVersion() + "\n");
 365       make<std::unique_ptr<TarWriter>>(std::move(*ErrOrWriter));
 366     } else {
 367       error(Twine("--reproduce: failed to open ") + Path + ": " +
 368             toString(ErrOrWriter.takeError()));
 369     }
 370   }
 371
 372   readConfigs(Args);
 373   initLLVM(Args);
 374   createFiles(Args);
 375   inferMachineType();
 376   setConfigs();
 377   checkOptions(Args);
 378   if (ErrorCount)
 379     return;
 380
 381   switch (Config->EKind) {
 382   case ELF32LEKind:
 383     link<ELF32LE>(Args);
 384     return;
 385   case ELF32BEKind:
 386     link<ELF32BE>(Args);
 387     return;
 388   case ELF64LEKind:
 389     link<ELF64LE>(Args);
 390     return;
 391   case ELF64BEKind:
 392     link<ELF64BE>(Args);
 393     return;
 394   default:
 395     llvm_unreachable("unknown Config->EKind");
 396   }
 397 }
 398
 399 static bool getArg(opt::InputArgList &Args, unsigned K1, unsigned K2,
 400                    bool Default) {
 401   if (auto *Arg = Args.getLastArg(K1, K2))
 402     return Arg->getOption().getID() == K1;
 403   return Default;
 404 }
 405
 406 static std::vector<StringRef> getArgs(opt::InputArgList &Args, int Id) {
 407   std::vector<StringRef> V;
 408   for (auto *Arg : Args.filtered(Id))
 409     V.push_back(Arg->getValue());
 410   return V;
 411 }
 412
 413 static std::string getRpath(opt::InputArgList &Args) {
 414   std::vector<StringRef> V = getArgs(Args, OPT_rpath);
 415   return llvm::join(V.begin(), V.end(), ":");
 416 }
 417
 418 // Determines what we should do if there are remaining unresolved
 419 // symbols after the name resolution.
 420 static UnresolvedPolicy getUnresolvedSymbolPolicy(opt::InputArgList &Args) {
 421   // -noinhibit-exec or -r imply some default values.
 422   if (Args.hasArg(OPT_noinhibit_exec))
 423     return UnresolvedPolicy::WarnAll;
 424   if (Args.hasArg(OPT_relocatable))
 425     return UnresolvedPolicy::IgnoreAll;
 426
 427   UnresolvedPolicy ErrorOrWarn = getArg(Args, OPT_error_unresolved_symbols,
 428                                         OPT_warn_unresolved_symbols, true)
 429                                      ? UnresolvedPolicy::ReportError
 430                                      : UnresolvedPolicy::Warn;
 431
 432   // Process the last of -unresolved-symbols, -no-undefined or -z defs.
 433   for (auto *Arg : llvm::reverse(Args)) {
 434     switch (Arg->getOption().getID()) {
 435     case OPT_unresolved_symbols: {
 436       StringRef S = Arg->getValue();
 437       if (S == "ignore-all" || S == "ignore-in-object-files")
 438         return UnresolvedPolicy::Ignore;
 439       if (S == "ignore-in-shared-libs" || S == "report-all")
 440         return ErrorOrWarn;
 441       error("unknown --unresolved-symbols value: " + S);
 442       continue;
 443     }
 444     case OPT_no_undefined:
 445       return ErrorOrWarn;
 446     case OPT_z:
 447       if (StringRef(Arg->getValue()) == "defs")
 448         return ErrorOrWarn;
 449       continue;
 450     }
 451   }
 452
 453   // -shared implies -unresolved-symbols=ignore-all because missing
 454   // symbols are likely to be resolved at runtime using other DSOs.
 455   if (Config->Shared)
 456     return UnresolvedPolicy::Ignore;
 457   return ErrorOrWarn;
 458 }
 459
 460 static Target2Policy getTarget2(opt::InputArgList &Args) {
 461   StringRef S = Args.getLastArgValue(OPT_target2, "got-rel");
 462   if (S == "rel")
 463     return Target2Policy::Rel;
 464   if (S == "abs")
 465     return Target2Policy::Abs;
 466   if (S == "got-rel")
 467     return Target2Policy::GotRel;
 468   error("unknown --target2 option: " + S);
 469   return Target2Policy::GotRel;
 470 }
 471
 472 static bool isOutputFormatBinary(opt::InputArgList &Args) {
 473   if (auto *Arg = Args.getLastArg(OPT_oformat)) {
 474     StringRef S = Arg->getValue();
 475     if (S == "binary")
 476       return true;
 477     error("unknown --oformat value: " + S);
 478   }
 479   return false;
 480 }
 481
 482 static DiscardPolicy getDiscard(opt::InputArgList &Args) {
 483   if (Args.hasArg(OPT_relocatable))
 484     return DiscardPolicy::None;
 485
 486   auto *Arg =
 487       Args.getLastArg(OPT_discard_all, OPT_discard_locals, OPT_discard_none);
 488   if (!Arg)
 489     return DiscardPolicy::Default;
 490   if (Arg->getOption().getID() == OPT_discard_all)
 491     return DiscardPolicy::All;
 492   if (Arg->getOption().getID() == OPT_discard_locals)
 493     return DiscardPolicy::Locals;
 494   return DiscardPolicy::None;
 495 }
 496
 497 static StringRef getDynamicLinker(opt::InputArgList &Args) {
 498   auto *Arg = Args.getLastArg(OPT_dynamic_linker, OPT_no_dynamic_linker);
 499   if (!Arg || Arg->getOption().getID() == OPT_no_dynamic_linker)
 500     return "";
 501   return Arg->getValue();
 502 }
 503
 504 static StripPolicy getStrip(opt::InputArgList &Args) {
 505   if (Args.hasArg(OPT_relocatable))
 506     return StripPolicy::None;
 507
 508   auto *Arg = Args.getLastArg(OPT_strip_all, OPT_strip_debug);
 509   if (!Arg)
 510     return StripPolicy::None;
 511   if (Arg->getOption().getID() == OPT_strip_all)
 512     return StripPolicy::All;
 513   return StripPolicy::Debug;
 514 }
 515
 516 static uint64_t parseSectionAddress(StringRef S, opt::Arg *Arg) {
 517   uint64_t VA = 0;
 518   if (S.startswith("0x"))
 519     S = S.drop_front(2);
 520   if (!to_integer(S, VA, 16))
 521     error("invalid argument: " + toString(Arg));
 522   return VA;
 523 }
 524
 525 static StringMap<uint64_t> getSectionStartMap(opt::InputArgList &Args) {
 526   StringMap<uint64_t> Ret;
 527   for (auto *Arg : Args.filtered(OPT_section_start)) {
 528     StringRef Name;
 529     StringRef Addr;
 530     std::tie(Name, Addr) = StringRef(Arg->getValue()).split('=');
 531     Ret[Name] = parseSectionAddress(Addr, Arg);
 532   }
 533
 534   if (auto *Arg = Args.getLastArg(OPT_Ttext))
 535     Ret[".text"] = parseSectionAddress(Arg->getValue(), Arg);
 536   if (auto *Arg = Args.getLastArg(OPT_Tdata))
 537     Ret[".data"] = parseSectionAddress(Arg->getValue(), Arg);
 538   if (auto *Arg = Args.getLastArg(OPT_Tbss))
 539     Ret[".bss"] = parseSectionAddress(Arg->getValue(), Arg);
 540   return Ret;
 541 }
 542
 543 static SortSectionPolicy getSortSection(opt::InputArgList &Args) {
 544   StringRef S = Args.getLastArgValue(OPT_sort_section);
 545   if (S == "alignment")
 546     return SortSectionPolicy::Alignment;
 547   if (S == "name")
 548     return SortSectionPolicy::Name;
 549   if (!S.empty())
 550     error("unknown --sort-section rule: " + S);
 551   return SortSectionPolicy::Default;
 552 }
 553
 554 static std::pair<bool, bool> getHashStyle(opt::InputArgList &Args) {
 555   StringRef S = Args.getLastArgValue(OPT_hash_style, "sysv");
 556   if (S == "sysv")
 557     return {true, false};
 558   if (S == "gnu")
 559     return {false, true};
 560   if (S != "both")
 561     error("unknown -hash-style: " + S);
 562   return {true, true};
 563 }
 564
 565 // Parse --build-id or --build-id=<style>. We handle "tree" as a
 566 // synonym for "sha1" because all our hash functions including
 567 // -build-id=sha1 are actually tree hashes for performance reasons.
 568 static std::pair<BuildIdKind, std::vector<uint8_t>>
 569 getBuildId(opt::InputArgList &Args) {
 570   auto *Arg = Args.getLastArg(OPT_build_id, OPT_build_id_eq);
 571   if (!Arg)
 572     return {BuildIdKind::None, {}};
 573
 574   if (Arg->getOption().getID() == OPT_build_id)
 575     return {BuildIdKind::Fast, {}};
 576
 577   StringRef S = Arg->getValue();
 578   if (S == "md5")
 579     return {BuildIdKind::Md5, {}};
 580   if (S == "sha1" || S == "tree")
 581     return {BuildIdKind::Sha1, {}};
 582   if (S == "uuid")
 583     return {BuildIdKind::Uuid, {}};
 584   if (S.startswith("0x"))
 585     return {BuildIdKind::Hexstring, parseHex(S.substr(2))};
 586
 587   if (S != "none")
 588     error("unknown --build-id style: " + S);
 589   return {BuildIdKind::None, {}};
 590 }
 591
 592 static std::vector<StringRef> getLines(MemoryBufferRef MB) {
 593   SmallVector<StringRef, 0> Arr;
 594   MB.getBuffer().split(Arr, '\n');
 595
 596   std::vector<StringRef> Ret;
 597   for (StringRef S : Arr) {
 598     S = S.trim();
 599     if (!S.empty())
 600       Ret.push_back(S);
 601   }
 602   return Ret;
 603 }
 604
 605 static bool getCompressDebugSections(opt::InputArgList &Args) {
 606   StringRef S = Args.getLastArgValue(OPT_compress_debug_sections, "none");
 607   if (S == "none")
 608     return false;
 609   if (S != "zlib")
 610     error("unknown --compress-debug-sections value: " + S);
 611   if (!zlib::isAvailable())
 612     error("--compress-debug-sections: zlib is not available");
 613   return true;
 614 }
 615
 616 // Initializes Config members by the command line options.
 617 void LinkerDriver::readConfigs(opt::InputArgList &Args) {
 618   Config->AllowMultipleDefinition =
 619       Args.hasArg(OPT_allow_multiple_definition) || hasZOption(Args, "muldefs");
 620   Config->AuxiliaryList = getArgs(Args, OPT_auxiliary);
 621   Config->Bsymbolic = Args.hasArg(OPT_Bsymbolic);
 622   Config->BsymbolicFunctions = Args.hasArg(OPT_Bsymbolic_functions);
 623   Config->CompressDebugSections = getCompressDebugSections(Args);
 624   Config->DefineCommon = getArg(Args, OPT_define_common, OPT_no_define_common,
 625                                 !Args.hasArg(OPT_relocatable));
 626   Config->Demangle = getArg(Args, OPT_demangle, OPT_no_demangle, true);
 627   Config->DisableVerify = Args.hasArg(OPT_disable_verify);
 628   Config->Discard = getDiscard(Args);
 629   Config->DynamicLinker = getDynamicLinker(Args);
 630   Config->EhFrameHdr = Args.hasArg(OPT_eh_frame_hdr);
 631   Config->EmitRelocs = Args.hasArg(OPT_emit_relocs);
 632   Config->EnableNewDtags = !Args.hasArg(OPT_disable_new_dtags);
 633   Config->Entry = Args.getLastArgValue(OPT_entry);
 634   Config->ExportDynamic =
 635       getArg(Args, OPT_export_dynamic, OPT_no_export_dynamic, false);
 636   Config->FatalWarnings =
 637       getArg(Args, OPT_fatal_warnings, OPT_no_fatal_warnings, false);
 638   Config->FilterList = getArgs(Args, OPT_filter);
 639   Config->Fini = Args.getLastArgValue(OPT_fini, "_fini");
 640   Config->GcSections = getArg(Args, OPT_gc_sections, OPT_no_gc_sections, false);
 641   Config->GdbIndex = Args.hasArg(OPT_gdb_index);
 642   Config->ICF = getArg(Args, OPT_icf_all, OPT_icf_none, false);
 643   Config->Init = Args.getLastArgValue(OPT_init, "_init");
 644   Config->LTOAAPipeline = Args.getLastArgValue(OPT_lto_aa_pipeline);
 645   Config->LTONewPmPasses = Args.getLastArgValue(OPT_lto_newpm_passes);
 646   Config->LTOO = getInteger(Args, OPT_lto_O, 2);
 647   Config->LTOPartitions = getInteger(Args, OPT_lto_partitions, 1);
 648   Config->MapFile = Args.getLastArgValue(OPT_Map);
 649   Config->NoGnuUnique = Args.hasArg(OPT_no_gnu_unique);
 650   Config->NoUndefinedVersion = Args.hasArg(OPT_no_undefined_version);
 651   Config->Nostdlib = Args.hasArg(OPT_nostdlib);
 652   Config->OFormatBinary = isOutputFormatBinary(Args);
 653   Config->Omagic = Args.hasArg(OPT_omagic);
 654   Config->OptRemarksFilename = Args.getLastArgValue(OPT_opt_remarks_filename);
 655   Config->OptRemarksWithHotness = Args.hasArg(OPT_opt_remarks_with_hotness);
 656   Config->Optimize = getInteger(Args, OPT_O, 1);
 657   Config->OutputFile = Args.getLastArgValue(OPT_o);
 658   Config->Pie = getArg(Args, OPT_pie, OPT_nopie, false);
 659   Config->PrintGcSections = Args.hasArg(OPT_print_gc_sections);
 660   Config->Rpath = getRpath(Args);
 661   Config->Relocatable = Args.hasArg(OPT_relocatable);
 662   Config->SaveTemps = Args.hasArg(OPT_save_temps);
 663   Config->SearchPaths = getArgs(Args, OPT_L);
 664   Config->SectionStartMap = getSectionStartMap(Args);
 665   Config->Shared = Args.hasArg(OPT_shared);
 666   Config->SingleRoRx = Args.hasArg(OPT_no_rosegment);
 667   Config->SoName = Args.getLastArgValue(OPT_soname);
 668   Config->SortSection = getSortSection(Args);
 669   Config->Strip = getStrip(Args);
 670   Config->Sysroot = Args.getLastArgValue(OPT_sysroot);
 671   Config->Target1Rel = getArg(Args, OPT_target1_rel, OPT_target1_abs, false);
 672   Config->Target2 = getTarget2(Args);
 673   Config->ThinLTOCacheDir = Args.getLastArgValue(OPT_thinlto_cache_dir);
 674   Config->ThinLTOCachePolicy = check(
 675       parseCachePruningPolicy(Args.getLastArgValue(OPT_thinlto_cache_policy)),
 676       "--thinlto-cache-policy: invalid cache policy");
 677   Config->ThinLTOJobs = getInteger(Args, OPT_thinlto_jobs, -1u);
 678   Config->Threads = getArg(Args, OPT_threads, OPT_no_threads, true);
 679   Config->Trace = Args.hasArg(OPT_trace);
 680   Config->Undefined = getArgs(Args, OPT_undefined);
 681   Config->UnresolvedSymbols = getUnresolvedSymbolPolicy(Args);
 682   Config->Verbose = Args.hasArg(OPT_verbose);
 683   Config->WarnCommon = Args.hasArg(OPT_warn_common);
 684   Config->ZCombreloc = !hasZOption(Args, "nocombreloc");
 685   Config->ZExecstack = hasZOption(Args, "execstack");
 686   Config->ZNocopyreloc = hasZOption(Args, "nocopyreloc");
 687   Config->ZNodelete = hasZOption(Args, "nodelete");
 688   Config->ZNodlopen = hasZOption(Args, "nodlopen");
 689   Config->ZNow = hasZOption(Args, "now");
 690   Config->ZOrigin = hasZOption(Args, "origin");
 691   Config->ZRelro = !hasZOption(Args, "norelro");
 692   Config->ZRodynamic = hasZOption(Args, "rodynamic");
 693   Config->ZStackSize = getZOptionValue(Args, "stack-size", 0);
 694   Config->ZText = !hasZOption(Args, "notext");
 695   Config->ZWxneeded = hasZOption(Args, "wxneeded");
 696
 697   if (Config->LTOO > 3)
 698     error("invalid optimization level for LTO: " +
 699           Args.getLastArgValue(OPT_lto_O));
 700   if (Config->LTOPartitions == 0)
 701     error("--lto-partitions: number of threads must be > 0");
 702   if (Config->ThinLTOJobs == 0)
 703     error("--thinlto-jobs: number of threads must be > 0");
 704
 705   if (auto *Arg = Args.getLastArg(OPT_m)) {
 706     // Parse ELF{32,64}{LE,BE} and CPU type.
 707     StringRef S = Arg->getValue();
 708     std::tie(Config->EKind, Config->EMachine, Config->OSABI) =
 709         parseEmulation(S);
 710     Config->MipsN32Abi = (S == "elf32btsmipn32" || S == "elf32ltsmipn32");
 711     Config->Emulation = S;
 712   }
 713
 714   if (Args.hasArg(OPT_print_map))
 715     Config->MapFile = "-";
 716
 717   // --omagic is an option to create old-fashioned executables in which
 718   // .text segments are writable. Today, the option is still in use to
 719   // create special-purpose programs such as boot loaders. It doesn't
 720   // make sense to create PT_GNU_RELRO for such executables.
 721   if (Config->Omagic)
 722     Config->ZRelro = false;
 723
 724   std::tie(Config->SysvHash, Config->GnuHash) = getHashStyle(Args);
 725   std::tie(Config->BuildId, Config->BuildIdVector) = getBuildId(Args);
 726
 727   if (auto *Arg = Args.getLastArg(OPT_symbol_ordering_file))
 728     if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue()))
 729       Config->SymbolOrderingFile = getLines(*Buffer);
 730
 731   // If --retain-symbol-file is used, we'll keep only the symbols listed in
 732   // the file and discard all others.
 733   if (auto *Arg = Args.getLastArg(OPT_retain_symbols_file)) {
 734     Config->DefaultSymbolVersion = VER_NDX_LOCAL;
 735     if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue()))
 736       for (StringRef S : getLines(*Buffer))
 737         Config->VersionScriptGlobals.push_back(
 738             {S, /*IsExternCpp*/ false, /*HasWildcard*/ false});
 739   }
 740
 741   bool HasExportDynamic =
 742       getArg(Args, OPT_export_dynamic, OPT_no_export_dynamic, false);
 743
 744   // Parses -dynamic-list and -export-dynamic-symbol. They make some
 745   // symbols private. Note that -export-dynamic takes precedence over them
 746   // as it says all symbols should be exported.
 747   if (!HasExportDynamic) {
 748     for (auto *Arg : Args.filtered(OPT_dynamic_list))
 749       if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue()))
 750         readDynamicList(*Buffer);
 751
 752     for (auto *Arg : Args.filtered(OPT_export_dynamic_symbol))
 753       Config->VersionScriptGlobals.push_back(
 754           {Arg->getValue(), /*IsExternCpp*/ false, /*HasWildcard*/ false});
 755
 756     // Dynamic lists are a simplified linker script that doesn't need the
 757     // "global:" and implicitly ends with a "local:*". Set the variables
 758     // needed to simulate that.
 759     if (Args.hasArg(OPT_dynamic_list) ||
 760         Args.hasArg(OPT_export_dynamic_symbol)) {
 761       Config->ExportDynamic = true;
 762       if (!Config->Shared)
 763         Config->DefaultSymbolVersion = VER_NDX_LOCAL;
 764     }
 765   }
 766
 767   if (auto *Arg = Args.getLastArg(OPT_version_script))
 768     if (Optional<MemoryBufferRef> Buffer = readFile(Arg->getValue()))
 769       readVersionScript(*Buffer);
 770 }
 771
 772 // Some Config members do not directly correspond to any particular
 773 // command line options, but computed based on other Config values.
 774 // This function initialize such members. See Config.h for the details
 775 // of these values.
 776 static void setConfigs() {
 777   ELFKind Kind = Config->EKind;
 778   uint16_t Machine = Config->EMachine;
 779
 780   // There is an ILP32 ABI for x86-64, although it's not very popular.
 781   // It is called the x32 ABI.
 782   bool IsX32 = (Kind == ELF32LEKind && Machine == EM_X86_64);
 783
 784   Config->CopyRelocs = (Config->Relocatable || Config->EmitRelocs);
 785   Config->Is64 = (Kind == ELF64LEKind || Kind == ELF64BEKind);
 786   Config->IsLE = (Kind == ELF32LEKind || Kind == ELF64LEKind);
 787   Config->Endianness =
 788       Config->IsLE ? support::endianness::little : support::endianness::big;
 789   Config->IsMips64EL = (Kind == ELF64LEKind && Machine == EM_MIPS);
 790   Config->IsRela = Config->Is64 || IsX32 || Config->MipsN32Abi;
 791   Config->Pic = Config->Pie || Config->Shared;
 792   Config->Wordsize = Config->Is64 ? 8 : 4;
 793 }
 794
 795 // Returns a value of "-format" option.
 796 static bool getBinaryOption(StringRef S) {
 797   if (S == "binary")
 798     return true;
 799   if (S == "elf" || S == "default")
 800     return false;
 801   error("unknown -format value: " + S +
 802         " (supported formats: elf, default, binary)");
 803   return false;
 804 }
 805
 806 void LinkerDriver::createFiles(opt::InputArgList &Args) {
 807   for (auto *Arg : Args) {
 808     switch (Arg->getOption().getID()) {
 809     case OPT_l:
 810       addLibrary(Arg->getValue());
 811       break;
 812     case OPT_INPUT:
 813       addFile(Arg->getValue(), /*WithLOption=*/false);
 814       break;
 815     case OPT_alias_script_T:
 816     case OPT_script:
 817       if (Optional<MemoryBufferRef> MB = readFile(Arg->getValue()))
 818         readLinkerScript(*MB);
 819       break;
 820     case OPT_as_needed:
 821       Config->AsNeeded = true;
 822       break;
 823     case OPT_format:
 824       InBinary = getBinaryOption(Arg->getValue());
 825       break;
 826     case OPT_no_as_needed:
 827       Config->AsNeeded = false;
 828       break;
 829     case OPT_Bstatic:
 830       Config->Static = true;
 831       break;
 832     case OPT_Bdynamic:
 833       Config->Static = false;
 834       break;
 835     case OPT_whole_archive:
 836       InWholeArchive = true;
 837       break;
 838     case OPT_no_whole_archive:
 839       InWholeArchive = false;
 840       break;
 841     case OPT_start_lib:
 842       InLib = true;
 843       break;
 844     case OPT_end_lib:
 845       InLib = false;
 846       break;
 847     }
 848   }
 849
 850   if (Files.empty() && ErrorCount == 0)
 851     error("no input files");
 852 }
 853
 854 // If -m <machine_type> was not given, infer it from object files.
 855 void LinkerDriver::inferMachineType() {
 856   if (Config->EKind != ELFNoneKind)
 857     return;
 858
 859   for (InputFile *F : Files) {
 860     if (F->EKind == ELFNoneKind)
 861       continue;
 862     Config->EKind = F->EKind;
 863     Config->EMachine = F->EMachine;
 864     Config->OSABI = F->OSABI;
 865     Config->MipsN32Abi = Config->EMachine == EM_MIPS && isMipsN32Abi(F);
 866     return;
 867   }
 868   error("target emulation unknown: -m or at least one .o file required");
 869 }
 870
 871 // Parse -z max-page-size=<value>. The default value is defined by
 872 // each target.
 873 static uint64_t getMaxPageSize(opt::InputArgList &Args) {
 874   uint64_t Val =
 875       getZOptionValue(Args, "max-page-size", Target->DefaultMaxPageSize);
 876   if (!isPowerOf2_64(Val))
 877     error("max-page-size: value isn't a power of 2");
 878   return Val;
 879 }
 880
 881 // Parses -image-base option.
 882 static uint64_t getImageBase(opt::InputArgList &Args) {
 883   // Use default if no -image-base option is given.
 884   // Because we are using "Target" here, this function
 885   // has to be called after the variable is initialized.
 886   auto *Arg = Args.getLastArg(OPT_image_base);
 887   if (!Arg)
 888     return Config->Pic ? 0 : Target->DefaultImageBase;
 889
 890   StringRef S = Arg->getValue();
 891   uint64_t V;
 892   if (!to_integer(S, V)) {
 893     error("-image-base: number expected, but got " + S);
 894     return 0;
 895   }
 896   if ((V % Config->MaxPageSize) != 0)
 897     warn("-image-base: address isn't multiple of page size: " + S);
 898   return V;
 899 }
 900
 901 // Parses --defsym=alias option.
 902 static std::vector<std::pair<StringRef, StringRef>>
 903 getDefsym(opt::InputArgList &Args) {
 904   std::vector<std::pair<StringRef, StringRef>> Ret;
 905   for (auto *Arg : Args.filtered(OPT_defsym)) {
 906     StringRef From;
 907     StringRef To;
 908     std::tie(From, To) = StringRef(Arg->getValue()).split('=');
 909     if (!isValidCIdentifier(To))
 910       error("--defsym: symbol name expected, but got " + To);
 911     Ret.push_back({From, To});
 912   }
 913   return Ret;
 914 }
 915
 916 // Parses `--exclude-libs=lib,lib,...`.
 917 // The library names may be delimited by commas or colons.
 918 static DenseSet<StringRef> getExcludeLibs(opt::InputArgList &Args) {
 919   DenseSet<StringRef> Ret;
 920   for (auto *Arg : Args.filtered(OPT_exclude_libs)) {
 921     StringRef S = Arg->getValue();
 922     for (;;) {
 923       size_t Pos = S.find_first_of(",:");
 924       if (Pos == StringRef::npos)
 925         break;
 926       Ret.insert(S.substr(0, Pos));
 927       S = S.substr(Pos + 1);
 928     }
 929     Ret.insert(S);
 930   }
 931   return Ret;
 932 }
 933
 934 // Handles the -exclude-libs option. If a static library file is specified
 935 // by the -exclude-libs option, all public symbols from the archive become
 936 // private unless otherwise specified by version scripts or something.
 937 // A special library name "ALL" means all archive files.
 938 //
 939 // This is not a popular option, but some programs such as bionic libc use it.
 940 static void excludeLibs(opt::InputArgList &Args, ArrayRef<InputFile *> Files) {
 941   DenseSet<StringRef> Libs = getExcludeLibs(Args);
 942   bool All = Libs.count("ALL");
 943
 944   for (InputFile *File : Files)
 945     if (auto *F = dyn_cast<ArchiveFile>(File))
 946       if (All || Libs.count(path::filename(F->getName())))
 947         for (Symbol *Sym : F->getSymbols())
 948           Sym->VersionId = VER_NDX_LOCAL;
 949 }
 950
 951 // Do actual linking. Note that when this function is called,
 952 // all linker scripts have already been parsed.
 953 template <class ELFT> void LinkerDriver::link(opt::InputArgList &Args) {
 954   SymbolTable<ELFT> Symtab;
 955   elf::Symtab<ELFT>::X = &Symtab;
 956   Target = getTarget();
 957
 958   Config->MaxPageSize = getMaxPageSize(Args);
 959   Config->ImageBase = getImageBase(Args);
 960
 961   // Default output filename is "a.out" by the Unix tradition.
 962   if (Config->OutputFile.empty())
 963     Config->OutputFile = "a.out";
 964
 965   // Fail early if the output file or map file is not writable. If a user has a
 966   // long link, e.g. due to a large LTO link, they do not wish to run it and
 967   // find that it failed because there was a mistake in their command-line.
 968   if (auto E = tryCreateFile(Config->OutputFile))
 969     error("cannot open output file " + Config->OutputFile + ": " + E.message());
 970   if (auto E = tryCreateFile(Config->MapFile))
 971     error("cannot open map file " + Config->MapFile + ": " + E.message());
 972   if (ErrorCount)
 973     return;
 974
 975   // Use default entry point name if no name was given via the command
 976   // line nor linker scripts. For some reason, MIPS entry point name is
 977   // different from others.
 978   Config->WarnMissingEntry =
 979       (!Config->Entry.empty() || (!Config->Shared && !Config->Relocatable));
 980   if (Config->Entry.empty() && !Config->Relocatable)
 981     Config->Entry = (Config->EMachine == EM_MIPS) ? "__start" : "_start";
 982
 983   // Handle --trace-symbol.
 984   for (auto *Arg : Args.filtered(OPT_trace_symbol))
 985     Symtab.trace(Arg->getValue());
 986
 987   // Add all files to the symbol table. This will add almost all
 988   // symbols that we need to the symbol table.
 989   for (InputFile *F : Files)
 990     Symtab.addFile(F);
 991
 992   // If an entry symbol is in a static archive, pull out that file now
 993   // to complete the symbol table. After this, no new names except a
 994   // few linker-synthesized ones will be added to the symbol table.
 995   if (Symtab.find(Config->Entry))
 996     Symtab.addUndefined(Config->Entry);
 997
 998   // Return if there were name resolution errors.
 999   if (ErrorCount)
1000     return;
1001
1002   // Handle the `--undefined <sym>` options.
1003   Symtab.scanUndefinedFlags();
1004
1005   // Handle undefined symbols in DSOs.
1006   Symtab.scanShlibUndefined();
1007
1008   // Handle the -exclude-libs option.
1009   if (Args.hasArg(OPT_exclude_libs))
1010     excludeLibs(Args, Files);
1011
1012   // Apply version scripts.
1013   Symtab.scanVersionScript();
1014
1015   // Create wrapped symbols for -wrap option.
1016   for (auto *Arg : Args.filtered(OPT_wrap))
1017     Symtab.addSymbolWrap(Arg->getValue());
1018
1019   // Create alias symbols for -defsym option.
1020   for (std::pair<StringRef, StringRef> &Def : getDefsym(Args))
1021     Symtab.addSymbolAlias(Def.first, Def.second);
1022
1023   Symtab.addCombinedLTOObject();
1024   if (ErrorCount)
1025     return;
1026
1027   // Some symbols (such as __ehdr_start) are defined lazily only when there
1028   // are undefined symbols for them, so we add these to trigger that logic.
1029   for (StringRef Sym : Script->Opt.ReferencedSymbols)
1030     Symtab.addUndefined(Sym);
1031
1032   // Apply symbol renames for -wrap and -defsym
1033   Symtab.applySymbolRenames();
1034
1035   // Now that we have a complete list of input files.
1036   // Beyond this point, no new files are added.
1037   // Aggregate all input sections into one place.
1038   for (elf::ObjectFile<ELFT> *F : Symtab.getObjectFiles())
1039     for (InputSectionBase *S : F->getSections())
1040       if (S && S != &InputSection::Discarded)
1041         InputSections.push_back(S);
1042   for (BinaryFile *F : Symtab.getBinaryFiles())
1043     for (InputSectionBase *S : F->getSections())
1044       InputSections.push_back(cast<InputSection>(S));
1045
1046   // This adds a .comment section containing a version string. We have to add it
1047   // before decompressAndMergeSections because the .comment section is a
1048   // mergeable section.
1049   if (!Config->Relocatable)
1050     InputSections.push_back(createCommentSection<ELFT>());
1051
1052   // Do size optimizations: garbage collection, merging of SHF_MERGE sections
1053   // and identical code folding.
1054   if (Config->GcSections)
1055     markLive<ELFT>();
1056   decompressAndMergeSections();
1057   if (Config->ICF)
1058     doIcf<ELFT>();
1059
1060   // Write the result to the file.
1061   writeResult<ELFT>();
1062 }