Blame view

lib/idr.c 23.4 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
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.
   *
3219b3b74   Nadia Derbey   idr: make idr_get...
9
10
   * Modified by Nadia Derbey to make it RCU safe.
   *
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
11
   * Small id to pointer translation service.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
12
   *
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
13
   * It uses a radix tree like structure as a sparse array indexed
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
14
   * by the id to obtain the pointer.  The bitmap makes allocating
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
15
   * a new id quick.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
16
17
18
19
20
   *
   * 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.
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
21
   * You can release ids at any time. When all ids are released, most of
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
22
   * the memory is returned (we keep IDR_FREE_MAX) in a local pool so we
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
23
   * don't need to go to the memory "store" during an id allocate, just
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
24
25
26
27
28
29
30
31
32
   * 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
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
33
  #include <linux/err.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
34
35
  #include <linux/string.h>
  #include <linux/idr.h>
88eca0207   Rusty Russell   ida: simplified f...
36
  #include <linux/spinlock.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
37

e18b890bb   Christoph Lameter   [PATCH] slab: rem...
38
  static struct kmem_cache *idr_layer_cache;
88eca0207   Rusty Russell   ida: simplified f...
39
  static DEFINE_SPINLOCK(simple_ida_lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
40

4ae537892   Nadia Derbey   idr: rename some ...
41
  static struct idr_layer *get_from_free_list(struct idr *idp)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42
43
  {
  	struct idr_layer *p;
c259cc281   Roland Dreier   [PATCH] Convert i...
44
  	unsigned long flags;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
45

c259cc281   Roland Dreier   [PATCH] Convert i...
46
  	spin_lock_irqsave(&idp->lock, flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
48
49
50
51
  	if ((p = idp->id_free)) {
  		idp->id_free = p->ary[0];
  		idp->id_free_cnt--;
  		p->ary[0] = NULL;
  	}
c259cc281   Roland Dreier   [PATCH] Convert i...
52
  	spin_unlock_irqrestore(&idp->lock, flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
53
54
  	return(p);
  }
cf481c20c   Nadia Derbey   idr: make idr_rem...
55
56
57
58
59
60
61
62
63
64
65
66
  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);
  }
1eec00565   Sonny Rao   [PATCH] fix race ...
67
  /* only called when idp->lock is held */
4ae537892   Nadia Derbey   idr: rename some ...
68
  static void __move_to_free_list(struct idr *idp, struct idr_layer *p)
1eec00565   Sonny Rao   [PATCH] fix race ...
69
70
71
72
73
  {
  	p->ary[0] = idp->id_free;
  	idp->id_free = p;
  	idp->id_free_cnt++;
  }
4ae537892   Nadia Derbey   idr: rename some ...
74
  static void move_to_free_list(struct idr *idp, struct idr_layer *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
75
  {
c259cc281   Roland Dreier   [PATCH] Convert i...
76
  	unsigned long flags;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
77
78
79
  	/*
  	 * Depends on the return element being zeroed.
  	 */
c259cc281   Roland Dreier   [PATCH] Convert i...
80
  	spin_lock_irqsave(&idp->lock, flags);
4ae537892   Nadia Derbey   idr: rename some ...
81
  	__move_to_free_list(idp, p);
c259cc281   Roland Dreier   [PATCH] Convert i...
82
  	spin_unlock_irqrestore(&idp->lock, flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
83
  }
e33ac8bdb   Tejun Heo   idr: separate out...
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
  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);
  	}
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
103
  /**
56083ab17   Randy Dunlap   docbook: add idr/...
104
   * idr_pre_get - reserve resources for idr allocation
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
105
106
107
   * @idp:	idr handle
   * @gfp_mask:	memory allocation flags
   *
066a9be6c   Naohiro Aota   idr: fix idr_pre_...
108
109
110
111
   * This function should be called prior to calling the idr_get_new* functions.
   * It preallocates enough memory to satisfy the worst possible allocation. The
   * caller should pass in GFP_KERNEL if possible.  This of course requires that
   * no spinning locks be held.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
112
   *
56083ab17   Randy Dunlap   docbook: add idr/...
113
114
   * If the system is REALLY out of memory this function returns %0,
   * otherwise %1.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
115
   */
fd4f2df24   Al Viro   [PATCH] gfp_t: lib/*
116
  int idr_pre_get(struct idr *idp, gfp_t gfp_mask)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
117
118
119
  {
  	while (idp->id_free_cnt < IDR_FREE_MAX) {
  		struct idr_layer *new;
5b019e990   Andrew Morton   lib/idr.c: use km...
120
  		new = kmem_cache_zalloc(idr_layer_cache, gfp_mask);
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
121
  		if (new == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
122
  			return (0);
4ae537892   Nadia Derbey   idr: rename some ...
123
  		move_to_free_list(idp, new);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
124
125
126
127
  	}
  	return 1;
  }
  EXPORT_SYMBOL(idr_pre_get);
e33ac8bdb   Tejun Heo   idr: separate out...
128
  static int sub_alloc(struct idr *idp, int *starting_id, struct idr_layer **pa)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
129
130
131
  {
  	int n, m, sh;
  	struct idr_layer *p, *new;
7aae6dd80   Tejun Heo   idr: fix obscure ...
132
  	int l, id, oid;
5ba253313   Al Viro   more low-hanging ...
133
  	unsigned long bm;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
134
135
  
  	id = *starting_id;
7aae6dd80   Tejun Heo   idr: fix obscure ...
136
   restart:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
137
138
139
140
141
142
143
144
145
146
147
148
149
  	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++;
7aae6dd80   Tejun Heo   idr: fix obscure ...
150
  			oid = id;
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
151
  			id = (id | ((1 << (IDR_BITS * l)) - 1)) + 1;
7aae6dd80   Tejun Heo   idr: fix obscure ...
152
153
  
  			/* if already at the top layer, we need to grow */
d2e7276b6   Tejun Heo   idr: fix a critic...
154
  			if (id >= 1 << (idp->layers * IDR_BITS)) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
155
  				*starting_id = id;
944ca05c7   Nadia Derbey   idr: error checki...
156
  				return IDR_NEED_TO_GROW;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
157
  			}
