]> git.sesse.net Git - casparcg/blobdiff - common/concurrency/executor.h
2.1.0: executor: Refactored. Removed thread priorities to simplify API.
[casparcg] / common / concurrency / executor.h
index a2427d3ceb3a951d25b0d3c99fdd70378678a421..14d9c1d1f2982f619de1ee0a25b0b2137e638c62 100644 (file)
 /*\r
-* copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
 *\r
-*  This file is part of CasparCG.\r
+* This file is part of CasparCG (www.casparcg.com).\r
 *\r
-*    CasparCG is free software: you can redistribute it and/or modify\r
-*    it under the terms of the GNU General Public License as published by\r
-*    the Free Software Foundation, either version 3 of the License, or\r
-*    (at your option) any later version.\r
+* CasparCG is free software: you can redistribute it and/or modify\r
+* it under the terms of the GNU General Public License as published by\r
+* the Free Software Foundation, either version 3 of the License, or\r
+* (at your option) any later version.\r
 *\r
-*    CasparCG is distributed in the hope that it will be useful,\r
-*    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-*    GNU General Public License for more details.\r
-\r
-*    You should have received a copy of the GNU General Public License\r
-*    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
+* CasparCG is distributed in the hope that it will be useful,\r
+* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+* GNU General Public License for more details.\r
+*\r
+* You should have received a copy of the GNU General Public License\r
+* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
 *\r
+* Author: Robert Nagy, ronag89@gmail.com\r
 */\r
+\r
 #pragma once\r
 \r
-#include "../exception/win32_exception.h"\r
-#include "../utility/assert.h"\r
-#include "../log/log.h"\r
+#include "../except.h"\r
+#include "../enum_class.h"\r
+#include "../log.h"\r
 \r
 #include <tbb/atomic.h>\r
 #include <tbb/concurrent_queue.h>\r
 \r
 #include <boost/thread.hpp>\r
-#include <boost/noncopyable.hpp>\r
 \r
 #include <functional>\r
 \r
 namespace caspar {\r
 \r
 namespace detail {\r
-\r
-typedef struct tagTHREADNAME_INFO\r
+       \r
+template<typename T>\r
+struct move_on_copy\r
 {\r
-       DWORD dwType; // must be 0x1000\r
-       LPCSTR szName; // pointer to name (in user addr space)\r
-       DWORD dwThreadID; // thread ID (-1=caller thread)\r
-       DWORD dwFlags; // reserved for future use, must be zero\r
-} THREADNAME_INFO;\r
+       move_on_copy(const move_on_copy<T>& other) : value(std::move(other.value)){}\r
+       move_on_copy(T&& value) : value(std::move(value)){}\r
+       mutable T value;\r
+};\r
 \r
-inline void SetThreadName(DWORD dwThreadID, LPCSTR szThreadName)\r
+template<typename T>\r
+move_on_copy<T> make_move_on_copy(T&& value)\r
 {\r
-       THREADNAME_INFO info;\r
-       {\r
-               info.dwType = 0x1000;\r
-               info.szName = szThreadName;\r
-               info.dwThreadID = dwThreadID;\r
-               info.dwFlags = 0;\r
-       }\r
-       __try\r
-       {\r
-               RaiseException( 0x406D1388, 0, sizeof(info)/sizeof(DWORD), (DWORD*)&info );\r
-       }\r
-       __except (EXCEPTION_CONTINUE_EXECUTION){}       \r
+       return move_on_copy<T>(std::move(value));\r
 }\r
 \r
 }\r
-\r
-enum priority\r
+       \r
+struct task_priority_def\r
 {\r
-       high_priority,\r
-       normal_priority,\r
-       priority_count\r
+       enum type\r
+       {\r
+               high_priority,\r
+               normal_priority,\r
+               priority_count\r
+       };\r
 };\r
+typedef enum_class<task_priority_def> task_priority;\r
 \r
