lib/axmap: Add more documentation
[fio.git] / lib / axmap.c
index e847a387bc6b8ab984ca4ca4162183ef37b6dd0f..4a907fec22d2f8a2723121d8236d7a56be6db01c 100644 (file)
@@ -22,8 +22,6 @@
 
 #include "../arch/arch.h"
 #include "axmap.h"
-#include "../smalloc.h"
-#include "../mutex.h"
 #include "../minmax.h"
 
 #if BITS_PER_LONG == 64
 #define BLOCKS_PER_UNIT                (1U << UNIT_SHIFT)
 #define BLOCKS_PER_UNIT_MASK   (BLOCKS_PER_UNIT - 1)
 
-#define firstfree_valid(b)     ((b)->first_free != (uint64_t) -1)
+static const unsigned long bit_masks[] = {
+       0x0000000000000000, 0x0000000000000001, 0x0000000000000003, 0x0000000000000007,
+       0x000000000000000f, 0x000000000000001f, 0x000000000000003f, 0x000000000000007f,
+       0x00000000000000ff, 0x00000000000001ff, 0x00000000000003ff, 0x00000000000007ff,
+       0x0000000000000fff, 0x0000000000001fff, 0x0000000000003fff, 0x0000000000007fff,
+       0x000000000000ffff, 0x000000000001ffff, 0x000000000003ffff, 0x000000000007ffff,
+       0x00000000000fffff, 0x00000000001fffff, 0x00000000003fffff, 0x00000000007fffff,
+       0x0000000000ffffff, 0x0000000001ffffff, 0x0000000003ffffff, 0x0000000007ffffff,
+       0x000000000fffffff, 0x000000001fffffff, 0x000000003fffffff, 0x000000007fffffff,
+       0x00000000ffffffff,
+#if BITS_PER_LONG == 64
+       0x00000001ffffffff, 0x00000003ffffffff, 0x00000007ffffffff, 0x0000000fffffffff,
+       0x0000001fffffffff, 0x0000003fffffffff, 0x0000007fffffffff, 0x000000ffffffffff,
+       0x000001ffffffffff, 0x000003ffffffffff, 0x000007ffffffffff, 0x00000fffffffffff,
+       0x00001fffffffffff, 0x00003fffffffffff, 0x00007fffffffffff, 0x0000ffffffffffff,
+       0x0001ffffffffffff, 0x0003ffffffffffff, 0x0007ffffffffffff, 0x000fffffffffffff,
+       0x001fffffffffffff, 0x003fffffffffffff, 0x007fffffffffffff, 0x00ffffffffffffff,
+       0x01ffffffffffffff, 0x03ffffffffffffff, 0x07ffffffffffffff, 0x0fffffffffffffff,
+       0x1fffffffffffffff, 0x3fffffffffffffff, 0x7fffffffffffffff, 0xffffffffffffffff
+#endif
+};
 
+/**
+ * struct axmap_level - a bitmap used to implement struct axmap
+ * @level: Level index. Each map has at least one level with index zero. The
+ *     higher the level index, the fewer bits a struct axmap_level contains.
+ * @map_size: Number of elements of the @map array.
+ * @map: A bitmap with @map_size elements.
+ */
 struct axmap_level {
        int level;
        unsigned long map_size;
        unsigned long *map;
 };
 
+/**
+ * struct axmap - a set that can store numbers 0 .. @nr_bits - 1
+ * @nr_level: Number of elements of the @levels array.
+ * @levels: struct axmap_level array in which lower levels contain more bits
+ *     than higher levels.
+ * @nr_bits: One more than the highest value stored in the set.
+ */
 struct axmap {
-       struct fio_mutex lock;
        unsigned int nr_levels;
        struct axmap_level *levels;
-       uint64_t first_free;
        uint64_t nr_bits;
 };
 
