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