BaseTools/Source/C/Include/IndustryStandard/PeImage.h

   1 /** @file
   2   EFI image format for PE32+. Please note some data structures are different
   3   for IA-32 and Itanium-based images, look for UINTN and the #ifdef EFI_IA64
   4
   5   @bug Fix text - doc as defined in MSFT EFI specification.
   6
   7   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   8   Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>
   9   Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
  10   Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
  11
  12   SPDX-License-Identifier: BSD-2-Clause-Patent
  13
  14 **/
  15
  16 #ifndef __PE_IMAGE_H__
  17 #define __PE_IMAGE_H__
  18
  19 //
  20 // PE32+ Subsystem type for EFI images
  21 //
  22 #define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION         10
  23 #define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
  24 #define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER      12
  25 #define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER      13
  26
  27 //
  28 // BugBug: Need to get a real answer for this problem. This is not in the
  29 //         PE specification.
  30 //
  31 //         A SAL runtime driver does not get fixed up when a transition to
  32 //         virtual mode is made. In all other cases it should be treated
  33 //         like a EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER image
  34 //
  35 #define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER  13
  36
  37 //
  38 // PE32+ Machine type for EFI images
  39 //
  40 #define IMAGE_FILE_MACHINE_I386        0x014c
  41 #define IMAGE_FILE_MACHINE_EBC         0x0EBC
  42 #define IMAGE_FILE_MACHINE_X64         0x8664
  43 #define IMAGE_FILE_MACHINE_ARM         0x01c0  // Thumb only
  44 #define IMAGE_FILE_MACHINE_ARMT        0x01c2  // 32bit Mixed ARM and Thumb/Thumb 2  Little Endian
  45 #define IMAGE_FILE_MACHINE_ARM64       0xAA64  // 64bit ARM Architecture, Little Endian
  46 #define IMAGE_FILE_MACHINE_RISCV64     0x5064  // 64bit RISC-V ISA
  47 #define IMAGE_FILE_MACHINE_LOONGARCH64 0x6264  // 64bit LoongArch Architecture
  48
  49 //
  50 // Support old names for backward compatible
  51 //
  52 #define EFI_IMAGE_MACHINE_IA32        IMAGE_FILE_MACHINE_I386
  53 #define EFI_IMAGE_MACHINE_EBC         IMAGE_FILE_MACHINE_EBC
  54 #define EFI_IMAGE_MACHINE_X64         IMAGE_FILE_MACHINE_X64
  55 #define EFI_IMAGE_MACHINE_ARMT        IMAGE_FILE_MACHINE_ARMT
  56 #define EFI_IMAGE_MACHINE_AARCH64     IMAGE_FILE_MACHINE_ARM64
  57 #define EFI_IMAGE_MACHINE_RISCV64     IMAGE_FILE_MACHINE_RISCV64
  58 #define EFI_IMAGE_MACHINE_LOONGARCH64 IMAGE_FILE_MACHINE_LOONGARCH64
  59
  60 #define EFI_IMAGE_DOS_SIGNATURE     0x5A4D      // MZ
  61 #define EFI_IMAGE_OS2_SIGNATURE     0x454E      // NE
  62 #define EFI_IMAGE_OS2_SIGNATURE_LE  0x454C      // LE
  63 #define EFI_IMAGE_NT_SIGNATURE      0x00004550  // PE00
  64 #define EFI_IMAGE_EDOS_SIGNATURE    0x44454550  // PEED
  65
  66 ///
  67 /// PE images can start with an optional DOS header, so if an image is run
  68 ///  under DOS it can print an error message.
  69 ///
  70 typedef struct {
  71   UINT16  e_magic;    // Magic number
  72   UINT16  e_cblp;     // Bytes on last page of file
  73   UINT16  e_cp;       // Pages in file
  74   UINT16  e_crlc;     // Relocations
  75   UINT16  e_cparhdr;  // Size of header in paragraphs
  76   UINT16  e_minalloc; // Minimum extra paragraphs needed
  77   UINT16  e_maxalloc; // Maximum extra paragraphs needed
  78   UINT16  e_ss;       // Initial (relative) SS value
  79   UINT16  e_sp;       // Initial SP value
  80   UINT16  e_csum;     // Checksum
  81   UINT16  e_ip;       // Initial IP value
  82   UINT16  e_cs;       // Initial (relative) CS value
  83   UINT16  e_lfarlc;   // File address of relocation table
  84   UINT16  e_ovno;     // Overlay number
  85   UINT16  e_res[4];   // Reserved words
  86   UINT16  e_oemid;    // OEM identifier (for e_oeminfo)
  87   UINT16  e_oeminfo;  // OEM information; e_oemid specific
  88   UINT16  e_res2[10]; // Reserved words
  89   UINT32  e_lfanew;   // File address of new exe header
  90 } EFI_IMAGE_DOS_HEADER;
  91
  92 ///
  93 /// File header format.
  94 ///
  95 typedef struct {
  96   UINT16  Machine;
  97   UINT16  NumberOfSections;
  98   UINT32  TimeDateStamp;
  99   UINT32  PointerToSymbolTable;
 100   UINT32  NumberOfSymbols;
 101   UINT16  SizeOfOptionalHeader;
 102   UINT16  Characteristics;
 103 } EFI_IMAGE_FILE_HEADER;
 104
 105 #define EFI_IMAGE_SIZEOF_FILE_HEADER        20
 106
 107 #define EFI_IMAGE_FILE_RELOCS_STRIPPED      0x0001  // Relocation info stripped from file.
 108 #define EFI_IMAGE_FILE_EXECUTABLE_IMAGE     0x0002  // File is executable  (i.e. no unresolved externel references).
 109 #define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED   0x0004  // Line nunbers stripped from file.
 110 #define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED  0x0008  // Local symbols stripped from file.
 111 #define EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE  0x0020  // Supports addresses > 2-GB
 112 #define EFI_IMAGE_FILE_BYTES_REVERSED_LO    0x0080  // Bytes of machine word are reversed.
 113 #define EFI_IMAGE_FILE_32BIT_MACHINE        0x0100  // 32 bit word machine.
 114 #define EFI_IMAGE_FILE_DEBUG_STRIPPED       0x0200  // Debugging info stripped from file in .DBG file
 115 #define EFI_IMAGE_FILE_SYSTEM               0x1000  // System File.
 116 #define EFI_IMAGE_FILE_DLL                  0x2000  // File is a DLL.
 117 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI    0x8000  // Bytes of machine word are reversed.
 118 #define EFI_IMAGE_FILE_MACHINE_UNKNOWN      0
 119 #define EFI_IMAGE_FILE_MACHINE_I386         0x14c   // Intel 386.
 120 #define EFI_IMAGE_FILE_MACHINE_R3000        0x162   // MIPS* little-endian, 0540 big-endian
 121 #define EFI_IMAGE_FILE_MACHINE_R4000        0x166   // MIPS* little-endian
 122 #define EFI_IMAGE_FILE_MACHINE_ALPHA        0x184   // Alpha_AXP*
 123 #define EFI_IMAGE_FILE_MACHINE_POWERPC      0x1F0   // IBM* PowerPC Little-Endian
 124 #define EFI_IMAGE_FILE_MACHINE_TAHOE        0x7cc   // Intel EM machine
 125 //
 126 // * Other names and brands may be claimed as the property of others.
 127 //
 128
 129 ///
 130 /// Directory format.
 131 ///
 132 typedef struct {
 133   UINT32  VirtualAddress;
 134   UINT32  Size;
 135 } EFI_IMAGE_DATA_DIRECTORY;
 136
 137 #define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16
 138
 139 typedef struct {
 140   UINT16  Magic;
 141   UINT8   MajorLinkerVersion;
 142   UINT8   MinorLinkerVersion;
 143   UINT32  SizeOfCode;
 144   UINT32  SizeOfInitializedData;
 145   UINT32  SizeOfUninitializedData;
 146   UINT32  AddressOfEntryPoint;
 147   UINT32  BaseOfCode;
 148   UINT32  BaseOfData;
 149   UINT32  BaseOfBss;
 150   UINT32  GprMask;
 151   UINT32  CprMask[4];
 152   UINT32  GpValue;
 153 } EFI_IMAGE_ROM_OPTIONAL_HEADER;
 154
 155 #define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC      0x107
 156 #define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER  sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER)
 157
 158 typedef struct {
 159   EFI_IMAGE_FILE_HEADER         FileHeader;
 160   EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;
 161 } EFI_IMAGE_ROM_HEADERS;
 162
 163 ///
 164 /// @attention
 165 /// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64
 166 /// are for use ONLY by tools.  All proper EFI code MUST use
 167 /// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!
 168 ///
 169 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
 170
 171 typedef struct {
 172   //
 173   // Standard fields.
 174   //
 175   UINT16                    Magic;
 176   UINT8                     MajorLinkerVersion;
 177   UINT8                     MinorLinkerVersion;
 178   UINT32                    SizeOfCode;
 179   UINT32                    SizeOfInitializedData;
 180   UINT32                    SizeOfUninitializedData;
 181   UINT32                    AddressOfEntryPoint;
 182   UINT32                    BaseOfCode;
 183   UINT32                    BaseOfData;
 184   //
 185   // NT additional fields.
 186   //
 187   UINT32                    ImageBase;
 188   UINT32                    SectionAlignment;
 189   UINT32                    FileAlignment;
 190   UINT16                    MajorOperatingSystemVersion;
 191   UINT16                    MinorOperatingSystemVersion;
 192   UINT16                    MajorImageVersion;
 193   UINT16                    MinorImageVersion;
 194   UINT16                    MajorSubsystemVersion;
 195   UINT16                    MinorSubsystemVersion;
 196   UINT32                    Win32VersionValue;
 197   UINT32                    SizeOfImage;
 198   UINT32                    SizeOfHeaders;
 199   UINT32                    CheckSum;
 200   UINT16                    Subsystem;
 201   UINT16                    DllCharacteristics;
 202   UINT32                    SizeOfStackReserve;
 203   UINT32                    SizeOfStackCommit;
 204   UINT32                    SizeOfHeapReserve;
 205   UINT32                    SizeOfHeapCommit;
 206   UINT32                    LoaderFlags;
 207   UINT32                    NumberOfRvaAndSizes;
 208   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
 209 } EFI_IMAGE_OPTIONAL_HEADER32;
 210
 211 ///
 212 /// @attention
 213 /// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64
 214 /// are for use ONLY by tools.  All proper EFI code MUST use
 215 /// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!
 216 ///
 217 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
 218
 219 typedef struct {
 220   //
 221   // Standard fields.
 222   //
 223   UINT16                    Magic;
 224   UINT8                     MajorLinkerVersion;
 225   UINT8                     MinorLinkerVersion;
 226   UINT32                    SizeOfCode;
 227   UINT32                    SizeOfInitializedData;
 228   UINT32                    SizeOfUninitializedData;
 229   UINT32                    AddressOfEntryPoint;
 230   UINT32                    BaseOfCode;
 231   //
 232   // NT additional fields.
 233   //
 234   UINT64                    ImageBase;
 235   UINT32                    SectionAlignment;
 236   UINT32                    FileAlignment;
 237   UINT16                    MajorOperatingSystemVersion;
 238   UINT16                    MinorOperatingSystemVersion;
 239   UINT16                    MajorImageVersion;
 240   UINT16                    MinorImageVersion;
 241   UINT16                    MajorSubsystemVersion;
 242   UINT16                    MinorSubsystemVersion;
 243   UINT32                    Win32VersionValue;
 244   UINT32                    SizeOfImage;
 245   UINT32                    SizeOfHeaders;
 246   UINT32                    CheckSum;
 247   UINT16                    Subsystem;
 248   UINT16                    DllCharacteristics;
 249   UINT64                    SizeOfStackReserve;
 250   UINT64                    SizeOfStackCommit;
 251   UINT64                    SizeOfHeapReserve;
 252   UINT64                    SizeOfHeapCommit;
 253   UINT32                    LoaderFlags;
 254   UINT32                    NumberOfRvaAndSizes;
 255   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
 256 } EFI_IMAGE_OPTIONAL_HEADER64;
 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 // Subsystem Values
 281 //
 282 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN     0
 283 #define EFI_IMAGE_SUBSYSTEM_NATIVE      1
 284 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2
 285 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3.
 286 #define EFI_IMAGE_SUBSYSTEM_OS2_CUI     5
 287 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI   7
 288
 289 //
 290 // Directory Entries
 291 //
 292 #define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT      0
 293 #define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT      1
 294 #define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE    2
 295 #define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION   3
 296 #define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY    4
 297 #define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC   5
 298 #define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG       6
 299 #define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT   7
 300 #define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR   8
 301 #define EFI_IMAGE_DIRECTORY_ENTRY_TLS         9
 302 #define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10
 303
 304 //
 305 // Section header format.
 306 //
 307 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8
 308
 309 typedef struct {
 310   UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
 311   union {
 312     UINT32  PhysicalAddress;
 313     UINT32  VirtualSize;
 314   } Misc;
 315   UINT32  VirtualAddress;
 316   UINT32  SizeOfRawData;
 317   UINT32  PointerToRawData;
 318   UINT32  PointerToRelocations;
 319   UINT32  PointerToLinenumbers;
 320   UINT16  NumberOfRelocations;
 321   UINT16  NumberOfLinenumbers;
 322   UINT32  Characteristics;
 323 } EFI_IMAGE_SECTION_HEADER;
 324
 325 #define EFI_IMAGE_SIZEOF_SECTION_HEADER       40
 326
 327 #define EFI_IMAGE_SCN_TYPE_NO_PAD             0x00000008  // Reserved.
 328 #define EFI_IMAGE_SCN_CNT_CODE                0x00000020
 329 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA    0x00000040
 330 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA  0x00000080
 331
 332 #define EFI_IMAGE_SCN_LNK_OTHER               0x00000100  // Reserved.
 333 #define EFI_IMAGE_SCN_LNK_INFO                0x00000200  // Section contains comments or some other type of information.
 334 #define EFI_IMAGE_SCN_LNK_REMOVE              0x00000800  // Section contents will not become part of image.
 335 #define EFI_IMAGE_SCN_LNK_COMDAT              0x00001000
 336
 337 #define EFI_IMAGE_SCN_ALIGN_1BYTES            0x00100000
 338 #define EFI_IMAGE_SCN_ALIGN_2BYTES            0x00200000
 339 #define EFI_IMAGE_SCN_ALIGN_4BYTES            0x00300000
 340 #define EFI_IMAGE_SCN_ALIGN_8BYTES            0x00400000
 341 #define EFI_IMAGE_SCN_ALIGN_16BYTES           0x00500000
 342 #define EFI_IMAGE_SCN_ALIGN_32BYTES           0x00600000
 343 #define EFI_IMAGE_SCN_ALIGN_64BYTES           0x00700000
 344
 345 #define EFI_IMAGE_SCN_MEM_DISCARDABLE         0x02000000
 346 #define EFI_IMAGE_SCN_MEM_NOT_CACHED          0x04000000
 347 #define EFI_IMAGE_SCN_MEM_NOT_PAGED           0x08000000
 348 #define EFI_IMAGE_SCN_MEM_SHARED              0x10000000
 349 #define EFI_IMAGE_SCN_MEM_EXECUTE             0x20000000
 350 #define EFI_IMAGE_SCN_MEM_READ                0x40000000
 351 #define EFI_IMAGE_SCN_MEM_WRITE               0x80000000
 352
 353 ///
 354 /// Symbol format.
 355 ///
 356 #define EFI_IMAGE_SIZEOF_SYMBOL 18
 357
 358 //
 359 // Section values.
 360 //
 361 // Symbols have a section number of the section in which they are
 362 // defined. Otherwise, section numbers have the following meanings:
 363 //
 364 #define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0  // Symbol is undefined or is common.
 365 #define EFI_IMAGE_SYM_ABSOLUTE  (UINT16) -1 // Symbol is an absolute value.
 366 #define EFI_IMAGE_SYM_DEBUG     (UINT16) -2 // Symbol is a special debug item.
 367 //
 368 // Type (fundamental) values.
 369 //
 370 #define EFI_IMAGE_SYM_TYPE_NULL   0   // no type.
 371 #define EFI_IMAGE_SYM_TYPE_VOID   1   //
 372 #define EFI_IMAGE_SYM_TYPE_CHAR   2   // type character.
 373 #define EFI_IMAGE_SYM_TYPE_SHORT  3   // type short integer.
 374 #define EFI_IMAGE_SYM_TYPE_INT    4
 375 #define EFI_IMAGE_SYM_TYPE_LONG   5
 376 #define EFI_IMAGE_SYM_TYPE_FLOAT  6
 377 #define EFI_IMAGE_SYM_TYPE_DOUBLE 7
 378 #define EFI_IMAGE_SYM_TYPE_STRUCT 8
 379 #define EFI_IMAGE_SYM_TYPE_UNION  9
 380 #define EFI_IMAGE_SYM_TYPE_ENUM   10  // enumeration.
 381 #define EFI_IMAGE_SYM_TYPE_MOE    11  // member of enumeration.
 382 #define EFI_IMAGE_SYM_TYPE_BYTE   12
 383 #define EFI_IMAGE_SYM_TYPE_WORD   13
 384 #define EFI_IMAGE_SYM_TYPE_UINT   14
 385 #define EFI_IMAGE_SYM_TYPE_DWORD  15
 386
 387 //
 388 // Type (derived) values.
 389 //
 390 #define EFI_IMAGE_SYM_DTYPE_NULL      0 // no derived type.
 391 #define EFI_IMAGE_SYM_DTYPE_POINTER   1
 392 #define EFI_IMAGE_SYM_DTYPE_FUNCTION  2
 393 #define EFI_IMAGE_SYM_DTYPE_ARRAY     3
 394
 395 //
 396 // Storage classes.
 397 //
 398 #define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   (UINT8) -1
 399 #define EFI_IMAGE_SYM_CLASS_NULL              0
 400 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC         1
 401 #define EFI_IMAGE_SYM_CLASS_EXTERNAL          2
 402 #define EFI_IMAGE_SYM_CLASS_STATIC            3
 403 #define EFI_IMAGE_SYM_CLASS_REGISTER          4
 404 #define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF      5
 405 #define EFI_IMAGE_SYM_CLASS_LABEL             6
 406 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL   7
 407 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT  8
 408 #define EFI_IMAGE_SYM_CLASS_ARGUMENT          9
 409 #define EFI_IMAGE_SYM_CLASS_STRUCT_TAG        10
 410 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION   11
 411 #define EFI_IMAGE_SYM_CLASS_UNION_TAG         12
 412 #define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION   13
 413 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC  14
 414 #define EFI_IMAGE_SYM_CLASS_ENUM_TAG          15
 415 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM    16
 416 #define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM    17
 417 #define EFI_IMAGE_SYM_CLASS_BIT_FIELD         18
 418 #define EFI_IMAGE_SYM_CLASS_BLOCK             100
 419 #define EFI_IMAGE_SYM_CLASS_FUNCTION          101
 420 #define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT     102
 421 #define EFI_IMAGE_SYM_CLASS_FILE              103
 422 #define EFI_IMAGE_SYM_CLASS_SECTION           104
 423 #define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL     105
 424
 425 //
 426 // type packing constants
 427 //
 428 #define EFI_IMAGE_N_BTMASK  017
 429 #define EFI_IMAGE_N_TMASK   060
 430 #define EFI_IMAGE_N_TMASK1  0300
 431 #define EFI_IMAGE_N_TMASK2  0360
 432 #define EFI_IMAGE_N_BTSHFT  4
 433 #define EFI_IMAGE_N_TSHIFT  2
 434
 435 //
 436 // Communal selection types.
 437 //
 438 #define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES    1
 439 #define EFI_IMAGE_COMDAT_SELECT_ANY             2
 440 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE       3
 441 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH     4
 442 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE     5
 443
 444 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY  1
 445 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY    2
 446 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS      3
 447
 448 ///
 449 /// Relocation format.
 450 ///
 451 typedef struct {
 452   UINT32  VirtualAddress;
 453   UINT32  SymbolTableIndex;
 454   UINT16  Type;
 455 } EFI_IMAGE_RELOCATION;
 456
 457 #define EFI_IMAGE_SIZEOF_RELOCATION 10
 458
 459 //
 460 // I386 relocation types.
 461 //
 462 #define EFI_IMAGE_REL_I386_ABSOLUTE 0   // Reference is absolute, no relocation is necessary
 463 #define EFI_IMAGE_REL_I386_DIR16    01  // Direct 16-bit reference to the symbols virtual address
 464 #define EFI_IMAGE_REL_I386_REL16    02  // PC-relative 16-bit reference to the symbols virtual address
 465 #define EFI_IMAGE_REL_I386_DIR32    06  // Direct 32-bit reference to the symbols virtual address
 466 #define EFI_IMAGE_REL_I386_DIR32NB  07  // Direct 32-bit reference to the symbols virtual address, base not included
 467 #define EFI_IMAGE_REL_I386_SEG12    09  // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
 468 #define EFI_IMAGE_REL_I386_SECTION  010
 469 #define EFI_IMAGE_REL_I386_SECREL   011
 470 #define EFI_IMAGE_REL_I386_REL32    020 // PC-relative 32-bit reference to the symbols virtual address
 471
 472 //
 473 // x64 processor relocation types.
 474 //
 475 #define IMAGE_REL_AMD64_ABSOLUTE  0x0000
 476 #define IMAGE_REL_AMD64_ADDR64    0x0001
 477 #define IMAGE_REL_AMD64_ADDR32    0x0002
 478 #define IMAGE_REL_AMD64_ADDR32NB  0x0003
 479 #define IMAGE_REL_AMD64_REL32      0x0004
 480 #define IMAGE_REL_AMD64_REL32_1    0x0005
 481 #define IMAGE_REL_AMD64_REL32_2    0x0006
 482 #define IMAGE_REL_AMD64_REL32_3    0x0007
 483 #define IMAGE_REL_AMD64_REL32_4    0x0008
 484 #define IMAGE_REL_AMD64_REL32_5    0x0009
 485 #define IMAGE_REL_AMD64_SECTION    0x000A
 486 #define IMAGE_REL_AMD64_SECREL    0x000B
 487 #define IMAGE_REL_AMD64_SECREL7    0x000C
 488 #define IMAGE_REL_AMD64_TOKEN      0x000D
 489 #define IMAGE_REL_AMD64_SREL32    0x000E
 490 #define IMAGE_REL_AMD64_PAIR      0x000F
 491 #define IMAGE_REL_AMD64_SSPAN32    0x0010
 492
 493 ///
 494 /// Based relocation format.
 495 ///
 496 typedef struct {
 497   UINT32  VirtualAddress;
 498   UINT32  SizeOfBlock;
 499 } EFI_IMAGE_BASE_RELOCATION;
 500
 501 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8
 502
 503 //
 504 // Based relocation types.
 505 //
 506 #define EFI_IMAGE_REL_BASED_ABSOLUTE             0
 507 #define EFI_IMAGE_REL_BASED_HIGH                 1
 508 #define EFI_IMAGE_REL_BASED_LOW                  2
 509 #define EFI_IMAGE_REL_BASED_HIGHLOW              3
 510 #define EFI_IMAGE_REL_BASED_HIGHADJ              4
 511 #define EFI_IMAGE_REL_BASED_MIPS_JMPADDR         5
 512 #define EFI_IMAGE_REL_BASED_ARM_MOV32A           5
 513 #define EFI_IMAGE_REL_BASED_RISCV_HI20           5
 514 #define EFI_IMAGE_REL_BASED_ARM_MOV32T           7
 515 #define EFI_IMAGE_REL_BASED_RISCV_LOW12I         7
 516 #define EFI_IMAGE_REL_BASED_RISCV_LOW12S         8
 517 #define EFI_IMAGE_REL_BASED_LOONGARCH32_MARK_LA  8
 518 #define EFI_IMAGE_REL_BASED_LOONGARCH64_MARK_LA  8
 519 #define EFI_IMAGE_REL_BASED_IA64_IMM64           9
 520 #define EFI_IMAGE_REL_BASED_DIR64                10
 521
 522
 523 ///
 524 /// Line number format.
 525 ///
 526 typedef struct {
 527   union {
 528     UINT32  SymbolTableIndex; // Symbol table index of function name if Linenumber is 0.
 529     UINT32  VirtualAddress;   // Virtual address of line number.
 530   } Type;
 531   UINT16  Linenumber;         // Line number.
 532 } EFI_IMAGE_LINENUMBER;
 533
 534 #define EFI_IMAGE_SIZEOF_LINENUMBER 6
 535
 536 //
 537 // Archive format.
 538 //
 539 #define EFI_IMAGE_ARCHIVE_START_SIZE        8
 540 #define EFI_IMAGE_ARCHIVE_START             "!<arch>\n"
 541 #define EFI_IMAGE_ARCHIVE_END               "`\n"
 542 #define EFI_IMAGE_ARCHIVE_PAD               "\n"
 543 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER     "/               "
 544 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER  "//              "
 545
 546 typedef struct {
 547   UINT8 Name[16];     // File member name - `/' terminated.
 548   UINT8 Date[12];     // File member date - decimal.
 549   UINT8 UserID[6];    // File member user id - decimal.
 550   UINT8 GroupID[6];   // File member group id - decimal.
 551   UINT8 Mode[8];      // File member mode - octal.
 552   UINT8 Size[10];     // File member size - decimal.
 553   UINT8 EndHeader[2]; // String to end header.
 554 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER;
 555
 556 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
 557
 558 //
 559 // DLL support.
 560 //
 561
 562 ///
 563 /// DLL Export Format
 564 ///
 565 typedef struct {
 566   UINT32  Characteristics;
 567   UINT32  TimeDateStamp;
 568   UINT16  MajorVersion;
 569   UINT16  MinorVersion;
 570   UINT32  Name;
 571   UINT32  Base;
 572   UINT32  NumberOfFunctions;
 573   UINT32  NumberOfNames;
 574   UINT32  AddressOfFunctions;
 575   UINT32  AddressOfNames;
 576   UINT32  AddressOfNameOrdinals;
 577 } EFI_IMAGE_EXPORT_DIRECTORY;
 578
 579 //
 580 // Based export types.
 581 //
 582 #define EFI_IMAGE_EXPORT_ORDINAL_BASE     1
 583 #define EFI_IMAGE_EXPORT_ADDR_SIZE        4
 584 #define EFI_IMAGE_EXPORT_ORDINAL_SIZE     2
 585
 586 ///
 587 /// DLL support.
 588 /// Import Format
 589 ///
 590 typedef struct {
 591   UINT16  Hint;
 592   UINT8   Name[1];
 593 } EFI_IMAGE_IMPORT_BY_NAME;
 594
 595 typedef struct {
 596   union {
 597     UINT32                    Function;
 598     UINT32                    Ordinal;
 599     EFI_IMAGE_IMPORT_BY_NAME  *AddressOfData;
 600   } u1;
 601 } EFI_IMAGE_THUNK_DATA;
 602
 603 #define EFI_IMAGE_ORDINAL_FLAG              0x80000000
 604 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
 605 #define EFI_IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)
 606
 607 typedef struct {
 608   UINT32                Characteristics;
 609   UINT32                TimeDateStamp;
 610   UINT32                ForwarderChain;
 611   UINT32                Name;
 612   EFI_IMAGE_THUNK_DATA  *FirstThunk;
 613 } EFI_IMAGE_IMPORT_DESCRIPTOR;
 614
 615 ///
 616 /// Debug Format
 617 ///
 618 #define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2
 619
 620 typedef struct {
 621   UINT32  Characteristics;
 622   UINT32  TimeDateStamp;
 623   UINT16  MajorVersion;
 624   UINT16  MinorVersion;
 625   UINT32  Type;
 626   UINT32  SizeOfData;
 627   UINT32  RVA;
 628   UINT32  FileOffset;
 629 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;
 630
 631 #define CODEVIEW_SIGNATURE_NB10 0x3031424E  // "NB10"
 632 typedef struct {
 633   UINT32  Signature;                        // "NB10"
 634   UINT32  Unknown;
 635   UINT32  Unknown2;
 636   UINT32  Unknown3;
 637   //
 638   // Filename of .PDB goes here
 639   //
 640 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
 641
 642 #define CODEVIEW_SIGNATURE_RSDS 0x53445352  // "RSDS"
 643 typedef struct {
 644   UINT32  Signature;                        // "RSDS"
 645   UINT32  Unknown;
 646   UINT32  Unknown2;
 647   UINT32  Unknown3;
 648   UINT32  Unknown4;
 649   UINT32  Unknown5;
 650   //
 651   // Filename of .PDB goes here
 652   //
 653 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
 654
 655 ///
 656 /// Debug Data Structure defined by Apple Mach-O to Coff utility
 657 ///
 658 #define CODEVIEW_SIGNATURE_MTOC  SIGNATURE_32('M', 'T', 'O', 'C')
 659 typedef struct {
 660   UINT32    Signature;                       ///< "MTOC"
 661   EFI_GUID  MachOUuid;
 662   //
 663   //  Filename of .DLL (Mach-O with debug info) goes here
 664   //
 665 } EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;
 666
 667 //
 668 // .pdata entries for X64
 669 //
 670 typedef struct {
 671   UINT32  FunctionStartAddress;
 672   UINT32  FunctionEndAddress;
 673   UINT32  UnwindInfoAddress;
 674 } RUNTIME_FUNCTION;
 675
 676 typedef struct {
 677   UINT8  Version:3;
 678   UINT8  Flags:5;
 679   UINT8  SizeOfProlog;
 680   UINT8  CountOfUnwindCodes;
 681   UINT8  FrameRegister:4;
 682   UINT8  FrameRegisterOffset:4;
 683 } UNWIND_INFO;
 684
 685 ///
 686 /// Resource format.
 687 ///
 688 typedef struct {
 689   UINT32  Characteristics;
 690   UINT32  TimeDateStamp;
 691   UINT16  MajorVersion;
 692   UINT16  MinorVersion;
 693   UINT16  NumberOfNamedEntries;
 694   UINT16  NumberOfIdEntries;
 695   //
 696   // Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.
 697   //
 698 } EFI_IMAGE_RESOURCE_DIRECTORY;
 699
 700 ///
 701 /// Resource directory entry format.
 702 ///
 703 typedef struct {
 704   union {
 705     struct {
 706       UINT32  NameOffset:31;
 707       UINT32  NameIsString:1;
 708     } s;
 709     UINT32  Id;
 710   } u1;
 711   union {
 712     UINT32  OffsetToData;
 713     struct {
 714       UINT32  OffsetToDirectory:31;
 715       UINT32  DataIsDirectory:1;
 716     } s;
 717   } u2;
 718 } EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;
 719
 720 ///
 721 /// Resource directory entry for string.
 722 ///
 723 typedef struct {
 724   UINT16  Length;
 725   CHAR16  String[1];
 726 } EFI_IMAGE_RESOURCE_DIRECTORY_STRING;
 727
 728 ///
 729 /// Resource directory entry for data array.
 730 ///
 731 typedef struct {
 732   UINT32  OffsetToData;
 733   UINT32  Size;
 734   UINT32  CodePage;
 735   UINT32  Reserved;
 736 } EFI_IMAGE_RESOURCE_DATA_ENTRY;
 737
 738 ///
 739 /// Header format for TE images
 740 ///
 741 typedef struct {
 742   UINT16                    Signature;            // signature for TE format = "VZ"
 743   UINT16                    Machine;              // from the original file header
 744   UINT8                     NumberOfSections;     // from the original file header
 745   UINT8                     Subsystem;            // from original optional header
 746   UINT16                    StrippedSize;         // how many bytes we removed from the header
 747   UINT32                    AddressOfEntryPoint;  // offset to entry point -- from original optional header
 748   UINT32                    BaseOfCode;           // from original image -- required for ITP debug
 749   UINT64                    ImageBase;            // from original file header
 750   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     // only base relocation and debug directory
 751 } EFI_TE_IMAGE_HEADER;
 752
 753 #define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56      // "VZ"
 754
 755 //
 756 // Data directory indexes in our TE image header
 757 //
 758 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC  0
 759 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG      1
 760
 761
 762 //
 763 // Union of PE32, PE32+, and TE headers
 764 //
 765 typedef union {
 766   EFI_IMAGE_NT_HEADERS32   Pe32;
 767   EFI_IMAGE_NT_HEADERS64   Pe32Plus;
 768   EFI_TE_IMAGE_HEADER      Te;
 769 } EFI_IMAGE_OPTIONAL_HEADER_UNION;
 770
 771 typedef union {
 772   EFI_IMAGE_NT_HEADERS32            *Pe32;
 773   EFI_IMAGE_NT_HEADERS64            *Pe32Plus;
 774   EFI_TE_IMAGE_HEADER               *Te;
 775   EFI_IMAGE_OPTIONAL_HEADER_UNION   *Union;
 776 } EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;
 777
 778 #endif