gitweb.dragonflybsd.org Git - dragonfly.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.7 2001/12/17 10:08:26 ru Exp $
	32	.\" $DragonFly: src/lib/libc_r/man/pthread_exit.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
	33	.\"
	34	.Dd April 4, 1996
	35	.Dt PTHREAD_EXIT 3
	36	.Os
	37	.Sh NAME
	38	.Nm pthread_exit
	39	.Nd terminate the calling thread
	40	.Sh LIBRARY
	41	.Lb libc_r
	42	.Sh SYNOPSIS
	43	.In pthread.h
	44	.Ft void
	45	.Fn pthread_exit "void *value_ptr"
	46	.Sh DESCRIPTION
	47	The
	48	.Fn pthread_exit
	49	function terminates the calling thread and makes the value
	50	.Fa value_ptr
	51	available to any successful join with the terminating thread.
	52	Any
	53	cancellation cleanup handlers that have been pushed and are not yet popped
	54	are popped in the reverse order that they were pushed and then executed.
	55	After all cancellation handlers have been executed, if the thread has any
	56	thread-specific data, appropriate destructor functions are called in an
	57	unspecified order.
	58	Thread termination does not release any application
	59	visible process resources, including, but not limited to, mutexes and
	60	file descriptors, nor does it perform any process level cleanup
	61	actions, including, but not limited to, calling
	62	.Fn atexit
	63	routines that may exist.
	64	.Pp
	65	An implicit call to
	66	.Fn pthread_exit
	67	is made when a thread other than the thread in which
	68	.Fn main
	69	was first invoked returns from the start routine that was used to create
	70	it. The function's return value serves as the thread's exit status.
	71	.Pp
	72	The behavior of
	73	.Fn pthread_exit
	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
	76	.Fn pthread_exit .
	77	.Pp
	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
	82	.Fn pthread_exit
	83	.Fa value_ptr
	84	parameter value.
	85	.Pp
	86	The process will exit with an exit status of 0 after the last thread has
	87	been terminated.
	88	The behavior is as if the implementation called
	89	.Fn exit
	90	with a zero argument at thread termination time.
	91	.Sh RETURN VALUES
	92	The
	93	.Fn pthread_exit
	94	function cannot return to its caller.
	95	.Sh ERRORS
	96	None.
	97	.Sh SEE ALSO
	98	.Xr _exit 2 ,
	99	.Xr exit 3 ,
	100	.Xr pthread_create 3 ,
	101	.Xr pthread_join 3
	102	.Sh STANDARDS
	103	.Fn pthread_exit
	104	conforms to
	105	.St -p1003.1-96 .