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.Dd March 15, 2014 32.Dt PTHREAD_EXIT 3 33.Os 34.Sh NAME 35.Nm pthread_exit 36.Nd terminate the calling thread 37.Sh LIBRARY 38.Lb libpthread 39.Sh SYNOPSIS 40.In 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. 49Any 50cancellation cleanup handlers that have been pushed and are not yet popped 51are popped in the reverse order that they were pushed and then executed. 52After all cancellation handlers have been executed, if the thread has any 53thread-specific data, appropriate destructor functions are called in an 54unspecified order. 55Thread termination does not release any application 56visible process resources, including, but not limited to, mutexes and 57file descriptors, nor does it perform any process level cleanup 58actions, including, but not limited to, calling 59.Fn atexit 60routines that may exist. 61.Pp 62An implicit call to 63.Fn pthread_exit 64is made when a thread other than the thread in which 65.Fn main 66was first invoked returns from the start routine that was used to create 67it. 68The function's return value serves as the thread's exit status. 69.Pp 70The behavior of 71.Fn pthread_exit 72is undefined if called from a cancellation handler or destructor function 73that was invoked as the result of an implicit or explicit call to 74.Fn pthread_exit . 75.Pp 76After a thread has terminated, the result of access to local (auto) 77variables of the thread is undefined. 78Thus, references to local variables 79of the exiting thread should not be used for the 80.Fn pthread_exit 81.Fa value_ptr 82parameter value. 83.Pp 84The process will exit with an exit status of 0 after the last thread has 85been terminated. 86The behavior is as if the implementation called 87.Fn exit 88with a zero argument at thread termination time. 89.Sh RETURN VALUES 90The 91.Fn pthread_exit 92function cannot return to its caller. 93.Sh ERRORS 94None. 95.Sh SEE ALSO 96.Xr _exit 2 , 97.Xr exit 3 , 98.Xr pthread_cancel 3 , 99.Xr pthread_create 3 , 100.Xr pthread_join 3 101.Sh STANDARDS 102The 103.Fn pthread_exit 104function conforms to 105.St -p1003.1-96 . 106