2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
6 Source code repo: http://github.com/khizmax/libcds/
7 Download: http://sourceforge.net/projects/libcds/files/
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 this list of conditions and the following disclaimer in the documentation
17 and/or other materials provided with the distribution.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef CDSLIB_CONTAINER_MICHAEL_KVLIST_NOGC_H
32 #define CDSLIB_CONTAINER_MICHAEL_KVLIST_NOGC_H
35 #include <cds/container/details/michael_list_base.h>
36 #include <cds/intrusive/michael_list_nogc.h>
37 #include <cds/container/details/make_michael_kvlist.h>
39 namespace cds { namespace container {
44 template <typename K, typename T, class Traits>
45 struct make_michael_kvlist_nogc: public make_michael_kvlist<gc::nogc, K, T, Traits>
47 typedef make_michael_kvlist<cds::gc::nogc, K, T, Traits> base_maker;
48 typedef typename base_maker::node_type node_type;
50 struct intrusive_traits: public base_maker::intrusive_traits
52 typedef typename base_maker::node_deallocator disposer;
55 typedef intrusive::MichaelList<cds::gc::nogc, node_type, intrusive_traits> type;
58 } // namespace details
61 /// Michael's ordered list (key-value pair, template specialization for gc::nogc)
62 /** @ingroup cds_nonintrusive_list
63 @anchor cds_nonintrusive_MichaelKVList_nogc
65 This specialization is intended for so-called persistent usage when no item
66 reclamation may be performed. The class does not support deleting of list item.
68 Usually, ordered single-linked list is used as a building block for the hash table implementation.
69 The complexity of searching is <tt>O(N)</tt>.
71 See \ref cds_nonintrusive_MichaelList_gc "MichaelList" for description of template parameters.
73 The interface of the specialization is a little different.
78 #ifdef CDS_DOXYGEN_INVOKED
79 typename Traits = michael_list::traits
84 class MichaelKVList<gc::nogc, Key, Value, Traits>:
85 #ifdef CDS_DOXYGEN_INVOKED
86 protected intrusive::MichaelList< gc::nogc, implementation_defined, Traits >
88 protected details::make_michael_kvlist_nogc< Key, Value, Traits >::type
92 typedef details::make_michael_kvlist_nogc< Key, Value, Traits > maker;
93 typedef typename maker::type base_class;
97 typedef cds::gc::nogc gc; ///< Garbage collector used
98 typedef Traits traits; ///< List traits
100 #ifdef CDS_DOXYGEN_INVOKED
101 typedef Key key_type ; ///< Key type
102 typedef Value mapped_type ; ///< Type of value stored in the list
103 typedef std::pair<key_type const, mapped_type> value_type ; ///< key/value pair stored in the list
105 typedef typename maker::key_type key_type;
106 typedef typename maker::value_type mapped_type;
107 typedef typename maker::pair_type value_type;
110 typedef typename base_class::back_off back_off; ///< Back-off strategy used
111 typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
112 typedef typename base_class::item_counter item_counter; ///< Item counting policy used
113 typedef typename maker::key_comparator key_comparator; ///< key comparison functor
114 typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
118 typedef typename base_class::value_type node_type;
119 typedef typename maker::cxx_allocator cxx_allocator;
120 typedef typename maker::node_deallocator node_deallocator;
121 typedef typename maker::intrusive_traits::compare intrusive_key_comparator;
123 typedef typename base_class::atomic_node_ptr head_type;
128 template <typename K>
129 static node_type * alloc_node(const K& key)
131 return cxx_allocator().New( key );
134 template <typename K, typename V>
135 static node_type * alloc_node( const K& key, const V& val )
137 return cxx_allocator().New( key, val );
140 template <typename K, typename... Args>
141 static node_type * alloc_node( K&& key, Args&&... args )
143 return cxx_allocator().MoveNew( std::forward<K>(key), std::forward<Args>(args)... );
146 static void free_node( node_type * pNode )
148 cxx_allocator().Delete( pNode );
151 struct node_disposer {
152 void operator()( node_type * pNode )
157 typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
161 return base_class::m_pHead;
164 head_type const& head() const
166 return base_class::m_pHead;
172 template <bool IsConst>
173 class iterator_type: protected base_class::template iterator_type<IsConst>
175 typedef typename base_class::template iterator_type<IsConst> iterator_base;
177 iterator_type( head_type const& refNode )
178 : iterator_base( refNode )
181 explicit iterator_type( const iterator_base& it )
182 : iterator_base( it )
185 friend class MichaelKVList;
188 explicit iterator_type( node_type& pNode )
189 : iterator_base( &pNode )
193 typedef typename cds::details::make_const_type<mapped_type, IsConst>::reference value_ref;
194 typedef typename cds::details::make_const_type<mapped_type, IsConst>::pointer value_ptr;
196 typedef typename cds::details::make_const_type<value_type, IsConst>::reference pair_ref;
197 typedef typename cds::details::make_const_type<value_type, IsConst>::pointer pair_ptr;
203 iterator_type( const iterator_type& src )
204 : iterator_base( src )
207 key_type const& key() const
209 typename iterator_base::value_ptr p = iterator_base::operator ->();
210 assert( p != nullptr );
211 return p->m_Data.first;
214 value_ref val() const
216 typename iterator_base::value_ptr p = iterator_base::operator ->();
217 assert( p != nullptr );
218 return p->m_Data.second;
221 pair_ptr operator ->() const
223 typename iterator_base::value_ptr p = iterator_base::operator ->();
224 return p ? &(p->m_Data) : nullptr;
227 pair_ref operator *() const
229 typename iterator_base::value_ref p = iterator_base::operator *();
234 iterator_type& operator ++()
236 iterator_base::operator ++();
241 iterator_type operator ++(int)
243 return iterator_base::operator ++(0);
247 bool operator ==(iterator_type<C> const& i ) const
249 return iterator_base::operator ==(i);
252 bool operator !=(iterator_type<C> const& i ) const
254 return iterator_base::operator !=(i);
260 ///@name Forward iterators
264 The forward iterator is safe: you may use it in multi-threaded enviromnent without any synchronization.
266 The forward iterator for Michael's list based on \p gc::nogc has pre- and post-increment operators.
268 The iterator interface to access item data:
269 - <tt> operator -> </tt> - returns a pointer to \p value_type
270 - <tt> operator *</tt> - returns a reference (a const reference for \p const_iterator) to \p value_type
271 - <tt> const key_type& key() </tt> - returns a key reference for iterator
272 - <tt> mapped_type& val() </tt> - retuns a value reference for iterator (const reference for \p const_iterator)
274 For both functions the iterator should not be equal to \p end().
276 @note \p end() iterator is not dereferenceable
278 typedef iterator_type<false> iterator;
280 /// Const forward iterator
282 For iterator's features and requirements see \ref iterator
284 typedef iterator_type<true> const_iterator;
286 /// Returns a forward iterator addressing the first element in a list
288 For empty list \code begin() == end() \endcode
292 return iterator( head() );
295 /// Returns an iterator that addresses the location succeeding the last element in a list
297 Do not use the value returned by <tt>end</tt> function to access any item.
298 Internally, <tt>end</tt> returning value equals to \p nullptr.
300 The returned value can be used only to control reaching the end of the list.
301 For empty list \code begin() == end() \endcode
308 /// Returns a forward const iterator addressing the first element in a list
309 const_iterator begin() const
311 return const_iterator( head() );
313 /// Returns a forward const iterator addressing the first element in a list
314 const_iterator cbegin() const
316 return const_iterator( head() );
319 /// Returns an const iterator that addresses the location succeeding the last element in a list
320 const_iterator end() const
322 return const_iterator();
324 /// Returns an const iterator that addresses the location succeeding the last element in a list
325 const_iterator cend() const
327 return const_iterator();
333 iterator node_to_iterator( node_type * pNode )
336 return iterator( *pNode );
342 /// Default constructor
344 Initialize empty list
358 /// Inserts new node with key and default value
360 The function creates a node with \p key and default value, and then inserts the node created into the list.
363 - The \ref key_type should be constructible from value of type \p K.
364 In trivial case, \p K is equal to \ref key_type.
365 - The \ref mapped_type should be default-constructible.
367 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
369 template <typename K>
370 iterator insert( const K& key )
372 return node_to_iterator( insert_at( head(), key ));
375 /// Inserts new node with a key and a value
377 The function creates a node with \p key and value \p val, and then inserts the node created into the list.
380 - The \ref key_type should be constructible from \p key of type \p K.
381 - The \ref mapped_type should be constructible from \p val of type \p V.
383 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
385 template <typename K, typename V>
386 iterator insert( const K& key, const V& val )
388 // We cannot use insert with functor here
389 // because we cannot lock inserted node for updating
390 // Therefore, we use separate function
391 return node_to_iterator( insert_at( head(), key, val ));
394 /// Inserts new node and initialize it by a functor
396 This function inserts new node with key \p key and if inserting is successful then it calls
397 \p func functor with signature
398 \code void func( value_type& item );
400 void operator()( value_type& item );
404 The argument \p item of user-defined functor \p func is the reference
405 to the list's item inserted. <tt>item.second</tt> is a reference to item's value that may be changed.
406 User-defined functor \p func should guarantee that during changing item's value no any other changes
407 could be made on this list's item by concurrent threads.
409 The key_type should be constructible from value of type \p K.
411 The function allows to split creating of new item into two part:
412 - create item from \p key;
413 - insert new item into the list;
414 - if inserting is successful, initialize the value of item by calling \p f functor
416 This can be useful if complete initialization of object of \p mapped_type is heavyweight and
417 it is preferable that the initialization should be completed only if inserting is successful.
419 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
421 template <typename K, typename Func>
422 iterator insert_with( const K& key, Func func )
424 return node_to_iterator( insert_with_at( head(), key, func ));
429 If \p key is not in the list and \p bAllowInsert is \p true,
431 the function inserts a new item.
432 Otherwise, the function returns an iterator pointing to the item found.
434 Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
435 item found or inserted, \p second is true if new item has been added or \p false if the item
436 already is in the list.
438 template <typename K>
439 std::pair<iterator, bool> update( K const& key, bool bAllowInsert = true )
441 std::pair< node_type *, bool > ret = update_at( head(), key, bAllowInsert );
442 return std::make_pair( node_to_iterator( ret.first ), ret.second );
445 template <typename K>
446 CDS_DEPRECATED("ensure() is deprecated, use update()")
447 std::pair<iterator, bool> ensure( K const& key )
449 return update( key );
453 /// Inserts data of type \ref mapped_type constructed with <tt>std::forward<Args>(args)...</tt>
455 Returns an iterator pointed to inserted value, or \p end() if inserting is failed
457 template <typename K, typename... Args>
458 iterator emplace( K&& key, Args&&... args )
460 return node_to_iterator( emplace_at( head(), std::forward<K>(key), std::forward<Args>(args)... ));
463 /// Checks whether the list contains \p key
465 The function searches the item with key equal to \p key
466 and returns an iterator pointed to item found and \ref end() otherwise
468 template <typename Q>
469 iterator contains( Q const& key )
471 return node_to_iterator( find_at( head(), key, intrusive_key_comparator() ) );
474 template <typename Q>
475 CDS_DEPRECATED("deprecated, use contains()")
476 iterator find( Q const& key )
478 return contains( key );
482 /// Checks whether the list contains \p key using \p pred predicate for searching
484 The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
485 \p Less functor has the interface like \p std::less.
486 \p pred must imply the same element order as the comparator used for building the list.
488 template <typename Q, typename Less>
489 iterator contains( Q const& key, Less pred )
492 return node_to_iterator( find_at( head(), key, typename maker::template less_wrapper<Less>::type() ) );
495 template <typename Q, typename Less>
496 CDS_DEPRECATED("deprecated, use contains()")
497 iterator find_with( Q const& key, Less pred )
499 return contains( key, pred );
503 /// Check if the list is empty
506 return base_class::empty();
509 /// Returns list's item count
511 The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
512 this function always returns 0.
514 @note Even if you use real item counter and it returns 0, this fact does not mean that the list
515 is empty. To check list emptyness use \p empty() method.
519 return base_class::size();
530 node_type * insert_node_at( head_type& refHead, node_type * pNode )
532 assert( pNode != nullptr );
533 scoped_node_ptr p( pNode );
534 if ( base_class::insert_at( refHead, *pNode ))
539 template <typename K>
540 node_type * insert_at( head_type& refHead, const K& key )
542 return insert_node_at( refHead, alloc_node( key ));
545 template <typename K, typename V>
546 node_type * insert_at( head_type& refHead, const K& key, const V& val )
548 return insert_node_at( refHead, alloc_node( key, val ));
551 template <typename K, typename Func>
552 node_type * insert_with_at( head_type& refHead, const K& key, Func f )
554 scoped_node_ptr pNode( alloc_node( key ));
556 if ( base_class::insert_at( refHead, *pNode )) {
558 return pNode.release();
563 template <typename K>
564 std::pair< node_type *, bool > update_at( head_type& refHead, const K& key, bool bAllowInsert )
566 scoped_node_ptr pNode( alloc_node( key ));
567 node_type * pItemFound = nullptr;
569 std::pair<bool, bool> ret = base_class::update_at( refHead, *pNode,
571 [&pItemFound](bool, node_type& item, node_type&){ pItemFound = &item; },
576 return std::make_pair( pItemFound, ret.second );
579 template <typename K, typename... Args>
580 node_type * emplace_at( head_type& refHead, K&& key, Args&&... args )
582 return insert_node_at( refHead, alloc_node( std::forward<K>(key), std::forward<Args>(args)... ));
585 template <typename K, typename Compare>
586 node_type * find_at( head_type& refHead, K const& key, Compare cmp )
588 return base_class::find_at( refHead, key, cmp );
593 }} // namespace cds::container
595 #endif // #ifndef CDSLIB_CONTAINER_MICHAEL_KVLIST_NOGC_H