checkpatch: Warn about data_race() without comment

melver · paulmckrcu · commit 5099a722e972 · 2020-05-06T10:54:58.000-07:00
Warn about applications of data_race() without a comment, to encourage
documenting the reasoning behind why it was deemed safe.

Suggested-by: Will Deacon &lt;will@kernel.org&gt;
Signed-off-by: Marco Elver &lt;elver@google.com&gt;
Signed-off-by: Paul E. McKenney &lt;paulmck@kernel.org&gt;
diff --git 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",

Original file line number	Diff line number	Diff line change
`@@ -5833,6 +5833,14 @@ sub process {`
`5833`	`5833`	`}`
`5834`	`5834`	`}`
`5835`	`5835`
	`5836`	`+# check for data_race without a comment.`
	`5837`	`+ if ($line =~ /\bdata_race\s*\(/) {`
	`5838`	`+ if (!ctx_has_comment($first_line, $linenr)) {`
	`5839`	`+ WARN("DATA_RACE",`
	`5840`	`+ "data_race without comment\n" . $herecurr);`
	`5841`	`+ }`
	`5842`	`+ }`
	`5843`	`+`
`5836`	`5844`	`# check for smp_read_barrier_depends and read_barrier_depends`
`5837`	`5845`	`if (!$file && $line =~ /\b(smp_\|)read_barrier_depends\s*\(/) {`
`5838`	`5846`	`WARN("READ_BARRIER_DEPENDS",`