radix-tree.c 44.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 * Copyright (C) 2001 Momchil Velikov
 * Portions Copyright (C) 2001 Christoph Hellwig
C
Christoph Lameter 已提交
4
 * Copyright (C) 2005 SGI, Christoph Lameter
5
 * Copyright (C) 2006 Nick Piggin
6
 * Copyright (C) 2012 Konstantin Khlebnikov
7 8
 * Copyright (C) 2016 Intel, Matthew Wilcox
 * Copyright (C) 2016 Intel, Ross Zwisler
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/errno.h>
#include <linux/init.h>
#include <linux/kernel.h>
28
#include <linux/export.h>
L
Linus Torvalds 已提交
29 30 31
#include <linux/radix-tree.h>
#include <linux/percpu.h>
#include <linux/slab.h>
32
#include <linux/kmemleak.h>
L
Linus Torvalds 已提交
33 34 35 36
#include <linux/notifier.h>
#include <linux/cpu.h>
#include <linux/string.h>
#include <linux/bitops.h>
37
#include <linux/rcupdate.h>
38
#include <linux/preempt.h>		/* in_interrupt() */
L
Linus Torvalds 已提交
39 40


41 42 43
/* Number of nodes in fully populated tree of given height */
static unsigned long height_to_maxnodes[RADIX_TREE_MAX_PATH + 1] __read_mostly;

L
Linus Torvalds 已提交
44 45 46
/*
 * Radix tree node cache.
 */
47
static struct kmem_cache *radix_tree_node_cachep;
L
Linus Torvalds 已提交
48

49 50 51 52 53 54 55 56 57 58 59 60 61
/*
 * The radix tree is variable-height, so an insert operation not only has
 * to build the branch to its corresponding item, it also has to build the
 * branch to existing items if the size has to be increased (by
 * radix_tree_extend).
 *
 * The worst case is a zero height tree with just a single item at index 0,
 * and then inserting an item at index ULONG_MAX. This requires 2 new branches
 * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
 * Hence:
 */
#define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)

L
Linus Torvalds 已提交
62 63 64 65
/*
 * Per-cpu pool of preloaded nodes
 */
struct radix_tree_preload {
M
Matthew Wilcox 已提交
66
	unsigned nr;
67 68
	/* nodes->private_data points to next preallocated node */
	struct radix_tree_node *nodes;
L
Linus Torvalds 已提交
69
};
70
static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
L
Linus Torvalds 已提交
71

72
static inline void *node_to_entry(void *ptr)
N
Nick Piggin 已提交
73
{
74
	return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
N
Nick Piggin 已提交
75 76
}

77
#define RADIX_TREE_RETRY	node_to_entry(NULL)
78

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
#ifdef CONFIG_RADIX_TREE_MULTIORDER
/* Sibling slots point directly to another slot in the same node */
static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
{
	void **ptr = node;
	return (parent->slots <= ptr) &&
			(ptr < parent->slots + RADIX_TREE_MAP_SIZE);
}
#else
static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
{
	return false;
}
#endif

static inline unsigned long get_slot_offset(struct radix_tree_node *parent,
						 void **slot)
{
	return slot - parent->slots;
}

100 101
static unsigned int radix_tree_descend(struct radix_tree_node *parent,
			struct radix_tree_node **nodep, unsigned long index)
102
{
103
	unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
104 105 106
	void **entry = rcu_dereference_raw(parent->slots[offset]);

#ifdef CONFIG_RADIX_TREE_MULTIORDER
107
	if (radix_tree_is_internal_node(entry)) {
108 109 110 111 112 113 114 115 116 117 118 119
		unsigned long siboff = get_slot_offset(parent, entry);
		if (siboff < RADIX_TREE_MAP_SIZE) {
			offset = siboff;
			entry = rcu_dereference_raw(parent->slots[offset]);
		}
	}
#endif

	*nodep = (void *)entry;
	return offset;
}

N
Nick Piggin 已提交
120 121 122 123 124
static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
{
	return root->gfp_mask & __GFP_BITS_MASK;
}

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
		int offset)
{
	__set_bit(offset, node->tags[tag]);
}

static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
		int offset)
{
	__clear_bit(offset, node->tags[tag]);
}

static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
		int offset)
{
	return test_bit(offset, node->tags[tag]);
}

static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
{
	root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
}

M
Matthew Wilcox 已提交
148
static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
149 150 151 152 153 154 155 156 157 158 159
{
	root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
}

static inline void root_tag_clear_all(struct radix_tree_root *root)
{
	root->gfp_mask &= __GFP_BITS_MASK;
}

static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
{
M
Matthew Wilcox 已提交
160
	return (__force int)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
161 162
}

163 164 165 166 167
static inline unsigned root_tags_get(struct radix_tree_root *root)
{
	return (__force unsigned)root->gfp_mask >> __GFP_BITS_SHIFT;
}

168 169 170 171 172 173
/*
 * Returns 1 if any slot in the node has this tag set.
 * Otherwise returns 0.
 */
static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
{
M
Matthew Wilcox 已提交
174
	unsigned idx;
175 176 177 178 179 180
	for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
		if (node->tags[tag][idx])
			return 1;
	}
	return 0;
}
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

/**
 * radix_tree_find_next_bit - find the next set bit in a memory region
 *
 * @addr: The address to base the search on
 * @size: The bitmap size in bits
 * @offset: The bitnumber to start searching at
 *
 * Unrollable variant of find_next_bit() for constant size arrays.
 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
 * Returns next bit offset, or size if nothing found.
 */
static __always_inline unsigned long
radix_tree_find_next_bit(const unsigned long *addr,
			 unsigned long size, unsigned long offset)
{
	if (!__builtin_constant_p(size))
		return find_next_bit(addr, size, offset);

	if (offset < size) {
		unsigned long tmp;

		addr += offset / BITS_PER_LONG;
		tmp = *addr >> (offset % BITS_PER_LONG);
		if (tmp)
			return __ffs(tmp) + offset;
		offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
		while (offset < size) {
			tmp = *++addr;
			if (tmp)
				return __ffs(tmp) + offset;
			offset += BITS_PER_LONG;
		}
	}
	return size;
}

218
#ifndef __KERNEL__
M
Matthew Wilcox 已提交
219
static void dump_node(struct radix_tree_node *node, unsigned long index)
M
Matthew Wilcox 已提交
220
{
221
	unsigned long i;
M
Matthew Wilcox 已提交
222

223
	pr_debug("radix node: %p offset %d tags %lx %lx %lx shift %d count %d parent %p\n",
224
		node, node->offset,
225
		node->tags[0][0], node->tags[1][0], node->tags[2][0],
226
		node->shift, node->count, node->parent);
227 228

	for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
M
Matthew Wilcox 已提交
229 230
		unsigned long first = index | (i << node->shift);
		unsigned long last = first | ((1UL << node->shift) - 1);
231 232 233 234 235 236
		void *entry = node->slots[i];
		if (!entry)
			continue;
		if (is_sibling_entry(node, entry)) {
			pr_debug("radix sblng %p offset %ld val %p indices %ld-%ld\n",
					entry, i,
237
					*(void **)entry_to_node(entry),
238
					first, last);
239
		} else if (!radix_tree_is_internal_node(entry)) {
240 241 242
			pr_debug("radix entry %p offset %ld indices %ld-%ld\n",
					entry, i, first, last);
		} else {
243
			dump_node(entry_to_node(entry), first);
244 245
		}
	}
M
Matthew Wilcox 已提交
246 247 248 249 250
}

