radix-tree.c 42.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
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 78 79 80 81 82
static inline void *ptr_to_indirect(void *ptr)
{
	return (void *)((unsigned long)ptr | RADIX_TREE_INDIRECT_PTR);
}

static inline void *indirect_to_ptr(void *ptr)
{
	return (void *)((unsigned long)ptr & ~RADIX_TREE_INDIRECT_PTR);
}

N
Nick Piggin 已提交
83 84 85 86 87
static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
{
	return root->gfp_mask & __GFP_BITS_MASK;
}

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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
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));
}

/*
 * 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;
}
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

/**
 * 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 已提交
176 177 178 179 180 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
#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 已提交
211 212 213 214 215 216 217
/*
 * 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)
{
218
	struct radix_tree_node *ret = NULL;
N
Nick Piggin 已提交
219
	gfp_t gfp_mask = root_gfp_mask(root);
L
Linus Torvalds 已提交
220

221 222 223 224 225
	/*
	 * 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.
	 */
226
	if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
L
Linus Torvalds 已提交
227 228
		struct radix_tree_preload *rtp;

229 230 231 232 233 234 235 236 237
		/*
		 * 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;

238 239 240 241 242
		/*
		 * Provided the caller has preloaded here, we will always
		 * succeed in getting a node here (and never reach
		 * kmem_cache_alloc)
		 */
243
		rtp = this_cpu_ptr(&radix_tree_preloads);
L
Linus Torvalds 已提交
244
		if (rtp->nr) {
245 246 247
			ret = rtp->nodes;
			rtp->nodes = ret->private_data;
			ret->private_data = NULL;
L
Linus Torvalds 已提交
248 249
			rtp->nr--;
		}
250 251 252 253 254
		/*
		 * Update the allocation stack trace as this is more useful
		 * for debugging.
		 */
		kmemleak_update_trace(ret);
255
		goto out;
L
Linus Torvalds 已提交
256
	}
257 258 259
	ret = kmem_cache_alloc(radix_tree_node_cachep,
			       gfp_mask | __GFP_ACCOUNT);
out:
N
Nick Piggin 已提交
260
	BUG_ON(radix_tree_is_indirect_ptr(ret));
L
Linus Torvalds 已提交
261 262 263
	return ret;
}

264 265 266 267
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);
268
	int i;
269 270 271 272 273 274

	/*
	 * 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.
	 */
275 276 277
	for (i = 0; i < RADIX_TREE_MAX_TAGS; i++)
		tag_clear(node, i, 0);

278 279 280
	node->slots[0] = NULL;
	node->count = 0;

281 282 283
	kmem_cache_free(radix_tree_node_cachep, node);
}

L
Linus Torvalds 已提交
284 285 286
static inline void
radix_tree_node_free(struct radix_tree_node *node)
{
287
	call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
L
Linus Torvalds 已提交
288 289 290 291 292 293 294
}

/*
 * 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.
295 296
 *
 * To make use of this facility, the radix tree must be initialised without
297
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
L
Linus Torvalds 已提交
298
 */
299
static int __radix_tree_preload(gfp_t gfp_mask)
L
Linus Torvalds 已提交
300 301 302 303 304 305
{
	struct radix_tree_preload *rtp;
	struct radix_tree_node *node;
	int ret = -ENOMEM;

	preempt_disable();
306
	rtp = this_cpu_ptr(&radix_tree_preloads);
307
	while (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
L
Linus Torvalds 已提交
308
		preempt_enable();
C
Christoph Lameter 已提交
309
		node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
L
Linus Torvalds 已提交
310 311 312
		if (node == NULL)
			goto out;
		preempt_disable();
313
		rtp = this_cpu_ptr(&radix_tree_preloads);
314 315 316 317 318
		if (rtp->nr < RADIX_TREE_PRELOAD_SIZE) {
			node->private_data = rtp->nodes;
			rtp->nodes = node;
			rtp->nr++;
		} else {
L
Linus Torvalds 已提交
319
			kmem_cache_free(radix_tree_node_cachep, node);
320
		}
L
Linus Torvalds 已提交
321 322 323 324 325
	}
	ret = 0;
out:
	return ret;
}
326 327 328 329 330 331 332 333

/*
 * 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
334
 * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
335 336 337 338
 */
int radix_tree_preload(gfp_t gfp_mask)
{
	/* Warn on non-sensical use... */
339
	WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
340 341
	return __radix_tree_preload(gfp_mask);
}
342
EXPORT_SYMBOL(radix_tree_preload);
L
Linus Torvalds 已提交
343

