xref: /freebsd/stand/efi/include/i386/pe.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /* $FreeBSD$ */
2 /*
3     PE32+ header file
4  */
5 #ifndef _PE_H
6 #define _PE_H
7 
8 #define IMAGE_DOS_SIGNATURE                 0x5A4D      // MZ
9 #define IMAGE_OS2_SIGNATURE                 0x454E      // NE
10 #define IMAGE_OS2_SIGNATURE_LE              0x454C      // LE
11 #define IMAGE_NT_SIGNATURE                  0x00004550  // PE00
12 #define IMAGE_EDOS_SIGNATURE                0x44454550  // PEED
13 
14 
15 typedef struct _IMAGE_DOS_HEADER {      // DOS .EXE header
16     UINT16   e_magic;                     // Magic number
17     UINT16   e_cblp;                      // Bytes on last page of file
18     UINT16   e_cp;                        // Pages in file
19     UINT16   e_crlc;                      // Relocations
20     UINT16   e_cparhdr;                   // Size of header in paragraphs
21     UINT16   e_minalloc;                  // Minimum extra paragraphs needed
22     UINT16   e_maxalloc;                  // Maximum extra paragraphs needed
23     UINT16   e_ss;                        // Initial (relative) SS value
24     UINT16   e_sp;                        // Initial SP value
25     UINT16   e_csum;                      // Checksum
26     UINT16   e_ip;                        // Initial IP value
27     UINT16   e_cs;                        // Initial (relative) CS value
28     UINT16   e_lfarlc;                    // File address of relocation table
29     UINT16   e_ovno;                      // Overlay number
30     UINT16   e_res[4];                    // Reserved words
31     UINT16   e_oemid;                     // OEM identifier (for e_oeminfo)
32     UINT16   e_oeminfo;                   // OEM information; e_oemid specific
33     UINT16   e_res2[10];                  // Reserved words
34     UINT32   e_lfanew;                    // File address of new exe header
35   } IMAGE_DOS_HEADER, *PIMAGE_DOS_HEADER;
36 
37 typedef struct _IMAGE_OS2_HEADER {      // OS/2 .EXE header
38     UINT16   ne_magic;                    // Magic number
39     UINT8    ne_ver;                      // Version number
40     UINT8    ne_rev;                      // Revision number
41     UINT16   ne_enttab;                   // Offset of Entry Table
42     UINT16   ne_cbenttab;                 // Number of bytes in Entry Table
43     UINT32   ne_crc;                      // Checksum of whole file
44     UINT16   ne_flags;                    // Flag UINT16
45     UINT16   ne_autodata;                 // Automatic data segment number
46     UINT16   ne_heap;                     // Initial heap allocation
47     UINT16   ne_stack;                    // Initial stack allocation
48     UINT32   ne_csip;                     // Initial CS:IP setting
49     UINT32   ne_sssp;                     // Initial SS:SP setting
50     UINT16   ne_cseg;                     // Count of file segments
51     UINT16   ne_cmod;                     // Entries in Module Reference Table
52     UINT16   ne_cbnrestab;                // Size of non-resident name table
53     UINT16   ne_segtab;                   // Offset of Segment Table
54     UINT16   ne_rsrctab;                  // Offset of Resource Table
55     UINT16   ne_restab;                   // Offset of resident name table
56     UINT16   ne_modtab;                   // Offset of Module Reference Table
57     UINT16   ne_imptab;                   // Offset of Imported Names Table
58     UINT32   ne_nrestab;                  // Offset of Non-resident Names Table
59     UINT16   ne_cmovent;                  // Count of movable entries
60     UINT16   ne_align;                    // Segment alignment shift count
61     UINT16   ne_cres;                     // Count of resource segments
62     UINT8    ne_exetyp;                   // Target Operating system
63     UINT8    ne_flagsothers;              // Other .EXE flags
64     UINT16   ne_pretthunks;               // offset to return thunks
65     UINT16   ne_psegrefbytes;             // offset to segment ref. bytes
66     UINT16   ne_swaparea;                 // Minimum code swap area size
67     UINT16   ne_expver;                   // Expected Windows version number
68   } IMAGE_OS2_HEADER, *PIMAGE_OS2_HEADER;
69 
70 //
71 // File header format.
72 //
73 
74 typedef struct _IMAGE_FILE_HEADER {
75     UINT16   Machine;
76     UINT16   NumberOfSections;
77     UINT32   TimeDateStamp;
78     UINT32   PointerToSymbolTable;
79     UINT32   NumberOfSymbols;
80     UINT16   SizeOfOptionalHeader;
81     UINT16   Characteristics;
82 } IMAGE_FILE_HEADER, *PIMAGE_FILE_HEADER;
83 
84 #define IMAGE_SIZEOF_FILE_HEADER             20
85 
86 #define IMAGE_FILE_RELOCS_STRIPPED           0x0001  // Relocation info stripped from file.
87 #define IMAGE_FILE_EXECUTABLE_IMAGE          0x0002  // File is executable  (i.e. no unresolved externel references).
88 #define IMAGE_FILE_LINE_NUMS_STRIPPED        0x0004  // Line nunbers stripped from file.
89 #define IMAGE_FILE_LOCAL_SYMS_STRIPPED       0x0008  // Local symbols stripped from file.
90 #define IMAGE_FILE_BYTES_REVERSED_LO         0x0080  // Bytes of machine word are reversed.
91 #define IMAGE_FILE_32BIT_MACHINE             0x0100  // 32 bit word machine.
92 #define IMAGE_FILE_DEBUG_STRIPPED            0x0200  // Debugging info stripped from file in .DBG file
93 #define IMAGE_FILE_SYSTEM                    0x1000  // System File.
94 #define IMAGE_FILE_DLL                       0x2000  // File is a DLL.
95 #define IMAGE_FILE_BYTES_REVERSED_HI         0x8000  // Bytes of machine word are reversed.
96 
97 #define IMAGE_FILE_MACHINE_UNKNOWN           0
98 #define IMAGE_FILE_MACHINE_I386              0x14c   // Intel 386.
99 #define IMAGE_FILE_MACHINE_R3000             0x162   // MIPS little-endian, 0540 big-endian
100 #define IMAGE_FILE_MACHINE_R4000             0x166   // MIPS little-endian
101 #define IMAGE_FILE_MACHINE_ALPHA             0x184   // Alpha_AXP
102 #define IMAGE_FILE_MACHINE_POWERPC           0x1F0   // IBM PowerPC Little-Endian
103 #define IMAGE_FILE_MACHINE_TAHOE             0x7cc   // Intel EM machine
104 //
105 // Directory format.
106 //
107 
108 typedef struct _IMAGE_DATA_DIRECTORY {
109     UINT32   VirtualAddress;
110     UINT32   Size;
111 } IMAGE_DATA_DIRECTORY, *PIMAGE_DATA_DIRECTORY;
112 
113 #define IMAGE_NUMBEROF_DIRECTORY_ENTRIES    16
114 
115 //
116 // Optional header format.
117 //
118 
119 typedef struct _IMAGE_OPTIONAL_HEADER {
120     //
121     // Standard fields.
122     //
123 
124     UINT16    Magic;
125     UINT8     MajorLinkerVersion;
126     UINT8     MinorLinkerVersion;
127     UINT32    SizeOfCode;
128     UINT32    SizeOfInitializedData;
129     UINT32    SizeOfUninitializedData;
130     UINT32    AddressOfEntryPoint;
131     UINT32    BaseOfCode;
132     UINT32    BaseOfData;
133 
134     //
135     // NT additional fields.
136     //
137 
138     UINT32   ImageBase;
139     UINT32   SectionAlignment;
140     UINT32   FileAlignment;
141     UINT16   MajorOperatingSystemVersion;
142     UINT16   MinorOperatingSystemVersion;
143     UINT16   MajorImageVersion;
144     UINT16   MinorImageVersion;
145     UINT16   MajorSubsystemVersion;
146     UINT16   MinorSubsystemVersion;
147     UINT32   Reserved1;
148     UINT32   SizeOfImage;
149     UINT32   SizeOfHeaders;
150     UINT32   CheckSum;
151     UINT16   Subsystem;
152     UINT16   DllCharacteristics;
153     UINT32   SizeOfStackReserve;
154     UINT32   SizeOfStackCommit;
155     UINT32   SizeOfHeapReserve;
156     UINT32   SizeOfHeapCommit;
157     UINT32   LoaderFlags;
158     UINT32   NumberOfRvaAndSizes;
159     IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
160 } IMAGE_OPTIONAL_HEADER, *PIMAGE_OPTIONAL_HEADER;
161 
162 typedef struct _IMAGE_ROM_OPTIONAL_HEADER {
163     UINT16  Magic;
164     UINT8   MajorLinkerVersion;
165     UINT8   MinorLinkerVersion;
166     UINT32  SizeOfCode;
167     UINT32  SizeOfInitializedData;
168     UINT32  SizeOfUninitializedData;
169     UINT32  AddressOfEntryPoint;
170     UINT32  BaseOfCode;
171     UINT32  BaseOfData;
172     UINT32  BaseOfBss;
173     UINT32  GprMask;
174     UINT32  CprMask[4];
175     UINT32  GpValue;
176 } IMAGE_ROM_OPTIONAL_HEADER, *PIMAGE_ROM_OPTIONAL_HEADER;
177 
178 #define IMAGE_SIZEOF_ROM_OPTIONAL_HEADER      56
179 #define IMAGE_SIZEOF_STD_OPTIONAL_HEADER      28
180 #define IMAGE_SIZEOF_NT_OPTIONAL_HEADER      224
181 
182 #define IMAGE_NT_OPTIONAL_HDR_MAGIC        0x10b
183 #define IMAGE_ROM_OPTIONAL_HDR_MAGIC       0x107
184 
185 typedef struct _IMAGE_NT_HEADERS {
186     UINT32 Signature;
187     IMAGE_FILE_HEADER FileHeader;
188     IMAGE_OPTIONAL_HEADER OptionalHeader;
189 } IMAGE_NT_HEADERS, *PIMAGE_NT_HEADERS;
190 
191 typedef struct _IMAGE_ROM_HEADERS {
192     IMAGE_FILE_HEADER FileHeader;
193     IMAGE_ROM_OPTIONAL_HEADER OptionalHeader;
194 } IMAGE_ROM_HEADERS, *PIMAGE_ROM_HEADERS;
195 
196 #define IMAGE_FIRST_SECTION( ntheader ) ((PIMAGE_SECTION_HEADER)        \
197     ((UINT32)ntheader +                                                  \
198      FIELD_OFFSET( IMAGE_NT_HEADERS, OptionalHeader ) +                 \
199      ((PIMAGE_NT_HEADERS)(ntheader))->FileHeader.SizeOfOptionalHeader   \
200     ))
201 
202 
203 // Subsystem Values
204 
205 #define IMAGE_SUBSYSTEM_UNKNOWN              0   // Unknown subsystem.
206 #define IMAGE_SUBSYSTEM_NATIVE               1   // Image doesn't require a subsystem.
207 #define IMAGE_SUBSYSTEM_WINDOWS_GUI          2   // Image runs in the Windows GUI subsystem.
208 #define IMAGE_SUBSYSTEM_WINDOWS_CUI          3   // Image runs in the Windows character subsystem.
209 #define IMAGE_SUBSYSTEM_OS2_CUI              5   // image runs in the OS/2 character subsystem.
210 #define IMAGE_SUBSYSTEM_POSIX_CUI            7   // image run  in the Posix character subsystem.
211 
212 
213 // Directory Entries
214 
215 #define IMAGE_DIRECTORY_ENTRY_EXPORT         0   // Export Directory
216 #define IMAGE_DIRECTORY_ENTRY_IMPORT         1   // Import Directory
217 #define IMAGE_DIRECTORY_ENTRY_RESOURCE       2   // Resource Directory
218 #define IMAGE_DIRECTORY_ENTRY_EXCEPTION      3   // Exception Directory
219 #define IMAGE_DIRECTORY_ENTRY_SECURITY       4   // Security Directory
220 #define IMAGE_DIRECTORY_ENTRY_BASERELOC      5   // Base Relocation Table
221 #define IMAGE_DIRECTORY_ENTRY_DEBUG          6   // Debug Directory
222 #define IMAGE_DIRECTORY_ENTRY_COPYRIGHT      7   // Description String
223 #define IMAGE_DIRECTORY_ENTRY_GLOBALPTR      8   // Machine Value (MIPS GP)
224 #define IMAGE_DIRECTORY_ENTRY_TLS            9   // TLS Directory
225 #define IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG   10   // Load Configuration Directory
226 
227 //
228 // Section header format.
229 //
230 
231 #define IMAGE_SIZEOF_SHORT_NAME              8
232 
233 typedef struct _IMAGE_SECTION_HEADER {
234     UINT8   Name[IMAGE_SIZEOF_SHORT_NAME];
235     union {
236             UINT32   PhysicalAddress;
237             UINT32   VirtualSize;
238     } Misc;
239     UINT32   VirtualAddress;
240     UINT32   SizeOfRawData;
241     UINT32   PointerToRawData;
242     UINT32   PointerToRelocations;
243     UINT32   PointerToLinenumbers;
244     UINT16   NumberOfRelocations;
245     UINT16   NumberOfLinenumbers;
246     UINT32   Characteristics;
247 } IMAGE_SECTION_HEADER, *PIMAGE_SECTION_HEADER;
248 
249 #define IMAGE_SIZEOF_SECTION_HEADER          40
250 
251 #define IMAGE_SCN_TYPE_NO_PAD                0x00000008  // Reserved.
252 
253 #define IMAGE_SCN_CNT_CODE                   0x00000020  // Section contains code.
254 #define IMAGE_SCN_CNT_INITIALIZED_DATA       0x00000040  // Section contains initialized data.
255 #define IMAGE_SCN_CNT_UNINITIALIZED_DATA     0x00000080  // Section contains uninitialized data.
256 
257 #define IMAGE_SCN_LNK_OTHER                  0x00000100  // Reserved.
258 #define IMAGE_SCN_LNK_INFO                   0x00000200  // Section contains comments or some other type of information.
259 #define IMAGE_SCN_LNK_REMOVE                 0x00000800  // Section contents will not become part of image.
260 #define IMAGE_SCN_LNK_COMDAT                 0x00001000  // Section contents comdat.
261 
262 #define IMAGE_SCN_ALIGN_1BYTES               0x00100000  //
263 #define IMAGE_SCN_ALIGN_2BYTES               0x00200000  //
264 #define IMAGE_SCN_ALIGN_4BYTES               0x00300000  //
265 #define IMAGE_SCN_ALIGN_8BYTES               0x00400000  //
266 #define IMAGE_SCN_ALIGN_16BYTES              0x00500000  // Default alignment if no others are specified.
267 #define IMAGE_SCN_ALIGN_32BYTES              0x00600000  //
268 #define IMAGE_SCN_ALIGN_64BYTES              0x00700000  //
269 
270 #define IMAGE_SCN_MEM_DISCARDABLE            0x02000000  // Section can be discarded.
271 #define IMAGE_SCN_MEM_NOT_CACHED             0x04000000  // Section is not cachable.
272 #define IMAGE_SCN_MEM_NOT_PAGED              0x08000000  // Section is not pageable.
273 #define IMAGE_SCN_MEM_SHARED                 0x10000000  // Section is shareable.
274 #define IMAGE_SCN_MEM_EXECUTE                0x20000000  // Section is executable.
275 #define IMAGE_SCN_MEM_READ                   0x40000000  // Section is readable.
276 #define IMAGE_SCN_MEM_WRITE                  0x80000000  // Section is writeable.
277 
278 //
279 // Symbol format.
280 //
281 
282 
283 #define IMAGE_SIZEOF_SYMBOL                  18
284 
285 //
286 // Section values.
287 //
288 // Symbols have a section number of the section in which they are
289 // defined. Otherwise, section numbers have the following meanings:
290 //
291 
292 #define IMAGE_SYM_UNDEFINED           (UINT16)0           // Symbol is undefined or is common.
293 #define IMAGE_SYM_ABSOLUTE            (UINT16)-1          // Symbol is an absolute value.
294 #define IMAGE_SYM_DEBUG               (UINT16)-2          // Symbol is a special debug item.
295 
296 //
297 // Type (fundamental) values.
298 //
299 
300 #define IMAGE_SYM_TYPE_NULL                  0           // no type.
301 #define IMAGE_SYM_TYPE_VOID                  1           //
302 #define IMAGE_SYM_TYPE_CHAR                  2           // type character.
303 #define IMAGE_SYM_TYPE_SHORT                 3           // type short integer.
304 #define IMAGE_SYM_TYPE_INT                   4           //
305 #define IMAGE_SYM_TYPE_LONG                  5           //
306 #define IMAGE_SYM_TYPE_FLOAT                 6           //
307 #define IMAGE_SYM_TYPE_DOUBLE                7           //
308 #define IMAGE_SYM_TYPE_STRUCT                8           //
309 #define IMAGE_SYM_TYPE_UNION                 9           //
310 #define IMAGE_SYM_TYPE_ENUM                  10          // enumeration.
311 #define IMAGE_SYM_TYPE_MOE                   11          // member of enumeration.
312 #define IMAGE_SYM_TYPE_BYTE                  12          //
313 #define IMAGE_SYM_TYPE_WORD                  13          //
314 #define IMAGE_SYM_TYPE_UINT                  14          //
315 #define IMAGE_SYM_TYPE_DWORD                 15          //
316 
317 //
318 // Type (derived) values.
319 //
320 
321 #define IMAGE_SYM_DTYPE_NULL                 0           // no derived type.
322 #define IMAGE_SYM_DTYPE_POINTER              1           // pointer.
323 #define IMAGE_SYM_DTYPE_FUNCTION             2           // function.
324 #define IMAGE_SYM_DTYPE_ARRAY                3           // array.
325 
326 //
327 // Storage classes.
328 //
329 
330 #define IMAGE_SYM_CLASS_END_OF_FUNCTION      (BYTE )-1
331 #define IMAGE_SYM_CLASS_NULL                 0
332 #define IMAGE_SYM_CLASS_AUTOMATIC            1
333 #define IMAGE_SYM_CLASS_EXTERNAL             2
334 #define IMAGE_SYM_CLASS_STATIC               3
335 #define IMAGE_SYM_CLASS_REGISTER             4
336 #define IMAGE_SYM_CLASS_EXTERNAL_DEF         5
337 #define IMAGE_SYM_CLASS_LABEL                6
338 #define IMAGE_SYM_CLASS_UNDEFINED_LABEL      7
339 #define IMAGE_SYM_CLASS_MEMBER_OF_STRUCT     8
340 #define IMAGE_SYM_CLASS_ARGUMENT             9
341 #define IMAGE_SYM_CLASS_STRUCT_TAG           10
342 #define IMAGE_SYM_CLASS_MEMBER_OF_UNION      11
343 #define IMAGE_SYM_CLASS_UNION_TAG            12
344 #define IMAGE_SYM_CLASS_TYPE_DEFINITION      13
345 #define IMAGE_SYM_CLASS_UNDEFINED_STATIC     14
346 #define IMAGE_SYM_CLASS_ENUM_TAG             15
347 #define IMAGE_SYM_CLASS_MEMBER_OF_ENUM       16
348 #define IMAGE_SYM_CLASS_REGISTER_PARAM       17
349 #define IMAGE_SYM_CLASS_BIT_FIELD            18
350 #define IMAGE_SYM_CLASS_BLOCK                100
351 #define IMAGE_SYM_CLASS_FUNCTION             101
352 #define IMAGE_SYM_CLASS_END_OF_STRUCT        102
353 #define IMAGE_SYM_CLASS_FILE                 103
354 // new
355 #define IMAGE_SYM_CLASS_SECTION              104
356 #define IMAGE_SYM_CLASS_WEAK_EXTERNAL        105
357 
358 // type packing constants
359 
360 #define N_BTMASK                            017
361 #define N_TMASK                             060
362 #define N_TMASK1                            0300
363 #define N_TMASK2                            0360
364 #define N_BTSHFT                            4
365 #define N_TSHIFT                            2
366 
367 // MACROS
368 
369 //
370 // Communal selection types.
371 //
372 
373 #define IMAGE_COMDAT_SELECT_NODUPLICATES   1
374 #define IMAGE_COMDAT_SELECT_ANY            2
375 #define IMAGE_COMDAT_SELECT_SAME_SIZE      3
376 #define IMAGE_COMDAT_SELECT_EXACT_MATCH    4
377 #define IMAGE_COMDAT_SELECT_ASSOCIATIVE    5
378 
379 #define IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
380 #define IMAGE_WEAK_EXTERN_SEARCH_LIBRARY   2
381 #define IMAGE_WEAK_EXTERN_SEARCH_ALIAS     3
382 
383 
384 //
385 // Relocation format.
386 //
387 
388 typedef struct _IMAGE_RELOCATION {
389     UINT32   VirtualAddress;
390     UINT32   SymbolTableIndex;
391     UINT16    Type;
392 } IMAGE_RELOCATION;
393 
394 #define IMAGE_SIZEOF_RELOCATION              10
395 
396 //
397 // I386 relocation types.
398 //
399 
400 #define IMAGE_REL_I386_ABSOLUTE              0           // Reference is absolute, no relocation is necessary
401 #define IMAGE_REL_I386_DIR16                 01          // Direct 16-bit reference to the symbols virtual address
402 #define IMAGE_REL_I386_REL16                 02          // PC-relative 16-bit reference to the symbols virtual address
403 #define IMAGE_REL_I386_DIR32                 06          // Direct 32-bit reference to the symbols virtual address
404 #define IMAGE_REL_I386_DIR32NB               07          // Direct 32-bit reference to the symbols virtual address, base not included
405 #define IMAGE_REL_I386_SEG12                 011         // Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address
406 #define IMAGE_REL_I386_SECTION               012
407 #define IMAGE_REL_I386_SECREL                013
408 #define IMAGE_REL_I386_REL32                 024         // PC-relative 32-bit reference to the symbols virtual address
409 
410 //
411 // MIPS relocation types.
412 //
413 
414 #define IMAGE_REL_MIPS_ABSOLUTE              0           // Reference is absolute, no relocation is necessary
415 #define IMAGE_REL_MIPS_REFHALF               01
416 #define IMAGE_REL_MIPS_REFWORD               02
417 #define IMAGE_REL_MIPS_JMPADDR               03
418 #define IMAGE_REL_MIPS_REFHI                 04
419 #define IMAGE_REL_MIPS_REFLO                 05
420 #define IMAGE_REL_MIPS_GPREL                 06
421 #define IMAGE_REL_MIPS_LITERAL               07
422 #define IMAGE_REL_MIPS_SECTION               012
423 #define IMAGE_REL_MIPS_SECREL                013
424 #define IMAGE_REL_MIPS_REFWORDNB             042
425 #define IMAGE_REL_MIPS_PAIR                  045
426 
427 //
428 // Alpha Relocation types.
429 //
430 
431 #define IMAGE_REL_ALPHA_ABSOLUTE             0x0
432 #define IMAGE_REL_ALPHA_REFLONG              0x1
433 #define IMAGE_REL_ALPHA_REFQUAD              0x2
434 #define IMAGE_REL_ALPHA_GPREL32              0x3
435 #define IMAGE_REL_ALPHA_LITERAL              0x4
436 #define IMAGE_REL_ALPHA_LITUSE               0x5
437 #define IMAGE_REL_ALPHA_GPDISP               0x6
438 #define IMAGE_REL_ALPHA_BRADDR               0x7
439 #define IMAGE_REL_ALPHA_HINT                 0x8
440 #define IMAGE_REL_ALPHA_INLINE_REFLONG       0x9
441 #define IMAGE_REL_ALPHA_REFHI                0xA
442 #define IMAGE_REL_ALPHA_REFLO                0xB
443 #define IMAGE_REL_ALPHA_PAIR                 0xC
444 #define IMAGE_REL_ALPHA_MATCH                0xD
445 #define IMAGE_REL_ALPHA_SECTION              0xE
446 #define IMAGE_REL_ALPHA_SECREL               0xF
447 #define IMAGE_REL_ALPHA_REFLONGNB            0x10
448 
449 //
450 // IBM PowerPC relocation types.
451 //
452 
453 #define IMAGE_REL_PPC_ABSOLUTE 0x0000  // NOP
454 #define IMAGE_REL_PPC_ADDR64   0x0001  // 64-bit address
455 #define IMAGE_REL_PPC_ADDR32   0x0002  // 32-bit address
456 #define IMAGE_REL_PPC_ADDR24   0x0003  // 26-bit address, shifted left 2 (branch absolute)
457 #define IMAGE_REL_PPC_ADDR16   0x0004  // 16-bit address
458 #define IMAGE_REL_PPC_ADDR14   0x0005  // 16-bit address, shifted left 2 (load doubleword)
459 #define IMAGE_REL_PPC_REL24    0x0006  // 26-bit PC-relative offset, shifted left 2 (branch relative)
460 #define IMAGE_REL_PPC_REL14    0x0007  // 16-bit PC-relative offset, shifted left 2 (br cond relative)
461 #define IMAGE_REL_PPC_TOCREL16 0x0008  // 16-bit offset from TOC base
462 #define IMAGE_REL_PPC_TOCREL14 0x0009  // 16-bit offset from TOC base, shifted left 2 (load doubleword)
463 
464 #define IMAGE_REL_PPC_ADDR32NB 0x000A  // 32-bit addr w/o image base
465 #define IMAGE_REL_PPC_SECREL   0x000B  // va of containing section (as in an image sectionhdr)
466 #define IMAGE_REL_PPC_SECTION  0x000C  // sectionheader number
467 #define IMAGE_REL_PPC_IFGLUE   0x000D  // substitute TOC restore instruction iff symbol is glue code
468 #define IMAGE_REL_PPC_IMGLUE   0x000E  // symbol is glue code; virtual address is TOC restore instruction
469 
470 #define IMAGE_REL_PPC_TYPEMASK 0x00FF  // mask to isolate above values in IMAGE_RELOCATION.Type
471 
472 // Flag bits in IMAGE_RELOCATION.TYPE
473 
474 #define IMAGE_REL_PPC_NEG      0x0100  // subtract reloc value rather than adding it
475 #define IMAGE_REL_PPC_BRTAKEN  0x0200  // fix branch prediction bit to predict branch taken
476 #define IMAGE_REL_PPC_BRNTAKEN 0x0400  // fix branch prediction bit to predict branch not taken
477 #define IMAGE_REL_PPC_TOCDEFN  0x0800  // toc slot defined in file (or, data in toc)
478 
479 //
480 // Based relocation format.
481 //
482 
483 typedef struct _IMAGE_BASE_RELOCATION {
484     UINT32   VirtualAddress;
485     UINT32   SizeOfBlock;
486 //  UINT16    TypeOffset[1];
487 } IMAGE_BASE_RELOCATION, *PIMAGE_BASE_RELOCATION;
488 
489 #define IMAGE_SIZEOF_BASE_RELOCATION         8
490 
491 //
492 // Based relocation types.
493 //
494 
495 #define IMAGE_REL_BASED_ABSOLUTE              0
496 #define IMAGE_REL_BASED_HIGH                  1
497 #define IMAGE_REL_BASED_LOW                   2
498 #define IMAGE_REL_BASED_HIGHLOW               3
499 #define IMAGE_REL_BASED_HIGHADJ               4
500 #define IMAGE_REL_BASED_MIPS_JMPADDR          5
501 #define IMAGE_REL_BASED_DIR64                 10
502 
503 //
504 // Line number format.
505 //
506 
507 typedef struct _IMAGE_LINENUMBER {
508     union {
509         UINT32   SymbolTableIndex;               // Symbol table index of function name if Linenumber is 0.
510         UINT32   VirtualAddress;                 // Virtual address of line number.
511     } Type;
512     UINT16    Linenumber;                         // Line number.
513 } IMAGE_LINENUMBER;
514 
515 #define IMAGE_SIZEOF_LINENUMBER              6
516 
517 //
518 // Archive format.
519 //
520 
521 #define IMAGE_ARCHIVE_START_SIZE             8
522 #define IMAGE_ARCHIVE_START                  "!<arch>\n"
523 #define IMAGE_ARCHIVE_END                    "`\n"
524 #define IMAGE_ARCHIVE_PAD                    "\n"
525 #define IMAGE_ARCHIVE_LINKER_MEMBER          "/               "
526 #define IMAGE_ARCHIVE_LONGNAMES_MEMBER       "//              "
527 
528 typedef struct _IMAGE_ARCHIVE_MEMBER_HEADER {
529     UINT8     Name[16];                          // File member name - `/' terminated.
530     UINT8     Date[12];                          // File member date - decimal.
531     UINT8     UserID[6];                         // File member user id - decimal.
532     UINT8     GroupID[6];                        // File member group id - decimal.
533     UINT8     Mode[8];                           // File member mode - octal.
534     UINT8     Size[10];                          // File member size - decimal.
535     UINT8     EndHeader[2];                      // String to end header.
536 } IMAGE_ARCHIVE_MEMBER_HEADER, *PIMAGE_ARCHIVE_MEMBER_HEADER;
537 
538 #define IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR      60
539 
540 //
541 // DLL support.
542 //
543 
544 //
545 // Export Format
546 //
547 
548 typedef struct _IMAGE_EXPORT_DIRECTORY {
549     UINT32   Characteristics;
550     UINT32   TimeDateStamp;
551     UINT16   MajorVersion;
552     UINT16   MinorVersion;
553     UINT32   Name;
554     UINT32   Base;
555     UINT32   NumberOfFunctions;
556     UINT32   NumberOfNames;
557     UINT32   *AddressOfFunctions;
558     UINT32   *AddressOfNames;
559     UINT32   *AddressOfNameOrdinals;
560 } IMAGE_EXPORT_DIRECTORY, *PIMAGE_EXPORT_DIRECTORY;
561 
562 //
563 // Import Format
564 //
565 
566 typedef struct _IMAGE_IMPORT_BY_NAME {
567     UINT16    Hint;
568     UINT8     Name[1];
569 } IMAGE_IMPORT_BY_NAME, *PIMAGE_IMPORT_BY_NAME;
570 
571 typedef struct _IMAGE_THUNK_DATA {
572     union {
573         UINT32 Function;
574         UINT32 Ordinal;
575         PIMAGE_IMPORT_BY_NAME AddressOfData;
576     } u1;
577 } IMAGE_THUNK_DATA, *PIMAGE_THUNK_DATA;
578 
579 #define IMAGE_ORDINAL_FLAG 0x80000000
580 #define IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & IMAGE_ORDINAL_FLAG) != 0)
581 #define IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
582 
583 typedef struct _IMAGE_IMPORT_DESCRIPTOR {
584     UINT32   Characteristics;
585     UINT32   TimeDateStamp;
586     UINT32   ForwarderChain;
587     UINT32   Name;
588     PIMAGE_THUNK_DATA FirstThunk;
589 } IMAGE_IMPORT_DESCRIPTOR, *PIMAGE_IMPORT_DESCRIPTOR;
590 
591 #define IMAGE_DEBUG_TYPE_CODEVIEW   2
592 
593 typedef struct {
594   UINT32    Characteristics;
595   UINT32    TimeDateStamp;
596   UINT16    MajorVersion;
597   UINT16    MinorVersion;
598   UINT32    Type;
599   UINT32    SizeOfData;
600   UINT32    RVA;
601   UINT32    FileOffset;
602 } IMAGE_DEBUG_DIRECTORY_ENTRY;
603 
604 #define CODEVIEW_SIGNATURE_NB10  0x3031424E // "NB10"
605 
606 typedef struct {
607   UINT32    Signature; // "NB10"
608   UINT32    Unknown;
609   UINT32    Unknown2;
610   UINT32    Unknown3;
611   //
612   // Filename of .PDB goes here
613   //
614 } EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
615 
616 #define CODEVIEW_SIGNATURE_RSDS  0x53445352 // "RSDS"
617 
618 typedef struct {
619   UINT32    Signature; // "RSDS"
620   UINT32    Unknown;
621   UINT32    Unknown2;
622   UINT32    Unknown3;
623   UINT32    Unknown4;
624   UINT32    Unknown5;
625   //
626   // Filename of .PDB goes here
627   //
628 } EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
629 
630 #endif
631