Spinlock.h File Reference

Headers of spinlock routines. More...

Go to the source code of this file.

Macros
#define	ScopedSpinlock(LockObject, CodeToRun)

Functions
BOOLEAN	SpinlockTryLock (volatile LONG *Lock)
	Tries to get the lock otherwise returns.
BOOLEAN	SpinlockCheckLock (volatile LONG *Lock)
	Check the lock without changing the state.
VOID	SpinlockLock (volatile LONG *Lock)
	Tries to get the lock and won't return until successfully get the lock.
VOID	SpinlockLockWithCustomWait (volatile LONG *Lock, UINT32 MaxWait)
	Tries to get the lock and won't return until successfully get the lock.
VOID	SpinlockUnlock (volatile LONG *Lock)
	Release the lock.
VOID	SpinlockInterlockedCompareExchange (LONG volatile *Destination, LONG Exchange, LONG Comperand)
	Interlocked spinlock that tries to change the value and makes sure that it changed the target value.

Detailed Description

Headers of spinlock routines.

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.1

Date

2020-04-10

Copyright

This project is released under the GNU Public License v3.

Macro Definition Documentation

ScopedSpinlock

#define ScopedSpinlock	(		LockObject,
			CodeToRun )

Value:

MetaScopedExpr(SpinlockLock(&LockObject),   \
               SpinlockUnlock(&LockObject), \
               CodeToRun)

#define ScopedSpinlock(LockObject, CodeToRun)   \
    MetaScopedExpr(SpinlockLock(&LockObject),   \
                   SpinlockUnlock(&LockObject), \
                   CodeToRun)

Function Documentation

SpinlockCheckLock()

BOOLEAN SpinlockCheckLock

(

volatile LONG *

Lock

)

Check the lock without changing the state.

Parameters

Lock	Lock variable

Returns

BOOLEAN Whether the lock is acquired or not

{
    if (*Lock)
    {
        return TRUE;
    }
    else
    {
        return FALSE;
    }
}

SpinlockInterlockedCompareExchange()

VOID SpinlockInterlockedCompareExchange	(	LONG volatile *	Destination,
		LONG	Exchange,
		LONG	Comperand )

Interlocked spinlock that tries to change the value and makes sure that it changed the target value.

Parameters

Destination	A pointer to the destination value
Exchange	The exchange value
Comperand	The value to compare to Destination

Returns

VOID

{
    UINT32 Wait = 1;
 
    while (InterlockedCompareExchange(Destination, Exchange, Comperand) != Comperand)
    {
        for (UINT32 i = 0; i < Wait; ++i)
        {
            _mm_pause();
        }
 
        //
        // Don't call "pause" too many times. If the Wait becomes too big,
        // clamp it to the MaxWait.
        //
 
        if (Wait * 2 > g_MaxWait)
        {
            Wait = g_MaxWait;
        }
        else
        {
            Wait = Wait * 2;
        }
    }
}

SpinlockLock()

VOID SpinlockLock

(

volatile LONG *

Lock

)

Tries to get the lock and won't return until successfully get the lock.

Parameters

Lock	Lock variable

Returns

VOID

{
    UINT32 Wait = 1;
 
    while (!SpinlockTryLock(Lock))
    {
        for (UINT32 i = 0; i < Wait; ++i)
        {
            _mm_pause();
        }
 
        //
        // Don't call "pause" too many times. If the Wait becomes too big,
        // clamp it to the MaxWait.
        //
 
        if (Wait * 2 > g_MaxWait)
        {
            Wait = g_MaxWait;
        }
        else
        {
            Wait = Wait * 2;
        }
    }
}

SpinlockLockWithCustomWait()

VOID SpinlockLockWithCustomWait	(	volatile LONG *	Lock,
		UINT32	MaximumWait )

Tries to get the lock and won't return until successfully get the lock.

Parameters

Lock	Lock variable
MaximumWait	Maximum wait (pause) count

Returns

VOID

{
    UINT32 Wait = 1;
 
    while (!SpinlockTryLock(Lock))
    {
        for (UINT32 i = 0; i < Wait; ++i)
        {
            _mm_pause();
        }
 
        //
        // Don't call "pause" too many times. If the Wait becomes too big,
        // clamp it to the MaxWait.
        //
 
        if (Wait * 2 > MaximumWait)
        {
            Wait = MaximumWait;
        }
        else
        {
            Wait = Wait * 2;
        }
    }
}

SpinlockTryLock()

BOOLEAN SpinlockTryLock

(

volatile LONG *

Lock

)

Tries to get the lock otherwise returns.

Parameters

Lock	Lock variable

Returns

BOOLEAN If it was successful on getting the lock

{
    return (!(*Lock) && !_interlockedbittestandset(Lock, 0));
}

SpinlockUnlock()

VOID SpinlockUnlock

(

volatile LONG *

Lock

)

Release the lock.

Parameters

Lock	Lock variable

Returns

VOID

{
    *Lock = 0;
}