cds  2.3.1
cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits > Class Template Reference

Michael's ordered list (template specialization for RCU) More...

#include <cds/container/michael_list_rcu.h>

Inheritance diagram for cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >:
cds::intrusive::MichaelList< cds::urcu::gc< RCU >, T, Traits >

Public Types

typedef cds::urcu::gc< RCU > gc
 RCU.
 
typedef T value_type
 Type of value stored in the list.
 
typedef Traits traits
 List traits.
 
typedef base_class::back_off back_off
 Back-off strategy used.
 
typedef maker::allocator_type allocator_type
 Allocator type used for allocate/deallocate the nodes.
 
typedef base_class::item_counter item_counter
 Item counting policy used.
 
typedef maker::key_comparator key_comparator
 key comparison functor
 
typedef base_class::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef base_class::stat stat
 Internal statistics.
 
typedef base_class::rcu_check_deadlock rcu_check_deadlock
 RCU deadlock checking policy.
 
typedef gc::scoped_lock rcu_lock
 RCU scoped lock.
 
using exempt_ptr = cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer >
 < pointer to extracted node
 
typedef cds::urcu::raw_ptr_adaptor< value_type, typename base_class::raw_ptr, raw_ptr_converter > raw_ptr
 Result of get(), get_with() functions - pointer to the node found.
 

Public Member Functions

 MichaelList ()
 Default constructor. More...
 
 ~MichaelList ()
 List destructor. More...
 
template<typename Q >
bool insert (Q &&val)
 Inserts new node. More...
 
template<typename Q , typename Func >
bool insert (Q &&key, Func func)
 Inserts new node. More...
 
template<typename Q , typename Func >
std::pair< bool, bool > update (Q const &key, Func func, bool bAllowInsert=true)
 Updates data by key. More...
 
template<typename... Args>
bool emplace (Args &&... args)
 Inserts data of type value_type constructed from args. More...
 
template<typename Q >
bool erase (Q const &key)
 Deletes key from the list. More...
 
template<typename Q , typename Less >
bool erase_with (Q const &key, Less pred)
 Deletes the item from the list using pred predicate for searching. More...
 
template<typename Q , typename Func >
bool erase (Q const &key, Func f)
 Deletes key from the list. More...
 
template<typename Q , typename Less , typename Func >
bool erase_with (Q const &key, Less pred, Func f)
 Deletes the item from the list using pred predicate for searching. More...
 
template<typename Q >
exempt_ptr extract (Q const &key)
 Extracts an item from the list. More...
 
template<typename Q , typename Less >
exempt_ptr extract_with (Q const &key, Less pred)
 Extracts an item from the list using pred predicate for searching. More...
 
template<typename Q >
bool contains (Q const &key)
 Checks whether the list contains key. More...
 
template<typename Q , typename Less >
bool contains (Q const &key, Less pred)
 Checks whether the list contains key using pred predicate for searching. More...
 
template<typename Q , typename Func >
bool find (Q &key, Func f)
 Finds the key key and performs an action with it. More...
 
template<typename Q , typename Less , typename Func >
bool find_with (Q &key, Less pred, Func f)
 Finds the key key using pred predicate for searching. More...
 
template<typename Q >
raw_ptr get (Q const &key)
 Finds the key key and return the item found. More...
 
template<typename Q , typename Less >
raw_ptr get_with (Q const &key, Less pred)
 Finds key and return the item found. More...
 
bool empty () const
 Checks if the list is empty.
 
size_t size () const
 Returns list's item count. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
void clear ()
 Clears the list.
 

Static Public Attributes

static constexpr const bool c_bExtractLockExternal = base_class::c_bExtractLockExternal
 Group of extract_xxx functions do not require external locking.
 

Forward iterators (only for debugging purpose)

typedef iterator_type< false > iterator
 Forward iterator. More...
 
typedef iterator_type< true > const_iterator
 Const forward iterator.
 
iterator begin ()
 Returns a forward iterator addressing the first element in a list. More...
 
iterator end ()
 Returns an iterator that addresses the location succeeding the last element in a list. More...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cbegin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cend () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 

Additional Inherited Members

