blob: dd04b51e5fbb63c45f6a556cc05c01f73baece0c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2001 Momchil Velikov
3 * Portions Copyright (C) 2001 Christoph Hellwig
Christoph Lametercde53532008-07-04 09:59:22 -07004 * Copyright (C) 2005 SGI, Christoph Lameter
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08005 * Copyright (C) 2006 Nick Piggin
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -07006 * Copyright (C) 2012 Konstantin Khlebnikov
Matthew Wilcox6b053b82016-05-20 17:02:58 -07007 * Copyright (C) 2016 Intel, Matthew Wilcox
8 * Copyright (C) 2016 Intel, Ross Zwisler
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
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>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050028#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/radix-tree.h>
30#include <linux/percpu.h>
31#include <linux/slab.h>
Catalin Marinasce80b062014-06-06 14:38:18 -070032#include <linux/kmemleak.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/notifier.h>
34#include <linux/cpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/string.h>
36#include <linux/bitops.h>
Nick Piggin7cf9c2c2006-12-06 20:33:44 -080037#include <linux/rcupdate.h>
Frederic Weisbecker92cf2112015-05-12 16:41:46 +020038#include <linux/preempt.h> /* in_interrupt() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40
Jeff Moyer26fb1582007-10-16 01:24:49 -070041/*
42 * The height_to_maxindex array needs to be one deeper than the maximum
43 * path as height 0 holds only 1 entry.
44 */
45static unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1] __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47/*
48 * Radix tree node cache.
49 */
Christoph Lametere18b8902006-12-06 20:33:20 -080050static struct kmem_cache *radix_tree_node_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52/*
Nick Piggin55368052012-05-29 15:07:34 -070053 * The radix tree is variable-height, so an insert operation not only has
54 * to build the branch to its corresponding item, it also has to build the
55 * branch to existing items if the size has to be increased (by
56 * radix_tree_extend).
57 *
58 * The worst case is a zero height tree with just a single item at index 0,
59 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
60 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
61 * Hence:
62 */
63#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
64
65/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 * Per-cpu pool of preloaded nodes
67 */
68struct radix_tree_preload {
Matthew Wilcox2fcd9002016-05-20 17:03:04 -070069 unsigned nr;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -070070 /* nodes->private_data points to next preallocated node */
71 struct radix_tree_node *nodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072};
Harvey Harrison8cef7d52009-01-06 14:40:50 -080073static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Nick Piggin27d20fd2010-11-11 14:05:19 -080075static inline void *ptr_to_indirect(void *ptr)
76{
77 return (void *)((unsigned long)ptr | RADIX_TREE_INDIRECT_PTR);
78}
79
Matthew Wilcoxafe0e392016-05-20 17:02:17 -070080#define RADIX_TREE_RETRY ptr_to_indirect(NULL)
81
Matthew Wilcoxdb050f22016-05-20 17:01:57 -070082#ifdef CONFIG_RADIX_TREE_MULTIORDER
83/* Sibling slots point directly to another slot in the same node */
84static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
85{
86 void **ptr = node;
87 return (parent->slots <= ptr) &&
88 (ptr < parent->slots + RADIX_TREE_MAP_SIZE);
89}
90#else
91static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
92{
93 return false;
94}
95#endif
96
97static inline unsigned long get_slot_offset(struct radix_tree_node *parent,
98 void **slot)
99{
100 return slot - parent->slots;
101}
102
103static unsigned radix_tree_descend(struct radix_tree_node *parent,
104 struct radix_tree_node **nodep, unsigned offset)
105{
106 void **entry = rcu_dereference_raw(parent->slots[offset]);
107
108#ifdef CONFIG_RADIX_TREE_MULTIORDER
109 if (radix_tree_is_indirect_ptr(entry)) {
110 unsigned long siboff = get_slot_offset(parent, entry);
111 if (siboff < RADIX_TREE_MAP_SIZE) {
112 offset = siboff;
113 entry = rcu_dereference_raw(parent->slots[offset]);
114 }
115 }
116#endif
117
118 *nodep = (void *)entry;
119 return offset;
120}
121
Nick Piggin612d6c12006-06-23 02:03:22 -0700122static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
123{
124 return root->gfp_mask & __GFP_BITS_MASK;
125}
126
Nick Piggin643b52b2008-06-12 15:21:52 -0700127static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
128 int offset)
129{
130 __set_bit(offset, node->tags[tag]);
131}
132
133static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
134 int offset)
135{
136 __clear_bit(offset, node->tags[tag]);
137}
138
139static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
140 int offset)
141{
142 return test_bit(offset, node->tags[tag]);
143}
144
145static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
146{
147 root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
148}
149
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700150static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
Nick Piggin643b52b2008-06-12 15:21:52 -0700151{
152 root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
153}
154
155static inline void root_tag_clear_all(struct radix_tree_root *root)
156{
157 root->gfp_mask &= __GFP_BITS_MASK;
158}
159
160static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
161{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700162 return (__force int)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
Nick Piggin643b52b2008-06-12 15:21:52 -0700163}
164
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700165static inline unsigned root_tags_get(struct radix_tree_root *root)
166{
167 return (__force unsigned)root->gfp_mask >> __GFP_BITS_SHIFT;
168}
169
Nick Piggin643b52b2008-06-12 15:21:52 -0700170/*
171 * Returns 1 if any slot in the node has this tag set.
172 * Otherwise returns 0.
173 */
174static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
175{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700176 unsigned idx;
Nick Piggin643b52b2008-06-12 15:21:52 -0700177 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
178 if (node->tags[tag][idx])
179 return 1;
180 }
181 return 0;
182}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700183
184/**
185 * radix_tree_find_next_bit - find the next set bit in a memory region
186 *
187 * @addr: The address to base the search on
188 * @size: The bitmap size in bits
189 * @offset: The bitnumber to start searching at
190 *
191 * Unrollable variant of find_next_bit() for constant size arrays.
192 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
193 * Returns next bit offset, or size if nothing found.
194 */
195static __always_inline unsigned long
196radix_tree_find_next_bit(const unsigned long *addr,
197 unsigned long size, unsigned long offset)
198{
199 if (!__builtin_constant_p(size))
200 return find_next_bit(addr, size, offset);
201
202 if (offset < size) {
203 unsigned long tmp;
204
205 addr += offset / BITS_PER_LONG;
206 tmp = *addr >> (offset % BITS_PER_LONG);
207 if (tmp)
208 return __ffs(tmp) + offset;
209 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
210 while (offset < size) {
211 tmp = *++addr;
212 if (tmp)
213 return __ffs(tmp) + offset;
214 offset += BITS_PER_LONG;
215 }
216 }
217 return size;
218}
219
Ross Zwisler0796c582016-05-20 17:02:55 -0700220#ifndef __KERNEL__
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700221static void dump_node(struct radix_tree_node *node,
Ross Zwisler0796c582016-05-20 17:02:55 -0700222 unsigned shift, unsigned long index)
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700223{
Ross Zwisler0796c582016-05-20 17:02:55 -0700224 unsigned long i;
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700225
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700226 pr_debug("radix node: %p offset %d tags %lx %lx %lx height %d count %d parent %p\n",
227 node, node->offset,
Ross Zwisler0796c582016-05-20 17:02:55 -0700228 node->tags[0][0], node->tags[1][0], node->tags[2][0],
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700229 node->height, node->count, node->parent);
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700230
Ross Zwisler0796c582016-05-20 17:02:55 -0700231 for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
232 unsigned long first = index | (i << shift);
233 unsigned long last = first | ((1UL << shift) - 1);
234 void *entry = node->slots[i];
235 if (!entry)
236 continue;
237 if (is_sibling_entry(node, entry)) {
238 pr_debug("radix sblng %p offset %ld val %p indices %ld-%ld\n",
239 entry, i,
240 *(void **)indirect_to_ptr(entry),
241 first, last);
242 } else if (!radix_tree_is_indirect_ptr(entry)) {
243 pr_debug("radix entry %p offset %ld indices %ld-%ld\n",
244 entry, i, first, last);
245 } else {
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700246 dump_node(indirect_to_ptr(entry),
Ross Zwisler0796c582016-05-20 17:02:55 -0700247 shift - RADIX_TREE_MAP_SHIFT, first);
248 }
249 }
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700250}
251
252/* For debug */
253static void radix_tree_dump(struct radix_tree_root *root)
254{
255 pr_debug("radix root: %p height %d rnode %p tags %x\n",
256 root, root->height, root->rnode,
257 root->gfp_mask >> __GFP_BITS_SHIFT);
258 if (!radix_tree_is_indirect_ptr(root->rnode))
259 return;
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700260 dump_node(indirect_to_ptr(root->rnode),
Ross Zwisler0796c582016-05-20 17:02:55 -0700261 (root->height - 1) * RADIX_TREE_MAP_SHIFT, 0);
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700262}
263#endif
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265/*
266 * This assumes that the caller has performed appropriate preallocation, and
267 * that the caller has pinned this thread of control to the current CPU.
268 */
269static struct radix_tree_node *
270radix_tree_node_alloc(struct radix_tree_root *root)
271{
Nick Piggine2848a02008-02-04 22:29:10 -0800272 struct radix_tree_node *ret = NULL;
Nick Piggin612d6c12006-06-23 02:03:22 -0700273 gfp_t gfp_mask = root_gfp_mask(root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Jan Kara5e4c0d972013-09-11 14:26:05 -0700275 /*
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700276 * Preload code isn't irq safe and it doesn't make sense to use
277 * preloading during an interrupt anyway as all the allocations have
278 * to be atomic. So just do normal allocation when in interrupt.
Jan Kara5e4c0d972013-09-11 14:26:05 -0700279 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800280 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 struct radix_tree_preload *rtp;
282
Nick Piggine2848a02008-02-04 22:29:10 -0800283 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700284 * Even if the caller has preloaded, try to allocate from the
285 * cache first for the new node to get accounted.
286 */
287 ret = kmem_cache_alloc(radix_tree_node_cachep,
288 gfp_mask | __GFP_ACCOUNT | __GFP_NOWARN);
289 if (ret)
290 goto out;
291
292 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800293 * Provided the caller has preloaded here, we will always
294 * succeed in getting a node here (and never reach
295 * kmem_cache_alloc)
296 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700297 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700299 ret = rtp->nodes;
300 rtp->nodes = ret->private_data;
301 ret->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 rtp->nr--;
303 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700304 /*
305 * Update the allocation stack trace as this is more useful
306 * for debugging.
307 */
308 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700309 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 }
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700311 ret = kmem_cache_alloc(radix_tree_node_cachep,
312 gfp_mask | __GFP_ACCOUNT);
313out:
Nick Pigginc0bc9872007-10-16 01:24:42 -0700314 BUG_ON(radix_tree_is_indirect_ptr(ret));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return ret;
316}
317
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800318static void radix_tree_node_rcu_free(struct rcu_head *head)
319{
320 struct radix_tree_node *node =
321 container_of(head, struct radix_tree_node, rcu_head);
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000322 int i;
Nick Piggin643b52b2008-06-12 15:21:52 -0700323
324 /*
325 * must only free zeroed nodes into the slab. radix_tree_shrink
326 * can leave us with a non-NULL entry in the first slot, so clear
327 * that here to make sure.
328 */
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000329 for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
330 tag_clear(node, i, 0);
331
Nick Piggin643b52b2008-06-12 15:21:52 -0700332 node->slots[0] = NULL;
333 node->count = 0;
334
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800335 kmem_cache_free(radix_tree_node_cachep, node);
336}
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338static inline void
339radix_tree_node_free(struct radix_tree_node *node)
340{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800341 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342}
343
344/*
345 * Load up this CPU's radix_tree_node buffer with sufficient objects to
346 * ensure that the addition of a single element in the tree cannot fail. On
347 * success, return zero, with preemption disabled. On error, return -ENOMEM
348 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000349 *
350 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800351 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 */
Jan Kara5e4c0d972013-09-11 14:26:05 -0700353static int __radix_tree_preload(gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
355 struct radix_tree_preload *rtp;
356 struct radix_tree_node *node;
357 int ret = -ENOMEM;
358
359 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700360 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700361 while (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 preempt_enable();
Christoph Lameter488514d2008-04-28 02:12:05 -0700363 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 if (node == NULL)
365 goto out;
366 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700367 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700368 if (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
369 node->private_data = rtp->nodes;
370 rtp->nodes = node;
371 rtp->nr++;
372 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700374 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 }
376 ret = 0;
377out:
378 return ret;
379}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700380
381/*
382 * Load up this CPU's radix_tree_node buffer with sufficient objects to
383 * ensure that the addition of a single element in the tree cannot fail. On
384 * success, return zero, with preemption disabled. On error, return -ENOMEM
385 * with preemption not disabled.
386 *
387 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800388 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700389 */
390int radix_tree_preload(gfp_t gfp_mask)
391{
392 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800393 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Jan Kara5e4c0d972013-09-11 14:26:05 -0700394 return __radix_tree_preload(gfp_mask);
395}
David Chinnerd7f09232007-07-14 16:05:04 +1000396EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Nick Piggin6e954b92006-01-08 01:01:40 -0800398/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700399 * The same as above function, except we don't guarantee preloading happens.
400 * We do it, if we decide it helps. On success, return zero with preemption
401 * disabled. On error, return -ENOMEM with preemption not disabled.
402 */
403int radix_tree_maybe_preload(gfp_t gfp_mask)
404{
Mel Gormand0164ad2015-11-06 16:28:21 -0800405 if (gfpflags_allow_blocking(gfp_mask))
Jan Kara5e4c0d972013-09-11 14:26:05 -0700406 return __radix_tree_preload(gfp_mask);
407 /* Preloading doesn't help anything with this gfp mask, skip it */
408 preempt_disable();
409 return 0;
410}
411EXPORT_SYMBOL(radix_tree_maybe_preload);
412
413/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 * Return the maximum key which can be store into a
415 * radix tree with height HEIGHT.
416 */
417static inline unsigned long radix_tree_maxindex(unsigned int height)
418{
419 return height_to_maxindex[height];
420}
421
Matthew Wilcox1456a432016-05-20 17:02:08 -0700422static inline unsigned long node_maxindex(struct radix_tree_node *node)
423{
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700424 return radix_tree_maxindex(node->height);
Matthew Wilcox1456a432016-05-20 17:02:08 -0700425}
426
427static unsigned radix_tree_load_root(struct radix_tree_root *root,
428 struct radix_tree_node **nodep, unsigned long *maxindex)
429{
430 struct radix_tree_node *node = rcu_dereference_raw(root->rnode);
431
432 *nodep = node;
433
434 if (likely(radix_tree_is_indirect_ptr(node))) {
435 node = indirect_to_ptr(node);
436 *maxindex = node_maxindex(node);
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700437 return node->height * RADIX_TREE_MAP_SHIFT;
Matthew Wilcox1456a432016-05-20 17:02:08 -0700438 }
439
440 *maxindex = 0;
441 return 0;
442}
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444/*
445 * Extend a radix tree so it can store key @index.
446 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700447static int radix_tree_extend(struct radix_tree_root *root,
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700448 unsigned long index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800450 struct radix_tree_node *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 unsigned int height;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 int tag;
453
454 /* Figure out what the height should be. */
455 height = root->height + 1;
456 while (index > radix_tree_maxindex(height))
457 height++;
458
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700459 if (root->rnode == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 root->height = height;
461 goto out;
462 }
463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 do {
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800465 unsigned int newheight;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700466 struct radix_tree_node *node = radix_tree_node_alloc(root);
467
468 if (!node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 return -ENOMEM;
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 /* Propagate the aggregated tag info into the new root */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800472 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Nick Piggin612d6c12006-06-23 02:03:22 -0700473 if (root_tag_get(root, tag))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 tag_set(node, tag, 0);
475 }
476
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800477 /* Increase the height. */
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700478 newheight = root->height + 1;
479 BUG_ON(newheight > BITS_PER_LONG);
480 node->height = newheight;
481 node->offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 node->count = 1;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800483 node->parent = NULL;
484 slot = root->rnode;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700485 if (radix_tree_is_indirect_ptr(slot)) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800486 slot = indirect_to_ptr(slot);
487 slot->parent = node;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700488 slot = ptr_to_indirect(slot);
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800489 }
490 node->slots[0] = slot;
Nick Piggin27d20fd2010-11-11 14:05:19 -0800491 node = ptr_to_indirect(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800492 rcu_assign_pointer(root->rnode, node);
493 root->height = newheight;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 } while (height > root->height);
495out:
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700496 return height * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
499/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700500 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 * @root: radix tree root
502 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700503 * @order: index occupies 2^order aligned slots
Johannes Weiner139e5612014-04-03 14:47:54 -0700504 * @nodep: returns node
505 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700507 * Create, if necessary, and return the node and slot for an item
508 * at position @index in the radix tree @root.
509 *
510 * Until there is more than one item in the tree, no nodes are
511 * allocated and @root->rnode is used as a direct slot instead of
512 * pointing to a node, in which case *@nodep will be NULL.
513 *
514 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700516int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700517 unsigned order, struct radix_tree_node **nodep,
518 void ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
Christoph Lameter201b6262005-09-06 15:16:46 -0700520 struct radix_tree_node *node = NULL, *slot;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700521 unsigned long maxindex;
Johannes Weiner139e5612014-04-03 14:47:54 -0700522 unsigned int height, shift, offset;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700523 unsigned long max = index | ((1UL << order) - 1);
524
525 shift = radix_tree_load_root(root, &slot, &maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 /* Make sure the tree is high enough. */
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700528 if (max > maxindex) {
529 int error = radix_tree_extend(root, max);
530 if (error < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 return error;
Matthew Wilcox49ea6eb2016-05-20 17:02:11 -0700532 shift = error;
533 slot = root->rnode;
534 if (order == shift) {
535 shift += RADIX_TREE_MAP_SHIFT;
536 root->height++;
537 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 }
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 height = root->height;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542 offset = 0; /* uninitialised var warning */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700543 while (shift > order) {
Christoph Lameter201b6262005-09-06 15:16:46 -0700544 if (slot == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 /* Have to add a child node. */
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700546 slot = radix_tree_node_alloc(root);
547 if (!slot)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return -ENOMEM;
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -0700549 slot->height = height;
550 slot->offset = offset;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800551 slot->parent = node;
Christoph Lameter201b6262005-09-06 15:16:46 -0700552 if (node) {
Matthew Wilcox339e6352016-03-17 14:21:48 -0700553 rcu_assign_pointer(node->slots[offset],
554 ptr_to_indirect(slot));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 node->count++;
Christoph Lameter201b6262005-09-06 15:16:46 -0700556 } else
Matthew Wilcox339e6352016-03-17 14:21:48 -0700557 rcu_assign_pointer(root->rnode,
558 ptr_to_indirect(slot));
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700559 } else if (!radix_tree_is_indirect_ptr(slot))
560 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
562 /* Go a level down */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700563 height--;
Matthew Wilcox0070e282016-03-17 14:21:51 -0700564 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700565 node = indirect_to_ptr(slot);
Matthew Wilcox8a14f4d2016-05-20 17:02:44 -0700566 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
567 offset = radix_tree_descend(node, &slot, offset);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700568 }
569
Matthew Wilcox57578c22016-05-20 17:01:54 -0700570#ifdef CONFIG_RADIX_TREE_MULTIORDER
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700571 /* Insert pointers to the canonical entry */
Matthew Wilcox3b8c00f2016-05-20 17:01:59 -0700572 if (order > shift) {
573 int i, n = 1 << (order - shift);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700574 offset = offset & ~(n - 1);
575 slot = ptr_to_indirect(&node->slots[offset]);
576 for (i = 0; i < n; i++) {
577 if (node->slots[offset + i])
578 return -EEXIST;
579 }
580
581 for (i = 1; i < n; i++) {
582 rcu_assign_pointer(node->slots[offset + i], slot);
583 node->count++;
584 }
Nick Piggin612d6c12006-06-23 02:03:22 -0700585 }
Matthew Wilcox57578c22016-05-20 17:01:54 -0700586#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Johannes Weiner139e5612014-04-03 14:47:54 -0700588 if (nodep)
589 *nodep = node;
590 if (slotp)
591 *slotp = node ? node->slots + offset : (void **)&root->rnode;
592 return 0;
593}
594
595/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700596 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700597 * @root: radix tree root
598 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700599 * @order: key covers the 2^order indices around index
Johannes Weiner139e5612014-04-03 14:47:54 -0700600 * @item: item to insert
601 *
602 * Insert an item into the radix tree at position @index.
603 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700604int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
605 unsigned order, void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700606{
607 struct radix_tree_node *node;
608 void **slot;
609 int error;
610
611 BUG_ON(radix_tree_is_indirect_ptr(item));
612
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700613 error = __radix_tree_create(root, index, order, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700614 if (error)
615 return error;
616 if (*slot != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return -EEXIST;
Johannes Weiner139e5612014-04-03 14:47:54 -0700618 rcu_assign_pointer(*slot, item);
Christoph Lameter201b6262005-09-06 15:16:46 -0700619
Nick Piggin612d6c12006-06-23 02:03:22 -0700620 if (node) {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700621 unsigned offset = get_slot_offset(node, slot);
Nick Piggin612d6c12006-06-23 02:03:22 -0700622 node->count++;
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700623 BUG_ON(tag_get(node, 0, offset));
624 BUG_ON(tag_get(node, 1, offset));
625 BUG_ON(tag_get(node, 2, offset));
Nick Piggin612d6c12006-06-23 02:03:22 -0700626 } else {
Matthew Wilcox7b60e9a2016-05-20 17:02:23 -0700627 BUG_ON(root_tags_get(root));
Nick Piggin612d6c12006-06-23 02:03:22 -0700628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 return 0;
631}
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700632EXPORT_SYMBOL(__radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Johannes Weiner139e5612014-04-03 14:47:54 -0700634/**
635 * __radix_tree_lookup - lookup an item in a radix tree
636 * @root: radix tree root
637 * @index: index key
638 * @nodep: returns node
639 * @slotp: returns slot
640 *
641 * Lookup and return the item at position @index in the radix
642 * tree @root.
643 *
644 * Until there is more than one item in the tree, no nodes are
645 * allocated and @root->rnode is used as a direct slot instead of
646 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800647 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700648void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
649 struct radix_tree_node **nodep, void ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800650{
Johannes Weiner139e5612014-04-03 14:47:54 -0700651 struct radix_tree_node *node, *parent;
Matthew Wilcox85829952016-05-20 17:02:20 -0700652 unsigned long maxindex;
653 unsigned int shift;
Johannes Weiner139e5612014-04-03 14:47:54 -0700654 void **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800655
Matthew Wilcox85829952016-05-20 17:02:20 -0700656 restart:
657 parent = NULL;
658 slot = (void **)&root->rnode;
659 shift = radix_tree_load_root(root, &node, &maxindex);
660 if (index > maxindex)
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800661 return NULL;
662
Matthew Wilcox85829952016-05-20 17:02:20 -0700663 while (radix_tree_is_indirect_ptr(node)) {
664 unsigned offset;
Johannes Weiner139e5612014-04-03 14:47:54 -0700665
Matthew Wilcox85829952016-05-20 17:02:20 -0700666 if (node == RADIX_TREE_RETRY)
667 goto restart;
668 parent = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800669 shift -= RADIX_TREE_MAP_SHIFT;
Matthew Wilcox85829952016-05-20 17:02:20 -0700670 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
671 offset = radix_tree_descend(parent, &node, offset);
672 slot = parent->slots + offset;
673 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800674
Johannes Weiner139e5612014-04-03 14:47:54 -0700675 if (nodep)
676 *nodep = parent;
677 if (slotp)
678 *slotp = slot;
679 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700680}
681
682/**
683 * radix_tree_lookup_slot - lookup a slot in a radix tree
684 * @root: radix tree root
685 * @index: index key
686 *
687 * Returns: the slot corresponding to the position @index in the
688 * radix tree @root. This is useful for update-if-exists operations.
689 *
690 * This function can be called under rcu_read_lock iff the slot is not
691 * modified by radix_tree_replace_slot, otherwise it must be called
692 * exclusive from other writers. Any dereference of the slot must be done
693 * using radix_tree_deref_slot.
694 */
695void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
696{
Johannes Weiner139e5612014-04-03 14:47:54 -0700697 void **slot;
698
699 if (!__radix_tree_lookup(root, index, NULL, &slot))
700 return NULL;
701 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800702}
703EXPORT_SYMBOL(radix_tree_lookup_slot);
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705/**
706 * radix_tree_lookup - perform lookup operation on a radix tree
707 * @root: radix tree root
708 * @index: index key
709 *
710 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800711 *
712 * This function can be called under rcu_read_lock, however the caller
713 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
714 * them safely). No RCU barriers are required to access or modify the
715 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 */
717void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
718{
Johannes Weiner139e5612014-04-03 14:47:54 -0700719 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720}
721EXPORT_SYMBOL(radix_tree_lookup);
722
723/**
724 * radix_tree_tag_set - set a tag on a radix tree node
725 * @root: radix tree root
726 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700727 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800729 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
730 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 * the root all the way down to the leaf node.
732 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700733 * Returns the address of the tagged item. Setting a tag on a not-present
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 * item is a bug.
735 */
736void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800737 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738{
Ross Zwislerfb969902016-05-20 17:02:32 -0700739 struct radix_tree_node *node, *parent;
740 unsigned long maxindex;
741 unsigned int shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
Ross Zwislerfb969902016-05-20 17:02:32 -0700743 shift = radix_tree_load_root(root, &node, &maxindex);
744 BUG_ON(index > maxindex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Ross Zwislerfb969902016-05-20 17:02:32 -0700746 while (radix_tree_is_indirect_ptr(node)) {
747 unsigned offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 shift -= RADIX_TREE_MAP_SHIFT;
Ross Zwislerfb969902016-05-20 17:02:32 -0700750 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
751
752 parent = indirect_to_ptr(node);
753 offset = radix_tree_descend(parent, &node, offset);
754 BUG_ON(!node);
755
756 if (!tag_get(parent, tag, offset))
757 tag_set(parent, tag, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 }
759
Nick Piggin612d6c12006-06-23 02:03:22 -0700760 /* set the root's tag bit */
Ross Zwislerfb969902016-05-20 17:02:32 -0700761 if (!root_tag_get(root, tag))
Nick Piggin612d6c12006-06-23 02:03:22 -0700762 root_tag_set(root, tag);
763
Ross Zwislerfb969902016-05-20 17:02:32 -0700764 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765}
766EXPORT_SYMBOL(radix_tree_tag_set);
767
768/**
769 * radix_tree_tag_clear - clear a tag on a radix tree node
770 * @root: radix tree root
771 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700772 * @tag: tag index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800774 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700775 * corresponding to @index in the radix tree. If this causes
776 * the leaf node to have no tags set then clear the tag in the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 * next-to-leaf node, etc.
778 *
779 * Returns the address of the tagged item on success, else NULL. ie:
780 * has the same return value and semantics as radix_tree_lookup().
781 */
782void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800783 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784{
Ross Zwisler00f47b52016-05-20 17:02:35 -0700785 struct radix_tree_node *node, *parent;
786 unsigned long maxindex;
787 unsigned int shift;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800788 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Ross Zwisler00f47b52016-05-20 17:02:35 -0700790 shift = radix_tree_load_root(root, &node, &maxindex);
791 if (index > maxindex)
792 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Ross Zwisler00f47b52016-05-20 17:02:35 -0700794 parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Ross Zwisler00f47b52016-05-20 17:02:35 -0700796 while (radix_tree_is_indirect_ptr(node)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800798 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Ross Zwisler00f47b52016-05-20 17:02:35 -0700799
800 parent = indirect_to_ptr(node);
801 offset = radix_tree_descend(parent, &node, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 }
803
Ross Zwisler00f47b52016-05-20 17:02:35 -0700804 if (node == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 goto out;
806
Ross Zwisler00f47b52016-05-20 17:02:35 -0700807 index >>= shift;
808
809 while (parent) {
810 if (!tag_get(parent, tag, offset))
Nick Piggind5274262006-01-08 01:01:41 -0800811 goto out;
Ross Zwisler00f47b52016-05-20 17:02:35 -0700812 tag_clear(parent, tag, offset);
813 if (any_tag_set(parent, tag))
Nick Piggin6e954b92006-01-08 01:01:40 -0800814 goto out;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800815
816 index >>= RADIX_TREE_MAP_SHIFT;
817 offset = index & RADIX_TREE_MAP_MASK;
Ross Zwisler00f47b52016-05-20 17:02:35 -0700818 parent = parent->parent;
Nick Piggin612d6c12006-06-23 02:03:22 -0700819 }
820
821 /* clear the root's tag bit */
822 if (root_tag_get(root, tag))
823 root_tag_clear(root, tag);
824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825out:
Ross Zwisler00f47b52016-05-20 17:02:35 -0700826 return node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
828EXPORT_SYMBOL(radix_tree_tag_clear);
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700831 * radix_tree_tag_get - get a tag on a radix tree node
832 * @root: radix tree root
833 * @index: index key
Matthew Wilcox2fcd9002016-05-20 17:03:04 -0700834 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700836 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 *
Nick Piggin612d6c12006-06-23 02:03:22 -0700838 * 0: tag not present or not set
839 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +0100840 *
841 * Note that the return value of this function may not be relied on, even if
842 * the RCU lock is held, unless tag modification and node deletion are excluded
843 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 */
845int radix_tree_tag_get(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800846 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847{
Ross Zwisler4589ba62016-05-20 17:02:38 -0700848 struct radix_tree_node *node, *parent;
849 unsigned long maxindex;
850 unsigned int shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Nick Piggin612d6c12006-06-23 02:03:22 -0700852 if (!root_tag_get(root, tag))
853 return 0;
854
Ross Zwisler4589ba62016-05-20 17:02:38 -0700855 shift = radix_tree_load_root(root, &node, &maxindex);
856 if (index > maxindex)
857 return 0;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800858 if (node == NULL)
859 return 0;
860
Ross Zwisler4589ba62016-05-20 17:02:38 -0700861 while (radix_tree_is_indirect_ptr(node)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 int offset;
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 shift -= RADIX_TREE_MAP_SHIFT;
Ross Zwisler4589ba62016-05-20 17:02:38 -0700865 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
866
867 parent = indirect_to_ptr(node);
868 offset = radix_tree_descend(parent, &node, offset);
869
870 if (!node)
871 return 0;
872 if (!tag_get(parent, tag, offset))
873 return 0;
874 if (node == RADIX_TREE_RETRY)
875 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 }
Ross Zwisler4589ba62016-05-20 17:02:38 -0700877
878 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
880EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Ross Zwisler21ef5332016-05-20 17:02:26 -0700882static inline void __set_iter_shift(struct radix_tree_iter *iter,
883 unsigned int shift)
884{
885#ifdef CONFIG_RADIX_TREE_MULTIORDER
886 iter->shift = shift;
887#endif
888}
889
Fengguang Wu6df8ba42007-10-16 01:24:33 -0700890/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700891 * radix_tree_next_chunk - find next chunk of slots for iteration
892 *
893 * @root: radix tree root
894 * @iter: iterator state
895 * @flags: RADIX_TREE_ITER_* flags and tag index
896 * Returns: pointer to chunk first slot, or NULL if iteration is over
897 */
898void **radix_tree_next_chunk(struct radix_tree_root *root,
899 struct radix_tree_iter *iter, unsigned flags)
900{
901 unsigned shift, tag = flags & RADIX_TREE_ITER_TAG_MASK;
902 struct radix_tree_node *rnode, *node;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700903 unsigned long index, offset, maxindex;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700904
905 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
906 return NULL;
907
908 /*
909 * Catch next_index overflow after ~0UL. iter->index never overflows
910 * during iterating; it can be zero only at the beginning.
911 * And we cannot overflow iter->next_index in a single step,
912 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +0400913 *
914 * This condition also used by radix_tree_next_slot() to stop
915 * contiguous iterating, and forbid swithing to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700916 */
917 index = iter->next_index;
918 if (!index && iter->index)
919 return NULL;
920
Ross Zwisler21ef5332016-05-20 17:02:26 -0700921 restart:
922 shift = radix_tree_load_root(root, &rnode, &maxindex);
923 if (index > maxindex)
924 return NULL;
925
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700926 if (radix_tree_is_indirect_ptr(rnode)) {
927 rnode = indirect_to_ptr(rnode);
Ross Zwisler21ef5332016-05-20 17:02:26 -0700928 } else if (rnode) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700929 /* Single-slot tree */
Ross Zwisler21ef5332016-05-20 17:02:26 -0700930 iter->index = index;
931 iter->next_index = maxindex + 1;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700932 iter->tags = 1;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700933 __set_iter_shift(iter, shift);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700934 return (void **)&root->rnode;
935 } else
936 return NULL;
937
Ross Zwisler21ef5332016-05-20 17:02:26 -0700938 shift -= RADIX_TREE_MAP_SHIFT;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700939 offset = index >> shift;
940
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700941 node = rnode;
942 while (1) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700943 struct radix_tree_node *slot;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700944 unsigned new_off = radix_tree_descend(node, &slot, offset);
945
946 if (new_off < offset) {
947 offset = new_off;
948 index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
949 index |= offset << shift;
950 }
951
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700952 if ((flags & RADIX_TREE_ITER_TAGGED) ?
Ross Zwisler21ef5332016-05-20 17:02:26 -0700953 !tag_get(node, tag, offset) : !slot) {
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700954 /* Hole detected */
955 if (flags & RADIX_TREE_ITER_CONTIG)
956 return NULL;
957
958 if (flags & RADIX_TREE_ITER_TAGGED)
959 offset = radix_tree_find_next_bit(
960 node->tags[tag],
961 RADIX_TREE_MAP_SIZE,
962 offset + 1);
963 else
964 while (++offset < RADIX_TREE_MAP_SIZE) {
Ross Zwisler21ef5332016-05-20 17:02:26 -0700965 void *slot = node->slots[offset];
966 if (is_sibling_entry(node, slot))
967 continue;
968 if (slot)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700969 break;
970 }
971 index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
972 index += offset << shift;
973 /* Overflow after ~0UL */
974 if (!index)
975 return NULL;
976 if (offset == RADIX_TREE_MAP_SIZE)
977 goto restart;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700978 slot = rcu_dereference_raw(node->slots[offset]);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700979 }
980
Ross Zwisler21ef5332016-05-20 17:02:26 -0700981 if ((slot == NULL) || (slot == RADIX_TREE_RETRY))
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700982 goto restart;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700983 if (!radix_tree_is_indirect_ptr(slot))
984 break;
Ross Zwisler21ef5332016-05-20 17:02:26 -0700985
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700986 node = indirect_to_ptr(slot);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700987 shift -= RADIX_TREE_MAP_SHIFT;
988 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
989 }
990
991 /* Update the iterator state */
Ross Zwisler21ef5332016-05-20 17:02:26 -0700992 iter->index = index & ~((1 << shift) - 1);
993 iter->next_index = (index | ((RADIX_TREE_MAP_SIZE << shift) - 1)) + 1;
994 __set_iter_shift(iter, shift);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700995
996 /* Construct iter->tags bit-mask from node->tags[tag] array */
997 if (flags & RADIX_TREE_ITER_TAGGED) {
998 unsigned tag_long, tag_bit;
999
1000 tag_long = offset / BITS_PER_LONG;
1001 tag_bit = offset % BITS_PER_LONG;
1002 iter->tags = node->tags[tag][tag_long] >> tag_bit;
1003 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1004 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1005 /* Pick tags from next element */
1006 if (tag_bit)
1007 iter->tags |= node->tags[tag][tag_long + 1] <<
1008 (BITS_PER_LONG - tag_bit);
1009 /* Clip chunk size, here only BITS_PER_LONG tags */
1010 iter->next_index = index + BITS_PER_LONG;
1011 }
1012 }
1013
1014 return node->slots + offset;
1015}
1016EXPORT_SYMBOL(radix_tree_next_chunk);
1017
1018/**
Jan Karaebf8aa42010-08-09 17:19:11 -07001019 * radix_tree_range_tag_if_tagged - for each item in given range set given
1020 * tag if item has another tag set
1021 * @root: radix tree root
1022 * @first_indexp: pointer to a starting index of a range to scan
1023 * @last_index: last index of a range to scan
1024 * @nr_to_tag: maximum number items to tag
1025 * @iftag: tag index to test
1026 * @settag: tag index to set if tested tag is set
1027 *
1028 * This function scans range of radix tree from first_index to last_index
1029 * (inclusive). For each item in the range if iftag is set, the function sets
1030 * also settag. The function stops either after tagging nr_to_tag items or
1031 * after reaching last_index.
1032 *
Dave Chinner144dcfc2010-08-23 10:33:53 +10001033 * The tags must be set from the leaf level only and propagated back up the
1034 * path to the root. We must do this so that we resolve the full path before
1035 * setting any tags on intermediate nodes. If we set tags as we descend, then
1036 * we can get to the leaf node and find that the index that has the iftag
1037 * set is outside the range we are scanning. This reults in dangling tags and
1038 * can lead to problems with later tag operations (e.g. livelocks on lookups).
1039 *
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001040 * The function returns the number of leaves where the tag was set and sets
Jan Karaebf8aa42010-08-09 17:19:11 -07001041 * *first_indexp to the first unscanned index.
Jan Karad5ed3a42010-08-19 14:13:33 -07001042 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
1043 * be prepared to handle that.
Jan Karaebf8aa42010-08-09 17:19:11 -07001044 */
1045unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
1046 unsigned long *first_indexp, unsigned long last_index,
1047 unsigned long nr_to_tag,
1048 unsigned int iftag, unsigned int settag)
1049{
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001050 struct radix_tree_node *slot, *node = NULL;
1051 unsigned long maxindex;
1052 unsigned int shift = radix_tree_load_root(root, &slot, &maxindex);
Dave Chinner144dcfc2010-08-23 10:33:53 +10001053 unsigned long tagged = 0;
1054 unsigned long index = *first_indexp;
Jan Karaebf8aa42010-08-09 17:19:11 -07001055
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001056 last_index = min(last_index, maxindex);
Jan Karaebf8aa42010-08-09 17:19:11 -07001057 if (index > last_index)
1058 return 0;
1059 if (!nr_to_tag)
1060 return 0;
1061 if (!root_tag_get(root, iftag)) {
1062 *first_indexp = last_index + 1;
1063 return 0;
1064 }
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001065 if (!radix_tree_is_indirect_ptr(slot)) {
Jan Karaebf8aa42010-08-09 17:19:11 -07001066 *first_indexp = last_index + 1;
1067 root_tag_set(root, settag);
1068 return 1;
1069 }
1070
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001071 node = indirect_to_ptr(slot);
1072 shift -= RADIX_TREE_MAP_SHIFT;
Jan Karaebf8aa42010-08-09 17:19:11 -07001073
1074 for (;;) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001075 unsigned long upindex;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001076 unsigned offset;
Jan Karaebf8aa42010-08-09 17:19:11 -07001077
1078 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001079 offset = radix_tree_descend(node, &slot, offset);
1080 if (!slot)
Jan Karaebf8aa42010-08-09 17:19:11 -07001081 goto next;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001082 if (!tag_get(node, iftag, offset))
Jan Karaebf8aa42010-08-09 17:19:11 -07001083 goto next;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001084 /* Sibling slots never have tags set on them */
1085 if (radix_tree_is_indirect_ptr(slot)) {
1086 node = indirect_to_ptr(slot);
1087 shift -= RADIX_TREE_MAP_SHIFT;
1088 continue;
Jan Karaebf8aa42010-08-09 17:19:11 -07001089 }
Dave Chinner144dcfc2010-08-23 10:33:53 +10001090
1091 /* tag the leaf */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001092 tagged++;
1093 tag_set(node, settag, offset);
Dave Chinner144dcfc2010-08-23 10:33:53 +10001094
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001095 slot = node->parent;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001096 /* walk back up the path tagging interior nodes */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001097 upindex = index >> shift;
1098 while (slot) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001099 upindex >>= RADIX_TREE_MAP_SHIFT;
1100 offset = upindex & RADIX_TREE_MAP_MASK;
1101
Dave Chinner144dcfc2010-08-23 10:33:53 +10001102 /* stop if we find a node with the tag already set */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001103 if (tag_get(slot, settag, offset))
Dave Chinner144dcfc2010-08-23 10:33:53 +10001104 break;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001105 tag_set(slot, settag, offset);
1106 slot = slot->parent;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001107 }
1108
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001109 next:
Jan Karaebf8aa42010-08-09 17:19:11 -07001110 /* Go to next item at level determined by 'shift' */
1111 index = ((index >> shift) + 1) << shift;
Jan Karad5ed3a42010-08-19 14:13:33 -07001112 /* Overflow can happen when last_index is ~0UL... */
1113 if (index > last_index || !index)
Jan Karaebf8aa42010-08-09 17:19:11 -07001114 break;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001115 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1116 while (offset == 0) {
Jan Karaebf8aa42010-08-09 17:19:11 -07001117 /*
1118 * We've fully scanned this node. Go up. Because
1119 * last_index is guaranteed to be in the tree, what
1120 * we do below cannot wander astray.
1121 */
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001122 node = node->parent;
Jan Karaebf8aa42010-08-09 17:19:11 -07001123 shift += RADIX_TREE_MAP_SHIFT;
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001124 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Jan Karaebf8aa42010-08-09 17:19:11 -07001125 }
Matthew Wilcox070c5ac2016-05-20 17:02:52 -07001126 if (is_sibling_entry(node, node->slots[offset]))
1127 goto next;
1128 if (tagged >= nr_to_tag)
1129 break;
Jan Karaebf8aa42010-08-09 17:19:11 -07001130 }
1131 /*
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001132 * We need not to tag the root tag if there is no tag which is set with
1133 * settag within the range from *first_indexp to last_index.
Jan Karaebf8aa42010-08-09 17:19:11 -07001134 */
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001135 if (tagged > 0)
1136 root_tag_set(root, settag);
Jan Karaebf8aa42010-08-09 17:19:11 -07001137 *first_indexp = index;
1138
1139 return tagged;
1140}
1141EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143/**
1144 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1145 * @root: radix tree root
1146 * @results: where the results of the lookup are placed
1147 * @first_index: start the lookup from this key
1148 * @max_items: place up to this many items at *results
1149 *
1150 * Performs an index-ascending scan of the tree for present items. Places
1151 * them at *@results and returns the number of items which were placed at
1152 * *@results.
1153 *
1154 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001155 *
1156 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1157 * rcu_read_lock. In this case, rather than the returned results being
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001158 * an atomic snapshot of the tree at a single point in time, the
1159 * semantics of an RCU protected gang lookup are as though multiple
1160 * radix_tree_lookups have been issued in individual locks, and results
1161 * stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 */
1163unsigned int
1164radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1165 unsigned long first_index, unsigned int max_items)
1166{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001167 struct radix_tree_iter iter;
1168 void **slot;
1169 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001171 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001172 return 0;
1173
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001174 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001175 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001176 if (!results[ret])
1177 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001178 if (radix_tree_is_indirect_ptr(results[ret])) {
1179 slot = radix_tree_iter_retry(&iter);
1180 continue;
1181 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001182 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001185
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 return ret;
1187}
1188EXPORT_SYMBOL(radix_tree_gang_lookup);
1189
Nick Piggin47feff22008-07-25 19:45:29 -07001190/**
1191 * radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1192 * @root: radix tree root
1193 * @results: where the results of the lookup are placed
Hugh Dickins63286502011-08-03 16:21:18 -07001194 * @indices: where their indices should be placed (but usually NULL)
Nick Piggin47feff22008-07-25 19:45:29 -07001195 * @first_index: start the lookup from this key
1196 * @max_items: place up to this many items at *results
1197 *
1198 * Performs an index-ascending scan of the tree for present items. Places
1199 * their slots at *@results and returns the number of items which were
1200 * placed at *@results.
1201 *
1202 * The implementation is naive.
1203 *
1204 * Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1205 * be dereferenced with radix_tree_deref_slot, and if using only RCU
1206 * protection, radix_tree_deref_slot may fail requiring a retry.
1207 */
1208unsigned int
Hugh Dickins63286502011-08-03 16:21:18 -07001209radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1210 void ***results, unsigned long *indices,
Nick Piggin47feff22008-07-25 19:45:29 -07001211 unsigned long first_index, unsigned int max_items)
1212{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001213 struct radix_tree_iter iter;
1214 void **slot;
1215 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001216
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001217 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001218 return 0;
1219
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001220 radix_tree_for_each_slot(slot, root, &iter, first_index) {
1221 results[ret] = slot;
Hugh Dickins63286502011-08-03 16:21:18 -07001222 if (indices)
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001223 indices[ret] = iter.index;
1224 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001225 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001226 }
1227
1228 return ret;
1229}
1230EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232/**
1233 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1234 * based on a tag
1235 * @root: radix tree root
1236 * @results: where the results of the lookup are placed
1237 * @first_index: start the lookup from this key
1238 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001239 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 *
1241 * Performs an index-ascending scan of the tree for present items which
1242 * have the tag indexed by @tag set. Places the items at *@results and
1243 * returns the number of items which were placed at *@results.
1244 */
1245unsigned int
1246radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001247 unsigned long first_index, unsigned int max_items,
1248 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001250 struct radix_tree_iter iter;
1251 void **slot;
1252 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001254 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001255 return 0;
1256
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001257 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001258 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001259 if (!results[ret])
1260 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001261 if (radix_tree_is_indirect_ptr(results[ret])) {
1262 slot = radix_tree_iter_retry(&iter);
1263 continue;
1264 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001265 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return ret;
1270}
1271EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1272
1273/**
Nick Piggin47feff22008-07-25 19:45:29 -07001274 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1275 * radix tree based on a tag
1276 * @root: radix tree root
1277 * @results: where the results of the lookup are placed
1278 * @first_index: start the lookup from this key
1279 * @max_items: place up to this many items at *results
1280 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1281 *
1282 * Performs an index-ascending scan of the tree for present items which
1283 * have the tag indexed by @tag set. Places the slots at *@results and
1284 * returns the number of slots which were placed at *@results.
1285 */
1286unsigned int
1287radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1288 unsigned long first_index, unsigned int max_items,
1289 unsigned int tag)
1290{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001291 struct radix_tree_iter iter;
1292 void **slot;
1293 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001294
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001295 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001296 return 0;
1297
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001298 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1299 results[ret] = slot;
1300 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001301 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001302 }
1303
1304 return ret;
1305}
1306EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1307
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001308#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1309#include <linux/sched.h> /* for cond_resched() */
1310
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001311struct locate_info {
1312 unsigned long found_index;
1313 bool stop;
1314};
1315
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001316/*
1317 * This linear search is at present only useful to shmem_unuse_inode().
1318 */
1319static unsigned long __locate(struct radix_tree_node *slot, void *item,
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001320 unsigned long index, struct locate_info *info)
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001321{
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -07001322 unsigned int shift;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001323 unsigned long i;
1324
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -07001325 shift = slot->height * RADIX_TREE_MAP_SHIFT;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001326
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001327 do {
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001328 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001329
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001330 for (i = (index >> shift) & RADIX_TREE_MAP_MASK;
1331 i < RADIX_TREE_MAP_SIZE;
1332 i++, index += (1UL << shift)) {
1333 struct radix_tree_node *node =
1334 rcu_dereference_raw(slot->slots[i]);
1335 if (node == RADIX_TREE_RETRY)
1336 goto out;
1337 if (!radix_tree_is_indirect_ptr(node)) {
1338 if (node == item) {
1339 info->found_index = index;
1340 info->stop = true;
1341 goto out;
1342 }
1343 continue;
1344 }
1345 node = indirect_to_ptr(node);
1346 if (is_sibling_entry(slot, node))
1347 continue;
1348 slot = node;
1349 break;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001350 }
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001351 if (i == RADIX_TREE_MAP_SIZE)
1352 break;
1353 } while (shift);
1354
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001355out:
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001356 if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
1357 info->stop = true;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001358 return index;
1359}
1360
1361/**
1362 * radix_tree_locate_item - search through radix tree for item
1363 * @root: radix tree root
1364 * @item: item to be found
1365 *
1366 * Returns index where item was found, or -1 if not found.
1367 * Caller must hold no lock (since this time-consuming function needs
1368 * to be preemptible), and must check afterwards if item is still there.
1369 */
1370unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1371{
1372 struct radix_tree_node *node;
1373 unsigned long max_index;
1374 unsigned long cur_index = 0;
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001375 struct locate_info info = {
1376 .found_index = -1,
1377 .stop = false,
1378 };
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001379
1380 do {
1381 rcu_read_lock();
1382 node = rcu_dereference_raw(root->rnode);
1383 if (!radix_tree_is_indirect_ptr(node)) {
1384 rcu_read_unlock();
1385 if (node == item)
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001386 info.found_index = 0;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001387 break;
1388 }
1389
1390 node = indirect_to_ptr(node);
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001391
1392 max_index = node_maxindex(node);
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001393 if (cur_index > max_index) {
1394 rcu_read_unlock();
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001395 break;
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001396 }
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001397
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001398 cur_index = __locate(node, item, cur_index, &info);
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001399 rcu_read_unlock();
1400 cond_resched();
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001401 } while (!info.stop && cur_index <= max_index);
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001402
Matthew Wilcox0a2efc62016-05-20 17:02:46 -07001403 return info.found_index;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001404}
1405#else
1406unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1407{
1408 return -1;
1409}
1410#endif /* CONFIG_SHMEM && CONFIG_SWAP */
Nick Piggin47feff22008-07-25 19:45:29 -07001411
1412/**
Nick Piggina5f51c92006-01-08 01:01:41 -08001413 * radix_tree_shrink - shrink height of a radix tree to minimal
1414 * @root radix tree root
1415 */
1416static inline void radix_tree_shrink(struct radix_tree_root *root)
1417{
1418 /* try to shrink tree height */
Nick Pigginc0bc9872007-10-16 01:24:42 -07001419 while (root->height > 0) {
Nick Piggina5f51c92006-01-08 01:01:41 -08001420 struct radix_tree_node *to_free = root->rnode;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001421 struct radix_tree_node *slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001422
Nick Pigginc0bc9872007-10-16 01:24:42 -07001423 BUG_ON(!radix_tree_is_indirect_ptr(to_free));
Nick Piggin27d20fd2010-11-11 14:05:19 -08001424 to_free = indirect_to_ptr(to_free);
Nick Pigginc0bc9872007-10-16 01:24:42 -07001425
1426 /*
1427 * The candidate node has more than one child, or its child
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001428 * is not at the leftmost slot, or it is a multiorder entry,
1429 * we cannot shrink.
Nick Pigginc0bc9872007-10-16 01:24:42 -07001430 */
1431 if (to_free->count != 1)
1432 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -07001433 slot = to_free->slots[0];
1434 if (!slot)
Nick Pigginc0bc9872007-10-16 01:24:42 -07001435 break;
Matthew Wilcoxafe0e392016-05-20 17:02:17 -07001436 if (!radix_tree_is_indirect_ptr(slot) && (root->height > 1))
1437 break;
1438
1439 if (radix_tree_is_indirect_ptr(slot)) {
1440 slot = indirect_to_ptr(slot);
1441 slot->parent = NULL;
1442 slot = ptr_to_indirect(slot);
1443 }
Nick Pigginc0bc9872007-10-16 01:24:42 -07001444
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001445 /*
1446 * We don't need rcu_assign_pointer(), since we are simply
Nick Piggin27d20fd2010-11-11 14:05:19 -08001447 * moving the node from one part of the tree to another: if it
1448 * was safe to dereference the old pointer to it
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001449 * (to_free->slots[0]), it will be safe to dereference the new
Nick Piggin27d20fd2010-11-11 14:05:19 -08001450 * one (root->rnode) as far as dependent read barriers go.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001451 */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001452 root->rnode = slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001453 root->height--;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001454
1455 /*
1456 * We have a dilemma here. The node's slot[0] must not be
1457 * NULLed in case there are concurrent lookups expecting to
1458 * find the item. However if this was a bottom-level node,
1459 * then it may be subject to the slot pointer being visible
1460 * to callers dereferencing it. If item corresponding to
1461 * slot[0] is subsequently deleted, these callers would expect
1462 * their slot to become empty sooner or later.
1463 *
1464 * For example, lockless pagecache will look up a slot, deref
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001465 * the page pointer, and if the page has 0 refcount it means it
Nick Piggin27d20fd2010-11-11 14:05:19 -08001466 * was concurrently deleted from pagecache so try the deref
1467 * again. Fortunately there is already a requirement for logic
1468 * to retry the entire slot lookup -- the indirect pointer
1469 * problem (replacing direct root node with an indirect pointer
1470 * also results in a stale slot). So tag the slot as indirect
1471 * to force callers to retry.
1472 */
Matthew Wilcoxafe0e392016-05-20 17:02:17 -07001473 if (!radix_tree_is_indirect_ptr(slot))
1474 to_free->slots[0] = RADIX_TREE_RETRY;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001475
Nick Piggina5f51c92006-01-08 01:01:41 -08001476 radix_tree_node_free(to_free);
1477 }
1478}
1479
1480/**
Johannes Weiner139e5612014-04-03 14:47:54 -07001481 * __radix_tree_delete_node - try to free node after clearing a slot
1482 * @root: radix tree root
Johannes Weiner139e5612014-04-03 14:47:54 -07001483 * @node: node containing @index
1484 *
1485 * After clearing the slot at @index in @node from radix tree
1486 * rooted at @root, call this function to attempt freeing the
1487 * node and shrinking the tree.
1488 *
1489 * Returns %true if @node was freed, %false otherwise.
1490 */
Johannes Weiner449dd692014-04-03 14:47:56 -07001491bool __radix_tree_delete_node(struct radix_tree_root *root,
Johannes Weiner139e5612014-04-03 14:47:54 -07001492 struct radix_tree_node *node)
1493{
1494 bool deleted = false;
1495
1496 do {
1497 struct radix_tree_node *parent;
1498
1499 if (node->count) {
1500 if (node == indirect_to_ptr(root->rnode)) {
1501 radix_tree_shrink(root);
1502 if (root->height == 0)
1503 deleted = true;
1504 }
1505 return deleted;
1506 }
1507
1508 parent = node->parent;
1509 if (parent) {
Matthew Wilcox0c7fa0a2016-05-20 17:03:07 -07001510 parent->slots[node->offset] = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001511 parent->count--;
1512 } else {
1513 root_tag_clear_all(root);
1514 root->height = 0;
1515 root->rnode = NULL;
1516 }
1517
1518 radix_tree_node_free(node);
1519 deleted = true;
1520
1521 node = parent;
1522 } while (node);
1523
1524 return deleted;
1525}
1526
Matthew Wilcox57578c22016-05-20 17:01:54 -07001527static inline void delete_sibling_entries(struct radix_tree_node *node,
1528 void *ptr, unsigned offset)
1529{
1530#ifdef CONFIG_RADIX_TREE_MULTIORDER
1531 int i;
1532 for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1533 if (node->slots[offset + i] != ptr)
1534 break;
1535 node->slots[offset + i] = NULL;
1536 node->count--;
1537 }
1538#endif
1539}
1540
Johannes Weiner139e5612014-04-03 14:47:54 -07001541/**
Johannes Weiner53c59f22014-04-03 14:47:39 -07001542 * radix_tree_delete_item - delete an item from a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 * @root: radix tree root
1544 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001545 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001547 * Remove @item at @index from the radix tree rooted at @root.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001549 * Returns the address of the deleted item, or NULL if it was not present
1550 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001552void *radix_tree_delete_item(struct radix_tree_root *root,
1553 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554{
Johannes Weiner139e5612014-04-03 14:47:54 -07001555 struct radix_tree_node *node;
Matthew Wilcox57578c22016-05-20 17:01:54 -07001556 unsigned int offset;
Johannes Weiner139e5612014-04-03 14:47:54 -07001557 void **slot;
1558 void *entry;
Nick Piggind5274262006-01-08 01:01:41 -08001559 int tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Johannes Weiner139e5612014-04-03 14:47:54 -07001561 entry = __radix_tree_lookup(root, index, &node, &slot);
1562 if (!entry)
1563 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Johannes Weiner139e5612014-04-03 14:47:54 -07001565 if (item && entry != item)
1566 return NULL;
1567
1568 if (!node) {
Nick Piggin612d6c12006-06-23 02:03:22 -07001569 root_tag_clear_all(root);
1570 root->rnode = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001571 return entry;
Nick Piggin612d6c12006-06-23 02:03:22 -07001572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Matthew Wilcox29e09672016-05-20 17:02:02 -07001574 offset = get_slot_offset(node, slot);
Johannes Weiner53c59f22014-04-03 14:47:39 -07001575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 /*
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001577 * Clear all tags associated with the item to be deleted.
1578 * This way of doing it would be inefficient, but seldom is any set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001580 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001581 if (tag_get(node, tag, offset))
Nick Piggin612d6c12006-06-23 02:03:22 -07001582 radix_tree_tag_clear(root, index, tag);
Nick Piggind5274262006-01-08 01:01:41 -08001583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Matthew Wilcox57578c22016-05-20 17:01:54 -07001585 delete_sibling_entries(node, ptr_to_indirect(slot), offset);
Johannes Weiner139e5612014-04-03 14:47:54 -07001586 node->slots[offset] = NULL;
1587 node->count--;
Nick Piggina5f51c92006-01-08 01:01:41 -08001588
Johannes Weiner449dd692014-04-03 14:47:56 -07001589 __radix_tree_delete_node(root, node);
Christoph Lameter201b6262005-09-06 15:16:46 -07001590
Johannes Weiner139e5612014-04-03 14:47:54 -07001591 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001593EXPORT_SYMBOL(radix_tree_delete_item);
1594
1595/**
1596 * radix_tree_delete - delete an item from a radix tree
1597 * @root: radix tree root
1598 * @index: index key
1599 *
1600 * Remove the item at @index from the radix tree rooted at @root.
1601 *
1602 * Returns the address of the deleted item, or NULL if it was not present.
1603 */
1604void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1605{
1606 return radix_tree_delete_item(root, index, NULL);
1607}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608EXPORT_SYMBOL(radix_tree_delete);
1609
1610/**
1611 * radix_tree_tagged - test whether any items in the tree are tagged
1612 * @root: radix tree root
1613 * @tag: tag to test
1614 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001615int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616{
Nick Piggin612d6c12006-06-23 02:03:22 -07001617 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618}
1619EXPORT_SYMBOL(radix_tree_tagged);
1620
1621static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001622radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623{
Johannes Weiner449dd692014-04-03 14:47:56 -07001624 struct radix_tree_node *node = arg;
1625
1626 memset(node, 0, sizeof(*node));
1627 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628}
1629
1630static __init unsigned long __maxindex(unsigned int height)
1631{
Peter Lund430d2752007-10-16 23:29:35 -07001632 unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1633 int shift = RADIX_TREE_INDEX_BITS - width;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Peter Lund430d2752007-10-16 23:29:35 -07001635 if (shift < 0)
1636 return ~0UL;
1637 if (shift >= BITS_PER_LONG)
1638 return 0UL;
1639 return ~0UL >> shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640}
1641
1642static __init void radix_tree_init_maxindex(void)
1643{
1644 unsigned int i;
1645
1646 for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1647 height_to_maxindex[i] = __maxindex(i);
1648}
1649
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650static int radix_tree_callback(struct notifier_block *nfb,
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001651 unsigned long action, void *hcpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001653 int cpu = (long)hcpu;
1654 struct radix_tree_preload *rtp;
1655 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001657 /* Free per-cpu pool of preloaded nodes */
1658 if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
1659 rtp = &per_cpu(radix_tree_preloads, cpu);
1660 while (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001661 node = rtp->nodes;
1662 rtp->nodes = node->private_data;
1663 kmem_cache_free(radix_tree_node_cachep, node);
1664 rtp->nr--;
Matthew Wilcox2fcd9002016-05-20 17:03:04 -07001665 }
1666 }
1667 return NOTIFY_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
1670void __init radix_tree_init(void)
1671{
1672 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1673 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001674 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1675 radix_tree_node_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 radix_tree_init_maxindex();
1677 hotcpu_notifier(radix_tree_callback, 0);
1678}