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