Blame view

lib/radix-tree.c 31 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
  /*
   * Copyright (C) 2001 Momchil Velikov
   * Portions Copyright (C) 2001 Christoph Hellwig
cde535359   Christoph Lameter   Christoph has moved
4
   * Copyright (C) 2005 SGI, Christoph Lameter
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
5
   * Copyright (C) 2006 Nick Piggin
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
   *
   * This program is free software; you can redistribute it and/or
   * modify it under the terms of the GNU General Public License as
   * published by the Free Software Foundation; either version 2, or (at
   * your option) any later version.
   *
   * This program is distributed in the hope that it will be useful, but
   * WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   */
  
  #include <linux/errno.h>
  #include <linux/init.h>
  #include <linux/kernel.h>
  #include <linux/module.h>
  #include <linux/radix-tree.h>
  #include <linux/percpu.h>
  #include <linux/slab.h>
  #include <linux/notifier.h>
  #include <linux/cpu.h>
  #include <linux/gfp.h>
  #include <linux/string.h>
  #include <linux/bitops.h>
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
34
  #include <linux/rcupdate.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
35
36
37
  
  
  #ifdef __KERNEL__
cfd9b7df4   Nick Piggin   [PATCH] radix-tre...
38
  #define RADIX_TREE_MAP_SHIFT	(CONFIG_BASE_SMALL ? 4 : 6)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
39
40
41
  #else
  #define RADIX_TREE_MAP_SHIFT	3	/* For more stressful testing */
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42
43
44
45
46
47
48
49
  
  #define RADIX_TREE_MAP_SIZE	(1UL << RADIX_TREE_MAP_SHIFT)
  #define RADIX_TREE_MAP_MASK	(RADIX_TREE_MAP_SIZE-1)
  
  #define RADIX_TREE_TAG_LONGS	\
  	((RADIX_TREE_MAP_SIZE + BITS_PER_LONG - 1) / BITS_PER_LONG)
  
  struct radix_tree_node {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
50
  	unsigned int	height;		/* Height from the bottom */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
51
  	unsigned int	count;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
52
  	struct rcu_head	rcu_head;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
53
  	void		*slots[RADIX_TREE_MAP_SIZE];
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
54
  	unsigned long	tags[RADIX_TREE_MAX_TAGS][RADIX_TREE_TAG_LONGS];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
55
56
57
  };
  
  struct radix_tree_path {
201b6264f   Christoph Lameter   [PATCH] radix-tre...
58
  	struct radix_tree_node *node;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
60
61
62
  	int offset;
  };
  
  #define RADIX_TREE_INDEX_BITS  (8 /* CHAR_BIT */ * sizeof(unsigned long))
26fb1589c   Jeff Moyer   fix the max path ...
63
64
  #define RADIX_TREE_MAX_PATH (DIV_ROUND_UP(RADIX_TREE_INDEX_BITS, \
  					  RADIX_TREE_MAP_SHIFT))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
65

26fb1589c   Jeff Moyer   fix the max path ...
66
67
68
69
70
  /*
   * The height_to_maxindex array needs to be one deeper than the maximum
   * path as height 0 holds only 1 entry.
   */
  static unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1] __read_mostly;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
71
72
73
74
  
  /*
   * Radix tree node cache.
   */
e18b890bb   Christoph Lameter   [PATCH] slab: rem...
75
  static struct kmem_cache *radix_tree_node_cachep;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
76
77
78
79
80
81
82
83
  
  /*
   * Per-cpu pool of preloaded nodes
   */
  struct radix_tree_preload {
  	int nr;
  	struct radix_tree_node *nodes[RADIX_TREE_MAX_PATH];
  };
8cef7d57a   Harvey Harrison   lib: radix_tree.c...
84
  static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
85

612d6c19d   Nick Piggin   [PATCH] radix-tre...
86
87
88
89
  static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
  {
  	return root->gfp_mask & __GFP_BITS_MASK;
  }
643b52b9c   Nick Piggin   radix-tree: fix s...
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
  		int offset)
  {
  	__set_bit(offset, node->tags[tag]);
  }
  
  static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
  		int offset)
  {
  	__clear_bit(offset, node->tags[tag]);
  }
  
  static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
  		int offset)
  {
  	return test_bit(offset, node->tags[tag]);
  }
  
  static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
  {
  	root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
  }
  
  static inline void root_tag_clear(struct radix_tree_root *root, unsigned int tag)
  {
  	root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
  }
  
  static inline void root_tag_clear_all(struct radix_tree_root *root)
  {
  	root->gfp_mask &= __GFP_BITS_MASK;
  }
  
  static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
  {
  	return (__force unsigned)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
  }
  
  /*
   * Returns 1 if any slot in the node has this tag set.
   * Otherwise returns 0.
   */
  static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
  {
  	int idx;
  	for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
  		if (node->tags[tag][idx])
  			return 1;
  	}
  	return 0;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
141
142
143
144
145
146
147
  /*
   * This assumes that the caller has performed appropriate preallocation, and
   * that the caller has pinned this thread of control to the current CPU.
   */
  static struct radix_tree_node *
  radix_tree_node_alloc(struct radix_tree_root *root)
  {
e2848a0ef   Nick Piggin   radix-tree: avoid...
148
  	struct radix_tree_node *ret = NULL;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
149
  	gfp_t gfp_mask = root_gfp_mask(root);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
150

e2848a0ef   Nick Piggin   radix-tree: avoid...
151
  	if (!(gfp_mask & __GFP_WAIT)) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
152
  		struct radix_tree_preload *rtp;
e2848a0ef   Nick Piggin   radix-tree: avoid...
153
154
155
156
157
  		/*
  		 * Provided the caller has preloaded here, we will always
  		 * succeed in getting a node here (and never reach
  		 * kmem_cache_alloc)
  		 */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
158
159
160
161
162
163
164
  		rtp = &__get_cpu_var(radix_tree_preloads);
  		if (rtp->nr) {
  			ret = rtp->nodes[rtp->nr - 1];
  			rtp->nodes[rtp->nr - 1] = NULL;
  			rtp->nr--;
  		}
  	}
