]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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> | |
14ed9d23 | 9 | #include <linux/kernel.h> |
1da177e4 LT |
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 | * | |
08cd3657 AK |
28 | * Note that nbits should be always a compile time evaluable constant. |
29 | * Otherwise many inlines will generate horrible code. | |
30 | * | |
1da177e4 LT |
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 | |
c1a2a962 AM |
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 | |
5e19b013 | 48 | * bitmap_find_next_zero_area_off(buf, len, pos, n, mask) as above |
1da177e4 LT |
49 | * bitmap_shift_right(dst, src, n, nbits) *dst = *src >> n |
50 | * bitmap_shift_left(dst, src, n, nbits) *dst = *src << n | |
fb5eeeee PJ |
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) | |
7ea931c9 PJ |
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 | |
01a3ee2b RC |
55 | * bitmap_parse(buf, buflen, dst, nbits) Parse bitmap dst from kernel buf |
56 | * bitmap_parse_user(ubuf, ulen, dst, nbits) Parse bitmap dst from user buf | |
4b060420 MT |
57 | * bitmap_parselist(buf, dst, nbits) Parse bitmap dst from kernel buf |
58 | * bitmap_parselist_user(buf, dst, nbits) Parse bitmap dst from user buf | |
87e24802 PJ |
59 | * bitmap_find_free_region(bitmap, bits, order) Find and allocate bit region |
60 | * bitmap_release_region(bitmap, pos, order) Free specified bit region | |
61 | * bitmap_allocate_region(bitmap, pos, order) Allocate specified bit region | |
e52bc7c2 DD |
62 | * bitmap_from_u32array(dst, nbits, buf, nwords) *dst = *buf (nwords 32b words) |
63 | * bitmap_to_u32array(buf, nwords, src, nbits) *buf = *dst (nwords 32b words) | |
1da177e4 LT |
64 | */ |
65 | ||
66 | /* | |
67 | * Also the following operations in asm/bitops.h apply to bitmaps. | |
68 | * | |
69 | * set_bit(bit, addr) *addr |= bit | |
70 | * clear_bit(bit, addr) *addr &= ~bit | |
71 | * change_bit(bit, addr) *addr ^= bit | |
72 | * test_bit(bit, addr) Is bit set in *addr? | |
73 | * test_and_set_bit(bit, addr) Set bit and return old value | |
74 | * test_and_clear_bit(bit, addr) Clear bit and return old value | |
75 | * test_and_change_bit(bit, addr) Change bit and return old value | |
76 | * find_first_zero_bit(addr, nbits) Position first zero bit in *addr | |
77 | * find_first_bit(addr, nbits) Position first set bit in *addr | |
78 | * find_next_zero_bit(addr, nbits, bit) Position next zero bit in *addr >= bit | |
79 | * find_next_bit(addr, nbits, bit) Position next set bit in *addr >= bit | |
80 | */ | |
81 | ||
82 | /* | |
83 | * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used | |
84 | * to declare an array named 'name' of just enough unsigned longs to | |
85 | * contain all bit positions from 0 to 'bits' - 1. | |
86 | */ | |
87 | ||
88 | /* | |
89 | * lib/bitmap.c provides these functions: | |
90 | */ | |
91 | ||
0679cc48 | 92 | extern int __bitmap_empty(const unsigned long *bitmap, unsigned int nbits); |
8397927c | 93 | extern int __bitmap_full(const unsigned long *bitmap, unsigned int nbits); |
1da177e4 | 94 | extern int __bitmap_equal(const unsigned long *bitmap1, |
5e068069 | 95 | const unsigned long *bitmap2, unsigned int nbits); |
1da177e4 | 96 | extern void __bitmap_complement(unsigned long *dst, const unsigned long *src, |
3d6684f4 | 97 | unsigned int nbits); |
2fbad299 RV |
98 | extern void __bitmap_shift_right(unsigned long *dst, const unsigned long *src, |
99 | unsigned int shift, unsigned int nbits); | |
dba94c25 RV |
100 | extern void __bitmap_shift_left(unsigned long *dst, const unsigned long *src, |
101 | unsigned int shift, unsigned int nbits); | |
f4b0373b | 102 | extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1, |
2f9305eb | 103 | const unsigned long *bitmap2, unsigned int nbits); |
1da177e4 | 104 | extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1, |
2f9305eb | 105 | const unsigned long *bitmap2, unsigned int nbits); |
1da177e4 | 106 | extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1, |
2f9305eb | 107 | const unsigned long *bitmap2, unsigned int nbits); |
f4b0373b | 108 | extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1, |
2f9305eb | 109 | const unsigned long *bitmap2, unsigned int nbits); |
1da177e4 | 110 | extern int __bitmap_intersects(const unsigned long *bitmap1, |
6dfe9799 | 111 | const unsigned long *bitmap2, unsigned int nbits); |
1da177e4 | 112 | extern int __bitmap_subset(const unsigned long *bitmap1, |
5be20213 | 113 | const unsigned long *bitmap2, unsigned int nbits); |
877d9f3b | 114 | extern int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits); |
1da177e4 | 115 | |
fb5ac542 | 116 | extern void bitmap_set(unsigned long *map, unsigned int start, int len); |
154f5e38 | 117 | extern void bitmap_clear(unsigned long *map, unsigned int start, int len); |
5e19b013 MN |
118 | |
119 | extern unsigned long bitmap_find_next_zero_area_off(unsigned long *map, | |
120 | unsigned long size, | |
121 | unsigned long start, | |
122 | unsigned int nr, | |
123 | unsigned long align_mask, | |
124 | unsigned long align_offset); | |
125 | ||
126 | /** | |
127 | * bitmap_find_next_zero_area - find a contiguous aligned zero area | |
128 | * @map: The address to base the search on | |
129 | * @size: The bitmap size in bits | |
130 | * @start: The bitnumber to start searching at | |
131 | * @nr: The number of zeroed bits we're looking for | |
132 | * @align_mask: Alignment mask for zero area | |
133 | * | |
134 | * The @align_mask should be one less than a power of 2; the effect is that | |
135 | * the bit offset of all zero areas this function finds is multiples of that | |
136 | * power of 2. A @align_mask of 0 means no alignment is required. | |
137 | */ | |
138 | static inline unsigned long | |
139 | bitmap_find_next_zero_area(unsigned long *map, | |
140 | unsigned long size, | |
141 | unsigned long start, | |
142 | unsigned int nr, | |
143 | unsigned long align_mask) | |
144 | { | |
145 | return bitmap_find_next_zero_area_off(map, size, start, nr, | |
146 | align_mask, 0); | |
147 | } | |
c1a2a962 | 148 | |
01a3ee2b RC |
149 | extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user, |
150 | unsigned long *dst, int nbits); | |
151 | extern int bitmap_parse_user(const char __user *ubuf, unsigned int ulen, | |
1da177e4 | 152 | unsigned long *dst, int nbits); |
1da177e4 LT |
153 | extern int bitmap_parselist(const char *buf, unsigned long *maskp, |
154 | int nmaskbits); | |
4b060420 MT |
155 | extern int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen, |
156 | unsigned long *dst, int nbits); | |
fb5eeeee | 157 | extern void bitmap_remap(unsigned long *dst, const unsigned long *src, |
9814ec13 | 158 | const unsigned long *old, const unsigned long *new, unsigned int nbits); |
fb5eeeee PJ |
159 | extern int bitmap_bitremap(int oldbit, |
160 | const unsigned long *old, const unsigned long *new, int bits); | |
7ea931c9 | 161 | extern void bitmap_onto(unsigned long *dst, const unsigned long *orig, |
eb569883 | 162 | const unsigned long *relmap, unsigned int bits); |
7ea931c9 | 163 | extern void bitmap_fold(unsigned long *dst, const unsigned long *orig, |
b26ad583 | 164 | unsigned int sz, unsigned int nbits); |
9279d328 RV |
165 | extern int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order); |
166 | extern void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order); | |
167 | extern int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order); | |
e52bc7c2 DD |
168 | extern unsigned int bitmap_from_u32array(unsigned long *bitmap, |
169 | unsigned int nbits, | |
170 | const u32 *buf, | |
171 | unsigned int nwords); | |
172 | extern unsigned int bitmap_to_u32array(u32 *buf, | |
173 | unsigned int nwords, | |
174 | const unsigned long *bitmap, | |
175 | unsigned int nbits); | |
e8f24278 | 176 | #ifdef __BIG_ENDIAN |
9b6c2d2e | 177 | extern void bitmap_copy_le(unsigned long *dst, const unsigned long *src, unsigned int nbits); |
e8f24278 RV |
178 | #else |
179 | #define bitmap_copy_le bitmap_copy | |
180 | #endif | |
f6a1f5db | 181 | extern unsigned int bitmap_ord_to_pos(const unsigned long *bitmap, unsigned int ord, unsigned int nbits); |
5aaba363 SH |
182 | extern int bitmap_print_to_pagebuf(bool list, char *buf, |
183 | const unsigned long *maskp, int nmaskbits); | |
1da177e4 | 184 | |
89c1e79e RV |
185 | #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) & (BITS_PER_LONG - 1))) |
186 | #define BITMAP_LAST_WORD_MASK(nbits) (~0UL >> (-(nbits) & (BITS_PER_LONG - 1))) | |
1da177e4 | 187 | |
4b0bc0bc RR |
188 | #define small_const_nbits(nbits) \ |
189 | (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG) | |
190 | ||
8b4daad5 | 191 | static inline void bitmap_zero(unsigned long *dst, unsigned int nbits) |
1da177e4 | 192 | { |
4b0bc0bc | 193 | if (small_const_nbits(nbits)) |
1da177e4 LT |
194 | *dst = 0UL; |
195 | else { | |
8b4daad5 | 196 | unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); |
1da177e4 LT |
197 | memset(dst, 0, len); |
198 | } | |
199 | } | |
200 | ||
8b4daad5 | 201 | static inline void bitmap_fill(unsigned long *dst, unsigned int nbits) |
1da177e4 | 202 | { |
8b4daad5 | 203 | unsigned int nlongs = BITS_TO_LONGS(nbits); |
4b0bc0bc | 204 | if (!small_const_nbits(nbits)) { |
8b4daad5 | 205 | unsigned int len = (nlongs - 1) * sizeof(unsigned long); |
1da177e4 LT |
206 | memset(dst, 0xff, len); |
207 | } | |
208 | dst[nlongs - 1] = BITMAP_LAST_WORD_MASK(nbits); | |
209 | } | |
210 | ||
211 | static inline void bitmap_copy(unsigned long *dst, const unsigned long *src, | |
8b4daad5 | 212 | unsigned int nbits) |
1da177e4 | 213 | { |
4b0bc0bc | 214 | if (small_const_nbits(nbits)) |
1da177e4 LT |
215 | *dst = *src; |
216 | else { | |
8b4daad5 | 217 | unsigned int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); |
1da177e4 LT |
218 | memcpy(dst, src, len); |
219 | } | |
220 | } | |
221 | ||
f4b0373b | 222 | static inline int bitmap_and(unsigned long *dst, const unsigned long *src1, |
2f9305eb | 223 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 224 | { |
4b0bc0bc | 225 | if (small_const_nbits(nbits)) |
7e5f97d1 | 226 | return (*dst = *src1 & *src2 & BITMAP_LAST_WORD_MASK(nbits)) != 0; |
f4b0373b | 227 | return __bitmap_and(dst, src1, src2, nbits); |
1da177e4 LT |
228 | } |
229 | ||
230 | static inline void bitmap_or(unsigned long *dst, const unsigned long *src1, | |
2f9305eb | 231 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 232 | { |
4b0bc0bc | 233 | if (small_const_nbits(nbits)) |
1da177e4 LT |
234 | *dst = *src1 | *src2; |
235 | else | |
236 | __bitmap_or(dst, src1, src2, nbits); | |
237 | } | |
238 | ||
239 | static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1, | |
2f9305eb | 240 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 241 | { |
4b0bc0bc | 242 | if (small_const_nbits(nbits)) |
1da177e4 LT |
243 | *dst = *src1 ^ *src2; |
244 | else | |
245 | __bitmap_xor(dst, src1, src2, nbits); | |
246 | } | |
247 | ||
f4b0373b | 248 | static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1, |
2f9305eb | 249 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 250 | { |
4b0bc0bc | 251 | if (small_const_nbits(nbits)) |
74e76531 | 252 | return (*dst = *src1 & ~(*src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0; |
f4b0373b | 253 | return __bitmap_andnot(dst, src1, src2, nbits); |
1da177e4 LT |
254 | } |
255 | ||
256 | static inline void bitmap_complement(unsigned long *dst, const unsigned long *src, | |
3d6684f4 | 257 | unsigned int nbits) |
1da177e4 | 258 | { |
4b0bc0bc | 259 | if (small_const_nbits(nbits)) |
65b4ee62 | 260 | *dst = ~(*src); |
1da177e4 LT |
261 | else |
262 | __bitmap_complement(dst, src, nbits); | |
263 | } | |
264 | ||
265 | static inline int bitmap_equal(const unsigned long *src1, | |
3d6684f4 | 266 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 267 | { |
4b0bc0bc | 268 | if (small_const_nbits(nbits)) |
4b9d314c | 269 | return !((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits)); |
7dd96816 | 270 | #ifdef CONFIG_S390 |
4b9d314c | 271 | if (__builtin_constant_p(nbits) && (nbits % BITS_PER_LONG) == 0) |
7dd96816 MS |
272 | return !memcmp(src1, src2, nbits / 8); |
273 | #endif | |
4b9d314c | 274 | return __bitmap_equal(src1, src2, nbits); |
1da177e4 LT |
275 | } |
276 | ||
277 | static inline int bitmap_intersects(const unsigned long *src1, | |
6dfe9799 | 278 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 279 | { |
4b0bc0bc | 280 | if (small_const_nbits(nbits)) |
1da177e4 LT |
281 | return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0; |
282 | else | |
283 | return __bitmap_intersects(src1, src2, nbits); | |
284 | } | |
285 | ||
286 | static inline int bitmap_subset(const unsigned long *src1, | |
5be20213 | 287 | const unsigned long *src2, unsigned int nbits) |
1da177e4 | 288 | { |
4b0bc0bc | 289 | if (small_const_nbits(nbits)) |
1da177e4 LT |
290 | return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits)); |
291 | else | |
292 | return __bitmap_subset(src1, src2, nbits); | |
293 | } | |
294 | ||
0679cc48 | 295 | static inline int bitmap_empty(const unsigned long *src, unsigned nbits) |
1da177e4 | 296 | { |
4b0bc0bc | 297 | if (small_const_nbits(nbits)) |
1da177e4 | 298 | return ! (*src & BITMAP_LAST_WORD_MASK(nbits)); |
2afe27c7 YN |
299 | |
300 | return find_first_bit(src, nbits) == nbits; | |
1da177e4 LT |
301 | } |
302 | ||
8397927c | 303 | static inline int bitmap_full(const unsigned long *src, unsigned int nbits) |
1da177e4 | 304 | { |
4b0bc0bc | 305 | if (small_const_nbits(nbits)) |
1da177e4 | 306 | return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits)); |
2afe27c7 YN |
307 | |
308 | return find_first_zero_bit(src, nbits) == nbits; | |
1da177e4 LT |
309 | } |
310 | ||
1a1d48a4 | 311 | static __always_inline int bitmap_weight(const unsigned long *src, unsigned int nbits) |
1da177e4 | 312 | { |
4b0bc0bc | 313 | if (small_const_nbits(nbits)) |
08cd3657 | 314 | return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits)); |
1da177e4 LT |
315 | return __bitmap_weight(src, nbits); |
316 | } | |
317 | ||
2fbad299 RV |
318 | static inline void bitmap_shift_right(unsigned long *dst, const unsigned long *src, |
319 | unsigned int shift, int nbits) | |
1da177e4 | 320 | { |
4b0bc0bc | 321 | if (small_const_nbits(nbits)) |
2fbad299 | 322 | *dst = (*src & BITMAP_LAST_WORD_MASK(nbits)) >> shift; |
1da177e4 | 323 | else |
2fbad299 | 324 | __bitmap_shift_right(dst, src, shift, nbits); |
1da177e4 LT |
325 | } |
326 | ||
dba94c25 RV |
327 | static inline void bitmap_shift_left(unsigned long *dst, const unsigned long *src, |
328 | unsigned int shift, unsigned int nbits) | |
1da177e4 | 329 | { |
4b0bc0bc | 330 | if (small_const_nbits(nbits)) |
dba94c25 | 331 | *dst = (*src << shift) & BITMAP_LAST_WORD_MASK(nbits); |
1da177e4 | 332 | else |
dba94c25 | 333 | __bitmap_shift_left(dst, src, shift, nbits); |
1da177e4 LT |
334 | } |
335 | ||
01a3ee2b RC |
336 | static inline int bitmap_parse(const char *buf, unsigned int buflen, |
337 | unsigned long *maskp, int nmaskbits) | |
338 | { | |
339 | return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits); | |
340 | } | |
341 | ||
29dd3288 MS |
342 | /* |
343 | * bitmap_from_u64 - Check and swap words within u64. | |
344 | * @mask: source bitmap | |
345 | * @dst: destination bitmap | |
346 | * | |
347 | * In 32-bit Big Endian kernel, when using (u32 *)(&val)[*] | |
348 | * to read u64 mask, we will get the wrong word. | |
349 | * That is "(u32 *)(&val)[0]" gets the upper 32 bits, | |
350 | * but we expect the lower 32-bits of u64. | |
351 | */ | |
352 | static inline void bitmap_from_u64(unsigned long *dst, u64 mask) | |
353 | { | |
354 | dst[0] = mask & ULONG_MAX; | |
355 | ||
356 | if (sizeof(mask) > sizeof(unsigned long)) | |
357 | dst[1] = mask >> 32; | |
358 | } | |
359 | ||
1da177e4 LT |
360 | #endif /* __ASSEMBLY__ */ |
361 | ||
362 | #endif /* __LINUX_BITMAP_H */ |