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