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
  39 static struct kmem_cache *idr_layer_cache;
  40 static DEFINE_SPINLOCK(simple_ida_lock);
  41
  42 static struct idr_layer *get_from_free_list(struct idr *idp)
  43 {
  44         struct idr_layer *p;
  45         unsigned long flags;
  46
  47         spin_lock_irqsave(&idp->lock, flags);
  48         if ((p = idp->id_free)) {
  49                 idp->id_free = p->ary[0];
  50                 idp->id_free_cnt--;
  51                 p->ary[0] = NULL;
  52         }
  53         spin_unlock_irqrestore(&idp->lock, flags);
  54         return(p);
  55 }
  56
  57 static void idr_layer_rcu_free(struct rcu_head *head)
  58 {
  59         struct idr_layer *layer;
  60
  61         layer = container_of(head, struct idr_layer, rcu_head);
  62         kmem_cache_free(idr_layer_cache, layer);
  63 }
  64
  65 static inline void free_layer(struct idr_layer *p)
  66 {
  67         call_rcu(&p->rcu_head, idr_layer_rcu_free);
  68 }
  69
  70 /* only called when idp->lock is held */
  71 static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
  72 {
  73         p->ary[0] = idp->id_free;
  74         idp->id_free = p;
  75         idp->id_free_cnt++;
  76 }
  77
  78 static void move_to_free_list(struct idr *idp, struct idr_layer *p)
  79 {
  80         unsigned long flags;
  81
  82         /*
  83          * Depends on the return element being zeroed.
  84          */
  85         spin_lock_irqsave(&idp->lock, flags);
  86         __move_to_free_list(idp, p);
  87         spin_unlock_irqrestore(&idp->lock, flags);
  88 }
  89
  90 static void idr_mark_full(struct idr_layer **pa, int id)
  91 {
  92         struct idr_layer *p = pa[0];
  93         int l = 0;
  94
  95         __set_bit(id & IDR_MASK, &p->bitmap);
  96         /*
  97          * If this layer is full mark the bit in the layer above to
  98          * show that this part of the radix tree is full.  This may
  99          * complete the layer above and require walking up the radix
 100          * tree.
 101          */
 102         while (p->bitmap == IDR_FULL) {
 103                 if (!(p = pa[++l]))
 104                         break;
 105                 id = id >> IDR_BITS;
 106                 __set_bit((id & IDR_MASK), &p->bitmap);
 107         }
 108 }
 109
 110 /**
 111  * idr_pre_get - reserve resources for idr allocation
 112  * @idp:        idr handle
 113  * @gfp_mask:   memory allocation flags
 114  *
 115  * This function should be called prior to calling the idr_get_new* functions.
 116  * It preallocates enough memory to satisfy the worst possible allocation. The
 117  * caller should pass in GFP_KERNEL if possible.  This of course requires that
 118  * no spinning locks be held.
 119  *
 120  * If the system is REALLY out of memory this function returns %0,
 121  * otherwise %1.
 122  */
 123 int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
 124 {
 125         while (idp->id_free_cnt < MAX_IDR_FREE) {
 126                 struct idr_layer *new;
 127                 new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
 128                 if (new == NULL)
 129                         return (0);
 130                 move_to_free_list(idp, new);
 131         }
 132         return 1;
 133 }
 134 EXPORT_SYMBOL(idr_pre_get);
 135
 136 /**
 137  * sub_alloc - try to allocate an id without growing the tree depth
 138  * @idp: idr handle
 139  * @starting_id: id to start search at
 140  * @id: pointer to the allocated handle
 141  * @pa: idr_layer[MAX_IDR_LEVEL] used as backtrack buffer
 142  *
 143  * Allocate an id in range [@starting_id, INT_MAX] from @idp without
 144  * growing its depth.  Returns
 145  *
 146  *  the allocated id >= 0 if successful,
 147  *  -EAGAIN if the tree needs to grow for allocation to succeed,
 148  *  -ENOSPC if the id space is exhausted,
 149  *  -ENOMEM if more idr_layers need to be allocated.
 150  */
 151 static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
 152 {
 153         int n, m, sh;
 154         struct idr_layer *p, *new;
 155         int l, id, oid;
 156         unsigned long bm;
 157
 158         id = *starting_id;
 159  restart:
 160         p = idp->top;
 161         l = idp->layers;
 162         pa[l--] = NULL;
 163         while (1) {
 164                 /*
 165                  * We run around this while until we reach the leaf node...
 166                  */
 167                 n = (id >> (IDR_BITS*l)) & IDR_MASK;
 168                 bm = ~p->bitmap;
 169                 m = find_next_bit(&bm, IDR_SIZE, n);
 170                 if (m == IDR_SIZE) {
 171                         /* no space available go back to previous layer. */
 172                         l++;
 173                         oid = id;
 174                         id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
 175
 176                         /* if already at the top layer, we need to grow */
 177                         if (id >= 1 << (idp->layers * IDR_BITS)) {
 178                                 *starting_id = id;
 179                                 return -EAGAIN;
 180                         }
 181                         p = pa[l];
 182                         BUG_ON(!p);
 183
 184                         /* If we need to go up one layer, continue the
 185                          * loop; otherwise, restart from the top.
 186                          */
 187                         sh = IDR_BITS * (l + 1);
 188                         if (oid >> sh == id >> sh)
 189                                 continue;
 190                         else
 191                                 goto restart;
 192                 }
 193                 if (m != n) {
 194                         sh = IDR_BITS*l;
 195                         id = ((id >> sh) ^ n ^ m) << sh;
 196                 }
 197                 if ((id >= MAX_IDR_BIT) || (id < 0))
 198                         return -ENOSPC;
 199                 if (l == 0)
 200                         break;
 201                 /*
 202                  * Create the layer below if it is missing.
 203                  */
 204                 if (!p->ary[m]) {
 205                         new = get_from_free_list(idp);
 206                         if (!new)
 207                                 return -ENOMEM;
 208                         new->layer = l-1;
 209                         rcu_assign_pointer(p->ary[m], new);
 210                         p->count++;
 211                 }
 212                 pa[l--] = p;
 213                 p = p->ary[m];
 214         }
 215
 216         pa[l] = p;
 217         return id;
 218 }
 219
 220 static int idr_get_empty_slot(struct idr *idp, int starting_id,
 221                               struct idr_layer **pa)
 222 {
 223         struct idr_layer *p, *new;
 224         int layers, v, id;
 225         unsigned long flags;
 226
 227         id = starting_id;
 228 build_up:
 229         p = idp->top;
 230         layers = idp->layers;
 231         if (unlikely(!p)) {
 232                 if (!(p = get_from_free_list(idp)))
 233                         return -ENOMEM;
 234                 p->layer = 0;
 235                 layers = 1;
 236         }
 237         /*
 238          * Add a new layer to the top of the tree if the requested
 239          * id is larger than the currently allocated space.
 240          */
 241         while ((layers < (MAX_IDR_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
 242                 layers++;
 243                 if (!p->count) {
 244                         /* special case: if the tree is currently empty,
 245                          * then we grow the tree by moving the top node
 246                          * upwards.
 247                          */
 248                         p->layer++;
 249                         continue;
 250                 }
 251                 if (!(new = get_from_free_list(idp))) {
 252                         /*
 253                          * The allocation failed.  If we built part of
 254                          * the structure tear it down.
 255                          */
 256                         spin_lock_irqsave(&idp->lock, flags);
 257                         for (new = p; p && p != idp->top; new = p) {
 258                                 p = p->ary[0];
 259                                 new->ary[0] = NULL;
 260                                 new->bitmap = new->count = 0;
 261                                 __move_to_free_list(idp, new);
 262                         }
 263                         spin_unlock_irqrestore(&idp->lock, flags);
 264                         return -ENOMEM;
 265                 }
 266                 new->ary[0] = p;
 267                 new->count = 1;
 268                 new->layer = layers-1;
 269                 if (p->bitmap == IDR_FULL)
 270                         __set_bit(0, &new->bitmap);
 271                 p = new;
 272         }
 273         rcu_assign_pointer(idp->top, p);
 274         idp->layers = layers;
 275         v = sub_alloc(idp, &id, pa);
 276         if (v == -EAGAIN)
 277                 goto build_up;
 278         return(v);
 279 }
 280
 281 /*
 282  * @id and @pa are from a successful allocation from idr_get_empty_slot().
 283  * Install the user pointer @ptr and mark the slot full.
 284  */
 285 static void idr_fill_slot(void *ptr, int id, struct idr_layer **pa)
 286 {
 287         rcu_assign_pointer(pa[0]->ary[id & IDR_MASK], (struct idr_layer *)ptr);
 288         pa[0]->count++;
 289         idr_mark_full(pa, id);
 290 }
 291
 292 /**
 293  * idr_get_new_above - allocate new idr entry above or equal to a start id
 294  * @idp: idr handle
 295  * @ptr: pointer you want associated with the id
 296  * @starting_id: id to start search at
 297  * @id: pointer to the allocated handle
 298  *
 299  * This is the allocate id function.  It should be called with any
 300  * required locks.
 301  *
 302  * If allocation from IDR's private freelist fails, idr_get_new_above() will
 303  * return %-EAGAIN.  The caller should retry the idr_pre_get() call to refill
 304  * IDR's preallocation and then retry the idr_get_new_above() call.
 305  *
 306  * If the idr is full idr_get_new_above() will return %-ENOSPC.
 307  *
 308  * @id returns a value in the range @starting_id ... %0x7fffffff
 309  */
 310 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
 311 {
 312         struct idr_layer *pa[MAX_IDR_LEVEL];
 313         int rv;
 314
 315         rv = idr_get_empty_slot(idp, starting_id, pa);
 316         if (rv < 0)
 317                 return rv == -ENOMEM ? -EAGAIN : rv;
 318
 319         idr_fill_slot(ptr, rv, pa);
 320         *id = rv;
 321         return 0;
 322 }
 323 EXPORT_SYMBOL(idr_get_new_above);
 324
 325 static void idr_remove_warning(int id)
 326 {
 327         printk(KERN_WARNING
 328                 "idr_remove called for id=%d which is not allocated.\n", id);
 329         dump_stack();
 330 }
 331
 332 static void sub_remove(struct idr *idp, int shift, int id)
 333 {
 334         struct idr_layer *p = idp->top;
 335         struct idr_layer **pa[MAX_IDR_LEVEL];
 336         struct idr_layer ***paa = &pa[0];
 337         struct idr_layer *to_free;
 338         int n;
 339
 340         *paa = NULL;
 341         *++paa = &idp->top;
 342
 343         while ((shift > 0) && p) {
 344                 n = (id >> shift) & IDR_MASK;
 345                 __clear_bit(n, &p->bitmap);
 346                 *++paa = &p->ary[n];
 347                 p = p->ary[n];
 348                 shift -= IDR_BITS;
 349         }
 350         n = id & IDR_MASK;
 351         if (likely(p != NULL && test_bit(n, &p->bitmap))){
 352                 __clear_bit(n, &p->bitmap);
 353                 rcu_assign_pointer(p->ary[n], NULL);
 354                 to_free = NULL;
 355                 while(*paa && ! --((**paa)->count)){
 356                         if (to_free)
 357                                 free_layer(to_free);
 358                         to_free = **paa;
 359                         **paa-- = NULL;
 360                 }
 361                 if (!*paa)
 362                         idp->layers = 0;
 363                 if (to_free)
 364                         free_layer(to_free);
 365         } else
 366                 idr_remove_warning(id);
 367 }
 368
 369 /**
 370  * idr_remove - remove the given id and free its slot
 371  * @idp: idr handle
 372  * @id: unique key
 373  */
 374 void idr_remove(struct idr *idp, int id)
 375 {
 376         struct idr_layer *p;
 377         struct idr_layer *to_free;
 378
 379         /* Mask off upper bits we don't use for the search. */
 380         id &= MAX_IDR_MASK;
 381
 382         sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
 383         if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
 384             idp->top->ary[0]) {
 385                 /*
 386                  * Single child at leftmost slot: we can shrink the tree.
 387                  * This level is not needed anymore since when layers are
 388                  * inserted, they are inserted at the top of the existing
 389                  * tree.
 390                  */
 391                 to_free = idp->top;
 392                 p = idp->top->ary[0];
 393                 rcu_assign_pointer(idp->top, p);
 394                 --idp->layers;
 395                 to_free->bitmap = to_free->count = 0;
 396                 free_layer(to_free);
 397         }
 398         while (idp->id_free_cnt >= MAX_IDR_FREE) {
 399                 p = get_from_free_list(idp);
 400                 /*
 401                  * Note: we don't call the rcu callback here, since the only
 402                  * layers that fall into the freelist are those that have been
 403                  * preallocated.
 404                  */
 405                 kmem_cache_free(idr_layer_cache, p);
 406         }
 407         return;
 408 }
 409 EXPORT_SYMBOL(idr_remove);
 410
 411 void __idr_remove_all(struct idr *idp)
 412 {
 413         int n, id, max;
 414         int bt_mask;
 415         struct idr_layer *p;
 416         struct idr_layer *pa[MAX_IDR_LEVEL];
 417         struct idr_layer **paa = &pa[0];
 418
 419         n = idp->layers * IDR_BITS;
 420         p = idp->top;
 421         rcu_assign_pointer(idp->top, NULL);
 422         max = 1 << n;
 423
 424         id = 0;
 425         while (id < max) {
 426                 while (n > IDR_BITS && p) {
 427                         n -= IDR_BITS;
 428                         *paa++ = p;
 429                         p = p->ary[(id >> n) & IDR_MASK];
 430                 }
 431
 432                 bt_mask = id;
 433                 id += 1 << n;
 434                 /* Get the highest bit that the above add changed from 0->1. */
 435                 while (n < fls(id ^ bt_mask)) {
 436                         if (p)
 437                                 free_layer(p);
 438                         n += IDR_BITS;
 439                         p = *--paa;
 440                 }
 441         }
 442         idp->layers = 0;
 443 }
 444 EXPORT_SYMBOL(__idr_remove_all);
 445
 446 /**
 447  * idr_destroy - release all cached layers within an idr tree
 448  * @idp: idr handle
 449  *
 450  * Free all id mappings and all idp_layers.  After this function, @idp is
 451  * completely unused and can be freed / recycled.  The caller is
 452  * responsible for ensuring that no one else accesses @idp during or after
 453  * idr_destroy().
 454  *
 455  * A typical clean-up sequence for objects stored in an idr tree will use
 456  * idr_for_each() to free all objects, if necessay, then idr_destroy() to
 457  * free up the id mappings and cached idr_layers.
 458  */
 459 void idr_destroy(struct idr *idp)
 460 {
 461         __idr_remove_all(idp);
 462
 463         while (idp->id_free_cnt) {
 464                 struct idr_layer *p = get_from_free_list(idp);
 465                 kmem_cache_free(idr_layer_cache, p);
 466         }
 467 }
 468 EXPORT_SYMBOL(idr_destroy);
 469
 470 /**
 471  * idr_find - return pointer for given id
 472  * @idp: idr handle
 473  * @id: lookup key
 474  *
 475  * Return the pointer given the id it has been registered with.  A %NULL
 476  * return indicates that @id is not valid or you passed %NULL in
 477  * idr_get_new().
 478  *
 479  * This function can be called under rcu_read_lock(), given that the leaf
 480  * pointers lifetimes are correctly managed.
 481  */
 482 void *idr_find(struct idr *idp, int id)
 483 {
 484         int n;
 485         struct idr_layer *p;
 486
 487         p = rcu_dereference_raw(idp->top);
 488         if (!p)
 489                 return NULL;
 490         n = (p->layer+1) * IDR_BITS;
 491
 492         /* Mask off upper bits we don't use for the search. */
 493         id &= MAX_IDR_MASK;
 494
 495         if (id >= (1 << n))
 496                 return NULL;
 497         BUG_ON(n == 0);
 498
 499         while (n > 0 && p) {
 500                 n -= IDR_BITS;
 501                 BUG_ON(n != p->layer*IDR_BITS);
 502                 p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 503         }
 504         return((void *)p);
 505 }
 506 EXPORT_SYMBOL(idr_find);
 507
 508 /**
 509  * idr_for_each - iterate through all stored pointers
 510  * @idp: idr handle
 511  * @fn: function to be called for each pointer
 512  * @data: data passed back to callback function
 513  *
 514  * Iterate over the pointers registered with the given idr.  The
 515  * callback function will be called for each pointer currently
 516  * registered, passing the id, the pointer and the data pointer passed
 517  * to this function.  It is not safe to modify the idr tree while in
 518  * the callback, so functions such as idr_get_new and idr_remove are
 519  * not allowed.
 520  *
 521  * We check the return of @fn each time. If it returns anything other
 522  * than %0, we break out and return that value.
 523  *
 524  * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
 525  */
 526 int idr_for_each(struct idr *idp,
 527                  int (*fn)(int id, void *p, void *data), void *data)
 528 {
 529         int n, id, max, error = 0;
 530         struct idr_layer *p;
 531         struct idr_layer *pa[MAX_IDR_LEVEL];
 532         struct idr_layer **paa = &pa[0];
 533
 534         n = idp->layers * IDR_BITS;
 535         p = rcu_dereference_raw(idp->top);
 536         max = 1 << n;
 537
 538         id = 0;
 539         while (id < max) {
 540                 while (n > 0 && p) {
 541                         n -= IDR_BITS;
 542                         *paa++ = p;
 543                         p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 544                 }
 545
 546                 if (p) {
 547                         error = fn(id, (void *)p, data);
 548                         if (error)
 549                                 break;
 550                 }
 551
 552                 id += 1 << n;
 553                 while (n < fls(id)) {
 554                         n += IDR_BITS;
 555                         p = *--paa;
 556                 }
 557         }
 558
 559         return error;
 560 }
 561 EXPORT_SYMBOL(idr_for_each);
 562
 563 /**
 564  * idr_get_next - lookup next object of id to given id.
 565  * @idp: idr handle
 566  * @nextidp:  pointer to lookup key
 567  *
 568  * Returns pointer to registered object with id, which is next number to
 569  * given id. After being looked up, *@nextidp will be updated for the next
 570  * iteration.
 571  *
 572  * This function can be called under rcu_read_lock(), given that the leaf
 573  * pointers lifetimes are correctly managed.
 574  */
 575 void *idr_get_next(struct idr *idp, int *nextidp)
 576 {
 577         struct idr_layer *p, *pa[MAX_IDR_LEVEL];
 578         struct idr_layer **paa = &pa[0];
 579         int id = *nextidp;
 580         int n, max;
 581
 582         /* find first ent */
 583         p = rcu_dereference_raw(idp->top);
 584         if (!p)
 585                 return NULL;
 586         n = (p->layer + 1) * IDR_BITS;
 587         max = 1 << n;
 588
 589         while (id < max) {
 590                 while (n > 0 && p) {
 591                         n -= IDR_BITS;
 592                         *paa++ = p;
 593                         p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
 594                 }
 595
 596                 if (p) {
 597                         *nextidp = id;
 598                         return p;
 599                 }
 600
 601                 /*
 602                  * Proceed to the next layer at the current level.  Unlike
 603                  * idr_for_each(), @id isn't guaranteed to be aligned to
 604                  * layer boundary at this point and adding 1 << n may
 605                  * incorrectly skip IDs.  Make sure we jump to the
 606                  * beginning of the next layer using round_up().
 607                  */
 608                 id = round_up(id + 1, 1 << n);
 609                 while (n < fls(id)) {
 610                         n += IDR_BITS;
 611                         p = *--paa;
 612                 }
 613         }
 614         return NULL;
 615 }
 616 EXPORT_SYMBOL(idr_get_next);
 617
 618
 619 /**
 620  * idr_replace - replace pointer for given id
 621  * @idp: idr handle
 622  * @ptr: pointer you want associated with the id
 623  * @id: lookup key
 624  *
 625  * Replace the pointer registered with an id and return the old value.
 626  * A %-ENOENT return indicates that @id was not found.
 627  * A %-EINVAL return indicates that @id was not within valid constraints.
 628  *
 629  * The caller must serialize with writers.
 630  */
 631 void *idr_replace(struct idr *idp, void *ptr, int id)
 632 {
 633         int n;
 634         struct idr_layer *p, *old_p;
 635
 636         p = idp->top;
 637         if (!p)
 638                 return ERR_PTR(-EINVAL);
 639
 640         n = (p->layer+1) * IDR_BITS;
 641
 642         id &= MAX_IDR_MASK;
 643
 644         if (id >= (1 << n))
 645                 return ERR_PTR(-EINVAL);
 646
 647         n -= IDR_BITS;
 648         while ((n > 0) && p) {
 649                 p = p->ary[(id >> n) & IDR_MASK];
 650                 n -= IDR_BITS;
 651         }
 652
 653         n = id & IDR_MASK;
 654         if (unlikely(p == NULL || !test_bit(n, &p->bitmap)))
 655                 return ERR_PTR(-ENOENT);
 656
 657         old_p = p->ary[n];
 658         rcu_assign_pointer(p->ary[n], ptr);
 659
 660         return old_p;
 661 }
 662 EXPORT_SYMBOL(idr_replace);
 663
 664 void __init idr_init_cache(void)
 665 {
 666         idr_layer_cache = kmem_cache_create("idr_layer_cache",
 667                                 sizeof(struct idr_layer), 0, SLAB_PANIC, NULL);
 668 }
 669
 670 /**
 671  * idr_init - initialize idr handle
 672  * @idp:        idr handle
 673  *
 674  * This function is use to set up the handle (@idp) that you will pass
 675  * to the rest of the functions.
 676  */
 677 void idr_init(struct idr *idp)
 678 {
 679         memset(idp, 0, sizeof(struct idr));
 680         spin_lock_init(&idp->lock);
 681 }
 682 EXPORT_SYMBOL(idr_init);
 683
 684
 685 /**
 686  * DOC: IDA description
 687  * IDA - IDR based ID allocator
 688  *
 689  * This is id allocator without id -> pointer translation.  Memory
 690  * usage is much lower than full blown idr because each id only
 691  * occupies a bit.  ida uses a custom leaf node which contains
 692  * IDA_BITMAP_BITS slots.
 693  *
 694  * 2007-04-25  written by Tejun Heo <htejun@gmail.com>
 695  */
 696
 697 static void free_bitmap(struct ida *ida, struct ida_bitmap *bitmap)
 698 {
 699         unsigned long flags;
 700
 701         if (!ida->free_bitmap) {
 702                 spin_lock_irqsave(&ida->idr.lock, flags);
 703                 if (!ida->free_bitmap) {
 704                         ida->free_bitmap = bitmap;
 705                         bitmap = NULL;
 706                 }
 707                 spin_unlock_irqrestore(&ida->idr.lock, flags);
 708         }
 709
 710         kfree(bitmap);
 711 }
 712
 713 /**
 714  * ida_pre_get - reserve resources for ida allocation
 715  * @ida:        ida handle
 716  * @gfp_mask:   memory allocation flag
 717  *
 718  * This function should be called prior to locking and calling the
 719  * following function.  It preallocates enough memory to satisfy the
 720  * worst possible allocation.
 721  *
 722  * If the system is REALLY out of memory this function returns %0,
 723  * otherwise %1.
 724  */
 725 int ida_pre_get(struct ida *ida, gfp_t gfp_mask)
 726 {
 727         /* allocate idr_layers */
 728         if (!idr_pre_get(&ida->idr, gfp_mask))
 729                 return 0;
 730
 731         /* allocate free_bitmap */
 732         if (!ida->free_bitmap) {
 733                 struct ida_bitmap *bitmap;
 734
 735                 bitmap = kmalloc(sizeof(struct ida_bitmap), gfp_mask);
 736                 if (!bitmap)
 737                         return 0;
 738
 739                 free_bitmap(ida, bitmap);
 740         }
 741
 742         return 1;
 743 }
 744 EXPORT_SYMBOL(ida_pre_get);
 745
 746 /**
 747  * ida_get_new_above - allocate new ID above or equal to a start id
 748  * @ida:        ida handle
 749  * @starting_id: id to start search at
 750  * @p_id:       pointer to the allocated handle
 751  *
 752  * Allocate new ID above or equal to @starting_id.  It should be called
 753  * with any required locks.
 754  *
 755  * If memory is required, it will return %-EAGAIN, you should unlock
 756  * and go back to the ida_pre_get() call.  If the ida is full, it will
 757  * return %-ENOSPC.
 758  *
 759  * @p_id returns a value in the range @starting_id ... %0x7fffffff.
 760  */
 761 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
 762 {
 763         struct idr_layer *pa[MAX_IDR_LEVEL];
 764         struct ida_bitmap *bitmap;
 765         unsigned long flags;
 766         int idr_id = starting_id / IDA_BITMAP_BITS;
 767         int offset = starting_id % IDA_BITMAP_BITS;
 768         int t, id;
 769
 770  restart:
 771         /* get vacant slot */
 772         t = idr_get_empty_slot(&ida->idr, idr_id, pa);
 773         if (t < 0)
 774                 return t == -ENOMEM ? -EAGAIN : t;
 775
 776         if (t * IDA_BITMAP_BITS >= MAX_IDR_BIT)
 777                 return -ENOSPC;
 778
 779         if (t != idr_id)
 780                 offset = 0;
 781         idr_id = t;
 782
 783         /* if bitmap isn't there, create a new one */
 784         bitmap = (void *)pa[0]->ary[idr_id & IDR_MASK];
 785         if (!bitmap) {
 786                 spin_lock_irqsave(&ida->idr.lock, flags);
 787                 bitmap = ida->free_bitmap;
 788                 ida->free_bitmap = NULL;
 789                 spin_unlock_irqrestore(&ida->idr.lock, flags);
 790
 791                 if (!bitmap)
 792                         return -EAGAIN;
 793
 794                 memset(bitmap, 0, sizeof(struct ida_bitmap));
 795                 rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
 796                                 (void *)bitmap);
 797                 pa[0]->count++;
 798         }
 799
 800         /* lookup for empty slot */
 801         t = find_next_zero_bit(bitmap->bitmap, IDA_BITMAP_BITS, offset);
 802         if (t == IDA_BITMAP_BITS) {
 803                 /* no empty slot after offset, continue to the next chunk */
 804                 idr_id++;
 805                 offset = 0;
 806                 goto restart;
 807         }
 808
 809         id = idr_id * IDA_BITMAP_BITS + t;
 810         if (id >= MAX_IDR_BIT)
 811                 return -ENOSPC;
 812
 813         __set_bit(t, bitmap->bitmap);
 814         if (++bitmap->nr_busy == IDA_BITMAP_BITS)
 815                 idr_mark_full(pa, idr_id);
 816
 817         *p_id = id;
 818
 819         /* Each leaf node can handle nearly a thousand slots and the
 820          * whole idea of ida is to have small memory foot print.
 821          * Throw away extra resources one by one after each successful
 822          * allocation.
 823          */
 824         if (ida->idr.id_free_cnt || ida->free_bitmap) {
 825                 struct idr_layer *p = get_from_free_list(&ida->idr);
 826                 if (p)
 827                         kmem_cache_free(idr_layer_cache, p);
 828         }
 829
 830         return 0;
 831 }
 832 EXPORT_SYMBOL(ida_get_new_above);
 833
 834 /**
 835  * ida_remove - remove the given ID
 836  * @ida:        ida handle
 837  * @id:         ID to free
 838  */
 839 void ida_remove(struct ida *ida, int id)
 840 {
 841         struct idr_layer *p = ida->idr.top;
 842         int shift = (ida->idr.layers - 1) * IDR_BITS;
 843         int idr_id = id / IDA_BITMAP_BITS;
 844         int offset = id % IDA_BITMAP_BITS;
 845         int n;
 846         struct ida_bitmap *bitmap;
 847
 848         /* clear full bits while looking up the leaf idr_layer */
 849         while ((shift > 0) && p) {
 850                 n = (idr_id >> shift) & IDR_MASK;
 851                 __clear_bit(n, &p->bitmap);
 852                 p = p->ary[n];
 853                 shift -= IDR_BITS;
 854         }
 855
 856         if (p == NULL)
 857                 goto err;
 858
 859         n = idr_id & IDR_MASK;
 860         __clear_bit(n, &p->bitmap);
 861
 862         bitmap = (void *)p->ary[n];
 863         if (!test_bit(offset, bitmap->bitmap))
 864                 goto err;
 865
 866         /* update bitmap and remove it if empty */
 867         __clear_bit(offset, bitmap->bitmap);
 868         if (--bitmap->nr_busy == 0) {
 869                 __set_bit(n, &p->bitmap);       /* to please idr_remove() */
 870                 idr_remove(&ida->idr, idr_id);
 871                 free_bitmap(ida, bitmap);
 872         }
 873
 874         return;
 875
 876  err:
 877         printk(KERN_WARNING
 878                "ida_remove called for id=%d which is not allocated.\n", id);
 879 }
 880 EXPORT_SYMBOL(ida_remove);
 881
 882 /**
 883  * ida_destroy - release all cached layers within an ida tree
 884  * @ida:                ida handle
 885  */
 886 void ida_destroy(struct ida *ida)
 887 {
 888         idr_destroy(&ida->idr);
 889         kfree(ida->free_bitmap);
 890 }
 891 EXPORT_SYMBOL(ida_destroy);
 892
 893 /**
 894  * ida_simple_get - get a new id.
 895  * @ida: the (initialized) ida.
 896  * @start: the minimum id (inclusive, < 0x8000000)
 897  * @end: the maximum id (exclusive, < 0x8000000 or 0)
 898  * @gfp_mask: memory allocation flags
 899  *
 900  * Allocates an id in the range start <= id < end, or returns -ENOSPC.
 901  * On memory allocation failure, returns -ENOMEM.
 902  *
 903  * Use ida_simple_remove() to get rid of an id.
 904  */
 905 int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
 906                    gfp_t gfp_mask)
 907 {
 908         int ret, id;
 909         unsigned int max;
 910         unsigned long flags;
 911
 912         BUG_ON((int)start < 0);
 913         BUG_ON((int)end < 0);
 914
 915         if (end == 0)
 916                 max = 0x80000000;
 917         else {
 918                 BUG_ON(end < start);
 919                 max = end - 1;
 920         }
 921
 922 again:
 923         if (!ida_pre_get(ida, gfp_mask))
 924                 return -ENOMEM;
 925
 926         spin_lock_irqsave(&simple_ida_lock, flags);
 927         ret = ida_get_new_above(ida, start, &id);
 928         if (!ret) {
 929                 if (id > max) {
 930                         ida_remove(ida, id);
 931                         ret = -ENOSPC;
 932                 } else {
 933                         ret = id;
 934                 }
 935         }
 936         spin_unlock_irqrestore(&simple_ida_lock, flags);
 937
 938         if (unlikely(ret == -EAGAIN))
 939                 goto again;
 940
 941         return ret;
 942 }
 943 EXPORT_SYMBOL(ida_simple_get);
 944
 945 /**
 946  * ida_simple_remove - remove an allocated id.
 947  * @ida: the (initialized) ida.
 948  * @id: the id returned by ida_simple_get.
 949  */
 950 void ida_simple_remove(struct ida *ida, unsigned int id)
 951 {
 952         unsigned long flags;
 953
 954         BUG_ON((int)id < 0);
 955         spin_lock_irqsave(&simple_ida_lock, flags);
 956         ida_remove(ida, id);
 957         spin_unlock_irqrestore(&simple_ida_lock, flags);
 958 }
 959 EXPORT_SYMBOL(ida_simple_remove);
 960
 961 /**
 962  * ida_init - initialize ida handle
 963  * @ida:        ida handle
 964  *
 965  * This function is use to set up the handle (@ida) that you will pass
 966  * to the rest of the functions.
 967  */
 968 void ida_init(struct ida *ida)
 969 {
 970         memset(ida, 0, sizeof(struct ida));
 971         idr_init(&ida->idr);
 972
 973 }
 974 EXPORT_SYMBOL(ida_init);