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_Unknown, // Type not specified
 184     ST_Data,
 185     ST_Debug,
 186     ST_File,
 187     ST_Function,
 188     ST_Other
 189   };
 190
 191   enum Flags {
 192     SF_None            = 0,
 193     SF_Undefined       = 1U << 0,  // Symbol is defined in another object file
 194     SF_Global          = 1U << 1,  // Global symbol
 195     SF_Weak            = 1U << 2,  // Weak symbol
 196     SF_Absolute        = 1U << 3,  // Absolute symbol
 197     SF_ThreadLocal     = 1U << 4,  // Thread local symbol
 198     SF_Common          = 1U << 5,  // Symbol has common linkage
 199     SF_FormatSpecific  = 1U << 31  // Specific to the object file format
 200                                    // (e.g. section symbols)
 201   };
 202
 203   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
 204
 205   bool operator==(const SymbolRef &Other) const;
 206   bool operator <(const SymbolRef &Other) const;
 207
 208   error_code getNext(SymbolRef &Result) const;
 209
 210   error_code getName(StringRef &Result) const;
 211   error_code getAddress(uint64_t &Result) const;
 212   error_code getFileOffset(uint64_t &Result) const;
 213   error_code getSize(uint64_t &Result) const;
 214   error_code getType(SymbolRef::Type &Result) const;
 215
 216   /// Returns the ascii char that should be displayed in a symbol table dump via
 217   /// nm for this symbol.
 218   error_code getNMTypeChar(char &Result) const;
 219
 220   /// Get symbol flags (bitwise OR of SymbolRef::Flags)
 221   error_code getFlags(uint32_t &Result) const;
 222
 223   /// @brief Get section this symbol is defined in reference to. Result is
 224   /// end_sections() if it is undefined or is an absolute symbol.
 225   error_code getSection(section_iterator &Result) const;
 226
 227   DataRefImpl getRawDataRefImpl() const;
 228 };
 229 typedef content_iterator<SymbolRef> symbol_iterator;
 230
 231 const uint64_t UnknownAddressOrSize = ~0ULL;
 232
 233 /// ObjectFile - This class is the base class for all object file types.
 234 /// Concrete instances of this object are created by createObjectFile, which
 235 /// figure out which type to create.
 236 class ObjectFile : public Binary {
 237   virtual void anchor();
 238   ObjectFile(); // = delete
 239   ObjectFile(const ObjectFile &other); // = delete
 240
 241 protected:
 242   ObjectFile(unsigned int Type, MemoryBuffer *source, error_code &ec);
 243
 244   const uint8_t *base() const {
 245     return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
 246   }
 247
 248   // These functions are for SymbolRef to call internally. The main goal of
 249   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
 250   // entry in the memory mapped object file. SymbolPimpl cannot contain any
 251   // virtual functions because then it could not point into the memory mapped
 252   // file.
 253   //
 254   // Implementations assume that the DataRefImpl is valid and has not been
 255   // modified externally. It's UB otherwise.
 256   friend class SymbolRef;
 257   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
 258   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
 259   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const =0;
 260   virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const =0;
 261   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
 262   virtual error_code getSymbolType(DataRefImpl Symb,
 263                                    SymbolRef::Type &Res) const = 0;
 264   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const = 0;
 265   virtual error_code getSymbolFlags(DataRefImpl Symb,
 266                                     uint32_t &Res) const = 0;
 267   virtual error_code getSymbolSection(DataRefImpl Symb,
 268                                       section_iterator &Res) const = 0;
 269
 270   // Same as above for SectionRef.
 271   friend class SectionRef;
 272   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
 273   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
 274   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
 275   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
 276   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
 277   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
 278   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
 279   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
 280   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
 281   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 282                                            bool &Result) const = 0;
 283   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const = 0;
 284   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const = 0;
 285
 286
 287   // Same as above for RelocationRef.
 288   friend class RelocationRef;
 289   virtual error_code getRelocationNext(DataRefImpl Rel,
 290                                        RelocationRef &Res) const = 0;
 291   virtual error_code getRelocationAddress(DataRefImpl Rel,
 292                                           uint64_t &Res) const =0;
 293   virtual error_code getRelocationOffset(DataRefImpl Rel,
 294                                          uint64_t &Res) const =0;
 295   virtual error_code getRelocationSymbol(DataRefImpl Rel,
 296                                          SymbolRef &Res) const = 0;
 297   virtual error_code getRelocationType(DataRefImpl Rel,
 298                                        uint64_t &Res) const = 0;
 299   virtual error_code getRelocationTypeName(DataRefImpl Rel,
 300                                        SmallVectorImpl<char> &Result) const = 0;
 301   virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
 302                                                  int64_t &Res) const = 0;
 303   virtual error_code getRelocationValueString(DataRefImpl Rel,
 304                                        SmallVectorImpl<char> &Result) const = 0;
 305   virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
 306     Result = false;
 307     return object_error::success;
 308   }
 309
 310 public:
 311
 312   virtual symbol_iterator begin_symbols() const = 0;
 313   virtual symbol_iterator end_symbols() const = 0;
 314
 315   virtual symbol_iterator begin_dynamic_symbols() const = 0;
 316   virtual symbol_iterator end_dynamic_symbols() const = 0;
 317
 318   virtual section_iterator begin_sections() const = 0;
 319   virtual section_iterator end_sections() const = 0;
 320
 321   /// @brief The number of bytes used to represent an address in this object
 322   ///        file format.
 323   virtual uint8_t getBytesInAddress() const = 0;
 324
 325   virtual StringRef getFileFormatName() const = 0;
 326   virtual /* Triple::ArchType */ unsigned getArch() const = 0;
 327
 328   /// @returns Pointer to ObjectFile subclass to handle this type of object.
 329   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
 330   ///        return true.
 331   /// @brief Create ObjectFile from path.
 332   static ObjectFile *createObjectFile(StringRef ObjectPath);
 333   static ObjectFile *createObjectFile(MemoryBuffer *Object);
 334
 335   static inline bool classof(const Binary *v) {
 336     return v->getType() >= isObject &&
 337            v->getType() < lastObject;
 338   }
 339   static inline bool classof(const ObjectFile *v) { return true; }
 340
 341 public:
 342   static ObjectFile *createCOFFObjectFile(MemoryBuffer *Object);
 343   static ObjectFile *createELFObjectFile(MemoryBuffer *Object);
 344   static ObjectFile *createMachOObjectFile(MemoryBuffer *Object);
 345 };
 346
 347 // Inline function definitions.
 348 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
 349   : SymbolPimpl(SymbolP)
 350   , OwningObject(Owner) {}
 351
 352 inline bool SymbolRef::operator==(const SymbolRef &Other) const {
 353   return SymbolPimpl == Other.SymbolPimpl;
 354 }
 355
 356 inline bool SymbolRef::operator <(const SymbolRef &Other) const {
 357   return SymbolPimpl < Other.SymbolPimpl;
 358 }
 359
 360 inline error_code SymbolRef::getNext(SymbolRef &Result) const {
 361   return OwningObject->getSymbolNext(SymbolPimpl, Result);
 362 }
 363
 364 inline error_code SymbolRef::getName(StringRef &Result) const {
 365   return OwningObject->getSymbolName(SymbolPimpl, Result);
 366 }
 367
 368 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
 369   return OwningObject->getSymbolAddress(SymbolPimpl, Result);
 370 }
 371
 372 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
 373   return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
 374 }
 375
 376 inline error_code SymbolRef::getSize(uint64_t &Result) const {
 377   return OwningObject->getSymbolSize(SymbolPimpl, Result);
 378 }
 379
 380 inline error_code SymbolRef::getNMTypeChar(char &Result) const {
 381   return OwningObject->getSymbolNMTypeChar(SymbolPimpl, Result);
 382 }
 383
 384 inline error_code SymbolRef::getFlags(uint32_t &Result) const {
 385   return OwningObject->getSymbolFlags(SymbolPimpl, Result);
 386 }
 387
 388 inline error_code SymbolRef::getSection(section_iterator &Result) const {
 389   return OwningObject->getSymbolSection(SymbolPimpl, Result);
 390 }
 391
 392 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
 393   return OwningObject->getSymbolType(SymbolPimpl, Result);
 394 }
 395
 396 inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
 397   return SymbolPimpl;
 398 }
 399
 400
 401 /// SectionRef
 402 inline SectionRef::SectionRef(DataRefImpl SectionP,
 403                               const ObjectFile *Owner)
 404   : SectionPimpl(SectionP)
 405   , OwningObject(Owner) {}
 406
 407 inline bool SectionRef::operator==(const SectionRef &Other) const {
 408   return SectionPimpl == Other.SectionPimpl;
 409 }
 410
 411 inline bool SectionRef::operator <(const SectionRef &Other) const {
 412   return SectionPimpl < Other.SectionPimpl;
 413 }
 414
 415 inline error_code SectionRef::getNext(SectionRef &Result) const {
 416   return OwningObject->getSectionNext(SectionPimpl, Result);
 417 }
 418
 419 inline error_code SectionRef::getName(StringRef &Result) const {
 420   return OwningObject->getSectionName(SectionPimpl, Result);
 421 }
 422
 423 inline error_code SectionRef::getAddress(uint64_t &Result) const {
 424   return OwningObject->getSectionAddress(SectionPimpl, Result);
 425 }
 426
 427 inline error_code SectionRef::getSize(uint64_t &Result) const {
 428   return OwningObject->getSectionSize(SectionPimpl, Result);
 429 }
 430
 431 inline error_code SectionRef::getContents(StringRef &Result) const {
 432   return OwningObject->getSectionContents(SectionPimpl, Result);
 433 }
 434
 435 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
 436   return OwningObject->getSectionAlignment(SectionPimpl, Result);
 437 }
 438
 439 inline error_code SectionRef::isText(bool &Result) const {
 440   return OwningObject->isSectionText(SectionPimpl, Result);
 441 }
 442
 443 inline error_code SectionRef::isData(bool &Result) const {
 444   return OwningObject->isSectionData(SectionPimpl, Result);
 445 }
 446
 447 inline error_code SectionRef::isBSS(bool &Result) const {
 448   return OwningObject->isSectionBSS(SectionPimpl, Result);
 449 }
 450
 451 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
 452   return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
 453                                              Result);
 454 }
 455
 456 inline relocation_iterator SectionRef::begin_relocations() const {
 457   return OwningObject->getSectionRelBegin(SectionPimpl);
 458 }
 459
 460 inline relocation_iterator SectionRef::end_relocations() const {
 461   return OwningObject->getSectionRelEnd(SectionPimpl);
 462 }
 463
 464
 465 /// RelocationRef
 466 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
 467                               const ObjectFile *Owner)
 468   : RelocationPimpl(RelocationP)
 469   , OwningObject(Owner) {}
 470
 471 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
 472   return RelocationPimpl == Other.RelocationPimpl;
 473 }
 474
 475 inline error_code RelocationRef::getNext(RelocationRef &Result) const {
 476   return OwningObject->getRelocationNext(RelocationPimpl, Result);
 477 }
 478
 479 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
 480   return OwningObject->getRelocationAddress(RelocationPimpl, Result);
 481 }
 482
 483 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
 484   return OwningObject->getRelocationOffset(RelocationPimpl, Result);
 485 }
 486
 487 inline error_code RelocationRef::getSymbol(SymbolRef &Result) const {
 488   return OwningObject->getRelocationSymbol(RelocationPimpl, Result);
 489 }
 490
 491 inline error_code RelocationRef::getType(uint64_t &Result) const {
 492   return OwningObject->getRelocationType(RelocationPimpl, Result);
 493 }
 494
 495 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
 496   const {
 497   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
 498 }
 499
 500 inline error_code RelocationRef::getAdditionalInfo(int64_t &Result) const {
 501   return OwningObject->getRelocationAdditionalInfo(RelocationPimpl, Result);
 502 }
 503
 504 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
 505   const {
 506   return OwningObject->getRelocationValueString(RelocationPimpl, Result);
 507 }
 508
 509 inline error_code RelocationRef::getHidden(bool &Result) const {
 510   return OwningObject->getRelocationHidden(RelocationPimpl, Result);
 511 }
 512
 513 } // end namespace object
 514 } // end namespace llvm
 515
 516 #endif