dlls/kernel/relay16.c

   1 /*
   2  * Copyright 1993 Robert J. Amstadt
   3  * Copyright 1995 Alexandre Julliard
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  */
  19
  20 #include "config.h"
  21 #include "wine/port.h"
  22
  23 #include <assert.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <stdarg.h>
  27 #include <stdio.h>
  28
  29 #include "windef.h"
  30 #include "winbase.h"
  31 #include "wine/winbase16.h"
  32 #include "winternl.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"
  38
  39 WINE_DEFAULT_DEBUG_CHANNEL(relay);
  40
  41 #ifdef __i386__
  42
  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;
  47
  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 )
  50 {
  51     while (*strA && (toupperW((unsigned char)*strA) == toupperW(*strW))) { strA++; strW++; }
  52     return toupperW((unsigned char)*strA) - toupperW(*strW);
  53 }
  54
  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 )
  57 {
  58     int ret = 0;
  59     for ( ; n > 0; n--, strA++, strW++)
  60         if ((ret = toupperW((unsigned char)*strA) - toupperW(*strW)) || !*strA) break;
  61     return ret;
  62 }
  63
  64 /***********************************************************************
  65  *           build_list
  66  *
  67  * Build a function list from a ';'-separated string.
  68  */
  69 static const WCHAR **build_list( const WCHAR *buffer )
  70 {
  71     int count = 1;
  72     const WCHAR *p = buffer;
  73     const WCHAR **ret;
  74
  75     while ((p = strchrW( p, ';' )))
  76     {
  77         count++;
  78         p++;
  79     }
  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) )))
  83     {
  84         WCHAR *str = (WCHAR *)(ret + count + 1);
  85         WCHAR *p = str;
  86
  87         strcpyW( str, buffer );
  88         count = 0;
  89         for (;;)
  90         {
  91             ret[count++] = p;
  92             if (!(p = strchrW( p, ';' ))) break;
  93             *p++ = 0;
  94         }
  95         ret[count++] = NULL;
  96     }
  97     return ret;
  98 }
  99
 100
 101 /***********************************************************************
 102  *           RELAY16_InitDebugLists
 103  *
 104  * Build the relay include/exclude function lists.
 105  */
 106 void RELAY16_InitDebugLists(void)
 107 {
 108     OBJECT_ATTRIBUTES attr;
 109     UNICODE_STRING name;
 110     char buffer[1024];
 111     HANDLE root, hkey;
 112     DWORD count;
 113     WCHAR *str;
 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};
 121
 122     RtlOpenCurrentUser( KEY_ALL_ACCESS, &root );
 123     attr.Length = sizeof(attr);
 124     attr.RootDirectory = root;
 125     attr.ObjectName = &name;
 126     attr.Attributes = 0;
 127     attr.SecurityDescriptor = NULL;
 128     attr.SecurityQualityOfService = NULL;
 129     RtlInitUnicodeString( &name, configW );
 130
 131     /* @@ Wine registry key: HKCU\Software\Wine\Debug */
 132     if (NtOpenKey( &hkey, KEY_ALL_ACCESS, &attr )) hkey = 0;
 133     NtClose( root );
 134     if (!hkey) return;
 135
 136     str = (WCHAR *)((KEY_VALUE_PARTIAL_INFORMATION *)buffer)->Data;
 137     RtlInitUnicodeString( &name, RelayIncludeW );
 138     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
 139     {
 140         debug_relay_includelist = build_list( str );
 141     }
 142
 143     RtlInitUnicodeString( &name, RelayExcludeW );
 144     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
 145     {
 146         debug_relay_excludelist = build_list( str );
 147     }
 148
 149     RtlInitUnicodeString( &name, SnoopIncludeW );
 150     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
 151     {
 152         debug_snoop_includelist = build_list( str );
 153     }
 154
 155     RtlInitUnicodeString( &name, SnoopExcludeW );
 156     if (!NtQueryValueKey( hkey, &name, KeyValuePartialInformation, buffer, sizeof(buffer), &count ))
 157     {
 158         debug_snoop_excludelist = build_list( str );
 159     }
 160     NtClose( hkey );
 161 }
 162
 163
 164 /***********************************************************************
 165  *           check_list
 166  *
 167  * Check if a given module and function is in the list.
 168  */
 169 static BOOL check_list( const char *module, int ordinal, const char *func, const WCHAR **list )
 170 {
 171     char ord_str[10];
 172
 173     sprintf( ord_str, "%d", ordinal );
 174     for(; *list; list++)
 175     {
 176         const WCHAR *p = strrchrW( *list, '.' );
 177         if (p && p > *list)  /* check module and function */
 178         {
 179             int len = p - *list;
 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;
 184         }
 185         else  /* function only */
 186         {
 187             if (func && !strcmpiAW( func, *list )) return TRUE;
 188         }
 189     }
 190     return FALSE;
 191 }
 192
 193
 194 /***********************************************************************
 195  *           RELAY_ShowDebugmsgRelay
 196  *
 197  * Simple function to decide if a particular debugging message is
 198  * wanted.
 199  */
 200 static BOOL RELAY_ShowDebugmsgRelay(const char *module, int ordinal, const char *func)
 201 {
 202     if (debug_relay_excludelist && check_list( module, ordinal, func, debug_relay_excludelist ))
 203         return FALSE;
 204     if (debug_relay_includelist && !check_list( module, ordinal, func, debug_relay_includelist ))
 205         return FALSE;
 206     return TRUE;
 207 }
 208
 209
 210 /***********************************************************************
 211  *          SNOOP16_ShowDebugmsgSnoop
 212  *
 213  * Simple function to decide if a particular debugging message is
 214  * wanted.
 215  */
 216 int SNOOP16_ShowDebugmsgSnoop(const char *module, int ordinal, const char *func)
 217 {
 218     if (debug_snoop_excludelist && check_list( module, ordinal, func, debug_snoop_excludelist ))
 219         return FALSE;
 220     if (debug_snoop_includelist && !check_list( module, ordinal, func, debug_snoop_includelist ))
 221         return FALSE;
 222     return TRUE;
 223 }
 224
 225
 226 /***********************************************************************
 227  *           get_entry_point
 228  *
 229  * Return the ordinal, name, and type info corresponding to a CS:IP address.
 230  */
 231 static const CALLFROM16 *get_entry_point( STACK16FRAME *frame, LPSTR module, LPSTR func, WORD *pOrd )
 232 {
 233     WORD i, max_offset;
 234     register BYTE *p;
 235     NE_MODULE *pModule;
 236     ET_BUNDLE *bundle;
 237     ET_ENTRY *entry;
 238
 239     *pOrd = 0;
 240     if (!(pModule = NE_GetPtr( FarGetOwner16( GlobalHandle16( frame->module_cs ) ))))
 241         return NULL;
 242
 243     max_offset = 0;
 244     bundle = (ET_BUNDLE *)((BYTE *)pModule + pModule->ne_enttab);
 245     do
 246     {
 247         entry = (ET_ENTRY *)((BYTE *)bundle+6);
 248         for (i = bundle->first + 1; i <= bundle->last; i++)
 249         {
 250             if ((entry->offs < frame->entry_ip)
 251             && (entry->segnum == 1) /* code segment ? */
 252             && (entry->offs >= max_offset))
 253             {
 254                 max_offset = entry->offs;
 255                 *pOrd = i;
 256             }
 257             entry++;
 258         }
 259     } while ( (bundle->next)
 260            && (bundle = (ET_BUNDLE *)((BYTE *)pModule+bundle->next)));
 261
 262     /* Search for the name in the resident names table */
 263     /* (built-in modules have no non-resident table)   */
 264
 265     p = (BYTE *)pModule + pModule->ne_restab;
 266     memcpy( module, p + 1, *p );
 267     module[*p] = 0;
 268
 269     while (*p)
 270     {
 271         p += *p + 1 + sizeof(WORD);
 272         if (*(WORD *)(p + *p + 1) == *pOrd) break;
 273     }
 274     memcpy( func, p + 1, *p );
 275     func[*p] = 0;
 276
 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);
 281 }
 282
 283
 284 extern int call_entry_point( void *func, int nb_args, const int *args );
 285 __ASM_GLOBAL_FUNC( call_entry_point,
 286                    "\tpushl %ebp\n"
 287                    "\tmovl %esp,%ebp\n"
 288                    "\tmovl 12(%ebp),%ecx\n"
 289                    "\tmovl 16(%ebp),%edx\n"
 290                    "\tjecxz 1f\n"
 291                    "2:\tpushl -4(%edx,%ecx,4)\n"
 292                    "\tloop 2b\n"
 293                    "1:\tcall *8(%ebp)\n"
 294                    "\tmovl %ebp,%esp\n"
 295                    "\tleave\n"
 296                    "\tret" );
 297
 298
 299 /***********************************************************************
 300  *           relay_call_from_16_no_debug
 301  *
 302  * Same as relay_call_from_16 but doesn't print any debug information.
 303  */
 304 static int relay_call_from_16_no_debug( void *entry_point, unsigned char *args16, CONTEXT86 *context,
 305                                         const CALLFROM16 *call )
 306 {
 307     int i, nb_args, args32[20];
 308
 309     nb_args = 0;
 310     if (call->lret == 0xcb66)  /* cdecl */
 311     {
 312         for (i = 0; i < 20; i++, nb_args++)
 313         {
 314             int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
 315
 316             if (type == ARG_NONE) break;
 317             switch(type)
 318             {
 319             case ARG_WORD:
 320                 args32[nb_args] = *(WORD *)args16;
 321                 args16 += sizeof(WORD);
 322                 break;
 323             case ARG_SWORD:
 324                 args32[nb_args] = *(short *)args16;
 325                 args16 += sizeof(WORD);
 326                 break;
 327             case ARG_LONG:
 328             case ARG_SEGSTR:
 329                 args32[nb_args] = *(int *)args16;
 330                 args16 += sizeof(int);
 331                 break;
 332             case ARG_PTR:
 333             case ARG_STR:
 334                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 335                 args16 += sizeof(SEGPTR);
 336                 break;
 337             case ARG_VARARG:
 338                 args32[nb_args] = (int)args16;
 339                 break;
 340             default:
 341                 break;
 342             }
 343         }
 344     }
 345     else  /* not cdecl */
 346     {
 347         /* Start with the last arg */
 348         args16 += call->nArgs;
 349         for (i = 0; i < 20; i++, nb_args++)
 350         {
 351             int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
 352
 353             if (type == ARG_NONE) break;
 354             switch(type)
 355             {
 356             case ARG_WORD:
 357                 args16 -= sizeof(WORD);
 358                 args32[nb_args] = *(WORD *)args16;
 359                 break;
 360             case ARG_SWORD:
 361                 args16 -= sizeof(WORD);
 362                 args32[nb_args] = *(short *)args16;
 363                 break;
 364             case ARG_LONG:
 365             case ARG_SEGSTR:
 366                 args16 -= sizeof(int);
 367                 args32[nb_args] = *(int *)args16;
 368                 break;
 369             case ARG_PTR:
 370             case ARG_STR:
 371                 args16 -= sizeof(SEGPTR);
 372                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 373                 break;
 374             default:
 375                 break;
 376             }
 377         }
 378     }
 379
 380     if (call->arg_types[0] & ARG_REGISTER) args32[nb_args++] = (int)context;
 381
 382     SYSLEVEL_CheckNotLevel( 2 );
 383
 384     return call_entry_point( entry_point, nb_args, args32 );
 385 }
 386
 387
 388 /***********************************************************************
 389  *           relay_call_from_16
 390  *
 391  * Replacement for the 16-bit relay functions when relay debugging is on.
 392  */
 393 int relay_call_from_16( void *entry_point, unsigned char *args16, CONTEXT86 *context )
 394 {
 395     STACK16FRAME *frame;
 396     WORD ordinal;
 397     int i, ret_val, nb_args, args32[20];
 398     char module[10], func[64];
 399     const CALLFROM16 *call;
 400
 401     frame = CURRENT_STACK16;
 402     call = get_entry_point( frame, module, func, &ordinal );
 403     if (!TRACE_ON(relay) || !RELAY_ShowDebugmsgRelay( module, ordinal, func ))
 404         return relay_call_from_16_no_debug( entry_point, args16, context, call );
 405
 406     DPRINTF( "%04lx:Call %s.%d: %s(",GetCurrentThreadId(), module, ordinal, func );
 407
 408     nb_args = 0;
 409     if (call->lret == 0xcb66)  /* cdecl */
 410     {
 411         for (i = 0; i < 20; i++, nb_args++)
 412         {
 413             int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
 414
 415             if (type == ARG_NONE) break;
 416             if (i) DPRINTF( "," );
 417             switch(type)
 418             {
 419             case ARG_WORD:
 420                 DPRINTF( "%04x", *(WORD *)args16 );
 421                 args32[nb_args] = *(WORD *)args16;
 422                 args16 += sizeof(WORD);
 423                 break;
 424             case ARG_SWORD:
 425                 DPRINTF( "%04x", *(WORD *)args16 );
 426                 args32[nb_args] = *(short *)args16;
 427                 args16 += sizeof(WORD);
 428                 break;
 429             case ARG_LONG:
 430                 DPRINTF( "%08x", *(int *)args16 );
 431                 args32[nb_args] = *(int *)args16;
 432                 args16 += sizeof(int);
 433                 break;
 434             case ARG_PTR:
 435                 DPRINTF( "%04x:%04x", *(WORD *)(args16+2), *(WORD *)args16 );
 436                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 437                 args16 += sizeof(SEGPTR);
 438                 break;
 439             case ARG_STR:
 440                 DPRINTF( "%08x %s", *(int *)args16,
 441                          debugstr_a( MapSL(*(SEGPTR *)args16 )));
 442                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 443                 args16 += sizeof(int);
 444                 break;
 445             case ARG_SEGSTR:
 446                 DPRINTF( "%04x:%04x %s", *(WORD *)(args16+2), *(WORD *)args16,
 447                          debugstr_a( MapSL(*(SEGPTR *)args16 )) );
 448                 args32[nb_args] = *(SEGPTR *)args16;
 449                 args16 += sizeof(SEGPTR);
 450                 break;
 451             case ARG_VARARG:
 452                 DPRINTF( "..." );
 453                 args32[nb_args] = (int)args16;
 454                 break;
 455             default:
 456                 break;
 457             }
 458         }
 459     }
 460     else  /* not cdecl */
 461     {
 462         /* Start with the last arg */
 463         args16 += call->nArgs;
 464         for (i = 0; i < 20; i++, nb_args++)
 465         {
 466             int type = (call->arg_types[i / 10] >> (3 * (i % 10))) & 7;
 467
 468             if (type == ARG_NONE) break;
 469             if (i) DPRINTF( "," );
 470             switch(type)
 471             {
 472             case ARG_WORD:
 473                 args16 -= sizeof(WORD);
 474                 args32[nb_args] = *(WORD *)args16;
 475                 DPRINTF( "%04x", *(WORD *)args16 );
 476                 break;
 477             case ARG_SWORD:
 478                 args16 -= sizeof(WORD);
 479                 args32[nb_args] = *(short *)args16;
 480                 DPRINTF( "%04x", *(WORD *)args16 );
 481                 break;
 482             case ARG_LONG:
 483                 args16 -= sizeof(int);
 484                 args32[nb_args] = *(int *)args16;
 485                 DPRINTF( "%08x", *(int *)args16 );
 486                 break;
 487             case ARG_PTR:
 488                 args16 -= sizeof(SEGPTR);
 489                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 490                 DPRINTF( "%04x:%04x", *(WORD *)(args16+2), *(WORD *)args16 );
 491                 break;
 492             case ARG_STR:
 493                 args16 -= sizeof(int);
 494                 args32[nb_args] = (int)MapSL( *(SEGPTR *)args16 );
 495                 DPRINTF( "%08x %s", *(int *)args16,
 496                          debugstr_a( MapSL(*(SEGPTR *)args16 )));
 497                 break;
 498             case ARG_SEGSTR:
 499                 args16 -= sizeof(SEGPTR);
 500                 args32[nb_args] = *(SEGPTR *)args16;
 501                 DPRINTF( "%04x:%04x %s", *(WORD *)(args16+2), *(WORD *)args16,
 502                          debugstr_a( MapSL(*(SEGPTR *)args16 )) );
 503                 break;
 504             case ARG_VARARG:
 505                 DPRINTF( "..." );
 506                 args32[nb_args] = (int)args16;
 507                 break;
 508             default:
 509                 break;
 510             }
 511         }
 512     }
 513
 514     DPRINTF( ") ret=%04x:%04x ds=%04x\n", frame->cs, frame->ip, frame->ds );
 515
 516     if (call->arg_types[0] & ARG_REGISTER)
 517     {
 518         args32[nb_args++] = (int)context;
 519         DPRINTF("     AX=%04x BX=%04x CX=%04x DX=%04x SI=%04x DI=%04x ES=%04x EFL=%08lx\n",
 520                 (WORD)context->Eax, (WORD)context->Ebx, (WORD)context->Ecx,
 521                 (WORD)context->Edx, (WORD)context->Esi, (WORD)context->Edi,
 522                 (WORD)context->SegEs, context->EFlags );
 523     }
 524
 525     SYSLEVEL_CheckNotLevel( 2 );
 526
 527     ret_val = call_entry_point( entry_point, nb_args, args32 );
 528
 529     SYSLEVEL_CheckNotLevel( 2 );
 530
 531     DPRINTF( "%04lx:Ret  %s.%d: %s() ",GetCurrentThreadId(), module, ordinal, func );
 532     if (call->arg_types[0] & ARG_REGISTER)
 533     {
 534         DPRINTF("retval=none ret=%04x:%04x ds=%04x\n",
 535                 (WORD)context->SegCs, LOWORD(context->Eip), (WORD)context->SegDs);
 536         DPRINTF("     AX=%04x BX=%04x CX=%04x DX=%04x SI=%04x DI=%04x ES=%04x EFL=%08lx\n",
 537                 (WORD)context->Eax, (WORD)context->Ebx, (WORD)context->Ecx,
 538                 (WORD)context->Edx, (WORD)context->Esi, (WORD)context->Edi,
 539                 (WORD)context->SegEs, context->EFlags );
 540     }
 541     else
 542     {
 543         frame = CURRENT_STACK16;  /* might have be changed by the entry point */
 544         if (call->arg_types[0] & ARG_RET16)
 545             DPRINTF( "retval=%04x ret=%04x:%04x ds=%04x\n",
 546                      ret_val & 0xffff, frame->cs, frame->ip, frame->ds );
 547         else
 548             DPRINTF( "retval=%08x ret=%04x:%04x ds=%04x\n",
 549                      ret_val, frame->cs, frame->ip, frame->ds );
 550     }
 551     return ret_val;
 552 }
 553
 554 #else /* __i386__ */
 555
 556 /*
 557  * Stubs for the CallTo16/CallFrom16 routines on non-Intel architectures
 558  * (these will never be called but need to be present to satisfy the linker ...)
 559  */
 560
 561 /***********************************************************************
 562  *              __wine_call_from_16_word (KERNEL32.@)
 563  */
 564 WORD __wine_call_from_16_word()
 565 {
 566     assert( FALSE );
 567 }
 568
 569 /***********************************************************************
 570  *              __wine_call_from_16_long (KERNEL32.@)
 571  */
 572 LONG __wine_call_from_16_long()
 573 {
 574     assert( FALSE );
 575 }
 576
 577 /***********************************************************************
 578  *              __wine_call_from_16_regs (KERNEL32.@)
 579  */
 580 void __wine_call_from_16_regs()
 581 {
 582     assert( FALSE );
 583 }
 584
 585 DWORD WINAPI CALL32_CBClient( FARPROC proc, LPWORD args, DWORD *esi )
 586 { assert( FALSE ); }
 587
 588 DWORD WINAPI CALL32_CBClientEx( FARPROC proc, LPWORD args, DWORD *esi, INT *nArgs )
 589 { assert( FALSE ); }
 590
 591 #endif  /* __i386__ */