- Protected Types inherited from cds::intrusive::MichaelList< cds::urcu::gc< RCU >, T, Traits >
typedef node_type::marked_ptr marked_node_ptr
 Marked node pointer.
 
typedef node_type::atomic_marked_ptr atomic_node_ptr
 Atomic node pointer.
 
typedef atomic_node_ptr auxiliary_head
 Auxiliary head type (for split-list support)
 
typedef T value_type
 type of value stored in the list
 
typedef Traits traits
 Traits template parameter.
 
typedef traits::hook hook
 hook type
 
typedef hook::node_type node_type
 node type
 
typedef implementation_defined key_comparator
 key comparison functor based on opt::compare and opt::less option setter.
 
typedef traits::disposer disposer
 disposer used
 
typedef get_node_traits< value_type, node_type, hook >::type node_traits
 node traits
 
typedef michael_list::get_link_checker< node_type, traits::link_checker >::type link_checker
 link checker
 
typedef cds::urcu::gc< RCU > gc
 RCU schema.
 
typedef traits::back_off back_off
 back-off strategy
 
typedef traits::item_counter item_counter
 Item counting policy used.
 
typedef traits::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef traits::rcu_check_deadlock rcu_check_deadlock
 Deadlock checking policy.
 
typedef traits::stat stat
 Internal statistics.
 
typedef gc::scoped_lock rcu_lock
 RCU scoped lock.
 
using exempt_ptr = cds::urcu::exempt_ptr< gc, value_type, value_type, clear_and_dispose, void >
 pointer to extracted node
 
typedef cds::urcu::raw_ptr< gc, value_type, raw_ptr_disposer > raw_ptr
 Result of get(), get_with() functions - pointer to the node found.
 
typedef iterator_type< false > iterator
 Forward iterator. More...
 
typedef iterator_type< true > const_iterator
 Const forward iterator.
 
- Protected Member Functions inherited from cds::intrusive::MichaelList< cds::urcu::gc< RCU >, T, Traits >
 MichaelList ()
 Default constructor initializes empty list.
 
 ~MichaelList ()
 Destroy list.
 
bool insert (value_type &val)
 Inserts new node. More...
 
template<typename Func >
bool insert (value_type &val, Func f)
 Inserts new node. More...
 
template<typename Func >
std::pair< bool, bool > update (value_type &val, Func func, bool bAllowInsert=true)
 Updates the item. More...
 
bool unlink (value_type &val)
 Unlinks the item val from the list. More...
 
template<typename Q >
bool erase (Q const &key)
 Deletes the item from the list. More...
 
template<typename Q , typename Less >
bool erase_with (Q const &key, Less pred)
 Deletes the item from the list using pred predicate for searching. More...
 
template<typename Q , typename Func >
bool erase (Q const &key, Func func)
 Deletes the item from the list. More...
 
template<typename Q , typename Less , typename Func >
bool erase_with (Q const &key, Less pred, Func func)
 Deletes the item from the list using pred predicate for searching. More...
 
template<typename Q >
exempt_ptr extract (Q const &key)
 Extracts an item from the list. More...
 
template<typename Q , typename Less >
exempt_ptr extract_with (Q const &key, Less pred)
 Extracts an item from the list using pred predicate for searching. More...
 
template<typename Q , typename Func >
bool find (Q &key, Func f)
 Find the key val. More...
 
template<typename Q , typename Less , typename Func >
bool find_with (Q &key, Less pred, Func f)
 Finds key using pred predicate for searching. More...
 
template<typename Q >
bool contains (Q const &key)
 Checks whether the list contains key. More...
 
template<typename Q , typename Less >
bool contains (Q const &key, Less pred)
 Checks whether the map contains key using pred predicate for searching. More...
 
template<typename Q >
raw_ptr get (Q const &key)
 Finds key and return the item found. More...
 
template<typename Q , typename Less >
raw_ptr get_with (Q const &key, Less pred)
 Finds key and return the item found. More...
 
void clear ()
 Clears the list using default disposer. More...
 
bool empty () const
 Check if the list is empty.
 
size_t size () const
 Returns list's item count. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
iterator begin ()
 Returns a forward iterator addressing the first element in a list. More...
 
