]> git.sesse.net Git - casparcg/blobdiff - common/concurrency/executor.h
2.0 image_mixer: Refactored, core: Fixed destruction proxy usage.
[casparcg] / common / concurrency / executor.h
index 9be56842112dabcf63e77350ae1cf4ac7085bbd0..0687889a179a951b0d2e14d82a9162941a4d03dd 100644 (file)
@@ -1,7 +1,27 @@
+/*\r
+* copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
+*\r
+*  This file is part of CasparCG.\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
+*/\r
 #pragma once\r
 \r
 #include "../exception/win32_exception.h"\r
-#include "../utility/assert.h"\r
+#include "../utility/string.h"\r
+#include "../utility/move_on_copy.h"\r
 #include "../log/log.h"\r
 \r
 #include <tbb/atomic.h>\r
@@ -42,118 +62,190 @@ inline void SetThreadName(DWORD dwThreadID, LPCSTR szThreadName)
 \r
 }\r
 \r
+enum task_priority\r
+{\r
+       high_priority,\r
+       normal_priority,\r
+       priority_count\r
+};\r
+\r
+enum thread_priority\r
+{\r
+       high_priority_class,\r
+       above_normal_priority_class,\r
+       normal_priority_class,\r
+       below_normal_priority_class\r
+};\r
+\r
 class executor : boost::noncopyable\r
 {\r
        const std::string name_;\r
        boost::thread thread_;\r
        tbb::atomic<bool> is_running_;\r
-       tbb::concurrent_bounded_queue<std::function<void()>> execution_queue_;\r
+       \r
+       typedef tbb::concurrent_bounded_queue<std::function<void()>> function_queue;\r
+       function_queue execution_queue_[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
                \r
-       explicit executor(const std::wstring& name) : name_(narrow(name))\r
+       explicit executor(const std::wstring& name) : name_(narrow(name)) // noexcept\r
        {\r
-               is_running_ = false;\r
+               thread_ = boost::thread([this]{run();});\r
+               is_running_ = true;\r
        }\r
        \r
-       virtual ~executor()\r
+       virtual ~executor() // noexcept\r
        {\r
                stop();\r
-               clear();\r
-               if(boost::this_thread::get_id() != thread_.get_id())\r
-                       thread_.join();\r
+               execution_queue_[normal_priority].try_push([]{}); // Wake the execution thread.\r
+               join();\r
        }\r
 \r
-       void set_capacity(size_t capacity)\r
+       void set_capacity(size_t capacity) // noexcept\r
        {\r
-               execution_queue_.set_capacity(capacity);\r
+               execution_queue_[normal_priority].set_capacity(capacity);\r
        }\r
 \r
-       void start() // noexcept\r
+       void set_priority_class(thread_priority p)\r
        {\r
-               if(is_running_.fetch_and_store(true))\r
-                       return;\r
-               clear();\r
-               thread_ = boost::thread([this]{run();});\r
+               begin_invoke([=]\r
+               {\r
+                       if(p == high_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), HIGH_PRIORITY_CLASS);\r
+                       if(p == above_normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), ABOVE_NORMAL_PRIORITY_CLASS);\r
+                       else if(p == normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), NORMAL_PRIORITY_CLASS);\r
+                       else if(p == below_normal_priority_class)\r
+                               SetThreadPriority(GetCurrentThread(), BELOW_NORMAL_PRIORITY_CLASS);\r
+               });\r
        }\r
-                       \r
+                               \r
        void stop() // noexcept\r
        {\r
                is_running_ = false;    \r
-               execution_queue_.try_push([]{});\r
        }\r
-       \r
-       void clear()\r
+\r
+       void wait() // noexcept\r
        {\r
-               std::function<void()> func;\r
-               auto size = execution_queue_.size();\r
-               for(int n = 0; n < size; ++n)\r
-               {\r
-                       try\r
-                       {\r
-                               if(!execution_queue_.try_pop(func))\r
-                                       return;\r
-                       }\r
-                       catch(boost::broken_promise&){}\r
-               }\r
+               invoke([]{});\r
+       }\r
+\r
+       void join()\r
+       {\r
+               if(boost::this_thread::get_id() != thread_.get_id())\r
+                       thread_.join();\r
        }\r
-                       \r
+                               \r
        template<typename Func>\r
-       auto begin_invoke(Func&& func) -> boost::unique_future<decltype(func())> // noexcept\r
+       auto begin_invoke(Func&& func, task_priority 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
-               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
-               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
+               // 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 = make_move_on_copy(create_task(func));\r
+\r
+               auto future = task_adaptor.value.get_future();\r
 \r
-               execution_queue_.push([=]\r
+               execution_queue_[priority].push([=]\r
                {\r
-                       try{task_adaptor();}\r
+                       try{task_adaptor.value();}\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
                                        \r
                return std::move(future);               \r
        }\r
-       \r
+\r
+       template<typename Func>\r
+       auto try_begin_invoke(Func&& func, task_priority priority = normal_priority) -> boost::unique_future<decltype(func())> // noexcept\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
+               auto task_adaptor = make_move_on_copy(create_task(func));\r
+               \r
+               auto future = task_adaptor.value.get_future();\r
+\r
+               if(priority == normal_priority || execution_queue_[normal_priority].try_push(nullptr))\r
+               {                       \r
+                       execution_queue_[priority].try_push([=]\r
+                       {\r
+                               try{task_adaptor.value();}\r
+                               catch(boost::task_already_started&){}\r
+                               catch(...){CASPAR_LOG_CURRENT_EXCEPTION();}\r
+                       });\r
+               }\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 = normal_priority) -> decltype(func()) // noexcept\r
        {\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)).get();\r
+               return begin_invoke(std::forward<Func>(func), prioriy).get();\r
+       }\r
+\r
+       template<typename Func>\r
+       auto try_invoke(Func&& func, task_priority prioriy = normal_priority) -> decltype(func()) // noexcept\r
+       {\r
+               if(boost::this_thread::get_id() == thread_.get_id())  // Avoids potential deadlock.\r
+                       return func();\r
+               \r
+               return try_begin_invoke(std::forward<Func>(func), prioriy).get();\r
+       }\r
+\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
+\r
+               std::function<void()> func;\r
+               while(execution_queue_[high_priority].try_pop(func))\r
+               {\r
+                       if(func)\r
+                               func();\r
+               }       \r
        }\r
        \r
-       tbb::concurrent_bounded_queue<std::function<void()>>::size_type capacity() const { return execution_queue_.capacity();  }\r
-       tbb::concurrent_bounded_queue<std::function<void()>>::size_type size() const { return execution_queue_.size();  }\r
-       bool empty() const              { return execution_queue_.empty();      }\r
-       bool is_running() const { return is_running_;                           }       \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_.pop(func);     \r
-               func();\r
+               execution_queue_[normal_priority].pop(func);    \r
+\r
+               yield();\r
+\r
+               if(func)\r
+                       func();\r
        }\r
 \r
        void run() // noexcept\r
@@ -161,7 +253,16 @@ private:
                win32_exception::install_handler();             \r
                detail::SetThreadName(GetCurrentThreadId(), name_.c_str());\r
                while(is_running_)\r
-                       execute();\r
+               {\r
+                       try\r
+                       {\r
+                               execute();\r
+                       }\r
+                       catch(...)\r
+                       {\r
+                               CASPAR_LOG_CURRENT_EXCEPTION();\r
+                       }\r
+               }\r
        }       \r
 };\r
 \r