pthread.h(0P)
π pthread.h(0P) β POSIX Programmer's Manual π
okay bestie, welcome to the POSIX Programmer's Manual glow-up of pthread.h(0P). this is part 1 of 2, and it's giving threads, threads, threads β¨
π«§ PROLOG π«§
This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for the deets on Linux behavior), or the interface may not be implemented on Linux. no cap, so check your local Linux tea before you spiral. π
πΈ NAME πΈ
pthread.h β threads. it's literally the header for thread vibes. π§΅β¨
β¨ SYNOPSIS β¨
#include <pthread.h>
π DESCRIPTION π
The <pthread.h> header shall define the following symbolic constants:
PTHREAD_BARRIER_SERIAL_THREADPTHREAD_CANCEL_ASYNCHRONOUSPTHREAD_CANCEL_ENABLEPTHREAD_CANCEL_DEFERREDPTHREAD_CANCEL_DISABLEPTHREAD_CANCELEDPTHREAD_CREATE_DETACHEDPTHREAD_CREATE_JOINABLEPTHREAD_EXPLICIT_SCHEDPTHREAD_INHERIT_SCHEDPTHREAD_MUTEX_DEFAULTPTHREAD_MUTEX_ERRORCHECKPTHREAD_MUTEX_NORMALPTHREAD_MUTEX_RECURSIVEPTHREAD_MUTEX_ROBUSTPTHREAD_MUTEX_STALLEDPTHREAD_ONCE_INITPTHREAD_PRIO_INHERITPTHREAD_PRIO_NONEPTHREAD_PRIO_PROTECTPTHREAD_PROCESS_SHAREDPTHREAD_PROCESS_PRIVATEPTHREAD_SCOPE_PROCESSPTHREAD_SCOPE_SYSTEM
The <pthread.h> header shall define the following compile-time constant expressions valid as initializers for the following types:
PTHREAD_COND_INITIALIZERβ initializer for typepthread_cond_tPTHREAD_MUTEX_INITIALIZERβ initializer for typepthread_mutex_tPTHREAD_RWLOCK_INITIALIZERβ initializer for typepthread_rwlock_t
The <pthread.h> header shall define the pthread_attr_t, pthread_barrier_t, pthread_barrierattr_t, pthread_cond_t, pthread_condattr_t, pthread_key_t, pthread_mutex_t, pthread_mutexattr_t, pthread_once_t, pthread_rwlock_t, pthread_rwlockattr_t, pthread_spinlock_t, and pthread_t types as described in <sys/types.h>. all the type besties, periodt. π
The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.
int pthread_atfork(void (*)(void), void (*)(void),
void(*)(void));
int pthread_attr_destroy(pthread_attr_t *);
int pthread_attr_getdetachstate(const pthread_attr_t *, int *);
int pthread_attr_getguardsize(const pthread_attr_t *restrict,
size_t *restrict);
int pthread_attr_getinheritsched(const pthread_attr_t *restrict,
int *restrict);
int pthread_attr_getschedparam(const pthread_attr_t *restrict,
struct sched_param *restrict);
int pthread_attr_getschedpolicy(const pthread_attr_t *restrict,
int *restrict);
int pthread_attr_getscope(const pthread_attr_t *restrict,
int *restrict);
int pthread_attr_getstack(const pthread_attr_t *restrict,
void **restrict, size_t *restrict);
int pthread_attr_getstacksize(const pthread_attr_t *restrict,
size_t *restrict);
int pthread_attr_init(pthread_attr_t *);
int pthread_attr_setdetachstate(pthread_attr_t *, int);
int pthread_attr_setguardsize(pthread_attr_t *, size_t);
int pthread_attr_setinheritsched(pthread_attr_t *, int);
int pthread_attr_setschedparam(pthread_attr_t *restrict,
const struct sched_param *restrict);
int pthread_attr_setschedpolicy(pthread_attr_t *, int);
int pthread_attr_setscope(pthread_attr_t *, int);
int pthread_attr_setstack(pthread_attr_t *, void *, size_t);
int pthread_attr_setstacksize(pthread_attr_t *, size_t);
int pthread_barrier_destroy(pthread_barrier_t *);
int pthread_barrier_init(pthread_barrier_t *restrict,
const pthread_barrierattr_t *restrict, unsigned);
int pthread_barrier_wait(pthread_barrier_t *);
int pthread_barrierattr_destroy(pthread_barrierattr_t *);
int pthread_barrierattr_getpshared(
const pthread_barrierattr_t *restrict, int *restrict);
int pthread_barrierattr_init(pthread_barrierattr_t *);
int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
int pthread_cancel(pthread_t);
int pthread_cond_broadcast(pthread_cond_t *);
int pthread_cond_destroy(pthread_cond_t *);
int pthread_cond_init(pthread_cond_t *restrict,
const pthread_condattr_t *restrict);
int pthread_cond_signal(pthread_cond_t *);
int pthread_cond_timedwait(pthread_cond_t *restrict,
pthread_mutex_t *restrict, const struct timespec *restrict);
int pthread_cond_wait(pthread_cond_t *restrict,
pthread_mutex_t *restrict);
int pthread_condattr_destroy(pthread_condattr_t *);
int pthread_condattr_getclock(const pthread_condattr_t *restrict,
clockid_t *restrict);
int pthread_condattr_getpshared(const pthread_condattr_t *restrict,
int *restrict);
int pthread_condattr_init(pthread_condattr_t *);
int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
int pthread_condattr_setpshared(pthread_condattr_t *, int);
int pthread_create(pthread_t *restrict, const pthread_attr_t *restrict,
void *(*)(void*), void *restrict);
int pthread_detach(pthread_t);
int pthread_equal(pthread_t, pthread_t);
void pthread_exit(void *);
int pthread_getconcurrency(void);
int pthread_getcpuclockid(pthread_t, clockid_t *);
int pthread_getschedparam(pthread_t, int *restrict,
struct sched_param *restrict);
void *pthread_getspecific(pthread_key_t);
int pthread_join(pthread_t, void **);
int pthread_key_create(pthread_key_t *, void (*)(void*));
int pthread_key_delete(pthread_key_t);
int pthread_mutex_consistent(pthread_mutex_t *);
int pthread_mutex_destroy(pthread_mutex_t *);
int pthread_mutex_getprioceiling(const pthread_mutex_t *restrict,
int *restrict);
int pthread_mutex_init(pthread_mutex_t *restrict,
const pthread_mutexattr_t *restrict);
int pthread_mutex_lock(pthread_mutex_t *);
int pthread_mutex_setprioceiling(pthread_mutex_t *restrict, int,
int *restrict);
int pthread_mutex_timedlock(pthread_mutex_t *restrict,
const struct timespec *restrict);
int pthread_mutex_trylock(pthread_mutex_t *);
int pthread_mutex_unlock(pthread_mutex_t *);
int pthread_mutexattr_destroy(pthread_mutexattr_t *);
int pthread_mutexattr_getprioceiling(
const pthread_mutexattr_t *restrict, int *restrict);
int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *restrict,
int *restrict);
int pthread_mutexattr_getpshared(const pthread_mutexattr_t *restrict,
int *restrict);
int pthread_mutexattr_getrobust(const pthread_mutexattr_t *restrict,
int *restrict);
int pthread_mutexattr_gettype(const pthread_mutexattr_t *restrict,
int *restrict);
int pthread_mutexattr_init(pthread_mutexattr_t *);
int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int);
int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
int pthread_once(pthread_once_t *, void (*)(void));
int pthread_rwlock_destroy(pthread_rwlock_t *);
int pthread_rwlock_init(pthread_rwlock_t *restrict,
const pthread_rwlockattr_t *restrict);
int pthread_rwlock_rdlock(pthread_rwlock_t *);
int pthread_rwlock_timedrdlock(pthread_rwlock_t *restrict,
const struct timespec *restrict);
int pthread_rwlock_timedwrlock(pthread_rwlock_t *restrict,
const struct timespec *restrict);
int pthread_rwlock_tryrdlock(pthread_rwlock_t *);
int pthread_rwlock_trywrlock(pthread_rwlock_t *);
int pthread_rwlock_unlock(pthread_rwlock_t *);
int pthread_rwlock_wrlock(pthread_rwlock_t *);
int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
int pthread_rwlockattr_getpshared(
const pthread_rwlockattr_t *restrict, int *restrict);
int pthread_rwlockattr_init(pthread_rwlockattr_t *);
int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
pthread_t
pthread_self(void);
int pthread_setcancelstate(int, int *);
int pthread_setcanceltype(int, int *);
int pthread_setconcurrency(int);
int pthread_setschedparam(pthread_t, int,
const struct sched_param *);
int pthread_setschedprio(pthread_t, int);
int pthread_setspecific(pthread_key_t, const void *);
int pthread_spin_destroy(pthread_spinlock_t *);
int pthread_spin_init(pthread_spinlock_t *, int);
int pthread_spin_lock(pthread_spinlock_t *);
int pthread_spin_trylock(pthread_spinlock_t *);
int pthread_spin_unlock(pthread_spinlock_t *);
void pthread_testcancel(void);
The following may be declared as functions, or defined as macros, or both. If functions are declared, function prototypes shall be provided.
pthread_cleanup_pop() pthread_cleanup_push()
Inclusion of the <pthread.h> header shall make symbols defined in the headers <sched.h> and <time.h> visible. π
The following sections are informative.
π APPLICATION USAGE π
None. fr fr, nothing here bestie. π«Ά
π RATIONALE π
None.
β FUTURE DIRECTIONS β
None.
π SEE ALSO π
okay bestie, here's the little fam of headers that hang out with <pthread.h> π«Ά
<sched.h><sys_types.h><time.h>
and then... the β¨extended universeβ¨. the System Interfaces volume of POSIX.1β2017 has a whole roster and we're listing every single one, no skipping, because they're all icons in their own right:
pthread_atfork()pthread_attr_destroy()pthread_attr_getdetachstate()pthread_attr_getguardsize()pthread_attr_getinheritsched()pthread_attr_getschedparam()pthread_attr_getschedpolicy()pthread_attr_getscope()pthread_attr_getstack()pthread_attr_getstacksize()pthread_barrier_destroy()pthread_barrier_wait()pthread_barrierattr_destroy()pthread_barrierattr_getpshared()pthread_cancel()pthread_cleanup_pop()pthread_cond_broadcast()pthread_cond_destroy()pthread_cond_timedwait()pthread_condattr_destroy()pthread_condattr_getclock()pthread_condattr_getpshared()pthread_create()pthread_detach()pthread_equal()pthread_exit()pthread_getconcurrency()pthread_getcpuclockid()pthread_getschedparam()pthread_getspecific()pthread_join()pthread_key_create()pthread_key_delete()pthread_mutex_consistent()pthread_mutex_destroy()pthread_mutex_getprioceiling()pthread_mutex_lock()pthread_mutex_timedlock()pthread_mutexattr_destroy()pthread_mutexattr_getprioceiling()pthread_mutexattr_getprotocol()pthread_mutexattr_getpshared()pthread_mutexattr_getrobust()pthread_mutexattr_gettype()pthread_once()pthread_rwlock_destroy()pthread_rwlock_rdlock()pthread_rwlock_timedrdlock()pthread_rwlock_timedwrlock()pthread_rwlock_trywrlock()pthread_rwlock_unlock()pthread_rwlockattr_destroy()pthread_rwlockattr_getpshared()pthread_self()pthread_setcancelstate()pthread_setschedprio()pthread_spin_destroy()pthread_spin_lock()pthread_spin_unlock()
like, that's the whole squad. every single one. go read them, they're all serving π
π COPYRIGHT π
okay so legal stuff, but make it cute:
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .
ngl the second one is important bestie β if this page and the actual standard ever beef, the standard wins, periodt. this is just the vibes version, not the source of truth π«‘
Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .
so if you spot a typo, don't blame the IEEE girlies, blame the conversion process π and go tell the kernel doc people at that link π
and that's a wrap on pthread.h(0P) bestie!! π this whole thing came to you from IEEE/The Open Group, dated 2017, and you just read the entire page top to bottom, which is honestly main character energy π go forth and thread responsibly, mwah πβ¨π¦
π¦ where this page comes from
- alpine 3.22: man-pages-posix 2017a-r0 Β· custom
- alpine 3.23: man-pages-posix 2017a-r0 Β· custom
- alpine 3.24: man-pages-posix 2017a-r0 Β· custom
- arch rolling: man-pages 6.19-1
- arch rolling: man-pages 6.20-1 Β· BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
- nixpkgs unstable: man-pages-posix 2017a
- opensuse-leap 16.0: man-pages-posix 2017a-160000.4.1 Β· SUSE-IEEE
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms