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.
   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_BYTES_REVERSED_LO    0x0080  // Bytes of machine word are reversed.
 114 #define EFI_IMAGE_FILE_32BIT_MACHINE        0x0100  // 32 bit word machine.
 115 #define EFI_IMAGE_FILE_DEBUG_STRIPPED       0x0200  // Debugging info stripped from file in .DBG file
 116 #define EFI_IMAGE_FILE_SYSTEM               0x1000  // System File.
 117 #define EFI_IMAGE_FILE_DLL                  0x2000  // File is a DLL.
 118 #define EFI_IMAGE_FILE_BYTES_REVERSED_HI    0x8000  // Bytes of machine word are reversed.
 119 #define EFI_IMAGE_FILE_MACHINE_UNKNOWN      0
 120 #define EFI_IMAGE_FILE_MACHINE_I386         0x14c   // Intel 386.
 121 #define EFI_IMAGE_FILE_MACHINE_R3000        0x162   // MIPS* little-endian, 0540 big-endian
 122 #define EFI_IMAGE_FILE_MACHINE_R4000        0x166   // MIPS* little-endian
 123 #define EFI_IMAGE_FILE_MACHINE_ALPHA        0x184   // Alpha_AXP*
 124 #define EFI_IMAGE_FILE_MACHINE_POWERPC      0x1F0   // IBM* PowerPC Little-Endian
 125 #define EFI_IMAGE_FILE_MACHINE_TAHOE        0x7cc   // Intel EM machine
 126 //
 127 // * Other names and brands may be claimed as the property of others.
 128 //
 129
 130 ///
 131 /// Directory format.
 132 ///
 133 typedef struct {
 134   UINT32  VirtualAddress;
 135   UINT32  Size;
 136 } EFI_IMAGE_DATA_DIRECTORY;
 137
 138 #define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16
 139
 140 typedef struct {
 141   UINT16  Magic;
 142   UINT8   MajorLinkerVersion;
 143   UINT8   MinorLinkerVersion;
 144   UINT32  SizeOfCode;
 145   UINT32  SizeOfInitializedData;
 146   UINT32  SizeOfUninitializedData;
 147   UINT32  AddressOfEntryPoint;
 148   UINT32  BaseOfCode;
 149   UINT32  BaseOfData;
 150   UINT32  BaseOfBss;
 151   UINT32  GprMask;
 152   UINT32  CprMask[4];
 153   UINT32  GpValue;
 154 } EFI_IMAGE_ROM_OPTIONAL_HEADER;
 155
 156 #define EFI_IMAGE_ROM_OPTIONAL_HDR_MAGIC      0x107
 157 #define EFI_IMAGE_SIZEOF_ROM_OPTIONAL_HEADER  sizeof (EFI_IMAGE_ROM_OPTIONAL_HEADER)
 158
 159 typedef struct {
 160   EFI_IMAGE_FILE_HEADER         FileHeader;
 161   EFI_IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;
 162 } EFI_IMAGE_ROM_HEADERS;
 163
 164 ///
 165 /// @attention
 166 /// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64
 167 /// are for use ONLY by tools.  All proper EFI code MUST use
 168 /// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!
 169 ///
 170 #define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
 171
 172 typedef struct {
 173   //
 174   // Standard fields.
 175   //
 176   UINT16                    Magic;
 177   UINT8                     MajorLinkerVersion;
 178   UINT8                     MinorLinkerVersion;
 179   UINT32                    SizeOfCode;
 180   UINT32                    SizeOfInitializedData;
 181   UINT32                    SizeOfUninitializedData;
 182   UINT32                    AddressOfEntryPoint;
 183   UINT32                    BaseOfCode;
 184   UINT32                    BaseOfData;
 185   //
 186   // NT additional fields.
 187   //
 188   UINT32                    ImageBase;
 189   UINT32                    SectionAlignment;
 190   UINT32                    FileAlignment;
 191   UINT16                    MajorOperatingSystemVersion;
 192   UINT16                    MinorOperatingSystemVersion;
 193   UINT16                    MajorImageVersion;
 194   UINT16                    MinorImageVersion;
 195   UINT16                    MajorSubsystemVersion;
 196   UINT16                    MinorSubsystemVersion;
 197   UINT32                    Win32VersionValue;
 198   UINT32                    SizeOfImage;
 199   UINT32                    SizeOfHeaders;
 200   UINT32                    CheckSum;
 201   UINT16                    Subsystem;
 202   UINT16                    DllCharacteristics;
 203   UINT32                    SizeOfStackReserve;
 204   UINT32                    SizeOfStackCommit;
 205   UINT32                    SizeOfHeapReserve;
 206   UINT32                    SizeOfHeapCommit;
 207   UINT32                    LoaderFlags;
 208   UINT32                    NumberOfRvaAndSizes;
 209   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
 210 } EFI_IMAGE_OPTIONAL_HEADER32;
 211
 212 ///
 213 /// @attention
 214 /// EFI_IMAGE_OPTIONAL_HEADER32 and EFI_IMAGE_OPTIONAL_HEADER64
 215 /// are for use ONLY by tools.  All proper EFI code MUST use
 216 /// EFI_IMAGE_OPTIONAL_HEADER ONLY!!!
 217 ///
 218 #define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
 219
 220 typedef struct {
 221   //
 222   // Standard fields.
 223   //
 224   UINT16                    Magic;
 225   UINT8                     MajorLinkerVersion;
 226   UINT8                     MinorLinkerVersion;
 227   UINT32                    SizeOfCode;
 228   UINT32                    SizeOfInitializedData;
 229   UINT32                    SizeOfUninitializedData;
 230   UINT32                    AddressOfEntryPoint;
 231   UINT32                    BaseOfCode;
 232   //
 233   // NT additional fields.
 234   //
 235   UINT64                    ImageBase;
 236   UINT32                    SectionAlignment;
 237   UINT32                    FileAlignment;
 238   UINT16                    MajorOperatingSystemVersion;
 239   UINT16                    MinorOperatingSystemVersion;
 240   UINT16                    MajorImageVersion;
 241   UINT16                    MinorImageVersion;
 242   UINT16                    MajorSubsystemVersion;
 243   UINT16                    MinorSubsystemVersion;
 244   UINT32                    Win32VersionValue;
 245   UINT32                    SizeOfImage;
 246   UINT32                    SizeOfHeaders;
 247   UINT32                    CheckSum;
 248   UINT16                    Subsystem;
 249   UINT16                    DllCharacteristics;
 250   UINT64                    SizeOfStackReserve;
 251   UINT64                    SizeOfStackCommit;
 252   UINT64                    SizeOfHeapReserve;
 253   UINT64                    SizeOfHeapCommit;
 254   UINT32                    LoaderFlags;
 255   UINT32                    NumberOfRvaAndSizes;
 256   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
 257 } EFI_IMAGE_OPTIONAL_HEADER64;
 258
 259 ///
 260 /// @attention
 261 /// EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY
 262 /// by tools.  All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!
 263 ///
 264 typedef struct {
 265   UINT32                      Signature;
 266   EFI_IMAGE_FILE_HEADER       FileHeader;
 267   EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader;
 268 } EFI_IMAGE_NT_HEADERS32;
 269
 270 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)
 271
 272 typedef struct {
 273   UINT32                      Signature;
 274   EFI_IMAGE_FILE_HEADER       FileHeader;
 275   EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader;
 276 } EFI_IMAGE_NT_HEADERS64;
 277
 278 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)
 279
 280 //
 281 // Subsystem Values
 282 //
 283 #define EFI_IMAGE_SUBSYSTEM_UNKNOWN     0
 284 #define EFI_IMAGE_SUBSYSTEM_NATIVE      1
 285 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2
 286 #define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3.
 287 #define EFI_IMAGE_SUBSYSTEM_OS2_CUI     5
 288 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI   7
 289
 290 //
 291 // Directory Entries
 292 //
 293 #define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT      0
 294 #define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT      1
 295 #define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE    2
 296 #define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION   3
 297 #define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY    4
 298 #define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC   5
 299 #define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG       6
 300 #define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT   7
 301 #define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR   8
 302 #define EFI_IMAGE_DIRECTORY_ENTRY_TLS         9
 303 #define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10
 304
 305 //
 306 // Section header format.
 307 //
 308 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8
 309
 310 typedef struct {
 311   UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
 312   union {
 313     UINT32  PhysicalAddress;
 314     UINT32  VirtualSize;
 315   } Misc;
 316   UINT32  VirtualAddress;
 317   UINT32  SizeOfRawData;
 318   UINT32  PointerToRawData;
 319   UINT32  PointerToRelocations;
 320   UINT32  PointerToLinenumbers;
 321   UINT16  NumberOfRelocations;
 322   UINT16  NumberOfLinenumbers;
 323   UINT32  Characteristics;
 324 } EFI_IMAGE_SECTION_HEADER;
 325
 326 #define EFI_IMAGE_SIZEOF_SECTION_HEADER       40
 327
 328 #define EFI_IMAGE_SCN_TYPE_NO_PAD             0x00000008  // Reserved.
 329 #define EFI_IMAGE_SCN_CNT_CODE                0x00000020
 330 #define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA    0x00000040
 331 #define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA  0x00000080
 332
 333 #define EFI_IMAGE_SCN_LNK_OTHER               0x00000100  // Reserved.
 334 #define EFI_IMAGE_SCN_LNK_INFO                0x00000200  // Section contains comments or some other type of information.
 335 #define EFI_IMAGE_SCN_LNK_REMOVE              0x00000800  // Section contents will not become part of image.
 336 #define EFI_IMAGE_SCN_LNK_COMDAT              0x00001000
 337
 338 #define EFI_IMAGE_SCN_ALIGN_1BYTES            0x00100000
 339 #define EFI_IMAGE_SCN_ALIGN_2BYTES            0x00200000
 340 #define EFI_IMAGE_SCN_ALIGN_4BYTES            0x00300000
 341 #define EFI_IMAGE_SCN_ALIGN_8BYTES            0x00400000
 342 #define EFI_IMAGE_SCN_ALIGN_16BYTES           0x00500000
 343 #define EFI_IMAGE_SCN_ALIGN_32BYTES           0x00600000
 344 #define EFI_IMAGE_SCN_ALIGN_64BYTES           0x00700000
 345
 346 #define EFI_IMAGE_SCN_MEM_DISCARDABLE         0x02000000
 347 #define EFI_IMAGE_SCN_MEM_NOT_CACHED          0x04000000
 348 #define EFI_IMAGE_SCN_MEM_NOT_PAGED           0x08000000
 349 #define EFI_IMAGE_SCN_MEM_SHARED              0x10000000
 350 #define EFI_IMAGE_SCN_MEM_EXECUTE             0x20000000
 351 #define EFI_IMAGE_SCN_MEM_READ                0x40000000
 352 #define EFI_IMAGE_SCN_MEM_WRITE               0x80000000
 353
 354 ///
 355 /// Symbol format.
 356 ///
 357 #define EFI_IMAGE_SIZEOF_SYMBOL 18
 358
 359 //
 360 // Section values.
 361 //
 362 // Symbols have a section number of the section in which they are
 363 // defined. Otherwise, section numbers have the following meanings:
 364 //
 365 #define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0  // Symbol is undefined or is common.
 366 #define EFI_IMAGE_SYM_ABSOLUTE  (UINT16) -1 // Symbol is an absolute value.
 367 #define EFI_IMAGE_SYM_DEBUG     (UINT16) -2 // Symbol is a special debug item.
 368 //
 369 // Type (fundamental) values.
 370 //
 371 #define EFI_IMAGE_SYM_TYPE_NULL   0   // no type.
 372 #define EFI_IMAGE_SYM_TYPE_VOID   1   //
 373 #define EFI_IMAGE_SYM_TYPE_CHAR   2   // type character.
 374 #define EFI_IMAGE_SYM_TYPE_SHORT  3   // type short integer.
 375 #define EFI_IMAGE_SYM_TYPE_INT    4
 376 #define EFI_IMAGE_SYM_TYPE_LONG   5
 377 #define EFI_IMAGE_SYM_TYPE_FLOAT  6
 378 #define EFI_IMAGE_SYM_TYPE_DOUBLE 7
 379 #define EFI_IMAGE_SYM_TYPE_STRUCT 8
 380 #define EFI_IMAGE_SYM_TYPE_UNION  9
 381 #define EFI_IMAGE_SYM_TYPE_ENUM   10  // enumeration.
 382 #define EFI_IMAGE_SYM_TYPE_MOE    11  // member of enumeration.
 383 #define EFI_IMAGE_SYM_TYPE_BYTE   12
 384 #define EFI_IMAGE_SYM_TYPE_WORD   13
 385 #define EFI_IMAGE_SYM_TYPE_UINT   14
 386 #define EFI_IMAGE_SYM_TYPE_DWORD  15
 387
 388 //
 389 // Type (derived) values.
 390 //
 391 #define EFI_IMAGE_SYM_DTYPE_NULL      0 // no derived type.
 392 #define EFI_IMAGE_SYM_DTYPE_POINTER   1
 393 #define EFI_IMAGE_SYM_DTYPE_FUNCTION  2
 394 #define EFI_IMAGE_SYM_DTYPE_ARRAY     3
 395
 396 //
 397 // Storage classes.
 398 //
 399 #define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   (UINT8) -1
 400 #define EFI_IMAGE_SYM_CLASS_NULL              0
 401 #define EFI_IMAGE_SYM_CLASS_AUTOMATIC         1
 402 #define EFI_IMAGE_SYM_CLASS_EXTERNAL          2
 403 #define EFI_IMAGE_SYM_CLASS_STATIC            3
 404 #define EFI_IMAGE_SYM_CLASS_REGISTER          4
 405 #define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF      5
 406 #define EFI_IMAGE_SYM_CLASS_LABEL             6
 407 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL   7
 408 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT  8
 409 #define EFI_IMAGE_SYM_CLASS_ARGUMENT          9
 410 #define EFI_IMAGE_SYM_CLASS_STRUCT_TAG        10
 411 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION   11
 412 #define EFI_IMAGE_SYM_CLASS_UNION_TAG         12
 413 #define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION   13
 414 #define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC  14
 415 #define EFI_IMAGE_SYM_CLASS_ENUM_TAG          15
 416 #define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM    16
 417 #define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM    17
 418 #define EFI_IMAGE_SYM_CLASS_BIT_FIELD         18
 419 #define EFI_IMAGE_SYM_CLASS_BLOCK             100
 420 #define EFI_IMAGE_SYM_CLASS_FUNCTION          101
 421 #define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT     102
 422 #define EFI_IMAGE_SYM_CLASS_FILE              103
 423 #define EFI_IMAGE_SYM_CLASS_SECTION           104
 424 #define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL     105
 425
 426 //
 427 // type packing constants
 428 //
 429 #define EFI_IMAGE_N_BTMASK  017
 430 #define EFI_IMAGE_N_TMASK   060
 431 #define EFI_IMAGE_N_TMASK1  0300
 432 #define EFI_IMAGE_N_TMASK2  0360
 433 #define EFI_IMAGE_N_BTSHFT  4
 434 #define EFI_IMAGE_N_TSHIFT  2
 435
 436 //
 437 // Communal selection types.
 438 //
 439 #define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES    1
 440 #define EFI_IMAGE_COMDAT_SELECT_ANY             2
 441 #define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE       3
 442 #define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH     4
 443 #define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE     5
 444
 445 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY  1
 446 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY    2
 447 #define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS      3
 448
 449 ///
 450 /// Relocation format.
 451 ///
 452 typedef struct {
 453   UINT32  VirtualAddress;
 454   UINT32  SymbolTableIndex;
 455   UINT16  Type;
 456 } EFI_IMAGE_RELOCATION;
 457
 458 #define EFI_IMAGE_SIZEOF_RELOCATION 10
 459
 460 //
 461 // I386 relocation types.
 462 //
 463 #define EFI_IMAGE_REL_I386_ABSOLUTE 0   // Reference is absolute, no relocation is necessary
 464 #define EFI_IMAGE_REL_I386_DIR16    01  // Direct 16-bit reference to the symbols virtual address
 465 #define EFI_IMAGE_REL_I386_REL16    02  // PC-relative 16-bit reference to the symbols virtual address
 466 #define EFI_IMAGE_REL_I386_DIR32    06  // Direct 32-bit reference to the symbols virtual address
 467 #define EFI_IMAGE_REL_I386_DIR32NB  07  // Direct 32-bit reference to the symbols virtual address, base not included
 468 #define EFI_IMAGE_REL_I386_SEG12    09  // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
 469 #define EFI_IMAGE_REL_I386_SECTION  010
 470 #define EFI_IMAGE_REL_I386_SECREL   011
 471 #define EFI_IMAGE_REL_I386_REL32    020 // PC-relative 32-bit reference to the symbols virtual address
 472
 473 //
 474 // x64 processor relocation types.
 475 //
 476 #define IMAGE_REL_AMD64_ABSOLUTE        0x0000
 477 #define IMAGE_REL_AMD64_ADDR64    0x0001
 478 #define IMAGE_REL_AMD64_ADDR32    0x0002
 479 #define IMAGE_REL_AMD64_ADDR32NB        0x0003
 480 #define IMAGE_REL_AMD64_REL32       0x0004
 481 #define IMAGE_REL_AMD64_REL32_1   0x0005
 482 #define IMAGE_REL_AMD64_REL32_2   0x0006
 483 #define IMAGE_REL_AMD64_REL32_3   0x0007
 484 #define IMAGE_REL_AMD64_REL32_4   0x0008
 485 #define IMAGE_REL_AMD64_REL32_5   0x0009
 486 #define IMAGE_REL_AMD64_SECTION   0x000A
 487 #define IMAGE_REL_AMD64_SECREL    0x000B
 488 #define IMAGE_REL_AMD64_SECREL7   0x000C
 489 #define IMAGE_REL_AMD64_TOKEN       0x000D
 490 #define IMAGE_REL_AMD64_SREL32    0x000E
 491 #define IMAGE_REL_AMD64_PAIR        0x000F
 492 #define IMAGE_REL_AMD64_SSPAN32   0x0010
 493
 494 ///
 495 /// Based relocation format.
 496 ///
 497 typedef struct {
 498   UINT32  VirtualAddress;
 499   UINT32  SizeOfBlock;
 500 } EFI_IMAGE_BASE_RELOCATION;
 501
 502 #define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8
 503
 504 //
 505 // Based relocation types.
 506 //
 507 #define EFI_IMAGE_REL_BASED_ABSOLUTE      0
 508 #define EFI_IMAGE_REL_BASED_HIGH          1
 509 #define EFI_IMAGE_REL_BASED_LOW           2
 510 #define EFI_IMAGE_REL_BASED_HIGHLOW       3
 511 #define EFI_IMAGE_REL_BASED_HIGHADJ       4
 512 #define EFI_IMAGE_REL_BASED_MIPS_JMPADDR  5
 513 #define EFI_IMAGE_REL_BASED_IA64_IMM64    9
 514 #define EFI_IMAGE_REL_BASED_DIR64         10
 515
 516 ///
 517 /// Line number format.
 518 ///
 519 typedef struct {
 520   union {
 521     UINT32  SymbolTableIndex; // Symbol table index of function name if Linenumber is 0.
 522     UINT32  VirtualAddress;   // Virtual address of line number.
 523   } Type;
 524   UINT16  Linenumber;         // Line number.
 525 } EFI_IMAGE_LINENUMBER;
 526
 527 #define EFI_IMAGE_SIZEOF_LINENUMBER 6
 528
 529 //
 530 // Archive format.
 531 //
 532 #define EFI_IMAGE_ARCHIVE_START_SIZE        8
 533 #define EFI_IMAGE_ARCHIVE_START             "!<arch>\n"
 534 #define EFI_IMAGE_ARCHIVE_END               "`\n"
 535 #define EFI_IMAGE_ARCHIVE_PAD               "\n"
 536 #define EFI_IMAGE_ARCHIVE_LINKER_MEMBER     "/               "
 537 #define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER  "//              "
 538
 539 typedef struct {
 540   UINT8 Name[16];     // File member name - `/' terminated.
 541   UINT8 Date[12];     // File member date - decimal.
 542   UINT8 UserID[6];    // File member user id - decimal.
 543   UINT8 GroupID[6];   // File member group id - decimal.
 544   UINT8 Mode[8];      // File member mode - octal.
 545   UINT8 Size[10];     // File member size - decimal.
 546   UINT8 EndHeader[2]; // String to end header.
 547 } EFI_IMAGE_ARCHIVE_MEMBER_HEADER;
 548
 549 #define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
 550
 551 //
 552 // DLL support.
 553 //
 554
 555 ///
 556 /// DLL Export Format
 557 ///
 558 typedef struct {
 559   UINT32  Characteristics;
 560   UINT32  TimeDateStamp;
 561   UINT16  MajorVersion;
 562   UINT16  MinorVersion;
 563   UINT32  Name;
 564   UINT32  Base;
 565   UINT32  NumberOfFunctions;
 566   UINT32  NumberOfNames;
 567   UINT32  AddressOfFunctions;
 568   UINT32  AddressOfNames;
 569   UINT32  AddressOfNameOrdinals;
 570 } EFI_IMAGE_EXPORT_DIRECTORY;
 571
 572 ///
 573 /// DLL support.
 574 /// Import Format
 575 ///
 576 typedef struct {
 577   UINT16  Hint;
 578   UINT8   Name[1];
 579 } EFI_IMAGE_IMPORT_BY_NAME;
 580
 581 typedef struct {
 582   union {
 583     UINT32                    Function;
 584     UINT32                    Ordinal;
 585     EFI_IMAGE_IMPORT_BY_NAME  *AddressOfData;
 586   } u1;
 587 } EFI_IMAGE_THUNK_DATA;
 588
 589 #define EFI_IMAGE_ORDINAL_FLAG              0x80000000
 590 #define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
 591 #define EFI_IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)
 592
 593 typedef struct {
 594   UINT32                Characteristics;
 595   UINT32                TimeDateStamp;
 596   UINT32                ForwarderChain;
 597   UINT32                Name;
 598   EFI_IMAGE_THUNK_DATA  *FirstThunk;
 599 } EFI_IMAGE_IMPORT_DESCRIPTOR;
 600
 601 ///
 602 /// Debug Format
 603 ///
 604 #define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2
 605
 606 typedef struct {
 607   UINT32  Characteristics;
 608   UINT32  TimeDateStamp;
 609   UINT16  MajorVersion;
 610   UINT16  MinorVersion;
 611   UINT32  Type;
 612   UINT32  SizeOfData;
 613   UINT32  RVA;
 614   UINT32  FileOffset;
 615 } EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;
 616
 617 #define CODEVIEW_SIGNATURE_NB10 0x3031424E  // "NB10"
 618 typedef struct {
 619   UINT32  Signature;                        // "NB10"
 620   UINT32  Unknown;
 621   UINT32  Unknown2;
 622   UINT32  Unknown3;
 623   //
 624   // Filename of .PDB goes here
 625   //
 626 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
 627
 628 #define CODEVIEW_SIGNATURE_RSDS 0x53445352  // "RSDS"
 629 typedef struct {
 630   UINT32  Signature;                        // "RSDS"
 631   UINT32  Unknown;
 632   UINT32  Unknown2;
 633   UINT32  Unknown3;
 634   UINT32  Unknown4;
 635   UINT32  Unknown5;
 636   //
 637   // Filename of .PDB goes here
 638   //
 639 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
 640
 641 //
 642 // .pdata entries for X64
 643 //
 644 typedef struct {
 645   UINT32  FunctionStartAddress;
 646   UINT32  FunctionEndAddress;
 647   UINT32  UnwindInfoAddress;
 648 } RUNTIME_FUNCTION;
 649
 650 typedef struct {
 651   UINT8  Version:3;
 652   UINT8  Flags:5;
 653   UINT8  SizeOfProlog;
 654   UINT8  CountOfUnwindCodes;
 655   UINT8  FrameRegister:4;
 656   UINT8  FrameRegisterOffset:4;
 657 } UNWIND_INFO;
 658
 659 ///
 660 /// Header format for TE images
 661 ///
 662 typedef struct {
 663   UINT16                    Signature;            // signature for TE format = "VZ"
 664   UINT16                    Machine;              // from the original file header
 665   UINT8                     NumberOfSections;     // from the original file header
 666   UINT8                     Subsystem;            // from original optional header
 667   UINT16                    StrippedSize;         // how many bytes we removed from the header
 668   UINT32                    AddressOfEntryPoint;  // offset to entry point -- from original optional header
 669   UINT32                    BaseOfCode;           // from original image -- required for ITP debug
 670   UINT64                    ImageBase;            // from original file header
 671   EFI_IMAGE_DATA_DIRECTORY  DataDirectory[2];     // only base relocation and debug directory
 672 } EFI_TE_IMAGE_HEADER;
 673
 674 #define EFI_TE_IMAGE_HEADER_SIGNATURE 0x5A56      // "VZ"
 675
 676 //
 677 // Data directory indexes in our TE image header
 678 //
 679 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC  0
 680 #define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG      1
 681
 682
 683 //
 684 // Union of PE32, PE32+, and TE headers
 685 //
 686 typedef union {
 687   EFI_IMAGE_NT_HEADERS32   Pe32;
 688   EFI_IMAGE_NT_HEADERS64   Pe32Plus;
 689   EFI_TE_IMAGE_HEADER      Te;
 690 } EFI_IMAGE_OPTIONAL_HEADER_UNION;
 691
 692 typedef union {
 693   EFI_IMAGE_NT_HEADERS32            *Pe32;
 694   EFI_IMAGE_NT_HEADERS64            *Pe32Plus;
 695   EFI_TE_IMAGE_HEADER               *Te;
 696   EFI_IMAGE_OPTIONAL_HEADER_UNION   *Union;
 697 } EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;
 698
 699 #endif