spin-locks 0.0.2

An Intel hardware-optimized spin lock that uses Hardware Lock Elision (HLE) and a non-CAS based spin lock (an OR lock) as a fast fallback.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

// This file is part of nvml. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/nvml/master/COPYRIGHT. No part of predicator, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2017 The developers of nvml. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/nvml/master/COPYRIGHT.


/// A spin-lock API.
pub trait SpinLock: Default
{
	/// Returns true if acquired spin lock.
	#[inline(always)]
	fn acquire_spin_lock(&self);
	
	/// Returns true if acquired spin lock.
	#[inline(always)]
	fn try_to_acquire_spin_lock(&self) -> bool;
	
	/// Unlocks the spin lock.
	#[inline(always)]
	fn unlock_spin_lock(&self);
	
	/// Returns true if locked (but not necessarily by this thread).
	#[inline(always)]
	fn is_locked(&self) -> bool;
	
	/// Returns true if unlocked.
	#[inline(always)]
	fn is_unlocked(&self) -> bool;
	
	/// Forcibly unlocks the spin lock, even if it is currently unlocked.
	/// Useful for working with persistent memory.
	#[inline(always)]
	fn forcibly_unlock_spin_lock(&self);
}