/* For debug */
static void radix_tree_dump(struct radix_tree_root *root)
{
M
Matthew Wilcox 已提交
251 252
	pr_debug("radix root: %p rnode %p tags %x\n",
			root, root->rnode,
M
Matthew Wilcox 已提交
253
			root->gfp_mask >> __GFP_BITS_SHIFT);
254
	if (!radix_tree_is_internal_node(root->rnode))
M
Matthew Wilcox 已提交
255
		return;
256
	dump_node(entry_to_node(root->rnode), 0);
M
Matthew Wilcox 已提交
257 258 259
}
#endif

L
Linus Torvalds 已提交
260 261 262 263 264 265 266
/*
 * This assumes that the caller has performed appropriate preallocation, and
 * that the caller has pinned this thread of control to the current CPU.
 */
static struct radix_tree_node *
radix_tree_node_alloc(struct radix_tree_root *root)
{
267
	struct radix_tree_node *ret = NULL;
N
Nick Piggin 已提交
268
	gfp_t gfp_mask = root_gfp_mask(root);
L
Linus Torvalds 已提交
269

270
	/*
M
Matthew Wilcox 已提交
271 272 273
	 * Preload code isn't irq safe and it doesn't make sense to use
	 * preloading during an interrupt anyway as all the allocations have
	 * to be atomic. So just do normal allocation when in interrupt.
274
	 */
275
	if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
L
Linus Torvalds 已提交
276 277
		struct radix_tree_preload *rtp;

278 279
		/*
		 * Even if the caller has preloaded, try to allocate from the
280 281
		 * cache first for the new node to get accounted to the memory
		 * cgroup.
282 283
		 */
		ret = kmem_cache_alloc(radix_tree_node_cachep,
284
				       gfp_mask | __GFP_NOWARN);
285 286 287
		if (ret)
			goto out;

288 289 290 291 292
		/*
		 * Provided the caller has preloaded here, we will always
		 * succeed in getting a node here (and never reach
		 * kmem_cache_alloc)
		 */
293
		rtp = this_cpu_ptr(&radix_tree_preloads);
L
Linus Torvalds 已提交
294
		if (rtp->nr) {
295 296 297
			ret = rtp->nodes;
			rtp->nodes = ret->private_data;
			ret->private_data = NULL;
L
Linus Torvalds 已提交
298 299
			rtp->nr--;
		}
300 301 302 303 304
		/*
		 * Update the allocation stack trace as this is more useful
		 * for debugging.
		 */
		kmemleak_update_trace(ret);
305
		goto out;
L
Linus Torvalds 已提交
306
	}
307
	ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
308
out:
309
	BUG_ON(radix_tree_is_internal_node(ret));
L
Linus Torvalds 已提交
310 311 312
	return ret;
}

313 314 315 316
static void radix_tree_node_rcu_free(struct rcu_head *head)
{
	struct radix_tree_node *node =
			container_of(head, struct radix_tree_node, rcu_head);
317
	int i;
318 319 320 321 322 323

	/*
	 * must only free zeroed nodes into the slab. radix_tree_shrink
	 * can leave us with a non-NULL entry in the first slot, so clear
	 * that here to make sure.
	 */
324 325 326
	for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
		tag_clear(node, i, 0);

327 328 329
	node->slots[0] = NULL;
	node->count = 0;

330 331 332
	kmem_cache_free(radix_tree_node_cachep, node);
}

L
Linus Torvalds 已提交
333 334 335
static inline void
radix_tree_node_free(struct radix_tree_node *node)
{
336
	call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
L
Linus Torvalds 已提交
337 338 339 340 341 342 343
}

/*
 * Load up this CPU's radix_tree_node buffer with sufficient objects to
 * ensure that the addition of a single element in the tree cannot fail.  On
 * success, return zero, with preemption disabled.  On error, return -ENOMEM
 * with preemption not disabled.
344 345
 *
 * To make use of this facility, the radix tree must be initialised without
346
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
L
Linus Torvalds 已提交
347
 */
348
static int __radix_tree_preload(gfp_t gfp_mask, int nr)
L
Linus Torvalds 已提交
349 350 351 352 353
{
	struct radix_tree_preload *rtp;
	struct radix_tree_node *node;
	int ret = -ENOMEM;

354 355 356 357 358 359
	/*
	 * Nodes preloaded by one cgroup can be be used by another cgroup, so
	 * they should never be accounted to any particular memory cgroup.
	 */
	gfp_mask &= ~__GFP_ACCOUNT;

L
Linus Torvalds 已提交
360
	preempt_disable();
361
	rtp = this_cpu_ptr(&radix_tree_preloads);
362
	while (rtp->nr < nr) {
L
Linus Torvalds 已提交
363
		preempt_enable();
C
Christoph Lameter 已提交
364
		node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
L
Linus Torvalds 已提交
365 366 367
		if (node == NULL)
			goto out;
		preempt_disable();
368
		rtp = this_cpu_ptr(&radix_tree_preloads);
369
		if (rtp->nr < nr) {
370 371 372 373
			node->private_data = rtp->nodes;
			rtp->nodes = node;
			rtp->nr++;
		} else {
L
Linus Torvalds 已提交
374
			kmem_cache_free(radix_tree_node_cachep, node);
375
		}
L
Linus Torvalds 已提交
376 377 378 379 380
	}
	ret = 0;
out:
	return ret;
}
381 382 383 384 385 386 387 388

/*
 * Load up this CPU's radix_tree_node buffer with sufficient objects to
 * ensure that the addition of a single element in the tree cannot fail.  On
 * success, return zero, with preemption disabled.  On error, return -ENOMEM
 * with preemption not disabled.
 *
 * To make use of this facility, the radix tree must be initialised without
389
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
390 391 392 393
 */
int radix_tree_preload(gfp_t gfp_mask)
{
	/* Warn on non-sensical use... */
394
	WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
395
	return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
396
}
397
EXPORT_SYMBOL(radix_tree_preload);
L
Linus Torvalds 已提交
398

399 400 401 402 403 404 405
/*
 * The same as above function, except we don't guarantee preloading happens.
 * We do it, if we decide it helps. On success, return zero with preemption
 * disabled. On error, return -ENOMEM with preemption not disabled.
 */
int radix_tree_maybe_preload(gfp_t gfp_mask)
{
406
	if (gfpflags_allow_blocking(gfp_mask))
407
		return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
408 409 410 411 412 413
	/* Preloading doesn't help anything with this gfp mask, skip it */
	preempt_disable();
	return 0;
}
EXPORT_SYMBOL(radix_tree_maybe_preload);

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
/*
 * The same as function above, but preload number of nodes required to insert
 * (1 << order) continuous naturally-aligned elements.
 */
int radix_tree_maybe_preload_order(gfp_t gfp_mask, int order)
{
	unsigned long nr_subtrees;
	int nr_nodes, subtree_height;

	/* Preloading doesn't help anything with this gfp mask, skip it */
	if (!gfpflags_allow_blocking(gfp_mask)) {
		preempt_disable();
		return 0;
	}

	/*
	 * Calculate number and height of fully populated subtrees it takes to
	 * store (1 << order) elements.
	 */
	nr_subtrees = 1 << order;
	for (subtree_height = 0; nr_subtrees > RADIX_TREE_MAP_SIZE;
			subtree_height++)
		nr_subtrees >>= RADIX_TREE_MAP_SHIFT;

	/*
	 * The worst case is zero height tree with a single item at index 0 and
	 * then inserting items starting at ULONG_MAX - (1 << order).
	 *
	 * This requires RADIX_TREE_MAX_PATH nodes to build branch from root to
	 * 0-index item.
	 */
	nr_nodes = RADIX_TREE_MAX_PATH;

	/* Plus branch to fully populated subtrees. */
	nr_nodes += RADIX_TREE_MAX_PATH - subtree_height;

	/* Root node is shared. */
	nr_nodes--;

	/* Plus nodes required to build subtrees. */
	nr_nodes += nr_subtrees * height_to_maxnodes[subtree_height];

	return __radix_tree_preload(gfp_mask, nr_nodes);
}

