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