CcCopyRead_drv.c File Reference

#include <kmt_test.h>
#include <debug.h>

Include dependency graph for CcCopyRead_drv.c:

Go to the source code of this file.

Classes
struct	_TEST_FCB

Macros
#define	NDEBUG
#define	ok_read_called(_Offset, _Length)
#define	ok_read_not_called()   ok(!ReadCalledNonCached, "CcCopyRead shouldn't have triggered a read.\n")

Typedefs
typedef struct _TEST_FCB	TEST_FCB
typedef struct _TEST_FCB *	PTEST_FCB

Functions
static BOOLEAN NTAPI	FastIoRead (_In_ PFILE_OBJECT FileObject, _In_ PLARGE_INTEGER FileOffset, _In_ ULONG Length, _In_ BOOLEAN Wait, _In_ ULONG LockKey, _Out_ PVOID Buffer, _Out_ PIO_STATUS_BLOCK IoStatus, _In_ PDEVICE_OBJECT DeviceObject)
NTSTATUS	TestEntry (_In_ PDRIVER_OBJECT DriverObject, _In_ PCUNICODE_STRING RegistryPath, _Out_ PCWSTR *DeviceName, _Inout_ INT *Flags)
VOID	TestUnload (_In_ PDRIVER_OBJECT DriverObject)
BOOLEAN NTAPI	AcquireForLazyWrite (_In_ PVOID Context, _In_ BOOLEAN Wait)
VOID NTAPI	ReleaseFromLazyWrite (_In_ PVOID Context)
BOOLEAN NTAPI	AcquireForReadAhead (_In_ PVOID Context, _In_ BOOLEAN Wait)
VOID NTAPI	ReleaseFromReadAhead (_In_ PVOID Context)
static PVOID	MapAndLockUserBuffer (_In_ _Out_ PIRP Irp, _In_ ULONG BufferLength)
static void	reset_read (void)
static VOID	Test_CcCopyRead (PFILE_OBJECT FileObject)
static NTSTATUS	TestIrpHandler (_In_ PDEVICE_OBJECT DeviceObject, _In_ PIRP Irp, _In_ PIO_STACK_LOCATION IoStack)

Variables
static PFILE_OBJECT	TestFileObject
static PDEVICE_OBJECT	TestDeviceObject
static KMT_IRP_HANDLER	TestIrpHandler
static FAST_IO_DISPATCH	TestFastIoDispatch
static BOOLEAN	InBehaviourTest
BOOLEAN	ReadCalledNonCached
LARGE_INTEGER	ReadOffset
ULONG	ReadLength
static CACHE_MANAGER_CALLBACKS	Callbacks

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file CcCopyRead_drv.c.

ok_read_called

#define ok_read_called	(		_Offset,
			_Length
	)

Value:

    do {                                               \
    ok(ReadCalledNonCached, "CcCopyRead should have triggerred a  non-cached read.\n");     \
    ok_eq_longlong(ReadOffset.QuadPart, _Offset);                                           \
    ok_eq_ulong(ReadLength, _Length);                                                       \
}while(0)

Definition at line 166 of file CcCopyRead_drv.c.

ok_read_not_called

#define ok_read_not_called

(

)

ok(!ReadCalledNonCached, "CcCopyRead shouldn't have triggered a read.\n")

Definition at line 172 of file CcCopyRead_drv.c.

Typedef Documentation

PTEST_FCB

typedef struct _TEST_FCB * PTEST_FCB

TEST_FCB

typedef struct _TEST_FCB TEST_FCB

Function Documentation

AcquireForLazyWrite()

BOOLEAN NTAPI AcquireForLazyWrite	(	_In_ PVOID	Context,
		_In_ BOOLEAN	Wait
	)

Definition at line 86 of file CcCopyRead_drv.c.

{
    return TRUE;
}

AcquireForReadAhead()

BOOLEAN NTAPI AcquireForReadAhead	(	_In_ PVOID	Context,
		_In_ BOOLEAN	Wait
	)

Definition at line 103 of file CcCopyRead_drv.c.

{
    return TRUE;
}