d2e7276b6   Tejun Heo   idr: fix a critic...
158
159
  			p = pa[l];
  			BUG_ON(!p);
7aae6dd80   Tejun Heo   idr: fix obscure ...
160
161
162
163
164
165
166
167
168
  
  			/* 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;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
169
170
171
172
173
174
  		}
  		if (m != n) {
  			sh = IDR_BITS*l;
  			id = ((id >> sh) ^ n ^ m) << sh;
  		}
  		if ((id >= MAX_ID_BIT) || (id < 0))
944ca05c7   Nadia Derbey   idr: error checki...
175
  			return IDR_NOMORE_SPACE;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
176
177
178
179
180
181
  		if (l == 0)
  			break;
  		/*
  		 * Create the layer below if it is missing.
  		 */
  		if (!p->ary[m]) {
4ae537892   Nadia Derbey   idr: rename some ...
182
183
  			new = get_from_free_list(idp);
  			if (!new)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
184
  				return -1;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
185
  			new->layer = l-1;
3219b3b74   Nadia Derbey   idr: make idr_get...
186
  			rcu_assign_pointer(p->ary[m], new);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
187
188
189
190
191
  			p->count++;
  		}
  		pa[l--] = p;
  		p = p->ary[m];
  	}
e33ac8bdb   Tejun Heo   idr: separate out...
192
193
194
  
  	pa[l] = p;
  	return id;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
195
  }
e33ac8bdb   Tejun Heo   idr: separate out...
196
197
  static int idr_get_empty_slot(struct idr *idp, int starting_id,
  			      struct idr_layer **pa)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
