Re: [PATCH v1 1/1] bitmap: Refactor bitmap_read() and bitmap_write() to avoid too big shift

From: Yury Norov

Date: Thu Nov 19 2026 - 15:37:50 EST


Hi Andy!

+ sparse people.

On Thu, Nov 19, 2026 at 08:15:30PM +0100, Andy Shevchenko wrote:
> While compiling ad4691.c I have noticed the following warnings:
>
> drivers/iio/adc/ad4691.c: note: in included file:
> include/linux/bitmap.h:854:55: warning: shift too big (64) for type unsigned long
> include/linux/bitmap.h:854:55: warning: shift too big (64) for type unsigned long
>
> Since the bitmap_read() is called with statically define 'start',
> the 'space' local variable becomes equal to BITS_PER_LONG, or 64 on
> 64-bit machines. The 'nbits' parameter is coming from the run-time
> defined value. Static analyser doesn't see that the right shift
> by 64-bit can't happen — the space >= nbits check guards that.
> While Jonathan put it as false positive [1], we still can give a hint
> to it without growing in the code (`bloat-o-meter` for above mentioned
> driver shows no difference in size). So this is what this change does.

Jonathan put it right.

If the analyzer (assuming sparse?) throws false positives, we don't
need to change the kernel. This is simply a wrong motivation. We need
to improve sparse instead.

Otherwise, the kernel will become a collection of hacks for various
poorly written tools. Let's do it the other way, please.

> For completeness, bitmap_write() is also refactored in the similar manner.
> I have also checked a few users of it and `bloat-o-meter` showed no change.
>
> Link: https://lore.kernel.org/r/20260531111528.32697d1f@jic23-huawei [1]
> Fixes: 63c15822b8dd ("lib/bitmap: add bitmap_{read,write}()")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> ---
> include/linux/bitmap.h | 24 +++++++++++-------------
> 1 file changed, 11 insertions(+), 13 deletions(-)
>
> diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h
> index adafbcf2016b..f331cf06130d 100644
> --- a/include/linux/bitmap.h
> +++ b/include/linux/bitmap.h
> @@ -846,7 +846,7 @@ unsigned long bitmap_read(const unsigned long *map, unsigned long start, unsigne
> if (unlikely(!nbits || nbits > BITS_PER_LONG))
> return 0;
>
> - if (space >= nbits)
> + if (space >= nbits || offset == 0)
> return (map[index] >> offset) & BITMAP_LAST_WORD_MASK(nbits);

So, doubling the number of conditions, and the new one duplicates the
existing check. This version suppresses sparse false positive:

if (offset <= BITS_PER_LONG - nbits)

And even with that I'm not sure we need to touch the kernel to make
sparse or whatever else tool happy...

> value_low = map[index] & BITMAP_FIRST_WORD_MASK(start);
> @@ -874,25 +874,23 @@ void bitmap_write(unsigned long *map, unsigned long value,
> unsigned long start, unsigned long nbits)
> {
> size_t index;
> - unsigned long offset;
> - unsigned long space;
> - unsigned long mask;
> - bool fit;
> + unsigned long offset = start % BITS_PER_LONG;
> + unsigned long space = BITS_PER_LONG - offset;
>
> if (unlikely(!nbits || nbits > BITS_PER_LONG))
> return;

Initialization of local variables before the sanity check
may become useless waste of cycles if this sanity fails.

This is also not necessarily needed for sparse happiness,
I guess... Let's keep the patch minimal?

> - mask = BITMAP_LAST_WORD_MASK(nbits);
> - value &= mask;
> - offset = start % BITS_PER_LONG;
> - space = BITS_PER_LONG - offset;
> - fit = space >= nbits;

I don't like this 'fit' thing, and would like to drop it. But
let's find a better motivation to do that?

Thanks,
Yury

> + value &= BITMAP_LAST_WORD_MASK(nbits);
> index = BIT_WORD(start);
>
> - map[index] &= (fit ? (~(mask << offset)) : ~BITMAP_FIRST_WORD_MASK(start));
> - map[index] |= value << offset;
> - if (fit)
> + if (space >= nbits || offset == 0) {
> + map[index] &= ~(BITMAP_LAST_WORD_MASK(nbits) << offset);
> + map[index] |= value << offset;
> return;
> + }
> +
> + map[index] &= ~BITMAP_FIRST_WORD_MASK(start);
> + map[index] |= value << offset;
>
> map[index + 1] &= BITMAP_FIRST_WORD_MASK(start + nbits);
> map[index + 1] |= (value >> space);
> --
> 2.50.1