reactos/subsystems/ntvdm/dos.c

/*
 * COPYRIGHT:       GPL - See COPYING in the top level directory
 * PROJECT:         ReactOS Virtual DOS Machine
 * FILE:            dos.c
 * PURPOSE:         VDM DOS Kernel
 * PROGRAMMERS:     Aleksandar Andrejevic <theflash AT sdf DOT lonestar DOT org>
 */

#include "ntvdm.h"

WORD CurrentPsp = SYSTEM_PSP, LastError = 0;

static VOID DosCombineFreeBlocks()
{
    WORD Segment = FIRST_MCB_SEGMENT;
    PDOS_MCB CurrentMcb, NextMcb;

    /* Loop through all the blocks */
    while (TRUE)
    {
        /* Get a pointer to the MCB */
        CurrentMcb = SEGMENT_TO_MCB(Segment);

        /* Ignore the last block */
        if (CurrentMcb->BlockType == 'Z') break;

        /* Get a pointer to the next MCB */
        NextMcb = SEGMENT_TO_MCB(Segment + CurrentMcb->Size + 1);

        /* If both this block and the next one are free, combine them */
        if ((CurrentMcb->OwnerPsp == 0) && (NextMcb->OwnerPsp == 0))
        {
            CurrentMcb->Size += NextMcb->Size + 1;
            CurrentMcb->BlockType = NextMcb->BlockType;

            /* Invalidate the next MCB */
            NextMcb->BlockType = 'I';

            /* Try to combine the current block again with the next one */
            continue;
        }

        /* Update the segment and continue */
        Segment += CurrentMcb->Size + 1;
    }
}

static WORD DosCopyEnvironmentBlock(WORD SourceSegment)
{
    PCHAR Ptr, SourceBuffer, DestBuffer = NULL;
    ULONG TotalSize = 0;
    WORD DestSegment;

    Ptr = SourceBuffer = (PCHAR)((ULONG_PTR)BaseAddress + TO_LINEAR(SourceSegment, 0));

    /* Calculate the size of the environment block */
    while (*Ptr)
    {
        TotalSize += strlen(Ptr) + 1;
        Ptr += strlen(Ptr) + 1;
    }
    TotalSize++;

    /* Allocate the memory for the environment block */
    DestSegment = DosAllocateMemory((TotalSize + 0x0F) >> 4);
    if (!DestSegment) return 0;

    Ptr = SourceBuffer;

    DestBuffer = (PCHAR)((ULONG_PTR)BaseAddress + TO_LINEAR(DestSegment, 0));
    while (*Ptr)
    {
        /* Copy the string */
        strcpy(DestBuffer, Ptr);

        /* Advance to the next string */
        Ptr += strlen(Ptr) + 1;
        DestBuffer += strlen(Ptr) + 1;
    }

    /* Set the final zero */
    *DestBuffer = 0;

    return DestSegment;
}

WORD DosAllocateMemory(WORD Size)
{
    WORD Result = 0, Segment = FIRST_MCB_SEGMENT;
    PDOS_MCB CurrentMcb, NextMcb;

    /* Find an unallocated block */
    while (TRUE)
    {
        /* Get a pointer to the MCB */
        CurrentMcb = SEGMENT_TO_MCB(Segment);

        /* Make sure it's valid */
        if (CurrentMcb->BlockType != 'M' && CurrentMcb->BlockType != 'Z')
        {
            return 0;
        }

        /* Only check free blocks */
        if (CurrentMcb->OwnerPsp != 0) goto Next;

        /* Check if the block is big enough */
        if (CurrentMcb->Size < Size) goto Next;

        /* It is, update the smallest found so far */
        if ((Result == 0) || (CurrentMcb->Size < SEGMENT_TO_MCB(Result)->Size))
        {
            Result = Segment;
        }

Next:
        /* If this was the last MCB in the chain, quit. */
        if (CurrentMcb->BlockType == 'Z') break;

        /* Otherwise, update the segment and continue */
        Segment += CurrentMcb->Size + 1;
    }

    /* If we didn't find a free block, return zero */
    if (Result == 0) return 0;

    /* Get a pointer to the MCB */
    CurrentMcb = SEGMENT_TO_MCB(Result);

    /* Check if the block is larger than requested */
    if (CurrentMcb->Size > Size)
    {
        /* It is, split it into two blocks */
        NextMcb = SEGMENT_TO_MCB(Result + Size + 1);

        /* Initialize the new MCB structure */
        NextMcb->BlockType = CurrentMcb->BlockType;
        NextMcb->Size = Size - CurrentMcb->Size - 1;
        NextMcb->OwnerPsp = 0;

        /* Update the current block */
        CurrentMcb->BlockType = 'M';
        CurrentMcb->Size = Size;

        /* Combine consecutive free blocks into larger blocks */
        DosCombineFreeBlocks();
    }

    /* Take ownership of the block */
    CurrentMcb->OwnerPsp = CurrentPsp;

    return Result;
}

