[TSan] Fixed data race: added compiler barriers, tuned memory ordering
[libcds.git] / cds / container / split_list_set_nogc.h
index 89c5acf5ecb174eb3f81694641fcf5c83a681af9..ffc98b8415f27dba9ec42ce16aa06d90fedd180d 100644 (file)
@@ -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_SPLIT_LIST_SET_NOGC_H
 #define CDSLIB_CONTAINER_SPLIT_LIST_SET_NOGC_H
@@ -109,21 +137,13 @@ namespace cds { namespace container {
         {}
 
     protected:
-        /// Forward iterator
-        /**
-            \p IsConst - constness boolean flag
-
-            The forward iterator has the following features:
-            - it has no post-increment operator
-            - it depends on underlying ordered list iterator
-        */
+        //@cond
         template <bool IsConst>
         class iterator_type: protected base_class::template iterator_type<IsConst>
         {
-            //@cond
             typedef typename base_class::template iterator_type<IsConst> iterator_base_class;
             friend class SplitListSet;
-            //@endcond
+
         public:
             /// Value pointer type (const for const iterator)
             typedef typename cds::details::make_const_type<value_type, IsConst>::pointer   value_ptr;
@@ -141,11 +161,9 @@ namespace cds { namespace container {
             {}
 
         protected:
-            //@cond
             explicit iterator_type( iterator_base_class const& src )
                 : iterator_base_class( src )
             {}
-            //@endcond
 
         public:
             /// Dereference operator
@@ -188,9 +206,45 @@ namespace cds { namespace container {
                 return iterator_base_class::operator!=(i);
             }
         };
+        //@endcond
 
     public:
+    ///@name Forward iterators
+    //@{
         /// Forward iterator
+        /**
+            The forward iterator for split-list is based on \p OrderedList forward iterator and has some features:
+            - it has no post-increment operator
+            - it iterates items in unordered fashion
+
+            The iterator interface:
+            \code
+            class iterator {
+            public:
+                // Default constructor
+                iterator();
+
+                // Copy construtor
+                iterator( iterator const& src );
+
+                // Dereference operator
+                value_type * operator ->() const;
+
+                // Dereference operator
+                value_type& operator *() const;
+
+                // Preincrement operator
+                iterator& operator ++();
+
+                // Assignment operator
+                iterator& operator = (iterator const& src);
+
+                // Equality operators
+                bool operator ==(iterator const& i ) const;
+                bool operator !=(iterator const& i ) const;
+            };
+            \endcode
+        */
         typedef iterator_type<false>  iterator;
 
         /// Const forward iterator
@@ -202,7 +256,7 @@ namespace cds { namespace container {
         */
         iterator begin()
         {
-            return iterator( base_class::begin() );
+            return iterator( base_class::begin());
         }
 
         /// Returns an iterator that addresses the location succeeding the last element in a set
@@ -213,7 +267,7 @@ namespace cds { namespace container {
         */
         iterator end()
         {
-            return iterator( base_class::end() );
+            return iterator( base_class::end());
         }
 
         /// Returns a forward const iterator addressing the first element in a set
@@ -224,7 +278,7 @@ namespace cds { namespace container {
         /// Returns a forward const iterator addressing the first element in a set
         const_iterator cbegin() const
         {
-            return const_iterator( base_class::cbegin() );
+            return const_iterator( base_class::cbegin());
         }
 
         /// Returns an const iterator that addresses the location succeeding the last element in a set
@@ -235,8 +289,9 @@ namespace cds { namespace container {
         /// Returns an const iterator that addresses the location succeeding the last element in a set
         const_iterator cend() const
         {
-            return const_iterator( base_class::cend() );
+            return const_iterator( base_class::cend());
         }
+    //@}
 
     protected:
         //@cond
@@ -246,7 +301,7 @@ namespace cds { namespace container {
             scoped_node_ptr p(pNode);
 
             iterator it( base_class::insert_( *pNode ));
-            if ( it != end() ) {
+            if ( it != end()) {
                 p.release();
                 return it;
             }
@@ -267,7 +322,7 @@ namespace cds { namespace container {
         template <typename Q>
         iterator insert( const Q& val )
         {
-            return insert_node( alloc_node( val ) );
+            return insert_node( alloc_node( val ));
         }
 
         /// Inserts data of type \p value_type created from \p args
@@ -277,7 +332,7 @@ namespace cds { namespace container {
         template <typename... Args>
         iterator emplace( Args&&... args )
         {
-            return insert_node( alloc_node( std::forward<Args>(args)... ) );
+            return insert_node( alloc_node( std::forward<Args>(args)... ));
         }
 
         /// Updates the item
@@ -286,13 +341,16 @@ namespace cds { namespace container {
             Otherwise, the function returns an iterator pointing to the item found.
 
             Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
-            item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()), 
+            item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()),
+
             \p second is true if new item has been added or \p false if the item
             already is in the set.
 
-            @warning If the set is based on \ref cds_nonintrusive_MichaelList_nogc "MichaelList", 
+            @warning If the set is based on \ref cds_nonintrusive_MichaelList_nogc "MichaelList",
+
             see \ref cds_intrusive_item_creating "insert item troubleshooting".
-            \ref cds_nonintrusive_LazyList_nogc "LazyList" as the base provides exclusive access to inserted item 
+            \ref cds_nonintrusive_LazyList_nogc "LazyList" as the base provides exclusive access to inserted item
+
             and does not require any node-level synchronization.
         */
         template <typename Q>
@@ -300,7 +358,8 @@ namespace cds { namespace container {
         {
             scoped_node_ptr pNode( alloc_node( key ));
 
-            std::pair<typename base_class::iterator, bool> ret = base_class::update_( *pNode, 
+            std::pair<typename base_class::iterator, bool> ret = base_class::update_( *pNode,
+
                 [](bool /*bNew*/, node_type& /*item*/, node_type& /*val*/){},
                 bAllowInsert );
             if ( ret.first != base_class::end() && ret.second ) {
@@ -311,8 +370,8 @@ namespace cds { namespace container {
             return std::make_pair( iterator(ret.first), ret.second );
         }
         //@cond
-        // Deprecated, use update()
         template <typename Q>
+        CDS_DEPRECATED("ensure() is deprecated, use update()")
         std::pair<iterator, bool> ensure( const Q& val )
         {
             return update( val, true );
@@ -330,8 +389,8 @@ namespace cds { namespace container {
             return iterator( base_class::find_( key ));
         }
         //@cond
-        // Deprecated, use contains()
         template <typename Q>
+        CDS_DEPRECATED("deprecated, use contains()")
         iterator find( Q const& key )
         {
             return contains( key );
@@ -348,7 +407,7 @@ namespace cds { namespace container {
         iterator contains( Q const& key, Less pred )
         {
             CDS_UNUSED( pred );
-            return iterator( base_class::find_with_( key, typename maker::template predicate_wrapper<Less>::type() ));
+            return iterator( base_class::find_with_( key, typename maker::template predicate_wrapper<Less>::type()));
         }
         //@cond
         // eprecated, use contains()
@@ -359,6 +418,12 @@ namespace cds { namespace container {
         }
         //@endcond
 
+        /// Clears the set (not atomic, for debugging purposes only)
+        void clear()
+        {
+            base_class::clear();
+        }
+
         /// Checks if the set is empty
         /**
             Emptiness is checked by item counting: if item count is zero then the set is empty.
@@ -380,6 +445,12 @@ namespace cds { namespace container {
         {
             return base_class::statistics();
         }
+
+        /// Returns internal statistics for \p ordered_list
+        typename ordered_list::stat const& list_statistics() const
+        {
+            return base_class::list_statistics();
+        }
     };
 
 }}  // namespace cds::container