198
199
200
  {
  	struct idr_layer *p, *new;
  	int layers, v, id;
c259cc281   Roland Dreier   [PATCH] Convert i...
201
  	unsigned long flags;
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
202

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
203
204
205
206
207
  	id = starting_id;
  build_up:
  	p = idp->top;
  	layers = idp->layers;
  	if (unlikely(!p)) {
4ae537892   Nadia Derbey   idr: rename some ...
208
  		if (!(p = get_from_free_list(idp)))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
209
  			return -1;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
210
  		p->layer = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
211
212
213
214
215
216
  		layers = 1;
  	}
  	/*
  	 * Add a new layer to the top of the tree if the requested
  	 * id is larger than the currently allocated space.
  	 */
589777eab   Zaur Kambarov   [PATCH] coverity:...
217
  	while ((layers < (MAX_LEVEL - 1)) && (id >= (1 << (layers*IDR_BITS)))) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
218
  		layers++;
711a49a07   Manfred Spraul   lib/idr.c: Fix bu...
219
220
221
222
223
224
  		if (!p->count) {
  			/* special case: if the tree is currently empty,
  			 * then we grow the tree by moving the top node
  			 * upwards.
  			 */
  			p->layer++;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
225
  			continue;
711a49a07   Manfred Spraul   lib/idr.c: Fix bu...
226
  		}
4ae537892   Nadia Derbey   idr: rename some ...
227
  		if (!(new = get_from_free_list(idp))) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
228
229
230
231
  			/*
  			 * The allocation failed.  If we built part of
  			 * the structure tear it down.
  			 */
c259cc281   Roland Dreier   [PATCH] Convert i...
232
  			spin_lock_irqsave(&idp->lock, flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
233
234
235
236
  			for (new = p; p && p != idp->top; new = p) {
  				p = p->ary[0];
  				new->ary[0] = NULL;
  				new->bitmap = new->count = 0;
4ae537892   Nadia Derbey   idr: rename some ...
237
  				__move_to_free_list(idp, new);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
238
  			}
c259cc281   Roland Dreier   [PATCH] Convert i...
239
  			spin_unlock_irqrestore(&idp->lock, flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
240
241
242
243
  			return -1;
  		}
  		new->ary[0] = p;
  		new->count = 1;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
244
  		new->layer = layers-1;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
245
246
247
248
  		if (p->bitmap == IDR_FULL)
  			__set_bit(0, &new->bitmap);
  		p = new;
  	}
3219b3b74   Nadia Derbey   idr: make idr_get...
249
  	rcu_assign_pointer(idp->top, p);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
250
  	idp->layers = layers;
e33ac8bdb   Tejun Heo   idr: separate out...
251
  	v = sub_alloc(idp, &id, pa);
944ca05c7   Nadia Derbey   idr: error checki...
252
  	if (v == IDR_NEED_TO_GROW)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
253
254
255
  		goto build_up;
  	return(v);
  }
e33ac8bdb   Tejun Heo   idr: separate out...
256
257
258
259
260
261
262
263
264
265
266
  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.
  		 */
3219b3b74   Nadia Derbey   idr: make idr_get...
267
268
  		rcu_assign_pointer(pa[0]->ary[id & IDR_MASK],
  				(struct idr_layer *)ptr);
e33ac8bdb   Tejun Heo   idr: separate out...
269
270
271
272
273
274
  		pa[0]->count++;
  		idr_mark_full(pa, id);
  	}
  
  	return id;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
