1 #ifndef __LINUX_BITMAP_H
2 #define __LINUX_BITMAP_H
6 #include <linux/types.h>
7 #include <linux/bitops.h>
8 #include <linux/string.h>
9 #include <linux/kernel.h>
12 * bitmaps provide bit arrays that consume one or more unsigned
13 * longs. The bitmap interface and available operations are listed
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.
21 * See lib/bitmap.c for more details.
25 * The available bitmap operations and their rough meaning in the
26 * case that the bitmap is a single unsigned long are thus:
28 * Note that nbits should be always a compile time evaluable constant.
29 * Otherwise many inlines will generate horrible code.
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 kernel buf
60 * bitmap_parselist_user(buf, dst, nbits) Parse bitmap dst from user buf
61 * bitmap_find_free_region(bitmap, bits, order) Find and allocate bit region
62 * bitmap_release_region(bitmap, pos, order) Free specified bit region
63 * bitmap_allocate_region(bitmap, pos, order) Allocate specified bit region
64 * bitmap_print_to_pagebuf(list, buf, mask, nbits) Print bitmap src as list/hex
68 * Also the following operations in asm/bitops.h apply to bitmaps.
70 * set_bit(bit, addr) *addr |= bit
71 * clear_bit(bit, addr) *addr &= ~bit
72 * change_bit(bit, addr) *addr ^= bit
73 * test_bit(bit, addr) Is bit set in *addr?
74 * test_and_set_bit(bit, addr) Set bit and return old value
75 * test_and_clear_bit(bit, addr) Clear bit and return old value
76 * test_and_change_bit(bit, addr) Change bit and return old value
77 * find_first_zero_bit(addr, nbits) Position first zero bit in *addr
78 * find_first_bit(addr, nbits) Position first set bit in *addr
79 * find_next_zero_bit(addr, nbits, bit) Position next zero bit in *addr >= bit
80 * find_next_bit(addr, nbits, bit) Position next set bit in *addr >= bit
84 * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
85 * to declare an array named 'name' of just enough unsigned longs to
86 * contain all bit positions from 0 to 'bits' - 1.
90 * lib/bitmap.c provides these functions:
93 extern int __bitmap_empty(const unsigned long *bitmap
, unsigned int nbits
);
94 extern int __bitmap_full(const unsigned long *bitmap
, unsigned int nbits
);
95 extern int __bitmap_equal(const unsigned long *bitmap1
,
96 const unsigned long *bitmap2
, unsigned int nbits
);
97 extern void __bitmap_complement(unsigned long *dst
, const unsigned long *src
,
99 extern void __bitmap_shift_right(unsigned long *dst
,
100 const unsigned long *src
, int shift
, int bits
);
101 extern void __bitmap_shift_left(unsigned long *dst
,
102 const unsigned long *src
, int shift
, int bits
);
103 extern int __bitmap_and(unsigned long *dst
, const unsigned long *bitmap1
,
104 const unsigned long *bitmap2
, unsigned int nbits
);
105 extern void __bitmap_or(unsigned long *dst
, const unsigned long *bitmap1
,
106 const unsigned long *bitmap2
, unsigned int nbits
);
107 extern void __bitmap_xor(unsigned long *dst
, const unsigned long *bitmap1
,
108 const unsigned long *bitmap2
, unsigned int nbits
);
109 extern int __bitmap_andnot(unsigned long *dst
, const unsigned long *bitmap1
,
110 const unsigned long *bitmap2
, unsigned int nbits
);
111 extern int __bitmap_intersects(const unsigned long *bitmap1
,
112 const unsigned long *bitmap2
, unsigned int nbits
);
113 extern int __bitmap_subset(const unsigned long *bitmap1
,
114 const unsigned long *bitmap2
, unsigned int nbits
);
115 extern int __bitmap_weight(const unsigned long *bitmap
, unsigned int nbits
);
117 extern void bitmap_set(unsigned long *map
, unsigned int start
, int len
);
118 extern void bitmap_clear(unsigned long *map
, unsigned int start
, int len
);
120 extern unsigned long bitmap_find_next_zero_area_off(unsigned long *map
,
124 unsigned long align_mask
,
125 unsigned long align_offset
);
128 * bitmap_find_next_zero_area - find a contiguous aligned zero area
129 * @map: The address to base the search on
130 * @size: The bitmap size in bits
131 * @start: The bitnumber to start searching at
132 * @nr: The number of zeroed bits we're looking for
133 * @align_mask: Alignment mask for zero area
135 * The @align_mask should be one less than a power of 2; the effect is that
136 * the bit offset of all zero areas this function finds is multiples of that
137 * power of 2. A @align_mask of 0 means no alignment is required.
139 static inline unsigned long
140 bitmap_find_next_zero_area(unsigned long *map
,
144 unsigned long align_mask
)
146 return bitmap_find_next_zero_area_off(map
, size
, start
, nr
,
150 extern int bitmap_scnprintf(char *buf
, unsigned int len
,
151 const unsigned long *src
, int nbits
);
152 extern int __bitmap_parse(const char *buf
, unsigned int buflen
, int is_user
,
153 unsigned long *dst
, int nbits
);
154 extern int bitmap_parse_user(const char __user
*ubuf
, unsigned int ulen
,
155 unsigned long *dst
, int nbits
);
156 extern int bitmap_scnlistprintf(char *buf
, unsigned int len
,
157 const unsigned long *src
, int nbits
);
158 extern int bitmap_parselist(const char *buf
, unsigned long *maskp
,
160 extern int bitmap_parselist_user(const char __user
*ubuf
, unsigned int ulen
,
161 unsigned long *dst
, int nbits
);
162 extern void bitmap_remap(unsigned long *dst
, const unsigned long *src
,
163 const unsigned long *old
, const unsigned long *new, int bits
);
164 extern int bitmap_bitremap(int oldbit
,
165 const unsigned long *old
, const unsigned long *new, int bits
);
166 extern void bitmap_onto(unsigned long *dst
, const unsigned long *orig
,
167 const unsigned long *relmap
, int bits
);
168 extern void bitmap_fold(unsigned long *dst
, const unsigned long *orig
,
170 extern int bitmap_find_free_region(unsigned long *bitmap
, unsigned int bits
, int order
);
171 extern void bitmap_release_region(unsigned long *bitmap
, unsigned int pos
, int order
);
172 extern int bitmap_allocate_region(unsigned long *bitmap
, unsigned int pos
, int order
);
173 extern void bitmap_copy_le(void *dst
, const unsigned long *src
, int nbits
);
174 extern int bitmap_ord_to_pos(const unsigned long *bitmap
, int n
, int bits
);
175 extern int bitmap_print_to_pagebuf(bool list
, char *buf
,
176 const unsigned long *maskp
, int nmaskbits
);
178 #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) % BITS_PER_LONG))
179 #define BITMAP_LAST_WORD_MASK(nbits) \
181 ((nbits) % BITS_PER_LONG) ? \
182 (1UL<<((nbits) % BITS_PER_LONG))-1 : ~0UL \
185 #define small_const_nbits(nbits) \
186 (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG)
188 static inline void bitmap_zero(unsigned long *dst
, unsigned int nbits
)
190 if (small_const_nbits(nbits
))
193 unsigned int len
= BITS_TO_LONGS(nbits
) * sizeof(unsigned long);
198 static inline void bitmap_fill(unsigned long *dst
, unsigned int nbits
)
200 unsigned int nlongs
= BITS_TO_LONGS(nbits
);
201 if (!small_const_nbits(nbits
)) {
202 unsigned int len
= (nlongs
- 1) * sizeof(unsigned long);
203 memset(dst
, 0xff, len
);
205 dst
[nlongs
- 1] = BITMAP_LAST_WORD_MASK(nbits
);
208 static inline void bitmap_copy(unsigned long *dst
, const unsigned long *src
,
211 if (small_const_nbits(nbits
))
214 unsigned int len
= BITS_TO_LONGS(nbits
) * sizeof(unsigned long);
215 memcpy(dst
, src
, len
);
219 static inline int bitmap_and(unsigned long *dst
, const unsigned long *src1
,
220 const unsigned long *src2
, unsigned int nbits
)
222 if (small_const_nbits(nbits
))
223 return (*dst
= *src1
& *src2
& BITMAP_LAST_WORD_MASK(nbits
)) != 0;
224 return __bitmap_and(dst
, src1
, src2
, nbits
);
227 static inline void bitmap_or(unsigned long *dst
, const unsigned long *src1
,
228 const unsigned long *src2
, unsigned int nbits
)
230 if (small_const_nbits(nbits
))
231 *dst
= *src1
| *src2
;
233 __bitmap_or(dst
, src1
, src2
, nbits
);
236 static inline void bitmap_xor(unsigned long *dst
, const unsigned long *src1
,
237 const unsigned long *src2
, unsigned int nbits
)
239 if (small_const_nbits(nbits
))
240 *dst
= *src1
^ *src2
;
242 __bitmap_xor(dst
, src1
, src2
, nbits
);
245 static inline int bitmap_andnot(unsigned long *dst
, const unsigned long *src1
,
246 const unsigned long *src2
, unsigned int nbits
)
248 if (small_const_nbits(nbits
))
249 return (*dst
= *src1
& ~(*src2
) & BITMAP_LAST_WORD_MASK(nbits
)) != 0;
250 return __bitmap_andnot(dst
, src1
, src2
, nbits
);
253 static inline void bitmap_complement(unsigned long *dst
, const unsigned long *src
,
256 if (small_const_nbits(nbits
))
259 __bitmap_complement(dst
, src
, nbits
);
262 static inline int bitmap_equal(const unsigned long *src1
,
263 const unsigned long *src2
, unsigned int nbits
)
265 if (small_const_nbits(nbits
))
266 return ! ((*src1
^ *src2
) & BITMAP_LAST_WORD_MASK(nbits
));
268 return __bitmap_equal(src1
, src2
, nbits
);
271 static inline int bitmap_intersects(const unsigned long *src1
,
272 const unsigned long *src2
, unsigned int nbits
)
274 if (small_const_nbits(nbits
))
275 return ((*src1
& *src2
) & BITMAP_LAST_WORD_MASK(nbits
)) != 0;
277 return __bitmap_intersects(src1
, src2
, nbits
);
280 static inline int bitmap_subset(const unsigned long *src1
,
281 const unsigned long *src2
, unsigned int nbits
)
283 if (small_const_nbits(nbits
))
284 return ! ((*src1
& ~(*src2
)) & BITMAP_LAST_WORD_MASK(nbits
));
286 return __bitmap_subset(src1
, src2
, nbits
);
289 static inline int bitmap_empty(const unsigned long *src
, unsigned nbits
)
291 if (small_const_nbits(nbits
))
292 return ! (*src
& BITMAP_LAST_WORD_MASK(nbits
));
294 return __bitmap_empty(src
, nbits
);
297 static inline int bitmap_full(const unsigned long *src
, unsigned int nbits
)
299 if (small_const_nbits(nbits
))
300 return ! (~(*src
) & BITMAP_LAST_WORD_MASK(nbits
));
302 return __bitmap_full(src
, nbits
);
305 static inline int bitmap_weight(const unsigned long *src
, unsigned int nbits
)
307 if (small_const_nbits(nbits
))
308 return hweight_long(*src
& BITMAP_LAST_WORD_MASK(nbits
));
309 return __bitmap_weight(src
, nbits
);
312 static inline void bitmap_shift_right(unsigned long *dst
,
313 const unsigned long *src
, int n
, int nbits
)
315 if (small_const_nbits(nbits
))
316 *dst
= (*src
& BITMAP_LAST_WORD_MASK(nbits
)) >> n
;
318 __bitmap_shift_right(dst
, src
, n
, nbits
);
321 static inline void bitmap_shift_left(unsigned long *dst
,
322 const unsigned long *src
, int n
, int nbits
)
324 if (small_const_nbits(nbits
))
325 *dst
= (*src
<< n
) & BITMAP_LAST_WORD_MASK(nbits
);
327 __bitmap_shift_left(dst
, src
, n
, nbits
);
330 static inline int bitmap_parse(const char *buf
, unsigned int buflen
,
331 unsigned long *maskp
, int nmaskbits
)
333 return __bitmap_parse(buf
, buflen
, 0, maskp
, nmaskbits
);
336 #endif /* __ASSEMBLY__ */
338 #endif /* __LINUX_BITMAP_H */
This page took 0.039022 seconds and 5 git commands to generate.