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