#include <cstdlib>
#include <memory>
#include <utility>
#include "MEM_guardedalloc.h"
#include "DNA_listBase.h"
#include "BLI_math.h"
#include "BLI_mempool.h"
#include "BLI_task.h"
#include "BLI_threads.h"

Classes
class	Task

class	TaskPool

Enumerations
enum	TaskPoolType { TASK_POOL_TBB , TASK_POOL_TBB_SUSPENDED , TASK_POOL_NO_THREADS , TASK_POOL_BACKGROUND , TASK_POOL_BACKGROUND_SERIAL }

Functions
static void	tbb_task_pool_create (TaskPool *pool, TaskPriority priority)

static void	tbb_task_pool_run (TaskPool *pool, Task &&task)

static void	tbb_task_pool_work_and_wait (TaskPool *pool)

static void	tbb_task_pool_cancel (TaskPool *pool)

static bool	tbb_task_pool_canceled (TaskPool *pool)

static void	tbb_task_pool_free (TaskPool *pool)

static void *	background_task_run (void *userdata)

static void	background_task_pool_create (TaskPool *pool)

static void	background_task_pool_run (TaskPool *pool, Task &&task)

static void	background_task_pool_work_and_wait (TaskPool *pool)

static void	background_task_pool_cancel (TaskPool *pool)

static bool	background_task_pool_canceled (TaskPool *pool)

static void	background_task_pool_free (TaskPool *pool)

static TaskPool *	task_pool_create_ex (void *userdata, TaskPoolType type, TaskPriority priority)

TaskPool *	BLI_task_pool_create (void *userdata, TaskPriority priority)

TaskPool *	BLI_task_pool_create_background (void *userdata, TaskPriority priority)

TaskPool *	BLI_task_pool_create_suspended (void *userdata, TaskPriority priority)

TaskPool *	BLI_task_pool_create_no_threads (void *userdata)

TaskPool *	BLI_task_pool_create_background_serial (void *userdata, TaskPriority priority)

void	BLI_task_pool_free (TaskPool *pool)

void	BLI_task_pool_push (TaskPool pool, TaskRunFunction run, void taskdata, bool free_taskdata, TaskFreeFunction freedata)

void	BLI_task_pool_work_and_wait (TaskPool *pool)

void	BLI_task_pool_cancel (TaskPool *pool)

bool	BLI_task_pool_current_canceled (TaskPool *pool)

void *	BLI_task_pool_user_data (TaskPool *pool)

ThreadMutex *	BLI_task_pool_user_mutex (TaskPool *pool)

Detailed Description

Task pool to run tasks in parallel.

Definition in file task_pool.cc.

Enumeration Type Documentation

◆ TaskPoolType

enum TaskPoolType

Enumerator
TASK_POOL_TBB
TASK_POOL_TBB_SUSPENDED
TASK_POOL_NO_THREADS
TASK_POOL_BACKGROUND
TASK_POOL_BACKGROUND_SERIAL

Definition at line 155 of file task_pool.cc.

Function Documentation

◆ background_task_pool_cancel()

static void background_task_pool_cancel ( TaskPool * pool )

static

Definition at line 337 of file task_pool.cc.

References TaskPool::background_is_canceling, TaskPool::background_queue, TaskPool::background_threads, BLI_thread_queue_nowait(), BLI_thread_queue_pop(), BLI_threadpool_remove(), MEM_freeN, blender::compositor::pool, and blender::compositor::task.

Referenced by BLI_task_pool_cancel().

◆ background_task_pool_canceled()

static bool background_task_pool_canceled ( TaskPool * pool )

static

Definition at line 353 of file task_pool.cc.

References TaskPool::background_is_canceling, and blender::compositor::pool.

Referenced by BLI_task_pool_current_canceled().

◆ background_task_pool_create()

static void background_task_pool_create ( TaskPool * pool )

static

Definition at line 311 of file task_pool.cc.

References TaskPool::background_queue, background_task_run(), TaskPool::background_threads, BLI_thread_queue_init(), BLI_threadpool_init(), and blender::compositor::pool.

Referenced by task_pool_create_ex().

◆ background_task_pool_free()

static void background_task_pool_free ( TaskPool * pool )

static

Definition at line 358 of file task_pool.cc.

References TaskPool::background_queue, background_task_pool_work_and_wait(), TaskPool::background_threads, BLI_thread_queue_free(), BLI_threadpool_end(), and blender::compositor::pool.

Referenced by BLI_task_pool_free().

◆ background_task_pool_run()

static void background_task_pool_run	(	TaskPool *	pool,
		Task &&	task
	)

static

Definition at line 317 of file task_pool.cc.

