quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T > Struct Template Reference

#include "spinlock.hpp"

Classes
union	_internals

Public Types
typedef T	value_type

Public Member Functions
constexpr	ordered_spinlockbase () noexcept
	ordered_spinlockbase (const ordered_spinlockbase &)=delete
	ordered_spinlockbase (ordered_spinlockbase &&) noexcept
	Atomically move constructs.
	~ordered_spinlockbase ()
ordered_spinlockbase &	operator= (const ordered_spinlockbase &)=delete
ordered_spinlockbase &	operator= (ordered_spinlockbase &&)=delete
constexpr T	load (memory_order o=memory_order_seq_cst) const noexcept
	Returns the raw atomic.
void	store (T a, memory_order o=memory_order_seq_cst) noexcept
	Sets the raw atomic.
bool	try_lock () noexcept
	Tries to lock the spinlock, returning true if successful.
void	unlock () noexcept
	Releases the lock.
bool	int_yield (size_t) noexcept

Protected Types
using	_halfT = typename detail::choose_half_type< value_type >::type

Protected Member Functions
value_type	_begin_try_lock () noexcept
bool	_try_lock (value_type &state) noexcept

Protected Attributes
atomic< value_type >	_v

Member Typedef Documentation

value_type

template<typename T >

typedef T quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::value_type

_halfT

template<typename T >

using quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::_halfT = typename detail::choose_half_type<value_type>::type

protected

Constructor & Destructor Documentation

ordered_spinlockbase() [1/3]

template<typename T >

constexpr quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::ordered_spinlockbase ( )

inlineconstexprnoexcept

        : _v(0)
    {
      QUICKCPPLIB_ANNOTATE_RWLOCK_CREATE(this);
      // v.store(0, memory_order_release);
    }

ordered_spinlockbase() [2/3]

template<typename T >

quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::ordered_spinlockbase ( const ordered_spinlockbase< T > &  )

delete

ordered_spinlockbase() [3/3]

template<typename T >

quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::ordered_spinlockbase ( ordered_spinlockbase< T > &&  )

inlinenoexcept

Atomically move constructs.

        : _v(0)
    {
      QUICKCPPLIB_ANNOTATE_RWLOCK_CREATE(this);
      // v.store(o.v.exchange(0, memory_order_acq_rel));
      // v.store(0, memory_order_release);
    }

~ordered_spinlockbase()

template<typename T >

quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::~ordered_spinlockbase ( )

inline

    {
#ifdef QUICKCPPLIB_ENABLE_VALGRIND
      _internals i = {_v.load(memory_order_relaxed)};
      if(i.entry != i.exit)
      {
        QUICKCPPLIB_ANNOTATE_RWLOCK_RELEASED(this, true);
      }
#endif
      QUICKCPPLIB_ANNOTATE_RWLOCK_DESTROY(this);
    }

Member Function Documentation

operator=() [1/2]

template<typename T >

ordered_spinlockbase & quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::operator= ( const ordered_spinlockbase< T > &  )

delete

operator=() [2/2]

template<typename T >

ordered_spinlockbase & quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::operator= ( ordered_spinlockbase< T > &&  )

delete

load()

template<typename T >

constexpr T quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::load ( memory_order  o = memory_order_seq_cst ) const

inlineconstexprnoexcept

Returns the raw atomic.

{ return _v.load(o); }

store()

template<typename T >

void quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::store ( T  a, memory_order  o = memory_order_seq_cst  )

inlinenoexcept

Sets the raw atomic.

{ _v.store(a, o); }

try_lock()

template<typename T >

bool quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::try_lock ( )

inlinenoexcept

Tries to lock the spinlock, returning true if successful.

    {
      _internals i = {_v.load(memory_order_relaxed)}, o = i;
      // If locked, bail out immediately
      if(i.entry != i.exit)
        return false;
      o.entry++;
      if(_v.compare_exchange_weak(i.uint, o.uint, memory_order_acquire, memory_order_relaxed))
      {
        QUICKCPPLIB_ANNOTATE_RWLOCK_ACQUIRED(this, true);
        return true;
      }
      return false;
    }

_begin_try_lock()

template<typename T >

value_type quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::_begin_try_lock ( )

inlineprotectednoexcept

{ return _v.load(memory_order_relaxed); }

_try_lock()

template<typename T >

bool quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::_try_lock ( value_type &  state )

inlineprotectednoexcept

    {
      _internals i = {state}, o;
      o = i;
      o.entry++;
      if(_v.compare_exchange_weak(i.uint, o.uint, memory_order_acquire, memory_order_relaxed))
      {
        QUICKCPPLIB_ANNOTATE_RWLOCK_ACQUIRED(this, true);
        return true;
      }
      state = i.uint;
      return false;
    }

unlock()

template<typename T >

void quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::unlock ( )

inlinenoexcept

Releases the lock.

    {
      QUICKCPPLIB_ANNOTATE_RWLOCK_RELEASED(this, true);
      _internals i = {_v.load(memory_order_relaxed)}, o;
      for(;;)
      {
        o = i;
        o.exit++;
        if(_v.compare_exchange_weak(i.uint, o.uint, memory_order_release, memory_order_relaxed))
          return;
      }
    }

int_yield()

template<typename T >

bool quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::int_yield ( size_t  )

inlinenoexcept

{ return false; }

Member Data Documentation

_v

template<typename T >

atomic<value_type> quickcpplib::_xxx::configurable_spinlock::ordered_spinlockbase< T >::_v

protected

---

The documentation for this struct was generated from the following file:

• include/quickcpplib/spinlock.hpp