2 EFI image format for PE32 and PE32+. 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+.
6 This file is coded to the Visual Studio, Microsoft Portable Executable and
7 Common Object File Format Specification, Revision 8.0 - May 16, 2006.
9 Copyright (c) 2006, Intel Corporation
10 All rights reserved. This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Module Name: EfiImage.h
22 #ifndef __EFI_IMAGE_H__
23 #define __EFI_IMAGE_H__
26 // PE32+ Subsystem type for EFI images
28 #define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10
29 #define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
30 #define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
31 #define EFI_IMAGE_SUBSYSTEM_EFI_EFI_ROM 13
33 #define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13
37 // PE32+ Machine type for EFI images
39 #define IMAGE_FILE_MACHINE_I386 0x014c
40 #define IMAGE_FILE_MACHINE_IA64 0x0200
41 #define IMAGE_FILE_MACHINE_EBC 0x0EBC
42 #define IMAGE_FILE_MACHINE_X64 0x8664
44 // Support old names for backward compatible
46 #define EFI_IMAGE_MACHINE_IA32 IMAGE_FILE_MACHINE_I386
47 #define EFI_IMAGE_MACHINE_IA64 IMAGE_FILE_MACHINE_IA64
48 #define EFI_IMAGE_MACHINE_IPF IMAGE_FILE_MACHINE_IA64
49 #define EFI_IMAGE_MACHINE_EBC IMAGE_FILE_MACHINE_EBC
50 #define EFI_IMAGE_MACHINE_X64 IMAGE_FILE_MACHINE_X64
52 #define EFI_IMAGE_DOS_SIGNATURE 0x5A4D // MZ
53 #define EFI_IMAGE_OS2_SIGNATURE 0x454E // NE
54 #define EFI_IMAGE_OS2_SIGNATURE_LE 0x454C // LE
55 #define EFI_IMAGE_NT_SIGNATURE 0x00004550 // PE00
58 /// PE images can start with an optional DOS header, so if an image is run
59 /// under DOS it can print an error message.
62 UINT16 e_magic
; // Magic number
63 UINT16 e_cblp
; // Bytes on last page of file
64 UINT16 e_cp
; // Pages in file
65 UINT16 e_crlc
; // Relocations
66 UINT16 e_cparhdr
; // Size of header in paragraphs
67 UINT16 e_minalloc
; // Minimum extra paragraphs needed
68 UINT16 e_maxalloc
; // Maximum extra paragraphs needed
69 UINT16 e_ss
; // Initial (relative) SS value
70 UINT16 e_sp
; // Initial SP value
71 UINT16 e_csum
; // Checksum
72 UINT16 e_ip
; // Initial IP value
73 UINT16 e_cs
; // Initial (relative) CS value
74 UINT16 e_lfarlc
; // File address of relocation table
75 UINT16 e_ovno
; // Overlay number
76 UINT16 e_res
[4]; // Reserved words
77 UINT16 e_oemid
; // OEM identifier (for e_oeminfo)
78 UINT16 e_oeminfo
; // OEM information; e_oemid specific
79 UINT16 e_res2
[10]; // Reserved words
80 UINT32 e_lfanew
; // File address of new exe header
81 } EFI_IMAGE_DOS_HEADER
;
84 /// File header format.
88 UINT16 NumberOfSections
;
90 UINT32 PointerToSymbolTable
;
91 UINT32 NumberOfSymbols
;
92 UINT16 SizeOfOptionalHeader
;
93 UINT16 Characteristics
;
94 } EFI_IMAGE_FILE_HEADER
;
96 #define EFI_IMAGE_SIZEOF_FILE_HEADER 20
98 #define EFI_IMAGE_FILE_RELOCS_STRIPPED 0x0001 // Relocation info stripped from file.
99 #define EFI_IMAGE_FILE_EXECUTABLE_IMAGE 0x0002 // File is executable (i.e. no unresolved externel references).
100 #define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004 // Line nunbers stripped from file.
101 #define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008 // Local symbols stripped from file.
102 #define EFI_IMAGE_FILE_BYTES_REVERSED_LO 0x0080 // Bytes of machine word are reversed.
103 #define EFI_IMAGE_FILE_32BIT_MACHINE 0x0100 // 32 bit word machine.
104 #define EFI_IMAGE_FILE_DEBUG_STRIPPED 0x0200 // Debugging info stripped from file in .DBG file
105 #define EFI_IMAGE_FILE_SYSTEM 0x1000 // System File.
106 #define EFI_IMAGE_FILE_DLL 0x2000 // File is a DLL.
107 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI 0x8000 // Bytes of machine word are reversed.
108 #define EFI_IMAGE_FILE_MACHINE_UNKNOWN 0
109 #define EFI_IMAGE_FILE_MACHINE_I386 0x14c // Intel 386.
110 #define EFI_IMAGE_FILE_MACHINE_R3000 0x162 // MIPS* little-endian, 0540 big-endian
111 #define EFI_IMAGE_FILE_MACHINE_R4000 0x166 // MIPS* little-endian
112 #define EFI_IMAGE_FILE_MACHINE_ALPHA 0x184 // Alpha_AXP*
113 #define EFI_IMAGE_FILE_MACHINE_POWERPC 0x1F0 // IBM* PowerPC Little-Endian
114 #define EFI_IMAGE_FILE_MACHINE_TAHOE 0x7cc // Intel EM machine
116 // * Other names and brands may be claimed as the property of others.
120 /// Directory format.
123 UINT32 VirtualAddress
;
125 } EFI_IMAGE_DATA_DIRECTORY
;
127 #define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16
131 UINT8 MajorLinkerVersion
;
132 UINT8 MinorLinkerVersion
;
134 UINT32 SizeOfInitializedData
;
135 UINT32 SizeOfUninitializedData
;
136 UINT32 AddressOfEntryPoint
;
143 } EFI_IMAGE_ROM_OPTIONAL_HEADER
;
145 #define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC 0x107
146 #define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER)
149 EFI_IMAGE_FILE_HEADER FileHeader
;
150 EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader
;
151 } EFI_IMAGE_ROM_HEADERS
;
155 /// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and
156 /// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary
157 /// after NT additional fields.
159 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
166 UINT8 MajorLinkerVersion
;
167 UINT8 MinorLinkerVersion
;
169 UINT32 SizeOfInitializedData
;
170 UINT32 SizeOfUninitializedData
;
171 UINT32 AddressOfEntryPoint
;
175 // NT additional fields.
178 UINT32 SectionAlignment
;
179 UINT32 FileAlignment
;
180 UINT16 MajorOperatingSystemVersion
;
181 UINT16 MinorOperatingSystemVersion
;
182 UINT16 MajorImageVersion
;
183 UINT16 MinorImageVersion
;
184 UINT16 MajorSubsystemVersion
;
185 UINT16 MinorSubsystemVersion
;
186 UINT32 Win32VersionValue
;
188 UINT32 SizeOfHeaders
;
191 UINT16 DllCharacteristics
;
192 UINT32 SizeOfStackReserve
;
193 UINT32 SizeOfStackCommit
;
194 UINT32 SizeOfHeapReserve
;
195 UINT32 SizeOfHeapCommit
;
197 UINT32 NumberOfRvaAndSizes
;
198 EFI_IMAGE_DATA_DIRECTORY DataDirectory
[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES
];
199 } EFI_IMAGE_OPTIONAL_HEADER32
;
203 /// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and
204 /// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary
205 /// after NT additional fields.
207 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
214 UINT8 MajorLinkerVersion
;
215 UINT8 MinorLinkerVersion
;
217 UINT32 SizeOfInitializedData
;
218 UINT32 SizeOfUninitializedData
;
219 UINT32 AddressOfEntryPoint
;
222 // NT additional fields.
225 UINT32 SectionAlignment
;
226 UINT32 FileAlignment
;
227 UINT16 MajorOperatingSystemVersion
;
228 UINT16 MinorOperatingSystemVersion
;
229 UINT16 MajorImageVersion
;
230 UINT16 MinorImageVersion
;
231 UINT16 MajorSubsystemVersion
;
232 UINT16 MinorSubsystemVersion
;
233 UINT32 Win32VersionValue
;
235 UINT32 SizeOfHeaders
;
238 UINT16 DllCharacteristics
;
239 UINT64 SizeOfStackReserve
;
240 UINT64 SizeOfStackCommit
;
241 UINT64 SizeOfHeapReserve
;
242 UINT64 SizeOfHeapCommit
;
244 UINT32 NumberOfRvaAndSizes
;
245 EFI_IMAGE_DATA_DIRECTORY DataDirectory
[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES
];
246 } EFI_IMAGE_OPTIONAL_HEADER64
;
251 /// EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY
252 /// by tools. All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!
256 EFI_IMAGE_FILE_HEADER FileHeader
;
257 EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader
;
258 } EFI_IMAGE_NT_HEADERS32
;
260 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)
264 EFI_IMAGE_FILE_HEADER FileHeader
;
265 EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader
;
266 } EFI_IMAGE_NT_HEADERS64
;
268 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)
272 // Processor specific definition of EFI_IMAGE_OPTIONAL_HEADER so the
273 // type name EFI_IMAGE_OPTIONAL_HEADER is appropriate to the build. Same for
274 // EFI_IMAGE_NT_HEADERS. These definitions MUST be used by ALL EFI code.
276 #if defined (MDE_CPU_IA32)
278 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
279 (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
281 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
284 // @bug - Remove me when other package updated.
286 typedef EFI_IMAGE_NT_HEADERS32 EFI_IMAGE_NT_HEADERS
;
288 #elif defined (MDE_CPU_IPF)
290 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
291 (((Machine) == EFI_IMAGE_MACHINE_IPF) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
293 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
295 #elif defined (MDE_CPU_X64)
297 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
298 (((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
300 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
303 // @bug - Remove me when other package updated.
305 typedef EFI_IMAGE_NT_HEADERS32 EFI_IMAGE_NT_HEADERS
;
307 #elif defined (MDE_CPU_EBC)
310 // This is just to make sure you can cross compile with the EBC compiiler.
311 // It does not make sense to have a PE loader coded in EBC. You need to
312 // understand the basic
314 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
316 #define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
319 #error Unknown Processor Type
323 #define EFI_IMAGE_FIRST_SECTION(ntheader) \
325 (EFI_IMAGE_SECTION_HEADER *) \
327 (UINT32) ntheader + \
328 FIELD_OFFSET (EFI_IMAGE_NT_HEADERS, OptionalHeader) + \
329 ((EFI_IMAGE_NT_HEADERS *) (ntheader))->FileHeader.SizeOfOptionalHeader \
336 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0
337 #define EFI_IMAGE_SUBSYSTEM_NATIVE 1
338 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2
339 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3.
340 #define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5
341 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7
346 #define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0
347 #define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1
348 #define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2
349 #define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3
350 #define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4
351 #define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5
352 #define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6
353 #define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7
354 #define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8
355 #define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9
356 #define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10
359 // Section header format.
361 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8
364 UINT8 Name
[EFI_IMAGE_SIZEOF_SHORT_NAME
];
366 UINT32 PhysicalAddress
;
369 UINT32 VirtualAddress
;
370 UINT32 SizeOfRawData
;
371 UINT32 PointerToRawData
;
372 UINT32 PointerToRelocations
;
373 UINT32 PointerToLinenumbers
;
374 UINT16 NumberOfRelocations
;
375 UINT16 NumberOfLinenumbers
;
376 UINT32 Characteristics
;
377 } EFI_IMAGE_SECTION_HEADER
;
379 #define EFI_IMAGE_SIZEOF_SECTION_HEADER 40
381 #define EFI_IMAGE_SCN_TYPE_NO_PAD 0x00000008 // Reserved.
382 #define EFI_IMAGE_SCN_CNT_CODE 0x00000020
383 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040
384 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA 0x00000080
386 #define EFI_IMAGE_SCN_LNK_OTHER 0x00000100 // Reserved.
387 #define EFI_IMAGE_SCN_LNK_INFO 0x00000200 // Section contains comments or some other type of information.
388 #define EFI_IMAGE_SCN_LNK_REMOVE 0x00000800 // Section contents will not become part of image.
389 #define EFI_IMAGE_SCN_LNK_COMDAT 0x00001000
391 #define EFI_IMAGE_SCN_ALIGN_1BYTES 0x00100000
392 #define EFI_IMAGE_SCN_ALIGN_2BYTES 0x00200000
393 #define EFI_IMAGE_SCN_ALIGN_4BYTES 0x00300000
394 #define EFI_IMAGE_SCN_ALIGN_8BYTES 0x00400000
395 #define EFI_IMAGE_SCN_ALIGN_16BYTES 0x00500000
396 #define EFI_IMAGE_SCN_ALIGN_32BYTES 0x00600000
397 #define EFI_IMAGE_SCN_ALIGN_64BYTES 0x00700000
399 #define EFI_IMAGE_SCN_MEM_DISCARDABLE 0x02000000
400 #define EFI_IMAGE_SCN_MEM_NOT_CACHED 0x04000000
401 #define EFI_IMAGE_SCN_MEM_NOT_PAGED 0x08000000
402 #define EFI_IMAGE_SCN_MEM_SHARED 0x10000000
403 #define EFI_IMAGE_SCN_MEM_EXECUTE 0x20000000
404 #define EFI_IMAGE_SCN_MEM_READ 0x40000000
405 #define EFI_IMAGE_SCN_MEM_WRITE 0x80000000
410 #define EFI_IMAGE_SIZEOF_SYMBOL 18
415 // Symbols have a section number of the section in which they are
416 // defined. Otherwise, section numbers have the following meanings:
418 #define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 // Symbol is undefined or is common.
419 #define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 // Symbol is an absolute value.
420 #define EFI_IMAGE_SYM_DEBUG (UINT16) -2 // Symbol is a special debug item.
422 // Type (fundamental) values.
424 #define EFI_IMAGE_SYM_TYPE_NULL 0 // no type.
425 #define EFI_IMAGE_SYM_TYPE_VOID 1 //
426 #define EFI_IMAGE_SYM_TYPE_CHAR 2 // type character.
427 #define EFI_IMAGE_SYM_TYPE_SHORT 3 // type short integer.
428 #define EFI_IMAGE_SYM_TYPE_INT 4
429 #define EFI_IMAGE_SYM_TYPE_LONG 5
430 #define EFI_IMAGE_SYM_TYPE_FLOAT 6
431 #define EFI_IMAGE_SYM_TYPE_DOUBLE 7
432 #define EFI_IMAGE_SYM_TYPE_STRUCT 8
433 #define EFI_IMAGE_SYM_TYPE_UNION 9
434 #define EFI_IMAGE_SYM_TYPE_ENUM 10 // enumeration.
435 #define EFI_IMAGE_SYM_TYPE_MOE 11 // member of enumeration.
436 #define EFI_IMAGE_SYM_TYPE_BYTE 12
437 #define EFI_IMAGE_SYM_TYPE_WORD 13
438 #define EFI_IMAGE_SYM_TYPE_UINT 14
439 #define EFI_IMAGE_SYM_TYPE_DWORD 15
442 // Type (derived) values.
444 #define EFI_IMAGE_SYM_DTYPE_NULL 0 // no derived type.
445 #define EFI_IMAGE_SYM_DTYPE_POINTER 1
446 #define EFI_IMAGE_SYM_DTYPE_FUNCTION 2
447 #define EFI_IMAGE_SYM_DTYPE_ARRAY 3
452 #define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION (UINT8) -1
453 #define EFI_IMAGE_SYM_CLASS_NULL 0
454 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1
455 #define EFI_IMAGE_SYM_CLASS_EXTERNAL 2
456 #define EFI_IMAGE_SYM_CLASS_STATIC 3
457 #define EFI_IMAGE_SYM_CLASS_REGISTER 4
458 #define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5
459 #define EFI_IMAGE_SYM_CLASS_LABEL 6
460 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7
461 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8
462 #define EFI_IMAGE_SYM_CLASS_ARGUMENT 9
463 #define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10
464 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11
465 #define EFI_IMAGE_SYM_CLASS_UNION_TAG 12
466 #define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13
467 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14
468 #define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15
469 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16
470 #define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17
471 #define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18
472 #define EFI_IMAGE_SYM_CLASS_BLOCK 100
473 #define EFI_IMAGE_SYM_CLASS_FUNCTION 101
474 #define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102
475 #define EFI_IMAGE_SYM_CLASS_FILE 103
476 #define EFI_IMAGE_SYM_CLASS_SECTION 104
477 #define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105
480 // type packing constants
482 #define EFI_IMAGE_N_BTMASK 017
483 #define EFI_IMAGE_N_TMASK 060
484 #define EFI_IMAGE_N_TMASK1 0300
485 #define EFI_IMAGE_N_TMASK2 0360
486 #define EFI_IMAGE_N_BTSHFT 4
487 #define EFI_IMAGE_N_TSHIFT 2
490 // Communal selection types.
492 #define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1
493 #define EFI_IMAGE_COMDAT_SELECT_ANY 2
494 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3
495 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4
496 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5
498 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
499 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2
500 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3
503 /// Relocation format.
506 UINT32 VirtualAddress
;
507 UINT32 SymbolTableIndex
;
509 } EFI_IMAGE_RELOCATION
;
511 #define EFI_IMAGE_SIZEOF_RELOCATION 10
514 // I386 relocation types.
516 #define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 // Reference is absolute, no relocation is necessary
517 #define EFI_IMAGE_REL_I386_DIR16 0x0001 // Direct 16-bit reference to the symbols virtual address
518 #define EFI_IMAGE_REL_I386_REL16 0x0002 // PC-relative 16-bit reference to the symbols virtual address
519 #define EFI_IMAGE_REL_I386_DIR32 0x0006 // Direct 32-bit reference to the symbols virtual address
520 #define EFI_IMAGE_REL_I386_DIR32NB 0x0007 // Direct 32-bit reference to the symbols virtual address, base not included
521 #define EFI_IMAGE_REL_I386_SEG12 0x0009 // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
522 #define EFI_IMAGE_REL_I386_SECTION 0x001a
523 #define EFI_IMAGE_REL_I386_SECREL 0x000b
524 #define EFI_IMAGE_REL_I386_REL32 0x0014 // PC-relative 32-bit reference to the symbols virtual address
527 // x64 processor relocation types.
529 #define IMAGE_REL_AMD64_ABSOLUTE 0x0000
530 #define IMAGE_REL_AMD64_ADDR64 0x0001
531 #define IMAGE_REL_AMD64_ADDR32 0x0002
532 #define IMAGE_REL_AMD64_ADDR32NB 0x0003
533 #define IMAGE_REL_AMD64_REL32 0x0004
534 #define IMAGE_REL_AMD64_REL32_1 0x0005
535 #define IMAGE_REL_AMD64_REL32_2 0x0006
536 #define IMAGE_REL_AMD64_REL32_3 0x0007
537 #define IMAGE_REL_AMD64_REL32_4 0x0008
538 #define IMAGE_REL_AMD64_REL32_5 0x0009
539 #define IMAGE_REL_AMD64_SECTION 0x000A
540 #define IMAGE_REL_AMD64_SECREL 0x000B
541 #define IMAGE_REL_AMD64_SECREL7 0x000C
542 #define IMAGE_REL_AMD64_TOKEN 0x000D
543 #define IMAGE_REL_AMD64_SREL32 0x000E
544 #define IMAGE_REL_AMD64_PAIR 0x000F
545 #define IMAGE_REL_AMD64_SSPAN32 0x0010
548 /// Based relocation format.
551 UINT32 VirtualAddress
;
553 } EFI_IMAGE_BASE_RELOCATION
;
555 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8
558 // Based relocation types.
560 #define EFI_IMAGE_REL_BASED_ABSOLUTE 0
561 #define EFI_IMAGE_REL_BASED_HIGH 1
562 #define EFI_IMAGE_REL_BASED_LOW 2
563 #define EFI_IMAGE_REL_BASED_HIGHLOW 3
564 #define EFI_IMAGE_REL_BASED_HIGHADJ 4
565 #define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5
566 #define EFI_IMAGE_REL_BASED_IA64_IMM64 9
567 #define EFI_IMAGE_REL_BASED_DIR64 10
570 /// Line number format.
574 UINT32 SymbolTableIndex
; // Symbol table index of function name if Linenumber is 0.
575 UINT32 VirtualAddress
; // Virtual address of line number.
577 UINT16 Linenumber
; // Line number.
578 } EFI_IMAGE_LINENUMBER
;
580 #define EFI_IMAGE_SIZEOF_LINENUMBER 6
585 #define EFI_IMAGE_ARCHIVE_START_SIZE 8
586 #define EFI_IMAGE_ARCHIVE_START "!<arch>\n"
587 #define EFI_IMAGE_ARCHIVE_END "`\n"
588 #define EFI_IMAGE_ARCHIVE_PAD "\n"
589 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ "
590 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// "
593 UINT8 Name
[16]; // File member name - `/' terminated.
594 UINT8 Date
[12]; // File member date - decimal.
595 UINT8 UserID
[6]; // File member user id - decimal.
596 UINT8 GroupID
[6]; // File member group id - decimal.
597 UINT8 Mode
[8]; // File member mode - octal.
598 UINT8 Size
[10]; // File member size - decimal.
599 UINT8 EndHeader
[2]; // String to end header.
600 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER
;
602 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
609 /// DLL Export Format
612 UINT32 Characteristics
;
613 UINT32 TimeDateStamp
;
618 UINT32 NumberOfFunctions
;
619 UINT32 NumberOfNames
;
620 UINT32 AddressOfFunctions
;
621 UINT32 AddressOfNames
;
622 UINT32 AddressOfNameOrdinals
;
623 } EFI_IMAGE_EXPORT_DIRECTORY
;
632 } EFI_IMAGE_IMPORT_BY_NAME
;
638 EFI_IMAGE_IMPORT_BY_NAME
*AddressOfData
;
640 } EFI_IMAGE_THUNK_DATA
;
642 #define EFI_IMAGE_ORDINAL_FLAG 0x80000000
643 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
644 #define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
647 UINT32 Characteristics
;
648 UINT32 TimeDateStamp
;
649 UINT32 ForwarderChain
;
651 EFI_IMAGE_THUNK_DATA
*FirstThunk
;
652 } EFI_IMAGE_IMPORT_DESCRIPTOR
;
657 #define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2
660 UINT32 Characteristics
;
661 UINT32 TimeDateStamp
;
668 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY
;
670 #define CODEVIEW_SIGNATURE_NB10 0x3031424E // "NB10"
672 UINT32 Signature
; // "NB10"
677 // Filename of .PDB goes here
679 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY
;
681 #define CODEVIEW_SIGNATURE_RSDS 0x53445352 // "RSDS"
683 UINT32 Signature
; // "RSDS"
690 // Filename of .PDB goes here
692 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY
;
695 /// Header format for TE images
698 UINT16 Signature
; // signature for TE format = "VZ"
699 UINT16 Machine
; // from the original file header
700 UINT8 NumberOfSections
; // from the original file header
701 UINT8 Subsystem
; // from original optional header
702 UINT16 StrippedSize
; // how many bytes we removed from the header
703 UINT32 AddressOfEntryPoint
; // offset to entry point -- from original optional header
704 UINT32 BaseOfCode
; // from original image -- required for ITP debug
705 UINT64 ImageBase
; // from original file header
706 EFI_IMAGE_DATA_DIRECTORY DataDirectory
[2]; // only base relocation and debug directory
707 } EFI_TE_IMAGE_HEADER
;
709 #define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56 // "VZ"
712 // Data directory indexes in our TE image header
714 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0
715 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1
719 // Union of PE32, PE32+, and TE headers
722 EFI_IMAGE_NT_HEADERS32 Pe32
;
723 EFI_IMAGE_NT_HEADERS64 Pe32Plus
;
724 EFI_TE_IMAGE_HEADER Te
;
725 } EFI_IMAGE_OPTIONAL_HEADER_UNION
;
728 EFI_IMAGE_NT_HEADERS32
*Pe32
;
729 EFI_IMAGE_NT_HEADERS64
*Pe32Plus
;
730 EFI_TE_IMAGE_HEADER
*Te
;
731 EFI_IMAGE_OPTIONAL_HEADER_UNION
*Union
;
732 } EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION
;