linux-kernel - [PATCH] checkpatch: Add a warning for log messages that don't end in a line feed

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20171122205516.26090-1-logang@deltatee.com>
Date:   Wed, 22 Nov 2017 13:55:16 -0700
From:   Logan Gunthorpe <logang@...tatee.com>
To:     linux-kernel@...r.kernel.org
Cc:     Logan Gunthorpe <logang@...tatee.com>,
        Andy Whitcroft <apw@...onical.com>,
        Joe Perches <joe@...ches.com>
Subject: [PATCH] checkpatch: Add a warning for log messages that don't end in a line feed

Check for lines with a log function using a $logLineFeedFunctions
expression which is similar to the existing $logFunctions expression
except we don't include MODULE and seq_ functions.

Once an appropriate log function is found, mark that we are in a
log function (for multiline calls). The mark is removed once we see a
line ending in ';' or the end of a patch hunk (similar to $in_comment).

For lines that are in a log function (including the first and last),
if we see a quoted string that ends in \n, we remove the mark as we are
likely good. Otherwise, if we see a quote followed by a comma or a close
paraenthesis, that isn't preceded by a backslash than it looks like we
have found the end of the format string without a \n and we WARN.

Signed-off-by: Logan Gunthorpe <logang@...tatee.com>
Cc: Andy Whitcroft <apw@...onical.com>
Cc: Joe Perches <joe@...ches.com>
---

This is my penance for breaking this rule for a while.

I've run these changes on a number of patchsets I've submitted and it
seems to perform quite well. I've also done my best to try and trick
it with different forms of log messages but I haven't come up with
anything that's a false positive or negative. If anyone's creative
enough to come up with something that does break it I can see if I can
address it.

 scripts/checkpatch.pl | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 8b80bac055e4..917725f36283 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -460,6 +460,13 @@ our $logFunctions = qr{(?x:
 	seq_vprintf|seq_printf|seq_puts
 )};

+our $logLineFeedFunctions = qr{(?x:
+	printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
+	(?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
+	WARN(?:_RATELIMIT|_ONCE|)|
+	panic
+)};
+
 our $signature_tags = qr{(?xi:
 	Signed-off-by:|
 	Acked-by:|
@@ -2202,6 +2209,7 @@ sub process {
 	my $here = '';
 	my $context_function;		#undef'd unless there's a known function
 	my $in_comment = 0;
+	my $in_log_function = 0;
 	my $comment_edge = 0;
 	my $first_line = 0;
 	my $p1_prefix = '';
@@ -2247,6 +2255,7 @@ sub process {
 				$realcnt=1+1;
 			}
 			$in_comment = 0;
+			$in_log_function = 0;

 			# Guestimate if this is a continuing comment.  Run
 			# the context looking for a comment "edge".  If this
@@ -5389,6 +5398,23 @@ sub process {
 			}
 		}

+# check for logging functions with lines that don't end in a '\n"'
+		if ($line =~ /\b$logLineFeedFunctions\s*\(/) {
+			$in_log_function = 1;
+		}
+		if ($in_log_function) {
+			my $qstr = get_quoted_string($line, $rawline);
+			if ($qstr =~ /\\n"$/) {
+				$in_log_function = 0;
+			} elsif ($line =~ /[^\\]"[,)]/) {
+				WARN("LOGGING_MISSING_LINEFEED",
+				     "Log messages should end in a line feed (\\n)\n" . $herecurr);
+				$in_log_function = 0;
+			} elsif ($line =~ /;$/) {
+				$in_log_function = 0;
+			}
+		}
+
 # check for logging continuations
 		if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
 			WARN("LOGGING_CONTINUATION",
--
2.11.0