L
Linus Torvalds 已提交
459
/*
M
Matthew Wilcox 已提交
460
 * The maximum index which can be stored in a radix tree
L
Linus Torvalds 已提交
461
 */
462 463 464 465 466
static inline unsigned long shift_maxindex(unsigned int shift)
{
	return (RADIX_TREE_MAP_SIZE << shift) - 1;
}

467 468
static inline unsigned long node_maxindex(struct radix_tree_node *node)
{
469
	return shift_maxindex(node->shift);
470 471 472 473 474 475 476 477 478
}

static unsigned radix_tree_load_root(struct radix_tree_root *root,
		struct radix_tree_node **nodep, unsigned long *maxindex)
{
	struct radix_tree_node *node = rcu_dereference_raw(root->rnode);

	*nodep = node;

479
	if (likely(radix_tree_is_internal_node(node))) {
480
		node = entry_to_node(node);
481
		*maxindex = node_maxindex(node);
482
		return node->shift + RADIX_TREE_MAP_SHIFT;
483 484 485 486 487 488
	}

	*maxindex = 0;
	return 0;
}

L
Linus Torvalds 已提交
489 490 491
/*
 *	Extend a radix tree so it can store key @index.
 */
492
static int radix_tree_extend(struct radix_tree_root *root,
M
Matthew Wilcox 已提交
493
				unsigned long index, unsigned int shift)
L
Linus Torvalds 已提交
494
{
495
	struct radix_tree_node *slot;
M
Matthew Wilcox 已提交
496
	unsigned int maxshift;
L
Linus Torvalds 已提交
497 498
	int tag;

M
Matthew Wilcox 已提交
499 500 501 502
	/* Figure out what the shift should be.  */
	maxshift = shift;
	while (index > shift_maxindex(maxshift))
		maxshift += RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
503

M
Matthew Wilcox 已提交
504 505
	slot = root->rnode;
	if (!slot)
L
Linus Torvalds 已提交
506 507 508
		goto out;

	do {
M
Matthew Wilcox 已提交
509 510 511
		struct radix_tree_node *node = radix_tree_node_alloc(root);

		if (!node)
L
Linus Torvalds 已提交
512 513 514
			return -ENOMEM;

		/* Propagate the aggregated tag info into the new root */
515
		for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
N
Nick Piggin 已提交
516
			if (root_tag_get(root, tag))
L
Linus Torvalds 已提交
517 518 519
				tag_set(node, tag, 0);
		}

M
Matthew Wilcox 已提交
520 521
		BUG_ON(shift > BITS_PER_LONG);
		node->shift = shift;
522
		node->offset = 0;
L
Linus Torvalds 已提交
523
		node->count = 1;
524
		node->parent = NULL;
525
		if (radix_tree_is_internal_node(slot))
526
			entry_to_node(slot)->parent = node;
527
		node->slots[0] = slot;
528 529
		slot = node_to_entry(node);
		rcu_assign_pointer(root->rnode, slot);
M
Matthew Wilcox 已提交
530 531
		shift += RADIX_TREE_MAP_SHIFT;
	} while (shift <= maxshift);
L
Linus Torvalds 已提交
532
out:
M
Matthew Wilcox 已提交
533
	return maxshift + RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
534 535 536
}

/**
537
 *	__radix_tree_create	-	create a slot in a radix tree
L
Linus Torvalds 已提交
538 539
 *	@root:		radix tree root
 *	@index:		index key
540
 *	@order:		index occupies 2^order aligned slots
541 542
 *	@nodep:		returns node
 *	@slotp:		returns slot
L
Linus Torvalds 已提交
543
 *
544 545 546 547 548 549 550 551
 *	Create, if necessary, and return the node and slot for an item
 *	at position @index in the radix tree @root.
 *
 *	Until there is more than one item in the tree, no nodes are
 *	allocated and @root->rnode is used as a direct slot instead of
 *	pointing to a node, in which case *@nodep will be NULL.
 *
 *	Returns -ENOMEM, or 0 for success.
L
Linus Torvalds 已提交
552
 */
553
int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
554 555
			unsigned order, struct radix_tree_node **nodep,
			void ***slotp)
L
Linus Torvalds 已提交
556
{
557 558
	struct radix_tree_node *node = NULL, *child;
	void **slot = (void **)&root->rnode;
559
	unsigned long maxindex;
560
	unsigned int shift, offset = 0;
561 562
	unsigned long max = index | ((1UL << order) - 1);

563
	shift = radix_tree_load_root(root, &child, &maxindex);
L
Linus Torvalds 已提交
564 565

	/* Make sure the tree is high enough.  */
566
	if (max > maxindex) {
M
Matthew Wilcox 已提交
567
		int error = radix_tree_extend(root, max, shift);
568
		if (error < 0)
L
Linus Torvalds 已提交
569
			return error;
570
		shift = error;
571
		child = root->rnode;
M
Matthew Wilcox 已提交
572
		if (order == shift)
573
			shift += RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
574 575
	}

576
	while (shift > order) {
577
		shift -= RADIX_TREE_MAP_SHIFT;
578
		if (child == NULL) {
L
Linus Torvalds 已提交
579
			/* Have to add a child node.  */
580 581
			child = radix_tree_node_alloc(root);
			if (!child)
L
Linus Torvalds 已提交
582
				return -ENOMEM;
583 584 585 586 587
			child->shift = shift;
			child->offset = offset;
			child->parent = node;
			rcu_assign_pointer(*slot, node_to_entry(child));
			if (node)
L
Linus Torvalds 已提交
588
				node->count++;
589
		} else if (!radix_tree_is_internal_node(child))
590
			break;
L
Linus Torvalds 已提交
591 592

		/* Go a level down */
593
		node = entry_to_node(child);
594
		offset = radix_tree_descend(node, &child, index);
595
		slot = &node->slots[offset];
596 597
	}

598
#ifdef CONFIG_RADIX_TREE_MULTIORDER
599
	/* Insert pointers to the canonical entry */
600
	if (order > shift) {
601
		unsigned i, n = 1 << (order - shift);
602
		offset = offset & ~(n - 1);
603 604
		slot = &node->slots[offset];
		child = node_to_entry(slot);
605
		for (i = 0; i < n; i++) {
606
			if (slot[i])
607 608 609 610
				return -EEXIST;
		}

		for (i = 1; i < n; i++) {
611
			rcu_assign_pointer(slot[i], child);
612 613
			node->count++;
		}
N
Nick Piggin 已提交
614
	}
615
#endif
L
Linus Torvalds 已提交
616

617 618 619
	if (nodep)
		*nodep = node;
	if (slotp)
620
		*slotp = slot;
621 622 623 624
	return 0;
}

/**
625
 *	__radix_tree_insert    -    insert into a radix tree
626 627
 *	@root:		radix tree root
 *	@index:		index key
628
 *	@order:		key covers the 2^order indices around index
629 630 631 632
 *	@item:		item to insert
 *
 *	Insert an item into the radix tree at position @index.
 */
