#include <pthread.h>
#include "BLI_sys_types.h"

Macros
#define	BLENDER_MAX_THREADS 1024
#define	BLI_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
#define	THREAD_LOCK_READ 1
#define	THREAD_LOCK_WRITE 2
#define	BLI_RWLOCK_INITIALIZER PTHREAD_RWLOCK_INITIALIZER
#define	ThreadLocal(type)
#define	BLI_thread_local_create(name)
#define	BLI_thread_local_delete(name)
#define	BLI_thread_local_get(name)
#define	BLI_thread_local_set(name, value)

Typedefs
typedef pthread_mutex_t	ThreadMutex
typedef pthread_spinlock_t	SpinLock
typedef pthread_rwlock_t	ThreadRWMutex
typedef struct TicketMutex	TicketMutex
typedef pthread_cond_t	ThreadCondition
typedef struct ThreadQueue	ThreadQueue

Enumerations
enum	{ LOCK_IMAGE = 0 , LOCK_DRAW_IMAGE , LOCK_VIEWER , LOCK_CUSTOM1 , LOCK_NODES , LOCK_MOVIECLIP , LOCK_COLORMANAGE , LOCK_FFTW , LOCK_VIEW3D }
enum	ThreadQueueWorkPriority { BLI_THREAD_QUEUE_WORK_PRIORITY_LOW , BLI_THREAD_QUEUE_WORK_PRIORITY_NORMAL , BLI_THREAD_QUEUE_WORK_PRIORITY_HIGH }

Functions
void	BLI_threadapi_init (void)
void	BLI_threadapi_exit (void)
void	BLI_threadpool_init (struct ListBase threadbase, void (do_thread)(void ), int tot)
int	BLI_available_threads (struct ListBase *threadbase)
int	BLI_threadpool_available_thread_index (struct ListBase *threadbase)
void	BLI_threadpool_insert (struct ListBase threadbase, void callerdata)
void	BLI_threadpool_remove (struct ListBase threadbase, void callerdata)
void	BLI_threadpool_remove_index (struct ListBase *threadbase, int index)
void	BLI_threadpool_clear (struct ListBase *threadbase)
void	BLI_threadpool_end (struct ListBase *threadbase)
int	BLI_thread_is_main (void)
int	BLI_system_thread_count (void)
void	BLI_system_num_threads_override_set (int num)
int	BLI_system_num_threads_override_get (void)
void	BLI_thread_lock (int type)
void	BLI_thread_unlock (int type)
void	BLI_mutex_init (ThreadMutex *mutex)
void	BLI_mutex_end (ThreadMutex *mutex)
ThreadMutex *	BLI_mutex_alloc (void)
void	BLI_mutex_free (ThreadMutex *mutex)
void	BLI_mutex_lock (ThreadMutex *mutex)
bool	BLI_mutex_trylock (ThreadMutex *mutex)
void	BLI_mutex_unlock (ThreadMutex *mutex)
void	BLI_spin_init (SpinLock *spin)
void	BLI_spin_lock (SpinLock *spin)
void	BLI_spin_unlock (SpinLock *spin)
void	BLI_spin_end (SpinLock *spin)
void	BLI_rw_mutex_init (ThreadRWMutex *mutex)
void	BLI_rw_mutex_end (ThreadRWMutex *mutex)
ThreadRWMutex *	BLI_rw_mutex_alloc (void)
void	BLI_rw_mutex_free (ThreadRWMutex *mutex)
void	BLI_rw_mutex_lock (ThreadRWMutex *mutex, int mode)
void	BLI_rw_mutex_unlock (ThreadRWMutex *mutex)
TicketMutex *	BLI_ticket_mutex_alloc (void)
void	BLI_ticket_mutex_free (TicketMutex *ticket)
void	BLI_ticket_mutex_lock (TicketMutex *ticket)
bool	BLI_ticket_mutex_lock_check_recursive (TicketMutex *ticket)
void	BLI_ticket_mutex_unlock (TicketMutex *ticket)
void	BLI_condition_init (ThreadCondition *cond)
void	BLI_condition_wait (ThreadCondition cond, ThreadMutex mutex)
void	BLI_condition_wait_global_mutex (ThreadCondition *cond, int type)
void	BLI_condition_notify_one (ThreadCondition *cond)
void	BLI_condition_notify_all (ThreadCondition *cond)
void	BLI_condition_end (ThreadCondition *cond)
ThreadQueue *	BLI_thread_queue_init (void)
void	BLI_thread_queue_free (ThreadQueue *queue)
uint64_t	BLI_thread_queue_push (ThreadQueue queue, void work, ThreadQueueWorkPriority priority)
void	BLI_thread_queue_cancel_work (ThreadQueue *queue, uint64_t work_id)
void *	BLI_thread_queue_pop (ThreadQueue *queue)
void *	BLI_thread_queue_pop_timeout (ThreadQueue *queue, int ms)
int	BLI_thread_queue_len (ThreadQueue *queue)
bool	BLI_thread_queue_is_empty (ThreadQueue *queue)
void	BLI_thread_queue_wait_finish (ThreadQueue *queue)
void	BLI_thread_queue_nowait (ThreadQueue *queue)

