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,
648                        target->gotEntrySize, ".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()) *
1149          target->gotEntrySize;
1150 }
1151 
1152 void GotPltSection::writeTo(uint8_t *buf) {
1153   target->writeGotPltHeader(buf);
1154   buf += target->gotPltHeaderEntriesNum * target->gotEntrySize;
1155   for (const Symbol *b : entries) {
1156     target->writeGotPlt(buf, *b);
1157     buf += target->gotEntrySize;
1158   }
1159 }
1160 
1161 bool GotPltSection::isNeeded() const {
1162   // We need to emit GOTPLT even if it's empty if there's a relocation relative
1163   // to it.
1164   return !entries.empty() || hasGotPltOffRel;
1165 }
1166 
1167 static StringRef getIgotPltName() {
1168   // On ARM the IgotPltSection is part of the GotSection.
1169   if (config->emachine == EM_ARM)
1170     return ".got";
1171 
1172   // On PowerPC64 the GotPltSection is renamed to '.plt' so the IgotPltSection
1173   // needs to be named the same.
1174   if (config->emachine == EM_PPC64)
1175     return ".plt";
1176 
1177   return ".got.plt";
1178 }
1179 
1180 // On PowerPC64 the GotPltSection type is SHT_NOBITS so we have to follow suit
1181 // with the IgotPltSection.
1182 IgotPltSection::IgotPltSection()
1183     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
1184                        config->emachine == EM_PPC64 ? SHT_NOBITS : SHT_PROGBITS,
1185                        target->gotEntrySize, getIgotPltName()) {}
1186 
1187 void IgotPltSection::addEntry(Symbol &sym) {
1188   assert(sym.pltIndex == entries.size());
1189   entries.push_back(&sym);
1190 }
1191 
1192 size_t IgotPltSection::getSize() const {
1193   return entries.size() * target->gotEntrySize;
1194 }
1195 
1196 void IgotPltSection::writeTo(uint8_t *buf) {
1197   for (const Symbol *b : entries) {
1198     target->writeIgotPlt(buf, *b);
1199     buf += target->gotEntrySize;
1200   }
1201 }
1202 
1203 StringTableSection::StringTableSection(StringRef name, bool dynamic)
1204     : SyntheticSection(dynamic ? (uint64_t)SHF_ALLOC : 0, SHT_STRTAB, 1, name),
1205       dynamic(dynamic) {
1206   // ELF string tables start with a NUL byte.
1207   addString("");
1208 }
1209 
1210 // Adds a string to the string table. If `hashIt` is true we hash and check for
1211 // duplicates. It is optional because the name of global symbols are already
1212 // uniqued and hashing them again has a big cost for a small value: uniquing
1213 // them with some other string that happens to be the same.
1214 unsigned StringTableSection::addString(StringRef s, bool hashIt) {
1215   if (hashIt) {
1216     auto r = stringMap.insert(std::make_pair(s, this->size));
1217     if (!r.second)
1218       return r.first->second;
1219   }
1220   unsigned ret = this->size;
1221   this->size = this->size + s.size() + 1;
1222   strings.push_back(s);
1223   return ret;
1224 }
1225 
1226 void StringTableSection::writeTo(uint8_t *buf) {
1227   for (StringRef s : strings) {
1228     memcpy(buf, s.data(), s.size());
1229     buf[s.size()] = '\0';
1230     buf += s.size() + 1;
1231   }
1232 }
1233 
1234 // Returns the number of entries in .gnu.version_d: the number of
1235 // non-VER_NDX_LOCAL-non-VER_NDX_GLOBAL definitions, plus 1.
1236 // Note that we don't support vd_cnt > 1 yet.
1237 static unsigned getVerDefNum() {
1238   return namedVersionDefs().size() + 1;
1239 }
1240 
1241 template <class ELFT>
1242 DynamicSection<ELFT>::DynamicSection()
1243     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_DYNAMIC, config->wordsize,
1244                        ".dynamic") {
1245   this->entsize = ELFT::Is64Bits ? 16 : 8;
1246 
1247   // .dynamic section is not writable on MIPS and on Fuchsia OS
1248   // which passes -z rodynamic.
1249   // See "Special Section" in Chapter 4 in the following document:
1250   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1251   if (config->emachine == EM_MIPS || config->zRodynamic)
1252     this->flags = SHF_ALLOC;
1253 }
1254 
1255 template <class ELFT>
1256 void DynamicSection<ELFT>::add(int32_t tag, std::function<uint64_t()> fn) {
1257   entries.push_back({tag, fn});
1258 }
1259 
1260 template <class ELFT>
1261 void DynamicSection<ELFT>::addInt(int32_t tag, uint64_t val) {
1262   entries.push_back({tag, [=] { return val; }});
1263 }
1264 
1265 template <class ELFT>
1266 void DynamicSection<ELFT>::addInSec(int32_t tag, InputSection *sec) {
1267   entries.push_back({tag, [=] { return sec->getVA(0); }});
1268 }
1269 
1270 template <class ELFT>
1271 void DynamicSection<ELFT>::addInSecRelative(int32_t tag, InputSection *sec) {
1272   size_t tagOffset = entries.size() * entsize;
1273   entries.push_back(
1274       {tag, [=] { return sec->getVA(0) - (getVA() + tagOffset); }});
1275 }
1276 
1277 template <class ELFT>
1278 void DynamicSection<ELFT>::addOutSec(int32_t tag, OutputSection *sec) {
1279   entries.push_back({tag, [=] { return sec->addr; }});
1280 }
1281 
1282 template <class ELFT>
1283 void DynamicSection<ELFT>::addSize(int32_t tag, OutputSection *sec) {
1284   entries.push_back({tag, [=] { return sec->size; }});
1285 }
1286 
1287 template <class ELFT>
1288 void DynamicSection<ELFT>::addSym(int32_t tag, Symbol *sym) {
1289   entries.push_back({tag, [=] { return sym->getVA(); }});
1290 }
1291 
1292 // The output section .rela.dyn may include these synthetic sections:
1293 //
1294 // - part.relaDyn
1295 // - in.relaIplt: this is included if in.relaIplt is named .rela.dyn
1296 // - in.relaPlt: this is included if a linker script places .rela.plt inside
1297 //   .rela.dyn
1298 //
1299 // DT_RELASZ is the total size of the included sections.
1300 static std::function<uint64_t()> addRelaSz(RelocationBaseSection *relaDyn) {
1301   return [=]() {
1302     size_t size = relaDyn->getSize();
1303     if (in.relaIplt->getParent() == relaDyn->getParent())
1304       size += in.relaIplt->getSize();
1305     if (in.relaPlt->getParent() == relaDyn->getParent())
1306       size += in.relaPlt->getSize();
1307     return size;
1308   };
1309 }
1310 
1311 // A Linker script may assign the RELA relocation sections to the same
1312 // output section. When this occurs we cannot just use the OutputSection
1313 // Size. Moreover the [DT_JMPREL, DT_JMPREL + DT_PLTRELSZ) is permitted to
1314 // overlap with the [DT_RELA, DT_RELA + DT_RELASZ).
1315 static uint64_t addPltRelSz() {
1316   size_t size = in.relaPlt->getSize();
1317   if (in.relaIplt->getParent() == in.relaPlt->getParent() &&
1318       in.relaIplt->name == in.relaPlt->name)
1319     size += in.relaIplt->getSize();
1320   return size;
1321 }
1322 
1323 // Add remaining entries to complete .dynamic contents.
1324 template <class ELFT> void DynamicSection<ELFT>::finalizeContents() {
1325   elf::Partition &part = getPartition();
1326   bool isMain = part.name.empty();
1327 
1328   for (StringRef s : config->filterList)
1329     addInt(DT_FILTER, part.dynStrTab->addString(s));
1330   for (StringRef s : config->auxiliaryList)
1331     addInt(DT_AUXILIARY, part.dynStrTab->addString(s));
1332 
1333   if (!config->rpath.empty())
1334     addInt(config->enableNewDtags ? DT_RUNPATH : DT_RPATH,
1335            part.dynStrTab->addString(config->rpath));
1336 
1337   for (SharedFile *file : sharedFiles)
1338     if (file->isNeeded)
1339       addInt(DT_NEEDED, part.dynStrTab->addString(file->soName));
1340 
1341   if (isMain) {
1342     if (!config->soName.empty())
1343       addInt(DT_SONAME, part.dynStrTab->addString(config->soName));
1344   } else {
1345     if (!config->soName.empty())
1346       addInt(DT_NEEDED, part.dynStrTab->addString(config->soName));
1347     addInt(DT_SONAME, part.dynStrTab->addString(part.name));
1348   }
1349 
1350   // Set DT_FLAGS and DT_FLAGS_1.
1351   uint32_t dtFlags = 0;
1352   uint32_t dtFlags1 = 0;
1353   if (config->bsymbolic)
1354     dtFlags |= DF_SYMBOLIC;
1355   if (config->zGlobal)
1356     dtFlags1 |= DF_1_GLOBAL;
1357   if (config->zInitfirst)
1358     dtFlags1 |= DF_1_INITFIRST;
1359   if (config->zInterpose)
1360     dtFlags1 |= DF_1_INTERPOSE;
1361   if (config->zNodefaultlib)
1362     dtFlags1 |= DF_1_NODEFLIB;
1363   if (config->zNodelete)
1364     dtFlags1 |= DF_1_NODELETE;
1365   if (config->zNodlopen)
1366     dtFlags1 |= DF_1_NOOPEN;
1367   if (config->pie)
1368     dtFlags1 |= DF_1_PIE;
1369   if (config->zNow) {
1370     dtFlags |= DF_BIND_NOW;
1371     dtFlags1 |= DF_1_NOW;
1372   }
1373   if (config->zOrigin) {
1374     dtFlags |= DF_ORIGIN;
1375     dtFlags1 |= DF_1_ORIGIN;
1376   }
1377   if (!config->zText)
1378     dtFlags |= DF_TEXTREL;
1379   if (config->hasStaticTlsModel)
1380     dtFlags |= DF_STATIC_TLS;
1381 
1382   if (dtFlags)
1383     addInt(DT_FLAGS, dtFlags);
1384   if (dtFlags1)
1385     addInt(DT_FLAGS_1, dtFlags1);
1386 
1387   // DT_DEBUG is a pointer to debug information used by debuggers at runtime. We
1388   // need it for each process, so we don't write it for DSOs. The loader writes
1389   // the pointer into this entry.
1390   //
1391   // DT_DEBUG is the only .dynamic entry that needs to be written to. Some
1392   // systems (currently only Fuchsia OS) provide other means to give the
1393   // debugger this information. Such systems may choose make .dynamic read-only.
1394   // If the target is such a system (used -z rodynamic) don't write DT_DEBUG.
1395   if (!config->shared && !config->relocatable && !config->zRodynamic)
1396     addInt(DT_DEBUG, 0);
1397 
1398   if (OutputSection *sec = part.dynStrTab->getParent())
1399     this->link = sec->sectionIndex;
1400 
1401   if (part.relaDyn->isNeeded() ||
1402       (in.relaIplt->isNeeded() &&
1403        part.relaDyn->getParent() == in.relaIplt->getParent())) {
1404     addInSec(part.relaDyn->dynamicTag, part.relaDyn);
1405     entries.push_back({part.relaDyn->sizeDynamicTag, addRelaSz(part.relaDyn)});
1406 
1407     bool isRela = config->isRela;
1408     addInt(isRela ? DT_RELAENT : DT_RELENT,
1409            isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel));
1410 
1411     // MIPS dynamic loader does not support RELCOUNT tag.
1412     // The problem is in the tight relation between dynamic
1413     // relocations and GOT. So do not emit this tag on MIPS.
1414     if (config->emachine != EM_MIPS) {
1415       size_t numRelativeRels = part.relaDyn->getRelativeRelocCount();
1416       if (config->zCombreloc && numRelativeRels)
1417         addInt(isRela ? DT_RELACOUNT : DT_RELCOUNT, numRelativeRels);
1418     }
1419   }
1420   if (part.relrDyn && !part.relrDyn->relocs.empty()) {
1421     addInSec(config->useAndroidRelrTags ? DT_ANDROID_RELR : DT_RELR,
1422              part.relrDyn);
1423     addSize(config->useAndroidRelrTags ? DT_ANDROID_RELRSZ : DT_RELRSZ,
1424             part.relrDyn->getParent());
1425     addInt(config->useAndroidRelrTags ? DT_ANDROID_RELRENT : DT_RELRENT,
1426            sizeof(Elf_Relr));
1427   }
1428   // .rel[a].plt section usually consists of two parts, containing plt and
1429   // iplt relocations. It is possible to have only iplt relocations in the
1430   // output. In that case relaPlt is empty and have zero offset, the same offset
1431   // as relaIplt has. And we still want to emit proper dynamic tags for that
1432   // case, so here we always use relaPlt as marker for the beginning of
1433   // .rel[a].plt section.
1434   if (isMain && (in.relaPlt->isNeeded() || in.relaIplt->isNeeded())) {
1435     addInSec(DT_JMPREL, in.relaPlt);
1436     entries.push_back({DT_PLTRELSZ, addPltRelSz});
1437     switch (config->emachine) {
1438     case EM_MIPS:
1439       addInSec(DT_MIPS_PLTGOT, in.gotPlt);
1440       break;
1441     case EM_SPARCV9:
1442       addInSec(DT_PLTGOT, in.plt);
1443       break;
1444     case EM_AARCH64:
1445       if (llvm::find_if(in.relaPlt->relocs, [](const DynamicReloc &r) {
1446            return r.type == target->pltRel &&
1447                   r.sym->stOther & STO_AARCH64_VARIANT_PCS;
1448           }) != in.relaPlt->relocs.end())
1449         addInt(DT_AARCH64_VARIANT_PCS, 0);
1450       LLVM_FALLTHROUGH;
1451     default:
1452       addInSec(DT_PLTGOT, in.gotPlt);
1453       break;
1454     }
1455     addInt(DT_PLTREL, config->isRela ? DT_RELA : DT_REL);
1456   }
1457 
1458   if (config->emachine == EM_AARCH64) {
1459     if (config->andFeatures & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)
1460       addInt(DT_AARCH64_BTI_PLT, 0);
1461     if (config->zPacPlt)
1462       addInt(DT_AARCH64_PAC_PLT, 0);
1463   }
1464 
1465   addInSec(DT_SYMTAB, part.dynSymTab);
1466   addInt(DT_SYMENT, sizeof(Elf_Sym));
1467   addInSec(DT_STRTAB, part.dynStrTab);
1468   addInt(DT_STRSZ, part.dynStrTab->getSize());
1469   if (!config->zText)
1470     addInt(DT_TEXTREL, 0);
1471   if (part.gnuHashTab)
1472     addInSec(DT_GNU_HASH, part.gnuHashTab);
1473   if (part.hashTab)
1474     addInSec(DT_HASH, part.hashTab);
1475 
1476   if (isMain) {
1477     if (Out::preinitArray) {
1478       addOutSec(DT_PREINIT_ARRAY, Out::preinitArray);
1479       addSize(DT_PREINIT_ARRAYSZ, Out::preinitArray);
1480     }
1481     if (Out::initArray) {
1482       addOutSec(DT_INIT_ARRAY, Out::initArray);
1483       addSize(DT_INIT_ARRAYSZ, Out::initArray);
1484     }
1485     if (Out::finiArray) {
1486       addOutSec(DT_FINI_ARRAY, Out::finiArray);
1487       addSize(DT_FINI_ARRAYSZ, Out::finiArray);
1488     }
1489 
1490     if (Symbol *b = symtab->find(config->init))
1491       if (b->isDefined())
1492         addSym(DT_INIT, b);
1493     if (Symbol *b = symtab->find(config->fini))
1494       if (b->isDefined())
1495         addSym(DT_FINI, b);
1496   }
1497 
1498   if (part.verSym && part.verSym->isNeeded())
1499     addInSec(DT_VERSYM, part.verSym);
1500   if (part.verDef && part.verDef->isLive()) {
1501     addInSec(DT_VERDEF, part.verDef);
1502     addInt(DT_VERDEFNUM, getVerDefNum());
1503   }
1504   if (part.verNeed && part.verNeed->isNeeded()) {
1505     addInSec(DT_VERNEED, part.verNeed);
1506     unsigned needNum = 0;
1507     for (SharedFile *f : sharedFiles)
1508       if (!f->vernauxs.empty())
1509         ++needNum;
1510     addInt(DT_VERNEEDNUM, needNum);
1511   }
1512 
1513   if (config->emachine == EM_MIPS) {
1514     addInt(DT_MIPS_RLD_VERSION, 1);
1515     addInt(DT_MIPS_FLAGS, RHF_NOTPOT);
1516     addInt(DT_MIPS_BASE_ADDRESS, target->getImageBase());
1517     addInt(DT_MIPS_SYMTABNO, part.dynSymTab->getNumSymbols());
1518 
1519     add(DT_MIPS_LOCAL_GOTNO, [] { return in.mipsGot->getLocalEntriesNum(); });
1520 
1521     if (const Symbol *b = in.mipsGot->getFirstGlobalEntry())
1522       addInt(DT_MIPS_GOTSYM, b->dynsymIndex);
1523     else
1524       addInt(DT_MIPS_GOTSYM, part.dynSymTab->getNumSymbols());
1525     addInSec(DT_PLTGOT, in.mipsGot);
1526     if (in.mipsRldMap) {
1527       if (!config->pie)
1528         addInSec(DT_MIPS_RLD_MAP, in.mipsRldMap);
1529       // Store the offset to the .rld_map section
1530       // relative to the address of the tag.
1531       addInSecRelative(DT_MIPS_RLD_MAP_REL, in.mipsRldMap);
1532     }
1533   }
1534 
1535   // DT_PPC_GOT indicates to glibc Secure PLT is used. If DT_PPC_GOT is absent,
1536   // glibc assumes the old-style BSS PLT layout which we don't support.
1537   if (config->emachine == EM_PPC)
1538     add(DT_PPC_GOT, [] { return in.got->getVA(); });
1539 
1540   // Glink dynamic tag is required by the V2 abi if the plt section isn't empty.
1541   if (config->emachine == EM_PPC64 && in.plt->isNeeded()) {
1542     // The Glink tag points to 32 bytes before the first lazy symbol resolution
1543     // stub, which starts directly after the header.
1544     entries.push_back({DT_PPC64_GLINK, [=] {
1545                          unsigned offset = target->pltHeaderSize - 32;
1546                          return in.plt->getVA(0) + offset;
1547                        }});
1548   }
1549 
1550   addInt(DT_NULL, 0);
1551 
1552   getParent()->link = this->link;
1553   this->size = entries.size() * this->entsize;
1554 }
1555 
1556 template <class ELFT> void DynamicSection<ELFT>::writeTo(uint8_t *buf) {
1557   auto *p = reinterpret_cast<Elf_Dyn *>(buf);
1558 
1559   for (std::pair<int32_t, std::function<uint64_t()>> &kv : entries) {
1560     p->d_tag = kv.first;
1561     p->d_un.d_val = kv.second();
1562     ++p;
1563   }
1564 }
1565 
1566 uint64_t DynamicReloc::getOffset() const {
1567   return inputSec->getVA(offsetInSec);
1568 }
1569 
1570 int64_t DynamicReloc::computeAddend() const {
1571   if (useSymVA)
1572     return sym->getVA(addend);
1573   if (!outputSec)
1574     return addend;
1575   // See the comment in the DynamicReloc ctor.
1576   return getMipsPageAddr(outputSec->addr) + addend;
1577 }
1578 
1579 uint32_t DynamicReloc::getSymIndex(SymbolTableBaseSection *symTab) const {
1580   if (sym && !useSymVA)
1581     return symTab->getSymbolIndex(sym);
1582   return 0;
1583 }
1584 
1585 RelocationBaseSection::RelocationBaseSection(StringRef name, uint32_t type,
1586                                              int32_t dynamicTag,
1587                                              int32_t sizeDynamicTag)
1588     : SyntheticSection(SHF_ALLOC, type, config->wordsize, name),
1589       dynamicTag(dynamicTag), sizeDynamicTag(sizeDynamicTag) {}
1590 
1591 void RelocationBaseSection::addReloc(RelType dynType, InputSectionBase *isec,
1592                                      uint64_t offsetInSec, Symbol *sym) {
1593   addReloc({dynType, isec, offsetInSec, false, sym, 0});
1594 }
1595 
1596 void RelocationBaseSection::addReloc(RelType dynType,
1597                                      InputSectionBase *inputSec,
1598                                      uint64_t offsetInSec, Symbol *sym,
1599                                      int64_t addend, RelExpr expr,
1600                                      RelType type) {
1601   // Write the addends to the relocated address if required. We skip
1602   // it if the written value would be zero.
1603   if (config->writeAddends && (expr != R_ADDEND || addend != 0))
1604     inputSec->relocations.push_back({expr, type, offsetInSec, addend, sym});
1605   addReloc({dynType, inputSec, offsetInSec, expr != R_ADDEND, sym, addend});
1606 }
1607 
1608 void RelocationBaseSection::addReloc(const DynamicReloc &reloc) {
1609   if (reloc.type == target->relativeRel)
1610     ++numRelativeRelocs;
1611   relocs.push_back(reloc);
1612 }
1613 
1614 void RelocationBaseSection::finalizeContents() {
1615   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
1616 
1617   // When linking glibc statically, .rel{,a}.plt contains R_*_IRELATIVE
1618   // relocations due to IFUNC (e.g. strcpy). sh_link will be set to 0 in that
1619   // case.
1620   if (symTab && symTab->getParent())
1621     getParent()->link = symTab->getParent()->sectionIndex;
1622   else
1623     getParent()->link = 0;
1624 
1625   if (in.relaPlt == this) {
1626     getParent()->flags |= ELF::SHF_INFO_LINK;
1627     getParent()->info = in.gotPlt->getParent()->sectionIndex;
1628   }
1629   if (in.relaIplt == this) {
1630     getParent()->flags |= ELF::SHF_INFO_LINK;
1631     getParent()->info = in.igotPlt->getParent()->sectionIndex;
1632   }
1633 }
1634 
1635 RelrBaseSection::RelrBaseSection()
1636     : SyntheticSection(SHF_ALLOC,
1637                        config->useAndroidRelrTags ? SHT_ANDROID_RELR : SHT_RELR,
1638                        config->wordsize, ".relr.dyn") {}
1639 
1640 template <class ELFT>
1641 static void encodeDynamicReloc(SymbolTableBaseSection *symTab,
1642                                typename ELFT::Rela *p,
1643                                const DynamicReloc &rel) {
1644   if (config->isRela)
1645     p->r_addend = rel.computeAddend();
1646   p->r_offset = rel.getOffset();
1647   p->setSymbolAndType(rel.getSymIndex(symTab), rel.type, config->isMips64EL);
1648 }
1649 
1650 template <class ELFT>
1651 RelocationSection<ELFT>::RelocationSection(StringRef name, bool sort)
1652     : RelocationBaseSection(name, config->isRela ? SHT_RELA : SHT_REL,
1653                             config->isRela ? DT_RELA : DT_REL,
1654                             config->isRela ? DT_RELASZ : DT_RELSZ),
1655       sort(sort) {
1656   this->entsize = config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1657 }
1658 
1659 template <class ELFT> void RelocationSection<ELFT>::writeTo(uint8_t *buf) {
1660   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
1661 
1662   // Sort by (!IsRelative,SymIndex,r_offset). DT_REL[A]COUNT requires us to
1663   // place R_*_RELATIVE first. SymIndex is to improve locality, while r_offset
1664   // is to make results easier to read.
1665   if (sort)
1666     llvm::stable_sort(
1667         relocs, [&](const DynamicReloc &a, const DynamicReloc &b) {
1668           return std::make_tuple(a.type != target->relativeRel,
1669                                  a.getSymIndex(symTab), a.getOffset()) <
1670                  std::make_tuple(b.type != target->relativeRel,
1671                                  b.getSymIndex(symTab), b.getOffset());
1672         });
1673 
1674   for (const DynamicReloc &rel : relocs) {
1675     encodeDynamicReloc<ELFT>(symTab, reinterpret_cast<Elf_Rela *>(buf), rel);
1676     buf += config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1677   }
1678 }
1679 
1680 template <class ELFT>
1681 AndroidPackedRelocationSection<ELFT>::AndroidPackedRelocationSection(
1682     StringRef name)
1683     : RelocationBaseSection(
1684           name, config->isRela ? SHT_ANDROID_RELA : SHT_ANDROID_REL,
1685           config->isRela ? DT_ANDROID_RELA : DT_ANDROID_REL,
1686           config->isRela ? DT_ANDROID_RELASZ : DT_ANDROID_RELSZ) {
1687   this->entsize = 1;
1688 }
1689 
1690 template <class ELFT>
1691 bool AndroidPackedRelocationSection<ELFT>::updateAllocSize() {
1692   // This function computes the contents of an Android-format packed relocation
1693   // section.
1694   //
1695   // This format compresses relocations by using relocation groups to factor out
1696   // fields that are common between relocations and storing deltas from previous
1697   // relocations in SLEB128 format (which has a short representation for small
1698   // numbers). A good example of a relocation type with common fields is
1699   // R_*_RELATIVE, which is normally used to represent function pointers in
1700   // vtables. In the REL format, each relative relocation has the same r_info
1701   // field, and is only different from other relative relocations in terms of
1702   // the r_offset field. By sorting relocations by offset, grouping them by
1703   // r_info and representing each relocation with only the delta from the
1704   // previous offset, each 8-byte relocation can be compressed to as little as 1
1705   // byte (or less with run-length encoding). This relocation packer was able to
1706   // reduce the size of the relocation section in an Android Chromium DSO from
1707   // 2,911,184 bytes to 174,693 bytes, or 6% of the original size.
1708   //
1709   // A relocation section consists of a header containing the literal bytes
1710   // 'APS2' followed by a sequence of SLEB128-encoded integers. The first two
1711   // elements are the total number of relocations in the section and an initial
1712   // r_offset value. The remaining elements define a sequence of relocation
1713   // groups. Each relocation group starts with a header consisting of the
1714   // following elements:
1715   //
1716   // - the number of relocations in the relocation group
1717   // - flags for the relocation group
1718   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is set) the r_offset delta
1719   //   for each relocation in the group.
1720   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is set) the value of the r_info
1721   //   field for each relocation in the group.
1722   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG and
1723   //   RELOCATION_GROUPED_BY_ADDEND_FLAG are set) the r_addend delta for
1724   //   each relocation in the group.
1725   //
1726   // Following the relocation group header are descriptions of each of the
1727   // relocations in the group. They consist of the following elements:
1728   //
1729   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is not set) the r_offset
1730   //   delta for this relocation.
1731   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is not set) the value of the r_info
1732   //   field for this relocation.
1733   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG is set and
1734   //   RELOCATION_GROUPED_BY_ADDEND_FLAG is not set) the r_addend delta for
1735   //   this relocation.
1736 
1737   size_t oldSize = relocData.size();
1738 
1739   relocData = {'A', 'P', 'S', '2'};
1740   raw_svector_ostream os(relocData);
1741   auto add = [&](int64_t v) { encodeSLEB128(v, os); };
1742 
1743   // The format header includes the number of relocations and the initial
1744   // offset (we set this to zero because the first relocation group will
1745   // perform the initial adjustment).
1746   add(relocs.size());
1747   add(0);
1748 
1749   std::vector<Elf_Rela> relatives, nonRelatives;
1750 
1751   for (const DynamicReloc &rel : relocs) {
1752     Elf_Rela r;
1753     encodeDynamicReloc<ELFT>(getPartition().dynSymTab, &r, rel);
1754 
1755     if (r.getType(config->isMips64EL) == target->relativeRel)
1756       relatives.push_back(r);
1757     else
1758       nonRelatives.push_back(r);
1759   }
1760 
1761   llvm::sort(relatives, [](const Elf_Rel &a, const Elf_Rel &b) {
1762     return a.r_offset < b.r_offset;
1763   });
1764 
1765   // Try to find groups of relative relocations which are spaced one word
1766   // apart from one another. These generally correspond to vtable entries. The
1767   // format allows these groups to be encoded using a sort of run-length
1768   // encoding, but each group will cost 7 bytes in addition to the offset from
1769   // the previous group, so it is only profitable to do this for groups of
1770   // size 8 or larger.
1771   std::vector<Elf_Rela> ungroupedRelatives;
1772   std::vector<std::vector<Elf_Rela>> relativeGroups;
1773   for (auto i = relatives.begin(), e = relatives.end(); i != e;) {
1774     std::vector<Elf_Rela> group;
1775     do {
1776       group.push_back(*i++);
1777     } while (i != e && (i - 1)->r_offset + config->wordsize == i->r_offset);
1778 
1779     if (group.size() < 8)
1780       ungroupedRelatives.insert(ungroupedRelatives.end(), group.begin(),
1781                                 group.end());
1782     else
1783       relativeGroups.emplace_back(std::move(group));
1784   }
1785 
1786   // For non-relative relocations, we would like to:
1787   //   1. Have relocations with the same symbol offset to be consecutive, so
1788   //      that the runtime linker can speed-up symbol lookup by implementing an
1789   //      1-entry cache.
1790   //   2. Group relocations by r_info to reduce the size of the relocation
1791   //      section.
1792   // Since the symbol offset is the high bits in r_info, sorting by r_info
1793   // allows us to do both.
1794   //
1795   // For Rela, we also want to sort by r_addend when r_info is the same. This
1796   // enables us to group by r_addend as well.
1797   llvm::stable_sort(nonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
1798     if (a.r_info != b.r_info)
1799       return a.r_info < b.r_info;
1800     if (config->isRela)
1801       return a.r_addend < b.r_addend;
1802     return false;
1803   });
1804 
1805   // Group relocations with the same r_info. Note that each group emits a group
1806   // header and that may make the relocation section larger. It is hard to
1807   // estimate the size of a group header as the encoded size of that varies
1808   // based on r_info. However, we can approximate this trade-off by the number
1809   // of values encoded. Each group header contains 3 values, and each relocation
1810   // in a group encodes one less value, as compared to when it is not grouped.
1811   // Therefore, we only group relocations if there are 3 or more of them with
1812   // the same r_info.
1813   //
1814   // For Rela, the addend for most non-relative relocations is zero, and thus we
1815   // can usually get a smaller relocation section if we group relocations with 0
1816   // addend as well.
1817   std::vector<Elf_Rela> ungroupedNonRelatives;
1818   std::vector<std::vector<Elf_Rela>> nonRelativeGroups;
1819   for (auto i = nonRelatives.begin(), e = nonRelatives.end(); i != e;) {
1820     auto j = i + 1;
1821     while (j != e && i->r_info == j->r_info &&
1822            (!config->isRela || i->r_addend == j->r_addend))
1823       ++j;
1824     if (j - i < 3 || (config->isRela && i->r_addend != 0))
1825       ungroupedNonRelatives.insert(ungroupedNonRelatives.end(), i, j);
1826     else
1827       nonRelativeGroups.emplace_back(i, j);
1828     i = j;
1829   }
1830 
1831   // Sort ungrouped relocations by offset to minimize the encoded length.
1832   llvm::sort(ungroupedNonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
1833     return a.r_offset < b.r_offset;
1834   });
1835 
1836   unsigned hasAddendIfRela =
1837       config->isRela ? RELOCATION_GROUP_HAS_ADDEND_FLAG : 0;
1838 
1839   uint64_t offset = 0;
1840   uint64_t addend = 0;
1841 
1842   // Emit the run-length encoding for the groups of adjacent relative
1843   // relocations. Each group is represented using two groups in the packed
1844   // format. The first is used to set the current offset to the start of the
1845   // group (and also encodes the first relocation), and the second encodes the
1846   // remaining relocations.
1847   for (std::vector<Elf_Rela> &g : relativeGroups) {
1848     // The first relocation in the group.
1849     add(1);
1850     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1851         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1852     add(g[0].r_offset - offset);
1853     add(target->relativeRel);
1854     if (config->isRela) {
1855       add(g[0].r_addend - addend);
1856       addend = g[0].r_addend;
1857     }
1858 
1859     // The remaining relocations.
1860     add(g.size() - 1);
1861     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1862         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1863     add(config->wordsize);
1864     add(target->relativeRel);
1865     if (config->isRela) {
1866       for (auto i = g.begin() + 1, e = g.end(); i != e; ++i) {
1867         add(i->r_addend - addend);
1868         addend = i->r_addend;
1869       }
1870     }
1871 
1872     offset = g.back().r_offset;
1873   }
1874 
1875   // Now the ungrouped relatives.
1876   if (!ungroupedRelatives.empty()) {
1877     add(ungroupedRelatives.size());
1878     add(RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
1879     add(target->relativeRel);
1880     for (Elf_Rela &r : ungroupedRelatives) {
1881       add(r.r_offset - offset);
1882       offset = r.r_offset;
1883       if (config->isRela) {
1884         add(r.r_addend - addend);
1885         addend = r.r_addend;
1886       }
1887     }
1888   }
1889 
1890   // Grouped non-relatives.
1891   for (ArrayRef<Elf_Rela> g : nonRelativeGroups) {
1892     add(g.size());
1893     add(RELOCATION_GROUPED_BY_INFO_FLAG);
1894     add(g[0].r_info);
1895     for (const Elf_Rela &r : g) {
1896       add(r.r_offset - offset);
1897       offset = r.r_offset;
1898     }
1899     addend = 0;
1900   }
1901 
1902   // Finally the ungrouped non-relative relocations.
1903   if (!ungroupedNonRelatives.empty()) {
1904     add(ungroupedNonRelatives.size());
1905     add(hasAddendIfRela);
1906     for (Elf_Rela &r : ungroupedNonRelatives) {
1907       add(r.r_offset - offset);
1908       offset = r.r_offset;
1909       add(r.r_info);
1910       if (config->isRela) {
1911         add(r.r_addend - addend);
1912         addend = r.r_addend;
1913       }
1914     }
1915   }
1916 
1917   // Don't allow the section to shrink; otherwise the size of the section can
1918   // oscillate infinitely.
1919   if (relocData.size() < oldSize)
1920     relocData.append(oldSize - relocData.size(), 0);
1921 
1922   // Returns whether the section size changed. We need to keep recomputing both
1923   // section layout and the contents of this section until the size converges
1924   // because changing this section's size can affect section layout, which in
1925   // turn can affect the sizes of the LEB-encoded integers stored in this
1926   // section.
1927   return relocData.size() != oldSize;
1928 }
1929 
1930 template <class ELFT> RelrSection<ELFT>::RelrSection() {
1931   this->entsize = config->wordsize;
1932 }
1933 
1934 template <class ELFT> bool RelrSection<ELFT>::updateAllocSize() {
1935   // This function computes the contents of an SHT_RELR packed relocation
1936   // section.
1937   //
1938   // Proposal for adding SHT_RELR sections to generic-abi is here:
1939   //   https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
1940   //
1941   // The encoded sequence of Elf64_Relr entries in a SHT_RELR section looks
1942   // like [ AAAAAAAA BBBBBBB1 BBBBBBB1 ... AAAAAAAA BBBBBB1 ... ]
1943   //
1944   // i.e. start with an address, followed by any number of bitmaps. The address
1945   // entry encodes 1 relocation. The subsequent bitmap entries encode up to 63
1946   // relocations each, at subsequent offsets following the last address entry.
1947   //
1948   // The bitmap entries must have 1 in the least significant bit. The assumption
1949   // here is that an address cannot have 1 in lsb. Odd addresses are not
1950   // supported.
1951   //
1952   // Excluding the least significant bit in the bitmap, each non-zero bit in
1953   // the bitmap represents a relocation to be applied to a corresponding machine
1954   // word that follows the base address word. The second least significant bit
1955   // represents the machine word immediately following the initial address, and
1956   // each bit that follows represents the next word, in linear order. As such,
1957   // a single bitmap can encode up to 31 relocations in a 32-bit object, and
1958   // 63 relocations in a 64-bit object.
1959   //
1960   // This encoding has a couple of interesting properties:
1961   // 1. Looking at any entry, it is clear whether it's an address or a bitmap:
1962   //    even means address, odd means bitmap.
1963   // 2. Just a simple list of addresses is a valid encoding.
1964 
1965   size_t oldSize = relrRelocs.size();
1966   relrRelocs.clear();
1967 
1968   // Same as Config->Wordsize but faster because this is a compile-time
1969   // constant.
1970   const size_t wordsize = sizeof(typename ELFT::uint);
1971 
1972   // Number of bits to use for the relocation offsets bitmap.
1973   // Must be either 63 or 31.
1974   const size_t nBits = wordsize * 8 - 1;
1975 
1976   // Get offsets for all relative relocations and sort them.
1977   std::vector<uint64_t> offsets;
1978   for (const RelativeReloc &rel : relocs)
1979     offsets.push_back(rel.getOffset());
1980   llvm::sort(offsets);
1981 
1982   // For each leading relocation, find following ones that can be folded
1983   // as a bitmap and fold them.
1984   for (size_t i = 0, e = offsets.size(); i < e;) {
1985     // Add a leading relocation.
1986     relrRelocs.push_back(Elf_Relr(offsets[i]));
1987     uint64_t base = offsets[i] + wordsize;
1988     ++i;
1989 
1990     // Find foldable relocations to construct bitmaps.
1991     while (i < e) {
1992       uint64_t bitmap = 0;
1993 
1994       while (i < e) {
1995         uint64_t delta = offsets[i] - base;
1996 
1997         // If it is too far, it cannot be folded.
1998         if (delta >= nBits * wordsize)
1999           break;
2000 
2001         // If it is not a multiple of wordsize away, it cannot be folded.
2002         if (delta % wordsize)
2003           break;
2004 
2005         // Fold it.
2006         bitmap |= 1ULL << (delta / wordsize);
2007         ++i;
2008       }
2009 
2010       if (!bitmap)
2011         break;
2012 
2013       relrRelocs.push_back(Elf_Relr((bitmap << 1) | 1));
2014       base += nBits * wordsize;
2015     }
2016   }
2017 
2018   // Don't allow the section to shrink; otherwise the size of the section can
2019   // oscillate infinitely. Trailing 1s do not decode to more relocations.
2020   if (relrRelocs.size() < oldSize) {
2021     log(".relr.dyn needs " + Twine(oldSize - relrRelocs.size()) +
2022         " padding word(s)");
2023     relrRelocs.resize(oldSize, Elf_Relr(1));
2024   }
2025 
2026   return relrRelocs.size() != oldSize;
2027 }
2028 
2029 SymbolTableBaseSection::SymbolTableBaseSection(StringTableSection &strTabSec)
2030     : SyntheticSection(strTabSec.isDynamic() ? (uint64_t)SHF_ALLOC : 0,
2031                        strTabSec.isDynamic() ? SHT_DYNSYM : SHT_SYMTAB,
2032                        config->wordsize,
2033                        strTabSec.isDynamic() ? ".dynsym" : ".symtab"),
2034       strTabSec(strTabSec) {}
2035 
2036 // Orders symbols according to their positions in the GOT,
2037 // in compliance with MIPS ABI rules.
2038 // See "Global Offset Table" in Chapter 5 in the following document
2039 // for detailed description:
2040 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
2041 static bool sortMipsSymbols(const SymbolTableEntry &l,
2042                             const SymbolTableEntry &r) {
2043   // Sort entries related to non-local preemptible symbols by GOT indexes.
2044   // All other entries go to the beginning of a dynsym in arbitrary order.
2045   if (l.sym->isInGot() && r.sym->isInGot())
2046     return l.sym->gotIndex < r.sym->gotIndex;
2047   if (!l.sym->isInGot() && !r.sym->isInGot())
2048     return false;
2049   return !l.sym->isInGot();
2050 }
2051 
2052 void SymbolTableBaseSection::finalizeContents() {
2053   if (OutputSection *sec = strTabSec.getParent())
2054     getParent()->link = sec->sectionIndex;
2055 
2056   if (this->type != SHT_DYNSYM) {
2057     sortSymTabSymbols();
2058     return;
2059   }
2060 
2061   // If it is a .dynsym, there should be no local symbols, but we need
2062   // to do a few things for the dynamic linker.
2063 
2064   // Section's Info field has the index of the first non-local symbol.
2065   // Because the first symbol entry is a null entry, 1 is the first.
2066   getParent()->info = 1;
2067 
2068   if (getPartition().gnuHashTab) {
2069     // NB: It also sorts Symbols to meet the GNU hash table requirements.
2070     getPartition().gnuHashTab->addSymbols(symbols);
2071   } else if (config->emachine == EM_MIPS) {
2072     llvm::stable_sort(symbols, sortMipsSymbols);
2073   }
2074 
2075   // Only the main partition's dynsym indexes are stored in the symbols
2076   // themselves. All other partitions use a lookup table.
2077   if (this == mainPart->dynSymTab) {
2078     size_t i = 0;
2079     for (const SymbolTableEntry &s : symbols)
2080       s.sym->dynsymIndex = ++i;
2081   }
2082 }
2083 
2084 // The ELF spec requires that all local symbols precede global symbols, so we
2085 // sort symbol entries in this function. (For .dynsym, we don't do that because
2086 // symbols for dynamic linking are inherently all globals.)
2087 //
2088 // Aside from above, we put local symbols in groups starting with the STT_FILE
2089 // symbol. That is convenient for purpose of identifying where are local symbols
2090 // coming from.
2091 void SymbolTableBaseSection::sortSymTabSymbols() {
2092   // Move all local symbols before global symbols.
2093   auto e = std::stable_partition(
2094       symbols.begin(), symbols.end(), [](const SymbolTableEntry &s) {
2095         return s.sym->isLocal() || s.sym->computeBinding() == STB_LOCAL;
2096       });
2097   size_t numLocals = e - symbols.begin();
2098   getParent()->info = numLocals + 1;
2099 
2100   // We want to group the local symbols by file. For that we rebuild the local
2101   // part of the symbols vector. We do not need to care about the STT_FILE
2102   // symbols, they are already naturally placed first in each group. That
2103   // happens because STT_FILE is always the first symbol in the object and hence
2104   // precede all other local symbols we add for a file.
2105   MapVector<InputFile *, std::vector<SymbolTableEntry>> arr;
2106   for (const SymbolTableEntry &s : llvm::make_range(symbols.begin(), e))
2107     arr[s.sym->file].push_back(s);
2108 
2109   auto i = symbols.begin();
2110   for (std::pair<InputFile *, std::vector<SymbolTableEntry>> &p : arr)
2111     for (SymbolTableEntry &entry : p.second)
2112       *i++ = entry;
2113 }
2114 
2115 void SymbolTableBaseSection::addSymbol(Symbol *b) {
2116   // Adding a local symbol to a .dynsym is a bug.
2117   assert(this->type != SHT_DYNSYM || !b->isLocal());
2118 
2119   bool hashIt = b->isLocal();
2120   symbols.push_back({b, strTabSec.addString(b->getName(), hashIt)});
2121 }
2122 
2123 size_t SymbolTableBaseSection::getSymbolIndex(Symbol *sym) {
2124   if (this == mainPart->dynSymTab)
2125     return sym->dynsymIndex;
2126 
2127   // Initializes symbol lookup tables lazily. This is used only for -r,
2128   // -emit-relocs and dynsyms in partitions other than the main one.
2129   llvm::call_once(onceFlag, [&] {
2130     symbolIndexMap.reserve(symbols.size());
2131     size_t i = 0;
2132     for (const SymbolTableEntry &e : symbols) {
2133       if (e.sym->type == STT_SECTION)
2134         sectionIndexMap[e.sym->getOutputSection()] = ++i;
2135       else
2136         symbolIndexMap[e.sym] = ++i;
2137     }
2138   });
2139 
2140   // Section symbols are mapped based on their output sections
2141   // to maintain their semantics.
2142   if (sym->type == STT_SECTION)
2143     return sectionIndexMap.lookup(sym->getOutputSection());
2144   return symbolIndexMap.lookup(sym);
2145 }
2146 
2147 template <class ELFT>
2148 SymbolTableSection<ELFT>::SymbolTableSection(StringTableSection &strTabSec)
2149     : SymbolTableBaseSection(strTabSec) {
2150   this->entsize = sizeof(Elf_Sym);
2151 }
2152 
2153 static BssSection *getCommonSec(Symbol *sym) {
2154   if (!config->defineCommon)
2155     if (auto *d = dyn_cast<Defined>(sym))
2156       return dyn_cast_or_null<BssSection>(d->section);
2157   return nullptr;
2158 }
2159 
2160 static uint32_t getSymSectionIndex(Symbol *sym) {
2161   if (getCommonSec(sym))
2162     return SHN_COMMON;
2163   if (!isa<Defined>(sym) || sym->needsPltAddr)
2164     return SHN_UNDEF;
2165   if (const OutputSection *os = sym->getOutputSection())
2166     return os->sectionIndex >= SHN_LORESERVE ? (uint32_t)SHN_XINDEX
2167                                              : os->sectionIndex;
2168   return SHN_ABS;
2169 }
2170 
2171 // Write the internal symbol table contents to the output symbol table.
2172 template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *buf) {
2173   // The first entry is a null entry as per the ELF spec.
2174   memset(buf, 0, sizeof(Elf_Sym));
2175   buf += sizeof(Elf_Sym);
2176 
2177   auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
2178 
2179   for (SymbolTableEntry &ent : symbols) {
2180     Symbol *sym = ent.sym;
2181     bool isDefinedHere = type == SHT_SYMTAB || sym->partition == partition;
2182 
2183     // Set st_info and st_other.
2184     eSym->st_other = 0;
2185     if (sym->isLocal()) {
2186       eSym->setBindingAndType(STB_LOCAL, sym->type);
2187     } else {
2188       eSym->setBindingAndType(sym->computeBinding(), sym->type);
2189       eSym->setVisibility(sym->visibility);
2190     }
2191 
2192     // The 3 most significant bits of st_other are used by OpenPOWER ABI.
2193     // See getPPC64GlobalEntryToLocalEntryOffset() for more details.
2194     if (config->emachine == EM_PPC64)
2195       eSym->st_other |= sym->stOther & 0xe0;
2196     // The most significant bit of st_other is used by AArch64 ABI for the
2197     // variant PCS.
2198     else if (config->emachine == EM_AARCH64)
2199       eSym->st_other |= sym->stOther & STO_AARCH64_VARIANT_PCS;
2200 
2201     eSym->st_name = ent.strTabOffset;
2202     if (isDefinedHere)
2203       eSym->st_shndx = getSymSectionIndex(ent.sym);
2204     else
2205       eSym->st_shndx = 0;
2206 
2207     // Copy symbol size if it is a defined symbol. st_size is not significant
2208     // for undefined symbols, so whether copying it or not is up to us if that's
2209     // the case. We'll leave it as zero because by not setting a value, we can
2210     // get the exact same outputs for two sets of input files that differ only
2211     // in undefined symbol size in DSOs.
2212     if (eSym->st_shndx == SHN_UNDEF || !isDefinedHere)
2213       eSym->st_size = 0;
2214     else
2215       eSym->st_size = sym->getSize();
2216 
2217     // st_value is usually an address of a symbol, but that has a special
2218     // meaning for uninstantiated common symbols (--no-define-common).
2219     if (BssSection *commonSec = getCommonSec(ent.sym))
2220       eSym->st_value = commonSec->alignment;
2221     else if (isDefinedHere)
2222       eSym->st_value = sym->getVA();
2223     else
2224       eSym->st_value = 0;
2225 
2226     ++eSym;
2227   }
2228 
2229   // On MIPS we need to mark symbol which has a PLT entry and requires
2230   // pointer equality by STO_MIPS_PLT flag. That is necessary to help
2231   // dynamic linker distinguish such symbols and MIPS lazy-binding stubs.
2232   // https://sourceware.org/ml/binutils/2008-07/txt00000.txt
2233   if (config->emachine == EM_MIPS) {
2234     auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
2235 
2236     for (SymbolTableEntry &ent : symbols) {
2237       Symbol *sym = ent.sym;
2238       if (sym->isInPlt() && sym->needsPltAddr)
2239         eSym->st_other |= STO_MIPS_PLT;
2240       if (isMicroMips()) {
2241         // We already set the less-significant bit for symbols
2242         // marked by the `STO_MIPS_MICROMIPS` flag and for microMIPS PLT
2243         // records. That allows us to distinguish such symbols in
2244         // the `MIPS<ELFT>::relocate()` routine. Now we should
2245         // clear that bit for non-dynamic symbol table, so tools
2246         // like `objdump` will be able to deal with a correct
2247         // symbol position.
2248         if (sym->isDefined() &&
2249             ((sym->stOther & STO_MIPS_MICROMIPS) || sym->needsPltAddr)) {
2250           if (!strTabSec.isDynamic())
2251             eSym->st_value &= ~1;
2252           eSym->st_other |= STO_MIPS_MICROMIPS;
2253         }
2254       }
2255       if (config->relocatable)
2256         if (auto *d = dyn_cast<Defined>(sym))
2257           if (isMipsPIC<ELFT>(d))
2258             eSym->st_other |= STO_MIPS_PIC;
2259       ++eSym;
2260     }
2261   }
2262 }
2263 
2264 SymtabShndxSection::SymtabShndxSection()
2265     : SyntheticSection(0, SHT_SYMTAB_SHNDX, 4, ".symtab_shndx") {
2266   this->entsize = 4;
2267 }
2268 
2269 void SymtabShndxSection::writeTo(uint8_t *buf) {
2270   // We write an array of 32 bit values, where each value has 1:1 association
2271   // with an entry in .symtab. If the corresponding entry contains SHN_XINDEX,
2272   // we need to write actual index, otherwise, we must write SHN_UNDEF(0).
2273   buf += 4; // Ignore .symtab[0] entry.
2274   for (const SymbolTableEntry &entry : in.symTab->getSymbols()) {
2275     if (getSymSectionIndex(entry.sym) == SHN_XINDEX)
2276       write32(buf, entry.sym->getOutputSection()->sectionIndex);
2277     buf += 4;
2278   }
2279 }
2280 
2281 bool SymtabShndxSection::isNeeded() const {
2282   // SHT_SYMTAB can hold symbols with section indices values up to
2283   // SHN_LORESERVE. If we need more, we want to use extension SHT_SYMTAB_SHNDX
2284   // section. Problem is that we reveal the final section indices a bit too
2285   // late, and we do not know them here. For simplicity, we just always create
2286   // a .symtab_shndx section when the amount of output sections is huge.
2287   size_t size = 0;
2288   for (BaseCommand *base : script->sectionCommands)
2289     if (isa<OutputSection>(base))
2290       ++size;
2291   return size >= SHN_LORESERVE;
2292 }
2293 
2294 void SymtabShndxSection::finalizeContents() {
2295   getParent()->link = in.symTab->getParent()->sectionIndex;
2296 }
2297 
2298 size_t SymtabShndxSection::getSize() const {
2299   return in.symTab->getNumSymbols() * 4;
2300 }
2301 
2302 // .hash and .gnu.hash sections contain on-disk hash tables that map
2303 // symbol names to their dynamic symbol table indices. Their purpose
2304 // is to help the dynamic linker resolve symbols quickly. If ELF files
2305 // don't have them, the dynamic linker has to do linear search on all
2306 // dynamic symbols, which makes programs slower. Therefore, a .hash
2307 // section is added to a DSO by default. A .gnu.hash is added if you
2308 // give the -hash-style=gnu or -hash-style=both option.
2309 //
2310 // The Unix semantics of resolving dynamic symbols is somewhat expensive.
2311 // Each ELF file has a list of DSOs that the ELF file depends on and a
2312 // list of dynamic symbols that need to be resolved from any of the
2313 // DSOs. That means resolving all dynamic symbols takes O(m)*O(n)
2314 // where m is the number of DSOs and n is the number of dynamic
2315 // symbols. For modern large programs, both m and n are large.  So
2316 // making each step faster by using hash tables substantially
2317 // improves time to load programs.
2318 //
2319 // (Note that this is not the only way to design the shared library.
2320 // For instance, the Windows DLL takes a different approach. On
2321 // Windows, each dynamic symbol has a name of DLL from which the symbol
2322 // has to be resolved. That makes the cost of symbol resolution O(n).
2323 // This disables some hacky techniques you can use on Unix such as
2324 // LD_PRELOAD, but this is arguably better semantics than the Unix ones.)
2325 //
2326 // Due to historical reasons, we have two different hash tables, .hash
2327 // and .gnu.hash. They are for the same purpose, and .gnu.hash is a new
2328 // and better version of .hash. .hash is just an on-disk hash table, but
2329 // .gnu.hash has a bloom filter in addition to a hash table to skip
2330 // DSOs very quickly. If you are sure that your dynamic linker knows
2331 // about .gnu.hash, you want to specify -hash-style=gnu. Otherwise, a
2332 // safe bet is to specify -hash-style=both for backward compatibility.
2333 GnuHashTableSection::GnuHashTableSection()
2334     : SyntheticSection(SHF_ALLOC, SHT_GNU_HASH, config->wordsize, ".gnu.hash") {
2335 }
2336 
2337 void GnuHashTableSection::finalizeContents() {
2338   if (OutputSection *sec = getPartition().dynSymTab->getParent())
2339     getParent()->link = sec->sectionIndex;
2340 
2341   // Computes bloom filter size in word size. We want to allocate 12
2342   // bits for each symbol. It must be a power of two.
2343   if (symbols.empty()) {
2344     maskWords = 1;
2345   } else {
2346     uint64_t numBits = symbols.size() * 12;
2347     maskWords = NextPowerOf2(numBits / (config->wordsize * 8));
2348   }
2349 
2350   size = 16;                            // Header
2351   size += config->wordsize * maskWords; // Bloom filter
2352   size += nBuckets * 4;                 // Hash buckets
2353   size += symbols.size() * 4;           // Hash values
2354 }
2355 
2356 void GnuHashTableSection::writeTo(uint8_t *buf) {
2357   // The output buffer is not guaranteed to be zero-cleared because we pre-
2358   // fill executable sections with trap instructions. This is a precaution
2359   // for that case, which happens only when -no-rosegment is given.
2360   memset(buf, 0, size);
2361 
2362   // Write a header.
2363   write32(buf, nBuckets);
2364   write32(buf + 4, getPartition().dynSymTab->getNumSymbols() - symbols.size());
2365   write32(buf + 8, maskWords);
2366   write32(buf + 12, Shift2);
2367   buf += 16;
2368 
2369   // Write a bloom filter and a hash table.
2370   writeBloomFilter(buf);
2371   buf += config->wordsize * maskWords;
2372   writeHashTable(buf);
2373 }
2374 
2375 // This function writes a 2-bit bloom filter. This bloom filter alone
2376 // usually filters out 80% or more of all symbol lookups [1].
2377 // The dynamic linker uses the hash table only when a symbol is not
2378 // filtered out by a bloom filter.
2379 //
2380 // [1] Ulrich Drepper (2011), "How To Write Shared Libraries" (Ver. 4.1.2),
2381 //     p.9, https://www.akkadia.org/drepper/dsohowto.pdf
2382 void GnuHashTableSection::writeBloomFilter(uint8_t *buf) {
2383   unsigned c = config->is64 ? 64 : 32;
2384   for (const Entry &sym : symbols) {
2385     // When C = 64, we choose a word with bits [6:...] and set 1 to two bits in
2386     // the word using bits [0:5] and [26:31].
2387     size_t i = (sym.hash / c) & (maskWords - 1);
2388     uint64_t val = readUint(buf + i * config->wordsize);
2389     val |= uint64_t(1) << (sym.hash % c);
2390     val |= uint64_t(1) << ((sym.hash >> Shift2) % c);
2391     writeUint(buf + i * config->wordsize, val);
2392   }
2393 }
2394 
2395 void GnuHashTableSection::writeHashTable(uint8_t *buf) {
2396   uint32_t *buckets = reinterpret_cast<uint32_t *>(buf);
2397   uint32_t oldBucket = -1;
2398   uint32_t *values = buckets + nBuckets;
2399   for (auto i = symbols.begin(), e = symbols.end(); i != e; ++i) {
2400     // Write a hash value. It represents a sequence of chains that share the
2401     // same hash modulo value. The last element of each chain is terminated by
2402     // LSB 1.
2403     uint32_t hash = i->hash;
2404     bool isLastInChain = (i + 1) == e || i->bucketIdx != (i + 1)->bucketIdx;
2405     hash = isLastInChain ? hash | 1 : hash & ~1;
2406     write32(values++, hash);
2407 
2408     if (i->bucketIdx == oldBucket)
2409       continue;
2410     // Write a hash bucket. Hash buckets contain indices in the following hash
2411     // value table.
2412     write32(buckets + i->bucketIdx,
2413             getPartition().dynSymTab->getSymbolIndex(i->sym));
2414     oldBucket = i->bucketIdx;
2415   }
2416 }
2417 
2418 static uint32_t hashGnu(StringRef name) {
2419   uint32_t h = 5381;
2420   for (uint8_t c : name)
2421     h = (h << 5) + h + c;
2422   return h;
2423 }
2424 
2425 // Add symbols to this symbol hash table. Note that this function
2426 // destructively sort a given vector -- which is needed because
2427 // GNU-style hash table places some sorting requirements.
2428 void GnuHashTableSection::addSymbols(std::vector<SymbolTableEntry> &v) {
2429   // We cannot use 'auto' for Mid because GCC 6.1 cannot deduce
2430   // its type correctly.
2431   std::vector<SymbolTableEntry>::iterator mid =
2432       std::stable_partition(v.begin(), v.end(), [&](const SymbolTableEntry &s) {
2433         return !s.sym->isDefined() || s.sym->partition != partition;
2434       });
2435 
2436   // We chose load factor 4 for the on-disk hash table. For each hash
2437   // collision, the dynamic linker will compare a uint32_t hash value.
2438   // Since the integer comparison is quite fast, we believe we can
2439   // make the load factor even larger. 4 is just a conservative choice.
2440   //
2441   // Note that we don't want to create a zero-sized hash table because
2442   // Android loader as of 2018 doesn't like a .gnu.hash containing such
2443   // table. If that's the case, we create a hash table with one unused
2444   // dummy slot.
2445   nBuckets = std::max<size_t>((v.end() - mid) / 4, 1);
2446 
2447   if (mid == v.end())
2448     return;
2449 
2450   for (SymbolTableEntry &ent : llvm::make_range(mid, v.end())) {
2451     Symbol *b = ent.sym;
2452     uint32_t hash = hashGnu(b->getName());
2453     uint32_t bucketIdx = hash % nBuckets;
2454     symbols.push_back({b, ent.strTabOffset, hash, bucketIdx});
2455   }
2456 
2457   llvm::stable_sort(symbols, [](const Entry &l, const Entry &r) {
2458     return l.bucketIdx < r.bucketIdx;
2459   });
2460 
2461   v.erase(mid, v.end());
2462   for (const Entry &ent : symbols)
2463     v.push_back({ent.sym, ent.strTabOffset});
2464 }
2465 
2466 HashTableSection::HashTableSection()
2467     : SyntheticSection(SHF_ALLOC, SHT_HASH, 4, ".hash") {
2468   this->entsize = 4;
2469 }
2470 
2471 void HashTableSection::finalizeContents() {
2472   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
2473 
2474   if (OutputSection *sec = symTab->getParent())
2475     getParent()->link = sec->sectionIndex;
2476 
2477   unsigned numEntries = 2;               // nbucket and nchain.
2478   numEntries += symTab->getNumSymbols(); // The chain entries.
2479 
2480   // Create as many buckets as there are symbols.
2481   numEntries += symTab->getNumSymbols();
2482   this->size = numEntries * 4;
2483 }
2484 
2485 void HashTableSection::writeTo(uint8_t *buf) {
2486   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
2487 
2488   // See comment in GnuHashTableSection::writeTo.
2489   memset(buf, 0, size);
2490 
2491   unsigned numSymbols = symTab->getNumSymbols();
2492 
2493   uint32_t *p = reinterpret_cast<uint32_t *>(buf);
2494   write32(p++, numSymbols); // nbucket
2495   write32(p++, numSymbols); // nchain
2496 
2497   uint32_t *buckets = p;
2498   uint32_t *chains = p + numSymbols;
2499 
2500   for (const SymbolTableEntry &s : symTab->getSymbols()) {
2501     Symbol *sym = s.sym;
2502     StringRef name = sym->getName();
2503     unsigned i = sym->dynsymIndex;
2504     uint32_t hash = hashSysV(name) % numSymbols;
2505     chains[i] = buckets[hash];
2506     write32(buckets + hash, i);
2507   }
2508 }
2509 
2510 PltSection::PltSection()
2511     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt"),
2512       headerSize(target->pltHeaderSize) {
2513   // On PowerPC, this section contains lazy symbol resolvers.
2514   if (config->emachine == EM_PPC64) {
2515     name = ".glink";
2516     alignment = 4;
2517   }
2518 
2519   // On x86 when IBT is enabled, this section contains the second PLT (lazy
2520   // symbol resolvers).
2521   if ((config->emachine == EM_386 || config->emachine == EM_X86_64) &&
2522       (config->andFeatures & GNU_PROPERTY_X86_FEATURE_1_IBT))
2523     name = ".plt.sec";
2524 
2525   // The PLT needs to be writable on SPARC as the dynamic linker will
2526   // modify the instructions in the PLT entries.
2527   if (config->emachine == EM_SPARCV9)
2528     this->flags |= SHF_WRITE;
2529 }
2530 
2531 void PltSection::writeTo(uint8_t *buf) {
2532   // At beginning of PLT, we have code to call the dynamic
2533   // linker to resolve dynsyms at runtime. Write such code.
2534   target->writePltHeader(buf);
2535   size_t off = headerSize;
2536 
2537   for (const Symbol *sym : entries) {
2538     target->writePlt(buf + off, *sym, getVA() + off);
2539     off += target->pltEntrySize;
2540   }
2541 }
2542 
2543 void PltSection::addEntry(Symbol &sym) {
2544   sym.pltIndex = entries.size();
2545   entries.push_back(&sym);
2546 }
2547 
2548 size_t PltSection::getSize() const {
2549   return headerSize + entries.size() * target->pltEntrySize;
2550 }
2551 
2552 bool PltSection::isNeeded() const {
2553   // For -z retpolineplt, .iplt needs the .plt header.
2554   return !entries.empty() || (config->zRetpolineplt && in.iplt->isNeeded());
2555 }
2556 
2557 // Used by ARM to add mapping symbols in the PLT section, which aid
2558 // disassembly.
2559 void PltSection::addSymbols() {
2560   target->addPltHeaderSymbols(*this);
2561 
2562   size_t off = headerSize;
2563   for (size_t i = 0; i < entries.size(); ++i) {
2564     target->addPltSymbols(*this, off);
2565     off += target->pltEntrySize;
2566   }
2567 }
2568 
2569 IpltSection::IpltSection()
2570     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".iplt") {
2571   if (config->emachine == EM_PPC || config->emachine == EM_PPC64) {
2572     name = ".glink";
2573     alignment = 4;
2574   }
2575 }
2576 
2577 void IpltSection::writeTo(uint8_t *buf) {
2578   uint32_t off = 0;
2579   for (const Symbol *sym : entries) {
2580     target->writeIplt(buf + off, *sym, getVA() + off);
2581     off += target->ipltEntrySize;
2582   }
2583 }
2584 
2585 size_t IpltSection::getSize() const {
2586   return entries.size() * target->ipltEntrySize;
2587 }
2588 
2589 void IpltSection::addEntry(Symbol &sym) {
2590   sym.pltIndex = entries.size();
2591   entries.push_back(&sym);
2592 }
2593 
2594 // ARM uses mapping symbols to aid disassembly.
2595 void IpltSection::addSymbols() {
2596   size_t off = 0;
2597   for (size_t i = 0, e = entries.size(); i != e; ++i) {
2598     target->addPltSymbols(*this, off);
2599     off += target->pltEntrySize;
2600   }
2601 }
2602 
2603 PPC32GlinkSection::PPC32GlinkSection() {
2604   name = ".glink";
2605   alignment = 4;
2606 }
2607 
2608 void PPC32GlinkSection::writeTo(uint8_t *buf) {
2609   writePPC32GlinkSection(buf, entries.size());
2610 }
2611 
2612 size_t PPC32GlinkSection::getSize() const {
2613   return headerSize + entries.size() * target->pltEntrySize + footerSize;
2614 }
2615 
2616 // This is an x86-only extra PLT section and used only when a security
2617 // enhancement feature called CET is enabled. In this comment, I'll explain what
2618 // the feature is and why we have two PLT sections if CET is enabled.
2619 //
2620 // So, what does CET do? CET introduces a new restriction to indirect jump
2621 // instructions. CET works this way. Assume that CET is enabled. Then, if you
2622 // execute an indirect jump instruction, the processor verifies that a special
2623 // "landing pad" instruction (which is actually a repurposed NOP instruction and
2624 // now called "endbr32" or "endbr64") is at the jump target. If the jump target
2625 // does not start with that instruction, the processor raises an exception
2626 // instead of continuing executing code.
2627 //
2628 // If CET is enabled, the compiler emits endbr to all locations where indirect
2629 // jumps may jump to.
2630 //
2631 // This mechanism makes it extremely hard to transfer the control to a middle of
2632 // a function that is not supporsed to be a indirect jump target, preventing
2633 // certain types of attacks such as ROP or JOP.
2634 //
2635 // Note that the processors in the market as of 2019 don't actually support the
2636 // feature. Only the spec is available at the moment.
2637 //
2638 // Now, I'll explain why we have this extra PLT section for CET.
2639 //
2640 // Since you can indirectly jump to a PLT entry, we have to make PLT entries
2641 // start with endbr. The problem is there's no extra space for endbr (which is 4
2642 // bytes long), as the PLT entry is only 16 bytes long and all bytes are already
2643 // used.
2644 //
2645 // In order to deal with the issue, we split a PLT entry into two PLT entries.
2646 // Remember that each PLT entry contains code to jump to an address read from
2647 // .got.plt AND code to resolve a dynamic symbol lazily. With the 2-PLT scheme,
2648 // the former code is written to .plt.sec, and the latter code is written to
2649 // .plt.
2650 //
2651 // Lazy symbol resolution in the 2-PLT scheme works in the usual way, except
2652 // that the regular .plt is now called .plt.sec and .plt is repurposed to
2653 // contain only code for lazy symbol resolution.
2654 //
2655 // In other words, this is how the 2-PLT scheme works. Application code is
2656 // supposed to jump to .plt.sec to call an external function. Each .plt.sec
2657 // entry contains code to read an address from a corresponding .got.plt entry
2658 // and jump to that address. Addresses in .got.plt initially point to .plt, so
2659 // when an application calls an external function for the first time, the
2660 // control is transferred to a function that resolves a symbol name from
2661 // external shared object files. That function then rewrites a .got.plt entry
2662 // with a resolved address, so that the subsequent function calls directly jump
2663 // to a desired location from .plt.sec.
2664 //
2665 // There is an open question as to whether the 2-PLT scheme was desirable or
2666 // not. We could have simply extended the PLT entry size to 32-bytes to
2667 // accommodate endbr, and that scheme would have been much simpler than the
2668 // 2-PLT scheme. One reason to split PLT was, by doing that, we could keep hot
2669 // code (.plt.sec) from cold code (.plt). But as far as I know no one proved
2670 // that the optimization actually makes a difference.
2671 //
2672 // That said, the 2-PLT scheme is a part of the ABI, debuggers and other tools
2673 // depend on it, so we implement the ABI.
2674 IBTPltSection::IBTPltSection()
2675     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt") {}
2676 
2677 void IBTPltSection::writeTo(uint8_t *buf) {
2678   target->writeIBTPlt(buf, in.plt->getNumEntries());
2679 }
2680 
2681 size_t IBTPltSection::getSize() const {
2682   // 16 is the header size of .plt.
2683   return 16 + in.plt->getNumEntries() * target->pltEntrySize;
2684 }
2685 
2686 // The string hash function for .gdb_index.
2687 static uint32_t computeGdbHash(StringRef s) {
2688   uint32_t h = 0;
2689   for (uint8_t c : s)
2690     h = h * 67 + toLower(c) - 113;
2691   return h;
2692 }
2693 
2694 GdbIndexSection::GdbIndexSection()
2695     : SyntheticSection(0, SHT_PROGBITS, 1, ".gdb_index") {}
2696 
2697 // Returns the desired size of an on-disk hash table for a .gdb_index section.
2698 // There's a tradeoff between size and collision rate. We aim 75% utilization.
2699 size_t GdbIndexSection::computeSymtabSize() const {
2700   return std::max<size_t>(NextPowerOf2(symbols.size() * 4 / 3), 1024);
2701 }
2702 
2703 // Compute the output section size.
2704 void GdbIndexSection::initOutputSize() {
2705   size = sizeof(GdbIndexHeader) + computeSymtabSize() * 8;
2706 
2707   for (GdbChunk &chunk : chunks)
2708     size += chunk.compilationUnits.size() * 16 + chunk.addressAreas.size() * 20;
2709 
2710   // Add the constant pool size if exists.
2711   if (!symbols.empty()) {
2712     GdbSymbol &sym = symbols.back();
2713     size += sym.nameOff + sym.name.size() + 1;
2714   }
2715 }
2716 
2717 static std::vector<GdbIndexSection::CuEntry> readCuList(DWARFContext &dwarf) {
2718   std::vector<GdbIndexSection::CuEntry> ret;
2719   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units())
2720     ret.push_back({cu->getOffset(), cu->getLength() + 4});
2721   return ret;
2722 }
2723 
2724 static std::vector<GdbIndexSection::AddressEntry>
2725 readAddressAreas(DWARFContext &dwarf, InputSection *sec) {
2726   std::vector<GdbIndexSection::AddressEntry> ret;
2727 
2728   uint32_t cuIdx = 0;
2729   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units()) {
2730     if (Error e = cu->tryExtractDIEsIfNeeded(false)) {
2731       warn(toString(sec) + ": " + toString(std::move(e)));
2732       return {};
2733     }
2734     Expected<DWARFAddressRangesVector> ranges = cu->collectAddressRanges();
2735     if (!ranges) {
2736       warn(toString(sec) + ": " + toString(ranges.takeError()));
2737       return {};
2738     }
2739 
2740     ArrayRef<InputSectionBase *> sections = sec->file->getSections();
2741     for (DWARFAddressRange &r : *ranges) {
2742       if (r.SectionIndex == -1ULL)
2743         continue;
2744       // Range list with zero size has no effect.
2745       InputSectionBase *s = sections[r.SectionIndex];
2746       if (s && s != &InputSection::discarded && s->isLive())
2747         if (r.LowPC != r.HighPC)
2748           ret.push_back({cast<InputSection>(s), r.LowPC, r.HighPC, cuIdx});
2749     }
2750     ++cuIdx;
2751   }
2752 
2753   return ret;
2754 }
2755 
2756 template <class ELFT>
2757 static std::vector<GdbIndexSection::NameAttrEntry>
2758 readPubNamesAndTypes(const LLDDwarfObj<ELFT> &obj,
2759                      const std::vector<GdbIndexSection::CuEntry> &cus) {
2760   const LLDDWARFSection &pubNames = obj.getGnuPubnamesSection();
2761   const LLDDWARFSection &pubTypes = obj.getGnuPubtypesSection();
2762 
2763   std::vector<GdbIndexSection::NameAttrEntry> ret;
2764   for (const LLDDWARFSection *pub : {&pubNames, &pubTypes}) {
2765     DWARFDataExtractor data(obj, *pub, config->isLE, config->wordsize);
2766     DWARFDebugPubTable table;
2767     table.extract(data, /*GnuStyle=*/true, [&](Error e) {
2768       warn(toString(pub->sec) + ": " + toString(std::move(e)));
2769     });
2770     for (const DWARFDebugPubTable::Set &set : table.getData()) {
2771       // The value written into the constant pool is kind << 24 | cuIndex. As we
2772       // don't know how many compilation units precede this object to compute
2773       // cuIndex, we compute (kind << 24 | cuIndexInThisObject) instead, and add
2774       // the number of preceding compilation units later.
2775       uint32_t i = llvm::partition_point(cus,
2776                                          [&](GdbIndexSection::CuEntry cu) {
2777                                            return cu.cuOffset < set.Offset;
2778                                          }) -
2779                    cus.begin();
2780       for (const DWARFDebugPubTable::Entry &ent : set.Entries)
2781         ret.push_back({{ent.Name, computeGdbHash(ent.Name)},
2782                        (ent.Descriptor.toBits() << 24) | i});
2783     }
2784   }
2785   return ret;
2786 }
2787 
2788 // Create a list of symbols from a given list of symbol names and types
2789 // by uniquifying them by name.
2790 static std::vector<GdbIndexSection::GdbSymbol>
2791 createSymbols(ArrayRef<std::vector<GdbIndexSection::NameAttrEntry>> nameAttrs,
2792               const std::vector<GdbIndexSection::GdbChunk> &chunks) {
2793   using GdbSymbol = GdbIndexSection::GdbSymbol;
2794   using NameAttrEntry = GdbIndexSection::NameAttrEntry;
2795 
2796   // For each chunk, compute the number of compilation units preceding it.
2797   uint32_t cuIdx = 0;
2798   std::vector<uint32_t> cuIdxs(chunks.size());
2799   for (uint32_t i = 0, e = chunks.size(); i != e; ++i) {
2800     cuIdxs[i] = cuIdx;
2801     cuIdx += chunks[i].compilationUnits.size();
2802   }
2803 
2804   // The number of symbols we will handle in this function is of the order
2805   // of millions for very large executables, so we use multi-threading to
2806   // speed it up.
2807   constexpr size_t numShards = 32;
2808   size_t concurrency = PowerOf2Floor(
2809       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
2810                            .compute_thread_count(),
2811                        numShards));
2812 
2813   // A sharded map to uniquify symbols by name.
2814   std::vector<DenseMap<CachedHashStringRef, size_t>> map(numShards);
2815   size_t shift = 32 - countTrailingZeros(numShards);
2816 
2817   // Instantiate GdbSymbols while uniqufying them by name.
2818   std::vector<std::vector<GdbSymbol>> symbols(numShards);
2819   parallelForEachN(0, concurrency, [&](size_t threadId) {
2820     uint32_t i = 0;
2821     for (ArrayRef<NameAttrEntry> entries : nameAttrs) {
2822       for (const NameAttrEntry &ent : entries) {
2823         size_t shardId = ent.name.hash() >> shift;
2824         if ((shardId & (concurrency - 1)) != threadId)
2825           continue;
2826 
2827         uint32_t v = ent.cuIndexAndAttrs + cuIdxs[i];
2828         size_t &idx = map[shardId][ent.name];
2829         if (idx) {
2830           symbols[shardId][idx - 1].cuVector.push_back(v);
2831           continue;
2832         }
2833 
2834         idx = symbols[shardId].size() + 1;
2835         symbols[shardId].push_back({ent.name, {v}, 0, 0});
2836       }
2837       ++i;
2838     }
2839   });
2840 
2841   size_t numSymbols = 0;
2842   for (ArrayRef<GdbSymbol> v : symbols)
2843     numSymbols += v.size();
2844 
2845   // The return type is a flattened vector, so we'll copy each vector
2846   // contents to Ret.
2847   std::vector<GdbSymbol> ret;
2848   ret.reserve(numSymbols);
2849   for (std::vector<GdbSymbol> &vec : symbols)
2850     for (GdbSymbol &sym : vec)
2851       ret.push_back(std::move(sym));
2852 
2853   // CU vectors and symbol names are adjacent in the output file.
2854   // We can compute their offsets in the output file now.
2855   size_t off = 0;
2856   for (GdbSymbol &sym : ret) {
2857     sym.cuVectorOff = off;
2858     off += (sym.cuVector.size() + 1) * 4;
2859   }
2860   for (GdbSymbol &sym : ret) {
2861     sym.nameOff = off;
2862     off += sym.name.size() + 1;
2863   }
2864 
2865   return ret;
2866 }
2867 
2868 // Returns a newly-created .gdb_index section.
2869 template <class ELFT> GdbIndexSection *GdbIndexSection::create() {
2870   // Collect InputFiles with .debug_info. See the comment in
2871   // LLDDwarfObj<ELFT>::LLDDwarfObj. If we do lightweight parsing in the future,
2872   // note that isec->data() may uncompress the full content, which should be
2873   // parallelized.
2874   SetVector<InputFile *> files;
2875   for (InputSectionBase *s : inputSections) {
2876     InputSection *isec = dyn_cast<InputSection>(s);
2877     if (!isec)
2878       continue;
2879     // .debug_gnu_pub{names,types} are useless in executables.
2880     // They are present in input object files solely for creating
2881     // a .gdb_index. So we can remove them from the output.
2882     if (s->name == ".debug_gnu_pubnames" || s->name == ".debug_gnu_pubtypes")
2883       s->markDead();
2884     else if (isec->name == ".debug_info")
2885       files.insert(isec->file);
2886   }
2887   // Drop .rel[a].debug_gnu_pub{names,types} for --emit-relocs.
2888   llvm::erase_if(inputSections, [](InputSectionBase *s) {
2889     if (auto *isec = dyn_cast<InputSection>(s))
2890       if (InputSectionBase *rel = isec->getRelocatedSection())
2891         return !rel->isLive();
2892     return !s->isLive();
2893   });
2894 
2895   std::vector<GdbChunk> chunks(files.size());
2896   std::vector<std::vector<NameAttrEntry>> nameAttrs(files.size());
2897 
2898   parallelForEachN(0, files.size(), [&](size_t i) {
2899     // To keep memory usage low, we don't want to keep cached DWARFContext, so
2900     // avoid getDwarf() here.
2901     ObjFile<ELFT> *file = cast<ObjFile<ELFT>>(files[i]);
2902     DWARFContext dwarf(std::make_unique<LLDDwarfObj<ELFT>>(file));
2903     auto &dobj = static_cast<const LLDDwarfObj<ELFT> &>(dwarf.getDWARFObj());
2904 
2905     // If the are multiple compile units .debug_info (very rare ld -r --unique),
2906     // this only picks the last one. Other address ranges are lost.
2907     chunks[i].sec = dobj.getInfoSection();
2908     chunks[i].compilationUnits = readCuList(dwarf);
2909     chunks[i].addressAreas = readAddressAreas(dwarf, chunks[i].sec);
2910     nameAttrs[i] = readPubNamesAndTypes<ELFT>(dobj, chunks[i].compilationUnits);
2911   });
2912 
2913   auto *ret = make<GdbIndexSection>();
2914   ret->chunks = std::move(chunks);
2915   ret->symbols = createSymbols(nameAttrs, ret->chunks);
2916   ret->initOutputSize();
2917   return ret;
2918 }
2919 
2920 void GdbIndexSection::writeTo(uint8_t *buf) {
2921   // Write the header.
2922   auto *hdr = reinterpret_cast<GdbIndexHeader *>(buf);
2923   uint8_t *start = buf;
2924   hdr->version = 7;
2925   buf += sizeof(*hdr);
2926 
2927   // Write the CU list.
2928   hdr->cuListOff = buf - start;
2929   for (GdbChunk &chunk : chunks) {
2930     for (CuEntry &cu : chunk.compilationUnits) {
2931       write64le(buf, chunk.sec->outSecOff + cu.cuOffset);
2932       write64le(buf + 8, cu.cuLength);
2933       buf += 16;
2934     }
2935   }
2936 
2937   // Write the address area.
2938   hdr->cuTypesOff = buf - start;
2939   hdr->addressAreaOff = buf - start;
2940   uint32_t cuOff = 0;
2941   for (GdbChunk &chunk : chunks) {
2942     for (AddressEntry &e : chunk.addressAreas) {
2943       // In the case of ICF there may be duplicate address range entries.
2944       const uint64_t baseAddr = e.section->repl->getVA(0);
2945       write64le(buf, baseAddr + e.lowAddress);
2946       write64le(buf + 8, baseAddr + e.highAddress);
2947       write32le(buf + 16, e.cuIndex + cuOff);
2948       buf += 20;
2949     }
2950     cuOff += chunk.compilationUnits.size();
2951   }
2952 
2953   // Write the on-disk open-addressing hash table containing symbols.
2954   hdr->symtabOff = buf - start;
2955   size_t symtabSize = computeSymtabSize();
2956   uint32_t mask = symtabSize - 1;
2957 
2958   for (GdbSymbol &sym : symbols) {
2959     uint32_t h = sym.name.hash();
2960     uint32_t i = h & mask;
2961     uint32_t step = ((h * 17) & mask) | 1;
2962 
2963     while (read32le(buf + i * 8))
2964       i = (i + step) & mask;
2965 
2966     write32le(buf + i * 8, sym.nameOff);
2967     write32le(buf + i * 8 + 4, sym.cuVectorOff);
2968   }
2969 
2970   buf += symtabSize * 8;
2971 
2972   // Write the string pool.
2973   hdr->constantPoolOff = buf - start;
2974   parallelForEach(symbols, [&](GdbSymbol &sym) {
2975     memcpy(buf + sym.nameOff, sym.name.data(), sym.name.size());
2976   });
2977 
2978   // Write the CU vectors.
2979   for (GdbSymbol &sym : symbols) {
2980     write32le(buf, sym.cuVector.size());
2981     buf += 4;
2982     for (uint32_t val : sym.cuVector) {
2983       write32le(buf, val);
2984       buf += 4;
2985     }
2986   }
2987 }
2988 
2989 bool GdbIndexSection::isNeeded() const { return !chunks.empty(); }
2990 
2991 EhFrameHeader::EhFrameHeader()
2992     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".eh_frame_hdr") {}
2993 
2994 void EhFrameHeader::writeTo(uint8_t *buf) {
2995   // Unlike most sections, the EhFrameHeader section is written while writing
2996   // another section, namely EhFrameSection, which calls the write() function
2997   // below from its writeTo() function. This is necessary because the contents
2998   // of EhFrameHeader depend on the relocated contents of EhFrameSection and we
2999   // don't know which order the sections will be written in.
3000 }
3001 
3002 // .eh_frame_hdr contains a binary search table of pointers to FDEs.
3003 // Each entry of the search table consists of two values,
3004 // the starting PC from where FDEs covers, and the FDE's address.
3005 // It is sorted by PC.
3006 void EhFrameHeader::write() {
3007   uint8_t *buf = Out::bufferStart + getParent()->offset + outSecOff;
3008   using FdeData = EhFrameSection::FdeData;
3009 
3010   std::vector<FdeData> fdes = getPartition().ehFrame->getFdeData();
3011 
3012   buf[0] = 1;
3013   buf[1] = DW_EH_PE_pcrel | DW_EH_PE_sdata4;
3014   buf[2] = DW_EH_PE_udata4;
3015   buf[3] = DW_EH_PE_datarel | DW_EH_PE_sdata4;
3016   write32(buf + 4,
3017           getPartition().ehFrame->getParent()->addr - this->getVA() - 4);
3018   write32(buf + 8, fdes.size());
3019   buf += 12;
3020 
3021   for (FdeData &fde : fdes) {
3022     write32(buf, fde.pcRel);
3023     write32(buf + 4, fde.fdeVARel);
3024     buf += 8;
3025   }
3026 }
3027 
3028 size_t EhFrameHeader::getSize() const {
3029   // .eh_frame_hdr has a 12 bytes header followed by an array of FDEs.
3030   return 12 + getPartition().ehFrame->numFdes * 8;
3031 }
3032 
3033 bool EhFrameHeader::isNeeded() const {
3034   return isLive() && getPartition().ehFrame->isNeeded();
3035 }
3036 
3037 VersionDefinitionSection::VersionDefinitionSection()
3038     : SyntheticSection(SHF_ALLOC, SHT_GNU_verdef, sizeof(uint32_t),
3039                        ".gnu.version_d") {}
3040 
3041 StringRef VersionDefinitionSection::getFileDefName() {
3042   if (!getPartition().name.empty())
3043     return getPartition().name;
3044   if (!config->soName.empty())
3045     return config->soName;
3046   return config->outputFile;
3047 }
3048 
3049 void VersionDefinitionSection::finalizeContents() {
3050   fileDefNameOff = getPartition().dynStrTab->addString(getFileDefName());
3051   for (const VersionDefinition &v : namedVersionDefs())
3052     verDefNameOffs.push_back(getPartition().dynStrTab->addString(v.name));
3053 
3054   if (OutputSection *sec = getPartition().dynStrTab->getParent())
3055     getParent()->link = sec->sectionIndex;
3056 
3057   // sh_info should be set to the number of definitions. This fact is missed in
3058   // documentation, but confirmed by binutils community:
3059   // https://sourceware.org/ml/binutils/2014-11/msg00355.html
3060   getParent()->info = getVerDefNum();
3061 }
3062 
3063 void VersionDefinitionSection::writeOne(uint8_t *buf, uint32_t index,
3064                                         StringRef name, size_t nameOff) {
3065   uint16_t flags = index == 1 ? VER_FLG_BASE : 0;
3066 
3067   // Write a verdef.
3068   write16(buf, 1);                  // vd_version
3069   write16(buf + 2, flags);          // vd_flags
3070   write16(buf + 4, index);          // vd_ndx
3071   write16(buf + 6, 1);              // vd_cnt
3072   write32(buf + 8, hashSysV(name)); // vd_hash
3073   write32(buf + 12, 20);            // vd_aux
3074   write32(buf + 16, 28);            // vd_next
3075 
3076   // Write a veraux.
3077   write32(buf + 20, nameOff); // vda_name
3078   write32(buf + 24, 0);       // vda_next
3079 }
3080 
3081 void VersionDefinitionSection::writeTo(uint8_t *buf) {
3082   writeOne(buf, 1, getFileDefName(), fileDefNameOff);
3083 
3084   auto nameOffIt = verDefNameOffs.begin();
3085   for (const VersionDefinition &v : namedVersionDefs()) {
3086     buf += EntrySize;
3087     writeOne(buf, v.id, v.name, *nameOffIt++);
3088   }
3089 
3090   // Need to terminate the last version definition.
3091   write32(buf + 16, 0); // vd_next
3092 }
3093 
3094 size_t VersionDefinitionSection::getSize() const {
3095   return EntrySize * getVerDefNum();
3096 }
3097 
3098 // .gnu.version is a table where each entry is 2 byte long.
3099 VersionTableSection::VersionTableSection()
3100     : SyntheticSection(SHF_ALLOC, SHT_GNU_versym, sizeof(uint16_t),
3101                        ".gnu.version") {
3102   this->entsize = 2;
3103 }
3104 
3105 void VersionTableSection::finalizeContents() {
3106   // At the moment of june 2016 GNU docs does not mention that sh_link field
3107   // should be set, but Sun docs do. Also readelf relies on this field.
3108   getParent()->link = getPartition().dynSymTab->getParent()->sectionIndex;
3109 }
3110 
3111 size_t VersionTableSection::getSize() const {
3112   return (getPartition().dynSymTab->getSymbols().size() + 1) * 2;
3113 }
3114 
3115 void VersionTableSection::writeTo(uint8_t *buf) {
3116   buf += 2;
3117   for (const SymbolTableEntry &s : getPartition().dynSymTab->getSymbols()) {
3118     // Use the original versionId for an unfetched lazy symbol (undefined weak),
3119     // which must be VER_NDX_GLOBAL (an undefined versioned symbol is an error).
3120     write16(buf, s.sym->isLazy() ? static_cast<uint16_t>(VER_NDX_GLOBAL)
3121                                  : s.sym->versionId);
3122     buf += 2;
3123   }
3124 }
3125 
3126 bool VersionTableSection::isNeeded() const {
3127   return isLive() &&
3128          (getPartition().verDef || getPartition().verNeed->isNeeded());
3129 }
3130 
3131 void elf::addVerneed(Symbol *ss) {
3132   auto &file = cast<SharedFile>(*ss->file);
3133   if (ss->verdefIndex == VER_NDX_GLOBAL) {
3134     ss->versionId = VER_NDX_GLOBAL;
3135     return;
3136   }
3137 
3138   if (file.vernauxs.empty())
3139     file.vernauxs.resize(file.verdefs.size());
3140 
3141   // Select a version identifier for the vernaux data structure, if we haven't
3142   // already allocated one. The verdef identifiers cover the range
3143   // [1..getVerDefNum()]; this causes the vernaux identifiers to start from
3144   // getVerDefNum()+1.
3145   if (file.vernauxs[ss->verdefIndex] == 0)
3146     file.vernauxs[ss->verdefIndex] = ++SharedFile::vernauxNum + getVerDefNum();
3147 
3148   ss->versionId = file.vernauxs[ss->verdefIndex];
3149 }
3150 
3151 template <class ELFT>
3152 VersionNeedSection<ELFT>::VersionNeedSection()
3153     : SyntheticSection(SHF_ALLOC, SHT_GNU_verneed, sizeof(uint32_t),
3154                        ".gnu.version_r") {}
3155 
3156 template <class ELFT> void VersionNeedSection<ELFT>::finalizeContents() {
3157   for (SharedFile *f : sharedFiles) {
3158     if (f->vernauxs.empty())
3159       continue;
3160     verneeds.emplace_back();
3161     Verneed &vn = verneeds.back();
3162     vn.nameStrTab = getPartition().dynStrTab->addString(f->soName);
3163     for (unsigned i = 0; i != f->vernauxs.size(); ++i) {
3164       if (f->vernauxs[i] == 0)
3165         continue;
3166       auto *verdef =
3167           reinterpret_cast<const typename ELFT::Verdef *>(f->verdefs[i]);
3168       vn.vernauxs.push_back(
3169           {verdef->vd_hash, f->vernauxs[i],
3170            getPartition().dynStrTab->addString(f->getStringTable().data() +
3171                                                verdef->getAux()->vda_name)});
3172     }
3173   }
3174 
3175   if (OutputSection *sec = getPartition().dynStrTab->getParent())
3176     getParent()->link = sec->sectionIndex;
3177   getParent()->info = verneeds.size();
3178 }
3179 
3180 template <class ELFT> void VersionNeedSection<ELFT>::writeTo(uint8_t *buf) {
3181   // The Elf_Verneeds need to appear first, followed by the Elf_Vernauxs.
3182   auto *verneed = reinterpret_cast<Elf_Verneed *>(buf);
3183   auto *vernaux = reinterpret_cast<Elf_Vernaux *>(verneed + verneeds.size());
3184 
3185   for (auto &vn : verneeds) {
3186     // Create an Elf_Verneed for this DSO.
3187     verneed->vn_version = 1;
3188     verneed->vn_cnt = vn.vernauxs.size();
3189     verneed->vn_file = vn.nameStrTab;
3190     verneed->vn_aux =
3191         reinterpret_cast<char *>(vernaux) - reinterpret_cast<char *>(verneed);
3192     verneed->vn_next = sizeof(Elf_Verneed);
3193     ++verneed;
3194 
3195     // Create the Elf_Vernauxs for this Elf_Verneed.
3196     for (auto &vna : vn.vernauxs) {
3197       vernaux->vna_hash = vna.hash;
3198       vernaux->vna_flags = 0;
3199       vernaux->vna_other = vna.verneedIndex;
3200       vernaux->vna_name = vna.nameStrTab;
3201       vernaux->vna_next = sizeof(Elf_Vernaux);
3202       ++vernaux;
3203     }
3204 
3205     vernaux[-1].vna_next = 0;
3206   }
3207   verneed[-1].vn_next = 0;
3208 }
3209 
3210 template <class ELFT> size_t VersionNeedSection<ELFT>::getSize() const {
3211   return verneeds.size() * sizeof(Elf_Verneed) +
3212          SharedFile::vernauxNum * sizeof(Elf_Vernaux);
3213 }
3214 
3215 template <class ELFT> bool VersionNeedSection<ELFT>::isNeeded() const {
3216   return isLive() && SharedFile::vernauxNum != 0;
3217 }
3218 
3219 void MergeSyntheticSection::addSection(MergeInputSection *ms) {
3220   ms->parent = this;
3221   sections.push_back(ms);
3222   assert(alignment == ms->alignment || !(ms->flags & SHF_STRINGS));
3223   alignment = std::max(alignment, ms->alignment);
3224 }
3225 
3226 MergeTailSection::MergeTailSection(StringRef name, uint32_t type,
3227                                    uint64_t flags, uint32_t alignment)
3228     : MergeSyntheticSection(name, type, flags, alignment),
3229       builder(StringTableBuilder::RAW, alignment) {}
3230 
3231 size_t MergeTailSection::getSize() const { return builder.getSize(); }
3232 
3233 void MergeTailSection::writeTo(uint8_t *buf) { builder.write(buf); }
3234 
3235 void MergeTailSection::finalizeContents() {
3236   // Add all string pieces to the string table builder to create section
3237   // contents.
3238   for (MergeInputSection *sec : sections)
3239     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3240       if (sec->pieces[i].live)
3241         builder.add(sec->getData(i));
3242 
3243   // Fix the string table content. After this, the contents will never change.
3244   builder.finalize();
3245 
3246   // finalize() fixed tail-optimized strings, so we can now get
3247   // offsets of strings. Get an offset for each string and save it
3248   // to a corresponding SectionPiece for easy access.
3249   for (MergeInputSection *sec : sections)
3250     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3251       if (sec->pieces[i].live)
3252         sec->pieces[i].outputOff = builder.getOffset(sec->getData(i));
3253 }
3254 
3255 void MergeNoTailSection::writeTo(uint8_t *buf) {
3256   for (size_t i = 0; i < numShards; ++i)
3257     shards[i].write(buf + shardOffsets[i]);
3258 }
3259 
3260 // This function is very hot (i.e. it can take several seconds to finish)
3261 // because sometimes the number of inputs is in an order of magnitude of
3262 // millions. So, we use multi-threading.
3263 //
3264 // For any strings S and T, we know S is not mergeable with T if S's hash
3265 // value is different from T's. If that's the case, we can safely put S and
3266 // T into different string builders without worrying about merge misses.
3267 // We do it in parallel.
3268 void MergeNoTailSection::finalizeContents() {
3269   // Initializes string table builders.
3270   for (size_t i = 0; i < numShards; ++i)
3271     shards.emplace_back(StringTableBuilder::RAW, alignment);
3272 
3273   // Concurrency level. Must be a power of 2 to avoid expensive modulo
3274   // operations in the following tight loop.
3275   size_t concurrency = PowerOf2Floor(
3276       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
3277                            .compute_thread_count(),
3278                        numShards));
3279 
3280   // Add section pieces to the builders.
3281   parallelForEachN(0, concurrency, [&](size_t threadId) {
3282     for (MergeInputSection *sec : sections) {
3283       for (size_t i = 0, e = sec->pieces.size(); i != e; ++i) {
3284         if (!sec->pieces[i].live)
3285           continue;
3286         size_t shardId = getShardId(sec->pieces[i].hash);
3287         if ((shardId & (concurrency - 1)) == threadId)
3288           sec->pieces[i].outputOff = shards[shardId].add(sec->getData(i));
3289       }
3290     }
3291   });
3292 
3293   // Compute an in-section offset for each shard.
3294   size_t off = 0;
3295   for (size_t i = 0; i < numShards; ++i) {
3296     shards[i].finalizeInOrder();
3297     if (shards[i].getSize() > 0)
3298       off = alignTo(off, alignment);
3299     shardOffsets[i] = off;
3300     off += shards[i].getSize();
3301   }
3302   size = off;
3303 
3304   // So far, section pieces have offsets from beginning of shards, but
3305   // we want offsets from beginning of the whole section. Fix them.
3306   parallelForEach(sections, [&](MergeInputSection *sec) {
3307     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
3308       if (sec->pieces[i].live)
3309         sec->pieces[i].outputOff +=
3310             shardOffsets[getShardId(sec->pieces[i].hash)];
3311   });
3312 }
3313 
3314 MergeSyntheticSection *elf::createMergeSynthetic(StringRef name, uint32_t type,
3315                                                  uint64_t flags,
3316                                                  uint32_t alignment) {
3317   bool shouldTailMerge = (flags & SHF_STRINGS) && config->optimize >= 2;
3318   if (shouldTailMerge)
3319     return make<MergeTailSection>(name, type, flags, alignment);
3320   return make<MergeNoTailSection>(name, type, flags, alignment);
3321 }
3322 
3323 template <class ELFT> void elf::splitSections() {
3324   llvm::TimeTraceScope timeScope("Split sections");
3325   // splitIntoPieces needs to be called on each MergeInputSection
3326   // before calling finalizeContents().
3327   parallelForEach(inputSections, [](InputSectionBase *sec) {
3328     if (auto *s = dyn_cast<MergeInputSection>(sec))
3329       s->splitIntoPieces();
3330     else if (auto *eh = dyn_cast<EhInputSection>(sec))
3331       eh->split<ELFT>();
3332   });
3333 }
3334 
3335 MipsRldMapSection::MipsRldMapSection()
3336     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
3337                        ".rld_map") {}
3338 
3339 ARMExidxSyntheticSection::ARMExidxSyntheticSection()
3340     : SyntheticSection(SHF_ALLOC | SHF_LINK_ORDER, SHT_ARM_EXIDX,
3341                        config->wordsize, ".ARM.exidx") {}
3342 
3343 static InputSection *findExidxSection(InputSection *isec) {
3344   for (InputSection *d : isec->dependentSections)
3345     if (d->type == SHT_ARM_EXIDX && d->isLive())
3346       return d;
3347   return nullptr;
3348 }
3349 
3350 static bool isValidExidxSectionDep(InputSection *isec) {
3351   return (isec->flags & SHF_ALLOC) && (isec->flags & SHF_EXECINSTR) &&
3352          isec->getSize() > 0;
3353 }
3354 
3355 bool ARMExidxSyntheticSection::addSection(InputSection *isec) {
3356   if (isec->type == SHT_ARM_EXIDX) {
3357     if (InputSection *dep = isec->getLinkOrderDep())
3358       if (isValidExidxSectionDep(dep)) {
3359         exidxSections.push_back(isec);
3360         // Every exidxSection is 8 bytes, we need an estimate of
3361         // size before assignAddresses can be called. Final size
3362         // will only be known after finalize is called.
3363         size += 8;
3364       }
3365     return true;
3366   }
3367 
3368   if (isValidExidxSectionDep(isec)) {
3369     executableSections.push_back(isec);
3370     return false;
3371   }
3372 
3373   // FIXME: we do not output a relocation section when --emit-relocs is used
3374   // as we do not have relocation sections for linker generated table entries
3375   // and we would have to erase at a late stage relocations from merged entries.
3376   // Given that exception tables are already position independent and a binary
3377   // analyzer could derive the relocations we choose to erase the relocations.
3378   if (config->emitRelocs && isec->type == SHT_REL)
3379     if (InputSectionBase *ex = isec->getRelocatedSection())
3380       if (isa<InputSection>(ex) && ex->type == SHT_ARM_EXIDX)
3381         return true;
3382 
3383   return false;
3384 }
3385 
3386 // References to .ARM.Extab Sections have bit 31 clear and are not the
3387 // special EXIDX_CANTUNWIND bit-pattern.
3388 static bool isExtabRef(uint32_t unwind) {
3389   return (unwind & 0x80000000) == 0 && unwind != 0x1;
3390 }
3391 
3392 // Return true if the .ARM.exidx section Cur can be merged into the .ARM.exidx
3393 // section Prev, where Cur follows Prev in the table. This can be done if the
3394 // unwinding instructions in Cur are identical to Prev. Linker generated
3395 // EXIDX_CANTUNWIND entries are represented by nullptr as they do not have an
3396 // InputSection.
3397 static bool isDuplicateArmExidxSec(InputSection *prev, InputSection *cur) {
3398 
3399   struct ExidxEntry {
3400     ulittle32_t fn;
3401     ulittle32_t unwind;
3402   };
3403   // Get the last table Entry from the previous .ARM.exidx section. If Prev is
3404   // nullptr then it will be a synthesized EXIDX_CANTUNWIND entry.
3405   ExidxEntry prevEntry = {ulittle32_t(0), ulittle32_t(1)};
3406   if (prev)
3407     prevEntry = prev->getDataAs<ExidxEntry>().back();
3408   if (isExtabRef(prevEntry.unwind))
3409     return false;
3410 
3411   // We consider the unwind instructions of an .ARM.exidx table entry
3412   // a duplicate if the previous unwind instructions if:
3413   // - Both are the special EXIDX_CANTUNWIND.
3414   // - Both are the same inline unwind instructions.
3415   // We do not attempt to follow and check links into .ARM.extab tables as
3416   // consecutive identical entries are rare and the effort to check that they
3417   // are identical is high.
3418 
3419   // If Cur is nullptr then this is synthesized EXIDX_CANTUNWIND entry.
3420   if (cur == nullptr)
3421     return prevEntry.unwind == 1;
3422 
3423   for (const ExidxEntry entry : cur->getDataAs<ExidxEntry>())
3424     if (isExtabRef(entry.unwind) || entry.unwind != prevEntry.unwind)
3425       return false;
3426 
3427   // All table entries in this .ARM.exidx Section can be merged into the
3428   // previous Section.
3429   return true;
3430 }
3431 
3432 // The .ARM.exidx table must be sorted in ascending order of the address of the
3433 // functions the table describes. Optionally duplicate adjacent table entries
3434 // can be removed. At the end of the function the executableSections must be
3435 // sorted in ascending order of address, Sentinel is set to the InputSection
3436 // with the highest address and any InputSections that have mergeable
3437 // .ARM.exidx table entries are removed from it.
3438 void ARMExidxSyntheticSection::finalizeContents() {
3439   // The executableSections and exidxSections that we use to derive the final
3440   // contents of this SyntheticSection are populated before
3441   // processSectionCommands() and ICF. A /DISCARD/ entry in SECTIONS command or
3442   // ICF may remove executable InputSections and their dependent .ARM.exidx
3443   // section that we recorded earlier.
3444   auto isDiscarded = [](const InputSection *isec) { return !isec->isLive(); };
3445   llvm::erase_if(exidxSections, isDiscarded);
3446   // We need to remove discarded InputSections and InputSections without
3447   // .ARM.exidx sections that if we generated the .ARM.exidx it would be out
3448   // of range.
3449   auto isDiscardedOrOutOfRange = [this](InputSection *isec) {
3450     if (!isec->isLive())
3451       return true;
3452     if (findExidxSection(isec))
3453       return false;
3454     int64_t off = static_cast<int64_t>(isec->getVA() - getVA());
3455     return off != llvm::SignExtend64(off, 31);
3456   };
3457   llvm::erase_if(executableSections, isDiscardedOrOutOfRange);
3458 
3459   // Sort the executable sections that may or may not have associated
3460   // .ARM.exidx sections by order of ascending address. This requires the
3461   // relative positions of InputSections and OutputSections to be known.
3462   auto compareByFilePosition = [](const InputSection *a,
3463                                   const InputSection *b) {
3464     OutputSection *aOut = a->getParent();
3465     OutputSection *bOut = b->getParent();
3466 
3467     if (aOut != bOut)
3468       return aOut->addr < bOut->addr;
3469     return a->outSecOff < b->outSecOff;
3470   };
3471   llvm::stable_sort(executableSections, compareByFilePosition);
3472   sentinel = executableSections.back();
3473   // Optionally merge adjacent duplicate entries.
3474   if (config->mergeArmExidx) {
3475     std::vector<InputSection *> selectedSections;
3476     selectedSections.reserve(executableSections.size());
3477     selectedSections.push_back(executableSections[0]);
3478     size_t prev = 0;
3479     for (size_t i = 1; i < executableSections.size(); ++i) {
3480       InputSection *ex1 = findExidxSection(executableSections[prev]);
3481       InputSection *ex2 = findExidxSection(executableSections[i]);
3482       if (!isDuplicateArmExidxSec(ex1, ex2)) {
3483         selectedSections.push_back(executableSections[i]);
3484         prev = i;
3485       }
3486     }
3487     executableSections = std::move(selectedSections);
3488   }
3489 
3490   size_t offset = 0;
3491   size = 0;
3492   for (InputSection *isec : executableSections) {
3493     if (InputSection *d = findExidxSection(isec)) {
3494       d->outSecOff = offset;
3495       d->parent = getParent();
3496       offset += d->getSize();
3497     } else {
3498       offset += 8;
3499     }
3500   }
3501   // Size includes Sentinel.
3502   size = offset + 8;
3503 }
3504 
3505 InputSection *ARMExidxSyntheticSection::getLinkOrderDep() const {
3506   return executableSections.front();
3507 }
3508 
3509 // To write the .ARM.exidx table from the ExecutableSections we have three cases
3510 // 1.) The InputSection has a .ARM.exidx InputSection in its dependent sections.
3511 //     We write the .ARM.exidx section contents and apply its relocations.
3512 // 2.) The InputSection does not have a dependent .ARM.exidx InputSection. We
3513 //     must write the contents of an EXIDX_CANTUNWIND directly. We use the
3514 //     start of the InputSection as the purpose of the linker generated
3515 //     section is to terminate the address range of the previous entry.
3516 // 3.) A trailing EXIDX_CANTUNWIND sentinel section is required at the end of
3517 //     the table to terminate the address range of the final entry.
3518 void ARMExidxSyntheticSection::writeTo(uint8_t *buf) {
3519 
3520   const uint8_t cantUnwindData[8] = {0, 0, 0, 0,  // PREL31 to target
3521                                      1, 0, 0, 0}; // EXIDX_CANTUNWIND
3522 
3523   uint64_t offset = 0;
3524   for (InputSection *isec : executableSections) {
3525     assert(isec->getParent() != nullptr);
3526     if (InputSection *d = findExidxSection(isec)) {
3527       memcpy(buf + offset, d->data().data(), d->data().size());
3528       d->relocateAlloc(buf + d->outSecOff, buf + d->outSecOff + d->getSize());
3529       offset += d->getSize();
3530     } else {
3531       // A Linker generated CANTUNWIND section.
3532       memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
3533       uint64_t s = isec->getVA();
3534       uint64_t p = getVA() + offset;
3535       target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
3536       offset += 8;
3537     }
3538   }
3539   // Write Sentinel.
3540   memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
3541   uint64_t s = sentinel->getVA(sentinel->getSize());
3542   uint64_t p = getVA() + offset;
3543   target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
3544   assert(size == offset + 8);
3545 }
3546 
3547 bool ARMExidxSyntheticSection::isNeeded() const {
3548   return llvm::find_if(exidxSections, [](InputSection *isec) {
3549            return isec->isLive();
3550          }) != exidxSections.end();
3551 }
3552 
3553 bool ARMExidxSyntheticSection::classof(const SectionBase *d) {
3554   return d->kind() == InputSectionBase::Synthetic && d->type == SHT_ARM_EXIDX;
3555 }
3556 
3557 ThunkSection::ThunkSection(OutputSection *os, uint64_t off)
3558     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS,
3559                        config->emachine == EM_PPC64 ? 16 : 4, ".text.thunk") {
3560   this->parent = os;
3561   this->outSecOff = off;
3562 }
3563 
3564 size_t ThunkSection::getSize() const {
3565   if (roundUpSizeForErrata)
3566     return alignTo(size, 4096);
3567   return size;
3568 }
3569 
3570 void ThunkSection::addThunk(Thunk *t) {
3571   thunks.push_back(t);
3572   t->addSymbols(*this);
3573 }
3574 
3575 void ThunkSection::writeTo(uint8_t *buf) {
3576   for (Thunk *t : thunks)
3577     t->writeTo(buf + t->offset);
3578 }
3579 
3580 InputSection *ThunkSection::getTargetInputSection() const {
3581   if (thunks.empty())
3582     return nullptr;
3583   const Thunk *t = thunks.front();
3584   return t->getTargetInputSection();
3585 }
3586 
3587 bool ThunkSection::assignOffsets() {
3588   uint64_t off = 0;
3589   for (Thunk *t : thunks) {
3590     off = alignTo(off, t->alignment);
3591     t->setOffset(off);
3592     uint32_t size = t->size();
3593     t->getThunkTargetSym()->size = size;
3594     off += size;
3595   }
3596   bool changed = off != size;
3597   size = off;
3598   return changed;
3599 }
3600 
3601 PPC32Got2Section::PPC32Got2Section()
3602     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, 4, ".got2") {}
3603 
3604 bool PPC32Got2Section::isNeeded() const {
3605   // See the comment below. This is not needed if there is no other
3606   // InputSection.
3607   for (BaseCommand *base : getParent()->sectionCommands)
3608     if (auto *isd = dyn_cast<InputSectionDescription>(base))
3609       for (InputSection *isec : isd->sections)
3610         if (isec != this)
3611           return true;
3612   return false;
3613 }
3614 
3615 void PPC32Got2Section::finalizeContents() {
3616   // PPC32 may create multiple GOT sections for -fPIC/-fPIE, one per file in
3617   // .got2 . This function computes outSecOff of each .got2 to be used in
3618   // PPC32PltCallStub::writeTo(). The purpose of this empty synthetic section is
3619   // to collect input sections named ".got2".
3620   uint32_t offset = 0;
3621   for (BaseCommand *base : getParent()->sectionCommands)
3622     if (auto *isd = dyn_cast<InputSectionDescription>(base)) {
3623       for (InputSection *isec : isd->sections) {
3624         if (isec == this)
3625           continue;
3626         isec->file->ppc32Got2OutSecOff = offset;
3627         offset += (uint32_t)isec->getSize();
3628       }
3629     }
3630 }
3631 
3632 // If linking position-dependent code then the table will store the addresses
3633 // directly in the binary so the section has type SHT_PROGBITS. If linking
3634 // position-independent code the section has type SHT_NOBITS since it will be
3635 // allocated and filled in by the dynamic linker.
3636 PPC64LongBranchTargetSection::PPC64LongBranchTargetSection()
3637     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
3638                        config->isPic ? SHT_NOBITS : SHT_PROGBITS, 8,
3639                        ".branch_lt") {}
3640 
3641 uint64_t PPC64LongBranchTargetSection::getEntryVA(const Symbol *sym,
3642                                                   int64_t addend) {
3643   return getVA() + entry_index.find({sym, addend})->second * 8;
3644 }
3645 
3646 Optional<uint32_t> PPC64LongBranchTargetSection::addEntry(const Symbol *sym,
3647                                                           int64_t addend) {
3648   auto res =
3649       entry_index.try_emplace(std::make_pair(sym, addend), entries.size());
3650   if (!res.second)
3651     return None;
3652   entries.emplace_back(sym, addend);
3653   return res.first->second;
3654 }
3655 
3656 size_t PPC64LongBranchTargetSection::getSize() const {
3657   return entries.size() * 8;
3658 }
3659 
3660 void PPC64LongBranchTargetSection::writeTo(uint8_t *buf) {
3661   // If linking non-pic we have the final addresses of the targets and they get
3662   // written to the table directly. For pic the dynamic linker will allocate
3663   // the section and fill it it.
3664   if (config->isPic)
3665     return;
3666 
3667   for (auto entry : entries) {
3668     const Symbol *sym = entry.first;
3669     int64_t addend = entry.second;
3670     assert(sym->getVA());
3671     // Need calls to branch to the local entry-point since a long-branch
3672     // must be a local-call.
3673     write64(buf, sym->getVA(addend) +
3674                      getPPC64GlobalEntryToLocalEntryOffset(sym->stOther));
3675     buf += 8;
3676   }
3677 }
3678 
3679 bool PPC64LongBranchTargetSection::isNeeded() const {
3680   // `removeUnusedSyntheticSections()` is called before thunk allocation which
3681   // is too early to determine if this section will be empty or not. We need
3682   // Finalized to keep the section alive until after thunk creation. Finalized
3683   // only gets set to true once `finalizeSections()` is called after thunk
3684   // creation. Because of this, if we don't create any long-branch thunks we end
3685   // up with an empty .branch_lt section in the binary.
3686   return !finalized || !entries.empty();
3687 }
3688 
3689 static uint8_t getAbiVersion() {
3690   // MIPS non-PIC executable gets ABI version 1.
3691   if (config->emachine == EM_MIPS) {
3692     if (!config->isPic && !config->relocatable &&
3693         (config->eflags & (EF_MIPS_PIC | EF_MIPS_CPIC)) == EF_MIPS_CPIC)
3694       return 1;
3695     return 0;
3696   }
3697 
3698   if (config->emachine == EM_AMDGPU) {
3699     uint8_t ver = objectFiles[0]->abiVersion;
3700     for (InputFile *file : makeArrayRef(objectFiles).slice(1))
3701       if (file->abiVersion != ver)
3702         error("incompatible ABI version: " + toString(file));
3703     return ver;
3704   }
3705 
3706   return 0;
3707 }
3708 
3709 template <typename ELFT> void elf::writeEhdr(uint8_t *buf, Partition &part) {
3710   // For executable segments, the trap instructions are written before writing
3711   // the header. Setting Elf header bytes to zero ensures that any unused bytes
3712   // in header are zero-cleared, instead of having trap instructions.
3713   memset(buf, 0, sizeof(typename ELFT::Ehdr));
3714   memcpy(buf, "\177ELF", 4);
3715 
3716   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
3717   eHdr->e_ident[EI_CLASS] = config->is64 ? ELFCLASS64 : ELFCLASS32;
3718   eHdr->e_ident[EI_DATA] = config->isLE ? ELFDATA2LSB : ELFDATA2MSB;
3719   eHdr->e_ident[EI_VERSION] = EV_CURRENT;
3720   eHdr->e_ident[EI_OSABI] = config->osabi;
3721   eHdr->e_ident[EI_ABIVERSION] = getAbiVersion();
3722   eHdr->e_machine = config->emachine;
3723   eHdr->e_version = EV_CURRENT;
3724   eHdr->e_flags = config->eflags;
3725   eHdr->e_ehsize = sizeof(typename ELFT::Ehdr);
3726   eHdr->e_phnum = part.phdrs.size();
3727   eHdr->e_shentsize = sizeof(typename ELFT::Shdr);
3728 
3729   if (!config->relocatable) {
3730     eHdr->e_phoff = sizeof(typename ELFT::Ehdr);
3731     eHdr->e_phentsize = sizeof(typename ELFT::Phdr);
3732   }
3733 }
3734 
3735 template <typename ELFT> void elf::writePhdrs(uint8_t *buf, Partition &part) {
3736   // Write the program header table.
3737   auto *hBuf = reinterpret_cast<typename ELFT::Phdr *>(buf);
3738   for (PhdrEntry *p : part.phdrs) {
3739     hBuf->p_type = p->p_type;
3740     hBuf->p_flags = p->p_flags;
3741     hBuf->p_offset = p->p_offset;
3742     hBuf->p_vaddr = p->p_vaddr;
3743     hBuf->p_paddr = p->p_paddr;
3744     hBuf->p_filesz = p->p_filesz;
3745     hBuf->p_memsz = p->p_memsz;
3746     hBuf->p_align = p->p_align;
3747     ++hBuf;
3748   }
3749 }
3750 
3751 template <typename ELFT>
3752 PartitionElfHeaderSection<ELFT>::PartitionElfHeaderSection()
3753     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_EHDR, 1, "") {}
3754 
3755 template <typename ELFT>
3756 size_t PartitionElfHeaderSection<ELFT>::getSize() const {
3757   return sizeof(typename ELFT::Ehdr);
3758 }
3759 
3760 template <typename ELFT>
3761 void PartitionElfHeaderSection<ELFT>::writeTo(uint8_t *buf) {
3762   writeEhdr<ELFT>(buf, getPartition());
3763 
3764   // Loadable partitions are always ET_DYN.
3765   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
3766   eHdr->e_type = ET_DYN;
3767 }
3768 
3769 template <typename ELFT>
3770 PartitionProgramHeadersSection<ELFT>::PartitionProgramHeadersSection()
3771     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_PHDR, 1, ".phdrs") {}
3772 
3773 template <typename ELFT>
3774 size_t PartitionProgramHeadersSection<ELFT>::getSize() const {
3775   return sizeof(typename ELFT::Phdr) * getPartition().phdrs.size();
3776 }
3777 
3778 template <typename ELFT>
3779 void PartitionProgramHeadersSection<ELFT>::writeTo(uint8_t *buf) {
3780   writePhdrs<ELFT>(buf, getPartition());
3781 }
3782 
3783 PartitionIndexSection::PartitionIndexSection()
3784     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".rodata") {}
3785 
3786 size_t PartitionIndexSection::getSize() const {
3787   return 12 * (partitions.size() - 1);
3788 }
3789 
3790 void PartitionIndexSection::finalizeContents() {
3791   for (size_t i = 1; i != partitions.size(); ++i)
3792     partitions[i].nameStrTab = mainPart->dynStrTab->addString(partitions[i].name);
3793 }
3794 
3795 void PartitionIndexSection::writeTo(uint8_t *buf) {
3796   uint64_t va = getVA();
3797   for (size_t i = 1; i != partitions.size(); ++i) {
3798     write32(buf, mainPart->dynStrTab->getVA() + partitions[i].nameStrTab - va);
3799     write32(buf + 4, partitions[i].elfHeader->getVA() - (va + 4));
3800 
3801     SyntheticSection *next =
3802         i == partitions.size() - 1 ? in.partEnd : partitions[i + 1].elfHeader;
3803     write32(buf + 8, next->getVA() - partitions[i].elfHeader->getVA());
3804 
3805     va += 12;
3806     buf += 12;
3807   }
3808 }
3809 
3810 InStruct elf::in;
3811 
3812 std::vector<Partition> elf::partitions;
3813 Partition *elf::mainPart;
3814 
3815 template GdbIndexSection *GdbIndexSection::create<ELF32LE>();
3816 template GdbIndexSection *GdbIndexSection::create<ELF32BE>();
3817 template GdbIndexSection *GdbIndexSection::create<ELF64LE>();
3818 template GdbIndexSection *GdbIndexSection::create<ELF64BE>();
3819 
3820 template void elf::splitSections<ELF32LE>();
3821 template void elf::splitSections<ELF32BE>();
3822 template void elf::splitSections<ELF64LE>();
3823 template void elf::splitSections<ELF64BE>();
3824 
3825 template class elf::MipsAbiFlagsSection<ELF32LE>;
3826 template class elf::MipsAbiFlagsSection<ELF32BE>;
3827 template class elf::MipsAbiFlagsSection<ELF64LE>;
3828 template class elf::MipsAbiFlagsSection<ELF64BE>;
3829 
3830 template class elf::MipsOptionsSection<ELF32LE>;
3831 template class elf::MipsOptionsSection<ELF32BE>;
3832 template class elf::MipsOptionsSection<ELF64LE>;
3833 template class elf::MipsOptionsSection<ELF64BE>;
3834 
3835 template void EhFrameSection::iterateFDEWithLSDA<ELF32LE>(
3836     function_ref<void(InputSection &)>);
3837 template void EhFrameSection::iterateFDEWithLSDA<ELF32BE>(
3838     function_ref<void(InputSection &)>);
3839 template void EhFrameSection::iterateFDEWithLSDA<ELF64LE>(
3840     function_ref<void(InputSection &)>);
3841 template void EhFrameSection::iterateFDEWithLSDA<ELF64BE>(
3842     function_ref<void(InputSection &)>);
3843 
3844 template class elf::MipsReginfoSection<ELF32LE>;
3845 template class elf::MipsReginfoSection<ELF32BE>;
3846 template class elf::MipsReginfoSection<ELF64LE>;
3847 template class elf::MipsReginfoSection<ELF64BE>;
3848 
3849 template class elf::DynamicSection<ELF32LE>;
3850 template class elf::DynamicSection<ELF32BE>;
3851 template class elf::DynamicSection<ELF64LE>;
3852 template class elf::DynamicSection<ELF64BE>;
3853 
3854 template class elf::RelocationSection<ELF32LE>;
3855 template class elf::RelocationSection<ELF32BE>;
3856 template class elf::RelocationSection<ELF64LE>;
3857 template class elf::RelocationSection<ELF64BE>;
3858 
3859 template class elf::AndroidPackedRelocationSection<ELF32LE>;
3860 template class elf::AndroidPackedRelocationSection<ELF32BE>;
3861 template class elf::AndroidPackedRelocationSection<ELF64LE>;
3862 template class elf::AndroidPackedRelocationSection<ELF64BE>;
3863 
3864 template class elf::RelrSection<ELF32LE>;
3865 template class elf::RelrSection<ELF32BE>;
3866 template class elf::RelrSection<ELF64LE>;
3867 template class elf::RelrSection<ELF64BE>;
3868 
3869 template class elf::SymbolTableSection<ELF32LE>;
3870 template class elf::SymbolTableSection<ELF32BE>;
3871 template class elf::SymbolTableSection<ELF64LE>;
3872 template class elf::SymbolTableSection<ELF64BE>;
3873 
3874 template class elf::VersionNeedSection<ELF32LE>;
3875 template class elf::VersionNeedSection<ELF32BE>;
3876 template class elf::VersionNeedSection<ELF64LE>;
3877 template class elf::VersionNeedSection<ELF64BE>;
3878 
3879 template void elf::writeEhdr<ELF32LE>(uint8_t *Buf, Partition &Part);
3880 template void elf::writeEhdr<ELF32BE>(uint8_t *Buf, Partition &Part);
3881 template void elf::writeEhdr<ELF64LE>(uint8_t *Buf, Partition &Part);
3882 template void elf::writeEhdr<ELF64BE>(uint8_t *Buf, Partition &Part);
3883 
3884 template void elf::writePhdrs<ELF32LE>(uint8_t *Buf, Partition &Part);
3885 template void elf::writePhdrs<ELF32BE>(uint8_t *Buf, Partition &Part);
3886 template void elf::writePhdrs<ELF64LE>(uint8_t *Buf, Partition &Part);
3887 template void elf::writePhdrs<ELF64BE>(uint8_t *Buf, Partition &Part);
3888 
3889 template class elf::PartitionElfHeaderSection<ELF32LE>;
3890 template class elf::PartitionElfHeaderSection<ELF32BE>;
3891 template class elf::PartitionElfHeaderSection<ELF64LE>;
3892 template class elf::PartitionElfHeaderSection<ELF64BE>;
3893 
3894 template class elf::PartitionProgramHeadersSection<ELF32LE>;
3895 template class elf::PartitionProgramHeadersSection<ELF32BE>;
3896 template class elf::PartitionProgramHeadersSection<ELF64LE>;
3897 template class elf::PartitionProgramHeadersSection<ELF64BE>;
3898