xref: /netbsd/lib/libc/sys/_lwp_kill.2 (revision 6550d01e)
1.\"	$NetBSD: _lwp_kill.2,v 1.4 2009/06/24 22:19:14 zafer Exp $
2.\"
3.\" Copyright (c) 2003, 2007 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe of Wasabi Systems, Inc, and by Andrew Doran.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd January 20, 2007
31.Dt _LWP_KILL 2
32.Os
33.Sh NAME
34.Nm _lwp_kill
35.Nd send a signal to a light-weight process
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In lwp.h
40.Ft int
41.Fn _lwp_kill "lwpid_t lwp" "int sig"
42.Sh DESCRIPTION
43.Fn _lwp_kill
44sends the signal specified by
45.Fa sig
46to the light-weight process specified by
47.Fa lwp .
48If the
49.Fa sig
50argument is given as 0 (zero),
51.Nm
52will test for the existence of the target LWP, but will take no further
53action.
54.Pp
55Job control signals and uncatchable signals can not be directed to a specific
56LWP: if posted with
57.Nm ,
58they will affect all LWPs in the process.
59.Pp
60Signals will be posted successfully to suspended LWPs, but will not be
61handled further until the LWP has been continued.
62.Sh RETURN VALUES
63A 0 value indicates that the call succeeded.
64A \-1 return value indicates an error occurred and
65.Va errno
66is set to indicate the reason.
67.Sh ERRORS
68.Bl -tag -width [EINVAL]
69.It Bq Er EINVAL
70.Fa sig
71is not a valid signal number.
72.It Bq Er ESRCH
73No LWP can be found in the current process corresponding to that
74specified by
75.Fa lwp .
76.El
77.Sh SEE ALSO
78.Xr _lwp_continue 2 ,
79.Xr _lwp_suspend 2 ,
80.Xr kill 2 ,
81.Xr sigaction 2 ,
82.Xr signal 7
83.Sh HISTORY
84The
85.Fn _lwp_kill
86system call first appeared in
87.Nx 5.0 .
88