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