include/linux/bitmap.h

   1 #ifndef __LINUX_BITMAP_H
   2 #define __LINUX_BITMAP_H
   3
   4 #ifndef __ASSEMBLY__
   5
   6 #include <linux/types.h>
   7 #include <linux/bitops.h>
   8 #include <linux/string.h>
   9 #include <linux/kernel.h>
  10
  11 /*
  12  * bitmaps provide bit arrays that consume one or more unsigned
  13  * longs.  The bitmap interface and available operations are listed
  14  * here, in bitmap.h
  15  *
  16  * Function implementations generic to all architectures are in
  17  * lib/bitmap.c.  Functions implementations that are architecture
  18  * specific are in various include/asm-<arch>/bitops.h headers
  19  * and other arch/<arch> specific files.
  20  *
  21  * See lib/bitmap.c for more details.
  22  */
  23
  24 /*
  25  * The available bitmap operations and their rough meaning in the
  26  * case that the bitmap is a single unsigned long are thus:
  27  *
  28  * Note that nbits should be always a compile time evaluable constant.
  29  * Otherwise many inlines will generate horrible code.
  30  *
  31  * bitmap_zero(dst, nbits)                      *dst = 0UL
  32  * bitmap_fill(dst, nbits)                      *dst = ~0UL
  33  * bitmap_copy(dst, src, nbits)                 *dst = *src
  34  * bitmap_and(dst, src1, src2, nbits)           *dst = *src1 & *src2
  35  * bitmap_or(dst, src1, src2, nbits)            *dst = *src1 | *src2
  36  * bitmap_xor(dst, src1, src2, nbits)           *dst = *src1 ^ *src2
  37  * bitmap_andnot(dst, src1, src2, nbits)        *dst = *src1 & ~(*src2)
  38  * bitmap_complement(dst, src, nbits)           *dst = ~(*src)
  39  * bitmap_equal(src1, src2, nbits)              Are *src1 and *src2 equal?
  40  * bitmap_intersects(src1, src2, nbits)         Do *src1 and *src2 overlap?
  41  * bitmap_subset(src1, src2, nbits)             Is *src1 a subset of *src2?
  42  * bitmap_empty(src, nbits)                     Are all bits zero in *src?
  43  * bitmap_full(src, nbits)                      Are all bits set in *src?
  44  * bitmap_weight(src, nbits)                    Hamming Weight: number set bits
  45  * bitmap_set(dst, pos, nbits)                  Set specified bit area
  46  * bitmap_clear(dst, pos, nbits)                Clear specified bit area
  47  * bitmap_find_next_zero_area(buf, len, pos, n, mask)   Find bit free area
  48  * bitmap_find_next_zero_area_off(buf, len, pos, n, mask)       as above
  49  * bitmap_shift_right(dst, src, n, nbits)       *dst = *src >> n
  50  * bitmap_shift_left(dst, src, n, nbits)        *dst = *src << n
  51  * bitmap_remap(dst, src, old, new, nbits)      *dst = map(old, new)(src)
  52  * bitmap_bitremap(oldbit, old, new, nbits)     newbit = map(old, new)(oldbit)
  53  * bitmap_onto(dst, orig, relmap, nbits)        *dst = orig relative to relmap
  54  * bitmap_fold(dst, orig, sz, nbits)            dst bits = orig bits mod sz
  55  * bitmap_scnprintf(buf, len, src, nbits)       Print bitmap src to buf
  56  * bitmap_parse(buf, buflen, dst, nbits)        Parse bitmap dst from kernel buf
  57  * bitmap_parse_user(ubuf, ulen, dst, nbits)    Parse bitmap dst from user buf
  58  * bitmap_scnlistprintf(buf, len, src, nbits)   Print bitmap src as list to buf
  59  * bitmap_parselist(buf, dst, nbits)            Parse bitmap dst from list
  60  * bitmap_find_free_region(bitmap, bits, order) Find and allocate bit region
  61  * bitmap_release_region(bitmap, pos, order)    Free specified bit region
  62  * bitmap_allocate_region(bitmap, pos, order)   Allocate specified bit region
  63  */
  64
  65 /*
  66  * Also the following operations in asm/bitops.h apply to bitmaps.
  67  *
  68  * set_bit(bit, addr)                   *addr |= bit
  69  * clear_bit(bit, addr)                 *addr &= ~bit
  70  * change_bit(bit, addr)                *addr ^= bit
  71  * test_bit(bit, addr)                  Is bit set in *addr?
  72  * test_and_set_bit(bit, addr)          Set bit and return old value
  73  * test_and_clear_bit(bit, addr)        Clear bit and return old value
  74  * test_and_change_bit(bit, addr)       Change bit and return old value
  75  * find_first_zero_bit(addr, nbits)     Position first zero bit in *addr
  76  * find_first_bit(addr, nbits)          Position first set bit in *addr
  77  * find_next_zero_bit(addr, nbits, bit) Position next zero bit in *addr >= bit
  78  * find_next_bit(addr, nbits, bit)      Position next set bit in *addr >= bit
  79  */
  80
  81 /*
  82  * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
  83  * to declare an array named 'name' of just enough unsigned longs to
  84  * contain all bit positions from 0 to 'bits' - 1.
  85  */
  86
  87 /*
  88  * lib/bitmap.c provides these functions:
  89  */
  90
  91 extern int __bitmap_empty(const unsigned long *bitmap, int bits);
  92 extern int __bitmap_full(const unsigned long *bitmap, int bits);
  93 extern int __bitmap_equal(const unsigned long *bitmap1,
  94                         const unsigned long *bitmap2, int bits);
  95 extern void __bitmap_complement(unsigned long *dst, const unsigned long *src,
  96                         int bits);
  97 extern void __bitmap_shift_right(unsigned long *dst,
  98                         const unsigned long *src, int shift, int bits);
  99 extern void __bitmap_shift_left(unsigned long *dst,
 100                         const unsigned long *src, int shift, int bits);
 101 extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
 102                         const unsigned long *bitmap2, int bits);
 103 extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
 104                         const unsigned long *bitmap2, int bits);
 105 extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
 106                         const unsigned long *bitmap2, int bits);
 107 extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
 108                         const unsigned long *bitmap2, int bits);
 109 extern int __bitmap_intersects(const unsigned long *bitmap1,
 110                         const unsigned long *bitmap2, int bits);
 111 extern int __bitmap_subset(const unsigned long *bitmap1,
 112                         const unsigned long *bitmap2, int bits);
 113 extern int __bitmap_weight(const unsigned long *bitmap, int bits);
 114
 115 extern void bitmap_set(unsigned long *map, int i, int len);
 116 extern void bitmap_clear(unsigned long *map, int start, int nr);
 117
 118 extern unsigned long bitmap_find_next_zero_area_off(unsigned long *map,
 119                                                     unsigned long size,
 120                                                     unsigned long start,
 121                                                     unsigned int nr,
 122                                                     unsigned long align_mask,
 123                                                     unsigned long align_offset);
 124
 125 static inline unsigned long
 126 bitmap_find_next_zero_area(unsigned long *map,
 127                            unsigned long size,
 128                            unsigned long start,
 129                            unsigned int nr,
 130                            unsigned long align_mask)
 131 {
 132         return bitmap_find_next_zero_area_off(map, size, start, nr,
 133                                               align_mask, 0);
 134 }
 135
 136 extern int bitmap_scnprintf(char *buf, unsigned int len,
 137                         const unsigned long *src, int nbits);
 138 extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user,
 139                         unsigned long *dst, int nbits);
 140 extern int bitmap_parse_user(const char __user *ubuf, unsigned int ulen,
 141                         unsigned long *dst, int nbits);
 142 extern int bitmap_scnlistprintf(char *buf, unsigned int len,
 143                         const unsigned long *src, int nbits);
 144 extern int bitmap_parselist(const char *buf, unsigned long *maskp,
 145                         int nmaskbits);
 146 extern void bitmap_remap(unsigned long *dst, const unsigned long *src,
 147                 const unsigned long *old, const unsigned long *new, int bits);
 148 extern int bitmap_bitremap(int oldbit,
 149                 const unsigned long *old, const unsigned long *new, int bits);
 150 extern void bitmap_onto(unsigned long *dst, const unsigned long *orig,
 151                 const unsigned long *relmap, int bits);
 152 extern void bitmap_fold(unsigned long *dst, const unsigned long *orig,
 153                 int sz, int bits);
 154 extern int bitmap_find_free_region(unsigned long *bitmap, int bits, int order);
 155 extern void bitmap_release_region(unsigned long *bitmap, int pos, int order);
 156 extern int bitmap_allocate_region(unsigned long *bitmap, int pos, int order);
 157 extern void bitmap_copy_le(void *dst, const unsigned long *src, int nbits);
 158
 159 #define BITMAP_LAST_WORD_MASK(nbits)                                    \
 160 (                                                                       \
 161         ((nbits) % BITS_PER_LONG) ?                                     \
 162                 (1UL<<((nbits) % BITS_PER_LONG))-1 : ~0UL               \
 163 )
 164
 165 #define small_const_nbits(nbits) \
 166         (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG)
 167
 168 static inline void bitmap_zero(unsigned long *dst, int nbits)
 169 {
 170         if (small_const_nbits(nbits))
 171                 *dst = 0UL;
 172         else {
 173                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
 174                 memset(dst, 0, len);
 175         }
 176 }
 177
 178 static inline void bitmap_fill(unsigned long *dst, int nbits)
 179 {
 180         size_t nlongs = BITS_TO_LONGS(nbits);
 181         if (!small_const_nbits(nbits)) {
 182                 int len = (nlongs - 1) * sizeof(unsigned long);
 183                 memset(dst, 0xff,  len);
 184         }
 185         dst[nlongs - 1] = BITMAP_LAST_WORD_MASK(nbits);
 186 }
 187
 188 static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
 189                         int nbits)
 190 {
 191         if (small_const_nbits(nbits))
 192                 *dst = *src;
 193         else {
 194                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
 195                 memcpy(dst, src, len);
 196         }
 197 }
 198
 199 static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
 200                         const unsigned long *src2, int nbits)
 201 {
 202         if (small_const_nbits(nbits))
 203                 return (*dst = *src1 & *src2) != 0;
 204         return __bitmap_and(dst, src1, src2, nbits);
 205 }
 206
 207 static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
 208                         const unsigned long *src2, int nbits)
 209 {
 210         if (small_const_nbits(nbits))
 211                 *dst = *src1 | *src2;
 212         else
 213                 __bitmap_or(dst, src1, src2, nbits);
 214 }
 215
 216 static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
 217                         const unsigned long *src2, int nbits)
 218 {
 219         if (small_const_nbits(nbits))
 220                 *dst = *src1 ^ *src2;
 221         else
 222                 __bitmap_xor(dst, src1, src2, nbits);
 223 }
 224
 225 static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
 226                         const unsigned long *src2, int nbits)
 227 {
 228         if (small_const_nbits(nbits))
 229                 return (*dst = *src1 & ~(*src2)) != 0;
 230         return __bitmap_andnot(dst, src1, src2, nbits);
 231 }
 232
 233 static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
 234                         int nbits)
 235 {
 236         if (small_const_nbits(nbits))
 237                 *dst = ~(*src) & BITMAP_LAST_WORD_MASK(nbits);
 238         else
 239                 __bitmap_complement(dst, src, nbits);
 240 }
 241
 242 static inline int bitmap_equal(const unsigned long *src1,
 243                         const unsigned long *src2, int nbits)
 244 {
 245         if (small_const_nbits(nbits))
 246                 return ! ((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
 247         else
 248                 return __bitmap_equal(src1, src2, nbits);
 249 }
 250
 251 static inline int bitmap_intersects(const unsigned long *src1,
 252                         const unsigned long *src2, int nbits)
 253 {
 254         if (small_const_nbits(nbits))
 255                 return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
 256         else
 257                 return __bitmap_intersects(src1, src2, nbits);
 258 }
 259
 260 static inline int bitmap_subset(const unsigned long *src1,
 261                         const unsigned long *src2, int nbits)
 262 {
 263         if (small_const_nbits(nbits))
 264                 return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
 265         else
 266                 return __bitmap_subset(src1, src2, nbits);
 267 }
 268
 269 static inline int bitmap_empty(const unsigned long *src, int nbits)
 270 {
 271         if (small_const_nbits(nbits))
 272                 return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
 273         else
 274                 return __bitmap_empty(src, nbits);
 275 }
 276
 277 static inline int bitmap_full(const unsigned long *src, int nbits)
 278 {
 279         if (small_const_nbits(nbits))
 280                 return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
 281         else
 282                 return __bitmap_full(src, nbits);
 283 }
 284
 285 static inline int bitmap_weight(const unsigned long *src, int nbits)
 286 {
 287         if (small_const_nbits(nbits))
 288                 return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
 289         return __bitmap_weight(src, nbits);
 290 }
 291
 292 static inline void bitmap_shift_right(unsigned long *dst,
 293                         const unsigned long *src, int n, int nbits)
 294 {
 295         if (small_const_nbits(nbits))
 296                 *dst = *src >> n;
 297         else
 298                 __bitmap_shift_right(dst, src, n, nbits);
 299 }
 300
 301 static inline void bitmap_shift_left(unsigned long *dst,
 302                         const unsigned long *src, int n, int nbits)
 303 {
 304         if (small_const_nbits(nbits))
 305                 *dst = (*src << n) & BITMAP_LAST_WORD_MASK(nbits);
 306         else
 307                 __bitmap_shift_left(dst, src, n, nbits);
 308 }
 309
 310 static inline int bitmap_parse(const char *buf, unsigned int buflen,
 311                         unsigned long *maskp, int nmaskbits)
 312 {
 313         return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
 314 }
 315
 316 #endif /* __ASSEMBLY__ */
 317
 318 #endif /* __LINUX_BITMAP_H */