lib/idr.c

   1 #include <linux/bitmap.h>
   2 #include <linux/export.h>
   3 #include <linux/idr.h>
   4 #include <linux/slab.h>
   5 #include <linux/spinlock.h>
   6
   7 DEFINE_PER_CPU(struct ida_bitmap *, ida_bitmap);
   8 static DEFINE_SPINLOCK(simple_ida_lock);
   9
  10 /**
  11  * idr_alloc - allocate an id
  12  * @idr: idr handle
  13  * @ptr: pointer to be associated with the new id
  14  * @start: the minimum id (inclusive)
  15  * @end: the maximum id (exclusive)
  16  * @gfp: memory allocation flags
  17  *
  18  * Allocates an unused ID in the range [start, end).  Returns -ENOSPC
  19  * if there are no unused IDs in that range.
  20  *
  21  * Note that @end is treated as max when <= 0.  This is to always allow
  22  * using @start + N as @end as long as N is inside integer range.
  23  *
  24  * Simultaneous modifications to the @idr are not allowed and should be
  25  * prevented by the user, usually with a lock.  idr_alloc() may be called
  26  * concurrently with read-only accesses to the @idr, such as idr_find() and
  27  * idr_for_each_entry().
  28  */
  29 int idr_alloc(struct idr *idr, void *ptr, int start, int end, gfp_t gfp)
  30 {
  31         void **slot;
  32         struct radix_tree_iter iter;
  33
  34         if (WARN_ON_ONCE(start < 0))
  35                 return -EINVAL;
  36         if (WARN_ON_ONCE(radix_tree_is_internal_node(ptr)))
  37                 return -EINVAL;
  38
  39         radix_tree_iter_init(&iter, start);
  40         slot = idr_get_free(&idr->idr_rt, &iter, gfp, end);
  41         if (IS_ERR(slot))
  42                 return PTR_ERR(slot);
  43
  44         radix_tree_iter_replace(&idr->idr_rt, &iter, slot, ptr);
  45         radix_tree_iter_tag_clear(&idr->idr_rt, &iter, IDR_FREE);
  46         return iter.index;
  47 }
  48 EXPORT_SYMBOL_GPL(idr_alloc);
  49
  50 /**
  51  * idr_alloc_cyclic - allocate new idr entry in a cyclical fashion
  52  * @idr: idr handle
  53  * @ptr: pointer to be associated with the new id
  54  * @start: the minimum id (inclusive)
  55  * @end: the maximum id (exclusive)
  56  * @gfp: memory allocation flags
  57  *
  58  * Allocates an ID larger than the last ID allocated if one is available.
  59  * If not, it will attempt to allocate the smallest ID that is larger or
  60  * equal to @start.
  61  */
  62 int idr_alloc_cyclic(struct idr *idr, void *ptr, int start, int end, gfp_t gfp)
  63 {
  64         int id, curr = idr->idr_next;
  65
  66         if (curr < start)
  67                 curr = start;
  68
  69         id = idr_alloc(idr, ptr, curr, end, gfp);
  70         if ((id == -ENOSPC) && (curr > start))
  71                 id = idr_alloc(idr, ptr, start, curr, gfp);
  72
  73         if (id >= 0)
  74                 idr->idr_next = id + 1U;
  75
  76         return id;
  77 }
  78 EXPORT_SYMBOL(idr_alloc_cyclic);
  79
  80 /**
  81  * idr_for_each - iterate through all stored pointers
  82  * @idr: idr handle
  83  * @fn: function to be called for each pointer
  84  * @data: data passed to callback function
  85  *
  86  * The callback function will be called for each entry in @idr, passing
  87  * the id, the pointer and the data pointer passed to this function.
  88  *
  89  * If @fn returns anything other than %0, the iteration stops and that
  90  * value is returned from this function.
  91  *
  92  * idr_for_each() can be called concurrently with idr_alloc() and
  93  * idr_remove() if protected by RCU.  Newly added entries may not be
  94  * seen and deleted entries may be seen, but adding and removing entries
  95  * will not cause other entries to be skipped, nor spurious ones to be seen.
  96  */
  97 int idr_for_each(const struct idr *idr,
  98                 int (*fn)(int id, void *p, void *data), void *data)
  99 {
 100         struct radix_tree_iter iter;
 101         void **slot;
 102
 103         radix_tree_for_each_slot(slot, &idr->idr_rt, &iter, 0) {
 104                 int ret = fn(iter.index, rcu_dereference_raw(*slot), data);
 105                 if (ret)
 106                         return ret;
 107         }
 108
 109         return 0;
 110 }
 111 EXPORT_SYMBOL(idr_for_each);
 112
 113 /**
 114  * idr_get_next - Find next populated entry
 115  * @idr: idr handle
 116  * @nextid: Pointer to lowest possible ID to return
 117  *
 118  * Returns the next populated entry in the tree with an ID greater than
 119  * or equal to the value pointed to by @nextid.  On exit, @nextid is updated
 120  * to the ID of the found value.  To use in a loop, the value pointed to by
 121  * nextid must be incremented by the user.
 122  */
 123 void *idr_get_next(struct idr *idr, int *nextid)
 124 {
 125         struct radix_tree_iter iter;
 126         void **slot;
 127
 128         slot = radix_tree_iter_find(&idr->idr_rt, &iter, *nextid);
 129         if (!slot)
 130                 return NULL;
 131
 132         *nextid = iter.index;
 133         return rcu_dereference_raw(*slot);
 134 }
 135 EXPORT_SYMBOL(idr_get_next);
 136
 137 /**
 138  * idr_replace - replace pointer for given id
 139  * @idr: idr handle
 140  * @ptr: New pointer to associate with the ID
 141  * @id: Lookup key
 142  *
 143  * Replace the pointer registered with an ID and return the old value.
 144  * This function can be called under the RCU read lock concurrently with
 145  * idr_alloc() and idr_remove() (as long as the ID being removed is not
 146  * the one being replaced!).
 147  *
 148  * Returns: 0 on success.  %-ENOENT indicates that @id was not found.
 149  * %-EINVAL indicates that @id or @ptr were not valid.
 150  */
 151 void *idr_replace(struct idr *idr, void *ptr, int id)
 152 {
 153         struct radix_tree_node *node;
 154         void **slot = NULL;
 155         void *entry;
 156
 157         if (WARN_ON_ONCE(id < 0))
 158                 return ERR_PTR(-EINVAL);
 159         if (WARN_ON_ONCE(radix_tree_is_internal_node(ptr)))
 160                 return ERR_PTR(-EINVAL);
 161
 162         entry = __radix_tree_lookup(&idr->idr_rt, id, &node, &slot);
 163         if (!slot || radix_tree_tag_get(&idr->idr_rt, id, IDR_FREE))
 164                 return ERR_PTR(-ENOENT);
 165
 166         __radix_tree_replace(&idr->idr_rt, node, slot, ptr, NULL, NULL);
 167
 168         return entry;
 169 }
 170 EXPORT_SYMBOL(idr_replace);
 171
 172 /**
 173  * DOC: IDA description
 174  *
 175  * The IDA is an ID allocator which does not provide the ability to
 176  * associate an ID with a pointer.  As such, it only needs to store one
 177  * bit per ID, and so is more space efficient than an IDR.  To use an IDA,
 178  * define it using DEFINE_IDA() (or embed a &struct ida in a data structure,
 179  * then initialise it using ida_init()).  To allocate a new ID, call
 180  * ida_simple_get().  To free an ID, call ida_simple_remove().
 181  *
 182  * If you have more complex locking requirements, use a loop around
 183  * ida_pre_get() and ida_get_new() to allocate a new ID.  Then use
 184  * ida_remove() to free an ID.  You must make sure that ida_get_new() and
 185  * ida_remove() cannot be called at the same time as each other for the
 186  * same IDA.
 187  *
 188  * You can also use ida_get_new_above() if you need an ID to be allocated
 189  * above a particular number.  ida_destroy() can be used to dispose of an
 190  * IDA without needing to free the individual IDs in it.  You can use
 191  * ida_is_empty() to find out whether the IDA has any IDs currently allocated.
 192  *
 193  * IDs are currently limited to the range [0-INT_MAX].  If this is an awkward
 194  * limitation, it should be quite straightforward to raise the maximum.
 195  */
 196
 197 #define IDA_MAX (0x80000000U / IDA_BITMAP_BITS)
 198
 199 /**
 200  * ida_get_new_above - allocate new ID above or equal to a start id
 201  * @ida: ida handle
 202  * @start: id to start search at
 203  * @id: pointer to the allocated handle
 204  *
 205  * Allocate new ID above or equal to @start.  It should be called
 206  * with any required locks to ensure that concurrent calls to
 207  * ida_get_new_above() / ida_get_new() / ida_remove() are not allowed.
 208  * Consider using ida_simple_get() if you do not have complex locking
 209  * requirements.
 210  *
 211  * If memory is required, it will return %-EAGAIN, you should unlock
 212  * and go back to the ida_pre_get() call.  If the ida is full, it will
 213  * return %-ENOSPC.  On success, it will return 0.
 214  *
 215  * @id returns a value in the range @start ... %0x7fffffff.
 216  */
 217 int ida_get_new_above(struct ida *ida, int start, int *id)
 218 {
 219         struct radix_tree_root *root = &ida->ida_rt;
 220         void **slot;
 221         struct radix_tree_iter iter;
 222         struct ida_bitmap *bitmap;
 223         unsigned long index;
 224         unsigned bit;
 225         int new;
 226
 227         index = start / IDA_BITMAP_BITS;
 228         bit = start % IDA_BITMAP_BITS;
 229
 230         slot = radix_tree_iter_init(&iter, index);
 231         for (;;) {
 232                 if (slot)
 233                         slot = radix_tree_next_slot(slot, &iter,
 234                                                 RADIX_TREE_ITER_TAGGED);
 235                 if (!slot) {
 236                         slot = idr_get_free(root, &iter, GFP_NOWAIT, IDA_MAX);
 237                         if (IS_ERR(slot)) {
 238                                 if (slot == ERR_PTR(-ENOMEM))
 239                                         return -EAGAIN;
 240                                 return PTR_ERR(slot);
 241                         }
 242                 }
 243                 if (iter.index > index)
 244                         bit = 0;
 245                 new = iter.index * IDA_BITMAP_BITS;
 246                 bitmap = rcu_dereference_raw(*slot);
 247                 if (bitmap) {
 248                         bit = find_next_zero_bit(bitmap->bitmap,
 249                                                         IDA_BITMAP_BITS, bit);
 250                         new += bit;
 251                         if (new < 0)
 252                                 return -ENOSPC;
 253                         if (bit == IDA_BITMAP_BITS)
 254                                 continue;
 255
 256                         __set_bit(bit, bitmap->bitmap);
 257                         if (bitmap_full(bitmap->bitmap, IDA_BITMAP_BITS))
 258                                 radix_tree_iter_tag_clear(root, &iter,
 259                                                                 IDR_FREE);
 260                 } else {
 261                         new += bit;
 262                         if (new < 0)
 263                                 return -ENOSPC;
 264                         bitmap = this_cpu_xchg(ida_bitmap, NULL);
 265                         if (!bitmap)
 266                                 return -EAGAIN;
 267                         memset(bitmap, 0, sizeof(*bitmap));
 268                         __set_bit(bit, bitmap->bitmap);
 269                         radix_tree_iter_replace(root, &iter, slot, bitmap);
 270                 }
 271
 272                 *id = new;
 273                 return 0;
 274         }
 275 }
 276 EXPORT_SYMBOL(ida_get_new_above);
 277
 278 /**
 279  * ida_remove - Free the given ID
 280  * @ida: ida handle
 281  * @id: ID to free
 282  *
 283  * This function should not be called at the same time as ida_get_new_above().
 284  */
 285 void ida_remove(struct ida *ida, int id)
 286 {
 287         unsigned long index = id / IDA_BITMAP_BITS;
 288         unsigned offset = id % IDA_BITMAP_BITS;
 289         struct ida_bitmap *bitmap;
 290         struct radix_tree_iter iter;
 291         void **slot;
 292
 293         slot = radix_tree_iter_lookup(&ida->ida_rt, &iter, index);
 294         if (!slot)
 295                 goto err;
 296
 297         bitmap = rcu_dereference_raw(*slot);
 298         if (!test_bit(offset, bitmap->bitmap))
 299                 goto err;
 300
 301         __clear_bit(offset, bitmap->bitmap);
 302         radix_tree_iter_tag_set(&ida->ida_rt, &iter, IDR_FREE);
 303         if (bitmap_empty(bitmap->bitmap, IDA_BITMAP_BITS)) {
 304                 kfree(bitmap);
 305                 radix_tree_iter_delete(&ida->ida_rt, &iter, slot);
 306         }
 307         return;
 308  err:
 309         WARN(1, "ida_remove called for id=%d which is not allocated.\n", id);
 310 }
 311 EXPORT_SYMBOL(ida_remove);
 312
 313 /**
 314  * ida_destroy - Free the contents of an ida
 315  * @ida: ida handle
 316  *
 317  * Calling this function releases all resources associated with an IDA.  When
 318  * this call returns, the IDA is empty and can be reused or freed.  The caller
 319  * should not allow ida_remove() or ida_get_new_above() to be called at the
 320  * same time.
 321  */
 322 void ida_destroy(struct ida *ida)
 323 {
 324         struct radix_tree_iter iter;
 325         void **slot;
 326
 327         radix_tree_for_each_slot(slot, &ida->ida_rt, &iter, 0) {
 328                 struct ida_bitmap *bitmap = rcu_dereference_raw(*slot);
 329                 kfree(bitmap);
 330                 radix_tree_iter_delete(&ida->ida_rt, &iter, slot);
 331         }
 332 }
 333 EXPORT_SYMBOL(ida_destroy);
 334
 335 /**
 336  * ida_simple_get - get a new id.
 337  * @ida: the (initialized) ida.
 338  * @start: the minimum id (inclusive, < 0x8000000)
 339  * @end: the maximum id (exclusive, < 0x8000000 or 0)
 340  * @gfp_mask: memory allocation flags
 341  *
 342  * Allocates an id in the range start <= id < end, or returns -ENOSPC.
 343  * On memory allocation failure, returns -ENOMEM.
 344  *
 345  * Compared to ida_get_new_above() this function does its own locking, and
 346  * should be used unless there are special requirements.
 347  *
 348  * Use ida_simple_remove() to get rid of an id.
 349  */
 350 int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
 351                    gfp_t gfp_mask)
 352 {
 353         int ret, id;
 354         unsigned int max;
 355         unsigned long flags;
 356
 357         BUG_ON((int)start < 0);
 358         BUG_ON((int)end < 0);
 359
 360         if (end == 0)
 361                 max = 0x80000000;
 362         else {
 363                 BUG_ON(end < start);
 364                 max = end - 1;
 365         }
 366
 367 again:
 368         if (!ida_pre_get(ida, gfp_mask))
 369                 return -ENOMEM;
 370
 371         spin_lock_irqsave(&simple_ida_lock, flags);
 372         ret = ida_get_new_above(ida, start, &id);
 373         if (!ret) {
 374                 if (id > max) {
 375                         ida_remove(ida, id);
 376                         ret = -ENOSPC;
 377                 } else {
 378                         ret = id;
 379                 }
 380         }
 381         spin_unlock_irqrestore(&simple_ida_lock, flags);
 382
 383         if (unlikely(ret == -EAGAIN))
 384                 goto again;
 385
 386         return ret;
 387 }
 388 EXPORT_SYMBOL(ida_simple_get);
 389
 390 /**
 391  * ida_simple_remove - remove an allocated id.
 392  * @ida: the (initialized) ida.
 393  * @id: the id returned by ida_simple_get.
 394  *
 395  * Use to release an id allocated with ida_simple_get().
 396  *
 397  * Compared to ida_remove() this function does its own locking, and should be
 398  * used unless there are special requirements.
 399  */
 400 void ida_simple_remove(struct ida *ida, unsigned int id)
 401 {
 402         unsigned long flags;
 403
 404         BUG_ON((int)id < 0);
 405         spin_lock_irqsave(&simple_ida_lock, flags);
 406         ida_remove(ida, id);
 407         spin_unlock_irqrestore(&simple_ida_lock, flags);
 408 }
 409 EXPORT_SYMBOL(ida_simple_remove);