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 BSD 4 36.Sh NAME 37.Nm pthread_exit 38.Nd terminate the calling thread 39.Sh SYNOPSIS 40.Fd #include <pthread.h> 41.Ft void 42.Fn pthread_exit "void *value_ptr" 43.Sh DESCRIPTION 44The 45.Fn pthread_exit 46function terminates the calling thread and makes the value 47.Fa value_ptr 48available to any successful join with the terminating thread. Any 49cancellation cleanup handlers that have been pushed and are not yet popped 50are popped in the reverse order that they were pushed and then executed. 51After all cancellation handlers have been executed, if the thread has any 52thread-specific data, appropriate destructor functions are called in an 53unspecified order. Thread termination does not release any application 54visible process resources, including, but not limited to, mutexes and 55file descriptors, nor does it perform any process level cleanup 56actions, including, but not limited to, calling 57.Fn atexit 58routines that may exist. 59.Pp 60An implicit call to 61.Fn pthread_exit 62is made when a thread other than the thread in which 63.Fn main 64was first invoked returns from the start routine that was used to create 65it. The function's return value serves as the thread's exit status. 66.Pp 67The behavior of 68.Fn pthread_exit 69is undefied if called from a cancellation handler or destructor function 70that was invoked as the result of an implicit or explicit call to 71.Fn pthread_exit . 72.Pp 73After a thread has terminated, the result of access to local (auto) 74variables of the thread is undefined. Thus, references to local variables 75of the exiting thread should not be used for the 76.Fn pthread_exit 77.Fa value_ptr 78parameter value. 79.Pp 80The process will exit with an exit status of 0 after the last thread has 81been terminated. The behavior is as if the implementation called 82.Fn exit 83with a zero argument at thread termination time. 84.Pp 85.Sh RETURN VALUES 86The 87.Fn pthread_exit 88function cannot return to its caller. 89.Sh ERRORS 90None. 91.Pp 92.Sh SEE ALSO 93.Xr _exit 2 , 94.Xr exit 3 , 95.Xr pthread_create 3 , 96.Xr pthread_join 3 97.Sh STANDARDS 98.Fn pthread_exit 99conforms to ISO/IEC 9945-1 ANSI/IEEE 100.Pq Dq Tn POSIX 101Std 1003.1 Second Edition 1996-07-12. 102