633 634
int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
			unsigned order, void *item)
635 636 637 638 639
{
	struct radix_tree_node *node;
	void **slot;
	int error;

640
	BUG_ON(radix_tree_is_internal_node(item));
641

642
	error = __radix_tree_create(root, index, order, &node, &slot);
643 644 645
	if (error)
		return error;
	if (*slot != NULL)
L
Linus Torvalds 已提交
646
		return -EEXIST;
647
	rcu_assign_pointer(*slot, item);
648

N
Nick Piggin 已提交
649
	if (node) {
650
		unsigned offset = get_slot_offset(node, slot);
N
Nick Piggin 已提交
651
		node->count++;
652 653 654
		BUG_ON(tag_get(node, 0, offset));
		BUG_ON(tag_get(node, 1, offset));
		BUG_ON(tag_get(node, 2, offset));
N
Nick Piggin 已提交
655
	} else {
656
		BUG_ON(root_tags_get(root));
N
Nick Piggin 已提交
657
	}
L
Linus Torvalds 已提交
658 659 660

	return 0;
}
661
EXPORT_SYMBOL(__radix_tree_insert);
L
Linus Torvalds 已提交
662

663 664 665 666 667 668 669 670 671 672 673 674 675
/**
 *	__radix_tree_lookup	-	lookup an item in a radix tree
 *	@root:		radix tree root
 *	@index:		index key
 *	@nodep:		returns node
 *	@slotp:		returns slot
 *
 *	Lookup and return the item at position @index in the radix
 *	tree @root.
 *
 *	Until there is more than one item in the tree, no nodes are
 *	allocated and @root->rnode is used as a direct slot instead of
 *	pointing to a node, in which case *@nodep will be NULL.
676
 */
677 678
void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
			  struct radix_tree_node **nodep, void ***slotp)
L
Linus Torvalds 已提交
679
{
680
	struct radix_tree_node *node, *parent;
681
	unsigned long maxindex;
682
	void **slot;
N
Nick Piggin 已提交
683

684 685 686
 restart:
	parent = NULL;
	slot = (void **)&root->rnode;
687
	radix_tree_load_root(root, &node, &maxindex);
688
	if (index > maxindex)
L
Linus Torvalds 已提交
689 690
		return NULL;

691
	while (radix_tree_is_internal_node(node)) {
692
		unsigned offset;
L
Linus Torvalds 已提交
693

694 695
		if (node == RADIX_TREE_RETRY)
			goto restart;
696
		parent = entry_to_node(node);
697
		offset = radix_tree_descend(parent, &node, index);
698 699
		slot = parent->slots + offset;
	}
L
Linus Torvalds 已提交
700

701 702 703 704 705
	if (nodep)
		*nodep = parent;
	if (slotp)
		*slotp = slot;
	return node;
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
}

/**
 *	radix_tree_lookup_slot    -    lookup a slot in a radix tree
 *	@root:		radix tree root
 *	@index:		index key
 *
 *	Returns:  the slot corresponding to the position @index in the
 *	radix tree @root. This is useful for update-if-exists operations.
 *
 *	This function can be called under rcu_read_lock iff the slot is not
 *	modified by radix_tree_replace_slot, otherwise it must be called
 *	exclusive from other writers. Any dereference of the slot must be done
 *	using radix_tree_deref_slot.
 */
void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
{
723 724 725 726 727
	void **slot;

	if (!__radix_tree_lookup(root, index, NULL, &slot))
		return NULL;
	return slot;
728 729 730 731 732 733 734 735 736
}
EXPORT_SYMBOL(radix_tree_lookup_slot);

/**
 *	radix_tree_lookup    -    perform lookup operation on a radix tree
 *	@root:		radix tree root
 *	@index:		index key
 *
 *	Lookup the item at the position @index in the radix tree @root.
737 738 739 740 741
 *
 *	This function can be called under rcu_read_lock, however the caller
 *	must manage lifetimes of leaf nodes (eg. RCU may also be used to free
 *	them safely). No RCU barriers are required to access or modify the
 *	returned item, however.
742 743 744
 */
void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
{
745
	return __radix_tree_lookup(root, index, NULL, NULL);
L
Linus Torvalds 已提交
746 747 748 749 750 751 752
}
EXPORT_SYMBOL(radix_tree_lookup);

/**
 *	radix_tree_tag_set - set a tag on a radix tree node
 *	@root:		radix tree root
 *	@index:		index key
M
Matthew Wilcox 已提交
753
 *	@tag:		tag index
L
Linus Torvalds 已提交
754
 *
755 756
 *	Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
 *	corresponding to @index in the radix tree.  From
L
Linus Torvalds 已提交
757 758
 *	the root all the way down to the leaf node.
 *
M
Matthew Wilcox 已提交
759
 *	Returns the address of the tagged item.  Setting a tag on a not-present
L
Linus Torvalds 已提交
760 761 762
 *	item is a bug.
 */
