radix-tree.c 44.2 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
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * 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>
26
#include <linux/export.h>
L
Linus Torvalds 已提交
27 28 29
#include <linux/radix-tree.h>
#include <linux/percpu.h>
#include <linux/slab.h>
30
#include <linux/kmemleak.h>
L
Linus Torvalds 已提交
31 32 33 34
#include <linux/notifier.h>
#include <linux/cpu.h>
#include <linux/string.h>
#include <linux/bitops.h>
35
#include <linux/rcupdate.h>
36
#include <linux/preempt.h>		/* in_interrupt() */
L
Linus Torvalds 已提交
37 38


39 40 41 42 43
/*
 * The height_to_maxindex array needs to be one deeper than the maximum
 * path as height 0 holds only 1 entry.
 */
static unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1] __read_mostly;
L
Linus Torvalds 已提交
44 45 46 47

/*
 * Radix tree node cache.
 */
48
static struct kmem_cache *radix_tree_node_cachep;
L
Linus Torvalds 已提交
49

50 51 52 53 54 55 56 57 58 59 60 61 62
/*
 * 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 已提交
63 64 65 66 67
/*
 * Per-cpu pool of preloaded nodes
 */
struct radix_tree_preload {
	int nr;
68 69
	/* nodes->private_data points to next preallocated node */
	struct radix_tree_node *nodes;
L
Linus Torvalds 已提交
70
};
71
static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
L
Linus Torvalds 已提交
72

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

78 79
#define RADIX_TREE_RETRY	ptr_to_indirect(NULL)

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
#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;
}

static unsigned radix_tree_descend(struct radix_tree_node *parent,
				struct radix_tree_node **nodep, unsigned offset)
{
	void **entry = rcu_dereference_raw(parent->slots[offset]);

#ifdef CONFIG_RADIX_TREE_MULTIORDER
	if (radix_tree_is_indirect_ptr(entry)) {
		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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
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));
}

static inline void root_tag_clear(struct radix_tree_root *root, unsigned int tag)
{
	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)
{
	return (__force unsigned)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
}

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 174 175 176 177 178 179 180
/*
 * 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)
{
	int idx;
	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;
}

M
Matthew Wilcox 已提交
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
#if 0
static void dump_node(void *slot, int height, int offset)
{
	struct radix_tree_node *node;
	int i;

	if (!slot)
		return;

	if (height == 0) {
		pr_debug("radix entry %p offset %d\n", slot, offset);
		return;
	}

	node = indirect_to_ptr(slot);
	pr_debug("radix node: %p offset %d tags %lx %lx %lx path %x count %d parent %p\n",
		slot, offset, node->tags[0][0], node->tags[1][0],
		node->tags[2][0], node->path, node->count, node->parent);

	for (i = 0; i < RADIX_TREE_MAP_SIZE; i++)
		dump_node(node->slots[i], height - 1, i);
}

/* For debug */
static void radix_tree_dump(struct radix_tree_root *root)
{
	pr_debug("radix root: %p height %d rnode %p tags %x\n",
			root, root->height, root->rnode,
			root->gfp_mask >> __GFP_BITS_SHIFT);
	if (!radix_tree_is_indirect_ptr(root->rnode))
		return;
	dump_node(root->rnode, root->height, 0);
}
#endif

L
Linus Torvalds 已提交
253 254 255 256 257 258 259
/*
 * 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)
{
260
	struct radix_tree_node *ret = NULL;
N
Nick Piggin 已提交
261
	gfp_t gfp_mask = root_gfp_mask(root);
L
Linus Torvalds 已提交
262

263 264 265 266 267
	/*
	 * Preload code isn't irq safe and it doesn't make sence to use
	 * preloading in the interrupt anyway as all the allocations have to
	 * be atomic. So just do normal allocation when in interrupt.
	 */
268
	if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
L
Linus Torvalds 已提交
269 270
		struct radix_tree_preload *rtp;

271 272 273 274 275 276 277 278 279
		/*
		 * Even if the caller has preloaded, try to allocate from the
		 * cache first for the new node to get accounted.
		 */
		ret = kmem_cache_alloc(radix_tree_node_cachep,
				       gfp_mask | __GFP_ACCOUNT | __GFP_NOWARN);
		if (ret)
			goto out;

280 281 282 283 284
		/*
		 * Provided the caller has preloaded here, we will always
		 * succeed in getting a node here (and never reach
		 * kmem_cache_alloc)
		 */
285
		rtp = this_cpu_ptr(&radix_tree_preloads);
L
Linus Torvalds 已提交
286
		if (rtp->nr) {
287 288 289
			ret = rtp->nodes;
			rtp->nodes = ret->private_data;
			ret->private_data = NULL;
L
Linus Torvalds 已提交
290 291
			rtp->nr--;
		}
292 293 294 295 296
		/*
		 * Update the allocation stack trace as this is more useful
		 * for debugging.
		 */
		kmemleak_update_trace(ret);
297
		goto out;
L
Linus Torvalds 已提交
298
	}
299 300 301
	ret = kmem_cache_alloc(radix_tree_node_cachep,
			       gfp_mask | __GFP_ACCOUNT);
