lib/axmap.c

   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>
  22
  23 #include "../arch/arch.h"
  24 #include "axmap.h"
  25 #include "../minmax.h"
  26
  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
  34
  35 #define BLOCKS_PER_UNIT         (1U << UNIT_SHIFT)
  36 #define BLOCKS_PER_UNIT_MASK    (BLOCKS_PER_UNIT - 1)
  37
  38 #define firstfree_valid(b)      ((b)->first_free != (uint64_t) -1)
  39
  40 static const unsigned long bit_masks[] = {
  41         0x0000000000000000, 0x0000000000000001, 0x0000000000000003, 0x0000000000000007,
  42         0x000000000000000f, 0x000000000000001f, 0x000000000000003f, 0x000000000000007f,
  43         0x00000000000000ff, 0x00000000000001ff, 0x00000000000003ff, 0x00000000000007ff,
  44         0x0000000000000fff, 0x0000000000001fff, 0x0000000000003fff, 0x0000000000007fff,
  45         0x000000000000ffff, 0x000000000001ffff, 0x000000000003ffff, 0x000000000007ffff,
  46         0x00000000000fffff, 0x00000000001fffff, 0x00000000003fffff, 0x00000000007fffff,
  47         0x0000000000ffffff, 0x0000000001ffffff, 0x0000000003ffffff, 0x0000000007ffffff,
  48         0x000000000fffffff, 0x000000001fffffff, 0x000000003fffffff, 0x000000007fffffff,
  49         0x00000000ffffffff,
  50 #if BITS_PER_LONG == 64
  51         0x00000001ffffffff, 0x00000003ffffffff, 0x00000007ffffffff, 0x0000000fffffffff,
  52         0x0000001fffffffff, 0x0000003fffffffff, 0x0000007fffffffff, 0x000000ffffffffff,
  53         0x000001ffffffffff, 0x000003ffffffffff, 0x000007ffffffffff, 0x00000fffffffffff,
  54         0x00001fffffffffff, 0x00003fffffffffff, 0x00007fffffffffff, 0x0000ffffffffffff,
  55         0x0001ffffffffffff, 0x0003ffffffffffff, 0x0007ffffffffffff, 0x000fffffffffffff,
  56         0x001fffffffffffff, 0x003fffffffffffff, 0x007fffffffffffff, 0x00ffffffffffffff,
  57         0x01ffffffffffffff, 0x03ffffffffffffff, 0x07ffffffffffffff, 0x0fffffffffffffff,
  58         0x1fffffffffffffff, 0x3fffffffffffffff, 0x7fffffffffffffff, 0xffffffffffffffff
  59 #endif
  60 };
  61
  62 struct axmap_level {
  63         int level;
  64         unsigned long map_size;
  65         unsigned long *map;
  66 };
  67
  68 struct axmap {
  69         unsigned int nr_levels;
  70         struct axmap_level *levels;
  71         uint64_t first_free;
  72         uint64_t nr_bits;
  73 };
  74
  75 static inline unsigned long ulog64(unsigned long val, unsigned int log)
  76 {
  77         while (log-- && val)
  78                 val >>= UNIT_SHIFT;
  79
  80         return val;
  81 }
  82
  83 void axmap_reset(struct axmap *axmap)
  84 {
  85         int i;
  86
  87         for (i = 0; i < axmap->nr_levels; i++) {
  88                 struct axmap_level *al = &axmap->levels[i];
  89
  90                 memset(al->map, 0, al->map_size * sizeof(unsigned long));
  91         }
  92
  93         axmap->first_free = 0;
  94 }
  95
  96 void axmap_free(struct axmap *axmap)
  97 {
  98         unsigned int i;
  99
 100         if (!axmap)
 101                 return;
 102
 103         for (i = 0; i < axmap->nr_levels; i++)
 104                 free(axmap->levels[i].map);
 105
 106         free(axmap->levels);
 107         free(axmap);
 108 }
 109
 110 struct axmap *axmap_new(unsigned long nr_bits)
 111 {
 112         struct axmap *axmap;
 113         unsigned int i, levels;
 114
 115         axmap = malloc(sizeof(*axmap));
 116         if (!axmap)
 117                 return NULL;
 118
 119         levels = 1;
 120         i = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 121         while (i > 1) {
 122                 i = (i + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 123                 levels++;
 124         }
 125
 126         axmap->nr_levels = levels;
 127         axmap->levels = calloc(axmap->nr_levels, sizeof(struct axmap_level));
 128         axmap->nr_bits = nr_bits;
 129
 130         for (i = 0; i < axmap->nr_levels; i++) {
 131                 struct axmap_level *al = &axmap->levels[i];
 132
 133                 al->level = i;
 134                 al->map_size = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 135                 al->map = malloc(al->map_size * sizeof(unsigned long));
 136                 if (!al->map)
 137                         goto err;
 138
 139                 nr_bits = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 140         }
 141
 142         axmap_reset(axmap);
 143         return axmap;
 144 err:
 145         for (i = 0; i < axmap->nr_levels; i++)
 146                 if (axmap->levels[i].map)
 147                         free(axmap->levels[i].map);
 148
 149         free(axmap->levels);
 150         free(axmap);
 151         return NULL;
 152 }
 153
 154 static bool axmap_handler(struct axmap *axmap, uint64_t bit_nr,
 155                           bool (*func)(struct axmap_level *, unsigned long, unsigned int,
 156                           void *), void *data)
 157 {
 158         struct axmap_level *al;
 159         uint64_t index = bit_nr;
 160         int i;
 161
 162         for (i = 0; i < axmap->nr_levels; i++) {
 163                 unsigned long offset = index >> UNIT_SHIFT;
 164                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 165
 166                 al = &axmap->levels[i];
 167
 168                 if (func(al, offset, bit, data))
 169                         return true;
 170
 171                 if (index)
 172                         index >>= UNIT_SHIFT;
 173         }
 174
 175         return false;
 176 }
 177
 178 static bool axmap_handler_topdown(struct axmap *axmap, uint64_t bit_nr,
 179         bool (*func)(struct axmap_level *, unsigned long, unsigned int, void *))
 180 {
 181         int i;
 182
 183         for (i = axmap->nr_levels - 1; i >= 0; i--) {
 184                 unsigned long index = ulog64(bit_nr, i);
 185                 unsigned long offset = index >> UNIT_SHIFT;
 186                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 187
 188                 if (func(&axmap->levels[i], offset, bit, NULL))
 189                         return true;
 190         }
 191
 192         return false;
 193 }
 194
 195 static bool axmap_clear_fn(struct axmap_level *al, unsigned long offset,
 196                            unsigned int bit, void *unused)
 197 {
 198         if (!(al->map[offset] & (1UL << bit)))
 199                 return true;
 200
 201         al->map[offset] &= ~(1UL << bit);
 202         return false;
 203 }
 204
 205 void axmap_clear(struct axmap *axmap, uint64_t bit_nr)
 206 {
 207         axmap_handler(axmap, bit_nr, axmap_clear_fn, NULL);
 208
 209         if (bit_nr < axmap->first_free)
 210                 axmap->first_free = bit_nr;
 211 }
 212
 213 struct axmap_set_data {
 214         unsigned int nr_bits;
 215         unsigned int set_bits;
 216 };
 217
 218 static bool axmap_set_fn(struct axmap_level *al, unsigned long offset,
 219                          unsigned int bit, void *__data)
 220 {
 221         struct axmap_set_data *data = __data;
 222         unsigned long mask, overlap;
 223         unsigned int nr_bits;
 224
 225         nr_bits = min(data->nr_bits, BLOCKS_PER_UNIT - bit);
 226
 227         mask = bit_masks[nr_bits] << bit;
 228
 229         /*
 230          * Mask off any potential overlap, only sets contig regions
 231          */
 232         overlap = al->map[offset] & mask;
 233         if (overlap == mask) {
 234 done:
 235                 data->set_bits = 0;
 236                 return true;
 237         }
 238
 239         if (overlap) {
 240                 const int __bit = ffz(~overlap);
 241
 242                 nr_bits = __bit - bit;
 243                 if (!nr_bits)
 244                         goto done;
 245
 246                 mask = bit_masks[nr_bits] << bit;
 247         }
 248
 249         assert(mask);
 250         assert(!(al->map[offset] & mask));
 251         al->map[offset] |= mask;
 252
 253         if (!al->level)
 254                 data->set_bits = nr_bits;
 255
 256         data->nr_bits = 1;
 257         return al->map[offset] != -1UL;
 258 }
 259
 260 static void __axmap_set(struct axmap *axmap, uint64_t bit_nr,
 261                          struct axmap_set_data *data)
 262 {
 263         unsigned int set_bits, nr_bits = data->nr_bits;
 264
 265         if (axmap->first_free >= bit_nr &&
 266             axmap->first_free < bit_nr + data->nr_bits)
 267                 axmap->first_free = -1ULL;
 268
 269         if (bit_nr > axmap->nr_bits)
 270                 return;
 271         else if (bit_nr + nr_bits > axmap->nr_bits)
 272                 nr_bits = axmap->nr_bits - bit_nr;
 273
 274         set_bits = 0;
 275         while (nr_bits) {
 276                 axmap_handler(axmap, bit_nr, axmap_set_fn, data);
 277                 set_bits += data->set_bits;
 278
 279                 if (!data->set_bits ||
 280                     data->set_bits != (BLOCKS_PER_UNIT - nr_bits))
 281                         break;
 282
 283                 nr_bits -= data->set_bits;
 284                 bit_nr += data->set_bits;
 285
 286                 data->nr_bits = nr_bits;
 287         }
 288
 289         data->set_bits = set_bits;
 290 }
 291
 292 void axmap_set(struct axmap *axmap, uint64_t bit_nr)
 293 {
 294         struct axmap_set_data data = { .nr_bits = 1, };
 295
 296         __axmap_set(axmap, bit_nr, &data);
 297 }
 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;
 303
 304         do {
 305                 struct axmap_set_data data = { .nr_bits = nr_bits, };
 306                 unsigned int max_bits, this_set;
 307
 308                 max_bits = BLOCKS_PER_UNIT - (bit_nr & BLOCKS_PER_UNIT_MASK);
 309                 if (nr_bits > max_bits)
 310                         data.nr_bits = max_bits;
 311
 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;
 317
 318                 nr_bits -= data.set_bits;
 319                 bit_nr += data.set_bits;
 320         } while (nr_bits);
 321
 322         return set_bits;
 323 }
 324
 325 static bool axmap_isset_fn(struct axmap_level *al, unsigned long offset,
 326                            unsigned int bit, void *unused)
 327 {
 328         return (al->map[offset] & (1UL << bit)) != 0;
 329 }
 330
 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);
 335
 336         return false;
 337 }
 338
 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;
 350
 351         index = 0;
 352         for (i = axmap->nr_levels - 1; i >= 0; i--) {
 353                 al = &axmap->levels[i];
 354
 355                 /* Shift previously calculated index for next level */
 356                 index <<= UNIT_SHIFT;
 357
 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;
 365
 366                 /* Get the offset and bit for this level */
 367                 offset = index >> UNIT_SHIFT;
 368                 bit = index & BLOCKS_PER_UNIT_MASK;
 369
 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;
 378
 379                 /* Check the first word starting with the specific bit */
 380                 temp = ~bit_masks[bit] & ~al->map[offset];
 381                 if (temp)
 382                         goto found;
 383
 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                 }
 393
 394                 /* Did not find a free bit */
 395                 return -1ULL;
 396
 397 found:
 398                 /* Compute the index of the free bit just found */
 399                 index = (offset << UNIT_SHIFT) + ffz(~temp);
 400         }
 401
 402         /* If found an unused bit in the last word of level 0, return -1 */
 403         if (index >= axmap->nr_bits)
 404                 return -1ULL;
 405
 406         return index;
 407 }
 408
 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;
 420
 421         if (bit_nr >= axmap->nr_bits)
 422                 return -1ULL;
 423
 424         /* If at the end of the map, wrap-around */
 425         if (next_bit == axmap->nr_bits)
 426                 next_bit = 0;
 427
 428         offset = next_bit >> UNIT_SHIFT;
 429         bit = next_bit & BLOCKS_PER_UNIT_MASK;
 430
 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[0].map[offset];
 437         if (temp) {
 438                 ret = (offset << UNIT_SHIFT) + ffz(~temp);
 439
 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);
 445
 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 }