pthread.h.0p (12442B)
- '\" et
- .TH pthread.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
- .\"
- .SH 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 details of Linux behavior),
- or the interface may not be implemented on Linux.
- .\"
- .SH NAME
- pthread.h
- \(em threads
- .SH SYNOPSIS
- .LP
- .nf
- #include <pthread.h>
- .fi
- .SH DESCRIPTION
- The
- .IR <pthread.h>
- header shall define the following symbolic constants:
- .P
- .nf
- PTHREAD_BARRIER_SERIAL_THREAD
- PTHREAD_CANCEL_ASYNCHRONOUS
- PTHREAD_CANCEL_ENABLE
- PTHREAD_CANCEL_DEFERRED
- PTHREAD_CANCEL_DISABLE
- PTHREAD_CANCELED
- PTHREAD_CREATE_DETACHED
- PTHREAD_CREATE_JOINABLE
- PTHREAD_EXPLICIT_SCHED
- PTHREAD_INHERIT_SCHED
- PTHREAD_MUTEX_DEFAULT
- PTHREAD_MUTEX_ERRORCHECK
- PTHREAD_MUTEX_NORMAL
- PTHREAD_MUTEX_RECURSIVE
- PTHREAD_MUTEX_ROBUST
- PTHREAD_MUTEX_STALLED
- PTHREAD_ONCE_INIT
- PTHREAD_PRIO_INHERIT
- PTHREAD_PRIO_NONE
- PTHREAD_PRIO_PROTECT
- PTHREAD_PROCESS_SHARED
- PTHREAD_PROCESS_PRIVATE
- PTHREAD_SCOPE_PROCESS
- PTHREAD_SCOPE_SYSTEM
- .fi
- .P
- The
- .IR <pthread.h>
- header shall define the following compile-time constant
- expressions valid as initializers for the following types:
- .TS
- tab(!) center box;
- cB | cB
- l | lB.
- Name!Initializer for Type
- _
- PTHREAD_COND_INITIALIZER!pthread_cond_t
- PTHREAD_MUTEX_INITIALIZER!pthread_mutex_t
- PTHREAD_RWLOCK_INITIALIZER!pthread_rwlock_t
- .TE
- .P
- The
- .IR <pthread.h>
- header shall define the
- .BR pthread_attr_t ,
- .BR pthread_barrier_t ,
- .BR pthread_barrierattr_t ,
- .BR pthread_cond_t ,
- .BR pthread_condattr_t ,
- .BR pthread_key_t ,
- .BR pthread_mutex_t ,
- .BR pthread_mutexattr_t ,
- .BR pthread_once_t ,
- .BR pthread_rwlock_t ,
- .BR pthread_rwlockattr_t ,
- .BR pthread_spinlock_t ,
- and
- .BR pthread_t
- types as described in
- .IR <sys/types.h> .
- .P
- The following shall be declared as functions and may also be defined
- as macros. Function prototypes shall be provided.
- .sp
- .RS 4
- .nf
- 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);
- .fi
- .P
- .RE
- .P
- The following may be declared as functions, or defined as macros, or both.
- If functions are declared, function prototypes shall be provided.
- .sp
- .RS
- \fIpthread_cleanup_pop\fR()
- \fIpthread_cleanup_push\fR()
- .RE
- .P
- Inclusion of the
- .IR <pthread.h>
- header shall make symbols defined in the headers
- .IR <sched.h>
- and
- .IR <time.h>
- visible.
- .LP
- .IR "The following sections are informative."
- .SH "APPLICATION USAGE"
- None.
- .SH RATIONALE
- None.
- .SH "FUTURE DIRECTIONS"
- None.
- .SH "SEE ALSO"
- .IR "\fB<sched.h>\fP",
- .IR "\fB<sys_types.h>\fP",
- .IR "\fB<time.h>\fP"
- .P
- .ad l
- The System Interfaces volume of POSIX.1\(hy2017,
- .IR "\fIpthread_atfork\fR\^(\|)",
- .IR "\fIpthread_attr_destroy\fR\^(\|)",
- .IR "\fIpthread_attr_getdetachstate\fR\^(\|)",
- .IR "\fIpthread_attr_getguardsize\fR\^(\|)",
- .IR "\fIpthread_attr_getinheritsched\fR\^(\|)",
- .IR "\fIpthread_attr_getschedparam\fR\^(\|)",
- .IR "\fIpthread_attr_getschedpolicy\fR\^(\|)",
- .IR "\fIpthread_attr_getscope\fR\^(\|)",
- .IR "\fIpthread_attr_getstack\fR\^(\|)",
- .IR "\fIpthread_attr_getstacksize\fR\^(\|)",
- .IR "\fIpthread_barrier_destroy\fR\^(\|)",
- .IR "\fIpthread_barrier_wait\fR\^(\|)",
- .IR "\fIpthread_barrierattr_destroy\fR\^(\|)",
- .IR "\fIpthread_barrierattr_getpshared\fR\^(\|)",
- .IR "\fIpthread_cancel\fR\^(\|)",
- .IR "\fIpthread_cleanup_pop\fR\^(\|)",
- .IR "\fIpthread_cond_broadcast\fR\^(\|)",
- .IR "\fIpthread_cond_destroy\fR\^(\|)",
- .IR "\fIpthread_cond_timedwait\fR\^(\|)",
- .IR "\fIpthread_condattr_destroy\fR\^(\|)",
- .IR "\fIpthread_condattr_getclock\fR\^(\|)",
- .IR "\fIpthread_condattr_getpshared\fR\^(\|)",
- .IR "\fIpthread_create\fR\^(\|)",
- .IR "\fIpthread_detach\fR\^(\|)",
- .IR "\fIpthread_equal\fR\^(\|)",
- .IR "\fIpthread_exit\fR\^(\|)",
- .IR "\fIpthread_getconcurrency\fR\^(\|)",
- .IR "\fIpthread_getcpuclockid\fR\^(\|)",
- .IR "\fIpthread_getschedparam\fR\^(\|)",
- .IR "\fIpthread_getspecific\fR\^(\|)",
- .IR "\fIpthread_join\fR\^(\|)",
- .IR "\fIpthread_key_create\fR\^(\|)",
- .IR "\fIpthread_key_delete\fR\^(\|)",
- .IR "\fIpthread_mutex_consistent\fR\^(\|)",
- .IR "\fIpthread_mutex_destroy\fR\^(\|)",
- .IR "\fIpthread_mutex_getprioceiling\fR\^(\|)",
- .IR "\fIpthread_mutex_lock\fR\^(\|)",
- .IR "\fIpthread_mutex_timedlock\fR\^(\|)",
- .IR "\fIpthread_mutexattr_destroy\fR\^(\|)",
- .IR "\fIpthread_mutexattr_getprioceiling\fR\^(\|)",
- .IR "\fIpthread_mutexattr_getprotocol\fR\^(\|)",
- .IR "\fIpthread_mutexattr_getpshared\fR\^(\|)",
- .IR "\fIpthread_mutexattr_getrobust\fR\^(\|)",
- .IR "\fIpthread_mutexattr_gettype\fR\^(\|)",
- .IR "\fIpthread_once\fR\^(\|)",
- .IR "\fIpthread_rwlock_destroy\fR\^(\|)",
- .IR "\fIpthread_rwlock_rdlock\fR\^(\|)",
- .IR "\fIpthread_rwlock_timedrdlock\fR\^(\|)",
- .IR "\fIpthread_rwlock_timedwrlock\fR\^(\|)",
- .IR "\fIpthread_rwlock_trywrlock\fR\^(\|)",
- .IR "\fIpthread_rwlock_unlock\fR\^(\|)",
- .IR "\fIpthread_rwlockattr_destroy\fR\^(\|)",
- .IR "\fIpthread_rwlockattr_getpshared\fR\^(\|)",
- .IR "\fIpthread_self\fR\^(\|)",
- .IR "\fIpthread_setcancelstate\fR\^(\|)",
- .IR "\fIpthread_setschedprio\fR\^(\|)",
- .IR "\fIpthread_spin_destroy\fR\^(\|)",
- .IR "\fIpthread_spin_lock\fR\^(\|)",
- .IR "\fIpthread_spin_unlock\fR\^(\|)"
- .ad b
- .\"
- .SH COPYRIGHT
- 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 .
- .PP
- 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 .