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