Skip to content

bits: De-bloat expansion of GENMASK()

[email protected] linux-arch linux-mm lkml llvm netdev oe-kbuild-all 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest14 patches 37 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/14overflow: Reduce expansion of __type_max()include/linux/overflow.h+1 -12 replies
2/14kbuild: Add W=c for additional compile time checksscripts/Makefile.warn+10 -25 replies
3/14media: videobuf2-core: Use static_assert() for sanity checkdrivers/media/common/videobuf2/videobuf2-core.c+3 -30 replies
4/14media: atomisp: Use static_assert() for sanity checkdrivers/staging/media/atomisp/pci/isp/kernels/fixedbds/fixedbds_1.0/ia_css_fixedbds_param.h+2 -30 replies
5/14ixgbevf: Use C test for PAGE_SIZE > IXGBE_MAX_DATA_PER_TXDdrivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c+7 -101 reply
6/14asm-generic: include linux/bits.h not vdso/bits.hinclude/asm-generic/thread_info_tif.h+1 -10 replies
7/14x86/tlb: include linux/bits.h not vdso/bits.harch/x86/include/asm/tlb.h+1 -10 replies
8/14bits: simplify GENMASK_TYPE()include/linux/bits.h+1 -22 replies
9/14bits: Change BIT_U8/16() and GENMASK_U8/16() to have unsigned valuesinclude/linux/bits.h lib/tests/test_bits.c+9 -90 replies
10/14bits: Fix assmebler expansions of GENMASK_Uxx() and BIT_Uxx()include/linux/bits.h+17 -164 replies
11/14bit: Strengthen compile-time tests in GENMASK() and BIT()include/linux/bits.h lib/tests/test_bits.c+56 -2315 replies
12/14bits: move the defitions of BIT() and BIT_ULL() back to linux/bits.hinclude/linux/bits.h include/vdso/bits.h+7 -26 replies
13/14test_bits: Change all the tests to be compile-time testslib/tests/test_bits.c+45 -452 replies
14/14test_bits: include some invalid input tests for GENMASK_INPUT_CHECK()lib/tests/test_bits.c+16 -00 replies

Reviews trailers per patch

2 of 14 patches have a Reviewed-by or Acked-by.

PatchKees CookSimon HormanYury Norov
1/14R-b R-b
2/14
3/14
4/14
5/14R-b
6/14
7/14
8/14
9/14
10/14
11/14
12/14
13/14
14/14

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v1 thread

Cover letter [PATCH next 00/14] bits: De-bloat expansion of GENMASK()

From: David Laight <[email protected]>

The expansion of GENMASK() is a few hundred bytes, this is often multiplied when the value is passed to other #defines (eg FIELD_PREP). Part of the size is due to the compile-type check (for reversed arguments), the rest from the way the value is defined.

Nothing in these patches changes the code the compiler sees - just the way the constants get defined.
Changing GENMASK(hi, lo) to (2 << hi) - (1 << lo) is left for further study.

I looked at getting the compiler to check for reversed arguments using (0 >> (hi - lo)) instead of const_true(lo > hi). While checking that it was always optimised away I discovered that you don't get an error message if the values are only 'compile time constants', worse clang starts throwing code away, generation an empty function for:

	int f(u32 x) {int n = 32; return x >> n; }

(Shifts by more than width are 'undefined behaviour', so what clang does is technically valid - but not friendly or expected.)

So I added extra checks to both GENMASK() and BITxxx() to detect this at compile time. But this bloats the output - the opposite of what I was trying to achieve.
However these are all compile-time checks that are actually unlikely to detect anything, they don't need to be done on every build. I've mitigated this by adding W=c (cf W=[123e]) to the main Makefile (adding -DKBUILD_EXTRA_WARNc) and defaulting to W=c for W=1 builds.

Adding checks to BIT() makes it no longer a pre-processor constant so can no longer be used in #if statements (when W=c) is set. This required minor changes to 3 files.

At some point the definition of BIT() was moved to vdso/bits.h (followed by that for BIT_ULL()), but then the fixed size BIT_Unn() were added to bits.h.
I've moved BIT_ULL() back to linux/bits.h and made the version of BIT() in linux/bits.h be preferred if both files get included. Note that the x86-64 allmodconfig build suceeds if vdso/bits.h is empty - everything includes linux/bits.h first.

I found two non-vdso files that included vdso/bits.h and changed them to use linux/bits.h.

GENMASK_U8() and BIT_U8() cast their result to (u8), this isn't a good idea. While the 'type of the expression' is 'u8', integer promotion makes the 'type of the value' 'signed int'. This means that in code like:

	u64 v = BIT_U8(7) << 24;

the value is sign extended and all the high bits are set. Instead change the type of the xxx_U8/U16 macros to 'unsigned int' so that the sign extension cannot happen.
The compile-time check on the bit number is still present.

For assembler files where GENMASK() can be used for constants the expansions from uapi/linux/bits.h were used. However these contain BITS_PER_LONG and BITS_PER_LONG_LONG which make no sense since the assembler doesn't have sized arithmetic. Replace with GENMASK(hi, lo) (2 << (hi)) - (1 << (lo)) which has the correct value without knowing the size of the integers.

The kunit tests all check compile-time values.
I've changed them to use BUILD_BUG_ON().

David Laight (14):
overflow: Reduce expansion of __type_max()
kbuild: Add W=c for additional compile time checks
media: videobuf2-core: Use static_assert() for sanity check
media: atomisp: Use static_assert() for sanity check
ixgbevf: Use C test for PAGE_SIZE > IXGBE_MAX_DATA_PER_TXD
asm-generic: include linux/bits.h not vdso/bits.h
x86/tlb: include linux/bits.h not vdso/bits.h
bits: simplify GENMASK_TYPE()
bits: Change BIT_U8/16() and GENMASK_U8/16() to have unsigned values
bits: Fix assmebler expansions of GENMASK_Uxx() and BIT_Uxx()
bit: Strengthen compile-time tests in GENMASK() and BIT()
bits: move the defitions of BIT() and BIT_ULL() back to linux/bits.h
test_bits: Change all the tests to be compile-time tests
test_bits: include some invalid input tests for GENMASK_INPUT_CHECK()

 arch/x86/include/asm/tlb.h                    |   2 +-
 .../media/common/videobuf2/videobuf2-core.c   |   6 +-
 .../net/ethernet/intel/ixgbevf/ixgbevf_main.c |  17 +--
 .../fixedbds_1.0/ia_css_fixedbds_param.h      |   5 +-
 include/asm-generic/thread_info_tif.h         |   2 +-
 include/linux/bits.h                          |  88 ++++++++----
 include/linux/overflow.h                      |   2 +-
 include/vdso/bits.h                           |   2 +-
 lib/tests/test_bits.c                         | 130 +++++++++++-------
 scripts/Makefile.warn                         |  12 +-
 10 files changed, 162 insertions(+), 104 deletions(-)
Signature · 1 line
2.39.5