-static unsigned long ulog64(unsigned long val, unsigned int log)
+static inline unsigned long ulog64(unsigned long val, unsigned int log)
 {
        while (log-- && val)
                val >>= UNIT_SHIFT;
@@ -61,20 +91,16 @@ static unsigned long ulog64(unsigned long val, unsigned int log)
        return val;
 }
 
+/* Remove all elements from the @axmap set */
 void axmap_reset(struct axmap *axmap)
 {
        int i;
 
-       fio_mutex_down(&axmap->lock);
-
        for (i = 0; i < axmap->nr_levels; i++) {
                struct axmap_level *al = &axmap->levels[i];
 
                memset(al->map, 0, al->map_size * sizeof(unsigned long));
        }
-
-       axmap->first_free = 0;
-       fio_mutex_up(&axmap->lock);
 }
 
 void axmap_free(struct axmap *axmap)
@@ -85,24 +111,22 @@ void axmap_free(struct axmap *axmap)
                return;
 
        for (i = 0; i < axmap->nr_levels; i++)
-               sfree(axmap->levels[i].map);
+               free(axmap->levels[i].map);
 
-       sfree(axmap->levels);
-       __fio_mutex_remove(&axmap->lock);
-       sfree(axmap);
+       free(axmap->levels);
+       free(axmap);
 }
 