344 345 346 347 348 349 350
/*
 * 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)
{
351
	if (gfpflags_allow_blocking(gfp_mask))
352 353 354 355 356 357 358
		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 已提交
359 360 361 362 363 364 365 366 367 368 369 370
/*
 *	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];
}

/*
 *	Extend a radix tree so it can store key @index.
 */
371 372
static int radix_tree_extend(struct radix_tree_root *root,
				unsigned long index, unsigned order)
L
Linus Torvalds 已提交
373 374
{
	struct radix_tree_node *node;
375
	struct radix_tree_node *slot;
L
Linus Torvalds 已提交
376 377 378 379 380 381 382 383
	unsigned int height;
	int tag;

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

384
	if ((root->rnode == NULL) && (order == 0)) {
L
Linus Torvalds 已提交
385 386 387 388 389
		root->height = height;
		goto out;
	}

	do {
390
		unsigned int newheight;
L
Linus Torvalds 已提交
391 392 393 394
		if (!(node = radix_tree_node_alloc(root)))
			return -ENOMEM;

		/* Propagate the aggregated tag info into the new root */
395
		for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
N
Nick Piggin 已提交
396
			if (root_tag_get(root, tag))
L
Linus Torvalds 已提交
397 398 399
				tag_set(node, tag, 0);
		}

400
		/* Increase the height.  */
401
		newheight = root->height+1;
402 403
		BUG_ON(newheight & ~RADIX_TREE_HEIGHT_MASK);
		node->path = newheight;
L
Linus Torvalds 已提交
404
		node->count = 1;
405 406
		node->parent = NULL;
		slot = root->rnode;
407
		if (radix_tree_is_indirect_ptr(slot) && newheight > 1) {
408 409
			slot = indirect_to_ptr(slot);
			slot->parent = node;
410
			slot = ptr_to_indirect(slot);
411 412
		}
		node->slots[0] = slot;
N
Nick Piggin 已提交
413
		node = ptr_to_indirect(node);
414 415
		rcu_assign_pointer(root->rnode, node);
		root->height = newheight;
L
Linus Torvalds 已提交
416 417 418 419 420 421
	} while (height > root->height);
out:
	return 0;
}

/**
422
 *	__radix_tree_create	-	create a slot in a radix tree
L
Linus Torvalds 已提交
423 424
 *	@root:		radix tree root
 *	@index:		index key
425
 *	@order:		index occupies 2^order aligned slots
426 427
 *	@nodep:		returns node
 *	@slotp:		returns slot
L
Linus Torvalds 已提交
428
 *
429 430 431 432 433 434 435 436
 *	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 已提交
437
 */
438
int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
439 440
			unsigned order, struct radix_tree_node **nodep,
			void ***slotp)
L
Linus Torvalds 已提交
441
{
442
	struct radix_tree_node *node = NULL, *slot;
443
	unsigned int height, shift, offset;
L
Linus Torvalds 已提交
444 445
	int error;

446 447
	BUG_ON((0 < order) && (order < RADIX_TREE_MAP_SHIFT));

L
Linus Torvalds 已提交
448
	/* Make sure the tree is high enough.  */
N
Nick Piggin 已提交
449
	if (index > radix_tree_maxindex(root->height)) {
450
		error = radix_tree_extend(root, index, order);
L
Linus Torvalds 已提交
451 452 453 454
		if (error)
			return error;
	}

455
	slot = root->rnode;
N
Nick Piggin 已提交
456

L
Linus Torvalds 已提交
457
	height = root->height;
458
	shift = height * RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
459 460

	offset = 0;			/* uninitialised var warning */
461
	while (shift > order) {
462
		if (slot == NULL) {
L
Linus Torvalds 已提交
463
			/* Have to add a child node.  */
464
			if (!(slot = radix_tree_node_alloc(root)))
L
Linus Torvalds 已提交
465
				return -ENOMEM;
466
			slot->path = height;
467
			slot->parent = node;
468
			if (node) {
469 470
				rcu_assign_pointer(node->slots[offset],
							ptr_to_indirect(slot));
L
Linus Torvalds 已提交
471
				node->count++;
472
				slot->path |= offset << RADIX_TREE_HEIGHT_SHIFT;
473
			} else
474 475
				rcu_assign_pointer(root->rnode,
							ptr_to_indirect(slot));
476 477
		} else if (!radix_tree_is_indirect_ptr(slot))
			break;
L
Linus Torvalds 已提交
478 479

		/* Go a level down */
480
		height--;
481
		shift -= RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
482
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
483
		node = indirect_to_ptr(slot);
484
		slot = node->slots[offset];
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
	}

	/* Insert pointers to the canonical entry */
	if ((shift - order) > 0) {
		int i, n = 1 << (shift - order);
		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 已提交
501
	}
L
Linus Torvalds 已提交
502

503 504 505 506 507 508 509 510
	if (nodep)
		*nodep = node;
	if (slotp)
		*slotp = node ? node->slots + offset : (void **)&root->rnode;
	return 0;
}

