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   std::error_code getAddress(uint64_t &Result) const;
  50   std::error_code getOffset(uint64_t &Result) const;
  51   symbol_iterator getSymbol() const;
  52   std::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   std::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   std::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   std::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   std::error_code getName(StringRef &Result) const;
  96   std::error_code getAddress(uint64_t &Result) const;
  97   std::error_code getSize(uint64_t &Result) const;
  98   std::error_code getContents(StringRef &Result) const;
  99
 100   /// @brief Get the alignment of this section as the actual value (not log 2).
 101   std::error_code getAlignment(uint64_t &Result) const;
 102
 103   // FIXME: Move to the normalization layer when it's created.
 104   std::error_code isText(bool &Result) const;
 105   std::error_code isData(bool &Result) const;
 106   std::error_code isBSS(bool &Result) const;
 107   std::error_code isRequiredForExecution(bool &Result) const;
 108   std::error_code isVirtual(bool &Result) const;
 109   std::error_code isZeroInit(bool &Result) const;
 110   std::error_code isReadOnlyData(bool &Result) const;
 111
 112   std::error_code containsSymbol(SymbolRef S, bool &Result) const;
 113
 114   relocation_iterator relocation_begin() const;
 115   relocation_iterator relocation_end() const;
 116   iterator_range<relocation_iterator> relocations() const {
 117     return iterator_range<relocation_iterator>(relocation_begin(),
 118                                                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   std::error_code getName(StringRef &Result) const;
 145   /// Returns the symbol virtual address (i.e. address at which it will be
 146   /// mapped).
 147   std::error_code getAddress(uint64_t &Result) const;
 148   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 149   std::error_code getAlignment(uint32_t &Result) const;
 150   std::error_code getSize(uint64_t &Result) const;
 151   std::error_code getType(SymbolRef::Type &Result) const;
 152   std::error_code getOther(uint8_t &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   std::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   std::error_code getNext(LibraryRef &Result) const;
 195
 196   // Get the path to this library, as stored in the object file.
 197   std::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, std::unique_ptr<MemoryBuffer> Source);
 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 std::error_code getSymbolName(DataRefImpl Symb,
 228                                         StringRef &Res) const = 0;
 229   std::error_code printSymbolName(raw_ostream &OS,
 230                                   DataRefImpl Symb) const override;
 231   virtual std::error_code getSymbolAddress(DataRefImpl Symb,
 232                                            uint64_t &Res) const = 0;
 233   virtual std::error_code getSymbolAlignment(DataRefImpl Symb,
 234                                              uint32_t &Res) const;
 235   virtual std::error_code getSymbolSize(DataRefImpl Symb,
 236                                         uint64_t &Res) const = 0;
 237   virtual std::error_code getSymbolType(DataRefImpl Symb,
 238                                         SymbolRef::Type &Res) const = 0;
 239   virtual std::error_code getSymbolSection(DataRefImpl Symb,
 240                                            section_iterator &Res) const = 0;
 241   virtual std::error_code getSymbolOther(DataRefImpl Symb,
 242                                          uint8_t &Res) const {
 243     return object_error::invalid_file_type;
 244   }
 245
 246   // Same as above for SectionRef.
 247   friend class SectionRef;
 248   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 249   virtual std::error_code getSectionName(DataRefImpl Sec,
 250                                          StringRef &Res) const = 0;
 251   virtual std::error_code getSectionAddress(DataRefImpl Sec,
 252                                             uint64_t &Res) const = 0;
 253   virtual std::error_code getSectionSize(DataRefImpl Sec,
 254                                          uint64_t &Res) const = 0;
 255   virtual std::error_code getSectionContents(DataRefImpl Sec,
 256                                              StringRef &Res) const = 0;
 257   virtual std::error_code getSectionAlignment(DataRefImpl Sec,
 258                                               uint64_t &Res) const = 0;
 259   virtual std::error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 260   virtual std::error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 261   virtual std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 262   virtual std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
 263                                                         bool &Res) const = 0;
 264   // A section is 'virtual' if its contents aren't present in the object image.
 265   virtual std::error_code isSectionVirtual(DataRefImpl Sec,
 266                                            bool &Res) const = 0;
 267   virtual std::error_code isSectionZeroInit(DataRefImpl Sec,
 268                                             bool &Res) const = 0;
 269   virtual std::error_code isSectionReadOnlyData(DataRefImpl Sec,
 270                                                 bool &Res) const = 0;
 271   virtual std::error_code sectionContainsSymbol(DataRefImpl Sec,
 272                                                 DataRefImpl Symb,
 273                                                 bool &Result) const = 0;
 274   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 275   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 276   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 277
 278   // Same as above for RelocationRef.
 279   friend class RelocationRef;
 280   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 281   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
 282                                                uint64_t &Res) const = 0;
 283   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
 284                                               uint64_t &Res) const = 0;
 285   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 286   virtual std::error_code getRelocationType(DataRefImpl Rel,
 287                                             uint64_t &Res) const = 0;
 288   virtual std::error_code
 289   getRelocationTypeName(DataRefImpl Rel,
 290                         SmallVectorImpl<char> &Result) const = 0;
 291   virtual std::error_code
 292   getRelocationValueString(DataRefImpl Rel,
 293                            SmallVectorImpl<char> &Result) const = 0;
 294   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
 295                                               bool &Result) const {
 296     Result = false;
 297     return object_error::success;
 298   }
 299
 300   // Same for LibraryRef
 301   friend class LibraryRef;
 302   virtual std::error_code getLibraryNext(DataRefImpl Lib,
 303                                          LibraryRef &Res) const = 0;
 304   virtual std::error_code getLibraryPath(DataRefImpl Lib,
 305                                          StringRef &Res) const = 0;
 306
 307 public:
 308   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 309   symbol_iterator_range symbols() const {
 310     return symbol_iterator_range(symbol_begin(), symbol_end());
 311   }
 312
 313   virtual section_iterator section_begin() const = 0;
 314   virtual section_iterator section_end() const = 0;
 315
 316   typedef iterator_range<section_iterator> section_iterator_range;
 317   section_iterator_range sections() const {
 318     return section_iterator_range(section_begin(), section_end());
 319   }
 320
 321   virtual library_iterator needed_library_begin() const = 0;
 322   virtual library_iterator needed_library_end() const = 0;
 323
 324   /// @brief The number of bytes used to represent an address in this object
 325   ///        file format.
 326   virtual uint8_t getBytesInAddress() const = 0;
 327
 328   virtual StringRef getFileFormatName() const = 0;
 329   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 330
 331   /// For shared objects, returns the name which this object should be
 332   /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
 333   /// LC_ID_DYLIB (install name) on MachO.
 334   virtual StringRef getLoadName() const = 0;
 335
 336   /// Returns platform-specific object flags, if any.
 337   virtual std::error_code getPlatformFlags(unsigned &Result) const {
 338     Result = 0;
 339     return object_error::invalid_file_type;
 340   }
 341
 342   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 343   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 344   ///        return true.
 345   /// @brief Create ObjectFile from path.
 346   static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
 347   static ErrorOr<ObjectFile *>
 348   createObjectFile(std::unique_ptr<MemoryBuffer> &Object,
 349                    sys::fs::file_magic Type);
 350   static ErrorOr<ObjectFile *>
 351   createObjectFile(std::unique_ptr<MemoryBuffer> &Object) {
 352     return createObjectFile(Object, sys::fs::file_magic::unknown);
 353   }
 354
 355
 356   static inline bool classof(const Binary *v) {
 357     return v->isObject();
 358   }
 359
 360 public:
 361   static ErrorOr<ObjectFile *>
 362   createCOFFObjectFile(std::unique_ptr<MemoryBuffer> Object);
 363   static ErrorOr<ObjectFile *>
 364   createELFObjectFile(std::unique_ptr<MemoryBuffer> &Object);
 365   static ErrorOr<ObjectFile *>
 366   createMachOObjectFile(std::unique_ptr<MemoryBuffer> &Object);
 367 };
 368
 369 // Inline function definitions.
 370 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 371     : BasicSymbolRef(SymbolP, Owner) {}
 372
 373 inline std::error_code SymbolRef::getName(StringRef &Result) const {
 374   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 375 }
 376
 377 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
 378   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 379 }
 380
 381 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
 382   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
 383 }
 384
 385 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
 386   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
 387 }
 388
 389 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
 390   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 391 }
 392
 393 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 394   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 395 }
 396
 397 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
 398   return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
 399 }
 400
 401 inline const ObjectFile *SymbolRef::getObject() const {
 402   const SymbolicFile *O = BasicSymbolRef::getObject();
 403   return cast<ObjectFile>(O);
 404 }
 405
 406
 407 /// SectionRef
 408 inline SectionRef::SectionRef(DataRefImpl SectionP,
 409                               const ObjectFile *Owner)
 410   : SectionPimpl(SectionP)
 411   , OwningObject(Owner) {}
 412
 413 inline bool SectionRef::operator==(const SectionRef &Other) const {
 414   return SectionPimpl == Other.SectionPimpl;
 415 }
 416
 417 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 418   return SectionPimpl != Other.SectionPimpl;
 419 }
 420
 421 inline bool SectionRef::operator<(const SectionRef &Other) const {
 422   return SectionPimpl < Other.SectionPimpl;
 423 }
 424
 425 inline void SectionRef::moveNext() {
 426   return OwningObject->moveSectionNext(SectionPimpl);
 427 }
 428
 429 inline std::error_code SectionRef::getName(StringRef &Result) const {
 430   return OwningObject->getSectionName(SectionPimpl, Result);
 431 }
 432
 433 inline std::error_code SectionRef::getAddress(uint64_t &Result) const {
 434   return OwningObject->getSectionAddress(SectionPimpl, Result);
 435 }
 436
 437 inline std::error_code SectionRef::getSize(uint64_t &Result) const {
 438   return OwningObject->getSectionSize(SectionPimpl, Result);
 439 }
 440
 441 inline std::error_code SectionRef::getContents(StringRef &Result) const {
 442   return OwningObject->getSectionContents(SectionPimpl, Result);
 443 }
 444
 445 inline std::error_code SectionRef::getAlignment(uint64_t &Result) const {
 446   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 447 }
 448
 449 inline std::error_code SectionRef::isText(bool &Result) const {
 450   return OwningObject->isSectionText(SectionPimpl, Result);
 451 }
 452
 453 inline std::error_code SectionRef::isData(bool &Result) const {
 454   return OwningObject->isSectionData(SectionPimpl, Result);
 455 }
 456
 457 inline std::error_code SectionRef::isBSS(bool &Result) const {
 458   return OwningObject->isSectionBSS(SectionPimpl, Result);
 459 }
 460
 461 inline std::error_code SectionRef::isRequiredForExecution(bool &Result) const {
 462   return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
 463 }
 464
 465 inline std::error_code SectionRef::isVirtual(bool &Result) const {
 466   return OwningObject->isSectionVirtual(SectionPimpl, Result);
 467 }
 468
 469 inline std::error_code SectionRef::isZeroInit(bool &Result) const {
 470   return OwningObject->isSectionZeroInit(SectionPimpl, Result);
 471 }
 472
 473 inline std::error_code SectionRef::isReadOnlyData(bool &Result) const {
 474   return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
 475 }
 476
 477 inline std::error_code SectionRef::containsSymbol(SymbolRef S,
 478                                                   bool &Result) const {
 479   return OwningObject->sectionContainsSymbol(SectionPimpl,
 480                                              S.getRawDataRefImpl(), Result);
 481 }
 482
 483 inline relocation_iterator SectionRef::relocation_begin() const {
 484   return OwningObject->section_rel_begin(SectionPimpl);
 485 }
 486
 487 inline relocation_iterator SectionRef::relocation_end() const {
 488   return OwningObject->section_rel_end(SectionPimpl);
 489 }
 490
 491 inline section_iterator SectionRef::getRelocatedSection() const {
 492   return OwningObject->getRelocatedSection(SectionPimpl);
 493 }
 494
 495 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 496   return SectionPimpl;
 497 }
 498
 499 /// RelocationRef
 500 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 501                               const ObjectFile *Owner)
 502   : RelocationPimpl(RelocationP)
 503   , OwningObject(Owner) {}
 504
 505 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 506   return RelocationPimpl == Other.RelocationPimpl;
 507 }
 508
 509 inline void RelocationRef::moveNext() {
 510   return OwningObject->moveRelocationNext(RelocationPimpl);
 511 }
 512
 513 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
 514   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 515 }
 516
 517 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
 518   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 519 }
 520
 521 inline symbol_iterator RelocationRef::getSymbol() const {
 522   return OwningObject->getRelocationSymbol(RelocationPimpl);
 523 }
 524
 525 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
 526   return OwningObject->getRelocationType(RelocationPimpl, Result);
 527 }
 528
 529 inline std::error_code
 530 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
 531   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 532 }
 533
 534 inline std::error_code
 535 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
 536   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 537 }
 538
 539 inline std::error_code RelocationRef::getHidden(bool &Result) const {
 540   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 541 }
 542
 543 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 544   return RelocationPimpl;
 545 }
 546
 547 inline const ObjectFile *RelocationRef::getObjectFile() const {
 548   return OwningObject;
 549 }
 550
 551 // Inline function definitions.
 552 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
 553   : LibraryPimpl(LibraryP)
 554   , OwningObject(Owner) {}
 555
 556 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
 557   return LibraryPimpl == Other.LibraryPimpl;
 558 }
 559
 560 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
 561   return LibraryPimpl < Other.LibraryPimpl;
 562 }
 563
 564 inline std::error_code LibraryRef::getNext(LibraryRef &Result) const {
 565   return OwningObject->getLibraryNext(LibraryPimpl, Result);
 566 }
 567
 568 inline std::error_code LibraryRef::getPath(StringRef &Result) const {
 569   return OwningObject->getLibraryPath(LibraryPimpl, Result);
 570 }
 571
 572 } // end namespace object
 573 } // end namespace llvm
 574
 575 #endif