WORD DosResizeMemory(WORD Segment, WORD NewSize)
{
    WORD ReturnSize = 0, CurrentSeg;
    PDOS_MCB Mcb = SEGMENT_TO_MCB(Segment), CurrentMcb;
    BOOLEAN FinalBlockUsed = FALSE;

    /* We can't expand the last block */
    if (Mcb->BlockType != 'M') return 0;

    /* Check if need to expand or contract the block */
    if (NewSize > Mcb->Size)
    {
        ReturnSize = Mcb->Size;

        /* Get the segment of the next MCB */
        CurrentSeg = Segment + Mcb->Size + 1;

        /* Calculate the maximum amount of memory this block could expand to */
        while (ReturnSize < NewSize)
        {
            /* Get the MCB */
            CurrentMcb = SEGMENT_TO_MCB(CurrentSeg);

            /* We can't expand the block over an allocated block */
            if (CurrentMcb->OwnerPsp != 0) break;

            ReturnSize += CurrentMcb->Size + 1;

            /* Check if this is the last block */
            if (CurrentMcb->BlockType == 'Z')
            {
                FinalBlockUsed = TRUE;
                break;
            }

            /* Update the segment and continue */
            CurrentSeg += CurrentMcb->Size + 1;
        }

        /* Check if we need to split the last block */
        if (ReturnSize > NewSize)
        {
            /* Initialize the new MCB structure */
            CurrentMcb = SEGMENT_TO_MCB(Segment + NewSize + 1);
            CurrentMcb->BlockType = (FinalBlockUsed) ? 'Z' : 'M';
            CurrentMcb->Size = ReturnSize - NewSize - 1;
            CurrentMcb->OwnerPsp = 0;
        }

        /* Calculate the new size of the block */
        ReturnSize = min(ReturnSize, NewSize);

        /* Update the MCB */
        if (FinalBlockUsed) Mcb->BlockType = 'Z';
        Mcb->Size = ReturnSize;
    }
    else if (NewSize < Mcb->Size)
    {
        /* Just split the block */
        CurrentMcb = SEGMENT_TO_MCB(Segment + NewSize + 1);
        CurrentMcb->BlockType = Mcb->BlockType;
        CurrentMcb->Size = Mcb->Size - NewSize - 1;
        CurrentMcb->OwnerPsp = 0;

        /* Update the MCB */
        Mcb->BlockType = 'M';
        Mcb->Size = NewSize;

        ReturnSize = NewSize;
    }

    /* Combine consecutive free blocks into larger blocks */
    DosCombineFreeBlocks();

    return ReturnSize;
}

BOOLEAN DosFreeMemory(WORD Segment)
{
    PDOS_MCB Mcb = SEGMENT_TO_MCB(Segment);

    /* Make sure the MCB is valid */
    if (Mcb->BlockType != 'M' && Mcb->BlockType != 'Z') return FALSE;

    /* Mark the block as free */
    Mcb->OwnerPsp = 0;

    /* Combine consecutive free blocks into larger blocks */
    DosCombineFreeBlocks();

    return TRUE;
}

