-//$$CDS-header$$
-
-#ifndef __CDS_INTRUSIVE_LAZY_LIST_RCU_H
-#define __CDS_INTRUSIVE_LAZY_LIST_RCU_H
-
-#include <cds/intrusive/lazy_list_base.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_LAZY_LIST_RCU_H
+#define CDSLIB_INTRUSIVE_LAZY_LIST_RCU_H
+
+#include <mutex> // unique_lock
+#include <cds/intrusive/details/lazy_list_base.h>
#include <cds/urcu/details/check_deadlock.h>
#include <cds/details/binary_functor_wrapper.h>
#include <cds/urcu/exempt_ptr.h>
typedef Tag tag ; ///< tag
typedef cds::details::marked_ptr<node, 1> marked_ptr ; ///< marked pointer
- typedef CDS_ATOMIC::atomic<marked_ptr> atomic_marked_ptr ; ///< atomic marked pointer specific for GC
+ typedef atomics::atomic<marked_ptr> atomic_marked_ptr ; ///< atomic marked pointer specific for GC
atomic_marked_ptr m_pNext ; ///< pointer to the next node in the list
mutable lock_type m_Lock ; ///< Node lock
/// Checks if node is marked
bool is_marked() const
{
- return m_pNext.load(CDS_ATOMIC::memory_order_relaxed).bits() != 0;
+ return m_pNext.load(atomics::memory_order_relaxed).bits() != 0;
}
/// Default ctor
/// Clears internal fields
void clear()
{
- m_pNext.store( marked_ptr(), CDS_ATOMIC::memory_order_release );
+ m_pNext.store( marked_ptr(), atomics::memory_order_release );
}
};
} // namespace lazy_list
Template arguments:
- \p RCU - one of \ref cds_urcu_gc "RCU type"
- \p T - type to be stored in the list
- - \p Traits - type traits. See lazy_list::type_traits for explanation.
+ - \p Traits - type traits. See \p lazy_list::traits for explanation.
It is possible to declare option-based list with \p %cds::intrusive::lazy_list::make_traits metafunction istead of \p Traits template
argument. Template argument list \p Options of cds::intrusive::lazy_list::make_traits metafunction are:
typename RCU
,typename T
#ifdef CDS_DOXYGEN_INVOKED
- ,class Traits = lazy_list::type_traits
+ ,class Traits = lazy_list::traits
#else
,class Traits
#endif
class LazyList<cds::urcu::gc<RCU>, T, Traits>
{
public:
- typedef T value_type ; ///< type of value stored in the list
- typedef Traits options ; ///< Traits template parameter
+ typedef cds::urcu::gc<RCU> gc; ///< RCU schema
+ 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 compare 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 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, traits::link_checker >::type link_checker; ///< link checker
- typedef cds::urcu::gc<RCU> gc ; ///< RCU schema
- typedef typename options::back_off back_off ; ///< back-off strategy (not used)
- 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 options::rcu_check_deadlock rcu_check_deadlock ; ///< Deadlock checking policy
+ typedef typename traits::back_off back_off; ///< back-off strategy (not used)
+ 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::rcu_check_deadlock rcu_check_deadlock; ///< Deadlock checking policy
typedef typename gc::scoped_lock rcu_lock ; ///< RCU scoped lock
- static CDS_CONSTEXPR_CONST bool c_bExtractLockExternal = true; ///< Group of \p extract_xxx functions require external locking
+ static CDS_CONSTEXPR const bool c_bExtractLockExternal = true; ///< Group of \p extract_xxx functions require external locking
//@cond
- // Rebind options (split-list support)
- template <CDS_DECL_OPTIONS8>
- struct rebind_options {
+ // Rebind traits (split-list support)
+ template <typename... Options>
+ struct rebind_traits {
typedef LazyList<
gc
, value_type
- , typename cds::opt::make_options< options, CDS_OPTIONS8>::type
+ , typename cds::opt::make_options< traits, Options...>::type
> type;
};
//@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:
- node_type m_Head ; ///< List head (dummy node)
- node_type m_Tail; ///< List tail (dummy node)
- item_counter m_ItemCounter ; ///< Item counter
+ node_type m_Head; ///< List head (dummy node)
+ node_type m_Tail; ///< List tail (dummy node)
+ item_counter m_ItemCounter; ///< Item counter
//@cond
/// 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
/// Locks nodes \p pPred and \p pCur
void lock()
}
};
- 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 cds::urcu::details::check_deadlock_policy< gc, rcu_check_deadlock> check_deadlock_policy;
-
-# ifndef CDS_CXX11_LAMBDA_SUPPORT
- struct empty_erase_functor {
- void operator()( value_type const& item )
- {}
- };
-
- struct get_functor {
- value_type * pFound;
-
- get_functor()
- : pFound( nullptr )
- {}
-
- template <typename Q>
- void operator()( value_type& item, Q& val )
- {
- pFound = &item;
- }
- };
-# endif
+ typedef std::unique_lock< position > scoped_position_lock;
+ typedef cds::urcu::details::check_deadlock_policy< gc, rcu_check_deadlock> deadlock_policy;
//@endcond
protected:
static void dispose_node( node_type * pNode )
{
assert( pNode );
- assert( !gc::is_locked() );
+ assert( !gc::is_locked());
- gc::template retire_ptr<clear_and_dispose>( node_traits::to_value_ptr( *pNode ) );
+ gc::template retire_ptr<clear_and_dispose>( node_traits::to_value_ptr( *pNode ));
}
- void link_node( node_type * pNode, node_type * pPred, node_type * pCur )
+ static void link_node( node_type * pNode, node_type * pPred, node_type * pCur )
{
assert( pPred->m_pNext.load(memory_model::memory_order_relaxed).ptr() == pCur );
- pNode->m_pNext.store( marked_node_ptr(pCur), memory_model::memory_order_release );
+ pNode->m_pNext.store( marked_node_ptr(pCur), memory_model::memory_order_relaxed );
pPred->m_pNext.store( marked_node_ptr(pNode), memory_model::memory_order_release );
}
assert( pCur != &m_Tail );
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_relaxed) ; // logically deleting
- pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_relaxed ) ; // logical deletion + back-link for search
- pPred->m_pNext.store( marked_node_ptr( pNext ), memory_model::memory_order_relaxed); // physically deleting
- //pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_relaxed ) ; // back-link for search
+ pCur->m_pNext.store( marked_node_ptr( pHead, 1 ), memory_model::memory_order_relaxed ); // logical deletion + back-link for search
+ pPred->m_pNext.store( marked_node_ptr( pNext ), memory_model::memory_order_release); // physically deleting
}
//@endcond
public:
- typedef cds::urcu::exempt_ptr< gc, value_type, value_type, clear_and_dispose, void > exempt_ptr ; ///< pointer to extracted node
+ /// pointer to extracted node
+ using exempt_ptr = cds::urcu::exempt_ptr< gc, value_type, value_type, clear_and_dispose, void >;
+ /// Type of \p get() member function return value
+ typedef value_type * raw_ptr;
protected:
//@cond
assert( m_pNode != nullptr );
node_type * pNode = node_traits::to_node_ptr( m_pNode );
- node_type * pNext = pNode->m_pNext.load(memory_model::memory_order_relaxed).ptr();
+ node_type * pNext = pNode->m_pNext.load(memory_model::memory_order_acquire).ptr();
if ( pNext != nullptr )
m_pNode = node_traits::to_value_ptr( pNext );
}
node_type * pNode = node_traits::to_node_ptr( m_pNode );
// Dummy tail node could not be marked
- while ( pNode->is_marked() )
- pNode = pNode->m_pNext.load(memory_model::memory_order_relaxed).ptr();
+ while ( pNode->is_marked())
+ pNode = pNode->m_pNext.load(memory_model::memory_order_acquire).ptr();
- if ( pNode != node_traits::to_node_ptr( m_pNode ) )
+ if ( pNode != node_traits::to_node_ptr( m_pNode ))
m_pNode = node_traits::to_value_ptr( pNode );
}
}
{
return get_const_begin();
}
- const_iterator cbegin()
+ const_iterator cbegin() const
{
return get_const_begin();
}
{
return get_const_end();
}
- const_iterator cend()
+ const_iterator cend() const
{
return get_const_end();
}
\endcode
where \p val is the item inserted.
While the functor \p f is working the item \p val is locked.
- The user-defined functor is called only if the inserting is success and may be passed by reference
- using <tt>boost::ref</tt>.
+ The user-defined functor is called only if the inserting is success.
*/
template <typename Func>
bool insert( value_type& val, Func f )
return insert_at( &m_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
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
- refers to the same thing.
+ refer to the same thing.
The functor may change non-key fields of the \p item.
While the functor \p f is calling the item \p item is locked.
- You may pass \p func argument by reference using <tt>boost::ref</tt> or cds::ref.
-
- Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
- \p second is true if new item has been added or \p false if the item with \p key
+ Returns <tt> std::pair<bool, bool> </tt> where \p first is \p true if operation is successfull,
+ \p second is \p true if new item has been added or \p false if the item with \p key
already is in the list.
- */
+ 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 );
}
+ //@cond
/// Unlinks the item \p val from the list
/**
The function returns \p true if success and \p false otherwise.
- RCU \p synchronize method can be called.
+ RCU \p synchronize method can be called. The RCU should not be locked.
Note that depending on RCU type used the \ref disposer call can be deferred.
The function can throw cds::urcu::rcu_deadlock exception if deadlock is encountered and
/// Deletes the item from the list
/** \anchor cds_intrusive_LazyList_rcu_find_erase
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
unlinks it from the list, and returns \p true.
- If the item with the key equal to \p val is not found the function return \p false.
+ If the item with the key equal to \p key is not found the function return \p false.
- RCU \p synchronize method can be called.
+ RCU \p synchronize method can be called. The RCU should not be locked.
Note that depending on RCU type used the \ref disposer call can be deferred.
The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if deadlock is encountered and
deadlock checking policy is opt::v::rcu_throw_deadlock.
*/
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
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- bool erase_with( Q const& val, Less pred )
+ bool erase_with( Q const& key, Less pred )
{
- return erase_at( &m_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_rcu_find_erase_func
- The function searches an item with key equal to \p val in the list,
+ The function searches an item with key equal to \p key in the list,
call \p func functor with item found, unlinks it from the list, and returns \p true.
The \p Func interface is
\code
void operator()( value_type const& item );
};
\endcode
- The functor may be passed by reference using <tt>boost:ref</tt>
- If the item with the key equal to \p val is not found the function return \p false.
+ If the item with the key equal to \p key is not found the function return \p false.
- RCU \p synchronize method can be called.
+ RCU \p synchronize method can be called. The RCU should not be locked.
Note that depending on RCU type used the \ref disposer call can be deferred.
The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if deadlock is encountered and
deadlock checking policy is opt::v::rcu_throw_deadlock.
*/
template <typename Q, typename Func>
- bool erase( Q const& val, Func func )
+ bool erase( Q const& key, Func func )
{
- return erase_at( &m_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
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less, typename Func>
- bool erase_with( Q const& val, Less pred, Func func )
+ bool erase_with( Q const& key, Less pred, Func func )
{
- return erase_at( &m_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 an item from the list
/**
\anchor cds_intrusive_LazyList_rcu_extract
- The function searches an item with key equal to \p val in the list,
- unlinks it from the list, and returns pointer to an item found in \p dest parameter.
- If the item with the key equal to \p val is not found the function returns \p false,
- \p dest is empty.
+ The function searches an item with key equal to \p key in the list,
+ unlinks it from the list, and returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to an item found.
+ If the item is not found the function returns empty \p exempt_ptr.
@note The function does NOT call RCU read-side lock or synchronization,
- and does NOT dispose the item found. It just excludes the item from the list
- and returns a pointer to item found.
- You should lock RCU before calling this function, and you should manually synchronize RCU
+ and does NOT dispose the item found. It just unlinks the item from the list
+ and returns a pointer to it.
+ You should manually lock RCU before calling this function, and you should manually synchronize RCU
outside the RCU lock region before reusing returned pointer.
\code
// Now, you can apply extract function
// Note that you must not delete the item found inside the RCU lock
- if ( theList.extract( p1, 10 )) {
+ p1 = theList.extract( 10 )
+ if ( p1 ) {
// do something with p1
...
}
\endcode
*/
template <typename Q>
- bool extract( exempt_ptr& dest, Q const& val )
+ exempt_ptr extract( Q const& key )
{
- dest = extract_at( &m_Head, val, key_comparator() );
- return !dest.empty();
+ return exempt_ptr( extract_at( &m_Head, key, key_comparator()));
}
/// Extracts an item from the list using \p pred predicate for searching
/**
- This function is the analog for \ref cds_intrusive_LazyList_rcu_extract "extract(exempt_ptr&, Q const&)".
+ This function is the analog for \p extract(Q const&).
The \p pred is a predicate used for key comparing.
\p Less has the interface like \p std::less.
\p pred must imply the same element order as \ref key_comparator.
*/
template <typename Q, typename Less>
- bool extract_with( exempt_ptr& dest, Q const& val, Less pred )
+ exempt_ptr extract_with( Q const& key, Less pred )
{
- dest = extract_at( &m_Head, val, cds::opt::details::make_comparator_from_less<Less>() );
- return !dest.empty();
+ CDS_UNUSED( pred );
+ return exempt_ptr( extract_at( &m_Head, key, cds::opt::details::make_comparator_from_less<Less>()));
}
- /// Finds the key \p val
+ /// Finds the key \p key
/** \anchor cds_intrusive_LazyList_rcu_find_func
- The function searches the item with key equal to \p val
+ The function searches the item with key equal to \p key
and calls the functor \p f for item found.
The interface of \p Func functor is:
\code
struct functor {
- void operator()( value_type& item, Q& val );
+ void operator()( value_type& item, Q& key );
};
\endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::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 found \p item is locked.
- 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 ) const
+ bool find( Q& key, Func f ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, key_comparator(), f );
+ return find_at( const_cast<node_type *>( &m_Head ), key, key_comparator(), f );
}
+ //@cond
+ template <typename Q, typename Func>
+ bool find( Q const& key, Func f ) const
+ {
+ return find_at( const_cast<node_type *>(&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_rcu_find_func "find(Q&, Func)"
- 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.
*/
template <typename Q, typename Less, typename Func>
- bool find_with( Q& val, Less pred, Func f ) const
+ bool find_with( Q& key, Less pred, Func f ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ CDS_UNUSED( pred );
+ return find_at( const_cast<node_type *>( &m_Head ), key, cds::opt::details::make_comparator_from_less<Less>(), f );
}
-
- /// Finds the key \p val
- /** \anchor cds_intrusive_LazyList_rcu_find_cfunc
- The function searches the item with key equal to \p val
- and calls the functor \p f for item found.
- The interface of \p Func functor is:
- \code
- struct functor {
- void operator()( value_type& item, Q const& val );
- };
- \endcode
- where \p item is the item found, \p val is the <tt>find</tt> function argument.
-
- You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
-
- The functor may change non-key fields of \p item.
- While the functor \p f is calling the item found \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 ) const
+ //@cond
+ template <typename Q, typename Less, typename Func>
+ bool find_with( Q const& key, Less pred, Func f ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, key_comparator(), f );
+ CDS_UNUSED( pred );
+ return find_at( const_cast<node_type *>(&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_rcu_find_cfunc "find(Q&, Func)"
- but \p pred is used for key comparing.
- \p Less functor has the interface like \p std::less.
- \p pred must imply the same element order as the comparator used for building the list.
+ 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 ) const
+ template <typename Q>
+ bool contains( Q const& key ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, cds::opt::details::make_comparator_from_less<Less>(), f );
+ return find_at( const_cast<node_type *>( &m_Head ), key, key_comparator());
}
-
- /// Finds the key \p val
- /** \anchor cds_intrusive_LazyList_rcu_find_val
- The function searches the item with key equal to \p val
- and returns \p true if \p val found or \p false otherwise.
- */
+ //@cond
template <typename Q>
- bool find( Q const& val ) const
+ CDS_DEPRECATED("deprecated, use contains()")
+ bool find( Q const& key ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, key_comparator() );
+ return contains( key );
}
+ //@endcond
- /// 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_rcu_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 ) const
+ bool contains( Q const& key, Less pred ) const
{
- return find_at( const_cast<node_type *>( &m_Head ), val, cds::opt::details::make_comparator_from_less<Less>() );
+ CDS_UNUSED( pred );
+ return find_at( const_cast<node_type *>( &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 ) const
+ {
+ return contains( key, pred );
+ }
+ //@endcond
- /// Finds the key \p val and return the item found
+ /// Finds the key \p key and return the item found
/** \anchor cds_intrusive_LazyList_rcu_get
- The function searches the item with key equal to \p val and returns the pointer to item found.
- If \p val is not found it returns \p NULL.
+ The function searches the item with key equal to \p key and returns the pointer to item found.
+ If \p key is not found it returns \p nullptr.
Note the compare functor should accept a parameter of type \p Q that can be not the same as \p value_type.
// ...
{
// Lock RCU
- ord_list::rcu_lock lock;
+ typename ord_list::rcu_lock lock;
foo * pVal = theList.get( 5 );
if ( pVal ) {
\endcode
*/
template <typename Q>
- value_type * get( Q const& val ) const
+ value_type * get( Q const& key ) const
{
- return get_at( const_cast<node_type *>( &m_Head ), val, key_comparator());
+ return get_at( const_cast<node_type *>( &m_Head ), key, key_comparator());
}
- /// Finds the key \p val and return the item found
+ /// Finds the key \p key and return the item found
/**
The function is an analog of \ref cds_intrusive_LazyList_rcu_get "get(Q const&)"
but \p pred is used for comparing the keys.
\p pred must imply the same element order as the comparator used for building the list.
*/
template <typename Q, typename Less>
- value_type * get_with( Q const& val, Less pred ) const
+ value_type * get_with( Q const& key, Less pred ) const
{
- return get_at( const_cast<node_type *>( &m_Head ), val, cds::opt::details::make_comparator_from_less<Less>());
+ CDS_UNUSED( pred );
+ return get_at( const_cast<node_type *>( &m_Head ), key, cds::opt::details::make_comparator_from_less<Less>());
}
/// Clears the list using default disposer
RCU \p synchronize method can be called.
Note that depending on RCU type used the \ref disposer call can be deferred.
- The function can throw cds::urcu::rcu_deadlock exception if deadlock is encountered and
- deadlock checking policy is opt::v::rcu_throw_deadlock.
+ The function can throw \p cds::urcu::rcu_deadlock exception if deadlock is encountered and
+ deadlock checking policy is \p opt::v::rcu_throw_deadlock.
*/
void clear()
{
- if( !empty() ) {
- check_deadlock_policy::check();
+ if( !empty()) {
+ deadlock_policy::check();
node_type * pHead;
for (;;) {
assert( pNode != nullptr );
// Hack: convert node_type to value_type.
- // In principle, auxiliary node can be non-reducible to value_type
+ // Actually, an auxiliary node should not be converted to value_type
// We assume that comparator can correctly distinguish aux and regular node.
- return insert_at( pHead, *node_traits::to_value_ptr( pNode ) );
+ return insert_at( pHead, *node_traits::to_value_ptr( pNode ));
}
- bool insert_at( node_type * pHead, value_type& val, bool bLock = true )
+ bool insert_at( node_type * pHead, value_type& val )
{
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
- position pos;
- key_comparator cmp;
-
- rcu_lock l( bLock );
- while ( true ) {
- search( pHead, val, pos );
- {
- auto_lock_position 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
- return false;
- }
- else {
- link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
- ++m_ItemCounter;
- return true;
- }
- }
- }
- }
+ rcu_lock l;
+ return insert_at_locked( pHead, val );
}
template <typename Func>
bool insert_at( node_type * pHead, value_type& val, Func f )
{
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
+ link_checker::is_empty( node_traits::to_node_ptr( val ));
position pos;
key_comparator cmp;
while ( true ) {
search( pHead, val, pos );
{
- auto_lock_position alp( pos );
+ scoped_position_lock sl( 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
return false;
}
- else {
- link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
- cds::unref(f)( val );
- ++m_ItemCounter;
- return true;
- }
+
+ f( val );
+ link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
+ ++m_ItemCounter;
+ return true;
}
}
}
}
- iterator insert_at_( node_type * pHead, value_type& val, bool bLock = true )
+ iterator insert_at_( node_type * pHead, value_type& val )
{
- rcu_lock l( bLock );
- if ( insert_at( pHead, val, false ))
+ rcu_lock l;
+ if ( insert_at_locked( pHead, val ))
return iterator( node_traits::to_node_ptr( val ));
return end();
}
template <typename Func>
- std::pair<iterator, bool> ensure_at_( node_type * pHead, value_type& val, Func func, bool bLock = true )
+ std::pair<iterator, bool> update_at_( node_type * pHead, value_type& val, Func func, bool bAllowInsert )
{
- position pos;
- key_comparator cmp;
-
- rcu_lock l( bLock );
- while ( true ) {
- search( pHead, val, pos );
- {
- auto_lock_position 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
-
- cds::unref(func)( false, *node_traits::to_value_ptr( *pos.pCur ) , val );
- return std::make_pair( iterator( pos.pCur ), false );
- }
- else {
- // new key
- link_checker::is_empty( node_traits::to_node_ptr( val ) );
-
- link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
- cds::unref(func)( true, val, val );
- ++m_ItemCounter;
- return std::make_pair( iterator( node_traits::to_node_ptr( val )), true );
- }
- }
- }
- }
+ rcu_lock l;
+ return update_at_locked( pHead, val, func, bAllowInsert );
}
template <typename Func>
- std::pair<bool, bool> ensure_at( node_type * pHead, value_type& val, Func func, bool bLock = true )
+ std::pair<bool, bool> update_at( node_type * pHead, value_type& val, Func func, bool bAllowInsert )
{
- rcu_lock l( bLock );
- std::pair<iterator, bool> ret = ensure_at_( pHead, val, func, false );
+ rcu_lock l;
+ std::pair<iterator, bool> ret = update_at_locked( pHead, val, func, bAllowInsert );
return std::make_pair( ret.first != end(), ret.second );
}
{
position pos;
key_comparator cmp;
- check_deadlock_policy::check();
+ deadlock_policy::check();
while ( true ) {
int nResult = 0;
rcu_lock l;
search( pHead, val, pos );
{
- 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 )
}
template <typename Q, typename Compare, typename Func>
- bool erase_at( node_type * pHead, Q const& val, Compare cmp, Func f, position& pos )
+ bool erase_at( node_type * const pHead, Q const& val, Compare cmp, Func f, position& pos )
{
- check_deadlock_policy::check();
+ deadlock_policy::check();
while ( true ) {
int nResult = 0;
rcu_lock l;
search( pHead, val, pos, cmp );
{
- 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 );
- cds::unref(f)( *node_traits::to_value_ptr( *pos.pCur ) );
+ f( *node_traits::to_value_ptr( *pos.pCur ));
--m_ItemCounter;
nResult = 1;
}
- else {
+ else
nResult = -1;
- }
}
}
}
bool erase_at( node_type * pHead, Q const& val, Compare cmp )
{
position pos;
-# ifdef CDS_CXX11_LAMBDA_SUPPORT
- return erase_at( pHead, val, cmp, [](value_type const &){}, pos );
-# else
- return erase_at( pHead, val, cmp, empty_erase_functor(), pos );
-# endif
+ return erase_at( pHead, val, cmp, [](value_type const&){}, pos );
}
template <typename Q, typename Compare>
- value_type * extract_at( node_type * pHead, Q const& val, Compare cmp )
+ value_type * extract_at( node_type * const pHead, Q const& val, Compare cmp )
{
position pos;
- assert( gc::is_locked() ) ; // RCU must be locked!!!
+ assert( gc::is_locked()) ; // RCU must be locked
while ( true ) {
search( pHead, val, pos, cmp );
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
}
template <typename Q, typename Compare, typename Func>
- bool find_at( node_type * pHead, Q& val, Compare cmp, Func f, bool bLock = true ) const
+ bool find_at( node_type * pHead, Q& val, Compare cmp, Func f ) const
{
position pos;
- rcu_lock l( bLock );
+ rcu_lock l;
search( pHead, val, pos, cmp );
if ( pos.pCur != &m_Tail ) {
- cds::lock::scoped_lock< typename node_type::lock_type> al( pos.pCur->m_Lock );
+ std::unique_lock< typename node_type::lock_type> al( pos.pCur->m_Lock );
if ( cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 )
{
- cds::unref(f)( *node_traits::to_value_ptr( *pos.pCur ), val );
+ f( *node_traits::to_value_ptr( *pos.pCur ), val );
return true;
}
}
template <typename Q, typename Compare>
const_iterator find_at_( node_type * pHead, Q& val, Compare cmp ) const
{
- assert( gc::is_locked() );
+ assert( gc::is_locked());
position pos;
search( pHead, val, pos, cmp );
if ( pos.pCur != &m_Tail ) {
- cds::lock::scoped_lock< typename node_type::lock_type> al( pos.pCur->m_Lock );
if ( cmp( *node_traits::to_value_ptr( *pos.pCur ), val ) == 0 )
- {
return const_iterator( pos.pCur );
- }
}
return end();
}
template <typename Q, typename Compare>
value_type * get_at( node_type * pHead, Q const& val, Compare cmp ) const
{
-# ifdef CDS_CXX11_LAMBDA_SUPPORT
value_type * pFound = nullptr;
return find_at( pHead, val, cmp, [&pFound](value_type& found, Q const& ) { pFound = &found; } )
? pFound : nullptr;
-# else
- get_functor gf;
- return find_at( pHead, val, cmp, cds::ref( gf ) ) ? gf.pFound : nullptr;
-# endif
}
//@endcond
protected:
//@cond
template <typename Q>
- void search( node_type * pHead, Q const& key, position& pos ) const
+ void search( node_type * const pHead, Q const& key, position& pos ) const
{
- search( pHead, key, pos, key_comparator() );
+ search( pHead, key, pos, key_comparator());
}
template <typename Q, typename Compare>
- void search( node_type * pHead, Q const& key, position& pos, Compare cmp ) const
+ void search( node_type * const pHead, Q const& key, position& pos, Compare cmp ) const
{
- // RCU should be locked!!!
- assert( gc::is_locked() );
+ // RCU should be locked
+ assert( gc::is_locked());
node_type const* pTail = &m_Tail;
marked_node_ptr pCur(pHead);
marked_node_ptr pPrev(pHead);
- while ( pCur.ptr() != pTail && ( pCur.ptr() == pHead || cmp( *node_traits::to_value_ptr( *pCur.ptr() ), key ) < 0 )) {
+ while ( pCur != pTail && ( pCur == pHead || cmp( *node_traits::to_value_ptr( *pCur.ptr()), key ) < 0 )) {
pPrev = pCur;
- pCur = pCur->m_pNext.load(memory_model::memory_order_relaxed);
+ pCur = pCur->m_pNext.load(memory_model::memory_order_acquire);
+ if ( pCur.bits())
+ pPrev = pCur = pHead;
}
pos.pCur = pCur.ptr();
pos.pPred = pPrev.ptr();
}
- static bool validate( node_type * pPred, node_type * pCur )
+ static bool validate( node_type * pPred, node_type * pCur ) CDS_NOEXCEPT
{
- // RCU lock should be locked!!!
- assert( gc::is_locked() );
+ // RCU lock should be locked
+ assert( gc::is_locked());
return !pPred->is_marked()
&& !pCur->is_marked()
}
//@endcond
+
+ private:
+ //@cond
+ bool insert_at_locked( node_type * pHead, value_type& val )
+ {
+ // RCU lock should be locked
+ assert( gc::is_locked());
+
+ link_checker::is_empty( node_traits::to_node_ptr( val ));
+ position pos;
+ key_comparator cmp;
+
+ while ( true ) {
+ search( pHead, val, 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
+ return false;
+ }
+
+ link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
+ ++m_ItemCounter;
+ return true;
+ }
+ }
+ }
+ }
+
+ template <typename Func>
+ std::pair<iterator, bool> update_at_locked( node_type * pHead, value_type& val, Func func, bool bAllowInsert )
+ {
+ // RCU lock should be locked
+ assert( gc::is_locked());
+
+ position pos;
+ key_comparator cmp;
+
+ while ( true ) {
+ search( pHead, val, 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 );
+ return std::make_pair( iterator( pos.pCur ), false );
+ }
+ else {
+ // new key
+ if ( !bAllowInsert )
+ return std::make_pair( end(), false );
+
+ link_checker::is_empty( node_traits::to_node_ptr( val ));
+
+ func( true, val, val );
+ link_node( node_traits::to_node_ptr( val ), pos.pPred, pos.pCur );
+ ++m_ItemCounter;
+ return std::make_pair( iterator( node_traits::to_node_ptr( val )), true );
+ }
+ }
+ }
+ }
+ }
+ //@endcond
};
}} // namespace cds::intrusive
-#endif // #ifndef __CDS_INTRUSIVE_LAZY_LIST_RCU_H
+#endif // #ifndef CDSLIB_INTRUSIVE_LAZY_LIST_RCU_H