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