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 class COFFObjectFile;
  31 class MachOObjectFile;
  32
  33 class SymbolRef;
  34 class symbol_iterator;
  35 class SectionRef;
  36 typedef content_iterator<SectionRef> section_iterator;
  37
  38 /// This is a value type class that represents a single relocation in the list
  39 /// of relocations in the object file.
  40 class RelocationRef {
  41   DataRefImpl RelocationPimpl;
  42   const ObjectFile *OwningObject;
  43
  44 public:
  45   RelocationRef() : OwningObject(nullptr) { }
  46
  47   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
  48
  49   bool operator==(const RelocationRef &Other) const;
  50
  51   void moveNext();
  52
  53   std::error_code getAddress(uint64_t &Result) const;
  54   std::error_code getOffset(uint64_t &Result) const;
  55   symbol_iterator getSymbol() const;
  56   std::error_code getType(uint64_t &Result) const;
  57
  58   /// @brief Indicates whether this relocation should hidden when listing
  59   /// relocations, usually because it is the trailing part of a multipart
  60   /// relocation that will be printed as part of the leading relocation.
  61   std::error_code getHidden(bool &Result) const;
  62
  63   /// @brief Get a string that represents the type of this relocation.
  64   ///
  65   /// This is for display purposes only.
  66   std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
  67
  68
  69   DataRefImpl getRawDataRefImpl() const;
  70   const ObjectFile *getObjectFile() const;
  71 };
  72 typedef content_iterator<RelocationRef> relocation_iterator;
  73
  74 /// This is a value type class that represents a single section in the list of
  75 /// sections in the object file.
  76 class SectionRef {
  77   friend class SymbolRef;
  78   DataRefImpl SectionPimpl;
  79   const ObjectFile *OwningObject;
  80
  81 public:
  82   SectionRef() : OwningObject(nullptr) { }
  83
  84   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
  85
  86   bool operator==(const SectionRef &Other) const;
  87   bool operator!=(const SectionRef &Other) const;
  88   bool operator<(const SectionRef &Other) const;
  89
  90   void moveNext();
  91
  92   std::error_code getName(StringRef &Result) const;
  93   uint64_t getAddress() const;
  94   uint64_t getSize() const;
  95   std::error_code getContents(StringRef &Result) const;
  96
  97   /// @brief Get the alignment of this section as the actual value (not log 2).
  98   uint64_t getAlignment() const;
  99
 100   bool isText() const;
 101   bool isData() const;
 102   bool isBSS() const;
 103   bool isVirtual() const;
 104
 105   bool containsSymbol(SymbolRef S) const;
 106
 107   relocation_iterator relocation_begin() const;
 108   relocation_iterator relocation_end() const;
 109   iterator_range<relocation_iterator> relocations() const {
 110     return iterator_range<relocation_iterator>(relocation_begin(),
 111                                                relocation_end());
 112   }
 113   section_iterator getRelocatedSection() const;
 114
 115   DataRefImpl getRawDataRefImpl() const;
 116   const ObjectFile *getObject() const;
 117 };
 118
 119 /// This is a value type class that represents a single symbol in the list of
 120 /// symbols in the object file.
 121 class SymbolRef : public BasicSymbolRef {
 122   friend class SectionRef;
 123
 124 public:
 125   SymbolRef() : BasicSymbolRef() {}
 126
 127   enum Type {
 128     ST_Unknown, // Type not specified
 129     ST_Data,
 130     ST_Debug,
 131     ST_File,
 132     ST_Function,
 133     ST_Other
 134   };
 135
 136   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 137   SymbolRef(const BasicSymbolRef &B) : BasicSymbolRef(B) {
 138     assert(isa<ObjectFile>(BasicSymbolRef::getObject()));
 139   }
 140
 141   std::error_code getName(StringRef &Result) const;
 142   /// Returns the symbol virtual address (i.e. address at which it will be
 143   /// mapped).
 144   std::error_code getAddress(uint64_t &Result) const;
 145
 146   /// Return the value of the symbol depending on the object this can be an
 147   /// offset or a virtual address.
 148   uint64_t getValue() const;
 149
 150   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 151   uint32_t getAlignment() const;
 152   uint64_t getCommonSize() const;
 153   std::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   std::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 /// This class is the base class for all object file types. Concrete instances
 181 /// of this object are created by createObjectFile, which figures out which type
 182 /// to create.
 183 class ObjectFile : public SymbolicFile {
 184   virtual void anchor();
 185   ObjectFile() = delete;
 186   ObjectFile(const ObjectFile &other) = delete;
 187
 188 protected:
 189   ObjectFile(unsigned int Type, MemoryBufferRef Source);
 190
 191   const uint8_t *base() const {
 192     return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
 193   }
 194
 195   // These functions are for SymbolRef to call internally. The main goal of
 196   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 197   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 198   // virtual functions because then it could not point into the memory mapped
 199   // file.
 200   //
 201   // Implementations assume that the DataRefImpl is valid and has not been
 202   // modified externally. It's UB otherwise.
 203   friend class SymbolRef;
 204   virtual std::error_code getSymbolName(DataRefImpl Symb,
 205                                         StringRef &Res) const = 0;
 206   std::error_code printSymbolName(raw_ostream &OS,
 207                                   DataRefImpl Symb) const override;
 208   virtual std::error_code getSymbolAddress(DataRefImpl Symb,
 209                                            uint64_t &Res) const = 0;
 210   virtual uint64_t getSymbolValue(DataRefImpl Symb) const = 0;
 211   virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
 212   virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
 213   virtual std::error_code getSymbolType(DataRefImpl Symb,
 214                                         SymbolRef::Type &Res) const = 0;
 215   virtual std::error_code getSymbolSection(DataRefImpl Symb,
 216                                            section_iterator &Res) const = 0;
 217
 218   // Same as above for SectionRef.
 219   friend class SectionRef;
 220   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 221   virtual std::error_code getSectionName(DataRefImpl Sec,
 222                                          StringRef &Res) const = 0;
 223   virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
 224   virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
 225   virtual std::error_code getSectionContents(DataRefImpl Sec,
 226                                              StringRef &Res) const = 0;
 227   virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
 228   virtual bool isSectionText(DataRefImpl Sec) const = 0;
 229   virtual bool isSectionData(DataRefImpl Sec) const = 0;
 230   virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
 231   // A section is 'virtual' if its contents aren't present in the object image.
 232   virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
 233   virtual bool sectionContainsSymbol(DataRefImpl Sec,
 234                                      DataRefImpl Symb) const = 0;
 235   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 236   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 237   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 238
 239   // Same as above for RelocationRef.
 240   friend class RelocationRef;
 241   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 242   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
 243                                                uint64_t &Res) const = 0;
 244   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
 245                                               uint64_t &Res) const = 0;
 246   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 247   virtual std::error_code getRelocationType(DataRefImpl Rel,
 248                                             uint64_t &Res) const = 0;
 249   virtual std::error_code
 250   getRelocationTypeName(DataRefImpl Rel,
 251                         SmallVectorImpl<char> &Result) const = 0;
 252   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
 253                                               bool &Result) const {
 254     Result = false;
 255     return std::error_code();
 256   }
 257
 258 public:
 259   uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
 260     assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
 261     return getCommonSymbolSizeImpl(Symb);
 262   }
 263
 264   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 265   symbol_iterator_range symbols() const {
 266     return symbol_iterator_range(symbol_begin(), symbol_end());
 267   }
 268
 269   virtual section_iterator section_begin() const = 0;
 270   virtual section_iterator section_end() const = 0;
 271
 272   typedef iterator_range<section_iterator> section_iterator_range;
 273   section_iterator_range sections() const {
 274     return section_iterator_range(section_begin(), section_end());
 275   }
 276
 277   /// @brief The number of bytes used to represent an address in this object
 278   ///        file format.
 279   virtual uint8_t getBytesInAddress() const = 0;
 280
 281   virtual StringRef getFileFormatName() const = 0;
 282   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 283
 284   /// Returns platform-specific object flags, if any.
 285   virtual std::error_code getPlatformFlags(unsigned &Result) const {
 286     Result = 0;
 287     return object_error::invalid_file_type;
 288   }
 289
 290   /// True if this is a relocatable object (.o/.obj).
 291   virtual bool isRelocatableObject() const = 0;
 292
 293   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 294   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 295   ///        return true.
 296   /// @brief Create ObjectFile from path.
 297   static ErrorOr<OwningBinary<ObjectFile>>
 298   createObjectFile(StringRef ObjectPath);
 299
 300   static ErrorOr<std::unique_ptr<ObjectFile>>
 301   createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
 302   static ErrorOr<std::unique_ptr<ObjectFile>>
 303   createObjectFile(MemoryBufferRef Object) {
 304     return createObjectFile(Object, sys::fs::file_magic::unknown);
 305   }
 306
 307
 308   static inline bool classof(const Binary *v) {
 309     return v->isObject();
 310   }
 311
 312   static ErrorOr<std::unique_ptr<COFFObjectFile>>
 313   createCOFFObjectFile(MemoryBufferRef Object);
 314
 315   static ErrorOr<std::unique_ptr<ObjectFile>>
 316   createELFObjectFile(MemoryBufferRef Object);
 317
 318   static ErrorOr<std::unique_ptr<MachOObjectFile>>
 319   createMachOObjectFile(MemoryBufferRef Object);
 320 };
 321
 322 // Inline function definitions.
 323 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 324     : BasicSymbolRef(SymbolP, Owner) {}
 325
 326 inline std::error_code SymbolRef::getName(StringRef &Result) const {
 327   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 328 }
 329
 330 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
 331   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 332 }
 333
 334 inline uint64_t SymbolRef::getValue() const {
 335   return getObject()->getSymbolValue(getRawDataRefImpl());
 336 }
 337
 338 inline uint32_t SymbolRef::getAlignment() const {
 339   return getObject()->getSymbolAlignment(getRawDataRefImpl());
 340 }
 341
 342 inline uint64_t SymbolRef::getCommonSize() const {
 343   return getObject()->getCommonSymbolSize(getRawDataRefImpl());
 344 }
 345
 346 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
 347   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 348 }
 349
 350 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 351   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 352 }
 353
 354 inline const ObjectFile *SymbolRef::getObject() const {
 355   const SymbolicFile *O = BasicSymbolRef::getObject();
 356   return cast<ObjectFile>(O);
 357 }
 358
 359
 360 /// SectionRef
 361 inline SectionRef::SectionRef(DataRefImpl SectionP,
 362                               const ObjectFile *Owner)
 363   : SectionPimpl(SectionP)
 364   , OwningObject(Owner) {}
 365
 366 inline bool SectionRef::operator==(const SectionRef &Other) const {
 367   return SectionPimpl == Other.SectionPimpl;
 368 }
 369
 370 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 371   return SectionPimpl != Other.SectionPimpl;
 372 }
 373
 374 inline bool SectionRef::operator<(const SectionRef &Other) const {
 375   return SectionPimpl < Other.SectionPimpl;
 376 }
 377
 378 inline void SectionRef::moveNext() {
 379   return OwningObject->moveSectionNext(SectionPimpl);
 380 }
 381
 382 inline std::error_code SectionRef::getName(StringRef &Result) const {
 383   return OwningObject->getSectionName(SectionPimpl, Result);
 384 }
 385
 386 inline uint64_t SectionRef::getAddress() const {
 387   return OwningObject->getSectionAddress(SectionPimpl);
 388 }
 389
 390 inline uint64_t SectionRef::getSize() const {
 391   return OwningObject->getSectionSize(SectionPimpl);
 392 }
 393
 394 inline std::error_code SectionRef::getContents(StringRef &Result) const {
 395   return OwningObject->getSectionContents(SectionPimpl, Result);
 396 }
 397
 398 inline uint64_t SectionRef::getAlignment() const {
 399   return OwningObject->getSectionAlignment(SectionPimpl);
 400 }
 401
 402 inline bool SectionRef::isText() const {
 403   return OwningObject->isSectionText(SectionPimpl);
 404 }
 405
 406 inline bool SectionRef::isData() const {
 407   return OwningObject->isSectionData(SectionPimpl);
 408 }
 409
 410 inline bool SectionRef::isBSS() const {
 411   return OwningObject->isSectionBSS(SectionPimpl);
 412 }
 413
 414 inline bool SectionRef::isVirtual() const {
 415   return OwningObject->isSectionVirtual(SectionPimpl);
 416 }
 417
 418 inline bool SectionRef::containsSymbol(SymbolRef S) const {
 419   return OwningObject->sectionContainsSymbol(SectionPimpl,
 420                                              S.getRawDataRefImpl());
 421 }
 422
 423 inline relocation_iterator SectionRef::relocation_begin() const {
 424   return OwningObject->section_rel_begin(SectionPimpl);
 425 }
 426
 427 inline relocation_iterator SectionRef::relocation_end() const {
 428   return OwningObject->section_rel_end(SectionPimpl);
 429 }
 430
 431 inline section_iterator SectionRef::getRelocatedSection() const {
 432   return OwningObject->getRelocatedSection(SectionPimpl);
 433 }
 434
 435 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 436   return SectionPimpl;
 437 }
 438
 439 inline const ObjectFile *SectionRef::getObject() const {
 440   return OwningObject;
 441 }
 442
 443 /// RelocationRef
 444 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 445                               const ObjectFile *Owner)
 446   : RelocationPimpl(RelocationP)
 447   , OwningObject(Owner) {}
 448
 449 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 450   return RelocationPimpl == Other.RelocationPimpl;
 451 }
 452
 453 inline void RelocationRef::moveNext() {
 454   return OwningObject->moveRelocationNext(RelocationPimpl);
 455 }
 456
 457 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
 458   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 459 }
 460
 461 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
 462   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 463 }
 464
 465 inline symbol_iterator RelocationRef::getSymbol() const {
 466   return OwningObject->getRelocationSymbol(RelocationPimpl);
 467 }
 468
 469 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
 470   return OwningObject->getRelocationType(RelocationPimpl, Result);
 471 }
 472
 473 inline std::error_code
 474 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
 475   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 476 }
 477
 478 inline std::error_code RelocationRef::getHidden(bool &Result) const {
 479   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 480 }
 481
 482 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 483   return RelocationPimpl;
 484 }
 485
 486 inline const ObjectFile *RelocationRef::getObjectFile() const {
 487   return OwningObject;
 488 }
 489
 490
 491 } // end namespace object
 492 } // end namespace llvm
 493
 494 #endif