275
  /**
7c657f2f2   John McCutchan   [PATCH] Document ...
276
   * idr_get_new_above - allocate new idr entry above or equal to a start id
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
277
   * @idp: idr handle
94e2bd688   Thadeu Lima de Souza Cascardo   tree-wide: fix so...
278
   * @ptr: pointer you want associated with the id
ea24ea850   Naohiro Aota   idr: fix kernel-d...
279
   * @starting_id: id to start search at
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
280
281
282
283
284
   * @id: pointer to the allocated handle
   *
   * This is the allocate id function.  It should be called with any
   * required locks.
   *
066a9be6c   Naohiro Aota   idr: fix idr_pre_...
285
   * If allocation from IDR's private freelist fails, idr_get_new_above() will
56083ab17   Randy Dunlap   docbook: add idr/...
286
   * return %-EAGAIN.  The caller should retry the idr_pre_get() call to refill
066a9be6c   Naohiro Aota   idr: fix idr_pre_...
287
288
   * IDR's preallocation and then retry the idr_get_new_above() call.
   *
56083ab17   Randy Dunlap   docbook: add idr/...
289
   * If the idr is full idr_get_new_above() will return %-ENOSPC.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
290
   *
56083ab17   Randy Dunlap   docbook: add idr/...
291
   * @id returns a value in the range @starting_id ... %0x7fffffff
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
292
293
294
295
   */
  int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id)
  {
  	int rv;
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
296

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
297
298
299
300
301
  	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.
  	 */
944ca05c7   Nadia Derbey   idr: error checki...
302
303
  	if (rv < 0)
  		return _idr_rc_to_errno(rv);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
304
305
306
307
308
309
310
311
  	*id = rv;
  	return 0;
  }
  EXPORT_SYMBOL(idr_get_new_above);
  
  /**
   * idr_get_new - allocate new idr entry
   * @idp: idr handle
94e2bd688   Thadeu Lima de Souza Cascardo   tree-wide: fix so...
312
   * @ptr: pointer you want associated with the id
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
313
314
   * @id: pointer to the allocated handle
   *
066a9be6c   Naohiro Aota   idr: fix idr_pre_...
315
   * If allocation from IDR's private freelist fails, idr_get_new_above() will
56083ab17   Randy Dunlap   docbook: add idr/...
316
   * return %-EAGAIN.  The caller should retry the idr_pre_get() call to refill
066a9be6c   Naohiro Aota   idr: fix idr_pre_...
317
   * IDR's preallocation and then retry the idr_get_new_above() call.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
318
   *
56083ab17   Randy Dunlap   docbook: add idr/...
319
   * If the idr is full idr_get_new_above() will return %-ENOSPC.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
320
   *
56083ab17   Randy Dunlap   docbook: add idr/...
321
   * @id returns a value in the range %0 ... %0x7fffffff
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
322
323
324
325
   */
  int idr_get_new(struct idr *idp, void *ptr, int *id)
  {
  	int rv;
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
326

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
327
328
329
330
331
  	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.
  	 */
944ca05c7   Nadia Derbey   idr: error checki...
332
333
  	if (rv < 0)
  		return _idr_rc_to_errno(rv);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
334
335
336
337
338
339
340
  	*id = rv;
  	return 0;
  }
  EXPORT_SYMBOL(idr_get_new);
  
  static void idr_remove_warning(int id)
  {
f098ad655   Nadia Derbey   idr: fix a printk...
341
342
343
  	printk(KERN_WARNING
  		"idr_remove called for id=%d which is not allocated.
  ", id);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
344
345
346
347
348
349
350
351
  	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];
cf481c20c   Nadia Derbey   idr: make idr_rem...
352
  	struct idr_layer *to_free;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
  	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);
cf481c20c   Nadia Derbey   idr: make idr_rem...
368
369
  		rcu_assign_pointer(p->ary[n], NULL);
  		to_free = NULL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
370
  		while(*paa && ! --((**paa)->count)){
cf481c20c   Nadia Derbey   idr: make idr_rem...
371
372
373
  			if (to_free)
  				free_layer(to_free);
  			to_free = **paa;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
374
375
  			**paa-- = NULL;
  		}
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
376
  		if (!*paa)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
377
  			idp->layers = 0;
cf481c20c   Nadia Derbey   idr: make idr_rem...
378
379
  		if (to_free)
  			free_layer(to_free);
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
380
  	} else
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
381
  		idr_remove_warning(id);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
