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