Merge pull request #63 from mgalimullin/cmake-update
[libcds.git] / cds / container / fcstack.h
index fb9cbbd51f25e9f1c51996ef02200e177a3eec7c..ba95875ba53ca7e3dfe438e8e84c033d2ff91974 100644 (file)
@@ -1,7 +1,35 @@
-//$$CDS-header$$
-
-#ifndef __CDS_CONTAINER_FCSTACK_H
-#define __CDS_CONTAINER_FCSTACK_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_CONTAINER_FCSTACK_H
+#define CDSLIB_CONTAINER_FCSTACK_H
 
 #include <cds/algo/flat_combining.h>
 #include <cds/algo/elimination_opt.h>
@@ -47,34 +75,28 @@ namespace cds { namespace container {
         };
 
         /// FCStack type traits
-        struct type_traits: public cds::algo::flat_combining::type_traits
+        struct traits: public cds::algo::flat_combining::traits
         {
             typedef empty_stat      stat;   ///< Internal statistics
-            static CDS_CONSTEXPR_CONST bool enable_elimination = false; ///< Enable \ref cds_elimination_description "elimination"
+            static CDS_CONSTEXPR const bool enable_elimination = false; ///< Enable \ref cds_elimination_description "elimination"
         };
 
         /// Metafunction converting option list to traits
         /**
-            This is a wrapper for <tt> cds::opt::make_options< type_traits, Options...> </tt>
             \p Options are:
-            - \p opt::lock_type - mutex type, default is \p cds::lock::Spin
-            - \p opt::back_off - back-off strategy, defalt is \p cds::backoff::Default
-            - \p opt::allocator - allocator type, default is \ref CDS_DEFAULT_ALLOCATOR
-            - \p opt::stat - internal statistics, possible type: \ref stat, \ref empty_stat (the default)
-            - \p opt::memory_model - C++ memory ordering model.
-                List of all available memory ordering see opt::memory_model.
-                Default if cds::opt::v:relaxed_ordering
+            - any \p cds::algo::flat_combining::make_traits options
+            - \p opt::stat - internal statistics, possible type: \p fcstack::stat, \p fcstack::empty_stat (the default)
             - \p opt::enable_elimination - enable/disable operation \ref cds_elimination_description "elimination"
                 By default, the elimination is disabled.
         */
-        template <CDS_DECL_OPTIONS8>
+        template <typename... Options>
         struct make_traits {
 #   ifdef CDS_DOXYGEN_INVOKED
             typedef implementation_defined type ;   ///< Metafunction result
 #   else
             typedef typename cds::opt::make_options<
-                typename cds::opt::find_type_traits< type_traits, CDS_OPTIONS8 >::type
-                ,CDS_OPTIONS8
+                typename cds::opt::find_type_traits< traits, Options... >::type
+                ,Options...
             >::type   type;
 #   endif
         };
@@ -91,12 +113,12 @@ namespace cds { namespace container {
         Template parameters:
         - \p T - a value type stored in the stack
         - \p Stack - sequential stack implementation, default is \p std::stack<T>
-        - \p Trats - type traits of flat combining, default is \p fcstack::type_traits
-            \p fcstack::make_traits metafunction can be used to construct specialized \p %type_traits
+        - \p Trats - type traits of flat combining, default is \p fcstack::traits
+            \p fcstack::make_traits metafunction can be used to construct specialized \p %fcstack::traits
     */
     template <typename T,
         class Stack = std::stack<T>,
-        typename Traits = fcstack::type_traits
+        typename Traits = fcstack::traits
     >
     class FCStack
 #ifndef CDS_DOXYGEN_INVOKED
@@ -106,10 +128,10 @@ namespace cds { namespace container {
     public:
         typedef T           value_type;     ///< Value type
         typedef Stack       stack_type;     ///< Sequential stack class
-        typedef Traits      type_traits;    ///< Stack type traits
+        typedef Traits      traits;         ///< Stack traits
 
-        typedef typename type_traits::stat  stat;   ///< Internal statistics type
-        static CDS_CONSTEXPR_CONST bool c_bEliminationEnabled = type_traits::enable_elimination; ///< \p true if elimination is enabled
+        typedef typename traits::stat  stat;   ///< Internal statistics type
+        static CDS_CONSTEXPR const bool c_bEliminationEnabled = traits::enable_elimination; ///< \p true if elimination is enabled
 
     protected:
         //@cond
@@ -118,7 +140,8 @@ namespace cds { namespace container {
             op_push = cds::algo::flat_combining::req_Operation, ///< Push
             op_push_move,   ///< Push (move semantics)
             op_pop,         ///< Pop
-            op_clear        ///< Clear
+            op_clear,       ///< Clear
+            op_empty        ///< Empty
         };
 
         /// Flat combining publication list record
@@ -133,12 +156,12 @@ namespace cds { namespace container {
         //@endcond
 
         /// Flat combining kernel
-        typedef cds::algo::flat_combining::kernel< fc_record, type_traits > fc_kernel;
+        typedef cds::algo::flat_combining::kernel< fc_record, traits > fc_kernel;
 
     protected:
         //@cond
-        fc_kernel   m_FlatCombining;
-        stack_type  m_Stack;
+        mutable fc_kernel m_FlatCombining;
+        stack_type        m_Stack;
         //@endcond
 
     public:
@@ -160,7 +183,7 @@ namespace cds { namespace container {
         */
         bool push( value_type const& val )
         {
-            fc_record * pRec = m_FlatCombining.acquire_record();
+            auto pRec = m_FlatCombining.acquire_record();
             pRec->pValPush = &val;
 
             if ( c_bEliminationEnabled )
@@ -174,14 +197,13 @@ namespace cds { namespace container {
             return true;
         }
 
-#   ifdef CDS_MOVE_SEMANTICS_SUPPORT
         /// Inserts a new element at the top of stack (move semantics)
         /**
             The content of the new element initialized to a copy of \p val.
         */
         bool push( value_type&& val )
         {
-            fc_record * pRec = m_FlatCombining.acquire_record();
+            auto pRec = m_FlatCombining.acquire_record();
             pRec->pValPush = &val;
 
             if ( c_bEliminationEnabled )
@@ -195,7 +217,6 @@ namespace cds { namespace container {
             m_FlatCombining.internal_statistics().onPushMove();
             return true;
         }
-#   endif
 
         /// Removes the element on top of the stack
         /**
@@ -203,7 +224,7 @@ namespace cds { namespace container {
         */
         bool pop( value_type& val )
         {
-            fc_record * pRec = m_FlatCombining.acquire_record();
+            auto pRec = m_FlatCombining.acquire_record();
             pRec->pValPop = &val;
 
             if ( c_bEliminationEnabled )
@@ -221,7 +242,7 @@ namespace cds { namespace container {
         /// Clears the stack
         void clear()
         {
-            fc_record * pRec = m_FlatCombining.acquire_record();
+            auto pRec = m_FlatCombining.acquire_record();
 
             if ( c_bEliminationEnabled )
                 m_FlatCombining.batch_combine( op_clear, pRec, *this );
@@ -247,10 +268,18 @@ namespace cds { namespace container {
         /**
             If the combining is in process the function waits while combining done.
         */
-        bool empty() const
+        bool empty()
         {
-            m_FlatCombining.wait_while_combining();
-            return m_Stack.empty();
+            auto pRec = m_FlatCombining.acquire_record();
+
+            if ( c_bEliminationEnabled )
+                m_FlatCombining.batch_combine( op_empty, pRec, *this );
+            else
+                m_FlatCombining.combine( op_empty, pRec, *this );
+
+            assert( pRec->is_done() );
+            m_FlatCombining.release_record( pRec );
+            return pRec->bEmpty;
         }
 
         /// Internal statistics
@@ -272,22 +301,22 @@ namespace cds { namespace container {
         {
             assert( pRec );
 
+            // this function is called under FC mutex, so switch TSan off
+            CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN;
             switch ( pRec->op() ) {
             case op_push:
                 assert( pRec->pValPush );
                 m_Stack.push( *(pRec->pValPush ) );
                 break;
-#       ifdef CDS_MOVE_SEMANTICS_SUPPORT
             case op_push_move:
                 assert( pRec->pValPush );
                 m_Stack.push( std::move( *(pRec->pValPush )) );
                 break;
-#       endif
             case op_pop:
                 assert( pRec->pValPop );
                 pRec->bEmpty = m_Stack.empty();
                 if ( !pRec->bEmpty ) {
-                    *(pRec->pValPop) = m_Stack.top();
+                    *(pRec->pValPop) = std::move( m_Stack.top());
                     m_Stack.pop();
                 }
                 break;
@@ -295,15 +324,22 @@ namespace cds { namespace container {
                 while ( !m_Stack.empty() )
                     m_Stack.pop();
                 break;
+            case op_empty:
+                pRec->bEmpty = m_Stack.empty();
+                break;
             default:
                 assert(false);
                 break;
             }
+            CDS_TSAN_ANNOTATE_IGNORE_RW_END;
         }
 
         /// Batch-processing flat combining
         void fc_process( typename fc_kernel::iterator itBegin, typename fc_kernel::iterator itEnd )
         {
+            // this function is called under FC mutex, so switch TSan off
+            CDS_TSAN_ANNOTATE_IGNORE_RW_BEGIN;
+
             typedef typename fc_kernel::iterator fc_iterator;
             for ( fc_iterator it = itBegin, itPrev = itEnd; it != itEnd; ++it ) {
                 switch ( it->op() ) {
@@ -317,6 +353,7 @@ namespace cds { namespace container {
                     break;
                 }
             }
+            CDS_TSAN_ANNOTATE_IGNORE_RW_END;
         }
         //@endcond
 
@@ -334,7 +371,6 @@ namespace cds { namespace container {
                         goto collided;
                     }
                     break;
-#       ifdef CDS_MOVE_SEMANTICS_SUPPORT
                 case op_push_move:
                     if ( rec2.op() == op_pop ) {
                         assert(rec1.pValPush);
@@ -344,13 +380,10 @@ namespace cds { namespace container {
                         goto collided;
                     }
                     break;
-#       endif
                 case op_pop:
                     switch ( rec2.op() ) {
                     case op_push:
-#       ifdef CDS_MOVE_SEMANTICS_SUPPORT
                     case op_push_move:
-#       endif
                         return collide( rec2, rec1 );
                     }
             }
@@ -366,4 +399,4 @@ namespace cds { namespace container {
     };
 }} // namespace cds::container
 
-#endif // #ifndef __CDS_CONTAINER_FCSTACK_H
+#endif // #ifndef CDSLIB_CONTAINER_FCSTACK_H