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