-//$$CDS-header$$
-
-#ifndef __CDS_INTRUSIVE_IMPL_LAZY_LIST_H
-#define __CDS_INTRUSIVE_IMPL_LAZY_LIST_H
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
+
+ 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_INTRUSIVE_IMPL_LAZY_LIST_H
+#define CDSLIB_INTRUSIVE_IMPL_LAZY_LIST_H
#include <mutex> // unique_lock
#include <cds/intrusive/details/lazy_list_base.h>
-#include <cds/gc/guarded_ptr.h>
namespace cds { namespace intrusive {
- \p GC - Garbage collector used. Note the \p GC must be the same as the GC used for item type \p T (see lazy_list::node).
- \p T - type to be stored in the list. The type must be based on lazy_list::node (for lazy_list::base_hook)
or it must have a member of type lazy_list::node (for lazy_list::member_hook).
- - \p Traits - type traits. See lazy_list::type_traits for explanation.
-
- It is possible to declare option-based list with cds::intrusive::lazy_list::make_traits metafunction istead of \p Traits template
- argument. For example, the following traits-based declaration of gc::HP lazy list
- \code
- #include <cds/intrusive/lazy_list_hp.h>
- // Declare item stored in your list
- struct item: public cds::intrusive::lazy_list::node< cds::gc::HP >
- { ... };
-
- // Declare comparator for the item
- struct my_compare { ... }
-
- // Declare type_traits
- struct my_traits: public cds::intrusive::lazy_list::type_traits
- {
- typedef cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::HP > > hook;
- typedef my_compare compare;
- };
+ - \p Traits - type traits. See lazy_list::traits for explanation.
+ It is possible to declare option-based list with cds::intrusive::lazy_list::make_traits metafunction instead of \p Traits template
+ argument. For example, the following traits-based declaration of \p gc::HP lazy list
+ \code
+ #include <cds/intrusive/lazy_list_hp.h>
+ // Declare item stored in your list
+ struct item: public cds::intrusive::lazy_list::node< cds::gc::HP >
+ { ... };
- // Declare traits-based list
- typedef cds::intrusive::LazyList< cds::gc::HP, item, my_traits > traits_based_list;
- \endcode
+ // Declare comparator for the item
+ struct my_compare { ... }
- is equivalent for the following option-based list
- \code
- #include <cds/intrusive/lazy_list_hp.h>
+ // Declare traits
+ struct my_traits: public cds::intrusive::lazy_list::traits
+ {
+ typedef cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::HP > > hook;
+ typedef my_compare compare;
+ };
- // item struct and my_compare are the same
+ // Declare traits-based list
+ typedef cds::intrusive::LazyList< cds::gc::HP, item, my_traits > traits_based_list;
+ \endcode
+ is equivalent for the following option-based list
+ \code
+ #include <cds/intrusive/lazy_list_hp.h>
- // Declare option-based list
- typedef cds::intrusive::LazyList< cds::gc::HP, item,
- typename cds::intrusive::lazy_list::make_traits<
- cds::intrusive::opt::hook< cds::intrusive::lazy_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
+ // item struct and my_compare are the same
- Template argument list \p Options of cds::intrusive::lazy_list::make_traits metafunction are:
- - opt::hook - hook used. Possible values are: lazy_list::base_hook, lazy_list::member_hook, lazy_list::traits_hook.
- If the option is not specified, <tt>lazy_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 means no item counting.
- - opt::allocator - an allocator needed for dummy head and tail nodes. Default is \ref CDS_DEFAULT_ALLOCATOR.
- The option applies only to gc::HRC garbage collector.
- - 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).
+ // Declare option-based list
+ typedef cds::intrusive::LazyList< cds::gc::HP, item,
+ typename cds::intrusive::lazy_list::make_traits<
+ cds::intrusive::opt::hook< cds::intrusive::lazy_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.
- for \ref cds_urcu_type "RCU" - see \ref cds_intrusive_LazyList_rcu "LazyList RCU specialization"
Then, you should incorporate lazy_list::node into your struct \p T and provide
- appropriate lazy_list::type_traits::hook in your \p Traits template parameters. Usually, for \p Traits
- a struct based on lazy_list::type_traits should be defined.
+ appropriate \p lazy_list::traits::hook in your \p Traits template parameters. Usually, for \p Traits
+ a struct based on \p lazy_list::traits should be defined.
- Example for gc::PTB and base hook:
+ Example for gc::DHP and base hook:
\code
// Include GC-related lazy list specialization
#include <cds/intrusive/lazy_list_dhp.h>
// Data stored in lazy list
- struct my_data: public cds::intrusive::lazy_list::node< cds::gc::PTB >
+ struct my_data: public cds::intrusive::lazy_list::node< cds::gc::DHP >
{
// key field
std::string strKey;
}
};
-
- // Declare type_traits
- struct my_traits: public cds::intrusive::lazy_list::type_traits
+ // Declare traits
+ struct my_traits: public cds::intrusive::lazy_list::traits
{
- typedef cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::PTB > > hook;
+ typedef cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::DHP > > hook;
typedef my_data_cmp compare;
};
// Declare list type
- typedef cds::intrusive::LazyList< cds::gc::PTB, my_data, my_traits > traits_based_list;
+ typedef cds::intrusive::LazyList< cds::gc::DHP, my_data, my_traits > traits_based_list;
\endcode
Equivalent option-based code:
};
// Declare option-based list
- typedef cds::intrusive::LazyList< cds::gc::PTB
+ typedef cds::intrusive::LazyList< cds::gc::DHP
,my_data
, typename cds::intrusive::lazy_list::make_traits<
- cds::intrusive::opt::hook< cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::PTB > > >
+ cds::intrusive::opt::hook< cds::intrusive::lazy_list::base_hook< cds::opt::gc< cds::gc::DHP > > >
,cds::intrusive::opt::compare< my_data_cmp >
>::type
> option_based_list;
class GC
,typename T
#ifdef CDS_DOXYGEN_INVOKED
- ,class Traits = lazy_list::type_traits
+ ,class Traits = lazy_list::traits
#else
,class Traits
#endif
class LazyList
{
public:
- typedef T value_type ; ///< type of value stored in the list
- typedef Traits options ; ///< Traits template parameter
+ typedef GC gc; ///< Garbage collector
+ 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.
+ 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 get_node_traits< value_type, node_type, hook>::type node_traits ; ///< node traits
- typedef typename lazy_list::get_link_checker< node_type, options::link_checker >::type link_checker ; ///< link checker
+ typedef typename traits::disposer disposer; ///< disposer
+ typedef typename get_node_traits< value_type, node_type, hook>::type node_traits; ///< node traits
+ typedef typename lazy_list::get_link_checker< node_type, traits::link_checker >::type link_checker; ///< link checker
+
+ 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; ///< C++ memory ordering (see \p lazy_list::traits::memory_model)
+ typedef typename traits::stat stat; ///< Internal statistics
+
+ static_assert((std::is_same< gc, typename node_type::gc >::value), "GC and node_type::gc must be the same type");
- 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; ///< C++ memory ordering (see lazy_list::type_traits::memory_model)
+ typedef typename gc::template guarded_ptr< value_type > guarded_ptr; ///< Guarded pointer
- typedef cds::gc::guarded_ptr< gc, value_type > guarded_ptr; ///< Guarded pointer
+ static CDS_CONSTEXPR const size_t c_nHazardPtrCount = 4; ///< Count of hazard pointer required for the algorithm
//@cond
- // Rebind options (split-list support)
+ // Rebind traits (split-list support)
template <typename... Options>
- struct rebind_options {
+ struct rebind_traits {
typedef LazyList<
gc
, value_type
- , typename cds::opt::make_options< options, Options...>::type
- > type;
+ , typename cds::opt::make_options< traits, Options...>::type
+ > type;
};
+
+ // Stat selector
+ template <typename Stat>
+ using select_stat_wrapper = lazy_list::select_stat_wrapper< Stat >;
//@endcond
protected:
- typedef typename node_type::marked_ptr marked_node_ptr ; ///< Node marked pointer
- typedef node_type * auxiliary_head ; ///< Auxiliary head type (for split-list support)
+ typedef typename node_type::marked_ptr marked_node_ptr; ///< Node marked pointer
+ typedef node_type * auxiliary_head; ///< Auxiliary head type (for split-list support)
protected:
//@cond
node_type m_Head;
node_type m_Tail;
- item_counter m_ItemCounter ; ///< Item counter
+ item_counter m_ItemCounter;
+ stat m_Stat; ///< Internal statistics
- //@cond
struct clean_disposer {
void operator()( value_type * p )
{
- lazy_list::node_cleaner<gc, node_type, memory_model>()( node_traits::to_node_ptr( p ) );
+ lazy_list::node_cleaner<gc, node_type, memory_model>()( node_traits::to_node_ptr( p ));
disposer()( p );
}
};
/// Position pointer for item search
struct position {
- node_type * pPred ; ///< Previous node
- node_type * pCur ; ///< Current node
+ node_type * pPred; ///< Previous node
+ node_type * pCur; ///< Current node
- typename gc::template GuardArray<2> guards ; ///< Guards array
+ typename gc::template GuardArray<2> guards; ///< Guards array
enum {
guard_prev_item,
}
};
- class auto_lock_position {
- position& m_pos;
- public:
- auto_lock_position( position& pos )
- : m_pos(pos)
- {
- pos.lock();
- }
- ~auto_lock_position()
- {
- m_pos.unlock();
- }
- };
+ typedef std::unique_lock< position > scoped_position_lock;
//@endcond
protected:
void link_node( node_type * pNode, node_type * pPred, node_type * pCur )
{
assert( pPred->m_pNext.load(memory_model::memory_order_relaxed).ptr() == pCur );
+ link_checker::is_empty( pNode );
pNode->m_pNext.store( marked_node_ptr(pCur), memory_model::memory_order_release );
pPred->m_pNext.store( marked_node_ptr(pNode), memory_model::memory_order_release );
assert( pPred->m_pNext.load(memory_model::memory_order_relaxed).ptr() == pCur );
node_type * pNext = pCur->m_pNext.load(memory_model::memory_order_relaxed).ptr();
- //pCur->m_pNext.store( marked_node_ptr( pNext, 1), memory_model::memory_order_release) ; // logically deleting
- pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_release ) ; // logical removal + back-link for search
+ pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_release ); // logical removal + back-link for search
pPred->m_pNext.store( marked_node_ptr( pNext ), memory_model::memory_order_release); // physically deleting
- //pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_release ) ; // back-link for search
}
void retire_node( node_type * pNode )
{
assert( pNode != nullptr );
- gc::template retire<clean_disposer>( node_traits::to_value_ptr( *pNode ) );
+ gc::template retire<clean_disposer>( node_traits::to_value_ptr( *pNode ));
}
//@endcond
do {
pNext = pCur->m_pNext.load(memory_model::memory_order_relaxed).ptr();
g.assign( node_traits::to_value_ptr( pNext ));
- } while ( pNext != pCur->m_pNext.load(memory_model::memory_order_relaxed).ptr() );
+ } while ( pNext != pCur->m_pNext.load(memory_model::memory_order_relaxed).ptr());
- m_pNode = m_Guard.assign( g.template get<value_type>() );
+ m_pNode = m_Guard.assign( g.template get<value_type>());
}
}
}
node_type * pNode = node_traits::to_node_ptr( m_pNode );
// Dummy tail node could not be marked
- while ( pNode->is_marked() ) {
+ while ( pNode->is_marked()) {
node_type * p = pNode->m_pNext.load(memory_model::memory_order_relaxed).ptr();
g.assign( node_traits::to_value_ptr( p ));
- if ( p == pNode->m_pNext.load(memory_model::memory_order_relaxed).ptr() )
+ if ( p == pNode->m_pNext.load(memory_model::memory_order_relaxed).ptr())
pNode = p;
}
- if ( pNode != node_traits::to_node_ptr( m_pNode ) )
- m_pNode = m_Guard.assign( g.template get<value_type>() );
+ if ( pNode != node_traits::to_node_ptr( m_pNode ))
+ m_pNode = m_Guard.assign( g.template get<value_type>());
}
}
//@endcond
public:
+ ///@name Forward iterators (only for debugging purpose)
+ //@{
/// Forward iterator
/**
The forward iterator for lazy list has some features:
- 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.
+ Moreover, a crash is possible when you try to iterate the next element that has been deleted by concurrent thread.
- Therefore, the use of iterators in concurrent environment is not good idea. Use the iterator on the concurrent container
- for debug purpose only.
+ @warning Use this iterator on the concurrent container for debugging purpose only.
*/
typedef iterator_type<false> iterator;
/// Const forward iterator
}
/// Returns a forward const iterator addressing the first element in a list
- //@{
const_iterator begin() const
{
return get_const_begin();
}
- const_iterator cbegin()
+
+ /// Returns a forward const iterator addressing the first element in a list
+ const_iterator cbegin() const
{
return get_const_begin();
}
- //@}
/// Returns an const iterator that addresses the location succeeding the last element in a list
- //@{
const_iterator end() const
{
return get_const_end();
}
- const_iterator cend()
+
+ /// Returns an const iterator that addresses the location succeeding the last element in a list
+ const_iterator cend() const
{
return get_const_end();
}
- //@}
+ //@}
private:
//@cond
}
const_iterator get_const_end() const
{
- return const_iterator( const_cast<node_type *>(&m_Tail) );
+ return const_iterator( const_cast<node_type *>(&m_Tail));
}
//@endcond
/// Default constructor initializes empty list
LazyList()
{
- static_assert( (std::is_same< gc, typename node_type::gc >::value), "GC and node_type::gc must be the same type" );
m_Head.m_pNext.store( marked_node_ptr( &m_Tail ), memory_model::memory_order_relaxed );
}
+ //@cond
+ template <typename Stat, typename = std::enable_if<std::is_same<stat, lazy_list::wrapped_stat<Stat>>::value >>
+ explicit LazyList( Stat& st )
+ : m_Stat( st )
+ {
+ m_Head.m_pNext.store( marked_node_ptr( &m_Tail ), memory_model::memory_order_relaxed );
+ }
+ //@endcond
+
/// Destroys the list object
~LazyList()
{
void func( value_type& val );
\endcode
where \p val is the item inserted.
- While the functor \p f is working the item \p val is locked.
+ While the functor \p f is called the item \p val is locked so
+ the functor has an exclusive access to the item.
The user-defined functor is called only if the inserting is success.
-
- @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
*/
template <typename Func>
bool insert( value_type& val, Func f )
return insert_at( &m_Head, val, f );
}
- /// Ensures that the \p item exists in the list
+ /// Updates the item
/**
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 not found in the list, then \p val is inserted into the list
+ iff \p bAllowInsert is \p true.
Otherwise, the functor \p func is called with item found.
The functor signature is:
\code
- void func( bool bNew, value_type& item, value_type& val );
+ struct functor {
+ void operator()( bool bNew, value_type& item, value_type& val );
+ };
\endcode
with arguments:
- \p bNew - \p true if the item has been inserted, \p false otherwise
- \p item - item of the list
- - \p val - argument \p val passed into the \p ensure function
+ - \p val - argument \p val passed into the \p update() function
If new item has been inserted (i.e. \p bNew is \p true) then \p item and \p val arguments
refer to the same thing.
The functor may change non-key fields of the \p item.
- While the functor \p f is working the item \p item is locked.
+ While the functor \p f is working the item \p item is locked,
+ so \p func has exclusive access to the item.
- Returns std::pair<bool, bool> where \p first is \p true if operation is successfull,
+ Returns <tt> std::pair<bool, bool> </tt> where \p first is \p true if operation is successful,
\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.
- @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
+ The function makes RCU lock internally.
*/
template <typename Func>
+ std::pair<bool, bool> update( value_type& val, Func func, bool bAllowInsert = true )
+ {
+ return update_at( &m_Head, val, func, bAllowInsert );
+ }
+ //@cond
+ template <typename Func>
+ CDS_DEPRECATED("ensure() is deprecated, use update()")
std::pair<bool, bool> ensure( value_type& val, Func func )
{
- return ensure_at( &m_Head, val, func );
+ return update( val, func, true );
}
+ //@endcond
/// Unlinks the item \p val from the list
/**
is equal to <tt> &val </tt>.
The function returns \p true if success and \p false otherwise.
+
+ \p disposer specified in \p Traits is called for unlinked item.
*/
bool unlink( value_type& val )
{
/// Deletes the item from the list
/** \anchor cds_intrusive_LazyList_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 the item with the key equal to \p key is not found the function return \p false.
+
+ \p disposer specified in \p Traits is called for deleted item.
*/
template <typename Q>
- bool erase( Q const& val )
+ bool erase( Q const& key )
{
- return erase_at( &m_Head, val, key_comparator() );
+ return erase_at( &m_Head, key, key_comparator());
}
/// Deletes the item from the list using \p pred predicate for searching
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.
+
+ \p disposer specified in \p Traits is called for deleted item.
*/
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_Head, val, cds::opt::details::make_comparator_from_less<Less>() );
+ CDS_UNUSED( pred );
+ return erase_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>());
}
/// Deletes the item from the list
/** \anchor cds_intrusive_LazyList_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 disposer specified in \p Traits is called for deleted item.
*/
template <typename Q, typename Func>
- bool erase( const Q& val, Func func )
+ bool erase( const Q& key, Func func )
{
- return erase_at( &m_Head, val, key_comparator(), func );
+ return erase_at( &m_Head, key, key_comparator(), func );
}
/// Deletes the item from the list using \p pred predicate for searching
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.
+
+ \p disposer specified in \p Traits is called for deleted item.
*/
template <typename Q, typename Less, typename Func>
- bool erase_with( const Q& val, Less pred, Func func )
+ bool erase_with( const Q& key, Less pred, Func func )
{
- return erase_at( &m_Head, val, cds::opt::details::make_comparator_from_less<Less>(), func );
+ CDS_UNUSED( pred );
+ return erase_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>(), func );
}
/// Extracts the item from the list with specified \p key
/** \anchor cds_intrusive_LazyList_hp_extract
The function searches an item with key equal to \p key,
- unlinks it from the list, and returns it in \p dest parameter.
- If the item with key equal to \p key is not found the function returns \p false.
+ 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 Q that can be not the same as \p value_type.
The \ref disposer specified in \p Traits class template parameter is called automatically
- by garbage collector \p GC specified in class' template parameters when returned \ref guarded_ptr object
+ 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.
ord_list theList;
// ...
{
- ord_list::guarded_ptr gp;
- theList.extract( gp, 5 );
+ ord_list::guarded_ptr gp( theList.extract( 5 ));
// Deal with gp
// ...
\endcode
*/
template <typename Q>
- bool extract( guarded_ptr& dest, Q const& key )
+ guarded_ptr extract( Q const& key )
{
- return extract_at( &m_Head, dest.guard(), key, key_comparator() );
+ guarded_ptr gp;
+ extract_at( &m_Head, gp.guard(), key, key_comparator());
+ return gp;
}
/// Extracts the item from the list with comparing functor \p pred
/**
- The function is an analog of \ref cds_intrusive_LazyList_hp_extract "extract(guarded_ptr&, Q const&)"
+ The function is an analog of \ref cds_intrusive_LazyList_hp_extract "extract(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 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 )
+ guarded_ptr extract_with( Q const& key, Less pred )
{
- return extract_at( &m_Head, dest.guard(), key, cds::opt::details::make_comparator_from_less<Less>() );
+ CDS_UNUSED( pred );
+ guarded_ptr gp;
+ extract_at( &m_Head, gp.guard(), key, cds::opt::details::make_comparator_from_less<Less>());
+ return gp;
}
- /// Finds the key \p val
+ /// Finds the key \p key
/** \anchor cds_intrusive_LazyList_hp_find
- 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.
While the functor \p f is calling the item \p item is locked.
- 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( &m_Head, key, key_comparator(), f );
+ }
+ //@cond
+ template <typename Q, typename Func>
+ bool find( Q const& key, Func f )
{
- return find_at( &m_Head, val, key_comparator(), f );
+ return find_at( &m_Head, key, key_comparator(), f );
}
+ //@endcond
- /// 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_LazyList_hp_find "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_Head, val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ CDS_UNUSED( pred );
+ return find_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
-
- /// Finds the key \p val
- /** \anchor cds_intrusive_LazyList_hp_find_const
- 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 \p find function argument.
-
- You may pass \p f argument by reference using \p std::ref.
-
- The functor may change non-key fields of \p item.
- While the functor \p f is calling the item \p item is locked.
-
- 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 )
+ //@cond
+ template <typename Q, typename Less, typename Func>
+ bool find_with( Q const& key, Less pred, Func f )
{
- return find_at( &m_Head, val, key_comparator(), f );
+ CDS_UNUSED( pred );
+ return find_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
+ //@endcond
- /// Finds the key \p val using \p pred predicate for searching
+ /// Checks whether the list contains \p key
/**
- The function is an analog of \ref cds_intrusive_LazyList_hp_find_const "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.
+ 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, typename Less, typename Func>
- bool find_with( Q const& val, Less pred, Func f )
+ template <typename Q>
+ bool contains( Q const& key )
{
- return find_at( &m_Head, val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return find_at( &m_Head, key, key_comparator());
}
-
- /// Finds the key \p val
- /** \anchor cds_intrusive_LazyList_hp_find_val
- The function searches the item with key equal to \p val
- and returns \p true if it is found, and \p false otherwise
- */
+ //@cond
template <typename Q>
- bool find( Q const & val )
+ CDS_DEPRECATED("deprecated, use contains()")
+ bool find( Q const& key )
{
- return find_at( &m_Head, val, key_comparator() );
+ return contains( key );
}
+ //@cond
- /// Finds the key \p val using \p pred predicate for searching
+ /// Checks whether the map contains \p key using \p pred predicate for searching
/**
- The function is an analog of \ref cds_intrusive_LazyList_hp_find_val "find(Q const&)"
- but \p pred is used for key comparing.
+ 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 pred must imply the same element order as the comparator used for building the list.
+ \p Less 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 contains( Q const& key, Less pred )
+ {
+ CDS_UNUSED( pred );
+ return find_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>());
+ }
+ //@cond
+ template <typename Q, typename Less>
+ CDS_DEPRECATED("deprecated, use contains()")
+ bool find_with( Q const& key, Less pred )
{
- return find_at( &m_Head, val, cds::opt::details::make_comparator_from_less<Less>() );
+ return contains( key, pred );
}
+ //@endcond
- /// Finds the key \p val and return the item found
+ /// Finds \p key and return the item found
/** \anchor cds_intrusive_LazyList_hp_get
- The function searches the item with key equal to \p val
- 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 searches the item with key equal to \p key
+ and returns an guarded pointer to it.
+ If \p key is not found the function returns an empty guarded pointer.
The \ref disposer specified in \p Traits class template parameter is called
- by garbage collector \p GC automatically when returned \ref guarded_ptr object
+ by garbage collector \p GC automatically when returned \p guarded_ptr object
will be destroyed or released.
@note Each \p guarded_ptr object uses one GC's guard which can be limited resource.
ord_list theList;
// ...
{
- ord_list::guarded_ptr gp;
- if ( theList.get( gp, 5 )) {
+ ord_list::guarded_ptr gp(theList.get( 5 ));
+ if ( gp ) {
// Deal with gp
//...
}
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 )
+ guarded_ptr get( Q const& key )
{
- return get_at( &m_Head, ptr.guard(), val, key_comparator() );
+ guarded_ptr gp;
+ get_at( &m_Head, gp.guard(), key, key_comparator());
+ return gp;
}
- /// 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_LazyList_hp_get "get( guarded_ptr& ptr, Q const&)"
+ The function is an analog of \ref cds_intrusive_LazyList_hp_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 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 )
+ guarded_ptr get_with( Q const& key, Less pred )
{
- return get_at( &m_Head, ptr.guard(), val, cds::opt::details::make_comparator_from_less<Less>() );
+ CDS_UNUSED( pred );
+ guarded_ptr gp;
+ get_at( &m_Head, gp.guard(), key, cds::opt::details::make_comparator_from_less<Less>());
+ return gp;
}
/// Clears the list
- /**
- The function unlink all items from the list.
- */
void clear()
{
typename gc::Guard guard;
marked_node_ptr h;
- while ( !empty() ) {
+ while ( !empty()) {
h = m_Head.m_pNext.load( memory_model::memory_order_relaxed );
- guard.assign( node_traits::to_value_ptr( h.ptr() ));
+ guard.assign( node_traits::to_value_ptr( h.ptr()));
if ( m_Head.m_pNext.load(memory_model::memory_order_acquire) == h ) {
m_Head.m_Lock.lock();
h->m_Lock.lock();
unlink_node( &m_Head, h.ptr(), &m_Head );
+ --m_ItemCounter;
h->m_Lock.unlock();
m_Head.m_Lock.unlock();
- retire_node( h.ptr() ) ; // free node
+ retire_node( h.ptr()) ; // free node
}
}
}
/// 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 emptiness use \p empty() method.
*/
size_t size() const
{
return m_ItemCounter.value();
}
+ /// Returns const reference to internal statistics
+ stat const& statistics() const
+ {
+ return m_Stat;
+ }
+
protected:
//@cond
// split-list support
assert( pNode != nullptr );
// Hack: convert node_type to value_type.
- // In principle, auxiliary node can be non-reducible to value_type
- // We assume that comparator can correctly distinguish aux and regular node.
- return insert_at( pHead, *node_traits::to_value_ptr( pNode ) );
+ // In principle, auxiliary node cannot be reducible to value_type
+ // We assume that internal comparator can correctly distinguish aux and regular node.
+ return insert_at( pHead, *node_traits::to_value_ptr( pNode ));
}
bool insert_at( node_type * pHead, value_type& val )
{
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
position pos;
key_comparator cmp;
while ( true ) {
- search( pHead, val, pos, key_comparator() );
+ search( pHead, val, pos, key_comparator());
{
- auto_lock_position alp( pos );
+ scoped_position_lock alp( pos );
if ( validate( pos.pPred, pos.pCur )) {
if ( pos.pCur != &m_Tail && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 ) {
// failed: key already in list
+ m_Stat.onInsertFailed();
return false;
}
else {
link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
- ++m_ItemCounter;
- return true;
+ break;
}
}
}
+
+ m_Stat.onInsertRetry();
}
+
+ ++m_ItemCounter;
+ m_Stat.onInsertSuccess();
+ return true;
}
template <typename Func>
bool insert_at( node_type * pHead, value_type& val, Func f )
{
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
position pos;
key_comparator cmp;
while ( true ) {
- search( pHead, val, pos, key_comparator() );
+ search( pHead, val, pos, key_comparator());
{
- auto_lock_position alp( pos );
+ scoped_position_lock alp( pos );
if ( validate( pos.pPred, pos.pCur )) {
if ( pos.pCur != &m_Tail && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 ) {
// failed: key already in list
+ m_Stat.onInsertFailed();
return false;
}
else {
link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
f( val );
- ++m_ItemCounter;
- return true;
+ break;
}
}
}
+
+ m_Stat.onInsertRetry();
}
+
+ ++m_ItemCounter;
+ m_Stat.onInsertSuccess();
+ return true;
}
template <typename Func>
- std::pair<bool, bool> ensure_at( node_type * pHead, value_type& val, Func func )
+ std::pair<bool, bool> update_at( node_type * pHead, value_type& val, Func func, bool bAllowInsert )
{
position pos;
key_comparator cmp;
while ( true ) {
- search( pHead, val, pos, key_comparator() );
+ search( pHead, val, pos, key_comparator());
{
- auto_lock_position alp( pos );
+ scoped_position_lock alp( pos );
if ( validate( pos.pPred, pos.pCur )) {
if ( pos.pCur != &m_Tail && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 ) {
// key already in the list
func( false, *node_traits::to_value_ptr( *pos.pCur ) , val );
+ m_Stat.onUpdateExisting();
return std::make_pair( true, false );
}
else {
// new key
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
+ if ( !bAllowInsert ) {
+ m_Stat.onUpdateFailed();
+ return std::make_pair( false, false );
+ }
link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
func( true, val, val );
- ++m_ItemCounter;
- return std::make_pair( true, true );
+ break;
}
}
}
+
+ m_Stat.onUpdateRetry();
}
+
+ ++m_ItemCounter;
+ m_Stat.onUpdateNew();
+ return std::make_pair( true, true );
}
bool unlink_at( node_type * pHead, value_type& val )
key_comparator cmp;
while ( true ) {
- search( pHead, val, pos, key_comparator() );
+ search( pHead, val, pos, key_comparator());
{
int nResult = 0;
{
- auto_lock_position alp( pos );
- if ( validate( pos.pPred, pos.pCur ) ) {
+ scoped_position_lock alp( pos );
+ if ( validate( pos.pPred, pos.pCur )) {
if ( pos.pCur != &m_Tail
&& cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0
&& node_traits::to_value_ptr( pos.pCur ) == &val )
{
// item found
unlink_node( pos.pPred, pos.pCur, pHead );
- --m_ItemCounter;
nResult = 1;
}
else
nResult = -1;
}
}
+
if ( nResult ) {
if ( nResult > 0 ) {
+ --m_ItemCounter;
retire_node( pos.pCur );
+ m_Stat.onEraseSuccess();
return true;
}
+
+ m_Stat.onEraseFailed();
return false;
}
}
+
+ m_Stat.onEraseRetry();
}
}
{
int nResult = 0;
{
- auto_lock_position alp( pos );
+ scoped_position_lock alp( pos );
if ( validate( pos.pPred, pos.pCur )) {
if ( pos.pCur != &m_Tail && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 ) {
// key found
unlink_node( pos.pPred, pos.pCur, pHead );
- f( *node_traits::to_value_ptr( *pos.pCur ) );
- --m_ItemCounter;
+ f( *node_traits::to_value_ptr( *pos.pCur ));
nResult = 1;
}
else {
}
if ( nResult ) {
if ( nResult > 0 ) {
+ --m_ItemCounter;
retire_node( pos.pCur );
+ m_Stat.onEraseSuccess();
return true;
}
+
+ m_Stat.onEraseFailed();
return false;
}
}
+
+ m_Stat.onEraseRetry();
}
}
}
template <typename Q, typename Compare>
- bool extract_at( node_type * pHead, typename gc::Guard& gp, const Q& val, Compare cmp )
+ bool extract_at( node_type * pHead, typename guarded_ptr::native_guard& gp, const Q& val, Compare cmp )
{
position pos;
if ( erase_at( pHead, val, cmp, [](value_type const &){}, pos )) {
- gp.assign( pos.guards.template get<value_type>(position::guard_current_item) );
+ gp.set( pos.guards.template get<value_type>(position::guard_current_item));
return true;
}
return false;
&& cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 )
{
f( *node_traits::to_value_ptr( *pos.pCur ), val );
+ m_Stat.onFindSuccess();
return true;
}
}
+
+ m_Stat.onFindFailed();
return false;
}
position pos;
search( pHead, val, pos, cmp );
- return pos.pCur != &m_Tail
- && !pos.pCur->is_marked()
- && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0;
+ if ( pos.pCur != &m_Tail && !pos.pCur->is_marked() && cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 ) {
+ m_Stat.onFindSuccess();
+ return true;
+ }
+
+ m_Stat.onFindFailed();
+ return false;
}
template <typename Q, typename Compare>
- bool get_at( node_type * pHead, typename gc::Guard& gp, Q const& val, Compare cmp )
+ bool get_at( node_type * pHead, typename guarded_ptr::native_guard& gp, Q const& val, Compare cmp )
{
position pos;
&& !pos.pCur->is_marked()
&& cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 )
{
- gp.assign( pos.guards.template get<value_type>( position::guard_current_item ));
+ gp.set( pos.guards.template get<value_type>( position::guard_current_item ));
+ m_Stat.onFindSuccess();
return true;
}
+
+ m_Stat.onFindFailed();
return false;
}
template <typename Q, typename Compare>
void search( node_type * pHead, const Q& key, position& pos, Compare cmp )
{
- const node_type * pTail = &m_Tail;
+ node_type const* pTail = &m_Tail;
marked_node_ptr pCur( pHead );
marked_node_ptr pPrev( pHead );
- back_off bkoff;
-
- while ( pCur.ptr() != pTail )
- {
+ while ( pCur.ptr() != pTail ) {
if ( pCur.ptr() != pHead ) {
- if ( cmp( *node_traits::to_value_ptr( *pCur.ptr() ), key ) >= 0 )
+ if ( cmp( *node_traits::to_value_ptr( *pCur.ptr()), key ) >= 0 )
break;
}
pos.guards.copy( position::guard_prev_item, position::guard_current_item );
pPrev = pCur;
- for (;;) {
- pCur = pPrev->m_pNext.load(memory_model::memory_order_relaxed);
- pos.guards.assign( position::guard_current_item, node_traits::to_value_ptr( pCur.ptr() ));
- if ( pCur == pPrev->m_pNext.load(memory_model::memory_order_acquire) )
- break;
- bkoff();
- }
+ pCur = pos.guards.protect( position::guard_current_item, pPrev->m_pNext,
+ []( marked_node_ptr p ) { return node_traits::to_value_ptr( p.ptr()); }
+ );
assert( pCur.ptr() != nullptr );
+ if ( pCur.bits())
+ pPrev = pCur = pHead;
}
pos.pCur = pCur.ptr();
pos.pPred = pPrev.ptr();
}
- static bool validate( node_type * pPred, node_type * pCur )
+ bool validate( node_type * pPred, node_type * pCur ) CDS_NOEXCEPT
+ {
+ if ( validate_link( pPred, pCur )) {
+ m_Stat.onValidationSuccess();
+ return true;
+ }
+
+ m_Stat.onValidationFailed();
+ return false;
+ }
+
+ static bool validate_link( node_type * pPred, node_type * pCur ) CDS_NOEXCEPT
{
return !pPred->is_marked()
&& !pCur->is_marked()
};
}} // namespace cds::intrusive
-#endif // __CDS_INTRUSIVE_IMPL_LAZY_LIST_H
+#endif // CDSLIB_INTRUSIVE_IMPL_LAZY_LIST_H
projects / libcds.git / blobdiff