pthread_exit(3) — Linux manual page

pthread_exit(3)         Library Functions Manual         pthread_exit(3)

NAME

       pthread_exit - terminate calling thread

LIBRARY

       POSIX threads library (libpthread, -lpthread)

SYNOPSIS

       #include <pthread.h>

       [[noreturn]] void pthread_exit(void *retval);

DESCRIPTION

       The pthread_exit() function terminates the calling thread and
       returns a value via retval that (if the thread is joinable) is
       available to another thread in the same process that calls
       pthread_join(3).

       Any clean-up handlers established by 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 atexit(3) are
       not called.

       After the last thread in a process terminates, the process
       terminates as by calling exit(3) with an exit status of zero;
       thus, process-shared resources are released and functions
       registered using atexit(3) are called.

RETURN VALUE

       This function does not return to the caller.

ERRORS

       This function always succeeds.

ATTRIBUTES

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           │ Attribute     │ Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ pthread_exit()                      │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS

       POSIX.1-2008.

HISTORY

       POSIX.1-2001.

NOTES

       Performing a return from the start function of any thread other
       than the main thread results in an implicit call to
       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 pthread_exit() rather than exit(3).

       The value pointed to by retval should not be located on the
       calling thread's stack, since the contents of that stack are
       undefined after the thread terminates.

BUGS

       Currently, there are limitations in the kernel implementation
       logic for 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 pthread_exit().

SEE ALSO

       pthread_create(3), pthread_join(3), pthreads(7)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                pthread_exit(3)

Pages that refer to this page: PR_SET_PDEATHSIG(2const), pthread_cancel(3), pthread_cleanup_push(3), pthread_create(3), pthread_detach(3), pthread_join(3), pthread_key_create(3), pthread_tryjoin_np(3), proc_pid_cwd(5), proc_pid_exe(5), proc_pid_fd(5), proc_pid_root(5), proc_pid_task(5), pthreads(7)

---