radix-tree: radix_tree_range_tag_if_tagged() can set incorrect tags
[pandora-kernel.git] / lib / radix-tree.c
1 /*
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
6  *
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.
11  *
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.
16  *
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.
20  */
21
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/string.h>
32 #include <linux/bitops.h>
33 #include <linux/rcupdate.h>
34
35
36 #ifdef __KERNEL__
37 #define RADIX_TREE_MAP_SHIFT    (CONFIG_BASE_SMALL ? 4 : 6)
38 #else
39 #define RADIX_TREE_MAP_SHIFT    3       /* For more stressful testing */
40 #endif
41
42 #define RADIX_TREE_MAP_SIZE     (1UL << RADIX_TREE_MAP_SHIFT)
43 #define RADIX_TREE_MAP_MASK     (RADIX_TREE_MAP_SIZE-1)
44
45 #define RADIX_TREE_TAG_LONGS    \
46         ((RADIX_TREE_MAP_SIZE + BITS_PER_LONG - 1) / BITS_PER_LONG)
47
48 struct radix_tree_node {
49         unsigned int    height;         /* Height from the bottom */
50         unsigned int    count;
51         struct rcu_head rcu_head;
52         void            *slots[RADIX_TREE_MAP_SIZE];
53         unsigned long   tags[RADIX_TREE_MAX_TAGS][RADIX_TREE_TAG_LONGS];
54 };
55
56 struct radix_tree_path {
57         struct radix_tree_node *node;
58         int offset;
59 };
60
61 #define RADIX_TREE_INDEX_BITS  (8 /* CHAR_BIT */ * sizeof(unsigned long))
62 #define RADIX_TREE_MAX_PATH (DIV_ROUND_UP(RADIX_TREE_INDEX_BITS, \
63                                           RADIX_TREE_MAP_SHIFT))
64
65 /*
66  * The height_to_maxindex array needs to be one deeper than the maximum
67  * path as height 0 holds only 1 entry.
68  */
69 static unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1] __read_mostly;
70
71 /*
72  * Radix tree node cache.
73  */
74 static struct kmem_cache *radix_tree_node_cachep;
75
76 /*
77  * Per-cpu pool of preloaded nodes
78  */
79 struct radix_tree_preload {
80         int nr;
81         struct radix_tree_node *nodes[RADIX_TREE_MAX_PATH];
82 };
83 static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
84
85 static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
86 {
87         return root->gfp_mask & __GFP_BITS_MASK;
88 }
89
90 static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
91                 int offset)
92 {
93         __set_bit(offset, node->tags[tag]);
94 }
95
96 static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
97                 int offset)
98 {
99         __clear_bit(offset, node->tags[tag]);
100 }
101
102 static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
103                 int offset)
104 {
105         return test_bit(offset, node->tags[tag]);
106 }
107
108 static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
109 {
110         root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
111 }
112
113 static inline void root_tag_clear(struct radix_tree_root *root, unsigned int tag)
114 {
115         root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
116 }
117
118 static inline void root_tag_clear_all(struct radix_tree_root *root)
119 {
120         root->gfp_mask &= __GFP_BITS_MASK;
121 }
122
123 static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
124 {
125         return (__force unsigned)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
126 }
127
128 /*
129  * Returns 1 if any slot in the node has this tag set.
130  * Otherwise returns 0.
131  */
132 static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
133 {
134         int idx;
135         for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
136                 if (node->tags[tag][idx])
137                         return 1;
138         }
139         return 0;
140 }
141 /*
142  * This assumes that the caller has performed appropriate preallocation, and
143  * that the caller has pinned this thread of control to the current CPU.
144  */
145 static struct radix_tree_node *
146 radix_tree_node_alloc(struct radix_tree_root *root)
147 {
148         struct radix_tree_node *ret = NULL;
149         gfp_t gfp_mask = root_gfp_mask(root);
150
151         if (!(gfp_mask & __GFP_WAIT)) {
152                 struct radix_tree_preload *rtp;
153
154                 /*
155                  * Provided the caller has preloaded here, we will always
156                  * succeed in getting a node here (and never reach
157                  * kmem_cache_alloc)
158                  */
159                 rtp = &__get_cpu_var(radix_tree_preloads);
160                 if (rtp->nr) {
161                         ret = rtp->nodes[rtp->nr - 1];
162                         rtp->nodes[rtp->nr - 1] = NULL;
163                         rtp->nr--;
164                 }
165         }
166         if (ret == NULL)
167                 ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
168
169         BUG_ON(radix_tree_is_indirect_ptr(ret));
170         return ret;
171 }
172
173 static void radix_tree_node_rcu_free(struct rcu_head *head)
174 {
175         struct radix_tree_node *node =
176                         container_of(head, struct radix_tree_node, rcu_head);
177         int i;
178
179         /*
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.
183          */
184         for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
185                 tag_clear(node, i, 0);
186
187         node->slots[0] = NULL;
188         node->count = 0;
189
190         kmem_cache_free(radix_tree_node_cachep, node);
191 }
192
193 static inline void
194 radix_tree_node_free(struct radix_tree_node *node)
195 {
196         call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
197 }
198
199 /*
200  * Load up this CPU's radix_tree_node buffer with sufficient objects to
201  * ensure that the addition of a single element in the tree cannot fail.  On
202  * success, return zero, with preemption disabled.  On error, return -ENOMEM
203  * with preemption not disabled.
204  *
205  * To make use of this facility, the radix tree must be initialised without
206  * __GFP_WAIT being passed to INIT_RADIX_TREE().
207  */
208 int radix_tree_preload(gfp_t gfp_mask)
209 {
210         struct radix_tree_preload *rtp;
211         struct radix_tree_node *node;
212         int ret = -ENOMEM;
213
214         preempt_disable();
215         rtp = &__get_cpu_var(radix_tree_preloads);
216         while (rtp->nr < ARRAY_SIZE(rtp->nodes)) {
217                 preempt_enable();
218                 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
219                 if (node == NULL)
220                         goto out;
221                 preempt_disable();
222                 rtp = &__get_cpu_var(radix_tree_preloads);
223                 if (rtp->nr < ARRAY_SIZE(rtp->nodes))
224                         rtp->nodes[rtp->nr++] = node;
225                 else
226                         kmem_cache_free(radix_tree_node_cachep, node);
227         }
228         ret = 0;
229 out:
230         return ret;
231 }
232 EXPORT_SYMBOL(radix_tree_preload);
233
234 /*
235  *      Return the maximum key which can be store into a
236  *      radix tree with height HEIGHT.
237  */
238 static inline unsigned long radix_tree_maxindex(unsigned int height)
239 {
240         return height_to_maxindex[height];
241 }
242
243 /*
244  *      Extend a radix tree so it can store key @index.
245  */
246 static int radix_tree_extend(struct radix_tree_root *root, unsigned long index)
247 {
248         struct radix_tree_node *node;
249         unsigned int height;
250         int tag;
251
252         /* Figure out what the height should be.  */
253         height = root->height + 1;
254         while (index > radix_tree_maxindex(height))
255                 height++;
256
257         if (root->rnode == NULL) {
258                 root->height = height;
259                 goto out;
260         }
261
262         do {
263                 unsigned int newheight;
264                 if (!(node = radix_tree_node_alloc(root)))
265                         return -ENOMEM;
266
267                 /* Increase the height.  */
268                 node->slots[0] = radix_tree_indirect_to_ptr(root->rnode);
269
270                 /* Propagate the aggregated tag info into the new root */
271                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
272                         if (root_tag_get(root, tag))
273                                 tag_set(node, tag, 0);
274                 }
275
276                 newheight = root->height+1;
277                 node->height = newheight;
278                 node->count = 1;
279                 node = radix_tree_ptr_to_indirect(node);
280                 rcu_assign_pointer(root->rnode, node);
281                 root->height = newheight;
282         } while (height > root->height);
283 out:
284         return 0;
285 }
286
287 /**
288  *      radix_tree_insert    -    insert into a radix tree
289  *      @root:          radix tree root
290  *      @index:         index key
291  *      @item:          item to insert
292  *
293  *      Insert an item into the radix tree at position @index.
294  */
295 int radix_tree_insert(struct radix_tree_root *root,
296                         unsigned long index, void *item)
297 {
298         struct radix_tree_node *node = NULL, *slot;
299         unsigned int height, shift;
300         int offset;
301         int error;
302
303         BUG_ON(radix_tree_is_indirect_ptr(item));
304
305         /* Make sure the tree is high enough.  */
306         if (index > radix_tree_maxindex(root->height)) {
307                 error = radix_tree_extend(root, index);
308                 if (error)
309                         return error;
310         }
311
312         slot = radix_tree_indirect_to_ptr(root->rnode);
313
314         height = root->height;
315         shift = (height-1) * RADIX_TREE_MAP_SHIFT;
316
317         offset = 0;                     /* uninitialised var warning */
318         while (height > 0) {
319                 if (slot == NULL) {
320                         /* Have to add a child node.  */
321                         if (!(slot = radix_tree_node_alloc(root)))
322                                 return -ENOMEM;
323                         slot->height = height;
324                         if (node) {
325                                 rcu_assign_pointer(node->slots[offset], slot);
326                                 node->count++;
327                         } else
328                                 rcu_assign_pointer(root->rnode,
329                                         radix_tree_ptr_to_indirect(slot));
330                 }
331
332                 /* Go a level down */
333                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
334                 node = slot;
335                 slot = node->slots[offset];
336                 shift -= RADIX_TREE_MAP_SHIFT;
337                 height--;
338         }
339
340         if (slot != NULL)
341                 return -EEXIST;
342
343         if (node) {
344                 node->count++;
345                 rcu_assign_pointer(node->slots[offset], item);
346                 BUG_ON(tag_get(node, 0, offset));
347                 BUG_ON(tag_get(node, 1, offset));
348         } else {
349                 rcu_assign_pointer(root->rnode, item);
350                 BUG_ON(root_tag_get(root, 0));
351                 BUG_ON(root_tag_get(root, 1));
352         }
353
354         return 0;
355 }
356 EXPORT_SYMBOL(radix_tree_insert);
357
358 /*
359  * is_slot == 1 : search for the slot.
360  * is_slot == 0 : search for the node.
361  */
362 static void *radix_tree_lookup_element(struct radix_tree_root *root,
363                                 unsigned long index, int is_slot)
364 {
365         unsigned int height, shift;
366         struct radix_tree_node *node, **slot;
367
368         node = rcu_dereference_raw(root->rnode);
369         if (node == NULL)
370                 return NULL;
371
372         if (!radix_tree_is_indirect_ptr(node)) {
373                 if (index > 0)
374                         return NULL;
375                 return is_slot ? (void *)&root->rnode : node;
376         }
377         node = radix_tree_indirect_to_ptr(node);
378
379         height = node->height;
380         if (index > radix_tree_maxindex(height))
381                 return NULL;
382
383         shift = (height-1) * RADIX_TREE_MAP_SHIFT;
384
385         do {
386                 slot = (struct radix_tree_node **)
387                         (node->slots + ((index>>shift) & RADIX_TREE_MAP_MASK));
388                 node = rcu_dereference_raw(*slot);
389                 if (node == NULL)
390                         return NULL;
391
392                 shift -= RADIX_TREE_MAP_SHIFT;
393                 height--;
394         } while (height > 0);
395
396         return is_slot ? (void *)slot:node;
397 }
398
399 /**
400  *      radix_tree_lookup_slot    -    lookup a slot in a radix tree
401  *      @root:          radix tree root
402  *      @index:         index key
403  *
404  *      Returns:  the slot corresponding to the position @index in the
405  *      radix tree @root. This is useful for update-if-exists operations.
406  *
407  *      This function can be called under rcu_read_lock iff the slot is not
408  *      modified by radix_tree_replace_slot, otherwise it must be called
409  *      exclusive from other writers. Any dereference of the slot must be done
410  *      using radix_tree_deref_slot.
411  */
412 void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
413 {
414         return (void **)radix_tree_lookup_element(root, index, 1);
415 }
416 EXPORT_SYMBOL(radix_tree_lookup_slot);
417
418 /**
419  *      radix_tree_lookup    -    perform lookup operation on a radix tree
420  *      @root:          radix tree root
421  *      @index:         index key
422  *
423  *      Lookup the item at the position @index in the radix tree @root.
424  *
425  *      This function can be called under rcu_read_lock, however the caller
426  *      must manage lifetimes of leaf nodes (eg. RCU may also be used to free
427  *      them safely). No RCU barriers are required to access or modify the
428  *      returned item, however.
429  */
430 void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
431 {
432         return radix_tree_lookup_element(root, index, 0);
433 }
434 EXPORT_SYMBOL(radix_tree_lookup);
435
436 /**
437  *      radix_tree_tag_set - set a tag on a radix tree node
438  *      @root:          radix tree root
439  *      @index:         index key
440  *      @tag:           tag index
441  *
442  *      Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
443  *      corresponding to @index in the radix tree.  From
444  *      the root all the way down to the leaf node.
445  *
446  *      Returns the address of the tagged item.   Setting a tag on a not-present
447  *      item is a bug.
448  */
449 void *radix_tree_tag_set(struct radix_tree_root *root,
450                         unsigned long index, unsigned int tag)
451 {
452         unsigned int height, shift;
453         struct radix_tree_node *slot;
454
455         height = root->height;
456         BUG_ON(index > radix_tree_maxindex(height));
457
458         slot = radix_tree_indirect_to_ptr(root->rnode);
459         shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
460
461         while (height > 0) {
462                 int offset;
463
464                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
465                 if (!tag_get(slot, tag, offset))
466                         tag_set(slot, tag, offset);
467                 slot = slot->slots[offset];
468                 BUG_ON(slot == NULL);
469                 shift -= RADIX_TREE_MAP_SHIFT;
470                 height--;
471         }
472
473         /* set the root's tag bit */
474         if (slot && !root_tag_get(root, tag))
475                 root_tag_set(root, tag);
476
477         return slot;
478 }
479 EXPORT_SYMBOL(radix_tree_tag_set);
480
481 /**
482  *      radix_tree_tag_clear - clear a tag on a radix tree node
483  *      @root:          radix tree root
484  *      @index:         index key
485  *      @tag:           tag index
486  *
487  *      Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
488  *      corresponding to @index in the radix tree.  If
489  *      this causes the leaf node to have no tags set then clear the tag in the
490  *      next-to-leaf node, etc.
491  *
492  *      Returns the address of the tagged item on success, else NULL.  ie:
493  *      has the same return value and semantics as radix_tree_lookup().
494  */
495 void *radix_tree_tag_clear(struct radix_tree_root *root,
496                         unsigned long index, unsigned int tag)
497 {
498         /*
499          * The radix tree path needs to be one longer than the maximum path
500          * since the "list" is null terminated.
501          */
502         struct radix_tree_path path[RADIX_TREE_MAX_PATH + 1], *pathp = path;
503         struct radix_tree_node *slot = NULL;
504         unsigned int height, shift;
505
506         height = root->height;
507         if (index > radix_tree_maxindex(height))
508                 goto out;
509
510         shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
511         pathp->node = NULL;
512         slot = radix_tree_indirect_to_ptr(root->rnode);
513
514         while (height > 0) {
515                 int offset;
516
517                 if (slot == NULL)
518                         goto out;
519
520                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
521                 pathp[1].offset = offset;
522                 pathp[1].node = slot;
523                 slot = slot->slots[offset];
524                 pathp++;
525                 shift -= RADIX_TREE_MAP_SHIFT;
526                 height--;
527         }
528
529         if (slot == NULL)
530                 goto out;
531
532         while (pathp->node) {
533                 if (!tag_get(pathp->node, tag, pathp->offset))
534                         goto out;
535                 tag_clear(pathp->node, tag, pathp->offset);
536                 if (any_tag_set(pathp->node, tag))
537                         goto out;
538                 pathp--;
539         }
540
541         /* clear the root's tag bit */
542         if (root_tag_get(root, tag))
543                 root_tag_clear(root, tag);
544
545 out:
546         return slot;
547 }
548 EXPORT_SYMBOL(radix_tree_tag_clear);
549
550 /**
551  * radix_tree_tag_get - get a tag on a radix tree node
552  * @root:               radix tree root
553  * @index:              index key
554  * @tag:                tag index (< RADIX_TREE_MAX_TAGS)
555  *
556  * Return values:
557  *
558  *  0: tag not present or not set
559  *  1: tag set
560  *
561  * Note that the return value of this function may not be relied on, even if
562  * the RCU lock is held, unless tag modification and node deletion are excluded
563  * from concurrency.
564  */
565 int radix_tree_tag_get(struct radix_tree_root *root,
566                         unsigned long index, unsigned int tag)
567 {
568         unsigned int height, shift;
569         struct radix_tree_node *node;
570         int saw_unset_tag = 0;
571
572         /* check the root's tag bit */
573         if (!root_tag_get(root, tag))
574                 return 0;
575
576         node = rcu_dereference_raw(root->rnode);
577         if (node == NULL)
578                 return 0;
579
580         if (!radix_tree_is_indirect_ptr(node))
581                 return (index == 0);
582         node = radix_tree_indirect_to_ptr(node);
583
584         height = node->height;
585         if (index > radix_tree_maxindex(height))
586                 return 0;
587
588         shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
589
590         for ( ; ; ) {
591                 int offset;
592
593                 if (node == NULL)
594                         return 0;
595
596                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
597
598                 /*
599                  * This is just a debug check.  Later, we can bale as soon as
600                  * we see an unset tag.
601                  */
602                 if (!tag_get(node, tag, offset))
603                         saw_unset_tag = 1;
604                 if (height == 1)
605                         return !!tag_get(node, tag, offset);
606                 node = rcu_dereference_raw(node->slots[offset]);
607                 shift -= RADIX_TREE_MAP_SHIFT;
608                 height--;
609         }
610 }
611 EXPORT_SYMBOL(radix_tree_tag_get);
612
613 /**
614  * radix_tree_range_tag_if_tagged - for each item in given range set given
615  *                                 tag if item has another tag set
616  * @root:               radix tree root
617  * @first_indexp:       pointer to a starting index of a range to scan
618  * @last_index:         last index of a range to scan
619  * @nr_to_tag:          maximum number items to tag
620  * @iftag:              tag index to test
621  * @settag:             tag index to set if tested tag is set
622  *
623  * This function scans range of radix tree from first_index to last_index
624  * (inclusive).  For each item in the range if iftag is set, the function sets
625  * also settag. The function stops either after tagging nr_to_tag items or
626  * after reaching last_index.
627  *
628  * The tags must be set from the leaf level only and propagated back up the
629  * path to the root. We must do this so that we resolve the full path before
630  * setting any tags on intermediate nodes. If we set tags as we descend, then
631  * we can get to the leaf node and find that the index that has the iftag
632  * set is outside the range we are scanning. This reults in dangling tags and
633  * can lead to problems with later tag operations (e.g. livelocks on lookups).
634  *
635  * The function returns number of leaves where the tag was set and sets
636  * *first_indexp to the first unscanned index.
637  */
638 unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
639                 unsigned long *first_indexp, unsigned long last_index,
640                 unsigned long nr_to_tag,
641                 unsigned int iftag, unsigned int settag)
642 {
643         unsigned int height = root->height;
644         struct radix_tree_path path[height];
645         struct radix_tree_path *pathp = path;
646         struct radix_tree_node *slot;
647         unsigned int shift;
648         unsigned long tagged = 0;
649         unsigned long index = *first_indexp;
650
651         last_index = min(last_index, radix_tree_maxindex(height));
652         if (index > last_index)
653                 return 0;
654         if (!nr_to_tag)
655                 return 0;
656         if (!root_tag_get(root, iftag)) {
657                 *first_indexp = last_index + 1;
658                 return 0;
659         }
660         if (height == 0) {
661                 *first_indexp = last_index + 1;
662                 root_tag_set(root, settag);
663                 return 1;
664         }
665
666         shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
667         slot = radix_tree_indirect_to_ptr(root->rnode);
668
669         /*
670          * we fill the path from (root->height - 2) to 0, leaving the index at
671          * (root->height - 1) as a terminator. Zero the node in the terminator
672          * so that we can use this to end walk loops back up the path.
673          */
674         path[height - 1].node = NULL;
675
676         for (;;) {
677                 int offset;
678
679                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
680                 if (!slot->slots[offset])
681                         goto next;
682                 if (!tag_get(slot, iftag, offset))
683                         goto next;
684                 if (height > 1) {
685                         /* Go down one level */
686                         height--;
687                         shift -= RADIX_TREE_MAP_SHIFT;
688                         path[height - 1].node = slot;
689                         path[height - 1].offset = offset;
690                         slot = slot->slots[offset];
691                         continue;
692                 }
693
694                 /* tag the leaf */
695                 tagged++;
696                 tag_set(slot, settag, offset);
697
698                 /* walk back up the path tagging interior nodes */
699                 pathp = &path[0];
700                 while (pathp->node) {
701                         /* stop if we find a node with the tag already set */
702                         if (tag_get(pathp->node, settag, pathp->offset))
703                                 break;
704                         tag_set(pathp->node, settag, pathp->offset);
705                         pathp++;
706                 }
707
708 next:
709                 /* Go to next item at level determined by 'shift' */
710                 index = ((index >> shift) + 1) << shift;
711                 if (index > last_index)
712                         break;
713                 if (tagged >= nr_to_tag)
714                         break;
715                 while (((index >> shift) & RADIX_TREE_MAP_MASK) == 0) {
716                         /*
717                          * We've fully scanned this node. Go up. Because
718                          * last_index is guaranteed to be in the tree, what
719                          * we do below cannot wander astray.
720                          */
721                         slot = path[height - 1].node;
722                         height++;
723                         shift += RADIX_TREE_MAP_SHIFT;
724                 }
725         }
726         /*
727          * The iftag must have been set somewhere because otherwise
728          * we would return immediated at the beginning of the function
729          */
730         root_tag_set(root, settag);
731         *first_indexp = index;
732
733         return tagged;
734 }
735 EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
736
737
738 /**
739  *      radix_tree_next_hole    -    find the next hole (not-present entry)
740  *      @root:          tree root
741  *      @index:         index key
742  *      @max_scan:      maximum range to search
743  *
744  *      Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the lowest
745  *      indexed hole.
746  *
747  *      Returns: the index of the hole if found, otherwise returns an index
748  *      outside of the set specified (in which case 'return - index >= max_scan'
749  *      will be true). In rare cases of index wrap-around, 0 will be returned.
750  *
751  *      radix_tree_next_hole may be called under rcu_read_lock. However, like
752  *      radix_tree_gang_lookup, this will not atomically search a snapshot of
753  *      the tree at a single point in time. For example, if a hole is created
754  *      at index 5, then subsequently a hole is created at index 10,
755  *      radix_tree_next_hole covering both indexes may return 10 if called
756  *      under rcu_read_lock.
757  */
758 unsigned long radix_tree_next_hole(struct radix_tree_root *root,
759                                 unsigned long index, unsigned long max_scan)
760 {
761         unsigned long i;
762
763         for (i = 0; i < max_scan; i++) {
764                 if (!radix_tree_lookup(root, index))
765                         break;
766                 index++;
767                 if (index == 0)
768                         break;
769         }
770
771         return index;
772 }
773 EXPORT_SYMBOL(radix_tree_next_hole);
774
775 /**
776  *      radix_tree_prev_hole    -    find the prev hole (not-present entry)
777  *      @root:          tree root
778  *      @index:         index key
779  *      @max_scan:      maximum range to search
780  *
781  *      Search backwards in the range [max(index-max_scan+1, 0), index]
782  *      for the first hole.
783  *
784  *      Returns: the index of the hole if found, otherwise returns an index
785  *      outside of the set specified (in which case 'index - return >= max_scan'
786  *      will be true). In rare cases of wrap-around, ULONG_MAX will be returned.
787  *
788  *      radix_tree_next_hole may be called under rcu_read_lock. However, like
789  *      radix_tree_gang_lookup, this will not atomically search a snapshot of
790  *      the tree at a single point in time. For example, if a hole is created
791  *      at index 10, then subsequently a hole is created at index 5,
792  *      radix_tree_prev_hole covering both indexes may return 5 if called under
793  *      rcu_read_lock.
794  */
795 unsigned long radix_tree_prev_hole(struct radix_tree_root *root,
796                                    unsigned long index, unsigned long max_scan)
797 {
798         unsigned long i;
799
800         for (i = 0; i < max_scan; i++) {
801                 if (!radix_tree_lookup(root, index))
802                         break;
803                 index--;
804                 if (index == ULONG_MAX)
805                         break;
806         }
807
808         return index;
809 }
810 EXPORT_SYMBOL(radix_tree_prev_hole);
811
812 static unsigned int
813 __lookup(struct radix_tree_node *slot, void ***results, unsigned long index,
814         unsigned int max_items, unsigned long *next_index)
815 {
816         unsigned int nr_found = 0;
817         unsigned int shift, height;
818         unsigned long i;
819
820         height = slot->height;
821         if (height == 0)
822                 goto out;
823         shift = (height-1) * RADIX_TREE_MAP_SHIFT;
824
825         for ( ; height > 1; height--) {
826                 i = (index >> shift) & RADIX_TREE_MAP_MASK;
827                 for (;;) {
828                         if (slot->slots[i] != NULL)
829                                 break;
830                         index &= ~((1UL << shift) - 1);
831                         index += 1UL << shift;
832                         if (index == 0)
833                                 goto out;       /* 32-bit wraparound */
834                         i++;
835                         if (i == RADIX_TREE_MAP_SIZE)
836                                 goto out;
837                 }
838
839                 shift -= RADIX_TREE_MAP_SHIFT;
840                 slot = rcu_dereference_raw(slot->slots[i]);
841                 if (slot == NULL)
842                         goto out;
843         }
844
845         /* Bottom level: grab some items */
846         for (i = index & RADIX_TREE_MAP_MASK; i < RADIX_TREE_MAP_SIZE; i++) {
847                 index++;
848                 if (slot->slots[i]) {
849                         results[nr_found++] = &(slot->slots[i]);
850                         if (nr_found == max_items)
851                                 goto out;
852                 }
853         }
854 out:
855         *next_index = index;
856         return nr_found;
857 }
858
859 /**
860  *      radix_tree_gang_lookup - perform multiple lookup on a radix tree
861  *      @root:          radix tree root
862  *      @results:       where the results of the lookup are placed
863  *      @first_index:   start the lookup from this key
864  *      @max_items:     place up to this many items at *results
865  *
866  *      Performs an index-ascending scan of the tree for present items.  Places
867  *      them at *@results and returns the number of items which were placed at
868  *      *@results.
869  *
870  *      The implementation is naive.
871  *
872  *      Like radix_tree_lookup, radix_tree_gang_lookup may be called under
873  *      rcu_read_lock. In this case, rather than the returned results being
874  *      an atomic snapshot of the tree at a single point in time, the semantics
875  *      of an RCU protected gang lookup are as though multiple radix_tree_lookups
876  *      have been issued in individual locks, and results stored in 'results'.
877  */
878 unsigned int
879 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
880                         unsigned long first_index, unsigned int max_items)
881 {
882         unsigned long max_index;
883         struct radix_tree_node *node;
884         unsigned long cur_index = first_index;
885         unsigned int ret;
886
887         node = rcu_dereference_raw(root->rnode);
888         if (!node)
889                 return 0;
890
891         if (!radix_tree_is_indirect_ptr(node)) {
892                 if (first_index > 0)
893                         return 0;
894                 results[0] = node;
895                 return 1;
896         }
897         node = radix_tree_indirect_to_ptr(node);
898
899         max_index = radix_tree_maxindex(node->height);
900
901         ret = 0;
902         while (ret < max_items) {
903                 unsigned int nr_found, slots_found, i;
904                 unsigned long next_index;       /* Index of next search */
905
906                 if (cur_index > max_index)
907                         break;
908                 slots_found = __lookup(node, (void ***)results + ret, cur_index,
909                                         max_items - ret, &next_index);
910                 nr_found = 0;
911                 for (i = 0; i < slots_found; i++) {
912                         struct radix_tree_node *slot;
913                         slot = *(((void ***)results)[ret + i]);
914                         if (!slot)
915                                 continue;
916                         results[ret + nr_found] = rcu_dereference_raw(slot);
917                         nr_found++;
918                 }
919                 ret += nr_found;
920                 if (next_index == 0)
921                         break;
922                 cur_index = next_index;
923         }
924
925         return ret;
926 }
927 EXPORT_SYMBOL(radix_tree_gang_lookup);
928
929 /**
930  *      radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
931  *      @root:          radix tree root
932  *      @results:       where the results of the lookup are placed
933  *      @first_index:   start the lookup from this key
934  *      @max_items:     place up to this many items at *results
935  *
936  *      Performs an index-ascending scan of the tree for present items.  Places
937  *      their slots at *@results and returns the number of items which were
938  *      placed at *@results.
939  *
940  *      The implementation is naive.
941  *
942  *      Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
943  *      be dereferenced with radix_tree_deref_slot, and if using only RCU
944  *      protection, radix_tree_deref_slot may fail requiring a retry.
945  */
946 unsigned int
947 radix_tree_gang_lookup_slot(struct radix_tree_root *root, void ***results,
948                         unsigned long first_index, unsigned int max_items)
949 {
950         unsigned long max_index;
951         struct radix_tree_node *node;
952         unsigned long cur_index = first_index;
953         unsigned int ret;
954
955         node = rcu_dereference_raw(root->rnode);
956         if (!node)
957                 return 0;
958
959         if (!radix_tree_is_indirect_ptr(node)) {
960                 if (first_index > 0)
961                         return 0;
962                 results[0] = (void **)&root->rnode;
963                 return 1;
964         }
965         node = radix_tree_indirect_to_ptr(node);
966
967         max_index = radix_tree_maxindex(node->height);
968
969         ret = 0;
970         while (ret < max_items) {
971                 unsigned int slots_found;
972                 unsigned long next_index;       /* Index of next search */
973
974                 if (cur_index > max_index)
975                         break;
976                 slots_found = __lookup(node, results + ret, cur_index,
977                                         max_items - ret, &next_index);
978                 ret += slots_found;
979                 if (next_index == 0)
980                         break;
981                 cur_index = next_index;
982         }
983
984         return ret;
985 }
986 EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
987
988 /*
989  * FIXME: the two tag_get()s here should use find_next_bit() instead of
990  * open-coding the search.
991  */
992 static unsigned int
993 __lookup_tag(struct radix_tree_node *slot, void ***results, unsigned long index,
994         unsigned int max_items, unsigned long *next_index, unsigned int tag)
995 {
996         unsigned int nr_found = 0;
997         unsigned int shift, height;
998
999         height = slot->height;
1000         if (height == 0)
1001                 goto out;
1002         shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1003
1004         while (height > 0) {
1005                 unsigned long i = (index >> shift) & RADIX_TREE_MAP_MASK ;
1006
1007                 for (;;) {
1008                         if (tag_get(slot, tag, i))
1009                                 break;
1010                         index &= ~((1UL << shift) - 1);
1011                         index += 1UL << shift;
1012                         if (index == 0)
1013                                 goto out;       /* 32-bit wraparound */
1014                         i++;
1015                         if (i == RADIX_TREE_MAP_SIZE)
1016                                 goto out;
1017                 }
1018                 height--;
1019                 if (height == 0) {      /* Bottom level: grab some items */
1020                         unsigned long j = index & RADIX_TREE_MAP_MASK;
1021
1022                         for ( ; j < RADIX_TREE_MAP_SIZE; j++) {
1023                                 index++;
1024                                 if (!tag_get(slot, tag, j))
1025                                         continue;
1026                                 /*
1027                                  * Even though the tag was found set, we need to
1028                                  * recheck that we have a non-NULL node, because
1029                                  * if this lookup is lockless, it may have been
1030                                  * subsequently deleted.
1031                                  *
1032                                  * Similar care must be taken in any place that
1033                                  * lookup ->slots[x] without a lock (ie. can't
1034                                  * rely on its value remaining the same).
1035                                  */
1036                                 if (slot->slots[j]) {
1037                                         results[nr_found++] = &(slot->slots[j]);
1038                                         if (nr_found == max_items)
1039                                                 goto out;
1040                                 }
1041                         }
1042                 }
1043                 shift -= RADIX_TREE_MAP_SHIFT;
1044                 slot = rcu_dereference_raw(slot->slots[i]);
1045                 if (slot == NULL)
1046                         break;
1047         }
1048 out:
1049         *next_index = index;
1050         return nr_found;
1051 }
1052
1053 /**
1054  *      radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1055  *                                   based on a tag
1056  *      @root:          radix tree root
1057  *      @results:       where the results of the lookup are placed
1058  *      @first_index:   start the lookup from this key
1059  *      @max_items:     place up to this many items at *results
1060  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1061  *
1062  *      Performs an index-ascending scan of the tree for present items which
1063  *      have the tag indexed by @tag set.  Places the items at *@results and
1064  *      returns the number of items which were placed at *@results.
1065  */
1066 unsigned int
1067 radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
1068                 unsigned long first_index, unsigned int max_items,
1069                 unsigned int tag)
1070 {
1071         struct radix_tree_node *node;
1072         unsigned long max_index;
1073         unsigned long cur_index = first_index;
1074         unsigned int ret;
1075
1076         /* check the root's tag bit */
1077         if (!root_tag_get(root, tag))
1078                 return 0;
1079
1080         node = rcu_dereference_raw(root->rnode);
1081         if (!node)
1082                 return 0;
1083
1084         if (!radix_tree_is_indirect_ptr(node)) {
1085                 if (first_index > 0)
1086                         return 0;
1087                 results[0] = node;
1088                 return 1;
1089         }
1090         node = radix_tree_indirect_to_ptr(node);
1091
1092         max_index = radix_tree_maxindex(node->height);
1093
1094         ret = 0;
1095         while (ret < max_items) {
1096                 unsigned int nr_found, slots_found, i;
1097                 unsigned long next_index;       /* Index of next search */
1098
1099                 if (cur_index > max_index)
1100                         break;
1101                 slots_found = __lookup_tag(node, (void ***)results + ret,
1102                                 cur_index, max_items - ret, &next_index, tag);
1103                 nr_found = 0;
1104                 for (i = 0; i < slots_found; i++) {
1105                         struct radix_tree_node *slot;
1106                         slot = *(((void ***)results)[ret + i]);
1107                         if (!slot)
1108                                 continue;
1109                         results[ret + nr_found] = rcu_dereference_raw(slot);
1110                         nr_found++;
1111                 }
1112                 ret += nr_found;
1113                 if (next_index == 0)
1114                         break;
1115                 cur_index = next_index;
1116         }
1117
1118         return ret;
1119 }
1120 EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1121
1122 /**
1123  *      radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1124  *                                        radix tree based on a tag
1125  *      @root:          radix tree root
1126  *      @results:       where the results of the lookup are placed
1127  *      @first_index:   start the lookup from this key
1128  *      @max_items:     place up to this many items at *results
1129  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1130  *
1131  *      Performs an index-ascending scan of the tree for present items which
1132  *      have the tag indexed by @tag set.  Places the slots at *@results and
1133  *      returns the number of slots which were placed at *@results.
1134  */
1135 unsigned int
1136 radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1137                 unsigned long first_index, unsigned int max_items,
1138                 unsigned int tag)
1139 {
1140         struct radix_tree_node *node;
1141         unsigned long max_index;
1142         unsigned long cur_index = first_index;
1143         unsigned int ret;
1144
1145         /* check the root's tag bit */
1146         if (!root_tag_get(root, tag))
1147                 return 0;
1148
1149         node = rcu_dereference_raw(root->rnode);
1150         if (!node)
1151                 return 0;
1152
1153         if (!radix_tree_is_indirect_ptr(node)) {
1154                 if (first_index > 0)
1155                         return 0;
1156                 results[0] = (void **)&root->rnode;
1157                 return 1;
1158         }
1159         node = radix_tree_indirect_to_ptr(node);
1160
1161         max_index = radix_tree_maxindex(node->height);
1162
1163         ret = 0;
1164         while (ret < max_items) {
1165                 unsigned int slots_found;
1166                 unsigned long next_index;       /* Index of next search */
1167
1168                 if (cur_index > max_index)
1169                         break;
1170                 slots_found = __lookup_tag(node, results + ret,
1171                                 cur_index, max_items - ret, &next_index, tag);
1172                 ret += slots_found;
1173                 if (next_index == 0)
1174                         break;
1175                 cur_index = next_index;
1176         }
1177
1178         return ret;
1179 }
1180 EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1181
1182
1183 /**
1184  *      radix_tree_shrink    -    shrink height of a radix tree to minimal
1185  *      @root           radix tree root
1186  */
1187 static inline void radix_tree_shrink(struct radix_tree_root *root)
1188 {
1189         /* try to shrink tree height */
1190         while (root->height > 0) {
1191                 struct radix_tree_node *to_free = root->rnode;
1192                 void *newptr;
1193
1194                 BUG_ON(!radix_tree_is_indirect_ptr(to_free));
1195                 to_free = radix_tree_indirect_to_ptr(to_free);
1196
1197                 /*
1198                  * The candidate node has more than one child, or its child
1199                  * is not at the leftmost slot, we cannot shrink.
1200                  */
1201                 if (to_free->count != 1)
1202                         break;
1203                 if (!to_free->slots[0])
1204                         break;
1205
1206                 /*
1207                  * We don't need rcu_assign_pointer(), since we are simply
1208                  * moving the node from one part of the tree to another. If
1209                  * it was safe to dereference the old pointer to it
1210                  * (to_free->slots[0]), it will be safe to dereference the new
1211                  * one (root->rnode).
1212                  */
1213                 newptr = to_free->slots[0];
1214                 if (root->height > 1)
1215                         newptr = radix_tree_ptr_to_indirect(newptr);
1216                 root->rnode = newptr;
1217                 root->height--;
1218                 radix_tree_node_free(to_free);
1219         }
1220 }
1221
1222 /**
1223  *      radix_tree_delete    -    delete an item from a radix tree
1224  *      @root:          radix tree root
1225  *      @index:         index key
1226  *
1227  *      Remove the item at @index from the radix tree rooted at @root.
1228  *
1229  *      Returns the address of the deleted item, or NULL if it was not present.
1230  */
1231 void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1232 {
1233         /*
1234          * The radix tree path needs to be one longer than the maximum path
1235          * since the "list" is null terminated.
1236          */
1237         struct radix_tree_path path[RADIX_TREE_MAX_PATH + 1], *pathp = path;
1238         struct radix_tree_node *slot = NULL;
1239         struct radix_tree_node *to_free;
1240         unsigned int height, shift;
1241         int tag;
1242         int offset;
1243
1244         height = root->height;
1245         if (index > radix_tree_maxindex(height))
1246                 goto out;
1247
1248         slot = root->rnode;
1249         if (height == 0) {
1250                 root_tag_clear_all(root);
1251                 root->rnode = NULL;
1252                 goto out;
1253         }
1254         slot = radix_tree_indirect_to_ptr(slot);
1255
1256         shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
1257         pathp->node = NULL;
1258
1259         do {
1260                 if (slot == NULL)
1261                         goto out;
1262
1263                 pathp++;
1264                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1265                 pathp->offset = offset;
1266                 pathp->node = slot;
1267                 slot = slot->slots[offset];
1268                 shift -= RADIX_TREE_MAP_SHIFT;
1269                 height--;
1270         } while (height > 0);
1271
1272         if (slot == NULL)
1273                 goto out;
1274
1275         /*
1276          * Clear all tags associated with the just-deleted item
1277          */
1278         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
1279                 if (tag_get(pathp->node, tag, pathp->offset))
1280                         radix_tree_tag_clear(root, index, tag);
1281         }
1282
1283         to_free = NULL;
1284         /* Now free the nodes we do not need anymore */
1285         while (pathp->node) {
1286                 pathp->node->slots[pathp->offset] = NULL;
1287                 pathp->node->count--;
1288                 /*
1289                  * Queue the node for deferred freeing after the
1290                  * last reference to it disappears (set NULL, above).
1291                  */
1292                 if (to_free)
1293                         radix_tree_node_free(to_free);
1294
1295                 if (pathp->node->count) {
1296                         if (pathp->node ==
1297                                         radix_tree_indirect_to_ptr(root->rnode))
1298                                 radix_tree_shrink(root);
1299                         goto out;
1300                 }
1301
1302                 /* Node with zero slots in use so free it */
1303                 to_free = pathp->node;
1304                 pathp--;
1305
1306         }
1307         root_tag_clear_all(root);
1308         root->height = 0;
1309         root->rnode = NULL;
1310         if (to_free)
1311                 radix_tree_node_free(to_free);
1312
1313 out:
1314         return slot;
1315 }
1316 EXPORT_SYMBOL(radix_tree_delete);
1317
1318 /**
1319  *      radix_tree_tagged - test whether any items in the tree are tagged
1320  *      @root:          radix tree root
1321  *      @tag:           tag to test
1322  */
1323 int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
1324 {
1325         return root_tag_get(root, tag);
1326 }
1327 EXPORT_SYMBOL(radix_tree_tagged);
1328
1329 static void
1330 radix_tree_node_ctor(void *node)
1331 {
1332         memset(node, 0, sizeof(struct radix_tree_node));
1333 }
1334
1335 static __init unsigned long __maxindex(unsigned int height)
1336 {
1337         unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1338         int shift = RADIX_TREE_INDEX_BITS - width;
1339
1340         if (shift < 0)
1341                 return ~0UL;
1342         if (shift >= BITS_PER_LONG)
1343                 return 0UL;
1344         return ~0UL >> shift;
1345 }
1346
1347 static __init void radix_tree_init_maxindex(void)
1348 {
1349         unsigned int i;
1350
1351         for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1352                 height_to_maxindex[i] = __maxindex(i);
1353 }
1354
1355 static int radix_tree_callback(struct notifier_block *nfb,
1356                             unsigned long action,
1357                             void *hcpu)
1358 {
1359        int cpu = (long)hcpu;
1360        struct radix_tree_preload *rtp;
1361
1362        /* Free per-cpu pool of perloaded nodes */
1363        if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
1364                rtp = &per_cpu(radix_tree_preloads, cpu);
1365                while (rtp->nr) {
1366                        kmem_cache_free(radix_tree_node_cachep,
1367                                        rtp->nodes[rtp->nr-1]);
1368                        rtp->nodes[rtp->nr-1] = NULL;
1369                        rtp->nr--;
1370                }
1371        }
1372        return NOTIFY_OK;
1373 }
1374
1375 void __init radix_tree_init(void)
1376 {
1377         radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1378                         sizeof(struct radix_tree_node), 0,
1379                         SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1380                         radix_tree_node_ctor);
1381         radix_tree_init_maxindex();
1382         hotcpu_notifier(radix_tree_callback, 0);
1383 }