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