lib/idr.c

   1 /*
   2  * 2002-10-18  written by Jim Houston jim.houston@ccur.com
   3  *      Copyright (C) 2002 by Concurrent Computer Corporation
   4  *      Distributed under the GNU GPL license version 2.
   5  *
   6  * Modified by George Anzinger to reuse immediately and to use
   7  * find bit instructions.  Also removed _irq on spinlocks.
   8  *
   9  * Modified by Nadia Derbey to make it RCU safe.
  10  *
  11  * Small id to pointer translation service.
  12  *
  13  * It uses a radix tree like structure as a sparse array indexed
  14  * by the id to obtain the pointer.  The bitmap makes allocating
  15  * a new id quick.
  16  *
  17  * You call it to allocate an id (an int) an associate with that id a
  18  * pointer or what ever, we treat it as a (void *).  You can pass this
  19  * id to a user for him to pass back at a later time.  You then pass
  20  * that id to this code and it returns your pointer.
  21
  22  * You can release ids at any time. When all ids are released, most of
  23  * the memory is returned (we keep MAX_IDR_FREE) in a local pool so we
  24  * don't need to go to the memory "store" during an id allocate, just
  25  * so you don't need to be too concerned about locking and conflicts
  26  * with the slab allocator.
  27  */
  28
  29 #ifndef TEST                        // to test in user space...
  30 #include <linux/slab.h>
  31 #include <linux/init.h>
  32 #include <linux/export.h>
  33 #endif
  34 #include <linux/err.h>
  35 #include <linux/string.h>
  36 #include <linux/idr.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/percpu.h>
  39 #include <linux/hardirq.h>
  40
  41 #define MAX_IDR_SHIFT           (sizeof(int) * 8 - 1)
  42 #define MAX_IDR_BIT             (1U << MAX_IDR_SHIFT)
  43
  44 /* Leave the possibility of an incomplete final layer */
  45 #define MAX_IDR_LEVEL ((MAX_IDR_SHIFT + IDR_BITS - 1) / IDR_BITS)
  46
  47 /* Number of id_layer structs to leave in free list */
  48 #define MAX_IDR_FREE (MAX_IDR_LEVEL * 2)
  49
  50 static struct kmem_cache *idr_layer_cache;
  51 static DEFINE_PER_CPU(struct idr_layer *, idr_preload_head);
  52 static DEFINE_PER_CPU(int, idr_preload_cnt);
  53 static DEFINE_SPINLOCK(simple_ida_lock);
  54
  55 /* the maximum ID which can be allocated given idr->layers */
  56 static int idr_max(int layers)
  57 {
  58         int bits = min_t(int, layers * IDR_BITS, MAX_IDR_SHIFT);
  59
  60         return (1 << bits) - 1;
  61 }
  62
  63 /*
  64  * Prefix mask for an idr_layer at @layer.  For layer 0, the prefix mask is
  65  * all bits except for the lower IDR_BITS.  For layer 1, 2 * IDR_BITS, and
  66  * so on.
  67  */
  68 static int idr_layer_prefix_mask(int layer)
  69 {
  70         return ~idr_max(layer + 1);
  71 }
  72
  73 static struct idr_layer *get_from_free_list(struct idr *idp)
  74 {
  75         struct idr_layer *p;
  76         unsigned long flags;
  77
  78         spin_lock_irqsave(&idp->lock, flags);
  79         if ((p = idp->id_free)) {
  80                 idp->id_free = p->ary[0];
  81                 idp->id_free_cnt--;
  82                 p->ary[0] = NULL;
  83         }
  84         spin_unlock_irqrestore(&idp->lock, flags);
  85         return(p);
  86 }
  87
  88 /**
  89  * idr_layer_alloc - allocate a new idr_layer
  90  * @gfp_mask: allocation mask
  91  * @layer_idr: optional idr to allocate from
  92  *
  93  * If @layer_idr is %NULL, directly allocate one using @gfp_mask or fetch
  94  * one from the per-cpu preload buffer.  If @layer_idr is not %NULL, fetch
  95  * an idr_layer from @idr->id_free.
  96  *
  97  * @layer_idr is to maintain backward compatibility with the old alloc
  98  * interface - idr_pre_get() and idr_get_new*() - and will be removed
  99  * together with per-pool preload buffer.
 100  */
 101 static struct idr_layer *idr_layer_alloc(gfp_t gfp_mask, struct idr *layer_idr)
 102 {
 103         struct idr_layer *new;
 104
 105         /* this is the old path, bypass to get_from_free_list() */
 106         if (layer_idr)
 107                 return get_from_free_list(layer_idr);
 108
 109         /* try to allocate directly from kmem_cache */
 110         new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
 111         if (new)
 112                 return new;
 113
 114         /*
 115          * Try to fetch one from the per-cpu preload buffer if in process
 116          * context.  See idr_preload() for details.
 117          */
 118         if (in_interrupt())
 119                 return NULL;
 120
 121         preempt_disable();
 122         new = __this_cpu_read(idr_preload_head);
 123         if (new) {
 124                 __this_cpu_write(idr_preload_head, new->ary[0]);
 125                 __this_cpu_dec(idr_preload_cnt);
 126                 new->ary[0] = NULL;
 127         }
 128         preempt_enable();
 129         return new;
 130 }
 131
 132 static void idr_layer_rcu_free(struct rcu_head *head)
 133 {
 134         struct idr_layer *layer;
 135
 136         layer = container_of(head, struct idr_layer, rcu_head);
 137         kmem_cache_free(idr_layer_cache, layer);
 138 }
 139
 140 static inline void free_layer(struct idr *idr, struct idr_layer *p)
 141 {
 142         if (idr->hint && idr->hint == p)
 143                 RCU_INIT_POINTER(idr->hint, NULL);
 144         call_rcu(&p->rcu_head, idr_layer_rcu_free);
 145 }
 146
 147 /* only called when idp->lock is held */
 148 static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
 149 {
 150         p->ary[0] = idp->id_free;
 151         idp->id_free = p;
 152         idp->id_free_cnt++;
 153 }
 154
 155 static void move_to_free_list(struct idr *idp, struct idr_layer *p)
 156 {
 157         unsigned long flags;
 158
 159         /*
 160          * Depends on the return element being zeroed.
 161          */
 162         spin_lock_irqsave(&idp->lock, flags);
 163         __move_to_free_list(idp, p);
 164         spin_unlock_irqrestore(&idp->lock, flags);
 165 }
 166
 167 static void idr_mark_full(struct idr_layer **pa, int id)
 168 {
 169         struct idr_layer *p = pa[0];
 170         int l = 0;
 171
 172         __set_bit(id & IDR_MASK, p->bitmap);
 173         /*
 174          * If this layer is full mark the bit in the layer above to
 175          * show that this part of the radix tree is full.  This may
 176          * complete the layer above and require walking up the radix
 177          * tree.
 178          */
 179         while (bitmap_full(p->bitmap, IDR_SIZE)) {
 180                 if (!(p = pa[++l]))
 181                         break;
 182                 id = id >> IDR_BITS;
 183                 __set_bit((id & IDR_MASK), p->bitmap);
 184         }
 185 }
 186
 187 int __idr_pre_get(struct idr *idp, gfp_t gfp_mask)
 188 {
 189         while (idp->id_free_cnt < MAX_IDR_FREE) {
 190                 struct idr_layer *new;
 191                 new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
 192                 if (new == NULL)
 193                         return (0);
 194                 move_to_free_list(idp, new);
 195         }
 196         return 1;
 197 }
 198 EXPORT_SYMBOL(__idr_pre_get);
 199
 200 /**
 201  * sub_alloc - try to allocate an id without growing the tree depth
 202  * @idp: idr handle
 203  * @starting_id: id to start search at
 204  * @pa: idr_layer[MAX_IDR_LEVEL] used as backtrack buffer
 205  * @gfp_mask: allocation mask for idr_layer_alloc()
 206  * @layer_idr: optional idr passed to idr_layer_alloc()
 207  *
 208  * Allocate an id in range [@starting_id, INT_MAX] from @idp without
 209  * growing its depth.  Returns
 210  *
 211  *  the allocated id >= 0 if successful,
 212  *  -EAGAIN if the tree needs to grow for allocation to succeed,
 213  *  -ENOSPC if the id space is exhausted,
 214  *  -ENOMEM if more idr_layers need to be allocated.
 215  */
 216 static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa,
 217                      gfp_t gfp_mask, struct idr *layer_idr)
 218 {
 219         int n, m, sh;
 220         struct idr_layer *p, *new;
 221         int l, id, oid;
 222
 223         id = *starting_id;
 224  restart:
 225         p = idp->top;
 226         l = idp->layers;
 227         pa[l--] = NULL;
 228         while (1) {
 229                 /*
 230                  * We run around this while until we reach the leaf node...
 231                  */
 232                 n = (id >> (IDR_BITS*l)) & IDR_MASK;
 233                 m = find_next_zero_bit(p->bitmap, IDR_SIZE, n);
 234                 if (m == IDR_SIZE) {
 235                         /* no space available go back to previous layer. */
 236                         l++;
 237                         oid = id;
 238                         id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
 239
 240                         /* if already at the top layer, we need to grow */
 241                         if (id >= 1 << (idp->layers * IDR_BITS)) {
 242                                 *starting_id = id;
 243                                 return -EAGAIN;
 244                         }
 245                         p = pa[l];
 246                         BUG_ON(!p);
 247
 248                         /* If we need to go up one layer, continue the
 249                          * loop; otherwise, restart from the top.
 250                          */
 251                         sh = IDR_BITS * (l + 1);
 252                         if (oid >> sh == id >> sh)
 253                                 continue;
 254                         else
 255                                 goto restart;
 256                 }
 257                 if (m != n) {
 258                         sh = IDR_BITS*l;
 259                         id = ((id >> sh) ^ n ^ m) << sh;
 260                 }
 261                 if ((id >= MAX_IDR_BIT) || (id < 0))
 262                         return -ENOSPC;
 263                 if (l == 0)
 264                         break;
 265                 /*
 266                  * Create the layer below if it is missing.
 267                  */
 268                 if (!p->ary[m]) {
 269                         new = idr_layer_alloc(gfp_mask, layer_idr);
 270                         if (!new)
 271                                 return -ENOMEM;
 272                         new->layer = l-1;
 273                         new->prefix = id & idr_layer_prefix_mask(new->layer);
 274                         rcu_assign_pointer(p->ary[m], new);
 275                         p->count++;
 276                 }
 277                 pa[l--] = p;
 278                 p = p->ary[m];
 279         }
 280
 281         pa[l] = p;
 282         return id;
 283 }
 284
 285 static int idr_get_empty_slot(struct idr *idp, int starting_id,
 286                               struct idr_layer **pa, gfp_t gfp_mask,
 287                               struct idr *layer_idr)
 288 {
 289         struct idr_layer *p, *new;
 290         int layers, v, id;
 291         unsigned long flags;
 292
 293         id = starting_id;
 294 build_up:
 295         p = idp->top;
 296         layers = idp->layers;
 297         if (unlikely(!p)) {
 298                 if (!(p = idr_layer_alloc(gfp_mask, layer_idr)))
 299                         return -ENOMEM;
 300                 p->layer = 0;
 301                 layers = 1;
 302         }
 303         /*
 304          * Add a new layer to the top of the tree if the requested
 305          * id is larger than the currently allocated space.
 306          */
 307         while (id > idr_max(layers)) {
 308                 layers++;
 309                 if (!p->count) {
 310                         /* special case: if the tree is currently empty,
 311                          * then we grow the tree by moving the top node
 312                          * upwards.
 313                          */
 314                         p->layer++;
 315                         WARN_ON_ONCE(p->prefix);
 316                         continue;
 317                 }
 318                 if (!(new = idr_layer_alloc(gfp_mask, layer_idr))) {
 319                         /*
 320                          * The allocation failed.  If we built part of
 321                          * the structure tear it down.
 322                          */
 323                         spin_lock_irqsave(&idp->lock, flags);
 324                         for (new = p; p && p != idp->top; new = p) {
 325                                 p = p->ary[0];
 326                                 new->ary[0] = NULL;
 327                                 new->count = 0;
 328                                 bitmap_clear(new->bitmap, 0, IDR_SIZE);
 329                                 __move_to_free_list(idp, new);
 330                         }
 331                         spin_unlock_irqrestore(&idp->lock, flags);
 332                         return -ENOMEM;
 333                 }
 334                 new->ary[0] = p;
 335                 new->count = 1;
 336                 new->layer = layers-1;
 337                 new->prefix = id & idr_layer_prefix_mask(new->layer);
 338                 if (bitmap_full(p->bitmap, IDR_SIZE))
 339                         __set_bit(0, new->bitmap);
 340                 p = new;
 341         }
 342         rcu_assign_pointer(idp->top, p);
 343         idp->layers = layers;
 344         v = sub_alloc(idp, &id, pa, gfp_mask, layer_idr);
 345         if (v == -EAGAIN)
 346                 goto build_up;
 347         return(v);
 348 }
 349
 350 /*
 351  * @id and @pa are from a successful allocation from idr_get_empty_slot().
 352  * Install the user pointer @ptr and mark the slot full.
 353  */
 354 static void idr_fill_slot(struct idr *idr, void *ptr, int id,
 355                           struct idr_layer **pa)
 356 {
 357         /* update hint used for lookup, cleared from free_layer() */
 358         rcu_assign_pointer(idr->hint, pa[0]);
 359
 360         rcu_assign_pointer(pa[0]->ary[id & IDR_MASK], (struct idr_layer *)ptr);
 361         pa[0]->count++;
 362         idr_mark_full(pa, id);
 363 }
 364
 365 int __idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
 366 {
 367         struct idr_layer *pa[MAX_IDR_LEVEL + 1];
 368         int rv;
 369
 370         rv = idr_get_empty_slot(idp, starting_id, pa, 0, idp);
 371         if (rv < 0)
 372                 return rv == -ENOMEM ? -EAGAIN : rv;
 373
 374         idr_fill_slot(idp, ptr, rv, pa);
 375         *id = rv;
 376         return 0;
 377 }
 378 EXPORT_SYMBOL(__idr_get_new_above);
 379
 380 /**
 381  * idr_preload - preload for idr_alloc()
 382  * @gfp_mask: allocation mask to use for preloading
 383  *
 384  * Preload per-cpu layer buffer for idr_alloc().  Can only be used from
 385  * process context and each idr_preload() invocation should be matched with
 386  * idr_preload_end().  Note that preemption is disabled while preloaded.
 387  *
 388  * The first idr_alloc() in the preloaded section can be treated as if it
 389  * were invoked with @gfp_mask used for preloading.  This allows using more
 390  * permissive allocation masks for idrs protected by spinlocks.
 391  *
 392  * For example, if idr_alloc() below fails, the failure can be treated as
 393  * if idr_alloc() were called with GFP_KERNEL rather than GFP_NOWAIT.
 394  *
 395  *      idr_preload(GFP_KERNEL);
 396  *      spin_lock(lock);
 397  *
 398  *      id = idr_alloc(idr, ptr, start, end, GFP_NOWAIT);
 399  *
 400  *      spin_unlock(lock);
 401  *      idr_preload_end();
 402  *      if (id < 0)
 403  *              error;
 404  */
 405 void idr_preload(gfp_t gfp_mask)
 406 {
 407         /*
 408          * Consuming preload buffer from non-process context breaks preload
 409          * allocation guarantee.  Disallow usage from those contexts.
 410          */
 411         WARN_ON_ONCE(in_interrupt());
 412         might_sleep_if(gfp_mask & __GFP_WAIT);
 413
 414         preempt_disable();
 415
 416         /*
 417          * idr_alloc() is likely to succeed w/o full idr_layer buffer and
 418          * return value from idr_alloc() needs to be checked for failure
 419          * anyway.  Silently give up if allocation fails.  The caller can
 420          * treat failures from idr_alloc() as if idr_alloc() were called
 421          * with @gfp_mask which should be enough.
 422          */
 423         while (__this_cpu_read(idr_preload_cnt) < MAX_IDR_FREE) {
 424                 struct idr_layer *new;
 425
 426                 preempt_enable();
 427                 new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
 428                 preempt_disable();
 429                 if (!new)
 430                         break;
 431
 432                 /* link the new one to per-cpu preload list */
 433                 new->ary[0] = __this_cpu_read(idr_preload_head);
 434                 __this_cpu_write(idr_preload_head, new);
 435                 __this_cpu_inc(idr_preload_cnt);
 436         }
 437 }
 438 EXPORT_SYMBOL(idr_preload);
 439
 440 /**
 441  * idr_alloc - allocate new idr entry
 442  * @idr: the (initialized) idr
 443  * @ptr: pointer to be associated with the new id
 444  * @start: the minimum id (inclusive)
 445  * @end: the maximum id (exclusive, <= 0 for max)
 446  * @gfp_mask: memory allocation flags
 447  *
 448  * Allocate an id in [start, end) and associate it with @ptr.  If no ID is
 449  * available in the specified range, returns -ENOSPC.  On memory allocation
 450  * failure, returns -ENOMEM.
 451  *
 452  * Note that @end is treated as max when <= 0.  This is to always allow
 453  * using @start + N as @end as long as N is inside integer range.
 454  *
 455  * The user is responsible for exclusively synchronizing all operations
 456  * which may modify @idr.  However, read-only accesses such as idr_find()
 457  * or iteration can be performed under RCU read lock provided the user
 458  * destroys @ptr in RCU-safe way after removal from idr.
 459  */
 460 int idr_alloc(struct idr *idr, void *ptr, int start, int end, gfp_t gfp_mask)
 461 {
 462         int max = end > 0 ? end - 1 : INT_MAX;  /* inclusive upper limit */
 463         struct idr_layer *pa[MAX_IDR_LEVEL + 1];
 464         int id;
 465
 466         might_sleep_if(gfp_mask & __GFP_WAIT);
 467
 468         /* sanity checks */
 469         if (WARN_ON_ONCE(start < 0))
 470                 return -EINVAL;
 471         if (unlikely(max < start))
 472                 return -ENOSPC;
 473
 474         /* allocate id */
 475         id = idr_get_empty_slot(idr, start, pa, gfp_mask, NULL);
 476         if (unlikely(id < 0))
 477                 return id;
 478         if (unlikely(id > max))
 479                 return -ENOSPC;
 480
 481         idr_fill_slot(idr, ptr, id, pa);
 482         return id;
 483 }
 484 EXPORT_SYMBOL_GPL(idr_alloc);
 485
 486 static void idr_remove_warning(int id)
 487 {
 488         printk(KERN_WARNING
 489                 "idr_remove called for id=%d which is not allocated.\n", id);
 490         dump_stack();
 491 }
 492
 493 static void sub_remove(struct idr *idp, int shift, int id)
 494 {
 495         struct idr_layer *p = idp->top;
 496         struct idr_layer **pa[MAX_IDR_LEVEL + 1];
 497         struct idr_layer ***paa = &pa[0];
 498         struct idr_layer *to_free;
 499         int n;
 500
 501         *paa = NULL;
 502         *++paa = &idp->top;
 503
 504         while ((shift > 0) && p) {
 505                 n = (id >> shift) & IDR_MASK;
 506                 __clear_bit(n, p->bitmap);
 507                 *++paa = &p->ary[n];
 508                 p = p->ary[n];
 509                 shift -= IDR_BITS;
 510         }
 511         n = id & IDR_MASK;
 512         if (likely(p != NULL && test_bit(n, p->bitmap))) {
 513                 __clear_bit(n, p->bitmap);
 514                 rcu_assign_pointer(p->ary[n], NULL);
 515                 to_free = NULL;
 516                 while(*paa && ! --((**paa)->count)){
 517                         if (to_free)
 518                                 free_layer(idp, to_free);
 519                         to_free = **paa;
 520                         **paa-- = NULL;
 521                 }
 522                 if (!*paa)
 523                         idp->layers = 0;
 524                 if (to_free)
 525                         free_layer(idp, to_free);
 526         } else
 527                 idr_remove_warning(id);
 528 }
 529
 530 /**
 531  * idr_remove - remove the given id and free its slot
 532  * @idp: idr handle
 533  * @id: unique key
 534  */
 535 void idr_remove(struct idr *idp, int id)
 536 {
 537         struct idr_layer *p;
 538         struct idr_layer *to_free;
 539
 540         if (id < 0)
 541                 return;
 542
 543         sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
 544         if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
 545             idp->top->ary[0]) {
 546                 /*
 547                  * Single child at leftmost slot: we can shrink the tree.
 548                  * This level is not needed anymore since when layers are
 549                  * inserted, they are inserted at the top of the existing
 550                  * tree.
 551                  */
 552                 to_free = idp->top;
 553                 p = idp->top->ary[0];
 554                 rcu_assign_pointer(idp->top, p);
 555                 --idp->layers;
 556                 to_free->count = 0;
 557                 bitmap_clear(to_free->bitmap, 0, IDR_SIZE);
 558                 free_layer(idp, to_free);
 559         }
 560         while (idp->id_free_cnt >= MAX_IDR_FREE) {
 561                 p = get_from_free_list(idp);
 562                 /*
 563                  * Note: we don't call the rcu callback here, since the only
 564                  * layers that fall into the freelist are those that have been
 565                  * preallocated.
 566                  */
 567                 kmem_cache_free(idr_layer_cache, p);
 568         }
 569         return;
 570 }
 571 EXPORT_SYMBOL(idr_remove);
 572
 573 void __idr_remove_all(struct idr *idp)
 574 {
 575         int n, id, max;
 576         int bt_mask;
 577         struct idr_layer *p;
 578         struct idr_layer *pa[MAX_IDR_LEVEL + 1];
 579         struct idr_layer **paa = &pa[0];
 580
 581         n = idp->layers * IDR_BITS;
 582         p = idp->top;
 583         rcu_assign_pointer(idp->top, NULL);
 584         max = idr_max(idp->layers);
 585
 586         id = 0;
 587         while (id >= 0 && id <= max) {
 588                 while (n > IDR_BITS && p) {
 589                         n -= IDR_BITS;
 590                         *paa++ = p;
 591                         p = p->ary[(id >> n) & IDR_MASK];
 592                 }
 593
 594                 bt_mask = id;
 595                 id += 1 << n;
 596                 /* Get the highest bit that the above add changed from 0->1. */
 597                 while (n < fls(id ^ bt_mask)) {
 598                         if (p)
 599                                 free_layer(idp, p);
 600                         n += IDR_BITS;
 601                         p = *--paa;
 602                 }
 603         }
 604         idp->layers = 0;
 605 }
 606 EXPORT_SYMBOL(__idr_remove_all);
 607
 608 /**
 609  * idr_destroy - release all cached layers within an idr tree
 610  * @idp: idr handle
 611  *
 612  * Free all id mappings and all idp_layers.  After this function, @idp is
 613  * completely unused and can be freed / recycled.  The caller is
 614  * responsible for ensuring that no one else accesses @idp during or after
 615  * idr_destroy().
 616  *
 617  * A typical clean-up sequence for objects stored in an idr tree will use
 618  * idr_for_each() to free all objects, if necessay, then idr_destroy() to
 619  * free up the id mappings and cached idr_layers.
 620  */
 621 void idr_destroy(struct idr *idp)
 622 {
 623         __idr_remove_all(idp);
 624
 625         while (idp->id_free_cnt) {
 626                 struct idr_layer *p = get_from_free_list(idp);
 627                 kmem_cache_free(idr_layer_cache, p);
 628         }
 629 }
 630 EXPORT_SYMBOL(idr_destroy);
 631
 632 void *idr_find_slowpath(struct idr *idp, int id)
 633 {
 634         int n;
 635         struct idr_layer *p;
 636
 637         if (id < 0)
 638                 return NULL;
 639
 640         p = rcu_dereference_raw(idp->top);
 641         if (!p)
 642                 return NULL;
 643         n = (p->layer+1) * IDR_BITS;
 644
 645         if (id > idr_max(p->layer + 1))
 646                 return NULL;
 647         BUG_ON(n == 0);
 648
 649         while (n > 0 && p) {
 650                 n -= IDR_BITS;
 651                 BUG_ON(n != p->layer*IDR_BITS);
 652                 p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 653         }
 654         return((void *)p);
 655 }
 656 EXPORT_SYMBOL(idr_find_slowpath);
 657
 658 /**
 659  * idr_for_each - iterate through all stored pointers
 660  * @idp: idr handle
 661  * @fn: function to be called for each pointer
 662  * @data: data passed back to callback function
 663  *
 664  * Iterate over the pointers registered with the given idr.  The
 665  * callback function will be called for each pointer currently
 666  * registered, passing the id, the pointer and the data pointer passed
 667  * to this function.  It is not safe to modify the idr tree while in
 668  * the callback, so functions such as idr_get_new and idr_remove are
 669  * not allowed.
 670  *
 671  * We check the return of @fn each time. If it returns anything other
 672  * than %0, we break out and return that value.
 673  *
 674  * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
 675  */
 676 int idr_for_each(struct idr *idp,
 677                  int (*fn)(int id, void *p, void *data), void *data)
 678 {
 679         int n, id, max, error = 0;
 680         struct idr_layer *p;
 681         struct idr_layer *pa[MAX_IDR_LEVEL + 1];
 682         struct idr_layer **paa = &pa[0];
 683
 684         n = idp->layers * IDR_BITS;
 685         p = rcu_dereference_raw(idp->top);
 686         max = idr_max(idp->layers);
 687
 688         id = 0;
 689         while (id >= 0 && id <= max) {
 690                 while (n > 0 && p) {
 691                         n -= IDR_BITS;
 692                         *paa++ = p;
 693                         p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 694                 }
 695
 696                 if (p) {
 697                         error = fn(id, (void *)p, data);
 698                         if (error)
 699                                 break;
 700                 }
 701
 702                 id += 1 << n;
 703                 while (n < fls(id)) {
 704                         n += IDR_BITS;
 705                         p = *--paa;
 706                 }
 707         }
 708
 709         return error;
 710 }
 711 EXPORT_SYMBOL(idr_for_each);
 712
 713 /**
 714  * idr_get_next - lookup next object of id to given id.
 715  * @idp: idr handle
 716  * @nextidp:  pointer to lookup key
 717  *
 718  * Returns pointer to registered object with id, which is next number to
 719  * given id. After being looked up, *@nextidp will be updated for the next
 720  * iteration.
 721  *
 722  * This function can be called under rcu_read_lock(), given that the leaf
 723  * pointers lifetimes are correctly managed.
 724  */
 725 void *idr_get_next(struct idr *idp, int *nextidp)
 726 {
 727         struct idr_layer *p, *pa[MAX_IDR_LEVEL + 1];
 728         struct idr_layer **paa = &pa[0];
 729         int id = *nextidp;
 730         int n, max;
 731
 732         /* find first ent */
 733         p = rcu_dereference_raw(idp->top);
 734         if (!p)
 735                 return NULL;
 736         n = (p->layer + 1) * IDR_BITS;
 737         max = idr_max(p->layer + 1);
 738
 739         while (id >= 0 && id <= max) {
 740                 while (n > 0 && p) {
 741                         n -= IDR_BITS;
 742                         *paa++ = p;
 743                         p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 744                 }
 745
 746                 if (p) {
 747                         *nextidp = id;
 748                         return p;
 749                 }
 750
 751                 /*
 752                  * Proceed to the next layer at the current level.  Unlike
 753                  * idr_for_each(), @id isn't guaranteed to be aligned to
 754                  * layer boundary at this point and adding 1 << n may
 755                  * incorrectly skip IDs.  Make sure we jump to the
 756                  * beginning of the next layer using round_up().
 757                  */
 758                 id = round_up(id + 1, 1 << n);
 759                 while (n < fls(id)) {
 760                         n += IDR_BITS;
 761                         p = *--paa;
 762                 }
 763         }
 764         return NULL;
 765 }
 766 EXPORT_SYMBOL(idr_get_next);
 767
 768
 769 /**
 770  * idr_replace - replace pointer for given id
 771  * @idp: idr handle
 772  * @ptr: pointer you want associated with the id
 773  * @id: lookup key
 774  *
 775  * Replace the pointer registered with an id and return the old value.
 776  * A %-ENOENT return indicates that @id was not found.
 777  * A %-EINVAL return indicates that @id was not within valid constraints.
 778  *
 779  * The caller must serialize with writers.
 780  */
 781 void *idr_replace(struct idr *idp, void *ptr, int id)
 782 {
 783         int n;
 784         struct idr_layer *p, *old_p;
 785
 786         if (id < 0)
 787                 return ERR_PTR(-EINVAL);
 788
 789         p = idp->top;
 790         if (!p)
 791                 return ERR_PTR(-EINVAL);
 792
 793         n = (p->layer+1) * IDR_BITS;
 794
 795         if (id >= (1 << n))
 796                 return ERR_PTR(-EINVAL);
 797
 798         n -= IDR_BITS;
 799         while ((n > 0) && p) {
 800                 p = p->ary[(id >> n) & IDR_MASK];
 801                 n -= IDR_BITS;
 802         }
 803
 804         n = id & IDR_MASK;
 805         if (unlikely(p == NULL || !test_bit(n, p->bitmap)))
 806                 return ERR_PTR(-ENOENT);
 807
 808         old_p = p->ary[n];
 809         rcu_assign_pointer(p->ary[n], ptr);
 810
 811         return old_p;
 812 }
 813 EXPORT_SYMBOL(idr_replace);
 814
 815 void __init idr_init_cache(void)
 816 {
 817         idr_layer_cache = kmem_cache_create("idr_layer_cache",
 818                                 sizeof(struct idr_layer), 0, SLAB_PANIC, NULL);
 819 }
 820
 821 /**
 822  * idr_init - initialize idr handle
 823  * @idp:        idr handle
 824  *
 825  * This function is use to set up the handle (@idp) that you will pass
 826  * to the rest of the functions.
 827  */
 828 void idr_init(struct idr *idp)
 829 {
 830         memset(idp, 0, sizeof(struct idr));
 831         spin_lock_init(&idp->lock);
 832 }
 833 EXPORT_SYMBOL(idr_init);
 834
 835
 836 /**
 837  * DOC: IDA description
 838  * IDA - IDR based ID allocator
 839  *
 840  * This is id allocator without id -> pointer translation.  Memory
 841  * usage is much lower than full blown idr because each id only
 842  * occupies a bit.  ida uses a custom leaf node which contains
 843  * IDA_BITMAP_BITS slots.
 844  *
 845  * 2007-04-25  written by Tejun Heo <htejun@gmail.com>
 846  */
 847
 848 static void free_bitmap(struct ida *ida, struct ida_bitmap *bitmap)
 849 {
 850         unsigned long flags;
 851
 852         if (!ida->free_bitmap) {
 853                 spin_lock_irqsave(&ida->idr.lock, flags);
 854                 if (!ida->free_bitmap) {
 855                         ida->free_bitmap = bitmap;
 856                         bitmap = NULL;
 857                 }
 858                 spin_unlock_irqrestore(&ida->idr.lock, flags);
 859         }
 860
 861         kfree(bitmap);
 862 }
 863
 864 /**
 865  * ida_pre_get - reserve resources for ida allocation
 866  * @ida:        ida handle
 867  * @gfp_mask:   memory allocation flag
 868  *
 869  * This function should be called prior to locking and calling the
 870  * following function.  It preallocates enough memory to satisfy the
 871  * worst possible allocation.
 872  *
 873  * If the system is REALLY out of memory this function returns %0,
 874  * otherwise %1.
 875  */
 876 int ida_pre_get(struct ida *ida, gfp_t gfp_mask)
 877 {
 878         /* allocate idr_layers */
 879         if (!__idr_pre_get(&ida->idr, gfp_mask))
 880                 return 0;
 881
 882         /* allocate free_bitmap */
 883         if (!ida->free_bitmap) {
 884                 struct ida_bitmap *bitmap;
 885
 886                 bitmap = kmalloc(sizeof(struct ida_bitmap), gfp_mask);
 887                 if (!bitmap)
 888                         return 0;
 889
 890                 free_bitmap(ida, bitmap);
 891         }
 892
 893         return 1;
 894 }
 895 EXPORT_SYMBOL(ida_pre_get);
 896
 897 /**
 898  * ida_get_new_above - allocate new ID above or equal to a start id
 899  * @ida:        ida handle
 900  * @starting_id: id to start search at
 901  * @p_id:       pointer to the allocated handle
 902  *
 903  * Allocate new ID above or equal to @starting_id.  It should be called
 904  * with any required locks.
 905  *
 906  * If memory is required, it will return %-EAGAIN, you should unlock
 907  * and go back to the ida_pre_get() call.  If the ida is full, it will
 908  * return %-ENOSPC.
 909  *
 910  * @p_id returns a value in the range @starting_id ... %0x7fffffff.
 911  */
 912 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
 913 {
 914         struct idr_layer *pa[MAX_IDR_LEVEL + 1];
 915         struct ida_bitmap *bitmap;
 916         unsigned long flags;
 917         int idr_id = starting_id / IDA_BITMAP_BITS;
 918         int offset = starting_id % IDA_BITMAP_BITS;
 919         int t, id;
 920
 921  restart:
 922         /* get vacant slot */
 923         t = idr_get_empty_slot(&ida->idr, idr_id, pa, 0, &ida->idr);
 924         if (t < 0)
 925                 return t == -ENOMEM ? -EAGAIN : t;
 926
 927         if (t * IDA_BITMAP_BITS >= MAX_IDR_BIT)
 928                 return -ENOSPC;
 929
 930         if (t != idr_id)
 931                 offset = 0;
 932         idr_id = t;
 933
 934         /* if bitmap isn't there, create a new one */
 935         bitmap = (void *)pa[0]->ary[idr_id & IDR_MASK];
 936         if (!bitmap) {
 937                 spin_lock_irqsave(&ida->idr.lock, flags);
 938                 bitmap = ida->free_bitmap;
 939                 ida->free_bitmap = NULL;
 940                 spin_unlock_irqrestore(&ida->idr.lock, flags);
 941
 942                 if (!bitmap)
 943                         return -EAGAIN;
 944
 945                 memset(bitmap, 0, sizeof(struct ida_bitmap));
 946                 rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
 947                                 (void *)bitmap);
 948                 pa[0]->count++;
 949         }
 950
 951         /* lookup for empty slot */
 952         t = find_next_zero_bit(bitmap->bitmap, IDA_BITMAP_BITS, offset);
 953         if (t == IDA_BITMAP_BITS) {
 954                 /* no empty slot after offset, continue to the next chunk */
 955                 idr_id++;
 956                 offset = 0;
 957                 goto restart;
 958         }
 959
 960         id = idr_id * IDA_BITMAP_BITS + t;
 961         if (id >= MAX_IDR_BIT)
 962                 return -ENOSPC;
 963
 964         __set_bit(t, bitmap->bitmap);
 965         if (++bitmap->nr_busy == IDA_BITMAP_BITS)
 966                 idr_mark_full(pa, idr_id);
 967
 968         *p_id = id;
 969
 970         /* Each leaf node can handle nearly a thousand slots and the
 971          * whole idea of ida is to have small memory foot print.
 972          * Throw away extra resources one by one after each successful
 973          * allocation.
 974          */
 975         if (ida->idr.id_free_cnt || ida->free_bitmap) {
 976                 struct idr_layer *p = get_from_free_list(&ida->idr);
 977                 if (p)
 978                         kmem_cache_free(idr_layer_cache, p);
 979         }
 980
 981         return 0;
 982 }
 983 EXPORT_SYMBOL(ida_get_new_above);
 984
 985 /**
 986  * ida_remove - remove the given ID
 987  * @ida:        ida handle
 988  * @id:         ID to free
 989  */
 990 void ida_remove(struct ida *ida, int id)
 991 {
 992         struct idr_layer *p = ida->idr.top;
 993         int shift = (ida->idr.layers - 1) * IDR_BITS;
 994         int idr_id = id / IDA_BITMAP_BITS;
 995         int offset = id % IDA_BITMAP_BITS;
 996         int n;
 997         struct ida_bitmap *bitmap;
 998
 999         /* clear full bits while looking up the leaf idr_layer */
1000         while ((shift > 0) && p) {
1001                 n = (idr_id >> shift) & IDR_MASK;
1002                 __clear_bit(n, p->bitmap);
1003                 p = p->ary[n];
1004                 shift -= IDR_BITS;
1005         }
1006
1007         if (p == NULL)
1008                 goto err;
1009
1010         n = idr_id & IDR_MASK;
1011         __clear_bit(n, p->bitmap);
1012
1013         bitmap = (void *)p->ary[n];
1014         if (!test_bit(offset, bitmap->bitmap))
1015                 goto err;
1016
1017         /* update bitmap and remove it if empty */
1018         __clear_bit(offset, bitmap->bitmap);
1019         if (--bitmap->nr_busy == 0) {
1020                 __set_bit(n, p->bitmap);        /* to please idr_remove() */
1021                 idr_remove(&ida->idr, idr_id);
1022                 free_bitmap(ida, bitmap);
1023         }
1024
1025         return;
1026
1027  err:
1028         printk(KERN_WARNING
1029                "ida_remove called for id=%d which is not allocated.\n", id);
1030 }
1031 EXPORT_SYMBOL(ida_remove);
1032
1033 /**
1034  * ida_destroy - release all cached layers within an ida tree
1035  * @ida:                ida handle
1036  */
1037 void ida_destroy(struct ida *ida)
1038 {
1039         idr_destroy(&ida->idr);
1040         kfree(ida->free_bitmap);
1041 }
1042 EXPORT_SYMBOL(ida_destroy);
1043
1044 /**
1045  * ida_simple_get - get a new id.
1046  * @ida: the (initialized) ida.
1047  * @start: the minimum id (inclusive, < 0x8000000)
1048  * @end: the maximum id (exclusive, < 0x8000000 or 0)
1049  * @gfp_mask: memory allocation flags
1050  *
1051  * Allocates an id in the range start <= id < end, or returns -ENOSPC.
1052  * On memory allocation failure, returns -ENOMEM.
1053  *
1054  * Use ida_simple_remove() to get rid of an id.
1055  */
1056 int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
1057                    gfp_t gfp_mask)
1058 {
1059         int ret, id;
1060         unsigned int max;
1061         unsigned long flags;
1062
1063         BUG_ON((int)start < 0);
1064         BUG_ON((int)end < 0);
1065
1066         if (end == 0)
1067                 max = 0x80000000;
1068         else {
1069                 BUG_ON(end < start);
1070                 max = end - 1;
1071         }
1072
1073 again:
1074         if (!ida_pre_get(ida, gfp_mask))
1075                 return -ENOMEM;
1076
1077         spin_lock_irqsave(&simple_ida_lock, flags);
1078         ret = ida_get_new_above(ida, start, &id);
1079         if (!ret) {
1080                 if (id > max) {
1081                         ida_remove(ida, id);
1082                         ret = -ENOSPC;
1083                 } else {
1084                         ret = id;
1085                 }
1086         }
1087         spin_unlock_irqrestore(&simple_ida_lock, flags);
1088
1089         if (unlikely(ret == -EAGAIN))
1090                 goto again;
1091
1092         return ret;
1093 }
1094 EXPORT_SYMBOL(ida_simple_get);
1095
1096 /**
1097  * ida_simple_remove - remove an allocated id.
1098  * @ida: the (initialized) ida.
1099  * @id: the id returned by ida_simple_get.
1100  */
1101 void ida_simple_remove(struct ida *ida, unsigned int id)
1102 {
1103         unsigned long flags;
1104
1105         BUG_ON((int)id < 0);
1106         spin_lock_irqsave(&simple_ida_lock, flags);
1107         ida_remove(ida, id);
1108         spin_unlock_irqrestore(&simple_ida_lock, flags);
1109 }
1110 EXPORT_SYMBOL(ida_simple_remove);
1111
1112 /**
1113  * ida_init - initialize ida handle
1114  * @ida:        ida handle
1115  *
1116  * This function is use to set up the handle (@ida) that you will pass
1117  * to the rest of the functions.
1118  */
1119 void ida_init(struct ida *ida)
1120 {
1121         memset(ida, 0, sizeof(struct ida));
1122         idr_init(&ida->idr);
1123
1124 }
1125 EXPORT_SYMBOL(ida_init);