-class executor : boost::noncopyable\r
+class executor\r
 {\r
-       const std::string name_;\r
-       boost::thread thread_;\r
-       tbb::atomic<bool> is_running_;\r
+       executor(const executor&);\r
+       executor& operator=(const executor&);\r
        \r
-       typedef tbb::concurrent_bounded_queue<std::function<void()>> function_queue;\r
-       function_queue execution_queue_[priority_count];\r
+       tbb::atomic<bool>       is_running_;\r
+       boost::thread           thread_;\r
        \r
-public:\r
+       typedef tbb::concurrent_bounded_queue<std::function<void()>> function_queue;\r
+       function_queue execution_queue_[task_priority::priority_count];\r
                \r
-       explicit executor(const std::wstring& name) : name_(narrow(name)) // noexcept\r
+       template<typename Func>\r
+       auto create_task(Func&& func) -> boost::packaged_task<decltype(func())> // noexcept\r
+       {       \r
+               typedef boost::packaged_task<decltype(func())> task_type;\r
+                               \r
+               auto task = task_type(std::forward<Func>(func));\r
+               \r
+               task.set_wait_callback(std::function<void(task_type&)>([=](task_type& my_task) // The std::function wrapper is required in order to add ::result_type to functor class.\r
+               {\r
+                       try\r
+                       {\r
+                               if(boost::this_thread::get_id() == thread_.get_id())  // Avoids potential deadlock.\r
+                                       my_task();\r
+                       }\r
+                       catch(boost::task_already_started&){}\r
+               }));\r
+                               \r
+               return std::move(task);\r
+       }\r
+\r
+public:                \r
+       executor(const std::wstring& name) // noexcept\r
        {\r
-               thread_ = boost::thread([this]{run();});\r
+               name; // TODO: Use to set thread name.\r
                is_running_ = true;\r
+               thread_ = boost::thread([this]{run();});\r
        }\r
        \r
        virtual ~executor() // noexcept\r
        {\r
                stop();\r
-               \r
-               std::function<void()> func;\r
-               while(execution_queue_[normal_priority].try_pop(func)){} // Wake all waiting push threads.\r
-\r
-               if(boost::this_thread::get_id() != thread_.get_id())\r
-                       thread_.join();\r
+               join();\r
        }\r
 \r
        void set_capacity(size_t capacity) // noexcept\r
        {\r
-               execution_queue_[normal_priority].set_capacity(capacity);\r
+               execution_queue_[task_priority::normal_priority].set_capacity(capacity);\r
+       }\r
+       \r
+       void clear()\r
+       {               \r
+               std::function<void()> func;\r
+               while(execution_queue_[task_priority::normal_priority].try_pop(func));\r
+               while(execution_queue_[task_priority::high_priority].try_pop(func));\r
        }\r
                                \r
        void stop() // noexcept\r
        {\r
                is_running_ = false;    \r
-               execution_queue_[normal_priority].try_push([]{}); // Wake the execution thread.\r
+               execution_queue_[task_priority::normal_priority].try_push([]{}); // Wake the execution thread.\r
        }\r
 \r
        void wait() // noexcept\r
        {\r
                invoke([]{});\r
        }\r
+\r
+       void join()\r
+       {\r
+               if(boost::this_thread::get_id() == thread_.get_id())\r
+                       BOOST_THROW_EXCEPTION(invalid_operation());\r
+\r
+               thread_.join();\r
+       }\r
                                \r
        template<typename Func>\r
-       auto begin_invoke(Func&& func, priority priority = normal_priority) -> boost::unique_future<decltype(func())> // noexcept\r
+       auto begin_invoke(Func&& func, task_priority priority = task_priority::normal_priority) -> boost::unique_future<decltype(func())> // noexcept\r
        {       \r
-               typedef boost::packaged_task<decltype(func())> task_type;\r
-                               \r
-               auto task = task_type(std::forward<Func>(func));\r
-               auto future = task.get_future();\r
-               \r
                if(!is_running_)\r
-                       return std::move(future);       \r
+                       BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("executor not running."));\r
 \r
-               task.set_wait_callback(std::function<void(task_type&)>([=](task_type& my_task) // The std::function wrapper is required in order to add ::result_type to functor class.\r
+               // Create a move on copy adaptor to avoid copying the functor into the queue, tbb::concurrent_queue does not support move semantics.\r
+               auto task_adaptor = detail::make_move_on_copy(create_task(func));\r
+\r
+               auto future = task_adaptor.value.get_future();\r
+\r
+               execution_queue_[priority.value()].push([=]\r
                {\r
                        try\r
                        {\r
-                               if(boost::this_thread::get_id() == thread_.get_id())  // Avoids potential deadlock.\r
-                                       my_task();\r
+                               task_adaptor.value();\r
+                       }\r
+                       catch(boost::task_already_started&)\r
+                       {\r
+                       }\r
+                       catch(...)\r
+                       {\r
+                               CASPAR_LOG_CURRENT_EXCEPTION();\r
                        }\r
-                       catch(boost::task_already_started&){}\r
-               }));\r
-                               \r
-               // Create a move on copy adaptor to avoid copying the functor into the queue, tbb::concurrent_queue does not support move semantics.\r
-               struct task_adaptor_t\r
-               {\r
-                       task_adaptor_t(const task_adaptor_t& other) : task(std::move(other.task)){}\r
-                       task_adaptor_t(task_type&& task) : task(std::move(task)){}\r
-                       void operator()() const { task(); }\r
-                       mutable task_type task;\r
-               } task_adaptor(std::move(task));\r
-\r
-               execution_queue_[priority].push([=]\r
-               {\r
-                       try{task_adaptor();}\r
-                       catch(boost::task_already_started&){}\r
-                       catch(...){CASPAR_LOG_CURRENT_EXCEPTION();}\r
                });\r
 \r
-               if(priority != normal_priority)\r
-                       execution_queue_[normal_priority].push(nullptr);\r
+               if(priority != task_priority::normal_priority)\r
+                       execution_queue_[task_priority::normal_priority].push(nullptr);\r
                                        \r
                return std::move(future);               \r
        }\r
        \r
        template<typename Func>\r
-       auto invoke(Func&& func, priority prioriy = normal_priority) -> decltype(func()) // noexcept\r
+       auto invoke(Func&& func, task_priority prioriy = task_priority::normal_priority) -> decltype(func()) // noexcept\r
        {\r
                if(boost::this_thread::get_id() == thread_.get_id())  // Avoids potential deadlock.\r
                        return func();\r
@@ -166,42 +182,46 @@ public:
 \r
        void yield() // noexcept\r
        {\r
-               if(boost::this_thread::get_id() != thread_.get_id())  // Only yield when calling from execution thread.\r
-                       return;\r
+               if(boost::this_thread::get_id() != thread_.get_id())\r
+                       BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("Executor can only yield inside of thread context."));\r
 \r
                std::function<void()> func;\r
-               while(execution_queue_[high_priority].try_pop(func))\r
+               execution_queue_[task_priority::normal_priority].pop(func);     \r
+               \r
+               std::function<void()> func2;\r
+               while(execution_queue_[task_priority::high_priority].try_pop(func2))\r
                {\r
-                       if(func)\r
-                               func();\r
+                       if(func2)\r
+                               func2();\r
                }       \r
-       }\r
-       \r
-       function_queue::size_type capacity() const /*noexcept*/ { return execution_queue_[normal_priority].capacity();  }\r
-       function_queue::size_type size() const /*noexcept*/ { return execution_queue_[normal_priority].size();  }\r
-       bool empty() const /*noexcept*/ { return execution_queue_[normal_priority].empty();     }\r
-       bool is_running() const /*noexcept*/ { return is_running_; }    \r
-               \r
-private:\r
-       \r
-       void execute() // noexcept\r
-       {\r
-               std::function<void()> func;\r
-               execution_queue_[normal_priority].pop(func);    \r
-\r
-               yield();\r
 \r
                if(func)\r
                        func();\r
        }\r
+               \r
+       function_queue::size_type size() const /*noexcept*/\r
+       {\r
+               return execution_queue_[task_priority::normal_priority].size() + execution_queue_[task_priority::high_priority].size(); \r
+       }\r
+               \r
+       bool is_running() const /*noexcept*/ { return is_running_; }    \r
+               \r
+private:       \r
 \r
        void run() // noexcept\r
        {\r
                win32_exception::install_handler();             \r
-               detail::SetThreadName(GetCurrentThreadId(), name_.c_str());\r
                while(is_running_)\r
-                       execute();\r
-               is_running_ = false;\r
+               {\r
+                       try\r
+                       {\r
+                               yield();\r
+                       }\r
+                       catch(...)\r
+                       {\r
+                               CASPAR_LOG_CURRENT_EXCEPTION();\r
+                       }\r
+               }\r
        }       \r
 };\r
 \r