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