Macro Definition Documentation

◆ BLENDER_MAX_THREADS

#define BLENDER_MAX_THREADS 1024

For tables, button in UI, etc.

Definition at line 16 of file BLI_threads.h.

Referenced by arg_handle_threads_set(), BLI_rng_threaded_new(), BLI_task_parallel_thread_id(), ntreeShaderBeginExecTree_internal(), ntreeShaderEndExecTree_internal(), ntreeTexBeginExecTree_internal(), ntreeTexEndExecTree_internal(), project_paint_op(), rna_def_scene_render_data(), and tex_free_delegates().

◆ BLI_MUTEX_INITIALIZER

#define BLI_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER

Definition at line 80 of file BLI_threads.h.

◆ BLI_RWLOCK_INITIALIZER

#define BLI_RWLOCK_INITIALIZER PTHREAD_RWLOCK_INITIALIZER

Definition at line 120 of file BLI_threads.h.

◆ BLI_thread_local_create

#define BLI_thread_local_create ( name )

Definition at line 248 of file BLI_threads.h.

◆ BLI_thread_local_delete

#define BLI_thread_local_delete ( name )

Definition at line 249 of file BLI_threads.h.

◆ BLI_thread_local_get

#define BLI_thread_local_get ( name )

Value:

name

const char * name

Definition python_compat.hh:32

Definition at line 250 of file BLI_threads.h.

◆ BLI_thread_local_set

#define BLI_thread_local_set	(		name,
			value )

Value:

name = value

Definition at line 251 of file BLI_threads.h.

◆ THREAD_LOCK_READ

#define THREAD_LOCK_READ 1

Definition at line 117 of file BLI_threads.h.

Referenced by BLI_rw_mutex_lock(), psys_update_particle_bvhtree(), RE_AcquireResultImage(), RE_AcquireResultImageViews(), RE_AcquireResultRead(), sph_evaluate_func(), and vfont_char_ensure_with_lock().

◆ THREAD_LOCK_WRITE

#define THREAD_LOCK_WRITE 2

Definition at line 118 of file BLI_threads.h.

Referenced by do_render_compositor(), do_render_sequencer(), fluid_modifier_reset_ex(), psys_update_particle_bvhtree(), RE_AcquireResultWrite(), RE_engine_render(), re_ensure_passes_allocated_thread_safe(), RE_InitState(), RE_ReadRenderResult(), render_init_from_main(), render_result_uncrop(), renderresult_set_passes_metadata(), vfont_char_ensure_with_lock(), and vfont_data_ensure_with_lock().

◆ ThreadLocal

#define ThreadLocal ( type )

Value:

__thread type

Definition at line 246 of file BLI_threads.h.

Typedef Documentation

◆ SpinLock

typedef pthread_spinlock_t SpinLock

Definition at line 107 of file BLI_threads.h.

◆ ThreadCondition

typedef pthread_cond_t ThreadCondition

Definition at line 148 of file BLI_threads.h.

◆ ThreadMutex

typedef pthread_mutex_t ThreadMutex

Definition at line 79 of file BLI_threads.h.

◆ ThreadQueue

