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