1.\" $NetBSD: pthread_exit.3,v 1.2 2003/06/08 06:44:31 thorpej Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. Neither the name of The NetBSD Foundation nor the names of its 14.\" contributors may be used to endorse or promote products derived 15.\" from this software without specific prior written permission. 16.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26.\" POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. 29.\" All rights reserved. 30.\" 31.\" Redistribution and use in source and binary forms, with or without 32.\" modification, are permitted provided that the following conditions 33.\" are met: 34.\" 1. Redistributions of source code must retain the above copyright 35.\" notice, this list of conditions and the following disclaimer. 36.\" 2. Redistributions in binary form must reproduce the above copyright 37.\" notice, this list of conditions and the following disclaimer in the 38.\" documentation and/or other materials provided with the distribution. 39.\" 3. All advertising materials mentioning features or use of this software 40.\" must display the following acknowledgement: 41.\" This product includes software developed by John Birrell. 42.\" 4. Neither the name of the author nor the names of any co-contributors 43.\" may be used to endorse or promote products derived from this software 44.\" without specific prior written permission. 45.\" 46.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 47.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 48.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 49.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 50.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 51.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 52.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 53.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 54.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 55.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 56.\" SUCH DAMAGE. 57.\" 58.\" $FreeBSD: src/lib/libpthread/man/pthread_exit.3,v 1.16 2002/09/16 19:29:28 mini Exp $ 59.\" 60.Dd January 30, 2003 61.Dt PTHREAD_EXIT 3 62.Os 63.Sh NAME 64.Nm pthread_exit 65.Nd terminate the calling thread 66.Sh LIBRARY 67.Lb libpthread 68.Sh SYNOPSIS 69.In pthread.h 70.Ft void 71.Fn pthread_exit "void *value_ptr" 72.Sh DESCRIPTION 73The 74.Fn pthread_exit 75function terminates the calling thread and makes the value 76.Fa value_ptr 77available to any successful join with the terminating thread. 78Any 79cancellation cleanup handlers that have been pushed and are not yet popped 80are popped in the reverse order that they were pushed and then executed. 81After all cancellation handlers have been executed, if the thread has any 82thread-specific data, appropriate destructor functions are called in an 83unspecified order. 84Thread termination does not release any application 85visible process resources, including, but not limited to, mutexes and 86file descriptors, nor does it perform any process level cleanup 87actions, including, but not limited to, calling 88.Fn atexit 89routines that may exist. 90.Pp 91An implicit call to 92.Fn pthread_exit 93is made when a thread other than the thread in which 94.Fn main 95was first invoked returns from the start routine that was used to create 96it. The function's return value serves as the thread's exit status. 97.Pp 98The behavior of 99.Fn pthread_exit 100is undefined if called from a cancellation handler or destructor function 101that was invoked as the result of an implicit or explicit call to 102.Fn pthread_exit . 103.Pp 104After a thread has terminated, the result of access to local (auto) 105variables of the thread is undefined. 106Thus, references to local variables 107of the exiting thread should not be used for the 108.Fn pthread_exit 109.Fa value_ptr 110parameter value. 111.Pp 112The process will exit with an exit status of 0 after the last thread has 113been terminated. 114The behavior is as if the implementation called 115.Fn exit 116with a zero argument at thread termination time. 117.Sh RETURN VALUES 118The 119.Fn pthread_exit 120function cannot return to its caller. 121.Sh ERRORS 122None. 123.Sh SEE ALSO 124.Xr _exit 2 , 125.Xr exit 3 , 126.Xr pthread_create 3 , 127.Xr pthread_join 3 128.Sh STANDARDS 129.Fn pthread_exit 130conforms to 131.St -p1003.1-96 . 132