Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r83538 - in trunk: boost/thread libs/thread/example libs/thread/test
From: vicente.botet_at_[hidden]
Date: 2013-03-24 08:24:23

Author: viboes
Date: 2013-03-24 08:24:22 EDT (Sun, 24 Mar 2013)
New Revision: 83538
URL: http://svn.boost.org/trac/boost/changeset/83538

Log:
Thread: Added first version of sync_bounded_queue.
Added:
   trunk/boost/thread/sync_bounded_queue.hpp (contents, props changed)
   trunk/libs/thread/example/producer_consumer.cpp (contents, props changed)
Text files modified:
   trunk/libs/thread/test/Jamfile.v2 | 3 ++-
   1 files changed, 2 insertions(+), 1 deletions(-)

Added: trunk/boost/thread/sync_bounded_queue.hpp
==============================================================================
--- (empty file)
+++ trunk/boost/thread/sync_bounded_queue.hpp 2013-03-24 08:24:22 EDT (Sun, 24 Mar 2013)
@@ -0,0 +1,571 @@
+#ifndef BOOST_THREAD_SYNC_BOUNDED_QUEUE_HPP
+#define BOOST_THREAD_SYNC_BOUNDED_QUEUE_HPP
+
+//////////////////////////////////////////////////////////////////////////////
+//
+// (C) Copyright Vicente J. Botet Escriba 2013. Distributed under the Boost
+// Software License, Version 1.0. (See accompanying file
+// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// See http://www.boost.org/libs/thread for documentation.
+//
+//////////////////////////////////////////////////////////////////////////////
+
+#include <boost/thread/detail/config.hpp>
+#include <boost/thread/condition_variable.hpp>
+#include <boost/thread/mutex.hpp>
+#include <boost/thread/detail/move.hpp>
+#include <boost/throw_exception.hpp>
+#include <boost/smart_ptr/shared_ptr.hpp>
+#include <boost/smart_ptr/make_shared.hpp>
+
+#include <boost/config/abi_prefix.hpp>
+
+namespace boost
+{
+
+ BOOST_SCOPED_ENUM_DECLARE_BEGIN(queue_op_status)
+ { success = 0, empty, full, closed, busy }
+ BOOST_SCOPED_ENUM_DECLARE_END(queue_op_status)
+
+ struct no_block_tag{};
+ no_block_tag no_block {};
+
+ struct sync_queue_is_closed : std::exception {};
+
+ template <typename ValueType>
+ class sync_bounded_queue
+ {
+ public:
+ typedef ValueType value_type;
+ typedef std::size_t size_type;
+
+
+ BOOST_THREAD_NO_COPYABLE(sync_bounded_queue)
+
+ explicit sync_bounded_queue(size_type max_elems);
+ template <typename Range>
+ sync_bounded_queue(size_type max_elems, Range range);
+ ~sync_bounded_queue();
+
+ // Observers
+ bool empty() const;
+ bool full() const;
+ size_type capacity() const;
+ size_type size() const;
+ bool closed() const;
+
+ // Modifiers
+ void wait_and_push(const value_type& x);
+ void wait_and_push(BOOST_THREAD_RV_REF(value_type) x);
+ bool try_push(const value_type& x);
+ bool try_push(BOOST_THREAD_RV_REF(value_type) x);
+ bool try_push(no_block_tag, const value_type& x);
+ bool try_push(no_block_tag, BOOST_THREAD_RV_REF(value_type) x);
+
+ void wait_and_pop(value_type&);
+ void wait_and_pop(ValueType& elem, bool & closed);
+
+ // enable_if is_nothrow_movable<value_type>
+ value_type value_pop();
+ shared_ptr<ValueType> wait_and_pop();
+
+ bool try_pop(value_type&);
+ bool try_pop(no_block_tag,value_type&);
+
+ void close();
+
+ private:
+ mutable mutex mtx_;
+ condition_variable not_empty_;
+ condition_variable not_full_;
+ size_type waiting_full_;
+ size_type waiting_empty_;
+ value_type* data_;
+ size_type in_;
+ size_type out_;
+ size_type capacity_;
+ bool closed_;
+
+ size_type inc(size_type idx) const BOOST_NOEXCEPT
+ {
+ return (idx + 1) % capacity_;
+ }
+
+ bool empty(unique_lock<mutex>& ) const BOOST_NOEXCEPT
+ {
+ return in_ == out_;
+ }
+ bool empty(lock_guard<mutex>& ) const BOOST_NOEXCEPT
+ {
+ return in_ == out_;
+ }
+ size_type capacity(lock_guard<mutex>& ) const BOOST_NOEXCEPT
+ {
+ return capacity;
+ }
+ size_type size(lock_guard<mutex>& ) const BOOST_NOEXCEPT
+ {
+ return ((out_+capacity_-in_) % capacity_)-1;
+ }
+
+ void throw_if_closed(unique_lock<mutex>&);
+
+ bool try_pop(value_type& x, unique_lock<mutex>& lk);
+ bool try_push(const value_type& x, unique_lock<mutex>& lk);
+ bool try_push(BOOST_THREAD_RV_REF(value_type) x, unique_lock<mutex>& lk);
+ void wait_until_not_empty(unique_lock<mutex>& lk);
+ void wait_until_not_empty(unique_lock<mutex>& lk, bool&);
+ size_type wait_until_not_full(unique_lock<mutex>& lk);
+ size_type wait_until_not_full(unique_lock<mutex>& lk, bool&);
+
+
+ void notify_not_empty_if_needed(unique_lock<mutex>& lk)
+ {
+ if (waiting_empty_ > 0)
+ {
+ --waiting_empty_;
+ lk.unlock();
+ not_empty_.notify_one();
+ }
+ }
+ void notify_not_full_if_needed(unique_lock<mutex>& lk)
+ {
+ if (waiting_full_ > 0)
+ {
+ --waiting_full_;
+ lk.unlock();
+ not_full_.notify_one();
+ }
+ }
+
+ void pop(value_type& elem, unique_lock<mutex>& lk)
+ {
+ elem = boost::move(data_[out_]);
+ out_ = inc(out_);
+ notify_not_full_if_needed(lk);
+ }
+ boost::shared_ptr<value_type> pop(unique_lock<mutex>& lk)
+ {
+ shared_ptr<value_type> res = make_shared<value_type>(boost::move(data_[out_]));
+ out_ = inc(out_);
+ notify_not_full_if_needed(lk);
+ return res;
+ }
+
+ void set_in(size_type in, unique_lock<mutex>& lk)
+ {
+ in_ = in;
+ notify_not_empty_if_needed(lk);
+ }
+
+ void push_at(const value_type& elem, size_type in_p_1, unique_lock<mutex>& lk)
+ {
+ data_[in_] = elem;
+ set_in(in_p_1, lk);
+ }
+
+ void push_at(BOOST_THREAD_RV_REF(value_type) elem, size_type in_p_1, unique_lock<mutex>& lk)
+ {
+ data_[in_] = boost::move(elem);
+ set_in(in_p_1, lk);
+ }
+
+
+ };
+
+ template <typename ValueType>
+ sync_bounded_queue<ValueType>::sync_bounded_queue(typename sync_bounded_queue<ValueType>::size_type max_elems) :
+ waiting_full_(0), waiting_empty_(0), data_(new value_type[max_elems + 1]), in_(0), out_(0), capacity_(max_elems + 1),
+ closed_(false)
+ {
+ BOOST_ASSERT_MSG(max_elems >= 1, "number of elements must be > 1");
+ }
+
+// template <typename ValueType>
+// template <typename Range>
+// sync_bounded_queue<ValueType>::sync_bounded_queue(size_type max_elems, Range range) :
+// waiting_full_(0), waiting_empty_(0), data_(new value_type[max_elems + 1]), in_(0), out_(0), capacity_(max_elems + 1),
+// closed_(false)
+// {
+// BOOST_ASSERT_MSG(max_elems >= 1, "number of elements must be > 1");
+// BOOST_ASSERT_MSG(max_elems == size(range), "number of elements must match range's size");
+// try
+// {
+// typedef typename Range::iterator iterator_t;
+// iterator_t first = boost::begin(range);
+// iterator_t end = boost::end(range);
+// size_type in = 0;
+// for (iterator_t cur = first; cur != end; ++cur, ++in)
+// {
+// data_[in] = *cur;
+// }
+// set_in(in);
+// }
+// catch (...)
+// {
+// delete[] data_;
+// }
+// }
+
+ template <typename ValueType>
+ sync_bounded_queue<ValueType>::~sync_bounded_queue()
+ {
+ delete[] data_;
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::close()
+ {
+ {
+ lock_guard<mutex> lk(mtx_);
+ closed_ = true;
+ }
+ not_empty_.notify_all();
+ not_full_.notify_all();
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::closed() const
+ {
+ lock_guard<mutex> lk(mtx_);
+ return closed_;
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::empty() const
+ {
+ lock_guard<mutex> lk(mtx_);
+ return empty(lk);
+ }
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::full() const
+ {
+ lock_guard<mutex> lk(mtx_);
+ return full(lk);
+ }
+
+ template <typename ValueType>
+ typename sync_bounded_queue<ValueType>::size_type sync_bounded_queue<ValueType>::capacity() const
+ {
+ lock_guard<mutex> lk(mtx_);
+ return capacity(lk);
+ }
+
+ template <typename ValueType>
+ typename sync_bounded_queue<ValueType>::size_type sync_bounded_queue<ValueType>::size() const
+ {
+ lock_guard<mutex> lk(mtx_);
+ return size(lk);
+ }
+
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_pop(ValueType& elem, unique_lock<mutex>& lk)
+ {
+ if (empty(lk))
+ {
+ if (closed_)
+ {
+ BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
+ }
+ return false;
+ }
+ pop(elem, lk);
+ return true;
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_pop(ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ return try_pop(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_pop(no_block_tag,ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_, try_to_lock);
+ if (!lk.owns_lock())
+ {
+ return false;
+ }
+ return try_pop(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::throw_if_closed(unique_lock<mutex>&)
+ {
+ if (closed_)
+ {
+ BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
+ }
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_until_not_empty(unique_lock<mutex>& lk)
+ {
+ for (;;)
+ {
+ if (out_ != in_) break;
+ throw_if_closed(lk);
+ ++waiting_empty_;
+ not_empty_.wait(lk);
+ }
+ }
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_until_not_empty(unique_lock<mutex>& lk, bool & closed)
+ {
+ for (;;)
+ {
+ if (out_ != in_) break;
+ if (closed_) {closed=true; return;}
+ ++waiting_empty_;
+ not_empty_.wait(lk);
+ }
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_and_pop(ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ wait_until_not_empty(lk);
+ pop(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_and_pop(ValueType& elem, bool & closed)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ wait_until_not_empty(lk, closed);
+ if (closed) {return;}
+ pop(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ // enable if ValueType is nothrow movable
+ template <typename ValueType>
+ ValueType sync_bounded_queue<ValueType>::value_pop()
+ {
+ try
+ {
+ value_type elem;
+ wait_and_pop(elem);
+ return boost::move(elem);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+ template <typename ValueType>
+ boost::shared_ptr<ValueType> sync_bounded_queue<ValueType>::wait_and_pop()
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ wait_until_not_empty(lk);
+ return pop(lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(const ValueType& elem, unique_lock<mutex>& lk)
+ {
+ throw_if_closed(lk);
+ size_type in_p_1 = inc(in_);
+ if (in_p_1 == out_) // full()
+ {
+ return false;
+ }
+ push_at(elem, in_p_1, lk);
+ return true;
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(const ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ return try_push(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(no_block_tag, const ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_, try_to_lock);
+ if (!lk.owns_lock()) return false;
+ return try_push(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+
+ template <typename ValueType>
+ typename sync_bounded_queue<ValueType>::size_type sync_bounded_queue<ValueType>::wait_until_not_full(unique_lock<mutex>& lk)
+ {
+ for (;;)
+ {
+ throw_if_closed(lk);
+ size_type in_p_1 = inc(in_);
+ if (in_p_1 != out_) // ! full()
+ {
+ return in_p_1;
+ }
+ ++waiting_full_;
+ not_full_.wait(lk);
+ }
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_and_push(const ValueType& elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ push_at(elem, wait_until_not_full(lk), lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(BOOST_THREAD_RV_REF(ValueType) elem, unique_lock<mutex>& lk)
+ {
+ throw_if_closed(lk);
+ size_type in_p_1 = inc(in_);
+ if (in_p_1 == out_) // full()
+ {
+ return false;
+ }
+ push_at(boost::move(elem), in_p_1, lk);
+ return true;
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(BOOST_THREAD_RV_REF(ValueType) elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ return try_push(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ bool sync_bounded_queue<ValueType>::try_push(no_block_tag, BOOST_THREAD_RV_REF(ValueType) elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_, try_to_lock);
+ if (!lk.owns_lock())
+ {
+ return false;
+ }
+ return try_push(elem, lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ void sync_bounded_queue<ValueType>::wait_and_push(BOOST_THREAD_RV_REF(ValueType) elem)
+ {
+ try
+ {
+ unique_lock<mutex> lk(mtx_);
+ push_at(elem, wait_until_not_full(lk), lk);
+ }
+ catch (...)
+ {
+ close();
+ throw;
+ }
+ }
+
+ template <typename ValueType>
+ sync_bounded_queue<ValueType>& operator<<(sync_bounded_queue<ValueType>& sbq, BOOST_THREAD_RV_REF(ValueType) elem)
+ {
+ sbq.wait_and_push(boost::forward<ValueType>(elem));
+ return sbq;
+ }
+
+ template <typename ValueType>
+ sync_bounded_queue<ValueType>& operator<<(sync_bounded_queue<ValueType>& sbq, ValueType const&elem)
+ {
+ sbq.wait_and_push(elem);
+ return sbq;
+ }
+
+ template <typename ValueType>
+ sync_bounded_queue<ValueType>& operator>>(sync_bounded_queue<ValueType>& sbq, ValueType &elem)
+ {
+ sbq.wait_and_pop(elem);
+ return sbq;
+ }
+
+}
+
+#include <boost/config/abi_suffix.hpp>
+
+#endif

Added: trunk/libs/thread/example/producer_consumer.cpp
==============================================================================
--- (empty file)
+++ trunk/libs/thread/example/producer_consumer.cpp 2013-03-24 08:24:22 EDT (Sun, 24 Mar 2013)
@@ -0,0 +1,125 @@
+// (C) Copyright 2012 Howard Hinnant
+// (C) Copyright 2012 Vicente Botet
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+// adapted from the example given by Howard Hinnant in
+
+#define BOOST_THREAD_VERSION 4
+
+#include <iostream>
+#include <boost/thread/scoped_thread.hpp>
+#include <boost/thread/externally_locked_stream.hpp>
+#include <boost/thread/sync_bounded_queue.hpp>
+
+void producer(boost::externally_locked_stream<std::ostream> &mos, boost::sync_bounded_queue<int> & sbq)
+{
+ using namespace boost;
+ try {
+ for(int i=0; ;++i)
+ {
+ //sbq.wait_and_push(i);
+ sbq << i;
+ mos << "wait_and_push(" << i << ")\n";
+ this_thread::sleep_for(chrono::milliseconds(200));
+ }
+ }
+ catch(sync_queue_is_closed&)
+ {
+ mos << "closed !!!\n";
+ }
+ catch(...)
+ {
+ mos << "exception !!!\n";
+ }}
+
+void consumer(boost::externally_locked_stream<std::ostream> &mos, boost::sync_bounded_queue<int> & sbq)
+{
+ using namespace boost;
+ try {
+ for(int i=0; ;++i)
+ {
+ int r;
+ //sbq.wait_and_pop(r);
+ sbq >> r;
+ mos << i << " wait_and_pop(" << r << ")\n";
+ this_thread::sleep_for(chrono::milliseconds(250));
+ }
+ }
+ catch(sync_queue_is_closed&)
+ {
+ mos << "closed !!!\n";
+ }
+ catch(...)
+ {
+ mos << "exception !!!\n";
+ }
+}
+void consumer2(boost::externally_locked_stream<std::ostream> &mos, boost::sync_bounded_queue<int> & sbq)
+{
+ using namespace boost;
+ try {
+ bool closed=false;
+ for(int i=0; ;++i)
+ {
+ int r;
+ sbq.wait_and_pop(r, closed);
+ if (closed) break;
+ mos << i << " wait_and_pop(" << r << ")\n";
+ this_thread::sleep_for(chrono::milliseconds(250));
+ }
+ }
+ catch(...)
+ {
+ mos << "exception !!!\n";
+ }
+}
+//void consumer3(boost::externally_locked_stream<std::ostream> &mos, boost::sync_bounded_queue<int> & sbq)
+//{
+// using namespace boost;
+// bool closed=false;
+// try {
+// for(int i=0; ;++i)
+// {
+// int r;
+// queue_op_status res = sbq.wait_and_pop(r);
+// if (res==queue_op_status::closed) break;
+// mos << i << " wait_and_pop(" << r << ")\n";
+// this_thread::sleep_for(chrono::milliseconds(250));
+// }
+// }
+// catch(...)
+// {
+// mos << "exception !!!\n";
+// }
+//}
+
+int main()
+{
+ using namespace boost;
+
+ recursive_mutex terminal_mutex;
+
+ externally_locked_stream<std::ostream> mcerr(std::cerr, terminal_mutex);
+ externally_locked_stream<std::ostream> mcout(std::cout, terminal_mutex);
+ externally_locked_stream<std::istream> mcin(std::cin, terminal_mutex);
+
+ sync_bounded_queue<int> sbq(10);
+
+ {
+ mcout << "begin of main" << std::endl;
+ scoped_thread<> t11(thread(producer, boost::ref(mcerr), boost::ref(sbq)));
+ scoped_thread<> t12(thread(producer, boost::ref(mcerr), boost::ref(sbq)));
+ scoped_thread<> t2(thread(consumer, boost::ref(mcout), boost::ref(sbq)));
+
+ this_thread::sleep_for(chrono::seconds(1));
+
+ sbq.close();
+ mcout << "closed()" << std::endl;
+
+ } // all threads joined here.
+ mcout << "end of main" << std::endl;
+ return 0;
+}
+

Modified: trunk/libs/thread/test/Jamfile.v2
==============================================================================
--- trunk/libs/thread/test/Jamfile.v2 (original)
+++ trunk/libs/thread/test/Jamfile.v2 2013-03-24 08:24:22 EDT (Sun, 24 Mar 2013)
@@ -667,6 +667,7 @@
           [ thread-run2-noit ../example/scoped_thread.cpp : ex_scoped_thread ]
           [ thread-run2-noit ../example/strict_lock.cpp : ex_strict_lock ]
           [ thread-run2-noit ../example/ba_externallly_locked.cpp : ex_ba_externallly_locked ]
+ [ thread-run ../example/producer_consumer.cpp ]
 
     ;
 
@@ -737,7 +738,7 @@
           #[ thread-run ../example/perf_condition_variable.cpp ]
           #[ thread-run ../example/perf_shared_mutex.cpp ]
           #[ thread-run ../example/not_interleaved.cpp ]
-
+
     ;
 
 }

Date view Thread view Subject view Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk