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