disk.c File Reference

#include "ntvdm.h"
#include <debug.h>
#include "emulator.h"
#include "disk.h"
#include "memory.h"
#include "utils.h"

Include dependency graph for disk.c:

Go to the source code of this file.

Classes
struct	_VHD_FOOTER
struct	_DISK_GEO
struct	_DISK_MOUNT_INFO

Macros
#define	NDEBUG
#define	VHD_TIMESTAMP_BASE   946684800

Typedefs
typedef struct _VHD_FOOTER	VHD_FOOTER
typedef struct _VHD_FOOTER *	PVHD_FOOTER
typedef struct _DISK_GEO	DISK_GEO
typedef struct _DISK_GEO *	PDISK_GEO
typedef BOOLEAN(*	MOUNT_DISK_HANDLER) (IN PDISK_IMAGE DiskImage, IN HANDLE hFile)
typedef struct _DISK_MOUNT_INFO	DISK_MOUNT_INFO
typedef struct _DISK_MOUNT_INFO *	PDISK_MOUNT_INFO

Enumerations
enum	VHD_TYPE { VHD_FIXED = 2 , VHD_DYNAMIC = 3 , VHD_DIFFERENCING = 4 }

Functions
	C_ASSERT (sizeof(VHD_FOOTER)==0x200)
static BOOLEAN	MountFDI (IN PDISK_IMAGE DiskImage, IN HANDLE hFile)
static BOOLEAN	MountHDD (IN PDISK_IMAGE DiskImage, IN HANDLE hFile)
BOOLEAN	IsDiskPresent (IN PDISK_IMAGE DiskImage)
BYTE	SeekDisk (IN PDISK_IMAGE DiskImage, IN WORD Cylinder, IN BYTE Head, IN BYTE Sector)
BYTE	ReadDisk (IN PDISK_IMAGE DiskImage, IN WORD Cylinder, IN BYTE Head, IN BYTE Sector, IN BYTE NumSectors)
BYTE	WriteDisk (IN PDISK_IMAGE DiskImage, IN WORD Cylinder, IN BYTE Head, IN BYTE Sector, IN BYTE NumSectors)
PDISK_IMAGE	RetrieveDisk (IN DISK_TYPE DiskType, IN ULONG DiskNumber)
BOOLEAN	MountDisk (IN DISK_TYPE DiskType, IN ULONG DiskNumber, IN PCWSTR FileName, IN BOOLEAN ReadOnly)
BOOLEAN	UnmountDisk (IN DISK_TYPE DiskType, IN ULONG DiskNumber)
BOOLEAN	DiskCtrlInitialize (VOID)
VOID	DiskCtrlCleanup (VOID)

Variables
static DISK_IMAGE	XDCFloppyDrive [4]
static WORD	HackSectorSize = 512
static DISK_GEO	DiskGeometryList []
static DISK_IMAGE	XDCHardDrive [4]
static DISK_MOUNT_INFO	DiskMountInfo [MAX_DISK_TYPE]

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 25 of file disk.c.

VHD_TIMESTAMP_BASE

#define VHD_TIMESTAMP_BASE   946684800

Definition at line 55 of file disk.c.

Typedef Documentation

DISK_GEO

typedef struct _DISK_GEO DISK_GEO

DISK_MOUNT_INFO

typedef struct _DISK_MOUNT_INFO DISK_MOUNT_INFO

MOUNT_DISK_HANDLER

typedef BOOLEAN(* MOUNT_DISK_HANDLER) (IN PDISK_IMAGE DiskImage, IN HANDLE hFile)

Definition at line 469 of file disk.c.

PDISK_GEO

typedef struct _DISK_GEO * PDISK_GEO

PDISK_MOUNT_INFO

typedef struct _DISK_MOUNT_INFO * PDISK_MOUNT_INFO

PVHD_FOOTER

typedef struct _VHD_FOOTER * PVHD_FOOTER

VHD_FOOTER

typedef struct _VHD_FOOTER VHD_FOOTER

Enumeration Type Documentation

VHD_TYPE

enum VHD_TYPE

Enumerator
VHD_FIXED
VHD_DYNAMIC
VHD_DIFFERENCING

Definition at line 47 of file disk.c.

{
    VHD_FIXED           = 2,
    VHD_DYNAMIC         = 3,
    VHD_DIFFERENCING    = 4,
};

Function Documentation

C_ASSERT()

C_ASSERT

(

sizeof(VHD_FOOTER)

= =0x200

)

DiskCtrlCleanup()

VOID DiskCtrlCleanup

