Skip to content

Commit 1940820

Browse files
vincent-mailholYuryNorov
authored andcommitted
bits: introduce fixed-type GENMASK_U*()
Add GENMASK_TYPE() which generalizes __GENMASK() to support different types, and implement fixed-types versions of GENMASK() based on it. The fixed-type version allows more strict checks to the min/max values accepted, which is useful for defining registers like implemented by i915 and xe drivers with their REG_GENMASK*() macros. The strict checks rely on shift-count-overflow compiler check to fail the build if a number outside of the range allowed is passed. Example: #define FOO_MASK GENMASK_U32(33, 4) will generate a warning like: include/linux/bits.h:51:27: error: right shift count >= width of type [-Werror=shift-count-overflow] 51 | type_max(t) >> (BITS_PER_TYPE(t) - 1 - (h))))) | ^~ The result is casted to the corresponding fixed width type. For example, GENMASK_U8() returns an u8. Note that because of the C promotion rules, GENMASK_U8() and GENMASK_U16() will immediately be promoted to int if used in an expression. Regardless, the main goal is not to get the correct type, but rather to enforce more checks at compile time. While GENMASK_TYPE() is crafted to cover all variants, including the already existing GENMASK(), GENMASK_ULL() and GENMASK_U128(), for the moment, only use it for the newly introduced GENMASK_U*(). The consolidation will be done in a separate change. Co-developed-by: Yury Norov <yury.norov@gmail.com> Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com> Acked-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Yury Norov <yury.norov@gmail.com>
1 parent 31299a5 commit 1940820

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

include/linux/bitops.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
#include <uapi/linux/kernel.h>
1010

11-
#define BITS_PER_TYPE(type) (sizeof(type) * BITS_PER_BYTE)
1211
#define BITS_TO_LONGS(nr) __KERNEL_DIV_ROUND_UP(nr, BITS_PER_TYPE(long))
1312
#define BITS_TO_U64(nr) __KERNEL_DIV_ROUND_UP(nr, BITS_PER_TYPE(u64))
1413
#define BITS_TO_U32(nr) __KERNEL_DIV_ROUND_UP(nr, BITS_PER_TYPE(u32))

include/linux/bits.h

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
#define BIT_ULL_MASK(nr) (ULL(1) << ((nr) % BITS_PER_LONG_LONG))
1313
#define BIT_ULL_WORD(nr) ((nr) / BITS_PER_LONG_LONG)
1414
#define BITS_PER_BYTE 8
15+
#define BITS_PER_TYPE(type) (sizeof(type) * BITS_PER_BYTE)
1516

1617
/*
1718
* Create a contiguous bitmask starting at bit position @l and ending at
@@ -20,11 +21,40 @@
2021
*/
2122
#if !defined(__ASSEMBLY__)
2223

24+
/*
25+
* Missing asm support
26+
*
27+
* GENMASK_U*() depend on BITS_PER_TYPE() which relies on sizeof(),
28+
* something not available in asm. Nevertheless, fixed width integers is a C
29+
* concept. Assembly code can rely on the long and long long versions instead.
30+
*/
31+
2332
#include <linux/build_bug.h>
2433
#include <linux/compiler.h>
34+
#include <linux/overflow.h>
2535

2636
#define GENMASK_INPUT_CHECK(h, l) BUILD_BUG_ON_ZERO(const_true((l) > (h)))
2737

38+
/*
39+
* Generate a mask for the specified type @t. Additional checks are made to
40+
* guarantee the value returned fits in that type, relying on
41+
* -Wshift-count-overflow compiler check to detect incompatible arguments.
42+
* For example, all these create build errors or warnings:
43+
*
44+
* - GENMASK(15, 20): wrong argument order
45+
* - GENMASK(72, 15): doesn't fit unsigned long
46+
* - GENMASK_U32(33, 15): doesn't fit in a u32
47+
*/
48+
#define GENMASK_TYPE(t, h, l) \
49+
((t)(GENMASK_INPUT_CHECK(h, l) + \
50+
(type_max(t) << (l) & \
51+
type_max(t) >> (BITS_PER_TYPE(t) - 1 - (h)))))
52+
53+
#define GENMASK_U8(h, l) GENMASK_TYPE(u8, h, l)
54+
#define GENMASK_U16(h, l) GENMASK_TYPE(u16, h, l)
55+
#define GENMASK_U32(h, l) GENMASK_TYPE(u32, h, l)
56+
#define GENMASK_U64(h, l) GENMASK_TYPE(u64, h, l)
57+
2858
#else /* defined(__ASSEMBLY__) */
2959

3060
/*

0 commit comments

Comments
 (0)