xref: /freebsd/contrib/llvm-project/lld/ELF/SyntheticSections.cpp (revision 23408297fbf3089f0388a8873b02fa75ab3f5bb9)
10b57cec5SDimitry Andric //===- SyntheticSections.cpp ----------------------------------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file contains linker-synthesized sections. Currently,
100b57cec5SDimitry Andric // synthetic sections are created either output sections or input sections,
110b57cec5SDimitry Andric // but we are rewriting code so that all synthetic sections are created as
120b57cec5SDimitry Andric // input sections.
130b57cec5SDimitry Andric //
140b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
150b57cec5SDimitry Andric 
160b57cec5SDimitry Andric #include "SyntheticSections.h"
170b57cec5SDimitry Andric #include "Config.h"
180b57cec5SDimitry Andric #include "InputFiles.h"
190b57cec5SDimitry Andric #include "LinkerScript.h"
200b57cec5SDimitry Andric #include "OutputSections.h"
210b57cec5SDimitry Andric #include "SymbolTable.h"
220b57cec5SDimitry Andric #include "Symbols.h"
230b57cec5SDimitry Andric #include "Target.h"
240b57cec5SDimitry Andric #include "Writer.h"
255ffd83dbSDimitry Andric #include "lld/Common/DWARF.h"
260b57cec5SDimitry Andric #include "lld/Common/ErrorHandler.h"
270b57cec5SDimitry Andric #include "lld/Common/Memory.h"
280b57cec5SDimitry Andric #include "lld/Common/Strings.h"
290b57cec5SDimitry Andric #include "lld/Common/Version.h"
300b57cec5SDimitry Andric #include "llvm/ADT/SetOperations.h"
310b57cec5SDimitry Andric #include "llvm/ADT/StringExtras.h"
320b57cec5SDimitry Andric #include "llvm/BinaryFormat/Dwarf.h"
330b57cec5SDimitry Andric #include "llvm/DebugInfo/DWARF/DWARFDebugPubTable.h"
340b57cec5SDimitry Andric #include "llvm/Object/ELFObjectFile.h"
350b57cec5SDimitry Andric #include "llvm/Support/Compression.h"
360b57cec5SDimitry Andric #include "llvm/Support/Endian.h"
370b57cec5SDimitry Andric #include "llvm/Support/LEB128.h"
380b57cec5SDimitry Andric #include "llvm/Support/MD5.h"
395ffd83dbSDimitry Andric #include "llvm/Support/Parallel.h"
405ffd83dbSDimitry Andric #include "llvm/Support/TimeProfiler.h"
410b57cec5SDimitry Andric #include <cstdlib>
420b57cec5SDimitry Andric #include <thread>
430b57cec5SDimitry Andric 
440b57cec5SDimitry Andric using namespace llvm;
450b57cec5SDimitry Andric using namespace llvm::dwarf;
460b57cec5SDimitry Andric using namespace llvm::ELF;
470b57cec5SDimitry Andric using namespace llvm::object;
480b57cec5SDimitry Andric using namespace llvm::support;
495ffd83dbSDimitry Andric using namespace lld;
505ffd83dbSDimitry Andric using namespace lld::elf;
510b57cec5SDimitry Andric 
520b57cec5SDimitry Andric using llvm::support::endian::read32le;
530b57cec5SDimitry Andric using llvm::support::endian::write32le;
540b57cec5SDimitry Andric using llvm::support::endian::write64le;
550b57cec5SDimitry Andric 
560b57cec5SDimitry Andric constexpr size_t MergeNoTailSection::numShards;
570b57cec5SDimitry Andric 
580b57cec5SDimitry Andric static uint64_t readUint(uint8_t *buf) {
590b57cec5SDimitry Andric   return config->is64 ? read64(buf) : read32(buf);
600b57cec5SDimitry Andric }
610b57cec5SDimitry Andric 
620b57cec5SDimitry Andric static void writeUint(uint8_t *buf, uint64_t val) {
630b57cec5SDimitry Andric   if (config->is64)
640b57cec5SDimitry Andric     write64(buf, val);
650b57cec5SDimitry Andric   else
660b57cec5SDimitry Andric     write32(buf, val);
670b57cec5SDimitry Andric }
680b57cec5SDimitry Andric 
690b57cec5SDimitry Andric // Returns an LLD version string.
700b57cec5SDimitry Andric static ArrayRef<uint8_t> getVersion() {
710b57cec5SDimitry Andric   // Check LLD_VERSION first for ease of testing.
720b57cec5SDimitry Andric   // You can get consistent output by using the environment variable.
730b57cec5SDimitry Andric   // This is only for testing.
740b57cec5SDimitry Andric   StringRef s = getenv("LLD_VERSION");
750b57cec5SDimitry Andric   if (s.empty())
760b57cec5SDimitry Andric     s = saver.save(Twine("Linker: ") + getLLDVersion());
770b57cec5SDimitry Andric 
780b57cec5SDimitry Andric   // +1 to include the terminating '\0'.
790b57cec5SDimitry Andric   return {(const uint8_t *)s.data(), s.size() + 1};
800b57cec5SDimitry Andric }
810b57cec5SDimitry Andric 
820b57cec5SDimitry Andric // Creates a .comment section containing LLD version info.
830b57cec5SDimitry Andric // With this feature, you can identify LLD-generated binaries easily
840b57cec5SDimitry Andric // by "readelf --string-dump .comment <file>".
850b57cec5SDimitry Andric // The returned object is a mergeable string section.
865ffd83dbSDimitry Andric MergeInputSection *elf::createCommentSection() {
870b57cec5SDimitry Andric   return make<MergeInputSection>(SHF_MERGE | SHF_STRINGS, SHT_PROGBITS, 1,
880b57cec5SDimitry Andric                                  getVersion(), ".comment");
890b57cec5SDimitry Andric }
900b57cec5SDimitry Andric 
910b57cec5SDimitry Andric // .MIPS.abiflags section.
920b57cec5SDimitry Andric template <class ELFT>
930b57cec5SDimitry Andric MipsAbiFlagsSection<ELFT>::MipsAbiFlagsSection(Elf_Mips_ABIFlags flags)
940b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_MIPS_ABIFLAGS, 8, ".MIPS.abiflags"),
950b57cec5SDimitry Andric       flags(flags) {
960b57cec5SDimitry Andric   this->entsize = sizeof(Elf_Mips_ABIFlags);
970b57cec5SDimitry Andric }
980b57cec5SDimitry Andric 
990b57cec5SDimitry Andric template <class ELFT> void MipsAbiFlagsSection<ELFT>::writeTo(uint8_t *buf) {
1000b57cec5SDimitry Andric   memcpy(buf, &flags, sizeof(flags));
1010b57cec5SDimitry Andric }
1020b57cec5SDimitry Andric 
1030b57cec5SDimitry Andric template <class ELFT>
1040b57cec5SDimitry Andric MipsAbiFlagsSection<ELFT> *MipsAbiFlagsSection<ELFT>::create() {
1050b57cec5SDimitry Andric   Elf_Mips_ABIFlags flags = {};
1060b57cec5SDimitry Andric   bool create = false;
1070b57cec5SDimitry Andric 
1080b57cec5SDimitry Andric   for (InputSectionBase *sec : inputSections) {
1090b57cec5SDimitry Andric     if (sec->type != SHT_MIPS_ABIFLAGS)
1100b57cec5SDimitry Andric       continue;
1110b57cec5SDimitry Andric     sec->markDead();
1120b57cec5SDimitry Andric     create = true;
1130b57cec5SDimitry Andric 
1140b57cec5SDimitry Andric     std::string filename = toString(sec->file);
1150b57cec5SDimitry Andric     const size_t size = sec->data().size();
1160b57cec5SDimitry Andric     // Older version of BFD (such as the default FreeBSD linker) concatenate
1170b57cec5SDimitry Andric     // .MIPS.abiflags instead of merging. To allow for this case (or potential
1180b57cec5SDimitry Andric     // zero padding) we ignore everything after the first Elf_Mips_ABIFlags
1190b57cec5SDimitry Andric     if (size < sizeof(Elf_Mips_ABIFlags)) {
1200b57cec5SDimitry Andric       error(filename + ": invalid size of .MIPS.abiflags section: got " +
1210b57cec5SDimitry Andric             Twine(size) + " instead of " + Twine(sizeof(Elf_Mips_ABIFlags)));
1220b57cec5SDimitry Andric       return nullptr;
1230b57cec5SDimitry Andric     }
1240b57cec5SDimitry Andric     auto *s = reinterpret_cast<const Elf_Mips_ABIFlags *>(sec->data().data());
1250b57cec5SDimitry Andric     if (s->version != 0) {
1260b57cec5SDimitry Andric       error(filename + ": unexpected .MIPS.abiflags version " +
1270b57cec5SDimitry Andric             Twine(s->version));
1280b57cec5SDimitry Andric       return nullptr;
1290b57cec5SDimitry Andric     }
1300b57cec5SDimitry Andric 
1310b57cec5SDimitry Andric     // LLD checks ISA compatibility in calcMipsEFlags(). Here we just
1320b57cec5SDimitry Andric     // select the highest number of ISA/Rev/Ext.
1330b57cec5SDimitry Andric     flags.isa_level = std::max(flags.isa_level, s->isa_level);
1340b57cec5SDimitry Andric     flags.isa_rev = std::max(flags.isa_rev, s->isa_rev);
1350b57cec5SDimitry Andric     flags.isa_ext = std::max(flags.isa_ext, s->isa_ext);
1360b57cec5SDimitry Andric     flags.gpr_size = std::max(flags.gpr_size, s->gpr_size);
1370b57cec5SDimitry Andric     flags.cpr1_size = std::max(flags.cpr1_size, s->cpr1_size);
1380b57cec5SDimitry Andric     flags.cpr2_size = std::max(flags.cpr2_size, s->cpr2_size);
1390b57cec5SDimitry Andric     flags.ases |= s->ases;
1400b57cec5SDimitry Andric     flags.flags1 |= s->flags1;
1410b57cec5SDimitry Andric     flags.flags2 |= s->flags2;
1425ffd83dbSDimitry Andric     flags.fp_abi = elf::getMipsFpAbiFlag(flags.fp_abi, s->fp_abi, filename);
1430b57cec5SDimitry Andric   };
1440b57cec5SDimitry Andric 
1450b57cec5SDimitry Andric   if (create)
1460b57cec5SDimitry Andric     return make<MipsAbiFlagsSection<ELFT>>(flags);
1470b57cec5SDimitry Andric   return nullptr;
1480b57cec5SDimitry Andric }
1490b57cec5SDimitry Andric 
1500b57cec5SDimitry Andric // .MIPS.options section.
1510b57cec5SDimitry Andric template <class ELFT>
1520b57cec5SDimitry Andric MipsOptionsSection<ELFT>::MipsOptionsSection(Elf_Mips_RegInfo reginfo)
1530b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_MIPS_OPTIONS, 8, ".MIPS.options"),
1540b57cec5SDimitry Andric       reginfo(reginfo) {
1550b57cec5SDimitry Andric   this->entsize = sizeof(Elf_Mips_Options) + sizeof(Elf_Mips_RegInfo);
1560b57cec5SDimitry Andric }
1570b57cec5SDimitry Andric 
1580b57cec5SDimitry Andric template <class ELFT> void MipsOptionsSection<ELFT>::writeTo(uint8_t *buf) {
1590b57cec5SDimitry Andric   auto *options = reinterpret_cast<Elf_Mips_Options *>(buf);
1600b57cec5SDimitry Andric   options->kind = ODK_REGINFO;
1610b57cec5SDimitry Andric   options->size = getSize();
1620b57cec5SDimitry Andric 
1630b57cec5SDimitry Andric   if (!config->relocatable)
1640b57cec5SDimitry Andric     reginfo.ri_gp_value = in.mipsGot->getGp();
1650b57cec5SDimitry Andric   memcpy(buf + sizeof(Elf_Mips_Options), &reginfo, sizeof(reginfo));
1660b57cec5SDimitry Andric }
1670b57cec5SDimitry Andric 
1680b57cec5SDimitry Andric template <class ELFT>
1690b57cec5SDimitry Andric MipsOptionsSection<ELFT> *MipsOptionsSection<ELFT>::create() {
1700b57cec5SDimitry Andric   // N64 ABI only.
1710b57cec5SDimitry Andric   if (!ELFT::Is64Bits)
1720b57cec5SDimitry Andric     return nullptr;
1730b57cec5SDimitry Andric 
1740b57cec5SDimitry Andric   std::vector<InputSectionBase *> sections;
1750b57cec5SDimitry Andric   for (InputSectionBase *sec : inputSections)
1760b57cec5SDimitry Andric     if (sec->type == SHT_MIPS_OPTIONS)
1770b57cec5SDimitry Andric       sections.push_back(sec);
1780b57cec5SDimitry Andric 
1790b57cec5SDimitry Andric   if (sections.empty())
1800b57cec5SDimitry Andric     return nullptr;
1810b57cec5SDimitry Andric 
1820b57cec5SDimitry Andric   Elf_Mips_RegInfo reginfo = {};
1830b57cec5SDimitry Andric   for (InputSectionBase *sec : sections) {
1840b57cec5SDimitry Andric     sec->markDead();
1850b57cec5SDimitry Andric 
1860b57cec5SDimitry Andric     std::string filename = toString(sec->file);
1870b57cec5SDimitry Andric     ArrayRef<uint8_t> d = sec->data();
1880b57cec5SDimitry Andric 
1890b57cec5SDimitry Andric     while (!d.empty()) {
1900b57cec5SDimitry Andric       if (d.size() < sizeof(Elf_Mips_Options)) {
1910b57cec5SDimitry Andric         error(filename + ": invalid size of .MIPS.options section");
1920b57cec5SDimitry Andric         break;
1930b57cec5SDimitry Andric       }
1940b57cec5SDimitry Andric 
1950b57cec5SDimitry Andric       auto *opt = reinterpret_cast<const Elf_Mips_Options *>(d.data());
1960b57cec5SDimitry Andric       if (opt->kind == ODK_REGINFO) {
1970b57cec5SDimitry Andric         reginfo.ri_gprmask |= opt->getRegInfo().ri_gprmask;
1980b57cec5SDimitry Andric         sec->getFile<ELFT>()->mipsGp0 = opt->getRegInfo().ri_gp_value;
1990b57cec5SDimitry Andric         break;
2000b57cec5SDimitry Andric       }
2010b57cec5SDimitry Andric 
2020b57cec5SDimitry Andric       if (!opt->size)
2030b57cec5SDimitry Andric         fatal(filename + ": zero option descriptor size");
2040b57cec5SDimitry Andric       d = d.slice(opt->size);
2050b57cec5SDimitry Andric     }
2060b57cec5SDimitry Andric   };
2070b57cec5SDimitry Andric 
2080b57cec5SDimitry Andric   return make<MipsOptionsSection<ELFT>>(reginfo);
2090b57cec5SDimitry Andric }
2100b57cec5SDimitry Andric 
2110b57cec5SDimitry Andric // MIPS .reginfo section.
2120b57cec5SDimitry Andric template <class ELFT>
2130b57cec5SDimitry Andric MipsReginfoSection<ELFT>::MipsReginfoSection(Elf_Mips_RegInfo reginfo)
2140b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_MIPS_REGINFO, 4, ".reginfo"),
2150b57cec5SDimitry Andric       reginfo(reginfo) {
2160b57cec5SDimitry Andric   this->entsize = sizeof(Elf_Mips_RegInfo);
2170b57cec5SDimitry Andric }
2180b57cec5SDimitry Andric 
2190b57cec5SDimitry Andric template <class ELFT> void MipsReginfoSection<ELFT>::writeTo(uint8_t *buf) {
2200b57cec5SDimitry Andric   if (!config->relocatable)
2210b57cec5SDimitry Andric     reginfo.ri_gp_value = in.mipsGot->getGp();
2220b57cec5SDimitry Andric   memcpy(buf, &reginfo, sizeof(reginfo));
2230b57cec5SDimitry Andric }
2240b57cec5SDimitry Andric 
2250b57cec5SDimitry Andric template <class ELFT>
2260b57cec5SDimitry Andric MipsReginfoSection<ELFT> *MipsReginfoSection<ELFT>::create() {
2270b57cec5SDimitry Andric   // Section should be alive for O32 and N32 ABIs only.
2280b57cec5SDimitry Andric   if (ELFT::Is64Bits)
2290b57cec5SDimitry Andric     return nullptr;
2300b57cec5SDimitry Andric 
2310b57cec5SDimitry Andric   std::vector<InputSectionBase *> sections;
2320b57cec5SDimitry Andric   for (InputSectionBase *sec : inputSections)
2330b57cec5SDimitry Andric     if (sec->type == SHT_MIPS_REGINFO)
2340b57cec5SDimitry Andric       sections.push_back(sec);
2350b57cec5SDimitry Andric 
2360b57cec5SDimitry Andric   if (sections.empty())
2370b57cec5SDimitry Andric     return nullptr;
2380b57cec5SDimitry Andric 
2390b57cec5SDimitry Andric   Elf_Mips_RegInfo reginfo = {};
2400b57cec5SDimitry Andric   for (InputSectionBase *sec : sections) {
2410b57cec5SDimitry Andric     sec->markDead();
2420b57cec5SDimitry Andric 
2430b57cec5SDimitry Andric     if (sec->data().size() != sizeof(Elf_Mips_RegInfo)) {
2440b57cec5SDimitry Andric       error(toString(sec->file) + ": invalid size of .reginfo section");
2450b57cec5SDimitry Andric       return nullptr;
2460b57cec5SDimitry Andric     }
2470b57cec5SDimitry Andric 
2480b57cec5SDimitry Andric     auto *r = reinterpret_cast<const Elf_Mips_RegInfo *>(sec->data().data());
2490b57cec5SDimitry Andric     reginfo.ri_gprmask |= r->ri_gprmask;
2500b57cec5SDimitry Andric     sec->getFile<ELFT>()->mipsGp0 = r->ri_gp_value;
2510b57cec5SDimitry Andric   };
2520b57cec5SDimitry Andric 
2530b57cec5SDimitry Andric   return make<MipsReginfoSection<ELFT>>(reginfo);
2540b57cec5SDimitry Andric }
2550b57cec5SDimitry Andric 
2565ffd83dbSDimitry Andric InputSection *elf::createInterpSection() {
2570b57cec5SDimitry Andric   // StringSaver guarantees that the returned string ends with '\0'.
2580b57cec5SDimitry Andric   StringRef s = saver.save(config->dynamicLinker);
2590b57cec5SDimitry Andric   ArrayRef<uint8_t> contents = {(const uint8_t *)s.data(), s.size() + 1};
2600b57cec5SDimitry Andric 
26185868e8aSDimitry Andric   return make<InputSection>(nullptr, SHF_ALLOC, SHT_PROGBITS, 1, contents,
2620b57cec5SDimitry Andric                             ".interp");
2630b57cec5SDimitry Andric }
2640b57cec5SDimitry Andric 
2655ffd83dbSDimitry Andric Defined *elf::addSyntheticLocal(StringRef name, uint8_t type, uint64_t value,
2660b57cec5SDimitry Andric                                 uint64_t size, InputSectionBase &section) {
2670b57cec5SDimitry Andric   auto *s = make<Defined>(section.file, name, STB_LOCAL, STV_DEFAULT, type,
2680b57cec5SDimitry Andric                           value, size, &section);
2690b57cec5SDimitry Andric   if (in.symTab)
2700b57cec5SDimitry Andric     in.symTab->addSymbol(s);
2710b57cec5SDimitry Andric   return s;
2720b57cec5SDimitry Andric }
2730b57cec5SDimitry Andric 
2740b57cec5SDimitry Andric static size_t getHashSize() {
2750b57cec5SDimitry Andric   switch (config->buildId) {
2760b57cec5SDimitry Andric   case BuildIdKind::Fast:
2770b57cec5SDimitry Andric     return 8;
2780b57cec5SDimitry Andric   case BuildIdKind::Md5:
2790b57cec5SDimitry Andric   case BuildIdKind::Uuid:
2800b57cec5SDimitry Andric     return 16;
2810b57cec5SDimitry Andric   case BuildIdKind::Sha1:
2820b57cec5SDimitry Andric     return 20;
2830b57cec5SDimitry Andric   case BuildIdKind::Hexstring:
2840b57cec5SDimitry Andric     return config->buildIdVector.size();
2850b57cec5SDimitry Andric   default:
2860b57cec5SDimitry Andric     llvm_unreachable("unknown BuildIdKind");
2870b57cec5SDimitry Andric   }
2880b57cec5SDimitry Andric }
2890b57cec5SDimitry Andric 
2900b57cec5SDimitry Andric // This class represents a linker-synthesized .note.gnu.property section.
2910b57cec5SDimitry Andric //
2920b57cec5SDimitry Andric // In x86 and AArch64, object files may contain feature flags indicating the
2930b57cec5SDimitry Andric // features that they have used. The flags are stored in a .note.gnu.property
2940b57cec5SDimitry Andric // section.
2950b57cec5SDimitry Andric //
2960b57cec5SDimitry Andric // lld reads the sections from input files and merges them by computing AND of
2970b57cec5SDimitry Andric // the flags. The result is written as a new .note.gnu.property section.
2980b57cec5SDimitry Andric //
2990b57cec5SDimitry Andric // If the flag is zero (which indicates that the intersection of the feature
3000b57cec5SDimitry Andric // sets is empty, or some input files didn't have .note.gnu.property sections),
3010b57cec5SDimitry Andric // we don't create this section.
3020b57cec5SDimitry Andric GnuPropertySection::GnuPropertySection()
303480093f4SDimitry Andric     : SyntheticSection(llvm::ELF::SHF_ALLOC, llvm::ELF::SHT_NOTE,
304480093f4SDimitry Andric                        config->wordsize, ".note.gnu.property") {}
3050b57cec5SDimitry Andric 
3060b57cec5SDimitry Andric void GnuPropertySection::writeTo(uint8_t *buf) {
3070b57cec5SDimitry Andric   uint32_t featureAndType = config->emachine == EM_AARCH64
3080b57cec5SDimitry Andric                                 ? GNU_PROPERTY_AARCH64_FEATURE_1_AND
3090b57cec5SDimitry Andric                                 : GNU_PROPERTY_X86_FEATURE_1_AND;
3100b57cec5SDimitry Andric 
3110b57cec5SDimitry Andric   write32(buf, 4);                                   // Name size
3120b57cec5SDimitry Andric   write32(buf + 4, config->is64 ? 16 : 12);          // Content size
3130b57cec5SDimitry Andric   write32(buf + 8, NT_GNU_PROPERTY_TYPE_0);          // Type
3140b57cec5SDimitry Andric   memcpy(buf + 12, "GNU", 4);                        // Name string
3150b57cec5SDimitry Andric   write32(buf + 16, featureAndType);                 // Feature type
3160b57cec5SDimitry Andric   write32(buf + 20, 4);                              // Feature size
3170b57cec5SDimitry Andric   write32(buf + 24, config->andFeatures);            // Feature flags
3180b57cec5SDimitry Andric   if (config->is64)
3190b57cec5SDimitry Andric     write32(buf + 28, 0); // Padding
3200b57cec5SDimitry Andric }
3210b57cec5SDimitry Andric 
3220b57cec5SDimitry Andric size_t GnuPropertySection::getSize() const { return config->is64 ? 32 : 28; }
3230b57cec5SDimitry Andric 
3240b57cec5SDimitry Andric BuildIdSection::BuildIdSection()
3250b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_NOTE, 4, ".note.gnu.build-id"),
3260b57cec5SDimitry Andric       hashSize(getHashSize()) {}
3270b57cec5SDimitry Andric 
3280b57cec5SDimitry Andric void BuildIdSection::writeTo(uint8_t *buf) {
3290b57cec5SDimitry Andric   write32(buf, 4);                      // Name size
3300b57cec5SDimitry Andric   write32(buf + 4, hashSize);           // Content size
3310b57cec5SDimitry Andric   write32(buf + 8, NT_GNU_BUILD_ID);    // Type
3320b57cec5SDimitry Andric   memcpy(buf + 12, "GNU", 4);           // Name string
3330b57cec5SDimitry Andric   hashBuf = buf + 16;
3340b57cec5SDimitry Andric }
3350b57cec5SDimitry Andric 
3360b57cec5SDimitry Andric void BuildIdSection::writeBuildId(ArrayRef<uint8_t> buf) {
3370b57cec5SDimitry Andric   assert(buf.size() == hashSize);
3380b57cec5SDimitry Andric   memcpy(hashBuf, buf.data(), hashSize);
3390b57cec5SDimitry Andric }
3400b57cec5SDimitry Andric 
3410b57cec5SDimitry Andric BssSection::BssSection(StringRef name, uint64_t size, uint32_t alignment)
3420b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_NOBITS, alignment, name) {
3430b57cec5SDimitry Andric   this->bss = true;
3440b57cec5SDimitry Andric   this->size = size;
3450b57cec5SDimitry Andric }
3460b57cec5SDimitry Andric 
3470b57cec5SDimitry Andric EhFrameSection::EhFrameSection()
3480b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 1, ".eh_frame") {}
3490b57cec5SDimitry Andric 
3500b57cec5SDimitry Andric // Search for an existing CIE record or create a new one.
3510b57cec5SDimitry Andric // CIE records from input object files are uniquified by their contents
3520b57cec5SDimitry Andric // and where their relocations point to.
3530b57cec5SDimitry Andric template <class ELFT, class RelTy>
3540b57cec5SDimitry Andric CieRecord *EhFrameSection::addCie(EhSectionPiece &cie, ArrayRef<RelTy> rels) {
3550b57cec5SDimitry Andric   Symbol *personality = nullptr;
3560b57cec5SDimitry Andric   unsigned firstRelI = cie.firstRelocation;
3570b57cec5SDimitry Andric   if (firstRelI != (unsigned)-1)
3580b57cec5SDimitry Andric     personality =
3590b57cec5SDimitry Andric         &cie.sec->template getFile<ELFT>()->getRelocTargetSym(rels[firstRelI]);
3600b57cec5SDimitry Andric 
3610b57cec5SDimitry Andric   // Search for an existing CIE by CIE contents/relocation target pair.
3620b57cec5SDimitry Andric   CieRecord *&rec = cieMap[{cie.data(), personality}];
3630b57cec5SDimitry Andric 
3640b57cec5SDimitry Andric   // If not found, create a new one.
3650b57cec5SDimitry Andric   if (!rec) {
3660b57cec5SDimitry Andric     rec = make<CieRecord>();
3670b57cec5SDimitry Andric     rec->cie = &cie;
3680b57cec5SDimitry Andric     cieRecords.push_back(rec);
3690b57cec5SDimitry Andric   }
3700b57cec5SDimitry Andric   return rec;
3710b57cec5SDimitry Andric }
3720b57cec5SDimitry Andric 
373e8d8bef9SDimitry Andric // There is one FDE per function. Returns a non-null pointer to the function
374e8d8bef9SDimitry Andric // symbol if the given FDE points to a live function.
3750b57cec5SDimitry Andric template <class ELFT, class RelTy>
376e8d8bef9SDimitry Andric Defined *EhFrameSection::isFdeLive(EhSectionPiece &fde, ArrayRef<RelTy> rels) {
3770b57cec5SDimitry Andric   auto *sec = cast<EhInputSection>(fde.sec);
3780b57cec5SDimitry Andric   unsigned firstRelI = fde.firstRelocation;
3790b57cec5SDimitry Andric 
3800b57cec5SDimitry Andric   // An FDE should point to some function because FDEs are to describe
3810b57cec5SDimitry Andric   // functions. That's however not always the case due to an issue of
3820b57cec5SDimitry Andric   // ld.gold with -r. ld.gold may discard only functions and leave their
3830b57cec5SDimitry Andric   // corresponding FDEs, which results in creating bad .eh_frame sections.
3840b57cec5SDimitry Andric   // To deal with that, we ignore such FDEs.
3850b57cec5SDimitry Andric   if (firstRelI == (unsigned)-1)
386e8d8bef9SDimitry Andric     return nullptr;
3870b57cec5SDimitry Andric 
3880b57cec5SDimitry Andric   const RelTy &rel = rels[firstRelI];
3890b57cec5SDimitry Andric   Symbol &b = sec->template getFile<ELFT>()->getRelocTargetSym(rel);
3900b57cec5SDimitry Andric 
3910b57cec5SDimitry Andric   // FDEs for garbage-collected or merged-by-ICF sections, or sections in
3920b57cec5SDimitry Andric   // another partition, are dead.
3930b57cec5SDimitry Andric   if (auto *d = dyn_cast<Defined>(&b))
394e8d8bef9SDimitry Andric     if (d->section && d->section->partition == partition)
395e8d8bef9SDimitry Andric       return d;
396e8d8bef9SDimitry Andric   return nullptr;
3970b57cec5SDimitry Andric }
3980b57cec5SDimitry Andric 
3990b57cec5SDimitry Andric // .eh_frame is a sequence of CIE or FDE records. In general, there
4000b57cec5SDimitry Andric // is one CIE record per input object file which is followed by
4010b57cec5SDimitry Andric // a list of FDEs. This function searches an existing CIE or create a new
4020b57cec5SDimitry Andric // one and associates FDEs to the CIE.
4030b57cec5SDimitry Andric template <class ELFT, class RelTy>
40485868e8aSDimitry Andric void EhFrameSection::addRecords(EhInputSection *sec, ArrayRef<RelTy> rels) {
4050b57cec5SDimitry Andric   offsetToCie.clear();
4060b57cec5SDimitry Andric   for (EhSectionPiece &piece : sec->pieces) {
4070b57cec5SDimitry Andric     // The empty record is the end marker.
4080b57cec5SDimitry Andric     if (piece.size == 4)
4090b57cec5SDimitry Andric       return;
4100b57cec5SDimitry Andric 
4110b57cec5SDimitry Andric     size_t offset = piece.inputOff;
4120b57cec5SDimitry Andric     uint32_t id = read32(piece.data().data() + 4);
4130b57cec5SDimitry Andric     if (id == 0) {
4140b57cec5SDimitry Andric       offsetToCie[offset] = addCie<ELFT>(piece, rels);
4150b57cec5SDimitry Andric       continue;
4160b57cec5SDimitry Andric     }
4170b57cec5SDimitry Andric 
4180b57cec5SDimitry Andric     uint32_t cieOffset = offset + 4 - id;
4190b57cec5SDimitry Andric     CieRecord *rec = offsetToCie[cieOffset];
4200b57cec5SDimitry Andric     if (!rec)
4210b57cec5SDimitry Andric       fatal(toString(sec) + ": invalid CIE reference");
4220b57cec5SDimitry Andric 
4230b57cec5SDimitry Andric     if (!isFdeLive<ELFT>(piece, rels))
4240b57cec5SDimitry Andric       continue;
4250b57cec5SDimitry Andric     rec->fdes.push_back(&piece);
4260b57cec5SDimitry Andric     numFdes++;
4270b57cec5SDimitry Andric   }
4280b57cec5SDimitry Andric }
4290b57cec5SDimitry Andric 
43085868e8aSDimitry Andric template <class ELFT>
43185868e8aSDimitry Andric void EhFrameSection::addSectionAux(EhInputSection *sec) {
43285868e8aSDimitry Andric   if (!sec->isLive())
43385868e8aSDimitry Andric     return;
43485868e8aSDimitry Andric   if (sec->areRelocsRela)
43585868e8aSDimitry Andric     addRecords<ELFT>(sec, sec->template relas<ELFT>());
43685868e8aSDimitry Andric   else
43785868e8aSDimitry Andric     addRecords<ELFT>(sec, sec->template rels<ELFT>());
43885868e8aSDimitry Andric }
43985868e8aSDimitry Andric 
44085868e8aSDimitry Andric void EhFrameSection::addSection(EhInputSection *sec) {
4410b57cec5SDimitry Andric   sec->parent = this;
4420b57cec5SDimitry Andric 
4430b57cec5SDimitry Andric   alignment = std::max(alignment, sec->alignment);
4440b57cec5SDimitry Andric   sections.push_back(sec);
4450b57cec5SDimitry Andric 
4460b57cec5SDimitry Andric   for (auto *ds : sec->dependentSections)
4470b57cec5SDimitry Andric     dependentSections.push_back(ds);
4480b57cec5SDimitry Andric }
4490b57cec5SDimitry Andric 
450e8d8bef9SDimitry Andric // Used by ICF<ELFT>::handleLSDA(). This function is very similar to
451e8d8bef9SDimitry Andric // EhFrameSection::addRecords().
452e8d8bef9SDimitry Andric template <class ELFT, class RelTy>
453e8d8bef9SDimitry Andric void EhFrameSection::iterateFDEWithLSDAAux(
454e8d8bef9SDimitry Andric     EhInputSection &sec, ArrayRef<RelTy> rels, DenseSet<size_t> &ciesWithLSDA,
455e8d8bef9SDimitry Andric     llvm::function_ref<void(InputSection &)> fn) {
456e8d8bef9SDimitry Andric   for (EhSectionPiece &piece : sec.pieces) {
457e8d8bef9SDimitry Andric     // Skip ZERO terminator.
458e8d8bef9SDimitry Andric     if (piece.size == 4)
459e8d8bef9SDimitry Andric       continue;
460e8d8bef9SDimitry Andric 
461e8d8bef9SDimitry Andric     size_t offset = piece.inputOff;
462e8d8bef9SDimitry Andric     uint32_t id =
463e8d8bef9SDimitry Andric         endian::read32<ELFT::TargetEndianness>(piece.data().data() + 4);
464e8d8bef9SDimitry Andric     if (id == 0) {
465e8d8bef9SDimitry Andric       if (hasLSDA(piece))
466e8d8bef9SDimitry Andric         ciesWithLSDA.insert(offset);
467e8d8bef9SDimitry Andric       continue;
468e8d8bef9SDimitry Andric     }
469e8d8bef9SDimitry Andric     uint32_t cieOffset = offset + 4 - id;
470e8d8bef9SDimitry Andric     if (ciesWithLSDA.count(cieOffset) == 0)
471e8d8bef9SDimitry Andric       continue;
472e8d8bef9SDimitry Andric 
473e8d8bef9SDimitry Andric     // The CIE has a LSDA argument. Call fn with d's section.
474e8d8bef9SDimitry Andric     if (Defined *d = isFdeLive<ELFT>(piece, rels))
475e8d8bef9SDimitry Andric       if (auto *s = dyn_cast_or_null<InputSection>(d->section))
476e8d8bef9SDimitry Andric         fn(*s);
477e8d8bef9SDimitry Andric   }
478e8d8bef9SDimitry Andric }
479e8d8bef9SDimitry Andric 
480e8d8bef9SDimitry Andric template <class ELFT>
481e8d8bef9SDimitry Andric void EhFrameSection::iterateFDEWithLSDA(
482e8d8bef9SDimitry Andric     llvm::function_ref<void(InputSection &)> fn) {
483e8d8bef9SDimitry Andric   DenseSet<size_t> ciesWithLSDA;
484e8d8bef9SDimitry Andric   for (EhInputSection *sec : sections) {
485e8d8bef9SDimitry Andric     ciesWithLSDA.clear();
486e8d8bef9SDimitry Andric     if (sec->areRelocsRela)
487e8d8bef9SDimitry Andric       iterateFDEWithLSDAAux<ELFT>(*sec, sec->template relas<ELFT>(),
488e8d8bef9SDimitry Andric                                   ciesWithLSDA, fn);
489e8d8bef9SDimitry Andric     else
490e8d8bef9SDimitry Andric       iterateFDEWithLSDAAux<ELFT>(*sec, sec->template rels<ELFT>(),
491e8d8bef9SDimitry Andric                                   ciesWithLSDA, fn);
492e8d8bef9SDimitry Andric   }
493e8d8bef9SDimitry Andric }
494e8d8bef9SDimitry Andric 
4950b57cec5SDimitry Andric static void writeCieFde(uint8_t *buf, ArrayRef<uint8_t> d) {
4960b57cec5SDimitry Andric   memcpy(buf, d.data(), d.size());
4970b57cec5SDimitry Andric 
4980b57cec5SDimitry Andric   size_t aligned = alignTo(d.size(), config->wordsize);
4990b57cec5SDimitry Andric 
5000b57cec5SDimitry Andric   // Zero-clear trailing padding if it exists.
5010b57cec5SDimitry Andric   memset(buf + d.size(), 0, aligned - d.size());
5020b57cec5SDimitry Andric 
5030b57cec5SDimitry Andric   // Fix the size field. -4 since size does not include the size field itself.
5040b57cec5SDimitry Andric   write32(buf, aligned - 4);
5050b57cec5SDimitry Andric }
5060b57cec5SDimitry Andric 
5070b57cec5SDimitry Andric void EhFrameSection::finalizeContents() {
5080b57cec5SDimitry Andric   assert(!this->size); // Not finalized.
50985868e8aSDimitry Andric 
51085868e8aSDimitry Andric   switch (config->ekind) {
51185868e8aSDimitry Andric   case ELFNoneKind:
51285868e8aSDimitry Andric     llvm_unreachable("invalid ekind");
51385868e8aSDimitry Andric   case ELF32LEKind:
51485868e8aSDimitry Andric     for (EhInputSection *sec : sections)
51585868e8aSDimitry Andric       addSectionAux<ELF32LE>(sec);
51685868e8aSDimitry Andric     break;
51785868e8aSDimitry Andric   case ELF32BEKind:
51885868e8aSDimitry Andric     for (EhInputSection *sec : sections)
51985868e8aSDimitry Andric       addSectionAux<ELF32BE>(sec);
52085868e8aSDimitry Andric     break;
52185868e8aSDimitry Andric   case ELF64LEKind:
52285868e8aSDimitry Andric     for (EhInputSection *sec : sections)
52385868e8aSDimitry Andric       addSectionAux<ELF64LE>(sec);
52485868e8aSDimitry Andric     break;
52585868e8aSDimitry Andric   case ELF64BEKind:
52685868e8aSDimitry Andric     for (EhInputSection *sec : sections)
52785868e8aSDimitry Andric       addSectionAux<ELF64BE>(sec);
52885868e8aSDimitry Andric     break;
52985868e8aSDimitry Andric   }
53085868e8aSDimitry Andric 
5310b57cec5SDimitry Andric   size_t off = 0;
5320b57cec5SDimitry Andric   for (CieRecord *rec : cieRecords) {
5330b57cec5SDimitry Andric     rec->cie->outputOff = off;
5340b57cec5SDimitry Andric     off += alignTo(rec->cie->size, config->wordsize);
5350b57cec5SDimitry Andric 
5360b57cec5SDimitry Andric     for (EhSectionPiece *fde : rec->fdes) {
5370b57cec5SDimitry Andric       fde->outputOff = off;
5380b57cec5SDimitry Andric       off += alignTo(fde->size, config->wordsize);
5390b57cec5SDimitry Andric     }
5400b57cec5SDimitry Andric   }
5410b57cec5SDimitry Andric 
5420b57cec5SDimitry Andric   // The LSB standard does not allow a .eh_frame section with zero
5430b57cec5SDimitry Andric   // Call Frame Information records. glibc unwind-dw2-fde.c
5440b57cec5SDimitry Andric   // classify_object_over_fdes expects there is a CIE record length 0 as a
5450b57cec5SDimitry Andric   // terminator. Thus we add one unconditionally.
5460b57cec5SDimitry Andric   off += 4;
5470b57cec5SDimitry Andric 
5480b57cec5SDimitry Andric   this->size = off;
5490b57cec5SDimitry Andric }
5500b57cec5SDimitry Andric 
5510b57cec5SDimitry Andric // Returns data for .eh_frame_hdr. .eh_frame_hdr is a binary search table
5520b57cec5SDimitry Andric // to get an FDE from an address to which FDE is applied. This function
5530b57cec5SDimitry Andric // returns a list of such pairs.
5540b57cec5SDimitry Andric std::vector<EhFrameSection::FdeData> EhFrameSection::getFdeData() const {
5550b57cec5SDimitry Andric   uint8_t *buf = Out::bufferStart + getParent()->offset + outSecOff;
5560b57cec5SDimitry Andric   std::vector<FdeData> ret;
5570b57cec5SDimitry Andric 
5580b57cec5SDimitry Andric   uint64_t va = getPartition().ehFrameHdr->getVA();
5590b57cec5SDimitry Andric   for (CieRecord *rec : cieRecords) {
5600b57cec5SDimitry Andric     uint8_t enc = getFdeEncoding(rec->cie);
5610b57cec5SDimitry Andric     for (EhSectionPiece *fde : rec->fdes) {
5620b57cec5SDimitry Andric       uint64_t pc = getFdePc(buf, fde->outputOff, enc);
5630b57cec5SDimitry Andric       uint64_t fdeVA = getParent()->addr + fde->outputOff;
5640b57cec5SDimitry Andric       if (!isInt<32>(pc - va))
5650b57cec5SDimitry Andric         fatal(toString(fde->sec) + ": PC offset is too large: 0x" +
5660b57cec5SDimitry Andric               Twine::utohexstr(pc - va));
5670b57cec5SDimitry Andric       ret.push_back({uint32_t(pc - va), uint32_t(fdeVA - va)});
5680b57cec5SDimitry Andric     }
5690b57cec5SDimitry Andric   }
5700b57cec5SDimitry Andric 
5710b57cec5SDimitry Andric   // Sort the FDE list by their PC and uniqueify. Usually there is only
5720b57cec5SDimitry Andric   // one FDE for a PC (i.e. function), but if ICF merges two functions
5730b57cec5SDimitry Andric   // into one, there can be more than one FDEs pointing to the address.
5740b57cec5SDimitry Andric   auto less = [](const FdeData &a, const FdeData &b) {
5750b57cec5SDimitry Andric     return a.pcRel < b.pcRel;
5760b57cec5SDimitry Andric   };
5770b57cec5SDimitry Andric   llvm::stable_sort(ret, less);
5780b57cec5SDimitry Andric   auto eq = [](const FdeData &a, const FdeData &b) {
5790b57cec5SDimitry Andric     return a.pcRel == b.pcRel;
5800b57cec5SDimitry Andric   };
5810b57cec5SDimitry Andric   ret.erase(std::unique(ret.begin(), ret.end(), eq), ret.end());
5820b57cec5SDimitry Andric 
5830b57cec5SDimitry Andric   return ret;
5840b57cec5SDimitry Andric }
5850b57cec5SDimitry Andric 
5860b57cec5SDimitry Andric static uint64_t readFdeAddr(uint8_t *buf, int size) {
5870b57cec5SDimitry Andric   switch (size) {
5880b57cec5SDimitry Andric   case DW_EH_PE_udata2:
5890b57cec5SDimitry Andric     return read16(buf);
5900b57cec5SDimitry Andric   case DW_EH_PE_sdata2:
5910b57cec5SDimitry Andric     return (int16_t)read16(buf);
5920b57cec5SDimitry Andric   case DW_EH_PE_udata4:
5930b57cec5SDimitry Andric     return read32(buf);
5940b57cec5SDimitry Andric   case DW_EH_PE_sdata4:
5950b57cec5SDimitry Andric     return (int32_t)read32(buf);
5960b57cec5SDimitry Andric   case DW_EH_PE_udata8:
5970b57cec5SDimitry Andric   case DW_EH_PE_sdata8:
5980b57cec5SDimitry Andric     return read64(buf);
5990b57cec5SDimitry Andric   case DW_EH_PE_absptr:
6000b57cec5SDimitry Andric     return readUint(buf);
6010b57cec5SDimitry Andric   }
6020b57cec5SDimitry Andric   fatal("unknown FDE size encoding");
6030b57cec5SDimitry Andric }
6040b57cec5SDimitry Andric 
6050b57cec5SDimitry Andric // Returns the VA to which a given FDE (on a mmap'ed buffer) is applied to.
6060b57cec5SDimitry Andric // We need it to create .eh_frame_hdr section.
6070b57cec5SDimitry Andric uint64_t EhFrameSection::getFdePc(uint8_t *buf, size_t fdeOff,
6080b57cec5SDimitry Andric                                   uint8_t enc) const {
6090b57cec5SDimitry Andric   // The starting address to which this FDE applies is
6100b57cec5SDimitry Andric   // stored at FDE + 8 byte.
6110b57cec5SDimitry Andric   size_t off = fdeOff + 8;
6120b57cec5SDimitry Andric   uint64_t addr = readFdeAddr(buf + off, enc & 0xf);
6130b57cec5SDimitry Andric   if ((enc & 0x70) == DW_EH_PE_absptr)
6140b57cec5SDimitry Andric     return addr;
6150b57cec5SDimitry Andric   if ((enc & 0x70) == DW_EH_PE_pcrel)
6160b57cec5SDimitry Andric     return addr + getParent()->addr + off;
6170b57cec5SDimitry Andric   fatal("unknown FDE size relative encoding");
6180b57cec5SDimitry Andric }
6190b57cec5SDimitry Andric 
6200b57cec5SDimitry Andric void EhFrameSection::writeTo(uint8_t *buf) {
6210b57cec5SDimitry Andric   // Write CIE and FDE records.
6220b57cec5SDimitry Andric   for (CieRecord *rec : cieRecords) {
6230b57cec5SDimitry Andric     size_t cieOffset = rec->cie->outputOff;
6240b57cec5SDimitry Andric     writeCieFde(buf + cieOffset, rec->cie->data());
6250b57cec5SDimitry Andric 
6260b57cec5SDimitry Andric     for (EhSectionPiece *fde : rec->fdes) {
6270b57cec5SDimitry Andric       size_t off = fde->outputOff;
6280b57cec5SDimitry Andric       writeCieFde(buf + off, fde->data());
6290b57cec5SDimitry Andric 
6300b57cec5SDimitry Andric       // FDE's second word should have the offset to an associated CIE.
6310b57cec5SDimitry Andric       // Write it.
6320b57cec5SDimitry Andric       write32(buf + off + 4, off + 4 - cieOffset);
6330b57cec5SDimitry Andric     }
6340b57cec5SDimitry Andric   }
6350b57cec5SDimitry Andric 
6360b57cec5SDimitry Andric   // Apply relocations. .eh_frame section contents are not contiguous
6370b57cec5SDimitry Andric   // in the output buffer, but relocateAlloc() still works because
6380b57cec5SDimitry Andric   // getOffset() takes care of discontiguous section pieces.
6390b57cec5SDimitry Andric   for (EhInputSection *s : sections)
6400b57cec5SDimitry Andric     s->relocateAlloc(buf, nullptr);
6410b57cec5SDimitry Andric 
6420b57cec5SDimitry Andric   if (getPartition().ehFrameHdr && getPartition().ehFrameHdr->getParent())
6430b57cec5SDimitry Andric     getPartition().ehFrameHdr->write();
6440b57cec5SDimitry Andric }
6450b57cec5SDimitry Andric 
6460b57cec5SDimitry Andric GotSection::GotSection()
6470b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
6480b57cec5SDimitry Andric                        ".got") {
6490b57cec5SDimitry Andric   // If ElfSym::globalOffsetTable is relative to .got and is referenced,
6500b57cec5SDimitry Andric   // increase numEntries by the number of entries used to emit
6510b57cec5SDimitry Andric   // ElfSym::globalOffsetTable.
6520b57cec5SDimitry Andric   if (ElfSym::globalOffsetTable && !target->gotBaseSymInGotPlt)
6530b57cec5SDimitry Andric     numEntries += target->gotHeaderEntriesNum;
6540b57cec5SDimitry Andric }
6550b57cec5SDimitry Andric 
6560b57cec5SDimitry Andric void GotSection::addEntry(Symbol &sym) {
6570b57cec5SDimitry Andric   sym.gotIndex = numEntries;
6580b57cec5SDimitry Andric   ++numEntries;
6590b57cec5SDimitry Andric }
6600b57cec5SDimitry Andric 
6610b57cec5SDimitry Andric bool GotSection::addDynTlsEntry(Symbol &sym) {
6620b57cec5SDimitry Andric   if (sym.globalDynIndex != -1U)
6630b57cec5SDimitry Andric     return false;
6640b57cec5SDimitry Andric   sym.globalDynIndex = numEntries;
6650b57cec5SDimitry Andric   // Global Dynamic TLS entries take two GOT slots.
6660b57cec5SDimitry Andric   numEntries += 2;
6670b57cec5SDimitry Andric   return true;
6680b57cec5SDimitry Andric }
6690b57cec5SDimitry Andric 
6700b57cec5SDimitry Andric // Reserves TLS entries for a TLS module ID and a TLS block offset.
6710b57cec5SDimitry Andric // In total it takes two GOT slots.
6720b57cec5SDimitry Andric bool GotSection::addTlsIndex() {
6730b57cec5SDimitry Andric   if (tlsIndexOff != uint32_t(-1))
6740b57cec5SDimitry Andric     return false;
6750b57cec5SDimitry Andric   tlsIndexOff = numEntries * config->wordsize;
6760b57cec5SDimitry Andric   numEntries += 2;
6770b57cec5SDimitry Andric   return true;
6780b57cec5SDimitry Andric }
6790b57cec5SDimitry Andric 
6800b57cec5SDimitry Andric uint64_t GotSection::getGlobalDynAddr(const Symbol &b) const {
6810b57cec5SDimitry Andric   return this->getVA() + b.globalDynIndex * config->wordsize;
6820b57cec5SDimitry Andric }
6830b57cec5SDimitry Andric 
6840b57cec5SDimitry Andric uint64_t GotSection::getGlobalDynOffset(const Symbol &b) const {
6850b57cec5SDimitry Andric   return b.globalDynIndex * config->wordsize;
6860b57cec5SDimitry Andric }
6870b57cec5SDimitry Andric 
6880b57cec5SDimitry Andric void GotSection::finalizeContents() {
6890b57cec5SDimitry Andric   size = numEntries * config->wordsize;
6900b57cec5SDimitry Andric }
6910b57cec5SDimitry Andric 
6920b57cec5SDimitry Andric bool GotSection::isNeeded() const {
6930b57cec5SDimitry Andric   // We need to emit a GOT even if it's empty if there's a relocation that is
6940b57cec5SDimitry Andric   // relative to GOT(such as GOTOFFREL).
6950b57cec5SDimitry Andric   return numEntries || hasGotOffRel;
6960b57cec5SDimitry Andric }
6970b57cec5SDimitry Andric 
6980b57cec5SDimitry Andric void GotSection::writeTo(uint8_t *buf) {
6990b57cec5SDimitry Andric   target->writeGotHeader(buf);
700e8d8bef9SDimitry Andric   relocateAlloc(buf, buf + size);
7010b57cec5SDimitry Andric }
7020b57cec5SDimitry Andric 
7030b57cec5SDimitry Andric static uint64_t getMipsPageAddr(uint64_t addr) {
7040b57cec5SDimitry Andric   return (addr + 0x8000) & ~0xffff;
7050b57cec5SDimitry Andric }
7060b57cec5SDimitry Andric 
7070b57cec5SDimitry Andric static uint64_t getMipsPageCount(uint64_t size) {
7080b57cec5SDimitry Andric   return (size + 0xfffe) / 0xffff + 1;
7090b57cec5SDimitry Andric }
7100b57cec5SDimitry Andric 
7110b57cec5SDimitry Andric MipsGotSection::MipsGotSection()
7120b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE | SHF_MIPS_GPREL, SHT_PROGBITS, 16,
7130b57cec5SDimitry Andric                        ".got") {}
7140b57cec5SDimitry Andric 
7150b57cec5SDimitry Andric void MipsGotSection::addEntry(InputFile &file, Symbol &sym, int64_t addend,
7160b57cec5SDimitry Andric                               RelExpr expr) {
7170b57cec5SDimitry Andric   FileGot &g = getGot(file);
7180b57cec5SDimitry Andric   if (expr == R_MIPS_GOT_LOCAL_PAGE) {
7190b57cec5SDimitry Andric     if (const OutputSection *os = sym.getOutputSection())
7200b57cec5SDimitry Andric       g.pagesMap.insert({os, {}});
7210b57cec5SDimitry Andric     else
7220b57cec5SDimitry Andric       g.local16.insert({{nullptr, getMipsPageAddr(sym.getVA(addend))}, 0});
7230b57cec5SDimitry Andric   } else if (sym.isTls())
7240b57cec5SDimitry Andric     g.tls.insert({&sym, 0});
7250b57cec5SDimitry Andric   else if (sym.isPreemptible && expr == R_ABS)
7260b57cec5SDimitry Andric     g.relocs.insert({&sym, 0});
7270b57cec5SDimitry Andric   else if (sym.isPreemptible)
7280b57cec5SDimitry Andric     g.global.insert({&sym, 0});
7290b57cec5SDimitry Andric   else if (expr == R_MIPS_GOT_OFF32)
7300b57cec5SDimitry Andric     g.local32.insert({{&sym, addend}, 0});
7310b57cec5SDimitry Andric   else
7320b57cec5SDimitry Andric     g.local16.insert({{&sym, addend}, 0});
7330b57cec5SDimitry Andric }
7340b57cec5SDimitry Andric 
7350b57cec5SDimitry Andric void MipsGotSection::addDynTlsEntry(InputFile &file, Symbol &sym) {
7360b57cec5SDimitry Andric   getGot(file).dynTlsSymbols.insert({&sym, 0});
7370b57cec5SDimitry Andric }
7380b57cec5SDimitry Andric 
7390b57cec5SDimitry Andric void MipsGotSection::addTlsIndex(InputFile &file) {
7400b57cec5SDimitry Andric   getGot(file).dynTlsSymbols.insert({nullptr, 0});
7410b57cec5SDimitry Andric }
7420b57cec5SDimitry Andric 
7430b57cec5SDimitry Andric size_t MipsGotSection::FileGot::getEntriesNum() const {
7440b57cec5SDimitry Andric   return getPageEntriesNum() + local16.size() + global.size() + relocs.size() +
7450b57cec5SDimitry Andric          tls.size() + dynTlsSymbols.size() * 2;
7460b57cec5SDimitry Andric }
7470b57cec5SDimitry Andric 
7480b57cec5SDimitry Andric size_t MipsGotSection::FileGot::getPageEntriesNum() const {
7490b57cec5SDimitry Andric   size_t num = 0;
7500b57cec5SDimitry Andric   for (const std::pair<const OutputSection *, FileGot::PageBlock> &p : pagesMap)
7510b57cec5SDimitry Andric     num += p.second.count;
7520b57cec5SDimitry Andric   return num;
7530b57cec5SDimitry Andric }
7540b57cec5SDimitry Andric 
7550b57cec5SDimitry Andric size_t MipsGotSection::FileGot::getIndexedEntriesNum() const {
7560b57cec5SDimitry Andric   size_t count = getPageEntriesNum() + local16.size() + global.size();
7570b57cec5SDimitry Andric   // If there are relocation-only entries in the GOT, TLS entries
7580b57cec5SDimitry Andric   // are allocated after them. TLS entries should be addressable
7590b57cec5SDimitry Andric   // by 16-bit index so count both reloc-only and TLS entries.
7600b57cec5SDimitry Andric   if (!tls.empty() || !dynTlsSymbols.empty())
7610b57cec5SDimitry Andric     count += relocs.size() + tls.size() + dynTlsSymbols.size() * 2;
7620b57cec5SDimitry Andric   return count;
7630b57cec5SDimitry Andric }
7640b57cec5SDimitry Andric 
7650b57cec5SDimitry Andric MipsGotSection::FileGot &MipsGotSection::getGot(InputFile &f) {
7660b57cec5SDimitry Andric   if (!f.mipsGotIndex.hasValue()) {
7670b57cec5SDimitry Andric     gots.emplace_back();
7680b57cec5SDimitry Andric     gots.back().file = &f;
7690b57cec5SDimitry Andric     f.mipsGotIndex = gots.size() - 1;
7700b57cec5SDimitry Andric   }
7710b57cec5SDimitry Andric   return gots[*f.mipsGotIndex];
7720b57cec5SDimitry Andric }
7730b57cec5SDimitry Andric 
7740b57cec5SDimitry Andric uint64_t MipsGotSection::getPageEntryOffset(const InputFile *f,
7750b57cec5SDimitry Andric                                             const Symbol &sym,
7760b57cec5SDimitry Andric                                             int64_t addend) const {
7770b57cec5SDimitry Andric   const FileGot &g = gots[*f->mipsGotIndex];
7780b57cec5SDimitry Andric   uint64_t index = 0;
7790b57cec5SDimitry Andric   if (const OutputSection *outSec = sym.getOutputSection()) {
7800b57cec5SDimitry Andric     uint64_t secAddr = getMipsPageAddr(outSec->addr);
7810b57cec5SDimitry Andric     uint64_t symAddr = getMipsPageAddr(sym.getVA(addend));
7820b57cec5SDimitry Andric     index = g.pagesMap.lookup(outSec).firstIndex + (symAddr - secAddr) / 0xffff;
7830b57cec5SDimitry Andric   } else {
7840b57cec5SDimitry Andric     index = g.local16.lookup({nullptr, getMipsPageAddr(sym.getVA(addend))});
7850b57cec5SDimitry Andric   }
7860b57cec5SDimitry Andric   return index * config->wordsize;
7870b57cec5SDimitry Andric }
7880b57cec5SDimitry Andric 
7890b57cec5SDimitry Andric uint64_t MipsGotSection::getSymEntryOffset(const InputFile *f, const Symbol &s,
7900b57cec5SDimitry Andric                                            int64_t addend) const {
7910b57cec5SDimitry Andric   const FileGot &g = gots[*f->mipsGotIndex];
7920b57cec5SDimitry Andric   Symbol *sym = const_cast<Symbol *>(&s);
7930b57cec5SDimitry Andric   if (sym->isTls())
7940b57cec5SDimitry Andric     return g.tls.lookup(sym) * config->wordsize;
7950b57cec5SDimitry Andric   if (sym->isPreemptible)
7960b57cec5SDimitry Andric     return g.global.lookup(sym) * config->wordsize;
7970b57cec5SDimitry Andric   return g.local16.lookup({sym, addend}) * config->wordsize;
7980b57cec5SDimitry Andric }
7990b57cec5SDimitry Andric 
8000b57cec5SDimitry Andric uint64_t MipsGotSection::getTlsIndexOffset(const InputFile *f) const {
8010b57cec5SDimitry Andric   const FileGot &g = gots[*f->mipsGotIndex];
8020b57cec5SDimitry Andric   return g.dynTlsSymbols.lookup(nullptr) * config->wordsize;
8030b57cec5SDimitry Andric }
8040b57cec5SDimitry Andric 
8050b57cec5SDimitry Andric uint64_t MipsGotSection::getGlobalDynOffset(const InputFile *f,
8060b57cec5SDimitry Andric                                             const Symbol &s) const {
8070b57cec5SDimitry Andric   const FileGot &g = gots[*f->mipsGotIndex];
8080b57cec5SDimitry Andric   Symbol *sym = const_cast<Symbol *>(&s);
8090b57cec5SDimitry Andric   return g.dynTlsSymbols.lookup(sym) * config->wordsize;
8100b57cec5SDimitry Andric }
8110b57cec5SDimitry Andric 
8120b57cec5SDimitry Andric const Symbol *MipsGotSection::getFirstGlobalEntry() const {
8130b57cec5SDimitry Andric   if (gots.empty())
8140b57cec5SDimitry Andric     return nullptr;
8150b57cec5SDimitry Andric   const FileGot &primGot = gots.front();
8160b57cec5SDimitry Andric   if (!primGot.global.empty())
8170b57cec5SDimitry Andric     return primGot.global.front().first;
8180b57cec5SDimitry Andric   if (!primGot.relocs.empty())
8190b57cec5SDimitry Andric     return primGot.relocs.front().first;
8200b57cec5SDimitry Andric   return nullptr;
8210b57cec5SDimitry Andric }
8220b57cec5SDimitry Andric 
8230b57cec5SDimitry Andric unsigned MipsGotSection::getLocalEntriesNum() const {
8240b57cec5SDimitry Andric   if (gots.empty())
8250b57cec5SDimitry Andric     return headerEntriesNum;
8260b57cec5SDimitry Andric   return headerEntriesNum + gots.front().getPageEntriesNum() +
8270b57cec5SDimitry Andric          gots.front().local16.size();
8280b57cec5SDimitry Andric }
8290b57cec5SDimitry Andric 
8300b57cec5SDimitry Andric bool MipsGotSection::tryMergeGots(FileGot &dst, FileGot &src, bool isPrimary) {
8310b57cec5SDimitry Andric   FileGot tmp = dst;
8320b57cec5SDimitry Andric   set_union(tmp.pagesMap, src.pagesMap);
8330b57cec5SDimitry Andric   set_union(tmp.local16, src.local16);
8340b57cec5SDimitry Andric   set_union(tmp.global, src.global);
8350b57cec5SDimitry Andric   set_union(tmp.relocs, src.relocs);
8360b57cec5SDimitry Andric   set_union(tmp.tls, src.tls);
8370b57cec5SDimitry Andric   set_union(tmp.dynTlsSymbols, src.dynTlsSymbols);
8380b57cec5SDimitry Andric 
8390b57cec5SDimitry Andric   size_t count = isPrimary ? headerEntriesNum : 0;
8400b57cec5SDimitry Andric   count += tmp.getIndexedEntriesNum();
8410b57cec5SDimitry Andric 
8420b57cec5SDimitry Andric   if (count * config->wordsize > config->mipsGotSize)
8430b57cec5SDimitry Andric     return false;
8440b57cec5SDimitry Andric 
8450b57cec5SDimitry Andric   std::swap(tmp, dst);
8460b57cec5SDimitry Andric   return true;
8470b57cec5SDimitry Andric }
8480b57cec5SDimitry Andric 
8490b57cec5SDimitry Andric void MipsGotSection::finalizeContents() { updateAllocSize(); }
8500b57cec5SDimitry Andric 
8510b57cec5SDimitry Andric bool MipsGotSection::updateAllocSize() {
8520b57cec5SDimitry Andric   size = headerEntriesNum * config->wordsize;
8530b57cec5SDimitry Andric   for (const FileGot &g : gots)
8540b57cec5SDimitry Andric     size += g.getEntriesNum() * config->wordsize;
8550b57cec5SDimitry Andric   return false;
8560b57cec5SDimitry Andric }
8570b57cec5SDimitry Andric 
8580b57cec5SDimitry Andric void MipsGotSection::build() {
8590b57cec5SDimitry Andric   if (gots.empty())
8600b57cec5SDimitry Andric     return;
8610b57cec5SDimitry Andric 
8620b57cec5SDimitry Andric   std::vector<FileGot> mergedGots(1);
8630b57cec5SDimitry Andric 
8640b57cec5SDimitry Andric   // For each GOT move non-preemptible symbols from the `Global`
8650b57cec5SDimitry Andric   // to `Local16` list. Preemptible symbol might become non-preemptible
8660b57cec5SDimitry Andric   // one if, for example, it gets a related copy relocation.
8670b57cec5SDimitry Andric   for (FileGot &got : gots) {
8680b57cec5SDimitry Andric     for (auto &p: got.global)
8690b57cec5SDimitry Andric       if (!p.first->isPreemptible)
8700b57cec5SDimitry Andric         got.local16.insert({{p.first, 0}, 0});
8710b57cec5SDimitry Andric     got.global.remove_if([&](const std::pair<Symbol *, size_t> &p) {
8720b57cec5SDimitry Andric       return !p.first->isPreemptible;
8730b57cec5SDimitry Andric     });
8740b57cec5SDimitry Andric   }
8750b57cec5SDimitry Andric 
8760b57cec5SDimitry Andric   // For each GOT remove "reloc-only" entry if there is "global"
8770b57cec5SDimitry Andric   // entry for the same symbol. And add local entries which indexed
8780b57cec5SDimitry Andric   // using 32-bit value at the end of 16-bit entries.
8790b57cec5SDimitry Andric   for (FileGot &got : gots) {
8800b57cec5SDimitry Andric     got.relocs.remove_if([&](const std::pair<Symbol *, size_t> &p) {
8810b57cec5SDimitry Andric       return got.global.count(p.first);
8820b57cec5SDimitry Andric     });
8830b57cec5SDimitry Andric     set_union(got.local16, got.local32);
8840b57cec5SDimitry Andric     got.local32.clear();
8850b57cec5SDimitry Andric   }
8860b57cec5SDimitry Andric 
8870b57cec5SDimitry Andric   // Evaluate number of "reloc-only" entries in the resulting GOT.
8880b57cec5SDimitry Andric   // To do that put all unique "reloc-only" and "global" entries
8890b57cec5SDimitry Andric   // from all GOTs to the future primary GOT.
8900b57cec5SDimitry Andric   FileGot *primGot = &mergedGots.front();
8910b57cec5SDimitry Andric   for (FileGot &got : gots) {
8920b57cec5SDimitry Andric     set_union(primGot->relocs, got.global);
8930b57cec5SDimitry Andric     set_union(primGot->relocs, got.relocs);
8940b57cec5SDimitry Andric     got.relocs.clear();
8950b57cec5SDimitry Andric   }
8960b57cec5SDimitry Andric 
8970b57cec5SDimitry Andric   // Evaluate number of "page" entries in each GOT.
8980b57cec5SDimitry Andric   for (FileGot &got : gots) {
8990b57cec5SDimitry Andric     for (std::pair<const OutputSection *, FileGot::PageBlock> &p :
9000b57cec5SDimitry Andric          got.pagesMap) {
9010b57cec5SDimitry Andric       const OutputSection *os = p.first;
9020b57cec5SDimitry Andric       uint64_t secSize = 0;
9030b57cec5SDimitry Andric       for (BaseCommand *cmd : os->sectionCommands) {
9040b57cec5SDimitry Andric         if (auto *isd = dyn_cast<InputSectionDescription>(cmd))
9050b57cec5SDimitry Andric           for (InputSection *isec : isd->sections) {
9060b57cec5SDimitry Andric             uint64_t off = alignTo(secSize, isec->alignment);
9070b57cec5SDimitry Andric             secSize = off + isec->getSize();
9080b57cec5SDimitry Andric           }
9090b57cec5SDimitry Andric       }
9100b57cec5SDimitry Andric       p.second.count = getMipsPageCount(secSize);
9110b57cec5SDimitry Andric     }
9120b57cec5SDimitry Andric   }
9130b57cec5SDimitry Andric 
9140b57cec5SDimitry Andric   // Merge GOTs. Try to join as much as possible GOTs but do not exceed
9150b57cec5SDimitry Andric   // maximum GOT size. At first, try to fill the primary GOT because
9160b57cec5SDimitry Andric   // the primary GOT can be accessed in the most effective way. If it
9170b57cec5SDimitry Andric   // is not possible, try to fill the last GOT in the list, and finally
9180b57cec5SDimitry Andric   // create a new GOT if both attempts failed.
9190b57cec5SDimitry Andric   for (FileGot &srcGot : gots) {
9200b57cec5SDimitry Andric     InputFile *file = srcGot.file;
9210b57cec5SDimitry Andric     if (tryMergeGots(mergedGots.front(), srcGot, true)) {
9220b57cec5SDimitry Andric       file->mipsGotIndex = 0;
9230b57cec5SDimitry Andric     } else {
9240b57cec5SDimitry Andric       // If this is the first time we failed to merge with the primary GOT,
9250b57cec5SDimitry Andric       // MergedGots.back() will also be the primary GOT. We must make sure not
9260b57cec5SDimitry Andric       // to try to merge again with isPrimary=false, as otherwise, if the
9270b57cec5SDimitry Andric       // inputs are just right, we could allow the primary GOT to become 1 or 2
9280b57cec5SDimitry Andric       // words bigger due to ignoring the header size.
9290b57cec5SDimitry Andric       if (mergedGots.size() == 1 ||
9300b57cec5SDimitry Andric           !tryMergeGots(mergedGots.back(), srcGot, false)) {
9310b57cec5SDimitry Andric         mergedGots.emplace_back();
9320b57cec5SDimitry Andric         std::swap(mergedGots.back(), srcGot);
9330b57cec5SDimitry Andric       }
9340b57cec5SDimitry Andric       file->mipsGotIndex = mergedGots.size() - 1;
9350b57cec5SDimitry Andric     }
9360b57cec5SDimitry Andric   }
9370b57cec5SDimitry Andric   std::swap(gots, mergedGots);
9380b57cec5SDimitry Andric 
9390b57cec5SDimitry Andric   // Reduce number of "reloc-only" entries in the primary GOT
940480093f4SDimitry Andric   // by subtracting "global" entries in the primary GOT.
9410b57cec5SDimitry Andric   primGot = &gots.front();
9420b57cec5SDimitry Andric   primGot->relocs.remove_if([&](const std::pair<Symbol *, size_t> &p) {
9430b57cec5SDimitry Andric     return primGot->global.count(p.first);
9440b57cec5SDimitry Andric   });
9450b57cec5SDimitry Andric 
9460b57cec5SDimitry Andric   // Calculate indexes for each GOT entry.
9470b57cec5SDimitry Andric   size_t index = headerEntriesNum;
9480b57cec5SDimitry Andric   for (FileGot &got : gots) {
9490b57cec5SDimitry Andric     got.startIndex = &got == primGot ? 0 : index;
9500b57cec5SDimitry Andric     for (std::pair<const OutputSection *, FileGot::PageBlock> &p :
9510b57cec5SDimitry Andric          got.pagesMap) {
9520b57cec5SDimitry Andric       // For each output section referenced by GOT page relocations calculate
9530b57cec5SDimitry Andric       // and save into pagesMap an upper bound of MIPS GOT entries required
9540b57cec5SDimitry Andric       // to store page addresses of local symbols. We assume the worst case -
9550b57cec5SDimitry Andric       // each 64kb page of the output section has at least one GOT relocation
9560b57cec5SDimitry Andric       // against it. And take in account the case when the section intersects
9570b57cec5SDimitry Andric       // page boundaries.
9580b57cec5SDimitry Andric       p.second.firstIndex = index;
9590b57cec5SDimitry Andric       index += p.second.count;
9600b57cec5SDimitry Andric     }
9610b57cec5SDimitry Andric     for (auto &p: got.local16)
9620b57cec5SDimitry Andric       p.second = index++;
9630b57cec5SDimitry Andric     for (auto &p: got.global)
9640b57cec5SDimitry Andric       p.second = index++;
9650b57cec5SDimitry Andric     for (auto &p: got.relocs)
9660b57cec5SDimitry Andric       p.second = index++;
9670b57cec5SDimitry Andric     for (auto &p: got.tls)
9680b57cec5SDimitry Andric       p.second = index++;
9690b57cec5SDimitry Andric     for (auto &p: got.dynTlsSymbols) {
9700b57cec5SDimitry Andric       p.second = index;
9710b57cec5SDimitry Andric       index += 2;
9720b57cec5SDimitry Andric     }
9730b57cec5SDimitry Andric   }
9740b57cec5SDimitry Andric 
9750b57cec5SDimitry Andric   // Update Symbol::gotIndex field to use this
9760b57cec5SDimitry Andric   // value later in the `sortMipsSymbols` function.
9770b57cec5SDimitry Andric   for (auto &p : primGot->global)
9780b57cec5SDimitry Andric     p.first->gotIndex = p.second;
9790b57cec5SDimitry Andric   for (auto &p : primGot->relocs)
9800b57cec5SDimitry Andric     p.first->gotIndex = p.second;
9810b57cec5SDimitry Andric 
9820b57cec5SDimitry Andric   // Create dynamic relocations.
9830b57cec5SDimitry Andric   for (FileGot &got : gots) {
9840b57cec5SDimitry Andric     // Create dynamic relocations for TLS entries.
9850b57cec5SDimitry Andric     for (std::pair<Symbol *, size_t> &p : got.tls) {
9860b57cec5SDimitry Andric       Symbol *s = p.first;
9870b57cec5SDimitry Andric       uint64_t offset = p.second * config->wordsize;
9880b57cec5SDimitry Andric       if (s->isPreemptible)
9890b57cec5SDimitry Andric         mainPart->relaDyn->addReloc(target->tlsGotRel, this, offset, s);
9900b57cec5SDimitry Andric     }
9910b57cec5SDimitry Andric     for (std::pair<Symbol *, size_t> &p : got.dynTlsSymbols) {
9920b57cec5SDimitry Andric       Symbol *s = p.first;
9930b57cec5SDimitry Andric       uint64_t offset = p.second * config->wordsize;
9940b57cec5SDimitry Andric       if (s == nullptr) {
9950b57cec5SDimitry Andric         if (!config->isPic)
9960b57cec5SDimitry Andric           continue;
9970b57cec5SDimitry Andric         mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, this, offset, s);
9980b57cec5SDimitry Andric       } else {
9990b57cec5SDimitry Andric         // When building a shared library we still need a dynamic relocation
10000b57cec5SDimitry Andric         // for the module index. Therefore only checking for
10010b57cec5SDimitry Andric         // S->isPreemptible is not sufficient (this happens e.g. for
10020b57cec5SDimitry Andric         // thread-locals that have been marked as local through a linker script)
10030b57cec5SDimitry Andric         if (!s->isPreemptible && !config->isPic)
10040b57cec5SDimitry Andric           continue;
10050b57cec5SDimitry Andric         mainPart->relaDyn->addReloc(target->tlsModuleIndexRel, this, offset, s);
10060b57cec5SDimitry Andric         // However, we can skip writing the TLS offset reloc for non-preemptible
10070b57cec5SDimitry Andric         // symbols since it is known even in shared libraries
10080b57cec5SDimitry Andric         if (!s->isPreemptible)
10090b57cec5SDimitry Andric           continue;
10100b57cec5SDimitry Andric         offset += config->wordsize;
10110b57cec5SDimitry Andric         mainPart->relaDyn->addReloc(target->tlsOffsetRel, this, offset, s);
10120b57cec5SDimitry Andric       }
10130b57cec5SDimitry Andric     }
10140b57cec5SDimitry Andric 
10150b57cec5SDimitry Andric     // Do not create dynamic relocations for non-TLS
10160b57cec5SDimitry Andric     // entries in the primary GOT.
10170b57cec5SDimitry Andric     if (&got == primGot)
10180b57cec5SDimitry Andric       continue;
10190b57cec5SDimitry Andric 
10200b57cec5SDimitry Andric     // Dynamic relocations for "global" entries.
10210b57cec5SDimitry Andric     for (const std::pair<Symbol *, size_t> &p : got.global) {
10220b57cec5SDimitry Andric       uint64_t offset = p.second * config->wordsize;
10230b57cec5SDimitry Andric       mainPart->relaDyn->addReloc(target->relativeRel, this, offset, p.first);
10240b57cec5SDimitry Andric     }
10250b57cec5SDimitry Andric     if (!config->isPic)
10260b57cec5SDimitry Andric       continue;
10270b57cec5SDimitry Andric     // Dynamic relocations for "local" entries in case of PIC.
10280b57cec5SDimitry Andric     for (const std::pair<const OutputSection *, FileGot::PageBlock> &l :
10290b57cec5SDimitry Andric          got.pagesMap) {
10300b57cec5SDimitry Andric       size_t pageCount = l.second.count;
10310b57cec5SDimitry Andric       for (size_t pi = 0; pi < pageCount; ++pi) {
10320b57cec5SDimitry Andric         uint64_t offset = (l.second.firstIndex + pi) * config->wordsize;
10330b57cec5SDimitry Andric         mainPart->relaDyn->addReloc({target->relativeRel, this, offset, l.first,
10340b57cec5SDimitry Andric                                  int64_t(pi * 0x10000)});
10350b57cec5SDimitry Andric       }
10360b57cec5SDimitry Andric     }
10370b57cec5SDimitry Andric     for (const std::pair<GotEntry, size_t> &p : got.local16) {
10380b57cec5SDimitry Andric       uint64_t offset = p.second * config->wordsize;
10390b57cec5SDimitry Andric       mainPart->relaDyn->addReloc({target->relativeRel, this, offset, true,
10400b57cec5SDimitry Andric                                p.first.first, p.first.second});
10410b57cec5SDimitry Andric     }
10420b57cec5SDimitry Andric   }
10430b57cec5SDimitry Andric }
10440b57cec5SDimitry Andric 
10450b57cec5SDimitry Andric bool MipsGotSection::isNeeded() const {
10460b57cec5SDimitry Andric   // We add the .got section to the result for dynamic MIPS target because
10470b57cec5SDimitry Andric   // its address and properties are mentioned in the .dynamic section.
10480b57cec5SDimitry Andric   return !config->relocatable;
10490b57cec5SDimitry Andric }
10500b57cec5SDimitry Andric 
10510b57cec5SDimitry Andric uint64_t MipsGotSection::getGp(const InputFile *f) const {
10520b57cec5SDimitry Andric   // For files without related GOT or files refer a primary GOT
10530b57cec5SDimitry Andric   // returns "common" _gp value. For secondary GOTs calculate
10540b57cec5SDimitry Andric   // individual _gp values.
10550b57cec5SDimitry Andric   if (!f || !f->mipsGotIndex.hasValue() || *f->mipsGotIndex == 0)
10560b57cec5SDimitry Andric     return ElfSym::mipsGp->getVA(0);
10570b57cec5SDimitry Andric   return getVA() + gots[*f->mipsGotIndex].startIndex * config->wordsize +
10580b57cec5SDimitry Andric          0x7ff0;
10590b57cec5SDimitry Andric }
10600b57cec5SDimitry Andric 
10610b57cec5SDimitry Andric void MipsGotSection::writeTo(uint8_t *buf) {
10620b57cec5SDimitry Andric   // Set the MSB of the second GOT slot. This is not required by any
10630b57cec5SDimitry Andric   // MIPS ABI documentation, though.
10640b57cec5SDimitry Andric   //
10650b57cec5SDimitry Andric   // There is a comment in glibc saying that "The MSB of got[1] of a
10660b57cec5SDimitry Andric   // gnu object is set to identify gnu objects," and in GNU gold it
10670b57cec5SDimitry Andric   // says "the second entry will be used by some runtime loaders".
10680b57cec5SDimitry Andric   // But how this field is being used is unclear.
10690b57cec5SDimitry Andric   //
10700b57cec5SDimitry Andric   // We are not really willing to mimic other linkers behaviors
10710b57cec5SDimitry Andric   // without understanding why they do that, but because all files
10720b57cec5SDimitry Andric   // generated by GNU tools have this special GOT value, and because
10730b57cec5SDimitry Andric   // we've been doing this for years, it is probably a safe bet to
10740b57cec5SDimitry Andric   // keep doing this for now. We really need to revisit this to see
10750b57cec5SDimitry Andric   // if we had to do this.
10760b57cec5SDimitry Andric   writeUint(buf + config->wordsize, (uint64_t)1 << (config->wordsize * 8 - 1));
10770b57cec5SDimitry Andric   for (const FileGot &g : gots) {
10780b57cec5SDimitry Andric     auto write = [&](size_t i, const Symbol *s, int64_t a) {
10790b57cec5SDimitry Andric       uint64_t va = a;
10800b57cec5SDimitry Andric       if (s)
10810b57cec5SDimitry Andric         va = s->getVA(a);
10820b57cec5SDimitry Andric       writeUint(buf + i * config->wordsize, va);
10830b57cec5SDimitry Andric     };
10840b57cec5SDimitry Andric     // Write 'page address' entries to the local part of the GOT.
10850b57cec5SDimitry Andric     for (const std::pair<const OutputSection *, FileGot::PageBlock> &l :
10860b57cec5SDimitry Andric          g.pagesMap) {
10870b57cec5SDimitry Andric       size_t pageCount = l.second.count;
10880b57cec5SDimitry Andric       uint64_t firstPageAddr = getMipsPageAddr(l.first->addr);
10890b57cec5SDimitry Andric       for (size_t pi = 0; pi < pageCount; ++pi)
10900b57cec5SDimitry Andric         write(l.second.firstIndex + pi, nullptr, firstPageAddr + pi * 0x10000);
10910b57cec5SDimitry Andric     }
10920b57cec5SDimitry Andric     // Local, global, TLS, reloc-only  entries.
10930b57cec5SDimitry Andric     // If TLS entry has a corresponding dynamic relocations, leave it
10940b57cec5SDimitry Andric     // initialized by zero. Write down adjusted TLS symbol's values otherwise.
10950b57cec5SDimitry Andric     // To calculate the adjustments use offsets for thread-local storage.
10960b57cec5SDimitry Andric     // https://www.linux-mips.org/wiki/NPTL
10970b57cec5SDimitry Andric     for (const std::pair<GotEntry, size_t> &p : g.local16)
10980b57cec5SDimitry Andric       write(p.second, p.first.first, p.first.second);
10990b57cec5SDimitry Andric     // Write VA to the primary GOT only. For secondary GOTs that
11000b57cec5SDimitry Andric     // will be done by REL32 dynamic relocations.
11010b57cec5SDimitry Andric     if (&g == &gots.front())
1102480093f4SDimitry Andric       for (const std::pair<Symbol *, size_t> &p : g.global)
11030b57cec5SDimitry Andric         write(p.second, p.first, 0);
11040b57cec5SDimitry Andric     for (const std::pair<Symbol *, size_t> &p : g.relocs)
11050b57cec5SDimitry Andric       write(p.second, p.first, 0);
11060b57cec5SDimitry Andric     for (const std::pair<Symbol *, size_t> &p : g.tls)
11070b57cec5SDimitry Andric       write(p.second, p.first, p.first->isPreemptible ? 0 : -0x7000);
11080b57cec5SDimitry Andric     for (const std::pair<Symbol *, size_t> &p : g.dynTlsSymbols) {
11090b57cec5SDimitry Andric       if (p.first == nullptr && !config->isPic)
11100b57cec5SDimitry Andric         write(p.second, nullptr, 1);
11110b57cec5SDimitry Andric       else if (p.first && !p.first->isPreemptible) {
11120b57cec5SDimitry Andric         // If we are emitting PIC code with relocations we mustn't write
11130b57cec5SDimitry Andric         // anything to the GOT here. When using Elf_Rel relocations the value
11140b57cec5SDimitry Andric         // one will be treated as an addend and will cause crashes at runtime
11150b57cec5SDimitry Andric         if (!config->isPic)
11160b57cec5SDimitry Andric           write(p.second, nullptr, 1);
11170b57cec5SDimitry Andric         write(p.second + 1, p.first, -0x8000);
11180b57cec5SDimitry Andric       }
11190b57cec5SDimitry Andric     }
11200b57cec5SDimitry Andric   }
11210b57cec5SDimitry Andric }
11220b57cec5SDimitry Andric 
11230b57cec5SDimitry Andric // On PowerPC the .plt section is used to hold the table of function addresses
11240b57cec5SDimitry Andric // instead of the .got.plt, and the type is SHT_NOBITS similar to a .bss
11250b57cec5SDimitry Andric // section. I don't know why we have a BSS style type for the section but it is
1126480093f4SDimitry Andric // consistent across both 64-bit PowerPC ABIs as well as the 32-bit PowerPC ABI.
11270b57cec5SDimitry Andric GotPltSection::GotPltSection()
11280b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
11290b57cec5SDimitry Andric                        ".got.plt") {
11300b57cec5SDimitry Andric   if (config->emachine == EM_PPC) {
11310b57cec5SDimitry Andric     name = ".plt";
11320b57cec5SDimitry Andric   } else if (config->emachine == EM_PPC64) {
11330b57cec5SDimitry Andric     type = SHT_NOBITS;
11340b57cec5SDimitry Andric     name = ".plt";
11350b57cec5SDimitry Andric   }
11360b57cec5SDimitry Andric }
11370b57cec5SDimitry Andric 
11380b57cec5SDimitry Andric void GotPltSection::addEntry(Symbol &sym) {
11390b57cec5SDimitry Andric   assert(sym.pltIndex == entries.size());
11400b57cec5SDimitry Andric   entries.push_back(&sym);
11410b57cec5SDimitry Andric }
11420b57cec5SDimitry Andric 
11430b57cec5SDimitry Andric size_t GotPltSection::getSize() const {
11440b57cec5SDimitry Andric   return (target->gotPltHeaderEntriesNum + entries.size()) * config->wordsize;
11450b57cec5SDimitry Andric }
11460b57cec5SDimitry Andric 
11470b57cec5SDimitry Andric void GotPltSection::writeTo(uint8_t *buf) {
11480b57cec5SDimitry Andric   target->writeGotPltHeader(buf);
11490b57cec5SDimitry Andric   buf += target->gotPltHeaderEntriesNum * config->wordsize;
11500b57cec5SDimitry Andric   for (const Symbol *b : entries) {
11510b57cec5SDimitry Andric     target->writeGotPlt(buf, *b);
11520b57cec5SDimitry Andric     buf += config->wordsize;
11530b57cec5SDimitry Andric   }
11540b57cec5SDimitry Andric }
11550b57cec5SDimitry Andric 
11560b57cec5SDimitry Andric bool GotPltSection::isNeeded() const {
11570b57cec5SDimitry Andric   // We need to emit GOTPLT even if it's empty if there's a relocation relative
11580b57cec5SDimitry Andric   // to it.
11590b57cec5SDimitry Andric   return !entries.empty() || hasGotPltOffRel;
11600b57cec5SDimitry Andric }
11610b57cec5SDimitry Andric 
11620b57cec5SDimitry Andric static StringRef getIgotPltName() {
11630b57cec5SDimitry Andric   // On ARM the IgotPltSection is part of the GotSection.
11640b57cec5SDimitry Andric   if (config->emachine == EM_ARM)
11650b57cec5SDimitry Andric     return ".got";
11660b57cec5SDimitry Andric 
11670b57cec5SDimitry Andric   // On PowerPC64 the GotPltSection is renamed to '.plt' so the IgotPltSection
11680b57cec5SDimitry Andric   // needs to be named the same.
11690b57cec5SDimitry Andric   if (config->emachine == EM_PPC64)
11700b57cec5SDimitry Andric     return ".plt";
11710b57cec5SDimitry Andric 
11720b57cec5SDimitry Andric   return ".got.plt";
11730b57cec5SDimitry Andric }
11740b57cec5SDimitry Andric 
11750b57cec5SDimitry Andric // On PowerPC64 the GotPltSection type is SHT_NOBITS so we have to follow suit
11760b57cec5SDimitry Andric // with the IgotPltSection.
11770b57cec5SDimitry Andric IgotPltSection::IgotPltSection()
11780b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
11790b57cec5SDimitry Andric                        config->emachine == EM_PPC64 ? SHT_NOBITS : SHT_PROGBITS,
11800b57cec5SDimitry Andric                        config->wordsize, getIgotPltName()) {}
11810b57cec5SDimitry Andric 
11820b57cec5SDimitry Andric void IgotPltSection::addEntry(Symbol &sym) {
11830b57cec5SDimitry Andric   assert(sym.pltIndex == entries.size());
11840b57cec5SDimitry Andric   entries.push_back(&sym);
11850b57cec5SDimitry Andric }
11860b57cec5SDimitry Andric 
11870b57cec5SDimitry Andric size_t IgotPltSection::getSize() const {
11880b57cec5SDimitry Andric   return entries.size() * config->wordsize;
11890b57cec5SDimitry Andric }
11900b57cec5SDimitry Andric 
11910b57cec5SDimitry Andric void IgotPltSection::writeTo(uint8_t *buf) {
11920b57cec5SDimitry Andric   for (const Symbol *b : entries) {
11930b57cec5SDimitry Andric     target->writeIgotPlt(buf, *b);
11940b57cec5SDimitry Andric     buf += config->wordsize;
11950b57cec5SDimitry Andric   }
11960b57cec5SDimitry Andric }
11970b57cec5SDimitry Andric 
11980b57cec5SDimitry Andric StringTableSection::StringTableSection(StringRef name, bool dynamic)
11990b57cec5SDimitry Andric     : SyntheticSection(dynamic ? (uint64_t)SHF_ALLOC : 0, SHT_STRTAB, 1, name),
12000b57cec5SDimitry Andric       dynamic(dynamic) {
12010b57cec5SDimitry Andric   // ELF string tables start with a NUL byte.
12020b57cec5SDimitry Andric   addString("");
12030b57cec5SDimitry Andric }
12040b57cec5SDimitry Andric 
12050b57cec5SDimitry Andric // Adds a string to the string table. If `hashIt` is true we hash and check for
12060b57cec5SDimitry Andric // duplicates. It is optional because the name of global symbols are already
12070b57cec5SDimitry Andric // uniqued and hashing them again has a big cost for a small value: uniquing
12080b57cec5SDimitry Andric // them with some other string that happens to be the same.
12090b57cec5SDimitry Andric unsigned StringTableSection::addString(StringRef s, bool hashIt) {
12100b57cec5SDimitry Andric   if (hashIt) {
12110b57cec5SDimitry Andric     auto r = stringMap.insert(std::make_pair(s, this->size));
12120b57cec5SDimitry Andric     if (!r.second)
12130b57cec5SDimitry Andric       return r.first->second;
12140b57cec5SDimitry Andric   }
12150b57cec5SDimitry Andric   unsigned ret = this->size;
12160b57cec5SDimitry Andric   this->size = this->size + s.size() + 1;
12170b57cec5SDimitry Andric   strings.push_back(s);
12180b57cec5SDimitry Andric   return ret;
12190b57cec5SDimitry Andric }
12200b57cec5SDimitry Andric 
12210b57cec5SDimitry Andric void StringTableSection::writeTo(uint8_t *buf) {
12220b57cec5SDimitry Andric   for (StringRef s : strings) {
12230b57cec5SDimitry Andric     memcpy(buf, s.data(), s.size());
12240b57cec5SDimitry Andric     buf[s.size()] = '\0';
12250b57cec5SDimitry Andric     buf += s.size() + 1;
12260b57cec5SDimitry Andric   }
12270b57cec5SDimitry Andric }
12280b57cec5SDimitry Andric 
122985868e8aSDimitry Andric // Returns the number of entries in .gnu.version_d: the number of
123085868e8aSDimitry Andric // non-VER_NDX_LOCAL-non-VER_NDX_GLOBAL definitions, plus 1.
123185868e8aSDimitry Andric // Note that we don't support vd_cnt > 1 yet.
123285868e8aSDimitry Andric static unsigned getVerDefNum() {
123385868e8aSDimitry Andric   return namedVersionDefs().size() + 1;
123485868e8aSDimitry Andric }
12350b57cec5SDimitry Andric 
12360b57cec5SDimitry Andric template <class ELFT>
12370b57cec5SDimitry Andric DynamicSection<ELFT>::DynamicSection()
12380b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_DYNAMIC, config->wordsize,
12390b57cec5SDimitry Andric                        ".dynamic") {
12400b57cec5SDimitry Andric   this->entsize = ELFT::Is64Bits ? 16 : 8;
12410b57cec5SDimitry Andric 
12420b57cec5SDimitry Andric   // .dynamic section is not writable on MIPS and on Fuchsia OS
12430b57cec5SDimitry Andric   // which passes -z rodynamic.
12440b57cec5SDimitry Andric   // See "Special Section" in Chapter 4 in the following document:
12450b57cec5SDimitry Andric   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
12460b57cec5SDimitry Andric   if (config->emachine == EM_MIPS || config->zRodynamic)
12470b57cec5SDimitry Andric     this->flags = SHF_ALLOC;
12480b57cec5SDimitry Andric }
12490b57cec5SDimitry Andric 
12500b57cec5SDimitry Andric template <class ELFT>
12510b57cec5SDimitry Andric void DynamicSection<ELFT>::add(int32_t tag, std::function<uint64_t()> fn) {
12520b57cec5SDimitry Andric   entries.push_back({tag, fn});
12530b57cec5SDimitry Andric }
12540b57cec5SDimitry Andric 
12550b57cec5SDimitry Andric template <class ELFT>
12560b57cec5SDimitry Andric void DynamicSection<ELFT>::addInt(int32_t tag, uint64_t val) {
12570b57cec5SDimitry Andric   entries.push_back({tag, [=] { return val; }});
12580b57cec5SDimitry Andric }
12590b57cec5SDimitry Andric 
12600b57cec5SDimitry Andric template <class ELFT>
12610b57cec5SDimitry Andric void DynamicSection<ELFT>::addInSec(int32_t tag, InputSection *sec) {
12620b57cec5SDimitry Andric   entries.push_back({tag, [=] { return sec->getVA(0); }});
12630b57cec5SDimitry Andric }
12640b57cec5SDimitry Andric 
12650b57cec5SDimitry Andric template <class ELFT>
12660b57cec5SDimitry Andric void DynamicSection<ELFT>::addInSecRelative(int32_t tag, InputSection *sec) {
12670b57cec5SDimitry Andric   size_t tagOffset = entries.size() * entsize;
12680b57cec5SDimitry Andric   entries.push_back(
12690b57cec5SDimitry Andric       {tag, [=] { return sec->getVA(0) - (getVA() + tagOffset); }});
12700b57cec5SDimitry Andric }
12710b57cec5SDimitry Andric 
12720b57cec5SDimitry Andric template <class ELFT>
12730b57cec5SDimitry Andric void DynamicSection<ELFT>::addOutSec(int32_t tag, OutputSection *sec) {
12740b57cec5SDimitry Andric   entries.push_back({tag, [=] { return sec->addr; }});
12750b57cec5SDimitry Andric }
12760b57cec5SDimitry Andric 
12770b57cec5SDimitry Andric template <class ELFT>
12780b57cec5SDimitry Andric void DynamicSection<ELFT>::addSize(int32_t tag, OutputSection *sec) {
12790b57cec5SDimitry Andric   entries.push_back({tag, [=] { return sec->size; }});
12800b57cec5SDimitry Andric }
12810b57cec5SDimitry Andric 
12820b57cec5SDimitry Andric template <class ELFT>
12830b57cec5SDimitry Andric void DynamicSection<ELFT>::addSym(int32_t tag, Symbol *sym) {
12840b57cec5SDimitry Andric   entries.push_back({tag, [=] { return sym->getVA(); }});
12850b57cec5SDimitry Andric }
12860b57cec5SDimitry Andric 
128785868e8aSDimitry Andric // The output section .rela.dyn may include these synthetic sections:
128885868e8aSDimitry Andric //
128985868e8aSDimitry Andric // - part.relaDyn
129085868e8aSDimitry Andric // - in.relaIplt: this is included if in.relaIplt is named .rela.dyn
129185868e8aSDimitry Andric // - in.relaPlt: this is included if a linker script places .rela.plt inside
129285868e8aSDimitry Andric //   .rela.dyn
129385868e8aSDimitry Andric //
129485868e8aSDimitry Andric // DT_RELASZ is the total size of the included sections.
129585868e8aSDimitry Andric static std::function<uint64_t()> addRelaSz(RelocationBaseSection *relaDyn) {
129685868e8aSDimitry Andric   return [=]() {
129785868e8aSDimitry Andric     size_t size = relaDyn->getSize();
129885868e8aSDimitry Andric     if (in.relaIplt->getParent() == relaDyn->getParent())
129985868e8aSDimitry Andric       size += in.relaIplt->getSize();
130085868e8aSDimitry Andric     if (in.relaPlt->getParent() == relaDyn->getParent())
130185868e8aSDimitry Andric       size += in.relaPlt->getSize();
130285868e8aSDimitry Andric     return size;
130385868e8aSDimitry Andric   };
130485868e8aSDimitry Andric }
130585868e8aSDimitry Andric 
13060b57cec5SDimitry Andric // A Linker script may assign the RELA relocation sections to the same
13070b57cec5SDimitry Andric // output section. When this occurs we cannot just use the OutputSection
13080b57cec5SDimitry Andric // Size. Moreover the [DT_JMPREL, DT_JMPREL + DT_PLTRELSZ) is permitted to
13090b57cec5SDimitry Andric // overlap with the [DT_RELA, DT_RELA + DT_RELASZ).
13100b57cec5SDimitry Andric static uint64_t addPltRelSz() {
13110b57cec5SDimitry Andric   size_t size = in.relaPlt->getSize();
13120b57cec5SDimitry Andric   if (in.relaIplt->getParent() == in.relaPlt->getParent() &&
13130b57cec5SDimitry Andric       in.relaIplt->name == in.relaPlt->name)
13140b57cec5SDimitry Andric     size += in.relaIplt->getSize();
13150b57cec5SDimitry Andric   return size;
13160b57cec5SDimitry Andric }
13170b57cec5SDimitry Andric 
13180b57cec5SDimitry Andric // Add remaining entries to complete .dynamic contents.
13190b57cec5SDimitry Andric template <class ELFT> void DynamicSection<ELFT>::finalizeContents() {
13205ffd83dbSDimitry Andric   elf::Partition &part = getPartition();
13210b57cec5SDimitry Andric   bool isMain = part.name.empty();
13220b57cec5SDimitry Andric 
13230b57cec5SDimitry Andric   for (StringRef s : config->filterList)
13240b57cec5SDimitry Andric     addInt(DT_FILTER, part.dynStrTab->addString(s));
13250b57cec5SDimitry Andric   for (StringRef s : config->auxiliaryList)
13260b57cec5SDimitry Andric     addInt(DT_AUXILIARY, part.dynStrTab->addString(s));
13270b57cec5SDimitry Andric 
13280b57cec5SDimitry Andric   if (!config->rpath.empty())
13290b57cec5SDimitry Andric     addInt(config->enableNewDtags ? DT_RUNPATH : DT_RPATH,
13300b57cec5SDimitry Andric            part.dynStrTab->addString(config->rpath));
13310b57cec5SDimitry Andric 
13320b57cec5SDimitry Andric   for (SharedFile *file : sharedFiles)
13330b57cec5SDimitry Andric     if (file->isNeeded)
13340b57cec5SDimitry Andric       addInt(DT_NEEDED, part.dynStrTab->addString(file->soName));
13350b57cec5SDimitry Andric 
13360b57cec5SDimitry Andric   if (isMain) {
13370b57cec5SDimitry Andric     if (!config->soName.empty())
13380b57cec5SDimitry Andric       addInt(DT_SONAME, part.dynStrTab->addString(config->soName));
13390b57cec5SDimitry Andric   } else {
13400b57cec5SDimitry Andric     if (!config->soName.empty())
13410b57cec5SDimitry Andric       addInt(DT_NEEDED, part.dynStrTab->addString(config->soName));
13420b57cec5SDimitry Andric     addInt(DT_SONAME, part.dynStrTab->addString(part.name));
13430b57cec5SDimitry Andric   }
13440b57cec5SDimitry Andric 
13450b57cec5SDimitry Andric   // Set DT_FLAGS and DT_FLAGS_1.
13460b57cec5SDimitry Andric   uint32_t dtFlags = 0;
13470b57cec5SDimitry Andric   uint32_t dtFlags1 = 0;
13480b57cec5SDimitry Andric   if (config->bsymbolic)
13490b57cec5SDimitry Andric     dtFlags |= DF_SYMBOLIC;
13500b57cec5SDimitry Andric   if (config->zGlobal)
13510b57cec5SDimitry Andric     dtFlags1 |= DF_1_GLOBAL;
13520b57cec5SDimitry Andric   if (config->zInitfirst)
13530b57cec5SDimitry Andric     dtFlags1 |= DF_1_INITFIRST;
13540b57cec5SDimitry Andric   if (config->zInterpose)
13550b57cec5SDimitry Andric     dtFlags1 |= DF_1_INTERPOSE;
13560b57cec5SDimitry Andric   if (config->zNodefaultlib)
13570b57cec5SDimitry Andric     dtFlags1 |= DF_1_NODEFLIB;
13580b57cec5SDimitry Andric   if (config->zNodelete)
13590b57cec5SDimitry Andric     dtFlags1 |= DF_1_NODELETE;
13600b57cec5SDimitry Andric   if (config->zNodlopen)
13610b57cec5SDimitry Andric     dtFlags1 |= DF_1_NOOPEN;
1362dfd4db93SEd Maste   if (config->pie)
1363dfd4db93SEd Maste     dtFlags1 |= DF_1_PIE;
13640b57cec5SDimitry Andric   if (config->zNow) {
13650b57cec5SDimitry Andric     dtFlags |= DF_BIND_NOW;
13660b57cec5SDimitry Andric     dtFlags1 |= DF_1_NOW;
13670b57cec5SDimitry Andric   }
13680b57cec5SDimitry Andric   if (config->zOrigin) {
13690b57cec5SDimitry Andric     dtFlags |= DF_ORIGIN;
13700b57cec5SDimitry Andric     dtFlags1 |= DF_1_ORIGIN;
13710b57cec5SDimitry Andric   }
13720b57cec5SDimitry Andric   if (!config->zText)
13730b57cec5SDimitry Andric     dtFlags |= DF_TEXTREL;
13740b57cec5SDimitry Andric   if (config->hasStaticTlsModel)
13750b57cec5SDimitry Andric     dtFlags |= DF_STATIC_TLS;
13760b57cec5SDimitry Andric 
13770b57cec5SDimitry Andric   if (dtFlags)
13780b57cec5SDimitry Andric     addInt(DT_FLAGS, dtFlags);
13790b57cec5SDimitry Andric   if (dtFlags1)
13800b57cec5SDimitry Andric     addInt(DT_FLAGS_1, dtFlags1);
13810b57cec5SDimitry Andric 
1382480093f4SDimitry Andric   // DT_DEBUG is a pointer to debug information used by debuggers at runtime. We
13830b57cec5SDimitry Andric   // need it for each process, so we don't write it for DSOs. The loader writes
13840b57cec5SDimitry Andric   // the pointer into this entry.
13850b57cec5SDimitry Andric   //
13860b57cec5SDimitry Andric   // DT_DEBUG is the only .dynamic entry that needs to be written to. Some
13870b57cec5SDimitry Andric   // systems (currently only Fuchsia OS) provide other means to give the
13880b57cec5SDimitry Andric   // debugger this information. Such systems may choose make .dynamic read-only.
13890b57cec5SDimitry Andric   // If the target is such a system (used -z rodynamic) don't write DT_DEBUG.
13900b57cec5SDimitry Andric   if (!config->shared && !config->relocatable && !config->zRodynamic)
13910b57cec5SDimitry Andric     addInt(DT_DEBUG, 0);
13920b57cec5SDimitry Andric 
13930b57cec5SDimitry Andric   if (OutputSection *sec = part.dynStrTab->getParent())
13940b57cec5SDimitry Andric     this->link = sec->sectionIndex;
13950b57cec5SDimitry Andric 
139685868e8aSDimitry Andric   if (part.relaDyn->isNeeded() ||
139785868e8aSDimitry Andric       (in.relaIplt->isNeeded() &&
139885868e8aSDimitry Andric        part.relaDyn->getParent() == in.relaIplt->getParent())) {
13990b57cec5SDimitry Andric     addInSec(part.relaDyn->dynamicTag, part.relaDyn);
140085868e8aSDimitry Andric     entries.push_back({part.relaDyn->sizeDynamicTag, addRelaSz(part.relaDyn)});
14010b57cec5SDimitry Andric 
14020b57cec5SDimitry Andric     bool isRela = config->isRela;
14030b57cec5SDimitry Andric     addInt(isRela ? DT_RELAENT : DT_RELENT,
14040b57cec5SDimitry Andric            isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel));
14050b57cec5SDimitry Andric 
14060b57cec5SDimitry Andric     // MIPS dynamic loader does not support RELCOUNT tag.
14070b57cec5SDimitry Andric     // The problem is in the tight relation between dynamic
14080b57cec5SDimitry Andric     // relocations and GOT. So do not emit this tag on MIPS.
14090b57cec5SDimitry Andric     if (config->emachine != EM_MIPS) {
14100b57cec5SDimitry Andric       size_t numRelativeRels = part.relaDyn->getRelativeRelocCount();
14110b57cec5SDimitry Andric       if (config->zCombreloc && numRelativeRels)
14120b57cec5SDimitry Andric         addInt(isRela ? DT_RELACOUNT : DT_RELCOUNT, numRelativeRels);
14130b57cec5SDimitry Andric     }
14140b57cec5SDimitry Andric   }
14150b57cec5SDimitry Andric   if (part.relrDyn && !part.relrDyn->relocs.empty()) {
14160b57cec5SDimitry Andric     addInSec(config->useAndroidRelrTags ? DT_ANDROID_RELR : DT_RELR,
14170b57cec5SDimitry Andric              part.relrDyn);
14180b57cec5SDimitry Andric     addSize(config->useAndroidRelrTags ? DT_ANDROID_RELRSZ : DT_RELRSZ,
14190b57cec5SDimitry Andric             part.relrDyn->getParent());
14200b57cec5SDimitry Andric     addInt(config->useAndroidRelrTags ? DT_ANDROID_RELRENT : DT_RELRENT,
14210b57cec5SDimitry Andric            sizeof(Elf_Relr));
14220b57cec5SDimitry Andric   }
14230b57cec5SDimitry Andric   // .rel[a].plt section usually consists of two parts, containing plt and
14240b57cec5SDimitry Andric   // iplt relocations. It is possible to have only iplt relocations in the
14250b57cec5SDimitry Andric   // output. In that case relaPlt is empty and have zero offset, the same offset
14260b57cec5SDimitry Andric   // as relaIplt has. And we still want to emit proper dynamic tags for that
1427480093f4SDimitry Andric   // case, so here we always use relaPlt as marker for the beginning of
14280b57cec5SDimitry Andric   // .rel[a].plt section.
14290b57cec5SDimitry Andric   if (isMain && (in.relaPlt->isNeeded() || in.relaIplt->isNeeded())) {
14300b57cec5SDimitry Andric     addInSec(DT_JMPREL, in.relaPlt);
14310b57cec5SDimitry Andric     entries.push_back({DT_PLTRELSZ, addPltRelSz});
14320b57cec5SDimitry Andric     switch (config->emachine) {
14330b57cec5SDimitry Andric     case EM_MIPS:
14340b57cec5SDimitry Andric       addInSec(DT_MIPS_PLTGOT, in.gotPlt);
14350b57cec5SDimitry Andric       break;
14360b57cec5SDimitry Andric     case EM_SPARCV9:
14370b57cec5SDimitry Andric       addInSec(DT_PLTGOT, in.plt);
14380b57cec5SDimitry Andric       break;
1439e8d8bef9SDimitry Andric     case EM_AARCH64:
1440e8d8bef9SDimitry Andric       if (llvm::find_if(in.relaPlt->relocs, [](const DynamicReloc &r) {
1441e8d8bef9SDimitry Andric            return r.type == target->pltRel &&
1442e8d8bef9SDimitry Andric                   r.sym->stOther & STO_AARCH64_VARIANT_PCS;
1443e8d8bef9SDimitry Andric           }) != in.relaPlt->relocs.end())
1444e8d8bef9SDimitry Andric         addInt(DT_AARCH64_VARIANT_PCS, 0);
1445e8d8bef9SDimitry Andric       LLVM_FALLTHROUGH;
14460b57cec5SDimitry Andric     default:
14470b57cec5SDimitry Andric       addInSec(DT_PLTGOT, in.gotPlt);
14480b57cec5SDimitry Andric       break;
14490b57cec5SDimitry Andric     }
14500b57cec5SDimitry Andric     addInt(DT_PLTREL, config->isRela ? DT_RELA : DT_REL);
14510b57cec5SDimitry Andric   }
14520b57cec5SDimitry Andric 
14530b57cec5SDimitry Andric   if (config->emachine == EM_AARCH64) {
14540b57cec5SDimitry Andric     if (config->andFeatures & GNU_PROPERTY_AARCH64_FEATURE_1_BTI)
14550b57cec5SDimitry Andric       addInt(DT_AARCH64_BTI_PLT, 0);
14565ffd83dbSDimitry Andric     if (config->zPacPlt)
14570b57cec5SDimitry Andric       addInt(DT_AARCH64_PAC_PLT, 0);
14580b57cec5SDimitry Andric   }
14590b57cec5SDimitry Andric 
14600b57cec5SDimitry Andric   addInSec(DT_SYMTAB, part.dynSymTab);
14610b57cec5SDimitry Andric   addInt(DT_SYMENT, sizeof(Elf_Sym));
14620b57cec5SDimitry Andric   addInSec(DT_STRTAB, part.dynStrTab);
14630b57cec5SDimitry Andric   addInt(DT_STRSZ, part.dynStrTab->getSize());
14640b57cec5SDimitry Andric   if (!config->zText)
14650b57cec5SDimitry Andric     addInt(DT_TEXTREL, 0);
14660b57cec5SDimitry Andric   if (part.gnuHashTab)
14670b57cec5SDimitry Andric     addInSec(DT_GNU_HASH, part.gnuHashTab);
14680b57cec5SDimitry Andric   if (part.hashTab)
14690b57cec5SDimitry Andric     addInSec(DT_HASH, part.hashTab);
14700b57cec5SDimitry Andric 
14710b57cec5SDimitry Andric   if (isMain) {
14720b57cec5SDimitry Andric     if (Out::preinitArray) {
14730b57cec5SDimitry Andric       addOutSec(DT_PREINIT_ARRAY, Out::preinitArray);
14740b57cec5SDimitry Andric       addSize(DT_PREINIT_ARRAYSZ, Out::preinitArray);
14750b57cec5SDimitry Andric     }
14760b57cec5SDimitry Andric     if (Out::initArray) {
14770b57cec5SDimitry Andric       addOutSec(DT_INIT_ARRAY, Out::initArray);
14780b57cec5SDimitry Andric       addSize(DT_INIT_ARRAYSZ, Out::initArray);
14790b57cec5SDimitry Andric     }
14800b57cec5SDimitry Andric     if (Out::finiArray) {
14810b57cec5SDimitry Andric       addOutSec(DT_FINI_ARRAY, Out::finiArray);
14820b57cec5SDimitry Andric       addSize(DT_FINI_ARRAYSZ, Out::finiArray);
14830b57cec5SDimitry Andric     }
14840b57cec5SDimitry Andric 
14850b57cec5SDimitry Andric     if (Symbol *b = symtab->find(config->init))
14860b57cec5SDimitry Andric       if (b->isDefined())
14870b57cec5SDimitry Andric         addSym(DT_INIT, b);
14880b57cec5SDimitry Andric     if (Symbol *b = symtab->find(config->fini))
14890b57cec5SDimitry Andric       if (b->isDefined())
14900b57cec5SDimitry Andric         addSym(DT_FINI, b);
14910b57cec5SDimitry Andric   }
14920b57cec5SDimitry Andric 
1493480093f4SDimitry Andric   if (part.verSym && part.verSym->isNeeded())
14940b57cec5SDimitry Andric     addInSec(DT_VERSYM, part.verSym);
1495480093f4SDimitry Andric   if (part.verDef && part.verDef->isLive()) {
14960b57cec5SDimitry Andric     addInSec(DT_VERDEF, part.verDef);
14970b57cec5SDimitry Andric     addInt(DT_VERDEFNUM, getVerDefNum());
14980b57cec5SDimitry Andric   }
1499480093f4SDimitry Andric   if (part.verNeed && part.verNeed->isNeeded()) {
15000b57cec5SDimitry Andric     addInSec(DT_VERNEED, part.verNeed);
15010b57cec5SDimitry Andric     unsigned needNum = 0;
15020b57cec5SDimitry Andric     for (SharedFile *f : sharedFiles)
15030b57cec5SDimitry Andric       if (!f->vernauxs.empty())
15040b57cec5SDimitry Andric         ++needNum;
15050b57cec5SDimitry Andric     addInt(DT_VERNEEDNUM, needNum);
15060b57cec5SDimitry Andric   }
15070b57cec5SDimitry Andric 
15080b57cec5SDimitry Andric   if (config->emachine == EM_MIPS) {
15090b57cec5SDimitry Andric     addInt(DT_MIPS_RLD_VERSION, 1);
15100b57cec5SDimitry Andric     addInt(DT_MIPS_FLAGS, RHF_NOTPOT);
15110b57cec5SDimitry Andric     addInt(DT_MIPS_BASE_ADDRESS, target->getImageBase());
15120b57cec5SDimitry Andric     addInt(DT_MIPS_SYMTABNO, part.dynSymTab->getNumSymbols());
15130b57cec5SDimitry Andric 
15140b57cec5SDimitry Andric     add(DT_MIPS_LOCAL_GOTNO, [] { return in.mipsGot->getLocalEntriesNum(); });
15150b57cec5SDimitry Andric 
15160b57cec5SDimitry Andric     if (const Symbol *b = in.mipsGot->getFirstGlobalEntry())
15170b57cec5SDimitry Andric       addInt(DT_MIPS_GOTSYM, b->dynsymIndex);
15180b57cec5SDimitry Andric     else
15190b57cec5SDimitry Andric       addInt(DT_MIPS_GOTSYM, part.dynSymTab->getNumSymbols());
15200b57cec5SDimitry Andric     addInSec(DT_PLTGOT, in.mipsGot);
15210b57cec5SDimitry Andric     if (in.mipsRldMap) {
15220b57cec5SDimitry Andric       if (!config->pie)
15230b57cec5SDimitry Andric         addInSec(DT_MIPS_RLD_MAP, in.mipsRldMap);
15240b57cec5SDimitry Andric       // Store the offset to the .rld_map section
15250b57cec5SDimitry Andric       // relative to the address of the tag.
15260b57cec5SDimitry Andric       addInSecRelative(DT_MIPS_RLD_MAP_REL, in.mipsRldMap);
15270b57cec5SDimitry Andric     }
15280b57cec5SDimitry Andric   }
15290b57cec5SDimitry Andric 
15300b57cec5SDimitry Andric   // DT_PPC_GOT indicates to glibc Secure PLT is used. If DT_PPC_GOT is absent,
15310b57cec5SDimitry Andric   // glibc assumes the old-style BSS PLT layout which we don't support.
15320b57cec5SDimitry Andric   if (config->emachine == EM_PPC)
15330b57cec5SDimitry Andric     add(DT_PPC_GOT, [] { return in.got->getVA(); });
15340b57cec5SDimitry Andric 
15350b57cec5SDimitry Andric   // Glink dynamic tag is required by the V2 abi if the plt section isn't empty.
15360b57cec5SDimitry Andric   if (config->emachine == EM_PPC64 && in.plt->isNeeded()) {
15370b57cec5SDimitry Andric     // The Glink tag points to 32 bytes before the first lazy symbol resolution
15380b57cec5SDimitry Andric     // stub, which starts directly after the header.
15390b57cec5SDimitry Andric     entries.push_back({DT_PPC64_GLINK, [=] {
15400b57cec5SDimitry Andric                          unsigned offset = target->pltHeaderSize - 32;
15410b57cec5SDimitry Andric                          return in.plt->getVA(0) + offset;
15420b57cec5SDimitry Andric                        }});
15430b57cec5SDimitry Andric   }
15440b57cec5SDimitry Andric 
15450b57cec5SDimitry Andric   addInt(DT_NULL, 0);
15460b57cec5SDimitry Andric 
15470b57cec5SDimitry Andric   getParent()->link = this->link;
15480b57cec5SDimitry Andric   this->size = entries.size() * this->entsize;
15490b57cec5SDimitry Andric }
15500b57cec5SDimitry Andric 
15510b57cec5SDimitry Andric template <class ELFT> void DynamicSection<ELFT>::writeTo(uint8_t *buf) {
15520b57cec5SDimitry Andric   auto *p = reinterpret_cast<Elf_Dyn *>(buf);
15530b57cec5SDimitry Andric 
15540b57cec5SDimitry Andric   for (std::pair<int32_t, std::function<uint64_t()>> &kv : entries) {
15550b57cec5SDimitry Andric     p->d_tag = kv.first;
15560b57cec5SDimitry Andric     p->d_un.d_val = kv.second();
15570b57cec5SDimitry Andric     ++p;
15580b57cec5SDimitry Andric   }
15590b57cec5SDimitry Andric }
15600b57cec5SDimitry Andric 
15610b57cec5SDimitry Andric uint64_t DynamicReloc::getOffset() const {
15620b57cec5SDimitry Andric   return inputSec->getVA(offsetInSec);
15630b57cec5SDimitry Andric }
15640b57cec5SDimitry Andric 
15650b57cec5SDimitry Andric int64_t DynamicReloc::computeAddend() const {
15660b57cec5SDimitry Andric   if (useSymVA)
15670b57cec5SDimitry Andric     return sym->getVA(addend);
15680b57cec5SDimitry Andric   if (!outputSec)
15690b57cec5SDimitry Andric     return addend;
15700b57cec5SDimitry Andric   // See the comment in the DynamicReloc ctor.
15710b57cec5SDimitry Andric   return getMipsPageAddr(outputSec->addr) + addend;
15720b57cec5SDimitry Andric }
15730b57cec5SDimitry Andric 
15740b57cec5SDimitry Andric uint32_t DynamicReloc::getSymIndex(SymbolTableBaseSection *symTab) const {
15750b57cec5SDimitry Andric   if (sym && !useSymVA)
15760b57cec5SDimitry Andric     return symTab->getSymbolIndex(sym);
15770b57cec5SDimitry Andric   return 0;
15780b57cec5SDimitry Andric }
15790b57cec5SDimitry Andric 
15800b57cec5SDimitry Andric RelocationBaseSection::RelocationBaseSection(StringRef name, uint32_t type,
15810b57cec5SDimitry Andric                                              int32_t dynamicTag,
15820b57cec5SDimitry Andric                                              int32_t sizeDynamicTag)
15830b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, type, config->wordsize, name),
15840b57cec5SDimitry Andric       dynamicTag(dynamicTag), sizeDynamicTag(sizeDynamicTag) {}
15850b57cec5SDimitry Andric 
15860b57cec5SDimitry Andric void RelocationBaseSection::addReloc(RelType dynType, InputSectionBase *isec,
15870b57cec5SDimitry Andric                                      uint64_t offsetInSec, Symbol *sym) {
15880b57cec5SDimitry Andric   addReloc({dynType, isec, offsetInSec, false, sym, 0});
15890b57cec5SDimitry Andric }
15900b57cec5SDimitry Andric 
15910b57cec5SDimitry Andric void RelocationBaseSection::addReloc(RelType dynType,
15920b57cec5SDimitry Andric                                      InputSectionBase *inputSec,
15930b57cec5SDimitry Andric                                      uint64_t offsetInSec, Symbol *sym,
15940b57cec5SDimitry Andric                                      int64_t addend, RelExpr expr,
15950b57cec5SDimitry Andric                                      RelType type) {
15960b57cec5SDimitry Andric   // Write the addends to the relocated address if required. We skip
15970b57cec5SDimitry Andric   // it if the written value would be zero.
15980b57cec5SDimitry Andric   if (config->writeAddends && (expr != R_ADDEND || addend != 0))
15990b57cec5SDimitry Andric     inputSec->relocations.push_back({expr, type, offsetInSec, addend, sym});
16000b57cec5SDimitry Andric   addReloc({dynType, inputSec, offsetInSec, expr != R_ADDEND, sym, addend});
16010b57cec5SDimitry Andric }
16020b57cec5SDimitry Andric 
16030b57cec5SDimitry Andric void RelocationBaseSection::addReloc(const DynamicReloc &reloc) {
16040b57cec5SDimitry Andric   if (reloc.type == target->relativeRel)
16050b57cec5SDimitry Andric     ++numRelativeRelocs;
16060b57cec5SDimitry Andric   relocs.push_back(reloc);
16070b57cec5SDimitry Andric }
16080b57cec5SDimitry Andric 
16090b57cec5SDimitry Andric void RelocationBaseSection::finalizeContents() {
16100b57cec5SDimitry Andric   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
16110b57cec5SDimitry Andric 
16120b57cec5SDimitry Andric   // When linking glibc statically, .rel{,a}.plt contains R_*_IRELATIVE
16130b57cec5SDimitry Andric   // relocations due to IFUNC (e.g. strcpy). sh_link will be set to 0 in that
16140b57cec5SDimitry Andric   // case.
16150b57cec5SDimitry Andric   if (symTab && symTab->getParent())
16160b57cec5SDimitry Andric     getParent()->link = symTab->getParent()->sectionIndex;
16170b57cec5SDimitry Andric   else
16180b57cec5SDimitry Andric     getParent()->link = 0;
16190b57cec5SDimitry Andric 
1620e8d8bef9SDimitry Andric   if (in.relaPlt == this) {
1621e8d8bef9SDimitry Andric     getParent()->flags |= ELF::SHF_INFO_LINK;
16220b57cec5SDimitry Andric     getParent()->info = in.gotPlt->getParent()->sectionIndex;
1623e8d8bef9SDimitry Andric   }
1624e8d8bef9SDimitry Andric   if (in.relaIplt == this) {
1625e8d8bef9SDimitry Andric     getParent()->flags |= ELF::SHF_INFO_LINK;
16260b57cec5SDimitry Andric     getParent()->info = in.igotPlt->getParent()->sectionIndex;
16270b57cec5SDimitry Andric   }
1628e8d8bef9SDimitry Andric }
16290b57cec5SDimitry Andric 
16300b57cec5SDimitry Andric RelrBaseSection::RelrBaseSection()
16310b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC,
16320b57cec5SDimitry Andric                        config->useAndroidRelrTags ? SHT_ANDROID_RELR : SHT_RELR,
16330b57cec5SDimitry Andric                        config->wordsize, ".relr.dyn") {}
16340b57cec5SDimitry Andric 
16350b57cec5SDimitry Andric template <class ELFT>
16360b57cec5SDimitry Andric static void encodeDynamicReloc(SymbolTableBaseSection *symTab,
16370b57cec5SDimitry Andric                                typename ELFT::Rela *p,
16380b57cec5SDimitry Andric                                const DynamicReloc &rel) {
16390b57cec5SDimitry Andric   if (config->isRela)
16400b57cec5SDimitry Andric     p->r_addend = rel.computeAddend();
16410b57cec5SDimitry Andric   p->r_offset = rel.getOffset();
16420b57cec5SDimitry Andric   p->setSymbolAndType(rel.getSymIndex(symTab), rel.type, config->isMips64EL);
16430b57cec5SDimitry Andric }
16440b57cec5SDimitry Andric 
16450b57cec5SDimitry Andric template <class ELFT>
16460b57cec5SDimitry Andric RelocationSection<ELFT>::RelocationSection(StringRef name, bool sort)
16470b57cec5SDimitry Andric     : RelocationBaseSection(name, config->isRela ? SHT_RELA : SHT_REL,
16480b57cec5SDimitry Andric                             config->isRela ? DT_RELA : DT_REL,
16490b57cec5SDimitry Andric                             config->isRela ? DT_RELASZ : DT_RELSZ),
16500b57cec5SDimitry Andric       sort(sort) {
16510b57cec5SDimitry Andric   this->entsize = config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
16520b57cec5SDimitry Andric }
16530b57cec5SDimitry Andric 
16540b57cec5SDimitry Andric template <class ELFT> void RelocationSection<ELFT>::writeTo(uint8_t *buf) {
16550b57cec5SDimitry Andric   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
16560b57cec5SDimitry Andric 
16570b57cec5SDimitry Andric   // Sort by (!IsRelative,SymIndex,r_offset). DT_REL[A]COUNT requires us to
16580b57cec5SDimitry Andric   // place R_*_RELATIVE first. SymIndex is to improve locality, while r_offset
16590b57cec5SDimitry Andric   // is to make results easier to read.
16600b57cec5SDimitry Andric   if (sort)
16610b57cec5SDimitry Andric     llvm::stable_sort(
16620b57cec5SDimitry Andric         relocs, [&](const DynamicReloc &a, const DynamicReloc &b) {
16630b57cec5SDimitry Andric           return std::make_tuple(a.type != target->relativeRel,
16640b57cec5SDimitry Andric                                  a.getSymIndex(symTab), a.getOffset()) <
16650b57cec5SDimitry Andric                  std::make_tuple(b.type != target->relativeRel,
16660b57cec5SDimitry Andric                                  b.getSymIndex(symTab), b.getOffset());
16670b57cec5SDimitry Andric         });
16680b57cec5SDimitry Andric 
16690b57cec5SDimitry Andric   for (const DynamicReloc &rel : relocs) {
16700b57cec5SDimitry Andric     encodeDynamicReloc<ELFT>(symTab, reinterpret_cast<Elf_Rela *>(buf), rel);
16710b57cec5SDimitry Andric     buf += config->isRela ? sizeof(Elf_Rela) : sizeof(Elf_Rel);
16720b57cec5SDimitry Andric   }
16730b57cec5SDimitry Andric }
16740b57cec5SDimitry Andric 
16750b57cec5SDimitry Andric template <class ELFT>
16760b57cec5SDimitry Andric AndroidPackedRelocationSection<ELFT>::AndroidPackedRelocationSection(
16770b57cec5SDimitry Andric     StringRef name)
16780b57cec5SDimitry Andric     : RelocationBaseSection(
16790b57cec5SDimitry Andric           name, config->isRela ? SHT_ANDROID_RELA : SHT_ANDROID_REL,
16800b57cec5SDimitry Andric           config->isRela ? DT_ANDROID_RELA : DT_ANDROID_REL,
16810b57cec5SDimitry Andric           config->isRela ? DT_ANDROID_RELASZ : DT_ANDROID_RELSZ) {
16820b57cec5SDimitry Andric   this->entsize = 1;
16830b57cec5SDimitry Andric }
16840b57cec5SDimitry Andric 
16850b57cec5SDimitry Andric template <class ELFT>
16860b57cec5SDimitry Andric bool AndroidPackedRelocationSection<ELFT>::updateAllocSize() {
16870b57cec5SDimitry Andric   // This function computes the contents of an Android-format packed relocation
16880b57cec5SDimitry Andric   // section.
16890b57cec5SDimitry Andric   //
16900b57cec5SDimitry Andric   // This format compresses relocations by using relocation groups to factor out
16910b57cec5SDimitry Andric   // fields that are common between relocations and storing deltas from previous
16920b57cec5SDimitry Andric   // relocations in SLEB128 format (which has a short representation for small
16930b57cec5SDimitry Andric   // numbers). A good example of a relocation type with common fields is
16940b57cec5SDimitry Andric   // R_*_RELATIVE, which is normally used to represent function pointers in
16950b57cec5SDimitry Andric   // vtables. In the REL format, each relative relocation has the same r_info
16960b57cec5SDimitry Andric   // field, and is only different from other relative relocations in terms of
16970b57cec5SDimitry Andric   // the r_offset field. By sorting relocations by offset, grouping them by
16980b57cec5SDimitry Andric   // r_info and representing each relocation with only the delta from the
16990b57cec5SDimitry Andric   // previous offset, each 8-byte relocation can be compressed to as little as 1
17000b57cec5SDimitry Andric   // byte (or less with run-length encoding). This relocation packer was able to
17010b57cec5SDimitry Andric   // reduce the size of the relocation section in an Android Chromium DSO from
17020b57cec5SDimitry Andric   // 2,911,184 bytes to 174,693 bytes, or 6% of the original size.
17030b57cec5SDimitry Andric   //
17040b57cec5SDimitry Andric   // A relocation section consists of a header containing the literal bytes
17050b57cec5SDimitry Andric   // 'APS2' followed by a sequence of SLEB128-encoded integers. The first two
17060b57cec5SDimitry Andric   // elements are the total number of relocations in the section and an initial
17070b57cec5SDimitry Andric   // r_offset value. The remaining elements define a sequence of relocation
17080b57cec5SDimitry Andric   // groups. Each relocation group starts with a header consisting of the
17090b57cec5SDimitry Andric   // following elements:
17100b57cec5SDimitry Andric   //
17110b57cec5SDimitry Andric   // - the number of relocations in the relocation group
17120b57cec5SDimitry Andric   // - flags for the relocation group
17130b57cec5SDimitry Andric   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is set) the r_offset delta
17140b57cec5SDimitry Andric   //   for each relocation in the group.
17150b57cec5SDimitry Andric   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is set) the value of the r_info
17160b57cec5SDimitry Andric   //   field for each relocation in the group.
17170b57cec5SDimitry Andric   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG and
17180b57cec5SDimitry Andric   //   RELOCATION_GROUPED_BY_ADDEND_FLAG are set) the r_addend delta for
17190b57cec5SDimitry Andric   //   each relocation in the group.
17200b57cec5SDimitry Andric   //
17210b57cec5SDimitry Andric   // Following the relocation group header are descriptions of each of the
17220b57cec5SDimitry Andric   // relocations in the group. They consist of the following elements:
17230b57cec5SDimitry Andric   //
17240b57cec5SDimitry Andric   // - (if RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG is not set) the r_offset
17250b57cec5SDimitry Andric   //   delta for this relocation.
17260b57cec5SDimitry Andric   // - (if RELOCATION_GROUPED_BY_INFO_FLAG is not set) the value of the r_info
17270b57cec5SDimitry Andric   //   field for this relocation.
17280b57cec5SDimitry Andric   // - (if RELOCATION_GROUP_HAS_ADDEND_FLAG is set and
17290b57cec5SDimitry Andric   //   RELOCATION_GROUPED_BY_ADDEND_FLAG is not set) the r_addend delta for
17300b57cec5SDimitry Andric   //   this relocation.
17310b57cec5SDimitry Andric 
17320b57cec5SDimitry Andric   size_t oldSize = relocData.size();
17330b57cec5SDimitry Andric 
17340b57cec5SDimitry Andric   relocData = {'A', 'P', 'S', '2'};
17350b57cec5SDimitry Andric   raw_svector_ostream os(relocData);
17360b57cec5SDimitry Andric   auto add = [&](int64_t v) { encodeSLEB128(v, os); };
17370b57cec5SDimitry Andric 
17380b57cec5SDimitry Andric   // The format header includes the number of relocations and the initial
17390b57cec5SDimitry Andric   // offset (we set this to zero because the first relocation group will
17400b57cec5SDimitry Andric   // perform the initial adjustment).
17410b57cec5SDimitry Andric   add(relocs.size());
17420b57cec5SDimitry Andric   add(0);
17430b57cec5SDimitry Andric 
17440b57cec5SDimitry Andric   std::vector<Elf_Rela> relatives, nonRelatives;
17450b57cec5SDimitry Andric 
17460b57cec5SDimitry Andric   for (const DynamicReloc &rel : relocs) {
17470b57cec5SDimitry Andric     Elf_Rela r;
17480b57cec5SDimitry Andric     encodeDynamicReloc<ELFT>(getPartition().dynSymTab, &r, rel);
17490b57cec5SDimitry Andric 
17500b57cec5SDimitry Andric     if (r.getType(config->isMips64EL) == target->relativeRel)
17510b57cec5SDimitry Andric       relatives.push_back(r);
17520b57cec5SDimitry Andric     else
17530b57cec5SDimitry Andric       nonRelatives.push_back(r);
17540b57cec5SDimitry Andric   }
17550b57cec5SDimitry Andric 
17560b57cec5SDimitry Andric   llvm::sort(relatives, [](const Elf_Rel &a, const Elf_Rel &b) {
17570b57cec5SDimitry Andric     return a.r_offset < b.r_offset;
17580b57cec5SDimitry Andric   });
17590b57cec5SDimitry Andric 
17600b57cec5SDimitry Andric   // Try to find groups of relative relocations which are spaced one word
17610b57cec5SDimitry Andric   // apart from one another. These generally correspond to vtable entries. The
17620b57cec5SDimitry Andric   // format allows these groups to be encoded using a sort of run-length
17630b57cec5SDimitry Andric   // encoding, but each group will cost 7 bytes in addition to the offset from
17640b57cec5SDimitry Andric   // the previous group, so it is only profitable to do this for groups of
17650b57cec5SDimitry Andric   // size 8 or larger.
17660b57cec5SDimitry Andric   std::vector<Elf_Rela> ungroupedRelatives;
17670b57cec5SDimitry Andric   std::vector<std::vector<Elf_Rela>> relativeGroups;
17680b57cec5SDimitry Andric   for (auto i = relatives.begin(), e = relatives.end(); i != e;) {
17690b57cec5SDimitry Andric     std::vector<Elf_Rela> group;
17700b57cec5SDimitry Andric     do {
17710b57cec5SDimitry Andric       group.push_back(*i++);
17720b57cec5SDimitry Andric     } while (i != e && (i - 1)->r_offset + config->wordsize == i->r_offset);
17730b57cec5SDimitry Andric 
17740b57cec5SDimitry Andric     if (group.size() < 8)
17750b57cec5SDimitry Andric       ungroupedRelatives.insert(ungroupedRelatives.end(), group.begin(),
17760b57cec5SDimitry Andric                                 group.end());
17770b57cec5SDimitry Andric     else
17780b57cec5SDimitry Andric       relativeGroups.emplace_back(std::move(group));
17790b57cec5SDimitry Andric   }
17800b57cec5SDimitry Andric 
178185868e8aSDimitry Andric   // For non-relative relocations, we would like to:
178285868e8aSDimitry Andric   //   1. Have relocations with the same symbol offset to be consecutive, so
178385868e8aSDimitry Andric   //      that the runtime linker can speed-up symbol lookup by implementing an
178485868e8aSDimitry Andric   //      1-entry cache.
178585868e8aSDimitry Andric   //   2. Group relocations by r_info to reduce the size of the relocation
178685868e8aSDimitry Andric   //      section.
178785868e8aSDimitry Andric   // Since the symbol offset is the high bits in r_info, sorting by r_info
178885868e8aSDimitry Andric   // allows us to do both.
178985868e8aSDimitry Andric   //
179085868e8aSDimitry Andric   // For Rela, we also want to sort by r_addend when r_info is the same. This
179185868e8aSDimitry Andric   // enables us to group by r_addend as well.
179285868e8aSDimitry Andric   llvm::stable_sort(nonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
179385868e8aSDimitry Andric     if (a.r_info != b.r_info)
179485868e8aSDimitry Andric       return a.r_info < b.r_info;
179585868e8aSDimitry Andric     if (config->isRela)
179685868e8aSDimitry Andric       return a.r_addend < b.r_addend;
179785868e8aSDimitry Andric     return false;
179885868e8aSDimitry Andric   });
179985868e8aSDimitry Andric 
180085868e8aSDimitry Andric   // Group relocations with the same r_info. Note that each group emits a group
180185868e8aSDimitry Andric   // header and that may make the relocation section larger. It is hard to
180285868e8aSDimitry Andric   // estimate the size of a group header as the encoded size of that varies
180385868e8aSDimitry Andric   // based on r_info. However, we can approximate this trade-off by the number
180485868e8aSDimitry Andric   // of values encoded. Each group header contains 3 values, and each relocation
180585868e8aSDimitry Andric   // in a group encodes one less value, as compared to when it is not grouped.
180685868e8aSDimitry Andric   // Therefore, we only group relocations if there are 3 or more of them with
180785868e8aSDimitry Andric   // the same r_info.
180885868e8aSDimitry Andric   //
180985868e8aSDimitry Andric   // For Rela, the addend for most non-relative relocations is zero, and thus we
181085868e8aSDimitry Andric   // can usually get a smaller relocation section if we group relocations with 0
181185868e8aSDimitry Andric   // addend as well.
181285868e8aSDimitry Andric   std::vector<Elf_Rela> ungroupedNonRelatives;
181385868e8aSDimitry Andric   std::vector<std::vector<Elf_Rela>> nonRelativeGroups;
181485868e8aSDimitry Andric   for (auto i = nonRelatives.begin(), e = nonRelatives.end(); i != e;) {
181585868e8aSDimitry Andric     auto j = i + 1;
181685868e8aSDimitry Andric     while (j != e && i->r_info == j->r_info &&
181785868e8aSDimitry Andric            (!config->isRela || i->r_addend == j->r_addend))
181885868e8aSDimitry Andric       ++j;
181985868e8aSDimitry Andric     if (j - i < 3 || (config->isRela && i->r_addend != 0))
182085868e8aSDimitry Andric       ungroupedNonRelatives.insert(ungroupedNonRelatives.end(), i, j);
182185868e8aSDimitry Andric     else
182285868e8aSDimitry Andric       nonRelativeGroups.emplace_back(i, j);
182385868e8aSDimitry Andric     i = j;
182485868e8aSDimitry Andric   }
182585868e8aSDimitry Andric 
182685868e8aSDimitry Andric   // Sort ungrouped relocations by offset to minimize the encoded length.
182785868e8aSDimitry Andric   llvm::sort(ungroupedNonRelatives, [](const Elf_Rela &a, const Elf_Rela &b) {
182885868e8aSDimitry Andric     return a.r_offset < b.r_offset;
182985868e8aSDimitry Andric   });
183085868e8aSDimitry Andric 
18310b57cec5SDimitry Andric   unsigned hasAddendIfRela =
18320b57cec5SDimitry Andric       config->isRela ? RELOCATION_GROUP_HAS_ADDEND_FLAG : 0;
18330b57cec5SDimitry Andric 
18340b57cec5SDimitry Andric   uint64_t offset = 0;
18350b57cec5SDimitry Andric   uint64_t addend = 0;
18360b57cec5SDimitry Andric 
18370b57cec5SDimitry Andric   // Emit the run-length encoding for the groups of adjacent relative
18380b57cec5SDimitry Andric   // relocations. Each group is represented using two groups in the packed
18390b57cec5SDimitry Andric   // format. The first is used to set the current offset to the start of the
18400b57cec5SDimitry Andric   // group (and also encodes the first relocation), and the second encodes the
18410b57cec5SDimitry Andric   // remaining relocations.
18420b57cec5SDimitry Andric   for (std::vector<Elf_Rela> &g : relativeGroups) {
18430b57cec5SDimitry Andric     // The first relocation in the group.
18440b57cec5SDimitry Andric     add(1);
18450b57cec5SDimitry Andric     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
18460b57cec5SDimitry Andric         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
18470b57cec5SDimitry Andric     add(g[0].r_offset - offset);
18480b57cec5SDimitry Andric     add(target->relativeRel);
18490b57cec5SDimitry Andric     if (config->isRela) {
18500b57cec5SDimitry Andric       add(g[0].r_addend - addend);
18510b57cec5SDimitry Andric       addend = g[0].r_addend;
18520b57cec5SDimitry Andric     }
18530b57cec5SDimitry Andric 
18540b57cec5SDimitry Andric     // The remaining relocations.
18550b57cec5SDimitry Andric     add(g.size() - 1);
18560b57cec5SDimitry Andric     add(RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG |
18570b57cec5SDimitry Andric         RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
18580b57cec5SDimitry Andric     add(config->wordsize);
18590b57cec5SDimitry Andric     add(target->relativeRel);
18600b57cec5SDimitry Andric     if (config->isRela) {
18610b57cec5SDimitry Andric       for (auto i = g.begin() + 1, e = g.end(); i != e; ++i) {
18620b57cec5SDimitry Andric         add(i->r_addend - addend);
18630b57cec5SDimitry Andric         addend = i->r_addend;
18640b57cec5SDimitry Andric       }
18650b57cec5SDimitry Andric     }
18660b57cec5SDimitry Andric 
18670b57cec5SDimitry Andric     offset = g.back().r_offset;
18680b57cec5SDimitry Andric   }
18690b57cec5SDimitry Andric 
18700b57cec5SDimitry Andric   // Now the ungrouped relatives.
18710b57cec5SDimitry Andric   if (!ungroupedRelatives.empty()) {
18720b57cec5SDimitry Andric     add(ungroupedRelatives.size());
18730b57cec5SDimitry Andric     add(RELOCATION_GROUPED_BY_INFO_FLAG | hasAddendIfRela);
18740b57cec5SDimitry Andric     add(target->relativeRel);
18750b57cec5SDimitry Andric     for (Elf_Rela &r : ungroupedRelatives) {
18760b57cec5SDimitry Andric       add(r.r_offset - offset);
18770b57cec5SDimitry Andric       offset = r.r_offset;
18780b57cec5SDimitry Andric       if (config->isRela) {
18790b57cec5SDimitry Andric         add(r.r_addend - addend);
18800b57cec5SDimitry Andric         addend = r.r_addend;
18810b57cec5SDimitry Andric       }
18820b57cec5SDimitry Andric     }
18830b57cec5SDimitry Andric   }
18840b57cec5SDimitry Andric 
188585868e8aSDimitry Andric   // Grouped non-relatives.
188685868e8aSDimitry Andric   for (ArrayRef<Elf_Rela> g : nonRelativeGroups) {
188785868e8aSDimitry Andric     add(g.size());
188885868e8aSDimitry Andric     add(RELOCATION_GROUPED_BY_INFO_FLAG);
188985868e8aSDimitry Andric     add(g[0].r_info);
189085868e8aSDimitry Andric     for (const Elf_Rela &r : g) {
189185868e8aSDimitry Andric       add(r.r_offset - offset);
189285868e8aSDimitry Andric       offset = r.r_offset;
189385868e8aSDimitry Andric     }
189485868e8aSDimitry Andric     addend = 0;
189585868e8aSDimitry Andric   }
189685868e8aSDimitry Andric 
189785868e8aSDimitry Andric   // Finally the ungrouped non-relative relocations.
189885868e8aSDimitry Andric   if (!ungroupedNonRelatives.empty()) {
189985868e8aSDimitry Andric     add(ungroupedNonRelatives.size());
19000b57cec5SDimitry Andric     add(hasAddendIfRela);
190185868e8aSDimitry Andric     for (Elf_Rela &r : ungroupedNonRelatives) {
19020b57cec5SDimitry Andric       add(r.r_offset - offset);
19030b57cec5SDimitry Andric       offset = r.r_offset;
19040b57cec5SDimitry Andric       add(r.r_info);
19050b57cec5SDimitry Andric       if (config->isRela) {
19060b57cec5SDimitry Andric         add(r.r_addend - addend);
19070b57cec5SDimitry Andric         addend = r.r_addend;
19080b57cec5SDimitry Andric       }
19090b57cec5SDimitry Andric     }
19100b57cec5SDimitry Andric   }
19110b57cec5SDimitry Andric 
19120b57cec5SDimitry Andric   // Don't allow the section to shrink; otherwise the size of the section can
19130b57cec5SDimitry Andric   // oscillate infinitely.
19140b57cec5SDimitry Andric   if (relocData.size() < oldSize)
19150b57cec5SDimitry Andric     relocData.append(oldSize - relocData.size(), 0);
19160b57cec5SDimitry Andric 
19170b57cec5SDimitry Andric   // Returns whether the section size changed. We need to keep recomputing both
19180b57cec5SDimitry Andric   // section layout and the contents of this section until the size converges
19190b57cec5SDimitry Andric   // because changing this section's size can affect section layout, which in
19200b57cec5SDimitry Andric   // turn can affect the sizes of the LEB-encoded integers stored in this
19210b57cec5SDimitry Andric   // section.
19220b57cec5SDimitry Andric   return relocData.size() != oldSize;
19230b57cec5SDimitry Andric }
19240b57cec5SDimitry Andric 
19250b57cec5SDimitry Andric template <class ELFT> RelrSection<ELFT>::RelrSection() {
19260b57cec5SDimitry Andric   this->entsize = config->wordsize;
19270b57cec5SDimitry Andric }
19280b57cec5SDimitry Andric 
19290b57cec5SDimitry Andric template <class ELFT> bool RelrSection<ELFT>::updateAllocSize() {
19300b57cec5SDimitry Andric   // This function computes the contents of an SHT_RELR packed relocation
19310b57cec5SDimitry Andric   // section.
19320b57cec5SDimitry Andric   //
19330b57cec5SDimitry Andric   // Proposal for adding SHT_RELR sections to generic-abi is here:
19340b57cec5SDimitry Andric   //   https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
19350b57cec5SDimitry Andric   //
19360b57cec5SDimitry Andric   // The encoded sequence of Elf64_Relr entries in a SHT_RELR section looks
19370b57cec5SDimitry Andric   // like [ AAAAAAAA BBBBBBB1 BBBBBBB1 ... AAAAAAAA BBBBBB1 ... ]
19380b57cec5SDimitry Andric   //
19390b57cec5SDimitry Andric   // i.e. start with an address, followed by any number of bitmaps. The address
19400b57cec5SDimitry Andric   // entry encodes 1 relocation. The subsequent bitmap entries encode up to 63
19410b57cec5SDimitry Andric   // relocations each, at subsequent offsets following the last address entry.
19420b57cec5SDimitry Andric   //
19430b57cec5SDimitry Andric   // The bitmap entries must have 1 in the least significant bit. The assumption
19440b57cec5SDimitry Andric   // here is that an address cannot have 1 in lsb. Odd addresses are not
19450b57cec5SDimitry Andric   // supported.
19460b57cec5SDimitry Andric   //
19470b57cec5SDimitry Andric   // Excluding the least significant bit in the bitmap, each non-zero bit in
19480b57cec5SDimitry Andric   // the bitmap represents a relocation to be applied to a corresponding machine
19490b57cec5SDimitry Andric   // word that follows the base address word. The second least significant bit
19500b57cec5SDimitry Andric   // represents the machine word immediately following the initial address, and
19510b57cec5SDimitry Andric   // each bit that follows represents the next word, in linear order. As such,
19520b57cec5SDimitry Andric   // a single bitmap can encode up to 31 relocations in a 32-bit object, and
19530b57cec5SDimitry Andric   // 63 relocations in a 64-bit object.
19540b57cec5SDimitry Andric   //
19550b57cec5SDimitry Andric   // This encoding has a couple of interesting properties:
19560b57cec5SDimitry Andric   // 1. Looking at any entry, it is clear whether it's an address or a bitmap:
19570b57cec5SDimitry Andric   //    even means address, odd means bitmap.
19580b57cec5SDimitry Andric   // 2. Just a simple list of addresses is a valid encoding.
19590b57cec5SDimitry Andric 
19600b57cec5SDimitry Andric   size_t oldSize = relrRelocs.size();
19610b57cec5SDimitry Andric   relrRelocs.clear();
19620b57cec5SDimitry Andric 
19630b57cec5SDimitry Andric   // Same as Config->Wordsize but faster because this is a compile-time
19640b57cec5SDimitry Andric   // constant.
19650b57cec5SDimitry Andric   const size_t wordsize = sizeof(typename ELFT::uint);
19660b57cec5SDimitry Andric 
19670b57cec5SDimitry Andric   // Number of bits to use for the relocation offsets bitmap.
19680b57cec5SDimitry Andric   // Must be either 63 or 31.
19690b57cec5SDimitry Andric   const size_t nBits = wordsize * 8 - 1;
19700b57cec5SDimitry Andric 
19710b57cec5SDimitry Andric   // Get offsets for all relative relocations and sort them.
19720b57cec5SDimitry Andric   std::vector<uint64_t> offsets;
19730b57cec5SDimitry Andric   for (const RelativeReloc &rel : relocs)
19740b57cec5SDimitry Andric     offsets.push_back(rel.getOffset());
19750b57cec5SDimitry Andric   llvm::sort(offsets);
19760b57cec5SDimitry Andric 
19770b57cec5SDimitry Andric   // For each leading relocation, find following ones that can be folded
19780b57cec5SDimitry Andric   // as a bitmap and fold them.
19790b57cec5SDimitry Andric   for (size_t i = 0, e = offsets.size(); i < e;) {
19800b57cec5SDimitry Andric     // Add a leading relocation.
19810b57cec5SDimitry Andric     relrRelocs.push_back(Elf_Relr(offsets[i]));
19820b57cec5SDimitry Andric     uint64_t base = offsets[i] + wordsize;
19830b57cec5SDimitry Andric     ++i;
19840b57cec5SDimitry Andric 
19850b57cec5SDimitry Andric     // Find foldable relocations to construct bitmaps.
19860b57cec5SDimitry Andric     while (i < e) {
19870b57cec5SDimitry Andric       uint64_t bitmap = 0;
19880b57cec5SDimitry Andric 
19890b57cec5SDimitry Andric       while (i < e) {
19900b57cec5SDimitry Andric         uint64_t delta = offsets[i] - base;
19910b57cec5SDimitry Andric 
19920b57cec5SDimitry Andric         // If it is too far, it cannot be folded.
19930b57cec5SDimitry Andric         if (delta >= nBits * wordsize)
19940b57cec5SDimitry Andric           break;
19950b57cec5SDimitry Andric 
19960b57cec5SDimitry Andric         // If it is not a multiple of wordsize away, it cannot be folded.
19970b57cec5SDimitry Andric         if (delta % wordsize)
19980b57cec5SDimitry Andric           break;
19990b57cec5SDimitry Andric 
20000b57cec5SDimitry Andric         // Fold it.
20010b57cec5SDimitry Andric         bitmap |= 1ULL << (delta / wordsize);
20020b57cec5SDimitry Andric         ++i;
20030b57cec5SDimitry Andric       }
20040b57cec5SDimitry Andric 
20050b57cec5SDimitry Andric       if (!bitmap)
20060b57cec5SDimitry Andric         break;
20070b57cec5SDimitry Andric 
20080b57cec5SDimitry Andric       relrRelocs.push_back(Elf_Relr((bitmap << 1) | 1));
20090b57cec5SDimitry Andric       base += nBits * wordsize;
20100b57cec5SDimitry Andric     }
20110b57cec5SDimitry Andric   }
20120b57cec5SDimitry Andric 
201385868e8aSDimitry Andric   // Don't allow the section to shrink; otherwise the size of the section can
201485868e8aSDimitry Andric   // oscillate infinitely. Trailing 1s do not decode to more relocations.
201585868e8aSDimitry Andric   if (relrRelocs.size() < oldSize) {
201685868e8aSDimitry Andric     log(".relr.dyn needs " + Twine(oldSize - relrRelocs.size()) +
201785868e8aSDimitry Andric         " padding word(s)");
201885868e8aSDimitry Andric     relrRelocs.resize(oldSize, Elf_Relr(1));
201985868e8aSDimitry Andric   }
202085868e8aSDimitry Andric 
20210b57cec5SDimitry Andric   return relrRelocs.size() != oldSize;
20220b57cec5SDimitry Andric }
20230b57cec5SDimitry Andric 
20240b57cec5SDimitry Andric SymbolTableBaseSection::SymbolTableBaseSection(StringTableSection &strTabSec)
20250b57cec5SDimitry Andric     : SyntheticSection(strTabSec.isDynamic() ? (uint64_t)SHF_ALLOC : 0,
20260b57cec5SDimitry Andric                        strTabSec.isDynamic() ? SHT_DYNSYM : SHT_SYMTAB,
20270b57cec5SDimitry Andric                        config->wordsize,
20280b57cec5SDimitry Andric                        strTabSec.isDynamic() ? ".dynsym" : ".symtab"),
20290b57cec5SDimitry Andric       strTabSec(strTabSec) {}
20300b57cec5SDimitry Andric 
20310b57cec5SDimitry Andric // Orders symbols according to their positions in the GOT,
20320b57cec5SDimitry Andric // in compliance with MIPS ABI rules.
20330b57cec5SDimitry Andric // See "Global Offset Table" in Chapter 5 in the following document
20340b57cec5SDimitry Andric // for detailed description:
20350b57cec5SDimitry Andric // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
20360b57cec5SDimitry Andric static bool sortMipsSymbols(const SymbolTableEntry &l,
20370b57cec5SDimitry Andric                             const SymbolTableEntry &r) {
20380b57cec5SDimitry Andric   // Sort entries related to non-local preemptible symbols by GOT indexes.
20390b57cec5SDimitry Andric   // All other entries go to the beginning of a dynsym in arbitrary order.
20400b57cec5SDimitry Andric   if (l.sym->isInGot() && r.sym->isInGot())
20410b57cec5SDimitry Andric     return l.sym->gotIndex < r.sym->gotIndex;
20420b57cec5SDimitry Andric   if (!l.sym->isInGot() && !r.sym->isInGot())
20430b57cec5SDimitry Andric     return false;
20440b57cec5SDimitry Andric   return !l.sym->isInGot();
20450b57cec5SDimitry Andric }
20460b57cec5SDimitry Andric 
20470b57cec5SDimitry Andric void SymbolTableBaseSection::finalizeContents() {
20480b57cec5SDimitry Andric   if (OutputSection *sec = strTabSec.getParent())
20490b57cec5SDimitry Andric     getParent()->link = sec->sectionIndex;
20500b57cec5SDimitry Andric 
20510b57cec5SDimitry Andric   if (this->type != SHT_DYNSYM) {
20520b57cec5SDimitry Andric     sortSymTabSymbols();
20530b57cec5SDimitry Andric     return;
20540b57cec5SDimitry Andric   }
20550b57cec5SDimitry Andric 
20560b57cec5SDimitry Andric   // If it is a .dynsym, there should be no local symbols, but we need
20570b57cec5SDimitry Andric   // to do a few things for the dynamic linker.
20580b57cec5SDimitry Andric 
20590b57cec5SDimitry Andric   // Section's Info field has the index of the first non-local symbol.
20600b57cec5SDimitry Andric   // Because the first symbol entry is a null entry, 1 is the first.
20610b57cec5SDimitry Andric   getParent()->info = 1;
20620b57cec5SDimitry Andric 
20630b57cec5SDimitry Andric   if (getPartition().gnuHashTab) {
20640b57cec5SDimitry Andric     // NB: It also sorts Symbols to meet the GNU hash table requirements.
20650b57cec5SDimitry Andric     getPartition().gnuHashTab->addSymbols(symbols);
20660b57cec5SDimitry Andric   } else if (config->emachine == EM_MIPS) {
20670b57cec5SDimitry Andric     llvm::stable_sort(symbols, sortMipsSymbols);
20680b57cec5SDimitry Andric   }
20690b57cec5SDimitry Andric 
20700b57cec5SDimitry Andric   // Only the main partition's dynsym indexes are stored in the symbols
20710b57cec5SDimitry Andric   // themselves. All other partitions use a lookup table.
20720b57cec5SDimitry Andric   if (this == mainPart->dynSymTab) {
20730b57cec5SDimitry Andric     size_t i = 0;
20740b57cec5SDimitry Andric     for (const SymbolTableEntry &s : symbols)
20750b57cec5SDimitry Andric       s.sym->dynsymIndex = ++i;
20760b57cec5SDimitry Andric   }
20770b57cec5SDimitry Andric }
20780b57cec5SDimitry Andric 
20790b57cec5SDimitry Andric // The ELF spec requires that all local symbols precede global symbols, so we
20800b57cec5SDimitry Andric // sort symbol entries in this function. (For .dynsym, we don't do that because
20810b57cec5SDimitry Andric // symbols for dynamic linking are inherently all globals.)
20820b57cec5SDimitry Andric //
20830b57cec5SDimitry Andric // Aside from above, we put local symbols in groups starting with the STT_FILE
20840b57cec5SDimitry Andric // symbol. That is convenient for purpose of identifying where are local symbols
20850b57cec5SDimitry Andric // coming from.
20860b57cec5SDimitry Andric void SymbolTableBaseSection::sortSymTabSymbols() {
20870b57cec5SDimitry Andric   // Move all local symbols before global symbols.
20880b57cec5SDimitry Andric   auto e = std::stable_partition(
20890b57cec5SDimitry Andric       symbols.begin(), symbols.end(), [](const SymbolTableEntry &s) {
20900b57cec5SDimitry Andric         return s.sym->isLocal() || s.sym->computeBinding() == STB_LOCAL;
20910b57cec5SDimitry Andric       });
20920b57cec5SDimitry Andric   size_t numLocals = e - symbols.begin();
20930b57cec5SDimitry Andric   getParent()->info = numLocals + 1;
20940b57cec5SDimitry Andric 
20950b57cec5SDimitry Andric   // We want to group the local symbols by file. For that we rebuild the local
20960b57cec5SDimitry Andric   // part of the symbols vector. We do not need to care about the STT_FILE
20970b57cec5SDimitry Andric   // symbols, they are already naturally placed first in each group. That
20980b57cec5SDimitry Andric   // happens because STT_FILE is always the first symbol in the object and hence
20990b57cec5SDimitry Andric   // precede all other local symbols we add for a file.
21000b57cec5SDimitry Andric   MapVector<InputFile *, std::vector<SymbolTableEntry>> arr;
21010b57cec5SDimitry Andric   for (const SymbolTableEntry &s : llvm::make_range(symbols.begin(), e))
21020b57cec5SDimitry Andric     arr[s.sym->file].push_back(s);
21030b57cec5SDimitry Andric 
21040b57cec5SDimitry Andric   auto i = symbols.begin();
21050b57cec5SDimitry Andric   for (std::pair<InputFile *, std::vector<SymbolTableEntry>> &p : arr)
21060b57cec5SDimitry Andric     for (SymbolTableEntry &entry : p.second)
21070b57cec5SDimitry Andric       *i++ = entry;
21080b57cec5SDimitry Andric }
21090b57cec5SDimitry Andric 
21100b57cec5SDimitry Andric void SymbolTableBaseSection::addSymbol(Symbol *b) {
21110b57cec5SDimitry Andric   // Adding a local symbol to a .dynsym is a bug.
21120b57cec5SDimitry Andric   assert(this->type != SHT_DYNSYM || !b->isLocal());
21130b57cec5SDimitry Andric 
21140b57cec5SDimitry Andric   bool hashIt = b->isLocal();
21150b57cec5SDimitry Andric   symbols.push_back({b, strTabSec.addString(b->getName(), hashIt)});
21160b57cec5SDimitry Andric }
21170b57cec5SDimitry Andric 
21180b57cec5SDimitry Andric size_t SymbolTableBaseSection::getSymbolIndex(Symbol *sym) {
21190b57cec5SDimitry Andric   if (this == mainPart->dynSymTab)
21200b57cec5SDimitry Andric     return sym->dynsymIndex;
21210b57cec5SDimitry Andric 
21220b57cec5SDimitry Andric   // Initializes symbol lookup tables lazily. This is used only for -r,
21230b57cec5SDimitry Andric   // -emit-relocs and dynsyms in partitions other than the main one.
21240b57cec5SDimitry Andric   llvm::call_once(onceFlag, [&] {
21250b57cec5SDimitry Andric     symbolIndexMap.reserve(symbols.size());
21260b57cec5SDimitry Andric     size_t i = 0;
21270b57cec5SDimitry Andric     for (const SymbolTableEntry &e : symbols) {
21280b57cec5SDimitry Andric       if (e.sym->type == STT_SECTION)
21290b57cec5SDimitry Andric         sectionIndexMap[e.sym->getOutputSection()] = ++i;
21300b57cec5SDimitry Andric       else
21310b57cec5SDimitry Andric         symbolIndexMap[e.sym] = ++i;
21320b57cec5SDimitry Andric     }
21330b57cec5SDimitry Andric   });
21340b57cec5SDimitry Andric 
21350b57cec5SDimitry Andric   // Section symbols are mapped based on their output sections
21360b57cec5SDimitry Andric   // to maintain their semantics.
21370b57cec5SDimitry Andric   if (sym->type == STT_SECTION)
21380b57cec5SDimitry Andric     return sectionIndexMap.lookup(sym->getOutputSection());
21390b57cec5SDimitry Andric   return symbolIndexMap.lookup(sym);
21400b57cec5SDimitry Andric }
21410b57cec5SDimitry Andric 
21420b57cec5SDimitry Andric template <class ELFT>
21430b57cec5SDimitry Andric SymbolTableSection<ELFT>::SymbolTableSection(StringTableSection &strTabSec)
21440b57cec5SDimitry Andric     : SymbolTableBaseSection(strTabSec) {
21450b57cec5SDimitry Andric   this->entsize = sizeof(Elf_Sym);
21460b57cec5SDimitry Andric }
21470b57cec5SDimitry Andric 
21480b57cec5SDimitry Andric static BssSection *getCommonSec(Symbol *sym) {
21490b57cec5SDimitry Andric   if (!config->defineCommon)
21500b57cec5SDimitry Andric     if (auto *d = dyn_cast<Defined>(sym))
21510b57cec5SDimitry Andric       return dyn_cast_or_null<BssSection>(d->section);
21520b57cec5SDimitry Andric   return nullptr;
21530b57cec5SDimitry Andric }
21540b57cec5SDimitry Andric 
21550b57cec5SDimitry Andric static uint32_t getSymSectionIndex(Symbol *sym) {
21560b57cec5SDimitry Andric   if (getCommonSec(sym))
21570b57cec5SDimitry Andric     return SHN_COMMON;
21580b57cec5SDimitry Andric   if (!isa<Defined>(sym) || sym->needsPltAddr)
21590b57cec5SDimitry Andric     return SHN_UNDEF;
21600b57cec5SDimitry Andric   if (const OutputSection *os = sym->getOutputSection())
21610b57cec5SDimitry Andric     return os->sectionIndex >= SHN_LORESERVE ? (uint32_t)SHN_XINDEX
21620b57cec5SDimitry Andric                                              : os->sectionIndex;
21630b57cec5SDimitry Andric   return SHN_ABS;
21640b57cec5SDimitry Andric }
21650b57cec5SDimitry Andric 
21660b57cec5SDimitry Andric // Write the internal symbol table contents to the output symbol table.
21670b57cec5SDimitry Andric template <class ELFT> void SymbolTableSection<ELFT>::writeTo(uint8_t *buf) {
21680b57cec5SDimitry Andric   // The first entry is a null entry as per the ELF spec.
21690b57cec5SDimitry Andric   memset(buf, 0, sizeof(Elf_Sym));
21700b57cec5SDimitry Andric   buf += sizeof(Elf_Sym);
21710b57cec5SDimitry Andric 
21720b57cec5SDimitry Andric   auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
21730b57cec5SDimitry Andric 
21740b57cec5SDimitry Andric   for (SymbolTableEntry &ent : symbols) {
21750b57cec5SDimitry Andric     Symbol *sym = ent.sym;
21760b57cec5SDimitry Andric     bool isDefinedHere = type == SHT_SYMTAB || sym->partition == partition;
21770b57cec5SDimitry Andric 
21780b57cec5SDimitry Andric     // Set st_info and st_other.
21790b57cec5SDimitry Andric     eSym->st_other = 0;
21800b57cec5SDimitry Andric     if (sym->isLocal()) {
21810b57cec5SDimitry Andric       eSym->setBindingAndType(STB_LOCAL, sym->type);
21820b57cec5SDimitry Andric     } else {
21830b57cec5SDimitry Andric       eSym->setBindingAndType(sym->computeBinding(), sym->type);
21840b57cec5SDimitry Andric       eSym->setVisibility(sym->visibility);
21850b57cec5SDimitry Andric     }
21860b57cec5SDimitry Andric 
21870b57cec5SDimitry Andric     // The 3 most significant bits of st_other are used by OpenPOWER ABI.
21880b57cec5SDimitry Andric     // See getPPC64GlobalEntryToLocalEntryOffset() for more details.
21890b57cec5SDimitry Andric     if (config->emachine == EM_PPC64)
21900b57cec5SDimitry Andric       eSym->st_other |= sym->stOther & 0xe0;
2191e8d8bef9SDimitry Andric     // The most significant bit of st_other is used by AArch64 ABI for the
2192e8d8bef9SDimitry Andric     // variant PCS.
2193e8d8bef9SDimitry Andric     else if (config->emachine == EM_AARCH64)
2194e8d8bef9SDimitry Andric       eSym->st_other |= sym->stOther & STO_AARCH64_VARIANT_PCS;
21950b57cec5SDimitry Andric 
21960b57cec5SDimitry Andric     eSym->st_name = ent.strTabOffset;
21970b57cec5SDimitry Andric     if (isDefinedHere)
21980b57cec5SDimitry Andric       eSym->st_shndx = getSymSectionIndex(ent.sym);
21990b57cec5SDimitry Andric     else
22000b57cec5SDimitry Andric       eSym->st_shndx = 0;
22010b57cec5SDimitry Andric 
22020b57cec5SDimitry Andric     // Copy symbol size if it is a defined symbol. st_size is not significant
22030b57cec5SDimitry Andric     // for undefined symbols, so whether copying it or not is up to us if that's
22040b57cec5SDimitry Andric     // the case. We'll leave it as zero because by not setting a value, we can
22050b57cec5SDimitry Andric     // get the exact same outputs for two sets of input files that differ only
22060b57cec5SDimitry Andric     // in undefined symbol size in DSOs.
22070b57cec5SDimitry Andric     if (eSym->st_shndx == SHN_UNDEF || !isDefinedHere)
22080b57cec5SDimitry Andric       eSym->st_size = 0;
22090b57cec5SDimitry Andric     else
22100b57cec5SDimitry Andric       eSym->st_size = sym->getSize();
22110b57cec5SDimitry Andric 
2212e8d8bef9SDimitry Andric     // st_value is usually an address of a symbol, but that has a special
2213e8d8bef9SDimitry Andric     // meaning for uninstantiated common symbols (--no-define-common).
22140b57cec5SDimitry Andric     if (BssSection *commonSec = getCommonSec(ent.sym))
22150b57cec5SDimitry Andric       eSym->st_value = commonSec->alignment;
22160b57cec5SDimitry Andric     else if (isDefinedHere)
22170b57cec5SDimitry Andric       eSym->st_value = sym->getVA();
22180b57cec5SDimitry Andric     else
22190b57cec5SDimitry Andric       eSym->st_value = 0;
22200b57cec5SDimitry Andric 
22210b57cec5SDimitry Andric     ++eSym;
22220b57cec5SDimitry Andric   }
22230b57cec5SDimitry Andric 
22240b57cec5SDimitry Andric   // On MIPS we need to mark symbol which has a PLT entry and requires
22250b57cec5SDimitry Andric   // pointer equality by STO_MIPS_PLT flag. That is necessary to help
22260b57cec5SDimitry Andric   // dynamic linker distinguish such symbols and MIPS lazy-binding stubs.
22270b57cec5SDimitry Andric   // https://sourceware.org/ml/binutils/2008-07/txt00000.txt
22280b57cec5SDimitry Andric   if (config->emachine == EM_MIPS) {
22290b57cec5SDimitry Andric     auto *eSym = reinterpret_cast<Elf_Sym *>(buf);
22300b57cec5SDimitry Andric 
22310b57cec5SDimitry Andric     for (SymbolTableEntry &ent : symbols) {
22320b57cec5SDimitry Andric       Symbol *sym = ent.sym;
22330b57cec5SDimitry Andric       if (sym->isInPlt() && sym->needsPltAddr)
22340b57cec5SDimitry Andric         eSym->st_other |= STO_MIPS_PLT;
22350b57cec5SDimitry Andric       if (isMicroMips()) {
22360b57cec5SDimitry Andric         // We already set the less-significant bit for symbols
22370b57cec5SDimitry Andric         // marked by the `STO_MIPS_MICROMIPS` flag and for microMIPS PLT
22380b57cec5SDimitry Andric         // records. That allows us to distinguish such symbols in
22395ffd83dbSDimitry Andric         // the `MIPS<ELFT>::relocate()` routine. Now we should
22400b57cec5SDimitry Andric         // clear that bit for non-dynamic symbol table, so tools
22410b57cec5SDimitry Andric         // like `objdump` will be able to deal with a correct
22420b57cec5SDimitry Andric         // symbol position.
22430b57cec5SDimitry Andric         if (sym->isDefined() &&
22440b57cec5SDimitry Andric             ((sym->stOther & STO_MIPS_MICROMIPS) || sym->needsPltAddr)) {
22450b57cec5SDimitry Andric           if (!strTabSec.isDynamic())
22460b57cec5SDimitry Andric             eSym->st_value &= ~1;
22470b57cec5SDimitry Andric           eSym->st_other |= STO_MIPS_MICROMIPS;
22480b57cec5SDimitry Andric         }
22490b57cec5SDimitry Andric       }
22500b57cec5SDimitry Andric       if (config->relocatable)
22510b57cec5SDimitry Andric         if (auto *d = dyn_cast<Defined>(sym))
22520b57cec5SDimitry Andric           if (isMipsPIC<ELFT>(d))
22530b57cec5SDimitry Andric             eSym->st_other |= STO_MIPS_PIC;
22540b57cec5SDimitry Andric       ++eSym;
22550b57cec5SDimitry Andric     }
22560b57cec5SDimitry Andric   }
22570b57cec5SDimitry Andric }
22580b57cec5SDimitry Andric 
22590b57cec5SDimitry Andric SymtabShndxSection::SymtabShndxSection()
22600b57cec5SDimitry Andric     : SyntheticSection(0, SHT_SYMTAB_SHNDX, 4, ".symtab_shndx") {
22610b57cec5SDimitry Andric   this->entsize = 4;
22620b57cec5SDimitry Andric }
22630b57cec5SDimitry Andric 
22640b57cec5SDimitry Andric void SymtabShndxSection::writeTo(uint8_t *buf) {
22650b57cec5SDimitry Andric   // We write an array of 32 bit values, where each value has 1:1 association
22660b57cec5SDimitry Andric   // with an entry in .symtab. If the corresponding entry contains SHN_XINDEX,
22670b57cec5SDimitry Andric   // we need to write actual index, otherwise, we must write SHN_UNDEF(0).
22680b57cec5SDimitry Andric   buf += 4; // Ignore .symtab[0] entry.
22690b57cec5SDimitry Andric   for (const SymbolTableEntry &entry : in.symTab->getSymbols()) {
22700b57cec5SDimitry Andric     if (getSymSectionIndex(entry.sym) == SHN_XINDEX)
22710b57cec5SDimitry Andric       write32(buf, entry.sym->getOutputSection()->sectionIndex);
22720b57cec5SDimitry Andric     buf += 4;
22730b57cec5SDimitry Andric   }
22740b57cec5SDimitry Andric }
22750b57cec5SDimitry Andric 
22760b57cec5SDimitry Andric bool SymtabShndxSection::isNeeded() const {
22770b57cec5SDimitry Andric   // SHT_SYMTAB can hold symbols with section indices values up to
22780b57cec5SDimitry Andric   // SHN_LORESERVE. If we need more, we want to use extension SHT_SYMTAB_SHNDX
22790b57cec5SDimitry Andric   // section. Problem is that we reveal the final section indices a bit too
22800b57cec5SDimitry Andric   // late, and we do not know them here. For simplicity, we just always create
22810b57cec5SDimitry Andric   // a .symtab_shndx section when the amount of output sections is huge.
22820b57cec5SDimitry Andric   size_t size = 0;
22830b57cec5SDimitry Andric   for (BaseCommand *base : script->sectionCommands)
22840b57cec5SDimitry Andric     if (isa<OutputSection>(base))
22850b57cec5SDimitry Andric       ++size;
22860b57cec5SDimitry Andric   return size >= SHN_LORESERVE;
22870b57cec5SDimitry Andric }
22880b57cec5SDimitry Andric 
22890b57cec5SDimitry Andric void SymtabShndxSection::finalizeContents() {
22900b57cec5SDimitry Andric   getParent()->link = in.symTab->getParent()->sectionIndex;
22910b57cec5SDimitry Andric }
22920b57cec5SDimitry Andric 
22930b57cec5SDimitry Andric size_t SymtabShndxSection::getSize() const {
22940b57cec5SDimitry Andric   return in.symTab->getNumSymbols() * 4;
22950b57cec5SDimitry Andric }
22960b57cec5SDimitry Andric 
22970b57cec5SDimitry Andric // .hash and .gnu.hash sections contain on-disk hash tables that map
22980b57cec5SDimitry Andric // symbol names to their dynamic symbol table indices. Their purpose
22990b57cec5SDimitry Andric // is to help the dynamic linker resolve symbols quickly. If ELF files
23000b57cec5SDimitry Andric // don't have them, the dynamic linker has to do linear search on all
23010b57cec5SDimitry Andric // dynamic symbols, which makes programs slower. Therefore, a .hash
23020b57cec5SDimitry Andric // section is added to a DSO by default. A .gnu.hash is added if you
23030b57cec5SDimitry Andric // give the -hash-style=gnu or -hash-style=both option.
23040b57cec5SDimitry Andric //
23050b57cec5SDimitry Andric // The Unix semantics of resolving dynamic symbols is somewhat expensive.
23060b57cec5SDimitry Andric // Each ELF file has a list of DSOs that the ELF file depends on and a
23070b57cec5SDimitry Andric // list of dynamic symbols that need to be resolved from any of the
23080b57cec5SDimitry Andric // DSOs. That means resolving all dynamic symbols takes O(m)*O(n)
23090b57cec5SDimitry Andric // where m is the number of DSOs and n is the number of dynamic
23100b57cec5SDimitry Andric // symbols. For modern large programs, both m and n are large.  So
23115ffd83dbSDimitry Andric // making each step faster by using hash tables substantially
23120b57cec5SDimitry Andric // improves time to load programs.
23130b57cec5SDimitry Andric //
23140b57cec5SDimitry Andric // (Note that this is not the only way to design the shared library.
23150b57cec5SDimitry Andric // For instance, the Windows DLL takes a different approach. On
23160b57cec5SDimitry Andric // Windows, each dynamic symbol has a name of DLL from which the symbol
23170b57cec5SDimitry Andric // has to be resolved. That makes the cost of symbol resolution O(n).
23180b57cec5SDimitry Andric // This disables some hacky techniques you can use on Unix such as
23190b57cec5SDimitry Andric // LD_PRELOAD, but this is arguably better semantics than the Unix ones.)
23200b57cec5SDimitry Andric //
23210b57cec5SDimitry Andric // Due to historical reasons, we have two different hash tables, .hash
23220b57cec5SDimitry Andric // and .gnu.hash. They are for the same purpose, and .gnu.hash is a new
23230b57cec5SDimitry Andric // and better version of .hash. .hash is just an on-disk hash table, but
23240b57cec5SDimitry Andric // .gnu.hash has a bloom filter in addition to a hash table to skip
23250b57cec5SDimitry Andric // DSOs very quickly. If you are sure that your dynamic linker knows
23260b57cec5SDimitry Andric // about .gnu.hash, you want to specify -hash-style=gnu. Otherwise, a
2327480093f4SDimitry Andric // safe bet is to specify -hash-style=both for backward compatibility.
23280b57cec5SDimitry Andric GnuHashTableSection::GnuHashTableSection()
23290b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_GNU_HASH, config->wordsize, ".gnu.hash") {
23300b57cec5SDimitry Andric }
23310b57cec5SDimitry Andric 
23320b57cec5SDimitry Andric void GnuHashTableSection::finalizeContents() {
23330b57cec5SDimitry Andric   if (OutputSection *sec = getPartition().dynSymTab->getParent())
23340b57cec5SDimitry Andric     getParent()->link = sec->sectionIndex;
23350b57cec5SDimitry Andric 
23360b57cec5SDimitry Andric   // Computes bloom filter size in word size. We want to allocate 12
23370b57cec5SDimitry Andric   // bits for each symbol. It must be a power of two.
23380b57cec5SDimitry Andric   if (symbols.empty()) {
23390b57cec5SDimitry Andric     maskWords = 1;
23400b57cec5SDimitry Andric   } else {
23410b57cec5SDimitry Andric     uint64_t numBits = symbols.size() * 12;
23420b57cec5SDimitry Andric     maskWords = NextPowerOf2(numBits / (config->wordsize * 8));
23430b57cec5SDimitry Andric   }
23440b57cec5SDimitry Andric 
23450b57cec5SDimitry Andric   size = 16;                            // Header
23460b57cec5SDimitry Andric   size += config->wordsize * maskWords; // Bloom filter
23470b57cec5SDimitry Andric   size += nBuckets * 4;                 // Hash buckets
23480b57cec5SDimitry Andric   size += symbols.size() * 4;           // Hash values
23490b57cec5SDimitry Andric }
23500b57cec5SDimitry Andric 
23510b57cec5SDimitry Andric void GnuHashTableSection::writeTo(uint8_t *buf) {
23520b57cec5SDimitry Andric   // The output buffer is not guaranteed to be zero-cleared because we pre-
23530b57cec5SDimitry Andric   // fill executable sections with trap instructions. This is a precaution
23540b57cec5SDimitry Andric   // for that case, which happens only when -no-rosegment is given.
23550b57cec5SDimitry Andric   memset(buf, 0, size);
23560b57cec5SDimitry Andric 
23570b57cec5SDimitry Andric   // Write a header.
23580b57cec5SDimitry Andric   write32(buf, nBuckets);
23590b57cec5SDimitry Andric   write32(buf + 4, getPartition().dynSymTab->getNumSymbols() - symbols.size());
23600b57cec5SDimitry Andric   write32(buf + 8, maskWords);
23610b57cec5SDimitry Andric   write32(buf + 12, Shift2);
23620b57cec5SDimitry Andric   buf += 16;
23630b57cec5SDimitry Andric 
23640b57cec5SDimitry Andric   // Write a bloom filter and a hash table.
23650b57cec5SDimitry Andric   writeBloomFilter(buf);
23660b57cec5SDimitry Andric   buf += config->wordsize * maskWords;
23670b57cec5SDimitry Andric   writeHashTable(buf);
23680b57cec5SDimitry Andric }
23690b57cec5SDimitry Andric 
23700b57cec5SDimitry Andric // This function writes a 2-bit bloom filter. This bloom filter alone
23710b57cec5SDimitry Andric // usually filters out 80% or more of all symbol lookups [1].
23720b57cec5SDimitry Andric // The dynamic linker uses the hash table only when a symbol is not
23730b57cec5SDimitry Andric // filtered out by a bloom filter.
23740b57cec5SDimitry Andric //
23750b57cec5SDimitry Andric // [1] Ulrich Drepper (2011), "How To Write Shared Libraries" (Ver. 4.1.2),
23760b57cec5SDimitry Andric //     p.9, https://www.akkadia.org/drepper/dsohowto.pdf
23770b57cec5SDimitry Andric void GnuHashTableSection::writeBloomFilter(uint8_t *buf) {
23780b57cec5SDimitry Andric   unsigned c = config->is64 ? 64 : 32;
23790b57cec5SDimitry Andric   for (const Entry &sym : symbols) {
23800b57cec5SDimitry Andric     // When C = 64, we choose a word with bits [6:...] and set 1 to two bits in
23810b57cec5SDimitry Andric     // the word using bits [0:5] and [26:31].
23820b57cec5SDimitry Andric     size_t i = (sym.hash / c) & (maskWords - 1);
23830b57cec5SDimitry Andric     uint64_t val = readUint(buf + i * config->wordsize);
23840b57cec5SDimitry Andric     val |= uint64_t(1) << (sym.hash % c);
23850b57cec5SDimitry Andric     val |= uint64_t(1) << ((sym.hash >> Shift2) % c);
23860b57cec5SDimitry Andric     writeUint(buf + i * config->wordsize, val);
23870b57cec5SDimitry Andric   }
23880b57cec5SDimitry Andric }
23890b57cec5SDimitry Andric 
23900b57cec5SDimitry Andric void GnuHashTableSection::writeHashTable(uint8_t *buf) {
23910b57cec5SDimitry Andric   uint32_t *buckets = reinterpret_cast<uint32_t *>(buf);
23920b57cec5SDimitry Andric   uint32_t oldBucket = -1;
23930b57cec5SDimitry Andric   uint32_t *values = buckets + nBuckets;
23940b57cec5SDimitry Andric   for (auto i = symbols.begin(), e = symbols.end(); i != e; ++i) {
23950b57cec5SDimitry Andric     // Write a hash value. It represents a sequence of chains that share the
23960b57cec5SDimitry Andric     // same hash modulo value. The last element of each chain is terminated by
23970b57cec5SDimitry Andric     // LSB 1.
23980b57cec5SDimitry Andric     uint32_t hash = i->hash;
23990b57cec5SDimitry Andric     bool isLastInChain = (i + 1) == e || i->bucketIdx != (i + 1)->bucketIdx;
24000b57cec5SDimitry Andric     hash = isLastInChain ? hash | 1 : hash & ~1;
24010b57cec5SDimitry Andric     write32(values++, hash);
24020b57cec5SDimitry Andric 
24030b57cec5SDimitry Andric     if (i->bucketIdx == oldBucket)
24040b57cec5SDimitry Andric       continue;
24050b57cec5SDimitry Andric     // Write a hash bucket. Hash buckets contain indices in the following hash
24060b57cec5SDimitry Andric     // value table.
24070b57cec5SDimitry Andric     write32(buckets + i->bucketIdx,
24080b57cec5SDimitry Andric             getPartition().dynSymTab->getSymbolIndex(i->sym));
24090b57cec5SDimitry Andric     oldBucket = i->bucketIdx;
24100b57cec5SDimitry Andric   }
24110b57cec5SDimitry Andric }
24120b57cec5SDimitry Andric 
24130b57cec5SDimitry Andric static uint32_t hashGnu(StringRef name) {
24140b57cec5SDimitry Andric   uint32_t h = 5381;
24150b57cec5SDimitry Andric   for (uint8_t c : name)
24160b57cec5SDimitry Andric     h = (h << 5) + h + c;
24170b57cec5SDimitry Andric   return h;
24180b57cec5SDimitry Andric }
24190b57cec5SDimitry Andric 
24200b57cec5SDimitry Andric // Add symbols to this symbol hash table. Note that this function
24210b57cec5SDimitry Andric // destructively sort a given vector -- which is needed because
24220b57cec5SDimitry Andric // GNU-style hash table places some sorting requirements.
24230b57cec5SDimitry Andric void GnuHashTableSection::addSymbols(std::vector<SymbolTableEntry> &v) {
24240b57cec5SDimitry Andric   // We cannot use 'auto' for Mid because GCC 6.1 cannot deduce
24250b57cec5SDimitry Andric   // its type correctly.
24260b57cec5SDimitry Andric   std::vector<SymbolTableEntry>::iterator mid =
24270b57cec5SDimitry Andric       std::stable_partition(v.begin(), v.end(), [&](const SymbolTableEntry &s) {
24280b57cec5SDimitry Andric         return !s.sym->isDefined() || s.sym->partition != partition;
24290b57cec5SDimitry Andric       });
24300b57cec5SDimitry Andric 
24310b57cec5SDimitry Andric   // We chose load factor 4 for the on-disk hash table. For each hash
24320b57cec5SDimitry Andric   // collision, the dynamic linker will compare a uint32_t hash value.
24330b57cec5SDimitry Andric   // Since the integer comparison is quite fast, we believe we can
24340b57cec5SDimitry Andric   // make the load factor even larger. 4 is just a conservative choice.
24350b57cec5SDimitry Andric   //
24360b57cec5SDimitry Andric   // Note that we don't want to create a zero-sized hash table because
24370b57cec5SDimitry Andric   // Android loader as of 2018 doesn't like a .gnu.hash containing such
24380b57cec5SDimitry Andric   // table. If that's the case, we create a hash table with one unused
24390b57cec5SDimitry Andric   // dummy slot.
24400b57cec5SDimitry Andric   nBuckets = std::max<size_t>((v.end() - mid) / 4, 1);
24410b57cec5SDimitry Andric 
24420b57cec5SDimitry Andric   if (mid == v.end())
24430b57cec5SDimitry Andric     return;
24440b57cec5SDimitry Andric 
24450b57cec5SDimitry Andric   for (SymbolTableEntry &ent : llvm::make_range(mid, v.end())) {
24460b57cec5SDimitry Andric     Symbol *b = ent.sym;
24470b57cec5SDimitry Andric     uint32_t hash = hashGnu(b->getName());
24480b57cec5SDimitry Andric     uint32_t bucketIdx = hash % nBuckets;
24490b57cec5SDimitry Andric     symbols.push_back({b, ent.strTabOffset, hash, bucketIdx});
24500b57cec5SDimitry Andric   }
24510b57cec5SDimitry Andric 
24520b57cec5SDimitry Andric   llvm::stable_sort(symbols, [](const Entry &l, const Entry &r) {
24530b57cec5SDimitry Andric     return l.bucketIdx < r.bucketIdx;
24540b57cec5SDimitry Andric   });
24550b57cec5SDimitry Andric 
24560b57cec5SDimitry Andric   v.erase(mid, v.end());
24570b57cec5SDimitry Andric   for (const Entry &ent : symbols)
24580b57cec5SDimitry Andric     v.push_back({ent.sym, ent.strTabOffset});
24590b57cec5SDimitry Andric }
24600b57cec5SDimitry Andric 
24610b57cec5SDimitry Andric HashTableSection::HashTableSection()
24620b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_HASH, 4, ".hash") {
24630b57cec5SDimitry Andric   this->entsize = 4;
24640b57cec5SDimitry Andric }
24650b57cec5SDimitry Andric 
24660b57cec5SDimitry Andric void HashTableSection::finalizeContents() {
24670b57cec5SDimitry Andric   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
24680b57cec5SDimitry Andric 
24690b57cec5SDimitry Andric   if (OutputSection *sec = symTab->getParent())
24700b57cec5SDimitry Andric     getParent()->link = sec->sectionIndex;
24710b57cec5SDimitry Andric 
24720b57cec5SDimitry Andric   unsigned numEntries = 2;               // nbucket and nchain.
24730b57cec5SDimitry Andric   numEntries += symTab->getNumSymbols(); // The chain entries.
24740b57cec5SDimitry Andric 
24750b57cec5SDimitry Andric   // Create as many buckets as there are symbols.
24760b57cec5SDimitry Andric   numEntries += symTab->getNumSymbols();
24770b57cec5SDimitry Andric   this->size = numEntries * 4;
24780b57cec5SDimitry Andric }
24790b57cec5SDimitry Andric 
24800b57cec5SDimitry Andric void HashTableSection::writeTo(uint8_t *buf) {
24810b57cec5SDimitry Andric   SymbolTableBaseSection *symTab = getPartition().dynSymTab;
24820b57cec5SDimitry Andric 
24830b57cec5SDimitry Andric   // See comment in GnuHashTableSection::writeTo.
24840b57cec5SDimitry Andric   memset(buf, 0, size);
24850b57cec5SDimitry Andric 
24860b57cec5SDimitry Andric   unsigned numSymbols = symTab->getNumSymbols();
24870b57cec5SDimitry Andric 
24880b57cec5SDimitry Andric   uint32_t *p = reinterpret_cast<uint32_t *>(buf);
24890b57cec5SDimitry Andric   write32(p++, numSymbols); // nbucket
24900b57cec5SDimitry Andric   write32(p++, numSymbols); // nchain
24910b57cec5SDimitry Andric 
24920b57cec5SDimitry Andric   uint32_t *buckets = p;
24930b57cec5SDimitry Andric   uint32_t *chains = p + numSymbols;
24940b57cec5SDimitry Andric 
24950b57cec5SDimitry Andric   for (const SymbolTableEntry &s : symTab->getSymbols()) {
24960b57cec5SDimitry Andric     Symbol *sym = s.sym;
24970b57cec5SDimitry Andric     StringRef name = sym->getName();
24980b57cec5SDimitry Andric     unsigned i = sym->dynsymIndex;
24990b57cec5SDimitry Andric     uint32_t hash = hashSysV(name) % numSymbols;
25000b57cec5SDimitry Andric     chains[i] = buckets[hash];
25010b57cec5SDimitry Andric     write32(buckets + hash, i);
25020b57cec5SDimitry Andric   }
25030b57cec5SDimitry Andric }
25040b57cec5SDimitry Andric 
2505480093f4SDimitry Andric PltSection::PltSection()
2506480093f4SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt"),
2507480093f4SDimitry Andric       headerSize(target->pltHeaderSize) {
2508480093f4SDimitry Andric   // On PowerPC, this section contains lazy symbol resolvers.
250992c0d181SDimitry Andric   if (config->emachine == EM_PPC64) {
2510480093f4SDimitry Andric     name = ".glink";
2511480093f4SDimitry Andric     alignment = 4;
2512480093f4SDimitry Andric   }
2513480093f4SDimitry Andric 
2514480093f4SDimitry Andric   // On x86 when IBT is enabled, this section contains the second PLT (lazy
2515480093f4SDimitry Andric   // symbol resolvers).
2516480093f4SDimitry Andric   if ((config->emachine == EM_386 || config->emachine == EM_X86_64) &&
2517480093f4SDimitry Andric       (config->andFeatures & GNU_PROPERTY_X86_FEATURE_1_IBT))
2518480093f4SDimitry Andric     name = ".plt.sec";
2519480093f4SDimitry Andric 
25200b57cec5SDimitry Andric   // The PLT needs to be writable on SPARC as the dynamic linker will
25210b57cec5SDimitry Andric   // modify the instructions in the PLT entries.
25220b57cec5SDimitry Andric   if (config->emachine == EM_SPARCV9)
25230b57cec5SDimitry Andric     this->flags |= SHF_WRITE;
25240b57cec5SDimitry Andric }
25250b57cec5SDimitry Andric 
25260b57cec5SDimitry Andric void PltSection::writeTo(uint8_t *buf) {
2527480093f4SDimitry Andric   // At beginning of PLT, we have code to call the dynamic
25280b57cec5SDimitry Andric   // linker to resolve dynsyms at runtime. Write such code.
25290b57cec5SDimitry Andric   target->writePltHeader(buf);
25300b57cec5SDimitry Andric   size_t off = headerSize;
25310b57cec5SDimitry Andric 
2532480093f4SDimitry Andric   for (const Symbol *sym : entries) {
2533480093f4SDimitry Andric     target->writePlt(buf + off, *sym, getVA() + off);
25340b57cec5SDimitry Andric     off += target->pltEntrySize;
25350b57cec5SDimitry Andric   }
25360b57cec5SDimitry Andric }
25370b57cec5SDimitry Andric 
2538480093f4SDimitry Andric void PltSection::addEntry(Symbol &sym) {
25390b57cec5SDimitry Andric   sym.pltIndex = entries.size();
25400b57cec5SDimitry Andric   entries.push_back(&sym);
25410b57cec5SDimitry Andric }
25420b57cec5SDimitry Andric 
25430b57cec5SDimitry Andric size_t PltSection::getSize() const {
254492c0d181SDimitry Andric   return headerSize + entries.size() * target->pltEntrySize;
25450b57cec5SDimitry Andric }
25460b57cec5SDimitry Andric 
2547480093f4SDimitry Andric bool PltSection::isNeeded() const {
2548480093f4SDimitry Andric   // For -z retpolineplt, .iplt needs the .plt header.
2549480093f4SDimitry Andric   return !entries.empty() || (config->zRetpolineplt && in.iplt->isNeeded());
2550480093f4SDimitry Andric }
2551480093f4SDimitry Andric 
2552480093f4SDimitry Andric // Used by ARM to add mapping symbols in the PLT section, which aid
2553480093f4SDimitry Andric // disassembly.
25540b57cec5SDimitry Andric void PltSection::addSymbols() {
25550b57cec5SDimitry Andric   target->addPltHeaderSymbols(*this);
25560b57cec5SDimitry Andric 
25570b57cec5SDimitry Andric   size_t off = headerSize;
25580b57cec5SDimitry Andric   for (size_t i = 0; i < entries.size(); ++i) {
25590b57cec5SDimitry Andric     target->addPltSymbols(*this, off);
25600b57cec5SDimitry Andric     off += target->pltEntrySize;
25610b57cec5SDimitry Andric   }
25620b57cec5SDimitry Andric }
25630b57cec5SDimitry Andric 
2564480093f4SDimitry Andric IpltSection::IpltSection()
2565480093f4SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".iplt") {
2566480093f4SDimitry Andric   if (config->emachine == EM_PPC || config->emachine == EM_PPC64) {
2567480093f4SDimitry Andric     name = ".glink";
2568480093f4SDimitry Andric     alignment = 4;
2569480093f4SDimitry Andric   }
2570480093f4SDimitry Andric }
2571480093f4SDimitry Andric 
2572480093f4SDimitry Andric void IpltSection::writeTo(uint8_t *buf) {
2573480093f4SDimitry Andric   uint32_t off = 0;
2574480093f4SDimitry Andric   for (const Symbol *sym : entries) {
2575480093f4SDimitry Andric     target->writeIplt(buf + off, *sym, getVA() + off);
2576480093f4SDimitry Andric     off += target->ipltEntrySize;
2577480093f4SDimitry Andric   }
2578480093f4SDimitry Andric }
2579480093f4SDimitry Andric 
2580480093f4SDimitry Andric size_t IpltSection::getSize() const {
2581480093f4SDimitry Andric   return entries.size() * target->ipltEntrySize;
2582480093f4SDimitry Andric }
2583480093f4SDimitry Andric 
2584480093f4SDimitry Andric void IpltSection::addEntry(Symbol &sym) {
2585480093f4SDimitry Andric   sym.pltIndex = entries.size();
2586480093f4SDimitry Andric   entries.push_back(&sym);
2587480093f4SDimitry Andric }
2588480093f4SDimitry Andric 
2589480093f4SDimitry Andric // ARM uses mapping symbols to aid disassembly.
2590480093f4SDimitry Andric void IpltSection::addSymbols() {
2591480093f4SDimitry Andric   size_t off = 0;
2592480093f4SDimitry Andric   for (size_t i = 0, e = entries.size(); i != e; ++i) {
2593480093f4SDimitry Andric     target->addPltSymbols(*this, off);
2594480093f4SDimitry Andric     off += target->pltEntrySize;
2595480093f4SDimitry Andric   }
2596480093f4SDimitry Andric }
2597480093f4SDimitry Andric 
259892c0d181SDimitry Andric PPC32GlinkSection::PPC32GlinkSection() {
259992c0d181SDimitry Andric   name = ".glink";
260092c0d181SDimitry Andric   alignment = 4;
260192c0d181SDimitry Andric }
260292c0d181SDimitry Andric 
260392c0d181SDimitry Andric void PPC32GlinkSection::writeTo(uint8_t *buf) {
260492c0d181SDimitry Andric   writePPC32GlinkSection(buf, entries.size());
260592c0d181SDimitry Andric }
260692c0d181SDimitry Andric 
260792c0d181SDimitry Andric size_t PPC32GlinkSection::getSize() const {
260892c0d181SDimitry Andric   return headerSize + entries.size() * target->pltEntrySize + footerSize;
260992c0d181SDimitry Andric }
261092c0d181SDimitry Andric 
2611480093f4SDimitry Andric // This is an x86-only extra PLT section and used only when a security
2612480093f4SDimitry Andric // enhancement feature called CET is enabled. In this comment, I'll explain what
2613480093f4SDimitry Andric // the feature is and why we have two PLT sections if CET is enabled.
2614480093f4SDimitry Andric //
2615480093f4SDimitry Andric // So, what does CET do? CET introduces a new restriction to indirect jump
2616480093f4SDimitry Andric // instructions. CET works this way. Assume that CET is enabled. Then, if you
2617480093f4SDimitry Andric // execute an indirect jump instruction, the processor verifies that a special
2618480093f4SDimitry Andric // "landing pad" instruction (which is actually a repurposed NOP instruction and
2619480093f4SDimitry Andric // now called "endbr32" or "endbr64") is at the jump target. If the jump target
2620480093f4SDimitry Andric // does not start with that instruction, the processor raises an exception
2621480093f4SDimitry Andric // instead of continuing executing code.
2622480093f4SDimitry Andric //
2623480093f4SDimitry Andric // If CET is enabled, the compiler emits endbr to all locations where indirect
2624480093f4SDimitry Andric // jumps may jump to.
2625480093f4SDimitry Andric //
2626480093f4SDimitry Andric // This mechanism makes it extremely hard to transfer the control to a middle of
2627480093f4SDimitry Andric // a function that is not supporsed to be a indirect jump target, preventing
2628480093f4SDimitry Andric // certain types of attacks such as ROP or JOP.
2629480093f4SDimitry Andric //
2630480093f4SDimitry Andric // Note that the processors in the market as of 2019 don't actually support the
2631480093f4SDimitry Andric // feature. Only the spec is available at the moment.
2632480093f4SDimitry Andric //
2633480093f4SDimitry Andric // Now, I'll explain why we have this extra PLT section for CET.
2634480093f4SDimitry Andric //
2635480093f4SDimitry Andric // Since you can indirectly jump to a PLT entry, we have to make PLT entries
2636480093f4SDimitry Andric // start with endbr. The problem is there's no extra space for endbr (which is 4
2637480093f4SDimitry Andric // bytes long), as the PLT entry is only 16 bytes long and all bytes are already
2638480093f4SDimitry Andric // used.
2639480093f4SDimitry Andric //
2640480093f4SDimitry Andric // In order to deal with the issue, we split a PLT entry into two PLT entries.
2641480093f4SDimitry Andric // Remember that each PLT entry contains code to jump to an address read from
2642480093f4SDimitry Andric // .got.plt AND code to resolve a dynamic symbol lazily. With the 2-PLT scheme,
2643480093f4SDimitry Andric // the former code is written to .plt.sec, and the latter code is written to
2644480093f4SDimitry Andric // .plt.
2645480093f4SDimitry Andric //
2646480093f4SDimitry Andric // Lazy symbol resolution in the 2-PLT scheme works in the usual way, except
2647480093f4SDimitry Andric // that the regular .plt is now called .plt.sec and .plt is repurposed to
2648480093f4SDimitry Andric // contain only code for lazy symbol resolution.
2649480093f4SDimitry Andric //
2650480093f4SDimitry Andric // In other words, this is how the 2-PLT scheme works. Application code is
2651480093f4SDimitry Andric // supposed to jump to .plt.sec to call an external function. Each .plt.sec
2652480093f4SDimitry Andric // entry contains code to read an address from a corresponding .got.plt entry
2653480093f4SDimitry Andric // and jump to that address. Addresses in .got.plt initially point to .plt, so
2654480093f4SDimitry Andric // when an application calls an external function for the first time, the
2655480093f4SDimitry Andric // control is transferred to a function that resolves a symbol name from
2656480093f4SDimitry Andric // external shared object files. That function then rewrites a .got.plt entry
2657480093f4SDimitry Andric // with a resolved address, so that the subsequent function calls directly jump
2658480093f4SDimitry Andric // to a desired location from .plt.sec.
2659480093f4SDimitry Andric //
2660480093f4SDimitry Andric // There is an open question as to whether the 2-PLT scheme was desirable or
2661480093f4SDimitry Andric // not. We could have simply extended the PLT entry size to 32-bytes to
2662480093f4SDimitry Andric // accommodate endbr, and that scheme would have been much simpler than the
2663480093f4SDimitry Andric // 2-PLT scheme. One reason to split PLT was, by doing that, we could keep hot
2664480093f4SDimitry Andric // code (.plt.sec) from cold code (.plt). But as far as I know no one proved
2665480093f4SDimitry Andric // that the optimization actually makes a difference.
2666480093f4SDimitry Andric //
2667480093f4SDimitry Andric // That said, the 2-PLT scheme is a part of the ABI, debuggers and other tools
2668480093f4SDimitry Andric // depend on it, so we implement the ABI.
2669480093f4SDimitry Andric IBTPltSection::IBTPltSection()
2670480093f4SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS, 16, ".plt") {}
2671480093f4SDimitry Andric 
2672480093f4SDimitry Andric void IBTPltSection::writeTo(uint8_t *buf) {
2673480093f4SDimitry Andric   target->writeIBTPlt(buf, in.plt->getNumEntries());
2674480093f4SDimitry Andric }
2675480093f4SDimitry Andric 
2676480093f4SDimitry Andric size_t IBTPltSection::getSize() const {
2677480093f4SDimitry Andric   // 16 is the header size of .plt.
2678480093f4SDimitry Andric   return 16 + in.plt->getNumEntries() * target->pltEntrySize;
2679480093f4SDimitry Andric }
2680480093f4SDimitry Andric 
26810b57cec5SDimitry Andric // The string hash function for .gdb_index.
26820b57cec5SDimitry Andric static uint32_t computeGdbHash(StringRef s) {
26830b57cec5SDimitry Andric   uint32_t h = 0;
26840b57cec5SDimitry Andric   for (uint8_t c : s)
26850b57cec5SDimitry Andric     h = h * 67 + toLower(c) - 113;
26860b57cec5SDimitry Andric   return h;
26870b57cec5SDimitry Andric }
26880b57cec5SDimitry Andric 
26890b57cec5SDimitry Andric GdbIndexSection::GdbIndexSection()
26900b57cec5SDimitry Andric     : SyntheticSection(0, SHT_PROGBITS, 1, ".gdb_index") {}
26910b57cec5SDimitry Andric 
26920b57cec5SDimitry Andric // Returns the desired size of an on-disk hash table for a .gdb_index section.
26930b57cec5SDimitry Andric // There's a tradeoff between size and collision rate. We aim 75% utilization.
26940b57cec5SDimitry Andric size_t GdbIndexSection::computeSymtabSize() const {
26950b57cec5SDimitry Andric   return std::max<size_t>(NextPowerOf2(symbols.size() * 4 / 3), 1024);
26960b57cec5SDimitry Andric }
26970b57cec5SDimitry Andric 
26980b57cec5SDimitry Andric // Compute the output section size.
26990b57cec5SDimitry Andric void GdbIndexSection::initOutputSize() {
27000b57cec5SDimitry Andric   size = sizeof(GdbIndexHeader) + computeSymtabSize() * 8;
27010b57cec5SDimitry Andric 
27020b57cec5SDimitry Andric   for (GdbChunk &chunk : chunks)
27030b57cec5SDimitry Andric     size += chunk.compilationUnits.size() * 16 + chunk.addressAreas.size() * 20;
27040b57cec5SDimitry Andric 
27050b57cec5SDimitry Andric   // Add the constant pool size if exists.
27060b57cec5SDimitry Andric   if (!symbols.empty()) {
27070b57cec5SDimitry Andric     GdbSymbol &sym = symbols.back();
27080b57cec5SDimitry Andric     size += sym.nameOff + sym.name.size() + 1;
27090b57cec5SDimitry Andric   }
27100b57cec5SDimitry Andric }
27110b57cec5SDimitry Andric 
27120b57cec5SDimitry Andric static std::vector<GdbIndexSection::CuEntry> readCuList(DWARFContext &dwarf) {
27130b57cec5SDimitry Andric   std::vector<GdbIndexSection::CuEntry> ret;
27140b57cec5SDimitry Andric   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units())
27150b57cec5SDimitry Andric     ret.push_back({cu->getOffset(), cu->getLength() + 4});
27160b57cec5SDimitry Andric   return ret;
27170b57cec5SDimitry Andric }
27180b57cec5SDimitry Andric 
27190b57cec5SDimitry Andric static std::vector<GdbIndexSection::AddressEntry>
27200b57cec5SDimitry Andric readAddressAreas(DWARFContext &dwarf, InputSection *sec) {
27210b57cec5SDimitry Andric   std::vector<GdbIndexSection::AddressEntry> ret;
27220b57cec5SDimitry Andric 
27230b57cec5SDimitry Andric   uint32_t cuIdx = 0;
27240b57cec5SDimitry Andric   for (std::unique_ptr<DWARFUnit> &cu : dwarf.compile_units()) {
272585868e8aSDimitry Andric     if (Error e = cu->tryExtractDIEsIfNeeded(false)) {
27265ffd83dbSDimitry Andric       warn(toString(sec) + ": " + toString(std::move(e)));
272785868e8aSDimitry Andric       return {};
272885868e8aSDimitry Andric     }
27290b57cec5SDimitry Andric     Expected<DWARFAddressRangesVector> ranges = cu->collectAddressRanges();
27300b57cec5SDimitry Andric     if (!ranges) {
27315ffd83dbSDimitry Andric       warn(toString(sec) + ": " + toString(ranges.takeError()));
27320b57cec5SDimitry Andric       return {};
27330b57cec5SDimitry Andric     }
27340b57cec5SDimitry Andric 
27350b57cec5SDimitry Andric     ArrayRef<InputSectionBase *> sections = sec->file->getSections();
27360b57cec5SDimitry Andric     for (DWARFAddressRange &r : *ranges) {
27370b57cec5SDimitry Andric       if (r.SectionIndex == -1ULL)
27380b57cec5SDimitry Andric         continue;
27390b57cec5SDimitry Andric       // Range list with zero size has no effect.
27405ffd83dbSDimitry Andric       InputSectionBase *s = sections[r.SectionIndex];
27415ffd83dbSDimitry Andric       if (s && s != &InputSection::discarded && s->isLive())
27425ffd83dbSDimitry Andric         if (r.LowPC != r.HighPC)
27435ffd83dbSDimitry Andric           ret.push_back({cast<InputSection>(s), r.LowPC, r.HighPC, cuIdx});
27440b57cec5SDimitry Andric     }
27450b57cec5SDimitry Andric     ++cuIdx;
27460b57cec5SDimitry Andric   }
27470b57cec5SDimitry Andric 
27480b57cec5SDimitry Andric   return ret;
27490b57cec5SDimitry Andric }
27500b57cec5SDimitry Andric 
27510b57cec5SDimitry Andric template <class ELFT>
27520b57cec5SDimitry Andric static std::vector<GdbIndexSection::NameAttrEntry>
27530b57cec5SDimitry Andric readPubNamesAndTypes(const LLDDwarfObj<ELFT> &obj,
275485868e8aSDimitry Andric                      const std::vector<GdbIndexSection::CuEntry> &cus) {
27555ffd83dbSDimitry Andric   const LLDDWARFSection &pubNames = obj.getGnuPubnamesSection();
27565ffd83dbSDimitry Andric   const LLDDWARFSection &pubTypes = obj.getGnuPubtypesSection();
27570b57cec5SDimitry Andric 
27580b57cec5SDimitry Andric   std::vector<GdbIndexSection::NameAttrEntry> ret;
27595ffd83dbSDimitry Andric   for (const LLDDWARFSection *pub : {&pubNames, &pubTypes}) {
27605ffd83dbSDimitry Andric     DWARFDataExtractor data(obj, *pub, config->isLE, config->wordsize);
27615ffd83dbSDimitry Andric     DWARFDebugPubTable table;
27625ffd83dbSDimitry Andric     table.extract(data, /*GnuStyle=*/true, [&](Error e) {
27635ffd83dbSDimitry Andric       warn(toString(pub->sec) + ": " + toString(std::move(e)));
27645ffd83dbSDimitry Andric     });
27650b57cec5SDimitry Andric     for (const DWARFDebugPubTable::Set &set : table.getData()) {
27660b57cec5SDimitry Andric       // The value written into the constant pool is kind << 24 | cuIndex. As we
27670b57cec5SDimitry Andric       // don't know how many compilation units precede this object to compute
27680b57cec5SDimitry Andric       // cuIndex, we compute (kind << 24 | cuIndexInThisObject) instead, and add
27690b57cec5SDimitry Andric       // the number of preceding compilation units later.
277085868e8aSDimitry Andric       uint32_t i = llvm::partition_point(cus,
277185868e8aSDimitry Andric                                          [&](GdbIndexSection::CuEntry cu) {
277285868e8aSDimitry Andric                                            return cu.cuOffset < set.Offset;
27730b57cec5SDimitry Andric                                          }) -
277485868e8aSDimitry Andric                    cus.begin();
27750b57cec5SDimitry Andric       for (const DWARFDebugPubTable::Entry &ent : set.Entries)
27760b57cec5SDimitry Andric         ret.push_back({{ent.Name, computeGdbHash(ent.Name)},
27770b57cec5SDimitry Andric                        (ent.Descriptor.toBits() << 24) | i});
27780b57cec5SDimitry Andric     }
27790b57cec5SDimitry Andric   }
27800b57cec5SDimitry Andric   return ret;
27810b57cec5SDimitry Andric }
27820b57cec5SDimitry Andric 
27830b57cec5SDimitry Andric // Create a list of symbols from a given list of symbol names and types
27840b57cec5SDimitry Andric // by uniquifying them by name.
27850b57cec5SDimitry Andric static std::vector<GdbIndexSection::GdbSymbol>
27860b57cec5SDimitry Andric createSymbols(ArrayRef<std::vector<GdbIndexSection::NameAttrEntry>> nameAttrs,
27870b57cec5SDimitry Andric               const std::vector<GdbIndexSection::GdbChunk> &chunks) {
27880b57cec5SDimitry Andric   using GdbSymbol = GdbIndexSection::GdbSymbol;
27890b57cec5SDimitry Andric   using NameAttrEntry = GdbIndexSection::NameAttrEntry;
27900b57cec5SDimitry Andric 
27910b57cec5SDimitry Andric   // For each chunk, compute the number of compilation units preceding it.
27920b57cec5SDimitry Andric   uint32_t cuIdx = 0;
27930b57cec5SDimitry Andric   std::vector<uint32_t> cuIdxs(chunks.size());
27940b57cec5SDimitry Andric   for (uint32_t i = 0, e = chunks.size(); i != e; ++i) {
27950b57cec5SDimitry Andric     cuIdxs[i] = cuIdx;
27960b57cec5SDimitry Andric     cuIdx += chunks[i].compilationUnits.size();
27970b57cec5SDimitry Andric   }
27980b57cec5SDimitry Andric 
27990b57cec5SDimitry Andric   // The number of symbols we will handle in this function is of the order
28000b57cec5SDimitry Andric   // of millions for very large executables, so we use multi-threading to
28010b57cec5SDimitry Andric   // speed it up.
28025ffd83dbSDimitry Andric   constexpr size_t numShards = 32;
28035ffd83dbSDimitry Andric   size_t concurrency = PowerOf2Floor(
28045ffd83dbSDimitry Andric       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
28055ffd83dbSDimitry Andric                            .compute_thread_count(),
28065ffd83dbSDimitry Andric                        numShards));
28070b57cec5SDimitry Andric 
28080b57cec5SDimitry Andric   // A sharded map to uniquify symbols by name.
28090b57cec5SDimitry Andric   std::vector<DenseMap<CachedHashStringRef, size_t>> map(numShards);
28100b57cec5SDimitry Andric   size_t shift = 32 - countTrailingZeros(numShards);
28110b57cec5SDimitry Andric 
28120b57cec5SDimitry Andric   // Instantiate GdbSymbols while uniqufying them by name.
28130b57cec5SDimitry Andric   std::vector<std::vector<GdbSymbol>> symbols(numShards);
28140b57cec5SDimitry Andric   parallelForEachN(0, concurrency, [&](size_t threadId) {
28150b57cec5SDimitry Andric     uint32_t i = 0;
28160b57cec5SDimitry Andric     for (ArrayRef<NameAttrEntry> entries : nameAttrs) {
28170b57cec5SDimitry Andric       for (const NameAttrEntry &ent : entries) {
28180b57cec5SDimitry Andric         size_t shardId = ent.name.hash() >> shift;
28190b57cec5SDimitry Andric         if ((shardId & (concurrency - 1)) != threadId)
28200b57cec5SDimitry Andric           continue;
28210b57cec5SDimitry Andric 
28220b57cec5SDimitry Andric         uint32_t v = ent.cuIndexAndAttrs + cuIdxs[i];
28230b57cec5SDimitry Andric         size_t &idx = map[shardId][ent.name];
28240b57cec5SDimitry Andric         if (idx) {
28250b57cec5SDimitry Andric           symbols[shardId][idx - 1].cuVector.push_back(v);
28260b57cec5SDimitry Andric           continue;
28270b57cec5SDimitry Andric         }
28280b57cec5SDimitry Andric 
28290b57cec5SDimitry Andric         idx = symbols[shardId].size() + 1;
28300b57cec5SDimitry Andric         symbols[shardId].push_back({ent.name, {v}, 0, 0});
28310b57cec5SDimitry Andric       }
28320b57cec5SDimitry Andric       ++i;
28330b57cec5SDimitry Andric     }
28340b57cec5SDimitry Andric   });
28350b57cec5SDimitry Andric 
28360b57cec5SDimitry Andric   size_t numSymbols = 0;
28370b57cec5SDimitry Andric   for (ArrayRef<GdbSymbol> v : symbols)
28380b57cec5SDimitry Andric     numSymbols += v.size();
28390b57cec5SDimitry Andric 
28400b57cec5SDimitry Andric   // The return type is a flattened vector, so we'll copy each vector
28410b57cec5SDimitry Andric   // contents to Ret.
28420b57cec5SDimitry Andric   std::vector<GdbSymbol> ret;
28430b57cec5SDimitry Andric   ret.reserve(numSymbols);
28440b57cec5SDimitry Andric   for (std::vector<GdbSymbol> &vec : symbols)
28450b57cec5SDimitry Andric     for (GdbSymbol &sym : vec)
28460b57cec5SDimitry Andric       ret.push_back(std::move(sym));
28470b57cec5SDimitry Andric 
28480b57cec5SDimitry Andric   // CU vectors and symbol names are adjacent in the output file.
28490b57cec5SDimitry Andric   // We can compute their offsets in the output file now.
28500b57cec5SDimitry Andric   size_t off = 0;
28510b57cec5SDimitry Andric   for (GdbSymbol &sym : ret) {
28520b57cec5SDimitry Andric     sym.cuVectorOff = off;
28530b57cec5SDimitry Andric     off += (sym.cuVector.size() + 1) * 4;
28540b57cec5SDimitry Andric   }
28550b57cec5SDimitry Andric   for (GdbSymbol &sym : ret) {
28560b57cec5SDimitry Andric     sym.nameOff = off;
28570b57cec5SDimitry Andric     off += sym.name.size() + 1;
28580b57cec5SDimitry Andric   }
28590b57cec5SDimitry Andric 
28600b57cec5SDimitry Andric   return ret;
28610b57cec5SDimitry Andric }
28620b57cec5SDimitry Andric 
28630b57cec5SDimitry Andric // Returns a newly-created .gdb_index section.
28640b57cec5SDimitry Andric template <class ELFT> GdbIndexSection *GdbIndexSection::create() {
286516d6b3b3SDimitry Andric   // Collect InputFiles with .debug_info. See the comment in
286616d6b3b3SDimitry Andric   // LLDDwarfObj<ELFT>::LLDDwarfObj. If we do lightweight parsing in the future,
286716d6b3b3SDimitry Andric   // note that isec->data() may uncompress the full content, which should be
286816d6b3b3SDimitry Andric   // parallelized.
286916d6b3b3SDimitry Andric   SetVector<InputFile *> files;
287016d6b3b3SDimitry Andric   for (InputSectionBase *s : inputSections) {
287116d6b3b3SDimitry Andric     InputSection *isec = dyn_cast<InputSection>(s);
287216d6b3b3SDimitry Andric     if (!isec)
287316d6b3b3SDimitry Andric       continue;
28740b57cec5SDimitry Andric     // .debug_gnu_pub{names,types} are useless in executables.
28750b57cec5SDimitry Andric     // They are present in input object files solely for creating
28760b57cec5SDimitry Andric     // a .gdb_index. So we can remove them from the output.
28770b57cec5SDimitry Andric     if (s->name == ".debug_gnu_pubnames" || s->name == ".debug_gnu_pubtypes")
28780b57cec5SDimitry Andric       s->markDead();
287916d6b3b3SDimitry Andric     else if (isec->name == ".debug_info")
288016d6b3b3SDimitry Andric       files.insert(isec->file);
288116d6b3b3SDimitry Andric   }
2882e8d8bef9SDimitry Andric   // Drop .rel[a].debug_gnu_pub{names,types} for --emit-relocs.
2883e8d8bef9SDimitry Andric   llvm::erase_if(inputSections, [](InputSectionBase *s) {
2884e8d8bef9SDimitry Andric     if (auto *isec = dyn_cast<InputSection>(s))
2885e8d8bef9SDimitry Andric       if (InputSectionBase *rel = isec->getRelocatedSection())
2886e8d8bef9SDimitry Andric         return !rel->isLive();
2887e8d8bef9SDimitry Andric     return !s->isLive();
2888e8d8bef9SDimitry Andric   });
28890b57cec5SDimitry Andric 
289016d6b3b3SDimitry Andric   std::vector<GdbChunk> chunks(files.size());
289116d6b3b3SDimitry Andric   std::vector<std::vector<NameAttrEntry>> nameAttrs(files.size());
28920b57cec5SDimitry Andric 
289316d6b3b3SDimitry Andric   parallelForEachN(0, files.size(), [&](size_t i) {
28945ffd83dbSDimitry Andric     // To keep memory usage low, we don't want to keep cached DWARFContext, so
28955ffd83dbSDimitry Andric     // avoid getDwarf() here.
289616d6b3b3SDimitry Andric     ObjFile<ELFT> *file = cast<ObjFile<ELFT>>(files[i]);
289785868e8aSDimitry Andric     DWARFContext dwarf(std::make_unique<LLDDwarfObj<ELFT>>(file));
289816d6b3b3SDimitry Andric     auto &dobj = static_cast<const LLDDwarfObj<ELFT> &>(dwarf.getDWARFObj());
28990b57cec5SDimitry Andric 
290016d6b3b3SDimitry Andric     // If the are multiple compile units .debug_info (very rare ld -r --unique),
290116d6b3b3SDimitry Andric     // this only picks the last one. Other address ranges are lost.
290216d6b3b3SDimitry Andric     chunks[i].sec = dobj.getInfoSection();
29030b57cec5SDimitry Andric     chunks[i].compilationUnits = readCuList(dwarf);
290416d6b3b3SDimitry Andric     chunks[i].addressAreas = readAddressAreas(dwarf, chunks[i].sec);
290516d6b3b3SDimitry Andric     nameAttrs[i] = readPubNamesAndTypes<ELFT>(dobj, chunks[i].compilationUnits);
29060b57cec5SDimitry Andric   });
29070b57cec5SDimitry Andric 
29080b57cec5SDimitry Andric   auto *ret = make<GdbIndexSection>();
29090b57cec5SDimitry Andric   ret->chunks = std::move(chunks);
29100b57cec5SDimitry Andric   ret->symbols = createSymbols(nameAttrs, ret->chunks);
29110b57cec5SDimitry Andric   ret->initOutputSize();
29120b57cec5SDimitry Andric   return ret;
29130b57cec5SDimitry Andric }
29140b57cec5SDimitry Andric 
29150b57cec5SDimitry Andric void GdbIndexSection::writeTo(uint8_t *buf) {
29160b57cec5SDimitry Andric   // Write the header.
29170b57cec5SDimitry Andric   auto *hdr = reinterpret_cast<GdbIndexHeader *>(buf);
29180b57cec5SDimitry Andric   uint8_t *start = buf;
29190b57cec5SDimitry Andric   hdr->version = 7;
29200b57cec5SDimitry Andric   buf += sizeof(*hdr);
29210b57cec5SDimitry Andric 
29220b57cec5SDimitry Andric   // Write the CU list.
29230b57cec5SDimitry Andric   hdr->cuListOff = buf - start;
29240b57cec5SDimitry Andric   for (GdbChunk &chunk : chunks) {
29250b57cec5SDimitry Andric     for (CuEntry &cu : chunk.compilationUnits) {
29260b57cec5SDimitry Andric       write64le(buf, chunk.sec->outSecOff + cu.cuOffset);
29270b57cec5SDimitry Andric       write64le(buf + 8, cu.cuLength);
29280b57cec5SDimitry Andric       buf += 16;
29290b57cec5SDimitry Andric     }
29300b57cec5SDimitry Andric   }
29310b57cec5SDimitry Andric 
29320b57cec5SDimitry Andric   // Write the address area.
29330b57cec5SDimitry Andric   hdr->cuTypesOff = buf - start;
29340b57cec5SDimitry Andric   hdr->addressAreaOff = buf - start;
29350b57cec5SDimitry Andric   uint32_t cuOff = 0;
29360b57cec5SDimitry Andric   for (GdbChunk &chunk : chunks) {
29370b57cec5SDimitry Andric     for (AddressEntry &e : chunk.addressAreas) {
2938e8d8bef9SDimitry Andric       // In the case of ICF there may be duplicate address range entries.
2939e8d8bef9SDimitry Andric       const uint64_t baseAddr = e.section->repl->getVA(0);
29400b57cec5SDimitry Andric       write64le(buf, baseAddr + e.lowAddress);
29410b57cec5SDimitry Andric       write64le(buf + 8, baseAddr + e.highAddress);
29420b57cec5SDimitry Andric       write32le(buf + 16, e.cuIndex + cuOff);
29430b57cec5SDimitry Andric       buf += 20;
29440b57cec5SDimitry Andric     }
29450b57cec5SDimitry Andric     cuOff += chunk.compilationUnits.size();
29460b57cec5SDimitry Andric   }
29470b57cec5SDimitry Andric 
29480b57cec5SDimitry Andric   // Write the on-disk open-addressing hash table containing symbols.
29490b57cec5SDimitry Andric   hdr->symtabOff = buf - start;
29500b57cec5SDimitry Andric   size_t symtabSize = computeSymtabSize();
29510b57cec5SDimitry Andric   uint32_t mask = symtabSize - 1;
29520b57cec5SDimitry Andric 
29530b57cec5SDimitry Andric   for (GdbSymbol &sym : symbols) {
29540b57cec5SDimitry Andric     uint32_t h = sym.name.hash();
29550b57cec5SDimitry Andric     uint32_t i = h & mask;
29560b57cec5SDimitry Andric     uint32_t step = ((h * 17) & mask) | 1;
29570b57cec5SDimitry Andric 
29580b57cec5SDimitry Andric     while (read32le(buf + i * 8))
29590b57cec5SDimitry Andric       i = (i + step) & mask;
29600b57cec5SDimitry Andric 
29610b57cec5SDimitry Andric     write32le(buf + i * 8, sym.nameOff);
29620b57cec5SDimitry Andric     write32le(buf + i * 8 + 4, sym.cuVectorOff);
29630b57cec5SDimitry Andric   }
29640b57cec5SDimitry Andric 
29650b57cec5SDimitry Andric   buf += symtabSize * 8;
29660b57cec5SDimitry Andric 
29670b57cec5SDimitry Andric   // Write the string pool.
29680b57cec5SDimitry Andric   hdr->constantPoolOff = buf - start;
29690b57cec5SDimitry Andric   parallelForEach(symbols, [&](GdbSymbol &sym) {
29700b57cec5SDimitry Andric     memcpy(buf + sym.nameOff, sym.name.data(), sym.name.size());
29710b57cec5SDimitry Andric   });
29720b57cec5SDimitry Andric 
29730b57cec5SDimitry Andric   // Write the CU vectors.
29740b57cec5SDimitry Andric   for (GdbSymbol &sym : symbols) {
29750b57cec5SDimitry Andric     write32le(buf, sym.cuVector.size());
29760b57cec5SDimitry Andric     buf += 4;
29770b57cec5SDimitry Andric     for (uint32_t val : sym.cuVector) {
29780b57cec5SDimitry Andric       write32le(buf, val);
29790b57cec5SDimitry Andric       buf += 4;
29800b57cec5SDimitry Andric     }
29810b57cec5SDimitry Andric   }
29820b57cec5SDimitry Andric }
29830b57cec5SDimitry Andric 
29840b57cec5SDimitry Andric bool GdbIndexSection::isNeeded() const { return !chunks.empty(); }
29850b57cec5SDimitry Andric 
29860b57cec5SDimitry Andric EhFrameHeader::EhFrameHeader()
29870b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".eh_frame_hdr") {}
29880b57cec5SDimitry Andric 
29890b57cec5SDimitry Andric void EhFrameHeader::writeTo(uint8_t *buf) {
29900b57cec5SDimitry Andric   // Unlike most sections, the EhFrameHeader section is written while writing
29910b57cec5SDimitry Andric   // another section, namely EhFrameSection, which calls the write() function
29920b57cec5SDimitry Andric   // below from its writeTo() function. This is necessary because the contents
29930b57cec5SDimitry Andric   // of EhFrameHeader depend on the relocated contents of EhFrameSection and we
29940b57cec5SDimitry Andric   // don't know which order the sections will be written in.
29950b57cec5SDimitry Andric }
29960b57cec5SDimitry Andric 
29970b57cec5SDimitry Andric // .eh_frame_hdr contains a binary search table of pointers to FDEs.
29980b57cec5SDimitry Andric // Each entry of the search table consists of two values,
29990b57cec5SDimitry Andric // the starting PC from where FDEs covers, and the FDE's address.
30000b57cec5SDimitry Andric // It is sorted by PC.
30010b57cec5SDimitry Andric void EhFrameHeader::write() {
30020b57cec5SDimitry Andric   uint8_t *buf = Out::bufferStart + getParent()->offset + outSecOff;
30030b57cec5SDimitry Andric   using FdeData = EhFrameSection::FdeData;
30040b57cec5SDimitry Andric 
30050b57cec5SDimitry Andric   std::vector<FdeData> fdes = getPartition().ehFrame->getFdeData();
30060b57cec5SDimitry Andric 
30070b57cec5SDimitry Andric   buf[0] = 1;
30080b57cec5SDimitry Andric   buf[1] = DW_EH_PE_pcrel | DW_EH_PE_sdata4;
30090b57cec5SDimitry Andric   buf[2] = DW_EH_PE_udata4;
30100b57cec5SDimitry Andric   buf[3] = DW_EH_PE_datarel | DW_EH_PE_sdata4;
30110b57cec5SDimitry Andric   write32(buf + 4,
30120b57cec5SDimitry Andric           getPartition().ehFrame->getParent()->addr - this->getVA() - 4);
30130b57cec5SDimitry Andric   write32(buf + 8, fdes.size());
30140b57cec5SDimitry Andric   buf += 12;
30150b57cec5SDimitry Andric 
30160b57cec5SDimitry Andric   for (FdeData &fde : fdes) {
30170b57cec5SDimitry Andric     write32(buf, fde.pcRel);
30180b57cec5SDimitry Andric     write32(buf + 4, fde.fdeVARel);
30190b57cec5SDimitry Andric     buf += 8;
30200b57cec5SDimitry Andric   }
30210b57cec5SDimitry Andric }
30220b57cec5SDimitry Andric 
30230b57cec5SDimitry Andric size_t EhFrameHeader::getSize() const {
30240b57cec5SDimitry Andric   // .eh_frame_hdr has a 12 bytes header followed by an array of FDEs.
30250b57cec5SDimitry Andric   return 12 + getPartition().ehFrame->numFdes * 8;
30260b57cec5SDimitry Andric }
30270b57cec5SDimitry Andric 
30280b57cec5SDimitry Andric bool EhFrameHeader::isNeeded() const {
30290b57cec5SDimitry Andric   return isLive() && getPartition().ehFrame->isNeeded();
30300b57cec5SDimitry Andric }
30310b57cec5SDimitry Andric 
30320b57cec5SDimitry Andric VersionDefinitionSection::VersionDefinitionSection()
30330b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_GNU_verdef, sizeof(uint32_t),
30340b57cec5SDimitry Andric                        ".gnu.version_d") {}
30350b57cec5SDimitry Andric 
30360b57cec5SDimitry Andric StringRef VersionDefinitionSection::getFileDefName() {
30370b57cec5SDimitry Andric   if (!getPartition().name.empty())
30380b57cec5SDimitry Andric     return getPartition().name;
30390b57cec5SDimitry Andric   if (!config->soName.empty())
30400b57cec5SDimitry Andric     return config->soName;
30410b57cec5SDimitry Andric   return config->outputFile;
30420b57cec5SDimitry Andric }
30430b57cec5SDimitry Andric 
30440b57cec5SDimitry Andric void VersionDefinitionSection::finalizeContents() {
30450b57cec5SDimitry Andric   fileDefNameOff = getPartition().dynStrTab->addString(getFileDefName());
304685868e8aSDimitry Andric   for (const VersionDefinition &v : namedVersionDefs())
30470b57cec5SDimitry Andric     verDefNameOffs.push_back(getPartition().dynStrTab->addString(v.name));
30480b57cec5SDimitry Andric 
30490b57cec5SDimitry Andric   if (OutputSection *sec = getPartition().dynStrTab->getParent())
30500b57cec5SDimitry Andric     getParent()->link = sec->sectionIndex;
30510b57cec5SDimitry Andric 
30520b57cec5SDimitry Andric   // sh_info should be set to the number of definitions. This fact is missed in
30530b57cec5SDimitry Andric   // documentation, but confirmed by binutils community:
30540b57cec5SDimitry Andric   // https://sourceware.org/ml/binutils/2014-11/msg00355.html
30550b57cec5SDimitry Andric   getParent()->info = getVerDefNum();
30560b57cec5SDimitry Andric }
30570b57cec5SDimitry Andric 
30580b57cec5SDimitry Andric void VersionDefinitionSection::writeOne(uint8_t *buf, uint32_t index,
30590b57cec5SDimitry Andric                                         StringRef name, size_t nameOff) {
30600b57cec5SDimitry Andric   uint16_t flags = index == 1 ? VER_FLG_BASE : 0;
30610b57cec5SDimitry Andric 
30620b57cec5SDimitry Andric   // Write a verdef.
30630b57cec5SDimitry Andric   write16(buf, 1);                  // vd_version
30640b57cec5SDimitry Andric   write16(buf + 2, flags);          // vd_flags
30650b57cec5SDimitry Andric   write16(buf + 4, index);          // vd_ndx
30660b57cec5SDimitry Andric   write16(buf + 6, 1);              // vd_cnt
30670b57cec5SDimitry Andric   write32(buf + 8, hashSysV(name)); // vd_hash
30680b57cec5SDimitry Andric   write32(buf + 12, 20);            // vd_aux
30690b57cec5SDimitry Andric   write32(buf + 16, 28);            // vd_next
30700b57cec5SDimitry Andric 
30710b57cec5SDimitry Andric   // Write a veraux.
30720b57cec5SDimitry Andric   write32(buf + 20, nameOff); // vda_name
30730b57cec5SDimitry Andric   write32(buf + 24, 0);       // vda_next
30740b57cec5SDimitry Andric }
30750b57cec5SDimitry Andric 
30760b57cec5SDimitry Andric void VersionDefinitionSection::writeTo(uint8_t *buf) {
30770b57cec5SDimitry Andric   writeOne(buf, 1, getFileDefName(), fileDefNameOff);
30780b57cec5SDimitry Andric 
30790b57cec5SDimitry Andric   auto nameOffIt = verDefNameOffs.begin();
308085868e8aSDimitry Andric   for (const VersionDefinition &v : namedVersionDefs()) {
30810b57cec5SDimitry Andric     buf += EntrySize;
30820b57cec5SDimitry Andric     writeOne(buf, v.id, v.name, *nameOffIt++);
30830b57cec5SDimitry Andric   }
30840b57cec5SDimitry Andric 
30850b57cec5SDimitry Andric   // Need to terminate the last version definition.
30860b57cec5SDimitry Andric   write32(buf + 16, 0); // vd_next
30870b57cec5SDimitry Andric }
30880b57cec5SDimitry Andric 
30890b57cec5SDimitry Andric size_t VersionDefinitionSection::getSize() const {
30900b57cec5SDimitry Andric   return EntrySize * getVerDefNum();
30910b57cec5SDimitry Andric }
30920b57cec5SDimitry Andric 
30930b57cec5SDimitry Andric // .gnu.version is a table where each entry is 2 byte long.
30940b57cec5SDimitry Andric VersionTableSection::VersionTableSection()
30950b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_GNU_versym, sizeof(uint16_t),
30960b57cec5SDimitry Andric                        ".gnu.version") {
30970b57cec5SDimitry Andric   this->entsize = 2;
30980b57cec5SDimitry Andric }
30990b57cec5SDimitry Andric 
31000b57cec5SDimitry Andric void VersionTableSection::finalizeContents() {
31010b57cec5SDimitry Andric   // At the moment of june 2016 GNU docs does not mention that sh_link field
31020b57cec5SDimitry Andric   // should be set, but Sun docs do. Also readelf relies on this field.
31030b57cec5SDimitry Andric   getParent()->link = getPartition().dynSymTab->getParent()->sectionIndex;
31040b57cec5SDimitry Andric }
31050b57cec5SDimitry Andric 
31060b57cec5SDimitry Andric size_t VersionTableSection::getSize() const {
31070b57cec5SDimitry Andric   return (getPartition().dynSymTab->getSymbols().size() + 1) * 2;
31080b57cec5SDimitry Andric }
31090b57cec5SDimitry Andric 
31100b57cec5SDimitry Andric void VersionTableSection::writeTo(uint8_t *buf) {
31110b57cec5SDimitry Andric   buf += 2;
31120b57cec5SDimitry Andric   for (const SymbolTableEntry &s : getPartition().dynSymTab->getSymbols()) {
3113*23408297SDimitry Andric     // Use the original versionId for an unfetched lazy symbol (undefined weak),
3114*23408297SDimitry Andric     // which must be VER_NDX_GLOBAL (an undefined versioned symbol is an error).
3115*23408297SDimitry Andric     write16(buf, s.sym->isLazy() ? VER_NDX_GLOBAL : s.sym->versionId);
31160b57cec5SDimitry Andric     buf += 2;
31170b57cec5SDimitry Andric   }
31180b57cec5SDimitry Andric }
31190b57cec5SDimitry Andric 
31200b57cec5SDimitry Andric bool VersionTableSection::isNeeded() const {
3121480093f4SDimitry Andric   return isLive() &&
3122480093f4SDimitry Andric          (getPartition().verDef || getPartition().verNeed->isNeeded());
31230b57cec5SDimitry Andric }
31240b57cec5SDimitry Andric 
31255ffd83dbSDimitry Andric void elf::addVerneed(Symbol *ss) {
31260b57cec5SDimitry Andric   auto &file = cast<SharedFile>(*ss->file);
31270b57cec5SDimitry Andric   if (ss->verdefIndex == VER_NDX_GLOBAL) {
31280b57cec5SDimitry Andric     ss->versionId = VER_NDX_GLOBAL;
31290b57cec5SDimitry Andric     return;
31300b57cec5SDimitry Andric   }
31310b57cec5SDimitry Andric 
31320b57cec5SDimitry Andric   if (file.vernauxs.empty())
31330b57cec5SDimitry Andric     file.vernauxs.resize(file.verdefs.size());
31340b57cec5SDimitry Andric 
31350b57cec5SDimitry Andric   // Select a version identifier for the vernaux data structure, if we haven't
31360b57cec5SDimitry Andric   // already allocated one. The verdef identifiers cover the range
31370b57cec5SDimitry Andric   // [1..getVerDefNum()]; this causes the vernaux identifiers to start from
31380b57cec5SDimitry Andric   // getVerDefNum()+1.
31390b57cec5SDimitry Andric   if (file.vernauxs[ss->verdefIndex] == 0)
31400b57cec5SDimitry Andric     file.vernauxs[ss->verdefIndex] = ++SharedFile::vernauxNum + getVerDefNum();
31410b57cec5SDimitry Andric 
31420b57cec5SDimitry Andric   ss->versionId = file.vernauxs[ss->verdefIndex];
31430b57cec5SDimitry Andric }
31440b57cec5SDimitry Andric 
31450b57cec5SDimitry Andric template <class ELFT>
31460b57cec5SDimitry Andric VersionNeedSection<ELFT>::VersionNeedSection()
31470b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_GNU_verneed, sizeof(uint32_t),
31480b57cec5SDimitry Andric                        ".gnu.version_r") {}
31490b57cec5SDimitry Andric 
31500b57cec5SDimitry Andric template <class ELFT> void VersionNeedSection<ELFT>::finalizeContents() {
31510b57cec5SDimitry Andric   for (SharedFile *f : sharedFiles) {
31520b57cec5SDimitry Andric     if (f->vernauxs.empty())
31530b57cec5SDimitry Andric       continue;
31540b57cec5SDimitry Andric     verneeds.emplace_back();
31550b57cec5SDimitry Andric     Verneed &vn = verneeds.back();
31560b57cec5SDimitry Andric     vn.nameStrTab = getPartition().dynStrTab->addString(f->soName);
31570b57cec5SDimitry Andric     for (unsigned i = 0; i != f->vernauxs.size(); ++i) {
31580b57cec5SDimitry Andric       if (f->vernauxs[i] == 0)
31590b57cec5SDimitry Andric         continue;
31600b57cec5SDimitry Andric       auto *verdef =
31610b57cec5SDimitry Andric           reinterpret_cast<const typename ELFT::Verdef *>(f->verdefs[i]);
31620b57cec5SDimitry Andric       vn.vernauxs.push_back(
31630b57cec5SDimitry Andric           {verdef->vd_hash, f->vernauxs[i],
31640b57cec5SDimitry Andric            getPartition().dynStrTab->addString(f->getStringTable().data() +
31650b57cec5SDimitry Andric                                                verdef->getAux()->vda_name)});
31660b57cec5SDimitry Andric     }
31670b57cec5SDimitry Andric   }
31680b57cec5SDimitry Andric 
31690b57cec5SDimitry Andric   if (OutputSection *sec = getPartition().dynStrTab->getParent())
31700b57cec5SDimitry Andric     getParent()->link = sec->sectionIndex;
31710b57cec5SDimitry Andric   getParent()->info = verneeds.size();
31720b57cec5SDimitry Andric }
31730b57cec5SDimitry Andric 
31740b57cec5SDimitry Andric template <class ELFT> void VersionNeedSection<ELFT>::writeTo(uint8_t *buf) {
31750b57cec5SDimitry Andric   // The Elf_Verneeds need to appear first, followed by the Elf_Vernauxs.
31760b57cec5SDimitry Andric   auto *verneed = reinterpret_cast<Elf_Verneed *>(buf);
31770b57cec5SDimitry Andric   auto *vernaux = reinterpret_cast<Elf_Vernaux *>(verneed + verneeds.size());
31780b57cec5SDimitry Andric 
31790b57cec5SDimitry Andric   for (auto &vn : verneeds) {
31800b57cec5SDimitry Andric     // Create an Elf_Verneed for this DSO.
31810b57cec5SDimitry Andric     verneed->vn_version = 1;
31820b57cec5SDimitry Andric     verneed->vn_cnt = vn.vernauxs.size();
31830b57cec5SDimitry Andric     verneed->vn_file = vn.nameStrTab;
31840b57cec5SDimitry Andric     verneed->vn_aux =
31850b57cec5SDimitry Andric         reinterpret_cast<char *>(vernaux) - reinterpret_cast<char *>(verneed);
31860b57cec5SDimitry Andric     verneed->vn_next = sizeof(Elf_Verneed);
31870b57cec5SDimitry Andric     ++verneed;
31880b57cec5SDimitry Andric 
31890b57cec5SDimitry Andric     // Create the Elf_Vernauxs for this Elf_Verneed.
31900b57cec5SDimitry Andric     for (auto &vna : vn.vernauxs) {
31910b57cec5SDimitry Andric       vernaux->vna_hash = vna.hash;
31920b57cec5SDimitry Andric       vernaux->vna_flags = 0;
31930b57cec5SDimitry Andric       vernaux->vna_other = vna.verneedIndex;
31940b57cec5SDimitry Andric       vernaux->vna_name = vna.nameStrTab;
31950b57cec5SDimitry Andric       vernaux->vna_next = sizeof(Elf_Vernaux);
31960b57cec5SDimitry Andric       ++vernaux;
31970b57cec5SDimitry Andric     }
31980b57cec5SDimitry Andric 
31990b57cec5SDimitry Andric     vernaux[-1].vna_next = 0;
32000b57cec5SDimitry Andric   }
32010b57cec5SDimitry Andric   verneed[-1].vn_next = 0;
32020b57cec5SDimitry Andric }
32030b57cec5SDimitry Andric 
32040b57cec5SDimitry Andric template <class ELFT> size_t VersionNeedSection<ELFT>::getSize() const {
32050b57cec5SDimitry Andric   return verneeds.size() * sizeof(Elf_Verneed) +
32060b57cec5SDimitry Andric          SharedFile::vernauxNum * sizeof(Elf_Vernaux);
32070b57cec5SDimitry Andric }
32080b57cec5SDimitry Andric 
32090b57cec5SDimitry Andric template <class ELFT> bool VersionNeedSection<ELFT>::isNeeded() const {
3210480093f4SDimitry Andric   return isLive() && SharedFile::vernauxNum != 0;
32110b57cec5SDimitry Andric }
32120b57cec5SDimitry Andric 
32130b57cec5SDimitry Andric void MergeSyntheticSection::addSection(MergeInputSection *ms) {
32140b57cec5SDimitry Andric   ms->parent = this;
32150b57cec5SDimitry Andric   sections.push_back(ms);
32160b57cec5SDimitry Andric   assert(alignment == ms->alignment || !(ms->flags & SHF_STRINGS));
32170b57cec5SDimitry Andric   alignment = std::max(alignment, ms->alignment);
32180b57cec5SDimitry Andric }
32190b57cec5SDimitry Andric 
32200b57cec5SDimitry Andric MergeTailSection::MergeTailSection(StringRef name, uint32_t type,
32210b57cec5SDimitry Andric                                    uint64_t flags, uint32_t alignment)
32220b57cec5SDimitry Andric     : MergeSyntheticSection(name, type, flags, alignment),
32230b57cec5SDimitry Andric       builder(StringTableBuilder::RAW, alignment) {}
32240b57cec5SDimitry Andric 
32250b57cec5SDimitry Andric size_t MergeTailSection::getSize() const { return builder.getSize(); }
32260b57cec5SDimitry Andric 
32270b57cec5SDimitry Andric void MergeTailSection::writeTo(uint8_t *buf) { builder.write(buf); }
32280b57cec5SDimitry Andric 
32290b57cec5SDimitry Andric void MergeTailSection::finalizeContents() {
32300b57cec5SDimitry Andric   // Add all string pieces to the string table builder to create section
32310b57cec5SDimitry Andric   // contents.
32320b57cec5SDimitry Andric   for (MergeInputSection *sec : sections)
32330b57cec5SDimitry Andric     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
32340b57cec5SDimitry Andric       if (sec->pieces[i].live)
32350b57cec5SDimitry Andric         builder.add(sec->getData(i));
32360b57cec5SDimitry Andric 
32370b57cec5SDimitry Andric   // Fix the string table content. After this, the contents will never change.
32380b57cec5SDimitry Andric   builder.finalize();
32390b57cec5SDimitry Andric 
32400b57cec5SDimitry Andric   // finalize() fixed tail-optimized strings, so we can now get
32410b57cec5SDimitry Andric   // offsets of strings. Get an offset for each string and save it
32420b57cec5SDimitry Andric   // to a corresponding SectionPiece for easy access.
32430b57cec5SDimitry Andric   for (MergeInputSection *sec : sections)
32440b57cec5SDimitry Andric     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
32450b57cec5SDimitry Andric       if (sec->pieces[i].live)
32460b57cec5SDimitry Andric         sec->pieces[i].outputOff = builder.getOffset(sec->getData(i));
32470b57cec5SDimitry Andric }
32480b57cec5SDimitry Andric 
32490b57cec5SDimitry Andric void MergeNoTailSection::writeTo(uint8_t *buf) {
32500b57cec5SDimitry Andric   for (size_t i = 0; i < numShards; ++i)
32510b57cec5SDimitry Andric     shards[i].write(buf + shardOffsets[i]);
32520b57cec5SDimitry Andric }
32530b57cec5SDimitry Andric 
32540b57cec5SDimitry Andric // This function is very hot (i.e. it can take several seconds to finish)
32550b57cec5SDimitry Andric // because sometimes the number of inputs is in an order of magnitude of
32560b57cec5SDimitry Andric // millions. So, we use multi-threading.
32570b57cec5SDimitry Andric //
32580b57cec5SDimitry Andric // For any strings S and T, we know S is not mergeable with T if S's hash
32590b57cec5SDimitry Andric // value is different from T's. If that's the case, we can safely put S and
32600b57cec5SDimitry Andric // T into different string builders without worrying about merge misses.
32610b57cec5SDimitry Andric // We do it in parallel.
32620b57cec5SDimitry Andric void MergeNoTailSection::finalizeContents() {
32630b57cec5SDimitry Andric   // Initializes string table builders.
32640b57cec5SDimitry Andric   for (size_t i = 0; i < numShards; ++i)
32650b57cec5SDimitry Andric     shards.emplace_back(StringTableBuilder::RAW, alignment);
32660b57cec5SDimitry Andric 
32670b57cec5SDimitry Andric   // Concurrency level. Must be a power of 2 to avoid expensive modulo
32680b57cec5SDimitry Andric   // operations in the following tight loop.
32695ffd83dbSDimitry Andric   size_t concurrency = PowerOf2Floor(
32705ffd83dbSDimitry Andric       std::min<size_t>(hardware_concurrency(parallel::strategy.ThreadsRequested)
32715ffd83dbSDimitry Andric                            .compute_thread_count(),
32725ffd83dbSDimitry Andric                        numShards));
32730b57cec5SDimitry Andric 
32740b57cec5SDimitry Andric   // Add section pieces to the builders.
32750b57cec5SDimitry Andric   parallelForEachN(0, concurrency, [&](size_t threadId) {
32760b57cec5SDimitry Andric     for (MergeInputSection *sec : sections) {
32770b57cec5SDimitry Andric       for (size_t i = 0, e = sec->pieces.size(); i != e; ++i) {
32780b57cec5SDimitry Andric         if (!sec->pieces[i].live)
32790b57cec5SDimitry Andric           continue;
32800b57cec5SDimitry Andric         size_t shardId = getShardId(sec->pieces[i].hash);
32810b57cec5SDimitry Andric         if ((shardId & (concurrency - 1)) == threadId)
32820b57cec5SDimitry Andric           sec->pieces[i].outputOff = shards[shardId].add(sec->getData(i));
32830b57cec5SDimitry Andric       }
32840b57cec5SDimitry Andric     }
32850b57cec5SDimitry Andric   });
32860b57cec5SDimitry Andric 
32870b57cec5SDimitry Andric   // Compute an in-section offset for each shard.
32880b57cec5SDimitry Andric   size_t off = 0;
32890b57cec5SDimitry Andric   for (size_t i = 0; i < numShards; ++i) {
32900b57cec5SDimitry Andric     shards[i].finalizeInOrder();
32910b57cec5SDimitry Andric     if (shards[i].getSize() > 0)
32920b57cec5SDimitry Andric       off = alignTo(off, alignment);
32930b57cec5SDimitry Andric     shardOffsets[i] = off;
32940b57cec5SDimitry Andric     off += shards[i].getSize();
32950b57cec5SDimitry Andric   }
32960b57cec5SDimitry Andric   size = off;
32970b57cec5SDimitry Andric 
32980b57cec5SDimitry Andric   // So far, section pieces have offsets from beginning of shards, but
32990b57cec5SDimitry Andric   // we want offsets from beginning of the whole section. Fix them.
33000b57cec5SDimitry Andric   parallelForEach(sections, [&](MergeInputSection *sec) {
33010b57cec5SDimitry Andric     for (size_t i = 0, e = sec->pieces.size(); i != e; ++i)
33020b57cec5SDimitry Andric       if (sec->pieces[i].live)
33030b57cec5SDimitry Andric         sec->pieces[i].outputOff +=
33040b57cec5SDimitry Andric             shardOffsets[getShardId(sec->pieces[i].hash)];
33050b57cec5SDimitry Andric   });
33060b57cec5SDimitry Andric }
33070b57cec5SDimitry Andric 
33085ffd83dbSDimitry Andric MergeSyntheticSection *elf::createMergeSynthetic(StringRef name, uint32_t type,
33090b57cec5SDimitry Andric                                                  uint64_t flags,
33100b57cec5SDimitry Andric                                                  uint32_t alignment) {
33110b57cec5SDimitry Andric   bool shouldTailMerge = (flags & SHF_STRINGS) && config->optimize >= 2;
33120b57cec5SDimitry Andric   if (shouldTailMerge)
33130b57cec5SDimitry Andric     return make<MergeTailSection>(name, type, flags, alignment);
33140b57cec5SDimitry Andric   return make<MergeNoTailSection>(name, type, flags, alignment);
33150b57cec5SDimitry Andric }
33160b57cec5SDimitry Andric 
33175ffd83dbSDimitry Andric template <class ELFT> void elf::splitSections() {
33185ffd83dbSDimitry Andric   llvm::TimeTraceScope timeScope("Split sections");
33190b57cec5SDimitry Andric   // splitIntoPieces needs to be called on each MergeInputSection
33200b57cec5SDimitry Andric   // before calling finalizeContents().
33210b57cec5SDimitry Andric   parallelForEach(inputSections, [](InputSectionBase *sec) {
33220b57cec5SDimitry Andric     if (auto *s = dyn_cast<MergeInputSection>(sec))
33230b57cec5SDimitry Andric       s->splitIntoPieces();
33240b57cec5SDimitry Andric     else if (auto *eh = dyn_cast<EhInputSection>(sec))
33250b57cec5SDimitry Andric       eh->split<ELFT>();
33260b57cec5SDimitry Andric   });
33270b57cec5SDimitry Andric }
33280b57cec5SDimitry Andric 
33290b57cec5SDimitry Andric MipsRldMapSection::MipsRldMapSection()
33300b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, config->wordsize,
33310b57cec5SDimitry Andric                        ".rld_map") {}
33320b57cec5SDimitry Andric 
33330b57cec5SDimitry Andric ARMExidxSyntheticSection::ARMExidxSyntheticSection()
33340b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_LINK_ORDER, SHT_ARM_EXIDX,
33350b57cec5SDimitry Andric                        config->wordsize, ".ARM.exidx") {}
33360b57cec5SDimitry Andric 
33370b57cec5SDimitry Andric static InputSection *findExidxSection(InputSection *isec) {
33380b57cec5SDimitry Andric   for (InputSection *d : isec->dependentSections)
33395ffd83dbSDimitry Andric     if (d->type == SHT_ARM_EXIDX && d->isLive())
33400b57cec5SDimitry Andric       return d;
33410b57cec5SDimitry Andric   return nullptr;
33420b57cec5SDimitry Andric }
33430b57cec5SDimitry Andric 
334485868e8aSDimitry Andric static bool isValidExidxSectionDep(InputSection *isec) {
334585868e8aSDimitry Andric   return (isec->flags & SHF_ALLOC) && (isec->flags & SHF_EXECINSTR) &&
334685868e8aSDimitry Andric          isec->getSize() > 0;
334785868e8aSDimitry Andric }
334885868e8aSDimitry Andric 
33490b57cec5SDimitry Andric bool ARMExidxSyntheticSection::addSection(InputSection *isec) {
33500b57cec5SDimitry Andric   if (isec->type == SHT_ARM_EXIDX) {
335185868e8aSDimitry Andric     if (InputSection *dep = isec->getLinkOrderDep())
33525ffd83dbSDimitry Andric       if (isValidExidxSectionDep(dep)) {
33530b57cec5SDimitry Andric         exidxSections.push_back(isec);
33545ffd83dbSDimitry Andric         // Every exidxSection is 8 bytes, we need an estimate of
33555ffd83dbSDimitry Andric         // size before assignAddresses can be called. Final size
33565ffd83dbSDimitry Andric         // will only be known after finalize is called.
33575ffd83dbSDimitry Andric         size += 8;
33585ffd83dbSDimitry Andric       }
33590b57cec5SDimitry Andric     return true;
33600b57cec5SDimitry Andric   }
33610b57cec5SDimitry Andric 
336285868e8aSDimitry Andric   if (isValidExidxSectionDep(isec)) {
33630b57cec5SDimitry Andric     executableSections.push_back(isec);
33640b57cec5SDimitry Andric     return false;
33650b57cec5SDimitry Andric   }
33660b57cec5SDimitry Andric 
33670b57cec5SDimitry Andric   // FIXME: we do not output a relocation section when --emit-relocs is used
33680b57cec5SDimitry Andric   // as we do not have relocation sections for linker generated table entries
33690b57cec5SDimitry Andric   // and we would have to erase at a late stage relocations from merged entries.
33700b57cec5SDimitry Andric   // Given that exception tables are already position independent and a binary
33710b57cec5SDimitry Andric   // analyzer could derive the relocations we choose to erase the relocations.
33720b57cec5SDimitry Andric   if (config->emitRelocs && isec->type == SHT_REL)
33730b57cec5SDimitry Andric     if (InputSectionBase *ex = isec->getRelocatedSection())
33740b57cec5SDimitry Andric       if (isa<InputSection>(ex) && ex->type == SHT_ARM_EXIDX)
33750b57cec5SDimitry Andric         return true;
33760b57cec5SDimitry Andric 
33770b57cec5SDimitry Andric   return false;
33780b57cec5SDimitry Andric }
33790b57cec5SDimitry Andric 
33800b57cec5SDimitry Andric // References to .ARM.Extab Sections have bit 31 clear and are not the
33810b57cec5SDimitry Andric // special EXIDX_CANTUNWIND bit-pattern.
33820b57cec5SDimitry Andric static bool isExtabRef(uint32_t unwind) {
33830b57cec5SDimitry Andric   return (unwind & 0x80000000) == 0 && unwind != 0x1;
33840b57cec5SDimitry Andric }
33850b57cec5SDimitry Andric 
33860b57cec5SDimitry Andric // Return true if the .ARM.exidx section Cur can be merged into the .ARM.exidx
33870b57cec5SDimitry Andric // section Prev, where Cur follows Prev in the table. This can be done if the
33880b57cec5SDimitry Andric // unwinding instructions in Cur are identical to Prev. Linker generated
33890b57cec5SDimitry Andric // EXIDX_CANTUNWIND entries are represented by nullptr as they do not have an
33900b57cec5SDimitry Andric // InputSection.
33910b57cec5SDimitry Andric static bool isDuplicateArmExidxSec(InputSection *prev, InputSection *cur) {
33920b57cec5SDimitry Andric 
33930b57cec5SDimitry Andric   struct ExidxEntry {
33940b57cec5SDimitry Andric     ulittle32_t fn;
33950b57cec5SDimitry Andric     ulittle32_t unwind;
33960b57cec5SDimitry Andric   };
33970b57cec5SDimitry Andric   // Get the last table Entry from the previous .ARM.exidx section. If Prev is
33980b57cec5SDimitry Andric   // nullptr then it will be a synthesized EXIDX_CANTUNWIND entry.
33990b57cec5SDimitry Andric   ExidxEntry prevEntry = {ulittle32_t(0), ulittle32_t(1)};
34000b57cec5SDimitry Andric   if (prev)
34010b57cec5SDimitry Andric     prevEntry = prev->getDataAs<ExidxEntry>().back();
34020b57cec5SDimitry Andric   if (isExtabRef(prevEntry.unwind))
34030b57cec5SDimitry Andric     return false;
34040b57cec5SDimitry Andric 
34050b57cec5SDimitry Andric   // We consider the unwind instructions of an .ARM.exidx table entry
34060b57cec5SDimitry Andric   // a duplicate if the previous unwind instructions if:
34070b57cec5SDimitry Andric   // - Both are the special EXIDX_CANTUNWIND.
34080b57cec5SDimitry Andric   // - Both are the same inline unwind instructions.
34090b57cec5SDimitry Andric   // We do not attempt to follow and check links into .ARM.extab tables as
34100b57cec5SDimitry Andric   // consecutive identical entries are rare and the effort to check that they
34110b57cec5SDimitry Andric   // are identical is high.
34120b57cec5SDimitry Andric 
34130b57cec5SDimitry Andric   // If Cur is nullptr then this is synthesized EXIDX_CANTUNWIND entry.
34140b57cec5SDimitry Andric   if (cur == nullptr)
34150b57cec5SDimitry Andric     return prevEntry.unwind == 1;
34160b57cec5SDimitry Andric 
34170b57cec5SDimitry Andric   for (const ExidxEntry entry : cur->getDataAs<ExidxEntry>())
34180b57cec5SDimitry Andric     if (isExtabRef(entry.unwind) || entry.unwind != prevEntry.unwind)
34190b57cec5SDimitry Andric       return false;
34200b57cec5SDimitry Andric 
34210b57cec5SDimitry Andric   // All table entries in this .ARM.exidx Section can be merged into the
34220b57cec5SDimitry Andric   // previous Section.
34230b57cec5SDimitry Andric   return true;
34240b57cec5SDimitry Andric }
34250b57cec5SDimitry Andric 
34260b57cec5SDimitry Andric // The .ARM.exidx table must be sorted in ascending order of the address of the
34270b57cec5SDimitry Andric // functions the table describes. Optionally duplicate adjacent table entries
34280b57cec5SDimitry Andric // can be removed. At the end of the function the executableSections must be
34290b57cec5SDimitry Andric // sorted in ascending order of address, Sentinel is set to the InputSection
34300b57cec5SDimitry Andric // with the highest address and any InputSections that have mergeable
34310b57cec5SDimitry Andric // .ARM.exidx table entries are removed from it.
34320b57cec5SDimitry Andric void ARMExidxSyntheticSection::finalizeContents() {
343385868e8aSDimitry Andric   // The executableSections and exidxSections that we use to derive the final
343485868e8aSDimitry Andric   // contents of this SyntheticSection are populated before
343585868e8aSDimitry Andric   // processSectionCommands() and ICF. A /DISCARD/ entry in SECTIONS command or
343685868e8aSDimitry Andric   // ICF may remove executable InputSections and their dependent .ARM.exidx
343785868e8aSDimitry Andric   // section that we recorded earlier.
34380b57cec5SDimitry Andric   auto isDiscarded = [](const InputSection *isec) { return !isec->isLive(); };
34390b57cec5SDimitry Andric   llvm::erase_if(exidxSections, isDiscarded);
34405ffd83dbSDimitry Andric   // We need to remove discarded InputSections and InputSections without
34415ffd83dbSDimitry Andric   // .ARM.exidx sections that if we generated the .ARM.exidx it would be out
34425ffd83dbSDimitry Andric   // of range.
34435ffd83dbSDimitry Andric   auto isDiscardedOrOutOfRange = [this](InputSection *isec) {
34445ffd83dbSDimitry Andric     if (!isec->isLive())
34455ffd83dbSDimitry Andric       return true;
34465ffd83dbSDimitry Andric     if (findExidxSection(isec))
34475ffd83dbSDimitry Andric       return false;
34485ffd83dbSDimitry Andric     int64_t off = static_cast<int64_t>(isec->getVA() - getVA());
34495ffd83dbSDimitry Andric     return off != llvm::SignExtend64(off, 31);
34505ffd83dbSDimitry Andric   };
34515ffd83dbSDimitry Andric   llvm::erase_if(executableSections, isDiscardedOrOutOfRange);
34520b57cec5SDimitry Andric 
34530b57cec5SDimitry Andric   // Sort the executable sections that may or may not have associated
34540b57cec5SDimitry Andric   // .ARM.exidx sections by order of ascending address. This requires the
34555ffd83dbSDimitry Andric   // relative positions of InputSections and OutputSections to be known.
34560b57cec5SDimitry Andric   auto compareByFilePosition = [](const InputSection *a,
34570b57cec5SDimitry Andric                                   const InputSection *b) {
34580b57cec5SDimitry Andric     OutputSection *aOut = a->getParent();
34590b57cec5SDimitry Andric     OutputSection *bOut = b->getParent();
34600b57cec5SDimitry Andric 
34610b57cec5SDimitry Andric     if (aOut != bOut)
34625ffd83dbSDimitry Andric       return aOut->addr < bOut->addr;
34630b57cec5SDimitry Andric     return a->outSecOff < b->outSecOff;
34640b57cec5SDimitry Andric   };
34650b57cec5SDimitry Andric   llvm::stable_sort(executableSections, compareByFilePosition);
34660b57cec5SDimitry Andric   sentinel = executableSections.back();
34670b57cec5SDimitry Andric   // Optionally merge adjacent duplicate entries.
34680b57cec5SDimitry Andric   if (config->mergeArmExidx) {
34690b57cec5SDimitry Andric     std::vector<InputSection *> selectedSections;
34700b57cec5SDimitry Andric     selectedSections.reserve(executableSections.size());
34710b57cec5SDimitry Andric     selectedSections.push_back(executableSections[0]);
34720b57cec5SDimitry Andric     size_t prev = 0;
34730b57cec5SDimitry Andric     for (size_t i = 1; i < executableSections.size(); ++i) {
34740b57cec5SDimitry Andric       InputSection *ex1 = findExidxSection(executableSections[prev]);
34750b57cec5SDimitry Andric       InputSection *ex2 = findExidxSection(executableSections[i]);
34760b57cec5SDimitry Andric       if (!isDuplicateArmExidxSec(ex1, ex2)) {
34770b57cec5SDimitry Andric         selectedSections.push_back(executableSections[i]);
34780b57cec5SDimitry Andric         prev = i;
34790b57cec5SDimitry Andric       }
34800b57cec5SDimitry Andric     }
34810b57cec5SDimitry Andric     executableSections = std::move(selectedSections);
34820b57cec5SDimitry Andric   }
34830b57cec5SDimitry Andric 
34840b57cec5SDimitry Andric   size_t offset = 0;
34850b57cec5SDimitry Andric   size = 0;
34860b57cec5SDimitry Andric   for (InputSection *isec : executableSections) {
34870b57cec5SDimitry Andric     if (InputSection *d = findExidxSection(isec)) {
34880b57cec5SDimitry Andric       d->outSecOff = offset;
34890b57cec5SDimitry Andric       d->parent = getParent();
34900b57cec5SDimitry Andric       offset += d->getSize();
34910b57cec5SDimitry Andric     } else {
34920b57cec5SDimitry Andric       offset += 8;
34930b57cec5SDimitry Andric     }
34940b57cec5SDimitry Andric   }
34950b57cec5SDimitry Andric   // Size includes Sentinel.
34960b57cec5SDimitry Andric   size = offset + 8;
34970b57cec5SDimitry Andric }
34980b57cec5SDimitry Andric 
34990b57cec5SDimitry Andric InputSection *ARMExidxSyntheticSection::getLinkOrderDep() const {
35000b57cec5SDimitry Andric   return executableSections.front();
35010b57cec5SDimitry Andric }
35020b57cec5SDimitry Andric 
35030b57cec5SDimitry Andric // To write the .ARM.exidx table from the ExecutableSections we have three cases
35040b57cec5SDimitry Andric // 1.) The InputSection has a .ARM.exidx InputSection in its dependent sections.
35050b57cec5SDimitry Andric //     We write the .ARM.exidx section contents and apply its relocations.
35060b57cec5SDimitry Andric // 2.) The InputSection does not have a dependent .ARM.exidx InputSection. We
35070b57cec5SDimitry Andric //     must write the contents of an EXIDX_CANTUNWIND directly. We use the
35080b57cec5SDimitry Andric //     start of the InputSection as the purpose of the linker generated
35090b57cec5SDimitry Andric //     section is to terminate the address range of the previous entry.
35100b57cec5SDimitry Andric // 3.) A trailing EXIDX_CANTUNWIND sentinel section is required at the end of
35110b57cec5SDimitry Andric //     the table to terminate the address range of the final entry.
35120b57cec5SDimitry Andric void ARMExidxSyntheticSection::writeTo(uint8_t *buf) {
35130b57cec5SDimitry Andric 
35140b57cec5SDimitry Andric   const uint8_t cantUnwindData[8] = {0, 0, 0, 0,  // PREL31 to target
35150b57cec5SDimitry Andric                                      1, 0, 0, 0}; // EXIDX_CANTUNWIND
35160b57cec5SDimitry Andric 
35170b57cec5SDimitry Andric   uint64_t offset = 0;
35180b57cec5SDimitry Andric   for (InputSection *isec : executableSections) {
35190b57cec5SDimitry Andric     assert(isec->getParent() != nullptr);
35200b57cec5SDimitry Andric     if (InputSection *d = findExidxSection(isec)) {
35210b57cec5SDimitry Andric       memcpy(buf + offset, d->data().data(), d->data().size());
3522e8d8bef9SDimitry Andric       d->relocateAlloc(buf + d->outSecOff, buf + d->outSecOff + d->getSize());
35230b57cec5SDimitry Andric       offset += d->getSize();
35240b57cec5SDimitry Andric     } else {
35250b57cec5SDimitry Andric       // A Linker generated CANTUNWIND section.
35260b57cec5SDimitry Andric       memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
35270b57cec5SDimitry Andric       uint64_t s = isec->getVA();
35280b57cec5SDimitry Andric       uint64_t p = getVA() + offset;
35295ffd83dbSDimitry Andric       target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
35300b57cec5SDimitry Andric       offset += 8;
35310b57cec5SDimitry Andric     }
35320b57cec5SDimitry Andric   }
35330b57cec5SDimitry Andric   // Write Sentinel.
35340b57cec5SDimitry Andric   memcpy(buf + offset, cantUnwindData, sizeof(cantUnwindData));
35350b57cec5SDimitry Andric   uint64_t s = sentinel->getVA(sentinel->getSize());
35360b57cec5SDimitry Andric   uint64_t p = getVA() + offset;
35375ffd83dbSDimitry Andric   target->relocateNoSym(buf + offset, R_ARM_PREL31, s - p);
35380b57cec5SDimitry Andric   assert(size == offset + 8);
35390b57cec5SDimitry Andric }
35400b57cec5SDimitry Andric 
354185868e8aSDimitry Andric bool ARMExidxSyntheticSection::isNeeded() const {
354285868e8aSDimitry Andric   return llvm::find_if(exidxSections, [](InputSection *isec) {
354385868e8aSDimitry Andric            return isec->isLive();
354485868e8aSDimitry Andric          }) != exidxSections.end();
354585868e8aSDimitry Andric }
354685868e8aSDimitry Andric 
35470b57cec5SDimitry Andric bool ARMExidxSyntheticSection::classof(const SectionBase *d) {
35480b57cec5SDimitry Andric   return d->kind() == InputSectionBase::Synthetic && d->type == SHT_ARM_EXIDX;
35490b57cec5SDimitry Andric }
35500b57cec5SDimitry Andric 
35510b57cec5SDimitry Andric ThunkSection::ThunkSection(OutputSection *os, uint64_t off)
3552e8d8bef9SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_EXECINSTR, SHT_PROGBITS,
3553e8d8bef9SDimitry Andric                        config->emachine == EM_PPC64 ? 16 : 4, ".text.thunk") {
35540b57cec5SDimitry Andric   this->parent = os;
35550b57cec5SDimitry Andric   this->outSecOff = off;
35560b57cec5SDimitry Andric }
35570b57cec5SDimitry Andric 
3558480093f4SDimitry Andric size_t ThunkSection::getSize() const {
355913138422SDimitry Andric   if (roundUpSizeForErrata)
3560480093f4SDimitry Andric     return alignTo(size, 4096);
3561480093f4SDimitry Andric   return size;
3562480093f4SDimitry Andric }
3563480093f4SDimitry Andric 
35640b57cec5SDimitry Andric void ThunkSection::addThunk(Thunk *t) {
35650b57cec5SDimitry Andric   thunks.push_back(t);
35660b57cec5SDimitry Andric   t->addSymbols(*this);
35670b57cec5SDimitry Andric }
35680b57cec5SDimitry Andric 
35690b57cec5SDimitry Andric void ThunkSection::writeTo(uint8_t *buf) {
35700b57cec5SDimitry Andric   for (Thunk *t : thunks)
35710b57cec5SDimitry Andric     t->writeTo(buf + t->offset);
35720b57cec5SDimitry Andric }
35730b57cec5SDimitry Andric 
35740b57cec5SDimitry Andric InputSection *ThunkSection::getTargetInputSection() const {
35750b57cec5SDimitry Andric   if (thunks.empty())
35760b57cec5SDimitry Andric     return nullptr;
35770b57cec5SDimitry Andric   const Thunk *t = thunks.front();
35780b57cec5SDimitry Andric   return t->getTargetInputSection();
35790b57cec5SDimitry Andric }
35800b57cec5SDimitry Andric 
35810b57cec5SDimitry Andric bool ThunkSection::assignOffsets() {
35820b57cec5SDimitry Andric   uint64_t off = 0;
35830b57cec5SDimitry Andric   for (Thunk *t : thunks) {
35840b57cec5SDimitry Andric     off = alignTo(off, t->alignment);
35850b57cec5SDimitry Andric     t->setOffset(off);
35860b57cec5SDimitry Andric     uint32_t size = t->size();
35870b57cec5SDimitry Andric     t->getThunkTargetSym()->size = size;
35880b57cec5SDimitry Andric     off += size;
35890b57cec5SDimitry Andric   }
35900b57cec5SDimitry Andric   bool changed = off != size;
35910b57cec5SDimitry Andric   size = off;
35920b57cec5SDimitry Andric   return changed;
35930b57cec5SDimitry Andric }
35940b57cec5SDimitry Andric 
35950b57cec5SDimitry Andric PPC32Got2Section::PPC32Got2Section()
35960b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE, SHT_PROGBITS, 4, ".got2") {}
35970b57cec5SDimitry Andric 
35980b57cec5SDimitry Andric bool PPC32Got2Section::isNeeded() const {
35990b57cec5SDimitry Andric   // See the comment below. This is not needed if there is no other
36000b57cec5SDimitry Andric   // InputSection.
36010b57cec5SDimitry Andric   for (BaseCommand *base : getParent()->sectionCommands)
36020b57cec5SDimitry Andric     if (auto *isd = dyn_cast<InputSectionDescription>(base))
36030b57cec5SDimitry Andric       for (InputSection *isec : isd->sections)
36040b57cec5SDimitry Andric         if (isec != this)
36050b57cec5SDimitry Andric           return true;
36060b57cec5SDimitry Andric   return false;
36070b57cec5SDimitry Andric }
36080b57cec5SDimitry Andric 
36090b57cec5SDimitry Andric void PPC32Got2Section::finalizeContents() {
36100b57cec5SDimitry Andric   // PPC32 may create multiple GOT sections for -fPIC/-fPIE, one per file in
36110b57cec5SDimitry Andric   // .got2 . This function computes outSecOff of each .got2 to be used in
36120b57cec5SDimitry Andric   // PPC32PltCallStub::writeTo(). The purpose of this empty synthetic section is
36130b57cec5SDimitry Andric   // to collect input sections named ".got2".
36140b57cec5SDimitry Andric   uint32_t offset = 0;
36150b57cec5SDimitry Andric   for (BaseCommand *base : getParent()->sectionCommands)
36160b57cec5SDimitry Andric     if (auto *isd = dyn_cast<InputSectionDescription>(base)) {
36170b57cec5SDimitry Andric       for (InputSection *isec : isd->sections) {
36180b57cec5SDimitry Andric         if (isec == this)
36190b57cec5SDimitry Andric           continue;
36200b57cec5SDimitry Andric         isec->file->ppc32Got2OutSecOff = offset;
36210b57cec5SDimitry Andric         offset += (uint32_t)isec->getSize();
36220b57cec5SDimitry Andric       }
36230b57cec5SDimitry Andric     }
36240b57cec5SDimitry Andric }
36250b57cec5SDimitry Andric 
36260b57cec5SDimitry Andric // If linking position-dependent code then the table will store the addresses
36270b57cec5SDimitry Andric // directly in the binary so the section has type SHT_PROGBITS. If linking
36280b57cec5SDimitry Andric // position-independent code the section has type SHT_NOBITS since it will be
36290b57cec5SDimitry Andric // allocated and filled in by the dynamic linker.
36300b57cec5SDimitry Andric PPC64LongBranchTargetSection::PPC64LongBranchTargetSection()
36310b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC | SHF_WRITE,
36320b57cec5SDimitry Andric                        config->isPic ? SHT_NOBITS : SHT_PROGBITS, 8,
36330b57cec5SDimitry Andric                        ".branch_lt") {}
36340b57cec5SDimitry Andric 
3635480093f4SDimitry Andric uint64_t PPC64LongBranchTargetSection::getEntryVA(const Symbol *sym,
3636480093f4SDimitry Andric                                                   int64_t addend) {
3637480093f4SDimitry Andric   return getVA() + entry_index.find({sym, addend})->second * 8;
3638480093f4SDimitry Andric }
3639480093f4SDimitry Andric 
3640480093f4SDimitry Andric Optional<uint32_t> PPC64LongBranchTargetSection::addEntry(const Symbol *sym,
3641480093f4SDimitry Andric                                                           int64_t addend) {
3642480093f4SDimitry Andric   auto res =
3643480093f4SDimitry Andric       entry_index.try_emplace(std::make_pair(sym, addend), entries.size());
3644480093f4SDimitry Andric   if (!res.second)
3645480093f4SDimitry Andric     return None;
3646480093f4SDimitry Andric   entries.emplace_back(sym, addend);
3647480093f4SDimitry Andric   return res.first->second;
36480b57cec5SDimitry Andric }
36490b57cec5SDimitry Andric 
36500b57cec5SDimitry Andric size_t PPC64LongBranchTargetSection::getSize() const {
36510b57cec5SDimitry Andric   return entries.size() * 8;
36520b57cec5SDimitry Andric }
36530b57cec5SDimitry Andric 
36540b57cec5SDimitry Andric void PPC64LongBranchTargetSection::writeTo(uint8_t *buf) {
36550b57cec5SDimitry Andric   // If linking non-pic we have the final addresses of the targets and they get
36560b57cec5SDimitry Andric   // written to the table directly. For pic the dynamic linker will allocate
36570b57cec5SDimitry Andric   // the section and fill it it.
36580b57cec5SDimitry Andric   if (config->isPic)
36590b57cec5SDimitry Andric     return;
36600b57cec5SDimitry Andric 
3661480093f4SDimitry Andric   for (auto entry : entries) {
3662480093f4SDimitry Andric     const Symbol *sym = entry.first;
3663480093f4SDimitry Andric     int64_t addend = entry.second;
36640b57cec5SDimitry Andric     assert(sym->getVA());
36650b57cec5SDimitry Andric     // Need calls to branch to the local entry-point since a long-branch
36660b57cec5SDimitry Andric     // must be a local-call.
3667480093f4SDimitry Andric     write64(buf, sym->getVA(addend) +
3668480093f4SDimitry Andric                      getPPC64GlobalEntryToLocalEntryOffset(sym->stOther));
36690b57cec5SDimitry Andric     buf += 8;
36700b57cec5SDimitry Andric   }
36710b57cec5SDimitry Andric }
36720b57cec5SDimitry Andric 
36730b57cec5SDimitry Andric bool PPC64LongBranchTargetSection::isNeeded() const {
36740b57cec5SDimitry Andric   // `removeUnusedSyntheticSections()` is called before thunk allocation which
36750b57cec5SDimitry Andric   // is too early to determine if this section will be empty or not. We need
36760b57cec5SDimitry Andric   // Finalized to keep the section alive until after thunk creation. Finalized
36770b57cec5SDimitry Andric   // only gets set to true once `finalizeSections()` is called after thunk
3678480093f4SDimitry Andric   // creation. Because of this, if we don't create any long-branch thunks we end
36790b57cec5SDimitry Andric   // up with an empty .branch_lt section in the binary.
36800b57cec5SDimitry Andric   return !finalized || !entries.empty();
36810b57cec5SDimitry Andric }
36820b57cec5SDimitry Andric 
36830b57cec5SDimitry Andric static uint8_t getAbiVersion() {
36840b57cec5SDimitry Andric   // MIPS non-PIC executable gets ABI version 1.
36850b57cec5SDimitry Andric   if (config->emachine == EM_MIPS) {
36860b57cec5SDimitry Andric     if (!config->isPic && !config->relocatable &&
36870b57cec5SDimitry Andric         (config->eflags & (EF_MIPS_PIC | EF_MIPS_CPIC)) == EF_MIPS_CPIC)
36880b57cec5SDimitry Andric       return 1;
36890b57cec5SDimitry Andric     return 0;
36900b57cec5SDimitry Andric   }
36910b57cec5SDimitry Andric 
36920b57cec5SDimitry Andric   if (config->emachine == EM_AMDGPU) {
36930b57cec5SDimitry Andric     uint8_t ver = objectFiles[0]->abiVersion;
36940b57cec5SDimitry Andric     for (InputFile *file : makeArrayRef(objectFiles).slice(1))
36950b57cec5SDimitry Andric       if (file->abiVersion != ver)
36960b57cec5SDimitry Andric         error("incompatible ABI version: " + toString(file));
36970b57cec5SDimitry Andric     return ver;
36980b57cec5SDimitry Andric   }
36990b57cec5SDimitry Andric 
37000b57cec5SDimitry Andric   return 0;
37010b57cec5SDimitry Andric }
37020b57cec5SDimitry Andric 
37035ffd83dbSDimitry Andric template <typename ELFT> void elf::writeEhdr(uint8_t *buf, Partition &part) {
37040b57cec5SDimitry Andric   // For executable segments, the trap instructions are written before writing
37050b57cec5SDimitry Andric   // the header. Setting Elf header bytes to zero ensures that any unused bytes
37060b57cec5SDimitry Andric   // in header are zero-cleared, instead of having trap instructions.
37070b57cec5SDimitry Andric   memset(buf, 0, sizeof(typename ELFT::Ehdr));
37080b57cec5SDimitry Andric   memcpy(buf, "\177ELF", 4);
37090b57cec5SDimitry Andric 
37100b57cec5SDimitry Andric   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
37110b57cec5SDimitry Andric   eHdr->e_ident[EI_CLASS] = config->is64 ? ELFCLASS64 : ELFCLASS32;
37120b57cec5SDimitry Andric   eHdr->e_ident[EI_DATA] = config->isLE ? ELFDATA2LSB : ELFDATA2MSB;
37130b57cec5SDimitry Andric   eHdr->e_ident[EI_VERSION] = EV_CURRENT;
37140b57cec5SDimitry Andric   eHdr->e_ident[EI_OSABI] = config->osabi;
37150b57cec5SDimitry Andric   eHdr->e_ident[EI_ABIVERSION] = getAbiVersion();
37160b57cec5SDimitry Andric   eHdr->e_machine = config->emachine;
37170b57cec5SDimitry Andric   eHdr->e_version = EV_CURRENT;
37180b57cec5SDimitry Andric   eHdr->e_flags = config->eflags;
37190b57cec5SDimitry Andric   eHdr->e_ehsize = sizeof(typename ELFT::Ehdr);
37200b57cec5SDimitry Andric   eHdr->e_phnum = part.phdrs.size();
37210b57cec5SDimitry Andric   eHdr->e_shentsize = sizeof(typename ELFT::Shdr);
37220b57cec5SDimitry Andric 
37230b57cec5SDimitry Andric   if (!config->relocatable) {
37240b57cec5SDimitry Andric     eHdr->e_phoff = sizeof(typename ELFT::Ehdr);
37250b57cec5SDimitry Andric     eHdr->e_phentsize = sizeof(typename ELFT::Phdr);
37260b57cec5SDimitry Andric   }
37270b57cec5SDimitry Andric }
37280b57cec5SDimitry Andric 
37295ffd83dbSDimitry Andric template <typename ELFT> void elf::writePhdrs(uint8_t *buf, Partition &part) {
37300b57cec5SDimitry Andric   // Write the program header table.
37310b57cec5SDimitry Andric   auto *hBuf = reinterpret_cast<typename ELFT::Phdr *>(buf);
37320b57cec5SDimitry Andric   for (PhdrEntry *p : part.phdrs) {
37330b57cec5SDimitry Andric     hBuf->p_type = p->p_type;
37340b57cec5SDimitry Andric     hBuf->p_flags = p->p_flags;
37350b57cec5SDimitry Andric     hBuf->p_offset = p->p_offset;
37360b57cec5SDimitry Andric     hBuf->p_vaddr = p->p_vaddr;
37370b57cec5SDimitry Andric     hBuf->p_paddr = p->p_paddr;
37380b57cec5SDimitry Andric     hBuf->p_filesz = p->p_filesz;
37390b57cec5SDimitry Andric     hBuf->p_memsz = p->p_memsz;
37400b57cec5SDimitry Andric     hBuf->p_align = p->p_align;
37410b57cec5SDimitry Andric     ++hBuf;
37420b57cec5SDimitry Andric   }
37430b57cec5SDimitry Andric }
37440b57cec5SDimitry Andric 
37450b57cec5SDimitry Andric template <typename ELFT>
37460b57cec5SDimitry Andric PartitionElfHeaderSection<ELFT>::PartitionElfHeaderSection()
37470b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_EHDR, 1, "") {}
37480b57cec5SDimitry Andric 
37490b57cec5SDimitry Andric template <typename ELFT>
37500b57cec5SDimitry Andric size_t PartitionElfHeaderSection<ELFT>::getSize() const {
37510b57cec5SDimitry Andric   return sizeof(typename ELFT::Ehdr);
37520b57cec5SDimitry Andric }
37530b57cec5SDimitry Andric 
37540b57cec5SDimitry Andric template <typename ELFT>
37550b57cec5SDimitry Andric void PartitionElfHeaderSection<ELFT>::writeTo(uint8_t *buf) {
37560b57cec5SDimitry Andric   writeEhdr<ELFT>(buf, getPartition());
37570b57cec5SDimitry Andric 
37580b57cec5SDimitry Andric   // Loadable partitions are always ET_DYN.
37590b57cec5SDimitry Andric   auto *eHdr = reinterpret_cast<typename ELFT::Ehdr *>(buf);
37600b57cec5SDimitry Andric   eHdr->e_type = ET_DYN;
37610b57cec5SDimitry Andric }
37620b57cec5SDimitry Andric 
37630b57cec5SDimitry Andric template <typename ELFT>
37640b57cec5SDimitry Andric PartitionProgramHeadersSection<ELFT>::PartitionProgramHeadersSection()
37650b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_LLVM_PART_PHDR, 1, ".phdrs") {}
37660b57cec5SDimitry Andric 
37670b57cec5SDimitry Andric template <typename ELFT>
37680b57cec5SDimitry Andric size_t PartitionProgramHeadersSection<ELFT>::getSize() const {
37690b57cec5SDimitry Andric   return sizeof(typename ELFT::Phdr) * getPartition().phdrs.size();
37700b57cec5SDimitry Andric }
37710b57cec5SDimitry Andric 
37720b57cec5SDimitry Andric template <typename ELFT>
37730b57cec5SDimitry Andric void PartitionProgramHeadersSection<ELFT>::writeTo(uint8_t *buf) {
37740b57cec5SDimitry Andric   writePhdrs<ELFT>(buf, getPartition());
37750b57cec5SDimitry Andric }
37760b57cec5SDimitry Andric 
37770b57cec5SDimitry Andric PartitionIndexSection::PartitionIndexSection()
37780b57cec5SDimitry Andric     : SyntheticSection(SHF_ALLOC, SHT_PROGBITS, 4, ".rodata") {}
37790b57cec5SDimitry Andric 
37800b57cec5SDimitry Andric size_t PartitionIndexSection::getSize() const {
37810b57cec5SDimitry Andric   return 12 * (partitions.size() - 1);
37820b57cec5SDimitry Andric }
37830b57cec5SDimitry Andric 
37840b57cec5SDimitry Andric void PartitionIndexSection::finalizeContents() {
37850b57cec5SDimitry Andric   for (size_t i = 1; i != partitions.size(); ++i)
37860b57cec5SDimitry Andric     partitions[i].nameStrTab = mainPart->dynStrTab->addString(partitions[i].name);
37870b57cec5SDimitry Andric }
37880b57cec5SDimitry Andric 
37890b57cec5SDimitry Andric void PartitionIndexSection::writeTo(uint8_t *buf) {
37900b57cec5SDimitry Andric   uint64_t va = getVA();
37910b57cec5SDimitry Andric   for (size_t i = 1; i != partitions.size(); ++i) {
37920b57cec5SDimitry Andric     write32(buf, mainPart->dynStrTab->getVA() + partitions[i].nameStrTab - va);
37930b57cec5SDimitry Andric     write32(buf + 4, partitions[i].elfHeader->getVA() - (va + 4));
37940b57cec5SDimitry Andric 
37950b57cec5SDimitry Andric     SyntheticSection *next =
37960b57cec5SDimitry Andric         i == partitions.size() - 1 ? in.partEnd : partitions[i + 1].elfHeader;
37970b57cec5SDimitry Andric     write32(buf + 8, next->getVA() - partitions[i].elfHeader->getVA());
37980b57cec5SDimitry Andric 
37990b57cec5SDimitry Andric     va += 12;
38000b57cec5SDimitry Andric     buf += 12;
38010b57cec5SDimitry Andric   }
38020b57cec5SDimitry Andric }
38030b57cec5SDimitry Andric 
38045ffd83dbSDimitry Andric InStruct elf::in;
38050b57cec5SDimitry Andric 
38065ffd83dbSDimitry Andric std::vector<Partition> elf::partitions;
38075ffd83dbSDimitry Andric Partition *elf::mainPart;
38080b57cec5SDimitry Andric 
38090b57cec5SDimitry Andric template GdbIndexSection *GdbIndexSection::create<ELF32LE>();
38100b57cec5SDimitry Andric template GdbIndexSection *GdbIndexSection::create<ELF32BE>();
38110b57cec5SDimitry Andric template GdbIndexSection *GdbIndexSection::create<ELF64LE>();
38120b57cec5SDimitry Andric template GdbIndexSection *GdbIndexSection::create<ELF64BE>();
38130b57cec5SDimitry Andric 
38145ffd83dbSDimitry Andric template void elf::splitSections<ELF32LE>();
38155ffd83dbSDimitry Andric template void elf::splitSections<ELF32BE>();
38165ffd83dbSDimitry Andric template void elf::splitSections<ELF64LE>();
38175ffd83dbSDimitry Andric template void elf::splitSections<ELF64BE>();
38180b57cec5SDimitry Andric 
38195ffd83dbSDimitry Andric template class elf::MipsAbiFlagsSection<ELF32LE>;
38205ffd83dbSDimitry Andric template class elf::MipsAbiFlagsSection<ELF32BE>;
38215ffd83dbSDimitry Andric template class elf::MipsAbiFlagsSection<ELF64LE>;
38225ffd83dbSDimitry Andric template class elf::MipsAbiFlagsSection<ELF64BE>;
38230b57cec5SDimitry Andric 
38245ffd83dbSDimitry Andric template class elf::MipsOptionsSection<ELF32LE>;
38255ffd83dbSDimitry Andric template class elf::MipsOptionsSection<ELF32BE>;
38265ffd83dbSDimitry Andric template class elf::MipsOptionsSection<ELF64LE>;
38275ffd83dbSDimitry Andric template class elf::MipsOptionsSection<ELF64BE>;
38280b57cec5SDimitry Andric 
3829e8d8bef9SDimitry Andric template void EhFrameSection::iterateFDEWithLSDA<ELF32LE>(
3830e8d8bef9SDimitry Andric     function_ref<void(InputSection &)>);
3831e8d8bef9SDimitry Andric template void EhFrameSection::iterateFDEWithLSDA<ELF32BE>(
3832e8d8bef9SDimitry Andric     function_ref<void(InputSection &)>);
3833e8d8bef9SDimitry Andric template void EhFrameSection::iterateFDEWithLSDA<ELF64LE>(
3834e8d8bef9SDimitry Andric     function_ref<void(InputSection &)>);
3835e8d8bef9SDimitry Andric template void EhFrameSection::iterateFDEWithLSDA<ELF64BE>(
3836e8d8bef9SDimitry Andric     function_ref<void(InputSection &)>);
3837e8d8bef9SDimitry Andric 
38385ffd83dbSDimitry Andric template class elf::MipsReginfoSection<ELF32LE>;
38395ffd83dbSDimitry Andric template class elf::MipsReginfoSection<ELF32BE>;
38405ffd83dbSDimitry Andric template class elf::MipsReginfoSection<ELF64LE>;
38415ffd83dbSDimitry Andric template class elf::MipsReginfoSection<ELF64BE>;
38420b57cec5SDimitry Andric 
38435ffd83dbSDimitry Andric template class elf::DynamicSection<ELF32LE>;
38445ffd83dbSDimitry Andric template class elf::DynamicSection<ELF32BE>;
38455ffd83dbSDimitry Andric template class elf::DynamicSection<ELF64LE>;
38465ffd83dbSDimitry Andric template class elf::DynamicSection<ELF64BE>;
38470b57cec5SDimitry Andric 
38485ffd83dbSDimitry Andric template class elf::RelocationSection<ELF32LE>;
38495ffd83dbSDimitry Andric template class elf::RelocationSection<ELF32BE>;
38505ffd83dbSDimitry Andric template class elf::RelocationSection<ELF64LE>;
38515ffd83dbSDimitry Andric template class elf::RelocationSection<ELF64BE>;
38520b57cec5SDimitry Andric 
38535ffd83dbSDimitry Andric template class elf::AndroidPackedRelocationSection<ELF32LE>;
38545ffd83dbSDimitry Andric template class elf::AndroidPackedRelocationSection<ELF32BE>;
38555ffd83dbSDimitry Andric template class elf::AndroidPackedRelocationSection<ELF64LE>;
38565ffd83dbSDimitry Andric template class elf::AndroidPackedRelocationSection<ELF64BE>;
38570b57cec5SDimitry Andric 
38585ffd83dbSDimitry Andric template class elf::RelrSection<ELF32LE>;
38595ffd83dbSDimitry Andric template class elf::RelrSection<ELF32BE>;
38605ffd83dbSDimitry Andric template class elf::RelrSection<ELF64LE>;
38615ffd83dbSDimitry Andric template class elf::RelrSection<ELF64BE>;
38620b57cec5SDimitry Andric 
38635ffd83dbSDimitry Andric template class elf::SymbolTableSection<ELF32LE>;
38645ffd83dbSDimitry Andric template class elf::SymbolTableSection<ELF32BE>;
38655ffd83dbSDimitry Andric template class elf::SymbolTableSection<ELF64LE>;
38665ffd83dbSDimitry Andric template class elf::SymbolTableSection<ELF64BE>;
38670b57cec5SDimitry Andric 
38685ffd83dbSDimitry Andric template class elf::VersionNeedSection<ELF32LE>;
38695ffd83dbSDimitry Andric template class elf::VersionNeedSection<ELF32BE>;
38705ffd83dbSDimitry Andric template class elf::VersionNeedSection<ELF64LE>;
38715ffd83dbSDimitry Andric template class elf::VersionNeedSection<ELF64BE>;
38720b57cec5SDimitry Andric 
38735ffd83dbSDimitry Andric template void elf::writeEhdr<ELF32LE>(uint8_t *Buf, Partition &Part);
38745ffd83dbSDimitry Andric template void elf::writeEhdr<ELF32BE>(uint8_t *Buf, Partition &Part);
38755ffd83dbSDimitry Andric template void elf::writeEhdr<ELF64LE>(uint8_t *Buf, Partition &Part);
38765ffd83dbSDimitry Andric template void elf::writeEhdr<ELF64BE>(uint8_t *Buf, Partition &Part);
38770b57cec5SDimitry Andric 
38785ffd83dbSDimitry Andric template void elf::writePhdrs<ELF32LE>(uint8_t *Buf, Partition &Part);
38795ffd83dbSDimitry Andric template void elf::writePhdrs<ELF32BE>(uint8_t *Buf, Partition &Part);
38805ffd83dbSDimitry Andric template void elf::writePhdrs<ELF64LE>(uint8_t *Buf, Partition &Part);
38815ffd83dbSDimitry Andric template void elf::writePhdrs<ELF64BE>(uint8_t *Buf, Partition &Part);
38820b57cec5SDimitry Andric 
38835ffd83dbSDimitry Andric template class elf::PartitionElfHeaderSection<ELF32LE>;
38845ffd83dbSDimitry Andric template class elf::PartitionElfHeaderSection<ELF32BE>;
38855ffd83dbSDimitry Andric template class elf::PartitionElfHeaderSection<ELF64LE>;
38865ffd83dbSDimitry Andric template class elf::PartitionElfHeaderSection<ELF64BE>;
38870b57cec5SDimitry Andric 
38885ffd83dbSDimitry Andric template class elf::PartitionProgramHeadersSection<ELF32LE>;
38895ffd83dbSDimitry Andric template class elf::PartitionProgramHeadersSection<ELF32BE>;
38905ffd83dbSDimitry Andric template class elf::PartitionProgramHeadersSection<ELF64LE>;
38915ffd83dbSDimitry Andric template class elf::PartitionProgramHeadersSection<ELF64BE>;
3892