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