Docfix

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

diff --git a/cds/container/lazy_kvlist_rcu.h b/cds/container/lazy_kvlist_rcu.h
index 6c7fd54ce398a52efbe80f2eb3fd72a7e700036e..e3cd14f20dbc2a346feec19ef164e5843c9e2fb3 100644 (file)
--- a/cds/container/lazy_kvlist_rcu.h
+++ b/cds/container/lazy_kvlist_rcu.h
@@ -1,7 +1,35 @@
-//$$CDS-header$$
+/*
+    This file is a part of libcds - Concurrent Data Structures library

 
 

-#ifndef __CDS_CONTAINER_LAZY_KVLIST_RCU_H
-#define __CDS_CONTAINER_LAZY_KVLIST_RCU_H
+    (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_LAZY_KVLIST_RCU_H
+#define CDSLIB_CONTAINER_LAZY_KVLIST_RCU_H

 
 #include <memory>
 #include <cds/container/details/lazy_list_base.h>
 
 #include <memory>
 #include <cds/container/details/lazy_list_base.h>


@@ -90,6 +118,7 @@ namespace cds { namespace container {
 
     public:
         typedef cds::urcu::gc<RCU> gc; ///< Garbage collector
 
     public:
         typedef cds::urcu::gc<RCU> gc; ///< Garbage collector

+        typedef Traits traits;         ///< List traits

 #ifdef CDS_DOXYGEN_INVOKED
         typedef Key                                 key_type        ;   ///< Key type
         typedef Value                               mapped_type     ;   ///< Type of value stored in the list
 #ifdef CDS_DOXYGEN_INVOKED
         typedef Key                                 key_type        ;   ///< Key type
         typedef Value                               mapped_type     ;   ///< Type of value stored in the list


@@ -104,11 +133,28 @@ namespace cds { namespace container {
         typedef typename base_class::item_counter item_counter;   ///< Item counting policy used
         typedef typename maker::key_comparator    key_comparator; ///< key comparison functor
         typedef typename base_class::memory_model memory_model;   ///< Memory ordering. See cds::opt::memory_model option
         typedef typename base_class::item_counter item_counter;   ///< Item counting policy used
         typedef typename maker::key_comparator    key_comparator; ///< key comparison functor
         typedef typename base_class::memory_model memory_model;   ///< Memory ordering. See cds::opt::memory_model option

+        typedef typename base_class::stat         stat;           ///< Internal statistics

         typedef typename base_class::rcu_check_deadlock rcu_check_deadlock ; ///< RCU deadlock checking policy
 
         typedef typename gc::scoped_lock    rcu_lock ;  ///< RCU scoped lock
         static CDS_CONSTEXPR const bool c_bExtractLockExternal = base_class::c_bExtractLockExternal; ///< Group of \p extract_xxx functions require external locking
 
         typedef typename base_class::rcu_check_deadlock rcu_check_deadlock ; ///< RCU deadlock checking policy
 
         typedef typename gc::scoped_lock    rcu_lock ;  ///< RCU scoped lock
         static CDS_CONSTEXPR const bool c_bExtractLockExternal = base_class::c_bExtractLockExternal; ///< Group of \p extract_xxx functions require external locking
 

+        //@cond
+        // Rebind traits (split-list support)
+        template <typename... Options>
+        struct rebind_traits {
+            typedef LazyKVList<
+                gc
+                , key_type, mapped_type
+                , typename cds::opt::make_options< traits, Options...>::type
+            > type;
+        };
+
+        // Stat selector
+        template <typename Stat>
+        using select_stat_wrapper = typename base_class::template select_stat_wrapper< Stat >;
+        //@endcond
+

     protected:
         //@cond
         typedef typename base_class::value_type   node_type;
     protected:
         //@cond
         typedef typename base_class::value_type   node_type;


@@ -124,6 +170,8 @@ namespace cds { namespace container {
         using exempt_ptr = cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer,
             cds::urcu::details::conventional_exempt_pair_cast<node_type, value_type>
         >;
         using exempt_ptr = cds::urcu::exempt_ptr< gc, node_type, value_type, typename maker::intrusive_traits::disposer,
             cds::urcu::details::conventional_exempt_pair_cast<node_type, value_type>
         >;

+        /// Type of \p get() member function return value
+        typedef value_type * raw_ptr;

 
     protected:
         //@cond
 
     protected:
         //@cond


@@ -188,10 +236,10 @@ namespace cds { namespace container {
             typedef typename base_class::template iterator_type<IsConst>    iterator_base;
 
             iterator_type( head_type const& pNode )
             typedef typename base_class::template iterator_type<IsConst>    iterator_base;
 
             iterator_type( head_type const& pNode )

-                : iterator_base( const_cast<head_type *>(&pNode) )
+                : iterator_base( const_cast<head_type *>(&pNode))

             {}
             iterator_type( head_type const * pNode )
             {}
             iterator_type( head_type const * pNode )

-                : iterator_base( const_cast<head_type *>(pNode) )
+                : iterator_base( const_cast<head_type *>(pNode))

             {}
 
             friend class LazyKVList;
             {}
 
             friend class LazyKVList;


@@ -257,7 +305,13 @@ namespace cds { namespace container {
         //@endcond
 
     public:
         //@endcond
 
     public:

+    ///@name Forward iterators
+    //@{

         /// Forward iterator
         /// Forward iterator

+        /**
+            You may safely use iterators in multi-threaded environment only under external RCU lock.
+            Otherwise, a program 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


@@ -269,7 +323,7 @@ namespace cds { namespace container {
         */
         iterator begin()
         {
         */
         iterator begin()
         {

-            iterator it( head() );
+            iterator it( head());

             ++it ;  // skip dummy head
             return it;
         }
             ++it ;  // skip dummy head
             return it;
         }


