1 /*
2  * Bitmap of bitmaps, where each layer is number-of-bits-per-word smaller than
3  * the previous. Hence an 'axmap', since we axe each previous layer into a
4  * much smaller piece. I swear, that is why it's named like that. It has
5  * nothing to do with anything remotely narcissistic.
6  *
7  * A set bit at layer N indicates a full word at layer N-1, and so forth. As
8  * the bitmap becomes progressively more full, checking for existence
9  * becomes cheaper (since fewer layers are walked, making it a lot more
10  * cache friendly) and locating the next free space likewise.
11  *
12  * Axmaps get pretty close to optimal (1 bit per block) space usage, since
13  * layers quickly diminish in size. Doing the size math is straight forward,
14  * since we have log64(blocks) layers of maps. For 20000 blocks, overhead
15  * is roughly 1.9%, or 1.019 bits per block. The number quickly converges
16  * towards 1.0158, or 1.58% of overhead.
17  */
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <string.h>
21 #include <assert.h>
23 #include "../arch/arch.h"
24 #include "axmap.h"
25 #include "../minmax.h"
27 #if BITS_PER_LONG == 64
28 #define UNIT_SHIFT              6
29 #elif BITS_PER_LONG == 32
30 #define UNIT_SHIFT              5
31 #else
32 #error "Number of arch bits unknown"
33 #endif
35 #define BLOCKS_PER_UNIT         (1U << UNIT_SHIFT)
36 #define BLOCKS_PER_UNIT_MASK    (BLOCKS_PER_UNIT - 1)
38 static const unsigned long bit_masks[] = {
39         0x0000000000000000, 0x0000000000000001, 0x0000000000000003, 0x0000000000000007,
40         0x000000000000000f, 0x000000000000001f, 0x000000000000003f, 0x000000000000007f,
41         0x00000000000000ff, 0x00000000000001ff, 0x00000000000003ff, 0x00000000000007ff,
42         0x0000000000000fff, 0x0000000000001fff, 0x0000000000003fff, 0x0000000000007fff,
43         0x000000000000ffff, 0x000000000001ffff, 0x000000000003ffff, 0x000000000007ffff,
44         0x00000000000fffff, 0x00000000001fffff, 0x00000000003fffff, 0x00000000007fffff,
45         0x0000000000ffffff, 0x0000000001ffffff, 0x0000000003ffffff, 0x0000000007ffffff,
46         0x000000000fffffff, 0x000000001fffffff, 0x000000003fffffff, 0x000000007fffffff,
47         0x00000000ffffffff,
48 #if BITS_PER_LONG == 64
49         0x00000001ffffffff, 0x00000003ffffffff, 0x00000007ffffffff, 0x0000000fffffffff,
50         0x0000001fffffffff, 0x0000003fffffffff, 0x0000007fffffffff, 0x000000ffffffffff,
51         0x000001ffffffffff, 0x000003ffffffffff, 0x000007ffffffffff, 0x00000fffffffffff,
52         0x00001fffffffffff, 0x00003fffffffffff, 0x00007fffffffffff, 0x0000ffffffffffff,
53         0x0001ffffffffffff, 0x0003ffffffffffff, 0x0007ffffffffffff, 0x000fffffffffffff,
54         0x001fffffffffffff, 0x003fffffffffffff, 0x007fffffffffffff, 0x00ffffffffffffff,
55         0x01ffffffffffffff, 0x03ffffffffffffff, 0x07ffffffffffffff, 0x0fffffffffffffff,
56         0x1fffffffffffffff, 0x3fffffffffffffff, 0x7fffffffffffffff, 0xffffffffffffffff
57 #endif
58 };
60 /**
61  * struct axmap_level - a bitmap used to implement struct axmap
62  * @level: Level index. Each map has at least one level with index zero. The
63  *      higher the level index, the fewer bits a struct axmap_level contains.
64  * @map_size: Number of elements of the @map array.
65  * @map: A bitmap with @map_size elements.
66  */
67 struct axmap_level {
68         int level;
69         unsigned long map_size;
70         unsigned long *map;
71 };
73 /**
74  * struct axmap - a set that can store numbers 0 .. @nr_bits - 1
75  * @nr_level: Number of elements of the @levels array.
76  * @levels: struct axmap_level array in which lower levels contain more bits
77  *      than higher levels.
78  * @nr_bits: One more than the highest value stored in the set.
79  */
80 struct axmap {
81         unsigned int nr_levels;
82         struct axmap_level *levels;
83         uint64_t nr_bits;
84 };
86 /* Remove all elements from the @axmap set */
87 void axmap_reset(struct axmap *axmap)
88 {
89         int i;
91         for (i = 0; i < axmap->nr_levels; i++) {
92                 struct axmap_level *al = &axmap->levels[i];
94                 memset(al->map, 0, al->map_size * sizeof(unsigned long));
95         }
96 }
98 void axmap_free(struct axmap *axmap)
99 {
100         unsigned int i;
102         if (!axmap)
103                 return;
105         for (i = 0; i < axmap->nr_levels; i++)
106                 free(axmap->levels[i].map);
108         free(axmap->levels);
109         free(axmap);
110 }
112 /* Allocate memory for a set that can store the numbers 0 .. @nr_bits - 1. */
113 struct axmap *axmap_new(uint64_t nr_bits)
114 {
115         struct axmap *axmap;
116         unsigned int i, levels;
118         axmap = malloc(sizeof(*axmap));
119         if (!axmap)
120                 return NULL;
122         levels = 1;
123         i = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
124         while (i > 1) {
125                 i = (i + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
126                 levels++;
127         }
129         axmap->nr_levels = levels;
130         axmap->levels = calloc(axmap->nr_levels, sizeof(struct axmap_level));
131         if (!axmap->levels)
132                 goto free_axmap;
133         axmap->nr_bits = nr_bits;
135         for (i = 0; i < axmap->nr_levels; i++) {
136                 struct axmap_level *al = &axmap->levels[i];
138                 nr_bits = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
140                 al->level = i;
141                 al->map_size = nr_bits;
142                 al->map = malloc(al->map_size * sizeof(unsigned long));
143                 if (!al->map)
144                         goto free_levels;
146         }
148         axmap_reset(axmap);
149         return axmap;
151 free_levels:
152         for (i = 0; i < axmap->nr_levels; i++)
153                 free(axmap->levels[i].map);
155         free(axmap->levels);
157 free_axmap:
158         free(axmap);
159         return NULL;
160 }
162 /*
163  * Call @func for each level, starting at level zero, until a level is found
164  * for which @func returns true. Return false if none of the @func calls
165  * returns true.
166  */
167 static bool axmap_handler(struct axmap *axmap, uint64_t bit_nr,
168                           bool (*func)(struct axmap_level *, uint64_t, unsigned int,
169                           void *), void *data)
170 {
171         struct axmap_level *al;
172         uint64_t index = bit_nr;
173         int i;
175         for (i = 0; i < axmap->nr_levels; i++) {
176                 unsigned long offset = index >> UNIT_SHIFT;
177                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
179                 al = &axmap->levels[i];
181                 if (func(al, offset, bit, data))
182                         return true;
184                 if (index)
185                         index >>= UNIT_SHIFT;
186         }
188         return false;
189 }
191 /*
192  * Call @func for each level, starting at the highest level, until a level is
193  * found for which @func returns true. Return false if none of the @func calls
194  * returns true.
195  */
196 static bool axmap_handler_topdown(struct axmap *axmap, uint64_t bit_nr,
197         bool (*func)(struct axmap_level *, uint64_t, unsigned int, void *))
198 {
199         int i;
201         for (i = axmap->nr_levels - 1; i >= 0; i--) {
202                 uint64_t index = bit_nr >> (UNIT_SHIFT * i);
203                 unsigned long offset = index >> UNIT_SHIFT;
204                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
206                 if (func(&axmap->levels[i], offset, bit, NULL))
207                         return true;
208         }
210         return false;
211 }
213 struct axmap_set_data {
214         unsigned int nr_bits;
215         unsigned int set_bits;
216 };
218 /*
219  * Set at most @__data->nr_bits bits in @al at offset @offset. Do not exceed
220  * the boundary of the element at offset @offset. Return the number of bits
221  * that have been set in @__data->set_bits if @al->level == 0.
222  */
223 static bool axmap_set_fn(struct axmap_level *al, uint64_t offset,
224                          unsigned int bit, void *__data)
225 {
226         struct axmap_set_data *data = __data;
228         unsigned int nr_bits;
230         nr_bits = min(data->nr_bits, BLOCKS_PER_UNIT - bit);
234         /*
235          * Mask off any potential overlap, only sets contig regions
236          */
237         overlap = al->map[offset] & mask;
238         if (overlap == mask) {
239                 data->set_bits = 0;
240                 return true;
241         }
243         if (overlap) {
244                 nr_bits = ffz(~overlap) - bit;
245                 if (!nr_bits)
246                         return true;
248         }
254         if (!al->level)
255                 data->set_bits = nr_bits;
257         /* For the next level */
258         data->nr_bits = 1;
260         return al->map[offset] != -1UL;
261 }
263 /*
264  * Set up to @data->nr_bits starting from @bit_nr in @axmap. Start at
265  * @bit_nr. If that bit has not yet been set then set it and continue until
266  * either @data->nr_bits have been set or a 1 bit is found. Store the number
267  * of bits that have been set in @data->set_bits. It is guaranteed that all
268  * bits that have been requested to set fit in the same unsigned long word of
269  * level 0 of @axmap.
270  */
271 static void __axmap_set(struct axmap *axmap, uint64_t bit_nr,
272                          struct axmap_set_data *data)
273 {
274         unsigned int nr_bits = data->nr_bits;
276         if (bit_nr > axmap->nr_bits)
277                 return;
278         else if (bit_nr + nr_bits > axmap->nr_bits)
279                 nr_bits = axmap->nr_bits - bit_nr;
281         assert(nr_bits <= BLOCKS_PER_UNIT);
283         axmap_handler(axmap, bit_nr, axmap_set_fn, data);
284 }
286 void axmap_set(struct axmap *axmap, uint64_t bit_nr)
287 {
288         struct axmap_set_data data = { .nr_bits = 1, };
290         __axmap_set(axmap, bit_nr, &data);
291 }
293 /*
294  * Set up to @nr_bits starting from @bit in @axmap. Start at @bit. If that
295  * bit has not yet been set then set it and continue until either @nr_bits
296  * have been set or a 1 bit is found. Return the number of bits that have been
297  * set.
298  */
299 unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr,
300                           unsigned int nr_bits)
301 {
302         unsigned int set_bits = 0;
304         do {
305                 struct axmap_set_data data = { .nr_bits = nr_bits, };
306                 unsigned int max_bits, this_set;
308                 max_bits = BLOCKS_PER_UNIT - (bit_nr & BLOCKS_PER_UNIT_MASK);
309                 if (nr_bits > max_bits)
310                         data.nr_bits = max_bits;
312                 this_set = data.nr_bits;
313                 __axmap_set(axmap, bit_nr, &data);
314                 set_bits += data.set_bits;
315                 if (data.set_bits != this_set)
316                         break;
318                 nr_bits -= data.set_bits;
319                 bit_nr += data.set_bits;
320         } while (nr_bits);
322         return set_bits;
323 }
325 static bool axmap_isset_fn(struct axmap_level *al, uint64_t offset,
326                            unsigned int bit, void *unused)
327 {
328         return (al->map[offset] & (1ULL << bit)) != 0;
329 }
331 bool axmap_isset(struct axmap *axmap, uint64_t bit_nr)
332 {
333         if (bit_nr <= axmap->nr_bits)
334                 return axmap_handler_topdown(axmap, bit_nr, axmap_isset_fn);
336         return false;
337 }
339 /*
340  * Find the first free bit that is at least as large as bit_nr.  Return
341  * -1 if no free bit is found before the end of the map.
342  */
343 static uint64_t axmap_find_first_free(struct axmap *axmap, uint64_t bit_nr)
344 {
345         int i;
346         unsigned long temp;
347         unsigned int bit;
348         uint64_t offset, base_index, index;
349         struct axmap_level *al;
351         index = 0;
352         for (i = axmap->nr_levels - 1; i >= 0; i--) {
353                 al = &axmap->levels[i];
355                 /* Shift previously calculated index for next level */
356                 index <<= UNIT_SHIFT;
358                 /*
359                  * Start from an index that's at least as large as the
360                  * originally passed in bit number.
361                  */
362                 base_index = bit_nr >> (UNIT_SHIFT * i);
363                 if (index < base_index)
364                         index = base_index;
366                 /* Get the offset and bit for this level */
367                 offset = index >> UNIT_SHIFT;
368                 bit = index & BLOCKS_PER_UNIT_MASK;
370                 /*
371                  * If the previous level had unused bits in its last
372                  * word, the offset could be bigger than the map at
373                  * this level. That means no free bits exist before the
374                  * end of the map, so return -1.
375                  */
376                 if (offset >= al->map_size)
377                         return -1ULL;
379                 /* Check the first word starting with the specific bit */
380                 temp = ~bit_masks[bit] & ~al->map[offset];
381                 if (temp)
382                         goto found;
384                 /*
385                  * No free bit in the first word, so iterate
386                  * looking for a word with one or more free bits.
387                  */
388                 for (offset++; offset < al->map_size; offset++) {
389                         temp = ~al->map[offset];
390                         if (temp)
391                                 goto found;
392                 }
394                 /* Did not find a free bit */
395                 return -1ULL;
397 found:
398                 /* Compute the index of the free bit just found */
399                 index = (offset << UNIT_SHIFT) + ffz(~temp);
400         }
402         /* If found an unused bit in the last word of level 0, return -1 */
403         if (index >= axmap->nr_bits)
404                 return -1ULL;
406         return index;
407 }
409 /*
410  * 'bit_nr' is already set. Find the next free bit after this one.
411  * Return -1 if no free bits found.
412  */
413 uint64_t axmap_next_free(struct axmap *axmap, uint64_t bit_nr)
414 {
415         uint64_t ret;
416         uint64_t next_bit = bit_nr + 1;
417         unsigned long temp;
418         uint64_t offset;
419         unsigned int bit;
421         if (bit_nr >= axmap->nr_bits)
422                 return -1ULL;
424         /* If at the end of the map, wrap-around */
425         if (next_bit == axmap->nr_bits)
426                 next_bit = 0;
428         offset = next_bit >> UNIT_SHIFT;
429         bit = next_bit & BLOCKS_PER_UNIT_MASK;
431         /*
432          * As an optimization, do a quick check for a free bit
433          * in the current word at level 0. If not found, do
434          * a topdown search.
435          */
436         temp = ~bit_masks[bit] & ~axmap->levels.map[offset];
437         if (temp) {
438                 ret = (offset << UNIT_SHIFT) + ffz(~temp);
440                 /* Might have found an unused bit at level 0 */
441                 if (ret >= axmap->nr_bits)
442                         ret = -1ULL;
443         } else
444                 ret = axmap_find_first_free(axmap, next_bit);
446         /*
447          * If there are no free bits starting at next_bit and going
448          * to the end of the map, wrap around by searching again
449          * starting at bit 0.
450          */
451         if (ret == -1ULL && next_bit != 0)
452                 ret = axmap_find_first_free(axmap, 0);
453         return ret;
454 }