New debug scheme with explicit debug channels declaration.
[wine] / if1632 / builtin.c
1 /*
2  * Built-in modules
3  *
4  * Copyright 1996 Alexandre Julliard
5  */
6
7 #include <assert.h>
8 #include <ctype.h>
9 #include <string.h>
10 #include "winbase.h"
11 #include "wine/winbase16.h"
12 #include "wine/winestring.h"
13 #include "builtin32.h"
14 #include "global.h"
15 #include "heap.h"
16 #include "module.h"
17 #include "miscemu.h"
18 #include "neexe.h"
19 #include "stackframe.h"
20 #include "user.h"
21 #include "process.h"
22 #include "snoop.h"
23 #include "task.h"
24 #include "debug.h"
25
26 DEFAULT_DEBUG_CHANNEL(module)
27
28 /* Built-in modules descriptors */
29 /* Don't change these structures! (see tools/build.c) */
30
31 typedef struct
32 {
33     const char *name;              /* DLL name */
34     void       *module_start;      /* 32-bit address of the module data */
35     int         module_size;       /* Size of the module data */
36     const BYTE *code_start;        /* 32-bit address of DLL code */
37     const BYTE *data_start;        /* 32-bit address of DLL data */
38 } WIN16_DESCRIPTOR;
39
40 typedef struct
41 {
42     const WIN16_DESCRIPTOR *descr;     /* DLL descriptor */
43     int                     flags;     /* flags (see below) */
44 } BUILTIN16_DLL;
45
46 /* DLL flags */
47 #define DLL_FLAG_NOT_USED    0x01  /* Use original Windows DLL if possible */
48 #define DLL_FLAG_ALWAYS_USED 0x02  /* Always use built-in DLL */
49
50 /* 16-bit DLLs */
51
52 extern const WIN16_DESCRIPTOR AVIFILE_Descriptor;
53 extern const WIN16_DESCRIPTOR COMM_Descriptor;
54 extern const WIN16_DESCRIPTOR COMMDLG_Descriptor;
55 extern const WIN16_DESCRIPTOR COMPOBJ_Descriptor;
56 extern const WIN16_DESCRIPTOR DDEML_Descriptor;
57 extern const WIN16_DESCRIPTOR DISPDIB_Descriptor;
58 extern const WIN16_DESCRIPTOR DISPLAY_Descriptor;
59 extern const WIN16_DESCRIPTOR GDI_Descriptor;
60 extern const WIN16_DESCRIPTOR KERNEL_Descriptor;
61 extern const WIN16_DESCRIPTOR KEYBOARD_Descriptor;
62 extern const WIN16_DESCRIPTOR LZEXPAND_Descriptor;
63 extern const WIN16_DESCRIPTOR MMSYSTEM_Descriptor;
64 extern const WIN16_DESCRIPTOR MOUSE_Descriptor;
65 extern const WIN16_DESCRIPTOR MSACM_Descriptor;
66 extern const WIN16_DESCRIPTOR MSVIDEO_Descriptor;
67 extern const WIN16_DESCRIPTOR OLE2CONV_Descriptor;
68 extern const WIN16_DESCRIPTOR OLE2DISP_Descriptor;
69 extern const WIN16_DESCRIPTOR OLE2NLS_Descriptor;
70 extern const WIN16_DESCRIPTOR OLE2PROX_Descriptor;
71 extern const WIN16_DESCRIPTOR OLE2THK_Descriptor;
72 extern const WIN16_DESCRIPTOR OLE2_Descriptor;
73 extern const WIN16_DESCRIPTOR OLECLI_Descriptor;
74 extern const WIN16_DESCRIPTOR OLESVR_Descriptor;
75 extern const WIN16_DESCRIPTOR RASAPI16_Descriptor;
76 extern const WIN16_DESCRIPTOR SHELL_Descriptor;
77 extern const WIN16_DESCRIPTOR SOUND_Descriptor;
78 extern const WIN16_DESCRIPTOR STORAGE_Descriptor;
79 extern const WIN16_DESCRIPTOR STRESS_Descriptor;
80 extern const WIN16_DESCRIPTOR SYSTEM_Descriptor;
81 extern const WIN16_DESCRIPTOR TOOLHELP_Descriptor;
82 extern const WIN16_DESCRIPTOR TYPELIB_Descriptor;
83 extern const WIN16_DESCRIPTOR USER_Descriptor;
84 extern const WIN16_DESCRIPTOR VER_Descriptor;
85 extern const WIN16_DESCRIPTOR W32SYS_Descriptor;
86 extern const WIN16_DESCRIPTOR WIN32S16_Descriptor;
87 extern const WIN16_DESCRIPTOR WIN87EM_Descriptor;
88 extern const WIN16_DESCRIPTOR WINASPI_Descriptor;
89 extern const WIN16_DESCRIPTOR WINDEBUG_Descriptor;
90 extern const WIN16_DESCRIPTOR WINEPS_Descriptor;
91 extern const WIN16_DESCRIPTOR WING_Descriptor;
92 extern const WIN16_DESCRIPTOR WINSOCK_Descriptor;
93 extern const WIN16_DESCRIPTOR WPROCS_Descriptor;
94
95 /* Table of all built-in DLLs */
96
97 static BUILTIN16_DLL BuiltinDLLs[] =
98 {
99     { &KERNEL_Descriptor,   0 },
100     { &USER_Descriptor,     0 },
101     { &GDI_Descriptor,      0 },
102     { &SYSTEM_Descriptor,   DLL_FLAG_ALWAYS_USED },
103     { &DISPLAY_Descriptor,  DLL_FLAG_ALWAYS_USED },
104     { &WPROCS_Descriptor,   DLL_FLAG_ALWAYS_USED },
105     { &WINDEBUG_Descriptor, DLL_FLAG_NOT_USED },
106     { &AVIFILE_Descriptor,  DLL_FLAG_NOT_USED },
107     { &COMMDLG_Descriptor,  DLL_FLAG_NOT_USED },
108     { &COMPOBJ_Descriptor,  DLL_FLAG_NOT_USED },
109     { &DDEML_Descriptor,    DLL_FLAG_NOT_USED },
110     { &DISPDIB_Descriptor,  0 },
111     { &KEYBOARD_Descriptor, 0 },
112     { &COMM_Descriptor,     0 },
113     { &LZEXPAND_Descriptor, 0 },
114     { &MMSYSTEM_Descriptor, 0 },
115     { &MOUSE_Descriptor,    0 },
116     { &MSACM_Descriptor,    0 },
117     { &MSVIDEO_Descriptor,  0 },
118     { &OLE2CONV_Descriptor, DLL_FLAG_NOT_USED },
119     { &OLE2DISP_Descriptor, DLL_FLAG_NOT_USED },
120     { &OLE2NLS_Descriptor,  DLL_FLAG_NOT_USED },
121     { &OLE2PROX_Descriptor, DLL_FLAG_NOT_USED },
122     { &OLE2THK_Descriptor,  DLL_FLAG_NOT_USED },
123     { &OLE2_Descriptor,     DLL_FLAG_NOT_USED },
124     { &OLECLI_Descriptor,   DLL_FLAG_NOT_USED },
125     { &OLESVR_Descriptor,   DLL_FLAG_NOT_USED },
126     { &RASAPI16_Descriptor, 0 },
127     { &SHELL_Descriptor,    0 },
128     { &SOUND_Descriptor,    0 },
129     { &STORAGE_Descriptor,  DLL_FLAG_NOT_USED },
130     { &STRESS_Descriptor,   0 },
131     { &TOOLHELP_Descriptor, 0 },
132     { &TYPELIB_Descriptor,  DLL_FLAG_NOT_USED },
133     { &VER_Descriptor,      0 },
134     { &W32SYS_Descriptor,   DLL_FLAG_NOT_USED },
135     { &WIN32S16_Descriptor, DLL_FLAG_NOT_USED },
136     { &WIN87EM_Descriptor,  DLL_FLAG_NOT_USED },
137     { &WINASPI_Descriptor,  0 },
138     { &WINEPS_Descriptor,   DLL_FLAG_ALWAYS_USED },
139     { &WING_Descriptor,     0 },
140     { &WINSOCK_Descriptor,  0 },
141     /* Last entry */
142     { NULL, 0 }
143 };
144
145   /* Ordinal number for interrupt 0 handler in WPROCS.DLL */
146 #define FIRST_INTERRUPT_ORDINAL 100
147
148
149 /***********************************************************************
150  *           BUILTIN_DoLoadModule16
151  *
152  * Load a built-in Win16 module. Helper function for BUILTIN_LoadModule
153  * and BUILTIN_Init.
154  */
155 static HMODULE16 BUILTIN_DoLoadModule16( const WIN16_DESCRIPTOR *descr )
156 {
157     NE_MODULE *pModule;
158     int minsize;
159     SEGTABLEENTRY *pSegTable;
160
161     HMODULE16 hModule = GLOBAL_CreateBlock( GMEM_MOVEABLE, descr->module_start,
162                                             descr->module_size, 0,
163                                             FALSE, FALSE, FALSE, NULL );
164     if (!hModule) return 0;
165     FarSetOwner16( hModule, hModule );
166
167     TRACE(module, "Built-in %s: hmodule=%04x\n",
168                     descr->name, hModule );
169     pModule = (NE_MODULE *)GlobalLock16( hModule );
170     pModule->self = hModule;
171
172     /* Allocate the code segment */
173
174     pSegTable = NE_SEG_TABLE( pModule );
175     pSegTable->hSeg = GLOBAL_CreateBlock( GMEM_FIXED, descr->code_start,
176                                               pSegTable->minsize, hModule,
177                                               TRUE, TRUE, FALSE, NULL );
178     if (!pSegTable->hSeg) return 0;
179     pSegTable++;
180
181     /* Allocate the data segment */
182
183     minsize = pSegTable->minsize ? pSegTable->minsize : 0x10000;
184     minsize += pModule->heap_size;
185     if (minsize > 0x10000) minsize = 0x10000;
186     pSegTable->hSeg = GLOBAL_Alloc( GMEM_FIXED, minsize,
187                                         hModule, FALSE, FALSE, FALSE );
188     if (!pSegTable->hSeg) return 0;
189     if (pSegTable->minsize) memcpy( GlobalLock16( pSegTable->hSeg ),
190                                     descr->data_start, pSegTable->minsize);
191     if (pModule->heap_size)
192         LocalInit16( GlobalHandleToSel16(pSegTable->hSeg),
193                 pSegTable->minsize, minsize );
194
195     NE_RegisterModule( pModule );
196     return hModule;
197 }
198
199
200 /***********************************************************************
201  *           BUILTIN_Init
202  *
203  * Load all built-in modules marked as 'always used'.
204  */
205 BOOL BUILTIN_Init(void)
206 {
207     BUILTIN16_DLL *dll;
208     WORD vector;
209     HMODULE16 hModule;
210
211     fnBUILTIN_LoadModule = BUILTIN_LoadModule;
212
213     for (dll = BuiltinDLLs; dll->descr; dll++)
214     {
215         if (dll->flags & DLL_FLAG_ALWAYS_USED)
216             if (!BUILTIN_DoLoadModule16( dll->descr )) return FALSE;
217     }
218
219     /* Set interrupt vectors from entry points in WPROCS.DLL */
220
221     hModule = GetModuleHandle16( "WPROCS" );
222     for (vector = 0; vector < 256; vector++)
223     {
224         FARPROC16 proc = NE_GetEntryPoint( hModule,
225                                            FIRST_INTERRUPT_ORDINAL + vector );
226         assert(proc);
227         INT_SetPMHandler( vector, proc );
228     }
229
230     SNOOP16_Init();
231
232     return TRUE;
233 }
234
235
236 /***********************************************************************
237  *           BUILTIN_LoadModule
238  *
239  * Load a built-in module. If the 'force' parameter is FALSE, we only
240  * load the module if it has not been disabled via the -dll option.
241  */
242 HMODULE16 BUILTIN_LoadModule( LPCSTR name, BOOL force )
243 {
244     BUILTIN16_DLL *table;
245     char dllname[16], *p;
246
247     /* Fix the name in case we have a full path and extension */
248
249     if ((p = strrchr( name, '\\' ))) name = p + 1;
250     lstrcpynA( dllname, name, sizeof(dllname) );
251     if ((p = strrchr( dllname, '.' ))) *p = '\0';
252
253     for (table = BuiltinDLLs; table->descr; table++)
254         if (!lstrcmpiA( table->descr->name, dllname )) break;
255     if (!table->descr) return 0;
256     if ((table->flags & DLL_FLAG_NOT_USED) && !force) return 0;
257
258     return BUILTIN_DoLoadModule16( table->descr );
259 }
260
261
262 /***********************************************************************
263  *           BUILTIN_GetEntryPoint16
264  *
265  * Return the ordinal and name corresponding to a CS:IP address.
266  * This is used only by relay debugging.
267  */
268 LPCSTR BUILTIN_GetEntryPoint16( WORD cs, WORD ip, WORD *pOrd )
269 {
270     static char buffer[80];
271     WORD i, max_offset;
272     register BYTE *p;
273     NE_MODULE *pModule;
274     ET_BUNDLE *bundle;
275     ET_ENTRY *entry;
276
277     if (!(pModule = NE_GetPtr( FarGetOwner16( GlobalHandle16(cs) ))))
278         return NULL;
279
280     max_offset = 0;
281     *pOrd = 0;
282     bundle = (ET_BUNDLE *)((BYTE *)pModule + pModule->entry_table);
283     entry = (ET_ENTRY *)((BYTE *)bundle+6);
284     do {
285         for (i = bundle->first + 1; i < bundle->last; i++)
286             {
287             if ((entry->offs <= ip)
288             && (entry->type == 1) /* code segment ? */
289             && (entry->offs >= max_offset))
290                 {
291                 max_offset = entry->offs;
292                 *pOrd = i;
293         }
294             entry++;
295     }
296     } while ( (bundle->next)
297            && (bundle = (ET_BUNDLE *)((BYTE *)pModule+bundle->next)));
298
299     /* Search for the name in the resident names table */
300     /* (built-in modules have no non-resident table)   */
301     
302     p = (BYTE *)pModule + pModule->name_table;
303     while (*p)
304     {
305         p += *p + 1 + sizeof(WORD);
306         if (*(WORD *)(p + *p + 1) == *pOrd) break;
307     }
308
309     sprintf( buffer, "%.*s.%d: %.*s",
310              *((BYTE *)pModule + pModule->name_table),
311              (char *)pModule + pModule->name_table + 1,
312              *pOrd, *p, (char *)(p + 1) );
313     return buffer;
314 }
315
316
317 /**********************************************************************
318  *          BUILTIN_DefaultIntHandler
319  *
320  * Default interrupt handler.
321  */
322 void BUILTIN_DefaultIntHandler( CONTEXT *context )
323 {
324     WORD ordinal;
325     STACK16FRAME *frame = CURRENT_STACK16;
326     BUILTIN_GetEntryPoint16( frame->entry_cs, frame->entry_ip, &ordinal );
327     INT_BARF( context, ordinal - FIRST_INTERRUPT_ORDINAL );
328 }
329