git.saurik.com Git - apple/libpthread.git/blame_incremental

... / ...

Commit	Line	Data
	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: src/lib/libc_r/man/pthread_exit.3,v 1.8.2.6 2001/08/17 15:42:51 ru Exp $
	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 SYNOPSIS
	40	.Fd #include <pthread.h>
	41	.Ft void
	42	.Fo pthread_exit
	43	.Fa "void *value_ptr"
	44	.Fc
	45	.Sh DESCRIPTION
	46	The
	47	.Fn pthread_exit
	48	function terminates the calling thread and makes the value
	49	.Fa value_ptr
	50	available to any successful join with the terminating thread.
	51	Any
	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
	56	unspecified order.
	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
	61	.Fn atexit
	62	routines that may exist.
	63	.Pp
	64	An implicit call to
	65	.Fn pthread_exit
	66	is made when a thread other than the thread in which
	67	.Fn main
	68	was first invoked returns from the start routine that was used to create
	69	it. The function's return value serves as the thread's exit status.
	70	.Pp
	71	The behavior of
	72	.Fn pthread_exit
	73	is undefined if called from a cancellation handler or destructor function
	74	that was invoked as the result of an implicit or explicit call to
	75	.Fn pthread_exit .
	76	.Pp
	77	After a thread has terminated, the result of access to local (auto)
	78	variables of the thread is undefined.
	79	Thus, references to local variables
	80	of the exiting thread should not be used for the
	81	.Fn pthread_exit
	82	.Fa value_ptr
	83	parameter value.
	84	.Pp
	85	The process will exit with an exit status of 0 after the last thread has
	86	been terminated.
	87	The behavior is as if the implementation called
	88	.Fn exit
	89	with a zero argument at thread termination time.
	90	.Sh RETURN VALUES
	91	The
	92	.Fn pthread_exit
	93	function cannot return to its caller.
	94	.Sh ERRORS
	95	None.
	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
	103	conforms to
	104	.St -p1003.1-96 .