out:
N
Nick Piggin 已提交
302
	BUG_ON(radix_tree_is_indirect_ptr(ret));
L
Linus Torvalds 已提交
303 304 305
	return ret;
}

306 307 308 309
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);
310
	int i;
311 312 313 314 315 316

	/*
	 * 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.
	 */
317 318 319
	for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
		tag_clear(node, i, 0);

320 321 322
	node->slots[0] = NULL;
	node->count = 0;

323 324 325
	kmem_cache_free(radix_tree_node_cachep, node);
}

L
Linus Torvalds 已提交
326 327 328
static inline void
radix_tree_node_free(struct radix_tree_node *node)
{
329
	call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
L
Linus Torvalds 已提交
330 331 332 333 334 335 336
}

/*
 * 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.
337 338
 *
 * To make use of this facility, the radix tree must be initialised without
339
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
L
Linus Torvalds 已提交
340
 */
341
static int __radix_tree_preload(gfp_t gfp_mask)
L
Linus Torvalds 已提交
342 343 344 345 346 347
{
	struct radix_tree_preload *rtp;
	struct radix_tree_node *node;
	int ret = -ENOMEM;

	preempt_disable();
348
	rtp = this_cpu_ptr(&radix_tree_preloads);
349
	while (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
L
Linus Torvalds 已提交
350
		preempt_enable();
C
Christoph Lameter 已提交
351
		node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
L
Linus Torvalds 已提交
352 353 354
		if (node == NULL)
			goto out;
		preempt_disable();
355
		rtp = this_cpu_ptr(&radix_tree_preloads);
356 357 358 359 360
		if (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
			node->private_data = rtp->nodes;
			rtp->nodes = node;
			rtp->nr++;
		} else {
L
Linus Torvalds 已提交
361
			kmem_cache_free(radix_tree_node_cachep, node);
362
		}
L
Linus Torvalds 已提交
363 364 365 366 367
	}
	ret = 0;
out:
	return ret;
}
368 369 370 371 372 373 374 375

/*
 * 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
376
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
377 378 379 380
 */
int radix_tree_preload(gfp_t gfp_mask)
{
	/* Warn on non-sensical use... */
381
	WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
382 383
	return __radix_tree_preload(gfp_mask);
}
384
EXPORT_SYMBOL(radix_tree_preload);
L
Linus Torvalds 已提交
385

386 387 388 389 390 391 392
/*
 * 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)
{
393
	if (gfpflags_allow_blocking(gfp_mask))
394 395 396 397 398 399 400
		return __radix_tree_preload(gfp_mask);
	/* Preloading doesn't help anything with this gfp mask, skip it */
	preempt_disable();
	return 0;
}
EXPORT_SYMBOL(radix_tree_maybe_preload);

L
Linus Torvalds 已提交
401 402 403 404 405 406 407 408 409
/*
 *	Return the maximum key which can be store into a
 *	radix tree with height HEIGHT.
 */
static inline unsigned long radix_tree_maxindex(unsigned int height)
{
	return height_to_maxindex[height];
}

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
static inline unsigned long node_maxindex(struct radix_tree_node *node)
{
	return radix_tree_maxindex(node->path & RADIX_TREE_HEIGHT_MASK);
}

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;

	if (likely(radix_tree_is_indirect_ptr(node))) {
		node = indirect_to_ptr(node);
		*maxindex = node_maxindex(node);
		return (node->path & RADIX_TREE_HEIGHT_MASK) *
			RADIX_TREE_MAP_SHIFT;
	}

	*maxindex = 0;
	return 0;
}

L
Linus Torvalds 已提交
433 434 435
/*
 *	Extend a radix tree so it can store key @index.
 */
436
static int radix_tree_extend(struct radix_tree_root *root,
437
				unsigned long index)
L
Linus Torvalds 已提交
438 439
{
	struct radix_tree_node *node;
440
	struct radix_tree_node *slot;
L
Linus Torvalds 已提交
441 442 443 444 445 446 447 448
	unsigned int height;
	int tag;

	/* Figure out what the height should be.  */
	height = root->height + 1;
	while (index > radix_tree_maxindex(height))
		height++;

449
	if (root->rnode == NULL) {
L
Linus Torvalds 已提交
450 451 452 453 454
		root->height = height;
		goto out;
	}

	do {
455
		unsigned int newheight;
L
Linus Torvalds 已提交
456 457 458 459
		if (!(node = radix_tree_node_alloc(root)))
			return -ENOMEM;

		/* Propagate the aggregated tag info into the new root */
460
		for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
N
Nick Piggin 已提交
461
			if (root_tag_get(root, tag))
L
Linus Torvalds 已提交
462 463 464
				tag_set(node, tag, 0);
		}

465
		/* Increase the height.  */
466
		newheight = root->height+1;
467 468
		BUG_ON(newheight & ~RADIX_TREE_HEIGHT_MASK);
		node->path = newheight;
L
Linus Torvalds 已提交
469
		node->count = 1;
470 471
		node->parent = NULL;
		slot = root->rnode;
472
		if (radix_tree_is_indirect_ptr(slot)) {
473 474
			slot = indirect_to_ptr(slot);
			slot->parent = node;
475
			slot = ptr_to_indirect(slot);
476 477
		}
		node->slots[0] = slot;
N
Nick Piggin 已提交
478
		node = ptr_to_indirect(node);
479 480
		rcu_assign_pointer(root->rnode, node);
		root->height = newheight;
L
Linus Torvalds 已提交
481 482
	} while (height > root->height);
