Merging r45928 through r45935 from trunk into soc-2011-tomato
[blender-staging.git] / intern / cycles / util / util_task.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __UTIL_TASK_H__
20 #define __UTIL_TASK_H__
21
22 #include "util_list.h"
23 #include "util_thread.h"
24 #include "util_vector.h"
25
26 CCL_NAMESPACE_BEGIN
27
28 class Task;
29 class TaskPool;
30 class TaskScheduler;
31
32 typedef boost::function<void(Task*,int)> TaskRunFunction;
33
34 /* Task
35  *
36  * Base class for tasks to be executed in threads. */
37
38 class Task
39 {
40 public:
41         Task() {};
42         virtual ~Task() {}
43 };
44
45 /* Task Pool
46  *
47  * Pool of tasks that will be executed by the central TaskScheduler.For each
48  * pool, we can wait for all tasks to be done, or cancel them before they are
49  * done.
50  *
51  * The run callback that actually executes the task may be create like this:
52  * function_bind(&MyClass::task_execute, this, _1, _2) */
53
54 class TaskPool
55 {
56 public:
57         TaskPool(const TaskRunFunction& run);
58         ~TaskPool();
59
60         void push(Task *task, bool front = false);
61
62         void wait();            /* wait until all tasks are done */
63         void cancel();          /* cancel all tasks, keep worker threads running */
64         void stop();            /* stop all worker threads */
65
66         bool cancelled();       /* for worker threads, test if cancelled */
67
68 protected:
69         friend class TaskScheduler;
70
71         void done_increase(int done);
72
73         TaskRunFunction run;
74
75         thread_mutex done_mutex;
76         thread_condition_variable done_cond;
77
78         volatile int num, num_done;
79         volatile bool do_cancel;
80 };
81
82 /* Task Scheduler
83  * 
84  * Central scheduler that holds running threads ready to execute tasks. A singe
85  * queue holds the task from all pools. */
86
87 class TaskScheduler
88 {
89 public:
90         static void init(int num_threads = 0);
91         static void exit();
92
93         static int num_threads() { return threads.size(); }
94
95 protected:
96         friend class TaskPool;
97
98         struct Entry {
99                 Task *task;
100                 TaskPool *pool;
101         };
102
103         static thread_mutex mutex;
104         static int users;
105         static vector<thread*> threads;
106         static volatile bool do_exit;
107
108         static list<Entry> queue;
109         static thread_mutex queue_mutex;
110         static thread_condition_variable queue_cond;
111
112         static void thread_run(int thread_id);
113         static bool thread_wait_pop(Entry& entry);
114
115         static void push(Entry& entry, bool front);
116         static void clear(TaskPool *pool);
117 };
118
119 CCL_NAMESPACE_END
120
121 #endif
122