void *radix_tree_tag_set(struct radix_tree_root *root,
763
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
764
{
765 766
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
L
Linus Torvalds 已提交
767

768
	radix_tree_load_root(root, &node, &maxindex);
769
	BUG_ON(index > maxindex);
L
Linus Torvalds 已提交
770

771
	while (radix_tree_is_internal_node(node)) {
772
		unsigned offset;
L
Linus Torvalds 已提交
773

774
		parent = entry_to_node(node);
775
		offset = radix_tree_descend(parent, &node, index);
776 777 778 779
		BUG_ON(!node);

		if (!tag_get(parent, tag, offset))
			tag_set(parent, tag, offset);
L
Linus Torvalds 已提交
780 781
	}

N
Nick Piggin 已提交
782
	/* set the root's tag bit */
783
	if (!root_tag_get(root, tag))
N
Nick Piggin 已提交
784 785
		root_tag_set(root, tag);

786
	return node;
L
Linus Torvalds 已提交
787 788 789
}
EXPORT_SYMBOL(radix_tree_tag_set);

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
static void node_tag_clear(struct radix_tree_root *root,
				struct radix_tree_node *node,
				unsigned int tag, unsigned int offset)
{
	while (node) {
		if (!tag_get(node, tag, offset))
			return;
		tag_clear(node, tag, offset);
		if (any_tag_set(node, tag))
			return;

		offset = node->offset;
		node = node->parent;
	}

	/* clear the root's tag bit */
	if (root_tag_get(root, tag))
		root_tag_clear(root, tag);
}

L
Linus Torvalds 已提交
810 811 812 813
/**
 *	radix_tree_tag_clear - clear a tag on a radix tree node
 *	@root:		radix tree root
 *	@index:		index key
M
Matthew Wilcox 已提交
814
 *	@tag:		tag index
L
Linus Torvalds 已提交
815
 *
816
 *	Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
M
Matthew Wilcox 已提交
817 818
 *	corresponding to @index in the radix tree.  If this causes
 *	the leaf node to have no tags set then clear the tag in the
L
Linus Torvalds 已提交
819 820 821 822 823 824
 *	next-to-leaf node, etc.
 *
 *	Returns the address of the tagged item on success, else NULL.  ie:
 *	has the same return value and semantics as radix_tree_lookup().
 */
void *radix_tree_tag_clear(struct radix_tree_root *root,
825
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
826
{
827 828
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
829
	int uninitialized_var(offset);
L
Linus Torvalds 已提交
830

831
	radix_tree_load_root(root, &node, &maxindex);
832 833
	if (index > maxindex)
		return NULL;
L
Linus Torvalds 已提交
834

835
	parent = NULL;
L
Linus Torvalds 已提交
836

837
	while (radix_tree_is_internal_node(node)) {
838
		parent = entry_to_node(node);
839
		offset = radix_tree_descend(parent, &node, index);
L
Linus Torvalds 已提交
840 841
	}

842 843
	if (node)
		node_tag_clear(root, parent, tag, offset);
L
Linus Torvalds 已提交
844

845
	return node;
L
Linus Torvalds 已提交
846 847 848 849
}
EXPORT_SYMBOL(radix_tree_tag_clear);

/**
850 851 852
 * radix_tree_tag_get - get a tag on a radix tree node
 * @root:		radix tree root
 * @index:		index key
M
Matthew Wilcox 已提交
853
 * @tag:		tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
854
 *
855
 * Return values:
L
Linus Torvalds 已提交
856
 *
N
Nick Piggin 已提交
857 858
 *  0: tag not present or not set
 *  1: tag set
859 860 861 862
 *
 * Note that the return value of this function may not be relied on, even if
 * the RCU lock is held, unless tag modification and node deletion are excluded
 * from concurrency.
L
Linus Torvalds 已提交
863 864
 */
int radix_tree_tag_get(struct radix_tree_root *root,
865
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
866
{
867 868
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
L
Linus Torvalds 已提交
869

N
Nick Piggin 已提交
870 871 872
	if (!root_tag_get(root, tag))
		return 0;

873
	radix_tree_load_root(root, &node, &maxindex);
874 875
	if (index > maxindex)
		return 0;
876 877 878
	if (node == NULL)
		return 0;

879
	while (radix_tree_is_internal_node(node)) {
880
		unsigned offset;
L
Linus Torvalds 已提交
881

882
		parent = entry_to_node(node);
883
		offset = radix_tree_descend(parent, &node, index);
L
Linus Torvalds 已提交
884

885
		if (!node)
L
Linus Torvalds 已提交
886
			return 0;
887
		if (!tag_get(parent, tag, offset))
888
			return 0;
889 890
		if (node == RADIX_TREE_RETRY)
			break;
L
Linus Torvalds 已提交
891
	}
892 893

	return 1;
L
Linus Torvalds 已提交
894 895 896
}
EXPORT_SYMBOL(radix_tree_tag_get);

897 898 899 900 901 902 903 904
static inline void __set_iter_shift(struct radix_tree_iter *iter,
					unsigned int shift)
{
#ifdef CONFIG_RADIX_TREE_MULTIORDER
	iter->shift = shift;
#endif
}

905 906 907 908 909 910 911 912 913 914 915
/**
 * radix_tree_next_chunk - find next chunk of slots for iteration
 *
 * @root:	radix tree root
 * @iter:	iterator state
 * @flags:	RADIX_TREE_ITER_* flags and tag index
 * Returns:	pointer to chunk first slot, or NULL if iteration is over
 */
void **radix_tree_next_chunk(struct radix_tree_root *root,
			     struct radix_tree_iter *iter, unsigned flags)
{
916
	unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
M
Matthew Wilcox 已提交
917
	struct radix_tree_node *node, *child;
918
	unsigned long index, offset, maxindex;
919 920 921 922 923 924 925 926 927

	if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
		return NULL;

	/*
	 * Catch next_index overflow after ~0UL. iter->index never overflows
	 * during iterating; it can be zero only at the beginning.
	 * And we cannot overflow iter->next_index in a single step,
	 * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
928 929 930
	 *
	 * This condition also used by radix_tree_next_slot() to stop
	 * contiguous iterating, and forbid swithing to the next chunk.
931 932 933 934 935
	 */
	index = iter->next_index;
	if (!index && iter->index)
		return NULL;

936
 restart:
937
	radix_tree_load_root(root, &child, &maxindex);
938 939
	if (index > maxindex)
		return NULL;
M
Matthew Wilcox 已提交
940 941
	if (!child)
		return NULL;
942

M
Matthew Wilcox 已提交
943
	if (!radix_tree_is_internal_node(child)) {
944
		/* Single-slot tree */
945 946
		iter->index = index;
		iter->next_index = maxindex + 1;
947
		iter->tags = 1;
M
Matthew Wilcox 已提交
948
		__set_iter_shift(iter, 0);
949
		return (void **)&root->rnode;
M
Matthew Wilcox 已提交
950
	}
951

M
Matthew Wilcox 已提交
952 953
	do {
		node = entry_to_node(child);
954
		offset = radix_tree_descend(node, &child, index);
955

956
		if ((flags & RADIX_TREE_ITER_TAGGED) ?
M
Matthew Wilcox 已提交
957
				!tag_get(node, tag, offset) : !child) {
958 959 960 961 962 963 964 965 966 967 968
			/* Hole detected */
			if (flags & RADIX_TREE_ITER_CONTIG)
				return NULL;

			if (flags & RADIX_TREE_ITER_TAGGED)
				offset = radix_tree_find_next_bit(
						node->tags[tag],
						RADIX_TREE_MAP_SIZE,
						offset + 1);
			else
				while (++offset	< RADIX_TREE_MAP_SIZE) {
969 970 971 972
					void *slot = node->slots[offset];
					if (is_sibling_entry(node, slot))
						continue;
					if (slot)
973 974
						break;
				}
M
Matthew Wilcox 已提交
975
			index &= ~node_maxindex(node);
976
			index += offset << node->shift;
977 978 979 980 981
			/* Overflow after ~0UL */
			if (!index)
				return NULL;
			if (offset == RADIX_TREE_MAP_SIZE)
				goto restart;
M
Matthew Wilcox 已提交
982
			child = rcu_dereference_raw(node->slots[offset]);
983 984
		}

M
Matthew Wilcox 已提交
985
		if ((child == NULL) || (child == RADIX_TREE_RETRY))
986
			goto restart;
M
Matthew Wilcox 已提交
987
	} while (radix_tree_is_internal_node(child));
988 989

	/* Update the iterator state */
M
Matthew Wilcox 已提交
990 991
	iter->index = (index &~ node_maxindex(node)) | (offset << node->shift);
	iter->next_index = (index | node_maxindex(node)) + 1;
992
	__set_iter_shift(iter, node->shift);
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

	/* Construct iter->tags bit-mask from node->tags[tag] array */
	if (flags & RADIX_TREE_ITER_TAGGED) {
		unsigned tag_long, tag_bit;

		tag_long = offset / BITS_PER_LONG;
		tag_bit  = offset % BITS_PER_LONG;
		iter->tags = node->tags[tag][tag_long] >> tag_bit;
		/* This never happens if RADIX_TREE_TAG_LONGS == 1 */
		if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
			/* Pick tags from next element */
			if (tag_bit)
				iter->tags |= node->tags[tag][tag_long + 1] <<
						(BITS_PER_LONG - tag_bit);
			/* Clip chunk size, here only BITS_PER_LONG tags */
			iter->next_index = index + BITS_PER_LONG;
		}
	}

	return node->slots + offset;
}
EXPORT_SYMBOL(radix_tree_next_chunk);

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
/**
 * radix_tree_range_tag_if_tagged - for each item in given range set given
 *				   tag if item has another tag set
 * @root:		radix tree root
 * @first_indexp:	pointer to a starting index of a range to scan
 * @last_index:		last index of a range to scan
 * @nr_to_tag:		maximum number items to tag
 * @iftag:		tag index to test
 * @settag:		tag index to set if tested tag is set
 *
 * This function scans range of radix tree from first_index to last_index
 * (inclusive).  For each item in the range if iftag is set, the function sets
 * also settag. The function stops either after tagging nr_to_tag items or
 * after reaching last_index.
 *
1031 1032 1033 1034 1035 1036 1037
 * The tags must be set from the leaf level only and propagated back up the
 * path to the root. We must do this so that we resolve the full path before
 * setting any tags on intermediate nodes. If we set tags as we descend, then
 * we can get to the leaf node and find that the index that has the iftag
 * set is outside the range we are scanning. This reults in dangling tags and
 * can lead to problems with later tag operations (e.g. livelocks on lookups).
 *
M
Matthew Wilcox 已提交
1038
 * The function returns the number of leaves where the tag was set and sets
1039
 * *first_indexp to the first unscanned index.
1040 1041
 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
 * be prepared to handle that.
1042 1043 1044 1045 1046 1047
 */
unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
		unsigned long *first_indexp, unsigned long last_index,
		unsigned long nr_to_tag,
		unsigned int iftag, unsigned int settag)
{
1048
	struct radix_tree_node *parent, *node, *child;
1049
	unsigned long maxindex;
1050 1051
	unsigned long tagged = 0;
	unsigned long index = *first_indexp;
1052

1053
	radix_tree_load_root(root, &child, &maxindex);
1054
	last_index = min(last_index, maxindex);
1055 1056 1057 1058 1059 1060 1061 1062
	if (index > last_index)
		return 0;
	if (!nr_to_tag)
		return 0;
	if (!root_tag_get(root, iftag)) {
		*first_indexp = last_index + 1;
		return 0;
	}
1063
	if (!radix_tree_is_internal_node(child)) {
1064 1065 1066 1067 1068
		*first_indexp = last_index + 1;
		root_tag_set(root, settag);
		return 1;
	}

1069
	node = entry_to_node(child);
1070 1071

	for (;;) {
1072
		unsigned offset = radix_tree_descend(node, &child, index);
1073
		if (!child)
1074
			goto next;
1075
		if (!tag_get(node, iftag, offset))
1076
			goto next;
1077
		/* Sibling slots never have tags set on them */
1078 1079
		if (radix_tree_is_internal_node(child)) {
			node = entry_to_node(child);
1080
			continue;
1081 1082 1083
		}

		/* tag the leaf */
1084 1085
		tagged++;
		tag_set(node, settag, offset);
1086 1087

		/* walk back up the path tagging interior nodes */
1088 1089 1090 1091 1092 1093
		parent = node;
		for (;;) {
			offset = parent->offset;
			parent = parent->parent;
			if (!parent)
				break;
1094
			/* stop if we find a node with the tag already set */
1095
			if (tag_get(parent, settag, offset))
1096
				break;
1097
			tag_set(parent, settag, offset);
1098
		}
1099
 next:
1100 1101
		/* Go to next entry in node */
		index = ((index >> node->shift) + 1) << node->shift;
1102 1103
		/* Overflow can happen when last_index is ~0UL... */
		if (index > last_index || !index)
1104
			break;
1105
		offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
1106
		while (offset == 0) {
1107 1108 1109 1110 1111
			/*
			 * We've fully scanned this node. Go up. Because
			 * last_index is guaranteed to be in the tree, what
			 * we do below cannot wander astray.
			 */
1112
			node = node->parent;
1113
			offset = (index >> node->shift) & RADIX_TREE_MAP_MASK;
1114
		}
1115 1116 1117 1118
		if (is_sibling_entry(node, node->slots[offset]))
			goto next;
		if (tagged >= nr_to_tag)
			break;
1119 1120
	}
	/*
1121 1122
	 * We need not to tag the root tag if there is no tag which is set with
	 * settag within the range from *first_indexp to last_index.
1123
	 */
1124 1125
	if (tagged > 0)
		root_tag_set(root, settag);
1126 1127 1128 1129 1130 1131
	*first_indexp = index;

	return tagged;
}
EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);

