blob: 1624c41179614321728bcdd878c7fb4153a91748 [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
487 /* Insert pointers to the canonical entry */
488 if ((shift - order) > 0) {
489 int i, n = 1 << (shift - order);
490 offset = offset & ~(n - 1);
491 slot = ptr_to_indirect(&node->slots[offset]);
492 for (i = 0; i < n; i++) {
493 if (node->slots[offset + i])
494 return -EEXIST;
495 }
496
497 for (i = 1; i < n; i++) {
498 rcu_assign_pointer(node->slots[offset + i], slot);
499 node->count++;
500 }
Nick Piggin612d6c12006-06-23 02:03:22 -0700501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Johannes Weiner139e5612014-04-03 14:47:54 -0700503 if (nodep)
504 *nodep = node;
505 if (slotp)
506 *slotp = node ? node->slots + offset : (void **)&root->rnode;
507 return 0;
508}
509
510/**
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700511 * __radix_tree_insert - insert into a radix tree
Johannes Weiner139e5612014-04-03 14:47:54 -0700512 * @root: radix tree root
513 * @index: index key
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700514 * @order: key covers the 2^order indices around index
Johannes Weiner139e5612014-04-03 14:47:54 -0700515 * @item: item to insert
516 *
517 * Insert an item into the radix tree at position @index.
518 */
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700519int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
520 unsigned order, void *item)
Johannes Weiner139e5612014-04-03 14:47:54 -0700521{
522 struct radix_tree_node *node;
523 void **slot;
524 int error;
525
526 BUG_ON(radix_tree_is_indirect_ptr(item));
527
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700528 error = __radix_tree_create(root, index, order, &node, &slot);
Johannes Weiner139e5612014-04-03 14:47:54 -0700529 if (error)
530 return error;
531 if (*slot != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 return -EEXIST;
Johannes Weiner139e5612014-04-03 14:47:54 -0700533 rcu_assign_pointer(*slot, item);
Christoph Lameter201b6262005-09-06 15:16:46 -0700534
Nick Piggin612d6c12006-06-23 02:03:22 -0700535 if (node) {
536 node->count++;
Johannes Weiner139e5612014-04-03 14:47:54 -0700537 BUG_ON(tag_get(node, 0, index & RADIX_TREE_MAP_MASK));
538 BUG_ON(tag_get(node, 1, index & RADIX_TREE_MAP_MASK));
Nick Piggin612d6c12006-06-23 02:03:22 -0700539 } else {
Nick Piggin612d6c12006-06-23 02:03:22 -0700540 BUG_ON(root_tag_get(root, 0));
541 BUG_ON(root_tag_get(root, 1));
542 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return 0;
545}
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700546EXPORT_SYMBOL(__radix_tree_insert);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Johannes Weiner139e5612014-04-03 14:47:54 -0700548/**
549 * __radix_tree_lookup - lookup an item in a radix tree
550 * @root: radix tree root
551 * @index: index key
552 * @nodep: returns node
553 * @slotp: returns slot
554 *
555 * Lookup and return the item at position @index in the radix
556 * tree @root.
557 *
558 * Until there is more than one item in the tree, no nodes are
559 * allocated and @root->rnode is used as a direct slot instead of
560 * pointing to a node, in which case *@nodep will be NULL.
Hans Reisera4331362005-11-07 00:59:29 -0800561 */
Johannes Weiner139e5612014-04-03 14:47:54 -0700562void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
563 struct radix_tree_node **nodep, void ***slotp)
Hans Reisera4331362005-11-07 00:59:29 -0800564{
Johannes Weiner139e5612014-04-03 14:47:54 -0700565 struct radix_tree_node *node, *parent;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800566 unsigned int height, shift;
Johannes Weiner139e5612014-04-03 14:47:54 -0700567 void **slot;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800568
Paul E. McKenney2676a582010-02-22 17:04:54 -0800569 node = rcu_dereference_raw(root->rnode);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800570 if (node == NULL)
571 return NULL;
572
Nick Pigginc0bc9872007-10-16 01:24:42 -0700573 if (!radix_tree_is_indirect_ptr(node)) {
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800574 if (index > 0)
575 return NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -0700576
577 if (nodep)
578 *nodep = NULL;
579 if (slotp)
580 *slotp = (void **)&root->rnode;
581 return node;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800582 }
Nick Piggin27d20fd2010-11-11 14:05:19 -0800583 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800584
Johannes Weiner449dd692014-04-03 14:47:56 -0700585 height = node->path & RADIX_TREE_HEIGHT_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800586 if (index > radix_tree_maxindex(height))
587 return NULL;
588
589 shift = (height-1) * RADIX_TREE_MAP_SHIFT;
590
591 do {
Johannes Weiner139e5612014-04-03 14:47:54 -0700592 parent = node;
593 slot = node->slots + ((index >> shift) & RADIX_TREE_MAP_MASK);
Paul E. McKenney2676a582010-02-22 17:04:54 -0800594 node = rcu_dereference_raw(*slot);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800595 if (node == NULL)
596 return NULL;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700597 if (!radix_tree_is_indirect_ptr(node))
598 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700599 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800600
601 shift -= RADIX_TREE_MAP_SHIFT;
602 height--;
603 } while (height > 0);
604
Johannes Weiner139e5612014-04-03 14:47:54 -0700605 if (nodep)
606 *nodep = parent;
607 if (slotp)
608 *slotp = slot;
609 return node;
Huang Shijieb72b71c2009-06-16 15:33:42 -0700610}
611
612/**
613 * radix_tree_lookup_slot - lookup a slot in a radix tree
614 * @root: radix tree root
615 * @index: index key
616 *
617 * Returns: the slot corresponding to the position @index in the
618 * radix tree @root. This is useful for update-if-exists operations.
619 *
620 * This function can be called under rcu_read_lock iff the slot is not
621 * modified by radix_tree_replace_slot, otherwise it must be called
622 * exclusive from other writers. Any dereference of the slot must be done
623 * using radix_tree_deref_slot.
624 */
625void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
626{
Johannes Weiner139e5612014-04-03 14:47:54 -0700627 void **slot;
628
629 if (!__radix_tree_lookup(root, index, NULL, &slot))
630 return NULL;
631 return slot;
Hans Reisera4331362005-11-07 00:59:29 -0800632}
633EXPORT_SYMBOL(radix_tree_lookup_slot);
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635/**
636 * radix_tree_lookup - perform lookup operation on a radix tree
637 * @root: radix tree root
638 * @index: index key
639 *
640 * Lookup the item at the position @index in the radix tree @root.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800641 *
642 * This function can be called under rcu_read_lock, however the caller
643 * must manage lifetimes of leaf nodes (eg. RCU may also be used to free
644 * them safely). No RCU barriers are required to access or modify the
645 * returned item, however.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 */
647void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
648{
Johannes Weiner139e5612014-04-03 14:47:54 -0700649 return __radix_tree_lookup(root, index, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650}
651EXPORT_SYMBOL(radix_tree_lookup);
652
653/**
654 * radix_tree_tag_set - set a tag on a radix tree node
655 * @root: radix tree root
656 * @index: index key
657 * @tag: tag index
658 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800659 * Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
660 * corresponding to @index in the radix tree. From
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 * the root all the way down to the leaf node.
662 *
663 * Returns the address of the tagged item. Setting a tag on a not-present
664 * item is a bug.
665 */
666void *radix_tree_tag_set(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800667 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
669 unsigned int height, shift;
Christoph Lameter201b6262005-09-06 15:16:46 -0700670 struct radix_tree_node *slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 height = root->height;
Peter Zijlstra4c91c362006-06-23 02:03:25 -0700673 BUG_ON(index > radix_tree_maxindex(height));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Nick Piggin27d20fd2010-11-11 14:05:19 -0800675 slot = indirect_to_ptr(root->rnode);
Nick Piggin612d6c12006-06-23 02:03:22 -0700676 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
678 while (height > 0) {
679 int offset;
680
681 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Nick Piggind5274262006-01-08 01:01:41 -0800682 if (!tag_get(slot, tag, offset))
683 tag_set(slot, tag, offset);
Christoph Lameter201b6262005-09-06 15:16:46 -0700684 slot = slot->slots[offset];
685 BUG_ON(slot == NULL);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700686 if (!radix_tree_is_indirect_ptr(slot))
687 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700688 slot = indirect_to_ptr(slot);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 shift -= RADIX_TREE_MAP_SHIFT;
690 height--;
691 }
692
Nick Piggin612d6c12006-06-23 02:03:22 -0700693 /* set the root's tag bit */
694 if (slot && !root_tag_get(root, tag))
695 root_tag_set(root, tag);
696
Christoph Lameter201b6262005-09-06 15:16:46 -0700697 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698}
699EXPORT_SYMBOL(radix_tree_tag_set);
700
701/**
702 * radix_tree_tag_clear - clear a tag on a radix tree node
703 * @root: radix tree root
704 * @index: index key
705 * @tag: tag index
706 *
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800707 * Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
708 * corresponding to @index in the radix tree. If
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 * this causes the leaf node to have no tags set then clear the tag in the
710 * next-to-leaf node, etc.
711 *
712 * Returns the address of the tagged item on success, else NULL. ie:
713 * has the same return value and semantics as radix_tree_lookup().
714 */
715void *radix_tree_tag_clear(struct radix_tree_root *root,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800716 unsigned long index, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800718 struct radix_tree_node *node = NULL;
Nick Piggin612d6c12006-06-23 02:03:22 -0700719 struct radix_tree_node *slot = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 unsigned int height, shift;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800721 int uninitialized_var(offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723 height = root->height;
724 if (index > radix_tree_maxindex(height))
725 goto out;
726
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800727 shift = height * RADIX_TREE_MAP_SHIFT;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700728 slot = root->rnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800730 while (shift) {
Christoph Lameter201b6262005-09-06 15:16:46 -0700731 if (slot == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 goto out;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700733 if (!radix_tree_is_indirect_ptr(slot))
734 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700735 slot = indirect_to_ptr(slot);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800738 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
739 node = slot;
740 slot = slot->slots[offset];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 }
742
Nick Piggin612d6c12006-06-23 02:03:22 -0700743 if (slot == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 goto out;
745
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800746 while (node) {
747 if (!tag_get(node, tag, offset))
Nick Piggind5274262006-01-08 01:01:41 -0800748 goto out;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800749 tag_clear(node, tag, offset);
750 if (any_tag_set(node, tag))
Nick Piggin6e954b92006-01-08 01:01:40 -0800751 goto out;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800752
753 index >>= RADIX_TREE_MAP_SHIFT;
754 offset = index & RADIX_TREE_MAP_MASK;
755 node = node->parent;
Nick Piggin612d6c12006-06-23 02:03:22 -0700756 }
757
758 /* clear the root's tag bit */
759 if (root_tag_get(root, tag))
760 root_tag_clear(root, tag);
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762out:
Nick Piggin612d6c12006-06-23 02:03:22 -0700763 return slot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
765EXPORT_SYMBOL(radix_tree_tag_clear);
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767/**
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700768 * radix_tree_tag_get - get a tag on a radix tree node
769 * @root: radix tree root
770 * @index: index key
Jonathan Corbetdaff89f2006-03-25 03:08:05 -0800771 * @tag: tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 *
Marcelo Tosatti32605a12005-09-06 15:16:48 -0700773 * Return values:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 *
Nick Piggin612d6c12006-06-23 02:03:22 -0700775 * 0: tag not present or not set
776 * 1: tag set
David Howellsce826532010-04-06 22:36:20 +0100777 *
778 * Note that the return value of this function may not be relied on, even if
779 * the RCU lock is held, unless tag modification and node deletion are excluded
780 * from concurrency.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 */
782int radix_tree_tag_get(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{
785 unsigned int height, shift;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800786 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Nick Piggin612d6c12006-06-23 02:03:22 -0700788 /* check the root's tag bit */
789 if (!root_tag_get(root, tag))
790 return 0;
791
Paul E. McKenney2676a582010-02-22 17:04:54 -0800792 node = rcu_dereference_raw(root->rnode);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800793 if (node == NULL)
794 return 0;
795
Nick Pigginc0bc9872007-10-16 01:24:42 -0700796 if (!radix_tree_is_indirect_ptr(node))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800797 return (index == 0);
Nick Piggin27d20fd2010-11-11 14:05:19 -0800798 node = indirect_to_ptr(node);
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800799
Johannes Weiner449dd692014-04-03 14:47:56 -0700800 height = node->path & RADIX_TREE_HEIGHT_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800801 if (index > radix_tree_maxindex(height))
802 return 0;
Nick Piggin612d6c12006-06-23 02:03:22 -0700803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
806 for ( ; ; ) {
807 int offset;
808
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800809 if (node == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return 0;
Matthew Wilcox339e6352016-03-17 14:21:48 -0700811 node = indirect_to_ptr(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
813 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
Nick Piggin7cf9c2c2006-12-06 20:33:44 -0800814 if (!tag_get(node, tag, offset))
Hugh Dickins3fa36ac2011-10-31 17:07:02 -0700815 return 0;
David Howellsce826532010-04-06 22:36:20 +0100816 if (height == 1)
Hugh Dickins3fa36ac2011-10-31 17:07:02 -0700817 return 1;
Paul E. McKenney2676a582010-02-22 17:04:54 -0800818 node = rcu_dereference_raw(node->slots[offset]);
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700819 if (!radix_tree_is_indirect_ptr(node))
820 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 shift -= RADIX_TREE_MAP_SHIFT;
822 height--;
823 }
824}
825EXPORT_SYMBOL(radix_tree_tag_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Fengguang Wu6df8ba42007-10-16 01:24:33 -0700827/**
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700828 * radix_tree_next_chunk - find next chunk of slots for iteration
829 *
830 * @root: radix tree root
831 * @iter: iterator state
832 * @flags: RADIX_TREE_ITER_* flags and tag index
833 * Returns: pointer to chunk first slot, or NULL if iteration is over
834 */
835void **radix_tree_next_chunk(struct radix_tree_root *root,
836 struct radix_tree_iter *iter, unsigned flags)
837{
838 unsigned shift, tag = flags & RADIX_TREE_ITER_TAG_MASK;
839 struct radix_tree_node *rnode, *node;
Johannes Weiner449dd692014-04-03 14:47:56 -0700840 unsigned long index, offset, height;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700841
842 if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
843 return NULL;
844
845 /*
846 * Catch next_index overflow after ~0UL. iter->index never overflows
847 * during iterating; it can be zero only at the beginning.
848 * And we cannot overflow iter->next_index in a single step,
849 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
Konstantin Khlebnikovfffaee32012-06-05 21:36:33 +0400850 *
851 * This condition also used by radix_tree_next_slot() to stop
852 * contiguous iterating, and forbid swithing to the next chunk.
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700853 */
854 index = iter->next_index;
855 if (!index && iter->index)
856 return NULL;
857
858 rnode = rcu_dereference_raw(root->rnode);
859 if (radix_tree_is_indirect_ptr(rnode)) {
860 rnode = indirect_to_ptr(rnode);
861 } else if (rnode && !index) {
862 /* Single-slot tree */
863 iter->index = 0;
864 iter->next_index = 1;
865 iter->tags = 1;
866 return (void **)&root->rnode;
867 } else
868 return NULL;
869
870restart:
Johannes Weiner449dd692014-04-03 14:47:56 -0700871 height = rnode->path & RADIX_TREE_HEIGHT_MASK;
872 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700873 offset = index >> shift;
874
875 /* Index outside of the tree */
876 if (offset >= RADIX_TREE_MAP_SIZE)
877 return NULL;
878
879 node = rnode;
880 while (1) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700881 struct radix_tree_node *slot;
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700882 if ((flags & RADIX_TREE_ITER_TAGGED) ?
883 !test_bit(offset, node->tags[tag]) :
884 !node->slots[offset]) {
885 /* Hole detected */
886 if (flags & RADIX_TREE_ITER_CONTIG)
887 return NULL;
888
889 if (flags & RADIX_TREE_ITER_TAGGED)
890 offset = radix_tree_find_next_bit(
891 node->tags[tag],
892 RADIX_TREE_MAP_SIZE,
893 offset + 1);
894 else
895 while (++offset < RADIX_TREE_MAP_SIZE) {
896 if (node->slots[offset])
897 break;
898 }
899 index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
900 index += offset << shift;
901 /* Overflow after ~0UL */
902 if (!index)
903 return NULL;
904 if (offset == RADIX_TREE_MAP_SIZE)
905 goto restart;
906 }
907
908 /* This is leaf-node */
909 if (!shift)
910 break;
911
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700912 slot = rcu_dereference_raw(node->slots[offset]);
913 if (slot == NULL)
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700914 goto restart;
Matthew Wilcoxe6145232016-03-17 14:21:54 -0700915 if (!radix_tree_is_indirect_ptr(slot))
916 break;
917 node = indirect_to_ptr(slot);
Konstantin Khlebnikov78c1d782012-03-28 14:42:53 -0700918 shift -= RADIX_TREE_MAP_SHIFT;
919 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
920 }
921
922 /* Update the iterator state */
923 iter->index = index;
924 iter->next_index = (index | RADIX_TREE_MAP_MASK) + 1;
925
926 /* Construct iter->tags bit-mask from node->tags[tag] array */
927 if (flags & RADIX_TREE_ITER_TAGGED) {
928 unsigned tag_long, tag_bit;
929
930 tag_long = offset / BITS_PER_LONG;
931 tag_bit = offset % BITS_PER_LONG;
932 iter->tags = node->tags[tag][tag_long] >> tag_bit;
933 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
934 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
935 /* Pick tags from next element */
936 if (tag_bit)
937 iter->tags |= node->tags[tag][tag_long + 1] <<
938 (BITS_PER_LONG - tag_bit);
939 /* Clip chunk size, here only BITS_PER_LONG tags */
940 iter->next_index = index + BITS_PER_LONG;
941 }
942 }
943
944 return node->slots + offset;
945}
946EXPORT_SYMBOL(radix_tree_next_chunk);
947
948/**
Jan Karaebf8aa42010-08-09 17:19:11 -0700949 * radix_tree_range_tag_if_tagged - for each item in given range set given
950 * tag if item has another tag set
951 * @root: radix tree root
952 * @first_indexp: pointer to a starting index of a range to scan
953 * @last_index: last index of a range to scan
954 * @nr_to_tag: maximum number items to tag
955 * @iftag: tag index to test
956 * @settag: tag index to set if tested tag is set
957 *
958 * This function scans range of radix tree from first_index to last_index
959 * (inclusive). For each item in the range if iftag is set, the function sets
960 * also settag. The function stops either after tagging nr_to_tag items or
961 * after reaching last_index.
962 *
Dave Chinner144dcfc2010-08-23 10:33:53 +1000963 * The tags must be set from the leaf level only and propagated back up the
964 * path to the root. We must do this so that we resolve the full path before
965 * setting any tags on intermediate nodes. If we set tags as we descend, then
966 * we can get to the leaf node and find that the index that has the iftag
967 * set is outside the range we are scanning. This reults in dangling tags and
968 * can lead to problems with later tag operations (e.g. livelocks on lookups).
969 *
Jan Karaebf8aa42010-08-09 17:19:11 -0700970 * The function returns number of leaves where the tag was set and sets
971 * *first_indexp to the first unscanned index.
Jan Karad5ed3a42010-08-19 14:13:33 -0700972 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
973 * be prepared to handle that.
Jan Karaebf8aa42010-08-09 17:19:11 -0700974 */
975unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
976 unsigned long *first_indexp, unsigned long last_index,
977 unsigned long nr_to_tag,
978 unsigned int iftag, unsigned int settag)
979{
Dave Chinner144dcfc2010-08-23 10:33:53 +1000980 unsigned int height = root->height;
Hugh Dickinse2bdb932012-01-12 17:20:41 -0800981 struct radix_tree_node *node = NULL;
Dave Chinner144dcfc2010-08-23 10:33:53 +1000982 struct radix_tree_node *slot;
983 unsigned int shift;
984 unsigned long tagged = 0;
985 unsigned long index = *first_indexp;
Jan Karaebf8aa42010-08-09 17:19:11 -0700986
987 last_index = min(last_index, radix_tree_maxindex(height));
988 if (index > last_index)
989 return 0;
990 if (!nr_to_tag)
991 return 0;
992 if (!root_tag_get(root, iftag)) {
993 *first_indexp = last_index + 1;
994 return 0;
995 }
996 if (height == 0) {
997 *first_indexp = last_index + 1;
998 root_tag_set(root, settag);
999 return 1;
1000 }
1001
1002 shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001003 slot = indirect_to_ptr(root->rnode);
Jan Karaebf8aa42010-08-09 17:19:11 -07001004
1005 for (;;) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001006 unsigned long upindex;
Jan Karaebf8aa42010-08-09 17:19:11 -07001007 int offset;
1008
1009 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1010 if (!slot->slots[offset])
1011 goto next;
1012 if (!tag_get(slot, iftag, offset))
1013 goto next;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001014 if (shift) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001015 node = slot;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001016 slot = slot->slots[offset];
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001017 if (radix_tree_is_indirect_ptr(slot)) {
1018 slot = indirect_to_ptr(slot);
1019 shift -= RADIX_TREE_MAP_SHIFT;
1020 continue;
1021 } else {
1022 slot = node;
1023 node = node->parent;
1024 }
Jan Karaebf8aa42010-08-09 17:19:11 -07001025 }
Dave Chinner144dcfc2010-08-23 10:33:53 +10001026
1027 /* tag the leaf */
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001028 tagged += 1 << shift;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001029 tag_set(slot, settag, offset);
1030
1031 /* walk back up the path tagging interior nodes */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001032 upindex = index;
1033 while (node) {
1034 upindex >>= RADIX_TREE_MAP_SHIFT;
1035 offset = upindex & RADIX_TREE_MAP_MASK;
1036
Dave Chinner144dcfc2010-08-23 10:33:53 +10001037 /* stop if we find a node with the tag already set */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001038 if (tag_get(node, settag, offset))
Dave Chinner144dcfc2010-08-23 10:33:53 +10001039 break;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001040 tag_set(node, settag, offset);
1041 node = node->parent;
Dave Chinner144dcfc2010-08-23 10:33:53 +10001042 }
1043
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001044 /*
1045 * Small optimization: now clear that node pointer.
1046 * Since all of this slot's ancestors now have the tag set
1047 * from setting it above, we have no further need to walk
1048 * back up the tree setting tags, until we update slot to
1049 * point to another radix_tree_node.
1050 */
1051 node = NULL;
1052
Jan Karaebf8aa42010-08-09 17:19:11 -07001053next:
1054 /* Go to next item at level determined by 'shift' */
1055 index = ((index >> shift) + 1) << shift;
Jan Karad5ed3a42010-08-19 14:13:33 -07001056 /* Overflow can happen when last_index is ~0UL... */
1057 if (index > last_index || !index)
Jan Karaebf8aa42010-08-09 17:19:11 -07001058 break;
1059 if (tagged >= nr_to_tag)
1060 break;
1061 while (((index >> shift) & RADIX_TREE_MAP_MASK) == 0) {
1062 /*
1063 * We've fully scanned this node. Go up. Because
1064 * last_index is guaranteed to be in the tree, what
1065 * we do below cannot wander astray.
1066 */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001067 slot = slot->parent;
Jan Karaebf8aa42010-08-09 17:19:11 -07001068 shift += RADIX_TREE_MAP_SHIFT;
1069 }
1070 }
1071 /*
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001072 * We need not to tag the root tag if there is no tag which is set with
1073 * settag within the range from *first_indexp to last_index.
Jan Karaebf8aa42010-08-09 17:19:11 -07001074 */
Toshiyuki Okajimaac15ee62011-01-25 15:07:32 -08001075 if (tagged > 0)
1076 root_tag_set(root, settag);
Jan Karaebf8aa42010-08-09 17:19:11 -07001077 *first_indexp = index;
1078
1079 return tagged;
1080}
1081EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1082
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083/**
1084 * radix_tree_gang_lookup - perform multiple lookup on a radix tree
1085 * @root: radix tree root
1086 * @results: where the results of the lookup are placed
1087 * @first_index: start the lookup from this key
1088 * @max_items: place up to this many items at *results
1089 *
1090 * Performs an index-ascending scan of the tree for present items. Places
1091 * them at *@results and returns the number of items which were placed at
1092 * *@results.
1093 *
1094 * The implementation is naive.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001095 *
1096 * Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1097 * rcu_read_lock. In this case, rather than the returned results being
1098 * an atomic snapshot of the tree at a single point in time, the semantics
1099 * of an RCU protected gang lookup are as though multiple radix_tree_lookups
1100 * have been issued in individual locks, and results stored in 'results'.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 */
1102unsigned int
1103radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1104 unsigned long first_index, unsigned int max_items)
1105{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001106 struct radix_tree_iter iter;
1107 void **slot;
1108 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001110 if (unlikely(!max_items))
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001111 return 0;
1112
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001113 radix_tree_for_each_slot(slot, root, &iter, first_index) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001114 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001115 if (!results[ret])
1116 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001117 if (radix_tree_is_indirect_ptr(results[ret])) {
1118 slot = radix_tree_iter_retry(&iter);
1119 continue;
1120 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001121 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 return ret;
1126}
1127EXPORT_SYMBOL(radix_tree_gang_lookup);
1128
Nick Piggin47feff22008-07-25 19:45:29 -07001129/**
1130 * radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1131 * @root: radix tree root
1132 * @results: where the results of the lookup are placed
Hugh Dickins63286502011-08-03 16:21:18 -07001133 * @indices: where their indices should be placed (but usually NULL)
Nick Piggin47feff22008-07-25 19:45:29 -07001134 * @first_index: start the lookup from this key
1135 * @max_items: place up to this many items at *results
1136 *
1137 * Performs an index-ascending scan of the tree for present items. Places
1138 * their slots at *@results and returns the number of items which were
1139 * placed at *@results.
1140 *
1141 * The implementation is naive.
1142 *
1143 * Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1144 * be dereferenced with radix_tree_deref_slot, and if using only RCU
1145 * protection, radix_tree_deref_slot may fail requiring a retry.
1146 */
1147unsigned int
Hugh Dickins63286502011-08-03 16:21:18 -07001148radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1149 void ***results, unsigned long *indices,
Nick Piggin47feff22008-07-25 19:45:29 -07001150 unsigned long first_index, unsigned int max_items)
1151{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001152 struct radix_tree_iter iter;
1153 void **slot;
1154 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001155
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001156 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001157 return 0;
1158
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001159 radix_tree_for_each_slot(slot, root, &iter, first_index) {
1160 results[ret] = slot;
Hugh Dickins63286502011-08-03 16:21:18 -07001161 if (indices)
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001162 indices[ret] = iter.index;
1163 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001164 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001165 }
1166
1167 return ret;
1168}
1169EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171/**
1172 * radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1173 * based on a tag
1174 * @root: radix tree root
1175 * @results: where the results of the lookup are placed
1176 * @first_index: start the lookup from this key
1177 * @max_items: place up to this many items at *results
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001178 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 *
1180 * Performs an index-ascending scan of the tree for present items which
1181 * have the tag indexed by @tag set. Places the items at *@results and
1182 * returns the number of items which were placed at *@results.
1183 */
1184unsigned int
1185radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001186 unsigned long first_index, unsigned int max_items,
1187 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001189 struct radix_tree_iter iter;
1190 void **slot;
1191 unsigned int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001193 if (unlikely(!max_items))
Nick Piggin612d6c12006-06-23 02:03:22 -07001194 return 0;
1195
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001196 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
Matthew Wilcox46437f92016-02-02 16:57:52 -08001197 results[ret] = rcu_dereference_raw(*slot);
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001198 if (!results[ret])
1199 continue;
Matthew Wilcox46437f92016-02-02 16:57:52 -08001200 if (radix_tree_is_indirect_ptr(results[ret])) {
1201 slot = radix_tree_iter_retry(&iter);
1202 continue;
1203 }
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001204 if (++ret == max_items)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 }
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001207
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 return ret;
1209}
1210EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1211
1212/**
Nick Piggin47feff22008-07-25 19:45:29 -07001213 * radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1214 * radix tree based on a tag
1215 * @root: radix tree root
1216 * @results: where the results of the lookup are placed
1217 * @first_index: start the lookup from this key
1218 * @max_items: place up to this many items at *results
1219 * @tag: the tag index (< RADIX_TREE_MAX_TAGS)
1220 *
1221 * Performs an index-ascending scan of the tree for present items which
1222 * have the tag indexed by @tag set. Places the slots at *@results and
1223 * returns the number of slots which were placed at *@results.
1224 */
1225unsigned int
1226radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1227 unsigned long first_index, unsigned int max_items,
1228 unsigned int tag)
1229{
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001230 struct radix_tree_iter iter;
1231 void **slot;
1232 unsigned int ret = 0;
Nick Piggin47feff22008-07-25 19:45:29 -07001233
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001234 if (unlikely(!max_items))
Nick Piggin47feff22008-07-25 19:45:29 -07001235 return 0;
1236
Konstantin Khlebnikovcebbd292012-03-28 14:42:53 -07001237 radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1238 results[ret] = slot;
1239 if (++ret == max_items)
Nick Piggin47feff22008-07-25 19:45:29 -07001240 break;
Nick Piggin47feff22008-07-25 19:45:29 -07001241 }
1242
1243 return ret;
1244}
1245EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1246
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001247#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1248#include <linux/sched.h> /* for cond_resched() */
1249
1250/*
1251 * This linear search is at present only useful to shmem_unuse_inode().
1252 */
1253static unsigned long __locate(struct radix_tree_node *slot, void *item,
1254 unsigned long index, unsigned long *found_index)
1255{
1256 unsigned int shift, height;
1257 unsigned long i;
1258
Johannes Weiner449dd692014-04-03 14:47:56 -07001259 height = slot->path & RADIX_TREE_HEIGHT_MASK;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001260 shift = (height-1) * RADIX_TREE_MAP_SHIFT;
1261
1262 for ( ; height > 1; height--) {
1263 i = (index >> shift) & RADIX_TREE_MAP_MASK;
1264 for (;;) {
1265 if (slot->slots[i] != NULL)
1266 break;
1267 index &= ~((1UL << shift) - 1);
1268 index += 1UL << shift;
1269 if (index == 0)
1270 goto out; /* 32-bit wraparound */
1271 i++;
1272 if (i == RADIX_TREE_MAP_SIZE)
1273 goto out;
1274 }
1275
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001276 slot = rcu_dereference_raw(slot->slots[i]);
1277 if (slot == NULL)
1278 goto out;
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001279 if (!radix_tree_is_indirect_ptr(slot)) {
1280 if (slot == item) {
1281 *found_index = index + i;
1282 index = 0;
1283 } else {
1284 index += shift;
1285 }
1286 goto out;
1287 }
Matthew Wilcox339e6352016-03-17 14:21:48 -07001288 slot = indirect_to_ptr(slot);
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001289 shift -= RADIX_TREE_MAP_SHIFT;
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001290 }
1291
1292 /* Bottom level: check items */
1293 for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
1294 if (slot->slots[i] == item) {
1295 *found_index = index + i;
1296 index = 0;
1297 goto out;
1298 }
1299 }
1300 index += RADIX_TREE_MAP_SIZE;
1301out:
1302 return index;
1303}
1304
1305/**
1306 * radix_tree_locate_item - search through radix tree for item
1307 * @root: radix tree root
1308 * @item: item to be found
1309 *
1310 * Returns index where item was found, or -1 if not found.
1311 * Caller must hold no lock (since this time-consuming function needs
1312 * to be preemptible), and must check afterwards if item is still there.
1313 */
1314unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1315{
1316 struct radix_tree_node *node;
1317 unsigned long max_index;
1318 unsigned long cur_index = 0;
1319 unsigned long found_index = -1;
1320
1321 do {
1322 rcu_read_lock();
1323 node = rcu_dereference_raw(root->rnode);
1324 if (!radix_tree_is_indirect_ptr(node)) {
1325 rcu_read_unlock();
1326 if (node == item)
1327 found_index = 0;
1328 break;
1329 }
1330
1331 node = indirect_to_ptr(node);
Johannes Weiner449dd692014-04-03 14:47:56 -07001332 max_index = radix_tree_maxindex(node->path &
1333 RADIX_TREE_HEIGHT_MASK);
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001334 if (cur_index > max_index) {
1335 rcu_read_unlock();
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001336 break;
Hugh Dickins5f30fc92014-03-03 15:38:23 -08001337 }
Hugh Dickinse504f3f2011-08-03 16:21:27 -07001338
1339 cur_index = __locate(node, item, cur_index, &found_index);
1340 rcu_read_unlock();
1341 cond_resched();
1342 } while (cur_index != 0 && cur_index <= max_index);
1343
1344 return found_index;
1345}
1346#else
1347unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1348{
1349 return -1;
1350}
1351#endif /* CONFIG_SHMEM && CONFIG_SWAP */
Nick Piggin47feff22008-07-25 19:45:29 -07001352
1353/**
Nick Piggina5f51c92006-01-08 01:01:41 -08001354 * radix_tree_shrink - shrink height of a radix tree to minimal
1355 * @root radix tree root
1356 */
1357static inline void radix_tree_shrink(struct radix_tree_root *root)
1358{
1359 /* try to shrink tree height */
Nick Pigginc0bc9872007-10-16 01:24:42 -07001360 while (root->height > 0) {
Nick Piggina5f51c92006-01-08 01:01:41 -08001361 struct radix_tree_node *to_free = root->rnode;
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001362 struct radix_tree_node *slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001363
Nick Pigginc0bc9872007-10-16 01:24:42 -07001364 BUG_ON(!radix_tree_is_indirect_ptr(to_free));
Nick Piggin27d20fd2010-11-11 14:05:19 -08001365 to_free = indirect_to_ptr(to_free);
Nick Pigginc0bc9872007-10-16 01:24:42 -07001366
1367 /*
1368 * The candidate node has more than one child, or its child
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001369 * is not at the leftmost slot, or it is a multiorder entry,
1370 * we cannot shrink.
Nick Pigginc0bc9872007-10-16 01:24:42 -07001371 */
1372 if (to_free->count != 1)
1373 break;
Matthew Wilcox339e6352016-03-17 14:21:48 -07001374 slot = to_free->slots[0];
1375 if (!slot)
Nick Pigginc0bc9872007-10-16 01:24:42 -07001376 break;
1377
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001378 /*
1379 * We don't need rcu_assign_pointer(), since we are simply
Nick Piggin27d20fd2010-11-11 14:05:19 -08001380 * moving the node from one part of the tree to another: if it
1381 * was safe to dereference the old pointer to it
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001382 * (to_free->slots[0]), it will be safe to dereference the new
Nick Piggin27d20fd2010-11-11 14:05:19 -08001383 * one (root->rnode) as far as dependent read barriers go.
Nick Piggin7cf9c2c2006-12-06 20:33:44 -08001384 */
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001385 if (root->height > 1) {
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001386 if (!radix_tree_is_indirect_ptr(slot))
1387 break;
1388
Matthew Wilcox339e6352016-03-17 14:21:48 -07001389 slot = indirect_to_ptr(slot);
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001390 slot->parent = NULL;
1391 slot = ptr_to_indirect(slot);
1392 }
1393 root->rnode = slot;
Nick Piggina5f51c92006-01-08 01:01:41 -08001394 root->height--;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001395
1396 /*
1397 * We have a dilemma here. The node's slot[0] must not be
1398 * NULLed in case there are concurrent lookups expecting to
1399 * find the item. However if this was a bottom-level node,
1400 * then it may be subject to the slot pointer being visible
1401 * to callers dereferencing it. If item corresponding to
1402 * slot[0] is subsequently deleted, these callers would expect
1403 * their slot to become empty sooner or later.
1404 *
1405 * For example, lockless pagecache will look up a slot, deref
1406 * the page pointer, and if the page is 0 refcount it means it
1407 * was concurrently deleted from pagecache so try the deref
1408 * again. Fortunately there is already a requirement for logic
1409 * to retry the entire slot lookup -- the indirect pointer
1410 * problem (replacing direct root node with an indirect pointer
1411 * also results in a stale slot). So tag the slot as indirect
1412 * to force callers to retry.
1413 */
1414 if (root->height == 0)
1415 *((unsigned long *)&to_free->slots[0]) |=
1416 RADIX_TREE_INDIRECT_PTR;
1417
Nick Piggina5f51c92006-01-08 01:01:41 -08001418 radix_tree_node_free(to_free);
1419 }
1420}
1421
1422/**
Johannes Weiner139e5612014-04-03 14:47:54 -07001423 * __radix_tree_delete_node - try to free node after clearing a slot
1424 * @root: radix tree root
Johannes Weiner139e5612014-04-03 14:47:54 -07001425 * @node: node containing @index
1426 *
1427 * After clearing the slot at @index in @node from radix tree
1428 * rooted at @root, call this function to attempt freeing the
1429 * node and shrinking the tree.
1430 *
1431 * Returns %true if @node was freed, %false otherwise.
1432 */
Johannes Weiner449dd692014-04-03 14:47:56 -07001433bool __radix_tree_delete_node(struct radix_tree_root *root,
Johannes Weiner139e5612014-04-03 14:47:54 -07001434 struct radix_tree_node *node)
1435{
1436 bool deleted = false;
1437
1438 do {
1439 struct radix_tree_node *parent;
1440
1441 if (node->count) {
1442 if (node == indirect_to_ptr(root->rnode)) {
1443 radix_tree_shrink(root);
1444 if (root->height == 0)
1445 deleted = true;
1446 }
1447 return deleted;
1448 }
1449
1450 parent = node->parent;
1451 if (parent) {
Johannes Weiner449dd692014-04-03 14:47:56 -07001452 unsigned int offset;
Johannes Weiner139e5612014-04-03 14:47:54 -07001453
Johannes Weiner449dd692014-04-03 14:47:56 -07001454 offset = node->path >> RADIX_TREE_HEIGHT_SHIFT;
1455 parent->slots[offset] = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001456 parent->count--;
1457 } else {
1458 root_tag_clear_all(root);
1459 root->height = 0;
1460 root->rnode = NULL;
1461 }
1462
1463 radix_tree_node_free(node);
1464 deleted = true;
1465
1466 node = parent;
1467 } while (node);
1468
1469 return deleted;
1470}
1471
1472/**
Johannes Weiner53c59f22014-04-03 14:47:39 -07001473 * radix_tree_delete_item - delete an item from a radix tree
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 * @root: radix tree root
1475 * @index: index key
Johannes Weiner53c59f22014-04-03 14:47:39 -07001476 * @item: expected item
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001478 * Remove @item at @index from the radix tree rooted at @root.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 *
Johannes Weiner53c59f22014-04-03 14:47:39 -07001480 * Returns the address of the deleted item, or NULL if it was not present
1481 * or the entry at the given @index was not @item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 */
Johannes Weiner53c59f22014-04-03 14:47:39 -07001483void *radix_tree_delete_item(struct radix_tree_root *root,
1484 unsigned long index, void *item)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485{
Johannes Weiner139e5612014-04-03 14:47:54 -07001486 struct radix_tree_node *node;
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001487 unsigned int offset, i;
Johannes Weiner139e5612014-04-03 14:47:54 -07001488 void **slot;
1489 void *entry;
Nick Piggind5274262006-01-08 01:01:41 -08001490 int tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491
Johannes Weiner139e5612014-04-03 14:47:54 -07001492 entry = __radix_tree_lookup(root, index, &node, &slot);
1493 if (!entry)
1494 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Johannes Weiner139e5612014-04-03 14:47:54 -07001496 if (item && entry != item)
1497 return NULL;
1498
1499 if (!node) {
Nick Piggin612d6c12006-06-23 02:03:22 -07001500 root_tag_clear_all(root);
1501 root->rnode = NULL;
Johannes Weiner139e5612014-04-03 14:47:54 -07001502 return entry;
Nick Piggin612d6c12006-06-23 02:03:22 -07001503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Johannes Weiner139e5612014-04-03 14:47:54 -07001505 offset = index & RADIX_TREE_MAP_MASK;
Johannes Weiner53c59f22014-04-03 14:47:39 -07001506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 /*
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001508 * Clear all tags associated with the item to be deleted.
1509 * This way of doing it would be inefficient, but seldom is any set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001511 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
Hugh Dickinse2bdb932012-01-12 17:20:41 -08001512 if (tag_get(node, tag, offset))
Nick Piggin612d6c12006-06-23 02:03:22 -07001513 radix_tree_tag_clear(root, index, tag);
Nick Piggind5274262006-01-08 01:01:41 -08001514 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Matthew Wilcoxe6145232016-03-17 14:21:54 -07001516 /* Delete any sibling slots pointing to this slot */
1517 for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1518 if (node->slots[offset + i] != ptr_to_indirect(slot))
1519 break;
1520 node->slots[offset + i] = NULL;
1521 node->count--;
1522 }
Johannes Weiner139e5612014-04-03 14:47:54 -07001523 node->slots[offset] = NULL;
1524 node->count--;
Nick Piggina5f51c92006-01-08 01:01:41 -08001525
Johannes Weiner449dd692014-04-03 14:47:56 -07001526 __radix_tree_delete_node(root, node);
Christoph Lameter201b6262005-09-06 15:16:46 -07001527
Johannes Weiner139e5612014-04-03 14:47:54 -07001528 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529}
Johannes Weiner53c59f22014-04-03 14:47:39 -07001530EXPORT_SYMBOL(radix_tree_delete_item);
1531
1532/**
1533 * radix_tree_delete - delete an item from a radix tree
1534 * @root: radix tree root
1535 * @index: index key
1536 *
1537 * Remove the item at @index from the radix tree rooted at @root.
1538 *
1539 * Returns the address of the deleted item, or NULL if it was not present.
1540 */
1541void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1542{
1543 return radix_tree_delete_item(root, index, NULL);
1544}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545EXPORT_SYMBOL(radix_tree_delete);
1546
1547/**
1548 * radix_tree_tagged - test whether any items in the tree are tagged
1549 * @root: radix tree root
1550 * @tag: tag to test
1551 */
Jonathan Corbetdaff89f2006-03-25 03:08:05 -08001552int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553{
Nick Piggin612d6c12006-06-23 02:03:22 -07001554 return root_tag_get(root, tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555}
1556EXPORT_SYMBOL(radix_tree_tagged);
1557
1558static void
Johannes Weiner449dd692014-04-03 14:47:56 -07001559radix_tree_node_ctor(void *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560{
Johannes Weiner449dd692014-04-03 14:47:56 -07001561 struct radix_tree_node *node = arg;
1562
1563 memset(node, 0, sizeof(*node));
1564 INIT_LIST_HEAD(&node->private_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565}
1566
1567static __init unsigned long __maxindex(unsigned int height)
1568{
Peter Lund430d2752007-10-16 23:29:35 -07001569 unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1570 int shift = RADIX_TREE_INDEX_BITS - width;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Peter Lund430d2752007-10-16 23:29:35 -07001572 if (shift < 0)
1573 return ~0UL;
1574 if (shift >= BITS_PER_LONG)
1575 return 0UL;
1576 return ~0UL >> shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577}
1578
1579static __init void radix_tree_init_maxindex(void)
1580{
1581 unsigned int i;
1582
1583 for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1584 height_to_maxindex[i] = __maxindex(i);
1585}
1586
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587static int radix_tree_callback(struct notifier_block *nfb,
1588 unsigned long action,
1589 void *hcpu)
1590{
1591 int cpu = (long)hcpu;
1592 struct radix_tree_preload *rtp;
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001593 struct radix_tree_node *node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
1595 /* Free per-cpu pool of perloaded nodes */
Rafael J. Wysocki8bb78442007-05-09 02:35:10 -07001596 if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 rtp = &per_cpu(radix_tree_preloads, cpu);
1598 while (rtp->nr) {
Kirill A. Shutemov9d2a8da2015-06-25 15:02:19 -07001599 node = rtp->nodes;
1600 rtp->nodes = node->private_data;
1601 kmem_cache_free(radix_tree_node_cachep, node);
1602 rtp->nr--;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 }
1604 }
1605 return NOTIFY_OK;
1606}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
1608void __init radix_tree_init(void)
1609{
1610 radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1611 sizeof(struct radix_tree_node), 0,
Christoph Lameter488514d2008-04-28 02:12:05 -07001612 SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1613 radix_tree_node_ctor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 radix_tree_init_maxindex();
1615 hotcpu_notifier(radix_tree_callback, 0);
1616}