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