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