L
Linus Torvalds 已提交
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
/**
 *	radix_tree_gang_lookup - perform multiple lookup on a radix tree
 *	@root:		radix tree root
 *	@results:	where the results of the lookup are placed
 *	@first_index:	start the lookup from this key
 *	@max_items:	place up to this many items at *results
 *
 *	Performs an index-ascending scan of the tree for present items.  Places
 *	them at *@results and returns the number of items which were placed at
 *	*@results.
 *
 *	The implementation is naive.
1144 1145 1146
 *
 *	Like radix_tree_lookup, radix_tree_gang_lookup may be called under
 *	rcu_read_lock. In this case, rather than the returned results being
M
Matthew Wilcox 已提交
1147 1148 1149 1150
 *	an atomic snapshot of the tree at a single point in time, the
 *	semantics of an RCU protected gang lookup are as though multiple
 *	radix_tree_lookups have been issued in individual locks, and results
 *	stored in 'results'.
L
Linus Torvalds 已提交
1151 1152 1153 1154 1155
 */
unsigned int
radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
			unsigned long first_index, unsigned int max_items)
{
1156 1157 1158
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1159

1160
	if (unlikely(!max_items))
1161
		return 0;
L
Linus Torvalds 已提交
1162

1163
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
1164
		results[ret] = rcu_dereference_raw(*slot);
1165 1166
		if (!results[ret])
			continue;
1167
		if (radix_tree_is_internal_node(results[ret])) {
1168 1169 1170
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1171
		if (++ret == max_items)
L
Linus Torvalds 已提交
1172 1173
			break;
	}
1174

L
Linus Torvalds 已提交
1175 1176 1177 1178
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup);

1179 1180 1181 1182
/**
 *	radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
 *	@root:		radix tree root
 *	@results:	where the results of the lookup are placed
1183
 *	@indices:	where their indices should be placed (but usually NULL)
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
 *	@first_index:	start the lookup from this key
 *	@max_items:	place up to this many items at *results
 *
 *	Performs an index-ascending scan of the tree for present items.  Places
 *	their slots at *@results and returns the number of items which were
 *	placed at *@results.
 *
 *	The implementation is naive.
 *
 *	Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
 *	be dereferenced with radix_tree_deref_slot, and if using only RCU
 *	protection, radix_tree_deref_slot may fail requiring a retry.
 */
unsigned int
1198 1199
radix_tree_gang_lookup_slot(struct radix_tree_root *root,
			void ***results, unsigned long *indices,
1200 1201
			unsigned long first_index, unsigned int max_items)
{
1202 1203 1204
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1205

1206
	if (unlikely(!max_items))
1207 1208
		return 0;

1209 1210
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
		results[ret] = slot;
1211
		if (indices)
1212 1213
			indices[ret] = iter.index;
		if (++ret == max_items)
1214 1215 1216 1217 1218 1219 1220
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_slot);

L
Linus Torvalds 已提交
1221 1222 1223 1224 1225 1226 1227
/**
 *	radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
 *	                             based on a tag
 *	@root:		radix tree root
 *	@results:	where the results of the lookup are placed
 *	@first_index:	start the lookup from this key
 *	@max_items:	place up to this many items at *results
1228
 *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
1229 1230 1231 1232 1233 1234 1235
 *
 *	Performs an index-ascending scan of the tree for present items which
 *	have the tag indexed by @tag set.  Places the items at *@results and
 *	returns the number of items which were placed at *@results.
 */
unsigned int
radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
1236 1237
		unsigned long first_index, unsigned int max_items,
		unsigned int tag)
