x86: fix bitops.h warning with a moved cast
Subsystems (4)
PATCH v2 1/2 x86: fix bitops.h warning with a moved cast
Fix many sparse warnings when building with C=1.
When the kernel is compiled with C=1, there are lots of messages like:
arch/x86/include/asm/bitops.h:77:37: warning: cast truncates bits from constant value (ffffff7f becomes 7f)
CONST_MASK() is using a signed integer "1" to create the mask which is later cast to (u8) when used. Move the cast to the definition so and use local variables so sparse and the compiler can see the correct type.
Verified with a test module (see next patch) and assembly inspection that the patch doesn't introduce any change in generated code.
---
v2: use correct CC: list
--- arch/x86/include/asm/bitops.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-)
arch/x86/include/asm/bitops.h +7 -3
@@ -46,15 +46,17 @@* a mask operation on a byte. */ #define CONST_MASK_ADDR (nr, addr) WBYTE_ADDR((void *)(addr) + ((nr)>>3)) -#define CONST_MASK (nr) (1 << ((nr) & 7)) +#define CONST_MASK (nr) ((u8)1 << ((nr) & 7)) static __always_inline voidarch_set_bit (long nr,volatile unsigned long *addr) {if (__builtin_constant_p (nr)) { +u8 cmask =CONST_MASK (nr); + asm volatile(LOCK_PREFIX "orb %1,%0" : CONST_MASK_ADDR(nr, addr) - : "iq" ((u8)CONST_MASK(nr)) + : "iq" (cmask) : "memory"); }else { asm volatile(LOCK_PREFIX __ASM_SIZE(bts) " %1,%0"
@@ -72,9 +74,11 @@ static __always_inline void arch_clear_bit(long nr, volatile unsigned long *addr) {if (__builtin_constant_p (nr)) { +u8 cmaski = ~CONST_MASK (nr); + asm volatile(LOCK_PREFIX "andb %1,%0" : CONST_MASK_ADDR(nr, addr) - : "iq" ((u8)~CONST_MASK(nr))); + : "iq" (cmaski)); }else { asm volatile(LOCK_PREFIX __ASM_SIZE(btr) " %1,%0" : : RLONG_ADDR(addr), "Ir" (nr) : "memory");
Signature · 1 line
2.24.1
PATCH v2 2/2 lib: make a test module with set/clear bit
Test some bit clears/sets to make sure assembly doesn't change. Instruct Kbuild to build this file with extra warning level -Wextra, to catch new issues, and also doesn't hurt to build with C=1.
This was used to test changes to arch/x86/include/asm/bitops.h.
Recommended usage:
make defconfigscripts/config -m CONFIG_TEST_BITOPS
make modules_prepare
make C=1 W=1 lib/test_bitops.ko
objdump -S -d lib/test_bitops.ko
---
v2: use correct CC: list
--- lib/Kconfig.debug | 13 ++++++++++++ lib/Makefile | 2 ++ lib/test_bitops.c | 34 ++++++++++++++++++++++++++++++ tools/testing/selftests/lib/config | 1 + 4 files changed, 50 insertions(+) create mode 100644 lib/test_bitops.c
lib/Kconfig.debug +13 -0
@@ -1947,6 +1947,19 @@ config TEST_LKM If unsure, say N. +config TEST_BITOPS + tristate "Test module for compilation of clear_bit/set_bit operations" + depends on m + help + This builds the "test_bitops" module that is much like the + TEST_LKM module except that it does a basic exercise of the + clear_bit and set_bit macros to make sure there are no compiler + warnings from C=1 sparse checker or -Wextra compilations. It has + no dependencies and doesn't run or load unless explicitly requested + by name. for example: modprobe test_bitops. + + If unsure, say N. + config TEST_VMALLOC tristate "Test module for stress/performance analysis of vmalloc allocator" default n
lib/Makefile +2 -0
@@ -89,6 +89,8 @@ obj-$(CONFIG_TEST_OBJAGG) += test_objagg.o obj-$(CONFIG_TEST_STACKINIT) += test_stackinit.o obj-$(CONFIG_TEST_BLACKHOLE_DEV) += test_blackhole_dev.o obj-$(CONFIG_TEST_MEMINIT) += test_meminit.o +obj-$(CONFIG_TEST_BITOPS) += test_bitops.o +CFLAGS_test_bitops.o += -Werror obj-$(CONFIG_TEST_LIVEPATCH) += livepatch/
lib/test_bitops.c new file +34 -0
@@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0-only +#define pr_fmt (fmt) KBUILD_MODNAME ": " fmt + +#include <linux/init.h> +#include <linux/module.h> +#include <linux/printk.h> + +/* a tiny module only meant to compile-test set/clear_bit */ + +static DECLARE_BITMAP(g_bitmap, 80); + +static int __init test_bitops_startup (void ) +{ +pr_warn ("Loaded test module\n" ); +set_bit (4 , g_bitmap); +set_bit (11 , g_bitmap); +set_bit (40 , g_bitmap); +return 0 ; +} + +static void __exit test_bitops_unstartup(void) +{ +clear_bit (4 , g_bitmap); +clear_bit (11 , g_bitmap); +clear_bit (40 , g_bitmap); +pr_warn ("Unloaded test module\n" ); +} + +module_init (test_bitops_startup); +module_exit (test_bitops_unstartup); + +MODULE_AUTHOR ("Jesse Brandeburg <[email protected]>" ); +MODULE_LICENSE ("GPL" ); +MODULE_DESCRIPTION ("Bit testing module" );
tools/testing/selftests/lib/config +1 -0
@@ -2,3 +2,4 @@ CONFIG_TEST_PRINTF=m CONFIG_TEST_BITMAP=m CONFIG_PRIME_NUMBERS=m CONFIG_TEST_STRSCPY=m +CONFIG_TEST_BITOPS=m
Signature · 1 line
2.24.1
Re: [PATCH v2 2/2] lib: make a test module with set/clear bit
Quoted 4 lines · Jesse Brandeburg
Test some bit clears/sets to make sure assembly doesn't change. Instruct
Kbuildto build this file with extra warning level -Wextra, to catch new issues, and also doesn't hurt to build with C=1.
Quoted 8 lines
This was used to test changes to
arch/x86/include/asm/bitops.h.Recommended usage:
make defconfigscripts/config-mCONFIG_TEST_BITOPS
makemodules_prepare
make C=1 W=1lib/test_bitops.ko
objdump -S -dlib/test_bitops.ko
I only applied this second patch:
# sparse --version 0.6.0 (Debian: 0.6.0-3+b1)
# grep TEST_BITOPS defconfig-build/.config CONFIG_TEST_BITOPS=m
# make C=1 W=1 O=defconfig-build/ lib/test_bitops.ko make[1]: Entering directory '/usr/src/linux-2.6/defconfig-build' GEN Makefile HOSTCC scripts/basic/fixdep HOSTCC arch/x86/tools/relocs_32.o HOSTCC arch/x86/tools/relocs_64.o HOSTCC arch/x86/tools/relocs_common.o HOSTLD arch/x86/tools/relocs HOSTCC scripts/selinux/genheaders/genheaders HOSTCC scripts/selinux/mdp/mdp HOSTCC scripts/kallsyms HOSTCC scripts/sorttable HOSTCC scripts/asn1_compiler HOSTCC scripts/extract-cert HOSTCC scripts/mod/mk_elfconfig CHECK ../scripts/mod/empty.c CC scripts/mod/empty.o MKELF scripts/mod/elfconfig.h HOSTCC scripts/mod/modpost.o CC scripts/mod/devicetable-offsets.s HOSTCC scripts/mod/file2alias.o HOSTCC scripts/mod/sumversion.o HOSTLD scripts/mod/modpost CC kernel/bounds.s CC arch/x86/kernel/asm-offsets.s CALL ../scripts/checksyscalls.sh CALL ../scripts/atomic/check-atomics.sh DESCEND objtool HOSTCC /usr/src/linux-2.6/defconfig-build/tools/objtool/fixdep.o HOSTLD /usr/src/linux-2.6/defconfig-build/tools/objtool/fixdep-in.o LINK /usr/src/linux-2.6/defconfig-build/tools/objtool/fixdep CC /usr/src/linux-2.6/defconfig-build/tools/objtool/exec-cmd.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/help.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/pager.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/parse-options.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/run-command.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/sigchain.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/subcmd-config.o LD /usr/src/linux-2.6/defconfig-build/tools/objtool/libsubcmd-in.o AR /usr/src/linux-2.6/defconfig-build/tools/objtool/libsubcmd.a CC /usr/src/linux-2.6/defconfig-build/tools/objtool/arch/x86/decode.o LD /usr/src/linux-2.6/defconfig-build/tools/objtool/arch/x86/objtool-in.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/builtin-check.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/builtin-orc.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/check.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/orc_gen.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/orc_dump.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/elf.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/special.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/objtool.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/libstring.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/libctype.o CC /usr/src/linux-2.6/defconfig-build/tools/objtool/str_error_r.o LD /usr/src/linux-2.6/defconfig-build/tools/objtool/objtool-in.o LINK /usr/src/linux-2.6/defconfig-build/tools/objtool/objtool CHECK ../lib/test_bitops.c CC [M] lib/test_bitops.o MODPOST 1 modules CC [M] lib/test_bitops.mod.o LD [M] lib/test_bitops.ko make[1]: Leaving directory '/usr/src/linux-2.6/defconfig-build'
No warnings for me!
Re: [PATCH v2 2/2] lib: make a test module with set/clear bit
Quoted 14 lines · On Thu, 20 Feb 2020 19:10:33 +0100 Peter wrote:
Quoted 4 lines · Jesse Brandeburg
Test some bit clears/sets to make sure assembly doesn't change. Instruct
Kbuildto build this file with extra warning level -Wextra, to catch new issues, and also doesn't hurt to build with C=1.Quoted 8 lines
This was used to test changes to
arch/x86/include/asm/bitops.h.Recommended usage:
make defconfigscripts/config-mCONFIG_TEST_BITOPS
makemodules_prepare
make C=1 W=1lib/test_bitops.ko
objdump -S -dlib/test_bitops.ko
Quoted 4 lines
I only applied this second patch:
# sparse --version 0.6.0 (Debian: 0.6.0-3+b1)
Thanks for the review! The module was created to verify assembly didn't change before/after, but it's not a reproducer. Let me fix that (I had skipped that step as I originally didn't plan to upstream the test-patch).
Quoted 9 lines · Jesse Brandeburg
Fix many sparse warnings when building with C=1.
When the kernel is compiled with C=1, there are lots of messages like:
arch/x86/include/asm/bitops.h:77:37: warning: cast truncates bits from constant value (ffffff7fbecomes 7f)arch/x86/include/asm/bitops.h +0
-0@@ -72,9 +74,11 @@ static __always_inline void arch_clear_bit(long nr, volatile unsigned long *addr) {
arch/x86/include/asm/bitops.h static __always_inline void · line 84
Quoted 10 lines
arch/x86/include/asm/bitops.h +3
-1if (__builtin_constant_p (nr)) { +u8 cmaski = ~CONST_MASK (nr); + asm volatile(LOCK_PREFIX "andb %1,%0" : CONST_MASK_ADDR(nr, addr) - : "iq" ((u8)~CONST_MASK(nr))); + : "iq" (cmaski)); }else { asm volatile(LOCK_PREFIX __ASM_SIZE(btr) " %1,%0" : : RLONG_ADDR(addr), "Ir" (nr) : "memory");
Urgh, that's sad. So why doesn't this still generate a warning, ~ should promote your u8 to int, and then you down-cast to u8 on assignment again.
So now you have more lines, more ugly casts and exactly the same generated code; where the win?
Perhaps you should write it like:
: "iq" (0xFF ^ CONST_MASK(nr))
hmm?
Quoted 15 lines · On Thu, 20 Feb 2020 19:12:36 +0100 Peter wrote:
arch/x86/include/asm/bitops.h static __always_inline void · line 81
Quoted 10 lines · Jesse Brandeburg
arch/x86/include/asm/bitops.h +3
-1@@ -72,9 +74,11 @@ static __always_inline void arch_clear_bit(long nr, volatile unsigned long *addr) {if (__builtin_constant_p (nr)) { +u8 cmaski = ~CONST_MASK (nr); + asm volatile(LOCK_PREFIX "andb %1,%0" : CONST_MASK_ADDR(nr, addr) - : "iq" ((u8)~CONST_MASK(nr))); + : "iq" (cmaski));Urgh, that's sad. So why doesn't this still generate a warning, ~ should promote your u8 to int, and then you down-cast to u8 on assignment again.
My suspicion is that using the right size types on the lvalue causes the compiler (and sparse) to know that the type and number of bits in the "iq" statement is unambiguous.
Quoted 3 lines
So now you have more lines, more ugly casts and exactly the same generated code; where the win?
The win as I see it is that sparse (C=1) doesn't warn, but you're right, it wasn't my first choice to do it the way I ended up with (see below)
Quoted 5 lines
Perhaps you should write it like:
: "iq" (0xFF ^ CONST_MASK(nr))hmm?
Thanks! That works, for my tests at least. FWIW, at one point during review I got some feedback from a build bot (zero day tester) that certain compilers like gcc 7.5.0 interpret ~CONST_MASK(nr) into needing 32 bits. So I solved that issue by using correctly typed (and width) local variables, but I didn't try the 0xff^ way at that time.
I'll change back to the simpler version of the changes (without locals) and with your 0xff^ change, we'll see if anything comes up from build bots.