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