FastIoRead()

static BOOLEAN NTAPI FastIoRead ( _In_ PFILE_OBJECT  FileObject, _In_ PLARGE_INTEGER  FileOffset, _In_ ULONG  Length, _In_ BOOLEAN  Wait, _In_ ULONG  LockKey, _Out_ PVOID  Buffer, _Out_ PIO_STATUS_BLOCK  IoStatus, _In_ PDEVICE_OBJECT  DeviceObject  )

static

Definition at line 34 of file CcCopyRead_drv.c.

{
    IoStatus->Status = STATUS_NOT_SUPPORTED;
    return FALSE;
}

Referenced by TestEntry().

MapAndLockUserBuffer()

static PVOID MapAndLockUserBuffer ( _In_ _Out_ PIRP  Irp, _In_ ULONG  BufferLength  )

static

Definition at line 127 of file CcCopyRead_drv.c.

{
    PMDL Mdl;
 
    if (Irp->MdlAddress == NULL)
    {
        Mdl = IoAllocateMdl(Irp->UserBuffer, BufferLength, FALSE, FALSE, Irp);
        if (Mdl == NULL)
        {
            return NULL;
        }
 
        _SEH2_TRY
        {
            MmProbeAndLockPages(Mdl, Irp->RequestorMode, IoWriteAccess);
        }
        _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
        {
            IoFreeMdl(Mdl);
            Irp->MdlAddress = NULL;
            _SEH2_YIELD(return NULL);
        }
        _SEH2_END;
    }
 
    return MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority);
}

Referenced by TestIrpHandler().

ReleaseFromLazyWrite()

VOID NTAPI ReleaseFromLazyWrite

(

_In_ PVOID

Context

)

Definition at line 95 of file CcCopyRead_drv.c.

{
    return;
}

ReleaseFromReadAhead()

VOID NTAPI ReleaseFromReadAhead

(

_In_ PVOID

Context

)

Definition at line 112 of file CcCopyRead_drv.c.

{
    return;
}

reset_read()

static void reset_read ( void  )

static

Definition at line 159 of file CcCopyRead_drv.c.

{
    ReadCalledNonCached = FALSE;
    ReadOffset.QuadPart = MAXLONGLONG;
    ReadLength = MAXULONG;
}

Referenced by Test_CcCopyRead().

Test_CcCopyRead()

static VOID Test_CcCopyRead ( PFILE_OBJECT  FileObject )

static

Definition at line 176 of file CcCopyRead_drv.c.

