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