1132 lines
35 KiB
C++
1132 lines
35 KiB
C++
//
|
|
// thread_pool.hpp
|
|
// ~~~~~~~~~~~~~~~
|
|
//
|
|
// Copyright (c) 2003-2021 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)
|
|
//
|
|
|
|
#ifndef ASIO_THREAD_POOL_HPP
|
|
#define ASIO_THREAD_POOL_HPP
|
|
|
|
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
|
# pragma once
|
|
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
|
|
|
#include "asio/detail/config.hpp"
|
|
#include "asio/detail/atomic_count.hpp"
|
|
#include "asio/detail/scheduler.hpp"
|
|
#include "asio/detail/thread_group.hpp"
|
|
#include "asio/execution.hpp"
|
|
#include "asio/execution_context.hpp"
|
|
|
|
#include "asio/detail/push_options.hpp"
|
|
|
|
namespace asio {
|
|
namespace detail {
|
|
struct thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(unsigned int, blocking_never = 1);
|
|
ASIO_STATIC_CONSTEXPR(unsigned int, blocking_always = 2);
|
|
ASIO_STATIC_CONSTEXPR(unsigned int, blocking_mask = 3);
|
|
ASIO_STATIC_CONSTEXPR(unsigned int, relationship_continuation = 4);
|
|
ASIO_STATIC_CONSTEXPR(unsigned int, outstanding_work_tracked = 8);
|
|
};
|
|
} // namespace detail
|
|
|
|
/// A simple fixed-size thread pool.
|
|
/**
|
|
* The thread pool class is an execution context where functions are permitted
|
|
* to run on one of a fixed number of threads.
|
|
*
|
|
* @par Submitting tasks to the pool
|
|
*
|
|
* To submit functions to the thread pool, use the @ref asio::dispatch,
|
|
* @ref asio::post or @ref asio::defer free functions.
|
|
*
|
|
* For example:
|
|
*
|
|
* @code void my_task()
|
|
* {
|
|
* ...
|
|
* }
|
|
*
|
|
* ...
|
|
*
|
|
* // Launch the pool with four threads.
|
|
* asio::thread_pool pool(4);
|
|
*
|
|
* // Submit a function to the pool.
|
|
* asio::post(pool, my_task);
|
|
*
|
|
* // Submit a lambda object to the pool.
|
|
* asio::post(pool,
|
|
* []()
|
|
* {
|
|
* ...
|
|
* });
|
|
*
|
|
* // Wait for all tasks in the pool to complete.
|
|
* pool.join(); @endcode
|
|
*/
|
|
class thread_pool
|
|
: public execution_context
|
|
{
|
|
public:
|
|
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(ASIO_NO_TS_EXECUTORS)
|
|
/// Constructs a pool with an automatically determined number of threads.
|
|
ASIO_DECL thread_pool();
|
|
#endif // !defined(ASIO_NO_TS_EXECUTORS)
|
|
|
|
/// Constructs a pool with a specified number of threads.
|
|
ASIO_DECL thread_pool(std::size_t num_threads);
|
|
|
|
/// Destructor.
|
|
/**
|
|
* Automatically stops and joins the pool, if not explicitly done beforehand.
|
|
*/
|
|
ASIO_DECL ~thread_pool();
|
|
|
|
/// Obtains the executor associated with the pool.
|
|
executor_type get_executor() ASIO_NOEXCEPT;
|
|
|
|
/// Obtains the executor associated with the pool.
|
|
executor_type executor() ASIO_NOEXCEPT;
|
|
|
|
/// Obtains the scheduler associated with the pool.
|
|
scheduler_type scheduler() ASIO_NOEXCEPT;
|
|
|
|
/// Stops the threads.
|
|
/**
|
|
* This function stops the threads as soon as possible. As a result of calling
|
|
* @c stop(), pending function objects may be never be invoked.
|
|
*/
|
|
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.
|
|
*/
|
|
ASIO_DECL void attach();
|
|
|
|
/// Joins the threads.
|
|
/**
|
|
* This function blocks until the threads in the pool have completed. If @c
|
|
* stop() is not called prior to @c join(), the @c join() call will wait
|
|
* until the pool has no more outstanding work.
|
|
*/
|
|
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.
|
|
*/
|
|
ASIO_DECL void wait();
|
|
|
|
private:
|
|
thread_pool(const thread_pool&) ASIO_DELETED;
|
|
thread_pool& operator=(const thread_pool&) ASIO_DELETED;
|
|
|
|
struct thread_function;
|
|
|
|
// Helper function to create the underlying scheduler.
|
|
ASIO_DECL detail::scheduler& add_scheduler(detail::scheduler* s);
|
|
|
|
// The underlying scheduler.
|
|
detail::scheduler& scheduler_;
|
|
|
|
// The threads in the pool.
|
|
detail::thread_group threads_;
|
|
|
|
// The current number of threads in the pool.
|
|
detail::atomic_count num_threads_;
|
|
};
|
|
|
|
/// 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(ASIO_HAS_DEDUCED_EXECUTION_IS_TYPED_SENDER_TRAIT) \
|
|
&& defined(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>;
|
|
|
|
ASIO_STATIC_CONSTEXPR(bool, sends_done = true);
|
|
#endif // defined(ASIO_HAS_DEDUCED_EXECUTION_IS_TYPED_SENDER_TRAIT)
|
|
// && defined(ASIO_HAS_STD_EXCEPTION_PTR)
|
|
|
|
/// Copy constructor.
|
|
basic_executor_type(
|
|
const basic_executor_type& other) ASIO_NOEXCEPT
|
|
: pool_(other.pool_),
|
|
allocator_(other.allocator_),
|
|
bits_(other.bits_)
|
|
{
|
|
if (Bits & outstanding_work_tracked)
|
|
if (pool_)
|
|
pool_->scheduler_.work_started();
|
|
}
|
|
|
|
#if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
|
|
/// Move constructor.
|
|
basic_executor_type(basic_executor_type&& other) ASIO_NOEXCEPT
|
|
: pool_(other.pool_),
|
|
allocator_(ASIO_MOVE_CAST(Allocator)(other.allocator_)),
|
|
bits_(other.bits_)
|
|
{
|
|
if (Bits & outstanding_work_tracked)
|
|
other.pool_ = 0;
|
|
}
|
|
#endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
|
|
|
|
/// Destructor.
|
|
~basic_executor_type() ASIO_NOEXCEPT
|
|
{
|
|
if (Bits & outstanding_work_tracked)
|
|
if (pool_)
|
|
pool_->scheduler_.work_finished();
|
|
}
|
|
|
|
/// Assignment operator.
|
|
basic_executor_type& operator=(
|
|
const basic_executor_type& other) ASIO_NOEXCEPT;
|
|
|
|
#if defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
|
|
/// Move assignment operator.
|
|
basic_executor_type& operator=(
|
|
basic_executor_type&& other) ASIO_NOEXCEPT;
|
|
#endif // defined(ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
|
|
|
|
#if !defined(GENERATING_DOCUMENTATION)
|
|
private:
|
|
friend struct asio_require_fn::impl;
|
|
friend struct asio_prefer_fn::impl;
|
|
#endif // !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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::blocking.possibly); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR basic_executor_type<Allocator,
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::blocking.always); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR basic_executor_type<Allocator,
|
|
ASIO_UNSPECIFIED((Bits & ~blocking_mask) | blocking_always)>
|
|
require(execution::blocking_t::always_t) const
|
|
{
|
|
return basic_executor_type<Allocator,
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::blocking.never); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR basic_executor_type<Allocator,
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::relationship.fork); @endcode
|
|
*/
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::relationship.continuation); @endcode
|
|
*/
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::outstanding_work.tracked); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR basic_executor_type<Allocator,
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::outstanding_work.untracked); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR basic_executor_type<Allocator,
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::allocator(my_allocator)); @endcode
|
|
*/
|
|
template <typename OtherAllocator>
|
|
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
|
|
* asio::require customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex1 = my_thread_pool.executor();
|
|
* auto ex2 = asio::require(ex1,
|
|
* asio::execution::allocator); @endcode
|
|
*/
|
|
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_);
|
|
}
|
|
|
|
#if !defined(GENERATING_DOCUMENTATION)
|
|
private:
|
|
friend struct asio_query_fn::impl;
|
|
friend struct asio::execution::detail::mapping_t<0>;
|
|
friend struct asio::execution::detail::outstanding_work_t<0>;
|
|
#endif // !defined(GENERATING_DOCUMENTATION)
|
|
|
|
/// Query the current value of the @c bulk_guarantee property.
|
|
/**
|
|
* Do not call this function directly. It is intended for use with the
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* if (asio::query(ex, asio::execution::bulk_guarantee)
|
|
* == asio::execution::bulk_guarantee.parallel)
|
|
* ... @endcode
|
|
*/
|
|
static ASIO_CONSTEXPR execution::bulk_guarantee_t query(
|
|
execution::bulk_guarantee_t) 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* if (asio::query(ex, asio::execution::mapping)
|
|
* == asio::execution::mapping.thread)
|
|
* ... @endcode
|
|
*/
|
|
static ASIO_CONSTEXPR execution::mapping_t query(
|
|
execution::mapping_t) 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* asio::thread_pool& pool = asio::query(
|
|
* ex, asio::execution::context); @endcode
|
|
*/
|
|
thread_pool& query(execution::context_t) const 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* if (asio::query(ex, asio::execution::blocking)
|
|
* == asio::execution::blocking.always)
|
|
* ... @endcode
|
|
*/
|
|
ASIO_CONSTEXPR execution::blocking_t query(
|
|
execution::blocking_t) const 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* if (asio::query(ex, asio::execution::relationship)
|
|
* == asio::execution::relationship.continuation)
|
|
* ... @endcode
|
|
*/
|
|
ASIO_CONSTEXPR execution::relationship_t query(
|
|
execution::relationship_t) const 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* if (asio::query(ex, asio::execution::outstanding_work)
|
|
* == asio::execution::outstanding_work.tracked)
|
|
* ... @endcode
|
|
*/
|
|
static ASIO_CONSTEXPR execution::outstanding_work_t query(
|
|
execution::outstanding_work_t) 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* auto alloc = asio::query(ex,
|
|
* asio::execution::allocator); @endcode
|
|
*/
|
|
template <typename OtherAllocator>
|
|
ASIO_CONSTEXPR Allocator query(
|
|
execution::allocator_t<OtherAllocator>) const 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* auto alloc = asio::query(ex,
|
|
* asio::execution::allocator); @endcode
|
|
*/
|
|
ASIO_CONSTEXPR Allocator query(
|
|
execution::allocator_t<void>) const 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
|
|
* asio::query customisation point.
|
|
*
|
|
* For example:
|
|
* @code auto ex = my_thread_pool.executor();
|
|
* std::size_t occupancy = asio::query(
|
|
* ex, asio::execution::occupancy); @endcode
|
|
*/
|
|
std::size_t query(execution::occupancy_t) const ASIO_NOEXCEPT
|
|
{
|
|
return static_cast<std::size_t>(pool_->num_threads_);
|
|
}
|
|
|
|
public:
|
|
/// 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 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) 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) ASIO_NOEXCEPT
|
|
{
|
|
return a.pool_ != b.pool_
|
|
|| a.allocator_ != b.allocator_
|
|
|| a.bits_ != b.bits_;
|
|
}
|
|
|
|
#if !defined(GENERATING_DOCUMENTATION)
|
|
private:
|
|
friend struct asio_execution_execute_fn::impl;
|
|
#endif // !defined(GENERATING_DOCUMENTATION)
|
|
|
|
/// 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(ASIO_MOVE_ARG(Function) f) const
|
|
{
|
|
this->do_execute(ASIO_MOVE_CAST(Function)(f),
|
|
integral_constant<bool, (Bits & blocking_always) != 0>());
|
|
}
|
|
|
|
public:
|
|
/// Bulk execution function.
|
|
template <typename Function>
|
|
void bulk_execute(ASIO_MOVE_ARG(Function) f, std::size_t n) const
|
|
{
|
|
this->do_bulk_execute(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 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 <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(ASIO_MOVE_ARG(Receiver) r) const
|
|
{
|
|
return execution::detail::as_operation<basic_executor_type, Receiver>(
|
|
*this, ASIO_MOVE_CAST(Receiver)(r));
|
|
}
|
|
|
|
#if !defined(ASIO_NO_TS_EXECUTORS)
|
|
/// Obtain the underlying execution context.
|
|
thread_pool& context() const ASIO_NOEXCEPT;
|
|
|
|
/// Inform the thread pool that it has some outstanding work to do.
|
|
/**
|
|
* This function is used to inform the thread pool that some work has begun.
|
|
* This ensures that the thread pool's join() function will not return while
|
|
* the work is underway.
|
|
*/
|
|
void on_work_started() const ASIO_NOEXCEPT;
|
|
|
|
/// Inform the thread pool that some work is no longer outstanding.
|
|
/**
|
|
* This function is used to inform the thread pool that some work has
|
|
* finished. Once the count of unfinished work reaches zero, the thread
|
|
* pool's join() function is permitted to exit.
|
|
*/
|
|
void on_work_finished() const ASIO_NOEXCEPT;
|
|
|
|
/// Request the thread pool to invoke the given function object.
|
|
/**
|
|
* This function is used to ask the thread pool to execute the given function
|
|
* object. If the current thread belongs to the pool, @c dispatch() executes
|
|
* the function before returning. Otherwise, the function will be scheduled
|
|
* to run on the thread pool.
|
|
*
|
|
* @param f The function object to be called. The executor will make
|
|
* a copy of the handler object as required. The function signature of the
|
|
* function object must be: @code void function(); @endcode
|
|
*
|
|
* @param a An allocator that may be used by the executor to allocate the
|
|
* internal storage needed for function invocation.
|
|
*/
|
|
template <typename Function, typename OtherAllocator>
|
|
void dispatch(ASIO_MOVE_ARG(Function) f,
|
|
const OtherAllocator& a) const;
|
|
|
|
/// Request the thread pool to invoke the given function object.
|
|
/**
|
|
* This function is used to ask the thread pool to execute the given function
|
|
* object. The function object will never be executed inside @c post().
|
|
* Instead, it will be scheduled to run on the thread pool.
|
|
*
|
|
* @param f The function object to be called. The executor will make
|
|
* a copy of the handler object as required. The function signature of the
|
|
* function object must be: @code void function(); @endcode
|
|
*
|
|
* @param a An allocator that may be used by the executor to allocate the
|
|
* internal storage needed for function invocation.
|
|
*/
|
|
template <typename Function, typename OtherAllocator>
|
|
void post(ASIO_MOVE_ARG(Function) f,
|
|
const OtherAllocator& a) const;
|
|
|
|
/// Request the thread pool to invoke the given function object.
|
|
/**
|
|
* This function is used to ask the thread pool to execute the given function
|
|
* object. The function object will never be executed inside @c defer().
|
|
* Instead, it will be scheduled to run on the thread pool.
|
|
*
|
|
* If the current thread belongs to the thread pool, @c defer() will delay
|
|
* scheduling the function object until the current thread returns control to
|
|
* the pool.
|
|
*
|
|
* @param f The function object to be called. The executor will make
|
|
* a copy of the handler object as required. The function signature of the
|
|
* function object must be: @code void function(); @endcode
|
|
*
|
|
* @param a An allocator that may be used by the executor to allocate the
|
|
* internal storage needed for function invocation.
|
|
*/
|
|
template <typename Function, typename OtherAllocator>
|
|
void defer(ASIO_MOVE_ARG(Function) f,
|
|
const OtherAllocator& a) const;
|
|
#endif // !defined(ASIO_NO_TS_EXECUTORS)
|
|
|
|
private:
|
|
friend class thread_pool;
|
|
template <typename, unsigned int> friend class basic_executor_type;
|
|
|
|
// Constructor used by thread_pool::get_executor().
|
|
explicit basic_executor_type(thread_pool& p) ASIO_NOEXCEPT
|
|
: pool_(&p),
|
|
allocator_(),
|
|
bits_(0)
|
|
{
|
|
if (Bits & outstanding_work_tracked)
|
|
pool_->scheduler_.work_started();
|
|
}
|
|
|
|
// Constructor used by require().
|
|
basic_executor_type(thread_pool* p,
|
|
const Allocator& a, unsigned int bits) ASIO_NOEXCEPT
|
|
: pool_(p),
|
|
allocator_(a),
|
|
bits_(bits)
|
|
{
|
|
if (Bits & outstanding_work_tracked)
|
|
if (pool_)
|
|
pool_->scheduler_.work_started();
|
|
}
|
|
|
|
/// Execution helper implementation for possibly and never blocking.
|
|
template <typename Function>
|
|
void do_execute(ASIO_MOVE_ARG(Function) f, false_type) const;
|
|
|
|
/// Execution helper implementation for always blocking.
|
|
template <typename Function>
|
|
void do_execute(ASIO_MOVE_ARG(Function) f, true_type) const;
|
|
|
|
/// Bulk execution helper implementation for possibly and never blocking.
|
|
template <typename Function>
|
|
void do_bulk_execute(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(ASIO_MOVE_ARG(Function) f,
|
|
std::size_t n, true_type) const;
|
|
|
|
// The underlying thread 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(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct equality_comparable<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Function>
|
|
struct execute_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Function
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef void result_type;
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_EXECUTE_MEMBER_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_SCHEDULE_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct schedule_member<
|
|
const asio::thread_pool::basic_executor_type<Allocator, Bits>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits> result_type;
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_SCHEDULE_MEMBER_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_CONNECT_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Receiver>
|
|
struct connect_member<
|
|
const asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Receiver
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::execution::detail::as_operation<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Receiver> result_type;
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_CONNECT_MEMBER_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::blocking_t::possibly_t
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits & ~blocking_mask> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::blocking_t::always_t
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<Allocator,
|
|
(Bits & ~blocking_mask) | blocking_always> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::blocking_t::never_t
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits & ~blocking_mask> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::relationship_t::fork_t
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::relationship_t::continuation_t
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::outstanding_work_t::tracked_t
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits | outstanding_work_tracked> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::outstanding_work_t::untracked_t
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
Allocator, Bits & ~outstanding_work_tracked> result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::allocator_t<void>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
std::allocator<void>, Bits> result_type;
|
|
};
|
|
|
|
template <unsigned int Bits,
|
|
typename Allocator, typename OtherAllocator>
|
|
struct require_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::allocator_t<OtherAllocator>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = false);
|
|
typedef asio::thread_pool::basic_executor_type<
|
|
OtherAllocator, Bits> result_type;
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_REQUIRE_MEMBER_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Property>
|
|
struct query_static_constexpr_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Property,
|
|
typename asio::enable_if<
|
|
asio::is_convertible<
|
|
Property,
|
|
asio::execution::bulk_guarantee_t
|
|
>::value
|
|
>::type
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::execution::bulk_guarantee_t::parallel_t result_type;
|
|
|
|
static ASIO_CONSTEXPR result_type value() ASIO_NOEXCEPT
|
|
{
|
|
return result_type();
|
|
}
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Property>
|
|
struct query_static_constexpr_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Property,
|
|
typename asio::enable_if<
|
|
asio::is_convertible<
|
|
Property,
|
|
asio::execution::outstanding_work_t
|
|
>::value
|
|
>::type
|
|
> : asio::detail::thread_pool_bits
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::execution::outstanding_work_t result_type;
|
|
|
|
static ASIO_CONSTEXPR result_type value() 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<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Property,
|
|
typename asio::enable_if<
|
|
asio::is_convertible<
|
|
Property,
|
|
asio::execution::mapping_t
|
|
>::value
|
|
>::type
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::execution::mapping_t::thread_t result_type;
|
|
|
|
static ASIO_CONSTEXPR result_type value() ASIO_NOEXCEPT
|
|
{
|
|
return result_type();
|
|
}
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_QUERY_STATIC_CONSTEXPR_MEMBER_TRAIT)
|
|
|
|
#if !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Property>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Property,
|
|
typename asio::enable_if<
|
|
asio::is_convertible<
|
|
Property,
|
|
asio::execution::blocking_t
|
|
>::value
|
|
>::type
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::execution::blocking_t result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits, typename Property>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
Property,
|
|
typename asio::enable_if<
|
|
asio::is_convertible<
|
|
Property,
|
|
asio::execution::relationship_t
|
|
>::value
|
|
>::type
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::execution::relationship_t result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::occupancy_t
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef std::size_t result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::context_t
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef asio::thread_pool& result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::allocator_t<void>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef Allocator result_type;
|
|
};
|
|
|
|
template <typename Allocator, unsigned int Bits, typename OtherAllocator>
|
|
struct query_member<
|
|
asio::thread_pool::basic_executor_type<Allocator, Bits>,
|
|
asio::execution::allocator_t<OtherAllocator>
|
|
>
|
|
{
|
|
ASIO_STATIC_CONSTEXPR(bool, is_valid = true);
|
|
ASIO_STATIC_CONSTEXPR(bool, is_noexcept = true);
|
|
typedef Allocator result_type;
|
|
};
|
|
|
|
#endif // !defined(ASIO_HAS_DEDUCED_QUERY_MEMBER_TRAIT)
|
|
|
|
} // namespace traits
|
|
|
|
#endif // !defined(GENERATING_DOCUMENTATION)
|
|
|
|
} // namespace asio
|
|
|
|
#include "asio/detail/pop_options.hpp"
|
|
|
|
#include "asio/impl/thread_pool.hpp"
|
|
#if defined(ASIO_HEADER_ONLY)
|
|
# include "asio/impl/thread_pool.ipp"
|
|
#endif // defined(ASIO_HEADER_ONLY)
|
|
|
|
#endif // ASIO_THREAD_POOL_HPP
|