spinlock.c File Reference

#include <ntoskrnl.h>
#include <debug.h>

Include dependency graph for spinlock.c:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	LQ_WAIT   1
#define	LQ_OWN   2

Functions
	_IRQL_requires_min_ (DISPATCH_LEVEL)
KIRQL NTAPI	KeAcquireInterruptSpinLock (IN PKINTERRUPT Interrupt)
VOID NTAPI	KeReleaseInterruptSpinLock (IN PKINTERRUPT Interrupt, IN KIRQL OldIrql)
VOID NTAPI	_KeInitializeSpinLock (IN PKSPIN_LOCK SpinLock)
VOID NTAPI	KeAcquireSpinLockAtDpcLevel (IN PKSPIN_LOCK SpinLock)
VOID NTAPI	KeReleaseSpinLockFromDpcLevel (IN PKSPIN_LOCK SpinLock)
VOID FASTCALL	KefAcquireSpinLockAtDpcLevel (IN PKSPIN_LOCK SpinLock)
VOID FASTCALL	KefReleaseSpinLockFromDpcLevel (IN PKSPIN_LOCK SpinLock)
VOID FASTCALL	KiAcquireSpinLock (IN PKSPIN_LOCK SpinLock)
VOID FASTCALL	KiReleaseSpinLock (IN PKSPIN_LOCK SpinLock)
BOOLEAN FASTCALL	KeTryToAcquireSpinLockAtDpcLevel (IN OUT PKSPIN_LOCK SpinLock)
VOID FASTCALL	KeAcquireInStackQueuedSpinLockAtDpcLevel (IN PKSPIN_LOCK SpinLock, IN PKLOCK_QUEUE_HANDLE LockHandle)
VOID FASTCALL	KeReleaseInStackQueuedSpinLockFromDpcLevel (IN PKLOCK_QUEUE_HANDLE LockHandle)
KIRQL FASTCALL	KeAcquireSpinLockForDpc (IN PKSPIN_LOCK SpinLock)
VOID FASTCALL	KeReleaseSpinLockForDpc (IN PKSPIN_LOCK SpinLock, IN KIRQL OldIrql)
VOID FASTCALL	KeAcquireInStackQueuedSpinLockForDpc (IN PKSPIN_LOCK SpinLock, IN PKLOCK_QUEUE_HANDLE LockHandle)
VOID FASTCALL	KeReleaseInStackQueuedSpinLockForDpc (IN PKLOCK_QUEUE_HANDLE LockHandle)
BOOLEAN FASTCALL	KeTestSpinLock (IN PKSPIN_LOCK SpinLock)

Macro Definition Documentation

LQ_OWN

#define LQ_OWN   2

Definition at line 16 of file spinlock.c.

LQ_WAIT

#define LQ_WAIT   1

Definition at line 15 of file spinlock.c.

NDEBUG

#define NDEBUG

Definition at line 12 of file spinlock.c.

Function Documentation

_IRQL_requires_min_()

_IRQL_requires_min_

(

DISPATCH_LEVEL

)

Definition at line 97 of file spinlock.c.

{
#if defined(CONFIG_SMP) || DBG
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)LockHandle->Lock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }
#endif

    /* Do the inlined function */
    KxAcquireSpinLock(LockHandle->Lock);
}

_KeInitializeSpinLock()

VOID NTAPI _KeInitializeSpinLock

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 186 of file spinlock.c.

{
    /* Clear it */
    *SpinLock = 0;
}

KeAcquireInStackQueuedSpinLockAtDpcLevel()

VOID FASTCALL KeAcquireInStackQueuedSpinLockAtDpcLevel	(	IN PKSPIN_LOCK	SpinLock,
		IN PKLOCK_QUEUE_HANDLE	LockHandle
	)

Definition at line 363 of file spinlock.c.

{
    /* Set it up properly */
    LockHandle->LockQueue.Next = NULL;
    LockHandle->LockQueue.Lock = SpinLock;
#ifdef CONFIG_SMP
#if 0
    KeAcquireQueuedSpinLockAtDpcLevel(LockHandle->LockQueue.Next);
#else
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)LockHandle->LockQueue.Lock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }
#endif
#endif

    /* Acquire the lock */
    KxAcquireSpinLock(LockHandle->LockQueue.Lock); // HACK
}

Referenced by KeAcquireInStackQueuedSpinLockForDpc(), KiAcquireApcLockAtSynchLevel(), and KiAcquireDeviceQueueLock().

KeAcquireInStackQueuedSpinLockForDpc()

