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