cgroup: don't use idr_remove_all()
[linux-2.6-block.git] / lib / idr.c
CommitLineData
1da177e4
LT
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 *
3219b3b7
ND
9 * Modified by Nadia Derbey to make it RCU safe.
10 *
e15ae2dd 11 * Small id to pointer translation service.
1da177e4 12 *
e15ae2dd 13 * It uses a radix tree like structure as a sparse array indexed
1da177e4 14 * by the id to obtain the pointer. The bitmap makes allocating
e15ae2dd 15 * a new id quick.
1da177e4
LT
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
e15ae2dd 22 * You can release ids at any time. When all ids are released, most of
125c4c70 23 * the memory is returned (we keep MAX_IDR_FREE) in a local pool so we
e15ae2dd 24 * don't need to go to the memory "store" during an id allocate, just
1da177e4
LT
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>
8bc3bcc9 32#include <linux/export.h>
1da177e4 33#endif
5806f07c 34#include <linux/err.h>
1da177e4
LT
35#include <linux/string.h>
36#include <linux/idr.h>
88eca020 37#include <linux/spinlock.h>
1da177e4 38
e18b890b 39static struct kmem_cache *idr_layer_cache;
88eca020 40static DEFINE_SPINLOCK(simple_ida_lock);
1da177e4 41
4ae53789 42static struct idr_layer *get_from_free_list(struct idr *idp)
1da177e4
LT
43{
44 struct idr_layer *p;
c259cc28 45 unsigned long flags;
1da177e4 46
c259cc28 47 spin_lock_irqsave(&idp->lock, flags);
1da177e4
LT
48 if ((p = idp->id_free)) {
49 idp->id_free = p->ary[0];
50 idp->id_free_cnt--;
51 p->ary[0] = NULL;
52 }
c259cc28 53 spin_unlock_irqrestore(&idp->lock, flags);
1da177e4
LT
54 return(p);
55}
56
cf481c20
ND
57static 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
65static inline void free_layer(struct idr_layer *p)
66{
67 call_rcu(&p->rcu_head, idr_layer_rcu_free);
68}
69
1eec0056 70/* only called when idp->lock is held */
4ae53789 71static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
1eec0056
SR
72{
73 p->ary[0] = idp->id_free;
74 idp->id_free = p;
75 idp->id_free_cnt++;
76}
77
4ae53789 78static void move_to_free_list(struct idr *idp, struct idr_layer *p)
1da177e4 79{
c259cc28
RD
80 unsigned long flags;
81
1da177e4
LT
82 /*
83 * Depends on the return element being zeroed.
84 */
c259cc28 85 spin_lock_irqsave(&idp->lock, flags);
4ae53789 86 __move_to_free_list(idp, p);
c259cc28 87 spin_unlock_irqrestore(&idp->lock, flags);
1da177e4
LT
88}
89
e33ac8bd
TH
90static 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
1da177e4 110/**
56083ab1 111 * idr_pre_get - reserve resources for idr allocation
1da177e4
LT
112 * @idp: idr handle
113 * @gfp_mask: memory allocation flags
114 *
066a9be6
NA
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.
1da177e4 119 *
56083ab1
RD
120 * If the system is REALLY out of memory this function returns %0,
121 * otherwise %1.
1da177e4 122 */
fd4f2df2 123int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
1da177e4 124{
125c4c70 125 while (idp->id_free_cnt < MAX_IDR_FREE) {
1da177e4 126 struct idr_layer *new;
5b019e99 127 new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
e15ae2dd 128 if (new == NULL)
1da177e4 129 return (0);
4ae53789 130 move_to_free_list(idp, new);
1da177e4
LT
131 }
132 return 1;
133}
134EXPORT_SYMBOL(idr_pre_get);
135
e33ac8bd 136static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
1da177e4
LT
137{
138 int n, m, sh;
139 struct idr_layer *p, *new;
7aae6dd8 140 int l, id, oid;
5ba25331 141 unsigned long bm;
1da177e4
LT
142
143 id = *starting_id;
7aae6dd8 144 restart:
1da177e4
LT
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++;
7aae6dd8 158 oid = id;
e15ae2dd 159 id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
7aae6dd8
TH
160
161 /* if already at the top layer, we need to grow */
d2e7276b 162 if (id >= 1 << (idp->layers * IDR_BITS)) {
1da177e4 163 *starting_id = id;
944ca05c 164 return IDR_NEED_TO_GROW;
1da177e4 165 }
d2e7276b
TH
166 p = pa[l];
167 BUG_ON(!p);
7aae6dd8
TH
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;
1da177e4
LT
177 }
178 if (m != n) {
179 sh = IDR_BITS*l;
180 id = ((id >> sh) ^ n ^ m) << sh;
181 }
125c4c70 182 if ((id >= MAX_IDR_BIT) || (id < 0))
944ca05c 183 return IDR_NOMORE_SPACE;
1da177e4
LT
184 if (l == 0)
185 break;
186 /*
187 * Create the layer below if it is missing.
188 */
189 if (!p->ary[m]) {
4ae53789
ND
190 new = get_from_free_list(idp);
191 if (!new)
1da177e4 192 return -1;
6ff2d39b 193 new->layer = l-1;
3219b3b7 194 rcu_assign_pointer(p->ary[m], new);
1da177e4
LT
195 p->count++;
196 }
197 pa[l--] = p;
198 p = p->ary[m];
199 }
e33ac8bd
TH
200
201 pa[l] = p;
202 return id;
1da177e4
LT
203}
204
e33ac8bd
TH
205static int idr_get_empty_slot(struct idr *idp, int starting_id,
206 struct idr_layer **pa)
1da177e4
LT
207{
208 struct idr_layer *p, *new;
209 int layers, v, id;
c259cc28 210 unsigned long flags;
e15ae2dd 211
1da177e4
LT
212 id = starting_id;
213build_up:
214 p = idp->top;
215 layers = idp->layers;
216 if (unlikely(!p)) {
4ae53789 217 if (!(p = get_from_free_list(idp)))
1da177e4 218 return -1;
6ff2d39b 219 p->layer = 0;
1da177e4
LT
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 */
125c4c70 226 while ((layers < (MAX_IDR_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
1da177e4 227 layers++;
711a49a0
MS
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++;
1da177e4 234 continue;
711a49a0 235 }
4ae53789 236 if (!(new = get_from_free_list(idp))) {
1da177e4
LT
237 /*
238 * The allocation failed. If we built part of
239 * the structure tear it down.
240 */
c259cc28 241 spin_lock_irqsave(&idp->lock, flags);
1da177e4
LT
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;
4ae53789 246 __move_to_free_list(idp, new);
1da177e4 247 }
c259cc28 248 spin_unlock_irqrestore(&idp->lock, flags);
1da177e4
LT
249 return -1;
250 }
251 new->ary[0] = p;
252 new->count = 1;
6ff2d39b 253 new->layer = layers-1;
1da177e4
LT
254 if (p->bitmap == IDR_FULL)
255 __set_bit(0, &new->bitmap);
256 p = new;
257 }
3219b3b7 258 rcu_assign_pointer(idp->top, p);
1da177e4 259 idp->layers = layers;
e33ac8bd 260 v = sub_alloc(idp, &id, pa);
944ca05c 261 if (v == IDR_NEED_TO_GROW)
1da177e4
LT
262 goto build_up;
263 return(v);
264}
265
e33ac8bd
TH
266static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
267{
125c4c70 268 struct idr_layer *pa[MAX_IDR_LEVEL];
e33ac8bd
TH
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 */
3219b3b7
ND
277 rcu_assign_pointer(pa[0]->ary[id & IDR_MASK],
278 (struct idr_layer *)ptr);
e33ac8bd
TH
279 pa[0]->count++;
280 idr_mark_full(pa, id);
281 }
282
283 return id;
284}
285
1da177e4 286/**
7c657f2f 287 * idr_get_new_above - allocate new idr entry above or equal to a start id
1da177e4 288 * @idp: idr handle
94e2bd68 289 * @ptr: pointer you want associated with the id
ea24ea85 290 * @starting_id: id to start search at
1da177e4
LT
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 *
066a9be6 296 * If allocation from IDR's private freelist fails, idr_get_new_above() will
56083ab1 297 * return %-EAGAIN. The caller should retry the idr_pre_get() call to refill
066a9be6
NA
298 * IDR's preallocation and then retry the idr_get_new_above() call.
299 *
56083ab1 300 * If the idr is full idr_get_new_above() will return %-ENOSPC.
1da177e4 301 *
56083ab1 302 * @id returns a value in the range @starting_id ... %0x7fffffff
1da177e4
LT
303 */
304int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
305{
306 int rv;
e15ae2dd 307
1da177e4
LT
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 */
944ca05c
ND
313 if (rv < 0)
314 return _idr_rc_to_errno(rv);
1da177e4
LT
315 *id = rv;
316 return 0;
317}
318EXPORT_SYMBOL(idr_get_new_above);
319
320/**
321 * idr_get_new - allocate new idr entry
322 * @idp: idr handle
94e2bd68 323 * @ptr: pointer you want associated with the id
1da177e4
LT
324 * @id: pointer to the allocated handle
325 *
066a9be6 326 * If allocation from IDR's private freelist fails, idr_get_new_above() will
56083ab1 327 * return %-EAGAIN. The caller should retry the idr_pre_get() call to refill
066a9be6 328 * IDR's preallocation and then retry the idr_get_new_above() call.
1da177e4 329 *
56083ab1 330 * If the idr is full idr_get_new_above() will return %-ENOSPC.
1da177e4 331 *
56083ab1 332 * @id returns a value in the range %0 ... %0x7fffffff
1da177e4
LT
333 */
334int idr_get_new(struct idr *idp, void *ptr, int *id)
335{
336 int rv;
e15ae2dd 337
1da177e4
LT
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 */
944ca05c
ND
343 if (rv < 0)
344 return _idr_rc_to_errno(rv);
1da177e4
LT
345 *id = rv;
346 return 0;
347}
348EXPORT_SYMBOL(idr_get_new);
349
350static void idr_remove_warning(int id)
351{
f098ad65
ND
352 printk(KERN_WARNING
353 "idr_remove called for id=%d which is not allocated.\n", id);
1da177e4
LT
354 dump_stack();
355}
356
357static void sub_remove(struct idr *idp, int shift, int id)
358{
359 struct idr_layer *p = idp->top;
125c4c70 360 struct idr_layer **pa[MAX_IDR_LEVEL];
1da177e4 361 struct idr_layer ***paa = &pa[0];
cf481c20 362 struct idr_layer *to_free;
1da177e4
LT
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);
cf481c20
ND
378 rcu_assign_pointer(p->ary[n], NULL);
379 to_free = NULL;
1da177e4 380 while(*paa && ! --((**paa)->count)){
cf481c20
ND
381 if (to_free)
382 free_layer(to_free);
383 to_free = **paa;
1da177e4
LT
384 **paa-- = NULL;
385 }
e15ae2dd 386 if (!*paa)
1da177e4 387 idp->layers = 0;
cf481c20
ND
388 if (to_free)
389 free_layer(to_free);
e15ae2dd 390 } else
1da177e4 391 idr_remove_warning(id);
1da177e4
LT
392}
393
394/**
56083ab1 395 * idr_remove - remove the given id and free its slot
72fd4a35
RD
396 * @idp: idr handle
397 * @id: unique key
1da177e4
LT
398 */
399void idr_remove(struct idr *idp, int id)
400{
401 struct idr_layer *p;
cf481c20 402 struct idr_layer *to_free;
1da177e4
LT
403
404 /* Mask off upper bits we don't use for the search. */
125c4c70 405 id &= MAX_IDR_MASK;
1da177e4
LT
406
407 sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
e15ae2dd 408 if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
cf481c20
ND
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;
1da177e4 417 p = idp->top->ary[0];
cf481c20 418 rcu_assign_pointer(idp->top, p);
1da177e4 419 --idp->layers;
cf481c20
ND
420 to_free->bitmap = to_free->count = 0;
421 free_layer(to_free);
1da177e4 422 }
125c4c70 423 while (idp->id_free_cnt >= MAX_IDR_FREE) {
4ae53789 424 p = get_from_free_list(idp);
cf481c20
ND
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 */
1da177e4 430 kmem_cache_free(idr_layer_cache, p);
1da177e4 431 }
af8e2a4c 432 return;
1da177e4
LT
433}
434EXPORT_SYMBOL(idr_remove);
435
23936cc0
KH
436/**
437 * idr_remove_all - remove all ids from the given idr tree
438 * @idp: idr handle
23936cc0
KH
439 */
440void idr_remove_all(struct idr *idp)
441{
6ace06dc 442 int n, id, max;
2dcb22b3 443 int bt_mask;
23936cc0 444 struct idr_layer *p;
125c4c70 445 struct idr_layer *pa[MAX_IDR_LEVEL];
23936cc0
KH
446 struct idr_layer **paa = &pa[0];
447
448 n = idp->layers * IDR_BITS;
449 p = idp->top;
1b23336a 450 rcu_assign_pointer(idp->top, NULL);
23936cc0
KH
451 max = 1 << n;
452
453 id = 0;
6ace06dc 454 while (id < max) {
23936cc0
KH
455 while (n > IDR_BITS && p) {
456 n -= IDR_BITS;
457 *paa++ = p;
458 p = p->ary[(id >> n) & IDR_MASK];
459 }
460
2dcb22b3 461 bt_mask = id;
23936cc0 462 id += 1 << n;
2dcb22b3
ID
463 /* Get the highest bit that the above add changed from 0->1. */
464 while (n < fls(id ^ bt_mask)) {
cf481c20
ND
465 if (p)
466 free_layer(p);
23936cc0
KH
467 n += IDR_BITS;
468 p = *--paa;
469 }
470 }
23936cc0
KH
471 idp->layers = 0;
472}
473EXPORT_SYMBOL(idr_remove_all);
474
8d3b3591
AM
475/**
476 * idr_destroy - release all cached layers within an idr tree
ea24ea85 477 * @idp: idr handle
9bb26bc1
TH
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.
8d3b3591
AM
487 */
488void idr_destroy(struct idr *idp)
489{
9bb26bc1
TH
490 idr_remove_all(idp);
491
8d3b3591 492 while (idp->id_free_cnt) {
4ae53789 493 struct idr_layer *p = get_from_free_list(idp);
8d3b3591
AM
494 kmem_cache_free(idr_layer_cache, p);
495 }
496}
497EXPORT_SYMBOL(idr_destroy);
498
1da177e4
LT
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 *
f9c46d6e
ND
508 * This function can be called under rcu_read_lock(), given that the leaf
509 * pointers lifetimes are correctly managed.
1da177e4
LT
510 */
511void *idr_find(struct idr *idp, int id)
512{
513 int n;
514 struct idr_layer *p;
515
96be753a 516 p = rcu_dereference_raw(idp->top);
6ff2d39b
MS
517 if (!p)
518 return NULL;
519 n = (p->layer+1) * IDR_BITS;
1da177e4
LT
520
521 /* Mask off upper bits we don't use for the search. */
125c4c70 522 id &= MAX_IDR_MASK;
1da177e4
LT
523
524 if (id >= (1 << n))
525 return NULL;
6ff2d39b 526 BUG_ON(n == 0);
1da177e4
LT
527
528 while (n > 0 && p) {
529 n -= IDR_BITS;
6ff2d39b 530 BUG_ON(n != p->layer*IDR_BITS);
96be753a 531 p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
1da177e4
LT
532 }
533 return((void *)p);
534}
535EXPORT_SYMBOL(idr_find);
536
96d7fa42
KH
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
56083ab1 551 * than %0, we break out and return that value.
96d7fa42
KH
552 *
553 * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
554 */
555int 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;
125c4c70 560 struct idr_layer *pa[MAX_IDR_LEVEL];
96d7fa42
KH
561 struct idr_layer **paa = &pa[0];
562
563 n = idp->layers * IDR_BITS;
96be753a 564 p = rcu_dereference_raw(idp->top);
96d7fa42
KH
565 max = 1 << n;
566
567 id = 0;
568 while (id < max) {
569 while (n > 0 && p) {
570 n -= IDR_BITS;
571 *paa++ = p;
96be753a 572 p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
96d7fa42
KH
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}
590EXPORT_SYMBOL(idr_for_each);
591
38460b48
KH
592/**
593 * idr_get_next - lookup next object of id to given id.
594 * @idp: idr handle
ea24ea85 595 * @nextidp: pointer to lookup key
38460b48
KH
596 *
597 * Returns pointer to registered object with id, which is next number to
1458ce16
NA
598 * given id. After being looked up, *@nextidp will be updated for the next
599 * iteration.
9f7de827
HD
600 *
601 * This function can be called under rcu_read_lock(), given that the leaf
602 * pointers lifetimes are correctly managed.
38460b48 603 */
38460b48
KH
604void *idr_get_next(struct idr *idp, int *nextidp)
605{
125c4c70 606 struct idr_layer *p, *pa[MAX_IDR_LEVEL];
38460b48
KH
607 struct idr_layer **paa = &pa[0];
608 int id = *nextidp;
609 int n, max;
610
611 /* find first ent */
94bfa3b6 612 p = rcu_dereference_raw(idp->top);
38460b48
KH
613 if (!p)
614 return NULL;
9f7de827
HD
615 n = (p->layer + 1) * IDR_BITS;
616 max = 1 << n;
38460b48
KH
617
618 while (id < max) {
619 while (n > 0 && p) {
620 n -= IDR_BITS;
621 *paa++ = p;
94bfa3b6 622 p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
38460b48
KH
623 }
624
625 if (p) {
626 *nextidp = id;
627 return p;
628 }
629
6cdae741
TH
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);
38460b48
KH
638 while (n < fls(id)) {
639 n += IDR_BITS;
640 p = *--paa;
641 }
642 }
643 return NULL;
644}
4d1ee80f 645EXPORT_SYMBOL(idr_get_next);
38460b48
KH
646
647
5806f07c
JM
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.
56083ab1
RD
655 * A %-ENOENT return indicates that @id was not found.
656 * A %-EINVAL return indicates that @id was not within valid constraints.
5806f07c 657 *
cf481c20 658 * The caller must serialize with writers.
5806f07c
JM
659 */
660void *idr_replace(struct idr *idp, void *ptr, int id)
661{
662 int n;
663 struct idr_layer *p, *old_p;
664
5806f07c 665 p = idp->top;
6ff2d39b
MS
666 if (!p)
667 return ERR_PTR(-EINVAL);
668
669 n = (p->layer+1) * IDR_BITS;
5806f07c 670
125c4c70 671 id &= MAX_IDR_MASK;
5806f07c
JM
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];
cf481c20 687 rcu_assign_pointer(p->ary[n], ptr);
5806f07c
JM
688
689 return old_p;
690}
691EXPORT_SYMBOL(idr_replace);
692
199f0ca5 693void __init idr_init_cache(void)
1da177e4 694{
199f0ca5 695 idr_layer_cache = kmem_cache_create("idr_layer_cache",
5b019e99 696 sizeof(struct idr_layer), 0, SLAB_PANIC, NULL);
1da177e4
LT
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 */
706void idr_init(struct idr *idp)
707{
1da177e4
LT
708 memset(idp, 0, sizeof(struct idr));
709 spin_lock_init(&idp->lock);
710}
711EXPORT_SYMBOL(idr_init);
72dba584
TH
712
713
56083ab1
RD
714/**
715 * DOC: IDA description
72dba584
TH
716 * IDA - IDR based ID allocator
717 *
56083ab1 718 * This is id allocator without id -> pointer translation. Memory
72dba584
TH
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
726static 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 *
56083ab1
RD
751 * If the system is REALLY out of memory this function returns %0,
752 * otherwise %1.
72dba584
TH
753 */
754int 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}
773EXPORT_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
ea24ea85 778 * @starting_id: id to start search at
72dba584
TH
779 * @p_id: pointer to the allocated handle
780 *
e3816c54
WSH
781 * Allocate new ID above or equal to @starting_id. It should be called
782 * with any required locks.
72dba584 783 *
56083ab1 784 * If memory is required, it will return %-EAGAIN, you should unlock
72dba584 785 * and go back to the ida_pre_get() call. If the ida is full, it will
56083ab1 786 * return %-ENOSPC.
72dba584 787 *
56083ab1 788 * @p_id returns a value in the range @starting_id ... %0x7fffffff.
72dba584
TH
789 */
790int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
791{
125c4c70 792 struct idr_layer *pa[MAX_IDR_LEVEL];
72dba584
TH
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);
944ca05c
ND
802 if (t < 0)
803 return _idr_rc_to_errno(t);
72dba584 804
125c4c70 805 if (t * IDA_BITMAP_BITS >= MAX_IDR_BIT)
72dba584
TH
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));
3219b3b7
ND
824 rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
825 (void *)bitmap);
72dba584
TH
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;
125c4c70 839 if (id >= MAX_IDR_BIT)
72dba584
TH
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) {
4ae53789 854 struct idr_layer *p = get_from_free_list(&ida->idr);
72dba584
TH
855 if (p)
856 kmem_cache_free(idr_layer_cache, p);
857 }
858
859 return 0;
860}
861EXPORT_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 *
56083ab1 870 * If memory is required, it will return %-EAGAIN, you should unlock
72dba584 871 * and go back to the idr_pre_get() call. If the idr is full, it will
56083ab1 872 * return %-ENOSPC.
72dba584 873 *
f5c3dd71 874 * @p_id returns a value in the range %0 ... %0x7fffffff.
72dba584
TH
875 */
876int ida_get_new(struct ida *ida, int *p_id)
877{
878 return ida_get_new_above(ida, 0, p_id);
879}
880EXPORT_SYMBOL(ida_get_new);
881
882/**
883 * ida_remove - remove the given ID
884 * @ida: ida handle
885 * @id: ID to free
886 */
887void 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}
928EXPORT_SYMBOL(ida_remove);
929
930/**
931 * ida_destroy - release all cached layers within an ida tree
ea24ea85 932 * @ida: ida handle
72dba584
TH
933 */
934void ida_destroy(struct ida *ida)
935{
936 idr_destroy(&ida->idr);
937 kfree(ida->free_bitmap);
938}
939EXPORT_SYMBOL(ida_destroy);
940
88eca020
RR
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 */
953int 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;
46cbc1d3 958 unsigned long flags;
88eca020
RR
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
970again:
971 if (!ida_pre_get(ida, gfp_mask))
972 return -ENOMEM;
973
46cbc1d3 974 spin_lock_irqsave(&simple_ida_lock, flags);
88eca020
RR
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 }
46cbc1d3 984 spin_unlock_irqrestore(&simple_ida_lock, flags);
88eca020
RR
985
986 if (unlikely(ret == -EAGAIN))
987 goto again;
988
989 return ret;
990}
991EXPORT_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 */
998void ida_simple_remove(struct ida *ida, unsigned int id)
999{
46cbc1d3
TH
1000 unsigned long flags;
1001
88eca020 1002 BUG_ON((int)id < 0);
46cbc1d3 1003 spin_lock_irqsave(&simple_ida_lock, flags);
88eca020 1004 ida_remove(ida, id);
46cbc1d3 1005 spin_unlock_irqrestore(&simple_ida_lock, flags);
88eca020
RR
1006}
1007EXPORT_SYMBOL(ida_simple_remove);
1008
72dba584
TH
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 */
1016void ida_init(struct ida *ida)
1017{
1018 memset(ida, 0, sizeof(struct ida));
1019 idr_init(&ida->idr);
1020
1021}
1022EXPORT_SYMBOL(ida_init);