/** @file | |
EFI image format for PE32+. Please note some data structures are different | |
for IA-32 and Itanium-based images, look for UINTN and the #ifdef EFI_IA64 | |
@bug Fix text - doc as defined in MSFT EFI specification. | |
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR> | |
Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR> | |
This program and the accompanying materials are licensed and made available | |
under the terms and conditions of the BSD License which accompanies this | |
distribution. The full text of the license may be found at | |
http://opensource.org/licenses/bsd-license.php | |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
**/ | |
#ifndef __PE_IMAGE_H__ | |
#define __PE_IMAGE_H__ | |
// | |
// PE32+ Subsystem type for EFI images | |
// | |
#define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10 | |
#define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11 | |
#define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12 | |
#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13 | |
// | |
// BugBug: Need to get a real answer for this problem. This is not in the | |
// PE specification. | |
// | |
// A SAL runtime driver does not get fixed up when a transition to | |
// virtual mode is made. In all other cases it should be treated | |
// like a EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER image | |
// | |
#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13 | |
// | |
// PE32+ Machine type for EFI images | |
// | |
#define IMAGE_FILE_MACHINE_I386 0x014c | |
#define IMAGE_FILE_MACHINE_IA64 0x0200 | |
#define IMAGE_FILE_MACHINE_EBC 0x0EBC | |
#define IMAGE_FILE_MACHINE_X64 0x8664 | |
#define IMAGE_FILE_MACHINE_ARM 0x01c0 // Thumb only | |
#define IMAGE_FILE_MACHINE_ARMT 0x01c2 // 32bit Mixed ARM and Thumb/Thumb 2 Little Endian | |
#define IMAGE_FILE_MACHINE_ARM64 0xAA64 // 64bit ARM Architecture, Little Endian | |
// | |
// Support old names for backward compatible | |
// | |
#define EFI_IMAGE_MACHINE_IA32 IMAGE_FILE_MACHINE_I386 | |
#define EFI_IMAGE_MACHINE_IA64 IMAGE_FILE_MACHINE_IA64 | |
#define EFI_IMAGE_MACHINE_IPF IMAGE_FILE_MACHINE_IA64 | |
#define EFI_IMAGE_MACHINE_EBC IMAGE_FILE_MACHINE_EBC | |
#define EFI_IMAGE_MACHINE_X64 IMAGE_FILE_MACHINE_X64 | |
#define EFI_IMAGE_MACHINE_ARMT IMAGE_FILE_MACHINE_ARMT | |
#define EFI_IMAGE_MACHINE_AARCH64 IMAGE_FILE_MACHINE_ARM64 | |
#define EFI_IMAGE_DOS_SIGNATURE 0x5A4D // MZ | |
#define EFI_IMAGE_OS2_SIGNATURE 0x454E // NE | |
#define EFI_IMAGE_OS2_SIGNATURE_LE 0x454C // LE | |
#define EFI_IMAGE_NT_SIGNATURE 0x00004550 // PE00 | |
#define EFI_IMAGE_EDOS_SIGNATURE 0x44454550 // PEED | |
/// | |
/// PE images can start with an optional DOS header, so if an image is run | |
/// under DOS it can print an error message. | |
/// | |
typedef struct { | |
UINT16 e_magic; // Magic number | |
UINT16 e_cblp; // Bytes on last page of file | |
UINT16 e_cp; // Pages in file | |
UINT16 e_crlc; // Relocations | |
UINT16 e_cparhdr; // Size of header in paragraphs | |
UINT16 e_minalloc; // Minimum extra paragraphs needed | |
UINT16 e_maxalloc; // Maximum extra paragraphs needed | |
UINT16 e_ss; // Initial (relative) SS value | |
UINT16 e_sp; // Initial SP value | |
UINT16 e_csum; // Checksum | |
UINT16 e_ip; // Initial IP value | |
UINT16 e_cs; // Initial (relative) CS value | |
UINT16 e_lfarlc; // File address of relocation table | |
UINT16 e_ovno; // Overlay number | |
UINT16 e_res[4]; // Reserved words | |
UINT16 e_oemid; // OEM identifier (for e_oeminfo) | |
UINT16 e_oeminfo; // OEM information; e_oemid specific | |
UINT16 e_res2[10]; // Reserved words | |
UINT32 e_lfanew; // File address of new exe header | |
} EFI_IMAGE_DOS_HEADER; | |
/// | |
/// File header format. | |
/// | |
typedef struct { | |
UINT16 Machine; | |
UINT16 NumberOfSections; | |
UINT32 TimeDateStamp; | |
UINT32 PointerToSymbolTable; | |
UINT32 NumberOfSymbols; | |
UINT16 SizeOfOptionalHeader; | |
UINT16 Characteristics; | |
} EFI_IMAGE_FILE_HEADER; | |
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20 | |
#define EFI_IMAGE_FILE_RELOCS_STRIPPED 0x0001 // Relocation info stripped from file. | |
#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE 0x0002 // File is executable (i.e. no unresolved externel references). | |
#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004 // Line nunbers stripped from file. | |
#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008 // Local symbols stripped from file. | |
#define EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE 0x0020 // Supports addresses > 2-GB | |
#define EFI_IMAGE_FILE_BYTES_REVERSED_LO 0x0080 // Bytes of machine word are reversed. | |
#define EFI_IMAGE_FILE_32BIT_MACHINE 0x0100 // 32 bit word machine. | |
#define EFI_IMAGE_FILE_DEBUG_STRIPPED 0x0200 // Debugging info stripped from file in .DBG file | |
#define EFI_IMAGE_FILE_SYSTEM 0x1000 // System File. | |
#define EFI_IMAGE_FILE_DLL 0x2000 // File is a DLL. | |
#define EFI_IMAGE_FILE_BYTES_REVERSED_HI 0x8000 // Bytes of machine word are reversed. | |
#define EFI_IMAGE_FILE_MACHINE_UNKNOWN 0 | |
#define EFI_IMAGE_FILE_MACHINE_I386 0x14c // Intel 386. | |
#define EFI_IMAGE_FILE_MACHINE_R3000 0x162 // MIPS* little-endian, 0540 big-endian | |
#define EFI_IMAGE_FILE_MACHINE_R4000 0x166 // MIPS* little-endian | |
#define EFI_IMAGE_FILE_MACHINE_ALPHA 0x184 // Alpha_AXP* | |
#define EFI_IMAGE_FILE_MACHINE_POWERPC 0x1F0 // IBM* PowerPC Little-Endian | |
#define EFI_IMAGE_FILE_MACHINE_TAHOE 0x7cc // Intel EM machine | |
// | |
// * Other names and brands may be claimed as the property of others. | |
// | |
/// | |
/// Directory format. | |
/// | |
typedef struct { | |
UINT32 VirtualAddress; | |
UINT32 Size; | |
} EFI_IMAGE_DATA_DIRECTORY; | |
#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16 | |
typedef struct { | |
UINT16 Magic; | |
UINT8 MajorLinkerVersion; | |
UINT8 MinorLinkerVersion; | |
UINT32 SizeOfCode; | |
UINT32 SizeOfInitializedData; | |
UINT32 SizeOfUninitializedData; | |
UINT32 AddressOfEntryPoint; | |
UINT32 BaseOfCode; | |
UINT32 BaseOfData; | |
UINT32 BaseOfBss; | |
UINT32 GprMask; | |
UINT32 CprMask[4]; | |
UINT32 GpValue; | |
} EFI_IMAGE_ROM_OPTIONAL_HEADER; | |
#define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC 0x107 | |
#define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER) | |
typedef struct { | |
EFI_IMAGE_FILE_HEADER FileHeader; | |
EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader; | |
} EFI_IMAGE_ROM_HEADERS; | |
/// | |
/// @attention | |
/// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64 | |
/// are for use ONLY by tools. All proper EFI code MUST use | |
/// EFI_IMAGE_OPTIONAL_HEADER ONLY!!! | |
/// | |
#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b | |
typedef struct { | |
// | |
// Standard fields. | |
// | |
UINT16 Magic; | |
UINT8 MajorLinkerVersion; | |
UINT8 MinorLinkerVersion; | |
UINT32 SizeOfCode; | |
UINT32 SizeOfInitializedData; | |
UINT32 SizeOfUninitializedData; | |
UINT32 AddressOfEntryPoint; | |
UINT32 BaseOfCode; | |
UINT32 BaseOfData; | |
// | |
// NT additional fields. | |
// | |
UINT32 ImageBase; | |
UINT32 SectionAlignment; | |
UINT32 FileAlignment; | |
UINT16 MajorOperatingSystemVersion; | |
UINT16 MinorOperatingSystemVersion; | |
UINT16 MajorImageVersion; | |
UINT16 MinorImageVersion; | |
UINT16 MajorSubsystemVersion; | |
UINT16 MinorSubsystemVersion; | |
UINT32 Win32VersionValue; | |
UINT32 SizeOfImage; | |
UINT32 SizeOfHeaders; | |
UINT32 CheckSum; | |
UINT16 Subsystem; | |
UINT16 DllCharacteristics; | |
UINT32 SizeOfStackReserve; | |
UINT32 SizeOfStackCommit; | |
UINT32 SizeOfHeapReserve; | |
UINT32 SizeOfHeapCommit; | |
UINT32 LoaderFlags; | |
UINT32 NumberOfRvaAndSizes; | |
EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES]; | |
} EFI_IMAGE_OPTIONAL_HEADER32; | |
/// | |
/// @attention | |
/// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64 | |
/// are for use ONLY by tools. All proper EFI code MUST use | |
/// EFI_IMAGE_OPTIONAL_HEADER ONLY!!! | |
/// | |
#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b | |
typedef struct { | |
// | |
// Standard fields. | |
// | |
UINT16 Magic; | |
UINT8 MajorLinkerVersion; | |
UINT8 MinorLinkerVersion; | |
UINT32 SizeOfCode; | |
UINT32 SizeOfInitializedData; | |
UINT32 SizeOfUninitializedData; | |
UINT32 AddressOfEntryPoint; | |
UINT32 BaseOfCode; | |
// | |
// NT additional fields. | |
// | |
UINT64 ImageBase; | |
UINT32 SectionAlignment; | |
UINT32 FileAlignment; | |
UINT16 MajorOperatingSystemVersion; | |
UINT16 MinorOperatingSystemVersion; | |
UINT16 MajorImageVersion; | |
UINT16 MinorImageVersion; | |
UINT16 MajorSubsystemVersion; | |
UINT16 MinorSubsystemVersion; | |
UINT32 Win32VersionValue; | |
UINT32 SizeOfImage; | |
UINT32 SizeOfHeaders; | |
UINT32 CheckSum; | |
UINT16 Subsystem; | |
UINT16 DllCharacteristics; | |
UINT64 SizeOfStackReserve; | |
UINT64 SizeOfStackCommit; | |
UINT64 SizeOfHeapReserve; | |
UINT64 SizeOfHeapCommit; | |
UINT32 LoaderFlags; | |
UINT32 NumberOfRvaAndSizes; | |
EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES]; | |
} EFI_IMAGE_OPTIONAL_HEADER64; | |
/// | |
/// @attention | |
/// EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY | |
/// by tools. All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!! | |
/// | |
typedef struct { | |
UINT32 Signature; | |
EFI_IMAGE_FILE_HEADER FileHeader; | |
EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader; | |
} EFI_IMAGE_NT_HEADERS32; | |
#define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32) | |
typedef struct { | |
UINT32 Signature; | |
EFI_IMAGE_FILE_HEADER FileHeader; | |
EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader; | |
} EFI_IMAGE_NT_HEADERS64; | |
#define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64) | |
// | |
// Subsystem Values | |
// | |
#define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0 | |
#define EFI_IMAGE_SUBSYSTEM_NATIVE 1 | |
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2 | |
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3. | |
#define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5 | |
#define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7 | |
// | |
// Directory Entries | |
// | |
#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9 | |
#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10 | |
// | |
// Section header format. | |
// | |
#define EFI_IMAGE_SIZEOF_SHORT_NAME 8 | |
typedef struct { | |
UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME]; | |
union { | |
UINT32 PhysicalAddress; | |
UINT32 VirtualSize; | |
} Misc; | |
UINT32 VirtualAddress; | |
UINT32 SizeOfRawData; | |
UINT32 PointerToRawData; | |
UINT32 PointerToRelocations; | |
UINT32 PointerToLinenumbers; | |
UINT16 NumberOfRelocations; | |
UINT16 NumberOfLinenumbers; | |
UINT32 Characteristics; | |
} EFI_IMAGE_SECTION_HEADER; | |
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40 | |
#define EFI_IMAGE_SCN_TYPE_NO_PAD 0x00000008 // Reserved. | |
#define EFI_IMAGE_SCN_CNT_CODE 0x00000020 | |
#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040 | |
#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA 0x00000080 | |
#define EFI_IMAGE_SCN_LNK_OTHER 0x00000100 // Reserved. | |
#define EFI_IMAGE_SCN_LNK_INFO 0x00000200 // Section contains comments or some other type of information. | |
#define EFI_IMAGE_SCN_LNK_REMOVE 0x00000800 // Section contents will not become part of image. | |
#define EFI_IMAGE_SCN_LNK_COMDAT 0x00001000 | |
#define EFI_IMAGE_SCN_ALIGN_1BYTES 0x00100000 | |
#define EFI_IMAGE_SCN_ALIGN_2BYTES 0x00200000 | |
#define EFI_IMAGE_SCN_ALIGN_4BYTES 0x00300000 | |
#define EFI_IMAGE_SCN_ALIGN_8BYTES 0x00400000 | |
#define EFI_IMAGE_SCN_ALIGN_16BYTES 0x00500000 | |
#define EFI_IMAGE_SCN_ALIGN_32BYTES 0x00600000 | |
#define EFI_IMAGE_SCN_ALIGN_64BYTES 0x00700000 | |
#define EFI_IMAGE_SCN_MEM_DISCARDABLE 0x02000000 | |
#define EFI_IMAGE_SCN_MEM_NOT_CACHED 0x04000000 | |
#define EFI_IMAGE_SCN_MEM_NOT_PAGED 0x08000000 | |
#define EFI_IMAGE_SCN_MEM_SHARED 0x10000000 | |
#define EFI_IMAGE_SCN_MEM_EXECUTE 0x20000000 | |
#define EFI_IMAGE_SCN_MEM_READ 0x40000000 | |
#define EFI_IMAGE_SCN_MEM_WRITE 0x80000000 | |
/// | |
/// Symbol format. | |
/// | |
#define EFI_IMAGE_SIZEOF_SYMBOL 18 | |
// | |
// Section values. | |
// | |
// Symbols have a section number of the section in which they are | |
// defined. Otherwise, section numbers have the following meanings: | |
// | |
#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 // Symbol is undefined or is common. | |
#define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 // Symbol is an absolute value. | |
#define EFI_IMAGE_SYM_DEBUG (UINT16) -2 // Symbol is a special debug item. | |
// | |
// Type (fundamental) values. | |
// | |
#define EFI_IMAGE_SYM_TYPE_NULL 0 // no type. | |
#define EFI_IMAGE_SYM_TYPE_VOID 1 // | |
#define EFI_IMAGE_SYM_TYPE_CHAR 2 // type character. | |
#define EFI_IMAGE_SYM_TYPE_SHORT 3 // type short integer. | |
#define EFI_IMAGE_SYM_TYPE_INT 4 | |
#define EFI_IMAGE_SYM_TYPE_LONG 5 | |
#define EFI_IMAGE_SYM_TYPE_FLOAT 6 | |
#define EFI_IMAGE_SYM_TYPE_DOUBLE 7 | |
#define EFI_IMAGE_SYM_TYPE_STRUCT 8 | |
#define EFI_IMAGE_SYM_TYPE_UNION 9 | |
#define EFI_IMAGE_SYM_TYPE_ENUM 10 // enumeration. | |
#define EFI_IMAGE_SYM_TYPE_MOE 11 // member of enumeration. | |
#define EFI_IMAGE_SYM_TYPE_BYTE 12 | |
#define EFI_IMAGE_SYM_TYPE_WORD 13 | |
#define EFI_IMAGE_SYM_TYPE_UINT 14 | |
#define EFI_IMAGE_SYM_TYPE_DWORD 15 | |
// | |
// Type (derived) values. | |
// | |
#define EFI_IMAGE_SYM_DTYPE_NULL 0 // no derived type. | |
#define EFI_IMAGE_SYM_DTYPE_POINTER 1 | |
#define EFI_IMAGE_SYM_DTYPE_FUNCTION 2 | |
#define EFI_IMAGE_SYM_DTYPE_ARRAY 3 | |
// | |
// Storage classes. | |
// | |
#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION (UINT8) -1 | |
#define EFI_IMAGE_SYM_CLASS_NULL 0 | |
#define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1 | |
#define EFI_IMAGE_SYM_CLASS_EXTERNAL 2 | |
#define EFI_IMAGE_SYM_CLASS_STATIC 3 | |
#define EFI_IMAGE_SYM_CLASS_REGISTER 4 | |
#define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5 | |
#define EFI_IMAGE_SYM_CLASS_LABEL 6 | |
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7 | |
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8 | |
#define EFI_IMAGE_SYM_CLASS_ARGUMENT 9 | |
#define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10 | |
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11 | |
#define EFI_IMAGE_SYM_CLASS_UNION_TAG 12 | |
#define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13 | |
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14 | |
#define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15 | |
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16 | |
#define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17 | |
#define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18 | |
#define EFI_IMAGE_SYM_CLASS_BLOCK 100 | |
#define EFI_IMAGE_SYM_CLASS_FUNCTION 101 | |
#define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102 | |
#define EFI_IMAGE_SYM_CLASS_FILE 103 | |
#define EFI_IMAGE_SYM_CLASS_SECTION 104 | |
#define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105 | |
// | |
// type packing constants | |
// | |
#define EFI_IMAGE_N_BTMASK 017 | |
#define EFI_IMAGE_N_TMASK 060 | |
#define EFI_IMAGE_N_TMASK1 0300 | |
#define EFI_IMAGE_N_TMASK2 0360 | |
#define EFI_IMAGE_N_BTSHFT 4 | |
#define EFI_IMAGE_N_TSHIFT 2 | |
// | |
// Communal selection types. | |
// | |
#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1 | |
#define EFI_IMAGE_COMDAT_SELECT_ANY 2 | |
#define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3 | |
#define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4 | |
#define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5 | |
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1 | |
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2 | |
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3 | |
/// | |
/// Relocation format. | |
/// | |
typedef struct { | |
UINT32 VirtualAddress; | |
UINT32 SymbolTableIndex; | |
UINT16 Type; | |
} EFI_IMAGE_RELOCATION; | |
#define EFI_IMAGE_SIZEOF_RELOCATION 10 | |
// | |
// I386 relocation types. | |
// | |
#define EFI_IMAGE_REL_I386_ABSOLUTE 0 // Reference is absolute, no relocation is necessary | |
#define EFI_IMAGE_REL_I386_DIR16 01 // Direct 16-bit reference to the symbols virtual address | |
#define EFI_IMAGE_REL_I386_REL16 02 // PC-relative 16-bit reference to the symbols virtual address | |
#define EFI_IMAGE_REL_I386_DIR32 06 // Direct 32-bit reference to the symbols virtual address | |
#define EFI_IMAGE_REL_I386_DIR32NB 07 // Direct 32-bit reference to the symbols virtual address, base not included | |
#define EFI_IMAGE_REL_I386_SEG12 09 // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address | |
#define EFI_IMAGE_REL_I386_SECTION 010 | |
#define EFI_IMAGE_REL_I386_SECREL 011 | |
#define EFI_IMAGE_REL_I386_REL32 020 // PC-relative 32-bit reference to the symbols virtual address | |
// | |
// x64 processor relocation types. | |
// | |
#define IMAGE_REL_AMD64_ABSOLUTE 0x0000 | |
#define IMAGE_REL_AMD64_ADDR64 0x0001 | |
#define IMAGE_REL_AMD64_ADDR32 0x0002 | |
#define IMAGE_REL_AMD64_ADDR32NB 0x0003 | |
#define IMAGE_REL_AMD64_REL32 0x0004 | |
#define IMAGE_REL_AMD64_REL32_1 0x0005 | |
#define IMAGE_REL_AMD64_REL32_2 0x0006 | |
#define IMAGE_REL_AMD64_REL32_3 0x0007 | |
#define IMAGE_REL_AMD64_REL32_4 0x0008 | |
#define IMAGE_REL_AMD64_REL32_5 0x0009 | |
#define IMAGE_REL_AMD64_SECTION 0x000A | |
#define IMAGE_REL_AMD64_SECREL 0x000B | |
#define IMAGE_REL_AMD64_SECREL7 0x000C | |
#define IMAGE_REL_AMD64_TOKEN 0x000D | |
#define IMAGE_REL_AMD64_SREL32 0x000E | |
#define IMAGE_REL_AMD64_PAIR 0x000F | |
#define IMAGE_REL_AMD64_SSPAN32 0x0010 | |
/// | |
/// Based relocation format. | |
/// | |
typedef struct { | |
UINT32 VirtualAddress; | |
UINT32 SizeOfBlock; | |
} EFI_IMAGE_BASE_RELOCATION; | |
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8 | |
// | |
// Based relocation types. | |
// | |
#define EFI_IMAGE_REL_BASED_ABSOLUTE 0 | |
#define EFI_IMAGE_REL_BASED_HIGH 1 | |
#define EFI_IMAGE_REL_BASED_LOW 2 | |
#define EFI_IMAGE_REL_BASED_HIGHLOW 3 | |
#define EFI_IMAGE_REL_BASED_HIGHADJ 4 | |
#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5 | |
#define EFI_IMAGE_REL_BASED_ARM_MOV32A 5 | |
#define EFI_IMAGE_REL_BASED_ARM_MOV32T 7 | |
#define EFI_IMAGE_REL_BASED_IA64_IMM64 9 | |
#define EFI_IMAGE_REL_BASED_DIR64 10 | |
/// | |
/// Line number format. | |
/// | |
typedef struct { | |
union { | |
UINT32 SymbolTableIndex; // Symbol table index of function name if Linenumber is 0. | |
UINT32 VirtualAddress; // Virtual address of line number. | |
} Type; | |
UINT16 Linenumber; // Line number. | |
} EFI_IMAGE_LINENUMBER; | |
#define EFI_IMAGE_SIZEOF_LINENUMBER 6 | |
// | |
// Archive format. | |
// | |
#define EFI_IMAGE_ARCHIVE_START_SIZE 8 | |
#define EFI_IMAGE_ARCHIVE_START "!<arch>\n" | |
#define EFI_IMAGE_ARCHIVE_END "`\n" | |
#define EFI_IMAGE_ARCHIVE_PAD "\n" | |
#define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ " | |
#define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// " | |
typedef struct { | |
UINT8 Name[16]; // File member name - `/' terminated. | |
UINT8 Date[12]; // File member date - decimal. | |
UINT8 UserID[6]; // File member user id - decimal. | |
UINT8 GroupID[6]; // File member group id - decimal. | |
UINT8 Mode[8]; // File member mode - octal. | |
UINT8 Size[10]; // File member size - decimal. | |
UINT8 EndHeader[2]; // String to end header. | |
} EFI_IMAGE_ARCHIVE_MEMBER_HEADER; | |
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60 | |
// | |
// DLL support. | |
// | |
/// | |
/// DLL Export Format | |
/// | |
typedef struct { | |
UINT32 Characteristics; | |
UINT32 TimeDateStamp; | |
UINT16 MajorVersion; | |
UINT16 MinorVersion; | |
UINT32 Name; | |
UINT32 Base; | |
UINT32 NumberOfFunctions; | |
UINT32 NumberOfNames; | |
UINT32 AddressOfFunctions; | |
UINT32 AddressOfNames; | |
UINT32 AddressOfNameOrdinals; | |
} EFI_IMAGE_EXPORT_DIRECTORY; | |
/// | |
/// DLL support. | |
/// Import Format | |
/// | |
typedef struct { | |
UINT16 Hint; | |
UINT8 Name[1]; | |
} EFI_IMAGE_IMPORT_BY_NAME; | |
typedef struct { | |
union { | |
UINT32 Function; | |
UINT32 Ordinal; | |
EFI_IMAGE_IMPORT_BY_NAME *AddressOfData; | |
} u1; | |
} EFI_IMAGE_THUNK_DATA; | |
#define EFI_IMAGE_ORDINAL_FLAG 0x80000000 | |
#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0) | |
#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff) | |
typedef struct { | |
UINT32 Characteristics; | |
UINT32 TimeDateStamp; | |
UINT32 ForwarderChain; | |
UINT32 Name; | |
EFI_IMAGE_THUNK_DATA *FirstThunk; | |
} EFI_IMAGE_IMPORT_DESCRIPTOR; | |
/// | |
/// Debug Format | |
/// | |
#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 | |
typedef struct { | |
UINT32 Characteristics; | |
UINT32 TimeDateStamp; | |
UINT16 MajorVersion; | |
UINT16 MinorVersion; | |
UINT32 Type; | |
UINT32 SizeOfData; | |
UINT32 RVA; | |
UINT32 FileOffset; | |
} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY; | |
#define CODEVIEW_SIGNATURE_NB10 0x3031424E // "NB10" | |
typedef struct { | |
UINT32 Signature; // "NB10" | |
UINT32 Unknown; | |
UINT32 Unknown2; | |
UINT32 Unknown3; | |
// | |
// Filename of .PDB goes here | |
// | |
} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY; | |
#define CODEVIEW_SIGNATURE_RSDS 0x53445352 // "RSDS" | |
typedef struct { | |
UINT32 Signature; // "RSDS" | |
UINT32 Unknown; | |
UINT32 Unknown2; | |
UINT32 Unknown3; | |
UINT32 Unknown4; | |
UINT32 Unknown5; | |
// | |
// Filename of .PDB goes here | |
// | |
} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY; | |
/// | |
/// Debug Data Structure defined by Apple Mach-O to Coff utility | |
/// | |
#define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C') | |
typedef struct { | |
UINT32 Signature; ///< "MTOC" | |
EFI_GUID MachOUuid; | |
// | |
// Filename of .DLL (Mach-O with debug info) goes here | |
// | |
} EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY; | |
// | |
// .pdata entries for X64 | |
// | |
typedef struct { | |
UINT32 FunctionStartAddress; | |
UINT32 FunctionEndAddress; | |
UINT32 UnwindInfoAddress; | |
} RUNTIME_FUNCTION; | |
typedef struct { | |
UINT8 Version:3; | |
UINT8 Flags:5; | |
UINT8 SizeOfProlog; | |
UINT8 CountOfUnwindCodes; | |
UINT8 FrameRegister:4; | |
UINT8 FrameRegisterOffset:4; | |
} UNWIND_INFO; | |
/// | |
/// Resource format. | |
/// | |
typedef struct { | |
UINT32 Characteristics; | |
UINT32 TimeDateStamp; | |
UINT16 MajorVersion; | |
UINT16 MinorVersion; | |
UINT16 NumberOfNamedEntries; | |
UINT16 NumberOfIdEntries; | |
// | |
// Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here. | |
// | |
} EFI_IMAGE_RESOURCE_DIRECTORY; | |
/// | |
/// Resource directory entry format. | |
/// | |
typedef struct { | |
union { | |
struct { | |
UINT32 NameOffset:31; | |
UINT32 NameIsString:1; | |
} s; | |
UINT32 Id; | |
} u1; | |
union { | |
UINT32 OffsetToData; | |
struct { | |
UINT32 OffsetToDirectory:31; | |
UINT32 DataIsDirectory:1; | |
} s; | |
} u2; | |
} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY; | |
/// | |
/// Resource directory entry for string. | |
/// | |
typedef struct { | |
UINT16 Length; | |
CHAR16 String[1]; | |
} EFI_IMAGE_RESOURCE_DIRECTORY_STRING; | |
/// | |
/// Resource directory entry for data array. | |
/// | |
typedef struct { | |
UINT32 OffsetToData; | |
UINT32 Size; | |
UINT32 CodePage; | |
UINT32 Reserved; | |
} EFI_IMAGE_RESOURCE_DATA_ENTRY; | |
/// | |
/// Header format for TE images | |
/// | |
typedef struct { | |
UINT16 Signature; // signature for TE format = "VZ" | |
UINT16 Machine; // from the original file header | |
UINT8 NumberOfSections; // from the original file header | |
UINT8 Subsystem; // from original optional header | |
UINT16 StrippedSize; // how many bytes we removed from the header | |
UINT32 AddressOfEntryPoint; // offset to entry point -- from original optional header | |
UINT32 BaseOfCode; // from original image -- required for ITP debug | |
UINT64 ImageBase; // from original file header | |
EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; // only base relocation and debug directory | |
} EFI_TE_IMAGE_HEADER; | |
#define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56 // "VZ" | |
// | |
// Data directory indexes in our TE image header | |
// | |
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0 | |
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1 | |
// | |
// Union of PE32, PE32+, and TE headers | |
// | |
typedef union { | |
EFI_IMAGE_NT_HEADERS32 Pe32; | |
EFI_IMAGE_NT_HEADERS64 Pe32Plus; | |
EFI_TE_IMAGE_HEADER Te; | |
} EFI_IMAGE_OPTIONAL_HEADER_UNION; | |
typedef union { | |
EFI_IMAGE_NT_HEADERS32 *Pe32; | |
EFI_IMAGE_NT_HEADERS64 *Pe32Plus; | |
EFI_TE_IMAGE_HEADER *Te; | |
EFI_IMAGE_OPTIONAL_HEADER_UNION *Union; | |
} EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION; | |
#endif |