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.
6 * Modified by George Anzinger to reuse immediately and to use
7 * find bit instructions. Also removed _irq on spinlocks.
9 * Small id to pointer translation service.
11 * It uses a radix tree like structure as a sparse array indexed
12 * by the id to obtain the pointer. The bitmap makes allocating
15 * You call it to allocate an id (an int) an associate with that id a
16 * pointer or what ever, we treat it as a (void *). You can pass this
17 * id to a user for him to pass back at a later time. You then pass
18 * that id to this code and it returns your pointer.
20 * You can release ids at any time. When all ids are released, most of
21 * the memory is returned (we keep IDR_FREE_MAX) in a local pool so we
22 * don't need to go to the memory "store" during an id allocate, just
23 * so you don't need to be too concerned about locking and conflicts
24 * with the slab allocator.
27 #ifndef TEST // to test in user space...
28 #include <linux/slab.h>
29 #include <linux/init.h>
30 #include <linux/module.h>
32 #include <linux/err.h>
33 #include <linux/string.h>
34 #include <linux/idr.h>
36 static struct kmem_cache *idr_layer_cache;
38 static struct idr_layer *get_from_free_list(struct idr *idp)
43 spin_lock_irqsave(&idp->lock, flags);
44 if ((p = idp->id_free)) {
45 idp->id_free = p->ary[0];
49 spin_unlock_irqrestore(&idp->lock, flags);
53 /* only called when idp->lock is held */
54 static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
56 p->ary[0] = idp->id_free;
61 static void move_to_free_list(struct idr *idp, struct idr_layer *p)
66 * Depends on the return element being zeroed.
68 spin_lock_irqsave(&idp->lock, flags);
69 __move_to_free_list(idp, p);
70 spin_unlock_irqrestore(&idp->lock, flags);
73 static void idr_mark_full(struct idr_layer **pa, int id)
75 struct idr_layer *p = pa[0];
78 __set_bit(id & IDR_MASK, &p->bitmap);
80 * If this layer is full mark the bit in the layer above to
81 * show that this part of the radix tree is full. This may
82 * complete the layer above and require walking up the radix
85 while (p->bitmap == IDR_FULL) {
89 __set_bit((id & IDR_MASK), &p->bitmap);
94 * idr_pre_get - reserver resources for idr allocation
96 * @gfp_mask: memory allocation flags
98 * This function should be called prior to locking and calling the
99 * following function. It preallocates enough memory to satisfy
100 * the worst possible allocation.
102 * If the system is REALLY out of memory this function returns 0,
105 int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
107 while (idp->id_free_cnt < IDR_FREE_MAX) {
108 struct idr_layer *new;
109 new = kmem_cache_alloc(idr_layer_cache, gfp_mask);
112 move_to_free_list(idp, new);
116 EXPORT_SYMBOL(idr_pre_get);
118 static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
121 struct idr_layer *p, *new;
132 * We run around this while until we reach the leaf node...
134 n = (id >> (IDR_BITS*l)) & IDR_MASK;
136 m = find_next_bit(&bm, IDR_SIZE, n);
138 /* no space available go back to previous layer. */
141 id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
143 /* if already at the top layer, we need to grow */
149 /* If we need to go up one layer, continue the
150 * loop; otherwise, restart from the top.
152 sh = IDR_BITS * (l + 1);
153 if (oid >> sh == id >> sh)
160 id = ((id >> sh) ^ n ^ m) << sh;
162 if ((id >= MAX_ID_BIT) || (id < 0))
167 * Create the layer below if it is missing.
170 new = get_from_free_list(idp);
184 static int idr_get_empty_slot(struct idr *idp, int starting_id,
185 struct idr_layer **pa)
187 struct idr_layer *p, *new;
194 layers = idp->layers;
196 if (!(p = get_from_free_list(idp)))
201 * Add a new layer to the top of the tree if the requested
202 * id is larger than the currently allocated space.
204 while ((layers < (MAX_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
208 if (!(new = get_from_free_list(idp))) {
210 * The allocation failed. If we built part of
211 * the structure tear it down.
213 spin_lock_irqsave(&idp->lock, flags);
214 for (new = p; p && p != idp->top; new = p) {
217 new->bitmap = new->count = 0;
218 __move_to_free_list(idp, new);
220 spin_unlock_irqrestore(&idp->lock, flags);
225 if (p->bitmap == IDR_FULL)
226 __set_bit(0, &new->bitmap);
230 idp->layers = layers;
231 v = sub_alloc(idp, &id, pa);
237 static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
239 struct idr_layer *pa[MAX_LEVEL];
242 id = idr_get_empty_slot(idp, starting_id, pa);
245 * Successfully found an empty slot. Install the user
246 * pointer and mark the slot full.
248 pa[0]->ary[id & IDR_MASK] = (struct idr_layer *)ptr;
250 idr_mark_full(pa, id);
257 * idr_get_new_above - allocate new idr entry above or equal to a start id
259 * @ptr: pointer you want associated with the ide
260 * @start_id: id to start search at
261 * @id: pointer to the allocated handle
263 * This is the allocate id function. It should be called with any
266 * If memory is required, it will return -EAGAIN, you should unlock
267 * and go back to the idr_pre_get() call. If the idr is full, it will
270 * @id returns a value in the range 0 ... 0x7fffffff
272 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
276 rv = idr_get_new_above_int(idp, ptr, starting_id);
278 * This is a cheap hack until the IDR code can be fixed to
279 * return proper error values.
284 else /* Will be -3 */
290 EXPORT_SYMBOL(idr_get_new_above);
293 * idr_get_new - allocate new idr entry
295 * @ptr: pointer you want associated with the ide
296 * @id: pointer to the allocated handle
298 * This is the allocate id function. It should be called with any
301 * If memory is required, it will return -EAGAIN, you should unlock
302 * and go back to the idr_pre_get() call. If the idr is full, it will
305 * @id returns a value in the range 0 ... 0x7fffffff
307 int idr_get_new(struct idr *idp, void *ptr, int *id)
311 rv = idr_get_new_above_int(idp, ptr, 0);
313 * This is a cheap hack until the IDR code can be fixed to
314 * return proper error values.
319 else /* Will be -3 */
325 EXPORT_SYMBOL(idr_get_new);
327 static void idr_remove_warning(int id)
330 "idr_remove called for id=%d which is not allocated.\n", id);
334 static void sub_remove(struct idr *idp, int shift, int id)
336 struct idr_layer *p = idp->top;
337 struct idr_layer **pa[MAX_LEVEL];
338 struct idr_layer ***paa = &pa[0];
344 while ((shift > 0) && p) {
345 n = (id >> shift) & IDR_MASK;
346 __clear_bit(n, &p->bitmap);
352 if (likely(p != NULL && test_bit(n, &p->bitmap))){
353 __clear_bit(n, &p->bitmap);
355 while(*paa && ! --((**paa)->count)){
356 move_to_free_list(idp, **paa);
362 idr_remove_warning(id);
366 * idr_remove - remove the given id and free it's slot
370 void idr_remove(struct idr *idp, int id)
374 /* Mask off upper bits we don't use for the search. */
377 sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
378 if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
379 idp->top->ary[0]) { // We can drop a layer
381 p = idp->top->ary[0];
382 idp->top->bitmap = idp->top->count = 0;
383 move_to_free_list(idp, idp->top);
387 while (idp->id_free_cnt >= IDR_FREE_MAX) {
388 p = get_from_free_list(idp);
389 kmem_cache_free(idr_layer_cache, p);
393 EXPORT_SYMBOL(idr_remove);
396 * idr_remove_all - remove all ids from the given idr tree
399 * idr_destroy() only frees up unused, cached idp_layers, but this
400 * function will remove all id mappings and leave all idp_layers
403 * A typical clean-up sequence for objects stored in an idr tree, will
404 * use idr_for_each() to free all objects, if necessay, then
405 * idr_remove_all() to remove all ids, and idr_destroy() to free
406 * up the cached idr_layers.
408 void idr_remove_all(struct idr *idp)
412 struct idr_layer *pa[MAX_LEVEL];
413 struct idr_layer **paa = &pa[0];
415 n = idp->layers * IDR_BITS;
421 while (n > IDR_BITS && p) {
424 p = p->ary[(id >> n) & IDR_MASK];
428 while (n < fls(id)) {
430 memset(p, 0, sizeof *p);
431 move_to_free_list(idp, p);
440 EXPORT_SYMBOL(idr_remove_all);
443 * idr_destroy - release all cached layers within an idr tree
446 void idr_destroy(struct idr *idp)
448 while (idp->id_free_cnt) {
449 struct idr_layer *p = get_from_free_list(idp);
450 kmem_cache_free(idr_layer_cache, p);
453 EXPORT_SYMBOL(idr_destroy);
456 * idr_find - return pointer for given id
460 * Return the pointer given the id it has been registered with. A %NULL
461 * return indicates that @id is not valid or you passed %NULL in
464 * The caller must serialize idr_find() vs idr_get_new() and idr_remove().
466 void *idr_find(struct idr *idp, int id)
471 n = idp->layers * IDR_BITS;
474 /* Mask off upper bits we don't use for the search. */
482 p = p->ary[(id >> n) & IDR_MASK];
486 EXPORT_SYMBOL(idr_find);
489 * idr_for_each - iterate through all stored pointers
491 * @fn: function to be called for each pointer
492 * @data: data passed back to callback function
494 * Iterate over the pointers registered with the given idr. The
495 * callback function will be called for each pointer currently
496 * registered, passing the id, the pointer and the data pointer passed
497 * to this function. It is not safe to modify the idr tree while in
498 * the callback, so functions such as idr_get_new and idr_remove are
501 * We check the return of @fn each time. If it returns anything other
502 * than 0, we break out and return that value.
504 * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
506 int idr_for_each(struct idr *idp,
507 int (*fn)(int id, void *p, void *data), void *data)
509 int n, id, max, error = 0;
511 struct idr_layer *pa[MAX_LEVEL];
512 struct idr_layer **paa = &pa[0];
514 n = idp->layers * IDR_BITS;
523 p = p->ary[(id >> n) & IDR_MASK];
527 error = fn(id, (void *)p, data);
533 while (n < fls(id)) {
541 EXPORT_SYMBOL(idr_for_each);
544 * idr_replace - replace pointer for given id
546 * @ptr: pointer you want associated with the id
549 * Replace the pointer registered with an id and return the old value.
550 * A -ENOENT return indicates that @id was not found.
551 * A -EINVAL return indicates that @id was not within valid constraints.
553 * The caller must serialize vs idr_find(), idr_get_new(), and idr_remove().
555 void *idr_replace(struct idr *idp, void *ptr, int id)
558 struct idr_layer *p, *old_p;
560 n = idp->layers * IDR_BITS;
566 return ERR_PTR(-EINVAL);
569 while ((n > 0) && p) {
570 p = p->ary[(id >> n) & IDR_MASK];
575 if (unlikely(p == NULL || !test_bit(n, &p->bitmap)))
576 return ERR_PTR(-ENOENT);
583 EXPORT_SYMBOL(idr_replace);
585 static void idr_cache_ctor(struct kmem_cache *idr_layer_cache, void *idr_layer)
587 memset(idr_layer, 0, sizeof(struct idr_layer));
590 void __init idr_init_cache(void)
592 idr_layer_cache = kmem_cache_create("idr_layer_cache",
593 sizeof(struct idr_layer), 0, SLAB_PANIC,
598 * idr_init - initialize idr handle
601 * This function is use to set up the handle (@idp) that you will pass
602 * to the rest of the functions.
604 void idr_init(struct idr *idp)
606 memset(idp, 0, sizeof(struct idr));
607 spin_lock_init(&idp->lock);
609 EXPORT_SYMBOL(idr_init);
613 * IDA - IDR based ID allocator
615 * this is id allocator without id -> pointer translation. Memory
616 * usage is much lower than full blown idr because each id only
617 * occupies a bit. ida uses a custom leaf node which contains
618 * IDA_BITMAP_BITS slots.
620 * 2007-04-25 written by Tejun Heo <htejun@gmail.com>
623 static void free_bitmap(struct ida *ida, struct ida_bitmap *bitmap)
627 if (!ida->free_bitmap) {
628 spin_lock_irqsave(&ida->idr.lock, flags);
629 if (!ida->free_bitmap) {
630 ida->free_bitmap = bitmap;
633 spin_unlock_irqrestore(&ida->idr.lock, flags);
640 * ida_pre_get - reserve resources for ida allocation
642 * @gfp_mask: memory allocation flag
644 * This function should be called prior to locking and calling the
645 * following function. It preallocates enough memory to satisfy the
646 * worst possible allocation.
648 * If the system is REALLY out of memory this function returns 0,
651 int ida_pre_get(struct ida *ida, gfp_t gfp_mask)
653 /* allocate idr_layers */
654 if (!idr_pre_get(&ida->idr, gfp_mask))
657 /* allocate free_bitmap */
658 if (!ida->free_bitmap) {
659 struct ida_bitmap *bitmap;
661 bitmap = kmalloc(sizeof(struct ida_bitmap), gfp_mask);
665 free_bitmap(ida, bitmap);
670 EXPORT_SYMBOL(ida_pre_get);
673 * ida_get_new_above - allocate new ID above or equal to a start id
675 * @staring_id: id to start search at
676 * @p_id: pointer to the allocated handle
678 * Allocate new ID above or equal to @ida. It should be called with
679 * any required locks.
681 * If memory is required, it will return -EAGAIN, you should unlock
682 * and go back to the ida_pre_get() call. If the ida is full, it will
685 * @p_id returns a value in the range 0 ... 0x7fffffff.
687 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
689 struct idr_layer *pa[MAX_LEVEL];
690 struct ida_bitmap *bitmap;
692 int idr_id = starting_id / IDA_BITMAP_BITS;
693 int offset = starting_id % IDA_BITMAP_BITS;
697 /* get vacant slot */
698 t = idr_get_empty_slot(&ida->idr, idr_id, pa);
702 else /* will be -3 */
706 if (t * IDA_BITMAP_BITS >= MAX_ID_BIT)
713 /* if bitmap isn't there, create a new one */
714 bitmap = (void *)pa[0]->ary[idr_id & IDR_MASK];
716 spin_lock_irqsave(&ida->idr.lock, flags);
717 bitmap = ida->free_bitmap;
718 ida->free_bitmap = NULL;
719 spin_unlock_irqrestore(&ida->idr.lock, flags);
724 memset(bitmap, 0, sizeof(struct ida_bitmap));
725 pa[0]->ary[idr_id & IDR_MASK] = (void *)bitmap;
729 /* lookup for empty slot */
730 t = find_next_zero_bit(bitmap->bitmap, IDA_BITMAP_BITS, offset);
731 if (t == IDA_BITMAP_BITS) {
732 /* no empty slot after offset, continue to the next chunk */
738 id = idr_id * IDA_BITMAP_BITS + t;
739 if (id >= MAX_ID_BIT)
742 __set_bit(t, bitmap->bitmap);
743 if (++bitmap->nr_busy == IDA_BITMAP_BITS)
744 idr_mark_full(pa, idr_id);
748 /* Each leaf node can handle nearly a thousand slots and the
749 * whole idea of ida is to have small memory foot print.
750 * Throw away extra resources one by one after each successful
753 if (ida->idr.id_free_cnt || ida->free_bitmap) {
754 struct idr_layer *p = get_from_free_list(&ida->idr);
756 kmem_cache_free(idr_layer_cache, p);
761 EXPORT_SYMBOL(ida_get_new_above);
764 * ida_get_new - allocate new ID
766 * @p_id: pointer to the allocated handle
768 * Allocate new ID. It should be called with any required locks.
770 * If memory is required, it will return -EAGAIN, you should unlock
771 * and go back to the idr_pre_get() call. If the idr is full, it will
774 * @id returns a value in the range 0 ... 0x7fffffff.
776 int ida_get_new(struct ida *ida, int *p_id)
778 return ida_get_new_above(ida, 0, p_id);
780 EXPORT_SYMBOL(ida_get_new);
783 * ida_remove - remove the given ID
787 void ida_remove(struct ida *ida, int id)
789 struct idr_layer *p = ida->idr.top;
790 int shift = (ida->idr.layers - 1) * IDR_BITS;
791 int idr_id = id / IDA_BITMAP_BITS;
792 int offset = id % IDA_BITMAP_BITS;
794 struct ida_bitmap *bitmap;
796 /* clear full bits while looking up the leaf idr_layer */
797 while ((shift > 0) && p) {
798 n = (idr_id >> shift) & IDR_MASK;
799 __clear_bit(n, &p->bitmap);
807 n = idr_id & IDR_MASK;
808 __clear_bit(n, &p->bitmap);
810 bitmap = (void *)p->ary[n];
811 if (!test_bit(offset, bitmap->bitmap))
814 /* update bitmap and remove it if empty */
815 __clear_bit(offset, bitmap->bitmap);
816 if (--bitmap->nr_busy == 0) {
817 __set_bit(n, &p->bitmap); /* to please idr_remove() */
818 idr_remove(&ida->idr, idr_id);
819 free_bitmap(ida, bitmap);
826 "ida_remove called for id=%d which is not allocated.\n", id);
828 EXPORT_SYMBOL(ida_remove);
831 * ida_destroy - release all cached layers within an ida tree
834 void ida_destroy(struct ida *ida)
836 idr_destroy(&ida->idr);
837 kfree(ida->free_bitmap);
839 EXPORT_SYMBOL(ida_destroy);
842 * ida_init - initialize ida handle
845 * This function is use to set up the handle (@ida) that you will pass
846 * to the rest of the functions.
848 void ida_init(struct ida *ida)
850 memset(ida, 0, sizeof(struct ida));
854 EXPORT_SYMBOL(ida_init);