VOID FASTCALL KeAcquireInStackQueuedSpinLockForDpc	(	IN PKSPIN_LOCK	SpinLock,
		IN PKLOCK_QUEUE_HANDLE	LockHandle
	)

Definition at line 446 of file spinlock.c.

{
    LockHandle->OldIrql = KeGetCurrentIrql();
    if (LockHandle->OldIrql >= DISPATCH_LEVEL)
        KeAcquireInStackQueuedSpinLockAtDpcLevel(SpinLock, LockHandle);
    else
        KeAcquireInStackQueuedSpinLock(SpinLock, LockHandle);
}

KeAcquireInterruptSpinLock()

KIRQL NTAPI KeAcquireInterruptSpinLock

(

IN PKINTERRUPT

Interrupt

)

Definition at line 154 of file spinlock.c.

{
    KIRQL OldIrql;

    /* Raise IRQL */
    KeRaiseIrql(Interrupt->SynchronizeIrql, &OldIrql);

    /* Acquire spinlock on MP */
    KeAcquireSpinLockAtDpcLevel(Interrupt->ActualLock);
    return OldIrql;
}

Referenced by i8042DpcRoutineMouseTimeout(), i8042KbdDpcRoutine(), i8042MouDpcRoutine(), i8042PacketDpc(), i8042StartPacket(), InPortDpcForIsr(), Mx::MxAcquireInterruptSpinLock(), PortAcquireSpinLock(), and StartProcedure().

KeAcquireSpinLockAtDpcLevel()

VOID NTAPI KeAcquireSpinLockAtDpcLevel

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 198 of file spinlock.c.

{
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)SpinLock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }

    /* Do the inlined function */
    KxAcquireSpinLock(SpinLock);
}

Referenced by _Function_class_(), AcpiOsAcquireLock(), CancelQueued(), CcPerformReadAhead(), CcPurgeCacheSection(), CcRosCreateVacb(), CcRosDeleteFileCache(), CcRosFreeUnusedVacb(), CcRosInitializeFileCache(), CcRosLookupVacb(), CcRosMarkDirtyVacb(), CcRosReleaseFileCache(), CcRosTraceCacheMap(), CcRosUnmarkDirtyVacb(), ClasspReleaseQueue(), EthFilterDprIndicateReceiveComplete(), ExpTimerApcKernelRoutine(), ExTimerRundown(), CPortPinWaveCyclic::GeneratePositionEvents(), HalpPCISynchronizeType1(), HalpPCISynchronizeType2(), InterfacePciDevicePresent(), InterfacePciDevicePresentEx(), IntVideoPortResetDisplayParametersEx(), IServiceGroupDpc(), KdbpSymFindModule(), KdbSymProcessSymbols(), KeAcquireInterruptSpinLock(), KeIpiGenericCall(), KeStartProfile(), KeStopProfile(), KeSynchronizeExecution(), KiRetireDpcList(), KsCancelRoutine(), KsMoveIrpsOnCancelableQueue(), KsRemoveIrpFromCancelableQueue(), MiniDoRequest(), MiniportWorker(), MiniRequestComplete(), MiniReset(), MiniTimerDpcFunction(), NdisAcquireReadWriteLock(), NdisDprAcquireSpinLock(), NdisDprAllocatePacket(), NdisDprFreePacket(), NtCancelTimer(), NtSetTimer(), ProtocolReceive(), RxTimerDispatch(), ScsiPortDpcForIsr(), ScsiPortIoTimer(), ScsiPortStartIo(), SpiAllocateSrbStructures(), SpiMiniportTimerDpc(), SpiProcessCompletedRequest(), TcpipAcquireSpinLockAtDpcLevel(), USBPORT_CancelActiveTransferIrp(), USBPORT_CancelPendingTransferIrp(), USBPORT_ClosePipe(), USBPORT_DpcHandler(), USBPORT_EndpointWorker(), USBPORT_FlushCancelList(), USBPORT_FlushPendingTransfers(), USBPORT_GetEndpointState(), USBPORT_IsrDpc(), USBPORT_IsrDpcHandler(), USBPORT_ReopenPipe(), USBPORT_ResetPipe(), USBPORT_RestoreDevice(), USBPORT_WorkerThreadHandler(), USBSTOR_Cancel(), USBSTOR_TimerRoutine(), and VideoPortAcquireSpinLockAtDpcLevel().

KeAcquireSpinLockForDpc()

KIRQL FASTCALL KeAcquireSpinLockForDpc

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 424 of file spinlock.c.

