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, *slot;
 503         unsigned long maxindex;
 504         unsigned int shift, offset;
 505         unsigned long max = index | ((1UL << order) - 1);
 506
 507         shift = radix_tree_load_root(root, &slot, &maxindex);
 508
 509         /* Make sure the tree is high enough.  */
 510         if (max > maxindex) {
 511                 int error = radix_tree_extend(root, max, shift);
 512                 if (error < 0)
 513                         return error;
 514                 shift = error;
 515                 slot = root->rnode;
 516                 if (order == shift)
 517                         shift += RADIX_TREE_MAP_SHIFT;
 518         }
 519
 520         offset = 0;                     /* uninitialised var warning */
 521         while (shift > order) {
 522                 shift -= RADIX_TREE_MAP_SHIFT;
 523                 if (slot == NULL) {
 524                         /* Have to add a child node.  */
 525                         slot = radix_tree_node_alloc(root);
 526                         if (!slot)
 527                                 return -ENOMEM;
 528                         slot->shift = shift;
 529                         slot->offset = offset;
 530                         slot->parent = node;
 531                         if (node) {
 532                                 rcu_assign_pointer(node->slots[offset],
 533                                                         node_to_entry(slot));
 534                                 node->count++;
 535                         } else
 536                                 rcu_assign_pointer(root->rnode,
 537                                                         node_to_entry(slot));
 538                 } else if (!radix_tree_is_internal_node(slot))
 539                         break;
 540
 541                 /* Go a level down */
 542                 node = entry_to_node(slot);
 543                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 544                 offset = radix_tree_descend(node, &slot, offset);
 545         }
 546
 547 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 548         /* Insert pointers to the canonical entry */
 549         if (order > shift) {
 550                 int i, n = 1 << (order - shift);
 551                 offset = offset & ~(n - 1);
 552                 slot = node_to_entry(&node->slots[offset]);
 553                 for (i = 0; i < n; i++) {
 554                         if (node->slots[offset + i])
 555                                 return -EEXIST;
 556                 }
 557
 558                 for (i = 1; i < n; i++) {
 559                         rcu_assign_pointer(node->slots[offset + i], slot);
 560                         node->count++;
 561                 }
 562         }
 563 #endif
 564
 565         if (nodep)
 566                 *nodep = node;
 567         if (slotp)
 568                 *slotp = node ? node->slots + offset : (void **)&root->rnode;
 569         return 0;
 570 }
 571
 572 /**
 573  *      __radix_tree_insert    -    insert into a radix tree
 574  *      @root:          radix tree root
 575  *      @index:         index key
 576  *      @order:         key covers the 2^order indices around index
 577  *      @item:          item to insert
 578  *
 579  *      Insert an item into the radix tree at position @index.
 580  */
 581 int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
 582                         unsigned order, void *item)
 583 {
 584         struct radix_tree_node *node;
 585         void **slot;
 586         int error;
 587
 588         BUG_ON(radix_tree_is_internal_node(item));
 589
 590         error = __radix_tree_create(root, index, order, &node, &slot);
 591         if (error)
 592                 return error;
 593         if (*slot != NULL)
 594                 return -EEXIST;
 595         rcu_assign_pointer(*slot, item);
 596
 597         if (node) {
 598                 unsigned offset = get_slot_offset(node, slot);
 599                 node->count++;
 600                 BUG_ON(tag_get(node, 0, offset));
 601                 BUG_ON(tag_get(node, 1, offset));
 602                 BUG_ON(tag_get(node, 2, offset));
 603         } else {
 604                 BUG_ON(root_tags_get(root));
 605         }
 606
 607         return 0;
 608 }
 609 EXPORT_SYMBOL(__radix_tree_insert);
 610
 611 /**
 612  *      __radix_tree_lookup     -       lookup an item in a radix tree
 613  *      @root:          radix tree root
 614  *      @index:         index key
 615  *      @nodep:         returns node
 616  *      @slotp:         returns slot
 617  *
 618  *      Lookup and return the item at position @index in the radix
 619  *      tree @root.
 620  *
 621  *      Until there is more than one item in the tree, no nodes are
 622  *      allocated and @root->rnode is used as a direct slot instead of
 623  *      pointing to a node, in which case *@nodep will be NULL.
 624  */
 625 void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
 626                           struct radix_tree_node **nodep, void ***slotp)
 627 {
 628         struct radix_tree_node *node, *parent;
 629         unsigned long maxindex;
 630         unsigned int shift;
 631         void **slot;
 632
 633  restart:
 634         parent = NULL;
 635         slot = (void **)&root->rnode;
 636         shift = radix_tree_load_root(root, &node, &maxindex);
 637         if (index > maxindex)
 638                 return NULL;
 639
 640         while (radix_tree_is_internal_node(node)) {
 641                 unsigned offset;
 642
 643                 if (node == RADIX_TREE_RETRY)
 644                         goto restart;
 645                 parent = entry_to_node(node);
 646                 shift -= RADIX_TREE_MAP_SHIFT;
 647                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 648                 offset = radix_tree_descend(parent, &node, offset);
 649                 slot = parent->slots + offset;
 650         }
 651
 652         if (nodep)
 653                 *nodep = parent;
 654         if (slotp)
 655                 *slotp = slot;
 656         return node;
 657 }
 658
 659 /**
 660  *      radix_tree_lookup_slot    -    lookup a slot in a radix tree
 661  *      @root:          radix tree root
 662  *      @index:         index key
 663  *
 664  *      Returns:  the slot corresponding to the position @index in the
 665  *      radix tree @root. This is useful for update-if-exists operations.
 666  *
 667  *      This function can be called under rcu_read_lock iff the slot is not
 668  *      modified by radix_tree_replace_slot, otherwise it must be called
 669  *      exclusive from other writers. Any dereference of the slot must be done
 670  *      using radix_tree_deref_slot.
 671  */
 672 void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
 673 {
 674         void **slot;
 675
 676         if (!__radix_tree_lookup(root, index, NULL, &slot))
 677                 return NULL;
 678         return slot;
 679 }
 680 EXPORT_SYMBOL(radix_tree_lookup_slot);
 681
 682 /**
 683  *      radix_tree_lookup    -    perform lookup operation on a radix tree
 684  *      @root:          radix tree root
 685  *      @index:         index key
 686  *
 687  *      Lookup the item at the position @index in the radix tree @root.
 688  *
 689  *      This function can be called under rcu_read_lock, however the caller
 690  *      must manage lifetimes of leaf nodes (eg. RCU may also be used to free
 691  *      them safely). No RCU barriers are required to access or modify the
 692  *      returned item, however.
 693  */
 694 void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
 695 {
 696         return __radix_tree_lookup(root, index, NULL, NULL);
 697 }
 698 EXPORT_SYMBOL(radix_tree_lookup);
 699
 700 /**
 701  *      radix_tree_tag_set - set a tag on a radix tree node
 702  *      @root:          radix tree root
 703  *      @index:         index key
 704  *      @tag:           tag index
 705  *
 706  *      Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
 707  *      corresponding to @index in the radix tree.  From
 708  *      the root all the way down to the leaf node.
 709  *
 710  *      Returns the address of the tagged item.  Setting a tag on a not-present
 711  *      item is a bug.
 712  */
 713 void *radix_tree_tag_set(struct radix_tree_root *root,
 714                         unsigned long index, unsigned int tag)
 715 {
 716         struct radix_tree_node *node, *parent;
 717         unsigned long maxindex;
 718         unsigned int shift;
 719
 720         shift = radix_tree_load_root(root, &node, &maxindex);
 721         BUG_ON(index > maxindex);
 722
 723         while (radix_tree_is_internal_node(node)) {
 724                 unsigned offset;
 725
 726                 shift -= RADIX_TREE_MAP_SHIFT;
 727                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 728
 729                 parent = entry_to_node(node);
 730                 offset = radix_tree_descend(parent, &node, offset);
 731                 BUG_ON(!node);
 732
 733                 if (!tag_get(parent, tag, offset))
 734                         tag_set(parent, tag, offset);
 735         }
 736
 737         /* set the root's tag bit */
 738         if (!root_tag_get(root, tag))
 739                 root_tag_set(root, tag);
 740
 741         return node;
 742 }
 743 EXPORT_SYMBOL(radix_tree_tag_set);
 744
 745 /**
 746  *      radix_tree_tag_clear - clear a tag on a radix tree node
 747  *      @root:          radix tree root
 748  *      @index:         index key
 749  *      @tag:           tag index
 750  *
 751  *      Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
 752  *      corresponding to @index in the radix tree.  If this causes
 753  *      the leaf node to have no tags set then clear the tag in the
 754  *      next-to-leaf node, etc.
 755  *
 756  *      Returns the address of the tagged item on success, else NULL.  ie:
 757  *      has the same return value and semantics as radix_tree_lookup().
 758  */
 759 void *radix_tree_tag_clear(struct radix_tree_root *root,
 760                         unsigned long index, unsigned int tag)
 761 {
 762         struct radix_tree_node *node, *parent;
 763         unsigned long maxindex;
 764         unsigned int shift;
 765         int uninitialized_var(offset);
 766
 767         shift = radix_tree_load_root(root, &node, &maxindex);
 768         if (index > maxindex)
 769                 return NULL;
 770
 771         parent = NULL;
 772
 773         while (radix_tree_is_internal_node(node)) {
 774                 shift -= RADIX_TREE_MAP_SHIFT;
 775                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 776
 777                 parent = entry_to_node(node);
 778                 offset = radix_tree_descend(parent, &node, offset);
 779         }
 780
 781         if (node == NULL)
 782                 goto out;
 783
 784         index >>= shift;
 785
 786         while (parent) {
 787                 if (!tag_get(parent, tag, offset))
 788                         goto out;
 789                 tag_clear(parent, tag, offset);
 790                 if (any_tag_set(parent, tag))
 791                         goto out;
 792
 793                 index >>= RADIX_TREE_MAP_SHIFT;
 794                 offset = index & RADIX_TREE_MAP_MASK;
 795                 parent = parent->parent;
 796         }
 797
 798         /* clear the root's tag bit */
 799         if (root_tag_get(root, tag))
 800                 root_tag_clear(root, tag);
 801
 802 out:
 803         return node;
 804 }
 805 EXPORT_SYMBOL(radix_tree_tag_clear);
 806
 807 /**
 808  * radix_tree_tag_get - get a tag on a radix tree node
 809  * @root:               radix tree root
 810  * @index:              index key
 811  * @tag:                tag index (< RADIX_TREE_MAX_TAGS)
 812  *
 813  * Return values:
 814  *
 815  *  0: tag not present or not set
 816  *  1: tag set
 817  *
 818  * Note that the return value of this function may not be relied on, even if
 819  * the RCU lock is held, unless tag modification and node deletion are excluded
 820  * from concurrency.
 821  */
 822 int radix_tree_tag_get(struct radix_tree_root *root,
 823                         unsigned long index, unsigned int tag)
 824 {
 825         struct radix_tree_node *node, *parent;
 826         unsigned long maxindex;
 827         unsigned int shift;
 828
 829         if (!root_tag_get(root, tag))
 830                 return 0;
 831
 832         shift = radix_tree_load_root(root, &node, &maxindex);
 833         if (index > maxindex)
 834                 return 0;
 835         if (node == NULL)
 836                 return 0;
 837
 838         while (radix_tree_is_internal_node(node)) {
 839                 int offset;
 840
 841                 shift -= RADIX_TREE_MAP_SHIFT;
 842                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 843
 844                 parent = entry_to_node(node);
 845                 offset = radix_tree_descend(parent, &node, offset);
 846
 847                 if (!node)
 848                         return 0;
 849                 if (!tag_get(parent, tag, offset))
 850                         return 0;
 851                 if (node == RADIX_TREE_RETRY)
 852                         break;
 853         }
 854
 855         return 1;
 856 }
 857 EXPORT_SYMBOL(radix_tree_tag_get);
 858
 859 static inline void __set_iter_shift(struct radix_tree_iter *iter,
 860                                         unsigned int shift)
 861 {
 862 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 863         iter->shift = shift;
 864 #endif
 865 }
 866
 867 /**
 868  * radix_tree_next_chunk - find next chunk of slots for iteration
 869  *
 870  * @root:       radix tree root
 871  * @iter:       iterator state
 872  * @flags:      RADIX_TREE_ITER_* flags and tag index
 873  * Returns:     pointer to chunk first slot, or NULL if iteration is over
 874  */
 875 void **radix_tree_next_chunk(struct radix_tree_root *root,
 876                              struct radix_tree_iter *iter, unsigned flags)
 877 {
 878         unsigned shift, tag = flags & RADIX_TREE_ITER_TAG_MASK;
 879         struct radix_tree_node *node, *child;
 880         unsigned long index, offset, maxindex;
 881
 882         if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
 883                 return NULL;
 884
 885         /*
 886          * Catch next_index overflow after ~0UL. iter->index never overflows
 887          * during iterating; it can be zero only at the beginning.
 888          * And we cannot overflow iter->next_index in a single step,
 889          * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
 890          *
 891          * This condition also used by radix_tree_next_slot() to stop
 892          * contiguous iterating, and forbid swithing to the next chunk.
 893          */
 894         index = iter->next_index;
 895         if (!index && iter->index)
 896                 return NULL;
 897
 898  restart:
 899         shift = radix_tree_load_root(root, &child, &maxindex);
 900         if (index > maxindex)
 901                 return NULL;
 902         if (!child)
 903                 return NULL;
 904
 905         if (!radix_tree_is_internal_node(child)) {
 906                 /* Single-slot tree */
 907                 iter->index = index;
 908                 iter->next_index = maxindex + 1;
 909                 iter->tags = 1;
 910                 __set_iter_shift(iter, 0);
 911                 return (void **)&root->rnode;
 912         }
 913
 914         do {
 915                 node = entry_to_node(child);
 916                 shift -= RADIX_TREE_MAP_SHIFT;
 917                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
 918                 offset = radix_tree_descend(node, &child, offset);
 919
 920                 if ((flags & RADIX_TREE_ITER_TAGGED) ?
 921                                 !tag_get(node, tag, offset) : !child) {
 922                         /* Hole detected */
 923                         if (flags & RADIX_TREE_ITER_CONTIG)
 924                                 return NULL;
 925
 926                         if (flags & RADIX_TREE_ITER_TAGGED)
 927                                 offset = radix_tree_find_next_bit(
 928                                                 node->tags[tag],
 929                                                 RADIX_TREE_MAP_SIZE,
 930                                                 offset + 1);
 931                         else
 932                                 while (++offset < RADIX_TREE_MAP_SIZE) {
 933                                         void *slot = node->slots[offset];
 934                                         if (is_sibling_entry(node, slot))
 935                                                 continue;
 936                                         if (slot)
 937                                                 break;
 938                                 }
 939                         index &= ~node_maxindex(node);
 940                         index += offset << shift;
 941                         /* Overflow after ~0UL */
 942                         if (!index)
 943                                 return NULL;
 944                         if (offset == RADIX_TREE_MAP_SIZE)
 945                                 goto restart;
 946                         child = rcu_dereference_raw(node->slots[offset]);
 947                 }
 948
 949                 if ((child == NULL) || (child == RADIX_TREE_RETRY))
 950                         goto restart;
 951         } while (radix_tree_is_internal_node(child));
 952
 953         /* Update the iterator state */
 954         iter->index = (index &~ node_maxindex(node)) | (offset << node->shift);
 955         iter->next_index = (index | node_maxindex(node)) + 1;
 956         __set_iter_shift(iter, shift);
 957
 958         /* Construct iter->tags bit-mask from node->tags[tag] array */
 959         if (flags & RADIX_TREE_ITER_TAGGED) {
 960                 unsigned tag_long, tag_bit;
 961
 962                 tag_long = offset / BITS_PER_LONG;
 963                 tag_bit  = offset % BITS_PER_LONG;
 964                 iter->tags = node->tags[tag][tag_long] >> tag_bit;
 965                 /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
 966                 if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
 967                         /* Pick tags from next element */
 968                         if (tag_bit)
 969                                 iter->tags |= node->tags[tag][tag_long + 1] <<
 970                                                 (BITS_PER_LONG - tag_bit);
 971                         /* Clip chunk size, here only BITS_PER_LONG tags */
 972                         iter->next_index = index + BITS_PER_LONG;
 973                 }
 974         }
 975
 976         return node->slots + offset;
 977 }
 978 EXPORT_SYMBOL(radix_tree_next_chunk);
 979
 980 /**
 981  * radix_tree_range_tag_if_tagged - for each item in given range set given
 982  *                                 tag if item has another tag set
 983  * @root:               radix tree root
 984  * @first_indexp:       pointer to a starting index of a range to scan
 985  * @last_index:         last index of a range to scan
 986  * @nr_to_tag:          maximum number items to tag
 987  * @iftag:              tag index to test
 988  * @settag:             tag index to set if tested tag is set
 989  *
 990  * This function scans range of radix tree from first_index to last_index
 991  * (inclusive).  For each item in the range if iftag is set, the function sets
 992  * also settag. The function stops either after tagging nr_to_tag items or
 993  * after reaching last_index.
 994  *
 995  * The tags must be set from the leaf level only and propagated back up the
 996  * path to the root. We must do this so that we resolve the full path before
 997  * setting any tags on intermediate nodes. If we set tags as we descend, then
 998  * we can get to the leaf node and find that the index that has the iftag
 999  * set is outside the range we are scanning. This reults in dangling tags and
1000  * can lead to problems with later tag operations (e.g. livelocks on lookups).
1001  *
1002  * The function returns the number of leaves where the tag was set and sets
1003  * *first_indexp to the first unscanned index.
1004  * WARNING! *first_indexp can wrap if last_index is ULONG_MAX. Caller must
1005  * be prepared to handle that.
1006  */
1007 unsigned long radix_tree_range_tag_if_tagged(struct radix_tree_root *root,
1008                 unsigned long *first_indexp, unsigned long last_index,
1009                 unsigned long nr_to_tag,
1010                 unsigned int iftag, unsigned int settag)
1011 {
1012         struct radix_tree_node *slot, *node = NULL;
1013         unsigned long maxindex;
1014         unsigned int shift = radix_tree_load_root(root, &slot, &maxindex);
1015         unsigned long tagged = 0;
1016         unsigned long index = *first_indexp;
1017
1018         last_index = min(last_index, maxindex);
1019         if (index > last_index)
1020                 return 0;
1021         if (!nr_to_tag)
1022                 return 0;
1023         if (!root_tag_get(root, iftag)) {
1024                 *first_indexp = last_index + 1;
1025                 return 0;
1026         }
1027         if (!radix_tree_is_internal_node(slot)) {
1028                 *first_indexp = last_index + 1;
1029                 root_tag_set(root, settag);
1030                 return 1;
1031         }
1032
1033         node = entry_to_node(slot);
1034         shift -= RADIX_TREE_MAP_SHIFT;
1035
1036         for (;;) {
1037                 unsigned long upindex;
1038                 unsigned offset;
1039
1040                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1041                 offset = radix_tree_descend(node, &slot, offset);
1042                 if (!slot)
1043                         goto next;
1044                 if (!tag_get(node, iftag, offset))
1045                         goto next;
1046                 /* Sibling slots never have tags set on them */
1047                 if (radix_tree_is_internal_node(slot)) {
1048                         node = entry_to_node(slot);
1049                         shift -= RADIX_TREE_MAP_SHIFT;
1050                         continue;
1051                 }
1052
1053                 /* tag the leaf */
1054                 tagged++;
1055                 tag_set(node, settag, offset);
1056
1057                 slot = node->parent;
1058                 /* walk back up the path tagging interior nodes */
1059                 upindex = index >> shift;
1060                 while (slot) {
1061                         upindex >>= RADIX_TREE_MAP_SHIFT;
1062                         offset = upindex & RADIX_TREE_MAP_MASK;
1063
1064                         /* stop if we find a node with the tag already set */
1065                         if (tag_get(slot, settag, offset))
1066                                 break;
1067                         tag_set(slot, settag, offset);
1068                         slot = slot->parent;
1069                 }
1070
1071  next:
1072                 /* Go to next item at level determined by 'shift' */
1073                 index = ((index >> shift) + 1) << shift;
1074                 /* Overflow can happen when last_index is ~0UL... */
1075                 if (index > last_index || !index)
1076                         break;
1077                 offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1078                 while (offset == 0) {
1079                         /*
1080                          * We've fully scanned this node. Go up. Because
1081                          * last_index is guaranteed to be in the tree, what
1082                          * we do below cannot wander astray.
1083                          */
1084                         node = node->parent;
1085                         shift += RADIX_TREE_MAP_SHIFT;
1086                         offset = (index >> shift) & RADIX_TREE_MAP_MASK;
1087                 }
1088                 if (is_sibling_entry(node, node->slots[offset]))
1089                         goto next;
1090                 if (tagged >= nr_to_tag)
1091                         break;
1092         }
1093         /*
1094          * We need not to tag the root tag if there is no tag which is set with
1095          * settag within the range from *first_indexp to last_index.
1096          */
1097         if (tagged > 0)
1098                 root_tag_set(root, settag);
1099         *first_indexp = index;
1100
1101         return tagged;
1102 }
1103 EXPORT_SYMBOL(radix_tree_range_tag_if_tagged);
1104
1105 /**
1106  *      radix_tree_gang_lookup - perform multiple lookup on a radix tree
1107  *      @root:          radix tree root
1108  *      @results:       where the results of the lookup are placed
1109  *      @first_index:   start the lookup from this key
1110  *      @max_items:     place up to this many items at *results
1111  *
1112  *      Performs an index-ascending scan of the tree for present items.  Places
1113  *      them at *@results and returns the number of items which were placed at
1114  *      *@results.
1115  *
1116  *      The implementation is naive.
1117  *
1118  *      Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1119  *      rcu_read_lock. In this case, rather than the returned results being
1120  *      an atomic snapshot of the tree at a single point in time, the
1121  *      semantics of an RCU protected gang lookup are as though multiple
1122  *      radix_tree_lookups have been issued in individual locks, and results
1123  *      stored in 'results'.
1124  */
1125 unsigned int
1126 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1127                         unsigned long first_index, unsigned int max_items)
1128 {
1129         struct radix_tree_iter iter;
1130         void **slot;
1131         unsigned int ret = 0;
1132
1133         if (unlikely(!max_items))
1134                 return 0;
1135
1136         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1137                 results[ret] = rcu_dereference_raw(*slot);
1138                 if (!results[ret])
1139                         continue;
1140                 if (radix_tree_is_internal_node(results[ret])) {
1141                         slot = radix_tree_iter_retry(&iter);
1142                         continue;
1143                 }
1144                 if (++ret == max_items)
1145                         break;
1146         }
1147
1148         return ret;
1149 }
1150 EXPORT_SYMBOL(radix_tree_gang_lookup);
1151
1152 /**
1153  *      radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1154  *      @root:          radix tree root
1155  *      @results:       where the results of the lookup are placed
1156  *      @indices:       where their indices should be placed (but usually NULL)
1157  *      @first_index:   start the lookup from this key
1158  *      @max_items:     place up to this many items at *results
1159  *
1160  *      Performs an index-ascending scan of the tree for present items.  Places
1161  *      their slots at *@results and returns the number of items which were
1162  *      placed at *@results.
1163  *
1164  *      The implementation is naive.
1165  *
1166  *      Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1167  *      be dereferenced with radix_tree_deref_slot, and if using only RCU
1168  *      protection, radix_tree_deref_slot may fail requiring a retry.
1169  */
1170 unsigned int
1171 radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1172                         void ***results, unsigned long *indices,
1173                         unsigned long first_index, unsigned int max_items)
1174 {
1175         struct radix_tree_iter iter;
1176         void **slot;
1177         unsigned int ret = 0;
1178
1179         if (unlikely(!max_items))
1180                 return 0;
1181
1182         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1183                 results[ret] = slot;
1184                 if (indices)
1185                         indices[ret] = iter.index;
1186                 if (++ret == max_items)
1187                         break;
1188         }
1189
1190         return ret;
1191 }
1192 EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1193
1194 /**
1195  *      radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1196  *                                   based on a tag
1197  *      @root:          radix tree root
1198  *      @results:       where the results of the lookup are placed
1199  *      @first_index:   start the lookup from this key
1200  *      @max_items:     place up to this many items at *results
1201  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1202  *
1203  *      Performs an index-ascending scan of the tree for present items which
1204  *      have the tag indexed by @tag set.  Places the items at *@results and
1205  *      returns the number of items which were placed at *@results.
1206  */
1207 unsigned int
1208 radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
1209                 unsigned long first_index, unsigned int max_items,
1210                 unsigned int tag)
1211 {
1212         struct radix_tree_iter iter;
1213         void **slot;
1214         unsigned int ret = 0;
1215
1216         if (unlikely(!max_items))
1217                 return 0;
1218
1219         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1220                 results[ret] = rcu_dereference_raw(*slot);
1221                 if (!results[ret])
1222                         continue;
1223                 if (radix_tree_is_internal_node(results[ret])) {
1224                         slot = radix_tree_iter_retry(&iter);
1225                         continue;
1226                 }
1227                 if (++ret == max_items)
1228                         break;
1229         }
1230
1231         return ret;
1232 }
1233 EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1234
1235 /**
1236  *      radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1237  *                                        radix tree based on a tag
1238  *      @root:          radix tree root
1239  *      @results:       where the results of the lookup are placed
1240  *      @first_index:   start the lookup from this key
1241  *      @max_items:     place up to this many items at *results
1242  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1243  *
1244  *      Performs an index-ascending scan of the tree for present items which
1245  *      have the tag indexed by @tag set.  Places the slots at *@results and
1246  *      returns the number of slots which were placed at *@results.
1247  */
1248 unsigned int
1249 radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1250                 unsigned long first_index, unsigned int max_items,
1251                 unsigned int tag)
1252 {
1253         struct radix_tree_iter iter;
1254         void **slot;
1255         unsigned int ret = 0;
1256
1257         if (unlikely(!max_items))
1258                 return 0;
1259
1260         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1261                 results[ret] = slot;
1262                 if (++ret == max_items)
1263                         break;
1264         }
1265
1266         return ret;
1267 }
1268 EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1269
1270 #if defined(CONFIG_SHMEM) && defined(CONFIG_SWAP)
1271 #include <linux/sched.h> /* for cond_resched() */
1272
1273 struct locate_info {
1274         unsigned long found_index;
1275         bool stop;
1276 };
1277
1278 /*
1279  * This linear search is at present only useful to shmem_unuse_inode().
1280  */
1281 static unsigned long __locate(struct radix_tree_node *slot, void *item,
1282                               unsigned long index, struct locate_info *info)
1283 {
1284         unsigned int shift;
1285         unsigned long i;
1286
1287         shift = slot->shift + RADIX_TREE_MAP_SHIFT;
1288
1289         do {
1290                 shift -= RADIX_TREE_MAP_SHIFT;
1291
1292                 for (i = (index >> shift) & RADIX_TREE_MAP_MASK;
1293                      i < RADIX_TREE_MAP_SIZE;
1294                      i++, index += (1UL << shift)) {
1295                         struct radix_tree_node *node =
1296                                         rcu_dereference_raw(slot->slots[i]);
1297                         if (node == RADIX_TREE_RETRY)
1298                                 goto out;
1299                         if (!radix_tree_is_internal_node(node)) {
1300                                 if (node == item) {
1301                                         info->found_index = index;
1302                                         info->stop = true;
1303                                         goto out;
1304                                 }
1305                                 continue;
1306                         }
1307                         node = entry_to_node(node);
1308                         if (is_sibling_entry(slot, node))
1309                                 continue;
1310                         slot = node;
1311                         break;
1312                 }
1313                 if (i == RADIX_TREE_MAP_SIZE)
1314                         break;
1315         } while (shift);
1316
1317 out:
1318         if ((index == 0) && (i == RADIX_TREE_MAP_SIZE))
1319                 info->stop = true;
1320         return index;
1321 }
1322
1323 /**
1324  *      radix_tree_locate_item - search through radix tree for item
1325  *      @root:          radix tree root
1326  *      @item:          item to be found
1327  *
1328  *      Returns index where item was found, or -1 if not found.
1329  *      Caller must hold no lock (since this time-consuming function needs
1330  *      to be preemptible), and must check afterwards if item is still there.
1331  */
1332 unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1333 {
1334         struct radix_tree_node *node;
1335         unsigned long max_index;
1336         unsigned long cur_index = 0;
1337         struct locate_info info = {
1338                 .found_index = -1,
1339                 .stop = false,
1340         };
1341
1342         do {
1343                 rcu_read_lock();
1344                 node = rcu_dereference_raw(root->rnode);
1345                 if (!radix_tree_is_internal_node(node)) {
1346                         rcu_read_unlock();
1347                         if (node == item)
1348                                 info.found_index = 0;
1349                         break;
1350                 }
1351
1352                 node = entry_to_node(node);
1353
1354                 max_index = node_maxindex(node);
1355                 if (cur_index > max_index) {
1356                         rcu_read_unlock();
1357                         break;
1358                 }
1359
1360                 cur_index = __locate(node, item, cur_index, &info);
1361                 rcu_read_unlock();
1362                 cond_resched();
1363         } while (!info.stop && cur_index <= max_index);
1364
1365         return info.found_index;
1366 }
1367 #else
1368 unsigned long radix_tree_locate_item(struct radix_tree_root *root, void *item)
1369 {
1370         return -1;
1371 }
1372 #endif /* CONFIG_SHMEM && CONFIG_SWAP */
1373
1374 /**
1375  *      radix_tree_shrink    -    shrink radix tree to minimum height
1376  *      @root           radix tree root
1377  */
1378 static inline bool radix_tree_shrink(struct radix_tree_root *root)
1379 {
1380         bool shrunk = false;
1381
1382         for (;;) {
1383                 struct radix_tree_node *node = root->rnode;
1384                 struct radix_tree_node *child;
1385
1386                 if (!radix_tree_is_internal_node(node))
1387                         break;
1388                 node = entry_to_node(node);
1389
1390                 /*
1391                  * The candidate node has more than one child, or its child
1392                  * is not at the leftmost slot, or the child is a multiorder
1393                  * entry, we cannot shrink.
1394                  */
1395                 if (node->count != 1)
1396                         break;
1397                 child = node->slots[0];
1398                 if (!child)
1399                         break;
1400                 if (!radix_tree_is_internal_node(child) && node->shift)
1401                         break;
1402
1403                 if (radix_tree_is_internal_node(child))
1404                         entry_to_node(child)->parent = NULL;
1405
1406                 /*
1407                  * We don't need rcu_assign_pointer(), since we are simply
1408                  * moving the node from one part of the tree to another: if it
1409                  * was safe to dereference the old pointer to it
1410                  * (node->slots[0]), it will be safe to dereference the new
1411                  * one (root->rnode) as far as dependent read barriers go.
1412                  */
1413                 root->rnode = child;
1414
1415                 /*
1416                  * We have a dilemma here. The node's slot[0] must not be
1417                  * NULLed in case there are concurrent lookups expecting to
1418                  * find the item. However if this was a bottom-level node,
1419                  * then it may be subject to the slot pointer being visible
1420                  * to callers dereferencing it. If item corresponding to
1421                  * slot[0] is subsequently deleted, these callers would expect
1422                  * their slot to become empty sooner or later.
1423                  *
1424                  * For example, lockless pagecache will look up a slot, deref
1425                  * the page pointer, and if the page has 0 refcount it means it
1426                  * was concurrently deleted from pagecache so try the deref
1427                  * again. Fortunately there is already a requirement for logic
1428                  * to retry the entire slot lookup -- the indirect pointer
1429                  * problem (replacing direct root node with an indirect pointer
1430                  * also results in a stale slot). So tag the slot as indirect
1431                  * to force callers to retry.
1432                  */
1433                 if (!radix_tree_is_internal_node(child))
1434                         node->slots[0] = RADIX_TREE_RETRY;
1435
1436                 radix_tree_node_free(node);
1437                 shrunk = true;
1438         }
1439
1440         return shrunk;
1441 }
1442
1443 /**
1444  *      __radix_tree_delete_node    -    try to free node after clearing a slot
1445  *      @root:          radix tree root
1446  *      @node:          node containing @index
1447  *
1448  *      After clearing the slot at @index in @node from radix tree
1449  *      rooted at @root, call this function to attempt freeing the
1450  *      node and shrinking the tree.
1451  *
1452  *      Returns %true if @node was freed, %false otherwise.
1453  */
1454 bool __radix_tree_delete_node(struct radix_tree_root *root,
1455                               struct radix_tree_node *node)
1456 {
1457         bool deleted = false;
1458
1459         do {
1460                 struct radix_tree_node *parent;
1461
1462                 if (node->count) {
1463                         if (node == entry_to_node(root->rnode))
1464                                 deleted |= radix_tree_shrink(root);
1465                         return deleted;
1466                 }
1467
1468                 parent = node->parent;
1469                 if (parent) {
1470                         parent->slots[node->offset] = NULL;
1471                         parent->count--;
1472                 } else {
1473                         root_tag_clear_all(root);
1474                         root->rnode = NULL;
1475                 }
1476
1477                 radix_tree_node_free(node);
1478                 deleted = true;
1479
1480                 node = parent;
1481         } while (node);
1482
1483         return deleted;
1484 }
1485
1486 static inline void delete_sibling_entries(struct radix_tree_node *node,
1487                                         void *ptr, unsigned offset)
1488 {
1489 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1490         int i;
1491         for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1492                 if (node->slots[offset + i] != ptr)
1493                         break;
1494                 node->slots[offset + i] = NULL;
1495                 node->count--;
1496         }
1497 #endif
1498 }
1499
1500 /**
1501  *      radix_tree_delete_item    -    delete an item from a radix tree
1502  *      @root:          radix tree root
1503  *      @index:         index key
1504  *      @item:          expected item
1505  *
1506  *      Remove @item at @index from the radix tree rooted at @root.
1507  *
1508  *      Returns the address of the deleted item, or NULL if it was not present
1509  *      or the entry at the given @index was not @item.
1510  */
1511 void *radix_tree_delete_item(struct radix_tree_root *root,
1512                              unsigned long index, void *item)
1513 {
1514         struct radix_tree_node *node;
1515         unsigned int offset;
1516         void **slot;
1517         void *entry;
1518         int tag;
1519
1520         entry = __radix_tree_lookup(root, index, &node, &slot);
1521         if (!entry)
1522                 return NULL;
1523
1524         if (item && entry != item)
1525                 return NULL;
1526
1527         if (!node) {
1528                 root_tag_clear_all(root);
1529                 root->rnode = NULL;
1530                 return entry;
1531         }
1532
1533         offset = get_slot_offset(node, slot);
1534
1535         /*
1536          * Clear all tags associated with the item to be deleted.
1537          * This way of doing it would be inefficient, but seldom is any set.
1538          */
1539         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
1540                 if (tag_get(node, tag, offset))
1541                         radix_tree_tag_clear(root, index, tag);
1542         }
1543
1544         delete_sibling_entries(node, node_to_entry(slot), offset);
1545         node->slots[offset] = NULL;
1546         node->count--;
1547
1548         __radix_tree_delete_node(root, node);
1549
1550         return entry;
1551 }
1552 EXPORT_SYMBOL(radix_tree_delete_item);
1553
1554 /**
1555  *      radix_tree_delete    -    delete an item from a radix tree
1556  *      @root:          radix tree root
1557  *      @index:         index key
1558  *
1559  *      Remove the item at @index from the radix tree rooted at @root.
1560  *
1561  *      Returns the address of the deleted item, or NULL if it was not present.
1562  */
1563 void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1564 {
1565         return radix_tree_delete_item(root, index, NULL);
1566 }
1567 EXPORT_SYMBOL(radix_tree_delete);
1568
1569 /**
1570  *      radix_tree_tagged - test whether any items in the tree are tagged
1571  *      @root:          radix tree root
1572  *      @tag:           tag to test
1573  */
1574 int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
1575 {
1576         return root_tag_get(root, tag);
1577 }
1578 EXPORT_SYMBOL(radix_tree_tagged);
1579
1580 static void
1581 radix_tree_node_ctor(void *arg)
1582 {
1583         struct radix_tree_node *node = arg;
1584
1585         memset(node, 0, sizeof(*node));
1586         INIT_LIST_HEAD(&node->private_list);
1587 }
1588
1589 static int radix_tree_callback(struct notifier_block *nfb,
1590                                 unsigned long action, void *hcpu)
1591 {
1592         int cpu = (long)hcpu;
1593         struct radix_tree_preload *rtp;
1594         struct radix_tree_node *node;
1595
1596         /* Free per-cpu pool of preloaded nodes */
1597         if (action == CPU_DEAD || action == CPU_DEAD_FROZEN) {
1598                 rtp = &per_cpu(radix_tree_preloads, cpu);
1599                 while (rtp->nr) {
1600                         node = rtp->nodes;
1601                         rtp->nodes = node->private_data;
1602                         kmem_cache_free(radix_tree_node_cachep, node);
1603                         rtp->nr--;
1604                 }
1605         }
1606         return NOTIFY_OK;
1607 }
1608
1609 void __init radix_tree_init(void)
1610 {
1611         radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1612                         sizeof(struct radix_tree_node), 0,
1613                         SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1614                         radix_tree_node_ctor);
1615         hotcpu_notifier(radix_tree_callback, 0);
1616 }