FxCallbackLock Class Reference

#include <fxcallbacklock.hpp>

Inheritance diagram for FxCallbackLock:

Collaboration diagram for FxCallbackLock:

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

Public Attributes
KIRQL	m_PreviousIrql

Protected Attributes
MxThread	m_OwnerThread
ULONG	m_RecursionCount
FxVerifierLock *	m_Verifier

Additional Inherited Members
Protected Member Functions inherited from FxStump
	FxStump (VOID)

Detailed Description

Definition at line 49 of file fxcallbacklock.hpp.

Constructor & Destructor Documentation

FxCallbackLock()

FxCallbackLock::FxCallbackLock ( PFX_DRIVER_GLOBALS  FxDriverGlobals )

inline

Definition at line 70 of file fxcallbacklock.hpp.

          :
        FxGlobalsStump(FxDriverGlobals)
    {
        m_OwnerThread = NULL;
        m_RecursionCount = 0;
        m_Verifier = NULL;
    }

~FxCallbackLock()

virtual FxCallbackLock::~FxCallbackLock ( )

inlinevirtual

Definition at line 80 of file fxcallbacklock.hpp.

    {
    }

Member Function Documentation

CheckOwnership()

VOID FxCallbackLock::CheckOwnership ( VOID  )

inline

Definition at line 111 of file fxcallbacklock.hpp.

    {
        PFX_DRIVER_GLOBALS pFxDriverGlobals;
 
        pFxDriverGlobals = GetDriverGlobals();
 
        //
        // If verify locks is on, catch drivers
        // returning with the lock released.
        //
        if (pFxDriverGlobals->FxVerifierLock) {
            if (IsOwner() == FALSE) {
                DoTraceLevelMessage(
                    pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
                    "Callback: Driver released the callback lock 0x%p",
                    this);
                FxVerifierDbgBreakPoint(pFxDriverGlobals);
            }
        }
    }

Referenced by FxCallbackMutexLock::Unlock(), and FxCallbackSpinLock::Unlock().

Initialize()

virtual void FxCallbackLock::Initialize ( FxObject *  ParentObject )

pure virtual

Implemented in FxCallbackMutexLock, and FxCallbackSpinLock.

Referenced by FxDeviceBase::ConfigureConstraints().

IsOwner()

virtual _Must_inspect_result_ BOOLEAN FxCallbackLock::IsOwner ( VOID  )

pure virtual

Implemented in FxCallbackMutexLock, and FxCallbackSpinLock.

Referenced by FxIoQueue::CanThreadDispatchEventsLocked(), and CheckOwnership().

Lock()

virtual void FxCallbackLock::Lock ( __out PKIRQL  PreviousIrql )

pure virtual

Implemented in FxCallbackMutexLock, and FxCallbackSpinLock.

Referenced by FxLockedCallback::CallbackStart(), FxDpc::DpcHandler(), FxInterrupt::DpcHandler(), FxTimer::TimerHandler(), FxWorkItem::WorkItemHandler(), and FxInterrupt::WorkItemHandler().

Unlock()

virtual void FxCallbackLock::Unlock ( __in KIRQL  PreviousIrql )

pure virtual

Implemented in FxCallbackMutexLock, and FxCallbackSpinLock.

Referenced by FxLockedCallback::CallbackEnd(), FxDpc::DpcHandler(), FxInterrupt::DpcHandler(), FxTimer::TimerHandler(), FxWorkItem::WorkItemHandler(), and FxInterrupt::WorkItemHandler().

Member Data Documentation

m_OwnerThread

MxThread FxCallbackLock::m_OwnerThread

protected

Definition at line 52 of file fxcallbacklock.hpp.

Referenced by FxCallbackLock(), FxCallbackMutexLock::IsOwner(), FxCallbackSpinLock::IsOwner(), FxCallbackMutexLock::Lock(), FxCallbackSpinLock::Lock(), FxCallbackMutexLock::Unlock(), and FxCallbackSpinLock::Unlock().

m_PreviousIrql

KIRQL FxCallbackLock::m_PreviousIrql

Definition at line 66 of file fxcallbacklock.hpp.

m_RecursionCount

ULONG FxCallbackLock::m_RecursionCount

protected

Definition at line 53 of file fxcallbacklock.hpp.

Referenced by FxCallbackLock(), FxCallbackMutexLock::Lock(), FxCallbackSpinLock::Lock(), FxCallbackMutexLock::Unlock(), and FxCallbackSpinLock::Unlock().

m_Verifier

FxVerifierLock* FxCallbackLock::m_Verifier

protected

Definition at line 56 of file fxcallbacklock.hpp.

Referenced by FxCallbackLock(), FxCallbackMutexLock::Initialize(), FxCallbackSpinLock::Initialize(), FxCallbackMutexLock::Lock(), FxCallbackSpinLock::Lock(), FxCallbackMutexLock::Unlock(), FxCallbackSpinLock::Unlock(), FxCallbackMutexLock::~FxCallbackMutexLock(), and FxCallbackSpinLock::~FxCallbackSpinLock().

---

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

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