lib/radix-tree.c

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