blob: 799f341977d05884464288df057fee70dde5e67c [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
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2, or (at
11 * your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23#include <linux/errno.h>
24#include <linux/init.h>
25#include <linux/kernel.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/radix-tree.h>
28#include <linux/percpu.h>
29#include <linux/slab.h>
Catalin Marinasce80b062014-06-06 14:38:18 -070030#include <linux/kmemleak.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/notifier.h>
32#include <linux/cpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/string.h>
34#include <linux/bitops.h>
Nick Piggin7cf9c2c2006-12-06 20:33:44 -080035#include <linux/rcupdate.h>
Frederic Weisbecker92cf2112015-05-12 16:41:46 +020036#include <linux/preempt.h> /* in_interrupt() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38
Jeff Moyer26fb1582007-10-16 01:24:49 -070039/*
40 * The height_to_maxindex array needs to be one deeper than the maximum
41 * path as height 0 holds only 1 entry.
42 */
43static unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1] __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45/*
46 * Radix tree node cache.
47 */
Christoph Lametere18b8902006-12-06 20:33:20 -080048static struct kmem_cache *radix_tree_node_cachep;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50/*
Nick Piggin55368052012-05-29 15:07:34 -070051 * The radix tree is variable-height, so an insert operation not only has
52 * to build the branch to its corresponding item, it also has to build the
53 * branch to existing items if the size has to be increased (by
54 * radix_tree_extend).
55 *
56 * The worst case is a zero height tree with just a single item at index 0,
57 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
58 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
59 * Hence:
60 */
61#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
62
63/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * Per-cpu pool of preloaded nodes
65 */
66struct radix_tree_preload {
67 int nr;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -070068 /* nodes->private_data points to next preallocated node */
69 struct radix_tree_node *nodes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070};
Harvey Harrison8cef7d52009-01-06 14:40:50 -080071static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Nick Piggin27d20fd2010-11-11 14:05:19 -080073static inline void *ptr_to_indirect(void *ptr)
74{
75 return (void *)((unsigned long)ptr | RADIX_TREE_INDIRECT_PTR);
76}
77
78static inline void *indirect_to_ptr(void *ptr)
79{
80 return (void *)((unsigned long)ptr & ~RADIX_TREE_INDIRECT_PTR);
81}
82
Nick Piggin612d6c12006-06-23 02:03:22 -070083static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
84{
85 return root->gfp_mask & __GFP_BITS_MASK;
86}
87
Nick Piggin643b52b2008-06-12 15:21:52 -070088static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
89 int offset)
90{
91 __set_bit(offset, node->tags[tag]);
92}
93
94static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
95 int offset)
96{
97 __clear_bit(offset, node->tags[tag]);
98}
99
100static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
101 int offset)
102{
103 return test_bit(offset, node->tags[tag]);
104}
105
106static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
107{
108 root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
109}
110
111static inline void root_tag_clear(struct radix_tree_root *root, unsigned int tag)
112{
113 root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
114}
115
116static inline void root_tag_clear_all(struct radix_tree_root *root)
117{
118 root->gfp_mask &= __GFP_BITS_MASK;
119}
120
121static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
122{
123 return (__force unsigned)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
124}
125
126/*
127 * Returns 1 if any slot in the node has this tag set.
128 * Otherwise returns 0.
129 */
130static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
131{
132 int idx;
133 for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
134 if (node->tags[tag][idx])
135 return 1;
136 }
137 return 0;
138}
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700139
140/**
141 * radix_tree_find_next_bit - find the next set bit in a memory region
142 *
143 * @addr: The address to base the search on
144 * @size: The bitmap size in bits
145 * @offset: The bitnumber to start searching at
146 *
147 * Unrollable variant of find_next_bit() for constant size arrays.
148 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
149 * Returns next bit offset, or size if nothing found.
150 */
151static __always_inline unsigned long
152radix_tree_find_next_bit(const unsigned long *addr,
153 unsigned long size, unsigned long offset)
154{
155 if (!__builtin_constant_p(size))
156 return find_next_bit(addr, size, offset);
157
158 if (offset < size) {
159 unsigned long tmp;
160
161 addr += offset / BITS_PER_LONG;
162 tmp = *addr >> (offset % BITS_PER_LONG);
163 if (tmp)
164 return __ffs(tmp) + offset;
165 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
166 while (offset < size) {
167 tmp = *++addr;
168 if (tmp)
169 return __ffs(tmp) + offset;
170 offset += BITS_PER_LONG;
171 }
172 }
173 return size;
174}
175
Matthew Wilcox7cf19af2016-03-17 14:21:57 -0700176#if 0
177static void dump_node(void *slot, int height, int offset)
178{
179 struct radix_tree_node *node;
180 int i;
181
182 if (!slot)
183 return;
184
185 if (height == 0) {
186 pr_debug("radix entry %p offset %d\n", slot, offset);
187 return;
188 }
189
190 node = indirect_to_ptr(slot);
191 pr_debug("radix node: %p offset %d tags %lx %lx %lx path %x count %d parent %p\n",
192 slot, offset, node->tags[0][0], node->tags[1][0],
193 node->tags[2][0], node->path, node->count, node->parent);
194
195 for (i = 0; i < RADIX_TREE_MAP_SIZE; i++)
196 dump_node(node->slots[i], height - 1, i);
197}
198
199/* For debug */
200static void radix_tree_dump(struct radix_tree_root *root)
201{
202 pr_debug("radix root: %p height %d rnode %p tags %x\n",
203 root, root->height, root->rnode,
204 root->gfp_mask >> __GFP_BITS_SHIFT);
205 if (!radix_tree_is_indirect_ptr(root->rnode))
206 return;
207 dump_node(root->rnode, root->height, 0);
208}
209#endif
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/*
212 * This assumes that the caller has performed appropriate preallocation, and
213 * that the caller has pinned this thread of control to the current CPU.
214 */
215static struct radix_tree_node *
216radix_tree_node_alloc(struct radix_tree_root *root)
217{
Nick Piggine2848a02008-02-04 22:29:10 -0800218 struct radix_tree_node *ret = NULL;
Nick Piggin612d6c12006-06-23 02:03:22 -0700219 gfp_t gfp_mask = root_gfp_mask(root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Jan Kara5e4c0d972013-09-11 14:26:05 -0700221 /*
222 * Preload code isn't irq safe and it doesn't make sence to use
223 * preloading in the interrupt anyway as all the allocations have to
224 * be atomic. So just do normal allocation when in interrupt.
225 */
Mel Gormand0164ad2015-11-06 16:28:21 -0800226 if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 struct radix_tree_preload *rtp;
228
Nick Piggine2848a02008-02-04 22:29:10 -0800229 /*
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700230 * Even if the caller has preloaded, try to allocate from the
231 * cache first for the new node to get accounted.
232 */
233 ret = kmem_cache_alloc(radix_tree_node_cachep,
234 gfp_mask | __GFP_ACCOUNT | __GFP_NOWARN);
235 if (ret)
236 goto out;
237
238 /*
Nick Piggine2848a02008-02-04 22:29:10 -0800239 * Provided the caller has preloaded here, we will always
240 * succeed in getting a node here (and never reach
241 * kmem_cache_alloc)
242 */
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700243 rtp = this_cpu_ptr(&radix_tree_preloads);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 if (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700245 ret = rtp->nodes;
246 rtp->nodes = ret->private_data;
247 ret->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 rtp->nr--;
249 }
Catalin Marinasce80b062014-06-06 14:38:18 -0700250 /*
251 * Update the allocation stack trace as this is more useful
252 * for debugging.
253 */
254 kmemleak_update_trace(ret);
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700255 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 }
Vladimir Davydov58e698a2016-03-17 14:18:36 -0700257 ret = kmem_cache_alloc(radix_tree_node_cachep,
258 gfp_mask | __GFP_ACCOUNT);
259out:
Nick Pigginc0bc9872007-10-16 01:24:42 -0700260 BUG_ON(radix_tree_is_indirect_ptr(ret));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 return ret;
262}
263
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800264static void radix_tree_node_rcu_free(struct rcu_head *head)
265{
266 struct radix_tree_node *node =
267 container_of(head, struct radix_tree_node, rcu_head);
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000268 int i;
Nick Piggin643b52b2008-06-12 15:21:52 -0700269
270 /*
271 * must only free zeroed nodes into the slab. radix_tree_shrink
272 * can leave us with a non-NULL entry in the first slot, so clear
273 * that here to make sure.
274 */
Dave Chinnerb6dd0862010-08-23 10:33:19 +1000275 for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
276 tag_clear(node, i, 0);
277
Nick Piggin643b52b2008-06-12 15:21:52 -0700278 node->slots[0] = NULL;
279 node->count = 0;
280
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800281 kmem_cache_free(radix_tree_node_cachep, node);
282}
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284static inline void
285radix_tree_node_free(struct radix_tree_node *node)
286{
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800287 call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
289
290/*
291 * Load up this CPU's radix_tree_node buffer with sufficient objects to
292 * ensure that the addition of a single element in the tree cannot fail. On
293 * success, return zero, with preemption disabled. On error, return -ENOMEM
294 * with preemption not disabled.
David Howellsb34df792009-11-19 18:11:14 +0000295 *
296 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800297 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 */
Jan Kara5e4c0d972013-09-11 14:26:05 -0700299static int __radix_tree_preload(gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
301 struct radix_tree_preload *rtp;
302 struct radix_tree_node *node;
303 int ret = -ENOMEM;
304
305 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700306 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700307 while (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 preempt_enable();
Christoph Lameter488514d2008-04-28 02:12:05 -0700309 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 if (node == NULL)
311 goto out;
312 preempt_disable();
Christoph Lameter7c8e0182014-06-04 16:07:56 -0700313 rtp = this_cpu_ptr(&radix_tree_preloads);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700314 if (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
315 node->private_data = rtp->nodes;
316 rtp->nodes = node;
317 rtp->nr++;
318 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 kmem_cache_free(radix_tree_node_cachep, node);
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -0700320 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 }
322 ret = 0;
323out:
324 return ret;
325}
Jan Kara5e4c0d972013-09-11 14:26:05 -0700326
327/*
328 * Load up this CPU's radix_tree_node buffer with sufficient objects to
329 * ensure that the addition of a single element in the tree cannot fail. On
330 * success, return zero, with preemption disabled. On error, return -ENOMEM
331 * with preemption not disabled.
332 *
333 * To make use of this facility, the radix tree must be initialised without
Mel Gormand0164ad2015-11-06 16:28:21 -0800334 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
Jan Kara5e4c0d972013-09-11 14:26:05 -0700335 */
336int radix_tree_preload(gfp_t gfp_mask)
337{
338 /* Warn on non-sensical use... */
Mel Gormand0164ad2015-11-06 16:28:21 -0800339 WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
Jan Kara5e4c0d972013-09-11 14:26:05 -0700340 return __radix_tree_preload(gfp_mask);
341}
David Chinnerd7f09232007-07-14 16:05:04 +1000342EXPORT_SYMBOL(radix_tree_preload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Nick Piggin6e954b92006-01-08 01:01:40 -0800344/*
Jan Kara5e4c0d972013-09-11 14:26:05 -0700345 * The same as above function, except we don't guarantee preloading happens.
346 * We do it, if we decide it helps. On success, return zero with preemption
347 * disabled. On error, return -ENOMEM with preemption not disabled.
348 */
349int radix_tree_maybe_preload(gfp_t gfp_mask)
350{
Mel Gormand0164ad2015-11-06 16:28:21 -0800351 if (gfpflags_allow_blocking(gfp_mask))
Jan Kara5e4c0d972013-09-11 14:26:05 -0700352 return __radix_tree_preload(gfp_mask);
353 /* Preloading doesn't help anything with this gfp mask, skip it */
354 preempt_disable();
355 return 0;
356}
357EXPORT_SYMBOL(radix_tree_maybe_preload);
358
359/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 * Return the maximum key which can be store into a
361 * radix tree with height HEIGHT.
362 */
363static inline unsigned long radix_tree_maxindex(unsigned int height)
364{
365 return height_to_maxindex[height];
366}
367
368/*
369 * Extend a radix tree so it can store key @index.
370 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700371static int radix_tree_extend(struct radix_tree_root *root,
372 unsigned long index, unsigned order)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
374 struct radix_tree_node *node;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800375 struct radix_tree_node *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 unsigned int height;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 int tag;
378
379 /* Figure out what the height should be. */
380 height = root->height + 1;
381 while (index > radix_tree_maxindex(height))
382 height++;
383
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700384 if ((root->rnode == NULL) && (order == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 root->height = height;
386 goto out;
387 }
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 do {
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800390 unsigned int newheight;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 if (!(node = radix_tree_node_alloc(root)))
392 return -ENOMEM;
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 /* Propagate the aggregated tag info into the new root */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800395 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Nick Piggin612d6c12006-06-23 02:03:22 -0700396 if (root_tag_get(root, tag))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 tag_set(node, tag, 0);
398 }
399
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800400 /* Increase the height. */
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800401 newheight = root->height+1;
Johannes Weiner449dd692014-04-03 14:47:56 -0700402 BUG_ON(newheight & ~RADIX_TREE_HEIGHT_MASK);
403 node->path = newheight;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 node->count = 1;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800405 node->parent = NULL;
406 slot = root->rnode;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700407 if (radix_tree_is_indirect_ptr(slot) && newheight > 1) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800408 slot = indirect_to_ptr(slot);
409 slot->parent = node;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700410 slot = ptr_to_indirect(slot);
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800411 }
412 node->slots[0] = slot;
Nick Piggin27d20fd2010-11-11 14:05:19 -0800413 node = ptr_to_indirect(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800414 rcu_assign_pointer(root->rnode, node);
415 root->height = newheight;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 } while (height > root->height);
417out:
418 return 0;
419}
420
421/**
Johannes Weiner139e5612014-04-03 14:47:54 -0700422 * __radix_tree_create - create a slot in a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 * @root: radix tree root
424 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700425 * @order: index occupies 2^order aligned slots
Johannes Weiner139e5612014-04-03 14:47:54 -0700426 * @nodep: returns node
427 * @slotp: returns slot
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 *
Johannes Weiner139e5612014-04-03 14:47:54 -0700429 * Create, if necessary, and return the node and slot for an item
430 * at position @index in the radix tree @root.
431 *
432 * Until there is more than one item in the tree, no nodes are
433 * allocated and @root->rnode is used as a direct slot instead of
434 * pointing to a node, in which case *@nodep will be NULL.
435 *
436 * Returns -ENOMEM, or 0 for success.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700438int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700439 unsigned order, struct radix_tree_node **nodep,
440 void ***slotp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
Christoph Lameter201b6262005-09-06 15:16:46 -0700442 struct radix_tree_node *node = NULL, *slot;
Johannes Weiner139e5612014-04-03 14:47:54 -0700443 unsigned int height, shift, offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 int error;
445
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700446 BUG_ON((0 < order) && (order < RADIX_TREE_MAP_SHIFT));
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 /* Make sure the tree is high enough. */
Nick Piggin612d6c12006-06-23 02:03:22 -0700449 if (index > radix_tree_maxindex(root->height)) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700450 error = radix_tree_extend(root, index, order);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 if (error)
452 return error;
453 }
454
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700455 slot = root->rnode;
Nick Pigginc0bc9872007-10-16 01:24:42 -0700456
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 height = root->height;
Matthew Wilcox0070e282016-03-17 14:21:51 -0700458 shift = height * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460 offset = 0; /* uninitialised var warning */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700461 while (shift > order) {
Christoph Lameter201b6262005-09-06 15:16:46 -0700462 if (slot == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 /* Have to add a child node. */
Christoph Lameter201b6262005-09-06 15:16:46 -0700464 if (!(slot = radix_tree_node_alloc(root)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return -ENOMEM;
Johannes Weiner449dd692014-04-03 14:47:56 -0700466 slot->path = height;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800467 slot->parent = node;
Christoph Lameter201b6262005-09-06 15:16:46 -0700468 if (node) {
Matthew Wilcox339e6352016-03-17 14:21:48 -0700469 rcu_assign_pointer(node->slots[offset],
470 ptr_to_indirect(slot));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 node->count++;
Johannes Weiner449dd692014-04-03 14:47:56 -0700472 slot->path |= offset << RADIX_TREE_HEIGHT_SHIFT;
Christoph Lameter201b6262005-09-06 15:16:46 -0700473 } else
Matthew Wilcox339e6352016-03-17 14:21:48 -0700474 rcu_assign_pointer(root->rnode,
475 ptr_to_indirect(slot));
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700476 } else if (!radix_tree_is_indirect_ptr(slot))
477 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479 /* Go a level down */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700480 height--;
Matthew Wilcox0070e282016-03-17 14:21:51 -0700481 shift -= RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700483 node = indirect_to_ptr(slot);
Christoph Lameter201b6262005-09-06 15:16:46 -0700484 slot = node->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700485 }
486
Matthew Wilcox57578c22016-05-20 17:01:54 -0700487#ifdef CONFIG_RADIX_TREE_MULTIORDER
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700488 /* Insert pointers to the canonical entry */
489 if ((shift - order) > 0) {
490 int i, n = 1 << (shift - order);
491 offset = offset & ~(n - 1);
492 slot = ptr_to_indirect(&node->slots[offset]);
493 for (i = 0; i < n; i++) {
494 if (node->slots[offset + i])
495 return -EEXIST;
496 }
497
498 for (i = 1; i < n; i++) {
499 rcu_assign_pointer(node->slots[offset + i], slot);
500 node->count++;
501 }
Nick Piggin612d6c12006-06-23 02:03:22 -0700502 }
Matthew Wilcox57578c22016-05-20 17:01:54 -0700503#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Johannes Weiner139e5612014-04-03 14:47:54 -0700505 if (nodep)
506 *nodep = node;
507 if (slotp)
508 *slotp = node ? node->slots + offset : (void **)&root->rnode;
509 return 0;
510}
511
512/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700513 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700514 * @root: radix tree root
515 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700516 * @order: key covers the 2^order indices around index
Johannes Weiner139e5612014-04-03 14:47:54 -0700517 * @item: item to insert
518 *
519 * Insert an item into the radix tree at position @index.
520 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700521int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
522 unsigned order, void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700523{
524 struct radix_tree_node *node;
525 void **slot;
526 int error;
527
528 BUG_ON(radix_tree_is_indirect_ptr(item));
529
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700530 error = __radix_tree_create(root, index, order, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700531 if (error)
532 return error;
533 if (*slot != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 return -EEXIST;
Johannes Weiner139e5612014-04-03 14:47:54 -0700535 rcu_assign_pointer(*slot, item);
Christoph Lameter201b6262005-09-06 15:16:46 -0700536
Nick Piggin612d6c12006-06-23 02:03:22 -0700537 if (node) {
538 node->count++;
Johannes Weiner139e5612014-04-03 14:47:54 -0700539 BUG_ON(tag_get(node, 0, index & RADIX_TREE_MAP_MASK));
540 BUG_ON(tag_get(node, 1, index & RADIX_TREE_MAP_MASK));
Nick Piggin612d6c12006-06-23 02:03:22 -0700541 } else {
Nick Piggin612d6c12006-06-23 02:03:22 -0700542 BUG_ON(root_tag_get(root, 0));
543 BUG_ON(root_tag_get(root, 1));
544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 return 0;
547}
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700548EXPORT_SYMBOL(__radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Johannes Weiner139e5612014-04-03 14:47:54 -0700550/**
551 * __radix_tree_lookup - lookup an item in a radix tree
552 * @root: radix tree root
553 * @index: index key
554 * @nodep: returns node
555 * @slotp: returns slot
556 *
557 * Lookup and return the item at position @index in the radix
558 * tree @root.
559 *
560 * Until there is more than one item in the tree, no nodes are
561 * allocated and @root->rnode is used as a direct slot instead of
562 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800563 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700564void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
565 struct radix_tree_node **nodep, void ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800566{
Johannes Weiner139e5612014-04-03 14:47:54 -0700567 struct radix_tree_node *node, *parent;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800568 unsigned int height, shift;
Johannes Weiner139e5612014-04-03 14:47:54 -0700569 void **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800570
Paul E. McKenney2676a582010-02-22 17:04:54 -0800571 node = rcu_dereference_raw(root->rnode);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800572 if (node == NULL)
573 return NULL;
574
Nick Pigginc0bc9872007-10-16 01:24:42 -0700575 if (!radix_tree_is_indirect_ptr(node)) {
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800576 if (index > 0)
577 return NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -0700578
579 if (nodep)
580 *nodep = NULL;
581 if (slotp)
582 *slotp = (void **)&root->rnode;
583 return node;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800584 }
Nick Piggin27d20fd2010-11-11 14:05:19 -0800585 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800586
Johannes Weiner449dd692014-04-03 14:47:56 -0700587 height = node->path & RADIX_TREE_HEIGHT_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800588 if (index > radix_tree_maxindex(height))
589 return NULL;
590
591 shift = (height-1) * RADIX_TREE_MAP_SHIFT;
592
593 do {
Johannes Weiner139e5612014-04-03 14:47:54 -0700594 parent = node;
595 slot = node->slots + ((index >> shift) & RADIX_TREE_MAP_MASK);
Paul E. McKenney2676a582010-02-22 17:04:54 -0800596 node = rcu_dereference_raw(*slot);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800597 if (node == NULL)
598 return NULL;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700599 if (!radix_tree_is_indirect_ptr(node))
600 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700601 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800602
603 shift -= RADIX_TREE_MAP_SHIFT;
604 height--;
605 } while (height > 0);
606
Johannes Weiner139e5612014-04-03 14:47:54 -0700607 if (nodep)
608 *nodep = parent;
609 if (slotp)
610 *slotp = slot;
611 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700612}
613
614/**
615 * radix_tree_lookup_slot - lookup a slot in a radix tree
616 * @root: radix tree root
617 * @index: index key
618 *
619 * Returns: the slot corresponding to the position @index in the
620 * radix tree @root. This is useful for update-if-exists operations.
621 *
622 * This function can be called under rcu_read_lock iff the slot is not
623 * modified by radix_tree_replace_slot, otherwise it must be called
624 * exclusive from other writers. Any dereference of the slot must be done
625 * using radix_tree_deref_slot.
626 */
627void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
628{
Johannes Weiner139e5612014-04-03 14:47:54 -0700629 void **slot;
630
631 if (!__radix_tree_lookup(root, index, NULL, &slot))
632 return NULL;
633 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800634}
635EXPORT_SYMBOL(radix_tree_lookup_slot);
636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637/**
638 * radix_tree_lookup - perform lookup operation on a radix tree
639 * @root: radix tree root
640 * @index: index key
641 *
642 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800643 *
644 * This function can be called under rcu_read_lock, however the caller
645 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
646 * them safely). No RCU barriers are required to access or modify the
647 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 */
649void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
650{
Johannes Weiner139e5612014-04-03 14:47:54 -0700651 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653EXPORT_SYMBOL(radix_tree_lookup);
654
655/**
656 * radix_tree_tag_set - set a tag on a radix tree node
657 * @root: radix tree root
658 * @index: index key
659 * @tag: tag index
660 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800661 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
662 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 * the root all the way down to the leaf node.
664 *
665 * Returns the address of the tagged item. Setting a tag on a not-present
666 * item is a bug.
667 */
668void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800669 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670{
671 unsigned int height, shift;
Christoph Lameter201b6262005-09-06 15:16:46 -0700672 struct radix_tree_node *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
674 height = root->height;
Peter Zijlstra4c91c362006-06-23 02:03:25 -0700675 BUG_ON(index > radix_tree_maxindex(height));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Nick Piggin27d20fd2010-11-11 14:05:19 -0800677 slot = indirect_to_ptr(root->rnode);
Nick Piggin612d6c12006-06-23 02:03:22 -0700678 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680 while (height > 0) {
681 int offset;
682
683 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Nick Piggind5274262006-01-08 01:01:41 -0800684 if (!tag_get(slot, tag, offset))
685 tag_set(slot, tag, offset);
Christoph Lameter201b6262005-09-06 15:16:46 -0700686 slot = slot->slots[offset];
687 BUG_ON(slot == NULL);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700688 if (!radix_tree_is_indirect_ptr(slot))
689 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700690 slot = indirect_to_ptr(slot);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 shift -= RADIX_TREE_MAP_SHIFT;
692 height--;
693 }
694
Nick Piggin612d6c12006-06-23 02:03:22 -0700695 /* set the root's tag bit */
696 if (slot && !root_tag_get(root, tag))
697 root_tag_set(root, tag);
698
Christoph Lameter201b6262005-09-06 15:16:46 -0700699 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701EXPORT_SYMBOL(radix_tree_tag_set);
702
703/**
704 * radix_tree_tag_clear - clear a tag on a radix tree node
705 * @root: radix tree root
706 * @index: index key
707 * @tag: tag index
708 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800709 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
710 * corresponding to @index in the radix tree. If
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 * this causes the leaf node to have no tags set then clear the tag in the
712 * next-to-leaf node, etc.
713 *
714 * Returns the address of the tagged item on success, else NULL. ie:
715 * has the same return value and semantics as radix_tree_lookup().
716 */
717void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800718 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719{
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800720 struct radix_tree_node *node = NULL;
Nick Piggin612d6c12006-06-23 02:03:22 -0700721 struct radix_tree_node *slot = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 unsigned int height, shift;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800723 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
725 height = root->height;
726 if (index > radix_tree_maxindex(height))
727 goto out;
728
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800729 shift = height * RADIX_TREE_MAP_SHIFT;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700730 slot = root->rnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800732 while (shift) {
Christoph Lameter201b6262005-09-06 15:16:46 -0700733 if (slot == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 goto out;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700735 if (!radix_tree_is_indirect_ptr(slot))
736 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700737 slot = indirect_to_ptr(slot);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800740 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
741 node = slot;
742 slot = slot->slots[offset];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 }
744
Nick Piggin612d6c12006-06-23 02:03:22 -0700745 if (slot == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 goto out;
747
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800748 while (node) {
749 if (!tag_get(node, tag, offset))
Nick Piggind5274262006-01-08 01:01:41 -0800750 goto out;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800751 tag_clear(node, tag, offset);
752 if (any_tag_set(node, tag))
Nick Piggin6e954b92006-01-08 01:01:40 -0800753 goto out;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800754
755 index >>= RADIX_TREE_MAP_SHIFT;
756 offset = index & RADIX_TREE_MAP_MASK;
757 node = node->parent;
Nick Piggin612d6c12006-06-23 02:03:22 -0700758 }
759
760 /* clear the root's tag bit */
761 if (root_tag_get(root, tag))
762 root_tag_clear(root, tag);
763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764out:
Nick Piggin612d6c12006-06-23 02:03:22 -0700765 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766}
767EXPORT_SYMBOL(radix_tree_tag_clear);
768
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700770 * radix_tree_tag_get - get a tag on a radix tree node
771 * @root: radix tree root
772 * @index: index key
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800773 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700775 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 *
Nick Piggin612d6c12006-06-23 02:03:22 -0700777 * 0: tag not present or not set
778 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +0100779 *
780 * Note that the return value of this function may not be relied on, even if
781 * the RCU lock is held, unless tag modification and node deletion are excluded
782 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 */
784int radix_tree_tag_get(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800785 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
787 unsigned int height, shift;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800788 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Nick Piggin612d6c12006-06-23 02:03:22 -0700790 /* check the root's tag bit */
791 if (!root_tag_get(root, tag))
792 return 0;
793
Paul E. McKenney2676a582010-02-22 17:04:54 -0800794 node = rcu_dereference_raw(root->rnode);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800795 if (node == NULL)
796 return 0;
797
Nick Pigginc0bc9872007-10-16 01:24:42 -0700798 if (!radix_tree_is_indirect_ptr(node))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800799 return (index == 0);
Nick Piggin27d20fd2010-11-11 14:05:19 -0800800 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800801
Johannes Weiner449dd692014-04-03 14:47:56 -0700802 height = node->path & RADIX_TREE_HEIGHT_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800803 if (index > radix_tree_maxindex(height))
804 return 0;
Nick Piggin612d6c12006-06-23 02:03:22 -0700805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
808 for ( ; ; ) {
809 int offset;
810
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800811 if (node == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return 0;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700813 node = indirect_to_ptr(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
815 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800816 if (!tag_get(node, tag, offset))
Hugh Dickins3fa36ac2011-10-31 17:07:02 -0700817 return 0;
David Howellsce826532010-04-06 22:36:20 +0100818 if (height == 1)
Hugh Dickins3fa36ac2011-10-31 17:07:02 -0700819 return 1;
Paul E. McKenney2676a582010-02-22 17:04:54 -0800820 node = rcu_dereference_raw(node->slots[offset]);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700821 if (!radix_tree_is_indirect_ptr(node))
822 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 shift -= RADIX_TREE_MAP_SHIFT;
824 height--;
825 }
826}
827EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Fengguang Wu6df8ba42007-10-16 01:24:33 -0700829/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700830 * radix_tree_next_chunk - find next chunk of slots for iteration
831 *
832 * @root: radix tree root
833 * @iter: iterator state
834 * @flags: RADIX_TREE_ITER_* flags and tag index
835 * Returns: pointer to chunk first slot, or NULL if iteration is over
836 */
837void **radix_tree_next_chunk(struct radix_tree_root *root,
838 struct radix_tree_iter *iter, unsigned flags)
839{
840 unsigned shift, tag = flags & RADIX_TREE_ITER_TAG_MASK;
841 struct radix_tree_node *rnode, *node;
Johannes Weiner449dd692014-04-03 14:47:56 -0700842 unsigned long index, offset, height;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700843
844 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
845 return NULL;
846
847 /*
848 * Catch next_index overflow after ~0UL. iter->index never overflows
849 * during iterating; it can be zero only at the beginning.
850 * And we cannot overflow iter->next_index in a single step,
851 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +0400852 *
853 * This condition also used by radix_tree_next_slot() to stop
854 * contiguous iterating, and forbid swithing to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700855 */
856 index = iter->next_index;
857 if (!index && iter->index)
858 return NULL;
859
860 rnode = rcu_dereference_raw(root->rnode);
861 if (radix_tree_is_indirect_ptr(rnode)) {
862 rnode = indirect_to_ptr(rnode);
863 } else if (rnode && !index) {
864 /* Single-slot tree */
865 iter->index = 0;
866 iter->next_index = 1;
867 iter->tags = 1;
868 return (void **)&root->rnode;
869 } else
870 return NULL;
871
872restart:
Johannes Weiner449dd692014-04-03 14:47:56 -0700873 height = rnode->path & RADIX_TREE_HEIGHT_MASK;
874 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700875 offset = index >> shift;
876
877 /* Index outside of the tree */
878 if (offset >= RADIX_TREE_MAP_SIZE)
879 return NULL;
880
881 node = rnode;
882 while (1) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700883 struct radix_tree_node *slot;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700884 if ((flags & RADIX_TREE_ITER_TAGGED) ?
885 !test_bit(offset, node->tags[tag]) :
886 !node->slots[offset]) {
887 /* Hole detected */
888 if (flags & RADIX_TREE_ITER_CONTIG)
889 return NULL;
890
891 if (flags & RADIX_TREE_ITER_TAGGED)
892 offset = radix_tree_find_next_bit(
893 node->tags[tag],
894 RADIX_TREE_MAP_SIZE,
895 offset + 1);
896 else
897 while (++offset < RADIX_TREE_MAP_SIZE) {
898 if (node->slots[offset])
899 break;
900 }
901 index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
902 index += offset << shift;
903 /* Overflow after ~0UL */
904 if (!index)
905 return NULL;
906 if (offset == RADIX_TREE_MAP_SIZE)
907 goto restart;
908 }
909
910 /* This is leaf-node */
911 if (!shift)
912 break;
913
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700914 slot = rcu_dereference_raw(node->slots[offset]);
915 if (slot == NULL)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700916 goto restart;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700917 if (!radix_tree_is_indirect_ptr(slot))
918 break;
919 node = indirect_to_ptr(slot);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700920 shift -= RADIX_TREE_MAP_SHIFT;
921 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
922 }
923
924 /* Update the iterator state */
925 iter->index = index;
926 iter->next_index = (index | RADIX_TREE_MAP_MASK) + 1;
927
928 /* Construct iter->tags bit-mask from node->tags[tag] array */
929 if (flags & RADIX_TREE_ITER_TAGGED) {
930 unsigned tag_long, tag_bit;
931
932 tag_long = offset / BITS_PER_LONG;
933 tag_bit = offset % BITS_PER_LONG;
934 iter->tags = node->tags[tag][tag_long] >> tag_bit;
935 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
936 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
937 /* Pick tags from next element */
938 if (tag_bit)
939 iter->tags |= node->tags[tag][tag_long + 1] <<
940 (BITS_PER_LONG - tag_bit);
941 /* Clip chunk size, here only BITS_PER_LONG tags */
942 iter->next_index = index + BITS_PER_LONG;
943 }
944 }
945
946 return node->slots + offset;
947}
948EXPORT_SYMBOL(radix_tree_next_chunk);
949
950/**
Jan Karaebf8aa42010-08-09 17:19:11 -0700951 * radix_tree_range_tag_if_tagged - for each item in given range set given
952 * tag if item has another tag set
953 * @root: radix tree root
954 * @first_indexp: pointer to a starting index of a range to scan
955 * @last_index: last index of a range to scan
956 * @nr_to_tag: maximum number items to tag
957 * @iftag: tag index to test
958 * @settag: tag index to set if tested tag is set
959 *
960 * This function scans range of radix tree from first_index to last_index
961 * (inclusive). For each item in the range if iftag is set, the function sets
962 * also settag. The function stops either after tagging nr_to_tag items or
963 * after reaching last_index.
964 *
Dave Chinner144dcfc2010-08-23 10:33:53 +1000965 * The tags must be set from the leaf level only and propagated back up the
966 * path to the root. We must do this so that we resolve the full path before
967 * setting any tags on intermediate nodes. If we set tags as we descend, then
968 * we can get to the leaf node and find that the index that has the iftag
969 * set is outside the range we are scanning. This reults in dangling tags and
970 * can lead to problems with later tag operations (e.g. livelocks on lookups).
971 *
Jan Karaebf8aa42010-08-09 17:19:11 -0700972 * The function returns number of leaves where the tag was set and sets
973 * *first_indexp to the first unscanned index.
Jan Karad5ed3a42010-08-19 14:13:33 -0700974 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
975 * be prepared to handle that.
Jan Karaebf8aa42010-08-09 17:19:11 -0700976 */
977unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
978 unsigned long *first_indexp, unsigned long last_index,
979 unsigned long nr_to_tag,
980 unsigned int iftag, unsigned int settag)
981{
Dave Chinner144dcfc2010-08-23 10:33:53 +1000982 unsigned int height = root->height;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800983 struct radix_tree_node *node = NULL;
Dave Chinner144dcfc2010-08-23 10:33:53 +1000984 struct radix_tree_node *slot;
985 unsigned int shift;
986 unsigned long tagged = 0;
987 unsigned long index = *first_indexp;
Jan Karaebf8aa42010-08-09 17:19:11 -0700988
989 last_index = min(last_index, radix_tree_maxindex(height));
990 if (index > last_index)
991 return 0;
992 if (!nr_to_tag)
993 return 0;
994 if (!root_tag_get(root, iftag)) {
995 *first_indexp = last_index + 1;
996 return 0;
997 }
998 if (height == 0) {
999 *first_indexp = last_index + 1;
1000 root_tag_set(root, settag);
1001 return 1;
1002 }
1003
1004 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001005 slot = indirect_to_ptr(root->rnode);
Jan Karaebf8aa42010-08-09 17:19:11 -07001006
1007 for (;;) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001008 unsigned long upindex;
Jan Karaebf8aa42010-08-09 17:19:11 -07001009 int offset;
1010
1011 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1012 if (!slot->slots[offset])
1013 goto next;
1014 if (!tag_get(slot, iftag, offset))
1015 goto next;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001016 if (shift) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001017 node = slot;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001018 slot = slot->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001019 if (radix_tree_is_indirect_ptr(slot)) {
1020 slot = indirect_to_ptr(slot);
1021 shift -= RADIX_TREE_MAP_SHIFT;
1022 continue;
1023 } else {
1024 slot = node;
1025 node = node->parent;
1026 }
Jan Karaebf8aa42010-08-09 17:19:11 -07001027 }
Dave Chinner144dcfc2010-08-23 10:33:53 +10001028
1029 /* tag the leaf */
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001030 tagged += 1 << shift;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001031 tag_set(slot, settag, offset);
1032
1033 /* walk back up the path tagging interior nodes */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001034 upindex = index;
1035 while (node) {
1036 upindex >>= RADIX_TREE_MAP_SHIFT;
1037 offset = upindex & RADIX_TREE_MAP_MASK;
1038
Dave Chinner144dcfc2010-08-23 10:33:53 +10001039 /* stop if we find a node with the tag already set */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001040 if (tag_get(node, settag, offset))
Dave Chinner144dcfc2010-08-23 10:33:53 +10001041 break;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001042 tag_set(node, settag, offset);
1043 node = node->parent;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001044 }
1045
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001046 /*
1047 * Small optimization: now clear that node pointer.
1048 * Since all of this slot's ancestors now have the tag set
1049 * from setting it above, we have no further need to walk
1050 * back up the tree setting tags, until we update slot to
1051 * point to another radix_tree_node.
1052 */
1053 node = NULL;
1054
Jan Karaebf8aa42010-08-09 17:19:11 -07001055next:
1056 /* Go to next item at level determined by 'shift' */
1057 index = ((index >> shift) + 1) << shift;
Jan Karad5ed3a42010-08-19 14:13:33 -07001058 /* Overflow can happen when last_index is ~0UL... */
1059 if (index > last_index || !index)
Jan Karaebf8aa42010-08-09 17:19:11 -07001060 break;
1061 if (tagged >= nr_to_tag)
1062 break;
1063 while (((index >> shift) & RADIX_TREE_MAP_MASK) == 0) {
1064 /*
1065 * We've fully scanned this node. Go up. Because
1066 * last_index is guaranteed to be in the tree, what
1067 * we do below cannot wander astray.
1068 */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001069 slot = slot->parent;
Jan Karaebf8aa42010-08-09 17:19:11 -07001070 shift += RADIX_TREE_MAP_SHIFT;
1071 }
1072 }
1073 /*
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001074 * We need not to tag the root tag if there is no tag which is set with
1075 * settag within the range from *first_indexp to last_index.
Jan Karaebf8aa42010-08-09 17:19:11 -07001076 */
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001077 if (tagged > 0)
1078 root_tag_set(root, settag);
Jan Karaebf8aa42010-08-09 17:19:11 -07001079 *first_indexp = index;
1080
1081 return tagged;
1082}
1083EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1084
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085/**
1086 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1087 * @root: radix tree root
1088 * @results: where the results of the lookup are placed
1089 * @first_index: start the lookup from this key
1090 * @max_items: place up to this many items at *results
1091 *
1092 * Performs an index-ascending scan of the tree for present items. Places
1093 * them at *@results and returns the number of items which were placed at
1094 * *@results.
1095 *
1096 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001097 *
1098 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1099 * rcu_read_lock. In this case, rather than the returned results being
1100 * an atomic snapshot of the tree at a single point in time, the semantics
1101 * of an RCU protected gang lookup are as though multiple radix_tree_lookups
1102 * have been issued in individual locks, and results stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 */
1104unsigned int
1105radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1106 unsigned long first_index, unsigned int max_items)
1107{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001108 struct radix_tree_iter iter;
1109 void **slot;
1110 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001112 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001113 return 0;
1114
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001115 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001116 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001117 if (!results[ret])
1118 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001119 if (radix_tree_is_indirect_ptr(results[ret])) {
1120 slot = radix_tree_iter_retry(&iter);
1121 continue;
1122 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001123 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001126
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 return ret;
1128}
1129EXPORT_SYMBOL(radix_tree_gang_lookup);
1130
Nick Piggin47feff22008-07-25 19:45:29 -07001131/**
1132 * radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1133 * @root: radix tree root
1134 * @results: where the results of the lookup are placed
Hugh Dickins63286502011-08-03 16:21:18 -07001135 * @indices: where their indices should be placed (but usually NULL)
Nick Piggin47feff22008-07-25 19:45:29 -07001136 * @first_index: start the lookup from this key
1137 * @max_items: place up to this many items at *results
1138 *
1139 * Performs an index-ascending scan of the tree for present items. Places
1140 * their slots at *@results and returns the number of items which were
1141 * placed at *@results.
1142 *
1143 * The implementation is naive.
1144 *
1145 * Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1146 * be dereferenced with radix_tree_deref_slot, and if using only RCU
1147 * protection, radix_tree_deref_slot may fail requiring a retry.
1148 */
1149unsigned int
Hugh Dickins63286502011-08-03 16:21:18 -07001150radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1151 void ***results, unsigned long *indices,
Nick Piggin47feff22008-07-25 19:45:29 -07001152 unsigned long first_index, unsigned int max_items)
1153{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001154 struct radix_tree_iter iter;
1155 void **slot;
1156 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001157
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001158 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001159 return 0;
1160
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001161 radix_tree_for_each_slot(slot, root, &iter, first_index) {
1162 results[ret] = slot;
Hugh Dickins63286502011-08-03 16:21:18 -07001163 if (indices)
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001164 indices[ret] = iter.index;
1165 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001166 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001167 }
1168
1169 return ret;
1170}
1171EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173/**
1174 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1175 * based on a tag
1176 * @root: radix tree root
1177 * @results: where the results of the lookup are placed
1178 * @first_index: start the lookup from this key
1179 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001180 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 *
1182 * Performs an index-ascending scan of the tree for present items which
1183 * have the tag indexed by @tag set. Places the items at *@results and
1184 * returns the number of items which were placed at *@results.
1185 */
1186unsigned int
1187radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001188 unsigned long first_index, unsigned int max_items,
1189 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001191 struct radix_tree_iter iter;
1192 void **slot;
1193 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001195 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001196 return 0;
1197
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001198 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001199 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001200 if (!results[ret])
1201 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001202 if (radix_tree_is_indirect_ptr(results[ret])) {
1203 slot = radix_tree_iter_retry(&iter);
1204 continue;
1205 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001206 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 return ret;
1211}
1212EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1213
1214/**
Nick Piggin47feff22008-07-25 19:45:29 -07001215 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1216 * radix tree based on a tag
1217 * @root: radix tree root
1218 * @results: where the results of the lookup are placed
1219 * @first_index: start the lookup from this key
1220 * @max_items: place up to this many items at *results
1221 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1222 *
1223 * Performs an index-ascending scan of the tree for present items which
1224 * have the tag indexed by @tag set. Places the slots at *@results and
1225 * returns the number of slots which were placed at *@results.
1226 */
1227unsigned int
1228radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1229 unsigned long first_index, unsigned int max_items,
1230 unsigned int tag)
1231{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001232 struct radix_tree_iter iter;
1233 void **slot;
1234 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001235
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001236 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001237 return 0;
1238
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001239 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1240 results[ret] = slot;
1241 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001242 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001243 }
1244
1245 return ret;
1246}
1247EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1248
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001249#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1250#include <linux/sched.h> /* for cond_resched() */
1251
1252/*
1253 * This linear search is at present only useful to shmem_unuse_inode().
1254 */
1255static unsigned long __locate(struct radix_tree_node *slot, void *item,
1256 unsigned long index, unsigned long *found_index)
1257{
1258 unsigned int shift, height;
1259 unsigned long i;
1260
Johannes Weiner449dd692014-04-03 14:47:56 -07001261 height = slot->path & RADIX_TREE_HEIGHT_MASK;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001262 shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1263
1264 for ( ; height > 1; height--) {
1265 i = (index >> shift) & RADIX_TREE_MAP_MASK;
1266 for (;;) {
1267 if (slot->slots[i] != NULL)
1268 break;
1269 index &= ~((1UL << shift) - 1);
1270 index += 1UL << shift;
1271 if (index == 0)
1272 goto out; /* 32-bit wraparound */
1273 i++;
1274 if (i == RADIX_TREE_MAP_SIZE)
1275 goto out;
1276 }
1277
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001278 slot = rcu_dereference_raw(slot->slots[i]);
1279 if (slot == NULL)
1280 goto out;
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001281 if (!radix_tree_is_indirect_ptr(slot)) {
1282 if (slot == item) {
1283 *found_index = index + i;
1284 index = 0;
1285 } else {
1286 index += shift;
1287 }
1288 goto out;
1289 }
Matthew Wilcox339e6352016-03-17 14:21:48 -07001290 slot = indirect_to_ptr(slot);
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001291 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001292 }
1293
1294 /* Bottom level: check items */
1295 for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
1296 if (slot->slots[i] == item) {
1297 *found_index = index + i;
1298 index = 0;
1299 goto out;
1300 }
1301 }
1302 index += RADIX_TREE_MAP_SIZE;
1303out:
1304 return index;
1305}
1306
1307/**
1308 * radix_tree_locate_item - search through radix tree for item
1309 * @root: radix tree root
1310 * @item: item to be found
1311 *
1312 * Returns index where item was found, or -1 if not found.
1313 * Caller must hold no lock (since this time-consuming function needs
1314 * to be preemptible), and must check afterwards if item is still there.
1315 */
1316unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1317{
1318 struct radix_tree_node *node;
1319 unsigned long max_index;
1320 unsigned long cur_index = 0;
1321 unsigned long found_index = -1;
1322
1323 do {
1324 rcu_read_lock();
1325 node = rcu_dereference_raw(root->rnode);
1326 if (!radix_tree_is_indirect_ptr(node)) {
1327 rcu_read_unlock();
1328 if (node == item)
1329 found_index = 0;
1330 break;
1331 }
1332
1333 node = indirect_to_ptr(node);
Johannes Weiner449dd692014-04-03 14:47:56 -07001334 max_index = radix_tree_maxindex(node->path &
1335 RADIX_TREE_HEIGHT_MASK);
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001336 if (cur_index > max_index) {
1337 rcu_read_unlock();
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001338 break;
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001339 }
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001340
1341 cur_index = __locate(node, item, cur_index, &found_index);
1342 rcu_read_unlock();
1343 cond_resched();
1344 } while (cur_index != 0 && cur_index <= max_index);
1345
1346 return found_index;
1347}
1348#else
1349unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1350{
1351 return -1;
1352}
1353#endif /* CONFIG_SHMEM && CONFIG_SWAP */
Nick Piggin47feff22008-07-25 19:45:29 -07001354
1355/**
Nick Piggina5f51c92006-01-08 01:01:41 -08001356 * radix_tree_shrink - shrink height of a radix tree to minimal
1357 * @root radix tree root
1358 */
1359static inline void radix_tree_shrink(struct radix_tree_root *root)
1360{
1361 /* try to shrink tree height */
Nick Pigginc0bc9872007-10-16 01:24:42 -07001362 while (root->height > 0) {
Nick Piggina5f51c92006-01-08 01:01:41 -08001363 struct radix_tree_node *to_free = root->rnode;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001364 struct radix_tree_node *slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001365
Nick Pigginc0bc9872007-10-16 01:24:42 -07001366 BUG_ON(!radix_tree_is_indirect_ptr(to_free));
Nick Piggin27d20fd2010-11-11 14:05:19 -08001367 to_free = indirect_to_ptr(to_free);
Nick Pigginc0bc9872007-10-16 01:24:42 -07001368
1369 /*
1370 * The candidate node has more than one child, or its child
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001371 * is not at the leftmost slot, or it is a multiorder entry,
1372 * we cannot shrink.
Nick Pigginc0bc9872007-10-16 01:24:42 -07001373 */
1374 if (to_free->count != 1)
1375 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -07001376 slot = to_free->slots[0];
1377 if (!slot)
Nick Pigginc0bc9872007-10-16 01:24:42 -07001378 break;
1379
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001380 /*
1381 * We don't need rcu_assign_pointer(), since we are simply
Nick Piggin27d20fd2010-11-11 14:05:19 -08001382 * moving the node from one part of the tree to another: if it
1383 * was safe to dereference the old pointer to it
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001384 * (to_free->slots[0]), it will be safe to dereference the new
Nick Piggin27d20fd2010-11-11 14:05:19 -08001385 * one (root->rnode) as far as dependent read barriers go.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001386 */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001387 if (root->height > 1) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001388 if (!radix_tree_is_indirect_ptr(slot))
1389 break;
1390
Matthew Wilcox339e6352016-03-17 14:21:48 -07001391 slot = indirect_to_ptr(slot);
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001392 slot->parent = NULL;
1393 slot = ptr_to_indirect(slot);
1394 }
1395 root->rnode = slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001396 root->height--;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001397
1398 /*
1399 * We have a dilemma here. The node's slot[0] must not be
1400 * NULLed in case there are concurrent lookups expecting to
1401 * find the item. However if this was a bottom-level node,
1402 * then it may be subject to the slot pointer being visible
1403 * to callers dereferencing it. If item corresponding to
1404 * slot[0] is subsequently deleted, these callers would expect
1405 * their slot to become empty sooner or later.
1406 *
1407 * For example, lockless pagecache will look up a slot, deref
1408 * the page pointer, and if the page is 0 refcount it means it
1409 * was concurrently deleted from pagecache so try the deref
1410 * again. Fortunately there is already a requirement for logic
1411 * to retry the entire slot lookup -- the indirect pointer
1412 * problem (replacing direct root node with an indirect pointer
1413 * also results in a stale slot). So tag the slot as indirect
1414 * to force callers to retry.
1415 */
1416 if (root->height == 0)
1417 *((unsigned long *)&to_free->slots[0]) |=
1418 RADIX_TREE_INDIRECT_PTR;
1419
Nick Piggina5f51c92006-01-08 01:01:41 -08001420 radix_tree_node_free(to_free);
1421 }
1422}
1423
1424/**
Johannes Weiner139e5612014-04-03 14:47:54 -07001425 * __radix_tree_delete_node - try to free node after clearing a slot
1426 * @root: radix tree root
Johannes Weiner139e5612014-04-03 14:47:54 -07001427 * @node: node containing @index
1428 *
1429 * After clearing the slot at @index in @node from radix tree
1430 * rooted at @root, call this function to attempt freeing the
1431 * node and shrinking the tree.
1432 *
1433 * Returns %true if @node was freed, %false otherwise.
1434 */
Johannes Weiner449dd692014-04-03 14:47:56 -07001435bool __radix_tree_delete_node(struct radix_tree_root *root,
Johannes Weiner139e5612014-04-03 14:47:54 -07001436 struct radix_tree_node *node)
1437{
1438 bool deleted = false;
1439
1440 do {
1441 struct radix_tree_node *parent;
1442
1443 if (node->count) {
1444 if (node == indirect_to_ptr(root->rnode)) {
1445 radix_tree_shrink(root);
1446 if (root->height == 0)
1447 deleted = true;
1448 }
1449 return deleted;
1450 }
1451
1452 parent = node->parent;
1453 if (parent) {
Johannes Weiner449dd692014-04-03 14:47:56 -07001454 unsigned int offset;
Johannes Weiner139e5612014-04-03 14:47:54 -07001455
Johannes Weiner449dd692014-04-03 14:47:56 -07001456 offset = node->path >> RADIX_TREE_HEIGHT_SHIFT;
1457 parent->slots[offset] = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001458 parent->count--;
1459 } else {
1460 root_tag_clear_all(root);
1461 root->height = 0;
1462 root->rnode = NULL;
1463 }
1464
1465 radix_tree_node_free(node);
1466 deleted = true;
1467
1468 node = parent;
1469 } while (node);
1470
1471 return deleted;
1472}
1473
Matthew Wilcox57578c22016-05-20 17:01:54 -07001474static inline void delete_sibling_entries(struct radix_tree_node *node,
1475 void *ptr, unsigned offset)
1476{
1477#ifdef CONFIG_RADIX_TREE_MULTIORDER
1478 int i;
1479 for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1480 if (node->slots[offset + i] != ptr)
1481 break;
1482 node->slots[offset + i] = NULL;
1483 node->count--;
1484 }
1485#endif
1486}
1487
Johannes Weiner139e5612014-04-03 14:47:54 -07001488/**
Johannes Weiner53c59f22014-04-03 14:47:39 -07001489 * radix_tree_delete_item - delete an item from a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 * @root: radix tree root
1491 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001492 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001494 * Remove @item at @index from the radix tree rooted at @root.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001496 * Returns the address of the deleted item, or NULL if it was not present
1497 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001499void *radix_tree_delete_item(struct radix_tree_root *root,
1500 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501{
Johannes Weiner139e5612014-04-03 14:47:54 -07001502 struct radix_tree_node *node;
Matthew Wilcox57578c22016-05-20 17:01:54 -07001503 unsigned int offset;
Johannes Weiner139e5612014-04-03 14:47:54 -07001504 void **slot;
1505 void *entry;
Nick Piggind5274262006-01-08 01:01:41 -08001506 int tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
Johannes Weiner139e5612014-04-03 14:47:54 -07001508 entry = __radix_tree_lookup(root, index, &node, &slot);
1509 if (!entry)
1510 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Johannes Weiner139e5612014-04-03 14:47:54 -07001512 if (item && entry != item)
1513 return NULL;
1514
1515 if (!node) {
Nick Piggin612d6c12006-06-23 02:03:22 -07001516 root_tag_clear_all(root);
1517 root->rnode = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001518 return entry;
Nick Piggin612d6c12006-06-23 02:03:22 -07001519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Johannes Weiner139e5612014-04-03 14:47:54 -07001521 offset = index & RADIX_TREE_MAP_MASK;
Johannes Weiner53c59f22014-04-03 14:47:39 -07001522
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 /*
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001524 * Clear all tags associated with the item to be deleted.
1525 * This way of doing it would be inefficient, but seldom is any set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001527 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001528 if (tag_get(node, tag, offset))
Nick Piggin612d6c12006-06-23 02:03:22 -07001529 radix_tree_tag_clear(root, index, tag);
Nick Piggind5274262006-01-08 01:01:41 -08001530 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Matthew Wilcox57578c22016-05-20 17:01:54 -07001532 delete_sibling_entries(node, ptr_to_indirect(slot), offset);
Johannes Weiner139e5612014-04-03 14:47:54 -07001533 node->slots[offset] = NULL;
1534 node->count--;
Nick Piggina5f51c92006-01-08 01:01:41 -08001535
Johannes Weiner449dd692014-04-03 14:47:56 -07001536 __radix_tree_delete_node(root, node);
Christoph Lameter201b6262005-09-06 15:16:46 -07001537
Johannes Weiner139e5612014-04-03 14:47:54 -07001538 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001540EXPORT_SYMBOL(radix_tree_delete_item);
1541
1542/**
1543 * radix_tree_delete - delete an item from a radix tree
1544 * @root: radix tree root
1545 * @index: index key
1546 *
1547 * Remove the item at @index from the radix tree rooted at @root.
1548 *
1549 * Returns the address of the deleted item, or NULL if it was not present.
1550 */
1551void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1552{
1553 return radix_tree_delete_item(root, index, NULL);
1554}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555EXPORT_SYMBOL(radix_tree_delete);
1556
1557/**
1558 * radix_tree_tagged - test whether any items in the tree are tagged
1559 * @root: radix tree root
1560 * @tag: tag to test
1561 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001562int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563{
Nick Piggin612d6c12006-06-23 02:03:22 -07001564 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565}
1566EXPORT_SYMBOL(radix_tree_tagged);
1567
1568static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001569radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570{
Johannes Weiner449dd692014-04-03 14:47:56 -07001571 struct radix_tree_node *node = arg;
1572
1573 memset(node, 0, sizeof(*node));
1574 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575}
1576
1577static __init unsigned long __maxindex(unsigned int height)
1578{
Peter Lund430d2752007-10-16 23:29:35 -07001579 unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1580 int shift = RADIX_TREE_INDEX_BITS - width;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Peter Lund430d2752007-10-16 23:29:35 -07001582 if (shift < 0)
1583 return ~0UL;
1584 if (shift >= BITS_PER_LONG)
1585 return 0UL;
1586 return ~0UL >> shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587}
1588
1589static __init void radix_tree_init_maxindex(void)
1590{
1591 unsigned int i;
1592
1593 for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1594 height_to_maxindex[i] = __maxindex(i);
1595}
1596
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597static int radix_tree_callback(struct notifier_block *nfb,
1598 unsigned long action,
1599 void *hcpu)
1600{
1601 int cpu = (long)hcpu;
1602 struct radix_tree_preload *rtp;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001603 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605 /* Free per-cpu pool of perloaded nodes */
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07001606 if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 rtp = &per_cpu(radix_tree_preloads, cpu);
1608 while (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001609 node = rtp->nodes;
1610 rtp->nodes = node->private_data;
1611 kmem_cache_free(radix_tree_node_cachep, node);
1612 rtp->nr--;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 }
1614 }
1615 return NOTIFY_OK;
1616}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
1618void __init radix_tree_init(void)
1619{
1620 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1621 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001622 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1623 radix_tree_node_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 radix_tree_init_maxindex();
1625 hotcpu_notifier(radix_tree_callback, 0);
1626}