git.sesse.net Git - casparcg/blob - common/executor.h

   1 /*\r
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 * This file is part of CasparCG (www.casparcg.com).\r
   5 *\r
   6 * CasparCG is free software: you can redistribute it and/or modify\r
   7 * it under the terms of the GNU General Public License as published by\r
   8 * the Free Software Foundation, either version 3 of the License, or\r
   9 * (at your option) any later version.\r
  10 *\r
  11 * CasparCG is distributed in the hope that it will be useful,\r
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 * GNU General Public License for more details.\r
  15 *\r
  16 * You should have received a copy of the GNU General Public License\r
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 * Author: Robert Nagy, ronag89@gmail.com\r
  20 */\r
  21 \r
  22 #pragma once\r
  23 \r
  24 #include "except.h"\r
  25 #include "enum_class.h"\r
  26 #include "log.h"\r
  27 \r
  28 #include <tbb/atomic.h>\r
  29 #include <tbb/concurrent_priority_queue.h>\r
  30 #include <tbb/concurrent_queue.h>\r
  31 \r
  32 #include <boost/thread.hpp>\r
  33 \r
  34 #include <functional>\r
  35 \r
  36 namespace caspar {\r
  37                 \r
  38 struct task_priority_def\r
  39 {\r
  40         enum type\r
  41         {\r
  42                 lowest_priority = 0,\r
  43                 lower_priority,\r
  44                 low_priority,\r
  45                 normal_priority,\r
  46                 high_priority,\r
  47                 higher_priority\r
  48         };\r
  49 };\r
  50 typedef enum_class<task_priority_def> task_priority;\r
  51 \r
  52 class executor\r
  53 {       \r
  54         struct priority_function\r
  55         {\r
  56                 int                                             priority;\r
  57                 std::function<void()>   func;\r
  58 \r
  59                 priority_function()\r
  60                 {\r
  61                 }\r
  62 \r
  63                 template<typename F>\r
  64                 priority_function(int priority, F&& func)\r
  65                         : priority(priority)\r
  66                         , func(std::forward<F>(func))\r
  67                 {\r
  68                 }\r
  69 \r
  70                 void operator()()\r
  71                 {\r
  72                         func();\r
  73                 }\r
  74 \r
  75                 bool operator<(const priority_function& other) const\r
  76                 {\r
  77                         return priority < other.priority;\r
  78                 }\r
  79         };\r
  80 \r
  81         executor(const executor&);\r
  82         executor& operator=(const executor&);\r
  83         \r
  84         typedef tbb::concurrent_priority_queue<priority_function>       function_queue_t;\r
  85 \r
  86         tbb::atomic<bool>                                                                                       is_running_;\r
  87         boost::thread                                                                                           thread_;        \r
  88         function_queue_t                                                                                        execution_queue_;\r
  89         tbb::concurrent_bounded_queue<int>                                                      semaphore_;\r
  90                 \r
  91 public:         \r
  92         executor(const std::wstring& name) // noexcept\r
  93         {\r
  94                 name; // TODO: Use to set thread name.\r
  95                 is_running_ = true;\r
  96                 thread_ = boost::thread([this]{run();});\r
  97         }\r
  98         \r
  99         virtual ~executor() // noexcept\r
 100         {\r
 101                 stop();\r
 102                 thread_.join();\r
 103         }\r
 104                                                 \r
 105         template<typename Func>\r
 106         auto begin_invoke(Func&& func, task_priority priority = task_priority::normal_priority) -> boost::unique_future<decltype(func())> // noexcept\r
 107         {       \r
 108                 if(execution_queue_.size() > 128)\r
 109                         BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("executor overflow."));\r
 110 \r
 111                 if(!is_running_)\r
 112                         BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("executor not running."));\r
 113                                 \r
 114                 typedef typename std::remove_reference<Func>::type      function_type;\r
 115                 typedef decltype(func())                                                        result_type;\r
 116                 typedef boost::packaged_task<result_type>                       task_type;\r
 117                                                                 \r
 118                 std::unique_ptr<task_type> task;\r
 119 \r
 120                 // Use pointers since the boost thread library doesn't fully support move semantics.\r
 121 \r
 122                 auto raw_func2 = new function_type(std::forward<Func>(func));\r
 123                 try\r
 124                 {\r
 125                         task.reset(new task_type([raw_func2]() -> result_type\r
 126                         {\r
 127                                 std::unique_ptr<function_type> func2(raw_func2);\r
 128                                 return (*func2)();\r
 129                         }));\r
 130                 }\r
 131                 catch(...)\r
 132                 {\r
 133                         delete raw_func2;\r
 134                         throw;\r
 135                 }\r
 136                 \r
 137                 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
 138                 {\r
 139                         try\r
 140                         {\r
 141                                 if(is_current())  // Avoids potential deadlock.\r
 142                                         my_task();\r
 143                         }\r
 144                         catch(boost::task_already_started&){}\r
 145                 }));\r
 146                                 \r
 147                 auto future = task->get_future();\r
 148 \r
 149                 auto raw_task = task.release();\r
 150                 priority_function prio_func(priority.value(), [raw_task]\r
 151                 {\r
 152                         std::unique_ptr<task_type> task(raw_task);\r
 153                         try\r
 154                         {\r
 155                                 (*task)();\r
 156                         }\r
 157                         catch(boost::task_already_started&){}\r
 158                 });\r
 159 \r
 160                 execution_queue_.push(prio_func);\r
 161                 semaphore_.push(0);\r
 162                                                         \r
 163                 return std::move(future);               \r
 164         }\r
 165         \r
 166         template<typename Func>\r
 167         auto invoke(Func&& func, task_priority prioriy = task_priority::normal_priority) -> decltype(func()) // noexcept\r
 168         {\r
 169                 if(is_current())  // Avoids potential deadlock.\r
 170                         return func();\r
 171                 \r
 172                 return begin_invoke(std::forward<Func>(func), prioriy).get();\r
 173         }\r
 174 \r
 175         void yield() // noexcept\r
 176         {\r
 177                 if(!is_current())\r
 178                         BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("Executor can only yield inside of thread context."));\r
 179 \r
 180                 int dummy;\r
 181                 semaphore_.pop(dummy);\r
 182 \r
 183                 priority_function func;\r
 184                 if(execution_queue_.try_pop(func))\r
 185                         func();\r
 186         }\r
 187 \r
 188         void set_capacity(std::size_t capacity) // noexcept\r
 189         {\r
 190                 semaphore_.set_capacity(capacity);\r
 191         }\r
 192 \r
 193         std::size_t capacity() const\r
 194         {\r
 195                 return semaphore_.capacity();\r
 196         }\r
 197         \r
 198         void clear()\r
 199         {               \r
 200                 priority_function func;\r
 201                 while(execution_queue_.try_pop(func));\r
 202         }\r
 203                                 \r
 204         void stop()\r
 205         {\r
 206                 invoke([this]\r
 207                 {\r
 208                         is_running_ = false;\r
 209                 });\r
 210         }\r
 211 \r
 212         void wait()\r
 213         {\r
 214                 invoke([]{}, task_priority::lowest_priority);\r
 215         }\r
 216                 \r
 217         function_queue_t::size_type size() const \r
 218         {\r
 219                 return execution_queue_.size(); \r
 220         }\r
 221                 \r
 222         bool is_running() const\r
 223         {\r
 224                 return is_running_; \r
 225         }       \r
 226 \r
 227         bool is_current() const\r
 228         {\r
 229                 return boost::this_thread::get_id() == thread_.get_id();\r
 230         }\r
 231                 \r
 232 private:        \r
 233 \r
 234         void run() // noexcept\r
 235         {\r
 236                 win32_exception::install_handler();             \r
 237                 while(is_running_)\r
 238                 {\r
 239                         try\r
 240                         {\r
 241                                 yield();\r
 242                         }\r
 243                         catch(...)\r
 244                         {\r
 245                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 246                         }\r
 247                 }\r
 248         }       \r
 249 };\r
 250 \r
 251 }