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