(

VOID

)

Definition at line 624 of file disk.c.

{
    ULONG DiskNumber;
 
    /* Unmount all the present floppy disk drives */
    for (DiskNumber = 0; DiskNumber < DiskMountInfo[FLOPPY_DISK].NumDisks; ++DiskNumber)
    {
        if (IsDiskPresent(&DiskMountInfo[FLOPPY_DISK].DiskArray[DiskNumber]))
            UnmountDisk(FLOPPY_DISK, DiskNumber);
    }
 
    /* Unmount all the present hard disk drives */
    for (DiskNumber = 0; DiskNumber < DiskMountInfo[HARD_DISK].NumDisks; ++DiskNumber)
    {
        if (IsDiskPresent(&DiskMountInfo[HARD_DISK].DiskArray[DiskNumber]))
            UnmountDisk(HARD_DISK, DiskNumber);
    }
}

Referenced by EmulatorCleanup().

DiskCtrlInitialize()

BOOLEAN DiskCtrlInitialize

(

VOID

)

Definition at line 619 of file disk.c.

{
    return TRUE;
}

Referenced by EmulatorInitialize().

IsDiskPresent()

BOOLEAN IsDiskPresent

(

IN PDISK_IMAGE

DiskImage

)

Definition at line 321 of file disk.c.

{
    ASSERT(DiskImage);
    return (DiskImage->hDisk != INVALID_HANDLE_VALUE && DiskImage->hDisk != NULL);
}

Referenced by BiosDiskService(), DiskCtrlCleanup(), MountDisk(), and UnmountDisk().

MountDisk()

BOOLEAN MountDisk	(	IN DISK_TYPE	DiskType,
		IN ULONG	DiskNumber,
		IN PCWSTR	FileName,
		IN BOOLEAN	ReadOnly
	)

Definition at line 500 of file disk.c.

{
    BOOLEAN Success = FALSE;
    PDISK_IMAGE DiskImage;
    HANDLE hFile;
 
    BY_HANDLE_FILE_INFORMATION FileInformation;
 
    ASSERT(DiskType < MAX_DISK_TYPE);
 
    if (DiskNumber >= DiskMountInfo[DiskType].NumDisks)
    {
        DisplayMessage(L"MountDisk: Disk number %d:%d invalid.", DiskType, DiskNumber);
        return FALSE;
    }
 
    DiskImage = &DiskMountInfo[DiskType].DiskArray[DiskNumber];
    if (IsDiskPresent(DiskImage))
    {
        DPRINT1("MountDisk: Disk %d:%d:0x%p already in use, recycling...\n", DiskType, DiskNumber, DiskImage);
        UnmountDisk(DiskType, DiskNumber);
    }
 
    /* Try to open the file */
    SetLastError(0); // For debugging purposes
    hFile = CreateFileW(FileName,
                        GENERIC_READ | (ReadOnly ? 0 : GENERIC_WRITE),
                        (ReadOnly ? FILE_SHARE_READ : 0),
                        NULL,
                        OPEN_EXISTING,
                        FILE_ATTRIBUTE_NORMAL,
                        NULL);
    DPRINT1("File '%S' opening %s ; GetLastError() = %u\n",
            FileName, hFile != INVALID_HANDLE_VALUE ? "succeeded" : "failed", GetLastError());
 
    /* If we failed, bail out */
    if (hFile == INVALID_HANDLE_VALUE)
    {
        DisplayMessage(L"MountDisk: Error when opening disk file '%s' (Error: %u).", FileName, GetLastError());
        return FALSE;
    }
 
    /* OK, we have a handle to the file */
 
    /*
     * Check that it is really a file, and not a physical drive.
     * For obvious security reasons, we do not want to be able to
     * write directly to physical drives.
     *
     * Redundant checks
     */
    SetLastError(0);
    if (!GetFileInformationByHandle(hFile, &FileInformation) &&
        GetLastError() == ERROR_INVALID_FUNCTION)
    {
        /* Objects other than real files are not supported */
        DisplayMessage(L"MountDisk: '%s' is not a valid disk file.", FileName);
        goto Quit;
    }
    SetLastError(0);
    if (GetFileSize(hFile, NULL) == INVALID_FILE_SIZE &&
        GetLastError() == ERROR_INVALID_FUNCTION)
    {
        /* Objects other than real files are not supported */
        DisplayMessage(L"MountDisk: '%s' is not a valid disk file.", FileName);
        goto Quit;
    }
 
    /* Success, mount the image */
    if (!DiskMountInfo[DiskType].MountDiskHelper(DiskImage, hFile))
    {
        DisplayMessage(L"MountDisk: Failed to mount disk file '%s' in 0x%p.", FileName, DiskImage);
        goto Quit;
    }
 
    /* Update its read/write state */
    DiskImage->ReadOnly = ReadOnly;
 
    Success = TRUE;
 
Quit:
    if (!Success) FileClose(hFile);
    return Success;
}

