4 * Copyright 1998 Ove Kåven
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Note: This code hasn't been completely cleaned up yet.
24 #include "wine/port.h"
35 #include <sys/types.h>
36 #ifdef HAVE_SYS_STAT_H
37 # include <sys/stat.h>
39 #ifdef HAVE_SYS_TIME_H
40 # include <sys/time.h>
44 #include "wine/winbase16.h"
48 #include "wine/debug.h"
49 #include "kernel16_private.h"
53 WINE_DEFAULT_DEBUG_CHANNEL(module);
55 static BOOL DOSVM_isdosexe;
57 /**********************************************************************
60 * Return TRUE if we are in Windows process.
62 BOOL DOSVM_IsWin16(void)
64 return DOSVM_isdosexe ? FALSE : TRUE;
67 /**********************************************************************
70 void DOSVM_Exit( WORD retval )
74 ReleaseThunkLock( &count );
81 #define BIOS_DATA_SEGMENT 0x40
84 #define SEG16(ptr,seg) ((LPVOID)((BYTE*)ptr+((DWORD)(seg)<<4)))
85 #define SEGPTR16(ptr,segptr) ((LPVOID)((BYTE*)ptr+((DWORD)SELECTOROF(segptr)<<4)+OFFSETOF(segptr)))
87 /* structures for EXEC */
109 /* global variables */
113 static WORD init_cs,init_ip,init_ss,init_sp;
114 static HANDLE dosvm_thread, loop_thread;
115 static DWORD dosvm_tid, loop_tid;
117 static void MZ_Launch( LPCSTR cmdtail, int length );
118 static BOOL MZ_InitTask(void);
120 static void MZ_CreatePSP( LPVOID lpPSP, WORD env, WORD par )
124 psp->int20=0x20CD; /* int 20 */
125 /* some programs use this to calculate how much memory they need */
126 psp->nextParagraph=0x9FFF; /* FIXME: use a real value */
127 /* FIXME: dispatcher */
128 psp->savedint22 = DOSVM_GetRMHandler(0x22);
129 psp->savedint23 = DOSVM_GetRMHandler(0x23);
130 psp->savedint24 = DOSVM_GetRMHandler(0x24);
132 psp->environment=env;
133 /* FIXME: more PSP stuff */
136 static void MZ_FillPSP( LPVOID lpPSP, LPCSTR cmdtail, int length )
142 WARN( "Command tail truncated! (length %d)\n", length );
146 psp->cmdLine[0] = length;
149 * Length of exactly 127 bytes means that full command line is
150 * stored in environment variable CMDLINE and PSP contains
151 * command tail truncated to 126 bytes.
157 memmove(psp->cmdLine+1, cmdtail, length);
159 psp->cmdLine[length+1] = '\r';
161 /* FIXME: more PSP stuff */
164 static WORD MZ_InitEnvironment( LPCSTR env, LPCSTR name )
172 /* get size of environment block */
173 while (env[sz++]) sz+=strlen(env+sz)+1;
176 envblk=DOSMEM_AllocBlock(sz+sizeof(WORD)+strlen(name)+1,&seg);
179 memcpy(envblk,env,sz);
181 /* DOS environment variables are uppercase */
183 while (envblk[i] != '='){
184 if (envblk[i]>='a' && envblk[i] <= 'z'){
189 i += strlen(envblk+i) + 1;
191 /* DOS 3.x: the block contains 1 additional string */
192 *(WORD*)(envblk+sz)=1;
193 /* being the program name itself */
194 strcpy(envblk+sz+sizeof(WORD),name);
198 static BOOL MZ_InitMemory(void)
200 /* initialize the memory */
201 TRACE("Initializing DOS memory structures\n");
202 DOSMEM_MapDosLayout();
203 DOSDEV_InstallDOSDevices();
204 MSCDEX_InstallCDROM();
209 static BOOL MZ_DoLoadImage( HANDLE hFile, LPCSTR filename, OverlayBlock *oblk, WORD par_env_seg )
211 IMAGE_DOS_HEADER mz_header;
212 DWORD image_start,image_size,min_size,max_size,avail;
213 BYTE*psp_start,*load_start;
215 int x, old_com=0, alloc;
217 WORD env_seg, load_seg, rel_seg, oldpsp_seg;
221 /* DOS process already running, inherit from it */
224 oldpsp_seg = DOSVM_psp;
226 par_psp = (PDB16*)((DWORD)DOSVM_psp << 4);
227 oldenv = (LPSTR)((DWORD)par_psp->environment << 4);
230 /* allocate new DOS process, inheriting from Wine environment */
234 oldenv = GetEnvironmentStringsA();
237 SetFilePointer(hFile,0,NULL,FILE_BEGIN);
238 if ( !ReadFile(hFile,&mz_header,sizeof(mz_header),&len,NULL)
239 || len != sizeof(mz_header)
240 || mz_header.e_magic != IMAGE_DOS_SIGNATURE) {
241 char *p = strrchr( filename, '.' );
242 if (!p || strcasecmp( p, ".com" )) /* check for .COM extension */
244 SetLastError(ERROR_BAD_FORMAT);
247 old_com=1; /* assume .COM file */
249 image_size=GetFileSize(hFile,NULL);
250 min_size=0x10000; max_size=0x100000;
252 mz_header.e_ss=0; mz_header.e_sp=0xFFFE;
253 mz_header.e_cs=0; mz_header.e_ip=0x100;
255 /* calculate load size */
256 image_start=mz_header.e_cparhdr<<4;
257 image_size=mz_header.e_cp<<9; /* pages are 512 bytes */
258 /* From Ralf Brown Interrupt List: If the word at offset 02h is 4, it should
259 * be treated as 00h, since pre-1.10 versions of the MS linker set it that
261 if ((mz_header.e_cblp!=0)&&(mz_header.e_cblp!=4)) image_size-=512-mz_header.e_cblp;
262 image_size-=image_start;
263 min_size=image_size+((DWORD)mz_header.e_minalloc<<4)+(PSP_SIZE<<4);
264 max_size=image_size+((DWORD)mz_header.e_maxalloc<<4)+(PSP_SIZE<<4);
267 if (alloc) MZ_InitMemory();
270 /* load overlay into preallocated memory */
271 load_seg=oblk->load_seg;
272 rel_seg=oblk->rel_seg;
273 load_start=(LPBYTE)((DWORD)load_seg<<4);
275 /* allocate environment block */
277 env_seg = par_env_seg;
279 env_seg=MZ_InitEnvironment(oldenv, filename);
281 FreeEnvironmentStringsA( oldenv);
283 /* allocate memory for the executable */
284 TRACE("Allocating DOS memory (min=%d, max=%d)\n",min_size,max_size);
285 avail=DOSMEM_Available();
286 if (avail<min_size) {
287 ERR("insufficient DOS memory\n");
288 SetLastError(ERROR_NOT_ENOUGH_MEMORY);
291 if (avail>max_size) avail=max_size;
292 psp_start=DOSMEM_AllocBlock(avail,&DOSVM_psp);
294 ERR("error allocating DOS memory\n");
295 SetLastError(ERROR_NOT_ENOUGH_MEMORY);
298 load_seg=DOSVM_psp+(old_com?0:PSP_SIZE);
300 load_start=psp_start+(PSP_SIZE<<4);
301 MZ_CreatePSP(psp_start, env_seg, oldpsp_seg);
304 /* load executable image */
305 TRACE("loading DOS %s image, %08x bytes\n",old_com?"COM":"EXE",image_size);
306 SetFilePointer(hFile,image_start,NULL,FILE_BEGIN);
307 if (!ReadFile(hFile,load_start,image_size,&len,NULL) || len != image_size) {
308 /* check if this is due to the workaround for the pre-1.10 MS linker and we
309 really had only 4 bytes on the last page */
310 if (mz_header.e_cblp != 4 || image_size - len != 512 - 4) {
311 SetLastError(ERROR_BAD_FORMAT);
316 if (mz_header.e_crlc) {
317 /* load relocation table */
318 TRACE("loading DOS EXE relocation table, %d entries\n",mz_header.e_crlc);
319 /* FIXME: is this too slow without read buffering? */
320 SetFilePointer(hFile,mz_header.e_lfarlc,NULL,FILE_BEGIN);
321 for (x=0; x<mz_header.e_crlc; x++) {
322 if (!ReadFile(hFile,&reloc,sizeof(reloc),&len,NULL) || len != sizeof(reloc)) {
323 SetLastError(ERROR_BAD_FORMAT);
326 *(WORD*)SEGPTR16(load_start,reloc)+=rel_seg;
331 init_cs = load_seg+mz_header.e_cs;
332 init_ip = mz_header.e_ip;
333 init_ss = load_seg+mz_header.e_ss;
334 init_sp = mz_header.e_sp;
336 /* .COM files exit with ret. Make sure they jump to psp start (=int 20) */
337 WORD* stack = PTR_REAL_TO_LIN(init_ss, init_sp);
341 TRACE("entry point: %04x:%04x\n",init_cs,init_ip);
344 if (alloc && !MZ_InitTask()) {
345 SetLastError(ERROR_GEN_FAILURE);
352 DOSVM_psp = oldpsp_seg;
357 /***********************************************************************
358 * __wine_load_dos_exe (KERNEL.@)
360 * Called from WineVDM when a new real-mode DOS process is started.
361 * Loads DOS program into memory and executes the program.
363 void __wine_load_dos_exe( LPCSTR filename, LPCSTR cmdline )
365 char dos_cmdtail[126];
368 HANDLE hFile = CreateFileA( filename, GENERIC_READ, FILE_SHARE_READ,
369 NULL, OPEN_EXISTING, 0, 0 );
370 if (hFile == INVALID_HANDLE_VALUE) return;
371 DOSVM_isdosexe = TRUE;
372 DOSMEM_InitDosMemory();
374 if(cmdline && *cmdline)
376 dos_length = strlen(cmdline);
377 memmove( dos_cmdtail + 1, cmdline,
378 (dos_length < 125) ? dos_length : 125 );
380 /* Non-empty command tail always starts with at least one space. */
381 dos_cmdtail[0] = ' ';
385 * If command tail is longer than 126 characters,
386 * set tail length to 127 and fill CMDLINE environment variable
387 * with full command line (this includes filename).
389 if (dos_length > 126)
391 char *cmd = HeapAlloc( GetProcessHeap(), 0,
392 dos_length + strlen(filename) + 4 );
399 * Append filename. If path includes spaces, quote the path.
401 if (strchr(filename, ' '))
404 strcpy( ptr, filename );
405 ptr += strlen(filename);
410 strcpy( ptr, filename );
411 ptr += strlen(filename);
415 * Append command tail.
417 if (cmdline[0] != ' ')
419 strcpy( ptr, cmdline );
422 * Set environment variable. This will be passed to
425 if (!SetEnvironmentVariableA( "CMDLINE", cmd ))
427 HeapFree(GetProcessHeap(), 0, cmd );
431 HeapFree(GetProcessHeap(), 0, cmd );
436 if (MZ_DoLoadImage( hFile, filename, NULL, 0 ))
437 MZ_Launch( dos_cmdtail, dos_length );
440 /***********************************************************************
443 * this may only be called from existing DOS processes
445 BOOL MZ_Exec( CONTEXT86 *context, LPCSTR filename, BYTE func, LPVOID paramblk )
449 PROCESS_INFORMATION pe;
454 if(!GetBinaryTypeA(filename, &binType)) /* determine what kind of binary this is */
456 return FALSE; /* binary is not an executable */
459 /* handle non-dos executables */
460 if(binType != SCS_DOS_BINARY)
462 if(func == 0) /* load and execute */
466 LPBYTE psp_start = (LPBYTE)((DWORD)DOSVM_psp << 4);
467 PDB16 *psp = (PDB16 *)psp_start;
468 ExecBlock *blk = paramblk;
469 LPBYTE cmdline = PTR_REAL_TO_LIN(SELECTOROF(blk->cmdline),OFFSETOF(blk->cmdline));
470 LPBYTE envblock = PTR_REAL_TO_LIN(psp->environment, 0);
471 int cmdLength = cmdline[0];
474 * If cmdLength is 127, command tail is truncated and environment
475 * variable CMDLINE should contain full command line
476 * (this includes filename).
478 if (cmdLength == 127)
480 FIXME( "CMDLINE argument passing is unimplemented.\n" );
481 cmdLength = 126; /* FIXME */
484 fullCmdLength = (strlen(filename) + 1) + cmdLength + 1; /* filename + space + cmdline + terminating null character */
486 fullCmdLine = HeapAlloc(GetProcessHeap(), 0, fullCmdLength);
487 if(!fullCmdLine) return FALSE; /* return false on memory alloc failure */
489 /* build the full command line from the executable file and the command line being passed in */
490 snprintf(fullCmdLine, fullCmdLength, "%s ", filename); /* start off with the executable filename and a space */
491 memcpy(fullCmdLine + strlen(fullCmdLine), cmdline + 1, cmdLength); /* append cmdline onto the end */
492 fullCmdLine[fullCmdLength - 1] = 0; /* null terminate string */
494 ZeroMemory (&st, sizeof(STARTUPINFOA));
495 st.cb = sizeof(STARTUPINFOA);
496 ret = CreateProcessA (NULL, fullCmdLine, NULL, NULL, TRUE, 0, envblock, NULL, &st, &pe);
498 /* wait for the app to finish and clean up PROCESS_INFORMATION handles */
501 WaitForSingleObject(pe.hProcess, INFINITE); /* wait here until the child process is complete */
502 CloseHandle(pe.hProcess);
503 CloseHandle(pe.hThread);
506 HeapFree(GetProcessHeap(), 0, fullCmdLine); /* free the memory we allocated */
510 FIXME("EXEC type of %d not implemented for non-dos executables\n", func);
515 } /* if(binType != SCS_DOS_BINARY) */
518 /* handle dos executables */
520 hFile = CreateFileA( filename, GENERIC_READ, FILE_SHARE_READ,
521 NULL, OPEN_EXISTING, 0, 0);
522 if (hFile == INVALID_HANDLE_VALUE) return FALSE;
525 case 0: /* load and execute */
526 case 1: /* load but don't execute */
528 /* save current process's return SS:SP now */
529 LPBYTE psp_start = (LPBYTE)((DWORD)DOSVM_psp << 4);
530 PDB16 *psp = (PDB16 *)psp_start;
531 psp->saveStack = (DWORD)MAKESEGPTR(context->SegSs, LOWORD(context->Esp));
533 ret = MZ_DoLoadImage( hFile, filename, NULL, ((ExecBlock *)paramblk)->env_seg );
535 /* MZ_LoadImage created a new PSP and loaded new values into it,
536 * let's work on the new values now */
537 LPBYTE psp_start = (LPBYTE)((DWORD)DOSVM_psp << 4);
538 ExecBlock *blk = paramblk;
539 LPBYTE cmdline = PTR_REAL_TO_LIN(SELECTOROF(blk->cmdline),OFFSETOF(blk->cmdline));
541 /* First character contains the length of the command line. */
542 MZ_FillPSP(psp_start, (LPSTR)cmdline + 1, cmdline[0]);
544 /* the lame MS-DOS engineers decided that the return address should be in int22 */
545 DOSVM_SetRMHandler(0x22, (FARPROC16)MAKESEGPTR(context->SegCs, LOWORD(context->Eip)));
547 /* don't execute, just return startup state */
550 * For function 01h, the AX value to be passed to the child program
551 * is put on top of the child's stack
555 stack = CTX_SEG_OFF_TO_LIN(context, init_ss, init_sp);
556 /* FIXME: push AX correctly */
557 stack[0] = 0x00; /* push AL */
558 stack[1] = 0x00; /* push AH */
560 blk->init_cs = init_cs;
561 blk->init_ip = init_ip;
562 blk->init_ss = init_ss;
563 blk->init_sp = init_sp;
565 /* execute by making us return to new process */
566 context->SegCs = init_cs;
567 context->Eip = init_ip;
568 context->SegSs = init_ss;
569 context->Esp = init_sp;
570 context->SegDs = DOSVM_psp;
571 context->SegEs = DOSVM_psp;
576 case 3: /* load overlay */
578 OverlayBlock *blk = paramblk;
579 ret = MZ_DoLoadImage( hFile, filename, blk, 0);
583 FIXME("EXEC load type %d not implemented\n", func);
584 SetLastError(ERROR_INVALID_FUNCTION);
591 /***********************************************************************
594 void MZ_AllocDPMITask( void )
600 /***********************************************************************
603 void MZ_RunInThread( PAPCFUNC proc, ULONG_PTR arg )
611 event = CreateEventW(NULL, TRUE, FALSE, NULL);
612 PostThreadMessageA(loop_tid, WM_USER, (WPARAM)event, (LPARAM)&spc);
613 WaitForSingleObject(event, INFINITE);
619 static DWORD WINAPI MZ_DOSVM( LPVOID lpExtra )
624 dosvm_pid = getpid();
626 memset( &context, 0, sizeof(context) );
627 context.SegCs = init_cs;
628 context.Eip = init_ip;
629 context.SegSs = init_ss;
630 context.Esp = init_sp;
631 context.SegDs = DOSVM_psp;
632 context.SegEs = DOSVM_psp;
633 context.EFlags = V86_FLAG | VIF_MASK;
634 DOSVM_SetTimer(0x10000);
635 ret = DOSVM_Enter( &context );
638 /* fetch the app name from the environment */
639 PDB16 *psp = PTR_REAL_TO_LIN( DOSVM_psp, 0 );
640 char *env = PTR_REAL_TO_LIN( psp->environment, 0 );
641 while (*env) env += strlen(env) + 1;
642 env += 1 + sizeof(WORD);
644 if (GetLastError() == ERROR_NOT_SUPPORTED)
645 MESSAGE( "wine: Cannot start DOS application %s\n"
646 " because vm86 mode is not supported on this platform.\n",
649 FIXME( "vm86 mode failed error %u\n", GetLastError() );
655 static BOOL MZ_InitTask(void)
657 if (!DuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
658 GetCurrentProcess(), &loop_thread,
659 0, FALSE, DUPLICATE_SAME_ACCESS))
661 dosvm_thread = CreateThread(NULL, 0, MZ_DOSVM, NULL, CREATE_SUSPENDED, &dosvm_tid);
663 CloseHandle(loop_thread);
667 loop_tid = GetCurrentThreadId();
671 static void MZ_Launch( LPCSTR cmdtail, int length )
673 TDB *pTask = GlobalLock16( GetCurrentTask() );
674 BYTE *psp_start = PTR_REAL_TO_LIN( DOSVM_psp, 0 );
679 MZ_FillPSP(psp_start, cmdtail, length);
680 pTask->flags |= TDBF_WINOLDAP;
682 /* DTA is set to PSP:0080h when a program is started. */
683 pTask->dta = MAKESEGPTR( DOSVM_psp, 0x80 );
685 GetpWin16Lock( &lock );
686 _LeaveSysLevel( lock );
688 /* force the message queue to be created */
689 PeekMessageW(&msg, NULL, WM_USER, WM_USER, PM_NOREMOVE);
691 ResumeThread(dosvm_thread);
692 rv = DOSVM_Loop(dosvm_thread);
694 CloseHandle(dosvm_thread);
695 dosvm_thread = 0; dosvm_tid = 0;
696 CloseHandle(loop_thread);
697 loop_thread = 0; loop_tid = 0;
703 /***********************************************************************
706 void MZ_Exit( CONTEXT86 *context, BOOL cs_psp, WORD retval )
709 WORD psp_seg = cs_psp ? context->SegCs : DOSVM_psp;
710 LPBYTE psp_start = (LPBYTE)((DWORD)psp_seg << 4);
711 PDB16 *psp = (PDB16 *)psp_start;
712 WORD parpsp = psp->parentPSP; /* check for parent DOS process */
714 /* retrieve parent's return address */
715 FARPROC16 retaddr = DOSVM_GetRMHandler(0x22);
716 /* restore interrupts */
717 DOSVM_SetRMHandler(0x22, psp->savedint22);
718 DOSVM_SetRMHandler(0x23, psp->savedint23);
719 DOSVM_SetRMHandler(0x24, psp->savedint24);
720 /* FIXME: deallocate file handles etc */
721 /* free process's associated memory
722 * FIXME: walk memory and deallocate all blocks owned by process */
723 DOSMEM_FreeBlock( PTR_REAL_TO_LIN(psp->environment,0) );
724 DOSMEM_FreeBlock( PTR_REAL_TO_LIN(DOSVM_psp,0) );
725 /* switch to parent's PSP */
727 psp_start = (LPBYTE)((DWORD)parpsp << 4);
728 psp = (PDB16 *)psp_start;
729 /* now return to parent */
730 DOSVM_retval = retval;
731 context->SegCs = SELECTOROF(retaddr);
732 context->Eip = OFFSETOF(retaddr);
733 context->SegSs = SELECTOROF(psp->saveStack);
734 context->Esp = OFFSETOF(psp->saveStack);
737 TRACE("killing DOS task\n");
739 DOSVM_Exit( retval );
743 /***********************************************************************
746 BOOL MZ_Current( void )
748 return (dosvm_pid != 0); /* FIXME: do a better check */
751 #else /* !MZ_SUPPORTED */
753 /***********************************************************************
754 * __wine_load_dos_exe (KERNEL.@)
756 void __wine_load_dos_exe( LPCSTR filename, LPCSTR cmdline )
758 FIXME("DOS executables not supported on this platform\n");
759 SetLastError(ERROR_BAD_FORMAT);
762 /***********************************************************************
765 BOOL MZ_Exec( CONTEXT86 *context, LPCSTR filename, BYTE func, LPVOID paramblk )
768 SetLastError(ERROR_BAD_FORMAT);
772 /***********************************************************************
775 void MZ_AllocDPMITask( void )
777 FIXME("Actual real-mode calls not supported on this platform!\n");
780 /***********************************************************************
783 void MZ_RunInThread( PAPCFUNC proc, ULONG_PTR arg )
788 /***********************************************************************
791 void MZ_Exit( CONTEXT86 *context, BOOL cs_psp, WORD retval )
793 DOSVM_Exit( retval );
796 /***********************************************************************
799 BOOL MZ_Current( void )
804 #endif /* !MZ_SUPPORTED */