{
    UNIMPLEMENTED;
    return 0;
}

KefAcquireSpinLockAtDpcLevel()

VOID FASTCALL KefAcquireSpinLockAtDpcLevel

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 243 of file spinlock.c.

{
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)SpinLock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }

    /* Do the inlined function */
    KxAcquireSpinLock(SpinLock);
}

KefReleaseSpinLockFromDpcLevel()

VOID FASTCALL KefReleaseSpinLockFromDpcLevel

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 265 of file spinlock.c.

{
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)SpinLock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }

    /* Do the inlined function */
    KxReleaseSpinLock(SpinLock);
}

KeReleaseInStackQueuedSpinLockForDpc()

VOID FASTCALL KeReleaseInStackQueuedSpinLockForDpc

(

IN PKLOCK_QUEUE_HANDLE

LockHandle

)

Definition at line 461 of file spinlock.c.

{
    if (LockHandle->OldIrql >= DISPATCH_LEVEL)
        KeReleaseInStackQueuedSpinLockFromDpcLevel(LockHandle);
    else
        KeReleaseInStackQueuedSpinLock(LockHandle);

}

KeReleaseInStackQueuedSpinLockFromDpcLevel()

VOID FASTCALL KeReleaseInStackQueuedSpinLockFromDpcLevel

(

IN PKLOCK_QUEUE_HANDLE

LockHandle

)

Definition at line 395 of file spinlock.c.

{
#ifdef CONFIG_SMP
#if 0
    /* Call the internal function */
    KeReleaseQueuedSpinLockFromDpcLevel(LockHandle->LockQueue.Next);
#else
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)LockHandle->LockQueue.Lock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }
#endif
#endif

    /* Release the lock */
    KxReleaseSpinLock(LockHandle->LockQueue.Lock); // HACK
}

Referenced by KeReleaseInStackQueuedSpinLockForDpc(), KiReleaseApcLockFromSynchLevel(), KiReleaseDeviceQueueLock(), and KiReleaseProcessLockFromSynchLevel().

KeReleaseInterruptSpinLock()

VOID NTAPI KeReleaseInterruptSpinLock	(	IN PKINTERRUPT	Interrupt,
		IN KIRQL	OldIrql
	)

Definition at line 171 of file spinlock.c.

{
    /* Release lock on MP */
    KeReleaseSpinLockFromDpcLevel(Interrupt->ActualLock);

    /* Lower IRQL */
    KeLowerIrql(OldIrql);
}

Referenced by i8042DpcRoutineMouseTimeout(), i8042KbdDpcRoutine(), i8042MouDpcRoutine(), i8042PacketDpc(), i8042StartPacket(), InPortDpcForIsr(), Mx::MxReleaseInterruptSpinLock(), PortReleaseSpinLock(), and StartProcedure().

KeReleaseSpinLockForDpc()

VOID FASTCALL KeReleaseSpinLockForDpc	(	IN PKSPIN_LOCK	SpinLock,
		IN KIRQL	OldIrql
	)

Definition at line 435 of file spinlock.c.

{
    UNIMPLEMENTED;
}

KeReleaseSpinLockFromDpcLevel()

VOID NTAPI KeReleaseSpinLockFromDpcLevel

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 221 of file spinlock.c.

{
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)SpinLock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }

    /* Do the inlined function */
    KxReleaseSpinLock(SpinLock);
}

