xref: /llvm-project-15.0.7/lld/ELF/Driver.cpp (revision faef447e)
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->optRemarksFilename = args.getLastArgValue(OPT_opt_remarks_filename);
1130   config->optStatsFilename = args.getLastArgValue(OPT_opt_stats_filename);
1131 
1132   // Parse remarks hotness threshold. Valid value is either integer or 'auto'.
1133   if (auto *arg = args.getLastArg(OPT_opt_remarks_hotness_threshold)) {
1134     auto resultOrErr = remarks::parseHotnessThresholdOption(arg->getValue());
1135     if (!resultOrErr)
1136       error(arg->getSpelling() + ": invalid argument '" + arg->getValue() +
1137             "', only integer or 'auto' is supported");
1138     else
1139       config->optRemarksHotnessThreshold = *resultOrErr;
1140   }
1141 
1142   config->optRemarksPasses = args.getLastArgValue(OPT_opt_remarks_passes);
1143   config->optRemarksWithHotness = args.hasArg(OPT_opt_remarks_with_hotness);
1144   config->optRemarksFormat = args.getLastArgValue(OPT_opt_remarks_format);
1145   config->optimize = args::getInteger(args, OPT_O, 1);
1146   config->orphanHandling = getOrphanHandling(args);
1147   config->outputFile = args.getLastArgValue(OPT_o);
1148   config->pie = args.hasFlag(OPT_pie, OPT_no_pie, false);
1149   config->printIcfSections =
1150       args.hasFlag(OPT_print_icf_sections, OPT_no_print_icf_sections, false);
1151   config->printGcSections =
1152       args.hasFlag(OPT_print_gc_sections, OPT_no_print_gc_sections, false);
1153   config->printArchiveStats = args.getLastArgValue(OPT_print_archive_stats);
1154   config->printSymbolOrder =
1155       args.getLastArgValue(OPT_print_symbol_order);
1156   config->relax = args.hasFlag(OPT_relax, OPT_no_relax, true);
1157   config->rpath = getRpath(args);
1158   config->relocatable = args.hasArg(OPT_relocatable);
1159   config->saveTemps = args.hasArg(OPT_save_temps);
1160   config->searchPaths = args::getStrings(args, OPT_library_path);
1161   config->sectionStartMap = getSectionStartMap(args);
1162   config->shared = args.hasArg(OPT_shared);
1163   config->singleRoRx = !args.hasFlag(OPT_rosegment, OPT_no_rosegment, true);
1164   config->soName = args.getLastArgValue(OPT_soname);
1165   config->sortSection = getSortSection(args);
1166   config->splitStackAdjustSize = args::getInteger(args, OPT_split_stack_adjust_size, 16384);
1167   config->strip = getStrip(args);
1168   config->sysroot = args.getLastArgValue(OPT_sysroot);
1169   config->target1Rel = args.hasFlag(OPT_target1_rel, OPT_target1_abs, false);
1170   config->target2 = getTarget2(args);
1171   config->thinLTOCacheDir = args.getLastArgValue(OPT_thinlto_cache_dir);
1172   config->thinLTOCachePolicy = CHECK(
1173       parseCachePruningPolicy(args.getLastArgValue(OPT_thinlto_cache_policy)),
1174       "--thinlto-cache-policy: invalid cache policy");
1175   config->thinLTOEmitImportsFiles = args.hasArg(OPT_thinlto_emit_imports_files);
1176   config->thinLTOIndexOnly = args.hasArg(OPT_thinlto_index_only) ||
1177                              args.hasArg(OPT_thinlto_index_only_eq);
1178   config->thinLTOIndexOnlyArg = args.getLastArgValue(OPT_thinlto_index_only_eq);
1179   config->thinLTOObjectSuffixReplace =
1180       getOldNewOptions(args, OPT_thinlto_object_suffix_replace_eq);
1181   config->thinLTOPrefixReplace =
1182       getOldNewOptions(args, OPT_thinlto_prefix_replace_eq);
1183   config->thinLTOModulesToCompile =
1184       args::getStrings(args, OPT_thinlto_single_module_eq);
1185   config->timeTraceEnabled = args.hasArg(OPT_time_trace);
1186   config->timeTraceGranularity =
1187       args::getInteger(args, OPT_time_trace_granularity, 500);
1188   config->trace = args.hasArg(OPT_trace);
1189   config->undefined = args::getStrings(args, OPT_undefined);
1190   config->undefinedVersion =
1191       args.hasFlag(OPT_undefined_version, OPT_no_undefined_version, true);
1192   config->unique = args.hasArg(OPT_unique);
1193   config->useAndroidRelrTags = args.hasFlag(
1194       OPT_use_android_relr_tags, OPT_no_use_android_relr_tags, false);
1195   config->warnBackrefs =
1196       args.hasFlag(OPT_warn_backrefs, OPT_no_warn_backrefs, false);
1197   config->warnCommon = args.hasFlag(OPT_warn_common, OPT_no_warn_common, false);
1198   config->warnSymbolOrdering =
1199       args.hasFlag(OPT_warn_symbol_ordering, OPT_no_warn_symbol_ordering, true);
1200   config->whyExtract = args.getLastArgValue(OPT_why_extract);
1201   config->zCombreloc = getZFlag(args, "combreloc", "nocombreloc", true);
1202   config->zCopyreloc = getZFlag(args, "copyreloc", "nocopyreloc", true);
1203   config->zForceBti = hasZOption(args, "force-bti");
1204   config->zForceIbt = hasZOption(args, "force-ibt");
1205   config->zGlobal = hasZOption(args, "global");
1206   config->zGnustack = getZGnuStack(args);
1207   config->zHazardplt = hasZOption(args, "hazardplt");
1208   config->zIfuncNoplt = hasZOption(args, "ifunc-noplt");
1209   config->zInitfirst = hasZOption(args, "initfirst");
1210   config->zInterpose = hasZOption(args, "interpose");
1211   config->zKeepTextSectionPrefix = getZFlag(
1212       args, "keep-text-section-prefix", "nokeep-text-section-prefix", false);
1213   config->zNodefaultlib = hasZOption(args, "nodefaultlib");
1214   config->zNodelete = hasZOption(args, "nodelete");
1215   config->zNodlopen = hasZOption(args, "nodlopen");
1216   config->zNow = getZFlag(args, "now", "lazy", false);
1217   config->zOrigin = hasZOption(args, "origin");
1218   config->zPacPlt = hasZOption(args, "pac-plt");
1219   config->zRelro = getZFlag(args, "relro", "norelro", true);
1220   config->zRetpolineplt = hasZOption(args, "retpolineplt");
1221   config->zRodynamic = hasZOption(args, "rodynamic");
1222   config->zSeparate = getZSeparate(args);
1223   config->zShstk = hasZOption(args, "shstk");
1224   config->zStackSize = args::getZOptionValue(args, OPT_z, "stack-size", 0);
1225   config->zStartStopGC =
1226       getZFlag(args, "start-stop-gc", "nostart-stop-gc", true);
1227   config->zStartStopVisibility = getZStartStopVisibility(args);
1228   config->zText = getZFlag(args, "text", "notext", true);
1229   config->zWxneeded = hasZOption(args, "wxneeded");
1230   setUnresolvedSymbolPolicy(args);
1231   config->power10Stubs = args.getLastArgValue(OPT_power10_stubs_eq) != "no";
1232 
1233   if (opt::Arg *arg = args.getLastArg(OPT_eb, OPT_el)) {
1234     if (arg->getOption().matches(OPT_eb))
1235       config->optEB = true;
1236     else
1237       config->optEL = true;
1238   }
1239 
1240   for (opt::Arg *arg : args.filtered(OPT_shuffle_sections)) {
1241     constexpr StringRef errPrefix = "--shuffle-sections=: ";
1242     std::pair<StringRef, StringRef> kv = StringRef(arg->getValue()).split('=');
1243     if (kv.first.empty() || kv.second.empty()) {
1244       error(errPrefix + "expected <section_glob>=<seed>, but got '" +
1245             arg->getValue() + "'");
1246       continue;
1247     }
1248     // Signed so that <section_glob>=-1 is allowed.
1249     int64_t v;
1250     if (!to_integer(kv.second, v))
1251       error(errPrefix + "expected an integer, but got '" + kv.second + "'");
1252     else if (Expected<GlobPattern> pat = GlobPattern::create(kv.first))
1253       config->shuffleSections.emplace_back(std::move(*pat), uint32_t(v));
1254     else
1255       error(errPrefix + toString(pat.takeError()));
1256   }
1257 
1258   auto reports = {std::make_pair("bti-report", &config->zBtiReport),
1259                   std::make_pair("cet-report", &config->zCetReport)};
1260   for (opt::Arg *arg : args.filtered(OPT_z)) {
1261     std::pair<StringRef, StringRef> option =
1262         StringRef(arg->getValue()).split('=');
1263     for (auto reportArg : reports) {
1264       if (option.first != reportArg.first)
1265         continue;
1266       if (!isValidReportString(option.second)) {
1267         error(Twine("-z ") + reportArg.first + "= parameter " + option.second +
1268               " is not recognized");
1269         continue;
1270       }
1271       *reportArg.second = option.second;
1272     }
1273   }
1274 
1275   for (opt::Arg *arg : args.filtered(OPT_z)) {
1276     std::pair<StringRef, StringRef> option =
1277         StringRef(arg->getValue()).split('=');
1278     if (option.first != "dead-reloc-in-nonalloc")
1279       continue;
1280     constexpr StringRef errPrefix = "-z dead-reloc-in-nonalloc=: ";
1281     std::pair<StringRef, StringRef> kv = option.second.split('=');
1282     if (kv.first.empty() || kv.second.empty()) {
1283       error(errPrefix + "expected <section_glob>=<value>");
1284       continue;
1285     }
1286     uint64_t v;
1287     if (!to_integer(kv.second, v))
1288       error(errPrefix + "expected a non-negative integer, but got '" +
1289             kv.second + "'");
1290     else if (Expected<GlobPattern> pat = GlobPattern::create(kv.first))
1291       config->deadRelocInNonAlloc.emplace_back(std::move(*pat), v);
1292     else
1293       error(errPrefix + toString(pat.takeError()));
1294   }
1295 
1296   cl::ResetAllOptionOccurrences();
1297 
1298   // Parse LTO options.
1299   if (auto *arg = args.getLastArg(OPT_plugin_opt_mcpu_eq))
1300     parseClangOption(saver().save("-mcpu=" + StringRef(arg->getValue())),
1301                      arg->getSpelling());
1302 
1303   for (opt::Arg *arg : args.filtered(OPT_plugin_opt_eq_minus))
1304     parseClangOption(std::string("-") + arg->getValue(), arg->getSpelling());
1305 
1306   // GCC collect2 passes -plugin-opt=path/to/lto-wrapper with an absolute or
1307   // relative path. Just ignore. If not ended with "lto-wrapper", consider it an
1308   // unsupported LLVMgold.so option and error.
1309   for (opt::Arg *arg : args.filtered(OPT_plugin_opt_eq))
1310     if (!StringRef(arg->getValue()).endswith("lto-wrapper"))
1311       error(arg->getSpelling() + ": unknown plugin option '" + arg->getValue() +
1312             "'");
1313 
1314   config->passPlugins = args::getStrings(args, OPT_load_pass_plugins);
1315 
1316   // Parse -mllvm options.
1317   for (auto *arg : args.filtered(OPT_mllvm))
1318     parseClangOption(arg->getValue(), arg->getSpelling());
1319 
1320   // --threads= takes a positive integer and provides the default value for
1321   // --thinlto-jobs=.
1322   if (auto *arg = args.getLastArg(OPT_threads)) {
1323     StringRef v(arg->getValue());
1324     unsigned threads = 0;
1325     if (!llvm::to_integer(v, threads, 0) || threads == 0)
1326       error(arg->getSpelling() + ": expected a positive integer, but got '" +
1327             arg->getValue() + "'");
1328     parallel::strategy = hardware_concurrency(threads);
1329     config->thinLTOJobs = v;
1330   }
1331   if (auto *arg = args.getLastArg(OPT_thinlto_jobs))
1332     config->thinLTOJobs = arg->getValue();
1333 
1334   if (config->ltoo > 3)
1335     error("invalid optimization level for LTO: " + Twine(config->ltoo));
1336   if (config->ltoPartitions == 0)
1337     error("--lto-partitions: number of threads must be > 0");
1338   if (!get_threadpool_strategy(config->thinLTOJobs))
1339     error("--thinlto-jobs: invalid job count: " + config->thinLTOJobs);
1340 
1341   if (config->splitStackAdjustSize < 0)
1342     error("--split-stack-adjust-size: size must be >= 0");
1343 
1344   // The text segment is traditionally the first segment, whose address equals
1345   // the base address. However, lld places the R PT_LOAD first. -Ttext-segment
1346   // is an old-fashioned option that does not play well with lld's layout.
1347   // Suggest --image-base as a likely alternative.
1348   if (args.hasArg(OPT_Ttext_segment))
1349     error("-Ttext-segment is not supported. Use --image-base if you "
1350           "intend to set the base address");
1351 
1352   // Parse ELF{32,64}{LE,BE} and CPU type.
1353   if (auto *arg = args.getLastArg(OPT_m)) {
1354     StringRef s = arg->getValue();
1355     std::tie(config->ekind, config->emachine, config->osabi) =
1356         parseEmulation(s);
1357     config->mipsN32Abi =
1358         (s.startswith("elf32btsmipn32") || s.startswith("elf32ltsmipn32"));
1359     config->emulation = s;
1360   }
1361 
1362   // Parse --hash-style={sysv,gnu,both}.
1363   if (auto *arg = args.getLastArg(OPT_hash_style)) {
1364     StringRef s = arg->getValue();
1365     if (s == "sysv")
1366       config->sysvHash = true;
1367     else if (s == "gnu")
1368       config->gnuHash = true;
1369     else if (s == "both")
1370       config->sysvHash = config->gnuHash = true;
1371     else
1372       error("unknown --hash-style: " + s);
1373   }
1374 
1375   if (args.hasArg(OPT_print_map))
1376     config->mapFile = "-";
1377 
1378   // Page alignment can be disabled by the -n (--nmagic) and -N (--omagic).
1379   // As PT_GNU_RELRO relies on Paging, do not create it when we have disabled
1380   // it.
1381   if (config->nmagic || config->omagic)
1382     config->zRelro = false;
1383 
1384   std::tie(config->buildId, config->buildIdVector) = getBuildId(args);
1385 
1386   if (getZFlag(args, "pack-relative-relocs", "nopack-relative-relocs", false)) {
1387     config->relrGlibc = true;
1388     config->relrPackDynRelocs = true;
1389   } else {
1390     std::tie(config->androidPackDynRelocs, config->relrPackDynRelocs) =
1391         getPackDynRelocs(args);
1392   }
1393 
1394   if (auto *arg = args.getLastArg(OPT_symbol_ordering_file)){
1395     if (args.hasArg(OPT_call_graph_ordering_file))
1396       error("--symbol-ordering-file and --call-graph-order-file "
1397             "may not be used together");
1398     if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue())){
1399       config->symbolOrderingFile = getSymbolOrderingFile(*buffer);
1400       // Also need to disable CallGraphProfileSort to prevent
1401       // LLD order symbols with CGProfile
1402       config->callGraphProfileSort = false;
1403     }
1404   }
1405 
1406   assert(config->versionDefinitions.empty());
1407   config->versionDefinitions.push_back(
1408       {"local", (uint16_t)VER_NDX_LOCAL, {}, {}});
1409   config->versionDefinitions.push_back(
1410       {"global", (uint16_t)VER_NDX_GLOBAL, {}, {}});
1411 
1412   // If --retain-symbol-file is used, we'll keep only the symbols listed in
1413   // the file and discard all others.
1414   if (auto *arg = args.getLastArg(OPT_retain_symbols_file)) {
1415     config->versionDefinitions[VER_NDX_LOCAL].nonLocalPatterns.push_back(
1416         {"*", /*isExternCpp=*/false, /*hasWildcard=*/true});
1417     if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue()))
1418       for (StringRef s : args::getLines(*buffer))
1419         config->versionDefinitions[VER_NDX_GLOBAL].nonLocalPatterns.push_back(
1420             {s, /*isExternCpp=*/false, /*hasWildcard=*/false});
1421   }
1422 
1423   for (opt::Arg *arg : args.filtered(OPT_warn_backrefs_exclude)) {
1424     StringRef pattern(arg->getValue());
1425     if (Expected<GlobPattern> pat = GlobPattern::create(pattern))
1426       config->warnBackrefsExclude.push_back(std::move(*pat));
1427     else
1428       error(arg->getSpelling() + ": " + toString(pat.takeError()));
1429   }
1430 
1431   // For -no-pie and -pie, --export-dynamic-symbol specifies defined symbols
1432   // which should be exported. For -shared, references to matched non-local
1433   // STV_DEFAULT symbols are not bound to definitions within the shared object,
1434   // even if other options express a symbolic intention: -Bsymbolic,
1435   // -Bsymbolic-functions (if STT_FUNC), --dynamic-list.
1436   for (auto *arg : args.filtered(OPT_export_dynamic_symbol))
1437     config->dynamicList.push_back(
1438         {arg->getValue(), /*isExternCpp=*/false,
1439          /*hasWildcard=*/hasWildcard(arg->getValue())});
1440 
1441   // --export-dynamic-symbol-list specifies a list of --export-dynamic-symbol
1442   // patterns. --dynamic-list is --export-dynamic-symbol-list plus -Bsymbolic
1443   // like semantics.
1444   config->symbolic =
1445       config->bsymbolic == BsymbolicKind::All || args.hasArg(OPT_dynamic_list);
1446   for (auto *arg :
1447        args.filtered(OPT_dynamic_list, OPT_export_dynamic_symbol_list))
1448     if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue()))
1449       readDynamicList(*buffer);
1450 
1451   for (auto *arg : args.filtered(OPT_version_script))
1452     if (Optional<std::string> path = searchScript(arg->getValue())) {
1453       if (Optional<MemoryBufferRef> buffer = readFile(*path))
1454         readVersionScript(*buffer);
1455     } else {
1456       error(Twine("cannot find version script ") + arg->getValue());
1457     }
1458 }
1459 
1460 // Some Config members do not directly correspond to any particular
1461 // command line options, but computed based on other Config values.
1462 // This function initialize such members. See Config.h for the details
1463 // of these values.
1464 static void setConfigs(opt::InputArgList &args) {
1465   ELFKind k = config->ekind;
1466   uint16_t m = config->emachine;
1467 
1468   config->copyRelocs = (config->relocatable || config->emitRelocs);
1469   config->is64 = (k == ELF64LEKind || k == ELF64BEKind);
1470   config->isLE = (k == ELF32LEKind || k == ELF64LEKind);
1471   config->endianness = config->isLE ? endianness::little : endianness::big;
1472   config->isMips64EL = (k == ELF64LEKind && m == EM_MIPS);
1473   config->isPic = config->pie || config->shared;
1474   config->picThunk = args.hasArg(OPT_pic_veneer, config->isPic);
1475   config->wordsize = config->is64 ? 8 : 4;
1476 
1477   // ELF defines two different ways to store relocation addends as shown below:
1478   //
1479   //  Rel: Addends are stored to the location where relocations are applied. It
1480   //  cannot pack the full range of addend values for all relocation types, but
1481   //  this only affects relocation types that we don't support emitting as
1482   //  dynamic relocations (see getDynRel).
1483   //  Rela: Addends are stored as part of relocation entry.
1484   //
1485   // In other words, Rela makes it easy to read addends at the price of extra
1486   // 4 or 8 byte for each relocation entry.
1487   //
1488   // We pick the format for dynamic relocations according to the psABI for each
1489   // processor, but a contrary choice can be made if the dynamic loader
1490   // supports.
1491   config->isRela = getIsRela(args);
1492 
1493   // If the output uses REL relocations we must store the dynamic relocation
1494   // addends to the output sections. We also store addends for RELA relocations
1495   // if --apply-dynamic-relocs is used.
1496   // We default to not writing the addends when using RELA relocations since
1497   // any standard conforming tool can find it in r_addend.
1498   config->writeAddends = args.hasFlag(OPT_apply_dynamic_relocs,
1499                                       OPT_no_apply_dynamic_relocs, false) ||
1500                          !config->isRela;
1501   // Validation of dynamic relocation addends is on by default for assertions
1502   // builds (for supported targets) and disabled otherwise. Ideally we would
1503   // enable the debug checks for all targets, but currently not all targets
1504   // have support for reading Elf_Rel addends, so we only enable for a subset.
1505 #ifndef NDEBUG
1506   bool checkDynamicRelocsDefault = m == EM_ARM || m == EM_386 || m == EM_MIPS ||
1507                                    m == EM_X86_64 || m == EM_RISCV;
1508 #else
1509   bool checkDynamicRelocsDefault = false;
1510 #endif
1511   config->checkDynamicRelocs =
1512       args.hasFlag(OPT_check_dynamic_relocations,
1513                    OPT_no_check_dynamic_relocations, checkDynamicRelocsDefault);
1514   config->tocOptimize =
1515       args.hasFlag(OPT_toc_optimize, OPT_no_toc_optimize, m == EM_PPC64);
1516   config->pcRelOptimize =
1517       args.hasFlag(OPT_pcrel_optimize, OPT_no_pcrel_optimize, m == EM_PPC64);
1518 }
1519 
1520 static bool isFormatBinary(StringRef s) {
1521   if (s == "binary")
1522     return true;
1523   if (s == "elf" || s == "default")
1524     return false;
1525   error("unknown --format value: " + s +
1526         " (supported formats: elf, default, binary)");
1527   return false;
1528 }
1529 
1530 void LinkerDriver::createFiles(opt::InputArgList &args) {
1531   llvm::TimeTraceScope timeScope("Load input files");
1532   // For --{push,pop}-state.
1533   std::vector<std::tuple<bool, bool, bool>> stack;
1534 
1535   // Iterate over argv to process input files and positional arguments.
1536   InputFile::isInGroup = false;
1537   bool hasInput = false;
1538   for (auto *arg : args) {
1539     switch (arg->getOption().getID()) {
1540     case OPT_library:
1541       addLibrary(arg->getValue());
1542       hasInput = true;
1543       break;
1544     case OPT_INPUT:
1545       addFile(arg->getValue(), /*withLOption=*/false);
1546       hasInput = true;
1547       break;
1548     case OPT_defsym: {
1549       StringRef from;
1550       StringRef to;
1551       std::tie(from, to) = StringRef(arg->getValue()).split('=');
1552       if (from.empty() || to.empty())
1553         error("--defsym: syntax error: " + StringRef(arg->getValue()));
1554       else
1555         readDefsym(from, MemoryBufferRef(to, "--defsym"));
1556       break;
1557     }
1558     case OPT_script:
1559       if (Optional<std::string> path = searchScript(arg->getValue())) {
1560         if (Optional<MemoryBufferRef> mb = readFile(*path))
1561           readLinkerScript(*mb);
1562         break;
1563       }
1564       error(Twine("cannot find linker script ") + arg->getValue());
1565       break;
1566     case OPT_as_needed:
1567       config->asNeeded = true;
1568       break;
1569     case OPT_format:
1570       config->formatBinary = isFormatBinary(arg->getValue());
1571       break;
1572     case OPT_no_as_needed:
1573       config->asNeeded = false;
1574       break;
1575     case OPT_Bstatic:
1576     case OPT_omagic:
1577     case OPT_nmagic:
1578       config->isStatic = true;
1579       break;
1580     case OPT_Bdynamic:
1581       config->isStatic = false;
1582       break;
1583     case OPT_whole_archive:
1584       inWholeArchive = true;
1585       break;
1586     case OPT_no_whole_archive:
1587       inWholeArchive = false;
1588       break;
1589     case OPT_just_symbols:
1590       if (Optional<MemoryBufferRef> mb = readFile(arg->getValue())) {
1591         files.push_back(createObjectFile(*mb));
1592         files.back()->justSymbols = true;
1593       }
1594       break;
1595     case OPT_start_group:
1596       if (InputFile::isInGroup)
1597         error("nested --start-group");
1598       InputFile::isInGroup = true;
1599       break;
1600     case OPT_end_group:
1601       if (!InputFile::isInGroup)
1602         error("stray --end-group");
1603       InputFile::isInGroup = false;
1604       ++InputFile::nextGroupId;
1605       break;
1606     case OPT_start_lib:
1607       if (inLib)
1608         error("nested --start-lib");
1609       if (InputFile::isInGroup)
1610         error("may not nest --start-lib in --start-group");
1611       inLib = true;
1612       InputFile::isInGroup = true;
1613       break;
1614     case OPT_end_lib:
1615       if (!inLib)
1616         error("stray --end-lib");
1617       inLib = false;
1618       InputFile::isInGroup = false;
1619       ++InputFile::nextGroupId;
1620       break;
1621     case OPT_push_state:
1622       stack.emplace_back(config->asNeeded, config->isStatic, inWholeArchive);
1623       break;
1624     case OPT_pop_state:
1625       if (stack.empty()) {
1626         error("unbalanced --push-state/--pop-state");
1627         break;
1628       }
1629       std::tie(config->asNeeded, config->isStatic, inWholeArchive) = stack.back();
1630       stack.pop_back();
1631       break;
1632     }
1633   }
1634 
1635   if (files.empty() && !hasInput && errorCount() == 0)
1636     error("no input files");
1637 }
1638 
1639 // If -m <machine_type> was not given, infer it from object files.
1640 void LinkerDriver::inferMachineType() {
1641   if (config->ekind != ELFNoneKind)
1642     return;
1643 
1644   for (InputFile *f : files) {
1645     if (f->ekind == ELFNoneKind)
1646       continue;
1647     config->ekind = f->ekind;
1648     config->emachine = f->emachine;
1649     config->osabi = f->osabi;
1650     config->mipsN32Abi = config->emachine == EM_MIPS && isMipsN32Abi(f);
1651     return;
1652   }
1653   error("target emulation unknown: -m or at least one .o file required");
1654 }
1655 
1656 // Parse -z max-page-size=<value>. The default value is defined by
1657 // each target.
1658 static uint64_t getMaxPageSize(opt::InputArgList &args) {
1659   uint64_t val = args::getZOptionValue(args, OPT_z, "max-page-size",
1660                                        target->defaultMaxPageSize);
1661   if (!isPowerOf2_64(val))
1662     error("max-page-size: value isn't a power of 2");
1663   if (config->nmagic || config->omagic) {
1664     if (val != target->defaultMaxPageSize)
1665       warn("-z max-page-size set, but paging disabled by omagic or nmagic");
1666     return 1;
1667   }
1668   return val;
1669 }
1670 
1671 // Parse -z common-page-size=<value>. The default value is defined by
1672 // each target.
1673 static uint64_t getCommonPageSize(opt::InputArgList &args) {
1674   uint64_t val = args::getZOptionValue(args, OPT_z, "common-page-size",
1675                                        target->defaultCommonPageSize);
1676   if (!isPowerOf2_64(val))
1677     error("common-page-size: value isn't a power of 2");
1678   if (config->nmagic || config->omagic) {
1679     if (val != target->defaultCommonPageSize)
1680       warn("-z common-page-size set, but paging disabled by omagic or nmagic");
1681     return 1;
1682   }
1683   // commonPageSize can't be larger than maxPageSize.
1684   if (val > config->maxPageSize)
1685     val = config->maxPageSize;
1686   return val;
1687 }
1688 
1689 // Parses --image-base option.
1690 static Optional<uint64_t> getImageBase(opt::InputArgList &args) {
1691   // Because we are using "Config->maxPageSize" here, this function has to be
1692   // called after the variable is initialized.
1693   auto *arg = args.getLastArg(OPT_image_base);
1694   if (!arg)
1695     return None;
1696 
1697   StringRef s = arg->getValue();
1698   uint64_t v;
1699   if (!to_integer(s, v)) {
1700     error("--image-base: number expected, but got " + s);
1701     return 0;
1702   }
1703   if ((v % config->maxPageSize) != 0)
1704     warn("--image-base: address isn't multiple of page size: " + s);
1705   return v;
1706 }
1707 
1708 // Parses `--exclude-libs=lib,lib,...`.
1709 // The library names may be delimited by commas or colons.
1710 static DenseSet<StringRef> getExcludeLibs(opt::InputArgList &args) {
1711   DenseSet<StringRef> ret;
1712   for (auto *arg : args.filtered(OPT_exclude_libs)) {
1713     StringRef s = arg->getValue();
1714     for (;;) {
1715       size_t pos = s.find_first_of(",:");
1716       if (pos == StringRef::npos)
1717         break;
1718       ret.insert(s.substr(0, pos));
1719       s = s.substr(pos + 1);
1720     }
1721     ret.insert(s);
1722   }
1723   return ret;
1724 }
1725 
1726 // Handles the --exclude-libs option. If a static library file is specified
1727 // by the --exclude-libs option, all public symbols from the archive become
1728 // private unless otherwise specified by version scripts or something.
1729 // A special library name "ALL" means all archive files.
1730 //
1731 // This is not a popular option, but some programs such as bionic libc use it.
1732 static void excludeLibs(opt::InputArgList &args) {
1733   DenseSet<StringRef> libs = getExcludeLibs(args);
1734   bool all = libs.count("ALL");
1735 
1736   auto visit = [&](InputFile *file) {
1737     if (file->archiveName.empty() ||
1738         !(all || libs.count(path::filename(file->archiveName))))
1739       return;
1740     ArrayRef<Symbol *> symbols = file->getSymbols();
1741     if (isa<ELFFileBase>(file))
1742       symbols = cast<ELFFileBase>(file)->getGlobalSymbols();
1743     for (Symbol *sym : symbols)
1744       if (!sym->isUndefined() && sym->file == file)
1745         sym->versionId = VER_NDX_LOCAL;
1746   };
1747 
1748   for (ELFFileBase *file : objectFiles)
1749     visit(file);
1750 
1751   for (BitcodeFile *file : bitcodeFiles)
1752     visit(file);
1753 }
1754 
1755 // Force Sym to be entered in the output.
1756 static void handleUndefined(Symbol *sym, const char *option) {
1757   // Since a symbol may not be used inside the program, LTO may
1758   // eliminate it. Mark the symbol as "used" to prevent it.
1759   sym->isUsedInRegularObj = true;
1760 
1761   if (!sym->isLazy())
1762     return;
1763   sym->extract();
1764   if (!config->whyExtract.empty())
1765     driver->whyExtract.emplace_back(option, sym->file, *sym);
1766 }
1767 
1768 // As an extension to GNU linkers, lld supports a variant of `-u`
1769 // which accepts wildcard patterns. All symbols that match a given
1770 // pattern are handled as if they were given by `-u`.
1771 static void handleUndefinedGlob(StringRef arg) {
1772   Expected<GlobPattern> pat = GlobPattern::create(arg);
1773   if (!pat) {
1774     error("--undefined-glob: " + toString(pat.takeError()));
1775     return;
1776   }
1777 
1778   // Calling sym->extract() in the loop is not safe because it may add new
1779   // symbols to the symbol table, invalidating the current iterator.
1780   SmallVector<Symbol *, 0> syms;
1781   for (Symbol *sym : symtab->symbols())
1782     if (!sym->isPlaceholder() && pat->match(sym->getName()))
1783       syms.push_back(sym);
1784 
1785   for (Symbol *sym : syms)
1786     handleUndefined(sym, "--undefined-glob");
1787 }
1788 
1789 static void handleLibcall(StringRef name) {
1790   Symbol *sym = symtab->find(name);
1791   if (!sym || !sym->isLazy())
1792     return;
1793 
1794   MemoryBufferRef mb;
1795   mb = cast<LazyObject>(sym)->file->mb;
1796 
1797   if (isBitcode(mb))
1798     sym->extract();
1799 }
1800 
1801 void LinkerDriver::writeArchiveStats() const {
1802   if (config->printArchiveStats.empty())
1803     return;
1804 
1805   std::error_code ec;
1806   raw_fd_ostream os(config->printArchiveStats, ec, sys::fs::OF_None);
1807   if (ec) {
1808     error("--print-archive-stats=: cannot open " + config->printArchiveStats +
1809           ": " + ec.message());
1810     return;
1811   }
1812 
1813   os << "members\textracted\tarchive\n";
1814 
1815   SmallVector<StringRef, 0> archives;
1816   DenseMap<CachedHashStringRef, unsigned> all, extracted;
1817   for (ELFFileBase *file : objectFiles)
1818     if (file->archiveName.size())
1819       ++extracted[CachedHashStringRef(file->archiveName)];
1820   for (BitcodeFile *file : bitcodeFiles)
1821     if (file->archiveName.size())
1822       ++extracted[CachedHashStringRef(file->archiveName)];
1823   for (std::pair<StringRef, unsigned> f : archiveFiles) {
1824     unsigned &v = extracted[CachedHashString(f.first)];
1825     os << f.second << '\t' << v << '\t' << f.first << '\n';
1826     // If the archive occurs multiple times, other instances have a count of 0.
1827     v = 0;
1828   }
1829 }
1830 
1831 void LinkerDriver::writeWhyExtract() const {
1832   if (config->whyExtract.empty())
1833     return;
1834 
1835   std::error_code ec;
1836   raw_fd_ostream os(config->whyExtract, ec, sys::fs::OF_None);
1837   if (ec) {
1838     error("cannot open --why-extract= file " + config->whyExtract + ": " +
1839           ec.message());
1840     return;
1841   }
1842 
1843   os << "reference\textracted\tsymbol\n";
1844   for (auto &entry : whyExtract) {
1845     os << std::get<0>(entry) << '\t' << toString(std::get<1>(entry)) << '\t'
1846        << toString(std::get<2>(entry)) << '\n';
1847   }
1848 }
1849 
1850 void LinkerDriver::reportBackrefs() const {
1851   for (auto &ref : backwardReferences) {
1852     const Symbol &sym = *ref.first;
1853     std::string to = toString(ref.second.second);
1854     // Some libraries have known problems and can cause noise. Filter them out
1855     // with --warn-backrefs-exclude=. The value may look like (for --start-lib)
1856     // *.o or (archive member) *.a(*.o).
1857     bool exclude = false;
1858     for (const llvm::GlobPattern &pat : config->warnBackrefsExclude)
1859       if (pat.match(to)) {
1860         exclude = true;
1861         break;
1862       }
1863     if (!exclude)
1864       warn("backward reference detected: " + sym.getName() + " in " +
1865            toString(ref.second.first) + " refers to " + to);
1866   }
1867 }
1868 
1869 // Handle --dependency-file=<path>. If that option is given, lld creates a
1870 // file at a given path with the following contents:
1871 //
1872 //   <output-file>: <input-file> ...
1873 //
1874 //   <input-file>:
1875 //
1876 // where <output-file> is a pathname of an output file and <input-file>
1877 // ... is a list of pathnames of all input files. `make` command can read a
1878 // file in the above format and interpret it as a dependency info. We write
1879 // phony targets for every <input-file> to avoid an error when that file is
1880 // removed.
1881 //
1882 // This option is useful if you want to make your final executable to depend
1883 // on all input files including system libraries. Here is why.
1884 //
1885 // When you write a Makefile, you usually write it so that the final
1886 // executable depends on all user-generated object files. Normally, you
1887 // don't make your executable to depend on system libraries (such as libc)
1888 // because you don't know the exact paths of libraries, even though system
1889 // libraries that are linked to your executable statically are technically a
1890 // part of your program. By using --dependency-file option, you can make
1891 // lld to dump dependency info so that you can maintain exact dependencies
1892 // easily.
1893 static void writeDependencyFile() {
1894   std::error_code ec;
1895   raw_fd_ostream os(config->dependencyFile, ec, sys::fs::OF_None);
1896   if (ec) {
1897     error("cannot open " + config->dependencyFile + ": " + ec.message());
1898     return;
1899   }
1900 
1901   // We use the same escape rules as Clang/GCC which are accepted by Make/Ninja:
1902   // * A space is escaped by a backslash which itself must be escaped.
1903   // * A hash sign is escaped by a single backslash.
1904   // * $ is escapes as $$.
1905   auto printFilename = [](raw_fd_ostream &os, StringRef filename) {
1906     llvm::SmallString<256> nativePath;
1907     llvm::sys::path::native(filename.str(), nativePath);
1908     llvm::sys::path::remove_dots(nativePath, /*remove_dot_dot=*/true);
1909     for (unsigned i = 0, e = nativePath.size(); i != e; ++i) {
1910       if (nativePath[i] == '#') {
1911         os << '\\';
1912       } else if (nativePath[i] == ' ') {
1913         os << '\\';
1914         unsigned j = i;
1915         while (j > 0 && nativePath[--j] == '\\')
1916           os << '\\';
1917       } else if (nativePath[i] == '$') {
1918         os << '$';
1919       }
1920       os << nativePath[i];
1921     }
1922   };
1923 
1924   os << config->outputFile << ":";
1925   for (StringRef path : config->dependencyFiles) {
1926     os << " \\\n ";
1927     printFilename(os, path);
1928   }
1929   os << "\n";
1930 
1931   for (StringRef path : config->dependencyFiles) {
1932     os << "\n";
1933     printFilename(os, path);
1934     os << ":\n";
1935   }
1936 }
1937 
1938 // Replaces common symbols with defined symbols reside in .bss sections.
1939 // This function is called after all symbol names are resolved. As a
1940 // result, the passes after the symbol resolution won't see any
1941 // symbols of type CommonSymbol.
1942 static void replaceCommonSymbols() {
1943   llvm::TimeTraceScope timeScope("Replace common symbols");
1944   for (ELFFileBase *file : objectFiles) {
1945     if (!file->hasCommonSyms)
1946       continue;
1947     for (Symbol *sym : file->getGlobalSymbols()) {
1948       auto *s = dyn_cast<CommonSymbol>(sym);
1949       if (!s)
1950         continue;
1951 
1952       auto *bss = make<BssSection>("COMMON", s->size, s->alignment);
1953       bss->file = s->file;
1954       inputSections.push_back(bss);
1955       s->replace(Defined{s->file, StringRef(), s->binding, s->stOther, s->type,
1956                          /*value=*/0, s->size, bss});
1957     }
1958   }
1959 }
1960 
1961 // If all references to a DSO happen to be weak, the DSO is not added to
1962 // DT_NEEDED. If that happens, replace ShardSymbol with Undefined to avoid
1963 // dangling references to an unneeded DSO. Use a weak binding to avoid
1964 // --no-allow-shlib-undefined diagnostics. Similarly, demote lazy symbols.
1965 static void demoteSharedAndLazySymbols() {
1966   llvm::TimeTraceScope timeScope("Demote shared and lazy symbols");
1967   for (Symbol *sym : symtab->symbols()) {
1968     auto *s = dyn_cast<SharedSymbol>(sym);
1969     if (!(s && !cast<SharedFile>(s->file)->isNeeded) && !sym->isLazy())
1970       continue;
1971 
1972     bool used = sym->used;
1973     uint8_t binding = sym->isLazy() ? sym->binding : uint8_t(STB_WEAK);
1974     sym->replace(
1975         Undefined{nullptr, sym->getName(), binding, sym->stOther, sym->type});
1976     sym->used = used;
1977     sym->versionId = VER_NDX_GLOBAL;
1978   }
1979 }
1980 
1981 // The section referred to by `s` is considered address-significant. Set the
1982 // keepUnique flag on the section if appropriate.
1983 static void markAddrsig(Symbol *s) {
1984   if (auto *d = dyn_cast_or_null<Defined>(s))
1985     if (d->section)
1986       // We don't need to keep text sections unique under --icf=all even if they
1987       // are address-significant.
1988       if (config->icf == ICFLevel::Safe || !(d->section->flags & SHF_EXECINSTR))
1989         d->section->keepUnique = true;
1990 }
1991 
1992 // Record sections that define symbols mentioned in --keep-unique <symbol>
1993 // and symbols referred to by address-significance tables. These sections are
1994 // ineligible for ICF.
1995 template <class ELFT>
1996 static void findKeepUniqueSections(opt::InputArgList &args) {
1997   for (auto *arg : args.filtered(OPT_keep_unique)) {
1998     StringRef name = arg->getValue();
1999     auto *d = dyn_cast_or_null<Defined>(symtab->find(name));
2000     if (!d || !d->section) {
2001       warn("could not find symbol " + name + " to keep unique");
2002       continue;
2003     }
2004     d->section->keepUnique = true;
2005   }
2006 
2007   // --icf=all --ignore-data-address-equality means that we can ignore
2008   // the dynsym and address-significance tables entirely.
2009   if (config->icf == ICFLevel::All && config->ignoreDataAddressEquality)
2010     return;
2011 
2012   // Symbols in the dynsym could be address-significant in other executables
2013   // or DSOs, so we conservatively mark them as address-significant.
2014   for (Symbol *sym : symtab->symbols())
2015     if (sym->includeInDynsym())
2016       markAddrsig(sym);
2017 
2018   // Visit the address-significance table in each object file and mark each
2019   // referenced symbol as address-significant.
2020   for (InputFile *f : objectFiles) {
2021     auto *obj = cast<ObjFile<ELFT>>(f);
2022     ArrayRef<Symbol *> syms = obj->getSymbols();
2023     if (obj->addrsigSec) {
2024       ArrayRef<uint8_t> contents =
2025           check(obj->getObj().getSectionContents(*obj->addrsigSec));
2026       const uint8_t *cur = contents.begin();
2027       while (cur != contents.end()) {
2028         unsigned size;
2029         const char *err;
2030         uint64_t symIndex = decodeULEB128(cur, &size, contents.end(), &err);
2031         if (err)
2032           fatal(toString(f) + ": could not decode addrsig section: " + err);
2033         markAddrsig(syms[symIndex]);
2034         cur += size;
2035       }
2036     } else {
2037       // If an object file does not have an address-significance table,
2038       // conservatively mark all of its symbols as address-significant.
2039       for (Symbol *s : syms)
2040         markAddrsig(s);
2041     }
2042   }
2043 }
2044 
2045 // This function reads a symbol partition specification section. These sections
2046 // are used to control which partition a symbol is allocated to. See
2047 // https://lld.llvm.org/Partitions.html for more details on partitions.
2048 template <typename ELFT>
2049 static void readSymbolPartitionSection(InputSectionBase *s) {
2050   // Read the relocation that refers to the partition's entry point symbol.
2051   Symbol *sym;
2052   const RelsOrRelas<ELFT> rels = s->template relsOrRelas<ELFT>();
2053   if (rels.areRelocsRel())
2054     sym = &s->getFile<ELFT>()->getRelocTargetSym(rels.rels[0]);
2055   else
2056     sym = &s->getFile<ELFT>()->getRelocTargetSym(rels.relas[0]);
2057   if (!isa<Defined>(sym) || !sym->includeInDynsym())
2058     return;
2059 
2060   StringRef partName = reinterpret_cast<const char *>(s->rawData.data());
2061   for (Partition &part : partitions) {
2062     if (part.name == partName) {
2063       sym->partition = part.getNumber();
2064       return;
2065     }
2066   }
2067 
2068   // Forbid partitions from being used on incompatible targets, and forbid them
2069   // from being used together with various linker features that assume a single
2070   // set of output sections.
2071   if (script->hasSectionsCommand)
2072     error(toString(s->file) +
2073           ": partitions cannot be used with the SECTIONS command");
2074   if (script->hasPhdrsCommands())
2075     error(toString(s->file) +
2076           ": partitions cannot be used with the PHDRS command");
2077   if (!config->sectionStartMap.empty())
2078     error(toString(s->file) + ": partitions cannot be used with "
2079                               "--section-start, -Ttext, -Tdata or -Tbss");
2080   if (config->emachine == EM_MIPS)
2081     error(toString(s->file) + ": partitions cannot be used on this target");
2082 
2083   // Impose a limit of no more than 254 partitions. This limit comes from the
2084   // sizes of the Partition fields in InputSectionBase and Symbol, as well as
2085   // the amount of space devoted to the partition number in RankFlags.
2086   if (partitions.size() == 254)
2087     fatal("may not have more than 254 partitions");
2088 
2089   partitions.emplace_back();
2090   Partition &newPart = partitions.back();
2091   newPart.name = partName;
2092   sym->partition = newPart.getNumber();
2093 }
2094 
2095 static Symbol *addUnusedUndefined(StringRef name,
2096                                   uint8_t binding = STB_GLOBAL) {
2097   return symtab->addSymbol(Undefined{nullptr, name, binding, STV_DEFAULT, 0});
2098 }
2099 
2100 static void markBuffersAsDontNeed(bool skipLinkedOutput) {
2101   // With --thinlto-index-only, all buffers are nearly unused from now on
2102   // (except symbol/section names used by infrequent passes). Mark input file
2103   // buffers as MADV_DONTNEED so that these pages can be reused by the expensive
2104   // thin link, saving memory.
2105   if (skipLinkedOutput) {
2106     for (MemoryBuffer &mb : llvm::make_pointee_range(memoryBuffers))
2107       mb.dontNeedIfMmap();
2108     return;
2109   }
2110 
2111   // Otherwise, just mark MemoryBuffers backing BitcodeFiles.
2112   DenseSet<const char *> bufs;
2113   for (BitcodeFile *file : bitcodeFiles)
2114     bufs.insert(file->mb.getBufferStart());
2115   for (BitcodeFile *file : lazyBitcodeFiles)
2116     bufs.insert(file->mb.getBufferStart());
2117   for (MemoryBuffer &mb : llvm::make_pointee_range(memoryBuffers))
2118     if (bufs.count(mb.getBufferStart()))
2119       mb.dontNeedIfMmap();
2120 }
2121 
2122 // This function is where all the optimizations of link-time
2123 // optimization takes place. When LTO is in use, some input files are
2124 // not in native object file format but in the LLVM bitcode format.
2125 // This function compiles bitcode files into a few big native files
2126 // using LLVM functions and replaces bitcode symbols with the results.
2127 // Because all bitcode files that the program consists of are passed to
2128 // the compiler at once, it can do a whole-program optimization.
2129 template <class ELFT>
2130 void LinkerDriver::compileBitcodeFiles(bool skipLinkedOutput) {
2131   llvm::TimeTraceScope timeScope("LTO");
2132   // Compile bitcode files and replace bitcode symbols.
2133   lto.reset(new BitcodeCompiler);
2134   for (BitcodeFile *file : bitcodeFiles)
2135     lto->add(*file);
2136 
2137   if (!bitcodeFiles.empty())
2138     markBuffersAsDontNeed(skipLinkedOutput);
2139 
2140   for (InputFile *file : lto->compile()) {
2141     auto *obj = cast<ObjFile<ELFT>>(file);
2142     obj->parse(/*ignoreComdats=*/true);
2143 
2144     // Parse '@' in symbol names for non-relocatable output.
2145     if (!config->relocatable)
2146       for (Symbol *sym : obj->getGlobalSymbols())
2147         if (sym->hasVersionSuffix)
2148           sym->parseSymbolVersion();
2149     objectFiles.push_back(obj);
2150   }
2151 }
2152 
2153 // The --wrap option is a feature to rename symbols so that you can write
2154 // wrappers for existing functions. If you pass `--wrap=foo`, all
2155 // occurrences of symbol `foo` are resolved to `__wrap_foo` (so, you are
2156 // expected to write `__wrap_foo` function as a wrapper). The original
2157 // symbol becomes accessible as `__real_foo`, so you can call that from your
2158 // wrapper.
2159 //
2160 // This data structure is instantiated for each --wrap option.
2161 struct WrappedSymbol {
2162   Symbol *sym;
2163   Symbol *real;
2164   Symbol *wrap;
2165 };
2166 
2167 // Handles --wrap option.
2168 //
2169 // This function instantiates wrapper symbols. At this point, they seem
2170 // like they are not being used at all, so we explicitly set some flags so
2171 // that LTO won't eliminate them.
2172 static std::vector<WrappedSymbol> addWrappedSymbols(opt::InputArgList &args) {
2173   std::vector<WrappedSymbol> v;
2174   DenseSet<StringRef> seen;
2175 
2176   for (auto *arg : args.filtered(OPT_wrap)) {
2177     StringRef name = arg->getValue();
2178     if (!seen.insert(name).second)
2179       continue;
2180 
2181     Symbol *sym = symtab->find(name);
2182     // Avoid wrapping symbols that are lazy and unreferenced at this point, to
2183     // not create undefined references. The isUsedInRegularObj check handles the
2184     // case of a weak reference, which we still want to wrap even though it
2185     // doesn't cause lazy symbols to be extracted.
2186     if (!sym || (sym->isLazy() && !sym->isUsedInRegularObj))
2187       continue;
2188 
2189     Symbol *real = addUnusedUndefined(saver().save("__real_" + name));
2190     Symbol *wrap =
2191         addUnusedUndefined(saver().save("__wrap_" + name), sym->binding);
2192     v.push_back({sym, real, wrap});
2193 
2194     // We want to tell LTO not to inline symbols to be overwritten
2195     // because LTO doesn't know the final symbol contents after renaming.
2196     real->scriptDefined = true;
2197     sym->scriptDefined = true;
2198 
2199     // Tell LTO not to eliminate these symbols.
2200     sym->isUsedInRegularObj = true;
2201     // If sym is referenced in any object file, bitcode file or shared object,
2202     // retain wrap which is the redirection target of sym. If the object file
2203     // defining sym has sym references, we cannot easily distinguish the case
2204     // from cases where sym is not referenced. Retain wrap because we choose to
2205     // wrap sym references regardless of whether sym is defined
2206     // (https://sourceware.org/bugzilla/show_bug.cgi?id=26358).
2207     if (sym->referenced || sym->isDefined())
2208       wrap->isUsedInRegularObj = true;
2209   }
2210   return v;
2211 }
2212 
2213 // Do renaming for --wrap and foo@v1 by updating pointers to symbols.
2214 //
2215 // When this function is executed, only InputFiles and symbol table
2216 // contain pointers to symbol objects. We visit them to replace pointers,
2217 // so that wrapped symbols are swapped as instructed by the command line.
2218 static void redirectSymbols(ArrayRef<WrappedSymbol> wrapped) {
2219   llvm::TimeTraceScope timeScope("Redirect symbols");
2220   DenseMap<Symbol *, Symbol *> map;
2221   for (const WrappedSymbol &w : wrapped) {
2222     map[w.sym] = w.wrap;
2223     map[w.real] = w.sym;
2224   }
2225   for (Symbol *sym : symtab->symbols()) {
2226     // Enumerate symbols with a non-default version (foo@v1). hasVersionSuffix
2227     // filters out most symbols but is not sufficient.
2228     if (!sym->hasVersionSuffix)
2229       continue;
2230     const char *suffix1 = sym->getVersionSuffix();
2231     if (suffix1[0] != '@' || suffix1[1] == '@')
2232       continue;
2233 
2234     // Check the existing symbol foo. We have two special cases to handle:
2235     //
2236     // * There is a definition of foo@v1 and foo@@v1.
2237     // * There is a definition of foo@v1 and foo.
2238     Defined *sym2 = dyn_cast_or_null<Defined>(symtab->find(sym->getName()));
2239     if (!sym2)
2240       continue;
2241     const char *suffix2 = sym2->getVersionSuffix();
2242     if (suffix2[0] == '@' && suffix2[1] == '@' &&
2243         strcmp(suffix1 + 1, suffix2 + 2) == 0) {
2244       // foo@v1 and foo@@v1 should be merged, so redirect foo@v1 to foo@@v1.
2245       map.try_emplace(sym, sym2);
2246       // If both foo@v1 and foo@@v1 are defined and non-weak, report a duplicate
2247       // definition error.
2248       if (sym->isDefined())
2249         sym2->checkDuplicate(cast<Defined>(*sym));
2250       sym2->resolve(*sym);
2251       // Eliminate foo@v1 from the symbol table.
2252       sym->symbolKind = Symbol::PlaceholderKind;
2253       sym->isUsedInRegularObj = false;
2254     } else if (auto *sym1 = dyn_cast<Defined>(sym)) {
2255       if (sym2->versionId > VER_NDX_GLOBAL
2256               ? config->versionDefinitions[sym2->versionId].name == suffix1 + 1
2257               : sym1->section == sym2->section && sym1->value == sym2->value) {
2258         // Due to an assembler design flaw, if foo is defined, .symver foo,
2259         // foo@v1 defines both foo and foo@v1. Unless foo is bound to a
2260         // different version, GNU ld makes foo@v1 canonical and eliminates foo.
2261         // Emulate its behavior, otherwise we would have foo or foo@@v1 beside
2262         // foo@v1. foo@v1 and foo combining does not apply if they are not
2263         // defined in the same place.
2264         map.try_emplace(sym2, sym);
2265         sym2->symbolKind = Symbol::PlaceholderKind;
2266         sym2->isUsedInRegularObj = false;
2267       }
2268     }
2269   }
2270 
2271   if (map.empty())
2272     return;
2273 
2274   // Update pointers in input files.
2275   parallelForEach(objectFiles, [&](ELFFileBase *file) {
2276     for (Symbol *&sym : file->getMutableGlobalSymbols())
2277       if (Symbol *s = map.lookup(sym))
2278         sym = s;
2279   });
2280 
2281   // Update pointers in the symbol table.
2282   for (const WrappedSymbol &w : wrapped)
2283     symtab->wrap(w.sym, w.real, w.wrap);
2284 }
2285 
2286 static void checkAndReportMissingFeature(StringRef config, uint32_t features,
2287                                          uint32_t mask, const Twine &report) {
2288   if (!(features & mask)) {
2289     if (config == "error")
2290       error(report);
2291     else if (config == "warning")
2292       warn(report);
2293   }
2294 }
2295 
2296 // To enable CET (x86's hardware-assited control flow enforcement), each
2297 // source file must be compiled with -fcf-protection. Object files compiled
2298 // with the flag contain feature flags indicating that they are compatible
2299 // with CET. We enable the feature only when all object files are compatible
2300 // with CET.
2301 //
2302 // This is also the case with AARCH64's BTI and PAC which use the similar
2303 // GNU_PROPERTY_AARCH64_FEATURE_1_AND mechanism.
2304 static uint32_t getAndFeatures() {
2305   if (config->emachine != EM_386 && config->emachine != EM_X86_64 &&
2306       config->emachine != EM_AARCH64)
2307     return 0;
2308 
2309   uint32_t ret = -1;
2310   for (ELFFileBase *f : objectFiles) {
2311     uint32_t features = f->andFeatures;
2312 
2313     checkAndReportMissingFeature(
2314         config->zBtiReport, features, GNU_PROPERTY_AARCH64_FEATURE_1_BTI,
2315         toString(f) + ": -z bti-report: file does not have "
2316                       "GNU_PROPERTY_AARCH64_FEATURE_1_BTI property");
2317 
2318     checkAndReportMissingFeature(
2319         config->zCetReport, features, GNU_PROPERTY_X86_FEATURE_1_IBT,
2320         toString(f) + ": -z cet-report: file does not have "
2321                       "GNU_PROPERTY_X86_FEATURE_1_IBT property");
2322 
2323     checkAndReportMissingFeature(
2324         config->zCetReport, features, GNU_PROPERTY_X86_FEATURE_1_SHSTK,
2325         toString(f) + ": -z cet-report: file does not have "
2326                       "GNU_PROPERTY_X86_FEATURE_1_SHSTK property");
2327 
2328     if (config->zForceBti && !(features & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)) {
2329       features |= GNU_PROPERTY_AARCH64_FEATURE_1_BTI;
2330       if (config->zBtiReport == "none")
2331         warn(toString(f) + ": -z force-bti: file does not have "
2332                            "GNU_PROPERTY_AARCH64_FEATURE_1_BTI property");
2333     } else if (config->zForceIbt &&
2334                !(features & GNU_PROPERTY_X86_FEATURE_1_IBT)) {
2335       if (config->zCetReport == "none")
2336         warn(toString(f) + ": -z force-ibt: file does not have "
2337                            "GNU_PROPERTY_X86_FEATURE_1_IBT property");
2338       features |= GNU_PROPERTY_X86_FEATURE_1_IBT;
2339     }
2340     if (config->zPacPlt && !(features & GNU_PROPERTY_AARCH64_FEATURE_1_PAC)) {
2341       warn(toString(f) + ": -z pac-plt: file does not have "
2342                          "GNU_PROPERTY_AARCH64_FEATURE_1_PAC property");
2343       features |= GNU_PROPERTY_AARCH64_FEATURE_1_PAC;
2344     }
2345     ret &= features;
2346   }
2347 
2348   // Force enable Shadow Stack.
2349   if (config->zShstk)
2350     ret |= GNU_PROPERTY_X86_FEATURE_1_SHSTK;
2351 
2352   return ret;
2353 }
2354 
2355 static void initializeLocalSymbols(ELFFileBase *file) {
2356   switch (config->ekind) {
2357   case ELF32LEKind:
2358     cast<ObjFile<ELF32LE>>(file)->initializeLocalSymbols();
2359     break;
2360   case ELF32BEKind:
2361     cast<ObjFile<ELF32BE>>(file)->initializeLocalSymbols();
2362     break;
2363   case ELF64LEKind:
2364     cast<ObjFile<ELF64LE>>(file)->initializeLocalSymbols();
2365     break;
2366   case ELF64BEKind:
2367     cast<ObjFile<ELF64BE>>(file)->initializeLocalSymbols();
2368     break;
2369   default:
2370     llvm_unreachable("");
2371   }
2372 }
2373 
2374 static void postParseObjectFile(ELFFileBase *file) {
2375   switch (config->ekind) {
2376   case ELF32LEKind:
2377     cast<ObjFile<ELF32LE>>(file)->postParse();
2378     break;
2379   case ELF32BEKind:
2380     cast<ObjFile<ELF32BE>>(file)->postParse();
2381     break;
2382   case ELF64LEKind:
2383     cast<ObjFile<ELF64LE>>(file)->postParse();
2384     break;
2385   case ELF64BEKind:
2386     cast<ObjFile<ELF64BE>>(file)->postParse();
2387     break;
2388   default:
2389     llvm_unreachable("");
2390   }
2391 }
2392 
2393 // Do actual linking. Note that when this function is called,
2394 // all linker scripts have already been parsed.
2395 void LinkerDriver::link(opt::InputArgList &args) {
2396   llvm::TimeTraceScope timeScope("Link", StringRef("LinkerDriver::Link"));
2397   // If a --hash-style option was not given, set to a default value,
2398   // which varies depending on the target.
2399   if (!args.hasArg(OPT_hash_style)) {
2400     if (config->emachine == EM_MIPS)
2401       config->sysvHash = true;
2402     else
2403       config->sysvHash = config->gnuHash = true;
2404   }
2405 
2406   // Default output filename is "a.out" by the Unix tradition.
2407   if (config->outputFile.empty())
2408     config->outputFile = "a.out";
2409 
2410   // Fail early if the output file or map file is not writable. If a user has a
2411   // long link, e.g. due to a large LTO link, they do not wish to run it and
2412   // find that it failed because there was a mistake in their command-line.
2413   {
2414     llvm::TimeTraceScope timeScope("Create output files");
2415     if (auto e = tryCreateFile(config->outputFile))
2416       error("cannot open output file " + config->outputFile + ": " +
2417             e.message());
2418     if (auto e = tryCreateFile(config->mapFile))
2419       error("cannot open map file " + config->mapFile + ": " + e.message());
2420     if (auto e = tryCreateFile(config->whyExtract))
2421       error("cannot open --why-extract= file " + config->whyExtract + ": " +
2422             e.message());
2423   }
2424   if (errorCount())
2425     return;
2426 
2427   // Use default entry point name if no name was given via the command
2428   // line nor linker scripts. For some reason, MIPS entry point name is
2429   // different from others.
2430   config->warnMissingEntry =
2431       (!config->entry.empty() || (!config->shared && !config->relocatable));
2432   if (config->entry.empty() && !config->relocatable)
2433     config->entry = (config->emachine == EM_MIPS) ? "__start" : "_start";
2434 
2435   // Handle --trace-symbol.
2436   for (auto *arg : args.filtered(OPT_trace_symbol))
2437     symtab->insert(arg->getValue())->traced = true;
2438 
2439   // Handle -u/--undefined before input files. If both a.a and b.so define foo,
2440   // -u foo a.a b.so will extract a.a.
2441   for (StringRef name : config->undefined)
2442     addUnusedUndefined(name)->referenced = true;
2443 
2444   // Add all files to the symbol table. This will add almost all
2445   // symbols that we need to the symbol table. This process might
2446   // add files to the link, via autolinking, these files are always
2447   // appended to the Files vector.
2448   {
2449     llvm::TimeTraceScope timeScope("Parse input files");
2450     for (size_t i = 0; i < files.size(); ++i) {
2451       llvm::TimeTraceScope timeScope("Parse input files", files[i]->getName());
2452       parseFile(files[i]);
2453     }
2454   }
2455 
2456   // Now that we have every file, we can decide if we will need a
2457   // dynamic symbol table.
2458   // We need one if we were asked to export dynamic symbols or if we are
2459   // producing a shared library.
2460   // We also need one if any shared libraries are used and for pie executables
2461   // (probably because the dynamic linker needs it).
2462   config->hasDynSymTab =
2463       !sharedFiles.empty() || config->isPic || config->exportDynamic;
2464 
2465   // Some symbols (such as __ehdr_start) are defined lazily only when there
2466   // are undefined symbols for them, so we add these to trigger that logic.
2467   for (StringRef name : script->referencedSymbols)
2468     addUnusedUndefined(name)->isUsedInRegularObj = true;
2469 
2470   // Prevent LTO from removing any definition referenced by -u.
2471   for (StringRef name : config->undefined)
2472     if (Defined *sym = dyn_cast_or_null<Defined>(symtab->find(name)))
2473       sym->isUsedInRegularObj = true;
2474 
2475   // If an entry symbol is in a static archive, pull out that file now.
2476   if (Symbol *sym = symtab->find(config->entry))
2477     handleUndefined(sym, "--entry");
2478 
2479   // Handle the `--undefined-glob <pattern>` options.
2480   for (StringRef pat : args::getStrings(args, OPT_undefined_glob))
2481     handleUndefinedGlob(pat);
2482 
2483   // Mark -init and -fini symbols so that the LTO doesn't eliminate them.
2484   if (Symbol *sym = dyn_cast_or_null<Defined>(symtab->find(config->init)))
2485     sym->isUsedInRegularObj = true;
2486   if (Symbol *sym = dyn_cast_or_null<Defined>(symtab->find(config->fini)))
2487     sym->isUsedInRegularObj = true;
2488 
2489   // If any of our inputs are bitcode files, the LTO code generator may create
2490   // references to certain library functions that might not be explicit in the
2491   // bitcode file's symbol table. If any of those library functions are defined
2492   // in a bitcode file in an archive member, we need to arrange to use LTO to
2493   // compile those archive members by adding them to the link beforehand.
2494   //
2495   // However, adding all libcall symbols to the link can have undesired
2496   // consequences. For example, the libgcc implementation of
2497   // __sync_val_compare_and_swap_8 on 32-bit ARM pulls in an .init_array entry
2498   // that aborts the program if the Linux kernel does not support 64-bit
2499   // atomics, which would prevent the program from running even if it does not
2500   // use 64-bit atomics.
2501   //
2502   // Therefore, we only add libcall symbols to the link before LTO if we have
2503   // to, i.e. if the symbol's definition is in bitcode. Any other required
2504   // libcall symbols will be added to the link after LTO when we add the LTO
2505   // object file to the link.
2506   if (!bitcodeFiles.empty())
2507     for (auto *s : lto::LTO::getRuntimeLibcallSymbols())
2508       handleLibcall(s);
2509 
2510   // Archive members defining __wrap symbols may be extracted.
2511   std::vector<WrappedSymbol> wrapped = addWrappedSymbols(args);
2512 
2513   // No more lazy bitcode can be extracted at this point. Do post parse work
2514   // like checking duplicate symbols.
2515   parallelForEach(objectFiles, initializeLocalSymbols);
2516   parallelForEach(objectFiles, postParseObjectFile);
2517   parallelForEach(bitcodeFiles, [](BitcodeFile *file) { file->postParse(); });
2518   for (auto &it : ctx->nonPrevailingSyms) {
2519     Symbol &sym = *it.first;
2520     sym.replace(Undefined{sym.file, sym.getName(), sym.binding, sym.stOther,
2521                           sym.type, it.second});
2522     cast<Undefined>(sym).nonPrevailing = true;
2523   }
2524   ctx->nonPrevailingSyms.clear();
2525   for (const DuplicateSymbol &d : ctx->duplicates)
2526     reportDuplicate(*d.sym, d.file, d.section, d.value);
2527   ctx->duplicates.clear();
2528 
2529   // Return if there were name resolution errors.
2530   if (errorCount())
2531     return;
2532 
2533   // We want to declare linker script's symbols early,
2534   // so that we can version them.
2535   // They also might be exported if referenced by DSOs.
2536   script->declareSymbols();
2537 
2538   // Handle --exclude-libs. This is before scanVersionScript() due to a
2539   // workaround for Android ndk: for a defined versioned symbol in an archive
2540   // without a version node in the version script, Android does not expect a
2541   // 'has undefined version' error in -shared --exclude-libs=ALL mode (PR36295).
2542   // GNU ld errors in this case.
2543   if (args.hasArg(OPT_exclude_libs))
2544     excludeLibs(args);
2545 
2546   // Create elfHeader early. We need a dummy section in
2547   // addReservedSymbols to mark the created symbols as not absolute.
2548   Out::elfHeader = make<OutputSection>("", 0, SHF_ALLOC);
2549 
2550   // We need to create some reserved symbols such as _end. Create them.
2551   if (!config->relocatable)
2552     addReservedSymbols();
2553 
2554   // Apply version scripts.
2555   //
2556   // For a relocatable output, version scripts don't make sense, and
2557   // parsing a symbol version string (e.g. dropping "@ver1" from a symbol
2558   // name "foo@ver1") rather do harm, so we don't call this if -r is given.
2559   if (!config->relocatable) {
2560     llvm::TimeTraceScope timeScope("Process symbol versions");
2561     symtab->scanVersionScript();
2562   }
2563 
2564   // Skip the normal linked output if some LTO options are specified.
2565   //
2566   // For --thinlto-index-only, index file creation is performed in
2567   // compileBitcodeFiles, so we are done afterwards. --plugin-opt=emit-llvm and
2568   // --plugin-opt=emit-asm create output files in bitcode or assembly code,
2569   // respectively. When only certain thinLTO modules are specified for
2570   // compilation, the intermediate object file are the expected output.
2571   const bool skipLinkedOutput = config->thinLTOIndexOnly || config->emitLLVM ||
2572                                 config->ltoEmitAsm ||
2573                                 !config->thinLTOModulesToCompile.empty();
2574 
2575   // Do link-time optimization if given files are LLVM bitcode files.
2576   // This compiles bitcode files into real object files.
2577   //
2578   // With this the symbol table should be complete. After this, no new names
2579   // except a few linker-synthesized ones will be added to the symbol table.
2580   const size_t numObjsBeforeLTO = objectFiles.size();
2581   invokeELFT(compileBitcodeFiles, skipLinkedOutput);
2582 
2583   // Symbol resolution finished. Report backward reference problems,
2584   // --print-archive-stats=, and --why-extract=.
2585   reportBackrefs();
2586   writeArchiveStats();
2587   writeWhyExtract();
2588   if (errorCount())
2589     return;
2590 
2591   // Bail out if normal linked output is skipped due to LTO.
2592   if (skipLinkedOutput)
2593     return;
2594 
2595   // compileBitcodeFiles may have produced lto.tmp object files. After this, no
2596   // more file will be added.
2597   auto newObjectFiles = makeArrayRef(objectFiles).slice(numObjsBeforeLTO);
2598   parallelForEach(newObjectFiles, initializeLocalSymbols);
2599   parallelForEach(newObjectFiles, postParseObjectFile);
2600   for (const DuplicateSymbol &d : ctx->duplicates)
2601     reportDuplicate(*d.sym, d.file, d.section, d.value);
2602 
2603   // Handle --exclude-libs again because lto.tmp may reference additional
2604   // libcalls symbols defined in an excluded archive. This may override
2605   // versionId set by scanVersionScript().
2606   if (args.hasArg(OPT_exclude_libs))
2607     excludeLibs(args);
2608 
2609   // Apply symbol renames for --wrap and combine foo@v1 and foo@@v1.
2610   redirectSymbols(wrapped);
2611 
2612   // Replace common symbols with regular symbols.
2613   replaceCommonSymbols();
2614 
2615   {
2616     llvm::TimeTraceScope timeScope("Aggregate sections");
2617     // Now that we have a complete list of input files.
2618     // Beyond this point, no new files are added.
2619     // Aggregate all input sections into one place.
2620     for (InputFile *f : objectFiles)
2621       for (InputSectionBase *s : f->getSections())
2622         if (s && s != &InputSection::discarded)
2623           inputSections.push_back(s);
2624     for (BinaryFile *f : binaryFiles)
2625       for (InputSectionBase *s : f->getSections())
2626         inputSections.push_back(cast<InputSection>(s));
2627   }
2628 
2629   {
2630     llvm::TimeTraceScope timeScope("Strip sections");
2631     if (ctx->hasSympart.load(std::memory_order_relaxed)) {
2632       llvm::erase_if(inputSections, [](InputSectionBase *s) {
2633         if (s->type != SHT_LLVM_SYMPART)
2634           return false;
2635         invokeELFT(readSymbolPartitionSection, s);
2636         return true;
2637       });
2638     }
2639     // We do not want to emit debug sections if --strip-all
2640     // or --strip-debug are given.
2641     if (config->strip != StripPolicy::None) {
2642       llvm::erase_if(inputSections, [](InputSectionBase *s) {
2643         if (isDebugSection(*s))
2644           return true;
2645         if (auto *isec = dyn_cast<InputSection>(s))
2646           if (InputSectionBase *rel = isec->getRelocatedSection())
2647             if (isDebugSection(*rel))
2648               return true;
2649 
2650         return false;
2651       });
2652     }
2653   }
2654 
2655   // Since we now have a complete set of input files, we can create
2656   // a .d file to record build dependencies.
2657   if (!config->dependencyFile.empty())
2658     writeDependencyFile();
2659 
2660   // Now that the number of partitions is fixed, save a pointer to the main
2661   // partition.
2662   mainPart = &partitions[0];
2663 
2664   // Read .note.gnu.property sections from input object files which
2665   // contain a hint to tweak linker's and loader's behaviors.
2666   config->andFeatures = getAndFeatures();
2667 
2668   // The Target instance handles target-specific stuff, such as applying
2669   // relocations or writing a PLT section. It also contains target-dependent
2670   // values such as a default image base address.
2671   target = getTarget();
2672 
2673   config->eflags = target->calcEFlags();
2674   // maxPageSize (sometimes called abi page size) is the maximum page size that
2675   // the output can be run on. For example if the OS can use 4k or 64k page
2676   // sizes then maxPageSize must be 64k for the output to be useable on both.
2677   // All important alignment decisions must use this value.
2678   config->maxPageSize = getMaxPageSize(args);
2679   // commonPageSize is the most common page size that the output will be run on.
2680   // For example if an OS can use 4k or 64k page sizes and 4k is more common
2681   // than 64k then commonPageSize is set to 4k. commonPageSize can be used for
2682   // optimizations such as DATA_SEGMENT_ALIGN in linker scripts. LLD's use of it
2683   // is limited to writing trap instructions on the last executable segment.
2684   config->commonPageSize = getCommonPageSize(args);
2685 
2686   config->imageBase = getImageBase(args);
2687 
2688   if (config->emachine == EM_ARM) {
2689     // FIXME: These warnings can be removed when lld only uses these features
2690     // when the input objects have been compiled with an architecture that
2691     // supports them.
2692     if (config->armHasBlx == false)
2693       warn("lld uses blx instruction, no object with architecture supporting "
2694            "feature detected");
2695   }
2696 
2697   // This adds a .comment section containing a version string.
2698   if (!config->relocatable)
2699     inputSections.push_back(createCommentSection());
2700 
2701   // Split SHF_MERGE and .eh_frame sections into pieces in preparation for garbage collection.
2702   invokeELFT(splitSections);
2703 
2704   // Garbage collection and removal of shared symbols from unused shared objects.
2705   invokeELFT(markLive);
2706   demoteSharedAndLazySymbols();
2707 
2708   // Make copies of any input sections that need to be copied into each
2709   // partition.
2710   copySectionsIntoPartitions();
2711 
2712   // Create synthesized sections such as .got and .plt. This is called before
2713   // processSectionCommands() so that they can be placed by SECTIONS commands.
2714   invokeELFT(createSyntheticSections);
2715 
2716   // Some input sections that are used for exception handling need to be moved
2717   // into synthetic sections. Do that now so that they aren't assigned to
2718   // output sections in the usual way.
2719   if (!config->relocatable)
2720     combineEhSections();
2721 
2722   {
2723     llvm::TimeTraceScope timeScope("Assign sections");
2724 
2725     // Create output sections described by SECTIONS commands.
2726     script->processSectionCommands();
2727 
2728     // Linker scripts control how input sections are assigned to output
2729     // sections. Input sections that were not handled by scripts are called
2730     // "orphans", and they are assigned to output sections by the default rule.
2731     // Process that.
2732     script->addOrphanSections();
2733   }
2734 
2735   {
2736     llvm::TimeTraceScope timeScope("Merge/finalize input sections");
2737 
2738     // Migrate InputSectionDescription::sectionBases to sections. This includes
2739     // merging MergeInputSections into a single MergeSyntheticSection. From this
2740     // point onwards InputSectionDescription::sections should be used instead of
2741     // sectionBases.
2742     for (SectionCommand *cmd : script->sectionCommands)
2743       if (auto *osd = dyn_cast<OutputDesc>(cmd))
2744         osd->osec.finalizeInputSections();
2745     llvm::erase_if(inputSections, [](InputSectionBase *s) {
2746       return isa<MergeInputSection>(s);
2747     });
2748   }
2749 
2750   // Two input sections with different output sections should not be folded.
2751   // ICF runs after processSectionCommands() so that we know the output sections.
2752   if (config->icf != ICFLevel::None) {
2753     invokeELFT(findKeepUniqueSections, args);
2754     invokeELFT(doIcf);
2755   }
2756 
2757   // Read the callgraph now that we know what was gced or icfed
2758   if (config->callGraphProfileSort) {
2759     if (auto *arg = args.getLastArg(OPT_call_graph_ordering_file))
2760       if (Optional<MemoryBufferRef> buffer = readFile(arg->getValue()))
2761         readCallGraph(*buffer);
2762     invokeELFT(readCallGraphsFromObjectFiles);
2763   }
2764 
2765   // Write the result to the file.
2766   invokeELFT(writeResult);
2767 }
2768