WORD DosCreateFile(LPCSTR FilePath)
{
    // TODO: NOT IMPLEMENTED
    return 0;
}

WORD DosOpenFile(LPCSTR FilePath)
{
    // TODO: NOT IMPLEMENTED
    return 0;
}

VOID DosInitializePsp(WORD PspSegment, LPCSTR CommandLine, WORD ProgramSize, WORD Environment)
{
    INT i;
    PDOS_PSP PspBlock = SEGMENT_TO_PSP(PspSegment);
    LPDWORD IntVecTable = (LPDWORD)((ULONG_PTR)BaseAddress);

    ZeroMemory(PspBlock, sizeof(DOS_PSP));

    /* Set the exit interrupt */
    PspBlock->Exit[0] = 0xCD; // int 0x20
    PspBlock->Exit[1] = 0x20;

    /* Set the program size */
    PspBlock->MemSize = ProgramSize;

    /* Save the interrupt vectors */
    PspBlock->TerminateAddress = IntVecTable[0x22];
    PspBlock->BreakAddress = IntVecTable[0x23];
    PspBlock->CriticalAddress = IntVecTable[0x24];

    /* Set the parent PSP */
    PspBlock->ParentPsp = CurrentPsp;

    /* Initialize the handle table */
    for (i = 0; i < 20; i++) PspBlock->HandleTable[i] = 0xFF;

    /* Did we get an environment segment? */
    if (!Environment)
    {
        /* No, copy the one from the parent */
        Environment = DosCopyEnvironmentBlock((CurrentPsp != SYSTEM_PSP)
                                              ? SEGMENT_TO_PSP(CurrentPsp)->EnvBlock
                                              : SYSTEM_ENV_BLOCK);
    }

    PspBlock->EnvBlock = Environment;

    /* Set the handle table pointers to the internal handle table */
    PspBlock->HandleTableSize = 20;
    PspBlock->HandleTablePtr = MAKELONG(0x18, PspSegment);

    /* Set the DOS version */
    PspBlock->DosVersion = DOS_VERSION;

    /* Set the far call opcodes */
    PspBlock->FarCall[0] = 0xCD; // int 0x21
    PspBlock->FarCall[1] = 0x21;
    PspBlock->FarCall[2] = 0xCB; // retf

    /* Set the command line */
    PspBlock->CommandLineSize = strlen(CommandLine);
    RtlCopyMemory(PspBlock->CommandLine, CommandLine, PspBlock->CommandLineSize);
    PspBlock->CommandLine[PspBlock->CommandLineSize] = '\r';
}

