Halide
Classes | Namespaces | Macros | Functions | Variables
thread_pool_common.h File Reference

Go to the source code of this file.

Classes

struct  Halide::Runtime::Internal::work
 
struct  Halide::Runtime::Internal::work_queue_t
 
struct  halide_semaphore_impl_t
 

Namespaces

 Halide
 This file defines the class FunctionDAG, which is our representation of a Halide pipeline, and contains methods to using Halide's bounds tools to query properties of it.
 
 Halide::Runtime
 
 Halide::Runtime::Internal
 

Macros

#define EXTENDED_DEBUG   0
 
#define log_message(stuff)   do { /*nothing*/ } while (0)
 
#define print_job(job, indent, prefix)   do { /*nothing*/ } while (0)
 
#define dump_job_state()   do { /*nothing*/ } while (0)
 

Functions

ALWAYS_INLINE int Halide::Runtime::Internal::clamp_num_threads (int threads)
 
WEAK int Halide::Runtime::Internal::default_desired_num_threads ()
 
WEAK void Halide::Runtime::Internal::worker_thread (void *)
 
WEAK void Halide::Runtime::Internal::worker_thread_already_locked (work *owned_job)
 
WEAK void Halide::Runtime::Internal::enqueue_work_already_locked (int num_jobs, work *jobs, work *task_parent)
 
WEAK int halide_default_do_task (void *user_context, halide_task_t f, int idx, uint8_t *closure)
 
WEAK int halide_default_do_loop_task (void *user_context, halide_loop_task_t f, int min, int extent, uint8_t *closure, void *task_parent)
 
WEAK int halide_default_do_par_for (void *user_context, halide_task_t f, int min, int size, uint8_t *closure)
 The default versions of the parallel runtime functions. More...
 
WEAK int halide_default_do_parallel_tasks (void *user_context, int num_tasks, struct halide_parallel_task_t *tasks, void *task_parent)
 
WEAK int halide_set_num_threads (int n)
 Set the number of threads used by Halide's thread pool. More...
 
WEAK void halide_shutdown_thread_pool ()
 
WEAK int halide_default_semaphore_init (halide_semaphore_t *s, int n)
 
WEAK int halide_default_semaphore_release (halide_semaphore_t *s, int n)
 
WEAK bool halide_default_semaphore_try_acquire (halide_semaphore_t *s, int n)
 
WEAK halide_do_task_t halide_set_custom_do_task (halide_do_task_t f)
 
WEAK halide_do_loop_task_t halide_set_custom_do_loop_task (halide_do_loop_task_t f)
 
WEAK halide_do_par_for_t halide_set_custom_do_par_for (halide_do_par_for_t f)
 
WEAK void halide_set_custom_parallel_runtime (halide_do_par_for_t do_par_for, halide_do_task_t do_task, halide_do_loop_task_t do_loop_task, halide_do_parallel_tasks_t do_parallel_tasks, halide_semaphore_init_t semaphore_init, halide_semaphore_try_acquire_t semaphore_try_acquire, halide_semaphore_release_t semaphore_release)
 
WEAK int halide_do_task (void *user_context, halide_task_t f, int idx, uint8_t *closure)
 
WEAK int halide_do_par_for (void *user_context, halide_task_t f, int min, int size, uint8_t *closure)
 
WEAK int halide_do_loop_task (void *user_context, halide_loop_task_t f, int min, int size, uint8_t *closure, void *task_parent)
 
WEAK int halide_do_parallel_tasks (void *user_context, int num_tasks, struct halide_parallel_task_t *tasks, void *task_parent)
 Enqueue some number of the tasks described above and wait for them to complete. More...
 
WEAK int halide_semaphore_init (struct halide_semaphore_t *sema, int count)
 
WEAK int halide_semaphore_release (struct halide_semaphore_t *sema, int count)
 
WEAK bool halide_semaphore_try_acquire (struct halide_semaphore_t *sema, int count)
 

Variables

WEAK work_queue_t Halide::Runtime::Internal::work_queue = {}
 
WEAK halide_do_task_t Halide::Runtime::Internal::custom_do_task = halide_default_do_task
 
WEAK halide_do_loop_task_t Halide::Runtime::Internal::custom_do_loop_task = halide_default_do_loop_task
 
WEAK halide_do_par_for_t Halide::Runtime::Internal::custom_do_par_for = halide_default_do_par_for
 