out:
483
	return height * RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
484 485 486
}

/**
487
 *	__radix_tree_create	-	create a slot in a radix tree
L
Linus Torvalds 已提交
488 489
 *	@root:		radix tree root
 *	@index:		index key
490
 *	@order:		index occupies 2^order aligned slots
491 492
 *	@nodep:		returns node
 *	@slotp:		returns slot
L
Linus Torvalds 已提交
493
 *
494 495 496 497 498 499 500 501
 *	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 已提交
502
 */
503
int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
504 505
			unsigned order, struct radix_tree_node **nodep,
			void ***slotp)
L
Linus Torvalds 已提交
506
{
507
	struct radix_tree_node *node = NULL, *slot;
508
	unsigned long maxindex;
509
	unsigned int height, shift, offset;
510 511 512
	unsigned long max = index | ((1UL << order) - 1);

	shift = radix_tree_load_root(root, &slot, &maxindex);
L
Linus Torvalds 已提交
513 514

	/* Make sure the tree is high enough.  */
515 516 517
	if (max > maxindex) {
		int error = radix_tree_extend(root, max);
		if (error < 0)
L
Linus Torvalds 已提交
518
			return error;
519 520 521 522 523 524
		shift = error;
		slot = root->rnode;
		if (order == shift) {
			shift += RADIX_TREE_MAP_SHIFT;
			root->height++;
		}
L
Linus Torvalds 已提交
525 526 527 528 529
	}

	height = root->height;

	offset = 0;			/* uninitialised var warning */
530
	while (shift > order) {
531
		if (slot == NULL) {
L
Linus Torvalds 已提交
532
			/* Have to add a child node.  */
533
			if (!(slot = radix_tree_node_alloc(root)))
L
Linus Torvalds 已提交
534
				return -ENOMEM;
535
			slot->path = height;
536
			slot->parent = node;
537
			if (node) {
538 539
				rcu_assign_pointer(node->slots[offset],
							ptr_to_indirect(slot));
L
Linus Torvalds 已提交
540
				node->count++;
541
				slot->path |= offset << RADIX_TREE_HEIGHT_SHIFT;
542
			} else
543 544
				rcu_assign_pointer(root->rnode,
							ptr_to_indirect(slot));
545 546
		} else if (!radix_tree_is_indirect_ptr(slot))
			break;
L
Linus Torvalds 已提交
547 548

		/* Go a level down */
549
		height--;
550
		shift -= RADIX_TREE_MAP_SHIFT;
551
		node = indirect_to_ptr(slot);
552 553
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
		offset = radix_tree_descend(node, &slot, offset);
554 555
	}

556
#ifdef CONFIG_RADIX_TREE_MULTIORDER
557
	/* Insert pointers to the canonical entry */
558 559
	if (order > shift) {
		int i, n = 1 << (order - shift);
560 561 562 563 564 565 566 567 568 569 570
		offset = offset & ~(n - 1);
		slot = ptr_to_indirect(&node->slots[offset]);
		for (i = 0; i < n; i++) {
			if (node->slots[offset + i])
				return -EEXIST;
		}

		for (i = 1; i < n; i++) {
			rcu_assign_pointer(node->slots[offset + i], slot);
			node->count++;
		}
N
Nick Piggin 已提交
571
	}
572
#endif
L
Linus Torvalds 已提交
573

574 575 576 577 578 579 580 581
	if (nodep)
		*nodep = node;
	if (slotp)
		*slotp = node ? node->slots + offset : (void **)&root->rnode;
	return 0;
}

/**
582
 *	__radix_tree_insert    -    insert into a radix tree
583 584
 *	@root:		radix tree root
 *	@index:		index key
585
 *	@order:		key covers the 2^order indices around index
586 587 588 589
 *	@item:		item to insert
 *
 *	Insert an item into the radix tree at position @index.
 */
590 591
int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
			unsigned order, void *item)
592 593 594 595 596 597 598
{
	struct radix_tree_node *node;
	void **slot;
	int error;

	BUG_ON(radix_tree_is_indirect_ptr(item));

599
	error = __radix_tree_create(root, index, order, &node, &slot);
600 601 602
	if (error)
		return error;
	if (*slot != NULL)
L
Linus Torvalds 已提交
603
		return -EEXIST;
604
	rcu_assign_pointer(*slot, item);
605

N
Nick Piggin 已提交
606
	if (node) {
607
		unsigned offset = get_slot_offset(node, slot);
N
Nick Piggin 已提交
608
		node->count++;
609 610 611
		BUG_ON(tag_get(node, 0, offset));
		BUG_ON(tag_get(node, 1, offset));
		BUG_ON(tag_get(node, 2, offset));
N
Nick Piggin 已提交
612
	} else {
613
		BUG_ON(root_tags_get(root));
N
Nick Piggin 已提交
614
	}
L
Linus Torvalds 已提交
615 616 617

	return 0;
}
618
EXPORT_SYMBOL(__radix_tree_insert);
L
Linus Torvalds 已提交
619

