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