Change the order of DispatchMessage and message removal.
[wine] / dlls / ntdll / relay.c
1 /*
2  * Win32 relay and snoop functions
3  *
4  * Copyright 1997 Alexandre Julliard
5  * Copyright 1998 Marcus Meissner
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "config.h"
23 #include "wine/port.h"
24
25 #include <assert.h>
26 #include <string.h>
27 #include <stdarg.h>
28 #include <stdio.h>
29
30 #include "windef.h"
31 #include "winbase.h"
32 #include "winreg.h"
33 #include "winternl.h"
34 #include "excpt.h"
35 #include "wine/exception.h"
36 #include "ntdll_misc.h"
37 #include "wine/unicode.h"
38 #include "wine/debug.h"
39
40 WINE_DEFAULT_DEBUG_CHANNEL(relay);
41 WINE_DECLARE_DEBUG_CHANNEL(snoop);
42 WINE_DECLARE_DEBUG_CHANNEL(seh);
43
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;
52
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 )
55 {
56     while (*strA && ((unsigned char)*strA == *strW)) { strA++; strW++; }
57     return (unsigned char)*strA - *strW;
58 }
59
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 )
62 {
63     int ret = 0;
64     for ( ; n > 0; n--, strA++, strW++)
65         if ((ret = toupperW((unsigned char)*strA) - toupperW(*strW)) || !*strA) break;
66     return ret;
67 }
68
69 /***********************************************************************
70  *           build_list
71  *
72  * Build a function list from a ';'-separated string.
73  */
74 static const WCHAR **build_list( const WCHAR *buffer )
75 {
76     int count = 1;
77     const WCHAR *p = buffer;
78     const WCHAR **ret;
79
80     while ((p = strchrW( p, ';' )))
81     {
82         count++;
83         p++;
84     }
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) )))
88     {
89         WCHAR *str = (WCHAR *)(ret + count + 1);
90         WCHAR *p = str;
91
92         strcpyW( str, buffer );
93         count = 0;
94         for (;;)
95         {
96             ret[count++] = p;
97             if (!(p = strchrW( p, ';' ))) break;
98             *p++ = 0;
99         }
100         ret[count++] = NULL;
101     }
102     return ret;
103 }
104
105
106 /***********************************************************************
107  *           RELAY_InitDebugLists
108  *
109  * Build the relay include/exclude function lists.
110  */
111 void RELAY_InitDebugLists(void)
112 {
113     OBJECT_ATTRIBUTES attr;
114     UNICODE_STRING name;
115     char buffer[1024];
116     HKEY hkey;
117     DWORD count;
118     WCHAR *str;
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};
133
134     attr.Length = sizeof(attr);
135     attr.RootDirectory = 0;
136     attr.ObjectName = &name;
137     attr.Attributes = 0;
138     attr.SecurityDescriptor = NULL;
139     attr.SecurityQualityOfService = NULL;
140     RtlInitUnicodeString( &name, configW );
141
142     if (NtOpenKey( &hkey, KEY_ALL_ACCESS, &attr )) return;
143
144     str = (WCHAR *)((KEY_VALUE_PARTIAL_INFORMATION *)buffer)->Data;
145     RtlInitUnicodeString( &name, RelayIncludeW );
146     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
147     {
148         TRACE("RelayInclude = %s\n", debugstr_w(str) );
149         debug_relay_includelist = build_list( str );
150     }
151
152     RtlInitUnicodeString( &name, RelayExcludeW );
153     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
154     {
155         TRACE( "RelayExclude = %s\n", debugstr_w(str) );
156         debug_relay_excludelist = build_list( str );
157     }
158
159     RtlInitUnicodeString( &name, SnoopIncludeW );
160     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
161     {
162         TRACE_(snoop)( "SnoopInclude = %s\n", debugstr_w(str) );
163         debug_snoop_includelist = build_list( str );
164     }
165
166     RtlInitUnicodeString( &name, SnoopExcludeW );
167     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
168     {
169         TRACE_(snoop)( "SnoopExclude = %s\n", debugstr_w(str) );
170         debug_snoop_excludelist = build_list( str );
171     }
172
173     RtlInitUnicodeString( &name, RelayFromIncludeW );
174     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
175     {
176         TRACE("RelayFromInclude = %s\n", debugstr_w(str) );
177         debug_from_relay_includelist = build_list( str );
178     }
179
180     RtlInitUnicodeString( &name, RelayFromExcludeW );
181     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
182     {
183         TRACE( "RelayFromExclude = %s\n", debugstr_w(str) );
184         debug_from_relay_excludelist = build_list( str );
185     }
186
187     RtlInitUnicodeString( &name, SnoopFromIncludeW );
188     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
189     {
190         TRACE_(snoop)("SnoopFromInclude = %s\n", debugstr_w(str) );
191         debug_from_snoop_includelist = build_list( str );
192     }
193
194     RtlInitUnicodeString( &name, SnoopFromExcludeW );
195     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
196     {
197         TRACE_(snoop)( "SnoopFromExclude = %s\n", debugstr_w(str) );
198         debug_from_snoop_excludelist = build_list( str );
199     }
200
201     NtClose( hkey );
202 }
203
204
205 #ifdef __i386__
206
207 #include "pshpack1.h"
208
209 typedef struct
210 {
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 */
217 } DEBUG_ENTRY_POINT;
218
219 typedef struct
220 {
221         /* code part */
222         BYTE            lcall;          /* 0xe8 call snoopentry (relative) */
223         /* NOTE: If you move snoopentry OR nrofargs fix the relative offset
224          * calculation!
225          */
226         DWORD           snoopentry;     /* SNOOP_Entry relative */
227         /* unreached */
228         int             nrofargs;
229         FARPROC origfun;
230         const char *name;
231 } SNOOP_FUN;
232
233 typedef struct tagSNOOP_DLL {
234         HMODULE hmod;
235         SNOOP_FUN       *funs;
236         DWORD           ordbase;
237         DWORD           nrofordinals;
238         struct tagSNOOP_DLL     *next;
239         char name[1];
240 } SNOOP_DLL;
241
242 typedef struct
243 {
244         /* code part */
245         BYTE            lcall;          /* 0xe8 call snoopret relative*/
246         /* NOTE: If you move snoopret OR origreturn fix the relative offset
247          * calculation!
248          */
249         DWORD           snoopret;       /* SNOOP_Ret relative */
250         /* unreached */
251         FARPROC origreturn;
252         SNOOP_DLL       *dll;
253         DWORD           ordinal;
254         DWORD           origESP;
255         DWORD           *args;          /* saved args across a stdcall */
256 } SNOOP_RETURNENTRY;
257
258 typedef struct tagSNOOP_RETURNENTRIES {
259         SNOOP_RETURNENTRY entry[4092/sizeof(SNOOP_RETURNENTRY)];
260         struct tagSNOOP_RETURNENTRIES   *next;
261 } SNOOP_RETURNENTRIES;
262
263 #include "poppack.h"
264
265 extern void WINAPI SNOOP_Entry();
266 extern void WINAPI SNOOP_Return();
267
268 static SNOOP_DLL *firstdll;
269 static SNOOP_RETURNENTRIES *firstrets;
270
271 static WINE_EXCEPTION_FILTER(page_fault)
272 {
273     if (GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ||
274         GetExceptionCode() == EXCEPTION_PRIV_INSTRUCTION)
275         return EXCEPTION_EXECUTE_HANDLER;
276     return EXCEPTION_CONTINUE_SEARCH;
277 }
278
279 /***********************************************************************
280  *           check_list
281  *
282  * Check if a given module and function is in the list.
283  */
284 static BOOL check_list( const char *module, int ordinal, const char *func, const WCHAR **list )
285 {
286     char ord_str[10];
287
288     sprintf( ord_str, "%d", ordinal );
289     for(; *list; list++)
290     {
291         const WCHAR *p = strrchrW( *list, '.' );
292         if (p && p > *list)  /* check module and function */
293         {
294             int len = p - *list;
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;
299         }
300         else  /* function only */
301         {
302             if (func && !strcmpAW( func, *list )) return TRUE;
303         }
304     }
305     return FALSE;
306 }
307
308
309 /***********************************************************************
310  *           check_relay_include
311  *
312  * Check if a given function must be included in the relay output.
313  */
314 static BOOL check_relay_include( const char *module, int ordinal, const char *func )
315 {
316     if (debug_relay_excludelist && check_list( module, ordinal, func, debug_relay_excludelist ))
317         return FALSE;
318     if (debug_relay_includelist && !check_list( module, ordinal, func, debug_relay_includelist ))
319         return FALSE;
320     return TRUE;
321 }
322
323 /***********************************************************************
324  *           check_from_module
325  *
326  * Check if calls from a given module must be included in the relay/snoop output,
327  * given the exclusion and inclusion lists.
328  */
329 static BOOL check_from_module( const WCHAR **includelist, const WCHAR **excludelist, const WCHAR *module )
330 {
331     static const WCHAR dllW[] = {'.','d','l','l',0 };
332     const WCHAR **listitem;
333     BOOL show;
334
335     if (!module) return TRUE;
336     if (!includelist && !excludelist) return TRUE;
337     if (excludelist)
338     {
339         show = TRUE;
340         listitem = excludelist;
341     }
342     else
343     {
344         show = FALSE;
345         listitem = includelist;
346     }
347     for(; *listitem; listitem++)
348     {
349         int len;
350
351         if (!strcmpiW( *listitem, module )) return !show;
352         len = strlenW( *listitem );
353         if (!strncmpiW( *listitem, module, len ) && !strcmpiW( module + len, dllW ))
354             return !show;
355     }
356     return show;
357 }
358
359 /***********************************************************************
360  *           find_exported_name
361  *
362  * Find the name of an exported function.
363  */
364 static const char *find_exported_name( HMODULE module,
365                                        IMAGE_EXPORT_DIRECTORY *exp, int ordinal )
366 {
367     unsigned int i;
368     const char *ret = NULL;
369
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];
375     return ret;
376 }
377
378
379 /***********************************************************************
380  *           get_entry_point
381  *
382  * Get the name of the DLL entry point corresponding to a relay address.
383  */
384 static void get_entry_point( char *buffer, DEBUG_ENTRY_POINT *relay )
385 {
386     IMAGE_EXPORT_DIRECTORY *exp = NULL;
387     DEBUG_ENTRY_POINT *debug;
388     char *p;
389     const char *name;
390     int ordinal = 0;
391     PLIST_ENTRY mark, entry;
392     PLDR_MODULE mod = NULL;
393     DWORD size;
394
395     /* First find the module */
396
397     mark = &NtCurrentTeb()->Peb->LdrData->InLoadOrderModuleList;
398     for (entry = mark->Flink; entry != mark; entry = entry->Flink)
399     {
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 );
403         if (!exp) continue;
404         debug = (DEBUG_ENTRY_POINT *)((char *)exp + size);
405         if (debug <= relay && relay < debug + exp->NumberOfFunctions)
406         {
407             ordinal = relay - debug;
408             break;
409         }
410     }
411
412     /* Now find the function */
413
414     strcpy( buffer, (char *)mod->BaseAddress + exp->Name );
415     p = buffer + strlen(buffer);
416     if (p > buffer + 4 && !strcasecmp( p - 4, ".dll" )) p -= 4;
417
418     if ((name = find_exported_name( mod->BaseAddress, exp, ordinal + exp->Base )))
419         sprintf( p, ".%s", name );
420     else
421         sprintf( p, ".%ld", ordinal + exp->Base );
422 }
423
424
425 /***********************************************************************
426  *           RELAY_PrintArgs
427  */
428 static inline void RELAY_PrintArgs( int *args, int nb_args, unsigned int typemask )
429 {
430     while (nb_args--)
431     {
432         if ((typemask & 3) && HIWORD(*args))
433         {
434             if (typemask & 2)
435                 DPRINTF( "%08x %s", *args, debugstr_w((LPWSTR)*args) );
436             else
437                 DPRINTF( "%08x %s", *args, debugstr_a((LPCSTR)*args) );
438         }
439         else DPRINTF( "%08x", *args );
440         if (nb_args) DPRINTF( "," );
441         args++;
442         typemask >>= 2;
443     }
444 }
445
446
447 typedef LONGLONG (*LONGLONG_CPROC)();
448 typedef LONGLONG (WINAPI *LONGLONG_FARPROC)();
449
450
451 /***********************************************************************
452  *           call_cdecl_function
453  */
454 static LONGLONG call_cdecl_function( LONGLONG_CPROC func, int nb_args, const int *args )
455 {
456     LONGLONG ret;
457     switch(nb_args)
458     {
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],
466                        args[5]); break;
467     case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
468                        args[6]); break;
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],
479                         args[11]); break;
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],
482                         args[12]); break;
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;
492     case 17: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
493                         args[6],args[7],args[8],args[9],args[10],args[11],
494                         args[12],args[13],args[14],args[15],args[16]); break;
495     case 18: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
496                         args[6],args[7],args[8],args[9],args[10],args[11],
497                         args[12],args[13],args[14],args[15],args[16],
498                         args[17]); break;
499     default:
500         ERR( "Unsupported nb of args %d\n", nb_args );
501         assert(FALSE);
502         ret = 0;
503         break;
504     }
505     return ret;
506 }
507
508
509 /***********************************************************************
510  *           call_stdcall_function
511  */
512 static LONGLONG call_stdcall_function( LONGLONG_FARPROC func, int nb_args, const int *args )
513 {
514     LONGLONG ret;
515     switch(nb_args)
516     {
517     case 0: ret = func(); break;
518     case 1: ret = func(args[0]); break;
519     case 2: ret = func(args[0],args[1]); break;
520     case 3: ret = func(args[0],args[1],args[2]); break;
521     case 4: ret = func(args[0],args[1],args[2],args[3]); break;
522     case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
523     case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
524                        args[5]); break;
525     case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
526                        args[6]); break;
527     case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
528                        args[6],args[7]); break;
529     case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
530                        args[6],args[7],args[8]); break;
531     case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
532                         args[6],args[7],args[8],args[9]); break;
533     case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
534                         args[6],args[7],args[8],args[9],args[10]); break;
535     case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
536                         args[6],args[7],args[8],args[9],args[10],
537                         args[11]); break;
538     case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
539                         args[6],args[7],args[8],args[9],args[10],args[11],
540                         args[12]); break;
541     case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
542                         args[6],args[7],args[8],args[9],args[10],args[11],
543                         args[12],args[13]); break;
544     case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
545                         args[6],args[7],args[8],args[9],args[10],args[11],
546                         args[12],args[13],args[14]); break;
547     case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
548                         args[6],args[7],args[8],args[9],args[10],args[11],
549                         args[12],args[13],args[14],args[15]); break;
550     case 17: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
551                         args[6],args[7],args[8],args[9],args[10],args[11],
552                         args[12],args[13],args[14],args[15],args[16]); break;
553     case 18: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
554                         args[6],args[7],args[8],args[9],args[10],args[11],
555                         args[12],args[13],args[14],args[15],args[16],
556                         args[17]); break;
557     default:
558         ERR( "Unsupported nb of args %d\n", nb_args );
559         assert(FALSE);
560         ret = 0;
561         break;
562     }
563     return ret;
564 }
565
566
567 /***********************************************************************
568  *           RELAY_CallFrom32
569  *
570  * Stack layout on entry to this function:
571  *  ...      ...
572  * (esp+12)  arg2
573  * (esp+8)   arg1
574  * (esp+4)   ret_addr
575  * (esp)     return addr to relay code
576  */
577 static LONGLONG RELAY_CallFrom32( int ret_addr, ... )
578 {
579     LONGLONG ret;
580     char buffer[80];
581
582     int *args = &ret_addr + 1;
583     /* Relay addr is the return address for this function */
584     BYTE *relay_addr = (BYTE *)__builtin_return_address(0);
585     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
586     WORD nb_args = relay->args / sizeof(int);
587
588     if (TRACE_ON(relay))
589     {
590         get_entry_point( buffer, relay );
591
592         DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
593         RELAY_PrintArgs( args, nb_args, relay->argtypes );
594         DPRINTF( ") ret=%08x\n", ret_addr );
595     }
596
597     if (relay->ret == 0xc3) /* cdecl */
598     {
599         ret = call_cdecl_function( (LONGLONG_CPROC)relay->orig, nb_args, args );
600     }
601     else  /* stdcall */
602     {
603         ret = call_stdcall_function( (LONGLONG_FARPROC)relay->orig, nb_args, args );
604     }
605
606     if (TRACE_ON(relay))
607     {
608         BOOL ret64 = (relay->argtypes & 0x80000000) && (nb_args < 16);
609         if (ret64)
610             DPRINTF( "%04lx:Ret  %s() retval=%08x%08x ret=%08x\n",
611                      GetCurrentThreadId(),
612                      buffer, (UINT)(ret >> 32), (UINT)ret, ret_addr );
613         else
614             DPRINTF( "%04lx:Ret  %s() retval=%08x ret=%08x\n",
615                      GetCurrentThreadId(),
616                      buffer, (UINT)ret, ret_addr );
617     }
618     return ret;
619 }
620
621
622 /***********************************************************************
623  *           RELAY_CallFrom32Regs
624  *
625  * Stack layout (esp is context->Esp, not the current %esp):
626  *
627  * ...
628  * (esp+4) first arg
629  * (esp)   return addr to caller
630  * (esp-4) return addr to DEBUG_ENTRY_POINT
631  * (esp-8) ptr to relay entry code for RELAY_CallFrom32Regs
632  *  ...    >128 bytes space free to be modified (ensured by the assembly glue)
633  */
634 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context )
635 {
636     char buffer[80];
637     int* args;
638     int args_copy[17];
639     BYTE *entry_point;
640
641     BYTE *relay_addr = *((BYTE **)context->Esp - 1);
642     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
643     WORD nb_args = relay->args / sizeof(int);
644
645     /* remove extra stuff from the stack */
646     context->Eip = *(DWORD *)context->Esp;
647     context->Esp += sizeof(DWORD);
648     args = (int *)context->Esp;
649     if (relay->ret == 0xc2) /* stdcall */
650         context->Esp += nb_args * sizeof(int);
651
652     entry_point = (BYTE *)relay->orig;
653     assert( *entry_point == 0xe8 /* lcall */ );
654
655     if (TRACE_ON(relay))
656     {
657         get_entry_point( buffer, relay );
658
659         DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
660         RELAY_PrintArgs( args, nb_args, relay->argtypes );
661         DPRINTF( ") ret=%08lx fs=%04lx\n", context->Eip, context->SegFs );
662
663         DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
664                 context->Eax, context->Ebx, context->Ecx,
665                 context->Edx, context->Esi, context->Edi );
666         DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
667                 context->Ebp, context->Esp, context->SegDs,
668                 context->SegEs, context->SegGs, context->EFlags );
669     }
670
671     /* Now call the real function */
672
673     memcpy( args_copy, args, nb_args * sizeof(args[0]) );
674     args_copy[nb_args] = (int)context;  /* append context argument */
675     if (relay->ret == 0xc3) /* cdecl */
676     {
677         call_cdecl_function( *(LONGLONG_CPROC *)(entry_point + 5), nb_args+1, args_copy );
678     }
679     else  /* stdcall */
680     {
681         call_stdcall_function( *(LONGLONG_FARPROC *)(entry_point + 5), nb_args+1, args_copy );
682     }
683
684     if (TRACE_ON(relay))
685     {
686         DPRINTF( "%04lx:Ret  %s() retval=%08lx ret=%08lx fs=%04lx\n",
687                  GetCurrentThreadId(),
688                  buffer, context->Eax, context->Eip, context->SegFs );
689
690         DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
691                 context->Eax, context->Ebx, context->Ecx,
692                 context->Edx, context->Esi, context->Edi );
693         DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
694                 context->Ebp, context->Esp, context->SegDs,
695                 context->SegEs, context->SegGs, context->EFlags );
696     }
697 }
698
699 void WINAPI RELAY_CallFrom32Regs(void);
700 __ASM_GLOBAL_FUNC( RELAY_CallFrom32Regs,
701                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
702                    ".long " __ASM_NAME("RELAY_DoCallFrom32Regs") ",0" );
703
704
705 /* check whether the function at addr starts with a call to __wine_call_from_32_regs */
706 static BOOL is_register_entry_point( const BYTE *addr )
707 {
708     extern void __wine_call_from_32_regs();
709     const int *offset;
710     const void *ptr;
711
712     if (*addr != 0xe8) return FALSE;  /* not a call */
713     /* check if call target is __wine_call_from_32_regs */
714     offset = (const int *)(addr + 1);
715     if (*offset == (const char *)__wine_call_from_32_regs - (const char *)(offset + 1)) return TRUE;
716     /* now check if call target is an import table jump to __wine_call_from_32_regs */
717     addr = (const BYTE *)(offset + 1) + *offset;
718     if (addr[0] != 0xff || addr[1] != 0x25) return FALSE;  /* not an indirect jmp */
719     ptr = *(const void * const*)(addr + 2);  /* get indirect jmp target address */
720     return (*(const char * const*)ptr == (char *)__wine_call_from_32_regs);
721 }
722
723
724 /***********************************************************************
725  *           RELAY_GetProcAddress
726  *
727  * Return the proc address to use for a given function.
728  */
729 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
730                               DWORD exp_size, FARPROC proc, const WCHAR *user )
731 {
732     const DEBUG_ENTRY_POINT *debug = (DEBUG_ENTRY_POINT *)proc;
733     const DEBUG_ENTRY_POINT *list = (const DEBUG_ENTRY_POINT *)((const char *)exports + exp_size);
734
735     if (debug < list || debug >= list + exports->NumberOfFunctions) return proc;
736     if (list + (debug - list) != debug) return proc;  /* not a valid address */
737     if (check_from_module( debug_from_relay_includelist, debug_from_relay_excludelist, user ))
738        return proc;  /* we want to relay it */
739     if (!debug->call) return proc;  /* not a normal function */
740     if (debug->call != 0xe8 && debug->call != 0xe9) return proc; /* not a debug thunk at all */
741     return debug->orig;
742 }
743
744
745 /***********************************************************************
746  *           RELAY_SetupDLL
747  *
748  * Setup relay debugging for a built-in dll.
749  */
750 void RELAY_SetupDLL( HMODULE module )
751 {
752     IMAGE_EXPORT_DIRECTORY *exports;
753     DEBUG_ENTRY_POINT *debug;
754     DWORD *funcs;
755     unsigned int i;
756     const char *name;
757     char *p, dllname[80];
758     DWORD size;
759
760     exports = RtlImageDirectoryEntryToData( module, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
761     if (!exports) return;
762     debug = (DEBUG_ENTRY_POINT *)((char *)exports + size);
763     funcs = (DWORD *)((char *)module + exports->AddressOfFunctions);
764     strcpy( dllname, (char *)module + exports->Name );
765     p = dllname + strlen(dllname) - 4;
766     if (p > dllname && !strcasecmp( p, ".dll" )) *p = 0;
767
768     for (i = 0; i < exports->NumberOfFunctions; i++, funcs++, debug++)
769     {
770         int on = 1;
771
772         if (!debug->call) continue;  /* not a normal function */
773         if (debug->call != 0xe8 && debug->call != 0xe9) break; /* not a debug thunk at all */
774
775         name = find_exported_name( module, exports, i + exports->Base );
776         on = check_relay_include( dllname, i + exports->Base, name );
777
778         if (on)
779         {
780             debug->call = 0xe8;  /* call relative */
781             if (is_register_entry_point( debug->orig ))
782                 debug->callfrom32 = (char *)RELAY_CallFrom32Regs - (char *)&debug->ret;
783             else
784                 debug->callfrom32 = (char *)RELAY_CallFrom32 - (char *)&debug->ret;
785         }
786         else
787         {
788             debug->call = 0xe9;  /* jmp relative */
789             debug->callfrom32 = (char *)debug->orig - (char *)&debug->ret;
790         }
791         *funcs = (char *)debug - (char *)module;
792     }
793 }
794
795
796 /***********************************************************************
797  *          SNOOP_ShowDebugmsgSnoop
798  *
799  * Simple function to decide if a particular debugging message is
800  * wanted.
801  */
802 static BOOL SNOOP_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
803 {
804     if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
805         return FALSE;
806     if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
807         return FALSE;
808     return TRUE;
809 }
810
811
812 /***********************************************************************
813  *           SNOOP_SetupDLL
814  *
815  * Setup snoop debugging for a native dll.
816  */
817 void SNOOP_SetupDLL(HMODULE hmod)
818 {
819     SNOOP_DLL **dll = &firstdll;
820     char *p, *name;
821     void *addr;
822     SIZE_T size;
823     IMAGE_EXPORT_DIRECTORY *exports;
824
825     exports = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
826     if (!exports) return;
827     name = (char *)hmod + exports->Name;
828
829     TRACE_(snoop)("hmod=%p, name=%s\n", hmod, name);
830
831     while (*dll) {
832         if ((*dll)->hmod == hmod)
833         {
834             /* another dll, loaded at the same address */
835             addr = (*dll)->funs;
836             size = (*dll)->nrofordinals * sizeof(SNOOP_FUN);
837             NtFreeVirtualMemory(NtCurrentProcess(), &addr, &size, MEM_RELEASE);
838             break;
839         }
840         dll = &((*dll)->next);
841     }
842     if (*dll)
843         *dll = RtlReAllocateHeap(GetProcessHeap(),
844                              HEAP_ZERO_MEMORY, *dll,
845                              sizeof(SNOOP_DLL) + strlen(name));
846     else
847         *dll = RtlAllocateHeap(GetProcessHeap(),
848                              HEAP_ZERO_MEMORY,
849                              sizeof(SNOOP_DLL) + strlen(name));
850     (*dll)->hmod        = hmod;
851     (*dll)->ordbase = exports->Base;
852     (*dll)->nrofordinals = exports->NumberOfFunctions;
853     strcpy( (*dll)->name, name );
854     p = (*dll)->name + strlen((*dll)->name) - 4;
855     if (p > (*dll)->name && !strcasecmp( p, ".dll" )) *p = 0;
856
857     size = exports->NumberOfFunctions * sizeof(SNOOP_FUN);
858     addr = NULL;
859     NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size,
860                             MEM_COMMIT | MEM_RESERVE, PAGE_EXECUTE_READWRITE);
861     if (!addr) {
862         RtlFreeHeap(GetProcessHeap(),0,*dll);
863         FIXME("out of memory\n");
864         return;
865     }
866     (*dll)->funs = addr;
867     memset((*dll)->funs,0,size);
868 }
869
870
871 /***********************************************************************
872  *           SNOOP_GetProcAddress
873  *
874  * Return the proc address to use for a given function.
875  */
876 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports,
877                               DWORD exp_size, FARPROC origfun, DWORD ordinal,
878                               const WCHAR *user)
879 {
880     unsigned int i;
881     const char *ename;
882     const WORD *ordinals;
883     const DWORD *names;
884     SNOOP_DLL *dll = firstdll;
885     SNOOP_FUN *fun;
886     const IMAGE_SECTION_HEADER *sec;
887
888     if (!TRACE_ON(snoop)) return origfun;
889     if (!check_from_module( debug_from_snoop_includelist, debug_from_snoop_excludelist, user ))
890         return origfun; /* the calling module was explicitly excluded */
891
892     if (!*(LPBYTE)origfun) /* 0x00 is an imposs. opcode, poss. dataref. */
893         return origfun;
894
895     sec = RtlImageRvaToSection( RtlImageNtHeader(hmod), hmod, (char *)origfun - (char *)hmod );
896
897     if (!sec || !(sec->Characteristics & IMAGE_SCN_CNT_CODE))
898         return origfun;  /* most likely a data reference */
899
900     while (dll) {
901         if (hmod == dll->hmod)
902             break;
903         dll = dll->next;
904     }
905     if (!dll)   /* probably internal */
906         return origfun;
907
908     /* try to find a name for it */
909     ename = NULL;
910     names = (const DWORD *)((const char *)hmod + exports->AddressOfNames);
911     ordinals = (const WORD *)((const char *)hmod + exports->AddressOfNameOrdinals);
912     if (names) for (i = 0; i < exports->NumberOfNames; i++)
913     {
914         if (ordinals[i] == ordinal)
915         {
916             ename = (const char *)hmod + names[i];
917             break;
918         }
919     }
920     if (!SNOOP_ShowDebugmsgSnoop(dll->name,ordinal,ename))
921         return origfun;
922     assert(ordinal < dll->nrofordinals);
923     fun = dll->funs + ordinal;
924     if (!fun->name)
925     {
926         fun->name       = ename;
927         fun->lcall      = 0xe8;
928         /* NOTE: origreturn struct member MUST come directly after snoopentry */
929         fun->snoopentry = (char*)SNOOP_Entry-((char*)(&fun->nrofargs));
930         fun->origfun    = origfun;
931         fun->nrofargs   = -1;
932     }
933     return (FARPROC)&(fun->lcall);
934 }
935
936 static void SNOOP_PrintArg(DWORD x)
937 {
938     int i,nostring;
939
940     DPRINTF("%08lx",x);
941     if (!HIWORD(x) || TRACE_ON(seh)) return; /* trivial reject to avoid faults */
942     __TRY
943     {
944         LPBYTE s=(LPBYTE)x;
945         i=0;nostring=0;
946         while (i<80) {
947             if (s[i]==0) break;
948             if (s[i]<0x20) {nostring=1;break;}
949             if (s[i]>=0x80) {nostring=1;break;}
950             i++;
951         }
952         if (!nostring && i > 5)
953             DPRINTF(" %s",debugstr_an((LPSTR)x,i));
954         else  /* try unicode */
955         {
956             LPWSTR s=(LPWSTR)x;
957             i=0;nostring=0;
958             while (i<80) {
959                 if (s[i]==0) break;
960                 if (s[i]<0x20) {nostring=1;break;}
961                 if (s[i]>0x100) {nostring=1;break;}
962                 i++;
963             }
964             if (!nostring && i > 5) DPRINTF(" %s",debugstr_wn((LPWSTR)x,i));
965         }
966     }
967     __EXCEPT(page_fault)
968     {
969     }
970     __ENDTRY
971 }
972
973 #define CALLER1REF (*(DWORD*)context->Esp)
974
975 void WINAPI SNOOP_DoEntry( CONTEXT86 *context )
976 {
977         DWORD           ordinal=0,entry = context->Eip - 5;
978         SNOOP_DLL       *dll = firstdll;
979         SNOOP_FUN       *fun = NULL;
980         SNOOP_RETURNENTRIES     **rets = &firstrets;
981         SNOOP_RETURNENTRY       *ret;
982         int             i=0, max;
983
984         while (dll) {
985                 if (    ((char*)entry>=(char*)dll->funs)        &&
986                         ((char*)entry<=(char*)(dll->funs+dll->nrofordinals))
987                 ) {
988                         fun = (SNOOP_FUN*)entry;
989                         ordinal = fun-dll->funs;
990                         break;
991                 }
992                 dll=dll->next;
993         }
994         if (!dll) {
995                 FIXME("entrypoint 0x%08lx not found\n",entry);
996                 return; /* oops */
997         }
998         /* guess cdecl ... */
999         if (fun->nrofargs<0) {
1000                 /* Typical cdecl return frame is:
1001                  *     add esp, xxxxxxxx
1002                  * which has (for xxxxxxxx up to 255 the opcode "83 C4 xx".
1003                  * (after that 81 C2 xx xx xx xx)
1004                  */
1005                 LPBYTE  reteip = (LPBYTE)CALLER1REF;
1006
1007                 if (reteip) {
1008                         if ((reteip[0]==0x83)&&(reteip[1]==0xc4))
1009                                 fun->nrofargs=reteip[2]/4;
1010                 }
1011         }
1012
1013
1014         while (*rets) {
1015                 for (i=0;i<sizeof((*rets)->entry)/sizeof((*rets)->entry[0]);i++)
1016                         if (!(*rets)->entry[i].origreturn)
1017                                 break;
1018                 if (i!=sizeof((*rets)->entry)/sizeof((*rets)->entry[0]))
1019                         break;
1020                 rets = &((*rets)->next);
1021         }
1022         if (!*rets) {
1023                 SIZE_T size = 4096;
1024                 VOID* addr = NULL;
1025
1026                 NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size, 
1027                                         MEM_COMMIT | MEM_RESERVE,
1028                                         PAGE_EXECUTE_READWRITE);
1029                 if (!addr) return;
1030                 *rets = addr;
1031                 memset(*rets,0,4096);
1032                 i = 0;  /* entry 0 is free */
1033         }
1034         ret = &((*rets)->entry[i]);
1035         ret->lcall      = 0xe8;
1036         /* NOTE: origreturn struct member MUST come directly after snoopret */
1037         ret->snoopret   = ((char*)SNOOP_Return)-(char*)(&ret->origreturn);
1038         ret->origreturn = (FARPROC)CALLER1REF;
1039         CALLER1REF      = (DWORD)&ret->lcall;
1040         ret->dll        = dll;
1041         ret->args       = NULL;
1042         ret->ordinal    = ordinal;
1043         ret->origESP    = context->Esp;
1044
1045         context->Eip = (DWORD)fun->origfun;
1046
1047         if (fun->name) DPRINTF("%04lx:CALL %s.%s(",GetCurrentThreadId(),dll->name,fun->name);
1048         else DPRINTF("%04lx:CALL %s.%ld(",GetCurrentThreadId(),dll->name,dll->ordbase+ordinal);
1049         if (fun->nrofargs>0) {
1050                 max = fun->nrofargs; if (max>16) max=16;
1051                 for (i=0;i<max;i++)
1052                 {
1053                     SNOOP_PrintArg(*(DWORD*)(context->Esp + 4 + sizeof(DWORD)*i));
1054                     if (i<fun->nrofargs-1) DPRINTF(",");
1055                 }
1056                 if (max!=fun->nrofargs)
1057                         DPRINTF(" ...");
1058         } else if (fun->nrofargs<0) {
1059                 DPRINTF("<unknown, check return>");
1060                 ret->args = RtlAllocateHeap(GetProcessHeap(),
1061                                             0,16*sizeof(DWORD));
1062                 memcpy(ret->args,(LPBYTE)(context->Esp + 4),sizeof(DWORD)*16);
1063         }
1064         DPRINTF(") ret=%08lx\n",(DWORD)ret->origreturn);
1065 }
1066
1067
1068 void WINAPI SNOOP_DoReturn( CONTEXT86 *context )
1069 {
1070         SNOOP_RETURNENTRY       *ret = (SNOOP_RETURNENTRY*)(context->Eip - 5);
1071         SNOOP_FUN *fun = &ret->dll->funs[ret->ordinal];
1072
1073         /* We haven't found out the nrofargs yet. If we called a cdecl
1074          * function it is too late anyway and we can just set '0' (which
1075          * will be the difference between orig and current ESP
1076          * If stdcall -> everything ok.
1077          */
1078         if (ret->dll->funs[ret->ordinal].nrofargs<0)
1079                 ret->dll->funs[ret->ordinal].nrofargs=(context->Esp - ret->origESP-4)/4;
1080         context->Eip = (DWORD)ret->origreturn;
1081         if (ret->args) {
1082                 int     i,max;
1083
1084                 if (fun->name)
1085                     DPRINTF("%04lx:RET  %s.%s(", GetCurrentThreadId(), ret->dll->name, fun->name);
1086                 else
1087                     DPRINTF("%04lx:RET  %s.%ld(", GetCurrentThreadId(),
1088                             ret->dll->name,ret->dll->ordbase+ret->ordinal);
1089
1090                 max = fun->nrofargs;
1091                 if (max>16) max=16;
1092
1093                 for (i=0;i<max;i++)
1094                 {
1095                     SNOOP_PrintArg(ret->args[i]);
1096                     if (i<max-1) DPRINTF(",");
1097                 }
1098                 DPRINTF(") retval=%08lx ret=%08lx\n",
1099                         context->Eax,(DWORD)ret->origreturn );
1100                 RtlFreeHeap(GetProcessHeap(),0,ret->args);
1101                 ret->args = NULL;
1102         }
1103         else
1104         {
1105             if (fun->name)
1106                 DPRINTF("%04lx:RET  %s.%s() retval=%08lx ret=%08lx\n",
1107                         GetCurrentThreadId(),
1108                         ret->dll->name, fun->name, context->Eax, (DWORD)ret->origreturn);
1109             else
1110                 DPRINTF("%04lx:RET  %s.%ld() retval=%08lx ret=%08lx\n",
1111                         GetCurrentThreadId(),
1112                         ret->dll->name,ret->dll->ordbase+ret->ordinal,
1113                         context->Eax, (DWORD)ret->origreturn);
1114         }
1115         ret->origreturn = NULL; /* mark as empty */
1116 }
1117
1118 /* assembly wrappers that save the context */
1119 __ASM_GLOBAL_FUNC( SNOOP_Entry,
1120                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1121                    ".long " __ASM_NAME("SNOOP_DoEntry") ",0" );
1122 __ASM_GLOBAL_FUNC( SNOOP_Return,
1123                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1124                    ".long " __ASM_NAME("SNOOP_DoReturn") ",0" );
1125
1126 #else  /* __i386__ */
1127
1128 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
1129                               DWORD exp_size, FARPROC proc, const WCHAR *user )
1130 {
1131     return proc;
1132 }
1133
1134 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
1135                               FARPROC origfun, DWORD ordinal, const WCHAR *user )
1136 {
1137     return origfun;
1138 }
1139
1140 void RELAY_SetupDLL( HMODULE module )
1141 {
1142 }
1143
1144 void SNOOP_SetupDLL( HMODULE hmod )
1145 {
1146     FIXME("snooping works only on i386 for now.\n");
1147 }
1148
1149 #endif /* __i386__ */