123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177 |
- // Copyright (C) 2015 Vicente J. Botet Escriba
- //
- // 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)
- //
- // 2013/11 Vicente J. Botet Escriba
- // first implementation of a simple serial scheduler.
- #ifndef BOOST_THREAD_SERIAL_EXECUTOR_CONT_HPP
- #define BOOST_THREAD_SERIAL_EXECUTOR_CONT_HPP
- #include <boost/thread/detail/config.hpp>
- #if defined BOOST_THREAD_PROVIDES_FUTURE_CONTINUATION && defined BOOST_THREAD_PROVIDES_EXECUTORS && defined BOOST_THREAD_USES_MOVE
- #include <exception> // std::terminate
- #include <boost/throw_exception.hpp>
- #include <boost/thread/detail/delete.hpp>
- #include <boost/thread/detail/move.hpp>
- #include <boost/thread/concurrent_queues/sync_queue.hpp>
- #include <boost/thread/executors/work.hpp>
- #include <boost/thread/executors/generic_executor_ref.hpp>
- #include <boost/thread/mutex.hpp>
- #include <boost/thread/future.hpp>
- #include <boost/thread/scoped_thread.hpp>
- #include <boost/thread/lock_guard.hpp>
- #include <boost/config/abi_prefix.hpp>
- namespace boost
- {
- namespace executors
- {
- class serial_executor_cont
- {
- public:
- /// type-erasure to store the works to do
- typedef executors::work work;
- private:
- generic_executor_ref ex_;
- BOOST_THREAD_FUTURE<void> fut_; // protected by mtx_
- bool closed_; // protected by mtx_
- mutex mtx_;
- struct continuation {
- work task;
- template <class X>
- struct result {
- typedef void type;
- };
- continuation(BOOST_THREAD_RV_REF(work) tsk)
- : task(boost::move(tsk)) {}
- void operator()(BOOST_THREAD_FUTURE<void> f)
- {
- try {
- task();
- } catch (...) {
- std::terminate();
- }
- }
- };
- bool closed(lock_guard<mutex>&) const
- {
- return closed_;
- }
- public:
- /**
- * \par Returns
- * The underlying executor wrapped on a generic executor reference.
- */
- generic_executor_ref& underlying_executor() BOOST_NOEXCEPT { return ex_; }
- /// serial_executor_cont is not copyable.
- BOOST_THREAD_NO_COPYABLE(serial_executor_cont)
- /**
- * \b Effects: creates a serial executor that runs closures in fifo order using one the associated executor.
- *
- * \b Throws: Whatever exception is thrown while initializing the needed resources.
- *
- * \b Notes:
- * * The lifetime of the associated executor must outlive the serial executor.
- * * The current implementation doesn't support submission from synchronous continuation, that is,
- * - the executor must execute the continuation asynchronously or
- * - the continuation can not submit to this serial executor.
- */
- template <class Executor>
- serial_executor_cont(Executor& ex)
- : ex_(ex), fut_(make_ready_future()), closed_(false)
- {
- }
- /**
- * \b Effects: Destroys the thread pool.
- *
- * \b Synchronization: The completion of all the closures happen before the completion of the \c serial_executor_cont destructor.
- */
- ~serial_executor_cont()
- {
- // signal to the worker thread that there will be no more submissions.
- close();
- }
- /**
- * \b Effects: close the \c serial_executor_cont for submissions.
- * The loop will work until there is no more closures to run.
- */
- void close()
- {
- lock_guard<mutex> lk(mtx_);
- closed_ = true;;
- }
- /**
- * \b Returns: whether the pool is closed for submissions.
- */
- bool closed()
- {
- lock_guard<mutex> lk(mtx_);
- return closed(lk);
- }
- /**
- * Effects: none.
- * Returns: always false.
- * Throws: No.
- * Remark: A serial executor can not execute one of its pending tasks as the tasks depends on the other tasks.
- */
- bool try_executing_one()
- {
- return false;
- }
- /**
- * \b Requires: \c Closure is a model of \c Callable(void()) and a model of \c CopyConstructible/MoveConstructible.
- *
- * \b Effects: The specified \c closure will be scheduled for execution after the last submitted closure finish.
- * If the invoked closure throws an exception the \c serial_executor_cont will call \c std::terminate, as is the case with threads.
- *
- * \b Throws: \c sync_queue_is_closed if the executor is closed.
- * Whatever exception that can be throw while storing the closure.
- *
- */
- #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
- template <typename Closure>
- void submit(Closure & closure)
- {
- lock_guard<mutex> lk(mtx_);
- if (closed(lk)) BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
- fut_ = fut_.then(ex_, continuation(work(closure)));
- }
- #endif
- void submit(void (*closure)())
- {
- lock_guard<mutex> lk(mtx_);
- if (closed(lk)) BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
- fut_ = fut_.then(ex_, continuation(work(closure)));
- }
- template <typename Closure>
- void submit(BOOST_THREAD_FWD_REF(Closure) closure)
- {
- lock_guard<mutex> lk(mtx_);
- if (closed(lk)) BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
- fut_ = fut_.then(ex_, continuation(work(boost::forward<Closure>(closure))));
- }
- };
- }
- using executors::serial_executor_cont;
- }
- #include <boost/config/abi_suffix.hpp>
- #endif
- #endif
|