lib/libc/sys/thr_exit.2

   1 .\" Copyright (c) 2016 The FreeBSD Foundation, Inc.
   2 .\"
   3 .\" This documentation was written by
   4 .\" Konstantin Belousov <kib@FreeBSD.org> under sponsorship
   5 .\" from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd May 5, 2020
  31 .Dt THR_EXIT 2
  32 .Os
  33 .Sh NAME
  34 .Nm thr_exit
  35 .Nd terminate current thread
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/thr.h
  40 .Ft void
  41 .Fn thr_exit "long *state"
  42 .Sh DESCRIPTION
  43 .Bf -symbolic
  44 This function is intended for implementing threading.
  45 Normal applications should call
  46 .Xr pthread_exit 3
  47 instead.
  48 .Ef
  49 .Pp
  50 The
  51 .Fn thr_exit
  52 system call terminates the current kernel-scheduled thread.
  53 .Pp
  54 If the
  55 .Fa state
  56 argument is not
  57 .Dv NULL ,
  58 the location pointed to by the argument is
  59 updated with an arbitrary non-zero value, and an
  60 .Xr _umtx_op 2
  61 .Dv UMTX_OP_WAKE
  62 operation is consequently performed on the location.
  63 .Pp
  64 Attempts to terminate the last thread in the process are silently ignored.
  65 Use
  66 .Xr _exit 2
  67 syscall to terminate the process.
  68 .Sh RETURN VALUES
  69 The function does not return a value.
  70 A return from the function indicates that the calling thread was the
  71 last one in the process.
  72 .Sh SEE ALSO
  73 .Xr _exit 2 ,
  74 .Xr _umtx_op 2 ,
  75 .Xr thr_kill 2 ,
  76 .Xr thr_kill2 2 ,
  77 .Xr thr_new 2 ,
  78 .Xr thr_self 2 ,
  79 .Xr thr_set_name 2 ,
  80 .Xr pthread_exit 3
  81 .Sh STANDARDS
  82 The
  83 .Fn thr_exit
  84 system call is non-standard and is used by
  85 .Lb libthr
  86 to implement
  87 .St -p1003.1-2001
  88 .Xr pthread 3
  89 functionality.
  90 .Sh HISTORY
  91 The
  92 .Fn thr_exit
  93 system call first appeared in
  94 .Fx 5.2 .