Function Description
Category |
Function Name |
Function Usage |
Application Scenario |
|---|---|---|---|
Initialization functions |
HTL_initialize_library |
Initializes HTL. |
HTL-OpenMP |
HTL_finalize_library |
Finalizes HTL. |
HTL-OpenMP |
|
HTL_library_initialized |
Checks whether HTL has been initialized. |
HTL-OpenMP |
|
Executor functions |
HTL_thread_executor_create |
Creates an executor. |
HTL-OpenMP |
HTL_thread_executor_create_basic |
Creates a basic executor. |
HTL-OpenMP |
|
HTL_thread_executor_free |
Releases an executor. |
HTL-OpenMP |
|
HTL_thread_executor_join |
Waits until an executor terminates. |
HTL-OpenMP |
|
HTL_thread_executor_set_scheduler |
Sets the scheduler of an executor by scheduler type. |
HTL-OpenMP |
|
HTL_thread_executor_set_scheduler_basic |
Sets the scheduler of an executor. |
HTL-OpenMP |
|
HTL_thread_executor_run_worker |
Runs the worker. |
HTL-OpenMP |
|
HTL_thread_executor_check_event |
Processes events associated with the scheduler. |
HTL-OpenMP |
|
HTL_thread_executor_self |
Obtains the executor that is running the calling worker. |
HTL-OpenMP |
|
HTL_thread_executor_self_by_rank |
Obtains the rank of the executor associated with the caller. |
HTL-OpenMP |
|
HTL_thread_executor_get_num |
Obtains the number of current executors. |
HTL-OpenMP |
|
HTL_thread_executor_set_cpubind |
Binds an executor to a CPU. |
HTL-OpenMP |
|
HTL_thread_executor_get_cpubind |
Obtains the CPU bound to a specified executor. |
HTL-OpenMP |
|
HTL_thread_executor_set_affinity |
Binds an executor to the target CPU set. |
HTL-OpenMP |
|
HTL_thread_executor_get_affinity |
Obtains the CPU set bound to a specified executor. |
HTL-OpenMP |
|
Scheduler functions |
HTL_thread_scheduler_create |
Creates a scheduler. |
HTL-OpenMP |
HTL_thread_scheduler_create_basic |
Creates a basic scheduler. |
HTL-OpenMP |
|
HTL_thread_scheduler_free |
Releases a scheduler. |
HTL-OpenMP |
|
HTL_thread_scheduler_get_pool_count |
Obtains the number of pools associated with a specified scheduler. |
HTL-OpenMP |
|
HTL_thread_scheduler_get_pools |
Obtains the thread pools associated with a specified scheduler. |
HTL-OpenMP |
|
HTL_thread_scheduler_stop |
Checks whether to stop a scheduler. |
HTL-OpenMP |
|
Thread pool functions |
HTL_thread_pool_create |
Creates a thread pool. |
HTL-OpenMP |
HTL_thread_pool_pop |
Pops up the worker from the pool. |
HTL-OpenMP |
|
HTL_thread_pool_pop_with_context |
Pops up the worker from the pool with the context. |
HTL-OpenMP |
|
HTL_thread_pool_free |
Releases a thread pool. |
HTL-OpenMP |
|
HTL_worker_associated_with_pool |
Associates the worker with a pool. |
HTL-OpenMP |
|
Thread functions |
HTL_thread_create_from_pool |
Creates a thread in a thread pool. |
HTL-OpenMP |
HTL_thread_create |
Creates a thread. |
HTL-PThreads |
|
HTL_thread_free |
Releases a thread. |
HTL-OpenMP |
|
HTL_thread_join |
Waits until a thread terminates and returns a value. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_join_np |
Waits until a thread terminates. |
HTL-OpenMP |
|
HTL_thread_exit |
Exits a thread and sets the return value. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_exit_np |
Terminates a thread. |
HTL-OpenMP |
|
HTL_thread_cancel |
Sends a cancellation instruction to a thread. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_yield |
Pauses the current thread and yields its resources to another thread. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_revive |
Wakes up a terminated thread. |
HTL-OpenMP |
|
HTL_thread_equal |
Compares whether two threads are equal. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_self |
Returns the thread handle. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_set_args |
Sets thread parameters. |
HTL-OpenMP |
|
HTL_thread_get_args |
Obtains thread parameters. |
HTL-OpenMP |
|
HTL_thread_setspecific |
Sets the value of the thread private variable. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_getspecific |
Obtains the value of the thread private variable. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_atfork |
Registers the fork handler. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_getthreadid_np |
Obtains the ID of the current thread. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_setaffinity_np |
Sets thread affinity. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_getaffinity_np |
Obtains thread affinity. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_mach_thread_np |
Obtains the ID of a specified thread. |
HTL-OpenMP, HTL-PThreads |
|
Thread attribute functions |
HTL_thread_attr_init |
Initializes the thread attribute. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_attr_destroy |
Destroys the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_attr_setstack |
Specifies memory and sets the stack size in the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_attr_getstack |
Obtains the stack size in the specified memory from the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_attr_setstacksize |
Sets the stack size in the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_attr_getstacksize |
Obtains the stack size from the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_get_attr |
Obtains the thread attribute. |
HTL-OpenMP, HTL-PThreads |
|
Mutex functions |
HTL_thread_mutex_init |
Initializes a mutex. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_mutex_destroy |
Destroys a mutex. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_mutex_lock |
Locks a mutex. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_mutex_trylock |
Attempts to lock a mutex. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_mutex_unlock |
Unlocks a mutex. |
HTL-OpenMP, HTL-PThreads |
|
Mutex attribute functions |
HTL_thread_mutexattr_init |
Initializes mutex attributes. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_mutexattr_destroy |
Destroys mutex attributes. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_mutexattr_settype |
Sets mutex attributes. |
HTL-OpenMP, HTL-PThreads |
|
Condition variable functions |
HTL_thread_cond_init |
Initializes environment variables. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_cond_destroy |
Destroys a condition variable. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_cond_wait |
Waits for the condition variable signal. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_cond_timedwait |
Waits for the condition variable signal and sets the timeout period. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_cond_signal |
Sends a condition variable signal to a waiting thread. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_cond_broadcast |
Sends a condition variable signal to all waiting threads. |
HTL-OpenMP, HTL-PThreads |
|
Barrier functions |
HTL_thread_barrier_init |
Initializes a barrier. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_barrier_reinit |
Reinitializes a barrier. |
HTL-OpenMP |
|
HTL_thread_barrier_destroy |
Destroys a barrier. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_barrier_wait |
Waits for all threads to reach the barrier. |
HTL-OpenMP, HTL-PThreads |
|
RW lock functions |
HTL_thread_rwlock_init |
Initializes the RW lock. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_rwlock_destroy |
Destroys the RW lock. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_rwlock_rdlock |
Applies a read lock to the RW lock. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_rwlock_wrlock |
Applies a write lock to the RW lock. |
HTL-OpenMP, HTL-PThreads |
|
HTL_thread_rwlock_unlock |
Releases the RW lock. |
HTL-OpenMP, HTL-PThreads |
|
Private variable functions |
HTL_thread_key_create |
Creates a thread private variable. |
HTL-OpenMP, HTL-PThreads |
HTL_thread_key_delete |
Releases a thread private variable. |
HTL-OpenMP, HTL-PThreads |
|
Extended feature functions |
HTL_create_randws_numa_resource |
Creates randws_numa resources. |
HTL-OpenMP |
HTL_destroy_randws_numa_resource |
Destroys randws_numa resources. |
HTL-OpenMP |
|
HTL_get_pool_for_thread_from_numa_pools |
Obtains thread pools in randws_numa. |
HTL-OpenMP |
|
HTL_is_cpu_in_same_numa |
Checks whether specified CPUs belong to the same NUMA node. |
HTL-OpenMP |