{
 
    BOOLEAN Ret;
    LARGE_INTEGER Offset;
    CHAR Buffer[10];
    IO_STATUS_BLOCK IoStatus;
 
    memset(Buffer, 0xAC, 10);
 
    /* Test bogus file object & file offset */
    Ret = 'x';
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, NULL, 0, FALSE, NULL, &IoStatus);
    KmtEndSeh(STATUS_ACCESS_VIOLATION);
    ok_eq_char(Ret, 'x');
 
    Ret = 'x';
    Offset.QuadPart = 0;
    KmtStartSeh()
        Ret = CcCopyRead(NULL, &Offset, 10, FALSE, Buffer, &IoStatus);
    KmtEndSeh(STATUS_ACCESS_VIOLATION);
    ok_eq_char(Ret, 'x');
 
    /* What happens on invalid buffer */
    Ret = 'x';
    Offset.QuadPart = 0;
    memset(&IoStatus, 0xAB, sizeof(IoStatus));
    reset_read();
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 0, TRUE, NULL, &IoStatus);
    KmtEndSeh(STATUS_SUCCESS);
    ok_bool_true(Ret, "CcCopyRead(0, NULL) should succeed\n");
    /* When there is nothing to write, there is no reason to read */
    ok_read_not_called();
    ok_eq_hex(IoStatus.Status, STATUS_SUCCESS);
    ok_eq_ulongptr(IoStatus.Information, 0);
 
    Ret = 'x';
    Offset.QuadPart = 0;
    memset(&IoStatus, 0xAB, sizeof(IoStatus));
    reset_read();
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 10, TRUE, NULL, &IoStatus);
    KmtEndSeh(STATUS_INVALID_USER_BUFFER);
    ok_eq_char(Ret, 'x');
    /* This raises an exception, but it actually triggered a read */
    ok_read_called(0, PAGE_SIZE);
    ok_eq_hex(IoStatus.Status, 0xABABABAB);
    ok_eq_ulongptr(IoStatus.Information, (ULONG_PTR)0xABABABABABABABAB);
 
    /* So this one succeeds, as the page is now resident */
    Ret = 'x';
    Offset.QuadPart = 0;
    memset(&IoStatus, 0xAB, sizeof(IoStatus));
    reset_read();
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 10, FALSE, Buffer, &IoStatus);
    KmtEndSeh(STATUS_SUCCESS);
    ok_bool_true(Ret, "CcCopyRead should succeed\n");
    /* But there was no read triggered, as the page is already resident. */
    ok_read_not_called();
    ok_eq_hex(IoStatus.Status, STATUS_SUCCESS);
    ok_eq_ulongptr(IoStatus.Information, 10);
 
    /* But this one doesn't */
    Ret = 'x';
    Offset.QuadPart = PAGE_SIZE;
    memset(&IoStatus, 0xAB, sizeof(IoStatus));
    reset_read();
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 10, FALSE, Buffer, &IoStatus);
    KmtEndSeh(STATUS_SUCCESS);
    ok_bool_false(Ret, "CcCopyRead should fail\n");
    /* But it triggered a read anyway. */
    ok_read_called(PAGE_SIZE, PAGE_SIZE);
    ok_eq_hex(IoStatus.Status, 0xABABABAB);
    ok_eq_ulongptr(IoStatus.Information, (ULONG_PTR)0xABABABABABABABAB);
 
    /* Of course, waiting for it succeeds and triggers the read */
    Ret = 'x';
    Offset.QuadPart = PAGE_SIZE * 2;
    memset(&IoStatus, 0xAB, sizeof(IoStatus));
    reset_read();
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 10, TRUE, Buffer, &IoStatus);
    KmtEndSeh(STATUS_SUCCESS);
    ok_bool_true(Ret, "CcCopyRead should succeed\n");
    ok_read_called(PAGE_SIZE * 2, PAGE_SIZE);
    ok_eq_hex(IoStatus.Status, STATUS_SUCCESS);
    ok_eq_ulongptr(IoStatus.Information, 10);
 
    /* Try the same without a status block */
    Ret = 'x';
    Offset.QuadPart = PAGE_SIZE * 2;
    KmtStartSeh()
        Ret = CcCopyRead(FileObject, &Offset, 10, TRUE, Buffer, NULL);
    KmtEndSeh(STATUS_ACCESS_VIOLATION);
    ok_eq_char(Ret, 'x');
}

TestEntry()

NTSTATUS TestEntry	(	_In_ PDRIVER_OBJECT	DriverObject,
		_In_ PCUNICODE_STRING	RegistryPath,
		_Out_ PCWSTR *	DeviceName,
		_Inout_ INT *	Flags
	)

Definition at line 49 of file CcCopyRead_drv.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(RegistryPath);
 
    *DeviceName = L"CcCopyRead";
    *Flags = TESTENTRY_NO_EXCLUSIVE_DEVICE |
             TESTENTRY_BUFFERED_IO_DEVICE |
             TESTENTRY_NO_READONLY_DEVICE;
 
    KmtRegisterIrpHandler(IRP_MJ_CLEANUP, NULL, TestIrpHandler);
    KmtRegisterIrpHandler(IRP_MJ_CREATE, NULL, TestIrpHandler);
    KmtRegisterIrpHandler(IRP_MJ_READ, NULL, TestIrpHandler);
 
    TestFastIoDispatch.FastIoRead = FastIoRead;
    DriverObject->FastIoDispatch = &TestFastIoDispatch;
 
 
    return Status;
}

TestIrpHandler()

static NTSTATUS TestIrpHandler ( _In_ PDEVICE_OBJECT  DeviceObject, _In_ PIRP  Irp, _In_ PIO_STACK_LOCATION  IoStack  )