e2848a0ef   Nick Piggin   radix-tree: avoid...
165
  	if (ret == NULL)
488514d17   Christoph Lameter   Remove set_migrat...
166
  		ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
e2848a0ef   Nick Piggin   radix-tree: avoid...
167

c0bc9875b   Nick Piggin   radix-tree: use i...
168
  	BUG_ON(radix_tree_is_indirect_ptr(ret));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
169
170
  	return ret;
  }
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
171
172
173
174
  static void radix_tree_node_rcu_free(struct rcu_head *head)
  {
  	struct radix_tree_node *node =
  			container_of(head, struct radix_tree_node, rcu_head);
643b52b9c   Nick Piggin   radix-tree: fix s...
175
176
177
178
179
180
181
182
183
184
  
  	/*
  	 * must only free zeroed nodes into the slab. radix_tree_shrink
  	 * can leave us with a non-NULL entry in the first slot, so clear
  	 * that here to make sure.
  	 */
  	tag_clear(node, 0, 0);
  	tag_clear(node, 1, 0);
  	node->slots[0] = NULL;
  	node->count = 0;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
185
186
  	kmem_cache_free(radix_tree_node_cachep, node);
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
187
188
189
  static inline void
  radix_tree_node_free(struct radix_tree_node *node)
  {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
190
  	call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
191
192
193
194
195
196
197
198
  }
  
  /*
   * Load up this CPU's radix_tree_node buffer with sufficient objects to
   * ensure that the addition of a single element in the tree cannot fail.  On
   * success, return zero, with preemption disabled.  On error, return -ENOMEM
   * with preemption not disabled.
   */
dd0fc66fb   Al Viro   [PATCH] gfp flags...
199
  int radix_tree_preload(gfp_t gfp_mask)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
200
201
202
203
204
205
206
207
208
  {
  	struct radix_tree_preload *rtp;
  	struct radix_tree_node *node;
  	int ret = -ENOMEM;
  
  	preempt_disable();
  	rtp = &__get_cpu_var(radix_tree_preloads);
  	while (rtp->nr < ARRAY_SIZE(rtp->nodes)) {
  		preempt_enable();
488514d17   Christoph Lameter   Remove set_migrat...
209
  		node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
210
211
212
213
214
215
216
217
218
219
220
221
222
  		if (node == NULL)
  			goto out;
  		preempt_disable();
  		rtp = &__get_cpu_var(radix_tree_preloads);
  		if (rtp->nr < ARRAY_SIZE(rtp->nodes))
  			rtp->nodes[rtp->nr++] = node;
  		else
  			kmem_cache_free(radix_tree_node_cachep, node);
  	}
  	ret = 0;
  out:
  	return ret;
  }
d7f0923d8   David Chinner   [LIB]: export rad...
223
  EXPORT_SYMBOL(radix_tree_preload);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
224

6e954b9e9   Nick Piggin   [PATCH] radix tre...
225
  /*
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
   *	Return the maximum key which can be store into a
   *	radix tree with height HEIGHT.
   */
  static inline unsigned long radix_tree_maxindex(unsigned int height)
  {
  	return height_to_maxindex[height];
  }
  
  /*
   *	Extend a radix tree so it can store key @index.
   */
  static int radix_tree_extend(struct radix_tree_root *root, unsigned long index)
  {
  	struct radix_tree_node *node;
  	unsigned int height;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
241
242
243
244
245
246
247
248
249
250
251
  	int tag;
  
  	/* Figure out what the height should be.  */
  	height = root->height + 1;
  	while (index > radix_tree_maxindex(height))
  		height++;
  
  	if (root->rnode == NULL) {
  		root->height = height;
  		goto out;
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
252
  	do {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
253
  		unsigned int newheight;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
254
255
256
257
  		if (!(node = radix_tree_node_alloc(root)))
  			return -ENOMEM;
  
  		/* Increase the height.  */
c0bc9875b   Nick Piggin   radix-tree: use i...
258
  		node->slots[0] = radix_tree_indirect_to_ptr(root->rnode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
259
260
  
  		/* Propagate the aggregated tag info into the new root */
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
261
  		for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
612d6c19d   Nick Piggin   [PATCH] radix-tre...
262
  			if (root_tag_get(root, tag))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
263
264
  				tag_set(node, tag, 0);
  		}
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
265
266
  		newheight = root->height+1;
  		node->height = newheight;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
267
  		node->count = 1;
c0bc9875b   Nick Piggin   radix-tree: use i...
268
  		node = radix_tree_ptr_to_indirect(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
269
270
  		rcu_assign_pointer(root->rnode, node);
  		root->height = newheight;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
  	} while (height > root->height);
  out:
  	return 0;
  }
  
  /**
   *	radix_tree_insert    -    insert into a radix tree
   *	@root:		radix tree root
   *	@index:		index key
   *	@item:		item to insert
   *
   *	Insert an item into the radix tree at position @index.
   */
  int radix_tree_insert(struct radix_tree_root *root,
  			unsigned long index, void *item)
  {
201b6264f   Christoph Lameter   [PATCH] radix-tre...
287
  	struct radix_tree_node *node = NULL, *slot;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
288
289
290
  	unsigned int height, shift;
  	int offset;
  	int error;
c0bc9875b   Nick Piggin   radix-tree: use i...
291
  	BUG_ON(radix_tree_is_indirect_ptr(item));
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
292

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
293
  	/* Make sure the tree is high enough.  */
612d6c19d   Nick Piggin   [PATCH] radix-tre...
294
  	if (index > radix_tree_maxindex(root->height)) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
295
296
297
298
  		error = radix_tree_extend(root, index);
  		if (error)
  			return error;
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
299
  	slot = radix_tree_indirect_to_ptr(root->rnode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
300
301
302
303
  	height = root->height;
  	shift = (height-1) * RADIX_TREE_MAP_SHIFT;
  
  	offset = 0;			/* uninitialised var warning */
612d6c19d   Nick Piggin   [PATCH] radix-tre...
304
  	while (height > 0) {
201b6264f   Christoph Lameter   [PATCH] radix-tre...
305
  		if (slot == NULL) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
306
  			/* Have to add a child node.  */
201b6264f   Christoph Lameter   [PATCH] radix-tre...
307
  			if (!(slot = radix_tree_node_alloc(root)))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
308
  				return -ENOMEM;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
309
  			slot->height = height;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
310
  			if (node) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
311
  				rcu_assign_pointer(node->slots[offset], slot);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
312
  				node->count++;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
313
  			} else
c0bc9875b   Nick Piggin   radix-tree: use i...
314
315
  				rcu_assign_pointer(root->rnode,
  					radix_tree_ptr_to_indirect(slot));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
316
317
318
319
  		}
  
  		/* Go a level down */
  		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
320
321
  		node = slot;
  		slot = node->slots[offset];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
322
323
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
324
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
325

201b6264f   Christoph Lameter   [PATCH] radix-tre...
326
  	if (slot != NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
327
  		return -EEXIST;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
328

612d6c19d   Nick Piggin   [PATCH] radix-tre...
329
330
  	if (node) {
  		node->count++;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
331
  		rcu_assign_pointer(node->slots[offset], item);
612d6c19d   Nick Piggin   [PATCH] radix-tre...
332
333
334
  		BUG_ON(tag_get(node, 0, offset));
  		BUG_ON(tag_get(node, 1, offset));
  	} else {
c0bc9875b   Nick Piggin   radix-tree: use i...
335
  		rcu_assign_pointer(root->rnode, item);
612d6c19d   Nick Piggin   [PATCH] radix-tre...
336
337
338
  		BUG_ON(root_tag_get(root, 0));
  		BUG_ON(root_tag_get(root, 1));
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
339

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
340
341
342
  	return 0;
  }
  EXPORT_SYMBOL(radix_tree_insert);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
343
344
345
346
347
348
349
350
  /**
   *	radix_tree_lookup_slot    -    lookup a slot in a radix tree
   *	@root:		radix tree root
   *	@index:		index key
   *
   *	Returns:  the slot corresponding to the position @index in the
   *	radix tree @root. This is useful for update-if-exists operations.
   *
47feff2c8   Nick Piggin   radix-tree: add g...
351
352
353
354
   *	This function can be called under rcu_read_lock iff the slot is not
   *	modified by radix_tree_replace_slot, otherwise it must be called
   *	exclusive from other writers. Any dereference of the slot must be done
   *	using radix_tree_deref_slot.
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
355
356
   */
  void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
357
358
  {
  	unsigned int height, shift;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
359
  	struct radix_tree_node *node, **slot;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
360

47feff2c8   Nick Piggin   radix-tree: add g...
361
  	node = rcu_dereference(root->rnode);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
362
  	if (node == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
363
  		return NULL;
c0bc9875b   Nick Piggin   radix-tree: use i...
364
  	if (!radix_tree_is_indirect_ptr(node)) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
365
366
  		if (index > 0)
  			return NULL;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
367
  		return (void **)&root->rnode;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
368
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
369
  	node = radix_tree_indirect_to_ptr(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
370
371
372
373
  
  	height = node->height;
  	if (index > radix_tree_maxindex(height))
  		return NULL;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
374

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
375
  	shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
376

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
377
378
379
  	do {
  		slot = (struct radix_tree_node **)
  			(node->slots + ((index>>shift) & RADIX_TREE_MAP_MASK));
47feff2c8   Nick Piggin   radix-tree: add g...
380
  		node = rcu_dereference(*slot);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
381
  		if (node == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
382
  			return NULL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
383
384
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
385
  	} while (height > 0);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
386

a43313668   Hans Reiser   [PATCH] reiser4: ...
387
388
  	return (void **)slot;
  }
a43313668   Hans Reiser   [PATCH] reiser4: ...
389
390
391
392
393
394
395
396
  EXPORT_SYMBOL(radix_tree_lookup_slot);
  
  /**
   *	radix_tree_lookup    -    perform lookup operation on a radix tree
   *	@root:		radix tree root
   *	@index:		index key
   *
   *	Lookup the item at the position @index in the radix tree @root.
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
397
398
399
400
401
   *
   *	This function can be called under rcu_read_lock, however the caller
   *	must manage lifetimes of leaf nodes (eg. RCU may also be used to free
   *	them safely). No RCU barriers are required to access or modify the
   *	returned item, however.
a43313668   Hans Reiser   [PATCH] reiser4: ...
402
403
404
   */
  void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
  {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
405
406
407
408
409
410
  	unsigned int height, shift;
  	struct radix_tree_node *node, **slot;
  
  	node = rcu_dereference(root->rnode);
  	if (node == NULL)
  		return NULL;
c0bc9875b   Nick Piggin   radix-tree: use i...
411
  	if (!radix_tree_is_indirect_ptr(node)) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
412
413
  		if (index > 0)
  			return NULL;
c0bc9875b   Nick Piggin   radix-tree: use i...
414
  		return node;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
415
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
416
  	node = radix_tree_indirect_to_ptr(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
417
418
419
420
421
422
  
  	height = node->height;
  	if (index > radix_tree_maxindex(height))
  		return NULL;
  
  	shift = (height-1) * RADIX_TREE_MAP_SHIFT;
a43313668   Hans Reiser   [PATCH] reiser4: ...
423

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
424
425
426
427
428
429
430
431
432
433
434
435
  	do {
  		slot = (struct radix_tree_node **)
  			(node->slots + ((index>>shift) & RADIX_TREE_MAP_MASK));
  		node = rcu_dereference(*slot);
  		if (node == NULL)
  			return NULL;
  
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
  	} while (height > 0);
  
  	return node;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
436
437
438
439
440
441
442
443
444
  }
  EXPORT_SYMBOL(radix_tree_lookup);
  
  /**
   *	radix_tree_tag_set - set a tag on a radix tree node
   *	@root:		radix tree root
   *	@index:		index key
   *	@tag: 		tag index
   *
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
445
446
   *	Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
   *	corresponding to @index in the radix tree.  From
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
447
448
449
450
451
452
   *	the root all the way down to the leaf node.
   *
   *	Returns the address of the tagged item.   Setting a tag on a not-present
   *	item is a bug.
   */
  void *radix_tree_tag_set(struct radix_tree_root *root,
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
453
  			unsigned long index, unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
454
455
  {
  	unsigned int height, shift;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
456
  	struct radix_tree_node *slot;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
457
458
  
  	height = root->height;
4c91c3648   Peter Zijlstra   [PATCH] buglet in...
459
  	BUG_ON(index > radix_tree_maxindex(height));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
460

c0bc9875b   Nick Piggin   radix-tree: use i...
461
  	slot = radix_tree_indirect_to_ptr(root->rnode);
612d6c19d   Nick Piggin   [PATCH] radix-tre...
462
  	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
463
464
465
466
467
  
  	while (height > 0) {
  		int offset;
  
  		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
d5274261e   Nick Piggin   [PATCH] radix tre...
468
469
  		if (!tag_get(slot, tag, offset))
  			tag_set(slot, tag, offset);
201b6264f   Christoph Lameter   [PATCH] radix-tre...
470
471
  		slot = slot->slots[offset];
  		BUG_ON(slot == NULL);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
472
473
474
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
  	}
612d6c19d   Nick Piggin   [PATCH] radix-tre...
475
476
477
  	/* set the root's tag bit */
  	if (slot && !root_tag_get(root, tag))
  		root_tag_set(root, tag);
201b6264f   Christoph Lameter   [PATCH] radix-tre...
478
  	return slot;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
479
480
481
482
483
484
485
486
487
  }
  EXPORT_SYMBOL(radix_tree_tag_set);
  
  /**
   *	radix_tree_tag_clear - clear a tag on a radix tree node
   *	@root:		radix tree root
   *	@index:		index key
   *	@tag: 		tag index
   *
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
488
489
   *	Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
   *	corresponding to @index in the radix tree.  If
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
490
491
492
493
494
495
496
   *	this causes the leaf node to have no tags set then clear the tag in the
   *	next-to-leaf node, etc.
   *
   *	Returns the address of the tagged item on success, else NULL.  ie:
   *	has the same return value and semantics as radix_tree_lookup().
   */
  void *radix_tree_tag_clear(struct radix_tree_root *root,
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
497
  			unsigned long index, unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
498
  {
26fb1589c   Jeff Moyer   fix the max path ...
499
500
501
502
503
  	/*
  	 * The radix tree path needs to be one longer than the maximum path
  	 * since the "list" is null terminated.
  	 */
  	struct radix_tree_path path[RADIX_TREE_MAX_PATH + 1], *pathp = path;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
504
  	struct radix_tree_node *slot = NULL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
505
  	unsigned int height, shift;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
506
507
508
509
510
511
512
  
  	height = root->height;
  	if (index > radix_tree_maxindex(height))
  		goto out;
  
  	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
  	pathp->node = NULL;
c0bc9875b   Nick Piggin   radix-tree: use i...
513
  	slot = radix_tree_indirect_to_ptr(root->rnode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
514
515
516
  
  	while (height > 0) {
  		int offset;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
517
  		if (slot == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
518
519
520
521
  			goto out;
  
  		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
  		pathp[1].offset = offset;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
522
523
  		pathp[1].node = slot;
  		slot = slot->slots[offset];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
524
525
526
527
  		pathp++;
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
  	}
612d6c19d   Nick Piggin   [PATCH] radix-tre...
528
  	if (slot == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
529
  		goto out;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
530
  	while (pathp->node) {
d5274261e   Nick Piggin   [PATCH] radix tre...
531
532
  		if (!tag_get(pathp->node, tag, pathp->offset))
  			goto out;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
533
  		tag_clear(pathp->node, tag, pathp->offset);
6e954b9e9   Nick Piggin   [PATCH] radix tre...
534
535
  		if (any_tag_set(pathp->node, tag))
  			goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
536
  		pathp--;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
537
538
539
540
541
  	}
  
  	/* clear the root's tag bit */
  	if (root_tag_get(root, tag))
  		root_tag_clear(root, tag);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
542
  out:
612d6c19d   Nick Piggin   [PATCH] radix-tre...
543
  	return slot;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
544
545
546
547
548
  }
  EXPORT_SYMBOL(radix_tree_tag_clear);
  
  #ifndef __KERNEL__	/* Only the test harness uses this at present */
  /**
32605a181   Marcelo Tosatti   [PATCH] radix_tag...
549
550
551
   * radix_tree_tag_get - get a tag on a radix tree node
   * @root:		radix tree root
   * @index:		index key
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
552
   * @tag: 		tag index (< RADIX_TREE_MAX_TAGS)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
553
   *
32605a181   Marcelo Tosatti   [PATCH] radix_tag...
554
   * Return values:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
555
   *
612d6c19d   Nick Piggin   [PATCH] radix-tre...
556
557
   *  0: tag not present or not set
   *  1: tag set
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
558
559
   */
  int radix_tree_tag_get(struct radix_tree_root *root,
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
560
  			unsigned long index, unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
561
562
  {
  	unsigned int height, shift;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
563
  	struct radix_tree_node *node;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
564
  	int saw_unset_tag = 0;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
565
566
567
  	/* check the root's tag bit */
  	if (!root_tag_get(root, tag))
  		return 0;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
568
569
570
  	node = rcu_dereference(root->rnode);
  	if (node == NULL)
  		return 0;
c0bc9875b   Nick Piggin   radix-tree: use i...
571
  	if (!radix_tree_is_indirect_ptr(node))
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
572
  		return (index == 0);
c0bc9875b   Nick Piggin   radix-tree: use i...
573
  	node = radix_tree_indirect_to_ptr(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
574
575
576
577
  
  	height = node->height;
  	if (index > radix_tree_maxindex(height))
  		return 0;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
578

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
579
  	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
580
581
582
  
  	for ( ; ; ) {
  		int offset;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
583
  		if (node == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
584
585
586
587
588
589
590
591
  			return 0;
  
  		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
  
  		/*
  		 * This is just a debug check.  Later, we can bale as soon as
  		 * we see an unset tag.
  		 */
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
592
  		if (!tag_get(node, tag, offset))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
593
594
  			saw_unset_tag = 1;
  		if (height == 1) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
595
  			int ret = tag_get(node, tag, offset);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
596
597
  
  			BUG_ON(ret && saw_unset_tag);
e5dcd90b5   Wu Fengguang   [PATCH] radixtree...
598
  			return !!ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
599
  		}
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
600
  		node = rcu_dereference(node->slots[offset]);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
601
602
603
604
605
606
  		shift -= RADIX_TREE_MAP_SHIFT;
  		height--;
  	}
  }
  EXPORT_SYMBOL(radix_tree_tag_get);
  #endif
6df8ba4f8   Fengguang Wu   radixtree: introd...
607
608
609
610
611
612
613
614
615
616
617
  /**
   *	radix_tree_next_hole    -    find the next hole (not-present entry)
   *	@root:		tree root
   *	@index:		index key
   *	@max_scan:	maximum range to search
   *
   *	Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the lowest
   *	indexed hole.
   *
   *	Returns: the index of the hole if found, otherwise returns an index
   *	outside of the set specified (in which case 'return - index >= max_scan'
8e6bdb7f8   Wu Fengguang   trivial: radix-tr...
618
   *	will be true). In rare cases of index wrap-around, 0 will be returned.
6df8ba4f8   Fengguang Wu   radixtree: introd...
619
620
   *
   *	radix_tree_next_hole may be called under rcu_read_lock. However, like
8e6bdb7f8   Wu Fengguang   trivial: radix-tr...
621
622
623
624
625
   *	radix_tree_gang_lookup, this will not atomically search a snapshot of
   *	the tree at a single point in time. For example, if a hole is created
   *	at index 5, then subsequently a hole is created at index 10,
   *	radix_tree_next_hole covering both indexes may return 10 if called
   *	under rcu_read_lock.
6df8ba4f8   Fengguang Wu   radixtree: introd...
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
   */
  unsigned long radix_tree_next_hole(struct radix_tree_root *root,
  				unsigned long index, unsigned long max_scan)
  {
  	unsigned long i;
  
  	for (i = 0; i < max_scan; i++) {
  		if (!radix_tree_lookup(root, index))
  			break;
  		index++;
  		if (index == 0)
  			break;
  	}
  
  	return index;
  }
  EXPORT_SYMBOL(radix_tree_next_hole);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
643
  static unsigned int
47feff2c8   Nick Piggin   radix-tree: add g...
644
  __lookup(struct radix_tree_node *slot, void ***results, unsigned long index,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
645
646
647
  	unsigned int max_items, unsigned long *next_index)
  {
  	unsigned int nr_found = 0;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
648
  	unsigned int shift, height;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
649
  	unsigned long i;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
650
651
  	height = slot->height;
  	if (height == 0)
201b6264f   Christoph Lameter   [PATCH] radix-tre...
652
  		goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
653
  	shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
654

201b6264f   Christoph Lameter   [PATCH] radix-tre...
655
  	for ( ; height > 1; height--) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
656
657
  		i = (index >> shift) & RADIX_TREE_MAP_MASK;
  		for (;;) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
658
659
660
661
662
663
  			if (slot->slots[i] != NULL)
  				break;
  			index &= ~((1UL << shift) - 1);
  			index += 1UL << shift;
  			if (index == 0)
  				goto out;	/* 32-bit wraparound */
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
664
665
666
  			i++;
  			if (i == RADIX_TREE_MAP_SIZE)
  				goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
667
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
668

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
669
  		shift -= RADIX_TREE_MAP_SHIFT;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
670
671
672
  		slot = rcu_dereference(slot->slots[i]);
  		if (slot == NULL)
  			goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
673
  	}
201b6264f   Christoph Lameter   [PATCH] radix-tre...
674
675
676
677
  
  	/* Bottom level: grab some items */
  	for (i = index & RADIX_TREE_MAP_MASK; i < RADIX_TREE_MAP_SIZE; i++) {
  		index++;
47feff2c8   Nick Piggin   radix-tree: add g...
678
679
  		if (slot->slots[i]) {
  			results[nr_found++] = &(slot->slots[i]);
201b6264f   Christoph Lameter   [PATCH] radix-tre...
680
681
682
683
  			if (nr_found == max_items)
  				goto out;
  		}
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
  out:
  	*next_index = index;
  	return nr_found;
  }
  
  /**
   *	radix_tree_gang_lookup - perform multiple lookup on a radix tree
   *	@root:		radix tree root
   *	@results:	where the results of the lookup are placed
   *	@first_index:	start the lookup from this key
   *	@max_items:	place up to this many items at *results
   *
   *	Performs an index-ascending scan of the tree for present items.  Places
   *	them at *@results and returns the number of items which were placed at
   *	*@results.
   *
   *	The implementation is naive.
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
701
702
703
704
705
706
   *
   *	Like radix_tree_lookup, radix_tree_gang_lookup may be called under
   *	rcu_read_lock. In this case, rather than the returned results being
   *	an atomic snapshot of the tree at a single point in time, the semantics
   *	of an RCU protected gang lookup are as though multiple radix_tree_lookups
   *	have been issued in individual locks, and results stored in 'results'.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
707
708
709
710
711
   */
  unsigned int
  radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
  			unsigned long first_index, unsigned int max_items)
  {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
712
713
  	unsigned long max_index;
  	struct radix_tree_node *node;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
714
  	unsigned long cur_index = first_index;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
715
716
717
718
719
  	unsigned int ret;
  
  	node = rcu_dereference(root->rnode);
  	if (!node)
  		return 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
720

c0bc9875b   Nick Piggin   radix-tree: use i...
721
  	if (!radix_tree_is_indirect_ptr(node)) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
722
723
  		if (first_index > 0)
  			return 0;
c0bc9875b   Nick Piggin   radix-tree: use i...
724
  		results[0] = node;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
725
726
  		return 1;
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
727
  	node = radix_tree_indirect_to_ptr(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
728
729
730
731
  
  	max_index = radix_tree_maxindex(node->height);
  
  	ret = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
732
  	while (ret < max_items) {
47feff2c8   Nick Piggin   radix-tree: add g...
733
  		unsigned int nr_found, slots_found, i;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
734
735
736
737
  		unsigned long next_index;	/* Index of next search */
  
  		if (cur_index > max_index)
  			break;
47feff2c8   Nick Piggin   radix-tree: add g...
738
  		slots_found = __lookup(node, (void ***)results + ret, cur_index,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
739
  					max_items - ret, &next_index);
47feff2c8   Nick Piggin   radix-tree: add g...
740
741
742
743
744
745
746
747
748
  		nr_found = 0;
  		for (i = 0; i < slots_found; i++) {
  			struct radix_tree_node *slot;
  			slot = *(((void ***)results)[ret + i]);
  			if (!slot)
  				continue;
  			results[ret + nr_found] = rcu_dereference(slot);
  			nr_found++;
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
749
750
751
752
753
  		ret += nr_found;
  		if (next_index == 0)
  			break;
  		cur_index = next_index;
  	}
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
754

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
755
756
757
  	return ret;
  }
  EXPORT_SYMBOL(radix_tree_gang_lookup);
47feff2c8   Nick Piggin   radix-tree: add g...
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
786
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
  /**
   *	radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
   *	@root:		radix tree root
   *	@results:	where the results of the lookup are placed
   *	@first_index:	start the lookup from this key
   *	@max_items:	place up to this many items at *results
   *
   *	Performs an index-ascending scan of the tree for present items.  Places
   *	their slots at *@results and returns the number of items which were
   *	placed at *@results.
   *
   *	The implementation is naive.
   *
   *	Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
   *	be dereferenced with radix_tree_deref_slot, and if using only RCU
   *	protection, radix_tree_deref_slot may fail requiring a retry.
   */
  unsigned int
  radix_tree_gang_lookup_slot(struct radix_tree_root *root, void ***results,
  			unsigned long first_index, unsigned int max_items)
  {
  	unsigned long max_index;
  	struct radix_tree_node *node;
  	unsigned long cur_index = first_index;
  	unsigned int ret;
  
  	node = rcu_dereference(root->rnode);
  	if (!node)
  		return 0;
  
  	if (!radix_tree_is_indirect_ptr(node)) {
  		if (first_index > 0)
  			return 0;
  		results[0] = (void **)&root->rnode;
  		return 1;
  	}
  	node = radix_tree_indirect_to_ptr(node);
  
  	max_index = radix_tree_maxindex(node->height);
  
  	ret = 0;
  	while (ret < max_items) {
  		unsigned int slots_found;
  		unsigned long next_index;	/* Index of next search */
  
  		if (cur_index > max_index)
  			break;
  		slots_found = __lookup(node, results + ret, cur_index,
  					max_items - ret, &next_index);
  		ret += slots_found;
  		if (next_index == 0)
  			break;
  		cur_index = next_index;
  	}
  
  	return ret;
  }
  EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
816
817
818
819
820
  /*
   * FIXME: the two tag_get()s here should use find_next_bit() instead of
   * open-coding the search.
   */
  static unsigned int
47feff2c8   Nick Piggin   radix-tree: add g...
821
  __lookup_tag(struct radix_tree_node *slot, void ***results, unsigned long index,
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
822
  	unsigned int max_items, unsigned long *next_index, unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
823
824
  {
  	unsigned int nr_found = 0;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
825
  	unsigned int shift, height;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
826

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
827
828
  	height = slot->height;
  	if (height == 0)
612d6c19d   Nick Piggin   [PATCH] radix-tre...
829
  		goto out;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
830
  	shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
831

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
832
833
  	while (height > 0) {
  		unsigned long i = (index >> shift) & RADIX_TREE_MAP_MASK ;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
834

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
835
836
  		for (;;) {
  			if (tag_get(slot, tag, i))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
837
  				break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
838
839
840
841
  			index &= ~((1UL << shift) - 1);
  			index += 1UL << shift;
  			if (index == 0)
  				goto out;	/* 32-bit wraparound */
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
842
843
844
  			i++;
  			if (i == RADIX_TREE_MAP_SIZE)
  				goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
845
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
846
847
848
849
850
851
  		height--;
  		if (height == 0) {	/* Bottom level: grab some items */
  			unsigned long j = index & RADIX_TREE_MAP_MASK;
  
  			for ( ; j < RADIX_TREE_MAP_SIZE; j++) {
  				index++;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
852
853
  				if (!tag_get(slot, tag, j))
  					continue;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
854
855
856
857
858
859
860
861
862
863
  				/*
  				 * Even though the tag was found set, we need to
  				 * recheck that we have a non-NULL node, because
  				 * if this lookup is lockless, it may have been
  				 * subsequently deleted.
  				 *
  				 * Similar care must be taken in any place that
  				 * lookup ->slots[x] without a lock (ie. can't
  				 * rely on its value remaining the same).
  				 */
47feff2c8   Nick Piggin   radix-tree: add g...
864
865
  				if (slot->slots[j]) {
  					results[nr_found++] = &(slot->slots[j]);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
866
867
868
869
870
871
  					if (nr_found == max_items)
  						goto out;
  				}
  			}
  		}
  		shift -= RADIX_TREE_MAP_SHIFT;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
872
873
874
875
  		slot = rcu_dereference(slot->slots[i]);
  		if (slot == NULL)
  			break;
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
876
877
878
879
880
881
882
883
884
885
886
887
  out:
  	*next_index = index;
  	return nr_found;
  }
  
  /**
   *	radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
   *	                             based on a tag
   *	@root:		radix tree root
   *	@results:	where the results of the lookup are placed
   *	@first_index:	start the lookup from this key
   *	@max_items:	place up to this many items at *results
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
888
   *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
889
890
891
892
893
894
895
   *
   *	Performs an index-ascending scan of the tree for present items which
   *	have the tag indexed by @tag set.  Places the items at *@results and
   *	returns the number of items which were placed at *@results.
   */
  unsigned int
  radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
896
897
  		unsigned long first_index, unsigned int max_items,
  		unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
898
  {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
899
900
  	struct radix_tree_node *node;
  	unsigned long max_index;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
901
  	unsigned long cur_index = first_index;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
902
  	unsigned int ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
903

612d6c19d   Nick Piggin   [PATCH] radix-tre...
904
905
906
  	/* check the root's tag bit */
  	if (!root_tag_get(root, tag))
  		return 0;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
907
908
909
  	node = rcu_dereference(root->rnode);
  	if (!node)
  		return 0;
c0bc9875b   Nick Piggin   radix-tree: use i...
910
  	if (!radix_tree_is_indirect_ptr(node)) {
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
911
912
  		if (first_index > 0)
  			return 0;
c0bc9875b   Nick Piggin   radix-tree: use i...
913
  		results[0] = node;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
914
915
  		return 1;
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
916
  	node = radix_tree_indirect_to_ptr(node);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
917
918
919
920
  
  	max_index = radix_tree_maxindex(node->height);
  
  	ret = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
921
  	while (ret < max_items) {
47feff2c8   Nick Piggin   radix-tree: add g...
922
  		unsigned int nr_found, slots_found, i;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
923
924
925
926
  		unsigned long next_index;	/* Index of next search */
  
  		if (cur_index > max_index)
  			break;
47feff2c8   Nick Piggin   radix-tree: add g...
927
928
929
930
931
932
933
934
935
936
937
  		slots_found = __lookup_tag(node, (void ***)results + ret,
  				cur_index, max_items - ret, &next_index, tag);
  		nr_found = 0;
  		for (i = 0; i < slots_found; i++) {
  			struct radix_tree_node *slot;
  			slot = *(((void ***)results)[ret + i]);
  			if (!slot)
  				continue;
  			results[ret + nr_found] = rcu_dereference(slot);
  			nr_found++;
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
938
939
940
941
942
  		ret += nr_found;
  		if (next_index == 0)
  			break;
  		cur_index = next_index;
  	}
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
943

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
944
945
946
947
948
  	return ret;
  }
  EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
  
  /**
47feff2c8   Nick Piggin   radix-tree: add g...
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
   *	radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
   *					  radix tree based on a tag
   *	@root:		radix tree root
   *	@results:	where the results of the lookup are placed
   *	@first_index:	start the lookup from this key
   *	@max_items:	place up to this many items at *results
   *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
   *
   *	Performs an index-ascending scan of the tree for present items which
   *	have the tag indexed by @tag set.  Places the slots at *@results and
   *	returns the number of slots which were placed at *@results.
   */
  unsigned int
  radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
  		unsigned long first_index, unsigned int max_items,
  		unsigned int tag)
  {
  	struct radix_tree_node *node;
  	unsigned long max_index;
  	unsigned long cur_index = first_index;
  	unsigned int ret;
  
  	/* check the root's tag bit */
  	if (!root_tag_get(root, tag))
  		return 0;
  
  	node = rcu_dereference(root->rnode);
  	if (!node)
  		return 0;
  
  	if (!radix_tree_is_indirect_ptr(node)) {
  		if (first_index > 0)
  			return 0;
  		results[0] = (void **)&root->rnode;
  		return 1;
  	}
  	node = radix_tree_indirect_to_ptr(node);
  
  	max_index = radix_tree_maxindex(node->height);
  
  	ret = 0;
  	while (ret < max_items) {
  		unsigned int slots_found;
  		unsigned long next_index;	/* Index of next search */
  
  		if (cur_index > max_index)
  			break;
  		slots_found = __lookup_tag(node, results + ret,
  				cur_index, max_items - ret, &next_index, tag);
  		ret += slots_found;
  		if (next_index == 0)
  			break;
  		cur_index = next_index;
  	}
  
  	return ret;
  }
  EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
  
  
  /**
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1010
1011
1012
1013
1014
1015
   *	radix_tree_shrink    -    shrink height of a radix tree to minimal
   *	@root		radix tree root
   */
  static inline void radix_tree_shrink(struct radix_tree_root *root)
  {
  	/* try to shrink tree height */
c0bc9875b   Nick Piggin   radix-tree: use i...
1016
  	while (root->height > 0) {
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1017
  		struct radix_tree_node *to_free = root->rnode;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1018
  		void *newptr;
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1019

c0bc9875b   Nick Piggin   radix-tree: use i...
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
  		BUG_ON(!radix_tree_is_indirect_ptr(to_free));
  		to_free = radix_tree_indirect_to_ptr(to_free);
  
  		/*
  		 * The candidate node has more than one child, or its child
  		 * is not at the leftmost slot, we cannot shrink.
  		 */
  		if (to_free->count != 1)
  			break;
  		if (!to_free->slots[0])
  			break;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1031
1032
1033
1034
1035
1036
1037
1038
  		/*
  		 * We don't need rcu_assign_pointer(), since we are simply
  		 * moving the node from one part of the tree to another. If
  		 * it was safe to dereference the old pointer to it
  		 * (to_free->slots[0]), it will be safe to dereference the new
  		 * one (root->rnode).
  		 */
  		newptr = to_free->slots[0];
c0bc9875b   Nick Piggin   radix-tree: use i...
1039
1040
  		if (root->height > 1)
  			newptr = radix_tree_ptr_to_indirect(newptr);
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1041
  		root->rnode = newptr;
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1042
  		root->height--;
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1043
1044
1045
1046
1047
  		radix_tree_node_free(to_free);
  	}
  }
  
  /**
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
   *	radix_tree_delete    -    delete an item from a radix tree
   *	@root:		radix tree root
   *	@index:		index key
   *
   *	Remove the item at @index from the radix tree rooted at @root.
   *
   *	Returns the address of the deleted item, or NULL if it was not present.
   */
  void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
  {
26fb1589c   Jeff Moyer   fix the max path ...
1058
1059
1060
1061
1062
  	/*
  	 * The radix tree path needs to be one longer than the maximum path
  	 * since the "list" is null terminated.
  	 */
  	struct radix_tree_path path[RADIX_TREE_MAX_PATH + 1], *pathp = path;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1063
  	struct radix_tree_node *slot = NULL;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1064
  	struct radix_tree_node *to_free;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1065
  	unsigned int height, shift;
d5274261e   Nick Piggin   [PATCH] radix tre...
1066
1067
  	int tag;
  	int offset;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1068
1069
1070
1071
  
  	height = root->height;
  	if (index > radix_tree_maxindex(height))
  		goto out;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1072
  	slot = root->rnode;
c0bc9875b   Nick Piggin   radix-tree: use i...
1073
  	if (height == 0) {
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1074
1075
1076
1077
  		root_tag_clear_all(root);
  		root->rnode = NULL;
  		goto out;
  	}
c0bc9875b   Nick Piggin   radix-tree: use i...
1078
  	slot = radix_tree_indirect_to_ptr(slot);
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1079

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1080
1081
  	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
  	pathp->node = NULL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1082

612d6c19d   Nick Piggin   [PATCH] radix-tre...
1083
  	do {
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1084
  		if (slot == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1085
  			goto out;
d5274261e   Nick Piggin   [PATCH] radix tre...
1086
  		pathp++;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1087
  		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
d5274261e   Nick Piggin   [PATCH] radix tre...
1088
1089
  		pathp->offset = offset;
  		pathp->node = slot;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1090
  		slot = slot->slots[offset];
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1091
  		shift -= RADIX_TREE_MAP_SHIFT;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1092
1093
  		height--;
  	} while (height > 0);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1094

612d6c19d   Nick Piggin   [PATCH] radix-tre...
1095
  	if (slot == NULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1096
  		goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1097
1098
1099
  	/*
  	 * Clear all tags associated with the just-deleted item
  	 */
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
1100
  	for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1101
1102
  		if (tag_get(pathp->node, tag, pathp->offset))
  			radix_tree_tag_clear(root, index, tag);
d5274261e   Nick Piggin   [PATCH] radix tre...
1103
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1104

7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1105
  	to_free = NULL;
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1106
  	/* Now free the nodes we do not need anymore */
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1107
  	while (pathp->node) {
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1108
  		pathp->node->slots[pathp->offset] = NULL;
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1109
  		pathp->node->count--;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1110
1111
1112
1113
1114
1115
  		/*
  		 * Queue the node for deferred freeing after the
  		 * last reference to it disappears (set NULL, above).
  		 */
  		if (to_free)
  			radix_tree_node_free(to_free);
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1116
1117
  
  		if (pathp->node->count) {
c0bc9875b   Nick Piggin   radix-tree: use i...
1118
1119
  			if (pathp->node ==
  					radix_tree_indirect_to_ptr(root->rnode))
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1120
  				radix_tree_shrink(root);
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1121
  			goto out;
a5f51c966   Nick Piggin   [PATCH] radix-tre...
1122
  		}
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1123
1124
  
  		/* Node with zero slots in use so free it */
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1125
  		to_free = pathp->node;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1126
  		pathp--;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1127

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1128
  	}
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1129
  	root_tag_clear_all(root);
201b6264f   Christoph Lameter   [PATCH] radix-tre...
1130
  	root->height = 0;
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1131
  	root->rnode = NULL;
7cf9c2c76   Nick Piggin   [PATCH] radix-tre...
1132
1133
  	if (to_free)
  		radix_tree_node_free(to_free);
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1134

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1135
  out:
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1136
  	return slot;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1137
1138
1139
1140
1141
1142
1143
1144
  }
  EXPORT_SYMBOL(radix_tree_delete);
  
  /**
   *	radix_tree_tagged - test whether any items in the tree are tagged
   *	@root:		radix tree root
   *	@tag:		tag to test
   */
daff89f32   Jonathan Corbet   [PATCH] radix-tre...
1145
  int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1146
  {
612d6c19d   Nick Piggin   [PATCH] radix-tre...
1147
  	return root_tag_get(root, tag);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1148
1149
1150
1151
  }
  EXPORT_SYMBOL(radix_tree_tagged);
  
  static void
51cc50685   Alexey Dobriyan   SL*B: drop kmem c...
1152
  radix_tree_node_ctor(void *node)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1153
1154
1155
1156
1157
1158
  {
  	memset(node, 0, sizeof(struct radix_tree_node));
  }
  
  static __init unsigned long __maxindex(unsigned int height)
  {
430d275a3   Peter Lund   avoid negative (a...
1159
1160
1161
1162
1163
1164
1165
1166
  	unsigned int width = height * RADIX_TREE_MAP_SHIFT;
  	int shift = RADIX_TREE_INDEX_BITS - width;
  
  	if (shift < 0)
  		return ~0UL;
  	if (shift >= BITS_PER_LONG)
  		return 0UL;
  	return ~0UL >> shift;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1167
1168
1169
1170
1171
1172
1173
1174
1175
  }
  
  static __init void radix_tree_init_maxindex(void)
  {
  	unsigned int i;
  
  	for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
  		height_to_maxindex[i] = __maxindex(i);
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1176
1177
1178
1179
1180
1181
1182
1183
  static int radix_tree_callback(struct notifier_block *nfb,
                              unsigned long action,
                              void *hcpu)
  {
         int cpu = (long)hcpu;
         struct radix_tree_preload *rtp;
  
         /* Free per-cpu pool of perloaded nodes */
8bb784428   Rafael J. Wysocki   Add suspend-relat...
1184
         if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
                 rtp = &per_cpu(radix_tree_preloads, cpu);
                 while (rtp->nr) {
                         kmem_cache_free(radix_tree_node_cachep,
                                         rtp->nodes[rtp->nr-1]);
                         rtp->nodes[rtp->nr-1] = NULL;
                         rtp->nr--;
                 }
         }
         return NOTIFY_OK;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1195
1196
1197
1198
1199
  
  void __init radix_tree_init(void)
  {
  	radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
  			sizeof(struct radix_tree_node), 0,
488514d17   Christoph Lameter   Remove set_migrat...
1200
1201
  			SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
  			radix_tree_node_ctor);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1202
1203
1204
  	radix_tree_init_maxindex();
  	hotcpu_notifier(radix_tree_callback, 0);
  }