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