static

Definition at line 280 of file CcCopyRead_drv.c.

{
    LARGE_INTEGER Zero = RTL_CONSTANT_LARGE_INTEGER(0LL);
    NTSTATUS Status;
    PTEST_FCB Fcb;
    CACHE_UNINITIALIZE_EVENT CacheUninitEvent;
 
    PAGED_CODE();
 
    DPRINT("IRP %x/%x\n", IoStack->MajorFunction, IoStack->MinorFunction);
    ASSERT(IoStack->MajorFunction == IRP_MJ_CLEANUP ||
           IoStack->MajorFunction == IRP_MJ_CREATE ||
           IoStack->MajorFunction == IRP_MJ_READ);
 
    Status = STATUS_NOT_SUPPORTED;
    Irp->IoStatus.Information = 0;
 
    if (IoStack->MajorFunction == IRP_MJ_CREATE)
    {
        ok_irql(PASSIVE_LEVEL);
 
        if (IoStack->FileObject->FileName.Length >= 2 * sizeof(WCHAR))
        {
            TestDeviceObject = DeviceObject;
            TestFileObject = IoStack->FileObject;
        }
        Fcb = ExAllocatePoolWithTag(NonPagedPool, sizeof(*Fcb), 'FwrI');
        RtlZeroMemory(Fcb, sizeof(*Fcb));
        ExInitializeFastMutex(&Fcb->HeaderMutex);
        FsRtlSetupAdvancedHeader(&Fcb->Header, &Fcb->HeaderMutex);
        Fcb->BigFile = FALSE;
        if (IoStack->FileObject->FileName.Length >= 2 * sizeof(WCHAR) &&
            IoStack->FileObject->FileName.Buffer[1] == 'B')
        {
            Fcb->Header.AllocationSize.QuadPart = 1000000;
            Fcb->Header.FileSize.QuadPart = 1000000;
            Fcb->Header.ValidDataLength.QuadPart = 1000000;
        }
        else if (IoStack->FileObject->FileName.Length >= 2 * sizeof(WCHAR) &&
                 IoStack->FileObject->FileName.Buffer[1] == 'S')
        {
            Fcb->Header.AllocationSize.QuadPart = 1004;
            Fcb->Header.FileSize.QuadPart = 1004;
            Fcb->Header.ValidDataLength.QuadPart = 1004;
        }
        else if (IoStack->FileObject->FileName.Length >= 2 * sizeof(WCHAR) &&
                 IoStack->FileObject->FileName.Buffer[1] == 'R')
        {
            Fcb->Header.AllocationSize.QuadPart = 62;
            Fcb->Header.FileSize.QuadPart = 62;
            Fcb->Header.ValidDataLength.QuadPart = 62;
        }
        else if (IoStack->FileObject->FileName.Length >= 2 * sizeof(WCHAR) &&
                 IoStack->FileObject->FileName.Buffer[1] == 'F')
        {
            Fcb->Header.AllocationSize.QuadPart = 4294967296;
            Fcb->Header.FileSize.QuadPart = 4294967296;
            Fcb->Header.ValidDataLength.QuadPart = 4294967296;
            Fcb->BigFile = TRUE;
        }
        else
        {
            Fcb->Header.AllocationSize.QuadPart = 512;
            Fcb->Header.FileSize.QuadPart = 512;
            Fcb->Header.ValidDataLength.QuadPart = 512;
        }
        Fcb->Header.IsFastIoPossible = FastIoIsNotPossible;
        IoStack->FileObject->FsContext = Fcb;
        IoStack->FileObject->SectionObjectPointer = &Fcb->SectionObjectPointers;
 
        CcInitializeCacheMap(IoStack->FileObject,
                             (PCC_FILE_SIZES)&Fcb->Header.AllocationSize,
                             FALSE, &Callbacks, NULL);
 
        Irp->IoStatus.Information = FILE_OPENED;
        Status = STATUS_SUCCESS;
    }
    else if (IoStack->MajorFunction == IRP_MJ_READ)
    {
        BOOLEAN Ret;
        ULONG Length;
        PVOID Buffer;
        LARGE_INTEGER Offset;
        static const UNICODE_STRING BehaviourTestFileName = RTL_CONSTANT_STRING(L"\\BehaviourTestFile");
 
        Offset = IoStack->Parameters.Read.ByteOffset;
        Length = IoStack->Parameters.Read.Length;
        Fcb = IoStack->FileObject->FsContext;
 
        ok_eq_pointer(DeviceObject, TestDeviceObject);
        ok_eq_pointer(IoStack->FileObject, TestFileObject);
 
        /* Check special file name */
        InBehaviourTest = RtlCompareUnicodeString(&IoStack->FileObject->FileName, &BehaviourTestFileName, TRUE) == 0;
 
        if (!FlagOn(Irp->Flags, IRP_NOCACHE))
        {
            ok_irql(PASSIVE_LEVEL);
 
            if (InBehaviourTest)
            {
                Test_CcCopyRead(IoStack->FileObject);
                Status = Irp->IoStatus.Status = STATUS_SUCCESS;
            }
            else
            {
                /* We don't want to test alignement for big files (not the purpose of the test) */
                if (!Fcb->BigFile)
                {
                    ok(Offset.QuadPart % PAGE_SIZE != 0, "Offset is aligned: %I64i\n", Offset.QuadPart);
                    ok(Length % PAGE_SIZE != 0, "Length is aligned: %I64i\n", Length);
                }
 
                Buffer = Irp->AssociatedIrp.SystemBuffer;
                ok(Buffer != NULL, "Null pointer!\n");
 
                _SEH2_TRY
                {
                    Ret = CcCopyRead(IoStack->FileObject, &Offset, Length, TRUE, Buffer,
                                    &Irp->IoStatus);
                    ok_bool_true(Ret, "CcCopyRead");
                }
                _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
                {
                    Irp->IoStatus.Status = _SEH2_GetExceptionCode();
                }
                _SEH2_END;
 
                Status = Irp->IoStatus.Status;
 
                if (NT_SUCCESS(Status))
                {
                    if (Offset.QuadPart <= 1000LL && Offset.QuadPart + Length > 1000LL)
                    {
                        ok_eq_hex(*(PUSHORT)((ULONG_PTR)Buffer + (ULONG_PTR)(1000LL - Offset.QuadPart)), 0xFFFF);
                    }
                    else
                    {
                        ok_eq_hex(*(PUSHORT)Buffer, 0xBABA);
                    }
                }
            }
        }
        else
        {
            PMDL Mdl;
 
            ReadCalledNonCached = TRUE;
            ReadOffset = Offset;
            ReadLength = Length;
 
            ok_irql(APC_LEVEL);
            ok((Offset.QuadPart % PAGE_SIZE == 0 || Offset.QuadPart == 0), "Offset is not aligned: %I64i\n", Offset.QuadPart);
            ok(Length % PAGE_SIZE == 0, "Length is not aligned: %I64i\n", Length);
 
            ok(Irp->AssociatedIrp.SystemBuffer == NULL, "A SystemBuffer was allocated!\n");
            Buffer = MapAndLockUserBuffer(Irp, Length);
            ok(Buffer != NULL, "Null pointer!\n");
            RtlFillMemory(Buffer, Length, 0xBA);
 
            Status = STATUS_SUCCESS;
            if (Offset.QuadPart <= 1000LL && Offset.QuadPart + Length > 1000LL)
            {
                *(PUSHORT)((ULONG_PTR)Buffer + (ULONG_PTR)(1000LL - Offset.QuadPart)) = 0xFFFF;
            }
 
            Mdl = Irp->MdlAddress;
            ok(Mdl != NULL, "Null pointer for MDL!\n");
            ok((Mdl->MdlFlags & MDL_PAGES_LOCKED) != 0, "MDL not locked\n");
            ok((Mdl->MdlFlags & MDL_SOURCE_IS_NONPAGED_POOL) == 0, "MDL from non paged\n");
            ok((Mdl->MdlFlags & MDL_IO_PAGE_READ) != 0, "Non paging IO\n");
            ok((Irp->Flags & IRP_PAGING_IO) != 0, "Non paging IO\n");
        }
 
        if (NT_SUCCESS(Status))
        {
            Irp->IoStatus.Information = Length;
            IoStack->FileObject->CurrentByteOffset.QuadPart = Offset.QuadPart + Length;
        }
 
        InBehaviourTest = FALSE;
    }
    else if (IoStack->MajorFunction == IRP_MJ_CLEANUP)
    {
        ok_irql(PASSIVE_LEVEL);
        KeInitializeEvent(&CacheUninitEvent.Event, NotificationEvent, FALSE);
        CcUninitializeCacheMap(IoStack->FileObject, &Zero, &CacheUninitEvent);
        KeWaitForSingleObject(&CacheUninitEvent.Event, Executive, KernelMode, FALSE, NULL);
        Fcb = IoStack->FileObject->FsContext;
        ExFreePoolWithTag(Fcb, 'FwrI');
        IoStack->FileObject->FsContext = NULL;
        Status = STATUS_SUCCESS;
    }
 
    if (Status == STATUS_PENDING)
    {
        IoMarkIrpPending(Irp);
        IoCompleteRequest(Irp, IO_NO_INCREMENT);
        Status = STATUS_PENDING;
    }
    else
    {
        Irp->IoStatus.Status = Status;
        IoCompleteRequest(Irp, IO_NO_INCREMENT);
    }
 
    return Status;
}