/**
511
 *	__radix_tree_insert    -    insert into a radix tree
512 513
 *	@root:		radix tree root
 *	@index:		index key
514
 *	@order:		key covers the 2^order indices around index
515 516 517 518
 *	@item:		item to insert
 *
 *	Insert an item into the radix tree at position @index.
 */
519 520
int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
			unsigned order, void *item)
521 522 523 524 525 526 527
{
	struct radix_tree_node *node;
	void **slot;
	int error;

	BUG_ON(radix_tree_is_indirect_ptr(item));

528
	error = __radix_tree_create(root, index, order, &node, &slot);
529 530 531
	if (error)
		return error;
	if (*slot != NULL)
L
Linus Torvalds 已提交
532
		return -EEXIST;
533
	rcu_assign_pointer(*slot, item);
534

N
Nick Piggin 已提交
535 536
	if (node) {
		node->count++;
537 538
		BUG_ON(tag_get(node, 0, index & RADIX_TREE_MAP_MASK));
		BUG_ON(tag_get(node, 1, index & RADIX_TREE_MAP_MASK));
N
Nick Piggin 已提交
539 540 541 542
	} else {
		BUG_ON(root_tag_get(root, 0));
		BUG_ON(root_tag_get(root, 1));
	}
L
Linus Torvalds 已提交
543 544 545

	return 0;
}
546
EXPORT_SYMBOL(__radix_tree_insert);
L
Linus Torvalds 已提交
547

548 549 550 551 552 553 554 555 556 557 558 559 560
/**
 *	__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.
561
 */
562 563
void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
			  struct radix_tree_node **nodep, void ***slotp)
L
Linus Torvalds 已提交
564
{
565
	struct radix_tree_node *node, *parent;
L
Linus Torvalds 已提交
566
	unsigned int height, shift;
567
	void **slot;
N
Nick Piggin 已提交
568

569
	node = rcu_dereference_raw(root->rnode);
570
	if (node == NULL)
L
Linus Torvalds 已提交
571 572
		return NULL;

N
Nick Piggin 已提交
573
	if (!radix_tree_is_indirect_ptr(node)) {
574 575
		if (index > 0)
			return NULL;
576 577 578 579 580 581

		if (nodep)
			*nodep = NULL;
		if (slotp)
			*slotp = (void **)&root->rnode;
		return node;
582
	}
N
Nick Piggin 已提交
583
	node = indirect_to_ptr(node);
584

585
	height = node->path & RADIX_TREE_HEIGHT_MASK;
586 587
	if (index > radix_tree_maxindex(height))
		return NULL;
N
Nick Piggin 已提交
588

L
Linus Torvalds 已提交
589 590
	shift = (height-1) * RADIX_TREE_MAP_SHIFT;

591
	do {
592 593
		parent = node;
		slot = node->slots + ((index >> shift) & RADIX_TREE_MAP_MASK);
594
		node = rcu_dereference_raw(*slot);
595
		if (node == NULL)
L
Linus Torvalds 已提交
596
			return NULL;
597 598
		if (!radix_tree_is_indirect_ptr(node))
			break;
599
		node = indirect_to_ptr(node);
L
Linus Torvalds 已提交
600 601 602

		shift -= RADIX_TREE_MAP_SHIFT;
		height--;
603
	} while (height > 0);
L
Linus Torvalds 已提交
604

605 606 607 608 609
	if (nodep)
		*nodep = parent;
	if (slotp)
		*slotp = slot;
	return node;
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
}

/**
 *	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)
{
627 628 629 630 631
	void **slot;

	if (!__radix_tree_lookup(root, index, NULL, &slot))
		return NULL;
	return slot;
632 633 634 635 636 637 638 639 640
}
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.
641 642 643 644 645
 *
 *	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.
646 647 648
 */
void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
{
649
	return __radix_tree_lookup(root, index, NULL, NULL);
L
Linus Torvalds 已提交
650 651 652 653 654 655 656 657 658
}
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
 *
