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 uint16_t MaxNumberOfSections16 = 65299;
  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     HeaderSize     = 20,
  47     NameSize       = 8,
  48     SymbolSize     = 18,
  49     SectionSize    = 40,
  50     RelocationSize = 10
  51   };
  52
  53   struct header {
  54     uint16_t Machine;
  55     uint16_t NumberOfSections;
  56     uint32_t TimeDateStamp;
  57     uint32_t PointerToSymbolTable;
  58     uint32_t NumberOfSymbols;
  59     uint16_t SizeOfOptionalHeader;
  60     uint16_t Characteristics;
  61   };
  62
  63   struct BigObjHeader {
  64     enum { MinBigObjectVersion = 2 };
  65
  66     uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
  67     uint16_t Sig2; ///< Must be 0xFFFF.
  68     uint16_t Version;
  69     uint16_t Machine;
  70     uint32_t TimeDateStamp;
  71     uint8_t  UUID[16];
  72     uint32_t unused1;
  73     uint32_t unused2;
  74     uint32_t unused3;
  75     uint32_t unused4;
  76     uint32_t NumberOfSections;
  77     uint32_t PointerToSymbolTable;
  78     uint32_t NumberOfSymbols;
  79   };
  80
  81   enum MachineTypes {
  82     MT_Invalid = 0xffff,
  83
  84     IMAGE_FILE_MACHINE_UNKNOWN   = 0x0,
  85     IMAGE_FILE_MACHINE_AM33      = 0x13,
  86     IMAGE_FILE_MACHINE_AMD64     = 0x8664,
  87     IMAGE_FILE_MACHINE_ARM       = 0x1C0,
  88     IMAGE_FILE_MACHINE_ARMNT     = 0x1C4,
  89     IMAGE_FILE_MACHINE_EBC       = 0xEBC,
  90     IMAGE_FILE_MACHINE_I386      = 0x14C,
  91     IMAGE_FILE_MACHINE_IA64      = 0x200,
  92     IMAGE_FILE_MACHINE_M32R      = 0x9041,
  93     IMAGE_FILE_MACHINE_MIPS16    = 0x266,
  94     IMAGE_FILE_MACHINE_MIPSFPU   = 0x366,
  95     IMAGE_FILE_MACHINE_MIPSFPU16 = 0x466,
  96     IMAGE_FILE_MACHINE_POWERPC   = 0x1F0,
  97     IMAGE_FILE_MACHINE_POWERPCFP = 0x1F1,
  98     IMAGE_FILE_MACHINE_R4000     = 0x166,
  99     IMAGE_FILE_MACHINE_SH3       = 0x1A2,
 100     IMAGE_FILE_MACHINE_SH3DSP    = 0x1A3,
 101     IMAGE_FILE_MACHINE_SH4       = 0x1A6,
 102     IMAGE_FILE_MACHINE_SH5       = 0x1A8,
 103     IMAGE_FILE_MACHINE_THUMB     = 0x1C2,
 104     IMAGE_FILE_MACHINE_WCEMIPSV2 = 0x169
 105   };
 106
 107   enum Characteristics {
 108     C_Invalid = 0,
 109
 110     /// The file does not contain base relocations and must be loaded at its
 111     /// preferred base. If this cannot be done, the loader will error.
 112     IMAGE_FILE_RELOCS_STRIPPED         = 0x0001,
 113     /// The file is valid and can be run.
 114     IMAGE_FILE_EXECUTABLE_IMAGE        = 0x0002,
 115     /// COFF line numbers have been stripped. This is deprecated and should be
 116     /// 0.
 117     IMAGE_FILE_LINE_NUMS_STRIPPED      = 0x0004,
 118     /// COFF symbol table entries for local symbols have been removed. This is
 119     /// deprecated and should be 0.
 120     IMAGE_FILE_LOCAL_SYMS_STRIPPED     = 0x0008,
 121     /// Aggressively trim working set. This is deprecated and must be 0.
 122     IMAGE_FILE_AGGRESSIVE_WS_TRIM      = 0x0010,
 123     /// Image can handle > 2GiB addresses.
 124     IMAGE_FILE_LARGE_ADDRESS_AWARE     = 0x0020,
 125     /// Little endian: the LSB precedes the MSB in memory. This is deprecated
 126     /// and should be 0.
 127     IMAGE_FILE_BYTES_REVERSED_LO       = 0x0080,
 128     /// Machine is based on a 32bit word architecture.
 129     IMAGE_FILE_32BIT_MACHINE           = 0x0100,
 130     /// Debugging info has been removed.
 131     IMAGE_FILE_DEBUG_STRIPPED          = 0x0200,
 132     /// If the image is on removable media, fully load it and copy it to swap.
 133     IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400,
 134     /// If the image is on network media, fully load it and copy it to swap.
 135     IMAGE_FILE_NET_RUN_FROM_SWAP       = 0x0800,
 136     /// The image file is a system file, not a user program.
 137     IMAGE_FILE_SYSTEM                  = 0x1000,
 138     /// The image file is a DLL.
 139     IMAGE_FILE_DLL                     = 0x2000,
 140     /// This file should only be run on a uniprocessor machine.
 141     IMAGE_FILE_UP_SYSTEM_ONLY          = 0x4000,
 142     /// Big endian: the MSB precedes the LSB in memory. This is deprecated
 143     /// and should be 0.
 144     IMAGE_FILE_BYTES_REVERSED_HI       = 0x8000
 145   };
 146
 147   struct symbol {
 148     char     Name[NameSize];
 149     uint32_t Value;
 150     uint16_t SectionNumber;
 151     uint16_t Type;
 152     uint8_t  StorageClass;
 153     uint8_t  NumberOfAuxSymbols;
 154   };
 155
 156   enum SymbolFlags {
 157     SF_TypeMask = 0x0000FFFF,
 158     SF_TypeShift = 0,
 159
 160     SF_ClassMask = 0x00FF0000,
 161     SF_ClassShift = 16,
 162
 163     SF_WeakExternal = 0x01000000
 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 AuxiliaryFile {
 394     uint8_t FileName[18];
 395   };
 396
 397   struct AuxiliarySectionDefinition {
 398     uint32_t Length;
 399     uint16_t NumberOfRelocations;
 400     uint16_t NumberOfLinenumbers;
 401     uint32_t CheckSum;
 402     uint16_t Number;
 403     uint8_t  Selection;
 404     char     unused[3];
 405   };
 406
 407   struct AuxiliaryCLRToken {
 408     uint8_t  AuxType;
 409     uint8_t  unused1;
 410     uint32_t SymbolTableIndex;
 411     char     unused2[12];
 412   };
 413
 414   union Auxiliary {
 415     AuxiliaryFunctionDefinition FunctionDefinition;
 416     AuxiliarybfAndefSymbol      bfAndefSymbol;
 417     AuxiliaryWeakExternal       WeakExternal;
 418     AuxiliaryFile               File;
 419     AuxiliarySectionDefinition  SectionDefinition;
 420   };
 421
 422   /// @brief The Import Directory Table.
 423   ///
 424   /// There is a single array of these and one entry per imported DLL.
 425   struct ImportDirectoryTableEntry {
 426     uint32_t ImportLookupTableRVA;
 427     uint32_t TimeDateStamp;
 428     uint32_t ForwarderChain;
 429     uint32_t NameRVA;
 430     uint32_t ImportAddressTableRVA;
 431   };
 432
 433   /// @brief The PE32 Import Lookup Table.
 434   ///
 435   /// There is an array of these for each imported DLL. It represents either
 436   /// the ordinal to import from the target DLL, or a name to lookup and import
 437   /// from the target DLL.
 438   ///
 439   /// This also happens to be the same format used by the Import Address Table
 440   /// when it is initially written out to the image.
 441   struct ImportLookupTableEntry32 {
 442     uint32_t data;
 443
 444     /// @brief Is this entry specified by ordinal, or name?
 445     bool isOrdinal() const { return data & 0x80000000; }
 446
 447     /// @brief Get the ordinal value of this entry. isOrdinal must be true.
 448     uint16_t getOrdinal() const {
 449       assert(isOrdinal() && "ILT entry is not an ordinal!");
 450       return data & 0xFFFF;
 451     }
 452
 453     /// @brief Set the ordinal value and set isOrdinal to true.
 454     void setOrdinal(uint16_t o) {
 455       data = o;
 456       data |= 0x80000000;
 457     }
 458
 459     /// @brief Get the Hint/Name entry RVA. isOrdinal must be false.
 460     uint32_t getHintNameRVA() const {
 461       assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
 462       return data;
 463     }
 464
 465     /// @brief Set the Hint/Name entry RVA and set isOrdinal to false.
 466     void setHintNameRVA(uint32_t rva) { data = rva; }
 467   };
 468
 469   /// @brief The DOS compatible header at the front of all PEs.
 470   struct DOSHeader {
 471     uint16_t Magic;
 472     uint16_t UsedBytesInTheLastPage;
 473     uint16_t FileSizeInPages;
 474     uint16_t NumberOfRelocationItems;
 475     uint16_t HeaderSizeInParagraphs;
 476     uint16_t MinimumExtraParagraphs;
 477     uint16_t MaximumExtraParagraphs;
 478     uint16_t InitialRelativeSS;
 479     uint16_t InitialSP;
 480     uint16_t Checksum;
 481     uint16_t InitialIP;
 482     uint16_t InitialRelativeCS;
 483     uint16_t AddressOfRelocationTable;
 484     uint16_t OverlayNumber;
 485     uint16_t Reserved[4];
 486     uint16_t OEMid;
 487     uint16_t OEMinfo;
 488     uint16_t Reserved2[10];
 489     uint32_t AddressOfNewExeHeader;
 490   };
 491
 492   struct PE32Header {
 493     enum {
 494       PE32 = 0x10b,
 495       PE32_PLUS = 0x20b
 496     };
 497
 498     uint16_t Magic;
 499     uint8_t  MajorLinkerVersion;
 500     uint8_t  MinorLinkerVersion;
 501     uint32_t SizeOfCode;
 502     uint32_t SizeOfInitializedData;
 503     uint32_t SizeOfUninitializedData;
 504     uint32_t AddressOfEntryPoint; // RVA
 505     uint32_t BaseOfCode; // RVA
 506     uint32_t BaseOfData; // RVA
 507     uint32_t ImageBase;
 508     uint32_t SectionAlignment;
 509     uint32_t FileAlignment;
 510     uint16_t MajorOperatingSystemVersion;
 511     uint16_t MinorOperatingSystemVersion;
 512     uint16_t MajorImageVersion;
 513     uint16_t MinorImageVersion;
 514     uint16_t MajorSubsystemVersion;
 515     uint16_t MinorSubsystemVersion;
 516     uint32_t Win32VersionValue;
 517     uint32_t SizeOfImage;
 518     uint32_t SizeOfHeaders;
 519     uint32_t CheckSum;
 520     uint16_t Subsystem;
 521     uint16_t DLLCharacteristics;
 522     uint32_t SizeOfStackReserve;
 523     uint32_t SizeOfStackCommit;
 524     uint32_t SizeOfHeapReserve;
 525     uint32_t SizeOfHeapCommit;
 526     uint32_t LoaderFlags;
 527     uint32_t NumberOfRvaAndSize;
 528   };
 529
 530   struct DataDirectory {
 531     uint32_t RelativeVirtualAddress;
 532     uint32_t Size;
 533   };
 534
 535   enum DataDirectoryIndex {
 536     EXPORT_TABLE = 0,
 537     IMPORT_TABLE,
 538     RESOURCE_TABLE,
 539     EXCEPTION_TABLE,
 540     CERTIFICATE_TABLE,
 541     BASE_RELOCATION_TABLE,
 542     DEBUG,
 543     ARCHITECTURE,
 544     GLOBAL_PTR,
 545     TLS_TABLE,
 546     LOAD_CONFIG_TABLE,
 547     BOUND_IMPORT,
 548     IAT,
 549     DELAY_IMPORT_DESCRIPTOR,
 550     CLR_RUNTIME_HEADER
 551   };
 552
 553   enum WindowsSubsystem {
 554     IMAGE_SUBSYSTEM_UNKNOWN = 0, ///< An unknown subsystem.
 555     IMAGE_SUBSYSTEM_NATIVE = 1, ///< Device drivers and native Windows processes
 556     IMAGE_SUBSYSTEM_WINDOWS_GUI = 2, ///< The Windows GUI subsystem.
 557     IMAGE_SUBSYSTEM_WINDOWS_CUI = 3, ///< The Windows character subsystem.
 558     IMAGE_SUBSYSTEM_OS2_CUI = 5, ///< The OS/2 character subsytem.
 559     IMAGE_SUBSYSTEM_POSIX_CUI = 7, ///< The POSIX character subsystem.
 560     IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8, ///< Native Windows 9x driver.
 561     IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9, ///< Windows CE.
 562     IMAGE_SUBSYSTEM_EFI_APPLICATION = 10, ///< An EFI application.
 563     IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11, ///< An EFI driver with boot
 564                                                   ///  services.
 565     IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12, ///< An EFI driver with run-time
 566                                              ///  services.
 567     IMAGE_SUBSYSTEM_EFI_ROM = 13, ///< An EFI ROM image.
 568     IMAGE_SUBSYSTEM_XBOX = 14, ///< XBOX.
 569     IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16 ///< A BCD application.
 570   };
 571
 572   enum DLLCharacteristics {
 573     /// ASLR with 64 bit address space.
 574     IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,
 575     /// DLL can be relocated at load time.
 576     IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE = 0x0040,
 577     /// Code integrity checks are enforced.
 578     IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY = 0x0080,
 579     ///< Image is NX compatible.
 580     IMAGE_DLL_CHARACTERISTICS_NX_COMPAT = 0x0100,
 581     /// Isolation aware, but do not isolate the image.
 582     IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION = 0x0200,
 583     /// Does not use structured exception handling (SEH). No SEH handler may be
 584     /// called in this image.
 585     IMAGE_DLL_CHARACTERISTICS_NO_SEH = 0x0400,
 586     /// Do not bind the image.
 587     IMAGE_DLL_CHARACTERISTICS_NO_BIND = 0x0800,
 588     ///< Image should execute in an AppContainer.
 589     IMAGE_DLL_CHARACTERISTICS_APPCONTAINER = 0x1000,
 590     ///< A WDM driver.
 591     IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER = 0x2000,
 592     ///< Image supports Control Flow Guard.
 593     IMAGE_DLL_CHARACTERISTICS_GUARD_CF = 0x4000,
 594     /// Terminal Server aware.
 595     IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
 596   };
 597
 598   enum DebugType {
 599     IMAGE_DEBUG_TYPE_UNKNOWN       = 0,
 600     IMAGE_DEBUG_TYPE_COFF          = 1,
 601     IMAGE_DEBUG_TYPE_CODEVIEW      = 2,
 602     IMAGE_DEBUG_TYPE_FPO           = 3,
 603     IMAGE_DEBUG_TYPE_MISC          = 4,
 604     IMAGE_DEBUG_TYPE_EXCEPTION     = 5,
 605     IMAGE_DEBUG_TYPE_FIXUP         = 6,
 606     IMAGE_DEBUG_TYPE_OMAP_TO_SRC   = 7,
 607     IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8,
 608     IMAGE_DEBUG_TYPE_BORLAND       = 9,
 609     IMAGE_DEBUG_TYPE_CLSID         = 11
 610   };
 611
 612   enum BaseRelocationType {
 613     IMAGE_REL_BASED_ABSOLUTE       = 0,
 614     IMAGE_REL_BASED_HIGH           = 1,
 615     IMAGE_REL_BASED_LOW            = 2,
 616     IMAGE_REL_BASED_HIGHLOW        = 3,
 617     IMAGE_REL_BASED_HIGHADJ        = 4,
 618     IMAGE_REL_BASED_MIPS_JMPADDR   = 5,
 619     IMAGE_REL_BASED_ARM_MOV32A     = 5,
 620     IMAGE_REL_BASED_ARM_MOV32T     = 7,
 621     IMAGE_REL_BASED_MIPS_JMPADDR16 = 9,
 622     IMAGE_REL_BASED_DIR64          = 10
 623   };
 624
 625   enum ImportType {
 626     IMPORT_CODE  = 0,
 627     IMPORT_DATA  = 1,
 628     IMPORT_CONST = 2
 629   };
 630
 631   enum ImportNameType {
 632     /// Import is by ordinal. This indicates that the value in the Ordinal/Hint
 633     /// field of the import header is the import's ordinal. If this constant is
 634     /// not specified, then the Ordinal/Hint field should always be interpreted
 635     /// as the import's hint.
 636     IMPORT_ORDINAL         = 0,
 637     /// The import name is identical to the public symbol name
 638     IMPORT_NAME            = 1,
 639     /// The import name is the public symbol name, but skipping the leading ?,
 640     /// @, or optionally _.
 641     IMPORT_NAME_NOPREFIX   = 2,
 642     /// The import name is the public symbol name, but skipping the leading ?,
 643     /// @, or optionally _, and truncating at the first @.
 644     IMPORT_NAME_UNDECORATE = 3
 645   };
 646
 647   struct ImportHeader {
 648     uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
 649     uint16_t Sig2; ///< Must be 0xFFFF.
 650     uint16_t Version;
 651     uint16_t Machine;
 652     uint32_t TimeDateStamp;
 653     uint32_t SizeOfData;
 654     uint16_t OrdinalHint;
 655     uint16_t TypeInfo;
 656
 657     ImportType getType() const {
 658       return static_cast<ImportType>(TypeInfo & 0x3);
 659     }
 660
 661     ImportNameType getNameType() const {
 662       return static_cast<ImportNameType>((TypeInfo & 0x1C) >> 3);
 663     }
 664   };
 665
 666   enum CodeViewLineTableIdentifiers {
 667     DEBUG_SECTION_MAGIC           = 0x4,
 668     DEBUG_LINE_TABLE_SUBSECTION   = 0xF2,
 669     DEBUG_STRING_TABLE_SUBSECTION = 0xF3,
 670     DEBUG_INDEX_SUBSECTION        = 0xF4
 671   };
 672
 673   inline bool isReservedSectionNumber(int32_t SectionNumber) {
 674     return SectionNumber <= 0;
 675   }
 676
 677 } // End namespace COFF.
 678 } // End namespace llvm.
 679
 680 #endif