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 #include <cstring>
28
29 namespace llvm {
30 namespace COFF {
31
32 // The maximum number of sections that a COFF object can have (inclusive).
33 const int32_t MaxNumberOfSections16 = 65279;
34
35 // The PE signature bytes that follows the DOS stub header.
36 static const char PEMagic[] = {'P', 'E', '\0', '\0'};
37
38 static const char BigObjMagic[] = {
39 '\xc7', '\xa1', '\xba', '\xd1', '\xee', '\xba', '\xa9', '\x4b',
40 '\xaf', '\x20', '\xfa', '\xf6', '\x6a', '\xa4', '\xdc', '\xb8',
41 };
42
43 static const char ClGlObjMagic[] = {
44 '\x38', '\xfe', '\xb3', '\x0c', '\xa5', '\xd9', '\xab', '\x4d',
45 '\xac', '\x9b', '\xd6', '\xb6', '\x22', '\x26', '\x53', '\xc2',
46 };
47
48 // The signature bytes that start a .res file.
49 static const char WinResMagic[] = {
50 '\x00', '\x00', '\x00', '\x00', '\x20', '\x00', '\x00', '\x00',
51 '\xff', '\xff', '\x00', '\x00', '\xff', '\xff', '\x00', '\x00',
52 };
53
54 // Sizes in bytes of various things in the COFF format.
55 enum {
56 Header16Size = 20,
57 Header32Size = 56,
58 NameSize = 8,
59 Symbol16Size = 18,
60 Symbol32Size = 20,
61 SectionSize = 40,
62 RelocationSize = 10
63 };
64
65 struct header {
66 uint16_t Machine;
67 int32_t NumberOfSections;
68 uint32_t TimeDateStamp;
69 uint32_t PointerToSymbolTable;
70 uint32_t NumberOfSymbols;
71 uint16_t SizeOfOptionalHeader;
72 uint16_t Characteristics;
73 };
74
75 struct BigObjHeader {
76 enum : uint16_t { MinBigObjectVersion = 2 };
77
78 uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
79 uint16_t Sig2; ///< Must be 0xFFFF.
80 uint16_t Version;
81 uint16_t Machine;
82 uint32_t TimeDateStamp;
83 uint8_t UUID[16];
84 uint32_t unused1;
85 uint32_t unused2;
86 uint32_t unused3;
87 uint32_t unused4;
88 uint32_t NumberOfSections;
89 uint32_t PointerToSymbolTable;
90 uint32_t NumberOfSymbols;
91 };
92
93 enum MachineTypes : unsigned {
94 MT_Invalid = 0xffff,
95
96 IMAGE_FILE_MACHINE_UNKNOWN = 0x0,
97 IMAGE_FILE_MACHINE_AM33 = 0x1D3,
98 IMAGE_FILE_MACHINE_AMD64 = 0x8664,
99 IMAGE_FILE_MACHINE_ARM = 0x1C0,
100 IMAGE_FILE_MACHINE_ARMNT = 0x1C4,
101 IMAGE_FILE_MACHINE_ARM64 = 0xAA64,
102 IMAGE_FILE_MACHINE_EBC = 0xEBC,
103 IMAGE_FILE_MACHINE_I386 = 0x14C,
104 IMAGE_FILE_MACHINE_IA64 = 0x200,
105 IMAGE_FILE_MACHINE_M32R = 0x9041,
106 IMAGE_FILE_MACHINE_MIPS16 = 0x266,
107 IMAGE_FILE_MACHINE_MIPSFPU = 0x366,
108 IMAGE_FILE_MACHINE_MIPSFPU16 = 0x466,
109 IMAGE_FILE_MACHINE_POWERPC = 0x1F0,
110 IMAGE_FILE_MACHINE_POWERPCFP = 0x1F1,
111 IMAGE_FILE_MACHINE_R4000 = 0x166,
112 IMAGE_FILE_MACHINE_RISCV32 = 0x5032,
113 IMAGE_FILE_MACHINE_RISCV64 = 0x5064,
114 IMAGE_FILE_MACHINE_RISCV128 = 0x5128,
115 IMAGE_FILE_MACHINE_SH3 = 0x1A2,
116 IMAGE_FILE_MACHINE_SH3DSP = 0x1A3,
117 IMAGE_FILE_MACHINE_SH4 = 0x1A6,
118 IMAGE_FILE_MACHINE_SH5 = 0x1A8,
119 IMAGE_FILE_MACHINE_THUMB = 0x1C2,
120 IMAGE_FILE_MACHINE_WCEMIPSV2 = 0x169
121 };
122
123 enum Characteristics : unsigned {
124 C_Invalid = 0,
125
126 /// The file does not contain base relocations and must be loaded at its
127 /// preferred base. If this cannot be done, the loader will error.
128 IMAGE_FILE_RELOCS_STRIPPED = 0x0001,
129 /// The file is valid and can be run.
130 IMAGE_FILE_EXECUTABLE_IMAGE = 0x0002,
131 /// COFF line numbers have been stripped. This is deprecated and should be
132 /// 0.
133 IMAGE_FILE_LINE_NUMS_STRIPPED = 0x0004,
134 /// COFF symbol table entries for local symbols have been removed. This is
135 /// deprecated and should be 0.
136 IMAGE_FILE_LOCAL_SYMS_STRIPPED = 0x0008,
137 /// Aggressively trim working set. This is deprecated and must be 0.
138 IMAGE_FILE_AGGRESSIVE_WS_TRIM = 0x0010,
139 /// Image can handle > 2GiB addresses.
140 IMAGE_FILE_LARGE_ADDRESS_AWARE = 0x0020,
141 /// Little endian: the LSB precedes the MSB in memory. This is deprecated
142 /// and should be 0.
143 IMAGE_FILE_BYTES_REVERSED_LO = 0x0080,
144 /// Machine is based on a 32bit word architecture.
145 IMAGE_FILE_32BIT_MACHINE = 0x0100,
146 /// Debugging info has been removed.
147 IMAGE_FILE_DEBUG_STRIPPED = 0x0200,
148 /// If the image is on removable media, fully load it and copy it to swap.
149 IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400,
150 /// If the image is on network media, fully load it and copy it to swap.
151 IMAGE_FILE_NET_RUN_FROM_SWAP = 0x0800,
152 /// The image file is a system file, not a user program.
153 IMAGE_FILE_SYSTEM = 0x1000,
154 /// The image file is a DLL.
155 IMAGE_FILE_DLL = 0x2000,
156 /// This file should only be run on a uniprocessor machine.
157 IMAGE_FILE_UP_SYSTEM_ONLY = 0x4000,
158 /// Big endian: the MSB precedes the LSB in memory. This is deprecated
159 /// and should be 0.
160 IMAGE_FILE_BYTES_REVERSED_HI = 0x8000
161 };
162
163 enum ResourceTypeID : unsigned {
164 RID_Cursor = 1,
165 RID_Bitmap = 2,
166 RID_Icon = 3,
167 RID_Menu = 4,
168 RID_Dialog = 5,
169 RID_String = 6,
170 RID_FontDir = 7,
171 RID_Font = 8,
172 RID_Accelerator = 9,
173 RID_RCData = 10,
174 RID_MessageTable = 11,
175 RID_Group_Cursor = 12,
176 RID_Group_Icon = 14,
177 RID_Version = 16,
178 RID_DLGInclude = 17,
179 RID_PlugPlay = 19,
180 RID_VXD = 20,
181 RID_AniCursor = 21,
182 RID_AniIcon = 22,
183 RID_HTML = 23,
184 RID_Manifest = 24,
185 };
186
187 struct symbol {
188 char Name[NameSize];
189 uint32_t Value;
190 int32_t SectionNumber;
191 uint16_t Type;
192 uint8_t StorageClass;
193 uint8_t NumberOfAuxSymbols;
194 };
195
196 enum SymbolSectionNumber : int32_t {
197 IMAGE_SYM_DEBUG = -2,
198 IMAGE_SYM_ABSOLUTE = -1,
199 IMAGE_SYM_UNDEFINED = 0
200 };
201
202 /// Storage class tells where and what the symbol represents
203 enum SymbolStorageClass {
204 SSC_Invalid = 0xff,
205
206 IMAGE_SYM_CLASS_END_OF_FUNCTION = -1, ///< Physical end of function
207 IMAGE_SYM_CLASS_NULL = 0, ///< No symbol
208 IMAGE_SYM_CLASS_AUTOMATIC = 1, ///< Stack variable
209 IMAGE_SYM_CLASS_EXTERNAL = 2, ///< External symbol
210 IMAGE_SYM_CLASS_STATIC = 3, ///< Static
211 IMAGE_SYM_CLASS_REGISTER = 4, ///< Register variable
212 IMAGE_SYM_CLASS_EXTERNAL_DEF = 5, ///< External definition
213 IMAGE_SYM_CLASS_LABEL = 6, ///< Label
214 IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7, ///< Undefined label
215 IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8, ///< Member of structure
216 IMAGE_SYM_CLASS_ARGUMENT = 9, ///< Function argument
217 IMAGE_SYM_CLASS_STRUCT_TAG = 10, ///< Structure tag
218 IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11, ///< Member of union
219 IMAGE_SYM_CLASS_UNION_TAG = 12, ///< Union tag
220 IMAGE_SYM_CLASS_TYPE_DEFINITION = 13, ///< Type definition
221 IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14, ///< Undefined static
222 IMAGE_SYM_CLASS_ENUM_TAG = 15, ///< Enumeration tag
223 IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16, ///< Member of enumeration
224 IMAGE_SYM_CLASS_REGISTER_PARAM = 17, ///< Register parameter
225 IMAGE_SYM_CLASS_BIT_FIELD = 18, ///< Bit field
226 /// ".bb" or ".eb" - beginning or end of block
227 IMAGE_SYM_CLASS_BLOCK = 100,
228 /// ".bf" or ".ef" - beginning or end of function
229 IMAGE_SYM_CLASS_FUNCTION = 101,
230 IMAGE_SYM_CLASS_END_OF_STRUCT = 102, ///< End of structure
231 IMAGE_SYM_CLASS_FILE = 103, ///< File name
232 /// Line number, reformatted as symbol
233 IMAGE_SYM_CLASS_SECTION = 104,
234 IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105, ///< Duplicate tag
235 /// External symbol in dmert public lib
236 IMAGE_SYM_CLASS_CLR_TOKEN = 107
237 };
238
239 enum SymbolBaseType : unsigned {
240 IMAGE_SYM_TYPE_NULL = 0, ///< No type information or unknown base type.
241 IMAGE_SYM_TYPE_VOID = 1, ///< Used with void pointers and functions.
242 IMAGE_SYM_TYPE_CHAR = 2, ///< A character (signed byte).
243 IMAGE_SYM_TYPE_SHORT = 3, ///< A 2-byte signed integer.
244 IMAGE_SYM_TYPE_INT = 4, ///< A natural integer type on the target.
245 IMAGE_SYM_TYPE_LONG = 5, ///< A 4-byte signed integer.
246 IMAGE_SYM_TYPE_FLOAT = 6, ///< A 4-byte floating-point number.
247 IMAGE_SYM_TYPE_DOUBLE = 7, ///< An 8-byte floating-point number.
248 IMAGE_SYM_TYPE_STRUCT = 8, ///< A structure.
249 IMAGE_SYM_TYPE_UNION = 9, ///< An union.
250 IMAGE_SYM_TYPE_ENUM = 10, ///< An enumerated type.
251 IMAGE_SYM_TYPE_MOE = 11, ///< A member of enumeration (a specific value).
252 IMAGE_SYM_TYPE_BYTE = 12, ///< A byte; unsigned 1-byte integer.
253 IMAGE_SYM_TYPE_WORD = 13, ///< A word; unsigned 2-byte integer.
254 IMAGE_SYM_TYPE_UINT = 14, ///< An unsigned integer of natural size.
255 IMAGE_SYM_TYPE_DWORD = 15 ///< An unsigned 4-byte integer.
256 };
257
258 enum SymbolComplexType : unsigned {
259 IMAGE_SYM_DTYPE_NULL = 0, ///< No complex type; simple scalar variable.
260 IMAGE_SYM_DTYPE_POINTER = 1, ///< A pointer to base type.
261 IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
262 IMAGE_SYM_DTYPE_ARRAY = 3, ///< An array of base type.
263
264 /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
265 SCT_COMPLEX_TYPE_SHIFT = 4
266 };
267
268 enum AuxSymbolType { IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF = 1 };
269
270 struct section {
271 char Name[NameSize];
272 uint32_t VirtualSize;
273 uint32_t VirtualAddress;
274 uint32_t SizeOfRawData;
275 uint32_t PointerToRawData;
276 uint32_t PointerToRelocations;
277 uint32_t PointerToLineNumbers;
278 uint16_t NumberOfRelocations;
279 uint16_t NumberOfLineNumbers;
280 uint32_t Characteristics;
281 };
282
283 enum SectionCharacteristics : uint32_t {
284 SC_Invalid = 0xffffffff,
285
286 IMAGE_SCN_TYPE_NOLOAD = 0x00000002,
287 IMAGE_SCN_TYPE_NO_PAD = 0x00000008,
288 IMAGE_SCN_CNT_CODE = 0x00000020,
289 IMAGE_SCN_CNT_INITIALIZED_DATA = 0x00000040,
290 IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
291 IMAGE_SCN_LNK_OTHER = 0x00000100,
292 IMAGE_SCN_LNK_INFO = 0x00000200,
293 IMAGE_SCN_LNK_REMOVE = 0x00000800,
294 IMAGE_SCN_LNK_COMDAT = 0x00001000,
295 IMAGE_SCN_GPREL = 0x00008000,
296 IMAGE_SCN_MEM_PURGEABLE = 0x00020000,
297 IMAGE_SCN_MEM_16BIT = 0x00020000,
298 IMAGE_SCN_MEM_LOCKED = 0x00040000,
299 IMAGE_SCN_MEM_PRELOAD = 0x00080000,
300 IMAGE_SCN_ALIGN_1BYTES = 0x00100000,
301 IMAGE_SCN_ALIGN_2BYTES = 0x00200000,
302 IMAGE_SCN_ALIGN_4BYTES = 0x00300000,
303 IMAGE_SCN_ALIGN_8BYTES = 0x00400000,
304 IMAGE_SCN_ALIGN_16BYTES = 0x00500000,
305 IMAGE_SCN_ALIGN_32BYTES = 0x00600000,
306 IMAGE_SCN_ALIGN_64BYTES = 0x00700000,
307 IMAGE_SCN_ALIGN_128BYTES = 0x00800000,
308 IMAGE_SCN_ALIGN_256BYTES = 0x00900000,
309 IMAGE_SCN_ALIGN_512BYTES = 0x00A00000,
310 IMAGE_SCN_ALIGN_1024BYTES = 0x00B00000,
311 IMAGE_SCN_ALIGN_2048BYTES = 0x00C00000,
312 IMAGE_SCN_ALIGN_4096BYTES = 0x00D00000,
313 IMAGE_SCN_ALIGN_8192BYTES = 0x00E00000,
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 };
443
444 struct AuxiliarySectionDefinition {
445 uint32_t Length;
446 uint16_t NumberOfRelocations;
447 uint16_t NumberOfLinenumbers;
448 uint32_t CheckSum;
449 uint32_t Number;
450 uint8_t Selection;
451 char unused;
452 };
453
454 struct AuxiliaryCLRToken {
455 uint8_t AuxType;
456 uint8_t unused1;
457 uint32_t SymbolTableIndex;
458 char unused2[12];
459 };
460
461 union Auxiliary {
462 AuxiliaryFunctionDefinition FunctionDefinition;
463 AuxiliarybfAndefSymbol bfAndefSymbol;
464 AuxiliaryWeakExternal WeakExternal;
465 AuxiliarySectionDefinition SectionDefinition;
466 };
467
468 /// The Import Directory Table.
469 ///
470 /// There is a single array of these and one entry per imported DLL.
471 struct ImportDirectoryTableEntry {
472 uint32_t ImportLookupTableRVA;
473 uint32_t TimeDateStamp;
474 uint32_t ForwarderChain;
475 uint32_t NameRVA;
476 uint32_t ImportAddressTableRVA;
477 };
478
479 /// The PE32 Import Lookup Table.
480 ///
481 /// There is an array of these for each imported DLL. It represents either
482 /// the ordinal to import from the target DLL, or a name to lookup and import
483 /// from the target DLL.
484 ///
485 /// This also happens to be the same format used by the Import Address Table
486 /// when it is initially written out to the image.
487 struct ImportLookupTableEntry32 {
488 uint32_t data;
489
490 /// Is this entry specified by ordinal, or name?
isOrdinalImportLookupTableEntry32491 bool isOrdinal() const { return data & 0x80000000; }
492
493 /// Get the ordinal value of this entry. isOrdinal must be true.
getOrdinalImportLookupTableEntry32494 uint16_t getOrdinal() const {
495 assert(isOrdinal() && "ILT entry is not an ordinal!");
496 return data & 0xFFFF;
497 }
498
499 /// Set the ordinal value and set isOrdinal to true.
setOrdinalImportLookupTableEntry32500 void setOrdinal(uint16_t o) {
501 data = o;
502 data |= 0x80000000;
503 }
504
505 /// Get the Hint/Name entry RVA. isOrdinal must be false.
getHintNameRVAImportLookupTableEntry32506 uint32_t getHintNameRVA() const {
507 assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
508 return data;
509 }
510
511 /// Set the Hint/Name entry RVA and set isOrdinal to false.
setHintNameRVAImportLookupTableEntry32512 void setHintNameRVA(uint32_t rva) { data = rva; }
513 };
514
515 /// The DOS compatible header at the front of all PEs.
516 struct DOSHeader {
517 uint16_t Magic;
518 uint16_t UsedBytesInTheLastPage;
519 uint16_t FileSizeInPages;
520 uint16_t NumberOfRelocationItems;
521 uint16_t HeaderSizeInParagraphs;
522 uint16_t MinimumExtraParagraphs;
523 uint16_t MaximumExtraParagraphs;
524 uint16_t InitialRelativeSS;
525 uint16_t InitialSP;
526 uint16_t Checksum;
527 uint16_t InitialIP;
528 uint16_t InitialRelativeCS;
529 uint16_t AddressOfRelocationTable;
530 uint16_t OverlayNumber;
531 uint16_t Reserved[4];
532 uint16_t OEMid;
533 uint16_t OEMinfo;
534 uint16_t Reserved2[10];
535 uint32_t AddressOfNewExeHeader;
536 };
537
538 struct PE32Header {
539 enum { PE32 = 0x10b, PE32_PLUS = 0x20b };
540
541 uint16_t Magic;
542 uint8_t MajorLinkerVersion;
543 uint8_t MinorLinkerVersion;
544 uint32_t SizeOfCode;
545 uint32_t SizeOfInitializedData;
546 uint32_t SizeOfUninitializedData;
547 uint32_t AddressOfEntryPoint; // RVA
548 uint32_t BaseOfCode; // RVA
549 uint32_t BaseOfData; // RVA
550 uint64_t ImageBase;
551 uint32_t SectionAlignment;
552 uint32_t FileAlignment;
553 uint16_t MajorOperatingSystemVersion;
554 uint16_t MinorOperatingSystemVersion;
555 uint16_t MajorImageVersion;
556 uint16_t MinorImageVersion;
557 uint16_t MajorSubsystemVersion;
558 uint16_t MinorSubsystemVersion;
559 uint32_t Win32VersionValue;
560 uint32_t SizeOfImage;
561 uint32_t SizeOfHeaders;
562 uint32_t CheckSum;
563 uint16_t Subsystem;
564 // FIXME: This should be DllCharacteristics to match the COFF spec.
565 uint16_t DLLCharacteristics;
566 uint64_t SizeOfStackReserve;
567 uint64_t SizeOfStackCommit;
568 uint64_t SizeOfHeapReserve;
569 uint64_t SizeOfHeapCommit;
570 uint32_t LoaderFlags;
571 // FIXME: This should be NumberOfRvaAndSizes to match the COFF spec.
572 uint32_t NumberOfRvaAndSize;
573 };
574
575 struct DataDirectory {
576 uint32_t RelativeVirtualAddress;
577 uint32_t Size;
578 };
579
580 enum DataDirectoryIndex : unsigned {
581 EXPORT_TABLE = 0,
582 IMPORT_TABLE,
583 RESOURCE_TABLE,
584 EXCEPTION_TABLE,
585 CERTIFICATE_TABLE,
586 BASE_RELOCATION_TABLE,
587 DEBUG_DIRECTORY,
588 ARCHITECTURE,
589 GLOBAL_PTR,
590 TLS_TABLE,
591 LOAD_CONFIG_TABLE,
592 BOUND_IMPORT,
593 IAT,
594 DELAY_IMPORT_DESCRIPTOR,
595 CLR_RUNTIME_HEADER,
596
597 NUM_DATA_DIRECTORIES
598 };
599
600 enum WindowsSubsystem : unsigned {
601 IMAGE_SUBSYSTEM_UNKNOWN = 0, ///< An unknown subsystem.
602 IMAGE_SUBSYSTEM_NATIVE = 1, ///< Device drivers and native Windows processes
603 IMAGE_SUBSYSTEM_WINDOWS_GUI = 2, ///< The Windows GUI subsystem.
604 IMAGE_SUBSYSTEM_WINDOWS_CUI = 3, ///< The Windows character subsystem.
605 IMAGE_SUBSYSTEM_OS2_CUI = 5, ///< The OS/2 character subsytem.
606 IMAGE_SUBSYSTEM_POSIX_CUI = 7, ///< The POSIX character subsystem.
607 IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8, ///< Native Windows 9x driver.
608 IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9, ///< Windows CE.
609 IMAGE_SUBSYSTEM_EFI_APPLICATION = 10, ///< An EFI application.
610 IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11, ///< An EFI driver with boot
611 /// services.
612 IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12, ///< An EFI driver with run-time
613 /// services.
614 IMAGE_SUBSYSTEM_EFI_ROM = 13, ///< An EFI ROM image.
615 IMAGE_SUBSYSTEM_XBOX = 14, ///< XBOX.
616 IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16 ///< A BCD application.
617 };
618
619 enum DLLCharacteristics : unsigned {
620 /// ASLR with 64 bit address space.
621 IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,
622 /// DLL can be relocated at load time.
623 IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE = 0x0040,
624 /// Code integrity checks are enforced.
625 IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY = 0x0080,
626 ///< Image is NX compatible.
627 IMAGE_DLL_CHARACTERISTICS_NX_COMPAT = 0x0100,
628 /// Isolation aware, but do not isolate the image.
629 IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION = 0x0200,
630 /// Does not use structured exception handling (SEH). No SEH handler may be
631 /// called in this image.
632 IMAGE_DLL_CHARACTERISTICS_NO_SEH = 0x0400,
633 /// Do not bind the image.
634 IMAGE_DLL_CHARACTERISTICS_NO_BIND = 0x0800,
635 ///< Image should execute in an AppContainer.
636 IMAGE_DLL_CHARACTERISTICS_APPCONTAINER = 0x1000,
637 ///< A WDM driver.
638 IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER = 0x2000,
639 ///< Image supports Control Flow Guard.
640 IMAGE_DLL_CHARACTERISTICS_GUARD_CF = 0x4000,
641 /// Terminal Server aware.
642 IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
643 };
644
645 enum DebugType : unsigned {
646 IMAGE_DEBUG_TYPE_UNKNOWN = 0,
647 IMAGE_DEBUG_TYPE_COFF = 1,
648 IMAGE_DEBUG_TYPE_CODEVIEW = 2,
649 IMAGE_DEBUG_TYPE_FPO = 3,
650 IMAGE_DEBUG_TYPE_MISC = 4,
651 IMAGE_DEBUG_TYPE_EXCEPTION = 5,
652 IMAGE_DEBUG_TYPE_FIXUP = 6,
653 IMAGE_DEBUG_TYPE_OMAP_TO_SRC = 7,
654 IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8,
655 IMAGE_DEBUG_TYPE_BORLAND = 9,
656 IMAGE_DEBUG_TYPE_RESERVED10 = 10,
657 IMAGE_DEBUG_TYPE_CLSID = 11,
658 IMAGE_DEBUG_TYPE_VC_FEATURE = 12,
659 IMAGE_DEBUG_TYPE_POGO = 13,
660 IMAGE_DEBUG_TYPE_ILTCG = 14,
661 IMAGE_DEBUG_TYPE_MPX = 15,
662 IMAGE_DEBUG_TYPE_REPRO = 16,
663 };
664
665 enum BaseRelocationType : unsigned {
666 IMAGE_REL_BASED_ABSOLUTE = 0,
667 IMAGE_REL_BASED_HIGH = 1,
668 IMAGE_REL_BASED_LOW = 2,
669 IMAGE_REL_BASED_HIGHLOW = 3,
670 IMAGE_REL_BASED_HIGHADJ = 4,
671 IMAGE_REL_BASED_MIPS_JMPADDR = 5,
672 IMAGE_REL_BASED_ARM_MOV32A = 5,
673 IMAGE_REL_BASED_ARM_MOV32T = 7,
674 IMAGE_REL_BASED_MIPS_JMPADDR16 = 9,
675 IMAGE_REL_BASED_DIR64 = 10
676 };
677
678 enum ImportType : unsigned {
679 IMPORT_CODE = 0,
680 IMPORT_DATA = 1,
681 IMPORT_CONST = 2
682 };
683
684 enum ImportNameType : unsigned {
685 /// Import is by ordinal. This indicates that the value in the Ordinal/Hint
686 /// field of the import header is the import's ordinal. If this constant is
687 /// not specified, then the Ordinal/Hint field should always be interpreted
688 /// as the import's hint.
689 IMPORT_ORDINAL = 0,
690 /// The import name is identical to the public symbol name
691 IMPORT_NAME = 1,
692 /// The import name is the public symbol name, but skipping the leading ?,
693 /// @, or optionally _.
694 IMPORT_NAME_NOPREFIX = 2,
695 /// The import name is the public symbol name, but skipping the leading ?,
696 /// @, or optionally _, and truncating at the first @.
697 IMPORT_NAME_UNDECORATE = 3
698 };
699
700 struct ImportHeader {
701 uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
702 uint16_t Sig2; ///< Must be 0xFFFF.
703 uint16_t Version;
704 uint16_t Machine;
705 uint32_t TimeDateStamp;
706 uint32_t SizeOfData;
707 uint16_t OrdinalHint;
708 uint16_t TypeInfo;
709
getTypeImportHeader710 ImportType getType() const { return static_cast<ImportType>(TypeInfo & 0x3); }
711
getNameTypeImportHeader712 ImportNameType getNameType() const {
713 return static_cast<ImportNameType>((TypeInfo & 0x1C) >> 2);
714 }
715 };
716
717 enum CodeViewIdentifiers {
718 DEBUG_SECTION_MAGIC = 0x4,
719 DEBUG_HASHES_SECTION_MAGIC = 0x133C9C5
720 };
721
isReservedSectionNumber(int32_t SectionNumber)722 inline bool isReservedSectionNumber(int32_t SectionNumber) {
723 return SectionNumber <= 0;
724 }
725
726 } // End namespace COFF.
727 } // End namespace llvm.
728
729 #endif
730