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