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