2 * Copyright 1993 Robert J. Amstadt
3 * Copyright 1995 Alexandre Julliard
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include "wine/port.h"
31 #include "wine/winbase16.h"
33 #include "kernel_private.h"
34 #include "kernel16_private.h"
35 #include "wine/unicode.h"
36 #include "wine/library.h"
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(relay);
43 static const WCHAR **debug_relay_excludelist;
44 static const WCHAR **debug_relay_includelist;
45 static const WCHAR **debug_snoop_excludelist;
46 static const WCHAR **debug_snoop_includelist;
48 /* compare an ASCII and a Unicode string without depending on the current codepage */
49 inline static int strcmpiAW( const char *strA, const WCHAR *strW )
51 while (*strA && (toupperW((unsigned char)*strA) == toupperW(*strW))) { strA++; strW++; }
52 return toupperW((unsigned char)*strA) - toupperW(*strW);
55 /* compare an ASCII and a Unicode string without depending on the current codepage */
56 inline static int strncmpiAW( const char *strA, const WCHAR *strW, int n )
59 for ( ; n > 0; n--, strA++, strW++)
60 if ((ret = toupperW((unsigned char)*strA) - toupperW(*strW)) || !*strA) break;
64 /***********************************************************************
67 * Build a function list from a ';'-separated string.
69 static const WCHAR **build_list( const WCHAR *buffer )
72 const WCHAR *p = buffer;
75 while ((p = strchrW( p, ';' )))
80 /* allocate count+1 pointers, plus the space for a copy of the string */
81 if ((ret = RtlAllocateHeap( GetProcessHeap(), 0,
82 (count+1) * sizeof(WCHAR*) + (strlenW(buffer)+1) * sizeof(WCHAR) )))
84 WCHAR *str = (WCHAR *)(ret + count + 1);
87 strcpyW( str, buffer );
92 if (!(p = strchrW( p, ';' ))) break;
101 /***********************************************************************
102 * RELAY16_InitDebugLists
104 * Build the relay include/exclude function lists.
106 void RELAY16_InitDebugLists(void)
108 OBJECT_ATTRIBUTES attr;
114 static const WCHAR configW[] = {'S','o','f','t','w','a','r','e','\\',
115 'W','i','n','e','\\',
116 'D','e','b','u','g',0};
117 static const WCHAR RelayIncludeW[] = {'R','e','l','a','y','I','n','c','l','u','d','e',0};
118 static const WCHAR RelayExcludeW[] = {'R','e','l','a','y','E','x','c','l','u','d','e',0};
119 static const WCHAR SnoopIncludeW[] = {'S','n','o','o','p','I','n','c','l','u','d','e',0};
120 static const WCHAR SnoopExcludeW[] = {'S','n','o','o','p','E','x','c','l','u','d','e',0};
122 RtlOpenCurrentUser( KEY_ALL_ACCESS, &root );
123 attr.Length = sizeof(attr);
124 attr.RootDirectory = root;
125 attr.ObjectName = &name;
127 attr.SecurityDescriptor = NULL;
128 attr.SecurityQualityOfService = NULL;
129 RtlInitUnicodeString( &name, configW );
131 /* @@ Wine registry key: HKCU\Software\Wine\Debug */
132 if (NtOpenKey( &hkey, KEY_ALL_ACCESS, &attr )) hkey = 0;
136 str = (WCHAR *)((KEY_VALUE_PARTIAL_INFORMATION *)buffer)->Data;
137 RtlInitUnicodeString( &name, RelayIncludeW );
138 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
140 debug_relay_includelist = build_list( str );
143 RtlInitUnicodeString( &name, RelayExcludeW );
144 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
146 debug_relay_excludelist = build_list( str );
149 RtlInitUnicodeString( &name, SnoopIncludeW );
150 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
152 debug_snoop_includelist = build_list( str );
155 RtlInitUnicodeString( &name, SnoopExcludeW );
156 if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
158 debug_snoop_excludelist = build_list( str );
164 /***********************************************************************
167 * Check if a given module and function is in the list.
169 static BOOL check_list( const char *module, int ordinal, const char *func, const WCHAR **list )
173 sprintf( ord_str, "%d", ordinal );
176 const WCHAR *p = strrchrW( *list, '.' );
177 if (p && p > *list) /* check module and function */
180 if (strncmpiAW( module, *list, len-1 ) || module[len]) continue;
181 if (p[1] == '*' && !p[2]) return TRUE;
182 if (!strcmpiAW( ord_str, p + 1 )) return TRUE;
183 if (func && !strcmpiAW( func, p + 1 )) return TRUE;
185 else /* function only */
187 if (func && !strcmpiAW( func, *list )) return TRUE;
194 /***********************************************************************
195 * RELAY_ShowDebugmsgRelay
197 * Simple function to decide if a particular debugging message is
200 static BOOL RELAY_ShowDebugmsgRelay(const char *module, int ordinal, const char *func)
202 if (debug_relay_excludelist && check_list( module, ordinal, func, debug_relay_excludelist ))
204 if (debug_relay_includelist && !check_list( module, ordinal, func, debug_relay_includelist ))
210 /***********************************************************************
211 * SNOOP16_ShowDebugmsgSnoop
213 * Simple function to decide if a particular debugging message is
216 int SNOOP16_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
218 if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
220 if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
226 /***********************************************************************
229 * Return the ordinal, name, and type info corresponding to a CS:IP address.
231 static const CALLFROM16 *get_entry_point( STACK16FRAME *frame, LPSTR module, LPSTR func, WORD *pOrd )
239 if (!(pModule = NE_GetPtr( FarGetOwner16( GlobalHandle16( frame->module_cs ) ))))
244 bundle = (ET_BUNDLE *)((BYTE *)pModule + pModule->ne_enttab);
247 entry = (ET_ENTRY *)((BYTE *)bundle+6);
248 for (i = bundle->first + 1; i <= bundle->last; i++)
250 if ((entry->offs < frame->entry_ip)
251 && (entry->segnum == 1) /* code segment ? */
252 && (entry->offs >= max_offset))
254 max_offset = entry->offs;
259 } while ( (bundle->next)
260 && (bundle = (ET_BUNDLE *)((BYTE *)pModule+bundle->next)));
262 /* Search for the name in the resident names table */
263 /* (built-in modules have no non-resident table) */
265 p = (BYTE *)pModule + pModule->ne_restab;
266 memcpy( module, p + 1, *p );
271 p += *p + 1 + sizeof(WORD);
272 if (*(WORD *)(p + *p + 1) == *pOrd) break;
274 memcpy( func, p + 1, *p );
277 /* Retrieve entry point call structure */
278 p = MapSL( MAKESEGPTR( frame->module_cs, frame->callfrom_ip ) );
279 /* p now points to lret, get the start of CALLFROM16 structure */
280 return (CALLFROM16 *)(p - (BYTE *)&((CALLFROM16 *)0)->lret);
284 typedef int (*CDECL_PROC)();
285 typedef int (WINAPI *PASCAL_PROC)();
287 /***********************************************************************
288 * call_cdecl_function
290 static int call_cdecl_function( CDECL_PROC func, int nb_args, const int *args )
295 case 0: ret = func(); break;
296 case 1: ret = func(args[0]); break;
297 case 2: ret = func(args[0],args[1]); break;
298 case 3: ret = func(args[0],args[1],args[2]); break;
299 case 4: ret = func(args[0],args[1],args[2],args[3]); break;
300 case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
301 case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
303 case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
305 case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
306 args[6],args[7]); break;
307 case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
308 args[6],args[7],args[8]); break;
309 case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
310 args[6],args[7],args[8],args[9]); break;
311 case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
312 args[6],args[7],args[8],args[9],args[10]); break;
313 case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
314 args[6],args[7],args[8],args[9],args[10],
316 case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
317 args[6],args[7],args[8],args[9],args[10],args[11],
319 case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
320 args[6],args[7],args[8],args[9],args[10],args[11],
321 args[12],args[13]); break;
322 case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
323 args[6],args[7],args[8],args[9],args[10],args[11],
324 args[12],args[13],args[14]); break;
325 case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
326 args[6],args[7],args[8],args[9],args[10],args[11],
327 args[12],args[13],args[14],args[15]); break;
328 case 17: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
329 args[6],args[7],args[8],args[9],args[10],args[11],
330 args[12],args[13],args[14],args[15],args[16]); break;
331 case 18: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
332 args[6],args[7],args[8],args[9],args[10],args[11],
333 args[12],args[13],args[14],args[15],args[16],
336 ERR( "Unsupported nb of args %d\n", nb_args );
345 /***********************************************************************
346 * call_pascal_function
348 static inline int call_pascal_function( PASCAL_PROC func, int nb_args, const int *args )
353 case 0: ret = func(); break;
354 case 1: ret = func(args[0]); break;
355 case 2: ret = func(args[0],args[1]); break;
356 case 3: ret = func(args[0],args[1],args[2]); break;
357 case 4: ret = func(args[0],args[1],args[2],args[3]); break;
358 case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
359 case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
361 case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
363 case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
364 args[6],args[7]); break;
365 case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
366 args[6],args[7],args[8]); break;
367 case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
368 args[6],args[7],args[8],args[9]); break;
369 case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
370 args[6],args[7],args[8],args[9],args[10]); break;
371 case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
372 args[6],args[7],args[8],args[9],args[10],
374 case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
375 args[6],args[7],args[8],args[9],args[10],args[11],
377 case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
378 args[6],args[7],args[8],args[9],args[10],args[11],
379 args[12],args[13]); break;
380 case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
381 args[6],args[7],args[8],args[9],args[10],args[11],
382 args[12],args[13],args[14]); break;
383 case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
384 args[6],args[7],args[8],args[9],args[10],args[11],
385 args[12],args[13],args[14],args[15]); break;
386 case 17: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
387 args[6],args[7],args[8],args[9],args[10],args[11],
388 args[12],args[13],args[14],args[15],args[16]); break;
389 case 18: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
390 args[6],args[7],args[8],args[9],args[10],args[11],
391 args[12],args[13],args[14],args[15],args[16],
394 ERR( "Unsupported nb of args %d\n", nb_args );
403 /***********************************************************************
404 * relay_call_from_16_no_debug
406 * Same as relay_call_from_16 but doesn't print any debug information.
408 static int relay_call_from_16_no_debug( void *entry_point, unsigned char *args16, CONTEXT86 *context,
409 const CALLFROM16 *call )
411 int i, nb_args, args32[20];
414 if (call->lret == 0xcb66) /* cdecl */
416 for (i = 0; i < 20; i++, nb_args++)
418 int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
420 if (type == ARG_NONE) break;
424 args32[nb_args] = *(WORD *)args16;
425 args16 += sizeof(WORD);
428 args32[nb_args] = *(short *)args16;
429 args16 += sizeof(WORD);
433 args32[nb_args] = *(int *)args16;
434 args16 += sizeof(int);
438 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
439 args16 += sizeof(SEGPTR);
442 args32[nb_args] = (int)args16;
451 /* Start with the last arg */
452 args16 += call->nArgs;
453 for (i = 0; i < 20; i++, nb_args++)
455 int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
457 if (type == ARG_NONE) break;
461 args16 -= sizeof(WORD);
462 args32[nb_args] = *(WORD *)args16;
465 args16 -= sizeof(WORD);
466 args32[nb_args] = *(short *)args16;
470 args16 -= sizeof(int);
471 args32[nb_args] = *(int *)args16;
475 args16 -= sizeof(SEGPTR);
476 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
484 if (call->arg_types[0] & ARG_REGISTER) args32[nb_args++] = (int)context;
486 SYSLEVEL_CheckNotLevel( 2 );
488 if (call->lret == 0xcb66) /* cdecl */
489 return call_cdecl_function( entry_point, nb_args, args32 );
491 return call_pascal_function( entry_point, nb_args, args32 );
495 /***********************************************************************
498 * Replacement for the 16-bit relay functions when relay debugging is on.
500 int relay_call_from_16( void *entry_point, unsigned char *args16, CONTEXT86 *context )
504 int i, ret_val, nb_args, args32[20];
505 char module[10], func[64];
506 const CALLFROM16 *call;
508 frame = CURRENT_STACK16;
509 call = get_entry_point( frame, module, func, &ordinal );
510 if (!TRACE_ON(relay) || !RELAY_ShowDebugmsgRelay( module, ordinal, func ))
511 return relay_call_from_16_no_debug( entry_point, args16, context, call );
513 DPRINTF( "%04lx:Call %s.%d: %s(",GetCurrentThreadId(), module, ordinal, func );
516 if (call->lret == 0xcb66) /* cdecl */
518 for (i = 0; i < 20; i++, nb_args++)
520 int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
522 if (type == ARG_NONE) break;
523 if (i) DPRINTF( "," );
527 DPRINTF( "%04x", *(WORD *)args16 );
528 args32[nb_args] = *(WORD *)args16;
529 args16 += sizeof(WORD);
532 DPRINTF( "%04x", *(WORD *)args16 );
533 args32[nb_args] = *(short *)args16;
534 args16 += sizeof(WORD);
537 DPRINTF( "%08x", *(int *)args16 );
538 args32[nb_args] = *(int *)args16;
539 args16 += sizeof(int);
542 DPRINTF( "%04x:%04x", *(WORD *)(args16+2), *(WORD *)args16 );
543 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
544 args16 += sizeof(SEGPTR);
547 DPRINTF( "%08x %s", *(int *)args16,
548 debugstr_a( MapSL(*(SEGPTR *)args16 )));
549 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
550 args16 += sizeof(int);
553 DPRINTF( "%04x:%04x %s", *(WORD *)(args16+2), *(WORD *)args16,
554 debugstr_a( MapSL(*(SEGPTR *)args16 )) );
555 args32[nb_args] = *(SEGPTR *)args16;
556 args16 += sizeof(SEGPTR);
560 args32[nb_args] = (int)args16;
569 /* Start with the last arg */
570 args16 += call->nArgs;
571 for (i = 0; i < 20; i++, nb_args++)
573 int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
575 if (type == ARG_NONE) break;
576 if (i) DPRINTF( "," );
580 args16 -= sizeof(WORD);
581 args32[nb_args] = *(WORD *)args16;
582 DPRINTF( "%04x", *(WORD *)args16 );
585 args16 -= sizeof(WORD);
586 args32[nb_args] = *(short *)args16;
587 DPRINTF( "%04x", *(WORD *)args16 );
590 args16 -= sizeof(int);
591 args32[nb_args] = *(int *)args16;
592 DPRINTF( "%08x", *(int *)args16 );
595 args16 -= sizeof(SEGPTR);
596 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
597 DPRINTF( "%04x:%04x", *(WORD *)(args16+2), *(WORD *)args16 );
600 args16 -= sizeof(int);
601 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
602 DPRINTF( "%08x %s", *(int *)args16,
603 debugstr_a( MapSL(*(SEGPTR *)args16 )));
606 args16 -= sizeof(SEGPTR);
607 args32[nb_args] = *(SEGPTR *)args16;
608 DPRINTF( "%04x:%04x %s", *(WORD *)(args16+2), *(WORD *)args16,
609 debugstr_a( MapSL(*(SEGPTR *)args16 )) );
613 args32[nb_args] = (int)args16;
621 DPRINTF( ") ret=%04x:%04x ds=%04x\n", frame->cs, frame->ip, frame->ds );
623 if (call->arg_types[0] & ARG_REGISTER)
625 args32[nb_args++] = (int)context;
626 DPRINTF(" AX=%04x BX=%04x CX=%04x DX=%04x SI=%04x DI=%04x ES=%04x EFL=%08lx\n",
627 (WORD)context->Eax, (WORD)context->Ebx, (WORD)context->Ecx,
628 (WORD)context->Edx, (WORD)context->Esi, (WORD)context->Edi,
629 (WORD)context->SegEs, context->EFlags );
632 SYSLEVEL_CheckNotLevel( 2 );
634 if (call->lret == 0xcb66) /* cdecl */
635 ret_val = call_cdecl_function( entry_point, nb_args, args32 );
637 ret_val = call_pascal_function( entry_point, nb_args, args32 );
639 SYSLEVEL_CheckNotLevel( 2 );
641 DPRINTF( "%04lx:Ret %s.%d: %s() ",GetCurrentThreadId(), module, ordinal, func );
642 if (call->arg_types[0] & ARG_REGISTER)
644 DPRINTF("retval=none ret=%04x:%04x ds=%04x\n",
645 (WORD)context->SegCs, LOWORD(context->Eip), (WORD)context->SegDs);
646 DPRINTF(" AX=%04x BX=%04x CX=%04x DX=%04x SI=%04x DI=%04x ES=%04x EFL=%08lx\n",
647 (WORD)context->Eax, (WORD)context->Ebx, (WORD)context->Ecx,
648 (WORD)context->Edx, (WORD)context->Esi, (WORD)context->Edi,
649 (WORD)context->SegEs, context->EFlags );
653 frame = CURRENT_STACK16; /* might have be changed by the entry point */
654 if (call->arg_types[0] & ARG_RET16)
655 DPRINTF( "retval=%04x ret=%04x:%04x ds=%04x\n",
656 ret_val & 0xffff, frame->cs, frame->ip, frame->ds );
658 DPRINTF( "retval=%08x ret=%04x:%04x ds=%04x\n",
659 ret_val, frame->cs, frame->ip, frame->ds );
667 * Stubs for the CallTo16/CallFrom16 routines on non-Intel architectures
668 * (these will never be called but need to be present to satisfy the linker ...)
671 /***********************************************************************
672 * __wine_call_from_16_word (KERNEL32.@)
674 WORD __wine_call_from_16_word()
679 /***********************************************************************
680 * __wine_call_from_16_long (KERNEL32.@)
682 LONG __wine_call_from_16_long()
687 /***********************************************************************
688 * __wine_call_from_16_regs (KERNEL32.@)
690 void __wine_call_from_16_regs()
695 DWORD WINAPI CALL32_CBClient( FARPROC proc, LPWORD args, DWORD *esi )
698 DWORD WINAPI CALL32_CBClientEx( FARPROC proc, LPWORD args, DWORD *esi, INT *nArgs )
701 #endif /* __i386__ */