Referenced by EmulatorInitialize(), and MountFloppy().

MountFDI()

static BOOLEAN MountFDI ( IN PDISK_IMAGE  DiskImage, IN HANDLE  hFile  )

static

Definition at line 190 of file disk.c.

{
    ULONG  FileSize;
    USHORT i;
 
    /*
     * Retrieve the size of the file. In NTVDM we will handle files
     * of maximum 1Mb so we can largely use GetFileSize only.
     */
    FileSize = GetFileSize(hFile, NULL);
    if (FileSize == INVALID_FILE_SIZE && GetLastError() != ERROR_SUCCESS)
    {
        /* We failed, bail out */
        DisplayMessage(L"MountFDI: Error when retrieving file size, or size too large (%d).", FileSize);
        return FALSE;
    }
 
    /* Convert the size in kB */
    FileSize /= 1024;
 
    /* Find the floppy format in the list, and mount it if found */
    for (i = 0; i < ARRAYSIZE(DiskGeometryList); ++i)
    {
        if (DiskGeometryList[i].ksize     == FileSize ||
            DiskGeometryList[i].ksize + 1 == FileSize)
        {
            /* Found, mount it */
            DiskImage->DiskType = DiskGeometryList[i].biosval;
            DiskImage->DiskInfo.Cylinders = DiskGeometryList[i].cylcount;
            DiskImage->DiskInfo.Heads     = DiskGeometryList[i].headscyl;
            DiskImage->DiskInfo.Sectors   = DiskGeometryList[i].secttrack;
            DiskImage->DiskInfo.SectorSize = HackSectorSize;
 
            /* Set the file pointer to the beginning */
            SetFilePointer(hFile, 0, NULL, FILE_BEGIN);
 
            DiskImage->hDisk = hFile;
            return TRUE;
        }
    }
 
    /* If we are here, we failed to find a suitable format. Bail out. */
    DisplayMessage(L"MountFDI: Floppy image of invalid size %d.", FileSize);
    return FALSE;
}

MountHDD()

static BOOLEAN MountHDD ( IN PDISK_IMAGE  DiskImage, IN HANDLE  hFile  )

static

Definition at line 246 of file disk.c.

{
    /**** Support for VHD fixed disks ****/
    DWORD FilePointer, BytesToRead;
    VHD_FOOTER vhd_footer;
 
    /* Go to the end of the file and retrieve the footer */
    FilePointer = SetFilePointer(hFile, -(LONG)sizeof(VHD_FOOTER), NULL, FILE_END);
    if (FilePointer == INVALID_SET_FILE_POINTER)
    {
        DPRINT1("MountHDD: Error when seeking HDD footer, last error = %d\n", GetLastError());
        return FALSE;
    }
 
    /* Read footer */
    // FIXME: We may consider just mapping section to the file...
    BytesToRead = sizeof(VHD_FOOTER);
    if (!ReadFile(hFile, &vhd_footer, BytesToRead, &BytesToRead, NULL))
    {
        DPRINT1("MountHDD: Error when reading HDD footer, last error = %d\n", GetLastError());
        return FALSE;
    }
 
    /* Perform validity checks */
    if (RtlCompareMemory(vhd_footer.creator, "conectix",
                         sizeof(vhd_footer.creator)) != sizeof(vhd_footer.creator))
    {
        DisplayMessage(L"MountHDD: Invalid HDD image (expected VHD).");
        return FALSE;
    }
    if (vhd_footer.version != 0x00000100 &&
        vhd_footer.version != 0x00000500) // FIXME: Big endian!
    {
        DisplayMessage(L"MountHDD: VHD HDD image of unexpected version %d.", vhd_footer.version);
        return FALSE;
    }
    if (RtlUlongByteSwap(vhd_footer.type) != VHD_FIXED) // FIXME: Big endian!
    {
        DisplayMessage(L"MountHDD: Only VHD HDD fixed images are supported.");
        return FALSE;
    }
    if (vhd_footer.data_offset != 0xFFFFFFFFFFFFFFFF)
    {
        DisplayMessage(L"MountHDD: Unexpected data offset for VHD HDD fixed image.");
        return FALSE;
    }
    if (vhd_footer.orig_size != vhd_footer.size)
    {
        DisplayMessage(L"MountHDD: VHD HDD fixed image size should be the same as its original size.");
        return FALSE;
    }
    // FIXME: Checksum!
 
    /* Found, mount it */
    DiskImage->DiskType = 0;
    DiskImage->DiskInfo.Cylinders = RtlUshortByteSwap(vhd_footer.cyls); // FIXME: Big endian!
    DiskImage->DiskInfo.Heads     = vhd_footer.heads;
    DiskImage->DiskInfo.Sectors   = vhd_footer.secs_per_cyl;
    DiskImage->DiskInfo.SectorSize = RtlUlonglongByteSwap(vhd_footer.size) / // FIXME: Big endian!
                                     DiskImage->DiskInfo.Cylinders /
                                     DiskImage->DiskInfo.Heads / DiskImage->DiskInfo.Sectors;
 
    /* Set the file pointer to the beginning */
    SetFilePointer(hFile, 0, NULL, FILE_BEGIN);
 
    DiskImage->hDisk = hFile;
    return TRUE;
}

