alarm: Force unset_alarm to grab the CV lock
[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  * bitmap_size(nbits)                           Size in bytes
58  */
59
60 /*
61  * Also the following operations in asm/bitops.h apply to bitmaps.
62  *
63  * set_bit(bit, addr)                   *addr |= bit
64  * clear_bit(bit, addr)                 *addr &= ~bit
65  * change_bit(bit, addr)                *addr ^= bit
66  * test_bit(bit, addr)                  Is bit set in *addr?
67  * test_and_set_bit(bit, addr)          Set bit and return old value
68  * test_and_clear_bit(bit, addr)        Clear bit and return old value
69  * test_and_change_bit(bit, addr)       Change bit and return old value
70  * find_first_zero_bit(addr, nbits)     Position first zero bit in *addr
71  * find_first_bit(addr, nbits)          Position first set bit in *addr
72  * find_next_zero_bit(addr, nbits, bit) Position next zero bit in *addr >= bit
73  * find_next_bit(addr, nbits, bit)      Position next set bit in *addr >= bit
74  */
75
76 /*
77  * The DECLARE_BITMAP(name,bits) macro, in linux/types.h, can be used
78  * to declare an array named 'name' of just enough unsigned longs to
79  * contain all bit positions from 0 to 'bits' - 1.
80  */
81
82 /*
83  * lib/bitmap.c provides these functions:
84  */
85
86 extern int __bitmap_empty(const unsigned long *bitmap, int bits);
87 extern int __bitmap_full(const unsigned long *bitmap, int bits);
88 extern int __bitmap_equal(const unsigned long *bitmap1,
89                         const unsigned long *bitmap2, int bits);
90 extern void __bitmap_complement(unsigned long *dst, const unsigned long *src,
91                         int bits);
92 extern void __bitmap_shift_right(unsigned long *dst,
93                         const unsigned long *src, int shift, int bits);
94 extern void __bitmap_shift_left(unsigned long *dst,
95                         const unsigned long *src, int shift, int bits);
96 extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1,
97                         const unsigned long *bitmap2, int bits);
98 extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1,
99                         const unsigned long *bitmap2, int bits);
100 extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1,
101                         const unsigned long *bitmap2, int bits);
102 extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1,
103                         const unsigned long *bitmap2, int bits);
104 extern int __bitmap_intersects(const unsigned long *bitmap1,
105                         const unsigned long *bitmap2, int bits);
106 extern int __bitmap_subset(const unsigned long *bitmap1,
107                         const unsigned long *bitmap2, int bits);
108 extern int __bitmap_weight(const unsigned long *bitmap, int bits);
109
110 extern void bitmap_set(unsigned long *map, int i, int len);
111 extern void bitmap_clear(unsigned long *map, int start, int nr);
112 extern unsigned long bitmap_find_next_zero_area(unsigned long *map,
113                                          unsigned long size,
114                                          unsigned long start,
115                                          unsigned int nr,
116                                          unsigned long align_mask);
117
118 extern int bitmap_scnprintf(char *buf, unsigned int len,
119                         const unsigned long *src, int nbits);
120 extern int __bitmap_parse(const char *buf, unsigned int buflen, int is_user,
121                         unsigned long *dst, int nbits);
122 extern int bitmap_parse_user(const char *ubuf, unsigned int ulen,
123                         unsigned long *dst, int nbits);
124 extern int bitmap_scnlistprintf(char *buf, unsigned int len,
125                         const unsigned long *src, int nbits);
126 extern int bitmap_parselist(const char *buf, unsigned long *maskp,
127                         int nmaskbits);
128 extern int bitmap_parselist_user(const char *ubuf, unsigned int ulen,
129                         unsigned long *dst, int nbits);
130 extern void bitmap_remap(unsigned long *dst, const unsigned long *src,
131                 const unsigned long *old, const unsigned long *new, int bits);
132 extern int bitmap_bitremap(int oldbit,
133                 const unsigned long *old, const unsigned long *new, int bits);
134 extern void bitmap_onto(unsigned long *dst, const unsigned long *orig,
135                 const unsigned long *relmap, int bits);
136 extern void bitmap_fold(unsigned long *dst, const unsigned long *orig,
137                 int sz, int bits);
138 extern int bitmap_find_free_region(unsigned long *bitmap, int bits, int order);
139 extern void bitmap_release_region(unsigned long *bitmap, int pos, int order);
140 extern int bitmap_allocate_region(unsigned long *bitmap, int pos, int order);
141 extern void bitmap_copy_le(void *dst, const unsigned long *src, int nbits);
142 extern int bitmap_ord_to_pos(const unsigned long *bitmap, int n, int bits);
143
144 #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) % BITS_PER_LONG))
145 #define BITMAP_LAST_WORD_MASK(nbits)                                    \
146 (                                                                       \
147         ((nbits) % BITS_PER_LONG) ?                                     \
148                 (1UL<<((nbits) % BITS_PER_LONG))-1 : ~0UL               \
149 )
150
151 #define small_const_nbits(nbits) \
152         (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG)
153
154 static inline void bitmap_zero(unsigned long *dst, int nbits)
155 {
156         if (small_const_nbits(nbits))
157                 *dst = 0UL;
158         else {
159                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
160                 memset(dst, 0, len);
161         }
162 }
163
164 static inline void bitmap_fill(unsigned long *dst, int nbits)
165 {
166         size_t nlongs = BITS_TO_LONGS(nbits);
167         if (!small_const_nbits(nbits)) {
168                 int len = (nlongs - 1) * sizeof(unsigned long);
169                 memset(dst, 0xff,  len);
170         }
171         dst[nlongs - 1] = BITMAP_LAST_WORD_MASK(nbits);
172 }
173
174 static inline void bitmap_copy(unsigned long *dst, const unsigned long *src,
175                         int nbits)
176 {
177         if (small_const_nbits(nbits))
178                 *dst = *src;
179         else {
180                 int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
181                 memcpy(dst, src, len);
182         }
183 }
184
185 static inline int bitmap_and(unsigned long *dst, const unsigned long *src1,
186                         const unsigned long *src2, int nbits)
187 {
188         if (small_const_nbits(nbits))
189                 return (*dst = *src1 & *src2) != 0;
190         return __bitmap_and(dst, src1, src2, nbits);
191 }
192
193 static inline void bitmap_or(unsigned long *dst, const unsigned long *src1,
194                         const unsigned long *src2, int nbits)
195 {
196         if (small_const_nbits(nbits))
197                 *dst = *src1 | *src2;
198         else
199                 __bitmap_or(dst, src1, src2, nbits);
200 }
201
202 static inline void bitmap_xor(unsigned long *dst, const unsigned long *src1,
203                         const unsigned long *src2, int nbits)
204 {
205         if (small_const_nbits(nbits))
206                 *dst = *src1 ^ *src2;
207         else
208                 __bitmap_xor(dst, src1, src2, nbits);
209 }
210
211 static inline int bitmap_andnot(unsigned long *dst, const unsigned long *src1,
212                         const unsigned long *src2, int nbits)
213 {
214         if (small_const_nbits(nbits))
215                 return (*dst = *src1 & ~(*src2)) != 0;
216         return __bitmap_andnot(dst, src1, src2, nbits);
217 }
218
219 static inline void bitmap_complement(unsigned long *dst, const unsigned long *src,
220                         int nbits)
221 {
222         if (small_const_nbits(nbits))
223                 *dst = ~(*src) & BITMAP_LAST_WORD_MASK(nbits);
224         else
225                 __bitmap_complement(dst, src, nbits);
226 }
227
228 static inline int bitmap_equal(const unsigned long *src1,
229                         const unsigned long *src2, int nbits)
230 {
231         if (small_const_nbits(nbits))
232                 return ! ((*src1 ^ *src2) & BITMAP_LAST_WORD_MASK(nbits));
233         else
234                 return __bitmap_equal(src1, src2, nbits);
235 }
236
237 static inline int bitmap_intersects(const unsigned long *src1,
238                         const unsigned long *src2, int nbits)
239 {
240         if (small_const_nbits(nbits))
241                 return ((*src1 & *src2) & BITMAP_LAST_WORD_MASK(nbits)) != 0;
242         else
243                 return __bitmap_intersects(src1, src2, nbits);
244 }
245
246 static inline int bitmap_subset(const unsigned long *src1,
247                         const unsigned long *src2, int nbits)
248 {
249         if (small_const_nbits(nbits))
250                 return ! ((*src1 & ~(*src2)) & BITMAP_LAST_WORD_MASK(nbits));
251         else
252                 return __bitmap_subset(src1, src2, nbits);
253 }
254
255 static inline int bitmap_empty(const unsigned long *src, int nbits)
256 {
257         if (small_const_nbits(nbits))
258                 return ! (*src & BITMAP_LAST_WORD_MASK(nbits));
259         else
260                 return __bitmap_empty(src, nbits);
261 }
262
263 static inline int bitmap_full(const unsigned long *src, int nbits)
264 {
265         if (small_const_nbits(nbits))
266                 return ! (~(*src) & BITMAP_LAST_WORD_MASK(nbits));
267         else
268                 return __bitmap_full(src, nbits);
269 }
270
271 static inline int bitmap_weight(const unsigned long *src, int nbits)
272 {
273         if (small_const_nbits(nbits))
274                 return hweight_long(*src & BITMAP_LAST_WORD_MASK(nbits));
275         return __bitmap_weight(src, nbits);
276 }
277
278 static inline void bitmap_shift_right(unsigned long *dst,
279                         const unsigned long *src, int n, int nbits)
280 {
281         if (small_const_nbits(nbits))
282                 *dst = *src >> n;
283         else
284                 __bitmap_shift_right(dst, src, n, nbits);
285 }
286
287 static inline void bitmap_shift_left(unsigned long *dst,
288                         const unsigned long *src, int n, int nbits)
289 {
290         if (small_const_nbits(nbits))
291                 *dst = (*src << n) & BITMAP_LAST_WORD_MASK(nbits);
292         else
293                 __bitmap_shift_left(dst, src, n, nbits);
294 }
295
296 static inline int bitmap_parse(const char *buf, unsigned int buflen,
297                         unsigned long *maskp, int nmaskbits)
298 {
299         return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
300 }
301
302 static inline size_t bitmap_size(int nbits)
303 {
304         return BITS_TO_LONGS(nbits) * sizeof(unsigned long);
305 }