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