--- /dev/null
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
+
+ Source code repo: http://github.com/khizmax/libcds/
+ Download: http://sourceforge.net/projects/libcds/files/
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef CDSLIB_CONTAINER_IMPL_MICHAEL_KVLIST_H
+#define CDSLIB_CONTAINER_IMPL_MICHAEL_KVLIST_H
+
+#include <memory>
+#include <cds/container/details/guarded_ptr_cast.h>
+
+namespace cds { namespace container {
+
+ /// Michael's ordered list for key-value pair
+ /** @ingroup cds_nonintrusive_list
+ \anchor cds_nonintrusive_MichaelKVList_gc
+
+ This is key-value variation of non-intrusive MichaelList.
+ Like standard container, this implementation split a value stored into two part -
+ 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> 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 \p michael_list::traits
+
+ It is possible to declare option-based list with \p cds::container::michael_list::make_traits metafunction instead 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
+ struct my_compare {
+ int operator ()( int i1, int i2 )
+ {
+ return i1 - i2;
+ }
+ };
+
+ // Declare traits
+ struct my_traits: public cds::container::michael_list::traits
+ {
+ typedef my_compare compare;
+ };
+
+ // Declare traits-based list
+ 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>
+
+ // my_compare is the same
+
+ // Declare option-based list
+ typedef cds::container::MichaelKVList< cds::gc::HP, int, int,
+ typename cds::container::michael_list::make_traits<
+ cds::container::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.
+ You should include appropriate .h-file depending on GC you are using:
+ - for gc::HP: \code #include <cds/container/michael_kvlist_hp.h> \endcode
+ - for gc::DHP: \code #include <cds/container/michael_kvlist_dhp.h> \endcode
+ - for \ref cds_urcu_desc "RCU": \code #include <cds/container/michael_kvlist_rcu.h> \endcode
+ - for gc::nogc: \code #include <cds/container/michael_kvlist_nogc.h> \endcode
+ */
+ template <
+ typename GC,
+ typename Key,
+ typename Value,
+#ifdef CDS_DOXYGEN_INVOKED
+ typename Traits = michael_list::traits
+#else
+ typename Traits
+#endif
+ >
+ class MichaelKVList:
+#ifdef CDS_DOXYGEN_INVOKED
+ protected intrusive::MichaelList< GC, implementation_defined, Traits >
+#else
+ protected details::make_michael_kvlist< GC, Key, Value, Traits >::type
+#endif
+ {
+ //@cond
+ typedef details::make_michael_kvlist< GC, Key, Value, Traits > maker;
+ typedef typename maker::type base_class;
+ //@endcond
+
+ public:
+#ifdef CDS_DOXYGEN_INVOKED
+ typedef Key key_type ; ///< Key type
+ 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 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 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::stat stat; ///< Internal statistics
+
+ static constexpr const size_t c_nHazardPtrCount = base_class::c_nHazardPtrCount; ///< Count of hazard pointer required for the algorithm
+
+ //@cond
+ // Rebind traits (split-list support)
+ template <typename... Options>
+ struct rebind_traits {
+ typedef MichaelKVList<
+ gc
+ , key_type, mapped_type
+ , typename cds::opt::make_options< traits, Options...>::type
+ > type;
+ };
+
+ // Stat selector
+ template <typename Stat>
+ using select_stat_wrapper = typename base_class::template select_stat_wrapper< Stat >;
+ //@endcond
+
+ protected:
+ //@cond
+ 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:
+ /// Guarded pointer
+ typedef typename gc::template guarded_ptr< node_type, value_type, details::guarded_ptr_cast_map<node_type, value_type> > guarded_ptr;
+
+ protected:
+ //@cond
+ template <typename K>
+ static node_type * alloc_node(const K& key)
+ {
+ return cxx_allocator().New( key );
+ }
+
+ template <typename K, typename V>
+ static node_type * alloc_node( const K& key, const V& val )
+ {
+ return cxx_allocator().New( key, val );
+ }
+
+ template <typename K, typename... Args>
+ static node_type * alloc_node( K&& key, Args&&... args )
+ {
+ return cxx_allocator().MoveNew( std::forward<K>(key), std::forward<Args>(args)...);
+ }
+
+ static void free_node( node_type * pNode )
+ {
+ cxx_allocator().Delete( pNode );
+ }
+
+ struct node_disposer {
+ void operator()( node_type * pNode )
+ {
+ free_node( pNode );
+ }
+ };
+ typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
+
+ head_type& head()
+ {
+ return base_class::m_pHead;
+ }
+
+ head_type const& head() const
+ {
+ return base_class::m_pHead;
+ }
+ //@endcond
+
+ protected:
+ //@cond
+ template <bool IsConst>
+ class iterator_type: protected base_class::template iterator_type<IsConst>
+ {
+ typedef typename base_class::template iterator_type<IsConst> iterator_base;
+
+ iterator_type( head_type const& pNode )
+ : iterator_base( pNode )
+ {}
+
+ friend class MichaelKVList;
+
+ public:
+ typedef typename cds::details::make_const_type<mapped_type, IsConst>::reference value_ref;
+ typedef typename cds::details::make_const_type<mapped_type, IsConst>::pointer value_ptr;
+
+ typedef typename cds::details::make_const_type<value_type, IsConst>::reference pair_ref;
+ typedef typename cds::details::make_const_type<value_type, IsConst>::pointer pair_ptr;
+
+ iterator_type()
+ {}
+
+ iterator_type( iterator_type const& src )
+ : iterator_base( src )
+ {}
+
+ key_type const& key() const
+ {
+ typename iterator_base::value_ptr p = iterator_base::operator ->();
+ assert( p != nullptr );
+ return p->m_Data.first;
+ }
+
+ pair_ptr operator ->() const
+ {
+ typename iterator_base::value_ptr p = iterator_base::operator ->();
+ return p ? &(p->m_Data) : nullptr;
+ }
+
+ pair_ref operator *() const
+ {
+ typename iterator_base::value_ref p = iterator_base::operator *();
+ return p.m_Data;
+ }
+
+ value_ref val() const
+ {
+ typename iterator_base::value_ptr p = iterator_base::operator ->();
+ assert( p != nullptr );
+ return p->m_Data.second;
+ }
+
+ /// Pre-increment
+ iterator_type& operator ++()
+ {
+ iterator_base::operator ++();
+ return *this;
+ }
+
+ template <bool C>
+ bool operator ==(iterator_type<C> const& i ) const
+ {
+ return iterator_base::operator ==(i);
+ }
+ template <bool C>
+ bool operator !=(iterator_type<C> const& i ) const
+ {
+ return iterator_base::operator !=(i);
+ }
+ };
+ //@endcond
+
+ public:
+ /// Forward iterator
+ /**
+ 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 (\p gc::HP), 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.
+
+ @warning Use this iterator on the concurrent container for debugging purpose only.
+
+ The iterator interface to access item data:
+ - <tt> operator -> </tt> - returns a pointer to \ref value_type for iterator
+ - <tt> operator *</tt> - returns a reference (a const reference for \p const_iterator) to \ref value_type for iterator
+ - <tt> const key_type& key() </tt> - returns a key reference for iterator
+ - <tt> mapped_type& val() </tt> - retuns a value reference for iterator (const reference for \p const_iterator)
+
+ For both functions the iterator should not be equal to <tt> end() </tt>
+ */
+ typedef iterator_type<false> iterator;
+
+ /// Const forward iterator
+ /**
+ For iterator's features and requirements see \ref iterator
+ */
+ typedef iterator_type<true> const_iterator;
+
+ ///@name Forward iterators (only for debugging purpose)
+ //@{
+ /// Returns a forward iterator addressing the first element in a list
+ /**
+ For empty list \code begin() == end() \endcode
+ */
+ iterator begin()
+ {
+ return iterator( head());
+ }
+
+ /// Returns an iterator that addresses the location succeeding the last element in a list
+ /**
+ Do not use the value returned by <tt>end</tt> function to access any item.
+ Internally, <tt>end</tt> returning value equals to \p nullptr.
+
+ The returned value can be used only to control reaching the end of the list.
+ For empty list \code begin() == end() \endcode
+ */
+ iterator end()
+ {
+ return iterator();
+ }
+
+ /// Returns a forward const iterator addressing the first element in a list
+ const_iterator begin() const
+ {
+ return const_iterator( head());
+ }
+
+ /// Returns a forward const iterator addressing the first element in a list
+ const_iterator cbegin() const
+ {
+ return const_iterator( head());
+ }
+
+ /// Returns an const iterator that addresses the location succeeding the last element in a list
+ const_iterator end() const
+ {
+ return const_iterator();
+ }
+
+ /// Returns an const iterator that addresses the location succeeding the last element in a list
+ const_iterator cend() const
+ {
+ return const_iterator();
+ }
+ //@}
+
+ public:
+ /// Default constructor
+ /**
+ Initializes empty list
+ */
+ MichaelKVList()
+ {}
+
+ //@cond
+ template <typename Stat, typename = std::enable_if<std::is_same<stat, michael_list::wrapped_stat<Stat>>::value >>
+ explicit MichaelKVList( Stat& st )
+ : base_class( st )
+ {}
+ //@endcond
+
+ /// List destructor
+ /**
+ Clears the list
+ */
+ ~MichaelKVList()
+ {
+ clear();
+ }
+
+ /// Inserts new node with key and default value
+ /**
+ The function creates a node with \p key and default value, and then inserts the node created into the list.
+
+ Preconditions:
+ - 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.
+ */
+ template <typename K>
+ bool insert( K&& key )
+ {
+ return insert_at( head(), std::forward<K>( key ));
+ }
+
+ /// Inserts new node with a key and a value
+ /**
+ The function creates a node with \p key and value \p val, and then inserts the node created into the list.
+
+ Preconditions:
+ - 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.
+ */
+ template <typename K, typename V>
+ bool insert( K&& key, V&& val )
+ {
+ // We cannot use insert with functor here
+ // because we cannot lock inserted node for updating
+ // Therefore, we use separate function
+ return insert_at( head(), std::forward<K>( key ), std::forward<V>( val ));
+ }
+
+ /// Inserts new node and initialize it by a functor
+ /**
+ This function inserts new node with key \p key and if inserting is successful then it calls
+ \p func functor with signature
+ \code
+ struct functor {
+ void operator()( value_type& item );
+ };
+ \endcode
+
+ The argument \p item of user-defined functor \p func is the reference
+ 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 is called only if inserting is successful.
+
+ 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 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
+ it is preferable that the initialization should be completed only if inserting is successful.
+
+ @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
+ */
+ template <typename K, typename Func>
+ bool insert_with( K&& key, Func func )
+ {
+ return insert_with_at( head(), std::forward<K>( key ), func );
+ }
+
+ /// Updates data by \p key
+ /**
+ The operation performs inserting or replacing the element with lock-free manner.
+
+ If the \p key not found in the list, then the new item created from \p key
+ will be inserted iff \p bAllowInsert is \p true.
+ (note that in this case the \ref key_type should be constructible from type \p K).
+ Otherwise, if \p key is found, the functor \p func is called with item found.
+
+ The functor \p Func signature is:
+ \code
+ struct my_functor {
+ void operator()( bool bNew, value_type& item );
+ };
+ \endcode
+ with arguments:
+ - \p bNew - \p true if the item has been inserted, \p false otherwise
+ - \p item - the item found or inserted
+
+ 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.
+
+ Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successful,
+ \p second is true if new item has been added or \p false if the item with \p key
+ already exists.
+
+ @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
+ */
+ template <typename K, typename Func>
+ std::pair<bool, bool> update( K&& key, Func f, bool bAllowInsert = true )
+ {
+ return update_at( head(), std::forward<K>( key ), f, bAllowInsert );
+ }
+ //@cond
+ template <typename K, typename Func>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
+ std::pair<bool, bool> ensure( K const& key, Func f )
+ {
+ return update( key, f, true );
+ }
+ //@endcond
+
+ /// 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>
+ bool emplace( K&& key, Args&&... args )
+ {
+ return emplace_at( head(), std::forward<K>(key), std::forward<Args>(args)... );
+ }
+
+ /// Deletes \p key from the list
+ /** \anchor cds_nonintrusive_MichaelKVList_hp_erase_val
+
+ Returns \p true if \p key is found and has been deleted, \p false otherwise
+ */
+ template <typename K>
+ bool erase( K const& key )
+ {
+ return erase_at( head(), key, intrusive_key_comparator());
+ }
+
+ /// Deletes the item from the list using \p pred predicate for searching
+ /**
+ The function is an analog of \ref cds_nonintrusive_MichaelKVList_hp_erase_val "erase(K const&)"
+ 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 K, typename Less>
+ bool erase_with( K const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type());
+ }
+
+ /// Deletes \p key from the list
+ /** \anchor cds_nonintrusive_MichaelKVList_hp_erase_func
+ The function searches an item with key \p key, calls \p f functor
+ and deletes the item. If \p key is not found, the functor is not called.
+
+ The functor \p Func interface:
+ \code
+ struct extractor {
+ void operator()(value_type& val) { ... }
+ };
+ \endcode
+
+ Return \p true if key is found and deleted, \p false otherwise
+
+ See also: \ref erase
+ */
+ template <typename K, typename Func>
+ bool erase( K const& key, Func f )
+ {
+ return erase_at( head(), key, intrusive_key_comparator(), f );
+ }
+
+ /// Deletes the item from the list using \p pred predicate for searching
+ /**
+ The function is an analog of \ref cds_nonintrusive_MichaelKVList_hp_erase_func "erase(K 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 K, typename Less, typename Func>
+ bool erase_with( K const& key, Less pred, Func f )
+ {
+ CDS_UNUSED( pred );
+ return erase_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
+ }
+
+ /// Extracts the item from the list with specified \p key
+ /** \anchor cds_nonintrusive_MichaelKVList_hp_extract
+ The function searches an item with key equal to \p key,
+ unlinks it from the list, and returns it as \p guarded_ptr.
+ If \p key is not found the function returns an empty guarded pointer.
+
+ Note the compare functor should accept a parameter of type \p K that can be not the same as \p key_type.
+
+ The \p disposer specified in \p Traits class template parameter is called automatically
+ by garbage collector \p GC specified in class' template parameters when returned \p guarded_ptr object
+ will be destroyed or released.
+ @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
+
+ Usage:
+ \code
+ typedef cds::container::MichaelKVList< cds::gc::HP, int, foo, my_traits > ord_list;
+ ord_list theList;
+ // ...
+ {
+ ord_list::guarded_ptr gp(theList.extract( 5 ));
+ if ( gp ) {
+ // Deal with gp
+ // ...
+ }
+ // Destructor of gp releases internal HP guard
+ }
+ \endcode
+ */
+ template <typename K>
+ guarded_ptr extract( K const& key )
+ {
+ return extract_at( head(), key, intrusive_key_comparator());
+ }
+
+ /// Extracts the item from the list with comparing functor \p pred
+ /**
+ The function is an analog of \ref cds_nonintrusive_MichaelKVList_hp_extract "extract(K 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 key_type and \p K
+ in any order.
+ \p pred must imply the same element order as the comparator used for building the list.
+ */
+ template <typename K, typename Less>
+ guarded_ptr extract_with( K const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return extract_at( head(), key, typename maker::template less_wrapper<Less>::type());
+ }
+
+ /// Checks whether the list contains \p key
+ /**
+ 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 contains( Q const& key )
+ {
+ return find_at( head(), key, intrusive_key_comparator());
+ }
+ //@cond
+ template <typename Q>
+ CDS_DEPRECATED("deprecated, use contains()")
+ bool find( Q const& key )
+ {
+ return contains( key );
+ }
+ //@endcond
+
+ /// Checks whether the map contains \p key using \p pred predicate for searching
+ /**
+ The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
+ \p Less functor has the interface like \p std::less.
+ \p Less must imply the same element order as the comparator used for building the list.
+ */
+ template <typename Q, typename Less>
+ bool contains( Q const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type());
+ }
+ //@cond
+ template <typename Q, typename Less>
+ CDS_DEPRECATED("deprecated, use contains()")
+ bool find_with( Q const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return contains( key, pred );
+ }
+ //@endcond
+
+ /// Finds the key \p key and performs an action with it
+ /** \anchor cds_nonintrusive_MichaelKVList_hp_find_func
+ 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 );
+ };
+ \endcode
+ where \p item is the item found.
+
+ The functor may change <tt>item.second</tt> that is reference to value of node.
+ 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 key is found, \p false otherwise.
+ */
+ template <typename Q, typename Func>
+ bool find( Q const& key, Func f )
+ {
+ return find_at( head(), key, intrusive_key_comparator(), f );
+ }
+
+ /// Finds the key \p val using \p pred predicate for searching
+ /**
+ The function is an analog of \ref cds_nonintrusive_MichaelKVList_hp_find_func "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& key, Less pred, Func f )
+ {
+ CDS_UNUSED( pred );
+ return find_at( head(), key, typename maker::template less_wrapper<Less>::type(), f );
+ }
+
+ /// Finds the \p key and return the item found
+ /** \anchor cds_nonintrusive_MichaelKVList_hp_get
+ The function searches the item with key equal to \p key
+ and returns it as \p guarded_ptr.
+ If \p key is not found the function returns an empty guarded pointer.
+
+ @note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
+
+ Usage:
+ \code
+ typedef cds::container::MichaelKVList< cds::gc::HP, int, foo, my_traits > ord_list;
+ ord_list theList;
+ // ...
+ {
+ ord_list::guarded_ptr gp(theList.get( 5 ));
+ if ( gp ) {
+ // Deal with gp
+ //...
+ }
+ // Destructor of guarded_ptr releases internal HP guard
+ }
+ \endcode
+
+ Note the compare functor specified for class \p Traits template parameter
+ should accept a parameter of type \p K that can be not the same as \p key_type.
+ */
+ template <typename K>
+ guarded_ptr get( K const& key )
+ {
+ return get_at( head(), key, intrusive_key_comparator());
+ }
+
+ /// Finds the \p key and return the item found
+ /**
+ The function is an analog of \ref cds_nonintrusive_MichaelKVList_hp_get "get( guarded_ptr& ptr, K 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 key_type and \p K
+ in any order.
+ \p pred must imply the same element order as the comparator used for building the list.
+ */
+ template <typename K, typename Less>
+ guarded_ptr get_with( K const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return get_at( head(), key, typename maker::template less_wrapper<Less>::type());
+ }
+
+ /// Checks if the list is empty
+ bool empty() const
+ {
+ return base_class::empty();
+ }
+
+ /// Returns list's item count
+ /**
+ The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
+ this function always returns 0.
+
+ @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
+ {
+ return base_class::size();
+ }
+
+ /// Clears the list
+ void clear()
+ {
+ base_class::clear();
+ }
+
+ /// Returns const reference to internal statistics
+ stat const& statistics() const
+ {
+ return base_class::statistics();
+ }
+
+ protected:
+ //@cond
+ bool insert_node_at( head_type& refHead, node_type * pNode )
+ {
+ assert( pNode != nullptr );
+ scoped_node_ptr p( pNode );
+ if ( base_class::insert_at( refHead, *pNode )) {
+ p.release();
+ return true;
+ }
+ return false;
+ }
+
+ template <typename K>
+ bool insert_at( head_type& refHead, K&& key )
+ {
+ return insert_node_at( refHead, alloc_node( std::forward<K>( key )));
+ }
+
+ template <typename K, typename V>
+ bool insert_at( head_type& refHead, K&& key, V&& val )
+ {
+ return insert_node_at( refHead, alloc_node( std::forward<K>( key ), std::forward<V>( val )));
+ }
+
+ template <typename K, typename Func>
+ bool insert_with_at( head_type& refHead, K&& key, Func f )
+ {
+ scoped_node_ptr pNode( alloc_node( std::forward<K>( key )));
+
+ if ( base_class::insert_at( refHead, *pNode, [&f](node_type& node){ f( node.m_Data ); })) {
+ pNode.release();
+ return true;
+ }
+ return false;
+ }
+
+ template <typename K, typename... Args>
+ bool emplace_at( head_type& refHead, K&& key, Args&&... args )
+ {
+ return insert_node_at( refHead, alloc_node( std::forward<K>(key), std::forward<Args>(args)... ));
+ }
+
+ template <typename K, typename Func>
+ std::pair<bool, bool> update_at( head_type& refHead, K&& key, Func f, bool bAllowInsert )
+ {
+ scoped_node_ptr pNode( alloc_node( std::forward<K>( key )));
+
+ std::pair<bool, bool> ret = base_class::update_at( refHead, *pNode,
+ [&f]( bool bNew, node_type& node, node_type& ){ f( bNew, node.m_Data ); },
+ bAllowInsert );
+ if ( ret.first && ret.second )
+ pNode.release();
+
+ return ret;
+ }
+
+ template <typename K, typename Compare>
+ bool erase_at( head_type& refHead, K const& key, Compare cmp )
+ {
+ return base_class::erase_at( refHead, key, cmp );
+ }
+
+ template <typename K, typename Compare, typename Func>
+ bool erase_at( head_type& refHead, K const& key, Compare cmp, Func f )
+ {
+ return base_class::erase_at( refHead, key, cmp, [&f]( node_type const & node ){ f( const_cast<value_type&>(node.m_Data)); });
+ }
+ template <typename K, typename Compare>
+ guarded_ptr extract_at( head_type& refHead, K const& key, Compare cmp )
+ {
+ return base_class::extract_at( refHead, key, cmp );
+ }
+
+ template <typename K, typename Compare>
+ bool find_at( head_type& refHead, K const& key, Compare cmp )
+ {
+ return base_class::find_at( refHead, key, cmp );
+ }
+
+ template <typename K, typename Compare, typename Func>
+ bool find_at( head_type& refHead, K& key, Compare cmp, Func f )
+ {
+ return base_class::find_at( refHead, key, cmp, [&f](node_type& node, K const&){ f( node.m_Data ); });
+ }
+
+ template <typename K, typename Compare>
+ guarded_ptr get_at( head_type& refHead, K const& key, Compare cmp )
+ {
+ return base_class::get_at( refHead, key, cmp );
+ }
+
+ //@endcond
+ };
+
+}} // namespace cds::container
+
+#endif // #ifndef CDSLIB_CONTAINER_IMPL_MICHAEL_KVLIST_H
projects / c11concurrency-benchmarks.git / blobdiff