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