Received-SPF: pass (google.com: domain of linux-kernel+bounces-92647-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Tue, 05 Mar 2024 23:47:32 +0800
Message-ID: <87edcor88b.wl-me@linux.beauty>
From: Li Chen <me@linux.beauty>
To: Andy Whitcroft <apw@canonical.com>,
	Joe Perches <joe@perches.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	linux-kernel@vger.kernel.org
Subject: [RFC PATCH 1/1] checkpatch: Add warning for msleep with durations suitable for ssleep
In-Reply-To: <87frx4r8dt.wl-me@linux.beauty>
References: <87frx4r8dt.wl-me@linux.beauty>
User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue)
 FLIM-LB/1.14.9 (=?ISO-8859-4?Q?Goj=F2?=) APEL-LB/10.8 EasyPG/1.0.0
 Emacs/29.2 (x86_64-pc-linux-gnu) MULE/6.0 (HANACHIRUSATO)
Precedence: bulk
MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue")
Content-Type: text/plain; charset=US-ASCII

From: Li Chen <chenl311@chinatelecom.cn>

This patch enhances checkpatch.pl by introducing a warning for instances
where msleep() is used with durations that are multiples of 1000
milliseconds. Such durations are more semantically appropriate for
ssleep().

The goal is to encourage developers to use the most fitting sleep function,
improving code readability.

Warn when msleep(x000); can be replaced with ssleep(x);
Signed-off-by: Li Chen <chenl311@chinatelecom.cn>
---
 scripts/checkpatch.pl | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 9c4c4a61bc83..a32df4ead5d4 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -6599,6 +6599,16 @@ sub process {
 			}
 		}
 
+# warn about msleep() calls with durations that should use ssleep()
+if ($line =~ /\bmsleep\s*\((\d+)\);/) {
+    my $ms_duration = $1;
+    if ($ms_duration >= 1000 && ($ms_duration % 1000) == 0) {
+        my $ss_duration = $ms_duration / 1000;
+        WARN("SSLEEP",
+             "Prefer ssleep($ss_duration) over msleep($ms_duration);\n" . $herecurr);
+    }
+}
+
 # check for comparisons of jiffies
 		if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
 			WARN("JIFFIES_COMPARISON",
-- 
2.44.0