Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_task.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BLI_TASK_H__
18 #define __BLI_TASK_H__
19
20 #include <string.h>  /* for memset() */
21
22 struct Link;
23 struct ListBase;
24
25 /** \file \ingroup bli
26  */
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include "BLI_threads.h"
33 #include "BLI_utildefines.h"
34
35 struct BLI_mempool;
36
37 /* Task Scheduler
38  *
39  * Central scheduler that holds running threads ready to execute tasks. A single
40  * queue holds the task from all pools.
41  *
42  * Init/exit must be called before/after any task pools are created/freed, and
43  * must be called from the main threads. All other scheduler and pool functions
44  * are thread-safe. */
45
46 typedef struct TaskScheduler TaskScheduler;
47
48 enum {
49         TASK_SCHEDULER_AUTO_THREADS = 0,
50         TASK_SCHEDULER_SINGLE_THREAD = 1,
51 };
52
53 TaskScheduler *BLI_task_scheduler_create(int num_threads);
54 void BLI_task_scheduler_free(TaskScheduler *scheduler);
55
56 int BLI_task_scheduler_num_threads(TaskScheduler *scheduler);
57
58 /* Task Pool
59  *
60  * Pool of tasks that will be executed by the central TaskScheduler. For each
61  * pool, we can wait for all tasks to be done, or cancel them before they are
62  * done.
63  *
64  * Running tasks may spawn new tasks.
65  *
66  * Pools may be nested, i.e. a thread running a task can create another task
67  * pool with smaller tasks. When other threads are busy they will continue
68  * working on their own tasks, if not they will join in, no new threads will
69  * be launched.
70  */
71
72 typedef enum TaskPriority {
73         TASK_PRIORITY_LOW,
74         TASK_PRIORITY_HIGH
75 } TaskPriority;
76
77 typedef struct TaskPool TaskPool;
78 typedef void (*TaskRunFunction)(TaskPool *__restrict pool, void *taskdata, int threadid);
79 typedef void (*TaskFreeFunction)(TaskPool *__restrict pool, void *taskdata, int threadid);
80
81 TaskPool *BLI_task_pool_create(TaskScheduler *scheduler, void *userdata);
82 TaskPool *BLI_task_pool_create_background(TaskScheduler *scheduler, void *userdata);
83 TaskPool *BLI_task_pool_create_suspended(TaskScheduler *scheduler, void *userdata);
84 void BLI_task_pool_free(TaskPool *pool);
85
86 void BLI_task_pool_push_ex(
87         TaskPool *pool, TaskRunFunction run, void *taskdata,
88         bool free_taskdata, TaskFreeFunction freedata, TaskPriority priority);
89 void BLI_task_pool_push(TaskPool *pool, TaskRunFunction run,
90         void *taskdata, bool free_taskdata, TaskPriority priority);
91 void BLI_task_pool_push_from_thread(TaskPool *pool, TaskRunFunction run,
92         void *taskdata, bool free_taskdata, TaskPriority priority, int thread_id);
93
94 /* work and wait until all tasks are done */
95 void BLI_task_pool_work_and_wait(TaskPool *pool);
96 /* work and wait until all tasks are done, then reset to the initial suspended state */
97 void BLI_task_pool_work_wait_and_reset(TaskPool *pool);
98 /* cancel all tasks, keep worker threads running */
99 void BLI_task_pool_cancel(TaskPool *pool);
100
101 /* for worker threads, test if canceled */
102 bool BLI_task_pool_canceled(TaskPool *pool);
103
104 /* optional userdata pointer to pass along to run function */
105 void *BLI_task_pool_userdata(TaskPool *pool);
106
107 /* optional mutex to use from run function */
108 ThreadMutex *BLI_task_pool_user_mutex(TaskPool *pool);
109
110 /* Delayed push, use that to reduce thread overhead by accumulating
111  * all new tasks into local queue first and pushing it to scheduler
112  * from within a single mutex lock.
113  */
114 void BLI_task_pool_delayed_push_begin(TaskPool *pool, int thread_id);
115 void BLI_task_pool_delayed_push_end(TaskPool *pool, int thread_id);
116
117 /* Parallel for routines */
118
119 typedef enum eTaskSchedulingMode {
120         /* Task scheduler will divide overall work into equal chunks, scheduling
121          * even chunks to all worker threads.
122          * Least run time benefit, ideal for cases when each task requires equal
123          * amount of compute power.
124          */
125         TASK_SCHEDULING_STATIC,
126         /* Task scheduler will schedule small amount of work to each worker thread.
127          * Has more run time overhead, but deals much better with cases when each
128          * part of the work requires totally different amount of compute power.
129          */
130         TASK_SCHEDULING_DYNAMIC,
131 } eTaskSchedulingMode;
132
133 /* Per-thread specific data passed to the callback. */
134 typedef struct ParallelRangeTLS {
135         /* Identifier of the thread who this data belongs to. */
136         int thread_id;
137         /* Copy of user-specifier chunk, which is copied from original chunk to all
138          * worker threads. This is similar to OpenMP's firstprivate.
139          */
140         void *userdata_chunk;
141 } ParallelRangeTLS;
142
143 typedef void (*TaskParallelRangeFunc)(void *__restrict userdata,
144                                       const int iter,
145                                       const ParallelRangeTLS *__restrict tls);
146 typedef void (*TaskParallelRangeFuncFinalize)(void *__restrict userdata,
147                                               void *__restrict userdata_chunk);
148
149 typedef struct ParallelRangeSettings {
150         /* Whether caller allows to do threading of the particular range.
151          * Usually set by some equation, which forces threading off when threading
152          * overhead becomes higher than speed benefit.
153          * BLI_task_parallel_range() by itself will always use threading when range
154          * is higher than a chunk size. As in, threading will always be performed.
155          */
156         bool use_threading;
157         /* Scheduling mode to use for this parallel range invocation. */
158         eTaskSchedulingMode scheduling_mode;
159         /* Each instance of looping chunks will get a copy of this data
160          * (similar to OpenMP's firstprivate).
161          */
162         void *userdata_chunk;        /* Pointer to actual data. */
163         size_t userdata_chunk_size;  /* Size of that data.  */
164         /* Function called from calling thread once whole range have been
165          * processed.
166          */
167         TaskParallelRangeFuncFinalize func_finalize;
168         /* Minimum allowed number of range iterators to be handled by a single
169          * thread. This allows to achieve following:
170          * - Reduce amount of threading overhead.
171          * - Partially occupy thread pool with ranges which are computationally
172          *   expensive, but which are smaller than amount of available threads.
173          *   For example, it's possible to multi-thread [0 .. 64] range into 4
174          *   thread which will be doing 16 iterators each.
175          * This is a preferred way to tell scheduler when to start threading than
176          * having a global use_threading switch based on just range size.
177          */
178         int min_iter_per_thread;
179 } ParallelRangeSettings;
180
181 BLI_INLINE void BLI_parallel_range_settings_defaults(
182         ParallelRangeSettings *settings);
183
184 void BLI_task_parallel_range(
185         const int start, const int stop,
186         void *userdata,
187         TaskParallelRangeFunc func,
188         const ParallelRangeSettings *settings);
189
190 typedef void (*TaskParallelListbaseFunc)(void *userdata,
191                                          struct Link *iter,
192                                          int index);
193 void BLI_task_parallel_listbase(
194         struct ListBase *listbase,
195         void *userdata,
196         TaskParallelListbaseFunc func,
197         const bool use_threading);
198
199 typedef struct MempoolIterData MempoolIterData;
200 typedef void (*TaskParallelMempoolFunc)(void *userdata,
201                                         MempoolIterData *iter);
202 void BLI_task_parallel_mempool(
203         struct BLI_mempool *mempool,
204         void *userdata,
205         TaskParallelMempoolFunc func,
206         const bool use_threading);
207
208 /* TODO(sergey): Think of a better place for this. */
209 BLI_INLINE void BLI_parallel_range_settings_defaults(
210         ParallelRangeSettings *settings)
211 {
212         memset(settings, 0, sizeof(*settings));
213         settings->use_threading = true;
214         settings->scheduling_mode = TASK_SCHEDULING_STATIC;
215         /* NOTE: Current value mimics old behavior, but it's not ideal by any
216          * means. Would be cool to find a common value which will work good enough
217          * for both static and dynamic scheduling.
218          */
219         settings->min_iter_per_thread = 1;
220 }
221
222 #ifdef __cplusplus
223 }
224 #endif
225
226 #endif