FxLock Class Reference

#include <fxlock.hpp>

Collaboration diagram for FxLock:

Public Member Functions
	FxLock (VOID)
VOID	Initialize (__in FxObject *ParentObject)
	~FxLock ()
	_When_ (this->m_Verifier==NULL, _Acquires_lock_(this->m_lock)) inline VOID Lock(__out PKIRQL PreviousIrql)
	_When_ (this->m_Verifier==NULL, _Releases_lock_(this->m_lock)) inline void Unlock(__in KIRQL PreviousIrql)
	_When_ (this->m_Verifier==NULL, _Acquires_lock_(this->m_lock)) inline VOID LockAtDispatch(VOID)
	_When_ (this->m_Verifier==NULL, _Releases_lock_(this->m_lock)) inline void UnlockFromDispatch(VOID)

Private Attributes
MxLock	m_lock
FxVerifierLock *	m_Verifier

Detailed Description

This is the base lock object implementation

This is intended to be embedded in an FxNonPagedObject rather than forcing a separate allocation for non-verifier mode.

In order to reduce the runtime memory cost of building in verifier support for a retail version, a single pointer it stored to FxVerifierLock if verifier is on. If this pointer is != NULL, lock calls are proxied to this lock function, leaving our internal spinlock redundent.

The decision is to minimize the non-verifier memory footprint so we do not have to compile it out for retail builds, but always have it available through a driver debug setting.

Definition at line 48 of file fxlock.hpp.

Constructor & Destructor Documentation

FxLock()

FxLock::FxLock ( VOID  )

inline

Definition at line 57 of file fxlock.hpp.

    {
 
 
 
 
        m_lock.Initialize();
        m_Verifier = NULL;
    }

~FxLock()

FxLock::~FxLock ( )

inline

Definition at line 74 of file fxlock.hpp.

    {
        if (m_Verifier != NULL) {
            delete m_Verifier;
        }
    }

Member Function Documentation

_When_() [1/4]

FxLock::_When_ ( this->  m_Verifier = = NULL, _Acquires_lock_(this->m_lock)    )

inline

Definition at line 81 of file fxlock.hpp.

    {
        if (m_Verifier != NULL) {
            m_Verifier->Lock(PreviousIrql, FALSE);
        }
        //  else if (PreviousIrql == NULL) {
         //     KeAcquireSpinLockAtDpcLevel(&m_lock);
        //  }
        else {
            m_lock.Acquire(PreviousIrql);
        }
    }

_When_() [2/4]

FxLock::_When_ ( this->  m_Verifier = = NULL, _Acquires_lock_(this->m_lock)    )

inline

Definition at line 117 of file fxlock.hpp.

    {
        if (m_Verifier != NULL) {
            KIRQL previousIrql;
 
            m_Verifier->Lock(&previousIrql, TRUE);
        }
        else {
            m_lock.AcquireAtDpcLevel();
        }
    }

_When_() [3/4]

FxLock::_When_ ( this->  m_Verifier = = NULL, _Releases_lock_(this->m_lock)    )

inline

Definition at line 99 of file fxlock.hpp.

    {
        if (m_Verifier != NULL) {
            m_Verifier->Unlock(PreviousIrql, FALSE);
        }
        // else if (AtDpc) {
        //     KeReleaseSpinLockFromDpcLevel(&m_lock);
        // }
        else {
            m_lock.Release(PreviousIrql);
        }
    }

_When_() [4/4]

FxLock::_When_ ( this->  m_Verifier = = NULL, _Releases_lock_(this->m_lock)    )

inline

Definition at line 134 of file fxlock.hpp.

    {
        if (m_Verifier != NULL) {
            m_Verifier->Unlock(DISPATCH_LEVEL, TRUE);
        }
        else {
            m_lock.ReleaseFromDpcLevel();
        }
    }

Initialize()

VOID FxLock::Initialize

(

__in FxObject *

ParentObject

)

Definition at line 29 of file fxlock.cpp.

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

Member Data Documentation

m_lock

MxLock FxLock::m_lock

private

Definition at line 51 of file fxlock.hpp.

Referenced by _When_(), and FxLock().

m_Verifier

FxVerifierLock* FxLock::m_Verifier

private

Definition at line 54 of file fxlock.hpp.

Referenced by _When_(), FxLock(), Initialize(), and ~FxLock().

---

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

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