include/llvm/Support/COFF.h

   1 //===-- llvm/Support/COFF.h -------------------------------------*- 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 contains an definitions used in Windows COFF Files.
  11 //
  12 // Structures and enums defined within this file where created using
  13 // information from Microsoft's publicly available PE/COFF format document:
  14 //
  15 // Microsoft Portable Executable and Common Object File Format Specification
  16 // Revision 8.1 - February 15, 2008
  17 //
  18 // As of 5/2/2010, hosted by Microsoft at:
  19 // http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_SUPPORT_COFF_H
  24 #define LLVM_SUPPORT_COFF_H
  25
  26 #include "llvm/Support/DataTypes.h"
  27 #include <cassert>
  28 #include <cstring>
  29
  30 namespace llvm {
  31 namespace COFF {
  32
  33   // The maximum number of sections that a COFF object can have (inclusive).
  34   const int32_t MaxNumberOfSections16 = 65279;
  35
  36   // The PE signature bytes that follows the DOS stub header.
  37   static const char PEMagic[] = { 'P', 'E', '\0', '\0' };
  38
  39   static const char BigObjMagic[] = {
  40       '\xc7', '\xa1', '\xba', '\xd1', '\xee', '\xba', '\xa9', '\x4b',
  41       '\xaf', '\x20', '\xfa', '\xf6', '\x6a', '\xa4', '\xdc', '\xb8',
  42   };
  43
  44   // Sizes in bytes of various things in the COFF format.
  45   enum {
  46     Header16Size   = 20,
  47     Header32Size   = 56,
  48     NameSize       = 8,
  49     Symbol16Size   = 18,
  50     Symbol32Size   = 20,
  51     SectionSize    = 40,
  52     RelocationSize = 10
  53   };
  54
  55   struct header {
  56     uint16_t Machine;
  57     int32_t  NumberOfSections;
  58     uint32_t TimeDateStamp;
  59     uint32_t PointerToSymbolTable;
  60     uint32_t NumberOfSymbols;
  61     uint16_t SizeOfOptionalHeader;
  62     uint16_t Characteristics;
  63   };
  64
  65   struct BigObjHeader {
  66     enum : uint16_t { MinBigObjectVersion = 2 };
  67
  68     uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
  69     uint16_t Sig2; ///< Must be 0xFFFF.
  70     uint16_t Version;
  71     uint16_t Machine;
  72     uint32_t TimeDateStamp;
  73     uint8_t  UUID[16];
  74     uint32_t unused1;
  75     uint32_t unused2;
  76     uint32_t unused3;
  77     uint32_t unused4;
  78     uint32_t NumberOfSections;
  79     uint32_t PointerToSymbolTable;
  80     uint32_t NumberOfSymbols;
  81   };
  82
  83   enum MachineTypes {
  84     MT_Invalid = 0xffff,
  85
  86     IMAGE_FILE_MACHINE_UNKNOWN   = 0x0,
  87     IMAGE_FILE_MACHINE_AM33      = 0x13,
  88     IMAGE_FILE_MACHINE_AMD64     = 0x8664,
  89     IMAGE_FILE_MACHINE_ARM       = 0x1C0,
  90     IMAGE_FILE_MACHINE_ARMNT     = 0x1C4,
  91     IMAGE_FILE_MACHINE_EBC       = 0xEBC,
  92     IMAGE_FILE_MACHINE_I386      = 0x14C,
  93     IMAGE_FILE_MACHINE_IA64      = 0x200,
  94     IMAGE_FILE_MACHINE_M32R      = 0x9041,
  95     IMAGE_FILE_MACHINE_MIPS16    = 0x266,
  96     IMAGE_FILE_MACHINE_MIPSFPU   = 0x366,
  97     IMAGE_FILE_MACHINE_MIPSFPU16 = 0x466,
  98     IMAGE_FILE_MACHINE_POWERPC   = 0x1F0,
  99     IMAGE_FILE_MACHINE_POWERPCFP = 0x1F1,
 100     IMAGE_FILE_MACHINE_R4000     = 0x166,
 101     IMAGE_FILE_MACHINE_SH3       = 0x1A2,
 102     IMAGE_FILE_MACHINE_SH3DSP    = 0x1A3,
 103     IMAGE_FILE_MACHINE_SH4       = 0x1A6,
 104     IMAGE_FILE_MACHINE_SH5       = 0x1A8,
 105     IMAGE_FILE_MACHINE_THUMB     = 0x1C2,
 106     IMAGE_FILE_MACHINE_WCEMIPSV2 = 0x169
 107   };
 108
 109   enum Characteristics {
 110     C_Invalid = 0,
 111
 112     /// The file does not contain base relocations and must be loaded at its
 113     /// preferred base. If this cannot be done, the loader will error.
 114     IMAGE_FILE_RELOCS_STRIPPED         = 0x0001,
 115     /// The file is valid and can be run.
 116     IMAGE_FILE_EXECUTABLE_IMAGE        = 0x0002,
 117     /// COFF line numbers have been stripped. This is deprecated and should be
 118     /// 0.
 119     IMAGE_FILE_LINE_NUMS_STRIPPED      = 0x0004,
 120     /// COFF symbol table entries for local symbols have been removed. This is
 121     /// deprecated and should be 0.
 122     IMAGE_FILE_LOCAL_SYMS_STRIPPED     = 0x0008,
 123     /// Aggressively trim working set. This is deprecated and must be 0.
 124     IMAGE_FILE_AGGRESSIVE_WS_TRIM      = 0x0010,
 125     /// Image can handle > 2GiB addresses.
 126     IMAGE_FILE_LARGE_ADDRESS_AWARE     = 0x0020,
 127     /// Little endian: the LSB precedes the MSB in memory. This is deprecated
 128     /// and should be 0.
 129     IMAGE_FILE_BYTES_REVERSED_LO       = 0x0080,
 130     /// Machine is based on a 32bit word architecture.
 131     IMAGE_FILE_32BIT_MACHINE           = 0x0100,
 132     /// Debugging info has been removed.
 133     IMAGE_FILE_DEBUG_STRIPPED          = 0x0200,
 134     /// If the image is on removable media, fully load it and copy it to swap.
 135     IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400,
 136     /// If the image is on network media, fully load it and copy it to swap.
 137     IMAGE_FILE_NET_RUN_FROM_SWAP       = 0x0800,
 138     /// The image file is a system file, not a user program.
 139     IMAGE_FILE_SYSTEM                  = 0x1000,
 140     /// The image file is a DLL.
 141     IMAGE_FILE_DLL                     = 0x2000,
 142     /// This file should only be run on a uniprocessor machine.
 143     IMAGE_FILE_UP_SYSTEM_ONLY          = 0x4000,
 144     /// Big endian: the MSB precedes the LSB in memory. This is deprecated
 145     /// and should be 0.
 146     IMAGE_FILE_BYTES_REVERSED_HI       = 0x8000
 147   };
 148
 149   struct symbol {
 150     char     Name[NameSize];
 151     uint32_t Value;
 152     int32_t  SectionNumber;
 153     uint16_t Type;
 154     uint8_t  StorageClass;
 155     uint8_t  NumberOfAuxSymbols;
 156   };
 157
 158   enum SymbolFlags : uint16_t {
 159     SF_ClassMask = 0x00FF,
 160     SF_ClassShift = 0,
 161
 162     SF_WeakExternal = 0x0100,
 163     SF_SafeSEH = 0x0200,
 164   };
 165
 166   enum SymbolSectionNumber : int32_t {
 167     IMAGE_SYM_DEBUG     = -2,
 168     IMAGE_SYM_ABSOLUTE  = -1,
 169     IMAGE_SYM_UNDEFINED = 0
 170   };
 171
 172   /// Storage class tells where and what the symbol represents
 173   enum SymbolStorageClass {
 174     SSC_Invalid = 0xff,
 175
 176     IMAGE_SYM_CLASS_END_OF_FUNCTION  = -1,  ///< Physical end of function
 177     IMAGE_SYM_CLASS_NULL             = 0,   ///< No symbol
 178     IMAGE_SYM_CLASS_AUTOMATIC        = 1,   ///< Stack variable
 179     IMAGE_SYM_CLASS_EXTERNAL         = 2,   ///< External symbol
 180     IMAGE_SYM_CLASS_STATIC           = 3,   ///< Static
 181     IMAGE_SYM_CLASS_REGISTER         = 4,   ///< Register variable
 182     IMAGE_SYM_CLASS_EXTERNAL_DEF     = 5,   ///< External definition
 183     IMAGE_SYM_CLASS_LABEL            = 6,   ///< Label
 184     IMAGE_SYM_CLASS_UNDEFINED_LABEL  = 7,   ///< Undefined label
 185     IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8,   ///< Member of structure
 186     IMAGE_SYM_CLASS_ARGUMENT         = 9,   ///< Function argument
 187     IMAGE_SYM_CLASS_STRUCT_TAG       = 10,  ///< Structure tag
 188     IMAGE_SYM_CLASS_MEMBER_OF_UNION  = 11,  ///< Member of union
 189     IMAGE_SYM_CLASS_UNION_TAG        = 12,  ///< Union tag
 190     IMAGE_SYM_CLASS_TYPE_DEFINITION  = 13,  ///< Type definition
 191     IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14,  ///< Undefined static
 192     IMAGE_SYM_CLASS_ENUM_TAG         = 15,  ///< Enumeration tag
 193     IMAGE_SYM_CLASS_MEMBER_OF_ENUM   = 16,  ///< Member of enumeration
 194     IMAGE_SYM_CLASS_REGISTER_PARAM   = 17,  ///< Register parameter
 195     IMAGE_SYM_CLASS_BIT_FIELD        = 18,  ///< Bit field
 196     /// ".bb" or ".eb" - beginning or end of block
 197     IMAGE_SYM_CLASS_BLOCK            = 100,
 198     /// ".bf" or ".ef" - beginning or end of function
 199     IMAGE_SYM_CLASS_FUNCTION         = 101,
 200     IMAGE_SYM_CLASS_END_OF_STRUCT    = 102, ///< End of structure
 201     IMAGE_SYM_CLASS_FILE             = 103, ///< File name
 202     /// Line number, reformatted as symbol
 203     IMAGE_SYM_CLASS_SECTION          = 104,
 204     IMAGE_SYM_CLASS_WEAK_EXTERNAL    = 105, ///< Duplicate tag
 205     /// External symbol in dmert public lib
 206     IMAGE_SYM_CLASS_CLR_TOKEN        = 107
 207   };
 208
 209   enum SymbolBaseType {
 210     IMAGE_SYM_TYPE_NULL   = 0,  ///< No type information or unknown base type.
 211     IMAGE_SYM_TYPE_VOID   = 1,  ///< Used with void pointers and functions.
 212     IMAGE_SYM_TYPE_CHAR   = 2,  ///< A character (signed byte).
 213     IMAGE_SYM_TYPE_SHORT  = 3,  ///< A 2-byte signed integer.
 214     IMAGE_SYM_TYPE_INT    = 4,  ///< A natural integer type on the target.
 215     IMAGE_SYM_TYPE_LONG   = 5,  ///< A 4-byte signed integer.
 216     IMAGE_SYM_TYPE_FLOAT  = 6,  ///< A 4-byte floating-point number.
 217     IMAGE_SYM_TYPE_DOUBLE = 7,  ///< An 8-byte floating-point number.
 218     IMAGE_SYM_TYPE_STRUCT = 8,  ///< A structure.
 219     IMAGE_SYM_TYPE_UNION  = 9,  ///< An union.
 220     IMAGE_SYM_TYPE_ENUM   = 10, ///< An enumerated type.
 221     IMAGE_SYM_TYPE_MOE    = 11, ///< A member of enumeration (a specific value).
 222     IMAGE_SYM_TYPE_BYTE   = 12, ///< A byte; unsigned 1-byte integer.
 223     IMAGE_SYM_TYPE_WORD   = 13, ///< A word; unsigned 2-byte integer.
 224     IMAGE_SYM_TYPE_UINT   = 14, ///< An unsigned integer of natural size.
 225     IMAGE_SYM_TYPE_DWORD  = 15  ///< An unsigned 4-byte integer.
 226   };
 227
 228   enum SymbolComplexType {
 229     IMAGE_SYM_DTYPE_NULL     = 0, ///< No complex type; simple scalar variable.
 230     IMAGE_SYM_DTYPE_POINTER  = 1, ///< A pointer to base type.
 231     IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
 232     IMAGE_SYM_DTYPE_ARRAY    = 3, ///< An array of base type.
 233
 234     /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
 235     SCT_COMPLEX_TYPE_SHIFT   = 4
 236   };
 237
 238   enum AuxSymbolType {
 239     IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF = 1
 240   };
 241
 242   struct section {
 243     char     Name[NameSize];
 244     uint32_t VirtualSize;
 245     uint32_t VirtualAddress;
 246     uint32_t SizeOfRawData;
 247     uint32_t PointerToRawData;
 248     uint32_t PointerToRelocations;
 249     uint32_t PointerToLineNumbers;
 250     uint16_t NumberOfRelocations;
 251     uint16_t NumberOfLineNumbers;
 252     uint32_t Characteristics;
 253   };
 254
 255   enum SectionCharacteristics : uint32_t {
 256     SC_Invalid = 0xffffffff,
 257
 258     IMAGE_SCN_TYPE_NO_PAD            = 0x00000008,
 259     IMAGE_SCN_CNT_CODE               = 0x00000020,
 260     IMAGE_SCN_CNT_INITIALIZED_DATA   = 0x00000040,
 261     IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
 262     IMAGE_SCN_LNK_OTHER              = 0x00000100,
 263     IMAGE_SCN_LNK_INFO               = 0x00000200,
 264     IMAGE_SCN_LNK_REMOVE             = 0x00000800,
 265     IMAGE_SCN_LNK_COMDAT             = 0x00001000,
 266     IMAGE_SCN_GPREL                  = 0x00008000,
 267     IMAGE_SCN_MEM_PURGEABLE          = 0x00020000,
 268     IMAGE_SCN_MEM_16BIT              = 0x00020000,
 269     IMAGE_SCN_MEM_LOCKED             = 0x00040000,
 270     IMAGE_SCN_MEM_PRELOAD            = 0x00080000,
 271     IMAGE_SCN_ALIGN_1BYTES           = 0x00100000,
 272     IMAGE_SCN_ALIGN_2BYTES           = 0x00200000,
 273     IMAGE_SCN_ALIGN_4BYTES           = 0x00300000,
 274     IMAGE_SCN_ALIGN_8BYTES           = 0x00400000,
 275     IMAGE_SCN_ALIGN_16BYTES          = 0x00500000,
 276     IMAGE_SCN_ALIGN_32BYTES          = 0x00600000,
 277     IMAGE_SCN_ALIGN_64BYTES          = 0x00700000,
 278     IMAGE_SCN_ALIGN_128BYTES         = 0x00800000,
 279     IMAGE_SCN_ALIGN_256BYTES         = 0x00900000,
 280     IMAGE_SCN_ALIGN_512BYTES         = 0x00A00000,
 281     IMAGE_SCN_ALIGN_1024BYTES        = 0x00B00000,
 282     IMAGE_SCN_ALIGN_2048BYTES        = 0x00C00000,
 283     IMAGE_SCN_ALIGN_4096BYTES        = 0x00D00000,
 284     IMAGE_SCN_ALIGN_8192BYTES        = 0x00E00000,
 285     IMAGE_SCN_LNK_NRELOC_OVFL        = 0x01000000,
 286     IMAGE_SCN_MEM_DISCARDABLE        = 0x02000000,
 287     IMAGE_SCN_MEM_NOT_CACHED         = 0x04000000,
 288     IMAGE_SCN_MEM_NOT_PAGED          = 0x08000000,
 289     IMAGE_SCN_MEM_SHARED             = 0x10000000,
 290     IMAGE_SCN_MEM_EXECUTE            = 0x20000000,
 291     IMAGE_SCN_MEM_READ               = 0x40000000,
 292     IMAGE_SCN_MEM_WRITE              = 0x80000000
 293   };
 294
 295   struct relocation {
 296     uint32_t VirtualAddress;
 297     uint32_t SymbolTableIndex;
 298     uint16_t Type;
 299   };
 300
 301   enum RelocationTypeI386 {
 302     IMAGE_REL_I386_ABSOLUTE = 0x0000,
 303     IMAGE_REL_I386_DIR16    = 0x0001,
 304     IMAGE_REL_I386_REL16    = 0x0002,
 305     IMAGE_REL_I386_DIR32    = 0x0006,
 306     IMAGE_REL_I386_DIR32NB  = 0x0007,
 307     IMAGE_REL_I386_SEG12    = 0x0009,
 308     IMAGE_REL_I386_SECTION  = 0x000A,
 309     IMAGE_REL_I386_SECREL   = 0x000B,
 310     IMAGE_REL_I386_TOKEN    = 0x000C,
 311     IMAGE_REL_I386_SECREL7  = 0x000D,
 312     IMAGE_REL_I386_REL32    = 0x0014
 313   };
 314
 315   enum RelocationTypeAMD64 {
 316     IMAGE_REL_AMD64_ABSOLUTE  = 0x0000,
 317     IMAGE_REL_AMD64_ADDR64    = 0x0001,
 318     IMAGE_REL_AMD64_ADDR32    = 0x0002,
 319     IMAGE_REL_AMD64_ADDR32NB  = 0x0003,
 320     IMAGE_REL_AMD64_REL32     = 0x0004,
 321     IMAGE_REL_AMD64_REL32_1   = 0x0005,
 322     IMAGE_REL_AMD64_REL32_2   = 0x0006,
 323     IMAGE_REL_AMD64_REL32_3   = 0x0007,
 324     IMAGE_REL_AMD64_REL32_4   = 0x0008,
 325     IMAGE_REL_AMD64_REL32_5   = 0x0009,
 326     IMAGE_REL_AMD64_SECTION   = 0x000A,
 327     IMAGE_REL_AMD64_SECREL    = 0x000B,
 328     IMAGE_REL_AMD64_SECREL7   = 0x000C,
 329     IMAGE_REL_AMD64_TOKEN     = 0x000D,
 330     IMAGE_REL_AMD64_SREL32    = 0x000E,
 331     IMAGE_REL_AMD64_PAIR      = 0x000F,
 332     IMAGE_REL_AMD64_SSPAN32   = 0x0010
 333   };
 334
 335   enum RelocationTypesARM {
 336     IMAGE_REL_ARM_ABSOLUTE  = 0x0000,
 337     IMAGE_REL_ARM_ADDR32    = 0x0001,
 338     IMAGE_REL_ARM_ADDR32NB  = 0x0002,
 339     IMAGE_REL_ARM_BRANCH24  = 0x0003,
 340     IMAGE_REL_ARM_BRANCH11  = 0x0004,
 341     IMAGE_REL_ARM_TOKEN     = 0x0005,
 342     IMAGE_REL_ARM_BLX24     = 0x0008,
 343     IMAGE_REL_ARM_BLX11     = 0x0009,
 344     IMAGE_REL_ARM_SECTION   = 0x000E,
 345     IMAGE_REL_ARM_SECREL    = 0x000F,
 346     IMAGE_REL_ARM_MOV32A    = 0x0010,
 347     IMAGE_REL_ARM_MOV32T    = 0x0011,
 348     IMAGE_REL_ARM_BRANCH20T = 0x0012,
 349     IMAGE_REL_ARM_BRANCH24T = 0x0014,
 350     IMAGE_REL_ARM_BLX23T    = 0x0015
 351   };
 352
 353   enum COMDATType {
 354     IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
 355     IMAGE_COMDAT_SELECT_ANY,
 356     IMAGE_COMDAT_SELECT_SAME_SIZE,
 357     IMAGE_COMDAT_SELECT_EXACT_MATCH,
 358     IMAGE_COMDAT_SELECT_ASSOCIATIVE,
 359     IMAGE_COMDAT_SELECT_LARGEST,
 360     IMAGE_COMDAT_SELECT_NEWEST
 361   };
 362
 363   // Auxiliary Symbol Formats
 364   struct AuxiliaryFunctionDefinition {
 365     uint32_t TagIndex;
 366     uint32_t TotalSize;
 367     uint32_t PointerToLinenumber;
 368     uint32_t PointerToNextFunction;
 369     char     unused[2];
 370   };
 371
 372   struct AuxiliarybfAndefSymbol {
 373     uint8_t  unused1[4];
 374     uint16_t Linenumber;
 375     uint8_t  unused2[6];
 376     uint32_t PointerToNextFunction;
 377     uint8_t  unused3[2];
 378   };
 379
 380   struct AuxiliaryWeakExternal {
 381     uint32_t TagIndex;
 382     uint32_t Characteristics;
 383     uint8_t  unused[10];
 384   };
 385
 386   /// These are not documented in the spec, but are located in WinNT.h.
 387   enum WeakExternalCharacteristics {
 388     IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1,
 389     IMAGE_WEAK_EXTERN_SEARCH_LIBRARY   = 2,
 390     IMAGE_WEAK_EXTERN_SEARCH_ALIAS     = 3
 391   };
 392
 393   struct AuxiliarySectionDefinition {
 394     uint32_t Length;
 395     uint16_t NumberOfRelocations;
 396     uint16_t NumberOfLinenumbers;
 397     uint32_t CheckSum;
 398     uint32_t Number;
 399     uint8_t  Selection;
 400     char     unused;
 401   };
 402
 403   struct AuxiliaryCLRToken {
 404     uint8_t  AuxType;
 405     uint8_t  unused1;
 406     uint32_t SymbolTableIndex;
 407     char     unused2[12];
 408   };
 409
 410   union Auxiliary {
 411     AuxiliaryFunctionDefinition FunctionDefinition;
 412     AuxiliarybfAndefSymbol      bfAndefSymbol;
 413     AuxiliaryWeakExternal       WeakExternal;
 414     AuxiliarySectionDefinition  SectionDefinition;
 415   };
 416
 417   /// @brief The Import Directory Table.
 418   ///
 419   /// There is a single array of these and one entry per imported DLL.
 420   struct ImportDirectoryTableEntry {
 421     uint32_t ImportLookupTableRVA;
 422     uint32_t TimeDateStamp;
 423     uint32_t ForwarderChain;
 424     uint32_t NameRVA;
 425     uint32_t ImportAddressTableRVA;
 426   };
 427
 428   /// @brief The PE32 Import Lookup Table.
 429   ///
 430   /// There is an array of these for each imported DLL. It represents either
 431   /// the ordinal to import from the target DLL, or a name to lookup and import
 432   /// from the target DLL.
 433   ///
 434   /// This also happens to be the same format used by the Import Address Table
 435   /// when it is initially written out to the image.
 436   struct ImportLookupTableEntry32 {
 437     uint32_t data;
 438
 439     /// @brief Is this entry specified by ordinal, or name?
 440     bool isOrdinal() const { return data & 0x80000000; }
 441
 442     /// @brief Get the ordinal value of this entry. isOrdinal must be true.
 443     uint16_t getOrdinal() const {
 444       assert(isOrdinal() && "ILT entry is not an ordinal!");
 445       return data & 0xFFFF;
 446     }
 447
 448     /// @brief Set the ordinal value and set isOrdinal to true.
 449     void setOrdinal(uint16_t o) {
 450       data = o;
 451       data |= 0x80000000;
 452     }
 453
 454     /// @brief Get the Hint/Name entry RVA. isOrdinal must be false.
 455     uint32_t getHintNameRVA() const {
 456       assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
 457       return data;
 458     }
 459
 460     /// @brief Set the Hint/Name entry RVA and set isOrdinal to false.
 461     void setHintNameRVA(uint32_t rva) { data = rva; }
 462   };
 463
 464   /// @brief The DOS compatible header at the front of all PEs.
 465   struct DOSHeader {
 466     uint16_t Magic;
 467     uint16_t UsedBytesInTheLastPage;
 468     uint16_t FileSizeInPages;
 469     uint16_t NumberOfRelocationItems;
 470     uint16_t HeaderSizeInParagraphs;
 471     uint16_t MinimumExtraParagraphs;
 472     uint16_t MaximumExtraParagraphs;
 473     uint16_t InitialRelativeSS;
 474     uint16_t InitialSP;
 475     uint16_t Checksum;
 476     uint16_t InitialIP;
 477     uint16_t InitialRelativeCS;
 478     uint16_t AddressOfRelocationTable;
 479     uint16_t OverlayNumber;
 480     uint16_t Reserved[4];
 481     uint16_t OEMid;
 482     uint16_t OEMinfo;
 483     uint16_t Reserved2[10];
 484     uint32_t AddressOfNewExeHeader;
 485   };
 486
 487   struct PE32Header {
 488     enum {
 489       PE32 = 0x10b,
 490       PE32_PLUS = 0x20b
 491     };
 492
 493     uint16_t Magic;
 494     uint8_t  MajorLinkerVersion;
 495     uint8_t  MinorLinkerVersion;
 496     uint32_t SizeOfCode;
 497     uint32_t SizeOfInitializedData;
 498     uint32_t SizeOfUninitializedData;
 499     uint32_t AddressOfEntryPoint; // RVA
 500     uint32_t BaseOfCode; // RVA
 501     uint32_t BaseOfData; // RVA
 502     uint32_t ImageBase;
 503     uint32_t SectionAlignment;
 504     uint32_t FileAlignment;
 505     uint16_t MajorOperatingSystemVersion;
 506     uint16_t MinorOperatingSystemVersion;
 507     uint16_t MajorImageVersion;
 508     uint16_t MinorImageVersion;
 509     uint16_t MajorSubsystemVersion;
 510     uint16_t MinorSubsystemVersion;
 511     uint32_t Win32VersionValue;
 512     uint32_t SizeOfImage;
 513     uint32_t SizeOfHeaders;
 514     uint32_t CheckSum;
 515     uint16_t Subsystem;
 516     // FIXME: This should be DllCharacteristics to match the COFF spec.
 517     uint16_t DLLCharacteristics;
 518     uint32_t SizeOfStackReserve;
 519     uint32_t SizeOfStackCommit;
 520     uint32_t SizeOfHeapReserve;
 521     uint32_t SizeOfHeapCommit;
 522     uint32_t LoaderFlags;
 523     // FIXME: This should be NumberOfRvaAndSizes to match the COFF spec.
 524     uint32_t NumberOfRvaAndSize;
 525   };
 526
 527   struct DataDirectory {
 528     uint32_t RelativeVirtualAddress;
 529     uint32_t Size;
 530   };
 531
 532   enum DataDirectoryIndex {
 533     EXPORT_TABLE = 0,
 534     IMPORT_TABLE,
 535     RESOURCE_TABLE,
 536     EXCEPTION_TABLE,
 537     CERTIFICATE_TABLE,
 538     BASE_RELOCATION_TABLE,
 539     DEBUG,
 540     ARCHITECTURE,
 541     GLOBAL_PTR,
 542     TLS_TABLE,
 543     LOAD_CONFIG_TABLE,
 544     BOUND_IMPORT,
 545     IAT,
 546     DELAY_IMPORT_DESCRIPTOR,
 547     CLR_RUNTIME_HEADER,
 548
 549     NUM_DATA_DIRECTORIES
 550   };
 551
 552   enum WindowsSubsystem {
 553     IMAGE_SUBSYSTEM_UNKNOWN = 0, ///< An unknown subsystem.
 554     IMAGE_SUBSYSTEM_NATIVE = 1, ///< Device drivers and native Windows processes
 555     IMAGE_SUBSYSTEM_WINDOWS_GUI = 2, ///< The Windows GUI subsystem.
 556     IMAGE_SUBSYSTEM_WINDOWS_CUI = 3, ///< The Windows character subsystem.
 557     IMAGE_SUBSYSTEM_OS2_CUI = 5, ///< The OS/2 character subsytem.
 558     IMAGE_SUBSYSTEM_POSIX_CUI = 7, ///< The POSIX character subsystem.
 559     IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8, ///< Native Windows 9x driver.
 560     IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9, ///< Windows CE.
 561     IMAGE_SUBSYSTEM_EFI_APPLICATION = 10, ///< An EFI application.
 562     IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11, ///< An EFI driver with boot
 563                                                   ///  services.
 564     IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12, ///< An EFI driver with run-time
 565                                              ///  services.
 566     IMAGE_SUBSYSTEM_EFI_ROM = 13, ///< An EFI ROM image.
 567     IMAGE_SUBSYSTEM_XBOX = 14, ///< XBOX.
 568     IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16 ///< A BCD application.
 569   };
 570
 571   enum DLLCharacteristics {
 572     /// ASLR with 64 bit address space.
 573     IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,
 574     /// DLL can be relocated at load time.
 575     IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE = 0x0040,
 576     /// Code integrity checks are enforced.
 577     IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY = 0x0080,
 578     ///< Image is NX compatible.
 579     IMAGE_DLL_CHARACTERISTICS_NX_COMPAT = 0x0100,
 580     /// Isolation aware, but do not isolate the image.
 581     IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION = 0x0200,
 582     /// Does not use structured exception handling (SEH). No SEH handler may be
 583     /// called in this image.
 584     IMAGE_DLL_CHARACTERISTICS_NO_SEH = 0x0400,
 585     /// Do not bind the image.
 586     IMAGE_DLL_CHARACTERISTICS_NO_BIND = 0x0800,
 587     ///< Image should execute in an AppContainer.
 588     IMAGE_DLL_CHARACTERISTICS_APPCONTAINER = 0x1000,
 589     ///< A WDM driver.
 590     IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER = 0x2000,
 591     ///< Image supports Control Flow Guard.
 592     IMAGE_DLL_CHARACTERISTICS_GUARD_CF = 0x4000,
 593     /// Terminal Server aware.
 594     IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
 595   };
 596
 597   enum DebugType {
 598     IMAGE_DEBUG_TYPE_UNKNOWN       = 0,
 599     IMAGE_DEBUG_TYPE_COFF          = 1,
 600     IMAGE_DEBUG_TYPE_CODEVIEW      = 2,
 601     IMAGE_DEBUG_TYPE_FPO           = 3,
 602     IMAGE_DEBUG_TYPE_MISC          = 4,
 603     IMAGE_DEBUG_TYPE_EXCEPTION     = 5,
 604     IMAGE_DEBUG_TYPE_FIXUP         = 6,
 605     IMAGE_DEBUG_TYPE_OMAP_TO_SRC   = 7,
 606     IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8,
 607     IMAGE_DEBUG_TYPE_BORLAND       = 9,
 608     IMAGE_DEBUG_TYPE_CLSID         = 11
 609   };
 610
 611   enum BaseRelocationType {
 612     IMAGE_REL_BASED_ABSOLUTE       = 0,
 613     IMAGE_REL_BASED_HIGH           = 1,
 614     IMAGE_REL_BASED_LOW            = 2,
 615     IMAGE_REL_BASED_HIGHLOW        = 3,
 616     IMAGE_REL_BASED_HIGHADJ        = 4,
 617     IMAGE_REL_BASED_MIPS_JMPADDR   = 5,
 618     IMAGE_REL_BASED_ARM_MOV32A     = 5,
 619     IMAGE_REL_BASED_ARM_MOV32T     = 7,
 620     IMAGE_REL_BASED_MIPS_JMPADDR16 = 9,
 621     IMAGE_REL_BASED_DIR64          = 10
 622   };
 623
 624   enum ImportType {
 625     IMPORT_CODE  = 0,
 626     IMPORT_DATA  = 1,
 627     IMPORT_CONST = 2
 628   };
 629
 630   enum ImportNameType {
 631     /// Import is by ordinal. This indicates that the value in the Ordinal/Hint
 632     /// field of the import header is the import's ordinal. If this constant is
 633     /// not specified, then the Ordinal/Hint field should always be interpreted
 634     /// as the import's hint.
 635     IMPORT_ORDINAL         = 0,
 636     /// The import name is identical to the public symbol name
 637     IMPORT_NAME            = 1,
 638     /// The import name is the public symbol name, but skipping the leading ?,
 639     /// @, or optionally _.
 640     IMPORT_NAME_NOPREFIX   = 2,
 641     /// The import name is the public symbol name, but skipping the leading ?,
 642     /// @, or optionally _, and truncating at the first @.
 643     IMPORT_NAME_UNDECORATE = 3
 644   };
 645
 646   struct ImportHeader {
 647     uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
 648     uint16_t Sig2; ///< Must be 0xFFFF.
 649     uint16_t Version;
 650     uint16_t Machine;
 651     uint32_t TimeDateStamp;
 652     uint32_t SizeOfData;
 653     uint16_t OrdinalHint;
 654     uint16_t TypeInfo;
 655
 656     ImportType getType() const {
 657       return static_cast<ImportType>(TypeInfo & 0x3);
 658     }
 659
 660     ImportNameType getNameType() const {
 661       return static_cast<ImportNameType>((TypeInfo & 0x1C) >> 3);
 662     }
 663   };
 664
 665   enum CodeViewIdentifiers {
 666     DEBUG_SECTION_MAGIC = 0x4,
 667     DEBUG_SYMBOL_SUBSECTION = 0xF1,
 668     DEBUG_LINE_TABLE_SUBSECTION = 0xF2,
 669     DEBUG_STRING_TABLE_SUBSECTION = 0xF3,
 670     DEBUG_INDEX_SUBSECTION = 0xF4,
 671
 672     // Symbol subsections are split into records of different types.
 673     DEBUG_SYMBOL_TYPE_PROC_START = 0x1147,
 674     DEBUG_SYMBOL_TYPE_PROC_END = 0x114F
 675   };
 676
 677   inline bool isReservedSectionNumber(int32_t SectionNumber) {
 678     return SectionNumber <= 0;
 679   }
 680
 681 } // End namespace COFF.
 682 } // End namespace llvm.
 683
 684 #endif