idr.c 20.5 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8
/*
 * 2002-10-18  written by Jim Houston jim.houston@ccur.com
 *	Copyright (C) 2002 by Concurrent Computer Corporation
 *	Distributed under the GNU GPL license version 2.
 *
 * Modified by George Anzinger to reuse immediately and to use
 * find bit instructions.  Also removed _irq on spinlocks.
 *
Nadia Derbey's avatar
Nadia Derbey committed
9 10
 * Modified by Nadia Derbey to make it RCU safe.
 *
11
 * Small id to pointer translation service.
Linus Torvalds's avatar
Linus Torvalds committed
12
 *
13
 * It uses a radix tree like structure as a sparse array indexed
Linus Torvalds's avatar
Linus Torvalds committed
14
 * by the id to obtain the pointer.  The bitmap makes allocating
15
 * a new id quick.
Linus Torvalds's avatar
Linus Torvalds committed
16 17 18 19 20 21
 *
 * You call it to allocate an id (an int) an associate with that id a
 * pointer or what ever, we treat it as a (void *).  You can pass this
 * id to a user for him to pass back at a later time.  You then pass
 * 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
Linus Torvalds's avatar
Linus Torvalds committed
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
Linus Torvalds's avatar
Linus Torvalds committed
25 26 27 28 29 30 31 32 33
 * so you don't need to be too concerned about locking and conflicts
 * with the slab allocator.
 */

#ifndef TEST                        // to test in user space...
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/module.h>
#endif
Jeff Mahoney's avatar
Jeff Mahoney committed
34
#include <linux/err.h>
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37
#include <linux/string.h>
#include <linux/idr.h>

38
static struct kmem_cache *idr_layer_cache;
Linus Torvalds's avatar
Linus Torvalds committed
39