659 660
 *	Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
 *	corresponding to @index in the radix tree.  From
L
Linus Torvalds 已提交
661 662 663 664 665 666
 *	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,
667
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
668 669
{
	unsigned int height, shift;
670
	struct radix_tree_node *slot;
L
Linus Torvalds 已提交
671 672

	height = root->height;
673
	BUG_ON(index > radix_tree_maxindex(height));
L
Linus Torvalds 已提交
674

N
Nick Piggin 已提交
675
	slot = indirect_to_ptr(root->rnode);
N
Nick Piggin 已提交
676
	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
677 678 679 680 681

	while (height > 0) {
		int offset;

		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
682 683
		if (!tag_get(slot, tag, offset))
			tag_set(slot, tag, offset);
684 685
		slot = slot->slots[offset];
		BUG_ON(slot == NULL);
686 687
		if (!radix_tree_is_indirect_ptr(slot))
			break;
688
		slot = indirect_to_ptr(slot);
L
Linus Torvalds 已提交
689 690 691 692
		shift -= RADIX_TREE_MAP_SHIFT;
		height--;
	}

N
Nick Piggin 已提交
693 694 695 696
	/* set the root's tag bit */
	if (slot && !root_tag_get(root, tag))
		root_tag_set(root, tag);

697
	return slot;
L
Linus Torvalds 已提交
698 699 700 701 702 703 704 705 706
}
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
 *
707 708
 *	Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
 *	corresponding to @index in the radix tree.  If
L
Linus Torvalds 已提交
709 710 711 712 713 714 715
 *	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,
716
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
717
{
718
	struct radix_tree_node *node = NULL;
N
Nick Piggin 已提交
719
	struct radix_tree_node *slot = NULL;
L
Linus Torvalds 已提交
720
	unsigned int height, shift;
721
	int uninitialized_var(offset);
L
Linus Torvalds 已提交
722 723 724 725 726

	height = root->height;
	if (index > radix_tree_maxindex(height))
		goto out;

727
	shift = height * RADIX_TREE_MAP_SHIFT;
728
	slot = root->rnode;
L
Linus Torvalds 已提交
729

730
	while (shift) {
731
		if (slot == NULL)
L
Linus Torvalds 已提交
732
			goto out;
733 734
		if (!radix_tree_is_indirect_ptr(slot))
			break;
735
		slot = indirect_to_ptr(slot);
L
Linus Torvalds 已提交
736

737
		shift -= RADIX_TREE_MAP_SHIFT;
L
Linus Torvalds 已提交
738
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
739
		node = slot;
740
		slot = slot->slots[offset];
L
Linus Torvalds 已提交
741 742
	}

N
Nick Piggin 已提交
743
	if (slot == NULL)
L
Linus Torvalds 已提交
744 745
		goto out;

746 747
	while (node) {
		if (!tag_get(node, tag, offset))
748
			goto out;
749 750
		tag_clear(node, tag, offset);
		if (any_tag_set(node, tag))
751
			goto out;
752 753 754 755

		index >>= RADIX_TREE_MAP_SHIFT;
		offset = index & RADIX_TREE_MAP_MASK;
		node = node->parent;
N
Nick Piggin 已提交
756 757 758 759 760 761
	}

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

L
Linus Torvalds 已提交
762
out:
N
Nick Piggin 已提交
763
	return slot;
L
Linus Torvalds 已提交
764 765 766 767
}
EXPORT_SYMBOL(radix_tree_tag_clear);

/**
768 769 770
 * radix_tree_tag_get - get a tag on a radix tree node
 * @root:		radix tree root
 * @index:		index key
771
 * @tag: 		tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
772
 *
773
 * Return values:
L
Linus Torvalds 已提交
774
 *
N
Nick Piggin 已提交
775 776
 *  0: tag not present or not set
 *  1: tag set
777 778 779 780
 *
 * 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 已提交
781 782
 */
int radix_tree_tag_get(struct radix_tree_root *root,
783
			unsigned long index, unsigned int tag)
