include/linux/bitmap.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LINUX_BITMAP_H
   3 #define __LINUX_BITMAP_H
   4
   5 #ifndef __ASSEMBLY__
   6
   7 #include <linux/bitops.h>
   8 #include <linux/kernel.h>
   9 #include <linux/string.h>
  10 #include <linux/types.h>
  11
  12 struct device;
  13
  14 /*
  15  * bitmaps provide bit arrays that consume one or more unsigned
  16  * longs.  The bitmap interface and available operations are listed
  17  * here, in bitmap.h
  18  *
  19  * Function implementations generic to all architectures are in
  20  * lib/bitmap.c.  Functions implementations that are architecture
  21  * specific are in various include/asm-<arch>/bitops.h headers
  22  * and other arch/<arch> specific files.
  23  *
  24  * See lib/bitmap.c for more details.
  25  */
  26
  27 /**
  28  * DOC: bitmap overview
  29  *
  30  * The available bitmap operations and their rough meaning in the
  31  * case that the bitmap is a single unsigned long are thus:
  32  *
  33  * The generated code is more efficient when nbits is known at
  34  * compile-time and at most BITS_PER_LONG.
  35  *
  36  * ::
  37  *
  38  *  bitmap_zero(dst, nbits)                     *dst = 0UL
  39  *  bitmap_fill(dst, nbits)                     *dst = ~0UL
  40  *  bitmap_copy(dst, src, nbits)                *dst = *src
  41  *  bitmap_and(dst, src1, src2, nbits)          *dst = *src1 & *src2
  42  *  bitmap_or(dst, src1, src2, nbits)           *dst = *src1 | *src2
  43  *  bitmap_xor(dst, src1, src2, nbits)          *dst = *src1 ^ *src2
  44  *  bitmap_andnot(dst, src1, src2, nbits)       *dst = *src1 & ~(*src2)
  45  *  bitmap_complement(dst, src, nbits)          *dst = ~(*src)
  46  *  bitmap_equal(src1, src2, nbits)             Are *src1 and *src2 equal?
  47  *  bitmap_intersects(src1, src2, nbits)        Do *src1 and *src2 overlap?
  48  *  bitmap_subset(src1, src2, nbits)            Is *src1 a subset of *src2?
  49  *  bitmap_empty(src, nbits)                    Are all bits zero in *src?
  50  *  bitmap_full(src, nbits)                     Are all bits set in *src?
  51  *  bitmap_weight(src, nbits)                   Hamming Weight: number set bits
  52  *  bitmap_set(dst, pos, nbits)                 Set specified bit area
  53  *  bitmap_clear(dst, pos, nbits)               Clear specified bit area
  54  *  bitmap_find_next_zero_area(buf, len, pos, n, mask)  Find bit free area
  55  *  bitmap_find_next_zero_area_off(buf, len, pos, n, mask, mask_off)  as above
  56  *  bitmap_next_clear_region(map, &start, &end, nbits)  Find next clear region
  57  *  bitmap_next_set_region(map, &start, &end, nbits)  Find next set region
  58  *  bitmap_for_each_clear_region(map, rs, re, start, end)
  59  *                                              Iterate over all clear regions
  60  *  bitmap_for_each_set_region(map, rs, re, start, end)
  61  *                                              Iterate over all set regions
  62  *  bitmap_shift_right(dst, src, n, nbits)      *dst = *src >> n
  63  *  bitmap_shift_left(dst, src, n, nbits)       *dst = *src << n
  64  *  bitmap_cut(dst, src, first, n, nbits)       Cut n bits from first, copy rest
  65  *  bitmap_replace(dst, old, new, mask, nbits)  *dst = (*old & ~(*mask)) | (*new & *mask)
  66  *  bitmap_remap(dst, src, old, new, nbits)     *dst = map(old, new)(src)
  67  *  bitmap_bitremap(oldbit, old, new, nbits)    newbit = map(old, new)(oldbit)
  68  *  bitmap_onto(dst, orig, relmap, nbits)       *dst = orig relative to relmap
  69  *  bitmap_fold(dst, orig, sz, nbits)           dst bits = orig bits mod sz
  70  *  bitmap_parse(buf, buflen, dst, nbits)       Parse bitmap dst from kernel buf
  71  *  bitmap_parse_user(ubuf, ulen, dst, nbits)   Parse bitmap dst from user buf
  72  *  bitmap_parselist(buf, dst, nbits)           Parse bitmap dst from kernel buf
  73  *  bitmap_parselist_user(buf, dst, nbits)      Parse bitmap dst from user buf
  74  *  bitmap_find_free_region(bitmap, bits, order)  Find and allocate bit region
  75  *  bitmap_release_region(bitmap, pos, order)   Free specified bit region
  76  *  bitmap_allocate_region(bitmap, pos, order)  Allocate specified bit region
  77  *  bitmap_from_arr32(dst, buf, nbits)          Copy nbits from u32[] buf to dst
  78  *  bitmap_to_arr32(buf, src, nbits)            Copy nbits from buf to u32[] dst
  79  *  bitmap_get_value8(map, start)               Get 8bit value from map at start
  80  *  bitmap_set_value8(map, value, start)        Set 8bit value to map at start
  81  *
  82  * Note, bitmap_zero() and bitmap_fill() operate over the region of
  83  * unsigned longs, that is, bits behind bitmap till the unsigned long
  84  * boundary will be zeroed or filled as well. Consider to use
  85  * bitmap_clear() or bitmap_set() to make explicit zeroing or filling
  86  * respectively.
  87  */
  88
  89 /**
  90  * DOC: bitmap bitops
  91  *
  92  * Also the following operations in asm/bitops.h apply to bitmaps.::
  93  *
  94  *  set_bit(bit, addr)                  *addr |= bit
  95  *  clear_bit(bit, addr)                *addr &= ~bit
  96  *  change_bit(bit, addr)               *addr ^= bit
  97  *  test_bit(bit, addr)                 Is bit set in *addr?
  98  *  test_and_set_bit(bit, addr)         Set bit and return old value
  99  *  test_and_clear_bit(bit, addr)       Clear bit and return old value
 100  *  test_and_change_bit(bit, addr)      Change bit and return old value
 101  *  find_first_zero_bit(addr, nbits)    Position first zero bit in *addr
 102  *  find_first_bit(addr, nbits)         Position first set bit in *addr
 103  *  find_next_zero_bit(addr, nbits, bit)
 104  *                                      Position next zero bit in *addr >= bit
 105  *  find_next_bit(addr, nbits, bit)     Position next set bit in *addr >= bit
 106  *  find_next_and_bit(addr1, addr2, nbits, bit)
 107  *                                      Same as find_next_bit, but in
 108  *                                      (*addr1 & *addr2)
 109  *
 110  */
 111
 112 /**
 113  * DOC: declare bitmap
 114  * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
 115  * to declare an array named 'name' of just enough unsigned longs to
 116  * contain all bit positions from 0 to 'bits' - 1.
 117  */
 118
 119 /*
 120  * Allocation and deallocation of bitmap.
 121  * Provided in lib/bitmap.c to avoid circular dependency.
 122  */
 123 unsigned long *bitmap_alloc(unsigned int nbits, gfp_t flags);
 124 unsigned long *bitmap_zalloc(unsigned int nbits, gfp_t flags);
 125 void bitmap_free(const unsigned long *bitmap);
 126
 127 /* Managed variants of the above. */
 128 unsigned long *devm_bitmap_alloc(struct device *dev,
 129                                  unsigned int nbits, gfp_t flags);
 130 unsigned long *devm_bitmap_zalloc(struct device *dev,
 131                                   unsigned int nbits, gfp_t flags);
 132
 133 /*
 134  * lib/bitmap.c provides these functions:
 135  */
 136
 137 int __bitmap_equal(const unsigned long *bitmap1,
 138                    const unsigned long *bitmap2, unsigned int nbits);
 139 bool __pure __bitmap_or_equal(const unsigned long *src1,
 140                               const unsigned long *src2,
 141                               const unsigned long *src3,
 142                               unsigned int nbits);
 143 void __bitmap_complement(unsigned long *dst, const unsigned long *src,
 144                          unsigned int nbits);
 145 void __bitmap_shift_right(unsigned long *dst, const unsigned long *src,
 146                           unsigned int shift, unsigned int nbits);
 147 void __bitmap_shift_left(unsigned long *dst, const unsigned long *src,
 148                          unsigned int shift, unsigned int nbits);
 149 void bitmap_cut(unsigned long *dst, const unsigned long *src,
 150                 unsigned int first, unsigned int cut, unsigned int nbits);
 151 int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
 152                  const unsigned long *bitmap2, unsigned int nbits);
 153 void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
 154                  const unsigned long *bitmap2, unsigned int nbits);
 155 void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
 156                   const unsigned long *bitmap2, unsigned int nbits);
 157 int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
 158                     const unsigned long *bitmap2, unsigned int nbits);
 159 void __bitmap_replace(unsigned long *dst,
 160                       const unsigned long *old, const unsigned long *new,
 161                       const unsigned long *mask, unsigned int nbits);
 162 int __bitmap_intersects(const unsigned long *bitmap1,
 163                         const unsigned long *bitmap2, unsigned int nbits);
 164 int __bitmap_subset(const unsigned long *bitmap1,
 165                     const unsigned long *bitmap2, unsigned int nbits);
 166 int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits);
 167 void __bitmap_set(unsigned long *map, unsigned int start, int len);
 168 void __bitmap_clear(unsigned long *map, unsigned int start, int len);
 169
 170 unsigned long bitmap_find_next_zero_area_off(unsigned long *map,
 171                                              unsigned long size,
 172                                              unsigned long start,
 173                                              unsigned int nr,
 174                                              unsigned long align_mask,
 175                                              unsigned long align_offset);
 176
 177 /**
 178  * bitmap_find_next_zero_area - find a contiguous aligned zero area
 179  * @map: The address to base the search on
 180  * @size: The bitmap size in bits
 181  * @start: The bitnumber to start searching at
 182  * @nr: The number of zeroed bits we're looking for
 183  * @align_mask: Alignment mask for zero area
 184  *
 185  * The @align_mask should be one less than a power of 2; the effect is that
 186  * the bit offset of all zero areas this function finds is multiples of that
 187  * power of 2. A @align_mask of 0 means no alignment is required.
 188  */
 189 static inline unsigned long
 190 bitmap_find_next_zero_area(unsigned long *map,
 191                            unsigned long size,
 192                            unsigned long start,
 193                            unsigned int nr,
 194                            unsigned long align_mask)
 195 {
 196         return bitmap_find_next_zero_area_off(map, size, start, nr,
 197                                               align_mask, 0);
 198 }
 199
 200 int bitmap_parse(const char *buf, unsigned int buflen,
 201                         unsigned long *dst, int nbits);
 202 int bitmap_parse_user(const char __user *ubuf, unsigned int ulen,
 203                         unsigned long *dst, int nbits);
 204 int bitmap_parselist(const char *buf, unsigned long *maskp,
 205                         int nmaskbits);
 206 int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen,
 207                         unsigned long *dst, int nbits);
 208 void bitmap_remap(unsigned long *dst, const unsigned long *src,
 209                 const unsigned long *old, const unsigned long *new, unsigned int nbits);
 210 int bitmap_bitremap(int oldbit,
 211                 const unsigned long *old, const unsigned long *new, int bits);
 212 void bitmap_onto(unsigned long *dst, const unsigned long *orig,
 213                 const unsigned long *relmap, unsigned int bits);
 214 void bitmap_fold(unsigned long *dst, const unsigned long *orig,
 215                 unsigned int sz, unsigned int nbits);
 216 int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order);
 217 void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order);
 218 int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order);
 219
 220 #ifdef __BIG_ENDIAN
 221 void bitmap_copy_le(unsigned long *dst, const unsigned long *src, unsigned int nbits);
 222 #else
 223 #define bitmap_copy_le bitmap_copy
 224 #endif
 225 unsigned int bitmap_ord_to_pos(const unsigned long *bitmap, unsigned int ord, unsigned int nbits);
 226 int bitmap_print_to_pagebuf(bool list, char *buf,
 227                                    const unsigned long *maskp, int nmaskbits);
 228
 229 #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) & (BITS_PER_LONG - 1)))
 230 #define BITMAP_LAST_WORD_MASK(nbits) (~0UL >> (-(nbits) & (BITS_PER_LONG - 1)))
 231
 232 /*
 233  * The static inlines below do not handle constant nbits==0 correctly,
 234  * so make such users (should any ever turn up) call the out-of-line
 235  * versions.
 236  */
 237 #define small_const_nbits(nbits) \
 238         (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG && (nbits) > 0)
 239
 240 static inline void bitmap_zero(unsigned long *dst, unsigned int nbits)
 241 {
 242         unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
 243         memset(dst, 0, len);
 244 }
 245
 246 static inline void bitmap_fill(unsigned long *dst, unsigned int nbits)
 247 {
 248         unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
 249         memset(dst, 0xff, len);
 250 }
 251
 252 static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
 253                         unsigned int nbits)
 254 {
 255         unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
 256         memcpy(dst, src, len);
 257 }
 258
 259 /*
 260  * Copy bitmap and clear tail bits in last word.
 261  */
 262 static inline void bitmap_copy_clear_tail(unsigned long *dst,
 263                 const unsigned long *src, unsigned int nbits)
 264 {
 265         bitmap_copy(dst, src, nbits);
 266         if (nbits % BITS_PER_LONG)
 267                 dst[nbits / BITS_PER_LONG] &= BITMAP_LAST_WORD_MASK(nbits);
 268 }
 269
 270 /*
 271  * On 32-bit systems bitmaps are represented as u32 arrays internally, and
 272  * therefore conversion is not needed when copying data from/to arrays of u32.
 273  */
 274 #if BITS_PER_LONG == 64
 275 void bitmap_from_arr32(unsigned long *bitmap, const u32 *buf,
 276                                                         unsigned int nbits);
 277 void bitmap_to_arr32(u32 *buf, const unsigned long *bitmap,
 278                                                         unsigned int nbits);
 279 #else
 280 #define bitmap_from_arr32(bitmap, buf, nbits)                   \
 281         bitmap_copy_clear_tail((unsigned long *) (bitmap),      \
 282                         (const unsigned long *) (buf), (nbits))
 283 #define bitmap_to_arr32(buf, bitmap, nbits)                     \
 284         bitmap_copy_clear_tail((unsigned long *) (buf),         \
 285                         (const unsigned long *) (bitmap), (nbits))
 286 #endif
 287
 288 static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
 289                         const unsigned long *src2, unsigned int nbits)
 290 {
 291         if (small_const_nbits(nbits))
 292                 return (*dst = *src1 & *src2 & BITMAP_LAST_WORD_MASK(nbits)) != 0;
 293         return __bitmap_and(dst, src1, src2, nbits);
 294 }
 295
 296 static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
 297                         const unsigned long *src2, unsigned int nbits)
 298 {
 299         if (small_const_nbits(nbits))
 300                 *dst = *src1 | *src2;
 301         else
 302                 __bitmap_or(dst, src1, src2, nbits);
 303 }
 304
 305 static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
 306                         const unsigned long *src2, unsigned int nbits)
 307 {
 308         if (small_const_nbits(nbits))
 309                 *dst = *src1 ^ *src2;
 310         else
 311                 __bitmap_xor(dst, src1, src2, nbits);
 312 }
 313
 314 static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
 315                         const unsigned long *src2, unsigned int nbits)
 316 {
 317         if (small_const_nbits(nbits))
 318                 return (*dst = *src1 & ~(*src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
 319         return __bitmap_andnot(dst, src1, src2, nbits);
 320 }
 321
 322 static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
 323                         unsigned int nbits)
 324 {
 325         if (small_const_nbits(nbits))
 326                 *dst = ~(*src);
 327         else
 328                 __bitmap_complement(dst, src, nbits);
 329 }
 330
 331 #ifdef __LITTLE_ENDIAN
 332 #define BITMAP_MEM_ALIGNMENT 8
 333 #else
 334 #define BITMAP_MEM_ALIGNMENT (8 * sizeof(unsigned long))
 335 #endif
 336 #define BITMAP_MEM_MASK (BITMAP_MEM_ALIGNMENT - 1)
 337
 338 static inline int bitmap_equal(const unsigned long *src1,
 339                         const unsigned long *src2, unsigned int nbits)
 340 {
 341         if (small_const_nbits(nbits))
 342                 return !((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
 343         if (__builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
 344             IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
 345                 return !memcmp(src1, src2, nbits / 8);
 346         return __bitmap_equal(src1, src2, nbits);
 347 }
 348
 349 /**
 350  * bitmap_or_equal - Check whether the or of two bitmaps is equal to a third
 351  * @src1:       Pointer to bitmap 1
 352  * @src2:       Pointer to bitmap 2 will be or'ed with bitmap 1
 353  * @src3:       Pointer to bitmap 3. Compare to the result of *@src1 | *@src2
 354  * @nbits:      number of bits in each of these bitmaps
 355  *
 356  * Returns: True if (*@src1 | *@src2) == *@src3, false otherwise
 357  */
 358 static inline bool bitmap_or_equal(const unsigned long *src1,
 359                                    const unsigned long *src2,
 360                                    const unsigned long *src3,
 361                                    unsigned int nbits)
 362 {
 363         if (!small_const_nbits(nbits))
 364                 return __bitmap_or_equal(src1, src2, src3, nbits);
 365
 366         return !(((*src1 | *src2) ^ *src3) & BITMAP_LAST_WORD_MASK(nbits));
 367 }
 368
 369 static inline int bitmap_intersects(const unsigned long *src1,
 370                         const unsigned long *src2, unsigned int nbits)
 371 {
 372         if (small_const_nbits(nbits))
 373                 return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
 374         else
 375                 return __bitmap_intersects(src1, src2, nbits);
 376 }
 377
 378 static inline int bitmap_subset(const unsigned long *src1,
 379                         const unsigned long *src2, unsigned int nbits)
 380 {
 381         if (small_const_nbits(nbits))
 382                 return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
 383         else
 384                 return __bitmap_subset(src1, src2, nbits);
 385 }
 386
 387 static inline bool bitmap_empty(const unsigned long *src, unsigned nbits)
 388 {
 389         if (small_const_nbits(nbits))
 390                 return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
 391
 392         return find_first_bit(src, nbits) == nbits;
 393 }
 394
 395 static inline bool bitmap_full(const unsigned long *src, unsigned int nbits)
 396 {
 397         if (small_const_nbits(nbits))
 398                 return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
 399
 400         return find_first_zero_bit(src, nbits) == nbits;
 401 }
 402
 403 static __always_inline int bitmap_weight(const unsigned long *src, unsigned int nbits)
 404 {
 405         if (small_const_nbits(nbits))
 406                 return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
 407         return __bitmap_weight(src, nbits);
 408 }
 409
 410 static __always_inline void bitmap_set(unsigned long *map, unsigned int start,
 411                 unsigned int nbits)
 412 {
 413         if (__builtin_constant_p(nbits) && nbits == 1)
 414                 __set_bit(start, map);
 415         else if (__builtin_constant_p(start & BITMAP_MEM_MASK) &&
 416                  IS_ALIGNED(start, BITMAP_MEM_ALIGNMENT) &&
 417                  __builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
 418                  IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
 419                 memset((char *)map + start / 8, 0xff, nbits / 8);
 420         else
 421                 __bitmap_set(map, start, nbits);
 422 }
 423
 424 static __always_inline void bitmap_clear(unsigned long *map, unsigned int start,
 425                 unsigned int nbits)
 426 {
 427         if (__builtin_constant_p(nbits) && nbits == 1)
 428                 __clear_bit(start, map);
 429         else if (__builtin_constant_p(start & BITMAP_MEM_MASK) &&
 430                  IS_ALIGNED(start, BITMAP_MEM_ALIGNMENT) &&
 431                  __builtin_constant_p(nbits & BITMAP_MEM_MASK) &&
 432                  IS_ALIGNED(nbits, BITMAP_MEM_ALIGNMENT))
 433                 memset((char *)map + start / 8, 0, nbits / 8);
 434         else
 435                 __bitmap_clear(map, start, nbits);
 436 }
 437
 438 static inline void bitmap_shift_right(unsigned long *dst, const unsigned long *src,
 439                                 unsigned int shift, unsigned int nbits)
 440 {
 441         if (small_const_nbits(nbits))
 442                 *dst = (*src & BITMAP_LAST_WORD_MASK(nbits)) >> shift;
 443         else
 444                 __bitmap_shift_right(dst, src, shift, nbits);
 445 }
 446
 447 static inline void bitmap_shift_left(unsigned long *dst, const unsigned long *src,
 448                                 unsigned int shift, unsigned int nbits)
 449 {
 450         if (small_const_nbits(nbits))
 451                 *dst = (*src << shift) & BITMAP_LAST_WORD_MASK(nbits);
 452         else
 453                 __bitmap_shift_left(dst, src, shift, nbits);
 454 }
 455
 456 static inline void bitmap_replace(unsigned long *dst,
 457                                   const unsigned long *old,
 458                                   const unsigned long *new,
 459                                   const unsigned long *mask,
 460                                   unsigned int nbits)
 461 {
 462         if (small_const_nbits(nbits))
 463                 *dst = (*old & ~(*mask)) | (*new & *mask);
 464         else
 465                 __bitmap_replace(dst, old, new, mask, nbits);
 466 }
 467
 468 static inline void bitmap_next_clear_region(unsigned long *bitmap,
 469                                             unsigned int *rs, unsigned int *re,
 470                                             unsigned int end)
 471 {
 472         *rs = find_next_zero_bit(bitmap, end, *rs);
 473         *re = find_next_bit(bitmap, end, *rs + 1);
 474 }
 475
 476 static inline void bitmap_next_set_region(unsigned long *bitmap,
 477                                           unsigned int *rs, unsigned int *re,
 478                                           unsigned int end)
 479 {
 480         *rs = find_next_bit(bitmap, end, *rs);
 481         *re = find_next_zero_bit(bitmap, end, *rs + 1);
 482 }
 483
 484 /*
 485  * Bitmap region iterators.  Iterates over the bitmap between [@start, @end).
 486  * @rs and @re should be integer variables and will be set to start and end
 487  * index of the current clear or set region.
 488  */
 489 #define bitmap_for_each_clear_region(bitmap, rs, re, start, end)             \
 490         for ((rs) = (start),                                                 \
 491              bitmap_next_clear_region((bitmap), &(rs), &(re), (end));        \
 492              (rs) < (re);                                                    \
 493              (rs) = (re) + 1,                                                \
 494              bitmap_next_clear_region((bitmap), &(rs), &(re), (end)))
 495
 496 #define bitmap_for_each_set_region(bitmap, rs, re, start, end)               \
 497         for ((rs) = (start),                                                 \
 498              bitmap_next_set_region((bitmap), &(rs), &(re), (end));          \
 499              (rs) < (re);                                                    \
 500              (rs) = (re) + 1,                                                \
 501              bitmap_next_set_region((bitmap), &(rs), &(re), (end)))
 502
 503 /**
 504  * BITMAP_FROM_U64() - Represent u64 value in the format suitable for bitmap.
 505  * @n: u64 value
 506  *
 507  * Linux bitmaps are internally arrays of unsigned longs, i.e. 32-bit
 508  * integers in 32-bit environment, and 64-bit integers in 64-bit one.
 509  *
 510  * There are four combinations of endianness and length of the word in linux
 511  * ABIs: LE64, BE64, LE32 and BE32.
 512  *
 513  * On 64-bit kernels 64-bit LE and BE numbers are naturally ordered in
 514  * bitmaps and therefore don't require any special handling.
 515  *
 516  * On 32-bit kernels 32-bit LE ABI orders lo word of 64-bit number in memory
 517  * prior to hi, and 32-bit BE orders hi word prior to lo. The bitmap on the
 518  * other hand is represented as an array of 32-bit words and the position of
 519  * bit N may therefore be calculated as: word #(N/32) and bit #(N%32) in that
 520  * word.  For example, bit #42 is located at 10th position of 2nd word.
 521  * It matches 32-bit LE ABI, and we can simply let the compiler store 64-bit
 522  * values in memory as it usually does. But for BE we need to swap hi and lo
 523  * words manually.
 524  *
 525  * With all that, the macro BITMAP_FROM_U64() does explicit reordering of hi and
 526  * lo parts of u64.  For LE32 it does nothing, and for BE environment it swaps
 527  * hi and lo words, as is expected by bitmap.
 528  */
 529 #if __BITS_PER_LONG == 64
 530 #define BITMAP_FROM_U64(n) (n)
 531 #else
 532 #define BITMAP_FROM_U64(n) ((unsigned long) ((u64)(n) & ULONG_MAX)), \
 533                                 ((unsigned long) ((u64)(n) >> 32))
 534 #endif
 535
 536 /**
 537  * bitmap_from_u64 - Check and swap words within u64.
 538  *  @mask: source bitmap
 539  *  @dst:  destination bitmap
 540  *
 541  * In 32-bit Big Endian kernel, when using ``(u32 *)(&val)[*]``
 542  * to read u64 mask, we will get the wrong word.
 543  * That is ``(u32 *)(&val)[0]`` gets the upper 32 bits,
 544  * but we expect the lower 32-bits of u64.
 545  */
 546 static inline void bitmap_from_u64(unsigned long *dst, u64 mask)
 547 {
 548         dst[0] = mask & ULONG_MAX;
 549
 550         if (sizeof(mask) > sizeof(unsigned long))
 551                 dst[1] = mask >> 32;
 552 }
 553
 554 /**
 555  * bitmap_get_value8 - get an 8-bit value within a memory region
 556  * @map: address to the bitmap memory region
 557  * @start: bit offset of the 8-bit value; must be a multiple of 8
 558  *
 559  * Returns the 8-bit value located at the @start bit offset within the @src
 560  * memory region.
 561  */
 562 static inline unsigned long bitmap_get_value8(const unsigned long *map,
 563                                               unsigned long start)
 564 {
 565         const size_t index = BIT_WORD(start);
 566         const unsigned long offset = start % BITS_PER_LONG;
 567
 568         return (map[index] >> offset) & 0xFF;
 569 }
 570
 571 /**
 572  * bitmap_set_value8 - set an 8-bit value within a memory region
 573  * @map: address to the bitmap memory region
 574  * @value: the 8-bit value; values wider than 8 bits may clobber bitmap
 575  * @start: bit offset of the 8-bit value; must be a multiple of 8
 576  */
 577 static inline void bitmap_set_value8(unsigned long *map, unsigned long value,
 578                                      unsigned long start)
 579 {
 580         const size_t index = BIT_WORD(start);
 581         const unsigned long offset = start % BITS_PER_LONG;
 582
 583         map[index] &= ~(0xFFUL << offset);
 584         map[index] |= value << offset;
 585 }
 586
 587 #endif /* __ASSEMBLY__ */
 588
 589 #endif /* __LINUX_BITMAP_H */