2 * Win32 relay and snoop functions
4 * Copyright 1997 Alexandre Julliard
5 * Copyright 1998 Marcus Meissner
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "wine/port.h"
35 #include "wine/exception.h"
36 #include "ntdll_misc.h"
37 #include "wine/unicode.h"
38 #include "wine/debug.h"
40 WINE_DEFAULT_DEBUG_CHANNEL(relay);
41 WINE_DECLARE_DEBUG_CHANNEL(snoop);
42 WINE_DECLARE_DEBUG_CHANNEL(seh);
44 static const WCHAR **debug_relay_excludelist;
45 static const WCHAR **debug_relay_includelist;
46 static const WCHAR **debug_snoop_excludelist;
47 static const WCHAR **debug_snoop_includelist;
48 static const WCHAR **debug_from_relay_excludelist;
49 static const WCHAR **debug_from_relay_includelist;
50 static const WCHAR **debug_from_snoop_excludelist;
51 static const WCHAR **debug_from_snoop_includelist;
53 /* compare an ASCII and a Unicode string without depending on the current codepage */
54 inline static int strcmpAW( const char *strA, const WCHAR *strW )
56 while (*strA && ((unsigned char)*strA == *strW)) { strA++; strW++; }
57 return (unsigned char)*strA - *strW;
60 /* compare an ASCII and a Unicode string without depending on the current codepage */
61 inline static int strncmpiAW( const char *strA, const WCHAR *strW, int n )
64 for ( ; n > 0; n--, strA++, strW++)
65 if ((ret = toupperW((unsigned char)*strA) - toupperW(*strW)) || !*strA) break;
69 /***********************************************************************
72 * Build a function list from a ';'-separated string.
74 static const WCHAR **build_list( const WCHAR *buffer )
77 const WCHAR *p = buffer;
80 while ((p = strchrW( p, ';' )))
85 /* allocate count+1 pointers, plus the space for a copy of the string */
86 if ((ret = RtlAllocateHeap( GetProcessHeap(), 0,
87 (count+1) * sizeof(WCHAR*) + (strlenW(buffer)+1) * sizeof(WCHAR) )))
89 WCHAR *str = (WCHAR *)(ret + count + 1);
92 strcpyW( str, buffer );
97 if (!(p = strchrW( p, ';' ))) break;
106 /***********************************************************************
107 * RELAY_InitDebugLists
109 * Build the relay include/exclude function lists.
111 void RELAY_InitDebugLists(void)
113 OBJECT_ATTRIBUTES attr;
119 static const WCHAR configW[] = {'M','a','c','h','i','n','e','\\',
120 'S','o','f','t','w','a','r','e','\\',
121 'W','i','n','e','\\',
122 'W','i','n','e','\\',
123 'C','o','n','f','i','g','\\',
124 'D','e','b','u','g',0};
125 static const WCHAR RelayIncludeW[] = {'R','e','l','a','y','I','n','c','l','u','d','e',0};
126 static const WCHAR RelayExcludeW[] = {'R','e','l','a','y','E','x','c','l','u','d','e',0};
127 static const WCHAR SnoopIncludeW[] = {'S','n','o','o','p','I','n','c','l','u','d','e',0};
128 static const WCHAR SnoopExcludeW[] = {'S','n','o','o','p','E','x','c','l','u','d','e',0};
129 static const WCHAR RelayFromIncludeW[] = {'R','e','l','a','y','F','r','o','m','I','n','c','l','u','d','e',0};
130 static const WCHAR RelayFromExcludeW[] = {'R','e','l','a','y','F','r','o','m','E','x','c','l','u','d','e',0};
131 static const WCHAR SnoopFromIncludeW[] = {'S','n','o','o','p','F','r','o','m','I','n','c','l','u','d','e',0};
132 static const WCHAR SnoopFromExcludeW[] = {'S','n','o','o','p','F','r','o','m','E','x','c','l','u','d','e',0};
134 attr.Length = sizeof(attr);
135 attr.RootDirectory = 0;
136 attr.ObjectName = &name;
138 attr.SecurityDescriptor = NULL;
139 attr.SecurityQualityOfService = NULL;
140 RtlInitUnicodeString( &name, configW );
142 if (NtOpenKey( &hkey, KEY_ALL_ACCESS, &attr )) return;
144 str = (WCHAR *)((KEY_VALUE_PARTIAL_INFORMATION *)buffer)->Data;
145 RtlInitUnicodeString( &name, RelayIncludeW );
146 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
148 TRACE("RelayInclude = %s\n", debugstr_w(str) );
149 debug_relay_includelist = build_list( str );
152 RtlInitUnicodeString( &name, RelayExcludeW );
153 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
155 TRACE( "RelayExclude = %s\n", debugstr_w(str) );
156 debug_relay_excludelist = build_list( str );
159 RtlInitUnicodeString( &name, SnoopIncludeW );
160 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
162 TRACE_(snoop)( "SnoopInclude = %s\n", debugstr_w(str) );
163 debug_snoop_includelist = build_list( str );
166 RtlInitUnicodeString( &name, SnoopExcludeW );
167 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
169 TRACE_(snoop)( "SnoopExclude = %s\n", debugstr_w(str) );
170 debug_snoop_excludelist = build_list( str );
173 RtlInitUnicodeString( &name, RelayFromIncludeW );
174 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
176 TRACE("RelayFromInclude = %s\n", debugstr_w(str) );
177 debug_from_relay_includelist = build_list( str );
180 RtlInitUnicodeString( &name, RelayFromExcludeW );
181 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
183 TRACE( "RelayFromExclude = %s\n", debugstr_w(str) );
184 debug_from_relay_excludelist = build_list( str );
187 RtlInitUnicodeString( &name, SnoopFromIncludeW );
188 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
190 TRACE_(snoop)("SnoopFromInclude = %s\n", debugstr_w(str) );
191 debug_from_snoop_includelist = build_list( str );
194 RtlInitUnicodeString( &name, SnoopFromExcludeW );
195 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
197 TRACE_(snoop)( "SnoopFromExclude = %s\n", debugstr_w(str) );
198 debug_from_snoop_excludelist = build_list( str );
207 #include "pshpack1.h"
211 BYTE call; /* 0xe8 call callfrom32 (relative) */
212 DWORD callfrom32; /* RELAY_CallFrom32 relative addr */
213 BYTE ret; /* 0xc2 ret $n or 0xc3 ret */
214 WORD args; /* nb of args to remove from the stack */
215 void *orig; /* original entry point */
216 DWORD argtypes; /* argument types */
222 BYTE lcall; /* 0xe8 call snoopentry (relative) */
223 /* NOTE: If you move snoopentry OR nrofargs fix the relative offset
226 DWORD snoopentry; /* SNOOP_Entry relative */
233 typedef struct tagSNOOP_DLL {
238 struct tagSNOOP_DLL *next;
245 BYTE lcall; /* 0xe8 call snoopret relative*/
246 /* NOTE: If you move snoopret OR origreturn fix the relative offset
249 DWORD snoopret; /* SNOOP_Ret relative */
255 DWORD *args; /* saved args across a stdcall */
258 typedef struct tagSNOOP_RETURNENTRIES {
259 SNOOP_RETURNENTRY entry[4092/sizeof(SNOOP_RETURNENTRY)];
260 struct tagSNOOP_RETURNENTRIES *next;
261 } SNOOP_RETURNENTRIES;
265 extern void WINAPI SNOOP_Entry();
266 extern void WINAPI SNOOP_Return();
268 static SNOOP_DLL *firstdll;
269 static SNOOP_RETURNENTRIES *firstrets;
271 static WINE_EXCEPTION_FILTER(page_fault)
273 if (GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ||
274 GetExceptionCode() == EXCEPTION_PRIV_INSTRUCTION)
275 return EXCEPTION_EXECUTE_HANDLER;
276 return EXCEPTION_CONTINUE_SEARCH;
279 /***********************************************************************
282 * Check if a given module and function is in the list.
284 static BOOL check_list( const char *module, int ordinal, const char *func, const WCHAR **list )
288 sprintf( ord_str, "%d", ordinal );
291 const WCHAR *p = strrchrW( *list, '.' );
292 if (p && p > *list) /* check module and function */
295 if (strncmpiAW( module, *list, len-1 ) || module[len]) continue;
296 if (p[1] == '*' && !p[2]) return TRUE;
297 if (!strcmpAW( ord_str, p + 1 )) return TRUE;
298 if (func && !strcmpAW( func, p + 1 )) return TRUE;
300 else /* function only */
302 if (func && !strcmpAW( func, *list )) return TRUE;
309 /***********************************************************************
310 * check_relay_include
312 * Check if a given function must be included in the relay output.
314 static BOOL check_relay_include( const char *module, int ordinal, const char *func )
316 if (debug_relay_excludelist && check_list( module, ordinal, func, debug_relay_excludelist ))
318 if (debug_relay_includelist && !check_list( module, ordinal, func, debug_relay_includelist ))
323 /***********************************************************************
326 * Check if calls from a given module must be included in the relay/snoop output,
327 * given the exclusion and inclusion lists.
329 static BOOL check_from_module( const WCHAR **includelist, const WCHAR **excludelist, const WCHAR *module )
331 static const WCHAR dllW[] = {'.','d','l','l',0 };
332 const WCHAR **listitem;
335 if (!module) return TRUE;
336 if (!includelist && !excludelist) return TRUE;
340 listitem = excludelist;
345 listitem = includelist;
347 for(; *listitem; listitem++)
351 if (!strcmpiW( *listitem, module )) return !show;
352 len = strlenW( *listitem );
353 if (!strncmpiW( *listitem, module, len ) && !strcmpiW( module + len, dllW ))
359 /***********************************************************************
362 * Find the name of an exported function.
364 static const char *find_exported_name( HMODULE module,
365 IMAGE_EXPORT_DIRECTORY *exp, int ordinal )
368 const char *ret = NULL;
370 WORD *ordptr = (WORD *)((char *)module + exp->AddressOfNameOrdinals);
371 for (i = 0; i < exp->NumberOfNames; i++, ordptr++)
372 if (*ordptr + exp->Base == ordinal) break;
373 if (i < exp->NumberOfNames)
374 ret = (char *)module + ((DWORD*)((char *)module + exp->AddressOfNames))[i];
379 /***********************************************************************
382 * Get the name of the DLL entry point corresponding to a relay address.
384 static void get_entry_point( char *buffer, DEBUG_ENTRY_POINT *relay )
386 IMAGE_EXPORT_DIRECTORY *exp = NULL;
387 DEBUG_ENTRY_POINT *debug;
391 PLIST_ENTRY mark, entry;
392 PLDR_MODULE mod = NULL;
395 /* First find the module */
397 mark = &NtCurrentTeb()->Peb->LdrData->InLoadOrderModuleList;
398 for (entry = mark->Flink; entry != mark; entry = entry->Flink)
400 mod = CONTAINING_RECORD(entry, LDR_MODULE, InLoadOrderModuleList);
401 if (!(mod->Flags & LDR_WINE_INTERNAL)) continue;
402 exp = RtlImageDirectoryEntryToData( mod->BaseAddress, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
404 debug = (DEBUG_ENTRY_POINT *)((char *)exp + size);
405 if (debug <= relay && relay < debug + exp->NumberOfFunctions)
407 ordinal = relay - debug;
412 /* Now find the function */
414 strcpy( buffer, (char *)mod->BaseAddress + exp->Name );
415 p = buffer + strlen(buffer);
416 if (p > buffer + 4 && !strcasecmp( p - 4, ".dll" )) p -= 4;
418 if ((name = find_exported_name( mod->BaseAddress, exp, ordinal + exp->Base )))
419 sprintf( p, ".%s", name );
421 sprintf( p, ".%ld", ordinal + exp->Base );
425 /***********************************************************************
428 static inline void RELAY_PrintArgs( int *args, int nb_args, unsigned int typemask )
432 if ((typemask & 3) && HIWORD(*args))
435 DPRINTF( "%08x %s", *args, debugstr_w((LPWSTR)*args) );
437 DPRINTF( "%08x %s", *args, debugstr_a((LPCSTR)*args) );
439 else DPRINTF( "%08x", *args );
440 if (nb_args) DPRINTF( "," );
447 typedef LONGLONG (*LONGLONG_CPROC)();
448 typedef LONGLONG (WINAPI *LONGLONG_FARPROC)();
451 /***********************************************************************
452 * call_cdecl_function
454 static LONGLONG call_cdecl_function( LONGLONG_CPROC func, int nb_args, const int *args )
459 case 0: ret = func(); break;
460 case 1: ret = func(args[0]); break;
461 case 2: ret = func(args[0],args[1]); break;
462 case 3: ret = func(args[0],args[1],args[2]); break;
463 case 4: ret = func(args[0],args[1],args[2],args[3]); break;
464 case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
465 case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
467 case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
469 case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
470 args[6],args[7]); break;
471 case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
472 args[6],args[7],args[8]); break;
473 case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
474 args[6],args[7],args[8],args[9]); break;
475 case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
476 args[6],args[7],args[8],args[9],args[10]); break;
477 case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
478 args[6],args[7],args[8],args[9],args[10],
480 case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
481 args[6],args[7],args[8],args[9],args[10],args[11],
483 case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
484 args[6],args[7],args[8],args[9],args[10],args[11],
485 args[12],args[13]); break;
486 case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
487 args[6],args[7],args[8],args[9],args[10],args[11],
488 args[12],args[13],args[14]); break;
489 case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
490 args[6],args[7],args[8],args[9],args[10],args[11],
491 args[12],args[13],args[14],args[15]); break;
493 ERR( "Unsupported nb of args %d\n", nb_args );
502 /***********************************************************************
503 * call_stdcall_function
505 static LONGLONG call_stdcall_function( LONGLONG_FARPROC func, int nb_args, const int *args )
510 case 0: ret = func(); break;
511 case 1: ret = func(args[0]); break;
512 case 2: ret = func(args[0],args[1]); break;
513 case 3: ret = func(args[0],args[1],args[2]); break;
514 case 4: ret = func(args[0],args[1],args[2],args[3]); break;
515 case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
516 case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
518 case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
520 case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
521 args[6],args[7]); break;
522 case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
523 args[6],args[7],args[8]); break;
524 case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
525 args[6],args[7],args[8],args[9]); break;
526 case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
527 args[6],args[7],args[8],args[9],args[10]); break;
528 case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
529 args[6],args[7],args[8],args[9],args[10],
531 case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
532 args[6],args[7],args[8],args[9],args[10],args[11],
534 case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
535 args[6],args[7],args[8],args[9],args[10],args[11],
536 args[12],args[13]); break;
537 case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
538 args[6],args[7],args[8],args[9],args[10],args[11],
539 args[12],args[13],args[14]); break;
540 case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
541 args[6],args[7],args[8],args[9],args[10],args[11],
542 args[12],args[13],args[14],args[15]); break;
544 ERR( "Unsupported nb of args %d\n", nb_args );
553 /***********************************************************************
556 * Stack layout on entry to this function:
561 * (esp) return addr to relay code
563 static LONGLONG RELAY_CallFrom32( int ret_addr, ... )
568 int *args = &ret_addr + 1;
569 /* Relay addr is the return address for this function */
570 BYTE *relay_addr = (BYTE *)__builtin_return_address(0);
571 DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
572 WORD nb_args = relay->args / sizeof(int);
576 get_entry_point( buffer, relay );
578 DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
579 RELAY_PrintArgs( args, nb_args, relay->argtypes );
580 DPRINTF( ") ret=%08x\n", ret_addr );
583 if (relay->ret == 0xc3) /* cdecl */
585 ret = call_cdecl_function( (LONGLONG_CPROC)relay->orig, nb_args, args );
589 ret = call_stdcall_function( (LONGLONG_FARPROC)relay->orig, nb_args, args );
594 BOOL ret64 = (relay->argtypes & 0x80000000) && (nb_args < 16);
596 DPRINTF( "%04lx:Ret %s() retval=%08x%08x ret=%08x\n",
597 GetCurrentThreadId(),
598 buffer, (UINT)(ret >> 32), (UINT)ret, ret_addr );
600 DPRINTF( "%04lx:Ret %s() retval=%08x ret=%08x\n",
601 GetCurrentThreadId(),
602 buffer, (UINT)ret, ret_addr );
608 /***********************************************************************
609 * RELAY_CallFrom32Regs
611 * Stack layout (esp is context->Esp, not the current %esp):
615 * (esp) return addr to caller
616 * (esp-4) return addr to DEBUG_ENTRY_POINT
617 * (esp-8) ptr to relay entry code for RELAY_CallFrom32Regs
618 * ... >128 bytes space free to be modified (ensured by the assembly glue)
620 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context )
627 BYTE *relay_addr = *((BYTE **)context->Esp - 1);
628 DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
629 WORD nb_args = relay->args / sizeof(int);
631 /* remove extra stuff from the stack */
632 context->Eip = *(DWORD *)context->Esp;
633 context->Esp += sizeof(DWORD);
634 args = (int *)context->Esp;
635 if (relay->ret == 0xc2) /* stdcall */
636 context->Esp += nb_args * sizeof(int);
638 entry_point = (BYTE *)relay->orig;
639 assert( *entry_point == 0xe8 /* lcall */ );
643 get_entry_point( buffer, relay );
645 DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
646 RELAY_PrintArgs( args, nb_args, relay->argtypes );
647 DPRINTF( ") ret=%08lx fs=%04lx\n", context->Eip, context->SegFs );
649 DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
650 context->Eax, context->Ebx, context->Ecx,
651 context->Edx, context->Esi, context->Edi );
652 DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
653 context->Ebp, context->Esp, context->SegDs,
654 context->SegEs, context->SegGs, context->EFlags );
657 /* Now call the real function */
659 memcpy( args_copy, args, nb_args * sizeof(args[0]) );
660 args_copy[nb_args] = (int)context; /* append context argument */
661 if (relay->ret == 0xc3) /* cdecl */
663 call_cdecl_function( *(LONGLONG_CPROC *)(entry_point + 5), nb_args+1, args_copy );
667 call_stdcall_function( *(LONGLONG_FARPROC *)(entry_point + 5), nb_args+1, args_copy );
672 DPRINTF( "%04lx:Ret %s() retval=%08lx ret=%08lx fs=%04lx\n",
673 GetCurrentThreadId(),
674 buffer, context->Eax, context->Eip, context->SegFs );
676 DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
677 context->Eax, context->Ebx, context->Ecx,
678 context->Edx, context->Esi, context->Edi );
679 DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
680 context->Ebp, context->Esp, context->SegDs,
681 context->SegEs, context->SegGs, context->EFlags );
685 void WINAPI RELAY_CallFrom32Regs(void);
686 __ASM_GLOBAL_FUNC( RELAY_CallFrom32Regs,
687 "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
688 ".long " __ASM_NAME("RELAY_DoCallFrom32Regs") ",0" );
691 /* check whether the function at addr starts with a call to __wine_call_from_32_regs */
692 static BOOL is_register_entry_point( const BYTE *addr )
694 extern void __wine_call_from_32_regs();
698 if (*addr != 0xe8) return FALSE; /* not a call */
699 /* check if call target is __wine_call_from_32_regs */
700 offset = (const int *)(addr + 1);
701 if (*offset == (const char *)__wine_call_from_32_regs - (const char *)(offset + 1)) return TRUE;
702 /* now check if call target is an import table jump to __wine_call_from_32_regs */
703 addr = (const BYTE *)(offset + 1) + *offset;
704 if (addr[0] != 0xff || addr[1] != 0x25) return FALSE; /* not an indirect jmp */
705 ptr = *(const void * const*)(addr + 2); /* get indirect jmp target address */
706 return (*(const char * const*)ptr == (char *)__wine_call_from_32_regs);
710 /***********************************************************************
711 * RELAY_GetProcAddress
713 * Return the proc address to use for a given function.
715 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
716 DWORD exp_size, FARPROC proc, const WCHAR *user )
718 const DEBUG_ENTRY_POINT *debug = (DEBUG_ENTRY_POINT *)proc;
719 const DEBUG_ENTRY_POINT *list = (const DEBUG_ENTRY_POINT *)((const char *)exports + exp_size);
721 if (debug < list || debug >= list + exports->NumberOfFunctions) return proc;
722 if (list + (debug - list) != debug) return proc; /* not a valid address */
723 if (check_from_module( debug_from_relay_includelist, debug_from_relay_excludelist, user ))
724 return proc; /* we want to relay it */
725 if (!debug->call) return proc; /* not a normal function */
726 if (debug->call != 0xe8 && debug->call != 0xe9) return proc; /* not a debug thunk at all */
731 /***********************************************************************
734 * Setup relay debugging for a built-in dll.
736 void RELAY_SetupDLL( HMODULE module )
738 IMAGE_EXPORT_DIRECTORY *exports;
739 DEBUG_ENTRY_POINT *debug;
743 char *p, dllname[80];
746 exports = RtlImageDirectoryEntryToData( module, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
747 if (!exports) return;
748 debug = (DEBUG_ENTRY_POINT *)((char *)exports + size);
749 funcs = (DWORD *)((char *)module + exports->AddressOfFunctions);
750 strcpy( dllname, (char *)module + exports->Name );
751 p = dllname + strlen(dllname) - 4;
752 if (p > dllname && !strcasecmp( p, ".dll" )) *p = 0;
754 for (i = 0; i < exports->NumberOfFunctions; i++, funcs++, debug++)
758 if (!debug->call) continue; /* not a normal function */
759 if (debug->call != 0xe8 && debug->call != 0xe9) break; /* not a debug thunk at all */
761 name = find_exported_name( module, exports, i + exports->Base );
762 on = check_relay_include( dllname, i + exports->Base, name );
766 debug->call = 0xe8; /* call relative */
767 if (is_register_entry_point( debug->orig ))
768 debug->callfrom32 = (char *)RELAY_CallFrom32Regs - (char *)&debug->ret;
770 debug->callfrom32 = (char *)RELAY_CallFrom32 - (char *)&debug->ret;
774 debug->call = 0xe9; /* jmp relative */
775 debug->callfrom32 = (char *)debug->orig - (char *)&debug->ret;
777 *funcs = (char *)debug - (char *)module;
782 /***********************************************************************
783 * SNOOP_ShowDebugmsgSnoop
785 * Simple function to decide if a particular debugging message is
788 static BOOL SNOOP_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
790 if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
792 if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
798 /***********************************************************************
801 * Setup snoop debugging for a native dll.
803 void SNOOP_SetupDLL(HMODULE hmod)
805 SNOOP_DLL **dll = &firstdll;
809 IMAGE_EXPORT_DIRECTORY *exports;
811 exports = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
812 if (!exports) return;
813 name = (char *)hmod + exports->Name;
815 TRACE_(snoop)("hmod=%p, name=%s\n", hmod, name);
818 if ((*dll)->hmod == hmod)
820 /* another dll, loaded at the same address */
822 size = (*dll)->nrofordinals * sizeof(SNOOP_FUN);
823 NtFreeVirtualMemory(NtCurrentProcess(), &addr, &size, MEM_RELEASE);
826 dll = &((*dll)->next);
829 *dll = RtlReAllocateHeap(GetProcessHeap(),
830 HEAP_ZERO_MEMORY, *dll,
831 sizeof(SNOOP_DLL) + strlen(name));
833 *dll = RtlAllocateHeap(GetProcessHeap(),
835 sizeof(SNOOP_DLL) + strlen(name));
837 (*dll)->ordbase = exports->Base;
838 (*dll)->nrofordinals = exports->NumberOfFunctions;
839 strcpy( (*dll)->name, name );
840 p = (*dll)->name + strlen((*dll)->name) - 4;
841 if (p > (*dll)->name && !strcasecmp( p, ".dll" )) *p = 0;
843 size = exports->NumberOfFunctions * sizeof(SNOOP_FUN);
845 NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size,
846 MEM_COMMIT | MEM_RESERVE, PAGE_EXECUTE_READWRITE);
848 RtlFreeHeap(GetProcessHeap(),0,*dll);
849 FIXME("out of memory\n");
853 memset((*dll)->funs,0,size);
857 /***********************************************************************
858 * SNOOP_GetProcAddress
860 * Return the proc address to use for a given function.
862 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports,
863 DWORD exp_size, FARPROC origfun, DWORD ordinal,
868 const WORD *ordinals;
870 SNOOP_DLL *dll = firstdll;
872 const IMAGE_SECTION_HEADER *sec;
874 if (!TRACE_ON(snoop)) return origfun;
875 if (!check_from_module( debug_from_snoop_includelist, debug_from_snoop_excludelist, user ))
876 return origfun; /* the calling module was explicitly excluded */
878 if (!*(LPBYTE)origfun) /* 0x00 is an imposs. opcode, poss. dataref. */
881 sec = RtlImageRvaToSection( RtlImageNtHeader(hmod), hmod, (char *)origfun - (char *)hmod );
883 if (!sec || !(sec->Characteristics & IMAGE_SCN_CNT_CODE))
884 return origfun; /* most likely a data reference */
887 if (hmod == dll->hmod)
891 if (!dll) /* probably internal */
894 /* try to find a name for it */
896 names = (const DWORD *)((const char *)hmod + exports->AddressOfNames);
897 ordinals = (const WORD *)((const char *)hmod + exports->AddressOfNameOrdinals);
898 if (names) for (i = 0; i < exports->NumberOfNames; i++)
900 if (ordinals[i] == ordinal)
902 ename = (const char *)hmod + names[i];
906 if (!SNOOP_ShowDebugmsgSnoop(dll->name,ordinal,ename))
908 assert(ordinal < dll->nrofordinals);
909 fun = dll->funs + ordinal;
914 /* NOTE: origreturn struct member MUST come directly after snoopentry */
915 fun->snoopentry = (char*)SNOOP_Entry-((char*)(&fun->nrofargs));
916 fun->origfun = origfun;
919 return (FARPROC)&(fun->lcall);
922 static void SNOOP_PrintArg(DWORD x)
927 if (!HIWORD(x) || TRACE_ON(seh)) return; /* trivial reject to avoid faults */
934 if (s[i]<0x20) {nostring=1;break;}
935 if (s[i]>=0x80) {nostring=1;break;}
938 if (!nostring && i > 5)
939 DPRINTF(" %s",debugstr_an((LPSTR)x,i));
940 else /* try unicode */
946 if (s[i]<0x20) {nostring=1;break;}
947 if (s[i]>0x100) {nostring=1;break;}
950 if (!nostring && i > 5) DPRINTF(" %s",debugstr_wn((LPWSTR)x,i));
959 #define CALLER1REF (*(DWORD*)context->Esp)
961 void WINAPI SNOOP_DoEntry( CONTEXT86 *context )
963 DWORD ordinal=0,entry = context->Eip - 5;
964 SNOOP_DLL *dll = firstdll;
965 SNOOP_FUN *fun = NULL;
966 SNOOP_RETURNENTRIES **rets = &firstrets;
967 SNOOP_RETURNENTRY *ret;
971 if ( ((char*)entry>=(char*)dll->funs) &&
972 ((char*)entry<=(char*)(dll->funs+dll->nrofordinals))
974 fun = (SNOOP_FUN*)entry;
975 ordinal = fun-dll->funs;
981 FIXME("entrypoint 0x%08lx not found\n",entry);
984 /* guess cdecl ... */
985 if (fun->nrofargs<0) {
986 /* Typical cdecl return frame is:
988 * which has (for xxxxxxxx up to 255 the opcode "83 C4 xx".
989 * (after that 81 C2 xx xx xx xx)
991 LPBYTE reteip = (LPBYTE)CALLER1REF;
994 if ((reteip[0]==0x83)&&(reteip[1]==0xc4))
995 fun->nrofargs=reteip[2]/4;
1001 for (i=0;i<sizeof((*rets)->entry)/sizeof((*rets)->entry[0]);i++)
1002 if (!(*rets)->entry[i].origreturn)
1004 if (i!=sizeof((*rets)->entry)/sizeof((*rets)->entry[0]))
1006 rets = &((*rets)->next);
1012 NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size,
1013 MEM_COMMIT | MEM_RESERVE,
1014 PAGE_EXECUTE_READWRITE);
1017 memset(*rets,0,4096);
1018 i = 0; /* entry 0 is free */
1020 ret = &((*rets)->entry[i]);
1022 /* NOTE: origreturn struct member MUST come directly after snoopret */
1023 ret->snoopret = ((char*)SNOOP_Return)-(char*)(&ret->origreturn);
1024 ret->origreturn = (FARPROC)CALLER1REF;
1025 CALLER1REF = (DWORD)&ret->lcall;
1028 ret->ordinal = ordinal;
1029 ret->origESP = context->Esp;
1031 context->Eip = (DWORD)fun->origfun;
1033 if (fun->name) DPRINTF("%04lx:CALL %s.%s(",GetCurrentThreadId(),dll->name,fun->name);
1034 else DPRINTF("%04lx:CALL %s.%ld(",GetCurrentThreadId(),dll->name,dll->ordbase+ordinal);
1035 if (fun->nrofargs>0) {
1036 max = fun->nrofargs; if (max>16) max=16;
1039 SNOOP_PrintArg(*(DWORD*)(context->Esp + 4 + sizeof(DWORD)*i));
1040 if (i<fun->nrofargs-1) DPRINTF(",");
1042 if (max!=fun->nrofargs)
1044 } else if (fun->nrofargs<0) {
1045 DPRINTF("<unknown, check return>");
1046 ret->args = RtlAllocateHeap(GetProcessHeap(),
1047 0,16*sizeof(DWORD));
1048 memcpy(ret->args,(LPBYTE)(context->Esp + 4),sizeof(DWORD)*16);
1050 DPRINTF(") ret=%08lx\n",(DWORD)ret->origreturn);
1054 void WINAPI SNOOP_DoReturn( CONTEXT86 *context )
1056 SNOOP_RETURNENTRY *ret = (SNOOP_RETURNENTRY*)(context->Eip - 5);
1057 SNOOP_FUN *fun = &ret->dll->funs[ret->ordinal];
1059 /* We haven't found out the nrofargs yet. If we called a cdecl
1060 * function it is too late anyway and we can just set '0' (which
1061 * will be the difference between orig and current ESP
1062 * If stdcall -> everything ok.
1064 if (ret->dll->funs[ret->ordinal].nrofargs<0)
1065 ret->dll->funs[ret->ordinal].nrofargs=(context->Esp - ret->origESP-4)/4;
1066 context->Eip = (DWORD)ret->origreturn;
1071 DPRINTF("%04lx:RET %s.%s(", GetCurrentThreadId(), ret->dll->name, fun->name);
1073 DPRINTF("%04lx:RET %s.%ld(", GetCurrentThreadId(),
1074 ret->dll->name,ret->dll->ordbase+ret->ordinal);
1076 max = fun->nrofargs;
1081 SNOOP_PrintArg(ret->args[i]);
1082 if (i<max-1) DPRINTF(",");
1084 DPRINTF(") retval=%08lx ret=%08lx\n",
1085 context->Eax,(DWORD)ret->origreturn );
1086 RtlFreeHeap(GetProcessHeap(),0,ret->args);
1092 DPRINTF("%04lx:RET %s.%s() retval=%08lx ret=%08lx\n",
1093 GetCurrentThreadId(),
1094 ret->dll->name, fun->name, context->Eax, (DWORD)ret->origreturn);
1096 DPRINTF("%04lx:RET %s.%ld() retval=%08lx ret=%08lx\n",
1097 GetCurrentThreadId(),
1098 ret->dll->name,ret->dll->ordbase+ret->ordinal,
1099 context->Eax, (DWORD)ret->origreturn);
1101 ret->origreturn = NULL; /* mark as empty */
1104 /* assembly wrappers that save the context */
1105 __ASM_GLOBAL_FUNC( SNOOP_Entry,
1106 "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1107 ".long " __ASM_NAME("SNOOP_DoEntry") ",0" );
1108 __ASM_GLOBAL_FUNC( SNOOP_Return,
1109 "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1110 ".long " __ASM_NAME("SNOOP_DoReturn") ",0" );
1112 #else /* __i386__ */
1114 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
1115 DWORD exp_size, FARPROC proc, const WCHAR *user )
1120 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
1121 FARPROC origfun, DWORD ordinal, const WCHAR *user )
1126 void RELAY_SetupDLL( HMODULE module )
1130 void SNOOP_SetupDLL( HMODULE hmod )
1132 FIXME("snooping works only on i386 for now.\n");
1135 #endif /* __i386__ */