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