123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352 |
- // Copyright (C) 2013-2014 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/09 Vicente J. Botet Escriba
- // Adapt to boost from CCIA C++11 implementation
- // first implementation of a simple pool thread using a vector of threads and a sync_queue.
- #ifndef BOOST_THREAD_EXECUTORS_BASIC_THREAD_POOL_HPP
- #define BOOST_THREAD_EXECUTORS_BASIC_THREAD_POOL_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 <boost/thread/detail/delete.hpp>
- #include <boost/thread/detail/move.hpp>
- #include <boost/thread/thread.hpp>
- #include <boost/thread/concurrent_queues/sync_queue.hpp>
- #include <boost/thread/executors/work.hpp>
- #include <boost/thread/csbl/vector.hpp>
- #include <boost/config/abi_prefix.hpp>
- namespace boost
- {
- namespace executors
- {
- class basic_thread_pool
- {
- public:
- /// type-erasure to store the works to do
- typedef executors::work work;
- private:
- typedef thread thread_t;
- /// A move aware vector type
- typedef csbl::vector<thread_t> thread_vector;
- /// A move aware vector
- thread_vector threads;
- /// the thread safe work queue
- concurrent::sync_queue<work > work_queue;
- public:
- /**
- * Effects: try to execute one task.
- * Returns: whether a task has been executed.
- * Throws: whatever the current task constructor throws or the task() throws.
- */
- bool try_executing_one()
- {
- try
- {
- work task;
- if (work_queue.try_pull(task) == queue_op_status::success)
- {
- task();
- return true;
- }
- return false;
- }
- catch (...)
- {
- std::terminate();
- //return false;
- }
- }
- /**
- * Effects: schedule one task or yields
- * Throws: whatever the current task constructor throws or the task() throws.
- */
- void schedule_one_or_yield()
- {
- if ( ! try_executing_one())
- {
- this_thread::yield();
- }
- }
- private:
- /**
- * The main loop of the worker threads
- */
- void worker_thread()
- {
- try
- {
- for(;;)
- {
- work task;
- try
- {
- queue_op_status st = work_queue.wait_pull(task);
- if (st == queue_op_status::closed) {
- return;
- }
- task();
- }
- catch (boost::thread_interrupted&)
- {
- return;
- }
- }
- }
- catch (...)
- {
- std::terminate();
- return;
- }
- }
- #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
- template <class AtThreadEntry>
- void worker_thread1(AtThreadEntry& at_thread_entry)
- {
- at_thread_entry(*this);
- worker_thread();
- }
- #endif
- void worker_thread2(void(*at_thread_entry)(basic_thread_pool&))
- {
- at_thread_entry(*this);
- worker_thread();
- }
- template <class AtThreadEntry>
- void worker_thread3(BOOST_THREAD_FWD_REF(AtThreadEntry) at_thread_entry)
- {
- at_thread_entry(*this);
- worker_thread();
- }
- static void do_nothing_at_thread_entry(basic_thread_pool&) {}
- public:
- /// basic_thread_pool is not copyable.
- BOOST_THREAD_NO_COPYABLE(basic_thread_pool)
- /**
- * \b Effects: creates a thread pool that runs closures on \c thread_count threads.
- *
- * \b Throws: Whatever exception is thrown while initializing the needed resources.
- */
- basic_thread_pool(unsigned const thread_count = thread::hardware_concurrency()+1)
- {
- try
- {
- threads.reserve(thread_count);
- for (unsigned i = 0; i < thread_count; ++i)
- {
- #if 1
- thread th (&basic_thread_pool::worker_thread, this);
- threads.push_back(thread_t(boost::move(th)));
- #else
- threads.push_back(thread_t(&basic_thread_pool::worker_thread, this)); // do not compile
- #endif
- }
- }
- catch (...)
- {
- close();
- throw;
- }
- }
- /**
- * \b Effects: creates a thread pool that runs closures on \c thread_count threads
- * and executes the at_thread_entry function at the entry of each created thread. .
- *
- * \b Throws: Whatever exception is thrown while initializing the needed resources.
- */
- #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
- template <class AtThreadEntry>
- basic_thread_pool( unsigned const thread_count, AtThreadEntry& at_thread_entry)
- {
- try
- {
- threads.reserve(thread_count);
- for (unsigned i = 0; i < thread_count; ++i)
- {
- thread th (&basic_thread_pool::worker_thread1<AtThreadEntry>, this, at_thread_entry);
- threads.push_back(thread_t(boost::move(th)));
- //threads.push_back(thread_t(&basic_thread_pool::worker_thread, this)); // do not compile
- }
- }
- catch (...)
- {
- close();
- throw;
- }
- }
- #endif
- basic_thread_pool( unsigned const thread_count, void(*at_thread_entry)(basic_thread_pool&))
- {
- try
- {
- threads.reserve(thread_count);
- for (unsigned i = 0; i < thread_count; ++i)
- {
- thread th (&basic_thread_pool::worker_thread2, this, at_thread_entry);
- threads.push_back(thread_t(boost::move(th)));
- //threads.push_back(thread_t(&basic_thread_pool::worker_thread, this)); // do not compile
- }
- }
- catch (...)
- {
- close();
- throw;
- }
- }
- template <class AtThreadEntry>
- basic_thread_pool( unsigned const thread_count, BOOST_THREAD_FWD_REF(AtThreadEntry) at_thread_entry)
- {
- try
- {
- threads.reserve(thread_count);
- for (unsigned i = 0; i < thread_count; ++i)
- {
- thread th (&basic_thread_pool::worker_thread3<AtThreadEntry>, this, boost::forward<AtThreadEntry>(at_thread_entry));
- threads.push_back(thread_t(boost::move(th)));
- //threads.push_back(thread_t(&basic_thread_pool::worker_thread, this)); // do not compile
- }
- }
- catch (...)
- {
- close();
- throw;
- }
- }
- /**
- * \b Effects: Destroys the thread pool.
- *
- * \b Synchronization: The completion of all the closures happen before the completion of the \c basic_thread_pool destructor.
- */
- ~basic_thread_pool()
- {
- // signal to all the worker threads that there will be no more submissions.
- close();
- // joins all the threads before destroying the thread pool resources (e.g. the queue).
- interrupt_and_join();
- }
- /**
- * \b Effects: join all the threads.
- */
- void join()
- {
- for (unsigned i = 0; i < threads.size(); ++i)
- {
- //threads[i].interrupt();
- threads[i].join();
- }
- }
- /**
- * \b Effects: interrupt all the threads.
- */
- void interrupt()
- {
- for (unsigned i = 0; i < threads.size(); ++i)
- {
- threads[i].interrupt();
- }
- }
- /**
- * \b Effects: interrupt and join all the threads.
- */
- void interrupt_and_join()
- {
- for (unsigned i = 0; i < threads.size(); ++i)
- {
- threads[i].interrupt();
- threads[i].join();
- }
- }
- /**
- * \b Effects: close the \c basic_thread_pool for submissions.
- * The worker threads will work until there is no more closures to run.
- */
- void close()
- {
- work_queue.close();
- }
- /**
- * \b Returns: whether the pool is closed for submissions.
- */
- bool closed()
- {
- return work_queue.closed();
- }
- /**
- * \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 at some point in the future.
- * If invoked closure throws an exception the \c basic_thread_pool will call \c std::terminate, as is the case with threads.
- *
- * \b Synchronization: completion of \c closure on a particular thread happens before destruction of thread's thread local variables.
- *
- * \b Throws: \c sync_queue_is_closed if the thread pool is closed.
- * Whatever exception that can be throw while storing the closure.
- */
- void submit(BOOST_THREAD_RV_REF(work) closure) {
- work_queue.push(boost::move(closure));
- }
- #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
- template <typename Closure>
- void submit(Closure & closure)
- {
- submit(work(closure));
- }
- #endif
- void submit(void (*closure)())
- {
- submit(work(closure));
- }
- template <typename Closure>
- void submit(BOOST_THREAD_FWD_REF(Closure) closure)
- {
- //submit(work(boost::forward<Closure>(closure)));
- work w((boost::forward<Closure>(closure)));
- submit(boost::move(w));
- }
- /**
- * \b Requires: This must be called from an scheduled task.
- *
- * \b Effects: reschedule functions until pred()
- */
- template <typename Pred>
- bool reschedule_until(Pred const& pred)
- {
- do {
- if ( ! try_executing_one())
- {
- return false;
- }
- } while (! pred());
- return true;
- }
- };
- }
- using executors::basic_thread_pool;
- }
- #include <boost/config/abi_suffix.hpp>
- #endif
- #endif
|