MdePkg/Include/IndustryStandard/PeImage.h

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