include/llvm/Object/ELFObjectFile.h

   1 //===- ELFObjectFile.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 ELFObjectFile template class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_ELF_OBJECT_FILE_H
  15 #define LLVM_OBJECT_ELF_OBJECT_FILE_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/ADT/PointerIntPair.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/ADT/StringSwitch.h"
  21 #include "llvm/ADT/Triple.h"
  22 #include "llvm/Object/ELF.h"
  23 #include "llvm/Object/ObjectFile.h"
  24 #include "llvm/Support/Casting.h"
  25 #include "llvm/Support/ELF.h"
  26 #include "llvm/Support/Endian.h"
  27 #include "llvm/Support/ErrorHandling.h"
  28 #include "llvm/Support/MemoryBuffer.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include <algorithm>
  31 #include <cctype>
  32 #include <limits>
  33 #include <utility>
  34
  35 namespace llvm {
  36 namespace object {
  37
  38 template <class ELFT>
  39 class ELFObjectFile : public ObjectFile {
  40 public:
  41   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
  42
  43   typedef typename ELFFile<ELFT>::uintX_t uintX_t;
  44
  45   typedef typename ELFFile<ELFT>::Elf_Sym Elf_Sym;
  46   typedef typename ELFFile<ELFT>::Elf_Shdr Elf_Shdr;
  47   typedef typename ELFFile<ELFT>::Elf_Rel Elf_Rel;
  48   typedef typename ELFFile<ELFT>::Elf_Rela Elf_Rela;
  49   typedef typename ELFFile<ELFT>::Elf_Dyn Elf_Dyn;
  50
  51   typedef typename ELFFile<ELFT>::Elf_Sym_Iter Elf_Sym_Iter;
  52   typedef typename ELFFile<ELFT>::Elf_Shdr_Iter Elf_Shdr_Iter;
  53   typedef typename ELFFile<ELFT>::Elf_Dyn_Iter Elf_Dyn_Iter;
  54
  55 protected:
  56   ELFFile<ELFT> EF;
  57
  58   void moveSymbolNext(DataRefImpl &Symb) const LLVM_OVERRIDE;
  59   error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const
  60       LLVM_OVERRIDE;
  61   error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const
  62       LLVM_OVERRIDE;
  63   error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const
  64       LLVM_OVERRIDE;
  65   error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const
  66       LLVM_OVERRIDE;
  67   error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const LLVM_OVERRIDE;
  68   uint32_t getSymbolFlags(DataRefImpl Symb) const LLVM_OVERRIDE;
  69   error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const
  70       LLVM_OVERRIDE;
  71   error_code getSymbolSection(DataRefImpl Symb, section_iterator &Res) const
  72       LLVM_OVERRIDE;
  73   error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const;
  74
  75   error_code getLibraryNext(DataRefImpl Data, LibraryRef &Result) const
  76       LLVM_OVERRIDE;
  77   error_code getLibraryPath(DataRefImpl Data, StringRef &Res) const
  78       LLVM_OVERRIDE;
  79
  80   void moveSectionNext(DataRefImpl &Sec) const LLVM_OVERRIDE;
  81   error_code getSectionName(DataRefImpl Sec, StringRef &Res) const
  82       LLVM_OVERRIDE;
  83   error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const
  84       LLVM_OVERRIDE;
  85   error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const LLVM_OVERRIDE;
  86   error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
  87   error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const
  88       LLVM_OVERRIDE;
  89   error_code isSectionText(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  90   error_code isSectionData(DataRefImpl Sec, bool &Res) const;
  91   error_code isSectionBSS(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  92   error_code isSectionRequiredForExecution(DataRefImpl Sec, bool &Res) const
  93       LLVM_OVERRIDE;
  94   error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
  95   error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const LLVM_OVERRIDE;
  96   error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
  97   error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
  98                                    bool &Result) const LLVM_OVERRIDE;
  99   relocation_iterator section_rel_begin(DataRefImpl Sec) const;
 100   relocation_iterator section_rel_end(DataRefImpl Sec) const LLVM_OVERRIDE;
 101   section_iterator getRelocatedSection(DataRefImpl Sec) const LLVM_OVERRIDE;
 102
 103   void moveRelocationNext(DataRefImpl &Rel) const LLVM_OVERRIDE;
 104   error_code getRelocationAddress(DataRefImpl Rel, uint64_t &Res) const
 105       LLVM_OVERRIDE;
 106   error_code getRelocationOffset(DataRefImpl Rel, uint64_t &Res) const
 107       LLVM_OVERRIDE;
 108   symbol_iterator getRelocationSymbol(DataRefImpl Rel) const LLVM_OVERRIDE;
 109   error_code getRelocationType(DataRefImpl Rel, uint64_t &Res) const;
 110   error_code getRelocationTypeName(DataRefImpl Rel,
 111                                    SmallVectorImpl<char> &Result) const
 112       LLVM_OVERRIDE;
 113   error_code getRelocationValueString(DataRefImpl Rel,
 114                                       SmallVectorImpl<char> &Result) const
 115       LLVM_OVERRIDE;
 116
 117   uint64_t getROffset(DataRefImpl Rel) const;
 118   StringRef getRelocationTypeName(uint32_t Type) const;
 119
 120   /// \brief Get the relocation section that contains \a Rel.
 121   const Elf_Shdr *getRelSection(DataRefImpl Rel) const {
 122     return EF.getSection(Rel.d.a);
 123   }
 124
 125   const Elf_Rel *getRel(DataRefImpl Rel) const;
 126   const Elf_Rela *getRela(DataRefImpl Rela) const;
 127
 128   Elf_Sym_Iter toELFSymIter(DataRefImpl Symb) const {
 129     bool IsDynamic = Symb.p & 1;
 130     if (IsDynamic)
 131       return Elf_Sym_Iter(
 132           EF.begin_dynamic_symbols().getEntSize(),
 133           reinterpret_cast<const char *>(Symb.p & ~uintptr_t(1)), IsDynamic);
 134     return Elf_Sym_Iter(EF.begin_symbols().getEntSize(),
 135                         reinterpret_cast<const char *>(Symb.p), IsDynamic);
 136   }
 137
 138   DataRefImpl toDRI(Elf_Sym_Iter Symb) const {
 139     DataRefImpl DRI;
 140     DRI.p = reinterpret_cast<uintptr_t>(Symb.get()) |
 141       static_cast<uintptr_t>(Symb.isDynamic());
 142     return DRI;
 143   }
 144
 145   Elf_Shdr_Iter toELFShdrIter(DataRefImpl Sec) const {
 146     return Elf_Shdr_Iter(EF.getHeader()->e_shentsize,
 147                          reinterpret_cast<const char *>(Sec.p));
 148   }
 149
 150   DataRefImpl toDRI(Elf_Shdr_Iter Sec) const {
 151     DataRefImpl DRI;
 152     DRI.p = reinterpret_cast<uintptr_t>(Sec.get());
 153     return DRI;
 154   }
 155
 156   DataRefImpl toDRI(const Elf_Shdr *Sec) const {
 157     DataRefImpl DRI;
 158     DRI.p = reinterpret_cast<uintptr_t>(Sec);
 159     return DRI;
 160   }
 161
 162   Elf_Dyn_Iter toELFDynIter(DataRefImpl Dyn) const {
 163     return Elf_Dyn_Iter(EF.begin_dynamic_table().getEntSize(),
 164                         reinterpret_cast<const char *>(Dyn.p));
 165   }
 166
 167   DataRefImpl toDRI(Elf_Dyn_Iter Dyn) const {
 168     DataRefImpl DRI;
 169     DRI.p = reinterpret_cast<uintptr_t>(Dyn.get());
 170     return DRI;
 171   }
 172
 173   // This flag is used for classof, to distinguish ELFObjectFile from
 174   // its subclass. If more subclasses will be created, this flag will
 175   // have to become an enum.
 176   bool isDyldELFObject;
 177
 178 public:
 179   ELFObjectFile(MemoryBuffer *Object, error_code &EC, bool BufferOwned = true);
 180
 181   const Elf_Sym *getSymbol(DataRefImpl Symb) const;
 182
 183   basic_symbol_iterator symbol_begin_impl() const LLVM_OVERRIDE;
 184   basic_symbol_iterator symbol_end_impl() const LLVM_OVERRIDE;
 185
 186   symbol_iterator dynamic_symbol_begin() const;
 187   symbol_iterator dynamic_symbol_end() const;
 188
 189   section_iterator section_begin() const LLVM_OVERRIDE;
 190   section_iterator section_end() const LLVM_OVERRIDE;
 191
 192   library_iterator needed_library_begin() const LLVM_OVERRIDE;
 193   library_iterator needed_library_end() const LLVM_OVERRIDE;
 194
 195   error_code getRelocationAddend(DataRefImpl Rel, int64_t &Res) const;
 196   error_code getSymbolVersion(SymbolRef Symb, StringRef &Version,
 197                               bool &IsDefault) const;
 198
 199
 200   uint8_t getBytesInAddress() const LLVM_OVERRIDE;
 201   StringRef getFileFormatName() const LLVM_OVERRIDE;
 202   unsigned getArch() const LLVM_OVERRIDE;
 203   StringRef getLoadName() const LLVM_OVERRIDE;
 204
 205   const ELFFile<ELFT> *getELFFile() const { return &EF; }
 206
 207   bool isDyldType() const { return isDyldELFObject; }
 208   static inline bool classof(const Binary *v) {
 209     return v->getType() == getELFType(ELFT::TargetEndianness == support::little,
 210                                       ELFT::Is64Bits);
 211   }
 212 };
 213
 214 // Use an alignment of 2 for the typedefs since that is the worst case for
 215 // ELF files in archives.
 216 typedef ELFObjectFile<ELFType<support::little, 2, false> > ELF32LEObjectFile;
 217 typedef ELFObjectFile<ELFType<support::little, 2, true> > ELF64LEObjectFile;
 218 typedef ELFObjectFile<ELFType<support::big, 2, false> > ELF32BEObjectFile;
 219 typedef ELFObjectFile<ELFType<support::big, 2, true> > ELF64BEObjectFile;
 220
 221 template <class ELFT>
 222 void ELFObjectFile<ELFT>::moveSymbolNext(DataRefImpl &Symb) const {
 223   Symb = toDRI(++toELFSymIter(Symb));
 224 }
 225
 226 template <class ELFT>
 227 error_code ELFObjectFile<ELFT>::getSymbolName(DataRefImpl Symb,
 228                                               StringRef &Result) const {
 229   ErrorOr<StringRef> Name = EF.getSymbolName(toELFSymIter(Symb));
 230   if (!Name)
 231     return Name.getError();
 232   Result = *Name;
 233   return object_error::success;
 234 }
 235
 236 template <class ELFT>
 237 error_code ELFObjectFile<ELFT>::getSymbolVersion(SymbolRef SymRef,
 238                                                  StringRef &Version,
 239                                                  bool &IsDefault) const {
 240   DataRefImpl Symb = SymRef.getRawDataRefImpl();
 241   const Elf_Sym *symb = getSymbol(Symb);
 242   ErrorOr<StringRef> Ver =
 243       EF.getSymbolVersion(EF.getSection(Symb.d.b), symb, IsDefault);
 244   if (!Ver)
 245     return Ver.getError();
 246   Version = *Ver;
 247   return object_error::success;
 248 }
 249
 250 template <class ELFT>
 251 error_code ELFObjectFile<ELFT>::getSymbolFileOffset(DataRefImpl Symb,
 252                                                     uint64_t &Result) const {
 253   const Elf_Sym *ESym = getSymbol(Symb);
 254   const Elf_Shdr *ESec;
 255   switch (EF.getSymbolTableIndex(ESym)) {
 256   case ELF::SHN_COMMON:
 257   // Unintialized symbols have no offset in the object file
 258   case ELF::SHN_UNDEF:
 259     Result = UnknownAddressOrSize;
 260     return object_error::success;
 261   case ELF::SHN_ABS:
 262     Result = ESym->st_value;
 263     return object_error::success;
 264   default:
 265     ESec = EF.getSection(ESym);
 266   }
 267
 268   switch (ESym->getType()) {
 269   case ELF::STT_SECTION:
 270     Result = ESec ? ESec->sh_offset : UnknownAddressOrSize;
 271     return object_error::success;
 272   case ELF::STT_FUNC:
 273   case ELF::STT_OBJECT:
 274   case ELF::STT_NOTYPE:
 275     Result = ESym->st_value + (ESec ? ESec->sh_offset : 0);
 276     return object_error::success;
 277   default:
 278     Result = UnknownAddressOrSize;
 279     return object_error::success;
 280   }
 281 }
 282
 283 template <class ELFT>
 284 error_code ELFObjectFile<ELFT>::getSymbolAddress(DataRefImpl Symb,
 285                                                  uint64_t &Result) const {
 286   const Elf_Sym *ESym = getSymbol(Symb);
 287   const Elf_Shdr *ESec;
 288   switch (EF.getSymbolTableIndex(ESym)) {
 289   case ELF::SHN_COMMON:
 290   case ELF::SHN_UNDEF:
 291     Result = UnknownAddressOrSize;
 292     return object_error::success;
 293   case ELF::SHN_ABS:
 294     Result = ESym->st_value;
 295     return object_error::success;
 296   default:
 297     ESec = EF.getSection(ESym);
 298   }
 299
 300   switch (ESym->getType()) {
 301   case ELF::STT_SECTION:
 302     Result = ESec ? ESec->sh_addr : UnknownAddressOrSize;
 303     return object_error::success;
 304   case ELF::STT_FUNC:
 305   case ELF::STT_OBJECT:
 306   case ELF::STT_NOTYPE:
 307   case ELF::STT_TLS:
 308     bool IsRelocatable;
 309     switch (EF.getHeader()->e_type) {
 310     case ELF::ET_EXEC:
 311     case ELF::ET_DYN:
 312       IsRelocatable = false;
 313       break;
 314     default:
 315       IsRelocatable = true;
 316     }
 317     Result = ESym->st_value;
 318
 319     // Clear the ARM/Thumb indicator flag.
 320     if (EF.getHeader()->e_machine == ELF::EM_ARM)
 321       Result &= ~1;
 322
 323     if (IsRelocatable && ESec != 0)
 324       Result += ESec->sh_addr;
 325     return object_error::success;
 326   default:
 327     Result = UnknownAddressOrSize;
 328     return object_error::success;
 329   }
 330 }
 331
 332 template <class ELFT>
 333 error_code ELFObjectFile<ELFT>::getSymbolAlignment(DataRefImpl Symb,
 334                                                    uint32_t &Res) const {
 335   Elf_Sym_Iter Sym = toELFSymIter(Symb);
 336   if (Sym->st_shndx == ELF::SHN_COMMON)
 337     Res = Sym->st_value;
 338   else
 339     Res = 0;
 340   return object_error::success;
 341 }
 342
 343 template <class ELFT>
 344 error_code ELFObjectFile<ELFT>::getSymbolSize(DataRefImpl Symb,
 345                                               uint64_t &Result) const {
 346   Result = toELFSymIter(Symb)->st_size;
 347   return object_error::success;
 348 }
 349
 350 template <class ELFT>
 351 error_code ELFObjectFile<ELFT>::getSymbolType(DataRefImpl Symb,
 352                                               SymbolRef::Type &Result) const {
 353   const Elf_Sym *ESym = getSymbol(Symb);
 354
 355   switch (ESym->getType()) {
 356   case ELF::STT_NOTYPE:
 357     Result = SymbolRef::ST_Unknown;
 358     break;
 359   case ELF::STT_SECTION:
 360     Result = SymbolRef::ST_Debug;
 361     break;
 362   case ELF::STT_FILE:
 363     Result = SymbolRef::ST_File;
 364     break;
 365   case ELF::STT_FUNC:
 366     Result = SymbolRef::ST_Function;
 367     break;
 368   case ELF::STT_OBJECT:
 369   case ELF::STT_COMMON:
 370   case ELF::STT_TLS:
 371     Result = SymbolRef::ST_Data;
 372     break;
 373   default:
 374     Result = SymbolRef::ST_Other;
 375     break;
 376   }
 377   return object_error::success;
 378 }
 379
 380 template <class ELFT>
 381 uint32_t ELFObjectFile<ELFT>::getSymbolFlags(DataRefImpl Symb) const {
 382   Elf_Sym_Iter EIter = toELFSymIter(Symb);
 383   const Elf_Sym *ESym = &*EIter;
 384
 385   uint32_t Result = SymbolRef::SF_None;
 386
 387   if (ESym->getBinding() != ELF::STB_LOCAL)
 388     Result |= SymbolRef::SF_Global;
 389
 390   if (ESym->getBinding() == ELF::STB_WEAK)
 391     Result |= SymbolRef::SF_Weak;
 392
 393   if (ESym->st_shndx == ELF::SHN_ABS)
 394     Result |= SymbolRef::SF_Absolute;
 395
 396   if (ESym->getType() == ELF::STT_FILE || ESym->getType() == ELF::STT_SECTION ||
 397       EIter == EF.begin_symbols() || EIter == EF.begin_dynamic_symbols())
 398     Result |= SymbolRef::SF_FormatSpecific;
 399
 400   if (EF.getSymbolTableIndex(ESym) == ELF::SHN_UNDEF)
 401     Result |= SymbolRef::SF_Undefined;
 402
 403   if (ESym->getType() == ELF::STT_COMMON ||
 404       EF.getSymbolTableIndex(ESym) == ELF::SHN_COMMON)
 405     Result |= SymbolRef::SF_Common;
 406
 407   return Result;
 408 }
 409
 410 template <class ELFT>
 411 error_code ELFObjectFile<ELFT>::getSymbolSection(DataRefImpl Symb,
 412                                                  section_iterator &Res) const {
 413   const Elf_Sym *ESym = getSymbol(Symb);
 414   const Elf_Shdr *ESec = EF.getSection(ESym);
 415   if (!ESec)
 416     Res = section_end();
 417   else {
 418     DataRefImpl Sec;
 419     Sec.p = reinterpret_cast<intptr_t>(ESec);
 420     Res = section_iterator(SectionRef(Sec, this));
 421   }
 422   return object_error::success;
 423 }
 424
 425 template <class ELFT>
 426 error_code ELFObjectFile<ELFT>::getSymbolValue(DataRefImpl Symb,
 427                                                uint64_t &Val) const {
 428   const Elf_Sym *ESym = getSymbol(Symb);
 429   Val = ESym->st_value;
 430   return object_error::success;
 431 }
 432
 433 template <class ELFT>
 434 void ELFObjectFile<ELFT>::moveSectionNext(DataRefImpl &Sec) const {
 435   Sec = toDRI(++toELFShdrIter(Sec));
 436 }
 437
 438 template <class ELFT>
 439 error_code ELFObjectFile<ELFT>::getSectionName(DataRefImpl Sec,
 440                                                StringRef &Result) const {
 441   ErrorOr<StringRef> Name = EF.getSectionName(&*toELFShdrIter(Sec));
 442   if (!Name)
 443     return Name.getError();
 444   Result = *Name;
 445   return object_error::success;
 446 }
 447
 448 template <class ELFT>
 449 error_code ELFObjectFile<ELFT>::getSectionAddress(DataRefImpl Sec,
 450                                                   uint64_t &Result) const {
 451   Result = toELFShdrIter(Sec)->sh_addr;
 452   return object_error::success;
 453 }
 454
 455 template <class ELFT>
 456 error_code ELFObjectFile<ELFT>::getSectionSize(DataRefImpl Sec,
 457                                                uint64_t &Result) const {
 458   Result = toELFShdrIter(Sec)->sh_size;
 459   return object_error::success;
 460 }
 461
 462 template <class ELFT>
 463 error_code ELFObjectFile<ELFT>::getSectionContents(DataRefImpl Sec,
 464                                                    StringRef &Result) const {
 465   Elf_Shdr_Iter EShdr = toELFShdrIter(Sec);
 466   Result = StringRef((const char *)base() + EShdr->sh_offset, EShdr->sh_size);
 467   return object_error::success;
 468 }
 469
 470 template <class ELFT>
 471 error_code ELFObjectFile<ELFT>::getSectionAlignment(DataRefImpl Sec,
 472                                                     uint64_t &Result) const {
 473   Result = toELFShdrIter(Sec)->sh_addralign;
 474   return object_error::success;
 475 }
 476
 477 template <class ELFT>
 478 error_code ELFObjectFile<ELFT>::isSectionText(DataRefImpl Sec,
 479                                               bool &Result) const {
 480   Result = toELFShdrIter(Sec)->sh_flags & ELF::SHF_EXECINSTR;
 481   return object_error::success;
 482 }
 483
 484 template <class ELFT>
 485 error_code ELFObjectFile<ELFT>::isSectionData(DataRefImpl Sec,
 486                                               bool &Result) const {
 487   Elf_Shdr_Iter EShdr = toELFShdrIter(Sec);
 488   Result = EShdr->sh_flags & (ELF::SHF_ALLOC | ELF::SHF_WRITE) &&
 489            EShdr->sh_type == ELF::SHT_PROGBITS;
 490   return object_error::success;
 491 }
 492
 493 template <class ELFT>
 494 error_code ELFObjectFile<ELFT>::isSectionBSS(DataRefImpl Sec,
 495                                              bool &Result) const {
 496   Elf_Shdr_Iter EShdr = toELFShdrIter(Sec);
 497   Result = EShdr->sh_flags & (ELF::SHF_ALLOC | ELF::SHF_WRITE) &&
 498            EShdr->sh_type == ELF::SHT_NOBITS;
 499   return object_error::success;
 500 }
 501
 502 template <class ELFT>
 503 error_code
 504 ELFObjectFile<ELFT>::isSectionRequiredForExecution(DataRefImpl Sec,
 505                                                    bool &Result) const {
 506   Result = toELFShdrIter(Sec)->sh_flags & ELF::SHF_ALLOC;
 507   return object_error::success;
 508 }
 509
 510 template <class ELFT>
 511 error_code ELFObjectFile<ELFT>::isSectionVirtual(DataRefImpl Sec,
 512                                                  bool &Result) const {
 513   Result = toELFShdrIter(Sec)->sh_type == ELF::SHT_NOBITS;
 514   return object_error::success;
 515 }
 516
 517 template <class ELFT>
 518 error_code ELFObjectFile<ELFT>::isSectionZeroInit(DataRefImpl Sec,
 519                                                   bool &Result) const {
 520   Result = toELFShdrIter(Sec)->sh_type == ELF::SHT_NOBITS;
 521   return object_error::success;
 522 }
 523
 524 template <class ELFT>
 525 error_code ELFObjectFile<ELFT>::isSectionReadOnlyData(DataRefImpl Sec,
 526                                                       bool &Result) const {
 527   Elf_Shdr_Iter EShdr = toELFShdrIter(Sec);
 528   Result = !(EShdr->sh_flags & (ELF::SHF_WRITE | ELF::SHF_EXECINSTR));
 529   return object_error::success;
 530 }
 531
 532 template <class ELFT>
 533 error_code ELFObjectFile<ELFT>::sectionContainsSymbol(DataRefImpl Sec,
 534                                                       DataRefImpl Symb,
 535                                                       bool &Result) const {
 536   Elf_Sym_Iter ESym = toELFSymIter(Symb);
 537
 538   uintX_t Index = ESym->st_shndx;
 539   bool Reserved = Index >= ELF::SHN_LORESERVE && Index <= ELF::SHN_HIRESERVE;
 540
 541   Result = !Reserved && (&*toELFShdrIter(Sec) == EF.getSection(ESym->st_shndx));
 542   return object_error::success;
 543 }
 544
 545 template <class ELFT>
 546 relocation_iterator
 547 ELFObjectFile<ELFT>::section_rel_begin(DataRefImpl Sec) const {
 548   DataRefImpl RelData;
 549   uintptr_t SHT = reinterpret_cast<uintptr_t>(EF.begin_sections().get());
 550   RelData.d.a = (Sec.p - SHT) / EF.getHeader()->e_shentsize;
 551   RelData.d.b = 0;
 552   return relocation_iterator(RelocationRef(RelData, this));
 553 }
 554
 555 template <class ELFT>
 556 relocation_iterator
 557 ELFObjectFile<ELFT>::section_rel_end(DataRefImpl Sec) const {
 558   DataRefImpl RelData;
 559   uintptr_t SHT = reinterpret_cast<uintptr_t>(EF.begin_sections().get());
 560   const Elf_Shdr *S = reinterpret_cast<const Elf_Shdr *>(Sec.p);
 561   RelData.d.a = (Sec.p - SHT) / EF.getHeader()->e_shentsize;
 562   if (S->sh_type != ELF::SHT_RELA && S->sh_type != ELF::SHT_REL)
 563     RelData.d.b = 0;
 564   else
 565     RelData.d.b = S->sh_size / S->sh_entsize;
 566
 567   return relocation_iterator(RelocationRef(RelData, this));
 568 }
 569
 570 template <class ELFT>
 571 section_iterator
 572 ELFObjectFile<ELFT>::getRelocatedSection(DataRefImpl Sec) const {
 573   if (EF.getHeader()->e_type != ELF::ET_REL)
 574     return section_end();
 575
 576   Elf_Shdr_Iter EShdr = toELFShdrIter(Sec);
 577   uintX_t Type = EShdr->sh_type;
 578   if (Type != ELF::SHT_REL && Type != ELF::SHT_RELA)
 579     return section_end();
 580
 581   const Elf_Shdr *R = EF.getSection(EShdr->sh_info);
 582   return section_iterator(SectionRef(toDRI(R), this));
 583 }
 584
 585 // Relocations
 586 template <class ELFT>
 587 void ELFObjectFile<ELFT>::moveRelocationNext(DataRefImpl &Rel) const {
 588   ++Rel.d.b;
 589 }
 590
 591 template <class ELFT>
 592 symbol_iterator
 593 ELFObjectFile<ELFT>::getRelocationSymbol(DataRefImpl Rel) const {
 594   uint32_t symbolIdx;
 595   const Elf_Shdr *sec = getRelSection(Rel);
 596   switch (sec->sh_type) {
 597   default:
 598     report_fatal_error("Invalid section type in Rel!");
 599   case ELF::SHT_REL: {
 600     symbolIdx = getRel(Rel)->getSymbol(EF.isMips64EL());
 601     break;
 602   }
 603   case ELF::SHT_RELA: {
 604     symbolIdx = getRela(Rel)->getSymbol(EF.isMips64EL());
 605     break;
 606   }
 607   }
 608   if (!symbolIdx)
 609     return symbol_end();
 610
 611   const Elf_Shdr *SymSec = EF.getSection(sec->sh_link);
 612
 613   DataRefImpl SymbolData;
 614   switch (SymSec->sh_type) {
 615   default:
 616     report_fatal_error("Invalid symbol table section type!");
 617   case ELF::SHT_SYMTAB:
 618     SymbolData = toDRI(EF.begin_symbols() + symbolIdx);
 619     break;
 620   case ELF::SHT_DYNSYM:
 621     SymbolData = toDRI(EF.begin_dynamic_symbols() + symbolIdx);
 622     break;
 623   }
 624
 625   return symbol_iterator(SymbolRef(SymbolData, this));
 626 }
 627
 628 template <class ELFT>
 629 error_code ELFObjectFile<ELFT>::getRelocationAddress(DataRefImpl Rel,
 630                                                      uint64_t &Result) const {
 631   Result = getROffset(Rel);
 632   return object_error::success;
 633 }
 634
 635 template <class ELFT>
 636 error_code ELFObjectFile<ELFT>::getRelocationOffset(DataRefImpl Rel,
 637                                                     uint64_t &Result) const {
 638   Result = getROffset(Rel);
 639   return object_error::success;
 640 }
 641
 642 template <class ELFT>
 643 uint64_t ELFObjectFile<ELFT>::getROffset(DataRefImpl Rel) const {
 644   const Elf_Shdr *sec = getRelSection(Rel);
 645   switch (sec->sh_type) {
 646   default:
 647     report_fatal_error("Invalid section type in Rel!");
 648   case ELF::SHT_REL:
 649     return getRel(Rel)->r_offset;
 650   case ELF::SHT_RELA:
 651     return getRela(Rel)->r_offset;
 652   }
 653 }
 654
 655 template <class ELFT>
 656 error_code ELFObjectFile<ELFT>::getRelocationType(DataRefImpl Rel,
 657                                                   uint64_t &Result) const {
 658   const Elf_Shdr *sec = getRelSection(Rel);
 659   switch (sec->sh_type) {
 660   default:
 661     report_fatal_error("Invalid section type in Rel!");
 662   case ELF::SHT_REL: {
 663     Result = getRel(Rel)->getType(EF.isMips64EL());
 664     break;
 665   }
 666   case ELF::SHT_RELA: {
 667     Result = getRela(Rel)->getType(EF.isMips64EL());
 668     break;
 669   }
 670   }
 671   return object_error::success;
 672 }
 673
 674 template <class ELFT>
 675 StringRef ELFObjectFile<ELFT>::getRelocationTypeName(uint32_t Type) const {
 676   return getELFRelocationTypeName(EF.getHeader()->e_machine, Type);
 677 }
 678
 679 template <class ELFT>
 680 error_code ELFObjectFile<ELFT>::getRelocationTypeName(
 681     DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
 682   const Elf_Shdr *sec = getRelSection(Rel);
 683   uint32_t type;
 684   switch (sec->sh_type) {
 685   default:
 686     return object_error::parse_failed;
 687   case ELF::SHT_REL: {
 688     type = getRel(Rel)->getType(EF.isMips64EL());
 689     break;
 690   }
 691   case ELF::SHT_RELA: {
 692     type = getRela(Rel)->getType(EF.isMips64EL());
 693     break;
 694   }
 695   }
 696
 697   EF.getRelocationTypeName(type, Result);
 698   return object_error::success;
 699 }
 700
 701 template <class ELFT>
 702 error_code ELFObjectFile<ELFT>::getRelocationAddend(DataRefImpl Rel,
 703                                                     int64_t &Result) const {
 704   const Elf_Shdr *sec = getRelSection(Rel);
 705   switch (sec->sh_type) {
 706   default:
 707     report_fatal_error("Invalid section type in Rel!");
 708   case ELF::SHT_REL: {
 709     Result = 0;
 710     return object_error::success;
 711   }
 712   case ELF::SHT_RELA: {
 713     Result = getRela(Rel)->r_addend;
 714     return object_error::success;
 715   }
 716   }
 717 }
 718
 719 template <class ELFT>
 720 error_code ELFObjectFile<ELFT>::getRelocationValueString(
 721     DataRefImpl Rel, SmallVectorImpl<char> &Result) const {
 722   const Elf_Shdr *sec = getRelSection(Rel);
 723   uint8_t type;
 724   StringRef res;
 725   int64_t addend = 0;
 726   uint16_t symbol_index = 0;
 727   switch (sec->sh_type) {
 728   default:
 729     return object_error::parse_failed;
 730   case ELF::SHT_REL: {
 731     type = getRel(Rel)->getType(EF.isMips64EL());
 732     symbol_index = getRel(Rel)->getSymbol(EF.isMips64EL());
 733     // TODO: Read implicit addend from section data.
 734     break;
 735   }
 736   case ELF::SHT_RELA: {
 737     type = getRela(Rel)->getType(EF.isMips64EL());
 738     symbol_index = getRela(Rel)->getSymbol(EF.isMips64EL());
 739     addend = getRela(Rel)->r_addend;
 740     break;
 741   }
 742   }
 743   const Elf_Sym *symb =
 744       EF.template getEntry<Elf_Sym>(sec->sh_link, symbol_index);
 745   ErrorOr<StringRef> SymName =
 746       EF.getSymbolName(EF.getSection(sec->sh_link), symb);
 747   if (!SymName)
 748     return SymName.getError();
 749   switch (EF.getHeader()->e_machine) {
 750   case ELF::EM_X86_64:
 751     switch (type) {
 752     case ELF::R_X86_64_PC8:
 753     case ELF::R_X86_64_PC16:
 754     case ELF::R_X86_64_PC32: {
 755       std::string fmtbuf;
 756       raw_string_ostream fmt(fmtbuf);
 757       fmt << *SymName << (addend < 0 ? "" : "+") << addend << "-P";
 758       fmt.flush();
 759       Result.append(fmtbuf.begin(), fmtbuf.end());
 760     } break;
 761     case ELF::R_X86_64_8:
 762     case ELF::R_X86_64_16:
 763     case ELF::R_X86_64_32:
 764     case ELF::R_X86_64_32S:
 765     case ELF::R_X86_64_64: {
 766       std::string fmtbuf;
 767       raw_string_ostream fmt(fmtbuf);
 768       fmt << *SymName << (addend < 0 ? "" : "+") << addend;
 769       fmt.flush();
 770       Result.append(fmtbuf.begin(), fmtbuf.end());
 771     } break;
 772     default:
 773       res = "Unknown";
 774     }
 775     break;
 776   case ELF::EM_AARCH64: {
 777     std::string fmtbuf;
 778     raw_string_ostream fmt(fmtbuf);
 779     fmt << *SymName;
 780     if (addend != 0)
 781       fmt << (addend < 0 ? "" : "+") << addend;
 782     fmt.flush();
 783     Result.append(fmtbuf.begin(), fmtbuf.end());
 784     break;
 785   }
 786   case ELF::EM_ARM:
 787   case ELF::EM_HEXAGON:
 788   case ELF::EM_MIPS:
 789     res = *SymName;
 790     break;
 791   default:
 792     res = "Unknown";
 793   }
 794   if (Result.empty())
 795     Result.append(res.begin(), res.end());
 796   return object_error::success;
 797 }
 798
 799 template <class ELFT>
 800 const typename ELFFile<ELFT>::Elf_Sym *
 801 ELFObjectFile<ELFT>::getSymbol(DataRefImpl Symb) const {
 802   return &*toELFSymIter(Symb);
 803 }
 804
 805 template <class ELFT>
 806 const typename ELFObjectFile<ELFT>::Elf_Rel *
 807 ELFObjectFile<ELFT>::getRel(DataRefImpl Rel) const {
 808   return EF.template getEntry<Elf_Rel>(Rel.d.a, Rel.d.b);
 809 }
 810
 811 template <class ELFT>
 812 const typename ELFObjectFile<ELFT>::Elf_Rela *
 813 ELFObjectFile<ELFT>::getRela(DataRefImpl Rela) const {
 814   return EF.template getEntry<Elf_Rela>(Rela.d.a, Rela.d.b);
 815 }
 816
 817 template <class ELFT>
 818 ELFObjectFile<ELFT>::ELFObjectFile(MemoryBuffer *Object, error_code &ec,
 819                                    bool BufferOwned)
 820     : ObjectFile(getELFType(static_cast<endianness>(ELFT::TargetEndianness) ==
 821                                 support::little,
 822                             ELFT::Is64Bits),
 823                  Object, BufferOwned),
 824       EF(Object, ec) {}
 825
 826 template <class ELFT>
 827 basic_symbol_iterator ELFObjectFile<ELFT>::symbol_begin_impl() const {
 828   return basic_symbol_iterator(SymbolRef(toDRI(EF.begin_symbols()), this));
 829 }
 830
 831 template <class ELFT>
 832 basic_symbol_iterator ELFObjectFile<ELFT>::symbol_end_impl() const {
 833   return basic_symbol_iterator(SymbolRef(toDRI(EF.end_symbols()), this));
 834 }
 835
 836 template <class ELFT>
 837 symbol_iterator ELFObjectFile<ELFT>::dynamic_symbol_begin() const {
 838   return symbol_iterator(SymbolRef(toDRI(EF.begin_dynamic_symbols()), this));
 839 }
 840
 841 template <class ELFT>
 842 symbol_iterator ELFObjectFile<ELFT>::dynamic_symbol_end() const {
 843   return symbol_iterator(SymbolRef(toDRI(EF.end_dynamic_symbols()), this));
 844 }
 845
 846 template <class ELFT>
 847 section_iterator ELFObjectFile<ELFT>::section_begin() const {
 848   return section_iterator(SectionRef(toDRI(EF.begin_sections()), this));
 849 }
 850
 851 template <class ELFT>
 852 section_iterator ELFObjectFile<ELFT>::section_end() const {
 853   return section_iterator(SectionRef(toDRI(EF.end_sections()), this));
 854 }
 855
 856 template <class ELFT>
 857 StringRef ELFObjectFile<ELFT>::getLoadName() const {
 858   Elf_Dyn_Iter DI = EF.begin_dynamic_table();
 859   Elf_Dyn_Iter DE = EF.end_dynamic_table();
 860
 861   while (DI != DE && DI->getTag() != ELF::DT_SONAME)
 862     ++DI;
 863
 864   if (DI != DE)
 865     return EF.getDynamicString(DI->getVal());
 866   return "";
 867 }
 868
 869 template <class ELFT>
 870 library_iterator ELFObjectFile<ELFT>::needed_library_begin() const {
 871   Elf_Dyn_Iter DI = EF.begin_dynamic_table();
 872   Elf_Dyn_Iter DE = EF.end_dynamic_table();
 873
 874   while (DI != DE && DI->getTag() != ELF::DT_SONAME)
 875     ++DI;
 876
 877   return library_iterator(LibraryRef(toDRI(DI), this));
 878 }
 879
 880 template <class ELFT>
 881 error_code ELFObjectFile<ELFT>::getLibraryNext(DataRefImpl Data,
 882                                                LibraryRef &Result) const {
 883   Elf_Dyn_Iter DI = toELFDynIter(Data);
 884   Elf_Dyn_Iter DE = EF.end_dynamic_table();
 885
 886   // Skip to the next DT_NEEDED entry.
 887   do
 888     ++DI;
 889   while (DI != DE && DI->getTag() != ELF::DT_NEEDED);
 890
 891   Result = LibraryRef(toDRI(DI), this);
 892   return object_error::success;
 893 }
 894
 895 template <class ELFT>
 896 error_code ELFObjectFile<ELFT>::getLibraryPath(DataRefImpl Data,
 897                                                StringRef &Res) const {
 898   Res = EF.getDynamicString(toELFDynIter(Data)->getVal());
 899   return object_error::success;
 900 }
 901
 902 template <class ELFT>
 903 library_iterator ELFObjectFile<ELFT>::needed_library_end() const {
 904   return library_iterator(LibraryRef(toDRI(EF.end_dynamic_table()), this));
 905 }
 906
 907 template <class ELFT>
 908 uint8_t ELFObjectFile<ELFT>::getBytesInAddress() const {
 909   return ELFT::Is64Bits ? 8 : 4;
 910 }
 911
 912 template <class ELFT>
 913 StringRef ELFObjectFile<ELFT>::getFileFormatName() const {
 914   switch (EF.getHeader()->e_ident[ELF::EI_CLASS]) {
 915   case ELF::ELFCLASS32:
 916     switch (EF.getHeader()->e_machine) {
 917     case ELF::EM_386:
 918       return "ELF32-i386";
 919     case ELF::EM_X86_64:
 920       return "ELF32-x86-64";
 921     case ELF::EM_ARM:
 922       return "ELF32-arm";
 923     case ELF::EM_HEXAGON:
 924       return "ELF32-hexagon";
 925     case ELF::EM_MIPS:
 926       return "ELF32-mips";
 927     case ELF::EM_PPC:
 928       return "ELF32-ppc";
 929     case ELF::EM_SPARC:
 930     case ELF::EM_SPARC32PLUS:
 931       return "ELF32-sparc";
 932     default:
 933       return "ELF32-unknown";
 934     }
 935   case ELF::ELFCLASS64:
 936     switch (EF.getHeader()->e_machine) {
 937     case ELF::EM_386:
 938       return "ELF64-i386";
 939     case ELF::EM_X86_64:
 940       return "ELF64-x86-64";
 941     case ELF::EM_AARCH64:
 942       return "ELF64-aarch64";
 943     case ELF::EM_PPC64:
 944       return "ELF64-ppc64";
 945     case ELF::EM_S390:
 946       return "ELF64-s390";
 947     case ELF::EM_SPARCV9:
 948       return "ELF64-sparc";
 949     case ELF::EM_MIPS:
 950       return "ELF64-mips";
 951     default:
 952       return "ELF64-unknown";
 953     }
 954   default:
 955     // FIXME: Proper error handling.
 956     report_fatal_error("Invalid ELFCLASS!");
 957   }
 958 }
 959
 960 template <class ELFT>
 961 unsigned ELFObjectFile<ELFT>::getArch() const {
 962   switch (EF.getHeader()->e_machine) {
 963   case ELF::EM_386:
 964     return Triple::x86;
 965   case ELF::EM_X86_64:
 966     return Triple::x86_64;
 967   case ELF::EM_AARCH64:
 968     return Triple::aarch64;
 969   case ELF::EM_ARM:
 970     return Triple::arm;
 971   case ELF::EM_HEXAGON:
 972     return Triple::hexagon;
 973   case ELF::EM_MIPS:
 974     return (ELFT::TargetEndianness == support::little) ? Triple::mipsel
 975                                                        : Triple::mips;
 976   case ELF::EM_PPC64:
 977     return (ELFT::TargetEndianness == support::little) ? Triple::ppc64le
 978                                                        : Triple::ppc64;
 979   case ELF::EM_S390:
 980     return Triple::systemz;
 981
 982   case ELF::EM_SPARC:
 983   case ELF::EM_SPARC32PLUS:
 984     return Triple::sparc;
 985   case ELF::EM_SPARCV9:
 986     return Triple::sparcv9;
 987
 988   default:
 989     return Triple::UnknownArch;
 990   }
 991 }
 992
 993 /// FIXME: Maybe we should have a base ElfObjectFile that is not a template
 994 /// and make these member functions?
 995 inline error_code getELFRelocationAddend(const RelocationRef R,
 996                                          int64_t &Addend) {
 997   const ObjectFile *Obj = R.getObjectFile();
 998   DataRefImpl DRI = R.getRawDataRefImpl();
 999   // Little-endian 32-bit
1000   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(Obj))
1001     return ELFObj->getRelocationAddend(DRI, Addend);
1002
1003   // Big-endian 32-bit
1004   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(Obj))
1005     return ELFObj->getRelocationAddend(DRI, Addend);
1006
1007   // Little-endian 64-bit
1008   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj))
1009     return ELFObj->getRelocationAddend(DRI, Addend);
1010
1011   // Big-endian 64-bit
1012   if (const ELF64BEObjectFile *ELFObj = dyn_cast<ELF64BEObjectFile>(Obj))
1013     return ELFObj->getRelocationAddend(DRI, Addend);
1014
1015   llvm_unreachable("Object passed to getELFRelocationAddend() is not ELF");
1016 }
1017
1018 inline std::pair<symbol_iterator, symbol_iterator>
1019 getELFDynamicSymbolIterators(SymbolicFile *Obj) {
1020   if (const ELF32LEObjectFile *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
1021     return std::make_pair(ELF->dynamic_symbol_begin(),
1022                           ELF->dynamic_symbol_end());
1023   if (const ELF64LEObjectFile *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
1024     return std::make_pair(ELF->dynamic_symbol_begin(),
1025                           ELF->dynamic_symbol_end());
1026   if (const ELF32BEObjectFile *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
1027     return std::make_pair(ELF->dynamic_symbol_begin(),
1028                           ELF->dynamic_symbol_end());
1029   if (const ELF64BEObjectFile *ELF = cast<ELF64BEObjectFile>(Obj))
1030     return std::make_pair(ELF->dynamic_symbol_begin(),
1031                           ELF->dynamic_symbol_end());
1032
1033   llvm_unreachable(
1034       "Object passed to getELFDynamicSymbolIterators() is not ELF");
1035 }
1036
1037 /// This is a generic interface for retrieving GNU symbol version
1038 /// information from an ELFObjectFile.
1039 inline error_code GetELFSymbolVersion(const ObjectFile *Obj,
1040                                       const SymbolRef &Sym, StringRef &Version,
1041                                       bool &IsDefault) {
1042   // Little-endian 32-bit
1043   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(Obj))
1044     return ELFObj->getSymbolVersion(Sym, Version, IsDefault);
1045
1046   // Big-endian 32-bit
1047   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(Obj))
1048     return ELFObj->getSymbolVersion(Sym, Version, IsDefault);
1049
1050   // Little-endian 64-bit
1051   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj))
1052     return ELFObj->getSymbolVersion(Sym, Version, IsDefault);
1053
1054   // Big-endian 64-bit
1055   if (const ELF64BEObjectFile *ELFObj = dyn_cast<ELF64BEObjectFile>(Obj))
1056     return ELFObj->getSymbolVersion(Sym, Version, IsDefault);
1057
1058   llvm_unreachable("Object passed to GetELFSymbolVersion() is not ELF");
1059 }
1060 }
1061 }
1062
1063 #endif