spinlock.cpp File Reference

This is the implementation for custom spinlock. More...

#include "pch.h"

Functions
BOOLEAN	SpinlockTryLock (volatile LONG *Lock)
	Tries to get the lock otherwise returns.
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 MaximumWait)
	Tries to get the lock and won't return until successfully get the lock.
VOID	SpinlockUnlock (volatile LONG *Lock)
	Release the lock.

Detailed Description

This is the implementation for custom spinlock.

Author

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

This implementation is derived from Hvpp by Petr Benes

• https://github.com/wbenny/hvpp Based on my benchmarks, this simple implementation beats other (often more complex) spinlock implementations - such as queue spinlocks, ticket spinlocks, MCS locks. The only difference between this implementation and completely naive spinlock is the "backoff".

Also, benefit of this implementation is that we can use it with STL lock guards, e.g.: std::lock_guard.

Look here for more information:

• https://locklessinc.com/articles/locks/
• https://github.com/cyfdecyf/spinlock

Version

0.1

Date

2022-05-19

Copyright

This project is released under the GNU Public License v3.

Function Documentation

SpinlockLock()

VOID SpinlockLock

(

volatile LONG *

Lock

)

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

Parameters

Lock	Lock variable
Lock	Lock variable

Returns

VOID

{
    UINT32 Wait = 1;
 
    while (!SpinlockTryLock(Lock))
    {
        for (UINT32 i = 0; i < Wait; ++i)
        {
            CpuPause();
        }
 
        //
        // Don't call "pause" too many times. If the wait becomes too big,
        // clamp it to the MaxWait.
        //
 
        if (Wait * 2 > MaxWait)
        {
            Wait = 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
Lock	Lock variable
MaximumWait	Maximum wait (pause) count

Returns

VOID

{
    UINT32 Wait = 1;
 
    while (!SpinlockTryLock(Lock))
    {
        for (UINT32 i = 0; i < Wait; ++i)
        {
            CpuPause();
        }
 
        //
        // 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) && !CpuInterlockedBitTestAndSet(Lock, 0));
}

SpinlockUnlock()

VOID SpinlockUnlock

(

volatile LONG *

Lock

)

Release the lock.

Parameters

Lock	Lock variable
Lock	Lock variable

Returns

VOID

{
    *Lock = 0;
}