WEAK halide_do_parallel_tasks_t Halide::Runtime::Internal::custom_do_parallel_tasks = halide_default_do_parallel_tasks
 
WEAK halide_semaphore_init_t Halide::Runtime::Internal::custom_semaphore_init = halide_default_semaphore_init
 
WEAK halide_semaphore_try_acquire_t Halide::Runtime::Internal::custom_semaphore_try_acquire = halide_default_semaphore_try_acquire
 
WEAK halide_semaphore_release_t Halide::Runtime::Internal::custom_semaphore_release = halide_default_semaphore_release
 

Macro Definition Documentation

◆ EXTENDED_DEBUG

#define EXTENDED_DEBUG   0

Definition at line 1 of file thread_pool_common.h.

◆ log_message

#define log_message (   stuff)    do { /*nothing*/ } while (0)

Definition at line 24 of file thread_pool_common.h.

◆ print_job

#define print_job (   job,
  indent,
  prefix 
)    do { /*nothing*/ } while (0)

Definition at line 197 of file thread_pool_common.h.

◆ dump_job_state

#define dump_job_state ( )    do { /*nothing*/ } while (0)

Definition at line 198 of file thread_pool_common.h.

Function Documentation

◆ halide_default_do_task()

WEAK int halide_default_do_task ( void *  user_context,
halide_task_t  f,
int  idx,
uint8_t *  closure 
)

Definition at line 596 of file thread_pool_common.h.

◆ halide_default_do_loop_task()

WEAK int halide_default_do_loop_task ( void *  user_context,
halide_loop_task_t  f,
int  min,
int  extent,
uint8_t *  closure,
void *  task_parent 
)

Definition at line 601 of file thread_pool_common.h.

◆ halide_default_do_par_for()

WEAK int halide_default_do_par_for ( void *  user_context,
halide_task_t  f,
int  min,
int  size,
uint8_t *  closure 
)

The default versions of the parallel runtime functions.

Definition at line 607 of file thread_pool_common.h.

◆ halide_default_do_parallel_tasks()

WEAK int halide_default_do_parallel_tasks ( void *  user_context,
int  num_tasks,
struct halide_parallel_task_t *  tasks,
void *  task_parent 
)

Definition at line 639 of file thread_pool_common.h.

◆ halide_set_num_threads()

WEAK int halide_set_num_threads ( int  n)

Set the number of threads used by Halide's thread pool.

Returns the old number.

n < 0 : error condition n == 0 : use a reasonable system default (typically, number of cpus online). n == 1 : use exactly one thread; this will always enforce serial execution n > 1 : use a pool of exactly n threads.

(Note that this is only guaranteed when using the default implementations of halide_do_par_for(); custom implementations may completely ignore values passed to halide_set_num_threads().)

Definition at line 679 of file thread_pool_common.h.

References Halide::Runtime::Internal::clamp_num_threads(), Halide::Runtime::Internal::default_desired_num_threads(), Halide::Runtime::Internal::work_queue_t::desired_threads_working, halide_error(), halide_mutex_lock(), halide_mutex_unlock(), Halide::Runtime::Internal::work_queue_t::mutex, and Halide::Runtime::Internal::work_queue.

◆ halide_shutdown_thread_pool()

WEAK void halide_shutdown_thread_pool ( )

Definition at line 696 of file thread_pool_common.h.

References halide_cond_broadcast(), halide_join_thread(), halide_mutex_lock(), halide_mutex_unlock(), Halide::Runtime::Internal::work_queue_t::initialized, Halide::Runtime::Internal::work_queue_t::mutex, Halide::Runtime::Internal::work_queue_t::reset(), Halide::Runtime::Internal::work_queue_t::shutdown, Halide::Runtime::Internal::work_queue_t::threads, Halide::Runtime::Internal::work_queue_t::threads_created, Halide::Runtime::Internal::work_queue_t::wake_a_team, Halide::Runtime::Internal::work_queue_t::wake_b_team, Halide::Runtime::Internal::work_queue_t::wake_owners, and Halide::Runtime::Internal::work_queue.

◆ halide_default_semaphore_init()

WEAK int halide_default_semaphore_init ( halide_semaphore_t *  s,
int  n 
)

Definition at line 722 of file thread_pool_common.h.

References halide_semaphore_impl_t::value.

