2 * Copyright (C) 2001 Momchil Velikov
3 * Portions Copyright (C) 2001 Christoph Hellwig
4 * Copyright (C) 2005 SGI, Christoph Lameter
5 * Copyright (C) 2006 Nick Piggin
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2, or (at
10 * your option) any later version.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/errno.h>
23 #include <linux/init.h>
24 #include <linux/kernel.h>
25 #include <linux/module.h>
26 #include <linux/radix-tree.h>
27 #include <linux/percpu.h>
28 #include <linux/slab.h>
29 #include <linux/notifier.h>
30 #include <linux/cpu.h>
31 #include <linux/gfp.h>
32 #include <linux/string.h>
33 #include <linux/bitops.h>
34 #include <linux/rcupdate.h>
38 #define RADIX_TREE_MAP_SHIFT (CONFIG_BASE_SMALL ? 4 : 6)
40 #define RADIX_TREE_MAP_SHIFT 3 /* For more stressful testing */
43 #define RADIX_TREE_MAP_SIZE (1UL << RADIX_TREE_MAP_SHIFT)
44 #define RADIX_TREE_MAP_MASK (RADIX_TREE_MAP_SIZE-1)
46 #define RADIX_TREE_TAG_LONGS \
47 ((RADIX_TREE_MAP_SIZE + BITS_PER_LONG - 1) / BITS_PER_LONG)
49 struct radix_tree_node
{
50 unsigned int height
; /* Height from the bottom */
52 struct rcu_head rcu_head
;
53 void *slots
[RADIX_TREE_MAP_SIZE
];
54 unsigned long tags
[RADIX_TREE_MAX_TAGS
][RADIX_TREE_TAG_LONGS
];
57 struct radix_tree_path
{
58 struct radix_tree_node
*node
;
62 #define RADIX_TREE_INDEX_BITS (8 /* CHAR_BIT */ * sizeof(unsigned long))
63 #define RADIX_TREE_MAX_PATH (DIV_ROUND_UP(RADIX_TREE_INDEX_BITS, \
64 RADIX_TREE_MAP_SHIFT))
67 * The height_to_maxindex array needs to be one deeper than the maximum
68 * path as height 0 holds only 1 entry.
70 static unsigned long height_to_maxindex
[RADIX_TREE_MAX_PATH
+ 1] __read_mostly
;
73 * Radix tree node cache.
75 static struct kmem_cache
*radix_tree_node_cachep
;
78 * Per-cpu pool of preloaded nodes
80 struct radix_tree_preload
{
82 struct radix_tree_node
*nodes
[RADIX_TREE_MAX_PATH
];
84 DEFINE_PER_CPU(struct radix_tree_preload
, radix_tree_preloads
) = { 0, };
86 static inline gfp_t
root_gfp_mask(struct radix_tree_root
*root
)
88 return root
->gfp_mask
& __GFP_BITS_MASK
;
91 static inline void tag_set(struct radix_tree_node
*node
, unsigned int tag
,
94 __set_bit(offset
, node
->tags
[tag
]);
97 static inline void tag_clear(struct radix_tree_node
*node
, unsigned int tag
,
100 __clear_bit(offset
, node
->tags
[tag
]);
103 static inline int tag_get(struct radix_tree_node
*node
, unsigned int tag
,
106 return test_bit(offset
, node
->tags
[tag
]);
109 static inline void root_tag_set(struct radix_tree_root
*root
, unsigned int tag
)
111 root
->gfp_mask
|= (__force gfp_t
)(1 << (tag
+ __GFP_BITS_SHIFT
));
114 static inline void root_tag_clear(struct radix_tree_root
*root
, unsigned int tag
)
116 root
->gfp_mask
&= (__force gfp_t
)~(1 << (tag
+ __GFP_BITS_SHIFT
));
119 static inline void root_tag_clear_all(struct radix_tree_root
*root
)
121 root
->gfp_mask
&= __GFP_BITS_MASK
;
124 static inline int root_tag_get(struct radix_tree_root
*root
, unsigned int tag
)
126 return (__force
unsigned)root
->gfp_mask
& (1 << (tag
+ __GFP_BITS_SHIFT
));
130 * Returns 1 if any slot in the node has this tag set.
131 * Otherwise returns 0.
133 static inline int any_tag_set(struct radix_tree_node
*node
, unsigned int tag
)
136 for (idx
= 0; idx
< RADIX_TREE_TAG_LONGS
; idx
++) {
137 if (node
->tags
[tag
][idx
])
143 * This assumes that the caller has performed appropriate preallocation, and
144 * that the caller has pinned this thread of control to the current CPU.
146 static struct radix_tree_node
*
147 radix_tree_node_alloc(struct radix_tree_root
*root
)
149 struct radix_tree_node
*ret
= NULL
;
150 gfp_t gfp_mask
= root_gfp_mask(root
);
152 if (!(gfp_mask
& __GFP_WAIT
)) {
153 struct radix_tree_preload
*rtp
;
156 * Provided the caller has preloaded here, we will always
157 * succeed in getting a node here (and never reach
160 rtp
= &__get_cpu_var(radix_tree_preloads
);
162 ret
= rtp
->nodes
[rtp
->nr
- 1];
163 rtp
->nodes
[rtp
->nr
- 1] = NULL
;
168 ret
= kmem_cache_alloc(radix_tree_node_cachep
, gfp_mask
);
170 BUG_ON(radix_tree_is_indirect_ptr(ret
));
174 static void radix_tree_node_rcu_free(struct rcu_head
*head
)
176 struct radix_tree_node
*node
=
177 container_of(head
, struct radix_tree_node
, rcu_head
);
180 * must only free zeroed nodes into the slab. radix_tree_shrink
181 * can leave us with a non-NULL entry in the first slot, so clear
182 * that here to make sure.
184 tag_clear(node
, 0, 0);
185 tag_clear(node
, 1, 0);
186 node
->slots
[0] = NULL
;
189 kmem_cache_free(radix_tree_node_cachep
, node
);
193 radix_tree_node_free(struct radix_tree_node
*node
)
195 call_rcu(&node
->rcu_head
, radix_tree_node_rcu_free
);
199 * Load up this CPU's radix_tree_node buffer with sufficient objects to
200 * ensure that the addition of a single element in the tree cannot fail. On
201 * success, return zero, with preemption disabled. On error, return -ENOMEM
202 * with preemption not disabled.
204 int radix_tree_preload(gfp_t gfp_mask
)
206 struct radix_tree_preload
*rtp
;
207 struct radix_tree_node
*node
;
211 rtp
= &__get_cpu_var(radix_tree_preloads
);
212 while (rtp
->nr
< ARRAY_SIZE(rtp
->nodes
)) {
214 node
= kmem_cache_alloc(radix_tree_node_cachep
, gfp_mask
);
218 rtp
= &__get_cpu_var(radix_tree_preloads
);
219 if (rtp
->nr
< ARRAY_SIZE(rtp
->nodes
))
220 rtp
->nodes
[rtp
->nr
++] = node
;
222 kmem_cache_free(radix_tree_node_cachep
, node
);
228 EXPORT_SYMBOL(radix_tree_preload
);
231 * Return the maximum key which can be store into a
232 * radix tree with height HEIGHT.
234 static inline unsigned long radix_tree_maxindex(unsigned int height
)
236 return height_to_maxindex
[height
];
240 * Extend a radix tree so it can store key @index.
242 static int radix_tree_extend(struct radix_tree_root
*root
, unsigned long index
)
244 struct radix_tree_node
*node
;
248 /* Figure out what the height should be. */
249 height
= root
->height
+ 1;
250 while (index
> radix_tree_maxindex(height
))
253 if (root
->rnode
== NULL
) {
254 root
->height
= height
;
259 unsigned int newheight
;
260 if (!(node
= radix_tree_node_alloc(root
)))
263 /* Increase the height. */
264 node
->slots
[0] = radix_tree_indirect_to_ptr(root
->rnode
);
266 /* Propagate the aggregated tag info into the new root */
267 for (tag
= 0; tag
< RADIX_TREE_MAX_TAGS
; tag
++) {
268 if (root_tag_get(root
, tag
))
269 tag_set(node
, tag
, 0);
272 newheight
= root
->height
+1;
273 node
->height
= newheight
;
275 node
= radix_tree_ptr_to_indirect(node
);
276 rcu_assign_pointer(root
->rnode
, node
);
277 root
->height
= newheight
;
278 } while (height
> root
->height
);
284 * radix_tree_insert - insert into a radix tree
285 * @root: radix tree root
287 * @item: item to insert
289 * Insert an item into the radix tree at position @index.
291 int radix_tree_insert(struct radix_tree_root
*root
,
292 unsigned long index
, void *item
)
294 struct radix_tree_node
*node
= NULL
, *slot
;
295 unsigned int height
, shift
;
299 BUG_ON(radix_tree_is_indirect_ptr(item
));
301 /* Make sure the tree is high enough. */
302 if (index
> radix_tree_maxindex(root
->height
)) {
303 error
= radix_tree_extend(root
, index
);
308 slot
= radix_tree_indirect_to_ptr(root
->rnode
);
310 height
= root
->height
;
311 shift
= (height
-1) * RADIX_TREE_MAP_SHIFT
;
313 offset
= 0; /* uninitialised var warning */
316 /* Have to add a child node. */
317 if (!(slot
= radix_tree_node_alloc(root
)))
319 slot
->height
= height
;
321 rcu_assign_pointer(node
->slots
[offset
], slot
);
324 rcu_assign_pointer(root
->rnode
,
325 radix_tree_ptr_to_indirect(slot
));
328 /* Go a level down */
329 offset
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
331 slot
= node
->slots
[offset
];
332 shift
-= RADIX_TREE_MAP_SHIFT
;
341 rcu_assign_pointer(node
->slots
[offset
], item
);
342 BUG_ON(tag_get(node
, 0, offset
));
343 BUG_ON(tag_get(node
, 1, offset
));
345 rcu_assign_pointer(root
->rnode
, item
);
346 BUG_ON(root_tag_get(root
, 0));
347 BUG_ON(root_tag_get(root
, 1));
352 EXPORT_SYMBOL(radix_tree_insert
);
355 * radix_tree_lookup_slot - lookup a slot in a radix tree
356 * @root: radix tree root
359 * Returns: the slot corresponding to the position @index in the
360 * radix tree @root. This is useful for update-if-exists operations.
362 * This function can be called under rcu_read_lock iff the slot is not
363 * modified by radix_tree_replace_slot, otherwise it must be called
364 * exclusive from other writers. Any dereference of the slot must be done
365 * using radix_tree_deref_slot.
367 void **radix_tree_lookup_slot(struct radix_tree_root
*root
, unsigned long index
)
369 unsigned int height
, shift
;
370 struct radix_tree_node
*node
, **slot
;
372 node
= rcu_dereference(root
->rnode
);
376 if (!radix_tree_is_indirect_ptr(node
)) {
379 return (void **)&root
->rnode
;
381 node
= radix_tree_indirect_to_ptr(node
);
383 height
= node
->height
;
384 if (index
> radix_tree_maxindex(height
))
387 shift
= (height
-1) * RADIX_TREE_MAP_SHIFT
;
390 slot
= (struct radix_tree_node
**)
391 (node
->slots
+ ((index
>>shift
) & RADIX_TREE_MAP_MASK
));
392 node
= rcu_dereference(*slot
);
396 shift
-= RADIX_TREE_MAP_SHIFT
;
398 } while (height
> 0);
400 return (void **)slot
;
402 EXPORT_SYMBOL(radix_tree_lookup_slot
);
405 * radix_tree_lookup - perform lookup operation on a radix tree
406 * @root: radix tree root
409 * Lookup the item at the position @index in the radix tree @root.
411 * This function can be called under rcu_read_lock, however the caller
412 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
413 * them safely). No RCU barriers are required to access or modify the
414 * returned item, however.
416 void *radix_tree_lookup(struct radix_tree_root
*root
, unsigned long index
)
418 unsigned int height
, shift
;
419 struct radix_tree_node
*node
, **slot
;
421 node
= rcu_dereference(root
->rnode
);
425 if (!radix_tree_is_indirect_ptr(node
)) {
430 node
= radix_tree_indirect_to_ptr(node
);
432 height
= node
->height
;
433 if (index
> radix_tree_maxindex(height
))
436 shift
= (height
-1) * RADIX_TREE_MAP_SHIFT
;
439 slot
= (struct radix_tree_node
**)
440 (node
->slots
+ ((index
>>shift
) & RADIX_TREE_MAP_MASK
));
441 node
= rcu_dereference(*slot
);
445 shift
-= RADIX_TREE_MAP_SHIFT
;
447 } while (height
> 0);
451 EXPORT_SYMBOL(radix_tree_lookup
);
454 * radix_tree_tag_set - set a tag on a radix tree node
455 * @root: radix tree root
459 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
460 * corresponding to @index in the radix tree. From
461 * the root all the way down to the leaf node.
463 * Returns the address of the tagged item. Setting a tag on a not-present
466 void *radix_tree_tag_set(struct radix_tree_root
*root
,
467 unsigned long index
, unsigned int tag
)
469 unsigned int height
, shift
;
470 struct radix_tree_node
*slot
;
472 height
= root
->height
;
473 BUG_ON(index
> radix_tree_maxindex(height
));
475 slot
= radix_tree_indirect_to_ptr(root
->rnode
);
476 shift
= (height
- 1) * RADIX_TREE_MAP_SHIFT
;
481 offset
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
482 if (!tag_get(slot
, tag
, offset
))
483 tag_set(slot
, tag
, offset
);
484 slot
= slot
->slots
[offset
];
485 BUG_ON(slot
== NULL
);
486 shift
-= RADIX_TREE_MAP_SHIFT
;
490 /* set the root's tag bit */
491 if (slot
&& !root_tag_get(root
, tag
))
492 root_tag_set(root
, tag
);
496 EXPORT_SYMBOL(radix_tree_tag_set
);
499 * radix_tree_tag_clear - clear a tag on a radix tree node
500 * @root: radix tree root
504 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
505 * corresponding to @index in the radix tree. If
506 * this causes the leaf node to have no tags set then clear the tag in the
507 * next-to-leaf node, etc.
509 * Returns the address of the tagged item on success, else NULL. ie:
510 * has the same return value and semantics as radix_tree_lookup().
512 void *radix_tree_tag_clear(struct radix_tree_root
*root
,
513 unsigned long index
, unsigned int tag
)
516 * The radix tree path needs to be one longer than the maximum path
517 * since the "list" is null terminated.
519 struct radix_tree_path path
[RADIX_TREE_MAX_PATH
+ 1], *pathp
= path
;
520 struct radix_tree_node
*slot
= NULL
;
521 unsigned int height
, shift
;
523 height
= root
->height
;
524 if (index
> radix_tree_maxindex(height
))
527 shift
= (height
- 1) * RADIX_TREE_MAP_SHIFT
;
529 slot
= radix_tree_indirect_to_ptr(root
->rnode
);
537 offset
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
538 pathp
[1].offset
= offset
;
539 pathp
[1].node
= slot
;
540 slot
= slot
->slots
[offset
];
542 shift
-= RADIX_TREE_MAP_SHIFT
;
549 while (pathp
->node
) {
550 if (!tag_get(pathp
->node
, tag
, pathp
->offset
))
552 tag_clear(pathp
->node
, tag
, pathp
->offset
);
553 if (any_tag_set(pathp
->node
, tag
))
558 /* clear the root's tag bit */
559 if (root_tag_get(root
, tag
))
560 root_tag_clear(root
, tag
);
565 EXPORT_SYMBOL(radix_tree_tag_clear
);
567 #ifndef __KERNEL__ /* Only the test harness uses this at present */
569 * radix_tree_tag_get - get a tag on a radix tree node
570 * @root: radix tree root
572 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
576 * 0: tag not present or not set
579 int radix_tree_tag_get(struct radix_tree_root
*root
,
580 unsigned long index
, unsigned int tag
)
582 unsigned int height
, shift
;
583 struct radix_tree_node
*node
;
584 int saw_unset_tag
= 0;
586 /* check the root's tag bit */
587 if (!root_tag_get(root
, tag
))
590 node
= rcu_dereference(root
->rnode
);
594 if (!radix_tree_is_indirect_ptr(node
))
596 node
= radix_tree_indirect_to_ptr(node
);
598 height
= node
->height
;
599 if (index
> radix_tree_maxindex(height
))
602 shift
= (height
- 1) * RADIX_TREE_MAP_SHIFT
;
610 offset
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
613 * This is just a debug check. Later, we can bale as soon as
614 * we see an unset tag.
616 if (!tag_get(node
, tag
, offset
))
619 int ret
= tag_get(node
, tag
, offset
);
621 BUG_ON(ret
&& saw_unset_tag
);
624 node
= rcu_dereference(node
->slots
[offset
]);
625 shift
-= RADIX_TREE_MAP_SHIFT
;
629 EXPORT_SYMBOL(radix_tree_tag_get
);
633 * radix_tree_next_hole - find the next hole (not-present entry)
636 * @max_scan: maximum range to search
638 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the lowest
641 * Returns: the index of the hole if found, otherwise returns an index
642 * outside of the set specified (in which case 'return - index >= max_scan'
645 * radix_tree_next_hole may be called under rcu_read_lock. However, like
646 * radix_tree_gang_lookup, this will not atomically search a snapshot of the
647 * tree at a single point in time. For example, if a hole is created at index
648 * 5, then subsequently a hole is created at index 10, radix_tree_next_hole
649 * covering both indexes may return 10 if called under rcu_read_lock.
651 unsigned long radix_tree_next_hole(struct radix_tree_root
*root
,
652 unsigned long index
, unsigned long max_scan
)
656 for (i
= 0; i
< max_scan
; i
++) {
657 if (!radix_tree_lookup(root
, index
))
666 EXPORT_SYMBOL(radix_tree_next_hole
);
669 __lookup(struct radix_tree_node
*slot
, void ***results
, unsigned long index
,
670 unsigned int max_items
, unsigned long *next_index
)
672 unsigned int nr_found
= 0;
673 unsigned int shift
, height
;
676 height
= slot
->height
;
679 shift
= (height
-1) * RADIX_TREE_MAP_SHIFT
;
681 for ( ; height
> 1; height
--) {
682 i
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
684 if (slot
->slots
[i
] != NULL
)
686 index
&= ~((1UL << shift
) - 1);
687 index
+= 1UL << shift
;
689 goto out
; /* 32-bit wraparound */
691 if (i
== RADIX_TREE_MAP_SIZE
)
695 shift
-= RADIX_TREE_MAP_SHIFT
;
696 slot
= rcu_dereference(slot
->slots
[i
]);
701 /* Bottom level: grab some items */
702 for (i
= index
& RADIX_TREE_MAP_MASK
; i
< RADIX_TREE_MAP_SIZE
; i
++) {
704 if (slot
->slots
[i
]) {
705 results
[nr_found
++] = &(slot
->slots
[i
]);
706 if (nr_found
== max_items
)
716 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
717 * @root: radix tree root
718 * @results: where the results of the lookup are placed
719 * @first_index: start the lookup from this key
720 * @max_items: place up to this many items at *results
722 * Performs an index-ascending scan of the tree for present items. Places
723 * them at *@results and returns the number of items which were placed at
726 * The implementation is naive.
728 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
729 * rcu_read_lock. In this case, rather than the returned results being
730 * an atomic snapshot of the tree at a single point in time, the semantics
731 * of an RCU protected gang lookup are as though multiple radix_tree_lookups
732 * have been issued in individual locks, and results stored in 'results'.
735 radix_tree_gang_lookup(struct radix_tree_root
*root
, void **results
,
736 unsigned long first_index
, unsigned int max_items
)
738 unsigned long max_index
;
739 struct radix_tree_node
*node
;
740 unsigned long cur_index
= first_index
;
743 node
= rcu_dereference(root
->rnode
);
747 if (!radix_tree_is_indirect_ptr(node
)) {
753 node
= radix_tree_indirect_to_ptr(node
);
755 max_index
= radix_tree_maxindex(node
->height
);
758 while (ret
< max_items
) {
759 unsigned int nr_found
, slots_found
, i
;
760 unsigned long next_index
; /* Index of next search */
762 if (cur_index
> max_index
)
764 slots_found
= __lookup(node
, (void ***)results
+ ret
, cur_index
,
765 max_items
- ret
, &next_index
);
767 for (i
= 0; i
< slots_found
; i
++) {
768 struct radix_tree_node
*slot
;
769 slot
= *(((void ***)results
)[ret
+ i
]);
772 results
[ret
+ nr_found
] = rcu_dereference(slot
);
778 cur_index
= next_index
;
783 EXPORT_SYMBOL(radix_tree_gang_lookup
);
786 * radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
787 * @root: radix tree root
788 * @results: where the results of the lookup are placed
789 * @first_index: start the lookup from this key
790 * @max_items: place up to this many items at *results
792 * Performs an index-ascending scan of the tree for present items. Places
793 * their slots at *@results and returns the number of items which were
794 * placed at *@results.
796 * The implementation is naive.
798 * Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
799 * be dereferenced with radix_tree_deref_slot, and if using only RCU
800 * protection, radix_tree_deref_slot may fail requiring a retry.
803 radix_tree_gang_lookup_slot(struct radix_tree_root
*root
, void ***results
,
804 unsigned long first_index
, unsigned int max_items
)
806 unsigned long max_index
;
807 struct radix_tree_node
*node
;
808 unsigned long cur_index
= first_index
;
811 node
= rcu_dereference(root
->rnode
);
815 if (!radix_tree_is_indirect_ptr(node
)) {
818 results
[0] = (void **)&root
->rnode
;
821 node
= radix_tree_indirect_to_ptr(node
);
823 max_index
= radix_tree_maxindex(node
->height
);
826 while (ret
< max_items
) {
827 unsigned int slots_found
;
828 unsigned long next_index
; /* Index of next search */
830 if (cur_index
> max_index
)
832 slots_found
= __lookup(node
, results
+ ret
, cur_index
,
833 max_items
- ret
, &next_index
);
837 cur_index
= next_index
;
842 EXPORT_SYMBOL(radix_tree_gang_lookup_slot
);
845 * FIXME: the two tag_get()s here should use find_next_bit() instead of
846 * open-coding the search.
849 __lookup_tag(struct radix_tree_node
*slot
, void ***results
, unsigned long index
,
850 unsigned int max_items
, unsigned long *next_index
, unsigned int tag
)
852 unsigned int nr_found
= 0;
853 unsigned int shift
, height
;
855 height
= slot
->height
;
858 shift
= (height
-1) * RADIX_TREE_MAP_SHIFT
;
861 unsigned long i
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
864 if (tag_get(slot
, tag
, i
))
866 index
&= ~((1UL << shift
) - 1);
867 index
+= 1UL << shift
;
869 goto out
; /* 32-bit wraparound */
871 if (i
== RADIX_TREE_MAP_SIZE
)
875 if (height
== 0) { /* Bottom level: grab some items */
876 unsigned long j
= index
& RADIX_TREE_MAP_MASK
;
878 for ( ; j
< RADIX_TREE_MAP_SIZE
; j
++) {
880 if (!tag_get(slot
, tag
, j
))
883 * Even though the tag was found set, we need to
884 * recheck that we have a non-NULL node, because
885 * if this lookup is lockless, it may have been
886 * subsequently deleted.
888 * Similar care must be taken in any place that
889 * lookup ->slots[x] without a lock (ie. can't
890 * rely on its value remaining the same).
892 if (slot
->slots
[j
]) {
893 results
[nr_found
++] = &(slot
->slots
[j
]);
894 if (nr_found
== max_items
)
899 shift
-= RADIX_TREE_MAP_SHIFT
;
900 slot
= rcu_dereference(slot
->slots
[i
]);
910 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
912 * @root: radix tree root
913 * @results: where the results of the lookup are placed
914 * @first_index: start the lookup from this key
915 * @max_items: place up to this many items at *results
916 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
918 * Performs an index-ascending scan of the tree for present items which
919 * have the tag indexed by @tag set. Places the items at *@results and
920 * returns the number of items which were placed at *@results.
923 radix_tree_gang_lookup_tag(struct radix_tree_root
*root
, void **results
,
924 unsigned long first_index
, unsigned int max_items
,
927 struct radix_tree_node
*node
;
928 unsigned long max_index
;
929 unsigned long cur_index
= first_index
;
932 /* check the root's tag bit */
933 if (!root_tag_get(root
, tag
))
936 node
= rcu_dereference(root
->rnode
);
940 if (!radix_tree_is_indirect_ptr(node
)) {
946 node
= radix_tree_indirect_to_ptr(node
);
948 max_index
= radix_tree_maxindex(node
->height
);
951 while (ret
< max_items
) {
952 unsigned int nr_found
, slots_found
, i
;
953 unsigned long next_index
; /* Index of next search */
955 if (cur_index
> max_index
)
957 slots_found
= __lookup_tag(node
, (void ***)results
+ ret
,
958 cur_index
, max_items
- ret
, &next_index
, tag
);
960 for (i
= 0; i
< slots_found
; i
++) {
961 struct radix_tree_node
*slot
;
962 slot
= *(((void ***)results
)[ret
+ i
]);
965 results
[ret
+ nr_found
] = rcu_dereference(slot
);
971 cur_index
= next_index
;
976 EXPORT_SYMBOL(radix_tree_gang_lookup_tag
);
979 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
980 * radix tree based on a tag
981 * @root: radix tree root
982 * @results: where the results of the lookup are placed
983 * @first_index: start the lookup from this key
984 * @max_items: place up to this many items at *results
985 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
987 * Performs an index-ascending scan of the tree for present items which
988 * have the tag indexed by @tag set. Places the slots at *@results and
989 * returns the number of slots which were placed at *@results.
992 radix_tree_gang_lookup_tag_slot(struct radix_tree_root
*root
, void ***results
,
993 unsigned long first_index
, unsigned int max_items
,
996 struct radix_tree_node
*node
;
997 unsigned long max_index
;
998 unsigned long cur_index
= first_index
;
1001 /* check the root's tag bit */
1002 if (!root_tag_get(root
, tag
))
1005 node
= rcu_dereference(root
->rnode
);
1009 if (!radix_tree_is_indirect_ptr(node
)) {
1010 if (first_index
> 0)
1012 results
[0] = (void **)&root
->rnode
;
1015 node
= radix_tree_indirect_to_ptr(node
);
1017 max_index
= radix_tree_maxindex(node
->height
);
1020 while (ret
< max_items
) {
1021 unsigned int slots_found
;
1022 unsigned long next_index
; /* Index of next search */
1024 if (cur_index
> max_index
)
1026 slots_found
= __lookup_tag(node
, results
+ ret
,
1027 cur_index
, max_items
- ret
, &next_index
, tag
);
1029 if (next_index
== 0)
1031 cur_index
= next_index
;
1036 EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot
);
1040 * radix_tree_shrink - shrink height of a radix tree to minimal
1041 * @root radix tree root
1043 static inline void radix_tree_shrink(struct radix_tree_root
*root
)
1045 /* try to shrink tree height */
1046 while (root
->height
> 0) {
1047 struct radix_tree_node
*to_free
= root
->rnode
;
1050 BUG_ON(!radix_tree_is_indirect_ptr(to_free
));
1051 to_free
= radix_tree_indirect_to_ptr(to_free
);
1054 * The candidate node has more than one child, or its child
1055 * is not at the leftmost slot, we cannot shrink.
1057 if (to_free
->count
!= 1)
1059 if (!to_free
->slots
[0])
1063 * We don't need rcu_assign_pointer(), since we are simply
1064 * moving the node from one part of the tree to another. If
1065 * it was safe to dereference the old pointer to it
1066 * (to_free->slots[0]), it will be safe to dereference the new
1067 * one (root->rnode).
1069 newptr
= to_free
->slots
[0];
1070 if (root
->height
> 1)
1071 newptr
= radix_tree_ptr_to_indirect(newptr
);
1072 root
->rnode
= newptr
;
1074 radix_tree_node_free(to_free
);
1079 * radix_tree_delete - delete an item from a radix tree
1080 * @root: radix tree root
1083 * Remove the item at @index from the radix tree rooted at @root.
1085 * Returns the address of the deleted item, or NULL if it was not present.
1087 void *radix_tree_delete(struct radix_tree_root
*root
, unsigned long index
)
1090 * The radix tree path needs to be one longer than the maximum path
1091 * since the "list" is null terminated.
1093 struct radix_tree_path path
[RADIX_TREE_MAX_PATH
+ 1], *pathp
= path
;
1094 struct radix_tree_node
*slot
= NULL
;
1095 struct radix_tree_node
*to_free
;
1096 unsigned int height
, shift
;
1100 height
= root
->height
;
1101 if (index
> radix_tree_maxindex(height
))
1106 root_tag_clear_all(root
);
1110 slot
= radix_tree_indirect_to_ptr(slot
);
1112 shift
= (height
- 1) * RADIX_TREE_MAP_SHIFT
;
1120 offset
= (index
>> shift
) & RADIX_TREE_MAP_MASK
;
1121 pathp
->offset
= offset
;
1123 slot
= slot
->slots
[offset
];
1124 shift
-= RADIX_TREE_MAP_SHIFT
;
1126 } while (height
> 0);
1132 * Clear all tags associated with the just-deleted item
1134 for (tag
= 0; tag
< RADIX_TREE_MAX_TAGS
; tag
++) {
1135 if (tag_get(pathp
->node
, tag
, pathp
->offset
))
1136 radix_tree_tag_clear(root
, index
, tag
);
1140 /* Now free the nodes we do not need anymore */
1141 while (pathp
->node
) {
1142 pathp
->node
->slots
[pathp
->offset
] = NULL
;
1143 pathp
->node
->count
--;
1145 * Queue the node for deferred freeing after the
1146 * last reference to it disappears (set NULL, above).
1149 radix_tree_node_free(to_free
);
1151 if (pathp
->node
->count
) {
1153 radix_tree_indirect_to_ptr(root
->rnode
))
1154 radix_tree_shrink(root
);
1158 /* Node with zero slots in use so free it */
1159 to_free
= pathp
->node
;
1163 root_tag_clear_all(root
);
1167 radix_tree_node_free(to_free
);
1172 EXPORT_SYMBOL(radix_tree_delete
);
1175 * radix_tree_tagged - test whether any items in the tree are tagged
1176 * @root: radix tree root
1179 int radix_tree_tagged(struct radix_tree_root
*root
, unsigned int tag
)
1181 return root_tag_get(root
, tag
);
1183 EXPORT_SYMBOL(radix_tree_tagged
);
1186 radix_tree_node_ctor(void *node
)
1188 memset(node
, 0, sizeof(struct radix_tree_node
));
1191 static __init
unsigned long __maxindex(unsigned int height
)
1193 unsigned int width
= height
* RADIX_TREE_MAP_SHIFT
;
1194 int shift
= RADIX_TREE_INDEX_BITS
- width
;
1198 if (shift
>= BITS_PER_LONG
)
1200 return ~0UL >> shift
;
1203 static __init
void radix_tree_init_maxindex(void)
1207 for (i
= 0; i
< ARRAY_SIZE(height_to_maxindex
); i
++)
1208 height_to_maxindex
[i
] = __maxindex(i
);
1211 static int radix_tree_callback(struct notifier_block
*nfb
,
1212 unsigned long action
,
1215 int cpu
= (long)hcpu
;
1216 struct radix_tree_preload
*rtp
;
1218 /* Free per-cpu pool of perloaded nodes */
1219 if (action
== CPU_DEAD
|| action
== CPU_DEAD_FROZEN
) {
1220 rtp
= &per_cpu(radix_tree_preloads
, cpu
);
1222 kmem_cache_free(radix_tree_node_cachep
,
1223 rtp
->nodes
[rtp
->nr
-1]);
1224 rtp
->nodes
[rtp
->nr
-1] = NULL
;
1231 void __init
radix_tree_init(void)
1233 radix_tree_node_cachep
= kmem_cache_create("radix_tree_node",
1234 sizeof(struct radix_tree_node
), 0,
1235 SLAB_PANIC
| SLAB_RECLAIM_ACCOUNT
,
1236 radix_tree_node_ctor
);
1237 radix_tree_init_maxindex();
1238 hotcpu_notifier(radix_tree_callback
, 0);