typedef struct ThreadQueue ThreadQueue

Definition at line 161 of file BLI_threads.h.

◆ ThreadRWMutex

typedef pthread_rwlock_t ThreadRWMutex

Definition at line 122 of file BLI_threads.h.

◆ TicketMutex

typedef struct TicketMutex TicketMutex

Definition at line 138 of file BLI_threads.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Global Mutex Locks

One custom lock available now. can be extended.

Enumerator
LOCK_IMAGE
LOCK_DRAW_IMAGE
LOCK_VIEWER
LOCK_CUSTOM1
LOCK_NODES
LOCK_MOVIECLIP
LOCK_COLORMANAGE
LOCK_FFTW
LOCK_VIEW3D

Definition at line 62 of file BLI_threads.h.

◆ ThreadQueueWorkPriority

enum ThreadQueueWorkPriority

Enumerator
BLI_THREAD_QUEUE_WORK_PRIORITY_LOW
BLI_THREAD_QUEUE_WORK_PRIORITY_NORMAL
BLI_THREAD_QUEUE_WORK_PRIORITY_HIGH

Definition at line 163 of file BLI_threads.h.

Function Documentation

◆ BLI_available_threads()

int BLI_available_threads ( struct ListBase * threadbase )

Amount of available threads.

Definition at line 146 of file threads.cc.

References LISTBASE_FOREACH.

Referenced by ZstdWriteWrap::write().

◆ BLI_condition_end()

void BLI_condition_end ( ThreadCondition * cond )

Definition at line 600 of file threads.cc.

Referenced by ZstdWriteWrap::close(), IMB_thumb_locks_release(), and blender::seq::seq_prefetch_free().

◆ BLI_condition_init()

void BLI_condition_init ( ThreadCondition * cond )

Definition at line 575 of file threads.cc.

Referenced by IMB_thumb_locks_acquire(), ZstdWriteWrap::open(), blender::seq::seq_prefetch_start_ex(), and blender::ed::vse::sequencer_preview_add_sound().

◆ BLI_condition_notify_all()

void BLI_condition_notify_all ( ThreadCondition * cond )

Definition at line 595 of file threads.cc.

Referenced by IMB_thumb_path_unlock().

◆ BLI_condition_notify_one()

void BLI_condition_notify_one ( ThreadCondition * cond )

Definition at line 590 of file threads.cc.

Referenced by blender::ed::vse::free_read_sound_waveform_task(), blender::seq::prefetch_stop(), blender::seq::seq_prefetch_resume(), and blender::ed::vse::sequencer_preview_add_sound().

◆ BLI_condition_wait()

void BLI_condition_wait	(	ThreadCondition *	cond,
		ThreadMutex *	mutex )

Definition at line 580 of file threads.cc.

References mutex.

Referenced by blender::ed::vse::preview_startjob(), and blender::seq::seq_prefetch_do_suspend().

◆ BLI_condition_wait_global_mutex()

void BLI_condition_wait_global_mutex	(	ThreadCondition *	cond,
		int	type )

Definition at line 585 of file threads.cc.

References global_mutex_from_type().

Referenced by IMB_thumb_path_lock().

◆ BLI_mutex_alloc()

ThreadMutex * BLI_mutex_alloc ( void )

Definition at line 365 of file threads.cc.

References BLI_mutex_init(), MEM_callocN(), and mutex.

Referenced by blender::ed::vse::sequencer_preview_add_sound().

◆ BLI_mutex_end()

void BLI_mutex_end ( ThreadMutex * mutex )

Definition at line 360 of file threads.cc.

References mutex.

Referenced by BLI_mutex_free(), BLI_spin_end(), ZstdWriteWrap::close(), gpu_batch_presets_exit(), RE_engine_free(), blender::seq::seq_prefetch_free(), and BaseRender::~BaseRender().

◆ BLI_mutex_free()

void BLI_mutex_free ( ThreadMutex * mutex )

Definition at line 372 of file threads.cc.

References BLI_mutex_end(), MEM_freeN(), and mutex.

Referenced by blender::ed::vse::free_preview_job().

◆ BLI_mutex_init()

void BLI_mutex_init ( ThreadMutex * mutex )

