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/DenseMap.h"
  19 #include "llvm/ADT/PointerIntPair.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/ADT/StringSwitch.h"
  22 #include "llvm/ADT/Triple.h"
  23 #include "llvm/Object/ELFTypes.h"
  24 #include "llvm/Object/Error.h"
  25 #include "llvm/Support/Casting.h"
  26 #include "llvm/Support/ELF.h"
  27 #include "llvm/Support/Endian.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/ErrorOr.h"
  30 #include "llvm/Support/MemoryBuffer.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include <algorithm>
  33 #include <limits>
  34 #include <utility>
  35
  36 namespace llvm {
  37 namespace object {
  38
  39 StringRef getELFRelocationTypeName(uint32_t Machine, uint32_t Type);
  40
  41 // Subclasses of ELFFile may need this for template instantiation
  42 inline std::pair<unsigned char, unsigned char>
  43 getElfArchType(StringRef Object) {
  44   if (Object.size() < ELF::EI_NIDENT)
  45     return std::make_pair((uint8_t)ELF::ELFCLASSNONE,
  46                           (uint8_t)ELF::ELFDATANONE);
  47   return std::make_pair((uint8_t)Object[ELF::EI_CLASS],
  48                         (uint8_t)Object[ELF::EI_DATA]);
  49 }
  50
  51 template <class ELFT>
  52 class ELFFile {
  53 public:
  54   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
  55   typedef typename std::conditional<ELFT::Is64Bits,
  56                                     uint64_t, uint32_t>::type uintX_t;
  57
  58   /// \brief Iterate over constant sized entities.
  59   template <class EntT>
  60   class ELFEntityIterator {
  61   public:
  62     typedef ptrdiff_t difference_type;
  63     typedef EntT value_type;
  64     typedef std::forward_iterator_tag iterator_category;
  65     typedef value_type &reference;
  66     typedef value_type *pointer;
  67
  68     /// \brief Default construct iterator.
  69     ELFEntityIterator() : EntitySize(0), Current(nullptr) {}
  70     ELFEntityIterator(uintX_t EntSize, const char *Start)
  71         : EntitySize(EntSize), Current(Start) {}
  72
  73     reference operator *() {
  74       assert(Current && "Attempted to dereference an invalid iterator!");
  75       return *reinterpret_cast<pointer>(Current);
  76     }
  77
  78     pointer operator ->() {
  79       assert(Current && "Attempted to dereference an invalid iterator!");
  80       return reinterpret_cast<pointer>(Current);
  81     }
  82
  83     bool operator ==(const ELFEntityIterator &Other) {
  84       return Current == Other.Current;
  85     }
  86
  87     bool operator !=(const ELFEntityIterator &Other) {
  88       return !(*this == Other);
  89     }
  90
  91     ELFEntityIterator &operator ++() {
  92       assert(Current && "Attempted to increment an invalid iterator!");
  93       Current += EntitySize;
  94       return *this;
  95     }
  96
  97     ELFEntityIterator &operator+(difference_type n) {
  98       assert(Current && "Attempted to increment an invalid iterator!");
  99       Current += (n * EntitySize);
 100       return *this;
 101     }
 102
 103     ELFEntityIterator &operator-(difference_type n) {
 104       assert(Current && "Attempted to subtract an invalid iterator!");
 105       Current -= (n * EntitySize);
 106       return *this;
 107     }
 108
 109     ELFEntityIterator operator ++(int) {
 110       ELFEntityIterator Tmp = *this;
 111       ++*this;
 112       return Tmp;
 113     }
 114
 115     difference_type operator -(const ELFEntityIterator &Other) const {
 116       assert(EntitySize == Other.EntitySize &&
 117              "Subtracting iterators of different EntitySize!");
 118       return (Current - Other.Current) / EntitySize;
 119     }
 120
 121     const char *get() const { return Current; }
 122
 123     uintX_t getEntSize() const { return EntitySize; }
 124
 125   private:
 126     uintX_t EntitySize;
 127     const char *Current;
 128   };
 129
 130   typedef Elf_Ehdr_Impl<ELFT> Elf_Ehdr;
 131   typedef Elf_Shdr_Impl<ELFT> Elf_Shdr;
 132   typedef Elf_Sym_Impl<ELFT> Elf_Sym;
 133   typedef Elf_Dyn_Impl<ELFT> Elf_Dyn;
 134   typedef Elf_Phdr_Impl<ELFT> Elf_Phdr;
 135   typedef Elf_Rel_Impl<ELFT, false> Elf_Rel;
 136   typedef Elf_Rel_Impl<ELFT, true> Elf_Rela;
 137   typedef Elf_Verdef_Impl<ELFT> Elf_Verdef;
 138   typedef Elf_Verdaux_Impl<ELFT> Elf_Verdaux;
 139   typedef Elf_Verneed_Impl<ELFT> Elf_Verneed;
 140   typedef Elf_Vernaux_Impl<ELFT> Elf_Vernaux;
 141   typedef Elf_Versym_Impl<ELFT> Elf_Versym;
 142   typedef Elf_Hash_Impl<ELFT> Elf_Hash;
 143   typedef iterator_range<const Elf_Dyn *> Elf_Dyn_Range;
 144   typedef iterator_range<const Elf_Shdr *> Elf_Shdr_Range;
 145
 146   /// \brief Archive files are 2 byte aligned, so we need this for
 147   ///     PointerIntPair to work.
 148   template <typename T>
 149   class ArchivePointerTypeTraits {
 150   public:
 151     static inline const void *getAsVoidPointer(T *P) { return P; }
 152     static inline T *getFromVoidPointer(const void *P) {
 153       return static_cast<T *>(P);
 154     }
 155     enum { NumLowBitsAvailable = 1 };
 156   };
 157
 158   typedef iterator_range<const Elf_Sym *> Elf_Sym_Range;
 159
 160 private:
 161   typedef SmallVector<const Elf_Shdr *, 2> Sections_t;
 162   typedef DenseMap<unsigned, unsigned> IndexMap_t;
 163
 164   StringRef Buf;
 165
 166   const uint8_t *base() const {
 167     return reinterpret_cast<const uint8_t *>(Buf.data());
 168   }
 169
 170   const Elf_Ehdr *Header;
 171   const Elf_Shdr *SectionHeaderTable = nullptr;
 172   StringRef DotShstrtab;                    // Section header string table.
 173   StringRef DotStrtab;                      // Symbol header string table.
 174   const Elf_Shdr *dot_symtab_sec = nullptr; // Symbol table section.
 175   const Elf_Shdr *DotDynSymSec = nullptr;   // Dynamic symbol table section.
 176   const Elf_Hash *HashTable = nullptr;
 177
 178   const Elf_Shdr *SymbolTableSectionHeaderIndex = nullptr;
 179   DenseMap<const Elf_Sym *, ELF::Elf64_Word> ExtendedSymbolTable;
 180
 181   const Elf_Shdr *dot_gnu_version_sec = nullptr;   // .gnu.version
 182   const Elf_Shdr *dot_gnu_version_r_sec = nullptr; // .gnu.version_r
 183   const Elf_Shdr *dot_gnu_version_d_sec = nullptr; // .gnu.version_d
 184
 185   /// \brief Represents a region described by entries in the .dynamic table.
 186   struct DynRegionInfo {
 187     DynRegionInfo() : Addr(nullptr), Size(0), EntSize(0) {}
 188     /// \brief Address in current address space.
 189     const void *Addr;
 190     /// \brief Size in bytes of the region.
 191     uintX_t Size;
 192     /// \brief Size of each entity in the region.
 193     uintX_t EntSize;
 194   };
 195
 196   DynRegionInfo DynamicRegion;
 197   DynRegionInfo DynHashRegion;
 198   DynRegionInfo DynStrRegion;
 199   DynRegionInfo DynRelaRegion;
 200
 201   // Pointer to SONAME entry in dynamic string table
 202   // This is set the first time getLoadName is called.
 203   mutable const char *dt_soname = nullptr;
 204
 205   // Records for each version index the corresponding Verdef or Vernaux entry.
 206   // This is filled the first time LoadVersionMap() is called.
 207   class VersionMapEntry : public PointerIntPair<const void*, 1> {
 208     public:
 209     // If the integer is 0, this is an Elf_Verdef*.
 210     // If the integer is 1, this is an Elf_Vernaux*.
 211     VersionMapEntry() : PointerIntPair<const void*, 1>(nullptr, 0) { }
 212     VersionMapEntry(const Elf_Verdef *verdef)
 213         : PointerIntPair<const void*, 1>(verdef, 0) { }
 214     VersionMapEntry(const Elf_Vernaux *vernaux)
 215         : PointerIntPair<const void*, 1>(vernaux, 1) { }
 216     bool isNull() const { return getPointer() == nullptr; }
 217     bool isVerdef() const { return !isNull() && getInt() == 0; }
 218     bool isVernaux() const { return !isNull() && getInt() == 1; }
 219     const Elf_Verdef *getVerdef() const {
 220       return isVerdef() ? (const Elf_Verdef*)getPointer() : nullptr;
 221     }
 222     const Elf_Vernaux *getVernaux() const {
 223       return isVernaux() ? (const Elf_Vernaux*)getPointer() : nullptr;
 224     }
 225   };
 226   mutable SmallVector<VersionMapEntry, 16> VersionMap;
 227   void LoadVersionDefs(const Elf_Shdr *sec) const;
 228   void LoadVersionNeeds(const Elf_Shdr *ec) const;
 229   void LoadVersionMap() const;
 230
 231   void scanDynamicTable();
 232
 233 public:
 234   template<typename T>
 235   const T        *getEntry(uint32_t Section, uint32_t Entry) const;
 236   template <typename T>
 237   const T *getEntry(const Elf_Shdr *Section, uint32_t Entry) const;
 238
 239   const Elf_Shdr *getDotSymtabSec() const { return dot_symtab_sec; }
 240   const Elf_Shdr *getDotDynSymSec() const { return DotDynSymSec; }
 241   const Elf_Hash *getHashTable() const { return HashTable; }
 242
 243   ErrorOr<StringRef> getStringTable(const Elf_Shdr *Section) const;
 244   const char *getDynamicString(uintX_t Offset) const;
 245   ErrorOr<StringRef> getSymbolVersion(const Elf_Shdr *section,
 246                                       const Elf_Sym *Symb,
 247                                       bool &IsDefault) const;
 248   void VerifyStrTab(const Elf_Shdr *sh) const;
 249
 250   StringRef getRelocationTypeName(uint32_t Type) const;
 251   void getRelocationTypeName(uint32_t Type,
 252                              SmallVectorImpl<char> &Result) const;
 253
 254   /// \brief Get the symbol table section and symbol for a given relocation.
 255   template <class RelT>
 256   std::pair<const Elf_Shdr *, const Elf_Sym *>
 257   getRelocationSymbol(const Elf_Shdr *RelSec, const RelT *Rel) const;
 258
 259   ELFFile(StringRef Object, std::error_code &EC);
 260
 261   bool isMipsELF64() const {
 262     return Header->e_machine == ELF::EM_MIPS &&
 263       Header->getFileClass() == ELF::ELFCLASS64;
 264   }
 265
 266   bool isMips64EL() const {
 267     return Header->e_machine == ELF::EM_MIPS &&
 268       Header->getFileClass() == ELF::ELFCLASS64 &&
 269       Header->getDataEncoding() == ELF::ELFDATA2LSB;
 270   }
 271
 272   const Elf_Shdr *section_begin() const;
 273   const Elf_Shdr *section_end() const;
 274   Elf_Shdr_Range sections() const {
 275     return make_range(section_begin(), section_end());
 276   }
 277
 278   const Elf_Sym *symbol_begin() const;
 279   const Elf_Sym *symbol_end() const;
 280   Elf_Sym_Range symbols() const {
 281     return make_range(symbol_begin(), symbol_end());
 282   }
 283
 284   const Elf_Dyn *dynamic_table_begin() const;
 285   const Elf_Dyn *dynamic_table_end() const;
 286   Elf_Dyn_Range dynamic_table() const {
 287     return make_range(dynamic_table_begin(), dynamic_table_end());
 288   }
 289
 290   const Elf_Sym *dynamic_symbol_begin() const {
 291     if (!DotDynSymSec)
 292       return nullptr;
 293     if (DotDynSymSec->sh_entsize != sizeof(Elf_Sym))
 294       report_fatal_error("Invalid symbol size");
 295     return reinterpret_cast<const Elf_Sym *>(base() + DotDynSymSec->sh_offset);
 296   }
 297
 298   const Elf_Sym *dynamic_symbol_end() const {
 299     if (!DotDynSymSec)
 300       return nullptr;
 301     return reinterpret_cast<const Elf_Sym *>(base() + DotDynSymSec->sh_offset +
 302                                              DotDynSymSec->sh_size);
 303   }
 304
 305   Elf_Sym_Range dynamic_symbols() const {
 306     return make_range(dynamic_symbol_begin(), dynamic_symbol_end());
 307   }
 308
 309   const Elf_Rela *dyn_rela_begin() const {
 310     if (DynRelaRegion.Size && DynRelaRegion.EntSize != sizeof(Elf_Rela))
 311       report_fatal_error("Invalid relocation entry size");
 312     return reinterpret_cast<const Elf_Rela *>(DynRelaRegion.Addr);
 313   }
 314
 315   const Elf_Rela *dyn_rela_end() const {
 316     uint64_t Size = DynRelaRegion.Size;
 317     if (Size % sizeof(Elf_Rela))
 318       report_fatal_error("Invalid relocation table size");
 319     return dyn_rela_begin() + Size / sizeof(Elf_Rela);
 320   }
 321
 322   typedef iterator_range<const Elf_Rela *> Elf_Rela_Range;
 323
 324   Elf_Rela_Range dyn_relas() const {
 325     return make_range(dyn_rela_begin(), dyn_rela_end());
 326   }
 327
 328   const Elf_Rela *rela_begin(const Elf_Shdr *sec) const {
 329     if (sec->sh_entsize != sizeof(Elf_Rela))
 330       report_fatal_error("Invalid relocation entry size");
 331     return reinterpret_cast<const Elf_Rela *>(base() + sec->sh_offset);
 332   }
 333
 334   const Elf_Rela *rela_end(const Elf_Shdr *sec) const {
 335     uint64_t Size = sec->sh_size;
 336     if (Size % sizeof(Elf_Rela))
 337       report_fatal_error("Invalid relocation table size");
 338     return rela_begin(sec) + Size / sizeof(Elf_Rela);
 339   }
 340
 341   Elf_Rela_Range relas(const Elf_Shdr *Sec) const {
 342     return make_range(rela_begin(Sec), rela_end(Sec));
 343   }
 344
 345   const Elf_Rel *rel_begin(const Elf_Shdr *sec) const {
 346     if (sec->sh_entsize != sizeof(Elf_Rel))
 347       report_fatal_error("Invalid relocation entry size");
 348     return reinterpret_cast<const Elf_Rel *>(base() + sec->sh_offset);
 349   }
 350
 351   const Elf_Rel *rel_end(const Elf_Shdr *sec) const {
 352     uint64_t Size = sec->sh_size;
 353     if (Size % sizeof(Elf_Rel))
 354       report_fatal_error("Invalid relocation table size");
 355     return rel_begin(sec) + Size / sizeof(Elf_Rel);
 356   }
 357
 358   typedef iterator_range<const Elf_Rel *> Elf_Rel_Range;
 359   Elf_Rel_Range rels(const Elf_Shdr *Sec) const {
 360     return make_range(rel_begin(Sec), rel_end(Sec));
 361   }
 362
 363   /// \brief Iterate over program header table.
 364   const Elf_Phdr *program_header_begin() const {
 365     if (Header->e_phnum && Header->e_phentsize != sizeof(Elf_Phdr))
 366       report_fatal_error("Invalid program header size");
 367     return reinterpret_cast<const Elf_Phdr *>(base() + Header->e_phoff);
 368   }
 369
 370   const Elf_Phdr *program_header_end() const {
 371     return program_header_begin() + Header->e_phnum;
 372   }
 373
 374   typedef iterator_range<const Elf_Phdr *> Elf_Phdr_Range;
 375
 376   const Elf_Phdr_Range program_headers() const {
 377     return make_range(program_header_begin(), program_header_end());
 378   }
 379
 380   uint64_t getNumSections() const;
 381   uintX_t getStringTableIndex() const;
 382   ELF::Elf64_Word getExtendedSymbolTableIndex(const Elf_Sym *symb) const;
 383   const Elf_Ehdr *getHeader() const { return Header; }
 384   ErrorOr<const Elf_Shdr *> getSection(const Elf_Sym *symb) const;
 385   ErrorOr<const Elf_Shdr *> getSection(uint32_t Index) const;
 386   const Elf_Sym *getSymbol(uint32_t index) const;
 387
 388   ErrorOr<StringRef> getStaticSymbolName(const Elf_Sym *Symb) const;
 389   ErrorOr<StringRef> getDynamicSymbolName(const Elf_Sym *Symb) const;
 390   ErrorOr<StringRef> getSymbolName(const Elf_Sym *Symb, bool IsDynamic) const;
 391
 392   ErrorOr<StringRef> getSectionName(const Elf_Shdr *Section) const;
 393   ErrorOr<ArrayRef<uint8_t> > getSectionContents(const Elf_Shdr *Sec) const;
 394   StringRef getLoadName() const;
 395 };
 396
 397 typedef ELFFile<ELFType<support::little, false>> ELF32LEFile;
 398 typedef ELFFile<ELFType<support::little, true>> ELF64LEFile;
 399 typedef ELFFile<ELFType<support::big, false>> ELF32BEFile;
 400 typedef ELFFile<ELFType<support::big, true>> ELF64BEFile;
 401
 402 // Iterate through the version definitions, and place each Elf_Verdef
 403 // in the VersionMap according to its index.
 404 template <class ELFT>
 405 void ELFFile<ELFT>::LoadVersionDefs(const Elf_Shdr *sec) const {
 406   unsigned vd_size = sec->sh_size;  // Size of section in bytes
 407   unsigned vd_count = sec->sh_info; // Number of Verdef entries
 408   const char *sec_start = (const char*)base() + sec->sh_offset;
 409   const char *sec_end = sec_start + vd_size;
 410   // The first Verdef entry is at the start of the section.
 411   const char *p = sec_start;
 412   for (unsigned i = 0; i < vd_count; i++) {
 413     if (p + sizeof(Elf_Verdef) > sec_end)
 414       report_fatal_error("Section ended unexpectedly while scanning "
 415                          "version definitions.");
 416     const Elf_Verdef *vd = reinterpret_cast<const Elf_Verdef *>(p);
 417     if (vd->vd_version != ELF::VER_DEF_CURRENT)
 418       report_fatal_error("Unexpected verdef version");
 419     size_t index = vd->vd_ndx & ELF::VERSYM_VERSION;
 420     if (index >= VersionMap.size())
 421       VersionMap.resize(index + 1);
 422     VersionMap[index] = VersionMapEntry(vd);
 423     p += vd->vd_next;
 424   }
 425 }
 426
 427 // Iterate through the versions needed section, and place each Elf_Vernaux
 428 // in the VersionMap according to its index.
 429 template <class ELFT>
 430 void ELFFile<ELFT>::LoadVersionNeeds(const Elf_Shdr *sec) const {
 431   unsigned vn_size = sec->sh_size;  // Size of section in bytes
 432   unsigned vn_count = sec->sh_info; // Number of Verneed entries
 433   const char *sec_start = (const char *)base() + sec->sh_offset;
 434   const char *sec_end = sec_start + vn_size;
 435   // The first Verneed entry is at the start of the section.
 436   const char *p = sec_start;
 437   for (unsigned i = 0; i < vn_count; i++) {
 438     if (p + sizeof(Elf_Verneed) > sec_end)
 439       report_fatal_error("Section ended unexpectedly while scanning "
 440                          "version needed records.");
 441     const Elf_Verneed *vn = reinterpret_cast<const Elf_Verneed *>(p);
 442     if (vn->vn_version != ELF::VER_NEED_CURRENT)
 443       report_fatal_error("Unexpected verneed version");
 444     // Iterate through the Vernaux entries
 445     const char *paux = p + vn->vn_aux;
 446     for (unsigned j = 0; j < vn->vn_cnt; j++) {
 447       if (paux + sizeof(Elf_Vernaux) > sec_end)
 448         report_fatal_error("Section ended unexpected while scanning auxiliary "
 449                            "version needed records.");
 450       const Elf_Vernaux *vna = reinterpret_cast<const Elf_Vernaux *>(paux);
 451       size_t index = vna->vna_other & ELF::VERSYM_VERSION;
 452       if (index >= VersionMap.size())
 453         VersionMap.resize(index + 1);
 454       VersionMap[index] = VersionMapEntry(vna);
 455       paux += vna->vna_next;
 456     }
 457     p += vn->vn_next;
 458   }
 459 }
 460
 461 template <class ELFT>
 462 void ELFFile<ELFT>::LoadVersionMap() const {
 463   // If there is no dynamic symtab or version table, there is nothing to do.
 464   if (!DotDynSymSec || !dot_gnu_version_sec)
 465     return;
 466
 467   // Has the VersionMap already been loaded?
 468   if (VersionMap.size() > 0)
 469     return;
 470
 471   // The first two version indexes are reserved.
 472   // Index 0 is LOCAL, index 1 is GLOBAL.
 473   VersionMap.push_back(VersionMapEntry());
 474   VersionMap.push_back(VersionMapEntry());
 475
 476   if (dot_gnu_version_d_sec)
 477     LoadVersionDefs(dot_gnu_version_d_sec);
 478
 479   if (dot_gnu_version_r_sec)
 480     LoadVersionNeeds(dot_gnu_version_r_sec);
 481 }
 482
 483 template <class ELFT>
 484 ELF::Elf64_Word
 485 ELFFile<ELFT>::getExtendedSymbolTableIndex(const Elf_Sym *symb) const {
 486   assert(symb->st_shndx == ELF::SHN_XINDEX);
 487   return ExtendedSymbolTable.lookup(symb);
 488 }
 489
 490 template <class ELFT>
 491 ErrorOr<const typename ELFFile<ELFT>::Elf_Shdr *>
 492 ELFFile<ELFT>::getSection(const Elf_Sym *symb) const {
 493   uint32_t Index = symb->st_shndx;
 494   if (Index == ELF::SHN_XINDEX)
 495     return getSection(ExtendedSymbolTable.lookup(symb));
 496   if (Index == ELF::SHN_UNDEF || Index >= ELF::SHN_LORESERVE)
 497     return nullptr;
 498   return getSection(symb->st_shndx);
 499 }
 500
 501 template <class ELFT>
 502 const typename ELFFile<ELFT>::Elf_Sym *
 503 ELFFile<ELFT>::getSymbol(uint32_t Index) const {
 504   return &*(symbol_begin() + Index);
 505 }
 506
 507 template <class ELFT>
 508 ErrorOr<ArrayRef<uint8_t> >
 509 ELFFile<ELFT>::getSectionContents(const Elf_Shdr *Sec) const {
 510   if (Sec->sh_offset + Sec->sh_size > Buf.size())
 511     return object_error::parse_failed;
 512   const uint8_t *Start = base() + Sec->sh_offset;
 513   return makeArrayRef(Start, Sec->sh_size);
 514 }
 515
 516 template <class ELFT>
 517 StringRef ELFFile<ELFT>::getRelocationTypeName(uint32_t Type) const {
 518   return getELFRelocationTypeName(Header->e_machine, Type);
 519 }
 520
 521 template <class ELFT>
 522 void ELFFile<ELFT>::getRelocationTypeName(uint32_t Type,
 523                                           SmallVectorImpl<char> &Result) const {
 524   if (!isMipsELF64()) {
 525     StringRef Name = getRelocationTypeName(Type);
 526     Result.append(Name.begin(), Name.end());
 527   } else {
 528     // The Mips N64 ABI allows up to three operations to be specified per
 529     // relocation record. Unfortunately there's no easy way to test for the
 530     // presence of N64 ELFs as they have no special flag that identifies them
 531     // as being N64. We can safely assume at the moment that all Mips
 532     // ELFCLASS64 ELFs are N64. New Mips64 ABIs should provide enough
 533     // information to disambiguate between old vs new ABIs.
 534     uint8_t Type1 = (Type >> 0) & 0xFF;
 535     uint8_t Type2 = (Type >> 8) & 0xFF;
 536     uint8_t Type3 = (Type >> 16) & 0xFF;
 537
 538     // Concat all three relocation type names.
 539     StringRef Name = getRelocationTypeName(Type1);
 540     Result.append(Name.begin(), Name.end());
 541
 542     Name = getRelocationTypeName(Type2);
 543     Result.append(1, '/');
 544     Result.append(Name.begin(), Name.end());
 545
 546     Name = getRelocationTypeName(Type3);
 547     Result.append(1, '/');
 548     Result.append(Name.begin(), Name.end());
 549   }
 550 }
 551
 552 template <class ELFT>
 553 template <class RelT>
 554 std::pair<const typename ELFFile<ELFT>::Elf_Shdr *,
 555           const typename ELFFile<ELFT>::Elf_Sym *>
 556 ELFFile<ELFT>::getRelocationSymbol(const Elf_Shdr *Sec, const RelT *Rel) const {
 557   if (!Sec->sh_link)
 558     return std::make_pair(nullptr, nullptr);
 559   ErrorOr<const Elf_Shdr *> SymTableOrErr = getSection(Sec->sh_link);
 560   if (std::error_code EC = SymTableOrErr.getError())
 561     report_fatal_error(EC.message());
 562   const Elf_Shdr *SymTable = *SymTableOrErr;
 563   return std::make_pair(
 564       SymTable, getEntry<Elf_Sym>(SymTable, Rel->getSymbol(isMips64EL())));
 565 }
 566
 567 template <class ELFT>
 568 uint64_t ELFFile<ELFT>::getNumSections() const {
 569   assert(Header && "Header not initialized!");
 570   if (Header->e_shnum == ELF::SHN_UNDEF && Header->e_shoff > 0) {
 571     assert(SectionHeaderTable && "SectionHeaderTable not initialized!");
 572     return SectionHeaderTable->sh_size;
 573   }
 574   return Header->e_shnum;
 575 }
 576
 577 template <class ELFT>
 578 typename ELFFile<ELFT>::uintX_t ELFFile<ELFT>::getStringTableIndex() const {
 579   if (Header->e_shnum == ELF::SHN_UNDEF) {
 580     if (Header->e_shstrndx == ELF::SHN_HIRESERVE)
 581       return SectionHeaderTable->sh_link;
 582     if (Header->e_shstrndx >= getNumSections())
 583       return 0;
 584   }
 585   return Header->e_shstrndx;
 586 }
 587
 588 template <class ELFT>
 589 ELFFile<ELFT>::ELFFile(StringRef Object, std::error_code &EC)
 590     : Buf(Object) {
 591   const uint64_t FileSize = Buf.size();
 592
 593   if (sizeof(Elf_Ehdr) > FileSize) {
 594     // File too short!
 595     EC = object_error::parse_failed;
 596     return;
 597   }
 598
 599   Header = reinterpret_cast<const Elf_Ehdr *>(base());
 600
 601   if (Header->e_shoff == 0) {
 602     scanDynamicTable();
 603     return;
 604   }
 605
 606   const uint64_t SectionTableOffset = Header->e_shoff;
 607
 608   if (SectionTableOffset + sizeof(Elf_Shdr) > FileSize) {
 609     // Section header table goes past end of file!
 610     EC = object_error::parse_failed;
 611     return;
 612   }
 613
 614   // The getNumSections() call below depends on SectionHeaderTable being set.
 615   SectionHeaderTable =
 616     reinterpret_cast<const Elf_Shdr *>(base() + SectionTableOffset);
 617   const uint64_t SectionTableSize = getNumSections() * Header->e_shentsize;
 618
 619   if (SectionTableOffset + SectionTableSize > FileSize) {
 620     // Section table goes past end of file!
 621     EC = object_error::parse_failed;
 622     return;
 623   }
 624
 625   // Scan sections for special sections.
 626
 627   for (const Elf_Shdr &Sec : sections()) {
 628     switch (Sec.sh_type) {
 629     case ELF::SHT_HASH:
 630       if (HashTable) {
 631         EC = object_error::parse_failed;
 632         return;
 633       }
 634       HashTable = reinterpret_cast<const Elf_Hash *>(base() + Sec.sh_offset);
 635       break;
 636     case ELF::SHT_SYMTAB_SHNDX:
 637       if (SymbolTableSectionHeaderIndex) {
 638         // More than one .symtab_shndx!
 639         EC = object_error::parse_failed;
 640         return;
 641       }
 642       SymbolTableSectionHeaderIndex = &Sec;
 643       break;
 644     case ELF::SHT_SYMTAB: {
 645       if (dot_symtab_sec) {
 646         // More than one .symtab!
 647         EC = object_error::parse_failed;
 648         return;
 649       }
 650       dot_symtab_sec = &Sec;
 651       ErrorOr<const Elf_Shdr *> SectionOrErr = getSection(Sec.sh_link);
 652       if ((EC = SectionOrErr.getError()))
 653         return;
 654       ErrorOr<StringRef> SymtabOrErr = getStringTable(*SectionOrErr);
 655       if ((EC = SymtabOrErr.getError()))
 656         return;
 657       DotStrtab = *SymtabOrErr;
 658     } break;
 659     case ELF::SHT_DYNSYM: {
 660       if (DotDynSymSec) {
 661         // More than one .dynsym!
 662         EC = object_error::parse_failed;
 663         return;
 664       }
 665       DotDynSymSec = &Sec;
 666       break;
 667     }
 668     case ELF::SHT_GNU_versym:
 669       if (dot_gnu_version_sec != nullptr) {
 670         // More than one .gnu.version section!
 671         EC = object_error::parse_failed;
 672         return;
 673       }
 674       dot_gnu_version_sec = &Sec;
 675       break;
 676     case ELF::SHT_GNU_verdef:
 677       if (dot_gnu_version_d_sec != nullptr) {
 678         // More than one .gnu.version_d section!
 679         EC = object_error::parse_failed;
 680         return;
 681       }
 682       dot_gnu_version_d_sec = &Sec;
 683       break;
 684     case ELF::SHT_GNU_verneed:
 685       if (dot_gnu_version_r_sec != nullptr) {
 686         // More than one .gnu.version_r section!
 687         EC = object_error::parse_failed;
 688         return;
 689       }
 690       dot_gnu_version_r_sec = &Sec;
 691       break;
 692     }
 693   }
 694
 695   // Get string table sections.
 696   ErrorOr<const Elf_Shdr *> StrTabSecOrErr = getSection(getStringTableIndex());
 697   if ((EC = StrTabSecOrErr.getError()))
 698     return;
 699
 700   ErrorOr<StringRef> SymtabOrErr = getStringTable(*StrTabSecOrErr);
 701   if ((EC = SymtabOrErr.getError()))
 702     return;
 703   DotShstrtab = *SymtabOrErr;
 704
 705   // Build symbol name side-mapping if there is one.
 706   if (SymbolTableSectionHeaderIndex) {
 707     const Elf_Word *ShndxTable = reinterpret_cast<const Elf_Word*>(base() +
 708                                       SymbolTableSectionHeaderIndex->sh_offset);
 709     for (const Elf_Sym &S : symbols()) {
 710       if (*ShndxTable != ELF::SHN_UNDEF)
 711         ExtendedSymbolTable[&S] = *ShndxTable;
 712       ++ShndxTable;
 713     }
 714   }
 715
 716   scanDynamicTable();
 717
 718   EC = std::error_code();
 719 }
 720
 721 template <class ELFT>
 722 static bool compareAddr(uint64_t VAddr, const Elf_Phdr_Impl<ELFT> *Phdr) {
 723   return VAddr < Phdr->p_vaddr;
 724 }
 725
 726 template <class ELFT> void ELFFile<ELFT>::scanDynamicTable() {
 727   SmallVector<const Elf_Phdr *, 4> LoadSegments;
 728   for (const Elf_Phdr &Phdr : program_headers()) {
 729     if (Phdr.p_type == ELF::PT_DYNAMIC) {
 730       DynamicRegion.Addr = base() + Phdr.p_offset;
 731       DynamicRegion.Size = Phdr.p_filesz;
 732       continue;
 733     }
 734     if (Phdr.p_type != ELF::PT_LOAD || Phdr.p_filesz == 0)
 735       continue;
 736     LoadSegments.push_back(&Phdr);
 737   }
 738
 739   auto toMappedAddr = [&](uint64_t VAddr) -> const uint8_t * {
 740     const Elf_Phdr **I = std::upper_bound(
 741         LoadSegments.begin(), LoadSegments.end(), VAddr, compareAddr<ELFT>);
 742     if (I == LoadSegments.begin())
 743       report_fatal_error("Virtual address is not in any segment");
 744     --I;
 745     const Elf_Phdr &Phdr = **I;
 746     uint64_t Delta = VAddr - Phdr.p_vaddr;
 747     if (Delta >= Phdr.p_filesz)
 748       report_fatal_error("Virtual address is not in any segment");
 749     return this->base() + Phdr.p_offset + Delta;
 750   };
 751
 752   for (const Elf_Dyn &Dyn : dynamic_table()) {
 753     switch (Dyn.d_tag) {
 754     case ELF::DT_HASH:
 755       if (HashTable)
 756         continue;
 757       HashTable =
 758           reinterpret_cast<const Elf_Hash *>(toMappedAddr(Dyn.getPtr()));
 759       break;
 760     case ELF::DT_STRTAB:
 761       if (!DynStrRegion.Addr)
 762         DynStrRegion.Addr = toMappedAddr(Dyn.getPtr());
 763       break;
 764     case ELF::DT_STRSZ:
 765       if (!DynStrRegion.Size)
 766         DynStrRegion.Size = Dyn.getVal();
 767       break;
 768     case ELF::DT_RELA:
 769       if (!DynRelaRegion.Addr)
 770         DynRelaRegion.Addr = toMappedAddr(Dyn.getPtr());
 771       break;
 772     case ELF::DT_RELASZ:
 773       DynRelaRegion.Size = Dyn.getVal();
 774       break;
 775     case ELF::DT_RELAENT:
 776       DynRelaRegion.EntSize = Dyn.getVal();
 777     }
 778   }
 779 }
 780
 781 template <class ELFT>
 782 const typename ELFFile<ELFT>::Elf_Shdr *ELFFile<ELFT>::section_begin() const {
 783   if (Header->e_shentsize != sizeof(Elf_Shdr))
 784     report_fatal_error(
 785         "Invalid section header entry size (e_shentsize) in ELF header");
 786   return reinterpret_cast<const Elf_Shdr *>(base() + Header->e_shoff);
 787 }
 788
 789 template <class ELFT>
 790 const typename ELFFile<ELFT>::Elf_Shdr *ELFFile<ELFT>::section_end() const {
 791   return section_begin() + getNumSections();
 792 }
 793
 794 template <class ELFT>
 795 const typename ELFFile<ELFT>::Elf_Sym *ELFFile<ELFT>::symbol_begin() const {
 796   if (!dot_symtab_sec)
 797     return nullptr;
 798   if (dot_symtab_sec->sh_entsize != sizeof(Elf_Sym))
 799     report_fatal_error("Invalid symbol size");
 800   return reinterpret_cast<const Elf_Sym *>(base() + dot_symtab_sec->sh_offset);
 801 }
 802
 803 template <class ELFT>
 804 const typename ELFFile<ELFT>::Elf_Sym *ELFFile<ELFT>::symbol_end() const {
 805   if (!dot_symtab_sec)
 806     return nullptr;
 807   return reinterpret_cast<const Elf_Sym *>(base() + dot_symtab_sec->sh_offset +
 808                                            dot_symtab_sec->sh_size);
 809 }
 810
 811 template <class ELFT>
 812 const typename ELFFile<ELFT>::Elf_Dyn *
 813 ELFFile<ELFT>::dynamic_table_begin() const {
 814   return reinterpret_cast<const Elf_Dyn *>(DynamicRegion.Addr);
 815 }
 816
 817 template <class ELFT>
 818 const typename ELFFile<ELFT>::Elf_Dyn *
 819 ELFFile<ELFT>::dynamic_table_end() const {
 820   uint64_t Size = DynamicRegion.Size;
 821   if (Size % sizeof(Elf_Dyn))
 822     report_fatal_error("Invalid dynamic table size");
 823
 824   return dynamic_table_begin() + Size / sizeof(Elf_Dyn);
 825 }
 826
 827 template <class ELFT>
 828 StringRef ELFFile<ELFT>::getLoadName() const {
 829   if (!dt_soname) {
 830     dt_soname = "";
 831     // Find the DT_SONAME entry
 832     for (const auto &Entry : dynamic_table())
 833       if (Entry.getTag() == ELF::DT_SONAME) {
 834         dt_soname = getDynamicString(Entry.getVal());
 835         break;
 836       }
 837   }
 838   return dt_soname;
 839 }
 840
 841 template <class ELFT>
 842 template <typename T>
 843 const T *ELFFile<ELFT>::getEntry(uint32_t Section, uint32_t Entry) const {
 844   ErrorOr<const Elf_Shdr *> Sec = getSection(Section);
 845   if (std::error_code EC = Sec.getError())
 846     report_fatal_error(EC.message());
 847   return getEntry<T>(*Sec, Entry);
 848 }
 849
 850 template <class ELFT>
 851 template <typename T>
 852 const T *ELFFile<ELFT>::getEntry(const Elf_Shdr *Section,
 853                                  uint32_t Entry) const {
 854   return reinterpret_cast<const T *>(base() + Section->sh_offset +
 855                                      (Entry * Section->sh_entsize));
 856 }
 857
 858 template <class ELFT>
 859 ErrorOr<const typename ELFFile<ELFT>::Elf_Shdr *>
 860 ELFFile<ELFT>::getSection(uint32_t Index) const {
 861   assert(SectionHeaderTable && "SectionHeaderTable not initialized!");
 862   if (Index >= getNumSections())
 863     return object_error::invalid_section_index;
 864
 865   return reinterpret_cast<const Elf_Shdr *>(
 866       reinterpret_cast<const char *>(SectionHeaderTable) +
 867       (Index * Header->e_shentsize));
 868 }
 869
 870 template <class ELFT>
 871 ErrorOr<StringRef>
 872 ELFFile<ELFT>::getStringTable(const Elf_Shdr *Section) const {
 873   if (Section->sh_type != ELF::SHT_STRTAB)
 874     return object_error::parse_failed;
 875   uint64_t Offset = Section->sh_offset;
 876   uint64_t Size = Section->sh_size;
 877   if (Offset + Size > Buf.size())
 878     return object_error::parse_failed;
 879   StringRef Data((const char *)base() + Section->sh_offset, Size);
 880   if (Data[Size - 1] != '\0')
 881     return object_error::string_table_non_null_end;
 882   return Data;
 883 }
 884
 885 template <class ELFT>
 886 const char *ELFFile<ELFT>::getDynamicString(uintX_t Offset) const {
 887   if (Offset >= DynStrRegion.Size)
 888     return nullptr;
 889   return (const char *)DynStrRegion.Addr + Offset;
 890 }
 891
 892 template <class ELFT>
 893 ErrorOr<StringRef>
 894 ELFFile<ELFT>::getStaticSymbolName(const Elf_Sym *Symb) const {
 895   return Symb->getName(DotStrtab);
 896 }
 897
 898 template <class ELFT>
 899 ErrorOr<StringRef>
 900 ELFFile<ELFT>::getDynamicSymbolName(const Elf_Sym *Symb) const {
 901   return StringRef(getDynamicString(Symb->st_name));
 902 }
 903
 904 template <class ELFT>
 905 ErrorOr<StringRef> ELFFile<ELFT>::getSymbolName(const Elf_Sym *Symb,
 906                                                 bool IsDynamic) const {
 907   if (IsDynamic)
 908     return getDynamicSymbolName(Symb);
 909   return getStaticSymbolName(Symb);
 910 }
 911
 912 template <class ELFT>
 913 ErrorOr<StringRef>
 914 ELFFile<ELFT>::getSectionName(const Elf_Shdr *Section) const {
 915   uint32_t Offset = Section->sh_name;
 916   if (Offset >= DotShstrtab.size())
 917     return object_error::parse_failed;
 918   return StringRef(DotShstrtab.data() + Offset);
 919 }
 920
 921 template <class ELFT>
 922 ErrorOr<StringRef> ELFFile<ELFT>::getSymbolVersion(const Elf_Shdr *section,
 923                                                    const Elf_Sym *symb,
 924                                                    bool &IsDefault) const {
 925   StringRef StrTab;
 926   if (section) {
 927     ErrorOr<StringRef> StrTabOrErr = getStringTable(section);
 928     if (std::error_code EC = StrTabOrErr.getError())
 929       return EC;
 930     StrTab = *StrTabOrErr;
 931   }
 932   // Handle non-dynamic symbols.
 933   if (section != DotDynSymSec && section != nullptr) {
 934     // Non-dynamic symbols can have versions in their names
 935     // A name of the form 'foo@V1' indicates version 'V1', non-default.
 936     // A name of the form 'foo@@V2' indicates version 'V2', default version.
 937     ErrorOr<StringRef> SymName = symb->getName(StrTab);
 938     if (!SymName)
 939       return SymName;
 940     StringRef Name = *SymName;
 941     size_t atpos = Name.find('@');
 942     if (atpos == StringRef::npos) {
 943       IsDefault = false;
 944       return StringRef("");
 945     }
 946     ++atpos;
 947     if (atpos < Name.size() && Name[atpos] == '@') {
 948       IsDefault = true;
 949       ++atpos;
 950     } else {
 951       IsDefault = false;
 952     }
 953     return Name.substr(atpos);
 954   }
 955
 956   // This is a dynamic symbol. Look in the GNU symbol version table.
 957   if (!dot_gnu_version_sec) {
 958     // No version table.
 959     IsDefault = false;
 960     return StringRef("");
 961   }
 962
 963   // Determine the position in the symbol table of this entry.
 964   size_t entry_index =
 965       (reinterpret_cast<uintptr_t>(symb) - DotDynSymSec->sh_offset -
 966        reinterpret_cast<uintptr_t>(base())) /
 967       sizeof(Elf_Sym);
 968
 969   // Get the corresponding version index entry
 970   const Elf_Versym *vs = getEntry<Elf_Versym>(dot_gnu_version_sec, entry_index);
 971   size_t version_index = vs->vs_index & ELF::VERSYM_VERSION;
 972
 973   // Special markers for unversioned symbols.
 974   if (version_index == ELF::VER_NDX_LOCAL ||
 975       version_index == ELF::VER_NDX_GLOBAL) {
 976     IsDefault = false;
 977     return StringRef("");
 978   }
 979
 980   // Lookup this symbol in the version table
 981   LoadVersionMap();
 982   if (version_index >= VersionMap.size() || VersionMap[version_index].isNull())
 983     return object_error::parse_failed;
 984   const VersionMapEntry &entry = VersionMap[version_index];
 985
 986   // Get the version name string
 987   size_t name_offset;
 988   if (entry.isVerdef()) {
 989     // The first Verdaux entry holds the name.
 990     name_offset = entry.getVerdef()->getAux()->vda_name;
 991   } else {
 992     name_offset = entry.getVernaux()->vna_name;
 993   }
 994
 995   // Set IsDefault
 996   if (entry.isVerdef()) {
 997     IsDefault = !(vs->vs_index & ELF::VERSYM_HIDDEN);
 998   } else {
 999     IsDefault = false;
1000   }
1001
1002   if (name_offset >= DynStrRegion.Size)
1003     return object_error::parse_failed;
1004   return StringRef(getDynamicString(name_offset));
1005 }
1006
1007 /// This function returns the hash value for a symbol in the .dynsym section
1008 /// Name of the API remains consistent as specified in the libelf
1009 /// REF : http://www.sco.com/developers/gabi/latest/ch5.dynamic.html#hash
1010 static inline unsigned elf_hash(StringRef &symbolName) {
1011   unsigned h = 0, g;
1012   for (unsigned i = 0, j = symbolName.size(); i < j; i++) {
1013     h = (h << 4) + symbolName[i];
1014     g = h & 0xf0000000L;
1015     if (g != 0)
1016       h ^= g >> 24;
1017     h &= ~g;
1018   }
1019   return h;
1020 }
1021 } // end namespace object
1022 } // end namespace llvm
1023
1024 #endif