include/llvm/Object/ObjectFile.h

   1 //===- ObjectFile.h - File format independent object file -------*- 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 a file format independent ObjectFile class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_OBJECTFILE_H
  15 #define LLVM_OBJECT_OBJECTFILE_H
  16
  17 #include "llvm/ADT/StringRef.h"
  18 #include "llvm/Object/SymbolicFile.h"
  19 #include "llvm/Support/DataTypes.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/FileSystem.h"
  22 #include "llvm/Support/MemoryBuffer.h"
  23 #include <cstring>
  24 #include <vector>
  25
  26 namespace llvm {
  27 namespace object {
  28
  29 class ObjectFile;
  30
  31 class SymbolRef;
  32 class symbol_iterator;
  33
  34 /// RelocationRef - This is a value type class that represents a single
  35 /// relocation in the list of relocations in the object file.
  36 class RelocationRef {
  37   DataRefImpl RelocationPimpl;
  38   const ObjectFile *OwningObject;
  39
  40 public:
  41   RelocationRef() : OwningObject(nullptr) { }
  42
  43   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
  44
  45   bool operator==(const RelocationRef &Other) const;
  46
  47   void moveNext();
  48
  49   error_code getAddress(uint64_t &Result) const;
  50   error_code getOffset(uint64_t &Result) const;
  51   symbol_iterator getSymbol() const;
  52   error_code getType(uint64_t &Result) const;
  53
  54   /// @brief Indicates whether this relocation should hidden when listing
  55   /// relocations, usually because it is the trailing part of a multipart
  56   /// relocation that will be printed as part of the leading relocation.
  57   error_code getHidden(bool &Result) const;
  58
  59   /// @brief Get a string that represents the type of this relocation.
  60   ///
  61   /// This is for display purposes only.
  62   error_code getTypeName(SmallVectorImpl<char> &Result) const;
  63
  64   /// @brief Get a string that represents the calculation of the value of this
  65   ///        relocation.
  66   ///
  67   /// This is for display purposes only.
  68   error_code getValueString(SmallVectorImpl<char> &Result) const;
  69
  70   DataRefImpl getRawDataRefImpl() const;
  71   const ObjectFile *getObjectFile() const;
  72 };
  73 typedef content_iterator<RelocationRef> relocation_iterator;
  74
  75 /// SectionRef - This is a value type class that represents a single section in
  76 /// the list of sections in the object file.
  77 class SectionRef;
  78 typedef content_iterator<SectionRef> section_iterator;
  79 class SectionRef {
  80   friend class SymbolRef;
  81   DataRefImpl SectionPimpl;
  82   const ObjectFile *OwningObject;
  83
  84 public:
  85   SectionRef() : OwningObject(nullptr) { }
  86
  87   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
  88
  89   bool operator==(const SectionRef &Other) const;
  90   bool operator!=(const SectionRef &Other) const;
  91   bool operator<(const SectionRef &Other) const;
  92
  93   void moveNext();
  94
  95   error_code getName(StringRef &Result) const;
  96   error_code getAddress(uint64_t &Result) const;
  97   error_code getSize(uint64_t &Result) const;
  98   error_code getContents(StringRef &Result) const;
  99
 100   /// @brief Get the alignment of this section as the actual value (not log 2).
 101   error_code getAlignment(uint64_t &Result) const;
 102
 103   // FIXME: Move to the normalization layer when it's created.
 104   error_code isText(bool &Result) const;
 105   error_code isData(bool &Result) const;
 106   error_code isBSS(bool &Result) const;
 107   error_code isRequiredForExecution(bool &Result) const;
 108   error_code isVirtual(bool &Result) const;
 109   error_code isZeroInit(bool &Result) const;
 110   error_code isReadOnlyData(bool &Result) const;
 111
 112   error_code containsSymbol(SymbolRef S, bool &Result) const;
 113
 114   relocation_iterator relocation_begin() const;
 115   relocation_iterator relocation_end() const;
 116   typedef iterator_range<relocation_iterator> relocation_iterator_range;
 117   relocation_iterator_range relocations() const {
 118     return relocation_iterator_range(relocation_begin(), relocation_end());
 119   }
 120   section_iterator getRelocatedSection() const;
 121
 122   DataRefImpl getRawDataRefImpl() const;
 123 };
 124
 125 /// SymbolRef - This is a value type class that represents a single symbol in
 126 /// the list of symbols in the object file.
 127 class SymbolRef : public BasicSymbolRef {
 128   friend class SectionRef;
 129
 130 public:
 131   SymbolRef() : BasicSymbolRef() {}
 132
 133   enum Type {
 134     ST_Unknown, // Type not specified
 135     ST_Data,
 136     ST_Debug,
 137     ST_File,
 138     ST_Function,
 139     ST_Other
 140   };
 141
 142   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 143
 144   error_code getName(StringRef &Result) const;
 145   /// Returns the symbol virtual address (i.e. address at which it will be
 146   /// mapped).
 147   error_code getAddress(uint64_t &Result) const;
 148   error_code getFileOffset(uint64_t &Result) const;
 149   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 150   error_code getAlignment(uint32_t &Result) const;
 151   error_code getSize(uint64_t &Result) const;
 152   error_code getType(SymbolRef::Type &Result) const;
 153
 154   /// @brief Get section this symbol is defined in reference to. Result is
 155   /// end_sections() if it is undefined or is an absolute symbol.
 156   error_code getSection(section_iterator &Result) const;
 157
 158   const ObjectFile *getObject() const;
 159 };
 160
 161 class symbol_iterator : public basic_symbol_iterator {
 162 public:
 163   symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
 164   symbol_iterator(const basic_symbol_iterator &B)
 165       : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
 166                                         cast<ObjectFile>(B->getObject()))) {}
 167
 168   const SymbolRef *operator->() const {
 169     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
 170     return static_cast<const SymbolRef*>(&P);
 171   }
 172
 173   const SymbolRef &operator*() const {
 174     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
 175     return static_cast<const SymbolRef&>(P);
 176   }
 177 };
 178
 179 /// LibraryRef - This is a value type class that represents a single library in
 180 /// the list of libraries needed by a shared or dynamic object.
 181 class LibraryRef {
 182   friend class SectionRef;
 183   DataRefImpl LibraryPimpl;
 184   const ObjectFile *OwningObject;
 185
 186 public:
 187   LibraryRef() : OwningObject(nullptr) { }
 188
 189   LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
 190
 191   bool operator==(const LibraryRef &Other) const;
 192   bool operator<(const LibraryRef &Other) const;
 193
 194   error_code getNext(LibraryRef &Result) const;
 195
 196   // Get the path to this library, as stored in the object file.
 197   error_code getPath(StringRef &Result) const;
 198
 199   DataRefImpl getRawDataRefImpl() const;
 200 };
 201 typedef content_iterator<LibraryRef> library_iterator;
 202
 203 /// ObjectFile - This class is the base class for all object file types.
 204 /// Concrete instances of this object are created by createObjectFile, which
 205 /// figures out which type to create.
 206 class ObjectFile : public SymbolicFile {
 207   virtual void anchor();
 208   ObjectFile() LLVM_DELETED_FUNCTION;
 209   ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
 210
 211 protected:
 212   ObjectFile(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
 213
 214   const uint8_t *base() const {
 215     return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
 216   }
 217
 218   // These functions are for SymbolRef to call internally. The main goal of
 219   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 220   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 221   // virtual functions because then it could not point into the memory mapped
 222   // file.
 223   //
 224   // Implementations assume that the DataRefImpl is valid and has not been
 225   // modified externally. It's UB otherwise.
 226   friend class SymbolRef;
 227   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
 228   error_code printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
 229   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
 230   virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
 231   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
 232   virtual error_code getSymbolType(DataRefImpl Symb,
 233                                    SymbolRef::Type &Res) const = 0;
 234   virtual error_code getSymbolSection(DataRefImpl Symb,
 235                                       section_iterator &Res) const = 0;
 236
 237   // Same as above for SectionRef.
 238   friend class SectionRef;
 239   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 240   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
 241   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
 242   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
 243   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
 244   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
 245   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 246   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 247   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 248   virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
 249                                                    bool &Res) const = 0;
 250   // A section is 'virtual' if its contents aren't present in the object image.
 251   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
 252   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
 253   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
 254   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 255                                            bool &Result) const = 0;
 256   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 257   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 258   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 259
 260   // Same as above for RelocationRef.
 261   friend class RelocationRef;
 262   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 263   virtual error_code getRelocationAddress(DataRefImpl Rel,
 264                                           uint64_t &Res) const =0;
 265   virtual error_code getRelocationOffset(DataRefImpl Rel,
 266                                          uint64_t &Res) const =0;
 267   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 268   virtual error_code getRelocationType(DataRefImpl Rel,
 269                                        uint64_t &Res) const = 0;
 270   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 271                                        SmallVectorImpl<char> &Result) const = 0;
 272   virtual error_code getRelocationValueString(DataRefImpl Rel,
 273                                        SmallVectorImpl<char> &Result) const = 0;
 274   virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
 275     Result = false;
 276     return object_error::success;
 277   }
 278
 279   // Same for LibraryRef
 280   friend class LibraryRef;
 281   virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
 282   virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
 283
 284 public:
 285   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 286   symbol_iterator_range symbols() const {
 287     return symbol_iterator_range(symbol_begin(), symbol_end());
 288   }
 289
 290   virtual section_iterator section_begin() const = 0;
 291   virtual section_iterator section_end() const = 0;
 292
 293   typedef iterator_range<section_iterator> section_iterator_range;
 294   section_iterator_range sections() const {
 295     return section_iterator_range(section_begin(), section_end());
 296   }
 297
 298   virtual library_iterator needed_library_begin() const = 0;
 299   virtual library_iterator needed_library_end() const = 0;
 300
 301   /// @brief The number of bytes used to represent an address in this object
 302   ///        file format.
 303   virtual uint8_t getBytesInAddress() const = 0;
 304
 305   virtual StringRef getFileFormatName() const = 0;
 306   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 307
 308   /// For shared objects, returns the name which this object should be
 309   /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
 310   /// LC_ID_DYLIB (install name) on MachO.
 311   virtual StringRef getLoadName() const = 0;
 312
 313   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 314   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 315   ///        return true.
 316   /// @brief Create ObjectFile from path.
 317   static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
 318   static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object,
 319                                                 bool BufferOwned,
 320                                                 sys::fs::file_magic Type);
 321   static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object) {
 322     return createObjectFile(Object, true, sys::fs::file_magic::unknown);
 323   }
 324
 325
 326   static inline bool classof(const Binary *v) {
 327     return v->isObject();
 328   }
 329
 330 public:
 331   static ErrorOr<ObjectFile *> createCOFFObjectFile(MemoryBuffer *Object,
 332                                                     bool BufferOwned = true);
 333   static ErrorOr<ObjectFile *> createELFObjectFile(MemoryBuffer *Object,
 334                                                    bool BufferOwned = true);
 335   static ErrorOr<ObjectFile *> createMachOObjectFile(MemoryBuffer *Object,
 336                                                      bool BufferOwned = true);
 337 };
 338
 339 // Inline function definitions.
 340 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 341     : BasicSymbolRef(SymbolP, Owner) {}
 342
 343 inline error_code SymbolRef::getName(StringRef &Result) const {
 344   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 345 }
 346
 347 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
 348   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 349 }
 350
 351 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
 352   uint64_t Address;
 353   if (error_code EC = getAddress(Address))
 354     return EC;
 355   if (Address == UnknownAddressOrSize) {
 356     Result = UnknownAddressOrSize;
 357     return object_error::success;
 358   }
 359
 360   const ObjectFile *Obj = getObject();
 361   section_iterator SecI(Obj->section_begin());
 362   if (error_code EC = getSection(SecI))
 363     return EC;
 364
 365   if (SecI == Obj->section_end()) {
 366     Result = UnknownAddressOrSize;
 367     return object_error::success;
 368   }
 369
 370   uint64_t SectionAddress;
 371   if (error_code EC = SecI->getAddress(SectionAddress))
 372     return EC;
 373
 374   uint64_t OffsetInSection = Address - SectionAddress;
 375
 376   StringRef SecContents;
 377   if (error_code EC = SecI->getContents(SecContents))
 378     return EC;
 379
 380   // FIXME: this is a hack.
 381   uint64_t SectionOffset = (uint64_t)SecContents.data() - (uint64_t)Obj->base();
 382
 383   Result = SectionOffset + OffsetInSection;
 384   return object_error::success;
 385 }
 386
 387 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
 388   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
 389 }
 390
 391 inline error_code SymbolRef::getSize(uint64_t &Result) const {
 392   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
 393 }
 394
 395 inline error_code SymbolRef::getSection(section_iterator &Result) const {
 396   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 397 }
 398
 399 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 400   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 401 }
 402
 403 inline const ObjectFile *SymbolRef::getObject() const {
 404   const SymbolicFile *O = BasicSymbolRef::getObject();
 405   return cast<ObjectFile>(O);
 406 }
 407
 408
 409 /// SectionRef
 410 inline SectionRef::SectionRef(DataRefImpl SectionP,
 411                               const ObjectFile *Owner)
 412   : SectionPimpl(SectionP)
 413   , OwningObject(Owner) {}
 414
 415 inline bool SectionRef::operator==(const SectionRef &Other) const {
 416   return SectionPimpl == Other.SectionPimpl;
 417 }
 418
 419 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 420   return SectionPimpl != Other.SectionPimpl;
 421 }
 422
 423 inline bool SectionRef::operator<(const SectionRef &Other) const {
 424   return SectionPimpl < Other.SectionPimpl;
 425 }
 426
 427 inline void SectionRef::moveNext() {
 428   return OwningObject->moveSectionNext(SectionPimpl);
 429 }
 430
 431 inline error_code SectionRef::getName(StringRef &Result) const {
 432   return OwningObject->getSectionName(SectionPimpl, Result);
 433 }
 434
 435 inline error_code SectionRef::getAddress(uint64_t &Result) const {
 436   return OwningObject->getSectionAddress(SectionPimpl, Result);
 437 }
 438
 439 inline error_code SectionRef::getSize(uint64_t &Result) const {
 440   return OwningObject->getSectionSize(SectionPimpl, Result);
 441 }
 442
 443 inline error_code SectionRef::getContents(StringRef &Result) const {
 444   return OwningObject->getSectionContents(SectionPimpl, Result);
 445 }
 446
 447 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
 448   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 449 }
 450
 451 inline error_code SectionRef::isText(bool &Result) const {
 452   return OwningObject->isSectionText(SectionPimpl, Result);
 453 }
 454
 455 inline error_code SectionRef::isData(bool &Result) const {
 456   return OwningObject->isSectionData(SectionPimpl, Result);
 457 }
 458
 459 inline error_code SectionRef::isBSS(bool &Result) const {
 460   return OwningObject->isSectionBSS(SectionPimpl, Result);
 461 }
 462
 463 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
 464   return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
 465 }
 466
 467 inline error_code SectionRef::isVirtual(bool &Result) const {
 468   return OwningObject->isSectionVirtual(SectionPimpl, Result);
 469 }
 470
 471 inline error_code SectionRef::isZeroInit(bool &Result) const {
 472   return OwningObject->isSectionZeroInit(SectionPimpl, Result);
 473 }
 474
 475 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
 476   return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
 477 }
 478
 479 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
 480   return OwningObject->sectionContainsSymbol(SectionPimpl,
 481                                              S.getRawDataRefImpl(), Result);
 482 }
 483
 484 inline relocation_iterator SectionRef::relocation_begin() const {
 485   return OwningObject->section_rel_begin(SectionPimpl);
 486 }
 487
 488 inline relocation_iterator SectionRef::relocation_end() const {
 489   return OwningObject->section_rel_end(SectionPimpl);
 490 }
 491
 492 inline section_iterator SectionRef::getRelocatedSection() const {
 493   return OwningObject->getRelocatedSection(SectionPimpl);
 494 }
 495
 496 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 497   return SectionPimpl;
 498 }
 499
 500 /// RelocationRef
 501 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 502                               const ObjectFile *Owner)
 503   : RelocationPimpl(RelocationP)
 504   , OwningObject(Owner) {}
 505
 506 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 507   return RelocationPimpl == Other.RelocationPimpl;
 508 }
 509
 510 inline void RelocationRef::moveNext() {
 511   return OwningObject->moveRelocationNext(RelocationPimpl);
 512 }
 513
 514 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
 515   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 516 }
 517
 518 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
 519   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 520 }
 521
 522 inline symbol_iterator RelocationRef::getSymbol() const {
 523   return OwningObject->getRelocationSymbol(RelocationPimpl);
 524 }
 525
 526 inline error_code RelocationRef::getType(uint64_t &Result) const {
 527   return OwningObject->getRelocationType(RelocationPimpl, Result);
 528 }
 529
 530 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
 531   const {
 532   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 533 }
 534
 535 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
 536   const {
 537   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 538 }
 539
 540 inline error_code RelocationRef::getHidden(bool &Result) const {
 541   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 542 }
 543
 544 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 545   return RelocationPimpl;
 546 }
 547
 548 inline const ObjectFile *RelocationRef::getObjectFile() const {
 549   return OwningObject;
 550 }
 551
 552 // Inline function definitions.
 553 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
 554   : LibraryPimpl(LibraryP)
 555   , OwningObject(Owner) {}
 556
 557 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
 558   return LibraryPimpl == Other.LibraryPimpl;
 559 }
 560
 561 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
 562   return LibraryPimpl < Other.LibraryPimpl;
 563 }
 564
 565 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
 566   return OwningObject->getLibraryNext(LibraryPimpl, Result);
 567 }
 568
 569 inline error_code LibraryRef::getPath(StringRef &Result) const {
 570   return OwningObject->getLibraryPath(LibraryPimpl, Result);
 571 }
 572
 573 } // end namespace object
 574 } // end namespace llvm
 575
 576 #endif