man3/pthread_exit.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_EXIT 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_exit \- terminate calling thread
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <pthread.h>
  32 .PP
  33 .BI "noreturn void pthread_exit(void *" retval );
  34 .PP
  35 Compile and link with \fI\-pthread\fP.
  36 .fi
  37 .SH DESCRIPTION
  38 The
  39 .BR pthread_exit ()
  40 function terminates the calling thread and returns a value via
  41 .I retval
  42 that (if the thread is joinable)
  43 is available to another thread in the same process that calls
  44 .BR pthread_join (3).
  45 .PP
  46 Any clean-up handlers established by
  47 .BR pthread_cleanup_push (3)
  48 that have not yet been popped,
  49 are popped (in the reverse of the order in which they were pushed)
  50 and executed.
  51 If the thread has any thread-specific data, then,
  52 after the clean-up handlers have been executed,
  53 the corresponding destructor functions are called,
  54 in an unspecified order.
  55 .PP
  56 When a thread terminates,
  57 process-shared resources (e.g., mutexes, condition variables,
  58 semaphores, and file descriptors) are not released,
  59 and functions registered using
  60 .BR atexit (3)
  61 are not called.
  62 .PP
  63 After the last thread in a process terminates,
  64 the process terminates as by calling
  65 .BR exit (3)
  66 with an exit status of zero;
  67 thus, process-shared resources
  68 are released and functions registered using
  69 .BR atexit (3)
  70 are called.
  71 .SH RETURN VALUE
  72 This function does not return to the caller.
  73 .SH ERRORS
  74 This function always succeeds.
  75 .SH ATTRIBUTES
  76 For an explanation of the terms used in this section, see
  77 .BR attributes (7).
  78 .ad l
  79 .nh
  80 .TS
  81 allbox;
  82 lbx lb lb
  83 l l l.
  84 Interface       Attribute       Value
  85 T{
  86 .BR pthread_exit ()
  87 T}      Thread safety   MT-Safe
  88 .TE
  89 .hy
  90 .ad
  91 .sp 1
  92 .SH CONFORMING TO
  93 POSIX.1-2001, POSIX.1-2008.
  94 .SH NOTES
  95 Performing a return from the start function of any thread other
  96 than the main thread results in an implicit call to
  97 .BR pthread_exit (),
  98 using the function's return value as the thread's exit status.
  99 .PP
 100 To allow other threads to continue execution,
 101 the main thread should terminate by calling
 102 .BR pthread_exit ()
 103 rather than
 104 .BR exit (3).
 105 .PP
 106 The value pointed to by
 107 .IR retval
 108 should not be located on the calling thread's stack,
 109 since the contents of that stack are undefined after the thread terminates.
 110 .SH BUGS
 111 Currently,
 112 .\" Linux 2.6.27
 113 there are limitations in the kernel implementation logic for
 114 .BR wait (2)ing
 115 on a stopped thread group with a dead thread group leader.
 116 This can manifest in problems such as a locked terminal if a stop signal is
 117 sent to a foreground process whose thread group leader has already called
 118 .BR pthread_exit ().
 119 .\" FIXME . review a later kernel to see if this gets fixed
 120 .\" http://thread.gmane.org/gmane.linux.kernel/611611
 121 .\" http://marc.info/?l=linux-kernel&m=122525468300823&w=2
 122 .SH SEE ALSO
 123 .BR pthread_create (3),
 124 .BR pthread_join (3),
 125 .BR pthreads (7)