From: david.laight.linux@gmail.com
To: Yury Norov <yury.norov@gmail.com>,
Rasmus Villemoes <linux@rasmusvillemoes.dk>,
linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org,
Geert Uytterhoeven <geert+renesas@glider.be>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Crt Mori <cmo@melexis.com>,
Richard Genoud <richard.genoud@bootlin.com>,
Andy Shevchenko <andriy.shevchenko@intel.com>,
Luo Jie <quic_luoj@quicinc.com>,
Peter Zijlstra <peterz@infradead.org>,
Jakub Kicinski <kuba@kernel.org>,
netdev@vger.kernel.org, "David S . Miller" <davem@davemloft.net>,
Simon Horman <simon.horman@netronome.com>,
Mika Westerberg <mika.westerberg@linux.intel.com>,
Andreas Noever <andreas.noever@gmail.com>,
Yehezkel Bernat <YehezkelShB@gmail.com>,
Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
Cc: David Laight <david.laight.linux@gmail.com>
Subject: [PATCH 6/9] bitfield: Update sanity checks
Date: Tue, 9 Dec 2025 10:03:10 +0000 [thread overview]
Message-ID: <20251209100313.2867-7-david.laight.linux@gmail.com> (raw)
In-Reply-To: <20251209100313.2867-1-david.laight.linux@gmail.com>
From: David Laight <david.laight.linux@gmail.com>
Simplify the check for 'reg' being large enough to hold 'mask' using
sizeof (reg) rather than a convoluted scheme to generate an unsigned
type the same size as 'reg'.
There are three places where the mask is checked for being non-zero
and contiguous. Add a simple expression that checks it and use in
all three places.
Three of the five calls to __BF_FIELD_CHECK_MASK() don't have a 'value'
to check, separate out as was done to __BF_FIELD_CHECK_REG().
There is no point checking a 'val' of zero or a 'reg' of 0ULL (both
are placeholders) - remove/change the calls.
There should be a check of __BF_FIELD_CHECK_REG() when __BF_FIELD_GET()
is called from field_get().
Move the check from FIELD_GET() into __BF_FIELD_GET().
Delete the now-unused __BF_FIELD_CHECK().
Signed-off-by: David Laight <david.laight.linux@gmail.com>
---
include/linux/bitfield.h | 74 ++++++++++++++--------------------------
1 file changed, 26 insertions(+), 48 deletions(-)
diff --git a/include/linux/bitfield.h b/include/linux/bitfield.h
index 3e0e8533bb66..7e8d436b6571 100644
--- a/include/linux/bitfield.h
+++ b/include/linux/bitfield.h
@@ -45,55 +45,38 @@
#define __bf_shf(x) (__builtin_ffsll(x) - 1)
-#define __scalar_type_to_unsigned_cases(type) \
- unsigned type: (unsigned type)0, \
- signed type: (unsigned type)0
+#define __BF_VALIDATE_MASK(mask) \
+ (!(mask) || ((mask) & ((mask) + ((mask) & -(mask)))))
-#define __unsigned_scalar_typeof(x) typeof( \
- _Generic((x), \
- char: (unsigned char)0, \
- __scalar_type_to_unsigned_cases(char), \
- __scalar_type_to_unsigned_cases(short), \
- __scalar_type_to_unsigned_cases(int), \
- __scalar_type_to_unsigned_cases(long), \
- __scalar_type_to_unsigned_cases(long long), \
- default: (x)))
-
-#define __bf_cast_unsigned(type, x) ((__unsigned_scalar_typeof(type))(x))
-
-#define __BF_FIELD_CHECK_MASK(mask, val, pfx) \
- ({ \
+#define __BF_FIELD_CHECK_MASK(mask, pfx) \
+ do { \
BUILD_BUG_ON_MSG(!__builtin_constant_p(mask), \
pfx "mask is not constant"); \
- BUILD_BUG_ON_MSG((mask) == 0, _pfx "mask is zero"); \
- BUILD_BUG_ON_MSG(__builtin_constant_p(val) ? \
- ~((mask) >> __bf_shf(mask)) & \
- (0 + (val)) : 0, \
- pfx "value too large for the field"); \
- __BUILD_BUG_ON_NOT_POWER_OF_2((mask) + \
- (1ULL << __bf_shf(mask))); \
- })
+ BUILD_BUG_ON_MSG(__BF_VALIDATE_MASK(mask), \
+ pfx "mask is zero or not contiguous"); \
+ } while (0)
+
+#define __BF_FIELD_CHECK_VAL(mask, val, pfx) \
+ BUILD_BUG_ON_MSG(__builtin_constant_p(val) && \
+ ~((mask) >> __bf_shf(mask)) & (val), \
+ pfx "value too large for the field")
#define __BF_FIELD_CHECK_REG(mask, reg, pfx) \
- BUILD_BUG_ON_MSG(__bf_cast_unsigned(mask, mask) > \
- __bf_cast_unsigned(reg, ~0ull), \
+ BUILD_BUG_ON_MSG(mask + 0U + 0UL + 0ULL > \
+ ~0ULL >> (64 - 8 * sizeof (reg)), \
pfx "type of reg too small for mask")
-#define __BF_FIELD_CHECK(mask, reg, val, pfx) \
- ({ \
- __BF_FIELD_CHECK_MASK(mask, val, pfx); \
- __BF_FIELD_CHECK_REG(mask, reg, pfx); \
- })
-
#define __BF_FIELD_PREP(mask, val, pfx) \
({ \
- __BF_FIELD_CHECK_MASK(mask, val, pfx); \
+ __BF_FIELD_CHECK_MASK(mask, pfx); \
+ __BF_FIELD_CHECK_VAL(mask, val, pfx); \
((val) << __bf_shf(mask)) & (mask); \
})
#define __BF_FIELD_GET(mask, reg, pfx) \
({ \
- __BF_FIELD_CHECK_MASK(mask, 0U, pfx); \
+ __BF_FIELD_CHECK_MASK(mask, pfx); \
+ __BF_FIELD_CHECK_REG(mask, reg, pfx); \
((reg) & (mask)) >> __bf_shf(mask); \
})
@@ -107,7 +90,7 @@
#define FIELD_MAX(mask) \
({ \
__auto_type _mask = mask; \
- __BF_FIELD_CHECK(_mask, 0ULL, 0ULL, "FIELD_MAX: "); \
+ __BF_FIELD_CHECK_MASK(_mask, "FIELD_MAX: "); \
(_mask >> __bf_shf(_mask)); \
})
@@ -122,7 +105,7 @@
({ \
__auto_type _mask = mask; \
__auto_type _val = 1 ? (val) : _mask; \
- __BF_FIELD_CHECK(_mask, 0ULL, 0ULL, "FIELD_FIT: "); \
+ __BF_FIELD_CHECK_MASK(_mask, "FIELD_FIT: "); \
!((_val << __bf_shf(_mask)) & ~_mask); \
})
@@ -138,12 +121,9 @@
({ \
__auto_type _mask = mask; \
__auto_type _val = 1 ? (val) : _mask; \
- __BF_FIELD_CHECK_REG(_mask, 0ULL, "FIELD_PREP: "); \
__BF_FIELD_PREP(_mask, _val, "FIELD_PREP: "); \
})
-#define __BF_CHECK_POW2(n) BUILD_BUG_ON_ZERO(((n) & ((n) - 1)) != 0)
-
/**
* FIELD_PREP_CONST() - prepare a constant bitfield element
* @mask: shifted mask defining the field's length and position
@@ -158,12 +138,10 @@
*/
#define FIELD_PREP_CONST(mask, val) \
( \
- /* mask must be non-zero */ \
- BUILD_BUG_ON_ZERO((mask) == 0) + \
+ /* mask must be non-zero and contiguous */ \
+ BUILD_BUG_ON_ZERO(__BF_VALIDATE_MASK(mask)) + \
/* check if value fits */ \
BUILD_BUG_ON_ZERO(~((mask) >> __bf_shf(mask)) & (val)) + \
- /* check if mask is contiguous */ \
- __BF_CHECK_POW2((mask) + (1ULL << __bf_shf(mask))) + \
/* and create the value */ \
(((typeof(mask))(val) << __bf_shf(mask)) & (mask)) \
)
@@ -180,7 +158,6 @@
({ \
__auto_type _mask = mask; \
__auto_type _reg = reg; \
- __BF_FIELD_CHECK_REG(_mask, _reg, "FIELD_GET: "); \
__BF_FIELD_GET(_mask, _reg, "FIELD_GET: "); \
})
@@ -198,8 +175,9 @@
__auto_type _mask = mask; \
__auto_type _reg_p = reg_p; \
__auto_type _val = 1 ? (val) : _mask; \
- typecheck_pointer(_reg_p); \
- __BF_FIELD_CHECK(_mask, *_reg_p, _val, "FIELD_MODIFY: "); \
+ __BF_FIELD_CHECK_MASK(_mask, "FIELD_MODIFY: "); \
+ __BF_FIELD_CHECK_VAL(_mask, _val, "FIELD_MODIFY: "); \
+ __BF_FIELD_CHECK_REG(_mask, *_reg_p, "FIELD_MODIFY: "); \
*_reg_p = (*_reg_p & ~_mask) | ((_val << __bf_shf(_mask)) & _mask); \
})
@@ -209,7 +187,7 @@ extern void __compiletime_error("bad bitfield mask")
__bad_mask(void);
static __always_inline u64 field_multiplier(u64 field)
{
- if ((field | (field - 1)) & ((field | (field - 1)) + 1))
+ if (__BF_VALIDATE_MASK(field))
__bad_mask();
return field & -field;
}
--
2.39.5
next prev parent reply other threads:[~2025-12-09 10:03 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-09 10:03 [PATCH 0/9] bitfield: tidy up bitfield.h david.laight.linux
2025-12-09 10:03 ` [PATCH 1/9] nfp: Call FIELD_PREP() in NFP_ETH_SET_BIT_CONFIG() wrapper david.laight.linux
2025-12-10 9:29 ` Jakub Kicinski
2025-12-10 10:04 ` David Laight
2025-12-09 10:03 ` [PATCH 2/9] thunderblot: Don't pass a bitfield to FIELD_GET david.laight.linux
2025-12-10 5:56 ` Mika Westerberg
2025-12-10 9:34 ` David Laight
2025-12-10 9:41 ` Mika Westerberg
2025-12-10 10:18 ` David Laight
2025-12-10 18:13 ` Yury Norov
2025-12-10 20:23 ` David Laight
2025-12-09 10:03 ` [PATCH 3/9] bitmap: Use FIELD_PREP() in expansion of FIELD_PREP_WM16() david.laight.linux
2025-12-09 15:46 ` Andy Shevchenko
2025-12-09 18:54 ` David Laight
2025-12-10 19:18 ` Nicolas Frattaroli
2025-12-10 20:59 ` David Laight
2025-12-11 12:50 ` Nicolas Frattaroli
2025-12-11 17:52 ` David Laight
2025-12-09 10:03 ` [PATCH 4/9] bitfield: Copy #define parameters to locals david.laight.linux
2025-12-09 15:51 ` Andy Shevchenko
2025-12-09 19:11 ` David Laight
2025-12-09 21:54 ` Andy Shevchenko
2025-12-10 18:45 ` Yury Norov
2025-12-09 10:03 ` [PATCH 5/9] bitfield: FIELD_MODIFY: Only do a single read/write on the target david.laight.linux
2025-12-09 10:03 ` david.laight.linux [this message]
2025-12-09 10:03 ` [PATCH 7/9] bitfield: Reduce indentation david.laight.linux
2025-12-09 10:03 ` [PATCH 8/9] bitfield: Add comment block for the host/fixed endian functions david.laight.linux
2025-12-09 15:53 ` Andy Shevchenko
2025-12-10 9:23 ` Jakub Kicinski
2025-12-10 10:08 ` David Laight
2025-12-11 5:26 ` Jakub Kicinski
2025-12-09 10:03 ` [PATCH 9/9] bitfield: Update comments for le/be functions david.laight.linux
2025-12-10 18:20 ` [PATCH 0/9] bitfield: tidy up bitfield.h Yury Norov
2025-12-10 22:40 ` David Laight
2025-12-11 10:51 ` David Laight
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251209100313.2867-7-david.laight.linux@gmail.com \
--to=david.laight.linux@gmail.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=YehezkelShB@gmail.com \
--cc=alexandre.belloni@bootlin.com \
--cc=andreas.noever@gmail.com \
--cc=andriy.shevchenko@intel.com \
--cc=cmo@melexis.com \
--cc=davem@davemloft.net \
--cc=geert+renesas@glider.be \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=linux@rasmusvillemoes.dk \
--cc=mika.westerberg@linux.intel.com \
--cc=netdev@vger.kernel.org \
--cc=nicolas.frattaroli@collabora.com \
--cc=peterz@infradead.org \
--cc=quic_luoj@quicinc.com \
--cc=richard.genoud@bootlin.com \
--cc=simon.horman@netronome.com \
--cc=yury.norov@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).