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