Added magic comments to all Wine-specific registry accesses to make
[wine] / dlls / kernel / snoop16.c
1 /*
2  * 386-specific Win16 dll<->dll snooping functions
3  *
4  * Copyright 1998 Marcus Meissner
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <string.h>
26 #include <stdarg.h>
27 #include <stdio.h>
28 #include "windef.h"
29 #include "winbase.h"
30 #include "winnt.h"
31 #include "wine/winbase16.h"
32 #include "winreg.h"
33 #include "winternl.h"
34 #include "wine/library.h"
35 #include "kernel_private.h"
36 #include "kernel16_private.h"
37 #include "toolhelp.h"
38 #include "wine/debug.h"
39
40 WINE_DEFAULT_DEBUG_CHANNEL(snoop);
41
42 #ifdef __i386__
43
44 #include "pshpack1.h"
45
46 void WINAPI SNOOP16_Entry(FARPROC proc, LPBYTE args, CONTEXT86 *context);
47 void WINAPI SNOOP16_Return(FARPROC proc, LPBYTE args, CONTEXT86 *context);
48
49 typedef struct tagSNOOP16_FUN {
50         /* code part */
51         BYTE            lcall;          /* 0x9a call absolute with segment */
52         DWORD           snr;
53         /* unreached */
54         int             nrofargs;
55         FARPROC16       origfun;
56         char            *name;
57 } SNOOP16_FUN;
58
59 typedef struct tagSNOOP16_DLL {
60         HMODULE16       hmod;
61         HANDLE16        funhandle;
62         SNOOP16_FUN     *funs;
63         struct tagSNOOP16_DLL   *next;
64         char name[1];
65 } SNOOP16_DLL;
66
67 typedef struct tagSNOOP16_RETURNENTRY {
68         /* code part */
69         BYTE            lcall;          /* 0x9a call absolute with segment */
70         DWORD           snr;
71         /* unreached */
72         FARPROC16       origreturn;
73         SNOOP16_DLL     *dll;
74         DWORD           ordinal;
75         WORD            origSP;
76         WORD            *args;          /* saved args across a stdcall */
77 } SNOOP16_RETURNENTRY;
78
79 typedef struct tagSNOOP16_RETURNENTRIES {
80         SNOOP16_RETURNENTRY entry[65500/sizeof(SNOOP16_RETURNENTRY)];
81         HANDLE16        rethandle;
82         struct tagSNOOP16_RETURNENTRIES *next;
83 } SNOOP16_RETURNENTRIES;
84
85 typedef struct tagSNOOP16_RELAY {
86         WORD            pushbp;         /* 0x5566 */
87         BYTE            pusheax;        /* 0x50 */
88         WORD            pushax;         /* 0x5066 */
89         BYTE            pushl;          /* 0x68 */
90         DWORD           realfun;        /* SNOOP16_Return */
91         BYTE            lcall;          /* 0x9a call absolute with segment */
92         DWORD           callfromregs;
93         WORD            seg;
94         WORD            lret;           /* 0xcb66 */
95 } SNOOP16_RELAY;
96
97 #include "poppack.h"
98
99 static  SNOOP16_DLL             *firstdll = NULL;
100 static  SNOOP16_RETURNENTRIES   *firstrets = NULL;
101 static  SNOOP16_RELAY           *snr;
102 static  HANDLE16                xsnr = 0;
103
104 void
105 SNOOP16_RegisterDLL(HMODULE16 hModule,LPCSTR name) {
106         SNOOP16_DLL     **dll = &(firstdll);
107         char            *s;
108
109         if (!TRACE_ON(snoop)) return;
110
111         TRACE("hmod=%x, name=%s\n", hModule, name);
112
113         if (!snr) {
114                 xsnr=GLOBAL_Alloc(GMEM_ZEROINIT,2*sizeof(*snr),0,WINE_LDT_FLAGS_CODE|WINE_LDT_FLAGS_32BIT);
115                 snr = GlobalLock16(xsnr);
116                 snr[0].pushbp   = 0x5566;
117                 snr[0].pusheax  = 0x50;
118                 snr[0].pushax   = 0x5066;
119                 snr[0].pushl    = 0x68;
120                 snr[0].realfun  = (DWORD)SNOOP16_Entry;
121                 snr[0].lcall    = 0x9a;
122                 snr[0].callfromregs = (DWORD)__wine_call_from_16_regs;
123                 snr[0].seg      = wine_get_cs();
124                 snr[0].lret     = 0xcb66;
125
126                 snr[1].pushbp   = 0x5566;
127                 snr[1].pusheax  = 0x50;
128                 snr[1].pushax   = 0x5066;
129                 snr[1].pushl    = 0x68;
130                 snr[1].realfun  = (DWORD)SNOOP16_Return;
131                 snr[1].lcall    = 0x9a;
132                 snr[1].callfromregs = (DWORD)__wine_call_from_16_regs;
133                 snr[1].seg      = wine_get_cs();
134                 snr[1].lret     = 0xcb66;
135         }
136         while (*dll) {
137                 if ((*dll)->hmod == hModule)
138                 {
139                     /* another dll, loaded at the same address */
140                     GlobalUnlock16((*dll)->funhandle);
141                     GlobalFree16((*dll)->funhandle);
142                     break;
143                 }
144                 dll = &((*dll)->next);
145         }
146
147         if (*dll)
148                 *dll = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *dll, sizeof(SNOOP16_DLL)+strlen(name));
149         else
150                 *dll = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(SNOOP16_DLL)+strlen(name)); 
151
152         (*dll)->next    = NULL;
153         (*dll)->hmod    = hModule;
154         if ((s=strrchr(name,'\\')))
155                 name = s+1;
156         strcpy( (*dll)->name, name );
157         if ((s=strrchr((*dll)->name,'.')))
158                 *s='\0';
159         (*dll)->funhandle = GlobalHandleToSel16(GLOBAL_Alloc(GMEM_ZEROINIT,65535,0,WINE_LDT_FLAGS_CODE));
160         (*dll)->funs = GlobalLock16((*dll)->funhandle);
161         if (!(*dll)->funs) {
162                 HeapFree(GetProcessHeap(),0,*dll);
163                 FIXME("out of memory\n");
164                 return;
165         }
166 }
167
168 FARPROC16
169 SNOOP16_GetProcAddress16(HMODULE16 hmod,DWORD ordinal,FARPROC16 origfun) {
170         SNOOP16_DLL                     *dll = firstdll;
171         SNOOP16_FUN                     *fun;
172         NE_MODULE                       *pModule = NE_GetPtr(hmod);
173         unsigned char                   *cpnt;
174         char                            name[200];
175
176         if (!TRACE_ON(snoop) || !pModule || !HIWORD(origfun))
177                 return origfun;
178         if (!*(LPBYTE)MapSL((SEGPTR)origfun)) /* 0x00 is an imposs. opcode, poss. dataref. */
179                 return origfun;
180         while (dll) {
181                 if (hmod == dll->hmod)
182                         break;
183                 dll=dll->next;
184         }
185         if (!dll)       /* probably internal */
186                 return origfun;
187         if (ordinal>65535/sizeof(SNOOP16_FUN))
188                 return origfun;
189         fun = dll->funs+ordinal;
190         /* already done? */
191         fun->lcall      = 0x9a;
192         fun->snr        = MAKELONG(0,xsnr);
193         fun->origfun    = origfun;
194         if (fun->name)
195                 return (FARPROC16)(SEGPTR)MAKELONG(((char*)fun-(char*)dll->funs),dll->funhandle);
196         cpnt = (unsigned char *)pModule + pModule->ne_restab;
197         while (*cpnt) {
198                 cpnt += *cpnt + 1 + sizeof(WORD);
199                 if (*(WORD*)(cpnt+*cpnt+1) == ordinal) {
200                         sprintf(name,"%.*s",*cpnt,cpnt+1);
201                         break;
202                 }
203         }
204         /* Now search the non-resident names table */
205
206         if (!*cpnt && pModule->nrname_handle) {
207                 cpnt = (char *)GlobalLock16( pModule->nrname_handle );
208                 while (*cpnt) {
209                         cpnt += *cpnt + 1 + sizeof(WORD);
210                         if (*(WORD*)(cpnt+*cpnt+1) == ordinal) {
211                                     sprintf(name,"%.*s",*cpnt,cpnt+1);
212                                     break;
213                         }
214                 }
215         }
216         if (*cpnt)
217         {
218             fun->name = HeapAlloc(GetProcessHeap(),0,strlen(name)+1);
219             strcpy( fun->name, name );
220         }
221         else
222             fun->name = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,1); /* empty string */
223
224         if (!SNOOP16_ShowDebugmsgSnoop(dll->name, ordinal, fun->name))
225                 return origfun;
226
227         /* more magic. do not try to snoop thunk data entries (MMSYSTEM) */
228         if (strchr(fun->name,'_')) {
229                 char *s=strchr(fun->name,'_');
230
231                 if (!strncasecmp(s,"_thunkdata",10)) {
232                         HeapFree(GetProcessHeap(),0,fun->name);
233                         fun->name = NULL;
234                         return origfun;
235                 }
236         }
237         fun->lcall      = 0x9a;
238         fun->snr        = MAKELONG(0,xsnr);
239         fun->origfun    = origfun;
240         fun->nrofargs   = -1;
241         return (FARPROC16)(SEGPTR)MAKELONG(((char*)fun-(char*)dll->funs),dll->funhandle);
242 }
243
244 #define CALLER1REF (*(DWORD*)(MapSL( MAKESEGPTR(context->SegSs,LOWORD(context->Esp)+4))))
245 void WINAPI SNOOP16_Entry(FARPROC proc, LPBYTE args, CONTEXT86 *context) {
246         DWORD           ordinal=0;
247         DWORD           entry=(DWORD)MapSL( MAKESEGPTR(context->SegCs,LOWORD(context->Eip)) )-5;
248         WORD            xcs = context->SegCs;
249         SNOOP16_DLL     *dll = firstdll;
250         SNOOP16_FUN     *fun = NULL;
251         SNOOP16_RETURNENTRIES   **rets = &firstrets;
252         SNOOP16_RETURNENTRY     *ret;
253         int             i=0, max;
254
255         while (dll) {
256                 if (xcs == dll->funhandle) {
257                         fun = (SNOOP16_FUN*)entry;
258                         ordinal = fun-dll->funs;
259                         break;
260                 }
261                 dll=dll->next;
262         }
263         if (!dll) {
264                 FIXME("entrypoint 0x%08lx not found\n",entry);
265                 return; /* oops */
266         }
267         while (*rets) {
268                 for (i=0;i<sizeof((*rets)->entry)/sizeof((*rets)->entry[0]);i++)
269                         if (!(*rets)->entry[i].origreturn)
270                                 break;
271                 if (i!=sizeof((*rets)->entry)/sizeof((*rets)->entry[0]))
272                         break;
273                 rets = &((*rets)->next);
274         }
275         if (!*rets) {
276                 HANDLE16 hand = GlobalHandleToSel16(GLOBAL_Alloc(GMEM_ZEROINIT,65535,0,WINE_LDT_FLAGS_CODE));
277                 *rets = GlobalLock16(hand);
278                 (*rets)->rethandle = hand;
279                 i = 0;  /* entry 0 is free */
280         }
281         ret = &((*rets)->entry[i]);
282         ret->lcall      = 0x9a;
283         ret->snr        = MAKELONG(sizeof(SNOOP16_RELAY),xsnr);
284         ret->origreturn = (FARPROC16)CALLER1REF;
285         CALLER1REF      = MAKELONG((char*)&(ret->lcall)-(char*)((*rets)->entry),(*rets)->rethandle);
286         ret->dll        = dll;
287         ret->args       = NULL;
288         ret->ordinal    = ordinal;
289         ret->origSP     = LOWORD(context->Esp);
290
291         context->Eip= LOWORD(fun->origfun);
292         context->SegCs = HIWORD(fun->origfun);
293
294
295         DPRINTF("%04lx:CALL %s.%ld: %s(",GetCurrentThreadId(), dll->name,ordinal,fun->name);
296         if (fun->nrofargs>0) {
297                 max = fun->nrofargs;
298                 if (max>16) max=16;
299                 for (i=max;i--;)
300                         DPRINTF("%04x%s",*(WORD*)((char *) MapSL( MAKESEGPTR(context->SegSs,LOWORD(context->Esp)) )+8+sizeof(WORD)*i),i?",":"");
301                 if (max!=fun->nrofargs)
302                         DPRINTF(" ...");
303         } else if (fun->nrofargs<0) {
304                 DPRINTF("<unknown, check return>");
305                 ret->args = HeapAlloc(GetProcessHeap(),0,16*sizeof(WORD));
306                 memcpy(ret->args,(LPBYTE)((char *) MapSL( MAKESEGPTR(context->SegSs,LOWORD(context->Esp)) )+8),sizeof(WORD)*16);
307         }
308         DPRINTF(") ret=%04x:%04x\n",HIWORD(ret->origreturn),LOWORD(ret->origreturn));
309 }
310
311 void WINAPI SNOOP16_Return(FARPROC proc, LPBYTE args, CONTEXT86 *context) {
312         SNOOP16_RETURNENTRY     *ret = (SNOOP16_RETURNENTRY*)((char *) MapSL( MAKESEGPTR(context->SegCs,LOWORD(context->Eip)) )-5);
313
314         /* We haven't found out the nrofargs yet. If we called a cdecl
315          * function it is too late anyway and we can just set '0' (which
316          * will be the difference between orig and current SP
317          * If pascal -> everything ok.
318          */
319         if (ret->dll->funs[ret->ordinal].nrofargs<0) {
320                 ret->dll->funs[ret->ordinal].nrofargs=(LOWORD(context->Esp)-ret->origSP-4)/2;
321         }
322         context->Eip = LOWORD(ret->origreturn);
323         context->SegCs  = HIWORD(ret->origreturn);
324         DPRINTF("%04lx:RET  %s.%ld: %s(",
325                 GetCurrentThreadId(),ret->dll->name,ret->ordinal,
326                 ret->dll->funs[ret->ordinal].name);
327         if (ret->args) {
328                 int     i,max;
329
330                 max = ret->dll->funs[ret->ordinal].nrofargs;
331                 if (max>16)
332                         max=16;
333                 if (max<0)
334                         max=0;
335
336                 for (i=max;i--;)
337                         DPRINTF("%04x%s",ret->args[i],i?",":"");
338                 if (max!=ret->dll->funs[ret->ordinal].nrofargs)
339                         DPRINTF(" ...");
340                 HeapFree(GetProcessHeap(),0,ret->args);
341                 ret->args = NULL;
342         }
343         DPRINTF(") retval = %04x:%04x ret=%04x:%04x\n",
344                 (WORD)context->Edx,(WORD)context->Eax,
345                 HIWORD(ret->origreturn),LOWORD(ret->origreturn));
346         ret->origreturn = NULL; /* mark as empty */
347 }
348 #else   /* !__i386__ */
349 void SNOOP16_RegisterDLL(HMODULE16 hModule,LPCSTR name) {
350         if (!TRACE_ON(snoop)) return;
351         FIXME("snooping works only on i386 for now.\n");
352 }
353
354 FARPROC16 SNOOP16_GetProcAddress16(HMODULE16 hmod,DWORD ordinal,FARPROC16 origfun) {
355         return origfun;
356 }
357 #endif  /* !__i386__ */