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