TestUnload()

VOID TestUnload

(

_In_ PDRIVER_OBJECT

DriverObject

)

Definition at line 78 of file CcCopyRead_drv.c.

{
    PAGED_CODE();
}

Variable Documentation

Callbacks

CACHE_MANAGER_CALLBACKS Callbacks

static

Initial value:

= {
    AcquireForLazyWrite,
    ReleaseFromLazyWrite,
    AcquireForReadAhead,
    ReleaseFromReadAhead,
}

Definition at line 118 of file CcCopyRead_drv.c.

Referenced by TestIrpHandler().

InBehaviourTest

BOOLEAN InBehaviourTest

static

Definition at line 25 of file CcCopyRead_drv.c.

Referenced by TestIrpHandler().

ReadCalledNonCached

BOOLEAN ReadCalledNonCached

Definition at line 27 of file CcCopyRead_drv.c.

Referenced by reset_read(), and TestIrpHandler().

ReadLength

ULONG ReadLength

Definition at line 29 of file CcCopyRead_drv.c.

Referenced by CcCopyRead(), ElfBackupFile(), ElfpInitExistingFile(), ElfReadRecord(), ElfWriteRecord(), IntVideoPortGetLegacyResources(), LibTCPGetDataFromConnectionQueue(), LogfpReadFile(), LogfReadEvents(), MmMakeSegmentResident(), NtfsDiskRead(), NtfsRead(), NtfsReadAttribute(), OslIsPciDevicePresent(), ReadAttribute(), ReadLogBuffer(), reset_read(), RxCommonRead(), TestIrpHandler(), UDFCommonRead(), VfatReadDisk(), VfatReadDiskPartial(), and VTUTF8ChannelIRead().

ReadOffset

LARGE_INTEGER ReadOffset

Definition at line 28 of file CcCopyRead_drv.c.

TestDeviceObject

PDEVICE_OBJECT TestDeviceObject

static

Definition at line 22 of file CcCopyRead_drv.c.

Referenced by TestIrpHandler().

TestFastIoDispatch

FAST_IO_DISPATCH TestFastIoDispatch

static

Definition at line 24 of file CcCopyRead_drv.c.

Referenced by TestEntry().

TestFileObject

PFILE_OBJECT TestFileObject

static

Definition at line 21 of file CcCopyRead_drv.c.

Referenced by TestIrpHandler().

TestIrpHandler

KMT_IRP_HANDLER TestIrpHandler

static

Definition at line 23 of file CcCopyRead_drv.c.

Referenced by TestEntry().