diff options
author | Chris Down <chris@chrisdown.name> | 2022-11-01 00:17:21 +0000 |
---|---|---|
committer | Craig Small <csmall@dropbear.xyz> | 2023-01-15 04:05:40 +0000 |
commit | 866abacf8805a74fb7c59cae1f64963e0a540b14 (patch) | |
tree | 56ad0980a9a39cbfa8eabbe8406ffbcb98729ac2 /man | |
parent | 1db14dafd95e29b1d9aca5dc1775598aabc0a24b (diff) | |
download | procps-ng-866abacf8805a74fb7c59cae1f64963e0a540b14.tar.gz |
pgrep: Support matching on the presence of a userspace signal handler
In production we've had several incidents over the years where a process
has a signal handler registered for SIGHUP or one of the SIGUSR signals
which can be used to signal a request to reload configs, rotate log
files, and the like. While this may seem harmless enough, what we've
seen happen repeatedly is something like the following:
1. A process is using SIGHUP/SIGUSR[12] to request some
application-handled state change -- reloading configs, rotating a log
file, etc;
2. This kind of request is deprecated and removed, so the signal handler
is removed. However, a site where the signal might be sent from is
missed (often logrotate or a service manager);
3. Because the default disposition of these signals is terminal, sooner
or later these applications are going to be sent SIGHUP or similar
and end up unexpectedly killed.
I know for a fact that we're not the only organisation experiencing
this: in general, signal use is pretty tricky to reason about and safely
remove because of the fairly aggressive SIG_DFL behaviour for some
common signals, especially for SIGHUP which has a particularly ambiguous
meaning. Especially in a large, highly interconnected codebase,
reasoning about signal interactions between system configuration and
applications can be highly complex, and it's inevitable that on occasion
a callsite will be missed.
In some cases the right call to avoid this will be to migrate services
towards other forms of IPC for this purpose, but inevitably there will
be some services which must continue using signals, so we need a safe
way to support them.
This patch adds support for the -H/--require-handler flag, which matches
on processes with a userspace handler present for the signal being sent.
With this flag we can enforce that all SIGHUP reload cases and SIGUSR
equivalents use --require-handler. This effectively mitigates the case
we've seen time and time again where SIGHUP is used to rotate log files
or reload configs, but the sending site is mistakenly left present after
the removal of signal handler, resulting in unintended termination of
the process.
Signed-off-by: Chris Down <chris@chrisdown.name>
Diffstat (limited to 'man')
-rw-r--r-- | man/pgrep.1 | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/man/pgrep.1 b/man/pgrep.1 index 57ddc4e..64e610d 100644 --- a/man/pgrep.1 +++ b/man/pgrep.1 @@ -7,7 +7,7 @@ .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" -.TH PGREP "1" "2022-08-31" "procps-ng" "User Commands" +.TH PGREP "1" "2022-11-01" "procps-ng" "User Commands" .SH NAME pgrep, pkill, pidwait \- look up, signal, or wait for processes based on name and other attributes .SH SYNOPSIS @@ -53,9 +53,14 @@ will wait for each process instead of listing them on stdout. .TQ \fB\-\-signal\fR \fIsignal\fR Defines the signal to send to each matched process. Either the numeric or -the symbolic signal name can be used. -.RB ( pkill -only.) +the symbolic signal name can be used. In +.B pgrep +or +.B pidwait +mode this has no effect unless used in conjunction with +\fB\-\-require\-handler\fR to filter to processes with a userspace signal +handler present for a particular signal. + .TP \fB\-c\fR, \fB\-\-count\fR Suppress normal output; instead print a count of matching processes. When @@ -187,6 +192,10 @@ For example, this can be useful when elevating with .BR sudo or similar tools. .TP +\fB\-H\fR, \fB\-\-require\-handler\fR\fR +Only match processes with a userspace signal handler present for the signal to +be sent. +.TP \fB\-\-cgroup \fIname\fP,... Match on provided control group (cgroup) v2 name. See .BR cgroups (8) |