typedef cds::details::compare_wrapper< node_type, cds::opt::details::make_comparator_from_less<Less>, key_field_accessor > type;
};
- struct type_traits: public original_type_traits
+ struct intrusive_traits: public original_type_traits
{
typedef intrusive::michael_list::base_hook< opt::gc<gc> > hook;
typedef node_deallocator disposer;
typedef cds::details::compare_wrapper< node_type, key_comparator, key_field_accessor > compare;
+ static const opt::link_check_type link_checker = intrusive::michael_list::traits::link_checker;
};
- typedef intrusive::MichaelList<gc, node_type, type_traits> type;
+ typedef intrusive::MichaelList<gc, node_type, intrusive_traits> type;
};
} // namespace details
//@endcond
{}
};
- typedef Traits original_type_traits;
+ typedef Traits original_traits;
- typedef typename original_type_traits::allocator::template rebind<node_type>::other allocator_type;
- typedef cds::details::Allocator< node_type, allocator_type > cxx_allocator;
+ typedef typename original_traits::allocator::template rebind<node_type>::other allocator_type;
+ typedef cds::details::Allocator< node_type, allocator_type > cxx_allocator;
struct node_deallocator
{
}
};
- typedef typename opt::details::make_comparator< value_type, original_type_traits >::type key_comparator;
+ typedef typename opt::details::make_comparator< value_type, original_traits >::type key_comparator;
struct value_accessor
{
template <typename Less>
struct less_wrapper {
- typedef cds::details::compare_wrapper< node_type, cds::opt::details::make_comparator_from_less<Less>, value_accessor > type;
+ typedef cds::details::compare_wrapper< node_type, cds::opt::details::make_comparator_from_less<Less>, value_accessor > type;
};
- struct type_traits: public original_type_traits
+ struct intrusive_traits: public original_traits
{
- typedef intrusive::michael_list::base_hook< opt::gc<gc> > hook;
- typedef node_deallocator disposer;
-
+ typedef intrusive::michael_list::base_hook< opt::gc<gc> > hook;
+ typedef node_deallocator disposer;
typedef cds::details::compare_wrapper< node_type, key_comparator, value_accessor > compare;
+ static const opt::link_check_type link_checker = intrusive::michael_list::traits::link_checker;
};
- typedef intrusive::MichaelList<gc, node_type, type_traits> type;
+ typedef intrusive::MichaelList<gc, node_type, intrusive_traits> type;
};
} // namespace details
//@endcond
/** @ingroup cds_nonintrusive_helper
*/
namespace michael_list {
- /// Michael list default type traits
- struct type_traits
+ /// MichaelList traits
+ struct traits
{
typedef CDS_DEFAULT_ALLOCATOR allocator ; ///< allocator used to allocate new node
*/
typedef opt::none compare;
- /// specifies binary predicate used for key comparison.
+ /// Specifies binary predicate used for key comparison.
/**
Default is \p std::less<T>.
*/
typedef opt::none less;
- /// back-off strategy used
- /**
- If the option is not specified, the cds::backoff::empty is used.
- */
+ /// Back-off strategy
typedef cds::backoff::empty back_off;
- /// Item counter
- /**
- The type for item counting feature.
- Default is no item counter (\ref atomicity::empty_item_counter)
- */
+ /// Item counting feature; by default, disabled. Use \p cds::atomicity::item_counter to enable item counting
typedef atomicity::empty_item_counter item_counter;
- /// Link fields checking feature
- /**
- Default is \ref intrusive::opt::debug_check_link
- */
- static const opt::link_check_type link_checker = opt::debug_check_link;
-
/// C++ memory ordering model
- /**
- List of available memory ordering see opt::memory_model
+ /**
+ Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
*/
typedef opt::v::relaxed_ordering memory_model;
//@endcond
};
- /// Metafunction converting option list to MichaelList traits
+ /// Metafunction converting option list to \p michael_list::traits
/**
- This is a wrapper for <tt> cds::opt::make_options< type_traits, Options...> </tt>
-
- See \ref MichaelList, \ref type_traits, \ref cds::opt::make_options.
*/
template <typename... Options>
struct make_traits {
typedef implementation_defined type ; ///< Metafunction result
# else
typedef typename cds::opt::make_options<
- typename cds::opt::find_type_traits< type_traits, Options... >::type
+ typename cds::opt::find_type_traits< traits, Options... >::type
,Options...
>::type type;
#endif
} // namespace michael_list
// Forward declarations
- template <typename GC, typename T, typename Traits=michael_list::type_traits>
+ template <typename GC, typename T, typename Traits=michael_list::traits>
class MichaelList;
- template <typename GC, typename Key, typename Value, typename Traits=michael_list::type_traits>
+ template <typename GC, typename Key, typename Value, typename Traits=michael_list::traits>
class MichaelKVList;
// Tag for selecting Michael's list implementation
#define __CDS_CONTAINER_IMPL_MICHAEL_KVLIST_H
#include <memory>
-#include <functional> // ref
#include <cds/container/details/guarded_ptr_cast.h>
namespace cds { namespace container {
- /// Michael's ordered list (key-value pair)
+ /// Michael's ordered list fo key-value pair
/** @ingroup cds_nonintrusive_list
\anchor cds_nonintrusive_MichaelKVList_gc
constant key and alterable value.
Usually, ordered single-linked list is used as a building block for the hash table implementation.
- The complexity of searching is <tt>O(N)</tt>.
+ The complexity of searching is <tt>O(N)</tt> where \p N is the item count in the list, not in the
+ hash table.
Template arguments:
- \p GC - garbage collector used
- \p Key - key type of an item stored in the list. It should be copy-constructible
- \p Value - value type stored in a list
- - \p Traits - type traits, default is michael_list::type_traits
+ - \p Traits - type traits, default is \p michael_list::traits
- It is possible to declare option-based list with cds::container::michael_list::make_traits metafunction istead of \p Traits template
- argument. For example, the following traits-based declaration of gc::HP Michael's list
+ It is possible to declare option-based list with \p cds::container::michael_list::make_traits metafunction istead of \p Traits template
+ argument. For example, the following traits-based declaration of \p gc::HP Michael's list
\code
#include <cds/container/michael_kvlist_hp.h>
// Declare comparator for the item
}
};
- // Declare type_traits
- struct my_traits: public cds::container::michael_list::type_traits
+ // Declare traits
+ struct my_traits: public cds::container::michael_list::traits
{
typedef my_compare compare;
};
// Declare traits-based list
typedef cds::container::MichaelKVList< cds::gc::HP, int, int, my_traits > traits_based_list;
\endcode
-
is equivalent for the following option-based list
\code
#include <cds/container/michael_kvlist_hp.h>
> option_based_list;
\endcode
- Template argument list \p Options of cds::container::michael_list::make_traits metafunction are:
- - opt::compare - key comparison functor. No default functor is provided.
- If the option is not specified, the opt::less is used.
- - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
- - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::empty is used.
- - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
- - opt::allocator - the allocator used for creating and freeing list's item. Default is \ref CDS_DEFAULT_ALLOCATOR macro.
- - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
- or opt::v::sequential_consistent (sequentially consisnent memory model).
-
\par Usage
There are different specializations of this template for each garbage collecting schema used.
You should include appropriate .h-file depending on GC you are using:
typename Key,
typename Value,
#ifdef CDS_DOXYGEN_INVOKED
- typename Traits = michael_list::type_traits
+ typename Traits = michael_list::traits
#else
typename Traits
#endif
#endif
{
//@cond
- typedef details::make_michael_kvlist< GC, Key, Value, Traits > options;
- typedef typename options::type base_class;
+ typedef details::make_michael_kvlist< GC, Key, Value, Traits > maker;
+ typedef typename maker::type base_class;
//@endcond
public:
typedef Value mapped_type ; ///< Type of value stored in the list
typedef std::pair<key_type const, mapped_type> value_type ; ///< key/value pair stored in the list
#else
- typedef typename options::key_type key_type;
- typedef typename options::value_type mapped_type;
- typedef typename options::pair_type value_type;
+ typedef typename maker::key_type key_type;
+ typedef typename maker::value_type mapped_type;
+ typedef typename maker::pair_type value_type;
#endif
- typedef typename base_class::gc gc ; ///< Garbage collector used
- typedef typename base_class::back_off back_off ; ///< Back-off strategy used
- typedef typename options::allocator_type allocator_type ; ///< Allocator type used for allocate/deallocate the nodes
- typedef typename base_class::item_counter item_counter ; ///< Item counting policy used
- typedef typename options::key_comparator key_comparator ; ///< key comparison functor
- typedef typename base_class::memory_model memory_model ; ///< Memory ordering. See cds::opt::memory_model option
+ typedef typename base_class::gc gc; ///< Garbage collector used
+ typedef typename base_class::back_off back_off; ///< Back-off strategy used
+ typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
+ typedef typename base_class::item_counter item_counter; ///< Item counting policy used
+ typedef typename maker::key_comparator key_comparator; ///< key comparison functor
+ typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
protected:
//@cond
- typedef typename base_class::value_type node_type;
- typedef typename options::cxx_allocator cxx_allocator;
- typedef typename options::node_deallocator node_deallocator;
- typedef typename options::type_traits::compare intrusive_key_comparator;
+ typedef typename base_class::value_type node_type;
+ typedef typename maker::cxx_allocator cxx_allocator;
+ typedef typename maker::node_deallocator node_deallocator;
+ typedef typename maker::intrusive_traits::compare intrusive_key_comparator;
typedef typename base_class::atomic_node_ptr head_type;
//@endcond
The function creates a node with \p key and default value, and then inserts the node created into the list.
Preconditions:
- - The \ref key_type should be constructible from value of type \p K.
- In trivial case, \p K is equal to \ref key_type.
- - The \ref mapped_type should be default-constructible.
+ - The \p key_type should be constructible from value of type \p K.
+ In trivial case, \p K is equal to \p key_type.
+ - The \p mapped_type should be default-constructible.
Returns \p true if inserting successful, \p false otherwise.
*/
The function creates a node with \p key and value \p val, and then inserts the node created into the list.
Preconditions:
- - The \ref key_type should be constructible from \p key of type \p K.
- - The \ref mapped_type should be constructible from \p val of type \p V.
+ - The \p key_type should be constructible from \p key of type \p K.
+ - The \p mapped_type should be constructible from \p val of type \p V.
Returns \p true if inserting successful, \p false otherwise.
*/
\endcode
The argument \p item of user-defined functor \p func is the reference
- to the list's item inserted. <tt>item.second</tt> is a reference to item's value that may be changed.
+ to the item inserted. <tt>item.second</tt> is a reference to item's value that may be changed.
User-defined functor \p 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 user-defined functor can be passed by reference using \p std::ref
- and it is called only if inserting is successful.
+ The user-defined functor is called only if inserting is successful.
- The key_type should be constructible from value of type \p K.
+ The \p key_type should be constructible from value of type \p K.
The function allows to split creating of new item into two part:
- - create item from \p key;
- - insert new item into the list;
+ - create a new item from \p key;
+ - insert the new item into the list;
- if inserting is successful, initialize the value of item by calling \p func functor
This can be useful if complete initialization of object of \p mapped_type is heavyweight and
The operation performs inserting or changing data with lock-free manner.
If the \p key not found in the list, then the new item created from \p key
- is inserted into the list (note that in this case the \ref key_type should be
+ is inserted into the list (note that in this case the \p key_type should be
copy-constructible from type \p K).
Otherwise, the functor \p func is called with item found.
The functor \p Func may be a function with signature:
- \p bNew - \p true if the item has been inserted, \p false otherwise
- \p item - item of the list
- The functor may change any fields of the \p item.second that is \ref mapped_type;
+ The functor may change any fields of the \p item.second of \p mapped_type;
however, \p func must guarantee that during changing no any other modifications
could be made on this item by concurrent threads.
- You may pass \p func argument by reference using \p std::ref
-
Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
\p second is true if new item has been added or \p false if the item with \p key
already is in the list.
return ensure_at( head(), key, f );
}
- /// Inserts data of type \ref mapped_type constructed with <tt>std::forward<Args>(args)...</tt>
+ /// Inserts a new node using move semantics
/**
+ \p key_type field of new item is constructed from \p key argument,
+ \p mapped_type field is done from \p args.
+
Returns \p true if inserting successful, \p false otherwise.
*/
template <typename K, typename... Args>
template <typename K, typename Less>
bool erase_with( K const& key, Less pred )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type() );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type() );
}
/// Deletes \p key from the list
template <typename K, typename Less, typename Func>
bool erase_with( K const& key, Less pred, Func f )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type(), f );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
/// Extracts the item from the list with specified \p key
template <typename K, typename Less>
bool extract_with( guarded_ptr& dest, K const& key, Less pred )
{
- return extract_at( head(), dest.guard(), key, typename options::template less_wrapper<Less>::type() );
+ return extract_at( head(), dest.guard(), key, typename maker::template less_wrapper<Less>::type() );
}
/// Finds the key \p key
template <typename Q, typename Less>
bool find_with( Q const& key, Less pred )
{
- return find_at( head(), key, typename options::template less_wrapper<Less>::type() );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
}
/// Finds the key \p key and performs an action with it
template <typename Q, typename Less, typename Func>
bool find_with( Q const& key, Less pred, Func f )
{
- return find_at( head(), key, typename options::template less_wrapper<Less>::type(), f );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
/// Finds the \p key and return the item found
template <typename K, typename Less>
bool get_with( guarded_ptr& ptr, K const& key, Less pred )
{
- return get_at( head(), ptr.guard(), key, typename options::template less_wrapper<Less>::type() );
+ return get_at( head(), ptr.guard(), key, typename maker::template less_wrapper<Less>::type() );
}
/// Checks if the list is empty
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomicity::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @note Even if you use real item counter and it returns 0, this fact is not mean that the list
+ is empty. To check list emptyness use \p empty() method.
*/
size_t size() const
{
}
/// Clears the list
- /**
- Post-condition: the list is empty
- */
void clear()
{
base_class::clear();
\anchor cds_nonintrusive_MichaelList_gc
Usually, ordered single-linked list is used as a building block for the hash table implementation.
- The complexity of searching is <tt>O(N)</tt>.
+ The complexity of searching is <tt>O(N)</tt>, where \p N is the item count in the list, not in the
+ hash table.
Source:
- [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"
Template arguments:
- \p GC - garbage collector used
- \p T - type stored in the list. The type must be default- and copy-constructible.
- - \p Traits - type traits, default is michael_list::type_traits
+ - \p Traits - type traits, default is \p michael_list::traits
Unlike standard container, this implementation does not divide type \p T into key and value part and
may be used as a main building block for hash set algorithms.
}
};
- // Declare type_traits
- struct my_traits: public cds::container::michael_list::type_traits
+ // Declare traits
+ struct my_traits: public cds::container::michael_list::traits
{
typedef my_compare compare;
};
> option_based_list;
\endcode
- Template argument list \p Options of cds::container::michael_list::make_traits metafunction are:
- - opt::compare - key comparison functor. No default functor is provided.
- If the option is not specified, the opt::less is used.
- - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
- - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::empty is used.
- - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
- - opt::allocator - the allocator used for creating and freeing list's item. Default is \ref CDS_DEFAULT_ALLOCATOR macro.
- - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
- or opt::v::sequential_consistent (sequentially consisnent memory model).
-
\par Usage
There are different specializations of this template for each garbage collecting schema used.
You should include appropriate .h-file depending on GC you are using:
typename GC,
typename T,
#ifdef CDS_DOXYGEN_INVOKED
- typename Traits = michael_list::type_traits
+ typename Traits = michael_list::traits
#else
typename Traits
#endif
#endif
{
//@cond
- typedef details::make_michael_list< GC, T, Traits > options;
- typedef typename options::type base_class;
+ typedef details::make_michael_list< GC, T, Traits > maker;
+ typedef typename maker::type base_class;
//@endcond
public:
- typedef T value_type ; ///< Type of value stored in the list
- typedef typename base_class::gc gc ; ///< Garbage collector used
- typedef typename base_class::back_off back_off ; ///< Back-off strategy used
- typedef typename options::allocator_type allocator_type ; ///< Allocator type used for allocate/deallocate the nodes
- typedef typename base_class::item_counter item_counter ; ///< Item counting policy used
- typedef typename options::key_comparator key_comparator ; ///< key comparison functor
- typedef typename base_class::memory_model memory_model ; ///< Memory ordering. See cds::opt::memory_model option
+ typedef T value_type; ///< Type of value stored in the list
+ typedef Traits traits; ///< List traits
+
+ typedef typename base_class::gc gc; ///< Garbage collector used
+ typedef typename base_class::back_off back_off; ///< Back-off strategy used
+ typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
+ typedef typename base_class::item_counter item_counter; ///< Item counting policy used
+ typedef typename maker::key_comparator key_comparator; ///< key comparison functor
+ typedef typename base_class::memory_model memory_model; ///< Memory ordering. See \p cds::opt::memory_model option
protected:
//@cond
- typedef typename base_class::value_type node_type;
- typedef typename options::cxx_allocator cxx_allocator;
- typedef typename options::node_deallocator node_deallocator;
- typedef typename options::type_traits::compare intrusive_key_comparator;
+ typedef typename base_class::value_type node_type;
+ typedef typename maker::cxx_allocator cxx_allocator;
+ typedef typename maker::node_deallocator node_deallocator;
+ typedef typename maker::intrusive_traits::compare intrusive_key_comparator;
typedef typename base_class::atomic_node_ptr head_type;
//@endcond
free_node( pNode );
}
};
- typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
+ typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
head_type& head()
{
//@endcond
protected:
- //@cond
+ //@cond
template <bool IsConst>
class iterator_type: protected base_class::template iterator_type<IsConst>
{
The function creates a node with copy of \p val value
and then inserts the node created into the list.
- The type \p Q should contain as minimum the complete key of the node.
+ The type \p Q should contain least the complete key of the node.
The object of \ref value_type should be constructible from \p val of type \p Q.
In trivial case, \p Q is equal to \ref value_type.
The argument \p itemValue of user-defined functor \p func is the reference
to the list's item inserted. User-defined functor \p 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 user-defined functor can be passed by reference using \p std::ref
- and it is called only if the inserting is success.
+ The user-defined functor is called only if inserting is success.
The type \p Q should contain the complete key of the node.
- The object of \ref value_type should be constructible from \p key of type \p Q.
+ The object of \p value_type should be constructible from \p key of type \p Q.
The function allows to split creating of new item into two part:
- create item from \p key with initializing key-fields only;
- insert new item into the list;
- - if inserting is successful, initialize non-key fields of item by calling \p f functor
+ - if inserting is successful, initialize non-key fields of item by calling \p func functor
- This can be useful if complete initialization of object of \p value_type is heavyweight and
+ The method can be useful if complete initialization of object of \p value_type is heavyweight and
it is preferable that the initialization should be completed only if inserting is successful.
*/
template <typename Q, typename Func>
The functor may change non-key fields of the \p item; however, \p func must guarantee
that during changing no any other modifications could be made on this item by concurrent threads.
- You may pass \p func argument by reference by \p std::ref
-
Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
\p second is true if new item has been added or \p false if the item with \p key
already is in the list.
*/
template <typename Q, typename Func>
- std::pair<bool, bool> ensure( Q const& key, Func f )
+ std::pair<bool, bool> ensure( Q const& key, Func func )
{
- return ensure_at( head(), key, f );
+ return ensure_at( head(), key, func );
}
- /// Inserts data of type \
ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
+ /// Inserts data of type \
p value_type constructed with <tt>std::forward<Args>(args)...</tt>
/**
Returns \p true if inserting successful, \p false otherwise.
*/
/// Delete \p key from the list
/** \anchor cds_nonintrusive_MichealList_hp_erase_val
- Since the key of MichaelList's item type \p T is not explicitly specified,
- template parameter \p Q defines the key type searching in the list.
- The list item comparator should be able to compare the type \p T of list item
+ Since the key of MichaelList's item type \p value_type is not explicitly specified,
+ template parameter \p Q sould contain the complete key to search in the list.
+ The list item comparator should be able to compare the type \p value_type
and the type \p Q.
Return \p true if key is found and deleted, \p false otherwise
template <typename Q, typename Less>
bool erase_with( Q const& key, Less pred )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type(), [](value_type const&){} );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), [](value_type const&){} );
}
/// Deletes \p key from the list
\endcode
The functor may be passed by reference with <tt>boost:ref</tt>
- Since the key of MichaelList's item type \p T is not explicitly specified,
- template parameter \p Q defines the key type searching in the list.
- The list item comparator should be able to compare the type \p T of list item
+ Since the key of MichaelList's item type \p value_type is not explicitly specified,
+ template parameter \p Q should contain the complete key to search in the list.
+ The list item comparator should be able to compare the type \p value_type of list item
and the type \p Q.
Return \p true if key is found and deleted, \p false otherwise
-
- See also: \ref erase
*/
template <typename Q, typename Func>
bool erase( Q const& key, Func f )
template <typename Q, typename Less, typename Func>
bool erase_with( Q const& key, Less pred, Func f )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type(), f );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
/// Extracts the item from the list with specified \p key
The function is an analog of \ref cds_nonintrusive_MichaelList_hp_extract "extract(guarded_ptr&, Q const&)"
but \p pred predicate is used for key comparing.
- \p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type and \p Q
+ \p Less functor has the semantics like \p std::less but it should accept arguments of type \p value_type and \p Q
in any order.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
bool extract_with( guarded_ptr& dest, Q const& key, Less pred )
{
- return extract_at( head(), dest.guard(), key, typename options::template less_wrapper<Less>::type() );
+ return extract_at( head(), dest.guard(), key, typename maker::template less_wrapper<Less>::type() );
}
- /// Find the key \p key
+ /// Finds \p key
/** \anchor cds_nonintrusive_MichaelList_hp_find_val
The function searches the item with key equal to \p key
and returns \p true if it is found, and \p false otherwise
return find_at( head(), key, intrusive_key_comparator() );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_nonintrusive_MichaelList_hp_find_val "find(Q const&)"
but \p pred is used for key comparing.
template <typename Q, typename Less>
bool find_with( Q const& key, Less pred )
{
- return find_at( head(), key, typename options::template less_wrapper<Less>::type() );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
}
- /// Find the key \p val and perform an action with it
+ /// Finds \p key and perform an action with it
/** \anchor cds_nonintrusive_MichaelList_hp_find_func
- The function searches an item with key equal to \p val and calls the functor \p f for the item found.
+ The function searches an item with key equal to \p key and calls the functor \p f for the item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref
+ where \p item is the item found, \p key is the <tt>find</tt> function argument.
The functor may change non-key fields of \p item. Note that the function is only guarantee
that \p item cannot be deleted during functor is executing.
The function does not serialize simultaneous access to the list \p item. If such access is
possible you must provide your own synchronization schema to exclude unsafe item modifications.
- The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
- may modify both arguments.
-
- The function returns \p true if \p val is found, \p false otherwise.
+ The function returns \p true if \p key is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f )
+ bool find( Q& key, Func f )
{
- return find_at( head(), val, intrusive_key_comparator(), f );
+ return find_at( head(), key, intrusive_key_comparator(), f );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_nonintrusive_MichaelList_hp_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f )
- {
- return find_at( head(), val, typename options::template less_wrapper<Less>::type(), f );
- }
-
- /// Find the key \p val and perform an action with it
- /** \anchor cds_nonintrusive_MichaelList_hp_find_cfunc
- The function searches an item with key equal to \p val and calls the functor \p f for the item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref
-
- The functor may change non-key fields of \p item. Note that the function is only guarantee
- that \p item cannot be deleted during functor is executing.
- The function does not serialize simultaneous access to the list \p item. If such access is
- possible you must provide your own synchronization schema to exclude unsafe item modifications.
-
- The function returns \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f )
- {
- return find_at( head(), val, intrusive_key_comparator(), f );
- }
-
- /// Finds the key \p val using \p pred predicate for searching
- /**
- The function is an analog of \ref cds_nonintrusive_MichaelList_hp_find_cfunc "find(Q&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
- */
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f )
+ bool find_with( Q& key, Less pred, Func f )
{
- return find_at( head(), val, typename options::template less_wrapper<Less>::type(), f );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/** \anchor cds_nonintrusive_MichaelList_hp_get
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and assigns the item found to guarded pointer \p ptr.
- The function returns \p true if \p val is found, and \p false otherwise.
- If \p val is not found the \p ptr parameter is not changed.
+ The function returns \p true if \p key is found, and \p false otherwise.
+ If \p key is not found the \p ptr parameter is not changed.
@note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
should accept a parameter of type \p Q that can be not the same as \p value_type.
*/
template <typename Q>
- bool get( guarded_ptr& ptr, Q const& val )
+ bool get( guarded_ptr& ptr, Q const& key )
{
- return get_at( head(), ptr.guard(), val, intrusive_key_comparator() );
+ return get_at( head(), ptr.guard(), key, intrusive_key_comparator() );
}
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/**
The function is an analog of \ref cds_nonintrusive_MichaelList_hp_get "get( guarded_ptr& ptr, Q const&)"
but \p pred is used for comparing the keys.
- \p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type and \p Q
+ \p Less functor has the semantics like \p std::less but should accept arguments of type \p value_type and \p Q
in any order.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool get_with( guarded_ptr& ptr, Q const& val, Less pred )
+ bool get_with( guarded_ptr& ptr, Q const& key, Less pred )
{
- return get_at( head(), ptr.guard(), val, typename options::template less_wrapper<Less>::type() );
+ return get_at( head(), ptr.guard(), key, typename maker::template less_wrapper<Less>::type() );
}
/// Check if the list is empty
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomics::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @note Even if you use real item counter and it returns 0, this fact is not mean that the list
+ is empty. To check list emptyness use \p empty() method.
*/
size_t size() const
{
}
/// Clears the list
- /**
- Post-condition: the list is empty
- */
void clear()
{
base_class::clear();
} // namespace details
//@endcond
- /// Michael's lock-free ordered single-linked list (template specialization for gc::nogc)
+ /// Michael's lock-free ordered single-linked list (template specialization for \pgc::nogc)
/** @ingroup cds_nonintrusive_list
\anchor cds_nonintrusive_MichaelList_nogc
- This specialization is intended for so-called persistent usage when no item
+ This specialization is intended for so-called append-only usage when no item
reclamation may be performed. The class does not support deleting of list item.
Usually, ordered single-linked list is used as a building block for the hash table implementation.
The complexity of searching is <tt>O(N)</tt>.
See \ref cds_nonintrusive_MichaelList_gc "MichaelList" for description of template parameters.
-
- The interface of the specialization is a little different.
*/
- template <typename T, typename Traits>
+ template <typename T,
+#ifdef CDS_DOXYGEN_INVOKED
+ class Traits = michael_list::traits
+#else
+ class Traits
+#endif
+ >
class MichaelList<gc::nogc, T, Traits>:
#ifdef CDS_DOXYGEN_INVOKED
protected intrusive::MichaelList< gc::nogc, T, Traits >
Template arguments:
- \p RCU - one of \ref cds_urcu_gc "RCU type"
- \p T - type stored in the list. The type must be default- and copy-constructible.
- - \p Traits - type traits, default is michael_list::type_traits
+ - \p Traits - type traits, default is michael_list::traits
The implementation does not divide type \p T into key and value part and
may be used as a main building block for hash set containers.
}
};
- // Declare type_traits
- struct my_traits: public cds::container::michael_list::type_traits
+ // Declare traits
+ struct my_traits: public cds::container::michael_list::traits
{
typedef my_compare compare;
};
typename RCU,
typename T,
#ifdef CDS_DOXYGEN_INVOKED
- typename Traits = michael_list::type_traits
+ typename Traits = michael_list::traits
#else
typename Traits
#endif
#endif
{
//@cond
- typedef details::make_michael_list< cds::urcu::gc<RCU>, T, Traits > options;
- typedef typename options::type base_class;
+ typedef details::make_michael_list< cds::urcu::gc<RCU>, T, Traits > maker;
+ typedef typename maker::type base_class;
//@endcond
public:
- typedef T value_type ; ///< Type of value stored in the list
- typedef typename base_class::gc gc ; ///< RCU schema used
- typedef typename base_class::back_off back_off ; ///< Back-off strategy used
- typedef typename options::allocator_type allocator_type ; ///< Allocator type used for allocate/deallocate the nodes
- typedef typename base_class::item_counter item_counter ; ///< Item counting policy used
- typedef typename options::key_comparator key_comparator ; ///< key comparison functor
- typedef typename base_class::memory_model memory_model ; ///< Memory ordering. See cds::opt::memory_model option
+ typedef cds::urcu::gc<RCU> gc; ///< RCU
+ typedef T value_type; ///< Type of value stored in the list
+ typedef Traits traits; /// List traits
+
+ typedef typename base_class::back_off back_off; ///< Back-off strategy used
+ typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
+ typedef typename base_class::item_counter item_counter; ///< Item counting policy used
+ typedef typename maker::key_comparator key_comparator; ///< key comparison functor
+ typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
typedef typename base_class::rcu_check_deadlock rcu_check_deadlock ; ///< RCU deadlock checking policy
typedef typename gc::scoped_lock rcu_lock ; ///< RCU scoped lock
protected:
//@cond
- typedef typename base_class::value_type node_type;
- typedef typename options::cxx_allocator cxx_allocator;
- typedef typename options::node_deallocator node_deallocator;
- typedef typename options::type_traits::compare intrusive_key_comparator;
+ typedef typename base_class::value_type node_type;
+ typedef typename maker::cxx_allocator cxx_allocator;
+ typedef typename maker::node_deallocator node_deallocator;
+ typedef typename maker::intrusive_traits::compare intrusive_key_comparator;
typedef typename base_class::atomic_node_ptr head_type;
//@endcond
public:
- typedef cds::urcu::exempt_ptr< gc, node_type, value_type, typename options::type_traits::disposer > exempt_ptr; ///< pointer to extracted node
+ typedef cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer > exempt_ptr; ///< pointer to extracted node
private:
//@cond
The functor may change non-key fields of the \p item; however, \p func must guarantee
that during changing no any other modifications could be made on this item by concurrent threads.
- You may pass \p func argument by reference using \p std::ref
-
The function makes RCU lock internally.
Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
return ensure_at( head(), key, f );
}
- /// Inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
+ /// Inserts data of type \ref value_type constructed from \p args
/**
Returns \p true if inserting successful, \p false otherwise.
/// Deletes \p key from the list
/** \anchor cds_nonintrusive_MichealList_rcu_erase_val
- Since the key of MichaelList's item type \p T is not explicitly specified,
+ Since the key of MichaelList's item type \p value_type is not explicitly specified,
template parameter \p Q defines the key type searching in the list.
- The list item comparator should be able to compare the type \p T of list item
- and the value \p key of type \p Q.
+ The list item comparator should be able to compare values of the type \p value_type
+ and \p Q in any order.
RCU \p synchronize method can be called. RCU should not be locked.
template <typename Q, typename Less>
bool erase_with( Q const& key, Less pred )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type(), [](value_type const&){} );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), [](value_type const&){} );
}
/// Deletes \p key from the list
void operator()(const value_type& val) { ... }
};
\endcode
- The functor may be passed by reference with <tt>boost:ref</tt>
- Since the key of MichaelList's item type \p T is not explicitly specified,
+ Since the key of MichaelList's item type \p value_type is not explicitly specified,
template parameter \p Q defines the key type searching in the list.
- The list item comparator should be able to compare the type \p T of list item
- and the type \p Q.
+ The list item comparator should be able to compare the values of type \p value_type
+ and \p Q in any order.
RCU \p synchronize method can be called. RCU should not be locked.
template <typename Q, typename Less, typename Func>
bool erase_with( Q const& key, Less pred, Func f )
{
- return erase_at( head(), key, typename options::template less_wrapper<Less>::type(), f );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
/// Extracts an item from the list
/**
@anchor cds_nonintrusive_MichaelList_rcu_extract
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
unlinks it from the list, and returns pointer to an item found in \p dest argument.
- If the item with the key equal to \p val is not found the function returns \p false.
+ If the item with the key equal to \p key is not found the function returns \p false.
@note The function does NOT call RCU read-side lock or synchronization,
and does NOT dispose the item found. It just excludes the item from the list
\endcode
*/
template <typename Q>
- bool extract( exempt_ptr& dest, Q const& val )
+ bool extract( exempt_ptr& dest, Q const& key )
{
- dest = extract_at( head(), val, intrusive_key_comparator() );
+ dest = extract_at( head(), key, intrusive_key_comparator() );
return !dest.empty();
}
\p pred must imply the same element order as \ref key_comparator.
*/
template <typename Q, typename Less>
- bool extract_with( exempt_ptr& dest, Q const& val, Less pred )
+ bool extract_with( exempt_ptr& dest, Q const& key, Less pred )
{
- dest = extract_at( head(), val, typename options::template less_wrapper<Less>::type() );
+ dest = extract_at( head(), key, typename maker::template less_wrapper<Less>::type() );
return !dest.empty();
}
template <typename Q, typename Less>
bool find_with( Q const& key, Less pred ) const
{
- return find_at( head(), key, typename options::template less_wrapper<Less>::type() );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
}
- /// Finds the key \p val and performs an action with it
+ /// Finds the key \p key and performs an action with it
/** \anchor cds_nonintrusive_MichaelList_rcu_find_func
- The function searches an item with key equal to \p val and calls the functor \p f for the item found.
+ The function searches an item with key equal to \p key and calls the functor \p f for the item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref.
+ where \p item is the item found, \p key is the \p %find() function argument.
The functor may change non-key fields of \p item. Note that the function is only guarantee
that \p item cannot be deleted during functor is executing.
The function does not serialize simultaneous access to the list \p item. If such access is
possible you must provide your own synchronization schema to exclude unsafe item modifications.
- The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
- may modify both arguments.
-
The function makes RCU lock internally.
The function returns \p true if \p val is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f ) const
+ bool find( Q& key, Func f ) const
{
- return find_at( head(), val, intrusive_key_comparator(), f );
+ return find_at( head(), key, intrusive_key_comparator(), f );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds the key \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_nonintrusive_MichaelList_rcu_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f ) const
- {
- return find_at( head(), val, typename options::template less_wrapper<Less>::type(), f );
- }
-
- /// Finds the key \p val and performs an action with it
- /** \anchor cds_nonintrusive_MichaelList_rcu_find_cfunc
- The function searches an item with key equal to \p val and calls the functor \p f for the item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref.
-
- The functor may change non-key fields of \p item. Note that the function is only guarantee
- that \p item cannot be deleted during functor is executing.
- The function does not serialize simultaneous access to the list \p 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 \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f ) const
- {
- return find_at( head(), val, intrusive_key_comparator(), f );
- }
-
- /// Finds the key \p val using \p pred predicate for searching
- /**
- The function is an analog of \ref cds_nonintrusive_MichaelList_rcu_find_cfunc "find(Q&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
- */
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f ) const
+ bool find_with( Q& key, Less pred, Func f ) const
{
- return find_at( head(), val, typename options::template less_wrapper<Less>::type(), f );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
}
- /// Finds the key \p val and return the item found
+ /// Finds the key \p key and return the item found
/** \anchor cds_nonintrusive_MichaelList_rcu_get
- The function searches the item with key equal to \p val and returns the pointer to item found.
- If \p val is not found it returns \p nullptr.
+ The function searches the item with key equal to \p key and returns the pointer to item found.
+ If \p key is not found it returns \p nullptr.
Note the compare functor should accept a parameter of type \p Q that can be not the same as \p value_type.
\endcode
*/
template <typename Q>
- value_type * get( Q const& val ) const
+ value_type * get( Q const& key ) const
{
- return get_at( head(), val, intrusive_key_comparator());
+ return get_at( head(), key, intrusive_key_comparator());
}
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/**
The function is an analog of \ref cds_nonintrusive_MichaelList_rcu_get "get(Q const&)"
but \p pred is used for comparing the keys.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- value_type * get_with( Q const& val, Less pred ) const
+ value_type * get_with( Q const& key, Less pred ) const
{
- return get_at( head(), val, typename options::template less_wrapper<Less>::type());
+ return get_at( head(), key, typename maker::template less_wrapper<Less>::type());
}
/// Checks if the list is empty
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomics::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use a real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @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 \p empty() method.
*/
size_t size() const
{
}
/// Clears the list
- /**
- Post-condition: the list is empty
- */
void clear()
{
base_class::clear();
#define __CDS_INTRUSIVE_DETAILS_MICHAEL_LIST_BASE_H
#include <type_traits>
-#include <functional> // ref
#include <cds/intrusive/details/base.h>
#include <cds/opt/compare.h>
#include <cds/cxx11_atomic.h>
#include <cds/details/marked_ptr.h>
-#include <cds/details/make_const_type.h>
#include <cds/urcu/options.h>
namespace cds { namespace intrusive {
//@endcond
};
- /// Check link
+ /// Checks link
template <typename Node>
struct link_checker
{
//@endcond
};
- /// Type traits for MichaelList class
- struct type_traits
+ /// MichaelList traits
+ struct traits
{
/// Hook used
/**
- Possible values are: michael_list::base_hook, michael_list::member_hook, michael_list::traits_hook.
+ Possible values are: \p michael_list::base_hook, \p michael_list::member_hook, \p michael_list::traits_hook.
*/
typedef base_hook<> hook;
*/
typedef opt::none compare;
- /// specifies binary predicate used for key compare.
+ /// Specifies binary predicate used for key compare.
/**
Default is \p std::less<T>.
*/
typedef opt::none less;
- /// back-off strategy used
- /**
- If the option is not specified, the cds::backoff::Default is used.
- */
+ /// Back-off strategy
typedef cds::backoff::Default back_off;
- /// Disposer
- /**
- the functor used for dispose removed items. Default is opt::v::empty_disposer.
- */
+ /// Disposer for removing items
typedef opt::v::empty_disposer disposer;
- /// Item counter
- /**
- The type for item counting feature.
- Default is no item counter (\ref atomicity::empty_item_counter)
- */
+ /// Item counting feature; by default, disabled. Use \p cds::atomicity::item_counter to enable item counting
typedef atomicity::empty_item_counter item_counter;
/// Link fields checking feature
/**
- Default is \ref opt::debug_check_link
+ Default is \p opt::debug_check_link
*/
static const opt::link_check_type link_checker = opt::debug_check_link;
/// C++ memory ordering model
- /**
- List of available memory ordering see opt::memory_model
+ /**
+ Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
*/
typedef opt::v::relaxed_ordering memory_model;
/// RCU deadlock checking policy (only for \ref cds_intrusive_MichaelList_rcu "RCU-based MichaelList")
/**
- List of available options see opt::rcu_check_deadlock
+ List of available policy see \p opt::rcu_check_deadlock
*/
typedef opt::v::rcu_throw_deadlock rcu_check_deadlock;
};
- /// Metafunction converting option list to traits
+ /// Metafunction converting option list to \p michael_list::traits
/**
- This is a wrapper for <tt> cds::opt::make_options< type_traits, Options...> </tt>
- \p Options list see \ref MichaelList.
+ Supported \p Options are:
+ - \p opt::hook - hook used. Possible values are: \p michael_list::base_hook, \p michael_list::member_hook, \p michael_list::traits_hook.
+ If the option is not specified, \p %michael_list::base_hook<> and \p gc::HP is used.
+ - \p opt::compare - key comparison functor. No default functor is provided.
+ If the option is not specified, the \p opt::less is used.
+ - \p opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
+ - \p opt::back_off - back-off strategy used. If the option is not specified, the \p cds::backoff::Default is used.
+ - \p opt::disposer - the functor used for disposing removed items. Default is \p opt::v::empty_disposer. Due the nature
+ of GC schema the disposer may be called asynchronously.
+ - \p opt::link_checker - the type of node's link fields checking. Default is \p opt::debug_check_link
+ - \p opt::item_counter - the type of item counting feature. Default is disabled (\p atomicity::empty_item_counter).
+ To enable item counting use \p atomicity::item_counter.
+ - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
+ - \p opt::rcu_check_deadlock - a deadlock checking policy for \ref cds_intrusive_MichaelList_rcu "RCU-based MichaelList"
+ Default is \p opt::v::rcu_throw_deadlock
*/
template <typename... Options>
struct make_traits {
typedef implementation_defined type ; ///< Metafunction result
# else
typedef typename cds::opt::make_options<
- typename cds::opt::find_type_traits< type_traits, Options... >::type
+ typename cds::opt::find_type_traits< traits, Options... >::type
,Options...
>::type type;
- //typedef typename cds::opt::make_options< type_traits, Options...>::type type ; ///< Result of metafunction
# endif
};
//@cond
// Forward declaration
- template < class GC, typename T, class Traits = michael_list::type_traits >
+ template < class GC, typename T, class Traits = michael_list::traits >
class MichaelList;
//@endcond
#include <cds/intrusive/details/michael_list_base.h>
#include <cds/gc/guarded_ptr.h>
+#include <cds/details/make_const_type.h>
namespace cds { namespace intrusive {
- [2002] Maged Michael "High performance dynamic lock-free hash tables and list-based sets"
Template arguments:
- - \p GC - Garbage collector used. Note the \p GC must be the same as the GC used for item type \p T (see michael_list::node).
+ - \p GC - Garbage collector used. Note the \p GC must be the same as the GC used for item type \p T (see \p michael_list::node).
- \p T - type to be stored in the list. The type must be based on michael_list::node (for michael_list::base_hook)
or it must have a member of type michael_list::node (for michael_list::member_hook).
- - \p Traits - type traits. See michael_list::type_traits for explanation.
-
- It is possible to declare option-based list with cds::intrusive::michael_list::make_traits metafunction istead of \p Traits template
- argument.
-
- Template argument list \p Options of cds::intrusive::michael_list::make_traits metafunction are:
- - opt::hook - hook used. Possible values are: michael_list::base_hook, michael_list::member_hook, michael_list::traits_hook.
- If the option is not specified, <tt>michael_list::base_hook<></tt> and gc::HP is used.
- - opt::compare - key comparison functor. No default functor is provided.
- If the option is not specified, the opt::less is used.
- - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
- - opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::Default is used.
- - opt::disposer - the functor used for dispose removed items. Default is opt::v::empty_disposer. Due the nature
- of GC schema the disposer may be called asynchronously.
- - opt::link_checker - the type of node's link fields checking. Default is \ref opt::debug_check_link
- - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
- - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
- or opt::v::sequential_consistent (sequentially consisnent memory model).
-
- For example, the following traits-based declaration of gc::HP Michael's list
- \code
- #include <cds/intrusive/michael_list_hp.h>
- // Declare item stored in your list
- struct item: public cds::intrusive::michael_list::node< cds::gc::HP >
- {
- int nKey;
- // .... other data
- };
-
- // Declare comparator for the item
- struct my_compare {
- int operator()( item const& i1, item const& i2 ) const
+ - \p Traits - type traits, default is \p michael_list::traits. It is possible to declare option-based
+ list with \p cds::intrusive::michael_list::make_traits metafunction:
+ For example, the following traits-based declaration of \p gc::HP Michael's list
+ \code
+ #include <cds/intrusive/michael_list_hp.h>
+ // Declare item stored in your list
+ struct item: public cds::intrusive::michael_list::node< cds::gc::HP >
{
- return i1.nKey - i2.nKey;
- }
- };
+ int nKey;
+ // .... other data
+ };
- // Declare type_traits
- struct my_traits: public cds::intrusive::michael_list::type_traits
- {
- typedef cds::intrusive::michael_list::base_hook< cds::opt::gc< cds::gc::HP > > hook;
- typedef my_compare compare;
- };
+ // Declare comparator for the item
+ struct my_compare {
+ int operator()( item const& i1, item const& i2 ) const
+ {
+ return i1.nKey - i2.nKey;
+ }
+ };
- // Declare traits-based list
- typedef cds::intrusive::MichaelList< cds::gc::HP, item, my_traits > traits_based_list;
- \endcode
+ // Declare traits
+ struct my_traits: public cds::intrusive::michael_list::traits
+ {
+ typedef cds::intrusive::michael_list::base_hook< cds::opt::gc< cds::gc::HP > > hook;
+ typedef my_compare compare;
+ };
- is equivalent for the following option-based list
- \code
- #include <cds/intrusive/michael_list_hp.h>
+ // Declare traits-based list
+ typedef cds::intrusive::MichaelList< cds::gc::HP, item, my_traits > traits_based_list;
+ \endcode
+ is equivalent for the following option-based list
+ \code
+ #include <cds/intrusive/michael_list_hp.h>
- // item struct and my_compare are the same
+ // item struct and my_compare are the same
- // Declare option-based list
- typedef cds::intrusive::MichaelList< cds::gc::HP, item,
- typename cds::intrusive::michael_list::make_traits<
- cds::intrusive::opt::hook< cds::intrusive::michael_list::base_hook< cds::opt::gc< cds::gc::HP > > > // hook option
- ,cds::intrusive::opt::compare< my_compare > // item comparator option
- >::type
- > option_based_list;
- \endcode
+ // Declare option-based list
+ typedef cds::intrusive::MichaelList< cds::gc::HP, item,
+ typename cds::intrusive::michael_list::make_traits<
+ cds::intrusive::opt::hook< cds::intrusive::michael_list::base_hook< cds::opt::gc< cds::gc::HP > > > // hook option
+ ,cds::intrusive::opt::compare< my_compare > // item comparator option
+ >::type
+ > option_based_list;
+ \endcode
\par Usage
There are different specializations of this template for each garbage collecting schema used.
See \ref cds_intrusive_MichaelList_nogc "non-GC MichaelList"
Then, you should incorporate michael_list::node into your struct \p T and provide
- appropriate michael_list::type_traits::hook in your \p Traits template parameters. Usually, for \p Traits you
- define a struct based on michael_list::type_traits.
+ appropriate \p michael_list::traits::hook in your \p Traits template parameters. Usually, for \p Traits you
+ define a struct based on \p michael_list::traits.
- Example for gc::PTB and base hook:
+ Example for \p gc::PTB and base hook:
\code
// Include GC-related Michael's list specialization
#include <cds/intrusive/michael_list_dhp.h>
};
- // Declare type_traits
- struct my_traits: public cds::intrusive::michael_list::type_traits
+ // Declare traits
+ struct my_traits: public cds::intrusive::michael_list::traits
{
typedef cds::intrusive::michael_list::base_hook< cds::opt::gc< cds::gc::PTB > > hook;
typedef my_data_cmp compare;
class GC
,typename T
#ifdef CDS_DOXYGEN_INVOKED
- ,class Traits = michael_list::type_traits
+ ,class Traits = michael_list::traits
#else
,class Traits
#endif
class MichaelList
{
public:
- typedef T value_type ; ///< type of value stored in the list
- typedef Traits options ; ///< Traits template parameter
+ typedef T value_type; ///< type of value stored in the list
+ typedef Traits traits; ///< Traits template parameter
- typedef typename options::hook hook ; ///< hook type
- typedef typename hook::node_type node_type ; ///< node type
+ typedef typename traits::hook hook; ///< hook type
+ typedef typename hook::node_type node_type; ///< node type
# ifdef CDS_DOXYGEN_INVOKED
typedef implementation_defined key_comparator ; ///< key comparison functor based on opt::compare and opt::less option setter.
# else
- typedef typename opt::details::make_comparator< value_type, options >::type key_comparator;
+ typedef typename opt::details::make_comparator< value_type, traits >::type key_comparator;
# endif
- typedef typename options::disposer disposer ; ///< disposer used
+ typedef typename traits::disposer disposer; ///< disposer used
typedef typename get_node_traits< value_type, node_type, hook>::type node_traits ; ///< node traits
- typedef typename michael_list::get_link_checker< node_type, options::link_checker >::type link_checker ; ///< link checker
+ typedef typename michael_list::get_link_checker< node_type, traits::link_checker >::type link_checker; ///< link checker
typedef GC gc ; ///< Garbage collector
- typedef typename options::back_off back_off ; ///< back-off strategy
- typedef typename options::item_counter item_counter ; ///< Item counting policy used
- typedef typename options::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
+ typedef typename traits::back_off back_off; ///< back-off strategy
+ typedef typename traits::item_counter item_counter; ///< Item counting policy used
+ typedef typename traits::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
typedef cds::gc::guarded_ptr< gc, value_type > guarded_ptr; ///< Guarded pointer
//@cond
- // Rebind options (split-list support)
+ // Rebind traits (split-list support)
template <typename... Options>
- struct rebind_options {
+ struct rebind_traits {
typedef MichaelList<
gc
, value_type
- , typename cds::opt::make_options< options, Options...>::type
+ , typename cds::opt::make_options< traits, Options...>::type
> type;
};
//@endcond
protected:
- typedef typename node_type::atomic_marked_ptr atomic_node_ptr ; ///< Atomic node pointer
- typedef typename node_type::marked_ptr marked_node_ptr ; ///< Node marked pointer
+ typedef typename node_type::atomic_marked_ptr atomic_node_ptr; ///< Atomic node pointer
+ typedef typename node_type::marked_ptr marked_node_ptr; ///< Node marked pointer
- typedef atomic_node_ptr auxiliary_head ; ///< Auxiliary head type (for split-list support)
+ typedef atomic_node_ptr auxiliary_head; ///< Auxiliary head type (for split-list support)
- atomic_node_ptr m_pHead ; ///< Head pointer
- item_counter m_ItemCounter ; ///< Item counter
+ atomic_node_ptr m_pHead; ///< Head pointer
+ item_counter m_ItemCounter; ///< Item counter
//@cond
/// Position pointer for item search
disposer()( p );
}
};
-
//@endcond
protected:
//@cond
- void retire_node( node_type * pNode )
+ static void retire_node( node_type * pNode )
{
assert( pNode != nullptr );
gc::template retire<clean_disposer>( node_traits::to_value_ptr( *pNode ) );
}
- bool link_node( node_type * pNode, position& pos )
+ static bool link_node( node_type * pNode, position& pos )
{
assert( pNode != nullptr );
link_checker::is_empty( pNode );
return pos.pPrev->compare_exchange_strong( cur, marked_node_ptr(pNode), memory_model::memory_order_release, atomics::memory_order_relaxed );
}
- bool unlink_node( position& pos )
+ static bool unlink_node( position& pos )
{
assert( pos.pPrev != nullptr );
assert( pos.pCur != nullptr );
The forward iterator for Michael's list has some features:
- it has no post-increment operator
- to protect the value, the iterator contains a GC-specific guard + another guard is required locally for increment operator.
- For some GC (gc::HP, gc::HRC), a guard is limited resource per thread, so an exception (or assertion) "no free guard"
- may be thrown if a limit of guard count per thread is exceeded.
- - The iterator cannot be moved across thread boundary since it contains GC's guard that is thread-private GC data.
- - Iterator ensures thread-safety even if you delete the item that iterator points to. However, in case of concurrent
- deleting operations it is no guarantee that you iterate all item in the list.
+ For some GC (like as \p gc::HP), a guard is a limited resource per thread, so an exception (or assertion) "no free guard"
+ may be thrown if the limit of guard count per thread is exceeded.
+ - The iterator cannot be moved across thread boundary since it contains thread-private GC's guard.
+ - Iterator ensures thread-safety even if you delete the item the iterator points to. However, in case of concurrent
+ deleting operations there is no guarantee that you iterate all item in the list.
Therefore, the use of iterators in concurrent environment is not good idea. Use the iterator on the concurrent container
for debug purpose only.
/// Inserts new node
/**
- The function inserts \p val in the list if the list does not contain
+ The function inserts \p val into the list if the list does not contain
an item with key equal to \p val.
- Returns \p true if \p val is linked into the list, \p false otherwise.
+ Returns \p true if \p val has been linked to the list, \p false otherwise.
*/
bool insert( value_type& val )
{
\endcode
where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
\p val no any other changes could be made on this list's item by concurrent threads.
- The user-defined functor is called only if the inserting is success and may be passed by reference
- using \p std::ref
+ The user-defined functor is called only if the inserting is success.
*/
template <typename Func>
bool insert( value_type& val, Func f )
return insert_at( m_pHead, val, f );
}
- /// Ensures that the \p item exists in the list
+ /// Ensures that the \p val exists in the list
/**
The operation performs inserting or changing data with lock-free manner.
- If the item \p val not found in the list, then \p val is inserted into the list.
+ If the item \p val is not found in the list, then \p val is inserted.
Otherwise, the functor \p func is called with item found.
The functor signature is:
\code
The functor may change non-key fields of the \p item; however, \p func must guarantee
that during changing no any other modifications could be made on this item by concurrent threads.
- You may pass \p func argument by reference using \p std::ref.
-
Returns std::pair<bool, bool> where \p first is \p true if operation is successfull,
\p second is \p true if new item has been added or \p false if the item with \p key
already is in the list.
/// Unlinks the item \p val from the list
/**
- The function searches the item \p val in the list and unlink it from the list
+ The function searches the item \p val in the list and unlinks it from the list
if it is found and it is equal to \p val.
- Difference between \ref erase and \p unlink functions: \p erase finds <i>a key</i>
- and deletes the item found. \p unlink finds an item by key and deletes it
- only if \p val is an item of that list, i.e. the pointer to item found
+ Difference between \p erase() and \p %unlink(): \p %erase() finds <i>a key</i>
+ and deletes the item found. \p %unlink() finds an item by key and deletes it
+ only if \p val is an item of the list, i.e. the pointer to item found
is equal to <tt> &val </tt>.
The function returns \p true if success and \p false otherwise.
/// Deletes the item from the list
/** \anchor cds_intrusive_MichaelList_hp_erase_val
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
unlinks it from the list, and returns \p true.
- If the item with the key equal to \p val is not found the function return \p false.
+ If \p key is not found the function return \p false.
*/
template <typename Q>
- bool erase( Q const& val )
+ bool erase( Q const& key )
{
- return erase_at( m_pHead, val, key_comparator() );
+ return erase_at( m_pHead, key, key_comparator() );
}
/// Deletes the item from the list using \p pred predicate for searching
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool erase_with( Q const& val, Less pred )
+ bool erase_with( Q const& key, Less pred )
{
- return erase_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>());
+ return erase_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>());
}
/// Deletes the item from the list
/** \anchor cds_intrusive_MichaelList_hp_erase_func
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
call \p func functor with item found, unlinks it from the list, and returns \p true.
The \p Func interface is
\code
void operator()( value_type const& item );
};
\endcode
- The functor may be passed by reference using <tt>boost:ref</tt>
-
- If the item with the key equal to \p val is not found the function return \p false.
+ If \p key is not found the function return \p false, \p func is not called.
*/
template <typename Q, typename Func>
- bool erase( Q const& val, Func func )
+ bool erase( Q const& key, Func func )
{
- return erase_at( m_pHead, val, key_comparator(), func );
+ return erase_at( m_pHead, key, key_comparator(), func );
}
/// Deletes the item from the list using \p pred predicate for searching
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool erase_with( Q const& val, Less pred, Func f )
+ bool erase_with( Q const& key, Less pred, Func f )
{
- return erase_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return erase_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
/// Extracts the item from the list with specified \p key
return extract_at( m_pHead, dest.guard(), key, cds::opt::details::make_comparator_from_less<Less>() );
}
- /// Finds the key \p val
+ /// Finds \p key in the list
/** \anchor cds_intrusive_MichaelList_hp_find_func
- The function searches the item with key equal to \p val and calls the functor \p f for item found.
+ The function searches the item with key equal to \p key and calls the functor \p f for item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref.
+ where \p item is the item found, \p key is the <tt>find</tt> function argument.
The functor may change non-key fields of \p item. Note that the function is only guarantee
that \p item cannot be disposed during functor is executing.
- The function does not serialize simultaneous access to the list \p item. If such access is
- possible you must provide your own synchronization schema to exclude unsafe item modifications.
+ The function does not serialize simultaneous access to the \p item. If such access is
+ possible you must provide your own synchronization schema to keep out unsafe item modifications.
- The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
+ The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
may modify both arguments.
The function returns \p true if \p val is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f )
+ bool find( Q& key, Func f )
{
- return find_at( m_pHead, val, key_comparator(), f );
+ return find_at( m_pHead, key, key_comparator(), f );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds the \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_intrusive_MichaelList_hp_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f )
- {
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), f );
- }
-
- /// Finds the key \p val
- /** \anchor cds_intrusive_MichaelList_hp_find_cfunc
- The function searches the item with key equal to \p val and calls the functor \p f for item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using \p std::ref.
-
- The functor may change non-key fields of \p item. Note that the function is only guarantee
- that \p item cannot be disposed during functor is executing.
- The function does not serialize simultaneous access to the list \p item. If such access is
- possible you must provide your own synchronization schema to exclude unsafe item modifications.
-
- The function returns \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f )
- {
- return find_at( m_pHead, val, key_comparator(), f );
- }
-
- /// Finds the key \p val using \p pred predicate for searching
- /**
- The function is an analog of \ref cds_intrusive_MichaelList_hp_find_cfunc "find(Q const&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
- */
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f )
+ bool find_with( Q& key, Less pred, Func f )
{
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return find_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
- /// Finds the key \p val
+ /// Finds the \p key
/** \anchor cds_intrusive_MichaelList_hp_find_val
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and returns \p true if it is found, and \p false otherwise
*/
template <typename Q>
- bool find( Q const & val )
+ bool find( Q const& key )
{
- return find_at( m_pHead, val, key_comparator() );
+ return find_at( m_pHead, key, key_comparator() );
}
/// Finds the key \p val using \p pred predicate for searching
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool find_with( Q const& val, Less pred )
+ bool find_with( Q const& key, Less pred )
{
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>() );
+ return find_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>() );
}
- /// Finds the key \p val and return the item found
+ /// Finds the \p key and return the item found
/** \anchor cds_intrusive_MichaelList_hp_get
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and assigns the item found to guarded pointer \p ptr.
- The function returns \p true if \p val is found, and \p false otherwise.
- If \p val is not found the \p ptr parameter is not changed.
+ The function returns \p true if \p key is found, and \p false otherwise.
+ If \p key is not found the \p ptr parameter is not changed.
The \ref disposer specified in \p Traits class template parameter is called
by garbage collector \p GC automatically when returned \ref guarded_ptr object
should accept a parameter of type \p Q that can be not the same as \p value_type.
*/
template <typename Q>
- bool get( guarded_ptr& ptr, Q const& val )
+ bool get( guarded_ptr& ptr, Q const& key )
{
- return get_at( m_pHead, ptr.guard(), val, key_comparator() );
+ return get_at( m_pHead, ptr.guard(), key, key_comparator() );
}
- /// Finds the key \p val and return the item found
+ /// Finds the \p key and return the item found
/**
The function is an analog of \ref cds_intrusive_MichaelList_hp_get "get( guarded_ptr& ptr, Q const&)"
but \p pred is used for comparing the keys.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool get_with( guarded_ptr& ptr, Q const& val, Less pred )
+ bool get_with( guarded_ptr& ptr, Q const& key, Less pred )
{
- return get_at( m_pHead, ptr.guard(), val, cds::opt::details::make_comparator_from_less<Less>() );
+ return get_at( m_pHead, ptr.guard(), key, cds::opt::details::make_comparator_from_less<Less>() );
}
/// Clears the list
}
}
- /// Checks if the list is empty
+ /// Checks whether the list is empty
bool empty() const
{
return m_pHead.load( memory_model::memory_order_relaxed ).all() == nullptr;
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomicity::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @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 \p empty() method.
*/
size_t size() const
{
#include <cds/intrusive/details/michael_list_base.h>
#include <cds/gc/nogc.h>
+#include <cds/details/make_const_type.h>
+
namespace cds { namespace intrusive {
: m_pNext( nullptr )
{}
};
-
} // namespace michael_list
/// Michael's lock-free ordered single-linked list (template specialization for gc::nogc)
/** @ingroup cds_intrusive_list
\anchor cds_intrusive_MichaelList_nogc
- This specialization is intended for so-called persistent usage when no item
- reclamation may be performed. The class does not support deleting of item.
+ This specialization is intended for so-called append-only usage when no item
+ reclamation may be performed. The class does not support item removal.
See \ref cds_intrusive_MichaelList_hp "MichaelList" for description of template parameters.
-
- The interface of the specialization is a slightly different.
*/
- template < typename T, class Traits >
+ template < typename T,
+#ifdef CDS_DOXYGEN_INVOKED
+ class Traits = michael_list::traits
+#else
+ class Traits
+#endif
+ >
class MichaelList<gc::nogc, T, Traits>
{
public:
- typedef T value_type ; ///< type of value stored in the queue
- typedef Traits options ; ///< Traits template parameter
+ typedef gc::nogc gc; ///< Garbage collector
+ typedef T value_type; ///< type of value to be stored in the queue
+ typedef Traits traits; ///< List traits
- typedef typename options::hook hook ; ///< hook type
- typedef typename hook::node_type node_type ; ///< node type
+ typedef typename traits::hook hook; ///< hook type
+ typedef typename hook::node_type node_type; ///< node type
# ifdef CDS_DOXYGEN_INVOKED
typedef implementation_defined key_comparator ; ///< key comparison functor based on opt::compare and opt::less option setter.
# else
- typedef typename opt::details::make_comparator< value_type, options >::type key_comparator;
+ typedef typename opt::details::make_comparator< value_type, traits >::type key_comparator;
# endif
- typedef typename options::disposer disposer ; ///< disposer used
+ typedef typename traits::disposer disposer; ///< disposer used
typedef typename get_node_traits< value_type, node_type, hook>::type node_traits ; ///< node traits
- typedef typename michael_list::get_link_checker< node_type, options::link_checker >::type link_checker ; ///< link checker
+ typedef typename michael_list::get_link_checker< node_type, traits::link_checker >::type link_checker; ///< link checker
- typedef gc::nogc gc ; ///< Garbage collector
- typedef typename options::back_off back_off ; ///< back-off strategy
- typedef typename options::item_counter item_counter ; ///< Item counting policy used
- typedef typename options::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
+ typedef typename traits::back_off back_off; ///< back-off strategy
+ typedef typename traits::item_counter item_counter; ///< Item counting policy used
+ typedef typename traits::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
//@cond
- // Rebind options (split-list support)
+ // Rebind traits (split-list support)
template <typename... Options>
- struct rebind_options {
+ struct rebind_traits {
typedef MichaelList<
gc
, value_type
- , typename cds::opt::make_options< options, Options...>::type
+ , typename cds::opt::make_options< traits, Options...>::type
> type;
};
//@endcond
typedef typename node_type::atomic_ptr atomic_node_ptr ; ///< Atomic node pointer
typedef atomic_node_ptr auxiliary_head ; ///< Auxiliary head type (for split-list support)
- atomic_node_ptr m_pHead ; ///< Head pointer
- item_counter m_ItemCounter ; ///< Item counter
+ atomic_node_ptr m_pHead; ///< Head pointer
+ item_counter m_ItemCounter; ///< Item counter
//@cond
/// Position pointer for item search
protected:
//@cond
- void clear_links( node_type * pNode )
+ static void clear_links( node_type * pNode )
{
pNode->m_pNext.store( nullptr, memory_model::memory_order_release );
}
template <class Disposer>
- void dispose_node( node_type * pNode, Disposer disp )
+ static void dispose_node( node_type * pNode, Disposer disp )
{
clear_links( pNode );
disp( node_traits::to_value_ptr( *pNode ));
}
template <class Disposer>
- void dispose_value( value_type& val, Disposer disp )
+ static void dispose_value( value_type& val, Disposer disp )
{
dispose_node( node_traits::to_node_ptr( val ), disp );
}
- bool link_node( node_type * pNode, position& pos )
+ static bool link_node( node_type * pNode, position& pos )
{
assert( pNode != nullptr );
link_checker::is_empty( pNode );
protected:
//@cond
- template <bool IS_CONST>
+ template <bool IsConst>
class iterator_type
{
friend class MichaelList;
}
public:
- typedef typename cds::details::make_const_type<value_type, IS_CONST>::pointer value_ptr;
- typedef typename cds::details::make_const_type<value_type, IS_CONST>::reference value_ref;
+ typedef typename cds::details::make_const_type<value_type, IsConst>::pointer value_ptr;
+ typedef typename cds::details::make_const_type<value_type, IsConst>::reference value_ref;
iterator_type()
: m_pNode( nullptr )
/// Finds the key \p val
/** \anchor cds_intrusive_MichaelList_nogc_find_func
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and calls the functor \p f for item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You can pass \p f argument by value or by reference using \p std::ref.
+ where \p item is the item found, \p key is the <tt>find</tt> function argument.
The functor can change non-key fields of \p item.
The function \p find does not serialize simultaneous access to the list \p item. If such access is
The function returns \p true if \p val is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f )
+ bool find( Q& key, Func f )
{
- return find_at( m_pHead, val, key_comparator(), f );
+ return find_at( m_pHead, key, key_comparator(), f );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds the key \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_intrusive_MichaelList_nogc_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f )
+ bool find_with( Q& key, Less pred, Func f )
{
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return find_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
- /// Finds the key \p val
- /** \anchor cds_intrusive_MichaelList_nogc_find_cfunc
- The function searches the item with key equal to \p val
- and calls the functor \p f for item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You can pass \p f argument by value or by reference using \p std::ref.
-
- The functor can change non-key fields of \p item.
- The function \p find does not serialize simultaneous access to the list \p item. If such access is
- possible you must provide your own synchronization schema to exclude unsafe item modifications.
-
- The function returns \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f )
- {
- return find_at( m_pHead, val, key_comparator(), f );
- }
-
- /// Finds the key \p val using \p pred predicate for searching
- /**
- The function is an analog of \ref cds_intrusive_MichaelList_nogc_find_cfunc "find(Q const&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
- */
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f )
- {
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), f );
- }
-
- /// Finds the key \p val
+ /// Finds \p key
/** \anchor cds_intrusive_MichaelList_nogc_find_val
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and returns pointer to value found or \p nullptr.
*/
template <typename Q>
- value_type * find( Q const & val )
+ value_type * find( Q const& key )
{
- return find_at( m_pHead, val, key_comparator() );
+ return find_at( m_pHead, key, key_comparator() );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_intrusive_MichaelList_nogc_find_val "find(Q const&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- value_type * find_with( Q const& val, Less pred )
+ value_type * find_with( Q const& key, Less pred )
{
- return find_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>());
+ return find_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>());
}
/// Clears the list
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomics::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @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 \p empty() method.
*/
size_t size() const
{
#include <cds/intrusive/details/michael_list_base.h>
#include <cds/urcu/details/check_deadlock.h>
#include <cds/details/binary_functor_wrapper.h>
+#include <cds/details/make_const_type.h>
#include <cds/urcu/exempt_ptr.h>
namespace cds { namespace intrusive {
- \p RCU - one of \ref cds_urcu_gc "RCU type"
- \p T - type to be stored in the list; the type \p T should be based on (or has a member of type)
cds::intrusive::micheal_list::node
- - \p Traits - type traits. See michael_list::type_traits for explanation.
-
- It is possible to declare option-based list with \p %cds::intrusive::michael_list::make_traits metafunction istead of \p Traits template
- argument. Template argument list \p Options of cds::intrusive::michael_list::make_traits metafunction are:
- - opt::hook - hook used. Possible values are: michael_list::base_hook, michael_list::member_hook, michael_list::traits_hook.
- If the option is not specified, <tt>michael_list::base_hook<></tt> is used.
- - opt::compare - key comparison functor. No default functor is provided.
- If the option is not specified, the opt::less is used.
- - opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
- - opt::disposer - the functor used for dispose removed items. Default is opt::v::empty_disposer
- - opt::rcu_check_deadlock - a deadlock checking policy. Default is opt::v::rcu_throw_deadlock
- - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter
- - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
- or opt::v::sequential_consistent (sequentially consisnent memory model).
+ - \p Traits - type traits. See \p michael_list::traits for explanation. It is possible to declare option-based
+ list with \p cds::intrusive::michael_list::make_traits metafunction,
+ see \ref cds_intrusive_MichaelList_hp "here" for explanations.
\par Usage
Before including <tt><cds/intrusive/michael_list_rcu.h></tt> you should include appropriate RCU header file,
typedef cds::intrusive::MichaelList<cds::urcu::gc< cds::urcu::general_buffered<> >, Foo > rcu_michael_list;
\endcode
*/
- template < typename RCU, typename T, class Traits >
+ template < typename RCU, typename T,
+#ifdef CDS_DOXYGEN_INVOKED
+ class Traits = michael_list::traits
+#else
+ class Traits
+#endif
+ >
class MichaelList<cds::urcu::gc<RCU>, T, Traits>
{
public:
- typedef T value_type ; ///< type of value stored in the queue
- typedef Traits options ; ///< Traits template parameter
+ typedef T value_type; ///< type of value stored in the list
+ typedef Traits traits; ///< Traits template parameter
- typedef typename options::hook hook ; ///< hook type
- typedef typename hook::node_type node_type ; ///< node type
+ typedef typename traits::hook hook; ///< hook type
+ typedef typename hook::node_type node_type; ///< node type
# ifdef CDS_DOXYGEN_INVOKED
typedef implementation_defined key_comparator ; ///< key comparison functor based on opt::compare and opt::less option setter.
# else
- typedef typename opt::details::make_comparator< value_type, options >::type key_comparator;
+ typedef typename opt::details::make_comparator< value_type, traits >::type key_comparator;
# endif
- typedef typename options::disposer disposer ; ///< disposer used
+ typedef typename traits::disposer disposer; ///< disposer used
typedef typename get_node_traits< value_type, node_type, hook>::type node_traits ; ///< node traits
- typedef typename michael_list::get_link_checker< node_type, options::link_checker >::type link_checker ; ///< link checker
+ typedef typename michael_list::get_link_checker< node_type, traits::link_checker >::type link_checker; ///< link checker
- typedef cds::urcu::gc<RCU> gc ; ///< RCU schema
- typedef typename options::back_off back_off ; ///< back-off strategy
- typedef typename options::item_counter item_counter; ///< Item counting policy used
- typedef typename options::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
- typedef typename options::rcu_check_deadlock rcu_check_deadlock ; ///< Deadlock checking policy
+ typedef cds::urcu::gc<RCU> gc; ///< RCU schema
+ typedef typename traits::back_off back_off; ///< back-off strategy
+ typedef typename traits::item_counter item_counter; ///< Item counting policy used
+ typedef typename traits::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
+ typedef typename traits::rcu_check_deadlock rcu_check_deadlock; ///< Deadlock checking policy
typedef typename gc::scoped_lock rcu_lock ; ///< RCU scoped lock
static CDS_CONSTEXPR const bool c_bExtractLockExternal = true; ///< Group of \p extract_xxx functions require external locking
//@cond
- // Rebind options (split-list support)
+ // Rebind traits (split-list support)
template <typename... Options>
- struct rebind_options {
+ struct rebind_traits {
typedef MichaelList<
gc
, value_type
- , typename cds::opt::make_options< options, Options...>::type
+ , typename cds::opt::make_options< traits, Options...>::type
> type;
};
//@endcond
The function allows to split new item creating into two part:
- create item with key only
- insert new item into the list
- - if inserting is success, calls \p f functor to initialize value-field of \p val.
+ - if inserting is success, calls \p f functor to initialize value-field of \p val.
The functor signature is:
\code
\endcode
where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
\p val no any other changes could be made on this list's item by concurrent threads.
- The user-defined functor is called only if the inserting is success and may be passed by reference
- using \p std::ref.
+ The user-defined functor is called only if the inserting is success.
The function makes RCU lock internally.
*/
The functor may change non-key fields of the \p item; however, \p func must guarantee
that during changing no any other modifications could be made on this item by concurrent threads.
- You can pass \p func argument by value or by reference using \p std::ref.
-
Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
\p second is true if new item has been added or \p false if the item with \p key
already is in the list.
The function makes RCU lock internally.
*/
-
template <typename Func>
std::pair<bool, bool> ensure( value_type& val, Func func )
{
Difference between \ref erase and \p unlink functions: \p erase finds <i>a key</i>
and deletes the item found. \p unlink finds an item by key and deletes it
- only if \p val is an item of that list, i.e. the pointer to item found
+ only if \p val is an item of that list, i.e. the pointer to the item found
is equal to <tt> &val </tt>.
The function returns \p true if success and \p false otherwise.
/// Deletes the item from the list
/** \anchor cds_intrusive_MichaelList_rcu_erase_val
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
unlinks it from the list, and returns \p true.
- If the item with the key equal to \p val is not found the function return \p false.
+ If the item with the key equal to \p key is not found the function return \p false.
RCU \p synchronize method can be called.
Note that depending on RCU type used the \ref disposer call can be deferred.
The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if a deadlock is detected and
- the deadlock checking policy is opt::v::rcu_throw_deadlock.
+ the deadlock checking policy is \p opt::v::rcu_throw_deadlock.
*/
template <typename Q>
- bool erase( Q const& val )
+ bool erase( Q const& key )
{
- return erase_at( m_pHead, val, key_comparator() );
+ return erase_at( m_pHead, key, key_comparator() );
}
/// Deletes the item from the list using \p pred predicate for searching
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool erase_with( Q const& val, Less pred )
+ bool erase_with( Q const& key, Less pred )
{
- return erase_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>() );
+ return erase_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>() );
}
/// Deletes the item from the list
/** \anchor cds_intrusive_MichaelList_rcu_erase_func
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
call \p func functor with item found, unlinks it from the list, and returns \p true.
The \p Func interface is
\code
void operator()( value_type const& item );
};
\endcode
- The functor may be passed by reference using <tt>boost:ref</tt>
- If the item with the key equal to \p val is not found the function return \p false.
+ If the item with the key equal to \p key is not found the function return \p false.
RCU \p synchronize method can be called.
Note that depending on RCU type used the \ref disposer call can be deferred.
The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if a deadlock is detected and
- the deadlock checking policy is opt::v::rcu_throw_deadlock.
+ the deadlock checking policy is \p opt::v::rcu_throw_deadlock.
*/
template <typename Q, typename Func>
- bool erase( Q const& val, Func func )
+ bool erase( Q const& key, Func func )
{
- return erase_at( m_pHead, val, key_comparator(), func );
+ return erase_at( m_pHead, key, key_comparator(), func );
}
/// Deletes the item from the list using \p pred predicate for searching
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool erase_with( Q const& val, Less pred, Func func )
+ bool erase_with( Q const& key, Less pred, Func func )
{
- return erase_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>(), func );
+ return erase_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>(), func );
}
/// Extracts an item from the list
/**
@anchor cds_intrusive_MichaelList_rcu_extract
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
unlinks it from the list, and returns pointer to an item found in \p dest parameter.
- If the item with the key equal to \p val is not found the function returns \p false,
- \p dest is empty.
+ If \p key is not found the function returns \p false, \p dest is empty.
@note The function does NOT call RCU read-side lock or synchronization,
- and does NOT dispose the item found. It just excludes the item from the list
+ and does NOT dispose the item found. It just unlinks the item from the list
and returns a pointer to item found.
You should lock RCU before calling this function, and you should manually release
\p dest exempt pointer outside the RCU lock before reusing the pointer.
\endcode
*/
template <typename Q>
- bool extract( exempt_ptr& dest, Q const& val )
+ bool extract( exempt_ptr& dest, Q const& key )
{
- dest = extract_at( m_pHead, val, key_comparator() );
+ dest = extract_at( m_pHead, key, key_comparator() );
return !dest.empty();
}
\p pred must imply the same element order as \ref key_comparator.
*/
template <typename Q, typename Less>
- bool extract_with( exempt_ptr& dest, Q const& val, Less pred )
+ bool extract_with( exempt_ptr& dest, Q const& key, Less pred )
{
- dest = extract_at( m_pHead, val, cds::opt::details::make_comparator_from_less<Less>() );
+ dest = extract_at( m_pHead, key, cds::opt::details::make_comparator_from_less<Less>() );
return !dest.empty();
}
/// Find the key \p val
/** \anchor cds_intrusive_MichaelList_rcu_find_func
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and calls the functor \p f for item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You can pass \p f argument by value or by reference using \p std::ref.
+ where \p item is the item found, \p key is the <tt>find</tt> function argument.
The functor can change non-key fields of \p item.
The function \p find does not serialize simultaneous access to the list \p item. If such access is
The function returns \p true if \p val is found, \p false otherwise.
*/
template <typename Q, typename Func>
- bool find( Q& val, Func f ) const
+ bool find( Q& key, Func f ) const
{
- return find_at( const_cast<atomic_node_ptr&>(m_pHead), val, key_comparator(), f );
+ return find_at( const_cast<atomic_node_ptr&>(m_pHead), key, key_comparator(), f );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_intrusive_MichaelList_rcu_find_func "find(Q&, Func)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f ) const
- {
- return find_at( const_cast<atomic_node_ptr&>( m_pHead ), val, cds::opt::details::make_comparator_from_less<Less>(), f );
- }
-
- /// Find the key \p val
- /** \anchor cds_intrusive_MichaelList_rcu_find_cfunc
- The function searches the item with key equal to \p val
- and calls the functor \p f for item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You can pass \p f argument by value or by reference using \p std::ref.
-
- The functor can change non-key fields of \p item.
- The function \p find does not serialize simultaneous access to the list \p 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 \p true if \p val is found, \p false otherwise.
- */
- template <typename Q, typename Func>
- bool find( Q const& val, Func f ) const
- {
- return find_at( const_cast<atomic_node_ptr&>( m_pHead ), val, key_comparator(), f );
- }
-
- /// Finds the key \p val using \p pred predicate for searching
- /**
- The function is an analog of \ref cds_intrusive_MichaelList_rcu_find_cfunc "find(Q const&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
- */
- template <typename Q, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f ) const
+ bool find_with( Q& key, Less pred, Func f ) const
{
- return find_at( const_cast<atomic_node_ptr&>( m_pHead ), val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return find_at( const_cast<atomic_node_ptr&>( m_pHead ), key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
- /// Find the key \p val
+ /// Finds \p key
/** \anchor cds_intrusive_MichaelList_rcu_find_val
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and returns \p true if \p val found or \p false otherwise.
*/
template <typename Q>
- bool find( Q const& val ) const
+ bool find( Q const& key ) const
{
- return find_at( const_cast<atomic_node_ptr&>( m_pHead ), val, key_comparator() );
+ return find_at( const_cast<atomic_node_ptr&>( m_pHead ), key, key_comparator() );
}
- /// Finds the key \p val using \p pred predicate for searching
+ /// Finds \p key using \p pred predicate for searching
/**
The function is an analog of \ref cds_intrusive_MichaelList_rcu_find_val "find(Q const&)"
but \p pred is used for key comparing.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool find_with( Q const& val, Less pred ) const
+ bool find_with( Q const& key, Less pred ) const
{
- return find_at( const_cast<atomic_node_ptr&>( m_pHead ), val, cds::opt::details::make_comparator_from_less<Less>() );
+ return find_at( const_cast<atomic_node_ptr&>( m_pHead ), key, cds::opt::details::make_comparator_from_less<Less>() );
}
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/** \anchor cds_intrusive_MichaelList_rcu_get
- The function searches the item with key equal to \p val and returns the pointer to item found.
- If \p val is not found it returns \p nullptr.
+ The function searches the item with key equal to \p key and returns the pointer to item found.
+ If \p key is not found it returns \p nullptr.
Note the compare functor should accept a parameter of type \p Q that can be not the same as \p value_type.
\endcode
*/
template <typename Q>
- value_type * get( Q const& val ) const
+ value_type * get( Q const& key ) const
{
- return get_at( const_cast<atomic_node_ptr&>( m_pHead ), val, key_comparator());
+ return get_at( const_cast<atomic_node_ptr&>( m_pHead ), key, key_comparator());
}
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/**
The function is an analog of \ref cds_intrusive_MichaelList_rcu_get "get(Q const&)"
but \p pred is used for comparing the keys.
- \p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type and \p Q
+ \p Less functor has the semantics like \p std::less but should take arguments of type \p value_type and \p Q
in any order.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- value_type * get_with( Q const& val, Less pred ) const
+ value_type * get_with( Q const& key, Less pred ) const
{
- return get_at( const_cast<atomic_node_ptr&>( m_pHead ), val, cds::opt::details::make_comparator_from_less<Less>());
+ return get_at( const_cast<atomic_node_ptr&>( m_pHead ), key, cds::opt::details::make_comparator_from_less<Less>());
}
/// Clears the list using default disposer
/**
- The function clears the list using default (provided in class template) disposer functor.
+ The function clears the list using default (provided by \p Traits class template argument) disposer functor.
RCU \p synchronize method can be called.
Note that depending on RCU type used the \ref disposer invocation can be deferred.
/// Returns list's item count
/**
- The value returned depends on opt::item_counter option. For atomics::empty_item_counter,
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
this function always returns 0.
- <b>Warning</b>: even if you use real item counter and it returns 0, this fact is not mean that the list
- is empty. To check list emptyness use \ref empty() method.
+ @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 \p empty() method.
*/
size_t size() const
{
> barQueue;
\endcode
*/
- template <typename GC, typename T, typename Traits>
+ template <typename GC, typename T, typename Traits = msqueue::traits>
class MSQueue
{
public:
The split-ordered list is a lock-free implementation of an extensible unbounded hash table. It uses original
recursive split-ordering algorithm discovered by Ori Shalev and Nir Shavit that allows to split buckets
- without moving an item on resizing.
+ without items moving on resizing.
\anchor cds_SplitList_algo_desc
<b>Short description</b>
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_lazy_rcu_gpt.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_lazy_rcu_shb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_lazy_rcu_sht.cpp" />\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_dhp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_hp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_list_rcu_gpb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_list_rcu_gpi.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_list_rcu_shb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_list_rcu_sht.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_nogc.cpp" />\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_ptb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_hp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_hrc.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_kv_hp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_rcu_gpt.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_rcu_shb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_rcu_sht.cpp" />\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_dhp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_hp.cpp" />\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_dhp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_hp.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_nogc.cpp" />\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_ptb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_rcu_gpb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_rcu_gpi.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_rcu_gpt.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_rcu_shb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_rcu_sht.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_nogc.cpp" />\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_ptb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_rcu_gpb.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_rcu_gpi.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_rcu_gpt.cpp" />\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_nogc.cpp">\r
<Filter>intrusive</Filter>\r
</ClCompile>\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_ptb.cpp">\r
- <Filter>intrusive</Filter>\r
- </ClCompile>\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_lazy_hp.cpp">\r
<Filter>container</Filter>\r
</ClCompile>\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_nogc.cpp">\r
<Filter>container</Filter>\r
</ClCompile>\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_ptb.cpp">\r
- <Filter>container</Filter>\r
- </ClCompile>\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_nogc.cpp">\r
<Filter>container</Filter>\r
</ClCompile>\r
- <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_ptb.cpp">\r
- <Filter>container</Filter>\r
- </ClCompile>\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_rcu_gpb.cpp">\r
<Filter>container</Filter>\r
</ClCompile>\r
<ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_rcu_sht.cpp">\r
<Filter>container</Filter>\r
</ClCompile>\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_michael_dhp.cpp">\r
+ <Filter>intrusive</Filter>\r
+ </ClCompile>\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_dhp.cpp">\r
+ <Filter>container</Filter>\r
+ </ClCompile>\r
+ <ClCompile Include="..\..\..\tests\test-hdr\ordered_list\hdr_michael_kv_dhp.cpp">\r
+ <Filter>container</Filter>\r
+ </ClCompile>\r
</ItemGroup>\r
<ItemGroup>\r
<ClInclude Include="..\..\..\tests\test-hdr\ordered_list\hdr_intrusive_lazy.h">\r
tests/test-hdr/ordered_list/hdr_lazy_kv_rcu_gpt.cpp \
tests/test-hdr/ordered_list/hdr_lazy_kv_rcu_shb.cpp \
tests/test-hdr/ordered_list/hdr_lazy_kv_rcu_sht.cpp \
+ tests/test-hdr/ordered_list/hdr_michael_dhp.cpp \
tests/test-hdr/ordered_list/hdr_michael_hp.cpp \
tests/test-hdr/ordered_list/hdr_michael_nogc.cpp \
- tests/test-hdr/ordered_list/hdr_michael_ptb.cpp \
tests/test-hdr/ordered_list/hdr_michael_rcu_gpi.cpp \
tests/test-hdr/ordered_list/hdr_michael_rcu_gpb.cpp \
tests/test-hdr/ordered_list/hdr_michael_rcu_gpt.cpp \
tests/test-hdr/ordered_list/hdr_michael_rcu_shb.cpp \
tests/test-hdr/ordered_list/hdr_michael_rcu_sht.cpp \
+ tests/test-hdr/ordered_list/hdr_michael_kv_dhp.cpp \
tests/test-hdr/ordered_list/hdr_michael_kv_hp.cpp \
tests/test-hdr/ordered_list/hdr_michael_kv_nogc.cpp \
- tests/test-hdr/ordered_list/hdr_michael_kv_ptb.cpp \
tests/test-hdr/ordered_list/hdr_michael_kv_rcu_gpi.cpp \
tests/test-hdr/ordered_list/hdr_michael_kv_rcu_gpb.cpp \
tests/test-hdr/ordered_list/hdr_michael_kv_rcu_gpt.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_lazy_rcu_sht.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_michael_hp.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_michael_nogc.cpp \
- tests/test-hdr/ordered_list/hdr_intrusive_michael_ptb.cpp \
+ tests/test-hdr/ordered_list/hdr_intrusive_michael_dhp.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_michael_list_rcu_gpb.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_michael_list_rcu_gpi.cpp \
tests/test-hdr/ordered_list/hdr_intrusive_michael_list_rcu_gpt.cpp \
void HP_member_cmpmix();
void HP_member_ic();
- void PTB_base_cmp();
- void PTB_base_less();
- void PTB_base_cmpmix();
- void PTB_base_ic();
- void PTB_member_cmp();
- void PTB_member_less();
- void PTB_member_cmpmix();
- void PTB_member_ic();
+ void DHP_base_cmp();
+ void DHP_base_less();
+ void DHP_base_cmpmix();
+ void DHP_base_ic();
+ void DHP_member_cmp();
+ void DHP_member_less();
+ void DHP_member_cmpmix();
+ void DHP_member_ic();
void RCU_GPI_base_cmp();
void RCU_GPI_base_less();
CPPUNIT_TEST(HP_member_cmpmix)
CPPUNIT_TEST(HP_member_ic)
- CPPUNIT_TEST(PTB_base_cmp)
- CPPUNIT_TEST(PTB_base_less)
- CPPUNIT_TEST(PTB_base_cmpmix)
- CPPUNIT_TEST(PTB_base_ic)
- CPPUNIT_TEST(PTB_member_cmp)
- CPPUNIT_TEST(PTB_member_less)
- CPPUNIT_TEST(PTB_member_cmpmix)
- CPPUNIT_TEST(PTB_member_ic)
+ CPPUNIT_TEST(DHP_base_cmp)
+ CPPUNIT_TEST(DHP_base_less)
+ CPPUNIT_TEST(DHP_base_cmpmix)
+ CPPUNIT_TEST(DHP_base_ic)
+ CPPUNIT_TEST(DHP_member_cmp)
+ CPPUNIT_TEST(DHP_member_less)
+ CPPUNIT_TEST(DHP_member_cmpmix)
+ CPPUNIT_TEST(DHP_member_ic)
CPPUNIT_TEST(RCU_GPI_base_cmp)
CPPUNIT_TEST(RCU_GPI_base_less)
#include <cds/intrusive/michael_list_dhp.h>
namespace ordlist {
- void IntrusiveMichaelListHeaderTest::PTB_base_cmp()
+ void IntrusiveMichaelListHeaderTest::DHP_base_cmp()
{
- typedef base_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::PTB> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ typedef base_int_item< cds::gc::DHP > item;
+ struct traits : public ci::michael_list::traits {
+ typedef ci::michael_list::base_hook< co::gc<cds::gc::DHP> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< cds::gc::DHP, item, traits > list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_base_less()
+ void IntrusiveMichaelListHeaderTest::DHP_base_less()
{
- typedef base_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef base_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::PTB> > >
+ ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::DHP> > >
,co::less< less<item> >
,ci::opt::disposer< faked_disposer >
>::type
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_base_cmpmix()
+ void IntrusiveMichaelListHeaderTest::DHP_base_cmpmix()
{
- typedef base_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef base_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::PTB> > >
+ ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::DHP> > >
,co::less< less<item> >
,co::compare< cmp<item> >
,ci::opt::disposer< faked_disposer >
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_base_ic()
+ void IntrusiveMichaelListHeaderTest::DHP_base_ic()
{
- typedef base_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef base_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::PTB> > >
+ ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::DHP> > >
,co::less< less<item> >
,co::compare< cmp<item> >
,ci::opt::disposer< faked_disposer >
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_member_cmp()
+ void IntrusiveMichaelListHeaderTest::DHP_member_cmp()
{
- typedef member_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef member_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
ci::opt::hook< ci::michael_list::member_hook<
offsetof( item, hMember ),
- co::gc<cds::gc::PTB>
+ co::gc<cds::gc::DHP>
> >
,co::compare< cmp<item> >
,ci::opt::disposer< faked_disposer >
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_member_less()
+ void IntrusiveMichaelListHeaderTest::DHP_member_less()
{
- typedef member_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef member_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
ci::opt::hook< ci::michael_list::member_hook<
offsetof( item, hMember ),
- co::gc<cds::gc::PTB>
+ co::gc<cds::gc::DHP>
> >
,co::less< less<item> >
,ci::opt::disposer< faked_disposer >
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_member_cmpmix()
+ void IntrusiveMichaelListHeaderTest::DHP_member_cmpmix()
{
- typedef member_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef member_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
ci::opt::hook< ci::michael_list::member_hook<
offsetof( item, hMember ),
- co::gc<cds::gc::PTB>
+ co::gc<cds::gc::DHP>
> >
,co::less< less<item> >
,co::compare< cmp<item> >
> list;
test_int<list>();
}
- void IntrusiveMichaelListHeaderTest::PTB_member_ic()
+ void IntrusiveMichaelListHeaderTest::DHP_member_ic()
{
- typedef member_int_item< cds::gc::PTB > item;
- typedef ci::MichaelList< cds::gc::PTB
+ typedef member_int_item< cds::gc::DHP > item;
+ typedef ci::MichaelList< cds::gc::DHP
,item
,ci::michael_list::make_traits<
ci::opt::hook< ci::michael_list::member_hook<
offsetof( item, hMember ),
- co::gc<cds::gc::PTB>
+ co::gc<cds::gc::DHP>
> >
,co::compare< cmp<item> >
,ci::opt::disposer< faked_disposer >
void IntrusiveMichaelListHeaderTest::HP_base_cmp()
{
typedef base_int_item< cds::gc::HP > item;
- typedef ci::MichaelList< cds::gc::HP
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::HP> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits {
+ typedef ci::michael_list::base_hook< co::gc<cds::gc::HP> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< cds::gc::HP, item, traits > list;
test_int<list>();
}
void IntrusiveMichaelListHeaderTest::HP_base_less()
void IntrusiveMichaelListHeaderTest::RCU_GPB_base_cmp()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPB_base_less()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPB_base_cmpmix()
void IntrusiveMichaelListHeaderTest::RCU_GPI_base_cmp()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPI_base_less()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPI_base_cmpmix()
void IntrusiveMichaelListHeaderTest::RCU_GPT_base_cmp()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPT_base_less()
{
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
}
void IntrusiveMichaelListHeaderTest::RCU_GPT_base_cmpmix()
{
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
#endif
}
{
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
#endif
}
{
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
#endif
}
{
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
typedef base_int_item< RCU > item;
- typedef ci::MichaelList< RCU
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<RCU> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<RCU> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< RCU, item, traits > list;
test_rcu_int<list>();
#endif
}
void IntrusiveMichaelListHeaderTest::nogc_base_cmp()
{
typedef base_int_item< cds::gc::nogc > item;
- typedef ci::MichaelList< cds::gc::nogc
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::nogc> > >
- ,co::compare< cmp<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<cds::gc::nogc> > hook;
+ typedef cmp<item> compare;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< cds::gc::nogc, item, traits > list;
test_nogc_int<list>();
}
void IntrusiveMichaelListHeaderTest::nogc_base_less()
{
typedef base_int_item< cds::gc::nogc > item;
- typedef ci::MichaelList< cds::gc::nogc
- ,item
- ,ci::michael_list::make_traits<
- ci::opt::hook< ci::michael_list::base_hook< co::gc<cds::gc::nogc> > >
- ,co::less< less<item> >
- ,ci::opt::disposer< faked_disposer >
- >::type
- > list;
+ struct traits : public ci::michael_list::traits
+ {
+ typedef ci::michael_list::base_hook< co::gc<cds::gc::nogc> > hook;
+ typedef IntrusiveMichaelListHeaderTest::less<item> less;
+ typedef faked_disposer disposer;
+ };
+ typedef ci::MichaelList< cds::gc::nogc, item, traits > list;
test_nogc_int<list>();
}
void IntrusiveMichaelListHeaderTest::nogc_base_cmpmix()
void HP_cmpmix();
void HP_ic();
- void PTB_cmp();
- void PTB_less();
- void PTB_cmpmix();
- void PTB_ic();
+ void DHP_cmp();
+ void DHP_less();
+ void DHP_cmpmix();
+ void DHP_ic();
void RCU_GPI_cmp();
void RCU_GPI_less();
CPPUNIT_TEST(HP_cmpmix)
CPPUNIT_TEST(HP_ic)
- CPPUNIT_TEST(PTB_cmp)
- CPPUNIT_TEST(PTB_less)
- CPPUNIT_TEST(PTB_cmpmix)
- CPPUNIT_TEST(PTB_ic)
+ CPPUNIT_TEST(DHP_cmp)
+ CPPUNIT_TEST(DHP_less)
+ CPPUNIT_TEST(DHP_cmpmix)
+ CPPUNIT_TEST(DHP_ic)
CPPUNIT_TEST(RCU_GPI_cmp)
CPPUNIT_TEST(RCU_GPI_less)
namespace ordlist {
namespace {
- struct PTB_cmp_traits: public cc::michael_list::type_traits
+ struct DHP_cmp_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
}
- void MichaelListTestHeader::PTB_cmp()
+ void MichaelListTestHeader::DHP_cmp()
{
// traits-based version
- typedef cc::MichaelList< cds::gc::PTB, item, PTB_cmp_traits > list;
+ typedef cc::MichaelList< cds::gc::DHP, item, DHP_cmp_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelList< cds::gc::PTB, item,
+ typedef cc::MichaelList< cds::gc::DHP, item,
cc::michael_list::make_traits<
cc::opt::compare< cmp<item> >
>::type
}
namespace {
- struct PTB_less_traits: public cc::michael_list::type_traits
+ struct DHP_less_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
- void MichaelListTestHeader::PTB_less()
+ void MichaelListTestHeader::DHP_less()
{
// traits-based version
- typedef cc::MichaelList< cds::gc::PTB, item, PTB_less_traits > list;
+ typedef cc::MichaelList< cds::gc::DHP, item, DHP_less_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelList< cds::gc::PTB, item,
+ typedef cc::MichaelList< cds::gc::DHP, item,
cc::michael_list::make_traits<
cc::opt::less< lt<item> >
>::type
}
namespace {
- struct PTB_cmpmix_traits: public cc::michael_list::type_traits
+ struct DHP_cmpmix_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
- void MichaelListTestHeader::PTB_cmpmix()
+ void MichaelListTestHeader::DHP_cmpmix()
{
// traits-based version
- typedef cc::MichaelList< cds::gc::PTB, item, PTB_cmpmix_traits > list;
+ typedef cc::MichaelList< cds::gc::DHP, item, DHP_cmpmix_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelList< cds::gc::PTB, item,
+ typedef cc::MichaelList< cds::gc::DHP, item,
cc::michael_list::make_traits<
cc::opt::compare< cmp<item> >
,cc::opt::less< lt<item> >
}
namespace {
- struct PTB_ic_traits: public cc::michael_list::type_traits
+ struct DHP_ic_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
};
}
- void MichaelListTestHeader::PTB_ic()
+ void MichaelListTestHeader::DHP_ic()
{
// traits-based version
- typedef cc::MichaelList< cds::gc::PTB, item, PTB_ic_traits > list;
+ typedef cc::MichaelList< cds::gc::DHP, item, DHP_ic_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelList< cds::gc::PTB, item,
+ typedef cc::MichaelList< cds::gc::DHP, item,
cc::michael_list::make_traits<
cc::opt::less< lt<item> >
,cc::opt::item_counter< cds::atomicity::item_counter >
namespace ordlist {
namespace {
- struct HP_cmp_traits: public cc::michael_list::type_traits
+ struct HP_cmp_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
}
namespace {
- struct HP_less_traits: public cc::michael_list::type_traits
+ struct HP_less_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
namespace {
- struct HP_cmpmix_traits: public cc::michael_list::type_traits
+ struct HP_cmpmix_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
}
namespace {
- struct HP_ic_traits: public cc::michael_list::type_traits
+ struct HP_ic_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
void HP_cmpmix();
void HP_ic();
- void PTB_cmp();
- void PTB_less();
- void PTB_cmpmix();
- void PTB_ic();
+ void DHP_cmp();
+ void DHP_less();
+ void DHP_cmpmix();
+ void DHP_ic();
void RCU_GPI_cmp();
void RCU_GPI_less();
CPPUNIT_TEST(HP_cmpmix)
CPPUNIT_TEST(HP_ic)
- CPPUNIT_TEST(PTB_cmp)
- CPPUNIT_TEST(PTB_less)
- CPPUNIT_TEST(PTB_cmpmix)
- CPPUNIT_TEST(PTB_ic)
+ CPPUNIT_TEST(DHP_cmp)
+ CPPUNIT_TEST(DHP_less)
+ CPPUNIT_TEST(DHP_cmpmix)
+ CPPUNIT_TEST(DHP_ic)
CPPUNIT_TEST(RCU_GPI_cmp)
CPPUNIT_TEST(RCU_GPI_less)
namespace ordlist {
namespace {
- struct PTB_cmp_traits: public cc::michael_list::type_traits
+ struct DHP_cmp_traits: public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::cmp<MichaelKVListTestHeader::key_type> compare;
};
}
- void MichaelKVListTestHeader::PTB_cmp()
+ void MichaelKVListTestHeader::DHP_cmp()
{
// traits-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type, PTB_cmp_traits > list;
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type, DHP_cmp_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type,
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type,
cc::michael_list::make_traits<
cc::opt::compare< cmp<key_type> >
>::type
}
namespace {
- struct PTB_less_traits: public cc::michael_list::type_traits
+ struct DHP_less_traits: public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
};
}
- void MichaelKVListTestHeader::PTB_less()
+ void MichaelKVListTestHeader::DHP_less()
{
// traits-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type, PTB_less_traits > list;
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type, DHP_less_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type,
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type,
cc::michael_list::make_traits<
cc::opt::less< lt<key_type> >
>::type
}
namespace {
- struct PTB_cmpmix_traits: public cc::michael_list::type_traits
+ struct DHP_cmpmix_traits: public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::cmp<MichaelKVListTestHeader::key_type> compare;
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
};
}
- void MichaelKVListTestHeader::PTB_cmpmix()
+ void MichaelKVListTestHeader::DHP_cmpmix()
{
// traits-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type, PTB_cmpmix_traits > list;
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type, DHP_cmpmix_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type,
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type,
cc::michael_list::make_traits<
cc::opt::compare< cmp<key_type> >
,cc::opt::less< lt<key_type> >
}
namespace {
- struct PTB_ic_traits: public cc::michael_list::type_traits
+ struct DHP_ic_traits: public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
typedef cds::atomicity::item_counter item_counter;
};
}
- void MichaelKVListTestHeader::PTB_ic()
+ void MichaelKVListTestHeader::DHP_ic()
{
// traits-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type, PTB_ic_traits > list;
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type, DHP_ic_traits > list;
test< list >();
// option-based version
- typedef cc::MichaelKVList< cds::gc::PTB, key_type, value_type,
+ typedef cc::MichaelKVList< cds::gc::DHP, key_type, value_type,
cc::michael_list::make_traits<
cc::opt::less< lt<key_type> >
,cc::opt::item_counter< cds::atomicity::item_counter >
namespace ordlist {
namespace {
- struct HP_cmp_traits: public cc::michael_list::type_traits
+ struct HP_cmp_traits: public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::cmp<MichaelKVListTestHeader::key_type> compare;
};
}
namespace {
- struct HP_less_traits: public cc::michael_list::type_traits
+ struct HP_less_traits : public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
};
}
namespace {
- struct HP_cmpmix_traits: public cc::michael_list::type_traits
+ struct HP_cmpmix_traits : public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::cmp<MichaelKVListTestHeader::key_type> compare;
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
}
namespace {
- struct HP_ic_traits: public cc::michael_list::type_traits
+ struct HP_ic_traits : public cc::michael_list::traits
{
typedef MichaelKVListTestHeader::lt<MichaelKVListTestHeader::key_type> less;
typedef cds::atomicity::item_counter item_counter;
namespace {
typedef cds::urcu::gc< cds::urcu::general_buffered<> > rcu_type;
- struct RCU_GPB_cmp_traits: public cc::michael_list::type_traits
+ struct RCU_GPB_cmp_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
}
namespace {
- struct RCU_GPB_less_traits: public cc::michael_list::type_traits
+ struct RCU_GPB_less_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
namespace {
- struct RCU_GPB_cmpmix_traits: public cc::michael_list::type_traits
+ struct RCU_GPB_cmpmix_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
}
namespace {
- struct RCU_GPB_ic_traits: public cc::michael_list::type_traits
+ struct RCU_GPB_ic_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
namespace {
typedef cds::urcu::gc< cds::urcu::general_instant<> > rcu_type;
- struct RCU_GPI_cmp_traits: public cc::michael_list::type_traits
+ struct RCU_GPI_cmp_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
}
namespace {
- struct RCU_GPI_less_traits: public cc::michael_list::type_traits
+ struct RCU_GPI_less_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
namespace {
- struct RCU_GPI_cmpmix_traits: public cc::michael_list::type_traits
+ struct RCU_GPI_cmpmix_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
}
namespace {
- struct RCU_GPI_ic_traits: public cc::michael_list::type_traits
+ struct RCU_GPI_ic_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
namespace {
typedef cds::urcu::gc< cds::urcu::general_threaded<> > rcu_type;
- struct RCU_GPT_cmp_traits: public cc::michael_list::type_traits
+ struct RCU_GPT_cmp_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
}
namespace {
- struct RCU_GPT_less_traits: public cc::michael_list::type_traits
+ struct RCU_GPT_less_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
}
namespace {
- struct RCU_GPT_cmpmix_traits: public cc::michael_list::type_traits
+ struct RCU_GPT_cmpmix_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
}
namespace {
- struct RCU_GPT_ic_traits: public cc::michael_list::type_traits
+ struct RCU_GPT_ic_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
namespace {
typedef cds::urcu::gc< cds::urcu::signal_buffered<> > rcu_type;
- struct RCU_SHB_cmp_traits: public cc::michael_list::type_traits
+ struct RCU_SHB_cmp_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHB_less_traits: public cc::michael_list::type_traits
+ struct RCU_SHB_less_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHB_cmpmix_traits: public cc::michael_list::type_traits
+ struct RCU_SHB_cmpmix_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHB_ic_traits: public cc::michael_list::type_traits
+ struct RCU_SHB_ic_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
namespace {
typedef cds::urcu::gc< cds::urcu::signal_threaded<> > rcu_type;
- struct RCU_SHT_cmp_traits: public cc::michael_list::type_traits
+ struct RCU_SHT_cmp_traits : public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
};
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHT_less_traits: public cc::michael_list::type_traits
+ struct RCU_SHT_less_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
};
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHT_cmpmix_traits: public cc::michael_list::type_traits
+ struct RCU_SHT_cmpmix_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::cmp<MichaelListTestHeader::item> compare;
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
#ifdef CDS_URCU_SIGNAL_HANDLING_ENABLED
namespace {
- struct RCU_SHT_ic_traits: public cc::michael_list::type_traits
+ struct RCU_SHT_ic_traits: public cc::michael_list::traits
{
typedef MichaelListTestHeader::lt<MichaelListTestHeader::item> less;
typedef cds::atomicity::item_counter item_counter;
projects / libcds.git / commitdiff