git.oblomov.eu Git - wine/blob - 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 "ntstatus.h"
  31 #define WIN32_NO_STATUS
  32 #include "windef.h"
  33 #include "winternl.h"
  34 #include "wine/exception.h"
  35 #include "ntdll_misc.h"
  36 #include "wine/unicode.h"
  37 #include "wine/debug.h"
  38
  39 WINE_DEFAULT_DEBUG_CHANNEL(relay);
  40
  41 #if defined(__i386__) || defined(__x86_64__)
  42
  43 struct relay_descr  /* descriptor for a module */
  44 {
  45     void               *magic;               /* signature */
  46     void               *relay_call;          /* functions to call from relay thunks */
  47     void               *relay_call_regs;
  48     void               *private;             /* reserved for the relay code private data */
  49     const char         *entry_point_base;    /* base address of entry point thunks */
  50     const unsigned int *entry_point_offsets; /* offsets of entry points thunks */
  51     const unsigned int *arg_types;           /* table of argument types for all entry points */
  52 };
  53
  54 #define RELAY_DESCR_MAGIC  ((void *)0xdeb90001)
  55 #define IS_INTARG(x)       (((ULONG_PTR)(x) >> 16) == 0)
  56
  57 /* private data built at dll load time */
  58
  59 struct relay_entry_point
  60 {
  61     void       *orig_func;    /* original entry point function */
  62     const char *name;         /* function name (if any) */
  63 };
  64
  65 struct relay_private_data
  66 {
  67     HMODULE                  module;            /* module handle of this dll */
  68     unsigned int             base;              /* ordinal base */
  69     char                     dllname[40];       /* dll name (without .dll extension) */
  70     struct relay_entry_point entry_points[1];   /* list of dll entry points */
  71 };
  72
  73 static const WCHAR **debug_relay_excludelist;
  74 static const WCHAR **debug_relay_includelist;
  75 static const WCHAR **debug_snoop_excludelist;
  76 static const WCHAR **debug_snoop_includelist;
  77 static const WCHAR **debug_from_relay_excludelist;
  78 static const WCHAR **debug_from_relay_includelist;
  79 static const WCHAR **debug_from_snoop_excludelist;
  80 static const WCHAR **debug_from_snoop_includelist;
  81
  82 static BOOL init_done;
  83
  84 /* compare an ASCII and a Unicode string without depending on the current codepage */
  85 static inline int strcmpAW( const char *strA, const WCHAR *strW )
  86 {
  87     while (*strA && ((unsigned char)*strA == *strW)) { strA++; strW++; }
  88     return (unsigned char)*strA - *strW;
  89 }
  90
  91 /* compare an ASCII and a Unicode string without depending on the current codepage */
  92 static inline int strncmpiAW( const char *strA, const WCHAR *strW, int n )
  93 {
  94     int ret = 0;
  95     for ( ; n > 0; n--, strA++, strW++)
  96         if ((ret = toupperW((unsigned char)*strA) - toupperW(*strW)) || !*strA) break;
  97     return ret;
  98 }
  99
 100 /***********************************************************************
 101  *           build_list
 102  *
 103  * Build a function list from a ';'-separated string.
 104  */
 105 static const WCHAR **build_list( const WCHAR *buffer )
 106 {
 107     int count = 1;
 108     const WCHAR *p = buffer;
 109     const WCHAR **ret;
 110
 111     while ((p = strchrW( p, ';' )))
 112     {
 113         count++;
 114         p++;
 115     }
 116     /* allocate count+1 pointers, plus the space for a copy of the string */
 117     if ((ret = RtlAllocateHeap( GetProcessHeap(), 0,
 118                                 (count+1) * sizeof(WCHAR*) + (strlenW(buffer)+1) * sizeof(WCHAR) )))
 119     {
 120         WCHAR *str = (WCHAR *)(ret + count + 1);
 121         WCHAR *p = str;
 122
 123         strcpyW( str, buffer );
 124         count = 0;
 125         for (;;)
 126         {
 127             ret[count++] = p;
 128             if (!(p = strchrW( p, ';' ))) break;
 129             *p++ = 0;
 130         }
 131         ret[count++] = NULL;
 132     }
 133     return ret;
 134 }
 135
 136 /***********************************************************************
 137  *           load_list_value
 138  *
 139  * Load a function list from a registry value.
 140  */
 141 static const WCHAR **load_list( HKEY hkey, const WCHAR *value )
 142 {
 143     char initial_buffer[4096];
 144     char *buffer = initial_buffer;
 145     DWORD count;
 146     NTSTATUS status;
 147     UNICODE_STRING name;
 148     const WCHAR **list = NULL;
 149
 150     RtlInitUnicodeString( &name, value );
 151     status = NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(initial_buffer), &count );
 152     if (status == STATUS_BUFFER_OVERFLOW)
 153     {
 154         buffer = RtlAllocateHeap( GetProcessHeap(), 0, count );
 155         status = NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, count, &count );
 156     }
 157     if (status == STATUS_SUCCESS)
 158     {
 159         WCHAR *str = (WCHAR *)((KEY_VALUE_PARTIAL_INFORMATION *)buffer)->Data;
 160         list = build_list( str );
 161         if (list) TRACE( "%s = %s\n", debugstr_w(value), debugstr_w(str) );
 162     }
 163
 164     if (buffer != initial_buffer) RtlFreeHeap( GetProcessHeap(), 0, buffer );
 165     return list;
 166 }
 167
 168 /***********************************************************************
 169  *           init_debug_lists
 170  *
 171  * Build the relay include/exclude function lists.
 172  */
 173 static void init_debug_lists(void)
 174 {
 175     OBJECT_ATTRIBUTES attr;
 176     UNICODE_STRING name;
 177     HANDLE root, hkey;
 178     static const WCHAR configW[] = {'S','o','f','t','w','a','r','e','\\',
 179                                     'W','i','n','e','\\',
 180                                     'D','e','b','u','g',0};
 181     static const WCHAR RelayIncludeW[] = {'R','e','l','a','y','I','n','c','l','u','d','e',0};
 182     static const WCHAR RelayExcludeW[] = {'R','e','l','a','y','E','x','c','l','u','d','e',0};
 183     static const WCHAR SnoopIncludeW[] = {'S','n','o','o','p','I','n','c','l','u','d','e',0};
 184     static const WCHAR SnoopExcludeW[] = {'S','n','o','o','p','E','x','c','l','u','d','e',0};
 185     static const WCHAR RelayFromIncludeW[] = {'R','e','l','a','y','F','r','o','m','I','n','c','l','u','d','e',0};
 186     static const WCHAR RelayFromExcludeW[] = {'R','e','l','a','y','F','r','o','m','E','x','c','l','u','d','e',0};
 187     static const WCHAR SnoopFromIncludeW[] = {'S','n','o','o','p','F','r','o','m','I','n','c','l','u','d','e',0};
 188     static const WCHAR SnoopFromExcludeW[] = {'S','n','o','o','p','F','r','o','m','E','x','c','l','u','d','e',0};
 189
 190     if (init_done) return;
 191     init_done = TRUE;
 192
 193     RtlOpenCurrentUser( KEY_ALL_ACCESS, &root );
 194     attr.Length = sizeof(attr);
 195     attr.RootDirectory = root;
 196     attr.ObjectName = &name;
 197     attr.Attributes = 0;
 198     attr.SecurityDescriptor = NULL;
 199     attr.SecurityQualityOfService = NULL;
 200     RtlInitUnicodeString( &name, configW );
 201
 202     /* @@ Wine registry key: HKCU\Software\Wine\Debug */
 203     if (NtOpenKey( &hkey, KEY_ALL_ACCESS, &attr )) hkey = 0;
 204     NtClose( root );
 205     if (!hkey) return;
 206
 207     debug_relay_includelist = load_list( hkey, RelayIncludeW );
 208     debug_relay_excludelist = load_list( hkey, RelayExcludeW );
 209     debug_snoop_includelist = load_list( hkey, SnoopIncludeW );
 210     debug_snoop_excludelist = load_list( hkey, SnoopExcludeW );
 211     debug_from_relay_includelist = load_list( hkey, RelayFromIncludeW );
 212     debug_from_relay_excludelist = load_list( hkey, RelayFromExcludeW );
 213     debug_from_snoop_includelist = load_list( hkey, SnoopFromIncludeW );
 214     debug_from_snoop_excludelist = load_list( hkey, SnoopFromExcludeW );
 215
 216     NtClose( hkey );
 217 }
 218
 219
 220 /***********************************************************************
 221  *           check_list
 222  *
 223  * Check if a given module and function is in the list.
 224  */
 225 static BOOL check_list( const char *module, int ordinal, const char *func, const WCHAR *const *list )
 226 {
 227     char ord_str[10];
 228
 229     sprintf( ord_str, "%d", ordinal );
 230     for(; *list; list++)
 231     {
 232         const WCHAR *p = strrchrW( *list, '.' );
 233         if (p && p > *list)  /* check module and function */
 234         {
 235             int len = p - *list;
 236             if (strncmpiAW( module, *list, len-1 ) || module[len]) continue;
 237             if (p[1] == '*' && !p[2]) return TRUE;
 238             if (!strcmpAW( ord_str, p + 1 )) return TRUE;
 239             if (func && !strcmpAW( func, p + 1 )) return TRUE;
 240         }
 241         else  /* function only */
 242         {
 243             if (func && !strcmpAW( func, *list )) return TRUE;
 244         }
 245     }
 246     return FALSE;
 247 }
 248
 249
 250 /***********************************************************************
 251  *           check_relay_include
 252  *
 253  * Check if a given function must be included in the relay output.
 254  */
 255 static BOOL check_relay_include( const char *module, int ordinal, const char *func )
 256 {
 257     if (debug_relay_excludelist && check_list( module, ordinal, func, debug_relay_excludelist ))
 258         return FALSE;
 259     if (debug_relay_includelist && !check_list( module, ordinal, func, debug_relay_includelist ))
 260         return FALSE;
 261     return TRUE;
 262 }
 263
 264 /***********************************************************************
 265  *           check_from_module
 266  *
 267  * Check if calls from a given module must be included in the relay/snoop output,
 268  * given the exclusion and inclusion lists.
 269  */
 270 static BOOL check_from_module( const WCHAR **includelist, const WCHAR **excludelist, const WCHAR *module )
 271 {
 272     static const WCHAR dllW[] = {'.','d','l','l',0 };
 273     const WCHAR **listitem;
 274     BOOL show;
 275
 276     if (!module) return TRUE;
 277     if (!includelist && !excludelist) return TRUE;
 278     if (excludelist)
 279     {
 280         show = TRUE;
 281         listitem = excludelist;
 282     }
 283     else
 284     {
 285         show = FALSE;
 286         listitem = includelist;
 287     }
 288     for(; *listitem; listitem++)
 289     {
 290         int len;
 291
 292         if (!strcmpiW( *listitem, module )) return !show;
 293         len = strlenW( *listitem );
 294         if (!strncmpiW( *listitem, module, len ) && !strcmpiW( module + len, dllW ))
 295             return !show;
 296     }
 297     return show;
 298 }
 299
 300 /***********************************************************************
 301  *           RELAY_PrintArgs
 302  */
 303 static inline void RELAY_PrintArgs( const INT_PTR *args, int nb_args, unsigned int typemask )
 304 {
 305     while (nb_args--)
 306     {
 307         if ((typemask & 3) && !IS_INTARG(*args))
 308         {
 309             if (typemask & 2)
 310                 DPRINTF( "%08lx %s", *args, debugstr_w((LPCWSTR)*args) );
 311             else
 312                 DPRINTF( "%08lx %s", *args, debugstr_a((LPCSTR)*args) );
 313         }
 314         else DPRINTF( "%08lx", *args );
 315         if (nb_args) DPRINTF( "," );
 316         args++;
 317         typemask >>= 2;
 318     }
 319 }
 320
 321 extern LONGLONG CDECL call_entry_point( void *func, int nb_args, const INT_PTR *args, int flags );
 322 #ifdef __i386__
 323 __ASM_GLOBAL_FUNC( call_entry_point,
 324                    "pushl %ebp\n\t"
 325                    __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
 326                    __ASM_CFI(".cfi_rel_offset %ebp,0\n\t")
 327                    "movl %esp,%ebp\n\t"
 328                    __ASM_CFI(".cfi_def_cfa_register %ebp\n\t")
 329                    "pushl %esi\n\t"
 330                   __ASM_CFI(".cfi_rel_offset %esi,-4\n\t")
 331                    "pushl %edi\n\t"
 332                   __ASM_CFI(".cfi_rel_offset %edi,-8\n\t")
 333                    "movl 12(%ebp),%edx\n\t"
 334                    "shll $2,%edx\n\t"
 335                    "jz 1f\n\t"
 336                    "subl %edx,%esp\n\t"
 337                    "andl $~15,%esp\n\t"
 338                    "movl 12(%ebp),%ecx\n\t"
 339                    "movl 16(%ebp),%esi\n\t"
 340                    "movl %esp,%edi\n\t"
 341                    "cld\n\t"
 342                    "rep; movsl\n"
 343                    "testl $2,20(%ebp)\n\t"  /* (flags & 2) -> thiscall */
 344                    "jz 1f\n\t"
 345                    "popl %ecx\n\t"
 346                    "1:\tcall *8(%ebp)\n\t"
 347                    "leal -8(%ebp),%esp\n\t"
 348                    "popl %edi\n\t"
 349                    __ASM_CFI(".cfi_same_value %edi\n\t")
 350                    "popl %esi\n\t"
 351                    __ASM_CFI(".cfi_same_value %esi\n\t")
 352                    "popl %ebp\n\t"
 353                    __ASM_CFI(".cfi_def_cfa %esp,4\n\t")
 354                    __ASM_CFI(".cfi_same_value %ebp\n\t")
 355                    "ret" )
 356 #else
 357 __ASM_GLOBAL_FUNC( call_entry_point,
 358                    "pushq %rbp\n\t"
 359                    __ASM_CFI(".cfi_adjust_cfa_offset 8\n\t")
 360                    __ASM_CFI(".cfi_rel_offset %rbp,0\n\t")
 361                    "movq %rsp,%rbp\n\t"
 362                    __ASM_CFI(".cfi_def_cfa_register %rbp\n\t")
 363                    "pushq %rsi\n\t"
 364                    __ASM_CFI(".cfi_rel_offset %rsi,-8\n\t")
 365                    "pushq %rdi\n\t"
 366                    __ASM_CFI(".cfi_rel_offset %rdi,-16\n\t")
 367                    "movq %rcx,%rax\n\t"
 368                    "movq $4,%rcx\n\t"
 369                    "cmp %rcx,%rdx\n\t"
 370                    "cmovgq %rdx,%rcx\n\t"
 371                    "leaq 0(,%rcx,8),%rdx\n\t"
 372                    "subq %rdx,%rsp\n\t"
 373                    "andq $~15,%rsp\n\t"
 374                    "movq %rsp,%rdi\n\t"
 375                    "movq %r8,%rsi\n\t"
 376                    "rep; movsq\n\t"
 377                    "movq 0(%rsp),%rcx\n\t"
 378                    "movq 8(%rsp),%rdx\n\t"
 379                    "movq 16(%rsp),%r8\n\t"
 380                    "movq 24(%rsp),%r9\n\t"
 381                    "callq *%rax\n\t"
 382                    "leaq -16(%rbp),%rsp\n\t"
 383                    "popq %rdi\n\t"
 384                    __ASM_CFI(".cfi_same_value %rdi\n\t")
 385                    "popq %rsi\n\t"
 386                    __ASM_CFI(".cfi_same_value %rsi\n\t")
 387                    __ASM_CFI(".cfi_def_cfa_register %rsp\n\t")
 388                    "popq %rbp\n\t"
 389                    __ASM_CFI(".cfi_adjust_cfa_offset -8\n\t")
 390                    __ASM_CFI(".cfi_same_value %rbp\n\t")
 391                    "ret")
 392 #endif
 393
 394
 395 /***********************************************************************
 396  *           relay_call
 397  *
 398  * stack points to the return address, i.e. the first argument is stack[1].
 399  */
 400 static LONGLONG WINAPI relay_call( struct relay_descr *descr, unsigned int idx, const INT_PTR *stack )
 401 {
 402     LONGLONG ret;
 403     WORD ordinal = LOWORD(idx);
 404     BYTE nb_args = LOBYTE(HIWORD(idx));
 405     BYTE flags   = HIBYTE(HIWORD(idx));
 406     struct relay_private_data *data = descr->private;
 407     struct relay_entry_point *entry_point = data->entry_points + ordinal;
 408
 409     if (!TRACE_ON(relay))
 410         ret = call_entry_point( entry_point->orig_func, nb_args, stack + 1, flags );
 411     else
 412     {
 413         if (entry_point->name)
 414             DPRINTF( "%04x:Call %s.%s(", GetCurrentThreadId(), data->dllname, entry_point->name );
 415         else
 416             DPRINTF( "%04x:Call %s.%u(", GetCurrentThreadId(), data->dllname, data->base + ordinal );
 417         RELAY_PrintArgs( stack + 1, nb_args, descr->arg_types[ordinal] );
 418         DPRINTF( ") ret=%08lx\n", stack[0] );
 419
 420         ret = call_entry_point( entry_point->orig_func, nb_args, stack + 1, flags );
 421
 422         if (entry_point->name)
 423             DPRINTF( "%04x:Ret  %s.%s()", GetCurrentThreadId(), data->dllname, entry_point->name );
 424         else
 425             DPRINTF( "%04x:Ret  %s.%u()", GetCurrentThreadId(), data->dllname, data->base + ordinal );
 426
 427         if (flags & 1)  /* 64-bit return value */
 428             DPRINTF( " retval=%08x%08x ret=%08lx\n",
 429                      (UINT)(ret >> 32), (UINT)ret, stack[0] );
 430         else
 431             DPRINTF( " retval=%08lx ret=%08lx\n", (UINT_PTR)ret, stack[0] );
 432     }
 433     return ret;
 434 }
 435
 436
 437 /***********************************************************************
 438  *           relay_call_regs
 439  */
 440 #ifdef __i386__
 441 void WINAPI __regs_relay_call_regs( struct relay_descr *descr, unsigned int idx,
 442                                     unsigned int orig_eax, unsigned int ret_addr,
 443                                     CONTEXT86 *context )
 444 {
 445     WORD ordinal = LOWORD(idx);
 446     BYTE nb_args = LOBYTE(HIWORD(idx));
 447     struct relay_private_data *data = descr->private;
 448     struct relay_entry_point *entry_point = data->entry_points + ordinal;
 449     BYTE *orig_func = entry_point->orig_func;
 450     INT_PTR *args = (INT_PTR *)context->Esp;
 451     INT_PTR args_copy[32];
 452
 453     /* restore the context to what it was before the relay thunk */
 454     context->Eax = orig_eax;
 455     context->Eip = ret_addr;
 456     context->Esp += nb_args * sizeof(int);
 457
 458     if (TRACE_ON(relay))
 459     {
 460         if (entry_point->name)
 461             DPRINTF( "%04x:Call %s.%s(", GetCurrentThreadId(), data->dllname, entry_point->name );
 462         else
 463             DPRINTF( "%04x:Call %s.%u(", GetCurrentThreadId(), data->dllname, data->base + ordinal );
 464         RELAY_PrintArgs( args, nb_args, descr->arg_types[ordinal] );
 465         DPRINTF( ") ret=%08x\n", ret_addr );
 466
 467         DPRINTF( "%04x:  eax=%08x ebx=%08x ecx=%08x edx=%08x esi=%08x edi=%08x "
 468                  "ebp=%08x esp=%08x ds=%04x es=%04x fs=%04x gs=%04x flags=%08x\n",
 469                  GetCurrentThreadId(), context->Eax, context->Ebx, context->Ecx,
 470                  context->Edx, context->Esi, context->Edi, context->Ebp, context->Esp,
 471                  context->SegDs, context->SegEs, context->SegFs, context->SegGs, context->EFlags );
 472
 473         assert( orig_func[0] == 0x68 /* pushl func */ );
 474         assert( orig_func[5] == 0x6a /* pushl args */ );
 475         assert( orig_func[7] == 0xe8 /* call */ );
 476     }
 477
 478     /* now call the real function */
 479
 480     memcpy( args_copy, args, nb_args * sizeof(args[0]) );
 481     args_copy[nb_args++] = (INT_PTR)context;  /* append context argument */
 482
 483     call_entry_point( orig_func + 12 + *(int *)(orig_func + 1), nb_args, args_copy, 0 );
 484
 485
 486     if (TRACE_ON(relay))
 487     {
 488         if (entry_point->name)
 489             DPRINTF( "%04x:Ret  %s.%s() retval=%08x ret=%08x\n",
 490                      GetCurrentThreadId(), data->dllname, entry_point->name,
 491                      context->Eax, context->Eip );
 492         else
 493             DPRINTF( "%04x:Ret  %s.%u() retval=%08x ret=%08x\n",
 494                      GetCurrentThreadId(), data->dllname, data->base + ordinal,
 495                      context->Eax, context->Eip );
 496         DPRINTF( "%04x:  eax=%08x ebx=%08x ecx=%08x edx=%08x esi=%08x edi=%08x "
 497                  "ebp=%08x esp=%08x ds=%04x es=%04x fs=%04x gs=%04x flags=%08x\n",
 498                  GetCurrentThreadId(), context->Eax, context->Ebx, context->Ecx,
 499                  context->Edx, context->Esi, context->Edi, context->Ebp, context->Esp,
 500                  context->SegDs, context->SegEs, context->SegFs, context->SegGs, context->EFlags );
 501     }
 502 }
 503 extern void WINAPI relay_call_regs(void);
 504 DEFINE_REGS_ENTRYPOINT( relay_call_regs, 4 )
 505
 506 #else  /* __i386__ */
 507
 508 void WINAPI __regs_relay_call_regs( struct relay_descr *descr, INT_PTR idx,
 509                                     INT_PTR *stack, CONTEXT *context )
 510 {
 511     WORD ordinal = LOWORD(idx);
 512     BYTE nb_args = LOBYTE(HIWORD(idx));
 513     struct relay_private_data *data = descr->private;
 514     struct relay_entry_point *entry_point = data->entry_points + ordinal;
 515     BYTE *orig_func = entry_point->orig_func;
 516     INT_PTR *args = stack + 1;
 517     INT_PTR args_copy[32];
 518
 519     /* restore the context to what it was before the relay thunk */
 520     context->Rip = stack[0];
 521     context->Rsp = (INT_PTR)args;
 522
 523     if (TRACE_ON(relay))
 524     {
 525         if (entry_point->name)
 526             DPRINTF( "%04x:Call %s.%s(", GetCurrentThreadId(), data->dllname, entry_point->name );
 527         else
 528             DPRINTF( "%04x:Call %s.%u(", GetCurrentThreadId(), data->dllname, data->base + ordinal );
 529         RELAY_PrintArgs( args, nb_args, descr->arg_types[ordinal] );
 530         DPRINTF( ") ret=%08lx\n", context->Rip );
 531
 532         DPRINTF( "%04x: rax=%016lx rbx=%016lx rcx=%016lx rdx=%016lx rsi=%016lx rdi=%016lx rbp=%016lx rsp=%016lx\n",
 533                  GetCurrentThreadId(), context->Rax, context->Rbx, context->Rcx, context->Rdx,
 534                  context->Rsi, context->Rdi, context->Rbp, context->Rsp );
 535         DPRINTF( "%04x:  r8=%016lx  r9=%016lx r10=%016lx r11=%016lx r12=%016lx r13=%016lx r14=%016lx r15=%016lx\n",
 536                  GetCurrentThreadId(), context->R8, context->R9, context->R10, context->R11,
 537                  context->R12, context->R13, context->R14, context->R15 );
 538
 539         assert( orig_func[17] == 0x48 /* leaq */ );
 540         assert( orig_func[18] == 0x8d );
 541         assert( orig_func[19] == 0x15 );
 542         assert( orig_func[24] == 0xe8 /* call */ );
 543     }
 544
 545     /* now call the real function */
 546
 547     memcpy( args_copy, args, nb_args * sizeof(args[0]) );
 548     args_copy[nb_args++] = (INT_PTR)context;  /* append context argument */
 549
 550     call_entry_point( orig_func + 24 + *(int *)(orig_func + 20), nb_args, args_copy, 0 );
 551
 552
 553     if (TRACE_ON(relay))
 554     {
 555         if (entry_point->name)
 556             DPRINTF( "%04x:Ret  %s.%s() retval=%08lx ret=%08lx\n",
 557                      GetCurrentThreadId(), data->dllname, entry_point->name,
 558                      context->Rax, context->Rip );
 559         else
 560             DPRINTF( "%04x:Ret  %s.%u() retval=%08lx ret=%08lx\n",
 561                      GetCurrentThreadId(), data->dllname, data->base + ordinal,
 562                      context->Rax, context->Rip );
 563         DPRINTF( "%04x:  rax=%016lx rbx=%016lx rcx=%016lx rdx=%016lx rsi=%016lx rdi=%016lx rbp=%016lx rsp=%016lx\n",
 564                  GetCurrentThreadId(), context->Rax, context->Rbx, context->Rcx, context->Rdx,
 565                  context->Rsi, context->Rdi, context->Rbp, context->Rsp );
 566         DPRINTF( "%04x:  r8=%016lx  r9=%016lx r10=%016lx r11=%016lx r12=%016lx r13=%016lx r14=%016lx r15=%016lx\n",
 567                  GetCurrentThreadId(), context->R8, context->R9, context->R10, context->R11,
 568                  context->R12, context->R13, context->R14, context->R15 );
 569     }
 570 }
 571 extern void WINAPI relay_call_regs(void);
 572 DEFINE_REGS_ENTRYPOINT( relay_call_regs, 3 )
 573
 574 #endif  /* __i386__ */
 575
 576
 577 /***********************************************************************
 578  *           RELAY_GetProcAddress
 579  *
 580  * Return the proc address to use for a given function.
 581  */
 582 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
 583                               DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user )
 584 {
 585     struct relay_private_data *data;
 586     const struct relay_descr *descr = (const struct relay_descr *)((const char *)exports + exp_size);
 587
 588     if (descr->magic != RELAY_DESCR_MAGIC || !(data = descr->private)) return proc;  /* no relay data */
 589     if (!data->entry_points[ordinal].orig_func) return proc;  /* not a relayed function */
 590     if (check_from_module( debug_from_relay_includelist, debug_from_relay_excludelist, user ))
 591         return proc;  /* we want to relay it */
 592     return data->entry_points[ordinal].orig_func;
 593 }
 594
 595
 596 /***********************************************************************
 597  *           RELAY_SetupDLL
 598  *
 599  * Setup relay debugging for a built-in dll.
 600  */
 601 void RELAY_SetupDLL( HMODULE module )
 602 {
 603     IMAGE_EXPORT_DIRECTORY *exports;
 604     DWORD *funcs;
 605     unsigned int i, len;
 606     DWORD size, entry_point_rva;
 607     struct relay_descr *descr;
 608     struct relay_private_data *data;
 609     const WORD *ordptr;
 610
 611     if (!init_done) init_debug_lists();
 612
 613     exports = RtlImageDirectoryEntryToData( module, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size );
 614     if (!exports) return;
 615
 616     descr = (struct relay_descr *)((char *)exports + size);
 617     if (descr->magic != RELAY_DESCR_MAGIC) return;
 618
 619     if (!(data = RtlAllocateHeap( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*data) +
 620                                   (exports->NumberOfFunctions-1) * sizeof(data->entry_points) )))
 621         return;
 622
 623     descr->relay_call = relay_call;
 624     descr->relay_call_regs = relay_call_regs;
 625     descr->private = data;
 626
 627     data->module = module;
 628     data->base   = exports->Base;
 629     len = strlen( (char *)module + exports->Name );
 630     if (len > 4 && !strcasecmp( (char *)module + exports->Name + len - 4, ".dll" )) len -= 4;
 631     len = min( len, sizeof(data->dllname) - 1 );
 632     memcpy( data->dllname, (char *)module + exports->Name, len );
 633     data->dllname[len] = 0;
 634
 635     /* fetch name pointer for all entry points and store them in the private structure */
 636
 637     ordptr = (const WORD *)((char *)module + exports->AddressOfNameOrdinals);
 638     for (i = 0; i < exports->NumberOfNames; i++, ordptr++)
 639     {
 640         DWORD name_rva = ((DWORD*)((char *)module + exports->AddressOfNames))[i];
 641         data->entry_points[*ordptr].name = (const char *)module + name_rva;
 642     }
 643
 644     /* patch the functions in the export table to point to the relay thunks */
 645
 646     funcs = (DWORD *)((char *)module + exports->AddressOfFunctions);
 647     entry_point_rva = descr->entry_point_base - (const char *)module;
 648     for (i = 0; i < exports->NumberOfFunctions; i++, funcs++)
 649     {
 650         if (!descr->entry_point_offsets[i]) continue;   /* not a normal function */
 651         if (!check_relay_include( data->dllname, i + exports->Base, data->entry_points[i].name ))
 652             continue;  /* don't include this entry point */
 653
 654         data->entry_points[i].orig_func = (char *)module + *funcs;
 655         *funcs = entry_point_rva + descr->entry_point_offsets[i];
 656     }
 657 }
 658
 659 #else  /* __i386__ || __x86_64__ */
 660
 661 FARPROC RELAY_GetProcAddress( HMODULE module, const IMAGE_EXPORT_DIRECTORY *exports,
 662                               DWORD exp_size, FARPROC proc, DWORD ordinal, const WCHAR *user )
 663 {
 664     return proc;
 665 }
 666
 667 void RELAY_SetupDLL( HMODULE module )
 668 {
 669 }
 670
 671 #endif  /* __i386__ || __x86_64__ */
 672
 673
 674 /***********************************************************************/
 675 /* snoop support */
 676 /***********************************************************************/
 677
 678 #ifdef __i386__
 679
 680 WINE_DECLARE_DEBUG_CHANNEL(seh);
 681 WINE_DECLARE_DEBUG_CHANNEL(snoop);
 682
 683 #include "pshpack1.h"
 684
 685 typedef struct
 686 {
 687         /* code part */
 688         BYTE            lcall;          /* 0xe8 call snoopentry (relative) */
 689         /* NOTE: If you move snoopentry OR nrofargs fix the relative offset
 690          * calculation!
 691          */
 692         DWORD           snoopentry;     /* SNOOP_Entry relative */
 693         /* unreached */
 694         int             nrofargs;
 695         FARPROC origfun;
 696         const char *name;
 697 } SNOOP_FUN;
 698
 699 typedef struct tagSNOOP_DLL {
 700         HMODULE hmod;
 701         SNOOP_FUN       *funs;
 702         DWORD           ordbase;
 703         DWORD           nrofordinals;
 704         struct tagSNOOP_DLL     *next;
 705         char name[1];
 706 } SNOOP_DLL;
 707
 708 typedef struct
 709 {
 710         /* code part */
 711         BYTE            lcall;          /* 0xe8 call snoopret relative*/
 712         /* NOTE: If you move snoopret OR origreturn fix the relative offset
 713          * calculation!
 714          */
 715         DWORD           snoopret;       /* SNOOP_Ret relative */
 716         /* unreached */
 717         FARPROC origreturn;
 718         SNOOP_DLL       *dll;
 719         DWORD           ordinal;
 720         DWORD           origESP;
 721         DWORD           *args;          /* saved args across a stdcall */
 722 } SNOOP_RETURNENTRY;
 723
 724 typedef struct tagSNOOP_RETURNENTRIES {
 725         SNOOP_RETURNENTRY entry[4092/sizeof(SNOOP_RETURNENTRY)];
 726         struct tagSNOOP_RETURNENTRIES   *next;
 727 } SNOOP_RETURNENTRIES;
 728
 729 #include "poppack.h"
 730
 731 extern void WINAPI SNOOP_Entry(void);
 732 extern void WINAPI SNOOP_Return(void);
 733
 734 static SNOOP_DLL *firstdll;
 735 static SNOOP_RETURNENTRIES *firstrets;
 736
 737
 738 /***********************************************************************
 739  *          SNOOP_ShowDebugmsgSnoop
 740  *
 741  * Simple function to decide if a particular debugging message is
 742  * wanted.
 743  */
 744 static BOOL SNOOP_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
 745 {
 746     if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
 747         return FALSE;
 748     if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
 749         return FALSE;
 750     return TRUE;
 751 }
 752
 753
 754 /***********************************************************************
 755  *           SNOOP_SetupDLL
 756  *
 757  * Setup snoop debugging for a native dll.
 758  */
 759 void SNOOP_SetupDLL(HMODULE hmod)
 760 {
 761     SNOOP_DLL **dll = &firstdll;
 762     char *p, *name;
 763     void *addr;
 764     SIZE_T size;
 765     ULONG size32;
 766     IMAGE_EXPORT_DIRECTORY *exports;
 767
 768     if (!init_done) init_debug_lists();
 769
 770     exports = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_EXPORT, &size32 );
 771     if (!exports || !exports->NumberOfFunctions) return;
 772     name = (char *)hmod + exports->Name;
 773     size = size32;
 774
 775     TRACE_(snoop)("hmod=%p, name=%s\n", hmod, name);
 776
 777     while (*dll) {
 778         if ((*dll)->hmod == hmod)
 779         {
 780             /* another dll, loaded at the same address */
 781             addr = (*dll)->funs;
 782             size = (*dll)->nrofordinals * sizeof(SNOOP_FUN);
 783             NtFreeVirtualMemory(NtCurrentProcess(), &addr, &size, MEM_RELEASE);
 784             break;
 785         }
 786         dll = &((*dll)->next);
 787     }
 788     if (*dll)
 789         *dll = RtlReAllocateHeap(GetProcessHeap(),
 790                              HEAP_ZERO_MEMORY, *dll,
 791                              sizeof(SNOOP_DLL) + strlen(name));
 792     else
 793         *dll = RtlAllocateHeap(GetProcessHeap(),
 794                              HEAP_ZERO_MEMORY,
 795                              sizeof(SNOOP_DLL) + strlen(name));
 796     (*dll)->hmod        = hmod;
 797     (*dll)->ordbase = exports->Base;
 798     (*dll)->nrofordinals = exports->NumberOfFunctions;
 799     strcpy( (*dll)->name, name );
 800     p = (*dll)->name + strlen((*dll)->name) - 4;
 801     if (p > (*dll)->name && !strcasecmp( p, ".dll" )) *p = 0;
 802
 803     size = exports->NumberOfFunctions * sizeof(SNOOP_FUN);
 804     addr = NULL;
 805     NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size,
 806                             MEM_COMMIT | MEM_RESERVE, PAGE_EXECUTE_READWRITE);
 807     if (!addr) {
 808         RtlFreeHeap(GetProcessHeap(),0,*dll);
 809         FIXME("out of memory\n");
 810         return;
 811     }
 812     (*dll)->funs = addr;
 813     memset((*dll)->funs,0,size);
 814 }
 815
 816
 817 /***********************************************************************
 818  *           SNOOP_GetProcAddress
 819  *
 820  * Return the proc address to use for a given function.
 821  */
 822 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports,
 823                               DWORD exp_size, FARPROC origfun, DWORD ordinal,
 824                               const WCHAR *user)
 825 {
 826     unsigned int i;
 827     const char *ename;
 828     const WORD *ordinals;
 829     const DWORD *names;
 830     SNOOP_DLL *dll = firstdll;
 831     SNOOP_FUN *fun;
 832     const IMAGE_SECTION_HEADER *sec;
 833
 834     if (!TRACE_ON(snoop)) return origfun;
 835     if (!check_from_module( debug_from_snoop_includelist, debug_from_snoop_excludelist, user ))
 836         return origfun; /* the calling module was explicitly excluded */
 837
 838     if (!*(LPBYTE)origfun) /* 0x00 is an impossible opcode, possible dataref. */
 839         return origfun;
 840
 841     sec = RtlImageRvaToSection( RtlImageNtHeader(hmod), hmod, (char *)origfun - (char *)hmod );
 842
 843     if (!sec || !(sec->Characteristics & IMAGE_SCN_CNT_CODE))
 844         return origfun;  /* most likely a data reference */
 845
 846     while (dll) {
 847         if (hmod == dll->hmod)
 848             break;
 849         dll = dll->next;
 850     }
 851     if (!dll)   /* probably internal */
 852         return origfun;
 853
 854     /* try to find a name for it */
 855     ename = NULL;
 856     names = (const DWORD *)((const char *)hmod + exports->AddressOfNames);
 857     ordinals = (const WORD *)((const char *)hmod + exports->AddressOfNameOrdinals);
 858     if (names) for (i = 0; i < exports->NumberOfNames; i++)
 859     {
 860         if (ordinals[i] == ordinal)
 861         {
 862             ename = (const char *)hmod + names[i];
 863             break;
 864         }
 865     }
 866     if (!SNOOP_ShowDebugmsgSnoop(dll->name,ordinal,ename))
 867         return origfun;
 868     assert(ordinal < dll->nrofordinals);
 869     fun = dll->funs + ordinal;
 870     if (!fun->name)
 871     {
 872         fun->name       = ename;
 873         fun->lcall      = 0xe8;
 874         /* NOTE: origreturn struct member MUST come directly after snoopentry */
 875         fun->snoopentry = (char*)SNOOP_Entry-((char*)(&fun->nrofargs));
 876         fun->origfun    = origfun;
 877         fun->nrofargs   = -1;
 878     }
 879     return (FARPROC)&(fun->lcall);
 880 }
 881
 882 static void SNOOP_PrintArg(DWORD x)
 883 {
 884     int i,nostring;
 885
 886     DPRINTF("%08x",x);
 887     if (IS_INTARG(x) || TRACE_ON(seh)) return; /* trivial reject to avoid faults */
 888     __TRY
 889     {
 890         LPBYTE s=(LPBYTE)x;
 891         i=0;nostring=0;
 892         while (i<80) {
 893             if (s[i]==0) break;
 894             if (s[i]<0x20) {nostring=1;break;}
 895             if (s[i]>=0x80) {nostring=1;break;}
 896             i++;
 897         }
 898         if (!nostring && i > 5)
 899             DPRINTF(" %s",debugstr_an((LPSTR)x,i));
 900         else  /* try unicode */
 901         {
 902             LPWSTR s=(LPWSTR)x;
 903             i=0;nostring=0;
 904             while (i<80) {
 905                 if (s[i]==0) break;
 906                 if (s[i]<0x20) {nostring=1;break;}
 907                 if (s[i]>0x100) {nostring=1;break;}
 908                 i++;
 909             }
 910             if (!nostring && i > 5) DPRINTF(" %s",debugstr_wn((LPWSTR)x,i));
 911         }
 912     }
 913     __EXCEPT_PAGE_FAULT
 914     {
 915     }
 916     __ENDTRY
 917 }
 918
 919 #define CALLER1REF (*(DWORD*)context->Esp)
 920
 921 void WINAPI __regs_SNOOP_Entry( CONTEXT86 *context )
 922 {
 923         DWORD           ordinal=0,entry = context->Eip - 5;
 924         SNOOP_DLL       *dll = firstdll;
 925         SNOOP_FUN       *fun = NULL;
 926         SNOOP_RETURNENTRIES     **rets = &firstrets;
 927         SNOOP_RETURNENTRY       *ret;
 928         int             i=0, max;
 929
 930         while (dll) {
 931                 if (    ((char*)entry>=(char*)dll->funs)        &&
 932                         ((char*)entry<=(char*)(dll->funs+dll->nrofordinals))
 933                 ) {
 934                         fun = (SNOOP_FUN*)entry;
 935                         ordinal = fun-dll->funs;
 936                         break;
 937                 }
 938                 dll=dll->next;
 939         }
 940         if (!dll) {
 941                 FIXME("entrypoint 0x%08x not found\n",entry);
 942                 return; /* oops */
 943         }
 944         /* guess cdecl ... */
 945         if (fun->nrofargs<0) {
 946                 /* Typical cdecl return frame is:
 947                  *     add esp, xxxxxxxx
 948                  * which has (for xxxxxxxx up to 255 the opcode "83 C4 xx".
 949                  * (after that 81 C2 xx xx xx xx)
 950                  */
 951                 LPBYTE  reteip = (LPBYTE)CALLER1REF;
 952
 953                 if (reteip) {
 954                         if ((reteip[0]==0x83)&&(reteip[1]==0xc4))
 955                                 fun->nrofargs=reteip[2]/4;
 956                 }
 957         }
 958
 959
 960         while (*rets) {
 961                 for (i=0;i<sizeof((*rets)->entry)/sizeof((*rets)->entry[0]);i++)
 962                         if (!(*rets)->entry[i].origreturn)
 963                                 break;
 964                 if (i!=sizeof((*rets)->entry)/sizeof((*rets)->entry[0]))
 965                         break;
 966                 rets = &((*rets)->next);
 967         }
 968         if (!*rets) {
 969                 SIZE_T size = 4096;
 970                 VOID* addr = NULL;
 971
 972                 NtAllocateVirtualMemory(NtCurrentProcess(), &addr, 0, &size,
 973                                         MEM_COMMIT | MEM_RESERVE,
 974                                         PAGE_EXECUTE_READWRITE);
 975                 if (!addr) return;
 976                 *rets = addr;
 977                 memset(*rets,0,4096);
 978                 i = 0;  /* entry 0 is free */
 979         }
 980         ret = &((*rets)->entry[i]);
 981         ret->lcall      = 0xe8;
 982         /* NOTE: origreturn struct member MUST come directly after snoopret */
 983         ret->snoopret   = ((char*)SNOOP_Return)-(char*)(&ret->origreturn);
 984         ret->origreturn = (FARPROC)CALLER1REF;
 985         CALLER1REF      = (DWORD)&ret->lcall;
 986         ret->dll        = dll;
 987         ret->args       = NULL;
 988         ret->ordinal    = ordinal;
 989         ret->origESP    = context->Esp;
 990
 991         context->Eip = (DWORD)fun->origfun;
 992
 993         if (fun->name) DPRINTF("%04x:CALL %s.%s(",GetCurrentThreadId(),dll->name,fun->name);
 994         else DPRINTF("%04x:CALL %s.%d(",GetCurrentThreadId(),dll->name,dll->ordbase+ordinal);
 995         if (fun->nrofargs>0) {
 996                 max = fun->nrofargs; if (max>16) max=16;
 997                 for (i=0;i<max;i++)
 998                 {
 999                     SNOOP_PrintArg(*(DWORD*)(context->Esp + 4 + sizeof(DWORD)*i));
1000                     if (i<fun->nrofargs-1) DPRINTF(",");
1001                 }
1002                 if (max!=fun->nrofargs)
1003                         DPRINTF(" ...");
1004         } else if (fun->nrofargs<0) {
1005                 DPRINTF("<unknown, check return>");
1006                 ret->args = RtlAllocateHeap(GetProcessHeap(),
1007                                             0,16*sizeof(DWORD));
1008                 memcpy(ret->args,(LPBYTE)(context->Esp + 4),sizeof(DWORD)*16);
1009         }
1010         DPRINTF(") ret=%08x\n",(DWORD)ret->origreturn);
1011 }
1012
1013
1014 void WINAPI __regs_SNOOP_Return( CONTEXT86 *context )
1015 {
1016         SNOOP_RETURNENTRY       *ret = (SNOOP_RETURNENTRY*)(context->Eip - 5);
1017         SNOOP_FUN *fun = &ret->dll->funs[ret->ordinal];
1018
1019         /* We haven't found out the nrofargs yet. If we called a cdecl
1020          * function it is too late anyway and we can just set '0' (which
1021          * will be the difference between orig and current ESP
1022          * If stdcall -> everything ok.
1023          */
1024         if (ret->dll->funs[ret->ordinal].nrofargs<0)
1025                 ret->dll->funs[ret->ordinal].nrofargs=(context->Esp - ret->origESP-4)/4;
1026         context->Eip = (DWORD)ret->origreturn;
1027         if (ret->args) {
1028                 int     i,max;
1029
1030                 if (fun->name)
1031                     DPRINTF("%04x:RET  %s.%s(", GetCurrentThreadId(), ret->dll->name, fun->name);
1032                 else
1033                     DPRINTF("%04x:RET  %s.%d(", GetCurrentThreadId(),
1034                             ret->dll->name,ret->dll->ordbase+ret->ordinal);
1035
1036                 max = fun->nrofargs;
1037                 if (max>16) max=16;
1038
1039                 for (i=0;i<max;i++)
1040                 {
1041                     SNOOP_PrintArg(ret->args[i]);
1042                     if (i<max-1) DPRINTF(",");
1043                 }
1044                 DPRINTF(") retval=%08x ret=%08x\n",
1045                         context->Eax,(DWORD)ret->origreturn );
1046                 RtlFreeHeap(GetProcessHeap(),0,ret->args);
1047                 ret->args = NULL;
1048         }
1049         else
1050         {
1051             if (fun->name)
1052                 DPRINTF("%04x:RET  %s.%s() retval=%08x ret=%08x\n",
1053                         GetCurrentThreadId(),
1054                         ret->dll->name, fun->name, context->Eax, (DWORD)ret->origreturn);
1055             else
1056                 DPRINTF("%04x:RET  %s.%d() retval=%08x ret=%08x\n",
1057                         GetCurrentThreadId(),
1058                         ret->dll->name,ret->dll->ordbase+ret->ordinal,
1059                         context->Eax, (DWORD)ret->origreturn);
1060         }
1061         ret->origreturn = NULL; /* mark as empty */
1062 }
1063
1064 /* assembly wrappers that save the context */
1065 DEFINE_REGS_ENTRYPOINT( SNOOP_Entry, 0 )
1066 DEFINE_REGS_ENTRYPOINT( SNOOP_Return, 0 )
1067
1068 #else  /* __i386__ */
1069
1070 FARPROC SNOOP_GetProcAddress( HMODULE hmod, const IMAGE_EXPORT_DIRECTORY *exports, DWORD exp_size,
1071                               FARPROC origfun, DWORD ordinal, const WCHAR *user )
1072 {
1073     return origfun;
1074 }
1075
1076 void SNOOP_SetupDLL( HMODULE hmod )
1077 {
1078     FIXME("snooping works only on i386 for now.\n");
1079 }
1080
1081 #endif /* __i386__ */