1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
31 .\" $FreeBSD: src/share/man/man3/pthread_exit.3,v 1.21 2007/10/22 10:08:00 ru Exp $
38 .Nd terminate the calling thread
44 .Fn pthread_exit "void *value_ptr"
48 function terminates the calling thread and makes the value
50 available to any successful join with the terminating thread.
52 cancellation cleanup handlers that have been pushed and are not yet popped
53 are popped in the reverse order that they were pushed and then executed.
54 After all cancellation handlers have been executed, if the thread has any
55 thread-specific data, appropriate destructor functions are called in an
57 Thread termination does not release any application
58 visible process resources, including, but not limited to, mutexes and
59 file descriptors, nor does it perform any process level cleanup
60 actions, including, but not limited to, calling
62 routines that may exist.
66 is made when a thread other than the thread in which
68 was first invoked returns from the start routine that was used to create
70 The function's return value serves as the thread's exit status.
74 is undefined if called from a cancellation handler or destructor function
75 that was invoked as the result of an implicit or explicit call to
78 After a thread has terminated, the result of access to local (auto)
79 variables of the thread is undefined.
80 Thus, references to local variables
81 of the exiting thread should not be used for the
86 The process will exit with an exit status of 0 after the last thread has
88 The behavior is as if the implementation called
90 with a zero argument at thread termination time.
94 function cannot return to its caller.
100 .Xr pthread_create 3 ,