L
Linus Torvalds 已提交
784 785
{
	unsigned int height, shift;
786
	struct radix_tree_node *node;
L
Linus Torvalds 已提交
787

N
Nick Piggin 已提交
788 789 790 791
	/* check the root's tag bit */
	if (!root_tag_get(root, tag))
		return 0;

792
	node = rcu_dereference_raw(root->rnode);
793 794 795
	if (node == NULL)
		return 0;

N
Nick Piggin 已提交
796
	if (!radix_tree_is_indirect_ptr(node))
797
		return (index == 0);
N
Nick Piggin 已提交
798
	node = indirect_to_ptr(node);
799

800
	height = node->path & RADIX_TREE_HEIGHT_MASK;
801 802
	if (index > radix_tree_maxindex(height))
		return 0;
N
Nick Piggin 已提交
803

L
Linus Torvalds 已提交
804 805 806 807 808
	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;

	for ( ; ; ) {
		int offset;

809
		if (node == NULL)
L
Linus Torvalds 已提交
810
			return 0;
811
		node = indirect_to_ptr(node);
L
Linus Torvalds 已提交
812 813

		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
814
		if (!tag_get(node, tag, offset))
815
			return 0;
816
		if (height == 1)
817
			return 1;
818
		node = rcu_dereference_raw(node->slots[offset]);
819 820
		if (!radix_tree_is_indirect_ptr(node))
			return 1;
L
Linus Torvalds 已提交
821 822 823 824 825 826
		shift -= RADIX_TREE_MAP_SHIFT;
		height--;
	}
}
EXPORT_SYMBOL(radix_tree_tag_get);

827 828 829 830 831 832 833 834 835 836 837 838 839
/**
 * 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;
840
	unsigned long index, offset, height;
841 842 843 844 845 846 847 848 849

	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.
850 851 852
	 *
	 * This condition also used by radix_tree_next_slot() to stop
	 * contiguous iterating, and forbid swithing to the next chunk.
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
	 */
	index = iter->next_index;
	if (!index && iter->index)
		return NULL;

	rnode = rcu_dereference_raw(root->rnode);
	if (radix_tree_is_indirect_ptr(rnode)) {
		rnode = indirect_to_ptr(rnode);
	} else if (rnode && !index) {
		/* Single-slot tree */
		iter->index = 0;
		iter->next_index = 1;
		iter->tags = 1;
		return (void **)&root->rnode;
	} else
		return NULL;

restart:
871 872
	height = rnode->path & RADIX_TREE_HEIGHT_MASK;
	shift = (height - 1) * RADIX_TREE_MAP_SHIFT;
873 874 875 876 877 878 879 880
	offset = index >> shift;

	/* Index outside of the tree */
	if (offset >= RADIX_TREE_MAP_SIZE)
		return NULL;

	node = rnode;
	while (1) {
881
		struct radix_tree_node *slot;
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
		if ((flags & RADIX_TREE_ITER_TAGGED) ?
				!test_bit(offset, node->tags[tag]) :
				!node->slots[offset]) {
			/* 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) {
					if (node->slots[offset])
						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;
		}

		/* This is leaf-node */
		if (!shift)
			break;

912 913
		slot = rcu_dereference_raw(node->slots[offset]);
		if (slot == NULL)
914
			goto restart;
915 916 917
		if (!radix_tree_is_indirect_ptr(slot))
			break;
		node = indirect_to_ptr(slot);
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
		shift -= RADIX_TREE_MAP_SHIFT;
		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
	}

	/* Update the iterator state */
	iter->index = index;
	iter->next_index = (index | RADIX_TREE_MAP_MASK) + 1;

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

948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
/**
 * 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.
 *
963 964 965 966 967 968 969
 * 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).
 *
970 971
 * The function returns number of leaves where the tag was set and sets
 * *first_indexp to the first unscanned index.
972 973
 * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
 * be prepared to handle that.
974 975 976 977 978 979
 */
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)
{
980
	unsigned int height = root->height;
981
	struct radix_tree_node *node = NULL;
982 983 984 985
	struct radix_tree_node *slot;
	unsigned int shift;
	unsigned long tagged = 0;
	unsigned long index = *first_indexp;
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002

	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 已提交
1003
	slot = indirect_to_ptr(root->rnode);
1004 1005

	for (;;) {
1006
		unsigned long upindex;
1007 1008 1009 1010 1011 1012 1013
		int offset;

		offset = (index >> shift) & RADIX_TREE_MAP_MASK;
		if (!slot->slots[offset])
			goto next;
		if (!tag_get(slot, iftag, offset))
			goto next;
1014 1015
		if (shift) {
			node = slot;
1016
			slot = slot->slots[offset];
1017 1018 1019 1020 1021 1022 1023 1024
			if (radix_tree_is_indirect_ptr(slot)) {
				slot = indirect_to_ptr(slot);
				shift -= RADIX_TREE_MAP_SHIFT;
				continue;
			} else {
				slot = node;
				node = node->parent;
			}
1025 1026 1027
		}

		/* tag the leaf */
1028
		tagged += 1 << shift;
1029
		tag_set(slot, settag, offset);
1030 1031

		/* walk back up the path tagging interior nodes */
1032 1033 1034 1035 1036
		upindex = index;
		while (node) {
			upindex >>= RADIX_TREE_MAP_SHIFT;
			offset = upindex & RADIX_TREE_MAP_MASK;

1037
			/* stop if we find a node with the tag already set */
1038
			if (tag_get(node, settag, offset))
1039
				break;
1040 1041
			tag_set(node, settag, offset);
			node = node->parent;
1042
		}
1043

1044 1045 1046 1047 1048 1049 1050 1051 1052
		/*
		 * 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;

1053 1054 1055
next:
		/* Go to next item at level determined by 'shift' */
		index = ((index >> shift) + 1) << shift;
1056 1057
		/* Overflow can happen when last_index is ~0UL... */
		if (index > last_index || !index)
1058 1059 1060 1061 1062 1063 1064 1065 1066
			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.
			 */
1067
			slot = slot->parent;
1068 1069 1070 1071
			shift += RADIX_TREE_MAP_SHIFT;
		}
	}
	/*
1072 1073
	 * 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.
1074
	 */
