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