Updated GETTING_STARTED with busybox info
[akaros.git] / kern / include / bitmap.h
1 #ifndef __LINUX_BITMAP_H
2 #define __LINUX_BITMAP_H
3
4 /*
5  * bitmaps provide bit arrays that consume one or more unsigned
6  * longs.  The bitmap interface and available operations are listed
7  * here, in bitmap.h
8  *
9  * Function implementations generic to all architectures are in
10  * lib/bitmap.c.  Functions implementations that are architecture
11  * specific are in various include/asm-<arch>/bitops.h headers
12  * and other arch/<arch> specific files.
13  *
14  * See lib/bitmap.c for more details.
15  */
16
17 /*
18  * The available bitmap operations and their rough meaning in the
19  * case that the bitmap is a single unsigned long are thus:
20  *
21  * Note that nbits should be always a compile time evaluable constant.
22  * Otherwise many inlines will generate horrible code.
23  *
24  * bitmap_zero(dst, nbits)                      *dst = 0UL
25  * bitmap_fill(dst, nbits)                      *dst = ~0UL
26  * bitmap_copy(dst, src, nbits)                 *dst = *src
27  * bitmap_and(dst, src1, src2, nbits)           *dst = *src1 & *src2
28  * bitmap_or(dst, src1, src2, nbits)            *dst = *src1 | *src2
29  * bitmap_xor(dst, src1, src2, nbits)           *dst = *src1 ^ *src2
30  * bitmap_andnot(dst, src1, src2, nbits)        *dst = *src1 & ~(*src2)
31  * bitmap_complement(dst, src, nbits)           *dst = ~(*src)
32  * bitmap_equal(src1, src2, nbits)              Are *src1 and *src2 equal?
33  * bitmap_intersects(src1, src2, nbits)         Do *src1 and *src2 overlap?
34  * bitmap_subset(src1, src2, nbits)             Is *src1 a subset of *src2?
35  * bitmap_empty(src, nbits)                     Are all bits zero in *src?
36  * bitmap_full(src, nbits)                      Are all bits set in *src?
37  * bitmap_weight(src, nbits)                    Hamming Weight: number set bits
38  * bitmap_set(dst, pos, nbits)                  Set specified bit area
39  * bitmap_clear(dst, pos, nbits)                Clear specified bit area
40  * bitmap_find_next_zero_area(buf, len, pos, n, mask)   Find bit free area
41  * bitmap_shift_right(dst, src, n, nbits)       *dst = *src >> n
42  * bitmap_shift_left(dst, src, n, nbits)        *dst = *src << n
43  * bitmap_remap(dst, src, old, new, nbits)      *dst = map(old, new)(src)
44  * bitmap_bitremap(oldbit, old, new, nbits)     newbit = map(old, new)(oldbit)
45  * bitmap_onto(dst, orig, relmap, nbits)        *dst = orig relative to relmap
46  * bitmap_fold(dst, orig, sz, nbits)            dst bits = orig bits mod sz
47  * bitmap_scnprintf(buf, len, src, nbits)       Print bitmap src to buf
48  * bitmap_parse(buf, buflen, dst, nbits)        Parse bitmap dst from kernel buf
49  * bitmap_parse_user(ubuf, ulen, dst, nbits)    Parse bitmap dst from user buf
50  * bitmap_scnlistprintf(buf, len, src, nbits)   Print bitmap src as list to buf
51  * bitmap_parselist(buf, dst, nbits)            Parse bitmap dst from kernel buf
52  * bitmap_parselist_user(buf, dst, nbits)       Parse bitmap dst from user buf
53  * bitmap_find_free_region(bitmap, bits, order) Find and allocate bit region
54  * bitmap_release_region(bitmap, pos, order)    Free specified bit region
55  * bitmap_allocate_region(bitmap, pos, order)   Allocate specified bit region
56  */
57
58 /*
59  * Also the following operations in asm/bitops.h apply to bitmaps.
60  *
61  * set_bit(bit, addr)                   *addr |= bit
62  * clear_bit(bit, addr)                 *addr &= ~bit
63  * change_bit(bit, addr)                *addr ^= bit
64  * test_bit(bit, addr)                  Is bit set in *addr?
65  * test_and_set_bit(bit, addr)          Set bit and return old value
66  * test_and_clear_bit(bit, addr)        Clear bit and return old value
67  * test_and_change_bit(bit, addr)       Change bit and return old value
68  * find_first_zero_bit(addr, nbits)     Position first zero bit in *addr
69  * find_first_bit(addr, nbits)          Position first set bit in *addr
70  * find_next_zero_bit(addr, nbits, bit) Position next zero bit in *addr >= bit
71  * find_next_bit(addr, nbits, bit)      Position next set bit in *addr >= bit
72  */
73
74 /*
75  * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
76  * to declare an array named 'name' of just enough unsigned longs to
77  * contain all bit positions from 0 to 'bits' - 1.
78  */
79
80 /*
81  * lib/bitmap.c provides these functions:
82  */
83
84 extern int __bitmap_empty(const unsigned long *bitmap, int bits);
85 extern int __bitmap_full(const unsigned long *bitmap, int bits);
86 extern int __bitmap_equal(const unsigned long *bitmap1,
87                         const unsigned long *bitmap2, int bits);
88 extern void __bitmap_complement(unsigned long *dst, const unsigned long *src,
89                         int bits);
90 extern void __bitmap_shift_right(unsigned long *dst,
91                         const unsigned long *src, int shift, int bits);
92 extern void __bitmap_shift_left(unsigned long *dst,
93                         const unsigned long *src, int shift, int bits);
94 extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
95                         const unsigned long *bitmap2, int bits);
96 extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
97                         const unsigned long *bitmap2, int bits);
98 extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
99                         const unsigned long *bitmap2, int bits);
100 extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
101                         const unsigned long *bitmap2, int bits);
102 extern int __bitmap_intersects(const unsigned long *bitmap1,
103                         const unsigned long *bitmap2, int bits);
104 extern int __bitmap_subset(const unsigned long *bitmap1,
105                         const unsigned long *bitmap2, int bits);
106 extern int __bitmap_weight(const unsigned long *bitmap, int bits);
107
108 extern void bitmap_set(unsigned long *map, int i, int len);
109 extern void bitmap_clear(unsigned long *map, int start, int nr);
110 extern unsigned long bitmap_find_next_zero_area(unsigned long *map,
111                                          unsigned long size,
112                                          unsigned long start,
113                                          unsigned int nr,
114                                          unsigned long align_mask);
115
116 extern int bitmap_scnprintf(char *buf, unsigned int len,
117                         const unsigned long *src, int nbits);
118 extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user,
119                         unsigned long *dst, int nbits);
120 extern int bitmap_parse_user(const char *ubuf, unsigned int ulen,
121                         unsigned long *dst, int nbits);
122 extern int bitmap_scnlistprintf(char *buf, unsigned int len,
123                         const unsigned long *src, int nbits);
124 extern int bitmap_parselist(const char *buf, unsigned long *maskp,
125                         int nmaskbits);
126 extern int bitmap_parselist_user(const char *ubuf, unsigned int ulen,
127                         unsigned long *dst, int nbits);
128 extern void bitmap_remap(unsigned long *dst, const unsigned long *src,
129                 const unsigned long *old, const unsigned long *new, int bits);
130 extern int bitmap_bitremap(int oldbit,
131                 const unsigned long *old, const unsigned long *new, int bits);
132 extern void bitmap_onto(unsigned long *dst, const unsigned long *orig,
133                 const unsigned long *relmap, int bits);
134 extern void bitmap_fold(unsigned long *dst, const unsigned long *orig,
135                 int sz, int bits);
136 extern int bitmap_find_free_region(unsigned long *bitmap, int bits, int order);
137 extern void bitmap_release_region(unsigned long *bitmap, int pos, int order);
138 extern int bitmap_allocate_region(unsigned long *bitmap, int pos, int order);
139 extern void bitmap_copy_le(void *dst, const unsigned long *src, int nbits);
140 extern int bitmap_ord_to_pos(const unsigned long *bitmap, int n, int bits);
141
142 #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) % BITS_PER_LONG))
143 #define BITMAP_LAST_WORD_MASK(nbits)                                    \
144 (                                                                       \
145         ((nbits) % BITS_PER_LONG) ?                                     \
146                 (1UL<<((nbits) % BITS_PER_LONG))-1 : ~0UL               \
147 )
148
149 #define small_const_nbits(nbits) \
150         (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG)
151
152 static inline void bitmap_zero(unsigned long *dst, int nbits)
153 {
154         if (small_const_nbits(nbits))
155                 *dst = 0UL;
156         else {
157                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
158                 memset(dst, 0, len);
159         }
160 }
161
162 static inline void bitmap_fill(unsigned long *dst, int nbits)
163 {
164         size_t nlongs = BITS_TO_LONGS(nbits);
165         if (!small_const_nbits(nbits)) {
166                 int len = (nlongs - 1) * sizeof(unsigned long);
167                 memset(dst, 0xff,  len);
168         }
169         dst[nlongs - 1] = BITMAP_LAST_WORD_MASK(nbits);
170 }
171
172 static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
173                         int nbits)
174 {
175         if (small_const_nbits(nbits))
176                 *dst = *src;
177         else {
178                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
179                 memcpy(dst, src, len);
180         }
181 }
182
183 static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
184                         const unsigned long *src2, int nbits)
185 {
186         if (small_const_nbits(nbits))
187                 return (*dst = *src1 & *src2) != 0;
188         return __bitmap_and(dst, src1, src2, nbits);
189 }
190
191 static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
192                         const unsigned long *src2, int nbits)
193 {
194         if (small_const_nbits(nbits))
195                 *dst = *src1 | *src2;
196         else
197                 __bitmap_or(dst, src1, src2, nbits);
198 }
199
200 static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
201                         const unsigned long *src2, int nbits)
202 {
203         if (small_const_nbits(nbits))
204                 *dst = *src1 ^ *src2;
205         else
206                 __bitmap_xor(dst, src1, src2, nbits);
207 }
208
209 static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
210                         const unsigned long *src2, int nbits)
211 {
212         if (small_const_nbits(nbits))
213                 return (*dst = *src1 & ~(*src2)) != 0;
214         return __bitmap_andnot(dst, src1, src2, nbits);
215 }
216
217 static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
218                         int nbits)
219 {
220         if (small_const_nbits(nbits))
221                 *dst = ~(*src) & BITMAP_LAST_WORD_MASK(nbits);
222         else
223                 __bitmap_complement(dst, src, nbits);
224 }
225
226 static inline int bitmap_equal(const unsigned long *src1,
227                         const unsigned long *src2, int nbits)
228 {
229         if (small_const_nbits(nbits))
230                 return ! ((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
231         else
232                 return __bitmap_equal(src1, src2, nbits);
233 }
234
235 static inline int bitmap_intersects(const unsigned long *src1,
236                         const unsigned long *src2, int nbits)
237 {
238         if (small_const_nbits(nbits))
239                 return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
240         else
241                 return __bitmap_intersects(src1, src2, nbits);
242 }
243
244 static inline int bitmap_subset(const unsigned long *src1,
245                         const unsigned long *src2, int nbits)
246 {
247         if (small_const_nbits(nbits))
248                 return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
249         else
250                 return __bitmap_subset(src1, src2, nbits);
251 }
252
253 static inline int bitmap_empty(const unsigned long *src, int nbits)
254 {
255         if (small_const_nbits(nbits))
256                 return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
257         else
258                 return __bitmap_empty(src, nbits);
259 }
260
261 static inline int bitmap_full(const unsigned long *src, int nbits)
262 {
263         if (small_const_nbits(nbits))
264                 return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
265         else
266                 return __bitmap_full(src, nbits);
267 }
268
269 static inline int bitmap_weight(const unsigned long *src, int nbits)
270 {
271         if (small_const_nbits(nbits))
272                 return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
273         return __bitmap_weight(src, nbits);
274 }
275
276 static inline void bitmap_shift_right(unsigned long *dst,
277                         const unsigned long *src, int n, int nbits)
278 {
279         if (small_const_nbits(nbits))
280                 *dst = *src >> n;
281         else
282                 __bitmap_shift_right(dst, src, n, nbits);
283 }
284
285 static inline void bitmap_shift_left(unsigned long *dst,
286                         const unsigned long *src, int n, int nbits)
287 {
288         if (small_const_nbits(nbits))
289                 *dst = (*src << n) & BITMAP_LAST_WORD_MASK(nbits);
290         else
291                 __bitmap_shift_left(dst, src, n, nbits);
292 }
293
294 static inline int bitmap_parse(const char *buf, unsigned int buflen,
295                         unsigned long *maskp, int nmaskbits)
296 {
297         return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
298 }
299
300 #endif /* __LINUX_BITMAP_H */