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 * Modified by Nadia Derbey to make it RCU safe.
11 * Small id to pointer translation service.
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
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.
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.
29 #ifndef TEST // to test in user space...
30 #include <linux/slab.h>
31 #include <linux/init.h>
32 #include <linux/module.h>
34 #include <linux/err.h>
35 #include <linux/string.h>
36 #include <linux/idr.h>
38 static struct kmem_cache *idr_layer_cache;
40 static struct idr_layer *get_from_free_list(struct idr *idp)
45 spin_lock_irqsave(&idp->lock, flags);
46 if ((p = idp->id_free)) {
47 idp->id_free = p->ary[0];
51 spin_unlock_irqrestore(&idp->lock, flags);
55 static void idr_layer_rcu_free(struct rcu_head *head)
57 struct idr_layer *layer;
59 layer = container_of(head, struct idr_layer, rcu_head);
60 kmem_cache_free(idr_layer_cache, layer);
63 static inline void free_layer(struct idr_layer *p)
65 call_rcu(&p->rcu_head, idr_layer_rcu_free);
68 /* only called when idp->lock is held */
69 static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
71 p->ary[0] = idp->id_free;
76 static void move_to_free_list(struct idr *idp, struct idr_layer *p)
81 * Depends on the return element being zeroed.
83 spin_lock_irqsave(&idp->lock, flags);
84 __move_to_free_list(idp, p);
85 spin_unlock_irqrestore(&idp->lock, flags);
88 static void idr_mark_full(struct idr_layer **pa, int id)
90 struct idr_layer *p = pa[0];
93 __set_bit(id & IDR_MASK, &p->bitmap);
95 * If this layer is full mark the bit in the layer above to
96 * show that this part of the radix tree is full. This may
97 * complete the layer above and require walking up the radix
100 while (p->bitmap == IDR_FULL) {
104 __set_bit((id & IDR_MASK), &p->bitmap);
109 * idr_pre_get - reserver resources for idr allocation
111 * @gfp_mask: memory allocation flags
113 * This function should be called prior to locking and calling the
114 * idr_get_new* functions. It preallocates enough memory to satisfy
115 * the worst possible allocation.
117 * If the system is REALLY out of memory this function returns 0,
120 int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
122 while (idp->id_free_cnt < IDR_FREE_MAX) {
123 struct idr_layer *new;
124 new = kmem_cache_alloc(idr_layer_cache, gfp_mask);
127 move_to_free_list(idp, new);
131 EXPORT_SYMBOL(idr_pre_get);
133 static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
136 struct idr_layer *p, *new;
147 * We run around this while until we reach the leaf node...
149 n = (id >> (IDR_BITS*l)) & IDR_MASK;
151 m = find_next_bit(&bm, IDR_SIZE, n);
153 /* no space available go back to previous layer. */
156 id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
158 /* if already at the top layer, we need to grow */
161 return IDR_NEED_TO_GROW;
164 /* If we need to go up one layer, continue the
165 * loop; otherwise, restart from the top.
167 sh = IDR_BITS * (l + 1);
168 if (oid >> sh == id >> sh)
175 id = ((id >> sh) ^ n ^ m) << sh;
177 if ((id >= MAX_ID_BIT) || (id < 0))
178 return IDR_NOMORE_SPACE;
182 * Create the layer below if it is missing.
185 new = get_from_free_list(idp);
188 rcu_assign_pointer(p->ary[m], new);
199 static int idr_get_empty_slot(struct idr *idp, int starting_id,
200 struct idr_layer **pa)
202 struct idr_layer *p, *new;
209 layers = idp->layers;
211 if (!(p = get_from_free_list(idp)))
216 * Add a new layer to the top of the tree if the requested
217 * id is larger than the currently allocated space.
219 while ((layers < (MAX_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
223 if (!(new = get_from_free_list(idp))) {
225 * The allocation failed. If we built part of
226 * the structure tear it down.
228 spin_lock_irqsave(&idp->lock, flags);
229 for (new = p; p && p != idp->top; new = p) {
232 new->bitmap = new->count = 0;
233 __move_to_free_list(idp, new);
235 spin_unlock_irqrestore(&idp->lock, flags);
240 if (p->bitmap == IDR_FULL)
241 __set_bit(0, &new->bitmap);
244 rcu_assign_pointer(idp->top, p);
245 idp->layers = layers;
246 v = sub_alloc(idp, &id, pa);
247 if (v == IDR_NEED_TO_GROW)
252 static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
254 struct idr_layer *pa[MAX_LEVEL];
257 id = idr_get_empty_slot(idp, starting_id, pa);
260 * Successfully found an empty slot. Install the user
261 * pointer and mark the slot full.
263 rcu_assign_pointer(pa[0]->ary[id & IDR_MASK],
264 (struct idr_layer *)ptr);
266 idr_mark_full(pa, id);
273 * idr_get_new_above - allocate new idr entry above or equal to a start id
275 * @ptr: pointer you want associated with the ide
276 * @start_id: id to start search at
277 * @id: pointer to the allocated handle
279 * This is the allocate id function. It should be called with any
282 * If memory is required, it will return -EAGAIN, you should unlock
283 * and go back to the idr_pre_get() call. If the idr is full, it will
286 * @id returns a value in the range 0 ... 0x7fffffff
288 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
292 rv = idr_get_new_above_int(idp, ptr, starting_id);
294 * This is a cheap hack until the IDR code can be fixed to
295 * return proper error values.
298 return _idr_rc_to_errno(rv);
302 EXPORT_SYMBOL(idr_get_new_above);
305 * idr_get_new - allocate new idr entry
307 * @ptr: pointer you want associated with the ide
308 * @id: pointer to the allocated handle
310 * This is the allocate id function. It should be called with any
313 * If memory is required, it will return -EAGAIN, you should unlock
314 * and go back to the idr_pre_get() call. If the idr is full, it will
317 * @id returns a value in the range 0 ... 0x7fffffff
319 int idr_get_new(struct idr *idp, void *ptr, int *id)
323 rv = idr_get_new_above_int(idp, ptr, 0);
325 * This is a cheap hack until the IDR code can be fixed to
326 * return proper error values.
329 return _idr_rc_to_errno(rv);
333 EXPORT_SYMBOL(idr_get_new);
335 static void idr_remove_warning(int id)
338 "idr_remove called for id=%d which is not allocated.\n", id);
342 static void sub_remove(struct idr *idp, int shift, int id)
344 struct idr_layer *p = idp->top;
345 struct idr_layer **pa[MAX_LEVEL];
346 struct idr_layer ***paa = &pa[0];
347 struct idr_layer *to_free;
353 while ((shift > 0) && p) {
354 n = (id >> shift) & IDR_MASK;
355 __clear_bit(n, &p->bitmap);
361 if (likely(p != NULL && test_bit(n, &p->bitmap))){
362 __clear_bit(n, &p->bitmap);
363 rcu_assign_pointer(p->ary[n], NULL);
365 while(*paa && ! --((**paa)->count)){
376 idr_remove_warning(id);
380 * idr_remove - remove the given id and free it's slot
384 void idr_remove(struct idr *idp, int id)
387 struct idr_layer *to_free;
389 /* Mask off upper bits we don't use for the search. */
392 sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
393 if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
396 * Single child at leftmost slot: we can shrink the tree.
397 * This level is not needed anymore since when layers are
398 * inserted, they are inserted at the top of the existing
402 p = idp->top->ary[0];
403 rcu_assign_pointer(idp->top, p);
405 to_free->bitmap = to_free->count = 0;
408 while (idp->id_free_cnt >= IDR_FREE_MAX) {
409 p = get_from_free_list(idp);
411 * Note: we don't call the rcu callback here, since the only
412 * layers that fall into the freelist are those that have been
415 kmem_cache_free(idr_layer_cache, p);
419 EXPORT_SYMBOL(idr_remove);
422 * idr_remove_all - remove all ids from the given idr tree
425 * idr_destroy() only frees up unused, cached idp_layers, but this
426 * function will remove all id mappings and leave all idp_layers
429 * A typical clean-up sequence for objects stored in an idr tree, will
430 * use idr_for_each() to free all objects, if necessay, then
431 * idr_remove_all() to remove all ids, and idr_destroy() to free
432 * up the cached idr_layers.
434 void idr_remove_all(struct idr *idp)
438 struct idr_layer *pa[MAX_LEVEL];
439 struct idr_layer **paa = &pa[0];
441 n = idp->layers * IDR_BITS;
447 while (n > IDR_BITS && p) {
450 p = p->ary[(id >> n) & IDR_MASK];
454 while (n < fls(id)) {
461 rcu_assign_pointer(idp->top, NULL);
464 EXPORT_SYMBOL(idr_remove_all);
467 * idr_destroy - release all cached layers within an idr tree
470 void idr_destroy(struct idr *idp)
472 while (idp->id_free_cnt) {
473 struct idr_layer *p = get_from_free_list(idp);
474 kmem_cache_free(idr_layer_cache, p);
477 EXPORT_SYMBOL(idr_destroy);
480 * idr_find - return pointer for given id
484 * Return the pointer given the id it has been registered with. A %NULL
485 * return indicates that @id is not valid or you passed %NULL in
488 * This function can be called under rcu_read_lock(), given that the leaf
489 * pointers lifetimes are correctly managed.
491 void *idr_find(struct idr *idp, int id)
496 n = idp->layers * IDR_BITS;
497 p = rcu_dereference(idp->top);
499 /* Mask off upper bits we don't use for the search. */
507 p = rcu_dereference(p->ary[(id >> n) & IDR_MASK]);
511 EXPORT_SYMBOL(idr_find);
514 * idr_for_each - iterate through all stored pointers
516 * @fn: function to be called for each pointer
517 * @data: data passed back to callback function
519 * Iterate over the pointers registered with the given idr. The
520 * callback function will be called for each pointer currently
521 * registered, passing the id, the pointer and the data pointer passed
522 * to this function. It is not safe to modify the idr tree while in
523 * the callback, so functions such as idr_get_new and idr_remove are
526 * We check the return of @fn each time. If it returns anything other
527 * than 0, we break out and return that value.
529 * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
531 int idr_for_each(struct idr *idp,
532 int (*fn)(int id, void *p, void *data), void *data)
534 int n, id, max, error = 0;
536 struct idr_layer *pa[MAX_LEVEL];
537 struct idr_layer **paa = &pa[0];
539 n = idp->layers * IDR_BITS;
540 p = rcu_dereference(idp->top);
548 p = rcu_dereference(p->ary[(id >> n) & IDR_MASK]);
552 error = fn(id, (void *)p, data);
558 while (n < fls(id)) {
566 EXPORT_SYMBOL(idr_for_each);
569 * idr_replace - replace pointer for given id
571 * @ptr: pointer you want associated with the id
574 * Replace the pointer registered with an id and return the old value.
575 * A -ENOENT return indicates that @id was not found.
576 * A -EINVAL return indicates that @id was not within valid constraints.
578 * The caller must serialize with writers.
580 void *idr_replace(struct idr *idp, void *ptr, int id)
583 struct idr_layer *p, *old_p;
585 n = idp->layers * IDR_BITS;
591 return ERR_PTR(-EINVAL);
594 while ((n > 0) && p) {
595 p = p->ary[(id >> n) & IDR_MASK];
600 if (unlikely(p == NULL || !test_bit(n, &p->bitmap)))
601 return ERR_PTR(-ENOENT);
604 rcu_assign_pointer(p->ary[n], ptr);
608 EXPORT_SYMBOL(idr_replace);
610 static void idr_cache_ctor(void *idr_layer)
612 memset(idr_layer, 0, sizeof(struct idr_layer));
615 void __init idr_init_cache(void)
617 idr_layer_cache = kmem_cache_create("idr_layer_cache",
618 sizeof(struct idr_layer), 0, SLAB_PANIC,
623 * idr_init - initialize idr handle
626 * This function is use to set up the handle (@idp) that you will pass
627 * to the rest of the functions.
629 void idr_init(struct idr *idp)
631 memset(idp, 0, sizeof(struct idr));
632 spin_lock_init(&idp->lock);
634 EXPORT_SYMBOL(idr_init);
638 * IDA - IDR based ID allocator
640 * this is id allocator without id -> pointer translation. Memory
641 * usage is much lower than full blown idr because each id only
642 * occupies a bit. ida uses a custom leaf node which contains
643 * IDA_BITMAP_BITS slots.
645 * 2007-04-25 written by Tejun Heo <htejun@gmail.com>
648 static void free_bitmap(struct ida *ida, struct ida_bitmap *bitmap)
652 if (!ida->free_bitmap) {
653 spin_lock_irqsave(&ida->idr.lock, flags);
654 if (!ida->free_bitmap) {
655 ida->free_bitmap = bitmap;
658 spin_unlock_irqrestore(&ida->idr.lock, flags);
665 * ida_pre_get - reserve resources for ida allocation
667 * @gfp_mask: memory allocation flag
669 * This function should be called prior to locking and calling the
670 * following function. It preallocates enough memory to satisfy the
671 * worst possible allocation.
673 * If the system is REALLY out of memory this function returns 0,
676 int ida_pre_get(struct ida *ida, gfp_t gfp_mask)
678 /* allocate idr_layers */
679 if (!idr_pre_get(&ida->idr, gfp_mask))
682 /* allocate free_bitmap */
683 if (!ida->free_bitmap) {
684 struct ida_bitmap *bitmap;
686 bitmap = kmalloc(sizeof(struct ida_bitmap), gfp_mask);
690 free_bitmap(ida, bitmap);
695 EXPORT_SYMBOL(ida_pre_get);
698 * ida_get_new_above - allocate new ID above or equal to a start id
700 * @staring_id: id to start search at
701 * @p_id: pointer to the allocated handle
703 * Allocate new ID above or equal to @ida. It should be called with
704 * any required locks.
706 * If memory is required, it will return -EAGAIN, you should unlock
707 * and go back to the ida_pre_get() call. If the ida is full, it will
710 * @p_id returns a value in the range 0 ... 0x7fffffff.
712 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
714 struct idr_layer *pa[MAX_LEVEL];
715 struct ida_bitmap *bitmap;
717 int idr_id = starting_id / IDA_BITMAP_BITS;
718 int offset = starting_id % IDA_BITMAP_BITS;
722 /* get vacant slot */
723 t = idr_get_empty_slot(&ida->idr, idr_id, pa);
725 return _idr_rc_to_errno(t);
727 if (t * IDA_BITMAP_BITS >= MAX_ID_BIT)
734 /* if bitmap isn't there, create a new one */
735 bitmap = (void *)pa[0]->ary[idr_id & IDR_MASK];
737 spin_lock_irqsave(&ida->idr.lock, flags);
738 bitmap = ida->free_bitmap;
739 ida->free_bitmap = NULL;
740 spin_unlock_irqrestore(&ida->idr.lock, flags);
745 memset(bitmap, 0, sizeof(struct ida_bitmap));
746 rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
751 /* lookup for empty slot */
752 t = find_next_zero_bit(bitmap->bitmap, IDA_BITMAP_BITS, offset);
753 if (t == IDA_BITMAP_BITS) {
754 /* no empty slot after offset, continue to the next chunk */
760 id = idr_id * IDA_BITMAP_BITS + t;
761 if (id >= MAX_ID_BIT)
764 __set_bit(t, bitmap->bitmap);
765 if (++bitmap->nr_busy == IDA_BITMAP_BITS)
766 idr_mark_full(pa, idr_id);
770 /* Each leaf node can handle nearly a thousand slots and the
771 * whole idea of ida is to have small memory foot print.
772 * Throw away extra resources one by one after each successful
775 if (ida->idr.id_free_cnt || ida->free_bitmap) {
776 struct idr_layer *p = get_from_free_list(&ida->idr);
778 kmem_cache_free(idr_layer_cache, p);
783 EXPORT_SYMBOL(ida_get_new_above);
786 * ida_get_new - allocate new ID
788 * @p_id: pointer to the allocated handle
790 * Allocate new ID. It should be called with any required locks.
792 * If memory is required, it will return -EAGAIN, you should unlock
793 * and go back to the idr_pre_get() call. If the idr is full, it will
796 * @id returns a value in the range 0 ... 0x7fffffff.
798 int ida_get_new(struct ida *ida, int *p_id)
800 return ida_get_new_above(ida, 0, p_id);
802 EXPORT_SYMBOL(ida_get_new);
805 * ida_remove - remove the given ID
809 void ida_remove(struct ida *ida, int id)
811 struct idr_layer *p = ida->idr.top;
812 int shift = (ida->idr.layers - 1) * IDR_BITS;
813 int idr_id = id / IDA_BITMAP_BITS;
814 int offset = id % IDA_BITMAP_BITS;
816 struct ida_bitmap *bitmap;
818 /* clear full bits while looking up the leaf idr_layer */
819 while ((shift > 0) && p) {
820 n = (idr_id >> shift) & IDR_MASK;
821 __clear_bit(n, &p->bitmap);
829 n = idr_id & IDR_MASK;
830 __clear_bit(n, &p->bitmap);
832 bitmap = (void *)p->ary[n];
833 if (!test_bit(offset, bitmap->bitmap))
836 /* update bitmap and remove it if empty */
837 __clear_bit(offset, bitmap->bitmap);
838 if (--bitmap->nr_busy == 0) {
839 __set_bit(n, &p->bitmap); /* to please idr_remove() */
840 idr_remove(&ida->idr, idr_id);
841 free_bitmap(ida, bitmap);
848 "ida_remove called for id=%d which is not allocated.\n", id);
850 EXPORT_SYMBOL(ida_remove);
853 * ida_destroy - release all cached layers within an ida tree
856 void ida_destroy(struct ida *ida)
858 idr_destroy(&ida->idr);
859 kfree(ida->free_bitmap);
861 EXPORT_SYMBOL(ida_destroy);
864 * ida_init - initialize ida handle
867 * This function is use to set up the handle (@ida) that you will pass
868 * to the rest of the functions.
870 void ida_init(struct ida *ida)
872 memset(ida, 0, sizeof(struct ida));
876 EXPORT_SYMBOL(ida_init);