1 //===-- llvm/BinaryFormat/COFF.h --------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains an definitions used in Windows COFF Files.
12 // Structures and enums defined within this file where created using
13 // information from Microsoft's publicly available PE/COFF format document:
15 // Microsoft Portable Executable and Common Object File Format Specification
16 // Revision 8.1 - February 15, 2008
18 // As of 5/2/2010, hosted by Microsoft at:
19 // http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx
21 //===----------------------------------------------------------------------===//
23 #ifndef LLVM_BINARYFORMAT_COFF_H
24 #define LLVM_BINARYFORMAT_COFF_H
26 #include "llvm/Support/DataTypes.h"
33 // The maximum number of sections that a COFF object can have (inclusive).
34 const int32_t MaxNumberOfSections16 = 65279;
36 // The PE signature bytes that follows the DOS stub header.
37 static const char PEMagic[] = {'P', 'E', '\0', '\0'};
39 static const char BigObjMagic[] = {
40 '\xc7', '\xa1', '\xba', '\xd1', '\xee', '\xba', '\xa9', '\x4b',
41 '\xaf', '\x20', '\xfa', '\xf6', '\x6a', '\xa4', '\xdc', '\xb8',
44 static const char ClGlObjMagic[] = {
45 '\x38', '\xfe', '\xb3', '\x0c', '\xa5', '\xd9', '\xab', '\x4d',
46 '\xac', '\x9b', '\xd6', '\xb6', '\x22', '\x26', '\x53', '\xc2',
49 // The signature bytes that start a .res file.
50 static const char WinResMagic[] = {
51 '\x00', '\x00', '\x00', '\x00', '\x20', '\x00', '\x00', '\x00',
52 '\xff', '\xff', '\x00', '\x00', '\xff', '\xff', '\x00', '\x00',
55 // Sizes in bytes of various things in the COFF format.
68 int32_t NumberOfSections;
69 uint32_t TimeDateStamp;
70 uint32_t PointerToSymbolTable;
71 uint32_t NumberOfSymbols;
72 uint16_t SizeOfOptionalHeader;
73 uint16_t Characteristics;
77 enum : uint16_t { MinBigObjectVersion = 2 };
79 uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
80 uint16_t Sig2; ///< Must be 0xFFFF.
83 uint32_t TimeDateStamp;
89 uint32_t NumberOfSections;
90 uint32_t PointerToSymbolTable;
91 uint32_t NumberOfSymbols;
94 enum MachineTypes : unsigned {
97 IMAGE_FILE_MACHINE_UNKNOWN = 0x0,
98 IMAGE_FILE_MACHINE_AM33 = 0x1D3,
99 IMAGE_FILE_MACHINE_AMD64 = 0x8664,
100 IMAGE_FILE_MACHINE_ARM = 0x1C0,
101 IMAGE_FILE_MACHINE_ARMNT = 0x1C4,
102 IMAGE_FILE_MACHINE_ARM64 = 0xAA64,
103 IMAGE_FILE_MACHINE_EBC = 0xEBC,
104 IMAGE_FILE_MACHINE_I386 = 0x14C,
105 IMAGE_FILE_MACHINE_IA64 = 0x200,
106 IMAGE_FILE_MACHINE_M32R = 0x9041,
107 IMAGE_FILE_MACHINE_MIPS16 = 0x266,
108 IMAGE_FILE_MACHINE_MIPSFPU = 0x366,
109 IMAGE_FILE_MACHINE_MIPSFPU16 = 0x466,
110 IMAGE_FILE_MACHINE_POWERPC = 0x1F0,
111 IMAGE_FILE_MACHINE_POWERPCFP = 0x1F1,
112 IMAGE_FILE_MACHINE_R4000 = 0x166,
113 IMAGE_FILE_MACHINE_SH3 = 0x1A2,
114 IMAGE_FILE_MACHINE_SH3DSP = 0x1A3,
115 IMAGE_FILE_MACHINE_SH4 = 0x1A6,
116 IMAGE_FILE_MACHINE_SH5 = 0x1A8,
117 IMAGE_FILE_MACHINE_THUMB = 0x1C2,
118 IMAGE_FILE_MACHINE_WCEMIPSV2 = 0x169
121 enum Characteristics : unsigned {
124 /// The file does not contain base relocations and must be loaded at its
125 /// preferred base. If this cannot be done, the loader will error.
126 IMAGE_FILE_RELOCS_STRIPPED = 0x0001,
127 /// The file is valid and can be run.
128 IMAGE_FILE_EXECUTABLE_IMAGE = 0x0002,
129 /// COFF line numbers have been stripped. This is deprecated and should be
131 IMAGE_FILE_LINE_NUMS_STRIPPED = 0x0004,
132 /// COFF symbol table entries for local symbols have been removed. This is
133 /// deprecated and should be 0.
134 IMAGE_FILE_LOCAL_SYMS_STRIPPED = 0x0008,
135 /// Aggressively trim working set. This is deprecated and must be 0.
136 IMAGE_FILE_AGGRESSIVE_WS_TRIM = 0x0010,
137 /// Image can handle > 2GiB addresses.
138 IMAGE_FILE_LARGE_ADDRESS_AWARE = 0x0020,
139 /// Little endian: the LSB precedes the MSB in memory. This is deprecated
141 IMAGE_FILE_BYTES_REVERSED_LO = 0x0080,
142 /// Machine is based on a 32bit word architecture.
143 IMAGE_FILE_32BIT_MACHINE = 0x0100,
144 /// Debugging info has been removed.
145 IMAGE_FILE_DEBUG_STRIPPED = 0x0200,
146 /// If the image is on removable media, fully load it and copy it to swap.
147 IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400,
148 /// If the image is on network media, fully load it and copy it to swap.
149 IMAGE_FILE_NET_RUN_FROM_SWAP = 0x0800,
150 /// The image file is a system file, not a user program.
151 IMAGE_FILE_SYSTEM = 0x1000,
152 /// The image file is a DLL.
153 IMAGE_FILE_DLL = 0x2000,
154 /// This file should only be run on a uniprocessor machine.
155 IMAGE_FILE_UP_SYSTEM_ONLY = 0x4000,
156 /// Big endian: the MSB precedes the LSB in memory. This is deprecated
158 IMAGE_FILE_BYTES_REVERSED_HI = 0x8000
161 enum ResourceTypeID : unsigned {
172 RID_MessageTable = 11,
173 RID_Group_Cursor = 12,
188 int32_t SectionNumber;
190 uint8_t StorageClass;
191 uint8_t NumberOfAuxSymbols;
194 enum SymbolSectionNumber : int32_t {
195 IMAGE_SYM_DEBUG = -2,
196 IMAGE_SYM_ABSOLUTE = -1,
197 IMAGE_SYM_UNDEFINED = 0
200 /// Storage class tells where and what the symbol represents
201 enum SymbolStorageClass {
204 IMAGE_SYM_CLASS_END_OF_FUNCTION = -1, ///< Physical end of function
205 IMAGE_SYM_CLASS_NULL = 0, ///< No symbol
206 IMAGE_SYM_CLASS_AUTOMATIC = 1, ///< Stack variable
207 IMAGE_SYM_CLASS_EXTERNAL = 2, ///< External symbol
208 IMAGE_SYM_CLASS_STATIC = 3, ///< Static
209 IMAGE_SYM_CLASS_REGISTER = 4, ///< Register variable
210 IMAGE_SYM_CLASS_EXTERNAL_DEF = 5, ///< External definition
211 IMAGE_SYM_CLASS_LABEL = 6, ///< Label
212 IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7, ///< Undefined label
213 IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8, ///< Member of structure
214 IMAGE_SYM_CLASS_ARGUMENT = 9, ///< Function argument
215 IMAGE_SYM_CLASS_STRUCT_TAG = 10, ///< Structure tag
216 IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11, ///< Member of union
217 IMAGE_SYM_CLASS_UNION_TAG = 12, ///< Union tag
218 IMAGE_SYM_CLASS_TYPE_DEFINITION = 13, ///< Type definition
219 IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14, ///< Undefined static
220 IMAGE_SYM_CLASS_ENUM_TAG = 15, ///< Enumeration tag
221 IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16, ///< Member of enumeration
222 IMAGE_SYM_CLASS_REGISTER_PARAM = 17, ///< Register parameter
223 IMAGE_SYM_CLASS_BIT_FIELD = 18, ///< Bit field
224 /// ".bb" or ".eb" - beginning or end of block
225 IMAGE_SYM_CLASS_BLOCK = 100,
226 /// ".bf" or ".ef" - beginning or end of function
227 IMAGE_SYM_CLASS_FUNCTION = 101,
228 IMAGE_SYM_CLASS_END_OF_STRUCT = 102, ///< End of structure
229 IMAGE_SYM_CLASS_FILE = 103, ///< File name
230 /// Line number, reformatted as symbol
231 IMAGE_SYM_CLASS_SECTION = 104,
232 IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105, ///< Duplicate tag
233 /// External symbol in dmert public lib
234 IMAGE_SYM_CLASS_CLR_TOKEN = 107
237 enum SymbolBaseType : unsigned {
238 IMAGE_SYM_TYPE_NULL = 0, ///< No type information or unknown base type.
239 IMAGE_SYM_TYPE_VOID = 1, ///< Used with void pointers and functions.
240 IMAGE_SYM_TYPE_CHAR = 2, ///< A character (signed byte).
241 IMAGE_SYM_TYPE_SHORT = 3, ///< A 2-byte signed integer.
242 IMAGE_SYM_TYPE_INT = 4, ///< A natural integer type on the target.
243 IMAGE_SYM_TYPE_LONG = 5, ///< A 4-byte signed integer.
244 IMAGE_SYM_TYPE_FLOAT = 6, ///< A 4-byte floating-point number.
245 IMAGE_SYM_TYPE_DOUBLE = 7, ///< An 8-byte floating-point number.
246 IMAGE_SYM_TYPE_STRUCT = 8, ///< A structure.
247 IMAGE_SYM_TYPE_UNION = 9, ///< An union.
248 IMAGE_SYM_TYPE_ENUM = 10, ///< An enumerated type.
249 IMAGE_SYM_TYPE_MOE = 11, ///< A member of enumeration (a specific value).
250 IMAGE_SYM_TYPE_BYTE = 12, ///< A byte; unsigned 1-byte integer.
251 IMAGE_SYM_TYPE_WORD = 13, ///< A word; unsigned 2-byte integer.
252 IMAGE_SYM_TYPE_UINT = 14, ///< An unsigned integer of natural size.
253 IMAGE_SYM_TYPE_DWORD = 15 ///< An unsigned 4-byte integer.
256 enum SymbolComplexType : unsigned {
257 IMAGE_SYM_DTYPE_NULL = 0, ///< No complex type; simple scalar variable.
258 IMAGE_SYM_DTYPE_POINTER = 1, ///< A pointer to base type.
259 IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
260 IMAGE_SYM_DTYPE_ARRAY = 3, ///< An array of base type.
262 /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
263 SCT_COMPLEX_TYPE_SHIFT = 4
266 enum AuxSymbolType { IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF = 1 };
270 uint32_t VirtualSize;
271 uint32_t VirtualAddress;
272 uint32_t SizeOfRawData;
273 uint32_t PointerToRawData;
274 uint32_t PointerToRelocations;
275 uint32_t PointerToLineNumbers;
276 uint16_t NumberOfRelocations;
277 uint16_t NumberOfLineNumbers;
278 uint32_t Characteristics;
281 enum SectionCharacteristics : uint32_t {
282 SC_Invalid = 0xffffffff,
284 IMAGE_SCN_TYPE_NOLOAD = 0x00000002,
285 IMAGE_SCN_TYPE_NO_PAD = 0x00000008,
286 IMAGE_SCN_CNT_CODE = 0x00000020,
287 IMAGE_SCN_CNT_INITIALIZED_DATA = 0x00000040,
288 IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
289 IMAGE_SCN_LNK_OTHER = 0x00000100,
290 IMAGE_SCN_LNK_INFO = 0x00000200,
291 IMAGE_SCN_LNK_REMOVE = 0x00000800,
292 IMAGE_SCN_LNK_COMDAT = 0x00001000,
293 IMAGE_SCN_GPREL = 0x00008000,
294 IMAGE_SCN_MEM_PURGEABLE = 0x00020000,
295 IMAGE_SCN_MEM_16BIT = 0x00020000,
296 IMAGE_SCN_MEM_LOCKED = 0x00040000,
297 IMAGE_SCN_MEM_PRELOAD = 0x00080000,
298 IMAGE_SCN_ALIGN_1BYTES = 0x00100000,
299 IMAGE_SCN_ALIGN_2BYTES = 0x00200000,
300 IMAGE_SCN_ALIGN_4BYTES = 0x00300000,
301 IMAGE_SCN_ALIGN_8BYTES = 0x00400000,
302 IMAGE_SCN_ALIGN_16BYTES = 0x00500000,
303 IMAGE_SCN_ALIGN_32BYTES = 0x00600000,
304 IMAGE_SCN_ALIGN_64BYTES = 0x00700000,
305 IMAGE_SCN_ALIGN_128BYTES = 0x00800000,
306 IMAGE_SCN_ALIGN_256BYTES = 0x00900000,
307 IMAGE_SCN_ALIGN_512BYTES = 0x00A00000,
308 IMAGE_SCN_ALIGN_1024BYTES = 0x00B00000,
309 IMAGE_SCN_ALIGN_2048BYTES = 0x00C00000,
310 IMAGE_SCN_ALIGN_4096BYTES = 0x00D00000,
311 IMAGE_SCN_ALIGN_8192BYTES = 0x00E00000,
312 IMAGE_SCN_LNK_NRELOC_OVFL = 0x01000000,
313 IMAGE_SCN_MEM_DISCARDABLE = 0x02000000,
314 IMAGE_SCN_MEM_NOT_CACHED = 0x04000000,
315 IMAGE_SCN_MEM_NOT_PAGED = 0x08000000,
316 IMAGE_SCN_MEM_SHARED = 0x10000000,
317 IMAGE_SCN_MEM_EXECUTE = 0x20000000,
318 IMAGE_SCN_MEM_READ = 0x40000000,
319 IMAGE_SCN_MEM_WRITE = 0x80000000
323 uint32_t VirtualAddress;
324 uint32_t SymbolTableIndex;
328 enum RelocationTypeI386 : unsigned {
329 IMAGE_REL_I386_ABSOLUTE = 0x0000,
330 IMAGE_REL_I386_DIR16 = 0x0001,
331 IMAGE_REL_I386_REL16 = 0x0002,
332 IMAGE_REL_I386_DIR32 = 0x0006,
333 IMAGE_REL_I386_DIR32NB = 0x0007,
334 IMAGE_REL_I386_SEG12 = 0x0009,
335 IMAGE_REL_I386_SECTION = 0x000A,
336 IMAGE_REL_I386_SECREL = 0x000B,
337 IMAGE_REL_I386_TOKEN = 0x000C,
338 IMAGE_REL_I386_SECREL7 = 0x000D,
339 IMAGE_REL_I386_REL32 = 0x0014
342 enum RelocationTypeAMD64 : unsigned {
343 IMAGE_REL_AMD64_ABSOLUTE = 0x0000,
344 IMAGE_REL_AMD64_ADDR64 = 0x0001,
345 IMAGE_REL_AMD64_ADDR32 = 0x0002,
346 IMAGE_REL_AMD64_ADDR32NB = 0x0003,
347 IMAGE_REL_AMD64_REL32 = 0x0004,
348 IMAGE_REL_AMD64_REL32_1 = 0x0005,
349 IMAGE_REL_AMD64_REL32_2 = 0x0006,
350 IMAGE_REL_AMD64_REL32_3 = 0x0007,
351 IMAGE_REL_AMD64_REL32_4 = 0x0008,
352 IMAGE_REL_AMD64_REL32_5 = 0x0009,
353 IMAGE_REL_AMD64_SECTION = 0x000A,
354 IMAGE_REL_AMD64_SECREL = 0x000B,
355 IMAGE_REL_AMD64_SECREL7 = 0x000C,
356 IMAGE_REL_AMD64_TOKEN = 0x000D,
357 IMAGE_REL_AMD64_SREL32 = 0x000E,
358 IMAGE_REL_AMD64_PAIR = 0x000F,
359 IMAGE_REL_AMD64_SSPAN32 = 0x0010
362 enum RelocationTypesARM : unsigned {
363 IMAGE_REL_ARM_ABSOLUTE = 0x0000,
364 IMAGE_REL_ARM_ADDR32 = 0x0001,
365 IMAGE_REL_ARM_ADDR32NB = 0x0002,
366 IMAGE_REL_ARM_BRANCH24 = 0x0003,
367 IMAGE_REL_ARM_BRANCH11 = 0x0004,
368 IMAGE_REL_ARM_TOKEN = 0x0005,
369 IMAGE_REL_ARM_BLX24 = 0x0008,
370 IMAGE_REL_ARM_BLX11 = 0x0009,
371 IMAGE_REL_ARM_SECTION = 0x000E,
372 IMAGE_REL_ARM_SECREL = 0x000F,
373 IMAGE_REL_ARM_MOV32A = 0x0010,
374 IMAGE_REL_ARM_MOV32T = 0x0011,
375 IMAGE_REL_ARM_BRANCH20T = 0x0012,
376 IMAGE_REL_ARM_BRANCH24T = 0x0014,
377 IMAGE_REL_ARM_BLX23T = 0x0015
380 enum RelocationTypesARM64 : unsigned {
381 IMAGE_REL_ARM64_ABSOLUTE = 0x0000,
382 IMAGE_REL_ARM64_ADDR32 = 0x0001,
383 IMAGE_REL_ARM64_ADDR32NB = 0x0002,
384 IMAGE_REL_ARM64_BRANCH26 = 0x0003,
385 IMAGE_REL_ARM64_PAGEBASE_REL21 = 0x0004,
386 IMAGE_REL_ARM64_REL21 = 0x0005,
387 IMAGE_REL_ARM64_PAGEOFFSET_12A = 0x0006,
388 IMAGE_REL_ARM64_PAGEOFFSET_12L = 0x0007,
389 IMAGE_REL_ARM64_SECREL = 0x0008,
390 IMAGE_REL_ARM64_SECREL_LOW12A = 0x0009,
391 IMAGE_REL_ARM64_SECREL_HIGH12A = 0x000A,
392 IMAGE_REL_ARM64_SECREL_LOW12L = 0x000B,
393 IMAGE_REL_ARM64_TOKEN = 0x000C,
394 IMAGE_REL_ARM64_SECTION = 0x000D,
395 IMAGE_REL_ARM64_ADDR64 = 0x000E,
396 IMAGE_REL_ARM64_BRANCH19 = 0x000F,
397 IMAGE_REL_ARM64_BRANCH14 = 0x0010,
400 enum COMDATType : unsigned {
401 IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
402 IMAGE_COMDAT_SELECT_ANY,
403 IMAGE_COMDAT_SELECT_SAME_SIZE,
404 IMAGE_COMDAT_SELECT_EXACT_MATCH,
405 IMAGE_COMDAT_SELECT_ASSOCIATIVE,
406 IMAGE_COMDAT_SELECT_LARGEST,
407 IMAGE_COMDAT_SELECT_NEWEST
410 // Auxiliary Symbol Formats
411 struct AuxiliaryFunctionDefinition {
414 uint32_t PointerToLinenumber;
415 uint32_t PointerToNextFunction;
419 struct AuxiliarybfAndefSymbol {
423 uint32_t PointerToNextFunction;
427 struct AuxiliaryWeakExternal {
429 uint32_t Characteristics;
433 enum WeakExternalCharacteristics : unsigned {
434 IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1,
435 IMAGE_WEAK_EXTERN_SEARCH_LIBRARY = 2,
436 IMAGE_WEAK_EXTERN_SEARCH_ALIAS = 3
439 struct AuxiliarySectionDefinition {
441 uint16_t NumberOfRelocations;
442 uint16_t NumberOfLinenumbers;
449 struct AuxiliaryCLRToken {
452 uint32_t SymbolTableIndex;
457 AuxiliaryFunctionDefinition FunctionDefinition;
458 AuxiliarybfAndefSymbol bfAndefSymbol;
459 AuxiliaryWeakExternal WeakExternal;
460 AuxiliarySectionDefinition SectionDefinition;
463 /// @brief The Import Directory Table.
465 /// There is a single array of these and one entry per imported DLL.
466 struct ImportDirectoryTableEntry {
467 uint32_t ImportLookupTableRVA;
468 uint32_t TimeDateStamp;
469 uint32_t ForwarderChain;
471 uint32_t ImportAddressTableRVA;
474 /// @brief The PE32 Import Lookup Table.
476 /// There is an array of these for each imported DLL. It represents either
477 /// the ordinal to import from the target DLL, or a name to lookup and import
478 /// from the target DLL.
480 /// This also happens to be the same format used by the Import Address Table
481 /// when it is initially written out to the image.
482 struct ImportLookupTableEntry32 {
485 /// @brief Is this entry specified by ordinal, or name?
486 bool isOrdinal() const { return data & 0x80000000; }
488 /// @brief Get the ordinal value of this entry. isOrdinal must be true.
489 uint16_t getOrdinal() const {
490 assert(isOrdinal() && "ILT entry is not an ordinal!");
491 return data & 0xFFFF;
494 /// @brief Set the ordinal value and set isOrdinal to true.
495 void setOrdinal(uint16_t o) {
500 /// @brief Get the Hint/Name entry RVA. isOrdinal must be false.
501 uint32_t getHintNameRVA() const {
502 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
506 /// @brief Set the Hint/Name entry RVA and set isOrdinal to false.
507 void setHintNameRVA(uint32_t rva) { data = rva; }
510 /// @brief The DOS compatible header at the front of all PEs.
513 uint16_t UsedBytesInTheLastPage;
514 uint16_t FileSizeInPages;
515 uint16_t NumberOfRelocationItems;
516 uint16_t HeaderSizeInParagraphs;
517 uint16_t MinimumExtraParagraphs;
518 uint16_t MaximumExtraParagraphs;
519 uint16_t InitialRelativeSS;
523 uint16_t InitialRelativeCS;
524 uint16_t AddressOfRelocationTable;
525 uint16_t OverlayNumber;
526 uint16_t Reserved[4];
529 uint16_t Reserved2[10];
530 uint32_t AddressOfNewExeHeader;
534 enum { PE32 = 0x10b, PE32_PLUS = 0x20b };
537 uint8_t MajorLinkerVersion;
538 uint8_t MinorLinkerVersion;
540 uint32_t SizeOfInitializedData;
541 uint32_t SizeOfUninitializedData;
542 uint32_t AddressOfEntryPoint; // RVA
543 uint32_t BaseOfCode; // RVA
544 uint32_t BaseOfData; // RVA
546 uint32_t SectionAlignment;
547 uint32_t FileAlignment;
548 uint16_t MajorOperatingSystemVersion;
549 uint16_t MinorOperatingSystemVersion;
550 uint16_t MajorImageVersion;
551 uint16_t MinorImageVersion;
552 uint16_t MajorSubsystemVersion;
553 uint16_t MinorSubsystemVersion;
554 uint32_t Win32VersionValue;
555 uint32_t SizeOfImage;
556 uint32_t SizeOfHeaders;
559 // FIXME: This should be DllCharacteristics to match the COFF spec.
560 uint16_t DLLCharacteristics;
561 uint32_t SizeOfStackReserve;
562 uint32_t SizeOfStackCommit;
563 uint32_t SizeOfHeapReserve;
564 uint32_t SizeOfHeapCommit;
565 uint32_t LoaderFlags;
566 // FIXME: This should be NumberOfRvaAndSizes to match the COFF spec.
567 uint32_t NumberOfRvaAndSize;
570 struct DataDirectory {
571 uint32_t RelativeVirtualAddress;
575 enum DataDirectoryIndex : unsigned {
581 BASE_RELOCATION_TABLE,
589 DELAY_IMPORT_DESCRIPTOR,
595 enum WindowsSubsystem : unsigned {
596 IMAGE_SUBSYSTEM_UNKNOWN = 0, ///< An unknown subsystem.
597 IMAGE_SUBSYSTEM_NATIVE = 1, ///< Device drivers and native Windows processes
598 IMAGE_SUBSYSTEM_WINDOWS_GUI = 2, ///< The Windows GUI subsystem.
599 IMAGE_SUBSYSTEM_WINDOWS_CUI = 3, ///< The Windows character subsystem.
600 IMAGE_SUBSYSTEM_OS2_CUI = 5, ///< The OS/2 character subsytem.
601 IMAGE_SUBSYSTEM_POSIX_CUI = 7, ///< The POSIX character subsystem.
602 IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8, ///< Native Windows 9x driver.
603 IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9, ///< Windows CE.
604 IMAGE_SUBSYSTEM_EFI_APPLICATION = 10, ///< An EFI application.
605 IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11, ///< An EFI driver with boot
607 IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12, ///< An EFI driver with run-time
609 IMAGE_SUBSYSTEM_EFI_ROM = 13, ///< An EFI ROM image.
610 IMAGE_SUBSYSTEM_XBOX = 14, ///< XBOX.
611 IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16 ///< A BCD application.
614 enum DLLCharacteristics : unsigned {
615 /// ASLR with 64 bit address space.
616 IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,
617 /// DLL can be relocated at load time.
618 IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE = 0x0040,
619 /// Code integrity checks are enforced.
620 IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY = 0x0080,
621 ///< Image is NX compatible.
622 IMAGE_DLL_CHARACTERISTICS_NX_COMPAT = 0x0100,
623 /// Isolation aware, but do not isolate the image.
624 IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION = 0x0200,
625 /// Does not use structured exception handling (SEH). No SEH handler may be
626 /// called in this image.
627 IMAGE_DLL_CHARACTERISTICS_NO_SEH = 0x0400,
628 /// Do not bind the image.
629 IMAGE_DLL_CHARACTERISTICS_NO_BIND = 0x0800,
630 ///< Image should execute in an AppContainer.
631 IMAGE_DLL_CHARACTERISTICS_APPCONTAINER = 0x1000,
633 IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER = 0x2000,
634 ///< Image supports Control Flow Guard.
635 IMAGE_DLL_CHARACTERISTICS_GUARD_CF = 0x4000,
636 /// Terminal Server aware.
637 IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
640 enum DebugType : unsigned {
641 IMAGE_DEBUG_TYPE_UNKNOWN = 0,
642 IMAGE_DEBUG_TYPE_COFF = 1,
643 IMAGE_DEBUG_TYPE_CODEVIEW = 2,
644 IMAGE_DEBUG_TYPE_FPO = 3,
645 IMAGE_DEBUG_TYPE_MISC = 4,
646 IMAGE_DEBUG_TYPE_EXCEPTION = 5,
647 IMAGE_DEBUG_TYPE_FIXUP = 6,
648 IMAGE_DEBUG_TYPE_OMAP_TO_SRC = 7,
649 IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8,
650 IMAGE_DEBUG_TYPE_BORLAND = 9,
651 IMAGE_DEBUG_TYPE_RESERVED10 = 10,
652 IMAGE_DEBUG_TYPE_CLSID = 11,
653 IMAGE_DEBUG_TYPE_VC_FEATURE = 12,
654 IMAGE_DEBUG_TYPE_POGO = 13,
655 IMAGE_DEBUG_TYPE_ILTCG = 14,
656 IMAGE_DEBUG_TYPE_MPX = 15,
657 IMAGE_DEBUG_TYPE_REPRO = 16,
660 enum BaseRelocationType : unsigned {
661 IMAGE_REL_BASED_ABSOLUTE = 0,
662 IMAGE_REL_BASED_HIGH = 1,
663 IMAGE_REL_BASED_LOW = 2,
664 IMAGE_REL_BASED_HIGHLOW = 3,
665 IMAGE_REL_BASED_HIGHADJ = 4,
666 IMAGE_REL_BASED_MIPS_JMPADDR = 5,
667 IMAGE_REL_BASED_ARM_MOV32A = 5,
668 IMAGE_REL_BASED_ARM_MOV32T = 7,
669 IMAGE_REL_BASED_MIPS_JMPADDR16 = 9,
670 IMAGE_REL_BASED_DIR64 = 10
673 enum ImportType : unsigned {
679 enum ImportNameType : unsigned {
680 /// Import is by ordinal. This indicates that the value in the Ordinal/Hint
681 /// field of the import header is the import's ordinal. If this constant is
682 /// not specified, then the Ordinal/Hint field should always be interpreted
683 /// as the import's hint.
685 /// The import name is identical to the public symbol name
687 /// The import name is the public symbol name, but skipping the leading ?,
688 /// @, or optionally _.
689 IMPORT_NAME_NOPREFIX = 2,
690 /// The import name is the public symbol name, but skipping the leading ?,
691 /// @, or optionally _, and truncating at the first @.
692 IMPORT_NAME_UNDECORATE = 3
695 struct ImportHeader {
696 uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
697 uint16_t Sig2; ///< Must be 0xFFFF.
700 uint32_t TimeDateStamp;
702 uint16_t OrdinalHint;
705 ImportType getType() const { return static_cast<ImportType>(TypeInfo & 0x3); }
707 ImportNameType getNameType() const {
708 return static_cast<ImportNameType>((TypeInfo & 0x1C) >> 2);
712 enum CodeViewIdentifiers {
713 DEBUG_SECTION_MAGIC = 0x4,
714 DEBUG_HASHES_SECTION_MAGIC = 0x133C9C5
717 inline bool isReservedSectionNumber(int32_t SectionNumber) {
718 return SectionNumber <= 0;
721 } // End namespace COFF.
722 } // End namespace llvm.