Add a new parallel looper for MemPool items to BLI_task.
[blender-staging.git] / source / blender / blenlib / BLI_task.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BLI_TASK_H__
22 #define __BLI_TASK_H__ 
23
24 struct Link;
25 struct ListBase;
26
27 /** \file BLI_task.h
28  *  \ingroup bli
29  */
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include "BLI_threads.h"
36 #include "BLI_utildefines.h"
37
38 struct BLI_mempool;
39
40 /* Task Scheduler
41  * 
42  * Central scheduler that holds running threads ready to execute tasks. A single
43  * queue holds the task from all pools.
44  *
45  * Init/exit must be called before/after any task pools are created/freed, and
46  * must be called from the main threads. All other scheduler and pool functions
47  * are thread-safe. */
48
49 typedef struct TaskScheduler TaskScheduler;
50
51 enum {
52         TASK_SCHEDULER_AUTO_THREADS = 0,
53         TASK_SCHEDULER_SINGLE_THREAD = 1
54 };
55
56 TaskScheduler *BLI_task_scheduler_create(int num_threads);
57 void BLI_task_scheduler_free(TaskScheduler *scheduler);
58
59 int BLI_task_scheduler_num_threads(TaskScheduler *scheduler);
60
61 /* Task Pool
62  *
63  * Pool of tasks that will be executed by the central TaskScheduler. For each
64  * pool, we can wait for all tasks to be done, or cancel them before they are
65  * done.
66  *
67  * Running tasks may spawn new tasks.
68  *
69  * Pools may be nested, i.e. a thread running a task can create another task
70  * pool with smaller tasks. When other threads are busy they will continue
71  * working on their own tasks, if not they will join in, no new threads will
72  * be launched.
73  */
74
75 typedef enum TaskPriority {
76         TASK_PRIORITY_LOW,
77         TASK_PRIORITY_HIGH
78 } TaskPriority;
79
80 typedef struct TaskPool TaskPool;
81 typedef void (*TaskRunFunction)(TaskPool *__restrict pool, void *taskdata, int threadid);
82 typedef void (*TaskFreeFunction)(TaskPool *__restrict pool, void *taskdata, int threadid);
83
84 TaskPool *BLI_task_pool_create(TaskScheduler *scheduler, void *userdata);
85 TaskPool *BLI_task_pool_create_background(TaskScheduler *scheduler, void *userdata);
86 TaskPool *BLI_task_pool_create_suspended(TaskScheduler *scheduler, void *userdata);
87 void BLI_task_pool_free(TaskPool *pool);
88
89 void BLI_task_pool_push_ex(
90         TaskPool *pool, TaskRunFunction run, void *taskdata,
91         bool free_taskdata, TaskFreeFunction freedata, TaskPriority priority);
92 void BLI_task_pool_push(TaskPool *pool, TaskRunFunction run,
93         void *taskdata, bool free_taskdata, TaskPriority priority);
94 void BLI_task_pool_push_from_thread(TaskPool *pool, TaskRunFunction run,
95         void *taskdata, bool free_taskdata, TaskPriority priority, int thread_id);
96
97 /* work and wait until all tasks are done */
98 void BLI_task_pool_work_and_wait(TaskPool *pool);
99 /* cancel all tasks, keep worker threads running */
100 void BLI_task_pool_cancel(TaskPool *pool);
101
102 /* for worker threads, test if canceled */
103 bool BLI_task_pool_canceled(TaskPool *pool);
104
105 /* optional userdata pointer to pass along to run function */
106 void *BLI_task_pool_userdata(TaskPool *pool);
107
108 /* optional mutex to use from run function */
109 ThreadMutex *BLI_task_pool_user_mutex(TaskPool *pool);
110
111 /* Delayed push, use that to reduce thread overhead by accumulating
112  * all new tasks into local queue first and pushing it to scheduler
113  * from within a single mutex lock.
114  */
115 void BLI_task_pool_delayed_push_begin(TaskPool *pool, int thread_id);
116 void BLI_task_pool_delayed_push_end(TaskPool *pool, int thread_id);
117
118 /* Parallel for routines */
119 typedef void (*TaskParallelRangeFunc)(void *userdata, const int iter);
120 typedef void (*TaskParallelRangeFuncEx)(void *userdata, void *userdata_chunk, const int iter, const int thread_id);
121 typedef void (*TaskParallelRangeFuncFinalize)(void *userdata, void *userdata_chunk);
122 void BLI_task_parallel_range_ex(
123         int start, int stop,
124         void *userdata,
125         void *userdata_chunk,
126         const size_t userdata_chunk_size,
127         TaskParallelRangeFuncEx func_ex,
128         const bool use_threading,
129         const bool use_dynamic_scheduling);
130 void BLI_task_parallel_range(
131         int start, int stop,
132         void *userdata,
133         TaskParallelRangeFunc func,
134         const bool use_threading);
135
136 void BLI_task_parallel_range_finalize(
137         int start, int stop,
138         void *userdata,
139         void *userdata_chunk,
140         const size_t userdata_chunk_size,
141         TaskParallelRangeFuncEx func_ex,
142         TaskParallelRangeFuncFinalize func_finalize,
143         const bool use_threading,
144         const bool use_dynamic_scheduling);
145
146 typedef void (*TaskParallelListbaseFunc)(void *userdata,
147                                          struct Link *iter,
148                                          int index);
149 void BLI_task_parallel_listbase(
150         struct ListBase *listbase,
151         void *userdata,
152         TaskParallelListbaseFunc func,
153         const bool use_threading);
154
155 typedef struct MempoolIterData MempoolIterData;
156 typedef void (*TaskParallelMempoolFunc)(void *userdata,
157                                         MempoolIterData *iter);
158 void BLI_task_parallel_mempool(
159         struct BLI_mempool *mempool,
160         void *userdata,
161         TaskParallelMempoolFunc func,
162         const bool use_threading);
163
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif
169