@@ -284,42 +338,50 @@ namespace cds { namespace container {
         */
         iterator end()
         {
         */
         iterator end()
         {

-            return iterator( tail() );
+            return iterator( tail());

         }
 
         /// 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
         {
         const_iterator begin() const
         {

-            const_iterator it( head() );
+            const_iterator it( head());

             ++it;   // skip dummy head
             return it;
         }
             ++it;   // skip dummy head
             return it;
         }

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

         const_iterator cbegin() const
         {
         const_iterator cbegin() const
         {

-            const_iterator it( head() );
+            const_iterator it( head());

             ++it;   // skip dummy head
             return it;
         }
             ++it;   // skip dummy head
             return it;
         }

-        //@}

 
         /// 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( tail());
         }
         const_iterator end() const
         {
             return const_iterator( tail());
         }

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

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

-        //@}
+    //@}

 
     public:
         /// Default constructor
         LazyKVList()
         {}
 
 
     public:
         /// Default constructor
         LazyKVList()
         {}
 

+        //@cond
+        template <typename Stat, typename = std::enable_if<std::is_same<stat, lazy_list::wrapped_stat<Stat>>::value >>
+        explicit LazyKVList( Stat& st )
+            : base_class( st )
+        {}
+        //@endcond
+

         /// Destructor clears the list
         ~LazyKVList()
         {
         /// Destructor clears the list
         ~LazyKVList()
         {


@@ -409,44 +471,48 @@ namespace cds { namespace container {
             return emplace_at( head(), std::forward<Args>(args)... );
         }
 
             return emplace_at( head(), std::forward<Args>(args)... );
         }
 

-        /// 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 (note that in this case the \ref key_type should be
-            copy-constructible from type \p K).
-            Otherwise, the functor \p func is called with item found.
-            The functor \p Func may be a function with signature:
-            \code
-                void func( bool bNew, value_type& item );
-            \endcode
-            or a functor:
+            will be inserted iff \p bAllowInsert is \p true.
+            (note that in this case the \ref key_type should be constructible from type \p K).
+            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 {
                     void operator()( bool bNew, value_type& item );
                 };
             \endcode
             \code
                 struct my_functor {
                     void operator()( bool bNew, value_type& item );
                 };
             \endcode

-

             with arguments:
             - \p bNew - \p true if the item has been inserted, \p false otherwise
             with arguments:
             - \p bNew - \p true if the item has been inserted, \p false otherwise

-            - \p item - item of the list
+            - \p item - the item found or inserted

 
 

-            The functor may change any fields of the \p item.second of type \p mapped_type.
+            The functor may change any fields of the \p item.second of \p mapped_type;
+            during \p func call \p item is locked so it is safe to modify the item in
+            multi-threaded environment.

 
 

-            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.
-
-            @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
+            already exists.

         */
         template <typename K, typename Func>
         */
         template <typename K, typename Func>

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

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

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

         }
         }

+        //@endcond

 
         /// Deletes \p key from the list
         /** \anchor cds_nonintrusive_LazyKVList_rcu_erase
 
         /// Deletes \p key from the list
         /** \anchor cds_nonintrusive_LazyKVList_rcu_erase


@@ -458,7 +524,7 @@ namespace cds { namespace container {
         template <typename K>
         bool erase( K const& key )
         {
         template <typename K>
         bool erase( K const& key )
         {

-            return erase_at( head(), key, intrusive_key_comparator() );
+            return erase_at( head(), key, intrusive_key_comparator());

         }
 
         /// Deletes the item from the list using \p pred predicate for searching
         }
 
         /// Deletes the item from the list using \p pred predicate for searching


@@ -472,7 +538,7 @@ namespace cds { namespace container {
         bool erase_with( K const& key, Less pred )
         {
             CDS_UNUSED( pred );
         bool erase_with( K const& key, Less pred )
         {
             CDS_UNUSED( pred );

-            return erase_at( head(), key, typename maker::template less_wrapper<Less>::type() );
+            return erase_at( head(), key, typename maker::template less_wrapper<Less>::type());

         }
 
         /// Deletes \p key from the list
         }
 
         /// Deletes \p key from the list


@@ -559,7 +625,7 @@ namespace cds { namespace container {
 
         /// Extracts an item from the list using \p pred predicate for searching
         /**
 
         /// Extracts an item from the list using \p pred predicate for searching
         /**

-            This function is the analog for \ref cds_nonintrusive_LazyKVList_rcu_extract "extract(exempt_ptr&, K const&)".
+            This function is the analog for \p extract(K 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.
             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.


@@ -568,35 +634,52 @@ namespace cds { namespace container {
         exempt_ptr extract_with( K const& key, Less pred )
         {
             CDS_UNUSED( pred );
         exempt_ptr extract_with( K const& key, Less pred )
         {
             CDS_UNUSED( pred );

-            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_LazyKVList_rcu_find_val
+        /// Checks whether the list contains \p key
+        /**

             The function searches the item with key equal to \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
+            and returns \p true if it is found, and \p false otherwise.

 
             The function applies RCU lock internally.
         */
         template <typename Q>
 
             The function applies RCU lock internally.
         */
         template <typename Q>

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

         bool find( Q const& key ) const
         {
         bool find( Q const& key ) const
         {

-            return find_at( head(), key, intrusive_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_nonintrusive_LazyKVList_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 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.
+
+            The function applies RCU lock internally.

         */
         template <typename Q, typename Less>
         */
         template <typename Q, typename Less>

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

         {
             CDS_UNUSED( pred );
         {
             CDS_UNUSED( pred );

-            return find_at( head(), key, typename maker::template less_wrapper<Less>::type() );
+            return find_at( head(), key, typename maker::template less_wrapper<Less>::type());

         }
         }

+        //@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 key and performs an action with it
         /** \anchor cds_nonintrusive_LazyKVList_rcu_find_func
 
         /// Finds the key \p key and performs an action with it
         /** \anchor cds_nonintrusive_LazyKVList_rcu_find_func


@@ -706,6 +789,12 @@ namespace cds { namespace container {
             return base_class::size();
         }
 
             return base_class::size();
         }
 

+        /// Returns const reference to internal statistics
+        stat const& statistics() const
+        {
+            return base_class::statistics();
+        }
+

         /// Clears the list
         void clear()
         {
         /// Clears the list
         void clear()
         {


@@ -770,12 +859,13 @@ namespace cds { namespace container {
         }
 
         template <typename K, typename Func>
         }
 
         template <typename K, typename Func>

-        std::pair<bool, bool> ensure_at( head_type& refHead, const K& key, Func f )
+        std::pair<bool, bool> update_at( head_type& refHead, const K& 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]( bool bNew, node_type& node, node_type& ){ f( bNew, node.m_Data ); });
+            std::pair<bool, bool> ret = base_class::update_at( &refHead, *pNode,
+                [&f]( bool bNew, node_type& node, node_type& ){ f( bNew, node.m_Data ); },
+                bAllowInsert );

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


@@ -812,4 +902,4 @@ namespace cds { namespace container {
 
 }}  // namespace cds::container
 
 
 }}  // namespace cds::container
 

-#endif  // #ifndef __CDS_CONTAINER_LAZY_KVLIST_RCU_H
+#endif  // #ifndef CDSLIB_CONTAINER_LAZY_KVLIST_RCU_H