]> git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/IndustryStandard/PeImage.h
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / PeImage.h
1 /** @file
2 EFI image format for PE32, PE32+ and TE. Please note some data structures are
3 different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and
4 EFI_IMAGE_NT_HEADERS64 is for PE32+.
5
6 This file is coded to the Visual Studio, Microsoft Portable Executable and
7 Common Object File Format Specification, Revision 8.3 - February 6, 2013.
8 This file also includes some definitions in PI Specification, Revision 1.0.
9
10 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
11 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
12 SPDX-License-Identifier: BSD-2-Clause-Patent
13
14 **/
15
16 #ifndef __PE_IMAGE_H__
17 #define __PE_IMAGE_H__
18
19 //
20 // PE32+ Subsystem type for EFI images
21 //
22 #define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10
23 #define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
24 #define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
25 #define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13 ///< defined PI Specification, 1.0
26
27
28 //
29 // PE32+ Machine type for EFI images
30 //
31 #define IMAGE_FILE_MACHINE_I386 0x014c
32 #define IMAGE_FILE_MACHINE_IA64 0x0200
33 #define IMAGE_FILE_MACHINE_EBC 0x0EBC
34 #define IMAGE_FILE_MACHINE_X64 0x8664
35 #define IMAGE_FILE_MACHINE_ARMTHUMB_MIXED 0x01c2
36 #define IMAGE_FILE_MACHINE_ARM64 0xAA64
37
38 //
39 // EXE file formats
40 //
41 #define EFI_IMAGE_DOS_SIGNATURE SIGNATURE_16('M', 'Z')
42 #define EFI_IMAGE_OS2_SIGNATURE SIGNATURE_16('N', 'E')
43 #define EFI_IMAGE_OS2_SIGNATURE_LE SIGNATURE_16('L', 'E')
44 #define EFI_IMAGE_NT_SIGNATURE SIGNATURE_32('P', 'E', '\0', '\0')
45
46 ///
47 /// PE images can start with an optional DOS header, so if an image is run
48 /// under DOS it can print an error message.
49 ///
50 typedef struct {
51 UINT16 e_magic; ///< Magic number.
52 UINT16 e_cblp; ///< Bytes on last page of file.
53 UINT16 e_cp; ///< Pages in file.
54 UINT16 e_crlc; ///< Relocations.
55 UINT16 e_cparhdr; ///< Size of header in paragraphs.
56 UINT16 e_minalloc; ///< Minimum extra paragraphs needed.
57 UINT16 e_maxalloc; ///< Maximum extra paragraphs needed.
58 UINT16 e_ss; ///< Initial (relative) SS value.
59 UINT16 e_sp; ///< Initial SP value.
60 UINT16 e_csum; ///< Checksum.
61 UINT16 e_ip; ///< Initial IP value.
62 UINT16 e_cs; ///< Initial (relative) CS value.
63 UINT16 e_lfarlc; ///< File address of relocation table.
64 UINT16 e_ovno; ///< Overlay number.
65 UINT16 e_res[4]; ///< Reserved words.
66 UINT16 e_oemid; ///< OEM identifier (for e_oeminfo).
67 UINT16 e_oeminfo; ///< OEM information; e_oemid specific.
68 UINT16 e_res2[10]; ///< Reserved words.
69 UINT32 e_lfanew; ///< File address of new exe header.
70 } EFI_IMAGE_DOS_HEADER;
71
72 ///
73 /// COFF File Header (Object and Image).
74 ///
75 typedef struct {
76 UINT16 Machine;
77 UINT16 NumberOfSections;
78 UINT32 TimeDateStamp;
79 UINT32 PointerToSymbolTable;
80 UINT32 NumberOfSymbols;
81 UINT16 SizeOfOptionalHeader;
82 UINT16 Characteristics;
83 } EFI_IMAGE_FILE_HEADER;
84
85 ///
86 /// Size of EFI_IMAGE_FILE_HEADER.
87 ///
88 #define EFI_IMAGE_SIZEOF_FILE_HEADER 20
89
90 //
91 // Characteristics
92 //
93 #define EFI_IMAGE_FILE_RELOCS_STRIPPED BIT0 ///< 0x0001 Relocation info stripped from file.
94 #define EFI_IMAGE_FILE_EXECUTABLE_IMAGE BIT1 ///< 0x0002 File is executable (i.e. no unresolved externel references).
95 #define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED BIT2 ///< 0x0004 Line nunbers stripped from file.
96 #define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED BIT3 ///< 0x0008 Local symbols stripped from file.
97 #define EFI_IMAGE_FILE_BYTES_REVERSED_LO BIT7 ///< 0x0080 Bytes of machine word are reversed.
98 #define EFI_IMAGE_FILE_32BIT_MACHINE BIT8 ///< 0x0100 32 bit word machine.
99 #define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file.
100 #define EFI_IMAGE_FILE_SYSTEM BIT12 ///< 0x1000 System File.
101 #define EFI_IMAGE_FILE_DLL BIT13 ///< 0x2000 File is a DLL.
102 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI BIT15 ///< 0x8000 Bytes of machine word are reversed.
103
104 ///
105 /// Header Data Directories.
106 ///
107 typedef struct {
108 UINT32 VirtualAddress;
109 UINT32 Size;
110 } EFI_IMAGE_DATA_DIRECTORY;
111
112 //
113 // Directory Entries
114 //
115 #define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0
116 #define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1
117 #define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2
118 #define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3
119 #define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4
120 #define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5
121 #define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6
122 #define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7
123 #define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8
124 #define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9
125 #define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10
126
127 #define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16
128
129 ///
130 /// @attention
131 /// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and
132 /// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary
133 /// after NT additional fields.
134 ///
135 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
136
137 ///
138 /// Optional Header Standard Fields for PE32.
139 ///
140 typedef struct {
141 ///
142 /// Standard fields.
143 ///
144 UINT16 Magic;
145 UINT8 MajorLinkerVersion;
146 UINT8 MinorLinkerVersion;
147 UINT32 SizeOfCode;
148 UINT32 SizeOfInitializedData;
149 UINT32 SizeOfUninitializedData;
150 UINT32 AddressOfEntryPoint;
151 UINT32 BaseOfCode;
152 UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.
153 ///
154 /// Optional Header Windows-Specific Fields.
155 ///
156 UINT32 ImageBase;
157 UINT32 SectionAlignment;
158 UINT32 FileAlignment;
159 UINT16 MajorOperatingSystemVersion;
160 UINT16 MinorOperatingSystemVersion;
161 UINT16 MajorImageVersion;
162 UINT16 MinorImageVersion;
163 UINT16 MajorSubsystemVersion;
164 UINT16 MinorSubsystemVersion;
165 UINT32 Win32VersionValue;
166 UINT32 SizeOfImage;
167 UINT32 SizeOfHeaders;
168 UINT32 CheckSum;
169 UINT16 Subsystem;
170 UINT16 DllCharacteristics;
171 UINT32 SizeOfStackReserve;
172 UINT32 SizeOfStackCommit;
173 UINT32 SizeOfHeapReserve;
174 UINT32 SizeOfHeapCommit;
175 UINT32 LoaderFlags;
176 UINT32 NumberOfRvaAndSizes;
177 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
178 } EFI_IMAGE_OPTIONAL_HEADER32;
179
180 ///
181 /// @attention
182 /// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and
183 /// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary
184 /// after NT additional fields.
185 ///
186 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
187
188 ///
189 /// Optional Header Standard Fields for PE32+.
190 ///
191 typedef struct {
192 ///
193 /// Standard fields.
194 ///
195 UINT16 Magic;
196 UINT8 MajorLinkerVersion;
197 UINT8 MinorLinkerVersion;
198 UINT32 SizeOfCode;
199 UINT32 SizeOfInitializedData;
200 UINT32 SizeOfUninitializedData;
201 UINT32 AddressOfEntryPoint;
202 UINT32 BaseOfCode;
203 ///
204 /// Optional Header Windows-Specific Fields.
205 ///
206 UINT64 ImageBase;
207 UINT32 SectionAlignment;
208 UINT32 FileAlignment;
209 UINT16 MajorOperatingSystemVersion;
210 UINT16 MinorOperatingSystemVersion;
211 UINT16 MajorImageVersion;
212 UINT16 MinorImageVersion;
213 UINT16 MajorSubsystemVersion;
214 UINT16 MinorSubsystemVersion;
215 UINT32 Win32VersionValue;
216 UINT32 SizeOfImage;
217 UINT32 SizeOfHeaders;
218 UINT32 CheckSum;
219 UINT16 Subsystem;
220 UINT16 DllCharacteristics;
221 UINT64 SizeOfStackReserve;
222 UINT64 SizeOfStackCommit;
223 UINT64 SizeOfHeapReserve;
224 UINT64 SizeOfHeapCommit;
225 UINT32 LoaderFlags;
226 UINT32 NumberOfRvaAndSizes;
227 EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
228 } EFI_IMAGE_OPTIONAL_HEADER64;
229
230
231 ///
232 /// @attention
233 /// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.
234 ///
235 typedef struct {
236 UINT32 Signature;
237 EFI_IMAGE_FILE_HEADER FileHeader;
238 EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader;
239 } EFI_IMAGE_NT_HEADERS32;
240
241 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)
242
243 ///
244 /// @attention
245 /// EFI_IMAGE_HEADERS64 is for use ONLY by tools.
246 ///
247 typedef struct {
248 UINT32 Signature;
249 EFI_IMAGE_FILE_HEADER FileHeader;
250 EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader;
251 } EFI_IMAGE_NT_HEADERS64;
252
253 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)
254
255 //
256 // Other Windows Subsystem Values
257 //
258 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0
259 #define EFI_IMAGE_SUBSYSTEM_NATIVE 1
260 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2
261 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3
262 #define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5
263 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7
264
265 ///
266 /// Length of ShortName.
267 ///
268 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8
269
270 ///
271 /// Section Table. This table immediately follows the optional header.
272 ///
273 typedef struct {
274 UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
275 union {
276 UINT32 PhysicalAddress;
277 UINT32 VirtualSize;
278 } Misc;
279 UINT32 VirtualAddress;
280 UINT32 SizeOfRawData;
281 UINT32 PointerToRawData;
282 UINT32 PointerToRelocations;
283 UINT32 PointerToLinenumbers;
284 UINT16 NumberOfRelocations;
285 UINT16 NumberOfLinenumbers;
286 UINT32 Characteristics;
287 } EFI_IMAGE_SECTION_HEADER;
288
289 ///
290 /// Size of EFI_IMAGE_SECTION_HEADER.
291 ///
292 #define EFI_IMAGE_SIZEOF_SECTION_HEADER 40
293
294 //
295 // Section Flags Values
296 //
297 #define EFI_IMAGE_SCN_TYPE_NO_PAD BIT3 ///< 0x00000008 ///< Reserved.
298 #define EFI_IMAGE_SCN_CNT_CODE BIT5 ///< 0x00000020
299 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA BIT6 ///< 0x00000040
300 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA BIT7 ///< 0x00000080
301
302 #define EFI_IMAGE_SCN_LNK_OTHER BIT8 ///< 0x00000100 ///< Reserved.
303 #define EFI_IMAGE_SCN_LNK_INFO BIT9 ///< 0x00000200 ///< Section contains comments or some other type of information.
304 #define EFI_IMAGE_SCN_LNK_REMOVE BIT11 ///< 0x00000800 ///< Section contents will not become part of image.
305 #define EFI_IMAGE_SCN_LNK_COMDAT BIT12 ///< 0x00001000
306
307 #define EFI_IMAGE_SCN_ALIGN_1BYTES BIT20 ///< 0x00100000
308 #define EFI_IMAGE_SCN_ALIGN_2BYTES BIT21 ///< 0x00200000
309 #define EFI_IMAGE_SCN_ALIGN_4BYTES (BIT20|BIT21) ///< 0x00300000
310 #define EFI_IMAGE_SCN_ALIGN_8BYTES BIT22 ///< 0x00400000
311 #define EFI_IMAGE_SCN_ALIGN_16BYTES (BIT20|BIT22) ///< 0x00500000
312 #define EFI_IMAGE_SCN_ALIGN_32BYTES (BIT21|BIT22) ///< 0x00600000
313 #define EFI_IMAGE_SCN_ALIGN_64BYTES (BIT20|BIT21|BIT22) ///< 0x00700000
314
315 #define EFI_IMAGE_SCN_MEM_DISCARDABLE BIT25 ///< 0x02000000
316 #define EFI_IMAGE_SCN_MEM_NOT_CACHED BIT26 ///< 0x04000000
317 #define EFI_IMAGE_SCN_MEM_NOT_PAGED BIT27 ///< 0x08000000
318 #define EFI_IMAGE_SCN_MEM_SHARED BIT28 ///< 0x10000000
319 #define EFI_IMAGE_SCN_MEM_EXECUTE BIT29 ///< 0x20000000
320 #define EFI_IMAGE_SCN_MEM_READ BIT30 ///< 0x40000000
321 #define EFI_IMAGE_SCN_MEM_WRITE BIT31 ///< 0x80000000
322
323 ///
324 /// Size of a Symbol Table Record.
325 ///
326 #define EFI_IMAGE_SIZEOF_SYMBOL 18
327
328 //
329 // Symbols have a section number of the section in which they are
330 // defined. Otherwise, section numbers have the following meanings:
331 //
332 #define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 ///< Symbol is undefined or is common.
333 #define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 ///< Symbol is an absolute value.
334 #define EFI_IMAGE_SYM_DEBUG (UINT16) -2 ///< Symbol is a special debug item.
335
336 //
337 // Symbol Type (fundamental) values.
338 //
339 #define EFI_IMAGE_SYM_TYPE_NULL 0 ///< no type.
340 #define EFI_IMAGE_SYM_TYPE_VOID 1 ///< no valid type.
341 #define EFI_IMAGE_SYM_TYPE_CHAR 2 ///< type character.
342 #define EFI_IMAGE_SYM_TYPE_SHORT 3 ///< type short integer.
343 #define EFI_IMAGE_SYM_TYPE_INT 4
344 #define EFI_IMAGE_SYM_TYPE_LONG 5
345 #define EFI_IMAGE_SYM_TYPE_FLOAT 6
346 #define EFI_IMAGE_SYM_TYPE_DOUBLE 7
347 #define EFI_IMAGE_SYM_TYPE_STRUCT 8
348 #define EFI_IMAGE_SYM_TYPE_UNION 9
349 #define EFI_IMAGE_SYM_TYPE_ENUM 10 ///< enumeration.
350 #define EFI_IMAGE_SYM_TYPE_MOE 11 ///< member of enumeration.
351 #define EFI_IMAGE_SYM_TYPE_BYTE 12
352 #define EFI_IMAGE_SYM_TYPE_WORD 13
353 #define EFI_IMAGE_SYM_TYPE_UINT 14
354 #define EFI_IMAGE_SYM_TYPE_DWORD 15
355
356 //
357 // Symbol Type (derived) values.
358 //
359 #define EFI_IMAGE_SYM_DTYPE_NULL 0 ///< no derived type.
360 #define EFI_IMAGE_SYM_DTYPE_POINTER 1
361 #define EFI_IMAGE_SYM_DTYPE_FUNCTION 2
362 #define EFI_IMAGE_SYM_DTYPE_ARRAY 3
363
364 //
365 // Storage classes.
366 //
367 #define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION ((UINT8) -1)
368 #define EFI_IMAGE_SYM_CLASS_NULL 0
369 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1
370 #define EFI_IMAGE_SYM_CLASS_EXTERNAL 2
371 #define EFI_IMAGE_SYM_CLASS_STATIC 3
372 #define EFI_IMAGE_SYM_CLASS_REGISTER 4
373 #define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5
374 #define EFI_IMAGE_SYM_CLASS_LABEL 6
375 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7
376 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8
377 #define EFI_IMAGE_SYM_CLASS_ARGUMENT 9
378 #define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10
379 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11
380 #define EFI_IMAGE_SYM_CLASS_UNION_TAG 12
381 #define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13
382 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14
383 #define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15
384 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16
385 #define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17
386 #define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18
387 #define EFI_IMAGE_SYM_CLASS_BLOCK 100
388 #define EFI_IMAGE_SYM_CLASS_FUNCTION 101
389 #define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102
390 #define EFI_IMAGE_SYM_CLASS_FILE 103
391 #define EFI_IMAGE_SYM_CLASS_SECTION 104
392 #define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105
393
394 //
395 // type packing constants
396 //
397 #define EFI_IMAGE_N_BTMASK 017
398 #define EFI_IMAGE_N_TMASK 060
399 #define EFI_IMAGE_N_TMASK1 0300
400 #define EFI_IMAGE_N_TMASK2 0360
401 #define EFI_IMAGE_N_BTSHFT 4
402 #define EFI_IMAGE_N_TSHIFT 2
403
404 //
405 // Communal selection types.
406 //
407 #define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1
408 #define EFI_IMAGE_COMDAT_SELECT_ANY 2
409 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3
410 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4
411 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5
412
413 //
414 // the following values only be referred in PeCoff, not defined in PECOFF.
415 //
416 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
417 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2
418 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3
419
420 ///
421 /// Relocation format.
422 ///
423 typedef struct {
424 UINT32 VirtualAddress;
425 UINT32 SymbolTableIndex;
426 UINT16 Type;
427 } EFI_IMAGE_RELOCATION;
428
429 ///
430 /// Size of EFI_IMAGE_RELOCATION
431 ///
432 #define EFI_IMAGE_SIZEOF_RELOCATION 10
433
434 //
435 // I386 relocation types.
436 //
437 #define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary.
438 #define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address.
439 #define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.
440 #define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address.
441 #define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.
442 #define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.
443 #define EFI_IMAGE_REL_I386_SECTION 0x000A
444 #define EFI_IMAGE_REL_I386_SECREL 0x000B
445 #define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.
446
447 //
448 // x64 processor relocation types.
449 //
450 #define IMAGE_REL_AMD64_ABSOLUTE 0x0000
451 #define IMAGE_REL_AMD64_ADDR64 0x0001
452 #define IMAGE_REL_AMD64_ADDR32 0x0002
453 #define IMAGE_REL_AMD64_ADDR32NB 0x0003
454 #define IMAGE_REL_AMD64_REL32 0x0004
455 #define IMAGE_REL_AMD64_REL32_1 0x0005
456 #define IMAGE_REL_AMD64_REL32_2 0x0006
457 #define IMAGE_REL_AMD64_REL32_3 0x0007
458 #define IMAGE_REL_AMD64_REL32_4 0x0008
459 #define IMAGE_REL_AMD64_REL32_5 0x0009
460 #define IMAGE_REL_AMD64_SECTION 0x000A
461 #define IMAGE_REL_AMD64_SECREL 0x000B
462 #define IMAGE_REL_AMD64_SECREL7 0x000C
463 #define IMAGE_REL_AMD64_TOKEN 0x000D
464 #define IMAGE_REL_AMD64_SREL32 0x000E
465 #define IMAGE_REL_AMD64_PAIR 0x000F
466 #define IMAGE_REL_AMD64_SSPAN32 0x0010
467
468 ///
469 /// Based relocation format.
470 ///
471 typedef struct {
472 UINT32 VirtualAddress;
473 UINT32 SizeOfBlock;
474 } EFI_IMAGE_BASE_RELOCATION;
475
476 ///
477 /// Size of EFI_IMAGE_BASE_RELOCATION.
478 ///
479 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8
480
481 //
482 // Based relocation types.
483 //
484 #define EFI_IMAGE_REL_BASED_ABSOLUTE 0
485 #define EFI_IMAGE_REL_BASED_HIGH 1
486 #define EFI_IMAGE_REL_BASED_LOW 2
487 #define EFI_IMAGE_REL_BASED_HIGHLOW 3
488 #define EFI_IMAGE_REL_BASED_HIGHADJ 4
489 #define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5
490 #define EFI_IMAGE_REL_BASED_ARM_MOV32A 5
491 #define EFI_IMAGE_REL_BASED_ARM_MOV32T 7
492 #define EFI_IMAGE_REL_BASED_IA64_IMM64 9
493 #define EFI_IMAGE_REL_BASED_MIPS_JMPADDR16 9
494 #define EFI_IMAGE_REL_BASED_DIR64 10
495
496 ///
497 /// Line number format.
498 ///
499 typedef struct {
500 union {
501 UINT32 SymbolTableIndex; ///< Symbol table index of function name if Linenumber is 0.
502 UINT32 VirtualAddress; ///< Virtual address of line number.
503 } Type;
504 UINT16 Linenumber; ///< Line number.
505 } EFI_IMAGE_LINENUMBER;
506
507 ///
508 /// Size of EFI_IMAGE_LINENUMBER.
509 ///
510 #define EFI_IMAGE_SIZEOF_LINENUMBER 6
511
512 //
513 // Archive format.
514 //
515 #define EFI_IMAGE_ARCHIVE_START_SIZE 8
516 #define EFI_IMAGE_ARCHIVE_START "!<arch>\n"
517 #define EFI_IMAGE_ARCHIVE_END "`\n"
518 #define EFI_IMAGE_ARCHIVE_PAD "\n"
519 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ "
520 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// "
521
522 ///
523 /// Archive Member Headers
524 ///
525 typedef struct {
526 UINT8 Name[16]; ///< File member name - `/' terminated.
527 UINT8 Date[12]; ///< File member date - decimal.
528 UINT8 UserID[6]; ///< File member user id - decimal.
529 UINT8 GroupID[6]; ///< File member group id - decimal.
530 UINT8 Mode[8]; ///< File member mode - octal.
531 UINT8 Size[10]; ///< File member size - decimal.
532 UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).
533 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER;
534
535 ///
536 /// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.
537 ///
538 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
539
540
541 //
542 // DLL Support
543 //
544
545 ///
546 /// Export Directory Table.
547 ///
548 typedef struct {
549 UINT32 Characteristics;
550 UINT32 TimeDateStamp;
551 UINT16 MajorVersion;
552 UINT16 MinorVersion;
553 UINT32 Name;
554 UINT32 Base;
555 UINT32 NumberOfFunctions;
556 UINT32 NumberOfNames;
557 UINT32 AddressOfFunctions;
558 UINT32 AddressOfNames;
559 UINT32 AddressOfNameOrdinals;
560 } EFI_IMAGE_EXPORT_DIRECTORY;
561
562 ///
563 /// Hint/Name Table.
564 ///
565 typedef struct {
566 UINT16 Hint;
567 UINT8 Name[1];
568 } EFI_IMAGE_IMPORT_BY_NAME;
569
570 ///
571 /// Import Address Table RVA (Thunk Table).
572 ///
573 typedef struct {
574 union {
575 UINT32 Function;
576 UINT32 Ordinal;
577 EFI_IMAGE_IMPORT_BY_NAME *AddressOfData;
578 } u1;
579 } EFI_IMAGE_THUNK_DATA;
580
581 #define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32.
582 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
583 #define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
584
585 ///
586 /// Import Directory Table
587 ///
588 typedef struct {
589 UINT32 Characteristics;
590 UINT32 TimeDateStamp;
591 UINT32 ForwarderChain;
592 UINT32 Name;
593 EFI_IMAGE_THUNK_DATA *FirstThunk;
594 } EFI_IMAGE_IMPORT_DESCRIPTOR;
595
596
597 ///
598 /// Debug Directory Format.
599 ///
600 typedef struct {
601 UINT32 Characteristics;
602 UINT32 TimeDateStamp;
603 UINT16 MajorVersion;
604 UINT16 MinorVersion;
605 UINT32 Type;
606 UINT32 SizeOfData;
607 UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base.
608 UINT32 FileOffset; ///< The file pointer to the debug data.
609 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;
610
611 #define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.
612
613 ///
614 /// Debug Data Structure defined in Microsoft C++.
615 ///
616 #define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')
617 typedef struct {
618 UINT32 Signature; ///< "NB10"
619 UINT32 Unknown;
620 UINT32 Unknown2;
621 UINT32 Unknown3;
622 //
623 // Filename of .PDB goes here
624 //
625 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
626
627 ///
628 /// Debug Data Structure defined in Microsoft C++.
629 ///
630 #define CODEVIEW_SIGNATURE_RSDS SIGNATURE_32('R', 'S', 'D', 'S')
631 typedef struct {
632 UINT32 Signature; ///< "RSDS".
633 UINT32 Unknown;
634 UINT32 Unknown2;
635 UINT32 Unknown3;
636 UINT32 Unknown4;
637 UINT32 Unknown5;
638 //
639 // Filename of .PDB goes here
640 //
641 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
642
643
644 ///
645 /// Debug Data Structure defined by Apple Mach-O to Coff utility.
646 ///
647 #define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C')
648 typedef struct {
649 UINT32 Signature; ///< "MTOC".
650 GUID MachOUuid;
651 //
652 // Filename of .DLL (Mach-O with debug info) goes here
653 //
654 } EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;
655
656 ///
657 /// Resource format.
658 ///
659 typedef struct {
660 UINT32 Characteristics;
661 UINT32 TimeDateStamp;
662 UINT16 MajorVersion;
663 UINT16 MinorVersion;
664 UINT16 NumberOfNamedEntries;
665 UINT16 NumberOfIdEntries;
666 //
667 // Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.
668 //
669 } EFI_IMAGE_RESOURCE_DIRECTORY;
670
671 ///
672 /// Resource directory entry format.
673 ///
674 typedef struct {
675 union {
676 struct {
677 UINT32 NameOffset:31;
678 UINT32 NameIsString:1;
679 } s;
680 UINT32 Id;
681 } u1;
682 union {
683 UINT32 OffsetToData;
684 struct {
685 UINT32 OffsetToDirectory:31;
686 UINT32 DataIsDirectory:1;
687 } s;
688 } u2;
689 } EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;
690
691 ///
692 /// Resource directory entry for string.
693 ///
694 typedef struct {
695 UINT16 Length;
696 CHAR16 String[1];
697 } EFI_IMAGE_RESOURCE_DIRECTORY_STRING;
698
699 ///
700 /// Resource directory entry for data array.
701 ///
702 typedef struct {
703 UINT32 OffsetToData;
704 UINT32 Size;
705 UINT32 CodePage;
706 UINT32 Reserved;
707 } EFI_IMAGE_RESOURCE_DATA_ENTRY;
708
709 ///
710 /// Header format for TE images, defined in the PI Specification, 1.0.
711 ///
712 typedef struct {
713 UINT16 Signature; ///< The signature for TE format = "VZ".
714 UINT16 Machine; ///< From the original file header.
715 UINT8 NumberOfSections; ///< From the original file header.
716 UINT8 Subsystem; ///< From original optional header.
717 UINT16 StrippedSize; ///< Number of bytes we removed from the header.
718 UINT32 AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.
719 UINT32 BaseOfCode; ///< From original image -- required for ITP debug.
720 UINT64 ImageBase; ///< From original file header.
721 EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< Only base relocation and debug directory.
722 } EFI_TE_IMAGE_HEADER;
723
724
725 #define EFI_TE_IMAGE_HEADER_SIGNATURE SIGNATURE_16('V', 'Z')
726
727 //
728 // Data directory indexes in our TE image header
729 //
730 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0
731 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1
732
733
734 ///
735 /// Union of PE32, PE32+, and TE headers.
736 ///
737 typedef union {
738 EFI_IMAGE_NT_HEADERS32 Pe32;
739 EFI_IMAGE_NT_HEADERS64 Pe32Plus;
740 EFI_TE_IMAGE_HEADER Te;
741 } EFI_IMAGE_OPTIONAL_HEADER_UNION;
742
743 typedef union {
744 EFI_IMAGE_NT_HEADERS32 *Pe32;
745 EFI_IMAGE_NT_HEADERS64 *Pe32Plus;
746 EFI_TE_IMAGE_HEADER *Te;
747 EFI_IMAGE_OPTIONAL_HEADER_UNION *Union;
748 } EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;
749
750 #endif
EFI Development Kit II mirror for PVE