FxCallbackSpinLock Class Reference

#include <fxcallbackspinlock.hpp>

Inheritance diagram for FxCallbackSpinLock:

Collaboration diagram for FxCallbackSpinLock:

Public Member Functions
	FxCallbackSpinLock (PFX_DRIVER_GLOBALS FxDriverGlobals)
virtual	~FxCallbackSpinLock (VOID)
virtual void	Initialize (FxObject *ParentObject)
virtual void	Lock (__out PKIRQL PreviousIrql)
virtual void	Unlock (__in KIRQL PreviousIrql)
virtual _Must_inspect_result_ BOOLEAN	IsOwner (VOID)
Public Member Functions inherited from FxCallbackLock
	FxCallbackLock (PFX_DRIVER_GLOBALS FxDriverGlobals)
virtual	~FxCallbackLock ()
virtual void	Initialize (FxObject *ParentObject)=0
virtual void	Lock (__out PKIRQL PreviousIrql)=0
virtual void	Unlock (__in KIRQL PreviousIrql)=0
virtual _Must_inspect_result_ BOOLEAN	IsOwner (VOID)=0
VOID	CheckOwnership (VOID)
Public Member Functions inherited from FxGlobalsStump
	FxGlobalsStump (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
PFX_DRIVER_GLOBALS	GetDriverGlobals (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)

Private Attributes
MxLock	m_Lock

Additional Inherited Members
Public Attributes inherited from FxCallbackLock
KIRQL	m_PreviousIrql
Protected Member Functions inherited from FxStump
	FxStump (VOID)
Protected Attributes inherited from FxCallbackLock
MxThread	m_OwnerThread
ULONG	m_RecursionCount
FxVerifierLock *	m_Verifier

Detailed Description

Definition at line 37 of file fxcallbackspinlock.hpp.

Constructor & Destructor Documentation

FxCallbackSpinLock()

FxCallbackSpinLock::FxCallbackSpinLock ( PFX_DRIVER_GLOBALS  FxDriverGlobals )

inline

Definition at line 44 of file fxcallbackspinlock.hpp.

          :
        FxCallbackLock(FxDriverGlobals)
    {
    }

~FxCallbackSpinLock()

virtual FxCallbackSpinLock::~FxCallbackSpinLock ( VOID  )

inlinevirtual

Definition at line 52 of file fxcallbackspinlock.hpp.

    {
        if (m_Verifier) {
            delete m_Verifier;
        }
    }

Member Function Documentation

Initialize()

virtual void FxCallbackSpinLock::Initialize ( FxObject *  ParentObject )

inlinevirtual

Implements FxCallbackLock.

Definition at line 63 of file fxcallbackspinlock.hpp.

    {
        PFX_DRIVER_GLOBALS fxDriverGlobals;
 
        m_Verifier = NULL;
        fxDriverGlobals = GetDriverGlobals();
 
        if (fxDriverGlobals->FxVerifierLock) {
 
            //
            // VerifierLock CreateAndInitialize failure is not fatal,
            // we just won't track anything
            //
            (void) FxVerifierLock::CreateAndInitialize(&m_Verifier,
                                                       fxDriverGlobals,
                                                       ParentObject,
                                                       FALSE);
 
        }
    }

Referenced by FxIoQueue::ConfigureConstraints().

IsOwner()

virtual _Must_inspect_result_ BOOLEAN FxCallbackSpinLock::IsOwner ( VOID  )

inlinevirtual

Implements FxCallbackLock.

Definition at line 156 of file fxcallbackspinlock.hpp.

    {
        MxThread cur = Mx::MxGetCurrentThread();
 
        if (m_OwnerThread == cur) {
            return TRUE;
        }
        else {
            return FALSE;
        }
    }

Lock()

virtual void FxCallbackSpinLock::Lock ( __out PKIRQL  PreviousIrql )

inlinevirtual

Implements FxCallbackLock.

Definition at line 88 of file fxcallbackspinlock.hpp.

    {
        MxThread cur = Mx::MxGetCurrentThread();
 
        if (m_OwnerThread == cur) {
            PFX_DRIVER_GLOBALS fxDriverGlobals;
 
            fxDriverGlobals = GetDriverGlobals();
            m_RecursionCount++;
 
            //
            // For now we have decided not to allow this.
            //
 
 
 
 
 
            //
            DoTraceLevelMessage(fxDriverGlobals, TRACE_LEVEL_FATAL, TRACINGDEVICE,
                                "Recursive acquire of callback lock! 0x%p", this);
 
            FxVerifierBugCheck(fxDriverGlobals,
                               WDF_RECURSIVE_LOCK,
                               (ULONG_PTR) this);
            return;
        }
        else {
            if (m_Verifier != NULL) {
                m_Verifier->Lock(PreviousIrql, FALSE);
            }
            else {
                m_Lock.Acquire(PreviousIrql);
            }
 
            m_OwnerThread = cur;
            return;
        }
    }

Unlock()

virtual void FxCallbackSpinLock::Unlock ( __in KIRQL  PreviousIrql )

inlinevirtual

Implements FxCallbackLock.

Definition at line 132 of file fxcallbackspinlock.hpp.

    {
        CheckOwnership();
 
        if (m_RecursionCount > 0) {
            m_RecursionCount--;
        }
        else {
            m_OwnerThread = NULL;
            if (m_Verifier != NULL) {
                m_Verifier->Unlock(PreviousIrql, FALSE);
            }
            else {
                m_Lock.Release(PreviousIrql);
            }
        }
    }

Member Data Documentation

m_Lock

MxLock FxCallbackSpinLock::m_Lock

private

Definition at line 40 of file fxcallbackspinlock.hpp.

Referenced by Lock(), and Unlock().

---

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

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