620 621 622 623 624 625 626 627 628 629 630 631 632
/**
 *	__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.
633
 */
634 635
void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
			  struct radix_tree_node **nodep, void ***slotp)
L
Linus Torvalds 已提交
636
{
637
	struct radix_tree_node *node, *parent;
638 639
	unsigned long maxindex;
	unsigned int shift;
640
	void **slot;
N
Nick Piggin 已提交
641

642 643 644 645 646
 restart:
	parent = NULL;
	slot = (void **)&root->rnode;
	shift = radix_tree_load_root(root, &node, &maxindex);
	if (index > maxindex)
L
Linus Torvalds 已提交
647 648
		return NULL;

649 650
	while (radix_tree_is_indirect_ptr(node)) {
		unsigned offset;
L
Linus Torvalds 已提交
651

652 653 654
		if (node == RADIX_TREE_RETRY)
			goto restart;
		parent = indirect_to_ptr(node);
L
Linus Torvalds 已提交
655
		shift -= RADIX_TREE_MAP_SHIFT;
656 657 658 659
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
		offset = radix_tree_descend(parent, &node, offset);
		slot = parent->slots + offset;
	}
L
Linus Torvalds 已提交
660

661 662 663 664 665
	if (nodep)
		*nodep = parent;
	if (slotp)
		*slotp = slot;
	return node;
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
}

/**
 *	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)
{
683 684 685 686 687
	void **slot;

	if (!__radix_tree_lookup(root, index, NULL, &slot))
		return NULL;
	return slot;
688 689 690 691 692 693 694 695 696
}
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.
697 698 699 700 701
 *
 *	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.
702 703 704
 */
void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
{
705
	return __radix_tree_lookup(root, index, NULL, NULL);
L
Linus Torvalds 已提交
706 707 708 709 710 711 712 713 714
}
EXPORT_SYMBOL(radix_tree_lookup);

/**
 *	radix_tree_tag_set - set a tag on a radix tree node
 *	@root:		radix tree root
 *	@index:		index key
 *	@tag: 		tag index
 *
715 716
 *	Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
 *	corresponding to @index in the radix tree.  From
L
Linus Torvalds 已提交
717 718 719 720 721 722
 *	the root all the way down to the leaf node.
 *
 *	Returns the address of the tagged item.   Setting a tag on a not-present
 *	item is a bug.
 */
