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   std::error_code getOther(uint8_t &Result) const;
 155
 156   /// @brief Get section this symbol is defined in reference to. Result is
 157   /// end_sections() if it is undefined or is an absolute symbol.
 158   std::error_code getSection(section_iterator &Result) 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 /// This class is the base class for all object file types. Concrete instances
 182 /// of this object are created by createObjectFile, which figures out which type
 183 /// to create.
 184 class ObjectFile : public SymbolicFile {
 185   virtual void anchor();
 186   ObjectFile() = delete;
 187   ObjectFile(const ObjectFile &other) = delete;
 188
 189 protected:
 190   ObjectFile(unsigned int Type, MemoryBufferRef Source);
 191
 192   const uint8_t *base() const {
 193     return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
 194   }
 195
 196   // These functions are for SymbolRef to call internally. The main goal of
 197   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 198   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 199   // virtual functions because then it could not point into the memory mapped
 200   // file.
 201   //
 202   // Implementations assume that the DataRefImpl is valid and has not been
 203   // modified externally. It's UB otherwise.
 204   friend class SymbolRef;
 205   virtual std::error_code getSymbolName(DataRefImpl Symb,
 206                                         StringRef &Res) const = 0;
 207   std::error_code printSymbolName(raw_ostream &OS,
 208                                   DataRefImpl Symb) const override;
 209   virtual std::error_code getSymbolAddress(DataRefImpl Symb,
 210                                            uint64_t &Res) const = 0;
 211   virtual uint64_t getSymbolValue(DataRefImpl Symb) const = 0;
 212   virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
 213   virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
 214   virtual std::error_code getSymbolType(DataRefImpl Symb,
 215                                         SymbolRef::Type &Res) const = 0;
 216   virtual std::error_code getSymbolSection(DataRefImpl Symb,
 217                                            section_iterator &Res) const = 0;
 218   virtual std::error_code getSymbolOther(DataRefImpl Symb,
 219                                          uint8_t &Res) const {
 220     return object_error::invalid_file_type;
 221   }
 222
 223   // Same as above for SectionRef.
 224   friend class SectionRef;
 225   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 226   virtual std::error_code getSectionName(DataRefImpl Sec,
 227                                          StringRef &Res) const = 0;
 228   virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
 229   virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
 230   virtual std::error_code getSectionContents(DataRefImpl Sec,
 231                                              StringRef &Res) const = 0;
 232   virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
 233   virtual bool isSectionText(DataRefImpl Sec) const = 0;
 234   virtual bool isSectionData(DataRefImpl Sec) const = 0;
 235   virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
 236   // A section is 'virtual' if its contents aren't present in the object image.
 237   virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
 238   virtual bool sectionContainsSymbol(DataRefImpl Sec,
 239                                      DataRefImpl Symb) const = 0;
 240   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 241   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 242   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 243
 244   // Same as above for RelocationRef.
 245   friend class RelocationRef;
 246   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 247   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
 248                                                uint64_t &Res) const = 0;
 249   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
 250                                               uint64_t &Res) const = 0;
 251   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 252   virtual std::error_code getRelocationType(DataRefImpl Rel,
 253                                             uint64_t &Res) const = 0;
 254   virtual std::error_code
 255   getRelocationTypeName(DataRefImpl Rel,
 256                         SmallVectorImpl<char> &Result) const = 0;
 257   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
 258                                               bool &Result) const {
 259     Result = false;
 260     return std::error_code();
 261   }
 262
 263 public:
 264   uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
 265     assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
 266     return getCommonSymbolSizeImpl(Symb);
 267   }
 268
 269   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 270   symbol_iterator_range symbols() const {
 271     return symbol_iterator_range(symbol_begin(), symbol_end());
 272   }
 273
 274   virtual section_iterator section_begin() const = 0;
 275   virtual section_iterator section_end() const = 0;
 276
 277   typedef iterator_range<section_iterator> section_iterator_range;
 278   section_iterator_range sections() const {
 279     return section_iterator_range(section_begin(), section_end());
 280   }
 281
 282   /// @brief The number of bytes used to represent an address in this object
 283   ///        file format.
 284   virtual uint8_t getBytesInAddress() const = 0;
 285
 286   virtual StringRef getFileFormatName() const = 0;
 287   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 288
 289   /// Returns platform-specific object flags, if any.
 290   virtual std::error_code getPlatformFlags(unsigned &Result) const {
 291     Result = 0;
 292     return object_error::invalid_file_type;
 293   }
 294
 295   /// True if this is a relocatable object (.o/.obj).
 296   virtual bool isRelocatableObject() const = 0;
 297
 298   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 299   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 300   ///        return true.
 301   /// @brief Create ObjectFile from path.
 302   static ErrorOr<OwningBinary<ObjectFile>>
 303   createObjectFile(StringRef ObjectPath);
 304
 305   static ErrorOr<std::unique_ptr<ObjectFile>>
 306   createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
 307   static ErrorOr<std::unique_ptr<ObjectFile>>
 308   createObjectFile(MemoryBufferRef Object) {
 309     return createObjectFile(Object, sys::fs::file_magic::unknown);
 310   }
 311
 312
 313   static inline bool classof(const Binary *v) {
 314     return v->isObject();
 315   }
 316
 317   static ErrorOr<std::unique_ptr<COFFObjectFile>>
 318   createCOFFObjectFile(MemoryBufferRef Object);
 319
 320   static ErrorOr<std::unique_ptr<ObjectFile>>
 321   createELFObjectFile(MemoryBufferRef Object);
 322
 323   static ErrorOr<std::unique_ptr<MachOObjectFile>>
 324   createMachOObjectFile(MemoryBufferRef Object);
 325 };
 326
 327 // Inline function definitions.
 328 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 329     : BasicSymbolRef(SymbolP, Owner) {}
 330
 331 inline std::error_code SymbolRef::getName(StringRef &Result) const {
 332   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 333 }
 334
 335 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
 336   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 337 }
 338
 339 inline uint64_t SymbolRef::getValue() const {
 340   return getObject()->getSymbolValue(getRawDataRefImpl());
 341 }
 342
 343 inline uint32_t SymbolRef::getAlignment() const {
 344   return getObject()->getSymbolAlignment(getRawDataRefImpl());
 345 }
 346
 347 inline uint64_t SymbolRef::getCommonSize() const {
 348   return getObject()->getCommonSymbolSize(getRawDataRefImpl());
 349 }
 350
 351 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
 352   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 353 }
 354
 355 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 356   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 357 }
 358
 359 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
 360   return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
 361 }
 362
 363 inline const ObjectFile *SymbolRef::getObject() const {
 364   const SymbolicFile *O = BasicSymbolRef::getObject();
 365   return cast<ObjectFile>(O);
 366 }
 367
 368
 369 /// SectionRef
 370 inline SectionRef::SectionRef(DataRefImpl SectionP,
 371                               const ObjectFile *Owner)
 372   : SectionPimpl(SectionP)
 373   , OwningObject(Owner) {}
 374
 375 inline bool SectionRef::operator==(const SectionRef &Other) const {
 376   return SectionPimpl == Other.SectionPimpl;
 377 }
 378
 379 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 380   return SectionPimpl != Other.SectionPimpl;
 381 }
 382
 383 inline bool SectionRef::operator<(const SectionRef &Other) const {
 384   return SectionPimpl < Other.SectionPimpl;
 385 }
 386
 387 inline void SectionRef::moveNext() {
 388   return OwningObject->moveSectionNext(SectionPimpl);
 389 }
 390
 391 inline std::error_code SectionRef::getName(StringRef &Result) const {
 392   return OwningObject->getSectionName(SectionPimpl, Result);
 393 }
 394
 395 inline uint64_t SectionRef::getAddress() const {
 396   return OwningObject->getSectionAddress(SectionPimpl);
 397 }
 398
 399 inline uint64_t SectionRef::getSize() const {
 400   return OwningObject->getSectionSize(SectionPimpl);
 401 }
 402
 403 inline std::error_code SectionRef::getContents(StringRef &Result) const {
 404   return OwningObject->getSectionContents(SectionPimpl, Result);
 405 }
 406
 407 inline uint64_t SectionRef::getAlignment() const {
 408   return OwningObject->getSectionAlignment(SectionPimpl);
 409 }
 410
 411 inline bool SectionRef::isText() const {
 412   return OwningObject->isSectionText(SectionPimpl);
 413 }
 414
 415 inline bool SectionRef::isData() const {
 416   return OwningObject->isSectionData(SectionPimpl);
 417 }
 418
 419 inline bool SectionRef::isBSS() const {
 420   return OwningObject->isSectionBSS(SectionPimpl);
 421 }
 422
 423 inline bool SectionRef::isVirtual() const {
 424   return OwningObject->isSectionVirtual(SectionPimpl);
 425 }
 426
 427 inline bool SectionRef::containsSymbol(SymbolRef S) const {
 428   return OwningObject->sectionContainsSymbol(SectionPimpl,
 429                                              S.getRawDataRefImpl());
 430 }
 431
 432 inline relocation_iterator SectionRef::relocation_begin() const {
 433   return OwningObject->section_rel_begin(SectionPimpl);
 434 }
 435
 436 inline relocation_iterator SectionRef::relocation_end() const {
 437   return OwningObject->section_rel_end(SectionPimpl);
 438 }
 439
 440 inline section_iterator SectionRef::getRelocatedSection() const {
 441   return OwningObject->getRelocatedSection(SectionPimpl);
 442 }
 443
 444 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 445   return SectionPimpl;
 446 }
 447
 448 inline const ObjectFile *SectionRef::getObject() const {
 449   return OwningObject;
 450 }
 451
 452 /// RelocationRef
 453 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 454                               const ObjectFile *Owner)
 455   : RelocationPimpl(RelocationP)
 456   , OwningObject(Owner) {}
 457
 458 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 459   return RelocationPimpl == Other.RelocationPimpl;
 460 }
 461
 462 inline void RelocationRef::moveNext() {
 463   return OwningObject->moveRelocationNext(RelocationPimpl);
 464 }
 465
 466 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
 467   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 468 }
 469
 470 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
 471   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 472 }
 473
 474 inline symbol_iterator RelocationRef::getSymbol() const {
 475   return OwningObject->getRelocationSymbol(RelocationPimpl);
 476 }
 477
 478 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
 479   return OwningObject->getRelocationType(RelocationPimpl, Result);
 480 }
 481
 482 inline std::error_code
 483 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
 484   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 485 }
 486
 487 inline std::error_code RelocationRef::getHidden(bool &Result) const {
 488   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 489 }
 490
 491 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 492   return RelocationPimpl;
 493 }
 494
 495 inline const ObjectFile *RelocationRef::getObjectFile() const {
 496   return OwningObject;
 497 }
 498
 499
 500 } // end namespace object
 501 } // end namespace llvm
 502
 503 #endif