ReadDisk()

BYTE ReadDisk	(	IN PDISK_IMAGE	DiskImage,
		IN WORD	Cylinder,
		IN BYTE	Head,
		IN BYTE	Sector,
		IN BYTE	NumSectors
	)

Definition at line 359 of file disk.c.

{
    BYTE Result;
    DWORD BytesToRead;
 
    PVOID LocalBuffer;
    BYTE StaticBuffer[1024];
 
    /* Read the sectors */
    Result = SeekDisk(DiskImage, Cylinder, Head, Sector);
    if (Result != 0x00)
        return Result;
 
    BytesToRead = (DWORD)NumSectors * DiskImage->DiskInfo.SectorSize;
 
    // FIXME: Consider just looping around filling each time the buffer...
 
    if (BytesToRead <= sizeof(StaticBuffer))
    {
        LocalBuffer = StaticBuffer;
    }
    else
    {
        LocalBuffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, BytesToRead);
        ASSERT(LocalBuffer != NULL);
    }
 
    if (ReadFile(DiskImage->hDisk, LocalBuffer, BytesToRead, &BytesToRead, NULL))
    {
        /* Write to the memory */
        EmulatorWriteMemory(&EmulatorContext,
                            TO_LINEAR(getES(), getBX()),
                            LocalBuffer,
                            BytesToRead);
 
        Result = 0x00;
    }
    else
    {
        Result = 0x04;
    }
 
    if (LocalBuffer != StaticBuffer)
        RtlFreeHeap(RtlGetProcessHeap(), 0, LocalBuffer);
 
    /* Return success or error */
    return Result;
}

Referenced by BiosDiskService().

RetrieveDisk()

PDISK_IMAGE RetrieveDisk	(	IN DISK_TYPE	DiskType,
		IN ULONG	DiskNumber
	)

Definition at line 485 of file disk.c.

{
    ASSERT(DiskType < MAX_DISK_TYPE);
 
    if (DiskNumber >= DiskMountInfo[DiskType].NumDisks)
    {
        DisplayMessage(L"RetrieveDisk: Disk number %d:%d invalid.", DiskType, DiskNumber);
        return NULL;
    }
 
    return &DiskMountInfo[DiskType].DiskArray[DiskNumber];
}

Referenced by DiskBios32Initialize().

SeekDisk()

BYTE SeekDisk	(	IN PDISK_IMAGE	DiskImage,
		IN WORD	Cylinder,
		IN BYTE	Head,
		IN BYTE	Sector
	)

Definition at line 328 of file disk.c.

{
    DWORD FilePointer;
 
    /* Check that the sector number is 1-based */
    // FIXME: Or do it in the caller?
    if (Sector == 0)
    {
        /* Return error */
        return 0x01;
    }
 
    /* Set position */
    // Compute the offset
    FilePointer = (DWORD)((DWORD)((DWORD)Cylinder * DiskImage->DiskInfo.Heads + Head)
                    * DiskImage->DiskInfo.Sectors + (Sector - 1))
                    * DiskImage->DiskInfo.SectorSize;
    FilePointer = SetFilePointer(DiskImage->hDisk, FilePointer, NULL, FILE_BEGIN);
    if (FilePointer == INVALID_SET_FILE_POINTER)
    {
        /* Return error */
        return 0x40;
    }
 
    return 0x00;
}