void *radix_tree_tag_set(struct radix_tree_root *root,
723
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
724
{
725 726 727
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
	unsigned int shift;
L
Linus Torvalds 已提交
728

729 730
	shift = radix_tree_load_root(root, &node, &maxindex);
	BUG_ON(index > maxindex);
L
Linus Torvalds 已提交
731

732 733
	while (radix_tree_is_indirect_ptr(node)) {
		unsigned offset;
L
Linus Torvalds 已提交
734 735

		shift -= RADIX_TREE_MAP_SHIFT;
736 737 738 739 740 741 742 743
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;

		parent = indirect_to_ptr(node);
		offset = radix_tree_descend(parent, &node, offset);
		BUG_ON(!node);

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

N
Nick Piggin 已提交
746
	/* set the root's tag bit */
747
	if (!root_tag_get(root, tag))
N
Nick Piggin 已提交
748 749
		root_tag_set(root, tag);

750
	return node;
L
Linus Torvalds 已提交
751 752 753 754 755 756 757 758 759
}
EXPORT_SYMBOL(radix_tree_tag_set);

/**
 *	radix_tree_tag_clear - clear a tag on a radix tree node
 *	@root:		radix tree root
 *	@index:		index key
 *	@tag: 		tag index
 *
760 761
 *	Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
 *	corresponding to @index in the radix tree.  If
L
Linus Torvalds 已提交
762 763 764 765 766 767 768
 *	this causes the leaf node to have no tags set then clear the tag in the
 *	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,
769
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
770
{
771 772 773
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
	unsigned int shift;
774
	int uninitialized_var(offset);
L
Linus Torvalds 已提交
775

776 777 778
	shift = radix_tree_load_root(root, &node, &maxindex);
	if (index > maxindex)
		return NULL;
L
Linus Torvalds 已提交
779

780
	parent = NULL;
L
Linus Torvalds 已提交
781

782
	while (radix_tree_is_indirect_ptr(node)) {
783
		shift -= RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
784
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
785 786 787

		parent = indirect_to_ptr(node);
		offset = radix_tree_descend(parent, &node, offset);
L
Linus Torvalds 已提交
788 789
	}

790
	if (node == NULL)
L
Linus Torvalds 已提交
791 792
		goto out;

793 794 795 796
	index >>= shift;

	while (parent) {
		if (!tag_get(parent, tag, offset))
797
			goto out;
798 799
		tag_clear(parent, tag, offset);
		if (any_tag_set(parent, tag))
800
			goto out;
801 802 803

		index >>= RADIX_TREE_MAP_SHIFT;
		offset = index & RADIX_TREE_MAP_MASK;
804
		parent = parent->parent;
N
Nick Piggin 已提交
805 806 807 808 809 810
	}

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

L
Linus Torvalds 已提交
811
out:
812
	return node;
L
Linus Torvalds 已提交
813 814 815 816
}
EXPORT_SYMBOL(radix_tree_tag_clear);

/**
817 818 819
 * radix_tree_tag_get - get a tag on a radix tree node
 * @root:		radix tree root
 * @index:		index key
820
 * @tag: 		tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
821
 *
822
 * Return values:
L
Linus Torvalds 已提交
823
 *
N
Nick Piggin 已提交
824 825
 *  0: tag not present or not set
 *  1: tag set
826 827 828 829
 *
 * 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 已提交
830 831
 */
int radix_tree_tag_get(struct radix_tree_root *root,
832
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
833
{
834 835 836
	struct radix_tree_node *node, *parent;
	unsigned long maxindex;
	unsigned int shift;
L
Linus Torvalds 已提交
837

N
Nick Piggin 已提交
838 839 840
	if (!root_tag_get(root, tag))
		return 0;

841 842 843
	shift = radix_tree_load_root(root, &node, &maxindex);
	if (index > maxindex)
		return 0;
844 845 846
	if (node == NULL)
		return 0;

847 848
	while (radix_tree_is_indirect_ptr(node)) {
		int offset;
N
Nick Piggin 已提交
849

850 851
		shift -= RADIX_TREE_MAP_SHIFT;
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
L
Linus Torvalds 已提交
852

853 854
		parent = indirect_to_ptr(node);
		offset = radix_tree_descend(parent, &node, offset);
L
Linus Torvalds 已提交
855

856
		if (!node)
L
Linus Torvalds 已提交
857
			return 0;
858
		if (!tag_get(parent, tag, offset))
859
			return 0;
860 861
		if (node == RADIX_TREE_RETRY)
			break;
L
Linus Torvalds 已提交
862
	}
863 864

	return 1;
L
Linus Torvalds 已提交
865 866 867
}
EXPORT_SYMBOL(radix_tree_tag_get);

868 869 870 871 872 873 874 875
static inline void __set_iter_shift(struct radix_tree_iter *iter,
					unsigned int shift)
{
#ifdef CONFIG_RADIX_TREE_MULTIORDER
	iter->shift = shift;
#endif
}

876 877 878 879 880 881 882 883 884 885 886 887 888
/**
 * 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)
{
	unsigned shift, tag = flags & RADIX_TREE_ITER_TAG_MASK;
	struct radix_tree_node *rnode, *node;
889
	unsigned long index, offset, maxindex;
890 891 892 893 894 895 896 897 898

	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.
899 900 901
	 *
	 * This condition also used by radix_tree_next_slot() to stop
	 * contiguous iterating, and forbid swithing to the next chunk.
902 903 904 905 906
	 */
	index = iter->next_index;
	if (!index && iter->index)
		return NULL;

907 908 909 910 911
 restart:
	shift = radix_tree_load_root(root, &rnode, &maxindex);
	if (index > maxindex)
		return NULL;

912 913
	if (radix_tree_is_indirect_ptr(rnode)) {
		rnode = indirect_to_ptr(rnode);
914
	} else if (rnode) {
915
		/* Single-slot tree */
916 917
		iter->index = index;
		iter->next_index = maxindex + 1;
918
		iter->tags = 1;
919
		__set_iter_shift(iter, shift);
920 921 922 923
		return (void **)&root->rnode;
	} else
		return NULL;

924
	shift -= RADIX_TREE_MAP_SHIFT;
925 926 927 928
	offset = index >> shift;

	node = rnode;
	while (1) {
929
		struct radix_tree_node *slot;
930 931 932 933 934 935 936 937
		unsigned new_off = radix_tree_descend(node, &slot, offset);

		if (new_off < offset) {
			offset = new_off;
			index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
			index |= offset << shift;
		}

938
		if ((flags & RADIX_TREE_ITER_TAGGED) ?
939
				!tag_get(node, tag, offset) : !slot) {
940 941 942 943 944 945 946 947 948 949 950
			/* 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) {
951 952 953 954
					void *slot = node->slots[offset];
					if (is_sibling_entry(node, slot))
						continue;
					if (slot)
955 956 957 958 959 960 961 962 963
						break;
				}
			index &= ~((RADIX_TREE_MAP_SIZE << shift) - 1);
			index += offset << shift;
			/* Overflow after ~0UL */
			if (!index)
				return NULL;
			if (offset == RADIX_TREE_MAP_SIZE)
				goto restart;
964
			slot = rcu_dereference_raw(node->slots[offset]);
965 966
		}

967
		if ((slot == NULL) || (slot == RADIX_TREE_RETRY))
968
			goto restart;
969 970
		if (!radix_tree_is_indirect_ptr(slot))
			break;
971

972
		node = indirect_to_ptr(slot);
973 974 975 976 977
		shift -= RADIX_TREE_MAP_SHIFT;
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
	}

	/* Update the iterator state */
978 979 980
	iter->index = index & ~((1 << shift) - 1);
	iter->next_index = (index | ((RADIX_TREE_MAP_SIZE << shift) - 1)) + 1;
	__set_iter_shift(iter, shift);
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003

	/* 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);

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
/**
 * 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.
 *
1019 1020 1021 1022 1023 1024 1025
 * 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).
 *
1026 1027
 * The function returns number of leaves where the tag was set and sets
 * *first_indexp to the first unscanned index.
1028 1029
 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
 * be prepared to handle that.
1030 1031 1032 1033 1034 1035
 */
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)
{
1036
	unsigned int height = root->height;
1037
	struct radix_tree_node *node = NULL;
1038 1039 1040 1041
	struct radix_tree_node *slot;
	unsigned int shift;
	unsigned long tagged = 0;
	unsigned long index = *first_indexp;
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

	last_index = min(last_index, radix_tree_maxindex(height));
	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;
	}
	if (height == 0) {
		*first_indexp = last_index + 1;
		root_tag_set(root, settag);
		return 1;
	}

	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
N
Nick Piggin 已提交
1059
	slot = indirect_to_ptr(root->rnode);
1060 1061

	for (;;) {
1062
		unsigned long upindex;
1063 1064 1065 1066 1067 1068 1069
		int offset;

		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
		if (!slot->slots[offset])
			goto next;
		if (!tag_get(slot, iftag, offset))
			goto next;
1070 1071
		if (shift) {
			node = slot;
1072
			slot = slot->slots[offset];
1073 1074 1075 1076 1077 1078 1079 1080
			if (radix_tree_is_indirect_ptr(slot)) {
				slot = indirect_to_ptr(slot);
				shift -= RADIX_TREE_MAP_SHIFT;
				continue;
			} else {
				slot = node;
				node = node->parent;
			}
1081 1082 1083
		}

		/* tag the leaf */
1084
		tagged += 1 << shift;
1085
		tag_set(slot, settag, offset);
1086 1087

		/* walk back up the path tagging interior nodes */
1088 1089 1090 1091 1092
		upindex = index;
		while (node) {
			upindex >>= RADIX_TREE_MAP_SHIFT;
			offset = upindex & RADIX_TREE_MAP_MASK;

1093
			/* stop if we find a node with the tag already set */
1094
			if (tag_get(node, settag, offset))
1095
				break;
1096 1097
			tag_set(node, settag, offset);
			node = node->parent;
1098
		}
1099

1100 1101 1102 1103 1104 1105 1106 1107 1108
		/*
		 * Small optimization: now clear that node pointer.
		 * Since all of this slot's ancestors now have the tag set
		 * from setting it above, we have no further need to walk
		 * back up the tree setting tags, until we update slot to
		 * point to another radix_tree_node.
		 */
		node = NULL;

1109 1110 1111
next:
		/* Go to next item at level determined by 'shift' */
		index = ((index >> shift) + 1) << shift;
1112 1113
		/* Overflow can happen when last_index is ~0UL... */
		if (index > last_index || !index)
1114 1115 1116 1117 1118 1119 1120 1121 1122
			break;
		if (tagged >= nr_to_tag)
			break;
		while (((index >> shift) & RADIX_TREE_MAP_MASK) == 0) {
			/*
			 * 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.
			 */
1123
			slot = slot->parent;
1124 1125 1126 1127
			shift += RADIX_TREE_MAP_SHIFT;
		}
	}
	/*
1128 1129
	 * 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.
1130
	 */
1131 1132
	if (tagged > 0)
		root_tag_set(root, settag);
1133 1134 1135 1136 1137 1138
	*first_indexp = index;

	return tagged;
}
EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);