BOOLEAN DosCreateProcess(LPCSTR CommandLine, WORD EnvBlock)
{
    BOOLEAN Success = FALSE;
    HANDLE FileHandle = INVALID_HANDLE_VALUE, FileMapping = NULL;
    LPBYTE Address = NULL;
    LPSTR ProgramFilePath, Parameters[128];
    CHAR CommandLineCopy[128];
    INT ParamCount = 0;
    WORD Segment, FileSize;

    /* Save a copy of the command line */
    strcpy(CommandLineCopy, CommandLine);

    /* Get the file name of the executable */
    ProgramFilePath = strtok(CommandLineCopy, " \t");

    /* Load the parameters in the local array */
    while ((ParamCount < 256)
           && ((Parameters[ParamCount] = strtok(NULL, " \t")) != NULL))
    {
        ParamCount++;
    }

    /* Open a handle to the executable */
    FileHandle = CreateFileA(ProgramFilePath,
                             GENERIC_READ,
                             0,
                             NULL,
                             OPEN_EXISTING,
                             FILE_ATTRIBUTE_NORMAL,
                             NULL);
    if (FileHandle == INVALID_HANDLE_VALUE) goto Cleanup;

    /* Get the file size */
    FileSize = GetFileSize(FileHandle, NULL);

    /* Create a mapping object for the file */
    FileMapping = CreateFileMapping(FileHandle,
                                    NULL,
                                    PAGE_READONLY,
                                    0,
                                    0,
                                    NULL);
    if (FileMapping == NULL) goto Cleanup;

    /* Map the file into memory */
    Address = (LPBYTE)MapViewOfFile(FileMapping, FILE_MAP_READ, 0, 0, 0);
    if (Address == NULL) goto Cleanup;

    /* Check if this is an EXE file or a COM file */
    if (Address[0] == 'M' && Address[1] == 'Z')
    {
        /* EXE file */

        // TODO: NOT IMPLEMENTED
        DisplayMessage(L"EXE files are not yet supported!");
    }
    else
    {
        /* COM file */

        /* Allocate memory for the whole program and the PSP */
        Segment = DosAllocateMemory((FileSize + sizeof(DOS_PSP)) >> 4);
        if (Segment == 0) goto Cleanup;

        /* Copy the program to Segment:0100 */
        RtlCopyMemory((PVOID)((ULONG_PTR)BaseAddress
                      + TO_LINEAR(Segment, 0x100)),
                      Address,
                      FileSize);

        /* Initialize the PSP */
        DosInitializePsp(Segment,
                         CommandLine,
                         (FileSize + sizeof(DOS_PSP)) >> 4,
                         EnvBlock);

        /* Set the initial segment registers */
        EmulatorSetRegister(EMULATOR_REG_DS, Segment);
        EmulatorSetRegister(EMULATOR_REG_ES, Segment);

        /* Set the stack to the last word of the segment */
        EmulatorSetStack(Segment, 0xFFFE);

        /* Execute */
        CurrentPsp = Segment;
        EmulatorExecute(Segment, 0x100);

        Success = TRUE;
    }

Cleanup:
    /* Unmap the file*/
    if (Address != NULL) UnmapViewOfFile(Address);

    /* Close the file mapping object */
    if (FileMapping != NULL) CloseHandle(FileMapping);

    /* Close the file handle */
    if (FileHandle != INVALID_HANDLE_VALUE) CloseHandle(FileHandle);

    return Success;
}

VOID DosTerminateProcess(WORD Psp, BYTE ReturnCode)
{
    WORD McbSegment = FIRST_MCB_SEGMENT;
    PDOS_MCB CurrentMcb;
    LPDWORD IntVecTable = (LPDWORD)((ULONG_PTR)BaseAddress);
    PDOS_PSP PspBlock = SEGMENT_TO_PSP(Psp);

    /* Check if this PSP is it's own parent */
    if (PspBlock->ParentPsp == Psp) goto Done;

    // TODO: Close all handles opened by the process

    /* Free the memory used by the process */
    while (TRUE)
    {
        /* Get a pointer to the MCB */
        CurrentMcb = SEGMENT_TO_MCB(McbSegment);

        /* Make sure the MCB is valid */
        if (CurrentMcb->BlockType != 'M' && CurrentMcb->BlockType !='Z') break;

        /* If this block was allocated by the process, free it */
        if (CurrentMcb->OwnerPsp == Psp) DosFreeMemory(McbSegment);

        /* If this was the last block, quit */
        if (CurrentMcb->BlockType == 'Z') break;

        /* Update the segment and continue */
        McbSegment += CurrentMcb->Size + 1;
    }

Done:
    /* Restore the interrupt vectors */
    IntVecTable[0x22] = PspBlock->TerminateAddress;
    IntVecTable[0x23] = PspBlock->BreakAddress;
    IntVecTable[0x24] = PspBlock->CriticalAddress;

    /* Update the current PSP */
    if (Psp == CurrentPsp)
    {
        CurrentPsp = PspBlock->ParentPsp;
        if (CurrentPsp == SYSTEM_PSP) VdmRunning = FALSE;
    }

    /* Return control to the parent process */
    EmulatorExecute(HIWORD(PspBlock->TerminateAddress),
                    LOWORD(PspBlock->TerminateAddress));
}