382
383
384
  }
  
  /**
56083ab17   Randy Dunlap   docbook: add idr/...
385
   * idr_remove - remove the given id and free its slot
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
386
387
   * @idp: idr handle
   * @id: unique key
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
388
389
390
391
   */
  void idr_remove(struct idr *idp, int id)
  {
  	struct idr_layer *p;
cf481c20c   Nadia Derbey   idr: make idr_rem...
392
  	struct idr_layer *to_free;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
393
394
395
396
397
  
  	/* Mask off upper bits we don't use for the search. */
  	id &= MAX_ID_MASK;
  
  	sub_remove(idp, (idp->layers - 1) * IDR_BITS, id);
e15ae2dd3   Jesper Juhl   [PATCH] Whitespac...
398
  	if (idp->top && idp->top->count == 1 && (idp->layers > 1) &&
cf481c20c   Nadia Derbey   idr: make idr_rem...
399
400
401
402
403
404
405
406
  	    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;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
407
  		p = idp->top->ary[0];
cf481c20c   Nadia Derbey   idr: make idr_rem...
408
  		rcu_assign_pointer(idp->top, p);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
409
  		--idp->layers;
cf481c20c   Nadia Derbey   idr: make idr_rem...
410
411
  		to_free->bitmap = to_free->count = 0;
  		free_layer(to_free);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
412
413
  	}
  	while (idp->id_free_cnt >= IDR_FREE_MAX) {
4ae537892   Nadia Derbey   idr: rename some ...
414
  		p = get_from_free_list(idp);
cf481c20c   Nadia Derbey   idr: make idr_rem...
415
416
417
418
419
  		/*
  		 * Note: we don't call the rcu callback here, since the only
  		 * layers that fall into the freelist are those that have been
  		 * preallocated.
  		 */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
420
  		kmem_cache_free(idr_layer_cache, p);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
421
  	}
af8e2a4cb   Nadia Derbey   idr: fix idr_remo...
422
  	return;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
423
424
425
426
  }
  EXPORT_SYMBOL(idr_remove);
  
  /**
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
427
428
429
430
431
432
433
   * 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.
   *
56083ab17   Randy Dunlap   docbook: add idr/...
434
   * A typical clean-up sequence for objects stored in an idr tree will
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
435
436
437
438
439
440
   * 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)
  {
6ace06dc6   Oleg Nesterov   idr_remove_all: k...
441
  	int n, id, max;
2dcb22b34   Imre Deak   idr: fix backtrac...
442
  	int bt_mask;
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
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;
1b23336ad   Paul E. McKenney   idr: make idr_rem...
449
  	rcu_assign_pointer(idp->top, NULL);
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
450
451
452
  	max = 1 << n;
  
  	id = 0;
6ace06dc6   Oleg Nesterov   idr_remove_all: k...
453
  	while (id < max) {
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
454
455
456
457
458
  		while (n > IDR_BITS && p) {
  			n -= IDR_BITS;
  			*paa++ = p;
  			p = p->ary[(id >> n) & IDR_MASK];
  		}
2dcb22b34   Imre Deak   idr: fix backtrac...
459
  		bt_mask = id;
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
460
  		id += 1 << n;
2dcb22b34   Imre Deak   idr: fix backtrac...
461
462
  		/* Get the highest bit that the above add changed from 0->1. */
  		while (n < fls(id ^ bt_mask)) {
cf481c20c   Nadia Derbey   idr: make idr_rem...
463
464
  			if (p)
  				free_layer(p);
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
465
466
467
468
  			n += IDR_BITS;
  			p = *--paa;
  		}
  	}
