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