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