queue.h

Go to the documentation of this file.

/*
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 *  Copyright 2004 Spiro Trikaliotis
 *
 */

#ifndef SRT_QUEUE_H
#define SRT_QUEUE_H

#ifdef CSQ_STATIC
#include <csq.h>
#endif

typedef NTSTATUS (*PCBMDRIVER_STARTIO)(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp);

typedef
struct QUEUE
{
    IO_CSQ IrpQueue;

    LIST_ENTRY IrpListHead;

    KSPIN_LOCK IrpListSpinlock;

    KEVENT NotEmptyEvent;

#ifdef USE_FAST_START_THREAD

    KEVENT BackSignalEvent;

#endif // #ifdef USE_FAST_START_THREAD

    PCBMDRIVER_STARTIO DriverStartIo;

    LONG IsStalled;

    LONG IsDropping;

    NTSTATUS DroppingReturnStatus;

    PIRP CurrentIrp;

} QUEUE, *PQUEUE;

/* For performance reasons, these two functions are defined as macros
   in release builds of the driver.
   They do not need any protecting by synchronization primitives, as their
   state could have changed on return in either way. This, the caller has
   to make sure that is obtains exactly the state it wants to know.
*/
#ifndef DBG

    #define QueueIsStalled(_Queue_) (_Queue_->IsStalled ? 1 : 0)

    #define QueueIsDropping(_Queue_) (_Queue_->IsDropping ? 1 : 0)

#endif

extern VOID
QueueInit(PQUEUE Queue, PCBMDRIVER_STARTIO DriverStartIo);

extern NTSTATUS
QueueCompleteIrp(PQUEUE Queue, PIRP Irp, NTSTATUS StatusCode, ULONG_PTR Information);

extern NTSTATUS
QueueStartPacket(PQUEUE Queue, PIRP Irp, BOOLEAN FastStart, PDEVICE_OBJECT Fdo);

extern NTSTATUS
QueuePoll(PQUEUE Queue, PDEVICE_OBJECT Fdo);

extern NTSTATUS
QueueSignal(PQUEUE Queue);

extern NTSTATUS
QueueCleanup(PQUEUE Queue, PFILE_OBJECT FileObject);

extern BOOLEAN
QueueShouldCancelCurrentIrp(PQUEUE Queue);

#endif /* #ifndef SRT_QUEUE_H */