1 //===- SyntheticSections.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 // This file contains linker-synthesized sections. Currently,
10 // synthetic sections are created either output sections or input sections,
11 // but we are rewriting code so that all synthetic sections are created as
12 // input sections.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "SyntheticSections.h"
17 #include "Config.h"
18 #include "InputFiles.h"
19 #include "LinkerScript.h"
20 #include "OutputSections.h"
21 #include "SymbolTable.h"
22 #include "Symbols.h"
23 #include "Target.h"
24 #include "Writer.h"
25 #include "lld/Common/DWARF.h"
26 #include "lld/Common/ErrorHandler.h"
27 #include "lld/Common/Memory.h"
28 #include "lld/Common/Strings.h"
29 #include "lld/Common/Version.h"
30 #include "llvm/ADT/SetOperations.h"
31 #include "llvm/ADT/StringExtras.h"
32 #include "llvm/BinaryFormat/Dwarf.h"
33 #include "llvm/DebugInfo/DWARF/DWARFDebugPubTable.h"
34 #include "llvm/Object/ELFObjectFile.h"
35 #include "llvm/Support/Compression.h"
36 #include "llvm/Support/Endian.h"
37 #include "llvm/Support/LEB128.h"
38 #include "llvm/Support/MD5.h"
39 #include "llvm/Support/Parallel.h"
40 #include "llvm/Support/TimeProfiler.h"
41 #include <cstdlib>
42 #include <thread>
43 
44 using namespace llvm;
45 using namespace llvm::dwarf;
46 using namespace llvm::ELF;
47 using namespace llvm::object;
48 using namespace llvm::support;
49 using namespace lld;
50 using namespace lld::elf;
51 
52 using llvm::support::endian::read32le;
53 using llvm::support::endian::write32le;
54 using llvm::support::endian::write64le;
55 
56 constexpr size_t MergeNoTailSection::numShards;
57 
58 static uint64_t readUint(uint8_t *buf) {
59   return config->is64 ? read64(buf) : read32(buf);
60 }
61 
62 static void writeUint(uint8_t *buf, uint64_t val) {
63   if (config->is64)
64     write64(buf, val);
65   else
66     write32(buf, val);
67 }
68 
69 // Returns an LLD version string.
70 static ArrayRef<uint8_t> getVersion() {
71   // Check LLD_VERSION first for ease of testing.
72   // You can get consistent output by using the environment variable.
73   // This is only for testing.
74   StringRef s = getenv("LLD_VERSION");
75   if (s.empty())
76     s = saver.save(Twine("Linker: ") + getLLDVersion());
77 
78   // +1 to include the terminating '\0'.
79   return {(const uint8_t *)s.data(), s.size() + 1};
80 }
81 
82 // Creates a .comment section containing LLD version info.
83 // With this feature, you can identify LLD-generated binaries easily
84 // by "readelf --string-dump .comment <file>".
85 // The returned object is a mergeable string section.
86 MergeInputSection *elf::createCommentSection() {
87   return make<MergeInputSection>(SHF_MERGE | SHF_STRINGS, SHT_PROGBITS, 1,
88                                  getVersion(), ".comment");
89 }
90 
91 // .MIPS.abiflags section.
92 template <class ELFT>
93 MipsAbiFlagsSection<ELFT>::MipsAbiFlagsSection(Elf_Mips_ABIFlags flags)
94     : SyntheticSection(SHF_ALLOC, SHT_MIPS_ABIFLAGS, 8, ".MIPS.abiflags"),
95       flags(flags) {
96   this->entsize = sizeof(Elf_Mips_ABIFlags);
97 }
98 
99 template <class ELFT> void MipsAbiFlagsSection<ELFT>::writeTo(uint8_t *buf) {
100   memcpy(buf, &flags, sizeof(flags));
101 }
102 
103 template <class ELFT>
104 MipsAbiFlagsSection<ELFT> *MipsAbiFlagsSection<ELFT>::create() {
105   Elf_Mips_ABIFlags flags = {};
106   bool create = false;
107 
108   for (InputSectionBase *sec : inputSections) {
109     if (sec->type != SHT_MIPS_ABIFLAGS)
110       continue;
111     sec->markDead();
112     create = true;
113 
114     std::string filename = toString(sec->file);
115     const size_t size = sec->data().size();
116     // Older version of BFD (such as the default FreeBSD linker) concatenate
117     // .MIPS.abiflags instead of merging. To allow for this case (or potential
118     // zero padding) we ignore everything after the first Elf_Mips_ABIFlags
119     if (size < sizeof(Elf_Mips_ABIFlags)) {
120       error(filename + ": invalid size of .MIPS.abiflags section: got " +
121             Twine(size) + " instead of " + Twine(sizeof(Elf_Mips_ABIFlags)));
122       return nullptr;
123     }
124     auto *s = reinterpret_cast<const Elf_Mips_ABIFlags *>(sec->data().data());
125     if (s->version != 0) {
126       error(filename + ": unexpected .MIPS.abiflags version " +
127             Twine(s->version));
128       return nullptr;
129     }
130 
131     // LLD checks ISA compatibility in calcMipsEFlags(). Here we just
132     // select the highest number of ISA/Rev/Ext.
133     flags.isa_level = std::max(flags.isa_level, s->isa_level);
134     flags.isa_rev = std::max(flags.isa_rev, s->isa_rev);
135     flags.isa_ext = std::max(flags.isa_ext, s->isa_ext);
136     flags.gpr_size = std::max(flags.gpr_size, s->gpr_size);
137     flags.cpr1_size = std::max(flags.cpr1_size, s->cpr1_size);
138     flags.cpr2_size = std::max(flags.cpr2_size, s->cpr2_size);
139     flags.ases |= s->ases;
140     flags.flags1 |= s->flags1;
141     flags.flags2 |= s->flags2;
142     flags.fp_abi = elf::getMipsFpAbiFlag(flags.fp_abi, s->fp_abi, filename);
143   };
144 
145   if (create)
146     return make<MipsAbiFlagsSection<ELFT>>(flags);
147   return nullptr;
148 }
149 
150 // .MIPS.options section.
151 template <class ELFT>
152 MipsOptionsSection<ELFT>::MipsOptionsSection(Elf_Mips_RegInfo reginfo)
153     : SyntheticSection(SHF_ALLOC, SHT_MIPS_OPTIONS, 8, ".MIPS.options"),
154       reginfo(reginfo) {
155   this->entsize = sizeof(Elf_Mips_Options) + sizeof(Elf_Mips_RegInfo);
156 }
157 
158 template <class ELFT> void MipsOptionsSection<ELFT>::writeTo(uint8_t *buf) {
159   auto *options = reinterpret_cast<Elf_Mips_Options *>(buf);
160   options->kind = ODK_REGINFO;
161   options->size = getSize();
162 
163   if (!config->relocatable)
164     reginfo.ri_gp_value = in.mipsGot->getGp();
165   memcpy(buf + sizeof(Elf_Mips_Options), &reginfo, sizeof(reginfo));
166 }
167 
168 template <class ELFT>
169 MipsOptionsSection<ELFT> *MipsOptionsSection<ELFT>::create() {
170   // N64 ABI only.
171   if (!ELFT::Is64Bits)
172     return nullptr;
173 
174   std::vector<InputSectionBase *> sections;
175   for (InputSectionBase *sec : inputSections)
176     if (sec->type == SHT_MIPS_OPTIONS)
177       sections.push_back(sec);
178 
179   if (sections.empty())
180     return nullptr;
181 
182   Elf_Mips_RegInfo reginfo = {};
183   for (InputSectionBase *sec : sections) {
184     sec->markDead();
185 
186     std::string filename = toString(sec->file);
187     ArrayRef<uint8_t> d = sec->data();
188 
189     while (!d.empty()) {
190       if (d.size() < sizeof(Elf_Mips_Options)) {
191         error(filename + ": invalid size of .MIPS.options section");
192         break;
193       }
194 
195       auto *opt = reinterpret_cast<const Elf_Mips_Options *>(d.data());
196       if (opt->kind == ODK_REGINFO) {
197         reginfo.ri_gprmask |= opt->getRegInfo().ri_gprmask;
198         sec->getFile<ELFT>()->mipsGp0 = opt->getRegInfo().ri_gp_value;
199         break;
200       }
201 
202       if (!opt->size)
203         fatal(filename + ": zero option descriptor size");
204       d = d.slice(opt->size);
205     }
206   };
207 
208   return make<MipsOptionsSection<ELFT>>(reginfo);
209 }
210 
211 // MIPS .reginfo section.
212 template <class ELFT>
213 MipsReginfoSection<ELFT>::MipsReginfoSection(Elf_Mips_RegInfo reginfo)
214     : SyntheticSection(SHF_ALLOC, SHT_MIPS_REGINFO, 4, ".reginfo"),
215       reginfo(reginfo) {
216   this->entsize = sizeof(Elf_Mips_RegInfo);
217 }
218 
219 template <class ELFT> void MipsReginfoSection<ELFT>::writeTo(uint8_t *buf) {
220   if (!config->relocatable)
221     reginfo.ri_gp_value = in.mipsGot->getGp();
222   memcpy(buf, &reginfo, sizeof(reginfo));
223 }
224 
225 template <class ELFT>
226 MipsReginfoSection<ELFT> *MipsReginfoSection<ELFT>::create() {
227   // Section should be alive for O32 and N32 ABIs only.
228   if (ELFT::Is64Bits)
229     return nullptr;
230 
231   std::vector<InputSectionBase *> sections;
232   for (InputSectionBase *sec : inputSections)
233     if (sec->type == SHT_MIPS_REGINFO)
234       sections.push_back(sec);
235 
236   if (sections.empty())
237     return nullptr;
238 
239   Elf_Mips_RegInfo reginfo = {};
240   for (InputSectionBase *sec : sections) {
241     sec->markDead();
242 
243     if (sec->data().size() != sizeof(Elf_Mips_RegInfo)) {
244       error(toString(sec->file) + ": invalid size of .reginfo section");
245       return nullptr;
246     }
247 
248     auto *r = reinterpret_cast<const Elf_Mips_RegInfo *>(sec->data().data());
249     reginfo.ri_gprmask |= r->ri_gprmask;
250     sec->getFile<ELFT>()->mipsGp0 = r->ri_gp_value;
251   };
252 
253   return make<MipsReginfoSection<ELFT>>(reginfo);
254 }
255 
256 InputSection *elf::createInterpSection() {
257   // StringSaver guarantees that the returned string ends with '\0'.
258   StringRef s = saver.save(config->dynamicLinker);
259   ArrayRef<uint8_t> contents = {(const uint8_t *)s.data(), s.size() + 1};
260 
261   return make<InputSection>(nullptr, SHF_ALLOC, SHT_PROGBITS, 1, contents,
262                             ".interp");
263 }
264 
265 Defined *elf::addSyntheticLocal(StringRef name, uint8_t type, uint64_t value,
266                                 uint64_t size, InputSectionBase &section) {
267   auto *s = make<Defined>(section.file, name, STB_LOCAL, STV_DEFAULT, type,
268                           value, size, &section);
269   if (in.symTab)
270     in.symTab->addSymbol(s);
271   return s;
272 }
273 
274 static size_t getHashSize() {
275   switch (config->buildId) {
276   case BuildIdKind::Fast:
277     return 8;
278   case BuildIdKind::Md5:
279   case BuildIdKind::Uuid:
280     return 16;
281   case BuildIdKind::Sha1:
282     return 20;
283   case BuildIdKind::Hexstring:
284     return config->buildIdVector.size();
285   default:
286     llvm_unreachable("unknown BuildIdKind");
287   }
288 }
289 
290 // This class represents a linker-synthesized .note.gnu.property section.
291 //
292 // In x86 and AArch64, object files may contain feature flags indicating the
293 // features that they have used. The flags are stored in a .note.gnu.property
294 // section.
295 //
296 // lld reads the sections from input files and merges them by computing AND of
297 // the flags. The result is written as a new .note.gnu.property section.
298 //
299 // If the flag is zero (which indicates that the intersection of the feature
300 // sets is empty, or some input files didn't have .note.gnu.property sections),
301 // we don't create this section.
302 GnuPropertySection::GnuPropertySection()
303     : SyntheticSection(llvm::ELF::SHF_ALLOC, llvm::ELF::SHT_NOTE,
304                        config->wordsize, ".note.gnu.property") {}
305 
306 void GnuPropertySection::writeTo(uint8_t *buf) {
307   uint32_t featureAndType = config->emachine == EM_AARCH64
308                                 ? GNU_PROPERTY_AARCH64_FEATURE_1_AND
309                                 : GNU_PROPERTY_X86_FEATURE_1_AND;
310 
311   write32(buf, 4);                                   // Name size
312   write32(buf + 4, config->is64 ? 16 : 12);          // Content size
313   write32(buf + 8, NT_GNU_PROPERTY_TYPE_0);          // Type
314   memcpy(buf + 12, "GNU", 4);                        // Name string
315   write32(buf + 16, featureAndType);                 // Feature type
316   write32(buf + 20, 4);                              // Feature size
317   write32(buf + 24, config->andFeatures);            // Feature flags
318   if (config->is64)
319     write32(buf + 28, 0); // Padding
320 }
321 
322 size_t GnuPropertySection::getSize() const { return config->is64 ? 32 : 28; }
323 
324 BuildIdSection::BuildIdSection()
325     : SyntheticSection(SHF_ALLOC, SHT_NOTE, 4, ".note.gnu.build-id"),
326       hashSize(getHashSize()) {}
327 
328 void BuildIdSection::writeTo(uint8_t *buf) {
329   write32(buf, 4);                      // Name size
330   write32(buf + 4, hashSize);           // Content size
331   write32(buf + 8, NT_GNU_BUILD_ID);    // Type
332   memcpy(buf + 12, "GNU", 4);           // Name string
333   hashBuf = buf + 16;
334 }
335 
336 void BuildIdSection::writeBuildId(ArrayRef<uint8_t> buf) {
337   assert(buf.size() == hashSize);
338   memcpy(hashBuf, buf.data(), hashSize);
339 }
340 
341 BssSection::BssSection(StringRef name, uint64_t size, uint32_t alignment)
342     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_NOBITS, alignment, name) {
343   this->bss = true;
344   this->size = size;
345 }
346 
347 EhFrameSection::EhFrameSection()
348     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 1, ".eh_frame") {}
349 
350 // Search for an existing CIE record or create a new one.
351 // CIE records from input object files are uniquified by their contents
352 // and where their relocations point to.
353 template <class ELFT, class RelTy>
354 CieRecord *EhFrameSection::addCie(EhSectionPiece &cie, ArrayRef<RelTy> rels) {
355   Symbol *personality = nullptr;
356   unsigned firstRelI = cie.firstRelocation;
357   if (firstRelI != (unsigned)-1)
358     personality =
359         &cie.sec->template getFile<ELFT>()->getRelocTargetSym(rels[firstRelI]);
360 
361   // Search for an existing CIE by CIE contents/relocation target pair.
362   CieRecord *&rec = cieMap[{cie.data(), personality}];
363 
364   // If not found, create a new one.
365   if (!rec) {
366     rec = make<CieRecord>();
367     rec->cie = &cie;
368     cieRecords.push_back(rec);
369   }
370   return rec;
371 }
372 
373 // There is one FDE per function. Returns a non-null pointer to the function
374 // symbol if the given FDE points to a live function.
375 template <class ELFT, class RelTy>
376 Defined *EhFrameSection::isFdeLive(EhSectionPiece &fde, ArrayRef<RelTy> rels) {
377   auto *sec = cast<EhInputSection>(fde.sec);
378   unsigned firstRelI = fde.firstRelocation;
379 
380   // An FDE should point to some function because FDEs are to describe
381   // functions. That's however not always the case due to an issue of
382   // ld.gold with -r. ld.gold may discard only functions and leave their
383   // corresponding FDEs, which results in creating bad .eh_frame sections.
384   // To deal with that, we ignore such FDEs.
385   if (firstRelI == (unsigned)-1)
386     return nullptr;
387 
388   const RelTy &rel = rels[firstRelI];
389   Symbol &b = sec->template getFile<ELFT>()->getRelocTargetSym(rel);
390 
391   // FDEs for garbage-collected or merged-by-ICF sections, or sections in
392   // another partition, are dead.
393   if (auto *d = dyn_cast<Defined>(&b))
394     if (d->section && d->section->partition == partition)
395       return d;
396   return nullptr;
397 }
398 
399 // .eh_frame is a sequence of CIE or FDE records. In general, there
400 // is one CIE record per input object file which is followed by
401 // a list of FDEs. This function searches an existing CIE or create a new
402 // one and associates FDEs to the CIE.
403 template <class ELFT, class RelTy>
404 void EhFrameSection::addRecords(EhInputSection *sec, ArrayRef<RelTy> rels) {
405   offsetToCie.clear();
406   for (EhSectionPiece &piece : sec->pieces) {
407     // The empty record is the end marker.
408     if (piece.size == 4)
409       return;
410 
411     size_t offset = piece.inputOff;
412     uint32_t id = read32(piece.data().data() + 4);
413     if (id == 0) {
414       offsetToCie[offset] = addCie<ELFT>(piece, rels);
415       continue;
416     }
417 
418     uint32_t cieOffset = offset + 4 - id;
419     CieRecord *rec = offsetToCie[cieOffset];
420     if (!rec)
421       fatal(toString(sec) + ": invalid CIE reference");
422 
423     if (!isFdeLive<ELFT>(piece, rels))
424       continue;
425     rec->fdes.push_back(&piece);
426     numFdes++;
427   }
428 }
429 
430 template <class ELFT>
431 void EhFrameSection::addSectionAux(EhInputSection *sec) {
432   if (!sec->isLive())
433     return;
434   if (sec->areRelocsRela)
435     addRecords<ELFT>(sec, sec->template relas<ELFT>());
436   else
437     addRecords<ELFT>(sec, sec->template rels<ELFT>());
438 }
439 
440 void EhFrameSection::addSection(EhInputSection *sec) {
441   sec->parent = this;
442 
443   alignment = std::max(alignment, sec->alignment);
444   sections.push_back(sec);
445 
446   for (auto *ds : sec->dependentSections)
447     dependentSections.push_back(ds);
448 }
449 
450 // Used by ICF<ELFT>::handleLSDA(). This function is very similar to
451 // EhFrameSection::addRecords().
452 template <class ELFT, class RelTy>
453 void EhFrameSection::iterateFDEWithLSDAAux(
454     EhInputSection &sec, ArrayRef<RelTy> rels, DenseSet<size_t> &ciesWithLSDA,
455     llvm::function_ref<void(InputSection &)> fn) {
456   for (EhSectionPiece &piece : sec.pieces) {
457     // Skip ZERO terminator.
458     if (piece.size == 4)
459       continue;
460 
461     size_t offset = piece.inputOff;
462     uint32_t id =
463         endian::read32<ELFT::TargetEndianness>(piece.data().data() + 4);
464     if (id == 0) {
465       if (hasLSDA(piece))
466         ciesWithLSDA.insert(offset);
467       continue;
468     }
469     uint32_t cieOffset = offset + 4 - id;
470     if (ciesWithLSDA.count(cieOffset) == 0)
471       continue;
472 
473     // The CIE has a LSDA argument. Call fn with d's section.
474     if (Defined *d = isFdeLive<ELFT>(piece, rels))
475       if (auto *s = dyn_cast_or_null<InputSection>(d->section))
476         fn(*s);
477   }
478 }
479 
480 template <class ELFT>
481 void EhFrameSection::iterateFDEWithLSDA(
482     llvm::function_ref<void(InputSection &)> fn) {
483   DenseSet<size_t> ciesWithLSDA;
484   for (EhInputSection *sec : sections) {
485     ciesWithLSDA.clear();
486     if (sec->areRelocsRela)
487       iterateFDEWithLSDAAux<ELFT>(*sec, sec->template relas<ELFT>(),
488                                   ciesWithLSDA, fn);
489     else
490       iterateFDEWithLSDAAux<ELFT>(*sec, sec->template rels<ELFT>(),
491                                   ciesWithLSDA, fn);
492   }
493 }
494 
495 static void writeCieFde(uint8_t *buf, ArrayRef<uint8_t> d) {
496   memcpy(buf, d.data(), d.size());
497 
498   size_t aligned = alignTo(d.size(), config->wordsize);
499 
500   // Zero-clear trailing padding if it exists.
501   memset(buf + d.size(), 0, aligned - d.size());
502 
503   // Fix the size field. -4 since size does not include the size field itself.
504   write32(buf, aligned - 4);
505 }
506 
507 void EhFrameSection::finalizeContents() {
508   assert(!this->size); // Not finalized.
509 
510   switch (config->ekind) {
511   case ELFNoneKind:
512     llvm_unreachable("invalid ekind");
513   case ELF32LEKind:
514     for (EhInputSection *sec : sections)
515       addSectionAux<ELF32LE>(sec);
516     break;
517   case ELF32BEKind:
518     for (EhInputSection *sec : sections)
519       addSectionAux<ELF32BE>(sec);
520     break;
521   case ELF64LEKind:
522     for (EhInputSection *sec : sections)
523       addSectionAux<ELF64LE>(sec);
524     break;
525   case ELF64BEKind:
526     for (EhInputSection *sec : sections)
527       addSectionAux<ELF64BE>(sec);
528     break;
529   }
530 
531   size_t off = 0;
532   for (CieRecord *rec : cieRecords) {
533     rec->cie->outputOff = off;
534     off += alignTo(rec->cie->size, config->wordsize);
535 
536     for (EhSectionPiece *fde : rec->fdes) {
537       fde->outputOff = off;
538       off += alignTo(fde->size, config->wordsize);
539     }
540   }
541 
542   // The LSB standard does not allow a .eh_frame section with zero
543   // Call Frame Information records. glibc unwind-dw2-fde.c
544   // classify_object_over_fdes expects there is a CIE record length 0 as a
545   // terminator. Thus we add one unconditionally.
546   off += 4;
547 
548   this->size = off;
549 }
550 
551 // Returns data for .eh_frame_hdr. .eh_frame_hdr is a binary search table
552 // to get an FDE from an address to which FDE is applied. This function
553 // returns a list of such pairs.
554 std::vector<EhFrameSection::FdeData> EhFrameSection::getFdeData() const {
555   uint8_t *buf = Out::bufferStart + getParent()->offset + outSecOff;
556   std::vector<FdeData> ret;
557 
558   uint64_t va = getPartition().ehFrameHdr->getVA();
559   for (CieRecord *rec : cieRecords) {
560     uint8_t enc = getFdeEncoding(rec->cie);
561     for (EhSectionPiece *fde : rec->fdes) {
562       uint64_t pc = getFdePc(buf, fde->outputOff, enc);
563       uint64_t fdeVA = getParent()->addr + fde->outputOff;
564       if (!isInt<32>(pc - va))
565         fatal(toString(fde->sec) + ": PC offset is too large: 0x" +
566               Twine::utohexstr(pc - va));
567       ret.push_back({uint32_t(pc - va), uint32_t(fdeVA - va)});
568     }
569   }
570 
571   // Sort the FDE list by their PC and uniqueify. Usually there is only
572   // one FDE for a PC (i.e. function), but if ICF merges two functions
573   // into one, there can be more than one FDEs pointing to the address.
574   auto less = [](const FdeData &a, const FdeData &b) {
575     return a.pcRel < b.pcRel;
576   };
577   llvm::stable_sort(ret, less);
578   auto eq = [](const FdeData &a, const FdeData &b) {
579     return a.pcRel == b.pcRel;
580   };
581   ret.erase(std::unique(ret.begin(), ret.end(), eq), ret.end());
582 
583   return ret;
584 }
585 
586 static uint64_t readFdeAddr(uint8_t *buf, int size) {
587   switch (size) {
588   case DW_EH_PE_udata2:
589     return read16(buf);
590   case DW_EH_PE_sdata2:
591     return (int16_t)read16(buf);
592   case DW_EH_PE_udata4:
593     return read32(buf);
594   case DW_EH_PE_sdata4:
595     return (int32_t)read32(buf);
596   case DW_EH_PE_udata8:
597   case DW_EH_PE_sdata8:
598     return read64(buf);
599   case DW_EH_PE_absptr:
600     return readUint(buf);
601   }
602   fatal("unknown FDE size encoding");
603 }
604 
605 // Returns the VA to which a given FDE (on a mmap'ed buffer) is applied to.
606 // We need it to create .eh_frame_hdr section.
607 uint64_t EhFrameSection::getFdePc(uint8_t *buf, size_t fdeOff,
608                                   uint8_t enc) const {
609   // The starting address to which this FDE applies is
610   // stored at FDE + 8 byte.
611   size_t off = fdeOff + 8;
612   uint64_t addr = readFdeAddr(buf + off, enc & 0xf);
613   if ((enc & 0x70) == DW_EH_PE_absptr)
614     return addr;
615   if ((enc & 0x70) == DW_EH_PE_pcrel)
616     return addr + getParent()->addr + off;
617   fatal("unknown FDE size relative encoding");
618 }
619 
620 void EhFrameSection::writeTo(uint8_t *buf) {
621   // Write CIE and FDE records.
622   for (CieRecord *rec : cieRecords) {
623     size_t cieOffset = rec->cie->outputOff;
624     writeCieFde(buf + cieOffset, rec->cie->data());
625 
626     for (EhSectionPiece *fde : rec->fdes) {
627       size_t off = fde->outputOff;
628       writeCieFde(buf + off, fde->data());
629 
630       // FDE's second word should have the offset to an associated CIE.
631       // Write it.
632       write32(buf + off + 4, off + 4 - cieOffset);
633     }
634   }
635 
636   // Apply relocations. .eh_frame section contents are not contiguous
637   // in the output buffer, but relocateAlloc() still works because
638   // getOffset() takes care of discontiguous section pieces.
639   for (EhInputSection *s : sections)
640     s->relocateAlloc(buf, nullptr);
641 
642   if (getPartition().ehFrameHdr && getPartition().ehFrameHdr->getParent())
643     getPartition().ehFrameHdr->write();
644 }
645 
646 GotSection::GotSection()
647     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
648                        ".got") {
649   numEntries = target->gotHeaderEntriesNum;
650 }
651 
652 void GotSection::addEntry(Symbol &sym) {
653   sym.gotIndex = numEntries;
654   ++numEntries;
655 }
656 
657 bool GotSection::addDynTlsEntry(Symbol &sym) {
658   if (sym.globalDynIndex != -1U)
659     return false;
660   sym.globalDynIndex = numEntries;
661   // Global Dynamic TLS entries take two GOT slots.
662   numEntries += 2;
663   return true;
664 }
665 
666 // Reserves TLS entries for a TLS module ID and a TLS block offset.
667 // In total it takes two GOT slots.
668 bool GotSection::addTlsIndex() {
669   if (tlsIndexOff != uint32_t(-1))
670     return false;
671   tlsIndexOff = numEntries * config->wordsize;
672   numEntries += 2;
673   return true;
674 }
675 
676 uint64_t GotSection::getGlobalDynAddr(const Symbol &b) const {
677   return this->getVA() + b.globalDynIndex * config->wordsize;
678 }
679 
680 uint64_t GotSection::getGlobalDynOffset(const Symbol &b) const {
681   return b.globalDynIndex * config->wordsize;
682 }
683 
684 void GotSection::finalizeContents() {
685   if (config->emachine == EM_PPC64 &&
686       numEntries <= target->gotHeaderEntriesNum && !ElfSym::globalOffsetTable)
687     size = 0;
688   else
689     size = numEntries * config->wordsize;
690 }
691 
692 bool GotSection::isNeeded() const {
693   // Needed if the GOT symbol is used or the number of entries is more than just
694   // the header. A GOT with just the header may not be needed.
695   return hasGotOffRel || numEntries > target->gotHeaderEntriesNum;
696 }
697 
698 void GotSection::writeTo(uint8_t *buf) {
699   target->writeGotHeader(buf);
700   relocateAlloc(buf, buf + size);
701 }
702 
703 static uint64_t getMipsPageAddr(uint64_t addr) {
704   return (addr + 0x8000) & ~0xffff;
705 }
706 
707 static uint64_t getMipsPageCount(uint64_t size) {
708   return (size + 0xfffe) / 0xffff + 1;
709 }
710 
711 MipsGotSection::MipsGotSection()
712     : SyntheticSection(SHF_ALLOC | SHF_WRITE | SHF_MIPS_GPREL, SHT_PROGBITS, 16,
713                        ".got") {}
714 
715 void MipsGotSection::addEntry(InputFile &file, Symbol &sym, int64_t addend,
716                               RelExpr expr) {
717   FileGot &g = getGot(file);
718   if (expr == R_MIPS_GOT_LOCAL_PAGE) {
719     if (const OutputSection *os = sym.getOutputSection())
720       g.pagesMap.insert({os, {}});
721     else
722       g.local16.insert({{nullptr, getMipsPageAddr(sym.getVA(addend))}, 0});
723   } else if (sym.isTls())
724     g.tls.insert({&sym, 0});
725   else if (sym.isPreemptible && expr == R_ABS)
726     g.relocs.insert({&sym, 0});
727   else if (sym.isPreemptible)
728     g.global.insert({&sym, 0});
729   else if (expr == R_MIPS_GOT_OFF32)
730     g.local32.insert({{&sym, addend}, 0});
731   else
732     g.local16.insert({{&sym, addend}, 0});
733 }
734 
735 void MipsGotSection::addDynTlsEntry(InputFile &file, Symbol &sym) {
736   getGot(file).dynTlsSymbols.insert({&sym, 0});
737 }
738 
739 void MipsGotSection::addTlsIndex(InputFile &file) {
740   getGot(file).dynTlsSymbols.insert({nullptr, 0});
741 }
742 
743 size_t MipsGotSection::FileGot::getEntriesNum() const {
744   return getPageEntriesNum() + local16.size() + global.size() + relocs.size() +
745          tls.size() + dynTlsSymbols.size() * 2;
746 }
747 
748 size_t MipsGotSection::FileGot::getPageEntriesNum() const {
749   size_t num = 0;
750   for (const std::pair<const OutputSection *, FileGot::PageBlock> &p : pagesMap)
751     num += p.second.count;
752   return num;
753 }
754 
755 size_t MipsGotSection::FileGot::getIndexedEntriesNum() const {
756   size_t count = getPageEntriesNum() + local16.size() + global.size();
757   // If there are relocation-only entries in the GOT, TLS entries
758   // are allocated after them. TLS entries should be addressable
759   // by 16-bit index so count both reloc-only and TLS entries.
760   if (!tls.empty() || !dynTlsSymbols.empty())
761     count += relocs.size() + tls.size() + dynTlsSymbols.size() * 2;
762   return count;
763 }
764 
765 MipsGotSection::FileGot &MipsGotSection::getGot(InputFile &f) {
766   if (!f.mipsGotIndex.hasValue()) {
767     gots.emplace_back();
768     gots.back().file = &f;
769     f.mipsGotIndex = gots.size() - 1;
770   }
771   return gots[*f.mipsGotIndex];
772 }
773 
774 uint64_t MipsGotSection::getPageEntryOffset(const InputFile *f,
775                                             const Symbol &sym,
776                                             int64_t addend) const {
777   const FileGot &g = gots[*f->mipsGotIndex];
778   uint64_t index = 0;
779   if (const OutputSection *outSec = sym.getOutputSection()) {
780     uint64_t secAddr = getMipsPageAddr(outSec->addr);
781     uint64_t symAddr = getMipsPageAddr(sym.getVA(addend));
782     index = g.pagesMap.lookup(outSec).firstIndex + (symAddr - secAddr) / 0xffff;
783   } else {
784     index = g.local16.lookup({nullptr, getMipsPageAddr(sym.getVA(addend))});
785   }
786   return index * config->wordsize;
787 }
788 
789 uint64_t MipsGotSection::getSymEntryOffset(const InputFile *f, const Symbol &s,
790                                            int64_t addend) const {
791   const FileGot &g = gots[*f->mipsGotIndex];
792   Symbol *sym = const_cast<Symbol *>(&s);
793   if (sym->isTls())
794     return g.tls.lookup(sym) * config->wordsize;
795   if (sym->isPreemptible)
796     return g.global.lookup(sym) * config->wordsize;
797   return g.local16.lookup({sym, addend}) * config->wordsize;
798 }
799 
800 uint64_t MipsGotSection::getTlsIndexOffset(const InputFile *f) const {
801   const FileGot &g = gots[*f->mipsGotIndex];
802   return g.dynTlsSymbols.lookup(nullptr) * config->wordsize;
803 }
804 
805 uint64_t MipsGotSection::getGlobalDynOffset(const InputFile *f,
806                                             const Symbol &s) const {
807   const FileGot &g = gots[*f->mipsGotIndex];
808   Symbol *sym = const_cast<Symbol *>(&s);
809   return g.dynTlsSymbols.lookup(sym) * config->wordsize;
810 }
811 
812 const Symbol *MipsGotSection::getFirstGlobalEntry() const {
813   if (gots.empty())
814     return nullptr;
815   const FileGot &primGot = gots.front();
816   if (!primGot.global.empty())
817     return primGot.global.front().first;
818   if (!primGot.relocs.empty())
819     return primGot.relocs.front().first;
820   return nullptr;
821 }
822 
823 unsigned MipsGotSection::getLocalEntriesNum() const {
824   if (gots.empty())
825     return headerEntriesNum;
826   return headerEntriesNum + gots.front().getPageEntriesNum() +
827          gots.front().local16.size();
828 }
829 
830 bool MipsGotSection::tryMergeGots(FileGot &dst, FileGot &src, bool isPrimary) {
831   FileGot tmp = dst;
832   set_union(tmp.pagesMap, src.pagesMap);
833   set_union(tmp.local16, src.local16);
834   set_union(tmp.global, src.global);
835   set_union(tmp.relocs, src.relocs);
836   set_union(tmp.tls, src.tls);
837   set_union(tmp.dynTlsSymbols, src.dynTlsSymbols);
838 
839   size_t count = isPrimary ? headerEntriesNum : 0;
840   count += tmp.getIndexedEntriesNum();
841 
842   if (count * config->wordsize > config->mipsGotSize)
843     return false;
844 
845   std::swap(tmp, dst);
846   return true;
847 }
848 
849 void MipsGotSection::finalizeContents() { updateAllocSize(); }
850 
851 bool MipsGotSection::updateAllocSize() {
852   size = headerEntriesNum * config->wordsize;
853   for (const FileGot &g : gots)
854     size += g.getEntriesNum() * config->wordsize;
855   return false;
856 }
857 
858 void MipsGotSection::build() {
859   if (gots.empty())
860     return;
861 
862   std::vector<FileGot> mergedGots(1);
863 
864   // For each GOT move non-preemptible symbols from the `Global`
865   // to `Local16` list. Preemptible symbol might become non-preemptible
866   // one if, for example, it gets a related copy relocation.
867   for (FileGot &got : gots) {
868     for (auto &p: got.global)
869       if (!p.first->isPreemptible)
870         got.local16.insert({{p.first, 0}, 0});
871     got.global.remove_if([&](const std::pair<Symbol *, size_t> &p) {
872       return !p.first->isPreemptible;
873     });
874   }
875 
876   // For each GOT remove "reloc-only" entry if there is "global"
877   // entry for the same symbol. And add local entries which indexed
878   // using 32-bit value at the end of 16-bit entries.
879   for (FileGot &got : gots) {
880     got.relocs.remove_if([&](const std::pair<Symbol *, size_t> &p) {
881       return got.global.count(p.first);
882     });
883     set_union(got.local16, got.local32);
884     got.local32.clear();
885   }
886 
887   // Evaluate number of "reloc-only" entries in the resulting GOT.
888   // To do that put all unique "reloc-only" and "global" entries
889   // from all GOTs to the future primary GOT.
890   FileGot *primGot = &mergedGots.front();
891   for (FileGot &got : gots) {
892     set_union(primGot->relocs, got.global);
893     set_union(primGot->relocs, got.relocs);
894     got.relocs.clear();
895   }
896 
897   // Evaluate number of "page" entries in each GOT.
898   for (FileGot &got : gots) {
899     for (std::pair<const OutputSection *, FileGot::PageBlock> &p :
900          got.pagesMap) {
901       const OutputSection *os = p.first;
902       uint64_t secSize = 0;
903       for (BaseCommand *cmd : os->sectionCommands) {
904         if (auto *isd = dyn_cast<InputSectionDescription>(cmd))
905           for (InputSection *isec : isd->sections) {
906             uint64_t off = alignTo(secSize, isec->alignment);
907             secSize = off + isec->getSize();
908           }
909       }
910       p.second.count = getMipsPageCount(secSize);
911     }
912   }
913 
914   // Merge GOTs. Try to join as much as possible GOTs but do not exceed
915   // maximum GOT size. At first, try to fill the primary GOT because
916   // the primary GOT can be accessed in the most effective way. If it
917   // is not possible, try to fill the last GOT in the list, and finally
918   // create a new GOT if both attempts failed.
919   for (FileGot &srcGot : gots) {
920     InputFile *file = srcGot.file;
921     if (tryMergeGots(mergedGots.front(), srcGot, true)) {
922       file->mipsGotIndex = 0;
923     } else {
924       // If this is the first time we failed to merge with the primary GOT,
925       // MergedGots.back() will also be the primary GOT. We must make sure not
926       // to try to merge again with isPrimary=false, as otherwise, if the
927       // inputs are just right, we could allow the primary GOT to become 1 or 2
928       // words bigger due to ignoring the header size.
929       if (mergedGots.size() == 1 ||
930           !tryMergeGots(mergedGots.back(), srcGot, false)) {
931         mergedGots.emplace_back();
932         std::swap(mergedGots.back(), srcGot);
933       }
934       file->mipsGotIndex = mergedGots.size() - 1;
935     }
936   }
937   std::swap(gots, mergedGots);
938 
939   // Reduce number of "reloc-only" entries in the primary GOT
940   // by subtracting "global" entries in the primary GOT.
941   primGot = &gots.front();
942   primGot->relocs.remove_if([&](const std::pair<Symbol *, size_t> &p) {
943     return primGot->global.count(p.first);
944   });
945 
946   // Calculate indexes for each GOT entry.
947   size_t index = headerEntriesNum;
948   for (FileGot &got : gots) {
949     got.startIndex = &got == primGot ? 0 : index;
950     for (std::pair<const OutputSection *, FileGot::PageBlock> &p :
951          got.pagesMap) {
952       // For each output section referenced by GOT page relocations calculate
953       // and save into pagesMap an upper bound of MIPS GOT entries required
954       // to store page addresses of local symbols. We assume the worst case -
955       // each 64kb page of the output section has at least one GOT relocation
956       // against it. And take in account the case when the section intersects
957       // page boundaries.
958       p.second.firstIndex = index;
959       index += p.second.count;
960     }
961     for (auto &p: got.local16)
962       p.second = index++;
963     for (auto &p: got.global)
964       p.second = index++;
965     for (auto &p: got.relocs)
966       p.second = index++;
967     for (auto &p: got.tls)
968       p.second = index++;
969     for (auto &p: got.dynTlsSymbols) {
970       p.second = index;
971       index += 2;
972     }
973   }
974 
975   // Update Symbol::gotIndex field to use this
976   // value later in the `sortMipsSymbols` function.
977   for (auto &p : primGot->global)
978     p.first->gotIndex = p.second;
979   for (auto &p : primGot->relocs)
980     p.first->gotIndex = p.second;
981 
982   // Create dynamic relocations.
983   for (FileGot &got : gots) {
984     // Create dynamic relocations for TLS entries.
985     for (std::pair<Symbol *, size_t> &p : got.tls) {
986       Symbol *s = p.first;
987       uint64_t offset = p.second * config->wordsize;
988       // When building a shared library we still need a dynamic relocation
989       // for the TP-relative offset as we don't know how much other data will
990       // be allocated before us in the static TLS block.
991       if (s->isPreemptible || config->shared)
992         mainPart->relaDyn->addReloc(target->tlsGotRel, this, offset, s);
993     }
994     for (std::pair<Symbol *, size_t> &p : got.dynTlsSymbols) {
995       Symbol *s = p.first;
996       uint64_t offset = p.second * config->wordsize;
997       if (s == nullptr) {
998         if (!config->shared)
999           continue;
1000         mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, this, offset, s);
1001       } else {
1002         // When building a shared library we still need a dynamic relocation
1003         // for the module index. Therefore only checking for
1004         // S->isPreemptible is not sufficient (this happens e.g. for
1005         // thread-locals that have been marked as local through a linker script)
1006         if (!s->isPreemptible && !config->shared)
1007           continue;
1008         mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, this, offset, s);
1009         // However, we can skip writing the TLS offset reloc for non-preemptible
1010         // symbols since it is known even in shared libraries
1011         if (!s->isPreemptible)
1012           continue;
1013         offset += config->wordsize;
1014         mainPart->relaDyn->addReloc(target->tlsOffsetRel, this, offset, s);
1015       }
1016     }
1017 
1018     // Do not create dynamic relocations for non-TLS
1019     // entries in the primary GOT.
1020     if (&got == primGot)
1021       continue;
1022 
1023     // Dynamic relocations for "global" entries.
1024     for (const std::pair<Symbol *, size_t> &p : got.global) {
1025       uint64_t offset = p.second * config->wordsize;
1026       mainPart->relaDyn->addReloc(target->relativeRel, this, offset, p.first);
1027     }
1028     if (!config->isPic)
1029       continue;
1030     // Dynamic relocations for "local" entries in case of PIC.
1031     for (const std::pair<const OutputSection *, FileGot::PageBlock> &l :
1032          got.pagesMap) {
1033       size_t pageCount = l.second.count;
1034       for (size_t pi = 0; pi < pageCount; ++pi) {
1035         uint64_t offset = (l.second.firstIndex + pi) * config->wordsize;
1036         mainPart->relaDyn->addReloc({target->relativeRel, this, offset, l.first,
1037                                  int64_t(pi * 0x10000)});
1038       }
1039     }
1040     for (const std::pair<GotEntry, size_t> &p : got.local16) {
1041       uint64_t offset = p.second * config->wordsize;
1042       mainPart->relaDyn->addReloc({target->relativeRel, this, offset, true,
1043                                p.first.first, p.first.second});
1044     }
1045   }
1046 }
1047 
1048 bool MipsGotSection::isNeeded() const {
1049   // We add the .got section to the result for dynamic MIPS target because
1050   // its address and properties are mentioned in the .dynamic section.
1051   return !config->relocatable;
1052 }
1053 
1054 uint64_t MipsGotSection::getGp(const InputFile *f) const {
1055   // For files without related GOT or files refer a primary GOT
1056   // returns "common" _gp value. For secondary GOTs calculate
1057   // individual _gp values.
1058   if (!f || !f->mipsGotIndex.hasValue() || *f->mipsGotIndex == 0)
1059     return ElfSym::mipsGp->getVA(0);
1060   return getVA() + gots[*f->mipsGotIndex].startIndex * config->wordsize +
1061          0x7ff0;
1062 }
1063 
1064 void MipsGotSection::writeTo(uint8_t *buf) {
1065   // Set the MSB of the second GOT slot. This is not required by any
1066   // MIPS ABI documentation, though.
1067   //
1068   // There is a comment in glibc saying that "The MSB of got[1] of a
1069   // gnu object is set to identify gnu objects," and in GNU gold it
1070   // says "the second entry will be used by some runtime loaders".
1071   // But how this field is being used is unclear.
1072   //
1073   // We are not really willing to mimic other linkers behaviors
1074   // without understanding why they do that, but because all files
1075   // generated by GNU tools have this special GOT value, and because
1076   // we've been doing this for years, it is probably a safe bet to
1077   // keep doing this for now. We really need to revisit this to see
1078   // if we had to do this.
1079   writeUint(buf + config->wordsize, (uint64_t)1 << (config->wordsize * 8 - 1));
1080   for (const FileGot &g : gots) {
1081     auto write = [&](size_t i, const Symbol *s, int64_t a) {
1082       uint64_t va = a;
1083       if (s)
1084         va = s->getVA(a);
1085       writeUint(buf + i * config->wordsize, va);
1086     };
1087     // Write 'page address' entries to the local part of the GOT.
1088     for (const std::pair<const OutputSection *, FileGot::PageBlock> &l :
1089          g.pagesMap) {
1090       size_t pageCount = l.second.count;
1091       uint64_t firstPageAddr = getMipsPageAddr(l.first->addr);
1092       for (size_t pi = 0; pi < pageCount; ++pi)
1093         write(l.second.firstIndex + pi, nullptr, firstPageAddr + pi * 0x10000);
1094     }
1095     // Local, global, TLS, reloc-only  entries.
1096     // If TLS entry has a corresponding dynamic relocations, leave it
1097     // initialized by zero. Write down adjusted TLS symbol's values otherwise.
1098     // To calculate the adjustments use offsets for thread-local storage.
1099     // http://web.archive.org/web/20190324223224/https://www.linux-mips.org/wiki/NPTL
1100     for (const std::pair<GotEntry, size_t> &p : g.local16)
1101       write(p.second, p.first.first, p.first.second);
1102     // Write VA to the primary GOT only. For secondary GOTs that
1103     // will be done by REL32 dynamic relocations.
1104     if (&g == &gots.front())
1105       for (const std::pair<Symbol *, size_t> &p : g.global)
1106         write(p.second, p.first, 0);
1107     for (const std::pair<Symbol *, size_t> &p : g.relocs)
1108       write(p.second, p.first, 0);
1109     for (const std::pair<Symbol *, size_t> &p : g.tls)
1110       write(p.second, p.first,
1111             p.first->isPreemptible || config->shared ? 0 : -0x7000);
1112     for (const std::pair<Symbol *, size_t> &p : g.dynTlsSymbols) {
1113       if (p.first == nullptr && !config->shared)
1114         write(p.second, nullptr, 1);
1115       else if (p.first && !p.first->isPreemptible) {
1116         // If we are emitting a shared libary with relocations we mustn't write
1117         // anything to the GOT here. When using Elf_Rel relocations the value
1118         // one will be treated as an addend and will cause crashes at runtime
1119         if (!config->shared)
1120           write(p.second, nullptr, 1);
1121         write(p.second + 1, p.first, -0x8000);
1122       }
1123     }
1124   }
1125 }
1126 
1127 // On PowerPC the .plt section is used to hold the table of function addresses
1128 // instead of the .got.plt, and the type is SHT_NOBITS similar to a .bss
1129 // section. I don't know why we have a BSS style type for the section but it is
1130 // consistent across both 64-bit PowerPC ABIs as well as the 32-bit PowerPC ABI.
1131 GotPltSection::GotPltSection()
1132     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
1133                        ".got.plt") {
1134   if (config->emachine == EM_PPC) {
1135     name = ".plt";
1136   } else if (config->emachine == EM_PPC64) {
1137     type = SHT_NOBITS;
1138     name = ".plt";
1139   }
1140 }
1141 
1142 void GotPltSection::addEntry(Symbol &sym) {
1143   assert(sym.pltIndex == entries.size());
1144   entries.push_back(&sym);
1145 }
1146 
1147 size_t GotPltSection::getSize() const {
1148   return (target->gotPltHeaderEntriesNum + entries.size()) * config->wordsize;
1149 }
1150 
1151 void GotPltSection::writeTo(uint8_t *buf) {
1152   target->writeGotPltHeader(buf);
1153   buf += target->gotPltHeaderEntriesNum * config->wordsize;
1154   for (const Symbol *b : entries) {
1155     target->writeGotPlt(buf, *b);
1156     buf += config->wordsize;
1157   }
1158 }
1159 
1160 bool GotPltSection::isNeeded() const {
1161   // We need to emit GOTPLT even if it's empty if there's a relocation relative
1162   // to it.
1163   return !entries.empty() || hasGotPltOffRel;
1164 }
1165 
1166 static StringRef getIgotPltName() {
1167   // On ARM the IgotPltSection is part of the GotSection.
1168   if (config->emachine == EM_ARM)
1169     return ".got";
1170 
1171   // On PowerPC64 the GotPltSection is renamed to '.plt' so the IgotPltSection
1172   // needs to be named the same.
1173   if (config->emachine == EM_PPC64)
1174     return ".plt";
1175 
1176   return ".got.plt";
1177 }
1178 
1179 // On PowerPC64 the GotPltSection type is SHT_NOBITS so we have to follow suit
1180 // with the IgotPltSection.
1181 IgotPltSection::IgotPltSection()
1182     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
1183                        config->emachine == EM_PPC64 ? SHT_NOBITS : SHT_PROGBITS,
1184                        config->wordsize, getIgotPltName()) {}
1185 
1186 void IgotPltSection::addEntry(Symbol &sym) {
1187   assert(sym.pltIndex == entries.size());
1188   entries.push_back(&sym);
1189 }
1190 
1191 size_t IgotPltSection::getSize() const {
1192   return entries.size() * config->wordsize;
1193 }
1194 
1195 void IgotPltSection::writeTo(uint8_t *buf) {
1196   for (const Symbol *b : entries) {
1197     target->writeIgotPlt(buf, *b);
1198     buf += config->wordsize;
1199   }
1200 }
1201 
1202 StringTableSection::StringTableSection(StringRef name, bool dynamic)
1203     : SyntheticSection(dynamic ? (uint64_t)SHF_ALLOC : 0, SHT_STRTAB, 1, name),
1204       dynamic(dynamic) {
1205   // ELF string tables start with a NUL byte.
1206   addString("");
1207 }
1208 
1209 // Adds a string to the string table. If `hashIt` is true we hash and check for
1210 // duplicates. It is optional because the name of global symbols are already
1211 // uniqued and hashing them again has a big cost for a small value: uniquing
1212 // them with some other string that happens to be the same.
1213 unsigned StringTableSection::addString(StringRef s, bool hashIt) {
1214   if (hashIt) {
1215     auto r = stringMap.insert(std::make_pair(s, this->size));
1216     if (!r.second)
1217       return r.first->second;
1218   }
1219   unsigned ret = this->size;
1220   this->size = this->size + s.size() + 1;
1221   strings.push_back(s);
1222   return ret;
1223 }
1224 
1225 void StringTableSection::writeTo(uint8_t *buf) {
1226   for (StringRef s : strings) {
1227     memcpy(buf, s.data(), s.size());
1228     buf[s.size()] = '\0';
1229     buf += s.size() + 1;
1230   }
1231 }
1232 
1233 // Returns the number of entries in .gnu.version_d: the number of
1234 // non-VER_NDX_LOCAL-non-VER_NDX_GLOBAL definitions, plus 1.
1235 // Note that we don't support vd_cnt > 1 yet.
1236 static unsigned getVerDefNum() {
1237   return namedVersionDefs().size() + 1;
1238 }
1239 
1240 template <class ELFT>
1241 DynamicSection<ELFT>::DynamicSection()
1242     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_DYNAMIC, config->wordsize,
1243                        ".dynamic") {
1244   this->entsize = ELFT::Is64Bits ? 16 : 8;
1245 
1246   // .dynamic section is not writable on MIPS and on Fuchsia OS
1247   // which passes -z rodynamic.
1248   // See "Special Section" in Chapter 4 in the following document:
1249   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1250   if (config->emachine == EM_MIPS || config->zRodynamic)
1251     this->flags = SHF_ALLOC;
1252 }
1253 
1254 template <class ELFT>
1255 void DynamicSection<ELFT>::add(int32_t tag, std::function<uint64_t()> fn) {
1256   entries.push_back({tag, fn});
1257 }
1258 
1259 template <class ELFT>
1260 void DynamicSection<ELFT>::addInt(int32_t tag, uint64_t val) {
1261   entries.push_back({tag, [=] { return val; }});
1262 }
1263 
1264 template <class ELFT>
1265 void DynamicSection<ELFT>::addInSec(int32_t tag, InputSection *sec) {
1266   entries.push_back({tag, [=] { return sec->getVA(0); }});
1267 }
1268 
1269 template <class ELFT>
1270 void DynamicSection<ELFT>::addInSecRelative(int32_t tag, InputSection *sec) {
1271   size_t tagOffset = entries.size() * entsize;
1272   entries.push_back(
1273       {tag, [=] { return sec->getVA(0) - (getVA() + tagOffset); }});
1274 }
1275 
1276 template <class ELFT>
1277 void DynamicSection<ELFT>::addOutSec(int32_t tag, OutputSection *sec) {
1278   entries.push_back({tag, [=] { return sec->addr; }});
1279 }
1280 
1281 template <class ELFT>
1282 void DynamicSection<ELFT>::addSize(int32_t tag, OutputSection *sec) {
1283   entries.push_back({tag, [=] { return sec->size; }});
1284 }
1285 
1286 template <class ELFT>
1287 void DynamicSection<ELFT>::addSym(int32_t tag, Symbol *sym) {
1288   entries.push_back({tag, [=] { return sym->getVA(); }});
1289 }
1290 
1291 // The output section .rela.dyn may include these synthetic sections:
1292 //
1293 // - part.relaDyn
1294 // - in.relaIplt: this is included if in.relaIplt is named .rela.dyn
1295 // - in.relaPlt: this is included if a linker script places .rela.plt inside
1296 //   .rela.dyn
1297 //
1298 // DT_RELASZ is the total size of the included sections.
1299 static std::function<uint64_t()> addRelaSz(RelocationBaseSection *relaDyn) {
1300   return [=]() {
1301     size_t size = relaDyn->getSize();
1302     if (in.relaIplt->getParent() == relaDyn->getParent())
1303       size += in.relaIplt->getSize();
1304     if (in.relaPlt->getParent() == relaDyn->getParent())
1305       size += in.relaPlt->getSize();
1306     return size;
1307   };
1308 }
1309 
1310 // A Linker script may assign the RELA relocation sections to the same
1311 // output section. When this occurs we cannot just use the OutputSection
1312 // Size. Moreover the [DT_JMPREL, DT_JMPREL + DT_PLTRELSZ) is permitted to
1313 // overlap with the [DT_RELA, DT_RELA + DT_RELASZ).
1314 static uint64_t addPltRelSz() {
1315   size_t size = in.relaPlt->getSize();
1316   if (in.relaIplt->getParent() == in.relaPlt->getParent() &&
1317       in.relaIplt->name == in.relaPlt->name)
1318     size += in.relaIplt->getSize();
1319   return size;
1320 }
1321 
1322 // Add remaining entries to complete .dynamic contents.
1323 template <class ELFT> void DynamicSection<ELFT>::finalizeContents() {
1324   elf::Partition &part = getPartition();
1325   bool isMain = part.name.empty();
1326 
1327   for (StringRef s : config->filterList)
1328     addInt(DT_FILTER, part.dynStrTab->addString(s));
1329   for (StringRef s : config->auxiliaryList)
1330     addInt(DT_AUXILIARY, part.dynStrTab->addString(s));
1331 
1332   if (!config->rpath.empty())
1333     addInt(config->enableNewDtags ? DT_RUNPATH : DT_RPATH,
1334            part.dynStrTab->addString(config->rpath));
1335 
1336   for (SharedFile *file : sharedFiles)
1337     if (file->isNeeded)
1338       addInt(DT_NEEDED, part.dynStrTab->addString(file->soName));
1339 
1340   if (isMain) {
1341     if (!config->soName.empty())
1342       addInt(DT_SONAME, part.dynStrTab->addString(config->soName));
1343   } else {
1344     if (!config->soName.empty())
1345       addInt(DT_NEEDED, part.dynStrTab->addString(config->soName));
1346     addInt(DT_SONAME, part.dynStrTab->addString(part.name));
1347   }
1348 
1349   // Set DT_FLAGS and DT_FLAGS_1.
1350   uint32_t dtFlags = 0;
1351   uint32_t dtFlags1 = 0;
1352   if (config->bsymbolic)
1353     dtFlags |= DF_SYMBOLIC;
1354   if (config->zGlobal)
1355     dtFlags1 |= DF_1_GLOBAL;
1356   if (config->zInitfirst)
1357     dtFlags1 |= DF_1_INITFIRST;
1358   if (config->zInterpose)
1359     dtFlags1 |= DF_1_INTERPOSE;
1360   if (config->zNodefaultlib)
1361     dtFlags1 |= DF_1_NODEFLIB;
1362   if (config->zNodelete)
1363     dtFlags1 |= DF_1_NODELETE;
1364   if (config->zNodlopen)
1365     dtFlags1 |= DF_1_NOOPEN;
1366   if (config->pie)
1367     dtFlags1 |= DF_1_PIE;
1368   if (config->zNow) {
1369     dtFlags |= DF_BIND_NOW;
1370     dtFlags1 |= DF_1_NOW;
1371   }
1372   if (config->zOrigin) {
1373     dtFlags |= DF_ORIGIN;
1374     dtFlags1 |= DF_1_ORIGIN;
1375   }
1376   if (!config->zText)
1377     dtFlags |= DF_TEXTREL;
1378   if (config->hasStaticTlsModel)
1379     dtFlags |= DF_STATIC_TLS;
1380 
1381   if (dtFlags)
1382     addInt(DT_FLAGS, dtFlags);
1383   if (dtFlags1)
1384     addInt(DT_FLAGS_1, dtFlags1);
1385 
1386   // DT_DEBUG is a pointer to debug information used by debuggers at runtime. We
1387   // need it for each process, so we don't write it for DSOs. The loader writes
1388   // the pointer into this entry.
1389   //
1390   // DT_DEBUG is the only .dynamic entry that needs to be written to. Some
1391   // systems (currently only Fuchsia OS) provide other means to give the
1392   // debugger this information. Such systems may choose make .dynamic read-only.
1393   // If the target is such a system (used -z rodynamic) don't write DT_DEBUG.
1394   if (!config->shared && !config->relocatable && !config->zRodynamic)
1395     addInt(DT_DEBUG, 0);
1396 
1397   if (OutputSection *sec = part.dynStrTab->getParent())
1398     this->link = sec->sectionIndex;
1399 
1400   if (part.relaDyn->isNeeded() ||
1401       (in.relaIplt->isNeeded() &&
1402        part.relaDyn->getParent() == in.relaIplt->getParent())) {
1403     addInSec(part.relaDyn->dynamicTag, part.relaDyn);
1404     entries.push_back({part.relaDyn->sizeDynamicTag, addRelaSz(part.relaDyn)});
1405 
1406     bool isRela = config->isRela;
1407     addInt(isRela ? DT_RELAENT : DT_RELENT,
1408            isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel));
1409 
1410     // MIPS dynamic loader does not support RELCOUNT tag.
1411     // The problem is in the tight relation between dynamic
1412     // relocations and GOT. So do not emit this tag on MIPS.
1413     if (config->emachine != EM_MIPS) {
1414       size_t numRelativeRels = part.relaDyn->getRelativeRelocCount();
1415       if (config->zCombreloc && numRelativeRels)
1416         addInt(isRela ? DT_RELACOUNT : DT_RELCOUNT, numRelativeRels);
1417     }
1418   }
1419   if (part.relrDyn && !part.relrDyn->relocs.empty()) {
1420     addInSec(config->useAndroidRelrTags ? DT_ANDROID_RELR : DT_RELR,
1421              part.relrDyn);
1422     addSize(config->useAndroidRelrTags ? DT_ANDROID_RELRSZ : DT_RELRSZ,
1423             part.relrDyn->getParent());
1424     addInt(config->useAndroidRelrTags ? DT_ANDROID_RELRENT : DT_RELRENT,
1425            sizeof(Elf_Relr));
1426   }
1427   // .rel[a].plt section usually consists of two parts, containing plt and
1428   // iplt relocations. It is possible to have only iplt relocations in the
1429   // output. In that case relaPlt is empty and have zero offset, the same offset
1430   // as relaIplt has. And we still want to emit proper dynamic tags for that
1431   // case, so here we always use relaPlt as marker for the beginning of
1432   // .rel[a].plt section.
1433   if (isMain && (in.relaPlt->isNeeded() || in.relaIplt->isNeeded())) {
1434     addInSec(DT_JMPREL, in.relaPlt);
1435     entries.push_back({DT_PLTRELSZ, addPltRelSz});
1436     switch (config->emachine) {
1437     case EM_MIPS:
1438       addInSec(DT_MIPS_PLTGOT, in.gotPlt);
1439       break;
1440     case EM_SPARCV9:
1441       addInSec(DT_PLTGOT, in.plt);
1442       break;
1443     case EM_AARCH64:
1444       if (llvm::find_if(in.relaPlt->relocs, [](const DynamicReloc &r) {
1445            return r.type == target->pltRel &&
1446                   r.sym->stOther & STO_AARCH64_VARIANT_PCS;
1447           }) != in.relaPlt->relocs.end())
1448         addInt(DT_AARCH64_VARIANT_PCS, 0);
1449       LLVM_FALLTHROUGH;
1450     default:
1451       addInSec(DT_PLTGOT, in.gotPlt);
1452       break;
1453     }
1454     addInt(DT_PLTREL, config->isRela ? DT_RELA : DT_REL);
1455   }
1456 
1457   if (config->emachine == EM_AARCH64) {
1458     if (config->andFeatures & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)
1459       addInt(DT_AARCH64_BTI_PLT, 0);
1460     if (config->zPacPlt)
1461       addInt(DT_AARCH64_PAC_PLT, 0);
1462   }
1463 
1464   addInSec(DT_SYMTAB, part.dynSymTab);
1465   addInt(DT_SYMENT, sizeof(Elf_Sym));
1466   addInSec(DT_STRTAB, part.dynStrTab);
1467   addInt(DT_STRSZ, part.dynStrTab->getSize());
1468   if (!config->zText)
1469     addInt(DT_TEXTREL, 0);
1470   if (part.gnuHashTab)
1471     addInSec(DT_GNU_HASH, part.gnuHashTab);
1472   if (part.hashTab)
1473     addInSec(DT_HASH, part.hashTab);
1474 
1475   if (isMain) {
1476     if (Out::preinitArray) {
1477       addOutSec(DT_PREINIT_ARRAY, Out::preinitArray);
1478       addSize(DT_PREINIT_ARRAYSZ, Out::preinitArray);
1479     }
1480     if (Out::initArray) {
1481       addOutSec(DT_INIT_ARRAY, Out::initArray);
1482       addSize(DT_INIT_ARRAYSZ, Out::initArray);
1483     }
1484     if (Out::finiArray) {
1485       addOutSec(DT_FINI_ARRAY, Out::finiArray);
1486       addSize(DT_FINI_ARRAYSZ, Out::finiArray);
1487     }
1488 
1489     if (Symbol *b = symtab->find(config->init))
1490       if (b->isDefined())
1491         addSym(DT_INIT, b);
1492     if (Symbol *b = symtab->find(config->fini))
1493       if (b->isDefined())
1494         addSym(DT_FINI, b);
1495   }
1496 
1497   if (part.verSym && part.verSym->isNeeded())
1498     addInSec(DT_VERSYM, part.verSym);
1499   if (part.verDef && part.verDef->isLive()) {
1500     addInSec(DT_VERDEF, part.verDef);
1501     addInt(DT_VERDEFNUM, getVerDefNum());
1502   }
1503   if (part.verNeed && part.verNeed->isNeeded()) {
1504     addInSec(DT_VERNEED, part.verNeed);
1505     unsigned needNum = 0;
1506     for (SharedFile *f : sharedFiles)
1507       if (!f->vernauxs.empty())
1508         ++needNum;
1509     addInt(DT_VERNEEDNUM, needNum);
1510   }
1511 
1512   if (config->emachine == EM_MIPS) {
1513     addInt(DT_MIPS_RLD_VERSION, 1);
1514     addInt(DT_MIPS_FLAGS, RHF_NOTPOT);
1515     addInt(DT_MIPS_BASE_ADDRESS, target->getImageBase());
1516     addInt(DT_MIPS_SYMTABNO, part.dynSymTab->getNumSymbols());
1517 
1518     add(DT_MIPS_LOCAL_GOTNO, [] { return in.mipsGot->getLocalEntriesNum(); });
1519 
1520     if (const Symbol *b = in.mipsGot->getFirstGlobalEntry())
1521       addInt(DT_MIPS_GOTSYM, b->dynsymIndex);
1522     else
1523       addInt(DT_MIPS_GOTSYM, part.dynSymTab->getNumSymbols());
1524     addInSec(DT_PLTGOT, in.mipsGot);
1525     if (in.mipsRldMap) {
1526       if (!config->pie)
1527         addInSec(DT_MIPS_RLD_MAP, in.mipsRldMap);
1528       // Store the offset to the .rld_map section
1529       // relative to the address of the tag.
1530       addInSecRelative(DT_MIPS_RLD_MAP_REL, in.mipsRldMap);
1531     }
1532   }
1533 
1534   // DT_PPC_GOT indicates to glibc Secure PLT is used. If DT_PPC_GOT is absent,
1535   // glibc assumes the old-style BSS PLT layout which we don't support.
1536   if (config->emachine == EM_PPC)
1537     add(DT_PPC_GOT, [] { return in.got->getVA(); });
1538 
1539   // Glink dynamic tag is required by the V2 abi if the plt section isn't empty.
1540   if (config->emachine == EM_PPC64 && in.plt->isNeeded()) {
1541     // The Glink tag points to 32 bytes before the first lazy symbol resolution
1542     // stub, which starts directly after the header.
1543     entries.push_back({DT_PPC64_GLINK, [=] {
1544                          unsigned offset = target->pltHeaderSize - 32;
1545                          return in.plt->getVA(0) + offset;
1546                        }});
1547   }
1548 
1549   addInt(DT_NULL, 0);
1550 
1551   getParent()->link = this->link;
1552   this->size = entries.size() * this->entsize;
1553 }
1554 
1555 template <class ELFT> void DynamicSection<ELFT>::writeTo(uint8_t *buf) {
1556   auto *p = reinterpret_cast<Elf_Dyn *>(buf);
1557 
1558   for (std::pair<int32_t, std::function<uint64_t()>> &kv : entries) {
1559     p->d_tag = kv.first;
1560     p->d_un.d_val = kv.second();
1561     ++p;
1562   }
1563 }
1564 
1565 uint64_t DynamicReloc::getOffset() const {
1566   return inputSec->getVA(offsetInSec);
1567 }
1568 
1569 int64_t DynamicReloc::computeAddend() const {
1570   if (useSymVA)
1571     return sym->getVA(addend);
1572   if (!outputSec)
1573     return addend;
1574   // See the comment in the DynamicReloc ctor.
1575   return getMipsPageAddr(outputSec->addr) + addend;
1576 }
1577 
1578 uint32_t DynamicReloc::getSymIndex(SymbolTableBaseSection *symTab) const {
1579   if (sym && !useSymVA)
1580     return symTab->getSymbolIndex(sym);
1581   return 0;
1582 }
1583 
1584 RelocationBaseSection::RelocationBaseSection(StringRef name, uint32_t type,
1585                                              int32_t dynamicTag,
1586                                              int32_t sizeDynamicTag)
1587     : SyntheticSection(SHF_ALLOC, type, config->wordsize, name),
1588       dynamicTag(dynamicTag), sizeDynamicTag(sizeDynamicTag) {}
1589 
1590 void RelocationBaseSection::addReloc(RelType dynType, InputSectionBase *isec,
1591                                      uint64_t offsetInSec, Symbol *sym) {
1592   addReloc({dynType, isec, offsetInSec, false, sym, 0});
1593 }
1594 
1595 void RelocationBaseSection::addReloc(RelType dynType,
1596                                      InputSectionBase *inputSec,
1597                                      uint64_t offsetInSec, Symbol *sym,
1598                                      int64_t addend, RelExpr expr,
1599                                      RelType type) {
1600   // Write the addends to the relocated address if required. We skip
1601   // it if the written value would be zero.
1602   if (config->writeAddends && (expr != R_ADDEND || addend != 0))
1603     inputSec->relocations.push_back({expr, type, offsetInSec, addend, sym});
1604   addReloc({dynType, inputSec, offsetInSec, expr != R_ADDEND, sym, addend});
1605 }
1606 
1607 void RelocationBaseSection::addReloc(const DynamicReloc &reloc) {
1608   if (reloc.type == target->relativeRel)
1609     ++numRelativeRelocs;
1610   relocs.push_back(reloc);
1611 }
1612 
1613 void RelocationBaseSection::finalizeContents() {
1614   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
1615 
1616   // When linking glibc statically, .rel{,a}.plt contains R_*_IRELATIVE
1617   // relocations due to IFUNC (e.g. strcpy). sh_link will be set to 0 in that
1618   // case.
1619   if (symTab && symTab->getParent())
1620     getParent()->link = symTab->getParent()->sectionIndex;
1621   else
1622     getParent()->link = 0;
1623 
1624   if (in.relaPlt == this) {
1625     getParent()->flags |= ELF::SHF_INFO_LINK;
1626     getParent()->info = in.gotPlt->getParent()->sectionIndex;
1627   }
1628   if (in.relaIplt == this) {
1629     getParent()->flags |= ELF::SHF_INFO_LINK;
1630     getParent()->info = in.igotPlt->getParent()->sectionIndex;
1631   }
1632 }
1633 
1634 RelrBaseSection::RelrBaseSection()
1635     : SyntheticSection(SHF_ALLOC,
1636                        config->useAndroidRelrTags ? SHT_ANDROID_RELR : SHT_RELR,
1637                        config->wordsize, ".relr.dyn") {}
1638 
1639 template <class ELFT>
1640 static void encodeDynamicReloc(SymbolTableBaseSection *symTab,
1641                                typename ELFT::Rela *p,
1642                                const DynamicReloc &rel) {
1643   if (config->isRela)
1644     p->r_addend = rel.computeAddend();
1645   p->r_offset = rel.getOffset();
1646   p->setSymbolAndType(rel.getSymIndex(symTab), rel.type, config->isMips64EL);
1647 }
1648 
1649 template <class ELFT>
1650 RelocationSection<ELFT>::RelocationSection(StringRef name, bool sort)
1651     : RelocationBaseSection(name, config->isRela ? SHT_RELA : SHT_REL,
1652                             config->isRela ? DT_RELA : DT_REL,
1653                             config->isRela ? DT_RELASZ : DT_RELSZ),
1654       sort(sort) {
1655   this->entsize = config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1656 }
1657 
1658 template <class ELFT> void RelocationSection<ELFT>::writeTo(uint8_t *buf) {
1659   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
1660 
1661   // Sort by (!IsRelative,SymIndex,r_offset). DT_REL[A]COUNT requires us to
1662   // place R_*_RELATIVE first. SymIndex is to improve locality, while r_offset
1663   // is to make results easier to read.
1664   if (sort)
1665     llvm::stable_sort(
1666         relocs, [&](const DynamicReloc &a, const DynamicReloc &b) {
1667           return std::make_tuple(a.type != target->relativeRel,
1668                                  a.getSymIndex(symTab), a.getOffset()) <
1669                  std::make_tuple(b.type != target->relativeRel,
1670                                  b.getSymIndex(symTab), b.getOffset());
1671         });
1672 
1673   for (const DynamicReloc &rel : relocs) {
1674     encodeDynamicReloc<ELFT>(symTab, reinterpret_cast<Elf_Rela *>(buf), rel);
1675     buf += config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1676   }
1677 }
1678 
1679 template <class ELFT>
1680 AndroidPackedRelocationSection<ELFT>::AndroidPackedRelocationSection(
1681     StringRef name)
1682     : RelocationBaseSection(
1683           name, config->isRela ? SHT_ANDROID_RELA : SHT_ANDROID_REL,
1684           config->isRela ? DT_ANDROID_RELA : DT_ANDROID_REL,
1685           config->isRela ? DT_ANDROID_RELASZ : DT_ANDROID_RELSZ) {
1686   this->entsize = 1;
1687 }
1688 
1689 template <class ELFT>
1690 bool AndroidPackedRelocationSection<ELFT>::updateAllocSize() {
1691   // This function computes the contents of an Android-format packed relocation
1692   // section.
1693   //
1694   // This format compresses relocations by using relocation groups to factor out
1695   // fields that are common between relocations and storing deltas from previous
1696   // relocations in SLEB128 format (which has a short representation for small
1697   // numbers). A good example of a relocation type with common fields is
1698   // R_*_RELATIVE, which is normally used to represent function pointers in
1699   // vtables. In the REL format, each relative relocation has the same r_info
1700   // field, and is only different from other relative relocations in terms of
1701   // the r_offset field. By sorting relocations by offset, grouping them by
1702   // r_info and representing each relocation with only the delta from the
1703   // previous offset, each 8-byte relocation can be compressed to as little as 1
1704   // byte (or less with run-length encoding). This relocation packer was able to
1705   // reduce the size of the relocation section in an Android Chromium DSO from
1706   // 2,911,184 bytes to 174,693 bytes, or 6% of the original size.
1707   //
1708   // A relocation section consists of a header containing the literal bytes
1709   // 'APS2' followed by a sequence of SLEB128-encoded integers. The first two
1710   // elements are the total number of relocations in the section and an initial
1711   // r_offset value. The remaining elements define a sequence of relocation
1712   // groups. Each relocation group starts with a header consisting of the
1713   // following elements:
1714   //
1715   // - the number of relocations in the relocation group
1716   // - flags for the relocation group
1717   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is set) the r_offset delta
1718   //   for each relocation in the group.
1719   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is set) the value of the r_info
1720   //   field for each relocation in the group.
1721   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG and
1722   //   RELOCATION_GROUPED_BY_ADDEND_FLAG are set) the r_addend delta for
1723   //   each relocation in the group.
1724   //
1725   // Following the relocation group header are descriptions of each of the
1726   // relocations in the group. They consist of the following elements:
1727   //
1728   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is not set) the r_offset
1729   //   delta for this relocation.
1730   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is not set) the value of the r_info
1731   //   field for this relocation.
1732   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG is set and
1733   //   RELOCATION_GROUPED_BY_ADDEND_FLAG is not set) the r_addend delta for
1734   //   this relocation.
1735 
1736   size_t oldSize = relocData.size();
1737 
1738   relocData = {'A', 'P', 'S', '2'};
1739   raw_svector_ostream os(relocData);
1740   auto add = [&](int64_t v) { encodeSLEB128(v, os); };
1741 
1742   // The format header includes the number of relocations and the initial
1743   // offset (we set this to zero because the first relocation group will
1744   // perform the initial adjustment).
1745   add(relocs.size());
1746   add(0);
1747 
1748   std::vector<Elf_Rela> relatives, nonRelatives;
1749 
1750   for (const DynamicReloc &rel : relocs) {
1751     Elf_Rela r;
1752     encodeDynamicReloc<ELFT>(getPartition().dynSymTab, &r, rel);
1753 
1754     if (r.getType(config->isMips64EL) == target->relativeRel)
1755       relatives.push_back(r);
1756     else
1757       nonRelatives.push_back(r);
1758   }
1759 
1760   llvm::sort(relatives, [](const Elf_Rel &a, const Elf_Rel &b) {
1761     return a.r_offset < b.r_offset;
1762   });
1763 
1764   // Try to find groups of relative relocations which are spaced one word
1765   // apart from one another. These generally correspond to vtable entries. The
1766   // format allows these groups to be encoded using a sort of run-length
1767   // encoding, but each group will cost 7 bytes in addition to the offset from
1768   // the previous group, so it is only profitable to do this for groups of
1769   // size 8 or larger.
1770   std::vector<Elf_Rela> ungroupedRelatives;
1771   std::vector<std::vector<Elf_Rela>> relativeGroups;
1772   for (auto i = relatives.begin(), e = relatives.end(); i != e;) {
1773     std::vector<Elf_Rela> group;
1774     do {
1775       group.push_back(*i++);
1776     } while (i != e && (i - 1)->r_offset + config->wordsize == i->r_offset);
1777 
1778     if (group.size() < 8)
1779       ungroupedRelatives.insert(ungroupedRelatives.end(), group.begin(),
1780                                 group.end());
1781     else
1782       relativeGroups.emplace_back(std::move(group));
1783   }
1784 
1785   // For non-relative relocations, we would like to:
1786   //   1. Have relocations with the same symbol offset to be consecutive, so
1787   //      that the runtime linker can speed-up symbol lookup by implementing an
1788   //      1-entry cache.
1789   //   2. Group relocations by r_info to reduce the size of the relocation
1790   //      section.
1791   // Since the symbol offset is the high bits in r_info, sorting by r_info
1792   // allows us to do both.
1793   //
1794   // For Rela, we also want to sort by r_addend when r_info is the same. This
1795   // enables us to group by r_addend as well.
1796   llvm::stable_sort(nonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
1797     if (a.r_info != b.r_info)
1798       return a.r_info < b.r_info;
1799     if (config->isRela)
1800       return a.r_addend < b.r_addend;
1801     return false;
1802   });
1803 
1804   // Group relocations with the same r_info. Note that each group emits a group
1805   // header and that may make the relocation section larger. It is hard to
1806   // estimate the size of a group header as the encoded size of that varies
1807   // based on r_info. However, we can approximate this trade-off by the number
1808   // of values encoded. Each group header contains 3 values, and each relocation
1809   // in a group encodes one less value, as compared to when it is not grouped.
1810   // Therefore, we only group relocations if there are 3 or more of them with
1811   // the same r_info.
1812   //
1813   // For Rela, the addend for most non-relative relocations is zero, and thus we
1814   // can usually get a smaller relocation section if we group relocations with 0
1815   // addend as well.
1816   std::vector<Elf_Rela> ungroupedNonRelatives;
1817   std::vector<std::vector<Elf_Rela>> nonRelativeGroups;
1818   for (auto i = nonRelatives.begin(), e = nonRelatives.end(); i != e;) {
1819     auto j = i + 1;
1820     while (j != e && i->r_info == j->r_info &&
1821            (!config->isRela || i->r_addend == j->r_addend))
1822       ++j;
1823     if (j - i < 3 || (config->isRela && i->r_addend != 0))
1824       ungroupedNonRelatives.insert(ungroupedNonRelatives.end(), i, j);
1825     else
1826       nonRelativeGroups.emplace_back(i, j);
1827     i = j;
1828   }
1829 
1830   // Sort ungrouped relocations by offset to minimize the encoded length.
1831   llvm::sort(ungroupedNonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
1832     return a.r_offset < b.r_offset;
1833   });
1834 
1835   unsigned hasAddendIfRela =
1836       config->isRela ? RELOCATION_GROUP_HAS_ADDEND_FLAG : 0;
1837 
1838   uint64_t offset = 0;
1839   uint64_t addend = 0;
1840 
1841   // Emit the run-length encoding for the groups of adjacent relative
1842   // relocations. Each group is represented using two groups in the packed
1843   // format. The first is used to set the current offset to the start of the
1844   // group (and also encodes the first relocation), and the second encodes the
1845   // remaining relocations.
1846   for (std::vector<Elf_Rela> &g : relativeGroups) {
1847     // The first relocation in the group.
1848     add(1);
1849     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1850         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1851     add(g[0].r_offset - offset);
1852     add(target->relativeRel);
1853     if (config->isRela) {
1854       add(g[0].r_addend - addend);
1855       addend = g[0].r_addend;
1856     }
1857 
1858     // The remaining relocations.
1859     add(g.size() - 1);
1860     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1861         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1862     add(config->wordsize);
1863     add(target->relativeRel);
1864     if (config->isRela) {
1865       for (auto i = g.begin() + 1, e = g.end(); i != e; ++i) {
1866         add(i->r_addend - addend);
1867         addend = i->r_addend;
1868       }
1869     }
1870 
1871     offset = g.back().r_offset;
1872   }
1873 
1874   // Now the ungrouped relatives.
1875   if (!ungroupedRelatives.empty()) {
1876     add(ungroupedRelatives.size());
1877     add(RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1878     add(target->relativeRel);
1879     for (Elf_Rela &r : ungroupedRelatives) {
1880       add(r.r_offset - offset);
1881       offset = r.r_offset;
1882       if (config->isRela) {
1883         add(r.r_addend - addend);
1884         addend = r.r_addend;
1885       }
1886     }
1887   }
1888 
1889   // Grouped non-relatives.
1890   for (ArrayRef<Elf_Rela> g : nonRelativeGroups) {
1891     add(g.size());
1892     add(RELOCATION_GROUPED_BY_INFO_FLAG);
1893     add(g[0].r_info);
1894     for (const Elf_Rela &r : g) {
1895       add(r.r_offset - offset);
1896       offset = r.r_offset;
1897     }
1898     addend = 0;
1899   }
1900 
1901   // Finally the ungrouped non-relative relocations.
1902   if (!ungroupedNonRelatives.empty()) {
1903     add(ungroupedNonRelatives.size());
1904     add(hasAddendIfRela);
1905     for (Elf_Rela &r : ungroupedNonRelatives) {
1906       add(r.r_offset - offset);
1907       offset = r.r_offset;
1908       add(r.r_info);
1909       if (config->isRela) {
1910         add(r.r_addend - addend);
1911         addend = r.r_addend;
1912       }
1913     }
1914   }
1915 
1916   // Don't allow the section to shrink; otherwise the size of the section can
1917   // oscillate infinitely.
1918   if (relocData.size() < oldSize)
1919     relocData.append(oldSize - relocData.size(), 0);
1920 
1921   // Returns whether the section size changed. We need to keep recomputing both
1922   // section layout and the contents of this section until the size converges
1923   // because changing this section's size can affect section layout, which in
1924   // turn can affect the sizes of the LEB-encoded integers stored in this
1925   // section.
1926   return relocData.size() != oldSize;
1927 }
1928 
1929 template <class ELFT> RelrSection<ELFT>::RelrSection() {
1930   this->entsize = config->wordsize;
1931 }
1932 
1933 template <class ELFT> bool RelrSection<ELFT>::updateAllocSize() {
1934   // This function computes the contents of an SHT_RELR packed relocation
1935   // section.
1936   //
1937   // Proposal for adding SHT_RELR sections to generic-abi is here:
1938   //   https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
1939   //
1940   // The encoded sequence of Elf64_Relr entries in a SHT_RELR section looks
1941   // like [ AAAAAAAA BBBBBBB1 BBBBBBB1 ... AAAAAAAA BBBBBB1 ... ]
1942   //
1943   // i.e. start with an address, followed by any number of bitmaps. The address
1944   // entry encodes 1 relocation. The subsequent bitmap entries encode up to 63
1945   // relocations each, at subsequent offsets following the last address entry.
1946   //
1947   // The bitmap entries must have 1 in the least significant bit. The assumption
1948   // here is that an address cannot have 1 in lsb. Odd addresses are not
1949   // supported.
1950   //
1951   // Excluding the least significant bit in the bitmap, each non-zero bit in
1952   // the bitmap represents a relocation to be applied to a corresponding machine
1953   // word that follows the base address word. The second least significant bit
1954   // represents the machine word immediately following the initial address, and
1955   // each bit that follows represents the next word, in linear order. As such,
1956   // a single bitmap can encode up to 31 relocations in a 32-bit object, and
1957   // 63 relocations in a 64-bit object.
1958   //
1959   // This encoding has a couple of interesting properties:
1960   // 1. Looking at any entry, it is clear whether it's an address or a bitmap:
1961   //    even means address, odd means bitmap.
1962   // 2. Just a simple list of addresses is a valid encoding.
1963 
1964   size_t oldSize = relrRelocs.size();
1965   relrRelocs.clear();
1966 
1967   // Same as Config->Wordsize but faster because this is a compile-time
1968   // constant.
1969   const size_t wordsize = sizeof(typename ELFT::uint);
1970 
1971   // Number of bits to use for the relocation offsets bitmap.
1972   // Must be either 63 or 31.
1973   const size_t nBits = wordsize * 8 - 1;
1974 
1975   // Get offsets for all relative relocations and sort them.
1976   std::vector<uint64_t> offsets;
1977   for (const RelativeReloc &rel : relocs)
1978     offsets.push_back(rel.getOffset());
1979   llvm::sort(offsets);
1980 
1981   // For each leading relocation, find following ones that can be folded
1982   // as a bitmap and fold them.
1983   for (size_t i = 0, e = offsets.size(); i < e;) {
1984     // Add a leading relocation.
1985     relrRelocs.push_back(Elf_Relr(offsets[i]));
1986     uint64_t base = offsets[i] + wordsize;
1987     ++i;
1988 
1989     // Find foldable relocations to construct bitmaps.
1990     while (i < e) {
1991       uint64_t bitmap = 0;
1992 
1993       while (i < e) {
1994         uint64_t delta = offsets[i] - base;
1995 
1996         // If it is too far, it cannot be folded.
1997         if (delta >= nBits * wordsize)
1998           break;
1999 
2000         // If it is not a multiple of wordsize away, it cannot be folded.
2001         if (delta % wordsize)
2002           break;
2003 
2004         // Fold it.
2005         bitmap |= 1ULL << (delta / wordsize);
2006         ++i;
2007       }
2008 
2009       if (!bitmap)
2010         break;
2011 
2012       relrRelocs.push_back(Elf_Relr((bitmap << 1) | 1));
2013       base += nBits * wordsize;
2014     }
2015   }
2016 
2017   // Don't allow the section to shrink; otherwise the size of the section can
2018   // oscillate infinitely. Trailing 1s do not decode to more relocations.
2019   if (relrRelocs.size() < oldSize) {
2020     log(".relr.dyn needs " + Twine(oldSize - relrRelocs.size()) +
2021         " padding word(s)");
2022     relrRelocs.resize(oldSize, Elf_Relr(1));
2023   }
2024 
2025   return relrRelocs.size() != oldSize;
2026 }
2027 
2028 SymbolTableBaseSection::SymbolTableBaseSection(StringTableSection &strTabSec)
2029     : SyntheticSection(strTabSec.isDynamic() ? (uint64_t)SHF_ALLOC : 0,
2030                        strTabSec.isDynamic() ? SHT_DYNSYM : SHT_SYMTAB,
2031                        config->wordsize,
2032                        strTabSec.isDynamic() ? ".dynsym" : ".symtab"),
2033       strTabSec(strTabSec) {}
2034 
2035 // Orders symbols according to their positions in the GOT,
2036 // in compliance with MIPS ABI rules.
2037 // See "Global Offset Table" in Chapter 5 in the following document
2038 // for detailed description:
2039 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
2040 static bool sortMipsSymbols(const SymbolTableEntry &l,
2041                             const SymbolTableEntry &r) {
2042   // Sort entries related to non-local preemptible symbols by GOT indexes.
2043   // All other entries go to the beginning of a dynsym in arbitrary order.
2044   if (l.sym->isInGot() && r.sym->isInGot())
2045     return l.sym->gotIndex < r.sym->gotIndex;
2046   if (!l.sym->isInGot() && !r.sym->isInGot())
2047     return false;
2048   return !l.sym->isInGot();
2049 }
2050 
2051 void SymbolTableBaseSection::finalizeContents() {
2052   if (OutputSection *sec = strTabSec.getParent())
2053     getParent()->link = sec->sectionIndex;
2054 
2055   if (this->type != SHT_DYNSYM) {
2056     sortSymTabSymbols();
2057     return;
2058   }
2059 
2060   // If it is a .dynsym, there should be no local symbols, but we need
2061   // to do a few things for the dynamic linker.
2062 
2063   // Section's Info field has the index of the first non-local symbol.
2064   // Because the first symbol entry is a null entry, 1 is the first.
2065   getParent()->info = 1;
2066 
2067   if (getPartition().gnuHashTab) {
2068     // NB: It also sorts Symbols to meet the GNU hash table requirements.
2069     getPartition().gnuHashTab->addSymbols(symbols);
2070   } else if (config->emachine == EM_MIPS) {
2071     llvm::stable_sort(symbols, sortMipsSymbols);
2072   }
2073 
2074   // Only the main partition's dynsym indexes are stored in the symbols
2075   // themselves. All other partitions use a lookup table.
2076   if (this == mainPart->dynSymTab) {
2077     size_t i = 0;
2078     for (const SymbolTableEntry &s : symbols)
2079       s.sym->dynsymIndex = ++i;
2080   }
2081 }
2082 
2083 // The ELF spec requires that all local symbols precede global symbols, so we
2084 // sort symbol entries in this function. (For .dynsym, we don't do that because
2085 // symbols for dynamic linking are inherently all globals.)
2086 //
2087 // Aside from above, we put local symbols in groups starting with the STT_FILE
2088 // symbol. That is convenient for purpose of identifying where are local symbols
2089 // coming from.
2090 void SymbolTableBaseSection::sortSymTabSymbols() {
2091   // Move all local symbols before global symbols.
2092   auto e = std::stable_partition(
2093       symbols.begin(), symbols.end(), [](const SymbolTableEntry &s) {
2094         return s.sym->isLocal() || s.sym->computeBinding() == STB_LOCAL;
2095       });
2096   size_t numLocals = e - symbols.begin();
2097   getParent()->info = numLocals + 1;
2098 
2099   // We want to group the local symbols by file. For that we rebuild the local
2100   // part of the symbols vector. We do not need to care about the STT_FILE
2101   // symbols, they are already naturally placed first in each group. That
2102   // happens because STT_FILE is always the first symbol in the object and hence
2103   // precede all other local symbols we add for a file.
2104   MapVector<InputFile *, std::vector<SymbolTableEntry>> arr;
2105   for (const SymbolTableEntry &s : llvm::make_range(symbols.begin(), e))
2106     arr[s.sym->file].push_back(s);
2107 
2108   auto i = symbols.begin();
2109   for (std::pair<InputFile *, std::vector<SymbolTableEntry>> &p : arr)
2110     for (SymbolTableEntry &entry : p.second)
2111       *i++ = entry;
2112 }
2113 
2114 void SymbolTableBaseSection::addSymbol(Symbol *b) {
2115   // Adding a local symbol to a .dynsym is a bug.
2116   assert(this->type != SHT_DYNSYM || !b->isLocal());
2117 
2118   bool hashIt = b->isLocal();
2119   symbols.push_back({b, strTabSec.addString(b->getName(), hashIt)});
2120 }
2121 
2122 size_t SymbolTableBaseSection::getSymbolIndex(Symbol *sym) {
2123   if (this == mainPart->dynSymTab)
2124     return sym->dynsymIndex;
2125 
2126   // Initializes symbol lookup tables lazily. This is used only for -r,
2127   // -emit-relocs and dynsyms in partitions other than the main one.
2128   llvm::call_once(onceFlag, [&] {
2129     symbolIndexMap.reserve(symbols.size());
2130     size_t i = 0;
2131     for (const SymbolTableEntry &e : symbols) {
2132       if (e.sym->type == STT_SECTION)
2133         sectionIndexMap[e.sym->getOutputSection()] = ++i;
2134       else
2135         symbolIndexMap[e.sym] = ++i;
2136     }
2137   });
2138 
2139   // Section symbols are mapped based on their output sections
2140   // to maintain their semantics.
2141   if (sym->type == STT_SECTION)
2142     return sectionIndexMap.lookup(sym->getOutputSection());
2143   return symbolIndexMap.lookup(sym);
2144 }
2145 
2146 template <class ELFT>
2147 SymbolTableSection<ELFT>::SymbolTableSection(StringTableSection &strTabSec)
2148     : SymbolTableBaseSection(strTabSec) {
2149   this->entsize = sizeof(Elf_Sym);
2150 }
2151 
2152 static BssSection *getCommonSec(Symbol *sym) {
2153   if (!config->defineCommon)
2154     if (auto *d = dyn_cast<Defined>(sym))
2155       return dyn_cast_or_null<BssSection>(d->section);
2156   return nullptr;
2157 }
2158 
2159 static uint32_t getSymSectionIndex(Symbol *sym) {
2160   if (getCommonSec(sym))
2161     return SHN_COMMON;
2162   if (!isa<Defined>(sym) || sym->needsPltAddr)
2163     return SHN_UNDEF;
2164   if (const OutputSection *os = sym->getOutputSection())
2165     return os->sectionIndex >= SHN_LORESERVE ? (uint32_t)SHN_XINDEX
2166                                              : os->sectionIndex;
2167   return SHN_ABS;
2168 }
2169 
2170 // Write the internal symbol table contents to the output symbol table.
2171 template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *buf) {
2172   // The first entry is a null entry as per the ELF spec.
2173   memset(buf, 0, sizeof(Elf_Sym));
2174   buf += sizeof(Elf_Sym);
2175 
2176   auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
2177 
2178   for (SymbolTableEntry &ent : symbols) {
2179     Symbol *sym = ent.sym;
2180     bool isDefinedHere = type == SHT_SYMTAB || sym->partition == partition;
2181 
2182     // Set st_info and st_other.
2183     eSym->st_other = 0;
2184     if (sym->isLocal()) {
2185       eSym->setBindingAndType(STB_LOCAL, sym->type);
2186     } else {
2187       eSym->setBindingAndType(sym->computeBinding(), sym->type);
2188       eSym->setVisibility(sym->visibility);
2189     }
2190 
2191     // The 3 most significant bits of st_other are used by OpenPOWER ABI.
2192     // See getPPC64GlobalEntryToLocalEntryOffset() for more details.
2193     if (config->emachine == EM_PPC64)
2194       eSym->st_other |= sym->stOther & 0xe0;
2195     // The most significant bit of st_other is used by AArch64 ABI for the
2196     // variant PCS.
2197     else if (config->emachine == EM_AARCH64)
2198       eSym->st_other |= sym->stOther & STO_AARCH64_VARIANT_PCS;
2199 
2200     eSym->st_name = ent.strTabOffset;
2201     if (isDefinedHere)
2202       eSym->st_shndx = getSymSectionIndex(ent.sym);
2203     else
2204       eSym->st_shndx = 0;
2205 
2206     // Copy symbol size if it is a defined symbol. st_size is not significant
2207     // for undefined symbols, so whether copying it or not is up to us if that's
2208     // the case. We'll leave it as zero because by not setting a value, we can
2209     // get the exact same outputs for two sets of input files that differ only
2210     // in undefined symbol size in DSOs.
2211     if (eSym->st_shndx == SHN_UNDEF || !isDefinedHere)
2212       eSym->st_size = 0;
2213     else
2214       eSym->st_size = sym->getSize();
2215 
2216     // st_value is usually an address of a symbol, but that has a special
2217     // meaning for uninstantiated common symbols (--no-define-common).
2218     if (BssSection *commonSec = getCommonSec(ent.sym))
2219       eSym->st_value = commonSec->alignment;
2220     else if (isDefinedHere)
2221       eSym->st_value = sym->getVA();
2222     else
2223       eSym->st_value = 0;
2224 
2225     ++eSym;
2226   }
2227 
2228   // On MIPS we need to mark symbol which has a PLT entry and requires
2229   // pointer equality by STO_MIPS_PLT flag. That is necessary to help
2230   // dynamic linker distinguish such symbols and MIPS lazy-binding stubs.
2231   // https://sourceware.org/ml/binutils/2008-07/txt00000.txt
2232   if (config->emachine == EM_MIPS) {
2233     auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
2234 
2235     for (SymbolTableEntry &ent : symbols) {
2236       Symbol *sym = ent.sym;
2237       if (sym->isInPlt() && sym->needsPltAddr)
2238         eSym->st_other |= STO_MIPS_PLT;
2239       if (isMicroMips()) {
2240         // We already set the less-significant bit for symbols
2241         // marked by the `STO_MIPS_MICROMIPS` flag and for microMIPS PLT
2242         // records. That allows us to distinguish such symbols in
2243         // the `MIPS<ELFT>::relocate()` routine. Now we should
2244         // clear that bit for non-dynamic symbol table, so tools
2245         // like `objdump` will be able to deal with a correct
2246         // symbol position.
2247         if (sym->isDefined() &&
2248             ((sym->stOther & STO_MIPS_MICROMIPS) || sym->needsPltAddr)) {
2249           if (!strTabSec.isDynamic())
2250             eSym->st_value &= ~1;
2251           eSym->st_other |= STO_MIPS_MICROMIPS;
2252         }
2253       }
2254       if (config->relocatable)
2255         if (auto *d = dyn_cast<Defined>(sym))
2256           if (isMipsPIC<ELFT>(d))
2257             eSym->st_other |= STO_MIPS_PIC;
2258       ++eSym;
2259     }
2260   }
2261 }
2262 
2263 SymtabShndxSection::SymtabShndxSection()
2264     : SyntheticSection(0, SHT_SYMTAB_SHNDX, 4, ".symtab_shndx") {
2265   this->entsize = 4;
2266 }
2267 
2268 void SymtabShndxSection::writeTo(uint8_t *buf) {
2269   // We write an array of 32 bit values, where each value has 1:1 association
2270   // with an entry in .symtab. If the corresponding entry contains SHN_XINDEX,
2271   // we need to write actual index, otherwise, we must write SHN_UNDEF(0).
2272   buf += 4; // Ignore .symtab[0] entry.
2273   for (const SymbolTableEntry &entry : in.symTab->getSymbols()) {
2274     if (getSymSectionIndex(entry.sym) == SHN_XINDEX)
2275       write32(buf, entry.sym->getOutputSection()->sectionIndex);
2276     buf += 4;
2277   }
2278 }
2279 
2280 bool SymtabShndxSection::isNeeded() const {
2281   // SHT_SYMTAB can hold symbols with section indices values up to
2282   // SHN_LORESERVE. If we need more, we want to use extension SHT_SYMTAB_SHNDX
2283   // section. Problem is that we reveal the final section indices a bit too
2284   // late, and we do not know them here. For simplicity, we just always create
2285   // a .symtab_shndx section when the amount of output sections is huge.
2286   size_t size = 0;
2287   for (BaseCommand *base : script->sectionCommands)
2288     if (isa<OutputSection>(base))
2289       ++size;
2290   return size >= SHN_LORESERVE;
2291 }
2292 
2293 void SymtabShndxSection::finalizeContents() {
2294   getParent()->link = in.symTab->getParent()->sectionIndex;
2295 }
2296 
2297 size_t SymtabShndxSection::getSize() const {
2298   return in.symTab->getNumSymbols() * 4;
2299 }
2300 
2301 // .hash and .gnu.hash sections contain on-disk hash tables that map
2302 // symbol names to their dynamic symbol table indices. Their purpose
2303 // is to help the dynamic linker resolve symbols quickly. If ELF files
2304 // don't have them, the dynamic linker has to do linear search on all
2305 // dynamic symbols, which makes programs slower. Therefore, a .hash
2306 // section is added to a DSO by default. A .gnu.hash is added if you
2307 // give the -hash-style=gnu or -hash-style=both option.
2308 //
2309 // The Unix semantics of resolving dynamic symbols is somewhat expensive.
2310 // Each ELF file has a list of DSOs that the ELF file depends on and a
2311 // list of dynamic symbols that need to be resolved from any of the
2312 // DSOs. That means resolving all dynamic symbols takes O(m)*O(n)
2313 // where m is the number of DSOs and n is the number of dynamic
2314 // symbols. For modern large programs, both m and n are large.  So
2315 // making each step faster by using hash tables substantially
2316 // improves time to load programs.
2317 //
2318 // (Note that this is not the only way to design the shared library.
2319 // For instance, the Windows DLL takes a different approach. On
2320 // Windows, each dynamic symbol has a name of DLL from which the symbol
2321 // has to be resolved. That makes the cost of symbol resolution O(n).
2322 // This disables some hacky techniques you can use on Unix such as
2323 // LD_PRELOAD, but this is arguably better semantics than the Unix ones.)
2324 //
2325 // Due to historical reasons, we have two different hash tables, .hash
2326 // and .gnu.hash. They are for the same purpose, and .gnu.hash is a new
2327 // and better version of .hash. .hash is just an on-disk hash table, but
2328 // .gnu.hash has a bloom filter in addition to a hash table to skip
2329 // DSOs very quickly. If you are sure that your dynamic linker knows
2330 // about .gnu.hash, you want to specify -hash-style=gnu. Otherwise, a
2331 // safe bet is to specify -hash-style=both for backward compatibility.
2332 GnuHashTableSection::GnuHashTableSection()
2333     : SyntheticSection(SHF_ALLOC, SHT_GNU_HASH, config->wordsize, ".gnu.hash") {
2334 }
2335 
2336 void GnuHashTableSection::finalizeContents() {
2337   if (OutputSection *sec = getPartition().dynSymTab->getParent())
2338     getParent()->link = sec->sectionIndex;
2339 
2340   // Computes bloom filter size in word size. We want to allocate 12
2341   // bits for each symbol. It must be a power of two.
2342   if (symbols.empty()) {
2343     maskWords = 1;
2344   } else {
2345     uint64_t numBits = symbols.size() * 12;
2346     maskWords = NextPowerOf2(numBits / (config->wordsize * 8));
2347   }
2348 
2349   size = 16;                            // Header
2350   size += config->wordsize * maskWords; // Bloom filter
2351   size += nBuckets * 4;                 // Hash buckets
2352   size += symbols.size() * 4;           // Hash values
2353 }
2354 
2355 void GnuHashTableSection::writeTo(uint8_t *buf) {
2356   // The output buffer is not guaranteed to be zero-cleared because we pre-
2357   // fill executable sections with trap instructions. This is a precaution
2358   // for that case, which happens only when -no-rosegment is given.
2359   memset(buf, 0, size);
2360 
2361   // Write a header.
2362   write32(buf, nBuckets);
2363   write32(buf + 4, getPartition().dynSymTab->getNumSymbols() - symbols.size());
2364   write32(buf + 8, maskWords);
2365   write32(buf + 12, Shift2);
2366   buf += 16;
2367 
2368   // Write a bloom filter and a hash table.
2369   writeBloomFilter(buf);
2370   buf += config->wordsize * maskWords;
2371   writeHashTable(buf);
2372 }
2373 
2374 // This function writes a 2-bit bloom filter. This bloom filter alone
2375 // usually filters out 80% or more of all symbol lookups [1].
2376 // The dynamic linker uses the hash table only when a symbol is not
2377 // filtered out by a bloom filter.
2378 //
2379 // [1] Ulrich Drepper (2011), "How To Write Shared Libraries" (Ver. 4.1.2),
2380 //     p.9, https://www.akkadia.org/drepper/dsohowto.pdf
2381 void GnuHashTableSection::writeBloomFilter(uint8_t *buf) {
2382   unsigned c = config->is64 ? 64 : 32;
2383   for (const Entry &sym : symbols) {
2384     // When C = 64, we choose a word with bits [6:...] and set 1 to two bits in
2385     // the word using bits [0:5] and [26:31].
2386     size_t i = (sym.hash / c) & (maskWords - 1);
2387     uint64_t val = readUint(buf + i * config->wordsize);
2388     val |= uint64_t(1) << (sym.hash % c);
2389     val |= uint64_t(1) << ((sym.hash >> Shift2) % c);
2390     writeUint(buf + i * config->wordsize, val);
2391   }
2392 }
2393 
2394 void GnuHashTableSection::writeHashTable(uint8_t *buf) {
2395   uint32_t *buckets = reinterpret_cast<uint32_t *>(buf);
2396   uint32_t oldBucket = -1;
2397   uint32_t *values = buckets + nBuckets;
2398   for (auto i = symbols.begin(), e = symbols.end(); i != e; ++i) {
2399     // Write a hash value. It represents a sequence of chains that share the
2400     // same hash modulo value. The last element of each chain is terminated by
2401     // LSB 1.
2402     uint32_t hash = i->hash;
2403     bool isLastInChain = (i + 1) == e || i->bucketIdx != (i + 1)->bucketIdx;
2404     hash = isLastInChain ? hash | 1 : hash & ~1;
2405     write32(values++, hash);
2406 
2407     if (i->bucketIdx == oldBucket)
2408       continue;
2409     // Write a hash bucket. Hash buckets contain indices in the following hash
2410     // value table.
2411     write32(buckets + i->bucketIdx,
2412             getPartition().dynSymTab->getSymbolIndex(i->sym));
2413     oldBucket = i->bucketIdx;
2414   }
2415 }
2416 
2417 static uint32_t hashGnu(StringRef name) {
2418   uint32_t h = 5381;
2419   for (uint8_t c : name)
2420     h = (h << 5) + h + c;
2421   return h;
2422 }
2423 
2424 // Add symbols to this symbol hash table. Note that this function
2425 // destructively sort a given vector -- which is needed because
2426 // GNU-style hash table places some sorting requirements.
2427 void GnuHashTableSection::addSymbols(std::vector<SymbolTableEntry> &v) {
2428   // We cannot use 'auto' for Mid because GCC 6.1 cannot deduce
2429   // its type correctly.
2430   std::vector<SymbolTableEntry>::iterator mid =
2431       std::stable_partition(v.begin(), v.end(), [&](const SymbolTableEntry &s) {
2432         return !s.sym->isDefined() || s.sym->partition != partition;
2433       });
2434 
2435   // We chose load factor 4 for the on-disk hash table. For each hash
2436   // collision, the dynamic linker will compare a uint32_t hash value.
2437   // Since the integer comparison is quite fast, we believe we can
2438   // make the load factor even larger. 4 is just a conservative choice.
2439   //
2440   // Note that we don't want to create a zero-sized hash table because
2441   // Android loader as of 2018 doesn't like a .gnu.hash containing such
2442   // table. If that's the case, we create a hash table with one unused
2443   // dummy slot.
2444   nBuckets = std::max<size_t>((v.end() - mid) / 4, 1);
2445 
2446   if (mid == v.end())
2447     return;
2448 
2449   for (SymbolTableEntry &ent : llvm::make_range(mid, v.end())) {
2450     Symbol *b = ent.sym;
2451     uint32_t hash = hashGnu(b->getName());
2452     uint32_t bucketIdx = hash % nBuckets;
2453     symbols.push_back({b, ent.strTabOffset, hash, bucketIdx});
2454   }
2455 
2456   llvm::stable_sort(symbols, [](const Entry &l, const Entry &r) {
2457     return l.bucketIdx < r.bucketIdx;
2458   });
2459 
2460   v.erase(mid, v.end());
2461   for (const Entry &ent : symbols)
2462     v.push_back({ent.sym, ent.strTabOffset});
2463 }
2464 
2465 HashTableSection::HashTableSection()
2466     : SyntheticSection(SHF_ALLOC, SHT_HASH, 4, ".hash") {
2467   this->entsize = 4;
2468 }
2469 
2470 void HashTableSection::finalizeContents() {
2471   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
2472 
2473   if (OutputSection *sec = symTab->getParent())
2474     getParent()->link = sec->sectionIndex;
2475 
2476   unsigned numEntries = 2;               // nbucket and nchain.
2477   numEntries += symTab->getNumSymbols(); // The chain entries.
2478 
2479   // Create as many buckets as there are symbols.
2480   numEntries += symTab->getNumSymbols();
2481   this->size = numEntries * 4;
2482 }
2483 
2484 void HashTableSection::writeTo(uint8_t *buf) {
2485   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
2486 
2487   // See comment in GnuHashTableSection::writeTo.
2488   memset(buf, 0, size);
2489 
2490   unsigned numSymbols = symTab->getNumSymbols();
2491 
2492   uint32_t *p = reinterpret_cast<uint32_t *>(buf);
2493   write32(p++, numSymbols); // nbucket
2494   write32(p++, numSymbols); // nchain
2495 
2496   uint32_t *buckets = p;
2497   uint32_t *chains = p + numSymbols;
2498 
2499   for (const SymbolTableEntry &s : symTab->getSymbols()) {
2500     Symbol *sym = s.sym;
2501     StringRef name = sym->getName();
2502     unsigned i = sym->dynsymIndex;
2503     uint32_t hash = hashSysV(name) % numSymbols;
2504     chains[i] = buckets[hash];
2505     write32(buckets + hash, i);
2506   }
2507 }
2508 
2509 PltSection::PltSection()
2510     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt"),
2511       headerSize(target->pltHeaderSize) {
2512   // On PowerPC, this section contains lazy symbol resolvers.
2513   if (config->emachine == EM_PPC64) {
2514     name = ".glink";
2515     alignment = 4;
2516   }
2517 
2518   // On x86 when IBT is enabled, this section contains the second PLT (lazy
2519   // symbol resolvers).
2520   if ((config->emachine == EM_386 || config->emachine == EM_X86_64) &&
2521       (config->andFeatures & GNU_PROPERTY_X86_FEATURE_1_IBT))
2522     name = ".plt.sec";
2523 
2524   // The PLT needs to be writable on SPARC as the dynamic linker will
2525   // modify the instructions in the PLT entries.
2526   if (config->emachine == EM_SPARCV9)
2527     this->flags |= SHF_WRITE;
2528 }
2529 
2530 void PltSection::writeTo(uint8_t *buf) {
2531   // At beginning of PLT, we have code to call the dynamic
2532   // linker to resolve dynsyms at runtime. Write such code.
2533   target->writePltHeader(buf);
2534   size_t off = headerSize;
2535 
2536   for (const Symbol *sym : entries) {
2537     target->writePlt(buf + off, *sym, getVA() + off);
2538     off += target->pltEntrySize;
2539   }
2540 }
2541 
2542 void PltSection::addEntry(Symbol &sym) {
2543   sym.pltIndex = entries.size();
2544   entries.push_back(&sym);
2545 }
2546 
2547 size_t PltSection::getSize() const {
2548   return headerSize + entries.size() * target->pltEntrySize;
2549 }
2550 
2551 bool PltSection::isNeeded() const {
2552   // For -z retpolineplt, .iplt needs the .plt header.
2553   return !entries.empty() || (config->zRetpolineplt && in.iplt->isNeeded());
2554 }
2555 
2556 // Used by ARM to add mapping symbols in the PLT section, which aid
2557 // disassembly.
2558 void PltSection::addSymbols() {
2559   target->addPltHeaderSymbols(*this);
2560 
2561   size_t off = headerSize;
2562   for (size_t i = 0; i < entries.size(); ++i) {
2563     target->addPltSymbols(*this, off);
2564     off += target->pltEntrySize;
2565   }
2566 }
2567 
2568 IpltSection::IpltSection()
2569     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".iplt") {
2570   if (config->emachine == EM_PPC || config->emachine == EM_PPC64) {
2571     name = ".glink";
2572     alignment = 4;
2573   }
2574 }
2575 
2576 void IpltSection::writeTo(uint8_t *buf) {
2577   uint32_t off = 0;
2578   for (const Symbol *sym : entries) {
2579     target->writeIplt(buf + off, *sym, getVA() + off);
2580     off += target->ipltEntrySize;
2581   }
2582 }
2583 
2584 size_t IpltSection::getSize() const {
2585   return entries.size() * target->ipltEntrySize;
2586 }
2587 
2588 void IpltSection::addEntry(Symbol &sym) {
2589   sym.pltIndex = entries.size();
2590   entries.push_back(&sym);
2591 }
2592 
2593 // ARM uses mapping symbols to aid disassembly.
2594 void IpltSection::addSymbols() {
2595   size_t off = 0;
2596   for (size_t i = 0, e = entries.size(); i != e; ++i) {
2597     target->addPltSymbols(*this, off);
2598     off += target->pltEntrySize;
2599   }
2600 }
2601 
2602 PPC32GlinkSection::PPC32GlinkSection() {
2603   name = ".glink";
2604   alignment = 4;
2605 }
2606 
2607 void PPC32GlinkSection::writeTo(uint8_t *buf) {
2608   writePPC32GlinkSection(buf, entries.size());
2609 }
2610 
2611 size_t PPC32GlinkSection::getSize() const {
2612   return headerSize + entries.size() * target->pltEntrySize + footerSize;
2613 }
2614 
2615 // This is an x86-only extra PLT section and used only when a security
2616 // enhancement feature called CET is enabled. In this comment, I'll explain what
2617 // the feature is and why we have two PLT sections if CET is enabled.
2618 //
2619 // So, what does CET do? CET introduces a new restriction to indirect jump
2620 // instructions. CET works this way. Assume that CET is enabled. Then, if you
2621 // execute an indirect jump instruction, the processor verifies that a special
2622 // "landing pad" instruction (which is actually a repurposed NOP instruction and
2623 // now called "endbr32" or "endbr64") is at the jump target. If the jump target
2624 // does not start with that instruction, the processor raises an exception
2625 // instead of continuing executing code.
2626 //
2627 // If CET is enabled, the compiler emits endbr to all locations where indirect
2628 // jumps may jump to.
2629 //
2630 // This mechanism makes it extremely hard to transfer the control to a middle of
2631 // a function that is not supporsed to be a indirect jump target, preventing
2632 // certain types of attacks such as ROP or JOP.
2633 //
2634 // Note that the processors in the market as of 2019 don't actually support the
2635 // feature. Only the spec is available at the moment.
2636 //
2637 // Now, I'll explain why we have this extra PLT section for CET.
2638 //
2639 // Since you can indirectly jump to a PLT entry, we have to make PLT entries
2640 // start with endbr. The problem is there's no extra space for endbr (which is 4
2641 // bytes long), as the PLT entry is only 16 bytes long and all bytes are already
2642 // used.
2643 //
2644 // In order to deal with the issue, we split a PLT entry into two PLT entries.
2645 // Remember that each PLT entry contains code to jump to an address read from
2646 // .got.plt AND code to resolve a dynamic symbol lazily. With the 2-PLT scheme,
2647 // the former code is written to .plt.sec, and the latter code is written to
2648 // .plt.
2649 //
2650 // Lazy symbol resolution in the 2-PLT scheme works in the usual way, except
2651 // that the regular .plt is now called .plt.sec and .plt is repurposed to
2652 // contain only code for lazy symbol resolution.
2653 //
2654 // In other words, this is how the 2-PLT scheme works. Application code is
2655 // supposed to jump to .plt.sec to call an external function. Each .plt.sec
2656 // entry contains code to read an address from a corresponding .got.plt entry
2657 // and jump to that address. Addresses in .got.plt initially point to .plt, so
2658 // when an application calls an external function for the first time, the
2659 // control is transferred to a function that resolves a symbol name from
2660 // external shared object files. That function then rewrites a .got.plt entry
2661 // with a resolved address, so that the subsequent function calls directly jump
2662 // to a desired location from .plt.sec.
2663 //
2664 // There is an open question as to whether the 2-PLT scheme was desirable or
2665 // not. We could have simply extended the PLT entry size to 32-bytes to
2666 // accommodate endbr, and that scheme would have been much simpler than the
2667 // 2-PLT scheme. One reason to split PLT was, by doing that, we could keep hot
2668 // code (.plt.sec) from cold code (.plt). But as far as I know no one proved
2669 // that the optimization actually makes a difference.
2670 //
2671 // That said, the 2-PLT scheme is a part of the ABI, debuggers and other tools
2672 // depend on it, so we implement the ABI.
2673 IBTPltSection::IBTPltSection()
2674     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt") {}
2675 
2676 void IBTPltSection::writeTo(uint8_t *buf) {
2677   target->writeIBTPlt(buf, in.plt->getNumEntries());
2678 }
2679 
2680 size_t IBTPltSection::getSize() const {
2681   // 16 is the header size of .plt.
2682   return 16 + in.plt->getNumEntries() * target->pltEntrySize;
2683 }
2684 
2685 // The string hash function for .gdb_index.
2686 static uint32_t computeGdbHash(StringRef s) {
2687   uint32_t h = 0;
2688   for (uint8_t c : s)
2689     h = h * 67 + toLower(c) - 113;
2690   return h;
2691 }
2692 
2693 GdbIndexSection::GdbIndexSection()
2694     : SyntheticSection(0, SHT_PROGBITS, 1, ".gdb_index") {}
2695 
2696 // Returns the desired size of an on-disk hash table for a .gdb_index section.
2697 // There's a tradeoff between size and collision rate. We aim 75% utilization.
2698 size_t GdbIndexSection::computeSymtabSize() const {
2699   return std::max<size_t>(NextPowerOf2(symbols.size() * 4 / 3), 1024);
2700 }
2701 
2702 // Compute the output section size.
2703 void GdbIndexSection::initOutputSize() {
2704   size = sizeof(GdbIndexHeader) + computeSymtabSize() * 8;
2705 
2706   for (GdbChunk &chunk : chunks)
2707     size += chunk.compilationUnits.size() * 16 + chunk.addressAreas.size() * 20;
2708 
2709   // Add the constant pool size if exists.
2710   if (!symbols.empty()) {
2711     GdbSymbol &sym = symbols.back();
2712     size += sym.nameOff + sym.name.size() + 1;
2713   }
2714 }
2715 
2716 static std::vector<GdbIndexSection::CuEntry> readCuList(DWARFContext &dwarf) {
2717   std::vector<GdbIndexSection::CuEntry> ret;
2718   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units())
2719     ret.push_back({cu->getOffset(), cu->getLength() + 4});
2720   return ret;
2721 }
2722 
2723 static std::vector<GdbIndexSection::AddressEntry>
2724 readAddressAreas(DWARFContext &dwarf, InputSection *sec) {
2725   std::vector<GdbIndexSection::AddressEntry> ret;
2726 
2727   uint32_t cuIdx = 0;
2728   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units()) {
2729     if (Error e = cu->tryExtractDIEsIfNeeded(false)) {
2730       warn(toString(sec) + ": " + toString(std::move(e)));
2731       return {};
2732     }
2733     Expected<DWARFAddressRangesVector> ranges = cu->collectAddressRanges();
2734     if (!ranges) {
2735       warn(toString(sec) + ": " + toString(ranges.takeError()));
2736       return {};
2737     }
2738 
2739     ArrayRef<InputSectionBase *> sections = sec->file->getSections();
2740     for (DWARFAddressRange &r : *ranges) {
2741       if (r.SectionIndex == -1ULL)
2742         continue;
2743       // Range list with zero size has no effect.
2744       InputSectionBase *s = sections[r.SectionIndex];
2745       if (s && s != &InputSection::discarded && s->isLive())
2746         if (r.LowPC != r.HighPC)
2747           ret.push_back({cast<InputSection>(s), r.LowPC, r.HighPC, cuIdx});
2748     }
2749     ++cuIdx;
2750   }
2751 
2752   return ret;
2753 }
2754 
2755 template <class ELFT>
2756 static std::vector<GdbIndexSection::NameAttrEntry>
2757 readPubNamesAndTypes(const LLDDwarfObj<ELFT> &obj,
2758                      const std::vector<GdbIndexSection::CuEntry> &cus) {
2759   const LLDDWARFSection &pubNames = obj.getGnuPubnamesSection();
2760   const LLDDWARFSection &pubTypes = obj.getGnuPubtypesSection();
2761 
2762   std::vector<GdbIndexSection::NameAttrEntry> ret;
2763   for (const LLDDWARFSection *pub : {&pubNames, &pubTypes}) {
2764     DWARFDataExtractor data(obj, *pub, config->isLE, config->wordsize);
2765     DWARFDebugPubTable table;
2766     table.extract(data, /*GnuStyle=*/true, [&](Error e) {
2767       warn(toString(pub->sec) + ": " + toString(std::move(e)));
2768     });
2769     for (const DWARFDebugPubTable::Set &set : table.getData()) {
2770       // The value written into the constant pool is kind << 24 | cuIndex. As we
2771       // don't know how many compilation units precede this object to compute
2772       // cuIndex, we compute (kind << 24 | cuIndexInThisObject) instead, and add
2773       // the number of preceding compilation units later.
2774       uint32_t i = llvm::partition_point(cus,
2775                                          [&](GdbIndexSection::CuEntry cu) {
2776                                            return cu.cuOffset < set.Offset;
2777                                          }) -
2778                    cus.begin();
2779       for (const DWARFDebugPubTable::Entry &ent : set.Entries)
2780         ret.push_back({{ent.Name, computeGdbHash(ent.Name)},
2781                        (ent.Descriptor.toBits() << 24) | i});
2782     }
2783   }
2784   return ret;
2785 }
2786 
2787 // Create a list of symbols from a given list of symbol names and types
2788 // by uniquifying them by name.
2789 static std::vector<GdbIndexSection::GdbSymbol>
2790 createSymbols(ArrayRef<std::vector<GdbIndexSection::NameAttrEntry>> nameAttrs,
2791               const std::vector<GdbIndexSection::GdbChunk> &chunks) {
2792   using GdbSymbol = GdbIndexSection::GdbSymbol;
2793   using NameAttrEntry = GdbIndexSection::NameAttrEntry;
2794 
2795   // For each chunk, compute the number of compilation units preceding it.
2796   uint32_t cuIdx = 0;
2797   std::vector<uint32_t> cuIdxs(chunks.size());
2798   for (uint32_t i = 0, e = chunks.size(); i != e; ++i) {
2799     cuIdxs[i] = cuIdx;
2800     cuIdx += chunks[i].compilationUnits.size();
2801   }
2802 
2803   // The number of symbols we will handle in this function is of the order
2804   // of millions for very large executables, so we use multi-threading to
2805   // speed it up.
2806   constexpr size_t numShards = 32;
2807   size_t concurrency = PowerOf2Floor(
2808       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
2809                            .compute_thread_count(),
2810                        numShards));
2811 
2812   // A sharded map to uniquify symbols by name.
2813   std::vector<DenseMap<CachedHashStringRef, size_t>> map(numShards);
2814   size_t shift = 32 - countTrailingZeros(numShards);
2815 
2816   // Instantiate GdbSymbols while uniqufying them by name.
2817   std::vector<std::vector<GdbSymbol>> symbols(numShards);
2818   parallelForEachN(0, concurrency, [&](size_t threadId) {
2819     uint32_t i = 0;
2820     for (ArrayRef<NameAttrEntry> entries : nameAttrs) {
2821       for (const NameAttrEntry &ent : entries) {
2822         size_t shardId = ent.name.hash() >> shift;
2823         if ((shardId & (concurrency - 1)) != threadId)
2824           continue;
2825 
2826         uint32_t v = ent.cuIndexAndAttrs + cuIdxs[i];
2827         size_t &idx = map[shardId][ent.name];
2828         if (idx) {
2829           symbols[shardId][idx - 1].cuVector.push_back(v);
2830           continue;
2831         }
2832 
2833         idx = symbols[shardId].size() + 1;
2834         symbols[shardId].push_back({ent.name, {v}, 0, 0});
2835       }
2836       ++i;
2837     }
2838   });
2839 
2840   size_t numSymbols = 0;
2841   for (ArrayRef<GdbSymbol> v : symbols)
2842     numSymbols += v.size();
2843 
2844   // The return type is a flattened vector, so we'll copy each vector
2845   // contents to Ret.
2846   std::vector<GdbSymbol> ret;
2847   ret.reserve(numSymbols);
2848   for (std::vector<GdbSymbol> &vec : symbols)
2849     for (GdbSymbol &sym : vec)
2850       ret.push_back(std::move(sym));
2851 
2852   // CU vectors and symbol names are adjacent in the output file.
2853   // We can compute their offsets in the output file now.
2854   size_t off = 0;
2855   for (GdbSymbol &sym : ret) {
2856     sym.cuVectorOff = off;
2857     off += (sym.cuVector.size() + 1) * 4;
2858   }
2859   for (GdbSymbol &sym : ret) {
2860     sym.nameOff = off;
2861     off += sym.name.size() + 1;
2862   }
2863 
2864   return ret;
2865 }
2866 
2867 // Returns a newly-created .gdb_index section.
2868 template <class ELFT> GdbIndexSection *GdbIndexSection::create() {
2869   // Collect InputFiles with .debug_info. See the comment in
2870   // LLDDwarfObj<ELFT>::LLDDwarfObj. If we do lightweight parsing in the future,
2871   // note that isec->data() may uncompress the full content, which should be
2872   // parallelized.
2873   SetVector<InputFile *> files;
2874   for (InputSectionBase *s : inputSections) {
2875     InputSection *isec = dyn_cast<InputSection>(s);
2876     if (!isec)
2877       continue;
2878     // .debug_gnu_pub{names,types} are useless in executables.
2879     // They are present in input object files solely for creating
2880     // a .gdb_index. So we can remove them from the output.
2881     if (s->name == ".debug_gnu_pubnames" || s->name == ".debug_gnu_pubtypes")
2882       s->markDead();
2883     else if (isec->name == ".debug_info")
2884       files.insert(isec->file);
2885   }
2886   // Drop .rel[a].debug_gnu_pub{names,types} for --emit-relocs.
2887   llvm::erase_if(inputSections, [](InputSectionBase *s) {
2888     if (auto *isec = dyn_cast<InputSection>(s))
2889       if (InputSectionBase *rel = isec->getRelocatedSection())
2890         return !rel->isLive();
2891     return !s->isLive();
2892   });
2893 
2894   std::vector<GdbChunk> chunks(files.size());
2895   std::vector<std::vector<NameAttrEntry>> nameAttrs(files.size());
2896 
2897   parallelForEachN(0, files.size(), [&](size_t i) {
2898     // To keep memory usage low, we don't want to keep cached DWARFContext, so
2899     // avoid getDwarf() here.
2900     ObjFile<ELFT> *file = cast<ObjFile<ELFT>>(files[i]);
2901     DWARFContext dwarf(std::make_unique<LLDDwarfObj<ELFT>>(file));
2902     auto &dobj = static_cast<const LLDDwarfObj<ELFT> &>(dwarf.getDWARFObj());
2903 
2904     // If the are multiple compile units .debug_info (very rare ld -r --unique),
2905     // this only picks the last one. Other address ranges are lost.
2906     chunks[i].sec = dobj.getInfoSection();
2907     chunks[i].compilationUnits = readCuList(dwarf);
2908     chunks[i].addressAreas = readAddressAreas(dwarf, chunks[i].sec);
2909     nameAttrs[i] = readPubNamesAndTypes<ELFT>(dobj, chunks[i].compilationUnits);
2910   });
2911 
2912   auto *ret = make<GdbIndexSection>();
2913   ret->chunks = std::move(chunks);
2914   ret->symbols = createSymbols(nameAttrs, ret->chunks);
2915   ret->initOutputSize();
2916   return ret;
2917 }
2918 
2919 void GdbIndexSection::writeTo(uint8_t *buf) {
2920   // Write the header.
2921   auto *hdr = reinterpret_cast<GdbIndexHeader *>(buf);
2922   uint8_t *start = buf;
2923   hdr->version = 7;
2924   buf += sizeof(*hdr);
2925 
2926   // Write the CU list.
2927   hdr->cuListOff = buf - start;
2928   for (GdbChunk &chunk : chunks) {
2929     for (CuEntry &cu : chunk.compilationUnits) {
2930       write64le(buf, chunk.sec->outSecOff + cu.cuOffset);
2931       write64le(buf + 8, cu.cuLength);
2932       buf += 16;
2933     }
2934   }
2935 
2936   // Write the address area.
2937   hdr->cuTypesOff = buf - start;
2938   hdr->addressAreaOff = buf - start;
2939   uint32_t cuOff = 0;
2940   for (GdbChunk &chunk : chunks) {
2941     for (AddressEntry &e : chunk.addressAreas) {
2942       // In the case of ICF there may be duplicate address range entries.
2943       const uint64_t baseAddr = e.section->repl->getVA(0);
2944       write64le(buf, baseAddr + e.lowAddress);
2945       write64le(buf + 8, baseAddr + e.highAddress);
2946       write32le(buf + 16, e.cuIndex + cuOff);
2947       buf += 20;
2948     }
2949     cuOff += chunk.compilationUnits.size();
2950   }
2951 
2952   // Write the on-disk open-addressing hash table containing symbols.
2953   hdr->symtabOff = buf - start;
2954   size_t symtabSize = computeSymtabSize();
2955   uint32_t mask = symtabSize - 1;
2956 
2957   for (GdbSymbol &sym : symbols) {
2958     uint32_t h = sym.name.hash();
2959     uint32_t i = h & mask;
2960     uint32_t step = ((h * 17) & mask) | 1;
2961 
2962     while (read32le(buf + i * 8))
2963       i = (i + step) & mask;
2964 
2965     write32le(buf + i * 8, sym.nameOff);
2966     write32le(buf + i * 8 + 4, sym.cuVectorOff);
2967   }
2968 
2969   buf += symtabSize * 8;
2970 
2971   // Write the string pool.
2972   hdr->constantPoolOff = buf - start;
2973   parallelForEach(symbols, [&](GdbSymbol &sym) {
2974     memcpy(buf + sym.nameOff, sym.name.data(), sym.name.size());
2975   });
2976 
2977   // Write the CU vectors.
2978   for (GdbSymbol &sym : symbols) {
2979     write32le(buf, sym.cuVector.size());
2980     buf += 4;
2981     for (uint32_t val : sym.cuVector) {
2982       write32le(buf, val);
2983       buf += 4;
2984     }
2985   }
2986 }
2987 
2988 bool GdbIndexSection::isNeeded() const { return !chunks.empty(); }
2989 
2990 EhFrameHeader::EhFrameHeader()
2991     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".eh_frame_hdr") {}
2992 
2993 void EhFrameHeader::writeTo(uint8_t *buf) {
2994   // Unlike most sections, the EhFrameHeader section is written while writing
2995   // another section, namely EhFrameSection, which calls the write() function
2996   // below from its writeTo() function. This is necessary because the contents
2997   // of EhFrameHeader depend on the relocated contents of EhFrameSection and we
2998   // don't know which order the sections will be written in.
2999 }
3000 
3001 // .eh_frame_hdr contains a binary search table of pointers to FDEs.
3002 // Each entry of the search table consists of two values,
3003 // the starting PC from where FDEs covers, and the FDE's address.
3004 // It is sorted by PC.
3005 void EhFrameHeader::write() {
3006   uint8_t *buf = Out::bufferStart + getParent()->offset + outSecOff;
3007   using FdeData = EhFrameSection::FdeData;
3008 
3009   std::vector<FdeData> fdes = getPartition().ehFrame->getFdeData();
3010 
3011   buf[0] = 1;
3012   buf[1] = DW_EH_PE_pcrel | DW_EH_PE_sdata4;
3013   buf[2] = DW_EH_PE_udata4;
3014   buf[3] = DW_EH_PE_datarel | DW_EH_PE_sdata4;
3015   write32(buf + 4,
3016           getPartition().ehFrame->getParent()->addr - this->getVA() - 4);
3017   write32(buf + 8, fdes.size());
3018   buf += 12;
3019 
3020   for (FdeData &fde : fdes) {
3021     write32(buf, fde.pcRel);
3022     write32(buf + 4, fde.fdeVARel);
3023     buf += 8;
3024   }
3025 }
3026 
3027 size_t EhFrameHeader::getSize() const {
3028   // .eh_frame_hdr has a 12 bytes header followed by an array of FDEs.
3029   return 12 + getPartition().ehFrame->numFdes * 8;
3030 }
3031 
3032 bool EhFrameHeader::isNeeded() const {
3033   return isLive() && getPartition().ehFrame->isNeeded();
3034 }
3035 
3036 VersionDefinitionSection::VersionDefinitionSection()
3037     : SyntheticSection(SHF_ALLOC, SHT_GNU_verdef, sizeof(uint32_t),
3038                        ".gnu.version_d") {}
3039 
3040 StringRef VersionDefinitionSection::getFileDefName() {
3041   if (!getPartition().name.empty())
3042     return getPartition().name;
3043   if (!config->soName.empty())
3044     return config->soName;
3045   return config->outputFile;
3046 }
3047 
3048 void VersionDefinitionSection::finalizeContents() {
3049   fileDefNameOff = getPartition().dynStrTab->addString(getFileDefName());
3050   for (const VersionDefinition &v : namedVersionDefs())
3051     verDefNameOffs.push_back(getPartition().dynStrTab->addString(v.name));
3052 
3053   if (OutputSection *sec = getPartition().dynStrTab->getParent())
3054     getParent()->link = sec->sectionIndex;
3055 
3056   // sh_info should be set to the number of definitions. This fact is missed in
3057   // documentation, but confirmed by binutils community:
3058   // https://sourceware.org/ml/binutils/2014-11/msg00355.html
3059   getParent()->info = getVerDefNum();
3060 }
3061 
3062 void VersionDefinitionSection::writeOne(uint8_t *buf, uint32_t index,
3063                                         StringRef name, size_t nameOff) {
3064   uint16_t flags = index == 1 ? VER_FLG_BASE : 0;
3065 
3066   // Write a verdef.
3067   write16(buf, 1);                  // vd_version
3068   write16(buf + 2, flags);          // vd_flags
3069   write16(buf + 4, index);          // vd_ndx
3070   write16(buf + 6, 1);              // vd_cnt
3071   write32(buf + 8, hashSysV(name)); // vd_hash
3072   write32(buf + 12, 20);            // vd_aux
3073   write32(buf + 16, 28);            // vd_next
3074 
3075   // Write a veraux.
3076   write32(buf + 20, nameOff); // vda_name
3077   write32(buf + 24, 0);       // vda_next
3078 }
3079 
3080 void VersionDefinitionSection::writeTo(uint8_t *buf) {
3081   writeOne(buf, 1, getFileDefName(), fileDefNameOff);
3082 
3083   auto nameOffIt = verDefNameOffs.begin();
3084   for (const VersionDefinition &v : namedVersionDefs()) {
3085     buf += EntrySize;
3086     writeOne(buf, v.id, v.name, *nameOffIt++);
3087   }
3088 
3089   // Need to terminate the last version definition.
3090   write32(buf + 16, 0); // vd_next
3091 }
3092 
3093 size_t VersionDefinitionSection::getSize() const {
3094   return EntrySize * getVerDefNum();
3095 }
3096 
3097 // .gnu.version is a table where each entry is 2 byte long.
3098 VersionTableSection::VersionTableSection()
3099     : SyntheticSection(SHF_ALLOC, SHT_GNU_versym, sizeof(uint16_t),
3100                        ".gnu.version") {
3101   this->entsize = 2;
3102 }
3103 
3104 void VersionTableSection::finalizeContents() {
3105   // At the moment of june 2016 GNU docs does not mention that sh_link field
3106   // should be set, but Sun docs do. Also readelf relies on this field.
3107   getParent()->link = getPartition().dynSymTab->getParent()->sectionIndex;
3108 }
3109 
3110 size_t VersionTableSection::getSize() const {
3111   return (getPartition().dynSymTab->getSymbols().size() + 1) * 2;
3112 }
3113 
3114 void VersionTableSection::writeTo(uint8_t *buf) {
3115   buf += 2;
3116   for (const SymbolTableEntry &s : getPartition().dynSymTab->getSymbols()) {
3117     // Use the original versionId for an unfetched lazy symbol (undefined weak),
3118     // which must be VER_NDX_GLOBAL (an undefined versioned symbol is an error).
3119     write16(buf, s.sym->isLazy() ? static_cast<uint16_t>(VER_NDX_GLOBAL)
3120                                  : s.sym->versionId);
3121     buf += 2;
3122   }
3123 }
3124 
3125 bool VersionTableSection::isNeeded() const {
3126   return isLive() &&
3127          (getPartition().verDef || getPartition().verNeed->isNeeded());
3128 }
3129 
3130 void elf::addVerneed(Symbol *ss) {
3131   auto &file = cast<SharedFile>(*ss->file);
3132   if (ss->verdefIndex == VER_NDX_GLOBAL) {
3133     ss->versionId = VER_NDX_GLOBAL;
3134     return;
3135   }
3136 
3137   if (file.vernauxs.empty())
3138     file.vernauxs.resize(file.verdefs.size());
3139 
3140   // Select a version identifier for the vernaux data structure, if we haven't
3141   // already allocated one. The verdef identifiers cover the range
3142   // [1..getVerDefNum()]; this causes the vernaux identifiers to start from
3143   // getVerDefNum()+1.
3144   if (file.vernauxs[ss->verdefIndex] == 0)
3145     file.vernauxs[ss->verdefIndex] = ++SharedFile::vernauxNum + getVerDefNum();
3146 
3147   ss->versionId = file.vernauxs[ss->verdefIndex];
3148 }
3149 
3150 template <class ELFT>
3151 VersionNeedSection<ELFT>::VersionNeedSection()
3152     : SyntheticSection(SHF_ALLOC, SHT_GNU_verneed, sizeof(uint32_t),
3153                        ".gnu.version_r") {}
3154 
3155 template <class ELFT> void VersionNeedSection<ELFT>::finalizeContents() {
3156   for (SharedFile *f : sharedFiles) {
3157     if (f->vernauxs.empty())
3158       continue;
3159     verneeds.emplace_back();
3160     Verneed &vn = verneeds.back();
3161     vn.nameStrTab = getPartition().dynStrTab->addString(f->soName);
3162     for (unsigned i = 0; i != f->vernauxs.size(); ++i) {
3163       if (f->vernauxs[i] == 0)
3164         continue;
3165       auto *verdef =
3166           reinterpret_cast<const typename ELFT::Verdef *>(f->verdefs[i]);
3167       vn.vernauxs.push_back(
3168           {verdef->vd_hash, f->vernauxs[i],
3169            getPartition().dynStrTab->addString(f->getStringTable().data() +
3170                                                verdef->getAux()->vda_name)});
3171     }
3172   }
3173 
3174   if (OutputSection *sec = getPartition().dynStrTab->getParent())
3175     getParent()->link = sec->sectionIndex;
3176   getParent()->info = verneeds.size();
3177 }
3178 
3179 template <class ELFT> void VersionNeedSection<ELFT>::writeTo(uint8_t *buf) {
3180   // The Elf_Verneeds need to appear first, followed by the Elf_Vernauxs.
3181   auto *verneed = reinterpret_cast<Elf_Verneed *>(buf);
3182   auto *vernaux = reinterpret_cast<Elf_Vernaux *>(verneed + verneeds.size());
3183 
3184   for (auto &vn : verneeds) {
3185     // Create an Elf_Verneed for this DSO.
3186     verneed->vn_version = 1;
3187     verneed->vn_cnt = vn.vernauxs.size();
3188     verneed->vn_file = vn.nameStrTab;
3189     verneed->vn_aux =
3190         reinterpret_cast<char *>(vernaux) - reinterpret_cast<char *>(verneed);
3191     verneed->vn_next = sizeof(Elf_Verneed);
3192     ++verneed;
3193 
3194     // Create the Elf_Vernauxs for this Elf_Verneed.
3195     for (auto &vna : vn.vernauxs) {
3196       vernaux->vna_hash = vna.hash;
3197       vernaux->vna_flags = 0;
3198       vernaux->vna_other = vna.verneedIndex;
3199       vernaux->vna_name = vna.nameStrTab;
3200       vernaux->vna_next = sizeof(Elf_Vernaux);
3201       ++vernaux;
3202     }
3203 
3204     vernaux[-1].vna_next = 0;
3205   }
3206   verneed[-1].vn_next = 0;
3207 }
3208 
3209 template <class ELFT> size_t VersionNeedSection<ELFT>::getSize() const {
3210   return verneeds.size() * sizeof(Elf_Verneed) +
3211          SharedFile::vernauxNum * sizeof(Elf_Vernaux);
3212 }
3213 
3214 template <class ELFT> bool VersionNeedSection<ELFT>::isNeeded() const {
3215   return isLive() && SharedFile::vernauxNum != 0;
3216 }
3217 
3218 void MergeSyntheticSection::addSection(MergeInputSection *ms) {
3219   ms->parent = this;
3220   sections.push_back(ms);
3221   assert(alignment == ms->alignment || !(ms->flags & SHF_STRINGS));
3222   alignment = std::max(alignment, ms->alignment);
3223 }
3224 
3225 MergeTailSection::MergeTailSection(StringRef name, uint32_t type,
3226                                    uint64_t flags, uint32_t alignment)
3227     : MergeSyntheticSection(name, type, flags, alignment),
3228       builder(StringTableBuilder::RAW, alignment) {}
3229 
3230 size_t MergeTailSection::getSize() const { return builder.getSize(); }
3231 
3232 void MergeTailSection::writeTo(uint8_t *buf) { builder.write(buf); }
3233 
3234 void MergeTailSection::finalizeContents() {
3235   // Add all string pieces to the string table builder to create section
3236   // contents.
3237   for (MergeInputSection *sec : sections)
3238     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3239       if (sec->pieces[i].live)
3240         builder.add(sec->getData(i));
3241 
3242   // Fix the string table content. After this, the contents will never change.
3243   builder.finalize();
3244 
3245   // finalize() fixed tail-optimized strings, so we can now get
3246   // offsets of strings. Get an offset for each string and save it
3247   // to a corresponding SectionPiece for easy access.
3248   for (MergeInputSection *sec : sections)
3249     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3250       if (sec->pieces[i].live)
3251         sec->pieces[i].outputOff = builder.getOffset(sec->getData(i));
3252 }
3253 
3254 void MergeNoTailSection::writeTo(uint8_t *buf) {
3255   for (size_t i = 0; i < numShards; ++i)
3256     shards[i].write(buf + shardOffsets[i]);
3257 }
3258 
3259 // This function is very hot (i.e. it can take several seconds to finish)
3260 // because sometimes the number of inputs is in an order of magnitude of
3261 // millions. So, we use multi-threading.
3262 //
3263 // For any strings S and T, we know S is not mergeable with T if S's hash
3264 // value is different from T's. If that's the case, we can safely put S and
3265 // T into different string builders without worrying about merge misses.
3266 // We do it in parallel.
3267 void MergeNoTailSection::finalizeContents() {
3268   // Initializes string table builders.
3269   for (size_t i = 0; i < numShards; ++i)
3270     shards.emplace_back(StringTableBuilder::RAW, alignment);
3271 
3272   // Concurrency level. Must be a power of 2 to avoid expensive modulo
3273   // operations in the following tight loop.
3274   size_t concurrency = PowerOf2Floor(
3275       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
3276                            .compute_thread_count(),
3277                        numShards));
3278 
3279   // Add section pieces to the builders.
3280   parallelForEachN(0, concurrency, [&](size_t threadId) {
3281     for (MergeInputSection *sec : sections) {
3282       for (size_t i = 0, e = sec->pieces.size(); i != e; ++i) {
3283         if (!sec->pieces[i].live)
3284           continue;
3285         size_t shardId = getShardId(sec->pieces[i].hash);
3286         if ((shardId & (concurrency - 1)) == threadId)
3287           sec->pieces[i].outputOff = shards[shardId].add(sec->getData(i));
3288       }
3289     }
3290   });
3291 
3292   // Compute an in-section offset for each shard.
3293   size_t off = 0;
3294   for (size_t i = 0; i < numShards; ++i) {
3295     shards[i].finalizeInOrder();
3296     if (shards[i].getSize() > 0)
3297       off = alignTo(off, alignment);
3298     shardOffsets[i] = off;
3299     off += shards[i].getSize();
3300   }
3301   size = off;
3302 
3303   // So far, section pieces have offsets from beginning of shards, but
3304   // we want offsets from beginning of the whole section. Fix them.
3305   parallelForEach(sections, [&](MergeInputSection *sec) {
3306     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3307       if (sec->pieces[i].live)
3308         sec->pieces[i].outputOff +=
3309             shardOffsets[getShardId(sec->pieces[i].hash)];
3310   });
3311 }
3312 
3313 MergeSyntheticSection *elf::createMergeSynthetic(StringRef name, uint32_t type,
3314                                                  uint64_t flags,
3315                                                  uint32_t alignment) {
3316   bool shouldTailMerge = (flags & SHF_STRINGS) && config->optimize >= 2;
3317   if (shouldTailMerge)
3318     return make<MergeTailSection>(name, type, flags, alignment);
3319   return make<MergeNoTailSection>(name, type, flags, alignment);
3320 }
3321 
3322 template <class ELFT> void elf::splitSections() {
3323   llvm::TimeTraceScope timeScope("Split sections");
3324   // splitIntoPieces needs to be called on each MergeInputSection
3325   // before calling finalizeContents().
3326   parallelForEach(inputSections, [](InputSectionBase *sec) {
3327     if (auto *s = dyn_cast<MergeInputSection>(sec))
3328       s->splitIntoPieces();
3329     else if (auto *eh = dyn_cast<EhInputSection>(sec))
3330       eh->split<ELFT>();
3331   });
3332 }
3333 
3334 MipsRldMapSection::MipsRldMapSection()
3335     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
3336                        ".rld_map") {}
3337 
3338 ARMExidxSyntheticSection::ARMExidxSyntheticSection()
3339     : SyntheticSection(SHF_ALLOC | SHF_LINK_ORDER, SHT_ARM_EXIDX,
3340                        config->wordsize, ".ARM.exidx") {}
3341 
3342 static InputSection *findExidxSection(InputSection *isec) {
3343   for (InputSection *d : isec->dependentSections)
3344     if (d->type == SHT_ARM_EXIDX && d->isLive())
3345       return d;
3346   return nullptr;
3347 }
3348 
3349 static bool isValidExidxSectionDep(InputSection *isec) {
3350   return (isec->flags & SHF_ALLOC) && (isec->flags & SHF_EXECINSTR) &&
3351          isec->getSize() > 0;
3352 }
3353 
3354 bool ARMExidxSyntheticSection::addSection(InputSection *isec) {
3355   if (isec->type == SHT_ARM_EXIDX) {
3356     if (InputSection *dep = isec->getLinkOrderDep())
3357       if (isValidExidxSectionDep(dep)) {
3358         exidxSections.push_back(isec);
3359         // Every exidxSection is 8 bytes, we need an estimate of
3360         // size before assignAddresses can be called. Final size
3361         // will only be known after finalize is called.
3362         size += 8;
3363       }
3364     return true;
3365   }
3366 
3367   if (isValidExidxSectionDep(isec)) {
3368     executableSections.push_back(isec);
3369     return false;
3370   }
3371 
3372   // FIXME: we do not output a relocation section when --emit-relocs is used
3373   // as we do not have relocation sections for linker generated table entries
3374   // and we would have to erase at a late stage relocations from merged entries.
3375   // Given that exception tables are already position independent and a binary
3376   // analyzer could derive the relocations we choose to erase the relocations.
3377   if (config->emitRelocs && isec->type == SHT_REL)
3378     if (InputSectionBase *ex = isec->getRelocatedSection())
3379       if (isa<InputSection>(ex) && ex->type == SHT_ARM_EXIDX)
3380         return true;
3381 
3382   return false;
3383 }
3384 
3385 // References to .ARM.Extab Sections have bit 31 clear and are not the
3386 // special EXIDX_CANTUNWIND bit-pattern.
3387 static bool isExtabRef(uint32_t unwind) {
3388   return (unwind & 0x80000000) == 0 && unwind != 0x1;
3389 }
3390 
3391 // Return true if the .ARM.exidx section Cur can be merged into the .ARM.exidx
3392 // section Prev, where Cur follows Prev in the table. This can be done if the
3393 // unwinding instructions in Cur are identical to Prev. Linker generated
3394 // EXIDX_CANTUNWIND entries are represented by nullptr as they do not have an
3395 // InputSection.
3396 static bool isDuplicateArmExidxSec(InputSection *prev, InputSection *cur) {
3397 
3398   struct ExidxEntry {
3399     ulittle32_t fn;
3400     ulittle32_t unwind;
3401   };
3402   // Get the last table Entry from the previous .ARM.exidx section. If Prev is
3403   // nullptr then it will be a synthesized EXIDX_CANTUNWIND entry.
3404   ExidxEntry prevEntry = {ulittle32_t(0), ulittle32_t(1)};
3405   if (prev)
3406     prevEntry = prev->getDataAs<ExidxEntry>().back();
3407   if (isExtabRef(prevEntry.unwind))
3408     return false;
3409 
3410   // We consider the unwind instructions of an .ARM.exidx table entry
3411   // a duplicate if the previous unwind instructions if:
3412   // - Both are the special EXIDX_CANTUNWIND.
3413   // - Both are the same inline unwind instructions.
3414   // We do not attempt to follow and check links into .ARM.extab tables as
3415   // consecutive identical entries are rare and the effort to check that they
3416   // are identical is high.
3417 
3418   // If Cur is nullptr then this is synthesized EXIDX_CANTUNWIND entry.
3419   if (cur == nullptr)
3420     return prevEntry.unwind == 1;
3421 
3422   for (const ExidxEntry entry : cur->getDataAs<ExidxEntry>())
3423     if (isExtabRef(entry.unwind) || entry.unwind != prevEntry.unwind)
3424       return false;
3425 
3426   // All table entries in this .ARM.exidx Section can be merged into the
3427   // previous Section.
3428   return true;
3429 }
3430 
3431 // The .ARM.exidx table must be sorted in ascending order of the address of the
3432 // functions the table describes. Optionally duplicate adjacent table entries
3433 // can be removed. At the end of the function the executableSections must be
3434 // sorted in ascending order of address, Sentinel is set to the InputSection
3435 // with the highest address and any InputSections that have mergeable
3436 // .ARM.exidx table entries are removed from it.
3437 void ARMExidxSyntheticSection::finalizeContents() {
3438   // The executableSections and exidxSections that we use to derive the final
3439   // contents of this SyntheticSection are populated before
3440   // processSectionCommands() and ICF. A /DISCARD/ entry in SECTIONS command or
3441   // ICF may remove executable InputSections and their dependent .ARM.exidx
3442   // section that we recorded earlier.
3443   auto isDiscarded = [](const InputSection *isec) { return !isec->isLive(); };
3444   llvm::erase_if(exidxSections, isDiscarded);
3445   // We need to remove discarded InputSections and InputSections without
3446   // .ARM.exidx sections that if we generated the .ARM.exidx it would be out
3447   // of range.
3448   auto isDiscardedOrOutOfRange = [this](InputSection *isec) {
3449     if (!isec->isLive())
3450       return true;
3451     if (findExidxSection(isec))
3452       return false;
3453     int64_t off = static_cast<int64_t>(isec->getVA() - getVA());
3454     return off != llvm::SignExtend64(off, 31);
3455   };
3456   llvm::erase_if(executableSections, isDiscardedOrOutOfRange);
3457 
3458   // Sort the executable sections that may or may not have associated
3459   // .ARM.exidx sections by order of ascending address. This requires the
3460   // relative positions of InputSections and OutputSections to be known.
3461   auto compareByFilePosition = [](const InputSection *a,
3462                                   const InputSection *b) {
3463     OutputSection *aOut = a->getParent();
3464     OutputSection *bOut = b->getParent();
3465 
3466     if (aOut != bOut)
3467       return aOut->addr < bOut->addr;
3468     return a->outSecOff < b->outSecOff;
3469   };
3470   llvm::stable_sort(executableSections, compareByFilePosition);
3471   sentinel = executableSections.back();
3472   // Optionally merge adjacent duplicate entries.
3473   if (config->mergeArmExidx) {
3474     std::vector<InputSection *> selectedSections;
3475     selectedSections.reserve(executableSections.size());
3476     selectedSections.push_back(executableSections[0]);
3477     size_t prev = 0;
3478     for (size_t i = 1; i < executableSections.size(); ++i) {
3479       InputSection *ex1 = findExidxSection(executableSections[prev]);
3480       InputSection *ex2 = findExidxSection(executableSections[i]);
3481       if (!isDuplicateArmExidxSec(ex1, ex2)) {
3482         selectedSections.push_back(executableSections[i]);
3483         prev = i;
3484       }
3485     }
3486     executableSections = std::move(selectedSections);
3487   }
3488 
3489   size_t offset = 0;
3490   size = 0;
3491   for (InputSection *isec : executableSections) {
3492     if (InputSection *d = findExidxSection(isec)) {
3493       d->outSecOff = offset;
3494       d->parent = getParent();
3495       offset += d->getSize();
3496     } else {
3497       offset += 8;
3498     }
3499   }
3500   // Size includes Sentinel.
3501   size = offset + 8;
3502 }
3503 
3504 InputSection *ARMExidxSyntheticSection::getLinkOrderDep() const {
3505   return executableSections.front();
3506 }
3507 
3508 // To write the .ARM.exidx table from the ExecutableSections we have three cases
3509 // 1.) The InputSection has a .ARM.exidx InputSection in its dependent sections.
3510 //     We write the .ARM.exidx section contents and apply its relocations.
3511 // 2.) The InputSection does not have a dependent .ARM.exidx InputSection. We
3512 //     must write the contents of an EXIDX_CANTUNWIND directly. We use the
3513 //     start of the InputSection as the purpose of the linker generated
3514 //     section is to terminate the address range of the previous entry.
3515 // 3.) A trailing EXIDX_CANTUNWIND sentinel section is required at the end of
3516 //     the table to terminate the address range of the final entry.
3517 void ARMExidxSyntheticSection::writeTo(uint8_t *buf) {
3518 
3519   const uint8_t cantUnwindData[8] = {0, 0, 0, 0,  // PREL31 to target
3520                                      1, 0, 0, 0}; // EXIDX_CANTUNWIND
3521 
3522   uint64_t offset = 0;
3523   for (InputSection *isec : executableSections) {
3524     assert(isec->getParent() != nullptr);
3525     if (InputSection *d = findExidxSection(isec)) {
3526       memcpy(buf + offset, d->data().data(), d->data().size());
3527       d->relocateAlloc(buf + d->outSecOff, buf + d->outSecOff + d->getSize());
3528       offset += d->getSize();
3529     } else {
3530       // A Linker generated CANTUNWIND section.
3531       memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
3532       uint64_t s = isec->getVA();
3533       uint64_t p = getVA() + offset;
3534       target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
3535       offset += 8;
3536     }
3537   }
3538   // Write Sentinel.
3539   memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
3540   uint64_t s = sentinel->getVA(sentinel->getSize());
3541   uint64_t p = getVA() + offset;
3542   target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
3543   assert(size == offset + 8);
3544 }
3545 
3546 bool ARMExidxSyntheticSection::isNeeded() const {
3547   return llvm::find_if(exidxSections, [](InputSection *isec) {
3548            return isec->isLive();
3549          }) != exidxSections.end();
3550 }
3551 
3552 bool ARMExidxSyntheticSection::classof(const SectionBase *d) {
3553   return d->kind() == InputSectionBase::Synthetic && d->type == SHT_ARM_EXIDX;
3554 }
3555 
3556 ThunkSection::ThunkSection(OutputSection *os, uint64_t off)
3557     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS,
3558                        config->emachine == EM_PPC64 ? 16 : 4, ".text.thunk") {
3559   this->parent = os;
3560   this->outSecOff = off;
3561 }
3562 
3563 size_t ThunkSection::getSize() const {
3564   if (roundUpSizeForErrata)
3565     return alignTo(size, 4096);
3566   return size;
3567 }
3568 
3569 void ThunkSection::addThunk(Thunk *t) {
3570   thunks.push_back(t);
3571   t->addSymbols(*this);
3572 }
3573 
3574 void ThunkSection::writeTo(uint8_t *buf) {
3575   for (Thunk *t : thunks)
3576     t->writeTo(buf + t->offset);
3577 }
3578 
3579 InputSection *ThunkSection::getTargetInputSection() const {
3580   if (thunks.empty())
3581     return nullptr;
3582   const Thunk *t = thunks.front();
3583   return t->getTargetInputSection();
3584 }
3585 
3586 bool ThunkSection::assignOffsets() {
3587   uint64_t off = 0;
3588   for (Thunk *t : thunks) {
3589     off = alignTo(off, t->alignment);
3590     t->setOffset(off);
3591     uint32_t size = t->size();
3592     t->getThunkTargetSym()->size = size;
3593     off += size;
3594   }
3595   bool changed = off != size;
3596   size = off;
3597   return changed;
3598 }
3599 
3600 PPC32Got2Section::PPC32Got2Section()
3601     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, 4, ".got2") {}
3602 
3603 bool PPC32Got2Section::isNeeded() const {
3604   // See the comment below. This is not needed if there is no other
3605   // InputSection.
3606   for (BaseCommand *base : getParent()->sectionCommands)
3607     if (auto *isd = dyn_cast<InputSectionDescription>(base))
3608       for (InputSection *isec : isd->sections)
3609         if (isec != this)
3610           return true;
3611   return false;
3612 }
3613 
3614 void PPC32Got2Section::finalizeContents() {
3615   // PPC32 may create multiple GOT sections for -fPIC/-fPIE, one per file in
3616   // .got2 . This function computes outSecOff of each .got2 to be used in
3617   // PPC32PltCallStub::writeTo(). The purpose of this empty synthetic section is
3618   // to collect input sections named ".got2".
3619   uint32_t offset = 0;
3620   for (BaseCommand *base : getParent()->sectionCommands)
3621     if (auto *isd = dyn_cast<InputSectionDescription>(base)) {
3622       for (InputSection *isec : isd->sections) {
3623         if (isec == this)
3624           continue;
3625         isec->file->ppc32Got2OutSecOff = offset;
3626         offset += (uint32_t)isec->getSize();
3627       }
3628     }
3629 }
3630 
3631 // If linking position-dependent code then the table will store the addresses
3632 // directly in the binary so the section has type SHT_PROGBITS. If linking
3633 // position-independent code the section has type SHT_NOBITS since it will be
3634 // allocated and filled in by the dynamic linker.
3635 PPC64LongBranchTargetSection::PPC64LongBranchTargetSection()
3636     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
3637                        config->isPic ? SHT_NOBITS : SHT_PROGBITS, 8,
3638                        ".branch_lt") {}
3639 
3640 uint64_t PPC64LongBranchTargetSection::getEntryVA(const Symbol *sym,
3641                                                   int64_t addend) {
3642   return getVA() + entry_index.find({sym, addend})->second * 8;
3643 }
3644 
3645 Optional<uint32_t> PPC64LongBranchTargetSection::addEntry(const Symbol *sym,
3646                                                           int64_t addend) {
3647   auto res =
3648       entry_index.try_emplace(std::make_pair(sym, addend), entries.size());
3649   if (!res.second)
3650     return None;
3651   entries.emplace_back(sym, addend);
3652   return res.first->second;
3653 }
3654 
3655 size_t PPC64LongBranchTargetSection::getSize() const {
3656   return entries.size() * 8;
3657 }
3658 
3659 void PPC64LongBranchTargetSection::writeTo(uint8_t *buf) {
3660   // If linking non-pic we have the final addresses of the targets and they get
3661   // written to the table directly. For pic the dynamic linker will allocate
3662   // the section and fill it it.
3663   if (config->isPic)
3664     return;
3665 
3666   for (auto entry : entries) {
3667     const Symbol *sym = entry.first;
3668     int64_t addend = entry.second;
3669     assert(sym->getVA());
3670     // Need calls to branch to the local entry-point since a long-branch
3671     // must be a local-call.
3672     write64(buf, sym->getVA(addend) +
3673                      getPPC64GlobalEntryToLocalEntryOffset(sym->stOther));
3674     buf += 8;
3675   }
3676 }
3677 
3678 bool PPC64LongBranchTargetSection::isNeeded() const {
3679   // `removeUnusedSyntheticSections()` is called before thunk allocation which
3680   // is too early to determine if this section will be empty or not. We need
3681   // Finalized to keep the section alive until after thunk creation. Finalized
3682   // only gets set to true once `finalizeSections()` is called after thunk
3683   // creation. Because of this, if we don't create any long-branch thunks we end
3684   // up with an empty .branch_lt section in the binary.
3685   return !finalized || !entries.empty();
3686 }
3687 
3688 static uint8_t getAbiVersion() {
3689   // MIPS non-PIC executable gets ABI version 1.
3690   if (config->emachine == EM_MIPS) {
3691     if (!config->isPic && !config->relocatable &&
3692         (config->eflags & (EF_MIPS_PIC | EF_MIPS_CPIC)) == EF_MIPS_CPIC)
3693       return 1;
3694     return 0;
3695   }
3696 
3697   if (config->emachine == EM_AMDGPU) {
3698     uint8_t ver = objectFiles[0]->abiVersion;
3699     for (InputFile *file : makeArrayRef(objectFiles).slice(1))
3700       if (file->abiVersion != ver)
3701         error("incompatible ABI version: " + toString(file));
3702     return ver;
3703   }
3704 
3705   return 0;
3706 }
3707 
3708 template <typename ELFT> void elf::writeEhdr(uint8_t *buf, Partition &part) {
3709   // For executable segments, the trap instructions are written before writing
3710   // the header. Setting Elf header bytes to zero ensures that any unused bytes
3711   // in header are zero-cleared, instead of having trap instructions.
3712   memset(buf, 0, sizeof(typename ELFT::Ehdr));
3713   memcpy(buf, "\177ELF", 4);
3714 
3715   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
3716   eHdr->e_ident[EI_CLASS] = config->is64 ? ELFCLASS64 : ELFCLASS32;
3717   eHdr->e_ident[EI_DATA] = config->isLE ? ELFDATA2LSB : ELFDATA2MSB;
3718   eHdr->e_ident[EI_VERSION] = EV_CURRENT;
3719   eHdr->e_ident[EI_OSABI] = config->osabi;
3720   eHdr->e_ident[EI_ABIVERSION] = getAbiVersion();
3721   eHdr->e_machine = config->emachine;
3722   eHdr->e_version = EV_CURRENT;
3723   eHdr->e_flags = config->eflags;
3724   eHdr->e_ehsize = sizeof(typename ELFT::Ehdr);
3725   eHdr->e_phnum = part.phdrs.size();
3726   eHdr->e_shentsize = sizeof(typename ELFT::Shdr);
3727 
3728   if (!config->relocatable) {
3729     eHdr->e_phoff = sizeof(typename ELFT::Ehdr);
3730     eHdr->e_phentsize = sizeof(typename ELFT::Phdr);
3731   }
3732 }
3733 
3734 template <typename ELFT> void elf::writePhdrs(uint8_t *buf, Partition &part) {
3735   // Write the program header table.
3736   auto *hBuf = reinterpret_cast<typename ELFT::Phdr *>(buf);
3737   for (PhdrEntry *p : part.phdrs) {
3738     hBuf->p_type = p->p_type;
3739     hBuf->p_flags = p->p_flags;
3740     hBuf->p_offset = p->p_offset;
3741     hBuf->p_vaddr = p->p_vaddr;
3742     hBuf->p_paddr = p->p_paddr;
3743     hBuf->p_filesz = p->p_filesz;
3744     hBuf->p_memsz = p->p_memsz;
3745     hBuf->p_align = p->p_align;
3746     ++hBuf;
3747   }
3748 }
3749 
3750 template <typename ELFT>
3751 PartitionElfHeaderSection<ELFT>::PartitionElfHeaderSection()
3752     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_EHDR, 1, "") {}
3753 
3754 template <typename ELFT>
3755 size_t PartitionElfHeaderSection<ELFT>::getSize() const {
3756   return sizeof(typename ELFT::Ehdr);
3757 }
3758 
3759 template <typename ELFT>
3760 void PartitionElfHeaderSection<ELFT>::writeTo(uint8_t *buf) {
3761   writeEhdr<ELFT>(buf, getPartition());
3762 
3763   // Loadable partitions are always ET_DYN.
3764   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
3765   eHdr->e_type = ET_DYN;
3766 }
3767 
3768 template <typename ELFT>
3769 PartitionProgramHeadersSection<ELFT>::PartitionProgramHeadersSection()
3770     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_PHDR, 1, ".phdrs") {}
3771 
3772 template <typename ELFT>
3773 size_t PartitionProgramHeadersSection<ELFT>::getSize() const {
3774   return sizeof(typename ELFT::Phdr) * getPartition().phdrs.size();
3775 }
3776 
3777 template <typename ELFT>
3778 void PartitionProgramHeadersSection<ELFT>::writeTo(uint8_t *buf) {
3779   writePhdrs<ELFT>(buf, getPartition());
3780 }
3781 
3782 PartitionIndexSection::PartitionIndexSection()
3783     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".rodata") {}
3784 
3785 size_t PartitionIndexSection::getSize() const {
3786   return 12 * (partitions.size() - 1);
3787 }
3788 
3789 void PartitionIndexSection::finalizeContents() {
3790   for (size_t i = 1; i != partitions.size(); ++i)
3791     partitions[i].nameStrTab = mainPart->dynStrTab->addString(partitions[i].name);
3792 }
3793 
3794 void PartitionIndexSection::writeTo(uint8_t *buf) {
3795   uint64_t va = getVA();
3796   for (size_t i = 1; i != partitions.size(); ++i) {
3797     write32(buf, mainPart->dynStrTab->getVA() + partitions[i].nameStrTab - va);
3798     write32(buf + 4, partitions[i].elfHeader->getVA() - (va + 4));
3799 
3800     SyntheticSection *next =
3801         i == partitions.size() - 1 ? in.partEnd : partitions[i + 1].elfHeader;
3802     write32(buf + 8, next->getVA() - partitions[i].elfHeader->getVA());
3803 
3804     va += 12;
3805     buf += 12;
3806   }
3807 }
3808 
3809 InStruct elf::in;
3810 
3811 std::vector<Partition> elf::partitions;
3812 Partition *elf::mainPart;
3813 
3814 template GdbIndexSection *GdbIndexSection::create<ELF32LE>();
3815 template GdbIndexSection *GdbIndexSection::create<ELF32BE>();
3816 template GdbIndexSection *GdbIndexSection::create<ELF64LE>();
3817 template GdbIndexSection *GdbIndexSection::create<ELF64BE>();
3818 
3819 template void elf::splitSections<ELF32LE>();
3820 template void elf::splitSections<ELF32BE>();
3821 template void elf::splitSections<ELF64LE>();
3822 template void elf::splitSections<ELF64BE>();
3823 
3824 template class elf::MipsAbiFlagsSection<ELF32LE>;
3825 template class elf::MipsAbiFlagsSection<ELF32BE>;
3826 template class elf::MipsAbiFlagsSection<ELF64LE>;
3827 template class elf::MipsAbiFlagsSection<ELF64BE>;
3828 
3829 template class elf::MipsOptionsSection<ELF32LE>;
3830 template class elf::MipsOptionsSection<ELF32BE>;
3831 template class elf::MipsOptionsSection<ELF64LE>;
3832 template class elf::MipsOptionsSection<ELF64BE>;
3833 
3834 template void EhFrameSection::iterateFDEWithLSDA<ELF32LE>(
3835     function_ref<void(InputSection &)>);
3836 template void EhFrameSection::iterateFDEWithLSDA<ELF32BE>(
3837     function_ref<void(InputSection &)>);
3838 template void EhFrameSection::iterateFDEWithLSDA<ELF64LE>(
3839     function_ref<void(InputSection &)>);
3840 template void EhFrameSection::iterateFDEWithLSDA<ELF64BE>(
3841     function_ref<void(InputSection &)>);
3842 
3843 template class elf::MipsReginfoSection<ELF32LE>;
3844 template class elf::MipsReginfoSection<ELF32BE>;
3845 template class elf::MipsReginfoSection<ELF64LE>;
3846 template class elf::MipsReginfoSection<ELF64BE>;
3847 
3848 template class elf::DynamicSection<ELF32LE>;
3849 template class elf::DynamicSection<ELF32BE>;
3850 template class elf::DynamicSection<ELF64LE>;
3851 template class elf::DynamicSection<ELF64BE>;
3852 
3853 template class elf::RelocationSection<ELF32LE>;
3854 template class elf::RelocationSection<ELF32BE>;
3855 template class elf::RelocationSection<ELF64LE>;
3856 template class elf::RelocationSection<ELF64BE>;
3857 
3858 template class elf::AndroidPackedRelocationSection<ELF32LE>;
3859 template class elf::AndroidPackedRelocationSection<ELF32BE>;
3860 template class elf::AndroidPackedRelocationSection<ELF64LE>;
3861 template class elf::AndroidPackedRelocationSection<ELF64BE>;
3862 
3863 template class elf::RelrSection<ELF32LE>;
3864 template class elf::RelrSection<ELF32BE>;
3865 template class elf::RelrSection<ELF64LE>;
3866 template class elf::RelrSection<ELF64BE>;
3867 
3868 template class elf::SymbolTableSection<ELF32LE>;
3869 template class elf::SymbolTableSection<ELF32BE>;
3870 template class elf::SymbolTableSection<ELF64LE>;
3871 template class elf::SymbolTableSection<ELF64BE>;
3872 
3873 template class elf::VersionNeedSection<ELF32LE>;
3874 template class elf::VersionNeedSection<ELF32BE>;
3875 template class elf::VersionNeedSection<ELF64LE>;
3876 template class elf::VersionNeedSection<ELF64BE>;
3877 
3878 template void elf::writeEhdr<ELF32LE>(uint8_t *Buf, Partition &Part);
3879 template void elf::writeEhdr<ELF32BE>(uint8_t *Buf, Partition &Part);
3880 template void elf::writeEhdr<ELF64LE>(uint8_t *Buf, Partition &Part);
3881 template void elf::writeEhdr<ELF64BE>(uint8_t *Buf, Partition &Part);
3882 
3883 template void elf::writePhdrs<ELF32LE>(uint8_t *Buf, Partition &Part);
3884 template void elf::writePhdrs<ELF32BE>(uint8_t *Buf, Partition &Part);
3885 template void elf::writePhdrs<ELF64LE>(uint8_t *Buf, Partition &Part);
3886 template void elf::writePhdrs<ELF64BE>(uint8_t *Buf, Partition &Part);
3887 
3888 template class elf::PartitionElfHeaderSection<ELF32LE>;
3889 template class elf::PartitionElfHeaderSection<ELF32BE>;
3890 template class elf::PartitionElfHeaderSection<ELF64LE>;
3891 template class elf::PartitionElfHeaderSection<ELF64BE>;
3892 
3893 template class elf::PartitionProgramHeadersSection<ELF32LE>;
3894 template class elf::PartitionProgramHeadersSection<ELF32BE>;
3895 template class elf::PartitionProgramHeadersSection<ELF64LE>;
3896 template class elf::PartitionProgramHeadersSection<ELF64BE>;
3897