blob: e1c8d080c4271d655f75a771ec71ab6ee81c66e3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Jiri Slaby14ed9d22007-10-18 23:40:37 -07009#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
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 *
Andi Kleen08cd3652006-06-26 13:57:10 +020028 * Note that nbits should be always a compile time evaluable constant.
29 * Otherwise many inlines will generate horrible code.
30 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 * 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
Akinobu Mitac1a2a962009-12-15 16:48:25 -080045 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 * bitmap_shift_right(dst, src, n, nbits) *dst = *src >> n
49 * bitmap_shift_left(dst, src, n, nbits) *dst = *src << n
Paul Jacksonfb5eeee2005-10-30 15:02:33 -080050 * bitmap_remap(dst, src, old, new, nbits) *dst = map(old, new)(src)
51 * bitmap_bitremap(oldbit, old, new, nbits) newbit = map(old, new)(oldbit)
Paul Jackson7ea931c2008-04-28 02:12:29 -070052 * bitmap_onto(dst, orig, relmap, nbits) *dst = orig relative to relmap
53 * bitmap_fold(dst, orig, sz, nbits) dst bits = orig bits mod sz
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * bitmap_scnprintf(buf, len, src, nbits) Print bitmap src to buf
Reinette Chatre01a3ee22006-10-11 01:21:55 -070055 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * bitmap_scnlistprintf(buf, len, src, nbits) Print bitmap src as list to buf
Mike Travis4b060422011-05-24 17:13:12 -070058 * bitmap_parselist(buf, dst, nbits) Parse bitmap dst from kernel buf
59 * bitmap_parselist_user(buf, dst, nbits) Parse bitmap dst from user buf
Paul Jackson87e24802006-03-24 03:15:44 -080060 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 */
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
Rasmus Villemoes0679cc42014-08-06 16:09:49 -070091extern int __bitmap_empty(const unsigned long *bitmap, unsigned int nbits);
Rasmus Villemoes83979272014-08-06 16:09:51 -070092extern int __bitmap_full(const unsigned long *bitmap, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093extern int __bitmap_equal(const unsigned long *bitmap1,
Rasmus Villemoes5e0680692014-08-06 16:09:53 -070094 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095extern void __bitmap_complement(unsigned long *dst, const unsigned long *src,
Rasmus Villemoes3d6684f2014-08-06 16:09:55 -070096 unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern void __bitmap_shift_right(unsigned long *dst,
98 const unsigned long *src, int shift, int bits);
99extern void __bitmap_shift_left(unsigned long *dst,
100 const unsigned long *src, int shift, int bits);
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700101extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700102 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700104 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700106 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700107extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700108 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109extern int __bitmap_intersects(const unsigned long *bitmap1,
Rasmus Villemoes6dfe9792014-08-06 16:10:01 -0700110 const unsigned long *bitmap2, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111extern int __bitmap_subset(const unsigned long *bitmap1,
Rasmus Villemoes5be20212014-08-06 16:10:03 -0700112 const unsigned long *bitmap2, unsigned int nbits);
Rasmus Villemoes877d9f32014-08-06 16:10:05 -0700113extern int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Rasmus Villemoesfb5ac542014-08-06 16:10:07 -0700115extern void bitmap_set(unsigned long *map, unsigned int start, int len);
Rasmus Villemoes154f5e32014-08-06 16:10:10 -0700116extern void bitmap_clear(unsigned long *map, unsigned int start, int len);
Akinobu Mitac1a2a962009-12-15 16:48:25 -0800117extern unsigned long bitmap_find_next_zero_area(unsigned long *map,
118 unsigned long size,
119 unsigned long start,
120 unsigned int nr,
121 unsigned long align_mask);
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123extern int bitmap_scnprintf(char *buf, unsigned int len,
124 const unsigned long *src, int nbits);
Reinette Chatre01a3ee22006-10-11 01:21:55 -0700125extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user,
126 unsigned long *dst, int nbits);
127extern int bitmap_parse_user(const char __user *ubuf, unsigned int ulen,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 unsigned long *dst, int nbits);
129extern int bitmap_scnlistprintf(char *buf, unsigned int len,
130 const unsigned long *src, int nbits);
131extern int bitmap_parselist(const char *buf, unsigned long *maskp,
132 int nmaskbits);
Mike Travis4b060422011-05-24 17:13:12 -0700133extern int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen,
134 unsigned long *dst, int nbits);
Paul Jacksonfb5eeee2005-10-30 15:02:33 -0800135extern void bitmap_remap(unsigned long *dst, const unsigned long *src,
136 const unsigned long *old, const unsigned long *new, int bits);
137extern int bitmap_bitremap(int oldbit,
138 const unsigned long *old, const unsigned long *new, int bits);
Paul Jackson7ea931c2008-04-28 02:12:29 -0700139extern void bitmap_onto(unsigned long *dst, const unsigned long *orig,
140 const unsigned long *relmap, int bits);
141extern void bitmap_fold(unsigned long *dst, const unsigned long *orig,
142 int sz, int bits);
Rasmus Villemoes9279d322014-08-06 16:10:16 -0700143extern int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order);
144extern void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order);
145extern int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order);
David Vrabelccbe3292008-09-17 16:34:03 +0100146extern void bitmap_copy_le(void *dst, const unsigned long *src, int nbits);
Michal Hocko778d3b02011-07-26 16:08:30 -0700147extern int bitmap_ord_to_pos(const unsigned long *bitmap, int n, int bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Huang Ying7f184272011-07-13 13:14:24 +0800149#define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) % BITS_PER_LONG))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#define BITMAP_LAST_WORD_MASK(nbits) \
151( \
152 ((nbits) % BITS_PER_LONG) ? \
153 (1UL<<((nbits) % BITS_PER_LONG))-1 : ~0UL \
154)
155
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030156#define small_const_nbits(nbits) \
157 (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG)
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159static inline void bitmap_zero(unsigned long *dst, int nbits)
160{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030161 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 *dst = 0UL;
163 else {
164 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
165 memset(dst, 0, len);
166 }
167}
168
169static inline void bitmap_fill(unsigned long *dst, int nbits)
170{
171 size_t nlongs = BITS_TO_LONGS(nbits);
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030172 if (!small_const_nbits(nbits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 int len = (nlongs - 1) * sizeof(unsigned long);
174 memset(dst, 0xff, len);
175 }
176 dst[nlongs - 1] = BITMAP_LAST_WORD_MASK(nbits);
177}
178
179static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
180 int nbits)
181{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030182 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 *dst = *src;
184 else {
185 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
186 memcpy(dst, src, len);
187 }
188}
189
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700190static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700191 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030193 if (small_const_nbits(nbits))
Rasmus Villemoes7e5f97d2014-08-06 16:10:22 -0700194 return (*dst = *src1 & *src2 & BITMAP_LAST_WORD_MASK(nbits)) != 0;
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700195 return __bitmap_and(dst, src1, src2, nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196}
197
198static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700199 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030201 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 *dst = *src1 | *src2;
203 else
204 __bitmap_or(dst, src1, src2, nbits);
205}
206
207static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700208 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030210 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 *dst = *src1 ^ *src2;
212 else
213 __bitmap_xor(dst, src1, src2, nbits);
214}
215
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700216static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
Rasmus Villemoes2f9305e2014-08-06 16:09:59 -0700217 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030219 if (small_const_nbits(nbits))
Rasmus Villemoes74e76532014-08-06 16:10:24 -0700220 return (*dst = *src1 & ~(*src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700221 return __bitmap_andnot(dst, src1, src2, nbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222}
223
224static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
Rasmus Villemoes3d6684f2014-08-06 16:09:55 -0700225 unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030227 if (small_const_nbits(nbits))
Rasmus Villemoes65b4ee62014-08-06 16:09:57 -0700228 *dst = ~(*src);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 else
230 __bitmap_complement(dst, src, nbits);
231}
232
233static inline int bitmap_equal(const unsigned long *src1,
Rasmus Villemoes3d6684f2014-08-06 16:09:55 -0700234 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030236 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 return ! ((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
238 else
239 return __bitmap_equal(src1, src2, nbits);
240}
241
242static inline int bitmap_intersects(const unsigned long *src1,
Rasmus Villemoes6dfe9792014-08-06 16:10:01 -0700243 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030245 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
247 else
248 return __bitmap_intersects(src1, src2, nbits);
249}
250
251static inline int bitmap_subset(const unsigned long *src1,
Rasmus Villemoes5be20212014-08-06 16:10:03 -0700252 const unsigned long *src2, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030254 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
256 else
257 return __bitmap_subset(src1, src2, nbits);
258}
259
Rasmus Villemoes0679cc42014-08-06 16:09:49 -0700260static inline int bitmap_empty(const unsigned long *src, unsigned nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030262 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
264 else
265 return __bitmap_empty(src, nbits);
266}
267
Rasmus Villemoes83979272014-08-06 16:09:51 -0700268static inline int bitmap_full(const unsigned long *src, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030270 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
272 else
273 return __bitmap_full(src, nbits);
274}
275
Rasmus Villemoes877d9f32014-08-06 16:10:05 -0700276static inline int bitmap_weight(const unsigned long *src, unsigned int nbits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030278 if (small_const_nbits(nbits))
Andi Kleen08cd3652006-06-26 13:57:10 +0200279 return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 return __bitmap_weight(src, nbits);
281}
282
283static inline void bitmap_shift_right(unsigned long *dst,
284 const unsigned long *src, int n, int nbits)
285{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030286 if (small_const_nbits(nbits))
Rasmus Villemoesc5341ec892014-08-06 16:10:20 -0700287 *dst = (*src & BITMAP_LAST_WORD_MASK(nbits)) >> n;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 else
289 __bitmap_shift_right(dst, src, n, nbits);
290}
291
292static inline void bitmap_shift_left(unsigned long *dst,
293 const unsigned long *src, int n, int nbits)
294{
Rusty Russell4b0bc0b2008-12-30 09:05:13 +1030295 if (small_const_nbits(nbits))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 *dst = (*src << n) & BITMAP_LAST_WORD_MASK(nbits);
297 else
298 __bitmap_shift_left(dst, src, n, nbits);
299}
300
Reinette Chatre01a3ee22006-10-11 01:21:55 -0700301static inline int bitmap_parse(const char *buf, unsigned int buflen,
302 unsigned long *maskp, int nmaskbits)
303{
304 return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
305}
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#endif /* __ASSEMBLY__ */
308
309#endif /* __LINUX_BITMAP_H */