2008-10-25 00:09:40 +00:00
|
|
|
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2009-03-29 18:17:27 +00:00
|
|
|
.TH PTHREAD_EXIT 3 2009-03-30 "Linux" "Linux Programmer's Manual"
|
2008-10-25 00:09:40 +00:00
|
|
|
.SH NAME
|
|
|
|
pthread_exit \- terminate calling thread
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
2008-10-25 02:09:15 +00:00
|
|
|
.BI "void pthread_exit(void *" retval );
|
2008-10-25 00:09:40 +00:00
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
add_key.2, keyctl.2, request_key.2, offsetof.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_cleanup_push_defer_np.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_testcancel.3: Global formatting fix: balance .nf/.fi pairs
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-03-12 15:37:22 +00:00
|
|
|
.fi
|
2008-10-25 00:09:40 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR pthread_exit ()
|
|
|
|
function terminates the calling thread and returns a value via
|
|
|
|
.I retval
|
|
|
|
that (if the thread is joinable)
|
|
|
|
is available to another thread in the same process that calls
|
|
|
|
.BR pthread_join (3).
|
|
|
|
|
|
|
|
Any clean-up handlers established by
|
|
|
|
.BR pthread_cleanup_push (3)
|
|
|
|
that have not yet been popped,
|
|
|
|
are popped (in the reverse of the order in which they were pushed)
|
|
|
|
and executed.
|
|
|
|
If the thread has any thread-specific data, then,
|
|
|
|
after the clean-up handlers have been executed,
|
|
|
|
the corresponding destructor functions are called,
|
|
|
|
in an unspecified order.
|
|
|
|
|
|
|
|
When a thread terminates,
|
|
|
|
process-shared resources (e.g., mutexes, condition variables,
|
|
|
|
semaphores, and file descriptors) are not released,
|
|
|
|
and functions registered using
|
|
|
|
.BR atexit (3)
|
|
|
|
are not called.
|
|
|
|
|
|
|
|
After the last thread in a process terminates,
|
|
|
|
the process terminates as by calling
|
|
|
|
.BR exit (3)
|
|
|
|
with an exit status of zero;
|
|
|
|
thus, process-shared resources
|
|
|
|
are released and functions registered using
|
|
|
|
.BR atexit (3)
|
|
|
|
are called.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
This function does not return to the caller.
|
|
|
|
.SH ERRORS
|
|
|
|
This function always succeeds.
|
|
|
|
.SH CONFORMING TO
|
|
|
|
POSIX.1-2001.
|
|
|
|
.SH NOTES
|
|
|
|
Performing a return from the start function of any thread other
|
|
|
|
than the main thread results in an implicit call to
|
|
|
|
.BR pthread_exit (),
|
|
|
|
using the function's return value as the thread's exit status.
|
|
|
|
|
|
|
|
To allow other threads to continue execution,
|
|
|
|
the main thread should terminate by calling
|
2009-03-29 18:17:27 +00:00
|
|
|
.BR pthread_exit ()
|
2008-10-25 00:09:40 +00:00
|
|
|
rather than
|
|
|
|
.BR exit (3).
|
|
|
|
|
|
|
|
The value pointed to by
|
|
|
|
.IR retval
|
|
|
|
should not be located on the calling thread's stack,
|
|
|
|
since the contents of that stack are undefined after the thread terminates.
|
2008-10-30 15:56:59 +00:00
|
|
|
.SH BUGS
|
|
|
|
Currently,
|
|
|
|
.\" Linux 2.6.27
|
|
|
|
there are limitations in the kernel implementation logic for
|
|
|
|
.BR wait (2)ing
|
|
|
|
on a stopped thread group with a dead thread group leader.
|
|
|
|
This can manifest in problems such as a locked terminal if a stop signal is
|
|
|
|
sent to a foreground process whose thread group leader has already called
|
2010-11-01 05:59:37 +00:00
|
|
|
.BR pthread_exit ().
|
2008-10-30 15:56:59 +00:00
|
|
|
.\" FIXME . review a later kernel to see if this gets fixed
|
|
|
|
.\" http://thread.gmane.org/gmane.linux.kernel/611611
|
|
|
|
.\" http://marc.info/?l=linux-kernel&m=122525468300823&w=2
|
2008-10-25 00:09:40 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
.BR pthread_create (3),
|
|
|
|
.BR pthread_join (3),
|
|
|
|
.BR pthreads (7)
|