// thread_pool.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2019 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2020 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// 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)
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include <boost/asio/detail/config.hpp>
-#include <boost/asio/detail/noncopyable.hpp>
+#include <boost/asio/detail/atomic_count.hpp>
#include <boost/asio/detail/scheduler.hpp>
#include <boost/asio/detail/thread_group.hpp>
+#include <boost/asio/execution.hpp>
#include <boost/asio/execution_context.hpp>
#include <boost/asio/detail/push_options.hpp>
namespace boost {
namespace asio {
+namespace detail {
+ struct thread_pool_bits
+ {
+ BOOST_ASIO_STATIC_CONSTEXPR(unsigned int, blocking_never = 1);
+ BOOST_ASIO_STATIC_CONSTEXPR(unsigned int, blocking_always = 2);
+ BOOST_ASIO_STATIC_CONSTEXPR(unsigned int, blocking_mask = 3);
+ BOOST_ASIO_STATIC_CONSTEXPR(unsigned int, relationship_continuation = 4);
+ BOOST_ASIO_STATIC_CONSTEXPR(unsigned int, outstanding_work_tracked = 8);
+ };
+} // namespace detail
/// A simple fixed-size thread pool.
/**
*
* @par Submitting tasks to the pool
*
- * To submit functions to the thread_pool, use the @ref boost::asio::dispatch,
+ * To submit functions to the thread pool, use the @ref boost::asio::dispatch,
* @ref boost::asio::post or @ref boost::asio::defer free functions.
*
* For example:
: public execution_context
{
public:
- class executor_type;
+ template <typename Allocator, unsigned int Bits>
+ class basic_executor_type;
+
+ template <typename Allocator, unsigned int Bits>
+ friend class basic_executor_type;
+
+ /// Executor used to submit functions to a thread pool.
+ typedef basic_executor_type<std::allocator<void>, 0> executor_type;
+ /// Scheduler used to schedule receivers on a thread pool.
+ typedef basic_executor_type<std::allocator<void>, 0> scheduler_type;
+
+#if !defined(BOOST_ASIO_NO_TS_EXECUTORS)
/// Constructs a pool with an automatically determined number of threads.
BOOST_ASIO_DECL thread_pool();
+#endif // !defined(BOOST_ASIO_NO_TS_EXECUTORS)
/// Constructs a pool with a specified number of threads.
BOOST_ASIO_DECL thread_pool(std::size_t num_threads);
/// Obtains the executor associated with the pool.
executor_type get_executor() BOOST_ASIO_NOEXCEPT;
+ /// Obtains the executor associated with the pool.
+ executor_type executor() BOOST_ASIO_NOEXCEPT;
+
+ /// Obtains the scheduler associated with the pool.
+ scheduler_type scheduler() BOOST_ASIO_NOEXCEPT;
+
/// Stops the threads.
/**
* This function stops the threads as soon as possible. As a result of calling
*/
BOOST_ASIO_DECL void stop();
+ /// Attaches the current thread to the pool.
+ /**
+ * This function attaches the current thread to the pool so that it may be
+ * used for executing submitted function objects. Blocks the calling thread
+ * until the pool is stopped or joined and has no outstanding work.
+ */
+ BOOST_ASIO_DECL void attach();
+
/// Joins the threads.
/**
* This function blocks until the threads in the pool have completed. If @c
*/
BOOST_ASIO_DECL void join();
+ /// Waits for threads to complete.
+ /**
+ * This function blocks until the threads in the pool have completed. If @c
+ * stop() is not called prior to @c wait(), the @c wait() call will wait
+ * until the pool has no more outstanding work.
+ */
+ BOOST_ASIO_DECL void wait();
+
private:
- friend class executor_type;
+ thread_pool(const thread_pool&) BOOST_ASIO_DELETED;
+ thread_pool& operator=(const thread_pool&) BOOST_ASIO_DELETED;
+
struct thread_function;
// Helper function to create the underlying scheduler.
// The threads in the pool.
detail::thread_group threads_;
+
+ // The current number of threads in the pool.
+ detail::atomic_count num_threads_;
};
-/// Executor used to submit functions to a thread pool.
-class thread_pool::executor_type
+/// Executor implementation type used to submit functions to a thread pool.
+template <typename Allocator, unsigned int Bits>
+class thread_pool::basic_executor_type : detail::thread_pool_bits
{
public:
+ /// The sender type, when this type is used as a scheduler.
+ typedef basic_executor_type sender_type;
+
+ /// The bulk execution shape type.
+ typedef std::size_t shape_type;
+
+ /// The bulk execution index type.
+ typedef std::size_t index_type;
+
+#if defined(BOOST_ASIO_HAS_DEDUCED_EXECUTION_IS_TYPED_SENDER_TRAIT) \
+ && defined(BOOST_ASIO_HAS_STD_EXCEPTION_PTR)
+ template <
+ template <typename...> class Tuple,
+ template <typename...> class Variant>
+ using value_types = Variant<Tuple<>>;
+
+ template <template <typename...> class Variant>
+ using error_types = Variant<std::exception_ptr>;
+
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, sends_done = true);
+#endif // defined(BOOST_ASIO_HAS_DEDUCED_EXECUTION_IS_TYPED_SENDER_TRAIT)
+ // && defined(BOOST_ASIO_HAS_STD_EXCEPTION_PTR)
+
+ /// Copy constructor.
+ basic_executor_type(
+ const basic_executor_type& other) BOOST_ASIO_NOEXCEPT
+ : pool_(other.pool_),
+ allocator_(other.allocator_),
+ bits_(other.bits_)
+ {
+ if (Bits & outstanding_work_tracked)
+ if (pool_)
+ pool_->scheduler_.work_started();
+ }
+
+#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+ /// Move constructor.
+ basic_executor_type(basic_executor_type&& other) BOOST_ASIO_NOEXCEPT
+ : pool_(other.pool_),
+ allocator_(BOOST_ASIO_MOVE_CAST(Allocator)(other.allocator_)),
+ bits_(other.bits_)
+ {
+ if (Bits & outstanding_work_tracked)
+ other.pool_ = 0;
+ }
+#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+
+ /// Destructor.
+ ~basic_executor_type() BOOST_ASIO_NOEXCEPT
+ {
+ if (Bits & outstanding_work_tracked)
+ if (pool_)
+ pool_->scheduler_.work_finished();
+ }
+
+ /// Assignment operator.
+ basic_executor_type& operator=(
+ const basic_executor_type& other) BOOST_ASIO_NOEXCEPT;
+
+#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+ /// Move assignment operator.
+ basic_executor_type& operator=(
+ basic_executor_type&& other) BOOST_ASIO_NOEXCEPT;
+#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+
+ /// Obtain an executor with the @c blocking.possibly property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::blocking.possibly); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED(Bits & ~blocking_mask)>
+ require(execution::blocking_t::possibly_t) const
+ {
+ return basic_executor_type<Allocator, Bits & ~blocking_mask>(
+ pool_, allocator_, bits_ & ~blocking_mask);
+ }
+
+ /// Obtain an executor with the @c blocking.always property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::blocking.always); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED((Bits & ~blocking_mask) | blocking_always)>
+ require(execution::blocking_t::always_t) const
+ {
+ return basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED((Bits & ~blocking_mask) | blocking_always)>(
+ pool_, allocator_, bits_ & ~blocking_mask);
+ }
+
+ /// Obtain an executor with the @c blocking.never property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::blocking.never); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED(Bits & ~blocking_mask)>
+ require(execution::blocking_t::never_t) const
+ {
+ return basic_executor_type<Allocator, Bits & ~blocking_mask>(
+ pool_, allocator_, (bits_ & ~blocking_mask) | blocking_never);
+ }
+
+ /// Obtain an executor with the @c relationship.fork property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::relationship.fork); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type require(
+ execution::relationship_t::fork_t) const
+ {
+ return basic_executor_type(pool_,
+ allocator_, bits_ & ~relationship_continuation);
+ }
+
+ /// Obtain an executor with the @c relationship.continuation property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::relationship.continuation); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type require(
+ execution::relationship_t::continuation_t) const
+ {
+ return basic_executor_type(pool_,
+ allocator_, bits_ | relationship_continuation);
+ }
+
+ /// Obtain an executor with the @c outstanding_work.tracked property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::outstanding_work.tracked); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED(Bits | outstanding_work_tracked)>
+ require(execution::outstanding_work_t::tracked_t) const
+ {
+ return basic_executor_type<Allocator, Bits | outstanding_work_tracked>(
+ pool_, allocator_, bits_);
+ }
+
+ /// Obtain an executor with the @c outstanding_work.untracked property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::outstanding_work.untracked); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<Allocator,
+ BOOST_ASIO_UNSPECIFIED(Bits & ~outstanding_work_tracked)>
+ require(execution::outstanding_work_t::untracked_t) const
+ {
+ return basic_executor_type<Allocator, Bits & ~outstanding_work_tracked>(
+ pool_, allocator_, bits_);
+ }
+
+ /// Obtain an executor with the specified @c allocator property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::allocator(my_allocator)); @endcode
+ */
+ template <typename OtherAllocator>
+ BOOST_ASIO_CONSTEXPR basic_executor_type<OtherAllocator, Bits>
+ require(execution::allocator_t<OtherAllocator> a) const
+ {
+ return basic_executor_type<OtherAllocator, Bits>(
+ pool_, a.value(), bits_);
+ }
+
+ /// Obtain an executor with the default @c allocator property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::require customisation point.
+ *
+ * For example:
+ * @code auto ex1 = my_thread_pool.executor();
+ * auto ex2 = boost::asio::require(ex1,
+ * boost::asio::execution::allocator); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR basic_executor_type<std::allocator<void>, Bits>
+ require(execution::allocator_t<void>) const
+ {
+ return basic_executor_type<std::allocator<void>, Bits>(
+ pool_, std::allocator<void>(), bits_);
+ }
+
+ /// Query the current value of the @c bulk_guarantee property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * if (boost::asio::query(ex, boost::asio::execution::bulk_guarantee)
+ * == boost::asio::execution::bulk_guarantee.parallel)
+ * ... @endcode
+ */
+ static BOOST_ASIO_CONSTEXPR execution::bulk_guarantee_t query(
+ execution::bulk_guarantee_t) BOOST_ASIO_NOEXCEPT
+ {
+ return execution::bulk_guarantee.parallel;
+ }
+
+ /// Query the current value of the @c mapping property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * if (boost::asio::query(ex, boost::asio::execution::mapping)
+ * == boost::asio::execution::mapping.thread)
+ * ... @endcode
+ */
+ static BOOST_ASIO_CONSTEXPR execution::mapping_t query(
+ execution::mapping_t) BOOST_ASIO_NOEXCEPT
+ {
+ return execution::mapping.thread;
+ }
+
+ /// Query the current value of the @c context property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * boost::asio::thread_pool& pool = boost::asio::query(
+ * ex, boost::asio::execution::context); @endcode
+ */
+ thread_pool& query(execution::context_t) const BOOST_ASIO_NOEXCEPT
+ {
+ return *pool_;
+ }
+
+ /// Query the current value of the @c blocking property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * if (boost::asio::query(ex, boost::asio::execution::blocking)
+ * == boost::asio::execution::blocking.always)
+ * ... @endcode
+ */
+ BOOST_ASIO_CONSTEXPR execution::blocking_t query(
+ execution::blocking_t) const BOOST_ASIO_NOEXCEPT
+ {
+ return (bits_ & blocking_never)
+ ? execution::blocking_t(execution::blocking.never)
+ : ((Bits & blocking_always)
+ ? execution::blocking_t(execution::blocking.always)
+ : execution::blocking_t(execution::blocking.possibly));
+ }
+
+ /// Query the current value of the @c relationship property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * if (boost::asio::query(ex, boost::asio::execution::relationship)
+ * == boost::asio::execution::relationship.continuation)
+ * ... @endcode
+ */
+ BOOST_ASIO_CONSTEXPR execution::relationship_t query(
+ execution::relationship_t) const BOOST_ASIO_NOEXCEPT
+ {
+ return (bits_ & relationship_continuation)
+ ? execution::relationship_t(execution::relationship.continuation)
+ : execution::relationship_t(execution::relationship.fork);
+ }
+
+ /// Query the current value of the @c outstanding_work property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * if (boost::asio::query(ex, boost::asio::execution::outstanding_work)
+ * == boost::asio::execution::outstanding_work.tracked)
+ * ... @endcode
+ */
+ static BOOST_ASIO_CONSTEXPR execution::outstanding_work_t query(
+ execution::outstanding_work_t) BOOST_ASIO_NOEXCEPT
+ {
+ return (Bits & outstanding_work_tracked)
+ ? execution::outstanding_work_t(execution::outstanding_work.tracked)
+ : execution::outstanding_work_t(execution::outstanding_work.untracked);
+ }
+
+ /// Query the current value of the @c allocator property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * auto alloc = boost::asio::query(ex,
+ * boost::asio::execution::allocator); @endcode
+ */
+ template <typename OtherAllocator>
+ BOOST_ASIO_CONSTEXPR Allocator query(
+ execution::allocator_t<OtherAllocator>) const BOOST_ASIO_NOEXCEPT
+ {
+ return allocator_;
+ }
+
+ /// Query the current value of the @c allocator property.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * auto alloc = boost::asio::query(ex,
+ * boost::asio::execution::allocator); @endcode
+ */
+ BOOST_ASIO_CONSTEXPR Allocator query(
+ execution::allocator_t<void>) const BOOST_ASIO_NOEXCEPT
+ {
+ return allocator_;
+ }
+
+ /// Query the occupancy (recommended number of work items) for the pool.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * boost::asio::query customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * std::size_t occupancy = boost::asio::query(
+ * ex, boost::asio::execution::occupancy); @endcode
+ */
+ std::size_t query(execution::occupancy_t) const BOOST_ASIO_NOEXCEPT
+ {
+ return static_cast<std::size_t>(pool_->num_threads_);
+ }
+
+ /// Determine whether the thread pool is running in the current thread.
+ /**
+ * @return @c true if the current thread is running the thread pool. Otherwise
+ * returns @c false.
+ */
+ bool running_in_this_thread() const BOOST_ASIO_NOEXCEPT;
+
+ /// Compare two executors for equality.
+ /**
+ * Two executors are equal if they refer to the same underlying thread pool.
+ */
+ friend bool operator==(const basic_executor_type& a,
+ const basic_executor_type& b) BOOST_ASIO_NOEXCEPT
+ {
+ return a.pool_ == b.pool_
+ && a.allocator_ == b.allocator_
+ && a.bits_ == b.bits_;
+ }
+
+ /// Compare two executors for inequality.
+ /**
+ * Two executors are equal if they refer to the same underlying thread pool.
+ */
+ friend bool operator!=(const basic_executor_type& a,
+ const basic_executor_type& b) BOOST_ASIO_NOEXCEPT
+ {
+ return a.pool_ != b.pool_
+ || a.allocator_ != b.allocator_
+ || a.bits_ != b.bits_;
+ }
+
+ /// Execution function.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * execution::execute customisation point.
+ *
+ * For example:
+ * @code auto ex = my_thread_pool.executor();
+ * execution::execute(ex, my_function_object); @endcode
+ */
+ template <typename Function>
+ void execute(BOOST_ASIO_MOVE_ARG(Function) f) const
+ {
+ this->do_execute(BOOST_ASIO_MOVE_CAST(Function)(f),
+ integral_constant<bool, (Bits & blocking_always) != 0>());
+ }
+
+ /// Bulk execution function.
+ template <typename Function>
+ void bulk_execute(BOOST_ASIO_MOVE_ARG(Function) f, std::size_t n) const
+ {
+ this->do_bulk_execute(BOOST_ASIO_MOVE_CAST(Function)(f), n,
+ integral_constant<bool, (Bits & blocking_always) != 0>());
+ }
+
+ /// Schedule function.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * execution::schedule customisation point.
+ *
+ * @return An object that satisfies the sender concept.
+ */
+ sender_type schedule() const BOOST_ASIO_NOEXCEPT
+ {
+ return *this;
+ }
+
+ /// Connect function.
+ /**
+ * Do not call this function directly. It is intended for use with the
+ * execution::connect customisation point.
+ *
+ * @return An object of an unspecified type that satisfies the @c
+ * operation_state concept.
+ */
+ template <BOOST_ASIO_EXECUTION_RECEIVER_OF_0 Receiver>
+#if defined(GENERATING_DOCUMENTATION)
+ unspecified
+#else // defined(GENERATING_DOCUMENTATION)
+ execution::detail::as_operation<basic_executor_type, Receiver>
+#endif // defined(GENERATING_DOCUMENTATION)
+ connect(BOOST_ASIO_MOVE_ARG(Receiver) r) const
+ {
+ return execution::detail::as_operation<basic_executor_type, Receiver>(
+ *this, BOOST_ASIO_MOVE_CAST(Receiver)(r));
+ }
+
+#if !defined(BOOST_ASIO_NO_TS_EXECUTORS)
/// Obtain the underlying execution context.
thread_pool& context() const BOOST_ASIO_NOEXCEPT;
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
- template <typename Function, typename Allocator>
- void dispatch(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
+ template <typename Function, typename OtherAllocator>
+ void dispatch(BOOST_ASIO_MOVE_ARG(Function) f,
+ const OtherAllocator& a) const;
/// Request the thread pool to invoke the given function object.
/**
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
- template <typename Function, typename Allocator>
- void post(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
+ template <typename Function, typename OtherAllocator>
+ void post(BOOST_ASIO_MOVE_ARG(Function) f,
+ const OtherAllocator& a) const;
/// Request the thread pool to invoke the given function object.
/**
* @param a An allocator that may be used by the executor to allocate the
* internal storage needed for function invocation.
*/
- template <typename Function, typename Allocator>
- void defer(BOOST_ASIO_MOVE_ARG(Function) f, const Allocator& a) const;
+ template <typename Function, typename OtherAllocator>
+ void defer(BOOST_ASIO_MOVE_ARG(Function) f,
+ const OtherAllocator& a) const;
+#endif // !defined(BOOST_ASIO_NO_TS_EXECUTORS)
- /// Determine whether the thread pool is running in the current thread.
- /**
- * @return @c true if the current thread belongs to the pool. Otherwise
- * returns @c false.
- */
- bool running_in_this_thread() const BOOST_ASIO_NOEXCEPT;
+private:
+ friend class thread_pool;
+ template <typename, unsigned int> friend class basic_executor_type;
- /// Compare two executors for equality.
- /**
- * Two executors are equal if they refer to the same underlying thread pool.
- */
- friend bool operator==(const executor_type& a,
- const executor_type& b) BOOST_ASIO_NOEXCEPT
+ // Constructor used by thread_pool::get_executor().
+ explicit basic_executor_type(thread_pool& p) BOOST_ASIO_NOEXCEPT
+ : pool_(&p),
+ allocator_(),
+ bits_(0)
{
- return &a.pool_ == &b.pool_;
+ if (Bits & outstanding_work_tracked)
+ pool_->scheduler_.work_started();
}
- /// Compare two executors for inequality.
- /**
- * Two executors are equal if they refer to the same underlying thread pool.
- */
- friend bool operator!=(const executor_type& a,
- const executor_type& b) BOOST_ASIO_NOEXCEPT
+ // Constructor used by require().
+ basic_executor_type(thread_pool* p,
+ const Allocator& a, unsigned int bits) BOOST_ASIO_NOEXCEPT
+ : pool_(p),
+ allocator_(a),
+ bits_(bits)
{
- return &a.pool_ != &b.pool_;
+ if (Bits & outstanding_work_tracked)
+ if (pool_)
+ pool_->scheduler_.work_started();
}
-private:
- friend class thread_pool;
+ /// Execution helper implementation for possibly and never blocking.
+ template <typename Function>
+ void do_execute(BOOST_ASIO_MOVE_ARG(Function) f, false_type) const;
+
+ /// Execution helper implementation for always blocking.
+ template <typename Function>
+ void do_execute(BOOST_ASIO_MOVE_ARG(Function) f, true_type) const;
- // Constructor.
- explicit executor_type(thread_pool& p) : pool_(p) {}
+ /// Bulk execution helper implementation for possibly and never blocking.
+ template <typename Function>
+ void do_bulk_execute(BOOST_ASIO_MOVE_ARG(Function) f,
+ std::size_t n, false_type) const;
+
+ /// Bulk execution helper implementation for always blocking.
+ template <typename Function>
+ void do_bulk_execute(BOOST_ASIO_MOVE_ARG(Function) f,
+ std::size_t n, true_type) const;
// The underlying thread pool.
- thread_pool& pool_;
+ thread_pool* pool_;
+
+ // The allocator used for execution functions.
+ Allocator allocator_;
+
+ // The runtime-switched properties of the thread pool executor.
+ unsigned int bits_;
};
+#if !defined(GENERATING_DOCUMENTATION)
+
+namespace traits {
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
+
+template <typename Allocator, unsigned int Bits>
+struct equality_comparable<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits, typename Function>
+struct execute_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Function
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef void result_type;
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_SCHEDULE_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits>
+struct schedule_member<
+ const boost::asio::thread_pool::basic_executor_type<Allocator, Bits>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits> result_type;
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_SCHEDULE_MEMBER_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_CONNECT_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits, typename Receiver>
+struct connect_member<
+ const boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Receiver
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::execution::detail::as_operation<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Receiver> result_type;
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_CONNECT_MEMBER_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::blocking_t::possibly_t
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits & ~blocking_mask> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::blocking_t::always_t
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<Allocator,
+ (Bits & ~blocking_mask) | blocking_always> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::blocking_t::never_t
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits & ~blocking_mask> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::relationship_t::fork_t
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::relationship_t::continuation_t
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::outstanding_work_t::tracked_t
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits | outstanding_work_tracked> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::outstanding_work_t::untracked_t
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ Allocator, Bits & ~outstanding_work_tracked> result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::allocator_t<void>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ std::allocator<void>, Bits> result_type;
+};
+
+template <unsigned int Bits,
+ typename Allocator, typename OtherAllocator>
+struct require_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::allocator_t<OtherAllocator>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
+ typedef boost::asio::thread_pool::basic_executor_type<
+ OtherAllocator, Bits> result_type;
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits, typename Property>
+struct query_static_constexpr_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Property,
+ typename boost::asio::enable_if<
+ boost::asio::is_convertible<
+ Property,
+ boost::asio::execution::bulk_guarantee_t
+ >::value
+ >::type
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::execution::bulk_guarantee_t::parallel_t result_type;
+
+ static BOOST_ASIO_CONSTEXPR result_type value() BOOST_ASIO_NOEXCEPT
+ {
+ return result_type();
+ }
+};
+
+template <typename Allocator, unsigned int Bits, typename Property>
+struct query_static_constexpr_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Property,
+ typename boost::asio::enable_if<
+ boost::asio::is_convertible<
+ Property,
+ boost::asio::execution::outstanding_work_t
+ >::value
+ >::type
+ > : boost::asio::detail::thread_pool_bits
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::execution::outstanding_work_t result_type;
+
+ static BOOST_ASIO_CONSTEXPR result_type value() BOOST_ASIO_NOEXCEPT
+ {
+ return (Bits & outstanding_work_tracked)
+ ? execution::outstanding_work_t(execution::outstanding_work.tracked)
+ : execution::outstanding_work_t(execution::outstanding_work.untracked);
+ }
+};
+
+template <typename Allocator, unsigned int Bits, typename Property>
+struct query_static_constexpr_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Property,
+ typename boost::asio::enable_if<
+ boost::asio::is_convertible<
+ Property,
+ boost::asio::execution::mapping_t
+ >::value
+ >::type
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::execution::mapping_t::thread_t result_type;
+
+ static BOOST_ASIO_CONSTEXPR result_type value() BOOST_ASIO_NOEXCEPT
+ {
+ return result_type();
+ }
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
+
+#if !defined(BOOST_ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
+
+template <typename Allocator, unsigned int Bits, typename Property>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Property,
+ typename boost::asio::enable_if<
+ boost::asio::is_convertible<
+ Property,
+ boost::asio::execution::blocking_t
+ >::value
+ >::type
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::execution::blocking_t result_type;
+};
+
+template <typename Allocator, unsigned int Bits, typename Property>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ Property,
+ typename boost::asio::enable_if<
+ boost::asio::is_convertible<
+ Property,
+ boost::asio::execution::relationship_t
+ >::value
+ >::type
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::execution::relationship_t result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::occupancy_t
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef std::size_t result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::context_t
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef boost::asio::thread_pool& result_type;
+};
+
+template <typename Allocator, unsigned int Bits>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::allocator_t<void>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef Allocator result_type;
+};
+
+template <typename Allocator, unsigned int Bits, typename OtherAllocator>
+struct query_member<
+ boost::asio::thread_pool::basic_executor_type<Allocator, Bits>,
+ boost::asio::execution::allocator_t<OtherAllocator>
+ >
+{
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
+ BOOST_ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
+ typedef Allocator result_type;
+};
+
+#endif // !defined(BOOST_ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
+
+} // namespace traits
+
+#endif // !defined(GENERATING_DOCUMENTATION)
+
} // namespace asio
} // namespace boost
projects / ceph.git / blobdiff