23936cc0b   Kristian Hoegsberg   lib: add idr_remo...
469
470
471
472
473
  	idp->layers = 0;
  }
  EXPORT_SYMBOL(idr_remove_all);
  
  /**
8d3b35914   Andrew Morton   [PATCH] inotify/i...
474
   * idr_destroy - release all cached layers within an idr tree
ea24ea850   Naohiro Aota   idr: fix kernel-d...
475
   * @idp: idr handle
8d3b35914   Andrew Morton   [PATCH] inotify/i...
476
477
478
479
   */
  void idr_destroy(struct idr *idp)
  {
  	while (idp->id_free_cnt) {
4ae537892   Nadia Derbey   idr: rename some ...
480
  		struct idr_layer *p = get_from_free_list(idp);
8d3b35914   Andrew Morton   [PATCH] inotify/i...
481
482
483
484
485
486
  		kmem_cache_free(idr_layer_cache, p);
  	}
  }
  EXPORT_SYMBOL(idr_destroy);
  
  /**
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
487
488
489
490
491
492
493
494
   * 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().
   *
f9c46d6ea   Nadia Derbey   idr: make idr_fin...
495
496
   * This function can be called under rcu_read_lock(), given that the leaf
   * pointers lifetimes are correctly managed.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
497
498
499
500
501
   */
  void *idr_find(struct idr *idp, int id)
  {
  	int n;
  	struct idr_layer *p;
96be753af   Paul E. McKenney   idr: Apply lockde...
502
  	p = rcu_dereference_raw(idp->top);
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
503
504
505
  	if (!p)
  		return NULL;
  	n = (p->layer+1) * IDR_BITS;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
506
507
508
509
510
511
  
  	/* Mask off upper bits we don't use for the search. */
  	id &= MAX_ID_MASK;
  
  	if (id >= (1 << n))
  		return NULL;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
512
  	BUG_ON(n == 0);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
513
514
515
  
  	while (n > 0 && p) {
  		n -= IDR_BITS;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
516
  		BUG_ON(n != p->layer*IDR_BITS);
96be753af   Paul E. McKenney   idr: Apply lockde...
517
  		p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
518
519
520
521
  	}
  	return((void *)p);
  }
  EXPORT_SYMBOL(idr_find);
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
522
  /**
96d7fa421   Kristian Hoegsberg   lib: add idr_for_...
523
524
525
526
527
528
529
530
531
532
533
534
535
   * 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
56083ab17   Randy Dunlap   docbook: add idr/...
536
   * than %0, we break out and return that value.
96d7fa421   Kristian Hoegsberg   lib: add idr_for_...
537
538
539
540
541
542
543
544
545
546
547
548
   *
   * 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;
96be753af   Paul E. McKenney   idr: Apply lockde...
549
  	p = rcu_dereference_raw(idp->top);
96d7fa421   Kristian Hoegsberg   lib: add idr_for_...
550
551
552
553
554
555
556
  	max = 1 << n;
  
  	id = 0;
  	while (id < max) {
  		while (n > 0 && p) {
  			n -= IDR_BITS;
  			*paa++ = p;
96be753af   Paul E. McKenney   idr: Apply lockde...
557
  			p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
96d7fa421   Kristian Hoegsberg   lib: add idr_for_...
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
  		}
  
  		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);
  
  /**
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
578
579
   * idr_get_next - lookup next object of id to given id.
   * @idp: idr handle
ea24ea850   Naohiro Aota   idr: fix kernel-d...
580
   * @nextidp:  pointer to lookup key
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
581
582
   *
   * Returns pointer to registered object with id, which is next number to
1458ce166   Naohiro Aota   idr: describe how...
583
584
   * given id. After being looked up, *@nextidp will be updated for the next
   * iteration.
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
585
586
587
588
589
590
591
592
593
594
595
596
   */
  
  void *idr_get_next(struct idr *idp, int *nextidp)
  {
  	struct idr_layer *p, *pa[MAX_LEVEL];
  	struct idr_layer **paa = &pa[0];
  	int id = *nextidp;
  	int n, max;
  
  	/* find first ent */
  	n = idp->layers * IDR_BITS;
  	max = 1 << n;
94bfa3b66   Paul E. McKenney   idr: fix RCU lock...
597
  	p = rcu_dereference_raw(idp->top);
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
598
599
600
601
602
603
604
  	if (!p)
  		return NULL;
  
  	while (id < max) {
  		while (n > 0 && p) {
  			n -= IDR_BITS;
  			*paa++ = p;
94bfa3b66   Paul E. McKenney   idr: fix RCU lock...
605
  			p = rcu_dereference_raw(p->ary[(id >> n) & IDR_MASK]);
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
  		}
  
  		if (p) {
  			*nextidp = id;
  			return p;
  		}
  
  		id += 1 << n;
  		while (n < fls(id)) {
  			n += IDR_BITS;
  			p = *--paa;
  		}
  	}
  	return NULL;
  }
4d1ee80f3   Ben Hutchings   idr: export idr_g...
621
  EXPORT_SYMBOL(idr_get_next);
38460b48d   KAMEZAWA Hiroyuki   cgroup: CSS ID su...
622
623
624
  
  
  /**
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
625
626
627
628
629
630
   * 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.
56083ab17   Randy Dunlap   docbook: add idr/...
631
632
   * A %-ENOENT return indicates that @id was not found.
   * A %-EINVAL return indicates that @id was not within valid constraints.
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
633
   *
cf481c20c   Nadia Derbey   idr: make idr_rem...
634
   * The caller must serialize with writers.
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
635
636
637
638
639
   */
  void *idr_replace(struct idr *idp, void *ptr, int id)
  {
  	int n;
  	struct idr_layer *p, *old_p;
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
640
  	p = idp->top;
6ff2d39b9   Manfred Spraul   lib/idr.c: fix rc...
641
642
643
644
  	if (!p)
  		return ERR_PTR(-EINVAL);
  
  	n = (p->layer+1) * IDR_BITS;
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
  
  	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];