CHAR DosReadCharacter()
{
    // TODO: STDIN can be redirected under DOS 2.0+
    return _getch();
}

VOID DosPrintCharacter(CHAR Character)
{
    // TODO: STDOUT can be redirected under DOS 2.0+
    if (Character == '\r') Character = '\n';
    putchar(Character);
}

VOID DosInt20h(WORD CodeSegment)
{
    /* This is the exit interrupt */
    DosTerminateProcess(CodeSegment, 0);
}

VOID DosInt21h(WORD CodeSegment)
{
    INT i;
    CHAR Character;
    SYSTEMTIME SystemTime;
    PCHAR String;
    PDOS_INPUT_BUFFER InputBuffer;
    DWORD Eax = EmulatorGetRegister(EMULATOR_REG_AX);
    DWORD Ecx = EmulatorGetRegister(EMULATOR_REG_CX);
    DWORD Edx = EmulatorGetRegister(EMULATOR_REG_DX);
    DWORD Ebx = EmulatorGetRegister(EMULATOR_REG_BX);
    WORD DataSegment = EmulatorGetRegister(EMULATOR_REG_DS);
    WORD ExtSegment = EmulatorGetRegister(EMULATOR_REG_ES);

    /* Check the value in the AH register */
    switch (HIBYTE(Eax))
    {
        /* Terminate Program */
        case 0x00:
        {
            DosTerminateProcess(CodeSegment, 0);
            break;
        }

        /* Read Character And Echo */
        case 0x01:
        {
            Character = DosReadCharacter();
            DosPrintCharacter(Character);
            EmulatorSetRegister(EMULATOR_REG_AX, (Eax & 0xFFFFFF00) | Character);
            break;
        }

        /* Print Character */
        case 0x02:
        {
            DosPrintCharacter(LOBYTE(Edx));
            break;
        }

        /* Read Character Without Echo */
        case 0x08:
        {
            EmulatorSetRegister(EMULATOR_REG_AX,
                               (Eax & 0xFFFFFF00) | DosReadCharacter());
            break;
        }

        /* Print String */
        case 0x09:
        {
            String = (PCHAR)((ULONG_PTR)BaseAddress
                     + TO_LINEAR(DataSegment, LOWORD(Edx)));

            while ((*String) != '$')
            {
                DosPrintCharacter(*String);
                String++;
            }

            break;
        }

        /* Read Buffered Input */
        case 0x0A:
        {
            InputBuffer = (PDOS_INPUT_BUFFER)((ULONG_PTR)BaseAddress
                                              + TO_LINEAR(DataSegment,
                                                          LOWORD(Edx)));

            InputBuffer->Length = 0;
            for (i = 0; i < InputBuffer->MaxLength; i ++)
            {
                Character = DosReadCharacter();
                DosPrintCharacter(Character);
                InputBuffer->Buffer[InputBuffer->Length] = Character;
                if (Character == '\r') break;
                InputBuffer->Length++;
            }

            break;
        }

        /* Get system date */
        case 0x2A:
        {
            GetSystemTime(&SystemTime);
            EmulatorSetRegister(EMULATOR_REG_CX,
                                (Ecx & 0xFFFF0000) | SystemTime.wYear);
            EmulatorSetRegister(EMULATOR_REG_DX,
                                (Edx & 0xFFFF0000)
                                | (SystemTime.wMonth << 8)
                                | SystemTime.wDay);
            EmulatorSetRegister(EMULATOR_REG_AX,
                                (Eax & 0xFFFFFF00) | SystemTime.wDayOfWeek);
            break;
        }

        /* Get system time */
        case 0x2C:
        {
            GetSystemTime(&SystemTime);
            EmulatorSetRegister(EMULATOR_REG_CX,
                                (Ecx & 0xFFFF0000)
                                | (SystemTime.wHour << 8)
                                | SystemTime.wMinute);
            EmulatorSetRegister(EMULATOR_REG_DX,
                                (Edx & 0xFFFF0000)
                                | (SystemTime.wSecond << 8)
                                | (SystemTime.wMilliseconds / 10));
            break;
        }

        /* Allocate Memory */
        case 0x48:
        {
            WORD Segment = DosAllocateMemory(LOWORD(Ebx));
            if (Segment != 0)
            {
                EmulatorSetRegister(EMULATOR_REG_AX, Segment);
                EmulatorClearFlag(EMULATOR_FLAG_CF);
            }
            else EmulatorSetFlag(EMULATOR_FLAG_CF);

            break;
        }

        /* Free Memory */
        case 0x49:
        {
            if (DosFreeMemory(ExtSegment))
            {
                EmulatorClearFlag(EMULATOR_FLAG_CF);
            }
            else EmulatorSetFlag(EMULATOR_FLAG_CF);

            break;
        }

        /* Resize Memory Block */
        case 0x4A:
        {
            WORD Size = DosResizeMemory(ExtSegment, LOWORD(Ebx));

            if (Size != 0)
            {
                EmulatorSetRegister(EMULATOR_REG_BX, Size);
                EmulatorClearFlag(EMULATOR_FLAG_CF);
            }
            else EmulatorSetFlag(EMULATOR_FLAG_CF);

            break;
        }

        /* Terminate With Return Code */
        case 0x4C:
        {
            DosTerminateProcess(CurrentPsp, LOBYTE(Eax));
            break;
        }

        /* Unsupported */
        default:
        {
            EmulatorSetFlag(EMULATOR_FLAG_CF);
        }
    }
}

