#include <fxdisposelist.hpp>

Inheritance diagram for FxDisposeList:

Collaboration diagram for FxDisposeList:

[legend]

Public Member Functions
	FxDisposeList (PFX_DRIVER_GLOBALS FxDriverGlobals)

	~FxDisposeList ()

NTSTATUS	Initialize (PVOID wdmObject)

VOID	Add (FxObject *object)

VOID	WaitForEmpty (VOID)

	DECLARE_INTERNAL_NEW_OPERATOR ()

Public Member Functions inherited from FxNonPagedObject
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

virtual	~FxNonPagedObject (VOID)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL PreviousIrql)

	_Releases_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID Unlock(__in __drv_restoresIRQL KIRQL PreviousIrql)

	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID LockAtDispatch(VOID)

	_Requires_lock_held_ (this->m_NPLock.m_Lock) _Releases_lock_(this -> m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID UnlockFromDispatch(VOID)

Public Member Functions inherited from FxObject
PVOID	GetCOMWrapper ()

void	SetCOMWrapper (__drv_aliasesMem PVOID Wrapper)

	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

virtual	~FxObject (VOID)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType Type)

PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize=0)

VOID	operator delete (__in PVOID Memory)

VOID	SetNoContextHeader (VOID)

PVOID __inline	GetObjectHandle (VOID)

__inline FxContextHeader *	GetContextHeader (VOID)

__inline PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)

WDFTYPE	GetType (VOID)

USHORT	GetObjectSize (VOID)

LONG	GetRefCnt (VOID)

FxTagTracker *	GetTagTracker (VOID)

CfxDevice *	GetDevice (VOID)

CfxDeviceBase *	GetDeviceBase (VOID)

VOID	SetDeviceBase (__in CfxDeviceBase *DeviceBase)

__inline VOID	CallCleanup (VOID)

ULONG __inline	AddRef (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	Release (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	AddRefOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual ULONG	ReleaseOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)

virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)

VOID	MarkTraceState (VOID)

BOOLEAN __inline	IsTraceState (VOID)

VOID __inline	TraceDroppedEvent (__in FxObjectDroppedEvent Event)

VOID	MarkPassiveDispose (__in FxObjectLockState State=ObjectLock)

VOID	MarkPassiveCallbacks (__in FxObjectLockState State=ObjectLock)

VOID	MarkForceDisposeThread (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsPassiveCallbacks (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsPassiveDispose (__in BOOLEAN AcquireLock=TRUE)

BOOLEAN	IsForceDisposeThread (__in BOOLEAN AcquireLock=TRUE)

VOID	MarkCommitted (VOID)

BOOLEAN	IsCommitted (VOID)

VOID	MarkDisposeOverride (__in FxObjectLockState State=ObjectLock)

VOID	MarkNoDeleteDDI (__in FxObjectLockState State=ObjectLock)

BOOLEAN	IsNoDeleteDDI (VOID)

_Must_inspect_result_ NTSTATUS	Commit (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out_opt WDFOBJECT ObjectHandle, __in_opt FxObject Parent=NULL, __in BOOLEAN AssignDriverAsDefaultParent=TRUE)

VOID	DeleteFromFailedCreate (VOID)

VOID	ClearEvtCallbacks (VOID)

BOOLEAN	EarlyDispose (VOID)

virtual VOID	DeleteObject (VOID)

virtual BOOLEAN	Dispose (VOID)

_Must_inspect_result_ NTSTATUS	AssignParentObject (__in FxObject *ParentObject)

_Must_inspect_result_ NTSTATUS	AddContext (__in FxContextHeader Header, __in PVOID Context, __in PWDF_OBJECT_ATTRIBUTES Attributes)

_Must_inspect_result_ NTSTATUS	RemoveParentAssignment (VOID)

_Must_inspect_result_ FxObject *	GetParentObjectReferenced (__in PVOID Tag)

BOOLEAN	IsDisposed (VOID)

Static Public Member Functions
static NTSTATUS	_Create (PFX_DRIVER_GLOBALS FxDriverGlobals, PVOID WdmObject, FxDisposeList **pObject)

Static Public Member Functions inherited from FxObject
static FxObject *	_FromDisposeEntry (__in PSINGLE_LIST_ENTRY Entry)

static FxObject *	_GetObjectFromHandle (__in WDFOBJECT Handle, __inout PWDFOBJECT_OFFSET ObjectOffset)

static PVOID __inline	_ToHandle (__in FxObject *Object)

static VOID __inline	_ReferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static VOID __inline	_DereferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)

static PVOID	_GetDebugBase (__in FxObject *Object)

static PFX_POOL_HEADER	_CleanupPointer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Object)

static _Must_inspect_result_ NTSTATUS	_GetEffectiveLock (__in FxObject Object, __in_opt IFxHasCallbacks Callbacks, __in BOOLEAN AutomaticLocking, __in BOOLEAN PassiveCallbacks, __out FxCallbackLock CallbackLock, __out_opt FxObject CallbackLockObject)