1075 1076
	if (tagged > 0)
		root_tag_set(root, settag);
1077 1078 1079 1080 1081 1082
	*first_indexp = index;

	return tagged;
}
EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);

L
Linus Torvalds 已提交
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
/**
 *	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.
1095 1096 1097 1098 1099 1100
 *
 *	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 已提交
1101 1102 1103 1104 1105
 */
unsigned int
radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
			unsigned long first_index, unsigned int max_items)
{
1106 1107 1108
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1109

1110
	if (unlikely(!max_items))
1111
		return 0;
L
Linus Torvalds 已提交
1112

1113
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
1114
		results[ret] = rcu_dereference_raw(*slot);
1115 1116
		if (!results[ret])
			continue;
1117 1118 1119 1120
		if (radix_tree_is_indirect_ptr(results[ret])) {
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1121
		if (++ret == max_items)
L
Linus Torvalds 已提交
1122 1123
			break;
	}
1124

L
Linus Torvalds 已提交
1125 1126 1127 1128
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup);

1129 1130 1131 1132
/**
 *	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
1133
 *	@indices:	where their indices should be placed (but usually NULL)
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
 *	@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
1148 1149
radix_tree_gang_lookup_slot(struct radix_tree_root *root,
			void ***results, unsigned long *indices,
1150 1151
			unsigned long first_index, unsigned int max_items)
{
1152 1153 1154
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1155

1156
	if (unlikely(!max_items))
1157 1158
		return 0;

1159 1160
	radix_tree_for_each_slot(slot, root, &iter, first_index) {
		results[ret] = slot;
1161
		if (indices)
1162 1163
			indices[ret] = iter.index;
		if (++ret == max_items)
1164 1165 1166 1167 1168 1169 1170
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_slot);

L
Linus Torvalds 已提交
1171 1172 1173 1174 1175 1176 1177
/**
 *	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
1178
 *	@tag:		the tag index (< RADIX_TREE_MAX_TAGS)
L
Linus Torvalds 已提交
1179 1180 1181 1182 1183 1184 1185
 *
 *	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,
1186 1187
		unsigned long first_index, unsigned int max_items,
		unsigned int tag)
L
Linus Torvalds 已提交
1188
{
1189 1190 1191
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
N
Nick Piggin 已提交
1192

1193
	if (unlikely(!max_items))
1194 1195
		return 0;

1196
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1197
		results[ret] = rcu_dereference_raw(*slot);
1198 1199
		if (!results[ret])
			continue;
1200 1201 1202 1203
		if (radix_tree_is_indirect_ptr(results[ret])) {
			slot = radix_tree_iter_retry(&iter);
			continue;
		}
1204
		if (++ret == max_items)
L
Linus Torvalds 已提交
1205 1206
			break;
	}
1207

L
Linus Torvalds 已提交
1208 1209 1210 1211
	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag);

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
/**
 *	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)
{
1230 1231 1232
	struct radix_tree_iter iter;
	void **slot;
	unsigned int ret = 0;
1233

1234
	if (unlikely(!max_items))
1235 1236
		return 0;

1237 1238 1239
	radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
		results[ret] = slot;
		if (++ret == max_items)
1240 1241 1242 1243 1244 1245 1246
			break;
	}

	return ret;
}
EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);

1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
#if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
#include <linux/sched.h> /* for cond_resched() */

