xref: /illumos-gate/usr/src/man/man3head/pthread.h.3head (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
1.\"
2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3.\" permission to reproduce portions of its copyrighted documentation.
4.\" Original documentation from The Open Group can be obtained online at
5.\" http://www.opengroup.org/bookstore/.
6.\"
7.\" The Institute of Electrical and Electronics Engineers and The Open
8.\" Group, have given us permission to reprint portions of their
9.\" documentation.
10.\"
11.\" In the following statement, the phrase ``this text'' refers to portions
12.\" of the system documentation.
13.\"
14.\" Portions of this text are reprinted and reproduced in electronic form
15.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16.\" Standard for Information Technology -- Portable Operating System
17.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20.\" between these versions and the original IEEE and The Open Group
21.\" Standard, the original IEEE and The Open Group Standard is the referee
22.\" document.  The original Standard can be obtained online at
23.\" http://www.opengroup.org/unix/online.html.
24.\"
25.\" This notice shall appear on any product containing this material.
26.\"
27.\" The contents of this file are subject to the terms of the
28.\" Common Development and Distribution License (the "License").
29.\" You may not use this file except in compliance with the License.
30.\"
31.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32.\" or http://www.opensolaris.org/os/licensing.
33.\" See the License for the specific language governing permissions
34.\" and limitations under the License.
35.\"
36.\" When distributing Covered Code, include this CDDL HEADER in each
37.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38.\" If applicable, add the following below this CDDL HEADER, with the
39.\" fields enclosed by brackets "[]" replaced with your own identifying
40.\" information: Portions Copyright [yyyy] [name of copyright owner]
41.\"
42.\"
43.\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
44.\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
45.\" Copyright 2022 OmniOS Community Edition (OmniOSce) Association.
46.\"
47.Dd February 19, 2022
48.Dt PTHREAD.H 3HEAD
49.Os
50.Sh NAME
51.Nm pthread.h ,
52.Nm pthread
53.Nd threads
54.Sh SYNOPSIS
55.In pthread.h
56.Sh DESCRIPTION
57The
58.In pthread.h
59header defines the following symbols:
60.Pp
61.Bl -inset -offset Ds -compact
62.It Dv PTHREAD_BARRIER_SERIAL_THREAD
63.It Dv PTHREAD_CANCEL_ASYNCHRONOUS
64.It Dv PTHREAD_CANCEL_ENABLE
65.It Dv PTHREAD_CANCEL_DEFERRED
66.It Dv PTHREAD_CANCEL_DISABLE
67.It Dv PTHREAD_CANCELED
68.It Dv PTHREAD_COND_INITIALIZER
69.It Dv PTHREAD_CREATE_DETACHED
70.It Dv PTHREAD_CREATE_JOINABLE
71.It Dv PTHREAD_EXPLICIT_SCHED
72.It Dv PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP
73.It Dv PTHREAD_INHERIT_SCHED
74.It Dv PTHREAD_MUTEX_DEFAULT
75.It Dv PTHREAD_MUTEX_ERRORCHECK
76.It Dv PTHREAD_MUTEX_INITIALIZER
77.It Dv PTHREAD_MUTEX_NORMAL
78.It Dv PTHREAD_MUTEX_RECURSIVE
79.It Dv PTHREAD_MUTEX_ROBUST
80.It Dv PTHREAD_MUTEX_STALLED
81.It Dv PTHREAD_ONCE_INIT
82.It Dv PTHREAD_PRIO_INHERIT
83.It Dv PTHREAD_PRIO_NONE
84.It Dv PTHREAD_PRIO_PROTECT
85.It Dv PTHREAD_PROCESS_SHARED
86.It Dv PTHREAD_PROCESS_PRIVATE
87.It Dv PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
88.It Dv PTHREAD_RWLOCK_INITIALIZER
89.It Dv PTHREAD_SCOPE_PROCESS
90.It Dv PTHREAD_SCOPE_SYSTEM
91.El
92.Pp
93The types listed below are defined as described in
94.In sys/types.h .
95See
96.Xr types.h 3HEAD .
97.Pp
98.Bl -inset -offset Ds -compact
99.It Vt pthread_attr_t
100.It Vt pthread_barrier_t
101.It Vt pthread_barrierattr_t
102.It Vt pthread_cond_t
103.It Vt pthread_condattr_t
104.It Vt pthread_key_t
105.It Vt pthread_mutex_t
106.It Vt pthread_mutexattr_t
107.It Vt pthread_once_t
108.It Vt pthread_rwlock_t
109.It Vt pthread_rwlockattr_t
110.It Vt pthread_spinlock_t
111.It Vt pthread_t
112.El
113.Sh INTERFACE STABILITY
114.Sy Committed
115.Sh SEE ALSO
116.Xr pthread_attr_getguardsize 3C ,
117.Xr pthread_attr_init 3C ,
118.Xr pthread_attr_setscope 3C ,
119.Xr pthread_cancel 3C ,
120.Xr pthread_cleanup_pop 3C ,
121.Xr pthread_cond_init 3C ,
122.Xr pthread_cond_signal 3C ,
123.Xr pthread_cond_wait 3C ,
124.Xr pthread_condattr_init 3C ,
125.Xr pthread_create 3C ,
126.Xr pthread_detach 3C ,
127.Xr pthread_equal 3C ,
128.Xr pthread_exit 3C ,
129.Xr pthread_getconcurrency 3C ,
130.Xr pthread_getschedparam 3C ,
131.Xr pthread_join 3C ,
132.Xr pthread_key_create 3C ,
133.Xr pthread_key_delete 3C ,
134.Xr pthread_mutex_consistent 3C ,
135.Xr pthread_mutex_init 3C ,
136.Xr pthread_mutex_lock 3C ,
137.Xr pthread_mutex_setprioceiling 3C ,
138.Xr pthread_mutexattr_getprotocol 3C ,
139.Xr pthread_mutexattr_getrobust 3C ,
140.Xr pthread_mutexattr_gettype 3C ,
141.Xr pthread_mutexattr_init 3C ,
142.Xr pthread_once 3C ,
143.Xr pthread_rwlock_init 3C ,
144.Xr pthread_rwlock_rdlock 3C ,
145.Xr pthread_rwlock_unlock 3C ,
146.Xr pthread_rwlock_wrlock 3C ,
147.Xr pthread_rwlockattr_getpshared 3C ,
148.Xr pthread_rwlockattr_init 3C ,
149.Xr pthread_self 3C ,
150.Xr pthread_setcancelstate 3C ,
151.Xr pthread_setspecific 3C ,
152.Xr sched.h 3HEAD ,
153.Xr time.h 3HEAD ,
154.Xr types.h 3HEAD ,
155.Xr attributes 7
156