2 * 386-specific Win32 relay functions
4 * Copyright 1997 Alexandre Julliard
12 #include "selectors.h"
13 #include "stackframe.h"
18 #include "debugtools.h"
20 DEFAULT_DEBUG_CHANNEL(relay);
22 char **debug_relay_excludelist = NULL, **debug_relay_includelist = NULL;
24 /***********************************************************************
25 * RELAY_ShowDebugmsgRelay
27 * Simple function to decide if a particular debugging message is
28 * wanted. Called from RELAY_CallFrom32 and from in if1632/relay.c
30 int RELAY_ShowDebugmsgRelay(const char *func) {
32 if(debug_relay_excludelist || debug_relay_includelist) {
33 const char *term = strchr(func, ':');
35 int len, len2, itemlen, show;
37 if(debug_relay_excludelist) {
39 listitem = debug_relay_excludelist;
42 listitem = debug_relay_includelist;
45 assert(strlen(term) > 2);
47 len2 = strchr(func, '.') - func;
48 assert(len2 && len2 > 0 && len2 < 64);
50 for(; *listitem; listitem++) {
51 itemlen = strlen(*listitem);
52 if((itemlen == len && !strncasecmp(*listitem, func, len)) ||
53 (itemlen == len2 && !strncasecmp(*listitem, func, len2)) ||
54 !strcasecmp(*listitem, term)) {
69 BYTE call; /* 0xe8 call callfrom32 (relative) */
70 DWORD callfrom32 WINE_PACKED; /* RELAY_CallFrom32 relative addr */
71 BYTE ret; /* 0xc2 ret $n or 0xc3 ret */
72 WORD args; /* nb of args to remove from the stack */
73 void *orig; /* original entry point */
74 DWORD argtypes; /* argument types */
78 /***********************************************************************
81 * Find the name of an exported function.
83 static const char *find_exported_name( const char *module,
84 IMAGE_EXPORT_DIRECTORY *exp, int ordinal )
87 const char *ret = NULL;
89 WORD *ordptr = (WORD *)(module + exp->AddressOfNameOrdinals);
90 for (i = 0; i < exp->NumberOfNames; i++, ordptr++)
91 if (*ordptr + exp->Base == ordinal) break;
92 if (i < exp->NumberOfNames)
93 ret = module + ((DWORD*)(module + exp->AddressOfNames))[i];
98 /***********************************************************************
101 * Get the name of the DLL entry point corresponding to a relay address.
103 static void get_entry_point( char *buffer, DEBUG_ENTRY_POINT *relay )
105 IMAGE_DATA_DIRECTORY *dir;
106 IMAGE_EXPORT_DIRECTORY *exp = NULL;
107 DEBUG_ENTRY_POINT *debug;
113 /* First find the module */
115 for (wm = PROCESS_Current()->modref_list; wm; wm = wm->next)
117 if (!(wm->flags & WINE_MODREF_INTERNAL)) continue;
118 base = (char *)wm->module;
119 dir = &PE_HEADER(base)->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
120 if (!dir->Size) continue;
121 exp = (IMAGE_EXPORT_DIRECTORY *)(base + dir->VirtualAddress);
122 debug = (DEBUG_ENTRY_POINT *)((char *)exp + dir->Size);
123 if (debug <= relay && relay < debug + exp->NumberOfFunctions)
125 ordinal = relay - debug;
130 /* Now find the function */
132 name = find_exported_name( base, exp, ordinal + exp->Base );
133 sprintf( buffer, "%s.%ld: %s", base + exp->Name, ordinal + exp->Base, name ? name : "@" );
137 /***********************************************************************
140 static inline void RELAY_PrintArgs( int *args, int nb_args, unsigned int typemask )
144 if ((typemask & 3) && HIWORD(*args))
147 DPRINTF( "%08x %s", *args, debugstr_w((LPWSTR)*args) );
149 DPRINTF( "%08x %s", *args, debugstr_a((LPCSTR)*args) );
151 else DPRINTF( "%08x", *args );
152 if (nb_args) DPRINTF( "," );
159 typedef LONGLONG WINAPI (*LONGLONG_FARPROC)();
161 /***********************************************************************
164 * Stack layout on entry to this function:
169 * (esp) return addr to relay code
171 static LONGLONG RELAY_CallFrom32( int ret_addr, ... )
177 int *args = &ret_addr + 1;
178 /* Relay addr is the return address for this function */
179 BYTE *relay_addr = (BYTE *)__builtin_return_address(0);
180 DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
181 WORD nb_args = relay->args / sizeof(int);
183 get_entry_point( buffer, relay );
185 DPRINTF( "Call %s(", buffer );
186 RELAY_PrintArgs( args, nb_args, relay->argtypes );
187 DPRINTF( ") ret=%08x fs=%04x\n", ret_addr, __get_fs() );
188 ret64 = (relay->argtypes & 0x80000000) && (nb_args < 16);
190 /* the user driver functions may be called with the window lock held */
191 if (memcmp( buffer, "x11drv.", 7 ) && memcmp( buffer, "ttydrv.", 7 ))
192 SYSLEVEL_CheckNotLevel( 2 );
194 if (relay->ret == 0xc3) /* cdecl */
196 LONGLONG (*cfunc)() = relay->orig;
199 case 0: ret = cfunc(); break;
200 case 1: ret = cfunc(args[0]); break;
201 case 2: ret = cfunc(args[0],args[1]); break;
202 case 3: ret = cfunc(args[0],args[1],args[2]); break;
203 case 4: ret = cfunc(args[0],args[1],args[2],args[3]); break;
204 case 5: ret = cfunc(args[0],args[1],args[2],args[3],args[4]); break;
205 case 6: ret = cfunc(args[0],args[1],args[2],args[3],args[4],
207 case 7: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
209 case 8: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
210 args[6],args[7]); break;
211 case 9: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
212 args[6],args[7],args[8]); break;
213 case 10: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
214 args[6],args[7],args[8],args[9]); break;
215 case 11: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
216 args[6],args[7],args[8],args[9],args[10]); break;
217 case 12: 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],
220 case 13: 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],
223 case 14: 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]); break;
226 case 15: 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]); break;
229 case 16: ret = cfunc(args[0],args[1],args[2],args[3],args[4],args[5],
230 args[6],args[7],args[8],args[9],args[10],args[11],
231 args[12],args[13],args[14],args[15]); break;
233 ERR( "Unsupported nb of args %d\n", nb_args );
239 LONGLONG_FARPROC func = relay->orig;
242 case 0: ret = func(); break;
243 case 1: ret = func(args[0]); break;
244 case 2: ret = func(args[0],args[1]); break;
245 case 3: ret = func(args[0],args[1],args[2]); break;
246 case 4: ret = func(args[0],args[1],args[2],args[3]); break;
247 case 5: ret = func(args[0],args[1],args[2],args[3],args[4]); break;
248 case 6: ret = func(args[0],args[1],args[2],args[3],args[4],
250 case 7: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
252 case 8: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
253 args[6],args[7]); break;
254 case 9: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
255 args[6],args[7],args[8]); break;
256 case 10: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
257 args[6],args[7],args[8],args[9]); break;
258 case 11: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
259 args[6],args[7],args[8],args[9],args[10]); break;
260 case 12: 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],
263 case 13: 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],
266 case 14: 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]); break;
269 case 15: 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]); break;
272 case 16: ret = func(args[0],args[1],args[2],args[3],args[4],args[5],
273 args[6],args[7],args[8],args[9],args[10],args[11],
274 args[12],args[13],args[14],args[15]); break;
276 ERR( "Unsupported nb of args %d\n", nb_args );
281 DPRINTF( "Ret %s() retval=%08x%08x ret=%08x fs=%04x\n",
282 buffer, (UINT)(ret >> 32), (UINT)ret, ret_addr, __get_fs() );
284 DPRINTF( "Ret %s() retval=%08x ret=%08x fs=%04x\n",
285 buffer, (UINT)ret, ret_addr, __get_fs() );
287 if (memcmp( buffer, "x11drv.", 7 ) && memcmp( buffer, "ttydrv.", 7 ))
288 SYSLEVEL_CheckNotLevel( 2 );
294 /***********************************************************************
295 * RELAY_CallFrom32Regs
297 * Stack layout (esp is context->Esp, not the current %esp):
301 * (esp) return addr to caller
302 * (esp-4) return addr to DEBUG_ENTRY_POINT
303 * (esp-8) ptr to relay entry code for RELAY_CallFrom32Regs
304 * ... >128 bytes space free to be modified (ensured by the assembly glue)
307 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context );
308 DEFINE_REGS_ENTRYPOINT_0( RELAY_CallFrom32Regs, RELAY_DoCallFrom32Regs )
309 void WINAPI RELAY_DoCallFrom32Regs( CONTEXT86 *context )
316 BYTE *relay_addr = *((BYTE **)context->Esp - 1);
317 DEBUG_ENTRY_POINT *relay = (DEBUG_ENTRY_POINT *)(relay_addr - 5);
318 WORD nb_args = (relay->args & ~0x8000) / sizeof(int);
320 /* remove extra stuff from the stack */
321 context->Eip = stack32_pop(context);
322 args = (int *)context->Esp;
323 context->Esp += 4 * nb_args;
325 assert(TRACE_ON(relay));
327 entry_point = (BYTE *)relay->orig;
328 assert( *entry_point == 0xe8 /* lcall */ );
329 func = *(FARPROC *)(entry_point + 5);
331 get_entry_point( buffer, relay );
333 DPRINTF( "Call %s(", buffer );
334 RELAY_PrintArgs( args, nb_args, relay->argtypes );
335 DPRINTF( ") ret=%08lx fs=%04lx\n", context->Eip, context->SegFs );
337 DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
338 context->Eax, context->Ebx, context->Ecx,
339 context->Edx, context->Esi, context->Edi );
340 DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
341 context->Ebp, context->Esp, context->SegDs,
342 context->SegEs, context->SegGs, context->EFlags );
344 SYSLEVEL_CheckNotLevel( 2 );
346 /* Now call the real function */
349 case 0: func(context); break;
350 case 1: func(args[0],context); break;
351 case 2: func(args[0],args[1],context); break;
352 case 3: func(args[0],args[1],args[2],context); break;
353 case 4: func(args[0],args[1],args[2],args[3],context); break;
354 case 5: func(args[0],args[1],args[2],args[3],args[4],context); break;
355 case 6: func(args[0],args[1],args[2],args[3],args[4],args[5],context); break;
356 case 7: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],context); break;
357 case 8: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],context); break;
358 case 9: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
360 case 10: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
361 args[9],context); break;
362 case 11: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
363 args[9],args[10],context); break;
364 case 12: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
365 args[9],args[10],args[11],context); break;
366 case 13: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
367 args[9],args[10],args[11],args[12],context); break;
368 case 14: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
369 args[9],args[10],args[11],args[12],args[13],context); break;
370 case 15: func(args[0],args[1],args[2],args[3],args[4],args[5],args[6],args[7],args[8],
371 args[9],args[10],args[11],args[12],args[13],args[14],context); break;
372 case 16: func(args[0],args[1],args[2],args[3],args[4],args[5], args[6],args[7],args[8],
373 args[9],args[10],args[11],args[12],args[13],args[14],args[15],context); break;
375 ERR( "Unsupported nb of args %d\n", nb_args );
379 DPRINTF( "Ret %s() retval=%08lx ret=%08lx fs=%04lx\n",
380 buffer, context->Eax, context->Eip, context->SegFs );
382 DPRINTF(" eax=%08lx ebx=%08lx ecx=%08lx edx=%08lx esi=%08lx edi=%08lx\n",
383 context->Eax, context->Ebx, context->Ecx,
384 context->Edx, context->Esi, context->Edi );
385 DPRINTF(" ebp=%08lx esp=%08lx ds=%04lx es=%04lx gs=%04lx flags=%08lx\n",
386 context->Ebp, context->Esp, context->SegDs,
387 context->SegEs, context->SegGs, context->EFlags );
389 SYSLEVEL_CheckNotLevel( 2 );
393 /***********************************************************************
396 * Setup relay debugging for a built-in dll.
398 void RELAY_SetupDLL( const char *module )
400 IMAGE_DATA_DIRECTORY *dir;
401 IMAGE_EXPORT_DIRECTORY *exports;
402 DEBUG_ENTRY_POINT *debug;
405 const char *name, *dllname;
407 dir = &PE_HEADER(module)->OptionalHeader.DataDirectory[IMAGE_FILE_EXPORT_DIRECTORY];
408 if (!dir->Size) return;
409 exports = (IMAGE_EXPORT_DIRECTORY *)(module + dir->VirtualAddress);
410 debug = (DEBUG_ENTRY_POINT *)((char *)exports + dir->Size);
411 funcs = (DWORD *)(module + exports->AddressOfFunctions);
412 dllname = module + exports->Name;
414 for (i = 0; i < exports->NumberOfFunctions; i++, funcs++, debug++)
418 if (!debug->call) continue; /* not a normal function */
420 if ((name = find_exported_name( module, exports, i + exports->Base )))
423 sprintf( buffer, "%s.%d: %s", dllname, i, name );
424 on = RELAY_ShowDebugmsgRelay(buffer);
429 debug->call = 0xe8; /* call relative */
430 if (debug->args & 0x8000) /* register func */
431 debug->callfrom32 = (char *)RELAY_CallFrom32Regs - (char *)&debug->ret;
433 debug->callfrom32 = (char *)RELAY_CallFrom32 - (char *)&debug->ret;
437 debug->call = 0xe9; /* jmp relative */
438 debug->callfrom32 = (char *)debug->orig - (char *)&debug->ret;
441 debug->orig = (FARPROC)(module + (DWORD)*funcs);
442 *funcs = (char *)debug - module;
448 void RELAY_SetupDLL( const char *module )
452 #endif /* __i386__ */