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