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