MdePkg/Include/IndustryStandard/PeImage.h

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