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