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 * $DragonFly: src/sys/emulation/ndis/subr_pe.c,v 1.1 2004/07/29 20:51:34 dillon Exp $
33 * $FreeBSD: src/sys/compat/ndis/subr_pe.c,v 1.7 2004/01/13 22:49:45 obrien Exp $
37 * This file contains routines for relocating and dynamically linking
38 * executable object code files in the Windows(r) PE (Portable Executable)
39 * format. In Windows, anything with a .EXE, .DLL or .SYS extention is
40 * considered an executable, and all such files have some structures in
41 * common. The PE format was apparently based largely on COFF but has
42 * mutated significantly over time. We are mainly concerned with .SYS files,
43 * so this module implements only enough routines to be able to parse the
44 * headers and sections of a .SYS object file and perform the necessary
45 * relocations and jump table patching to allow us to call into it
46 * (and to have it call back to us). Note that while this module
47 * can handle fixups for imported symbols, it knows nothing about
51 #include <sys/param.h>
52 #include <sys/types.h>
53 #include <sys/errno.h>
55 #include <sys/systm.h>
66 static vm_offset_t pe_functbl_match(image_patch_table *, char *);
69 * Check for an MS-DOS executable header. All Windows binaries
70 * have a small MS-DOS executable prepended to them to print out
71 * the "This program requires Windows" message. Even .SYS files
72 * have this header, in spite of the fact that you're can't actually
77 pe_get_dos_header(imgbase, hdr)
79 image_dos_header *hdr;
83 if (imgbase == 0 || hdr == NULL)
86 signature = *(uint16_t *)imgbase;
87 if (signature != IMAGE_DOS_SIGNATURE)
90 bcopy ((char *)imgbase, (char *)hdr, sizeof(image_dos_header));
96 * Verify that this image has a Windows NT PE signature.
100 pe_is_nt_image(imgbase)
104 image_dos_header *dos_hdr;
109 signature = *(uint16_t *)imgbase;
110 if (signature == IMAGE_DOS_SIGNATURE) {
111 dos_hdr = (image_dos_header *)imgbase;
112 signature = *(uint32_t *)(imgbase + dos_hdr->idh_lfanew);
113 if (signature == IMAGE_NT_SIGNATURE)
121 * Return a copy of the optional header. This contains the
122 * executable entry point and the directory listing which we
123 * need to find the relocations and imports later.
127 pe_get_optional_header(imgbase, hdr)
129 image_optional_header *hdr;
131 image_dos_header *dos_hdr;
132 image_nt_header *nt_hdr;
134 if (imgbase == 0 || hdr == NULL)
137 if (pe_is_nt_image(imgbase))
140 dos_hdr = (image_dos_header *)(imgbase);
141 nt_hdr = (image_nt_header *)(imgbase + dos_hdr->idh_lfanew);
143 bcopy ((char *)&nt_hdr->inh_optionalhdr, (char *)hdr,
144 sizeof(image_optional_header));
150 * Return a copy of the file header. Contains the number of
151 * sections in this image.
155 pe_get_file_header(imgbase, hdr)
157 image_file_header *hdr;
159 image_dos_header *dos_hdr;
160 image_nt_header *nt_hdr;
162 if (imgbase == 0 || hdr == NULL)
165 if (pe_is_nt_image(imgbase))
168 dos_hdr = (image_dos_header *)imgbase;
169 nt_hdr = (image_nt_header *)(imgbase + dos_hdr->idh_lfanew);
171 bcopy ((char *)&nt_hdr->inh_filehdr, (char *)hdr,
172 sizeof(image_file_header));
178 * Return the header of the first section in this image (usually
183 pe_get_section_header(imgbase, hdr)
185 image_section_header *hdr;
187 image_dos_header *dos_hdr;
188 image_nt_header *nt_hdr;
189 image_section_header *sect_hdr;
191 if (imgbase == 0 || hdr == NULL)
194 if (pe_is_nt_image(imgbase))
197 dos_hdr = (image_dos_header *)imgbase;
198 nt_hdr = (image_nt_header *)(imgbase + dos_hdr->idh_lfanew);
199 sect_hdr = (image_section_header *)((vm_offset_t)nt_hdr +
200 sizeof(image_nt_header));
202 bcopy ((char *)sect_hdr, (char *)hdr, sizeof(image_section_header));
208 * Return the number of sections in this executable, or 0 on error.
212 pe_numsections(imgbase)
215 image_file_header file_hdr;
217 if (pe_get_file_header(imgbase, &file_hdr))
220 return (file_hdr.ifh_numsections);
224 * Return the base address that this image was linked for.
225 * This helps us calculate relocation addresses later.
229 pe_imagebase(imgbase)
232 image_optional_header optional_hdr;
234 if (pe_get_optional_header(imgbase, &optional_hdr))
237 return (optional_hdr.ioh_imagebase);
241 * Return the offset of a given directory structure within the
242 * image. Directories reside within sections.
246 pe_directory_offset(imgbase, diridx)
250 image_optional_header opt_hdr;
253 if (pe_get_optional_header(imgbase, &opt_hdr))
256 if (diridx >= opt_hdr.ioh_rva_size_cnt)
259 dir = opt_hdr.ioh_datadir[diridx].idd_vaddr;
261 return(pe_translate_addr(imgbase, dir));
265 pe_translate_addr(imgbase, rva)
269 image_optional_header opt_hdr;
270 image_section_header *sect_hdr;
271 image_dos_header *dos_hdr;
272 image_nt_header *nt_hdr;
273 int i = 0, sections, fixedlen;
275 if (pe_get_optional_header(imgbase, &opt_hdr))
278 sections = pe_numsections(imgbase);
280 dos_hdr = (image_dos_header *)imgbase;
281 nt_hdr = (image_nt_header *)(imgbase + dos_hdr->idh_lfanew);
282 sect_hdr = (image_section_header *)((vm_offset_t)nt_hdr +
283 sizeof(image_nt_header));
286 * The test here is to see if the RVA falls somewhere
287 * inside the section, based on the section's start RVA
288 * and its length. However it seems sometimes the
289 * virtual length isn't enough to cover the entire
290 * area of the section. We fudge by taking into account
291 * the section alignment and rounding the section length
292 * up to a page boundary.
294 while (i++ < sections) {
295 fixedlen = sect_hdr->ish_misc.ish_vsize;
296 fixedlen += ((opt_hdr.ioh_sectalign - 1) -
297 sect_hdr->ish_misc.ish_vsize) &
298 (opt_hdr.ioh_sectalign - 1);
299 if (sect_hdr->ish_vaddr <= (u_int32_t)rva &&
300 (sect_hdr->ish_vaddr + fixedlen) >
309 return((vm_offset_t)(imgbase + rva - sect_hdr->ish_vaddr +
310 sect_hdr->ish_rawdataaddr));
314 * Get the section header for a particular section. Note that
315 * section names can be anything, but there are some standard
316 * ones (.text, .data, .rdata, .reloc).
320 pe_get_section(imgbase, hdr, name)
322 image_section_header *hdr;
325 image_dos_header *dos_hdr;
326 image_nt_header *nt_hdr;
327 image_section_header *sect_hdr;
331 if (imgbase == 0 || hdr == NULL)
334 if (pe_is_nt_image(imgbase))
337 sections = pe_numsections(imgbase);
339 dos_hdr = (image_dos_header *)imgbase;
340 nt_hdr = (image_nt_header *)(imgbase + dos_hdr->idh_lfanew);
341 sect_hdr = (image_section_header *)((vm_offset_t)nt_hdr +
342 sizeof(image_nt_header));
344 for (i = 0; i < sections; i++) {
345 if (!strcmp ((char *)§_hdr->ish_name, name)) {
346 bcopy((char *)sect_hdr, (char *)hdr,
347 sizeof(image_section_header));
357 * Apply the base relocations to this image. The relocation table
358 * resides within the .reloc section. Relocations are specified in
359 * blocks which refer to a particular page. We apply the relocations
360 * one page block at a time.
367 image_section_header sect;
368 image_base_reloc *relhdr;
370 uint32_t base, delta, *lloc;
374 base = pe_imagebase(imgbase);
375 pe_get_section(imgbase, §, ".text");
376 txt = pe_translate_addr(imgbase, sect.ish_vaddr);
377 delta = (uint32_t)(txt) - base - sect.ish_vaddr;
379 pe_get_section(imgbase, §, ".reloc");
381 relhdr = (image_base_reloc *)(imgbase + sect.ish_rawdataaddr);
384 count = (relhdr->ibr_blocksize -
385 (sizeof(uint32_t) * 2)) / sizeof(uint16_t);
386 for (i = 0; i < count; i++) {
387 rel = relhdr->ibr_rel[i];
388 switch (IMR_RELTYPE(rel)) {
389 case IMAGE_REL_BASED_ABSOLUTE:
391 case IMAGE_REL_BASED_HIGHLOW:
392 lloc = (uint32_t *)pe_translate_addr(imgbase,
393 relhdr->ibr_vaddr + IMR_RELOFFSET(rel));
394 *lloc = pe_translate_addr(imgbase,
397 case IMAGE_REL_BASED_HIGH:
398 sloc = (uint16_t *)pe_translate_addr(imgbase,
399 relhdr->ibr_vaddr + IMR_RELOFFSET(rel));
400 *sloc += (delta & 0xFFFF0000) >> 16;
402 case IMAGE_REL_BASED_LOW:
403 sloc = (uint16_t *)pe_translate_addr(imgbase,
404 relhdr->ibr_vaddr + IMR_RELOFFSET(rel));
405 *sloc += (delta & 0xFFFF);
408 printf ("[%d]reloc type: %d\n",i,
413 relhdr = (image_base_reloc *)((vm_offset_t)relhdr +
414 relhdr->ibr_blocksize);
415 } while (relhdr->ibr_blocksize);
421 * Return the import descriptor for a particular module. An image
422 * may be linked against several modules, typically HAL.dll, ntoskrnl.exe
423 * and NDIS.SYS. For each module, there is a list of imported function
424 * names and their addresses.
428 pe_get_import_descriptor(imgbase, desc, module)
430 image_import_descriptor *desc;
434 image_import_descriptor *imp_desc;
437 if (imgbase == 0 || module == NULL || desc == NULL)
440 offset = pe_directory_offset(imgbase, IMAGE_DIRECTORY_ENTRY_IMPORT);
444 imp_desc = (void *)offset;
446 while (imp_desc->iid_nameaddr) {
447 modname = (char *)pe_translate_addr(imgbase,
448 imp_desc->iid_nameaddr);
449 if (!strncmp(module, modname, strlen(module))) {
450 bcopy((char *)imp_desc, (char *)desc,
451 sizeof(image_import_descriptor));
461 pe_get_messagetable(imgbase, md)
463 message_resource_data **md;
465 image_resource_directory *rdir, *rtype;
466 image_resource_directory_entry *dent, *dent2;
467 image_resource_data_entry *rent;
474 offset = pe_directory_offset(imgbase, IMAGE_DIRECTORY_ENTRY_RESOURCE);
478 rdir = (image_resource_directory *)offset;
480 dent = (image_resource_directory_entry *)(offset +
481 sizeof(image_resource_directory));
483 for (i = 0; i < rdir->ird_id_entries; i++){
484 if (dent->irde_name != RT_MESSAGETABLE) {
489 while (dent2->irde_dataoff & RESOURCE_DIR_FLAG) {
490 rtype = (image_resource_directory *)(offset +
491 (dent2->irde_dataoff & ~RESOURCE_DIR_FLAG));
492 dent2 = (image_resource_directory_entry *)
494 sizeof(image_resource_directory));
496 rent = (image_resource_data_entry *)(offset +
497 dent2->irde_dataoff);
498 *md = (message_resource_data *)pe_translate_addr(imgbase,
507 pe_get_message(imgbase, id, str, len, flags)
514 message_resource_data *md = NULL;
515 message_resource_block *mb;
516 message_resource_entry *me;
519 pe_get_messagetable(imgbase, &md);
524 mb = (message_resource_block *)((uintptr_t)md +
525 sizeof(message_resource_data));
527 for (i = 0; i < md->mrd_numblocks; i++) {
528 if (id >= mb->mrb_lowid && id <= mb->mrb_highid) {
529 me = (message_resource_entry *)((uintptr_t)md +
531 for (i = id - mb->mrb_lowid; i > 0; i--)
532 me = (message_resource_entry *)((uintptr_t)me +
536 *flags = me->mre_flags;
546 * Find the function that matches a particular name. This doesn't
547 * need to be particularly speedy since it's only run when loading
548 * a module for the first time.
552 pe_functbl_match(functbl, name)
553 image_patch_table *functbl;
556 image_patch_table *p;
558 if (functbl == NULL || name == NULL)
563 while (p->ipt_name != NULL) {
564 if (!strcmp(p->ipt_name, name))
565 return((vm_offset_t)p->ipt_func);
568 printf ("no match for %s\n", name);
569 return((vm_offset_t)p->ipt_func);
573 * Patch the imported function addresses for a given module.
574 * The caller must specify the module name and provide a table
575 * of function pointers that will be patched into the jump table.
576 * Note that there are actually two copies of the jump table: one
577 * copy is left alone. In a .SYS file, the jump tables are usually
578 * merged into the INIT segment.
582 pe_patch_imports(imgbase, module, functbl)
585 image_patch_table *functbl;
587 image_import_descriptor imp_desc;
589 vm_offset_t *nptr, *fptr;
592 if (imgbase == 0 || module == NULL || functbl == NULL)
595 if (pe_get_import_descriptor(imgbase, &imp_desc, module))
598 nptr = (vm_offset_t *)pe_translate_addr(imgbase,
599 imp_desc.iid_import_name_table_addr);
600 fptr = (vm_offset_t *)pe_translate_addr(imgbase,
601 imp_desc.iid_import_address_table_addr);
603 while (nptr != NULL && pe_translate_addr(imgbase, *nptr)) {
604 fname = (char *)pe_translate_addr(imgbase, (*nptr) + 2);
605 func = pe_functbl_match(functbl, fname);