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/cpu.h>
  26 #include <linux/errno.h>
  27 #include <linux/init.h>
  28 #include <linux/kernel.h>
  29 #include <linux/export.h>
  30 #include <linux/radix-tree.h>
  31 #include <linux/percpu.h>
  32 #include <linux/slab.h>
  33 #include <linux/kmemleak.h>
  34 #include <linux/notifier.h>
  35 #include <linux/cpu.h>
  36 #include <linux/string.h>
  37 #include <linux/bitops.h>
  38 #include <linux/rcupdate.h>
  39 #include <linux/preempt.h>              /* in_interrupt() */
  40
  41
  42 /* Number of nodes in fully populated tree of given height */
  43 static unsigned long height_to_maxnodes[RADIX_TREE_MAX_PATH + 1] __read_mostly;
  44
  45 /*
  46  * Radix tree node cache.
  47  */
  48 static struct kmem_cache *radix_tree_node_cachep;
  49
  50 /*
  51  * The radix tree is variable-height, so an insert operation not only has
  52  * to build the branch to its corresponding item, it also has to build the
  53  * branch to existing items if the size has to be increased (by
  54  * radix_tree_extend).
  55  *
  56  * The worst case is a zero height tree with just a single item at index 0,
  57  * and then inserting an item at index ULONG_MAX. This requires 2 new branches
  58  * of RADIX_TREE_MAX_PATH size to be created, with only the root node shared.
  59  * Hence:
  60  */
  61 #define RADIX_TREE_PRELOAD_SIZE (RADIX_TREE_MAX_PATH * 2 - 1)
  62
  63 /*
  64  * Per-cpu pool of preloaded nodes
  65  */
  66 struct radix_tree_preload {
  67         unsigned nr;
  68         /* nodes->private_data points to next preallocated node */
  69         struct radix_tree_node *nodes;
  70 };
  71 static DEFINE_PER_CPU(struct radix_tree_preload, radix_tree_preloads) = { 0, };
  72
  73 static inline struct radix_tree_node *entry_to_node(void *ptr)
  74 {
  75         return (void *)((unsigned long)ptr & ~RADIX_TREE_INTERNAL_NODE);
  76 }
  77
  78 static inline void *node_to_entry(void *ptr)
  79 {
  80         return (void *)((unsigned long)ptr | RADIX_TREE_INTERNAL_NODE);
  81 }
  82
  83 #define RADIX_TREE_RETRY        node_to_entry(NULL)
  84
  85 #ifdef CONFIG_RADIX_TREE_MULTIORDER
  86 /* Sibling slots point directly to another slot in the same node */
  87 static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
  88 {
  89         void **ptr = node;
  90         return (parent->slots <= ptr) &&
  91                         (ptr < parent->slots + RADIX_TREE_MAP_SIZE);
  92 }
  93 #else
  94 static inline bool is_sibling_entry(struct radix_tree_node *parent, void *node)
  95 {
  96         return false;
  97 }
  98 #endif
  99
 100 static inline unsigned long get_slot_offset(struct radix_tree_node *parent,
 101                                                  void **slot)
 102 {
 103         return slot - parent->slots;
 104 }
 105
 106 static unsigned int radix_tree_descend(struct radix_tree_node *parent,
 107                         struct radix_tree_node **nodep, unsigned long index)
 108 {
 109         unsigned int offset = (index >> parent->shift) & RADIX_TREE_MAP_MASK;
 110         void **entry = rcu_dereference_raw(parent->slots[offset]);
 111
 112 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 113         if (radix_tree_is_internal_node(entry)) {
 114                 if (is_sibling_entry(parent, entry)) {
 115                         void **sibentry = (void **) entry_to_node(entry);
 116                         offset = get_slot_offset(parent, sibentry);
 117                         entry = rcu_dereference_raw(*sibentry);
 118                 }
 119         }
 120 #endif
 121
 122         *nodep = (void *)entry;
 123         return offset;
 124 }
 125
 126 static inline gfp_t root_gfp_mask(struct radix_tree_root *root)
 127 {
 128         return root->gfp_mask & __GFP_BITS_MASK;
 129 }
 130
 131 static inline void tag_set(struct radix_tree_node *node, unsigned int tag,
 132                 int offset)
 133 {
 134         __set_bit(offset, node->tags[tag]);
 135 }
 136
 137 static inline void tag_clear(struct radix_tree_node *node, unsigned int tag,
 138                 int offset)
 139 {
 140         __clear_bit(offset, node->tags[tag]);
 141 }
 142
 143 static inline int tag_get(struct radix_tree_node *node, unsigned int tag,
 144                 int offset)
 145 {
 146         return test_bit(offset, node->tags[tag]);
 147 }
 148
 149 static inline void root_tag_set(struct radix_tree_root *root, unsigned int tag)
 150 {
 151         root->gfp_mask |= (__force gfp_t)(1 << (tag + __GFP_BITS_SHIFT));
 152 }
 153
 154 static inline void root_tag_clear(struct radix_tree_root *root, unsigned tag)
 155 {
 156         root->gfp_mask &= (__force gfp_t)~(1 << (tag + __GFP_BITS_SHIFT));
 157 }
 158
 159 static inline void root_tag_clear_all(struct radix_tree_root *root)
 160 {
 161         root->gfp_mask &= __GFP_BITS_MASK;
 162 }
 163
 164 static inline int root_tag_get(struct radix_tree_root *root, unsigned int tag)
 165 {
 166         return (__force int)root->gfp_mask & (1 << (tag + __GFP_BITS_SHIFT));
 167 }
 168
 169 static inline unsigned root_tags_get(struct radix_tree_root *root)
 170 {
 171         return (__force unsigned)root->gfp_mask >> __GFP_BITS_SHIFT;
 172 }
 173
 174 /*
 175  * Returns 1 if any slot in the node has this tag set.
 176  * Otherwise returns 0.
 177  */
 178 static inline int any_tag_set(struct radix_tree_node *node, unsigned int tag)
 179 {
 180         unsigned idx;
 181         for (idx = 0; idx < RADIX_TREE_TAG_LONGS; idx++) {
 182                 if (node->tags[tag][idx])
 183                         return 1;
 184         }
 185         return 0;
 186 }
 187
 188 /**
 189  * radix_tree_find_next_bit - find the next set bit in a memory region
 190  *
 191  * @addr: The address to base the search on
 192  * @size: The bitmap size in bits
 193  * @offset: The bitnumber to start searching at
 194  *
 195  * Unrollable variant of find_next_bit() for constant size arrays.
 196  * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
 197  * Returns next bit offset, or size if nothing found.
 198  */
 199 static __always_inline unsigned long
 200 radix_tree_find_next_bit(struct radix_tree_node *node, unsigned int tag,
 201                          unsigned long offset)
 202 {
 203         const unsigned long *addr = node->tags[tag];
 204
 205         if (offset < RADIX_TREE_MAP_SIZE) {
 206                 unsigned long tmp;
 207
 208                 addr += offset / BITS_PER_LONG;
 209                 tmp = *addr >> (offset % BITS_PER_LONG);
 210                 if (tmp)
 211                         return __ffs(tmp) + offset;
 212                 offset = (offset + BITS_PER_LONG) & ~(BITS_PER_LONG - 1);
 213                 while (offset < RADIX_TREE_MAP_SIZE) {
 214                         tmp = *++addr;
 215                         if (tmp)
 216                                 return __ffs(tmp) + offset;
 217                         offset += BITS_PER_LONG;
 218                 }
 219         }
 220         return RADIX_TREE_MAP_SIZE;
 221 }
 222
 223 static unsigned int iter_offset(const struct radix_tree_iter *iter)
 224 {
 225         return (iter->index >> iter_shift(iter)) & RADIX_TREE_MAP_MASK;
 226 }
 227
 228 /*
 229  * The maximum index which can be stored in a radix tree
 230  */
 231 static inline unsigned long shift_maxindex(unsigned int shift)
 232 {
 233         return (RADIX_TREE_MAP_SIZE << shift) - 1;
 234 }
 235
 236 static inline unsigned long node_maxindex(struct radix_tree_node *node)
 237 {
 238         return shift_maxindex(node->shift);
 239 }
 240
 241 #ifndef __KERNEL__
 242 static void dump_node(struct radix_tree_node *node, unsigned long index)
 243 {
 244         unsigned long i;
 245
 246         pr_debug("radix node: %p offset %d indices %lu-%lu parent %p tags %lx %lx %lx shift %d count %d exceptional %d\n",
 247                 node, node->offset, index, index | node_maxindex(node),
 248                 node->parent,
 249                 node->tags[0][0], node->tags[1][0], node->tags[2][0],
 250                 node->shift, node->count, node->exceptional);
 251
 252         for (i = 0; i < RADIX_TREE_MAP_SIZE; i++) {
 253                 unsigned long first = index | (i << node->shift);
 254                 unsigned long last = first | ((1UL << node->shift) - 1);
 255                 void *entry = node->slots[i];
 256                 if (!entry)
 257                         continue;
 258                 if (entry == RADIX_TREE_RETRY) {
 259                         pr_debug("radix retry offset %ld indices %lu-%lu parent %p\n",
 260                                         i, first, last, node);
 261                 } else if (!radix_tree_is_internal_node(entry)) {
 262                         pr_debug("radix entry %p offset %ld indices %lu-%lu parent %p\n",
 263                                         entry, i, first, last, node);
 264                 } else if (is_sibling_entry(node, entry)) {
 265                         pr_debug("radix sblng %p offset %ld indices %lu-%lu parent %p val %p\n",
 266                                         entry, i, first, last, node,
 267                                         *(void **)entry_to_node(entry));
 268                 } else {
 269                         dump_node(entry_to_node(entry), first);
 270                 }
 271         }
 272 }
 273
 274 /* For debug */
 275 static void radix_tree_dump(struct radix_tree_root *root)
 276 {
 277         pr_debug("radix root: %p rnode %p tags %x\n",
 278                         root, root->rnode,
 279                         root->gfp_mask >> __GFP_BITS_SHIFT);
 280         if (!radix_tree_is_internal_node(root->rnode))
 281                 return;
 282         dump_node(entry_to_node(root->rnode), 0);
 283 }
 284 #endif
 285
 286 /*
 287  * This assumes that the caller has performed appropriate preallocation, and
 288  * that the caller has pinned this thread of control to the current CPU.
 289  */
 290 static struct radix_tree_node *
 291 radix_tree_node_alloc(struct radix_tree_root *root)
 292 {
 293         struct radix_tree_node *ret = NULL;
 294         gfp_t gfp_mask = root_gfp_mask(root);
 295
 296         /*
 297          * Preload code isn't irq safe and it doesn't make sense to use
 298          * preloading during an interrupt anyway as all the allocations have
 299          * to be atomic. So just do normal allocation when in interrupt.
 300          */
 301         if (!gfpflags_allow_blocking(gfp_mask) && !in_interrupt()) {
 302                 struct radix_tree_preload *rtp;
 303
 304                 /*
 305                  * Even if the caller has preloaded, try to allocate from the
 306                  * cache first for the new node to get accounted to the memory
 307                  * cgroup.
 308                  */
 309                 ret = kmem_cache_alloc(radix_tree_node_cachep,
 310                                        gfp_mask | __GFP_NOWARN);
 311                 if (ret)
 312                         goto out;
 313
 314                 /*
 315                  * Provided the caller has preloaded here, we will always
 316                  * succeed in getting a node here (and never reach
 317                  * kmem_cache_alloc)
 318                  */
 319                 rtp = this_cpu_ptr(&radix_tree_preloads);
 320                 if (rtp->nr) {
 321                         ret = rtp->nodes;
 322                         rtp->nodes = ret->private_data;
 323                         ret->private_data = NULL;
 324                         rtp->nr--;
 325                 }
 326                 /*
 327                  * Update the allocation stack trace as this is more useful
 328                  * for debugging.
 329                  */
 330                 kmemleak_update_trace(ret);
 331                 goto out;
 332         }
 333         ret = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
 334 out:
 335         BUG_ON(radix_tree_is_internal_node(ret));
 336         return ret;
 337 }
 338
 339 static void radix_tree_node_rcu_free(struct rcu_head *head)
 340 {
 341         struct radix_tree_node *node =
 342                         container_of(head, struct radix_tree_node, rcu_head);
 343
 344         /*
 345          * Must only free zeroed nodes into the slab.  We can be left with
 346          * non-NULL entries by radix_tree_free_nodes, so clear the entries
 347          * and tags here.
 348          */
 349         memset(node->slots, 0, sizeof(node->slots));
 350         memset(node->tags, 0, sizeof(node->tags));
 351         INIT_LIST_HEAD(&node->private_list);
 352
 353         kmem_cache_free(radix_tree_node_cachep, node);
 354 }
 355
 356 static inline void
 357 radix_tree_node_free(struct radix_tree_node *node)
 358 {
 359         call_rcu(&node->rcu_head, radix_tree_node_rcu_free);
 360 }
 361
 362 /*
 363  * Load up this CPU's radix_tree_node buffer with sufficient objects to
 364  * ensure that the addition of a single element in the tree cannot fail.  On
 365  * success, return zero, with preemption disabled.  On error, return -ENOMEM
 366  * with preemption not disabled.
 367  *
 368  * To make use of this facility, the radix tree must be initialised without
 369  * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
 370  */
 371 static int __radix_tree_preload(gfp_t gfp_mask, unsigned nr)
 372 {
 373         struct radix_tree_preload *rtp;
 374         struct radix_tree_node *node;
 375         int ret = -ENOMEM;
 376
 377         /*
 378          * Nodes preloaded by one cgroup can be be used by another cgroup, so
 379          * they should never be accounted to any particular memory cgroup.
 380          */
 381         gfp_mask &= ~__GFP_ACCOUNT;
 382
 383         preempt_disable();
 384         rtp = this_cpu_ptr(&radix_tree_preloads);
 385         while (rtp->nr < nr) {
 386                 preempt_enable();
 387                 node = kmem_cache_alloc(radix_tree_node_cachep, gfp_mask);
 388                 if (node == NULL)
 389                         goto out;
 390                 preempt_disable();
 391                 rtp = this_cpu_ptr(&radix_tree_preloads);
 392                 if (rtp->nr < nr) {
 393                         node->private_data = rtp->nodes;
 394                         rtp->nodes = node;
 395                         rtp->nr++;
 396                 } else {
 397                         kmem_cache_free(radix_tree_node_cachep, node);
 398                 }
 399         }
 400         ret = 0;
 401 out:
 402         return ret;
 403 }
 404
 405 /*
 406  * Load up this CPU's radix_tree_node buffer with sufficient objects to
 407  * ensure that the addition of a single element in the tree cannot fail.  On
 408  * success, return zero, with preemption disabled.  On error, return -ENOMEM
 409  * with preemption not disabled.
 410  *
 411  * To make use of this facility, the radix tree must be initialised without
 412  * __GFP_DIRECT_RECLAIM being passed to INIT_RADIX_TREE().
 413  */
 414 int radix_tree_preload(gfp_t gfp_mask)
 415 {
 416         /* Warn on non-sensical use... */
 417         WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
 418         return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
 419 }
 420 EXPORT_SYMBOL(radix_tree_preload);
 421
 422 /*
 423  * The same as above function, except we don't guarantee preloading happens.
 424  * We do it, if we decide it helps. On success, return zero with preemption
 425  * disabled. On error, return -ENOMEM with preemption not disabled.
 426  */
 427 int radix_tree_maybe_preload(gfp_t gfp_mask)
 428 {
 429         if (gfpflags_allow_blocking(gfp_mask))
 430                 return __radix_tree_preload(gfp_mask, RADIX_TREE_PRELOAD_SIZE);
 431         /* Preloading doesn't help anything with this gfp mask, skip it */
 432         preempt_disable();
 433         return 0;
 434 }
 435 EXPORT_SYMBOL(radix_tree_maybe_preload);
 436
 437 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 438 /*
 439  * Preload with enough objects to ensure that we can split a single entry
 440  * of order @old_order into many entries of size @new_order
 441  */
 442 int radix_tree_split_preload(unsigned int old_order, unsigned int new_order,
 443                                                         gfp_t gfp_mask)
 444 {
 445         unsigned top = 1 << (old_order % RADIX_TREE_MAP_SHIFT);
 446         unsigned layers = (old_order / RADIX_TREE_MAP_SHIFT) -
 447                                 (new_order / RADIX_TREE_MAP_SHIFT);
 448         unsigned nr = 0;
 449
 450         WARN_ON_ONCE(!gfpflags_allow_blocking(gfp_mask));
 451         BUG_ON(new_order >= old_order);
 452
 453         while (layers--)
 454                 nr = nr * RADIX_TREE_MAP_SIZE + 1;
 455         return __radix_tree_preload(gfp_mask, top * nr);
 456 }
 457 #endif
 458
 459 /*
 460  * The same as function above, but preload number of nodes required to insert
 461  * (1 << order) continuous naturally-aligned elements.
 462  */
 463 int radix_tree_maybe_preload_order(gfp_t gfp_mask, int order)
 464 {
 465         unsigned long nr_subtrees;
 466         int nr_nodes, subtree_height;
 467
 468         /* Preloading doesn't help anything with this gfp mask, skip it */
 469         if (!gfpflags_allow_blocking(gfp_mask)) {
 470                 preempt_disable();
 471                 return 0;
 472         }
 473
 474         /*
 475          * Calculate number and height of fully populated subtrees it takes to
 476          * store (1 << order) elements.
 477          */
 478         nr_subtrees = 1 << order;
 479         for (subtree_height = 0; nr_subtrees > RADIX_TREE_MAP_SIZE;
 480                         subtree_height++)
 481                 nr_subtrees >>= RADIX_TREE_MAP_SHIFT;
 482
 483         /*
 484          * The worst case is zero height tree with a single item at index 0 and
 485          * then inserting items starting at ULONG_MAX - (1 << order).
 486          *
 487          * This requires RADIX_TREE_MAX_PATH nodes to build branch from root to
 488          * 0-index item.
 489          */
 490         nr_nodes = RADIX_TREE_MAX_PATH;
 491
 492         /* Plus branch to fully populated subtrees. */
 493         nr_nodes += RADIX_TREE_MAX_PATH - subtree_height;
 494
 495         /* Root node is shared. */
 496         nr_nodes--;
 497
 498         /* Plus nodes required to build subtrees. */
 499         nr_nodes += nr_subtrees * height_to_maxnodes[subtree_height];
 500
 501         return __radix_tree_preload(gfp_mask, nr_nodes);
 502 }
 503
 504 static unsigned radix_tree_load_root(struct radix_tree_root *root,
 505                 struct radix_tree_node **nodep, unsigned long *maxindex)
 506 {
 507         struct radix_tree_node *node = rcu_dereference_raw(root->rnode);
 508
 509         *nodep = node;
 510
 511         if (likely(radix_tree_is_internal_node(node))) {
 512                 node = entry_to_node(node);
 513                 *maxindex = node_maxindex(node);
 514                 return node->shift + RADIX_TREE_MAP_SHIFT;
 515         }
 516
 517         *maxindex = 0;
 518         return 0;
 519 }
 520
 521 /*
 522  *      Extend a radix tree so it can store key @index.
 523  */
 524 static int radix_tree_extend(struct radix_tree_root *root,
 525                                 unsigned long index, unsigned int shift)
 526 {
 527         struct radix_tree_node *slot;
 528         unsigned int maxshift;
 529         int tag;
 530
 531         /* Figure out what the shift should be.  */
 532         maxshift = shift;
 533         while (index > shift_maxindex(maxshift))
 534                 maxshift += RADIX_TREE_MAP_SHIFT;
 535
 536         slot = root->rnode;
 537         if (!slot)
 538                 goto out;
 539
 540         do {
 541                 struct radix_tree_node *node = radix_tree_node_alloc(root);
 542
 543                 if (!node)
 544                         return -ENOMEM;
 545
 546                 /* Propagate the aggregated tag info into the new root */
 547                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
 548                         if (root_tag_get(root, tag))
 549                                 tag_set(node, tag, 0);
 550                 }
 551
 552                 BUG_ON(shift > BITS_PER_LONG);
 553                 node->shift = shift;
 554                 node->offset = 0;
 555                 node->count = 1;
 556                 node->parent = NULL;
 557                 if (radix_tree_is_internal_node(slot)) {
 558                         entry_to_node(slot)->parent = node;
 559                 } else {
 560                         /* Moving an exceptional root->rnode to a node */
 561                         if (radix_tree_exceptional_entry(slot))
 562                                 node->exceptional = 1;
 563                 }
 564                 node->slots[0] = slot;
 565                 slot = node_to_entry(node);
 566                 rcu_assign_pointer(root->rnode, slot);
 567                 shift += RADIX_TREE_MAP_SHIFT;
 568         } while (shift <= maxshift);
 569 out:
 570         return maxshift + RADIX_TREE_MAP_SHIFT;
 571 }
 572
 573 /**
 574  *      radix_tree_shrink    -    shrink radix tree to minimum height
 575  *      @root           radix tree root
 576  */
 577 static inline void radix_tree_shrink(struct radix_tree_root *root,
 578                                      radix_tree_update_node_t update_node,
 579                                      void *private)
 580 {
 581         for (;;) {
 582                 struct radix_tree_node *node = root->rnode;
 583                 struct radix_tree_node *child;
 584
 585                 if (!radix_tree_is_internal_node(node))
 586                         break;
 587                 node = entry_to_node(node);
 588
 589                 /*
 590                  * The candidate node has more than one child, or its child
 591                  * is not at the leftmost slot, or the child is a multiorder
 592                  * entry, we cannot shrink.
 593                  */
 594                 if (node->count != 1)
 595                         break;
 596                 child = node->slots[0];
 597                 if (!child)
 598                         break;
 599                 if (!radix_tree_is_internal_node(child) && node->shift)
 600                         break;
 601
 602                 if (radix_tree_is_internal_node(child))
 603                         entry_to_node(child)->parent = NULL;
 604
 605                 /*
 606                  * We don't need rcu_assign_pointer(), since we are simply
 607                  * moving the node from one part of the tree to another: if it
 608                  * was safe to dereference the old pointer to it
 609                  * (node->slots[0]), it will be safe to dereference the new
 610                  * one (root->rnode) as far as dependent read barriers go.
 611                  */
 612                 root->rnode = child;
 613
 614                 /*
 615                  * We have a dilemma here. The node's slot[0] must not be
 616                  * NULLed in case there are concurrent lookups expecting to
 617                  * find the item. However if this was a bottom-level node,
 618                  * then it may be subject to the slot pointer being visible
 619                  * to callers dereferencing it. If item corresponding to
 620                  * slot[0] is subsequently deleted, these callers would expect
 621                  * their slot to become empty sooner or later.
 622                  *
 623                  * For example, lockless pagecache will look up a slot, deref
 624                  * the page pointer, and if the page has 0 refcount it means it
 625                  * was concurrently deleted from pagecache so try the deref
 626                  * again. Fortunately there is already a requirement for logic
 627                  * to retry the entire slot lookup -- the indirect pointer
 628                  * problem (replacing direct root node with an indirect pointer
 629                  * also results in a stale slot). So tag the slot as indirect
 630                  * to force callers to retry.
 631                  */
 632                 node->count = 0;
 633                 if (!radix_tree_is_internal_node(child)) {
 634                         node->slots[0] = RADIX_TREE_RETRY;
 635                         if (update_node)
 636                                 update_node(node, private);
 637                 }
 638
 639                 radix_tree_node_free(node);
 640         }
 641 }
 642
 643 static void delete_node(struct radix_tree_root *root,
 644                         struct radix_tree_node *node,
 645                         radix_tree_update_node_t update_node, void *private)
 646 {
 647         do {
 648                 struct radix_tree_node *parent;
 649
 650                 if (node->count) {
 651                         if (node == entry_to_node(root->rnode))
 652                                 radix_tree_shrink(root, update_node, private);
 653                         return;
 654                 }
 655
 656                 parent = node->parent;
 657                 if (parent) {
 658                         parent->slots[node->offset] = NULL;
 659                         parent->count--;
 660                 } else {
 661                         root_tag_clear_all(root);
 662                         root->rnode = NULL;
 663                 }
 664
 665                 radix_tree_node_free(node);
 666
 667                 node = parent;
 668         } while (node);
 669 }
 670
 671 /**
 672  *      __radix_tree_create     -       create a slot in a radix tree
 673  *      @root:          radix tree root
 674  *      @index:         index key
 675  *      @order:         index occupies 2^order aligned slots
 676  *      @nodep:         returns node
 677  *      @slotp:         returns slot
 678  *
 679  *      Create, if necessary, and return the node and slot for an item
 680  *      at position @index in the radix tree @root.
 681  *
 682  *      Until there is more than one item in the tree, no nodes are
 683  *      allocated and @root->rnode is used as a direct slot instead of
 684  *      pointing to a node, in which case *@nodep will be NULL.
 685  *
 686  *      Returns -ENOMEM, or 0 for success.
 687  */
 688 int __radix_tree_create(struct radix_tree_root *root, unsigned long index,
 689                         unsigned order, struct radix_tree_node **nodep,
 690                         void ***slotp)
 691 {
 692         struct radix_tree_node *node = NULL, *child;
 693         void **slot = (void **)&root->rnode;
 694         unsigned long maxindex;
 695         unsigned int shift, offset = 0;
 696         unsigned long max = index | ((1UL << order) - 1);
 697
 698         shift = radix_tree_load_root(root, &child, &maxindex);
 699
 700         /* Make sure the tree is high enough.  */
 701         if (order > 0 && max == ((1UL << order) - 1))
 702                 max++;
 703         if (max > maxindex) {
 704                 int error = radix_tree_extend(root, max, shift);
 705                 if (error < 0)
 706                         return error;
 707                 shift = error;
 708                 child = root->rnode;
 709         }
 710
 711         while (shift > order) {
 712                 shift -= RADIX_TREE_MAP_SHIFT;
 713                 if (child == NULL) {
 714                         /* Have to add a child node.  */
 715                         child = radix_tree_node_alloc(root);
 716                         if (!child)
 717                                 return -ENOMEM;
 718                         child->shift = shift;
 719                         child->offset = offset;
 720                         child->count = 0;
 721                         child->exceptional = 0;
 722                         child->parent = node;
 723                         rcu_assign_pointer(*slot, node_to_entry(child));
 724                         if (node)
 725                                 node->count++;
 726                 } else if (!radix_tree_is_internal_node(child))
 727                         break;
 728
 729                 /* Go a level down */
 730                 node = entry_to_node(child);
 731                 offset = radix_tree_descend(node, &child, index);
 732                 slot = &node->slots[offset];
 733         }
 734
 735         if (nodep)
 736                 *nodep = node;
 737         if (slotp)
 738                 *slotp = slot;
 739         return 0;
 740 }
 741
 742 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 743 /*
 744  * Free any nodes below this node.  The tree is presumed to not need
 745  * shrinking, and any user data in the tree is presumed to not need a
 746  * destructor called on it.  If we need to add a destructor, we can
 747  * add that functionality later.  Note that we may not clear tags or
 748  * slots from the tree as an RCU walker may still have a pointer into
 749  * this subtree.  We could replace the entries with RADIX_TREE_RETRY,
 750  * but we'll still have to clear those in rcu_free.
 751  */
 752 static void radix_tree_free_nodes(struct radix_tree_node *node)
 753 {
 754         unsigned offset = 0;
 755         struct radix_tree_node *child = entry_to_node(node);
 756
 757         for (;;) {
 758                 void *entry = child->slots[offset];
 759                 if (radix_tree_is_internal_node(entry) &&
 760                                         !is_sibling_entry(child, entry)) {
 761                         child = entry_to_node(entry);
 762                         offset = 0;
 763                         continue;
 764                 }
 765                 offset++;
 766                 while (offset == RADIX_TREE_MAP_SIZE) {
 767                         struct radix_tree_node *old = child;
 768                         offset = child->offset + 1;
 769                         child = child->parent;
 770                         radix_tree_node_free(old);
 771                         if (old == entry_to_node(node))
 772                                 return;
 773                 }
 774         }
 775 }
 776
 777 static inline int insert_entries(struct radix_tree_node *node, void **slot,
 778                                 void *item, unsigned order, bool replace)
 779 {
 780         struct radix_tree_node *child;
 781         unsigned i, n, tag, offset, tags = 0;
 782
 783         if (node) {
 784                 if (order > node->shift)
 785                         n = 1 << (order - node->shift);
 786                 else
 787                         n = 1;
 788                 offset = get_slot_offset(node, slot);
 789         } else {
 790                 n = 1;
 791                 offset = 0;
 792         }
 793
 794         if (n > 1) {
 795                 offset = offset & ~(n - 1);
 796                 slot = &node->slots[offset];
 797         }
 798         child = node_to_entry(slot);
 799
 800         for (i = 0; i < n; i++) {
 801                 if (slot[i]) {
 802                         if (replace) {
 803                                 node->count--;
 804                                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
 805                                         if (tag_get(node, tag, offset + i))
 806                                                 tags |= 1 << tag;
 807                         } else
 808                                 return -EEXIST;
 809                 }
 810         }
 811
 812         for (i = 0; i < n; i++) {
 813                 struct radix_tree_node *old = slot[i];
 814                 if (i) {
 815                         rcu_assign_pointer(slot[i], child);
 816                         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
 817                                 if (tags & (1 << tag))
 818                                         tag_clear(node, tag, offset + i);
 819                 } else {
 820                         rcu_assign_pointer(slot[i], item);
 821                         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
 822                                 if (tags & (1 << tag))
 823                                         tag_set(node, tag, offset);
 824                 }
 825                 if (radix_tree_is_internal_node(old) &&
 826                                         !is_sibling_entry(node, old) &&
 827                                         (old != RADIX_TREE_RETRY))
 828                         radix_tree_free_nodes(old);
 829                 if (radix_tree_exceptional_entry(old))
 830                         node->exceptional--;
 831         }
 832         if (node) {
 833                 node->count += n;
 834                 if (radix_tree_exceptional_entry(item))
 835                         node->exceptional += n;
 836         }
 837         return n;
 838 }
 839 #else
 840 static inline int insert_entries(struct radix_tree_node *node, void **slot,
 841                                 void *item, unsigned order, bool replace)
 842 {
 843         if (*slot)
 844                 return -EEXIST;
 845         rcu_assign_pointer(*slot, item);
 846         if (node) {
 847                 node->count++;
 848                 if (radix_tree_exceptional_entry(item))
 849                         node->exceptional++;
 850         }
 851         return 1;
 852 }
 853 #endif
 854
 855 /**
 856  *      __radix_tree_insert    -    insert into a radix tree
 857  *      @root:          radix tree root
 858  *      @index:         index key
 859  *      @order:         key covers the 2^order indices around index
 860  *      @item:          item to insert
 861  *
 862  *      Insert an item into the radix tree at position @index.
 863  */
 864 int __radix_tree_insert(struct radix_tree_root *root, unsigned long index,
 865                         unsigned order, void *item)
 866 {
 867         struct radix_tree_node *node;
 868         void **slot;
 869         int error;
 870
 871         BUG_ON(radix_tree_is_internal_node(item));
 872
 873         error = __radix_tree_create(root, index, order, &node, &slot);
 874         if (error)
 875                 return error;
 876
 877         error = insert_entries(node, slot, item, order, false);
 878         if (error < 0)
 879                 return error;
 880
 881         if (node) {
 882                 unsigned offset = get_slot_offset(node, slot);
 883                 BUG_ON(tag_get(node, 0, offset));
 884                 BUG_ON(tag_get(node, 1, offset));
 885                 BUG_ON(tag_get(node, 2, offset));
 886         } else {
 887                 BUG_ON(root_tags_get(root));
 888         }
 889
 890         return 0;
 891 }
 892 EXPORT_SYMBOL(__radix_tree_insert);
 893
 894 /**
 895  *      __radix_tree_lookup     -       lookup an item in a radix tree
 896  *      @root:          radix tree root
 897  *      @index:         index key
 898  *      @nodep:         returns node
 899  *      @slotp:         returns slot
 900  *
 901  *      Lookup and return the item at position @index in the radix
 902  *      tree @root.
 903  *
 904  *      Until there is more than one item in the tree, no nodes are
 905  *      allocated and @root->rnode is used as a direct slot instead of
 906  *      pointing to a node, in which case *@nodep will be NULL.
 907  */
 908 void *__radix_tree_lookup(struct radix_tree_root *root, unsigned long index,
 909                           struct radix_tree_node **nodep, void ***slotp)
 910 {
 911         struct radix_tree_node *node, *parent;
 912         unsigned long maxindex;
 913         void **slot;
 914
 915  restart:
 916         parent = NULL;
 917         slot = (void **)&root->rnode;
 918         radix_tree_load_root(root, &node, &maxindex);
 919         if (index > maxindex)
 920                 return NULL;
 921
 922         while (radix_tree_is_internal_node(node)) {
 923                 unsigned offset;
 924
 925                 if (node == RADIX_TREE_RETRY)
 926                         goto restart;
 927                 parent = entry_to_node(node);
 928                 offset = radix_tree_descend(parent, &node, index);
 929                 slot = parent->slots + offset;
 930         }
 931
 932         if (nodep)
 933                 *nodep = parent;
 934         if (slotp)
 935                 *slotp = slot;
 936         return node;
 937 }
 938
 939 /**
 940  *      radix_tree_lookup_slot    -    lookup a slot in a radix tree
 941  *      @root:          radix tree root
 942  *      @index:         index key
 943  *
 944  *      Returns:  the slot corresponding to the position @index in the
 945  *      radix tree @root. This is useful for update-if-exists operations.
 946  *
 947  *      This function can be called under rcu_read_lock iff the slot is not
 948  *      modified by radix_tree_replace_slot, otherwise it must be called
 949  *      exclusive from other writers. Any dereference of the slot must be done
 950  *      using radix_tree_deref_slot.
 951  */
 952 void **radix_tree_lookup_slot(struct radix_tree_root *root, unsigned long index)
 953 {
 954         void **slot;
 955
 956         if (!__radix_tree_lookup(root, index, NULL, &slot))
 957                 return NULL;
 958         return slot;
 959 }
 960 EXPORT_SYMBOL(radix_tree_lookup_slot);
 961
 962 /**
 963  *      radix_tree_lookup    -    perform lookup operation on a radix tree
 964  *      @root:          radix tree root
 965  *      @index:         index key
 966  *
 967  *      Lookup the item at the position @index in the radix tree @root.
 968  *
 969  *      This function can be called under rcu_read_lock, however the caller
 970  *      must manage lifetimes of leaf nodes (eg. RCU may also be used to free
 971  *      them safely). No RCU barriers are required to access or modify the
 972  *      returned item, however.
 973  */
 974 void *radix_tree_lookup(struct radix_tree_root *root, unsigned long index)
 975 {
 976         return __radix_tree_lookup(root, index, NULL, NULL);
 977 }
 978 EXPORT_SYMBOL(radix_tree_lookup);
 979
 980 static inline int slot_count(struct radix_tree_node *node,
 981                                                 void **slot)
 982 {
 983         int n = 1;
 984 #ifdef CONFIG_RADIX_TREE_MULTIORDER
 985         void *ptr = node_to_entry(slot);
 986         unsigned offset = get_slot_offset(node, slot);
 987         int i;
 988
 989         for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
 990                 if (node->slots[offset + i] != ptr)
 991                         break;
 992                 n++;
 993         }
 994 #endif
 995         return n;
 996 }
 997
 998 static void replace_slot(struct radix_tree_root *root,
 999                          struct radix_tree_node *node,
1000                          void **slot, void *item,
1001                          bool warn_typeswitch)
1002 {
1003         void *old = rcu_dereference_raw(*slot);
1004         int count, exceptional;
1005
1006         WARN_ON_ONCE(radix_tree_is_internal_node(item));
1007
1008         count = !!item - !!old;
1009         exceptional = !!radix_tree_exceptional_entry(item) -
1010                       !!radix_tree_exceptional_entry(old);
1011
1012         WARN_ON_ONCE(warn_typeswitch && (count || exceptional));
1013
1014         if (node) {
1015                 node->count += count;
1016                 if (exceptional) {
1017                         exceptional *= slot_count(node, slot);
1018                         node->exceptional += exceptional;
1019                 }
1020         }
1021
1022         rcu_assign_pointer(*slot, item);
1023 }
1024
1025 static inline void delete_sibling_entries(struct radix_tree_node *node,
1026                                                 void **slot)
1027 {
1028 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1029         bool exceptional = radix_tree_exceptional_entry(*slot);
1030         void *ptr = node_to_entry(slot);
1031         unsigned offset = get_slot_offset(node, slot);
1032         int i;
1033
1034         for (i = 1; offset + i < RADIX_TREE_MAP_SIZE; i++) {
1035                 if (node->slots[offset + i] != ptr)
1036                         break;
1037                 node->slots[offset + i] = NULL;
1038                 node->count--;
1039                 if (exceptional)
1040                         node->exceptional--;
1041         }
1042 #endif
1043 }
1044
1045 /**
1046  * __radix_tree_replace         - replace item in a slot
1047  * @root:               radix tree root
1048  * @node:               pointer to tree node
1049  * @slot:               pointer to slot in @node
1050  * @item:               new item to store in the slot.
1051  * @update_node:        callback for changing leaf nodes
1052  * @private:            private data to pass to @update_node
1053  *
1054  * For use with __radix_tree_lookup().  Caller must hold tree write locked
1055  * across slot lookup and replacement.
1056  */
1057 void __radix_tree_replace(struct radix_tree_root *root,
1058                           struct radix_tree_node *node,
1059                           void **slot, void *item,
1060                           radix_tree_update_node_t update_node, void *private)
1061 {
1062         if (!item)
1063                 delete_sibling_entries(node, slot);
1064         /*
1065          * This function supports replacing exceptional entries and
1066          * deleting entries, but that needs accounting against the
1067          * node unless the slot is root->rnode.
1068          */
1069         replace_slot(root, node, slot, item,
1070                      !node && slot != (void **)&root->rnode);
1071
1072         if (!node)
1073                 return;
1074
1075         if (update_node)
1076                 update_node(node, private);
1077
1078         delete_node(root, node, update_node, private);
1079 }
1080
1081 /**
1082  * radix_tree_replace_slot      - replace item in a slot
1083  * @root:       radix tree root
1084  * @slot:       pointer to slot
1085  * @item:       new item to store in the slot.
1086  *
1087  * For use with radix_tree_lookup_slot(), radix_tree_gang_lookup_slot(),
1088  * radix_tree_gang_lookup_tag_slot().  Caller must hold tree write locked
1089  * across slot lookup and replacement.
1090  *
1091  * NOTE: This cannot be used to switch between non-entries (empty slots),
1092  * regular entries, and exceptional entries, as that requires accounting
1093  * inside the radix tree node. When switching from one type of entry or
1094  * deleting, use __radix_tree_lookup() and __radix_tree_replace() or
1095  * radix_tree_iter_replace().
1096  */
1097 void radix_tree_replace_slot(struct radix_tree_root *root,
1098                              void **slot, void *item)
1099 {
1100         replace_slot(root, NULL, slot, item, true);
1101 }
1102
1103 /**
1104  * radix_tree_iter_replace - replace item in a slot
1105  * @root:       radix tree root
1106  * @slot:       pointer to slot
1107  * @item:       new item to store in the slot.
1108  *
1109  * For use with radix_tree_split() and radix_tree_for_each_slot().
1110  * Caller must hold tree write locked across split and replacement.
1111  */
1112 void radix_tree_iter_replace(struct radix_tree_root *root,
1113                 const struct radix_tree_iter *iter, void **slot, void *item)
1114 {
1115         __radix_tree_replace(root, iter->node, slot, item, NULL, NULL);
1116 }
1117
1118 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1119 /**
1120  * radix_tree_join - replace multiple entries with one multiorder entry
1121  * @root: radix tree root
1122  * @index: an index inside the new entry
1123  * @order: order of the new entry
1124  * @item: new entry
1125  *
1126  * Call this function to replace several entries with one larger entry.
1127  * The existing entries are presumed to not need freeing as a result of
1128  * this call.
1129  *
1130  * The replacement entry will have all the tags set on it that were set
1131  * on any of the entries it is replacing.
1132  */
1133 int radix_tree_join(struct radix_tree_root *root, unsigned long index,
1134                         unsigned order, void *item)
1135 {
1136         struct radix_tree_node *node;
1137         void **slot;
1138         int error;
1139
1140         BUG_ON(radix_tree_is_internal_node(item));
1141
1142         error = __radix_tree_create(root, index, order, &node, &slot);
1143         if (!error)
1144                 error = insert_entries(node, slot, item, order, true);
1145         if (error > 0)
1146                 error = 0;
1147
1148         return error;
1149 }
1150
1151 /**
1152  * radix_tree_split - Split an entry into smaller entries
1153  * @root: radix tree root
1154  * @index: An index within the large entry
1155  * @order: Order of new entries
1156  *
1157  * Call this function as the first step in replacing a multiorder entry
1158  * with several entries of lower order.  After this function returns,
1159  * loop over the relevant portion of the tree using radix_tree_for_each_slot()
1160  * and call radix_tree_iter_replace() to set up each new entry.
1161  *
1162  * The tags from this entry are replicated to all the new entries.
1163  *
1164  * The radix tree should be locked against modification during the entire
1165  * replacement operation.  Lock-free lookups will see RADIX_TREE_RETRY which
1166  * should prompt RCU walkers to restart the lookup from the root.
1167  */
1168 int radix_tree_split(struct radix_tree_root *root, unsigned long index,
1169                                 unsigned order)
1170 {
1171         struct radix_tree_node *parent, *node, *child;
1172         void **slot;
1173         unsigned int offset, end;
1174         unsigned n, tag, tags = 0;
1175
1176         if (!__radix_tree_lookup(root, index, &parent, &slot))
1177                 return -ENOENT;
1178         if (!parent)
1179                 return -ENOENT;
1180
1181         offset = get_slot_offset(parent, slot);
1182
1183         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1184                 if (tag_get(parent, tag, offset))
1185                         tags |= 1 << tag;
1186
1187         for (end = offset + 1; end < RADIX_TREE_MAP_SIZE; end++) {
1188                 if (!is_sibling_entry(parent, parent->slots[end]))
1189                         break;
1190                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1191                         if (tags & (1 << tag))
1192                                 tag_set(parent, tag, end);
1193                 /* rcu_assign_pointer ensures tags are set before RETRY */
1194                 rcu_assign_pointer(parent->slots[end], RADIX_TREE_RETRY);
1195         }
1196         rcu_assign_pointer(parent->slots[offset], RADIX_TREE_RETRY);
1197         parent->exceptional -= (end - offset);
1198
1199         if (order == parent->shift)
1200                 return 0;
1201         if (order > parent->shift) {
1202                 while (offset < end)
1203                         offset += insert_entries(parent, &parent->slots[offset],
1204                                         RADIX_TREE_RETRY, order, true);
1205                 return 0;
1206         }
1207
1208         node = parent;
1209
1210         for (;;) {
1211                 if (node->shift > order) {
1212                         child = radix_tree_node_alloc(root);
1213                         if (!child)
1214                                 goto nomem;
1215                         child->shift = node->shift - RADIX_TREE_MAP_SHIFT;
1216                         child->offset = offset;
1217                         child->count = 0;
1218                         child->parent = node;
1219                         if (node != parent) {
1220                                 node->count++;
1221                                 node->slots[offset] = node_to_entry(child);
1222                                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1223                                         if (tags & (1 << tag))
1224                                                 tag_set(node, tag, offset);
1225                         }
1226
1227                         node = child;
1228                         offset = 0;
1229                         continue;
1230                 }
1231
1232                 n = insert_entries(node, &node->slots[offset],
1233                                         RADIX_TREE_RETRY, order, false);
1234                 BUG_ON(n > RADIX_TREE_MAP_SIZE);
1235
1236                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1237                         if (tags & (1 << tag))
1238                                 tag_set(node, tag, offset);
1239                 offset += n;
1240
1241                 while (offset == RADIX_TREE_MAP_SIZE) {
1242                         if (node == parent)
1243                                 break;
1244                         offset = node->offset;
1245                         child = node;
1246                         node = node->parent;
1247                         rcu_assign_pointer(node->slots[offset],
1248                                                 node_to_entry(child));
1249                         offset++;
1250                 }
1251                 if ((node == parent) && (offset == end))
1252                         return 0;
1253         }
1254
1255  nomem:
1256         /* Shouldn't happen; did user forget to preload? */
1257         /* TODO: free all the allocated nodes */
1258         WARN_ON(1);
1259         return -ENOMEM;
1260 }
1261 #endif
1262
1263 /**
1264  *      radix_tree_tag_set - set a tag on a radix tree node
1265  *      @root:          radix tree root
1266  *      @index:         index key
1267  *      @tag:           tag index
1268  *
1269  *      Set the search tag (which must be < RADIX_TREE_MAX_TAGS)
1270  *      corresponding to @index in the radix tree.  From
1271  *      the root all the way down to the leaf node.
1272  *
1273  *      Returns the address of the tagged item.  Setting a tag on a not-present
1274  *      item is a bug.
1275  */
1276 void *radix_tree_tag_set(struct radix_tree_root *root,
1277                         unsigned long index, unsigned int tag)
1278 {
1279         struct radix_tree_node *node, *parent;
1280         unsigned long maxindex;
1281
1282         radix_tree_load_root(root, &node, &maxindex);
1283         BUG_ON(index > maxindex);
1284
1285         while (radix_tree_is_internal_node(node)) {
1286                 unsigned offset;
1287
1288                 parent = entry_to_node(node);
1289                 offset = radix_tree_descend(parent, &node, index);
1290                 BUG_ON(!node);
1291
1292                 if (!tag_get(parent, tag, offset))
1293                         tag_set(parent, tag, offset);
1294         }
1295
1296         /* set the root's tag bit */
1297         if (!root_tag_get(root, tag))
1298                 root_tag_set(root, tag);
1299
1300         return node;
1301 }
1302 EXPORT_SYMBOL(radix_tree_tag_set);
1303
1304 static void node_tag_clear(struct radix_tree_root *root,
1305                                 struct radix_tree_node *node,
1306                                 unsigned int tag, unsigned int offset)
1307 {
1308         while (node) {
1309                 if (!tag_get(node, tag, offset))
1310                         return;
1311                 tag_clear(node, tag, offset);
1312                 if (any_tag_set(node, tag))
1313                         return;
1314
1315                 offset = node->offset;
1316                 node = node->parent;
1317         }
1318
1319         /* clear the root's tag bit */
1320         if (root_tag_get(root, tag))
1321                 root_tag_clear(root, tag);
1322 }
1323
1324 static void node_tag_set(struct radix_tree_root *root,
1325                                 struct radix_tree_node *node,
1326                                 unsigned int tag, unsigned int offset)
1327 {
1328         while (node) {
1329                 if (tag_get(node, tag, offset))
1330                         return;
1331                 tag_set(node, tag, offset);
1332                 offset = node->offset;
1333                 node = node->parent;
1334         }
1335
1336         if (!root_tag_get(root, tag))
1337                 root_tag_set(root, tag);
1338 }
1339
1340 /**
1341  * radix_tree_iter_tag_set - set a tag on the current iterator entry
1342  * @root:       radix tree root
1343  * @iter:       iterator state
1344  * @tag:        tag to set
1345  */
1346 void radix_tree_iter_tag_set(struct radix_tree_root *root,
1347                         const struct radix_tree_iter *iter, unsigned int tag)
1348 {
1349         node_tag_set(root, iter->node, tag, iter_offset(iter));
1350 }
1351
1352 /**
1353  *      radix_tree_tag_clear - clear a tag on a radix tree node
1354  *      @root:          radix tree root
1355  *      @index:         index key
1356  *      @tag:           tag index
1357  *
1358  *      Clear the search tag (which must be < RADIX_TREE_MAX_TAGS)
1359  *      corresponding to @index in the radix tree.  If this causes
1360  *      the leaf node to have no tags set then clear the tag in the
1361  *      next-to-leaf node, etc.
1362  *
1363  *      Returns the address of the tagged item on success, else NULL.  ie:
1364  *      has the same return value and semantics as radix_tree_lookup().
1365  */
1366 void *radix_tree_tag_clear(struct radix_tree_root *root,
1367                         unsigned long index, unsigned int tag)
1368 {
1369         struct radix_tree_node *node, *parent;
1370         unsigned long maxindex;
1371         int uninitialized_var(offset);
1372
1373         radix_tree_load_root(root, &node, &maxindex);
1374         if (index > maxindex)
1375                 return NULL;
1376
1377         parent = NULL;
1378
1379         while (radix_tree_is_internal_node(node)) {
1380                 parent = entry_to_node(node);
1381                 offset = radix_tree_descend(parent, &node, index);
1382         }
1383
1384         if (node)
1385                 node_tag_clear(root, parent, tag, offset);
1386
1387         return node;
1388 }
1389 EXPORT_SYMBOL(radix_tree_tag_clear);
1390
1391 /**
1392  * radix_tree_tag_get - get a tag on a radix tree node
1393  * @root:               radix tree root
1394  * @index:              index key
1395  * @tag:                tag index (< RADIX_TREE_MAX_TAGS)
1396  *
1397  * Return values:
1398  *
1399  *  0: tag not present or not set
1400  *  1: tag set
1401  *
1402  * Note that the return value of this function may not be relied on, even if
1403  * the RCU lock is held, unless tag modification and node deletion are excluded
1404  * from concurrency.
1405  */
1406 int radix_tree_tag_get(struct radix_tree_root *root,
1407                         unsigned long index, unsigned int tag)
1408 {
1409         struct radix_tree_node *node, *parent;
1410         unsigned long maxindex;
1411
1412         if (!root_tag_get(root, tag))
1413                 return 0;
1414
1415         radix_tree_load_root(root, &node, &maxindex);
1416         if (index > maxindex)
1417                 return 0;
1418         if (node == NULL)
1419                 return 0;
1420
1421         while (radix_tree_is_internal_node(node)) {
1422                 unsigned offset;
1423
1424                 parent = entry_to_node(node);
1425                 offset = radix_tree_descend(parent, &node, index);
1426
1427                 if (!node)
1428                         return 0;
1429                 if (!tag_get(parent, tag, offset))
1430                         return 0;
1431                 if (node == RADIX_TREE_RETRY)
1432                         break;
1433         }
1434
1435         return 1;
1436 }
1437 EXPORT_SYMBOL(radix_tree_tag_get);
1438
1439 static inline void __set_iter_shift(struct radix_tree_iter *iter,
1440                                         unsigned int shift)
1441 {
1442 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1443         iter->shift = shift;
1444 #endif
1445 }
1446
1447 /* Construct iter->tags bit-mask from node->tags[tag] array */
1448 static void set_iter_tags(struct radix_tree_iter *iter,
1449                                 struct radix_tree_node *node, unsigned offset,
1450                                 unsigned tag)
1451 {
1452         unsigned tag_long = offset / BITS_PER_LONG;
1453         unsigned tag_bit  = offset % BITS_PER_LONG;
1454
1455         iter->tags = node->tags[tag][tag_long] >> tag_bit;
1456
1457         /* This never happens if RADIX_TREE_TAG_LONGS == 1 */
1458         if (tag_long < RADIX_TREE_TAG_LONGS - 1) {
1459                 /* Pick tags from next element */
1460                 if (tag_bit)
1461                         iter->tags |= node->tags[tag][tag_long + 1] <<
1462                                                 (BITS_PER_LONG - tag_bit);
1463                 /* Clip chunk size, here only BITS_PER_LONG tags */
1464                 iter->next_index = __radix_tree_iter_add(iter, BITS_PER_LONG);
1465         }
1466 }
1467
1468 #ifdef CONFIG_RADIX_TREE_MULTIORDER
1469 static void **skip_siblings(struct radix_tree_node **nodep,
1470                         void **slot, struct radix_tree_iter *iter)
1471 {
1472         void *sib = node_to_entry(slot - 1);
1473
1474         while (iter->index < iter->next_index) {
1475                 *nodep = rcu_dereference_raw(*slot);
1476                 if (*nodep && *nodep != sib)
1477                         return slot;
1478                 slot++;
1479                 iter->index = __radix_tree_iter_add(iter, 1);
1480                 iter->tags >>= 1;
1481         }
1482
1483         *nodep = NULL;
1484         return NULL;
1485 }
1486
1487 void ** __radix_tree_next_slot(void **slot, struct radix_tree_iter *iter,
1488                                         unsigned flags)
1489 {
1490         unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
1491         struct radix_tree_node *node = rcu_dereference_raw(*slot);
1492
1493         slot = skip_siblings(&node, slot, iter);
1494
1495         while (radix_tree_is_internal_node(node)) {
1496                 unsigned offset;
1497                 unsigned long next_index;
1498
1499                 if (node == RADIX_TREE_RETRY)
1500                         return slot;
1501                 node = entry_to_node(node);
1502                 iter->node = node;
1503                 iter->shift = node->shift;
1504
1505                 if (flags & RADIX_TREE_ITER_TAGGED) {
1506                         offset = radix_tree_find_next_bit(node, tag, 0);
1507                         if (offset == RADIX_TREE_MAP_SIZE)
1508                                 return NULL;
1509                         slot = &node->slots[offset];
1510                         iter->index = __radix_tree_iter_add(iter, offset);
1511                         set_iter_tags(iter, node, offset, tag);
1512                         node = rcu_dereference_raw(*slot);
1513                 } else {
1514                         offset = 0;
1515                         slot = &node->slots[0];
1516                         for (;;) {
1517                                 node = rcu_dereference_raw(*slot);
1518                                 if (node)
1519                                         break;
1520                                 slot++;
1521                                 offset++;
1522                                 if (offset == RADIX_TREE_MAP_SIZE)
1523                                         return NULL;
1524                         }
1525                         iter->index = __radix_tree_iter_add(iter, offset);
1526                 }
1527                 if ((flags & RADIX_TREE_ITER_CONTIG) && (offset > 0))
1528                         goto none;
1529                 next_index = (iter->index | shift_maxindex(iter->shift)) + 1;
1530                 if (next_index < iter->next_index)
1531                         iter->next_index = next_index;
1532         }
1533
1534         return slot;
1535  none:
1536         iter->next_index = 0;
1537         return NULL;
1538 }
1539 EXPORT_SYMBOL(__radix_tree_next_slot);
1540 #else
1541 static void **skip_siblings(struct radix_tree_node **nodep,
1542                         void **slot, struct radix_tree_iter *iter)
1543 {
1544         return slot;
1545 }
1546 #endif
1547
1548 void **radix_tree_iter_resume(void **slot, struct radix_tree_iter *iter)
1549 {
1550         struct radix_tree_node *node;
1551
1552         slot++;
1553         iter->index = __radix_tree_iter_add(iter, 1);
1554         node = rcu_dereference_raw(*slot);
1555         skip_siblings(&node, slot, iter);
1556         iter->next_index = iter->index;
1557         iter->tags = 0;
1558         return NULL;
1559 }
1560 EXPORT_SYMBOL(radix_tree_iter_resume);
1561
1562 /**
1563  * radix_tree_next_chunk - find next chunk of slots for iteration
1564  *
1565  * @root:       radix tree root
1566  * @iter:       iterator state
1567  * @flags:      RADIX_TREE_ITER_* flags and tag index
1568  * Returns:     pointer to chunk first slot, or NULL if iteration is over
1569  */
1570 void **radix_tree_next_chunk(struct radix_tree_root *root,
1571                              struct radix_tree_iter *iter, unsigned flags)
1572 {
1573         unsigned tag = flags & RADIX_TREE_ITER_TAG_MASK;
1574         struct radix_tree_node *node, *child;
1575         unsigned long index, offset, maxindex;
1576
1577         if ((flags & RADIX_TREE_ITER_TAGGED) && !root_tag_get(root, tag))
1578                 return NULL;
1579
1580         /*
1581          * Catch next_index overflow after ~0UL. iter->index never overflows
1582          * during iterating; it can be zero only at the beginning.
1583          * And we cannot overflow iter->next_index in a single step,
1584          * because RADIX_TREE_MAP_SHIFT < BITS_PER_LONG.
1585          *
1586          * This condition also used by radix_tree_next_slot() to stop
1587          * contiguous iterating, and forbid switching to the next chunk.
1588          */
1589         index = iter->next_index;
1590         if (!index && iter->index)
1591                 return NULL;
1592
1593  restart:
1594         radix_tree_load_root(root, &child, &maxindex);
1595         if (index > maxindex)
1596                 return NULL;
1597         if (!child)
1598                 return NULL;
1599
1600         if (!radix_tree_is_internal_node(child)) {
1601                 /* Single-slot tree */
1602                 iter->index = index;
1603                 iter->next_index = maxindex + 1;
1604                 iter->tags = 1;
1605                 iter->node = NULL;
1606                 __set_iter_shift(iter, 0);
1607                 return (void **)&root->rnode;
1608         }
1609
1610         do {
1611                 node = entry_to_node(child);
1612                 offset = radix_tree_descend(node, &child, index);
1613
1614                 if ((flags & RADIX_TREE_ITER_TAGGED) ?
1615                                 !tag_get(node, tag, offset) : !child) {
1616                         /* Hole detected */
1617                         if (flags & RADIX_TREE_ITER_CONTIG)
1618                                 return NULL;
1619
1620                         if (flags & RADIX_TREE_ITER_TAGGED)
1621                                 offset = radix_tree_find_next_bit(node, tag,
1622                                                 offset + 1);
1623                         else
1624                                 while (++offset < RADIX_TREE_MAP_SIZE) {
1625                                         void *slot = node->slots[offset];
1626                                         if (is_sibling_entry(node, slot))
1627                                                 continue;
1628                                         if (slot)
1629                                                 break;
1630                                 }
1631                         index &= ~node_maxindex(node);
1632                         index += offset << node->shift;
1633                         /* Overflow after ~0UL */
1634                         if (!index)
1635                                 return NULL;
1636                         if (offset == RADIX_TREE_MAP_SIZE)
1637                                 goto restart;
1638                         child = rcu_dereference_raw(node->slots[offset]);
1639                 }
1640
1641                 if (!child)
1642                         goto restart;
1643                 if (child == RADIX_TREE_RETRY)
1644                         break;
1645         } while (radix_tree_is_internal_node(child));
1646
1647         /* Update the iterator state */
1648         iter->index = (index &~ node_maxindex(node)) | (offset << node->shift);
1649         iter->next_index = (index | node_maxindex(node)) + 1;
1650         iter->node = node;
1651         __set_iter_shift(iter, node->shift);
1652
1653         if (flags & RADIX_TREE_ITER_TAGGED)
1654                 set_iter_tags(iter, node, offset, tag);
1655
1656         return node->slots + offset;
1657 }
1658 EXPORT_SYMBOL(radix_tree_next_chunk);
1659
1660 /**
1661  *      radix_tree_gang_lookup - perform multiple lookup on a radix tree
1662  *      @root:          radix tree root
1663  *      @results:       where the results of the lookup are placed
1664  *      @first_index:   start the lookup from this key
1665  *      @max_items:     place up to this many items at *results
1666  *
1667  *      Performs an index-ascending scan of the tree for present items.  Places
1668  *      them at *@results and returns the number of items which were placed at
1669  *      *@results.
1670  *
1671  *      The implementation is naive.
1672  *
1673  *      Like radix_tree_lookup, radix_tree_gang_lookup may be called under
1674  *      rcu_read_lock. In this case, rather than the returned results being
1675  *      an atomic snapshot of the tree at a single point in time, the
1676  *      semantics of an RCU protected gang lookup are as though multiple
1677  *      radix_tree_lookups have been issued in individual locks, and results
1678  *      stored in 'results'.
1679  */
1680 unsigned int
1681 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
1682                         unsigned long first_index, unsigned int max_items)
1683 {
1684         struct radix_tree_iter iter;
1685         void **slot;
1686         unsigned int ret = 0;
1687
1688         if (unlikely(!max_items))
1689                 return 0;
1690
1691         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1692                 results[ret] = rcu_dereference_raw(*slot);
1693                 if (!results[ret])
1694                         continue;
1695                 if (radix_tree_is_internal_node(results[ret])) {
1696                         slot = radix_tree_iter_retry(&iter);
1697                         continue;
1698                 }
1699                 if (++ret == max_items)
1700                         break;
1701         }
1702
1703         return ret;
1704 }
1705 EXPORT_SYMBOL(radix_tree_gang_lookup);
1706
1707 /**
1708  *      radix_tree_gang_lookup_slot - perform multiple slot lookup on radix tree
1709  *      @root:          radix tree root
1710  *      @results:       where the results of the lookup are placed
1711  *      @indices:       where their indices should be placed (but usually NULL)
1712  *      @first_index:   start the lookup from this key
1713  *      @max_items:     place up to this many items at *results
1714  *
1715  *      Performs an index-ascending scan of the tree for present items.  Places
1716  *      their slots at *@results and returns the number of items which were
1717  *      placed at *@results.
1718  *
1719  *      The implementation is naive.
1720  *
1721  *      Like radix_tree_gang_lookup as far as RCU and locking goes. Slots must
1722  *      be dereferenced with radix_tree_deref_slot, and if using only RCU
1723  *      protection, radix_tree_deref_slot may fail requiring a retry.
1724  */
1725 unsigned int
1726 radix_tree_gang_lookup_slot(struct radix_tree_root *root,
1727                         void ***results, unsigned long *indices,
1728                         unsigned long first_index, unsigned int max_items)
1729 {
1730         struct radix_tree_iter iter;
1731         void **slot;
1732         unsigned int ret = 0;
1733
1734         if (unlikely(!max_items))
1735                 return 0;
1736
1737         radix_tree_for_each_slot(slot, root, &iter, first_index) {
1738                 results[ret] = slot;
1739                 if (indices)
1740                         indices[ret] = iter.index;
1741                 if (++ret == max_items)
1742                         break;
1743         }
1744
1745         return ret;
1746 }
1747 EXPORT_SYMBOL(radix_tree_gang_lookup_slot);
1748
1749 /**
1750  *      radix_tree_gang_lookup_tag - perform multiple lookup on a radix tree
1751  *                                   based on a tag
1752  *      @root:          radix tree root
1753  *      @results:       where the results of the lookup are placed
1754  *      @first_index:   start the lookup from this key
1755  *      @max_items:     place up to this many items at *results
1756  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1757  *
1758  *      Performs an index-ascending scan of the tree for present items which
1759  *      have the tag indexed by @tag set.  Places the items at *@results and
1760  *      returns the number of items which were placed at *@results.
1761  */
1762 unsigned int
1763 radix_tree_gang_lookup_tag(struct radix_tree_root *root, void **results,
1764                 unsigned long first_index, unsigned int max_items,
1765                 unsigned int tag)
1766 {
1767         struct radix_tree_iter iter;
1768         void **slot;
1769         unsigned int ret = 0;
1770
1771         if (unlikely(!max_items))
1772                 return 0;
1773
1774         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1775                 results[ret] = rcu_dereference_raw(*slot);
1776                 if (!results[ret])
1777                         continue;
1778                 if (radix_tree_is_internal_node(results[ret])) {
1779                         slot = radix_tree_iter_retry(&iter);
1780                         continue;
1781                 }
1782                 if (++ret == max_items)
1783                         break;
1784         }
1785
1786         return ret;
1787 }
1788 EXPORT_SYMBOL(radix_tree_gang_lookup_tag);
1789
1790 /**
1791  *      radix_tree_gang_lookup_tag_slot - perform multiple slot lookup on a
1792  *                                        radix tree based on a tag
1793  *      @root:          radix tree root
1794  *      @results:       where the results of the lookup are placed
1795  *      @first_index:   start the lookup from this key
1796  *      @max_items:     place up to this many items at *results
1797  *      @tag:           the tag index (< RADIX_TREE_MAX_TAGS)
1798  *
1799  *      Performs an index-ascending scan of the tree for present items which
1800  *      have the tag indexed by @tag set.  Places the slots at *@results and
1801  *      returns the number of slots which were placed at *@results.
1802  */
1803 unsigned int
1804 radix_tree_gang_lookup_tag_slot(struct radix_tree_root *root, void ***results,
1805                 unsigned long first_index, unsigned int max_items,
1806                 unsigned int tag)
1807 {
1808         struct radix_tree_iter iter;
1809         void **slot;
1810         unsigned int ret = 0;
1811
1812         if (unlikely(!max_items))
1813                 return 0;
1814
1815         radix_tree_for_each_tagged(slot, root, &iter, first_index, tag) {
1816                 results[ret] = slot;
1817                 if (++ret == max_items)
1818                         break;
1819         }
1820
1821         return ret;
1822 }
1823 EXPORT_SYMBOL(radix_tree_gang_lookup_tag_slot);
1824
1825 /**
1826  *      __radix_tree_delete_node    -    try to free node after clearing a slot
1827  *      @root:          radix tree root
1828  *      @node:          node containing @index
1829  *
1830  *      After clearing the slot at @index in @node from radix tree
1831  *      rooted at @root, call this function to attempt freeing the
1832  *      node and shrinking the tree.
1833  */
1834 void __radix_tree_delete_node(struct radix_tree_root *root,
1835                               struct radix_tree_node *node)
1836 {
1837         delete_node(root, node, NULL, NULL);
1838 }
1839
1840 /**
1841  *      radix_tree_delete_item    -    delete an item from a radix tree
1842  *      @root:          radix tree root
1843  *      @index:         index key
1844  *      @item:          expected item
1845  *
1846  *      Remove @item at @index from the radix tree rooted at @root.
1847  *
1848  *      Returns the address of the deleted item, or NULL if it was not present
1849  *      or the entry at the given @index was not @item.
1850  */
1851 void *radix_tree_delete_item(struct radix_tree_root *root,
1852                              unsigned long index, void *item)
1853 {
1854         struct radix_tree_node *node;
1855         unsigned int offset;
1856         void **slot;
1857         void *entry;
1858         int tag;
1859
1860         entry = __radix_tree_lookup(root, index, &node, &slot);
1861         if (!entry)
1862                 return NULL;
1863
1864         if (item && entry != item)
1865                 return NULL;
1866
1867         if (!node) {
1868                 root_tag_clear_all(root);
1869                 root->rnode = NULL;
1870                 return entry;
1871         }
1872
1873         offset = get_slot_offset(node, slot);
1874
1875         /* Clear all tags associated with the item to be deleted.  */
1876         for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1877                 node_tag_clear(root, node, tag, offset);
1878
1879         __radix_tree_replace(root, node, slot, NULL, NULL, NULL);
1880
1881         return entry;
1882 }
1883 EXPORT_SYMBOL(radix_tree_delete_item);
1884
1885 /**
1886  *      radix_tree_delete    -    delete an item from a radix tree
1887  *      @root:          radix tree root
1888  *      @index:         index key
1889  *
1890  *      Remove the item at @index from the radix tree rooted at @root.
1891  *
1892  *      Returns the address of the deleted item, or NULL if it was not present.
1893  */
1894 void *radix_tree_delete(struct radix_tree_root *root, unsigned long index)
1895 {
1896         return radix_tree_delete_item(root, index, NULL);
1897 }
1898 EXPORT_SYMBOL(radix_tree_delete);
1899
1900 void radix_tree_clear_tags(struct radix_tree_root *root,
1901                            struct radix_tree_node *node,
1902                            void **slot)
1903 {
1904         if (node) {
1905                 unsigned int tag, offset = get_slot_offset(node, slot);
1906                 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++)
1907                         node_tag_clear(root, node, tag, offset);
1908         } else {
1909                 /* Clear root node tags */
1910                 root->gfp_mask &= __GFP_BITS_MASK;
1911         }
1912 }
1913
1914 /**
1915  *      radix_tree_tagged - test whether any items in the tree are tagged
1916  *      @root:          radix tree root
1917  *      @tag:           tag to test
1918  */
1919 int radix_tree_tagged(struct radix_tree_root *root, unsigned int tag)
1920 {
1921         return root_tag_get(root, tag);
1922 }
1923 EXPORT_SYMBOL(radix_tree_tagged);
1924
1925 static void
1926 radix_tree_node_ctor(void *arg)
1927 {
1928         struct radix_tree_node *node = arg;
1929
1930         memset(node, 0, sizeof(*node));
1931         INIT_LIST_HEAD(&node->private_list);
1932 }
1933
1934 static __init unsigned long __maxindex(unsigned int height)
1935 {
1936         unsigned int width = height * RADIX_TREE_MAP_SHIFT;
1937         int shift = RADIX_TREE_INDEX_BITS - width;
1938
1939         if (shift < 0)
1940                 return ~0UL;
1941         if (shift >= BITS_PER_LONG)
1942                 return 0UL;
1943         return ~0UL >> shift;
1944 }
1945
1946 static __init void radix_tree_init_maxnodes(void)
1947 {
1948         unsigned long height_to_maxindex[RADIX_TREE_MAX_PATH + 1];
1949         unsigned int i, j;
1950
1951         for (i = 0; i < ARRAY_SIZE(height_to_maxindex); i++)
1952                 height_to_maxindex[i] = __maxindex(i);
1953         for (i = 0; i < ARRAY_SIZE(height_to_maxnodes); i++) {
1954                 for (j = i; j > 0; j--)
1955                         height_to_maxnodes[i] += height_to_maxindex[j - 1] + 1;
1956         }
1957 }
1958
1959 static int radix_tree_cpu_dead(unsigned int cpu)
1960 {
1961         struct radix_tree_preload *rtp;
1962         struct radix_tree_node *node;
1963
1964         /* Free per-cpu pool of preloaded nodes */
1965         rtp = &per_cpu(radix_tree_preloads, cpu);
1966         while (rtp->nr) {
1967                 node = rtp->nodes;
1968                 rtp->nodes = node->private_data;
1969                 kmem_cache_free(radix_tree_node_cachep, node);
1970                 rtp->nr--;
1971         }
1972         return 0;
1973 }
1974
1975 void __init radix_tree_init(void)
1976 {
1977         int ret;
1978         radix_tree_node_cachep = kmem_cache_create("radix_tree_node",
1979                         sizeof(struct radix_tree_node), 0,
1980                         SLAB_PANIC | SLAB_RECLAIM_ACCOUNT,
1981                         radix_tree_node_ctor);
1982         radix_tree_init_maxnodes();
1983         ret = cpuhp_setup_state_nocalls(CPUHP_RADIX_DEAD, "lib/radix:dead",
1984                                         NULL, radix_tree_cpu_dead);
1985         WARN_ON(ret < 0);
1986 }