Blender V4.5
BLI_threads.h File Reference
#include <pthread.h>
#include "BLI_sys_types.h"

Go to the source code of this file.

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
}

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)
ThreadMutexBLI_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)
ThreadRWMutexBLI_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)
TicketMutexBLI_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)
ThreadQueueBLI_thread_queue_init (void)
void BLI_thread_queue_free (ThreadQueue *queue)
void BLI_thread_queue_push (ThreadQueue *queue, void *work)
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

◆ 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 189 of file BLI_threads.h.

◆ BLI_thread_local_delete

#define BLI_thread_local_delete ( name)

Definition at line 190 of file BLI_threads.h.

◆ BLI_thread_local_get

#define BLI_thread_local_get ( name)
Value:
name

Definition at line 191 of file BLI_threads.h.

◆ BLI_thread_local_set

#define BLI_thread_local_set ( name,
value )
Value:
name = value

Definition at line 192 of file BLI_threads.h.

◆ THREAD_LOCK_READ

◆ THREAD_LOCK_WRITE

◆ ThreadLocal

#define ThreadLocal ( type)
Value:
__thread type

Definition at line 187 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.

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)

◆ BLI_condition_init()

◆ 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()

◆ 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()

◆ 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()

◆ 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 )

◆ 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(), ccgDM_release(), 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(), and getCCGDerivedMesh().

◆ BLI_rw_mutex_lock()

◆ BLI_rw_mutex_unlock()

◆ BLI_spin_end()

◆ BLI_spin_init()

◆ 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()

◆ 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(), 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(), RE_system_gpu_context_ensure(), RE_system_gpu_context_free(), 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(), and blender::eevee::LightBake::~LightBake().

◆ BLI_thread_lock()

◆ BLI_thread_queue_free()

◆ BLI_thread_queue_init()

◆ BLI_thread_queue_is_empty()

bool BLI_thread_queue_is_empty ( ThreadQueue * queue)

◆ BLI_thread_queue_len()

int BLI_thread_queue_len ( ThreadQueue * queue)

Definition at line 746 of file threads.cc.

References BLI_gsqueue_len(), ThreadQueue::mutex, ThreadQueue::queue, and size().

◆ BLI_thread_queue_nowait()

void BLI_thread_queue_nowait ( ThreadQueue * queue)

Definition at line 768 of file threads.cc.

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

Referenced by filelist_cache_previews_free().

◆ BLI_thread_queue_pop()

◆ BLI_thread_queue_pop_timeout()

◆ BLI_thread_queue_push()

◆ BLI_thread_queue_wait_finish()

void BLI_thread_queue_wait_finish ( ThreadQueue * queue)

◆ BLI_thread_unlock()

◆ BLI_threadapi_exit()

void BLI_threadapi_exit ( void )

◆ BLI_threadapi_init()

void BLI_threadapi_init ( void )

◆ BLI_threadpool_available_thread_index()

int BLI_threadpool_available_thread_index ( struct ListBase * threadbase)

Returns thread number, for sample patterns or threadsafe tables.

Definition at line 159 of file threads.cc.

References LISTBASE_FOREACH.

◆ BLI_threadpool_clear()

void BLI_threadpool_clear ( struct ListBase * threadbase)

Definition at line 223 of file threads.cc.

References LISTBASE_FOREACH.

◆ BLI_threadpool_end()

◆ BLI_threadpool_init()

void BLI_threadpool_init ( struct ListBase * threadbase,
void *(* do_thread )(void *),
int tot )
Parameters
totWhen 0 only initializes malloc mutex in a safe way (see sequence.c) problem otherwise: scene render will kill of the mutex!

Definition at line 121 of file threads.cc.

References atomic_fetch_and_add_u(), ThreadSlot::avail, BLI_addtail(), BLI_listbase_clear(), ThreadSlot::do_thread, MEM_callocN(), RE_MAX_THREAD, and thread_levels.

Referenced by do_multires_bake(), ZstdWriteWrap::open(), sb_cf_threads_run(), sb_sfesf_threads_run(), blender::seq::seq_prefetch_start_ex(), TaskPool::TaskPool(), and WM_jobs_start().

◆ BLI_threadpool_insert()

void BLI_threadpool_insert ( struct ListBase * threadbase,
void * callerdata )

◆ BLI_threadpool_remove()

void BLI_threadpool_remove ( struct ListBase * threadbase,
void * callerdata )

◆ BLI_threadpool_remove_index()

void BLI_threadpool_remove_index ( struct ListBase * threadbase,
int index )

Definition at line 208 of file threads.cc.

References LISTBASE_FOREACH.

◆ BLI_ticket_mutex_alloc()

TicketMutex * BLI_ticket_mutex_alloc ( void )

◆ BLI_ticket_mutex_free()

void BLI_ticket_mutex_free ( TicketMutex * ticket)

◆ BLI_ticket_mutex_lock()

void BLI_ticket_mutex_lock ( TicketMutex * ticket)

◆ BLI_ticket_mutex_lock_check_recursive()

bool BLI_ticket_mutex_lock_check_recursive ( TicketMutex * ticket)

Definition at line 557 of file threads.cc.

References ticket_mutex_lock().

Referenced by DRW_lock_start(), and DRW_submission_start().

◆ BLI_ticket_mutex_unlock()