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