L
Linus Torvalds 已提交
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
/**
 *	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.
1151 1152 1153 1154 1155 1156
 *
 *	Like radix_tree_lookup, radix_tree_gang_lookup may be called under
 *	rcu_read_lock. In this case, rather than the returned results being
 *	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 已提交
1157 1158 1159 1160 1161
 */
unsigned int
radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
			unsigned long first_index, unsigned int max_items)
{
1162 1163 1164
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1165

1166
	if (unlikely(!max_items))
1167
		return 0;
L
Linus Torvalds 已提交
1168

1169
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
1170
		results[ret] = rcu_dereference_raw(*slot);
1171 1172
		if (!results[ret])
			continue;
1173 1174 1175 1176
		if (radix_tree_is_indirect_ptr(results[ret])) {
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1177
		if (++ret == max_items)
L
Linus Torvalds 已提交
1178 1179
			break;
	}
1180

L
Linus Torvalds 已提交
1181 1182 1183 1184
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup);

1185 1186 1187 1188
/**
 *	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
1189
 *	@indices:	where their indices should be placed (but usually NULL)
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
 *	@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
1204 1205
radix_tree_gang_lookup_slot(struct radix_tree_root *root,
			void ***results, unsigned long *indices,
1206 1207
			unsigned long first_index, unsigned int max_items)
{
1208 1209 1210
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1211

1212
	if (unlikely(!max_items))
1213 1214
		return 0;

1215 1216
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
		results[ret] = slot;
1217
		if (indices)
1218 1219
			indices[ret] = iter.index;
		if (++ret == max_items)
1220 1221 1222 1223 1224 1225 1226
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_slot);

L
Linus Torvalds 已提交
1227 1228 1229 1230 1231 1232 1233
/**
 *	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
1234
 *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
1235 1236 1237 1238 1239 1240 1241
 *
 *	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,
1242 1243
		unsigned long first_index, unsigned int max_items,
		unsigned int tag)
L
Linus Torvalds 已提交
1244
{
1245 1246 1247
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
N
Nick Piggin 已提交
1248

1249
	if (unlikely(!max_items))
1250 1251
		return 0;

1252
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1253
		results[ret] = rcu_dereference_raw(*slot);
1254 1255
		if (!results[ret])
			continue;
1256 1257 1258 1259
		if (radix_tree_is_indirect_ptr(results[ret])) {
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1260
		if (++ret == max_items)
L
Linus Torvalds 已提交
1261 1262
			break;
	}
1263

L
Linus Torvalds 已提交
1264 1265 1266 1267
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag);

1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
/**
 *	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)
{
1286 1287 1288
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1289

1290
	if (unlikely(!max_items))
1291 1292
		return 0;

1293 1294 1295
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
		results[ret] = slot;
		if (++ret == max_items)
1296 1297 1298 1299 1300 1301 1302
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);

1303 1304 1305
#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
#include <linux/sched.h> /* for cond_resched() */

