#ifndef BOOST_THREAD_SYNC_BOUNDED_QUEUE_HPP #define BOOST_THREAD_SYNC_BOUNDED_QUEUE_HPP ////////////////////////////////////////////////////////////////////////////// // // (C) Copyright Vicente J. Botet Escriba 2013-2014. 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 #include #include #include #include #include #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD #include #include #endif #include namespace boost { template class sync_bounded_queue { public: typedef ValueType value_type; typedef std::size_t size_type; // Constructors/Assignment/Destructors BOOST_THREAD_NO_COPYABLE(sync_bounded_queue) explicit sync_bounded_queue(size_type max_elems); template sync_bounded_queue(size_type max_elems, Range range); ~sync_bounded_queue(); // Observers inline bool empty() const; inline bool full() const; inline size_type capacity() const; inline size_type size() const; inline bool closed() const; // Modifiers inline void close(); #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD inline void push(const value_type& x); inline void push(BOOST_THREAD_RV_REF(value_type) x); inline bool try_push(const value_type& x); inline bool try_push(BOOST_THREAD_RV_REF(value_type) x); inline bool try_push(no_block_tag, const value_type& x); inline bool try_push(no_block_tag, BOOST_THREAD_RV_REF(value_type) x); #endif inline void push_back(const value_type& x); inline void push_back(BOOST_THREAD_RV_REF(value_type) x); inline queue_op_status try_push_back(const value_type& x); inline queue_op_status try_push_back(BOOST_THREAD_RV_REF(value_type) x); inline queue_op_status nonblocking_push_back(const value_type& x); inline queue_op_status nonblocking_push_back(BOOST_THREAD_RV_REF(value_type) x); inline queue_op_status wait_push_back(const value_type& x); inline queue_op_status wait_push_back(BOOST_THREAD_RV_REF(value_type) x); // Observers/Modifiers #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD inline void pull(value_type&); // enable_if is_nothrow_copy_movable inline value_type pull(); inline shared_ptr ptr_pull(); inline bool try_pull(value_type&); inline bool try_pull(no_block_tag,value_type&); inline shared_ptr try_pull(); #endif inline void pull_front(value_type&); // enable_if is_nothrow_copy_movable inline value_type pull_front(); inline queue_op_status try_pull_front(value_type&); inline queue_op_status nonblocking_pull_front(value_type&); inline queue_op_status wait_pull_front(ValueType& elem); 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_; inline size_type inc(size_type idx) const BOOST_NOEXCEPT { return (idx + 1) % capacity_; } inline bool empty(unique_lock& ) const BOOST_NOEXCEPT { return in_ == out_; } inline bool empty(lock_guard& ) const BOOST_NOEXCEPT { return in_ == out_; } inline bool full(unique_lock& ) const BOOST_NOEXCEPT { return (inc(in_) == out_); } inline bool full(lock_guard& ) const BOOST_NOEXCEPT { return (inc(in_) == out_); } inline size_type capacity(lock_guard& ) const BOOST_NOEXCEPT { return capacity_-1; } inline size_type size(lock_guard& lk) const BOOST_NOEXCEPT { if (full(lk)) return capacity(lk); return ((out_+capacity(lk)-in_) % capacity(lk)); } inline void throw_if_closed(unique_lock&); inline bool closed(unique_lock&) const; #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD inline bool try_pull(value_type& x, unique_lock& lk); inline shared_ptr try_pull(unique_lock& lk); inline bool try_push(const value_type& x, unique_lock& lk); inline bool try_push(BOOST_THREAD_RV_REF(value_type) x, unique_lock& lk); #endif inline queue_op_status try_pull_front(value_type& x, unique_lock& lk); inline queue_op_status try_push_back(const value_type& x, unique_lock& lk); inline queue_op_status try_push_back(BOOST_THREAD_RV_REF(value_type) x, unique_lock& lk); inline queue_op_status wait_pull_front(value_type& x, unique_lock& lk); inline queue_op_status wait_push_back(const value_type& x, unique_lock& lk); inline queue_op_status wait_push_back(BOOST_THREAD_RV_REF(value_type) x, unique_lock& lk); inline void wait_until_not_empty(unique_lock& lk); inline void wait_until_not_empty(unique_lock& lk, bool&); inline size_type wait_until_not_full(unique_lock& lk); inline size_type wait_until_not_full(unique_lock& lk, bool&); inline void notify_not_empty_if_needed(unique_lock& lk) { if (waiting_empty_ > 0) { --waiting_empty_; lk.unlock(); not_empty_.notify_one(); } } inline void notify_not_full_if_needed(unique_lock& lk) { if (waiting_full_ > 0) { --waiting_full_; lk.unlock(); not_full_.notify_one(); } } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD inline void pull(value_type& elem, unique_lock& lk) { elem = boost::move(data_[out_]); out_ = inc(out_); notify_not_full_if_needed(lk); } inline value_type pull(unique_lock& lk) { value_type elem = boost::move(data_[out_]); out_ = inc(out_); notify_not_full_if_needed(lk); return boost::move(elem); } inline boost::shared_ptr ptr_pull(unique_lock& lk) { shared_ptr res = make_shared(boost::move(data_[out_])); out_ = inc(out_); notify_not_full_if_needed(lk); return res; } #endif inline void pull_front(value_type& elem, unique_lock& lk) { elem = boost::move(data_[out_]); out_ = inc(out_); notify_not_full_if_needed(lk); } inline value_type pull_front(unique_lock& lk) { value_type elem = boost::move(data_[out_]); out_ = inc(out_); notify_not_full_if_needed(lk); return boost::move(elem); } inline void set_in(size_type in, unique_lock& lk) { in_ = in; notify_not_empty_if_needed(lk); } inline void push_at(const value_type& elem, size_type in_p_1, unique_lock& lk) { data_[in_] = elem; set_in(in_p_1, lk); } inline void push_at(BOOST_THREAD_RV_REF(value_type) elem, size_type in_p_1, unique_lock& lk) { data_[in_] = boost::move(elem); set_in(in_p_1, lk); } }; template sync_bounded_queue::sync_bounded_queue(typename sync_bounded_queue::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 // template // sync_bounded_queue::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 sync_bounded_queue::~sync_bounded_queue() { delete[] data_; } template void sync_bounded_queue::close() { { lock_guard lk(mtx_); closed_ = true; } not_empty_.notify_all(); not_full_.notify_all(); } template bool sync_bounded_queue::closed() const { lock_guard lk(mtx_); return closed_; } template bool sync_bounded_queue::closed(unique_lock& ) const { return closed_; } template bool sync_bounded_queue::empty() const { lock_guard lk(mtx_); return empty(lk); } template bool sync_bounded_queue::full() const { lock_guard lk(mtx_); return full(lk); } template typename sync_bounded_queue::size_type sync_bounded_queue::capacity() const { lock_guard lk(mtx_); return capacity(lk); } template typename sync_bounded_queue::size_type sync_bounded_queue::size() const { lock_guard lk(mtx_); return size(lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_pull(ValueType& elem, unique_lock& lk) { if (empty(lk)) { throw_if_closed(lk); return false; } pull(elem, lk); return true; } template shared_ptr sync_bounded_queue::try_pull(unique_lock& lk) { if (empty(lk)) { throw_if_closed(lk); return shared_ptr(); } return ptr_pull(lk); } template bool sync_bounded_queue::try_pull(ValueType& elem) { unique_lock lk(mtx_); return try_pull(elem, lk); } #endif template queue_op_status sync_bounded_queue::try_pull_front(ValueType& elem, unique_lock& lk) { if (empty(lk)) { if (closed(lk)) return queue_op_status::closed; return queue_op_status::empty; } pull_front(elem, lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::try_pull_front(ValueType& elem) { unique_lock lk(mtx_); return try_pull_front(elem, lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_pull(no_block_tag,ValueType& elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) { return false; } return try_pull(elem, lk); } template boost::shared_ptr sync_bounded_queue::try_pull() { unique_lock lk(mtx_); return try_pull(lk); } #endif template queue_op_status sync_bounded_queue::nonblocking_pull_front(ValueType& elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) { return queue_op_status::busy; } return try_pull_front(elem, lk); } template void sync_bounded_queue::throw_if_closed(unique_lock&) { if (closed_) { BOOST_THROW_EXCEPTION( sync_queue_is_closed() ); } } template void sync_bounded_queue::wait_until_not_empty(unique_lock& lk) { for (;;) { if (out_ != in_) break; throw_if_closed(lk); ++waiting_empty_; not_empty_.wait(lk); } } template void sync_bounded_queue::wait_until_not_empty(unique_lock& lk, bool & closed) { for (;;) { if (out_ != in_) break; if (closed_) {closed=true; return;} ++waiting_empty_; not_empty_.wait(lk); } } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template void sync_bounded_queue::pull(ValueType& elem) { unique_lock lk(mtx_); wait_until_not_empty(lk); pull(elem, lk); } // template // void sync_bounded_queue::pull(ValueType& elem, bool & closed) // { // unique_lock lk(mtx_); // wait_until_not_empty(lk, closed); // if (closed) {return;} // pull(elem, lk); // } // enable if ValueType is nothrow movable template ValueType sync_bounded_queue::pull() { unique_lock lk(mtx_); wait_until_not_empty(lk); return pull(lk); } template boost::shared_ptr sync_bounded_queue::ptr_pull() { unique_lock lk(mtx_); wait_until_not_empty(lk); return ptr_pull(lk); } #endif template void sync_bounded_queue::pull_front(ValueType& elem) { unique_lock lk(mtx_); wait_until_not_empty(lk); pull_front(elem, lk); } // enable if ValueType is nothrow movable template ValueType sync_bounded_queue::pull_front() { unique_lock lk(mtx_); wait_until_not_empty(lk); return pull_front(lk); } template queue_op_status sync_bounded_queue::wait_pull_front(ValueType& elem, unique_lock& lk) { if (empty(lk) && closed(lk)) {return queue_op_status::closed;} wait_until_not_empty(lk); pull_front(elem, lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::wait_pull_front(ValueType& elem) { unique_lock lk(mtx_); return wait_pull_front(elem, lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_push(const ValueType& elem, unique_lock& 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 bool sync_bounded_queue::try_push(const ValueType& elem) { unique_lock lk(mtx_); return try_push(elem, lk); } #endif template queue_op_status sync_bounded_queue::try_push_back(const ValueType& elem, unique_lock& lk) { if (closed(lk)) return queue_op_status::closed; size_type in_p_1 = inc(in_); if (in_p_1 == out_) // full() { return queue_op_status::full; } push_at(elem, in_p_1, lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::try_push_back(const ValueType& elem) { unique_lock lk(mtx_); return try_push_back(elem, lk); } template queue_op_status sync_bounded_queue::wait_push_back(const ValueType& elem, unique_lock& lk) { if (closed(lk)) return queue_op_status::closed; push_at(elem, wait_until_not_full(lk), lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::wait_push_back(const ValueType& elem) { unique_lock lk(mtx_); return wait_push_back(elem, lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_push(no_block_tag, const ValueType& elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) return false; return try_push(elem, lk); } #endif template queue_op_status sync_bounded_queue::nonblocking_push_back(const ValueType& elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) return queue_op_status::busy; return try_push_back(elem, lk); } template typename sync_bounded_queue::size_type sync_bounded_queue::wait_until_not_full(unique_lock& 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); } } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template void sync_bounded_queue::push(const ValueType& elem) { unique_lock lk(mtx_); push_at(elem, wait_until_not_full(lk), lk); } #endif template void sync_bounded_queue::push_back(const ValueType& elem) { unique_lock lk(mtx_); push_at(elem, wait_until_not_full(lk), lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_push(BOOST_THREAD_RV_REF(ValueType) elem, unique_lock& 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 bool sync_bounded_queue::try_push(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_); return try_push(boost::move(elem), lk); } #endif template queue_op_status sync_bounded_queue::try_push_back(BOOST_THREAD_RV_REF(ValueType) elem, unique_lock& lk) { if (closed(lk)) return queue_op_status::closed; size_type in_p_1 = inc(in_); if (in_p_1 == out_) // full() { return queue_op_status::full; } push_at(boost::move(elem), in_p_1, lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::try_push_back(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_); return try_push_back(boost::move(elem), lk); } template queue_op_status sync_bounded_queue::wait_push_back(BOOST_THREAD_RV_REF(ValueType) elem, unique_lock& lk) { if (closed(lk)) return queue_op_status::closed; push_at(boost::move(elem), wait_until_not_full(lk), lk); return queue_op_status::success; } template queue_op_status sync_bounded_queue::wait_push_back(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_); return try_push_back(boost::move(elem), lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template bool sync_bounded_queue::try_push(no_block_tag, BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) { return false; } return try_push(boost::move(elem), lk); } #endif template queue_op_status sync_bounded_queue::nonblocking_push_back(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_, try_to_lock); if (!lk.owns_lock()) { return queue_op_status::busy; } return try_push_back(boost::move(elem), lk); } #ifndef BOOST_THREAD_QUEUE_DEPRECATE_OLD template void sync_bounded_queue::push(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_); push_at(boost::move(elem), wait_until_not_full(lk), lk); } #endif template void sync_bounded_queue::push_back(BOOST_THREAD_RV_REF(ValueType) elem) { unique_lock lk(mtx_); push_at(boost::move(elem), wait_until_not_full(lk), lk); } template sync_bounded_queue& operator<<(sync_bounded_queue& sbq, BOOST_THREAD_RV_REF(ValueType) elem) { sbq.push_back(boost::move(elem)); return sbq; } template sync_bounded_queue& operator<<(sync_bounded_queue& sbq, ValueType const&elem) { sbq.push_back(elem); return sbq; } template sync_bounded_queue& operator>>(sync_bounded_queue& sbq, ValueType &elem) { sbq.pull_front(elem); return sbq; } } #include #endif