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