Fixed DOS environment passing.
[wine/multimedia.git] / loader / dos / module.c
blobfa880048be46abb32db34ad6083bad212872fd4f
1 /*
2 * DOS (MZ) loader
4 * Copyright 1998 Ove Kåven
6 * This code hasn't been completely cleaned up yet.
7 */
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <string.h>
12 #include <errno.h>
13 #include <fcntl.h>
14 #include <signal.h>
15 #include <unistd.h>
16 #include <sys/types.h>
17 #include <sys/stat.h>
18 #include "windows.h"
19 #include "winbase.h"
20 #include "module.h"
21 #include "task.h"
22 #include "selectors.h"
23 #include "file.h"
24 #include "ldt.h"
25 #include "process.h"
26 #include "miscemu.h"
27 #include "debug.h"
28 #include "dosexe.h"
29 #include "options.h"
31 #ifdef MZ_SUPPORTED
33 #include <sys/mman.h>
35 /* define this to try mapping through /proc/pid/mem instead of a temp file,
36 but Linus doesn't like mmapping /proc/pid/mem, so it doesn't work for me */
37 #undef MZ_MAPSELF
39 #define BIOS_DATA_SEGMENT 0x40
40 #define START_OFFSET 0
41 #define PSP_SIZE 0x10
43 #define SEG16(ptr,seg) ((LPVOID)((BYTE*)ptr+((DWORD)(seg)<<4)))
44 #define SEGPTR16(ptr,segptr) ((LPVOID)((BYTE*)ptr+((DWORD)SELECTOROF(segptr)<<4)+OFFSETOF(segptr)))
46 static void MZ_InitPSP( LPVOID lpPSP, LPCSTR cmdline, WORD env )
48 PDB*psp=lpPSP;
49 const char*cmd=cmdline?strchr(cmdline,' '):NULL;
51 psp->int20=0x20CD; /* int 20 */
52 /* some programs use this to calculate how much memory they need */
53 psp->nextParagraph=0x9FFF;
54 psp->environment=env;
55 /* copy parameters */
56 if (cmd) {
57 #if 0
58 /* command.com doesn't do this */
59 while (*cmd == ' ') cmd++;
60 #endif
61 psp->cmdLine[0]=strlen(cmd);
62 strcpy(psp->cmdLine+1,cmd);
63 psp->cmdLine[psp->cmdLine[0]+1]='\r';
64 } else psp->cmdLine[1]='\r';
65 /* FIXME: integrate the memory stuff from Wine (msdos/dosmem.c) */
66 /* FIXME: integrate the PDB stuff from Wine (loader/task.c) */
69 static char enter_xms[]={
70 /* XMS hookable entry point */
71 0xEB,0x03, /* jmp entry */
72 0x90,0x90,0x90, /* nop;nop;nop */
73 /* entry: */
74 /* real entry point */
75 /* for simplicity, we'll just use the same hook as DPMI below */
76 0xCD,0x31, /* int $0x31 */
77 0xCB /* lret */
80 static void MZ_InitXMS( LPDOSTASK lpDosTask )
82 LPBYTE start=DOSMEM_GetBlock(lpDosTask->hModule,sizeof(enter_xms),&(lpDosTask->xms_seg));
83 memcpy(start,enter_xms,sizeof(enter_xms));
86 static char enter_pm[]={
87 0x50, /* pushw %ax */
88 0x52, /* pushw %dx */
89 0x55, /* pushw %bp */
90 0x89,0xE5, /* movw %sp,%bp */
91 /* get return CS */
92 0x8B,0x56,0x08, /* movw 8(%bp),%dx */
93 /* just call int 31 here to get into protected mode... */
94 /* it'll check whether it was called from dpmi_seg... */
95 0xCD,0x31, /* int $0x31 */
96 /* we are now in the context of a 16-bit relay call */
97 /* need to fixup our stack;
98 * 16-bit relay return address will be lost, but we won't worry quite yet */
99 0x8E,0xD0, /* movw %ax,%ss */
100 0x66,0x0F,0xB7,0xE5, /* movzwl %bp,%esp */
101 /* set return CS */
102 0x89,0x56,0x08, /* movw %dx,8(%bp) */
103 0x5D, /* popw %bp */
104 0x5A, /* popw %dx */
105 0x58, /* popw %ax */
106 0xCB /* lret */
109 static char wrap_rm[]={
110 0xCD,0x31, /* int $0x31 */
111 0xCB /* lret */
114 static void MZ_InitDPMI( LPDOSTASK lpDosTask )
116 unsigned size=sizeof(enter_pm)+sizeof(wrap_rm);
117 LPBYTE start=DOSMEM_GetBlock(lpDosTask->hModule,size,&(lpDosTask->dpmi_seg));
119 lpDosTask->dpmi_sel = SELECTOR_AllocBlock( start, size, SEGMENT_CODE, FALSE, FALSE );
120 lpDosTask->wrap_ofs = size-sizeof(wrap_rm);
121 lpDosTask->call_ofs = size-1;
123 memcpy(start,enter_pm,sizeof(enter_pm));
126 static WORD MZ_InitEnvironment( LPDOSTASK lpDosTask, LPCSTR env, LPCSTR name )
128 unsigned sz=0;
129 WORD seg;
130 LPSTR envblk;
132 if (env) {
133 /* get size of environment block */
134 while (env[sz++]) sz+=strlen(env+sz)+1;
135 } else sz++;
136 /* allocate it */
137 envblk=DOSMEM_GetBlock(lpDosTask->hModule,sz+sizeof(WORD)+strlen(name)+1,&seg);
138 /* fill it */
139 if (env) {
140 memcpy(envblk,env,sz);
141 } else envblk[0]=0;
142 /* DOS 3.x: the block contains 1 additional string */
143 *(WORD*)(envblk+sz)=1;
144 /* being the program name itself */
145 strcpy(envblk+sz+sizeof(WORD),name);
146 return seg;
149 int MZ_InitMemory( LPDOSTASK lpDosTask, NE_MODULE *pModule )
151 int x;
153 if (lpDosTask->img_ofs) return 32; /* already allocated */
155 /* allocate 1MB+64K shared memory */
156 lpDosTask->img_ofs=START_OFFSET;
157 #ifdef MZ_MAPSELF
158 lpDosTask->img=VirtualAlloc(NULL,0x110000,MEM_COMMIT,PAGE_READWRITE);
159 /* make sure mmap accepts it */
160 ((char*)lpDosTask->img)[0x10FFFF]=0;
161 #else
162 tmpnam(lpDosTask->mm_name);
163 /* strcpy(lpDosTask->mm_name,"/tmp/mydosimage"); */
164 lpDosTask->mm_fd=open(lpDosTask->mm_name,O_RDWR|O_CREAT /* |O_TRUNC */,S_IRUSR|S_IWUSR);
165 if (lpDosTask->mm_fd<0) ERR(module,"file %s could not be opened\n",lpDosTask->mm_name);
166 /* expand file to 1MB+64K */
167 lseek(lpDosTask->mm_fd,0x110000-1,SEEK_SET);
168 x=0; write(lpDosTask->mm_fd,&x,1);
169 /* map it in */
170 lpDosTask->img=mmap(NULL,0x110000-START_OFFSET,PROT_READ|PROT_WRITE,MAP_SHARED,lpDosTask->mm_fd,0);
171 #endif
172 if (lpDosTask->img==(LPVOID)-1) {
173 ERR(module,"could not map shared memory, error=%s\n",strerror(errno));
174 return 0;
176 TRACE(module,"DOS VM86 image mapped at %08lx\n",(DWORD)lpDosTask->img);
177 pModule->dos_image=lpDosTask->img;
179 /* initialize the memory */
180 TRACE(module,"Initializing DOS memory structures\n");
181 DOSMEM_Init(lpDosTask->hModule);
182 MZ_InitXMS(lpDosTask);
183 MZ_InitDPMI(lpDosTask);
184 return 32;
187 static int MZ_LoadImage( HFILE16 hFile, LPCSTR name, LPCSTR cmdline,
188 LPCSTR env, LPDOSTASK lpDosTask, NE_MODULE *pModule )
190 IMAGE_DOS_HEADER mz_header;
191 DWORD image_start,image_size,min_size,max_size,avail;
192 BYTE*psp_start,*load_start;
193 int x,old_com=0;
194 SEGPTR reloc;
195 WORD env_seg;
197 if ((_hread16(hFile,&mz_header,sizeof(mz_header)) != sizeof(mz_header)) ||
198 (mz_header.e_magic != IMAGE_DOS_SIGNATURE)) {
199 #if 0
200 return 11; /* invalid exe */
201 #endif
202 old_com=1; /* assume .COM file */
203 image_start=0;
204 image_size=GetFileSize(HFILE16_TO_HFILE32(hFile),NULL);
205 min_size=0x10000; max_size=0x100000;
206 mz_header.e_crlc=0;
207 mz_header.e_ss=0; mz_header.e_sp=0xFFFE;
208 mz_header.e_cs=0; mz_header.e_ip=0x100;
209 } else {
210 /* calculate load size */
211 image_start=mz_header.e_cparhdr<<4;
212 image_size=mz_header.e_cp<<9; /* pages are 512 bytes */
213 if ((mz_header.e_cblp!=0)&&(mz_header.e_cblp!=4)) image_size-=512-mz_header.e_cblp;
214 image_size-=image_start;
215 min_size=image_size+((DWORD)mz_header.e_minalloc<<4)+(PSP_SIZE<<4);
216 max_size=image_size+((DWORD)mz_header.e_maxalloc<<4)+(PSP_SIZE<<4);
219 MZ_InitMemory(lpDosTask,pModule);
221 /* allocate environment block */
222 env_seg=MZ_InitEnvironment(lpDosTask,env,name);
224 /* allocate memory for the executable */
225 TRACE(module,"Allocating DOS memory (min=%ld, max=%ld)\n",min_size,max_size);
226 avail=DOSMEM_Available(lpDosTask->hModule);
227 if (avail<min_size) {
228 ERR(module, "insufficient DOS memory\n");
229 return 0;
231 if (avail>max_size) avail=max_size;
232 psp_start=DOSMEM_GetBlock(lpDosTask->hModule,avail,&lpDosTask->psp_seg);
233 if (!psp_start) {
234 ERR(module, "error allocating DOS memory\n");
235 return 0;
237 lpDosTask->load_seg=lpDosTask->psp_seg+(old_com?0:PSP_SIZE);
238 load_start=psp_start+(PSP_SIZE<<4);
239 MZ_InitPSP(psp_start, cmdline, env_seg);
241 /* load executable image */
242 TRACE(module,"loading DOS %s image, %08lx bytes\n",old_com?"COM":"EXE",image_size);
243 _llseek16(hFile,image_start,FILE_BEGIN);
244 if ((_hread16(hFile,load_start,image_size)) != image_size)
245 return 11; /* invalid exe */
247 if (mz_header.e_crlc) {
248 /* load relocation table */
249 TRACE(module,"loading DOS EXE relocation table, %d entries\n",mz_header.e_lfarlc);
250 /* FIXME: is this too slow without read buffering? */
251 _llseek16(hFile,mz_header.e_lfarlc,FILE_BEGIN);
252 for (x=0; x<mz_header.e_crlc; x++) {
253 if (_lread16(hFile,&reloc,sizeof(reloc)) != sizeof(reloc))
254 return 11; /* invalid exe */
255 *(WORD*)SEGPTR16(load_start,reloc)+=lpDosTask->load_seg;
259 lpDosTask->init_cs=lpDosTask->load_seg+mz_header.e_cs;
260 lpDosTask->init_ip=mz_header.e_ip;
261 lpDosTask->init_ss=lpDosTask->load_seg+mz_header.e_ss;
262 lpDosTask->init_sp=mz_header.e_sp;
264 TRACE(module,"entry point: %04x:%04x\n",lpDosTask->init_cs,lpDosTask->init_ip);
266 return 32;
269 LPDOSTASK MZ_AllocDPMITask( HMODULE16 hModule )
271 LPDOSTASK lpDosTask = calloc(1, sizeof(DOSTASK));
272 NE_MODULE *pModule;
274 if (lpDosTask) {
275 lpDosTask->hModule = hModule;
277 pModule = (NE_MODULE *)GlobalLock16(hModule);
278 pModule->lpDosTask = lpDosTask;
280 lpDosTask->img=NULL; lpDosTask->mm_name[0]=0; lpDosTask->mm_fd=-1;
282 MZ_InitMemory(lpDosTask, pModule);
284 GlobalUnlock16(hModule);
286 return lpDosTask;
289 int MZ_InitTask( LPDOSTASK lpDosTask )
291 int read_fd[2],write_fd[2];
292 pid_t child;
293 char *fname,*farg,arg[16],fproc[64],path[256],*fpath;
295 if (!lpDosTask) return 0;
296 /* create read pipe */
297 if (pipe(read_fd)<0) return 0;
298 if (pipe(write_fd)<0) {
299 close(read_fd[0]); close(read_fd[1]); return 0;
301 lpDosTask->read_pipe=read_fd[0];
302 lpDosTask->write_pipe=write_fd[1];
303 /* if we have a mapping file, use it */
304 fname=lpDosTask->mm_name; farg=NULL;
305 if (!fname[0]) {
306 /* otherwise, map our own memory image */
307 sprintf(fproc,"/proc/%d/mem",getpid());
308 sprintf(arg,"%ld",(unsigned long)lpDosTask->img);
309 fname=fproc; farg=arg;
312 TRACE(module,"Loading DOS VM support module (hmodule=%04x)\n",lpDosTask->hModule);
313 if ((child=fork())<0) {
314 close(write_fd[0]); close(write_fd[1]);
315 close(read_fd[0]); close(read_fd[1]); return 0;
317 if (child!=0) {
318 /* parent process */
319 int ret;
321 close(read_fd[1]); close(write_fd[0]);
322 lpDosTask->task=child;
323 /* wait for child process to signal readiness */
324 do {
325 if (read(lpDosTask->read_pipe,&ret,sizeof(ret))!=sizeof(ret)) {
326 if ((errno==EINTR)||(errno==EAGAIN)) continue;
327 /* failure */
328 ERR(module,"dosmod has failed to initialize\n");
329 if (lpDosTask->mm_name[0]!=0) unlink(lpDosTask->mm_name);
330 return 0;
332 } while (0);
333 /* the child has now mmaped the temp file, it's now safe to unlink.
334 * do it here to avoid leaving a mess in /tmp if/when Wine crashes... */
335 if (lpDosTask->mm_name[0]!=0) unlink(lpDosTask->mm_name);
336 /* all systems are now go */
337 } else {
338 /* child process */
339 close(read_fd[0]); close(write_fd[1]);
340 /* put our pipes somewhere dosmod can find them */
341 dup2(write_fd[0],0); /* stdin */
342 dup2(read_fd[1],1); /* stdout */
343 /* now load dosmod */
344 execlp("dosmod",fname,farg,NULL);
345 execl("dosmod",fname,farg,NULL);
346 /* hmm, they didn't install properly */
347 execl("loader/dos/dosmod",fname,farg,NULL);
348 /* last resort, try to find it through argv[0] */
349 fpath=strrchr(strcpy(path,Options.argv0),'/');
350 if (fpath) {
351 strcpy(fpath,"/loader/dos/dosmod");
352 execl(path,fname,farg,NULL);
354 /* if failure, exit */
355 ERR(module,"Failed to spawn dosmod, error=%s\n",strerror(errno));
356 exit(1);
358 return 32;
361 HINSTANCE16 MZ_CreateProcess( LPCSTR name, LPCSTR cmdline, LPCSTR env,
362 LPSTARTUPINFO32A startup, LPPROCESS_INFORMATION info )
364 LPDOSTASK lpDosTask = NULL; /* keep gcc from complaining */
365 HMODULE16 hModule;
366 HINSTANCE16 hInstance;
367 PDB32 *pdb = PROCESS_Current();
368 TDB *pTask = (TDB*)GlobalLock16( GetCurrentTask() );
369 NE_MODULE *pModule = pTask ? NE_GetPtr( pTask->hModule ) : NULL;
370 HFILE16 hFile;
371 OFSTRUCT ofs;
372 int err, alloc = !(pModule && pModule->dos_image);
374 GlobalUnlock16( GetCurrentTask() );
376 if (alloc && (lpDosTask = calloc(1, sizeof(DOSTASK))) == NULL)
377 return 0;
379 if ((hFile = OpenFile16( name, &ofs, OF_READ )) == HFILE_ERROR16)
380 return 2; /* File not found */
382 if ((!env)&&pdb) env = pdb->env_db->environ;
383 if (alloc) {
384 if ((hModule = MODULE_CreateDummyModule(&ofs)) < 32)
385 return hModule;
387 lpDosTask->hModule = hModule;
389 pModule = (NE_MODULE *)GlobalLock16(hModule);
390 pModule->lpDosTask = lpDosTask;
392 lpDosTask->img=NULL; lpDosTask->mm_name[0]=0; lpDosTask->mm_fd=-1;
393 } else lpDosTask=pModule->lpDosTask;
394 err = MZ_LoadImage( hFile, name, cmdline, env, lpDosTask, pModule );
395 _lclose16(hFile);
396 if (alloc) {
397 pModule->dos_image = lpDosTask->img;
398 if (err<32) {
399 if (lpDosTask->mm_name[0]!=0) {
400 if (lpDosTask->img!=NULL) munmap(lpDosTask->img,0x110000-START_OFFSET);
401 if (lpDosTask->mm_fd>=0) close(lpDosTask->mm_fd);
402 unlink(lpDosTask->mm_name);
403 } else
404 if (lpDosTask->img!=NULL) VirtualFree(lpDosTask->img,0x110000,MEM_RELEASE);
405 return err;
407 err = MZ_InitTask( lpDosTask );
408 if (err<32) {
409 MZ_KillModule( lpDosTask );
410 /* FIXME: cleanup hModule */
411 return err;
414 hInstance = NE_CreateInstance(pModule, NULL, (cmdline == NULL));
415 PROCESS_Create( pModule, cmdline, env, hInstance, 0, startup, info );
416 return hInstance;
417 } else {
418 return (err<32) ? err : pTask->hInstance;
422 void MZ_KillModule( LPDOSTASK lpDosTask )
424 if (lpDosTask->mm_name[0]!=0) {
425 munmap(lpDosTask->img,0x110000-START_OFFSET);
426 close(lpDosTask->mm_fd);
427 } else VirtualFree(lpDosTask->img,0x110000,MEM_RELEASE);
428 close(lpDosTask->read_pipe);
429 close(lpDosTask->write_pipe);
430 kill(lpDosTask->task,SIGTERM);
431 #if 0
432 /* FIXME: this seems to crash */
433 if (lpDosTask->dpmi_sel)
434 UnMapLS(PTR_SEG_OFF_TO_SEGPTR(lpDosTask->dpmi_sel,0));
435 #endif
438 #else /* !MZ_SUPPORTED */
440 HINSTANCE16 MZ_CreateProcess( LPCSTR name, LPCSTR cmdline, LPCSTR env,
441 LPSTARTUPINFO32A startup, LPPROCESS_INFORMATION info )
443 WARN(module,"DOS executables not supported on this architecture\n");
444 return (HMODULE16)11; /* invalid exe */
447 #endif