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   std::error_code getAddress(uint64_t &Result) const;
  99   std::error_code getSize(uint64_t &Result) 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   std::error_code getAlignment(uint64_t &Result) const;
 104
 105   // FIXME: Move to the normalization layer when it's created.
 106   std::error_code isText(bool &Result) const;
 107   std::error_code isData(bool &Result) const;
 108   std::error_code isBSS(bool &Result) const;
 109   std::error_code isRequiredForExecution(bool &Result) const;
 110   std::error_code isVirtual(bool &Result) const;
 111   std::error_code isZeroInit(bool &Result) const;
 112   std::error_code isReadOnlyData(bool &Result) const;
 113
 114   std::error_code containsSymbol(SymbolRef S, bool &Result) const;
 115
 116   relocation_iterator relocation_begin() const;
 117   relocation_iterator relocation_end() const;
 118   iterator_range<relocation_iterator> relocations() const {
 119     return iterator_range<relocation_iterator>(relocation_begin(),
 120                                                relocation_end());
 121   }
 122   section_iterator getRelocatedSection() const;
 123
 124   DataRefImpl getRawDataRefImpl() const;
 125 };
 126
 127 /// SymbolRef - This is a value type class that represents a single symbol in
 128 /// the list of symbols in the object file.
 129 class SymbolRef : public BasicSymbolRef {
 130   friend class SectionRef;
 131
 132 public:
 133   SymbolRef() : BasicSymbolRef() {}
 134
 135   enum Type {
 136     ST_Unknown, // Type not specified
 137     ST_Data,
 138     ST_Debug,
 139     ST_File,
 140     ST_Function,
 141     ST_Other
 142   };
 143
 144   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 145
 146   std::error_code getName(StringRef &Result) const;
 147   /// Returns the symbol virtual address (i.e. address at which it will be
 148   /// mapped).
 149   std::error_code getAddress(uint64_t &Result) const;
 150   /// @brief Get the alignment of this symbol as the actual value (not log 2).
 151   std::error_code getAlignment(uint32_t &Result) const;
 152   std::error_code getSize(uint64_t &Result) 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 /// ObjectFile - This class is the base class for all object file types.
 182 /// Concrete instances of this object are created by createObjectFile, which
 183 /// figures out which type to create.
 184 class ObjectFile : public SymbolicFile {
 185   virtual void anchor();
 186   ObjectFile() LLVM_DELETED_FUNCTION;
 187   ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
 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 std::error_code getSymbolAlignment(DataRefImpl Symb,
 212                                              uint32_t &Res) const;
 213   virtual std::error_code getSymbolSize(DataRefImpl Symb,
 214                                         uint64_t &Res) const = 0;
 215   virtual std::error_code getSymbolType(DataRefImpl Symb,
 216                                         SymbolRef::Type &Res) const = 0;
 217   virtual std::error_code getSymbolSection(DataRefImpl Symb,
 218                                            section_iterator &Res) const = 0;
 219   virtual std::error_code getSymbolOther(DataRefImpl Symb,
 220                                          uint8_t &Res) const {
 221     return object_error::invalid_file_type;
 222   }
 223
 224   // Same as above for SectionRef.
 225   friend class SectionRef;
 226   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
 227   virtual std::error_code getSectionName(DataRefImpl Sec,
 228                                          StringRef &Res) const = 0;
 229   virtual std::error_code getSectionAddress(DataRefImpl Sec,
 230                                             uint64_t &Res) const = 0;
 231   virtual std::error_code getSectionSize(DataRefImpl Sec,
 232                                          uint64_t &Res) const = 0;
 233   virtual std::error_code getSectionContents(DataRefImpl Sec,
 234                                              StringRef &Res) const = 0;
 235   virtual std::error_code getSectionAlignment(DataRefImpl Sec,
 236                                               uint64_t &Res) const = 0;
 237   virtual std::error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 238   virtual std::error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 239   virtual std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 240   virtual std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
 241                                                         bool &Res) const = 0;
 242   // A section is 'virtual' if its contents aren't present in the object image.
 243   virtual std::error_code isSectionVirtual(DataRefImpl Sec,
 244                                            bool &Res) const = 0;
 245   virtual std::error_code isSectionZeroInit(DataRefImpl Sec,
 246                                             bool &Res) const = 0;
 247   virtual std::error_code isSectionReadOnlyData(DataRefImpl Sec,
 248                                                 bool &Res) const = 0;
 249   virtual std::error_code sectionContainsSymbol(DataRefImpl Sec,
 250                                                 DataRefImpl Symb,
 251                                                 bool &Result) const = 0;
 252   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
 253   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
 254   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
 255
 256   // Same as above for RelocationRef.
 257   friend class RelocationRef;
 258   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
 259   virtual std::error_code getRelocationAddress(DataRefImpl Rel,
 260                                                uint64_t &Res) const = 0;
 261   virtual std::error_code getRelocationOffset(DataRefImpl Rel,
 262                                               uint64_t &Res) const = 0;
 263   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
 264   virtual std::error_code getRelocationType(DataRefImpl Rel,
 265                                             uint64_t &Res) const = 0;
 266   virtual std::error_code
 267   getRelocationTypeName(DataRefImpl Rel,
 268                         SmallVectorImpl<char> &Result) const = 0;
 269   virtual std::error_code
 270   getRelocationValueString(DataRefImpl Rel,
 271                            SmallVectorImpl<char> &Result) const = 0;
 272   virtual std::error_code getRelocationHidden(DataRefImpl Rel,
 273                                               bool &Result) const {
 274     Result = false;
 275     return object_error::success;
 276   }
 277
 278 public:
 279   typedef iterator_range<symbol_iterator> symbol_iterator_range;
 280   symbol_iterator_range symbols() const {
 281     return symbol_iterator_range(symbol_begin(), symbol_end());
 282   }
 283
 284   virtual section_iterator section_begin() const = 0;
 285   virtual section_iterator section_end() const = 0;
 286
 287   typedef iterator_range<section_iterator> section_iterator_range;
 288   section_iterator_range sections() const {
 289     return section_iterator_range(section_begin(), section_end());
 290   }
 291
 292   /// @brief The number of bytes used to represent an address in this object
 293   ///        file format.
 294   virtual uint8_t getBytesInAddress() const = 0;
 295
 296   virtual StringRef getFileFormatName() const = 0;
 297   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 298
 299   /// Returns platform-specific object flags, if any.
 300   virtual std::error_code getPlatformFlags(unsigned &Result) const {
 301     Result = 0;
 302     return object_error::invalid_file_type;
 303   }
 304
 305   /// True if this is a relocatable object (.o/.obj).
 306   virtual bool isRelocatableObject() const = 0;
 307
 308   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 309   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 310   ///        return true.
 311   /// @brief Create ObjectFile from path.
 312   static ErrorOr<OwningBinary<ObjectFile>>
 313   createObjectFile(StringRef ObjectPath);
 314
 315   static ErrorOr<std::unique_ptr<ObjectFile>>
 316   createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
 317   static ErrorOr<std::unique_ptr<ObjectFile>>
 318   createObjectFile(MemoryBufferRef Object) {
 319     return createObjectFile(Object, sys::fs::file_magic::unknown);
 320   }
 321
 322
 323   static inline bool classof(const Binary *v) {
 324     return v->isObject();
 325   }
 326
 327   static ErrorOr<std::unique_ptr<COFFObjectFile>>
 328   createCOFFObjectFile(MemoryBufferRef Object);
 329
 330   static ErrorOr<std::unique_ptr<ObjectFile>>
 331   createELFObjectFile(MemoryBufferRef Object);
 332
 333   static ErrorOr<std::unique_ptr<MachOObjectFile>>
 334   createMachOObjectFile(MemoryBufferRef Object);
 335 };
 336
 337 // Inline function definitions.
 338 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 339     : BasicSymbolRef(SymbolP, Owner) {}
 340
 341 inline std::error_code SymbolRef::getName(StringRef &Result) const {
 342   return getObject()->getSymbolName(getRawDataRefImpl(), Result);
 343 }
 344
 345 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
 346   return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
 347 }
 348
 349 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
 350   return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
 351 }
 352
 353 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
 354   return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
 355 }
 356
 357 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
 358   return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
 359 }
 360
 361 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 362   return getObject()->getSymbolType(getRawDataRefImpl(), Result);
 363 }
 364
 365 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
 366   return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
 367 }
 368
 369 inline const ObjectFile *SymbolRef::getObject() const {
 370   const SymbolicFile *O = BasicSymbolRef::getObject();
 371   return cast<ObjectFile>(O);
 372 }
 373
 374
 375 /// SectionRef
 376 inline SectionRef::SectionRef(DataRefImpl SectionP,
 377                               const ObjectFile *Owner)
 378   : SectionPimpl(SectionP)
 379   , OwningObject(Owner) {}
 380
 381 inline bool SectionRef::operator==(const SectionRef &Other) const {
 382   return SectionPimpl == Other.SectionPimpl;
 383 }
 384
 385 inline bool SectionRef::operator!=(const SectionRef &Other) const {
 386   return SectionPimpl != Other.SectionPimpl;
 387 }
 388
 389 inline bool SectionRef::operator<(const SectionRef &Other) const {
 390   return SectionPimpl < Other.SectionPimpl;
 391 }
 392
 393 inline void SectionRef::moveNext() {
 394   return OwningObject->moveSectionNext(SectionPimpl);
 395 }
 396
 397 inline std::error_code SectionRef::getName(StringRef &Result) const {
 398   return OwningObject->getSectionName(SectionPimpl, Result);
 399 }
 400
 401 inline std::error_code SectionRef::getAddress(uint64_t &Result) const {
 402   return OwningObject->getSectionAddress(SectionPimpl, Result);
 403 }
 404
 405 inline std::error_code SectionRef::getSize(uint64_t &Result) const {
 406   return OwningObject->getSectionSize(SectionPimpl, Result);
 407 }
 408
 409 inline std::error_code SectionRef::getContents(StringRef &Result) const {
 410   return OwningObject->getSectionContents(SectionPimpl, Result);
 411 }
 412
 413 inline std::error_code SectionRef::getAlignment(uint64_t &Result) const {
 414   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 415 }
 416
 417 inline std::error_code SectionRef::isText(bool &Result) const {
 418   return OwningObject->isSectionText(SectionPimpl, Result);
 419 }
 420
 421 inline std::error_code SectionRef::isData(bool &Result) const {
 422   return OwningObject->isSectionData(SectionPimpl, Result);
 423 }
 424
 425 inline std::error_code SectionRef::isBSS(bool &Result) const {
 426   return OwningObject->isSectionBSS(SectionPimpl, Result);
 427 }
 428
 429 inline std::error_code SectionRef::isRequiredForExecution(bool &Result) const {
 430   return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
 431 }
 432
 433 inline std::error_code SectionRef::isVirtual(bool &Result) const {
 434   return OwningObject->isSectionVirtual(SectionPimpl, Result);
 435 }
 436
 437 inline std::error_code SectionRef::isZeroInit(bool &Result) const {
 438   return OwningObject->isSectionZeroInit(SectionPimpl, Result);
 439 }
 440
 441 inline std::error_code SectionRef::isReadOnlyData(bool &Result) const {
 442   return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
 443 }
 444
 445 inline std::error_code SectionRef::containsSymbol(SymbolRef S,
 446                                                   bool &Result) const {
 447   return OwningObject->sectionContainsSymbol(SectionPimpl,
 448                                              S.getRawDataRefImpl(), Result);
 449 }
 450
 451 inline relocation_iterator SectionRef::relocation_begin() const {
 452   return OwningObject->section_rel_begin(SectionPimpl);
 453 }
 454
 455 inline relocation_iterator SectionRef::relocation_end() const {
 456   return OwningObject->section_rel_end(SectionPimpl);
 457 }
 458
 459 inline section_iterator SectionRef::getRelocatedSection() const {
 460   return OwningObject->getRelocatedSection(SectionPimpl);
 461 }
 462
 463 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
 464   return SectionPimpl;
 465 }
 466
 467 /// RelocationRef
 468 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 469                               const ObjectFile *Owner)
 470   : RelocationPimpl(RelocationP)
 471   , OwningObject(Owner) {}
 472
 473 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 474   return RelocationPimpl == Other.RelocationPimpl;
 475 }
 476
 477 inline void RelocationRef::moveNext() {
 478   return OwningObject->moveRelocationNext(RelocationPimpl);
 479 }
 480
 481 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
 482   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 483 }
 484
 485 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
 486   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 487 }
 488
 489 inline symbol_iterator RelocationRef::getSymbol() const {
 490   return OwningObject->getRelocationSymbol(RelocationPimpl);
 491 }
 492
 493 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
 494   return OwningObject->getRelocationType(RelocationPimpl, Result);
 495 }
 496
 497 inline std::error_code
 498 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
 499   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 500 }
 501
 502 inline std::error_code
 503 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
 504   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 505 }
 506
 507 inline std::error_code RelocationRef::getHidden(bool &Result) const {
 508   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 509 }
 510
 511 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
 512   return RelocationPimpl;
 513 }
 514
 515 inline const ObjectFile *RelocationRef::getObjectFile() const {
 516   return OwningObject;
 517 }
 518
 519
 520 } // end namespace object
 521 } // end namespace llvm
 522
 523 #endif