--- /dev/null
+/*
+ This file is a part of libcds - Concurrent Data Structures library
+
+ (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
+
+ 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>
+#include <stack>
+
+namespace cds { namespace container {
+
+ /// FCStack related definitions
+ /** @ingroup cds_nonintrusive_helper
+ */
+ namespace fcstack {
+
+ /// FCStack internal statistics
+ template <typename Counter = cds::atomicity::event_counter >
+ struct stat: public cds::algo::flat_combining::stat<Counter>
+ {
+ typedef cds::algo::flat_combining::stat<Counter> flat_combining_stat; ///< Flat-combining statistics
+ typedef typename flat_combining_stat::counter_type counter_type; ///< Counter type
+
+ counter_type m_nPush ; ///< Count of push operations
+ counter_type m_nPushMove ; ///< Count of push operations with move semantics
+ counter_type m_nPop ; ///< Count of success pop operations
+ counter_type m_nFailedPop; ///< Count of failed pop operations (pop from empty stack)
+ counter_type m_nCollided ; ///< How many pairs of push/pop were collided, if elimination is enabled
+
+ //@cond
+ void onPush() { ++m_nPush; }
+ void onPushMove() { ++m_nPushMove; }
+ void onPop( bool bFailed ) { if ( bFailed ) ++m_nFailedPop; else ++m_nPop; }
+ void onCollide() { ++m_nCollided; }
+ //@endcond
+ };
+
+ /// FCStack dummy statistics, no overhead
+ struct empty_stat: public cds::algo::flat_combining::empty_stat
+ {
+ //@cond
+ void onPush() {}
+ void onPushMove() {}
+ void onPop(bool) {}
+ void onCollide() {}
+ //@endcond
+ };
+
+ /// FCStack type traits
+ struct traits: public cds::algo::flat_combining::traits
+ {
+ typedef empty_stat stat; ///< Internal statistics
+ static constexpr const bool enable_elimination = false; ///< Enable \ref cds_elimination_description "elimination"
+ };
+
+ /// Metafunction converting option list to traits
+ /**
+ \p Options are:
+ - 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 <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< traits, Options... >::type
+ ,Options...
+ >::type type;
+# endif
+ };
+
+ } // namespace fcstack
+
+ /// Flat-combining stack
+ /**
+ @ingroup cds_nonintrusive_stack
+ @ingroup cds_flat_combining_container
+
+ \ref cds_flat_combining_description "Flat combining" sequential stack.
+
+ 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::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::traits
+ >
+ class FCStack
+#ifndef CDS_DOXYGEN_INVOKED
+ : public cds::algo::flat_combining::container
+#endif
+ {
+ public:
+ typedef T value_type; ///< Value type
+ typedef Stack stack_type; ///< Sequential stack class
+ typedef Traits traits; ///< Stack traits
+
+ typedef typename traits::stat stat; ///< Internal statistics type
+ static constexpr const bool c_bEliminationEnabled = traits::enable_elimination; ///< \p true if elimination is enabled
+
+ protected:
+ //@cond
+ /// Stack operation IDs
+ enum fc_operation {
+ op_push = cds::algo::flat_combining::req_Operation, ///< Push
+ op_push_move, ///< Push (move semantics)
+ op_pop, ///< Pop
+ op_clear, ///< Clear
+ op_empty ///< Empty
+ };
+
+ /// Flat combining publication list record
+ struct fc_record: public cds::algo::flat_combining::publication_record
+ {
+ union {
+ value_type const * pValPush; ///< Value to push
+ value_type * pValPop; ///< Pop destination
+ };
+ bool bEmpty; ///< \p true if the stack is empty
+ };
+ //@endcond
+
+ /// Flat combining kernel
+ typedef cds::algo::flat_combining::kernel< fc_record, traits > fc_kernel;
+
+ protected:
+ //@cond
+ mutable fc_kernel m_FlatCombining;
+ stack_type m_Stack;
+ //@endcond
+
+ public:
+ /// Initializes empty stack object
+ FCStack()
+ {}
+
+ /// Initializes empty stack object and gives flat combining parameters
+ FCStack(
+ unsigned int nCompactFactor ///< Flat combining: publication list compacting factor
+ ,unsigned int nCombinePassCount ///< Flat combining: number of combining passes for combiner thread
+ )
+ : m_FlatCombining( nCompactFactor, nCombinePassCount )
+ {}
+
+ /// Inserts a new element at the top of stack
+ /**
+ The content of the new element initialized to a copy of \p val.
+ */
+ bool push( value_type const& val )
+ {
+ auto pRec = m_FlatCombining.acquire_record();
+ pRec->pValPush = &val;
+
+ constexpr_if ( c_bEliminationEnabled )
+ m_FlatCombining.batch_combine( op_push, pRec, *this );
+ else
+ m_FlatCombining.combine( op_push, pRec, *this );
+
+ assert( pRec->is_done());
+ m_FlatCombining.release_record( pRec );
+ m_FlatCombining.internal_statistics().onPush();
+ return true;
+ }
+
+ /// 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 )
+ {
+ auto pRec = m_FlatCombining.acquire_record();
+ pRec->pValPush = &val;
+
+ constexpr_if ( c_bEliminationEnabled )
+ m_FlatCombining.batch_combine( op_push_move, pRec, *this );
+ else
+ m_FlatCombining.combine( op_push_move, pRec, *this );
+
+ assert( pRec->is_done());
+ m_FlatCombining.release_record( pRec );
+
+ m_FlatCombining.internal_statistics().onPushMove();
+ return true;
+ }
+
+ /// Removes the element on top of the stack
+ /**
+ \p val takes a copy of top element
+ */
+ bool pop( value_type& val )
+ {
+ auto pRec = m_FlatCombining.acquire_record();
+ pRec->pValPop = &val;
+
+ constexpr_if ( c_bEliminationEnabled )
+ m_FlatCombining.batch_combine( op_pop, pRec, *this );
+ else
+ m_FlatCombining.combine( op_pop, pRec, *this );
+
+ assert( pRec->is_done());
+ m_FlatCombining.release_record( pRec );
+
+ m_FlatCombining.internal_statistics().onPop( pRec->bEmpty );
+ return !pRec->bEmpty;
+ }
+
+ /// Clears the stack
+ void clear()
+ {
+ auto pRec = m_FlatCombining.acquire_record();
+
+ constexpr_if ( c_bEliminationEnabled )
+ m_FlatCombining.batch_combine( op_clear, pRec, *this );
+ else
+ m_FlatCombining.combine( op_clear, pRec, *this );
+
+ assert( pRec->is_done());
+ m_FlatCombining.release_record( pRec );
+ }
+
+ /// Exclusive access to underlying stack object
+ /**
+ The functor \p f can do any operation with underlying \p stack_type in exclusive mode.
+ For example, you can iterate over the stack.
+ \p Func signature is:
+ \code
+ void f( stack_type& stack );
+ \endcode
+ */
+ template <typename Func>
+ void apply( Func f )
+ {
+ auto& stack = m_Stack;
+ m_FlatCombining.invoke_exclusive( [&stack, &f]() { f( stack ); } );
+ }
+
+ /// Exclusive access to underlying stack object
+ /**
+ The functor \p f can do any operation with underlying \p stack_type in exclusive mode.
+ For example, you can iterate over the stack.
+ \p Func signature is:
+ \code
+ void f( stack_type const& stack );
+ \endcode
+ */
+ template <typename Func>
+ void apply( Func f ) const
+ {
+ auto const& stack = m_Stack;
+ m_FlatCombining.invoke_exclusive( [&stack, &f]() { f( stack ); } );
+ }
+
+ /// Returns the number of elements in the stack.
+ /**
+ Note that <tt>size() == 0</tt> is not mean that the stack is empty because
+ combining record can be in process.
+ To check emptiness use \ref empty() function.
+ */
+ size_t size() const
+ {
+ return m_Stack.size();
+ }
+
+ /// Checks if the stack is empty
+ /**
+ If the combining is in process the function waits while combining done.
+ */
+ bool empty()
+ {
+ auto pRec = m_FlatCombining.acquire_record();
+
+ constexpr_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
+ stat const& statistics() const
+ {
+ return m_FlatCombining.statistics();
+ }
+
+
+ public: // flat combining cooperation, not for direct use!
+ //@cond
+ /// Flat combining supporting function. Do not call it directly!
+ /**
+ The function is called by \ref cds::algo::flat_combining::kernel "flat combining kernel"
+ object if the current thread becomes a combiner. Invocation of the function means that
+ the stack should perform an action recorded in \p pRec.
+ */
+ void fc_apply( fc_record * pRec )
+ {
+ assert( pRec );
+
+ switch ( pRec->op()) {
+ case op_push:
+ assert( pRec->pValPush );
+ m_Stack.push( *(pRec->pValPush ));
+ break;
+ case op_push_move:
+ assert( pRec->pValPush );
+ m_Stack.push( std::move( *(pRec->pValPush )));
+ break;
+ case op_pop:
+ assert( pRec->pValPop );
+ pRec->bEmpty = m_Stack.empty();
+ if ( !pRec->bEmpty ) {
+ *(pRec->pValPop) = std::move( m_Stack.top());
+ m_Stack.pop();
+ }
+ break;
+ case op_clear:
+ while ( !m_Stack.empty())
+ m_Stack.pop();
+ break;
+ case op_empty:
+ pRec->bEmpty = m_Stack.empty();
+ break;
+ default:
+ assert(false);
+ break;
+ }
+ }
+
+ /// Batch-processing flat combining
+ void fc_process( typename fc_kernel::iterator itBegin, typename fc_kernel::iterator itEnd )
+ {
+ typedef typename fc_kernel::iterator fc_iterator;
+ for ( fc_iterator it = itBegin, itPrev = itEnd; it != itEnd; ++it ) {
+ switch ( it->op( atomics::memory_order_acquire )) {
+ case op_push:
+ case op_push_move:
+ case op_pop:
+ if ( itPrev != itEnd && collide( *itPrev, *it ))
+ itPrev = itEnd;
+ else
+ itPrev = it;
+ break;
+ }
+ }
+ }
+ //@endcond
+
+ private:
+ //@cond
+ bool collide( fc_record& rec1, fc_record& rec2 )
+ {
+ switch ( rec1.op()) {
+ case op_push:
+ if ( rec2.op() == op_pop ) {
+ assert(rec1.pValPush);
+ assert(rec2.pValPop);
+ *rec2.pValPop = *rec1.pValPush;
+ rec2.bEmpty = false;
+ goto collided;
+ }
+ break;
+ case op_push_move:
+ if ( rec2.op() == op_pop ) {
+ assert(rec1.pValPush);
+ assert(rec2.pValPop);
+ *rec2.pValPop = std::move( *rec1.pValPush );
+ rec2.bEmpty = false;
+ goto collided;
+ }
+ break;
+ case op_pop:
+ switch ( rec2.op()) {
+ case op_push:
+ case op_push_move:
+ return collide( rec2, rec1 );
+ }
+ }
+ return false;
+
+ collided:
+ m_FlatCombining.operation_done( rec1 );
+ m_FlatCombining.operation_done( rec2 );
+ m_FlatCombining.internal_statistics().onCollide();
+ return true;
+ }
+ //@endcond
+ };
+}} // namespace cds::container
+
+#endif // #ifndef CDSLIB_CONTAINER_FCSTACK_H
projects / c11concurrency-benchmarks.git / blobdiff