#include <fxeventqueue.hpp>

Inheritance diagram for FxWorkItemEventQueue:

[legend]

Collaboration diagram for FxWorkItemEventQueue:

[legend]

Public Member Functions
	FxWorkItemEventQueue (__in UCHAR QueueDepth)

	~FxWorkItemEventQueue ()

_Must_inspect_result_ NTSTATUS	Init (__inout FxPkgPnp *Pnp, __in PFN_PNP_EVENT_WORKER WorkerRoutine, __in PVOID WorkerContext=NULL)

VOID	QueueToThread (VOID)

Public Member Functions inherited from FxEventQueue
	FxEventQueue (__in UCHAR QueueDepth)

_Must_inspect_result_ NTSTATUS	Initialize (__in PFX_DRIVER_GLOBALS DriverGlobals)

	_Acquires_lock_ (this->m_QueueLock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL Irql)

	_Releases_lock_ (this->m_QueueLock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID Unlock(__in __drv_restoresIRQL KIRQL Irql)

BOOLEAN	IsFull (VOID)

BOOLEAN	IsEmpty (VOID)

VOID	IncrementHead (VOID)

UCHAR	GetHead (VOID)

UCHAR	InsertAtHead (VOID)

UCHAR	InsertAtTail (VOID)

UCHAR	IncrementHistoryIndex (VOID)

BOOLEAN	IsClosedLocked (VOID)

VOID	GetFinishedState (__inout FxPostProcessInfo *Info)

BOOLEAN	SetFinished (__in FxCREvent *Event)

VOID	SetDelayedDeletion (VOID)

Public Member Functions inherited from FxStump
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType)

VOID	operator delete (__in PVOID pointer)

PVOID	operator new[] (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

VOID	operator delete[] (__in PVOID pointer)

Protected Member Functions
VOID	QueueWorkItem (VOID)

Protected Member Functions inherited from FxEventQueue
VOID	Configure (__in FxPkgPnp *Pnp, __in PFN_PNP_EVENT_WORKER WorkerRoutine, __in PVOID Context)

BOOLEAN	QueueToThreadWorker (VOID)

VOID	EventQueueWorker (VOID)

BOOLEAN	IsIdleLocked (VOID)

Protected Member Functions inherited from FxStump
	FxStump (VOID)

Protected Attributes
MxWorkItem	m_WorkItem

Protected Attributes inherited from FxEventQueue
UCHAR	m_QueueHead

UCHAR	m_QueueTail

UCHAR	m_QueueDepth

UCHAR	m_HistoryIndex

FxPkgPnp *	m_PkgPnp

PVOID	m_EventWorkerContext

MxLock	m_QueueLock

PFN_PNP_EVENT_WORKER	m_EventWorker

FxCREvent *	m_WorkItemFinished

union {
UCHAR m_QueueFlags

struct {
UCHAR WorkItemQueued: 1

UCHAR Closed: 1

UCHAR DelayDeletion: 1

} m_QueueFlagsByName

};

UCHAR	m_WorkItemRunningCount

Static Protected Attributes
static MX_WORKITEM_ROUTINE	_WorkItemCallback

Additional Inherited Members
Public Attributes inherited from FxEventQueue
FxWaitLockInternal	m_StateMachineLock

Detailed Description

Definition at line 292 of file fxeventqueue.hpp.

Constructor & Destructor Documentation

◆ FxWorkItemEventQueue()

FxWorkItemEventQueue::FxWorkItemEventQueue ( __in UCHAR QueueDepth )

Definition at line 308 of file eventqueue.cpp.

      : FxEventQueue(QueueDepth)
{
}

◆ ~FxWorkItemEventQueue()

FxWorkItemEventQueue::~FxWorkItemEventQueue ( )

Definition at line 314 of file eventqueue.cpp.

{
    m_WorkItem.Free();
}

Member Function Documentation

◆ Init()

_Must_inspect_result_ NTSTATUS FxWorkItemEventQueue::Init	(	__inout FxPkgPnp *	Pnp,
		__in PFN_PNP_EVENT_WORKER	WorkerRoutine,
		__in PVOID	WorkerContext = `NULL`
	)

Definition at line 321 of file eventqueue.cpp.

{
    NTSTATUS status;
 
    Configure(Pnp, WorkerRoutine, WorkerContext);
 
    status = m_WorkItem.Allocate(
        (MdDeviceObject)(GetIoMgrObjectForWorkItemAllocation())
        );
 
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    return STATUS_SUCCESS;
}

Referenced by FxPkgPnp::PostCreateDeviceInitialize().

◆ QueueToThread()

VOID FxWorkItemEventQueue::QueueToThread ( VOID )

inline

Definition at line 308 of file fxeventqueue.hpp.

    {
        if (QueueToThreadWorker()) {
            QueueWorkItem();
        }
    }

Referenced by FxPkgPnp::PnpProcessEvent().

◆ QueueWorkItem()

VOID FxWorkItemEventQueue::QueueWorkItem ( VOID )

protected

Definition at line 40 of file eventqueuekm.cpp.

{
    //
    // The work item will take a reference on KMDF itself.  This will keep KMDF's
    // image around (but not necessarily prevent DriverUnload from being called)
    // so that the code after we set the done event will be in memory and not
    // unloaded.  We must do this because there is no explicit reference between
    // the client driver and KMDF, so when the io manager calls the client's
    // DriverUnload, it has no way of managing KMDF's ref count to stay in memory
    // when the loader unloads KMDF explicitly in response to DriverUnload.
    //
    // We manually take a reference on the client so that we provide the same
    // functionality that IO workitems do.  The client driver's image will have
    // a reference on it after it has returned.
    //
 
 
 
 
    Mx::MxReferenceObject(m_PkgPnp->GetDriverGlobals()->Driver->GetDriverObject());
 
    //
    // Prevent FxDriverGlobals from being deleted until the workitem finishes
    // its work. In case of a bus driver with a PDO in removed
    // state, if the bus is removed, the removal of PDO may happen in a workitem
    // and may result in unload routine being called before the PDO package is
    // deallocated. Since FxPool deallocation code touches FxDriverGlobals
    // (a pointer of which is located in the header of each FxPool allocated
    // object), taking this ref prevents the globals from going away until a
    // corresponding deref at the end of workitem.
    //
    m_PkgPnp->GetDriverGlobals()->ADDREF((PVOID)_WorkItemCallback);
 
    m_WorkItem.Enqueue(
        (PMX_WORKITEM_ROUTINE) _WorkItemCallback,
        (FxEventQueue*) this);
}

Referenced by QueueToThread().

Member Data Documentation

◆ _WorkItemCallback

VOID FxWorkItemEventQueue::_WorkItemCallback

staticprotected

Definition at line 325 of file fxeventqueue.hpp.

Referenced by QueueWorkItem().

◆ m_WorkItem

MxWorkItem FxWorkItemEventQueue::m_WorkItem

protected

Definition at line 327 of file fxeventqueue.hpp.

Referenced by Init(), QueueWorkItem(), and ~FxWorkItemEventQueue().

The documentation for this struct was generated from the following files:

sdk/lib/drivers/wdf/shared/inc/private/common/fxeventqueue.hpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/eventqueue.cpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/km/eventqueuekm.cpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/um/eventqueueum.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members