From: Marco Elver <elver@google.com>
Date: Wed, 1 Apr 2020 10:17:14 +0000 (+0200)
Subject: checkpatch: Warn about data_race() without comment
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=5099a722e9727fe9a93fac51e961735f40e5b6c8;p=linux.git

checkpatch: Warn about data_race() without comment

Warn about applications of data_race() without a comment, to encourage
documenting the reasoning behind why it was deemed safe.

Suggested-by: Will Deacon <will@kernel.org>
Signed-off-by: Marco Elver <elver@google.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
---

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index a63380c6b0d20..48bb9508e3009 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -5833,6 +5833,14 @@ sub process {
 			}
 		}
 
+# check for data_race without a comment.
+		if ($line =~ /\bdata_race\s*\(/) {
+			if (!ctx_has_comment($first_line, $linenr)) {
+				WARN("DATA_RACE",
+				     "data_race without comment\n" . $herecurr);
+			}
+		}
+
 # check for smp_read_barrier_depends and read_barrier_depends
 		if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
 			WARN("READ_BARRIER_DEPENDS",