/*
 * This linear search is at present only useful to shmem_unuse_inode().
 */
static unsigned long __locate(struct radix_tree_node *slot, void *item,
			      unsigned long index, unsigned long *found_index)
{
	unsigned int shift, height;
	unsigned long i;

1259
	height = slot->path & RADIX_TREE_HEIGHT_MASK;
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
	shift = (height-1) * RADIX_TREE_MAP_SHIFT;

	for ( ; height > 1; height--) {
		i = (index >> shift) & RADIX_TREE_MAP_MASK;
		for (;;) {
			if (slot->slots[i] != NULL)
				break;
			index &= ~((1UL << shift) - 1);
			index += 1UL << shift;
			if (index == 0)
				goto out;	/* 32-bit wraparound */
			i++;
			if (i == RADIX_TREE_MAP_SIZE)
				goto out;
		}

		slot = rcu_dereference_raw(slot->slots[i]);
		if (slot == NULL)
			goto out;
1279 1280 1281 1282 1283 1284 1285 1286 1287
		if (!radix_tree_is_indirect_ptr(slot)) {
			if (slot == item) {
				*found_index = index + i;
				index = 0;
			} else {
				index += shift;
			}
			goto out;
		}
1288
		slot = indirect_to_ptr(slot);
1289
		shift -= RADIX_TREE_MAP_SHIFT;
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
	}

	/* Bottom level: check items */
	for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
		if (slot->slots[i] == item) {
			*found_index = index + i;
			index = 0;
			goto out;
		}
	}
	index += RADIX_TREE_MAP_SIZE;
out:
	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;
	unsigned long found_index = -1;

	do {
		rcu_read_lock();
		node = rcu_dereference_raw(root->rnode);
		if (!radix_tree_is_indirect_ptr(node)) {
			rcu_read_unlock();
			if (node == item)
				found_index = 0;
			break;
		}

		node = indirect_to_ptr(node);
1332 1333
		max_index = radix_tree_maxindex(node->path &
						RADIX_TREE_HEIGHT_MASK);
1334 1335
		if (cur_index > max_index) {
			rcu_read_unlock();
1336
			break;
1337
		}
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351

		cur_index = __locate(node, item, cur_index, &found_index);
		rcu_read_unlock();
		cond_resched();
	} while (cur_index != 0 && cur_index <= max_index);

	return found_index;
}
#else
unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
{
	return -1;
}
#endif /* CONFIG_SHMEM && CONFIG_SWAP */
1352

1353 1354 1355 1356 1357 1358 1359
/**
 *	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 已提交
1360
	while (root->height > 0) {
1361
		struct radix_tree_node *to_free = root->rnode;
1362
		struct radix_tree_node *slot;
1363

N
Nick Piggin 已提交
1364
		BUG_ON(!radix_tree_is_indirect_ptr(to_free));
N
Nick Piggin 已提交
1365
		to_free = indirect_to_ptr(to_free);
N
Nick Piggin 已提交
1366 1367 1368

		/*
		 * The candidate node has more than one child, or its child
1369 1370
		 * is not at the leftmost slot, or it is a multiorder entry,
		 * we cannot shrink.
N
Nick Piggin 已提交
1371 1372 1373
		 */
		if (to_free->count != 1)
			break;
1374 1375
		slot = to_free->slots[0];
		if (!slot)
N
Nick Piggin 已提交
1376 1377
			break;

1378 1379
		/*
		 * We don't need rcu_assign_pointer(), since we are simply
N
Nick Piggin 已提交
1380 1381
		 * moving the node from one part of the tree to another: if it
		 * was safe to dereference the old pointer to it
1382
		 * (to_free->slots[0]), it will be safe to dereference the new
N
Nick Piggin 已提交
1383
		 * one (root->rnode) as far as dependent read barriers go.
1384
		 */
1385
		if (root->height > 1) {
1386 1387 1388
			if (!radix_tree_is_indirect_ptr(slot))
				break;

1389
			slot = indirect_to_ptr(slot);
1390 1391 1392 1393
			slot->parent = NULL;
			slot = ptr_to_indirect(slot);
		}
		root->rnode = slot;
1394
		root->height--;
N
Nick Piggin 已提交
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417

		/*
		 * 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.
		 */
		if (root->height == 0)
			*((unsigned long *)&to_free->slots[0]) |=
						RADIX_TREE_INDIRECT_PTR;