Definition at line 340 of file threads.cc.

References mutex.

Referenced by BLI_mempool_create(), BLI_mutex_alloc(), BLI_spin_init(), gpu_batch_presets_init(), ZstdWriteWrap::open(), RE_engine_create(), and blender::seq::seq_prefetch_start_ex().

◆ BLI_mutex_lock()

◆ BLI_mutex_trylock()

bool BLI_mutex_trylock ( ThreadMutex * mutex )

Definition at line 355 of file threads.cc.

References mutex.

◆ BLI_mutex_unlock()

◆ BLI_rw_mutex_alloc()

ThreadRWMutex * BLI_rw_mutex_alloc ( void )

Definition at line 487 of file threads.cc.

References BLI_rw_mutex_init(), MEM_callocN(), and mutex.

Referenced by BKE_fluid_modifier_create_type_data(), and BKE_modifier_blend_read_data().

◆ BLI_rw_mutex_end()

void BLI_rw_mutex_end ( ThreadRWMutex * mutex )

Definition at line 482 of file threads.cc.

References mutex.

Referenced by BLI_rw_mutex_free(), and BaseRender::~BaseRender().

◆ BLI_rw_mutex_free()

void BLI_rw_mutex_free ( ThreadRWMutex * mutex )

Definition at line 494 of file threads.cc.

References BLI_rw_mutex_end(), MEM_freeN(), and mutex.

Referenced by fluid_modifier_freeDomain().

◆ BLI_rw_mutex_init()

void BLI_rw_mutex_init ( ThreadRWMutex * mutex )

Definition at line 462 of file threads.cc.

References mutex.

Referenced by BLI_rw_mutex_alloc().

◆ BLI_rw_mutex_lock()

void BLI_rw_mutex_lock	(	ThreadRWMutex *	mutex,
		int	mode )

◆ BLI_rw_mutex_unlock()

void BLI_rw_mutex_unlock ( ThreadRWMutex * mutex )

◆ BLI_spin_end()

void BLI_spin_end ( SpinLock * spin )

Definition at line 445 of file threads.cc.

References BLI_mutex_end(), and UNUSED_VARS.

Referenced by BKE_autotrack_context_free(), dynamics_step(), ED_image_paint_tile_lock_end(), lineart_destroy_render_data(), lineart_end_bounding_area_recursive(), lineart_free_bounding_area_memory(), project_paint_end(), sound_free_data(), tracking_image_accessor_destroy(), tracks_map_free(), blender::deg::Depsgraph::~Depsgraph(), and Main::~Main().

◆ BLI_spin_init()

void BLI_spin_init ( SpinLock * spin )

Definition at line 391 of file threads.cc.

References BLI_mutex_init().

Referenced by BKE_autotrack_context_new(), BKE_sound_new_file(), blender::deg::Depsgraph::Depsgraph(), dynamics_step(), ED_image_paint_tile_lock_init(), lineart_bounding_area_split(), lineart_create_render_buffer_v3(), lineart_main_bounding_area_make_initial(), lineart_main_try_generate_shadow_v3(), Main::Main(), proj_paint_state_thread_init(), sound_blend_read_data(), sound_copy_data(), tracking_image_accessor_new(), and tracks_map_new().

◆ BLI_spin_lock()

◆ BLI_spin_unlock()

◆ BLI_system_num_threads_override_get()

int BLI_system_num_threads_override_get ( void )

Definition at line 294 of file threads.cc.

References threads_override_num.

Referenced by BKE_render_num_threads(), BLI_task_scheduler_init(), and OIIO_init().

◆ BLI_system_num_threads_override_set()

void BLI_system_num_threads_override_set ( int num )

Definition at line 289 of file threads.cc.

References num, and threads_override_num.

Referenced by arg_handle_threads_set().

◆ BLI_system_thread_count()

int BLI_system_thread_count ( void )

Returns: the number of threads the system can make use of.

Definition at line 253 of file threads.cc.

References CLAMP, len, LIKELY, RE_MAX_THREAD, and threads_override_num.