iterator end ()
 Returns an iterator that addresses the location succeeding the last element in a list. More...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cbegin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cend () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
- Protected Attributes inherited from cds::intrusive::MichaelList< cds::urcu::gc< RCU >, T, Traits >
atomic_node_ptr m_pHead
 Head pointer.
 
item_counter m_ItemCounter
 Item counter.
 
stat m_Stat
 Internal statistics.
 
- Static Protected Attributes inherited from cds::intrusive::MichaelList< cds::urcu::gc< RCU >, T, Traits >
static constexpr const bool c_bExtractLockExternal = false
 Group of extract_xxx functions do not require external locking.
 

Detailed Description

template<typename RCU, typename T, typename Traits = michael_list::traits>
class cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >

Michael's ordered list (template specialization for RCU)

Usually, ordered single-linked list is used as a building block for the hash table implementation. The complexity of searching is O(N).

Source:

  • [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"

This class is non-intrusive version of cds::intrusive::MichaelList RCU specialization.

Template arguments:

  • RCU - one of RCU type
  • T - type stored in the list. The type must be default- and copy-constructible.
  • Traits - type traits, default is michael_list::traits

The implementation does not divide type T into key and value part and may be used as a main building block for hash set containers. The key is a function (or a part) of type T, and this function is specified by Traits::compare functor or Traits::less predicate.

MichaelKVList is a key-value version of Michael's non-intrusive list that is closer to the C++ std library approach.

Note
Before including <cds/container/michael_list_rcu.h> you should include appropriate RCU header file, see RCU type for list of existing RCU class and corresponding header files.

It is possible to declare option-based list with cds::container::michael_list::make_traits metafunction istead of Traits template argument. For example, the following traits-based declaration of Michael's list

#include <cds/urcu/general_buffered.h>
#include <cds/container/michael_list_rcu.h>
// Declare comparator for the item
struct my_compare {
int operator ()( int i1, int i2 )
{
return i1 - i2;
}
};
// Declare traits
struct my_traits: public cds::container::michael_list::traits
{
typedef my_compare compare;
};
// Declare traits-based list

is equivalent for the following option-based list

#include <cds/urcu/general_buffered.h>
#include <cds/container/michael_list_rcu.h>
// my_compare is the same
// Declare option-based list
typedef cds::container::MichaelList< cds::urcu::gc< cds::urcu::general_buffered<> >, int,
>::type
> option_based_list;

Template argument list Options of cds::container::michael_list::make_traits metafunction are:

Member Typedef Documentation

◆ iterator

template<typename RCU , typename T , typename Traits = michael_list::traits>
typedef iterator_type<false> cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::iterator

Forward iterator.

You may safely use iterators in multi-threaded environment only under RCU lock. Otherwise, a crash is possible if another thread deletes the item the iterator points to.

Constructor & Destructor Documentation

◆ MichaelList()

template<typename RCU , typename T , typename Traits = michael_list::traits>
cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::MichaelList ( )
inline

Default constructor.

Initialize empty list

◆ ~MichaelList()

template<typename RCU , typename T , typename Traits = michael_list::traits>
cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::~MichaelList ( )
inline

List destructor.

Clears the list

Member Function Documentation

◆ begin()

template<typename RCU , typename T , typename Traits = michael_list::traits>
iterator cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::begin ( )
inline

Returns a forward iterator addressing the first element in a list.

For empty list

begin() == end()

◆ contains() [1/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::contains ( Q const &  key)
inline

Checks whether the list contains key.

The function searches the item with key equal to key and returns true if it is found, and false otherwise.

The function applies RCU lock internally.

◆ contains() [2/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::contains ( Q const &  key,
Less  pred 
)
inline

Checks whether the list contains key using pred predicate for searching.

The function is an analog of contains( key ) but pred is used for key comparing. Less functor has the interface like std::less. pred must imply the same element order as the comparator used for building the list.

◆ emplace()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename... Args>
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::emplace ( Args &&...  args)
inline

Inserts data of type value_type constructed from args.

Returns true if inserting successful, false otherwise.

The function makes RCU lock internally.

◆ end()

template<typename RCU , typename T , typename Traits = michael_list::traits>
iterator cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::end ( )
inline

Returns an iterator that addresses the location succeeding the last element in a list.

Do not use the value returned by end function to access any item. Internally, end returning value equals to nullptr.

The returned value can be used only to control reaching the end of the list. For empty list

begin() == end()

◆ erase() [1/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::erase ( Q const &  key)
inline

Deletes key from the list.

Since the key of MichaelList's item type value_type is not explicitly specified, template parameter Q defines the key type searching in the list. The list item comparator should be able to compare values of the type value_type and Q in any order.

RCU synchronize method can be called. RCU should not be locked.

Return true if key is found and deleted, false otherwise

◆ erase() [2/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Func >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::erase ( Q const &  key,
Func  f 
)
inline

Deletes key from the list.

The function searches an item with key key, calls f functor with item found and deletes it. If key is not found, the functor is not called.

The functor Func interface:

struct functor {
void operator()(const value_type& val) { ... }
};

Since the key of MichaelList's item type value_type is not explicitly specified, template parameter Q defines the key type searching in the list. The list item comparator should be able to compare the values of type value_type and Q in any order.

RCU synchronize method can be called. RCU should not be locked.

Return true if key is found and deleted, false otherwise

◆ erase_with() [1/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::erase_with ( Q const &  key,
Less  pred 
)
inline

Deletes the item from the list using pred predicate for searching.

The function is an analog of erase(Q const&) but pred is used for key comparing. Less functor has the interface like std::less. pred must imply the same element order as the comparator used for building the list.

◆ erase_with() [2/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less , typename Func >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::erase_with ( Q const &  key,
Less  pred,
Func  f 
)
inline

Deletes the item from the list using pred predicate for searching.

The function is an analog of erase(Q const&, Func) but pred is used for key comparing. Less functor has the interface like std::less. pred must imply the same element order as the comparator used for building the list.

◆ extract()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q >
exempt_ptr cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::extract ( Q const &  key)
inline

Extracts an item from the list.

The function searches an item with key equal to key in the list, unlinks it from the list, and returns exempt_ptr pointer to the item found. If the item with the key equal to key is not found the function returns an empty exempt_ptr.

Note
The function does NOT dispose the item found. It just excludes the item from the list and returns a pointer to the item. You shouldn't lock RCU for current thread before calling this function.
#include <cds/urcu/general_buffered.h>
#include <cds/container/michael_list_rcu.h>
typedef cds::urcu::gc< general_buffered<> > rcu;
typedef cds::container::MichaelList< rcu, Foo > rcu_michael_list;
rcu_michael_list theList;
// ...
rcu_michael_list::exempt_ptr p;
// The RCU should NOT be locked when extract() is called!
assert( !rcu::is_locked());
// extract() call
p = theList.extract( 10 )
if ( p ) {
// do something with p
...
}
// we may safely release extracted pointer here.
// release() passes the pointer to RCU reclamation cycle.
p.release();

◆ extract_with()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less >
exempt_ptr cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::extract_with ( Q const &  key,
Less  pred 
)
inline

Extracts an item from the list using pred predicate for searching.

This function is the analog for extract(Q const&).

The pred is a predicate used for key comparing. Less has the interface like std::less. pred must imply the same element order as key_comparator.

◆ find()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Func >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::find ( Q &  key,
Func  f 
)
inline

Finds the key key and performs an action with it.

The function searches an item with key equal to key and calls the functor f for the item found. The interface of Func functor is:

struct functor {
void operator()( value_type& item, Q& key );
};

where item is the item found, key is the find() function argument.

The functor may change non-key fields of item. Note that the function is only guarantee that item cannot be deleted during functor is executing. The function does not serialize simultaneous access to the list item. If such access is possible you must provide your own synchronization schema to exclude unsafe item modifications.

The function makes RCU lock internally.

The function returns true if val is found, false otherwise.

◆ find_with()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less , typename Func >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::find_with ( Q &  key,
Less  pred,
Func  f 
)
inline

Finds the key key using pred predicate for searching.

The function is an analog of find(Q&, Func) but pred is used for key comparing. Less functor has the interface like std::less. pred must imply the same element order as the comparator used for building the list.

◆ get()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q >
raw_ptr cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::get ( Q const &  key)
inline

Finds the key key and return the item found.

The function searches the item with key equal to key and returns the pointer to item found. If key is not found it returns an empty raw_ptr.

Note the compare functor should accept a parameter of type Q that can be not the same as value_type.

RCU should be locked before call of this function. Returned item is valid only while RCU is locked:

typedef cds::container::MichaelList< cds::urcu::gc< cds::urcu::general_buffered<> >, foo, my_traits > ord_list;
ord_list theList;
// ...
typename ord_list::raw_ptr rp;
{
// Lock RCU
ord_list::rcu_lock lock;
rp = theList.get( 5 );
if ( rp ) {
// Deal with rp
//...
}
// Unlock RCU by rcu_lock destructor
// A value owned by rp can be freed at any time after RCU has been unlocked
}
// You can manually release rp after RCU-locked section
rp.release();

◆ get_with()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Less >
raw_ptr cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::get_with ( Q const &  key,
Less  pred 
)
inline

Finds key and return the item found.

The function is an analog of get(Q const&) but pred is used for comparing the keys.

Less functor has the semantics like std::less but should take arguments of type value_type and Q in any order. pred must imply the same element order as the comparator used for building the list.

◆ insert() [1/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::insert ( Q &&  val)
inline

Inserts new node.

The function creates a node with copy of val value and then inserts the node created into the list.

The type Q should contain as minimum the complete key of the node. The object of value_type should be constructible from val of type Q. In trivial case, Q is equal to value_type.

The function makes RCU lock internally.

Returns true if inserting successful, false otherwise.

◆ insert() [2/2]

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Func >
bool cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::insert ( Q &&  key,
Func  func 
)
inline

Inserts new node.

This function inserts new node with default-constructed value and then it calls func functor with signature

void func( value_type& itemValue ) ;

The argument itemValue of user-defined functor func is the reference to the list's item inserted. User-defined functor func should guarantee that during changing item's value no any other changes could be made on this list's item by concurrent threads.

The type Q should contain the complete key of the node. The object of value_type should be constructible from key of type Q.

The function allows to split creating of new item into two part:

  • create item from key with initializing key-fields only;
  • insert new item into the list;
  • if inserting is successful, initialize non-key fields of item by calling f functor

This can be useful if complete initialization of object of value_type is heavyweight and it is preferable that the initialization should be completed only if inserting is successful.

The function makes RCU lock internally.

Warning
See insert item troubleshooting

◆ size()

template<typename RCU , typename T , typename Traits = michael_list::traits>
size_t cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::size ( ) const
inline

Returns list's item count.

The value returned depends on item counter provided by Traits. For atomicity::empty_item_counter, this function always returns 0.

Note
Even if you use real item counter and it returns 0, this fact does not mean that the list is empty. To check list emptyness use empty() method.

◆ update()

template<typename RCU , typename T , typename Traits = michael_list::traits>
template<typename Q , typename Func >
std::pair<bool, bool> cds::container::MichaelList< cds::urcu::gc< RCU >, T, Traits >::update ( Q const &  key,
Func  func,
bool  bAllowInsert = true 
)
inline

Updates data by key.

The operation performs inserting or replacing the element with lock-free manner.

If the key not found in the list, then the new item created from key will be inserted iff bAllowInsert is true. Otherwise, if key is found, the functor func is called with item found.

The functor Func signature is:

struct my_functor {
void operator()( bool bNew, value_type& item, Q const& val );
};

with arguments:

  • bNew - true if the item has been inserted, false otherwise
  • item - item of the list
  • val - argument key passed into the update() function

The functor may change non-key fields of the item; however, func must guarantee that during changing no any other modifications could be made on this item by concurrent threads.

The function applies RCU lock internally.

Returns std::pair<bool, bool> where first is true if operation is successful, second is true if new item has been added or false if the item with key already exists.

Warning
See insert item troubleshooting

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

cds 2.3.1 Developed by Maxim Khizhinsky aka khizmax 2007 - 2017
Autogenerated Fri Sep 1 2017 08:47:06 by Doxygen 1.8.13