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