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