References TaskPool::background_queue, TaskPool::background_threads, BLI_available_threads(), BLI_thread_queue_push(), BLI_threadpool_insert(), MEM_mallocN, blender::compositor::pool, and blender::compositor::task.

Referenced by BLI_task_pool_push().

◆ background_task_pool_work_and_wait()

static void background_task_pool_work_and_wait ( TaskPool * pool )

static

Definition at line 328 of file task_pool.cc.

References TaskPool::background_queue, TaskPool::background_threads, BLI_thread_queue_nowait(), BLI_thread_queue_wait_finish(), BLI_threadpool_clear(), and blender::compositor::pool.

Referenced by background_task_pool_free(), and BLI_task_pool_work_and_wait().

◆ background_task_run()

static void* background_task_run ( void * userdata )

static

Definition at line 300 of file task_pool.cc.

References TaskPool::background_queue, BLI_thread_queue_pop(), MEM_freeN, blender::compositor::pool, and blender::compositor::task.

Referenced by background_task_pool_create().

◆ BLI_task_pool_cancel()

void BLI_task_pool_cancel ( TaskPool * pool )

Definition at line 511 of file task_pool.cc.

References background_task_pool_cancel(), blender::compositor::pool, TASK_POOL_BACKGROUND, TASK_POOL_BACKGROUND_SERIAL, TASK_POOL_NO_THREADS, TASK_POOL_TBB, TASK_POOL_TBB_SUSPENDED, tbb_task_pool_cancel(), and TaskPool::type.

Referenced by filelist_cache_previews_clear().

◆ BLI_task_pool_create()

TaskPool* BLI_task_pool_create	(	void *	userdata,
		TaskPriority	priority
	)

Create a normal task pool. Tasks will be executed as soon as they are added.

Definition at line 406 of file task_pool.cc.

References task_pool_create_ex(), and TASK_POOL_TBB.

Referenced by BKE_editmesh_loop_tangent_calc(), BKE_lib_override_library_main_operations_create(), BKE_mesh_calc_loop_tangent_ex(), BKE_mesh_normals_loop_split(), BLI_task_parallel_mempool(), distribute_particles_on_dm(), do_sequence_proxy(), IMB_processor_apply_threaded(), IMB_processor_apply_threaded_scanlines(), lineart_main_occlusion_begin(), psys_cache_child_paths(), screen_opengl_render_init(), start_prefetch_threads(), task_parallel_iterator_do(), and blender::compositor::threading_model_task_start().

◆ BLI_task_pool_create_background()

TaskPool* BLI_task_pool_create_background	(	void *	userdata,
		TaskPriority	priority
	)

Create a background task pool. In multi-threaded context, there is no differences with BLI_task_pool_create(), but in single-threaded case it is ensured to have at least one worker thread to run on (i.e. you don't have to call BLI_task_pool_work_and_wait on it to be sure it will be processed).

Note: Background pools are non-recursive (that is, you should not create other background pools in tasks assigned to a background pool, they could end never being executed, since the 'fallback' background thread is already busy with parent task in single-threaded context).

Definition at line 423 of file task_pool.cc.

References TASK_POOL_BACKGROUND, and task_pool_create_ex().

Referenced by filelist_cache_preview_ensure_running().

◆ BLI_task_pool_create_background_serial()

TaskPool* BLI_task_pool_create_background_serial	(	void *	userdata,
		TaskPriority	priority
	)

Task pool that executes one task after the other, possibly on different threads but never in parallel.

Definition at line 451 of file task_pool.cc.

References TASK_POOL_BACKGROUND_SERIAL, and task_pool_create_ex().

Referenced by screen_opengl_render_init().

◆ BLI_task_pool_create_no_threads()

TaskPool* BLI_task_pool_create_no_threads ( void * userdata )

Single threaded task pool that executes pushed task immediately, for debugging purposes.

Definition at line 442 of file task_pool.cc.

References task_pool_create_ex(), TASK_POOL_NO_THREADS, and TASK_PRIORITY_HIGH.

Referenced by blender::deg::deg_evaluate_task_pool_create().

◆ BLI_task_pool_create_suspended()

TaskPool* BLI_task_pool_create_suspended	(	void *	userdata,
		TaskPriority	priority
	)

Similar to BLI_task_pool_create() but does not schedule any tasks for execution for until BLI_task_pool_work_and_wait() is called. This helps reducing threading overhead when pushing huge amount of small initial tasks from the main thread.

Definition at line 433 of file task_pool.cc.

References task_pool_create_ex(), and TASK_POOL_TBB_SUSPENDED.

Referenced by blender::deg::deg_evaluate_task_pool_create(), project_paint_op(), and TEST().