177943Sdfr/* $FreeBSD$ */
277943Sdfr/*
377943Sdfr    PE32+ header file
477943Sdfr */
577943Sdfr#ifndef _PE_H
677943Sdfr#define _PE_H
777943Sdfr
877943Sdfr#define IMAGE_DOS_SIGNATURE                 0x5A4D      // MZ
977943Sdfr#define IMAGE_OS2_SIGNATURE                 0x454E      // NE
1077943Sdfr#define IMAGE_OS2_SIGNATURE_LE              0x454C      // LE
1177943Sdfr#define IMAGE_NT_SIGNATURE                  0x00004550  // PE00
1277943Sdfr#define IMAGE_EDOS_SIGNATURE                0x44454550  // PEED
1377943Sdfr
1477943Sdfr
1577943Sdfrtypedef struct _IMAGE_DOS_HEADER {      // DOS .EXE header
1677943Sdfr    UINT16   e_magic;                     // Magic number
1777943Sdfr    UINT16   e_cblp;                      // Bytes on last page of file
1877943Sdfr    UINT16   e_cp;                        // Pages in file
1977943Sdfr    UINT16   e_crlc;                      // Relocations
2077943Sdfr    UINT16   e_cparhdr;                   // Size of header in paragraphs
2177943Sdfr    UINT16   e_minalloc;                  // Minimum extra paragraphs needed
2277943Sdfr    UINT16   e_maxalloc;                  // Maximum extra paragraphs needed
2377943Sdfr    UINT16   e_ss;                        // Initial (relative) SS value
2477943Sdfr    UINT16   e_sp;                        // Initial SP value
2577943Sdfr    UINT16   e_csum;                      // Checksum
2677943Sdfr    UINT16   e_ip;                        // Initial IP value
2777943Sdfr    UINT16   e_cs;                        // Initial (relative) CS value
2877943Sdfr    UINT16   e_lfarlc;                    // File address of relocation table
2977943Sdfr    UINT16   e_ovno;                      // Overlay number
3077943Sdfr    UINT16   e_res[4];                    // Reserved words
3177943Sdfr    UINT16   e_oemid;                     // OEM identifier (for e_oeminfo)
3277943Sdfr    UINT16   e_oeminfo;                   // OEM information; e_oemid specific
3377943Sdfr    UINT16   e_res2[10];                  // Reserved words
3477943Sdfr    UINT32   e_lfanew;                    // File address of new exe header
3577943Sdfr  } IMAGE_DOS_HEADER, *PIMAGE_DOS_HEADER;
3677943Sdfr
3777943Sdfrtypedef struct _IMAGE_OS2_HEADER {      // OS/2 .EXE header
3877943Sdfr    UINT16   ne_magic;                    // Magic number
3977943Sdfr    UINT8    ne_ver;                      // Version number
4077943Sdfr    UINT8    ne_rev;                      // Revision number
4177943Sdfr    UINT16   ne_enttab;                   // Offset of Entry Table
4277943Sdfr    UINT16   ne_cbenttab;                 // Number of bytes in Entry Table
4377943Sdfr    UINT32   ne_crc;                      // Checksum of whole file
4477943Sdfr    UINT16   ne_flags;                    // Flag UINT16
4577943Sdfr    UINT16   ne_autodata;                 // Automatic data segment number
4677943Sdfr    UINT16   ne_heap;                     // Initial heap allocation
4777943Sdfr    UINT16   ne_stack;                    // Initial stack allocation
4877943Sdfr    UINT32   ne_csip;                     // Initial CS:IP setting
4977943Sdfr    UINT32   ne_sssp;                     // Initial SS:SP setting
5077943Sdfr    UINT16   ne_cseg;                     // Count of file segments
5177943Sdfr    UINT16   ne_cmod;                     // Entries in Module Reference Table
5277943Sdfr    UINT16   ne_cbnrestab;                // Size of non-resident name table
5377943Sdfr    UINT16   ne_segtab;                   // Offset of Segment Table
5477943Sdfr    UINT16   ne_rsrctab;                  // Offset of Resource Table
5577943Sdfr    UINT16   ne_restab;                   // Offset of resident name table
5677943Sdfr    UINT16   ne_modtab;                   // Offset of Module Reference Table
5777943Sdfr    UINT16   ne_imptab;                   // Offset of Imported Names Table
5877943Sdfr    UINT32   ne_nrestab;                  // Offset of Non-resident Names Table
5977943Sdfr    UINT16   ne_cmovent;                  // Count of movable entries
6077943Sdfr    UINT16   ne_align;                    // Segment alignment shift count
6177943Sdfr    UINT16   ne_cres;                     // Count of resource segments
6277943Sdfr    UINT8    ne_exetyp;                   // Target Operating system
6377943Sdfr    UINT8    ne_flagsothers;              // Other .EXE flags
6477943Sdfr    UINT16   ne_pretthunks;               // offset to return thunks
6577943Sdfr    UINT16   ne_psegrefbytes;             // offset to segment ref. bytes
6677943Sdfr    UINT16   ne_swaparea;                 // Minimum code swap area size
6777943Sdfr    UINT16   ne_expver;                   // Expected Windows version number
6877943Sdfr  } IMAGE_OS2_HEADER, *PIMAGE_OS2_HEADER;
6977943Sdfr
7077943Sdfr//
7177943Sdfr// File header format.
7277943Sdfr//
7377943Sdfr
7477943Sdfrtypedef struct _IMAGE_FILE_HEADER {
7577943Sdfr    UINT16   Machine;
7677943Sdfr    UINT16   NumberOfSections;
7777943Sdfr    UINT32   TimeDateStamp;
7877943Sdfr    UINT32   PointerToSymbolTable;
7977943Sdfr    UINT32   NumberOfSymbols;
8077943Sdfr    UINT16   SizeOfOptionalHeader;
8177943Sdfr    UINT16   Characteristics;
8277943Sdfr} IMAGE_FILE_HEADER, *PIMAGE_FILE_HEADER;
8377943Sdfr
8477943Sdfr#define IMAGE_SIZEOF_FILE_HEADER             20
8577943Sdfr
8677943Sdfr#define IMAGE_FILE_RELOCS_STRIPPED           0x0001  // Relocation info stripped from file.
8777943Sdfr#define IMAGE_FILE_EXECUTABLE_IMAGE          0x0002  // File is executable  (i.e. no unresolved externel references).
8877943Sdfr#define IMAGE_FILE_LINE_NUMS_STRIPPED        0x0004  // Line nunbers stripped from file.
8977943Sdfr#define IMAGE_FILE_LOCAL_SYMS_STRIPPED       0x0008  // Local symbols stripped from file.
9077943Sdfr#define IMAGE_FILE_BYTES_REVERSED_LO         0x0080  // Bytes of machine word are reversed.
9177943Sdfr#define IMAGE_FILE_32BIT_MACHINE             0x0100  // 32 bit word machine.
9277943Sdfr#define IMAGE_FILE_DEBUG_STRIPPED            0x0200  // Debugging info stripped from file in .DBG file
9377943Sdfr#define IMAGE_FILE_SYSTEM                    0x1000  // System File.
9477943Sdfr#define IMAGE_FILE_DLL                       0x2000  // File is a DLL.
9577943Sdfr#define IMAGE_FILE_BYTES_REVERSED_HI         0x8000  // Bytes of machine word are reversed.
9677943Sdfr
9777943Sdfr#define IMAGE_FILE_MACHINE_UNKNOWN           0
9877943Sdfr#define IMAGE_FILE_MACHINE_I386              0x14c   // Intel 386.
9977943Sdfr#define IMAGE_FILE_MACHINE_R3000             0x162   // MIPS little-endian, 0540 big-endian
10077943Sdfr#define IMAGE_FILE_MACHINE_R4000             0x166   // MIPS little-endian
10177943Sdfr#define IMAGE_FILE_MACHINE_ALPHA             0x184   // Alpha_AXP
10277943Sdfr#define IMAGE_FILE_MACHINE_POWERPC           0x1F0   // IBM PowerPC Little-Endian
10377943Sdfr#define IMAGE_FILE_MACHINE_TAHOE             0x7cc   // Intel EM machine
10477943Sdfr//
10577943Sdfr// Directory format.
10677943Sdfr//
10777943Sdfr
10877943Sdfrtypedef struct _IMAGE_DATA_DIRECTORY {
10977943Sdfr    UINT32   VirtualAddress;
11077943Sdfr    UINT32   Size;
11177943Sdfr} IMAGE_DATA_DIRECTORY, *PIMAGE_DATA_DIRECTORY;
11277943Sdfr
11377943Sdfr#define IMAGE_NUMBEROF_DIRECTORY_ENTRIES    16
11477943Sdfr
11577943Sdfr//
11677943Sdfr// Optional header format.
11777943Sdfr//
11877943Sdfr
11977943Sdfrtypedef struct _IMAGE_OPTIONAL_HEADER {
12077943Sdfr    //
12177943Sdfr    // Standard fields.
12277943Sdfr    //
12377943Sdfr
12477943Sdfr    UINT16    Magic;
12577943Sdfr    UINT8     MajorLinkerVersion;
12677943Sdfr    UINT8     MinorLinkerVersion;
12777943Sdfr    UINT32    SizeOfCode;
12877943Sdfr    UINT32    SizeOfInitializedData;
12977943Sdfr    UINT32    SizeOfUninitializedData;
13077943Sdfr    UINT32    AddressOfEntryPoint;
13177943Sdfr    UINT32    BaseOfCode;
13277943Sdfr    UINT32    BaseOfData;
13377943Sdfr
13477943Sdfr    //
13577943Sdfr    // NT additional fields.
13677943Sdfr    //
13777943Sdfr
13877943Sdfr    UINT32   ImageBase;
13977943Sdfr    UINT32   SectionAlignment;
14077943Sdfr    UINT32   FileAlignment;
14177943Sdfr    UINT16   MajorOperatingSystemVersion;
14277943Sdfr    UINT16   MinorOperatingSystemVersion;
14377943Sdfr    UINT16   MajorImageVersion;
14477943Sdfr    UINT16   MinorImageVersion;
14577943Sdfr    UINT16   MajorSubsystemVersion;
14677943Sdfr    UINT16   MinorSubsystemVersion;
14777943Sdfr    UINT32   Reserved1;
14877943Sdfr    UINT32   SizeOfImage;
14977943Sdfr    UINT32   SizeOfHeaders;
15077943Sdfr    UINT32   CheckSum;
15177943Sdfr    UINT16   Subsystem;
15277943Sdfr    UINT16   DllCharacteristics;
15377943Sdfr    UINT32   SizeOfStackReserve;
15477943Sdfr    UINT32   SizeOfStackCommit;
15577943Sdfr    UINT32   SizeOfHeapReserve;
15677943Sdfr    UINT32   SizeOfHeapCommit;
15777943Sdfr    UINT32   LoaderFlags;
15877943Sdfr    UINT32   NumberOfRvaAndSizes;
15977943Sdfr    IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
16077943Sdfr} IMAGE_OPTIONAL_HEADER, *PIMAGE_OPTIONAL_HEADER;
16177943Sdfr
16277943Sdfrtypedef struct _IMAGE_ROM_OPTIONAL_HEADER {
16377943Sdfr    UINT16  Magic;
16477943Sdfr    UINT8   MajorLinkerVersion;
16577943Sdfr    UINT8   MinorLinkerVersion;
16677943Sdfr    UINT32  SizeOfCode;
16777943Sdfr    UINT32  SizeOfInitializedData;
16877943Sdfr    UINT32  SizeOfUninitializedData;
16977943Sdfr    UINT32  AddressOfEntryPoint;
17077943Sdfr    UINT32  BaseOfCode;
17177943Sdfr    UINT32  BaseOfData;
17277943Sdfr    UINT32  BaseOfBss;
17377943Sdfr    UINT32  GprMask;
17477943Sdfr    UINT32  CprMask[4];
17577943Sdfr    UINT32  GpValue;
17677943Sdfr} IMAGE_ROM_OPTIONAL_HEADER, *PIMAGE_ROM_OPTIONAL_HEADER;
17777943Sdfr
17877943Sdfr#define IMAGE_SIZEOF_ROM_OPTIONAL_HEADER      56
17977943Sdfr#define IMAGE_SIZEOF_STD_OPTIONAL_HEADER      28
18077943Sdfr#define IMAGE_SIZEOF_NT_OPTIONAL_HEADER      224
18177943Sdfr
18277943Sdfr#define IMAGE_NT_OPTIONAL_HDR_MAGIC        0x10b
18377943Sdfr#define IMAGE_ROM_OPTIONAL_HDR_MAGIC       0x107
18477943Sdfr
18577943Sdfrtypedef struct _IMAGE_NT_HEADERS {
18677943Sdfr    UINT32 Signature;
18777943Sdfr    IMAGE_FILE_HEADER FileHeader;
18877943Sdfr    IMAGE_OPTIONAL_HEADER OptionalHeader;
18977943Sdfr} IMAGE_NT_HEADERS, *PIMAGE_NT_HEADERS;
19077943Sdfr
19177943Sdfrtypedef struct _IMAGE_ROM_HEADERS {
19277943Sdfr    IMAGE_FILE_HEADER FileHeader;
19377943Sdfr    IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;
19477943Sdfr} IMAGE_ROM_HEADERS, *PIMAGE_ROM_HEADERS;
19577943Sdfr
19677943Sdfr#define IMAGE_FIRST_SECTION( ntheader ) ((PIMAGE_SECTION_HEADER)        \
19777943Sdfr    ((UINT32)ntheader +                                                  \
19877943Sdfr     FIELD_OFFSET( IMAGE_NT_HEADERS, OptionalHeader ) +                 \
19977943Sdfr     ((PIMAGE_NT_HEADERS)(ntheader))->FileHeader.SizeOfOptionalHeader   \
20077943Sdfr    ))
20177943Sdfr
20277943Sdfr
20377943Sdfr// Subsystem Values
20477943Sdfr
20577943Sdfr#define IMAGE_SUBSYSTEM_UNKNOWN              0   // Unknown subsystem.
20677943Sdfr#define IMAGE_SUBSYSTEM_NATIVE               1   // Image doesn't require a subsystem.
20777943Sdfr#define IMAGE_SUBSYSTEM_WINDOWS_GUI          2   // Image runs in the Windows GUI subsystem.
20877943Sdfr#define IMAGE_SUBSYSTEM_WINDOWS_CUI          3   // Image runs in the Windows character subsystem.
20977943Sdfr#define IMAGE_SUBSYSTEM_OS2_CUI              5   // image runs in the OS/2 character subsystem.
21077943Sdfr#define IMAGE_SUBSYSTEM_POSIX_CUI            7   // image run  in the Posix character subsystem.
21177943Sdfr
21277943Sdfr
21377943Sdfr// Directory Entries
21477943Sdfr
21577943Sdfr#define IMAGE_DIRECTORY_ENTRY_EXPORT         0   // Export Directory
21677943Sdfr#define IMAGE_DIRECTORY_ENTRY_IMPORT         1   // Import Directory
21777943Sdfr#define IMAGE_DIRECTORY_ENTRY_RESOURCE       2   // Resource Directory
21877943Sdfr#define IMAGE_DIRECTORY_ENTRY_EXCEPTION      3   // Exception Directory
21977943Sdfr#define IMAGE_DIRECTORY_ENTRY_SECURITY       4   // Security Directory
22077943Sdfr#define IMAGE_DIRECTORY_ENTRY_BASERELOC      5   // Base Relocation Table
22177943Sdfr#define IMAGE_DIRECTORY_ENTRY_DEBUG          6   // Debug Directory
22277943Sdfr#define IMAGE_DIRECTORY_ENTRY_COPYRIGHT      7   // Description String
22377943Sdfr#define IMAGE_DIRECTORY_ENTRY_GLOBALPTR      8   // Machine Value (MIPS GP)
22477943Sdfr#define IMAGE_DIRECTORY_ENTRY_TLS            9   // TLS Directory
22577943Sdfr#define IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG   10   // Load Configuration Directory
22677943Sdfr
22777943Sdfr//
22877943Sdfr// Section header format.
22977943Sdfr//
23077943Sdfr
23177943Sdfr#define IMAGE_SIZEOF_SHORT_NAME              8
23277943Sdfr
23377943Sdfrtypedef struct _IMAGE_SECTION_HEADER {
23477943Sdfr    UINT8   Name[IMAGE_SIZEOF_SHORT_NAME];
23577943Sdfr    union {
23677943Sdfr            UINT32   PhysicalAddress;
23777943Sdfr            UINT32   VirtualSize;
23877943Sdfr    } Misc;
23977943Sdfr    UINT32   VirtualAddress;
24077943Sdfr    UINT32   SizeOfRawData;
24177943Sdfr    UINT32   PointerToRawData;
24277943Sdfr    UINT32   PointerToRelocations;
24377943Sdfr    UINT32   PointerToLinenumbers;
24477943Sdfr    UINT16   NumberOfRelocations;
24577943Sdfr    UINT16   NumberOfLinenumbers;
24677943Sdfr    UINT32   Characteristics;
24777943Sdfr} IMAGE_SECTION_HEADER, *PIMAGE_SECTION_HEADER;
24877943Sdfr
24977943Sdfr#define IMAGE_SIZEOF_SECTION_HEADER          40
25077943Sdfr
25177943Sdfr#define IMAGE_SCN_TYPE_NO_PAD                0x00000008  // Reserved.
25277943Sdfr
25377943Sdfr#define IMAGE_SCN_CNT_CODE                   0x00000020  // Section contains code.
25477943Sdfr#define IMAGE_SCN_CNT_INITIALIZED_DATA       0x00000040  // Section contains initialized data.
25577943Sdfr#define IMAGE_SCN_CNT_UNINITIALIZED_DATA     0x00000080  // Section contains uninitialized data.
25677943Sdfr
25777943Sdfr#define IMAGE_SCN_LNK_OTHER                  0x00000100  // Reserved.
25877943Sdfr#define IMAGE_SCN_LNK_INFO                   0x00000200  // Section contains comments or some other type of information.
25977943Sdfr#define IMAGE_SCN_LNK_REMOVE                 0x00000800  // Section contents will not become part of image.
26077943Sdfr#define IMAGE_SCN_LNK_COMDAT                 0x00001000  // Section contents comdat.
26177943Sdfr
26277943Sdfr#define IMAGE_SCN_ALIGN_1BYTES               0x00100000  //
26377943Sdfr#define IMAGE_SCN_ALIGN_2BYTES               0x00200000  //
26477943Sdfr#define IMAGE_SCN_ALIGN_4BYTES               0x00300000  //
26577943Sdfr#define IMAGE_SCN_ALIGN_8BYTES               0x00400000  //
26677943Sdfr#define IMAGE_SCN_ALIGN_16BYTES              0x00500000  // Default alignment if no others are specified.
26777943Sdfr#define IMAGE_SCN_ALIGN_32BYTES              0x00600000  //
26877943Sdfr#define IMAGE_SCN_ALIGN_64BYTES              0x00700000  //
26977943Sdfr
27077943Sdfr#define IMAGE_SCN_MEM_DISCARDABLE            0x02000000  // Section can be discarded.
27177943Sdfr#define IMAGE_SCN_MEM_NOT_CACHED             0x04000000  // Section is not cachable.
27277943Sdfr#define IMAGE_SCN_MEM_NOT_PAGED              0x08000000  // Section is not pageable.
27377943Sdfr#define IMAGE_SCN_MEM_SHARED                 0x10000000  // Section is shareable.
27477943Sdfr#define IMAGE_SCN_MEM_EXECUTE                0x20000000  // Section is executable.
27577943Sdfr#define IMAGE_SCN_MEM_READ                   0x40000000  // Section is readable.
27677943Sdfr#define IMAGE_SCN_MEM_WRITE                  0x80000000  // Section is writeable.
27777943Sdfr
27877943Sdfr//
27977943Sdfr// Symbol format.
28077943Sdfr//
28177943Sdfr
28277943Sdfr
28377943Sdfr#define IMAGE_SIZEOF_SYMBOL                  18
28477943Sdfr
28577943Sdfr//
28677943Sdfr// Section values.
28777943Sdfr//
28877943Sdfr// Symbols have a section number of the section in which they are
28977943Sdfr// defined. Otherwise, section numbers have the following meanings:
29077943Sdfr//
29177943Sdfr
29277943Sdfr#define IMAGE_SYM_UNDEFINED           (UINT16)0           // Symbol is undefined or is common.
29377943Sdfr#define IMAGE_SYM_ABSOLUTE            (UINT16)-1          // Symbol is an absolute value.
29477943Sdfr#define IMAGE_SYM_DEBUG               (UINT16)-2          // Symbol is a special debug item.
29577943Sdfr
29677943Sdfr//
29777943Sdfr// Type (fundamental) values.
29877943Sdfr//
29977943Sdfr
30077943Sdfr#define IMAGE_SYM_TYPE_NULL                  0           // no type.
30177943Sdfr#define IMAGE_SYM_TYPE_VOID                  1           //
30277943Sdfr#define IMAGE_SYM_TYPE_CHAR                  2           // type character.
30377943Sdfr#define IMAGE_SYM_TYPE_SHORT                 3           // type short integer.
30477943Sdfr#define IMAGE_SYM_TYPE_INT                   4           //
30577943Sdfr#define IMAGE_SYM_TYPE_LONG                  5           //
30677943Sdfr#define IMAGE_SYM_TYPE_FLOAT                 6           //
30777943Sdfr#define IMAGE_SYM_TYPE_DOUBLE                7           //
30877943Sdfr#define IMAGE_SYM_TYPE_STRUCT                8           //
30977943Sdfr#define IMAGE_SYM_TYPE_UNION                 9           //
31077943Sdfr#define IMAGE_SYM_TYPE_ENUM                  10          // enumeration.
31177943Sdfr#define IMAGE_SYM_TYPE_MOE                   11          // member of enumeration.
31277943Sdfr#define IMAGE_SYM_TYPE_BYTE                  12          //
31377943Sdfr#define IMAGE_SYM_TYPE_WORD                  13          //
31477943Sdfr#define IMAGE_SYM_TYPE_UINT                  14          //
31577943Sdfr#define IMAGE_SYM_TYPE_DWORD                 15          //
31677943Sdfr
31777943Sdfr//
31877943Sdfr// Type (derived) values.
31977943Sdfr//
32077943Sdfr
32177943Sdfr#define IMAGE_SYM_DTYPE_NULL                 0           // no derived type.
32277943Sdfr#define IMAGE_SYM_DTYPE_POINTER              1           // pointer.
32377943Sdfr#define IMAGE_SYM_DTYPE_FUNCTION             2           // function.
32477943Sdfr#define IMAGE_SYM_DTYPE_ARRAY                3           // array.
32577943Sdfr
32677943Sdfr//
32777943Sdfr// Storage classes.
32877943Sdfr//
32977943Sdfr
33077943Sdfr#define IMAGE_SYM_CLASS_END_OF_FUNCTION      (BYTE )-1
33177943Sdfr#define IMAGE_SYM_CLASS_NULL                 0
33277943Sdfr#define IMAGE_SYM_CLASS_AUTOMATIC            1
33377943Sdfr#define IMAGE_SYM_CLASS_EXTERNAL             2
33477943Sdfr#define IMAGE_SYM_CLASS_STATIC               3
33577943Sdfr#define IMAGE_SYM_CLASS_REGISTER             4
33677943Sdfr#define IMAGE_SYM_CLASS_EXTERNAL_DEF         5
33777943Sdfr#define IMAGE_SYM_CLASS_LABEL                6
33877943Sdfr#define IMAGE_SYM_CLASS_UNDEFINED_LABEL      7
33977943Sdfr#define IMAGE_SYM_CLASS_MEMBER_OF_STRUCT     8
34077943Sdfr#define IMAGE_SYM_CLASS_ARGUMENT             9
34177943Sdfr#define IMAGE_SYM_CLASS_STRUCT_TAG           10
34277943Sdfr#define IMAGE_SYM_CLASS_MEMBER_OF_UNION      11
34377943Sdfr#define IMAGE_SYM_CLASS_UNION_TAG            12
34477943Sdfr#define IMAGE_SYM_CLASS_TYPE_DEFINITION      13
34577943Sdfr#define IMAGE_SYM_CLASS_UNDEFINED_STATIC     14
34677943Sdfr#define IMAGE_SYM_CLASS_ENUM_TAG             15
34777943Sdfr#define IMAGE_SYM_CLASS_MEMBER_OF_ENUM       16
34877943Sdfr#define IMAGE_SYM_CLASS_REGISTER_PARAM       17
34977943Sdfr#define IMAGE_SYM_CLASS_BIT_FIELD            18
35077943Sdfr#define IMAGE_SYM_CLASS_BLOCK                100
35177943Sdfr#define IMAGE_SYM_CLASS_FUNCTION             101
35277943Sdfr#define IMAGE_SYM_CLASS_END_OF_STRUCT        102
35377943Sdfr#define IMAGE_SYM_CLASS_FILE                 103
35477943Sdfr// new
35577943Sdfr#define IMAGE_SYM_CLASS_SECTION              104
35677943Sdfr#define IMAGE_SYM_CLASS_WEAK_EXTERNAL        105
35777943Sdfr
35877943Sdfr// type packing constants
35977943Sdfr
36077943Sdfr#define N_BTMASK                            017
36177943Sdfr#define N_TMASK                             060
36277943Sdfr#define N_TMASK1                            0300
36377943Sdfr#define N_TMASK2                            0360
36477943Sdfr#define N_BTSHFT                            4
36577943Sdfr#define N_TSHIFT                            2
36677943Sdfr
36777943Sdfr// MACROS
36877943Sdfr
36977943Sdfr//
37077943Sdfr// Communal selection types.
37177943Sdfr//
37277943Sdfr
37377943Sdfr#define IMAGE_COMDAT_SELECT_NODUPLICATES   1
37477943Sdfr#define IMAGE_COMDAT_SELECT_ANY            2
37577943Sdfr#define IMAGE_COMDAT_SELECT_SAME_SIZE      3
37677943Sdfr#define IMAGE_COMDAT_SELECT_EXACT_MATCH    4
37777943Sdfr#define IMAGE_COMDAT_SELECT_ASSOCIATIVE    5
37877943Sdfr
37977943Sdfr#define IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
38077943Sdfr#define IMAGE_WEAK_EXTERN_SEARCH_LIBRARY   2
38177943Sdfr#define IMAGE_WEAK_EXTERN_SEARCH_ALIAS     3
38277943Sdfr
38377943Sdfr
38477943Sdfr//
38577943Sdfr// Relocation format.
38677943Sdfr//
38777943Sdfr
38877943Sdfrtypedef struct _IMAGE_RELOCATION {
38977943Sdfr    UINT32   VirtualAddress;
39077943Sdfr    UINT32   SymbolTableIndex;
39177943Sdfr    UINT16    Type;
39277943Sdfr} IMAGE_RELOCATION;
39377943Sdfr
39477943Sdfr#define IMAGE_SIZEOF_RELOCATION              10
39577943Sdfr
39677943Sdfr//
39777943Sdfr// I386 relocation types.
39877943Sdfr//
39977943Sdfr
40077943Sdfr#define IMAGE_REL_I386_ABSOLUTE              0           // Reference is absolute, no relocation is necessary
40177943Sdfr#define IMAGE_REL_I386_DIR16                 01          // Direct 16-bit reference to the symbols virtual address
40277943Sdfr#define IMAGE_REL_I386_REL16                 02          // PC-relative 16-bit reference to the symbols virtual address
40377943Sdfr#define IMAGE_REL_I386_DIR32                 06          // Direct 32-bit reference to the symbols virtual address
40477943Sdfr#define IMAGE_REL_I386_DIR32NB               07          // Direct 32-bit reference to the symbols virtual address, base not included
40577943Sdfr#define IMAGE_REL_I386_SEG12                 011         // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
40677943Sdfr#define IMAGE_REL_I386_SECTION               012
40777943Sdfr#define IMAGE_REL_I386_SECREL                013
40877943Sdfr#define IMAGE_REL_I386_REL32                 024         // PC-relative 32-bit reference to the symbols virtual address
40977943Sdfr
41077943Sdfr//
41177943Sdfr// MIPS relocation types.
41277943Sdfr//
41377943Sdfr
41477943Sdfr#define IMAGE_REL_MIPS_ABSOLUTE              0           // Reference is absolute, no relocation is necessary
41577943Sdfr#define IMAGE_REL_MIPS_REFHALF               01
41677943Sdfr#define IMAGE_REL_MIPS_REFWORD               02
41777943Sdfr#define IMAGE_REL_MIPS_JMPADDR               03
41877943Sdfr#define IMAGE_REL_MIPS_REFHI                 04
41977943Sdfr#define IMAGE_REL_MIPS_REFLO                 05
42077943Sdfr#define IMAGE_REL_MIPS_GPREL                 06
42177943Sdfr#define IMAGE_REL_MIPS_LITERAL               07
42277943Sdfr#define IMAGE_REL_MIPS_SECTION               012
42377943Sdfr#define IMAGE_REL_MIPS_SECREL                013
42477943Sdfr#define IMAGE_REL_MIPS_REFWORDNB             042
42577943Sdfr#define IMAGE_REL_MIPS_PAIR                  045
42677943Sdfr
42777943Sdfr//
42877943Sdfr// Alpha Relocation types.
42977943Sdfr//
43077943Sdfr
43177943Sdfr#define IMAGE_REL_ALPHA_ABSOLUTE             0x0
43277943Sdfr#define IMAGE_REL_ALPHA_REFLONG              0x1
43377943Sdfr#define IMAGE_REL_ALPHA_REFQUAD              0x2
43477943Sdfr#define IMAGE_REL_ALPHA_GPREL32              0x3
43577943Sdfr#define IMAGE_REL_ALPHA_LITERAL              0x4
43677943Sdfr#define IMAGE_REL_ALPHA_LITUSE               0x5
43777943Sdfr#define IMAGE_REL_ALPHA_GPDISP               0x6
43877943Sdfr#define IMAGE_REL_ALPHA_BRADDR               0x7
43977943Sdfr#define IMAGE_REL_ALPHA_HINT                 0x8
44077943Sdfr#define IMAGE_REL_ALPHA_INLINE_REFLONG       0x9
44177943Sdfr#define IMAGE_REL_ALPHA_REFHI                0xA
44277943Sdfr#define IMAGE_REL_ALPHA_REFLO                0xB
44377943Sdfr#define IMAGE_REL_ALPHA_PAIR                 0xC
44477943Sdfr#define IMAGE_REL_ALPHA_MATCH                0xD
44577943Sdfr#define IMAGE_REL_ALPHA_SECTION              0xE
44677943Sdfr#define IMAGE_REL_ALPHA_SECREL               0xF
44777943Sdfr#define IMAGE_REL_ALPHA_REFLONGNB            0x10
44877943Sdfr
44977943Sdfr//
45077943Sdfr// IBM PowerPC relocation types.
45177943Sdfr//
45277943Sdfr
45377943Sdfr#define IMAGE_REL_PPC_ABSOLUTE 0x0000  // NOP
45477943Sdfr#define IMAGE_REL_PPC_ADDR64   0x0001  // 64-bit address
45577943Sdfr#define IMAGE_REL_PPC_ADDR32   0x0002  // 32-bit address
45677943Sdfr#define IMAGE_REL_PPC_ADDR24   0x0003  // 26-bit address, shifted left 2 (branch absolute)
45777943Sdfr#define IMAGE_REL_PPC_ADDR16   0x0004  // 16-bit address
45877943Sdfr#define IMAGE_REL_PPC_ADDR14   0x0005  // 16-bit address, shifted left 2 (load doubleword)
45977943Sdfr#define IMAGE_REL_PPC_REL24    0x0006  // 26-bit PC-relative offset, shifted left 2 (branch relative)
46077943Sdfr#define IMAGE_REL_PPC_REL14    0x0007  // 16-bit PC-relative offset, shifted left 2 (br cond relative)
46177943Sdfr#define IMAGE_REL_PPC_TOCREL16 0x0008  // 16-bit offset from TOC base
46277943Sdfr#define IMAGE_REL_PPC_TOCREL14 0x0009  // 16-bit offset from TOC base, shifted left 2 (load doubleword)
46377943Sdfr
46477943Sdfr#define IMAGE_REL_PPC_ADDR32NB 0x000A  // 32-bit addr w/o image base
46577943Sdfr#define IMAGE_REL_PPC_SECREL   0x000B  // va of containing section (as in an image sectionhdr)
46677943Sdfr#define IMAGE_REL_PPC_SECTION  0x000C  // sectionheader number
46777943Sdfr#define IMAGE_REL_PPC_IFGLUE   0x000D  // substitute TOC restore instruction iff symbol is glue code
46877943Sdfr#define IMAGE_REL_PPC_IMGLUE   0x000E  // symbol is glue code; virtual address is TOC restore instruction
46977943Sdfr
47077943Sdfr#define IMAGE_REL_PPC_TYPEMASK 0x00FF  // mask to isolate above values in IMAGE_RELOCATION.Type
47177943Sdfr
47277943Sdfr// Flag bits in IMAGE_RELOCATION.TYPE
47377943Sdfr
47477943Sdfr#define IMAGE_REL_PPC_NEG      0x0100  // subtract reloc value rather than adding it
47577943Sdfr#define IMAGE_REL_PPC_BRTAKEN  0x0200  // fix branch prediction bit to predict branch taken
47677943Sdfr#define IMAGE_REL_PPC_BRNTAKEN 0x0400  // fix branch prediction bit to predict branch not taken
47777943Sdfr#define IMAGE_REL_PPC_TOCDEFN  0x0800  // toc slot defined in file (or, data in toc)
47877943Sdfr
47977943Sdfr//
48077943Sdfr// Based relocation format.
48177943Sdfr//
48277943Sdfr
48377943Sdfrtypedef struct _IMAGE_BASE_RELOCATION {
48477943Sdfr    UINT32   VirtualAddress;
48577943Sdfr    UINT32   SizeOfBlock;
48677943Sdfr//  UINT16    TypeOffset[1];
48777943Sdfr} IMAGE_BASE_RELOCATION, *PIMAGE_BASE_RELOCATION;
48877943Sdfr
48977943Sdfr#define IMAGE_SIZEOF_BASE_RELOCATION         8
49077943Sdfr
49177943Sdfr//
49277943Sdfr// Based relocation types.
49377943Sdfr//
49477943Sdfr
49577943Sdfr#define IMAGE_REL_BASED_ABSOLUTE              0
49677943Sdfr#define IMAGE_REL_BASED_HIGH                  1
49777943Sdfr#define IMAGE_REL_BASED_LOW                   2
49877943Sdfr#define IMAGE_REL_BASED_HIGHLOW               3
49977943Sdfr#define IMAGE_REL_BASED_HIGHADJ               4
50077943Sdfr#define IMAGE_REL_BASED_MIPS_JMPADDR          5
50177943Sdfr#define IMAGE_REL_BASED_IA64_IMM64            9
50277943Sdfr#define IMAGE_REL_BASED_DIR64                 10
50377943Sdfr
50477943Sdfr//
50577943Sdfr// Line number format.
50677943Sdfr//
50777943Sdfr
50877943Sdfrtypedef struct _IMAGE_LINENUMBER {
50977943Sdfr    union {
51077943Sdfr        UINT32   SymbolTableIndex;               // Symbol table index of function name if Linenumber is 0.
51177943Sdfr        UINT32   VirtualAddress;                 // Virtual address of line number.
51277943Sdfr    } Type;
51377943Sdfr    UINT16    Linenumber;                         // Line number.
51477943Sdfr} IMAGE_LINENUMBER;
51577943Sdfr
51677943Sdfr#define IMAGE_SIZEOF_LINENUMBER              6
51777943Sdfr
51877943Sdfr//
51977943Sdfr// Archive format.
52077943Sdfr//
52177943Sdfr
52277943Sdfr#define IMAGE_ARCHIVE_START_SIZE             8
52377943Sdfr#define IMAGE_ARCHIVE_START                  "!<arch>\n"
52477943Sdfr#define IMAGE_ARCHIVE_END                    "`\n"
52577943Sdfr#define IMAGE_ARCHIVE_PAD                    "\n"
52677943Sdfr#define IMAGE_ARCHIVE_LINKER_MEMBER          "/               "
52777943Sdfr#define IMAGE_ARCHIVE_LONGNAMES_MEMBER       "//              "
52877943Sdfr
52977943Sdfrtypedef struct _IMAGE_ARCHIVE_MEMBER_HEADER {
53077943Sdfr    UINT8     Name[16];                          // File member name - `/' terminated.
53177943Sdfr    UINT8     Date[12];                          // File member date - decimal.
53277943Sdfr    UINT8     UserID[6];                         // File member user id - decimal.
53377943Sdfr    UINT8     GroupID[6];                        // File member group id - decimal.
53477943Sdfr    UINT8     Mode[8];                           // File member mode - octal.
53577943Sdfr    UINT8     Size[10];                          // File member size - decimal.
53677943Sdfr    UINT8     EndHeader[2];                      // String to end header.
53777943Sdfr} IMAGE_ARCHIVE_MEMBER_HEADER, *PIMAGE_ARCHIVE_MEMBER_HEADER;
53877943Sdfr
53977943Sdfr#define IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR      60
54077943Sdfr
54177943Sdfr//
54277943Sdfr// DLL support.
54377943Sdfr//
54477943Sdfr
54577943Sdfr//
54677943Sdfr// Export Format
54777943Sdfr//
54877943Sdfr
54977943Sdfrtypedef struct _IMAGE_EXPORT_DIRECTORY {
55077943Sdfr    UINT32   Characteristics;
55177943Sdfr    UINT32   TimeDateStamp;
55277943Sdfr    UINT16   MajorVersion;
55377943Sdfr    UINT16   MinorVersion;
55477943Sdfr    UINT32   Name;
55577943Sdfr    UINT32   Base;
55677943Sdfr    UINT32   NumberOfFunctions;
55777943Sdfr    UINT32   NumberOfNames;
55877943Sdfr    UINT32   *AddressOfFunctions;
55977943Sdfr    UINT32   *AddressOfNames;
56077943Sdfr    UINT32   *AddressOfNameOrdinals;
56177943Sdfr} IMAGE_EXPORT_DIRECTORY, *PIMAGE_EXPORT_DIRECTORY;
56277943Sdfr
56377943Sdfr//
56477943Sdfr// Import Format
56577943Sdfr//
56677943Sdfr
56777943Sdfrtypedef struct _IMAGE_IMPORT_BY_NAME {
56877943Sdfr    UINT16    Hint;
56977943Sdfr    UINT8     Name[1];
57077943Sdfr} IMAGE_IMPORT_BY_NAME, *PIMAGE_IMPORT_BY_NAME;
57177943Sdfr
57277943Sdfrtypedef struct _IMAGE_THUNK_DATA {
57377943Sdfr    union {
57477943Sdfr        UINT32 Function;
57577943Sdfr        UINT32 Ordinal;
57677943Sdfr        PIMAGE_IMPORT_BY_NAME AddressOfData;
57777943Sdfr    } u1;
57877943Sdfr} IMAGE_THUNK_DATA, *PIMAGE_THUNK_DATA;
57977943Sdfr
58077943Sdfr#define IMAGE_ORDINAL_FLAG 0x80000000
58177943Sdfr#define IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & IMAGE_ORDINAL_FLAG) != 0)
58277943Sdfr#define IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
58377943Sdfr
58477943Sdfrtypedef struct _IMAGE_IMPORT_DESCRIPTOR {
58577943Sdfr    UINT32   Characteristics;
58677943Sdfr    UINT32   TimeDateStamp;
58777943Sdfr    UINT32   ForwarderChain;
58877943Sdfr    UINT32   Name;
58977943Sdfr    PIMAGE_THUNK_DATA FirstThunk;
59077943Sdfr} IMAGE_IMPORT_DESCRIPTOR, *PIMAGE_IMPORT_DESCRIPTOR;
59177943Sdfr
592163898Smarcel#define IMAGE_DEBUG_TYPE_CODEVIEW   2
593163898Smarcel
594163898Smarceltypedef struct {
595163898Smarcel  UINT32    Characteristics;
596163898Smarcel  UINT32    TimeDateStamp;
597163898Smarcel  UINT16    MajorVersion;
598163898Smarcel  UINT16    MinorVersion;
599163898Smarcel  UINT32    Type;
600163898Smarcel  UINT32    SizeOfData;
601163898Smarcel  UINT32    RVA;
602163898Smarcel  UINT32    FileOffset;
603163898Smarcel} IMAGE_DEBUG_DIRECTORY_ENTRY;
604163898Smarcel
605163898Smarcel#define CODEVIEW_SIGNATURE_NB10  0x3031424E // "NB10"
606163898Smarcel
607163898Smarceltypedef struct {
608163898Smarcel  UINT32    Signature; // "NB10"
609163898Smarcel  UINT32    Unknown;
610163898Smarcel  UINT32    Unknown2;
611163898Smarcel  UINT32    Unknown3;
612163898Smarcel  //
613163898Smarcel  // Filename of .PDB goes here
614163898Smarcel  //
615163898Smarcel} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
616163898Smarcel
617163898Smarcel#define CODEVIEW_SIGNATURE_RSDS  0x53445352 // "RSDS"
618163898Smarcel
619163898Smarceltypedef struct {
620163898Smarcel  UINT32    Signature; // "RSDS"
621163898Smarcel  UINT32    Unknown;
622163898Smarcel  UINT32    Unknown2;
623163898Smarcel  UINT32    Unknown3;
624163898Smarcel  UINT32    Unknown4;
625163898Smarcel  UINT32    Unknown5;
626163898Smarcel  //
627163898Smarcel  // Filename of .PDB goes here
628163898Smarcel  //
629163898Smarcel} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
630163898Smarcel
63177943Sdfr#endif
632