FxNonPagedObject Class Reference

#include <fxnonpagedobject.hpp>

Inheritance diagram for FxNonPagedObject:

Collaboration diagram for FxNonPagedObject:

Public Member Functions
	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)

Private Attributes
MxLock	m_NPLock

Additional Inherited Members
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)
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 45 of file fxnonpagedobject.hpp.

Constructor & Destructor Documentation

FxNonPagedObject() [1/2]

FxNonPagedObject::FxNonPagedObject ( __in WDFTYPE  Type, __in USHORT  Size, __in PFX_DRIVER_GLOBALS  FxDriverGlobals  )

inline

Definition at line 52 of file fxnonpagedobject.hpp.

          :
        FxObject(Type, Size, FxDriverGlobals)
    {
        if (IsDebug()) {
            if (GetDriverGlobals()->FxVerifierLock) {
                //
                // VerifierLock CreateAndInitialize failure is not fatal,
                // we just won't track anything
                //
                FxVerifierLock * verifierLock = NULL;
                (void) FxVerifierLock::CreateAndInitialize(&verifierLock,
                                                    GetDriverGlobals(),
                                                    this);
                GetDebugExtension()->VerifierLock = verifierLock;
            }
        }
    }

FxNonPagedObject() [2/2]

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

inline

Definition at line 74 of file fxnonpagedobject.hpp.

          :
        FxObject(Type, Size, FxDriverGlobals, ObjectType)
    {
        if (IsDebug()) {
            if (GetDriverGlobals()->FxVerifierLock) {
                //
                // VerifierLock CreateAndInitialize failure is not fatal,
                // we just won't track anything
                //
                FxVerifierLock * verifierLock = NULL;
                (void) FxVerifierLock::CreateAndInitialize(&verifierLock,
                                                    GetDriverGlobals(),
                                                    this);
                GetDebugExtension()->VerifierLock = verifierLock;
            }
        }
    }

~FxNonPagedObject()

virtual FxNonPagedObject::~FxNonPagedObject ( VOID  )

inlinevirtual

Definition at line 98 of file fxnonpagedobject.hpp.

    {
        if (IsDebug()) {
            FxObjectDebugExtension* pExtension;
 
            pExtension = GetDebugExtension();
 
            if (pExtension->VerifierLock != NULL) {
                delete pExtension->VerifierLock;
                pExtension->VerifierLock = NULL;
            }
        }
    }

Member Function Documentation

_Acquires_lock_() [1/2]

FxNonPagedObject::_Acquires_lock_ ( this->m_NPLock.  m_Lock )

inline

Definition at line 114 of file fxnonpagedobject.hpp.

    {
        if (IsDebug()) {
            FxObjectDebugExtension* pExtension;
 
            pExtension = GetDebugExtension();
 
            if (pExtension->VerifierLock != NULL) {
                pExtension->VerifierLock->Lock(PreviousIrql, FALSE);
                //
                // return here so that we don't acquire the non verified lock
                // below
                //
                return;
            }
        }
 
        m_NPLock.Acquire(PreviousIrql);
    }

_Acquires_lock_() [2/2]

FxNonPagedObject::_Acquires_lock_ ( this->m_NPLock.  m_Lock )

inline

Definition at line 169 of file fxnonpagedobject.hpp.

    {
        if (IsDebug()) {
            FxObjectDebugExtension* pExtension;
 
            pExtension = GetDebugExtension();
 
            if (pExtension->VerifierLock != NULL) {
                KIRQL previousIrql;
 
                pExtension->VerifierLock->Lock(&previousIrql, TRUE);
 
                ASSERT(previousIrql == DISPATCH_LEVEL);
                //
                // return here so that we don't acquire the non verified lock
                // below
                //
                return;
            }
        }
 
        m_NPLock.AcquireAtDpcLevel();
    }

_Releases_lock_()

FxNonPagedObject::_Releases_lock_ ( this->m_NPLock.  m_Lock )

inline

Definition at line 140 of file fxnonpagedobject.hpp.

    {
        if (IsDebug()) {
            FxObjectDebugExtension* pExtension;
 
            pExtension = GetDebugExtension();
 
            if (pExtension->VerifierLock != NULL) {
                pExtension->VerifierLock->Unlock(PreviousIrql, FALSE);
 
                //
                // return here so that we don't release the non verified lock
                // below
                //
                return;
            }
        }
 
        m_NPLock.Release(PreviousIrql);
    }

_Requires_lock_held_()

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

inline

Definition at line 198 of file fxnonpagedobject.hpp.

    {
        if (IsDebug()) {
            FxObjectDebugExtension* pExtension;
 
            pExtension = GetDebugExtension();
 
            if (pExtension->VerifierLock != NULL) {
                pExtension->VerifierLock->Unlock(DISPATCH_LEVEL, TRUE);
 
                //
                // return here so that we don't acquire the non verified lock
                // below
                //
                return;
            }
        }
 
        m_NPLock.ReleaseFromDpcLevel();
    }

Member Data Documentation

m_NPLock

MxLock FxNonPagedObject::m_NPLock

private

Definition at line 49 of file fxnonpagedobject.hpp.

Referenced by _Acquires_lock_(), _Releases_lock_(), and _Requires_lock_held_().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxnonpagedobject.hpp