1306 1307 1308 1309 1310
struct locate_info {
	unsigned long found_index;
	bool stop;
};

1311 1312 1313 1314
/*
 * This linear search is at present only useful to shmem_unuse_inode().
 */
static unsigned long __locate(struct radix_tree_node *slot, void *item,
1315
			      unsigned long index, struct locate_info *info)
1316 1317 1318 1319
{
	unsigned int shift, height;
	unsigned long i;

1320
	height = slot->path & RADIX_TREE_HEIGHT_MASK;
1321
	shift = height * RADIX_TREE_MAP_SHIFT;
1322

1323 1324
	do {
		shift -= RADIX_TREE_MAP_SHIFT;
1325

1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
		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;
			if (!radix_tree_is_indirect_ptr(node)) {
				if (node == item) {
					info->found_index = index;
					info->stop = true;
					goto out;
				}
				continue;
1340
			}
1341 1342 1343 1344 1345
			node = indirect_to_ptr(node);
			if (is_sibling_entry(slot, node))
				continue;
			slot = node;
			break;
1346
		}
1347 1348 1349
		if (i == RADIX_TREE_MAP_SIZE)
			break;
	} while (shift);
1350 1351

out:
1352 1353
	if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
		info->stop = true;
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
	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;
1371 1372 1373 1374
	struct locate_info info = {
		.found_index = -1,
		.stop = false,
	};
1375 1376 1377 1378 1379 1380 1381

	do {
		rcu_read_lock();
		node = rcu_dereference_raw(root->rnode);
		if (!radix_tree_is_indirect_ptr(node)) {
			rcu_read_unlock();
			if (node == item)
1382
				info.found_index = 0;
1383 1384 1385 1386
			break;
		}

		node = indirect_to_ptr(node);
1387 1388

		max_index = node_maxindex(node);
1389 1390
		if (cur_index > max_index) {
			rcu_read_unlock();
1391
			break;
1392
		}
1393

1394
		cur_index = __locate(node, item, cur_index, &info);
1395 1396
		rcu_read_unlock();
		cond_resched();
1397
	} while (!info.stop && cur_index <= max_index);
1398

1399
	return info.found_index;
1400 1401 1402 1403 1404 1405 1406
}
#else
unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
{
	return -1;
}
#endif /* CONFIG_SHMEM && CONFIG_SWAP */
1407

1408 1409 1410 1411 1412 1413 1414
/**
 *	radix_tree_shrink    -    shrink height of a radix tree to minimal
 *	@root		radix tree root
 */
static inline void radix_tree_shrink(struct radix_tree_root *root)
{
	/* try to shrink tree height */
N
Nick Piggin 已提交
1415
	while (root->height > 0) {
1416
		struct radix_tree_node *to_free = root->rnode;
1417
		struct radix_tree_node *slot;
1418

N
Nick Piggin 已提交
1419
		BUG_ON(!radix_tree_is_indirect_ptr(to_free));
N
Nick Piggin 已提交
1420
		to_free = indirect_to_ptr(to_free);
N
Nick Piggin 已提交
1421 1422 1423

		/*
		 * The candidate node has more than one child, or its child
1424 1425
		 * is not at the leftmost slot, or it is a multiorder entry,
		 * we cannot shrink.
N
Nick Piggin 已提交
1426 1427 1428
		 */
		if (to_free->count != 1)
			break;
1429 1430
		slot = to_free->slots[0];
		if (!slot)
N
Nick Piggin 已提交
1431
			break;
1432 1433 1434 1435 1436 1437 1438 1439
		if (!radix_tree_is_indirect_ptr(slot) && (root->height > 1))
			break;

		if (radix_tree_is_indirect_ptr(slot)) {
			slot = indirect_to_ptr(slot);
			slot->parent = NULL;
			slot = ptr_to_indirect(slot);
		}
N
Nick Piggin 已提交
1440

1441 1442
		/*
		 * We don't need rcu_assign_pointer(), since we are simply
N
Nick Piggin 已提交
1443 1444
		 * moving the node from one part of the tree to another: if it
		 * was safe to dereference the old pointer to it
1445
		 * (to_free->slots[0]), it will be safe to dereference the new
N
Nick Piggin 已提交
1446
		 * one (root->rnode) as far as dependent read barriers go.
1447
		 */
1448
		root->rnode = slot;
1449
		root->height--;
N
Nick Piggin 已提交
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468

		/*
		 * 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
		 * the page pointer, and if the page is 0 refcount it means it
		 * 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.
		 */
1469 1470
		if (!radix_tree_is_indirect_ptr(slot))
			to_free->slots[0] = RADIX_TREE_RETRY;
N
Nick Piggin 已提交
1471

1472 1473 1474 1475
		radix_tree_node_free(to_free);
	}
}

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
/**
 *	__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.
 */