◆ halide_default_semaphore_release()

WEAK int halide_default_semaphore_release ( halide_semaphore_t *  s,
int  n 
)

Definition at line 728 of file thread_pool_common.h.

References halide_cond_broadcast(), halide_mutex_lock(), halide_mutex_unlock(), Halide::Runtime::Internal::work_queue_t::mutex, halide_semaphore_impl_t::value, Halide::Runtime::Internal::work_queue_t::wake_a_team, Halide::Runtime::Internal::work_queue_t::wake_owners, and Halide::Runtime::Internal::work_queue.

◆ halide_default_semaphore_try_acquire()

WEAK bool halide_default_semaphore_try_acquire ( halide_semaphore_t *  s,
int  n 
)

Definition at line 742 of file thread_pool_common.h.

References halide_semaphore_impl_t::value.

Referenced by Halide::Runtime::Internal::work::make_runnable().

◆ halide_set_custom_do_task()

WEAK halide_do_task_t halide_set_custom_do_task ( halide_do_task_t  f)

Definition at line 758 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_do_task.

◆ halide_set_custom_do_loop_task()

WEAK halide_do_loop_task_t halide_set_custom_do_loop_task ( halide_do_loop_task_t  f)

Definition at line 764 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_do_loop_task.

◆ halide_set_custom_do_par_for()

WEAK halide_do_par_for_t halide_set_custom_do_par_for ( halide_do_par_for_t  f)

Definition at line 770 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_do_par_for.

◆ halide_set_custom_parallel_runtime()

WEAK void halide_set_custom_parallel_runtime ( halide_do_par_for_t  do_par_for,
halide_do_task_t  do_task,
halide_do_loop_task_t  do_loop_task,
halide_do_parallel_tasks_t  do_parallel_tasks,
halide_semaphore_init_t  semaphore_init,
halide_semaphore_try_acquire_t  semaphore_try_acquire,
halide_semaphore_release_t  semaphore_release 
)

Definition at line 776 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_do_loop_task, Halide::Runtime::Internal::custom_do_par_for, Halide::Runtime::Internal::custom_do_parallel_tasks, Halide::Runtime::Internal::custom_do_task, Halide::Runtime::Internal::custom_semaphore_init, Halide::Runtime::Internal::custom_semaphore_release, and Halide::Runtime::Internal::custom_semaphore_try_acquire.

◆ halide_do_task()

WEAK int halide_do_task ( void *  user_context,
halide_task_t  f,
int  idx,
uint8_t *  closure 
)

Definition at line 794 of file thread_pool_common.h.

Referenced by Halide::Runtime::Internal::worker_thread_already_locked().

◆ halide_do_par_for()

WEAK int halide_do_par_for ( void *  user_context,
halide_task_t  f,
int  min,
int  size,
uint8_t *  closure 
)

Definition at line 799 of file thread_pool_common.h.

◆ halide_do_loop_task()

WEAK int halide_do_loop_task ( void *  user_context,
halide_loop_task_t  f,
int  min,
int  size,
uint8_t *  closure,
void *  task_parent 
)

Definition at line 804 of file thread_pool_common.h.

Referenced by Halide::Runtime::Internal::worker_thread_already_locked().

◆ halide_do_parallel_tasks()

WEAK int halide_do_parallel_tasks ( void *  user_context,
int  num_tasks,
struct halide_parallel_task_t *  tasks,
void *  task_parent 
)

Enqueue some number of the tasks described above and wait for them to complete.

While waiting, the calling threads assists with either the tasks enqueued, or other non-blocking tasks in the task system. Note that task_parent should be NULL for top-level calls and the pass through argument if this call is being made from another task.

Definition at line 809 of file thread_pool_common.h.

◆ halide_semaphore_init()

WEAK int halide_semaphore_init ( struct halide_semaphore_t *  sema,
int  count 
)

Definition at line 815 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_semaphore_init.

◆ halide_semaphore_release()

WEAK int halide_semaphore_release ( struct halide_semaphore_t *  sema,
int  count 
)

Definition at line 819 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_semaphore_release.

◆ halide_semaphore_try_acquire()

WEAK bool halide_semaphore_try_acquire ( struct halide_semaphore_t *  sema,
int  count 
)

Definition at line 823 of file thread_pool_common.h.

References Halide::Runtime::Internal::custom_semaphore_try_acquire.