106f32e7eSjoerg //===- ELF.cpp - ELF object file implementation ---------------------------===//
206f32e7eSjoerg //
306f32e7eSjoerg // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
406f32e7eSjoerg // See https://llvm.org/LICENSE.txt for license information.
506f32e7eSjoerg // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
606f32e7eSjoerg //
706f32e7eSjoerg //===----------------------------------------------------------------------===//
806f32e7eSjoerg 
906f32e7eSjoerg #include "llvm/Object/ELF.h"
1006f32e7eSjoerg #include "llvm/BinaryFormat/ELF.h"
11*da58b97aSjoerg #include "llvm/Support/DataExtractor.h"
1206f32e7eSjoerg 
1306f32e7eSjoerg using namespace llvm;
1406f32e7eSjoerg using namespace object;
1506f32e7eSjoerg 
1606f32e7eSjoerg #define STRINGIFY_ENUM_CASE(ns, name)                                          \
1706f32e7eSjoerg   case ns::name:                                                               \
1806f32e7eSjoerg     return #name;
1906f32e7eSjoerg 
2006f32e7eSjoerg #define ELF_RELOC(name, value) STRINGIFY_ENUM_CASE(ELF, name)
2106f32e7eSjoerg 
getELFRelocationTypeName(uint32_t Machine,uint32_t Type)2206f32e7eSjoerg StringRef llvm::object::getELFRelocationTypeName(uint32_t Machine,
2306f32e7eSjoerg                                                  uint32_t Type) {
2406f32e7eSjoerg   switch (Machine) {
25*da58b97aSjoerg   case ELF::EM_68K:
26*da58b97aSjoerg     switch (Type) {
27*da58b97aSjoerg #include "llvm/BinaryFormat/ELFRelocs/M68k.def"
28*da58b97aSjoerg     default:
29*da58b97aSjoerg       break;
30*da58b97aSjoerg     }
31*da58b97aSjoerg     break;
3206f32e7eSjoerg   case ELF::EM_X86_64:
3306f32e7eSjoerg     switch (Type) {
3406f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/x86_64.def"
3506f32e7eSjoerg     default:
3606f32e7eSjoerg       break;
3706f32e7eSjoerg     }
3806f32e7eSjoerg     break;
3906f32e7eSjoerg   case ELF::EM_386:
4006f32e7eSjoerg   case ELF::EM_IAMCU:
4106f32e7eSjoerg     switch (Type) {
4206f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/i386.def"
4306f32e7eSjoerg     default:
4406f32e7eSjoerg       break;
4506f32e7eSjoerg     }
4606f32e7eSjoerg     break;
4706f32e7eSjoerg   case ELF::EM_MIPS:
4806f32e7eSjoerg     switch (Type) {
4906f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/Mips.def"
5006f32e7eSjoerg     default:
5106f32e7eSjoerg       break;
5206f32e7eSjoerg     }
5306f32e7eSjoerg     break;
5406f32e7eSjoerg   case ELF::EM_AARCH64:
5506f32e7eSjoerg     switch (Type) {
5606f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/AArch64.def"
5706f32e7eSjoerg     default:
5806f32e7eSjoerg       break;
5906f32e7eSjoerg     }
6006f32e7eSjoerg     break;
6106f32e7eSjoerg   case ELF::EM_ARM:
6206f32e7eSjoerg     switch (Type) {
6306f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/ARM.def"
6406f32e7eSjoerg     default:
6506f32e7eSjoerg       break;
6606f32e7eSjoerg     }
6706f32e7eSjoerg     break;
6806f32e7eSjoerg   case ELF::EM_ARC_COMPACT:
6906f32e7eSjoerg   case ELF::EM_ARC_COMPACT2:
7006f32e7eSjoerg     switch (Type) {
7106f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/ARC.def"
7206f32e7eSjoerg     default:
7306f32e7eSjoerg       break;
7406f32e7eSjoerg     }
7506f32e7eSjoerg     break;
7606f32e7eSjoerg   case ELF::EM_AVR:
7706f32e7eSjoerg     switch (Type) {
7806f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/AVR.def"
7906f32e7eSjoerg     default:
8006f32e7eSjoerg       break;
8106f32e7eSjoerg     }
8206f32e7eSjoerg     break;
8306f32e7eSjoerg   case ELF::EM_HEXAGON:
8406f32e7eSjoerg     switch (Type) {
8506f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/Hexagon.def"
8606f32e7eSjoerg     default:
8706f32e7eSjoerg       break;
8806f32e7eSjoerg     }
8906f32e7eSjoerg     break;
9006f32e7eSjoerg   case ELF::EM_LANAI:
9106f32e7eSjoerg     switch (Type) {
9206f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/Lanai.def"
9306f32e7eSjoerg     default:
9406f32e7eSjoerg       break;
9506f32e7eSjoerg     }
9606f32e7eSjoerg     break;
9706f32e7eSjoerg   case ELF::EM_PPC:
9806f32e7eSjoerg     switch (Type) {
9906f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/PowerPC.def"
10006f32e7eSjoerg     default:
10106f32e7eSjoerg       break;
10206f32e7eSjoerg     }
10306f32e7eSjoerg     break;
10406f32e7eSjoerg   case ELF::EM_PPC64:
10506f32e7eSjoerg     switch (Type) {
10606f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/PowerPC64.def"
10706f32e7eSjoerg     default:
10806f32e7eSjoerg       break;
10906f32e7eSjoerg     }
11006f32e7eSjoerg     break;
11106f32e7eSjoerg   case ELF::EM_RISCV:
11206f32e7eSjoerg     switch (Type) {
11306f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/RISCV.def"
11406f32e7eSjoerg     default:
11506f32e7eSjoerg       break;
11606f32e7eSjoerg     }
11706f32e7eSjoerg     break;
11806f32e7eSjoerg   case ELF::EM_S390:
11906f32e7eSjoerg     switch (Type) {
12006f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/SystemZ.def"
12106f32e7eSjoerg     default:
12206f32e7eSjoerg       break;
12306f32e7eSjoerg     }
12406f32e7eSjoerg     break;
12506f32e7eSjoerg   case ELF::EM_SPARC:
12606f32e7eSjoerg   case ELF::EM_SPARC32PLUS:
12706f32e7eSjoerg   case ELF::EM_SPARCV9:
12806f32e7eSjoerg     switch (Type) {
12906f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/Sparc.def"
13006f32e7eSjoerg     default:
13106f32e7eSjoerg       break;
13206f32e7eSjoerg     }
13306f32e7eSjoerg     break;
13406f32e7eSjoerg   case ELF::EM_AMDGPU:
13506f32e7eSjoerg     switch (Type) {
13606f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/AMDGPU.def"
13706f32e7eSjoerg     default:
13806f32e7eSjoerg       break;
13906f32e7eSjoerg     }
14006f32e7eSjoerg     break;
14106f32e7eSjoerg   case ELF::EM_BPF:
14206f32e7eSjoerg     switch (Type) {
14306f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/BPF.def"
14406f32e7eSjoerg     default:
14506f32e7eSjoerg       break;
14606f32e7eSjoerg     }
14706f32e7eSjoerg     break;
14806f32e7eSjoerg   case ELF::EM_MSP430:
14906f32e7eSjoerg     switch (Type) {
15006f32e7eSjoerg #include "llvm/BinaryFormat/ELFRelocs/MSP430.def"
15106f32e7eSjoerg     default:
15206f32e7eSjoerg       break;
15306f32e7eSjoerg     }
15406f32e7eSjoerg     break;
155*da58b97aSjoerg   case ELF::EM_VE:
156*da58b97aSjoerg     switch (Type) {
157*da58b97aSjoerg #include "llvm/BinaryFormat/ELFRelocs/VE.def"
158*da58b97aSjoerg     default:
159*da58b97aSjoerg       break;
160*da58b97aSjoerg     }
161*da58b97aSjoerg     break;
162*da58b97aSjoerg   case ELF::EM_CSKY:
163*da58b97aSjoerg     switch (Type) {
164*da58b97aSjoerg #include "llvm/BinaryFormat/ELFRelocs/CSKY.def"
165*da58b97aSjoerg     default:
166*da58b97aSjoerg       break;
167*da58b97aSjoerg     }
168*da58b97aSjoerg     break;
16906f32e7eSjoerg   default:
17006f32e7eSjoerg     break;
17106f32e7eSjoerg   }
17206f32e7eSjoerg   return "Unknown";
17306f32e7eSjoerg }
17406f32e7eSjoerg 
17506f32e7eSjoerg #undef ELF_RELOC
17606f32e7eSjoerg 
getELFRelativeRelocationType(uint32_t Machine)17706f32e7eSjoerg uint32_t llvm::object::getELFRelativeRelocationType(uint32_t Machine) {
17806f32e7eSjoerg   switch (Machine) {
17906f32e7eSjoerg   case ELF::EM_X86_64:
18006f32e7eSjoerg     return ELF::R_X86_64_RELATIVE;
18106f32e7eSjoerg   case ELF::EM_386:
18206f32e7eSjoerg   case ELF::EM_IAMCU:
18306f32e7eSjoerg     return ELF::R_386_RELATIVE;
18406f32e7eSjoerg   case ELF::EM_MIPS:
18506f32e7eSjoerg     break;
18606f32e7eSjoerg   case ELF::EM_AARCH64:
18706f32e7eSjoerg     return ELF::R_AARCH64_RELATIVE;
18806f32e7eSjoerg   case ELF::EM_ARM:
18906f32e7eSjoerg     return ELF::R_ARM_RELATIVE;
19006f32e7eSjoerg   case ELF::EM_ARC_COMPACT:
19106f32e7eSjoerg   case ELF::EM_ARC_COMPACT2:
19206f32e7eSjoerg     return ELF::R_ARC_RELATIVE;
19306f32e7eSjoerg   case ELF::EM_AVR:
19406f32e7eSjoerg     break;
19506f32e7eSjoerg   case ELF::EM_HEXAGON:
19606f32e7eSjoerg     return ELF::R_HEX_RELATIVE;
19706f32e7eSjoerg   case ELF::EM_LANAI:
19806f32e7eSjoerg     break;
19906f32e7eSjoerg   case ELF::EM_PPC:
20006f32e7eSjoerg     break;
20106f32e7eSjoerg   case ELF::EM_PPC64:
20206f32e7eSjoerg     return ELF::R_PPC64_RELATIVE;
20306f32e7eSjoerg   case ELF::EM_RISCV:
20406f32e7eSjoerg     return ELF::R_RISCV_RELATIVE;
20506f32e7eSjoerg   case ELF::EM_S390:
20606f32e7eSjoerg     return ELF::R_390_RELATIVE;
20706f32e7eSjoerg   case ELF::EM_SPARC:
20806f32e7eSjoerg   case ELF::EM_SPARC32PLUS:
20906f32e7eSjoerg   case ELF::EM_SPARCV9:
21006f32e7eSjoerg     return ELF::R_SPARC_RELATIVE;
211*da58b97aSjoerg   case ELF::EM_CSKY:
212*da58b97aSjoerg     return ELF::R_CKCORE_RELATIVE;
21306f32e7eSjoerg   case ELF::EM_AMDGPU:
21406f32e7eSjoerg     break;
21506f32e7eSjoerg   case ELF::EM_BPF:
21606f32e7eSjoerg     break;
21706f32e7eSjoerg   default:
21806f32e7eSjoerg     break;
21906f32e7eSjoerg   }
22006f32e7eSjoerg   return 0;
22106f32e7eSjoerg }
22206f32e7eSjoerg 
getELFSectionTypeName(uint32_t Machine,unsigned Type)22306f32e7eSjoerg StringRef llvm::object::getELFSectionTypeName(uint32_t Machine, unsigned Type) {
22406f32e7eSjoerg   switch (Machine) {
22506f32e7eSjoerg   case ELF::EM_ARM:
22606f32e7eSjoerg     switch (Type) {
22706f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_ARM_EXIDX);
22806f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_ARM_PREEMPTMAP);
22906f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_ARM_ATTRIBUTES);
23006f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_ARM_DEBUGOVERLAY);
23106f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_ARM_OVERLAYSECTION);
23206f32e7eSjoerg     }
23306f32e7eSjoerg     break;
23406f32e7eSjoerg   case ELF::EM_HEXAGON:
23506f32e7eSjoerg     switch (Type) { STRINGIFY_ENUM_CASE(ELF, SHT_HEX_ORDERED); }
23606f32e7eSjoerg     break;
23706f32e7eSjoerg   case ELF::EM_X86_64:
23806f32e7eSjoerg     switch (Type) { STRINGIFY_ENUM_CASE(ELF, SHT_X86_64_UNWIND); }
23906f32e7eSjoerg     break;
24006f32e7eSjoerg   case ELF::EM_MIPS:
24106f32e7eSjoerg   case ELF::EM_MIPS_RS3_LE:
24206f32e7eSjoerg     switch (Type) {
24306f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_MIPS_REGINFO);
24406f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_MIPS_OPTIONS);
24506f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_MIPS_DWARF);
24606f32e7eSjoerg       STRINGIFY_ENUM_CASE(ELF, SHT_MIPS_ABIFLAGS);
24706f32e7eSjoerg     }
24806f32e7eSjoerg     break;
249*da58b97aSjoerg   case ELF::EM_RISCV:
250*da58b97aSjoerg     switch (Type) { STRINGIFY_ENUM_CASE(ELF, SHT_RISCV_ATTRIBUTES); }
251*da58b97aSjoerg     break;
25206f32e7eSjoerg   default:
25306f32e7eSjoerg     break;
25406f32e7eSjoerg   }
25506f32e7eSjoerg 
25606f32e7eSjoerg   switch (Type) {
25706f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_NULL);
25806f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_PROGBITS);
25906f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_SYMTAB);
26006f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_STRTAB);
26106f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_RELA);
26206f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_HASH);
26306f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_DYNAMIC);
26406f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_NOTE);
26506f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_NOBITS);
26606f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_REL);
26706f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_SHLIB);
26806f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_DYNSYM);
26906f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_INIT_ARRAY);
27006f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_FINI_ARRAY);
27106f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_PREINIT_ARRAY);
27206f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GROUP);
27306f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_SYMTAB_SHNDX);
27406f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_RELR);
27506f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_ANDROID_REL);
27606f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_ANDROID_RELA);
27706f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_ANDROID_RELR);
27806f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_ODRTAB);
27906f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_LINKER_OPTIONS);
28006f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_CALL_GRAPH_PROFILE);
28106f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_ADDRSIG);
28206f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_DEPENDENT_LIBRARIES);
28306f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_SYMPART);
28406f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_PART_EHDR);
28506f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_PART_PHDR);
286*da58b97aSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_BB_ADDR_MAP);
28706f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GNU_ATTRIBUTES);
28806f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GNU_HASH);
28906f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GNU_verdef);
29006f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GNU_verneed);
29106f32e7eSjoerg     STRINGIFY_ENUM_CASE(ELF, SHT_GNU_versym);
29206f32e7eSjoerg   default:
29306f32e7eSjoerg     return "Unknown";
29406f32e7eSjoerg   }
29506f32e7eSjoerg }
29606f32e7eSjoerg 
29706f32e7eSjoerg template <class ELFT>
298*da58b97aSjoerg std::vector<typename ELFT::Rel>
decode_relrs(Elf_Relr_Range relrs) const29906f32e7eSjoerg ELFFile<ELFT>::decode_relrs(Elf_Relr_Range relrs) const {
30006f32e7eSjoerg   // This function decodes the contents of an SHT_RELR packed relocation
30106f32e7eSjoerg   // section.
30206f32e7eSjoerg   //
30306f32e7eSjoerg   // Proposal for adding SHT_RELR sections to generic-abi is here:
30406f32e7eSjoerg   //   https://groups.google.com/forum/#!topic/generic-abi/bX460iggiKg
30506f32e7eSjoerg   //
30606f32e7eSjoerg   // The encoded sequence of Elf64_Relr entries in a SHT_RELR section looks
30706f32e7eSjoerg   // like [ AAAAAAAA BBBBBBB1 BBBBBBB1 ... AAAAAAAA BBBBBB1 ... ]
30806f32e7eSjoerg   //
30906f32e7eSjoerg   // i.e. start with an address, followed by any number of bitmaps. The address
31006f32e7eSjoerg   // entry encodes 1 relocation. The subsequent bitmap entries encode up to 63
31106f32e7eSjoerg   // relocations each, at subsequent offsets following the last address entry.
31206f32e7eSjoerg   //
31306f32e7eSjoerg   // The bitmap entries must have 1 in the least significant bit. The assumption
31406f32e7eSjoerg   // here is that an address cannot have 1 in lsb. Odd addresses are not
31506f32e7eSjoerg   // supported.
31606f32e7eSjoerg   //
31706f32e7eSjoerg   // Excluding the least significant bit in the bitmap, each non-zero bit in
31806f32e7eSjoerg   // the bitmap represents a relocation to be applied to a corresponding machine
31906f32e7eSjoerg   // word that follows the base address word. The second least significant bit
32006f32e7eSjoerg   // represents the machine word immediately following the initial address, and
32106f32e7eSjoerg   // each bit that follows represents the next word, in linear order. As such,
32206f32e7eSjoerg   // a single bitmap can encode up to 31 relocations in a 32-bit object, and
32306f32e7eSjoerg   // 63 relocations in a 64-bit object.
32406f32e7eSjoerg   //
32506f32e7eSjoerg   // This encoding has a couple of interesting properties:
32606f32e7eSjoerg   // 1. Looking at any entry, it is clear whether it's an address or a bitmap:
32706f32e7eSjoerg   //    even means address, odd means bitmap.
32806f32e7eSjoerg   // 2. Just a simple list of addresses is a valid encoding.
32906f32e7eSjoerg 
330*da58b97aSjoerg   Elf_Rel Rel;
331*da58b97aSjoerg   Rel.r_info = 0;
332*da58b97aSjoerg   Rel.setType(getRelativeRelocationType(), false);
333*da58b97aSjoerg   std::vector<Elf_Rel> Relocs;
33406f32e7eSjoerg 
33506f32e7eSjoerg   // Word type: uint32_t for Elf32, and uint64_t for Elf64.
33606f32e7eSjoerg   typedef typename ELFT::uint Word;
33706f32e7eSjoerg 
33806f32e7eSjoerg   // Word size in number of bytes.
33906f32e7eSjoerg   const size_t WordSize = sizeof(Word);
34006f32e7eSjoerg 
34106f32e7eSjoerg   // Number of bits used for the relocation offsets bitmap.
34206f32e7eSjoerg   // These many relative relocations can be encoded in a single entry.
34306f32e7eSjoerg   const size_t NBits = 8*WordSize - 1;
34406f32e7eSjoerg 
34506f32e7eSjoerg   Word Base = 0;
34606f32e7eSjoerg   for (const Elf_Relr &R : relrs) {
34706f32e7eSjoerg     Word Entry = R;
34806f32e7eSjoerg     if ((Entry&1) == 0) {
34906f32e7eSjoerg       // Even entry: encodes the offset for next relocation.
350*da58b97aSjoerg       Rel.r_offset = Entry;
351*da58b97aSjoerg       Relocs.push_back(Rel);
35206f32e7eSjoerg       // Set base offset for subsequent bitmap entries.
35306f32e7eSjoerg       Base = Entry + WordSize;
35406f32e7eSjoerg       continue;
35506f32e7eSjoerg     }
35606f32e7eSjoerg 
35706f32e7eSjoerg     // Odd entry: encodes bitmap for relocations starting at base.
35806f32e7eSjoerg     Word Offset = Base;
35906f32e7eSjoerg     while (Entry != 0) {
36006f32e7eSjoerg       Entry >>= 1;
36106f32e7eSjoerg       if ((Entry&1) != 0) {
362*da58b97aSjoerg         Rel.r_offset = Offset;
363*da58b97aSjoerg         Relocs.push_back(Rel);
36406f32e7eSjoerg       }
36506f32e7eSjoerg       Offset += WordSize;
36606f32e7eSjoerg     }
36706f32e7eSjoerg 
36806f32e7eSjoerg     // Advance base offset by NBits words.
36906f32e7eSjoerg     Base += NBits * WordSize;
37006f32e7eSjoerg   }
37106f32e7eSjoerg 
37206f32e7eSjoerg   return Relocs;
37306f32e7eSjoerg }
37406f32e7eSjoerg 
37506f32e7eSjoerg template <class ELFT>
37606f32e7eSjoerg Expected<std::vector<typename ELFT::Rela>>
android_relas(const Elf_Shdr & Sec) const377*da58b97aSjoerg ELFFile<ELFT>::android_relas(const Elf_Shdr &Sec) const {
37806f32e7eSjoerg   // This function reads relocations in Android's packed relocation format,
37906f32e7eSjoerg   // which is based on SLEB128 and delta encoding.
38006f32e7eSjoerg   Expected<ArrayRef<uint8_t>> ContentsOrErr = getSectionContents(Sec);
38106f32e7eSjoerg   if (!ContentsOrErr)
38206f32e7eSjoerg     return ContentsOrErr.takeError();
383*da58b97aSjoerg   ArrayRef<uint8_t> Content = *ContentsOrErr;
384*da58b97aSjoerg   if (Content.size() < 4 || Content[0] != 'A' || Content[1] != 'P' ||
385*da58b97aSjoerg       Content[2] != 'S' || Content[3] != '2')
38606f32e7eSjoerg     return createError("invalid packed relocation header");
387*da58b97aSjoerg   DataExtractor Data(Content, isLE(), ELFT::Is64Bits ? 8 : 4);
388*da58b97aSjoerg   DataExtractor::Cursor Cur(/*Offset=*/4);
38906f32e7eSjoerg 
390*da58b97aSjoerg   uint64_t NumRelocs = Data.getSLEB128(Cur);
391*da58b97aSjoerg   uint64_t Offset = Data.getSLEB128(Cur);
39206f32e7eSjoerg   uint64_t Addend = 0;
39306f32e7eSjoerg 
394*da58b97aSjoerg   if (!Cur)
395*da58b97aSjoerg     return std::move(Cur.takeError());
39606f32e7eSjoerg 
39706f32e7eSjoerg   std::vector<Elf_Rela> Relocs;
39806f32e7eSjoerg   Relocs.reserve(NumRelocs);
39906f32e7eSjoerg   while (NumRelocs) {
400*da58b97aSjoerg     uint64_t NumRelocsInGroup = Data.getSLEB128(Cur);
401*da58b97aSjoerg     if (!Cur)
402*da58b97aSjoerg       return std::move(Cur.takeError());
40306f32e7eSjoerg     if (NumRelocsInGroup > NumRelocs)
40406f32e7eSjoerg       return createError("relocation group unexpectedly large");
40506f32e7eSjoerg     NumRelocs -= NumRelocsInGroup;
40606f32e7eSjoerg 
407*da58b97aSjoerg     uint64_t GroupFlags = Data.getSLEB128(Cur);
40806f32e7eSjoerg     bool GroupedByInfo = GroupFlags & ELF::RELOCATION_GROUPED_BY_INFO_FLAG;
40906f32e7eSjoerg     bool GroupedByOffsetDelta = GroupFlags & ELF::RELOCATION_GROUPED_BY_OFFSET_DELTA_FLAG;
41006f32e7eSjoerg     bool GroupedByAddend = GroupFlags & ELF::RELOCATION_GROUPED_BY_ADDEND_FLAG;
41106f32e7eSjoerg     bool GroupHasAddend = GroupFlags & ELF::RELOCATION_GROUP_HAS_ADDEND_FLAG;
41206f32e7eSjoerg 
41306f32e7eSjoerg     uint64_t GroupOffsetDelta;
41406f32e7eSjoerg     if (GroupedByOffsetDelta)
415*da58b97aSjoerg       GroupOffsetDelta = Data.getSLEB128(Cur);
41606f32e7eSjoerg 
41706f32e7eSjoerg     uint64_t GroupRInfo;
41806f32e7eSjoerg     if (GroupedByInfo)
419*da58b97aSjoerg       GroupRInfo = Data.getSLEB128(Cur);
42006f32e7eSjoerg 
42106f32e7eSjoerg     if (GroupedByAddend && GroupHasAddend)
422*da58b97aSjoerg       Addend += Data.getSLEB128(Cur);
42306f32e7eSjoerg 
42406f32e7eSjoerg     if (!GroupHasAddend)
42506f32e7eSjoerg       Addend = 0;
42606f32e7eSjoerg 
427*da58b97aSjoerg     for (uint64_t I = 0; Cur && I != NumRelocsInGroup; ++I) {
42806f32e7eSjoerg       Elf_Rela R;
429*da58b97aSjoerg       Offset += GroupedByOffsetDelta ? GroupOffsetDelta : Data.getSLEB128(Cur);
43006f32e7eSjoerg       R.r_offset = Offset;
431*da58b97aSjoerg       R.r_info = GroupedByInfo ? GroupRInfo : Data.getSLEB128(Cur);
43206f32e7eSjoerg       if (GroupHasAddend && !GroupedByAddend)
433*da58b97aSjoerg         Addend += Data.getSLEB128(Cur);
43406f32e7eSjoerg       R.r_addend = Addend;
43506f32e7eSjoerg       Relocs.push_back(R);
43606f32e7eSjoerg     }
437*da58b97aSjoerg     if (!Cur)
438*da58b97aSjoerg       return std::move(Cur.takeError());
43906f32e7eSjoerg   }
44006f32e7eSjoerg 
44106f32e7eSjoerg   return Relocs;
44206f32e7eSjoerg }
44306f32e7eSjoerg 
44406f32e7eSjoerg template <class ELFT>
getDynamicTagAsString(unsigned Arch,uint64_t Type) const44506f32e7eSjoerg std::string ELFFile<ELFT>::getDynamicTagAsString(unsigned Arch,
44606f32e7eSjoerg                                                  uint64_t Type) const {
44706f32e7eSjoerg #define DYNAMIC_STRINGIFY_ENUM(tag, value)                                     \
44806f32e7eSjoerg   case value:                                                                  \
44906f32e7eSjoerg     return #tag;
45006f32e7eSjoerg 
45106f32e7eSjoerg #define DYNAMIC_TAG(n, v)
45206f32e7eSjoerg   switch (Arch) {
45306f32e7eSjoerg   case ELF::EM_AARCH64:
45406f32e7eSjoerg     switch (Type) {
45506f32e7eSjoerg #define AARCH64_DYNAMIC_TAG(name, value) DYNAMIC_STRINGIFY_ENUM(name, value)
45606f32e7eSjoerg #include "llvm/BinaryFormat/DynamicTags.def"
45706f32e7eSjoerg #undef AARCH64_DYNAMIC_TAG
45806f32e7eSjoerg     }
45906f32e7eSjoerg     break;
46006f32e7eSjoerg 
46106f32e7eSjoerg   case ELF::EM_HEXAGON:
46206f32e7eSjoerg     switch (Type) {
46306f32e7eSjoerg #define HEXAGON_DYNAMIC_TAG(name, value) DYNAMIC_STRINGIFY_ENUM(name, value)
46406f32e7eSjoerg #include "llvm/BinaryFormat/DynamicTags.def"
46506f32e7eSjoerg #undef HEXAGON_DYNAMIC_TAG
46606f32e7eSjoerg     }
46706f32e7eSjoerg     break;
46806f32e7eSjoerg 
46906f32e7eSjoerg   case ELF::EM_MIPS:
47006f32e7eSjoerg     switch (Type) {
47106f32e7eSjoerg #define MIPS_DYNAMIC_TAG(name, value) DYNAMIC_STRINGIFY_ENUM(name, value)
47206f32e7eSjoerg #include "llvm/BinaryFormat/DynamicTags.def"
47306f32e7eSjoerg #undef MIPS_DYNAMIC_TAG
47406f32e7eSjoerg     }
47506f32e7eSjoerg     break;
47606f32e7eSjoerg 
47706f32e7eSjoerg   case ELF::EM_PPC64:
47806f32e7eSjoerg     switch (Type) {
47906f32e7eSjoerg #define PPC64_DYNAMIC_TAG(name, value) DYNAMIC_STRINGIFY_ENUM(name, value)
48006f32e7eSjoerg #include "llvm/BinaryFormat/DynamicTags.def"
48106f32e7eSjoerg #undef PPC64_DYNAMIC_TAG
48206f32e7eSjoerg     }
48306f32e7eSjoerg     break;
48406f32e7eSjoerg   }
48506f32e7eSjoerg #undef DYNAMIC_TAG
48606f32e7eSjoerg   switch (Type) {
48706f32e7eSjoerg // Now handle all dynamic tags except the architecture specific ones
48806f32e7eSjoerg #define AARCH64_DYNAMIC_TAG(name, value)
48906f32e7eSjoerg #define MIPS_DYNAMIC_TAG(name, value)
49006f32e7eSjoerg #define HEXAGON_DYNAMIC_TAG(name, value)
49106f32e7eSjoerg #define PPC64_DYNAMIC_TAG(name, value)
49206f32e7eSjoerg // Also ignore marker tags such as DT_HIOS (maps to DT_VERNEEDNUM), etc.
49306f32e7eSjoerg #define DYNAMIC_TAG_MARKER(name, value)
494*da58b97aSjoerg #define DYNAMIC_TAG(name, value) case value: return #name;
49506f32e7eSjoerg #include "llvm/BinaryFormat/DynamicTags.def"
49606f32e7eSjoerg #undef DYNAMIC_TAG
49706f32e7eSjoerg #undef AARCH64_DYNAMIC_TAG
49806f32e7eSjoerg #undef MIPS_DYNAMIC_TAG
49906f32e7eSjoerg #undef HEXAGON_DYNAMIC_TAG
50006f32e7eSjoerg #undef PPC64_DYNAMIC_TAG
50106f32e7eSjoerg #undef DYNAMIC_TAG_MARKER
50206f32e7eSjoerg #undef DYNAMIC_STRINGIFY_ENUM
50306f32e7eSjoerg   default:
50406f32e7eSjoerg     return "<unknown:>0x" + utohexstr(Type, true);
50506f32e7eSjoerg   }
50606f32e7eSjoerg }
50706f32e7eSjoerg 
50806f32e7eSjoerg template <class ELFT>
getDynamicTagAsString(uint64_t Type) const50906f32e7eSjoerg std::string ELFFile<ELFT>::getDynamicTagAsString(uint64_t Type) const {
510*da58b97aSjoerg   return getDynamicTagAsString(getHeader().e_machine, Type);
51106f32e7eSjoerg }
51206f32e7eSjoerg 
51306f32e7eSjoerg template <class ELFT>
dynamicEntries() const51406f32e7eSjoerg Expected<typename ELFT::DynRange> ELFFile<ELFT>::dynamicEntries() const {
51506f32e7eSjoerg   ArrayRef<Elf_Dyn> Dyn;
51606f32e7eSjoerg 
51706f32e7eSjoerg   auto ProgramHeadersOrError = program_headers();
51806f32e7eSjoerg   if (!ProgramHeadersOrError)
51906f32e7eSjoerg     return ProgramHeadersOrError.takeError();
52006f32e7eSjoerg 
52106f32e7eSjoerg   for (const Elf_Phdr &Phdr : *ProgramHeadersOrError) {
52206f32e7eSjoerg     if (Phdr.p_type == ELF::PT_DYNAMIC) {
52306f32e7eSjoerg       Dyn = makeArrayRef(
52406f32e7eSjoerg           reinterpret_cast<const Elf_Dyn *>(base() + Phdr.p_offset),
52506f32e7eSjoerg           Phdr.p_filesz / sizeof(Elf_Dyn));
52606f32e7eSjoerg       break;
52706f32e7eSjoerg     }
52806f32e7eSjoerg   }
52906f32e7eSjoerg 
53006f32e7eSjoerg   // If we can't find the dynamic section in the program headers, we just fall
53106f32e7eSjoerg   // back on the sections.
53206f32e7eSjoerg   if (Dyn.empty()) {
53306f32e7eSjoerg     auto SectionsOrError = sections();
53406f32e7eSjoerg     if (!SectionsOrError)
53506f32e7eSjoerg       return SectionsOrError.takeError();
53606f32e7eSjoerg 
53706f32e7eSjoerg     for (const Elf_Shdr &Sec : *SectionsOrError) {
53806f32e7eSjoerg       if (Sec.sh_type == ELF::SHT_DYNAMIC) {
53906f32e7eSjoerg         Expected<ArrayRef<Elf_Dyn>> DynOrError =
540*da58b97aSjoerg             getSectionContentsAsArray<Elf_Dyn>(Sec);
54106f32e7eSjoerg         if (!DynOrError)
54206f32e7eSjoerg           return DynOrError.takeError();
54306f32e7eSjoerg         Dyn = *DynOrError;
54406f32e7eSjoerg         break;
54506f32e7eSjoerg       }
54606f32e7eSjoerg     }
54706f32e7eSjoerg 
54806f32e7eSjoerg     if (!Dyn.data())
54906f32e7eSjoerg       return ArrayRef<Elf_Dyn>();
55006f32e7eSjoerg   }
55106f32e7eSjoerg 
55206f32e7eSjoerg   if (Dyn.empty())
55306f32e7eSjoerg     // TODO: this error is untested.
55406f32e7eSjoerg     return createError("invalid empty dynamic section");
55506f32e7eSjoerg 
55606f32e7eSjoerg   if (Dyn.back().d_tag != ELF::DT_NULL)
55706f32e7eSjoerg     // TODO: this error is untested.
55806f32e7eSjoerg     return createError("dynamic sections must be DT_NULL terminated");
55906f32e7eSjoerg 
56006f32e7eSjoerg   return Dyn;
56106f32e7eSjoerg }
56206f32e7eSjoerg 
56306f32e7eSjoerg template <class ELFT>
564*da58b97aSjoerg Expected<const uint8_t *>
toMappedAddr(uint64_t VAddr,WarningHandler WarnHandler) const565*da58b97aSjoerg ELFFile<ELFT>::toMappedAddr(uint64_t VAddr, WarningHandler WarnHandler) const {
56606f32e7eSjoerg   auto ProgramHeadersOrError = program_headers();
56706f32e7eSjoerg   if (!ProgramHeadersOrError)
56806f32e7eSjoerg     return ProgramHeadersOrError.takeError();
56906f32e7eSjoerg 
57006f32e7eSjoerg   llvm::SmallVector<Elf_Phdr *, 4> LoadSegments;
57106f32e7eSjoerg 
57206f32e7eSjoerg   for (const Elf_Phdr &Phdr : *ProgramHeadersOrError)
57306f32e7eSjoerg     if (Phdr.p_type == ELF::PT_LOAD)
57406f32e7eSjoerg       LoadSegments.push_back(const_cast<Elf_Phdr *>(&Phdr));
57506f32e7eSjoerg 
576*da58b97aSjoerg   auto SortPred = [](const Elf_Phdr_Impl<ELFT> *A,
577*da58b97aSjoerg                      const Elf_Phdr_Impl<ELFT> *B) {
578*da58b97aSjoerg     return A->p_vaddr < B->p_vaddr;
579*da58b97aSjoerg   };
580*da58b97aSjoerg   if (!llvm::is_sorted(LoadSegments, SortPred)) {
581*da58b97aSjoerg     if (Error E =
582*da58b97aSjoerg             WarnHandler("loadable segments are unsorted by virtual address"))
583*da58b97aSjoerg       return std::move(E);
584*da58b97aSjoerg     llvm::stable_sort(LoadSegments, SortPred);
585*da58b97aSjoerg   }
586*da58b97aSjoerg 
587*da58b97aSjoerg   const Elf_Phdr *const *I = llvm::upper_bound(
588*da58b97aSjoerg       LoadSegments, VAddr, [](uint64_t VAddr, const Elf_Phdr_Impl<ELFT> *Phdr) {
58906f32e7eSjoerg         return VAddr < Phdr->p_vaddr;
59006f32e7eSjoerg       });
59106f32e7eSjoerg 
59206f32e7eSjoerg   if (I == LoadSegments.begin())
59306f32e7eSjoerg     return createError("virtual address is not in any segment: 0x" +
59406f32e7eSjoerg                        Twine::utohexstr(VAddr));
59506f32e7eSjoerg   --I;
59606f32e7eSjoerg   const Elf_Phdr &Phdr = **I;
59706f32e7eSjoerg   uint64_t Delta = VAddr - Phdr.p_vaddr;
59806f32e7eSjoerg   if (Delta >= Phdr.p_filesz)
59906f32e7eSjoerg     return createError("virtual address is not in any segment: 0x" +
60006f32e7eSjoerg                        Twine::utohexstr(VAddr));
601*da58b97aSjoerg 
602*da58b97aSjoerg   uint64_t Offset = Phdr.p_offset + Delta;
603*da58b97aSjoerg   if (Offset >= getBufSize())
604*da58b97aSjoerg     return createError("can't map virtual address 0x" +
605*da58b97aSjoerg                        Twine::utohexstr(VAddr) + " to the segment with index " +
606*da58b97aSjoerg                        Twine(&Phdr - (*ProgramHeadersOrError).data() + 1) +
607*da58b97aSjoerg                        ": the segment ends at 0x" +
608*da58b97aSjoerg                        Twine::utohexstr(Phdr.p_offset + Phdr.p_filesz) +
609*da58b97aSjoerg                        ", which is greater than the file size (0x" +
610*da58b97aSjoerg                        Twine::utohexstr(getBufSize()) + ")");
611*da58b97aSjoerg 
612*da58b97aSjoerg   return base() + Offset;
613*da58b97aSjoerg }
614*da58b97aSjoerg 
615*da58b97aSjoerg template <class ELFT>
616*da58b97aSjoerg Expected<std::vector<typename ELFT::BBAddrMap>>
decodeBBAddrMap(const Elf_Shdr & Sec) const617*da58b97aSjoerg ELFFile<ELFT>::decodeBBAddrMap(const Elf_Shdr &Sec) const {
618*da58b97aSjoerg   Expected<ArrayRef<uint8_t>> ContentsOrErr = getSectionContents(Sec);
619*da58b97aSjoerg   if (!ContentsOrErr)
620*da58b97aSjoerg     return ContentsOrErr.takeError();
621*da58b97aSjoerg   ArrayRef<uint8_t> Content = *ContentsOrErr;
622*da58b97aSjoerg   DataExtractor Data(Content, isLE(), ELFT::Is64Bits ? 8 : 4);
623*da58b97aSjoerg   std::vector<Elf_BBAddrMap> FunctionEntries;
624*da58b97aSjoerg 
625*da58b97aSjoerg   DataExtractor::Cursor Cur(0);
626*da58b97aSjoerg   Error ULEBSizeErr = Error::success();
627*da58b97aSjoerg 
628*da58b97aSjoerg   // Helper to extract and decode the next ULEB128 value as uint32_t.
629*da58b97aSjoerg   // Returns zero and sets ULEBSizeErr if the ULEB128 value exceeds the uint32_t
630*da58b97aSjoerg   // limit.
631*da58b97aSjoerg   // Also returns zero if ULEBSizeErr is already in an error state.
632*da58b97aSjoerg   auto ReadULEB128AsUInt32 = [&Data, &Cur, &ULEBSizeErr]() -> uint32_t {
633*da58b97aSjoerg     // Bail out and do not extract data if ULEBSizeErr is already set.
634*da58b97aSjoerg     if (ULEBSizeErr)
635*da58b97aSjoerg       return 0;
636*da58b97aSjoerg     uint64_t Offset = Cur.tell();
637*da58b97aSjoerg     uint64_t Value = Data.getULEB128(Cur);
638*da58b97aSjoerg     if (Value > UINT32_MAX) {
639*da58b97aSjoerg       ULEBSizeErr = createError(
640*da58b97aSjoerg           "ULEB128 value at offset 0x" + Twine::utohexstr(Offset) +
641*da58b97aSjoerg           " exceeds UINT32_MAX (0x" + Twine::utohexstr(Value) + ")");
642*da58b97aSjoerg       return 0;
643*da58b97aSjoerg     }
644*da58b97aSjoerg     return static_cast<uint32_t>(Value);
645*da58b97aSjoerg   };
646*da58b97aSjoerg 
647*da58b97aSjoerg   while (!ULEBSizeErr && Cur && Cur.tell() < Content.size()) {
648*da58b97aSjoerg     uintX_t Address = static_cast<uintX_t>(Data.getAddress(Cur));
649*da58b97aSjoerg     uint32_t NumBlocks = ReadULEB128AsUInt32();
650*da58b97aSjoerg     std::vector<typename Elf_BBAddrMap::BBEntry> BBEntries;
651*da58b97aSjoerg     for (uint32_t BlockID = 0; !ULEBSizeErr && Cur && (BlockID < NumBlocks);
652*da58b97aSjoerg          ++BlockID) {
653*da58b97aSjoerg       uint32_t Offset = ReadULEB128AsUInt32();
654*da58b97aSjoerg       uint32_t Size = ReadULEB128AsUInt32();
655*da58b97aSjoerg       uint32_t Metadata = ReadULEB128AsUInt32();
656*da58b97aSjoerg       BBEntries.push_back({Offset, Size, Metadata});
657*da58b97aSjoerg     }
658*da58b97aSjoerg     FunctionEntries.push_back({Address, BBEntries});
659*da58b97aSjoerg   }
660*da58b97aSjoerg   // Either Cur is in the error state, or ULEBSizeError is set (not both), but
661*da58b97aSjoerg   // we join the two errors here to be safe.
662*da58b97aSjoerg   if (!Cur || ULEBSizeErr)
663*da58b97aSjoerg     return joinErrors(Cur.takeError(), std::move(ULEBSizeErr));
664*da58b97aSjoerg   return FunctionEntries;
66506f32e7eSjoerg }
66606f32e7eSjoerg 
66706f32e7eSjoerg template class llvm::object::ELFFile<ELF32LE>;
66806f32e7eSjoerg template class llvm::object::ELFFile<ELF32BE>;
66906f32e7eSjoerg template class llvm::object::ELFFile<ELF64LE>;
67006f32e7eSjoerg template class llvm::object::ELFFile<ELF64BE>;
671