static _Must_inspect_result_ NTSTATUS	_ObjectQuery (_In_ FxObject Object, _In_ CONST GUID Guid, _In_ ULONG QueryBufferLength, _Out_writes_bytes_(QueryBufferLength) PVOID QueryBuffer)

Private Member Functions
VOID	DrainListLocked (PKIRQL PreviousIrql)

virtual BOOLEAN	Dispose (VOID)

Static Private Member Functions
static VOID	_WorkItemThunk (__in PVOID Parameter)

Private Attributes
SINGLE_LIST_ENTRY	m_List

SINGLE_LIST_ENTRY **	m_ListEnd

MxThread	m_WorkItemThread

FxSystemWorkItem *	m_SystemWorkItem

PVOID	m_WdmObject

Additional Inherited Members
Protected Member Functions inherited from FxObject
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)

FxObjectDebugExtension *	GetDebugExtension (VOID)

BOOLEAN	IsDebug (VOID)

VOID	AllocateTagTracker (__in WDFTYPE Type)

virtual VOID	SelfDestruct (VOID)

PVOID __inline	GetObjectHandleUnchecked (VOID)

VOID __inline	DestroyChildren (VOID)

VOID	DeleteEarlyDisposedObject (VOID)

Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Protected Attributes inherited from FxObject
union {
CfxDeviceBase * m_DeviceBase

CfxDevice * m_Device

};

Detailed Description

Definition at line 51 of file fxdisposelist.hpp.

Constructor & Destructor Documentation

◆ FxDisposeList()

FxDisposeList::FxDisposeList ( PFX_DRIVER_GLOBALS FxDriverGlobals )

Definition at line 41 of file fxdisposelist.cpp.

      :
    FxNonPagedObject(FX_TYPE_DISPOSELIST, 0, FxDriverGlobals)
{
   m_List.Next = NULL;
   m_ListEnd = &m_List.Next;
 
   m_SystemWorkItem = NULL;
   m_WorkItemThread = NULL;
}

◆ ~FxDisposeList()

FxDisposeList::~FxDisposeList ( )

Definition at line 53 of file fxdisposelist.cpp.

{
    ASSERT(m_List.Next == NULL);
}

Member Function Documentation

◆ _Create()

NTSTATUS FxDisposeList::_Create	(	PFX_DRIVER_GLOBALS	FxDriverGlobals,
		PVOID	WdmObject,
		FxDisposeList **	pObject
	)

static

Definition at line 59 of file fxdisposelist.cpp.

{
    FxDisposeList* list;
    NTSTATUS status;
 
    *pObject = NULL;
 
    list = new(FxDriverGlobals) FxDisposeList(FxDriverGlobals);
 
    if (list == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    status = list->Initialize(WdmObject);
 
    if (NT_SUCCESS(status)) {
        *pObject = list;
    }
    else {
        list->DeleteFromFailedCreate();
    }
 
    return status;
}

Referenced by FxDriver::Initialize(), and FxDevice::PostInitialize().

◆ _WorkItemThunk()

VOID FxDisposeList::_WorkItemThunk ( __in PVOID Parameter )

staticprivate

Definition at line 238 of file fxdisposelist.cpp.

{
    FxDisposeList* pThis;
    KIRQL irql;
 
    pThis = (FxDisposeList*) Parameter;
 
    pThis->Lock(&irql);
 
    pThis->DrainListLocked(&irql);
 
    pThis->Unlock(irql);
}

Referenced by Add().

◆ Add()

VOID FxDisposeList::Add ( FxObject * object )

Definition at line 130 of file fxdisposelist.cpp.

{
    KIRQL irql;
    BOOLEAN previouslyEmpty;
 
    Lock(&irql);
 
    ASSERT(Object->m_DisposeSingleEntry.Next == NULL);
 
    previouslyEmpty = m_List.Next == NULL ? TRUE : FALSE;
 
    //
    // Add to the end of m_List
    //
    *m_ListEnd = &Object->m_DisposeSingleEntry;
 
    //
    // Update the end
    //
    m_ListEnd = &Object->m_DisposeSingleEntry.Next;
 
    if (previouslyEmpty) {
        m_SystemWorkItem->TryToEnqueue(_WorkItemThunk, this);
    }
 
    Unlock(irql);
}

Referenced by FxDeviceBase::AddToDisposeList(), FxObject::FinalRelease(), and FxObject::QueueDeferredDisposeLocked().

◆ DECLARE_INTERNAL_NEW_OPERATOR()

FxDisposeList::DECLARE_INTERNAL_NEW_OPERATOR ( )

◆ Dispose()

BOOLEAN FxDisposeList::Dispose ( VOID )

privatevirtual

Reimplemented from FxObject.

Definition at line 114 of file fxdisposelist.cpp.

{
    if (m_SystemWorkItem != NULL) {
        m_SystemWorkItem->DeleteObject();
        m_SystemWorkItem = NULL;
    }
 
    ASSERT(m_List.Next == NULL);
 
    FxNonPagedObject::Dispose(); // __super call
 
    return TRUE;
}

◆ DrainListLocked()

VOID FxDisposeList::DrainListLocked ( PKIRQL PreviousIrql )

private

Definition at line 187 of file fxdisposelist.cpp.

{
    FxObject* pObject;
    PSINGLE_LIST_ENTRY pEntry;
 
    //
    // Process items on the list until it is empty
    //
    while (m_List.Next != NULL) {
        pEntry = m_List.Next;
 
        //
        // Remove pEntry from the list
        //
        m_List.Next = pEntry->Next;
 
        //
        // Indicate pEntry is no longer in the list
        //
        pEntry->Next = NULL;
 
        //
        // Convert back to the object
        //
        pObject = FxObject::_FromDisposeEntry(pEntry);
 
        //
        // If the list is empty, we just popped off the entry and we need to
        // update m_ListEnd to a head of the list so it points to valid pool.
        //
        if (m_List.Next == NULL) {
            m_ListEnd = &m_List.Next;
        }
 
        Unlock(*PreviousIrql);
 
        //
        // Invoke the objects deferred dispose entry
        //
        pObject->DeferredDisposeWorkItem();
 
        //
        // pObject may be invalid at this point due to its dereferencing itself
        //
        Lock(PreviousIrql);
    }
}

Referenced by _WorkItemThunk(), and WaitForEmpty().

◆ Initialize()

NTSTATUS FxDisposeList::Initialize ( PVOID wdmObject )

Definition at line 89 of file fxdisposelist.cpp.

{
    NTSTATUS status;
    PFX_DRIVER_GLOBALS FxDriverGlobals = GetDriverGlobals();
 
    MarkDisposeOverride(ObjectDoNotLock);
 
    status = FxSystemWorkItem::_Create(FxDriverGlobals,
                                      WdmObject,
                                      &m_SystemWorkItem
                                      );
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGIO,
                            "Could not allocate workitem: %!STATUS!", status);
        return status;
    }
 
    m_WdmObject = WdmObject;
 
    return STATUS_SUCCESS;
}

