tools headers: Synchronize linux/bits.h with the kernel sources
PATCH 1/1 tools headers: Synchronize linux/bits.h with the kernel sources
tldr; Just FYI, I'm carrying this on the perf tools tree.
Full explanation:
There used to be no copies, with tools/ code using kernel headers directly. From time to time tools/perf/ broke due to legitimate kernel hacking. At some point Linus complained about such direct usage. Then we adopted the current model.
See further details at:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/include/uapi/README
To pick up the changes in this cset:
5b572e8a9f3dcd6e ("bits: introduce fixed-type BIT_U*()")
19408200c094858d ("bits: introduce fixed-type GENMASK_U*()") 31299a5e02112411 ("bits: add comments and newlines to #if, #else and #endif directives")
This addresses these perf build warnings:
Warning: Kernel ABI header differences:
diff -u tools/include/linux/bits.h include/linux/bits.h
Please see tools/include/uapi/README for further details.
--- tools/include/linux/bits.h | 57 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-)
tools/include/linux/bits.h +55 -2
@@ -12,6 +12,7 @@#define BIT_ULL_MASK (nr) (ULL(1) << ((nr) % BITS_PER_LONG_LONG))#define BIT_ULL_WORD (nr) ((nr) / BITS_PER_LONG_LONG)#define BITS_PER_BYTE 8 +#define BITS_PER_TYPE (type) (sizeof(type) * BITS_PER_BYTE)/* * Create a contiguous bitmask starting at bit position @l and ending at
@@ -19,16 +20,68 @@* GENMASK_ULL(39, 21) gives us the 64bit vector 0x000000ffffe00000. */ #if !defined(__ASSEMBLY__) + +/* +* Missing asm support +* +* GENMASK_U*() and BIT_U*() depend on BITS_PER_TYPE() which relies on sizeof(), +* something not available in asm. Nevertheless, fixed width integers is a C +* concept. Assembly code can rely on the long and long long versions instead. +*/ +#include <linux/build_bug.h> #include <linux/compiler.h> +#include <linux/overflow.h> +#define GENMASK_INPUT_CHECK (h, l) BUILD_BUG_ON_ZERO(const_true((l) > (h))) -#else + +/* +* Generate a mask for the specified type @t. Additional checks are made to +* guarantee the value returned fits in that type, relying on +* -Wshift-count-overflow compiler check to detect incompatible arguments. +* For example, all these create build errors or warnings: +* +* - GENMASK(15, 20): wrong argument order +* - GENMASK(72, 15): doesn't fit unsigned long +* - GENMASK_U32(33, 15): doesn't fit in a u32 +*/ +#define GENMASK_TYPE (t, h, l) \ + ((t)(GENMASK_INPUT_CHECK(h, l) + \ + (type_max(t) << (l) & \ + type_max(t) >> (BITS_PER_TYPE(t) - 1 - (h))))) + +#define GENMASK_U8 (h, l) GENMASK_TYPE(u8, h, l) +#define GENMASK_U16 (h, l) GENMASK_TYPE(u16, h, l) +#define GENMASK_U32 (h, l) GENMASK_TYPE(u32, h, l) +#define GENMASK_U64 (h, l) GENMASK_TYPE(u64, h, l) + +/* +* Fixed-type variants of BIT(), with additional checks like GENMASK_TYPE(). The +* following examples generate compiler warnings due to -Wshift-count-overflow: +* +* - BIT_U8(8) +* - BIT_U32(-1) +* - BIT_U32(40) +*/ +#define BIT_INPUT_CHECK (type, nr) \ + BUILD_BUG_ON_ZERO(const_true((nr) >= BITS_PER_TYPE(type))) + +#define BIT_TYPE (type, nr) ((type)(BIT_INPUT_CHECK(type, nr) + BIT_ULL(nr))) + +#define BIT_U8 (nr) BIT_TYPE(u8, nr) +#define BIT_U16 (nr) BIT_TYPE(u16, nr) +#define BIT_U32 (nr) BIT_TYPE(u32, nr) +#define BIT_U64 (nr) BIT_TYPE(u64, nr) + +#else /* defined(__ASSEMBLY__) */ +/* * BUILD_BUG_ON_ZERO is not available in h files included from asm files, * disable the input check if that is the case. */ #define GENMASK_INPUT_CHECK (h, l) 0 -#endif + +#endif /* !defined(__ASSEMBLY__) */ #define GENMASK (h, l) \ (GENMASK_INPUT_CHECK(h, l) + __GENMASK(h, l))
Signature · 1 line
2.49.0
Quoted 26 lines · Arnaldo Carvalho de Melo
tldr; Just FYI, I'm carrying this on the perf tools tree.
Full explanation:
There used to be no copies, with
tools/code using kernel headers directly. From time to timetools/perf/broke due to legitimate kernel hacking. At some point Linus complained about such direct usage. Then we adopted the current model.See further details at:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/include/uapi/README
To pick up the changes in this cset:
5b572e8a9f3dcd6e("bits: introduce fixed-type BIT_U*()")
19408200c094858d("bits: introduce fixed-type GENMASK_U*()")31299a5e02112411("bits: add comments and newlines to #if, #else and #endif directives")This addresses these perf build warnings:
Warning: Kernel ABI header differences:
diff -utools/include/linux/bits.hinclude/linux/bits.hPlease see
tools/include/uapi/READMEfor further details.
Quoted 11 lines
Cc Adrian Hunter <[email protected]>Cc Ian Rogers <[email protected]>Cc James Clark <[email protected]>Cc Jiri Olsa <[email protected]>Cc Kan Liang <[email protected]>Cc Lucas De Marchi <[email protected]>Cc Namhyung Kim <[email protected]>Cc Vincent Mailhol <[email protected]>Cc Yury Norov <[email protected]>Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
For what it is worth:
Yours sincerely,
Vincent Mailhol
Quoted 26 lines · Vincent Mailhol
Quoted 13 lines · Arnaldo Carvalho de Melo
To pick up the changes in this cset:
5b572e8a9f3dcd6e("bits: introduce fixed-type BIT_U*()")
19408200c094858d("bits: introduce fixed-type GENMASK_U*()")31299a5e02112411("bits: add comments and newlines to #if, #else and #endif directives")This addresses these perf build warnings:
Warning: Kernel ABI header differences:
diff -utools/include/linux/bits.hinclude/linux/bits.hPlease see
tools/include/uapi/READMEfor further details.Quoted 11 lines
Cc Adrian Hunter <[email protected]>Cc Ian Rogers <[email protected]>Cc James Clark <[email protected]>Cc Jiri Olsa <[email protected]>Cc Kan Liang <[email protected]>Cc Lucas De Marchi <[email protected]>Cc Namhyung Kim <[email protected]>Cc Vincent Mailhol <[email protected]>Cc Yury Norov <[email protected]>Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
Quoted 3 lines
For what it is worth:
Acked-by Vincent Mailhol <[email protected]>
Very much appreciated, added to the cset.
- Arnaldo
Quoted 27 lines · Arnaldo Carvalho de Melo
Quoted 25 lines · Vincent Mailhol
Quoted 24 lines · Arnaldo Carvalho de Melo
To pick up the changes in this cset:
5b572e8a9f3dcd6e("bits: introduce fixed-type BIT_U*()")
19408200c094858d("bits: introduce fixed-type GENMASK_U*()")31299a5e02112411("bits: add comments and newlines to #if, #else and #endif directives")This addresses these perf build warnings:
Warning: Kernel ABI header differences:
diff -utools/include/linux/bits.hinclude/linux/bits.hPlease see
tools/include/uapi/READMEfor further details.Cc Adrian Hunter <[email protected]>Cc Ian Rogers <[email protected]>Cc James Clark <[email protected]>Cc Jiri Olsa <[email protected]>Cc Kan Liang <[email protected]>Cc Lucas De Marchi <[email protected]>Cc Namhyung Kim <[email protected]>Cc Vincent Mailhol <[email protected]>Cc Yury Norov <[email protected]>Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
Quoted 5 lines
Quoted 3 lines
For what it is worth:
Acked-by Vincent Mailhol <[email protected]>Very much appreciated, added to the cset.
But then there is one more:
1e7933a575ed8af4 ("uapi: Revert "bitops: avoid integer overflow in GENMASK(_ULL)"")I updated the sync with this extra one.
- Arnaldo