Message-ID: <20250919101727.16152-23-farbere@amazon.com>
Date: Fri, 19 Sep 2025 10:17:22 +0000
From: Eliav Farber <farbere@...zon.com>
To: <linux@...linux.org.uk>, <jdike@...toit.com>, <richard@....at>,
	<anton.ivanov@...bridgegreys.com>, <dave.hansen@...ux.intel.com>,
	<luto@...nel.org>, <peterz@...radead.org>, <tglx@...utronix.de>,
	<mingo@...hat.com>, <bp@...en8.de>, <x86@...nel.org>, <hpa@...or.com>,
	<tony.luck@...el.com>, <qiuxu.zhuo@...el.com>, <mchehab@...nel.org>,
	<james.morse@....com>, <rric@...nel.org>, <harry.wentland@....com>,
	<sunpeng.li@....com>, <alexander.deucher@....com>,
	<christian.koenig@....com>, <airlied@...ux.ie>, <daniel@...ll.ch>,
	<evan.quan@....com>, <james.qian.wang@....com>, <liviu.dudau@....com>,
	<mihail.atanassov@....com>, <brian.starkey@....com>,
	<maarten.lankhorst@...ux.intel.com>, <mripard@...nel.org>,
	<tzimmermann@...e.de>, <robdclark@...il.com>, <sean@...rly.run>,
	<jdelvare@...e.com>, <linux@...ck-us.net>, <fery@...ress.com>,
	<dmitry.torokhov@...il.com>, <agk@...hat.com>, <snitzer@...hat.com>,
	<dm-devel@...hat.com>, <rajur@...lsio.com>, <davem@...emloft.net>,
	<kuba@...nel.org>, <peppe.cavallaro@...com>, <alexandre.torgue@...com>,
	<joabreu@...opsys.com>, <mcoquelin.stm32@...il.com>, <malattia@...ux.it>,
	<hdegoede@...hat.com>, <mgross@...ux.intel.com>, <intel-linux-scu@...el.com>,
	<artur.paszkiewicz@...el.com>, <jejb@...ux.ibm.com>,
	<martin.petersen@...cle.com>, <sakari.ailus@...ux.intel.com>,
	<gregkh@...uxfoundation.org>, <clm@...com>, <josef@...icpanda.com>,
	<dsterba@...e.com>, <jack@...e.com>, <tytso@....edu>,
	<adilger.kernel@...ger.ca>, <dushistov@...l.ru>,
	<luc.vanoostenryck@...il.com>, <rostedt@...dmis.org>, <pmladek@...e.com>,
	<sergey.senozhatsky@...il.com>, <andriy.shevchenko@...ux.intel.com>,
	<linux@...musvillemoes.dk>, <minchan@...nel.org>, <ngupta@...are.org>,
	<akpm@...ux-foundation.org>, <kuznet@....inr.ac.ru>,
	<yoshfuji@...ux-ipv6.org>, <pablo@...filter.org>, <kadlec@...filter.org>,
	<fw@...len.de>, <jmaloy@...hat.com>, <ying.xue@...driver.com>,
	<willy@...radead.org>, <farbere@...zon.com>, <sashal@...nel.org>,
	<ruanjinjie@...wei.com>, <David.Laight@...LAB.COM>,
	<herve.codina@...tlin.com>, <Jason@...c4.com>, <bvanassche@....org>,
	<keescook@...omium.org>, <linux-arm-kernel@...ts.infradead.org>,
	<linux-kernel@...r.kernel.org>, <linux-um@...ts.infradead.org>,
	<linux-edac@...r.kernel.org>, <amd-gfx@...ts.freedesktop.org>,
	<dri-devel@...ts.freedesktop.org>, <linux-arm-msm@...r.kernel.org>,
	<freedreno@...ts.freedesktop.org>, <linux-hwmon@...r.kernel.org>,
	<linux-input@...r.kernel.org>, <linux-media@...r.kernel.org>,
	<netdev@...r.kernel.org>, <linux-stm32@...md-mailman.stormreply.com>,
	<platform-driver-x86@...r.kernel.org>, <linux-scsi@...r.kernel.org>,
	<linux-staging@...ts.linux.dev>, <linux-btrfs@...r.kernel.org>,
	<linux-ext4@...r.kernel.org>, <linux-sparse@...r.kernel.org>,
	<linux-mm@...ck.org>, <netfilter-devel@...r.kernel.org>,
	<coreteam@...filter.org>, <tipc-discussion@...ts.sourceforge.net>,
	<stable@...r.kernel.org>
CC: <jonnyc@...zon.com>, Arnd Bergmann <arnd@...nel.org>, Christoph Hellwig
	<hch@...radead.org>, Dan Carpenter <dan.carpenter@...aro.org>, Jens Axboe
	<axboe@...nel.dk>, Lorenzo Stoakes <lorenzo.stoakes@...cle.com>, "Mateusz
 Guzik" <mjguzik@...il.com>, Pedro Falcato <pedro.falcato@...il.com>
Subject: [PATCH 22/27 5.10.y] minmax.h: update some comments

From: David Laight <David.Laight@...LAB.COM>

[ Upstream commit 10666e99204818ef45c702469488353b5bb09ec7 ]

