radix-tree: improve dump output
[muen/linux.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  * Copyright (C) 2012 Konstantin Khlebnikov
7  * Copyright (C) 2016 Intel, Matthew Wilcox
8  * Copyright (C) 2016 Intel, Ross Zwisler
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2, or (at
13  * your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 #include <linux/errno.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/export.h>
29 #include <linux/radix-tree.h>
30 #include <linux/percpu.h>
31 #include <linux/slab.h>
32 #include <linux/kmemleak.h>
33 #include <linux/notifier.h>
34 #include <linux/cpu.h>
35 #include <linux/string.h>
36 #include <linux/bitops.h>
37 #include <linux/rcupdate.h>
38 #include <linux/preempt.h>              /* in_interrupt() */
39
40
41 /* Number of nodes in fully populated tree of given height */
42 static unsigned long height_to_maxnodes[RADIX_TREE_MAX_PATH + 1] __read_mostly;
43
44 /*
45  * Radix tree node cache.
46  */
47 static struct kmem_cache *radix_tree_node_cachep;
48
49 /*
50  * The radix tree is variable-height, so an insert operation not only has
51  * to build the branch to its corresponding item, it also has to build the
52  * branch to existing items if the size has to be increased (by
53  * radix_tree_extend).
54  *
55  * The worst case is a zero height tree with just a single item at index 0,
56  * and then inserting an item at index ULONG_MAX. This requires 2 new branches
57  * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
58  * Hence:
59  */
60 #define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
61
62 /*
63  * Per-cpu pool of preloaded nodes
64  */
65 struct radix_tree_preload {
66         unsigned nr;
67         /* nodes->private_data points to next preallocated node */
68         struct radix_tree_node *nodes;
69 };
70 static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
71
72 static inline void *node_to_entry(void *ptr)
73 {
74         return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
75 }
76
77 #define RADIX_TREE_RETRY        node_to_entry(NULL)
78
79 #ifdef CONFIG_RADIX_TREE_MULTIORDER
80 /* Sibling slots point directly to another slot in the same node */
81 static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
82 {
83         void **ptr = node;
84         return (parent->slots <= ptr) &&
85                         (ptr < parent->slots + RADIX_TREE_MAP_SIZE);
86 }
87 #else
88 static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
89 {
90         return false;
91 }
92 #endif
93
94 static inline unsigned long get_slot_offset(struct radix_tree_node *parent,
95                                                  void **slot)
96 {
97         return slot - parent->slots;
98 }
99
100 static unsigned int radix_tree_descend(struct radix_tree_node *parent,
101                         struct radix_tree_node **nodep, unsigned long index)
102 {
103         unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
104         void **entry = rcu_dereference_raw(parent->slots[offset]);
105
106 #ifdef CONFIG_RADIX_TREE_MULTIORDER
107         if (radix_tree_is_internal_node(entry)) {
108                 if (is_sibling_entry(parent, entry)) {
109                         void **sibentry = (void **) entry_to_node(entry);
110                         offset = get_slot_offset(parent, sibentry);
111                         entry = rcu_dereference_raw(*sibentry);
112                 }
113         }
114 #endif
115
116         *nodep = (void *)entry;
117         return offset;
118 }
119
120 static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
121 {
122         return root->gfp_mask & __GFP_BITS_MASK;
123 }
124
125 static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
126                 int offset)
127 {
128         __set_bit(offset, node->tags[tag]);
129 }
130
131 static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
132                 int offset)
133 {
134         __clear_bit(offset, node->tags[tag]);
135 }
136
137 static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
138                 int offset)
139 {
140         return test_bit(offset, node->tags[tag]);
141 }
142
143 static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
144 {
145         root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
146 }
147
148 static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
149 {
150         root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
151 }
152
153 static inline void root_tag_clear_all(struct radix_tree_root *root)
154 {
155         root->gfp_mask &= __GFP_BITS_MASK;
156 }
157
158 static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
159 {
160         return (__force int)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
161 }
162
163 static inline unsigned root_tags_get(struct radix_tree_root *root)
164 {
165         return (__force unsigned)root->gfp_mask >> __GFP_BITS_SHIFT;
166 }
167
168 /*
169  * Returns 1 if any slot in the node has this tag set.
170  * Otherwise returns 0.
171  */
172 static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
173 {
174         unsigned idx;
175         for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
176                 if (node->tags[tag][idx])
177                         return 1;
178         }
179         return 0;
180 }
181
182 /**
183  * radix_tree_find_next_bit - find the next set bit in a memory region
184  *
185  * @addr: The address to base the search on
186  * @size: The bitmap size in bits
187  * @offset: The bitnumber to start searching at
188  *
189  * Unrollable variant of find_next_bit() for constant size arrays.
190  * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
191  * Returns next bit offset, or size if nothing found.
192  */
193 static __always_inline unsigned long
194 radix_tree_find_next_bit(struct radix_tree_node *node, unsigned int tag,
195                          unsigned long offset)
196 {
197         const unsigned long *addr = node->tags[tag];
198
199         if (offset < RADIX_TREE_MAP_SIZE) {
200                 unsigned long tmp;
201
202                 addr += offset / BITS_PER_LONG;
203                 tmp = *addr >> (offset % BITS_PER_LONG);
204                 if (tmp)
205                         return __ffs(tmp) + offset;
206                 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
207                 while (offset < RADIX_TREE_MAP_SIZE) {
208                         tmp = *++addr;
209                         if (tmp)
210                                 return __ffs(tmp) + offset;
211                         offset += BITS_PER_LONG;
212                 }
213         }
214         return RADIX_TREE_MAP_SIZE;
215 }
216
217 /*
218  * The maximum index which can be stored in a radix tree
219  */
220 static inline unsigned long shift_maxindex(unsigned int shift)
221 {
222         return (RADIX_TREE_MAP_SIZE << shift) - 1;
223 }
224
225 static inline unsigned long node_maxindex(struct radix_tree_node *node)
226 {
227         return shift_maxindex(node->shift);
228 }
229
230 #ifndef __KERNEL__
231 static void dump_node(struct radix_tree_node *node, unsigned long index)
232 {
233         unsigned long i;
234
235         pr_debug("radix node: %p offset %d indices %lu-%lu parent %p tags %lx %lx %lx shift %d count %d exceptional %d\n",
236                 node, node->offset, index, index | node_maxindex(node),
237                 node->parent,
238                 node->tags[0][0], node->tags[1][0], node->tags[2][0],
239                 node->shift, node->count, node->exceptional);
240
241         for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
242                 unsigned long first = index | (i << node->shift);
243                 unsigned long last = first | ((1UL << node->shift) - 1);
244                 void *entry = node->slots[i];
245                 if (!entry)
246                         continue;
247                 if (entry == RADIX_TREE_RETRY) {
248                         pr_debug("radix retry offset %ld indices %lu-%lu parent %p\n",
249                                         i, first, last, node);
250                 } else if (!radix_tree_is_internal_node(entry)) {
251                         pr_debug("radix entry %p offset %ld indices %lu-%lu parent %p\n",
252                                         entry, i, first, last, node);
253                 } else if (is_sibling_entry(node, entry)) {
254                         pr_debug("radix sblng %p offset %ld indices %lu-%lu parent %p val %p\n",
255                                         entry, i, first, last, node,
256                                         *(void **)entry_to_node(entry));
257                 } else {
258                         dump_node(entry_to_node(entry), first);
259                 }
260         }
261 }
262
263 /* For debug */
264 static void radix_tree_dump(struct radix_tree_root *root)
265 {
266         pr_debug("radix root: %p rnode %p tags %x\n",
267                         root, root->rnode,
268                         root->gfp_mask >> __GFP_BITS_SHIFT);
269         if (!radix_tree_is_internal_node(root->rnode))
270                 return;
271         dump_node(entry_to_node(root->rnode), 0);
272 }
273 #endif
274
275 /*
276  * This assumes that the caller has performed appropriate preallocation, and
277  * that the caller has pinned this thread of control to the current CPU.
278  */
279 static struct radix_tree_node *
280 radix_tree_node_alloc(struct radix_tree_root *root)
281 {
282         struct radix_tree_node *ret = NULL;
283         gfp_t gfp_mask = root_gfp_mask(root);
284
285         /*
286          * Preload code isn't irq safe and it doesn't make sense to use
287          * preloading during an interrupt anyway as all the allocations have
288          * to be atomic. So just do normal allocation when in interrupt.
289          */
290         if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
291                 struct radix_tree_preload *rtp;
292
293                 /*
294                  * Even if the caller has preloaded, try to allocate from the
295                  * cache first for the new node to get accounted to the memory
296                  * cgroup.
297                  */
298                 ret = kmem_cache_alloc(radix_tree_node_cachep,
299                                        gfp_mask | __GFP_NOWARN);
300                 if (ret)
301                         goto out;
302
303                 /*
304                  * Provided the caller has preloaded here, we will always
305                  * succeed in getting a node here (and never reach
306                  * kmem_cache_alloc)
307                  */
308                 rtp = this_cpu_ptr(&radix_tree_preloads);
309                 if (rtp->nr) {
310                         ret = rtp->nodes;
311                         rtp->nodes = ret->private_data;
312                         ret->private_data = NULL;
313                         rtp->nr--;
314                 }
315                 /*
316                  * Update the allocation stack trace as this is more useful
317                  * for debugging.
318                  */
319                 kmemleak_update_trace(ret);
320                 goto out;
321         }
322         ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
323 out:
324         BUG_ON(radix_tree_is_internal_node(ret));
325         return ret;
326 }
327
328 static void radix_tree_node_rcu_free(struct rcu_head *head)
329 {
330         struct radix_tree_node *node =
331                         container_of(head, struct radix_tree_node, rcu_head);
332         int i;
333
334         /*
335          * must only free zeroed nodes into the slab. radix_tree_shrink
336          * can leave us with a non-NULL entry in the first slot, so clear
337          * that here to make sure.
338          */
339         for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
340                 tag_clear(node, i, 0);
341
342         node->slots[0] = NULL;
343         INIT_LIST_HEAD(&node->private_list);
344
345         kmem_cache_free(radix_tree_node_cachep, node);
346 }
347
348 static inline void
349 radix_tree_node_free(struct radix_tree_node *node)
350 {
351         call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
352 }
353
354 /*
355  * Load up this CPU's radix_tree_node buffer with sufficient objects to
356  * ensure that the addition of a single element in the tree cannot fail.  On
357  * success, return zero, with preemption disabled.  On error, return -ENOMEM
358  * with preemption not disabled.
359  *
360  * To make use of this facility, the radix tree must be initialised without
361  * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
362  */
363 static int __radix_tree_preload(gfp_t gfp_mask, int nr)
364 {
365         struct radix_tree_preload *rtp;
366         struct radix_tree_node *node;
367         int ret = -ENOMEM;
368
369         /*
370          * Nodes preloaded by one cgroup can be be used by another cgroup, so
371          * they should never be accounted to any particular memory cgroup.
372          */
373         gfp_mask &= ~__GFP_ACCOUNT;
374
375         preempt_disable();
376         rtp = this_cpu_ptr(&radix_tree_preloads);
377         while (rtp->nr < nr) {
378                 preempt_enable();
379                 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
380                 if (node == NULL)
381                         goto out;
382                 preempt_disable();
383                 rtp = this_cpu_ptr(&radix_tree_preloads);
384                 if (rtp->nr < nr) {
385                         node->private_data = rtp->nodes;
386                         rtp->nodes = node;
387                         rtp->nr++;
388                 } else {
389                         kmem_cache_free(radix_tree_node_cachep, node);
390                 }
391         }
392         ret = 0;
393 out:
394         return ret;
395 }
396
397 /*
398  * Load up this CPU's radix_tree_node buffer with sufficient objects to
399  * ensure that the addition of a single element in the tree cannot fail.  On
400  * success, return zero, with preemption disabled.  On error, return -ENOMEM
401  * with preemption not disabled.
402  *
403  * To make use of this facility, the radix tree must be initialised without
404  * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
405  */
406 int radix_tree_preload(gfp_t gfp_mask)
407 {
408         /* Warn on non-sensical use... */
409         WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
410         return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
411 }
412 EXPORT_SYMBOL(radix_tree_preload);
413
414 /*
415  * The same as above function, except we don't guarantee preloading happens.
416  * We do it, if we decide it helps. On success, return zero with preemption
417  * disabled. On error, return -ENOMEM with preemption not disabled.
418  */
419 int radix_tree_maybe_preload(gfp_t gfp_mask)
420 {
421         if (gfpflags_allow_blocking(gfp_mask))
422                 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
423         /* Preloading doesn't help anything with this gfp mask, skip it */
424         preempt_disable();
425         return 0;
426 }
427 EXPORT_SYMBOL(radix_tree_maybe_preload);
428
429 /*
430  * The same as function above, but preload number of nodes required to insert
431  * (1 << order) continuous naturally-aligned elements.
432  */
433 int radix_tree_maybe_preload_order(gfp_t gfp_mask, int order)
434 {
435         unsigned long nr_subtrees;
436         int nr_nodes, subtree_height;
437
438         /* Preloading doesn't help anything with this gfp mask, skip it */
439         if (!gfpflags_allow_blocking(gfp_mask)) {
440                 preempt_disable();
441                 return 0;
442         }
443
444         /*
445          * Calculate number and height of fully populated subtrees it takes to
446          * store (1 << order) elements.
447          */
448         nr_subtrees = 1 << order;
449         for (subtree_height = 0; nr_subtrees > RADIX_TREE_MAP_SIZE;
450                         subtree_height++)
451                 nr_subtrees >>= RADIX_TREE_MAP_SHIFT;
452
453         /*
454          * The worst case is zero height tree with a single item at index 0 and
455          * then inserting items starting at ULONG_MAX - (1 << order).
456          *
457          * This requires RADIX_TREE_MAX_PATH nodes to build branch from root to
458          * 0-index item.
459          */
460         nr_nodes = RADIX_TREE_MAX_PATH;
461
462         /* Plus branch to fully populated subtrees. */
463         nr_nodes += RADIX_TREE_MAX_PATH - subtree_height;
464
465         /* Root node is shared. */
466         nr_nodes--;
467
468         /* Plus nodes required to build subtrees. */
469         nr_nodes += nr_subtrees * height_to_maxnodes[subtree_height];
470
471         return __radix_tree_preload(gfp_mask, nr_nodes);
472 }
473
474 static unsigned radix_tree_load_root(struct radix_tree_root *root,
475                 struct radix_tree_node **nodep, unsigned long *maxindex)
476 {
477         struct radix_tree_node *node = rcu_dereference_raw(root->rnode);
478
479         *nodep = node;
480
481         if (likely(radix_tree_is_internal_node(node))) {
482                 node = entry_to_node(node);
483                 *maxindex = node_maxindex(node);
484                 return node->shift + RADIX_TREE_MAP_SHIFT;
485         }
486
487         *maxindex = 0;
488         return 0;
489 }
490
491 /*
492  *      Extend a radix tree so it can store key @index.
493  */
494 static int radix_tree_extend(struct radix_tree_root *root,
495                                 unsigned long index, unsigned int shift)
496 {
497         struct radix_tree_node *slot;
498         unsigned int maxshift;
499         int tag;
500
501         /* Figure out what the shift should be.  */
502         maxshift = shift;
503         while (index > shift_maxindex(maxshift))
504                 maxshift += RADIX_TREE_MAP_SHIFT;
505
506         slot = root->rnode;
507         if (!slot)
508                 goto out;
509
510         do {
511                 struct radix_tree_node *node = radix_tree_node_alloc(root);
512
513                 if (!node)
514                         return -ENOMEM;
515
516                 /* Propagate the aggregated tag info into the new root */
517                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
518                         if (root_tag_get(root, tag))
519                                 tag_set(node, tag, 0);
520                 }
521
522                 BUG_ON(shift > BITS_PER_LONG);
523                 node->shift = shift;
524                 node->offset = 0;
525                 node->count = 1;
526                 node->parent = NULL;
527                 if (radix_tree_is_internal_node(slot)) {
528                         entry_to_node(slot)->parent = node;
529                 } else {
530                         /* Moving an exceptional root->rnode to a node */
531                         if (radix_tree_exceptional_entry(slot))
532                                 node->exceptional = 1;
533                 }
534                 node->slots[0] = slot;
535                 slot = node_to_entry(node);
536                 rcu_assign_pointer(root->rnode, slot);
537                 shift += RADIX_TREE_MAP_SHIFT;
538         } while (shift <= maxshift);
539 out:
540         return maxshift + RADIX_TREE_MAP_SHIFT;
541 }
542
543 /**
544  *      radix_tree_shrink    -    shrink radix tree to minimum height
545  *      @root           radix tree root
546  */
547 static inline void radix_tree_shrink(struct radix_tree_root *root,
548                                      radix_tree_update_node_t update_node,
549                                      void *private)
550 {
551         for (;;) {
552                 struct radix_tree_node *node = root->rnode;
553                 struct radix_tree_node *child;
554
555                 if (!radix_tree_is_internal_node(node))
556                         break;
557                 node = entry_to_node(node);
558
559                 /*
560                  * The candidate node has more than one child, or its child
561                  * is not at the leftmost slot, or the child is a multiorder
562                  * entry, we cannot shrink.
563                  */
564                 if (node->count != 1)
565                         break;
566                 child = node->slots[0];
567                 if (!child)
568                         break;
569                 if (!radix_tree_is_internal_node(child) && node->shift)
570                         break;
571
572                 if (radix_tree_is_internal_node(child))
573                         entry_to_node(child)->parent = NULL;
574
575                 /*
576                  * We don't need rcu_assign_pointer(), since we are simply
577                  * moving the node from one part of the tree to another: if it
578                  * was safe to dereference the old pointer to it
579                  * (node->slots[0]), it will be safe to dereference the new
580                  * one (root->rnode) as far as dependent read barriers go.
581                  */
582                 root->rnode = child;
583
584                 /*
585                  * We have a dilemma here. The node's slot[0] must not be
586                  * NULLed in case there are concurrent lookups expecting to
587                  * find the item. However if this was a bottom-level node,
588                  * then it may be subject to the slot pointer being visible
589                  * to callers dereferencing it. If item corresponding to
590                  * slot[0] is subsequently deleted, these callers would expect
591                  * their slot to become empty sooner or later.
592                  *
593                  * For example, lockless pagecache will look up a slot, deref
594                  * the page pointer, and if the page has 0 refcount it means it
595                  * was concurrently deleted from pagecache so try the deref
596                  * again. Fortunately there is already a requirement for logic
597                  * to retry the entire slot lookup -- the indirect pointer
598                  * problem (replacing direct root node with an indirect pointer
599                  * also results in a stale slot). So tag the slot as indirect
600                  * to force callers to retry.
601                  */
602                 node->count = 0;
603                 if (!radix_tree_is_internal_node(child)) {
604                         node->slots[0] = RADIX_TREE_RETRY;
605                         if (update_node)
606                                 update_node(node, private);
607                 }
608
609                 radix_tree_node_free(node);
610         }
611 }
612
613 static void delete_node(struct radix_tree_root *root,
614                         struct radix_tree_node *node,
615                         radix_tree_update_node_t update_node, void *private)
616 {
617         do {
618                 struct radix_tree_node *parent;
619
620                 if (node->count) {
621                         if (node == entry_to_node(root->rnode))
622                                 radix_tree_shrink(root, update_node, private);
623                         return;
624                 }
625
626                 parent = node->parent;
627                 if (parent) {
628                         parent->slots[node->offset] = NULL;
629                         parent->count--;
630                 } else {
631                         root_tag_clear_all(root);
632                         root->rnode = NULL;
633                 }
634
635                 radix_tree_node_free(node);
636
637                 node = parent;
638         } while (node);
639 }
640
641 /**
642  *      __radix_tree_create     -       create a slot in a radix tree
643  *      @root:          radix tree root
644  *      @index:         index key
645  *      @order:         index occupies 2^order aligned slots
646  *      @nodep:         returns node
647  *      @slotp:         returns slot
648  *
649  *      Create, if necessary, and return the node and slot for an item
650  *      at position @index in the radix tree @root.
651  *
652  *      Until there is more than one item in the tree, no nodes are
653  *      allocated and @root->rnode is used as a direct slot instead of
654  *      pointing to a node, in which case *@nodep will be NULL.
655  *
656  *      Returns -ENOMEM, or 0 for success.
657  */
658 int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
659                         unsigned order, struct radix_tree_node **nodep,
660                         void ***slotp)
661 {
662         struct radix_tree_node *node = NULL, *child;
663         void **slot = (void **)&root->rnode;
664         unsigned long maxindex;
665         unsigned int shift, offset = 0;
666         unsigned long max = index | ((1UL << order) - 1);
667
668         shift = radix_tree_load_root(root, &child, &maxindex);
669
670         /* Make sure the tree is high enough.  */
671         if (max > maxindex) {
672                 int error = radix_tree_extend(root, max, shift);
673                 if (error < 0)
674                         return error;
675                 shift = error;
676                 child = root->rnode;
677                 if (order == shift)
678                         shift += RADIX_TREE_MAP_SHIFT;
679         }
680
681         while (shift > order) {
682                 shift -= RADIX_TREE_MAP_SHIFT;
683                 if (child == NULL) {
684                         /* Have to add a child node.  */
685                         child = radix_tree_node_alloc(root);
686                         if (!child)
687                                 return -ENOMEM;
688                         child->shift = shift;
689                         child->offset = offset;
690                         child->parent = node;
691                         rcu_assign_pointer(*slot, node_to_entry(child));
692                         if (node)
693                                 node->count++;
694                 } else if (!radix_tree_is_internal_node(child))
695                         break;
696
697                 /* Go a level down */
698                 node = entry_to_node(child);
699                 offset = radix_tree_descend(node, &child, index);
700                 slot = &node->slots[offset];
701         }
702
703 #ifdef CONFIG_RADIX_TREE_MULTIORDER
704         /* Insert pointers to the canonical entry */
705         if (order > shift) {
706                 unsigned i, n = 1 << (order - shift);
707                 offset = offset & ~(n - 1);
708                 slot = &node->slots[offset];
709                 child = node_to_entry(slot);
710                 for (i = 0; i < n; i++) {
711                         if (slot[i])
712                                 return -EEXIST;
713                 }
714
715                 for (i = 1; i < n; i++) {
716                         rcu_assign_pointer(slot[i], child);
717                         node->count++;
718                 }
719         }
720 #endif
721
722         if (nodep)
723                 *nodep = node;
724         if (slotp)
725                 *slotp = slot;
726         return 0;
727 }
728
729 /**
730  *      __radix_tree_insert    -    insert into a radix tree
731  *      @root:          radix tree root
732  *      @index:         index key
733  *      @order:         key covers the 2^order indices around index
734  *      @item:          item to insert
735  *
736  *      Insert an item into the radix tree at position @index.
737  */
738 int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
739                         unsigned order, void *item)
740 {
741         struct radix_tree_node *node;
742         void **slot;
743         int error;
744
745         BUG_ON(radix_tree_is_internal_node(item));
746
747         error = __radix_tree_create(root, index, order, &node, &slot);
748         if (error)
749                 return error;
750         if (*slot != NULL)
751                 return -EEXIST;
752         rcu_assign_pointer(*slot, item);
753
754         if (node) {
755                 unsigned offset = get_slot_offset(node, slot);
756                 node->count++;
757                 if (radix_tree_exceptional_entry(item))
758                         node->exceptional++;
759                 BUG_ON(tag_get(node, 0, offset));
760                 BUG_ON(tag_get(node, 1, offset));
761                 BUG_ON(tag_get(node, 2, offset));
762         } else {
763                 BUG_ON(root_tags_get(root));
764         }
765
766         return 0;
767 }
768 EXPORT_SYMBOL(__radix_tree_insert);
769
770 /**
771  *      __radix_tree_lookup     -       lookup an item in a radix tree
772  *      @root:          radix tree root
773  *      @index:         index key
774  *      @nodep:         returns node
775  *      @slotp:         returns slot
776  *
777  *      Lookup and return the item at position @index in the radix
778  *      tree @root.
779  *
780  *      Until there is more than one item in the tree, no nodes are
781  *      allocated and @root->rnode is used as a direct slot instead of
782  *      pointing to a node, in which case *@nodep will be NULL.
783  */
784 void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
785                           struct radix_tree_node **nodep, void ***slotp)
786 {
787         struct radix_tree_node *node, *parent;
788         unsigned long maxindex;
789         void **slot;
790
791  restart:
792         parent = NULL;
793         slot = (void **)&root->rnode;
794         radix_tree_load_root(root, &node, &maxindex);
795         if (index > maxindex)
796                 return NULL;
797
798         while (radix_tree_is_internal_node(node)) {
799                 unsigned offset;
800
801                 if (node == RADIX_TREE_RETRY)
802                         goto restart;
803                 parent = entry_to_node(node);
804                 offset = radix_tree_descend(parent, &node, index);
805                 slot = parent->slots + offset;
806         }
807
808         if (nodep)
809                 *nodep = parent;
810         if (slotp)
811                 *slotp = slot;
812         return node;
813 }
814
815 /**
816  *      radix_tree_lookup_slot    -    lookup a slot in a radix tree
817  *      @root:          radix tree root
818  *      @index:         index key
819  *
820  *      Returns:  the slot corresponding to the position @index in the
821  *      radix tree @root. This is useful for update-if-exists operations.
822  *
823  *      This function can be called under rcu_read_lock iff the slot is not
824  *      modified by radix_tree_replace_slot, otherwise it must be called
825  *      exclusive from other writers. Any dereference of the slot must be done
826  *      using radix_tree_deref_slot.
827  */
828 void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
829 {
830         void **slot;
831
832         if (!__radix_tree_lookup(root, index, NULL, &slot))
833                 return NULL;
834         return slot;
835 }
836 EXPORT_SYMBOL(radix_tree_lookup_slot);
837
838 /**
839  *      radix_tree_lookup    -    perform lookup operation on a radix tree
840  *      @root:          radix tree root
841  *      @index:         index key
842  *
843  *      Lookup the item at the position @index in the radix tree @root.
844  *
845  *      This function can be called under rcu_read_lock, however the caller
846  *      must manage lifetimes of leaf nodes (eg. RCU may also be used to free
847  *      them safely). No RCU barriers are required to access or modify the
848  *      returned item, however.
849  */
850 void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
851 {
852         return __radix_tree_lookup(root, index, NULL, NULL);
853 }
854 EXPORT_SYMBOL(radix_tree_lookup);
855
856 static void replace_slot(struct radix_tree_root *root,
857                          struct radix_tree_node *node,
858                          void **slot, void *item,
859                          bool warn_typeswitch)
860 {
861         void *old = rcu_dereference_raw(*slot);
862         int count, exceptional;
863
864         WARN_ON_ONCE(radix_tree_is_internal_node(item));
865
866         count = !!item - !!old;
867         exceptional = !!radix_tree_exceptional_entry(item) -
868                       !!radix_tree_exceptional_entry(old);
869
870         WARN_ON_ONCE(warn_typeswitch && (count || exceptional));
871
872         if (node) {
873                 node->count += count;
874                 node->exceptional += exceptional;
875         }
876
877         rcu_assign_pointer(*slot, item);
878 }
879
880 /**
881  * __radix_tree_replace         - replace item in a slot
882  * @root:               radix tree root
883  * @node:               pointer to tree node
884  * @slot:               pointer to slot in @node
885  * @item:               new item to store in the slot.
886  * @update_node:        callback for changing leaf nodes
887  * @private:            private data to pass to @update_node
888  *
889  * For use with __radix_tree_lookup().  Caller must hold tree write locked
890  * across slot lookup and replacement.
891  */
892 void __radix_tree_replace(struct radix_tree_root *root,
893                           struct radix_tree_node *node,
894                           void **slot, void *item,
895                           radix_tree_update_node_t update_node, void *private)
896 {
897         /*
898          * This function supports replacing exceptional entries and
899          * deleting entries, but that needs accounting against the
900          * node unless the slot is root->rnode.
901          */
902         replace_slot(root, node, slot, item,
903                      !node && slot != (void **)&root->rnode);
904
905         if (!node)
906                 return;
907
908         if (update_node)
909                 update_node(node, private);
910
911         delete_node(root, node, update_node, private);
912 }
913
914 /**
915  * radix_tree_replace_slot      - replace item in a slot
916  * @root:       radix tree root
917  * @slot:       pointer to slot
918  * @item:       new item to store in the slot.
919  *
920  * For use with radix_tree_lookup_slot(), radix_tree_gang_lookup_slot(),
921  * radix_tree_gang_lookup_tag_slot().  Caller must hold tree write locked
922  * across slot lookup and replacement.
923  *
924  * NOTE: This cannot be used to switch between non-entries (empty slots),
925  * regular entries, and exceptional entries, as that requires accounting
926  * inside the radix tree node. When switching from one type of entry or
927  * deleting, use __radix_tree_lookup() and __radix_tree_replace().
928  */
929 void radix_tree_replace_slot(struct radix_tree_root *root,
930                              void **slot, void *item)
931 {
932         replace_slot(root, NULL, slot, item, true);
933 }
934
935 /**
936  *      radix_tree_tag_set - set a tag on a radix tree node
937  *      @root:          radix tree root
938  *      @index:         index key
939  *      @tag:           tag index
940  *
941  *      Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
942  *      corresponding to @index in the radix tree.  From
943  *      the root all the way down to the leaf node.
944  *
945  *      Returns the address of the tagged item.  Setting a tag on a not-present
946  *      item is a bug.
947  */
948 void *radix_tree_tag_set(struct radix_tree_root *root,
949                         unsigned long index, unsigned int tag)
950 {
951         struct radix_tree_node *node, *parent;
952         unsigned long maxindex;
953
954         radix_tree_load_root(root, &node, &maxindex);
955         BUG_ON(index > maxindex);
956
957         while (radix_tree_is_internal_node(node)) {
958                 unsigned offset;
959
960                 parent = entry_to_node(node);
961                 offset = radix_tree_descend(parent, &node, index);
962                 BUG_ON(!node);
963
964                 if (!tag_get(parent, tag, offset))
965                         tag_set(parent, tag, offset);
966         }
967
968         /* set the root's tag bit */
969         if (!root_tag_get(root, tag))
970                 root_tag_set(root, tag);
971
972         return node;
973 }
974 EXPORT_SYMBOL(radix_tree_tag_set);
975
976 static void node_tag_clear(struct radix_tree_root *root,
977                                 struct radix_tree_node *node,
978                                 unsigned int tag, unsigned int offset)
979 {
980         while (node) {
981                 if (!tag_get(node, tag, offset))
982                         return;
983                 tag_clear(node, tag, offset);
984                 if (any_tag_set(node, tag))
985                         return;
986
987                 offset = node->offset;
988                 node = node->parent;
989         }
990
991         /* clear the root's tag bit */
992         if (root_tag_get(root, tag))
993                 root_tag_clear(root, tag);
994 }
995
996 static void node_tag_set(struct radix_tree_root *root,
997                                 struct radix_tree_node *node,
998                                 unsigned int tag, unsigned int offset)
999 {
1000         while (node) {
1001                 if (tag_get(node, tag, offset))
1002                         return;
1003                 tag_set(node, tag, offset);
1004                 offset = node->offset;
1005                 node = node->parent;
1006         }
1007
1008         if (!root_tag_get(root, tag))
1009                 root_tag_set(root, tag);
1010 }
1011
1012 /**
1013  *      radix_tree_tag_clear - clear a tag on a radix tree node
1014  *      @root:          radix tree root
1015  *      @index:         index key
1016  *      @tag:           tag index
1017  *
1018  *      Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
1019  *      corresponding to @index in the radix tree.  If this causes
1020  *      the leaf node to have no tags set then clear the tag in the
1021  *      next-to-leaf node, etc.
1022  *
1023  *      Returns the address of the tagged item on success, else NULL.  ie:
1024  *      has the same return value and semantics as radix_tree_lookup().
1025  */
1026 void *radix_tree_tag_clear(struct radix_tree_root *root,
1027                         unsigned long index, unsigned int tag)
1028 {
1029         struct radix_tree_node *node, *parent;
1030         unsigned long maxindex;
1031         int uninitialized_var(offset);
1032
1033         radix_tree_load_root(root, &node, &maxindex);
1034         if (index > maxindex)
1035                 return NULL;
1036
1037         parent = NULL;
1038
1039         while (radix_tree_is_internal_node(node)) {
1040                 parent = entry_to_node(node);
1041                 offset = radix_tree_descend(parent, &node, index);
1042         }
1043
1044         if (node)
1045                 node_tag_clear(root, parent, tag, offset);
1046
1047         return node;
1048 }
1049 EXPORT_SYMBOL(radix_tree_tag_clear);
1050
1051 /**
1052  * radix_tree_tag_get - get a tag on a radix tree node
1053  * @root:               radix tree root
1054  * @index:              index key
1055  * @tag:                tag index (< RADIX_TREE_MAX_TAGS)
1056  *
1057  * Return values:
1058  *
1059  *  0: tag not present or not set
1060  *  1: tag set
1061  *
1062  * Note that the return value of this function may not be relied on, even if
1063  * the RCU lock is held, unless tag modification and node deletion are excluded
1064  * from concurrency.
1065  */
1066 int radix_tree_tag_get(struct radix_tree_root *root,
1067                         unsigned long index, unsigned int tag)
1068 {
1069         struct radix_tree_node *node, *parent;
1070         unsigned long maxindex;
1071
1072         if (!root_tag_get(root, tag))
1073                 return 0;
1074
1075         radix_tree_load_root(root, &node, &maxindex);
1076         if (index > maxindex)
1077                 return 0;
1078         if (node == NULL)
1079                 return 0;
1080
1081         while (radix_tree_is_internal_node(node)) {
1082                 unsigned offset;
1083
1084                 parent = entry_to_node(node);
1085                 offset = radix_tree_descend(parent, &node, index);
1086
1087                 if (!node)
1088                         return 0;
1089                 if (!tag_get(parent, tag, offset))
1090                         return 0;
1091                 if (node == RADIX_TREE_RETRY)
1092                         break;
1093         }
1094
1095         return 1;
1096 }
1097 EXPORT_SYMBOL(radix_tree_tag_get);
1098
1099 static inline void __set_iter_shift(struct radix_tree_iter *iter,
1100                                         unsigned int shift)
1101 {
1102 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1103         iter->shift = shift;
1104 #endif
1105 }
1106
1107 /**
1108  * radix_tree_next_chunk - find next chunk of slots for iteration
1109  *
1110  * @root:       radix tree root
1111  * @iter:       iterator state
1112  * @flags:      RADIX_TREE_ITER_* flags and tag index
1113  * Returns:     pointer to chunk first slot, or NULL if iteration is over
1114  */
1115 void **radix_tree_next_chunk(struct radix_tree_root *root,
1116                              struct radix_tree_iter *iter, unsigned flags)
1117 {
1118         unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
1119         struct radix_tree_node *node, *child;
1120         unsigned long index, offset, maxindex;
1121
1122         if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
1123                 return NULL;
1124
1125         /*
1126          * Catch next_index overflow after ~0UL. iter->index never overflows
1127          * during iterating; it can be zero only at the beginning.
1128          * And we cannot overflow iter->next_index in a single step,
1129          * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
1130          *
1131          * This condition also used by radix_tree_next_slot() to stop
1132          * contiguous iterating, and forbid switching to the next chunk.
1133          */
1134         index = iter->next_index;
1135         if (!index && iter->index)
1136                 return NULL;
1137
1138  restart:
1139         radix_tree_load_root(root, &child, &maxindex);
1140         if (index > maxindex)
1141                 return NULL;
1142         if (!child)
1143                 return NULL;
1144
1145         if (!radix_tree_is_internal_node(child)) {
1146                 /* Single-slot tree */
1147                 iter->index = index;
1148                 iter->next_index = maxindex + 1;
1149                 iter->tags = 1;
1150                 __set_iter_shift(iter, 0);
1151                 return (void **)&root->rnode;
1152         }
1153
1154         do {
1155                 node = entry_to_node(child);
1156                 offset = radix_tree_descend(node, &child, index);
1157
1158                 if ((flags & RADIX_TREE_ITER_TAGGED) ?
1159                                 !tag_get(node, tag, offset) : !child) {
1160                         /* Hole detected */
1161                         if (flags & RADIX_TREE_ITER_CONTIG)
1162                                 return NULL;
1163
1164                         if (flags & RADIX_TREE_ITER_TAGGED)
1165                                 offset = radix_tree_find_next_bit(node, tag,
1166                                                 offset + 1);
1167                         else
1168                                 while (++offset < RADIX_TREE_MAP_SIZE) {
1169                                         void *slot = node->slots[offset];
1170                                         if (is_sibling_entry(node, slot))
1171                                                 continue;
1172                                         if (slot)
1173                                                 break;
1174                                 }
1175                         index &= ~node_maxindex(node);
1176                         index += offset << node->shift;
1177                         /* Overflow after ~0UL */
1178                         if (!index)
1179                                 return NULL;
1180                         if (offset == RADIX_TREE_MAP_SIZE)
1181                                 goto restart;
1182                         child = rcu_dereference_raw(node->slots[offset]);
1183                 }
1184
1185                 if ((child == NULL) || (child == RADIX_TREE_RETRY))
1186                         goto restart;
1187         } while (radix_tree_is_internal_node(child));
1188
1189         /* Update the iterator state */
1190         iter->index = (index &~ node_maxindex(node)) | (offset << node->shift);
1191         iter->next_index = (index | node_maxindex(node)) + 1;
1192         __set_iter_shift(iter, node->shift);
1193
1194         /* Construct iter->tags bit-mask from node->tags[tag] array */
1195         if (flags & RADIX_TREE_ITER_TAGGED) {
1196                 unsigned tag_long, tag_bit;
1197
1198                 tag_long = offset / BITS_PER_LONG;
1199                 tag_bit  = offset % BITS_PER_LONG;
1200                 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1201                 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1202                 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1203                         /* Pick tags from next element */
1204                         if (tag_bit)
1205                                 iter->tags |= node->tags[tag][tag_long + 1] <<
1206                                                 (BITS_PER_LONG - tag_bit);
1207                         /* Clip chunk size, here only BITS_PER_LONG tags */
1208                         iter->next_index = index + BITS_PER_LONG;
1209                 }
1210         }
1211
1212         return node->slots + offset;
1213 }
1214 EXPORT_SYMBOL(radix_tree_next_chunk);
1215
1216 /**
1217  * radix_tree_range_tag_if_tagged - for each item in given range set given
1218  *                                 tag if item has another tag set
1219  * @root:               radix tree root
1220  * @first_indexp:       pointer to a starting index of a range to scan
1221  * @last_index:         last index of a range to scan
1222  * @nr_to_tag:          maximum number items to tag
1223  * @iftag:              tag index to test
1224  * @settag:             tag index to set if tested tag is set
1225  *
1226  * This function scans range of radix tree from first_index to last_index
1227  * (inclusive).  For each item in the range if iftag is set, the function sets
1228  * also settag. The function stops either after tagging nr_to_tag items or
1229  * after reaching last_index.
1230  *
1231  * The tags must be set from the leaf level only and propagated back up the
1232  * path to the root. We must do this so that we resolve the full path before
1233  * setting any tags on intermediate nodes. If we set tags as we descend, then
1234  * we can get to the leaf node and find that the index that has the iftag
1235  * set is outside the range we are scanning. This reults in dangling tags and
1236  * can lead to problems with later tag operations (e.g. livelocks on lookups).
1237  *
1238  * The function returns the number of leaves where the tag was set and sets
1239  * *first_indexp to the first unscanned index.
1240  * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
1241  * be prepared to handle that.
1242  */
1243 unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
1244                 unsigned long *first_indexp, unsigned long last_index,
1245                 unsigned long nr_to_tag,
1246                 unsigned int iftag, unsigned int settag)
1247 {
1248         struct radix_tree_node *node, *child;
1249         unsigned long maxindex;
1250         unsigned long tagged = 0;
1251         unsigned long index = *first_indexp;
1252
1253         radix_tree_load_root(root, &child, &maxindex);
1254         last_index = min(last_index, maxindex);
1255         if (index > last_index)
1256                 return 0;
1257         if (!nr_to_tag)
1258                 return 0;
1259         if (!root_tag_get(root, iftag)) {
1260                 *first_indexp = last_index + 1;
1261                 return 0;
1262         }
1263         if (!radix_tree_is_internal_node(child)) {
1264                 *first_indexp = last_index + 1;
1265                 root_tag_set(root, settag);
1266                 return 1;
1267         }
1268
1269         node = entry_to_node(child);
1270
1271         for (;;) {
1272                 unsigned offset = radix_tree_descend(node, &child, index);
1273                 if (!child)
1274                         goto next;
1275                 if (!tag_get(node, iftag, offset))
1276                         goto next;
1277                 /* Sibling slots never have tags set on them */
1278                 if (radix_tree_is_internal_node(child)) {
1279                         node = entry_to_node(child);
1280                         continue;
1281                 }
1282
1283                 tagged++;
1284                 node_tag_set(root, node, settag, offset);
1285  next:
1286                 /* Go to next entry in node */
1287                 index = ((index >> node->shift) + 1) << node->shift;
1288                 /* Overflow can happen when last_index is ~0UL... */
1289                 if (index > last_index || !index)
1290                         break;
1291                 offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
1292                 while (offset == 0) {
1293                         /*
1294                          * We've fully scanned this node. Go up. Because
1295                          * last_index is guaranteed to be in the tree, what
1296                          * we do below cannot wander astray.
1297                          */
1298                         node = node->parent;
1299                         offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
1300                 }
1301                 if (is_sibling_entry(node, node->slots[offset]))
1302                         goto next;
1303                 if (tagged >= nr_to_tag)
1304                         break;
1305         }
1306
1307         *first_indexp = index;
1308
1309         return tagged;
1310 }
1311 EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1312
1313 /**
1314  *      radix_tree_gang_lookup - perform multiple lookup on a radix tree
1315  *      @root:          radix tree root
1316  *      @results:       where the results of the lookup are placed
1317  *      @first_index:   start the lookup from this key
1318  *      @max_items:     place up to this many items at *results
1319  *
1320  *      Performs an index-ascending scan of the tree for present items.  Places
1321  *      them at *@results and returns the number of items which were placed at
1322  *      *@results.
1323  *
1324  *      The implementation is naive.
1325  *
1326  *      Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1327  *      rcu_read_lock. In this case, rather than the returned results being
1328  *      an atomic snapshot of the tree at a single point in time, the
1329  *      semantics of an RCU protected gang lookup are as though multiple
1330  *      radix_tree_lookups have been issued in individual locks, and results
1331  *      stored in 'results'.
1332  */
1333 unsigned int
1334 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1335                         unsigned long first_index, unsigned int max_items)
1336 {
1337         struct radix_tree_iter iter;
1338         void **slot;
1339         unsigned int ret = 0;
1340
1341         if (unlikely(!max_items))
1342                 return 0;
1343
1344         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1345                 results[ret] = rcu_dereference_raw(*slot);
1346                 if (!results[ret])
1347                         continue;
1348                 if (radix_tree_is_internal_node(results[ret])) {
1349                         slot = radix_tree_iter_retry(&iter);
1350                         continue;
1351                 }
1352                 if (++ret == max_items)
1353                         break;
1354         }
1355
1356         return ret;
1357 }
1358 EXPORT_SYMBOL(radix_tree_gang_lookup);
1359
1360 /**
1361  *      radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1362  *      @root:          radix tree root
1363  *      @results:       where the results of the lookup are placed
1364  *      @indices:       where their indices should be placed (but usually NULL)
1365  *      @first_index:   start the lookup from this key
1366  *      @max_items:     place up to this many items at *results
1367  *
1368  *      Performs an index-ascending scan of the tree for present items.  Places
1369  *      their slots at *@results and returns the number of items which were
1370  *      placed at *@results.
1371  *
1372  *      The implementation is naive.
1373  *
1374  *      Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1375  *      be dereferenced with radix_tree_deref_slot, and if using only RCU
1376  *      protection, radix_tree_deref_slot may fail requiring a retry.
1377  */
1378 unsigned int
1379 radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1380                         void ***results, unsigned long *indices,
1381                         unsigned long first_index, unsigned int max_items)
1382 {
1383         struct radix_tree_iter iter;
1384         void **slot;
1385         unsigned int ret = 0;
1386
1387         if (unlikely(!max_items))
1388                 return 0;
1389
1390         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1391                 results[ret] = slot;
1392                 if (indices)
1393                         indices[ret] = iter.index;
1394                 if (++ret == max_items)
1395                         break;
1396         }
1397
1398         return ret;
1399 }
1400 EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1401
1402 /**
1403  *      radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1404  *                                   based on a tag
1405  *      @root:          radix tree root
1406  *      @results:       where the results of the lookup are placed
1407  *      @first_index:   start the lookup from this key
1408  *      @max_items:     place up to this many items at *results
1409  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1410  *
1411  *      Performs an index-ascending scan of the tree for present items which
1412  *      have the tag indexed by @tag set.  Places the items at *@results and
1413  *      returns the number of items which were placed at *@results.
1414  */
1415 unsigned int
1416 radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
1417                 unsigned long first_index, unsigned int max_items,
1418                 unsigned int tag)
1419 {
1420         struct radix_tree_iter iter;
1421         void **slot;
1422         unsigned int ret = 0;
1423
1424         if (unlikely(!max_items))
1425                 return 0;
1426
1427         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1428                 results[ret] = rcu_dereference_raw(*slot);
1429                 if (!results[ret])
1430                         continue;
1431                 if (radix_tree_is_internal_node(results[ret])) {
1432                         slot = radix_tree_iter_retry(&iter);
1433                         continue;
1434                 }
1435                 if (++ret == max_items)
1436                         break;
1437         }
1438
1439         return ret;
1440 }
1441 EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1442
1443 /**
1444  *      radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1445  *                                        radix tree based on a tag
1446  *      @root:          radix tree root
1447  *      @results:       where the results of the lookup are placed
1448  *      @first_index:   start the lookup from this key
1449  *      @max_items:     place up to this many items at *results
1450  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1451  *
1452  *      Performs an index-ascending scan of the tree for present items which
1453  *      have the tag indexed by @tag set.  Places the slots at *@results and
1454  *      returns the number of slots which were placed at *@results.
1455  */
1456 unsigned int
1457 radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1458                 unsigned long first_index, unsigned int max_items,
1459                 unsigned int tag)
1460 {
1461         struct radix_tree_iter iter;
1462         void **slot;
1463         unsigned int ret = 0;
1464
1465         if (unlikely(!max_items))
1466                 return 0;
1467
1468         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1469                 results[ret] = slot;
1470                 if (++ret == max_items)
1471                         break;
1472         }
1473
1474         return ret;
1475 }
1476 EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1477
1478 #if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1479 #include <linux/sched.h> /* for cond_resched() */
1480
1481 struct locate_info {
1482         unsigned long found_index;
1483         bool stop;
1484 };
1485
1486 /*
1487  * This linear search is at present only useful to shmem_unuse_inode().
1488  */
1489 static unsigned long __locate(struct radix_tree_node *slot, void *item,
1490                               unsigned long index, struct locate_info *info)
1491 {
1492         unsigned long i;
1493
1494         do {
1495                 unsigned int shift = slot->shift;
1496
1497                 for (i = (index >> shift) & RADIX_TREE_MAP_MASK;
1498                      i < RADIX_TREE_MAP_SIZE;
1499                      i++, index += (1UL << shift)) {
1500                         struct radix_tree_node *node =
1501                                         rcu_dereference_raw(slot->slots[i]);
1502                         if (node == RADIX_TREE_RETRY)
1503                                 goto out;
1504                         if (!radix_tree_is_internal_node(node)) {
1505                                 if (node == item) {
1506                                         info->found_index = index;
1507                                         info->stop = true;
1508                                         goto out;
1509                                 }
1510                                 continue;
1511                         }
1512                         node = entry_to_node(node);
1513                         if (is_sibling_entry(slot, node))
1514                                 continue;
1515                         slot = node;
1516                         break;
1517                 }
1518         } while (i < RADIX_TREE_MAP_SIZE);
1519
1520 out:
1521         if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
1522                 info->stop = true;
1523         return index;
1524 }
1525
1526 /**
1527  *      radix_tree_locate_item - search through radix tree for item
1528  *      @root:          radix tree root
1529  *      @item:          item to be found
1530  *
1531  *      Returns index where item was found, or -1 if not found.
1532  *      Caller must hold no lock (since this time-consuming function needs
1533  *      to be preemptible), and must check afterwards if item is still there.
1534  */
1535 unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1536 {
1537         struct radix_tree_node *node;
1538         unsigned long max_index;
1539         unsigned long cur_index = 0;
1540         struct locate_info info = {
1541                 .found_index = -1,
1542                 .stop = false,
1543         };
1544
1545         do {
1546                 rcu_read_lock();
1547                 node = rcu_dereference_raw(root->rnode);
1548                 if (!radix_tree_is_internal_node(node)) {
1549                         rcu_read_unlock();
1550                         if (node == item)
1551                                 info.found_index = 0;
1552                         break;
1553                 }
1554
1555                 node = entry_to_node(node);
1556
1557                 max_index = node_maxindex(node);
1558                 if (cur_index > max_index) {
1559                         rcu_read_unlock();
1560                         break;
1561                 }
1562
1563                 cur_index = __locate(node, item, cur_index, &info);
1564                 rcu_read_unlock();
1565                 cond_resched();
1566         } while (!info.stop && cur_index <= max_index);
1567
1568         return info.found_index;
1569 }
1570 #else
1571 unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1572 {
1573         return -1;
1574 }
1575 #endif /* CONFIG_SHMEM && CONFIG_SWAP */
1576
1577 /**
1578  *      __radix_tree_delete_node    -    try to free node after clearing a slot
1579  *      @root:          radix tree root
1580  *      @node:          node containing @index
1581  *
1582  *      After clearing the slot at @index in @node from radix tree
1583  *      rooted at @root, call this function to attempt freeing the
1584  *      node and shrinking the tree.
1585  */
1586 void __radix_tree_delete_node(struct radix_tree_root *root,
1587                               struct radix_tree_node *node)
1588 {
1589         delete_node(root, node, NULL, NULL);
1590 }
1591
1592 static inline void delete_sibling_entries(struct radix_tree_node *node,
1593                                         void *ptr, unsigned offset)
1594 {
1595 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1596         int i;
1597         for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1598                 if (node->slots[offset + i] != ptr)
1599                         break;
1600                 node->slots[offset + i] = NULL;
1601                 node->count--;
1602         }
1603 #endif
1604 }
1605
1606 /**
1607  *      radix_tree_delete_item    -    delete an item from a radix tree
1608  *      @root:          radix tree root
1609  *      @index:         index key
1610  *      @item:          expected item
1611  *
1612  *      Remove @item at @index from the radix tree rooted at @root.
1613  *
1614  *      Returns the address of the deleted item, or NULL if it was not present
1615  *      or the entry at the given @index was not @item.
1616  */
1617 void *radix_tree_delete_item(struct radix_tree_root *root,
1618                              unsigned long index, void *item)
1619 {
1620         struct radix_tree_node *node;
1621         unsigned int offset;
1622         void **slot;
1623         void *entry;
1624         int tag;
1625
1626         entry = __radix_tree_lookup(root, index, &node, &slot);
1627         if (!entry)
1628                 return NULL;
1629
1630         if (item && entry != item)
1631                 return NULL;
1632
1633         if (!node) {
1634                 root_tag_clear_all(root);
1635                 root->rnode = NULL;
1636                 return entry;
1637         }
1638
1639         offset = get_slot_offset(node, slot);
1640
1641         /* Clear all tags associated with the item to be deleted.  */
1642         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1643                 node_tag_clear(root, node, tag, offset);
1644
1645         delete_sibling_entries(node, node_to_entry(slot), offset);
1646         __radix_tree_replace(root, node, slot, NULL, NULL, NULL);
1647
1648         return entry;
1649 }
1650 EXPORT_SYMBOL(radix_tree_delete_item);
1651
1652 /**
1653  *      radix_tree_delete    -    delete an item from a radix tree
1654  *      @root:          radix tree root
1655  *      @index:         index key
1656  *
1657  *      Remove the item at @index from the radix tree rooted at @root.
1658  *
1659  *      Returns the address of the deleted item, or NULL if it was not present.
1660  */
1661 void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1662 {
1663         return radix_tree_delete_item(root, index, NULL);
1664 }
1665 EXPORT_SYMBOL(radix_tree_delete);
1666
1667 void radix_tree_clear_tags(struct radix_tree_root *root,
1668                            struct radix_tree_node *node,
1669                            void **slot)
1670 {
1671         if (node) {
1672                 unsigned int tag, offset = get_slot_offset(node, slot);
1673                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1674                         node_tag_clear(root, node, tag, offset);
1675         } else {
1676                 /* Clear root node tags */
1677                 root->gfp_mask &= __GFP_BITS_MASK;
1678         }
1679 }
1680
1681 /**
1682  *      radix_tree_tagged - test whether any items in the tree are tagged
1683  *      @root:          radix tree root
1684  *      @tag:           tag to test
1685  */
1686 int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
1687 {
1688         return root_tag_get(root, tag);
1689 }
1690 EXPORT_SYMBOL(radix_tree_tagged);
1691
1692 static void
1693 radix_tree_node_ctor(void *arg)
1694 {
1695         struct radix_tree_node *node = arg;
1696
1697         memset(node, 0, sizeof(*node));
1698         INIT_LIST_HEAD(&node->private_list);
1699 }
1700
1701 static __init unsigned long __maxindex(unsigned int height)
1702 {
1703         unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1704         int shift = RADIX_TREE_INDEX_BITS - width;
1705
1706         if (shift < 0)
1707                 return ~0UL;
1708         if (shift >= BITS_PER_LONG)
1709                 return 0UL;
1710         return ~0UL >> shift;
1711 }
1712
1713 static __init void radix_tree_init_maxnodes(void)
1714 {
1715         unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1];
1716         unsigned int i, j;
1717
1718         for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1719                 height_to_maxindex[i] = __maxindex(i);
1720         for (i = 0; i < ARRAY_SIZE(height_to_maxnodes); i++) {
1721                 for (j = i; j > 0; j--)
1722                         height_to_maxnodes[i] += height_to_maxindex[j - 1] + 1;
1723         }
1724 }
1725
1726 static int radix_tree_cpu_dead(unsigned int cpu)
1727 {
1728         struct radix_tree_preload *rtp;
1729         struct radix_tree_node *node;
1730
1731         /* Free per-cpu pool of preloaded nodes */
1732         rtp = &per_cpu(radix_tree_preloads, cpu);
1733         while (rtp->nr) {
1734                 node = rtp->nodes;
1735                 rtp->nodes = node->private_data;
1736                 kmem_cache_free(radix_tree_node_cachep, node);
1737                 rtp->nr--;
1738         }
1739         return 0;
1740 }
1741
1742 void __init radix_tree_init(void)
1743 {
1744         int ret;
1745         radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1746                         sizeof(struct radix_tree_node), 0,
1747                         SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1748                         radix_tree_node_ctor);
1749         radix_tree_init_maxnodes();
1750         ret = cpuhp_setup_state_nocalls(CPUHP_RADIX_DEAD, "lib/radix:dead",
1751                                         NULL, radix_tree_cpu_dead);
1752         WARN_ON(ret < 0);
1753 }