Fixed doc typo

[libcds.git] / cds / container / michael_list_rcu.h

diff --git a/cds/container/michael_list_rcu.h b/cds/container/michael_list_rcu.h
index 6d0b5daf391952ced087744e5f5b6a02b9185a7d..61d16235f90d4b07ec0d88498662fd388460bbae 100644 (file)
--- a/cds/container/michael_list_rcu.h
+++ b/cds/container/michael_list_rcu.h
@@ -1,4 +1,32 @@
-//$$CDS-header$$
+/*
+    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_CONTAINER_MICHAEL_LIST_RCU_H
 #define CDSLIB_CONTAINER_MICHAEL_LIST_RCU_H
 
 #ifndef CDSLIB_CONTAINER_MICHAEL_LIST_RCU_H
 #define CDSLIB_CONTAINER_MICHAEL_LIST_RCU_H


@@ -139,6 +167,7 @@ namespace cds { namespace container {
         using exempt_ptr = cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer >; ///< pointer to extracted node
 
     private:
         using exempt_ptr = cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer >; ///< pointer to extracted node
 
     private:

+        //@cond

         struct raw_ptr_converter
         {
             value_type * operator()( node_type * p ) const
         struct raw_ptr_converter
         {
             value_type * operator()( node_type * p ) const


@@ -156,12 +185,13 @@ namespace cds { namespace container {
                 return n.m_Value;
             }
         };
                 return n.m_Value;
             }
         };

+        //@endcond

 
     public:
         /// Result of \p get(), \p get_with() functions - pointer to the node found
         typedef cds::urcu::raw_ptr_adaptor< value_type, typename base_class::raw_ptr, raw_ptr_converter > raw_ptr;
 
 
     public:
         /// Result of \p get(), \p get_with() functions - pointer to the node found
         typedef cds::urcu::raw_ptr_adaptor< value_type, typename base_class::raw_ptr, raw_ptr_converter > raw_ptr;
 

-    private:
+    protected:

         //@cond
         static value_type& node_to_value( node_type& n )
         {
         //@cond
         static value_type& node_to_value( node_type& n )
         {


@@ -171,10 +201,7 @@ namespace cds { namespace container {
         {
             return n.m_Value;
         }
         {
             return n.m_Value;
         }

-        //@endcond

 
 

-    protected:
-        //@cond

         template <typename Q>
         static node_type * alloc_node( Q const& v )
         {
         template <typename Q>
         static node_type * alloc_node( Q const& v )
         {


@@ -267,7 +294,13 @@ namespace cds { namespace container {
         //@endcond
 
     public:
         //@endcond
 
     public:

+    ///@name Forward iterators (only for debugging purpose)
+    //@{

         /// Forward iterator
         /// Forward iterator

+        /**
+            You may safely use iterators in multi-threaded environment only under RCU lock.
+            Otherwise, a crash is possible if another thread deletes the item the iterator points to.
+        */

         typedef iterator_type<false>    iterator;
 
         /// Const forward iterator
         typedef iterator_type<false>    iterator;
 
         /// Const forward iterator


@@ -296,28 +329,29 @@ namespace cds { namespace container {
         }
 
         /// Returns a forward const iterator addressing the first element in a list
         }
 
         /// Returns a forward const iterator addressing the first element in a list

-        //@{

         const_iterator begin() const
         {
             return const_iterator( head() );
         }
         const_iterator begin() const
         {
             return const_iterator( head() );
         }

+
+        /// Returns a forward const iterator addressing the first element in a list

         const_iterator cbegin() const
         {
             return const_iterator( head() );
         }
         const_iterator cbegin() const
         {
             return const_iterator( head() );
         }

-        //@}

 
         /// Returns an const iterator that addresses the location succeeding the last element in a list
 
         /// Returns an const iterator that addresses the location succeeding the last element in a list

-        //@{

         const_iterator end() const
         {
             return const_iterator();
         }
         const_iterator end() const
         {
             return const_iterator();
         }