cf481c20c   Nadia Derbey   idr: make idr_rem...
662
  	rcu_assign_pointer(p->ary[n], ptr);
5806f07cd   Jeff Mahoney   [PATCH] lib: add ...
663
664
665
666
  
  	return old_p;
  }
  EXPORT_SYMBOL(idr_replace);
199f0ca51   Akinobu Mita   idr: create idr_l...
667
  void __init idr_init_cache(void)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
668
  {
199f0ca51   Akinobu Mita   idr: create idr_l...
669
  	idr_layer_cache = kmem_cache_create("idr_layer_cache",
5b019e990   Andrew Morton   lib/idr.c: use km...
670
  				sizeof(struct idr_layer), 0, SLAB_PANIC, NULL);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
671
672
673
674
675
676
677
678
679
680
681
  }
  
  /**
   * 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)
  {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
682
683
684
685
  	memset(idp, 0, sizeof(struct idr));
  	spin_lock_init(&idp->lock);
  }
  EXPORT_SYMBOL(idr_init);
72dba584b   Tejun Heo   ida: implement id...
686

56083ab17   Randy Dunlap   docbook: add idr/...
687
688
  /**
   * DOC: IDA description
72dba584b   Tejun Heo   ida: implement id...
689
690
   * IDA - IDR based ID allocator
   *
56083ab17   Randy Dunlap   docbook: add idr/...
691
   * This is id allocator without id -> pointer translation.  Memory
72dba584b   Tejun Heo   ida: implement id...
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
   * 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.
   *
56083ab17   Randy Dunlap   docbook: add idr/...
724
725
   * If the system is REALLY out of memory this function returns %0,
   * otherwise %1.
72dba584b   Tejun Heo   ida: implement id...
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
   */
  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
ea24ea850   Naohiro Aota   idr: fix kernel-d...
751
   * @starting_id: id to start search at
72dba584b   Tejun Heo   ida: implement id...
752
753
   * @p_id:	pointer to the allocated handle
   *
e3816c540   Wang Sheng-Hui   lib/idr.c: fix co...
754
755
   * Allocate new ID above or equal to @starting_id.  It should be called
   * with any required locks.
72dba584b   Tejun Heo   ida: implement id...
756
   *
56083ab17   Randy Dunlap   docbook: add idr/...
757
   * If memory is required, it will return %-EAGAIN, you should unlock
72dba584b   Tejun Heo   ida: implement id...
758
   * and go back to the ida_pre_get() call.  If the ida is full, it will
56083ab17   Randy Dunlap   docbook: add idr/...
759
   * return %-ENOSPC.
72dba584b   Tejun Heo   ida: implement id...
760
   *
56083ab17   Randy Dunlap   docbook: add idr/...
761
   * @p_id returns a value in the range @starting_id ... %0x7fffffff.
72dba584b   Tejun Heo   ida: implement id...
762
763
764
765
766
767
768
769
770
771
772
773
774
   */
  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);
944ca05c7   Nadia Derbey   idr: error checki...
775
776
  	if (t < 0)
  		return _idr_rc_to_errno(t);
72dba584b   Tejun Heo   ida: implement id...
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
  
  	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));
3219b3b74   Nadia Derbey   idr: make idr_get...
797
798
  		rcu_assign_pointer(pa[0]->ary[idr_id & IDR_MASK],
  				(void *)bitmap);
