Section 3: library functions
pthread_mutex_consistent – make a robust mutex consistent Synopsis #include <pthread.h> int pthread_mutex_consistent(pthread_mutex_t *mutex); Compile and link with -pthread. Feature Test Macro Requirements for glibc (see feature_test_macros(7)): pthread_mutex_consistent(): _POSIX_C_SOURCE >= 200809L Description This function makes a robust mutex consistent if it is in an inconsistent state. A mutex can be left in an inconsistent state if…
pthread_kill_other_threads_np – terminate all other threads in process Synopsis #include <pthread.h> void pthread_kill_other_threads_np(void); Description pthread_kill_other_threads_np() has an effect only in the LinuxThreads threading implementation. On that implementation, calling this function causes the immediate termination of all threads in the application, except the calling thread. The cancellation state and cancellation type of the to-be-terminated threads are…
pthread_kill – send a signal to a thread Synopsis #include <signal.h> int pthread_kill(pthread_t thread, int sig); Compile and link with -pthread. Feature Test Macro Requirements for glibc (see feature_test_macros(7)): pthread_kill(): _POSIX_C_SOURCE >= 199506L || _XOPEN_SOURCE >= 500 Description The pthread_kill() function sends the signal sig to thread, a thread in the same process as the caller. The signal is…
pthread_join – join with a terminated thread Synopsis #include <pthread.h> int pthread_join(pthread_t thread, void **retval); Compile and link with -pthread. Description The pthread_join() function waits for the thread specified by thread to terminate. If that thread has already terminated, then pthread_join() returns immediately. The thread specified by thread must be joinable. If retval is not…
pthread_setschedparam, pthread_getschedparam – set/get scheduling policy and parameters of a thread Synopsis #include <pthread.h> int pthread_setschedparam(pthread_t thread, int policy, const struct sched_param *param); int pthread_getschedparam(pthread_t thread, int *policy, struct sched_param *param); Compile and link with – pthread. Description The pthread_setschedparam() function sets the scheduling policy and parameters of the thread thread. policy specifies the new…
pthread_setname_np, pthread_getname_np – set/get the name of a thread Synopsis #define _GNU_SOURCE /* See feature_test_macros(7) */ #include <pthread.h> int pthread_setname_np(pthread_t thread, const char *name); int pthread_getname_np(pthread_t thread, char *name, size_t len); Compile and link with -pthread. Description By default, all the threads created using pthread_create() inherit the program name. The pthread_setname_np() function can be used…
pthread_getcpuclockid – retrieve ID of a thread’s CPU time clock Synopsis #include <pthread.h> #include <time.h> int pthread_getcpuclockid(pthread_t thread, clockid_t *clockid); Compile and link with – pthread. Description The pthread_getcpuclockid() function obtains the ID of the CPU-time clock of the thread whose ID is given in thread, and returns it in the location pointed to by…
pthread_setconcurrency, pthread_getconcurrency – set/get the concurrency level Synopsis #include <pthread.h> int pthread_setconcurrency(int new_level); int pthread_getconcurrency(void); Compile and link with – pthread. Description The pthread_setconcurrency() function informs the implementation of the application’s desired concurrency level, specified in new_level. The implementation takes this only as a hint: POSIX.1 does not specify the level of concurrency that should…
pthread_getattr_np – get attributes of created thread Synopsis #define _GNU_SOURCE /* See feature_test_macros(7) */ #include <pthread.h> int pthread_getattr_np(pthread_t thread, pthread_attr_t *attr); Compile and link with – pthread. Description The pthread_getattr_np() function initializes the thread attributes object referred to by attr so that it contains actual attribute values describing the running thread thread. The returned attribute…
pthread_getattr_default_np, pthread_setattr_default_np, – get or set default thread-creation attributes Synopsis #define _GNU_SOURCE /* See feature_test_macros(7) */ #include <pthread.h> int pthread_getattr_default_np(pthread_attr_t *attr); int pthread_setattr_default_np(pthread_attr_t *attr); Compile and link with – pthread. Description The pthread_setattr_default_np() function sets the default attributes used for creation of a new thread—that is, the attributes that are used when pthread_create(3) is called…
pthread_setaffinity_np, pthread_getaffinity_np – set/get CPU affinity of a thread Synopsis #define _GNU_SOURCE /* See feature_test_macros(7) */ #include <pthread.h> int pthread_setaffinity_np(pthread_t thread, size_t cpusetsize, const cpu_set_t *cpuset); int pthread_getaffinity_np(pthread_t thread, size_t cpusetsize, cpu_set_t *cpuset); Compile and link with – pthread. Description The pthread_setaffinity_np() function sets the CPU affinity mask of the thread thread to the CPU…
pthread_exit – terminate calling thread Synopsis #include <pthread.h> void pthread_exit(void *retval); Compile and link with – pthread. Description The pthread_exit() function terminates the calling thread and returns a value via retval that (if the thread is joinable) is available to another thread in the same process that calls pthread_join(3). Any clean-up handlers established by pthread_cleanup_push(3)…
pthread_equal – compare thread IDs Synopsis #include <pthread.h> int pthread_equal(pthread_t t1, pthread_t t2); Compile and link with – pthread. Description The pthread_equal() function compares two thread identifiers. Return Value If the two thread IDs are equal, pthread_equal() returns a nonzero value; otherwise, it returns 0. Errors This function always succeeds. Attributes For an explanation of…
pthread_detach – detach a thread Synopsis #include <pthread.h> int pthread_detach(pthread_t thread); Compile and link with -pthread. Description The pthread_detach() function marks the thread identified by thread as detached. When a detached thread terminates, its resources are automatically released back to the system without the need for another thread to join with the terminated thread. Attempting…
pthread_create – create a new thread Synopsis #include <pthread.h> int pthread_create(pthread_t *thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg); Compile and link with -pthread. Description The pthread_create() function starts a new thread in the calling process. The new thread starts execution by invoking start_routine(); arg is passed as the sole argument of start_routine(). The…
pthread_cleanup_push_defer_np, pthread_cleanup_pop_restore_np – push and pop thread cancellation clean-up handlers while saving cancelability type Synopsis #include <pthread.h> void pthread_cleanup_push_defer_np(void (*routine)(void *), void *arg); void pthread_cleanup_pop_restore_np(int execute); Compile and link with -pthread. Feature Test Macro Requirements for glibc (see feature_test_macros(7)): pthread_cleanup_push_defer_np(), pthread_cleanup_pop_defer_np(): _GNU_SOURCE Description These functions are the same as pthread_cleanup_push(3) and pthread_cleanup_pop(3), except for the…
pthread_cleanup_push, pthread_cleanup_pop – push and pop thread cancellation clean-up handlers Synopsis #include <pthread.h> void pthread_cleanup_push(void (*routine)(void *), void *arg); void pthread_cleanup_pop(int execute); Compile and link with – pthread. Description These functions manipulate the calling thread’s stack of thread-cancellation clean-up handlers. A clean-up handler is a function that is automatically executed when a thread is canceled…
pthread_cleanup_push_defer_np, pthread_cleanup_pop_restore_np – push and pop thread cancellation clean-up handlers while saving cancelability type Synopsis #include <pthread.h> void pthread_cleanup_push_defer_np(void (*routine)(void *), void *arg); void pthread_cleanup_pop_restore_np(int execute); Compile and link with -pthread. Feature Test Macro Requirements for glibc (see feature_test_macros(7)): pthread_cleanup_push_defer_np(), pthread_cleanup_pop_defer_np(): _GNU_SOURCE Description These functions are the same as pthread_cleanup_push(3) and pthread_cleanup_pop(3), except for the…
pthread_cleanup_push, pthread_cleanup_pop – push and pop thread cancellation clean-up handlers Synopsis #include <pthread.h> void pthread_cleanup_push(void (*routine)(void *), void *arg); void pthread_cleanup_pop(int execute); Compile and link with – pthread. Description These functions manipulate the calling thread’s stack of thread-cancellation clean-up handlers. A clean-up handler is a function that is automatically executed when a thread is canceled…
pthread_cancel – send a cancellation request to a thread Synopsis #include <pthread.h> int pthread_cancel(pthread_t thread); Compile and link with – pthread. Description The pthread_cancel() function sends a cancellation request to the thread thread. Whether and when the target thread reacts to the cancellation request depends on two attributes that are under the control of that…