fxspinlockapi.cpp File Reference

#include "fxsupportpch.hpp"
#include "fxspinlock.hpp"

Include dependency graph for fxspinlockapi.cpp:

Go to the source code of this file.

Functions
_Must_inspect_result_	__drv_maxIRQL (DISPATCH_LEVEL) NTSTATUS NTAPI WDFEXPORT(WdfSpinLockCreate)(__in PWDF_DRIVER_GLOBALS DriverGlobals
	if (NT_SUCCESS(FxValidateObjectAttributesForParentHandle(pFxDriverGlobals, SpinLockAttributes)))
	FxPointerNotNull (pFxDriverGlobals, SpinLock)
	if (!NT_SUCCESS(status))
	if (pFxDriverGlobals->FxVerifierLock)
	if (pLock==NULL)
	if (NT_SUCCESS(status))
	__drv_raisesIRQL (DISPATCH_LEVEL) __drv_maxIRQL(DISPATCH_LEVEL) VOID NTAPI WDFEXPORT(WdfSpinLockAcquire)(__in PWDF_DRIVER_GLOBALS DriverGlobals
__in __drv_savesIRQL	_Requires_lock_not_held_ (_Curr_) _Acquires_lock_(_Curr_) WDFSPINLOCK SpinLock)
__in __drv_restoresIRQL	_Requires_lock_held_ (_Curr_) _Releases_lock_(_Curr_) WDFSPINLOCK SpinLock)

Variables
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES	SpinLockAttributes
_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFSPINLOCK *	SpinLock
PFX_DRIVER_GLOBALS	pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)
NTSTATUS	status = FxValidateObjectAttributes(pFxDriverGlobals, SpinLockAttributes)
FxSpinLock *	pLock
WDFSPINLOCK	lock
USHORT	extra
	else

Function Documentation

__drv_maxIRQL()

_Must_inspect_result_ __drv_maxIRQL

(

DISPATCH_LEVEL

)

__drv_raisesIRQL()

__drv_raisesIRQL

(

DISPATCH_LEVEL

)

_Requires_lock_held_()

__in __drv_restoresIRQL _Requires_lock_held_

(

_Curr_

)

Definition at line 156 of file fxspinlockapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxSpinLock* pLock;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   SpinLock,
                                   FX_TYPE_SPIN_LOCK,
                                   (PVOID*) &pLock,
                                   &pFxDriverGlobals);
 
    if (pLock->IsInterruptLock()) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGERROR,
                            "WDFSPINLOCK %p is associated with an interrupt, "
                            "cannot be used for normal sync operations",
                            SpinLock);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return;
    }
 
    pLock->ReleaseLock();
}

_Requires_lock_not_held_()

__in __drv_savesIRQL _Requires_lock_not_held_

(

_Curr_

)

Definition at line 118 of file fxspinlockapi.cpp.

{
    DDI_ENTRY();
 
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxSpinLock* pLock;
 
    FxObjectHandleGetPtrAndGlobals(GetFxDriverGlobals(DriverGlobals),
                                   SpinLock,
                                   FX_TYPE_SPIN_LOCK,
                                   (PVOID*) &pLock,
                                   &pFxDriverGlobals);
 
    if (pLock->IsInterruptLock()) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGERROR,
                            "WDFSPINLOCK %p is associated with an interrupt, "
                            "cannot be used for normal sync operations",
                            SpinLock);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        return;
    }
 
    pLock->AcquireLock(
        pFxDriverGlobals->FxVerifierLock ? _ReturnAddress() : NULL);
}

FxPointerNotNull()

FxPointerNotNull	(	pFxDriverGlobals	,
		SpinLock
	)

if() [1/5]

if

(

!

NT_SUCCESSstatus

)

Definition at line 77 of file fxspinlockapi.cpp.

                             {
        return status;
    }

if() [2/5]

if

(

NT_SUCCESS(FxValidateObjectAttributesForParentHandle( pFxDriverGlobals, SpinLockAttributes))

)

Definition at line 63 of file fxspinlockapi.cpp.

                                                                {
        FxObject* pParent;
 
        FxObjectHandleGetPtrAndGlobals(pFxDriverGlobals,
                                       SpinLockAttributes->ParentObject,
                                       FX_TYPE_OBJECT,
                                       (PVOID*)&pParent,
                                       &pFxDriverGlobals);
    }

if() [3/5]

if

(

NT_SUCCESS(status)

)

Definition at line 99 of file fxspinlockapi.cpp.

                            {
        *SpinLock = lock;
    }

if() [4/5]

if

(

pFxDriverGlobals->

FxVerifierLock

)

Definition at line 81 of file fxspinlockapi.cpp.

                                          {
        extra = sizeof(FX_SPIN_LOCK_HISTORY);
    }

if() [5/5]

if

(

pLock

= = NULL

)

Definition at line 93 of file fxspinlockapi.cpp.

                       {
        return STATUS_INSUFFICIENT_RESOURCES;
    }

Variable Documentation

else

else

Initial value:

{
        extra = 0

Definition at line 84 of file fxspinlockapi.cpp.

extra

USHORT extra

Definition at line 56 of file fxspinlockapi.cpp.

Referenced by if().

lock

WDFSPINLOCK lock

Definition at line 55 of file fxspinlockapi.cpp.

Referenced by if().

pFxDriverGlobals

pFxDriverGlobals = GetFxDriverGlobals(DriverGlobals)

Definition at line 52 of file fxspinlockapi.cpp.

Referenced by _Requires_lock_held_(), _Requires_lock_not_held_(), and if().

pLock

FxWaitLock * pLock

Initial value:

= new(pFxDriverGlobals, SpinLockAttributes, extra)
        FxSpinLock(pFxDriverGlobals, extra)

Definition at line 54 of file fxspinlockapi.cpp.

Referenced by _Requires_lock_held_(), _Requires_lock_not_held_(), FreeDescriptorsFromList(), FxVerifierLock::GetThreadTableEntry(), and FxVerifierLock::ReleaseOrReplaceThreadTableEntry().

SpinLock

* SpinLock

Initial value:

{
    DDI_ENTRY()

Definition at line 47 of file fxspinlockapi.cpp.

SpinLockAttributes

_Must_inspect_result_ __in_opt PWDF_OBJECT_ATTRIBUTES SpinLockAttributes

Definition at line 45 of file fxspinlockapi.cpp.

status

return status = FxValidateObjectAttributes(pFxDriverGlobals, SpinLockAttributes)

Definition at line 53 of file fxspinlockapi.cpp.

Referenced by if().