Referenced by arg_handle_gpu_compilation_subprocesses_set(), BKE_render_num_threads(), BLI_task_scheduler_init(), blender::gpu::VKBackend::capabilities_init(), blender::fn::multi_function::compute_grain_size(), blender::array_utils::count_indices(), blender::index_mask::IndexMask::from_indices(), blender::bke::calc_edges::get_parallel_maps_count(), imb_initopenexr(), blender::fftw::initialize_float(), ZstdWriteWrap::open(), and psys_tasks_create().

◆ BLI_thread_is_main()

int BLI_thread_is_main ( void )

Definition at line 179 of file threads.cc.

References mainid.

Referenced by blender::gpu::GPUSecondaryContext::activate(), BKE_icon_geom_ensure(), BKE_icon_geom_from_file(), BKE_icon_geom_from_memory(), BKE_icon_get(), BKE_icon_gplayer_color_ensure(), BKE_icon_id_delete(), BKE_icon_id_ensure(), BKE_icons_free(), BKE_icons_init(), BKE_image_free_gputextures(), BKE_image_free_unused_gpu_textures(), BKE_previewimg_cached_ensure(), BKE_previewimg_cached_get(), BKE_previewimg_cached_release(), BKE_previewimg_cached_thumbnail_read(), BLI_change_working_dir(), BLT_translate(), BPY_context_update(), ctx_data_get(), ctx_wm_python_context_get(), blender::gpu::VKDevice::debug_print(), ContextShared::disable(), blender::draw::DebugDraw::display_to_view(), DRW_blender_gpu_render_context_enable(), DRW_gpu_context_activate(), DRW_gpu_context_destroy(), DRW_gpu_context_release(), DRW_system_gpu_render_context_enable(), ED_preview_ensure_dbase(), ED_render_id_flush_update(), ED_render_scene_update(), engine_depsgraph_free(), RenderDisplay::ensure_system_gpu_context(), blender::render::Compositor::execute(), GPU_batch_preset_sphere(), GPU_batch_preset_sphere_wire(), blender::gpu::GPUSecondaryContext::GPUSecondaryContext(), icon_gplayer_color_ensure_create_icon(), icon_id_ensure_create_icon(), image_init_after_load(), blender::eevee::LightBake::LightBake(), RE_engine_gpu_context_create(), RE_FreeUnusedGPUResources(), blender::gpu::VKBackend::render_end(), blender::eevee::LightBake::update(), wm_file_write(), wm_job_end(), wm_surface_reset_drawable(), WM_system_gpu_context_create(), wm_window_events_process(), wm_window_reset_drawable(), blender::render::Compositor::~Compositor(), blender::gpu::GPUSecondaryContext::~GPUSecondaryContext(), blender::eevee::LightBake::~LightBake(), and RenderDisplay::~RenderDisplay().

◆ BLI_thread_lock()

void BLI_thread_lock ( int type )

Definition at line 328 of file threads.cc.

References global_mutex_from_type().

Referenced by accessor_get_ibuf(), BKE_image_ensure_viewer_views(), BKE_movieclip_get_cache_segments(), BKE_movieclip_has_cached_frame(), BKE_movieclip_put_frame_if_possible(), colorfn(), blender::ed::space_node::draw_nodespace_back_pix(), image_acquire_ibuf(), image_get_render_result(), image_main_region_draw(), blender::nodes::node_geo_image_texture_cc::ImageFieldsFunction::ImageFieldsFunction(), IMB_display_buffer_acquire(), IMB_display_buffer_release(), imb_partial_display_buffer_update_ex(), IMB_thumb_locks_acquire(), IMB_thumb_locks_release(), IMB_thumb_path_lock(), IMB_thumb_path_unlock(), movieclip_build_proxy_ibuf(), movieclip_get_postprocessed_ibuf(), ntreeTexExecTree(), blender::render::Context::output_to_render_result(), project_paint_face_init(), view3d_stereo3d_setup(), and blender::render::Context::viewer_output_to_viewer_image().

◆ BLI_thread_queue_cancel_work()

void BLI_thread_queue_cancel_work	(	ThreadQueue *	queue,
		uint64_t	work_id )

Remove the corresponding work from the queue.

Definition at line 684 of file threads.cc.