L
Linus Torvalds 已提交
1238
{
1239 1240 1241
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
N
Nick Piggin 已提交
1242

1243
	if (unlikely(!max_items))
1244 1245
		return 0;

1246
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1247
		results[ret] = rcu_dereference_raw(*slot);
1248 1249
		if (!results[ret])
			continue;
1250
		if (radix_tree_is_internal_node(results[ret])) {
1251 1252 1253
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1254
		if (++ret == max_items)
L
Linus Torvalds 已提交
1255 1256
			break;
	}
1257

L
Linus Torvalds 已提交
1258 1259 1260 1261
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag);

1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/**
 *	radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
 *					  radix tree based on a tag
 *	@root:		radix tree root
 *	@results:	where the results of the lookup are placed
 *	@first_index:	start the lookup from this key
 *	@max_items:	place up to this many items at *results
 *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
 *
 *	Performs an index-ascending scan of the tree for present items which
 *	have the tag indexed by @tag set.  Places the slots at *@results and
 *	returns the number of slots which were placed at *@results.
 */
unsigned int
radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
		unsigned long first_index, unsigned int max_items,
		unsigned int tag)
{
1280 1281 1282
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1283

1284
	if (unlikely(!max_items))
1285 1286
		return 0;

1287 1288 1289
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
		results[ret] = slot;
		if (++ret == max_items)
1290 1291 1292 1293 1294 1295 1296
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);

1297 1298 1299
#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
#include <linux/sched.h> /* for cond_resched() */

1300 1301 1302 1303 1304
struct locate_info {
	unsigned long found_index;
	bool stop;
};

1305 1306 1307 1308
/*
 * This linear search is at present only useful to shmem_unuse_inode().
 */
static unsigned long __locate(struct radix_tree_node *slot, void *item,
1309
			      unsigned long index, struct locate_info *info)
1310 1311 1312
{
	unsigned long i;

1313
	do {
1314
		unsigned int shift = slot->shift;
1315

1316 1317 1318 1319 1320 1321 1322
		for (i = (index >> shift) & RADIX_TREE_MAP_MASK;
		     i < RADIX_TREE_MAP_SIZE;
		     i++, index += (1UL << shift)) {
			struct radix_tree_node *node =
					rcu_dereference_raw(slot->slots[i]);
			if (node == RADIX_TREE_RETRY)
				goto out;
1323
			if (!radix_tree_is_internal_node(node)) {
1324 1325 1326 1327 1328 1329
				if (node == item) {
					info->found_index = index;
					info->stop = true;
					goto out;
				}
				continue;
1330
			}
1331
			node = entry_to_node(node);
1332 1333 1334 1335
			if (is_sibling_entry(slot, node))
				continue;
			slot = node;
			break;
1336
		}
1337
	} while (i < RADIX_TREE_MAP_SIZE);
1338 1339

out:
1340 1341
	if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
		info->stop = true;
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
	return index;
}

/**
 *	radix_tree_locate_item - search through radix tree for item
 *	@root:		radix tree root
 *	@item:		item to be found
 *
 *	Returns index where item was found, or -1 if not found.
 *	Caller must hold no lock (since this time-consuming function needs
 *	to be preemptible), and must check afterwards if item is still there.
 */
unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
{
	struct radix_tree_node *node;
	unsigned long max_index;
	unsigned long cur_index = 0;
1359 1360 1361 1362
	struct locate_info info = {
		.found_index = -1,
		.stop = false,
	};
1363 1364 1365 1366

	do {
		rcu_read_lock();
		node = rcu_dereference_raw(root->rnode);
1367
		if (!radix_tree_is_internal_node(node)) {
1368 1369
			rcu_read_unlock();
			if (node == item)
1370
				info.found_index = 0;
1371 1372 1373
			break;
		}

1374
		node = entry_to_node(node);
1375 1376

		max_index = node_maxindex(node);
1377 1378
		if (cur_index > max_index) {
			rcu_read_unlock();
1379
			break;
1380
		}
1381

1382
		cur_index = __locate(node, item, cur_index, &info);
1383 1384
		rcu_read_unlock();
		cond_resched();
1385
	} while (!info.stop && cur_index <= max_index);
1386

1387
	return info.found_index;
1388 1389 1390 1391 1392 1393 1394
}
#else
unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
{
	return -1;
}
#endif /* CONFIG_SHMEM && CONFIG_SWAP */
1395

1396
/**
M
Matthew Wilcox 已提交
1397
 *	radix_tree_shrink    -    shrink radix tree to minimum height
1398 1399
 *	@root		radix tree root
 */
1400
static inline bool radix_tree_shrink(struct radix_tree_root *root)
1401
{
1402 1403
	bool shrunk = false;

M
Matthew Wilcox 已提交
1404
	for (;;) {
1405 1406
		struct radix_tree_node *node = root->rnode;
		struct radix_tree_node *child;
1407

1408
		if (!radix_tree_is_internal_node(node))
M
Matthew Wilcox 已提交
1409
			break;
1410
		node = entry_to_node(node);
N
Nick Piggin 已提交
1411 1412 1413

		/*
		 * The candidate node has more than one child, or its child
M
Matthew Wilcox 已提交
1414 1415
		 * is not at the leftmost slot, or the child is a multiorder
		 * entry, we cannot shrink.
N
Nick Piggin 已提交
1416
		 */
1417
		if (node->count != 1)
N
Nick Piggin 已提交
1418
			break;
1419 1420
		child = node->slots[0];
		if (!child)
N
Nick Piggin 已提交
1421
			break;
1422
		if (!radix_tree_is_internal_node(child) && node->shift)
1423 1424
			break;

1425 1426
		if (radix_tree_is_internal_node(child))
			entry_to_node(child)->parent = NULL;
N
Nick Piggin 已提交
1427

1428 1429
		/*
		 * We don't need rcu_assign_pointer(), since we are simply
N
Nick Piggin 已提交
1430 1431
		 * moving the node from one part of the tree to another: if it
		 * was safe to dereference the old pointer to it
1432
		 * (node->slots[0]), it will be safe to dereference the new
N
Nick Piggin 已提交
1433
		 * one (root->rnode) as far as dependent read barriers go.
1434
		 */
1435
		root->rnode = child;
N
Nick Piggin 已提交
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446

		/*
		 * We have a dilemma here. The node's slot[0] must not be
		 * NULLed in case there are concurrent lookups expecting to
		 * find the item. However if this was a bottom-level node,
		 * then it may be subject to the slot pointer being visible
		 * to callers dereferencing it. If item corresponding to
		 * slot[0] is subsequently deleted, these callers would expect
		 * their slot to become empty sooner or later.
		 *
		 * For example, lockless pagecache will look up a slot, deref
M
Matthew Wilcox 已提交
1447
		 * the page pointer, and if the page has 0 refcount it means it
N
Nick Piggin 已提交
1448 1449 1450 1451 1452 1453 1454
		 * was concurrently deleted from pagecache so try the deref
		 * again. Fortunately there is already a requirement for logic
		 * to retry the entire slot lookup -- the indirect pointer
		 * problem (replacing direct root node with an indirect pointer
		 * also results in a stale slot). So tag the slot as indirect
		 * to force callers to retry.
		 */
1455 1456
		if (!radix_tree_is_internal_node(child))
			node->slots[0] = RADIX_TREE_RETRY;
N
Nick Piggin 已提交
1457

1458
		radix_tree_node_free(node);
1459
		shrunk = true;
1460
	}
1461 1462

	return shrunk;
1463 1464
}

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
/**
 *	__radix_tree_delete_node    -    try to free node after clearing a slot
 *	@root:		radix tree root
 *	@node:		node containing @index
 *
 *	After clearing the slot at @index in @node from radix tree
 *	rooted at @root, call this function to attempt freeing the
 *	node and shrinking the tree.
 *
 *	Returns %true if @node was freed, %false otherwise.
 */
