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
  92   void moveNext();
  93
  94   error_code getName(StringRef &Result) const;
  95   error_code getAddress(uint64_t &Result) const;
  96   error_code getSize(uint64_t &Result) const;
  97   error_code getContents(StringRef &Result) const;
  98
  99   /// @brief Get the alignment of this section as the actual value (not log 2).
 100   error_code getAlignment(uint64_t &Result) const;
 101
 102   // FIXME: Move to the normalization layer when it's created.
 103   error_code isText(bool &Result) const;
 104   error_code isData(bool &Result) const;
 105   error_code isBSS(bool &Result) const;
 106   error_code isRequiredForExecution(bool &Result) const;
 107   error_code isVirtual(bool &Result) const;
 108   error_code isZeroInit(bool &Result) const;
 109   error_code isReadOnlyData(bool &Result) const;
 110
 111   error_code containsSymbol(SymbolRef S, bool &Result) const;
 112
 113   relocation_iterator relocation_begin() const;
 114   relocation_iterator relocation_end() const;
 115   typedef iterator_range<relocation_iterator> relocation_iterator_range;
 116   relocation_iterator_range relocations() const {
 117     return relocation_iterator_range(relocation_begin(), relocation_end());
 118   }
 119   section_iterator getRelocatedSection() const;
 120
 121   DataRefImpl getRawDataRefImpl() const;
 122 };
 123
 124 /// SymbolRef - This is a value type class that represents a single symbol in
 125 /// the list of symbols in the object file.
 126 class SymbolRef : public BasicSymbolRef {
 127   friend class SectionRef;
 128
 129 public:
 130   SymbolRef() : BasicSymbolRef() {}
 131
 132   enum Type {
 133     ST_Unknown, // Type not specified
 134     ST_Data,
 135     ST_Debug,
 136     ST_File,
 137     ST_Function,
 138     ST_Other
 139   };
 140
 141   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 142
 143   error_code getName(StringRef &Result) const;
 144   /// Returns the symbol virtual address (i.e. address at which it will be
 145   /// mapped).
 146   error_code getAddress(uint64_t &Result) const;
 147   error_code getFileOffset(uint64_t &Result) const;
 148   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 149   error_code getAlignment(uint32_t &Result) const;
 150   error_code getSize(uint64_t &Result) const;
 151   error_code getType(SymbolRef::Type &Result) const;
 152
 153   /// @brief Get section this symbol is defined in reference to. Result is
 154   /// end_sections() if it is undefined or is an absolute symbol.
 155   error_code getSection(section_iterator &Result) const;
 156
 157   /// @brief Get value of the symbol in the symbol table.
 158   error_code getValue(uint64_t &Val) const;
 159
 160   const ObjectFile *getObject() const;
 161 };
 162
 163 class symbol_iterator : public basic_symbol_iterator {
 164 public:
 165   symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
 166   symbol_iterator(const basic_symbol_iterator &B)
 167       : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
 168                                         cast<ObjectFile>(B->getObject()))) {}
 169
 170   const SymbolRef *operator->() const {
 171     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
 172     return static_cast<const SymbolRef*>(&P);
 173   }
 174
 175   const SymbolRef &operator*() const {
 176     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
 177     return static_cast<const SymbolRef&>(P);
 178   }
 179 };
 180
 181 /// LibraryRef - This is a value type class that represents a single library in
 182 /// the list of libraries needed by a shared or dynamic object.
 183 class LibraryRef {
 184   friend class SectionRef;
 185   DataRefImpl LibraryPimpl;
 186   const ObjectFile *OwningObject;
 187
 188 public:
 189   LibraryRef() : OwningObject(NULL) { }
 190
 191   LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
 192
 193   bool operator==(const LibraryRef &Other) const;
 194   bool operator<(const LibraryRef &Other) const;
 195
 196   error_code getNext(LibraryRef &Result) const;
 197
 198   // Get the path to this library, as stored in the object file.
 199   error_code getPath(StringRef &Result) const;
 200
 201   DataRefImpl getRawDataRefImpl() const;
 202 };
 203 typedef content_iterator<LibraryRef> library_iterator;
 204
 205 /// ObjectFile - This class is the base class for all object file types.
 206 /// Concrete instances of this object are created by createObjectFile, which
 207 /// figures out which type to create.
 208 class ObjectFile : public SymbolicFile {
 209   virtual void anchor();
 210   ObjectFile() LLVM_DELETED_FUNCTION;
 211   ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
 212
 213 protected:
 214   ObjectFile(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
 215
 216   const uint8_t *base() const {
 217     return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
 218   }
 219
 220   // These functions are for SymbolRef to call internally. The main goal of
 221   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 222   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 223   // virtual functions because then it could not point into the memory mapped
 224   // file.
 225   //
 226   // Implementations assume that the DataRefImpl is valid and has not been
 227   // modified externally. It's UB otherwise.
 228   friend class SymbolRef;
 229   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
 230   error_code printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
 231   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
 232   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res)const=0;
 233   virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
 234   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
 235   virtual error_code getSymbolType(DataRefImpl Symb,
 236                                    SymbolRef::Type &Res) const = 0;
 237   virtual error_code getSymbolSection(DataRefImpl Symb,
 238                                       section_iterator &Res) const = 0;
 239   virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const = 0;
 240
 241   // Same as above for SectionRef.
 242   friend class SectionRef;
 243   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 244   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
 245   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
 246   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
 247   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
 248   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
 249   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 250   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 251   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 252   virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
 253                                                    bool &Res) const = 0;
 254   // A section is 'virtual' if its contents aren't present in the object image.
 255   virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
 256   virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
 257   virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
 258   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 259                                            bool &Result) const = 0;
 260   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 261   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 262   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 263
 264   // Same as above for RelocationRef.
 265   friend class RelocationRef;
 266   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 267   virtual error_code getRelocationAddress(DataRefImpl Rel,
 268                                           uint64_t &Res) const =0;
 269   virtual error_code getRelocationOffset(DataRefImpl Rel,
 270                                          uint64_t &Res) const =0;
 271   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 272   virtual error_code getRelocationType(DataRefImpl Rel,
 273                                        uint64_t &Res) const = 0;
 274   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 275                                        SmallVectorImpl<char> &Result) const = 0;
 276   virtual error_code getRelocationValueString(DataRefImpl Rel,
 277                                        SmallVectorImpl<char> &Result) const = 0;
 278   virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
 279     Result = false;
 280     return object_error::success;
 281   }
 282
 283   // Same for LibraryRef
 284   friend class LibraryRef;
 285   virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
 286   virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
 287
 288 public:
 289
 290   symbol_iterator begin_symbols() const;
 291   symbol_iterator end_symbols() const;
 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 symbol_iterator ObjectFile::begin_symbols() const {
 347   basic_symbol_iterator I = symbol_begin_impl();
 348   const BasicSymbolRef &Ref = *I;
 349   const SymbolRef &Cast = static_cast<const SymbolRef&>(Ref);
 350   return symbol_iterator(Cast);
 351 }
 352
 353 inline symbol_iterator ObjectFile::end_symbols() const {
 354   basic_symbol_iterator I = symbol_end_impl();
 355   const BasicSymbolRef &Ref = *I;
 356   const SymbolRef &Cast = static_cast<const SymbolRef&>(Ref);
 357   return symbol_iterator(Cast);
 358 }
 359
 360 inline error_code SymbolRef::getName(StringRef &Result) const {
 361   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 362 }
 363
 364 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
 365   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 366 }
 367
 368 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
 369   return getObject()->getSymbolFileOffset(getRawDataRefImpl(), Result);
 370 }
 371
 372 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
 373   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
 374 }
 375
 376 inline error_code SymbolRef::getSize(uint64_t &Result) const {
 377   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
 378 }
 379
 380 inline error_code SymbolRef::getSection(section_iterator &Result) const {
 381   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 382 }
 383
 384 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 385   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 386 }
 387
 388 inline error_code SymbolRef::getValue(uint64_t &Val) const {
 389   return getObject()->getSymbolValue(getRawDataRefImpl(), Val);
 390 }
 391
 392 inline const ObjectFile *SymbolRef::getObject() const {
 393   const SymbolicFile *O = BasicSymbolRef::getObject();
 394   return cast<ObjectFile>(O);
 395 }
 396
 397
 398 /// SectionRef
 399 inline SectionRef::SectionRef(DataRefImpl SectionP,
 400                               const ObjectFile *Owner)
 401   : SectionPimpl(SectionP)
 402   , OwningObject(Owner) {}
 403
 404 inline bool SectionRef::operator==(const SectionRef &Other) const {
 405   return SectionPimpl == Other.SectionPimpl;
 406 }
 407
 408 inline bool SectionRef::operator<(const SectionRef &Other) const {
 409   return SectionPimpl < Other.SectionPimpl;
 410 }
 411
 412 inline void SectionRef::moveNext() {
 413   return OwningObject->moveSectionNext(SectionPimpl);
 414 }
 415
 416 inline error_code SectionRef::getName(StringRef &Result) const {
 417   return OwningObject->getSectionName(SectionPimpl, Result);
 418 }
 419
 420 inline error_code SectionRef::getAddress(uint64_t &Result) const {
 421   return OwningObject->getSectionAddress(SectionPimpl, Result);
 422 }
 423
 424 inline error_code SectionRef::getSize(uint64_t &Result) const {
 425   return OwningObject->getSectionSize(SectionPimpl, Result);
 426 }
 427
 428 inline error_code SectionRef::getContents(StringRef &Result) const {
 429   return OwningObject->getSectionContents(SectionPimpl, Result);
 430 }
 431
 432 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
 433   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 434 }
 435
 436 inline error_code SectionRef::isText(bool &Result) const {
 437   return OwningObject->isSectionText(SectionPimpl, Result);
 438 }
 439
 440 inline error_code SectionRef::isData(bool &Result) const {
 441   return OwningObject->isSectionData(SectionPimpl, Result);
 442 }
 443
 444 inline error_code SectionRef::isBSS(bool &Result) const {
 445   return OwningObject->isSectionBSS(SectionPimpl, Result);
 446 }
 447
 448 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
 449   return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
 450 }
 451
 452 inline error_code SectionRef::isVirtual(bool &Result) const {
 453   return OwningObject->isSectionVirtual(SectionPimpl, Result);
 454 }
 455
 456 inline error_code SectionRef::isZeroInit(bool &Result) const {
 457   return OwningObject->isSectionZeroInit(SectionPimpl, Result);
 458 }
 459
 460 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
 461   return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
 462 }
 463
 464 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
 465   return OwningObject->sectionContainsSymbol(SectionPimpl,
 466                                              S.getRawDataRefImpl(), Result);
 467 }
 468
 469 inline relocation_iterator SectionRef::relocation_begin() const {
 470   return OwningObject->section_rel_begin(SectionPimpl);
 471 }
 472
 473 inline relocation_iterator SectionRef::relocation_end() const {
 474   return OwningObject->section_rel_end(SectionPimpl);
 475 }
 476
 477 inline section_iterator SectionRef::getRelocatedSection() const {
 478   return OwningObject->getRelocatedSection(SectionPimpl);
 479 }
 480
 481 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 482   return SectionPimpl;
 483 }
 484
 485 /// RelocationRef
 486 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 487                               const ObjectFile *Owner)
 488   : RelocationPimpl(RelocationP)
 489   , OwningObject(Owner) {}
 490
 491 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 492   return RelocationPimpl == Other.RelocationPimpl;
 493 }
 494
 495 inline void RelocationRef::moveNext() {
 496   return OwningObject->moveRelocationNext(RelocationPimpl);
 497 }
 498
 499 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
 500   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 501 }
 502
 503 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
 504   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 505 }
 506
 507 inline symbol_iterator RelocationRef::getSymbol() const {
 508   return OwningObject->getRelocationSymbol(RelocationPimpl);
 509 }
 510
 511 inline error_code RelocationRef::getType(uint64_t &Result) const {
 512   return OwningObject->getRelocationType(RelocationPimpl, Result);
 513 }
 514
 515 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
 516   const {
 517   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 518 }
 519
 520 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
 521   const {
 522   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 523 }
 524
 525 inline error_code RelocationRef::getHidden(bool &Result) const {
 526   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 527 }
 528
 529 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 530   return RelocationPimpl;
 531 }
 532
 533 inline const ObjectFile *RelocationRef::getObjectFile() const {
 534   return OwningObject;
 535 }
 536
 537 // Inline function definitions.
 538 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
 539   : LibraryPimpl(LibraryP)
 540   , OwningObject(Owner) {}
 541
 542 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
 543   return LibraryPimpl == Other.LibraryPimpl;
 544 }
 545
 546 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
 547   return LibraryPimpl < Other.LibraryPimpl;
 548 }
 549
 550 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
 551   return OwningObject->getLibraryNext(LibraryPimpl, Result);
 552 }
 553
 554 inline error_code LibraryRef::getPath(StringRef &Result) const {
 555   return OwningObject->getLibraryPath(LibraryPimpl, Result);
 556 }
 557
 558 } // end namespace object
 559 } // end namespace llvm
 560
 561 #endif