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