xref: /freebsd/share/man/man9/psignal.9 (revision 1b6c76a2fe091c74f08427e6c870851025a9cf67)
1.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to The NetBSD Foundation
5.\" by Paul Kranenburg.
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.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"        This product includes software developed by the NetBSD
18.\"        Foundation, Inc. and its contributors.
19.\" 4. Neither the name of The NetBSD Foundation nor the names of its
20.\"    contributors may be used to endorse or promote products derived
21.\"    from this software without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
27.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33.\" POSSIBILITY OF SUCH DAMAGE.
34.\"
35.\"	$NetBSD: psignal.9,v 1.1 1996/06/22 22:57:35 pk Exp $
36.\" $FreeBSD$
37.\"
38.Dd June 22, 1996
39.Dt PSIGNAL 9
40.Os
41.Sh NAME
42.Nm psignal ,
43.Nm pgsignal ,
44.Nm gsignal
45.Nd post signal to a process or process group
46.Sh SYNOPSIS
47.Fd #include <sys/types.h>
48.Fd #include <sys/signalvar.h>
49.Ft void
50.Fn psignal "struct proc *p" "int signum"
51.Ft void
52.Fn pgsignal "struct pgrp *pgrp" "int signum" "int checkctty"
53.Ft void
54.Fn gsignal "int pgid" "int signum"
55.Sh DESCRIPTION
56These functions post a signal to one or more processes.
57The argument
58.Fa signum
59common to all three functions should be in the range
60.Bq 1- Ns Dv NSIG .
61.Pp
62The
63.Fn psignal
64function posts signal number
65.Fa signum
66to the process represented by the process structure
67.Fa p .
68With a few exceptions noted below, the target process signal disposition is
69updated and is marked as runnable, so further handling of the signal is done
70in the context of the target process after a context switch.
71Note that
72.Fn psignal
73does not by itself cause a context switch to happen.
74.Pp
75The target process is not marked as runnable in the following cases:
76.Bl -bullet -offset indent
77.It
78The target process is sleeping uninterruptibly.
79The signal will be
80noticed when the process returns from the system call or trap.
81.It
82The target process is currently ignoring the signal.
83.It
84If a stop signal is sent to a sleeping process that takes the
85default action
86.Pq see Xr sigaction 2 ,
87the process is stopped without awakening it.
88.It
89.Dv SIGCONT
90restarts a stopped process
91.Pq or puts them back to sleep
92regardless of the signal action
93.Pq e.g., blocked or ignored .
94.El
95.Pp
96If the target process is being traced
97.Fn psignal
98behaves as if the target process were taking the default action for
99.Fa signum .
100This allows the tracing process to be notified of the signal.
101.Pp
102The
103.Fn pgsignal
104function posts signal number
105.Fa signum
106to each member of the process group described by
107.Fa pgrp .
108If
109.Fa checkctty
110is non-zero, the signal will be posted only to processes that have
111a controlling terminal.
112.Fn pgsignal
113is implemented by walking along the process list headed by the field
114.Li pg_members
115of the process group structure
116pointed at by
117.Fa pgrp
118and calling
119.Fn psignal
120as appropriate.
121If
122.Fa pgrp
123is
124.Dv NULL
125no action is taken.
126.Pp
127The
128.Fn gsignal
129function posts signal number
130.Fa signum
131to each member of the process group identified by the group id
132.Fa pgid .
133.Fn gsignal
134first finds the group structure associated with
135.Fa pgid ,
136then invokes
137.Fn pgsignal
138with the argument
139.Fa checkctty
140set to zero.
141If
142.Fa pgid
143is zero no action is taken.
144.Sh SEE ALSO
145.Xr sigaction 2 ,
146.Xr tsleep 9
147