+/* Allocate memory for a set that can store the numbers 0 .. @nr_bits - 1. */
 struct axmap *axmap_new(unsigned long nr_bits)
 {
        struct axmap *axmap;
        unsigned int i, levels;
 
-       axmap = smalloc(sizeof(*axmap));
+       axmap = malloc(sizeof(*axmap));
        if (!axmap)
                return NULL;
 
-       __fio_mutex_init(&axmap->lock, FIO_MUTEX_UNLOCKED);
-
        levels = 1;
        i = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
        while (i > 1) {
@@ -111,7 +135,7 @@ struct axmap *axmap_new(unsigned long nr_bits)
        }
 
        axmap->nr_levels = levels;
-       axmap->levels = smalloc(axmap->nr_levels * sizeof(struct axmap_level));
+       axmap->levels = calloc(axmap->nr_levels, sizeof(struct axmap_level));
        axmap->nr_bits = nr_bits;
 
        for (i = 0; i < axmap->nr_levels; i++) {
@@ -119,7 +143,7 @@ struct axmap *axmap_new(unsigned long nr_bits)
 
                al->level = i;
                al->map_size = (nr_bits + BLOCKS_PER_UNIT - 1) >> UNIT_SHIFT;
-               al->map = smalloc(al->map_size * sizeof(unsigned long));
+               al->map = malloc(al->map_size * sizeof(unsigned long));
                if (!al->map)
                        goto err;
 
@@ -131,69 +155,62 @@ struct axmap *axmap_new(unsigned long nr_bits)
 err:
        for (i = 0; i < axmap->nr_levels; i++)
                if (axmap->levels[i].map)
-                       sfree(axmap->levels[i].map);
+                       free(axmap->levels[i].map);
 
-       sfree(axmap->levels);
-       __fio_mutex_remove(&axmap->lock);
-       sfree(axmap);
+       free(axmap->levels);
+       free(axmap);
        return NULL;
 }
 
-static int axmap_handler(struct axmap *axmap, uint64_t bit_nr,
-                         int (*func)(struct axmap_level *, unsigned long, unsigned int,
+/*
+ * Call @func for each level, starting at level zero, until a level is found
+ * for which @func returns true. Return false if none of the @func calls
+ * returns true.
+ */
+static bool axmap_handler(struct axmap *axmap, uint64_t bit_nr,
+                         bool (*func)(struct axmap_level *, unsigned long, unsigned int,
                          void *), void *data)
 {
        struct axmap_level *al;
+       uint64_t index = bit_nr;
        int i;
 
        for (i = 0; i < axmap->nr_levels; i++) {
-               unsigned long index = ulog64(bit_nr, i);
                unsigned long offset = index >> UNIT_SHIFT;
                unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 
                al = &axmap->levels[i];
 
                if (func(al, offset, bit, data))
-                       return 1;
+                       return true;
+
+               if (index)
+                       index >>= UNIT_SHIFT;
        }
 
-       return 0;
+       return false;
 }
 
-static int axmap_handler_topdown(struct axmap *axmap, uint64_t bit_nr,
-       int (*func)(struct axmap_level *, unsigned long, unsigned int, void *),
-       void *data)
+/*
+ * Call @func for each level, starting at the highest level, until a level is
+ * found for which @func returns true. Return false if none of the @func calls
+ * returns true.
+ */
+static bool axmap_handler_topdown(struct axmap *axmap, uint64_t bit_nr,
+       bool (*func)(struct axmap_level *, unsigned long, unsigned int, void *))
 {
-       struct axmap_level *al;
-       int i, level = axmap->nr_levels;
+       int i;
 
        for (i = axmap->nr_levels - 1; i >= 0; i--) {
-               unsigned long index = ulog64(bit_nr, --level);
+               unsigned long index = ulog64(bit_nr, i);
                unsigned long offset = index >> UNIT_SHIFT;
                unsigned int bit = index & BLOCKS_PER_UNIT_MASK;
 
-               al = &axmap->levels[i];
-
-               if (func(al, offset, bit, data))
-                       return 1;
+               if (func(&axmap->levels[i], offset, bit, NULL))
+                       return true;
        }
 
-       return 0;
-}
-
-static int axmap_clear_fn(struct axmap_level *al, unsigned long offset,
-                          unsigned int bit, void *unused)
-{
-       if (!(al->map[offset] & (1UL << bit)))
-               return 1;
-
-       al->map[offset] &= ~(1UL << bit);
-       return 0;
-}
-
-void axmap_clear(struct axmap *axmap, uint64_t bit_nr)
-{
-       axmap_handler(axmap, bit_nr, axmap_clear_fn, NULL);
+       return false;
 }
 
 struct axmap_set_data {
@@ -201,29 +218,12 @@ struct axmap_set_data {
        unsigned int set_bits;
 };
 
-static unsigned long bit_masks[] = {
-       0x0000000000000000, 0x0000000000000001, 0x0000000000000003, 0x0000000000000007,
-       0x000000000000000f, 0x000000000000001f, 0x000000000000003f, 0x000000000000007f,
-       0x00000000000000ff, 0x00000000000001ff, 0x00000000000003ff, 0x00000000000007ff,
-       0x0000000000000fff, 0x0000000000001fff, 0x0000000000003fff, 0x0000000000007fff,
-       0x000000000000ffff, 0x000000000001ffff, 0x000000000003ffff, 0x000000000007ffff,
-       0x00000000000fffff, 0x00000000001fffff, 0x00000000003fffff, 0x00000000007fffff,
-       0x0000000000ffffff, 0x0000000001ffffff, 0x0000000003ffffff, 0x0000000007ffffff,
-       0x000000000fffffff, 0x000000001fffffff, 0x000000003fffffff, 0x000000007fffffff,
-       0x00000000ffffffff,
-#if BITS_PER_LONG == 64
-       0x00000001ffffffff, 0x00000003ffffffff, 0x00000007ffffffff, 0x0000000fffffffff,
-       0x0000001fffffffff, 0x0000003fffffffff, 0x0000007fffffffff, 0x000000ffffffffff,
-       0x000001ffffffffff, 0x000003ffffffffff, 0x000007ffffffffff, 0x00000fffffffffff,
-       0x00001fffffffffff, 0x00003fffffffffff, 0x00007fffffffffff, 0x0000ffffffffffff,
-       0x0001ffffffffffff, 0x0003ffffffffffff, 0x0007ffffffffffff, 0x000fffffffffffff,
-       0x001fffffffffffff, 0x003fffffffffffff, 0x007fffffffffffff, 0x00ffffffffffffff,
-       0x01ffffffffffffff, 0x03ffffffffffffff, 0x07ffffffffffffff, 0x0fffffffffffffff,
-       0x1fffffffffffffff, 0x3fffffffffffffff, 0x7fffffffffffffff, 0xffffffffffffffff
-#endif
-};
-
-static int axmap_set_fn(struct axmap_level *al, unsigned long offset,
+/*
+ * Set at most @__data->nr_bits bits in @al at offset @offset. Do not exceed
+ * the boundary of the element at offset @offset. Return the number of bits
+ * that have been set in @__data->set_bits if @al->level == 0.
+ */
+static bool axmap_set_fn(struct axmap_level *al, unsigned long offset,
                         unsigned int bit, void *__data)
 {
        struct axmap_set_data *data = __data;
@@ -238,38 +238,48 @@ static int axmap_set_fn(struct axmap_level *al, unsigned long offset,
         * Mask off any potential overlap, only sets contig regions
         */
        overlap = al->map[offset] & mask;
-       if (overlap == mask)
-               return 1;
+       if (overlap == mask) {
+done:
+               data->set_bits = 0;
+               return true;
+       }
 
-       while (overlap) {
-               unsigned long clear_mask = ~(1UL << ffz(~overlap));
+       if (overlap) {
+               const int __bit = ffz(~overlap);
 
-               mask &= clear_mask;
-               overlap &= clear_mask;
-               nr_bits--;
+               nr_bits = __bit - bit;
+               if (!nr_bits)
+                       goto done;
+
+               mask = bit_masks[nr_bits] << bit;
        }
 
        assert(mask);
        assert(!(al->map[offset] & mask));
-               
        al->map[offset] |= mask;
 
        if (!al->level)
                data->set_bits = nr_bits;
 
+       /* For the next level */
        data->nr_bits = 1;
+
        return al->map[offset] != -1UL;
 }
 
+/*
+ * Set up to @data->nr_bits starting from @bit_nr in @axmap. Start at
+ * @bit_nr. If that bit has not yet been set then set it and continue until
+ * either @data->nr_bits have been set or a 1 bit is found. Store the number
+ * of bits that have been set in @data->set_bits. It is guaranteed that all
+ * bits that have been requested to set fit in the same unsigned long word of
+ * level 0 of @axmap.
+ */
 static void __axmap_set(struct axmap *axmap, uint64_t bit_nr,
                         struct axmap_set_data *data)
 {
        unsigned int set_bits, nr_bits = data->nr_bits;
 
-       if (axmap->first_free >= bit_nr &&
-           axmap->first_free < bit_nr + data->nr_bits)
-               axmap->first_free = -1ULL;
-
        if (bit_nr > axmap->nr_bits)
                return;
        else if (bit_nr + nr_bits > axmap->nr_bits)
@@ -297,12 +307,17 @@ void axmap_set(struct axmap *axmap, uint64_t bit_nr)
 {
        struct axmap_set_data data = { .nr_bits = 1, };
 
-       fio_mutex_down(&axmap->lock);
        __axmap_set(axmap, bit_nr, &data);
-       fio_mutex_up(&axmap->lock);
 }
 
-unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr, unsigned int nr_bits)
+/*
+ * Set up to @nr_bits starting from @bit in @axmap. Start at @bit. If that
+ * bit has not yet been set then set it and continue until either @nr_bits
+ * have been set or a 1 bit is found. Return the number of bits that have been
+ * set.
+ */
+unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr,
+                         unsigned int nr_bits)
 {
        unsigned int set_bits = 0;
 
@@ -311,7 +326,7 @@ unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr, unsigned int nr_
                unsigned int max_bits, this_set;
 
                max_bits = BLOCKS_PER_UNIT - (bit_nr & BLOCKS_PER_UNIT_MASK);
-               if (max_bits < nr_bits)
+               if (nr_bits > max_bits)
                        data.nr_bits = max_bits;
 
                this_set = data.nr_bits;
@@ -327,140 +342,133 @@ unsigned int axmap_set_nr(struct axmap *axmap, uint64_t bit_nr, unsigned int nr_
        return set_bits;
 }
 
-static int axmap_isset_fn(struct axmap_level *al, unsigned long offset,
-                           unsigned int bit, void *unused)
+static bool axmap_isset_fn(struct axmap_level *al, unsigned long offset,
+                          unsigned int bit, void *unused)
 {
        return (al->map[offset] & (1UL << bit)) != 0;
 }
 
-int axmap_isset(struct axmap *axmap, uint64_t bit_nr)
+bool axmap_isset(struct axmap *axmap, uint64_t bit_nr)
 {
-       if (bit_nr <= axmap->nr_bits) {
-               int ret;
+       if (bit_nr <= axmap->nr_bits)
+               return axmap_handler_topdown(axmap, bit_nr, axmap_isset_fn);
 
-               fio_mutex_down(&axmap->lock);
-               ret = axmap_handler_topdown(axmap, bit_nr, axmap_isset_fn, NULL);
-               fio_mutex_up(&axmap->lock);
-               return ret;
-       }
-
-       return 0;
+       return false;
 }
 
-static uint64_t axmap_find_first_free(struct axmap *axmap, unsigned int level,
-                                      uint64_t index)
+/*
+ * Find the first free bit that is at least as large as bit_nr.  Return
+ * -1 if no free bit is found before the end of the map.
+ */
+static uint64_t axmap_find_first_free(struct axmap *axmap, uint64_t bit_nr)
 {
-       uint64_t ret = -1ULL;
-       unsigned long j;
        int i;
+       unsigned long temp;
+       unsigned int bit;
+       uint64_t offset, base_index, index;
+       struct axmap_level *al;
 
-       /*
-        * Start at the bottom, then converge towards first free bit at the top
-        */
-       for (i = level; i >= 0; i--) {
-               struct axmap_level *al = &axmap->levels[i];
+       index = 0;
+       for (i = axmap->nr_levels - 1; i >= 0; i--) {
+               al = &axmap->levels[i];
+
+               /* Shift previously calculated index for next level */
+               index <<= UNIT_SHIFT;
 
                /*
-                * Clear 'ret', this is a bug condition.
+                * Start from an index that's at least as large as the
+                * originally passed in bit number.
                 */
-               if (index >= al->map_size) {
-                       ret = -1ULL;
-                       break;
-               }
-
-               for (j = index; j < al->map_size; j++) {
-                       if (al->map[j] == -1UL)
-                               continue;
+               base_index = bit_nr >> (UNIT_SHIFT * i);
+               if (index < base_index)
+                       index = base_index;
 
-                       /*
-                        * First free bit here is our index into the first
-                        * free bit at the next higher level
-                        */
-                       ret = index = (j << UNIT_SHIFT) + ffz(al->map[j]);
-                       break;
-               }
-       }
-
-       if (ret < axmap->nr_bits)
-               return ret;
-
-       return (uint64_t) -1ULL;
-}
-
-uint64_t axmap_first_free(struct axmap *axmap)
-{
-       uint64_t ret;
-
-       if (firstfree_valid(axmap))
-               return axmap->first_free;
+               /* Get the offset and bit for this level */
+               offset = index >> UNIT_SHIFT;
+               bit = index & BLOCKS_PER_UNIT_MASK;
 
-       fio_mutex_down(&axmap->lock);
-       ret = axmap_find_first_free(axmap, axmap->nr_levels - 1, 0);
-       axmap->first_free = ret;
-       fio_mutex_up(&axmap->lock);
-
-       return ret;
-}
+               /*
+                * If the previous level had unused bits in its last
+                * word, the offset could be bigger than the map at
+                * this level. That means no free bits exist before the
+                * end of the map, so return -1.
+                */
+               if (offset >= al->map_size)
+                       return -1ULL;
 
-struct axmap_next_free_data {
-       unsigned int level;
-       unsigned long offset;
-       uint64_t bit;
-};
+               /* Check the first word starting with the specific bit */
+               temp = ~bit_masks[bit] & ~al->map[offset];
+               if (temp)
+                       goto found;
 
-static int axmap_next_free_fn(struct axmap_level *al, unsigned long offset,
-                              unsigned int bit, void *__data)
-{
-       struct axmap_next_free_data *data = __data;
-       uint64_t mask = ~bit_masks[(data->bit + 1) & BLOCKS_PER_UNIT_MASK];
+               /*
+                * No free bit in the first word, so iterate
+                * looking for a word with one or more free bits.
+                */
+               for (offset++; offset < al->map_size; offset++) {
+                       temp = ~al->map[offset];
+                       if (temp)
+                               goto found;
+               }
 
-       if (!(mask & ~al->map[offset]))
-               return 0;
+               /* Did not find a free bit */
+               return -1ULL;
 
-       if (al->map[offset] != -1UL) {
-               data->level = al->level;
-               data->offset = offset;
-               return 1;
+found:
+               /* Compute the index of the free bit just found */
+               index = (offset << UNIT_SHIFT) + ffz(~temp);
        }
 
-       data->bit = (data->bit + BLOCKS_PER_UNIT - 1) / BLOCKS_PER_UNIT;
-       return 0;
+       /* If found an unused bit in the last word of level 0, return -1 */
+       if (index >= axmap->nr_bits)
+               return -1ULL;
+
+       return index;
 }
 
 /*
  * 'bit_nr' is already set. Find the next free bit after this one.
+ * Return -1 if no free bits found.
  */
 uint64_t axmap_next_free(struct axmap *axmap, uint64_t bit_nr)
 {
-       struct axmap_next_free_data data = { .level = -1U, .bit = bit_nr, };
        uint64_t ret;
+       uint64_t next_bit = bit_nr + 1;
+       unsigned long temp;
+       uint64_t offset;
+       unsigned int bit;
 
-       fio_mutex_down(&axmap->lock);
-
-       if (firstfree_valid(axmap) && bit_nr < axmap->first_free) {
-               ret = axmap->first_free;
-               goto done;
-       }
+       if (bit_nr >= axmap->nr_bits)
+               return -1ULL;
 
-       if (!axmap_handler(axmap, bit_nr, axmap_next_free_fn, &data)) {
-               ret = axmap_first_free(axmap);
-               goto done;
-       }
+       /* If at the end of the map, wrap-around */
+       if (next_bit == axmap->nr_bits)
+               next_bit = 0;
 
-       assert(data.level != -1U);
+       offset = next_bit >> UNIT_SHIFT;
+       bit = next_bit & BLOCKS_PER_UNIT_MASK;
 
        /*
-        * In the rare case that the map is unaligned, we might end up
-        * finding an offset that's beyond the valid end. For that case,
-        * find the first free one, the map is practically full.
+        * As an optimization, do a quick check for a free bit
+        * in the current word at level 0. If not found, do
+        * a topdown search.
         */
-       ret = axmap_find_first_free(axmap, data.level, data.offset);
-       if (ret != -1ULL) {
-done:
-               fio_mutex_up(&axmap->lock);
-               return ret;
-       }
+       temp = ~bit_masks[bit] & ~axmap->levels[0].map[offset];
+       if (temp) {
+               ret = (offset << UNIT_SHIFT) + ffz(~temp);
+
+               /* Might have found an unused bit at level 0 */
+               if (ret >= axmap->nr_bits)
+                       ret = -1ULL;
+       } else
+               ret = axmap_find_first_free(axmap, next_bit);
 
-       ret = axmap_first_free(axmap);
-       goto done;
+       /*
+        * If there are no free bits starting at next_bit and going
+        * to the end of the map, wrap around by searching again
+        * starting at bit 0.
+        */
+       if (ret == -1ULL && next_bit != 0)
+               ret = axmap_find_first_free(axmap, 0);
+       return ret;
 }