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 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 };
  59
  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 };
  72
  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 };
  85
  86 /* Remove all elements from the @axmap set */
  87 void axmap_reset(struct axmap *axmap)
  88 {
  89         int i;
  90
  91         for (i = 0; i < axmap->nr_levels; i++) {
  92                 struct axmap_level *al = &axmap->levels[i];
  93
  94                 memset(al->map, 0, al->map_size * sizeof(unsigned long));
  95         }
  96 }
  97
  98 void axmap_free(struct axmap *axmap)
  99 {
 100         unsigned int i;
 101
 102         if (!axmap)
 103                 return;
 104
 105         for (i = 0; i < axmap->nr_levels; i++)
 106                 free(axmap->levels[i].map);
 107
 108         free(axmap->levels);
 109         free(axmap);
 110 }
 111
 112 /* Allocate memory for a set that can store the numbers 0 .. @nr_bits - 1. */
 113 struct axmap *axmap_new(unsigned long nr_bits)
 114 {
 115         struct axmap *axmap;
 116         unsigned int i, levels;
 117
 118         axmap = malloc(sizeof(*axmap));
 119         if (!axmap)
 120                 return NULL;
 121
 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         }
 128
 129         axmap->nr_levels = levels;
 130         axmap->levels = calloc(axmap->nr_levels, sizeof(struct axmap_level));
 131         axmap->nr_bits = nr_bits;
 132
 133         for (i = 0; i < axmap->nr_levels; i++) {
 134                 struct axmap_level *al = &axmap->levels[i];
 135
 136                 al->level = i;
 137                 al->map_size = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 138                 al->map = malloc(al->map_size * sizeof(unsigned long));
 139                 if (!al->map)
 140                         goto err;
 141
 142                 nr_bits = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
 143         }
 144
 145         axmap_reset(axmap);
 146         return axmap;
 147 err:
 148         for (i = 0; i < axmap->nr_levels; i++)
 149                 if (axmap->levels[i].map)
 150                         free(axmap->levels[i].map);
 151
 152         free(axmap->levels);
 153         free(axmap);
 154         return NULL;
 155 }
 156
 157 /*
 158  * Call @func for each level, starting at level zero, until a level is found
 159  * for which @func returns true. Return false if none of the @func calls
 160  * returns true.
 161  */
 162 static bool axmap_handler(struct axmap *axmap, uint64_t bit_nr,
 163                           bool (*func)(struct axmap_level *, unsigned long, unsigned int,
 164                           void *), void *data)
 165 {
 166         struct axmap_level *al;
 167         uint64_t index = bit_nr;
 168         int i;
 169
 170         for (i = 0; i < axmap->nr_levels; i++) {
 171                 unsigned long offset = index >> UNIT_SHIFT;
 172                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 173
 174                 al = &axmap->levels[i];
 175
 176                 if (func(al, offset, bit, data))
 177                         return true;
 178
 179                 if (index)
 180                         index >>= UNIT_SHIFT;
 181         }
 182
 183         return false;
 184 }
 185
 186 /*
 187  * Call @func for each level, starting at the highest level, until a level is
 188  * found for which @func returns true. Return false if none of the @func calls
 189  * returns true.
 190  */
 191 static bool axmap_handler_topdown(struct axmap *axmap, uint64_t bit_nr,
 192         bool (*func)(struct axmap_level *, unsigned long, unsigned int, void *))
 193 {
 194         int i;
 195
 196         for (i = axmap->nr_levels - 1; i >= 0; i--) {
 197                 unsigned long index = bit_nr >> (UNIT_SHIFT * i);
 198                 unsigned long offset = index >> UNIT_SHIFT;
 199                 unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 200
 201                 if (func(&axmap->levels[i], offset, bit, NULL))
 202                         return true;
 203         }
 204
 205         return false;
 206 }
 207
 208 struct axmap_set_data {
 209         unsigned int nr_bits;
 210         unsigned int set_bits;
 211 };
 212
 213 /*
 214  * Set at most @__data->nr_bits bits in @al at offset @offset. Do not exceed
 215  * the boundary of the element at offset @offset. Return the number of bits
 216  * that have been set in @__data->set_bits if @al->level == 0.
 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         /* For the next level */
 257         data->nr_bits = 1;
 258
 259         return al->map[offset] != -1UL;
 260 }
 261
 262 /*
 263  * Set up to @data->nr_bits starting from @bit_nr in @axmap. Start at
 264  * @bit_nr. If that bit has not yet been set then set it and continue until
 265  * either @data->nr_bits have been set or a 1 bit is found. Store the number
 266  * of bits that have been set in @data->set_bits. It is guaranteed that all
 267  * bits that have been requested to set fit in the same unsigned long word of
 268  * level 0 of @axmap.
 269  */
 270 static void __axmap_set(struct axmap *axmap, uint64_t bit_nr,
 271                          struct axmap_set_data *data)
 272 {
 273         unsigned int set_bits, nr_bits = data->nr_bits;
 274
 275         if (bit_nr > axmap->nr_bits)
 276                 return;
 277         else if (bit_nr + nr_bits > axmap->nr_bits)
 278                 nr_bits = axmap->nr_bits - bit_nr;
 279
 280         set_bits = 0;
 281         while (nr_bits) {
 282                 axmap_handler(axmap, bit_nr, axmap_set_fn, data);
 283                 set_bits += data->set_bits;
 284
 285                 if (!data->set_bits ||
 286                     data->set_bits != (BLOCKS_PER_UNIT - nr_bits))
 287                         break;
 288
 289                 nr_bits -= data->set_bits;
 290                 bit_nr += data->set_bits;
 291
 292                 data->nr_bits = nr_bits;
 293         }
 294
 295         data->set_bits = set_bits;
 296 }
 297
 298 void axmap_set(struct axmap *axmap, uint64_t bit_nr)
 299 {
 300         struct axmap_set_data data = { .nr_bits = 1, };
 301
 302         __axmap_set(axmap, bit_nr, &data);
 303 }
 304
 305 /*
 306  * Set up to @nr_bits starting from @bit in @axmap. Start at @bit. If that
 307  * bit has not yet been set then set it and continue until either @nr_bits
 308  * have been set or a 1 bit is found. Return the number of bits that have been
 309  * set.
 310  */
 311 unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr,
 312                           unsigned int nr_bits)
 313 {
 314         unsigned int set_bits = 0;
 315
 316         do {
 317                 struct axmap_set_data data = { .nr_bits = nr_bits, };
 318                 unsigned int max_bits, this_set;
 319
 320                 max_bits = BLOCKS_PER_UNIT - (bit_nr & BLOCKS_PER_UNIT_MASK);
 321                 if (nr_bits > max_bits)
 322                         data.nr_bits = max_bits;
 323
 324                 this_set = data.nr_bits;
 325                 __axmap_set(axmap, bit_nr, &data);
 326                 set_bits += data.set_bits;
 327                 if (data.set_bits != this_set)
 328                         break;
 329
 330                 nr_bits -= data.set_bits;
 331                 bit_nr += data.set_bits;
 332         } while (nr_bits);
 333
 334         return set_bits;
 335 }
 336
 337 static bool axmap_isset_fn(struct axmap_level *al, unsigned long offset,
 338                            unsigned int bit, void *unused)
 339 {
 340         return (al->map[offset] & (1UL << bit)) != 0;
 341 }
 342
 343 bool axmap_isset(struct axmap *axmap, uint64_t bit_nr)
 344 {
 345         if (bit_nr <= axmap->nr_bits)
 346                 return axmap_handler_topdown(axmap, bit_nr, axmap_isset_fn);
 347
 348         return false;
 349 }
 350
 351 /*
 352  * Find the first free bit that is at least as large as bit_nr.  Return
 353  * -1 if no free bit is found before the end of the map.
 354  */
 355 static uint64_t axmap_find_first_free(struct axmap *axmap, uint64_t bit_nr)
 356 {
 357         int i;
 358         unsigned long temp;
 359         unsigned int bit;
 360         uint64_t offset, base_index, index;
 361         struct axmap_level *al;
 362
 363         index = 0;
 364         for (i = axmap->nr_levels - 1; i >= 0; i--) {
 365                 al = &axmap->levels[i];
 366
 367                 /* Shift previously calculated index for next level */
 368                 index <<= UNIT_SHIFT;
 369
 370                 /*
 371                  * Start from an index that's at least as large as the
 372                  * originally passed in bit number.
 373                  */
 374                 base_index = bit_nr >> (UNIT_SHIFT * i);
 375                 if (index < base_index)
 376                         index = base_index;
 377
 378                 /* Get the offset and bit for this level */
 379                 offset = index >> UNIT_SHIFT;
 380                 bit = index & BLOCKS_PER_UNIT_MASK;
 381
 382                 /*
 383                  * If the previous level had unused bits in its last
 384                  * word, the offset could be bigger than the map at
 385                  * this level. That means no free bits exist before the
 386                  * end of the map, so return -1.
 387                  */
 388                 if (offset >= al->map_size)
 389                         return -1ULL;
 390
 391                 /* Check the first word starting with the specific bit */
 392                 temp = ~bit_masks[bit] & ~al->map[offset];
 393                 if (temp)
 394                         goto found;
 395
 396                 /*
 397                  * No free bit in the first word, so iterate
 398                  * looking for a word with one or more free bits.
 399                  */
 400                 for (offset++; offset < al->map_size; offset++) {
 401                         temp = ~al->map[offset];
 402                         if (temp)
 403                                 goto found;
 404                 }
 405
 406                 /* Did not find a free bit */
 407                 return -1ULL;
 408
 409 found:
 410                 /* Compute the index of the free bit just found */
 411                 index = (offset << UNIT_SHIFT) + ffz(~temp);
 412         }
 413
 414         /* If found an unused bit in the last word of level 0, return -1 */
 415         if (index >= axmap->nr_bits)
 416                 return -1ULL;
 417
 418         return index;
 419 }
 420
 421 /*
 422  * 'bit_nr' is already set. Find the next free bit after this one.
 423  * Return -1 if no free bits found.
 424  */
 425 uint64_t axmap_next_free(struct axmap *axmap, uint64_t bit_nr)
 426 {
 427         uint64_t ret;
 428         uint64_t next_bit = bit_nr + 1;
 429         unsigned long temp;
 430         uint64_t offset;
 431         unsigned int bit;
 432
 433         if (bit_nr >= axmap->nr_bits)
 434                 return -1ULL;
 435
 436         /* If at the end of the map, wrap-around */
 437         if (next_bit == axmap->nr_bits)
 438                 next_bit = 0;
 439
 440         offset = next_bit >> UNIT_SHIFT;
 441         bit = next_bit & BLOCKS_PER_UNIT_MASK;
 442
 443         /*
 444          * As an optimization, do a quick check for a free bit
 445          * in the current word at level 0. If not found, do
 446          * a topdown search.
 447          */
 448         temp = ~bit_masks[bit] & ~axmap->levels[0].map[offset];
 449         if (temp) {
 450                 ret = (offset << UNIT_SHIFT) + ffz(~temp);
 451
 452                 /* Might have found an unused bit at level 0 */
 453                 if (ret >= axmap->nr_bits)
 454                         ret = -1ULL;
 455         } else
 456                 ret = axmap_find_first_free(axmap, next_bit);
 457
 458         /*
 459          * If there are no free bits starting at next_bit and going
 460          * to the end of the map, wrap around by searching again
 461          * starting at bit 0.
 462          */
 463         if (ret == -1ULL && next_bit != 0)
 464                 ret = axmap_find_first_free(axmap, 0);
 465         return ret;
 466 }