include/llvm/Object/COFF.h

   1 //===- COFF.h - COFF object file implementation -----------------*- 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 the COFFObjectFile class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_COFF_H
  15 #define LLVM_OBJECT_COFF_H
  16
  17 #include "llvm/ADT/PointerUnion.h"
  18 #include "llvm/Object/ObjectFile.h"
  19 #include "llvm/Support/COFF.h"
  20 #include "llvm/Support/Endian.h"
  21 #include "llvm/Support/ErrorOr.h"
  22
  23 namespace llvm {
  24 template <typename T> class ArrayRef;
  25
  26 namespace object {
  27 class ImportDirectoryEntryRef;
  28 class ExportDirectoryEntryRef;
  29 class ImportedSymbolRef;
  30 typedef content_iterator<ImportDirectoryEntryRef> import_directory_iterator;
  31 typedef content_iterator<ExportDirectoryEntryRef> export_directory_iterator;
  32 typedef content_iterator<ImportedSymbolRef> imported_symbol_iterator;
  33
  34 /// The DOS compatible header at the front of all PE/COFF executables.
  35 struct dos_header {
  36   support::ulittle16_t Magic;
  37   support::ulittle16_t UsedBytesInTheLastPage;
  38   support::ulittle16_t FileSizeInPages;
  39   support::ulittle16_t NumberOfRelocationItems;
  40   support::ulittle16_t HeaderSizeInParagraphs;
  41   support::ulittle16_t MinimumExtraParagraphs;
  42   support::ulittle16_t MaximumExtraParagraphs;
  43   support::ulittle16_t InitialRelativeSS;
  44   support::ulittle16_t InitialSP;
  45   support::ulittle16_t Checksum;
  46   support::ulittle16_t InitialIP;
  47   support::ulittle16_t InitialRelativeCS;
  48   support::ulittle16_t AddressOfRelocationTable;
  49   support::ulittle16_t OverlayNumber;
  50   support::ulittle16_t Reserved[4];
  51   support::ulittle16_t OEMid;
  52   support::ulittle16_t OEMinfo;
  53   support::ulittle16_t Reserved2[10];
  54   support::ulittle32_t AddressOfNewExeHeader;
  55 };
  56
  57 struct coff_file_header {
  58   support::ulittle16_t Machine;
  59   support::ulittle16_t NumberOfSections;
  60   support::ulittle32_t TimeDateStamp;
  61   support::ulittle32_t PointerToSymbolTable;
  62   support::ulittle32_t NumberOfSymbols;
  63   support::ulittle16_t SizeOfOptionalHeader;
  64   support::ulittle16_t Characteristics;
  65
  66   bool isImportLibrary() const { return NumberOfSections == 0xffff; }
  67 };
  68
  69 struct coff_bigobj_file_header {
  70   support::ulittle16_t Sig1;
  71   support::ulittle16_t Sig2;
  72   support::ulittle16_t Version;
  73   support::ulittle16_t Machine;
  74   support::ulittle32_t TimeDateStamp;
  75   uint8_t              UUID[16];
  76   support::ulittle32_t unused1;
  77   support::ulittle32_t unused2;
  78   support::ulittle32_t unused3;
  79   support::ulittle32_t unused4;
  80   support::ulittle32_t NumberOfSections;
  81   support::ulittle32_t PointerToSymbolTable;
  82   support::ulittle32_t NumberOfSymbols;
  83 };
  84
  85 /// The 32-bit PE header that follows the COFF header.
  86 struct pe32_header {
  87   support::ulittle16_t Magic;
  88   uint8_t MajorLinkerVersion;
  89   uint8_t MinorLinkerVersion;
  90   support::ulittle32_t SizeOfCode;
  91   support::ulittle32_t SizeOfInitializedData;
  92   support::ulittle32_t SizeOfUninitializedData;
  93   support::ulittle32_t AddressOfEntryPoint;
  94   support::ulittle32_t BaseOfCode;
  95   support::ulittle32_t BaseOfData;
  96   support::ulittle32_t ImageBase;
  97   support::ulittle32_t SectionAlignment;
  98   support::ulittle32_t FileAlignment;
  99   support::ulittle16_t MajorOperatingSystemVersion;
 100   support::ulittle16_t MinorOperatingSystemVersion;
 101   support::ulittle16_t MajorImageVersion;
 102   support::ulittle16_t MinorImageVersion;
 103   support::ulittle16_t MajorSubsystemVersion;
 104   support::ulittle16_t MinorSubsystemVersion;
 105   support::ulittle32_t Win32VersionValue;
 106   support::ulittle32_t SizeOfImage;
 107   support::ulittle32_t SizeOfHeaders;
 108   support::ulittle32_t CheckSum;
 109   support::ulittle16_t Subsystem;
 110   support::ulittle16_t DLLCharacteristics;
 111   support::ulittle32_t SizeOfStackReserve;
 112   support::ulittle32_t SizeOfStackCommit;
 113   support::ulittle32_t SizeOfHeapReserve;
 114   support::ulittle32_t SizeOfHeapCommit;
 115   support::ulittle32_t LoaderFlags;
 116   support::ulittle32_t NumberOfRvaAndSize;
 117 };
 118
 119 /// The 64-bit PE header that follows the COFF header.
 120 struct pe32plus_header {
 121   support::ulittle16_t Magic;
 122   uint8_t MajorLinkerVersion;
 123   uint8_t MinorLinkerVersion;
 124   support::ulittle32_t SizeOfCode;
 125   support::ulittle32_t SizeOfInitializedData;
 126   support::ulittle32_t SizeOfUninitializedData;
 127   support::ulittle32_t AddressOfEntryPoint;
 128   support::ulittle32_t BaseOfCode;
 129   support::ulittle64_t ImageBase;
 130   support::ulittle32_t SectionAlignment;
 131   support::ulittle32_t FileAlignment;
 132   support::ulittle16_t MajorOperatingSystemVersion;
 133   support::ulittle16_t MinorOperatingSystemVersion;
 134   support::ulittle16_t MajorImageVersion;
 135   support::ulittle16_t MinorImageVersion;
 136   support::ulittle16_t MajorSubsystemVersion;
 137   support::ulittle16_t MinorSubsystemVersion;
 138   support::ulittle32_t Win32VersionValue;
 139   support::ulittle32_t SizeOfImage;
 140   support::ulittle32_t SizeOfHeaders;
 141   support::ulittle32_t CheckSum;
 142   support::ulittle16_t Subsystem;
 143   support::ulittle16_t DLLCharacteristics;
 144   support::ulittle64_t SizeOfStackReserve;
 145   support::ulittle64_t SizeOfStackCommit;
 146   support::ulittle64_t SizeOfHeapReserve;
 147   support::ulittle64_t SizeOfHeapCommit;
 148   support::ulittle32_t LoaderFlags;
 149   support::ulittle32_t NumberOfRvaAndSize;
 150 };
 151
 152 struct data_directory {
 153   support::ulittle32_t RelativeVirtualAddress;
 154   support::ulittle32_t Size;
 155 };
 156
 157 struct import_directory_table_entry {
 158   support::ulittle32_t ImportLookupTableRVA;
 159   support::ulittle32_t TimeDateStamp;
 160   support::ulittle32_t ForwarderChain;
 161   support::ulittle32_t NameRVA;
 162   support::ulittle32_t ImportAddressTableRVA;
 163 };
 164
 165 template <typename IntTy>
 166 struct import_lookup_table_entry {
 167   IntTy data;
 168
 169   bool isOrdinal() const { return data < 0; }
 170
 171   uint16_t getOrdinal() const {
 172     assert(isOrdinal() && "ILT entry is not an ordinal!");
 173     return data & 0xFFFF;
 174   }
 175
 176   uint32_t getHintNameRVA() const {
 177     assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
 178     return data & 0xFFFFFFFF;
 179   }
 180 };
 181
 182 typedef import_lookup_table_entry<support::little32_t>
 183     import_lookup_table_entry32;
 184 typedef import_lookup_table_entry<support::little64_t>
 185     import_lookup_table_entry64;
 186
 187 struct export_directory_table_entry {
 188   support::ulittle32_t ExportFlags;
 189   support::ulittle32_t TimeDateStamp;
 190   support::ulittle16_t MajorVersion;
 191   support::ulittle16_t MinorVersion;
 192   support::ulittle32_t NameRVA;
 193   support::ulittle32_t OrdinalBase;
 194   support::ulittle32_t AddressTableEntries;
 195   support::ulittle32_t NumberOfNamePointers;
 196   support::ulittle32_t ExportAddressTableRVA;
 197   support::ulittle32_t NamePointerRVA;
 198   support::ulittle32_t OrdinalTableRVA;
 199 };
 200
 201 union export_address_table_entry {
 202   support::ulittle32_t ExportRVA;
 203   support::ulittle32_t ForwarderRVA;
 204 };
 205
 206 typedef support::ulittle32_t export_name_pointer_table_entry;
 207 typedef support::ulittle16_t export_ordinal_table_entry;
 208
 209 struct StringTableOffset {
 210   support::ulittle32_t Zeroes;
 211   support::ulittle32_t Offset;
 212 };
 213
 214 template <typename SectionNumberType>
 215 struct coff_symbol {
 216   union {
 217     char ShortName[COFF::NameSize];
 218     StringTableOffset Offset;
 219   } Name;
 220
 221   support::ulittle32_t Value;
 222   SectionNumberType SectionNumber;
 223
 224   support::ulittle16_t Type;
 225
 226   uint8_t StorageClass;
 227   uint8_t NumberOfAuxSymbols;
 228 };
 229
 230 typedef coff_symbol<support::ulittle16_t> coff_symbol16;
 231 typedef coff_symbol<support::ulittle32_t> coff_symbol32;
 232
 233 class COFFSymbolRef {
 234 public:
 235   COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS), CS32(nullptr) {}
 236   COFFSymbolRef(const coff_symbol32 *CS) : CS16(nullptr), CS32(CS) {}
 237   COFFSymbolRef() : CS16(nullptr), CS32(nullptr) {}
 238
 239   const void *getRawPtr() const {
 240     return CS16 ? static_cast<const void *>(CS16) : CS32;
 241   }
 242
 243   friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
 244     return A.getRawPtr() < B.getRawPtr();
 245   }
 246
 247   bool isBigObj() const {
 248     if (CS16)
 249       return false;
 250     if (CS32)
 251       return true;
 252     llvm_unreachable("COFFSymbolRef points to nothing!");
 253   }
 254
 255   const char *getShortName() const {
 256     return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
 257   }
 258
 259   const StringTableOffset &getStringTableOffset() const {
 260     return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
 261   }
 262
 263   uint32_t getValue() const { return CS16 ? CS16->Value : CS32->Value; }
 264
 265   int32_t getSectionNumber() const {
 266     if (CS16) {
 267       // Reserved sections are returned as negative numbers.
 268       if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
 269         return CS16->SectionNumber;
 270       return static_cast<int16_t>(CS16->SectionNumber);
 271     }
 272     return static_cast<int32_t>(CS32->SectionNumber);
 273   }
 274
 275   uint16_t getType() const { return CS16 ? CS16->Type : CS32->Type; }
 276
 277   uint8_t getStorageClass() const {
 278     return CS16 ? CS16->StorageClass : CS32->StorageClass;
 279   }
 280
 281   uint8_t getNumberOfAuxSymbols() const {
 282     return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
 283   }
 284
 285   uint8_t getBaseType() const { return getType() & 0x0F; }
 286
 287   uint8_t getComplexType() const { return (getType() & 0xF0) >> 4; }
 288
 289   bool isFunctionDefinition() const {
 290     return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 291            getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
 292            getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
 293            !COFF::isReservedSectionNumber(getSectionNumber());
 294   }
 295
 296   bool isFunctionLineInfo() const {
 297     return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
 298   }
 299
 300   bool isWeakExternal() const {
 301     return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL ||
 302            (getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 303             getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED && getValue() == 0);
 304   }
 305
 306   bool isFileRecord() const {
 307     return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
 308   }
 309
 310   bool isSectionDefinition() const {
 311     // C++/CLI creates external ABS symbols for non-const appdomain globals.
 312     // These are also followed by an auxiliary section definition.
 313     bool isAppdomainGlobal =
 314         getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 315         getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
 316     bool isOrdinarySection =
 317         getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC && getValue() == 0;
 318     return isAppdomainGlobal || isOrdinarySection;
 319   }
 320
 321   bool isCLRToken() const {
 322     return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
 323   }
 324
 325 private:
 326   const coff_symbol16 *CS16;
 327   const coff_symbol32 *CS32;
 328 };
 329
 330 struct coff_section {
 331   char Name[COFF::NameSize];
 332   support::ulittle32_t VirtualSize;
 333   support::ulittle32_t VirtualAddress;
 334   support::ulittle32_t SizeOfRawData;
 335   support::ulittle32_t PointerToRawData;
 336   support::ulittle32_t PointerToRelocations;
 337   support::ulittle32_t PointerToLinenumbers;
 338   support::ulittle16_t NumberOfRelocations;
 339   support::ulittle16_t NumberOfLinenumbers;
 340   support::ulittle32_t Characteristics;
 341
 342   // Returns true if the actual number of relocations is stored in
 343   // VirtualAddress field of the first relocation table entry.
 344   bool hasExtendedRelocations() const {
 345     return Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL &&
 346         NumberOfRelocations == UINT16_MAX;
 347   };
 348 };
 349
 350 struct coff_relocation {
 351   support::ulittle32_t VirtualAddress;
 352   support::ulittle32_t SymbolTableIndex;
 353   support::ulittle16_t Type;
 354 };
 355
 356 struct coff_aux_function_definition {
 357   support::ulittle32_t TagIndex;
 358   support::ulittle32_t TotalSize;
 359   support::ulittle32_t PointerToLinenumber;
 360   support::ulittle32_t PointerToNextFunction;
 361 };
 362
 363 struct coff_aux_bf_and_ef_symbol {
 364   char Unused1[4];
 365   support::ulittle16_t Linenumber;
 366   char Unused2[6];
 367   support::ulittle32_t PointerToNextFunction;
 368 };
 369
 370 struct coff_aux_weak_external {
 371   support::ulittle32_t TagIndex;
 372   support::ulittle32_t Characteristics;
 373 };
 374
 375 struct coff_aux_section_definition {
 376   support::ulittle32_t Length;
 377   support::ulittle16_t NumberOfRelocations;
 378   support::ulittle16_t NumberOfLinenumbers;
 379   support::ulittle32_t CheckSum;
 380   support::ulittle16_t NumberLowPart;
 381   uint8_t              Selection;
 382   uint8_t              Unused;
 383   support::ulittle16_t NumberHighPart;
 384   int32_t getNumber(bool IsBigObj) const {
 385     uint32_t Number = static_cast<uint32_t>(NumberLowPart);
 386     if (IsBigObj)
 387       Number |= static_cast<uint32_t>(NumberHighPart) << 16;
 388     return static_cast<int32_t>(Number);
 389   }
 390 };
 391
 392 struct coff_aux_clr_token {
 393   uint8_t              AuxType;
 394   uint8_t              Reserved;
 395   support::ulittle32_t SymbolTableIndex;
 396 };
 397
 398 struct coff_load_configuration32 {
 399   support::ulittle32_t Characteristics;
 400   support::ulittle32_t TimeDateStamp;
 401   support::ulittle16_t MajorVersion;
 402   support::ulittle16_t MinorVersion;
 403   support::ulittle32_t GlobalFlagsClear;
 404   support::ulittle32_t GlobalFlagsSet;
 405   support::ulittle32_t CriticalSectionDefaultTimeout;
 406   support::ulittle32_t DeCommitFreeBlockThreshold;
 407   support::ulittle32_t DeCommitTotalFreeThreshold;
 408   support::ulittle32_t LockPrefixTable;
 409   support::ulittle32_t MaximumAllocationSize;
 410   support::ulittle32_t VirtualMemoryThreshold;
 411   support::ulittle32_t ProcessAffinityMask;
 412   support::ulittle32_t ProcessHeapFlags;
 413   support::ulittle16_t CSDVersion;
 414   support::ulittle16_t Reserved;
 415   support::ulittle32_t EditList;
 416   support::ulittle32_t SecurityCookie;
 417   support::ulittle32_t SEHandlerTable;
 418   support::ulittle32_t SEHandlerCount;
 419 };
 420
 421 struct coff_runtime_function_x64 {
 422   support::ulittle32_t BeginAddress;
 423   support::ulittle32_t EndAddress;
 424   support::ulittle32_t UnwindInformation;
 425 };
 426
 427 class COFFObjectFile : public ObjectFile {
 428 private:
 429   friend class ImportDirectoryEntryRef;
 430   friend class ExportDirectoryEntryRef;
 431   const coff_file_header *COFFHeader;
 432   const coff_bigobj_file_header *COFFBigObjHeader;
 433   const pe32_header *PE32Header;
 434   const pe32plus_header *PE32PlusHeader;
 435   const data_directory *DataDirectory;
 436   const coff_section *SectionTable;
 437   const coff_symbol16 *SymbolTable16;
 438   const coff_symbol32 *SymbolTable32;
 439   const char *StringTable;
 440   uint32_t StringTableSize;
 441   const import_directory_table_entry *ImportDirectory;
 442   uint32_t NumberOfImportDirectory;
 443   const export_directory_table_entry *ExportDirectory;
 444
 445   std::error_code getString(uint32_t offset, StringRef &Res) const;
 446
 447   template <typename coff_symbol_type>
 448   const coff_symbol_type *toSymb(DataRefImpl Symb) const;
 449   const coff_section *toSec(DataRefImpl Sec) const;
 450   const coff_relocation *toRel(DataRefImpl Rel) const;
 451
 452   std::error_code initSymbolTablePtr();
 453   std::error_code initImportTablePtr();
 454   std::error_code initExportTablePtr();
 455
 456 public:
 457   uintptr_t getSymbolTable() const {
 458     if (SymbolTable16)
 459       return reinterpret_cast<uintptr_t>(SymbolTable16);
 460     if (SymbolTable32)
 461       return reinterpret_cast<uintptr_t>(SymbolTable32);
 462     return uintptr_t(0);
 463   }
 464   uint16_t getMachine() const {
 465     if (COFFHeader)
 466       return COFFHeader->Machine;
 467     if (COFFBigObjHeader)
 468       return COFFBigObjHeader->Machine;
 469     llvm_unreachable("no COFF header!");
 470   }
 471   uint16_t getSizeOfOptionalHeader() const {
 472     if (COFFHeader)
 473       return COFFHeader->SizeOfOptionalHeader;
 474     // bigobj doesn't have this field.
 475     if (COFFBigObjHeader)
 476       return 0;
 477     llvm_unreachable("no COFF header!");
 478   }
 479   uint16_t getCharacteristics() const {
 480     if (COFFHeader)
 481       return COFFHeader->Characteristics;
 482     // bigobj doesn't have characteristics to speak of,
 483     // editbin will silently lie to you if you attempt to set any.
 484     if (COFFBigObjHeader)
 485       return 0;
 486     llvm_unreachable("no COFF header!");
 487   }
 488   uint32_t getTimeDateStamp() const {
 489     if (COFFHeader)
 490       return COFFHeader->TimeDateStamp;
 491     if (COFFBigObjHeader)
 492       return COFFBigObjHeader->TimeDateStamp;
 493     llvm_unreachable("no COFF header!");
 494   }
 495   uint32_t getNumberOfSections() const {
 496     if (COFFHeader)
 497       return COFFHeader->NumberOfSections;
 498     if (COFFBigObjHeader)
 499       return COFFBigObjHeader->NumberOfSections;
 500     llvm_unreachable("no COFF header!");
 501   }
 502   uint32_t getPointerToSymbolTable() const {
 503     if (COFFHeader)
 504       return COFFHeader->PointerToSymbolTable;
 505     if (COFFBigObjHeader)
 506       return COFFBigObjHeader->PointerToSymbolTable;
 507     llvm_unreachable("no COFF header!");
 508   }
 509   uint32_t getNumberOfSymbols() const {
 510     if (COFFHeader)
 511       return COFFHeader->NumberOfSymbols;
 512     if (COFFBigObjHeader)
 513       return COFFBigObjHeader->NumberOfSymbols;
 514     llvm_unreachable("no COFF header!");
 515   }
 516 protected:
 517   void moveSymbolNext(DataRefImpl &Symb) const override;
 518   std::error_code getSymbolName(DataRefImpl Symb,
 519                                 StringRef &Res) const override;
 520   std::error_code getSymbolAddress(DataRefImpl Symb,
 521                                    uint64_t &Res) const override;
 522   std::error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const override;
 523   uint32_t getSymbolFlags(DataRefImpl Symb) const override;
 524   std::error_code getSymbolType(DataRefImpl Symb,
 525                                 SymbolRef::Type &Res) const override;
 526   std::error_code getSymbolSection(DataRefImpl Symb,
 527                                    section_iterator &Res) const override;
 528   void moveSectionNext(DataRefImpl &Sec) const override;
 529   std::error_code getSectionName(DataRefImpl Sec,
 530                                  StringRef &Res) const override;
 531   std::error_code getSectionAddress(DataRefImpl Sec,
 532                                     uint64_t &Res) const override;
 533   std::error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const override;
 534   std::error_code getSectionContents(DataRefImpl Sec,
 535                                      StringRef &Res) const override;
 536   std::error_code getSectionAlignment(DataRefImpl Sec,
 537                                       uint64_t &Res) const override;
 538   std::error_code isSectionText(DataRefImpl Sec, bool &Res) const override;
 539   std::error_code isSectionData(DataRefImpl Sec, bool &Res) const override;
 540   std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const override;
 541   std::error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const override;
 542   std::error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const override;
 543   std::error_code isSectionReadOnlyData(DataRefImpl Sec,
 544                                         bool &Res) const override;
 545   std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
 546                                                 bool &Res) const override;
 547   std::error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
 548                                         bool &Result) const override;
 549   relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
 550   relocation_iterator section_rel_end(DataRefImpl Sec) const override;
 551
 552   void moveRelocationNext(DataRefImpl &Rel) const override;
 553   std::error_code getRelocationAddress(DataRefImpl Rel,
 554                                        uint64_t &Res) const override;
 555   std::error_code getRelocationOffset(DataRefImpl Rel,
 556                                       uint64_t &Res) const override;
 557   symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
 558   std::error_code getRelocationType(DataRefImpl Rel,
 559                                     uint64_t &Res) const override;
 560   std::error_code
 561   getRelocationTypeName(DataRefImpl Rel,
 562                         SmallVectorImpl<char> &Result) const override;
 563   std::error_code
 564   getRelocationValueString(DataRefImpl Rel,
 565                            SmallVectorImpl<char> &Result) const override;
 566
 567 public:
 568   COFFObjectFile(MemoryBufferRef Object, std::error_code &EC);
 569   basic_symbol_iterator symbol_begin_impl() const override;
 570   basic_symbol_iterator symbol_end_impl() const override;
 571   section_iterator section_begin() const override;
 572   section_iterator section_end() const override;
 573
 574   const coff_section *getCOFFSection(const SectionRef &Section) const;
 575   COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
 576   COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
 577   const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
 578
 579   uint8_t getBytesInAddress() const override;
 580   StringRef getFileFormatName() const override;
 581   unsigned getArch() const override;
 582
 583   import_directory_iterator import_directory_begin() const;
 584   import_directory_iterator import_directory_end() const;
 585   export_directory_iterator export_directory_begin() const;
 586   export_directory_iterator export_directory_end() const;
 587
 588   std::error_code getPE32Header(const pe32_header *&Res) const;
 589   std::error_code getPE32PlusHeader(const pe32plus_header *&Res) const;
 590   std::error_code getDataDirectory(uint32_t index,
 591                                    const data_directory *&Res) const;
 592   std::error_code getSection(int32_t index, const coff_section *&Res) const;
 593   template <typename coff_symbol_type>
 594   std::error_code getSymbol(uint32_t Index,
 595                             const coff_symbol_type *&Res) const {
 596     if (Index >= getNumberOfSymbols())
 597       return object_error::parse_failed;
 598
 599     Res = reinterpret_cast<coff_symbol_type *>(getSymbolTable()) + Index;
 600     return object_error::success;
 601   }
 602   ErrorOr<COFFSymbolRef> getSymbol(uint32_t index) const {
 603     if (SymbolTable16) {
 604       const coff_symbol16 *Symb = nullptr;
 605       if (std::error_code EC = getSymbol(index, Symb))
 606         return EC;
 607       return COFFSymbolRef(Symb);
 608     }
 609     if (SymbolTable32) {
 610       const coff_symbol32 *Symb = nullptr;
 611       if (std::error_code EC = getSymbol(index, Symb))
 612         return EC;
 613       return COFFSymbolRef(Symb);
 614     }
 615     llvm_unreachable("no symbol table pointer!");
 616   }
 617   template <typename T>
 618   std::error_code getAuxSymbol(uint32_t index, const T *&Res) const {
 619     ErrorOr<COFFSymbolRef> s = getSymbol(index);
 620     if (std::error_code EC = s.getError())
 621       return EC;
 622     Res = reinterpret_cast<const T *>(s->getRawPtr());
 623     return object_error::success;
 624   }
 625   std::error_code getSymbolName(COFFSymbolRef Symbol, StringRef &Res) const;
 626
 627   ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
 628
 629   size_t getSymbolTableEntrySize() const {
 630     if (COFFHeader)
 631       return sizeof(coff_symbol16);
 632     if (COFFBigObjHeader)
 633       return sizeof(coff_symbol32);
 634     llvm_unreachable("null symbol table pointer!");
 635   }
 636
 637   std::error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
 638   std::error_code getSectionContents(const coff_section *Sec,
 639                                      ArrayRef<uint8_t> &Res) const;
 640
 641   std::error_code getVaPtr(uint64_t VA, uintptr_t &Res) const;
 642   std::error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
 643   std::error_code getHintName(uint32_t Rva, uint16_t &Hint,
 644                               StringRef &Name) const;
 645
 646   bool isRelocatableObject() const override;
 647
 648   static inline bool classof(const Binary *v) { return v->isCOFF(); }
 649 };
 650
 651 // The iterator for the import directory table.
 652 class ImportDirectoryEntryRef {
 653 public:
 654   ImportDirectoryEntryRef() : OwningObject(nullptr) {}
 655   ImportDirectoryEntryRef(const import_directory_table_entry *Table, uint32_t I,
 656                           const COFFObjectFile *Owner)
 657       : ImportTable(Table), Index(I), OwningObject(Owner) {}
 658
 659   bool operator==(const ImportDirectoryEntryRef &Other) const;
 660   void moveNext();
 661
 662   imported_symbol_iterator imported_symbol_begin() const;
 663   imported_symbol_iterator imported_symbol_end() const;
 664
 665   std::error_code getName(StringRef &Result) const;
 666   std::error_code getImportLookupTableRVA(uint32_t &Result) const;
 667   std::error_code getImportAddressTableRVA(uint32_t &Result) const;
 668
 669   std::error_code
 670   getImportTableEntry(const import_directory_table_entry *&Result) const;
 671
 672   std::error_code
 673   getImportLookupEntry(const import_lookup_table_entry32 *&Result) const;
 674
 675 private:
 676   const import_directory_table_entry *ImportTable;
 677   uint32_t Index;
 678   const COFFObjectFile *OwningObject;
 679 };
 680
 681 // The iterator for the export directory table entry.
 682 class ExportDirectoryEntryRef {
 683 public:
 684   ExportDirectoryEntryRef() : OwningObject(nullptr) {}
 685   ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
 686                           const COFFObjectFile *Owner)
 687       : ExportTable(Table), Index(I), OwningObject(Owner) {}
 688
 689   bool operator==(const ExportDirectoryEntryRef &Other) const;
 690   void moveNext();
 691
 692   std::error_code getDllName(StringRef &Result) const;
 693   std::error_code getOrdinalBase(uint32_t &Result) const;
 694   std::error_code getOrdinal(uint32_t &Result) const;
 695   std::error_code getExportRVA(uint32_t &Result) const;
 696   std::error_code getSymbolName(StringRef &Result) const;
 697
 698 private:
 699   const export_directory_table_entry *ExportTable;
 700   uint32_t Index;
 701   const COFFObjectFile *OwningObject;
 702 };
 703
 704 class ImportedSymbolRef {
 705 public:
 706   ImportedSymbolRef() : OwningObject(nullptr) {}
 707   ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
 708                     const COFFObjectFile *Owner)
 709       : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
 710   ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
 711                     const COFFObjectFile *Owner)
 712       : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
 713
 714   bool operator==(const ImportedSymbolRef &Other) const;
 715   void moveNext();
 716
 717   std::error_code getSymbolName(StringRef &Result) const;
 718   std::error_code getOrdinal(uint16_t &Result) const;
 719
 720 private:
 721   const import_lookup_table_entry32 *Entry32;
 722   const import_lookup_table_entry64 *Entry64;
 723   uint32_t Index;
 724   const COFFObjectFile *OwningObject;
 725 };
 726 } // end namespace object
 727 } // end namespace llvm
 728
 729 #endif