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