72dba584b   Tejun Heo   ida: implement id...
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
  		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) {
4ae537892   Nadia Derbey   idr: rename some ...
827
  		struct idr_layer *p = get_from_free_list(&ida->idr);
72dba584b   Tejun Heo   ida: implement id...
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
  		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.
   *
56083ab17   Randy Dunlap   docbook: add idr/...
843
   * If memory is required, it will return %-EAGAIN, you should unlock
72dba584b   Tejun Heo   ida: implement id...
844
   * and go back to the idr_pre_get() call.  If the idr is full, it will
56083ab17   Randy Dunlap   docbook: add idr/...
845
   * return %-ENOSPC.
72dba584b   Tejun Heo   ida: implement id...
846
   *
f5c3dd719   Paul Bolle   Fix kernel-doc co...
847
   * @p_id returns a value in the range %0 ... %0x7fffffff.
72dba584b   Tejun Heo   ida: implement id...
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
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
   */
  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.
  ", id);
  }
  EXPORT_SYMBOL(ida_remove);
  
  /**
   * ida_destroy - release all cached layers within an ida tree
ea24ea850   Naohiro Aota   idr: fix kernel-d...
906
   * @ida:		ida handle
72dba584b   Tejun Heo   ida: implement id...
907
908
909
910
911
912
913
914
915
   */
  void ida_destroy(struct ida *ida)
  {
  	idr_destroy(&ida->idr);
  	kfree(ida->free_bitmap);
  }
  EXPORT_SYMBOL(ida_destroy);
  
  /**
88eca0207   Rusty Russell   ida: simplified f...
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
   * ida_simple_get - get a new id.
   * @ida: the (initialized) ida.
   * @start: the minimum id (inclusive, < 0x8000000)
   * @end: the maximum id (exclusive, < 0x8000000 or 0)
   * @gfp_mask: memory allocation flags
   *
   * Allocates an id in the range start <= id < end, or returns -ENOSPC.
   * On memory allocation failure, returns -ENOMEM.
   *
   * Use ida_simple_remove() to get rid of an id.
   */
  int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
  		   gfp_t gfp_mask)
  {
  	int ret, id;
  	unsigned int max;
46cbc1d39   Tejun Heo   ida: make ida_sim...
932
  	unsigned long flags;
88eca0207   Rusty Russell   ida: simplified f...
933
934
935
936
937
938
939
940
941
942
943
944
945
946
  
  	BUG_ON((int)start < 0);
  	BUG_ON((int)end < 0);
  
  	if (end == 0)
  		max = 0x80000000;
  	else {
  		BUG_ON(end < start);
  		max = end - 1;
  	}
  
  again:
  	if (!ida_pre_get(ida, gfp_mask))
  		return -ENOMEM;
46cbc1d39   Tejun Heo   ida: make ida_sim...
947
  	spin_lock_irqsave(&simple_ida_lock, flags);
88eca0207   Rusty Russell   ida: simplified f...
948
949
950
951
952
953
954
955
956
  	ret = ida_get_new_above(ida, start, &id);
  	if (!ret) {
  		if (id > max) {
  			ida_remove(ida, id);
  			ret = -ENOSPC;
  		} else {
  			ret = id;
  		}
  	}
46cbc1d39   Tejun Heo   ida: make ida_sim...
957
  	spin_unlock_irqrestore(&simple_ida_lock, flags);
88eca0207   Rusty Russell   ida: simplified f...
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
  
  	if (unlikely(ret == -EAGAIN))
  		goto again;
  
  	return ret;
  }
  EXPORT_SYMBOL(ida_simple_get);
  
  /**
   * ida_simple_remove - remove an allocated id.
   * @ida: the (initialized) ida.
   * @id: the id returned by ida_simple_get.
   */
  void ida_simple_remove(struct ida *ida, unsigned int id)
  {
46cbc1d39   Tejun Heo   ida: make ida_sim...
973
  	unsigned long flags;
88eca0207   Rusty Russell   ida: simplified f...
974
  	BUG_ON((int)id < 0);
46cbc1d39   Tejun Heo   ida: make ida_sim...
975
  	spin_lock_irqsave(&simple_ida_lock, flags);
88eca0207   Rusty Russell   ida: simplified f...
976
  	ida_remove(ida, id);
46cbc1d39   Tejun Heo   ida: make ida_sim...
977
  	spin_unlock_irqrestore(&simple_ida_lock, flags);
88eca0207   Rusty Russell   ida: simplified f...
978
979
980
981
  }
  EXPORT_SYMBOL(ida_simple_remove);
  
  /**
72dba584b   Tejun Heo   ida: implement id...
982
983
984
985
986
987
988
989
990
991
992
993
994
   * 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);