+
+        /// Returns an const iterator that addresses the location succeeding the last element in a list

         const_iterator cend() const
         {
             return const_iterator();
         }
         const_iterator cend() const
         {
             return const_iterator();
         }

-        //@}
+    //@}

 
     public:
         /// Default constructor
 
     public:
         /// Default constructor


@@ -386,44 +420,50 @@ namespace cds { namespace container {
             return insert_at( head(), key, func );
         }
 
             return insert_at( head(), key, func );
         }
 

-        /// Ensures that the \p key exists in the list
+        /// Updates data by \p key

         /**
         /**

-            The operation performs inserting or changing data with lock-free manner.
+            The operation performs inserting or replacing the element with lock-free manner.

 
             If the \p key not found in the list, then the new item created from \p key
 
             If the \p key not found in the list, then the new item created from \p key

-            is inserted into the list. Otherwise, the functor \p func is called with the item found.
-            The functor \p Func should be a function with signature:
-            \code
-                void func( bool bNew, value_type& item, const Q& val );
-            \endcode
-            or a functor:
+            will be inserted iff \p bAllowInsert is \p true.
+            Otherwise, if \p key is found, the functor \p func is called with item found.
+
+            The functor \p Func signature is:

             \code
                 struct my_functor {
             \code
                 struct my_functor {

-                    void operator()( bool bNew, value_type& item, const Q& val );
+                    void operator()( bool bNew, value_type& item, Q const& val );

                 };
             \endcode
 
             with arguments:
             - \p bNew - \p true if the item has been inserted, \p false otherwise
             - \p item - item of the list
                 };
             \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 key passed into the \p ensure function
+            - \p val - argument \p key passed into the \p %update() function

 
             The functor may change non-key fields of the \p item; however, \p func must guarantee
             that during changing no any other modifications could be made on this item by concurrent threads.
 
 
             The functor may change non-key fields of the \p item; however, \p func must guarantee
             that during changing no any other modifications could be made on this item by concurrent threads.
 

-            The function makes RCU lock internally.
+            The function applies RCU lock internally.

 
 

-            Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
+            Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successful,

             \p second is true if new item has been added or \p false if the item with \p key
             \p second is true if new item has been added or \p false if the item with \p key

-            already is in the list.
+            already exists.

 
             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
         */
         template <typename Q, typename Func>
 
             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
         */
         template <typename Q, typename Func>

+        std::pair<bool, bool> update( Q const& key, Func func, bool bAllowInsert = true )
+        {
+            return update_at( head(), key, func, bAllowInsert );
+        }
+        //@cond
+        template <typename Q, typename Func>
+        CDS_DEPRECATED("ensure() is deprecated, use update()")

         std::pair<bool, bool> ensure( Q const& key, Func f )
         {
         std::pair<bool, bool> ensure( Q const& key, Func f )
         {

-            return ensure_at( head(), key, f );
+            return update( key, f, true );

         }
         }

+        //@endcond

 
         /// Inserts data of type \ref value_type constructed from \p args
         /**
 
         /// Inserts data of type \ref value_type constructed from \p args
         /**


@@ -517,8 +557,8 @@ namespace cds { namespace container {
             If the item with the key equal to \p key is not found the function returns an empty \p exempt_ptr.
 
             @note The function does NOT dispose the item found. It just excludes the item from the list
             If the item with the key equal to \p key is not found the function returns an empty \p exempt_ptr.
 
             @note The function does NOT dispose the item found. It just excludes the item from the list

-            and returns a pointer to item found.
-            You shouldn't lock RCU before calling this function.
+            and returns a pointer to the item.
+            You shouldn't lock RCU for current thread before calling this function.

 
             \code
             #include <cds/urcu/general_buffered.h>
 
             \code
             #include <cds/urcu/general_buffered.h>


@@ -534,7 +574,7 @@ namespace cds { namespace container {
 
             // The RCU should NOT be locked when extract() is called!
             assert( !rcu::is_locked() );
 
             // The RCU should NOT be locked when extract() is called!
             assert( !rcu::is_locked() );

-                
+

             // extract() call
             p = theList.extract( 10 )
             if ( p ) {
             // extract() call
             p = theList.extract( 10 )
             if ( p ) {


@@ -568,32 +608,48 @@ namespace cds { namespace container {
             return exempt_ptr( extract_at( head(), key, typename maker::template less_wrapper<Less>::type() ));
         }
 
             return exempt_ptr( extract_at( head(), key, typename maker::template less_wrapper<Less>::type() ));
         }
 

-        /// Finds the key \p key
-        /** \anchor cds_nonintrusive_MichaelList_rcu_find_val
+        /// Checks whether the list contains \p key
+        /**

             The function searches the item with key equal to \p key
             and returns \p true if it is found, and \p false otherwise.
 
             The function searches the item with key equal to \p key
             and returns \p true if it is found, and \p false otherwise.
 

-            The function makes RCU lock internally.
+            The function applies RCU lock internally.

         */
         template <typename Q>
         */
         template <typename Q>

