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
  36 /// RelocationRef - This is a value type class that represents a single
  37 /// relocation in the list of relocations in the object file.
  38 class RelocationRef {
  39   DataRefImpl RelocationPimpl;
  40   const ObjectFile *OwningObject;
  41
  42 public:
  43   RelocationRef() : OwningObject(nullptr) { }
  44
  45   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
  46
  47   bool operator==(const RelocationRef &Other) const;
  48
  49   void moveNext();
  50
  51   std::error_code getAddress(uint64_t &Result) const;
  52   std::error_code getOffset(uint64_t &Result) const;
  53   symbol_iterator getSymbol() const;
  54   std::error_code getType(uint64_t &Result) const;
  55
  56   /// @brief Indicates whether this relocation should hidden when listing
  57   /// relocations, usually because it is the trailing part of a multipart
  58   /// relocation that will be printed as part of the leading relocation.
  59   std::error_code getHidden(bool &Result) const;
  60
  61   /// @brief Get a string that represents the type of this relocation.
  62   ///
  63   /// This is for display purposes only.
  64   std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
  65
  66   /// @brief Get a string that represents the calculation of the value of this
  67   ///        relocation.
  68   ///
  69   /// This is for display purposes only.
  70   std::error_code getValueString(SmallVectorImpl<char> &Result) const;
  71
  72   DataRefImpl getRawDataRefImpl() const;
  73   const ObjectFile *getObjectFile() const;
  74 };
  75 typedef content_iterator<RelocationRef> relocation_iterator;
  76
  77 /// SectionRef - This is a value type class that represents a single section in
  78 /// the list of sections in the object file.
  79 class SectionRef;
  80 typedef content_iterator<SectionRef> section_iterator;
  81 class SectionRef {
  82   friend class SymbolRef;
  83   DataRefImpl SectionPimpl;
  84   const ObjectFile *OwningObject;
  85
  86 public:
  87   SectionRef() : OwningObject(nullptr) { }
  88
  89   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
  90
  91   bool operator==(const SectionRef &Other) const;
  92   bool operator!=(const SectionRef &Other) const;
  93   bool operator<(const SectionRef &Other) const;
  94
  95   void moveNext();
  96
  97   std::error_code getName(StringRef &Result) const;
  98   uint64_t getAddress() const;
  99   uint64_t getSize() const;
 100   std::error_code getContents(StringRef &Result) const;
 101
 102   /// @brief Get the alignment of this section as the actual value (not log 2).
 103   uint64_t getAlignment() const;
 104
 105   bool isText() const;
 106   bool isData() const;
 107   bool isBSS() const;
 108   bool isRequiredForExecution() const;
 109   bool isVirtual() const;
 110   bool isZeroInit() const;
 111   bool isReadOnlyData() const;
 112
 113   bool containsSymbol(SymbolRef S) const;
 114
 115   relocation_iterator relocation_begin() const;
 116   relocation_iterator relocation_end() const;
 117   iterator_range<relocation_iterator> relocations() const {
 118     return iterator_range<relocation_iterator>(relocation_begin(),
 119                                                relocation_end());
 120   }
 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   std::error_code getName(StringRef &Result) const;
 146   /// Returns the symbol virtual address (i.e. address at which it will be
 147   /// mapped).
 148   std::error_code getAddress(uint64_t &Result) const;
 149   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 150   std::error_code getAlignment(uint32_t &Result) const;
 151   std::error_code getSize(uint64_t &Result) const;
 152   std::error_code getType(SymbolRef::Type &Result) const;
 153   std::error_code getOther(uint8_t &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 /// ObjectFile - This class is the base class for all object file types.
 181 /// Concrete instances of this object are created by createObjectFile, which
 182 /// figures out which type to create.
 183 class ObjectFile : public SymbolicFile {
 184   virtual void anchor();
 185   ObjectFile() LLVM_DELETED_FUNCTION;
 186   ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
 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 std::error_code getSymbolAlignment(DataRefImpl Symb,
 211                                              uint32_t &Res) const;
 212   virtual std::error_code getSymbolSize(DataRefImpl Symb,
 213                                         uint64_t &Res) 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   virtual bool isSectionRequiredForExecution(DataRefImpl Sec) const = 0;
 237   // A section is 'virtual' if its contents aren't present in the object image.
 238   virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
 239   virtual bool isSectionZeroInit(DataRefImpl Sec) const = 0;
 240   virtual bool isSectionReadOnlyData(DataRefImpl Sec) const = 0;
 241   virtual bool sectionContainsSymbol(DataRefImpl Sec,
 242                                      DataRefImpl Symb) const = 0;
 243   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 244   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 245   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 246
 247   // Same as above for RelocationRef.
 248   friend class RelocationRef;
 249   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 250   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
 251                                                uint64_t &Res) const = 0;
 252   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
 253                                               uint64_t &Res) const = 0;
 254   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 255   virtual std::error_code getRelocationType(DataRefImpl Rel,
 256                                             uint64_t &Res) const = 0;
 257   virtual std::error_code
 258   getRelocationTypeName(DataRefImpl Rel,
 259                         SmallVectorImpl<char> &Result) const = 0;
 260   virtual std::error_code
 261   getRelocationValueString(DataRefImpl Rel,
 262                            SmallVectorImpl<char> &Result) const = 0;
 263   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
 264                                               bool &Result) const {
 265     Result = false;
 266     return object_error::success;
 267   }
 268
 269 public:
 270   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 271   symbol_iterator_range symbols() const {
 272     return symbol_iterator_range(symbol_begin(), symbol_end());
 273   }
 274
 275   virtual section_iterator section_begin() const = 0;
 276   virtual section_iterator section_end() const = 0;
 277
 278   typedef iterator_range<section_iterator> section_iterator_range;
 279   section_iterator_range sections() const {
 280     return section_iterator_range(section_begin(), section_end());
 281   }
 282
 283   /// @brief The number of bytes used to represent an address in this object
 284   ///        file format.
 285   virtual uint8_t getBytesInAddress() const = 0;
 286
 287   virtual StringRef getFileFormatName() const = 0;
 288   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 289
 290   /// Returns platform-specific object flags, if any.
 291   virtual std::error_code getPlatformFlags(unsigned &Result) const {
 292     Result = 0;
 293     return object_error::invalid_file_type;
 294   }
 295
 296   /// True if this is a relocatable object (.o/.obj).
 297   virtual bool isRelocatableObject() const = 0;
 298
 299   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 300   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 301   ///        return true.
 302   /// @brief Create ObjectFile from path.
 303   static ErrorOr<OwningBinary<ObjectFile>>
 304   createObjectFile(StringRef ObjectPath);
 305
 306   static ErrorOr<std::unique_ptr<ObjectFile>>
 307   createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
 308   static ErrorOr<std::unique_ptr<ObjectFile>>
 309   createObjectFile(MemoryBufferRef Object) {
 310     return createObjectFile(Object, sys::fs::file_magic::unknown);
 311   }
 312
 313
 314   static inline bool classof(const Binary *v) {
 315     return v->isObject();
 316   }
 317
 318   static ErrorOr<std::unique_ptr<COFFObjectFile>>
 319   createCOFFObjectFile(MemoryBufferRef Object);
 320
 321   static ErrorOr<std::unique_ptr<ObjectFile>>
 322   createELFObjectFile(MemoryBufferRef Object);
 323
 324   static ErrorOr<std::unique_ptr<MachOObjectFile>>
 325   createMachOObjectFile(MemoryBufferRef Object);
 326 };
 327
 328 // Inline function definitions.
 329 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 330     : BasicSymbolRef(SymbolP, Owner) {}
 331
 332 inline std::error_code SymbolRef::getName(StringRef &Result) const {
 333   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 334 }
 335
 336 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
 337   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 338 }
 339
 340 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
 341   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
 342 }
 343
 344 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
 345   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
 346 }
 347
 348 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
 349   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 350 }
 351
 352 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 353   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 354 }
 355
 356 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
 357   return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
 358 }
 359
 360 inline const ObjectFile *SymbolRef::getObject() const {
 361   const SymbolicFile *O = BasicSymbolRef::getObject();
 362   return cast<ObjectFile>(O);
 363 }
 364
 365
 366 /// SectionRef
 367 inline SectionRef::SectionRef(DataRefImpl SectionP,
 368                               const ObjectFile *Owner)
 369   : SectionPimpl(SectionP)
 370   , OwningObject(Owner) {}
 371
 372 inline bool SectionRef::operator==(const SectionRef &Other) const {
 373   return SectionPimpl == Other.SectionPimpl;
 374 }
 375
 376 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 377   return SectionPimpl != Other.SectionPimpl;
 378 }
 379
 380 inline bool SectionRef::operator<(const SectionRef &Other) const {
 381   return SectionPimpl < Other.SectionPimpl;
 382 }
 383
 384 inline void SectionRef::moveNext() {
 385   return OwningObject->moveSectionNext(SectionPimpl);
 386 }
 387
 388 inline std::error_code SectionRef::getName(StringRef &Result) const {
 389   return OwningObject->getSectionName(SectionPimpl, Result);
 390 }
 391
 392 inline uint64_t SectionRef::getAddress() const {
 393   return OwningObject->getSectionAddress(SectionPimpl);
 394 }
 395
 396 inline uint64_t SectionRef::getSize() const {
 397   return OwningObject->getSectionSize(SectionPimpl);
 398 }
 399
 400 inline std::error_code SectionRef::getContents(StringRef &Result) const {
 401   return OwningObject->getSectionContents(SectionPimpl, Result);
 402 }
 403
 404 inline uint64_t SectionRef::getAlignment() const {
 405   return OwningObject->getSectionAlignment(SectionPimpl);
 406 }
 407
 408 inline bool SectionRef::isText() const {
 409   return OwningObject->isSectionText(SectionPimpl);
 410 }
 411
 412 inline bool SectionRef::isData() const {
 413   return OwningObject->isSectionData(SectionPimpl);
 414 }
 415
 416 inline bool SectionRef::isBSS() const {
 417   return OwningObject->isSectionBSS(SectionPimpl);
 418 }
 419
 420 inline bool SectionRef::isRequiredForExecution() const {
 421   return OwningObject->isSectionRequiredForExecution(SectionPimpl);
 422 }
 423
 424 inline bool SectionRef::isVirtual() const {
 425   return OwningObject->isSectionVirtual(SectionPimpl);
 426 }
 427
 428 inline bool SectionRef::isZeroInit() const {
 429   return OwningObject->isSectionZeroInit(SectionPimpl);
 430 }
 431
 432 inline bool SectionRef::isReadOnlyData() const {
 433   return OwningObject->isSectionReadOnlyData(SectionPimpl);
 434 }
 435
 436 inline bool SectionRef::containsSymbol(SymbolRef S) const {
 437   return OwningObject->sectionContainsSymbol(SectionPimpl,
 438                                              S.getRawDataRefImpl());
 439 }
 440
 441 inline relocation_iterator SectionRef::relocation_begin() const {
 442   return OwningObject->section_rel_begin(SectionPimpl);
 443 }
 444
 445 inline relocation_iterator SectionRef::relocation_end() const {
 446   return OwningObject->section_rel_end(SectionPimpl);
 447 }
 448
 449 inline section_iterator SectionRef::getRelocatedSection() const {
 450   return OwningObject->getRelocatedSection(SectionPimpl);
 451 }
 452
 453 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 454   return SectionPimpl;
 455 }
 456
 457 /// RelocationRef
 458 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 459                               const ObjectFile *Owner)
 460   : RelocationPimpl(RelocationP)
 461   , OwningObject(Owner) {}
 462
 463 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 464   return RelocationPimpl == Other.RelocationPimpl;
 465 }
 466
 467 inline void RelocationRef::moveNext() {
 468   return OwningObject->moveRelocationNext(RelocationPimpl);
 469 }
 470
 471 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
 472   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 473 }
 474
 475 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
 476   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 477 }
 478
 479 inline symbol_iterator RelocationRef::getSymbol() const {
 480   return OwningObject->getRelocationSymbol(RelocationPimpl);
 481 }
 482
 483 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
 484   return OwningObject->getRelocationType(RelocationPimpl, Result);
 485 }
 486
 487 inline std::error_code
 488 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
 489   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 490 }
 491
 492 inline std::error_code
 493 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
 494   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 495 }
 496
 497 inline std::error_code RelocationRef::getHidden(bool &Result) const {
 498   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 499 }
 500
 501 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 502   return RelocationPimpl;
 503 }
 504
 505 inline const ObjectFile *RelocationRef::getObjectFile() const {
 506   return OwningObject;
 507 }
 508
 509
 510 } // end namespace object
 511 } // end namespace llvm
 512
 513 #endif