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:
7 * ftp.microsoft.com:/developr/MSDN/OctCD/PEFILE.ZIP
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Before you start changing something in this file be aware of the following:
26 * - There are several functions called recursively. In a very subtle and
27 * obscure way. DLLs can reference each other recursively etc.
28 * - If you want to enhance, speed up or clean up something in here, think
29 * twice WHY it is implemented in that strange way. There is usually a reason.
30 * Though sometimes it might just be lazyness ;)
31 * - In PE_MapImage, right before PE_fixup_imports() all external and internal
32 * state MUST be correct since this function can be called with the SAME image
33 * AGAIN. (Thats recursion for you.) That means MODREF.module and
39 #include <sys/types.h>
40 #ifdef HAVE_SYS_MMAN_H
44 #include "wine/winbase16.h"
47 #include "wine/server.h"
48 #include "wine/debug.h"
50 WINE_DEFAULT_DEBUG_CHANNEL(win32);
51 WINE_DECLARE_DEBUG_CHANNEL(delayhlp);
52 WINE_DECLARE_DEBUG_CHANNEL(fixup);
53 WINE_DECLARE_DEBUG_CHANNEL(module);
54 WINE_DECLARE_DEBUG_CHANNEL(relay);
55 WINE_DECLARE_DEBUG_CHANNEL(segment);
58 /* convert PE image VirtualAddress to Real Address */
59 inline static void *get_rva( HMODULE module, DWORD va )
61 return (void *)((char *)module + va);
64 #define AdjustPtr(ptr,delta) ((char *)(ptr) + (delta))
66 void dump_exports( HMODULE hModule )
71 DWORD *function,*functions;
73 IMAGE_EXPORT_DIRECTORY *pe_exports;
74 DWORD rva_start, size;
76 pe_exports = RtlImageDirectoryEntryToData( hModule, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
77 rva_start = (char *)pe_exports - (char *)hModule;
79 Module = get_rva(hModule, pe_exports->Name);
80 DPRINTF("*******EXPORT DATA*******\n");
81 DPRINTF("Module name is %s, %ld functions, %ld names\n",
82 Module, pe_exports->NumberOfFunctions, pe_exports->NumberOfNames);
84 ordinal = get_rva(hModule, pe_exports->AddressOfNameOrdinals);
85 functions = function = get_rva(hModule, pe_exports->AddressOfFunctions);
86 name = get_rva(hModule, pe_exports->AddressOfNames);
88 DPRINTF(" Ord RVA Addr Name\n" );
89 for (i=0;i<pe_exports->NumberOfFunctions;i++, function++)
91 if (!*function) continue; /* No such function */
92 DPRINTF( "%4ld %08lx %p", i + pe_exports->Base, *function, get_rva(hModule, *function) );
93 /* Check if we have a name for it */
94 for (j = 0; j < pe_exports->NumberOfNames; j++)
97 DPRINTF( " %s", (char*)get_rva(hModule, name[j]) );
100 if ((*function >= rva_start) && (*function <= rva_start + size))
101 DPRINTF(" (forwarded -> %s)", (char *)get_rva(hModule, *function));
106 /* Look up the specified function or ordinal in the export list:
108 * - look up the name in the name list.
109 * - look up the ordinal with that index.
110 * - use the ordinal as offset into the functionlist
111 * If it is an ordinal:
112 * - use ordinal-pe_export->Base as offset into the function list
114 static FARPROC PE_FindExportedFunction(
115 WINE_MODREF *wm, /* [in] WINE modreference */
116 LPCSTR funcName, /* [in] function name */
123 DWORD rva_start, addr;
128 IMAGE_EXPORT_DIRECTORY *exports;
131 if (!(exports = RtlImageDirectoryEntryToData( wm->module, TRUE,
132 IMAGE_DIRECTORY_ENTRY_EXPORT, &exp_size )))
135 if (HIWORD(funcName)) TRACE("(%s)\n",funcName);
136 else TRACE("(%d)\n",LOWORD(funcName));
138 ordinals= get_rva(wm->module, exports->AddressOfNameOrdinals);
139 function= get_rva(wm->module, exports->AddressOfFunctions);
140 name = get_rva(wm->module, exports->AddressOfNames);
142 rva_start = (char *)exports - (char *)wm->module;
144 if (HIWORD(funcName))
146 int min = 0, max = exports->NumberOfNames - 1;
148 /* first check the hint */
149 if (hint >= 0 && hint <= max)
151 ename = get_rva(wm->module, name[hint]);
152 if (!strcmp( ename, funcName ))
154 ordinal = ordinals[hint];
159 /* then do a binary search */
162 int res, pos = (min + max) / 2;
163 ename = get_rva(wm->module, name[pos]);
164 if (!(res = strcmp( ename, funcName )))
166 ordinal = ordinals[pos];
169 if (res > 0) max = pos - 1;
174 else /* find by ordinal */
176 ordinal = LOWORD(funcName) - exports->Base;
177 if (snoop && name) /* need to find a name for it */
179 for (i = 0; i < exports->NumberOfNames; i++)
180 if (ordinals[i] == ordinal)
182 ename = get_rva(wm->module, name[i]);
189 if (ordinal >= exports->NumberOfFunctions)
191 TRACE(" ordinal %ld out of range!\n", ordinal + exports->Base );
194 addr = function[ordinal];
195 if (!addr) return NULL;
197 proc = get_rva(wm->module, addr);
198 if (((char *)proc < (char *)exports) || ((char *)proc >= (char *)exports + exp_size))
202 if (!ename) ename = "@";
203 proc = SNOOP_GetProcAddress(wm->module,ename,ordinal,proc);
207 else /* forward entry point */
210 char *forward = (char *)proc;
212 char *end = strchr(forward, '.');
214 if (!end) return NULL;
215 if (end - forward >= sizeof(module)) return NULL;
216 memcpy( module, forward, end - forward );
217 module[end-forward] = 0;
218 if (!(wm_fw = MODULE_FindModule( module )))
220 ERR("module not found for forward '%s' used by '%s'\n", forward, wm->modname );
223 if (!(proc = MODULE_GetProcAddress( wm_fw->module, end + 1, -1, snoop )))
224 ERR("function not found for forward '%s' used by '%s'. If you are using builtin '%s', try using the native one instead.\n", forward, wm->modname, wm->modname );
229 /****************************************************************
232 DWORD PE_fixup_imports( WINE_MODREF *wm )
234 int i,characteristics_detection=1;
235 IMAGE_IMPORT_DESCRIPTOR *imports, *pe_imp;
238 imports = RtlImageDirectoryEntryToData( wm->module, TRUE, IMAGE_DIRECTORY_ENTRY_IMPORT, &size );
240 /* first, count the number of imported non-internal modules */
242 if (!pe_imp) return 0;
244 /* OK, now dump the import list */
245 TRACE("Dumping imports list\n");
247 /* We assume that we have at least one import with !0 characteristics and
248 * detect broken imports with all characteristics 0 (notably Borland) and
249 * switch the detection off for them.
251 for (i = 0; pe_imp->Name ; pe_imp++) {
252 if (!i && !pe_imp->u.Characteristics)
253 characteristics_detection = 0;
254 if (characteristics_detection && !pe_imp->u.Characteristics)
258 if (!i) return 0; /* no imports */
260 /* Allocate module dependency list */
262 wm->deps = HeapAlloc( GetProcessHeap(), 0, i*sizeof(WINE_MODREF *) );
264 /* load the imported modules. They are automatically
265 * added to the modref list of the process.
268 for (i = 0, pe_imp = imports; pe_imp->Name ; pe_imp++) {
270 IMAGE_IMPORT_BY_NAME *pe_name;
271 PIMAGE_THUNK_DATA import_list,thunk_list;
272 char *name = get_rva(wm->module, pe_imp->Name);
274 if (characteristics_detection && !pe_imp->u.Characteristics)
277 wmImp = MODULE_LoadLibraryExA( name, 0, 0 );
279 ERR_(module)("Module (file) %s (which is needed by %s) not found\n", name, wm->filename);
282 wm->deps[i++] = wmImp;
284 /* FIXME: forwarder entries ... */
286 if (pe_imp->u.OriginalFirstThunk != 0) { /* original MS style */
287 TRACE("Microsoft style imports used\n");
288 import_list = get_rva(wm->module, (DWORD)pe_imp->u.OriginalFirstThunk);
289 thunk_list = get_rva(wm->module, (DWORD)pe_imp->FirstThunk);
291 while (import_list->u1.Ordinal) {
292 if (IMAGE_SNAP_BY_ORDINAL(import_list->u1.Ordinal)) {
293 int ordinal = IMAGE_ORDINAL(import_list->u1.Ordinal);
295 TRACE("--- Ordinal %s,%d\n", name, ordinal);
296 thunk_list->u1.Function=(PDWORD)MODULE_GetProcAddress(
297 wmImp->module, (LPCSTR)ordinal, -1, TRUE
299 if (!thunk_list->u1.Function) {
300 ERR("No implementation for %s.%d imported from %s, setting to 0xdeadbeef\n",
301 name, ordinal, wm->filename );
302 thunk_list->u1.Function = (PDWORD)0xdeadbeef;
304 } else { /* import by name */
305 pe_name = get_rva(wm->module, (DWORD)import_list->u1.AddressOfData);
306 TRACE("--- %s %s.%d\n", pe_name->Name, name, pe_name->Hint);
307 thunk_list->u1.Function=(PDWORD)MODULE_GetProcAddress(
308 wmImp->module, pe_name->Name, pe_name->Hint, TRUE
310 if (!thunk_list->u1.Function) {
311 ERR("No implementation for %s.%d(%s) imported from %s, setting to 0xdeadbeef\n",
312 name,pe_name->Hint,pe_name->Name,wm->filename);
313 thunk_list->u1.Function = (PDWORD)0xdeadbeef;
319 } else { /* Borland style */
320 TRACE("Borland style imports used\n");
321 thunk_list = get_rva(wm->module, (DWORD)pe_imp->FirstThunk);
322 while (thunk_list->u1.Ordinal) {
323 if (IMAGE_SNAP_BY_ORDINAL(thunk_list->u1.Ordinal)) {
324 /* not sure about this branch, but it seems to work */
325 int ordinal = IMAGE_ORDINAL(thunk_list->u1.Ordinal);
327 TRACE("--- Ordinal %s.%d\n",name,ordinal);
328 thunk_list->u1.Function=(PDWORD)MODULE_GetProcAddress(
329 wmImp->module, (LPCSTR) ordinal, -1, TRUE
331 if (!thunk_list->u1.Function) {
332 ERR("No implementation for %s.%d imported from %s, setting to 0xdeadbeef\n",
333 name,ordinal, wm->filename);
334 thunk_list->u1.Function = (PDWORD)0xdeadbeef;
337 pe_name=get_rva(wm->module, (DWORD)thunk_list->u1.AddressOfData);
338 TRACE("--- %s %s.%d\n",
339 pe_name->Name,name,pe_name->Hint);
340 thunk_list->u1.Function=(PDWORD)MODULE_GetProcAddress(
341 wmImp->module, pe_name->Name, pe_name->Hint, TRUE
343 if (!thunk_list->u1.Function) {
344 ERR("No implementation for %s.%d(%s) imported from %s, setting to 0xdeadbeef\n",
345 name, pe_name->Hint, pe_name->Name, wm->filename);
346 thunk_list->u1.Function = (PDWORD)0xdeadbeef;
356 /**********************************************************************
358 * Load one PE format DLL/EXE into memory
360 * Unluckily we can't just mmap the sections where we want them, for
361 * (at least) Linux does only support offsets which are page-aligned.
363 * BUT we have to map the whole image anyway, for Win32 programs sometimes
364 * want to access them. (HMODULE points to the start of it)
366 HMODULE PE_LoadImage( HANDLE hFile, LPCSTR filename, DWORD flags )
368 IMAGE_NT_HEADERS *nt;
373 TRACE_(module)( "loading %s\n", filename );
375 mapping = CreateFileMappingA( hFile, NULL, SEC_IMAGE, 0, 0, NULL );
376 if (!mapping) return 0;
377 base = MapViewOfFile( mapping, FILE_MAP_READ, 0, 0, 0 );
378 CloseHandle( mapping );
383 hModule = (HMODULE)base;
384 nt = RtlImageNtHeader( hModule );
386 if (nt->OptionalHeader.AddressOfEntryPoint)
388 if (!RtlImageRvaToSection( nt, hModule, nt->OptionalHeader.AddressOfEntryPoint ))
389 MESSAGE("VIRUS WARNING: PE module has an invalid entrypoint (0x%08lx) "
390 "outside all sections (possibly infected by Tchernobyl/SpaceFiller virus)!\n",
391 nt->OptionalHeader.AddressOfEntryPoint );
397 /**********************************************************************
400 * Create WINE_MODREF structure for loaded HMODULE, link it into
401 * process modref_list, and fixup all imports.
403 * Note: hModule must point to a correctly allocated PE image,
404 * with base relocations applied; the 16-bit dummy module
405 * associated to hModule must already exist.
407 * Note: This routine must always be called in the context of the
408 * process that is to own the module to be created.
410 * Note: Assumes that the process critical section is held
412 WINE_MODREF *PE_CreateModule( HMODULE hModule, LPCSTR filename, DWORD flags,
413 HANDLE hFile, BOOL builtin )
415 IMAGE_NT_HEADERS *nt;
416 IMAGE_DATA_DIRECTORY *dir;
417 IMAGE_EXPORT_DIRECTORY *pe_export = NULL;
421 /* Retrieve DataDirectory entries */
423 nt = RtlImageNtHeader(hModule);
424 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_EXPORT;
425 if (dir->Size) pe_export = get_rva(hModule, dir->VirtualAddress);
427 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_EXCEPTION;
428 if (dir->Size) FIXME("Exception directory ignored\n" );
430 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_SECURITY;
431 if (dir->Size) FIXME("Security directory ignored\n" );
433 /* IMAGE_DIRECTORY_ENTRY_BASERELOC handled in PE_LoadImage */
434 /* IMAGE_DIRECTORY_ENTRY_DEBUG handled by debugger */
436 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_GLOBALPTR;
437 if (dir->Size) FIXME("Global Pointer (MIPS) ignored\n" );
439 /* IMAGE_DIRECTORY_ENTRY_TLS handled in PE_TlsInit */
441 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG;
442 if (dir->Size) FIXME("Load Configuration directory ignored\n" );
444 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT;
445 if (dir->Size) TRACE("Bound Import directory ignored\n" );
447 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_IAT;
448 if (dir->Size) TRACE("Import Address Table directory ignored\n" );
450 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT;
453 TRACE("Delayed import, stub calls LoadLibrary\n" );
455 * Nothing to do here.
460 * This code is useful to observe what the heck is going on.
463 ImgDelayDescr *pe_delay = NULL;
464 pe_delay = get_rva(hModule, dir->VirtualAddress);
465 TRACE_(delayhlp)("pe_delay->grAttrs = %08x\n", pe_delay->grAttrs);
466 TRACE_(delayhlp)("pe_delay->szName = %s\n", pe_delay->szName);
467 TRACE_(delayhlp)("pe_delay->phmod = %08x\n", pe_delay->phmod);
468 TRACE_(delayhlp)("pe_delay->pIAT = %08x\n", pe_delay->pIAT);
469 TRACE_(delayhlp)("pe_delay->pINT = %08x\n", pe_delay->pINT);
470 TRACE_(delayhlp)("pe_delay->pBoundIAT = %08x\n", pe_delay->pBoundIAT);
471 TRACE_(delayhlp)("pe_delay->pUnloadIAT = %08x\n", pe_delay->pUnloadIAT);
472 TRACE_(delayhlp)("pe_delay->dwTimeStamp = %08x\n", pe_delay->dwTimeStamp);
474 #endif /* ImgDelayDescr */
477 dir = nt->OptionalHeader.DataDirectory+IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR;
478 if (dir->Size) FIXME("Unknown directory 14 ignored\n" );
480 dir = nt->OptionalHeader.DataDirectory+15;
481 if (dir->Size) FIXME("Unknown directory 15 ignored\n" );
483 /* Create 16-bit dummy module */
485 if ((hModule16 = MODULE_CreateDummyModule( filename, hModule )) < 32)
487 SetLastError( (DWORD)hModule16 ); /* This should give the correct error */
491 /* Allocate and fill WINE_MODREF */
493 if (!(wm = MODULE_AllocModRef( hModule, filename )))
495 FreeLibrary16( hModule16 );
498 wm->hDummyMod = hModule16;
502 NE_MODULE *pModule = (NE_MODULE *)GlobalLock16( hModule16 );
503 pModule->flags |= NE_FFLAGS_BUILTIN;
504 wm->flags |= WINE_MODREF_INTERNAL;
506 else if ( flags & DONT_RESOLVE_DLL_REFERENCES )
507 wm->flags |= WINE_MODREF_DONT_RESOLVE_REFS;
509 wm->find_export = PE_FindExportedFunction;
513 if (pe_export && TRACE_ON(win32))
514 dump_exports( hModule );
518 if (!(wm->flags & WINE_MODREF_DONT_RESOLVE_REFS) &&
519 PE_fixup_imports( wm ))
521 /* remove entry from modref chain */
524 MODULE_modref_list = wm->next;
526 wm->prev->next = wm->next;
528 if ( wm->next ) wm->next->prev = wm->prev;
529 wm->next = wm->prev = NULL;
531 /* FIXME: there are several more dangling references
532 * left. Including dlls loaded by this dll before the
533 * failed one. Unrolling is rather difficult with the
534 * current structure and we can leave them lying
535 * around with no problems, so we don't care.
536 * As these might reference our wm, we don't free it.
541 if (!builtin && pe_export)
542 SNOOP_RegisterDLL( hModule, wm->modname, pe_export->Base, pe_export->NumberOfFunctions );
544 /* Send DLL load event */
545 /* we don't need to send a dll event for the main exe */
547 if (nt->FileHeader.Characteristics & IMAGE_FILE_DLL)
551 UINT drive_type = GetDriveTypeA( wm->short_filename );
552 /* don't keep the file handle open on removable media */
553 if (drive_type == DRIVE_REMOVABLE || drive_type == DRIVE_CDROM) hFile = 0;
555 SERVER_START_REQ( load_dll )
558 req->base = (void *)hModule;
559 req->size = nt->OptionalHeader.SizeOfImage;
560 req->dbg_offset = nt->FileHeader.PointerToSymbolTable;
561 req->dbg_size = nt->FileHeader.NumberOfSymbols;
562 req->name = &wm->filename;
563 wine_server_add_data( req, wm->filename, strlen(wm->filename) );
564 wine_server_call( req );
572 /******************************************************************************
573 * The PE Library Loader frontend.
574 * FIXME: handle the flags.
576 WINE_MODREF *PE_LoadLibraryExA (LPCSTR name, DWORD flags)
582 hFile = CreateFileA( name, GENERIC_READ, FILE_SHARE_READ,
583 NULL, OPEN_EXISTING, 0, 0 );
584 if ( hFile == INVALID_HANDLE_VALUE ) return NULL;
587 hModule32 = PE_LoadImage( hFile, name, flags );
590 CloseHandle( hFile );
594 /* Create 32-bit MODREF */
595 if ( !(wm = PE_CreateModule( hModule32, name, flags, hFile, FALSE )) )
597 ERR( "can't load %s\n", name );
598 CloseHandle( hFile );
599 SetLastError( ERROR_OUTOFMEMORY );
603 CloseHandle( hFile );
608 /* Called if the library is loaded or freed.
609 * NOTE: if a thread attaches a DLL, the current thread will only do
610 * DLL_PROCESS_ATTACH. Only newly created threads do DLL_THREAD_ATTACH
613 typedef DWORD (CALLBACK *DLLENTRYPROC)(HMODULE,DWORD,LPVOID);
615 BOOL PE_InitDLL( HMODULE module, DWORD type, LPVOID lpReserved )
618 IMAGE_NT_HEADERS *nt = RtlImageNtHeader(module);
620 /* Is this a library? And has it got an entrypoint? */
621 if (nt && (nt->FileHeader.Characteristics & IMAGE_FILE_DLL) &&
622 (nt->OptionalHeader.AddressOfEntryPoint))
624 DLLENTRYPROC entry = (void*)((char*)module + nt->OptionalHeader.AddressOfEntryPoint);
626 DPRINTF("%08lx:Call PE DLL (proc=%p,module=%p,type=%ld,res=%p)\n",
627 GetCurrentThreadId(), entry, module, type, lpReserved );
628 retv = entry( module, type, lpReserved );
630 DPRINTF("%08lx:Ret PE DLL (proc=%p,module=%p,type=%ld,res=%p) retval=%x\n",
631 GetCurrentThreadId(), entry, module, type, lpReserved, retv );
637 /************************************************************************
638 * PE_InitTls (internal)
640 * If included, initialises the thread local storages of modules.
641 * Pointers in those structs are not RVAs but real pointers which have been
642 * relocated by do_relocations() already.
645 _fixup_address(PIMAGE_OPTIONAL_HEADER opt,int delta,LPVOID addr) {
646 if ( ((DWORD)addr>opt->ImageBase) &&
647 ((DWORD)addr<opt->ImageBase+opt->SizeOfImage)
649 /* the address has not been relocated! */
650 return (LPVOID)(((DWORD)addr)+delta);
652 /* the address has been relocated already */
655 void PE_InitTls( void )
658 IMAGE_NT_HEADERS *peh;
659 DWORD size,datasize,dirsize;
661 PIMAGE_TLS_DIRECTORY pdir;
664 for (wm = MODULE_modref_list;wm;wm=wm->next) {
665 peh = RtlImageNtHeader(wm->module);
666 pdir = RtlImageDirectoryEntryToData( wm->module, TRUE,
667 IMAGE_DIRECTORY_ENTRY_TLS, &dirsize );
669 delta = (char *)wm->module - (char *)peh->OptionalHeader.ImageBase;
671 if ( wm->tlsindex == -1 ) {
673 wm->tlsindex = TlsAlloc();
674 xaddr = _fixup_address(&(peh->OptionalHeader),delta,
679 datasize= pdir->EndAddressOfRawData-pdir->StartAddressOfRawData;
680 size = datasize + pdir->SizeOfZeroFill;
681 mem=VirtualAlloc(0,size,MEM_RESERVE|MEM_COMMIT,PAGE_READWRITE);
682 memcpy(mem,_fixup_address(&(peh->OptionalHeader),delta,(LPVOID)pdir->StartAddressOfRawData),datasize);
683 if (pdir->AddressOfCallBacks) {
684 PIMAGE_TLS_CALLBACK *cbs;
686 cbs = _fixup_address(&(peh->OptionalHeader),delta,pdir->AddressOfCallBacks);
688 FIXME("TLS Callbacks aren't going to be called\n");
691 TlsSetValue( wm->tlsindex, mem );