[v3] checkpatch: warn about direct use of send_sig_info and force_sig_info
diff mbox series

Message ID 20210507131658.3754171-1-elver@google.com
State New, archived
Headers show
Series
  • [v3] checkpatch: warn about direct use of send_sig_info and force_sig_info
Related show

Commit Message

Marco Elver May 7, 2021, 1:16 p.m. UTC
Setting up siginfo and using send_sig_info() and force_sig_info()
directly is discouraged. Instead, new code wanting to generate signals
should use the appropriate helper specific to the signal.

Eric mentioned that he'd like to make these static at some point, but
until that can happen, let's try to avoid introducing new users of them.

Link: https://lkml.kernel.org/r/m17dkjttpj.fsf@fess.ebiederm.org
Link: https://lkml.kernel.org/r/m1eeej3g52.fsf@fess.ebiederm.org
Cc: Eric W. Biederman <ebiederm@xmission.com>
Signed-off-by: Marco Elver <elver@google.com>
---
v3:
* Reword warning message (Joe Perches).
* Simplify regex (Joe Perches).

v2:
* Use ?: because we don't need $2 (suggested by Dwaipayan Ray).

v1: https://lkml.kernel.org/r/20210506132827.3198497-1-elver@google.com
---
 scripts/checkpatch.pl | 6 ++++++
 1 file changed, 6 insertions(+)

Patch
diff mbox series

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index ccb412a74725..c714543818e5 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -7153,6 +7153,12 @@  sub process {
 			     "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
 		}
 
+# check for direct use of send_sig_info(), force_sig_info()
+		if ($sline =~ /\b(force_sig_info|send_sig_info)\s*\(/) {
+			WARN("USE_SIGINFO_HELPER",
+			     "Prefer signal-specific helpers over use of '$1' (see: include/linux/sched/signal.h)\n" . $herecurr);
+		}
+
 # check for deprecated apis
 		if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
 			my $deprecated_api = $1;