1418 1419 1420 1421
		radix_tree_node_free(to_free);
	}
}

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
/**
 *	__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.
 */
1433
bool __radix_tree_delete_node(struct radix_tree_root *root,
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
			      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) {
1452
			unsigned int offset;
1453

1454 1455
			offset = node->path >> RADIX_TREE_HEIGHT_SHIFT;
			parent->slots[offset] = NULL;
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
			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;
}

L
Linus Torvalds 已提交
1472
/**
1473
 *	radix_tree_delete_item    -    delete an item from a radix tree
L
Linus Torvalds 已提交
1474 1475
 *	@root:		radix tree root
 *	@index:		index key
1476
 *	@item:		expected item
L
Linus Torvalds 已提交
1477
 *
1478
 *	Remove @item at @index from the radix tree rooted at @root.
L
Linus Torvalds 已提交
1479
 *
1480 1481
 *	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 已提交
1482
 */
1483 1484
void *radix_tree_delete_item(struct radix_tree_root *root,
			     unsigned long index, void *item)
L
Linus Torvalds 已提交
1485
{
1486
	struct radix_tree_node *node;
1487
	unsigned int offset, i;
1488 1489
	void **slot;
	void *entry;
1490
	int tag;
L
Linus Torvalds 已提交
1491

1492 1493 1494
	entry = __radix_tree_lookup(root, index, &node, &slot);
	if (!entry)
		return NULL;
L
Linus Torvalds 已提交
1495

1496 1497 1498 1499
	if (item && entry != item)
		return NULL;

	if (!node) {
N
Nick Piggin 已提交
1500 1501
		root_tag_clear_all(root);
		root->rnode = NULL;
1502
		return entry;
N
Nick Piggin 已提交
1503
	}
L
Linus Torvalds 已提交
1504

1505
	offset = index & RADIX_TREE_MAP_MASK;
1506

L
Linus Torvalds 已提交
1507
	/*
1508 1509
	 * 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 已提交
1510
	 */
1511
	for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
1512
		if (tag_get(node, tag, offset))
N
Nick Piggin 已提交
1513
			radix_tree_tag_clear(root, index, tag);
1514
	}
L
Linus Torvalds 已提交
1515

1516 1517 1518 1519 1520 1521 1522
	/* Delete any sibling slots pointing to this slot */
	for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
		if (node->slots[offset + i] != ptr_to_indirect(slot))
			break;
		node->slots[offset + i] = NULL;
		node->count--;
	}
1523 1524
	node->slots[offset] = NULL;
	node->count--;
1525

1526
	__radix_tree_delete_node(root, node);
N
Nick Piggin 已提交
1527

1528
	return entry;
L
Linus Torvalds 已提交
1529
}
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
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 已提交
1545 1546 1547 1548 1549 1550 1551
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
 */
1552
int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
L
Linus Torvalds 已提交
1553
{
N
Nick Piggin 已提交
1554
	return root_tag_get(root, tag);
L
Linus Torvalds 已提交
1555 1556 1557 1558
}
EXPORT_SYMBOL(radix_tree_tagged);

static void
1559
radix_tree_node_ctor(void *arg)
L
Linus Torvalds 已提交
1560
{
1561 1562 1563 1564
	struct radix_tree_node *node = arg;

	memset(node, 0, sizeof(*node));
	INIT_LIST_HEAD(&node->private_list);
L
Linus Torvalds 已提交
1565 1566 1567 1568
}

static __init unsigned long __maxindex(unsigned int height)
{
1569 1570 1571 1572 1573 1574 1575 1576
	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 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
}

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;
1593
       struct radix_tree_node *node;
L
Linus Torvalds 已提交
1594 1595

       /* Free per-cpu pool of perloaded nodes */
1596
       if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
L
Linus Torvalds 已提交
1597 1598
               rtp = &per_cpu(radix_tree_preloads, cpu);
               while (rtp->nr) {
1599 1600 1601 1602
			node = rtp->nodes;
			rtp->nodes = node->private_data;
			kmem_cache_free(radix_tree_node_cachep, node);
			rtp->nr--;
L
Linus Torvalds 已提交
1603 1604 1605 1606 1607 1608 1609 1610 1611
               }
       }
       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 已提交
1612 1613
			SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
			radix_tree_node_ctor);
L
Linus Torvalds 已提交
1614 1615 1616
	radix_tree_init_maxindex();
	hotcpu_notifier(radix_tree_callback, 0);
}