contrib/llvm/include/llvm/Object/ELF.h

   1 //===- ELF.h - ELF object file implementation -------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the ELFFile template class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_ELF_H
  15 #define LLVM_OBJECT_ELF_H
  16
  17 #include "llvm/ADT/ArrayRef.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/Object/ELFTypes.h"
  21 #include "llvm/Object/Error.h"
  22 #include "llvm/Support/ELF.h"
  23 #include "llvm/Support/Endian.h"
  24 #include "llvm/Support/Error.h"
  25 #include <cassert>
  26 #include <cstddef>
  27 #include <cstdint>
  28 #include <limits>
  29 #include <utility>
  30
  31 namespace llvm {
  32 namespace object {
  33
  34 StringRef getELFRelocationTypeName(uint32_t Machine, uint32_t Type);
  35 StringRef getELFSectionTypeName(uint32_t Machine, uint32_t Type);
  36
  37 // Subclasses of ELFFile may need this for template instantiation
  38 inline std::pair<unsigned char, unsigned char>
  39 getElfArchType(StringRef Object) {
  40   if (Object.size() < ELF::EI_NIDENT)
  41     return std::make_pair((uint8_t)ELF::ELFCLASSNONE,
  42                           (uint8_t)ELF::ELFDATANONE);
  43   return std::make_pair((uint8_t)Object[ELF::EI_CLASS],
  44                         (uint8_t)Object[ELF::EI_DATA]);
  45 }
  46
  47 static inline Error createError(StringRef Err) {
  48   return make_error<StringError>(Err, object_error::parse_failed);
  49 }
  50
  51 template <class ELFT>
  52 class ELFFile {
  53 public:
  54   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
  55   using uintX_t = typename ELFT::uint;
  56   using Elf_Ehdr = typename ELFT::Ehdr;
  57   using Elf_Shdr = typename ELFT::Shdr;
  58   using Elf_Sym = typename ELFT::Sym;
  59   using Elf_Dyn = typename ELFT::Dyn;
  60   using Elf_Phdr = typename ELFT::Phdr;
  61   using Elf_Rel = typename ELFT::Rel;
  62   using Elf_Rela = typename ELFT::Rela;
  63   using Elf_Verdef = typename ELFT::Verdef;
  64   using Elf_Verdaux = typename ELFT::Verdaux;
  65   using Elf_Verneed = typename ELFT::Verneed;
  66   using Elf_Vernaux = typename ELFT::Vernaux;
  67   using Elf_Versym = typename ELFT::Versym;
  68   using Elf_Hash = typename ELFT::Hash;
  69   using Elf_GnuHash = typename ELFT::GnuHash;
  70   using Elf_Dyn_Range = typename ELFT::DynRange;
  71   using Elf_Shdr_Range = typename ELFT::ShdrRange;
  72   using Elf_Sym_Range = typename ELFT::SymRange;
  73   using Elf_Rel_Range = typename ELFT::RelRange;
  74   using Elf_Rela_Range = typename ELFT::RelaRange;
  75   using Elf_Phdr_Range = typename ELFT::PhdrRange;
  76
  77   const uint8_t *base() const {
  78     return reinterpret_cast<const uint8_t *>(Buf.data());
  79   }
  80
  81   size_t getBufSize() const { return Buf.size(); }
  82
  83 private:
  84   StringRef Buf;
  85
  86 public:
  87   const Elf_Ehdr *getHeader() const {
  88     return reinterpret_cast<const Elf_Ehdr *>(base());
  89   }
  90
  91   template <typename T>
  92   Expected<const T *> getEntry(uint32_t Section, uint32_t Entry) const;
  93   template <typename T>
  94   Expected<const T *> getEntry(const Elf_Shdr *Section, uint32_t Entry) const;
  95
  96   Expected<StringRef> getStringTable(const Elf_Shdr *Section) const;
  97   Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section) const;
  98   Expected<StringRef> getStringTableForSymtab(const Elf_Shdr &Section,
  99                                               Elf_Shdr_Range Sections) const;
 100
 101   Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section) const;
 102   Expected<ArrayRef<Elf_Word>> getSHNDXTable(const Elf_Shdr &Section,
 103                                              Elf_Shdr_Range Sections) const;
 104
 105   void VerifyStrTab(const Elf_Shdr *sh) const;
 106
 107   StringRef getRelocationTypeName(uint32_t Type) const;
 108   void getRelocationTypeName(uint32_t Type,
 109                              SmallVectorImpl<char> &Result) const;
 110
 111   /// \brief Get the symbol for a given relocation.
 112   Expected<const Elf_Sym *> getRelocationSymbol(const Elf_Rel *Rel,
 113                                                 const Elf_Shdr *SymTab) const;
 114
 115   ELFFile(StringRef Object);
 116
 117   bool isMipsELF64() const {
 118     return getHeader()->e_machine == ELF::EM_MIPS &&
 119            getHeader()->getFileClass() == ELF::ELFCLASS64;
 120   }
 121
 122   bool isMips64EL() const {
 123     return isMipsELF64() &&
 124            getHeader()->getDataEncoding() == ELF::ELFDATA2LSB;
 125   }
 126
 127   Expected<Elf_Shdr_Range> sections() const;
 128
 129   Expected<Elf_Sym_Range> symbols(const Elf_Shdr *Sec) const {
 130     if (!Sec)
 131       return makeArrayRef<Elf_Sym>(nullptr, nullptr);
 132     return getSectionContentsAsArray<Elf_Sym>(Sec);
 133   }
 134
 135   Expected<Elf_Rela_Range> relas(const Elf_Shdr *Sec) const {
 136     return getSectionContentsAsArray<Elf_Rela>(Sec);
 137   }
 138
 139   Expected<Elf_Rel_Range> rels(const Elf_Shdr *Sec) const {
 140     return getSectionContentsAsArray<Elf_Rel>(Sec);
 141   }
 142
 143   /// \brief Iterate over program header table.
 144   Expected<Elf_Phdr_Range> program_headers() const {
 145     if (getHeader()->e_phnum && getHeader()->e_phentsize != sizeof(Elf_Phdr))
 146       return createError("invalid e_phentsize");
 147     auto *Begin =
 148         reinterpret_cast<const Elf_Phdr *>(base() + getHeader()->e_phoff);
 149     return makeArrayRef(Begin, Begin + getHeader()->e_phnum);
 150   }
 151
 152   Expected<StringRef> getSectionStringTable(Elf_Shdr_Range Sections) const;
 153   Expected<uint32_t> getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms,
 154                                      ArrayRef<Elf_Word> ShndxTable) const;
 155   Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym,
 156                                         const Elf_Shdr *SymTab,
 157                                         ArrayRef<Elf_Word> ShndxTable) const;
 158   Expected<const Elf_Shdr *> getSection(const Elf_Sym *Sym,
 159                                         Elf_Sym_Range Symtab,
 160                                         ArrayRef<Elf_Word> ShndxTable) const;
 161   Expected<const Elf_Shdr *> getSection(uint32_t Index) const;
 162
 163   Expected<const Elf_Sym *> getSymbol(const Elf_Shdr *Sec,
 164                                       uint32_t Index) const;
 165
 166   Expected<StringRef> getSectionName(const Elf_Shdr *Section) const;
 167   Expected<StringRef> getSectionName(const Elf_Shdr *Section,
 168                                      StringRef DotShstrtab) const;
 169   template <typename T>
 170   Expected<ArrayRef<T>> getSectionContentsAsArray(const Elf_Shdr *Sec) const;
 171   Expected<ArrayRef<uint8_t>> getSectionContents(const Elf_Shdr *Sec) const;
 172 };
 173
 174 using ELF32LEFile = ELFFile<ELFType<support::little, false>>;
 175 using ELF64LEFile = ELFFile<ELFType<support::little, true>>;
 176 using ELF32BEFile = ELFFile<ELFType<support::big, false>>;
 177 using ELF64BEFile = ELFFile<ELFType<support::big, true>>;
 178
 179 template <class ELFT>
 180 inline Expected<const typename ELFT::Shdr *>
 181 getSection(typename ELFT::ShdrRange Sections, uint32_t Index) {
 182   if (Index >= Sections.size())
 183     return createError("invalid section index");
 184   return &Sections[Index];
 185 }
 186
 187 template <class ELFT>
 188 inline Expected<uint32_t>
 189 getExtendedSymbolTableIndex(const typename ELFT::Sym *Sym,
 190                             const typename ELFT::Sym *FirstSym,
 191                             ArrayRef<typename ELFT::Word> ShndxTable) {
 192   assert(Sym->st_shndx == ELF::SHN_XINDEX);
 193   unsigned Index = Sym - FirstSym;
 194   if (Index >= ShndxTable.size())
 195     return createError("index past the end of the symbol table");
 196
 197   // The size of the table was checked in getSHNDXTable.
 198   return ShndxTable[Index];
 199 }
 200
 201 template <class ELFT>
 202 Expected<uint32_t>
 203 ELFFile<ELFT>::getSectionIndex(const Elf_Sym *Sym, Elf_Sym_Range Syms,
 204                                ArrayRef<Elf_Word> ShndxTable) const {
 205   uint32_t Index = Sym->st_shndx;
 206   if (Index == ELF::SHN_XINDEX) {
 207     auto ErrorOrIndex = getExtendedSymbolTableIndex<ELFT>(
 208         Sym, Syms.begin(), ShndxTable);
 209     if (!ErrorOrIndex)
 210       return ErrorOrIndex.takeError();
 211     return *ErrorOrIndex;
 212   }
 213   if (Index == ELF::SHN_UNDEF || Index >= ELF::SHN_LORESERVE)
 214     return 0;
 215   return Index;
 216 }
 217
 218 template <class ELFT>
 219 Expected<const typename ELFT::Shdr *>
 220 ELFFile<ELFT>::getSection(const Elf_Sym *Sym, const Elf_Shdr *SymTab,
 221                           ArrayRef<Elf_Word> ShndxTable) const {
 222   auto SymsOrErr = symbols(SymTab);
 223   if (!SymsOrErr)
 224     return SymsOrErr.takeError();
 225   return getSection(Sym, *SymsOrErr, ShndxTable);
 226 }
 227
 228 template <class ELFT>
 229 Expected<const typename ELFT::Shdr *>
 230 ELFFile<ELFT>::getSection(const Elf_Sym *Sym, Elf_Sym_Range Symbols,
 231                           ArrayRef<Elf_Word> ShndxTable) const {
 232   auto IndexOrErr = getSectionIndex(Sym, Symbols, ShndxTable);
 233   if (!IndexOrErr)
 234     return IndexOrErr.takeError();
 235   uint32_t Index = *IndexOrErr;
 236   if (Index == 0)
 237     return nullptr;
 238   return getSection(Index);
 239 }
 240
 241 template <class ELFT>
 242 inline Expected<const typename ELFT::Sym *>
 243 getSymbol(typename ELFT::SymRange Symbols, uint32_t Index) {
 244   if (Index >= Symbols.size())
 245     return createError("invalid symbol index");
 246   return &Symbols[Index];
 247 }
 248
 249 template <class ELFT>
 250 Expected<const typename ELFT::Sym *>
 251 ELFFile<ELFT>::getSymbol(const Elf_Shdr *Sec, uint32_t Index) const {
 252   auto SymtabOrErr = symbols(Sec);
 253   if (!SymtabOrErr)
 254     return SymtabOrErr.takeError();
 255   return object::getSymbol<ELFT>(*SymtabOrErr, Index);
 256 }
 257
 258 template <class ELFT>
 259 template <typename T>
 260 Expected<ArrayRef<T>>
 261 ELFFile<ELFT>::getSectionContentsAsArray(const Elf_Shdr *Sec) const {
 262   if (Sec->sh_entsize != sizeof(T) && sizeof(T) != 1)
 263     return createError("invalid sh_entsize");
 264
 265   uintX_t Offset = Sec->sh_offset;
 266   uintX_t Size = Sec->sh_size;
 267
 268   if (Size % sizeof(T))
 269     return createError("size is not a multiple of sh_entsize");
 270   if ((std::numeric_limits<uintX_t>::max() - Offset < Size) ||
 271       Offset + Size > Buf.size())
 272     return createError("invalid section offset");
 273
 274   const T *Start = reinterpret_cast<const T *>(base() + Offset);
 275   return makeArrayRef(Start, Size / sizeof(T));
 276 }
 277
 278 template <class ELFT>
 279 Expected<ArrayRef<uint8_t>>
 280 ELFFile<ELFT>::getSectionContents(const Elf_Shdr *Sec) const {
 281   return getSectionContentsAsArray<uint8_t>(Sec);
 282 }
 283
 284 template <class ELFT>
 285 StringRef ELFFile<ELFT>::getRelocationTypeName(uint32_t Type) const {
 286   return getELFRelocationTypeName(getHeader()->e_machine, Type);
 287 }
 288
 289 template <class ELFT>
 290 void ELFFile<ELFT>::getRelocationTypeName(uint32_t Type,
 291                                           SmallVectorImpl<char> &Result) const {
 292   if (!isMipsELF64()) {
 293     StringRef Name = getRelocationTypeName(Type);
 294     Result.append(Name.begin(), Name.end());
 295   } else {
 296     // The Mips N64 ABI allows up to three operations to be specified per
 297     // relocation record. Unfortunately there's no easy way to test for the
 298     // presence of N64 ELFs as they have no special flag that identifies them
 299     // as being N64. We can safely assume at the moment that all Mips
 300     // ELFCLASS64 ELFs are N64. New Mips64 ABIs should provide enough
 301     // information to disambiguate between old vs new ABIs.
 302     uint8_t Type1 = (Type >> 0) & 0xFF;
 303     uint8_t Type2 = (Type >> 8) & 0xFF;
 304     uint8_t Type3 = (Type >> 16) & 0xFF;
 305
 306     // Concat all three relocation type names.
 307     StringRef Name = getRelocationTypeName(Type1);
 308     Result.append(Name.begin(), Name.end());
 309
 310     Name = getRelocationTypeName(Type2);
 311     Result.append(1, '/');
 312     Result.append(Name.begin(), Name.end());
 313
 314     Name = getRelocationTypeName(Type3);
 315     Result.append(1, '/');
 316     Result.append(Name.begin(), Name.end());
 317   }
 318 }
 319
 320 template <class ELFT>
 321 Expected<const typename ELFT::Sym *>
 322 ELFFile<ELFT>::getRelocationSymbol(const Elf_Rel *Rel,
 323                                    const Elf_Shdr *SymTab) const {
 324   uint32_t Index = Rel->getSymbol(isMips64EL());
 325   if (Index == 0)
 326     return nullptr;
 327   return getEntry<Elf_Sym>(SymTab, Index);
 328 }
 329
 330 template <class ELFT>
 331 Expected<StringRef>
 332 ELFFile<ELFT>::getSectionStringTable(Elf_Shdr_Range Sections) const {
 333   uint32_t Index = getHeader()->e_shstrndx;
 334   if (Index == ELF::SHN_XINDEX)
 335     Index = Sections[0].sh_link;
 336
 337   if (!Index) // no section string table.
 338     return "";
 339   if (Index >= Sections.size())
 340     return createError("invalid section index");
 341   return getStringTable(&Sections[Index]);
 342 }
 343
 344 template <class ELFT>
 345 ELFFile<ELFT>::ELFFile(StringRef Object) : Buf(Object) {
 346   assert(sizeof(Elf_Ehdr) <= Buf.size() && "Invalid buffer");
 347 }
 348
 349 template <class ELFT>
 350 bool compareAddr(uint64_t VAddr, const Elf_Phdr_Impl<ELFT> *Phdr) {
 351   return VAddr < Phdr->p_vaddr;
 352 }
 353
 354 template <class ELFT>
 355 Expected<typename ELFT::ShdrRange> ELFFile<ELFT>::sections() const {
 356   const uintX_t SectionTableOffset = getHeader()->e_shoff;
 357   if (SectionTableOffset == 0)
 358     return ArrayRef<Elf_Shdr>();
 359
 360   if (getHeader()->e_shentsize != sizeof(Elf_Shdr))
 361     return createError(
 362         "invalid section header entry size (e_shentsize) in ELF header");
 363
 364   const uint64_t FileSize = Buf.size();
 365
 366   if (SectionTableOffset + sizeof(Elf_Shdr) > FileSize)
 367     return createError("section header table goes past the end of the file");
 368
 369   // Invalid address alignment of section headers
 370   if (SectionTableOffset & (alignof(Elf_Shdr) - 1))
 371     return createError("invalid alignment of section headers");
 372
 373   const Elf_Shdr *First =
 374       reinterpret_cast<const Elf_Shdr *>(base() + SectionTableOffset);
 375
 376   uintX_t NumSections = getHeader()->e_shnum;
 377   if (NumSections == 0)
 378     NumSections = First->sh_size;
 379
 380   if (NumSections > UINT64_MAX / sizeof(Elf_Shdr))
 381     return createError("section table goes past the end of file");
 382
 383   const uint64_t SectionTableSize = NumSections * sizeof(Elf_Shdr);
 384
 385   // Section table goes past end of file!
 386   if (SectionTableOffset + SectionTableSize > FileSize)
 387     return createError("section table goes past the end of file");
 388
 389   return makeArrayRef(First, NumSections);
 390 }
 391
 392 template <class ELFT>
 393 template <typename T>
 394 Expected<const T *> ELFFile<ELFT>::getEntry(uint32_t Section,
 395                                             uint32_t Entry) const {
 396   auto SecOrErr = getSection(Section);
 397   if (!SecOrErr)
 398     return SecOrErr.takeError();
 399   return getEntry<T>(*SecOrErr, Entry);
 400 }
 401
 402 template <class ELFT>
 403 template <typename T>
 404 Expected<const T *> ELFFile<ELFT>::getEntry(const Elf_Shdr *Section,
 405                                             uint32_t Entry) const {
 406   if (sizeof(T) != Section->sh_entsize)
 407     return createError("invalid sh_entsize");
 408   size_t Pos = Section->sh_offset + Entry * sizeof(T);
 409   if (Pos + sizeof(T) > Buf.size())
 410     return createError("invalid section offset");
 411   return reinterpret_cast<const T *>(base() + Pos);
 412 }
 413
 414 template <class ELFT>
 415 Expected<const typename ELFT::Shdr *>
 416 ELFFile<ELFT>::getSection(uint32_t Index) const {
 417   auto TableOrErr = sections();
 418   if (!TableOrErr)
 419     return TableOrErr.takeError();
 420   return object::getSection<ELFT>(*TableOrErr, Index);
 421 }
 422
 423 template <class ELFT>
 424 Expected<StringRef>
 425 ELFFile<ELFT>::getStringTable(const Elf_Shdr *Section) const {
 426   if (Section->sh_type != ELF::SHT_STRTAB)
 427     return createError("invalid sh_type for string table, expected SHT_STRTAB");
 428   auto V = getSectionContentsAsArray<char>(Section);
 429   if (!V)
 430     return V.takeError();
 431   ArrayRef<char> Data = *V;
 432   if (Data.empty())
 433     return createError("empty string table");
 434   if (Data.back() != '\0')
 435     return createError("string table non-null terminated");
 436   return StringRef(Data.begin(), Data.size());
 437 }
 438
 439 template <class ELFT>
 440 Expected<ArrayRef<typename ELFT::Word>>
 441 ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section) const {
 442   auto SectionsOrErr = sections();
 443   if (!SectionsOrErr)
 444     return SectionsOrErr.takeError();
 445   return getSHNDXTable(Section, *SectionsOrErr);
 446 }
 447
 448 template <class ELFT>
 449 Expected<ArrayRef<typename ELFT::Word>>
 450 ELFFile<ELFT>::getSHNDXTable(const Elf_Shdr &Section,
 451                              Elf_Shdr_Range Sections) const {
 452   assert(Section.sh_type == ELF::SHT_SYMTAB_SHNDX);
 453   auto VOrErr = getSectionContentsAsArray<Elf_Word>(&Section);
 454   if (!VOrErr)
 455     return VOrErr.takeError();
 456   ArrayRef<Elf_Word> V = *VOrErr;
 457   auto SymTableOrErr = object::getSection<ELFT>(Sections, Section.sh_link);
 458   if (!SymTableOrErr)
 459     return SymTableOrErr.takeError();
 460   const Elf_Shdr &SymTable = **SymTableOrErr;
 461   if (SymTable.sh_type != ELF::SHT_SYMTAB &&
 462       SymTable.sh_type != ELF::SHT_DYNSYM)
 463     return createError("invalid sh_type");
 464   if (V.size() != (SymTable.sh_size / sizeof(Elf_Sym)))
 465     return createError("invalid section contents size");
 466   return V;
 467 }
 468
 469 template <class ELFT>
 470 Expected<StringRef>
 471 ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec) const {
 472   auto SectionsOrErr = sections();
 473   if (!SectionsOrErr)
 474     return SectionsOrErr.takeError();
 475   return getStringTableForSymtab(Sec, *SectionsOrErr);
 476 }
 477
 478 template <class ELFT>
 479 Expected<StringRef>
 480 ELFFile<ELFT>::getStringTableForSymtab(const Elf_Shdr &Sec,
 481                                        Elf_Shdr_Range Sections) const {
 482
 483   if (Sec.sh_type != ELF::SHT_SYMTAB && Sec.sh_type != ELF::SHT_DYNSYM)
 484     return createError(
 485         "invalid sh_type for symbol table, expected SHT_SYMTAB or SHT_DYNSYM");
 486   auto SectionOrErr = object::getSection<ELFT>(Sections, Sec.sh_link);
 487   if (!SectionOrErr)
 488     return SectionOrErr.takeError();
 489   return getStringTable(*SectionOrErr);
 490 }
 491
 492 template <class ELFT>
 493 Expected<StringRef>
 494 ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section) const {
 495   auto SectionsOrErr = sections();
 496   if (!SectionsOrErr)
 497     return SectionsOrErr.takeError();
 498   auto Table = getSectionStringTable(*SectionsOrErr);
 499   if (!Table)
 500     return Table.takeError();
 501   return getSectionName(Section, *Table);
 502 }
 503
 504 template <class ELFT>
 505 Expected<StringRef> ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section,
 506                                                   StringRef DotShstrtab) const {
 507   uint32_t Offset = Section->sh_name;
 508   if (Offset == 0)
 509     return StringRef();
 510   if (Offset >= DotShstrtab.size())
 511     return createError("invalid string offset");
 512   return StringRef(DotShstrtab.data() + Offset);
 513 }
 514
 515 /// This function returns the hash value for a symbol in the .dynsym section
 516 /// Name of the API remains consistent as specified in the libelf
 517 /// REF : http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#hash
 518 inline unsigned hashSysV(StringRef SymbolName) {
 519   unsigned h = 0, g;
 520   for (char C : SymbolName) {
 521     h = (h << 4) + C;
 522     g = h & 0xf0000000L;
 523     if (g != 0)
 524       h ^= g >> 24;
 525     h &= ~g;
 526   }
 527   return h;
 528 }
 529
 530 } // end namespace object
 531 } // end namespace llvm
 532
 533 #endif // LLVM_OBJECT_ELF_H