overflow: Correct check_shl_overflow() comment
authorKeith Busch <kbusch@kernel.org>
Thu, 1 Apr 2021 16:06:29 +0000 (09:06 -0700)
committerKees Cook <keescook@chromium.org>
Thu, 1 Apr 2021 21:07:41 +0000 (14:07 -0700)
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@ziepe.ca>
Signed-off-by: Keith Busch <kbusch@kernel.org>
Signed-off-by: Kees Cook <keescook@chromium.org>
Fixes: 0c66847793d1 ("overflow.h: Add arithmetic shift helper")
Link: https://lore.kernel.org/r/20210401160629.1941787-1-kbusch@kernel.org
include/linux/overflow.h

index ef74051d5cfed5769d1dcb4786ce6392bf654588..0f12345c21fb58430ea93884c4ad5f4688ad7d18 100644 (file)
@@ -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;                                               \