◆ WaitForEmpty()

VOID FxDisposeList::WaitForEmpty ( VOID )

Definition at line 255 of file fxdisposelist.cpp.

{
    KIRQL irql;
    BOOLEAN wait;
 
    Lock(&irql);
 
    wait = TRUE;
 
    if (m_WorkItemThread == Mx::MxGetCurrentThread()) {
 
        ASSERT(FALSE);
        DrainListLocked(&irql);
        wait = FALSE;
    }
 
    Unlock(irql);
 
    if (wait) {
        m_SystemWorkItem->WaitForExit();
    }
 
    // Should only be true for an empty list
    ASSERT(m_List.Next == NULL);
}

Referenced by FxDevice::DeleteDeviceFromFailedCreateNoDelete(), FxDevice::Dispose(), FxMpDevice::Dispose(), FxDriver::Dispose(), and FxPkgPnp::PnpEventRemovedCommonCode().

Member Data Documentation

◆ m_List

SINGLE_LIST_ENTRY FxDisposeList::m_List

private

Definition at line 58 of file fxdisposelist.hpp.

Referenced by Add(), Dispose(), DrainListLocked(), FxDisposeList(), WaitForEmpty(), and ~FxDisposeList().

◆ m_ListEnd

SINGLE_LIST_ENTRY** FxDisposeList::m_ListEnd

private

Definition at line 64 of file fxdisposelist.hpp.

Referenced by Add(), DrainListLocked(), and FxDisposeList().

◆ m_SystemWorkItem

FxSystemWorkItem* FxDisposeList::m_SystemWorkItem

private

Definition at line 73 of file fxdisposelist.hpp.

Referenced by Add(), Dispose(), FxDisposeList(), Initialize(), and WaitForEmpty().

◆ m_WdmObject

PVOID FxDisposeList::m_WdmObject

private

Definition at line 78 of file fxdisposelist.hpp.

Referenced by Initialize().

◆ m_WorkItemThread

MxThread FxDisposeList::m_WorkItemThread

private

Definition at line 71 of file fxdisposelist.hpp.

Referenced by FxDisposeList(), and WaitForEmpty().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxdisposelist.hpp
sdk/lib/drivers/wdf/shared/core/fxdisposelist.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxDisposeList()

◆ ~FxDisposeList()

Member Function Documentation

◆ _Create()

◆ _WorkItemThunk()

◆ Add()

◆ DECLARE_INTERNAL_NEW_OPERATOR()

◆ Dispose()

◆ DrainListLocked()

◆ Initialize()

◆ WaitForEmpty()

Member Data Documentation

◆ m_List

◆ m_ListEnd

◆ m_SystemWorkItem

◆ m_WdmObject

◆ m_WorkItemThread