linux-kernel - [PATCH v3 1/4 5.10.y] overflow: Correct check_shl

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-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250912185518.39980-2-farbere@amazon.com>
Date: Fri, 12 Sep 2025 18:55:13 +0000
From: Eliav Farber <farbere@...zon.com>
To: <luc.vanoostenryck@...il.com>, <rostedt@...dmis.org>, <mingo@...hat.com>,
	<natechancellor@...il.com>, <ndesaulniers@...gle.com>,
	<keescook@...omium.org>, <sashal@...nel.org>, <akpm@...ux-foundation.org>,
	<ojeda@...nel.org>, <elver@...gle.com>, <gregkh@...uxfoundation.org>,
	<kbusch@...nel.org>, <sj@...nel.org>, <bvanassche@....org>,
	<leon@...nel.org>, <jgg@...pe.ca>, <linux-kernel@...r.kernel.org>,
	<linux-sparse@...r.kernel.org>, <clang-built-linux@...glegroups.com>,
	<stable@...r.kernel.org>
CC: <jonnyc@...zon.com>, <farbere@...zon.com>
Subject: [PATCH v3 1/4 5.10.y] overflow: Correct check_shl_overflow() comment

From: Keith Busch <kbusch@...nel.org>

[ Upstream commit 4578be130a6470d85ff05b13b75a00e6224eeeeb ]

A 'false' return means the value was safely set, so the comment should
say 'true' for when it is not considered safe.

Cc: Jason Gunthorpe <jgg@...pe.ca>
Signed-off-by: Keith Busch <kbusch@...nel.org>
Signed-off-by: Kees Cook <keescook@...omium.org>
Signed-off-by: Eliav Farber <farbere@...zon.com>
Fixes: 0c66847793d1 ("overflow.h: Add arithmetic shift helper")
Link: https://lore.kernel.org/r/20210401160629.1941787-1-kbusch@kernel.org
---
 include/linux/overflow.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/overflow.h b/include/linux/overflow.h
index 35af574d006f..d1dd039fe1c3 100644
--- a/include/linux/overflow.h
+++ b/include/linux/overflow.h
@@ -235,7 +235,7 @@ static inline bool __must_check __must_check_overflow(bool overflow)
  * - 'a << s' sets the sign bit, if any, in '*d'.
  *
  * '*d' will hold the results of the attempted shift, but is not
- * considered "safe for use" if false is returned.
+ * considered "safe for use" if true is returned.
  */
 #define check_shl_overflow(a, s, d) __must_check_overflow(({		\
 	typeof(a) _a = a;						\
-- 
2.47.3