Do not use the PEB lock as loader lock, use a separate critical
[wine] / dlls / winedos / module.c
1 /*
2  * DOS (MZ) loader
3  *
4  * Copyright 1998 Ove Kåven
5  *
6  * This code hasn't been completely cleaned up yet.
7  */
8
9 #include "config.h"
10
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <string.h>
14 #include <errno.h>
15 #include <fcntl.h>
16 #include <signal.h>
17 #include <unistd.h>
18 #include <sys/types.h>
19 #include <sys/stat.h>
20 #include <sys/time.h>
21 #include "windef.h"
22 #include "wine/winbase16.h"
23 #include "wingdi.h"
24 #include "winuser.h"
25 #include "winerror.h"
26 #include "module.h"
27 #include "task.h"
28 #include "file.h"
29 #include "miscemu.h"
30 #include "debugtools.h"
31 #include "dosexe.h"
32 #include "dosvm.h"
33 #include "options.h"
34 #include "vga.h"
35
36 DEFAULT_DEBUG_CHANNEL(module);
37
38 #ifdef MZ_SUPPORTED
39
40 #ifdef HAVE_SYS_MMAN_H
41 # include <sys/mman.h>
42 #endif
43
44 /* define this to try mapping through /proc/pid/mem instead of a temp file,
45    but Linus doesn't like mmapping /proc/pid/mem, so it doesn't work for me */
46 #undef MZ_MAPSELF
47
48 #define BIOS_DATA_SEGMENT 0x40
49 #define PSP_SIZE 0x10
50
51 #define SEG16(ptr,seg) ((LPVOID)((BYTE*)ptr+((DWORD)(seg)<<4)))
52 #define SEGPTR16(ptr,segptr) ((LPVOID)((BYTE*)ptr+((DWORD)SELECTOROF(segptr)<<4)+OFFSETOF(segptr)))
53
54 /* structures for EXEC */
55
56 typedef struct {
57   WORD env_seg;
58   DWORD cmdline WINE_PACKED;
59   DWORD fcb1 WINE_PACKED;
60   DWORD fcb2 WINE_PACKED;
61   WORD init_sp;
62   WORD init_ss;
63   WORD init_ip;
64   WORD init_cs;
65 } ExecBlock;
66
67 typedef struct {
68   WORD load_seg;
69   WORD rel_seg;
70 } OverlayBlock;
71
72 /* global variables */
73
74 pid_t dosvm_pid;
75
76 static WORD init_cs,init_ip,init_ss,init_sp;
77 static HANDLE dosvm_thread, loop_thread;
78 static DWORD dosvm_tid, loop_tid;
79
80 static void MZ_Launch(void);
81 static BOOL MZ_InitTask(void);
82 static void MZ_KillTask(void);
83
84 static void MZ_CreatePSP( LPVOID lpPSP, WORD env, WORD par )
85 {
86   PDB16*psp=lpPSP;
87
88   psp->int20=0x20CD; /* int 20 */
89   /* some programs use this to calculate how much memory they need */
90   psp->nextParagraph=0x9FFF; /* FIXME: use a real value */
91   /* FIXME: dispatcher */
92   psp->savedint22 = DOSVM_GetRMHandler(0x22);
93   psp->savedint23 = DOSVM_GetRMHandler(0x23);
94   psp->savedint24 = DOSVM_GetRMHandler(0x24);
95   psp->parentPSP=par;
96   psp->environment=env;
97   /* FIXME: more PSP stuff */
98 }
99
100 static void MZ_FillPSP( LPVOID lpPSP, LPCSTR cmdline )
101 {
102  PDB16*psp=lpPSP;
103  const char*cmd=cmdline?strchr(cmdline,' '):NULL;
104
105  /* copy parameters */
106  if (cmd) {
107 #if 0
108   /* command.com doesn't do this */
109   while (*cmd == ' ') cmd++;
110 #endif
111   psp->cmdLine[0]=strlen(cmd);
112   strcpy(psp->cmdLine+1,cmd);
113   psp->cmdLine[psp->cmdLine[0]+1]='\r';
114  } else psp->cmdLine[1]='\r';
115  /* FIXME: more PSP stuff */
116 }
117
118 /* default INT 08 handler: increases timer tick counter but not much more */
119 static char int08[]={
120  0xCD,0x1C,           /* int $0x1c */
121  0x50,                /* pushw %ax */
122  0x1E,                /* pushw %ds */
123  0xB8,0x40,0x00,      /* movw $0x40,%ax */
124  0x8E,0xD8,           /* movw %ax,%ds */
125 #if 0
126  0x83,0x06,0x6C,0x00,0x01, /* addw $1,(0x6c) */
127  0x83,0x16,0x6E,0x00,0x00, /* adcw $0,(0x6e) */
128 #else
129  0x66,0xFF,0x06,0x6C,0x00, /* incl (0x6c) */
130 #endif
131  0xB0,0x20,           /* movb $0x20,%al */
132  0xE6,0x20,           /* outb %al,$0x20 */
133  0x1F,                /* popw %ax */
134  0x58,                /* popw %ax */
135  0xCF                 /* iret */
136 };
137
138 static void MZ_InitHandlers(void)
139 {
140  WORD seg;
141  LPBYTE start=DOSMEM_GetBlock(sizeof(int08),&seg);
142  memcpy(start,int08,sizeof(int08));
143 /* INT 08: point it at our tick-incrementing handler */
144  ((SEGPTR*)0)[0x08]=MAKESEGPTR(seg,0);
145 /* INT 1C: just point it to IRET, we don't want to handle it ourselves */
146  ((SEGPTR*)0)[0x1C]=MAKESEGPTR(seg,sizeof(int08)-1);
147 }
148
149 static WORD MZ_InitEnvironment( LPCSTR env, LPCSTR name )
150 {
151  unsigned sz=0;
152  WORD seg;
153  LPSTR envblk;
154
155  if (env) {
156   /* get size of environment block */
157   while (env[sz++]) sz+=strlen(env+sz)+1;
158  } else sz++;
159  /* allocate it */
160  envblk=DOSMEM_GetBlock(sz+sizeof(WORD)+strlen(name)+1,&seg);
161  /* fill it */
162  if (env) {
163   memcpy(envblk,env,sz);
164  } else envblk[0]=0;
165  /* DOS 3.x: the block contains 1 additional string */
166  *(WORD*)(envblk+sz)=1;
167  /* being the program name itself */
168  strcpy(envblk+sz+sizeof(WORD),name);
169  return seg;
170 }
171
172 static BOOL MZ_InitMemory(void)
173 {
174     /* initialize the memory */
175     TRACE("Initializing DOS memory structures\n");
176     DOSMEM_Init(TRUE);
177
178     MZ_InitHandlers();
179     return TRUE;
180 }
181
182 static BOOL MZ_DoLoadImage( HANDLE hFile, LPCSTR filename, OverlayBlock *oblk )
183 {
184   IMAGE_DOS_HEADER mz_header;
185   DWORD image_start,image_size,min_size,max_size,avail;
186   BYTE*psp_start,*load_start,*oldenv;
187   int x, old_com=0, alloc;
188   SEGPTR reloc;
189   WORD env_seg, load_seg, rel_seg, oldpsp_seg;
190   DWORD len;
191
192   if (DOSVM_psp) {
193     /* DOS process already running, inherit from it */
194     PDB16* par_psp = (PDB16*)((DWORD)DOSVM_psp << 4);
195     alloc=0;
196     oldenv = (LPBYTE)((DWORD)par_psp->environment << 4);
197     oldpsp_seg = DOSVM_psp;
198   } else {
199     /* allocate new DOS process, inheriting from Wine environment */
200     alloc=1;
201     oldenv = GetEnvironmentStringsA();
202     oldpsp_seg = 0;
203   }
204
205  SetFilePointer(hFile,0,NULL,FILE_BEGIN);
206  if (   !ReadFile(hFile,&mz_header,sizeof(mz_header),&len,NULL)
207      || len != sizeof(mz_header) 
208      || mz_header.e_magic != IMAGE_DOS_SIGNATURE) {
209   char *p = strrchr( filename, '.' );
210   if (!p || strcasecmp( p, ".com" ))  /* check for .COM extension */
211   {
212       SetLastError(ERROR_BAD_FORMAT);
213       goto load_error;
214   }
215   old_com=1; /* assume .COM file */
216   image_start=0;
217   image_size=GetFileSize(hFile,NULL);
218   min_size=0x10000; max_size=0x100000;
219   mz_header.e_crlc=0;
220   mz_header.e_ss=0; mz_header.e_sp=0xFFFE;
221   mz_header.e_cs=0; mz_header.e_ip=0x100;
222  } else {
223   /* calculate load size */
224   image_start=mz_header.e_cparhdr<<4;
225   image_size=mz_header.e_cp<<9; /* pages are 512 bytes */
226   if ((mz_header.e_cblp!=0)&&(mz_header.e_cblp!=4)) image_size-=512-mz_header.e_cblp;
227   image_size-=image_start;
228   min_size=image_size+((DWORD)mz_header.e_minalloc<<4)+(PSP_SIZE<<4);
229   max_size=image_size+((DWORD)mz_header.e_maxalloc<<4)+(PSP_SIZE<<4);
230  }
231
232   if (alloc) MZ_InitMemory();
233
234   if (oblk) {
235     /* load overlay into preallocated memory */
236     load_seg=oblk->load_seg;
237     rel_seg=oblk->rel_seg;
238     load_start=(LPBYTE)((DWORD)load_seg<<4);
239   } else {
240     /* allocate environment block */
241     env_seg=MZ_InitEnvironment(oldenv, filename);
242
243     /* allocate memory for the executable */
244     TRACE("Allocating DOS memory (min=%ld, max=%ld)\n",min_size,max_size);
245     avail=DOSMEM_Available();
246     if (avail<min_size) {
247       ERR("insufficient DOS memory\n");
248       SetLastError(ERROR_NOT_ENOUGH_MEMORY);
249       goto load_error;
250     }
251     if (avail>max_size) avail=max_size;
252     psp_start=DOSMEM_GetBlock(avail,&DOSVM_psp);
253     if (!psp_start) {
254       ERR("error allocating DOS memory\n");
255       SetLastError(ERROR_NOT_ENOUGH_MEMORY);
256       goto load_error;
257     }
258     load_seg=DOSVM_psp+(old_com?0:PSP_SIZE);
259     rel_seg=load_seg;
260     load_start=psp_start+(PSP_SIZE<<4);
261     MZ_CreatePSP(psp_start, env_seg, oldpsp_seg);
262   }
263
264  /* load executable image */
265  TRACE("loading DOS %s image, %08lx bytes\n",old_com?"COM":"EXE",image_size);
266  SetFilePointer(hFile,image_start,NULL,FILE_BEGIN);
267  if (!ReadFile(hFile,load_start,image_size,&len,NULL) || len != image_size) {
268   SetLastError(ERROR_BAD_FORMAT);
269   goto load_error;
270  }
271
272  if (mz_header.e_crlc) {
273   /* load relocation table */
274   TRACE("loading DOS EXE relocation table, %d entries\n",mz_header.e_crlc);
275   /* FIXME: is this too slow without read buffering? */
276   SetFilePointer(hFile,mz_header.e_lfarlc,NULL,FILE_BEGIN);
277   for (x=0; x<mz_header.e_crlc; x++) {
278    if (!ReadFile(hFile,&reloc,sizeof(reloc),&len,NULL) || len != sizeof(reloc)) {
279     SetLastError(ERROR_BAD_FORMAT);
280     goto load_error;
281    }
282    *(WORD*)SEGPTR16(load_start,reloc)+=rel_seg;
283   }
284  }
285
286   if (!oblk) {
287     init_cs = load_seg+mz_header.e_cs;
288     init_ip = mz_header.e_ip;
289     init_ss = load_seg+mz_header.e_ss;
290     init_sp = mz_header.e_sp;
291
292     TRACE("entry point: %04x:%04x\n",init_cs,init_ip);
293   }
294
295   if (alloc && !MZ_InitTask()) {
296     SetLastError(ERROR_GEN_FAILURE);
297     return FALSE;
298   }
299
300   return TRUE;
301
302 load_error:
303   DOSVM_psp = oldpsp_seg;
304
305   return FALSE;
306 }
307
308 /***********************************************************************
309  *              LoadDosExe (WINEDOS.@)
310  */
311 void WINAPI MZ_LoadImage( LPCSTR filename, HANDLE hFile )
312 {
313   if (MZ_DoLoadImage( hFile, filename, NULL )) MZ_Launch();
314 }
315
316 /***********************************************************************
317  *              MZ_Exec
318  */
319 BOOL WINAPI MZ_Exec( CONTEXT86 *context, LPCSTR filename, BYTE func, LPVOID paramblk )
320 {
321   /* this may only be called from existing DOS processes
322    * (i.e. one DOS app spawning another) */
323   /* FIXME: do we want to check binary type first, to check
324    * whether it's a NE/PE executable? */
325   HFILE hFile = CreateFileA( filename, GENERIC_READ, FILE_SHARE_READ,
326                              NULL, OPEN_EXISTING, 0, 0);
327   BOOL ret = FALSE;
328   if (hFile == INVALID_HANDLE_VALUE) return FALSE;
329   switch (func) {
330   case 0: /* load and execute */
331   case 1: /* load but don't execute */
332     {
333       /* save current process's return SS:SP now */
334       LPBYTE psp_start = (LPBYTE)((DWORD)DOSVM_psp << 4);
335       PDB16 *psp = (PDB16 *)psp_start;
336       psp->saveStack = (DWORD)MAKESEGPTR(context->SegSs, LOWORD(context->Esp));
337     }
338     ret = MZ_DoLoadImage( hFile, filename, NULL );
339     if (ret) {
340       /* MZ_LoadImage created a new PSP and loaded new values into it,
341        * let's work on the new values now */
342       LPBYTE psp_start = (LPBYTE)((DWORD)DOSVM_psp << 4);
343       ExecBlock *blk = (ExecBlock *)paramblk;
344       MZ_FillPSP(psp_start, DOSMEM_MapRealToLinear(blk->cmdline));
345       /* the lame MS-DOS engineers decided that the return address should be in int22 */
346       DOSVM_SetRMHandler(0x22, (FARPROC16)MAKESEGPTR(context->SegCs, LOWORD(context->Eip)));
347       if (func) {
348         /* don't execute, just return startup state */
349         blk->init_cs = init_cs;
350         blk->init_ip = init_ip;
351         blk->init_ss = init_ss;
352         blk->init_sp = init_sp;
353       } else {
354         /* execute by making us return to new process */
355         context->SegCs = init_cs;
356         context->Eip   = init_ip;
357         context->SegSs = init_ss;
358         context->Esp   = init_sp;
359         context->SegDs = DOSVM_psp;
360         context->SegEs = DOSVM_psp;
361         context->Eax   = 0;
362       }
363     }
364     break;
365   case 3: /* load overlay */
366     {
367       OverlayBlock *blk = (OverlayBlock *)paramblk;
368       ret = MZ_DoLoadImage( hFile, filename, blk );
369     }
370     break;
371   default:
372     FIXME("EXEC load type %d not implemented\n", func);
373     SetLastError(ERROR_INVALID_FUNCTION);
374     break;
375   }
376   CloseHandle(hFile);
377   return ret;
378 }
379
380 /***********************************************************************
381  *              MZ_AllocDPMITask
382  */
383 void WINAPI MZ_AllocDPMITask( void )
384 {
385   MZ_InitMemory();
386   MZ_InitTask();
387 }
388
389 /***********************************************************************
390  *              MZ_RunInThread
391  */
392 void WINAPI MZ_RunInThread( PAPCFUNC proc, ULONG_PTR arg )
393 {
394   if (loop_thread) {
395     DOS_SPC spc;
396     HANDLE event;
397
398     spc.proc = proc;
399     spc.arg = arg;
400     event = CreateEventA(NULL, TRUE, FALSE, NULL);
401     PostThreadMessageA(loop_tid, WM_USER, event, (LPARAM)&spc);
402     WaitForSingleObject(event, INFINITE);
403     CloseHandle(event);
404   } else
405     proc(arg);
406 }
407
408 static DWORD WINAPI MZ_DOSVM( LPVOID lpExtra )
409 {
410   CONTEXT context;
411   DWORD ret;
412
413   dosvm_pid = getpid();
414
415   memset( &context, 0, sizeof(context) );
416   context.SegCs  = init_cs;
417   context.Eip    = init_ip;
418   context.SegSs  = init_ss;
419   context.Esp    = init_sp;
420   context.SegDs  = DOSVM_psp;
421   context.SegEs  = DOSVM_psp;
422   context.EFlags = 0x00080000;  /* virtual interrupt flag */
423   DOSVM_SetTimer(0x10000);
424   ret = DOSVM_Enter( &context );
425
426   dosvm_pid = 0;
427   return ret;
428 }
429
430 static BOOL MZ_InitTask(void)
431 {
432   if (!DuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
433                        GetCurrentProcess(), &loop_thread,
434                        0, FALSE, DUPLICATE_SAME_ACCESS))
435     return FALSE;
436   dosvm_thread = CreateThread(NULL, 0, MZ_DOSVM, NULL, CREATE_SUSPENDED, &dosvm_tid);
437   if (!dosvm_thread) {
438     CloseHandle(loop_thread);
439     loop_thread = 0;
440     return FALSE;
441   }
442   loop_tid = GetCurrentThreadId();
443   return TRUE;
444 }
445
446 static void MZ_Launch(void)
447 {
448   TDB *pTask = TASK_GetCurrent();
449   BYTE *psp_start = PTR_REAL_TO_LIN( DOSVM_psp, 0 );
450
451   MZ_FillPSP(psp_start, GetCommandLineA());
452   pTask->flags |= TDBF_WINOLDAP;
453
454   _LeaveWin16Lock();
455   
456   ResumeThread(dosvm_thread);
457   DOSVM_Loop(NULL);
458   ExitThread(0);
459 }
460
461 static void MZ_KillTask(void)
462 {
463   TRACE("killing DOS task\n");
464   VGA_Clean();
465   PostThreadMessageA(loop_tid, WM_QUIT, 0, 0);
466   WaitForSingleObject(loop_thread, INFINITE); /* ? */
467   CloseHandle(dosvm_thread);
468   dosvm_thread = 0; dosvm_tid = 0;
469   CloseHandle(loop_thread);
470   loop_thread = 0; loop_tid = 0;
471 }
472
473 /***********************************************************************
474  *              MZ_Exit
475  */
476 void WINAPI MZ_Exit( CONTEXT86 *context, BOOL cs_psp, WORD retval )
477 {
478   if (DOSVM_psp) {
479     WORD psp_seg = cs_psp ? context->SegCs : DOSVM_psp;
480     LPBYTE psp_start = (LPBYTE)((DWORD)psp_seg << 4);
481     PDB16 *psp = (PDB16 *)psp_start;
482     WORD parpsp = psp->parentPSP; /* check for parent DOS process */
483     if (parpsp) {
484       /* retrieve parent's return address */
485       FARPROC16 retaddr = DOSVM_GetRMHandler(0x22);
486       /* restore interrupts */
487       DOSVM_SetRMHandler(0x22, psp->savedint22);
488       DOSVM_SetRMHandler(0x23, psp->savedint23);
489       DOSVM_SetRMHandler(0x24, psp->savedint24);
490       /* FIXME: deallocate file handles etc */
491       /* free process's associated memory
492        * FIXME: walk memory and deallocate all blocks owned by process */
493       DOSMEM_FreeBlock(DOSMEM_MapRealToLinear(MAKELONG(0,psp->environment)));
494       DOSMEM_FreeBlock(DOSMEM_MapRealToLinear(MAKELONG(0,DOSVM_psp)));
495       /* switch to parent's PSP */
496       DOSVM_psp = parpsp;
497       psp_start = (LPBYTE)((DWORD)parpsp << 4);
498       psp = (PDB16 *)psp_start;
499       /* now return to parent */
500       DOSVM_retval = retval;
501       context->SegCs = SELECTOROF(retaddr);
502       context->Eip   = OFFSETOF(retaddr);
503       context->SegSs = SELECTOROF(psp->saveStack);
504       context->Esp   = OFFSETOF(psp->saveStack);
505       return;
506     } else
507       MZ_KillTask();
508   }
509   ExitThread( retval );
510 }
511
512
513 /***********************************************************************
514  *              MZ_Current
515  */
516 BOOL WINAPI MZ_Current( void )
517 {
518   return (dosvm_pid != 0); /* FIXME: do a better check */
519 }
520
521 #else /* !MZ_SUPPORTED */
522
523 /***********************************************************************
524  *              LoadDosExe (WINEDOS.@)
525  */
526 void WINAPI MZ_LoadImage( LPCSTR filename, HANDLE hFile )
527 {
528   WARN("DOS executables not supported on this platform\n");
529   SetLastError(ERROR_BAD_FORMAT);
530 }
531
532 /***********************************************************************
533  *              MZ_Exec
534  */
535 BOOL WINAPI MZ_Exec( CONTEXT86 *context, LPCSTR filename, BYTE func, LPVOID paramblk )
536 {
537   /* can't happen */
538   SetLastError(ERROR_BAD_FORMAT);
539   return FALSE;
540 }
541
542 /***********************************************************************
543  *              MZ_AllocDPMITask
544  */
545 void WINAPI MZ_AllocDPMITask( void )
546 {
547     ERR("Actual real-mode calls not supported on this platform!\n");
548 }
549
550 /***********************************************************************
551  *              MZ_Exit
552  */
553 void WINAPI MZ_Exit( CONTEXT86 *context, BOOL cs_psp, WORD retval )
554 {
555   ExitThread( retval );
556 }
557
558 /***********************************************************************
559  *              MZ_Current
560  */
561 BOOL WINAPI MZ_Current( void )
562 {
563     return FALSE;
564 }
565
566 #endif /* !MZ_SUPPORTED */