#include <concurrent_map.h>

Classes
class	Iterator

class	Mutator

Public Types
typedef Leapfrog< ConcurrentMap >	Details

typedef quint32	Hash

typedef K	Key

typedef KT	KeyTraits

typedef V	Value

typedef VT	ValueTraits

Public Member Functions
Value	assign (Key key, Value desired)

	ConcurrentMap (quint64 capacity=Details::InitialSize)

Value	erase (Key key)

Value	exchange (Key key, Value desired)

Mutator	find (Key key)

Value	get (Key key)

QSBR &	getGC ()

Mutator	insertOrFind (Key key)

bool	migrationInProcess ()

void	publishTableMigration (typename Details::TableMigration *migration)

	~ConcurrentMap ()

Private Attributes
QSBR	m_gc

Atomic< typename Details::Table * >	m_root

Detailed Description

template<typename K, typename V, class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>
class ConcurrentMap< K, V, KT, VT >

Definition at line 18 of file concurrent_map.h.

Member Typedef Documentation

◆ Details

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef Leapfrog<ConcurrentMap> ConcurrentMap< K, V, KT, VT >::Details

Definition at line 26 of file concurrent_map.h.

◆ Hash

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef quint32 ConcurrentMap< K, V, KT, VT >::Hash

Definition at line 25 of file concurrent_map.h.

◆ Key

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef K ConcurrentMap< K, V, KT, VT >::Key

Definition at line 21 of file concurrent_map.h.

◆ KeyTraits

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef KT ConcurrentMap< K, V, KT, VT >::KeyTraits

Definition at line 23 of file concurrent_map.h.

◆ Value

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef V ConcurrentMap< K, V, KT, VT >::Value

Definition at line 22 of file concurrent_map.h.

◆ ValueTraits

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

typedef VT ConcurrentMap< K, V, KT, VT >::ValueTraits

Definition at line 24 of file concurrent_map.h.

Constructor & Destructor Documentation

◆ ConcurrentMap()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

ConcurrentMap< K, V, KT, VT >::ConcurrentMap ( quint64 capacity = Details::InitialSize )

inline

Definition at line 33 of file concurrent_map.h.

                                                         : m_root(Details::Table::create(capacity))
    {
    }

◆ ~ConcurrentMap()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

ConcurrentMap< K, V, KT, VT >::~ConcurrentMap ( )

inline

Definition at line 37 of file concurrent_map.h.

    {
        typename Details::Table* table = m_root.loadNonatomic();
        table->destroy();
        m_gc.flush();
    }

References Leapfrog< Map >::Table::destroy(), QSBR::flush(), ConcurrentMap< K, V, KT, VT >::m_gc, and ConcurrentMap< K, V, KT, VT >::m_root.

Member Function Documentation

◆ assign()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Value ConcurrentMap< K, V, KT, VT >::assign	(	Key	key,
		Value	desired )

inline

Definition at line 279 of file concurrent_map.h.

    {
        Mutator iter(*this, key);
        return iter.exchangeValue(desired);
    }

References ConcurrentMap< K, V, KT, VT >::Mutator::exchangeValue().

◆ erase()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Value ConcurrentMap< K, V, KT, VT >::erase ( Key key )

inline

Definition at line 291 of file concurrent_map.h.

    {
        Mutator iter(*this, key, false);
        return iter.eraseValue();
    }

References ConcurrentMap< K, V, KT, VT >::Mutator::eraseValue().

◆ exchange()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Value ConcurrentMap< K, V, KT, VT >::exchange	(	Key	key,
		Value	desired )

inline

Definition at line 285 of file concurrent_map.h.

    {
        Mutator iter(*this, key);
        return iter.exchangeValue(desired);
    }

References ConcurrentMap< K, V, KT, VT >::Mutator::exchangeValue().

◆ find()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Mutator ConcurrentMap< K, V, KT, VT >::find ( Key key )

inline

Definition at line 253 of file concurrent_map.h.

    {
        return Mutator(*this, key, false);
    }

◆ get()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Value ConcurrentMap< K, V, KT, VT >::get ( Key key )

inline

Definition at line 259 of file concurrent_map.h.

    {
        Hash hash = KeyTraits::hash(key);
        for (;;) {
            typename Details::Table* table = m_root.load(Consume);
            typename Details::Cell* cell = Details::find(hash, table);
            if (!cell) {
                return Value(ValueTraits::NullValue);
            }
 
            Value value = cell->value.load(Consume);
            if (value != Value(ValueTraits::Redirect)) {
                return value; // Found an existing value
            }
            // We've been redirected to a new table. Help with the migration.
            table->jobCoordinator.participate();
            // Try again in the new table.
        }
    }

References Consume, Leapfrog< Map >::find(), Leapfrog< Map >::Table::jobCoordinator, Atomic< T >::load(), ConcurrentMap< K, V, KT, VT >::m_root, SimpleJobCoordinator::participate(), Leapfrog< Map >::Cell::value, and value().

◆ getGC()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

QSBR & ConcurrentMap< K, V, KT, VT >::getGC ( )

inline

Definition at line 44 of file concurrent_map.h.

    {
        return m_gc;
    }

References ConcurrentMap< K, V, KT, VT >::m_gc.

◆ insertOrFind()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Mutator ConcurrentMap< K, V, KT, VT >::insertOrFind ( Key key )

inline

Definition at line 248 of file concurrent_map.h.

    {
        return Mutator(*this, key);
    }

◆ migrationInProcess()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

bool ConcurrentMap< K, V, KT, VT >::migrationInProcess ( )

inline

Definition at line 49 of file concurrent_map.h.

    {
        return quint64(m_root.loadNonatomic()->jobCoordinator.loadConsume()) > 1;
    }

References ConcurrentMap< K, V, KT, VT >::m_root.

◆ publishTableMigration()

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

void ConcurrentMap< K, V, KT, VT >::publishTableMigration ( typename Details::TableMigration * migration )

inline

Definition at line 56 of file concurrent_map.h.

    {
        m_root.store(migration->m_destination, Release);
        // Caller will GC the TableMigration and the source table.
    }

References Leapfrog< Map >::TableMigration::m_destination, ConcurrentMap< K, V, KT, VT >::m_root, and Release.

Member Data Documentation

◆ m_gc

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

QSBR ConcurrentMap< K, V, KT, VT >::m_gc

private

Definition at line 30 of file concurrent_map.h.

◆ m_root

template<typename K , typename V , class KT = DefaultKeyTraits<K>, class VT = DefaultValueTraits<V>>

Atomic<typename Details::Table*> ConcurrentMap< K, V, KT, VT >::m_root

private

Definition at line 29 of file concurrent_map.h.

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

libs/image/3rdparty/lock_free_map/concurrent_map.h

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Details

◆ Hash

◆ Key

◆ KeyTraits

◆ Value

◆ ValueTraits

Constructor & Destructor Documentation

◆ ConcurrentMap()

◆ ~ConcurrentMap()

Member Function Documentation

◆ assign()

◆ erase()

◆ exchange()

◆ find()

◆ get()

◆ getGC()

◆ insertOrFind()

◆ migrationInProcess()

◆ publishTableMigration()

Member Data Documentation

◆ m_gc

◆ m_root