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