Referenced by _Function_class_(), AcpiOsReleaseLock(), CcPerformReadAhead(), CcPurgeCacheSection(), CcRosCreateVacb(), CcRosDeleteFileCache(), CcRosFreeUnusedVacb(), CcRosInitializeFileCache(), CcRosLookupVacb(), CcRosMarkDirtyVacb(), CcRosReleaseFileCache(), CcRosTraceCacheMap(), CcRosUnmarkDirtyVacb(), ClasspReleaseQueue(), EthFilterDprIndicateReceiveComplete(), ExpTimerApcKernelRoutine(), ExTimerRundown(), CPortPinWaveCyclic::GeneratePositionEvents(), InterfacePciDevicePresent(), InterfacePciDevicePresentEx(), IntVideoPortResetDisplayParametersEx(), IServiceGroupDpc(), KdbpSymFindModule(), KdbSymProcessSymbols(), KeIpiGenericCall(), KeReleaseInterruptSpinLock(), KeStartProfile(), KeStopProfile(), KeSynchronizeExecution(), KiRetireDpcList(), KsMoveIrpsOnCancelableQueue(), KsRemoveIrpFromCancelableQueue(), MiniDoRequest(), MiniportWorker(), MiniRequestComplete(), MiniReset(), MiniTimerDpcFunction(), NdisAcquireReadWriteLock(), NdisDprAllocatePacket(), NdisDprFreePacket(), NdisDprReleaseSpinLock(), NtCancelTimer(), NtSetTimer(), ProtocolReceive(), RxTimerDispatch(), ScsiPortDpcForIsr(), ScsiPortIoTimer(), ScsiPortStartIo(), SpiAllocateSrbStructures(), SpiGetNextRequestFromLun(), SpiMiniportTimerDpc(), SpiProcessCompletedRequest(), TcpipReleaseSpinLockFromDpcLevel(), USBPORT_CancelActiveTransferIrp(), USBPORT_CancelPendingTransferIrp(), USBPORT_ClosePipe(), USBPORT_DpcHandler(), USBPORT_EndpointWorker(), USBPORT_FlushCancelList(), USBPORT_FlushPendingTransfers(), USBPORT_GetEndpointState(), USBPORT_IsrDpc(), USBPORT_IsrDpcHandler(), USBPORT_ReopenPipe(), USBPORT_ResetPipe(), USBPORT_RestoreDevice(), USBPORT_WorkerThreadHandler(), USBSTOR_Cancel(), USBSTOR_TimerRoutine(), and VideoPortReleaseSpinLockFromDpcLevel().

KeTestSpinLock()

BOOLEAN FASTCALL KeTestSpinLock

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 475 of file spinlock.c.

{
    /* Test this spinlock */
    if (*SpinLock)
    {
        /* Spinlock is busy, yield execution */
        YieldProcessor();

        /* Return busy flag */
        return FALSE;
    }

    /* Spinlock appears to be free */
    return TRUE;
}

Referenced by InbvAcquireLock(), IntVideoPortResetDisplayParametersEx(), and KdpAcquireLock().

KeTryToAcquireSpinLockAtDpcLevel()

BOOLEAN FASTCALL KeTryToAcquireSpinLockAtDpcLevel

(

IN OUT PKSPIN_LOCK

SpinLock

)

Definition at line 309 of file spinlock.c.

{
#if DBG
    /* Make sure we are at DPC or above! */
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
    {
        /* We aren't -- bugcheck */
        KeBugCheckEx(IRQL_NOT_GREATER_OR_EQUAL,
                     (ULONG_PTR)SpinLock,
                     KeGetCurrentIrql(),
                     0,
                     0);
    }

    /* Make sure that we don't own the lock already */
    if (((KSPIN_LOCK)KeGetCurrentThread() | 1) == *SpinLock)
    {
        /* We do, bugcheck! */
        KeBugCheckEx(SPIN_LOCK_ALREADY_OWNED, (ULONG_PTR)SpinLock, 0, 0, 0);
    }
#endif

#ifdef CONFIG_SMP
    /* Check if it's already acquired */
    if (!(*SpinLock))
    {
        /* Try to acquire it */
        if (InterlockedBitTestAndSet((PLONG)SpinLock, 0))
        {
            /* Someone else acquired it */
            return FALSE;
        }
    }
    else
    {
        /* It was already acquired */
        return FALSE;
    }
#endif

#if DBG
    /* On debug builds, we OR in the KTHREAD */
    *SpinLock = (ULONG_PTR)KeGetCurrentThread() | 1;
#endif

    /* All is well, return TRUE */
    return TRUE;
}

Referenced by KdEnterDebugger(), KdpAcquireLock(), KdPollBreakIn(), KeTryToAcquireQueuedSpinLock(), and KeTryToAcquireQueuedSpinLockRaiseToSynch().

KiAcquireSpinLock()

VOID FASTCALL KiAcquireSpinLock

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 287 of file spinlock.c.

{
    /* Do the inlined function */
    KxAcquireSpinLock(SpinLock);
}

Referenced by InbvAcquireLock(), KdpPortLock(), KeInsertQueueDpc(), and KeRemoveQueueDpc().

KiReleaseSpinLock()

VOID FASTCALL KiReleaseSpinLock

(

IN PKSPIN_LOCK

SpinLock

)

Definition at line 298 of file spinlock.c.

{
    /* Do the inlined function */
    KxReleaseSpinLock(SpinLock);
}

Referenced by InbvReleaseLock(), KdpPortUnlock(), KdpReleaseLock(), KeInsertQueueDpc(), and KeRemoveQueueDpc().