]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/llvm/tools/lld/ELF/SyntheticSections.cpp
MFhead@r344527
[FreeBSD/FreeBSD.git] / contrib / llvm / tools / lld / ELF / SyntheticSections.cpp
1 //===- SyntheticSections.cpp ----------------------------------------------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains linker-synthesized sections. Currently,
11 // synthetic sections are created either output sections or input sections,
12 // but we are rewriting code so that all synthetic sections are created as
13 // input sections.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #include "SyntheticSections.h"
18 #include "Bits.h"
19 #include "Config.h"
20 #include "InputFiles.h"
21 #include "LinkerScript.h"
22 #include "OutputSections.h"
23 #include "SymbolTable.h"
24 #include "Symbols.h"
25 #include "Target.h"
26 #include "Writer.h"
27 #include "lld/Common/ErrorHandler.h"
28 #include "lld/Common/Memory.h"
29 #include "lld/Common/Strings.h"
30 #include "lld/Common/Threads.h"
31 #include "lld/Common/Version.h"
32 #include "llvm/ADT/SetOperations.h"
33 #include "llvm/BinaryFormat/Dwarf.h"
34 #include "llvm/DebugInfo/DWARF/DWARFDebugPubTable.h"
35 #include "llvm/Object/Decompressor.h"
36 #include "llvm/Object/ELFObjectFile.h"
37 #include "llvm/Support/Endian.h"
38 #include "llvm/Support/LEB128.h"
39 #include "llvm/Support/MD5.h"
40 #include "llvm/Support/RandomNumberGenerator.h"
41 #include "llvm/Support/SHA1.h"
42 #include "llvm/Support/xxhash.h"
43 #include <cstdlib>
44 #include <thread>
45
46 using namespace llvm;
47 using namespace llvm::dwarf;
48 using namespace llvm::ELF;
49 using namespace llvm::object;
50 using namespace llvm::support;
51
52 using namespace lld;
53 using namespace lld::elf;
54
55 using llvm::support::endian::read32le;
56 using llvm::support::endian::write32le;
57 using llvm::support::endian::write64le;
58
59 constexpr size_t MergeNoTailSection::NumShards;
60
61 // Returns an LLD version string.
62 static ArrayRef<uint8_t> getVersion() {
63   // Check LLD_VERSION first for ease of testing.
64   // You can get consistent output by using the environment variable.
65   // This is only for testing.
66   StringRef S = getenv("LLD_VERSION");
67   if (S.empty())
68     S = Saver.save(Twine("Linker: ") + getLLDVersion());
69
70   // +1 to include the terminating '\0'.
71   return {(const uint8_t *)S.data(), S.size() + 1};
72 }
73
74 // Creates a .comment section containing LLD version info.
75 // With this feature, you can identify LLD-generated binaries easily
76 // by "readelf --string-dump .comment <file>".
77 // The returned object is a mergeable string section.
78 MergeInputSection *elf::createCommentSection() {
79   return make<MergeInputSection>(SHF_MERGE | SHF_STRINGS, SHT_PROGBITS, 1,
80                                  getVersion(), ".comment");
81 }
82
83 // .MIPS.abiflags section.
84 template <class ELFT>
85 MipsAbiFlagsSection<ELFT>::MipsAbiFlagsSection(Elf_Mips_ABIFlags Flags)
86     : SyntheticSection(SHF_ALLOC, SHT_MIPS_ABIFLAGS, 8, ".MIPS.abiflags"),
87       Flags(Flags) {
88   this->Entsize = sizeof(Elf_Mips_ABIFlags);
89 }
90
91 template <class ELFT> void MipsAbiFlagsSection<ELFT>::writeTo(uint8_t *Buf) {
92   memcpy(Buf, &Flags, sizeof(Flags));
93 }
94
95 template <class ELFT>
96 MipsAbiFlagsSection<ELFT> *MipsAbiFlagsSection<ELFT>::create() {
97   Elf_Mips_ABIFlags Flags = {};
98   bool Create = false;
99
100   for (InputSectionBase *Sec : InputSections) {
101     if (Sec->Type != SHT_MIPS_ABIFLAGS)
102       continue;
103     Sec->Live = false;
104     Create = true;
105
106     std::string Filename = toString(Sec->File);
107     const size_t Size = Sec->Data.size();
108     // Older version of BFD (such as the default FreeBSD linker) concatenate
109     // .MIPS.abiflags instead of merging. To allow for this case (or potential
110     // zero padding) we ignore everything after the first Elf_Mips_ABIFlags
111     if (Size < sizeof(Elf_Mips_ABIFlags)) {
112       error(Filename + ": invalid size of .MIPS.abiflags section: got " +
113             Twine(Size) + " instead of " + Twine(sizeof(Elf_Mips_ABIFlags)));
114       return nullptr;
115     }
116     auto *S = reinterpret_cast<const Elf_Mips_ABIFlags *>(Sec->Data.data());
117     if (S->version != 0) {
118       error(Filename + ": unexpected .MIPS.abiflags version " +
119             Twine(S->version));
120       return nullptr;
121     }
122
123     // LLD checks ISA compatibility in calcMipsEFlags(). Here we just
124     // select the highest number of ISA/Rev/Ext.
125     Flags.isa_level = std::max(Flags.isa_level, S->isa_level);
126     Flags.isa_rev = std::max(Flags.isa_rev, S->isa_rev);
127     Flags.isa_ext = std::max(Flags.isa_ext, S->isa_ext);
128     Flags.gpr_size = std::max(Flags.gpr_size, S->gpr_size);
129     Flags.cpr1_size = std::max(Flags.cpr1_size, S->cpr1_size);
130     Flags.cpr2_size = std::max(Flags.cpr2_size, S->cpr2_size);
131     Flags.ases |= S->ases;
132     Flags.flags1 |= S->flags1;
133     Flags.flags2 |= S->flags2;
134     Flags.fp_abi = elf::getMipsFpAbiFlag(Flags.fp_abi, S->fp_abi, Filename);
135   };
136
137   if (Create)
138     return make<MipsAbiFlagsSection<ELFT>>(Flags);
139   return nullptr;
140 }
141
142 // .MIPS.options section.
143 template <class ELFT>
144 MipsOptionsSection<ELFT>::MipsOptionsSection(Elf_Mips_RegInfo Reginfo)
145     : SyntheticSection(SHF_ALLOC, SHT_MIPS_OPTIONS, 8, ".MIPS.options"),
146       Reginfo(Reginfo) {
147   this->Entsize = sizeof(Elf_Mips_Options) + sizeof(Elf_Mips_RegInfo);
148 }
149
150 template <class ELFT> void MipsOptionsSection<ELFT>::writeTo(uint8_t *Buf) {
151   auto *Options = reinterpret_cast<Elf_Mips_Options *>(Buf);
152   Options->kind = ODK_REGINFO;
153   Options->size = getSize();
154
155   if (!Config->Relocatable)
156     Reginfo.ri_gp_value = InX::MipsGot->getGp();
157   memcpy(Buf + sizeof(Elf_Mips_Options), &Reginfo, sizeof(Reginfo));
158 }
159
160 template <class ELFT>
161 MipsOptionsSection<ELFT> *MipsOptionsSection<ELFT>::create() {
162   // N64 ABI only.
163   if (!ELFT::Is64Bits)
164     return nullptr;
165
166   std::vector<InputSectionBase *> Sections;
167   for (InputSectionBase *Sec : InputSections)
168     if (Sec->Type == SHT_MIPS_OPTIONS)
169       Sections.push_back(Sec);
170
171   if (Sections.empty())
172     return nullptr;
173
174   Elf_Mips_RegInfo Reginfo = {};
175   for (InputSectionBase *Sec : Sections) {
176     Sec->Live = false;
177
178     std::string Filename = toString(Sec->File);
179     ArrayRef<uint8_t> D = Sec->Data;
180
181     while (!D.empty()) {
182       if (D.size() < sizeof(Elf_Mips_Options)) {
183         error(Filename + ": invalid size of .MIPS.options section");
184         break;
185       }
186
187       auto *Opt = reinterpret_cast<const Elf_Mips_Options *>(D.data());
188       if (Opt->kind == ODK_REGINFO) {
189         Reginfo.ri_gprmask |= Opt->getRegInfo().ri_gprmask;
190         Sec->getFile<ELFT>()->MipsGp0 = Opt->getRegInfo().ri_gp_value;
191         break;
192       }
193
194       if (!Opt->size)
195         fatal(Filename + ": zero option descriptor size");
196       D = D.slice(Opt->size);
197     }
198   };
199
200   return make<MipsOptionsSection<ELFT>>(Reginfo);
201 }
202
203 // MIPS .reginfo section.
204 template <class ELFT>
205 MipsReginfoSection<ELFT>::MipsReginfoSection(Elf_Mips_RegInfo Reginfo)
206     : SyntheticSection(SHF_ALLOC, SHT_MIPS_REGINFO, 4, ".reginfo"),
207       Reginfo(Reginfo) {
208   this->Entsize = sizeof(Elf_Mips_RegInfo);
209 }
210
211 template <class ELFT> void MipsReginfoSection<ELFT>::writeTo(uint8_t *Buf) {
212   if (!Config->Relocatable)
213     Reginfo.ri_gp_value = InX::MipsGot->getGp();
214   memcpy(Buf, &Reginfo, sizeof(Reginfo));
215 }
216
217 template <class ELFT>
218 MipsReginfoSection<ELFT> *MipsReginfoSection<ELFT>::create() {
219   // Section should be alive for O32 and N32 ABIs only.
220   if (ELFT::Is64Bits)
221     return nullptr;
222
223   std::vector<InputSectionBase *> Sections;
224   for (InputSectionBase *Sec : InputSections)
225     if (Sec->Type == SHT_MIPS_REGINFO)
226       Sections.push_back(Sec);
227
228   if (Sections.empty())
229     return nullptr;
230
231   Elf_Mips_RegInfo Reginfo = {};
232   for (InputSectionBase *Sec : Sections) {
233     Sec->Live = false;
234
235     if (Sec->Data.size() != sizeof(Elf_Mips_RegInfo)) {
236       error(toString(Sec->File) + ": invalid size of .reginfo section");
237       return nullptr;
238     }
239
240     auto *R = reinterpret_cast<const Elf_Mips_RegInfo *>(Sec->Data.data());
241     Reginfo.ri_gprmask |= R->ri_gprmask;
242     Sec->getFile<ELFT>()->MipsGp0 = R->ri_gp_value;
243   };
244
245   return make<MipsReginfoSection<ELFT>>(Reginfo);
246 }
247
248 InputSection *elf::createInterpSection() {
249   // StringSaver guarantees that the returned string ends with '\0'.
250   StringRef S = Saver.save(Config->DynamicLinker);
251   ArrayRef<uint8_t> Contents = {(const uint8_t *)S.data(), S.size() + 1};
252
253   auto *Sec = make<InputSection>(nullptr, SHF_ALLOC, SHT_PROGBITS, 1, Contents,
254                                  ".interp");
255   Sec->Live = true;
256   return Sec;
257 }
258
259 Defined *elf::addSyntheticLocal(StringRef Name, uint8_t Type, uint64_t Value,
260                                 uint64_t Size, InputSectionBase &Section) {
261   auto *S = make<Defined>(Section.File, Name, STB_LOCAL, STV_DEFAULT, Type,
262                           Value, Size, &Section);
263   if (InX::SymTab)
264     InX::SymTab->addSymbol(S);
265   return S;
266 }
267
268 static size_t getHashSize() {
269   switch (Config->BuildId) {
270   case BuildIdKind::Fast:
271     return 8;
272   case BuildIdKind::Md5:
273   case BuildIdKind::Uuid:
274     return 16;
275   case BuildIdKind::Sha1:
276     return 20;
277   case BuildIdKind::Hexstring:
278     return Config->BuildIdVector.size();
279   default:
280     llvm_unreachable("unknown BuildIdKind");
281   }
282 }
283
284 BuildIdSection::BuildIdSection()
285     : SyntheticSection(SHF_ALLOC, SHT_NOTE, 4, ".note.gnu.build-id"),
286       HashSize(getHashSize()) {}
287
288 void BuildIdSection::writeTo(uint8_t *Buf) {
289   write32(Buf, 4);                      // Name size
290   write32(Buf + 4, HashSize);           // Content size
291   write32(Buf + 8, NT_GNU_BUILD_ID);    // Type
292   memcpy(Buf + 12, "GNU", 4);           // Name string
293   HashBuf = Buf + 16;
294 }
295
296 // Split one uint8 array into small pieces of uint8 arrays.
297 static std::vector<ArrayRef<uint8_t>> split(ArrayRef<uint8_t> Arr,
298                                             size_t ChunkSize) {
299   std::vector<ArrayRef<uint8_t>> Ret;
300   while (Arr.size() > ChunkSize) {
301     Ret.push_back(Arr.take_front(ChunkSize));
302     Arr = Arr.drop_front(ChunkSize);
303   }
304   if (!Arr.empty())
305     Ret.push_back(Arr);
306   return Ret;
307 }
308
309 // Computes a hash value of Data using a given hash function.
310 // In order to utilize multiple cores, we first split data into 1MB
311 // chunks, compute a hash for each chunk, and then compute a hash value
312 // of the hash values.
313 void BuildIdSection::computeHash(
314     llvm::ArrayRef<uint8_t> Data,
315     std::function<void(uint8_t *Dest, ArrayRef<uint8_t> Arr)> HashFn) {
316   std::vector<ArrayRef<uint8_t>> Chunks = split(Data, 1024 * 1024);
317   std::vector<uint8_t> Hashes(Chunks.size() * HashSize);
318
319   // Compute hash values.
320   parallelForEachN(0, Chunks.size(), [&](size_t I) {
321     HashFn(Hashes.data() + I * HashSize, Chunks[I]);
322   });
323
324   // Write to the final output buffer.
325   HashFn(HashBuf, Hashes);
326 }
327
328 BssSection::BssSection(StringRef Name, uint64_t Size, uint32_t Alignment)
329     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_NOBITS, Alignment, Name) {
330   this->Bss = true;
331   this->Size = Size;
332 }
333
334 void BuildIdSection::writeBuildId(ArrayRef<uint8_t> Buf) {
335   switch (Config->BuildId) {
336   case BuildIdKind::Fast:
337     computeHash(Buf, [](uint8_t *Dest, ArrayRef<uint8_t> Arr) {
338       write64le(Dest, xxHash64(Arr));
339     });
340     break;
341   case BuildIdKind::Md5:
342     computeHash(Buf, [](uint8_t *Dest, ArrayRef<uint8_t> Arr) {
343       memcpy(Dest, MD5::hash(Arr).data(), 16);
344     });
345     break;
346   case BuildIdKind::Sha1:
347     computeHash(Buf, [](uint8_t *Dest, ArrayRef<uint8_t> Arr) {
348       memcpy(Dest, SHA1::hash(Arr).data(), 20);
349     });
350     break;
351   case BuildIdKind::Uuid:
352     if (auto EC = getRandomBytes(HashBuf, HashSize))
353       error("entropy source failure: " + EC.message());
354     break;
355   case BuildIdKind::Hexstring:
356     memcpy(HashBuf, Config->BuildIdVector.data(), Config->BuildIdVector.size());
357     break;
358   default:
359     llvm_unreachable("unknown BuildIdKind");
360   }
361 }
362
363 EhFrameSection::EhFrameSection()
364     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 1, ".eh_frame") {}
365
366 // Search for an existing CIE record or create a new one.
367 // CIE records from input object files are uniquified by their contents
368 // and where their relocations point to.
369 template <class ELFT, class RelTy>
370 CieRecord *EhFrameSection::addCie(EhSectionPiece &Cie, ArrayRef<RelTy> Rels) {
371   Symbol *Personality = nullptr;
372   unsigned FirstRelI = Cie.FirstRelocation;
373   if (FirstRelI != (unsigned)-1)
374     Personality =
375         &Cie.Sec->template getFile<ELFT>()->getRelocTargetSym(Rels[FirstRelI]);
376
377   // Search for an existing CIE by CIE contents/relocation target pair.
378   CieRecord *&Rec = CieMap[{Cie.data(), Personality}];
379
380   // If not found, create a new one.
381   if (!Rec) {
382     Rec = make<CieRecord>();
383     Rec->Cie = &Cie;
384     CieRecords.push_back(Rec);
385   }
386   return Rec;
387 }
388
389 // There is one FDE per function. Returns true if a given FDE
390 // points to a live function.
391 template <class ELFT, class RelTy>
392 bool EhFrameSection::isFdeLive(EhSectionPiece &Fde, ArrayRef<RelTy> Rels) {
393   auto *Sec = cast<EhInputSection>(Fde.Sec);
394   unsigned FirstRelI = Fde.FirstRelocation;
395
396   // An FDE should point to some function because FDEs are to describe
397   // functions. That's however not always the case due to an issue of
398   // ld.gold with -r. ld.gold may discard only functions and leave their
399   // corresponding FDEs, which results in creating bad .eh_frame sections.
400   // To deal with that, we ignore such FDEs.
401   if (FirstRelI == (unsigned)-1)
402     return false;
403
404   const RelTy &Rel = Rels[FirstRelI];
405   Symbol &B = Sec->template getFile<ELFT>()->getRelocTargetSym(Rel);
406
407   // FDEs for garbage-collected or merged-by-ICF sections are dead.
408   if (auto *D = dyn_cast<Defined>(&B))
409     if (SectionBase *Sec = D->Section)
410       return Sec->Live;
411   return false;
412 }
413
414 // .eh_frame is a sequence of CIE or FDE records. In general, there
415 // is one CIE record per input object file which is followed by
416 // a list of FDEs. This function searches an existing CIE or create a new
417 // one and associates FDEs to the CIE.
418 template <class ELFT, class RelTy>
419 void EhFrameSection::addSectionAux(EhInputSection *Sec, ArrayRef<RelTy> Rels) {
420   OffsetToCie.clear();
421   for (EhSectionPiece &Piece : Sec->Pieces) {
422     // The empty record is the end marker.
423     if (Piece.Size == 4)
424       return;
425
426     size_t Offset = Piece.InputOff;
427     uint32_t ID = read32(Piece.data().data() + 4);
428     if (ID == 0) {
429       OffsetToCie[Offset] = addCie<ELFT>(Piece, Rels);
430       continue;
431     }
432
433     uint32_t CieOffset = Offset + 4 - ID;
434     CieRecord *Rec = OffsetToCie[CieOffset];
435     if (!Rec)
436       fatal(toString(Sec) + ": invalid CIE reference");
437
438     if (!isFdeLive<ELFT>(Piece, Rels))
439       continue;
440     Rec->Fdes.push_back(&Piece);
441     NumFdes++;
442   }
443 }
444
445 template <class ELFT> void EhFrameSection::addSection(InputSectionBase *C) {
446   auto *Sec = cast<EhInputSection>(C);
447   Sec->Parent = this;
448
449   Alignment = std::max(Alignment, Sec->Alignment);
450   Sections.push_back(Sec);
451
452   for (auto *DS : Sec->DependentSections)
453     DependentSections.push_back(DS);
454
455   if (Sec->Pieces.empty())
456     return;
457
458   if (Sec->AreRelocsRela)
459     addSectionAux<ELFT>(Sec, Sec->template relas<ELFT>());
460   else
461     addSectionAux<ELFT>(Sec, Sec->template rels<ELFT>());
462 }
463
464 static void writeCieFde(uint8_t *Buf, ArrayRef<uint8_t> D) {
465   memcpy(Buf, D.data(), D.size());
466
467   size_t Aligned = alignTo(D.size(), Config->Wordsize);
468
469   // Zero-clear trailing padding if it exists.
470   memset(Buf + D.size(), 0, Aligned - D.size());
471
472   // Fix the size field. -4 since size does not include the size field itself.
473   write32(Buf, Aligned - 4);
474 }
475
476 void EhFrameSection::finalizeContents() {
477   assert(!this->Size); // Not finalized.
478   size_t Off = 0;
479   for (CieRecord *Rec : CieRecords) {
480     Rec->Cie->OutputOff = Off;
481     Off += alignTo(Rec->Cie->Size, Config->Wordsize);
482
483     for (EhSectionPiece *Fde : Rec->Fdes) {
484       Fde->OutputOff = Off;
485       Off += alignTo(Fde->Size, Config->Wordsize);
486     }
487   }
488
489   // The LSB standard does not allow a .eh_frame section with zero
490   // Call Frame Information records. glibc unwind-dw2-fde.c
491   // classify_object_over_fdes expects there is a CIE record length 0 as a
492   // terminator. Thus we add one unconditionally.
493   Off += 4;
494
495   this->Size = Off;
496 }
497
498 // Returns data for .eh_frame_hdr. .eh_frame_hdr is a binary search table
499 // to get an FDE from an address to which FDE is applied. This function
500 // returns a list of such pairs.
501 std::vector<EhFrameSection::FdeData> EhFrameSection::getFdeData() const {
502   uint8_t *Buf = getParent()->Loc + OutSecOff;
503   std::vector<FdeData> Ret;
504
505   uint64_t VA = InX::EhFrameHdr->getVA();
506   for (CieRecord *Rec : CieRecords) {
507     uint8_t Enc = getFdeEncoding(Rec->Cie);
508     for (EhSectionPiece *Fde : Rec->Fdes) {
509       uint64_t Pc = getFdePc(Buf, Fde->OutputOff, Enc);
510       uint64_t FdeVA = getParent()->Addr + Fde->OutputOff;
511       if (!isInt<32>(Pc - VA))
512         fatal(toString(Fde->Sec) + ": PC offset is too large: 0x" +
513               Twine::utohexstr(Pc - VA));
514       Ret.push_back({uint32_t(Pc - VA), uint32_t(FdeVA - VA)});
515     }
516   }
517
518   // Sort the FDE list by their PC and uniqueify. Usually there is only
519   // one FDE for a PC (i.e. function), but if ICF merges two functions
520   // into one, there can be more than one FDEs pointing to the address.
521   auto Less = [](const FdeData &A, const FdeData &B) {
522     return A.PcRel < B.PcRel;
523   };
524   std::stable_sort(Ret.begin(), Ret.end(), Less);
525   auto Eq = [](const FdeData &A, const FdeData &B) {
526     return A.PcRel == B.PcRel;
527   };
528   Ret.erase(std::unique(Ret.begin(), Ret.end(), Eq), Ret.end());
529
530   return Ret;
531 }
532
533 static uint64_t readFdeAddr(uint8_t *Buf, int Size) {
534   switch (Size) {
535   case DW_EH_PE_udata2:
536     return read16(Buf);
537   case DW_EH_PE_sdata2:
538     return (int16_t)read16(Buf);
539   case DW_EH_PE_udata4:
540     return read32(Buf);
541   case DW_EH_PE_sdata4:
542     return (int32_t)read32(Buf);
543   case DW_EH_PE_udata8:
544   case DW_EH_PE_sdata8:
545     return read64(Buf);
546   case DW_EH_PE_absptr:
547     return readUint(Buf);
548   }
549   fatal("unknown FDE size encoding");
550 }
551
552 // Returns the VA to which a given FDE (on a mmap'ed buffer) is applied to.
553 // We need it to create .eh_frame_hdr section.
554 uint64_t EhFrameSection::getFdePc(uint8_t *Buf, size_t FdeOff,
555                                   uint8_t Enc) const {
556   // The starting address to which this FDE applies is
557   // stored at FDE + 8 byte.
558   size_t Off = FdeOff + 8;
559   uint64_t Addr = readFdeAddr(Buf + Off, Enc & 0xf);
560   if ((Enc & 0x70) == DW_EH_PE_absptr)
561     return Addr;
562   if ((Enc & 0x70) == DW_EH_PE_pcrel)
563     return Addr + getParent()->Addr + Off;
564   fatal("unknown FDE size relative encoding");
565 }
566
567 void EhFrameSection::writeTo(uint8_t *Buf) {
568   // Write CIE and FDE records.
569   for (CieRecord *Rec : CieRecords) {
570     size_t CieOffset = Rec->Cie->OutputOff;
571     writeCieFde(Buf + CieOffset, Rec->Cie->data());
572
573     for (EhSectionPiece *Fde : Rec->Fdes) {
574       size_t Off = Fde->OutputOff;
575       writeCieFde(Buf + Off, Fde->data());
576
577       // FDE's second word should have the offset to an associated CIE.
578       // Write it.
579       write32(Buf + Off + 4, Off + 4 - CieOffset);
580     }
581   }
582
583   // Apply relocations. .eh_frame section contents are not contiguous
584   // in the output buffer, but relocateAlloc() still works because
585   // getOffset() takes care of discontiguous section pieces.
586   for (EhInputSection *S : Sections)
587     S->relocateAlloc(Buf, nullptr);
588 }
589
590 GotSection::GotSection()
591     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS,
592                        Target->GotEntrySize, ".got") {
593   // PPC64 saves the ElfSym::GlobalOffsetTable .TOC. as the first entry in the
594   // .got. If there are no references to .TOC. in the symbol table,
595   // ElfSym::GlobalOffsetTable will not be defined and we won't need to save
596   // .TOC. in the .got. When it is defined, we increase NumEntries by the number
597   // of entries used to emit ElfSym::GlobalOffsetTable.
598   if (ElfSym::GlobalOffsetTable && !Target->GotBaseSymInGotPlt)
599     NumEntries += Target->GotHeaderEntriesNum;
600 }
601
602 void GotSection::addEntry(Symbol &Sym) {
603   Sym.GotIndex = NumEntries;
604   ++NumEntries;
605 }
606
607 bool GotSection::addDynTlsEntry(Symbol &Sym) {
608   if (Sym.GlobalDynIndex != -1U)
609     return false;
610   Sym.GlobalDynIndex = NumEntries;
611   // Global Dynamic TLS entries take two GOT slots.
612   NumEntries += 2;
613   return true;
614 }
615
616 // Reserves TLS entries for a TLS module ID and a TLS block offset.
617 // In total it takes two GOT slots.
618 bool GotSection::addTlsIndex() {
619   if (TlsIndexOff != uint32_t(-1))
620     return false;
621   TlsIndexOff = NumEntries * Config->Wordsize;
622   NumEntries += 2;
623   return true;
624 }
625
626 uint64_t GotSection::getGlobalDynAddr(const Symbol &B) const {
627   return this->getVA() + B.GlobalDynIndex * Config->Wordsize;
628 }
629
630 uint64_t GotSection::getGlobalDynOffset(const Symbol &B) const {
631   return B.GlobalDynIndex * Config->Wordsize;
632 }
633
634 void GotSection::finalizeContents() {
635   Size = NumEntries * Config->Wordsize;
636 }
637
638 bool GotSection::empty() const {
639   // We need to emit a GOT even if it's empty if there's a relocation that is
640   // relative to GOT(such as GOTOFFREL) or there's a symbol that points to a GOT
641   // (i.e. _GLOBAL_OFFSET_TABLE_) that the target defines relative to the .got.
642   return NumEntries == 0 && !HasGotOffRel &&
643          !(ElfSym::GlobalOffsetTable && !Target->GotBaseSymInGotPlt);
644 }
645
646 void GotSection::writeTo(uint8_t *Buf) {
647   // Buf points to the start of this section's buffer,
648   // whereas InputSectionBase::relocateAlloc() expects its argument
649   // to point to the start of the output section.
650   Target->writeGotHeader(Buf);
651   relocateAlloc(Buf - OutSecOff, Buf - OutSecOff + Size);
652 }
653
654 static uint64_t getMipsPageAddr(uint64_t Addr) {
655   return (Addr + 0x8000) & ~0xffff;
656 }
657
658 static uint64_t getMipsPageCount(uint64_t Size) {
659   return (Size + 0xfffe) / 0xffff + 1;
660 }
661
662 MipsGotSection::MipsGotSection()
663     : SyntheticSection(SHF_ALLOC | SHF_WRITE | SHF_MIPS_GPREL, SHT_PROGBITS, 16,
664                        ".got") {}
665
666 void MipsGotSection::addEntry(InputFile &File, Symbol &Sym, int64_t Addend,
667                               RelExpr Expr) {
668   FileGot &G = getGot(File);
669   if (Expr == R_MIPS_GOT_LOCAL_PAGE) {
670     if (const OutputSection *OS = Sym.getOutputSection())
671       G.PagesMap.insert({OS, {}});
672     else
673       G.Local16.insert({{nullptr, getMipsPageAddr(Sym.getVA(Addend))}, 0});
674   } else if (Sym.isTls())
675     G.Tls.insert({&Sym, 0});
676   else if (Sym.IsPreemptible && Expr == R_ABS)
677     G.Relocs.insert({&Sym, 0});
678   else if (Sym.IsPreemptible)
679     G.Global.insert({&Sym, 0});
680   else if (Expr == R_MIPS_GOT_OFF32)
681     G.Local32.insert({{&Sym, Addend}, 0});
682   else
683     G.Local16.insert({{&Sym, Addend}, 0});
684 }
685
686 void MipsGotSection::addDynTlsEntry(InputFile &File, Symbol &Sym) {
687   getGot(File).DynTlsSymbols.insert({&Sym, 0});
688 }
689
690 void MipsGotSection::addTlsIndex(InputFile &File) {
691   getGot(File).DynTlsSymbols.insert({nullptr, 0});
692 }
693
694 size_t MipsGotSection::FileGot::getEntriesNum() const {
695   return getPageEntriesNum() + Local16.size() + Global.size() + Relocs.size() +
696          Tls.size() + DynTlsSymbols.size() * 2;
697 }
698
699 size_t MipsGotSection::FileGot::getPageEntriesNum() const {
700   size_t Num = 0;
701   for (const std::pair<const OutputSection *, FileGot::PageBlock> &P : PagesMap)
702     Num += P.second.Count;
703   return Num;
704 }
705
706 size_t MipsGotSection::FileGot::getIndexedEntriesNum() const {
707   size_t Count = getPageEntriesNum() + Local16.size() + Global.size();
708   // If there are relocation-only entries in the GOT, TLS entries
709   // are allocated after them. TLS entries should be addressable
710   // by 16-bit index so count both reloc-only and TLS entries.
711   if (!Tls.empty() || !DynTlsSymbols.empty())
712     Count += Relocs.size() + Tls.size() + DynTlsSymbols.size() * 2;
713   return Count;
714 }
715
716 MipsGotSection::FileGot &MipsGotSection::getGot(InputFile &F) {
717   if (!F.MipsGotIndex.hasValue()) {
718     Gots.emplace_back();
719     Gots.back().File = &F;
720     F.MipsGotIndex = Gots.size() - 1;
721   }
722   return Gots[*F.MipsGotIndex];
723 }
724
725 uint64_t MipsGotSection::getPageEntryOffset(const InputFile *F,
726                                             const Symbol &Sym,
727                                             int64_t Addend) const {
728   const FileGot &G = Gots[*F->MipsGotIndex];
729   uint64_t Index = 0;
730   if (const OutputSection *OutSec = Sym.getOutputSection()) {
731     uint64_t SecAddr = getMipsPageAddr(OutSec->Addr);
732     uint64_t SymAddr = getMipsPageAddr(Sym.getVA(Addend));
733     Index = G.PagesMap.lookup(OutSec).FirstIndex + (SymAddr - SecAddr) / 0xffff;
734   } else {
735     Index = G.Local16.lookup({nullptr, getMipsPageAddr(Sym.getVA(Addend))});
736   }
737   return Index * Config->Wordsize;
738 }
739
740 uint64_t MipsGotSection::getSymEntryOffset(const InputFile *F, const Symbol &S,
741                                            int64_t Addend) const {
742   const FileGot &G = Gots[*F->MipsGotIndex];
743   Symbol *Sym = const_cast<Symbol *>(&S);
744   if (Sym->isTls())
745     return G.Tls.lookup(Sym) * Config->Wordsize;
746   if (Sym->IsPreemptible)
747     return G.Global.lookup(Sym) * Config->Wordsize;
748   return G.Local16.lookup({Sym, Addend}) * Config->Wordsize;
749 }
750
751 uint64_t MipsGotSection::getTlsIndexOffset(const InputFile *F) const {
752   const FileGot &G = Gots[*F->MipsGotIndex];
753   return G.DynTlsSymbols.lookup(nullptr) * Config->Wordsize;
754 }
755
756 uint64_t MipsGotSection::getGlobalDynOffset(const InputFile *F,
757                                             const Symbol &S) const {
758   const FileGot &G = Gots[*F->MipsGotIndex];
759   Symbol *Sym = const_cast<Symbol *>(&S);
760   return G.DynTlsSymbols.lookup(Sym) * Config->Wordsize;
761 }
762
763 const Symbol *MipsGotSection::getFirstGlobalEntry() const {
764   if (Gots.empty())
765     return nullptr;
766   const FileGot &PrimGot = Gots.front();
767   if (!PrimGot.Global.empty())
768     return PrimGot.Global.front().first;
769   if (!PrimGot.Relocs.empty())
770     return PrimGot.Relocs.front().first;
771   return nullptr;
772 }
773
774 unsigned MipsGotSection::getLocalEntriesNum() const {
775   if (Gots.empty())
776     return HeaderEntriesNum;
777   return HeaderEntriesNum + Gots.front().getPageEntriesNum() +
778          Gots.front().Local16.size();
779 }
780
781 bool MipsGotSection::tryMergeGots(FileGot &Dst, FileGot &Src, bool IsPrimary) {
782   FileGot Tmp = Dst;
783   set_union(Tmp.PagesMap, Src.PagesMap);
784   set_union(Tmp.Local16, Src.Local16);
785   set_union(Tmp.Global, Src.Global);
786   set_union(Tmp.Relocs, Src.Relocs);
787   set_union(Tmp.Tls, Src.Tls);
788   set_union(Tmp.DynTlsSymbols, Src.DynTlsSymbols);
789
790   size_t Count = IsPrimary ? HeaderEntriesNum : 0;
791   Count += Tmp.getIndexedEntriesNum();
792
793   if (Count * Config->Wordsize > Config->MipsGotSize)
794     return false;
795
796   std::swap(Tmp, Dst);
797   return true;
798 }
799
800 void MipsGotSection::finalizeContents() { updateAllocSize(); }
801
802 bool MipsGotSection::updateAllocSize() {
803   Size = HeaderEntriesNum * Config->Wordsize;
804   for (const FileGot &G : Gots)
805     Size += G.getEntriesNum() * Config->Wordsize;
806   return false;
807 }
808
809 template <class ELFT> void MipsGotSection::build() {
810   if (Gots.empty())
811     return;
812
813   std::vector<FileGot> MergedGots(1);
814
815   // For each GOT move non-preemptible symbols from the `Global`
816   // to `Local16` list. Preemptible symbol might become non-preemptible
817   // one if, for example, it gets a related copy relocation.
818   for (FileGot &Got : Gots) {
819     for (auto &P: Got.Global)
820       if (!P.first->IsPreemptible)
821         Got.Local16.insert({{P.first, 0}, 0});
822     Got.Global.remove_if([&](const std::pair<Symbol *, size_t> &P) {
823       return !P.first->IsPreemptible;
824     });
825   }
826
827   // For each GOT remove "reloc-only" entry if there is "global"
828   // entry for the same symbol. And add local entries which indexed
829   // using 32-bit value at the end of 16-bit entries.
830   for (FileGot &Got : Gots) {
831     Got.Relocs.remove_if([&](const std::pair<Symbol *, size_t> &P) {
832       return Got.Global.count(P.first);
833     });
834     set_union(Got.Local16, Got.Local32);
835     Got.Local32.clear();
836   }
837
838   // Evaluate number of "reloc-only" entries in the resulting GOT.
839   // To do that put all unique "reloc-only" and "global" entries
840   // from all GOTs to the future primary GOT.
841   FileGot *PrimGot = &MergedGots.front();
842   for (FileGot &Got : Gots) {
843     set_union(PrimGot->Relocs, Got.Global);
844     set_union(PrimGot->Relocs, Got.Relocs);
845     Got.Relocs.clear();
846   }
847
848   // Evaluate number of "page" entries in each GOT.
849   for (FileGot &Got : Gots) {
850     for (std::pair<const OutputSection *, FileGot::PageBlock> &P :
851          Got.PagesMap) {
852       const OutputSection *OS = P.first;
853       uint64_t SecSize = 0;
854       for (BaseCommand *Cmd : OS->SectionCommands) {
855         if (auto *ISD = dyn_cast<InputSectionDescription>(Cmd))
856           for (InputSection *IS : ISD->Sections) {
857             uint64_t Off = alignTo(SecSize, IS->Alignment);
858             SecSize = Off + IS->getSize();
859           }
860       }
861       P.second.Count = getMipsPageCount(SecSize);
862     }
863   }
864
865   // Merge GOTs. Try to join as much as possible GOTs but do not exceed
866   // maximum GOT size. At first, try to fill the primary GOT because
867   // the primary GOT can be accessed in the most effective way. If it
868   // is not possible, try to fill the last GOT in the list, and finally
869   // create a new GOT if both attempts failed.
870   for (FileGot &SrcGot : Gots) {
871     InputFile *File = SrcGot.File;
872     if (tryMergeGots(MergedGots.front(), SrcGot, true)) {
873       File->MipsGotIndex = 0;
874     } else {
875       // If this is the first time we failed to merge with the primary GOT,
876       // MergedGots.back() will also be the primary GOT. We must make sure not
877       // to try to merge again with IsPrimary=false, as otherwise, if the
878       // inputs are just right, we could allow the primary GOT to become 1 or 2
879       // words too big due to ignoring the header size.
880       if (MergedGots.size() == 1 ||
881           !tryMergeGots(MergedGots.back(), SrcGot, false)) {
882         MergedGots.emplace_back();
883         std::swap(MergedGots.back(), SrcGot);
884       }
885       File->MipsGotIndex = MergedGots.size() - 1;
886     }
887   }
888   std::swap(Gots, MergedGots);
889
890   // Reduce number of "reloc-only" entries in the primary GOT
891   // by substracting "global" entries exist in the primary GOT.
892   PrimGot = &Gots.front();
893   PrimGot->Relocs.remove_if([&](const std::pair<Symbol *, size_t> &P) {
894     return PrimGot->Global.count(P.first);
895   });
896
897   // Calculate indexes for each GOT entry.
898   size_t Index = HeaderEntriesNum;
899   for (FileGot &Got : Gots) {
900     Got.StartIndex = &Got == PrimGot ? 0 : Index;
901     for (std::pair<const OutputSection *, FileGot::PageBlock> &P :
902          Got.PagesMap) {
903       // For each output section referenced by GOT page relocations calculate
904       // and save into PagesMap an upper bound of MIPS GOT entries required
905       // to store page addresses of local symbols. We assume the worst case -
906       // each 64kb page of the output section has at least one GOT relocation
907       // against it. And take in account the case when the section intersects
908       // page boundaries.
909       P.second.FirstIndex = Index;
910       Index += P.second.Count;
911     }
912     for (auto &P: Got.Local16)
913       P.second = Index++;
914     for (auto &P: Got.Global)
915       P.second = Index++;
916     for (auto &P: Got.Relocs)
917       P.second = Index++;
918     for (auto &P: Got.Tls)
919       P.second = Index++;
920     for (auto &P: Got.DynTlsSymbols) {
921       P.second = Index;
922       Index += 2;
923     }
924   }
925
926   // Update Symbol::GotIndex field to use this
927   // value later in the `sortMipsSymbols` function.
928   for (auto &P : PrimGot->Global)
929     P.first->GotIndex = P.second;
930   for (auto &P : PrimGot->Relocs)
931     P.first->GotIndex = P.second;
932
933   // Create dynamic relocations.
934   for (FileGot &Got : Gots) {
935     // Create dynamic relocations for TLS entries.
936     for (std::pair<Symbol *, size_t> &P : Got.Tls) {
937       Symbol *S = P.first;
938       uint64_t Offset = P.second * Config->Wordsize;
939       if (S->IsPreemptible)
940         InX::RelaDyn->addReloc(Target->TlsGotRel, this, Offset, S);
941     }
942     for (std::pair<Symbol *, size_t> &P : Got.DynTlsSymbols) {
943       Symbol *S = P.first;
944       uint64_t Offset = P.second * Config->Wordsize;
945       if (S == nullptr) {
946         if (!Config->Pic)
947           continue;
948         InX::RelaDyn->addReloc(Target->TlsModuleIndexRel, this, Offset, S);
949       } else {
950         // When building a shared library we still need a dynamic relocation
951         // for the module index. Therefore only checking for
952         // S->IsPreemptible is not sufficient (this happens e.g. for
953         // thread-locals that have been marked as local through a linker script)
954         if (!S->IsPreemptible && !Config->Pic)
955           continue;
956         InX::RelaDyn->addReloc(Target->TlsModuleIndexRel, this, Offset, S);
957         // However, we can skip writing the TLS offset reloc for non-preemptible
958         // symbols since it is known even in shared libraries
959         if (!S->IsPreemptible)
960           continue;
961         Offset += Config->Wordsize;
962         InX::RelaDyn->addReloc(Target->TlsOffsetRel, this, Offset, S);
963       }
964     }
965
966     // Do not create dynamic relocations for non-TLS
967     // entries in the primary GOT.
968     if (&Got == PrimGot)
969       continue;
970
971     // Dynamic relocations for "global" entries.
972     for (const std::pair<Symbol *, size_t> &P : Got.Global) {
973       uint64_t Offset = P.second * Config->Wordsize;
974       InX::RelaDyn->addReloc(Target->RelativeRel, this, Offset, P.first);
975     }
976     if (!Config->Pic)
977       continue;
978     // Dynamic relocations for "local" entries in case of PIC.
979     for (const std::pair<const OutputSection *, FileGot::PageBlock> &L :
980          Got.PagesMap) {
981       size_t PageCount = L.second.Count;
982       for (size_t PI = 0; PI < PageCount; ++PI) {
983         uint64_t Offset = (L.second.FirstIndex + PI) * Config->Wordsize;
984         InX::RelaDyn->addReloc({Target->RelativeRel, this, Offset, L.first,
985                                 int64_t(PI * 0x10000)});
986       }
987     }
988     for (const std::pair<GotEntry, size_t> &P : Got.Local16) {
989       uint64_t Offset = P.second * Config->Wordsize;
990       InX::RelaDyn->addReloc({Target->RelativeRel, this, Offset, true,
991                               P.first.first, P.first.second});
992     }
993   }
994 }
995
996 bool MipsGotSection::empty() const {
997   // We add the .got section to the result for dynamic MIPS target because
998   // its address and properties are mentioned in the .dynamic section.
999   return Config->Relocatable;
1000 }
1001
1002 uint64_t MipsGotSection::getGp(const InputFile *F) const {
1003   // For files without related GOT or files refer a primary GOT
1004   // returns "common" _gp value. For secondary GOTs calculate
1005   // individual _gp values.
1006   if (!F || !F->MipsGotIndex.hasValue() || *F->MipsGotIndex == 0)
1007     return ElfSym::MipsGp->getVA(0);
1008   return getVA() + Gots[*F->MipsGotIndex].StartIndex * Config->Wordsize +
1009          0x7ff0;
1010 }
1011
1012 void MipsGotSection::writeTo(uint8_t *Buf) {
1013   // Set the MSB of the second GOT slot. This is not required by any
1014   // MIPS ABI documentation, though.
1015   //
1016   // There is a comment in glibc saying that "The MSB of got[1] of a
1017   // gnu object is set to identify gnu objects," and in GNU gold it
1018   // says "the second entry will be used by some runtime loaders".
1019   // But how this field is being used is unclear.
1020   //
1021   // We are not really willing to mimic other linkers behaviors
1022   // without understanding why they do that, but because all files
1023   // generated by GNU tools have this special GOT value, and because
1024   // we've been doing this for years, it is probably a safe bet to
1025   // keep doing this for now. We really need to revisit this to see
1026   // if we had to do this.
1027   writeUint(Buf + Config->Wordsize, (uint64_t)1 << (Config->Wordsize * 8 - 1));
1028   for (const FileGot &G : Gots) {
1029     auto Write = [&](size_t I, const Symbol *S, int64_t A) {
1030       uint64_t VA = A;
1031       if (S) {
1032         VA = S->getVA(A);
1033         if (S->StOther & STO_MIPS_MICROMIPS)
1034           VA |= 1;
1035       }
1036       writeUint(Buf + I * Config->Wordsize, VA);
1037     };
1038     // Write 'page address' entries to the local part of the GOT.
1039     for (const std::pair<const OutputSection *, FileGot::PageBlock> &L :
1040          G.PagesMap) {
1041       size_t PageCount = L.second.Count;
1042       uint64_t FirstPageAddr = getMipsPageAddr(L.first->Addr);
1043       for (size_t PI = 0; PI < PageCount; ++PI)
1044         Write(L.second.FirstIndex + PI, nullptr, FirstPageAddr + PI * 0x10000);
1045     }
1046     // Local, global, TLS, reloc-only  entries.
1047     // If TLS entry has a corresponding dynamic relocations, leave it
1048     // initialized by zero. Write down adjusted TLS symbol's values otherwise.
1049     // To calculate the adjustments use offsets for thread-local storage.
1050     // https://www.linux-mips.org/wiki/NPTL
1051     for (const std::pair<GotEntry, size_t> &P : G.Local16)
1052       Write(P.second, P.first.first, P.first.second);
1053     // Write VA to the primary GOT only. For secondary GOTs that
1054     // will be done by REL32 dynamic relocations.
1055     if (&G == &Gots.front())
1056       for (const std::pair<const Symbol *, size_t> &P : G.Global)
1057         Write(P.second, P.first, 0);
1058     for (const std::pair<Symbol *, size_t> &P : G.Relocs)
1059       Write(P.second, P.first, 0);
1060     for (const std::pair<Symbol *, size_t> &P : G.Tls)
1061       Write(P.second, P.first, P.first->IsPreemptible ? 0 : -0x7000);
1062     for (const std::pair<Symbol *, size_t> &P : G.DynTlsSymbols) {
1063       if (P.first == nullptr && !Config->Pic)
1064         Write(P.second, nullptr, 1);
1065       else if (P.first && !P.first->IsPreemptible) {
1066         // If we are emitting PIC code with relocations we mustn't write
1067         // anything to the GOT here. When using Elf_Rel relocations the value
1068         // one will be treated as an addend and will cause crashes at runtime
1069         if (!Config->Pic)
1070           Write(P.second, nullptr, 1);
1071         Write(P.second + 1, P.first, -0x8000);
1072       }
1073     }
1074   }
1075 }
1076
1077 // On PowerPC the .plt section is used to hold the table of function addresses
1078 // instead of the .got.plt, and the type is SHT_NOBITS similar to a .bss
1079 // section. I don't know why we have a BSS style type for the section but it is
1080 // consitent across both 64-bit PowerPC ABIs as well as the 32-bit PowerPC ABI.
1081 GotPltSection::GotPltSection()
1082     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
1083                        Config->EMachine == EM_PPC64 ? SHT_NOBITS : SHT_PROGBITS,
1084                        Target->GotPltEntrySize,
1085                        Config->EMachine == EM_PPC64 ? ".plt" : ".got.plt") {}
1086
1087 void GotPltSection::addEntry(Symbol &Sym) {
1088   assert(Sym.PltIndex == Entries.size());
1089   Entries.push_back(&Sym);
1090 }
1091
1092 size_t GotPltSection::getSize() const {
1093   return (Target->GotPltHeaderEntriesNum + Entries.size()) *
1094          Target->GotPltEntrySize;
1095 }
1096
1097 void GotPltSection::writeTo(uint8_t *Buf) {
1098   Target->writeGotPltHeader(Buf);
1099   Buf += Target->GotPltHeaderEntriesNum * Target->GotPltEntrySize;
1100   for (const Symbol *B : Entries) {
1101     Target->writeGotPlt(Buf, *B);
1102     Buf += Config->Wordsize;
1103   }
1104 }
1105
1106 bool GotPltSection::empty() const {
1107   // We need to emit a GOT.PLT even if it's empty if there's a symbol that
1108   // references the _GLOBAL_OFFSET_TABLE_ and the Target defines the symbol
1109   // relative to the .got.plt section.
1110   return Entries.empty() &&
1111          !(ElfSym::GlobalOffsetTable && Target->GotBaseSymInGotPlt);
1112 }
1113
1114 static StringRef getIgotPltName() {
1115   // On ARM the IgotPltSection is part of the GotSection.
1116   if (Config->EMachine == EM_ARM)
1117     return ".got";
1118
1119   // On PowerPC64 the GotPltSection is renamed to '.plt' so the IgotPltSection
1120   // needs to be named the same.
1121   if (Config->EMachine == EM_PPC64)
1122     return ".plt";
1123
1124   return ".got.plt";
1125 }
1126
1127 // On PowerPC64 the GotPltSection type is SHT_NOBITS so we have to follow suit
1128 // with the IgotPltSection.
1129 IgotPltSection::IgotPltSection()
1130     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
1131                        Config->EMachine == EM_PPC64 ? SHT_NOBITS : SHT_PROGBITS,
1132                        Target->GotPltEntrySize, getIgotPltName()) {}
1133
1134 void IgotPltSection::addEntry(Symbol &Sym) {
1135   Sym.IsInIgot = true;
1136   assert(Sym.PltIndex == Entries.size());
1137   Entries.push_back(&Sym);
1138 }
1139
1140 size_t IgotPltSection::getSize() const {
1141   return Entries.size() * Target->GotPltEntrySize;
1142 }
1143
1144 void IgotPltSection::writeTo(uint8_t *Buf) {
1145   for (const Symbol *B : Entries) {
1146     Target->writeIgotPlt(Buf, *B);
1147     Buf += Config->Wordsize;
1148   }
1149 }
1150
1151 StringTableSection::StringTableSection(StringRef Name, bool Dynamic)
1152     : SyntheticSection(Dynamic ? (uint64_t)SHF_ALLOC : 0, SHT_STRTAB, 1, Name),
1153       Dynamic(Dynamic) {
1154   // ELF string tables start with a NUL byte.
1155   addString("");
1156 }
1157
1158 // Adds a string to the string table. If HashIt is true we hash and check for
1159 // duplicates. It is optional because the name of global symbols are already
1160 // uniqued and hashing them again has a big cost for a small value: uniquing
1161 // them with some other string that happens to be the same.
1162 unsigned StringTableSection::addString(StringRef S, bool HashIt) {
1163   if (HashIt) {
1164     auto R = StringMap.insert(std::make_pair(S, this->Size));
1165     if (!R.second)
1166       return R.first->second;
1167   }
1168   unsigned Ret = this->Size;
1169   this->Size = this->Size + S.size() + 1;
1170   Strings.push_back(S);
1171   return Ret;
1172 }
1173
1174 void StringTableSection::writeTo(uint8_t *Buf) {
1175   for (StringRef S : Strings) {
1176     memcpy(Buf, S.data(), S.size());
1177     Buf[S.size()] = '\0';
1178     Buf += S.size() + 1;
1179   }
1180 }
1181
1182 // Returns the number of version definition entries. Because the first entry
1183 // is for the version definition itself, it is the number of versioned symbols
1184 // plus one. Note that we don't support multiple versions yet.
1185 static unsigned getVerDefNum() { return Config->VersionDefinitions.size() + 1; }
1186
1187 template <class ELFT>
1188 DynamicSection<ELFT>::DynamicSection()
1189     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_DYNAMIC, Config->Wordsize,
1190                        ".dynamic") {
1191   this->Entsize = ELFT::Is64Bits ? 16 : 8;
1192
1193   // .dynamic section is not writable on MIPS and on Fuchsia OS
1194   // which passes -z rodynamic.
1195   // See "Special Section" in Chapter 4 in the following document:
1196   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1197   if (Config->EMachine == EM_MIPS || Config->ZRodynamic)
1198     this->Flags = SHF_ALLOC;
1199
1200   // Add strings to .dynstr early so that .dynstr's size will be
1201   // fixed early.
1202   for (StringRef S : Config->FilterList)
1203     addInt(DT_FILTER, InX::DynStrTab->addString(S));
1204   for (StringRef S : Config->AuxiliaryList)
1205     addInt(DT_AUXILIARY, InX::DynStrTab->addString(S));
1206
1207   if (!Config->Rpath.empty())
1208     addInt(Config->EnableNewDtags ? DT_RUNPATH : DT_RPATH,
1209            InX::DynStrTab->addString(Config->Rpath));
1210
1211   for (InputFile *File : SharedFiles) {
1212     SharedFile<ELFT> *F = cast<SharedFile<ELFT>>(File);
1213     if (F->IsNeeded)
1214       addInt(DT_NEEDED, InX::DynStrTab->addString(F->SoName));
1215   }
1216   if (!Config->SoName.empty())
1217     addInt(DT_SONAME, InX::DynStrTab->addString(Config->SoName));
1218 }
1219
1220 template <class ELFT>
1221 void DynamicSection<ELFT>::add(int32_t Tag, std::function<uint64_t()> Fn) {
1222   Entries.push_back({Tag, Fn});
1223 }
1224
1225 template <class ELFT>
1226 void DynamicSection<ELFT>::addInt(int32_t Tag, uint64_t Val) {
1227   Entries.push_back({Tag, [=] { return Val; }});
1228 }
1229
1230 template <class ELFT>
1231 void DynamicSection<ELFT>::addInSec(int32_t Tag, InputSection *Sec) {
1232   Entries.push_back({Tag, [=] { return Sec->getVA(0); }});
1233 }
1234
1235 template <class ELFT>
1236 void DynamicSection<ELFT>::addInSecRelative(int32_t Tag, InputSection *Sec) {
1237   size_t TagOffset = Entries.size() * Entsize;
1238   Entries.push_back(
1239       {Tag, [=] { return Sec->getVA(0) - (getVA() + TagOffset); }});
1240 }
1241
1242 template <class ELFT>
1243 void DynamicSection<ELFT>::addOutSec(int32_t Tag, OutputSection *Sec) {
1244   Entries.push_back({Tag, [=] { return Sec->Addr; }});
1245 }
1246
1247 template <class ELFT>
1248 void DynamicSection<ELFT>::addSize(int32_t Tag, OutputSection *Sec) {
1249   Entries.push_back({Tag, [=] { return Sec->Size; }});
1250 }
1251
1252 template <class ELFT>
1253 void DynamicSection<ELFT>::addSym(int32_t Tag, Symbol *Sym) {
1254   Entries.push_back({Tag, [=] { return Sym->getVA(); }});
1255 }
1256
1257 // Add remaining entries to complete .dynamic contents.
1258 template <class ELFT> void DynamicSection<ELFT>::finalizeContents() {
1259   if (this->Size)
1260     return; // Already finalized.
1261
1262   // Set DT_FLAGS and DT_FLAGS_1.
1263   uint32_t DtFlags = 0;
1264   uint32_t DtFlags1 = 0;
1265   if (Config->Bsymbolic)
1266     DtFlags |= DF_SYMBOLIC;
1267   if (Config->ZInitfirst)
1268     DtFlags1 |= DF_1_INITFIRST;
1269   if (Config->ZInterpose)
1270     DtFlags1 |= DF_1_INTERPOSE;
1271   if (Config->ZNodelete)
1272     DtFlags1 |= DF_1_NODELETE;
1273   if (Config->ZNodlopen)
1274     DtFlags1 |= DF_1_NOOPEN;
1275   if (Config->ZNow) {
1276     DtFlags |= DF_BIND_NOW;
1277     DtFlags1 |= DF_1_NOW;
1278   }
1279   if (Config->ZOrigin) {
1280     DtFlags |= DF_ORIGIN;
1281     DtFlags1 |= DF_1_ORIGIN;
1282   }
1283   if (!Config->ZText)
1284     DtFlags |= DF_TEXTREL;
1285   if (Config->HasStaticTlsModel)
1286     DtFlags |= DF_STATIC_TLS;
1287
1288   if (DtFlags)
1289     addInt(DT_FLAGS, DtFlags);
1290   if (DtFlags1)
1291     addInt(DT_FLAGS_1, DtFlags1);
1292
1293   // DT_DEBUG is a pointer to debug informaion used by debuggers at runtime. We
1294   // need it for each process, so we don't write it for DSOs. The loader writes
1295   // the pointer into this entry.
1296   //
1297   // DT_DEBUG is the only .dynamic entry that needs to be written to. Some
1298   // systems (currently only Fuchsia OS) provide other means to give the
1299   // debugger this information. Such systems may choose make .dynamic read-only.
1300   // If the target is such a system (used -z rodynamic) don't write DT_DEBUG.
1301   if (!Config->Shared && !Config->Relocatable && !Config->ZRodynamic)
1302     addInt(DT_DEBUG, 0);
1303
1304   this->Link = InX::DynStrTab->getParent()->SectionIndex;
1305   if (!InX::RelaDyn->empty()) {
1306     addInSec(InX::RelaDyn->DynamicTag, InX::RelaDyn);
1307     addSize(InX::RelaDyn->SizeDynamicTag, InX::RelaDyn->getParent());
1308
1309     bool IsRela = Config->IsRela;
1310     addInt(IsRela ? DT_RELAENT : DT_RELENT,
1311            IsRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel));
1312
1313     // MIPS dynamic loader does not support RELCOUNT tag.
1314     // The problem is in the tight relation between dynamic
1315     // relocations and GOT. So do not emit this tag on MIPS.
1316     if (Config->EMachine != EM_MIPS) {
1317       size_t NumRelativeRels = InX::RelaDyn->getRelativeRelocCount();
1318       if (Config->ZCombreloc && NumRelativeRels)
1319         addInt(IsRela ? DT_RELACOUNT : DT_RELCOUNT, NumRelativeRels);
1320     }
1321   }
1322   if (InX::RelrDyn && !InX::RelrDyn->Relocs.empty()) {
1323     addInSec(Config->UseAndroidRelrTags ? DT_ANDROID_RELR : DT_RELR,
1324              InX::RelrDyn);
1325     addSize(Config->UseAndroidRelrTags ? DT_ANDROID_RELRSZ : DT_RELRSZ,
1326             InX::RelrDyn->getParent());
1327     addInt(Config->UseAndroidRelrTags ? DT_ANDROID_RELRENT : DT_RELRENT,
1328            sizeof(Elf_Relr));
1329   }
1330   // .rel[a].plt section usually consists of two parts, containing plt and
1331   // iplt relocations. It is possible to have only iplt relocations in the
1332   // output. In that case RelaPlt is empty and have zero offset, the same offset
1333   // as RelaIplt have. And we still want to emit proper dynamic tags for that
1334   // case, so here we always use RelaPlt as marker for the begining of
1335   // .rel[a].plt section.
1336   if (InX::RelaPlt->getParent()->Live) {
1337     addInSec(DT_JMPREL, InX::RelaPlt);
1338     addSize(DT_PLTRELSZ, InX::RelaPlt->getParent());
1339     switch (Config->EMachine) {
1340     case EM_MIPS:
1341       addInSec(DT_MIPS_PLTGOT, InX::GotPlt);
1342       break;
1343     case EM_SPARCV9:
1344       addInSec(DT_PLTGOT, InX::Plt);
1345       break;
1346     default:
1347       addInSec(DT_PLTGOT, InX::GotPlt);
1348       break;
1349     }
1350     addInt(DT_PLTREL, Config->IsRela ? DT_RELA : DT_REL);
1351   }
1352
1353   addInSec(DT_SYMTAB, InX::DynSymTab);
1354   addInt(DT_SYMENT, sizeof(Elf_Sym));
1355   addInSec(DT_STRTAB, InX::DynStrTab);
1356   addInt(DT_STRSZ, InX::DynStrTab->getSize());
1357   if (!Config->ZText)
1358     addInt(DT_TEXTREL, 0);
1359   if (InX::GnuHashTab)
1360     addInSec(DT_GNU_HASH, InX::GnuHashTab);
1361   if (InX::HashTab)
1362     addInSec(DT_HASH, InX::HashTab);
1363
1364   if (Out::PreinitArray) {
1365     addOutSec(DT_PREINIT_ARRAY, Out::PreinitArray);
1366     addSize(DT_PREINIT_ARRAYSZ, Out::PreinitArray);
1367   }
1368   if (Out::InitArray) {
1369     addOutSec(DT_INIT_ARRAY, Out::InitArray);
1370     addSize(DT_INIT_ARRAYSZ, Out::InitArray);
1371   }
1372   if (Out::FiniArray) {
1373     addOutSec(DT_FINI_ARRAY, Out::FiniArray);
1374     addSize(DT_FINI_ARRAYSZ, Out::FiniArray);
1375   }
1376
1377   if (Symbol *B = Symtab->find(Config->Init))
1378     if (B->isDefined())
1379       addSym(DT_INIT, B);
1380   if (Symbol *B = Symtab->find(Config->Fini))
1381     if (B->isDefined())
1382       addSym(DT_FINI, B);
1383
1384   bool HasVerNeed = In<ELFT>::VerNeed->getNeedNum() != 0;
1385   if (HasVerNeed || In<ELFT>::VerDef)
1386     addInSec(DT_VERSYM, In<ELFT>::VerSym);
1387   if (In<ELFT>::VerDef) {
1388     addInSec(DT_VERDEF, In<ELFT>::VerDef);
1389     addInt(DT_VERDEFNUM, getVerDefNum());
1390   }
1391   if (HasVerNeed) {
1392     addInSec(DT_VERNEED, In<ELFT>::VerNeed);
1393     addInt(DT_VERNEEDNUM, In<ELFT>::VerNeed->getNeedNum());
1394   }
1395
1396   if (Config->EMachine == EM_MIPS) {
1397     addInt(DT_MIPS_RLD_VERSION, 1);
1398     addInt(DT_MIPS_FLAGS, RHF_NOTPOT);
1399     addInt(DT_MIPS_BASE_ADDRESS, Target->getImageBase());
1400     addInt(DT_MIPS_SYMTABNO, InX::DynSymTab->getNumSymbols());
1401
1402     add(DT_MIPS_LOCAL_GOTNO, [] { return InX::MipsGot->getLocalEntriesNum(); });
1403
1404     if (const Symbol *B = InX::MipsGot->getFirstGlobalEntry())
1405       addInt(DT_MIPS_GOTSYM, B->DynsymIndex);
1406     else
1407       addInt(DT_MIPS_GOTSYM, InX::DynSymTab->getNumSymbols());
1408     addInSec(DT_PLTGOT, InX::MipsGot);
1409     if (InX::MipsRldMap) {
1410       if (!Config->Pie)
1411         addInSec(DT_MIPS_RLD_MAP, InX::MipsRldMap);
1412       // Store the offset to the .rld_map section
1413       // relative to the address of the tag.
1414       addInSecRelative(DT_MIPS_RLD_MAP_REL, InX::MipsRldMap);
1415     }
1416   }
1417
1418   // Glink dynamic tag is required by the V2 abi if the plt section isn't empty.
1419   if (Config->EMachine == EM_PPC64 && !InX::Plt->empty()) {
1420     // The Glink tag points to 32 bytes before the first lazy symbol resolution
1421     // stub, which starts directly after the header.
1422     Entries.push_back({DT_PPC64_GLINK, [=] {
1423                          unsigned Offset = Target->PltHeaderSize - 32;
1424                          return InX::Plt->getVA(0) + Offset;
1425                        }});
1426   }
1427
1428   addInt(DT_NULL, 0);
1429
1430   getParent()->Link = this->Link;
1431   this->Size = Entries.size() * this->Entsize;
1432 }
1433
1434 template <class ELFT> void DynamicSection<ELFT>::writeTo(uint8_t *Buf) {
1435   auto *P = reinterpret_cast<Elf_Dyn *>(Buf);
1436
1437   for (std::pair<int32_t, std::function<uint64_t()>> &KV : Entries) {
1438     P->d_tag = KV.first;
1439     P->d_un.d_val = KV.second();
1440     ++P;
1441   }
1442 }
1443
1444 uint64_t DynamicReloc::getOffset() const {
1445   return InputSec->getVA(OffsetInSec);
1446 }
1447
1448 int64_t DynamicReloc::computeAddend() const {
1449   if (UseSymVA)
1450     return Sym->getVA(Addend);
1451   if (!OutputSec)
1452     return Addend;
1453   // See the comment in the DynamicReloc ctor.
1454   return getMipsPageAddr(OutputSec->Addr) + Addend;
1455 }
1456
1457 uint32_t DynamicReloc::getSymIndex() const {
1458   if (Sym && !UseSymVA)
1459     return Sym->DynsymIndex;
1460   return 0;
1461 }
1462
1463 RelocationBaseSection::RelocationBaseSection(StringRef Name, uint32_t Type,
1464                                              int32_t DynamicTag,
1465                                              int32_t SizeDynamicTag)
1466     : SyntheticSection(SHF_ALLOC, Type, Config->Wordsize, Name),
1467       DynamicTag(DynamicTag), SizeDynamicTag(SizeDynamicTag) {}
1468
1469 void RelocationBaseSection::addReloc(RelType DynType, InputSectionBase *IS,
1470                                      uint64_t OffsetInSec, Symbol *Sym) {
1471   addReloc({DynType, IS, OffsetInSec, false, Sym, 0});
1472 }
1473
1474 void RelocationBaseSection::addReloc(RelType DynType,
1475                                      InputSectionBase *InputSec,
1476                                      uint64_t OffsetInSec, Symbol *Sym,
1477                                      int64_t Addend, RelExpr Expr,
1478                                      RelType Type) {
1479   // Write the addends to the relocated address if required. We skip
1480   // it if the written value would be zero.
1481   if (Config->WriteAddends && (Expr != R_ADDEND || Addend != 0))
1482     InputSec->Relocations.push_back({Expr, Type, OffsetInSec, Addend, Sym});
1483   addReloc({DynType, InputSec, OffsetInSec, Expr != R_ADDEND, Sym, Addend});
1484 }
1485
1486 void RelocationBaseSection::addReloc(const DynamicReloc &Reloc) {
1487   if (Reloc.Type == Target->RelativeRel)
1488     ++NumRelativeRelocs;
1489   Relocs.push_back(Reloc);
1490 }
1491
1492 void RelocationBaseSection::finalizeContents() {
1493   // If all relocations are R_*_RELATIVE they don't refer to any
1494   // dynamic symbol and we don't need a dynamic symbol table. If that
1495   // is the case, just use the index of the regular symbol table section.
1496   getParent()->Link = InX::DynSymTab ?
1497     InX::DynSymTab->getParent()->SectionIndex :
1498     InX::SymTab->getParent()->SectionIndex;
1499
1500   if (InX::RelaIplt == this || InX::RelaPlt == this)
1501     getParent()->Info = InX::GotPlt->getParent()->SectionIndex;
1502 }
1503
1504 RelrBaseSection::RelrBaseSection()
1505     : SyntheticSection(SHF_ALLOC,
1506                        Config->UseAndroidRelrTags ? SHT_ANDROID_RELR : SHT_RELR,
1507                        Config->Wordsize, ".relr.dyn") {}
1508
1509 template <class ELFT>
1510 static void encodeDynamicReloc(typename ELFT::Rela *P,
1511                                const DynamicReloc &Rel) {
1512   if (Config->IsRela)
1513     P->r_addend = Rel.computeAddend();
1514   P->r_offset = Rel.getOffset();
1515   P->setSymbolAndType(Rel.getSymIndex(), Rel.Type, Config->IsMips64EL);
1516 }
1517
1518 template <class ELFT>
1519 RelocationSection<ELFT>::RelocationSection(StringRef Name, bool Sort)
1520     : RelocationBaseSection(Name, Config->IsRela ? SHT_RELA : SHT_REL,
1521                             Config->IsRela ? DT_RELA : DT_REL,
1522                             Config->IsRela ? DT_RELASZ : DT_RELSZ),
1523       Sort(Sort) {
1524   this->Entsize = Config->IsRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1525 }
1526
1527 static bool compRelocations(const DynamicReloc &A, const DynamicReloc &B) {
1528   bool AIsRel = A.Type == Target->RelativeRel;
1529   bool BIsRel = B.Type == Target->RelativeRel;
1530   if (AIsRel != BIsRel)
1531     return AIsRel;
1532   return A.getSymIndex() < B.getSymIndex();
1533 }
1534
1535 template <class ELFT> void RelocationSection<ELFT>::writeTo(uint8_t *Buf) {
1536   if (Sort)
1537     std::stable_sort(Relocs.begin(), Relocs.end(), compRelocations);
1538
1539   for (const DynamicReloc &Rel : Relocs) {
1540     encodeDynamicReloc<ELFT>(reinterpret_cast<Elf_Rela *>(Buf), Rel);
1541     Buf += Config->IsRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
1542   }
1543 }
1544
1545 template <class ELFT> unsigned RelocationSection<ELFT>::getRelocOffset() {
1546   return this->Entsize * Relocs.size();
1547 }
1548
1549 template <class ELFT>
1550 AndroidPackedRelocationSection<ELFT>::AndroidPackedRelocationSection(
1551     StringRef Name)
1552     : RelocationBaseSection(
1553           Name, Config->IsRela ? SHT_ANDROID_RELA : SHT_ANDROID_REL,
1554           Config->IsRela ? DT_ANDROID_RELA : DT_ANDROID_REL,
1555           Config->IsRela ? DT_ANDROID_RELASZ : DT_ANDROID_RELSZ) {
1556   this->Entsize = 1;
1557 }
1558
1559 template <class ELFT>
1560 bool AndroidPackedRelocationSection<ELFT>::updateAllocSize() {
1561   // This function computes the contents of an Android-format packed relocation
1562   // section.
1563   //
1564   // This format compresses relocations by using relocation groups to factor out
1565   // fields that are common between relocations and storing deltas from previous
1566   // relocations in SLEB128 format (which has a short representation for small
1567   // numbers). A good example of a relocation type with common fields is
1568   // R_*_RELATIVE, which is normally used to represent function pointers in
1569   // vtables. In the REL format, each relative relocation has the same r_info
1570   // field, and is only different from other relative relocations in terms of
1571   // the r_offset field. By sorting relocations by offset, grouping them by
1572   // r_info and representing each relocation with only the delta from the
1573   // previous offset, each 8-byte relocation can be compressed to as little as 1
1574   // byte (or less with run-length encoding). This relocation packer was able to
1575   // reduce the size of the relocation section in an Android Chromium DSO from
1576   // 2,911,184 bytes to 174,693 bytes, or 6% of the original size.
1577   //
1578   // A relocation section consists of a header containing the literal bytes
1579   // 'APS2' followed by a sequence of SLEB128-encoded integers. The first two
1580   // elements are the total number of relocations in the section and an initial
1581   // r_offset value. The remaining elements define a sequence of relocation
1582   // groups. Each relocation group starts with a header consisting of the
1583   // following elements:
1584   //
1585   // - the number of relocations in the relocation group
1586   // - flags for the relocation group
1587   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is set) the r_offset delta
1588   //   for each relocation in the group.
1589   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is set) the value of the r_info
1590   //   field for each relocation in the group.
1591   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG and
1592   //   RELOCATION_GROUPED_BY_ADDEND_FLAG are set) the r_addend delta for
1593   //   each relocation in the group.
1594   //
1595   // Following the relocation group header are descriptions of each of the
1596   // relocations in the group. They consist of the following elements:
1597   //
1598   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is not set) the r_offset
1599   //   delta for this relocation.
1600   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is not set) the value of the r_info
1601   //   field for this relocation.
1602   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG is set and
1603   //   RELOCATION_GROUPED_BY_ADDEND_FLAG is not set) the r_addend delta for
1604   //   this relocation.
1605
1606   size_t OldSize = RelocData.size();
1607
1608   RelocData = {'A', 'P', 'S', '2'};
1609   raw_svector_ostream OS(RelocData);
1610   auto Add = [&](int64_t V) { encodeSLEB128(V, OS); };
1611
1612   // The format header includes the number of relocations and the initial
1613   // offset (we set this to zero because the first relocation group will
1614   // perform the initial adjustment).
1615   Add(Relocs.size());
1616   Add(0);
1617
1618   std::vector<Elf_Rela> Relatives, NonRelatives;
1619
1620   for (const DynamicReloc &Rel : Relocs) {
1621     Elf_Rela R;
1622     encodeDynamicReloc<ELFT>(&R, Rel);
1623
1624     if (R.getType(Config->IsMips64EL) == Target->RelativeRel)
1625       Relatives.push_back(R);
1626     else
1627       NonRelatives.push_back(R);
1628   }
1629
1630   llvm::sort(Relatives.begin(), Relatives.end(),
1631              [](const Elf_Rel &A, const Elf_Rel &B) {
1632                return A.r_offset < B.r_offset;
1633              });
1634
1635   // Try to find groups of relative relocations which are spaced one word
1636   // apart from one another. These generally correspond to vtable entries. The
1637   // format allows these groups to be encoded using a sort of run-length
1638   // encoding, but each group will cost 7 bytes in addition to the offset from
1639   // the previous group, so it is only profitable to do this for groups of
1640   // size 8 or larger.
1641   std::vector<Elf_Rela> UngroupedRelatives;
1642   std::vector<std::vector<Elf_Rela>> RelativeGroups;
1643   for (auto I = Relatives.begin(), E = Relatives.end(); I != E;) {
1644     std::vector<Elf_Rela> Group;
1645     do {
1646       Group.push_back(*I++);
1647     } while (I != E && (I - 1)->r_offset + Config->Wordsize == I->r_offset);
1648
1649     if (Group.size() < 8)
1650       UngroupedRelatives.insert(UngroupedRelatives.end(), Group.begin(),
1651                                 Group.end());
1652     else
1653       RelativeGroups.emplace_back(std::move(Group));
1654   }
1655
1656   unsigned HasAddendIfRela =
1657       Config->IsRela ? RELOCATION_GROUP_HAS_ADDEND_FLAG : 0;
1658
1659   uint64_t Offset = 0;
1660   uint64_t Addend = 0;
1661
1662   // Emit the run-length encoding for the groups of adjacent relative
1663   // relocations. Each group is represented using two groups in the packed
1664   // format. The first is used to set the current offset to the start of the
1665   // group (and also encodes the first relocation), and the second encodes the
1666   // remaining relocations.
1667   for (std::vector<Elf_Rela> &G : RelativeGroups) {
1668     // The first relocation in the group.
1669     Add(1);
1670     Add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1671         RELOCATION_GROUPED_BY_INFO_FLAG | HasAddendIfRela);
1672     Add(G[0].r_offset - Offset);
1673     Add(Target->RelativeRel);
1674     if (Config->IsRela) {
1675       Add(G[0].r_addend - Addend);
1676       Addend = G[0].r_addend;
1677     }
1678
1679     // The remaining relocations.
1680     Add(G.size() - 1);
1681     Add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
1682         RELOCATION_GROUPED_BY_INFO_FLAG | HasAddendIfRela);
1683     Add(Config->Wordsize);
1684     Add(Target->RelativeRel);
1685     if (Config->IsRela) {
1686       for (auto I = G.begin() + 1, E = G.end(); I != E; ++I) {
1687         Add(I->r_addend - Addend);
1688         Addend = I->r_addend;
1689       }
1690     }
1691
1692     Offset = G.back().r_offset;
1693   }
1694
1695   // Now the ungrouped relatives.
1696   if (!UngroupedRelatives.empty()) {
1697     Add(UngroupedRelatives.size());
1698     Add(RELOCATION_GROUPED_BY_INFO_FLAG | HasAddendIfRela);
1699     Add(Target->RelativeRel);
1700     for (Elf_Rela &R : UngroupedRelatives) {
1701       Add(R.r_offset - Offset);
1702       Offset = R.r_offset;
1703       if (Config->IsRela) {
1704         Add(R.r_addend - Addend);
1705         Addend = R.r_addend;
1706       }
1707     }
1708   }
1709
1710   // Finally the non-relative relocations.
1711   llvm::sort(NonRelatives.begin(), NonRelatives.end(),
1712              [](const Elf_Rela &A, const Elf_Rela &B) {
1713                return A.r_offset < B.r_offset;
1714              });
1715   if (!NonRelatives.empty()) {
1716     Add(NonRelatives.size());
1717     Add(HasAddendIfRela);
1718     for (Elf_Rela &R : NonRelatives) {
1719       Add(R.r_offset - Offset);
1720       Offset = R.r_offset;
1721       Add(R.r_info);
1722       if (Config->IsRela) {
1723         Add(R.r_addend - Addend);
1724         Addend = R.r_addend;
1725       }
1726     }
1727   }
1728
1729   // Returns whether the section size changed. We need to keep recomputing both
1730   // section layout and the contents of this section until the size converges
1731   // because changing this section's size can affect section layout, which in
1732   // turn can affect the sizes of the LEB-encoded integers stored in this
1733   // section.
1734   return RelocData.size() != OldSize;
1735 }
1736
1737 template <class ELFT> RelrSection<ELFT>::RelrSection() {
1738   this->Entsize = Config->Wordsize;
1739 }
1740
1741 template <class ELFT> bool RelrSection<ELFT>::updateAllocSize() {
1742   // This function computes the contents of an SHT_RELR packed relocation
1743   // section.
1744   //
1745   // Proposal for adding SHT_RELR sections to generic-abi is here:
1746   //   https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
1747   //
1748   // The encoded sequence of Elf64_Relr entries in a SHT_RELR section looks
1749   // like [ AAAAAAAA BBBBBBB1 BBBBBBB1 ... AAAAAAAA BBBBBB1 ... ]
1750   //
1751   // i.e. start with an address, followed by any number of bitmaps. The address
1752   // entry encodes 1 relocation. The subsequent bitmap entries encode up to 63
1753   // relocations each, at subsequent offsets following the last address entry.
1754   //
1755   // The bitmap entries must have 1 in the least significant bit. The assumption
1756   // here is that an address cannot have 1 in lsb. Odd addresses are not
1757   // supported.
1758   //
1759   // Excluding the least significant bit in the bitmap, each non-zero bit in
1760   // the bitmap represents a relocation to be applied to a corresponding machine
1761   // word that follows the base address word. The second least significant bit
1762   // represents the machine word immediately following the initial address, and
1763   // each bit that follows represents the next word, in linear order. As such,
1764   // a single bitmap can encode up to 31 relocations in a 32-bit object, and
1765   // 63 relocations in a 64-bit object.
1766   //
1767   // This encoding has a couple of interesting properties:
1768   // 1. Looking at any entry, it is clear whether it's an address or a bitmap:
1769   //    even means address, odd means bitmap.
1770   // 2. Just a simple list of addresses is a valid encoding.
1771
1772   size_t OldSize = RelrRelocs.size();
1773   RelrRelocs.clear();
1774
1775   // Same as Config->Wordsize but faster because this is a compile-time
1776   // constant.
1777   const size_t Wordsize = sizeof(typename ELFT::uint);
1778
1779   // Number of bits to use for the relocation offsets bitmap.
1780   // Must be either 63 or 31.
1781   const size_t NBits = Wordsize * 8 - 1;
1782
1783   // Get offsets for all relative relocations and sort them.
1784   std::vector<uint64_t> Offsets;
1785   for (const RelativeReloc &Rel : Relocs)
1786     Offsets.push_back(Rel.getOffset());
1787   llvm::sort(Offsets.begin(), Offsets.end());
1788
1789   // For each leading relocation, find following ones that can be folded
1790   // as a bitmap and fold them.
1791   for (size_t I = 0, E = Offsets.size(); I < E;) {
1792     // Add a leading relocation.
1793     RelrRelocs.push_back(Elf_Relr(Offsets[I]));
1794     uint64_t Base = Offsets[I] + Wordsize;
1795     ++I;
1796
1797     // Find foldable relocations to construct bitmaps.
1798     while (I < E) {
1799       uint64_t Bitmap = 0;
1800
1801       while (I < E) {
1802         uint64_t Delta = Offsets[I] - Base;
1803
1804         // If it is too far, it cannot be folded.
1805         if (Delta >= NBits * Wordsize)
1806           break;
1807
1808         // If it is not a multiple of wordsize away, it cannot be folded.
1809         if (Delta % Wordsize)
1810           break;
1811
1812         // Fold it.
1813         Bitmap |= 1ULL << (Delta / Wordsize);
1814         ++I;
1815       }
1816
1817       if (!Bitmap)
1818         break;
1819
1820       RelrRelocs.push_back(Elf_Relr((Bitmap << 1) | 1));
1821       Base += NBits * Wordsize;
1822     }
1823   }
1824
1825   return RelrRelocs.size() != OldSize;
1826 }
1827
1828 SymbolTableBaseSection::SymbolTableBaseSection(StringTableSection &StrTabSec)
1829     : SyntheticSection(StrTabSec.isDynamic() ? (uint64_t)SHF_ALLOC : 0,
1830                        StrTabSec.isDynamic() ? SHT_DYNSYM : SHT_SYMTAB,
1831                        Config->Wordsize,
1832                        StrTabSec.isDynamic() ? ".dynsym" : ".symtab"),
1833       StrTabSec(StrTabSec) {}
1834
1835 // Orders symbols according to their positions in the GOT,
1836 // in compliance with MIPS ABI rules.
1837 // See "Global Offset Table" in Chapter 5 in the following document
1838 // for detailed description:
1839 // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1840 static bool sortMipsSymbols(const SymbolTableEntry &L,
1841                             const SymbolTableEntry &R) {
1842   // Sort entries related to non-local preemptible symbols by GOT indexes.
1843   // All other entries go to the beginning of a dynsym in arbitrary order.
1844   if (L.Sym->isInGot() && R.Sym->isInGot())
1845     return L.Sym->GotIndex < R.Sym->GotIndex;
1846   if (!L.Sym->isInGot() && !R.Sym->isInGot())
1847     return false;
1848   return !L.Sym->isInGot();
1849 }
1850
1851 void SymbolTableBaseSection::finalizeContents() {
1852   getParent()->Link = StrTabSec.getParent()->SectionIndex;
1853
1854   if (this->Type != SHT_DYNSYM)
1855     return;
1856
1857   // If it is a .dynsym, there should be no local symbols, but we need
1858   // to do a few things for the dynamic linker.
1859
1860   // Section's Info field has the index of the first non-local symbol.
1861   // Because the first symbol entry is a null entry, 1 is the first.
1862   getParent()->Info = 1;
1863
1864   if (InX::GnuHashTab) {
1865     // NB: It also sorts Symbols to meet the GNU hash table requirements.
1866     InX::GnuHashTab->addSymbols(Symbols);
1867   } else if (Config->EMachine == EM_MIPS) {
1868     std::stable_sort(Symbols.begin(), Symbols.end(), sortMipsSymbols);
1869   }
1870
1871   size_t I = 0;
1872   for (const SymbolTableEntry &S : Symbols)
1873     S.Sym->DynsymIndex = ++I;
1874 }
1875
1876 // The ELF spec requires that all local symbols precede global symbols, so we
1877 // sort symbol entries in this function. (For .dynsym, we don't do that because
1878 // symbols for dynamic linking are inherently all globals.)
1879 //
1880 // Aside from above, we put local symbols in groups starting with the STT_FILE
1881 // symbol. That is convenient for purpose of identifying where are local symbols
1882 // coming from.
1883 void SymbolTableBaseSection::postThunkContents() {
1884   assert(this->Type == SHT_SYMTAB);
1885
1886   // Move all local symbols before global symbols.
1887   auto E = std::stable_partition(
1888       Symbols.begin(), Symbols.end(), [](const SymbolTableEntry &S) {
1889         return S.Sym->isLocal() || S.Sym->computeBinding() == STB_LOCAL;
1890       });
1891   size_t NumLocals = E - Symbols.begin();
1892   getParent()->Info = NumLocals + 1;
1893
1894   // We want to group the local symbols by file. For that we rebuild the local
1895   // part of the symbols vector. We do not need to care about the STT_FILE
1896   // symbols, they are already naturally placed first in each group. That
1897   // happens because STT_FILE is always the first symbol in the object and hence
1898   // precede all other local symbols we add for a file.
1899   MapVector<InputFile *, std::vector<SymbolTableEntry>> Arr;
1900   for (const SymbolTableEntry &S : llvm::make_range(Symbols.begin(), E))
1901     Arr[S.Sym->File].push_back(S);
1902
1903   auto I = Symbols.begin();
1904   for (std::pair<InputFile *, std::vector<SymbolTableEntry>> &P : Arr)
1905     for (SymbolTableEntry &Entry : P.second)
1906       *I++ = Entry;
1907 }
1908
1909 void SymbolTableBaseSection::addSymbol(Symbol *B) {
1910   // Adding a local symbol to a .dynsym is a bug.
1911   assert(this->Type != SHT_DYNSYM || !B->isLocal());
1912
1913   bool HashIt = B->isLocal();
1914   Symbols.push_back({B, StrTabSec.addString(B->getName(), HashIt)});
1915 }
1916
1917 size_t SymbolTableBaseSection::getSymbolIndex(Symbol *Sym) {
1918   // Initializes symbol lookup tables lazily. This is used only
1919   // for -r or -emit-relocs.
1920   llvm::call_once(OnceFlag, [&] {
1921     SymbolIndexMap.reserve(Symbols.size());
1922     size_t I = 0;
1923     for (const SymbolTableEntry &E : Symbols) {
1924       if (E.Sym->Type == STT_SECTION)
1925         SectionIndexMap[E.Sym->getOutputSection()] = ++I;
1926       else
1927         SymbolIndexMap[E.Sym] = ++I;
1928     }
1929   });
1930
1931   // Section symbols are mapped based on their output sections
1932   // to maintain their semantics.
1933   if (Sym->Type == STT_SECTION)
1934     return SectionIndexMap.lookup(Sym->getOutputSection());
1935   return SymbolIndexMap.lookup(Sym);
1936 }
1937
1938 template <class ELFT>
1939 SymbolTableSection<ELFT>::SymbolTableSection(StringTableSection &StrTabSec)
1940     : SymbolTableBaseSection(StrTabSec) {
1941   this->Entsize = sizeof(Elf_Sym);
1942 }
1943
1944 static BssSection *getCommonSec(Symbol *Sym) {
1945   if (!Config->DefineCommon)
1946     if (auto *D = dyn_cast<Defined>(Sym))
1947       return dyn_cast_or_null<BssSection>(D->Section);
1948   return nullptr;
1949 }
1950
1951 static uint32_t getSymSectionIndex(Symbol *Sym) {
1952   if (getCommonSec(Sym))
1953     return SHN_COMMON;
1954   if (!isa<Defined>(Sym) || Sym->NeedsPltAddr)
1955     return SHN_UNDEF;
1956   if (const OutputSection *OS = Sym->getOutputSection())
1957     return OS->SectionIndex >= SHN_LORESERVE ? SHN_XINDEX : OS->SectionIndex;
1958   return SHN_ABS;
1959 }
1960
1961 // Write the internal symbol table contents to the output symbol table.
1962 template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *Buf) {
1963   // The first entry is a null entry as per the ELF spec.
1964   memset(Buf, 0, sizeof(Elf_Sym));
1965   Buf += sizeof(Elf_Sym);
1966
1967   auto *ESym = reinterpret_cast<Elf_Sym *>(Buf);
1968
1969   for (SymbolTableEntry &Ent : Symbols) {
1970     Symbol *Sym = Ent.Sym;
1971
1972     // Set st_info and st_other.
1973     ESym->st_other = 0;
1974     if (Sym->isLocal()) {
1975       ESym->setBindingAndType(STB_LOCAL, Sym->Type);
1976     } else {
1977       ESym->setBindingAndType(Sym->computeBinding(), Sym->Type);
1978       ESym->setVisibility(Sym->Visibility);
1979     }
1980
1981     ESym->st_name = Ent.StrTabOffset;
1982     ESym->st_shndx = getSymSectionIndex(Ent.Sym);
1983
1984     // Copy symbol size if it is a defined symbol. st_size is not significant
1985     // for undefined symbols, so whether copying it or not is up to us if that's
1986     // the case. We'll leave it as zero because by not setting a value, we can
1987     // get the exact same outputs for two sets of input files that differ only
1988     // in undefined symbol size in DSOs.
1989     if (ESym->st_shndx == SHN_UNDEF)
1990       ESym->st_size = 0;
1991     else
1992       ESym->st_size = Sym->getSize();
1993
1994     // st_value is usually an address of a symbol, but that has a
1995     // special meaining for uninstantiated common symbols (this can
1996     // occur if -r is given).
1997     if (BssSection *CommonSec = getCommonSec(Ent.Sym))
1998       ESym->st_value = CommonSec->Alignment;
1999     else
2000       ESym->st_value = Sym->getVA();
2001
2002     ++ESym;
2003   }
2004
2005   // On MIPS we need to mark symbol which has a PLT entry and requires
2006   // pointer equality by STO_MIPS_PLT flag. That is necessary to help
2007   // dynamic linker distinguish such symbols and MIPS lazy-binding stubs.
2008   // https://sourceware.org/ml/binutils/2008-07/txt00000.txt
2009   if (Config->EMachine == EM_MIPS) {
2010     auto *ESym = reinterpret_cast<Elf_Sym *>(Buf);
2011
2012     for (SymbolTableEntry &Ent : Symbols) {
2013       Symbol *Sym = Ent.Sym;
2014       if (Sym->isInPlt() && Sym->NeedsPltAddr)
2015         ESym->st_other |= STO_MIPS_PLT;
2016       if (isMicroMips()) {
2017         // Set STO_MIPS_MICROMIPS flag and less-significant bit for
2018         // a defined microMIPS symbol and symbol should point to its
2019         // PLT entry (in case of microMIPS, PLT entries always contain
2020         // microMIPS code).
2021         if (Sym->isDefined() &&
2022             ((Sym->StOther & STO_MIPS_MICROMIPS) || Sym->NeedsPltAddr)) {
2023           if (StrTabSec.isDynamic())
2024             ESym->st_value |= 1;
2025           ESym->st_other |= STO_MIPS_MICROMIPS;
2026         }
2027       }
2028       if (Config->Relocatable)
2029         if (auto *D = dyn_cast<Defined>(Sym))
2030           if (isMipsPIC<ELFT>(D))
2031             ESym->st_other |= STO_MIPS_PIC;
2032       ++ESym;
2033     }
2034   }
2035 }
2036
2037 SymtabShndxSection::SymtabShndxSection()
2038     : SyntheticSection(0, SHT_SYMTAB_SHNDX, 4, ".symtab_shndxr") {
2039   this->Entsize = 4;
2040 }
2041
2042 void SymtabShndxSection::writeTo(uint8_t *Buf) {
2043   // We write an array of 32 bit values, where each value has 1:1 association
2044   // with an entry in .symtab. If the corresponding entry contains SHN_XINDEX,
2045   // we need to write actual index, otherwise, we must write SHN_UNDEF(0).
2046   Buf += 4; // Ignore .symtab[0] entry.
2047   for (const SymbolTableEntry &Entry : InX::SymTab->getSymbols()) {
2048     if (getSymSectionIndex(Entry.Sym) == SHN_XINDEX)
2049       write32(Buf, Entry.Sym->getOutputSection()->SectionIndex);
2050     Buf += 4;
2051   }
2052 }
2053
2054 bool SymtabShndxSection::empty() const {
2055   // SHT_SYMTAB can hold symbols with section indices values up to
2056   // SHN_LORESERVE. If we need more, we want to use extension SHT_SYMTAB_SHNDX
2057   // section. Problem is that we reveal the final section indices a bit too
2058   // late, and we do not know them here. For simplicity, we just always create
2059   // a .symtab_shndxr section when the amount of output sections is huge.
2060   size_t Size = 0;
2061   for (BaseCommand *Base : Script->SectionCommands)
2062     if (isa<OutputSection>(Base))
2063       ++Size;
2064   return Size < SHN_LORESERVE;
2065 }
2066
2067 void SymtabShndxSection::finalizeContents() {
2068   getParent()->Link = InX::SymTab->getParent()->SectionIndex;
2069 }
2070
2071 size_t SymtabShndxSection::getSize() const {
2072   return InX::SymTab->getNumSymbols() * 4;
2073 }
2074
2075 // .hash and .gnu.hash sections contain on-disk hash tables that map
2076 // symbol names to their dynamic symbol table indices. Their purpose
2077 // is to help the dynamic linker resolve symbols quickly. If ELF files
2078 // don't have them, the dynamic linker has to do linear search on all
2079 // dynamic symbols, which makes programs slower. Therefore, a .hash
2080 // section is added to a DSO by default. A .gnu.hash is added if you
2081 // give the -hash-style=gnu or -hash-style=both option.
2082 //
2083 // The Unix semantics of resolving dynamic symbols is somewhat expensive.
2084 // Each ELF file has a list of DSOs that the ELF file depends on and a
2085 // list of dynamic symbols that need to be resolved from any of the
2086 // DSOs. That means resolving all dynamic symbols takes O(m)*O(n)
2087 // where m is the number of DSOs and n is the number of dynamic
2088 // symbols. For modern large programs, both m and n are large.  So
2089 // making each step faster by using hash tables substiantially
2090 // improves time to load programs.
2091 //
2092 // (Note that this is not the only way to design the shared library.
2093 // For instance, the Windows DLL takes a different approach. On
2094 // Windows, each dynamic symbol has a name of DLL from which the symbol
2095 // has to be resolved. That makes the cost of symbol resolution O(n).
2096 // This disables some hacky techniques you can use on Unix such as
2097 // LD_PRELOAD, but this is arguably better semantics than the Unix ones.)
2098 //
2099 // Due to historical reasons, we have two different hash tables, .hash
2100 // and .gnu.hash. They are for the same purpose, and .gnu.hash is a new
2101 // and better version of .hash. .hash is just an on-disk hash table, but
2102 // .gnu.hash has a bloom filter in addition to a hash table to skip
2103 // DSOs very quickly. If you are sure that your dynamic linker knows
2104 // about .gnu.hash, you want to specify -hash-style=gnu. Otherwise, a
2105 // safe bet is to specify -hash-style=both for backward compatibilty.
2106 GnuHashTableSection::GnuHashTableSection()
2107     : SyntheticSection(SHF_ALLOC, SHT_GNU_HASH, Config->Wordsize, ".gnu.hash") {
2108 }
2109
2110 void GnuHashTableSection::finalizeContents() {
2111   getParent()->Link = InX::DynSymTab->getParent()->SectionIndex;
2112
2113   // Computes bloom filter size in word size. We want to allocate 12
2114   // bits for each symbol. It must be a power of two.
2115   if (Symbols.empty()) {
2116     MaskWords = 1;
2117   } else {
2118     uint64_t NumBits = Symbols.size() * 12;
2119     MaskWords = NextPowerOf2(NumBits / (Config->Wordsize * 8));
2120   }
2121
2122   Size = 16;                            // Header
2123   Size += Config->Wordsize * MaskWords; // Bloom filter
2124   Size += NBuckets * 4;                 // Hash buckets
2125   Size += Symbols.size() * 4;           // Hash values
2126 }
2127
2128 void GnuHashTableSection::writeTo(uint8_t *Buf) {
2129   // The output buffer is not guaranteed to be zero-cleared because we pre-
2130   // fill executable sections with trap instructions. This is a precaution
2131   // for that case, which happens only when -no-rosegment is given.
2132   memset(Buf, 0, Size);
2133
2134   // Write a header.
2135   write32(Buf, NBuckets);
2136   write32(Buf + 4, InX::DynSymTab->getNumSymbols() - Symbols.size());
2137   write32(Buf + 8, MaskWords);
2138   write32(Buf + 12, Shift2);
2139   Buf += 16;
2140
2141   // Write a bloom filter and a hash table.
2142   writeBloomFilter(Buf);
2143   Buf += Config->Wordsize * MaskWords;
2144   writeHashTable(Buf);
2145 }
2146
2147 // This function writes a 2-bit bloom filter. This bloom filter alone
2148 // usually filters out 80% or more of all symbol lookups [1].
2149 // The dynamic linker uses the hash table only when a symbol is not
2150 // filtered out by a bloom filter.
2151 //
2152 // [1] Ulrich Drepper (2011), "How To Write Shared Libraries" (Ver. 4.1.2),
2153 //     p.9, https://www.akkadia.org/drepper/dsohowto.pdf
2154 void GnuHashTableSection::writeBloomFilter(uint8_t *Buf) {
2155   unsigned C = Config->Is64 ? 64 : 32;
2156   for (const Entry &Sym : Symbols) {
2157     size_t I = (Sym.Hash / C) & (MaskWords - 1);
2158     uint64_t Val = readUint(Buf + I * Config->Wordsize);
2159     Val |= uint64_t(1) << (Sym.Hash % C);
2160     Val |= uint64_t(1) << ((Sym.Hash >> Shift2) % C);
2161     writeUint(Buf + I * Config->Wordsize, Val);
2162   }
2163 }
2164
2165 void GnuHashTableSection::writeHashTable(uint8_t *Buf) {
2166   uint32_t *Buckets = reinterpret_cast<uint32_t *>(Buf);
2167   uint32_t OldBucket = -1;
2168   uint32_t *Values = Buckets + NBuckets;
2169   for (auto I = Symbols.begin(), E = Symbols.end(); I != E; ++I) {
2170     // Write a hash value. It represents a sequence of chains that share the
2171     // same hash modulo value. The last element of each chain is terminated by
2172     // LSB 1.
2173     uint32_t Hash = I->Hash;
2174     bool IsLastInChain = (I + 1) == E || I->BucketIdx != (I + 1)->BucketIdx;
2175     Hash = IsLastInChain ? Hash | 1 : Hash & ~1;
2176     write32(Values++, Hash);
2177
2178     if (I->BucketIdx == OldBucket)
2179       continue;
2180     // Write a hash bucket. Hash buckets contain indices in the following hash
2181     // value table.
2182     write32(Buckets + I->BucketIdx, I->Sym->DynsymIndex);
2183     OldBucket = I->BucketIdx;
2184   }
2185 }
2186
2187 static uint32_t hashGnu(StringRef Name) {
2188   uint32_t H = 5381;
2189   for (uint8_t C : Name)
2190     H = (H << 5) + H + C;
2191   return H;
2192 }
2193
2194 // Add symbols to this symbol hash table. Note that this function
2195 // destructively sort a given vector -- which is needed because
2196 // GNU-style hash table places some sorting requirements.
2197 void GnuHashTableSection::addSymbols(std::vector<SymbolTableEntry> &V) {
2198   // We cannot use 'auto' for Mid because GCC 6.1 cannot deduce
2199   // its type correctly.
2200   std::vector<SymbolTableEntry>::iterator Mid =
2201       std::stable_partition(V.begin(), V.end(), [](const SymbolTableEntry &S) {
2202         return !S.Sym->isDefined();
2203       });
2204
2205   // We chose load factor 4 for the on-disk hash table. For each hash
2206   // collision, the dynamic linker will compare a uint32_t hash value.
2207   // Since the integer comparison is quite fast, we believe we can
2208   // make the load factor even larger. 4 is just a conservative choice.
2209   //
2210   // Note that we don't want to create a zero-sized hash table because
2211   // Android loader as of 2018 doesn't like a .gnu.hash containing such
2212   // table. If that's the case, we create a hash table with one unused
2213   // dummy slot.
2214   NBuckets = std::max<size_t>((V.end() - Mid) / 4, 1);
2215
2216   if (Mid == V.end())
2217     return;
2218
2219   for (SymbolTableEntry &Ent : llvm::make_range(Mid, V.end())) {
2220     Symbol *B = Ent.Sym;
2221     uint32_t Hash = hashGnu(B->getName());
2222     uint32_t BucketIdx = Hash % NBuckets;
2223     Symbols.push_back({B, Ent.StrTabOffset, Hash, BucketIdx});
2224   }
2225
2226   std::stable_sort(
2227       Symbols.begin(), Symbols.end(),
2228       [](const Entry &L, const Entry &R) { return L.BucketIdx < R.BucketIdx; });
2229
2230   V.erase(Mid, V.end());
2231   for (const Entry &Ent : Symbols)
2232     V.push_back({Ent.Sym, Ent.StrTabOffset});
2233 }
2234
2235 HashTableSection::HashTableSection()
2236     : SyntheticSection(SHF_ALLOC, SHT_HASH, 4, ".hash") {
2237   this->Entsize = 4;
2238 }
2239
2240 void HashTableSection::finalizeContents() {
2241   getParent()->Link = InX::DynSymTab->getParent()->SectionIndex;
2242
2243   unsigned NumEntries = 2;                       // nbucket and nchain.
2244   NumEntries += InX::DynSymTab->getNumSymbols(); // The chain entries.
2245
2246   // Create as many buckets as there are symbols.
2247   NumEntries += InX::DynSymTab->getNumSymbols();
2248   this->Size = NumEntries * 4;
2249 }
2250
2251 void HashTableSection::writeTo(uint8_t *Buf) {
2252   // See comment in GnuHashTableSection::writeTo.
2253   memset(Buf, 0, Size);
2254
2255   unsigned NumSymbols = InX::DynSymTab->getNumSymbols();
2256
2257   uint32_t *P = reinterpret_cast<uint32_t *>(Buf);
2258   write32(P++, NumSymbols); // nbucket
2259   write32(P++, NumSymbols); // nchain
2260
2261   uint32_t *Buckets = P;
2262   uint32_t *Chains = P + NumSymbols;
2263
2264   for (const SymbolTableEntry &S : InX::DynSymTab->getSymbols()) {
2265     Symbol *Sym = S.Sym;
2266     StringRef Name = Sym->getName();
2267     unsigned I = Sym->DynsymIndex;
2268     uint32_t Hash = hashSysV(Name) % NumSymbols;
2269     Chains[I] = Buckets[Hash];
2270     write32(Buckets + Hash, I);
2271   }
2272 }
2273
2274 // On PowerPC64 the lazy symbol resolvers go into the `global linkage table`
2275 // in the .glink section, rather then the typical .plt section.
2276 PltSection::PltSection(bool IsIplt)
2277     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16,
2278                        Config->EMachine == EM_PPC64 ? ".glink" : ".plt"),
2279       HeaderSize(IsIplt ? 0 : Target->PltHeaderSize), IsIplt(IsIplt) {
2280   // The PLT needs to be writable on SPARC as the dynamic linker will
2281   // modify the instructions in the PLT entries.
2282   if (Config->EMachine == EM_SPARCV9)
2283     this->Flags |= SHF_WRITE;
2284 }
2285
2286 void PltSection::writeTo(uint8_t *Buf) {
2287   // At beginning of PLT but not the IPLT, we have code to call the dynamic
2288   // linker to resolve dynsyms at runtime. Write such code.
2289   if (!IsIplt)
2290     Target->writePltHeader(Buf);
2291   size_t Off = HeaderSize;
2292   // The IPlt is immediately after the Plt, account for this in RelOff
2293   unsigned PltOff = getPltRelocOff();
2294
2295   for (auto &I : Entries) {
2296     const Symbol *B = I.first;
2297     unsigned RelOff = I.second + PltOff;
2298     uint64_t Got = B->getGotPltVA();
2299     uint64_t Plt = this->getVA() + Off;
2300     Target->writePlt(Buf + Off, Got, Plt, B->PltIndex, RelOff);
2301     Off += Target->PltEntrySize;
2302   }
2303 }
2304
2305 template <class ELFT> void PltSection::addEntry(Symbol &Sym) {
2306   Sym.PltIndex = Entries.size();
2307   RelocationBaseSection *PltRelocSection = InX::RelaPlt;
2308   if (IsIplt) {
2309     PltRelocSection = InX::RelaIplt;
2310     Sym.IsInIplt = true;
2311   }
2312   unsigned RelOff =
2313       static_cast<RelocationSection<ELFT> *>(PltRelocSection)->getRelocOffset();
2314   Entries.push_back(std::make_pair(&Sym, RelOff));
2315 }
2316
2317 size_t PltSection::getSize() const {
2318   return HeaderSize + Entries.size() * Target->PltEntrySize;
2319 }
2320
2321 // Some architectures such as additional symbols in the PLT section. For
2322 // example ARM uses mapping symbols to aid disassembly
2323 void PltSection::addSymbols() {
2324   // The PLT may have symbols defined for the Header, the IPLT has no header
2325   if (!IsIplt)
2326     Target->addPltHeaderSymbols(*this);
2327   size_t Off = HeaderSize;
2328   for (size_t I = 0; I < Entries.size(); ++I) {
2329     Target->addPltSymbols(*this, Off);
2330     Off += Target->PltEntrySize;
2331   }
2332 }
2333
2334 unsigned PltSection::getPltRelocOff() const {
2335   return IsIplt ? InX::Plt->getSize() : 0;
2336 }
2337
2338 // The string hash function for .gdb_index.
2339 static uint32_t computeGdbHash(StringRef S) {
2340   uint32_t H = 0;
2341   for (uint8_t C : S)
2342     H = H * 67 + tolower(C) - 113;
2343   return H;
2344 }
2345
2346 GdbIndexSection::GdbIndexSection()
2347     : SyntheticSection(0, SHT_PROGBITS, 1, ".gdb_index") {}
2348
2349 // Returns the desired size of an on-disk hash table for a .gdb_index section.
2350 // There's a tradeoff between size and collision rate. We aim 75% utilization.
2351 size_t GdbIndexSection::computeSymtabSize() const {
2352   return std::max<size_t>(NextPowerOf2(Symbols.size() * 4 / 3), 1024);
2353 }
2354
2355 // Compute the output section size.
2356 void GdbIndexSection::initOutputSize() {
2357   Size = sizeof(GdbIndexHeader) + computeSymtabSize() * 8;
2358
2359   for (GdbChunk &Chunk : Chunks)
2360     Size += Chunk.CompilationUnits.size() * 16 + Chunk.AddressAreas.size() * 20;
2361
2362   // Add the constant pool size if exists.
2363   if (!Symbols.empty()) {
2364     GdbSymbol &Sym = Symbols.back();
2365     Size += Sym.NameOff + Sym.Name.size() + 1;
2366   }
2367 }
2368
2369 static std::vector<InputSection *> getDebugInfoSections() {
2370   std::vector<InputSection *> Ret;
2371   for (InputSectionBase *S : InputSections)
2372     if (InputSection *IS = dyn_cast<InputSection>(S))
2373       if (IS->Name == ".debug_info")
2374         Ret.push_back(IS);
2375   return Ret;
2376 }
2377
2378 static std::vector<GdbIndexSection::CuEntry> readCuList(DWARFContext &Dwarf) {
2379   std::vector<GdbIndexSection::CuEntry> Ret;
2380   for (std::unique_ptr<DWARFCompileUnit> &Cu : Dwarf.compile_units())
2381     Ret.push_back({Cu->getOffset(), Cu->getLength() + 4});
2382   return Ret;
2383 }
2384
2385 static std::vector<GdbIndexSection::AddressEntry>
2386 readAddressAreas(DWARFContext &Dwarf, InputSection *Sec) {
2387   std::vector<GdbIndexSection::AddressEntry> Ret;
2388
2389   uint32_t CuIdx = 0;
2390   for (std::unique_ptr<DWARFCompileUnit> &Cu : Dwarf.compile_units()) {
2391     DWARFAddressRangesVector Ranges;
2392     Cu->collectAddressRanges(Ranges);
2393
2394     ArrayRef<InputSectionBase *> Sections = Sec->File->getSections();
2395     for (DWARFAddressRange &R : Ranges) {
2396       InputSectionBase *S = Sections[R.SectionIndex];
2397       if (!S || S == &InputSection::Discarded || !S->Live)
2398         continue;
2399       // Range list with zero size has no effect.
2400       if (R.LowPC == R.HighPC)
2401         continue;
2402       auto *IS = cast<InputSection>(S);
2403       uint64_t Offset = IS->getOffsetInFile();
2404       Ret.push_back({IS, R.LowPC - Offset, R.HighPC - Offset, CuIdx});
2405     }
2406     ++CuIdx;
2407   }
2408   return Ret;
2409 }
2410
2411 static std::vector<GdbIndexSection::NameTypeEntry>
2412 readPubNamesAndTypes(DWARFContext &Dwarf, uint32_t Idx) {
2413   StringRef Sec1 = Dwarf.getDWARFObj().getGnuPubNamesSection();
2414   StringRef Sec2 = Dwarf.getDWARFObj().getGnuPubTypesSection();
2415
2416   std::vector<GdbIndexSection::NameTypeEntry> Ret;
2417   for (StringRef Sec : {Sec1, Sec2}) {
2418     DWARFDebugPubTable Table(Sec, Config->IsLE, true);
2419     for (const DWARFDebugPubTable::Set &Set : Table.getData())
2420       for (const DWARFDebugPubTable::Entry &Ent : Set.Entries)
2421         Ret.push_back({{Ent.Name, computeGdbHash(Ent.Name)},
2422                        (Ent.Descriptor.toBits() << 24) | Idx});
2423   }
2424   return Ret;
2425 }
2426
2427 // Create a list of symbols from a given list of symbol names and types
2428 // by uniquifying them by name.
2429 static std::vector<GdbIndexSection::GdbSymbol>
2430 createSymbols(ArrayRef<std::vector<GdbIndexSection::NameTypeEntry>> NameTypes) {
2431   typedef GdbIndexSection::GdbSymbol GdbSymbol;
2432   typedef GdbIndexSection::NameTypeEntry NameTypeEntry;
2433
2434   // The number of symbols we will handle in this function is of the order
2435   // of millions for very large executables, so we use multi-threading to
2436   // speed it up.
2437   size_t NumShards = 32;
2438   size_t Concurrency = 1;
2439   if (ThreadsEnabled)
2440     Concurrency =
2441         std::min<size_t>(PowerOf2Floor(hardware_concurrency()), NumShards);
2442
2443   // A sharded map to uniquify symbols by name.
2444   std::vector<DenseMap<CachedHashStringRef, size_t>> Map(NumShards);
2445   size_t Shift = 32 - countTrailingZeros(NumShards);
2446
2447   // Instantiate GdbSymbols while uniqufying them by name.
2448   std::vector<std::vector<GdbSymbol>> Symbols(NumShards);
2449   parallelForEachN(0, Concurrency, [&](size_t ThreadId) {
2450     for (ArrayRef<NameTypeEntry> Entries : NameTypes) {
2451       for (const NameTypeEntry &Ent : Entries) {
2452         size_t ShardId = Ent.Name.hash() >> Shift;
2453         if ((ShardId & (Concurrency - 1)) != ThreadId)
2454           continue;
2455
2456         size_t &Idx = Map[ShardId][Ent.Name];
2457         if (Idx) {
2458           Symbols[ShardId][Idx - 1].CuVector.push_back(Ent.Type);
2459           continue;
2460         }
2461
2462         Idx = Symbols[ShardId].size() + 1;
2463         Symbols[ShardId].push_back({Ent.Name, {Ent.Type}, 0, 0});
2464       }
2465     }
2466   });
2467
2468   size_t NumSymbols = 0;
2469   for (ArrayRef<GdbSymbol> V : Symbols)
2470     NumSymbols += V.size();
2471
2472   // The return type is a flattened vector, so we'll copy each vector
2473   // contents to Ret.
2474   std::vector<GdbSymbol> Ret;
2475   Ret.reserve(NumSymbols);
2476   for (std::vector<GdbSymbol> &Vec : Symbols)
2477     for (GdbSymbol &Sym : Vec)
2478       Ret.push_back(std::move(Sym));
2479
2480   // CU vectors and symbol names are adjacent in the output file.
2481   // We can compute their offsets in the output file now.
2482   size_t Off = 0;
2483   for (GdbSymbol &Sym : Ret) {
2484     Sym.CuVectorOff = Off;
2485     Off += (Sym.CuVector.size() + 1) * 4;
2486   }
2487   for (GdbSymbol &Sym : Ret) {
2488     Sym.NameOff = Off;
2489     Off += Sym.Name.size() + 1;
2490   }
2491
2492   return Ret;
2493 }
2494
2495 // Returns a newly-created .gdb_index section.
2496 template <class ELFT> GdbIndexSection *GdbIndexSection::create() {
2497   std::vector<InputSection *> Sections = getDebugInfoSections();
2498
2499   // .debug_gnu_pub{names,types} are useless in executables.
2500   // They are present in input object files solely for creating
2501   // a .gdb_index. So we can remove them from the output.
2502   for (InputSectionBase *S : InputSections)
2503     if (S->Name == ".debug_gnu_pubnames" || S->Name == ".debug_gnu_pubtypes")
2504       S->Live = false;
2505
2506   std::vector<GdbChunk> Chunks(Sections.size());
2507   std::vector<std::vector<NameTypeEntry>> NameTypes(Sections.size());
2508
2509   parallelForEachN(0, Sections.size(), [&](size_t I) {
2510     ObjFile<ELFT> *File = Sections[I]->getFile<ELFT>();
2511     DWARFContext Dwarf(make_unique<LLDDwarfObj<ELFT>>(File));
2512
2513     Chunks[I].Sec = Sections[I];
2514     Chunks[I].CompilationUnits = readCuList(Dwarf);
2515     Chunks[I].AddressAreas = readAddressAreas(Dwarf, Sections[I]);
2516     NameTypes[I] = readPubNamesAndTypes(Dwarf, I);
2517   });
2518
2519   auto *Ret = make<GdbIndexSection>();
2520   Ret->Chunks = std::move(Chunks);
2521   Ret->Symbols = createSymbols(NameTypes);
2522   Ret->initOutputSize();
2523   return Ret;
2524 }
2525
2526 void GdbIndexSection::writeTo(uint8_t *Buf) {
2527   // Write the header.
2528   auto *Hdr = reinterpret_cast<GdbIndexHeader *>(Buf);
2529   uint8_t *Start = Buf;
2530   Hdr->Version = 7;
2531   Buf += sizeof(*Hdr);
2532
2533   // Write the CU list.
2534   Hdr->CuListOff = Buf - Start;
2535   for (GdbChunk &Chunk : Chunks) {
2536     for (CuEntry &Cu : Chunk.CompilationUnits) {
2537       write64le(Buf, Chunk.Sec->OutSecOff + Cu.CuOffset);
2538       write64le(Buf + 8, Cu.CuLength);
2539       Buf += 16;
2540     }
2541   }
2542
2543   // Write the address area.
2544   Hdr->CuTypesOff = Buf - Start;
2545   Hdr->AddressAreaOff = Buf - Start;
2546   uint32_t CuOff = 0;
2547   for (GdbChunk &Chunk : Chunks) {
2548     for (AddressEntry &E : Chunk.AddressAreas) {
2549       uint64_t BaseAddr = E.Section->getVA(0);
2550       write64le(Buf, BaseAddr + E.LowAddress);
2551       write64le(Buf + 8, BaseAddr + E.HighAddress);
2552       write32le(Buf + 16, E.CuIndex + CuOff);
2553       Buf += 20;
2554     }
2555     CuOff += Chunk.CompilationUnits.size();
2556   }
2557
2558   // Write the on-disk open-addressing hash table containing symbols.
2559   Hdr->SymtabOff = Buf - Start;
2560   size_t SymtabSize = computeSymtabSize();
2561   uint32_t Mask = SymtabSize - 1;
2562
2563   for (GdbSymbol &Sym : Symbols) {
2564     uint32_t H = Sym.Name.hash();
2565     uint32_t I = H & Mask;
2566     uint32_t Step = ((H * 17) & Mask) | 1;
2567
2568     while (read32le(Buf + I * 8))
2569       I = (I + Step) & Mask;
2570
2571     write32le(Buf + I * 8, Sym.NameOff);
2572     write32le(Buf + I * 8 + 4, Sym.CuVectorOff);
2573   }
2574
2575   Buf += SymtabSize * 8;
2576
2577   // Write the string pool.
2578   Hdr->ConstantPoolOff = Buf - Start;
2579   for (GdbSymbol &Sym : Symbols)
2580     memcpy(Buf + Sym.NameOff, Sym.Name.data(), Sym.Name.size());
2581
2582   // Write the CU vectors.
2583   for (GdbSymbol &Sym : Symbols) {
2584     write32le(Buf, Sym.CuVector.size());
2585     Buf += 4;
2586     for (uint32_t Val : Sym.CuVector) {
2587       write32le(Buf, Val);
2588       Buf += 4;
2589     }
2590   }
2591 }
2592
2593 bool GdbIndexSection::empty() const { return !Out::DebugInfo; }
2594
2595 EhFrameHeader::EhFrameHeader()
2596     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".eh_frame_hdr") {}
2597
2598 // .eh_frame_hdr contains a binary search table of pointers to FDEs.
2599 // Each entry of the search table consists of two values,
2600 // the starting PC from where FDEs covers, and the FDE's address.
2601 // It is sorted by PC.
2602 void EhFrameHeader::writeTo(uint8_t *Buf) {
2603   typedef EhFrameSection::FdeData FdeData;
2604
2605   std::vector<FdeData> Fdes = InX::EhFrame->getFdeData();
2606
2607   Buf[0] = 1;
2608   Buf[1] = DW_EH_PE_pcrel | DW_EH_PE_sdata4;
2609   Buf[2] = DW_EH_PE_udata4;
2610   Buf[3] = DW_EH_PE_datarel | DW_EH_PE_sdata4;
2611   write32(Buf + 4, InX::EhFrame->getParent()->Addr - this->getVA() - 4);
2612   write32(Buf + 8, Fdes.size());
2613   Buf += 12;
2614
2615   for (FdeData &Fde : Fdes) {
2616     write32(Buf, Fde.PcRel);
2617     write32(Buf + 4, Fde.FdeVARel);
2618     Buf += 8;
2619   }
2620 }
2621
2622 size_t EhFrameHeader::getSize() const {
2623   // .eh_frame_hdr has a 12 bytes header followed by an array of FDEs.
2624   return 12 + InX::EhFrame->NumFdes * 8;
2625 }
2626
2627 bool EhFrameHeader::empty() const { return InX::EhFrame->empty(); }
2628
2629 template <class ELFT>
2630 VersionDefinitionSection<ELFT>::VersionDefinitionSection()
2631     : SyntheticSection(SHF_ALLOC, SHT_GNU_verdef, sizeof(uint32_t),
2632                        ".gnu.version_d") {}
2633
2634 static StringRef getFileDefName() {
2635   if (!Config->SoName.empty())
2636     return Config->SoName;
2637   return Config->OutputFile;
2638 }
2639
2640 template <class ELFT> void VersionDefinitionSection<ELFT>::finalizeContents() {
2641   FileDefNameOff = InX::DynStrTab->addString(getFileDefName());
2642   for (VersionDefinition &V : Config->VersionDefinitions)
2643     V.NameOff = InX::DynStrTab->addString(V.Name);
2644
2645   getParent()->Link = InX::DynStrTab->getParent()->SectionIndex;
2646
2647   // sh_info should be set to the number of definitions. This fact is missed in
2648   // documentation, but confirmed by binutils community:
2649   // https://sourceware.org/ml/binutils/2014-11/msg00355.html
2650   getParent()->Info = getVerDefNum();
2651 }
2652
2653 template <class ELFT>
2654 void VersionDefinitionSection<ELFT>::writeOne(uint8_t *Buf, uint32_t Index,
2655                                               StringRef Name, size_t NameOff) {
2656   auto *Verdef = reinterpret_cast<Elf_Verdef *>(Buf);
2657   Verdef->vd_version = 1;
2658   Verdef->vd_cnt = 1;
2659   Verdef->vd_aux = sizeof(Elf_Verdef);
2660   Verdef->vd_next = sizeof(Elf_Verdef) + sizeof(Elf_Verdaux);
2661   Verdef->vd_flags = (Index == 1 ? VER_FLG_BASE : 0);
2662   Verdef->vd_ndx = Index;
2663   Verdef->vd_hash = hashSysV(Name);
2664
2665   auto *Verdaux = reinterpret_cast<Elf_Verdaux *>(Buf + sizeof(Elf_Verdef));
2666   Verdaux->vda_name = NameOff;
2667   Verdaux->vda_next = 0;
2668 }
2669
2670 template <class ELFT>
2671 void VersionDefinitionSection<ELFT>::writeTo(uint8_t *Buf) {
2672   writeOne(Buf, 1, getFileDefName(), FileDefNameOff);
2673
2674   for (VersionDefinition &V : Config->VersionDefinitions) {
2675     Buf += sizeof(Elf_Verdef) + sizeof(Elf_Verdaux);
2676     writeOne(Buf, V.Id, V.Name, V.NameOff);
2677   }
2678
2679   // Need to terminate the last version definition.
2680   Elf_Verdef *Verdef = reinterpret_cast<Elf_Verdef *>(Buf);
2681   Verdef->vd_next = 0;
2682 }
2683
2684 template <class ELFT> size_t VersionDefinitionSection<ELFT>::getSize() const {
2685   return (sizeof(Elf_Verdef) + sizeof(Elf_Verdaux)) * getVerDefNum();
2686 }
2687
2688 template <class ELFT>
2689 VersionTableSection<ELFT>::VersionTableSection()
2690     : SyntheticSection(SHF_ALLOC, SHT_GNU_versym, sizeof(uint16_t),
2691                        ".gnu.version") {
2692   this->Entsize = sizeof(Elf_Versym);
2693 }
2694
2695 template <class ELFT> void VersionTableSection<ELFT>::finalizeContents() {
2696   // At the moment of june 2016 GNU docs does not mention that sh_link field
2697   // should be set, but Sun docs do. Also readelf relies on this field.
2698   getParent()->Link = InX::DynSymTab->getParent()->SectionIndex;
2699 }
2700
2701 template <class ELFT> size_t VersionTableSection<ELFT>::getSize() const {
2702   return sizeof(Elf_Versym) * (InX::DynSymTab->getSymbols().size() + 1);
2703 }
2704
2705 template <class ELFT> void VersionTableSection<ELFT>::writeTo(uint8_t *Buf) {
2706   auto *OutVersym = reinterpret_cast<Elf_Versym *>(Buf) + 1;
2707   for (const SymbolTableEntry &S : InX::DynSymTab->getSymbols()) {
2708     OutVersym->vs_index = S.Sym->VersionId;
2709     ++OutVersym;
2710   }
2711 }
2712
2713 template <class ELFT> bool VersionTableSection<ELFT>::empty() const {
2714   return !In<ELFT>::VerDef && In<ELFT>::VerNeed->empty();
2715 }
2716
2717 template <class ELFT>
2718 VersionNeedSection<ELFT>::VersionNeedSection()
2719     : SyntheticSection(SHF_ALLOC, SHT_GNU_verneed, sizeof(uint32_t),
2720                        ".gnu.version_r") {
2721   // Identifiers in verneed section start at 2 because 0 and 1 are reserved
2722   // for VER_NDX_LOCAL and VER_NDX_GLOBAL.
2723   // First identifiers are reserved by verdef section if it exist.
2724   NextIndex = getVerDefNum() + 1;
2725 }
2726
2727 template <class ELFT> void VersionNeedSection<ELFT>::addSymbol(Symbol *SS) {
2728   auto &File = cast<SharedFile<ELFT>>(*SS->File);
2729   if (SS->VerdefIndex == VER_NDX_GLOBAL) {
2730     SS->VersionId = VER_NDX_GLOBAL;
2731     return;
2732   }
2733
2734   // If we don't already know that we need an Elf_Verneed for this DSO, prepare
2735   // to create one by adding it to our needed list and creating a dynstr entry
2736   // for the soname.
2737   if (File.VerdefMap.empty())
2738     Needed.push_back({&File, InX::DynStrTab->addString(File.SoName)});
2739   const typename ELFT::Verdef *Ver = File.Verdefs[SS->VerdefIndex];
2740   typename SharedFile<ELFT>::NeededVer &NV = File.VerdefMap[Ver];
2741
2742   // If we don't already know that we need an Elf_Vernaux for this Elf_Verdef,
2743   // prepare to create one by allocating a version identifier and creating a
2744   // dynstr entry for the version name.
2745   if (NV.Index == 0) {
2746     NV.StrTab = InX::DynStrTab->addString(File.getStringTable().data() +
2747                                           Ver->getAux()->vda_name);
2748     NV.Index = NextIndex++;
2749   }
2750   SS->VersionId = NV.Index;
2751 }
2752
2753 template <class ELFT> void VersionNeedSection<ELFT>::writeTo(uint8_t *Buf) {
2754   // The Elf_Verneeds need to appear first, followed by the Elf_Vernauxs.
2755   auto *Verneed = reinterpret_cast<Elf_Verneed *>(Buf);
2756   auto *Vernaux = reinterpret_cast<Elf_Vernaux *>(Verneed + Needed.size());
2757
2758   for (std::pair<SharedFile<ELFT> *, size_t> &P : Needed) {
2759     // Create an Elf_Verneed for this DSO.
2760     Verneed->vn_version = 1;
2761     Verneed->vn_cnt = P.first->VerdefMap.size();
2762     Verneed->vn_file = P.second;
2763     Verneed->vn_aux =
2764         reinterpret_cast<char *>(Vernaux) - reinterpret_cast<char *>(Verneed);
2765     Verneed->vn_next = sizeof(Elf_Verneed);
2766     ++Verneed;
2767
2768     // Create the Elf_Vernauxs for this Elf_Verneed. The loop iterates over
2769     // VerdefMap, which will only contain references to needed version
2770     // definitions. Each Elf_Vernaux is based on the information contained in
2771     // the Elf_Verdef in the source DSO. This loop iterates over a std::map of
2772     // pointers, but is deterministic because the pointers refer to Elf_Verdef
2773     // data structures within a single input file.
2774     for (auto &NV : P.first->VerdefMap) {
2775       Vernaux->vna_hash = NV.first->vd_hash;
2776       Vernaux->vna_flags = 0;
2777       Vernaux->vna_other = NV.second.Index;
2778       Vernaux->vna_name = NV.second.StrTab;
2779       Vernaux->vna_next = sizeof(Elf_Vernaux);
2780       ++Vernaux;
2781     }
2782
2783     Vernaux[-1].vna_next = 0;
2784   }
2785   Verneed[-1].vn_next = 0;
2786 }
2787
2788 template <class ELFT> void VersionNeedSection<ELFT>::finalizeContents() {
2789   getParent()->Link = InX::DynStrTab->getParent()->SectionIndex;
2790   getParent()->Info = Needed.size();
2791 }
2792
2793 template <class ELFT> size_t VersionNeedSection<ELFT>::getSize() const {
2794   unsigned Size = Needed.size() * sizeof(Elf_Verneed);
2795   for (const std::pair<SharedFile<ELFT> *, size_t> &P : Needed)
2796     Size += P.first->VerdefMap.size() * sizeof(Elf_Vernaux);
2797   return Size;
2798 }
2799
2800 template <class ELFT> bool VersionNeedSection<ELFT>::empty() const {
2801   return getNeedNum() == 0;
2802 }
2803
2804 void MergeSyntheticSection::addSection(MergeInputSection *MS) {
2805   MS->Parent = this;
2806   Sections.push_back(MS);
2807 }
2808
2809 MergeTailSection::MergeTailSection(StringRef Name, uint32_t Type,
2810                                    uint64_t Flags, uint32_t Alignment)
2811     : MergeSyntheticSection(Name, Type, Flags, Alignment),
2812       Builder(StringTableBuilder::RAW, Alignment) {}
2813
2814 size_t MergeTailSection::getSize() const { return Builder.getSize(); }
2815
2816 void MergeTailSection::writeTo(uint8_t *Buf) { Builder.write(Buf); }
2817
2818 void MergeTailSection::finalizeContents() {
2819   // Add all string pieces to the string table builder to create section
2820   // contents.
2821   for (MergeInputSection *Sec : Sections)
2822     for (size_t I = 0, E = Sec->Pieces.size(); I != E; ++I)
2823       if (Sec->Pieces[I].Live)
2824         Builder.add(Sec->getData(I));
2825
2826   // Fix the string table content. After this, the contents will never change.
2827   Builder.finalize();
2828
2829   // finalize() fixed tail-optimized strings, so we can now get
2830   // offsets of strings. Get an offset for each string and save it
2831   // to a corresponding StringPiece for easy access.
2832   for (MergeInputSection *Sec : Sections)
2833     for (size_t I = 0, E = Sec->Pieces.size(); I != E; ++I)
2834       if (Sec->Pieces[I].Live)
2835         Sec->Pieces[I].OutputOff = Builder.getOffset(Sec->getData(I));
2836 }
2837
2838 void MergeNoTailSection::writeTo(uint8_t *Buf) {
2839   for (size_t I = 0; I < NumShards; ++I)
2840     Shards[I].write(Buf + ShardOffsets[I]);
2841 }
2842
2843 // This function is very hot (i.e. it can take several seconds to finish)
2844 // because sometimes the number of inputs is in an order of magnitude of
2845 // millions. So, we use multi-threading.
2846 //
2847 // For any strings S and T, we know S is not mergeable with T if S's hash
2848 // value is different from T's. If that's the case, we can safely put S and
2849 // T into different string builders without worrying about merge misses.
2850 // We do it in parallel.
2851 void MergeNoTailSection::finalizeContents() {
2852   // Initializes string table builders.
2853   for (size_t I = 0; I < NumShards; ++I)
2854     Shards.emplace_back(StringTableBuilder::RAW, Alignment);
2855
2856   // Concurrency level. Must be a power of 2 to avoid expensive modulo
2857   // operations in the following tight loop.
2858   size_t Concurrency = 1;
2859   if (ThreadsEnabled)
2860     Concurrency =
2861         std::min<size_t>(PowerOf2Floor(hardware_concurrency()), NumShards);
2862
2863   // Add section pieces to the builders.
2864   parallelForEachN(0, Concurrency, [&](size_t ThreadId) {
2865     for (MergeInputSection *Sec : Sections) {
2866       for (size_t I = 0, E = Sec->Pieces.size(); I != E; ++I) {
2867         size_t ShardId = getShardId(Sec->Pieces[I].Hash);
2868         if ((ShardId & (Concurrency - 1)) == ThreadId && Sec->Pieces[I].Live)
2869           Sec->Pieces[I].OutputOff = Shards[ShardId].add(Sec->getData(I));
2870       }
2871     }
2872   });
2873
2874   // Compute an in-section offset for each shard.
2875   size_t Off = 0;
2876   for (size_t I = 0; I < NumShards; ++I) {
2877     Shards[I].finalizeInOrder();
2878     if (Shards[I].getSize() > 0)
2879       Off = alignTo(Off, Alignment);
2880     ShardOffsets[I] = Off;
2881     Off += Shards[I].getSize();
2882   }
2883   Size = Off;
2884
2885   // So far, section pieces have offsets from beginning of shards, but
2886   // we want offsets from beginning of the whole section. Fix them.
2887   parallelForEach(Sections, [&](MergeInputSection *Sec) {
2888     for (size_t I = 0, E = Sec->Pieces.size(); I != E; ++I)
2889       if (Sec->Pieces[I].Live)
2890         Sec->Pieces[I].OutputOff +=
2891             ShardOffsets[getShardId(Sec->Pieces[I].Hash)];
2892   });
2893 }
2894
2895 static MergeSyntheticSection *createMergeSynthetic(StringRef Name,
2896                                                    uint32_t Type,
2897                                                    uint64_t Flags,
2898                                                    uint32_t Alignment) {
2899   bool ShouldTailMerge = (Flags & SHF_STRINGS) && Config->Optimize >= 2;
2900   if (ShouldTailMerge)
2901     return make<MergeTailSection>(Name, Type, Flags, Alignment);
2902   return make<MergeNoTailSection>(Name, Type, Flags, Alignment);
2903 }
2904
2905 // Debug sections may be compressed by zlib. Decompress if exists.
2906 void elf::decompressSections() {
2907   parallelForEach(InputSections,
2908                   [](InputSectionBase *Sec) { Sec->maybeDecompress(); });
2909 }
2910
2911 template <class ELFT> void elf::splitSections() {
2912   // splitIntoPieces needs to be called on each MergeInputSection
2913   // before calling finalizeContents().
2914   parallelForEach(InputSections, [](InputSectionBase *Sec) {
2915     if (auto *S = dyn_cast<MergeInputSection>(Sec))
2916       S->splitIntoPieces();
2917     else if (auto *Eh = dyn_cast<EhInputSection>(Sec))
2918       Eh->split<ELFT>();
2919   });
2920 }
2921
2922 // This function scans over the inputsections to create mergeable
2923 // synthetic sections.
2924 //
2925 // It removes MergeInputSections from the input section array and adds
2926 // new synthetic sections at the location of the first input section
2927 // that it replaces. It then finalizes each synthetic section in order
2928 // to compute an output offset for each piece of each input section.
2929 void elf::mergeSections() {
2930   std::vector<MergeSyntheticSection *> MergeSections;
2931   for (InputSectionBase *&S : InputSections) {
2932     MergeInputSection *MS = dyn_cast<MergeInputSection>(S);
2933     if (!MS)
2934       continue;
2935
2936     // We do not want to handle sections that are not alive, so just remove
2937     // them instead of trying to merge.
2938     if (!MS->Live) {
2939       S = nullptr;
2940       continue;
2941     }
2942
2943     StringRef OutsecName = getOutputSectionName(MS);
2944     uint32_t Alignment = std::max<uint32_t>(MS->Alignment, MS->Entsize);
2945
2946     auto I = llvm::find_if(MergeSections, [=](MergeSyntheticSection *Sec) {
2947       // While we could create a single synthetic section for two different
2948       // values of Entsize, it is better to take Entsize into consideration.
2949       //
2950       // With a single synthetic section no two pieces with different Entsize
2951       // could be equal, so we may as well have two sections.
2952       //
2953       // Using Entsize in here also allows us to propagate it to the synthetic
2954       // section.
2955       return Sec->Name == OutsecName && Sec->Flags == MS->Flags &&
2956              Sec->Entsize == MS->Entsize && Sec->Alignment == Alignment;
2957     });
2958     if (I == MergeSections.end()) {
2959       MergeSyntheticSection *Syn =
2960           createMergeSynthetic(OutsecName, MS->Type, MS->Flags, Alignment);
2961       MergeSections.push_back(Syn);
2962       I = std::prev(MergeSections.end());
2963       S = Syn;
2964       Syn->Entsize = MS->Entsize;
2965     } else {
2966       S = nullptr;
2967     }
2968     (*I)->addSection(MS);
2969   }
2970   for (auto *MS : MergeSections)
2971     MS->finalizeContents();
2972
2973   std::vector<InputSectionBase *> &V = InputSections;
2974   V.erase(std::remove(V.begin(), V.end(), nullptr), V.end());
2975 }
2976
2977 MipsRldMapSection::MipsRldMapSection()
2978     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, Config->Wordsize,
2979                        ".rld_map") {}
2980
2981 ARMExidxSentinelSection::ARMExidxSentinelSection()
2982     : SyntheticSection(SHF_ALLOC | SHF_LINK_ORDER, SHT_ARM_EXIDX,
2983                        Config->Wordsize, ".ARM.exidx") {}
2984
2985 // Write a terminating sentinel entry to the end of the .ARM.exidx table.
2986 // This section will have been sorted last in the .ARM.exidx table.
2987 // This table entry will have the form:
2988 // | PREL31 upper bound of code that has exception tables | EXIDX_CANTUNWIND |
2989 // The sentinel must have the PREL31 value of an address higher than any
2990 // address described by any other table entry.
2991 void ARMExidxSentinelSection::writeTo(uint8_t *Buf) {
2992   assert(Highest);
2993   uint64_t S = Highest->getVA(Highest->getSize());
2994   uint64_t P = getVA();
2995   Target->relocateOne(Buf, R_ARM_PREL31, S - P);
2996   write32le(Buf + 4, 1);
2997 }
2998
2999 // The sentinel has to be removed if there are no other .ARM.exidx entries.
3000 bool ARMExidxSentinelSection::empty() const {
3001   for (InputSection *IS : getInputSections(getParent()))
3002     if (!isa<ARMExidxSentinelSection>(IS))
3003       return false;
3004   return true;
3005 }
3006
3007 bool ARMExidxSentinelSection::classof(const SectionBase *D) {
3008   return D->kind() == InputSectionBase::Synthetic && D->Type == SHT_ARM_EXIDX;
3009 }
3010
3011 ThunkSection::ThunkSection(OutputSection *OS, uint64_t Off)
3012     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS,
3013                        Config->Wordsize, ".text.thunk") {
3014   this->Parent = OS;
3015   this->OutSecOff = Off;
3016 }
3017
3018 void ThunkSection::addThunk(Thunk *T) {
3019   Thunks.push_back(T);
3020   T->addSymbols(*this);
3021 }
3022
3023 void ThunkSection::writeTo(uint8_t *Buf) {
3024   for (Thunk *T : Thunks)
3025     T->writeTo(Buf + T->Offset);
3026 }
3027
3028 InputSection *ThunkSection::getTargetInputSection() const {
3029   if (Thunks.empty())
3030     return nullptr;
3031   const Thunk *T = Thunks.front();
3032   return T->getTargetInputSection();
3033 }
3034
3035 bool ThunkSection::assignOffsets() {
3036   uint64_t Off = 0;
3037   for (Thunk *T : Thunks) {
3038     Off = alignTo(Off, T->Alignment);
3039     T->setOffset(Off);
3040     uint32_t Size = T->size();
3041     T->getThunkTargetSym()->Size = Size;
3042     Off += Size;
3043   }
3044   bool Changed = Off != Size;
3045   Size = Off;
3046   return Changed;
3047 }
3048
3049 InputSection *InX::ARMAttributes;
3050 BssSection *InX::Bss;
3051 BssSection *InX::BssRelRo;
3052 BuildIdSection *InX::BuildId;
3053 EhFrameHeader *InX::EhFrameHdr;
3054 EhFrameSection *InX::EhFrame;
3055 SyntheticSection *InX::Dynamic;
3056 StringTableSection *InX::DynStrTab;
3057 SymbolTableBaseSection *InX::DynSymTab;
3058 InputSection *InX::Interp;
3059 GdbIndexSection *InX::GdbIndex;
3060 GotSection *InX::Got;
3061 GotPltSection *InX::GotPlt;
3062 GnuHashTableSection *InX::GnuHashTab;
3063 HashTableSection *InX::HashTab;
3064 IgotPltSection *InX::IgotPlt;
3065 MipsGotSection *InX::MipsGot;
3066 MipsRldMapSection *InX::MipsRldMap;
3067 PltSection *InX::Plt;
3068 PltSection *InX::Iplt;
3069 RelocationBaseSection *InX::RelaDyn;
3070 RelrBaseSection *InX::RelrDyn;
3071 RelocationBaseSection *InX::RelaPlt;
3072 RelocationBaseSection *InX::RelaIplt;
3073 StringTableSection *InX::ShStrTab;
3074 StringTableSection *InX::StrTab;
3075 SymbolTableBaseSection *InX::SymTab;
3076 SymtabShndxSection *InX::SymTabShndx;
3077
3078 template GdbIndexSection *GdbIndexSection::create<ELF32LE>();
3079 template GdbIndexSection *GdbIndexSection::create<ELF32BE>();
3080 template GdbIndexSection *GdbIndexSection::create<ELF64LE>();
3081 template GdbIndexSection *GdbIndexSection::create<ELF64BE>();
3082
3083 template void elf::splitSections<ELF32LE>();
3084 template void elf::splitSections<ELF32BE>();
3085 template void elf::splitSections<ELF64LE>();
3086 template void elf::splitSections<ELF64BE>();
3087
3088 template void EhFrameSection::addSection<ELF32LE>(InputSectionBase *);
3089 template void EhFrameSection::addSection<ELF32BE>(InputSectionBase *);
3090 template void EhFrameSection::addSection<ELF64LE>(InputSectionBase *);
3091 template void EhFrameSection::addSection<ELF64BE>(InputSectionBase *);
3092
3093 template void PltSection::addEntry<ELF32LE>(Symbol &Sym);
3094 template void PltSection::addEntry<ELF32BE>(Symbol &Sym);
3095 template void PltSection::addEntry<ELF64LE>(Symbol &Sym);
3096 template void PltSection::addEntry<ELF64BE>(Symbol &Sym);
3097
3098 template void MipsGotSection::build<ELF32LE>();
3099 template void MipsGotSection::build<ELF32BE>();
3100 template void MipsGotSection::build<ELF64LE>();
3101 template void MipsGotSection::build<ELF64BE>();
3102
3103 template class elf::MipsAbiFlagsSection<ELF32LE>;
3104 template class elf::MipsAbiFlagsSection<ELF32BE>;
3105 template class elf::MipsAbiFlagsSection<ELF64LE>;
3106 template class elf::MipsAbiFlagsSection<ELF64BE>;
3107
3108 template class elf::MipsOptionsSection<ELF32LE>;
3109 template class elf::MipsOptionsSection<ELF32BE>;
3110 template class elf::MipsOptionsSection<ELF64LE>;
3111 template class elf::MipsOptionsSection<ELF64BE>;
3112
3113 template class elf::MipsReginfoSection<ELF32LE>;
3114 template class elf::MipsReginfoSection<ELF32BE>;
3115 template class elf::MipsReginfoSection<ELF64LE>;
3116 template class elf::MipsReginfoSection<ELF64BE>;
3117
3118 template class elf::DynamicSection<ELF32LE>;
3119 template class elf::DynamicSection<ELF32BE>;
3120 template class elf::DynamicSection<ELF64LE>;
3121 template class elf::DynamicSection<ELF64BE>;
3122
3123 template class elf::RelocationSection<ELF32LE>;
3124 template class elf::RelocationSection<ELF32BE>;
3125 template class elf::RelocationSection<ELF64LE>;
3126 template class elf::RelocationSection<ELF64BE>;
3127
3128 template class elf::AndroidPackedRelocationSection<ELF32LE>;
3129 template class elf::AndroidPackedRelocationSection<ELF32BE>;
3130 template class elf::AndroidPackedRelocationSection<ELF64LE>;
3131 template class elf::AndroidPackedRelocationSection<ELF64BE>;
3132
3133 template class elf::RelrSection<ELF32LE>;
3134 template class elf::RelrSection<ELF32BE>;
3135 template class elf::RelrSection<ELF64LE>;
3136 template class elf::RelrSection<ELF64BE>;
3137
3138 template class elf::SymbolTableSection<ELF32LE>;
3139 template class elf::SymbolTableSection<ELF32BE>;
3140 template class elf::SymbolTableSection<ELF64LE>;
3141 template class elf::SymbolTableSection<ELF64BE>;
3142
3143 template class elf::VersionTableSection<ELF32LE>;
3144 template class elf::VersionTableSection<ELF32BE>;
3145 template class elf::VersionTableSection<ELF64LE>;
3146 template class elf::VersionTableSection<ELF64BE>;
3147
3148 template class elf::VersionNeedSection<ELF32LE>;
3149 template class elf::VersionNeedSection<ELF32BE>;
3150 template class elf::VersionNeedSection<ELF64LE>;
3151 template class elf::VersionNeedSection<ELF64BE>;
3152
3153 template class elf::VersionDefinitionSection<ELF32LE>;
3154 template class elf::VersionDefinitionSection<ELF32BE>;
3155 template class elf::VersionDefinitionSection<ELF64LE>;
3156 template class elf::VersionDefinitionSection<ELF64BE>;