References check_finalization(), ThreadQueue::mutex, ThreadQueue::queue_high_priority, ThreadQueue::queue_low_priority, and ThreadQueue::queue_normal_priority.

◆ BLI_thread_queue_free()

void BLI_thread_queue_free ( ThreadQueue * queue )

Deallocate the ThreadQueue. Assumes no one is using the queue anymore.

Definition at line 635 of file threads.cc.

References ThreadQueue::finish_cond, ThreadQueue::mutex, and ThreadQueue::push_cond.

Referenced by filelist_cache_previews_free(), PreviewLoadJob::~PreviewLoadJob(), and TaskPool::~TaskPool().

◆ BLI_thread_queue_init()

ThreadQueue * BLI_thread_queue_init ( void )

Allocate a new ThreadQueue.

Definition at line 624 of file threads.cc.

References ThreadQueue::finish_cond, ThreadQueue::mutex, and ThreadQueue::push_cond.

Referenced by filelist_cache_preview_ensure_running(), PreviewLoadJob::PreviewLoadJob(), and TaskPool::TaskPool().

◆ BLI_thread_queue_is_empty()

bool BLI_thread_queue_is_empty ( ThreadQueue * queue )

Returns: true if there are no pending works in the queue.

Definition at line 839 of file threads.cc.

References ThreadQueue::mutex, ThreadQueue::queue_high_priority, ThreadQueue::queue_low_priority, and ThreadQueue::queue_normal_priority.

Referenced by filelist_cache_previews_update().

◆ BLI_thread_queue_len()

int BLI_thread_queue_len ( ThreadQueue * queue )

Returns: the total amount of pending works still in the queue.

Definition at line 827 of file threads.cc.

References ThreadQueue::mutex, ThreadQueue::queue_high_priority, ThreadQueue::queue_low_priority, ThreadQueue::queue_normal_priority, and size().

◆ BLI_thread_queue_nowait()

void BLI_thread_queue_nowait ( ThreadQueue * queue )

After calling this function, BLI_thread_queue_pop and BLI_thread_queue_pop_timeout won't block the calling thread even when the queue is empty.

Definition at line 851 of file threads.cc.

References ThreadQueue::mutex, ThreadQueue::nowait, and ThreadQueue::push_cond.

Referenced by filelist_cache_previews_free().

◆ BLI_thread_queue_pop()

void * BLI_thread_queue_pop ( ThreadQueue * queue )

Pop the oldest, highest priority work from the queue. Blocks the calling thread unless BLI_thread_queue_nowait has been called for this queue.

Returns: nullptr if nowait has been set and the queue is empty. Otherwise returns a work pointer.

Definition at line 712 of file threads.cc.

References check_finalization(), ThreadQueue::mutex, ThreadQueue::nowait, ThreadQueue::push_cond, ThreadQueue::queue_high_priority, ThreadQueue::queue_low_priority, ThreadQueue::queue_normal_priority, and ThreadQueueWork::work.

Referenced by filelist_cache_previews_update().

◆ BLI_thread_queue_pop_timeout()

void * BLI_thread_queue_pop_timeout	(	ThreadQueue *	queue,
		int	ms )

Try to pop the oldest, highest priority work from the queue. Blocks the calling thread unless BLI_thread_queue_nowait has been called for this queue.

Returns: nullptr if time runs out, or if nowait has been set and the queue is empty. Otherwise returns a work pointer.

Definition at line 782 of file threads.cc.

References BLI_time_now_seconds(), check_finalization(), ThreadQueue::mutex, ThreadQueue::nowait, ThreadQueue::push_cond, ThreadQueue::queue_high_priority, ThreadQueue::queue_low_priority, ThreadQueue::queue_normal_priority, wait_timeout(), and ThreadQueueWork::work.

Referenced by filelist_cache_previews_clear(), blender::gpu::VKDevice::render_graph_new(), and blender::gpu::VKDevice::submission_runner().

◆ BLI_thread_queue_push()

uint64_t BLI_thread_queue_push	(	ThreadQueue *	queue,
		void *	work,
		ThreadQueueWorkPriority	priority )

Push one work pointer to the queue. Higher priority works always take priority over lower priority ones, regardless of their insertion order. Works within the same priority follow FIFO order.