csqtest.c File Reference

#include <ntddk.h>
#include <csq.h>

Include dependency graph for csqtest.c:

Go to the source code of this file.

Macros
#define	assert(x)
#define	KdPrint(x)   DbgPrint x
#define	NT_DEVICE_NAME   L"\\Device\\csqtest"
#define	DOS_DEVICE_NAME   L"\\??\\csqtest"

Functions
VOID NTAPI	CsqInsertIrp (PIO_CSQ Csq, PIRP Irp)
VOID NTAPI	CsqRemoveIrp (PIO_CSQ Csq, PIRP Irp)
PIRP NTAPI	CsqPeekNextIrp (PIO_CSQ Csq, PIRP Irp, PVOID PeekContext)
VOID NTAPI	CsqAcquireLock (PIO_CSQ Csq, PKIRQL Irql)
VOID NTAPI	CsqReleaseLock (PIO_CSQ Csq, KIRQL Irql)
VOID NTAPI	CsqCompleteCancelledIrp (PIO_CSQ Csq, PIRP Irp)
NTSTATUS NTAPI	CsqInsertIrpEx (PIO_CSQ Csq, PIRP Irp, PVOID InsertContext)
NTSTATUS NTAPI	DispatchCreateCloseCleanup (PDEVICE_OBJECT DeviceObject, PIRP Irp)
NTSTATUS NTAPI	DispatchReadWrite (PDEVICE_OBJECT DeviceObject, PIRP Irp)
NTSTATUS NTAPI	DispatchIoctl (PDEVICE_OBJECT DeviceObject, PIRP Irp)
VOID NTAPI	Unload (PDRIVER_OBJECT DriverObject)
NTSTATUS NTAPI	DriverEntry (PDRIVER_OBJECT DriverObject, PUNICODE_STRING RegistryPath)

Variables
IO_CSQ	Csq
LIST_ENTRY	IrpQueue
KSPIN_LOCK	IrpQueueLock
PDEVICE_OBJECT	DeviceObject

Macro Definition Documentation

assert

#define assert

(

x

)

Definition at line 13 of file csqtest.c.

DOS_DEVICE_NAME

#define DOS_DEVICE_NAME   L"\\??\\csqtest"

Definition at line 22 of file csqtest.c.

KdPrint

#define KdPrint

(

x

)

DbgPrint x

Definition at line 15 of file csqtest.c.

NT_DEVICE_NAME

#define NT_DEVICE_NAME   L"\\Device\\csqtest"

Definition at line 19 of file csqtest.c.

Function Documentation

CsqAcquireLock()

VOID NTAPI CsqAcquireLock	(	PIO_CSQ	Csq,
		PKIRQL	Irql
	)

Definition at line 62 of file csqtest.c.

{
    KdPrint(("Acquiring spin lock\n"));
    KeAcquireSpinLock(&IrpQueueLock, Irql);
}

CsqCompleteCancelledIrp()

VOID NTAPI CsqCompleteCancelledIrp	(	PIO_CSQ	Csq,
		PIRP	Irp
	)

Definition at line 74 of file csqtest.c.

{
    KdPrint(("cancelling irp 0x%x\n", Irp));
    Irp->IoStatus.Status = STATUS_CANCELLED;
    Irp->IoStatus.Information = 0;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}

Referenced by DriverEntry().

CsqInsertIrp()

VOID NTAPI CsqInsertIrp	(	PIO_CSQ	Csq,
		PIRP	Irp
	)

Definition at line 37 of file csqtest.c.

{
    KdPrint(("Inserting IRP 0x%x into CSQ\n", Irp));
    InsertTailList(&IrpQueue, &Irp->Tail.Overlay.ListEntry);
}

CsqInsertIrpEx()

NTSTATUS NTAPI CsqInsertIrpEx	(	PIO_CSQ	Csq,
		PIRP	Irp,
		PVOID	InsertContext
	)

