contrib/llvm/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/iterator_range.h"
  18 #include "llvm/BinaryFormat/COFF.h"
  19 #include "llvm/MC/SubtargetFeature.h"
  20 #include "llvm/Object/Binary.h"
  21 #include "llvm/Object/CVDebugRecord.h"
  22 #include "llvm/Object/Error.h"
  23 #include "llvm/Object/ObjectFile.h"
  24 #include "llvm/Support/BinaryByteStream.h"
  25 #include "llvm/Support/ConvertUTF.h"
  26 #include "llvm/Support/Endian.h"
  27 #include "llvm/Support/ErrorHandling.h"
  28 #include <cassert>
  29 #include <cstddef>
  30 #include <cstdint>
  31 #include <system_error>
  32
  33 namespace llvm {
  34
  35 template <typename T> class ArrayRef;
  36
  37 namespace object {
  38
  39 class BaseRelocRef;
  40 class DelayImportDirectoryEntryRef;
  41 class ExportDirectoryEntryRef;
  42 class ImportDirectoryEntryRef;
  43 class ImportedSymbolRef;
  44 class ResourceSectionRef;
  45
  46 using import_directory_iterator = content_iterator<ImportDirectoryEntryRef>;
  47 using delay_import_directory_iterator =
  48     content_iterator<DelayImportDirectoryEntryRef>;
  49 using export_directory_iterator = content_iterator<ExportDirectoryEntryRef>;
  50 using imported_symbol_iterator = content_iterator<ImportedSymbolRef>;
  51 using base_reloc_iterator = content_iterator<BaseRelocRef>;
  52
  53 /// The DOS compatible header at the front of all PE/COFF executables.
  54 struct dos_header {
  55   char                 Magic[2];
  56   support::ulittle16_t UsedBytesInTheLastPage;
  57   support::ulittle16_t FileSizeInPages;
  58   support::ulittle16_t NumberOfRelocationItems;
  59   support::ulittle16_t HeaderSizeInParagraphs;
  60   support::ulittle16_t MinimumExtraParagraphs;
  61   support::ulittle16_t MaximumExtraParagraphs;
  62   support::ulittle16_t InitialRelativeSS;
  63   support::ulittle16_t InitialSP;
  64   support::ulittle16_t Checksum;
  65   support::ulittle16_t InitialIP;
  66   support::ulittle16_t InitialRelativeCS;
  67   support::ulittle16_t AddressOfRelocationTable;
  68   support::ulittle16_t OverlayNumber;
  69   support::ulittle16_t Reserved[4];
  70   support::ulittle16_t OEMid;
  71   support::ulittle16_t OEMinfo;
  72   support::ulittle16_t Reserved2[10];
  73   support::ulittle32_t AddressOfNewExeHeader;
  74 };
  75
  76 struct coff_file_header {
  77   support::ulittle16_t Machine;
  78   support::ulittle16_t NumberOfSections;
  79   support::ulittle32_t TimeDateStamp;
  80   support::ulittle32_t PointerToSymbolTable;
  81   support::ulittle32_t NumberOfSymbols;
  82   support::ulittle16_t SizeOfOptionalHeader;
  83   support::ulittle16_t Characteristics;
  84
  85   bool isImportLibrary() const { return NumberOfSections == 0xffff; }
  86 };
  87
  88 struct coff_bigobj_file_header {
  89   support::ulittle16_t Sig1;
  90   support::ulittle16_t Sig2;
  91   support::ulittle16_t Version;
  92   support::ulittle16_t Machine;
  93   support::ulittle32_t TimeDateStamp;
  94   uint8_t              UUID[16];
  95   support::ulittle32_t unused1;
  96   support::ulittle32_t unused2;
  97   support::ulittle32_t unused3;
  98   support::ulittle32_t unused4;
  99   support::ulittle32_t NumberOfSections;
 100   support::ulittle32_t PointerToSymbolTable;
 101   support::ulittle32_t NumberOfSymbols;
 102 };
 103
 104 /// The 32-bit PE header that follows the COFF header.
 105 struct pe32_header {
 106   support::ulittle16_t Magic;
 107   uint8_t MajorLinkerVersion;
 108   uint8_t MinorLinkerVersion;
 109   support::ulittle32_t SizeOfCode;
 110   support::ulittle32_t SizeOfInitializedData;
 111   support::ulittle32_t SizeOfUninitializedData;
 112   support::ulittle32_t AddressOfEntryPoint;
 113   support::ulittle32_t BaseOfCode;
 114   support::ulittle32_t BaseOfData;
 115   support::ulittle32_t ImageBase;
 116   support::ulittle32_t SectionAlignment;
 117   support::ulittle32_t FileAlignment;
 118   support::ulittle16_t MajorOperatingSystemVersion;
 119   support::ulittle16_t MinorOperatingSystemVersion;
 120   support::ulittle16_t MajorImageVersion;
 121   support::ulittle16_t MinorImageVersion;
 122   support::ulittle16_t MajorSubsystemVersion;
 123   support::ulittle16_t MinorSubsystemVersion;
 124   support::ulittle32_t Win32VersionValue;
 125   support::ulittle32_t SizeOfImage;
 126   support::ulittle32_t SizeOfHeaders;
 127   support::ulittle32_t CheckSum;
 128   support::ulittle16_t Subsystem;
 129   // FIXME: This should be DllCharacteristics.
 130   support::ulittle16_t DLLCharacteristics;
 131   support::ulittle32_t SizeOfStackReserve;
 132   support::ulittle32_t SizeOfStackCommit;
 133   support::ulittle32_t SizeOfHeapReserve;
 134   support::ulittle32_t SizeOfHeapCommit;
 135   support::ulittle32_t LoaderFlags;
 136   // FIXME: This should be NumberOfRvaAndSizes.
 137   support::ulittle32_t NumberOfRvaAndSize;
 138 };
 139
 140 /// The 64-bit PE header that follows the COFF header.
 141 struct pe32plus_header {
 142   support::ulittle16_t Magic;
 143   uint8_t MajorLinkerVersion;
 144   uint8_t MinorLinkerVersion;
 145   support::ulittle32_t SizeOfCode;
 146   support::ulittle32_t SizeOfInitializedData;
 147   support::ulittle32_t SizeOfUninitializedData;
 148   support::ulittle32_t AddressOfEntryPoint;
 149   support::ulittle32_t BaseOfCode;
 150   support::ulittle64_t ImageBase;
 151   support::ulittle32_t SectionAlignment;
 152   support::ulittle32_t FileAlignment;
 153   support::ulittle16_t MajorOperatingSystemVersion;
 154   support::ulittle16_t MinorOperatingSystemVersion;
 155   support::ulittle16_t MajorImageVersion;
 156   support::ulittle16_t MinorImageVersion;
 157   support::ulittle16_t MajorSubsystemVersion;
 158   support::ulittle16_t MinorSubsystemVersion;
 159   support::ulittle32_t Win32VersionValue;
 160   support::ulittle32_t SizeOfImage;
 161   support::ulittle32_t SizeOfHeaders;
 162   support::ulittle32_t CheckSum;
 163   support::ulittle16_t Subsystem;
 164   support::ulittle16_t DLLCharacteristics;
 165   support::ulittle64_t SizeOfStackReserve;
 166   support::ulittle64_t SizeOfStackCommit;
 167   support::ulittle64_t SizeOfHeapReserve;
 168   support::ulittle64_t SizeOfHeapCommit;
 169   support::ulittle32_t LoaderFlags;
 170   support::ulittle32_t NumberOfRvaAndSize;
 171 };
 172
 173 struct data_directory {
 174   support::ulittle32_t RelativeVirtualAddress;
 175   support::ulittle32_t Size;
 176 };
 177
 178 struct debug_directory {
 179   support::ulittle32_t Characteristics;
 180   support::ulittle32_t TimeDateStamp;
 181   support::ulittle16_t MajorVersion;
 182   support::ulittle16_t MinorVersion;
 183   support::ulittle32_t Type;
 184   support::ulittle32_t SizeOfData;
 185   support::ulittle32_t AddressOfRawData;
 186   support::ulittle32_t PointerToRawData;
 187 };
 188
 189 template <typename IntTy>
 190 struct import_lookup_table_entry {
 191   IntTy Data;
 192
 193   bool isOrdinal() const { return Data < 0; }
 194
 195   uint16_t getOrdinal() const {
 196     assert(isOrdinal() && "ILT entry is not an ordinal!");
 197     return Data & 0xFFFF;
 198   }
 199
 200   uint32_t getHintNameRVA() const {
 201     assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
 202     return Data & 0xFFFFFFFF;
 203   }
 204 };
 205
 206 using import_lookup_table_entry32 =
 207     import_lookup_table_entry<support::little32_t>;
 208 using import_lookup_table_entry64 =
 209     import_lookup_table_entry<support::little64_t>;
 210
 211 struct delay_import_directory_table_entry {
 212   // dumpbin reports this field as "Characteristics" instead of "Attributes".
 213   support::ulittle32_t Attributes;
 214   support::ulittle32_t Name;
 215   support::ulittle32_t ModuleHandle;
 216   support::ulittle32_t DelayImportAddressTable;
 217   support::ulittle32_t DelayImportNameTable;
 218   support::ulittle32_t BoundDelayImportTable;
 219   support::ulittle32_t UnloadDelayImportTable;
 220   support::ulittle32_t TimeStamp;
 221 };
 222
 223 struct export_directory_table_entry {
 224   support::ulittle32_t ExportFlags;
 225   support::ulittle32_t TimeDateStamp;
 226   support::ulittle16_t MajorVersion;
 227   support::ulittle16_t MinorVersion;
 228   support::ulittle32_t NameRVA;
 229   support::ulittle32_t OrdinalBase;
 230   support::ulittle32_t AddressTableEntries;
 231   support::ulittle32_t NumberOfNamePointers;
 232   support::ulittle32_t ExportAddressTableRVA;
 233   support::ulittle32_t NamePointerRVA;
 234   support::ulittle32_t OrdinalTableRVA;
 235 };
 236
 237 union export_address_table_entry {
 238   support::ulittle32_t ExportRVA;
 239   support::ulittle32_t ForwarderRVA;
 240 };
 241
 242 using export_name_pointer_table_entry = support::ulittle32_t;
 243 using export_ordinal_table_entry = support::ulittle16_t;
 244
 245 struct StringTableOffset {
 246   support::ulittle32_t Zeroes;
 247   support::ulittle32_t Offset;
 248 };
 249
 250 template <typename SectionNumberType>
 251 struct coff_symbol {
 252   union {
 253     char ShortName[COFF::NameSize];
 254     StringTableOffset Offset;
 255   } Name;
 256
 257   support::ulittle32_t Value;
 258   SectionNumberType SectionNumber;
 259
 260   support::ulittle16_t Type;
 261
 262   uint8_t StorageClass;
 263   uint8_t NumberOfAuxSymbols;
 264 };
 265
 266 using coff_symbol16 = coff_symbol<support::ulittle16_t>;
 267 using coff_symbol32 = coff_symbol<support::ulittle32_t>;
 268
 269 // Contains only common parts of coff_symbol16 and coff_symbol32.
 270 struct coff_symbol_generic {
 271   union {
 272     char ShortName[COFF::NameSize];
 273     StringTableOffset Offset;
 274   } Name;
 275   support::ulittle32_t Value;
 276 };
 277
 278 struct coff_aux_section_definition;
 279 struct coff_aux_weak_external;
 280
 281 class COFFSymbolRef {
 282 public:
 283   COFFSymbolRef() = default;
 284   COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS) {}
 285   COFFSymbolRef(const coff_symbol32 *CS) : CS32(CS) {}
 286
 287   const void *getRawPtr() const {
 288     return CS16 ? static_cast<const void *>(CS16) : CS32;
 289   }
 290
 291   const coff_symbol_generic *getGeneric() const {
 292     if (CS16)
 293       return reinterpret_cast<const coff_symbol_generic *>(CS16);
 294     return reinterpret_cast<const coff_symbol_generic *>(CS32);
 295   }
 296
 297   friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
 298     return A.getRawPtr() < B.getRawPtr();
 299   }
 300
 301   bool isBigObj() const {
 302     if (CS16)
 303       return false;
 304     if (CS32)
 305       return true;
 306     llvm_unreachable("COFFSymbolRef points to nothing!");
 307   }
 308
 309   const char *getShortName() const {
 310     return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
 311   }
 312
 313   const StringTableOffset &getStringTableOffset() const {
 314     assert(isSet() && "COFFSymbolRef points to nothing!");
 315     return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
 316   }
 317
 318   uint32_t getValue() const { return CS16 ? CS16->Value : CS32->Value; }
 319
 320   int32_t getSectionNumber() const {
 321     assert(isSet() && "COFFSymbolRef points to nothing!");
 322     if (CS16) {
 323       // Reserved sections are returned as negative numbers.
 324       if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
 325         return CS16->SectionNumber;
 326       return static_cast<int16_t>(CS16->SectionNumber);
 327     }
 328     return static_cast<int32_t>(CS32->SectionNumber);
 329   }
 330
 331   uint16_t getType() const {
 332     assert(isSet() && "COFFSymbolRef points to nothing!");
 333     return CS16 ? CS16->Type : CS32->Type;
 334   }
 335
 336   uint8_t getStorageClass() const {
 337     assert(isSet() && "COFFSymbolRef points to nothing!");
 338     return CS16 ? CS16->StorageClass : CS32->StorageClass;
 339   }
 340
 341   uint8_t getNumberOfAuxSymbols() const {
 342     assert(isSet() && "COFFSymbolRef points to nothing!");
 343     return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
 344   }
 345
 346   uint8_t getBaseType() const { return getType() & 0x0F; }
 347
 348   uint8_t getComplexType() const {
 349     return (getType() & 0xF0) >> COFF::SCT_COMPLEX_TYPE_SHIFT;
 350   }
 351
 352   template <typename T> const T *getAux() const {
 353     return CS16 ? reinterpret_cast<const T *>(CS16 + 1)
 354                 : reinterpret_cast<const T *>(CS32 + 1);
 355   }
 356
 357   const coff_aux_section_definition *getSectionDefinition() const {
 358     if (!getNumberOfAuxSymbols() ||
 359         getStorageClass() != COFF::IMAGE_SYM_CLASS_STATIC)
 360       return nullptr;
 361     return getAux<coff_aux_section_definition>();
 362   }
 363
 364   const coff_aux_weak_external *getWeakExternal() const {
 365     if (!getNumberOfAuxSymbols() ||
 366         getStorageClass() != COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
 367       return nullptr;
 368     return getAux<coff_aux_weak_external>();
 369   }
 370
 371   bool isAbsolute() const {
 372     return getSectionNumber() == -1;
 373   }
 374
 375   bool isExternal() const {
 376     return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL;
 377   }
 378
 379   bool isCommon() const {
 380     return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
 381            getValue() != 0;
 382   }
 383
 384   bool isUndefined() const {
 385     return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
 386            getValue() == 0;
 387   }
 388
 389   bool isWeakExternal() const {
 390     return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
 391   }
 392
 393   bool isFunctionDefinition() const {
 394     return isExternal() && getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
 395            getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
 396            !COFF::isReservedSectionNumber(getSectionNumber());
 397   }
 398
 399   bool isFunctionLineInfo() const {
 400     return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
 401   }
 402
 403   bool isAnyUndefined() const {
 404     return isUndefined() || isWeakExternal();
 405   }
 406
 407   bool isFileRecord() const {
 408     return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
 409   }
 410
 411   bool isSection() const {
 412     return getStorageClass() == COFF::IMAGE_SYM_CLASS_SECTION;
 413   }
 414
 415   bool isSectionDefinition() const {
 416     // C++/CLI creates external ABS symbols for non-const appdomain globals.
 417     // These are also followed by an auxiliary section definition.
 418     bool isAppdomainGlobal =
 419         getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
 420         getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
 421     bool isOrdinarySection = getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC;
 422     if (!getNumberOfAuxSymbols())
 423       return false;
 424     return isAppdomainGlobal || isOrdinarySection;
 425   }
 426
 427   bool isCLRToken() const {
 428     return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
 429   }
 430
 431 private:
 432   bool isSet() const { return CS16 || CS32; }
 433
 434   const coff_symbol16 *CS16 = nullptr;
 435   const coff_symbol32 *CS32 = nullptr;
 436 };
 437
 438 struct coff_section {
 439   char Name[COFF::NameSize];
 440   support::ulittle32_t VirtualSize;
 441   support::ulittle32_t VirtualAddress;
 442   support::ulittle32_t SizeOfRawData;
 443   support::ulittle32_t PointerToRawData;
 444   support::ulittle32_t PointerToRelocations;
 445   support::ulittle32_t PointerToLinenumbers;
 446   support::ulittle16_t NumberOfRelocations;
 447   support::ulittle16_t NumberOfLinenumbers;
 448   support::ulittle32_t Characteristics;
 449
 450   // Returns true if the actual number of relocations is stored in
 451   // VirtualAddress field of the first relocation table entry.
 452   bool hasExtendedRelocations() const {
 453     return (Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL) &&
 454            NumberOfRelocations == UINT16_MAX;
 455   }
 456
 457   uint32_t getAlignment() const {
 458     // The IMAGE_SCN_TYPE_NO_PAD bit is a legacy way of getting to
 459     // IMAGE_SCN_ALIGN_1BYTES.
 460     if (Characteristics & COFF::IMAGE_SCN_TYPE_NO_PAD)
 461       return 1;
 462
 463     // Bit [20:24] contains section alignment. 0 means use a default alignment
 464     // of 16.
 465     uint32_t Shift = (Characteristics >> 20) & 0xF;
 466     if (Shift > 0)
 467       return 1U << (Shift - 1);
 468     return 16;
 469   }
 470 };
 471
 472 struct coff_relocation {
 473   support::ulittle32_t VirtualAddress;
 474   support::ulittle32_t SymbolTableIndex;
 475   support::ulittle16_t Type;
 476 };
 477
 478 struct coff_aux_function_definition {
 479   support::ulittle32_t TagIndex;
 480   support::ulittle32_t TotalSize;
 481   support::ulittle32_t PointerToLinenumber;
 482   support::ulittle32_t PointerToNextFunction;
 483   char Unused1[2];
 484 };
 485
 486 static_assert(sizeof(coff_aux_function_definition) == 18,
 487               "auxiliary entry must be 18 bytes");
 488
 489 struct coff_aux_bf_and_ef_symbol {
 490   char Unused1[4];
 491   support::ulittle16_t Linenumber;
 492   char Unused2[6];
 493   support::ulittle32_t PointerToNextFunction;
 494   char Unused3[2];
 495 };
 496
 497 static_assert(sizeof(coff_aux_bf_and_ef_symbol) == 18,
 498               "auxiliary entry must be 18 bytes");
 499
 500 struct coff_aux_weak_external {
 501   support::ulittle32_t TagIndex;
 502   support::ulittle32_t Characteristics;
 503   char Unused1[10];
 504 };
 505
 506 static_assert(sizeof(coff_aux_weak_external) == 18,
 507               "auxiliary entry must be 18 bytes");
 508
 509 struct coff_aux_section_definition {
 510   support::ulittle32_t Length;
 511   support::ulittle16_t NumberOfRelocations;
 512   support::ulittle16_t NumberOfLinenumbers;
 513   support::ulittle32_t CheckSum;
 514   support::ulittle16_t NumberLowPart;
 515   uint8_t              Selection;
 516   uint8_t              Unused;
 517   support::ulittle16_t NumberHighPart;
 518   int32_t getNumber(bool IsBigObj) const {
 519     uint32_t Number = static_cast<uint32_t>(NumberLowPart);
 520     if (IsBigObj)
 521       Number |= static_cast<uint32_t>(NumberHighPart) << 16;
 522     return static_cast<int32_t>(Number);
 523   }
 524 };
 525
 526 static_assert(sizeof(coff_aux_section_definition) == 18,
 527               "auxiliary entry must be 18 bytes");
 528
 529 struct coff_aux_clr_token {
 530   uint8_t              AuxType;
 531   uint8_t              Reserved;
 532   support::ulittle32_t SymbolTableIndex;
 533   char                 MBZ[12];
 534 };
 535
 536 static_assert(sizeof(coff_aux_clr_token) == 18,
 537               "auxiliary entry must be 18 bytes");
 538
 539 struct coff_import_header {
 540   support::ulittle16_t Sig1;
 541   support::ulittle16_t Sig2;
 542   support::ulittle16_t Version;
 543   support::ulittle16_t Machine;
 544   support::ulittle32_t TimeDateStamp;
 545   support::ulittle32_t SizeOfData;
 546   support::ulittle16_t OrdinalHint;
 547   support::ulittle16_t TypeInfo;
 548
 549   int getType() const { return TypeInfo & 0x3; }
 550   int getNameType() const { return (TypeInfo >> 2) & 0x7; }
 551 };
 552
 553 struct coff_import_directory_table_entry {
 554   support::ulittle32_t ImportLookupTableRVA;
 555   support::ulittle32_t TimeDateStamp;
 556   support::ulittle32_t ForwarderChain;
 557   support::ulittle32_t NameRVA;
 558   support::ulittle32_t ImportAddressTableRVA;
 559
 560   bool isNull() const {
 561     return ImportLookupTableRVA == 0 && TimeDateStamp == 0 &&
 562            ForwarderChain == 0 && NameRVA == 0 && ImportAddressTableRVA == 0;
 563   }
 564 };
 565
 566 template <typename IntTy>
 567 struct coff_tls_directory {
 568   IntTy StartAddressOfRawData;
 569   IntTy EndAddressOfRawData;
 570   IntTy AddressOfIndex;
 571   IntTy AddressOfCallBacks;
 572   support::ulittle32_t SizeOfZeroFill;
 573   support::ulittle32_t Characteristics;
 574
 575   uint32_t getAlignment() const {
 576     // Bit [20:24] contains section alignment.
 577     uint32_t Shift = (Characteristics & 0x00F00000) >> 20;
 578     if (Shift > 0)
 579       return 1U << (Shift - 1);
 580     return 0;
 581   }
 582 };
 583
 584 using coff_tls_directory32 = coff_tls_directory<support::little32_t>;
 585 using coff_tls_directory64 = coff_tls_directory<support::little64_t>;
 586
 587 /// Bits in control flow guard flags as we understand them.
 588 enum class coff_guard_flags : uint32_t {
 589   CFInstrumented = 0x00000100,
 590   HasFidTable = 0x00000400,
 591   ProtectDelayLoadIAT = 0x00001000,
 592   DelayLoadIATSection = 0x00002000, // Delay load in separate section
 593   HasLongJmpTable = 0x00010000,
 594   FidTableHasFlags = 0x10000000, // Indicates that fid tables are 5 bytes
 595 };
 596
 597 struct coff_load_config_code_integrity {
 598   support::ulittle16_t Flags;
 599   support::ulittle16_t Catalog;
 600   support::ulittle32_t CatalogOffset;
 601   support::ulittle32_t Reserved;
 602 };
 603
 604 /// 32-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY32)
 605 struct coff_load_configuration32 {
 606   support::ulittle32_t Size;
 607   support::ulittle32_t TimeDateStamp;
 608   support::ulittle16_t MajorVersion;
 609   support::ulittle16_t MinorVersion;
 610   support::ulittle32_t GlobalFlagsClear;
 611   support::ulittle32_t GlobalFlagsSet;
 612   support::ulittle32_t CriticalSectionDefaultTimeout;
 613   support::ulittle32_t DeCommitFreeBlockThreshold;
 614   support::ulittle32_t DeCommitTotalFreeThreshold;
 615   support::ulittle32_t LockPrefixTable;
 616   support::ulittle32_t MaximumAllocationSize;
 617   support::ulittle32_t VirtualMemoryThreshold;
 618   support::ulittle32_t ProcessAffinityMask;
 619   support::ulittle32_t ProcessHeapFlags;
 620   support::ulittle16_t CSDVersion;
 621   support::ulittle16_t DependentLoadFlags;
 622   support::ulittle32_t EditList;
 623   support::ulittle32_t SecurityCookie;
 624   support::ulittle32_t SEHandlerTable;
 625   support::ulittle32_t SEHandlerCount;
 626
 627   // Added in MSVC 2015 for /guard:cf.
 628   support::ulittle32_t GuardCFCheckFunction;
 629   support::ulittle32_t GuardCFCheckDispatch;
 630   support::ulittle32_t GuardCFFunctionTable;
 631   support::ulittle32_t GuardCFFunctionCount;
 632   support::ulittle32_t GuardFlags; // coff_guard_flags
 633
 634   // Added in MSVC 2017
 635   coff_load_config_code_integrity CodeIntegrity;
 636   support::ulittle32_t GuardAddressTakenIatEntryTable;
 637   support::ulittle32_t GuardAddressTakenIatEntryCount;
 638   support::ulittle32_t GuardLongJumpTargetTable;
 639   support::ulittle32_t GuardLongJumpTargetCount;
 640   support::ulittle32_t DynamicValueRelocTable;
 641   support::ulittle32_t CHPEMetadataPointer;
 642   support::ulittle32_t GuardRFFailureRoutine;
 643   support::ulittle32_t GuardRFFailureRoutineFunctionPointer;
 644   support::ulittle32_t DynamicValueRelocTableOffset;
 645   support::ulittle16_t DynamicValueRelocTableSection;
 646   support::ulittle16_t Reserved2;
 647   support::ulittle32_t GuardRFVerifyStackPointerFunctionPointer;
 648   support::ulittle32_t HotPatchTableOffset;
 649 };
 650
 651 /// 64-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY64)
 652 struct coff_load_configuration64 {
 653   support::ulittle32_t Size;
 654   support::ulittle32_t TimeDateStamp;
 655   support::ulittle16_t MajorVersion;
 656   support::ulittle16_t MinorVersion;
 657   support::ulittle32_t GlobalFlagsClear;
 658   support::ulittle32_t GlobalFlagsSet;
 659   support::ulittle32_t CriticalSectionDefaultTimeout;
 660   support::ulittle64_t DeCommitFreeBlockThreshold;
 661   support::ulittle64_t DeCommitTotalFreeThreshold;
 662   support::ulittle64_t LockPrefixTable;
 663   support::ulittle64_t MaximumAllocationSize;
 664   support::ulittle64_t VirtualMemoryThreshold;
 665   support::ulittle64_t ProcessAffinityMask;
 666   support::ulittle32_t ProcessHeapFlags;
 667   support::ulittle16_t CSDVersion;
 668   support::ulittle16_t DependentLoadFlags;
 669   support::ulittle64_t EditList;
 670   support::ulittle64_t SecurityCookie;
 671   support::ulittle64_t SEHandlerTable;
 672   support::ulittle64_t SEHandlerCount;
 673
 674   // Added in MSVC 2015 for /guard:cf.
 675   support::ulittle64_t GuardCFCheckFunction;
 676   support::ulittle64_t GuardCFCheckDispatch;
 677   support::ulittle64_t GuardCFFunctionTable;
 678   support::ulittle64_t GuardCFFunctionCount;
 679   support::ulittle32_t GuardFlags;
 680
 681   // Added in MSVC 2017
 682   coff_load_config_code_integrity CodeIntegrity;
 683   support::ulittle64_t GuardAddressTakenIatEntryTable;
 684   support::ulittle64_t GuardAddressTakenIatEntryCount;
 685   support::ulittle64_t GuardLongJumpTargetTable;
 686   support::ulittle64_t GuardLongJumpTargetCount;
 687   support::ulittle64_t DynamicValueRelocTable;
 688   support::ulittle64_t CHPEMetadataPointer;
 689   support::ulittle64_t GuardRFFailureRoutine;
 690   support::ulittle64_t GuardRFFailureRoutineFunctionPointer;
 691   support::ulittle32_t DynamicValueRelocTableOffset;
 692   support::ulittle16_t DynamicValueRelocTableSection;
 693   support::ulittle16_t Reserved2;
 694   support::ulittle64_t GuardRFVerifyStackPointerFunctionPointer;
 695   support::ulittle32_t HotPatchTableOffset;
 696 };
 697
 698 struct coff_runtime_function_x64 {
 699   support::ulittle32_t BeginAddress;
 700   support::ulittle32_t EndAddress;
 701   support::ulittle32_t UnwindInformation;
 702 };
 703
 704 struct coff_base_reloc_block_header {
 705   support::ulittle32_t PageRVA;
 706   support::ulittle32_t BlockSize;
 707 };
 708
 709 struct coff_base_reloc_block_entry {
 710   support::ulittle16_t Data;
 711
 712   int getType() const { return Data >> 12; }
 713   int getOffset() const { return Data & ((1 << 12) - 1); }
 714 };
 715
 716 struct coff_resource_dir_entry {
 717   union {
 718     support::ulittle32_t NameOffset;
 719     support::ulittle32_t ID;
 720     uint32_t getNameOffset() const {
 721       return maskTrailingOnes<uint32_t>(31) & NameOffset;
 722     }
 723     // Even though the PE/COFF spec doesn't mention this, the high bit of a name
 724     // offset is set.
 725     void setNameOffset(uint32_t Offset) { NameOffset = Offset | (1 << 31); }
 726   } Identifier;
 727   union {
 728     support::ulittle32_t DataEntryOffset;
 729     support::ulittle32_t SubdirOffset;
 730
 731     bool isSubDir() const { return SubdirOffset >> 31; }
 732     uint32_t value() const {
 733       return maskTrailingOnes<uint32_t>(31) & SubdirOffset;
 734     }
 735
 736   } Offset;
 737 };
 738
 739 struct coff_resource_data_entry {
 740   support::ulittle32_t DataRVA;
 741   support::ulittle32_t DataSize;
 742   support::ulittle32_t Codepage;
 743   support::ulittle32_t Reserved;
 744 };
 745
 746 struct coff_resource_dir_table {
 747   support::ulittle32_t Characteristics;
 748   support::ulittle32_t TimeDateStamp;
 749   support::ulittle16_t MajorVersion;
 750   support::ulittle16_t MinorVersion;
 751   support::ulittle16_t NumberOfNameEntries;
 752   support::ulittle16_t NumberOfIDEntries;
 753 };
 754
 755 struct debug_h_header {
 756   support::ulittle32_t Magic;
 757   support::ulittle16_t Version;
 758   support::ulittle16_t HashAlgorithm;
 759 };
 760
 761 class COFFObjectFile : public ObjectFile {
 762 private:
 763   friend class ImportDirectoryEntryRef;
 764   friend class ExportDirectoryEntryRef;
 765   const coff_file_header *COFFHeader;
 766   const coff_bigobj_file_header *COFFBigObjHeader;
 767   const pe32_header *PE32Header;
 768   const pe32plus_header *PE32PlusHeader;
 769   const data_directory *DataDirectory;
 770   const coff_section *SectionTable;
 771   const coff_symbol16 *SymbolTable16;
 772   const coff_symbol32 *SymbolTable32;
 773   const char *StringTable;
 774   uint32_t StringTableSize;
 775   const coff_import_directory_table_entry *ImportDirectory;
 776   const delay_import_directory_table_entry *DelayImportDirectory;
 777   uint32_t NumberOfDelayImportDirectory;
 778   const export_directory_table_entry *ExportDirectory;
 779   const coff_base_reloc_block_header *BaseRelocHeader;
 780   const coff_base_reloc_block_header *BaseRelocEnd;
 781   const debug_directory *DebugDirectoryBegin;
 782   const debug_directory *DebugDirectoryEnd;
 783   // Either coff_load_configuration32 or coff_load_configuration64.
 784   const void *LoadConfig = nullptr;
 785
 786   std::error_code getString(uint32_t offset, StringRef &Res) const;
 787
 788   template <typename coff_symbol_type>
 789   const coff_symbol_type *toSymb(DataRefImpl Symb) const;
 790   const coff_section *toSec(DataRefImpl Sec) const;
 791   const coff_relocation *toRel(DataRefImpl Rel) const;
 792
 793   std::error_code initSymbolTablePtr();
 794   std::error_code initImportTablePtr();
 795   std::error_code initDelayImportTablePtr();
 796   std::error_code initExportTablePtr();
 797   std::error_code initBaseRelocPtr();
 798   std::error_code initDebugDirectoryPtr();
 799   std::error_code initLoadConfigPtr();
 800
 801 public:
 802   uintptr_t getSymbolTable() const {
 803     if (SymbolTable16)
 804       return reinterpret_cast<uintptr_t>(SymbolTable16);
 805     if (SymbolTable32)
 806       return reinterpret_cast<uintptr_t>(SymbolTable32);
 807     return uintptr_t(0);
 808   }
 809
 810   uint16_t getMachine() const {
 811     if (COFFHeader)
 812       return COFFHeader->Machine;
 813     if (COFFBigObjHeader)
 814       return COFFBigObjHeader->Machine;
 815     llvm_unreachable("no COFF header!");
 816   }
 817
 818   uint16_t getSizeOfOptionalHeader() const {
 819     if (COFFHeader)
 820       return COFFHeader->isImportLibrary() ? 0
 821                                            : COFFHeader->SizeOfOptionalHeader;
 822     // bigobj doesn't have this field.
 823     if (COFFBigObjHeader)
 824       return 0;
 825     llvm_unreachable("no COFF header!");
 826   }
 827
 828   uint16_t getCharacteristics() const {
 829     if (COFFHeader)
 830       return COFFHeader->isImportLibrary() ? 0 : COFFHeader->Characteristics;
 831     // bigobj doesn't have characteristics to speak of,
 832     // editbin will silently lie to you if you attempt to set any.
 833     if (COFFBigObjHeader)
 834       return 0;
 835     llvm_unreachable("no COFF header!");
 836   }
 837
 838   uint32_t getTimeDateStamp() const {
 839     if (COFFHeader)
 840       return COFFHeader->TimeDateStamp;
 841     if (COFFBigObjHeader)
 842       return COFFBigObjHeader->TimeDateStamp;
 843     llvm_unreachable("no COFF header!");
 844   }
 845
 846   uint32_t getNumberOfSections() const {
 847     if (COFFHeader)
 848       return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSections;
 849     if (COFFBigObjHeader)
 850       return COFFBigObjHeader->NumberOfSections;
 851     llvm_unreachable("no COFF header!");
 852   }
 853
 854   uint32_t getPointerToSymbolTable() const {
 855     if (COFFHeader)
 856       return COFFHeader->isImportLibrary() ? 0
 857                                            : COFFHeader->PointerToSymbolTable;
 858     if (COFFBigObjHeader)
 859       return COFFBigObjHeader->PointerToSymbolTable;
 860     llvm_unreachable("no COFF header!");
 861   }
 862
 863   uint32_t getRawNumberOfSymbols() const {
 864     if (COFFHeader)
 865       return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSymbols;
 866     if (COFFBigObjHeader)
 867       return COFFBigObjHeader->NumberOfSymbols;
 868     llvm_unreachable("no COFF header!");
 869   }
 870
 871   uint32_t getNumberOfSymbols() const {
 872     if (!SymbolTable16 && !SymbolTable32)
 873       return 0;
 874     return getRawNumberOfSymbols();
 875   }
 876
 877   const coff_load_configuration32 *getLoadConfig32() const {
 878     assert(!is64());
 879     return reinterpret_cast<const coff_load_configuration32 *>(LoadConfig);
 880   }
 881
 882   const coff_load_configuration64 *getLoadConfig64() const {
 883     assert(is64());
 884     return reinterpret_cast<const coff_load_configuration64 *>(LoadConfig);
 885   }
 886
 887 protected:
 888   void moveSymbolNext(DataRefImpl &Symb) const override;
 889   Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
 890   Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;
 891   uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
 892   uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
 893   uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
 894   uint32_t getSymbolFlags(DataRefImpl Symb) const override;
 895   Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override;
 896   Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;
 897   void moveSectionNext(DataRefImpl &Sec) const override;
 898   std::error_code getSectionName(DataRefImpl Sec,
 899                                  StringRef &Res) const override;
 900   uint64_t getSectionAddress(DataRefImpl Sec) const override;
 901   uint64_t getSectionIndex(DataRefImpl Sec) const override;
 902   uint64_t getSectionSize(DataRefImpl Sec) const override;
 903   std::error_code getSectionContents(DataRefImpl Sec,
 904                                      StringRef &Res) const override;
 905   uint64_t getSectionAlignment(DataRefImpl Sec) const override;
 906   bool isSectionCompressed(DataRefImpl Sec) const override;
 907   bool isSectionText(DataRefImpl Sec) const override;
 908   bool isSectionData(DataRefImpl Sec) const override;
 909   bool isSectionBSS(DataRefImpl Sec) const override;
 910   bool isSectionVirtual(DataRefImpl Sec) const override;
 911   relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
 912   relocation_iterator section_rel_end(DataRefImpl Sec) const override;
 913
 914   void moveRelocationNext(DataRefImpl &Rel) const override;
 915   uint64_t getRelocationOffset(DataRefImpl Rel) const override;
 916   symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
 917   uint64_t getRelocationType(DataRefImpl Rel) const override;
 918   void getRelocationTypeName(DataRefImpl Rel,
 919                              SmallVectorImpl<char> &Result) const override;
 920
 921 public:
 922   COFFObjectFile(MemoryBufferRef Object, std::error_code &EC);
 923
 924   basic_symbol_iterator symbol_begin() const override;
 925   basic_symbol_iterator symbol_end() const override;
 926   section_iterator section_begin() const override;
 927   section_iterator section_end() const override;
 928
 929   const coff_section *getCOFFSection(const SectionRef &Section) const;
 930   COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
 931   COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
 932   const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
 933   unsigned getSectionID(SectionRef Sec) const;
 934   unsigned getSymbolSectionID(SymbolRef Sym) const;
 935
 936   uint8_t getBytesInAddress() const override;
 937   StringRef getFileFormatName() const override;
 938   Triple::ArchType getArch() const override;
 939   Expected<uint64_t> getStartAddress() const override;
 940   SubtargetFeatures getFeatures() const override { return SubtargetFeatures(); }
 941
 942   import_directory_iterator import_directory_begin() const;
 943   import_directory_iterator import_directory_end() const;
 944   delay_import_directory_iterator delay_import_directory_begin() const;
 945   delay_import_directory_iterator delay_import_directory_end() const;
 946   export_directory_iterator export_directory_begin() const;
 947   export_directory_iterator export_directory_end() const;
 948   base_reloc_iterator base_reloc_begin() const;
 949   base_reloc_iterator base_reloc_end() const;
 950   const debug_directory *debug_directory_begin() const {
 951     return DebugDirectoryBegin;
 952   }
 953   const debug_directory *debug_directory_end() const {
 954     return DebugDirectoryEnd;
 955   }
 956
 957   iterator_range<import_directory_iterator> import_directories() const;
 958   iterator_range<delay_import_directory_iterator>
 959       delay_import_directories() const;
 960   iterator_range<export_directory_iterator> export_directories() const;
 961   iterator_range<base_reloc_iterator> base_relocs() const;
 962   iterator_range<const debug_directory *> debug_directories() const {
 963     return make_range(debug_directory_begin(), debug_directory_end());
 964   }
 965
 966   const dos_header *getDOSHeader() const {
 967     if (!PE32Header && !PE32PlusHeader)
 968       return nullptr;
 969     return reinterpret_cast<const dos_header *>(base());
 970   }
 971   std::error_code getPE32Header(const pe32_header *&Res) const;
 972   std::error_code getPE32PlusHeader(const pe32plus_header *&Res) const;
 973   std::error_code getDataDirectory(uint32_t index,
 974                                    const data_directory *&Res) const;
 975   std::error_code getSection(int32_t index, const coff_section *&Res) const;
 976   std::error_code getSection(StringRef SectionName,
 977                              const coff_section *&Res) const;
 978
 979   template <typename coff_symbol_type>
 980   std::error_code getSymbol(uint32_t Index,
 981                             const coff_symbol_type *&Res) const {
 982     if (Index >= getNumberOfSymbols())
 983       return object_error::parse_failed;
 984
 985     Res = reinterpret_cast<coff_symbol_type *>(getSymbolTable()) + Index;
 986     return std::error_code();
 987   }
 988   Expected<COFFSymbolRef> getSymbol(uint32_t index) const {
 989     if (SymbolTable16) {
 990       const coff_symbol16 *Symb = nullptr;
 991       if (std::error_code EC = getSymbol(index, Symb))
 992         return errorCodeToError(EC);
 993       return COFFSymbolRef(Symb);
 994     }
 995     if (SymbolTable32) {
 996       const coff_symbol32 *Symb = nullptr;
 997       if (std::error_code EC = getSymbol(index, Symb))
 998         return errorCodeToError(EC);
 999       return COFFSymbolRef(Symb);
1000     }
1001     return errorCodeToError(object_error::parse_failed);
1002   }
1003
1004   template <typename T>
1005   std::error_code getAuxSymbol(uint32_t index, const T *&Res) const {
1006     Expected<COFFSymbolRef> S = getSymbol(index);
1007     if (Error E = S.takeError())
1008       return errorToErrorCode(std::move(E));
1009     Res = reinterpret_cast<const T *>(S->getRawPtr());
1010     return std::error_code();
1011   }
1012
1013   std::error_code getSymbolName(COFFSymbolRef Symbol, StringRef &Res) const;
1014   std::error_code getSymbolName(const coff_symbol_generic *Symbol,
1015                                 StringRef &Res) const;
1016
1017   ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
1018
1019   size_t getSymbolTableEntrySize() const {
1020     if (COFFHeader)
1021       return sizeof(coff_symbol16);
1022     if (COFFBigObjHeader)
1023       return sizeof(coff_symbol32);
1024     llvm_unreachable("null symbol table pointer!");
1025   }
1026
1027   ArrayRef<coff_relocation> getRelocations(const coff_section *Sec) const;
1028
1029   std::error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
1030   uint64_t getSectionSize(const coff_section *Sec) const;
1031   std::error_code getSectionContents(const coff_section *Sec,
1032                                      ArrayRef<uint8_t> &Res) const;
1033
1034   uint64_t getImageBase() const;
1035   std::error_code getVaPtr(uint64_t VA, uintptr_t &Res) const;
1036   std::error_code getRvaPtr(uint32_t Rva, uintptr_t &Res) const;
1037
1038   /// Given an RVA base and size, returns a valid array of bytes or an error
1039   /// code if the RVA and size is not contained completely within a valid
1040   /// section.
1041   std::error_code getRvaAndSizeAsBytes(uint32_t RVA, uint32_t Size,
1042                                        ArrayRef<uint8_t> &Contents) const;
1043
1044   std::error_code getHintName(uint32_t Rva, uint16_t &Hint,
1045                               StringRef &Name) const;
1046
1047   /// Get PDB information out of a codeview debug directory entry.
1048   std::error_code getDebugPDBInfo(const debug_directory *DebugDir,
1049                                   const codeview::DebugInfo *&Info,
1050                                   StringRef &PDBFileName) const;
1051
1052   /// Get PDB information from an executable. If the information is not present,
1053   /// Info will be set to nullptr and PDBFileName will be empty. An error is
1054   /// returned only on corrupt object files. Convenience accessor that can be
1055   /// used if the debug directory is not already handy.
1056   std::error_code getDebugPDBInfo(const codeview::DebugInfo *&Info,
1057                                   StringRef &PDBFileName) const;
1058
1059   bool isRelocatableObject() const override;
1060   bool is64() const { return PE32PlusHeader; }
1061
1062   static bool classof(const Binary *v) { return v->isCOFF(); }
1063 };
1064
1065 // The iterator for the import directory table.
1066 class ImportDirectoryEntryRef {
1067 public:
1068   ImportDirectoryEntryRef() = default;
1069   ImportDirectoryEntryRef(const coff_import_directory_table_entry *Table,
1070                           uint32_t I, const COFFObjectFile *Owner)
1071       : ImportTable(Table), Index(I), OwningObject(Owner) {}
1072
1073   bool operator==(const ImportDirectoryEntryRef &Other) const;
1074   void moveNext();
1075
1076   imported_symbol_iterator imported_symbol_begin() const;
1077   imported_symbol_iterator imported_symbol_end() const;
1078   iterator_range<imported_symbol_iterator> imported_symbols() const;
1079
1080   imported_symbol_iterator lookup_table_begin() const;
1081   imported_symbol_iterator lookup_table_end() const;
1082   iterator_range<imported_symbol_iterator> lookup_table_symbols() const;
1083
1084   std::error_code getName(StringRef &Result) const;
1085   std::error_code getImportLookupTableRVA(uint32_t &Result) const;
1086   std::error_code getImportAddressTableRVA(uint32_t &Result) const;
1087
1088   std::error_code
1089   getImportTableEntry(const coff_import_directory_table_entry *&Result) const;
1090
1091 private:
1092   const coff_import_directory_table_entry *ImportTable;
1093   uint32_t Index;
1094   const COFFObjectFile *OwningObject = nullptr;
1095 };
1096
1097 class DelayImportDirectoryEntryRef {
1098 public:
1099   DelayImportDirectoryEntryRef() = default;
1100   DelayImportDirectoryEntryRef(const delay_import_directory_table_entry *T,
1101                                uint32_t I, const COFFObjectFile *Owner)
1102       : Table(T), Index(I), OwningObject(Owner) {}
1103
1104   bool operator==(const DelayImportDirectoryEntryRef &Other) const;
1105   void moveNext();
1106
1107   imported_symbol_iterator imported_symbol_begin() const;
1108   imported_symbol_iterator imported_symbol_end() const;
1109   iterator_range<imported_symbol_iterator> imported_symbols() const;
1110
1111   std::error_code getName(StringRef &Result) const;
1112   std::error_code getDelayImportTable(
1113       const delay_import_directory_table_entry *&Result) const;
1114   std::error_code getImportAddress(int AddrIndex, uint64_t &Result) const;
1115
1116 private:
1117   const delay_import_directory_table_entry *Table;
1118   uint32_t Index;
1119   const COFFObjectFile *OwningObject = nullptr;
1120 };
1121
1122 // The iterator for the export directory table entry.
1123 class ExportDirectoryEntryRef {
1124 public:
1125   ExportDirectoryEntryRef() = default;
1126   ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
1127                           const COFFObjectFile *Owner)
1128       : ExportTable(Table), Index(I), OwningObject(Owner) {}
1129
1130   bool operator==(const ExportDirectoryEntryRef &Other) const;
1131   void moveNext();
1132
1133   std::error_code getDllName(StringRef &Result) const;
1134   std::error_code getOrdinalBase(uint32_t &Result) const;
1135   std::error_code getOrdinal(uint32_t &Result) const;
1136   std::error_code getExportRVA(uint32_t &Result) const;
1137   std::error_code getSymbolName(StringRef &Result) const;
1138
1139   std::error_code isForwarder(bool &Result) const;
1140   std::error_code getForwardTo(StringRef &Result) const;
1141
1142 private:
1143   const export_directory_table_entry *ExportTable;
1144   uint32_t Index;
1145   const COFFObjectFile *OwningObject = nullptr;
1146 };
1147
1148 class ImportedSymbolRef {
1149 public:
1150   ImportedSymbolRef() = default;
1151   ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
1152                     const COFFObjectFile *Owner)
1153       : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
1154   ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
1155                     const COFFObjectFile *Owner)
1156       : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
1157
1158   bool operator==(const ImportedSymbolRef &Other) const;
1159   void moveNext();
1160
1161   std::error_code getSymbolName(StringRef &Result) const;
1162   std::error_code isOrdinal(bool &Result) const;
1163   std::error_code getOrdinal(uint16_t &Result) const;
1164   std::error_code getHintNameRVA(uint32_t &Result) const;
1165
1166 private:
1167   const import_lookup_table_entry32 *Entry32;
1168   const import_lookup_table_entry64 *Entry64;
1169   uint32_t Index;
1170   const COFFObjectFile *OwningObject = nullptr;
1171 };
1172
1173 class BaseRelocRef {
1174 public:
1175   BaseRelocRef() = default;
1176   BaseRelocRef(const coff_base_reloc_block_header *Header,
1177                const COFFObjectFile *Owner)
1178       : Header(Header), Index(0) {}
1179
1180   bool operator==(const BaseRelocRef &Other) const;
1181   void moveNext();
1182
1183   std::error_code getType(uint8_t &Type) const;
1184   std::error_code getRVA(uint32_t &Result) const;
1185
1186 private:
1187   const coff_base_reloc_block_header *Header;
1188   uint32_t Index;
1189 };
1190
1191 class ResourceSectionRef {
1192 public:
1193   ResourceSectionRef() = default;
1194   explicit ResourceSectionRef(StringRef Ref) : BBS(Ref, support::little) {}
1195
1196   Expected<ArrayRef<UTF16>>
1197   getEntryNameString(const coff_resource_dir_entry &Entry);
1198   Expected<const coff_resource_dir_table &>
1199   getEntrySubDir(const coff_resource_dir_entry &Entry);
1200   Expected<const coff_resource_dir_table &> getBaseTable();
1201
1202 private:
1203   BinaryByteStream BBS;
1204
1205   Expected<const coff_resource_dir_table &> getTableAtOffset(uint32_t Offset);
1206   Expected<ArrayRef<UTF16>> getDirStringAtOffset(uint32_t Offset);
1207 };
1208
1209 // Corresponds to `_FPO_DATA` structure in the PE/COFF spec.
1210 struct FpoData {
1211   support::ulittle32_t Offset; // ulOffStart: Offset 1st byte of function code
1212   support::ulittle32_t Size;   // cbProcSize: # bytes in function
1213   support::ulittle32_t NumLocals; // cdwLocals: # bytes in locals/4
1214   support::ulittle16_t NumParams; // cdwParams: # bytes in params/4
1215   support::ulittle16_t Attributes;
1216
1217   // cbProlog: # bytes in prolog
1218   int getPrologSize() const { return Attributes & 0xF; }
1219
1220   // cbRegs: # regs saved
1221   int getNumSavedRegs() const { return (Attributes >> 8) & 0x7; }
1222
1223   // fHasSEH: true if seh is func
1224   bool hasSEH() const { return (Attributes >> 9) & 1; }
1225
1226   // fUseBP: true if EBP has been allocated
1227   bool useBP() const { return (Attributes >> 10) & 1; }
1228
1229   // cbFrame: frame pointer
1230   int getFP() const { return Attributes >> 14; }
1231 };
1232
1233 } // end namespace object
1234
1235 } // end namespace llvm
1236
1237 #endif // LLVM_OBJECT_COFF_H