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 .Dd May 5, 2020
  29 .Dt THR_EXIT 2
  30 .Os
  31 .Sh NAME
  32 .Nm thr_exit
  33 .Nd terminate current thread
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/thr.h
  38 .Ft void
  39 .Fn thr_exit "long *state"
  40 .Sh DESCRIPTION
  41 .Bf -symbolic
  42 This function is intended for implementing threading.
  43 Normal applications should call
  44 .Xr pthread_exit 3
  45 instead.
  46 .Ef
  47 .Pp
  48 The
  49 .Fn thr_exit
  50 system call terminates the current kernel-scheduled thread.
  51 .Pp
  52 If the
  53 .Fa state
  54 argument is not
  55 .Dv NULL ,
  56 the location pointed to by the argument is
  57 updated with an arbitrary non-zero value, and an
  58 .Xr _umtx_op 2
  59 .Dv UMTX_OP_WAKE
  60 operation is consequently performed on the location.
  61 .Pp
  62 Attempts to terminate the last thread in the process are silently ignored.
  63 Use
  64 .Xr _exit 2
  65 syscall to terminate the process.
  66 .Sh RETURN VALUES
  67 The function does not return a value.
  68 A return from the function indicates that the calling thread was the
  69 last one in the process.
  70 .Sh SEE ALSO
  71 .Xr _exit 2 ,
  72 .Xr _umtx_op 2 ,
  73 .Xr thr_kill 2 ,
  74 .Xr thr_kill2 2 ,
  75 .Xr thr_new 2 ,
  76 .Xr thr_self 2 ,
  77 .Xr thr_set_name 2 ,
  78 .Xr pthread_exit 3
  79 .Sh STANDARDS
  80 The
  81 .Fn thr_exit
  82 system call is non-standard and is used by
  83 .Lb libthr
  84 to implement
  85 .St -p1003.1-2001
  86 .Xr pthread 3
  87 functionality.
  88 .Sh HISTORY
  89 The
  90 .Fn thr_exit
  91 system call first appeared in
  92 .Fx 5.2 .