Release 980301
[wine] / include / peexe.h
1 /*
2  * Copyright  Eric Youngdale (1994)
3  */
4 #ifndef __WINE_PEEXE_H
5 #define __WINE_PEEXE_H
6
7 #include "wintypes.h"
8 #include "neexe.h"
9
10 typedef struct _IMAGE_FILE_HEADER {
11         WORD    Machine;                        /* 00 */
12         WORD    NumberOfSections;               /* 02 */
13         DWORD   TimeDateStamp;                  /* 04 */
14         DWORD   PointerToSymbolTable;           /* 08 */
15         DWORD   NumberOfSymbols;                /* 0c */
16         WORD    SizeOfOptionalHeader;           /* 10 */
17         WORD    Characteristics;                /* 12 */
18 } IMAGE_FILE_HEADER,*LPIMAGE_FILE_HEADER;
19
20 #define IMAGE_SIZEOF_FILE_HEADER        20
21
22 /* These defines describe the meanings of the bits in the Characteristics
23    field */
24
25 #define IMAGE_FILE_RELOCS_STRIPPED      1 /* No relocation info */
26 #define IMAGE_FILE_EXECUTABLE_IMAGE     2
27 #define IMAGE_FILE_LINE_NUMS_STRIPPED   4
28 #define IMAGE_FILE_LOCAL_SYMS_STRIPPED  8
29 #define IMAGE_FILE_16BIT_MACHINE        0x40
30 #define IMAGE_FILE_BYTES_REVERSED_LO    0x80
31 #define IMAGE_FILE_32BIT_MACHINE        0x100
32 #define IMAGE_FILE_DEBUG_STRIPPED       0x200
33 #define IMAGE_FILE_SYSTEM               0x1000
34 #define IMAGE_FILE_DLL                  0x2000
35 #define IMAGE_FILE_BYTES_REVERSED_HI    0x8000
36
37 /* These are the settings of the Machine field. */
38 #define IMAGE_FILE_MACHINE_UNKNOWN      0
39 #define IMAGE_FILE_MACHINE_I860         0x14d
40 #define IMAGE_FILE_MACHINE_I386         0x14c
41 #define IMAGE_FILE_MACHINE_R3000        0x162
42 #define IMAGE_FILE_MACHINE_R4000        0x166
43 #define IMAGE_FILE_MACHINE_R10000       0x168
44 #define IMAGE_FILE_MACHINE_ALPHA        0x184
45 #define IMAGE_FILE_MACHINE_POWERPC      0x1F0  
46
47 typedef struct _IMAGE_DATA_DIRECTORY
48 {
49         DWORD   VirtualAddress;
50         DWORD   Size;
51 } IMAGE_DATA_DIRECTORY,*LPIMAGE_DATA_DIRECTORY;
52
53 #define IMAGE_NUMBEROF_DIRECTORY_ENTRIES 16
54
55 /* Optional coff header - used by NT to provide additional information. */
56 typedef struct _IMAGE_OPTIONAL_HEADER
57 {
58         /*
59          * Standard fields.
60          */
61
62         WORD    Magic;
63         BYTE    MajorLinkerVersion;
64         BYTE    MinorLinkerVersion;
65         DWORD   SizeOfCode;
66         DWORD   SizeOfInitializedData;
67         DWORD   SizeOfUninitializedData;
68         DWORD   AddressOfEntryPoint;
69         DWORD   BaseOfCode;
70         DWORD   BaseOfData;
71
72         /*
73          * NT additional fields.
74          */
75
76         DWORD   ImageBase;
77         DWORD   SectionAlignment;
78         DWORD   FileAlignment;
79         WORD    MajorOperatingSystemVersion;
80         WORD    MinorOperatingSystemVersion;
81         WORD    MajorImageVersion;
82         WORD    MinorImageVersion;
83         WORD    MajorSubsystemVersion;
84         WORD    MinorSubsystemVersion;
85         DWORD   Reserved1;
86         DWORD   SizeOfImage;
87         DWORD   SizeOfHeaders;
88         DWORD   CheckSum;
89         WORD    Subsystem;
90         WORD    DllCharacteristics;
91         DWORD   SizeOfStackReserve;
92         DWORD   SizeOfStackCommit;
93         DWORD   SizeOfHeapReserve;
94         DWORD   SizeOfHeapCommit;
95         DWORD   LoaderFlags;
96         DWORD   NumberOfRvaAndSizes;
97         IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];
98 } IMAGE_OPTIONAL_HEADER,*LPIMAGE_OPTIONAL_HEADER;
99
100 /* Possible Magic values */
101 #define IMAGE_NT_OPTIONAL_HDR_MAGIC        0x10b
102 #define IMAGE_ROM_OPTIONAL_HDR_MAGIC       0x107
103
104 /* These are indexes into the DataDirectory array */
105 #define IMAGE_FILE_EXPORT_DIRECTORY             0
106 #define IMAGE_FILE_IMPORT_DIRECTORY             1
107 #define IMAGE_FILE_RESOURCE_DIRECTORY           2
108 #define IMAGE_FILE_EXCEPTION_DIRECTORY          3
109 #define IMAGE_FILE_SECURITY_DIRECTORY           4
110 #define IMAGE_FILE_BASE_RELOCATION_TABLE        5
111 #define IMAGE_FILE_DEBUG_DIRECTORY              6
112 #define IMAGE_FILE_DESCRIPTION_STRING           7
113 #define IMAGE_FILE_MACHINE_VALUE                8  /* Mips */
114 #define IMAGE_FILE_THREAD_LOCAL_STORAGE         9
115 #define IMAGE_FILE_CALLBACK_DIRECTORY           10
116
117 /* Directory Entries, indices into the DataDirectory array */
118
119 #define IMAGE_DIRECTORY_ENTRY_EXPORT            0
120 #define IMAGE_DIRECTORY_ENTRY_IMPORT            1
121 #define IMAGE_DIRECTORY_ENTRY_RESOURCE          2
122 #define IMAGE_DIRECTORY_ENTRY_EXCEPTION         3
123 #define IMAGE_DIRECTORY_ENTRY_SECURITY          4
124 #define IMAGE_DIRECTORY_ENTRY_BASERELOC         5
125 #define IMAGE_DIRECTORY_ENTRY_DEBUG             6
126 #define IMAGE_DIRECTORY_ENTRY_COPYRIGHT         7
127 #define IMAGE_DIRECTORY_ENTRY_GLOBALPTR         8   /* (MIPS GP) */
128 #define IMAGE_DIRECTORY_ENTRY_TLS               9
129 #define IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG       10
130 #define IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT      11
131 #define IMAGE_DIRECTORY_ENTRY_IAT               12  /* Import Address Table */
132
133 /* Subsystem Values */
134
135 #define IMAGE_SUBSYSTEM_UNKNOWN         0
136 #define IMAGE_SUBSYSTEM_NATIVE          1
137 #define IMAGE_SUBSYSTEM_WINDOWS_GUI     2       /* Windows GUI subsystem */
138 #define IMAGE_SUBSYSTEM_WINDOWS_CUI     3       /* Windows character subsystem*/
139 #define IMAGE_SUBSYSTEM_OS2_CUI         5
140 #define IMAGE_SUBSYSTEM_POSIX_CUI       7
141
142 typedef struct _IMAGE_NT_HEADERS {
143         DWORD                   Signature;
144         IMAGE_FILE_HEADER       FileHeader;
145         IMAGE_OPTIONAL_HEADER   OptionalHeader;
146 } IMAGE_NT_HEADERS,*LPIMAGE_NT_HEADERS;
147
148
149 #define PE_HEADER(module) \
150     ((IMAGE_NT_HEADERS*)((LPBYTE)(module) + \
151                          (((IMAGE_DOS_HEADER*)(module))->e_lfanew)))
152
153 #define PE_SECTIONS(module) \
154     ((IMAGE_SECTION_HEADER*)((LPBYTE)&PE_HEADER(module)->OptionalHeader + \
155                            PE_HEADER(module)->FileHeader.SizeOfOptionalHeader))
156
157 #define RVA_PTR(module,field) ((LPBYTE)(module) + PE_HEADER(module)->field)
158
159 /* Section header format */
160
161 #define IMAGE_SIZEOF_SHORT_NAME 8
162
163 typedef struct _IMAGE_SECTION_HEADER {
164         BYTE    Name[IMAGE_SIZEOF_SHORT_NAME];
165         union {
166                 DWORD   PhysicalAddress;
167                 DWORD   VirtualSize;
168         } Misc;
169         DWORD   VirtualAddress;
170         DWORD   SizeOfRawData;
171         DWORD   PointerToRawData;
172         DWORD   PointerToRelocations;
173         DWORD   PointerToLinenumbers;
174         WORD    NumberOfRelocations;
175         WORD    NumberOfLinenumbers;
176         DWORD   Characteristics;
177 } IMAGE_SECTION_HEADER,*LPIMAGE_SECTION_HEADER;
178
179 #define IMAGE_SIZEOF_SECTION_HEADER 40
180
181 /* These defines are for the Characteristics bitfield. */
182 /* #define IMAGE_SCN_TYPE_REG                   0x00000000 - Reserved */
183 /* #define IMAGE_SCN_TYPE_DSECT                 0x00000001 - Reserved */
184 /* #define IMAGE_SCN_TYPE_NOLOAD                0x00000002 - Reserved */
185 /* #define IMAGE_SCN_TYPE_GROUP                 0x00000004 - Reserved */
186 /* #define IMAGE_SCN_TYPE_NO_PAD                0x00000008 - Reserved */
187 /* #define IMAGE_SCN_TYPE_COPY                  0x00000010 - Reserved */
188
189 #define IMAGE_SCN_CNT_CODE                      0x00000020
190 #define IMAGE_SCN_CNT_INITIALIZED_DATA          0x00000040
191 #define IMAGE_SCN_CNT_UNINITIALIZED_DATA        0x00000080
192
193 #define IMAGE_SCN_LNK_OTHER                     0x00000100 
194 #define IMAGE_SCN_LNK_INFO                      0x00000200  
195 /* #define      IMAGE_SCN_TYPE_OVER             0x00000400 - Reserved */
196 #define IMAGE_SCN_LNK_REMOVE                    0x00000800
197 #define IMAGE_SCN_LNK_COMDAT                    0x00001000
198
199 /*                                              0x00002000 - Reserved */
200 /* #define IMAGE_SCN_MEM_PROTECTED              0x00004000 - Obsolete */
201 #define IMAGE_SCN_MEM_FARDATA                   0x00008000
202
203 /* #define IMAGE_SCN_MEM_SYSHEAP                0x00010000 - Obsolete */
204 #define IMAGE_SCN_MEM_PURGEABLE                 0x00020000
205 #define IMAGE_SCN_MEM_16BIT                     0x00020000
206 #define IMAGE_SCN_MEM_LOCKED                    0x00040000
207 #define IMAGE_SCN_MEM_PRELOAD                   0x00080000
208
209 #define IMAGE_SCN_ALIGN_1BYTES                  0x00100000
210 #define IMAGE_SCN_ALIGN_2BYTES                  0x00200000
211 #define IMAGE_SCN_ALIGN_4BYTES                  0x00300000
212 #define IMAGE_SCN_ALIGN_8BYTES                  0x00400000
213 #define IMAGE_SCN_ALIGN_16BYTES                 0x00500000  /* Default */
214 #define IMAGE_SCN_ALIGN_32BYTES                 0x00600000
215 #define IMAGE_SCN_ALIGN_64BYTES                 0x00700000
216 /*                                              0x00800000 - Unused */
217
218 #define IMAGE_SCN_LNK_NRELOC_OVFL               0x01000000
219
220
221 #define IMAGE_SCN_MEM_DISCARDABLE               0x02000000
222 #define IMAGE_SCN_MEM_NOT_CACHED                0x04000000
223 #define IMAGE_SCN_MEM_NOT_PAGED                 0x08000000
224 #define IMAGE_SCN_MEM_SHARED                    0x10000000
225 #define IMAGE_SCN_MEM_EXECUTE                   0x20000000
226 #define IMAGE_SCN_MEM_READ                      0x40000000
227 #define IMAGE_SCN_MEM_WRITE                     0x80000000
228
229
230 /* Import name entry */
231 typedef struct _IMAGE_IMPORT_BY_NAME {
232         WORD    Hint;
233         BYTE    Name[1];
234 } IMAGE_IMPORT_BY_NAME,*LPIMAGE_IMPORT_BY_NAME;
235
236 /* Import thunk */
237 typedef struct _IMAGE_THUNK_DATA {
238         union {
239                 LPBYTE  ForwarderString;
240                 LPDWORD Function;
241                 DWORD   Ordinal;
242                 LPIMAGE_IMPORT_BY_NAME  AddressOfData;
243         } u1;
244 } IMAGE_THUNK_DATA,*LPIMAGE_THUNK_DATA;
245
246 /* Import module directory */
247
248 typedef struct _IMAGE_IMPORT_DESCRIPTOR {
249         union {
250                 DWORD   Characteristics; /* 0 for terminating null import descriptor  */
251                 LPIMAGE_THUNK_DATA OriginalFirstThunk;  /* RVA to original unbound IAT */
252         } u;
253         DWORD   TimeDateStamp;  /* 0 if not bound,
254                                  * -1 if bound, and real date\time stamp
255                                  *    in IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT
256                                  * (new BIND)
257                                  * otherwise date/time stamp of DLL bound to
258                                  * (Old BIND)
259                                  */
260         DWORD   ForwarderChain; /* -1 if no forwarders */
261         DWORD   Name;
262         /* RVA to IAT (if bound this IAT has actual addresses) */
263         LPIMAGE_THUNK_DATA FirstThunk;  
264 } IMAGE_IMPORT_DESCRIPTOR,*LPIMAGE_IMPORT_DESCRIPTOR;
265
266 #define IMAGE_ORDINAL_FLAG              0x80000000
267 #define IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & IMAGE_ORDINAL_FLAG) != 0)
268 #define IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)
269
270 /* Export module directory */
271
272 typedef struct _IMAGE_EXPORT_DIRECTORY {
273         DWORD   Characteristics;
274         DWORD   TimeDateStamp;
275         WORD    MajorVersion;
276         WORD    MinorVersion;
277         DWORD   Name;
278         DWORD   Base;
279         DWORD   NumberOfFunctions;
280         DWORD   NumberOfNames;
281         LPDWORD *AddressOfFunctions;
282         LPDWORD *AddressOfNames;
283         LPWORD  *AddressOfNameOrdinals;
284 /*  u_char ModuleName[1]; */
285 } IMAGE_EXPORT_DIRECTORY,*LPIMAGE_EXPORT_DIRECTORY;
286
287
288 /*
289  * Resource directory stuff
290  */
291 typedef struct _IMAGE_RESOURCE_DIRECTORY {
292         DWORD   Characteristics;
293         DWORD   TimeDateStamp;
294         WORD    MajorVersion;
295         WORD    MinorVersion;
296         WORD    NumberOfNamedEntries;
297         WORD    NumberOfIdEntries;
298         /*  IMAGE_RESOURCE_DIRECTORY_ENTRY DirectoryEntries[]; */
299 } IMAGE_RESOURCE_DIRECTORY,*LPIMAGE_RESOURCE_DIRECTORY;
300
301 #define IMAGE_RESOURCE_NAME_IS_STRING           0x80000000
302 #define IMAGE_RESOURCE_DATA_IS_DIRECTORY        0x80000000
303
304 typedef struct _IMAGE_RESOURCE_DIRECTORY_ENTRY {
305         union {
306                 struct {
307                         DWORD NameOffset:31;
308                         DWORD NameIsString:1;
309                 } s;
310                 DWORD   Name;
311                 WORD    Id;
312         } u1;
313         union {
314                 DWORD   OffsetToData;
315                 struct {
316                         DWORD   OffsetToDirectory:31;
317                         DWORD   DataIsDirectory:1;
318                 } s;
319         } u2;
320 } IMAGE_RESOURCE_DIRECTORY_ENTRY,*LPIMAGE_RESOURCE_DIRECTORY_ENTRY;
321
322
323 typedef struct _IMAGE_RESOURCE_DIRECTORY_STRING {
324         WORD    Length;
325         CHAR    NameString[ 1 ];
326 } IMAGE_RESOURCE_DIRECTORY_STRING,*LPIMAGE_RESOURCE_DIRECTORY_STRING;
327
328 typedef struct _IMAGE_RESOURCE_DIR_STRING_U {
329         WORD    Length;
330         WCHAR   NameString[ 1 ];
331 } IMAGE_RESOURCE_DIR_STRING_U,*LPIMAGE_RESOURCE_DIR_STRING_U;
332
333 typedef struct _IMAGE_RESOURCE_DATA_ENTRY {
334         DWORD   OffsetToData;
335         DWORD   Size;
336         DWORD   CodePage;
337         DWORD   ResourceHandle;
338 } IMAGE_RESOURCE_DATA_ENTRY,*LPIMAGE_RESOURCE_DATA_ENTRY;
339
340 typedef struct _IMAGE_BASE_RELOCATION
341 {
342         DWORD   VirtualAddress;
343         DWORD   SizeOfBlock;
344         WORD    TypeOffset[1];
345 } IMAGE_BASE_RELOCATION,*LPIMAGE_BASE_RELOCATION;
346
347 typedef struct _IMAGE_LOAD_CONFIG_DIRECTORY {
348         DWORD   Characteristics;
349         DWORD   TimeDateStamp;
350         WORD    MajorVersion;
351         WORD    MinorVersion;
352         DWORD   GlobalFlagsClear;
353         DWORD   GlobalFlagsSet;
354         DWORD   CriticalSectionDefaultTimeout;
355         DWORD   DeCommitFreeBlockThreshold;
356         DWORD   DeCommitTotalFreeThreshold;
357         LPVOID  LockPrefixTable;
358         DWORD   MaximumAllocationSize;
359         DWORD   VirtualMemoryThreshold;
360         DWORD   ProcessHeapFlags;
361         DWORD   Reserved[ 4 ];
362 } IMAGE_LOAD_CONFIG_DIRECTORY,*LPIMAGE_LOAD_CONFIG_DIRECTORY;
363
364 typedef VOID (CALLBACK *LPIMAGE_TLS_CALLBACK)(
365         LPVOID DllHandle,DWORD Reason,LPVOID Reserved
366 );
367
368 typedef struct _IMAGE_TLS_DIRECTORY {
369         DWORD   StartAddressOfRawData;
370         DWORD   EndAddressOfRawData;
371         LPDWORD AddressOfIndex;
372         LPIMAGE_TLS_CALLBACK *AddressOfCallBacks;
373         DWORD   SizeOfZeroFill;
374         DWORD   Characteristics;
375 } IMAGE_TLS_DIRECTORY,*LPIMAGE_TLS_DIRECTORY;
376
377 /*
378  * The IMAGE_DEBUG_DIRECTORY data directory points to an array of
379  * these structures.
380  */
381 typedef struct _IMAGE_DEBUG_DIRECTORY {
382         DWORD   Characteristics;
383         DWORD   TimeDateStamp;
384         WORD    MajorVersion;
385         WORD    MinorVersion;
386         DWORD   Type;
387         DWORD   SizeOfData;
388         DWORD   AddressOfRawData;
389         DWORD   PointerToRawData;
390 } IMAGE_DEBUG_DIRECTORY,*LPIMAGE_DEBUG_DIRECTORY;
391
392 /*
393  * The type field above can take these (plus a few other
394  * irrelevant) values.
395  */
396 #define IMAGE_DEBUG_TYPE_UNKNOWN        0
397 #define IMAGE_DEBUG_TYPE_COFF           1
398 #define IMAGE_DEBUG_TYPE_CODEVIEW       2
399 #define IMAGE_DEBUG_TYPE_FPO            3
400 #define IMAGE_DEBUG_TYPE_MISC           4
401 #define IMAGE_DEBUG_TYPE_EXCEPTION      5
402 #define IMAGE_DEBUG_TYPE_FIXUP          6
403 #define IMAGE_DEBUG_TYPE_OMAP_TO_SRC    7
404 #define IMAGE_DEBUG_TYPE_OMAP_FROM_SRC  8
405
406
407 #define IMAGE_REL_BASED_ABSOLUTE                0
408 #define IMAGE_REL_BASED_HIGH                    1
409 #define IMAGE_REL_BASED_LOW                     2
410 #define IMAGE_REL_BASED_HIGHLOW                 3
411 #define IMAGE_REL_BASED_HIGHADJ                 4
412 #define IMAGE_REL_BASED_MIPS_JMPADDR            5
413
414 /*
415  * This is the structure that appears at the very start of a .DBG file.
416  */
417 typedef struct _IMAGE_SEPARATE_DEBUG_HEADER {
418         WORD    Signature;
419         WORD    Flags;
420         WORD    Machine;
421         WORD    Characteristics;
422         DWORD   TimeDateStamp;
423         DWORD   CheckSum;
424         DWORD   ImageBase;
425         DWORD   SizeOfImage;
426         DWORD   NumberOfSections;
427         DWORD   ExportedNamesSize;
428         DWORD   DebugDirectorySize;
429         DWORD   Reserved[ 3 ];
430 } IMAGE_SEPARATE_DEBUG_HEADER,*LPIMAGE_SEPARATE_DEBUG_HEADER;
431
432 #define IMAGE_SEPARATE_DEBUG_SIGNATURE 0x4944
433
434 #endif /* __WINE_PEEXE_H */