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