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