- Change three to several.
- Remove the comment about retaining constant expressions, no longer true.
- Realign to nearer 80 columns and break on major punctiation.
- Add a leading comment to the block before __signed_type() and __is_nonneg()
  Otherwise the block explaining the cast is a bit 'floating'.
  Reword the rest of that comment to improve readability.

Link: https://lkml.kernel.org/r/85b050c81c1d4076aeb91a6cded45fee@AcuMS.aculab.com
Signed-off-by: David Laight <david.laight@...lab.com>
Cc: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc: Arnd Bergmann <arnd@...nel.org>
Cc: Christoph Hellwig <hch@...radead.org>
Cc: Dan Carpenter <dan.carpenter@...aro.org>
Cc: Jason A. Donenfeld <Jason@...c4.com>
Cc: Jens Axboe <axboe@...nel.dk>
Cc: Lorenzo Stoakes <lorenzo.stoakes@...cle.com>
Cc: Mateusz Guzik <mjguzik@...il.com>
Cc: Matthew Wilcox <willy@...radead.org>
Cc: Pedro Falcato <pedro.falcato@...il.com>
Signed-off-by: Andrew Morton <akpm@...ux-foundation.org>
Signed-off-by: Eliav Farber <farbere@...zon.com>
---
 include/linux/minmax.h | 53 +++++++++++++++++++-----------------------
 1 file changed, 24 insertions(+), 29 deletions(-)

diff --git a/include/linux/minmax.h b/include/linux/minmax.h
index 51b0d988e322..24e4b372649a 100644
--- a/include/linux/minmax.h
+++ b/include/linux/minmax.h
@@ -8,13 +8,10 @@
 #include <linux/types.h>
 
 /*
- * min()/max()/clamp() macros must accomplish three things:
+ * min()/max()/clamp() macros must accomplish several things:
  *
  * - Avoid multiple evaluations of the arguments (so side-effects like
  *   "x++" happen only once) when non-constant.
- * - Retain result as a constant expressions when called with only
- *   constant expressions (to avoid tripping VLA warnings in stack
- *   allocation usage).
  * - Perform signed v unsigned type-checking (to generate compile
  *   errors instead of nasty runtime surprises).
  * - Unsigned char/short are always promoted to signed int and can be
@@ -31,25 +28,23 @@
  *   bit #0 set if ok for unsigned comparisons
  *   bit #1 set if ok for signed comparisons
  *
- * In particular, statically non-negative signed integer
- * expressions are ok for both.
+ * In particular, statically non-negative signed integer expressions
+ * are ok for both.
  *
- * NOTE! Unsigned types smaller than 'int' are implicitly
- * converted to 'int' in expressions, and are accepted for
- * signed conversions for now. This is debatable.
+ * NOTE! Unsigned types smaller than 'int' are implicitly converted to 'int'
+ * in expressions, and are accepted for signed conversions for now.
+ * This is debatable.
  *
- * Note that 'x' is the original expression, and 'ux' is
- * the unique variable that contains the value.
+ * Note that 'x' is the original expression, and 'ux' is the unique variable
+ * that contains the value.
  *
- * We use 'ux' for pure type checking, and 'x' for when
- * we need to look at the value (but without evaluating
- * it for side effects! Careful to only ever evaluate it
- * with sizeof() or __builtin_constant_p() etc).
+ * We use 'ux' for pure type checking, and 'x' for when we need to look at the
+ * value (but without evaluating it for side effects!
+ * Careful to only ever evaluate it with sizeof() or __builtin_constant_p() etc).
  *
- * Pointers end up being checked by the normal C type
- * rules at the actual comparison, and these expressions
- * only need to be careful to not cause warnings for
- * pointer use.
+ * Pointers end up being checked by the normal C type rules at the actual
+ * comparison, and these expressions only need to be careful to not cause
+ * warnings for pointer use.
  */
 #define __signed_type_use(x, ux) (2 + __is_nonneg(x, ux))
 #define __unsigned_type_use(x, ux) (1 + 2 * (sizeof(ux) < 4))
@@ -57,19 +52,19 @@
 	__signed_type_use(x, ux) : __unsigned_type_use(x, ux))
 
 /*
- * To avoid warnings about casting pointers to integers
- * of different sizes, we need that special sign type.
+ * Check whether a signed value is always non-negative.
  *
- * On 64-bit we can just always use 'long', since any
- * integer or pointer type can just be cast to that.
+ * A cast is needed to avoid any warnings from values that aren't signed
+ * integer types (in which case the result doesn't matter).
  *
- * This does not work for 128-bit signed integers since
- * the cast would truncate them, but we do not use s128
- * types in the kernel (we do use 'u128', but they will
- * be handled by the !is_signed_type() case).
+ * On 64-bit any integer or pointer type can safely be cast to 'long'.
+ * But on 32-bit we need to avoid warnings about casting pointers to integers
+ * of different sizes without truncating 64-bit values so 'long' or 'long long'
+ * must be used depending on the size of the value.
  *
- * NOTE! The cast is there only to avoid any warnings
- * from when values that aren't signed integer types.
+ * This does not work for 128-bit signed integers since the cast would truncate
+ * them, but we do not use s128 types in the kernel (we do use 'u128',
+ * but they are handled by the !is_signed_type() case).
  */
 #ifdef CONFIG_64BIT
   #define __signed_type(ux) long
-- 
2.47.3

Powered by blists - more mailing lists