Fix a compile error for SNOOP_GetProcAddress and RELAY_GetProcAddress
[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 (!includelist && !excludelist) return TRUE;
336     if (excludelist)
337     {
338         show = TRUE;
339         listitem = excludelist;
340     }
341     else
342     {
343         show = FALSE;
344         listitem = includelist;
345     }
346     for(; *listitem; listitem++)
347     {
348         int len;
349
350         if (!strcmpiW( *listitem, module )) return !show;
351         len = strlenW( *listitem );
352         if (!strncmpiW( *listitem, module, len ) && !strcmpiW( module + len, dllW ))
353             return !show;
354     }
355     return show;
356 }
357
358 /***********************************************************************
359  *           find_exported_name
360  *
361  * Find the name of an exported function.
362  */
363 static const char *find_exported_name( HMODULE module,
364                                        IMAGE_EXPORT_DIRECTORY *exp, int ordinal )
365 {
366     int i;
367     const char *ret = NULL;
368
369     WORD *ordptr = (WORD *)((char *)module + exp->AddressOfNameOrdinals);
370     for (i = 0; i < exp->NumberOfNames; i++, ordptr++)
371         if (*ordptr + exp->Base == ordinal) break;
372     if (i < exp->NumberOfNames)
373         ret = (char *)module + ((DWORD*)((char *)module + exp->AddressOfNames))[i];
374     return ret;
375 }
376
377
378 /***********************************************************************
379  *           get_entry_point
380  *
381  * Get the name of the DLL entry point corresponding to a relay address.
382  */
383 static void get_entry_point( char *buffer, DEBUG_ENTRY_POINT *relay )
384 {
385     IMAGE_EXPORT_DIRECTORY *exp = NULL;
386     DEBUG_ENTRY_POINT *debug;
387     char *p;
388     const char *name;
389     int ordinal = 0;
390     PLIST_ENTRY mark, entry;
391     PLDR_MODULE mod = NULL;
392     DWORD size;
393
394     /* First find the module */
395
396     mark = &NtCurrentTeb()->Peb->LdrData->InLoadOrderModuleList;
397     for (entry = mark->Flink; entry != mark; entry = entry->Flink)
398     {
399         mod = CONTAINING_RECORD(entry, LDR_MODULE, InLoadOrderModuleList);
400         if (!(mod->Flags & LDR_WINE_INTERNAL)) continue;
401         exp = RtlImageDirectoryEntryToData( mod->BaseAddress, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
402         if (!exp) continue;
403         debug = (DEBUG_ENTRY_POINT *)((char *)exp + size);
404         if (debug <= relay && relay < debug + exp->NumberOfFunctions)
405         {
406             ordinal = relay - debug;
407             break;
408         }
409     }
410
411     /* Now find the function */
412
413     strcpy( buffer, (char *)mod->BaseAddress + exp->Name );
414     p = buffer + strlen(buffer);
415     if (p > buffer + 4 && !strcasecmp( p - 4, ".dll" )) p -= 4;
416
417     if ((name = find_exported_name( mod->BaseAddress, exp, ordinal + exp->Base )))
418         sprintf( p, ".%s", name );
419     else
420         sprintf( p, ".%ld", ordinal + exp->Base );
421 }
422
423
424 /***********************************************************************
425  *           RELAY_PrintArgs
426  */
427 static inline void RELAY_PrintArgs( int *args, int nb_args, unsigned int typemask )
428 {
429     while (nb_args--)
430     {
431         if ((typemask & 3) && HIWORD(*args))
432         {
433             if (typemask & 2)
434                 DPRINTF( "%08x %s", *args, debugstr_w((LPWSTR)*args) );
435             else
436                 DPRINTF( "%08x %s", *args, debugstr_a((LPCSTR)*args) );
437         }
438         else DPRINTF( "%08x", *args );
439         if (nb_args) DPRINTF( "," );
440         args++;
441         typemask >>= 2;
442     }
443 }
444
445
446 typedef LONGLONG (*LONGLONG_CPROC)();
447 typedef LONGLONG (WINAPI *LONGLONG_FARPROC)();
448
449
450 /***********************************************************************
451  *           call_cdecl_function
452  */
453 static LONGLONG call_cdecl_function( LONGLONG_CPROC func, int nb_args, const int *args )
454 {
455     LONGLONG ret;
456     switch(nb_args)
457     {
458     case 0: ret = func(); break;
459     case 1: ret = func(args[0]); break;
460     case 2: ret = func(args[0],args[1]); break;
461     case 3: ret = func(args[0],args[1],args[2]); break;
462     case 4: ret = func(args[0],args[1],args[2],args[3]); break;
463     case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
464     case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
465                        args[5]); break;
466     case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
467                        args[6]); break;
468     case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
469                        args[6],args[7]); break;
470     case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
471                        args[6],args[7],args[8]); break;
472     case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
473                         args[6],args[7],args[8],args[9]); break;
474     case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
475                         args[6],args[7],args[8],args[9],args[10]); break;
476     case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
477                         args[6],args[7],args[8],args[9],args[10],
478                         args[11]); break;
479     case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
480                         args[6],args[7],args[8],args[9],args[10],args[11],
481                         args[12]); break;
482     case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
483                         args[6],args[7],args[8],args[9],args[10],args[11],
484                         args[12],args[13]); break;
485     case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
486                         args[6],args[7],args[8],args[9],args[10],args[11],
487                         args[12],args[13],args[14]); break;
488     case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
489                         args[6],args[7],args[8],args[9],args[10],args[11],
490                         args[12],args[13],args[14],args[15]); break;
491     default:
492         ERR( "Unsupported nb of args %d\n", nb_args );
493         assert(FALSE);
494         ret = 0;
495         break;
496     }
497     return ret;
498 }
499
500
501 /***********************************************************************
502  *           call_stdcall_function
503  */
504 static LONGLONG call_stdcall_function( LONGLONG_FARPROC func, int nb_args, const int *args )
505 {
506     LONGLONG ret;
507     switch(nb_args)
508     {
509     case 0: ret = func(); break;
510     case 1: ret = func(args[0]); break;
511     case 2: ret = func(args[0],args[1]); break;
512     case 3: ret = func(args[0],args[1],args[2]); break;
513     case 4: ret = func(args[0],args[1],args[2],args[3]); break;
514     case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
515     case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
516                        args[5]); break;
517     case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
518                        args[6]); break;
519     case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
520                        args[6],args[7]); break;
521     case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
522                        args[6],args[7],args[8]); break;
523     case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
524                         args[6],args[7],args[8],args[9]); break;
525     case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
526                         args[6],args[7],args[8],args[9],args[10]); break;
527     case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
528                         args[6],args[7],args[8],args[9],args[10],
529                         args[11]); break;
530     case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
531                         args[6],args[7],args[8],args[9],args[10],args[11],
532                         args[12]); break;
533     case 14: 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],args[11],
535                         args[12],args[13]); break;
536     case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
537                         args[6],args[7],args[8],args[9],args[10],args[11],
538                         args[12],args[13],args[14]); break;
539     case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
540                         args[6],args[7],args[8],args[9],args[10],args[11],
541                         args[12],args[13],args[14],args[15]); break;
542     default:
543         ERR( "Unsupported nb of args %d\n", nb_args );
544         assert(FALSE);
545         ret = 0;
546         break;
547     }
548     return ret;
549 }
550
551
552 /***********************************************************************
553  *           RELAY_CallFrom32
554  *
555  * Stack layout on entry to this function:
556  *  ...      ...
557  * (esp+12)  arg2
558  * (esp+8)   arg1
559  * (esp+4)   ret_addr
560  * (esp)     return addr to relay code
561  */
562 static LONGLONG RELAY_CallFrom32( int ret_addr, ... )
563 {
564     LONGLONG ret;
565     char buffer[80];
566
567     int *args = &ret_addr + 1;
568     /* Relay addr is the return address for this function */
569     BYTE *relay_addr = (BYTE *)__builtin_return_address(0);
570     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
571     WORD nb_args = relay->args / sizeof(int);
572
573     if (TRACE_ON(relay))
574     {
575         get_entry_point( buffer, relay );
576
577         DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
578         RELAY_PrintArgs( args, nb_args, relay->argtypes );
579         DPRINTF( ") ret=%08x\n", ret_addr );
580     }
581
582     if (relay->ret == 0xc3) /* cdecl */
583     {
584         ret = call_cdecl_function( (LONGLONG_CPROC)relay->orig, nb_args, args );
585     }
586     else  /* stdcall */
587     {
588         ret = call_stdcall_function( (LONGLONG_FARPROC)relay->orig, nb_args, args );
589     }
590
591     if (TRACE_ON(relay))
592     {
593         BOOL ret64 = (relay->argtypes & 0x80000000) && (nb_args < 16);
594         if (ret64)
595             DPRINTF( "%04lx:Ret  %s() retval=%08x%08x ret=%08x\n",
596                      GetCurrentThreadId(),
597                      buffer, (UINT)(ret >> 32), (UINT)ret, ret_addr );
598         else
599             DPRINTF( "%04lx:Ret  %s() retval=%08x ret=%08x\n",
600                      GetCurrentThreadId(),
601                      buffer, (UINT)ret, ret_addr );
602     }
603     return ret;
604 }
605
606
607 /***********************************************************************
608  *           RELAY_CallFrom32Regs
609  *
610  * Stack layout (esp is context->Esp, not the current %esp):
611  *
612  * ...
613  * (esp+4) first arg
614  * (esp)   return addr to caller
615  * (esp-4) return addr to DEBUG_ENTRY_POINT
616  * (esp-8) ptr to relay entry code for RELAY_CallFrom32Regs
617  *  ...    >128 bytes space free to be modified (ensured by the assembly glue)
618  */
619 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context )
620 {
621     char buffer[80];
622     int* args;
623     int args_copy[17];
624     BYTE *entry_point;
625
626     BYTE *relay_addr = *((BYTE **)context->Esp - 1);
627     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
628     WORD nb_args = relay->args / sizeof(int);
629
630     /* remove extra stuff from the stack */
631     context->Eip = *(DWORD *)context->Esp;
632     context->Esp += sizeof(DWORD);
633     args = (int *)context->Esp;
634     if (relay->ret == 0xc2) /* stdcall */
635         context->Esp += nb_args * sizeof(int);
636
637     entry_point = (BYTE *)relay->orig;
638     assert( *entry_point == 0xe8 /* lcall */ );
639
640     if (TRACE_ON(relay))
641     {
642         get_entry_point( buffer, relay );
643
644         DPRINTF( "%04lx:Call %s(", GetCurrentThreadId(), buffer );
645         RELAY_PrintArgs( args, nb_args, relay->argtypes );
646         DPRINTF( ") ret=%08lx fs=%04lx\n", context->Eip, context->SegFs );
647
648         DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
649                 context->Eax, context->Ebx, context->Ecx,
650                 context->Edx, context->Esi, context->Edi );
651         DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
652                 context->Ebp, context->Esp, context->SegDs,
653                 context->SegEs, context->SegGs, context->EFlags );
654     }
655
656     /* Now call the real function */
657
658     memcpy( args_copy, args, nb_args * sizeof(args[0]) );
659     args_copy[nb_args] = (int)context;  /* append context argument */
660     if (relay->ret == 0xc3) /* cdecl */
661     {
662         call_cdecl_function( *(LONGLONG_CPROC *)(entry_point + 5), nb_args+1, args_copy );
663     }
664     else  /* stdcall */
665     {
666         call_stdcall_function( *(LONGLONG_FARPROC *)(entry_point + 5), nb_args+1, args_copy );
667     }
668
669     if (TRACE_ON(relay))
670     {
671         DPRINTF( "%04lx:Ret  %s() retval=%08lx ret=%08lx fs=%04lx\n",
672                  GetCurrentThreadId(),
673                  buffer, context->Eax, context->Eip, context->SegFs );
674
675         DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
676                 context->Eax, context->Ebx, context->Ecx,
677                 context->Edx, context->Esi, context->Edi );
678         DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
679                 context->Ebp, context->Esp, context->SegDs,
680                 context->SegEs, context->SegGs, context->EFlags );
681     }
682 }
683
684 void WINAPI RELAY_CallFrom32Regs(void);
685 __ASM_GLOBAL_FUNC( RELAY_CallFrom32Regs,
686                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
687                    ".long " __ASM_NAME("RELAY_DoCallFrom32Regs") ",0" );
688
689
690 /* check whether the function at addr starts with a call to __wine_call_from_32_regs */
691 static BOOL is_register_entry_point( const BYTE *addr )
692 {
693     extern void __wine_call_from_32_regs();
694     const int *offset;
695     const void *ptr;
696
697     if (*addr != 0xe8) return FALSE;  /* not a call */
698     /* check if call target is __wine_call_from_32_regs */
699     offset = (const int *)(addr + 1);
700     if (*offset == (const char *)__wine_call_from_32_regs - (const char *)(offset + 1)) return TRUE;
701     /* now check if call target is an import table jump to __wine_call_from_32_regs */
702     addr = (const BYTE *)(offset + 1) + *offset;
703     if (addr[0] != 0xff || addr[1] != 0x25) return FALSE;  /* not an indirect jmp */
704     ptr = *(const void * const*)(addr + 2);  /* get indirect jmp target address */
705     return (*(const char * const*)ptr == (char *)__wine_call_from_32_regs);
706 }
707
708
709 /***********************************************************************
710  *           RELAY_GetProcAddress
711  *
712  * Return the proc address to use for a given function.
713  */
714 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
715                               DWORD exp_size, FARPROC proc, const WCHAR *user )
716 {
717     const DEBUG_ENTRY_POINT *debug = (DEBUG_ENTRY_POINT *)proc;
718     const DEBUG_ENTRY_POINT *list = (const DEBUG_ENTRY_POINT *)((const char *)exports + exp_size);
719
720     if (debug < list || debug >= list + exports->NumberOfFunctions) return proc;
721     if (list + (debug - list) != debug) return proc;  /* not a valid address */
722     if (check_from_module( debug_from_relay_includelist, debug_from_relay_excludelist, user ))
723        return proc;  /* we want to relay it */
724     if (!debug->call) return proc;  /* not a normal function */
725     if (debug->call != 0xe8 && debug->call != 0xe9) return proc; /* not a debug thunk at all */
726     return debug->orig;
727 }
728
729
730 /***********************************************************************
731  *           RELAY_SetupDLL
732  *
733  * Setup relay debugging for a built-in dll.
734  */
735 void RELAY_SetupDLL( HMODULE module )
736 {
737     IMAGE_EXPORT_DIRECTORY *exports;
738     DEBUG_ENTRY_POINT *debug;
739     DWORD *funcs;
740     int i;
741     const char *name;
742     char *p, dllname[80];
743     DWORD size;
744
745     exports = RtlImageDirectoryEntryToData( module, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
746     if (!exports) return;
747     debug = (DEBUG_ENTRY_POINT *)((char *)exports + size);
748     funcs = (DWORD *)((char *)module + exports->AddressOfFunctions);
749     strcpy( dllname, (char *)module + exports->Name );
750     p = dllname + strlen(dllname) - 4;
751     if (p > dllname && !strcasecmp( p, ".dll" )) *p = 0;
752
753     for (i = 0; i < exports->NumberOfFunctions; i++, funcs++, debug++)
754     {
755         int on = 1;
756
757         if (!debug->call) continue;  /* not a normal function */
758         if (debug->call != 0xe8 && debug->call != 0xe9) break; /* not a debug thunk at all */
759
760         name = find_exported_name( module, exports, i + exports->Base );
761         on = check_relay_include( dllname, i + exports->Base, name );
762
763         if (on)
764         {
765             debug->call = 0xe8;  /* call relative */
766             if (is_register_entry_point( debug->orig ))
767                 debug->callfrom32 = (char *)RELAY_CallFrom32Regs - (char *)&debug->ret;
768             else
769                 debug->callfrom32 = (char *)RELAY_CallFrom32 - (char *)&debug->ret;
770         }
771         else
772         {
773             debug->call = 0xe9;  /* jmp relative */
774             debug->callfrom32 = (char *)debug->orig - (char *)&debug->ret;
775         }
776         *funcs = (char *)debug - (char *)module;
777     }
778 }
779
780
781 /***********************************************************************
782  *          SNOOP_ShowDebugmsgSnoop
783  *
784  * Simple function to decide if a particular debugging message is
785  * wanted.
786  */
787 static BOOL SNOOP_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
788 {
789     if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
790         return FALSE;
791     if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
792         return FALSE;
793     return TRUE;
794 }
795
796
797 /***********************************************************************
798  *           SNOOP_SetupDLL
799  *
800  * Setup snoop debugging for a native dll.
801  */
802 void SNOOP_SetupDLL(HMODULE hmod)
803 {
804     SNOOP_DLL **dll = &firstdll;
805     char *p, *name;
806     void *addr;
807     SIZE_T size;
808     IMAGE_EXPORT_DIRECTORY *exports;
809
810     exports = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
811     if (!exports) return;
812     name = (char *)hmod + exports->Name;
813
814     TRACE_(snoop)("hmod=%p, name=%s\n", hmod, name);
815
816     while (*dll) {
817         if ((*dll)->hmod == hmod)
818         {
819             /* another dll, loaded at the same address */
820             addr = (*dll)->funs;
821             size = (*dll)->nrofordinals * sizeof(SNOOP_FUN);
822             NtFreeVirtualMemory(GetCurrentProcess(), &addr, &size, MEM_RELEASE);
823             break;
824         }
825         dll = &((*dll)->next);
826     }
827     if (*dll)
828         *dll = RtlReAllocateHeap(GetProcessHeap(),
829                              HEAP_ZERO_MEMORY, *dll,
830                              sizeof(SNOOP_DLL) + strlen(name));
831     else
832         *dll = RtlAllocateHeap(GetProcessHeap(),
833                              HEAP_ZERO_MEMORY,
834                              sizeof(SNOOP_DLL) + strlen(name));
835     (*dll)->hmod        = hmod;
836     (*dll)->ordbase = exports->Base;
837     (*dll)->nrofordinals = exports->NumberOfFunctions;
838     strcpy( (*dll)->name, name );
839     p = (*dll)->name + strlen((*dll)->name) - 4;
840     if (p > (*dll)->name && !strcasecmp( p, ".dll" )) *p = 0;
841
842     size = exports->NumberOfFunctions * sizeof(SNOOP_FUN);
843     NtAllocateVirtualMemory(GetCurrentProcess(), &addr, NULL, &size,
844                             MEM_COMMIT | MEM_RESERVE, PAGE_EXECUTE_READWRITE);
845     if (!addr) {
846         RtlFreeHeap(GetProcessHeap(),0,*dll);
847         FIXME("out of memory\n");
848         return;
849     }
850     (*dll)->funs = addr;
851     memset((*dll)->funs,0,size);
852 }
853
854
855 /***********************************************************************
856  *           SNOOP_GetProcAddress
857  *
858  * Return the proc address to use for a given function.
859  */
860 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports,
861                               DWORD exp_size, FARPROC origfun, DWORD ordinal,
862                               const WCHAR *user)
863 {
864     int i;
865     const char *ename;
866     const WORD *ordinals;
867     const DWORD *names;
868     SNOOP_DLL *dll = firstdll;
869     SNOOP_FUN *fun;
870     const IMAGE_SECTION_HEADER *sec;
871
872     if (!TRACE_ON(snoop)) return origfun;
873     if (!check_from_module( debug_from_snoop_includelist, debug_from_snoop_excludelist, user ))
874         return origfun; /* the calling module was explicitly excluded */
875
876     if (!*(LPBYTE)origfun) /* 0x00 is an imposs. opcode, poss. dataref. */
877         return origfun;
878
879     sec = RtlImageRvaToSection( RtlImageNtHeader(hmod), hmod, (char *)origfun - (char *)hmod );
880
881     if (!sec || !(sec->Characteristics & IMAGE_SCN_CNT_CODE))
882         return origfun;  /* most likely a data reference */
883
884     while (dll) {
885         if (hmod == dll->hmod)
886             break;
887         dll = dll->next;
888     }
889     if (!dll)   /* probably internal */
890         return origfun;
891
892     /* try to find a name for it */
893     ename = NULL;
894     names = (const DWORD *)((const char *)hmod + exports->AddressOfNames);
895     ordinals = (const WORD *)((const char *)hmod + exports->AddressOfNameOrdinals);
896     if (names) for (i = 0; i < exports->NumberOfNames; i++)
897     {
898         if (ordinals[i] == ordinal)
899         {
900             ename = (const char *)hmod + names[i];
901             break;
902         }
903     }
904     if (!SNOOP_ShowDebugmsgSnoop(dll->name,ordinal,ename))
905         return origfun;
906     assert(ordinal < dll->nrofordinals);
907     fun = dll->funs + ordinal;
908     if (!fun->name)
909     {
910         fun->name       = ename;
911         fun->lcall      = 0xe8;
912         /* NOTE: origreturn struct member MUST come directly after snoopentry */
913         fun->snoopentry = (char*)SNOOP_Entry-((char*)(&fun->nrofargs));
914         fun->origfun    = origfun;
915         fun->nrofargs   = -1;
916     }
917     return (FARPROC)&(fun->lcall);
918 }
919
920 static void SNOOP_PrintArg(DWORD x)
921 {
922     int i,nostring;
923
924     DPRINTF("%08lx",x);
925     if (!HIWORD(x) || TRACE_ON(seh)) return; /* trivial reject to avoid faults */
926     __TRY
927     {
928         LPBYTE s=(LPBYTE)x;
929         i=0;nostring=0;
930         while (i<80) {
931             if (s[i]==0) break;
932             if (s[i]<0x20) {nostring=1;break;}
933             if (s[i]>=0x80) {nostring=1;break;}
934             i++;
935         }
936         if (!nostring && i > 5)
937             DPRINTF(" %s",debugstr_an((LPSTR)x,i));
938         else  /* try unicode */
939         {
940             LPWSTR s=(LPWSTR)x;
941             i=0;nostring=0;
942             while (i<80) {
943                 if (s[i]==0) break;
944                 if (s[i]<0x20) {nostring=1;break;}
945                 if (s[i]>0x100) {nostring=1;break;}
946                 i++;
947             }
948             if (!nostring && i > 5) DPRINTF(" %s",debugstr_wn((LPWSTR)x,i));
949         }
950     }
951     __EXCEPT(page_fault)
952     {
953     }
954     __ENDTRY
955 }
956
957 #define CALLER1REF (*(DWORD*)context->Esp)
958
959 void WINAPI SNOOP_DoEntry( CONTEXT86 *context )
960 {
961         DWORD           ordinal=0,entry = context->Eip - 5;
962         SNOOP_DLL       *dll = firstdll;
963         SNOOP_FUN       *fun = NULL;
964         SNOOP_RETURNENTRIES     **rets = &firstrets;
965         SNOOP_RETURNENTRY       *ret;
966         int             i=0, max;
967
968         while (dll) {
969                 if (    ((char*)entry>=(char*)dll->funs)        &&
970                         ((char*)entry<=(char*)(dll->funs+dll->nrofordinals))
971                 ) {
972                         fun = (SNOOP_FUN*)entry;
973                         ordinal = fun-dll->funs;
974                         break;
975                 }
976                 dll=dll->next;
977         }
978         if (!dll) {
979                 FIXME("entrypoint 0x%08lx not found\n",entry);
980                 return; /* oops */
981         }
982         /* guess cdecl ... */
983         if (fun->nrofargs<0) {
984                 /* Typical cdecl return frame is:
985                  *     add esp, xxxxxxxx
986                  * which has (for xxxxxxxx up to 255 the opcode "83 C4 xx".
987                  * (after that 81 C2 xx xx xx xx)
988                  */
989                 LPBYTE  reteip = (LPBYTE)CALLER1REF;
990
991                 if (reteip) {
992                         if ((reteip[0]==0x83)&&(reteip[1]==0xc4))
993                                 fun->nrofargs=reteip[2]/4;
994                 }
995         }
996
997
998         while (*rets) {
999                 for (i=0;i<sizeof((*rets)->entry)/sizeof((*rets)->entry[0]);i++)
1000                         if (!(*rets)->entry[i].origreturn)
1001                                 break;
1002                 if (i!=sizeof((*rets)->entry)/sizeof((*rets)->entry[0]))
1003                         break;
1004                 rets = &((*rets)->next);
1005         }
1006         if (!*rets) {
1007                 SIZE_T size = 4096;
1008                 VOID* addr;
1009
1010                 NtAllocateVirtualMemory(GetCurrentProcess(), &addr, NULL, &size, 
1011                                         MEM_COMMIT | MEM_RESERVE,
1012                                         PAGE_EXECUTE_READWRITE);
1013                 if (!addr) return;
1014                 *rets = addr;
1015                 memset(*rets,0,4096);
1016                 i = 0;  /* entry 0 is free */
1017         }
1018         ret = &((*rets)->entry[i]);
1019         ret->lcall      = 0xe8;
1020         /* NOTE: origreturn struct member MUST come directly after snoopret */
1021         ret->snoopret   = ((char*)SNOOP_Return)-(char*)(&ret->origreturn);
1022         ret->origreturn = (FARPROC)CALLER1REF;
1023         CALLER1REF      = (DWORD)&ret->lcall;
1024         ret->dll        = dll;
1025         ret->args       = NULL;
1026         ret->ordinal    = ordinal;
1027         ret->origESP    = context->Esp;
1028
1029         context->Eip = (DWORD)fun->origfun;
1030
1031         if (fun->name) DPRINTF("%04lx:CALL %s.%s(",GetCurrentThreadId(),dll->name,fun->name);
1032         else DPRINTF("%04lx:CALL %s.%ld(",GetCurrentThreadId(),dll->name,dll->ordbase+ordinal);
1033         if (fun->nrofargs>0) {
1034                 max = fun->nrofargs; if (max>16) max=16;
1035                 for (i=0;i<max;i++)
1036                 {
1037                     SNOOP_PrintArg(*(DWORD*)(context->Esp + 4 + sizeof(DWORD)*i));
1038                     if (i<fun->nrofargs-1) DPRINTF(",");
1039                 }
1040                 if (max!=fun->nrofargs)
1041                         DPRINTF(" ...");
1042         } else if (fun->nrofargs<0) {
1043                 DPRINTF("<unknown, check return>");
1044                 ret->args = RtlAllocateHeap(GetProcessHeap(),
1045                                             0,16*sizeof(DWORD));
1046                 memcpy(ret->args,(LPBYTE)(context->Esp + 4),sizeof(DWORD)*16);
1047         }
1048         DPRINTF(") ret=%08lx\n",(DWORD)ret->origreturn);
1049 }
1050
1051
1052 void WINAPI SNOOP_DoReturn( CONTEXT86 *context )
1053 {
1054         SNOOP_RETURNENTRY       *ret = (SNOOP_RETURNENTRY*)(context->Eip - 5);
1055         SNOOP_FUN *fun = &ret->dll->funs[ret->ordinal];
1056
1057         /* We haven't found out the nrofargs yet. If we called a cdecl
1058          * function it is too late anyway and we can just set '0' (which
1059          * will be the difference between orig and current ESP
1060          * If stdcall -> everything ok.
1061          */
1062         if (ret->dll->funs[ret->ordinal].nrofargs<0)
1063                 ret->dll->funs[ret->ordinal].nrofargs=(context->Esp - ret->origESP-4)/4;
1064         context->Eip = (DWORD)ret->origreturn;
1065         if (ret->args) {
1066                 int     i,max;
1067
1068                 if (fun->name)
1069                     DPRINTF("%04lx:RET  %s.%s(", GetCurrentThreadId(), ret->dll->name, fun->name);
1070                 else
1071                     DPRINTF("%04lx:RET  %s.%ld(", GetCurrentThreadId(),
1072                             ret->dll->name,ret->dll->ordbase+ret->ordinal);
1073
1074                 max = fun->nrofargs;
1075                 if (max>16) max=16;
1076
1077                 for (i=0;i<max;i++)
1078                 {
1079                     SNOOP_PrintArg(ret->args[i]);
1080                     if (i<max-1) DPRINTF(",");
1081                 }
1082                 DPRINTF(") retval=%08lx ret=%08lx\n",
1083                         context->Eax,(DWORD)ret->origreturn );
1084                 RtlFreeHeap(GetProcessHeap(),0,ret->args);
1085                 ret->args = NULL;
1086         }
1087         else
1088         {
1089             if (fun->name)
1090                 DPRINTF("%04lx:RET  %s.%s() retval=%08lx ret=%08lx\n",
1091                         GetCurrentThreadId(),
1092                         ret->dll->name, fun->name, context->Eax, (DWORD)ret->origreturn);
1093             else
1094                 DPRINTF("%04lx:RET  %s.%ld() retval=%08lx ret=%08lx\n",
1095                         GetCurrentThreadId(),
1096                         ret->dll->name,ret->dll->ordbase+ret->ordinal,
1097                         context->Eax, (DWORD)ret->origreturn);
1098         }
1099         ret->origreturn = NULL; /* mark as empty */
1100 }
1101
1102 /* assembly wrappers that save the context */
1103 __ASM_GLOBAL_FUNC( SNOOP_Entry,
1104                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1105                    ".long " __ASM_NAME("SNOOP_DoEntry") ",0" );
1106 __ASM_GLOBAL_FUNC( SNOOP_Return,
1107                    "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t"
1108                    ".long " __ASM_NAME("SNOOP_DoReturn") ",0" );
1109
1110 #else  /* __i386__ */
1111
1112 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
1113                               DWORD exp_size, FARPROC proc, const WCHAR *user )
1114 {
1115     return proc;
1116 }
1117
1118 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
1119                               FARPROC origfun, DWORD ordinal, const WCHAR *user )
1120 {
1121     return origfun;
1122 }
1123
1124 void RELAY_SetupDLL( HMODULE module )
1125 {
1126 }
1127
1128 void SNOOP_SetupDLL( HMODULE hmod )
1129 {
1130     FIXME("snooping works only on i386 for now.\n");
1131 }
1132
1133 #endif /* __i386__ */