relay32/relay386.c

   1 /*
   2  * 386-specific Win32 relay functions
   3  *
   4  * Copyright 1997 Alexandre Julliard
   5  */
   6
   7 #ifdef __i386__
   8
   9 #include <assert.h>
  10 #include <string.h>
  11 #include "winnt.h"
  12 #include "windows.h"
  13 #include "builtin32.h"
  14 #include "selectors.h"
  15 #include "debugstr.h"
  16 #include "debug.h"
  17
  18 char **debug_relay_excludelist = NULL, **debug_relay_includelist = NULL;
  19
  20 /***********************************************************************
  21  *           RELAY_ShowDebugmsgRelay
  22  *
  23  * Simple function to decide if a particular debugging message is
  24  * wanted.  Called from RELAY_CallFrom32 and from in if1632/relay.c
  25  */
  26 int RELAY_ShowDebugmsgRelay(const char *func) {
  27
  28   if(debug_relay_excludelist || debug_relay_includelist) {
  29     const char *term = strchr(func, ':');
  30     char **listitem;
  31     int len, len2, itemlen, show;
  32
  33     if(debug_relay_excludelist) {
  34       show = 1;
  35       listitem = debug_relay_excludelist;
  36     } else {
  37       show = 0;
  38       listitem = debug_relay_includelist;
  39     }
  40     assert(term);
  41     assert(strlen(term) > 2);
  42     len = term - func;
  43     len2 = strchr(func, '.') - func;
  44     assert(len2 && len2 > 0 && len2 < 64);
  45     term += 2;
  46     for(; *listitem; listitem++) {
  47       itemlen = strlen(*listitem);
  48       if((itemlen == len && !strncmp(*listitem, func, len)) ||
  49          (itemlen == len2 && !strncmp(*listitem, func, len2)) ||
  50          !strcmp(*listitem, term)) {
  51         show = !show;
  52        break;
  53       }
  54     }
  55     return show;
  56   }
  57   return 1;
  58 }
  59
  60 /***********************************************************************
  61  *           RELAY_CallFrom32
  62  *
  63  * Stack layout on entry to this function:
  64  *  ...      ...
  65  * (esp+12)  arg2
  66  * (esp+8)   arg1
  67  * (esp+4)   ret_addr
  68  * (esp)     return addr to relay code
  69  */
  70 int RELAY_CallFrom32( int ret_addr, ... )
  71 {
  72     int i, ret, show;
  73     char buffer[80];
  74     FARPROC32 func;
  75     unsigned int mask, typemask;
  76     WORD fs;
  77     DWORD deadbeef = 0xdeadbeef,*xdeadbeef = &deadbeef;
  78
  79     int *args = &ret_addr;
  80     /* Relay addr is the return address for this function */
  81     BYTE *relay_addr = (BYTE *)args[-1];
  82     WORD nb_args = *(WORD *)(relay_addr + 1) / sizeof(int);
  83
  84     assert(TRACE_ON(relay));
  85     func = (FARPROC32)BUILTIN32_GetEntryPoint( buffer, relay_addr - 5,
  86                                                &typemask );
  87     show = RELAY_ShowDebugmsgRelay(buffer);
  88     if(show) {
  89       DPRINTF( "Call %s(", buffer );
  90       args++;
  91       for (i = 0, mask = 3; i < nb_args; i++, mask <<= 2)
  92       {
  93         if (i) DPRINTF( "," );
  94         if ((typemask & mask) && HIWORD(args[i]))
  95         {
  96             if (typemask & (2<<(2*i)))
  97                 DPRINTF( "%08x L%s", args[i], debugstr_w((LPWSTR)args[i]) );
  98             else
  99                 DPRINTF( "%08x %s", args[i], debugstr_a((LPCSTR)args[i]) );
 100         }
 101         else DPRINTF( "%08x", args[i] );
 102       }
 103       GET_FS( fs );
 104       DPRINTF( ") ret=%08x fs=%04x\n", ret_addr, fs );
 105     } else {
 106       args++;
 107       fs = 0; /* quieten gcc */
 108     }
 109     if (*relay_addr == 0xc3) /* cdecl */
 110     {
 111         LRESULT (*cfunc)() = (LRESULT(*)())func;
 112         switch(nb_args)
 113         {
 114         case 0: ret = cfunc(); break;
 115         case 1: ret = cfunc(args[0]); break;
 116         case 2: ret = cfunc(args[0],args[1]); break;
 117         case 3: ret = cfunc(args[0],args[1],args[2]); break;
 118         case 4: ret = cfunc(args[0],args[1],args[2],args[3]); break;
 119         case 5: ret = cfunc(args[0],args[1],args[2],args[3],args[4]); break;
 120         case 6: ret = cfunc(args[0],args[1],args[2],args[3],args[4],
 121                             args[5]); break;
 122         case 7: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 123                             args[6]); break;
 124         case 8: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 125                             args[6],args[7]); break;
 126         case 9: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 127                             args[6],args[7],args[8]); break;
 128         case 10: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 129                              args[6],args[7],args[8],args[9]); break;
 130         case 11: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 131                              args[6],args[7],args[8],args[9],args[10]); break;
 132         case 12: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 133                              args[6],args[7],args[8],args[9],args[10],
 134                              args[11]); break;
 135         case 13: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 136                              args[6],args[7],args[8],args[9],args[10],args[11],
 137                              args[12]); break;
 138         case 14: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 139                              args[6],args[7],args[8],args[9],args[10],args[11],
 140                              args[12],args[13]); break;
 141         case 15: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
 142                              args[6],args[7],args[8],args[9],args[10],args[11],
 143                              args[12],args[13],args[14]); break;
 144         default:
 145             ERR(relay, "Unsupported nb args %d\n",
 146                      nb_args );
 147             assert(FALSE);
 148         }
 149     }
 150     else  /* stdcall */
 151     {
 152         switch(nb_args)
 153         {
 154         case 0: ret = func(); break;
 155         case 1: ret = func(args[0]); break;
 156         case 2: ret = func(args[0],args[1]); break;
 157         case 3: ret = func(args[0],args[1],args[2]); break;
 158         case 4: ret = func(args[0],args[1],args[2],args[3]); break;
 159         case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
 160         case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
 161                            args[5]); break;
 162         case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 163                            args[6]); break;
 164         case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 165                            args[6],args[7]); break;
 166         case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 167                            args[6],args[7],args[8]); break;
 168         case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 169                             args[6],args[7],args[8],args[9]); break;
 170         case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 171                             args[6],args[7],args[8],args[9],args[10]); break;
 172         case 12: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 173                             args[6],args[7],args[8],args[9],args[10],
 174                             args[11]); break;
 175         case 13: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 176                             args[6],args[7],args[8],args[9],args[10],args[11],
 177                             args[12]); break;
 178         case 14: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 179                             args[6],args[7],args[8],args[9],args[10],args[11],
 180                             args[12],args[13]); break;
 181         case 15: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
 182                             args[6],args[7],args[8],args[9],args[10],args[11],
 183                             args[12],args[13],args[14]); break;
 184         default:
 185             ERR(relay, "Unsupported nb args %d\n",nb_args );
 186             assert(FALSE);
 187         }
 188     }
 189     if(show)
 190       DPRINTF( "Ret  %s() retval=%08x ret=%08x fs=%04x\n",
 191                buffer, ret, ret_addr, fs );
 192     assert(*xdeadbeef==0xdeadbeef);
 193     return ret;
 194 }
 195
 196
 197 /***********************************************************************
 198  *           RELAY_CallFrom32Regs
 199  *
 200  * 'context' contains the register contents at the point of call of
 201  * the REG_ENTRY_POINT. The stack layout of the stack pointed to by
 202  * ESP_reg(&context) is as follows:
 203  *
 204  * If debugmsg(relay) is OFF:
 205  *  ...    ...
 206  * (esp+4) args
 207  * (esp)   return addr to caller
 208  * (esp-4) function entry point
 209  *
 210  * If debugmsg(relay) is ON:
 211  *  ...    ...
 212  * (esp+8) args
 213  * (esp+4) return addr to caller
 214  * (esp)   return addr to DEBUG_ENTRY_POINT
 215  * (esp-4) function entry point
 216  *
 217  * As the called function might change the stack layout
 218  * (e.g. FT_Prolog, FT_ExitNN), we remove all modifications to the stack,
 219  * so that the called function sees (in both cases):
 220  *
 221  *  ...    ...
 222  * (esp+4) args
 223  * (esp)   return addr to caller
 224  *  ...    >128 bytes space free to be modified (ensured by the assembly glue)
 225  *
 226  * NOTE: This routine makes no assumption about the relative position of
 227  *       its own stack to the stack pointed to by ESP_reg(&context),
 228  *       except that the latter must have >128 bytes space to grow.
 229  *       This means the assembly glue could even switch stacks completely
 230  *       (e.g. to allow for large stacks).
 231  *
 232  */
 233
 234 void RELAY_CallFrom32Regs( CONTEXT context )
 235 {
 236     typedef void (CALLBACK *entry_point_t)(CONTEXT *);
 237     entry_point_t entry_point = *(entry_point_t*) (ESP_reg(&context) - 4);
 238
 239     __RESTORE_ES;
 240
 241     if (!TRACE_ON(relay))
 242     {
 243         /* Simply call the entry point */
 244         entry_point( &context );
 245     }
 246     else
 247     {
 248         char buffer[80];
 249         unsigned int typemask;
 250         BYTE *relay_addr;
 251
 252         /*
 253          * Fixup the context structure because of the extra parameter
 254          * pushed by the relay debugging code.
 255          * Note that this implicitly does a RET on the CALL from the
 256          * DEBUG_ENTRY_POINT to the REG_ENTRY_POINT;  setting the EIP register
 257          * ensures that the assembly glue will directly return to the
 258          * caller, just as in the non-debugging case.
 259          */
 260
 261         relay_addr = *(BYTE **) ESP_reg(&context);
 262         if (BUILTIN32_GetEntryPoint( buffer, relay_addr - 5, &typemask )) {
 263             /* correct win32 spec generated register function found.
 264              * remove extra call stuff from stack
 265              */
 266             ESP_reg(&context) += sizeof(BYTE *);
 267             EIP_reg(&context) = *(DWORD *)ESP_reg(&context);
 268             DPRINTF("Call %s(regs) ret=%08x\n", buffer, *(int *)ESP_reg(&context) );
 269             DPRINTF(" EAX=%08lx EBX=%08lx ECX=%08lx EDX=%08lx ESI=%08lx EDI=%08lx\n",
 270                     EAX_reg(&context), EBX_reg(&context), ECX_reg(&context),
 271                     EDX_reg(&context), ESI_reg(&context), EDI_reg(&context) );
 272             DPRINTF(" EBP=%08lx ESP=%08lx EIP=%08lx DS=%04lx ES=%04lx FS=%04lx GS=%04lx EFL=%08lx\n",
 273                     EBP_reg(&context), ESP_reg(&context), EIP_reg(&context),
 274                     DS_reg(&context), ES_reg(&context), FS_reg(&context),
 275                     GS_reg(&context), EFL_reg(&context) );
 276
 277             /* Now call the real function */
 278             entry_point( &context );
 279
 280
 281             DPRINTF("Ret  %s() retval=regs ret=%08x\n", buffer, *(int *)ESP_reg(&context) );
 282             DPRINTF(" EAX=%08lx EBX=%08lx ECX=%08lx EDX=%08lx ESI=%08lx EDI=%08lx\n",
 283                     EAX_reg(&context), EBX_reg(&context), ECX_reg(&context),
 284                     EDX_reg(&context), ESI_reg(&context), EDI_reg(&context) );
 285             DPRINTF(" EBP=%08lx ESP=%08lx EIP=%08lx DS=%04lx ES=%04lx FS=%04lx GS=%04lx EFL=%08lx\n",
 286                     EBP_reg(&context), ESP_reg(&context), EIP_reg(&context),
 287                     DS_reg(&context), ES_reg(&context), FS_reg(&context),
 288                     GS_reg(&context), EFL_reg(&context) );
 289         } else
 290             /* WINE internal register function found. Do not remove anything.
 291              * Do not print any debuginfo (it is not a normal relayed one).
 292              * Currently only used for snooping.
 293              */
 294            entry_point( &context );
 295     }
 296 }
 297 #endif  /* __i386__ */