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_OBJECT_FILE_H
  15 #define LLVM_OBJECT_OBJECT_FILE_H
  16
  17 #include "llvm/Object/Binary.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/Support/DataTypes.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include <cstring>
  23 #include <vector>
  24
  25 namespace llvm {
  26 namespace object {
  27
  28 class ObjectFile;
  29
  30 union DataRefImpl {
  31   struct {
  32     // ELF needs this for relocations. This entire union should probably be a
  33     // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
  34     uint16_t a, b;
  35     uint32_t c;
  36   } w;
  37   struct {
  38     uint32_t a, b;
  39   } d;
  40   uintptr_t p;
  41 };
  42
  43 template<class content_type>
  44 class content_iterator {
  45   content_type Current;
  46 public:
  47   content_iterator(content_type symb)
  48     : Current(symb) {}
  49
  50   const content_type* operator->() const {
  51     return &Current;
  52   }
  53
  54   const content_type &operator*() const {
  55     return Current;
  56   }
  57
  58   bool operator==(const content_iterator &other) const {
  59     return Current == other.Current;
  60   }
  61
  62   bool operator!=(const content_iterator &other) const {
  63     return !(*this == other);
  64   }
  65
  66   content_iterator& increment(error_code &err) {
  67     content_type next;
  68     if (error_code ec = Current.getNext(next))
  69       err = ec;
  70     else
  71       Current = next;
  72     return *this;
  73   }
  74 };
  75
  76 static bool operator ==(const DataRefImpl &a, const DataRefImpl &b) {
  77   // Check bitwise identical. This is the only legal way to compare a union w/o
  78   // knowing which member is in use.
  79   return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;
  80 }
  81
  82 static bool operator <(const DataRefImpl &a, const DataRefImpl &b) {
  83   // Check bitwise identical. This is the only legal way to compare a union w/o
  84   // knowing which member is in use.
  85   return std::memcmp(&a, &b, sizeof(DataRefImpl)) < 0;
  86 }
  87
  88 class SymbolRef;
  89
  90 /// RelocationRef - This is a value type class that represents a single
  91 /// relocation in the list of relocations in the object file.
  92 class RelocationRef {
  93   DataRefImpl RelocationPimpl;
  94   const ObjectFile *OwningObject;
  95
  96 public:
  97   RelocationRef() : OwningObject(NULL) {
  98     std::memset(&RelocationPimpl, 0, sizeof(RelocationPimpl));
  99   }
 100
 101   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
 102
 103   bool operator==(const RelocationRef &Other) const;
 104
 105   error_code getNext(RelocationRef &Result) const;
 106
 107   error_code getAddress(uint64_t &Result) const;
 108   error_code getOffset(uint64_t &Result) const;
 109   error_code getSymbol(SymbolRef &Result) const;
 110   error_code getType(uint64_t &Result) const;
 111
 112   /// @brief Indicates whether this relocation should hidden when listing
 113   /// relocations, usually because it is the trailing part of a multipart
 114   /// relocation that will be printed as part of the leading relocation.
 115   error_code getHidden(bool &Result) const;
 116
 117   /// @brief Get a string that represents the type of this relocation.
 118   ///
 119   /// This is for display purposes only.
 120   error_code getTypeName(SmallVectorImpl<char> &Result) const;
 121   error_code getAdditionalInfo(int64_t &Result) const;
 122
 123   /// @brief Get a string that represents the calculation of the value of this
 124   ///        relocation.
 125   ///
 126   /// This is for display purposes only.
 127   error_code getValueString(SmallVectorImpl<char> &Result) const;
 128 };
 129 typedef content_iterator<RelocationRef> relocation_iterator;
 130
 131 /// SectionRef - This is a value type class that represents a single section in
 132 /// the list of sections in the object file.
 133 class SectionRef {
 134   friend class SymbolRef;
 135   DataRefImpl SectionPimpl;
 136   const ObjectFile *OwningObject;
 137
 138 public:
 139   SectionRef() : OwningObject(NULL) {
 140     std::memset(&SectionPimpl, 0, sizeof(SectionPimpl));
 141   }
 142
 143   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
 144
 145   bool operator==(const SectionRef &Other) const;
 146   bool operator <(const SectionRef &Other) const;
 147
 148   error_code getNext(SectionRef &Result) const;
 149
 150   error_code getName(StringRef &Result) const;
 151   error_code getAddress(uint64_t &Result) const;
 152   error_code getSize(uint64_t &Result) const;
 153   error_code getContents(StringRef &Result) const;
 154
 155   /// @brief Get the alignment of this section as the actual value (not log 2).
 156   error_code getAlignment(uint64_t &Result) const;
 157
 158   // FIXME: Move to the normalization layer when it's created.
 159   error_code isText(bool &Result) const;
 160   error_code isData(bool &Result) const;
 161   error_code isBSS(bool &Result) const;
 162
 163   error_code containsSymbol(SymbolRef S, bool &Result) const;
 164
 165   relocation_iterator begin_relocations() const;
 166   relocation_iterator end_relocations() const;
 167 };
 168 typedef content_iterator<SectionRef> section_iterator;
 169
 170 /// SymbolRef - This is a value type class that represents a single symbol in
 171 /// the list of symbols in the object file.
 172 class SymbolRef {
 173   friend class SectionRef;
 174   DataRefImpl SymbolPimpl;
 175   const ObjectFile *OwningObject;
 176
 177 public:
 178   SymbolRef() : OwningObject(NULL) {
 179     std::memset(&SymbolPimpl, 0, sizeof(SymbolPimpl));
 180   }
 181
 182   enum Type {
 183     ST_Data,
 184     ST_Debug,
 185     ST_External,    // Defined in another object file
 186     ST_File,
 187     ST_Function,
 188     ST_Other
 189   };
 190
 191   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 192
 193   bool operator==(const SymbolRef &Other) const;
 194   bool operator <(const SymbolRef &Other) const;
 195
 196   error_code getNext(SymbolRef &Result) const;
 197
 198   error_code getName(StringRef &Result) const;
 199   error_code getAddress(uint64_t &Result) const;
 200   error_code getFileOffset(uint64_t &Result) const;
 201   error_code getSize(uint64_t &Result) const;
 202   error_code getType(SymbolRef::Type &Result) const;
 203
 204   /// Returns the ascii char that should be displayed in a symbol table dump via
 205   /// nm for this symbol.
 206   error_code getNMTypeChar(char &Result) const;
 207
 208   /// Returns true for symbols that are internal to the object file format such
 209   /// as section symbols.
 210   error_code isInternal(bool &Result) const;
 211
 212   /// Returns true for symbols that can be used in another objects,
 213   /// such as library functions
 214   error_code isGlobal(bool &Result) const;
 215
 216   /// Returns true for weak symbols.
 217   error_code isWeak(bool &Result) const;
 218
 219   /// @brief Return true for absolute symbols.
 220   error_code isAbsolute(bool &Result) const;
 221
 222   /// @brief Get section this symbol is defined in reference to. Result is
 223   /// end_sections() if it is undefined or is an absolute symbol.
 224   error_code getSection(section_iterator &Result) const;
 225
 226   DataRefImpl getRawDataRefImpl() const;
 227 };
 228 typedef content_iterator<SymbolRef> symbol_iterator;
 229
 230 const uint64_t UnknownAddressOrSize = ~0ULL;
 231
 232 /// ObjectFile - This class is the base class for all object file types.
 233 /// Concrete instances of this object are created by createObjectFile, which
 234 /// figure out which type to create.
 235 class ObjectFile : public Binary {
 236   virtual void anchor();
 237   ObjectFile(); // = delete
 238   ObjectFile(const ObjectFile &other); // = delete
 239
 240 protected:
 241   ObjectFile(unsigned int Type, MemoryBuffer *source, error_code &ec);
 242
 243   const uint8_t *base() const {
 244     return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
 245   }
 246
 247   // These functions are for SymbolRef to call internally. The main goal of
 248   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 249   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 250   // virtual functions because then it could not point into the memory mapped
 251   // file.
 252   //
 253   // Implementations assume that the DataRefImpl is valid and has not been
 254   // modified externally. It's UB otherwise.
 255   friend class SymbolRef;
 256   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
 257   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
 258   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const =0;
 259   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const =0;
 260   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
 261   virtual error_code getSymbolType(DataRefImpl Symb,
 262                                    SymbolRef::Type &Res) const = 0;
 263   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const = 0;
 264   virtual error_code isSymbolInternal(DataRefImpl Symb, bool &Res) const = 0;
 265   virtual error_code isSymbolGlobal(DataRefImpl Symb, bool &Res) const = 0;
 266   virtual error_code isSymbolWeak(DataRefImpl Symb, bool &Res) const = 0;
 267   virtual error_code isSymbolAbsolute(DataRefImpl Symb, bool &Res) const = 0;
 268   virtual error_code getSymbolSection(DataRefImpl Symb,
 269                                       section_iterator &Res) const = 0;
 270
 271   // Same as above for SectionRef.
 272   friend class SectionRef;
 273   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
 274   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
 275   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
 276   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
 277   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
 278   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
 279   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 280   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 281   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 282   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 283                                            bool &Result) const = 0;
 284   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const = 0;
 285   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const = 0;
 286
 287
 288   // Same as above for RelocationRef.
 289   friend class RelocationRef;
 290   virtual error_code getRelocationNext(DataRefImpl Rel,
 291                                        RelocationRef &Res) const = 0;
 292   virtual error_code getRelocationAddress(DataRefImpl Rel,
 293                                           uint64_t &Res) const =0;
 294   virtual error_code getRelocationOffset(DataRefImpl Rel,
 295                                          uint64_t &Res) const =0;
 296   virtual error_code getRelocationSymbol(DataRefImpl Rel,
 297                                          SymbolRef &Res) const = 0;
 298   virtual error_code getRelocationType(DataRefImpl Rel,
 299                                        uint64_t &Res) const = 0;
 300   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 301                                        SmallVectorImpl<char> &Result) const = 0;
 302   virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
 303                                                  int64_t &Res) const = 0;
 304   virtual error_code getRelocationValueString(DataRefImpl Rel,
 305                                        SmallVectorImpl<char> &Result) const = 0;
 306   virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
 307     Result = false;
 308     return object_error::success;
 309   }
 310
 311 public:
 312
 313   virtual symbol_iterator begin_symbols() const = 0;
 314   virtual symbol_iterator end_symbols() const = 0;
 315
 316   virtual section_iterator begin_sections() const = 0;
 317   virtual section_iterator end_sections() const = 0;
 318
 319   /// @brief The number of bytes used to represent an address in this object
 320   ///        file format.
 321   virtual uint8_t getBytesInAddress() const = 0;
 322
 323   virtual StringRef getFileFormatName() const = 0;
 324   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 325
 326   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 327   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 328   ///        return true.
 329   /// @brief Create ObjectFile from path.
 330   static ObjectFile *createObjectFile(StringRef ObjectPath);
 331   static ObjectFile *createObjectFile(MemoryBuffer *Object);
 332
 333   static inline bool classof(const Binary *v) {
 334     return v->getType() >= isObject &&
 335            v->getType() < lastObject;
 336   }
 337   static inline bool classof(const ObjectFile *v) { return true; }
 338
 339 public:
 340   static ObjectFile *createCOFFObjectFile(MemoryBuffer *Object);
 341   static ObjectFile *createELFObjectFile(MemoryBuffer *Object,
 342       bool doDyld = false, std::vector<uint8_t*> *MemoryMap = 0);
 343   static ObjectFile *createMachOObjectFile(MemoryBuffer *Object);
 344 };
 345
 346 // Inline function definitions.
 347 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 348   : SymbolPimpl(SymbolP)
 349   , OwningObject(Owner) {}
 350
 351 inline bool SymbolRef::operator==(const SymbolRef &Other) const {
 352   return SymbolPimpl == Other.SymbolPimpl;
 353 }
 354
 355 inline bool SymbolRef::operator <(const SymbolRef &Other) const {
 356   return SymbolPimpl < Other.SymbolPimpl;
 357 }
 358
 359 inline error_code SymbolRef::getNext(SymbolRef &Result) const {
 360   return OwningObject->getSymbolNext(SymbolPimpl, Result);
 361 }
 362
 363 inline error_code SymbolRef::getName(StringRef &Result) const {
 364   return OwningObject->getSymbolName(SymbolPimpl, Result);
 365 }
 366
 367 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
 368   return OwningObject->getSymbolAddress(SymbolPimpl, Result);
 369 }
 370
 371 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
 372   return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
 373 }
 374
 375 inline error_code SymbolRef::getSize(uint64_t &Result) const {
 376   return OwningObject->getSymbolSize(SymbolPimpl, Result);
 377 }
 378
 379 inline error_code SymbolRef::getNMTypeChar(char &Result) const {
 380   return OwningObject->getSymbolNMTypeChar(SymbolPimpl, Result);
 381 }
 382
 383 inline error_code SymbolRef::isInternal(bool &Result) const {
 384   return OwningObject->isSymbolInternal(SymbolPimpl, Result);
 385 }
 386
 387 inline error_code SymbolRef::isGlobal(bool &Result) const {
 388   return OwningObject->isSymbolGlobal(SymbolPimpl, Result);
 389 }
 390
 391 inline error_code SymbolRef::isWeak(bool &Result) const {
 392   return OwningObject->isSymbolWeak(SymbolPimpl, Result);
 393 }
 394
 395 inline error_code SymbolRef::isAbsolute(bool &Result) const {
 396   return OwningObject->isSymbolAbsolute(SymbolPimpl, Result);
 397 }
 398
 399 inline error_code SymbolRef::getSection(section_iterator &Result) const {
 400   return OwningObject->getSymbolSection(SymbolPimpl, Result);
 401 }
 402
 403 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 404   return OwningObject->getSymbolType(SymbolPimpl, Result);
 405 }
 406
 407 inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
 408   return SymbolPimpl;
 409 }
 410
 411
 412 /// SectionRef
 413 inline SectionRef::SectionRef(DataRefImpl SectionP,
 414                               const ObjectFile *Owner)
 415   : SectionPimpl(SectionP)
 416   , OwningObject(Owner) {}
 417
 418 inline bool SectionRef::operator==(const SectionRef &Other) const {
 419   return SectionPimpl == Other.SectionPimpl;
 420 }
 421
 422 inline bool SectionRef::operator <(const SectionRef &Other) const {
 423   return SectionPimpl < Other.SectionPimpl;
 424 }
 425
 426 inline error_code SectionRef::getNext(SectionRef &Result) const {
 427   return OwningObject->getSectionNext(SectionPimpl, Result);
 428 }
 429
 430 inline error_code SectionRef::getName(StringRef &Result) const {
 431   return OwningObject->getSectionName(SectionPimpl, Result);
 432 }
 433
 434 inline error_code SectionRef::getAddress(uint64_t &Result) const {
 435   return OwningObject->getSectionAddress(SectionPimpl, Result);
 436 }
 437
 438 inline error_code SectionRef::getSize(uint64_t &Result) const {
 439   return OwningObject->getSectionSize(SectionPimpl, Result);
 440 }
 441
 442 inline error_code SectionRef::getContents(StringRef &Result) const {
 443   return OwningObject->getSectionContents(SectionPimpl, Result);
 444 }
 445
 446 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
 447   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 448 }
 449
 450 inline error_code SectionRef::isText(bool &Result) const {
 451   return OwningObject->isSectionText(SectionPimpl, Result);
 452 }
 453
 454 inline error_code SectionRef::isData(bool &Result) const {
 455   return OwningObject->isSectionData(SectionPimpl, Result);
 456 }
 457
 458 inline error_code SectionRef::isBSS(bool &Result) const {
 459   return OwningObject->isSectionBSS(SectionPimpl, Result);
 460 }
 461
 462 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
 463   return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
 464                                              Result);
 465 }
 466
 467 inline relocation_iterator SectionRef::begin_relocations() const {
 468   return OwningObject->getSectionRelBegin(SectionPimpl);
 469 }
 470
 471 inline relocation_iterator SectionRef::end_relocations() const {
 472   return OwningObject->getSectionRelEnd(SectionPimpl);
 473 }
 474
 475
 476 /// RelocationRef
 477 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 478                               const ObjectFile *Owner)
 479   : RelocationPimpl(RelocationP)
 480   , OwningObject(Owner) {}
 481
 482 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 483   return RelocationPimpl == Other.RelocationPimpl;
 484 }
 485
 486 inline error_code RelocationRef::getNext(RelocationRef &Result) const {
 487   return OwningObject->getRelocationNext(RelocationPimpl, Result);
 488 }
 489
 490 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
 491   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 492 }
 493
 494 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
 495   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 496 }
 497
 498 inline error_code RelocationRef::getSymbol(SymbolRef &Result) const {
 499   return OwningObject->getRelocationSymbol(RelocationPimpl, Result);
 500 }
 501
 502 inline error_code RelocationRef::getType(uint64_t &Result) const {
 503   return OwningObject->getRelocationType(RelocationPimpl, Result);
 504 }
 505
 506 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
 507   const {
 508   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 509 }
 510
 511 inline error_code RelocationRef::getAdditionalInfo(int64_t &Result) const {
 512   return OwningObject->getRelocationAdditionalInfo(RelocationPimpl, Result);
 513 }
 514
 515 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
 516   const {
 517   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 518 }
 519
 520 inline error_code RelocationRef::getHidden(bool &Result) const {
 521   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 522 }
 523
 524 } // end namespace object
 525 } // end namespace llvm
 526
 527 #endif