man2/tkill.2

   1 .\" Copyright (C) 2008 Michael Kerrisk <tmk.manpages@gmail.com>
   2 .\" and Copyright 2003 Abhijit Menon-Sen <ams@wiw.org>
   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 .\" 2004-05-31, added tgkill, ahu, aeb
  27 .\" 2008-01-15 mtk -- rewrote DESCRIPTION
  28 .\"
  29 .TH TKILL 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 tkill, tgkill \- send a signal to a thread
  32 .SH SYNOPSIS
  33 .nf
  34 .BR "#include <signal.h>" "           /* Definition of " SIG* " constants */"
  35 .BR "#include <sys/syscall.h>" "      /* Definition of " SYS_* " constants */"
  36 .B #include <unistd.h>
  37 .PP
  38 .BI "int syscall(SYS_tkill, pid_t " tid ", int " sig );
  39 .PP
  40 .B #include <signal.h>
  41 .PP
  42 .BI "int tgkill(pid_t " tgid ", pid_t " tid ", int " sig );
  43 .fi
  44 .PP
  45 .IR Note :
  46 glibc provides no wrapper for
  47 .BR tkill (),
  48 necessitating the use of
  49 .BR syscall (2).
  50 .SH DESCRIPTION
  51 .BR tgkill ()
  52 sends the signal
  53 .I sig
  54 to the thread with the thread ID
  55 .I tid
  56 in the thread group
  57 .IR tgid .
  58 (By contrast,
  59 .BR kill (2)
  60 can be used to send a signal only to a process (i.e., thread group)
  61 as a whole, and the signal will be delivered to an arbitrary
  62 thread within that process.)
  63 .PP
  64 .BR tkill ()
  65 is an obsolete predecessor to
  66 .BR tgkill ().
  67 It allows only the target thread ID to be specified,
  68 which may result in the wrong thread being signaled if a thread
  69 terminates and its thread ID is recycled.
  70 Avoid using this system call.
  71 .\" FIXME Maybe say something about the following:
  72 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=12889
  73 .\"
  74 .\" Quoting Rich Felker <bugdal@aerifal.cx>:
  75 .\"
  76 .\" There is a race condition in pthread_kill: it is possible that,
  77 .\" between the time pthread_kill reads the pid/tid from the target
  78 .\" thread descriptor and the time it makes the tgkill syscall,
  79 .\" the target thread terminates and the same tid gets assigned
  80 .\" to a new thread in the same process.
  81 .\"
  82 .\" (The tgkill syscall was designed to eliminate a similar race
  83 .\" condition in tkill, but it only succeeded in eliminating races
  84 .\" where the tid gets reused in a different process, and does not
  85 .\" help if the same tid gets assigned to a new thread in the
  86 .\" same process.)
  87 .\"
  88 .\" The only solution I can see is to introduce a mutex that ensures
  89 .\" that a thread cannot exit while pthread_kill is being called on it.
  90 .\"
  91 .\" Note that in most real-world situations, like almost all race
  92 .\" conditions, this one will be extremely rare. To make it
  93 .\" measurable, one could exhaust all but 1-2 available pid values,
  94 .\" possibly by lowering the max pid parameter in /proc, forcing
  95 .\" the same tid to be reused rapidly.
  96 .PP
  97 These are the raw system call interfaces, meant for internal
  98 thread library use.
  99 .SH RETURN VALUE
 100 On success, zero is returned.
 101 On error, \-1 is returned, and \fIerrno\fP
 102 is set to indicate the error.
 103 .SH ERRORS
 104 .TP
 105 .B EAGAIN
 106 The
 107 .B RLIMIT_SIGPENDING
 108 resource limit was reached and
 109 .I sig
 110 is a real-time signal.
 111 .TP
 112 .B EAGAIN
 113 Insufficient kernel memory was available and
 114 .I sig
 115 is a real-time signal.
 116 .TP
 117 .B EINVAL
 118 An invalid thread ID, thread group ID, or signal was specified.
 119 .TP
 120 .B EPERM
 121 Permission denied.
 122 For the required permissions, see
 123 .BR kill (2).
 124 .TP
 125 .B ESRCH
 126 No process with the specified thread ID (and thread group ID) exists.
 127 .SH VERSIONS
 128 .BR tkill ()
 129 is supported since Linux 2.4.19 / 2.5.4.
 130 .BR tgkill ()
 131 was added in Linux 2.5.75.
 132 .PP
 133 Library support for
 134 .BR tgkill ()
 135 was added to glibc in version 2.30.
 136 .SH CONFORMING TO
 137 .BR tkill ()
 138 and
 139 .BR tgkill ()
 140 are Linux-specific and should not be used
 141 in programs that are intended to be portable.
 142 .SH NOTES
 143 See the description of
 144 .B CLONE_THREAD
 145 in
 146 .BR clone (2)
 147 for an explanation of thread groups.
 148 .PP
 149 Before glibc 2.30, there was also no wrapper function for
 150 .BR tgkill ().
 151 .SH SEE ALSO
 152 .BR clone (2),
 153 .BR gettid (2),
 154 .BR kill (2),
 155 .BR rt_sigqueueinfo (2)