VOID DosBreakInterrupt()
{
    VdmRunning = FALSE;
}

BOOLEAN DosInitialize()
{
    PDOS_MCB Mcb = SEGMENT_TO_MCB(FIRST_MCB_SEGMENT);
    FILE *Stream;
    WCHAR Buffer[256];
    LPWSTR SourcePtr, Environment;
    LPSTR AsciiString;
    LPSTR DestPtr = (LPSTR)((ULONG_PTR)BaseAddress + TO_LINEAR(SYSTEM_ENV_BLOCK, 0));
    DWORD AsciiSize;

    /* Initialize the MCB */
    Mcb->BlockType = 'Z';
    Mcb->Size = (WORD)USER_MEMORY_SIZE;
    Mcb->OwnerPsp = 0;

    /* Get the environment strings */
    SourcePtr = Environment = GetEnvironmentStringsW();
    if (Environment == NULL) return FALSE;

    /* Fill the DOS system environment block */
    while (*SourcePtr)
    {
        /* Get the size of the ASCII string */
        AsciiSize = WideCharToMultiByte(CP_ACP,
                                        0,
                                        SourcePtr,
                                        -1,
                                        NULL,
                                        0,
                                        NULL,
                                        NULL);

        /* Allocate memory for the ASCII string */
        AsciiString = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, AsciiSize);
        if (AsciiString == NULL)
        {
            FreeEnvironmentStringsW(Environment);
            return FALSE;
        }

        /* Convert to ASCII */
        WideCharToMultiByte(CP_ACP,
                            0,
                            SourcePtr,
                            -1,
                            AsciiString,
                            AsciiSize,
                            NULL,
                            NULL);

        /* Copy the string into DOS memory */
        strcpy(DestPtr, AsciiString);

        /* Free the memory */
        HeapFree(GetProcessHeap(), 0, AsciiString);

        /* Move to the next string */
        SourcePtr += wcslen(SourcePtr) + 1;
        DestPtr += strlen(AsciiString) + 1;
    }

    /* Free the memory allocated for environment strings */
    FreeEnvironmentStringsW(Environment);

    /* Read CONFIG.SYS */
    Stream = _wfopen(DOS_CONFIG_PATH, L"r");
    if (Stream != NULL)
    {
        while (fgetws(Buffer, 256, Stream))
        {
            // TODO: Parse the line
        }
        fclose(Stream);
    }

    return TRUE;
}

/* EOF */