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