1 //===- InputFiles.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 #include "InputFiles.h"
10 #include "Driver.h"
11 #include "InputSection.h"
12 #include "LinkerScript.h"
13 #include "SymbolTable.h"
14 #include "Symbols.h"
15 #include "SyntheticSections.h"
16 #include "lld/Common/DWARF.h"
17 #include "lld/Common/ErrorHandler.h"
18 #include "lld/Common/Memory.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/CodeGen/Analysis.h"
21 #include "llvm/IR/LLVMContext.h"
22 #include "llvm/IR/Module.h"
23 #include "llvm/LTO/LTO.h"
24 #include "llvm/MC/StringTableBuilder.h"
25 #include "llvm/Object/ELFObjectFile.h"
26 #include "llvm/Support/ARMAttributeParser.h"
27 #include "llvm/Support/ARMBuildAttributes.h"
28 #include "llvm/Support/Endian.h"
29 #include "llvm/Support/Path.h"
30 #include "llvm/Support/RISCVAttributeParser.h"
31 #include "llvm/Support/TarWriter.h"
32 #include "llvm/Support/raw_ostream.h"
33 
34 using namespace llvm;
35 using namespace llvm::ELF;
36 using namespace llvm::object;
37 using namespace llvm::sys;
38 using namespace llvm::sys::fs;
39 using namespace llvm::support::endian;
40 using namespace lld;
41 using namespace lld::elf;
42 
43 bool InputFile::isInGroup;
44 uint32_t InputFile::nextGroupId;
45 
46 std::vector<ArchiveFile *> elf::archiveFiles;
47 std::vector<BinaryFile *> elf::binaryFiles;
48 std::vector<BitcodeFile *> elf::bitcodeFiles;
49 std::vector<LazyObjFile *> elf::lazyObjFiles;
50 std::vector<InputFile *> elf::objectFiles;
51 std::vector<SharedFile *> elf::sharedFiles;
52 
53 std::unique_ptr<TarWriter> elf::tar;
54 
55 // Returns "<internal>", "foo.a(bar.o)" or "baz.o".
56 std::string lld::toString(const InputFile *f) {
57   if (!f)
58     return "<internal>";
59 
60   if (f->toStringCache.empty()) {
61     if (f->archiveName.empty())
62       f->toStringCache = std::string(f->getName());
63     else
64       f->toStringCache = (f->archiveName + "(" + f->getName() + ")").str();
65   }
66   return f->toStringCache;
67 }
68 
69 static ELFKind getELFKind(MemoryBufferRef mb, StringRef archiveName) {
70   unsigned char size;
71   unsigned char endian;
72   std::tie(size, endian) = getElfArchType(mb.getBuffer());
73 
74   auto report = [&](StringRef msg) {
75     StringRef filename = mb.getBufferIdentifier();
76     if (archiveName.empty())
77       fatal(filename + ": " + msg);
78     else
79       fatal(archiveName + "(" + filename + "): " + msg);
80   };
81 
82   if (!mb.getBuffer().startswith(ElfMagic))
83     report("not an ELF file");
84   if (endian != ELFDATA2LSB && endian != ELFDATA2MSB)
85     report("corrupted ELF file: invalid data encoding");
86   if (size != ELFCLASS32 && size != ELFCLASS64)
87     report("corrupted ELF file: invalid file class");
88 
89   size_t bufSize = mb.getBuffer().size();
90   if ((size == ELFCLASS32 && bufSize < sizeof(Elf32_Ehdr)) ||
91       (size == ELFCLASS64 && bufSize < sizeof(Elf64_Ehdr)))
92     report("corrupted ELF file: file is too short");
93 
94   if (size == ELFCLASS32)
95     return (endian == ELFDATA2LSB) ? ELF32LEKind : ELF32BEKind;
96   return (endian == ELFDATA2LSB) ? ELF64LEKind : ELF64BEKind;
97 }
98 
99 InputFile::InputFile(Kind k, MemoryBufferRef m)
100     : mb(m), groupId(nextGroupId), fileKind(k) {
101   // All files within the same --{start,end}-group get the same group ID.
102   // Otherwise, a new file will get a new group ID.
103   if (!isInGroup)
104     ++nextGroupId;
105 }
106 
107 Optional<MemoryBufferRef> elf::readFile(StringRef path) {
108   llvm::TimeTraceScope timeScope("Load input files", path);
109 
110   // The --chroot option changes our virtual root directory.
111   // This is useful when you are dealing with files created by --reproduce.
112   if (!config->chroot.empty() && path.startswith("/"))
113     path = saver.save(config->chroot + path);
114 
115   log(path);
116   config->dependencyFiles.insert(llvm::CachedHashString(path));
117 
118   auto mbOrErr = MemoryBuffer::getFile(path, /*IsText=*/false,
119                                        /*RequiresNullTerminator=*/false);
120   if (auto ec = mbOrErr.getError()) {
121     error("cannot open " + path + ": " + ec.message());
122     return None;
123   }
124 
125   std::unique_ptr<MemoryBuffer> &mb = *mbOrErr;
126   MemoryBufferRef mbref = mb->getMemBufferRef();
127   make<std::unique_ptr<MemoryBuffer>>(std::move(mb)); // take MB ownership
128 
129   if (tar)
130     tar->append(relativeToRoot(path), mbref.getBuffer());
131   return mbref;
132 }
133 
134 // All input object files must be for the same architecture
135 // (e.g. it does not make sense to link x86 object files with
136 // MIPS object files.) This function checks for that error.
137 static bool isCompatible(InputFile *file) {
138   if (!file->isElf() && !isa<BitcodeFile>(file))
139     return true;
140 
141   if (file->ekind == config->ekind && file->emachine == config->emachine) {
142     if (config->emachine != EM_MIPS)
143       return true;
144     if (isMipsN32Abi(file) == config->mipsN32Abi)
145       return true;
146   }
147 
148   StringRef target =
149       !config->bfdname.empty() ? config->bfdname : config->emulation;
150   if (!target.empty()) {
151     error(toString(file) + " is incompatible with " + target);
152     return false;
153   }
154 
155   InputFile *existing;
156   if (!objectFiles.empty())
157     existing = objectFiles[0];
158   else if (!sharedFiles.empty())
159     existing = sharedFiles[0];
160   else if (!bitcodeFiles.empty())
161     existing = bitcodeFiles[0];
162   else
163     llvm_unreachable("Must have -m, OUTPUT_FORMAT or existing input file to "
164                      "determine target emulation");
165 
166   error(toString(file) + " is incompatible with " + toString(existing));
167   return false;
168 }
169 
170 template <class ELFT> static void doParseFile(InputFile *file) {
171   if (!isCompatible(file))
172     return;
173 
174   // Binary file
175   if (auto *f = dyn_cast<BinaryFile>(file)) {
176     binaryFiles.push_back(f);
177     f->parse();
178     return;
179   }
180 
181   // .a file
182   if (auto *f = dyn_cast<ArchiveFile>(file)) {
183     archiveFiles.push_back(f);
184     f->parse();
185     return;
186   }
187 
188   // Lazy object file
189   if (auto *f = dyn_cast<LazyObjFile>(file)) {
190     lazyObjFiles.push_back(f);
191     f->parse<ELFT>();
192     return;
193   }
194 
195   if (config->trace)
196     message(toString(file));
197 
198   // .so file
199   if (auto *f = dyn_cast<SharedFile>(file)) {
200     f->parse<ELFT>();
201     return;
202   }
203 
204   // LLVM bitcode file
205   if (auto *f = dyn_cast<BitcodeFile>(file)) {
206     bitcodeFiles.push_back(f);
207     f->parse<ELFT>();
208     return;
209   }
210 
211   // Regular object file
212   objectFiles.push_back(file);
213   cast<ObjFile<ELFT>>(file)->parse();
214 }
215 
216 // Add symbols in File to the symbol table.
217 void elf::parseFile(InputFile *file) {
218   switch (config->ekind) {
219   case ELF32LEKind:
220     doParseFile<ELF32LE>(file);
221     return;
222   case ELF32BEKind:
223     doParseFile<ELF32BE>(file);
224     return;
225   case ELF64LEKind:
226     doParseFile<ELF64LE>(file);
227     return;
228   case ELF64BEKind:
229     doParseFile<ELF64BE>(file);
230     return;
231   default:
232     llvm_unreachable("unknown ELFT");
233   }
234 }
235 
236 // Concatenates arguments to construct a string representing an error location.
237 static std::string createFileLineMsg(StringRef path, unsigned line) {
238   std::string filename = std::string(path::filename(path));
239   std::string lineno = ":" + std::to_string(line);
240   if (filename == path)
241     return filename + lineno;
242   return filename + lineno + " (" + path.str() + lineno + ")";
243 }
244 
245 template <class ELFT>
246 static std::string getSrcMsgAux(ObjFile<ELFT> &file, const Symbol &sym,
247                                 InputSectionBase &sec, uint64_t offset) {
248   // In DWARF, functions and variables are stored to different places.
249   // First, lookup a function for a given offset.
250   if (Optional<DILineInfo> info = file.getDILineInfo(&sec, offset))
251     return createFileLineMsg(info->FileName, info->Line);
252 
253   // If it failed, lookup again as a variable.
254   if (Optional<std::pair<std::string, unsigned>> fileLine =
255           file.getVariableLoc(sym.getName()))
256     return createFileLineMsg(fileLine->first, fileLine->second);
257 
258   // File.sourceFile contains STT_FILE symbol, and that is a last resort.
259   return std::string(file.sourceFile);
260 }
261 
262 std::string InputFile::getSrcMsg(const Symbol &sym, InputSectionBase &sec,
263                                  uint64_t offset) {
264   if (kind() != ObjKind)
265     return "";
266   switch (config->ekind) {
267   default:
268     llvm_unreachable("Invalid kind");
269   case ELF32LEKind:
270     return getSrcMsgAux(cast<ObjFile<ELF32LE>>(*this), sym, sec, offset);
271   case ELF32BEKind:
272     return getSrcMsgAux(cast<ObjFile<ELF32BE>>(*this), sym, sec, offset);
273   case ELF64LEKind:
274     return getSrcMsgAux(cast<ObjFile<ELF64LE>>(*this), sym, sec, offset);
275   case ELF64BEKind:
276     return getSrcMsgAux(cast<ObjFile<ELF64BE>>(*this), sym, sec, offset);
277   }
278 }
279 
280 StringRef InputFile::getNameForScript() const {
281   if (archiveName.empty())
282     return getName();
283 
284   if (nameForScriptCache.empty())
285     nameForScriptCache = (archiveName + Twine(':') + getName()).str();
286 
287   return nameForScriptCache;
288 }
289 
290 template <class ELFT> DWARFCache *ObjFile<ELFT>::getDwarf() {
291   llvm::call_once(initDwarf, [this]() {
292     dwarf = std::make_unique<DWARFCache>(std::make_unique<DWARFContext>(
293         std::make_unique<LLDDwarfObj<ELFT>>(this), "",
294         [&](Error err) { warn(getName() + ": " + toString(std::move(err))); },
295         [&](Error warning) {
296           warn(getName() + ": " + toString(std::move(warning)));
297         }));
298   });
299 
300   return dwarf.get();
301 }
302 
303 // Returns the pair of file name and line number describing location of data
304 // object (variable, array, etc) definition.
305 template <class ELFT>
306 Optional<std::pair<std::string, unsigned>>
307 ObjFile<ELFT>::getVariableLoc(StringRef name) {
308   return getDwarf()->getVariableLoc(name);
309 }
310 
311 // Returns source line information for a given offset
312 // using DWARF debug info.
313 template <class ELFT>
314 Optional<DILineInfo> ObjFile<ELFT>::getDILineInfo(InputSectionBase *s,
315                                                   uint64_t offset) {
316   // Detect SectionIndex for specified section.
317   uint64_t sectionIndex = object::SectionedAddress::UndefSection;
318   ArrayRef<InputSectionBase *> sections = s->file->getSections();
319   for (uint64_t curIndex = 0; curIndex < sections.size(); ++curIndex) {
320     if (s == sections[curIndex]) {
321       sectionIndex = curIndex;
322       break;
323     }
324   }
325 
326   return getDwarf()->getDILineInfo(offset, sectionIndex);
327 }
328 
329 ELFFileBase::ELFFileBase(Kind k, MemoryBufferRef mb) : InputFile(k, mb) {
330   ekind = getELFKind(mb, "");
331 
332   switch (ekind) {
333   case ELF32LEKind:
334     init<ELF32LE>();
335     break;
336   case ELF32BEKind:
337     init<ELF32BE>();
338     break;
339   case ELF64LEKind:
340     init<ELF64LE>();
341     break;
342   case ELF64BEKind:
343     init<ELF64BE>();
344     break;
345   default:
346     llvm_unreachable("getELFKind");
347   }
348 }
349 
350 template <typename Elf_Shdr>
351 static const Elf_Shdr *findSection(ArrayRef<Elf_Shdr> sections, uint32_t type) {
352   for (const Elf_Shdr &sec : sections)
353     if (sec.sh_type == type)
354       return &sec;
355   return nullptr;
356 }
357 
358 template <class ELFT> void ELFFileBase::init() {
359   using Elf_Shdr = typename ELFT::Shdr;
360   using Elf_Sym = typename ELFT::Sym;
361 
362   // Initialize trivial attributes.
363   const ELFFile<ELFT> &obj = getObj<ELFT>();
364   emachine = obj.getHeader().e_machine;
365   osabi = obj.getHeader().e_ident[llvm::ELF::EI_OSABI];
366   abiVersion = obj.getHeader().e_ident[llvm::ELF::EI_ABIVERSION];
367 
368   ArrayRef<Elf_Shdr> sections = CHECK(obj.sections(), this);
369 
370   // Find a symbol table.
371   bool isDSO =
372       (identify_magic(mb.getBuffer()) == file_magic::elf_shared_object);
373   const Elf_Shdr *symtabSec =
374       findSection(sections, isDSO ? SHT_DYNSYM : SHT_SYMTAB);
375 
376   if (!symtabSec)
377     return;
378 
379   // Initialize members corresponding to a symbol table.
380   firstGlobal = symtabSec->sh_info;
381 
382   ArrayRef<Elf_Sym> eSyms = CHECK(obj.symbols(symtabSec), this);
383   if (firstGlobal == 0 || firstGlobal > eSyms.size())
384     fatal(toString(this) + ": invalid sh_info in symbol table");
385 
386   elfSyms = reinterpret_cast<const void *>(eSyms.data());
387   numELFSyms = eSyms.size();
388   stringTable = CHECK(obj.getStringTableForSymtab(*symtabSec, sections), this);
389 }
390 
391 template <class ELFT>
392 uint32_t ObjFile<ELFT>::getSectionIndex(const Elf_Sym &sym) const {
393   return CHECK(
394       this->getObj().getSectionIndex(sym, getELFSyms<ELFT>(), shndxTable),
395       this);
396 }
397 
398 template <class ELFT> ArrayRef<Symbol *> ObjFile<ELFT>::getLocalSymbols() {
399   if (this->symbols.empty())
400     return {};
401   return makeArrayRef(this->symbols).slice(1, this->firstGlobal - 1);
402 }
403 
404 template <class ELFT> ArrayRef<Symbol *> ObjFile<ELFT>::getGlobalSymbols() {
405   return makeArrayRef(this->symbols).slice(this->firstGlobal);
406 }
407 
408 template <class ELFT> void ObjFile<ELFT>::parse(bool ignoreComdats) {
409   // Read a section table. justSymbols is usually false.
410   if (this->justSymbols)
411     initializeJustSymbols();
412   else
413     initializeSections(ignoreComdats);
414 
415   // Read a symbol table.
416   initializeSymbols();
417 }
418 
419 // Sections with SHT_GROUP and comdat bits define comdat section groups.
420 // They are identified and deduplicated by group name. This function
421 // returns a group name.
422 template <class ELFT>
423 StringRef ObjFile<ELFT>::getShtGroupSignature(ArrayRef<Elf_Shdr> sections,
424                                               const Elf_Shdr &sec) {
425   typename ELFT::SymRange symbols = this->getELFSyms<ELFT>();
426   if (sec.sh_info >= symbols.size())
427     fatal(toString(this) + ": invalid symbol index");
428   const typename ELFT::Sym &sym = symbols[sec.sh_info];
429   StringRef signature = CHECK(sym.getName(this->stringTable), this);
430 
431   // As a special case, if a symbol is a section symbol and has no name,
432   // we use a section name as a signature.
433   //
434   // Such SHT_GROUP sections are invalid from the perspective of the ELF
435   // standard, but GNU gold 1.14 (the newest version as of July 2017) or
436   // older produce such sections as outputs for the -r option, so we need
437   // a bug-compatibility.
438   if (signature.empty() && sym.getType() == STT_SECTION)
439     return getSectionName(sec);
440   return signature;
441 }
442 
443 template <class ELFT>
444 bool ObjFile<ELFT>::shouldMerge(const Elf_Shdr &sec, StringRef name) {
445   if (!(sec.sh_flags & SHF_MERGE))
446     return false;
447 
448   // On a regular link we don't merge sections if -O0 (default is -O1). This
449   // sometimes makes the linker significantly faster, although the output will
450   // be bigger.
451   //
452   // Doing the same for -r would create a problem as it would combine sections
453   // with different sh_entsize. One option would be to just copy every SHF_MERGE
454   // section as is to the output. While this would produce a valid ELF file with
455   // usable SHF_MERGE sections, tools like (llvm-)?dwarfdump get confused when
456   // they see two .debug_str. We could have separate logic for combining
457   // SHF_MERGE sections based both on their name and sh_entsize, but that seems
458   // to be more trouble than it is worth. Instead, we just use the regular (-O1)
459   // logic for -r.
460   if (config->optimize == 0 && !config->relocatable)
461     return false;
462 
463   // A mergeable section with size 0 is useless because they don't have
464   // any data to merge. A mergeable string section with size 0 can be
465   // argued as invalid because it doesn't end with a null character.
466   // We'll avoid a mess by handling them as if they were non-mergeable.
467   if (sec.sh_size == 0)
468     return false;
469 
470   // Check for sh_entsize. The ELF spec is not clear about the zero
471   // sh_entsize. It says that "the member [sh_entsize] contains 0 if
472   // the section does not hold a table of fixed-size entries". We know
473   // that Rust 1.13 produces a string mergeable section with a zero
474   // sh_entsize. Here we just accept it rather than being picky about it.
475   uint64_t entSize = sec.sh_entsize;
476   if (entSize == 0)
477     return false;
478   if (sec.sh_size % entSize)
479     fatal(toString(this) + ":(" + name + "): SHF_MERGE section size (" +
480           Twine(sec.sh_size) + ") must be a multiple of sh_entsize (" +
481           Twine(entSize) + ")");
482 
483   if (sec.sh_flags & SHF_WRITE)
484     fatal(toString(this) + ":(" + name +
485           "): writable SHF_MERGE section is not supported");
486 
487   return true;
488 }
489 
490 // This is for --just-symbols.
491 //
492 // --just-symbols is a very minor feature that allows you to link your
493 // output against other existing program, so that if you load both your
494 // program and the other program into memory, your output can refer the
495 // other program's symbols.
496 //
497 // When the option is given, we link "just symbols". The section table is
498 // initialized with null pointers.
499 template <class ELFT> void ObjFile<ELFT>::initializeJustSymbols() {
500   ArrayRef<Elf_Shdr> sections = CHECK(this->getObj().sections(), this);
501   this->sections.resize(sections.size());
502 }
503 
504 // An ELF object file may contain a `.deplibs` section. If it exists, the
505 // section contains a list of library specifiers such as `m` for libm. This
506 // function resolves a given name by finding the first matching library checking
507 // the various ways that a library can be specified to LLD. This ELF extension
508 // is a form of autolinking and is called `dependent libraries`. It is currently
509 // unique to LLVM and lld.
510 static void addDependentLibrary(StringRef specifier, const InputFile *f) {
511   if (!config->dependentLibraries)
512     return;
513   if (fs::exists(specifier))
514     driver->addFile(specifier, /*withLOption=*/false);
515   else if (Optional<std::string> s = findFromSearchPaths(specifier))
516     driver->addFile(*s, /*withLOption=*/true);
517   else if (Optional<std::string> s = searchLibraryBaseName(specifier))
518     driver->addFile(*s, /*withLOption=*/true);
519   else
520     error(toString(f) +
521           ": unable to find library from dependent library specifier: " +
522           specifier);
523 }
524 
525 // Record the membership of a section group so that in the garbage collection
526 // pass, section group members are kept or discarded as a unit.
527 template <class ELFT>
528 static void handleSectionGroup(ArrayRef<InputSectionBase *> sections,
529                                ArrayRef<typename ELFT::Word> entries) {
530   bool hasAlloc = false;
531   for (uint32_t index : entries.slice(1)) {
532     if (index >= sections.size())
533       return;
534     if (InputSectionBase *s = sections[index])
535       if (s != &InputSection::discarded && s->flags & SHF_ALLOC)
536         hasAlloc = true;
537   }
538 
539   // If any member has the SHF_ALLOC flag, the whole group is subject to garbage
540   // collection. See the comment in markLive(). This rule retains .debug_types
541   // and .rela.debug_types.
542   if (!hasAlloc)
543     return;
544 
545   // Connect the members in a circular doubly-linked list via
546   // nextInSectionGroup.
547   InputSectionBase *head;
548   InputSectionBase *prev = nullptr;
549   for (uint32_t index : entries.slice(1)) {
550     InputSectionBase *s = sections[index];
551     if (!s || s == &InputSection::discarded)
552       continue;
553     if (prev)
554       prev->nextInSectionGroup = s;
555     else
556       head = s;
557     prev = s;
558   }
559   if (prev)
560     prev->nextInSectionGroup = head;
561 }
562 
563 template <class ELFT>
564 void ObjFile<ELFT>::initializeSections(bool ignoreComdats) {
565   const ELFFile<ELFT> &obj = this->getObj();
566 
567   ArrayRef<Elf_Shdr> objSections = CHECK(obj.sections(), this);
568   uint64_t size = objSections.size();
569   this->sections.resize(size);
570   this->sectionStringTable =
571       CHECK(obj.getSectionStringTable(objSections), this);
572 
573   std::vector<ArrayRef<Elf_Word>> selectedGroups;
574   // SHT_LLVM_CALL_GRAPH_PROFILE Section Index.
575   size_t cgProfileSectionIndex = 0;
576 
577   for (size_t i = 0, e = objSections.size(); i < e; ++i) {
578     if (this->sections[i] == &InputSection::discarded)
579       continue;
580     const Elf_Shdr &sec = objSections[i];
581 
582     if (sec.sh_type == ELF::SHT_LLVM_CALL_GRAPH_PROFILE) {
583       cgProfile =
584           check(obj.template getSectionContentsAsArray<Elf_CGProfile>(sec));
585       cgProfileSectionIndex = i;
586     }
587 
588     // SHF_EXCLUDE'ed sections are discarded by the linker. However,
589     // if -r is given, we'll let the final link discard such sections.
590     // This is compatible with GNU.
591     if ((sec.sh_flags & SHF_EXCLUDE) && !config->relocatable) {
592       if (sec.sh_type == SHT_LLVM_ADDRSIG) {
593         // We ignore the address-significance table if we know that the object
594         // file was created by objcopy or ld -r. This is because these tools
595         // will reorder the symbols in the symbol table, invalidating the data
596         // in the address-significance table, which refers to symbols by index.
597         if (sec.sh_link != 0)
598           this->addrsigSec = &sec;
599         else if (config->icf == ICFLevel::Safe)
600           warn(toString(this) +
601                ": --icf=safe conservatively ignores "
602                "SHT_LLVM_ADDRSIG [index " +
603                Twine(i) +
604                "] with sh_link=0 "
605                "(likely created using objcopy or ld -r)");
606       }
607       this->sections[i] = &InputSection::discarded;
608       continue;
609     }
610 
611     switch (sec.sh_type) {
612     case SHT_GROUP: {
613       // De-duplicate section groups by their signatures.
614       StringRef signature = getShtGroupSignature(objSections, sec);
615       this->sections[i] = &InputSection::discarded;
616 
617       ArrayRef<Elf_Word> entries =
618           CHECK(obj.template getSectionContentsAsArray<Elf_Word>(sec), this);
619       if (entries.empty())
620         fatal(toString(this) + ": empty SHT_GROUP");
621 
622       Elf_Word flag = entries[0];
623       if (flag && flag != GRP_COMDAT)
624         fatal(toString(this) + ": unsupported SHT_GROUP format");
625 
626       bool keepGroup =
627           (flag & GRP_COMDAT) == 0 || ignoreComdats ||
628           symtab->comdatGroups.try_emplace(CachedHashStringRef(signature), this)
629               .second;
630       if (keepGroup) {
631         if (config->relocatable)
632           this->sections[i] = createInputSection(sec);
633         selectedGroups.push_back(entries);
634         continue;
635       }
636 
637       // Otherwise, discard group members.
638       for (uint32_t secIndex : entries.slice(1)) {
639         if (secIndex >= size)
640           fatal(toString(this) +
641                 ": invalid section index in group: " + Twine(secIndex));
642         this->sections[secIndex] = &InputSection::discarded;
643       }
644       break;
645     }
646     case SHT_SYMTAB_SHNDX:
647       shndxTable = CHECK(obj.getSHNDXTable(sec, objSections), this);
648       break;
649     case SHT_SYMTAB:
650     case SHT_STRTAB:
651     case SHT_REL:
652     case SHT_RELA:
653     case SHT_NULL:
654       break;
655     default:
656       this->sections[i] = createInputSection(sec);
657     }
658   }
659 
660   // We have a second loop. It is used to:
661   // 1) handle SHF_LINK_ORDER sections.
662   // 2) create SHT_REL[A] sections. In some cases the section header index of a
663   //    relocation section may be smaller than that of the relocated section. In
664   //    such cases, the relocation section would attempt to reference a target
665   //    section that has not yet been created. For simplicity, delay creation of
666   //    relocation sections until now.
667   for (size_t i = 0, e = objSections.size(); i < e; ++i) {
668     if (this->sections[i] == &InputSection::discarded)
669       continue;
670     const Elf_Shdr &sec = objSections[i];
671 
672     if (cgProfileSectionIndex && sec.sh_info == cgProfileSectionIndex) {
673       if (sec.sh_type == SHT_RELA)
674         cgProfileRela = CHECK(getObj().relas(sec), this);
675       else
676         warn(toString(this) + ": unsupported call graph section type");
677     }
678 
679     if (sec.sh_type == SHT_REL || sec.sh_type == SHT_RELA)
680       this->sections[i] = createInputSection(sec);
681 
682     // A SHF_LINK_ORDER section with sh_link=0 is handled as if it did not have
683     // the flag.
684     if (!(sec.sh_flags & SHF_LINK_ORDER) || !sec.sh_link)
685       continue;
686 
687     InputSectionBase *linkSec = nullptr;
688     if (sec.sh_link < this->sections.size())
689       linkSec = this->sections[sec.sh_link];
690     if (!linkSec)
691       fatal(toString(this) + ": invalid sh_link index: " + Twine(sec.sh_link));
692 
693     // A SHF_LINK_ORDER section is discarded if its linked-to section is
694     // discarded.
695     InputSection *isec = cast<InputSection>(this->sections[i]);
696     linkSec->dependentSections.push_back(isec);
697     if (!isa<InputSection>(linkSec))
698       error("a section " + isec->name +
699             " with SHF_LINK_ORDER should not refer a non-regular section: " +
700             toString(linkSec));
701   }
702 
703   for (ArrayRef<Elf_Word> entries : selectedGroups)
704     handleSectionGroup<ELFT>(this->sections, entries);
705 }
706 
707 // For ARM only, to set the EF_ARM_ABI_FLOAT_SOFT or EF_ARM_ABI_FLOAT_HARD
708 // flag in the ELF Header we need to look at Tag_ABI_VFP_args to find out how
709 // the input objects have been compiled.
710 static void updateARMVFPArgs(const ARMAttributeParser &attributes,
711                              const InputFile *f) {
712   Optional<unsigned> attr =
713       attributes.getAttributeValue(ARMBuildAttrs::ABI_VFP_args);
714   if (!attr.hasValue())
715     // If an ABI tag isn't present then it is implicitly given the value of 0
716     // which maps to ARMBuildAttrs::BaseAAPCS. However many assembler files,
717     // including some in glibc that don't use FP args (and should have value 3)
718     // don't have the attribute so we do not consider an implicit value of 0
719     // as a clash.
720     return;
721 
722   unsigned vfpArgs = attr.getValue();
723   ARMVFPArgKind arg;
724   switch (vfpArgs) {
725   case ARMBuildAttrs::BaseAAPCS:
726     arg = ARMVFPArgKind::Base;
727     break;
728   case ARMBuildAttrs::HardFPAAPCS:
729     arg = ARMVFPArgKind::VFP;
730     break;
731   case ARMBuildAttrs::ToolChainFPPCS:
732     // Tool chain specific convention that conforms to neither AAPCS variant.
733     arg = ARMVFPArgKind::ToolChain;
734     break;
735   case ARMBuildAttrs::CompatibleFPAAPCS:
736     // Object compatible with all conventions.
737     return;
738   default:
739     error(toString(f) + ": unknown Tag_ABI_VFP_args value: " + Twine(vfpArgs));
740     return;
741   }
742   // Follow ld.bfd and error if there is a mix of calling conventions.
743   if (config->armVFPArgs != arg && config->armVFPArgs != ARMVFPArgKind::Default)
744     error(toString(f) + ": incompatible Tag_ABI_VFP_args");
745   else
746     config->armVFPArgs = arg;
747 }
748 
749 // The ARM support in lld makes some use of instructions that are not available
750 // on all ARM architectures. Namely:
751 // - Use of BLX instruction for interworking between ARM and Thumb state.
752 // - Use of the extended Thumb branch encoding in relocation.
753 // - Use of the MOVT/MOVW instructions in Thumb Thunks.
754 // The ARM Attributes section contains information about the architecture chosen
755 // at compile time. We follow the convention that if at least one input object
756 // is compiled with an architecture that supports these features then lld is
757 // permitted to use them.
758 static void updateSupportedARMFeatures(const ARMAttributeParser &attributes) {
759   Optional<unsigned> attr =
760       attributes.getAttributeValue(ARMBuildAttrs::CPU_arch);
761   if (!attr.hasValue())
762     return;
763   auto arch = attr.getValue();
764   switch (arch) {
765   case ARMBuildAttrs::Pre_v4:
766   case ARMBuildAttrs::v4:
767   case ARMBuildAttrs::v4T:
768     // Architectures prior to v5 do not support BLX instruction
769     break;
770   case ARMBuildAttrs::v5T:
771   case ARMBuildAttrs::v5TE:
772   case ARMBuildAttrs::v5TEJ:
773   case ARMBuildAttrs::v6:
774   case ARMBuildAttrs::v6KZ:
775   case ARMBuildAttrs::v6K:
776     config->armHasBlx = true;
777     // Architectures used in pre-Cortex processors do not support
778     // The J1 = 1 J2 = 1 Thumb branch range extension, with the exception
779     // of Architecture v6T2 (arm1156t2-s and arm1156t2f-s) that do.
780     break;
781   default:
782     // All other Architectures have BLX and extended branch encoding
783     config->armHasBlx = true;
784     config->armJ1J2BranchEncoding = true;
785     if (arch != ARMBuildAttrs::v6_M && arch != ARMBuildAttrs::v6S_M)
786       // All Architectures used in Cortex processors with the exception
787       // of v6-M and v6S-M have the MOVT and MOVW instructions.
788       config->armHasMovtMovw = true;
789     break;
790   }
791 }
792 
793 // If a source file is compiled with x86 hardware-assisted call flow control
794 // enabled, the generated object file contains feature flags indicating that
795 // fact. This function reads the feature flags and returns it.
796 //
797 // Essentially we want to read a single 32-bit value in this function, but this
798 // function is rather complicated because the value is buried deep inside a
799 // .note.gnu.property section.
800 //
801 // The section consists of one or more NOTE records. Each NOTE record consists
802 // of zero or more type-length-value fields. We want to find a field of a
803 // certain type. It seems a bit too much to just store a 32-bit value, perhaps
804 // the ABI is unnecessarily complicated.
805 template <class ELFT> static uint32_t readAndFeatures(const InputSection &sec) {
806   using Elf_Nhdr = typename ELFT::Nhdr;
807   using Elf_Note = typename ELFT::Note;
808 
809   uint32_t featuresSet = 0;
810   ArrayRef<uint8_t> data = sec.data();
811   auto reportFatal = [&](const uint8_t *place, const char *msg) {
812     fatal(toString(sec.file) + ":(" + sec.name + "+0x" +
813           Twine::utohexstr(place - sec.data().data()) + "): " + msg);
814   };
815   while (!data.empty()) {
816     // Read one NOTE record.
817     auto *nhdr = reinterpret_cast<const Elf_Nhdr *>(data.data());
818     if (data.size() < sizeof(Elf_Nhdr) || data.size() < nhdr->getSize())
819       reportFatal(data.data(), "data is too short");
820 
821     Elf_Note note(*nhdr);
822     if (nhdr->n_type != NT_GNU_PROPERTY_TYPE_0 || note.getName() != "GNU") {
823       data = data.slice(nhdr->getSize());
824       continue;
825     }
826 
827     uint32_t featureAndType = config->emachine == EM_AARCH64
828                                   ? GNU_PROPERTY_AARCH64_FEATURE_1_AND
829                                   : GNU_PROPERTY_X86_FEATURE_1_AND;
830 
831     // Read a body of a NOTE record, which consists of type-length-value fields.
832     ArrayRef<uint8_t> desc = note.getDesc();
833     while (!desc.empty()) {
834       const uint8_t *place = desc.data();
835       if (desc.size() < 8)
836         reportFatal(place, "program property is too short");
837       uint32_t type = read32<ELFT::TargetEndianness>(desc.data());
838       uint32_t size = read32<ELFT::TargetEndianness>(desc.data() + 4);
839       desc = desc.slice(8);
840       if (desc.size() < size)
841         reportFatal(place, "program property is too short");
842 
843       if (type == featureAndType) {
844         // We found a FEATURE_1_AND field. There may be more than one of these
845         // in a .note.gnu.property section, for a relocatable object we
846         // accumulate the bits set.
847         if (size < 4)
848           reportFatal(place, "FEATURE_1_AND entry is too short");
849         featuresSet |= read32<ELFT::TargetEndianness>(desc.data());
850       }
851 
852       // Padding is present in the note descriptor, if necessary.
853       desc = desc.slice(alignTo<(ELFT::Is64Bits ? 8 : 4)>(size));
854     }
855 
856     // Go to next NOTE record to look for more FEATURE_1_AND descriptions.
857     data = data.slice(nhdr->getSize());
858   }
859 
860   return featuresSet;
861 }
862 
863 template <class ELFT>
864 InputSectionBase *ObjFile<ELFT>::getRelocTarget(const Elf_Shdr &sec) {
865   uint32_t idx = sec.sh_info;
866   if (idx >= this->sections.size())
867     fatal(toString(this) + ": invalid relocated section index: " + Twine(idx));
868   InputSectionBase *target = this->sections[idx];
869 
870   // Strictly speaking, a relocation section must be included in the
871   // group of the section it relocates. However, LLVM 3.3 and earlier
872   // would fail to do so, so we gracefully handle that case.
873   if (target == &InputSection::discarded)
874     return nullptr;
875 
876   if (!target)
877     fatal(toString(this) + ": unsupported relocation reference");
878   return target;
879 }
880 
881 // Create a regular InputSection class that has the same contents
882 // as a given section.
883 static InputSection *toRegularSection(MergeInputSection *sec) {
884   return make<InputSection>(sec->file, sec->flags, sec->type, sec->alignment,
885                             sec->data(), sec->name);
886 }
887 
888 template <class ELFT>
889 InputSectionBase *ObjFile<ELFT>::createInputSection(const Elf_Shdr &sec) {
890   StringRef name = getSectionName(sec);
891 
892   if (config->emachine == EM_ARM && sec.sh_type == SHT_ARM_ATTRIBUTES) {
893     ARMAttributeParser attributes;
894     ArrayRef<uint8_t> contents = check(this->getObj().getSectionContents(sec));
895     if (Error e = attributes.parse(contents, config->ekind == ELF32LEKind
896                                                  ? support::little
897                                                  : support::big)) {
898       auto *isec = make<InputSection>(*this, sec, name);
899       warn(toString(isec) + ": " + llvm::toString(std::move(e)));
900     } else {
901       updateSupportedARMFeatures(attributes);
902       updateARMVFPArgs(attributes, this);
903 
904       // FIXME: Retain the first attribute section we see. The eglibc ARM
905       // dynamic loaders require the presence of an attribute section for dlopen
906       // to work. In a full implementation we would merge all attribute
907       // sections.
908       if (in.attributes == nullptr) {
909         in.attributes = make<InputSection>(*this, sec, name);
910         return in.attributes;
911       }
912       return &InputSection::discarded;
913     }
914   }
915 
916   if (config->emachine == EM_RISCV && sec.sh_type == SHT_RISCV_ATTRIBUTES) {
917     RISCVAttributeParser attributes;
918     ArrayRef<uint8_t> contents = check(this->getObj().getSectionContents(sec));
919     if (Error e = attributes.parse(contents, support::little)) {
920       auto *isec = make<InputSection>(*this, sec, name);
921       warn(toString(isec) + ": " + llvm::toString(std::move(e)));
922     } else {
923       // FIXME: Validate arch tag contains C if and only if EF_RISCV_RVC is
924       // present.
925 
926       // FIXME: Retain the first attribute section we see. Tools such as
927       // llvm-objdump make use of the attribute section to determine which
928       // standard extensions to enable. In a full implementation we would merge
929       // all attribute sections.
930       if (in.attributes == nullptr) {
931         in.attributes = make<InputSection>(*this, sec, name);
932         return in.attributes;
933       }
934       return &InputSection::discarded;
935     }
936   }
937 
938   switch (sec.sh_type) {
939   case SHT_LLVM_DEPENDENT_LIBRARIES: {
940     if (config->relocatable)
941       break;
942     ArrayRef<char> data =
943         CHECK(this->getObj().template getSectionContentsAsArray<char>(sec), this);
944     if (!data.empty() && data.back() != '\0') {
945       error(toString(this) +
946             ": corrupted dependent libraries section (unterminated string): " +
947             name);
948       return &InputSection::discarded;
949     }
950     for (const char *d = data.begin(), *e = data.end(); d < e;) {
951       StringRef s(d);
952       addDependentLibrary(s, this);
953       d += s.size() + 1;
954     }
955     return &InputSection::discarded;
956   }
957   case SHT_RELA:
958   case SHT_REL: {
959     // Find a relocation target section and associate this section with that.
960     // Target may have been discarded if it is in a different section group
961     // and the group is discarded, even though it's a violation of the
962     // spec. We handle that situation gracefully by discarding dangling
963     // relocation sections.
964     InputSectionBase *target = getRelocTarget(sec);
965     if (!target)
966       return nullptr;
967 
968     // ELF spec allows mergeable sections with relocations, but they are
969     // rare, and it is in practice hard to merge such sections by contents,
970     // because applying relocations at end of linking changes section
971     // contents. So, we simply handle such sections as non-mergeable ones.
972     // Degrading like this is acceptable because section merging is optional.
973     if (auto *ms = dyn_cast<MergeInputSection>(target)) {
974       target = toRegularSection(ms);
975       this->sections[sec.sh_info] = target;
976     }
977 
978     if (target->firstRelocation)
979       fatal(toString(this) +
980             ": multiple relocation sections to one section are not supported");
981 
982     if (sec.sh_type == SHT_RELA) {
983       ArrayRef<Elf_Rela> rels = CHECK(getObj().relas(sec), this);
984       target->firstRelocation = rels.begin();
985       target->numRelocations = rels.size();
986       target->areRelocsRela = true;
987     } else {
988       ArrayRef<Elf_Rel> rels = CHECK(getObj().rels(sec), this);
989       target->firstRelocation = rels.begin();
990       target->numRelocations = rels.size();
991       target->areRelocsRela = false;
992     }
993     assert(isUInt<31>(target->numRelocations));
994 
995     // Relocation sections are usually removed from the output, so return
996     // `nullptr` for the normal case. However, if -r or --emit-relocs is
997     // specified, we need to copy them to the output. (Some post link analysis
998     // tools specify --emit-relocs to obtain the information.)
999     if (!config->relocatable && !config->emitRelocs)
1000       return nullptr;
1001     InputSection *relocSec = make<InputSection>(*this, sec, name);
1002     // If the relocated section is discarded (due to /DISCARD/ or
1003     // --gc-sections), the relocation section should be discarded as well.
1004     target->dependentSections.push_back(relocSec);
1005     return relocSec;
1006   }
1007   }
1008 
1009   // The GNU linker uses .note.GNU-stack section as a marker indicating
1010   // that the code in the object file does not expect that the stack is
1011   // executable (in terms of NX bit). If all input files have the marker,
1012   // the GNU linker adds a PT_GNU_STACK segment to tells the loader to
1013   // make the stack non-executable. Most object files have this section as
1014   // of 2017.
1015   //
1016   // But making the stack non-executable is a norm today for security
1017   // reasons. Failure to do so may result in a serious security issue.
1018   // Therefore, we make LLD always add PT_GNU_STACK unless it is
1019   // explicitly told to do otherwise (by -z execstack). Because the stack
1020   // executable-ness is controlled solely by command line options,
1021   // .note.GNU-stack sections are simply ignored.
1022   if (name == ".note.GNU-stack")
1023     return &InputSection::discarded;
1024 
1025   // Object files that use processor features such as Intel Control-Flow
1026   // Enforcement (CET) or AArch64 Branch Target Identification BTI, use a
1027   // .note.gnu.property section containing a bitfield of feature bits like the
1028   // GNU_PROPERTY_X86_FEATURE_1_IBT flag. Read a bitmap containing the flag.
1029   //
1030   // Since we merge bitmaps from multiple object files to create a new
1031   // .note.gnu.property containing a single AND'ed bitmap, we discard an input
1032   // file's .note.gnu.property section.
1033   if (name == ".note.gnu.property") {
1034     this->andFeatures = readAndFeatures<ELFT>(InputSection(*this, sec, name));
1035     return &InputSection::discarded;
1036   }
1037 
1038   // Split stacks is a feature to support a discontiguous stack,
1039   // commonly used in the programming language Go. For the details,
1040   // see https://gcc.gnu.org/wiki/SplitStacks. An object file compiled
1041   // for split stack will include a .note.GNU-split-stack section.
1042   if (name == ".note.GNU-split-stack") {
1043     if (config->relocatable) {
1044       error("cannot mix split-stack and non-split-stack in a relocatable link");
1045       return &InputSection::discarded;
1046     }
1047     this->splitStack = true;
1048     return &InputSection::discarded;
1049   }
1050 
1051   // An object file cmpiled for split stack, but where some of the
1052   // functions were compiled with the no_split_stack_attribute will
1053   // include a .note.GNU-no-split-stack section.
1054   if (name == ".note.GNU-no-split-stack") {
1055     this->someNoSplitStack = true;
1056     return &InputSection::discarded;
1057   }
1058 
1059   // The linkonce feature is a sort of proto-comdat. Some glibc i386 object
1060   // files contain definitions of symbol "__x86.get_pc_thunk.bx" in linkonce
1061   // sections. Drop those sections to avoid duplicate symbol errors.
1062   // FIXME: This is glibc PR20543, we should remove this hack once that has been
1063   // fixed for a while.
1064   if (name == ".gnu.linkonce.t.__x86.get_pc_thunk.bx" ||
1065       name == ".gnu.linkonce.t.__i686.get_pc_thunk.bx")
1066     return &InputSection::discarded;
1067 
1068   // If we are creating a new .build-id section, strip existing .build-id
1069   // sections so that the output won't have more than one .build-id.
1070   // This is not usually a problem because input object files normally don't
1071   // have .build-id sections, but you can create such files by
1072   // "ld.{bfd,gold,lld} -r --build-id", and we want to guard against it.
1073   if (name == ".note.gnu.build-id" && config->buildId != BuildIdKind::None)
1074     return &InputSection::discarded;
1075 
1076   // The linker merges EH (exception handling) frames and creates a
1077   // .eh_frame_hdr section for runtime. So we handle them with a special
1078   // class. For relocatable outputs, they are just passed through.
1079   if (name == ".eh_frame" && !config->relocatable)
1080     return make<EhInputSection>(*this, sec, name);
1081 
1082   if (shouldMerge(sec, name))
1083     return make<MergeInputSection>(*this, sec, name);
1084   return make<InputSection>(*this, sec, name);
1085 }
1086 
1087 template <class ELFT>
1088 StringRef ObjFile<ELFT>::getSectionName(const Elf_Shdr &sec) {
1089   return CHECK(getObj().getSectionName(sec, sectionStringTable), this);
1090 }
1091 
1092 // Initialize this->Symbols. this->Symbols is a parallel array as
1093 // its corresponding ELF symbol table.
1094 template <class ELFT> void ObjFile<ELFT>::initializeSymbols() {
1095   ArrayRef<Elf_Sym> eSyms = this->getELFSyms<ELFT>();
1096   this->symbols.resize(eSyms.size());
1097 
1098   // Fill in InputFile::symbols. Some entries have been initialized
1099   // because of LazyObjFile.
1100   for (size_t i = 0, end = eSyms.size(); i != end; ++i) {
1101     if (this->symbols[i])
1102       continue;
1103     const Elf_Sym &eSym = eSyms[i];
1104     uint32_t secIdx = getSectionIndex(eSym);
1105     if (secIdx >= this->sections.size())
1106       fatal(toString(this) + ": invalid section index: " + Twine(secIdx));
1107     if (eSym.getBinding() != STB_LOCAL) {
1108       if (i < firstGlobal)
1109         error(toString(this) + ": non-local symbol (" + Twine(i) +
1110               ") found at index < .symtab's sh_info (" + Twine(firstGlobal) +
1111               ")");
1112       this->symbols[i] =
1113           symtab->insert(CHECK(eSyms[i].getName(this->stringTable), this));
1114       continue;
1115     }
1116 
1117     // Handle local symbols. Local symbols are not added to the symbol
1118     // table because they are not visible from other object files. We
1119     // allocate symbol instances and add their pointers to symbols.
1120     if (i >= firstGlobal)
1121       errorOrWarn(toString(this) + ": STB_LOCAL symbol (" + Twine(i) +
1122                   ") found at index >= .symtab's sh_info (" +
1123                   Twine(firstGlobal) + ")");
1124 
1125     InputSectionBase *sec = this->sections[secIdx];
1126     uint8_t type = eSym.getType();
1127     if (type == STT_FILE)
1128       sourceFile = CHECK(eSym.getName(this->stringTable), this);
1129     if (this->stringTable.size() <= eSym.st_name)
1130       fatal(toString(this) + ": invalid symbol name offset");
1131     StringRefZ name = this->stringTable.data() + eSym.st_name;
1132 
1133     if (eSym.st_shndx == SHN_UNDEF)
1134       this->symbols[i] =
1135           make<Undefined>(this, name, STB_LOCAL, eSym.st_other, type);
1136     else if (sec == &InputSection::discarded)
1137       this->symbols[i] =
1138           make<Undefined>(this, name, STB_LOCAL, eSym.st_other, type,
1139                           /*discardedSecIdx=*/secIdx);
1140     else
1141       this->symbols[i] = make<Defined>(this, name, STB_LOCAL, eSym.st_other,
1142                                        type, eSym.st_value, eSym.st_size, sec);
1143   }
1144 
1145   // Symbol resolution of non-local symbols.
1146   SmallVector<unsigned, 32> unds;
1147   for (size_t i = firstGlobal, end = eSyms.size(); i != end; ++i) {
1148     const Elf_Sym &eSym = eSyms[i];
1149     uint8_t binding = eSym.getBinding();
1150     if (binding == STB_LOCAL)
1151       continue; // Errored above.
1152 
1153     uint32_t secIdx = getSectionIndex(eSym);
1154     InputSectionBase *sec = this->sections[secIdx];
1155     uint8_t stOther = eSym.st_other;
1156     uint8_t type = eSym.getType();
1157     uint64_t value = eSym.st_value;
1158     uint64_t size = eSym.st_size;
1159     StringRefZ name = this->stringTable.data() + eSym.st_name;
1160 
1161     // Handle global undefined symbols.
1162     if (eSym.st_shndx == SHN_UNDEF) {
1163       unds.push_back(i);
1164       continue;
1165     }
1166 
1167     // Handle global common symbols.
1168     if (eSym.st_shndx == SHN_COMMON) {
1169       if (value == 0 || value >= UINT32_MAX)
1170         fatal(toString(this) + ": common symbol '" + StringRef(name.data) +
1171               "' has invalid alignment: " + Twine(value));
1172       this->symbols[i]->resolve(
1173           CommonSymbol{this, name, binding, stOther, type, value, size});
1174       continue;
1175     }
1176 
1177     // If a defined symbol is in a discarded section, handle it as if it
1178     // were an undefined symbol. Such symbol doesn't comply with the
1179     // standard, but in practice, a .eh_frame often directly refer
1180     // COMDAT member sections, and if a comdat group is discarded, some
1181     // defined symbol in a .eh_frame becomes dangling symbols.
1182     if (sec == &InputSection::discarded) {
1183       Undefined und{this, name, binding, stOther, type, secIdx};
1184       Symbol *sym = this->symbols[i];
1185       // !ArchiveFile::parsed or LazyObjFile::fetched means that the file
1186       // containing this object has not finished processing, i.e. this symbol is
1187       // a result of a lazy symbol fetch. We should demote the lazy symbol to an
1188       // Undefined so that any relocations outside of the group to it will
1189       // trigger a discarded section error.
1190       if ((sym->symbolKind == Symbol::LazyArchiveKind &&
1191            !cast<ArchiveFile>(sym->file)->parsed) ||
1192           (sym->symbolKind == Symbol::LazyObjectKind &&
1193            cast<LazyObjFile>(sym->file)->fetched))
1194         sym->replace(und);
1195       else
1196         sym->resolve(und);
1197       continue;
1198     }
1199 
1200     // Handle global defined symbols.
1201     if (binding == STB_GLOBAL || binding == STB_WEAK ||
1202         binding == STB_GNU_UNIQUE) {
1203       this->symbols[i]->resolve(
1204           Defined{this, name, binding, stOther, type, value, size, sec});
1205       continue;
1206     }
1207 
1208     fatal(toString(this) + ": unexpected binding: " + Twine((int)binding));
1209   }
1210 
1211   // Undefined symbols (excluding those defined relative to non-prevailing
1212   // sections) can trigger recursive fetch. Process defined symbols first so
1213   // that the relative order between a defined symbol and an undefined symbol
1214   // does not change the symbol resolution behavior. In addition, a set of
1215   // interconnected symbols will all be resolved to the same file, instead of
1216   // being resolved to different files.
1217   for (unsigned i : unds) {
1218     const Elf_Sym &eSym = eSyms[i];
1219     StringRefZ name = this->stringTable.data() + eSym.st_name;
1220     this->symbols[i]->resolve(Undefined{this, name, eSym.getBinding(),
1221                                         eSym.st_other, eSym.getType()});
1222     this->symbols[i]->referenced = true;
1223   }
1224 }
1225 
1226 ArchiveFile::ArchiveFile(std::unique_ptr<Archive> &&file)
1227     : InputFile(ArchiveKind, file->getMemoryBufferRef()),
1228       file(std::move(file)) {}
1229 
1230 void ArchiveFile::parse() {
1231   for (const Archive::Symbol &sym : file->symbols())
1232     symtab->addSymbol(LazyArchive{*this, sym});
1233 
1234   // Inform a future invocation of ObjFile<ELFT>::initializeSymbols() that this
1235   // archive has been processed.
1236   parsed = true;
1237 }
1238 
1239 // Returns a buffer pointing to a member file containing a given symbol.
1240 void ArchiveFile::fetch(const Archive::Symbol &sym) {
1241   Archive::Child c =
1242       CHECK(sym.getMember(), toString(this) +
1243                                  ": could not get the member for symbol " +
1244                                  toELFString(sym));
1245 
1246   if (!seen.insert(c.getChildOffset()).second)
1247     return;
1248 
1249   MemoryBufferRef mb =
1250       CHECK(c.getMemoryBufferRef(),
1251             toString(this) +
1252                 ": could not get the buffer for the member defining symbol " +
1253                 toELFString(sym));
1254 
1255   if (tar && c.getParent()->isThin())
1256     tar->append(relativeToRoot(CHECK(c.getFullName(), this)), mb.getBuffer());
1257 
1258   InputFile *file = createObjectFile(mb, getName(), c.getChildOffset());
1259   file->groupId = groupId;
1260   parseFile(file);
1261 }
1262 
1263 // The handling of tentative definitions (COMMON symbols) in archives is murky.
1264 // A tentative definition will be promoted to a global definition if there are
1265 // no non-tentative definitions to dominate it. When we hold a tentative
1266 // definition to a symbol and are inspecting archive members for inclusion
1267 // there are 2 ways we can proceed:
1268 //
1269 // 1) Consider the tentative definition a 'real' definition (ie promotion from
1270 //    tentative to real definition has already happened) and not inspect
1271 //    archive members for Global/Weak definitions to replace the tentative
1272 //    definition. An archive member would only be included if it satisfies some
1273 //    other undefined symbol. This is the behavior Gold uses.
1274 //
1275 // 2) Consider the tentative definition as still undefined (ie the promotion to
1276 //    a real definition happens only after all symbol resolution is done).
1277 //    The linker searches archive members for global or weak definitions to
1278 //    replace the tentative definition with. This is the behavior used by
1279 //    GNU ld.
1280 //
1281 //  The second behavior is inherited from SysVR4, which based it on the FORTRAN
1282 //  COMMON BLOCK model. This behavior is needed for proper initialization in old
1283 //  (pre F90) FORTRAN code that is packaged into an archive.
1284 //
1285 //  The following functions search archive members for definitions to replace
1286 //  tentative definitions (implementing behavior 2).
1287 static bool isBitcodeNonCommonDef(MemoryBufferRef mb, StringRef symName,
1288                                   StringRef archiveName) {
1289   IRSymtabFile symtabFile = check(readIRSymtab(mb));
1290   for (const irsymtab::Reader::SymbolRef &sym :
1291        symtabFile.TheReader.symbols()) {
1292     if (sym.isGlobal() && sym.getName() == symName)
1293       return !sym.isUndefined() && !sym.isCommon();
1294   }
1295   return false;
1296 }
1297 
1298 template <class ELFT>
1299 static bool isNonCommonDef(MemoryBufferRef mb, StringRef symName,
1300                            StringRef archiveName) {
1301   ObjFile<ELFT> *obj = make<ObjFile<ELFT>>(mb, archiveName);
1302   StringRef stringtable = obj->getStringTable();
1303 
1304   for (auto sym : obj->template getGlobalELFSyms<ELFT>()) {
1305     Expected<StringRef> name = sym.getName(stringtable);
1306     if (name && name.get() == symName)
1307       return sym.isDefined() && !sym.isCommon();
1308   }
1309   return false;
1310 }
1311 
1312 static bool isNonCommonDef(MemoryBufferRef mb, StringRef symName,
1313                            StringRef archiveName) {
1314   switch (getELFKind(mb, archiveName)) {
1315   case ELF32LEKind:
1316     return isNonCommonDef<ELF32LE>(mb, symName, archiveName);
1317   case ELF32BEKind:
1318     return isNonCommonDef<ELF32BE>(mb, symName, archiveName);
1319   case ELF64LEKind:
1320     return isNonCommonDef<ELF64LE>(mb, symName, archiveName);
1321   case ELF64BEKind:
1322     return isNonCommonDef<ELF64BE>(mb, symName, archiveName);
1323   default:
1324     llvm_unreachable("getELFKind");
1325   }
1326 }
1327 
1328 bool ArchiveFile::shouldFetchForCommon(const Archive::Symbol &sym) {
1329   Archive::Child c =
1330       CHECK(sym.getMember(), toString(this) +
1331                                  ": could not get the member for symbol " +
1332                                  toELFString(sym));
1333   MemoryBufferRef mb =
1334       CHECK(c.getMemoryBufferRef(),
1335             toString(this) +
1336                 ": could not get the buffer for the member defining symbol " +
1337                 toELFString(sym));
1338 
1339   if (isBitcode(mb))
1340     return isBitcodeNonCommonDef(mb, sym.getName(), getName());
1341 
1342   return isNonCommonDef(mb, sym.getName(), getName());
1343 }
1344 
1345 size_t ArchiveFile::getMemberCount() const {
1346   size_t count = 0;
1347   Error err = Error::success();
1348   for (const Archive::Child &c : file->children(err)) {
1349     (void)c;
1350     ++count;
1351   }
1352   // This function is used by --print-archive-stats=, where an error does not
1353   // really matter.
1354   consumeError(std::move(err));
1355   return count;
1356 }
1357 
1358 unsigned SharedFile::vernauxNum;
1359 
1360 // Parse the version definitions in the object file if present, and return a
1361 // vector whose nth element contains a pointer to the Elf_Verdef for version
1362 // identifier n. Version identifiers that are not definitions map to nullptr.
1363 template <typename ELFT>
1364 static std::vector<const void *> parseVerdefs(const uint8_t *base,
1365                                               const typename ELFT::Shdr *sec) {
1366   if (!sec)
1367     return {};
1368 
1369   // We cannot determine the largest verdef identifier without inspecting
1370   // every Elf_Verdef, but both bfd and gold assign verdef identifiers
1371   // sequentially starting from 1, so we predict that the largest identifier
1372   // will be verdefCount.
1373   unsigned verdefCount = sec->sh_info;
1374   std::vector<const void *> verdefs(verdefCount + 1);
1375 
1376   // Build the Verdefs array by following the chain of Elf_Verdef objects
1377   // from the start of the .gnu.version_d section.
1378   const uint8_t *verdef = base + sec->sh_offset;
1379   for (unsigned i = 0; i != verdefCount; ++i) {
1380     auto *curVerdef = reinterpret_cast<const typename ELFT::Verdef *>(verdef);
1381     verdef += curVerdef->vd_next;
1382     unsigned verdefIndex = curVerdef->vd_ndx;
1383     verdefs.resize(verdefIndex + 1);
1384     verdefs[verdefIndex] = curVerdef;
1385   }
1386   return verdefs;
1387 }
1388 
1389 // Parse SHT_GNU_verneed to properly set the name of a versioned undefined
1390 // symbol. We detect fatal issues which would cause vulnerabilities, but do not
1391 // implement sophisticated error checking like in llvm-readobj because the value
1392 // of such diagnostics is low.
1393 template <typename ELFT>
1394 std::vector<uint32_t> SharedFile::parseVerneed(const ELFFile<ELFT> &obj,
1395                                                const typename ELFT::Shdr *sec) {
1396   if (!sec)
1397     return {};
1398   std::vector<uint32_t> verneeds;
1399   ArrayRef<uint8_t> data = CHECK(obj.getSectionContents(*sec), this);
1400   const uint8_t *verneedBuf = data.begin();
1401   for (unsigned i = 0; i != sec->sh_info; ++i) {
1402     if (verneedBuf + sizeof(typename ELFT::Verneed) > data.end())
1403       fatal(toString(this) + " has an invalid Verneed");
1404     auto *vn = reinterpret_cast<const typename ELFT::Verneed *>(verneedBuf);
1405     const uint8_t *vernauxBuf = verneedBuf + vn->vn_aux;
1406     for (unsigned j = 0; j != vn->vn_cnt; ++j) {
1407       if (vernauxBuf + sizeof(typename ELFT::Vernaux) > data.end())
1408         fatal(toString(this) + " has an invalid Vernaux");
1409       auto *aux = reinterpret_cast<const typename ELFT::Vernaux *>(vernauxBuf);
1410       if (aux->vna_name >= this->stringTable.size())
1411         fatal(toString(this) + " has a Vernaux with an invalid vna_name");
1412       uint16_t version = aux->vna_other & VERSYM_VERSION;
1413       if (version >= verneeds.size())
1414         verneeds.resize(version + 1);
1415       verneeds[version] = aux->vna_name;
1416       vernauxBuf += aux->vna_next;
1417     }
1418     verneedBuf += vn->vn_next;
1419   }
1420   return verneeds;
1421 }
1422 
1423 // We do not usually care about alignments of data in shared object
1424 // files because the loader takes care of it. However, if we promote a
1425 // DSO symbol to point to .bss due to copy relocation, we need to keep
1426 // the original alignment requirements. We infer it in this function.
1427 template <typename ELFT>
1428 static uint64_t getAlignment(ArrayRef<typename ELFT::Shdr> sections,
1429                              const typename ELFT::Sym &sym) {
1430   uint64_t ret = UINT64_MAX;
1431   if (sym.st_value)
1432     ret = 1ULL << countTrailingZeros((uint64_t)sym.st_value);
1433   if (0 < sym.st_shndx && sym.st_shndx < sections.size())
1434     ret = std::min<uint64_t>(ret, sections[sym.st_shndx].sh_addralign);
1435   return (ret > UINT32_MAX) ? 0 : ret;
1436 }
1437 
1438 // Fully parse the shared object file.
1439 //
1440 // This function parses symbol versions. If a DSO has version information,
1441 // the file has a ".gnu.version_d" section which contains symbol version
1442 // definitions. Each symbol is associated to one version through a table in
1443 // ".gnu.version" section. That table is a parallel array for the symbol
1444 // table, and each table entry contains an index in ".gnu.version_d".
1445 //
1446 // The special index 0 is reserved for VERF_NDX_LOCAL and 1 is for
1447 // VER_NDX_GLOBAL. There's no table entry for these special versions in
1448 // ".gnu.version_d".
1449 //
1450 // The file format for symbol versioning is perhaps a bit more complicated
1451 // than necessary, but you can easily understand the code if you wrap your
1452 // head around the data structure described above.
1453 template <class ELFT> void SharedFile::parse() {
1454   using Elf_Dyn = typename ELFT::Dyn;
1455   using Elf_Shdr = typename ELFT::Shdr;
1456   using Elf_Sym = typename ELFT::Sym;
1457   using Elf_Verdef = typename ELFT::Verdef;
1458   using Elf_Versym = typename ELFT::Versym;
1459 
1460   ArrayRef<Elf_Dyn> dynamicTags;
1461   const ELFFile<ELFT> obj = this->getObj<ELFT>();
1462   ArrayRef<Elf_Shdr> sections = CHECK(obj.sections(), this);
1463 
1464   const Elf_Shdr *versymSec = nullptr;
1465   const Elf_Shdr *verdefSec = nullptr;
1466   const Elf_Shdr *verneedSec = nullptr;
1467 
1468   // Search for .dynsym, .dynamic, .symtab, .gnu.version and .gnu.version_d.
1469   for (const Elf_Shdr &sec : sections) {
1470     switch (sec.sh_type) {
1471     default:
1472       continue;
1473     case SHT_DYNAMIC:
1474       dynamicTags =
1475           CHECK(obj.template getSectionContentsAsArray<Elf_Dyn>(sec), this);
1476       break;
1477     case SHT_GNU_versym:
1478       versymSec = &sec;
1479       break;
1480     case SHT_GNU_verdef:
1481       verdefSec = &sec;
1482       break;
1483     case SHT_GNU_verneed:
1484       verneedSec = &sec;
1485       break;
1486     }
1487   }
1488 
1489   if (versymSec && numELFSyms == 0) {
1490     error("SHT_GNU_versym should be associated with symbol table");
1491     return;
1492   }
1493 
1494   // Search for a DT_SONAME tag to initialize this->soName.
1495   for (const Elf_Dyn &dyn : dynamicTags) {
1496     if (dyn.d_tag == DT_NEEDED) {
1497       uint64_t val = dyn.getVal();
1498       if (val >= this->stringTable.size())
1499         fatal(toString(this) + ": invalid DT_NEEDED entry");
1500       dtNeeded.push_back(this->stringTable.data() + val);
1501     } else if (dyn.d_tag == DT_SONAME) {
1502       uint64_t val = dyn.getVal();
1503       if (val >= this->stringTable.size())
1504         fatal(toString(this) + ": invalid DT_SONAME entry");
1505       soName = this->stringTable.data() + val;
1506     }
1507   }
1508 
1509   // DSOs are uniquified not by filename but by soname.
1510   DenseMap<StringRef, SharedFile *>::iterator it;
1511   bool wasInserted;
1512   std::tie(it, wasInserted) = symtab->soNames.try_emplace(soName, this);
1513 
1514   // If a DSO appears more than once on the command line with and without
1515   // --as-needed, --no-as-needed takes precedence over --as-needed because a
1516   // user can add an extra DSO with --no-as-needed to force it to be added to
1517   // the dependency list.
1518   it->second->isNeeded |= isNeeded;
1519   if (!wasInserted)
1520     return;
1521 
1522   sharedFiles.push_back(this);
1523 
1524   verdefs = parseVerdefs<ELFT>(obj.base(), verdefSec);
1525   std::vector<uint32_t> verneeds = parseVerneed<ELFT>(obj, verneedSec);
1526 
1527   // Parse ".gnu.version" section which is a parallel array for the symbol
1528   // table. If a given file doesn't have a ".gnu.version" section, we use
1529   // VER_NDX_GLOBAL.
1530   size_t size = numELFSyms - firstGlobal;
1531   std::vector<uint16_t> versyms(size, VER_NDX_GLOBAL);
1532   if (versymSec) {
1533     ArrayRef<Elf_Versym> versym =
1534         CHECK(obj.template getSectionContentsAsArray<Elf_Versym>(*versymSec),
1535               this)
1536             .slice(firstGlobal);
1537     for (size_t i = 0; i < size; ++i)
1538       versyms[i] = versym[i].vs_index;
1539   }
1540 
1541   // System libraries can have a lot of symbols with versions. Using a
1542   // fixed buffer for computing the versions name (foo@ver) can save a
1543   // lot of allocations.
1544   SmallString<0> versionedNameBuffer;
1545 
1546   // Add symbols to the symbol table.
1547   ArrayRef<Elf_Sym> syms = this->getGlobalELFSyms<ELFT>();
1548   for (size_t i = 0; i < syms.size(); ++i) {
1549     const Elf_Sym &sym = syms[i];
1550 
1551     // ELF spec requires that all local symbols precede weak or global
1552     // symbols in each symbol table, and the index of first non-local symbol
1553     // is stored to sh_info. If a local symbol appears after some non-local
1554     // symbol, that's a violation of the spec.
1555     StringRef name = CHECK(sym.getName(this->stringTable), this);
1556     if (sym.getBinding() == STB_LOCAL) {
1557       warn("found local symbol '" + name +
1558            "' in global part of symbol table in file " + toString(this));
1559       continue;
1560     }
1561 
1562     uint16_t idx = versyms[i] & ~VERSYM_HIDDEN;
1563     if (sym.isUndefined()) {
1564       // For unversioned undefined symbols, VER_NDX_GLOBAL makes more sense but
1565       // as of binutils 2.34, GNU ld produces VER_NDX_LOCAL.
1566       if (idx != VER_NDX_LOCAL && idx != VER_NDX_GLOBAL) {
1567         if (idx >= verneeds.size()) {
1568           error("corrupt input file: version need index " + Twine(idx) +
1569                 " for symbol " + name + " is out of bounds\n>>> defined in " +
1570                 toString(this));
1571           continue;
1572         }
1573         StringRef verName = this->stringTable.data() + verneeds[idx];
1574         versionedNameBuffer.clear();
1575         name =
1576             saver.save((name + "@" + verName).toStringRef(versionedNameBuffer));
1577       }
1578       Symbol *s = symtab->addSymbol(
1579           Undefined{this, name, sym.getBinding(), sym.st_other, sym.getType()});
1580       s->exportDynamic = true;
1581       if (s->isUndefined() && !s->isWeak() &&
1582           config->unresolvedSymbolsInShlib != UnresolvedPolicy::Ignore)
1583         requiredSymbols.push_back(s);
1584       continue;
1585     }
1586 
1587     // MIPS BFD linker puts _gp_disp symbol into DSO files and incorrectly
1588     // assigns VER_NDX_LOCAL to this section global symbol. Here is a
1589     // workaround for this bug.
1590     if (config->emachine == EM_MIPS && idx == VER_NDX_LOCAL &&
1591         name == "_gp_disp")
1592       continue;
1593 
1594     uint32_t alignment = getAlignment<ELFT>(sections, sym);
1595     if (!(versyms[i] & VERSYM_HIDDEN)) {
1596       symtab->addSymbol(SharedSymbol{*this, name, sym.getBinding(),
1597                                      sym.st_other, sym.getType(), sym.st_value,
1598                                      sym.st_size, alignment, idx});
1599     }
1600 
1601     // Also add the symbol with the versioned name to handle undefined symbols
1602     // with explicit versions.
1603     if (idx == VER_NDX_GLOBAL)
1604       continue;
1605 
1606     if (idx >= verdefs.size() || idx == VER_NDX_LOCAL) {
1607       error("corrupt input file: version definition index " + Twine(idx) +
1608             " for symbol " + name + " is out of bounds\n>>> defined in " +
1609             toString(this));
1610       continue;
1611     }
1612 
1613     StringRef verName =
1614         this->stringTable.data() +
1615         reinterpret_cast<const Elf_Verdef *>(verdefs[idx])->getAux()->vda_name;
1616     versionedNameBuffer.clear();
1617     name = (name + "@" + verName).toStringRef(versionedNameBuffer);
1618     symtab->addSymbol(SharedSymbol{*this, saver.save(name), sym.getBinding(),
1619                                    sym.st_other, sym.getType(), sym.st_value,
1620                                    sym.st_size, alignment, idx});
1621   }
1622 }
1623 
1624 static ELFKind getBitcodeELFKind(const Triple &t) {
1625   if (t.isLittleEndian())
1626     return t.isArch64Bit() ? ELF64LEKind : ELF32LEKind;
1627   return t.isArch64Bit() ? ELF64BEKind : ELF32BEKind;
1628 }
1629 
1630 static uint16_t getBitcodeMachineKind(StringRef path, const Triple &t) {
1631   switch (t.getArch()) {
1632   case Triple::aarch64:
1633   case Triple::aarch64_be:
1634     return EM_AARCH64;
1635   case Triple::amdgcn:
1636   case Triple::r600:
1637     return EM_AMDGPU;
1638   case Triple::arm:
1639   case Triple::thumb:
1640     return EM_ARM;
1641   case Triple::avr:
1642     return EM_AVR;
1643   case Triple::mips:
1644   case Triple::mipsel:
1645   case Triple::mips64:
1646   case Triple::mips64el:
1647     return EM_MIPS;
1648   case Triple::msp430:
1649     return EM_MSP430;
1650   case Triple::ppc:
1651   case Triple::ppcle:
1652     return EM_PPC;
1653   case Triple::ppc64:
1654   case Triple::ppc64le:
1655     return EM_PPC64;
1656   case Triple::riscv32:
1657   case Triple::riscv64:
1658     return EM_RISCV;
1659   case Triple::x86:
1660     return t.isOSIAMCU() ? EM_IAMCU : EM_386;
1661   case Triple::x86_64:
1662     return EM_X86_64;
1663   default:
1664     error(path + ": could not infer e_machine from bitcode target triple " +
1665           t.str());
1666     return EM_NONE;
1667   }
1668 }
1669 
1670 static uint8_t getOsAbi(const Triple &t) {
1671   switch (t.getOS()) {
1672   case Triple::AMDHSA:
1673     return ELF::ELFOSABI_AMDGPU_HSA;
1674   case Triple::AMDPAL:
1675     return ELF::ELFOSABI_AMDGPU_PAL;
1676   case Triple::Mesa3D:
1677     return ELF::ELFOSABI_AMDGPU_MESA3D;
1678   default:
1679     return ELF::ELFOSABI_NONE;
1680   }
1681 }
1682 
1683 BitcodeFile::BitcodeFile(MemoryBufferRef mb, StringRef archiveName,
1684                          uint64_t offsetInArchive)
1685     : InputFile(BitcodeKind, mb) {
1686   this->archiveName = std::string(archiveName);
1687 
1688   std::string path = mb.getBufferIdentifier().str();
1689   if (config->thinLTOIndexOnly)
1690     path = replaceThinLTOSuffix(mb.getBufferIdentifier());
1691 
1692   // ThinLTO assumes that all MemoryBufferRefs given to it have a unique
1693   // name. If two archives define two members with the same name, this
1694   // causes a collision which result in only one of the objects being taken
1695   // into consideration at LTO time (which very likely causes undefined
1696   // symbols later in the link stage). So we append file offset to make
1697   // filename unique.
1698   StringRef name =
1699       archiveName.empty()
1700           ? saver.save(path)
1701           : saver.save(archiveName + "(" + path::filename(path) + " at " +
1702                        utostr(offsetInArchive) + ")");
1703   MemoryBufferRef mbref(mb.getBuffer(), name);
1704 
1705   obj = CHECK(lto::InputFile::create(mbref), this);
1706 
1707   Triple t(obj->getTargetTriple());
1708   ekind = getBitcodeELFKind(t);
1709   emachine = getBitcodeMachineKind(mb.getBufferIdentifier(), t);
1710   osabi = getOsAbi(t);
1711 }
1712 
1713 static uint8_t mapVisibility(GlobalValue::VisibilityTypes gvVisibility) {
1714   switch (gvVisibility) {
1715   case GlobalValue::DefaultVisibility:
1716     return STV_DEFAULT;
1717   case GlobalValue::HiddenVisibility:
1718     return STV_HIDDEN;
1719   case GlobalValue::ProtectedVisibility:
1720     return STV_PROTECTED;
1721   }
1722   llvm_unreachable("unknown visibility");
1723 }
1724 
1725 template <class ELFT>
1726 static Symbol *createBitcodeSymbol(const std::vector<bool> &keptComdats,
1727                                    const lto::InputFile::Symbol &objSym,
1728                                    BitcodeFile &f) {
1729   StringRef name = saver.save(objSym.getName());
1730   uint8_t binding = objSym.isWeak() ? STB_WEAK : STB_GLOBAL;
1731   uint8_t type = objSym.isTLS() ? STT_TLS : STT_NOTYPE;
1732   uint8_t visibility = mapVisibility(objSym.getVisibility());
1733   bool canOmitFromDynSym = objSym.canBeOmittedFromSymbolTable();
1734 
1735   int c = objSym.getComdatIndex();
1736   if (objSym.isUndefined() || (c != -1 && !keptComdats[c])) {
1737     Undefined newSym(&f, name, binding, visibility, type);
1738     if (canOmitFromDynSym)
1739       newSym.exportDynamic = false;
1740     Symbol *ret = symtab->addSymbol(newSym);
1741     ret->referenced = true;
1742     return ret;
1743   }
1744 
1745   if (objSym.isCommon())
1746     return symtab->addSymbol(
1747         CommonSymbol{&f, name, binding, visibility, STT_OBJECT,
1748                      objSym.getCommonAlignment(), objSym.getCommonSize()});
1749 
1750   Defined newSym(&f, name, binding, visibility, type, 0, 0, nullptr);
1751   if (canOmitFromDynSym)
1752     newSym.exportDynamic = false;
1753   return symtab->addSymbol(newSym);
1754 }
1755 
1756 template <class ELFT> void BitcodeFile::parse() {
1757   std::vector<bool> keptComdats;
1758   for (StringRef s : obj->getComdatTable())
1759     keptComdats.push_back(
1760         symtab->comdatGroups.try_emplace(CachedHashStringRef(s), this).second);
1761 
1762   for (const lto::InputFile::Symbol &objSym : obj->symbols())
1763     symbols.push_back(createBitcodeSymbol<ELFT>(keptComdats, objSym, *this));
1764 
1765   for (auto l : obj->getDependentLibraries())
1766     addDependentLibrary(l, this);
1767 }
1768 
1769 void BinaryFile::parse() {
1770   ArrayRef<uint8_t> data = arrayRefFromStringRef(mb.getBuffer());
1771   auto *section = make<InputSection>(this, SHF_ALLOC | SHF_WRITE, SHT_PROGBITS,
1772                                      8, data, ".data");
1773   sections.push_back(section);
1774 
1775   // For each input file foo that is embedded to a result as a binary
1776   // blob, we define _binary_foo_{start,end,size} symbols, so that
1777   // user programs can access blobs by name. Non-alphanumeric
1778   // characters in a filename are replaced with underscore.
1779   std::string s = "_binary_" + mb.getBufferIdentifier().str();
1780   for (size_t i = 0; i < s.size(); ++i)
1781     if (!isAlnum(s[i]))
1782       s[i] = '_';
1783 
1784   symtab->addSymbol(Defined{nullptr, saver.save(s + "_start"), STB_GLOBAL,
1785                             STV_DEFAULT, STT_OBJECT, 0, 0, section});
1786   symtab->addSymbol(Defined{nullptr, saver.save(s + "_end"), STB_GLOBAL,
1787                             STV_DEFAULT, STT_OBJECT, data.size(), 0, section});
1788   symtab->addSymbol(Defined{nullptr, saver.save(s + "_size"), STB_GLOBAL,
1789                             STV_DEFAULT, STT_OBJECT, data.size(), 0, nullptr});
1790 }
1791 
1792 InputFile *elf::createObjectFile(MemoryBufferRef mb, StringRef archiveName,
1793                                  uint64_t offsetInArchive) {
1794   if (isBitcode(mb))
1795     return make<BitcodeFile>(mb, archiveName, offsetInArchive);
1796 
1797   switch (getELFKind(mb, archiveName)) {
1798   case ELF32LEKind:
1799     return make<ObjFile<ELF32LE>>(mb, archiveName);
1800   case ELF32BEKind:
1801     return make<ObjFile<ELF32BE>>(mb, archiveName);
1802   case ELF64LEKind:
1803     return make<ObjFile<ELF64LE>>(mb, archiveName);
1804   case ELF64BEKind:
1805     return make<ObjFile<ELF64BE>>(mb, archiveName);
1806   default:
1807     llvm_unreachable("getELFKind");
1808   }
1809 }
1810 
1811 void LazyObjFile::fetch() {
1812   if (fetched)
1813     return;
1814   fetched = true;
1815 
1816   InputFile *file = createObjectFile(mb, archiveName, offsetInArchive);
1817   file->groupId = groupId;
1818 
1819   // Copy symbol vector so that the new InputFile doesn't have to
1820   // insert the same defined symbols to the symbol table again.
1821   file->symbols = std::move(symbols);
1822 
1823   parseFile(file);
1824 }
1825 
1826 template <class ELFT> void LazyObjFile::parse() {
1827   using Elf_Sym = typename ELFT::Sym;
1828 
1829   // A lazy object file wraps either a bitcode file or an ELF file.
1830   if (isBitcode(this->mb)) {
1831     std::unique_ptr<lto::InputFile> obj =
1832         CHECK(lto::InputFile::create(this->mb), this);
1833     for (const lto::InputFile::Symbol &sym : obj->symbols()) {
1834       if (sym.isUndefined())
1835         continue;
1836       symtab->addSymbol(LazyObject{*this, saver.save(sym.getName())});
1837     }
1838     return;
1839   }
1840 
1841   if (getELFKind(this->mb, archiveName) != config->ekind) {
1842     error("incompatible file: " + this->mb.getBufferIdentifier());
1843     return;
1844   }
1845 
1846   // Find a symbol table.
1847   ELFFile<ELFT> obj = check(ELFFile<ELFT>::create(mb.getBuffer()));
1848   ArrayRef<typename ELFT::Shdr> sections = CHECK(obj.sections(), this);
1849 
1850   for (const typename ELFT::Shdr &sec : sections) {
1851     if (sec.sh_type != SHT_SYMTAB)
1852       continue;
1853 
1854     // A symbol table is found.
1855     ArrayRef<Elf_Sym> eSyms = CHECK(obj.symbols(&sec), this);
1856     uint32_t firstGlobal = sec.sh_info;
1857     StringRef strtab = CHECK(obj.getStringTableForSymtab(sec, sections), this);
1858     this->symbols.resize(eSyms.size());
1859 
1860     // Get existing symbols or insert placeholder symbols.
1861     for (size_t i = firstGlobal, end = eSyms.size(); i != end; ++i)
1862       if (eSyms[i].st_shndx != SHN_UNDEF)
1863         this->symbols[i] = symtab->insert(CHECK(eSyms[i].getName(strtab), this));
1864 
1865     // Replace existing symbols with LazyObject symbols.
1866     //
1867     // resolve() may trigger this->fetch() if an existing symbol is an
1868     // undefined symbol. If that happens, this LazyObjFile has served
1869     // its purpose, and we can exit from the loop early.
1870     for (Symbol *sym : this->symbols) {
1871       if (!sym)
1872         continue;
1873       sym->resolve(LazyObject{*this, sym->getName()});
1874 
1875       // If fetched, stop iterating because this->symbols has been transferred
1876       // to the instantiated ObjFile.
1877       if (fetched)
1878         return;
1879     }
1880     return;
1881   }
1882 }
1883 
1884 bool LazyObjFile::shouldFetchForCommon(const StringRef &name) {
1885   if (isBitcode(mb))
1886     return isBitcodeNonCommonDef(mb, name, archiveName);
1887 
1888   return isNonCommonDef(mb, name, archiveName);
1889 }
1890 
1891 std::string elf::replaceThinLTOSuffix(StringRef path) {
1892   StringRef suffix = config->thinLTOObjectSuffixReplace.first;
1893   StringRef repl = config->thinLTOObjectSuffixReplace.second;
1894 
1895   if (path.consume_back(suffix))
1896     return (path + repl).str();
1897   return std::string(path);
1898 }
1899 
1900 template void BitcodeFile::parse<ELF32LE>();
1901 template void BitcodeFile::parse<ELF32BE>();
1902 template void BitcodeFile::parse<ELF64LE>();
1903 template void BitcodeFile::parse<ELF64BE>();
1904 
1905 template void LazyObjFile::parse<ELF32LE>();
1906 template void LazyObjFile::parse<ELF32BE>();
1907 template void LazyObjFile::parse<ELF64LE>();
1908 template void LazyObjFile::parse<ELF64BE>();
1909 
1910 template class elf::ObjFile<ELF32LE>;
1911 template class elf::ObjFile<ELF32BE>;
1912 template class elf::ObjFile<ELF64LE>;
1913 template class elf::ObjFile<ELF64BE>;
1914 
1915 template void SharedFile::parse<ELF32LE>();
1916 template void SharedFile::parse<ELF32BE>();
1917 template void SharedFile::parse<ELF64LE>();
1918 template void SharedFile::parse<ELF64BE>();
1919