40
static struct idr_layer *get_from_free_list(struct idr *idp)
Linus Torvalds's avatar
Linus Torvalds committed
41 42
{
	struct idr_layer *p;
43
	unsigned long flags;
Linus Torvalds's avatar
Linus Torvalds committed
44

45
	spin_lock_irqsave(&idp->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
46 47 48 49 50
	if ((p = idp->id_free)) {
		idp->id_free = p->ary[0];
		idp->id_free_cnt--;
		p->ary[0] = NULL;
	}
51
	spin_unlock_irqrestore(&idp->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
52 53 54
	return(p);
}

Nadia Derbey's avatar
Nadia Derbey committed
55 56 57 58 59 60 61 62 63 64 65 66 67
static void idr_layer_rcu_free(struct rcu_head *head)
{
	struct idr_layer *layer;

	layer = container_of(head, struct idr_layer, rcu_head);
	kmem_cache_free(idr_layer_cache, layer);
}

static inline void free_layer(struct idr_layer *p)
{
	call_rcu(&p->rcu_head, idr_layer_rcu_free);
}

Sonny Rao's avatar
Sonny Rao committed
68
/* only called when idp->lock is held */
69
static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
Sonny Rao's avatar
Sonny Rao committed
70 71 72 73 74 75
{
	p->ary[0] = idp->id_free;
	idp->id_free = p;
	idp->id_free_cnt++;
}

76
static void move_to_free_list(struct idr *idp, struct idr_layer *p)
Linus Torvalds's avatar
Linus Torvalds committed
77
{
78 79
	unsigned long flags;

Linus Torvalds's avatar
Linus Torvalds committed
80 81 82
	/*
	 * 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);
Linus Torvalds's avatar
Linus Torvalds committed
86 87
}

Tejun Heo's avatar
Tejun Heo committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
static void idr_mark_full(struct idr_layer **pa, int id)
{
	struct idr_layer *p = pa[0];
	int l = 0;

	__set_bit(id & IDR_MASK, &p->bitmap);
	/*
	 * If this layer is full mark the bit in the layer above to
	 * show that this part of the radix tree is full.  This may
	 * complete the layer above and require walking up the radix
	 * tree.
	 */
	while (p->bitmap == IDR_FULL) {
		if (!(p = pa[++l]))
			break;
		id = id >> IDR_BITS;
		__set_bit((id & IDR_MASK), &p->bitmap);
	}
}

Linus Torvalds's avatar
Linus Torvalds committed
108 109 110 111 112 113
/**
 * idr_pre_get - reserver resources for idr allocation
 * @idp:	idr handle
 * @gfp_mask:	memory allocation flags
 *
 * This function should be called prior to locking and calling the
Nadia Derbey's avatar
Nadia Derbey committed
114
 * idr_get_new* functions. It preallocates enough memory to satisfy
Linus Torvalds's avatar
Linus Torvalds committed
115 116 117 118 119
 * the worst possible allocation.
 *
 * If the system is REALLY out of memory this function returns 0,
 * otherwise 1.
 */
Al Viro's avatar
Al Viro committed
120
int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
Linus Torvalds's avatar
Linus Torvalds committed
121 122 123 124
{
	while (idp->id_free_cnt < IDR_FREE_MAX) {
		struct idr_layer *new;
		new = kmem_cache_alloc(idr_layer_cache, gfp_mask);
125
		if (new == NULL)
Linus Torvalds's avatar
Linus Torvalds committed
126
			return (0);
127
		move_to_free_list(idp, new);
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130 131 132
	}
	return 1;
}
EXPORT_SYMBOL(idr_pre_get);

Tejun Heo's avatar
Tejun Heo committed
133
static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
Linus Torvalds's avatar
Linus Torvalds committed
134 135 136
{
	int n, m, sh;
	struct idr_layer *p, *new;
137
	int l, id, oid;
138
	unsigned long bm;
Linus Torvalds's avatar
Linus Torvalds committed
139 140

	id = *starting_id;
141
 restart:
Linus Torvalds's avatar
Linus Torvalds committed
142 143 144 145 146 147 148 149 150 151 152 153 154
	p = idp->top;
	l = idp->layers;
	pa[l--] = NULL;
	while (1) {
		/*
		 * We run around this while until we reach the leaf node...
		 */
		n = (id >> (IDR_BITS*l)) & IDR_MASK;
		bm = ~p->bitmap;
		m = find_next_bit(&bm, IDR_SIZE, n);
		if (m == IDR_SIZE) {
			/* no space available go back to previous layer. */
			l++;
155
			oid = id;
156
			id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
157 158

			/* if already at the top layer, we need to grow */
Linus Torvalds's avatar
Linus Torvalds committed
159 160
			if (!(p = pa[l])) {
				*starting_id = id;
161
				return IDR_NEED_TO_GROW;
Linus Torvalds's avatar
Linus Torvalds committed
162
			}
163 164 165 166 167 168 169 170 171

			/* If we need to go up one layer, continue the
			 * loop; otherwise, restart from the top.
			 */
			sh = IDR_BITS * (l + 1);
			if (oid >> sh == id >> sh)
				continue;
			else
				goto restart;
Linus Torvalds's avatar
Linus Torvalds committed
172 173 174 175 176 177
		}
		if (m != n) {
			sh = IDR_BITS*l;
			id = ((id >> sh) ^ n ^ m) << sh;
		}
		if ((id >= MAX_ID_BIT) || (id < 0))
178
			return IDR_NOMORE_SPACE;
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182 183 184
		if (l == 0)
			break;
		/*
		 * Create the layer below if it is missing.
		 */
		if (!p->ary[m]) {
185 186
			new = get_from_free_list(idp);
			if (!new)
Linus Torvalds's avatar
Linus Torvalds committed
187
				return -1;
188
			new->layer = l-1;
Nadia Derbey's avatar
Nadia Derbey committed
189
			rcu_assign_pointer(p->ary[m], new);
Linus Torvalds's avatar
Linus Torvalds committed
190 191 192 193 194
			p->count++;
		}
		pa[l--] = p;
		p = p->ary[m];
	}
Tejun Heo's avatar
Tejun Heo committed
195 196 197

	pa[l] = p;
	return id;
Linus Torvalds's avatar
Linus Torvalds committed
198 199
}

Tejun Heo's avatar
Tejun Heo committed
200 201
static int idr_get_empty_slot(struct idr *idp, int starting_id,
			      struct idr_layer **pa)
Linus Torvalds's avatar
Linus Torvalds committed
202 203 204
{
	struct idr_layer *p, *new;
	int layers, v, id;
205
	unsigned long flags;
206

Linus Torvalds's avatar
Linus Torvalds committed
207 208 209 210 211
	id = starting_id;
build_up:
	p = idp->top;
	layers = idp->layers;
	if (unlikely(!p)) {
212
		if (!(p = get_from_free_list(idp)))
Linus Torvalds's avatar
Linus Torvalds committed
213
			return -1;
214
		p->layer = 0;
Linus Torvalds's avatar
Linus Torvalds committed
215 216 217 218 219 220
		layers = 1;
	}
	/*
	 * Add a new layer to the top of the tree if the requested
	 * id is larger than the currently allocated space.
	 */
221
	while ((layers < (MAX_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
Linus Torvalds's avatar
Linus Torvalds committed
222 223 224
		layers++;
		if (!p->count)
			continue;
225
		if (!(new = get_from_free_list(idp))) {
Linus Torvalds's avatar
Linus Torvalds committed
226 227 228 229
			/*
			 * The allocation failed.  If we built part of
			 * the structure tear it down.
			 */
230
			spin_lock_irqsave(&idp->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
231 232 233 234
			for (new = p; p && p != idp->top; new = p) {
				p = p->ary[0];
				new->ary[0] = NULL;
				new->bitmap = new->count = 0;
235
				__move_to_free_list(idp, new);
Linus Torvalds's avatar
Linus Torvalds committed
236
			}
237
			spin_unlock_irqrestore(&idp->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
238 239 240 241
			return -1;
		}
		new->ary[0] = p;
		new->count = 1;
242
		new->layer = layers-1;
Linus Torvalds's avatar
Linus Torvalds committed
243 244 245 246
		if (p->bitmap == IDR_FULL)
			__set_bit(0, &new->bitmap);
		p = new;
	}
Nadia Derbey's avatar
Nadia Derbey committed
247
	rcu_assign_pointer(idp->top, p);
Linus Torvalds's avatar
Linus Torvalds committed
248
	idp->layers = layers;
Tejun Heo's avatar
Tejun Heo committed
249
	v = sub_alloc(idp, &id, pa);
250
	if (v == IDR_NEED_TO_GROW)
Linus Torvalds's avatar
Linus Torvalds committed
251 252 253 254
		goto build_up;
	return(v);
}

Tejun Heo's avatar
Tejun Heo committed
255 256 257 258 259 260 261 262 263 264 265
static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
{
	struct idr_layer *pa[MAX_LEVEL];
	int id;

	id = idr_get_empty_slot(idp, starting_id, pa);
	if (id >= 0) {
		/*
		 * Successfully found an empty slot.  Install the user
		 * pointer and mark the slot full.
		 */
Nadia Derbey's avatar
Nadia Derbey committed
266 267
		rcu_assign_pointer(pa[0]->ary[id & IDR_MASK],
				(struct idr_layer *)ptr);
Tejun Heo's avatar
Tejun Heo committed
268 269 270 271 272 273 274
		pa[0]->count++;
		idr_mark_full(pa, id);
	}

	return id;
}

Linus Torvalds's avatar
Linus Torvalds committed
275
/**
276
 * idr_get_new_above - allocate new idr entry above or equal to a start id
Linus Torvalds's avatar
Linus Torvalds committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
 * @idp: idr handle
 * @ptr: pointer you want associated with the ide
 * @start_id: id to start search at
 * @id: pointer to the allocated handle
 *
 * This is the allocate id function.  It should be called with any
 * required locks.
 *
 * If memory is required, it will return -EAGAIN, you should unlock
 * and go back to the idr_pre_get() call.  If the idr is full, it will
 * return -ENOSPC.
 *
 * @id returns a value in the range 0 ... 0x7fffffff
 */
int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
{
	int rv;
294

Linus Torvalds's avatar
Linus Torvalds committed
295 296 297 298 299
	rv = idr_get_new_above_int(idp, ptr, starting_id);
	/*
	 * This is a cheap hack until the IDR code can be fixed to
	 * return proper error values.
	 */
300 301
	if (rv < 0)
		return _idr_rc_to_errno(rv);
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
	*id = rv;
	return 0;
}
EXPORT_SYMBOL(idr_get_new_above);

/**
 * idr_get_new - allocate new idr entry
 * @idp: idr handle
 * @ptr: pointer you want associated with the ide
 * @id: pointer to the allocated handle
 *
 * This is the allocate id function.  It should be called with any
 * required locks.
 *
 * If memory is required, it will return -EAGAIN, you should unlock
 * and go back to the idr_pre_get() call.  If the idr is full, it will
 * return -ENOSPC.
 *
 * @id returns a value in the range 0 ... 0x7fffffff
 */
int idr_get_new(struct idr *idp, void *ptr, int *id)
{
	int rv;
325

Linus Torvalds's avatar
Linus Torvalds committed
326 327 328 329 330
	rv = idr_get_new_above_int(idp, ptr, 0);
	/*
	 * This is a cheap hack until the IDR code can be fixed to
	 * return proper error values.
	 */
331 332
	if (rv < 0)
		return _idr_rc_to_errno(rv);
Linus Torvalds's avatar
Linus Torvalds committed
333 334 335 336 337 338 339
	*id = rv;
	return 0;
}
EXPORT_SYMBOL(idr_get_new);

static void idr_remove_warning(int id)
{
Nadia Derbey's avatar
Nadia Derbey committed
340 341
	printk(KERN_WARNING
		"idr_remove called for id=%d which is not allocated.\n", id);
Linus Torvalds's avatar
Linus Torvalds committed
342 343 344 345 346 347 348 349
	dump_stack();
}

static void sub_remove(struct idr *idp, int shift, int id)
{
	struct idr_layer *p = idp->top;
	struct idr_layer **pa[MAX_LEVEL];
	struct idr_layer ***paa = &pa[0];
Nadia Derbey's avatar
Nadia Derbey committed
350
	struct idr_layer *to_free;
Linus Torvalds's avatar
Linus Torvalds committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
	int n;

	*paa = NULL;
	*++paa = &idp->top;

	while ((shift > 0) && p) {
		n = (id >> shift) & IDR_MASK;
		__clear_bit(n, &p->bitmap);
		*++paa = &p->ary[n];
		p = p->ary[n];
		shift -= IDR_BITS;
	}
	n = id & IDR_MASK;
	if (likely(p != NULL && test_bit(n, &p->bitmap))){
		__clear_bit(n, &p->bitmap);
Nadia Derbey's avatar
Nadia Derbey committed
366 367
		rcu_assign_pointer(p->ary[n], NULL);
		to_free = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
368
		while(*paa && ! --((**paa)->count)){
Nadia Derbey's avatar
Nadia Derbey committed
369 370 371
			if (to_free)
				free_layer(to_free);
			to_free = **paa;
Linus Torvalds's avatar
Linus Torvalds committed
372 373
			**paa-- = NULL;
		}
374
		if (!*paa)
Linus Torvalds's avatar
Linus Torvalds committed
375
			idp->layers = 0;
Nadia Derbey's avatar
Nadia Derbey committed
376 377
		if (to_free)
			free_layer(to_free);
378
	} else
Linus Torvalds's avatar
Linus Torvalds committed
379 380 381 382 383
		idr_remove_warning(id);
}

/**
 * idr_remove - remove the given id and free it's slot
384 385
 * @idp: idr handle
 * @id: unique key
Linus Torvalds's avatar
Linus Torvalds committed
386 387 388 389
 */
void idr_remove(struct idr *idp, int id)
{
	struct idr_layer *p;
Nadia Derbey's avatar
Nadia Derbey committed
390
	struct idr_layer *to_free;
Linus Torvalds's avatar
Linus Torvalds committed
391 392 393 394 395

	/* Mask off upper bits we don't use for the search. */
	id &= MAX_ID_MASK;

	sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
396
	if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
Nadia Derbey's avatar
Nadia Derbey committed
397 398 399 400 401 402 403 404
	    idp->top->ary[0]) {
		/*
		 * Single child at leftmost slot: we can shrink the tree.
		 * This level is not needed anymore since when layers are
		 * inserted, they are inserted at the top of the existing
		 * tree.
		 */
		to_free = idp->top;
Linus Torvalds's avatar
Linus Torvalds committed
405
		p = idp->top->ary[0];
Nadia Derbey's avatar
Nadia Derbey committed
406
		rcu_assign_pointer(idp->top, p);
Linus Torvalds's avatar
Linus Torvalds committed
407
		--idp->layers;
Nadia Derbey's avatar
Nadia Derbey committed
408 409
		to_free->bitmap = to_free->count = 0;
		free_layer(to_free);
Linus Torvalds's avatar
Linus Torvalds committed
410 411
	}
	while (idp->id_free_cnt >= IDR_FREE_MAX) {
412
		p = get_from_free_list(idp);
Nadia Derbey's avatar
Nadia Derbey committed
413 414 415 416 417
		/*
		 * Note: we don't call the rcu callback here, since the only
		 * layers that fall into the freelist are those that have been
		 * preallocated.
		 */
Linus Torvalds's avatar
Linus Torvalds committed
418 419
		kmem_cache_free(idr_layer_cache, p);
	}
Nadia Derbey's avatar
Nadia Derbey committed
420
	return;
Linus Torvalds's avatar
Linus Torvalds committed
421 422 423
}
EXPORT_SYMBOL(idr_remove);

Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
/**
 * idr_remove_all - remove all ids from the given idr tree
 * @idp: idr handle
 *
 * idr_destroy() only frees up unused, cached idp_layers, but this
 * function will remove all id mappings and leave all idp_layers
 * unused.
 *
 * A typical clean-up sequence for objects stored in an idr tree, will
 * use idr_for_each() to free all objects, if necessay, then
 * idr_remove_all() to remove all ids, and idr_destroy() to free
 * up the cached idr_layers.
 */
void idr_remove_all(struct idr *idp)
{
439
	int n, id, max;
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
440 441 442 443 444 445 446 447 448
	struct idr_layer *p;
	struct idr_layer *pa[MAX_LEVEL];
	struct idr_layer **paa = &pa[0];

	n = idp->layers * IDR_BITS;
	p = idp->top;
	max = 1 << n;

	id = 0;
449
	while (id < max) {
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
450 451 452 453 454 455 456 457
		while (n > IDR_BITS && p) {
			n -= IDR_BITS;
			*paa++ = p;
			p = p->ary[(id >> n) & IDR_MASK];
		}

		id += 1 << n;
		while (n < fls(id)) {
Nadia Derbey's avatar
Nadia Derbey committed
458 459
			if (p)
				free_layer(p);
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
460 461 462 463
			n += IDR_BITS;
			p = *--paa;
		}
	}
Nadia Derbey's avatar
Nadia Derbey committed
464
	rcu_assign_pointer(idp->top, NULL);
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
465 466 467 468
	idp->layers = 0;
}
EXPORT_SYMBOL(idr_remove_all);

Andrew Morton's avatar
Andrew Morton committed
469 470 471 472 473 474 475
/**
 * idr_destroy - release all cached layers within an idr tree
 * idp: idr handle
 */
void idr_destroy(struct idr *idp)
{
	while (idp->id_free_cnt) {
476
		struct idr_layer *p = get_from_free_list(idp);
Andrew Morton's avatar
Andrew Morton committed
477 478 479 480 481
		kmem_cache_free(idr_layer_cache, p);
	}
}
EXPORT_SYMBOL(idr_destroy);

Linus Torvalds's avatar
Linus Torvalds committed
482 483 484 485 486 487 488 489 490
/**
 * idr_find - return pointer for given id
 * @idp: idr handle
 * @id: lookup key
 *
 * Return the pointer given the id it has been registered with.  A %NULL
 * return indicates that @id is not valid or you passed %NULL in
 * idr_get_new().
 *
Nadia Derbey's avatar
Nadia Derbey committed
491 492
 * This function can be called under rcu_read_lock(), given that the leaf
 * pointers lifetimes are correctly managed.
Linus Torvalds's avatar
Linus Torvalds committed
493 494 495 496 497 498
 */
void *idr_find(struct idr *idp, int id)
{
	int n;
	struct idr_layer *p;

Nadia Derbey's avatar
Nadia Derbey committed
499
	p = rcu_dereference(idp->top);
500 501 502
	if (!p)
		return NULL;
	n = (p->layer+1) * IDR_BITS;
Linus Torvalds's avatar
Linus Torvalds committed
503 504 505 506 507 508

	/* Mask off upper bits we don't use for the search. */
	id &= MAX_ID_MASK;

	if (id >= (1 << n))
		return NULL;
509
	BUG_ON(n == 0);
Linus Torvalds's avatar
Linus Torvalds committed
510 511 512

	while (n > 0 && p) {
		n -= IDR_BITS;
513
		BUG_ON(n != p->layer*IDR_BITS);
Nadia Derbey's avatar
Nadia Derbey committed
514
		p = rcu_dereference(p->ary[(id >> n) & IDR_MASK]);
Linus Torvalds's avatar
Linus Torvalds committed
515 516 517 518 519
	}
	return((void *)p);
}
EXPORT_SYMBOL(idr_find);

Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
/**
 * idr_for_each - iterate through all stored pointers
 * @idp: idr handle
 * @fn: function to be called for each pointer
 * @data: data passed back to callback function
 *
 * Iterate over the pointers registered with the given idr.  The
 * callback function will be called for each pointer currently
 * registered, passing the id, the pointer and the data pointer passed
 * to this function.  It is not safe to modify the idr tree while in
 * the callback, so functions such as idr_get_new and idr_remove are
 * not allowed.
 *
 * We check the return of @fn each time. If it returns anything other
 * than 0, we break out and return that value.
 *
 * The caller must serialize idr_for_each() vs idr_get_new() and idr_remove().
 */
int idr_for_each(struct idr *idp,
		 int (*fn)(int id, void *p, void *data), void *data)
{
	int n, id, max, error = 0;
	struct idr_layer *p;
	struct idr_layer *pa[MAX_LEVEL];
	struct idr_layer **paa = &pa[0];

	n = idp->layers * IDR_BITS;
Nadia Derbey's avatar
Nadia Derbey committed
547
	p = rcu_dereference(idp->top);
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
548 549 550 551 552 553 554
	max = 1 << n;

	id = 0;
	while (id < max) {
		while (n > 0 && p) {
			n -= IDR_BITS;
			*paa++ = p;
Nadia Derbey's avatar
Nadia Derbey committed
555
			p = rcu_dereference(p->ary[(id >> n) & IDR_MASK]);
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
		}

		if (p) {
			error = fn(id, (void *)p, data);
			if (error)
				break;
		}

		id += 1 << n;
		while (n < fls(id)) {
			n += IDR_BITS;
			p = *--paa;
		}
	}

	return error;
}
EXPORT_SYMBOL(idr_for_each);

Jeff Mahoney's avatar
Jeff Mahoney committed
575 576 577 578 579 580 581 582 583 584
/**
 * idr_replace - replace pointer for given id
 * @idp: idr handle
 * @ptr: pointer you want associated with the id
 * @id: lookup key
 *
 * Replace the pointer registered with an id and return the old value.
 * A -ENOENT return indicates that @id was not found.
 * A -EINVAL return indicates that @id was not within valid constraints.
 *
Nadia Derbey's avatar
Nadia Derbey committed
585
 * The caller must serialize with writers.
Jeff Mahoney's avatar
Jeff Mahoney committed
586 587 588 589 590 591 592
 */
void *idr_replace(struct idr *idp, void *ptr, int id)
{
	int n;
	struct idr_layer *p, *old_p;

	p = idp->top;
593 594 595 596
	if (!p)
		return ERR_PTR(-EINVAL);

	n = (p->layer+1) * IDR_BITS;
Jeff Mahoney's avatar
Jeff Mahoney committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

	id &= MAX_ID_MASK;

	if (id >= (1 << n))
		return ERR_PTR(-EINVAL);

	n -= IDR_BITS;
	while ((n > 0) && p) {
		p = p->ary[(id >> n) & IDR_MASK];
		n -= IDR_BITS;
	}

	n = id & IDR_MASK;
	if (unlikely(p == NULL || !test_bit(n, &p->bitmap)))
		return ERR_PTR(-ENOENT);

	old_p = p->ary[n];
Nadia Derbey's avatar
Nadia Derbey committed
614
	rcu_assign_pointer(p->ary[n], ptr);
Jeff Mahoney's avatar
Jeff Mahoney committed
615 616 617 618 619

	return old_p;
}
EXPORT_SYMBOL(idr_replace);

620
static void idr_cache_ctor(void *idr_layer)
Linus Torvalds's avatar
Linus Torvalds committed
621 622 623 624
{
	memset(idr_layer, 0, sizeof(struct idr_layer));
}

625
void __init idr_init_cache(void)
Linus Torvalds's avatar
Linus Torvalds committed
626
{
627 628 629
	idr_layer_cache = kmem_cache_create("idr_layer_cache",
				sizeof(struct idr_layer), 0, SLAB_PANIC,
				idr_cache_ctor);
Linus Torvalds's avatar
Linus Torvalds committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
}

/**
 * idr_init - initialize idr handle
 * @idp:	idr handle
 *
 * This function is use to set up the handle (@idp) that you will pass
 * to the rest of the functions.
 */
void idr_init(struct idr *idp)
{
	memset(idp, 0, sizeof(struct idr));
	spin_lock_init(&idp->lock);
}
EXPORT_SYMBOL(idr_init);
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733


/*
 * IDA - IDR based ID allocator
 *
 * this is id allocator without id -> pointer translation.  Memory
 * usage is much lower than full blown idr because each id only
 * occupies a bit.  ida uses a custom leaf node which contains
 * IDA_BITMAP_BITS slots.
 *
 * 2007-04-25  written by Tejun Heo <htejun@gmail.com>
 */

static void free_bitmap(struct ida *ida, struct ida_bitmap *bitmap)
{
	unsigned long flags;

	if (!ida->free_bitmap) {
		spin_lock_irqsave(&ida->idr.lock, flags);
		if (!ida->free_bitmap) {
			ida->free_bitmap = bitmap;
			bitmap = NULL;
		}
		spin_unlock_irqrestore(&ida->idr.lock, flags);
	}

	kfree(bitmap);
}

/**
 * ida_pre_get - reserve resources for ida allocation
 * @ida:	ida handle
 * @gfp_mask:	memory allocation flag
 *
 * This function should be called prior to locking and calling the
 * following function.  It preallocates enough memory to satisfy the
 * worst possible allocation.
 *
 * If the system is REALLY out of memory this function returns 0,
 * otherwise 1.
 */
int ida_pre_get(struct ida *ida, gfp_t gfp_mask)
{
	/* allocate idr_layers */
	if (!idr_pre_get(&ida->idr, gfp_mask))
		return 0;

	/* allocate free_bitmap */
	if (!ida->free_bitmap) {
		struct ida_bitmap *bitmap;

		bitmap = kmalloc(sizeof(struct ida_bitmap), gfp_mask);
		if (!bitmap)
			return 0;

		free_bitmap(ida, bitmap);
	}

	return 1;
}
EXPORT_SYMBOL(ida_pre_get);

/**
 * ida_get_new_above - allocate new ID above or equal to a start id
 * @ida:	ida handle
 * @staring_id:	id to start search at
 * @p_id:	pointer to the allocated handle
 *
 * Allocate new ID above or equal to @ida.  It should be called with
 * any required locks.
 *
 * If memory is required, it will return -EAGAIN, you should unlock
 * and go back to the ida_pre_get() call.  If the ida is full, it will
 * return -ENOSPC.
 *
 * @p_id returns a value in the range 0 ... 0x7fffffff.
 */
int ida_get_new_above(struct ida *ida, int starting_id, int *p_id)
{
	struct idr_layer *pa[MAX_LEVEL];
	struct ida_bitmap *bitmap;
	unsigned long flags;
	int idr_id = starting_id / IDA_BITMAP_BITS;
	int offset = starting_id % IDA_BITMAP_BITS;
	int t, id;

 restart:
	/* get vacant slot */
	t = idr_get_empty_slot(&ida->idr, idr_id, pa);
734 735
	if (t < 0)
		return _idr_rc_to_errno(t);
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

	if (t * IDA_BITMAP_BITS >= MAX_ID_BIT)
		return -ENOSPC;

	if (t != idr_id)
		offset = 0;
	idr_id = t;

	/* if bitmap isn't there, create a new one */
	bitmap = (void *)pa[0]->ary[idr_id & IDR_MASK];
	if (!bitmap) {
		spin_lock_irqsave(&ida->idr.lock, flags);
		bitmap = ida->free_bitmap;
		ida->free_bitmap = NULL;
		spin_unlock_irqrestore(&ida->idr.lock, flags);

		if (!bitmap)
			return -EAGAIN;

		memset(bitmap, 0, sizeof(struct ida_bitmap));
Nadia Derbey's avatar
Nadia Derbey committed
756 757
		rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
				(void *)bitmap);
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
		pa[0]->count++;
	}

	/* lookup for empty slot */
	t = find_next_zero_bit(bitmap->bitmap, IDA_BITMAP_BITS, offset);
	if (t == IDA_BITMAP_BITS) {
		/* no empty slot after offset, continue to the next chunk */
		idr_id++;
		offset = 0;
		goto restart;
	}

	id = idr_id * IDA_BITMAP_BITS + t;
	if (id >= MAX_ID_BIT)
		return -ENOSPC;

	__set_bit(t, bitmap->bitmap);
	if (++bitmap->nr_busy == IDA_BITMAP_BITS)
		idr_mark_full(pa, idr_id);

	*p_id = id;

	/* Each leaf node can handle nearly a thousand slots and the
	 * whole idea of ida is to have small memory foot print.
	 * Throw away extra resources one by one after each successful
	 * allocation.
	 */
	if (ida->idr.id_free_cnt || ida->free_bitmap) {
786
		struct idr_layer *p = get_from_free_list(&ida->idr);
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
		if (p)
			kmem_cache_free(idr_layer_cache, p);
	}

	return 0;
}
EXPORT_SYMBOL(ida_get_new_above);

/**
 * ida_get_new - allocate new ID
 * @ida:	idr handle
 * @p_id:	pointer to the allocated handle
 *
 * Allocate new ID.  It should be called with any required locks.
 *
 * If memory is required, it will return -EAGAIN, you should unlock
 * and go back to the idr_pre_get() call.  If the idr is full, it will
 * return -ENOSPC.
 *
 * @id returns a value in the range 0 ... 0x7fffffff.
 */
int ida_get_new(struct ida *ida, int *p_id)
{
	return ida_get_new_above(ida, 0, p_id);
}
EXPORT_SYMBOL(ida_get_new);

/**
 * ida_remove - remove the given ID
 * @ida:	ida handle
 * @id:		ID to free
 */
void ida_remove(struct ida *ida, int id)
{
	struct idr_layer *p = ida->idr.top;
	int shift = (ida->idr.layers - 1) * IDR_BITS;
	int idr_id = id / IDA_BITMAP_BITS;
	int offset = id % IDA_BITMAP_BITS;
	int n;
	struct ida_bitmap *bitmap;

	/* clear full bits while looking up the leaf idr_layer */
	while ((shift > 0) && p) {
		n = (idr_id >> shift) & IDR_MASK;
		__clear_bit(n, &p->bitmap);
		p = p->ary[n];
		shift -= IDR_BITS;
	}

	if (p == NULL)
		goto err;

	n = idr_id & IDR_MASK;
	__clear_bit(n, &p->bitmap);

	bitmap = (void *)p->ary[n];
	if (!test_bit(offset, bitmap->bitmap))
		goto err;

	/* update bitmap and remove it if empty */
	__clear_bit(offset, bitmap->bitmap);
	if (--bitmap->nr_busy == 0) {
		__set_bit(n, &p->bitmap);	/* to please idr_remove() */
		idr_remove(&ida->idr, idr_id);
		free_bitmap(ida, bitmap);
	}

	return;

 err:
	printk(KERN_WARNING
	       "ida_remove called for id=%d which is not allocated.\n", id);
}
EXPORT_SYMBOL(ida_remove);

/**
 * ida_destroy - release all cached layers within an ida tree
 * ida:		ida handle
 */
void ida_destroy(struct ida *ida)
{
	idr_destroy(&ida->idr);
	kfree(ida->free_bitmap);
}
EXPORT_SYMBOL(ida_destroy);

/**
 * ida_init - initialize ida handle
 * @ida:	ida handle
 *
 * This function is use to set up the handle (@ida) that you will pass
 * to the rest of the functions.
 */
void ida_init(struct ida *ida)
{
	memset(ida, 0, sizeof(struct ida));
	idr_init(&ida->idr);

}
EXPORT_SYMBOL(ida_init);