1487
bool __radix_tree_delete_node(struct radix_tree_root *root,
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
			      struct radix_tree_node *node)
{
	bool deleted = false;

	do {
		struct radix_tree_node *parent;

		if (node->count) {
			if (node == indirect_to_ptr(root->rnode)) {
				radix_tree_shrink(root);
				if (root->height == 0)
					deleted = true;
			}
			return deleted;
		}

		parent = node->parent;
		if (parent) {
1506
			unsigned int offset;
1507

1508 1509
			offset = node->path >> RADIX_TREE_HEIGHT_SHIFT;
			parent->slots[offset] = NULL;
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
			parent->count--;
		} else {
			root_tag_clear_all(root);
			root->height = 0;
			root->rnode = NULL;
		}

		radix_tree_node_free(node);
		deleted = true;

		node = parent;
	} while (node);

	return deleted;
}

1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
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 已提交
1540
/**
1541
 *	radix_tree_delete_item    -    delete an item from a radix tree
L
Linus Torvalds 已提交
1542 1543
 *	@root:		radix tree root
 *	@index:		index key
1544
 *	@item:		expected item
L
Linus Torvalds 已提交
1545
 *
1546
 *	Remove @item at @index from the radix tree rooted at @root.
L
Linus Torvalds 已提交
1547
 *
1548 1549
 *	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 已提交
1550
 */
1551 1552
void *radix_tree_delete_item(struct radix_tree_root *root,
			     unsigned long index, void *item)
L
Linus Torvalds 已提交
1553
{
1554
	struct radix_tree_node *node;
1555
	unsigned int offset;
1556 1557
	void **slot;
	void *entry;
1558
	int tag;
L
Linus Torvalds 已提交
1559

1560 1561 1562
	entry = __radix_tree_lookup(root, index, &node, &slot);
	if (!entry)
		return NULL;
L
Linus Torvalds 已提交
1563

1564 1565 1566 1567
	if (item && entry != item)
		return NULL;

	if (!node) {
N
Nick Piggin 已提交
1568 1569
		root_tag_clear_all(root);
		root->rnode = NULL;
1570
		return entry;
N
Nick Piggin 已提交
1571
	}
L
Linus Torvalds 已提交
1572

1573
	offset = get_slot_offset(node, slot);
1574

L
Linus Torvalds 已提交
1575
	/*
1576 1577
	 * Clear all tags associated with the item to be deleted.
	 * This way of doing it would be inefficient, but seldom is any set.
L
Linus Torvalds 已提交
1578
	 */
1579
	for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
1580
		if (tag_get(node, tag, offset))
N
Nick Piggin 已提交
1581
			radix_tree_tag_clear(root, index, tag);
1582
	}
L
Linus Torvalds 已提交
1583

1584
	delete_sibling_entries(node, ptr_to_indirect(slot), offset);
1585 1586
	node->slots[offset] = NULL;
	node->count--;
1587

1588
	__radix_tree_delete_node(root, node);
N
Nick Piggin 已提交
1589

1590
	return entry;
L
Linus Torvalds 已提交
1591
}
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
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 已提交
1607 1608 1609 1610 1611 1612 1613
EXPORT_SYMBOL(radix_tree_delete);

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

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

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

static __init unsigned long __maxindex(unsigned int height)
{
1631 1632 1633 1634 1635 1636 1637 1638
	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;
L
Linus Torvalds 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
}

static __init void radix_tree_init_maxindex(void)
{
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
		height_to_maxindex[i] = __maxindex(i);
}

static int radix_tree_callback(struct notifier_block *nfb,
                            unsigned long action,
                            void *hcpu)
{
       int cpu = (long)hcpu;
       struct radix_tree_preload *rtp;
1655
       struct radix_tree_node *node;
L
Linus Torvalds 已提交
1656 1657

       /* Free per-cpu pool of perloaded nodes */
1658
       if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
L
Linus Torvalds 已提交
1659 1660
               rtp = &per_cpu(radix_tree_preloads, cpu);
               while (rtp->nr) {
1661 1662 1663 1664
			node = rtp->nodes;
			rtp->nodes = node->private_data;
			kmem_cache_free(radix_tree_node_cachep, node);
			rtp->nr--;
L
Linus Torvalds 已提交
1665 1666 1667 1668 1669 1670 1671 1672 1673
               }
       }
       return NOTIFY_OK;
}

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 已提交
1674 1675
			SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
			radix_tree_node_ctor);
L
Linus Torvalds 已提交
1676 1677 1678
	radix_tree_init_maxindex();
	hotcpu_notifier(radix_tree_callback, 0);
}