3 * Bill Paul <wpaul@windriver.com>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Bill Paul.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
32 * $FreeBSD: src/sys/compat/ndis/pe_var.h,v 1.15 2009/03/07 07:26:22 weongyo Exp $
38 #include <machine/types.h> /* XXX for vm_offset_t */
44 #define IMAGE_DOS_SIGNATURE 0x5A4D /* MZ */
45 #define IMAGE_OS2_SIGNATURE 0x454E /* NE */
46 #define IMAGE_OS2_SIGNATURE_LE 0x454C /* LE */
47 #define IMAGE_VXD_SIGNATURE 0x454C /* LE */
48 #define IMAGE_NT_SIGNATURE 0x00004550 /* PE00 */
51 * All PE files have one of these, just so if you attempt to
52 * run them, they'll print out a message telling you they can
53 * only be run in Windows.
56 struct image_dos_header {
57 uint16_t idh_magic; /* Magic number */
58 uint16_t idh_cblp; /* Bytes on last page of file */
59 uint16_t idh_cp; /* Pages in file */
60 uint16_t idh_crlc; /* Relocations */
61 uint16_t idh_cparhdr; /* Size of header in paragraphs */
62 uint16_t idh_minalloc; /* Minimum extra paragraphs needed */
63 uint16_t idh_maxalloc; /* Maximum extra paragraphs needed */
64 uint16_t idh_ss; /* Initial (relative) SS value */
65 uint16_t idh_sp; /* Initial SP value */
66 uint16_t idh_csum; /* Checksum */
67 uint16_t idh_ip; /* Initial IP value */
68 uint16_t idh_cs; /* Initial (relative) CS value */
69 uint16_t idh_lfarlc; /* File address of relocation table */
70 uint16_t idh_ovno; /* Overlay number */
71 uint16_t idh_rsvd1[4]; /* Reserved words */
72 uint16_t idh_oemid; /* OEM identifier (for idh_oeminfo) */
73 uint16_t idh_oeminfo; /* OEM information; oemid specific */
74 uint16_t idh_rsvd2[10]; /* Reserved words */
75 uint32_t idh_lfanew; /* File address of new exe header */
78 typedef struct image_dos_header image_dos_header;
84 struct image_file_header {
85 uint16_t ifh_machine; /* Machine type */
86 uint16_t ifh_numsections; /* # of sections */
87 uint32_t ifh_timestamp; /* Date/time stamp */
88 uint32_t ifh_symtblptr; /* Offset to symbol table */
89 uint32_t ifh_numsyms; /* # of symbols */
90 uint16_t ifh_optionalhdrlen; /* Size of optional header */
91 uint16_t ifh_characteristics; /* Characteristics */
94 typedef struct image_file_header image_file_header;
98 #define IMAGE_FILE_MACHINE_UNKNOWN 0
99 #define IMAGE_FILE_MACHINE_I860 0x014d
100 #define IMAGE_FILE_MACHINE_I386 0x014c
101 #define IMAGE_FILE_MACHINE_R3000 0x0162
102 #define IMAGE_FILE_MACHINE_R4000 0x0166
103 #define IMAGE_FILE_MACHINE_R10000 0x0168
104 #define IMAGE_FILE_MACHINE_WCEMIPSV2 0x0169
105 #define IMAGE_FILE_MACHINE_ALPHA 0x0184
106 #define IMAGE_FILE_MACHINE_SH3 0x01a2
107 #define IMAGE_FILE_MACHINE_SH3DSP 0x01a3
108 #define IMAGE_FILE_MACHINE_SH3E 0x01a4
109 #define IMAGE_FILE_MACHINE_SH4 0x01a6
110 #define IMAGE_FILE_MACHINE_SH5 0x01a8
111 #define IMAGE_FILE_MACHINE_ARM 0x01c0
112 #define IMAGE_FILE_MACHINE_THUMB 0x01c2
113 #define IMAGE_FILE_MACHINE_AM33 0x01d3
114 #define IMAGE_FILE_MACHINE_POWERPC 0x01f0
115 #define IMAGE_FILE_MACHINE_POWERPCFP 0x01f1
116 #define IMAGE_FILE_MACHINE_IA64 0x0200
117 #define IMAGE_FILE_MACHINE_MIPS16 0x0266
118 #define IMAGE_FILE_MACHINE_ALPHA64 0x0284
119 #define IMAGE_FILE_MACHINE_MIPSFPU 0x0366
120 #define IMAGE_FILE_MACHINE_MIPSFPU16 0x0466
121 #define IMAGE_FILE_MACHINE_AXP64 IMAGE_FILE_MACHINE_ALPHA64
122 #define IMAGE_FILE_MACHINE_TRICORE 0x0520
123 #define IMAGE_FILE_MACHINE_CEF 0x0cef
124 #define IMAGE_FILE_MACHINE_EBC 0x0ebc
125 #define IMAGE_FILE_MACHINE_AMD64 0x8664
126 #define IMAGE_FILE_MACHINE_M32R 0x9041
127 #define IMAGE_FILE_MACHINE_CEE 0xc0ee
129 /* Characteristics */
131 #define IMAGE_FILE_RELOCS_STRIPPED 0x0001 /* No relocation info */
132 #define IMAGE_FILE_EXECUTABLE_IMAGE 0x0002
133 #define IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004
134 #define IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008
135 #define IMAGE_FILE_AGGRESIVE_WS_TRIM 0x0010
136 #define IMAGE_FILE_LARGE_ADDRESS_AWARE 0x0020
137 #define IMAGE_FILE_16BIT_MACHINE 0x0040
138 #define IMAGE_FILE_BYTES_REVERSED_LO 0x0080
139 #define IMAGE_FILE_32BIT_MACHINE 0x0100
140 #define IMAGE_FILE_DEBUG_STRIPPED 0x0200
141 #define IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP 0x0400
142 #define IMAGE_FILE_NET_RUN_FROM_SWAP 0x0800
143 #define IMAGE_FILE_SYSTEM 0x1000
144 #define IMAGE_FILE_DLL 0x2000
145 #define IMAGE_FILE_UP_SYSTEM_ONLY 0x4000
146 #define IMAGE_FILE_BYTES_REVERSED_HI 0x8000
148 #define IMAGE_SIZEOF_FILE_HEADER 20
154 struct image_data_directory {
155 uint32_t idd_vaddr; /* virtual address */
156 uint32_t idd_size; /* size */
159 typedef struct image_data_directory image_data_directory;
161 #define IMAGE_DIRECTORY_ENTRIES_MAX 16
164 * Optional header format.
167 struct image_optional_header {
169 /* Standard fields */
172 uint8_t ioh_linkerver_major;
173 uint8_t ioh_linkerver_minor;
174 uint32_t ioh_codesize;
175 uint32_t ioh_datasize;
176 uint32_t ioh_bsssize;
177 uint32_t ioh_entryaddr;
178 uint32_t ioh_codebaseaddr;
180 uint32_t ioh_databaseaddr;
183 /* NT-specific fields */
185 uintptr_t ioh_imagebase;
186 uint32_t ioh_sectalign;
187 uint32_t ioh_filealign;
188 uint16_t ioh_osver_major;
189 uint16_t ioh_osver_minor;
190 uint16_t ioh_imagever_major;
191 uint16_t ioh_imagever_minor;
192 uint16_t ioh_subsys_major;
193 uint16_t ioh_subsys_minor;
194 uint32_t ioh_win32ver;
195 uint32_t ioh_imagesize;
196 uint32_t ioh_headersize;
199 uint16_t ioh_dll_characteristics;
200 uintptr_t ioh_stackreservesize;
201 uintptr_t ioh_stackcommitsize;
202 uintptr_t ioh_heapreservesize;
203 uintptr_t ioh_heapcommitsize;
204 uint16_t ioh_loaderflags;
205 uint32_t ioh_rva_size_cnt;
206 image_data_directory ioh_datadir[IMAGE_DIRECTORY_ENTRIES_MAX];
209 typedef struct image_optional_header image_optional_header;
211 struct image_nt_header {
212 uint32_t inh_signature;
213 image_file_header inh_filehdr;
214 image_optional_header inh_optionalhdr;
217 typedef struct image_nt_header image_nt_header;
219 #define IMAGE_SIZEOF_NT_HEADER(nthdr) \
220 (offsetof(image_nt_header, inh_optionalhdr) + \
221 ((image_nt_header *)(nthdr))->inh_filehdr.ifh_optionalhdrlen)
223 /* Directory Entries */
225 #define IMAGE_DIRECTORY_ENTRY_EXPORT 0 /* Export Directory */
226 #define IMAGE_DIRECTORY_ENTRY_IMPORT 1 /* Import Directory */
227 #define IMAGE_DIRECTORY_ENTRY_RESOURCE 2 /* Resource Directory */
228 #define IMAGE_DIRECTORY_ENTRY_EXCEPTION 3 /* Exception Directory */
229 #define IMAGE_DIRECTORY_ENTRY_SECURITY 4 /* Security Directory */
230 #define IMAGE_DIRECTORY_ENTRY_BASERELOC 5 /* Base Relocation Table */
231 #define IMAGE_DIRECTORY_ENTRY_DEBUG 6 /* Debug Directory */
232 #define IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7 /* Description String */
233 #define IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8 /* Machine Value (MIPS GP) */
234 #define IMAGE_DIRECTORY_ENTRY_TLS 9 /* TLS Directory */
235 #define IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10 /* Load Configuration Directory */
236 #define IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT 11 /* Bound Import Directory in headers */
237 #define IMAGE_DIRECTORY_ENTRY_IAT 12 /* Import Address Table */
238 #define IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT 13
239 #define IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR 14
251 #define RT_ACCELERATOR 9
253 #define RT_MESSAGETABLE 11
254 #define RT_GROUP_CURSOR 12
255 #define RT_GROUP_ICON 14
256 #define RT_VERSION 16
257 #define RT_DLGINCLUDE 17
258 #define RT_PLUGPLAY 19
260 #define RT_ANICURSOR 21
261 #define RT_ANIICON 22
265 * Section header format.
268 #define IMAGE_SHORT_NAME_LEN 8
270 struct image_section_header {
271 uint8_t ish_name[IMAGE_SHORT_NAME_LEN];
277 uint32_t ish_rawdatasize;
278 uint32_t ish_rawdataaddr;
279 uint32_t ish_relocaddr;
280 uint32_t ish_linenumaddr;
281 uint16_t ish_numrelocs;
282 uint16_t ish_numlinenums;
283 uint32_t ish_characteristics;
286 typedef struct image_section_header image_section_header;
288 #define IMAGE_SIZEOF_SECTION_HEADER 40
290 #define IMAGE_FIRST_SECTION(nthdr) \
291 ((image_section_header *)((vm_offset_t)(nthdr) + \
292 offsetof(image_nt_header, inh_optionalhdr) + \
293 ((image_nt_header *)(nthdr))->inh_filehdr.ifh_optionalhdrlen))
299 struct image_import_by_name {
301 uint8_t iibn_name[1];
304 #define IMAGE_ORDINAL_FLAG 0x80000000
305 #define IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
307 struct image_import_descriptor {
308 uint32_t iid_import_name_table_addr;
309 uint32_t iid_timestamp;
310 uint32_t iid_forwardchain;
311 uint32_t iid_nameaddr;
312 uint32_t iid_import_address_table_addr;
315 typedef struct image_import_descriptor image_import_descriptor;
317 struct image_base_reloc {
319 uint32_t ibr_blocksize;
323 typedef struct image_base_reloc image_base_reloc;
325 #define IMR_RELTYPE(x) ((x >> 12) & 0xF)
326 #define IMR_RELOFFSET(x) (x & 0xFFF)
328 /* generic relocation types */
329 #define IMAGE_REL_BASED_ABSOLUTE 0
330 #define IMAGE_REL_BASED_HIGH 1
331 #define IMAGE_REL_BASED_LOW 2
332 #define IMAGE_REL_BASED_HIGHLOW 3
333 #define IMAGE_REL_BASED_HIGHADJ 4
334 #define IMAGE_REL_BASED_MIPS_JMPADDR 5
335 #define IMAGE_REL_BASED_SECTION 6
336 #define IMAGE_REL_BASED_REL 7
337 #define IMAGE_REL_BASED_MIPS_JMPADDR16 9
338 #define IMAGE_REL_BASED_IA64_IMM64 9 /* yes, 9 too */
339 #define IMAGE_REL_BASED_DIR64 10
340 #define IMAGE_REL_BASED_HIGH3ADJ 11
342 struct image_resource_directory_entry {
344 uint32_t irde_dataoff;
347 typedef struct image_resource_directory_entry image_resource_directory_entry;
349 #define RESOURCE_NAME_STR 0x80000000
350 #define RESOURCE_DIR_FLAG 0x80000000
352 struct image_resource_directory {
353 uint32_t ird_characteristics;
354 uint32_t ird_timestamp;
355 uint16_t ird_majorver;
356 uint16_t ird_minorver;
357 uint16_t ird_named_entries;
358 uint16_t ird_id_entries;
360 image_resource_directory_entry ird_entries[1];
364 typedef struct image_resource_directory image_resource_directory;
366 struct image_resource_directory_string {
371 typedef struct image_resource_directory_string image_resource_directory_string;
373 struct image_resource_directory_string_u {
378 typedef struct image_resource_directory_string_u
379 image_resource_directory_string_u;
381 struct image_resource_data_entry {
382 uint32_t irde_offset;
384 uint32_t irde_codepage;
388 typedef struct image_resource_data_entry image_resource_data_entry;
390 struct message_resource_data {
391 uint32_t mrd_numblocks;
393 message_resource_block mrd_blocks[1];
397 typedef struct message_resource_data message_resource_data;
399 struct message_resource_block {
402 uint32_t mrb_entryoff;
405 typedef struct message_resource_block message_resource_block;
407 struct message_resource_entry {
413 typedef struct message_resource_entry message_resource_entry;
415 #define MESSAGE_RESOURCE_UNICODE 0x0001
417 struct image_patch_table {
419 void (*ipt_func)(void);
420 void (*ipt_wrap)(void);
425 typedef struct image_patch_table image_patch_table;
428 * AMD64 support. Microsoft uses a different calling convention
429 * than everyone else on the amd64 platform. Sadly, gcc has no
430 * built-in support for it (yet).
432 * The three major differences we're concerned with are:
434 * - The first 4 register-sized arguments are passed in the
435 * %rcx, %rdx, %r8 and %r9 registers, and the rest are pushed
436 * onto the stack. (The ELF ABI uses 6 registers, not 4).
438 * - The caller must reserve space on the stack for the 4
439 * register arguments in case the callee has to spill them.
441 * - The stack myst be 16-byte aligned by the time the callee
442 * executes. A call instruction implicitly pushes an 8 byte
443 * return address onto the stack. We have to make sure that
444 * the amount of space we consume, plus the return address,
445 * is a multiple of 16 bytes in size. This means that in
446 * some cases, we may need to chew up an extra 8 bytes on
447 * the stack that will be unused.
449 * On the bright side, Microsoft seems to be using just the one
450 * calling convention for all functions on amd64, unlike x86 where
451 * they use a mix of _stdcall, _fastcall and _cdecl.
456 extern uint64_t x86_64_call1(void *, uint64_t);
457 extern uint64_t x86_64_call2(void *, uint64_t, uint64_t);
458 extern uint64_t x86_64_call3(void *, uint64_t, uint64_t, uint64_t);
459 extern uint64_t x86_64_call4(void *, uint64_t, uint64_t, uint64_t, uint64_t);
460 extern uint64_t x86_64_call5(void *, uint64_t, uint64_t, uint64_t, uint64_t,
462 extern uint64_t x86_64_call6(void *, uint64_t, uint64_t, uint64_t, uint64_t,
466 #define MSCALL1(fn, a) \
467 x86_64_call1((fn), (uint64_t)(a))
468 #define MSCALL2(fn, a, b) \
469 x86_64_call2((fn), (uint64_t)(a), (uint64_t)(b))
470 #define MSCALL3(fn, a, b, c) \
471 x86_64_call3((fn), (uint64_t)(a), (uint64_t)(b), \
473 #define MSCALL4(fn, a, b, c, d) \
474 x86_64_call4((fn), (uint64_t)(a), (uint64_t)(b), \
475 (uint64_t)(c), (uint64_t)(d))
476 #define MSCALL5(fn, a, b, c, d, e) \
477 x86_64_call5((fn), (uint64_t)(a), (uint64_t)(b), \
478 (uint64_t)(c), (uint64_t)(d), (uint64_t)(e))
479 #define MSCALL6(fn, a, b, c, d, e, f) \
480 x86_64_call6((fn), (uint64_t)(a), (uint64_t)(b), \
481 (uint64_t)(c), (uint64_t)(d), (uint64_t)(e), (uint64_t)(f))
483 #endif /* __x86_64__ */
485 #define FUNC void(*)(void)
488 #define IMPORT_SFUNC(x, y) { #x, (FUNC)x, NULL, y, WINDRV_WRAP_AMD64 }
489 #define IMPORT_SFUNC_MAP(x, y, z) \
490 { #x, (FUNC)y, NULL, z, WINDRV_WRAP_AMD64 }
491 #define IMPORT_FFUNC(x, y) { #x, (FUNC)x, NULL, y, WINDRV_WRAP_AMD64 }
492 #define IMPORT_FFUNC_MAP(x, y, z) \
493 { #x, (FUNC)y, NULL, z, WINDRV_WRAP_AMD64 }
494 #define IMPORT_RFUNC(x, y) { #x, (FUNC)x, NULL, y, WINDRV_WRAP_AMD64 }
495 #define IMPORT_RFUNC_MAP(x, y, z) \
496 { #x, (FUNC)y, NULL, z, WINDRV_WRAP_AMD64 }
497 #define IMPORT_CFUNC(x, y) { #x, (FUNC)x, NULL, y, WINDRV_WRAP_AMD64 }
498 #define IMPORT_CFUNC_MAP(x, y, z) \
499 { #x, (FUNC)y, NULL, z, WINDRV_WRAP_AMD64 }
500 #endif /* __x86_64__ */
503 extern int pe_get_dos_header(vm_offset_t, image_dos_header *);
504 extern int pe_is_nt_image(vm_offset_t);
505 extern int pe_get_optional_header(vm_offset_t, image_optional_header *);
506 extern int pe_get_file_header(vm_offset_t, image_file_header *);
507 extern int pe_get_section_header(vm_offset_t, image_section_header *);
508 extern int pe_numsections(vm_offset_t);
509 extern vm_offset_t pe_imagebase(vm_offset_t);
510 extern vm_offset_t pe_directory_offset(vm_offset_t, uint32_t);
511 extern vm_offset_t pe_translate_addr (vm_offset_t, vm_offset_t);
512 extern int pe_get_section(vm_offset_t, image_section_header *, const char *);
513 extern int pe_relocate(vm_offset_t);
514 extern int pe_get_import_descriptor(vm_offset_t, image_import_descriptor *, char *);
515 extern int pe_patch_imports(vm_offset_t, char *, image_patch_table *);
516 extern int pe_get_messagetable(vm_offset_t, message_resource_data **);
517 extern int pe_get_message(vm_offset_t, uint32_t, char **, int *, uint16_t *);
520 #endif /* _PE_VAR_H_ */