-        bool find( Q const& key )
+        bool contains( Q const& key )

         {
             return find_at( head(), key, intrusive_key_comparator() );
         }
         {
             return find_at( head(), key, intrusive_key_comparator() );
         }

+        //@cond
+        template <typename Q>
+        CDS_DEPRECATED("deprecated, use contains()")
+        bool find( Q const& key )
+        {
+            return contains( key );
+        }
+        //@endcond

 
 

-        /// Finds the key \p val using \p pred predicate for searching
+        /// Checks whether the list contains \p key using \p pred predicate for searching

         /**
         /**

-            The function is an analog of \ref cds_nonintrusive_MichaelList_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.
         */
         template <typename Q, typename Less>
             \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>

-        bool find_with( Q const& key, Less pred )
+        bool contains( Q const& key, Less pred )

         {
             CDS_UNUSED( pred );
             return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
         }
         {
             CDS_UNUSED( pred );
             return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
         }

+        //@cond
+        // Deprecatd, use contains()
+        template <typename Q, typename Less>
+        bool find_with( Q const& key, Less pred )
+        {
+            CDS_UNUSED( pred );
+            return contains( key, pred );
+        }
+        //@endcond

 
         /// Finds the key \p key and performs an action with it
         /** \anchor cds_nonintrusive_MichaelList_rcu_find_func
 
         /// Finds the key \p key and performs an action with it
         /** \anchor cds_nonintrusive_MichaelList_rcu_find_func


@@ -729,6 +785,11 @@ namespace cds { namespace container {
 
     protected:
         //@cond
 
     protected:
         //@cond

+        bool insert_node( node_type * pNode )
+        {
+            return insert_node_at( head(), pNode );
+        }
+

         bool insert_node_at( head_type& refHead, node_type * pNode )
         {
             assert( pNode );
         bool insert_node_at( head_type& refHead, node_type * pNode )
         {
             assert( pNode );


@@ -772,12 +833,13 @@ namespace cds { namespace container {
         }
 
         template <typename Q, typename Func>
         }
 
         template <typename Q, typename Func>

-        std::pair<bool, bool> ensure_at( head_type& refHead, Q const& key, Func f )
+        std::pair<bool, bool> update_at( head_type& refHead, Q const& key, Func f, bool bAllowInsert )

         {
             scoped_node_ptr pNode( alloc_node( key ));
 
         {
             scoped_node_ptr pNode( alloc_node( key ));
 

-            std::pair<bool, bool> ret = base_class::ensure_at( refHead, *pNode,
-                [&f, &key](bool bNew, node_type& node, node_type&){ f( bNew, node_to_value(node), key ); });
+            std::pair<bool, bool> ret = base_class::update_at( refHead, *pNode,
+                [&f, &key](bool bNew, node_type& node, node_type&){ f( bNew, node_to_value(node), key );},
+                bAllowInsert );

             if ( ret.first && ret.second )
                 pNode.release();
 
             if ( ret.first && ret.second )
                 pNode.release();