Definition at line 82 of file csqtest.c.

{
    CsqInsertIrp(Csq, Irp);
    return STATUS_PENDING;
}

Referenced by IoCsqInitializeEx().

CsqPeekNextIrp()

PIRP NTAPI CsqPeekNextIrp	(	PIO_CSQ	Csq,
		PIRP	Irp,
		PVOID	PeekContext
	)

Definition at line 49 of file csqtest.c.

{
    KdPrint(("Peeking for next IRP\n"));
 
    if(Irp)
        return CONTAINING_RECORD(&Irp->Tail.Overlay.ListEntry.Flink, IRP, Tail.Overlay.ListEntry);
 
    if(IsListEmpty(&IrpQueue))
        return NULL;
 
    return CONTAINING_RECORD(IrpQueue.Flink, IRP, Tail.Overlay.ListEntry);
}

CsqReleaseLock()

VOID NTAPI CsqReleaseLock	(	PIO_CSQ	Csq,
		KIRQL	Irql
	)

Definition at line 68 of file csqtest.c.

{
    KdPrint(("Releasing spin lock\n"));
    KeReleaseSpinLock(&IrpQueueLock, Irql);
}

CsqRemoveIrp()

VOID NTAPI CsqRemoveIrp	(	PIO_CSQ	Csq,
		PIRP	Irp
	)

Definition at line 43 of file csqtest.c.

{
    KdPrint(("Removing IRP 0x%x from CSQ\n", Irp));
    RemoveEntryList(&Irp->Tail.Overlay.ListEntry);
}

DispatchCreateCloseCleanup()

NTSTATUS NTAPI DispatchCreateCloseCleanup	(	PDEVICE_OBJECT	DeviceObject,
		PIRP	Irp
	)

Definition at line 97 of file csqtest.c.

{
    PIO_STACK_LOCATION StackLocation = IoGetCurrentIrpStackLocation(Irp);
 
    if(StackLocation->MajorFunction == IRP_MJ_CLEANUP)
        {
            /* flush the irp queue */
            PIRP CurrentIrp;
 
            KdPrint(("csqtest: Cleanup received; flushing the IRP queue with cancel\n"));
 
            while((CurrentIrp = IoCsqRemoveNextIrp(&Csq, 0)))
                {
                    CurrentIrp->IoStatus.Status = STATUS_CANCELLED;
                    CurrentIrp->IoStatus.Information = 0;
 
                    IoCompleteRequest(CurrentIrp, IO_NO_INCREMENT);
                }
        }
 
    Irp->IoStatus.Status = STATUS_SUCCESS;
    Irp->IoStatus.Information = 0;
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
 
    return STATUS_SUCCESS;
}

Referenced by DriverEntry().

DispatchIoctl()

NTSTATUS NTAPI DispatchIoctl	(	PDEVICE_OBJECT	DeviceObject,
		PIRP	Irp
	)

Definition at line 135 of file csqtest.c.

{
    PIRP CurrentIrp;
 
    KdPrint(("csqtest: Ioctl received; flushing the IRP queue with success\n"));
 
    while((CurrentIrp = IoCsqRemoveNextIrp(&Csq, 0)))
        {
            CurrentIrp->IoStatus.Status = STATUS_SUCCESS;
            CurrentIrp->IoStatus.Information = 0;
 
            IoCompleteRequest(CurrentIrp, IO_NO_INCREMENT);
        }
 
    Irp->IoStatus.Status = STATUS_SUCCESS;
    Irp->IoStatus.Information = 0;
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
 
    return STATUS_SUCCESS;
}

Referenced by DriverEntry().

DispatchReadWrite()

NTSTATUS NTAPI DispatchReadWrite	(	PDEVICE_OBJECT	DeviceObject,
		PIRP	Irp
	)

Definition at line 125 of file csqtest.c.

