/share/man/man3/pthread_exit.3

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