xref: /netbsd-src/lib/libc/sys/_lwp_kill.2 (revision ce099b40997c43048fb78bd578195f81d2456523)
1.\"	$NetBSD: _lwp_kill.2,v 1.2 2007/02/10 10:34:03 ad 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd January 20, 2007
38.Dt _LWP_KILL 2
39.Os
40.Sh NAME
41.Nm _lwp_kill
42.Nd send a signal to a light-weight process
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In lwp.h
47.Ft int
48.Fn _lwp_kill "lwpid_t lwp" "int sig"
49.Sh DESCRIPTION
50.Fn _lwp_kill
51sends the signal specified by
52.Fa sig
53to the light-weight process specified by
54.Fa lwp .
55If the
56.Fa sig
57argument is given as 0 (zero),
58.Nm
59will test for the existance of the target LWP, but will take no further
60action.
61.Pp
62Job control signals and uncatchable signals can not be directed to a specific
63LWP: if posted with
64.Nm ,
65they will affect all LWPs in the process.
66.Pp
67Signals will be posted successfully to suspended LWPs, but will not be
68handled further until the LWP has been continued.
69.Sh RETURN VALUES
70A 0 value indicates that the call succeeded.
71A \-1 return value indicates an error occurred and
72.Va errno
73is set to indicate the reason.
74.Sh ERRORS
75.Bl -tag -width [EINVAL]
76.It Bq Er EINVAL
77.Fa sig
78is not a valid signal number.
79.It Bq Er ESRCH
80No LWP can be found in the current process corresponding to that
81specified by
82.Fa lwp .
83.El
84.Sh SEE ALSO
85.Xr _lwp_continue 2 ,
86.Xr _lwp_suspend 2 ,
87.Xr kill 2 ,
88.Xr sigaction 2 ,
89.Xr signal 7
90.Sh HISTORY
91The
92.Fn _lwp_kill
93system call first appeared in
94.Nx 5.0 .
95