Authors: Chris Morgan <cmorgan@wpi.edu>, James Abbatiello <abbeyj@wpi.edu>
[wine/multimedia.git] / loader / pe_image.c
blobb1c00cca042f248aa3b829a5ccb363dd62584e05
1 /*
2 * Copyright 1994 Eric Youndale & Erik Bos
3 * Copyright 1995 Martin von Löwis
4 * Copyright 1996-98 Marcus Meissner
6 * based on Eric Youndale's pe-test and:
8 * ftp.microsoft.com:/pub/developer/MSDN/CD8/PEFILE.ZIP
9 * make that:
10 * ftp.microsoft.com:/developr/MSDN/OctCD/PEFILE.ZIP
12 /* Notes:
13 * Before you start changing something in this file be aware of the following:
15 * - There are several functions called recursively. In a very subtle and
16 * obscure way. DLLs can reference each other recursively etc.
17 * - If you want to enhance, speed up or clean up something in here, think
18 * twice WHY it is implemented in that strange way. There is usually a reason.
19 * Though sometimes it might just be lazyness ;)
20 * - In PE_MapImage, right before fixup_imports() all external and internal
21 * state MUST be correct since this function can be called with the SAME image
22 * AGAIN. (Thats recursion for you.) That means MODREF.module and
23 * NE_MODULE.module32.
24 * - Sometimes, we can't use Linux mmap() to mmap() the images directly.
26 * The problem is, that there is not direct 1:1 mapping from a diskimage and
27 * a memoryimage. The headers at the start are mapped linear, but the sections
28 * are not. Older x86 pe binaries are 512 byte aligned in file and 4096 byte
29 * aligned in memory. Linux likes them 4096 byte aligned in memory (due to
30 * x86 pagesize, this cannot be fixed without a rather large kernel rewrite)
31 * and 'blocksize' file-aligned (offsets). Since we have 512/1024/2048 (CDROM)
32 * and other byte blocksizes, we can't always do this. We *can* do this for
33 * newer pe binaries produced by MSVC 5 and later, since they are also aligned
34 * to 4096 byte boundaries on disk.
37 #include "config.h"
39 #include <errno.h>
40 #include <assert.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <unistd.h>
44 #include <sys/types.h>
45 #include <sys/stat.h>
46 #ifdef HAVE_SYS_MMAN_H
47 #include <sys/mman.h>
48 #endif
49 #include "windef.h"
50 #include "winbase.h"
51 #include "winerror.h"
52 #include "callback.h"
53 #include "file.h"
54 #include "heap.h"
55 #include "neexe.h"
56 #include "process.h"
57 #include "thread.h"
58 #include "pe_image.h"
59 #include "module.h"
60 #include "global.h"
61 #include "task.h"
62 #include "snoop.h"
63 #include "server.h"
64 #include "debugtools.h"
66 DEFAULT_DEBUG_CHANNEL(win32)
67 DECLARE_DEBUG_CHANNEL(delayhlp)
68 DECLARE_DEBUG_CHANNEL(fixup)
69 DECLARE_DEBUG_CHANNEL(module)
70 DECLARE_DEBUG_CHANNEL(relay)
71 DECLARE_DEBUG_CHANNEL(segment)
74 /* convert PE image VirtualAddress to Real Address */
75 #define RVA(x) ((void *)((char *)load_addr+(unsigned int)(x)))
77 #define AdjustPtr(ptr,delta) ((char *)(ptr) + (delta))
79 void dump_exports( HMODULE hModule )
81 char *Module;
82 int i, j;
83 u_short *ordinal;
84 u_long *function,*functions;
85 u_char **name;
86 unsigned int load_addr = hModule;
88 DWORD rva_start = PE_HEADER(hModule)->OptionalHeader
89 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].VirtualAddress;
90 DWORD rva_end = rva_start + PE_HEADER(hModule)->OptionalHeader
91 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].Size;
92 IMAGE_EXPORT_DIRECTORY *pe_exports = (IMAGE_EXPORT_DIRECTORY*)RVA(rva_start);
94 Module = (char*)RVA(pe_exports->Name);
95 TRACE("*******EXPORT DATA*******\n");
96 TRACE("Module name is %s, %ld functions, %ld names\n",
97 Module, pe_exports->NumberOfFunctions, pe_exports->NumberOfNames);
99 ordinal=(u_short*) RVA(pe_exports->AddressOfNameOrdinals);
100 functions=function=(u_long*) RVA(pe_exports->AddressOfFunctions);
101 name=(u_char**) RVA(pe_exports->AddressOfNames);
103 TRACE(" Ord RVA Addr Name\n" );
104 for (i=0;i<pe_exports->NumberOfFunctions;i++, function++)
106 if (!*function) continue; /* No such function */
107 if (TRACE_ON(win32))
109 DPRINTF( "%4ld %08lx %p", i + pe_exports->Base, *function, RVA(*function) );
110 /* Check if we have a name for it */
111 for (j = 0; j < pe_exports->NumberOfNames; j++)
112 if (ordinal[j] == i)
114 DPRINTF( " %s", (char*)RVA(name[j]) );
115 break;
117 if ((*function >= rva_start) && (*function <= rva_end))
118 DPRINTF(" (forwarded -> %s)", (char *)RVA(*function));
119 DPRINTF("\n");
124 /* Look up the specified function or ordinal in the exportlist:
125 * If it is a string:
126 * - look up the name in the Name list.
127 * - look up the ordinal with that index.
128 * - use the ordinal as offset into the functionlist
129 * If it is a ordinal:
130 * - use ordinal-pe_export->Base as offset into the functionlist
132 FARPROC PE_FindExportedFunction(
133 WINE_MODREF *wm, /* [in] WINE modreference */
134 LPCSTR funcName, /* [in] function name */
135 BOOL snoop )
137 u_short * ordinals;
138 u_long * function;
139 u_char ** name, *ename = NULL;
140 int i, ordinal;
141 PE_MODREF *pem = &(wm->binfmt.pe);
142 IMAGE_EXPORT_DIRECTORY *exports = pem->pe_export;
143 unsigned int load_addr = wm->module;
144 u_long rva_start, rva_end, addr;
145 char * forward;
147 if (HIWORD(funcName))
148 TRACE("(%s)\n",funcName);
149 else
150 TRACE("(%d)\n",(int)funcName);
151 if (!exports) {
152 /* Not a fatal problem, some apps do
153 * GetProcAddress(0,"RegisterPenApp") which triggers this
154 * case.
156 WARN("Module %08x(%s)/MODREF %p doesn't have a exports table.\n",wm->module,wm->modname,pem);
157 return NULL;
159 ordinals= (u_short*) RVA(exports->AddressOfNameOrdinals);
160 function= (u_long*) RVA(exports->AddressOfFunctions);
161 name = (u_char **) RVA(exports->AddressOfNames);
162 forward = NULL;
163 rva_start = PE_HEADER(wm->module)->OptionalHeader
164 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].VirtualAddress;
165 rva_end = rva_start + PE_HEADER(wm->module)->OptionalHeader
166 .DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT].Size;
168 if (HIWORD(funcName))
170 /* first try a binary search */
171 int min = 0, max = exports->NumberOfNames - 1;
172 while (min <= max)
174 int res, pos = (min + max) / 2;
175 ename = RVA(name[pos]);
176 if (!(res = strcmp( ename, funcName )))
178 ordinal = ordinals[pos];
179 goto found;
181 if (res > 0) max = pos - 1;
182 else min = pos + 1;
184 /* now try a linear search in case the names aren't sorted properly */
185 for (i = 0; i < exports->NumberOfNames; i++)
187 ename = RVA(name[i]);
188 if (!strcmp( ename, funcName ))
190 ERR( "%s.%s required a linear search\n", wm->modname, funcName );
191 ordinal = ordinals[i];
192 goto found;
195 return NULL;
197 else /* find by ordinal */
199 ordinal = LOWORD(funcName) - exports->Base;
200 if (snoop && name) /* need to find a name for it */
202 for (i = 0; i < exports->NumberOfNames; i++)
203 if (ordinals[i] == ordinal)
205 ename = RVA(name[i]);
206 break;
211 found:
212 if (ordinal >= exports->NumberOfFunctions)
214 TRACE(" ordinal %ld out of range!\n", ordinal + exports->Base );
215 return NULL;
217 addr = function[ordinal];
218 if (!addr) return NULL;
219 if ((addr < rva_start) || (addr >= rva_end))
221 FARPROC proc = RVA(addr);
222 if (snoop)
224 if (!ename) ename = "@";
225 proc = SNOOP_GetProcAddress(wm->module,ename,ordinal,proc);
227 return proc;
229 else /* forward entry point */
231 WINE_MODREF *wm;
232 char *forward = RVA(addr);
233 char module[256];
234 char *end = strchr(forward, '.');
236 if (!end) return NULL;
237 if (end - forward >= sizeof(module)) return NULL;
238 memcpy( module, forward, end - forward );
239 module[end-forward] = 0;
240 if (!(wm = MODULE_FindModule( module )))
242 ERR("module not found for forward '%s'\n", forward );
243 return NULL;
245 return MODULE_GetProcAddress( wm->module, end + 1, snoop );
249 DWORD fixup_imports( WINE_MODREF *wm )
251 IMAGE_IMPORT_DESCRIPTOR *pe_imp;
252 PE_MODREF *pem;
253 unsigned int load_addr = wm->module;
254 int i,characteristics_detection=1;
255 char *modname;
257 assert(wm->type==MODULE32_PE);
258 pem = &(wm->binfmt.pe);
259 if (pem->pe_export)
260 modname = (char*) RVA(pem->pe_export->Name);
261 else
262 modname = "<unknown>";
264 /* OK, now dump the import list */
265 TRACE("Dumping imports list\n");
267 /* first, count the number of imported non-internal modules */
268 pe_imp = pem->pe_import;
269 if (!pe_imp) return 0;
271 /* We assume that we have at least one import with !0 characteristics and
272 * detect broken imports with all characteristsics 0 (notably Borland) and
273 * switch the detection off for them.
275 for (i = 0; pe_imp->Name ; pe_imp++) {
276 if (!i && !pe_imp->u.Characteristics)
277 characteristics_detection = 0;
278 if (characteristics_detection && !pe_imp->u.Characteristics)
279 break;
280 i++;
282 if (!i) return 0; /* no imports */
284 /* Allocate module dependency list */
285 wm->nDeps = i;
286 wm->deps = HeapAlloc( GetProcessHeap(), 0, i*sizeof(WINE_MODREF *) );
288 /* load the imported modules. They are automatically
289 * added to the modref list of the process.
292 for (i = 0, pe_imp = pem->pe_import; pe_imp->Name ; pe_imp++) {
293 WINE_MODREF *wmImp;
294 IMAGE_IMPORT_BY_NAME *pe_name;
295 PIMAGE_THUNK_DATA import_list,thunk_list;
296 char *name = (char *) RVA(pe_imp->Name);
298 if (characteristics_detection && !pe_imp->u.Characteristics)
299 break;
301 wmImp = MODULE_LoadLibraryExA( name, 0, 0 );
302 if (!wmImp) {
303 ERR_(module)("Module %s not found\n", name);
304 return 1;
306 wm->deps[i++] = wmImp;
308 /* FIXME: forwarder entries ... */
310 if (pe_imp->u.OriginalFirstThunk != 0) { /* original MS style */
311 TRACE("Microsoft style imports used\n");
312 import_list =(PIMAGE_THUNK_DATA) RVA(pe_imp->u.OriginalFirstThunk);
313 thunk_list = (PIMAGE_THUNK_DATA) RVA(pe_imp->FirstThunk);
315 while (import_list->u1.Ordinal) {
316 if (IMAGE_SNAP_BY_ORDINAL(import_list->u1.Ordinal)) {
317 int ordinal = IMAGE_ORDINAL(import_list->u1.Ordinal);
319 TRACE("--- Ordinal %s,%d\n", name, ordinal);
320 thunk_list->u1.Function=MODULE_GetProcAddress(
321 wmImp->module, (LPCSTR)ordinal, TRUE
323 if (!thunk_list->u1.Function) {
324 ERR("No implementation for %s.%d, setting to 0xdeadbeef\n",
325 name, ordinal);
326 thunk_list->u1.Function = (FARPROC)0xdeadbeef;
328 } else { /* import by name */
329 pe_name = (PIMAGE_IMPORT_BY_NAME)RVA(import_list->u1.AddressOfData);
330 TRACE("--- %s %s.%d\n", pe_name->Name, name, pe_name->Hint);
331 thunk_list->u1.Function=MODULE_GetProcAddress(
332 wmImp->module, pe_name->Name, TRUE
334 if (!thunk_list->u1.Function) {
335 ERR("No implementation for %s.%d(%s), setting to 0xdeadbeef\n",
336 name,pe_name->Hint,pe_name->Name);
337 thunk_list->u1.Function = (FARPROC)0xdeadbeef;
340 import_list++;
341 thunk_list++;
343 } else { /* Borland style */
344 TRACE("Borland style imports used\n");
345 thunk_list = (PIMAGE_THUNK_DATA) RVA(pe_imp->FirstThunk);
346 while (thunk_list->u1.Ordinal) {
347 if (IMAGE_SNAP_BY_ORDINAL(thunk_list->u1.Ordinal)) {
348 /* not sure about this branch, but it seems to work */
349 int ordinal = IMAGE_ORDINAL(thunk_list->u1.Ordinal);
351 TRACE("--- Ordinal %s.%d\n",name,ordinal);
352 thunk_list->u1.Function=MODULE_GetProcAddress(
353 wmImp->module, (LPCSTR) ordinal, TRUE
355 if (!thunk_list->u1.Function) {
356 ERR("No implementation for %s.%d, setting to 0xdeadbeef\n",
357 name,ordinal);
358 thunk_list->u1.Function = (FARPROC)0xdeadbeef;
360 } else {
361 pe_name=(PIMAGE_IMPORT_BY_NAME) RVA(thunk_list->u1.AddressOfData);
362 TRACE("--- %s %s.%d\n",
363 pe_name->Name,name,pe_name->Hint);
364 thunk_list->u1.Function=MODULE_GetProcAddress(
365 wmImp->module, pe_name->Name, TRUE
367 if (!thunk_list->u1.Function) {
368 ERR("No implementation for %s.%d, setting to 0xdeadbeef\n",
369 name, pe_name->Hint);
370 thunk_list->u1.Function = (FARPROC)0xdeadbeef;
373 thunk_list++;
377 return 0;
380 static int calc_vma_size( HMODULE hModule )
382 int i,vma_size = 0;
383 IMAGE_SECTION_HEADER *pe_seg = PE_SECTIONS(hModule);
385 TRACE("Dump of segment table\n");
386 TRACE(" Name VSz Vaddr SzRaw Fileadr *Reloc *Lineum #Reloc #Linum Char\n");
387 for (i = 0; i< PE_HEADER(hModule)->FileHeader.NumberOfSections; i++)
389 TRACE("%8s: %4.4lx %8.8lx %8.8lx %8.8lx %8.8lx %8.8lx %4.4x %4.4x %8.8lx\n",
390 pe_seg->Name,
391 pe_seg->Misc.VirtualSize,
392 pe_seg->VirtualAddress,
393 pe_seg->SizeOfRawData,
394 pe_seg->PointerToRawData,
395 pe_seg->PointerToRelocations,
396 pe_seg->PointerToLinenumbers,
397 pe_seg->NumberOfRelocations,
398 pe_seg->NumberOfLinenumbers,
399 pe_seg->Characteristics);
400 vma_size=max(vma_size, pe_seg->VirtualAddress+pe_seg->SizeOfRawData);
401 vma_size=max(vma_size, pe_seg->VirtualAddress+pe_seg->Misc.VirtualSize);
402 pe_seg++;
404 return vma_size;
407 static void do_relocations( unsigned int load_addr, IMAGE_BASE_RELOCATION *r )
409 int delta = load_addr - PE_HEADER(load_addr)->OptionalHeader.ImageBase;
410 int hdelta = (delta >> 16) & 0xFFFF;
411 int ldelta = delta & 0xFFFF;
413 if(delta == 0)
414 /* Nothing to do */
415 return;
416 while(r->VirtualAddress)
418 char *page = (char*) RVA(r->VirtualAddress);
419 int count = (r->SizeOfBlock - 8)/2;
420 int i;
421 TRACE_(fixup)("%x relocations for page %lx\n",
422 count, r->VirtualAddress);
423 /* patching in reverse order */
424 for(i=0;i<count;i++)
426 int offset = r->TypeOffset[i] & 0xFFF;
427 int type = r->TypeOffset[i] >> 12;
428 TRACE_(fixup)("patching %x type %x\n", offset, type);
429 switch(type)
431 case IMAGE_REL_BASED_ABSOLUTE: break;
432 case IMAGE_REL_BASED_HIGH:
433 *(short*)(page+offset) += hdelta;
434 break;
435 case IMAGE_REL_BASED_LOW:
436 *(short*)(page+offset) += ldelta;
437 break;
438 case IMAGE_REL_BASED_HIGHLOW:
439 *(int*)(page+offset) += delta;
440 /* FIXME: if this is an exported address, fire up enhanced logic */
441 break;
442 case IMAGE_REL_BASED_HIGHADJ:
443 FIXME("Don't know what to do with IMAGE_REL_BASED_HIGHADJ\n");
444 break;
445 case IMAGE_REL_BASED_MIPS_JMPADDR:
446 FIXME("Is this a MIPS machine ???\n");
447 break;
448 default:
449 FIXME("Unknown fixup type\n");
450 break;
453 r = (IMAGE_BASE_RELOCATION*)((char*)r + r->SizeOfBlock);
461 /**********************************************************************
462 * PE_LoadImage
463 * Load one PE format DLL/EXE into memory
465 * Unluckily we can't just mmap the sections where we want them, for
466 * (at least) Linux does only support offsets which are page-aligned.
468 * BUT we have to map the whole image anyway, for Win32 programs sometimes
469 * want to access them. (HMODULE32 point to the start of it)
471 HMODULE PE_LoadImage( HANDLE hFile, LPCSTR filename, WORD *version )
473 HMODULE hModule;
474 HANDLE mapping;
476 IMAGE_NT_HEADERS *nt;
477 IMAGE_SECTION_HEADER *pe_sec;
478 IMAGE_DATA_DIRECTORY *dir;
479 BY_HANDLE_FILE_INFORMATION bhfi;
480 int i, rawsize, lowest_va, vma_size, file_size = 0;
481 DWORD load_addr = 0, aoep, reloc = 0;
482 struct get_read_fd_request *req = get_req_buffer();
483 int unix_handle = -1;
485 /* Retrieve file size */
486 if ( GetFileInformationByHandle( hFile, &bhfi ) )
487 file_size = bhfi.nFileSizeLow; /* FIXME: 64 bit */
489 /* Map the PE file somewhere */
490 mapping = CreateFileMappingA( hFile, NULL, PAGE_READONLY | SEC_COMMIT,
491 0, 0, NULL );
492 if (!mapping)
494 WARN("CreateFileMapping error %ld\n", GetLastError() );
495 return 0;
497 hModule = (HMODULE)MapViewOfFile( mapping, FILE_MAP_READ, 0, 0, 0 );
498 CloseHandle( mapping );
499 if (!hModule)
501 WARN("MapViewOfFile error %ld\n", GetLastError() );
502 return 0;
504 if ( *(WORD*)hModule !=IMAGE_DOS_SIGNATURE)
506 WARN("%s image doesn't have DOS signature, but 0x%04x\n", filename,*(WORD*)hModule);
507 goto error;
510 nt = PE_HEADER( hModule );
512 /* Check signature */
513 if ( nt->Signature != IMAGE_NT_SIGNATURE )
515 WARN("%s image doesn't have PE signature, but 0x%08lx\n", filename, nt->Signature );
516 goto error;
519 /* Check architecture */
520 if ( nt->FileHeader.Machine != IMAGE_FILE_MACHINE_I386 )
522 MESSAGE("Trying to load PE image for unsupported architecture (");
523 switch (nt->FileHeader.Machine)
525 case IMAGE_FILE_MACHINE_UNKNOWN: MESSAGE("Unknown"); break;
526 case IMAGE_FILE_MACHINE_I860: MESSAGE("I860"); break;
527 case IMAGE_FILE_MACHINE_R3000: MESSAGE("R3000"); break;
528 case IMAGE_FILE_MACHINE_R4000: MESSAGE("R4000"); break;
529 case IMAGE_FILE_MACHINE_R10000: MESSAGE("R10000"); break;
530 case IMAGE_FILE_MACHINE_ALPHA: MESSAGE("Alpha"); break;
531 case IMAGE_FILE_MACHINE_POWERPC: MESSAGE("PowerPC"); break;
532 default: MESSAGE("Unknown-%04x", nt->FileHeader.Machine); break;
534 MESSAGE(")\n");
535 goto error;
538 /* Find out how large this executeable should be */
539 pe_sec = PE_SECTIONS( hModule );
540 rawsize = 0; lowest_va = 0x10000;
541 for (i = 0; i < nt->FileHeader.NumberOfSections; i++)
543 if (lowest_va > pe_sec[i].VirtualAddress)
544 lowest_va = pe_sec[i].VirtualAddress;
545 if (pe_sec[i].Characteristics & IMAGE_SCN_CNT_UNINITIALIZED_DATA)
546 continue;
547 if (pe_sec[i].PointerToRawData+pe_sec[i].SizeOfRawData > rawsize)
548 rawsize = pe_sec[i].PointerToRawData+pe_sec[i].SizeOfRawData;
551 /* Check file size */
552 if ( file_size && file_size < rawsize )
554 ERR("PE module is too small (header: %d, filesize: %d), "
555 "probably truncated download?\n",
556 rawsize, file_size );
557 goto error;
560 /* Check entrypoint address */
561 aoep = nt->OptionalHeader.AddressOfEntryPoint;
562 if (aoep && (aoep < lowest_va))
563 FIXME("VIRUS WARNING: '%s' has an invalid entrypoint (0x%08lx) "
564 "below the first virtual address (0x%08x) "
565 "(possibly infected by Tchernobyl/SpaceFiller virus)!\n",
566 filename, aoep, lowest_va );
569 /* FIXME: Hack! While we don't really support shared sections yet,
570 * this checks for those special cases where the whole DLL
571 * consists only of shared sections and is mapped into the
572 * shared address space > 2GB. In this case, we assume that
573 * the module got mapped at its base address. Thus we simply
574 * check whether the module has actually been mapped there
575 * and use it, if so. This is needed to get Win95 USER32.DLL
576 * to work (until we support shared sections properly).
579 if ( nt->OptionalHeader.ImageBase & 0x80000000 )
581 HMODULE sharedMod = (HMODULE)nt->OptionalHeader.ImageBase;
582 IMAGE_NT_HEADERS *sharedNt = (PIMAGE_NT_HEADERS)
583 ( (LPBYTE)sharedMod + ((LPBYTE)nt - (LPBYTE)hModule) );
585 /* Well, this check is not really comprehensive,
586 but should be good enough for now ... */
587 if ( !IsBadReadPtr( (LPBYTE)sharedMod, sizeof(IMAGE_DOS_HEADER) )
588 && memcmp( (LPBYTE)sharedMod, (LPBYTE)hModule, sizeof(IMAGE_DOS_HEADER) ) == 0
589 && !IsBadReadPtr( sharedNt, sizeof(IMAGE_NT_HEADERS) )
590 && memcmp( sharedNt, nt, sizeof(IMAGE_NT_HEADERS) ) == 0 )
592 UnmapViewOfFile( (LPVOID)hModule );
593 return sharedMod;
598 /* Allocate memory for module */
599 load_addr = nt->OptionalHeader.ImageBase;
600 vma_size = calc_vma_size( hModule );
602 load_addr = (DWORD)VirtualAlloc( (void*)load_addr, vma_size,
603 MEM_RESERVE | MEM_COMMIT,
604 PAGE_EXECUTE_READWRITE );
605 if (load_addr == 0)
607 /* We need to perform base relocations */
608 FIXME("We need to perform base relocations for %s\n", filename);
609 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_BASERELOC;
610 if (dir->Size)
611 reloc = dir->VirtualAddress;
612 else
614 FIXME( "FATAL: Need to relocate %s, but no relocation records present (%s). Try to run that file directly !\n",
615 filename,
616 (nt->FileHeader.Characteristics&IMAGE_FILE_RELOCS_STRIPPED)?
617 "stripped during link" : "unknown reason" );
618 goto error;
621 /* FIXME: If we need to relocate a system DLL (base > 2GB) we should
622 * really make sure that the *new* base address is also > 2GB.
623 * Some DLLs really check the MSB of the module handle :-/
625 if ( nt->OptionalHeader.ImageBase & 0x80000000 )
626 ERR( "Forced to relocate system DLL (base > 2GB). This is not good.\n" );
628 load_addr = (DWORD)VirtualAlloc( NULL, vma_size,
629 MEM_RESERVE | MEM_COMMIT,
630 PAGE_EXECUTE_READWRITE );
631 if (!load_addr) {
632 FIXME_(win32)(
633 "FATAL: Couldn't load module %s (out of memory, %d needed)!\n", filename, vma_size);
634 goto error;
638 TRACE("Load addr is %lx (base %lx), range %x\n",
639 load_addr, nt->OptionalHeader.ImageBase, vma_size );
640 TRACE_(segment)("Loading %s at %lx, range %x\n",
641 filename, load_addr, vma_size );
643 #if 0
644 /* Store the NT header at the load addr */
645 *(PIMAGE_DOS_HEADER)load_addr = *(PIMAGE_DOS_HEADER)hModule;
646 *PE_HEADER( load_addr ) = *nt;
647 memcpy( PE_SECTIONS(load_addr), PE_SECTIONS(hModule),
648 sizeof(IMAGE_SECTION_HEADER) * nt->FileHeader.NumberOfSections );
650 /* Copies all stuff up to the first section. Including win32 viruses. */
651 memcpy( load_addr, hModule, lowest_fa );
652 #endif
654 req->handle = hFile;
655 server_call_fd( REQ_GET_READ_FD, -1, &unix_handle );
656 if (unix_handle == -1) goto error;
658 /* Map the header */
659 if (FILE_dommap( unix_handle, (void *)load_addr, 0, nt->OptionalHeader.SizeOfHeaders,
660 0, 0, PROT_EXEC | PROT_WRITE | PROT_READ,
661 MAP_PRIVATE | MAP_FIXED ) != load_addr)
663 ERR_(win32)( "Critical Error: failed to map PE header to necessary address.\n");
664 goto error;
667 /* Copy sections into module image */
668 pe_sec = PE_SECTIONS( hModule );
669 for (i = 0; i < nt->FileHeader.NumberOfSections; i++, pe_sec++)
671 if (!pe_sec->SizeOfRawData) continue;
672 TRACE("%s: mmaping section %s at %p off %lx\n",
673 filename, pe_sec->Name, (void*)RVA(pe_sec->VirtualAddress),
674 pe_sec->PointerToRawData);
675 if (FILE_dommap( unix_handle, (void*)RVA(pe_sec->VirtualAddress),
676 0, min(pe_sec->Misc.VirtualSize, pe_sec->SizeOfRawData),
677 0, pe_sec->PointerToRawData, PROT_EXEC | PROT_WRITE | PROT_READ,
678 MAP_PRIVATE | MAP_FIXED ) != (void*)RVA(pe_sec->VirtualAddress))
680 /* We failed to map to the right place (huh?) */
681 ERR_(win32)( "Critical Error: failed to map PE section to necessary address.\n");
682 goto error;
686 /* Perform base relocation, if necessary */
687 if ( reloc )
688 do_relocations( load_addr, (IMAGE_BASE_RELOCATION *)RVA(reloc) );
690 /* Get expected OS / Subsystem version */
691 *version = ( (nt->OptionalHeader.MajorSubsystemVersion & 0xff) << 8 )
692 | (nt->OptionalHeader.MinorSubsystemVersion & 0xff);
694 /* We don't need the orignal mapping any more */
695 UnmapViewOfFile( (LPVOID)hModule );
696 return (HMODULE)load_addr;
698 error:
699 if (unix_handle != -1) close( unix_handle );
700 if (load_addr) VirtualFree( (LPVOID)load_addr, 0, MEM_RELEASE );
701 UnmapViewOfFile( (LPVOID)hModule );
702 return 0;
705 /**********************************************************************
706 * PE_CreateModule
708 * Create WINE_MODREF structure for loaded HMODULE32, link it into
709 * process modref_list, and fixup all imports.
711 * Note: hModule must point to a correctly allocated PE image,
712 * with base relocations applied; the 16-bit dummy module
713 * associated to hModule must already exist.
715 * Note: This routine must always be called in the context of the
716 * process that is to own the module to be created.
718 WINE_MODREF *PE_CreateModule( HMODULE hModule,
719 LPCSTR filename, DWORD flags, BOOL builtin )
721 DWORD load_addr = (DWORD)hModule; /* for RVA */
722 IMAGE_NT_HEADERS *nt = PE_HEADER(hModule);
723 IMAGE_DATA_DIRECTORY *dir;
724 IMAGE_IMPORT_DESCRIPTOR *pe_import = NULL;
725 IMAGE_EXPORT_DIRECTORY *pe_export = NULL;
726 IMAGE_RESOURCE_DIRECTORY *pe_resource = NULL;
727 WINE_MODREF *wm;
728 int result;
731 /* Retrieve DataDirectory entries */
733 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_EXPORT;
734 if (dir->Size)
735 pe_export = (PIMAGE_EXPORT_DIRECTORY)RVA(dir->VirtualAddress);
737 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_IMPORT;
738 if (dir->Size)
739 pe_import = (PIMAGE_IMPORT_DESCRIPTOR)RVA(dir->VirtualAddress);
741 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_RESOURCE;
742 if (dir->Size)
743 pe_resource = (PIMAGE_RESOURCE_DIRECTORY)RVA(dir->VirtualAddress);
745 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_EXCEPTION;
746 if (dir->Size) FIXME("Exception directory ignored\n" );
748 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_SECURITY;
749 if (dir->Size) FIXME("Security directory ignored\n" );
751 /* IMAGE_DIRECTORY_ENTRY_BASERELOC handled in PE_LoadImage */
752 /* IMAGE_DIRECTORY_ENTRY_DEBUG handled by debugger */
754 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_DEBUG;
755 if (dir->Size) TRACE("Debug directory ignored\n" );
757 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_COPYRIGHT;
758 if (dir->Size) FIXME("Copyright string ignored\n" );
760 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_GLOBALPTR;
761 if (dir->Size) FIXME("Global Pointer (MIPS) ignored\n" );
763 /* IMAGE_DIRECTORY_ENTRY_TLS handled in PE_TlsInit */
765 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG;
766 if (dir->Size) FIXME("Load Configuration directory ignored\n" );
768 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT;
769 if (dir->Size) TRACE("Bound Import directory ignored\n" );
771 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_IAT;
772 if (dir->Size) TRACE("Import Address Table directory ignored\n" );
774 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT;
775 if (dir->Size)
777 TRACE("Delayed import, stub calls LoadLibrary\n" );
779 * Nothing to do here.
782 #ifdef ImgDelayDescr
784 * This code is useful to observe what the heck is going on.
787 ImgDelayDescr *pe_delay = NULL;
788 pe_delay = (PImgDelayDescr)RVA(dir->VirtualAddress);
789 TRACE_(delayhlp)("pe_delay->grAttrs = %08x\n", pe_delay->grAttrs);
790 TRACE_(delayhlp)("pe_delay->szName = %s\n", pe_delay->szName);
791 TRACE_(delayhlp)("pe_delay->phmod = %08x\n", pe_delay->phmod);
792 TRACE_(delayhlp)("pe_delay->pIAT = %08x\n", pe_delay->pIAT);
793 TRACE_(delayhlp)("pe_delay->pINT = %08x\n", pe_delay->pINT);
794 TRACE_(delayhlp)("pe_delay->pBoundIAT = %08x\n", pe_delay->pBoundIAT);
795 TRACE_(delayhlp)("pe_delay->pUnloadIAT = %08x\n", pe_delay->pUnloadIAT);
796 TRACE_(delayhlp)("pe_delay->dwTimeStamp = %08x\n", pe_delay->dwTimeStamp);
798 #endif /* ImgDelayDescr */
801 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR;
802 if (dir->Size) FIXME("Unknown directory 14 ignored\n" );
804 dir = nt->OptionalHeader.DataDirectory+15;
805 if (dir->Size) FIXME("Unknown directory 15 ignored\n" );
808 /* Allocate and fill WINE_MODREF */
810 wm = (WINE_MODREF *)HeapAlloc( GetProcessHeap(),
811 HEAP_ZERO_MEMORY, sizeof(*wm) );
812 wm->module = hModule;
814 if ( builtin )
815 wm->flags |= WINE_MODREF_INTERNAL;
816 if ( flags & DONT_RESOLVE_DLL_REFERENCES )
817 wm->flags |= WINE_MODREF_DONT_RESOLVE_REFS;
818 if ( flags & LOAD_LIBRARY_AS_DATAFILE )
819 wm->flags |= WINE_MODREF_LOAD_AS_DATAFILE;
821 wm->type = MODULE32_PE;
822 wm->binfmt.pe.pe_export = pe_export;
823 wm->binfmt.pe.pe_import = pe_import;
824 wm->binfmt.pe.pe_resource = pe_resource;
825 wm->binfmt.pe.tlsindex = -1;
827 wm->filename = HEAP_strdupA( GetProcessHeap(), 0, filename );
828 wm->modname = strrchr( wm->filename, '\\' );
829 if (!wm->modname) wm->modname = wm->filename;
830 else wm->modname++;
832 result = GetShortPathNameA( wm->filename, NULL, 0 );
833 wm->short_filename = (char *)HeapAlloc( GetProcessHeap(), 0, result+1 );
834 GetShortPathNameA( wm->filename, wm->short_filename, result+1 );
835 wm->short_modname = strrchr( wm->short_filename, '\\' );
836 if (!wm->short_modname) wm->short_modname = wm->short_filename;
837 else wm->short_modname++;
839 /* Link MODREF into process list */
841 EnterCriticalSection( &PROCESS_Current()->crit_section );
843 wm->next = PROCESS_Current()->modref_list;
844 PROCESS_Current()->modref_list = wm;
845 if ( wm->next ) wm->next->prev = wm;
847 if ( !( nt->FileHeader.Characteristics & IMAGE_FILE_DLL )
848 && !( wm->flags & WINE_MODREF_LOAD_AS_DATAFILE ) )
851 if ( PROCESS_Current()->exe_modref )
852 FIXME( "Trying to load second .EXE file: %s\n", filename );
853 else
854 PROCESS_Current()->exe_modref = wm;
857 LeaveCriticalSection( &PROCESS_Current()->crit_section );
860 /* Dump Exports */
862 if ( pe_export )
863 dump_exports( hModule );
865 /* Fixup Imports */
867 if ( pe_import
868 && !( wm->flags & WINE_MODREF_LOAD_AS_DATAFILE )
869 && !( wm->flags & WINE_MODREF_DONT_RESOLVE_REFS )
870 && fixup_imports( wm ) )
872 /* remove entry from modref chain */
873 EnterCriticalSection( &PROCESS_Current()->crit_section );
875 if ( !wm->prev )
876 PROCESS_Current()->modref_list = wm->next;
877 else
878 wm->prev->next = wm->next;
880 if ( wm->next ) wm->next->prev = wm->prev;
881 wm->next = wm->prev = NULL;
883 LeaveCriticalSection( &PROCESS_Current()->crit_section );
885 /* FIXME: there are several more dangling references
886 * left. Including dlls loaded by this dll before the
887 * failed one. Unrolling is rather difficult with the
888 * current structure and we can leave it them lying
889 * around with no problems, so we don't care.
890 * As these might reference our wm, we don't free it.
892 return NULL;
895 return wm;
898 /******************************************************************************
899 * The PE Library Loader frontend.
900 * FIXME: handle the flags.
902 WINE_MODREF *PE_LoadLibraryExA (LPCSTR name, DWORD flags)
904 struct load_dll_request *req = get_req_buffer();
905 HMODULE hModule32;
906 HMODULE16 hModule16;
907 WINE_MODREF *wm;
908 char filename[256];
909 HANDLE hFile;
910 WORD version = 0;
912 /* Search for and open PE file */
913 if ( SearchPathA( NULL, name, ".DLL",
914 sizeof(filename), filename, NULL ) == 0 ) return NULL;
916 hFile = CreateFileA( filename, GENERIC_READ, FILE_SHARE_READ,
917 NULL, OPEN_EXISTING, 0, -1 );
918 if ( hFile == INVALID_HANDLE_VALUE ) return NULL;
920 /* Load PE module */
921 hModule32 = PE_LoadImage( hFile, filename, &version );
922 if (!hModule32)
924 CloseHandle( hFile );
925 SetLastError( ERROR_OUTOFMEMORY ); /* Not entirely right, but good enough */
926 return NULL;
929 /* Create 16-bit dummy module */
930 if ((hModule16 = MODULE_CreateDummyModule( filename, hModule32 )) < 32)
932 CloseHandle( hFile );
933 SetLastError( (DWORD)hModule16 ); /* This should give the correct error */
934 return NULL;
937 /* Create 32-bit MODREF */
938 if ( !(wm = PE_CreateModule( hModule32, filename, flags, FALSE )) )
940 ERR( "can't load %s\n", filename );
941 FreeLibrary16( hModule16 );
942 CloseHandle( hFile );
943 SetLastError( ERROR_OUTOFMEMORY );
944 return NULL;
947 if (wm->binfmt.pe.pe_export)
948 SNOOP_RegisterDLL(wm->module,wm->modname,wm->binfmt.pe.pe_export->NumberOfFunctions);
949 req->handle = hFile;
950 req->base = (void *)hModule32;
951 req->dbg_offset = 0;
952 req->dbg_size = 0;
953 req->name = &wm->modname;
954 server_call_noerr( REQ_LOAD_DLL );
955 CloseHandle( hFile );
956 return wm;
960 /*****************************************************************************
961 * PE_UnloadLibrary
963 * Unload the library unmapping the image and freeing the modref structure.
965 void PE_UnloadLibrary(WINE_MODREF *wm)
967 TRACE(" unloading %s\n", wm->filename);
968 VirtualFree( (LPVOID)wm->module, 0, MEM_RELEASE );
969 HeapFree( GetProcessHeap(), 0, wm->filename );
970 HeapFree( GetProcessHeap(), 0, wm->short_filename );
971 HeapFree( GetProcessHeap(), 0, wm );
974 /*****************************************************************************
975 * Load the PE main .EXE. All other loading is done by PE_LoadLibraryExA
976 * FIXME: this function should use PE_LoadLibraryExA, but currently can't
977 * due to the PROCESS_Create stuff.
979 BOOL PE_CreateProcess( HANDLE hFile, LPCSTR filename, LPCSTR cmd_line, LPCSTR env,
980 LPSECURITY_ATTRIBUTES psa, LPSECURITY_ATTRIBUTES tsa,
981 BOOL inherit, DWORD flags, LPSTARTUPINFOA startup,
982 LPPROCESS_INFORMATION info )
984 WORD version = 0;
985 HMODULE16 hModule16;
986 HMODULE hModule32;
987 NE_MODULE *pModule;
989 /* Load file */
990 if ( (hModule32 = PE_LoadImage( hFile, filename, &version )) < 32 )
992 SetLastError( hModule32 );
993 return FALSE;
995 #if 0
996 if (PE_HEADER(hModule32)->FileHeader.Characteristics & IMAGE_FILE_DLL)
998 SetLastError( 20 ); /* FIXME: not the right error code */
999 return FALSE;
1001 #endif
1003 /* Create 16-bit dummy module */
1004 if ( (hModule16 = MODULE_CreateDummyModule( filename, hModule32 )) < 32 )
1006 SetLastError( hModule16 );
1007 return FALSE;
1009 pModule = (NE_MODULE *)GlobalLock16( hModule16 );
1011 /* Create new process */
1012 if ( !PROCESS_Create( pModule, hFile, cmd_line, env,
1013 psa, tsa, inherit, flags, startup, info ) )
1014 return FALSE;
1016 /* Note: PE_CreateModule and the remaining process initialization will
1017 be done in the context of the new process, in TASK_CallToStart */
1019 return TRUE;
1023 /* Called if the library is loaded or freed.
1024 * NOTE: if a thread attaches a DLL, the current thread will only do
1025 * DLL_PROCESS_ATTACH. Only new created threads do DLL_THREAD_ATTACH
1026 * (SDK)
1028 BOOL PE_InitDLL( WINE_MODREF *wm, DWORD type, LPVOID lpReserved )
1030 BOOL retv = TRUE;
1031 assert( wm->type == MODULE32_PE );
1033 /* Is this a library? And has it got an entrypoint? */
1034 if ((PE_HEADER(wm->module)->FileHeader.Characteristics & IMAGE_FILE_DLL) &&
1035 (PE_HEADER(wm->module)->OptionalHeader.AddressOfEntryPoint)
1037 DLLENTRYPROC entry = (void*)RVA_PTR( wm->module,OptionalHeader.AddressOfEntryPoint );
1038 TRACE_(relay)("CallTo32(entryproc=%p,module=%08x,type=%ld,res=%p)\n",
1039 entry, wm->module, type, lpReserved );
1041 retv = entry( wm->module, type, lpReserved );
1044 return retv;
1047 /************************************************************************
1048 * PE_InitTls (internal)
1050 * If included, initialises the thread local storages of modules.
1051 * Pointers in those structs are not RVAs but real pointers which have been
1052 * relocated by do_relocations() already.
1054 static LPVOID
1055 _fixup_address(PIMAGE_OPTIONAL_HEADER opt,int delta,LPVOID addr) {
1056 if ( ((DWORD)addr>opt->ImageBase) &&
1057 ((DWORD)addr<opt->ImageBase+opt->SizeOfImage)
1059 /* the address has not been relocated! */
1060 return (LPVOID)(((DWORD)addr)+delta);
1061 else
1062 /* the address has been relocated already */
1063 return addr;
1065 void PE_InitTls( void )
1067 WINE_MODREF *wm;
1068 PE_MODREF *pem;
1069 IMAGE_NT_HEADERS *peh;
1070 DWORD size,datasize;
1071 LPVOID mem;
1072 PIMAGE_TLS_DIRECTORY pdir;
1073 int delta;
1075 for (wm = PROCESS_Current()->modref_list;wm;wm=wm->next) {
1076 if (wm->type!=MODULE32_PE)
1077 continue;
1078 pem = &(wm->binfmt.pe);
1079 peh = PE_HEADER(wm->module);
1080 delta = wm->module - peh->OptionalHeader.ImageBase;
1081 if (!peh->OptionalHeader.DataDirectory[IMAGE_FILE_THREAD_LOCAL_STORAGE].VirtualAddress)
1082 continue;
1083 pdir = (LPVOID)(wm->module + peh->OptionalHeader.
1084 DataDirectory[IMAGE_FILE_THREAD_LOCAL_STORAGE].VirtualAddress);
1087 if ( pem->tlsindex == -1 ) {
1088 LPDWORD xaddr;
1089 pem->tlsindex = TlsAlloc();
1090 xaddr = _fixup_address(&(peh->OptionalHeader),delta,
1091 pdir->AddressOfIndex
1093 *xaddr=pem->tlsindex;
1095 datasize= pdir->EndAddressOfRawData-pdir->StartAddressOfRawData;
1096 size = datasize + pdir->SizeOfZeroFill;
1097 mem=VirtualAlloc(0,size,MEM_RESERVE|MEM_COMMIT,PAGE_READWRITE);
1098 memcpy(mem,_fixup_address(&(peh->OptionalHeader),delta,(LPVOID)pdir->StartAddressOfRawData),datasize);
1099 if (pdir->AddressOfCallBacks) {
1100 PIMAGE_TLS_CALLBACK *cbs;
1102 cbs = _fixup_address(&(peh->OptionalHeader),delta,pdir->AddressOfCallBacks);
1103 if (*cbs)
1104 FIXME("TLS Callbacks aren't going to be called\n");
1107 TlsSetValue( pem->tlsindex, mem );