| @@ -1,153 +1,160 @@ | | | @@ -1,153 +1,160 @@ |
1 | .\" $NetBSD: pthread.3,v 1.8 2008/05/09 08:31:13 wiz Exp $ | | 1 | .\" $NetBSD: pthread.3,v 1.9 2008/10/08 10:11:11 ad Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 2003, 2007 The NetBSD Foundation, Inc. | | 3 | .\" Copyright (c) 2003, 2007 The NetBSD Foundation, Inc. |
4 | .\" All rights reserved. | | 4 | .\" All rights reserved. |
5 | .\" | | 5 | .\" |
6 | .\" This code is derived from software contributed to The NetBSD Foundation | | 6 | .\" This code is derived from software contributed to The NetBSD Foundation |
7 | .\" by Hubert Feyrer <hubertf@NetBSD.org> and Thomas Klausner <wiz@NetBSD.org>. | | 7 | .\" by Hubert Feyrer <hubertf@NetBSD.org> and Thomas Klausner <wiz@NetBSD.org>. |
8 | .\" | | 8 | .\" |
9 | .\" Redistribution and use in source and binary forms, with or without | | 9 | .\" Redistribution and use in source and binary forms, with or without |
10 | .\" modification, are permitted provided that the following conditions | | 10 | .\" modification, are permitted provided that the following conditions |
11 | .\" are met: | | 11 | .\" are met: |
12 | .\" 1. Redistributions of source code must retain the above copyright | | 12 | .\" 1. Redistributions of source code must retain the above copyright |
13 | .\" notice, this list of conditions and the following disclaimer. | | 13 | .\" notice, this list of conditions and the following disclaimer. |
14 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 14 | .\" 2. Redistributions in binary form must reproduce the above copyright |
15 | .\" notice, this list of conditions and the following disclaimer in the | | 15 | .\" notice, this list of conditions and the following disclaimer in the |
16 | .\" documentation and/or other materials provided with the distribution. | | 16 | .\" documentation and/or other materials provided with the distribution. |
17 | .\" | | 17 | .\" |
18 | .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS | | 18 | .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |
19 | .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED | | 19 | .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
20 | .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | | 20 | .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
21 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS | | 21 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |
22 | .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | | 22 | .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
23 | .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | | 23 | .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
24 | .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | | 24 | .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
25 | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | | 25 | .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
26 | .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | | 26 | .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
27 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | | 27 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
28 | .\" POSSIBILITY OF SUCH DAMAGE. | | 28 | .\" POSSIBILITY OF SUCH DAMAGE. |
29 | .\" | | 29 | .\" |
30 | .Dd November 19, 2007 | | 30 | .Dd October 8, 2008 |
31 | .Dt PTHREAD 3 | | 31 | .Dt PTHREAD 3 |
32 | .Os | | 32 | .Os |
33 | .Sh NAME | | 33 | .Sh NAME |
34 | .Nm pthread | | 34 | .Nm pthread |
35 | .Nd POSIX Threads Library | | 35 | .Nd POSIX Threads Library |
36 | .Sh LIBRARY | | 36 | .Sh LIBRARY |
37 | .Lb libpthread | | 37 | .Lb libpthread |
38 | .Sh SYNOPSIS | | 38 | .Sh SYNOPSIS |
39 | .In pthread.h | | 39 | .In pthread.h |
40 | .Pp | | 40 | .Pp |
41 | .Nm cc | | 41 | .Nm cc |
42 | .Op Ar flags | | 42 | .Op Ar flags |
43 | .Ar files | | 43 | .Ar files |
44 | .Fl lpthread | | 44 | .Fl lpthread |
45 | .Op Ar libraries | | 45 | .Op Ar libraries |
46 | .Sh DESCRIPTION | | 46 | .Sh DESCRIPTION |
47 | The | | 47 | The |
48 | .Nm | | 48 | .Nm |
49 | library provides an implementation of the standard | | 49 | library provides an implementation of the standard |
50 | .Tn POSIX | | 50 | .Tn POSIX |
51 | threads framework. | | 51 | threads framework. |
52 | .Pp | | 52 | .Pp |
53 | Note that the system private thread interfaces upon which the | | 53 | Note that the system private thread interfaces upon which the |
54 | .Nm | | 54 | .Nm |
55 | library is built are subject to change without notice. | | 55 | library is built are subject to change without notice. |
56 | In order to remain compatible with future | | 56 | In order to remain compatible with future |
57 | .Nx | | 57 | .Nx |
58 | releases, programs must be linked against the dynamic version of the | | 58 | releases, programs must be linked against the dynamic version of the |
59 | thread library. | | 59 | thread library. |
60 | Statically linked programs using the | | 60 | Statically linked programs using the |
61 | .Tn POSIX | | 61 | .Tn POSIX |
62 | threads framework may not work when run on a future version of the system. | | 62 | threads framework may not work when run on a future version of the system. |
63 | .Sh ENVIRONMENT | | 63 | .Sh ENVIRONMENT |
64 | .Bl -tag -width PTHREAD_DEBUGCOUNTERSXX | | 64 | .Bl -tag -width PTHREAD_DEBUGCOUNTERSXX |
65 | .It Ev PTHREAD_CONCURRENCY | | 65 | .It Ev PTHREAD_CONCURRENCY |
66 | The current version of the system does not inspect this variable. | | 66 | The current version of the system does not inspect this variable. |
67 | It is reserved for use by the | | 67 | It is reserved for use by the |
68 | .Nm | | 68 | .Nm |
69 | library. | | 69 | library. |
70 | .It Ev PTHREAD_DIAGASSERT | | 70 | .It Ev PTHREAD_DIAGASSERT |
71 | Possible values are any combinations of: | | 71 | Possible values are any combinations of: |
| | | 72 | .Pp |
72 | .Bl -tag -width ignoreXX -offset indent -compact | | 73 | .Bl -tag -width ignoreXX -offset indent -compact |
73 | .It Sy A | | 74 | .It Sy A |
74 | Ignore errors. | | 75 | Report errors to application by error return, but do not abort. |
75 | .It Sy a | | 76 | .It Sy a |
76 | Abort on errors, creating a core dump for further debugging. | | 77 | Abort on errors, creating a core dump for further debugging. |
77 | .It Sy E | | 78 | .It Sy E |
78 | Do not log errors to stdout. | | 79 | Do not log errors to stdout. |
79 | .It Sy e | | 80 | .It Sy e |
80 | Log errors to stdout. | | 81 | Log errors to stdout. |
81 | .It Sy L | | 82 | .It Sy L |
82 | Do not log errors via | | 83 | Do not log errors via |
83 | .Xr syslogd 8 . | | 84 | .Xr syslogd 8 . |
84 | .It Sy l | | 85 | .It Sy l |
85 | Log errors via | | 86 | Log errors via |
86 | .Xr syslogd 8 . | | 87 | .Xr syslogd 8 . |
87 | .El | | 88 | .El |
| | | 89 | .Pp |
| | | 90 | If not set in the environment, the |
| | | 91 | .Nm |
| | | 92 | library behaves as if |
| | | 93 | .Sy AEL |
| | | 94 | has been specified. |
88 | .It Ev PTHREAD_RRTIME | | 95 | .It Ev PTHREAD_RRTIME |
89 | The current version of the system does not inspect this variable. | | 96 | The current version of the system does not inspect this variable. |
90 | It is reserved for use by the | | 97 | It is reserved for use by the |
91 | .Nm | | 98 | .Nm |
92 | library. | | 99 | library. |
93 | .It Ev PTHREAD_STACKSIZE | | 100 | .It Ev PTHREAD_STACKSIZE |
94 | Integer value giving the stack size in kilobytes. | | 101 | Integer value giving the stack size in kilobytes. |
95 | This allows to set a smaller stack size than the default stack size. | | 102 | This allows to set a smaller stack size than the default stack size. |
96 | The default stack size is the current limit on the stack size as | | 103 | The default stack size is the current limit on the stack size as |
97 | set with the shell's command to change limits | | 104 | set with the shell's command to change limits |
98 | .Ic ( limit | | 105 | .Ic ( limit |
99 | for | | 106 | for |
100 | .Xr csh 1 , | | 107 | .Xr csh 1 , |
101 | or | | 108 | or |
102 | .Ic ulimit | | 109 | .Ic ulimit |
103 | for | | 110 | for |
104 | .Xr sh 1 ) . | | 111 | .Xr sh 1 ) . |
105 | .El | | 112 | .El |
106 | .Sh SEE ALSO | | 113 | .Sh SEE ALSO |
107 | .Xr pthread_attr 3 , | | 114 | .Xr pthread_attr 3 , |
108 | .Xr pthread_barrier_destroy 3 , | | 115 | .Xr pthread_barrier_destroy 3 , |
109 | .Xr pthread_barrier_init 3 , | | 116 | .Xr pthread_barrier_init 3 , |
110 | .Xr pthread_barrier_wait 3 , | | 117 | .Xr pthread_barrier_wait 3 , |
111 | .Xr pthread_barrierattr 3 , | | 118 | .Xr pthread_barrierattr 3 , |
112 | .Xr pthread_cancel 3 , | | 119 | .Xr pthread_cancel 3 , |
113 | .Xr pthread_cleanup_push 3 , | | 120 | .Xr pthread_cleanup_push 3 , |
114 | .Xr pthread_cond_broadcast 3 , | | 121 | .Xr pthread_cond_broadcast 3 , |
115 | .Xr pthread_cond_destroy 3 , | | 122 | .Xr pthread_cond_destroy 3 , |
116 | .Xr pthread_cond_init 3 , | | 123 | .Xr pthread_cond_init 3 , |
117 | .Xr pthread_cond_wait 3 , | | 124 | .Xr pthread_cond_wait 3 , |
118 | .Xr pthread_condattr 3 , | | 125 | .Xr pthread_condattr 3 , |
119 | .Xr pthread_create 3 , | | 126 | .Xr pthread_create 3 , |
120 | .Xr pthread_detach 3 , | | 127 | .Xr pthread_detach 3 , |
121 | .Xr pthread_equal 3 , | | 128 | .Xr pthread_equal 3 , |
122 | .Xr pthread_exit 3 , | | 129 | .Xr pthread_exit 3 , |
123 | .Xr pthread_getspecific 3 , | | 130 | .Xr pthread_getspecific 3 , |
124 | .Xr pthread_join 3 , | | 131 | .Xr pthread_join 3 , |
125 | .Xr pthread_key_create 3 , | | 132 | .Xr pthread_key_create 3 , |
126 | .Xr pthread_key_delete 3 , | | 133 | .Xr pthread_key_delete 3 , |
127 | .Xr pthread_kill 3 , | | 134 | .Xr pthread_kill 3 , |
128 | .Xr pthread_mutex_destroy 3 , | | 135 | .Xr pthread_mutex_destroy 3 , |
129 | .Xr pthread_mutex_init 3 , | | 136 | .Xr pthread_mutex_init 3 , |
130 | .Xr pthread_mutex_lock 3 , | | 137 | .Xr pthread_mutex_lock 3 , |
131 | .Xr pthread_mutex_unlock 3 , | | 138 | .Xr pthread_mutex_unlock 3 , |
132 | .Xr pthread_mutexattr 3 , | | 139 | .Xr pthread_mutexattr 3 , |
133 | .Xr pthread_once 3 , | | 140 | .Xr pthread_once 3 , |
134 | .Xr pthread_rwlock_destroy 3 , | | 141 | .Xr pthread_rwlock_destroy 3 , |
135 | .Xr pthread_rwlock_init 3 , | | 142 | .Xr pthread_rwlock_init 3 , |
136 | .Xr pthread_rwlock_rdlock 3 , | | 143 | .Xr pthread_rwlock_rdlock 3 , |
137 | .Xr pthread_rwlock_unlock 3 , | | 144 | .Xr pthread_rwlock_unlock 3 , |
138 | .Xr pthread_rwlock_wrlock 3 , | | 145 | .Xr pthread_rwlock_wrlock 3 , |
139 | .Xr pthread_rwlockattr 3 , | | 146 | .Xr pthread_rwlockattr 3 , |
140 | .Xr pthread_schedparam 3 , | | 147 | .Xr pthread_schedparam 3 , |
141 | .Xr pthread_self 3 , | | 148 | .Xr pthread_self 3 , |
142 | .Xr pthread_setspecific 3 , | | 149 | .Xr pthread_setspecific 3 , |
143 | .Xr pthread_sigmask 3 , | | 150 | .Xr pthread_sigmask 3 , |
144 | .Xr pthread_spin_destroy 3 , | | 151 | .Xr pthread_spin_destroy 3 , |
145 | .Xr pthread_spin_init 3 , | | 152 | .Xr pthread_spin_init 3 , |
146 | .Xr pthread_spin_lock 3 , | | 153 | .Xr pthread_spin_lock 3 , |
147 | .Xr pthread_spin_unlock 3 , | | 154 | .Xr pthread_spin_unlock 3 , |
148 | .Xr pthread_testcancel 3 | | 155 | .Xr pthread_testcancel 3 |
149 | .Sh STANDARDS | | 156 | .Sh STANDARDS |
150 | The | | 157 | The |
151 | .Nm | | 158 | .Nm |
152 | library conforms to | | 159 | library conforms to |
153 | .St -p1003.1-2001 . | | 160 | .St -p1003.1-2001 . |