//$$CDS-header$$
-#ifndef __CDS_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H
-#define __CDS_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H
+#ifndef CDSLIB_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H
+#define CDSLIB_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H
-#include <cds/container/base.h>
+#include <cds/container/details/base.h>
#include <cds/opt/buffer.h>
#include <cds/opt/value_cleaner.h>
-#include <cds/cxx11_atomic.h>
-#include <cds/ref.h>
-#include <cds/details/trivial_assign.h>
+#include <cds/algo/atomic.h>
#include <cds/details/bounded_container.h>
namespace cds { namespace container {
+ /// VyukovMPMCCycleQueue related definitions
+ /** @ingroup cds_nonintrusive_helper
+ */
+ namespace vyukov_queue {
+
+ /// VyukovMPMCCycleQueue default traits
+ struct traits {
+ /// Buffer type for internal array
+ /*
+ The type of element for the buffer is not important: the queue rebinds
+ buffer for required type via \p rebind metafunction.
+
+ For \p VyukovMPMCCycleQueue queue the buffer size should have power-of-2 size.
+ */
+ typedef cds::opt::v::dynamic_buffer< void * > buffer;
+
+ /// A functor to clean item dequeued.
+ /**
+ The functor calls the destructor for queue item.
+ After an item is dequeued, \p value_cleaner cleans the cell that the item has been occupied.
+ If \p T is a complex type, \p value_cleaner may be the useful feature.
+
+ Default value is \ref opt::v::destruct_cleaner
+ */
+ typedef cds::opt::v::destruct_cleaner value_cleaner;
+
+ /// Item counting feature; by default, disabled. Use \p cds::atomicity::item_counter to enable item counting
+ typedef cds::atomicity::empty_item_counter item_counter;
+
+ /// C++ memory ordering model
+ /**
+ Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
+ */
+ typedef opt::v::relaxed_ordering memory_model;
+
+ /// Alignment for internal queue data. Default is \p opt::cache_line_alignment
+ enum { alignment = opt::cache_line_alignment };
+ };
+
+ /// Metafunction converting option list to \p vyukov_queue::traits
+ /**
+ Supported \p Options are:
+ - \p opt::buffer - the buffer type for internal cyclic array. Possible types are:
+ \p opt::v::dynamic_buffer (the default), \p opt::v::static_buffer. The type of
+ element in the buffer is not important: it will be changed via \p rebind metafunction.
+ - \p opt::value_cleaner - a functor to clean item dequeued.
+ The functor calls the destructor for queue item.
+ After an item is dequeued, \p value_cleaner cleans the cell that the item has been occupied.
+ If \p T is a complex type, \p value_cleaner may be the useful feature.
+ Default value is \ref opt::v::destruct_cleaner
+ - \p opt::item_counter - the type of item counting feature. Default is \p cds::atomicity::empty_item_counter (item counting disabled)
+ To enable item counting use \p cds::atomicity::item_counter
+ - \p opt::alignment - the alignment for internal queue data. Default is \p opt::cache_line_alignment
+ - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default)
+ or \p opt::v::sequential_consistent (sequentially consisnent memory model).
+
+ Example: declare \p %VyukovMPMCCycleQueue with item counting and static iternal buffer of size 1024:
+ \code
+ typedef cds::container::VyukovMPMCCycleQueue< Foo,
+ typename cds::container::vyukov_queue::make_traits<
+ cds::opt::buffer< cds::opt::v::static_buffer< void *, 1024 >,
+ cds::opt::item_counte< cds::atomicity::item_counter >
+ >::type
+ > myQueue;
+ \endcode
+ */
+ 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 vyukov_queue
+
/// Vyukov's MPMC bounded queue
/** @ingroup cds_nonintrusive_queue
This algorithm is developed by Dmitry Vyukov (see http://www.1024cores.net)
No dynamic memory allocation/management during operation. Producers and consumers are separated from each other (as in the two-lock queue),
i.e. do not touch the same data while queue is not empty.
- \par Source:
- http://www.1024cores.net/home/lock-free-algorithms/queues/bounded-mpmc-queue
+ Source:
+ - http://www.1024cores.net/home/lock-free-algorithms/queues/bounded-mpmc-queue
- \par Template parameters
- \li \p T - type stored in queue.
- \li \p Options - queue's options
-
- Options \p Options are:
- - opt::buffer - buffer to store items. Mandatory option, see option description for full list of possible types.
- - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter
- - opt::value_cleaner - a functor to clean item dequeued. Default value is \ref opt::v::destruct_cleaner
- that calls the destructor of type \p T.
- After an item is dequeued, \p value_cleaner cleans the cell that the item has been occupied. If \p T
- is a complex type, \p value_cleaner may be the useful feature.
- - opt::alignment - the alignment for internal queue data. Default is opt::cache_line_alignment
- - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
- or opt::v::sequential_consistent (sequentially consisnent memory model).
+ Template parameters
+ - \p T - type stored in queue.
+ - \p Traits - queue traits, default is \p vykov_queue::traits. You can use \p vykov_queue::make_traits
+ metafunction to make your traits or just derive your traits from \p %vykov_queue::traits:
+ \code
+ struct myTraits: public cds::container::vykov_queue::traits {
+ typedef cds::atomicity::item_counter item_counter;
+ };
+ typedef cds::container::VyukovMPMCCycleQueue< Foo, myTraits > myQueue;
+
+ // Equivalent make_traits example:
+ typedef cds::container::VyukovMPMCCycleQueue< cds::gc::HP, Foo,
+ typename cds::container::vykov_queue::make_traits<
+ cds::opt::item_counter< cds::atomicity::item_counter >
+ >::type
+ > myQueue;
+ \endcode
\par License
Simplified BSD license by Dmitry Vyukov (http://www.1024cores.net/site/1024cores/home/code-license)
-
- \par Example
- \code
- #include <cds/container/vyukov_mpmc_cycle_queue.h>
-
- // // Queue with 1024 item static buffer
- cds::container::vyukov_mpmc_bounded<
- int
- ,cds::opt::buffer< cds::opt::v::static_buffer<int, 1024> >
- > myQueue;
- \endcode
*/
- template <typename T, CDS_DECL_OPTIONS6>
- class VyukovMPMCCycleQueue
- : public cds::bounded_container
+ template <typename T, typename Traits = vyukov_queue::traits >
+ class VyukovMPMCCycleQueue : public cds::bounded_container
{
- protected:
- //@cond
- struct default_options
- {
- typedef cds::opt::v::destruct_cleaner value_cleaner;
- typedef atomicity::empty_item_counter item_counter;
- typedef opt::v::empty_disposer disposer ; // for intrusive version only
- typedef opt::v::relaxed_ordering memory_model;
- enum { alignment = opt::cache_line_alignment };
- };
- //@endcond
-
- public:
- //@cond
- typedef typename opt::make_options<
- typename cds::opt::find_type_traits< default_options, CDS_OPTIONS6 >::type
- ,CDS_OPTIONS6
- >::type options;
- //@endcond
-
- protected:
- //@cond
- typedef typename options::value_cleaner value_cleaner;
- //@endcond
-
public:
- typedef T value_type ; ///< @anchor cds_container_VyukovMPMCCycleQueue_value_type type of value stored in the queue
- typedef typename options::item_counter item_counter ; ///< Item counter type
- typedef typename options::memory_model memory_model ; ///< Memory ordering. See cds::opt::memory_model option
+ typedef T value_type; ///< Value type to be stored in the queue
+ typedef Traits traits; ///< Queue traits
+ typedef typename traits::item_counter item_counter; ///< Item counter type
+ typedef typename traits::memory_model memory_model; ///< Memory ordering. See cds::opt::memory_model option
+ typedef typename traits::value_cleaner value_cleaner; ///< Value cleaner, see \p vyukov_queue::traits::value_cleaner
/// Rebind template arguments
- template <typename T2, CDS_DECL_OTHER_OPTIONS6>
+ template <typename T2, typename Traits2>
struct rebind {
- typedef VyukovMPMCCycleQueue< T2, CDS_OTHER_OPTIONS6> other ; ///< Rebinding result
+ typedef VyukovMPMCCycleQueue< T2, Traits2 > other ; ///< Rebinding result
};
protected:
{}
};
-# ifndef CDS_CXX11_LAMBDA_SUPPORT
- struct copy_construct {
- void operator()( value_type& dest, value_type const& src )
- {
- new ( &dest ) value_type( src );
- }
- };
-# endif
-
- typedef cds::details::trivial_assign< value_type, value_type > copy_assign;
-
- typedef typename options::buffer::template rebind<cell_type>::other buffer;
- typedef typename opt::details::alignment_setter< sequence_type, options::alignment >::type aligned_sequence_type;
- typedef typename opt::details::alignment_setter< buffer, options::alignment >::type aligned_buffer;
+ typedef typename traits::buffer::template rebind<cell_type>::other buffer;
+ typedef typename opt::details::alignment_setter< sequence_type, traits::alignment >::type aligned_sequence_type;
+ typedef typename opt::details::alignment_setter< buffer, traits::alignment >::type aligned_buffer;
//@endcond
protected:
public:
/// Constructs the queue of capacity \p nCapacity
/**
- For cds::opt::v::static_buffer the \p nCapacity parameter is ignored.
+ For \p cds::opt::v::static_buffer the \p nCapacity parameter is ignored.
*/
VyukovMPMCCycleQueue(
size_t nCapacity = 0
clear();
}
- /// Enqueues \p data to queue using copy functor
- /** @anchor cds_container_VyukovMPMCCycleQueue_enqueue_func
- \p Func is a functor called to copy value \p data of type \p Source
- which may be differ from type \p T stored in the queue.
- The functor's interface is:
+ /// Enqueues data to the queue using a functor
+ /**
+ \p Func is a functor called to copy a value to the queue cell.
+ The functor \p f takes one argument - a reference to a empty cell of type \ref value_type :
\code
- struct myFunctor {
- void operator()(T& dest, Source const& data)
- {
- // // Code to copy \p data to \p dest
- dest = data;
- }
- };
+ cds::container::VyukovMPMCCycleQueue< Foo > myQueue;
+ Bar bar;
+ myQueue.enqueue_with( [&bar]( Foo& dest ) { dest = std::move(bar); } );
\endcode
- You may use \p boost:ref construction to pass functor \p f by reference.
-
- <b>Requirements</b> The functor \p Func should not throw any exception.
*/
- template <typename Source, typename Func>
- bool enqueue(Source const& data, Func func)
+ template <typename Func>
+ bool enqueue_with(Func f)
{
cell_type* cell;
size_t pos = m_posEnqueue.load(memory_model::memory_order_relaxed);
pos = m_posEnqueue.load(memory_model::memory_order_relaxed);
}
- unref(func)( cell->data, data );
+ f( cell->data );
cell->sequence.store(pos + 1, memory_model::memory_order_release);
++m_ItemCounter;
return true;
}
- /// @anchor cds_container_VyukovMPMCCycleQueue_enqueue Enqueues \p data to queue
- bool enqueue(value_type const& data )
+ /// Enqueues \p val value into the queue.
+ /**
+ The new queue item is created by calling placement new in free cell.
+ Returns \p true if success, \p false if the queue is full.
+ */
+ bool enqueue( value_type const& val )
+ {
+ return enqueue_with( [&val]( value_type& dest ){ new ( &dest ) value_type( val ); });
+ }
+
+ /// Synonym for \p enqueue()
+ bool push( value_type const& data )
+ {
+ return enqueue( data );
+ }
+
+ /// Synonym for \p enqueue_with()
+ template <typename Func>
+ bool push_with( Func f )
{
-# ifdef CDS_CXX11_LAMBDA_SUPPORT
- return enqueue( data, [](value_type& dest, value_type const& src){ new ( &dest ) value_type( src ); });
-# else
- return enqueue( data, copy_construct() );
-# endif
+ return enqueue_with( f );
}
- /// Enqueues data of type \ref cds_container_VyukovMPMCCycleQueue_value_type "value_type" constructed with <tt>std::forward<Args>(args)...</tt>
+ /// Enqueues data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
template <typename... Args>
bool emplace( Args&&... args )
{
return true;
}
- /// Dequeues an item from queue
- /** @anchor cds_container_VyukovMPMCCycleQueue_dequeue_func
- \p Func is a functor called to copy dequeued value of type \p T to \p dest of type \p Dest.
- The functor's interface is:
+ /// Dequeues a value using a functor
+ /**
+ \p Func is a functor called to copy dequeued value.
+ The functor takes one argument - a reference to removed node:
\code
- struct myFunctor {
- void operator()(Dest& dest, T const& data)
- {
- // // Code to copy \p data to \p dest
- dest = data;
- }
- };
+ cds:container::VyukovMPMCCycleQueue< Foo > myQueue;
+ Bar bar;
+ myQueue.dequeue_with( [&bar]( Foo& src ) { bar = std::move( src );});
\endcode
- You may use \p boost:ref construction to pass functor \p func by reference.
-
- <b>Requirements</b> The functor \p Func should not throw any exception.
+ The functor is called only if the queue is not empty.
*/
- template <typename Dest, typename Func>
- bool dequeue( Dest& data, Func func )
+ template <typename Func>
+ bool dequeue_with( Func f )
{
cell_type * cell;
size_t pos = m_posDequeue.load(memory_model::memory_order_relaxed);
pos = m_posDequeue.load(memory_model::memory_order_relaxed);
}
- unref(func)( data, cell->data );
+ f( cell->data );
value_cleaner()( cell->data );
--m_ItemCounter;
cell->sequence.store( pos + m_nBufferMask + 1, memory_model::memory_order_release );
return true;
}
- /// Dequeues an item from queue to \p data
- /** @anchor cds_container_VyukovMPMCCycleQueue_dequeue
- If queue is empty, returns \p false, \p data is unchanged.
+ /// Dequeues a value from the queue
+ /**
+ If queue is not empty, the function returns \p true, \p dest contains copy of
+ dequeued value. The assignment operator for type \ref value_type is invoked.
+ If queue is empty, the function returns \p false, \p dest is unchanged.
*/
- bool dequeue(value_type & data )
- {
- return dequeue( data, copy_assign() );
- }
-
- /// Synonym of \ref cds_container_VyukovMPMCCycleQueue_enqueue "enqueue"
- bool push(value_type const& data)
- {
- return enqueue(data);
- }
-
- /// Synonym for template version of \ref cds_container_VyukovMPMCCycleQueue_enqueue_func "enqueue" function
- template <typename Source, typename Func>
- bool push( const Source& data, Func f )
+ bool dequeue(value_type & dest )
{
- return enqueue( data, f );
+ return dequeue_with( [&dest]( value_type& src ){ dest = src; } );
}
- /// Synonym of \ref cds_container_VyukovMPMCCycleQueue_dequeue "dequeue"
+ /// Synonym for \p dequeue()
bool pop(value_type& data)
{
return dequeue(data);
}
- /// Synonym for template version of \ref cds_container_VyukovMPMCCycleQueue_dequeue_func "dequeue" function
- template <typename Type, typename Func>
- bool pop( Type& dest, Func f )
+ /// Synonym for \p dequeue_with()
+ template <typename Func>
+ bool pop_with( Func f )
{
- return dequeue( dest, f );
+ return dequeue_with( f );
}
/// Checks if the queue is empty
/// Returns queue's item count
/**
- The value returned depends on opt::item_counter option. For atomicity::empty_item_counter,
- this function always returns 0.
+ The value returned depends on \p vyukov_queue::traits::item_counter option.
+ For \p atomicity::empty_item_counter, this function always returns 0.
*/
size_t size() const
{
return m_ItemCounter.value();
}
- /// Returns capacity of cyclic buffer
+ /// Returns capacity of the queue
size_t capacity() const
{
return m_buffer.capacity();
};
}} // namespace cds::container
-#endif // #ifndef __CDS_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H
+#endif // #ifndef CDSLIB_CONTAINER_VYUKOV_MPMC_CYCLE_QUEUE_H