1476
bool __radix_tree_delete_node(struct radix_tree_root *root,
1477 1478 1479 1480 1481 1482 1483 1484
			      struct radix_tree_node *node)
{
	bool deleted = false;

	do {
		struct radix_tree_node *parent;

		if (node->count) {
1485
			if (node == entry_to_node(root->rnode))
1486
				deleted |= radix_tree_shrink(root);
1487 1488 1489 1490 1491
			return deleted;
		}

		parent = node->parent;
		if (parent) {
1492
			parent->slots[node->offset] = NULL;
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
			parent->count--;
		} else {
			root_tag_clear_all(root);
			root->rnode = NULL;
		}

		radix_tree_node_free(node);
		deleted = true;

		node = parent;
	} while (node);

	return deleted;
}

1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
static inline void delete_sibling_entries(struct radix_tree_node *node,
					void *ptr, unsigned offset)
{
#ifdef CONFIG_RADIX_TREE_MULTIORDER
	int i;
	for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
		if (node->slots[offset + i] != ptr)
			break;
		node->slots[offset + i] = NULL;
		node->count--;
	}
#endif
}

L
Linus Torvalds 已提交
1522
/**
1523
 *	radix_tree_delete_item    -    delete an item from a radix tree
L
Linus Torvalds 已提交
1524 1525
 *	@root:		radix tree root
 *	@index:		index key
1526
 *	@item:		expected item
L
Linus Torvalds 已提交
1527
 *
1528
 *	Remove @item at @index from the radix tree rooted at @root.
L
Linus Torvalds 已提交
1529
 *
1530 1531
 *	Returns the address of the deleted item, or NULL if it was not present
 *	or the entry at the given @index was not @item.
L
Linus Torvalds 已提交
1532
 */
1533 1534
void *radix_tree_delete_item(struct radix_tree_root *root,
			     unsigned long index, void *item)
L
Linus Torvalds 已提交
1535
{
1536
	struct radix_tree_node *node;
1537
	unsigned int offset;
1538 1539
	void **slot;
	void *entry;
1540
	int tag;
L
Linus Torvalds 已提交
1541

1542 1543 1544
	entry = __radix_tree_lookup(root, index, &node, &slot);
	if (!entry)
		return NULL;
L
Linus Torvalds 已提交
1545

1546 1547 1548 1549
	if (item && entry != item)
		return NULL;

	if (!node) {
N
Nick Piggin 已提交
1550 1551
		root_tag_clear_all(root);
		root->rnode = NULL;
1552
		return entry;
N
Nick Piggin 已提交
1553
	}
L
Linus Torvalds 已提交
1554

1555
	offset = get_slot_offset(node, slot);
1556

1557 1558 1559
	/* Clear all tags associated with the item to be deleted.  */
	for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
		node_tag_clear(root, node, tag, offset);
L
Linus Torvalds 已提交
1560

1561
	delete_sibling_entries(node, node_to_entry(slot), offset);
1562 1563
	node->slots[offset] = NULL;
	node->count--;
1564

1565
	__radix_tree_delete_node(root, node);
N
Nick Piggin 已提交
1566

1567
	return entry;
L
Linus Torvalds 已提交
1568
}
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
EXPORT_SYMBOL(radix_tree_delete_item);

/**
 *	radix_tree_delete    -    delete an item from a radix tree
 *	@root:		radix tree root
 *	@index:		index key
 *
 *	Remove the item at @index from the radix tree rooted at @root.
 *
 *	Returns the address of the deleted item, or NULL if it was not present.
 */
void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
{
	return radix_tree_delete_item(root, index, NULL);
}
L
Linus Torvalds 已提交
1584 1585
EXPORT_SYMBOL(radix_tree_delete);

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
struct radix_tree_node *radix_tree_replace_clear_tags(
			struct radix_tree_root *root,
			unsigned long index, void *entry)
{
	struct radix_tree_node *node;
	void **slot;

	__radix_tree_lookup(root, index, &node, &slot);

	if (node) {
		unsigned int tag, offset = get_slot_offset(node, slot);
		for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
			node_tag_clear(root, node, tag, offset);
	} else {
		/* Clear root node tags */
		root->gfp_mask &= __GFP_BITS_MASK;
	}

	radix_tree_replace_slot(slot, entry);
	return node;
}

L
Linus Torvalds 已提交
1608 1609 1610 1611 1612
/**
 *	radix_tree_tagged - test whether any items in the tree are tagged
 *	@root:		radix tree root
 *	@tag:		tag to test
 */
1613
int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
L
Linus Torvalds 已提交
1614
{
N
Nick Piggin 已提交
1615
	return root_tag_get(root, tag);
L
Linus Torvalds 已提交
1616 1617 1618 1619
}
EXPORT_SYMBOL(radix_tree_tagged);

static void
1620
radix_tree_node_ctor(void *arg)
L
Linus Torvalds 已提交
1621
{
1622 1623 1624 1625
	struct radix_tree_node *node = arg;

	memset(node, 0, sizeof(*node));
	INIT_LIST_HEAD(&node->private_list);
L
Linus Torvalds 已提交
1626 1627
}

1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
static __init unsigned long __maxindex(unsigned int height)
{
	unsigned int width = height * RADIX_TREE_MAP_SHIFT;
	int shift = RADIX_TREE_INDEX_BITS - width;

	if (shift < 0)
		return ~0UL;
	if (shift >= BITS_PER_LONG)
		return 0UL;
	return ~0UL >> shift;
}

static __init void radix_tree_init_maxnodes(void)
{
	unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1];
	unsigned int i, j;

	for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
		height_to_maxindex[i] = __maxindex(i);
	for (i = 0; i < ARRAY_SIZE(height_to_maxnodes); i++) {
		for (j = i; j > 0; j--)
			height_to_maxnodes[i] += height_to_maxindex[j - 1] + 1;
	}
}

L
Linus Torvalds 已提交
1653
static int radix_tree_callback(struct notifier_block *nfb,
M
Matthew Wilcox 已提交
1654
				unsigned long action, void *hcpu)
L
Linus Torvalds 已提交
1655
{
M
Matthew Wilcox 已提交
1656 1657 1658 1659 1660 1661 1662 1663
	int cpu = (long)hcpu;
	struct radix_tree_preload *rtp;
	struct radix_tree_node *node;

	/* Free per-cpu pool of preloaded nodes */
	if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
		rtp = &per_cpu(radix_tree_preloads, cpu);
		while (rtp->nr) {
1664 1665 1666 1667
			node = rtp->nodes;
			rtp->nodes = node->private_data;
			kmem_cache_free(radix_tree_node_cachep, node);
			rtp->nr--;
M
Matthew Wilcox 已提交
1668 1669 1670
		}
	}
	return NOTIFY_OK;
L
Linus Torvalds 已提交
1671 1672 1673 1674 1675 1676
}

void __init radix_tree_init(void)
{
	radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
			sizeof(struct radix_tree_node), 0,
C
Christoph Lameter 已提交
1677 1678
			SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
			radix_tree_node_ctor);
1679
	radix_tree_init_maxnodes();
L
Linus Torvalds 已提交
1680 1681
	hotcpu_notifier(radix_tree_callback, 0);
}