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