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