{
    /* According to the cancel sample in the DDK, IoCsqInsertIrp() marks the irp pending */
    /* However, I think it's wrong. */
    IoMarkIrpPending(Irp);
    IoCsqInsertIrp(&Csq, Irp, 0);
 
    return STATUS_PENDING;
}

Referenced by DriverEntry().

DriverEntry()

NTSTATUS NTAPI DriverEntry	(	PDRIVER_OBJECT	DriverObject,
		PUNICODE_STRING	RegistryPath
	)

Definition at line 179 of file csqtest.c.

{
    NTSTATUS Status;
    UNICODE_STRING NtName;
    UNICODE_STRING DosName;
 
    DriverObject->MajorFunction[IRP_MJ_CREATE] = DispatchCreateCloseCleanup;
    DriverObject->MajorFunction[IRP_MJ_CLOSE] = DispatchCreateCloseCleanup;
    DriverObject->MajorFunction[IRP_MJ_CLEANUP] = DispatchCreateCloseCleanup;
    DriverObject->MajorFunction[IRP_MJ_READ] = DispatchReadWrite;
    DriverObject->MajorFunction[IRP_MJ_WRITE] = DispatchReadWrite;
    DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = DispatchIoctl;
    DriverObject->DriverUnload = Unload;
 
    Status = IoCsqInitialize(&Csq, CsqInsertIrp, CsqRemoveIrp, CsqPeekNextIrp,
                                                     CsqAcquireLock, CsqReleaseLock, CsqCompleteCancelledIrp);
 
    if(Status != STATUS_SUCCESS)
        KdPrint(("csqtest: IoCsqInitialize failed: 0x%x\n", Status));
    else
        KdPrint(("csqtest: IoCsqInitialize succeeded\n"));
 
    InitializeListHead(&IrpQueue);
    KeInitializeSpinLock(&IrpQueueLock);
 
    /* Set up a device */
    RtlInitUnicodeString(&NtName, NT_DEVICE_NAME);
    Status = IoCreateDevice(DriverObject, 0, &NtName, FILE_DEVICE_UNKNOWN, 0, 0, &DeviceObject);
 
    if(!NT_SUCCESS(Status))
        {
            KdPrint(("csqtest: Unable to create device: 0x%x\n", Status));
            return Status;
        }
 
    RtlInitUnicodeString(&DosName, DOS_DEVICE_NAME);
    Status = IoCreateSymbolicLink(&DosName, &NtName);
 
    if(!NT_SUCCESS(Status))
        {
            KdPrint(("csqtest: Unable to create link: 0x%x\n", Status));
            return Status;
        }
 
    DeviceObject->Flags |= DO_BUFFERED_IO;
 
    return STATUS_SUCCESS;
}

Unload()

VOID NTAPI Unload

(

PDRIVER_OBJECT

DriverObject

)

Definition at line 160 of file csqtest.c.

{
    UNICODE_STRING LinkName;
 
    RtlInitUnicodeString(&LinkName, DOS_DEVICE_NAME);
 
    IoDeleteSymbolicLink(&LinkName);
 
    if(DeviceObject)
        IoDeleteDevice(DeviceObject);
}

Referenced by DriverEntry().

Variable Documentation

Csq

IO_CSQ Csq

Definition at line 25 of file csqtest.c.

Referenced by CsqInsertIrpEx(), DispatchCreateCloseCleanup(), DispatchIoctl(), DispatchReadWrite(), and DriverEntry().

DeviceObject

PDEVICE_OBJECT DeviceObject

Definition at line 32 of file csqtest.c.

IrpQueue

LIST_ENTRY IrpQueue

Definition at line 28 of file csqtest.c.

Referenced by CsqInsertIrp(), CsqPeekNextIrp(), and DriverEntry().

IrpQueueLock

KSPIN_LOCK IrpQueueLock

Definition at line 29 of file csqtest.c.

Referenced by CsqAcquireLock(), CsqReleaseLock(), and DriverEntry().