2 * Win32 relay and snoop functions
4 * Copyright 1997 Alexandre Julliard
5 * Copyright 1998 Marcus Meissner
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
31 #define WIN32_NO_STATUS
34 #include "wine/exception.h"
35 #include "ntdll_misc.h"
36 #include "wine/unicode.h"
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(relay
);
41 #if defined(__i386__) || defined(__x86_64__) || defined(__arm__) || defined(__aarch64__)
43 struct relay_descr
/* descriptor for a module */
45 void *magic
; /* signature */
46 void *relay_call
; /* functions to call from relay thunks */
47 void *private; /* reserved for the relay code private data */
48 const char *entry_point_base
; /* base address of entry point thunks */
49 const unsigned int *entry_point_offsets
; /* offsets of entry points thunks */
50 const char *args_string
; /* string describing the arguments */
53 #define RELAY_DESCR_MAGIC ((void *)0xdeb90002)
54 #define IS_INTARG(x) (((ULONG_PTR)(x) >> 16) == 0)
56 /* private data built at dll load time */
58 struct relay_entry_point
60 void *orig_func
; /* original entry point function */
61 const char *name
; /* function name (if any) */
64 struct relay_private_data
66 HMODULE module
; /* module handle of this dll */
67 unsigned int base
; /* ordinal base */
68 char dllname
[40]; /* dll name (without .dll extension) */
69 struct relay_entry_point entry_points
[1]; /* list of dll entry points */
72 static const WCHAR
**debug_relay_excludelist
;
73 static const WCHAR
**debug_relay_includelist
;
74 static const WCHAR
**debug_snoop_excludelist
;
75 static const WCHAR
**debug_snoop_includelist
;
76 static const WCHAR
**debug_from_relay_excludelist
;
77 static const WCHAR
**debug_from_relay_includelist
;
78 static const WCHAR
**debug_from_snoop_excludelist
;
79 static const WCHAR
**debug_from_snoop_includelist
;
81 static RTL_RUN_ONCE init_once
= RTL_RUN_ONCE_INIT
;
83 /* compare an ASCII and a Unicode string without depending on the current codepage */
84 static inline int strcmpAW( const char *strA
, const WCHAR
*strW
)
86 while (*strA
&& ((unsigned char)*strA
== *strW
)) { strA
++; strW
++; }
87 return (unsigned char)*strA
- *strW
;
90 /* compare an ASCII and a Unicode string without depending on the current codepage */
91 static inline int strncmpiAW( const char *strA
, const WCHAR
*strW
, int n
)
94 for ( ; n
> 0; n
--, strA
++, strW
++)
95 if ((ret
= toupperW((unsigned char)*strA
) - toupperW(*strW
)) || !*strA
) break;
99 /***********************************************************************
102 * Build a function list from a ';'-separated string.
104 static const WCHAR
**build_list( const WCHAR
*buffer
)
107 const WCHAR
*p
= buffer
;
110 while ((p
= strchrW( p
, ';' )))
115 /* allocate count+1 pointers, plus the space for a copy of the string */
116 if ((ret
= RtlAllocateHeap( GetProcessHeap(), 0,
117 (count
+1) * sizeof(WCHAR
*) + (strlenW(buffer
)+1) * sizeof(WCHAR
) )))
119 WCHAR
*str
= (WCHAR
*)(ret
+ count
+ 1);
122 strcpyW( str
, buffer
);
127 if (!(q
= strchrW( q
, ';' ))) break;
135 /***********************************************************************
138 * Load a function list from a registry value.
140 static const WCHAR
**load_list( HKEY hkey
, const WCHAR
*value
)
142 char initial_buffer
[4096];
143 char *buffer
= initial_buffer
;
147 const WCHAR
**list
= NULL
;
149 RtlInitUnicodeString( &name
, value
);
150 status
= NtQueryValueKey( hkey
, &name
, KeyValuePartialInformation
, buffer
, sizeof(initial_buffer
), &count
);
151 if (status
== STATUS_BUFFER_OVERFLOW
)
153 buffer
= RtlAllocateHeap( GetProcessHeap(), 0, count
);
154 status
= NtQueryValueKey( hkey
, &name
, KeyValuePartialInformation
, buffer
, count
, &count
);
156 if (status
== STATUS_SUCCESS
)
158 WCHAR
*str
= (WCHAR
*)((KEY_VALUE_PARTIAL_INFORMATION
*)buffer
)->Data
;
159 list
= build_list( str
);
160 if (list
) TRACE( "%s = %s\n", debugstr_w(value
), debugstr_w(str
) );
163 if (buffer
!= initial_buffer
) RtlFreeHeap( GetProcessHeap(), 0, buffer
);
167 /***********************************************************************
170 * Build the relay include/exclude function lists.
172 static DWORD WINAPI
init_debug_lists( RTL_RUN_ONCE
*once
, void *param
, void **context
)
174 OBJECT_ATTRIBUTES attr
;
177 static const WCHAR configW
[] = {'S','o','f','t','w','a','r','e','\\',
178 'W','i','n','e','\\',
179 'D','e','b','u','g',0};
180 static const WCHAR RelayIncludeW
[] = {'R','e','l','a','y','I','n','c','l','u','d','e',0};
181 static const WCHAR RelayExcludeW
[] = {'R','e','l','a','y','E','x','c','l','u','d','e',0};
182 static const WCHAR SnoopIncludeW
[] = {'S','n','o','o','p','I','n','c','l','u','d','e',0};
183 static const WCHAR SnoopExcludeW
[] = {'S','n','o','o','p','E','x','c','l','u','d','e',0};
184 static const WCHAR RelayFromIncludeW
[] = {'R','e','l','a','y','F','r','o','m','I','n','c','l','u','d','e',0};
185 static const WCHAR RelayFromExcludeW
[] = {'R','e','l','a','y','F','r','o','m','E','x','c','l','u','d','e',0};
186 static const WCHAR SnoopFromIncludeW
[] = {'S','n','o','o','p','F','r','o','m','I','n','c','l','u','d','e',0};
187 static const WCHAR SnoopFromExcludeW
[] = {'S','n','o','o','p','F','r','o','m','E','x','c','l','u','d','e',0};
189 RtlOpenCurrentUser( KEY_ALL_ACCESS
, &root
);
190 attr
.Length
= sizeof(attr
);
191 attr
.RootDirectory
= root
;
192 attr
.ObjectName
= &name
;
194 attr
.SecurityDescriptor
= NULL
;
195 attr
.SecurityQualityOfService
= NULL
;
196 RtlInitUnicodeString( &name
, configW
);
198 /* @@ Wine registry key: HKCU\Software\Wine\Debug */
199 if (NtOpenKey( &hkey
, KEY_ALL_ACCESS
, &attr
)) hkey
= 0;
201 if (!hkey
) return TRUE
;
203 debug_relay_includelist
= load_list( hkey
, RelayIncludeW
);
204 debug_relay_excludelist
= load_list( hkey
, RelayExcludeW
);
205 debug_snoop_includelist
= load_list( hkey
, SnoopIncludeW
);
206 debug_snoop_excludelist
= load_list( hkey
, SnoopExcludeW
);
207 debug_from_relay_includelist
= load_list( hkey
, RelayFromIncludeW
);
208 debug_from_relay_excludelist
= load_list( hkey
, RelayFromExcludeW
);
209 debug_from_snoop_includelist
= load_list( hkey
, SnoopFromIncludeW
);
210 debug_from_snoop_excludelist
= load_list( hkey
, SnoopFromExcludeW
);
217 /***********************************************************************
220 * Check if a given module and function is in the list.
222 static BOOL
check_list( const char *module
, int ordinal
, const char *func
, const WCHAR
*const *list
)
226 sprintf( ord_str
, "%d", ordinal
);
229 const WCHAR
*p
= strrchrW( *list
, '.' );
230 if (p
&& p
> *list
) /* check module and function */
233 if (strncmpiAW( module
, *list
, len
-1 ) || module
[len
]) continue;
234 if (p
[1] == '*' && !p
[2]) return TRUE
;
235 if (!strcmpAW( ord_str
, p
+ 1 )) return TRUE
;
236 if (func
&& !strcmpAW( func
, p
+ 1 )) return TRUE
;
238 else /* function only */
240 if (func
&& !strcmpAW( func
, *list
)) return TRUE
;
247 /***********************************************************************
248 * check_relay_include
250 * Check if a given function must be included in the relay output.
252 static BOOL
check_relay_include( const char *module
, int ordinal
, const char *func
)
254 if (debug_relay_excludelist
&& check_list( module
, ordinal
, func
, debug_relay_excludelist
))
256 if (debug_relay_includelist
&& !check_list( module
, ordinal
, func
, debug_relay_includelist
))
261 /***********************************************************************
264 * Check if calls from a given module must be included in the relay/snoop output,
265 * given the exclusion and inclusion lists.
267 static BOOL
check_from_module( const WCHAR
**includelist
, const WCHAR
**excludelist
, const WCHAR
*module
)
269 static const WCHAR dllW
[] = {'.','d','l','l',0 };
270 const WCHAR
**listitem
;
273 if (!module
) return TRUE
;
274 if (!includelist
&& !excludelist
) return TRUE
;
278 listitem
= excludelist
;
283 listitem
= includelist
;
285 for(; *listitem
; listitem
++)
289 if (!strcmpiW( *listitem
, module
)) return !show
;
290 len
= strlenW( *listitem
);
291 if (!strncmpiW( *listitem
, module
, len
) && !strcmpiW( module
+ len
, dllW
))
298 static BOOL
is_ret_val( char type
)
300 return type
>= 'A' && type
<= 'Z';
303 static const char *func_name( struct relay_private_data
*data
, unsigned int ordinal
)
305 struct relay_entry_point
*entry_point
= data
->entry_points
+ ordinal
;
307 if (entry_point
->name
)
308 return wine_dbg_sprintf( "%s.%s", data
->dllname
, entry_point
->name
);
310 return wine_dbg_sprintf( "%s.%u", data
->dllname
, data
->base
+ ordinal
);
313 static void trace_string_a( INT_PTR ptr
)
315 if (!IS_INTARG( ptr
)) TRACE( "%08lx %s", ptr
, debugstr_a( (char *)ptr
));
316 else TRACE( "%08lx", ptr
);
319 static void trace_string_w( INT_PTR ptr
)
321 if (!IS_INTARG( ptr
)) TRACE( "%08lx %s", ptr
, debugstr_w( (WCHAR
*)ptr
));
322 else TRACE( "%08lx", ptr
);
327 /***********************************************************************
330 DECLSPEC_HIDDEN
void * WINAPI
relay_trace_entry( struct relay_descr
*descr
, unsigned int idx
,
331 const DWORD
*stack
, unsigned int *nb_args
)
333 WORD ordinal
= LOWORD(idx
);
334 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
335 struct relay_private_data
*data
= descr
->private;
336 struct relay_entry_point
*entry_point
= data
->entry_points
+ ordinal
;
339 TRACE( "\1Call %s(", func_name( data
, ordinal
));
341 for (i
= pos
= 0; !is_ret_val( arg_types
[i
] ); i
++)
343 switch (arg_types
[i
])
345 case 'j': /* int64 */
346 TRACE( "%x%08x", stack
[pos
+1], stack
[pos
] );
349 case 'k': /* int128 */
350 TRACE( "{%08x,%08x,%08x,%08x}", stack
[pos
], stack
[pos
+1], stack
[pos
+2], stack
[pos
+3] );
354 trace_string_a( stack
[pos
++] );
357 trace_string_w( stack
[pos
++] );
359 case 'f': /* float */
360 TRACE( "%g", *(const float *)&stack
[pos
++] );
362 case 'd': /* double */
363 TRACE( "%g", *(const double *)&stack
[pos
] );
368 TRACE( "%08x", stack
[pos
++] );
371 if (!is_ret_val( arg_types
[i
+1] )) TRACE( "," );
374 if (arg_types
[0] == 't') *nb_args
|= 0x80000000; /* thiscall */
375 TRACE( ") ret=%08x\n", stack
[-1] );
376 return entry_point
->orig_func
;
379 /***********************************************************************
382 DECLSPEC_HIDDEN
void WINAPI
relay_trace_exit( struct relay_descr
*descr
, unsigned int idx
,
383 void *retaddr
, LONGLONG retval
)
385 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
387 TRACE( "\1Ret %s()", func_name( descr
->private, LOWORD(idx
) ));
389 while (!is_ret_val( *arg_types
)) arg_types
++;
390 if (*arg_types
== 'J') /* int64 return value */
391 TRACE( " retval=%08x%08x ret=%08x\n",
392 (UINT
)(retval
>> 32), (UINT
)retval
, (UINT
)retaddr
);
394 TRACE( " retval=%08x ret=%08x\n", (UINT
)retval
, (UINT
)retaddr
);
397 extern LONGLONG WINAPI
relay_call( struct relay_descr
*descr
, unsigned int idx
);
398 __ASM_GLOBAL_FUNC( relay_call
,
400 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
401 __ASM_CFI(".cfi_rel_offset %ebp,0\n\t")
403 __ASM_CFI(".cfi_def_cfa_register %ebp\n\t")
405 __ASM_CFI(".cfi_rel_offset %esi,-4\n\t")
407 __ASM_CFI(".cfi_rel_offset %edi,-8\n\t")
409 __ASM_CFI(".cfi_rel_offset %ecx,-12\n\t")
410 /* trace the parameters */
412 "pushl %esp\n\t" /* number of args return ptr */
413 "leal 20(%ebp),%esi\n\t" /* stack */
417 "call " __ASM_NAME("relay_trace_entry") "\n\t"
418 /* copy the arguments*/
419 "movl -16(%ebp),%ecx\n\t" /* number of args */
421 "andl $0x7fffffff,%ecx\n\t"
422 "leal 0(,%ecx,4),%edx\n\t"
428 "testl $0x80000000,-16(%ebp)\n\t" /* thiscall */
431 /* call the entry point */
435 /* trace the return value */
436 "leal -20(%ebp),%esp\n\t"
442 "call " __ASM_NAME("relay_trace_exit") "\n\t"
443 /* restore return value and return */
444 "leal -12(%ebp),%esp\n\t"
448 __ASM_CFI(".cfi_same_value %ecx\n\t")
450 __ASM_CFI(".cfi_same_value %edi\n\t")
452 __ASM_CFI(".cfi_same_value %esi\n\t")
454 __ASM_CFI(".cfi_def_cfa %esp,4\n\t")
455 __ASM_CFI(".cfi_same_value %ebp\n\t")
458 #elif defined(__arm__)
460 /***********************************************************************
463 DECLSPEC_HIDDEN
void * WINAPI
relay_trace_entry( struct relay_descr
*descr
, unsigned int idx
,
464 const DWORD
*stack
, unsigned int *nb_args
)
466 WORD ordinal
= LOWORD(idx
);
467 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
468 struct relay_private_data
*data
= descr
->private;
469 struct relay_entry_point
*entry_point
= data
->entry_points
+ ordinal
;
472 unsigned int float_pos
= 0, double_pos
= 0;
473 const union fpregs
{ float s
[16]; double d
[8]; } *fpstack
= (const union fpregs
*)stack
- 1;
476 TRACE( "\1Call %s(", func_name( data
, ordinal
));
478 for (i
= pos
= 0; !is_ret_val( arg_types
[i
] ); i
++)
480 switch (arg_types
[i
])
482 case 'j': /* int64 */
483 pos
= (pos
+ 1) & ~1;
484 TRACE( "%x%08x", stack
[pos
+1], stack
[pos
] );
487 case 'k': /* int128 */
488 TRACE( "{%08x,%08x,%08x,%08x}", stack
[pos
], stack
[pos
+1], stack
[pos
+2], stack
[pos
+3] );
492 trace_string_a( stack
[pos
++] );
495 trace_string_w( stack
[pos
++] );
497 case 'f': /* float */
499 if (!(float_pos
% 2)) float_pos
= max( float_pos
, double_pos
* 2 );
502 TRACE( "%g", fpstack
->s
[float_pos
++] );
506 TRACE( "%g", *(const float *)&stack
[pos
++] );
508 case 'd': /* double */
510 double_pos
= max( (float_pos
+ 1) / 2, double_pos
);
513 TRACE( "%g", fpstack
->d
[double_pos
++] );
517 pos
= (pos
+ 1) & ~1;
518 TRACE( "%g", *(const double *)&stack
[pos
] );
523 TRACE( "%08x", stack
[pos
++] );
526 if (!is_ret_val( arg_types
[i
+1] )) TRACE( "," );
530 if (float_pos
|| double_pos
)
533 stack
= (const DWORD
*)fpstack
; /* retaddr is below the fp regs */
537 TRACE( ") ret=%08x\n", stack
[-1] );
538 return entry_point
->orig_func
;
541 /***********************************************************************
544 DECLSPEC_HIDDEN
void WINAPI
relay_trace_exit( struct relay_descr
*descr
, unsigned int idx
,
545 DWORD retaddr
, LONGLONG retval
)
547 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
549 TRACE( "\1Ret %s()", func_name( descr
->private, LOWORD(idx
) ));
551 while (!is_ret_val( *arg_types
)) arg_types
++;
552 if (*arg_types
== 'J') /* int64 return value */
553 TRACE( " retval=%08x%08x ret=%08x\n",
554 (UINT
)(retval
>> 32), (UINT
)retval
, retaddr
);
556 TRACE( " retval=%08x ret=%08x\n", (UINT
)retval
, retaddr
);
559 extern LONGLONG WINAPI
relay_call( struct relay_descr
*descr
, unsigned int idx
, const DWORD
*stack
);
560 __ASM_GLOBAL_FUNC( relay_call
,
562 "push {r4-r8,lr}\n\t"
565 "add r3, sp, #12\n\t"
568 "bl " __ASM_NAME("relay_trace_entry") "\n\t"
569 "mov ip, r0\n\t" /* entry point */
571 "ldr r1, [sp, #12]\n\t" /* number of args */
573 "subs r3, #16\n\t" /* first 4 args are in registers */
577 "add r2, r6, #16\n\t" /* skip r0-r3 */
578 "1:\tsubs r3, r3, #4\n\t"
579 "ldr r0, [r2, r3]\n\t"
580 "str r0, [sp, r3]\n\t"
584 "tst r1, #0x80000000\n\t"
585 "ldm r6, {r0-r3}\n\t"
586 "vldmdbne r6!, {s0-s15}\n\t"
588 "ldm r6, {r0-r3}\n\t"
592 "ldr r2, [r6, #-4]\n\t" /* retaddr */
598 "str r5, [sp, #4]\n\t"
600 "vstr d0, [sp, #8]\n\t" /* preserve floating point retval */
601 "bl " __ASM_NAME("relay_trace_exit") "\n\t"
602 "vldr d0, [sp, #8]\n\t"
604 "bl " __ASM_NAME("relay_trace_exit") "\n\t"
611 #elif defined(__aarch64__)
613 /***********************************************************************
616 DECLSPEC_HIDDEN
void * WINAPI
relay_trace_entry( struct relay_descr
*descr
, unsigned int idx
,
617 const INT_PTR
*stack
, unsigned int *nb_args
)
619 WORD ordinal
= LOWORD(idx
);
620 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
621 struct relay_private_data
*data
= descr
->private;
622 struct relay_entry_point
*entry_point
= data
->entry_points
+ ordinal
;
625 TRACE( "\1Call %s(", func_name( data
, ordinal
));
627 for (i
= 0; !is_ret_val( arg_types
[i
] ); i
++)
629 switch (arg_types
[i
])
632 trace_string_a( stack
[i
] );
635 trace_string_w( stack
[i
] );
639 TRACE( "%08lx", stack
[i
] );
642 if (!is_ret_val( arg_types
[i
+ 1] )) TRACE( "," );
645 TRACE( ") ret=%08lx\n", stack
[-1] );
646 return entry_point
->orig_func
;
649 /***********************************************************************
652 DECLSPEC_HIDDEN
void WINAPI
relay_trace_exit( struct relay_descr
*descr
, unsigned int idx
,
653 INT_PTR retaddr
, INT_PTR retval
)
655 TRACE( "\1Ret %s() retval=%08lx ret=%08lx\n",
656 func_name( descr
->private, LOWORD(idx
) ), retval
, retaddr
);
659 extern LONGLONG CDECL
call_entry_point( void *func
, int nb_args
, const INT_PTR
*args
);
660 __ASM_GLOBAL_FUNC( call_entry_point
,
661 "stp x29, x30, [SP,#-16]!\n\t"
662 "stp x19, x20, [SP,#-16]!\n\t"
665 "ldp x8, x9, [x19, #-32]\n\t"
671 "ldp x0, x1, [x11], #16\n\t"
672 "add w12, w12, #2\n\t"
675 "ldp x2, x3, [x11], #16\n\t"
676 "add w12, w12, #2\n\t"
679 "ldp x4, x5, [x11], #16\n\t"
680 "add w12, w12, #2\n\t"
683 "ldp x6, x7, [x11], #16\n\t"
684 "add w12, w12, #2\n\t"
687 "sub w12, w10, #8\n\t"
688 "lsl w12, w12, #3\n\t"
689 "sub SP, SP, w12, uxtw\n\t"
690 "tbz w12, #3, 1f\n\t"
692 "1: sub w12, w12, #8\n\t"
693 "ldr x13, [x11, x12]\n\t"
694 "str x13, [SP, x12]\n\t"
698 "ldp x19, x20, [SP], #16\n\t"
699 "ldp x29, x30, [SP], #16\n\t"
702 static LONGLONG WINAPI
relay_call( struct relay_descr
*descr
, unsigned int idx
, const INT_PTR
*stack
)
704 unsigned int nb_args
;
705 void *func
= relay_trace_entry( descr
, idx
, stack
, &nb_args
);
706 LONGLONG ret
= call_entry_point( func
, nb_args
, stack
);
707 relay_trace_exit( descr
, idx
, stack
[-1], ret
);
711 #elif defined(__x86_64__)
713 /***********************************************************************
716 DECLSPEC_HIDDEN
void * WINAPI
relay_trace_entry( struct relay_descr
*descr
, unsigned int idx
,
717 const INT_PTR
*stack
, unsigned int *nb_args
)
719 WORD ordinal
= LOWORD(idx
);
720 const char *arg_types
= descr
->args_string
+ HIWORD(idx
);
721 struct relay_private_data
*data
= descr
->private;
722 struct relay_entry_point
*entry_point
= data
->entry_points
+ ordinal
;
725 TRACE( "\1Call %s(", func_name( data
, ordinal
));
727 for (i
= 0; !is_ret_val( arg_types
[i
] ); i
++)
729 switch (arg_types
[i
])
732 trace_string_a( stack
[i
] );
735 trace_string_w( stack
[i
] );
737 case 'f': /* float */
738 TRACE( "%g", *(const float *)&stack
[i
] );
740 case 'd': /* double */
741 TRACE( "%g", *(const double *)&stack
[i
] );
745 TRACE( "%08lx", stack
[i
] );
748 if (!is_ret_val( arg_types
[i
] )) TRACE( "," );
751 TRACE( ") ret=%08lx\n", stack
[-1] );
752 return entry_point
->orig_func
;
755 /***********************************************************************
758 DECLSPEC_HIDDEN
void WINAPI
relay_trace_exit( struct relay_descr
*descr
, unsigned int idx
,
759 INT_PTR retaddr
, INT_PTR retval
)
761 TRACE( "\1Ret %s() retval=%08lx ret=%08lx\n",
762 func_name( descr
->private, LOWORD(idx
) ), retval
, retaddr
);
765 extern INT_PTR WINAPI
relay_call( struct relay_descr
*descr
, unsigned int idx
, const INT_PTR
*stack
);
766 __ASM_GLOBAL_FUNC( relay_call
,
768 __ASM_CFI(".cfi_adjust_cfa_offset 8\n\t")
769 __ASM_CFI(".cfi_rel_offset %rbp,0\n\t")
771 __ASM_CFI(".cfi_def_cfa_register %rbp\n\t")
772 "leaq -0x48(%rbp),%rsp\n\t"
774 "movq %rcx,-32(%rbp)\n\t"
775 __ASM_CFI(".cfi_rel_offset %rcx,-32\n\t")
776 "movq %rdx,-24(%rbp)\n\t"
777 __ASM_CFI(".cfi_rel_offset %rdx,-24\n\t")
778 "movq %rsi,-16(%rbp)\n\t"
779 __ASM_CFI(".cfi_rel_offset %rsi,-16\n\t")
780 "movq %rdi,-8(%rbp)\n\t"
781 __ASM_CFI(".cfi_rel_offset %rdi,-8\n\t")
782 /* trace the parameters */
783 "leaq 24(%rbp),%r8\n\t" /* stack */
784 "leaq -40(%rbp),%r9\n\t"
785 "call " __ASM_NAME("relay_trace_entry") "\n\t"
786 /* copy the arguments */
787 "movl -40(%rbp),%edx\n\t" /* number of args */
790 "cmovgq %rdx,%rcx\n\t"
791 "leaq -16(,%rcx,8),%rdx\n\t"
794 "leaq 24(%rbp),%rsi\n\t" /* original stack */
797 /* call the entry point */
798 "movq 0(%rsp),%rcx\n\t"
799 "movq 8(%rsp),%rdx\n\t"
800 "movq 16(%rsp),%r8\n\t"
801 "movq 24(%rsp),%r9\n\t"
802 "movq 0(%rsp),%xmm0\n\t"
803 "movq 8(%rsp),%xmm1\n\t"
804 "movq 16(%rsp),%xmm2\n\t"
805 "movq 24(%rsp),%xmm3\n\t"
807 /* trace the return value */
808 "movq -32(%rbp),%rcx\n\t"
809 "movq -24(%rbp),%rdx\n\t"
810 "movq 16(%rbp),%r8\n\t" /* retaddr */
812 "movaps %xmm0,32(%rsp)\n\t"
814 "call " __ASM_NAME("relay_trace_exit") "\n\t"
815 /* restore return value and return */
817 "movaps 32(%rsp),%xmm0\n\t"
818 "movq -16(%rbp),%rsi\n\t"
819 __ASM_CFI(".cfi_same_value %rsi\n\t")
820 "movq -8(%rbp),%rdi\n\t"
821 __ASM_CFI(".cfi_same_value %rdi\n\t")
823 __ASM_CFI(".cfi_def_cfa_register %rsp\n\t")
825 __ASM_CFI(".cfi_adjust_cfa_offset -8\n\t")
826 __ASM_CFI(".cfi_same_value %rbp\n\t")
830 #error Not supported on this CPU
834 /***********************************************************************
835 * RELAY_GetProcAddress
837 * Return the proc address to use for a given function.
839 FARPROC
RELAY_GetProcAddress( HMODULE module
, const IMAGE_EXPORT_DIRECTORY
*exports
,
840 DWORD exp_size
, FARPROC proc
, DWORD ordinal
, const WCHAR
*user
)
842 struct relay_private_data
*data
;
843 const struct relay_descr
*descr
= (const struct relay_descr
*)((const char *)exports
+ exp_size
);
845 if (descr
->magic
!= RELAY_DESCR_MAGIC
|| !(data
= descr
->private)) return proc
; /* no relay data */
846 if (!data
->entry_points
[ordinal
].orig_func
) return proc
; /* not a relayed function */
847 if (check_from_module( debug_from_relay_includelist
, debug_from_relay_excludelist
, user
))
848 return proc
; /* we want to relay it */
849 return data
->entry_points
[ordinal
].orig_func
;
853 /***********************************************************************
856 * Setup relay debugging for a built-in dll.
858 void RELAY_SetupDLL( HMODULE module
)
860 IMAGE_EXPORT_DIRECTORY
*exports
;
863 DWORD size
, entry_point_rva
;
864 struct relay_descr
*descr
;
865 struct relay_private_data
*data
;
868 RtlRunOnceExecuteOnce( &init_once
, init_debug_lists
, NULL
, NULL
);
870 exports
= RtlImageDirectoryEntryToData( module
, TRUE
, IMAGE_DIRECTORY_ENTRY_EXPORT
, &size
);
871 if (!exports
) return;
873 descr
= (struct relay_descr
*)((char *)exports
+ size
);
874 if (descr
->magic
!= RELAY_DESCR_MAGIC
) return;
876 if (!(data
= RtlAllocateHeap( GetProcessHeap(), HEAP_ZERO_MEMORY
, sizeof(*data
) +
877 (exports
->NumberOfFunctions
-1) * sizeof(data
->entry_points
) )))
880 descr
->relay_call
= relay_call
;
881 descr
->private = data
;
883 data
->module
= module
;
884 data
->base
= exports
->Base
;
885 len
= strlen( (char *)module
+ exports
->Name
);
886 if (len
> 4 && !strcasecmp( (char *)module
+ exports
->Name
+ len
- 4, ".dll" )) len
-= 4;
887 len
= min( len
, sizeof(data
->dllname
) - 1 );
888 memcpy( data
->dllname
, (char *)module
+ exports
->Name
, len
);
889 data
->dllname
[len
] = 0;
891 /* fetch name pointer for all entry points and store them in the private structure */
893 ordptr
= (const WORD
*)((char *)module
+ exports
->AddressOfNameOrdinals
);
894 for (i
= 0; i
< exports
->NumberOfNames
; i
++, ordptr
++)
896 DWORD name_rva
= ((DWORD
*)((char *)module
+ exports
->AddressOfNames
))[i
];
897 data
->entry_points
[*ordptr
].name
= (const char *)module
+ name_rva
;
900 /* patch the functions in the export table to point to the relay thunks */
902 funcs
= (DWORD
*)((char *)module
+ exports
->AddressOfFunctions
);
903 entry_point_rva
= descr
->entry_point_base
- (const char *)module
;
904 for (i
= 0; i
< exports
->NumberOfFunctions
; i
++, funcs
++)
906 if (!descr
->entry_point_offsets
[i
]) continue; /* not a normal function */
907 if (!check_relay_include( data
->dllname
, i
+ exports
->Base
, data
->entry_points
[i
].name
))
908 continue; /* don't include this entry point */
910 data
->entry_points
[i
].orig_func
= (char *)module
+ *funcs
;
911 *funcs
= entry_point_rva
+ descr
->entry_point_offsets
[i
];
915 #else /* __i386__ || __x86_64__ || __arm__ || __aarch64__ */
917 FARPROC
RELAY_GetProcAddress( HMODULE module
, const IMAGE_EXPORT_DIRECTORY
*exports
,
918 DWORD exp_size
, FARPROC proc
, DWORD ordinal
, const WCHAR
*user
)
923 void RELAY_SetupDLL( HMODULE module
)
927 #endif /* __i386__ || __x86_64__ || __arm__ || __aarch64__ */
930 /***********************************************************************/
932 /***********************************************************************/
936 WINE_DECLARE_DEBUG_CHANNEL(seh
);
937 WINE_DECLARE_DEBUG_CHANNEL(snoop
);
939 #include "pshpack1.h"
944 BYTE lcall
; /* 0xe8 call snoopentry (relative) */
945 DWORD snoopentry
; /* SNOOP_Entry relative */
952 typedef struct tagSNOOP_DLL
{
957 struct tagSNOOP_DLL
*next
;
964 BYTE lcall
; /* 0xe8 call snoopret relative*/
965 DWORD snoopret
; /* SNOOP_Ret relative */
971 DWORD
*args
; /* saved args across a stdcall */
974 typedef struct tagSNOOP_RETURNENTRIES
{
975 SNOOP_RETURNENTRY entry
[4092/sizeof(SNOOP_RETURNENTRY
)];
976 struct tagSNOOP_RETURNENTRIES
*next
;
977 } SNOOP_RETURNENTRIES
;
981 extern void WINAPI
SNOOP_Entry(void);
982 extern void WINAPI
SNOOP_Return(void);
984 static SNOOP_DLL
*firstdll
;
985 static SNOOP_RETURNENTRIES
*firstrets
;
988 /***********************************************************************
989 * SNOOP_ShowDebugmsgSnoop
991 * Simple function to decide if a particular debugging message is
994 static BOOL
SNOOP_ShowDebugmsgSnoop(const char *module
, int ordinal
, const char *func
)
996 if (debug_snoop_excludelist
&& check_list( module
, ordinal
, func
, debug_snoop_excludelist
))
998 if (debug_snoop_includelist
&& !check_list( module
, ordinal
, func
, debug_snoop_includelist
))
1004 /***********************************************************************
1007 * Setup snoop debugging for a native dll.
1009 void SNOOP_SetupDLL(HMODULE hmod
)
1011 SNOOP_DLL
**dll
= &firstdll
;
1016 IMAGE_EXPORT_DIRECTORY
*exports
;
1018 RtlRunOnceExecuteOnce( &init_once
, init_debug_lists
, NULL
, NULL
);
1020 exports
= RtlImageDirectoryEntryToData( hmod
, TRUE
, IMAGE_DIRECTORY_ENTRY_EXPORT
, &size32
);
1021 if (!exports
|| !exports
->NumberOfFunctions
) return;
1022 name
= (char *)hmod
+ exports
->Name
;
1025 TRACE_(snoop
)("hmod=%p, name=%s\n", hmod
, name
);
1028 if ((*dll
)->hmod
== hmod
)
1030 /* another dll, loaded at the same address */
1031 addr
= (*dll
)->funs
;
1032 size
= (*dll
)->nrofordinals
* sizeof(SNOOP_FUN
);
1033 NtFreeVirtualMemory(NtCurrentProcess(), &addr
, &size
, MEM_RELEASE
);
1036 dll
= &((*dll
)->next
);
1039 *dll
= RtlReAllocateHeap(GetProcessHeap(),
1040 HEAP_ZERO_MEMORY
, *dll
,
1041 sizeof(SNOOP_DLL
) + strlen(name
));
1043 *dll
= RtlAllocateHeap(GetProcessHeap(),
1045 sizeof(SNOOP_DLL
) + strlen(name
));
1046 (*dll
)->hmod
= hmod
;
1047 (*dll
)->ordbase
= exports
->Base
;
1048 (*dll
)->nrofordinals
= exports
->NumberOfFunctions
;
1049 strcpy( (*dll
)->name
, name
);
1050 p
= (*dll
)->name
+ strlen((*dll
)->name
) - 4;
1051 if (p
> (*dll
)->name
&& !strcasecmp( p
, ".dll" )) *p
= 0;
1053 size
= exports
->NumberOfFunctions
* sizeof(SNOOP_FUN
);
1055 NtAllocateVirtualMemory(NtCurrentProcess(), &addr
, 0, &size
,
1056 MEM_COMMIT
| MEM_RESERVE
, PAGE_EXECUTE_READWRITE
);
1058 RtlFreeHeap(GetProcessHeap(),0,*dll
);
1059 FIXME("out of memory\n");
1062 (*dll
)->funs
= addr
;
1063 memset((*dll
)->funs
,0,size
);
1067 /***********************************************************************
1068 * SNOOP_GetProcAddress
1070 * Return the proc address to use for a given function.
1072 FARPROC
SNOOP_GetProcAddress( HMODULE hmod
, const IMAGE_EXPORT_DIRECTORY
*exports
,
1073 DWORD exp_size
, FARPROC origfun
, DWORD ordinal
,
1078 const WORD
*ordinals
;
1080 SNOOP_DLL
*dll
= firstdll
;
1082 const IMAGE_SECTION_HEADER
*sec
;
1084 if (!TRACE_ON(snoop
)) return origfun
;
1085 if (!check_from_module( debug_from_snoop_includelist
, debug_from_snoop_excludelist
, user
))
1086 return origfun
; /* the calling module was explicitly excluded */
1088 if (!*(LPBYTE
)origfun
) /* 0x00 is an impossible opcode, possible dataref. */
1091 sec
= RtlImageRvaToSection( RtlImageNtHeader(hmod
), hmod
, (char *)origfun
- (char *)hmod
);
1093 if (!sec
|| !(sec
->Characteristics
& IMAGE_SCN_CNT_CODE
))
1094 return origfun
; /* most likely a data reference */
1097 if (hmod
== dll
->hmod
)
1101 if (!dll
) /* probably internal */
1104 /* try to find a name for it */
1106 names
= (const DWORD
*)((const char *)hmod
+ exports
->AddressOfNames
);
1107 ordinals
= (const WORD
*)((const char *)hmod
+ exports
->AddressOfNameOrdinals
);
1108 if (names
) for (i
= 0; i
< exports
->NumberOfNames
; i
++)
1110 if (ordinals
[i
] == ordinal
)
1112 ename
= (const char *)hmod
+ names
[i
];
1116 if (!SNOOP_ShowDebugmsgSnoop(dll
->name
,ordinal
,ename
))
1118 assert(ordinal
< dll
->nrofordinals
);
1119 fun
= dll
->funs
+ ordinal
;
1124 fun
->snoopentry
= (char *)SNOOP_Entry
- (char *)(&fun
->snoopentry
+ 1);
1125 fun
->origfun
= origfun
;
1128 return (FARPROC
)&(fun
->lcall
);
1131 static void SNOOP_PrintArg(DWORD x
)
1135 TRACE_(snoop
)("%08x",x
);
1136 if (IS_INTARG(x
) || TRACE_ON(seh
)) return; /* trivial reject to avoid faults */
1143 if (s
[i
]<0x20) {nostring
=1;break;}
1144 if (s
[i
]>=0x80) {nostring
=1;break;}
1147 if (!nostring
&& i
> 5)
1148 TRACE_(snoop
)(" %s",debugstr_an((LPSTR
)x
,i
));
1149 else /* try unicode */
1155 if (s
[i
]<0x20) {nostring
=1;break;}
1156 if (s
[i
]>0x100) {nostring
=1;break;}
1159 if (!nostring
&& i
> 5) TRACE_(snoop
)(" %s",debugstr_wn((LPWSTR
)x
,i
));
1168 void WINAPI DECLSPEC_HIDDEN
__regs_SNOOP_Entry( void **stack
)
1171 SNOOP_FUN
*fun
= (SNOOP_FUN
*)((char *)stack
[0] - 5);
1172 SNOOP_RETURNENTRIES
**rets
= &firstrets
;
1173 SNOOP_RETURNENTRY
*ret
;
1176 for (dll
= firstdll
; dll
; dll
= dll
->next
)
1177 if (fun
>= dll
->funs
&& fun
< dll
->funs
+ dll
->nrofordinals
) break;
1180 FIXME("entrypoint %p not found\n", fun
);
1183 /* guess cdecl ... */
1184 if (fun
->nrofargs
<0) {
1185 /* Typical cdecl return frame is:
1187 * which has (for xxxxxxxx up to 255 the opcode "83 C4 xx".
1188 * (after that 81 C2 xx xx xx xx)
1190 LPBYTE reteip
= stack
[1];
1193 if ((reteip
[0]==0x83)&&(reteip
[1]==0xc4))
1194 fun
->nrofargs
=reteip
[2]/4;
1200 for (i
=0;i
<sizeof((*rets
)->entry
)/sizeof((*rets
)->entry
[0]);i
++)
1201 if (!(*rets
)->entry
[i
].origreturn
)
1203 if (i
!=sizeof((*rets
)->entry
)/sizeof((*rets
)->entry
[0]))
1205 rets
= &((*rets
)->next
);
1211 NtAllocateVirtualMemory(NtCurrentProcess(), &addr
, 0, &size
,
1212 MEM_COMMIT
| MEM_RESERVE
,
1213 PAGE_EXECUTE_READWRITE
);
1216 i
= 0; /* entry 0 is free */
1218 ret
= &((*rets
)->entry
[i
]);
1220 ret
->snoopret
= (char *)SNOOP_Return
- (char *)(&ret
->snoopret
+ 1);
1221 ret
->origreturn
= stack
[1];
1222 stack
[1] = &ret
->lcall
;
1225 ret
->ordinal
= fun
- dll
->funs
;
1226 ret
->origESP
= stack
;
1228 stack
[0] = fun
->origfun
;
1230 if (!TRACE_ON(snoop
)) return;
1232 if (fun
->name
) TRACE_(snoop
)("\1CALL %s.%s(", dll
->name
, fun
->name
);
1233 else TRACE_(snoop
)("\1CALL %s.%d(", dll
->name
, dll
->ordbase
+ret
->ordinal
);
1234 if (fun
->nrofargs
>0) {
1235 max
= fun
->nrofargs
; if (max
>16) max
=16;
1238 SNOOP_PrintArg( (DWORD
)stack
[i
+ 2] );
1239 if (i
<fun
->nrofargs
-1) TRACE_(snoop
)(",");
1241 if (max
!=fun
->nrofargs
)
1242 TRACE_(snoop
)(" ...");
1243 } else if (fun
->nrofargs
<0) {
1244 TRACE_(snoop
)("<unknown, check return>");
1245 ret
->args
= RtlAllocateHeap(GetProcessHeap(),
1246 0,16*sizeof(DWORD
));
1247 memcpy(ret
->args
, stack
+ 2, sizeof(DWORD
)*16);
1249 TRACE_(snoop
)(") ret=%08x\n",(DWORD
)ret
->origreturn
);
1252 void WINAPI DECLSPEC_HIDDEN
__regs_SNOOP_Return( void **stack
)
1254 SNOOP_RETURNENTRY
*ret
= (SNOOP_RETURNENTRY
*)((char *)stack
[0] - 5);
1255 SNOOP_FUN
*fun
= &ret
->dll
->funs
[ret
->ordinal
];
1256 DWORD retval
= (DWORD
)stack
[-1]; /* get saved %eax from the stack */
1258 /* We haven't found out the nrofargs yet. If we called a cdecl
1259 * function it is too late anyway and we can just set '0' (which
1260 * will be the difference between orig and current ESP
1261 * If stdcall -> everything ok.
1263 if (ret
->dll
->funs
[ret
->ordinal
].nrofargs
<0)
1264 ret
->dll
->funs
[ret
->ordinal
].nrofargs
= stack
- ret
->origESP
- 1;
1265 stack
[0] = ret
->origreturn
;
1267 if (!TRACE_ON(snoop
)) {
1268 ret
->origreturn
= NULL
; /* mark as empty */
1276 TRACE_(snoop
)("\1RET %s.%s(", ret
->dll
->name
, fun
->name
);
1278 TRACE_(snoop
)("\1RET %s.%d(", ret
->dll
->name
, ret
->dll
->ordbase
+ret
->ordinal
);
1280 max
= fun
->nrofargs
;
1285 SNOOP_PrintArg(ret
->args
[i
]);
1286 if (i
<max
-1) TRACE_(snoop
)(",");
1288 TRACE_(snoop
)(") retval=%08x ret=%08x\n", retval
, (DWORD
)ret
->origreturn
);
1289 RtlFreeHeap(GetProcessHeap(),0,ret
->args
);
1295 TRACE_(snoop
)("\1RET %s.%s() retval=%08x ret=%08x\n",
1296 ret
->dll
->name
, fun
->name
, retval
, (DWORD
)ret
->origreturn
);
1298 TRACE_(snoop
)("\1RET %s.%d() retval=%08x ret=%08x\n",
1299 ret
->dll
->name
,ret
->dll
->ordbase
+ret
->ordinal
,
1300 retval
, (DWORD
)ret
->origreturn
);
1302 ret
->origreturn
= NULL
; /* mark as empty */
1305 /* small wrappers that save registers and get the stack pointer */
1306 #define SNOOP_WRAPPER(name) \
1307 __ASM_STDCALL_FUNC( name, 0, \
1309 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") \
1311 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") \
1313 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") \
1314 "leal 12(%esp),%eax\n\t" \
1316 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") \
1317 "call " __ASM_NAME("__regs_" #name) __ASM_STDCALL(4) "\n\t" \
1318 __ASM_CFI(".cfi_adjust_cfa_offset -4\n\t") \
1320 __ASM_CFI(".cfi_adjust_cfa_offset -4\n\t") \
1322 __ASM_CFI(".cfi_adjust_cfa_offset -4\n\t") \
1324 __ASM_CFI(".cfi_adjust_cfa_offset -4\n\t") \
1327 SNOOP_WRAPPER( SNOOP_Entry
)
1328 SNOOP_WRAPPER( SNOOP_Return
)
1330 #else /* __i386__ */
1332 FARPROC
SNOOP_GetProcAddress( HMODULE hmod
, const IMAGE_EXPORT_DIRECTORY
*exports
, DWORD exp_size
,
1333 FARPROC origfun
, DWORD ordinal
, const WCHAR
*user
)
1338 void SNOOP_SetupDLL( HMODULE hmod
)
1340 FIXME("snooping works only on i386 for now.\n");
1343 #endif /* __i386__ */