]> git.sesse.net Git - casparcg/blobdiff - common/concurrency/executor.h
2.1.0: Refactoring.
[casparcg] / common / concurrency / executor.h
index 5fb6ef521d39c2dc4d678351a0b31dbecc7bbe89..8d1ed1a1b846360fc80889346173cf71b9fa2efa 100644 (file)
+/*\r
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
+*\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
+*\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 <boost/thread.hpp>\r
+#include "../except.h"\r
+#include "../log.h"\r
+#include "../enum_class.h"\r
+#include "../os/windows/windows.h"\r
 \r
 #include <tbb/atomic.h>\r
 #include <tbb/concurrent_queue.h>\r
 \r
+#include <boost/thread.hpp>\r
+\r
 #include <functional>\r
 \r
-namespace caspar { namespace common {\r
+namespace caspar {\r
+\r
+namespace detail {\r
+       \r
+template<typename T>\r
+struct move_on_copy\r
+{\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
+template<typename T>\r
+move_on_copy<T> make_move_on_copy(T&& value)\r
+{\r
+       return move_on_copy<T>(std::move(value));\r
+}\r
+\r
+}\r
+       \r
+struct task_priority_def\r
+{\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
+struct thread_priority_def\r
+{\r
+       enum type\r
+       {\r
+               high_priority_class,\r
+               above_normal_priority_class,\r
+               normal_priority_class,\r
+               below_normal_priority_class\r
+       };\r
+};\r
+typedef enum_class<thread_priority_def> thread_priority;\r
 \r
 class executor\r
 {\r
+       executor(const executor&);\r
+       executor& operator=(const executor&);\r
+\r
+       const std::string name_;\r
+       boost::thread thread_;\r
+       tbb::atomic<bool> is_running_;\r
+       \r
+       typedef tbb::concurrent_bounded_queue<std::function<void()>> function_queue;\r
+       function_queue execution_queue_[task_priority::priority_count];\r
+               \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::function<void()>& run_func = nullptr) : run_func_(run_func)\r
+               \r
+       explicit executor(const std::wstring& name) : name_(u8(name)) // noexcept\r
        {\r
-               is_running_ = false;\r
-               if(run_func_ == nullptr) \r
-                       run_func_ = [=]{default_run();};\r
+               is_running_ = true;\r
+               thread_ = boost::thread([this]{run();});\r
        }\r
-\r
-       virtual ~executor()\r
+       \r
+       virtual ~executor() // noexcept\r
        {\r
                stop();\r
+               join();\r
        }\r
 \r
-       void start()\r
+       void set_capacity(size_t capacity) // noexcept\r
        {\r
-               if(is_running_.fetch_and_store(true))\r
-                       return;\r
-               thread_ = boost::thread(run_func_);\r
+               execution_queue_[task_priority::normal_priority].set_capacity(capacity);\r
        }\r
 \r
-       bool is_running() const\r
+       void set_priority_class(thread_priority p)\r
+       {\r
+               begin_invoke([=]\r
+               {\r
+                       if(p == thread_priority::high_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), HIGH_PRIORITY_CLASS);\r
+                       else if(p == thread_priority::above_normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), ABOVE_NORMAL_PRIORITY_CLASS);\r
+                       else if(p == thread_priority::normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), NORMAL_PRIORITY_CLASS);\r
+                       else if(p == thread_priority::below_normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), BELOW_NORMAL_PRIORITY_CLASS);\r
+               });\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
-               return is_running_;\r
+               is_running_ = false;    \r
+               execution_queue_[task_priority::normal_priority].try_push([]{}); // Wake the execution thread.\r
        }\r
 \r
-       bool stop(unsigned int timeout = 5000)\r
+       void wait() // noexcept\r
        {\r
-               if(is_running_.fetch_and_store(false))\r
-               {\r
-                       execution_queue_.push([](){});\r
-                       execute(false);\r
-               }\r
-               return thread_.timed_join(boost::posix_time::milliseconds(timeout));\r
+               invoke([]{});\r
        }\r
 \r
-       void execute(bool block = false)\r
+       void join()\r
        {\r
-               std::function<void()> func;\r
-               if(block)               \r
-               {\r
-                       execution_queue_.pop(func);     \r
-                       func();\r
-               }\r
+               if(boost::this_thread::get_id() == thread_.get_id())\r
+                       BOOST_THROW_EXCEPTION(invalid_operation());\r
 \r
-               while(execution_queue_.try_pop(func))\r
-                       func();         \r
+               thread_.join();\r
        }\r
-\r
+                               \r
        template<typename Func>\r
-       auto begin_invoke(Func&& func) -> boost::unique_future<decltype(func())>\r
+       auto begin_invoke(Func&& func, task_priority priority = task_priority::normal_priority) -> boost::unique_future<decltype(func())> // noexcept\r
        {       \r
-               typedef decltype(func()) result_type; \r
-\r
                if(!is_running_)\r
-                       return boost::packaged_task<result_type>([]{ return result_type(); }).get_future();\r
+                       BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("executor not running."));\r
 \r
-               if(boost::this_thread::get_id() == thread_.get_id())\r
-                       return boost::packaged_task<result_type>([=]{ return func(); }).get_future();\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 task = std::make_shared<boost::packaged_task<result_type>>([=]{ return is_running_ ? func() : result_type(); });   \r
-               auto future = task->get_future();\r
+               auto future = task_adaptor.value.get_future();\r
 \r
-               execution_queue_.push([=]{(*task)();});\r
+               execution_queue_[priority.value()].push([=]\r
+               {\r
+                       try\r
+                       {\r
+                               task_adaptor.value();\r
+                       }\r
+                       catch(boost::task_already_started&)\r
+                       {\r
+                       }\r
+                       catch(...)\r
+                       {\r
+                               CASPAR_LOG_CURRENT_EXCEPTION();\r
+                       }\r
+               });\r
 \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) -> decltype(func())\r
+       auto invoke(Func&& func, task_priority prioriy = task_priority::normal_priority) -> decltype(func()) // noexcept\r
        {\r
-               return begin_invoke(std::forward<Func>(func)).get();\r
+               if(boost::this_thread::get_id() == thread_.get_id())  // Avoids potential deadlock.\r
+                       return func();\r
+               \r
+               return begin_invoke(std::forward<Func>(func), prioriy).get();\r
        }\r
-       \r
-private:\r
 \r
-       void default_run() throw()\r
+       void yield() // noexcept\r
        {\r
-               while(is_running_)\r
-                       execute(true);\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
+               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(func2)\r
+                               func2();\r
+               }       \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
-       std::function<void()> run_func_;\r
-       boost::thread thread_;\r
-       tbb::atomic<bool> is_running_;\r
-       tbb::concurrent_bounded_queue<std::function<void()>> execution_queue_;\r
+       void run() // noexcept\r
+       {\r
+               win32_exception::install_handler();             \r
+               //detail::SetThreadName(GetCurrentThreadId(), name_.c_str());\r
+               while(is_running_)\r
+               {\r
+                       try\r
+                       {\r
+                               yield();\r
+                       }\r
+                       catch(...)\r
+                       {\r
+                               CASPAR_LOG_CURRENT_EXCEPTION();\r
+                       }\r
+               }\r
+       }       \r
 };\r
 \r
-}}
\ No newline at end of file
+}
\ No newline at end of file