2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
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_LIST_NOGC_H
32 #define CDSLIB_CONTAINER_MICHAEL_LIST_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_list.h>
39 namespace cds { namespace container {
44 template <typename T, class Traits>
45 struct make_michael_list_nogc: public make_michael_list<gc::nogc, T, Traits>
47 typedef make_michael_list<cds::gc::nogc, 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 lock-free ordered single-linked list (template specialization for \p gc::nogc)
62 /** @ingroup cds_nonintrusive_list
63 \anchor cds_nonintrusive_MichaelList_nogc
65 This specialization is intended for so-called append-only usage when no item
66 reclamation may be performed. The class does not support deleting of list item.
67 Usually, ordered single-linked list is used as a building block for the hash table implementation.
68 The complexity of searching is <tt>O(N)</tt>.
70 See \ref cds_nonintrusive_MichaelList_gc "MichaelList" for description of template parameters.
73 #ifdef CDS_DOXYGEN_INVOKED
74 class Traits = michael_list::traits
79 class MichaelList<gc::nogc, T, Traits>:
80 #ifdef CDS_DOXYGEN_INVOKED
81 protected intrusive::MichaelList< gc::nogc, T, Traits >
83 protected details::make_michael_list_nogc< T, Traits >::type
87 typedef details::make_michael_list_nogc< T, Traits > maker;
88 typedef typename maker::type base_class;
92 typedef cds::gc::nogc gc; ///< Garbage collector used
93 typedef T value_type; ///< Type of value stored in the list
94 typedef Traits traits; ///< List traits
96 typedef typename base_class::back_off back_off; ///< Back-off strategy used
97 typedef typename maker::allocator_type allocator_type; ///< Allocator type used for allocate/deallocate the nodes
98 typedef typename base_class::item_counter item_counter; ///< Item counting policy used
99 typedef typename maker::key_comparator key_comparator; ///< key comparison functor
100 typedef typename base_class::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
101 typedef typename base_class::stat stat; ///< Internal statistics
104 // Rebind traits (split-list support)
105 template <typename... Options>
106 struct rebind_traits {
110 , typename cds::opt::make_options< traits, Options...>::type
115 template <typename Stat>
116 using select_stat_wrapper = typename base_class::template select_stat_wrapper< Stat >;
121 typedef typename base_class::value_type node_type;
122 typedef typename maker::cxx_allocator cxx_allocator;
123 typedef typename maker::node_deallocator node_deallocator;
124 typedef typename maker::intrusive_traits::compare intrusive_key_comparator;
126 typedef typename base_class::atomic_node_ptr head_type;
128 struct node_disposer {
129 void operator()( node_type * pNode )
135 typedef std::unique_ptr< node_type, node_disposer > scoped_node_ptr;
140 template <bool IsConst>
141 class iterator_type: protected base_class::template iterator_type<IsConst>
143 typedef typename base_class::template iterator_type<IsConst> iterator_base;
145 iterator_type( head_type const& pNode )
146 : iterator_base( pNode )
149 explicit iterator_type( const iterator_base& it )
150 : iterator_base( it )
153 friend class MichaelList;
156 explicit iterator_type( node_type& pNode )
157 : iterator_base( &pNode )
161 typedef typename cds::details::make_const_type<value_type, IsConst>::pointer value_ptr;
162 typedef typename cds::details::make_const_type<value_type, IsConst>::reference value_ref;
167 iterator_type( const iterator_type& src )
168 : iterator_base( src )
171 value_ptr operator ->() const
173 typename iterator_base::value_ptr p = iterator_base::operator ->();
174 return p ? &(p->m_Value) : nullptr;
177 value_ref operator *() const
179 return (iterator_base::operator *()).m_Value;
183 iterator_type& operator ++()
185 iterator_base::operator ++();
190 iterator_type operator ++(int)
192 return iterator_base::operator ++(0);
196 bool operator ==(iterator_type<C> const& i ) const
198 return iterator_base::operator ==(i);
201 bool operator !=(iterator_type<C> const& i ) const
203 return iterator_base::operator !=(i);
209 ///@name Forward iterators
211 /// Returns a forward iterator addressing the first element in a list
213 For empty list \code begin() == end() \endcode
215 typedef iterator_type<false> iterator;
217 /// Const forward iterator
219 For iterator's features and requirements see \ref iterator
221 typedef iterator_type<true> const_iterator;
223 /// Returns a forward iterator addressing the first element in a list
225 For empty list \code begin() == end() \endcode
229 return iterator( head());
232 /// Returns an iterator that addresses the location succeeding the last element in a list
234 Do not use the value returned by <tt>end</tt> function to access any item.
235 Internally, <tt>end</tt> returning value equals to \p nullptr.
237 The returned value can be used only to control reaching the end of the list.
238 For empty list \code begin() == end() \endcode
245 /// Returns a forward const iterator addressing the first element in a list
246 const_iterator begin() const
248 return const_iterator( head());
251 /// Returns a forward const iterator addressing the first element in a list
252 const_iterator cbegin() const
254 return const_iterator( head());
257 /// Returns an const iterator that addresses the location succeeding the last element in a list
258 const_iterator end() const
260 return const_iterator();
263 /// Returns an const iterator that addresses the location succeeding the last element in a list
264 const_iterator cend() const
266 return const_iterator();
271 /// Default constructor
273 Initialize empty list
279 template <typename Stat, typename = std::enable_if<std::is_same<stat, michael_list::wrapped_stat<Stat>>::value >>
280 explicit MichaelList( Stat& st )
296 The function inserts \p val in the list if the list does not contain
297 an item with key equal to \p val.
299 Return an iterator pointing to inserted item if success \ref end() otherwise
301 template <typename Q>
302 iterator insert( Q&& val )
304 return node_to_iterator( insert_at( head(), std::forward<Q>( val )));
309 If \p key is not in the list and \p bAllowInsert is \p true,
310 the function inserts a new item.
311 Otherwise, the function returns an iterator pointing to the item found.
313 Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
314 item found or inserted, \p second is true if new item has been added or \p false if the item
315 already is in the list.
317 template <typename Q>
318 std::pair<iterator, bool> update( Q&& key, bool bAllowInsert = true )
320 std::pair< node_type *, bool > ret = update_at( head(), std::forward<Q>( key ), bAllowInsert );
321 return std::make_pair( node_to_iterator( ret.first ), ret.second );
324 template <typename Q>
325 CDS_DEPRECATED("ensure() is deprecated, use update()")
326 std::pair<iterator, bool> ensure( const Q& val )
328 return update( val, true );
332 /// Inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
334 Return an iterator pointing to inserted item if success \ref end() otherwise
336 template <typename... Args>
337 iterator emplace( Args&&... args )
339 return node_to_iterator( emplace_at( head(), std::forward<Args>(args)... ));
342 /// Checks whether the list contains \p key
344 The function searches the item with key equal to \p key
345 and returns an iterator pointed to item found if the key is found,
346 and \ref end() otherwise
348 template <typename Q>
349 iterator contains( Q const& key )
351 return node_to_iterator( find_at( head(), key, intrusive_key_comparator()));
354 template <typename Q>
355 CDS_DEPRECATED("deprecated, use contains()")
356 iterator find( Q const& key )
358 return contains( key );
362 /// Checks whether the map contains \p key using \p pred predicate for searching
364 The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
365 \p Less functor has the interface like \p std::less.
366 \p Less must imply the same element order as the comparator used for building the list.
368 template <typename Q, typename Less>
369 iterator contains( Q const& key, Less pred )
372 return node_to_iterator( find_at( head(), key, typename maker::template less_wrapper<Less>::type()));
375 template <typename Q, typename Less>
376 CDS_DEPRECATED("deprecated, use contains()")
377 iterator find_with( Q const& key, Less pred )
379 return contains( key, pred );
383 /// Check if the list is empty
386 return base_class::empty();
389 /// Returns list's item count
391 The value returned depends on item counter provided by \p Traits. For \p atomicity::empty_item_counter,
392 this function always returns 0.
394 @note Even if you use real item counter and it returns 0, this fact does not mean that the list
395 is empty. To check list emptyness use \p empty() method.
399 return base_class::size();
402 /// Returns const reference to internal statistics
403 stat const& statistics() const
405 return base_class::statistics();
416 static value_type& node_to_value( node_type& n )
421 static node_type * alloc_node()
423 return cxx_allocator().New();
426 static node_type * alloc_node( value_type const& v )
428 return cxx_allocator().New( v );
431 template <typename... Args>
432 static node_type * alloc_node( Args&&... args )
434 return cxx_allocator().MoveNew( std::forward<Args>( args )... );
437 static void free_node( node_type * pNode )
439 cxx_allocator().Delete( pNode );
444 return base_class::m_pHead;
447 head_type const& head() const
449 return base_class::m_pHead;
452 iterator node_to_iterator( node_type * pNode )
455 return iterator( *pNode );
459 iterator insert_node( node_type * pNode )
461 return node_to_iterator( insert_node_at( head(), pNode ));
464 node_type * insert_node_at( head_type& refHead, node_type * pNode )
466 assert( pNode != nullptr );
467 scoped_node_ptr p(pNode);
468 if ( base_class::insert_at( refHead, *pNode ))
474 template <typename Q>
475 node_type * insert_at( head_type& refHead, Q&& val )
477 return insert_node_at( refHead, alloc_node( std::forward<Q>( val )));
480 template <typename Q>
481 std::pair< node_type *, bool > update_at( head_type& refHead, Q&& val, bool bAllowInsert )
483 scoped_node_ptr pNode( alloc_node( std::forward<Q>( val )));
484 node_type * pItemFound = nullptr;
486 std::pair<bool, bool> ret = base_class::update_at( refHead, *pNode,
487 [&pItemFound](bool, node_type& item, node_type&) { pItemFound = &item; },
492 return std::make_pair( pItemFound, ret.second );
495 template <typename... Args>
496 node_type * emplace_at( head_type& refHead, Args&&... args )
498 return insert_node_at( refHead, alloc_node( std::forward<Args>(args)...));
501 template <typename Q, typename Compare>
502 node_type * find_at( head_type& refHead, Q const& key, Compare cmp )
504 return base_class::find_at( refHead, key, cmp );
508 }} // namespace cds::container
510 #endif // #ifndef CDSLIB_CONTAINER_MICHAEL_LIST_NOGC_H