relay32/relay386.c

   1 /*
   2  * 386-specific Win32 relay functions
   3  *
   4  * Copyright 1997 Alexandre Julliard
   5  */
   6
   7
   8 #include "config.h"
   9
  10 #include <assert.h>
  11 #include <string.h>
  12 #include <stdio.h>
  13
  14 #include "winnt.h"
  15 #include "stackframe.h"
  16 #include "module.h"
  17 #include "debugtools.h"
  18
  19 DEFAULT_DEBUG_CHANNEL(relay);
  20
  21 char **debug_relay_excludelist = NULL, **debug_relay_includelist = NULL;
  22
  23 /***********************************************************************
  24  *           RELAY_ShowDebugmsgRelay
  25  *
  26  * Simple function to decide if a particular debugging message is
  27  * wanted.  Called from RELAY_CallFrom32 and from in if1632/relay.c
  28  */
  29 int RELAY_ShowDebugmsgRelay(const char *func) {
  30
  31   if(debug_relay_excludelist || debug_relay_includelist) {
  32     const char *term = strchr(func, ':');
  33     char **listitem;
  34     int len, len2, itemlen, show;
  35
  36     if(debug_relay_excludelist) {
  37       show = 1;
  38       listitem = debug_relay_excludelist;
  39     } else {
  40       show = 0;
  41       listitem = debug_relay_includelist;
  42     }
  43     assert(term);
  44     assert(strlen(term) > 2);
  45     len = term - func;
  46     len2 = strchr(func, '.') - func;
  47     assert(len2 && len2 > 0 && len2 < 64);
  48     term += 2;
  49     for(; *listitem; listitem++) {
  50       itemlen = strlen(*listitem);
  51       if((itemlen == len && !strncasecmp(*listitem, func, len)) ||
  52          (itemlen == len2 && !strncasecmp(*listitem, func, len2)) ||
  53          !strcasecmp(*listitem, term)) {
  54         show = !show;
  55        break;
  56       }
  57     }
  58     return show;
  59   }
  60   return 1;
  61 }
  62
  63
  64 #ifdef __i386__
  65
  66 typedef struct
  67 {
  68     BYTE          call;                    /* 0xe8 call callfrom32 (relative) */
  69     DWORD         callfrom32 WINE_PACKED;  /* RELAY_CallFrom32 relative addr */
  70     BYTE          ret;                     /* 0xc2 ret $n  or  0xc3 ret */
  71     WORD          args;                    /* nb of args to remove from the stack */
  72     void         *orig;                    /* original entry point */
  73     DWORD         argtypes;                /* argument types */
  74 } DEBUG_ENTRY_POINT;
  75
  76
  77 /***********************************************************************
  78  *           find_exported_name
  79  *
  80  * Find the name of an exported function.
  81  */
  82 static const char *find_exported_name( const char *module,
  83                                        IMAGE_EXPORT_DIRECTORY *exp, int ordinal )
  84 {
  85     int i;
  86     const char *ret = NULL;
  87
  88     WORD *ordptr = (WORD *)(module + exp->AddressOfNameOrdinals);
  89     for (i = 0; i < exp->NumberOfNames; i++, ordptr++)
  90         if (*ordptr + exp->Base == ordinal) break;
  91     if (i < exp->NumberOfNames)
  92         ret = module + ((DWORD*)(module + exp->AddressOfNames))[i];
  93     return ret;
  94 }
  95
  96
  97 /***********************************************************************
  98  *           get_entry_point
  99  *
 100  * Get the name of the DLL entry point corresponding to a relay address.
 101  */
 102 static void get_entry_point( char *buffer, DEBUG_ENTRY_POINT *relay )
 103 {
 104     IMAGE_DATA_DIRECTORY *dir;
 105     IMAGE_EXPORT_DIRECTORY *exp = NULL;
 106     DEBUG_ENTRY_POINT *debug;
 107     char *base = NULL;
 108     const char *name;
 109     int ordinal = 0;
 110     WINE_MODREF *wm;
 111
 112     /* First find the module */
 113
 114     for (wm = MODULE_modref_list; wm; wm = wm->next)
 115     {
 116         if (!(wm->flags & WINE_MODREF_INTERNAL)) continue;
 117         base = (char *)wm->module;
 118         dir = &PE_HEADER(base)->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
 119         if (!dir->Size) continue;
 120         exp = (IMAGE_EXPORT_DIRECTORY *)(base + dir->VirtualAddress);
 121         debug = (DEBUG_ENTRY_POINT *)((char *)exp + dir->Size);
 122         if (debug <= relay && relay < debug + exp->NumberOfFunctions)
 123         {
 124             ordinal = relay - debug;
 125             break;
 126         }
 127     }
 128
 129     /* Now find the function */
 130
 131     if ((name = find_exported_name( base, exp, ordinal + exp->Base )))
 132         sprintf( buffer, "%s.%s", base + exp->Name, name );
 133     else
 134         sprintf( buffer, "%s.%ld", base + exp->Name, ordinal + exp->Base );
 135 }
 136
 137
 138 /***********************************************************************
 139  *           RELAY_PrintArgs
 140  */
 141 static inline void RELAY_PrintArgs( int *args, int nb_args, unsigned int typemask )
 142 {
 143     while (nb_args--)
 144     {
 145         if ((typemask & 3) && HIWORD(*args))
 146         {
 147             if (typemask & 2)
 148                 DPRINTF( "%08x %s", *args, debugstr_w((LPWSTR)*args) );
 149             else
 150                 DPRINTF( "%08x %s", *args, debugstr_a((LPCSTR)*args) );
 151         }
 152         else DPRINTF( "%08x", *args );
 153         if (nb_args) DPRINTF( "," );
 154         args++;
 155         typemask >>= 2;
 156     }
 157 }
 158
 159
 160 typedef LONGLONG WINAPI (*LONGLONG_FARPROC)();
 161
 162 /***********************************************************************
 163  *           RELAY_CallFrom32
 164  *
 165  * Stack layout on entry to this function:
 166  *  ...      ...
 167  * (esp+12)  arg2
 168  * (esp+8)   arg1
 169  * (esp+4)   ret_addr
 170  * (esp)     return addr to relay code
 171  */
 172 static LONGLONG RELAY_CallFrom32( int ret_addr, ... )
 173 {
 174     LONGLONG ret;
 175     char buffer[80];
 176     BOOL ret64;
 177
 178     int *args = &ret_addr + 1;
 179     /* Relay addr is the return address for this function */
 180     BYTE *relay_addr = (BYTE *)__builtin_return_address(0);
 181     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
 182     WORD nb_args = relay->args / sizeof(int);
 183
 184     get_entry_point( buffer, relay );
 185
 186     DPRINTF( "%08lx:Call %s(", GetCurrentThreadId(), buffer );
 187     RELAY_PrintArgs( args, nb_args, relay->argtypes );
 188     DPRINTF( ") ret=%08x\n", ret_addr );
 189     ret64 = (relay->argtypes & 0x80000000) && (nb_args < 16);
 190
 191     if (relay->ret == 0xc3) /* cdecl */
 192     {
 193         LONGLONG (*cfunc)() = relay->orig;
 194         switch(nb_args)
 195         {
 196         case 0: ret = cfunc(); break;
 197         case 1: ret = cfunc(args[0]); break;
 198         case 2: ret = cfunc(args[0],args[1]); break;
 199         case 3: ret = cfunc(args[0],args[1],args[2]); break;
 200         case 4: ret = cfunc(args[0],args[1],args[2],args[3]); break;
 201         case 5: ret = cfunc(args[0],args[1],args[2],args[3],args[4]); break;
 202         case 6: ret = cfunc(args[0],args[1],args[2],args[3],args[4],
 203                             args[5]); break;
 204         case 7: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 205                             args[6]); break;
 206         case 8: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 207                             args[6],args[7]); break;
 208         case 9: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 209                             args[6],args[7],args[8]); break;
 210         case 10: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 211                              args[6],args[7],args[8],args[9]); break;
 212         case 11: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 213                              args[6],args[7],args[8],args[9],args[10]); break;
 214         case 12: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 215                              args[6],args[7],args[8],args[9],args[10],
 216                              args[11]); break;
 217         case 13: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 218                              args[6],args[7],args[8],args[9],args[10],args[11],
 219                              args[12]); break;
 220         case 14: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 221                              args[6],args[7],args[8],args[9],args[10],args[11],
 222                              args[12],args[13]); break;
 223         case 15: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 224                              args[6],args[7],args[8],args[9],args[10],args[11],
 225                              args[12],args[13],args[14]); break;
 226         case 16: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 227                              args[6],args[7],args[8],args[9],args[10],args[11],
 228                              args[12],args[13],args[14],args[15]); break;
 229         default:
 230             ERR( "Unsupported nb of args %d\n", nb_args );
 231             assert(FALSE);
 232         }
 233     }
 234     else  /* stdcall */
 235     {
 236         LONGLONG_FARPROC func = relay->orig;
 237         switch(nb_args)
 238         {
 239         case 0: ret = func(); break;
 240         case 1: ret = func(args[0]); break;
 241         case 2: ret = func(args[0],args[1]); break;
 242         case 3: ret = func(args[0],args[1],args[2]); break;
 243         case 4: ret = func(args[0],args[1],args[2],args[3]); break;
 244         case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
 245         case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
 246                            args[5]); break;
 247         case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 248                            args[6]); break;
 249         case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 250                            args[6],args[7]); break;
 251         case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 252                            args[6],args[7],args[8]); break;
 253         case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 254                             args[6],args[7],args[8],args[9]); break;
 255         case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 256                             args[6],args[7],args[8],args[9],args[10]); break;
 257         case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 258                             args[6],args[7],args[8],args[9],args[10],
 259                             args[11]); break;
 260         case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 261                             args[6],args[7],args[8],args[9],args[10],args[11],
 262                             args[12]); break;
 263         case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 264                             args[6],args[7],args[8],args[9],args[10],args[11],
 265                             args[12],args[13]); break;
 266         case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 267                             args[6],args[7],args[8],args[9],args[10],args[11],
 268                             args[12],args[13],args[14]); break;
 269         case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 270                             args[6],args[7],args[8],args[9],args[10],args[11],
 271                             args[12],args[13],args[14],args[15]); break;
 272         default:
 273             ERR( "Unsupported nb of args %d\n", nb_args );
 274             assert(FALSE);
 275         }
 276     }
 277     if (ret64)
 278         DPRINTF( "%08lx:Ret  %s() retval=%08x%08x ret=%08x\n",
 279                  GetCurrentThreadId(),
 280                  buffer, (UINT)(ret >> 32), (UINT)ret, ret_addr );
 281     else
 282         DPRINTF( "%08lx:Ret  %s() retval=%08x ret=%08x\n",
 283                  GetCurrentThreadId(),
 284                  buffer, (UINT)ret, ret_addr );
 285
 286     return ret;
 287 }
 288
 289
 290 /***********************************************************************
 291  *           RELAY_CallFrom32Regs
 292  *
 293  * Stack layout (esp is context->Esp, not the current %esp):
 294  *
 295  * ...
 296  * (esp+4) first arg
 297  * (esp)   return addr to caller
 298  * (esp-4) return addr to DEBUG_ENTRY_POINT
 299  * (esp-8) ptr to relay entry code for RELAY_CallFrom32Regs
 300  *  ...    >128 bytes space free to be modified (ensured by the assembly glue)
 301  */
 302 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context )
 303 {
 304     char buffer[80];
 305     int* args;
 306     FARPROC func;
 307     BYTE *entry_point;
 308
 309     BYTE *relay_addr = *((BYTE **)context->Esp - 1);
 310     DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
 311     WORD nb_args = (relay->args & ~0x8000) / sizeof(int);
 312
 313     /* remove extra stuff from the stack */
 314     context->Eip = stack32_pop(context);
 315     args = (int *)context->Esp;
 316     context->Esp += 4 * nb_args;
 317
 318     assert(TRACE_ON(relay));
 319
 320     entry_point = (BYTE *)relay->orig;
 321     assert( *entry_point == 0xe8 /* lcall */ );
 322     func = *(FARPROC *)(entry_point + 5);
 323
 324     get_entry_point( buffer, relay );
 325
 326     DPRINTF( "%08lx:Call %s(", GetCurrentThreadId(), buffer );
 327     RELAY_PrintArgs( args, nb_args, relay->argtypes );
 328     DPRINTF( ") ret=%08lx fs=%04lx\n", context->Eip, context->SegFs );
 329
 330     DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
 331             context->Eax, context->Ebx, context->Ecx,
 332             context->Edx, context->Esi, context->Edi );
 333     DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
 334             context->Ebp, context->Esp, context->SegDs,
 335             context->SegEs, context->SegGs, context->EFlags );
 336
 337     /* Now call the real function */
 338     switch(nb_args)
 339     {
 340     case 0: func(context); break;
 341     case 1: func(args[0],context); break;
 342     case 2: func(args[0],args[1],context); break;
 343     case 3: func(args[0],args[1],args[2],context); break;
 344     case 4: func(args[0],args[1],args[2],args[3],context); break;
 345     case 5: func(args[0],args[1],args[2],args[3],args[4],context); break;
 346     case 6: func(args[0],args[1],args[2],args[3],args[4],args[5],context); break;
 347     case 7: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],context); break;
 348     case 8: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],context); break;
 349     case 9: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 350                  context); break;
 351     case 10: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 352                   args[9],context); break;
 353     case 11: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 354                   args[9],args[10],context); break;
 355     case 12: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 356                   args[9],args[10],args[11],context); break;
 357     case 13: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 358                   args[9],args[10],args[11],args[12],context); break;
 359     case 14: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 360                   args[9],args[10],args[11],args[12],args[13],context); break;
 361     case 15: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
 362                   args[9],args[10],args[11],args[12],args[13],args[14],context); break;
 363     case 16: func(args[0],args[1],args[2],args[3],args[4],args[5], args[6],args[7],args[8],
 364                   args[9],args[10],args[11],args[12],args[13],args[14],args[15],context); break;
 365     default:
 366         ERR( "Unsupported nb of args %d\n", nb_args );
 367         assert(FALSE);
 368     }
 369
 370     DPRINTF( "%08lx:Ret  %s() retval=%08lx ret=%08lx fs=%04lx\n",
 371              GetCurrentThreadId(),
 372              buffer, context->Eax, context->Eip, context->SegFs );
 373
 374     DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
 375             context->Eax, context->Ebx, context->Ecx,
 376             context->Edx, context->Esi, context->Edi );
 377     DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
 378             context->Ebp, context->Esp, context->SegDs,
 379             context->SegEs, context->SegGs, context->EFlags );
 380 }
 381
 382 void WINAPI RELAY_CallFrom32Regs(void);
 383 __ASM_GLOBAL_FUNC( RELAY_CallFrom32Regs,
 384                    "call " __ASM_NAME("CALL32_Regs") "\n\t"
 385                    ".long " __ASM_NAME("RELAY_DoCallFrom32Regs") ",0" );
 386
 387 /***********************************************************************
 388  *           RELAY_SetupDLL
 389  *
 390  * Setup relay debugging for a built-in dll.
 391  */
 392 void RELAY_SetupDLL( const char *module )
 393 {
 394     IMAGE_DATA_DIRECTORY *dir;
 395     IMAGE_EXPORT_DIRECTORY *exports;
 396     DEBUG_ENTRY_POINT *debug;
 397     DWORD *funcs;
 398     int i;
 399     const char *name, *dllname;
 400
 401     dir = &PE_HEADER(module)->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
 402     if (!dir->Size) return;
 403     exports = (IMAGE_EXPORT_DIRECTORY *)(module + dir->VirtualAddress);
 404     debug = (DEBUG_ENTRY_POINT *)((char *)exports + dir->Size);
 405     funcs = (DWORD *)(module + exports->AddressOfFunctions);
 406     dllname = module + exports->Name;
 407
 408     for (i = 0; i < exports->NumberOfFunctions; i++, funcs++, debug++)
 409     {
 410         int on = 1;
 411
 412         if (!debug->call) continue;  /* not a normal function */
 413         if (debug->call != 0xe8 && debug->call != 0xe9) break; /* not a debug thunk at all */
 414
 415         if ((name = find_exported_name( module, exports, i + exports->Base )))
 416         {
 417             char buffer[200];
 418             sprintf( buffer, "%s.%d: %s", dllname, i, name );
 419             on = RELAY_ShowDebugmsgRelay(buffer);
 420         }
 421
 422         if (on)
 423         {
 424             debug->call = 0xe8;  /* call relative */
 425             if (debug->args & 0x8000)  /* register func */
 426                 debug->callfrom32 = (char *)RELAY_CallFrom32Regs - (char *)&debug->ret;
 427             else
 428                 debug->callfrom32 = (char *)RELAY_CallFrom32 - (char *)&debug->ret;
 429         }
 430         else
 431         {
 432             debug->call = 0xe9;  /* jmp relative */
 433             debug->callfrom32 = (char *)debug->orig - (char *)&debug->ret;
 434         }
 435
 436         debug->orig = (FARPROC)(module + (DWORD)*funcs);
 437         *funcs = (char *)debug - module;
 438     }
 439 }
 440
 441 #else  /* __i386__ */
 442
 443 void RELAY_SetupDLL( const char *module )
 444 {
 445 }
 446
 447 #endif /* __i386__ */