Referenced by BiosDiskService(), ReadDisk(), and WriteDisk().

UnmountDisk()

BOOLEAN UnmountDisk	(	IN DISK_TYPE	DiskType,
		IN ULONG	DiskNumber
	)

Definition at line 589 of file disk.c.

{
    PDISK_IMAGE DiskImage;
 
    ASSERT(DiskType < MAX_DISK_TYPE);
 
    if (DiskNumber >= DiskMountInfo[DiskType].NumDisks)
    {
        DisplayMessage(L"UnmountDisk: Disk number %d:%d invalid.", DiskType, DiskNumber);
        return FALSE;
    }
 
    DiskImage = &DiskMountInfo[DiskType].DiskArray[DiskNumber];
    if (!IsDiskPresent(DiskImage))
    {
        DPRINT1("UnmountDisk: Disk %d:%d:0x%p is already unmounted\n", DiskType, DiskNumber, DiskImage);
        return FALSE;
    }
 
    /* Flush the image and unmount it */
    FlushFileBuffers(DiskImage->hDisk);
    FileClose(DiskImage->hDisk);
    DiskImage->hDisk = NULL;
    return TRUE;
}

Referenced by DiskCtrlCleanup(), EjectFloppy(), and MountDisk().

WriteDisk()

BYTE WriteDisk	(	IN PDISK_IMAGE	DiskImage,
		IN WORD	Cylinder,
		IN BYTE	Head,
		IN BYTE	Sector,
		IN BYTE	NumSectors
	)

Definition at line 413 of file disk.c.

{
    BYTE Result;
    DWORD BytesToWrite;
 
    PVOID LocalBuffer;
    BYTE StaticBuffer[1024];
 
    /* Check for write protection */
    if (DiskImage->ReadOnly)
    {
        /* Return error */
        return 0x03;
    }
 
    /* Write the sectors */
    Result = SeekDisk(DiskImage, Cylinder, Head, Sector);
    if (Result != 0x00)
        return Result;
 
    BytesToWrite = (DWORD)NumSectors * DiskImage->DiskInfo.SectorSize;
 
    // FIXME: Consider just looping around filling each time the buffer...
 
    if (BytesToWrite <= sizeof(StaticBuffer))
    {
        LocalBuffer = StaticBuffer;
    }
    else
    {
        LocalBuffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, BytesToWrite);
        ASSERT(LocalBuffer != NULL);
    }
 
    /* Read from the memory */
    EmulatorReadMemory(&EmulatorContext,
                       TO_LINEAR(getES(), getBX()),
                       LocalBuffer,
                       BytesToWrite);
 
    if (WriteFile(DiskImage->hDisk, LocalBuffer, BytesToWrite, &BytesToWrite, NULL))
        Result = 0x00;
    else
        Result = 0x04;
 
    if (LocalBuffer != StaticBuffer)
        RtlFreeHeap(RtlGetProcessHeap(), 0, LocalBuffer);
 
    /* Return success or error */
    return Result;
}

Referenced by BiosDiskService().

Variable Documentation

DiskGeometryList

DISK_GEO DiskGeometryList[]

static

Initial value:

=
{
    { 160,  8, 1, 40, 0},
    { 180,  9, 1, 40, 0},
    { 200, 10, 1, 40, 0},
    { 320,  8, 2, 40, 1},
    { 360,  9, 2, 40, 1},
    { 400, 10, 2, 40, 1},
    { 720,  9, 2, 80, 3},
    {1200, 15, 2, 80, 2},
    {1440, 18, 2, 80, 4},
    {2880, 36, 2, 80, 6},
}

Definition at line 175 of file disk.c.

Referenced by MountFDI().

DiskMountInfo

DISK_MOUNT_INFO DiskMountInfo[MAX_DISK_TYPE]

static

Initial value:

=
{
    {XDCFloppyDrive, _ARRAYSIZE(XDCFloppyDrive), MountFDI},
    {XDCHardDrive  , _ARRAYSIZE(XDCHardDrive)  , MountHDD},
}

Definition at line 478 of file disk.c.

Referenced by DiskCtrlCleanup(), MountDisk(), RetrieveDisk(), and UnmountDisk().

HackSectorSize

WORD HackSectorSize = 512

static

Definition at line 174 of file disk.c.

Referenced by MountFDI().

XDCFloppyDrive

DISK_IMAGE XDCFloppyDrive[4]

static

Definition at line 161 of file disk.c.

XDCHardDrive

DISK_IMAGE XDCHardDrive[4]

static

Definition at line 243 of file disk.c.