sys/vm/vm_radix.c

   1 /*
   2  * Copyright (c) 2013 EMC Corp.
   3  * Copyright (c) 2011 Jeffrey Roberson <jeff@freebsd.org>
   4  * Copyright (c) 2008 Mayur Shardul <mayur.shardul@gmail.com>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  */
  29
  30 /*
  31  * Path-compressed radix trie implementation.
  32  * The following code is not generalized into a general purpose library
  33  * because there are way too many parameters embedded that should really
  34  * be decided by the library consumers.  At the same time, consumers
  35  * of this code must achieve highest possible performance.
  36  *
  37  * The implementation takes into account the following rationale:
  38  * - Size of the nodes should be as small as possible but still big enough
  39  *   to avoid a large maximum depth for the trie.  This is a balance
  40  *   between the necessity to not wire too much physical memory for the nodes
  41  *   and the necessity to avoid too much cache pollution during the trie
  42  *   operations.
  43  * - There is not a huge bias toward the number of lookup operations over
  44  *   the number of insert and remove operations.  This basically implies
  45  *   that optimizations supposedly helping one operation but hurting the
  46  *   other might be carefully evaluated.
  47  * - On average not many nodes are expected to be fully populated, hence
  48  *   level compression may just complicate things.
  49  */
  50
  51 #include <sys/cdefs.h>
  52 __FBSDID("$FreeBSD$");
  53
  54 #include "opt_ddb.h"
  55
  56 #include <sys/param.h>
  57 #include <sys/systm.h>
  58 #include <sys/kernel.h>
  59 #include <sys/vmmeter.h>
  60
  61 #include <vm/uma.h>
  62 #include <vm/vm.h>
  63 #include <vm/vm_param.h>
  64 #include <vm/vm_page.h>
  65 #include <vm/vm_radix.h>
  66
  67 #ifdef DDB
  68 #include <ddb/ddb.h>
  69 #endif
  70
  71 /*
  72  * These widths should allow the pointers to a node's children to fit within
  73  * a single cache line.  The extra levels from a narrow width should not be
  74  * a problem thanks to path compression.
  75  */
  76 #ifdef __LP64__
  77 #define VM_RADIX_WIDTH  4
  78 #else
  79 #define VM_RADIX_WIDTH  3
  80 #endif
  81
  82 #define VM_RADIX_COUNT  (1 << VM_RADIX_WIDTH)
  83 #define VM_RADIX_MASK   (VM_RADIX_COUNT - 1)
  84 #define VM_RADIX_LIMIT                                                  \
  85         (howmany((sizeof(vm_pindex_t) * NBBY), VM_RADIX_WIDTH) - 1)
  86
  87 /* Flag bits stored in node pointers. */
  88 #define VM_RADIX_ISLEAF 0x1
  89 #define VM_RADIX_FLAGS  0x1
  90 #define VM_RADIX_PAD    VM_RADIX_FLAGS
  91
  92 /* Returns one unit associated with specified level. */
  93 #define VM_RADIX_UNITLEVEL(lev)                                         \
  94         ((vm_pindex_t)1 << ((VM_RADIX_LIMIT - (lev)) * VM_RADIX_WIDTH))
  95
  96 struct vm_radix_node {
  97         void            *rn_child[VM_RADIX_COUNT];      /* Child nodes. */
  98         vm_pindex_t      rn_owner;                      /* Owner of record. */
  99         uint16_t         rn_count;                      /* Valid children. */
 100         uint16_t         rn_clev;                       /* Current level. */
 101 };
 102
 103 static uma_zone_t vm_radix_node_zone;
 104
 105 /*
 106  * Allocate a radix node.  Pre-allocation should ensure that the request
 107  * will always be satisfied.
 108  */
 109 static __inline struct vm_radix_node *
 110 vm_radix_node_get(vm_pindex_t owner, uint16_t count, uint16_t clevel)
 111 {
 112         struct vm_radix_node *rnode;
 113
 114         rnode = uma_zalloc(vm_radix_node_zone, M_NOWAIT);
 115
 116         /*
 117          * The required number of nodes should already be pre-allocated
 118          * by vm_radix_prealloc().  However, UMA can hold a few nodes
 119          * in per-CPU buckets, which will not be accessible by the
 120          * current CPU.  Thus, the allocation could return NULL when
 121          * the pre-allocated pool is close to exhaustion.  Anyway,
 122          * in practice this should never occur because a new node
 123          * is not always required for insert.  Thus, the pre-allocated
 124          * pool should have some extra pages that prevent this from
 125          * becoming a problem.
 126          */
 127         if (rnode == NULL)
 128                 panic("%s: uma_zalloc() returned NULL for a new node",
 129                     __func__);
 130         rnode->rn_owner = owner;
 131         rnode->rn_count = count;
 132         rnode->rn_clev = clevel;
 133         return (rnode);
 134 }
 135
 136 /*
 137  * Free radix node.
 138  */
 139 static __inline void
 140 vm_radix_node_put(struct vm_radix_node *rnode)
 141 {
 142
 143         uma_zfree(vm_radix_node_zone, rnode);
 144 }
 145
 146 /*
 147  * Return the position in the array for a given level.
 148  */
 149 static __inline int
 150 vm_radix_slot(vm_pindex_t index, uint16_t level)
 151 {
 152
 153         return ((index >> ((VM_RADIX_LIMIT - level) * VM_RADIX_WIDTH)) &
 154             VM_RADIX_MASK);
 155 }
 156
 157 /* Trims the key after the specified level. */
 158 static __inline vm_pindex_t
 159 vm_radix_trimkey(vm_pindex_t index, uint16_t level)
 160 {
 161         vm_pindex_t ret;
 162
 163         ret = index;
 164         if (level < VM_RADIX_LIMIT) {
 165                 ret >>= (VM_RADIX_LIMIT - level) * VM_RADIX_WIDTH;
 166                 ret <<= (VM_RADIX_LIMIT - level) * VM_RADIX_WIDTH;
 167         }
 168         return (ret);
 169 }
 170
 171 /*
 172  * Get the root node for a radix tree.
 173  */
 174 static __inline struct vm_radix_node *
 175 vm_radix_getroot(struct vm_radix *rtree)
 176 {
 177
 178         return ((struct vm_radix_node *)(rtree->rt_root & ~VM_RADIX_FLAGS));
 179 }
 180
 181 /*
 182  * Set the root node for a radix tree.
 183  */
 184 static __inline void
 185 vm_radix_setroot(struct vm_radix *rtree, struct vm_radix_node *rnode)
 186 {
 187
 188         rtree->rt_root = (uintptr_t)rnode;
 189 }
 190
 191 /*
 192  * Returns TRUE if the specified radix node is a leaf and FALSE otherwise.
 193  */
 194 static __inline boolean_t
 195 vm_radix_isleaf(struct vm_radix_node *rnode)
 196 {
 197
 198         return (((uintptr_t)rnode & VM_RADIX_ISLEAF) != 0);
 199 }
 200
 201 /*
 202  * Returns the associated page extracted from rnode if available,
 203  * and NULL otherwise.
 204  */
 205 static __inline vm_page_t
 206 vm_radix_node_page(struct vm_radix_node *rnode)
 207 {
 208
 209         return ((((uintptr_t)rnode & VM_RADIX_ISLEAF) != 0) ?
 210             (vm_page_t)((uintptr_t)rnode & ~VM_RADIX_FLAGS) : NULL);
 211 }
 212
 213 /*
 214  * Adds the page as a child of the provided node.
 215  */
 216 static __inline void
 217 vm_radix_addpage(struct vm_radix_node *rnode, vm_pindex_t index, uint16_t clev,
 218     vm_page_t page)
 219 {
 220         int slot;
 221
 222         slot = vm_radix_slot(index, clev);
 223         rnode->rn_child[slot] = (void *)((uintptr_t)page | VM_RADIX_ISLEAF);
 224 }
 225
 226 /*
 227  * Returns the slot where two keys differ.
 228  * It cannot accept 2 equal keys.
 229  */
 230 static __inline uint16_t
 231 vm_radix_keydiff(vm_pindex_t index1, vm_pindex_t index2)
 232 {
 233         uint16_t clev;
 234
 235         KASSERT(index1 != index2, ("%s: passing the same key value %jx",
 236             __func__, (uintmax_t)index1));
 237
 238         index1 ^= index2;
 239         for (clev = 0; clev <= VM_RADIX_LIMIT ; clev++)
 240                 if (vm_radix_slot(index1, clev))
 241                         return (clev);
 242         panic("%s: cannot reach this point", __func__);
 243         return (0);
 244 }
 245
 246 /*
 247  * Returns TRUE if it can be determined that key does not belong to the
 248  * specified rnode.  Otherwise, returns FALSE.
 249  */
 250 static __inline boolean_t
 251 vm_radix_keybarr(struct vm_radix_node *rnode, vm_pindex_t idx)
 252 {
 253
 254         if (rnode->rn_clev > 0) {
 255                 idx = vm_radix_trimkey(idx, rnode->rn_clev - 1);
 256                 idx -= rnode->rn_owner;
 257                 if (idx != 0)
 258                         return (TRUE);
 259         }
 260         return (FALSE);
 261 }
 262
 263 /*
 264  * Adjusts the idx key to the first upper level available, based on a valid
 265  * initial level and map of available levels.
 266  * Returns a value bigger than 0 to signal that there are not valid levels
 267  * available.
 268  */
 269 static __inline int
 270 vm_radix_addlev(vm_pindex_t *idx, boolean_t *levels, uint16_t ilev)
 271 {
 272         vm_pindex_t wrapidx;
 273
 274         for (; levels[ilev] == FALSE ||
 275             vm_radix_slot(*idx, ilev) == (VM_RADIX_COUNT - 1); ilev--)
 276                 if (ilev == 0)
 277                         break;
 278         KASSERT(ilev > 0 || levels[0],
 279             ("%s: levels back-scanning problem", __func__));
 280         if (ilev == 0 && vm_radix_slot(*idx, ilev) == (VM_RADIX_COUNT - 1))
 281                 return (1);
 282         wrapidx = *idx;
 283         *idx = vm_radix_trimkey(*idx, ilev);
 284         *idx += VM_RADIX_UNITLEVEL(ilev);
 285         return (*idx < wrapidx);
 286 }
 287
 288 /*
 289  * Adjusts the idx key to the first lower level available, based on a valid
 290  * initial level and map of available levels.
 291  * Returns a value bigger than 0 to signal that there are not valid levels
 292  * available.
 293  */
 294 static __inline int
 295 vm_radix_declev(vm_pindex_t *idx, boolean_t *levels, uint16_t ilev)
 296 {
 297         vm_pindex_t wrapidx;
 298
 299         for (; levels[ilev] == FALSE ||
 300             vm_radix_slot(*idx, ilev) == 0; ilev--)
 301                 if (ilev == 0)
 302                         break;
 303         KASSERT(ilev > 0 || levels[0],
 304             ("%s: levels back-scanning problem", __func__));
 305         if (ilev == 0 && vm_radix_slot(*idx, ilev) == 0)
 306                 return (1);
 307         wrapidx = *idx;
 308         *idx = vm_radix_trimkey(*idx, ilev);
 309         *idx |= VM_RADIX_UNITLEVEL(ilev) - 1;
 310         *idx -= VM_RADIX_UNITLEVEL(ilev);
 311         return (*idx > wrapidx);
 312 }
 313
 314 /*
 315  * Internal helper for vm_radix_reclaim_allnodes().
 316  * This function is recursive.
 317  */
 318 static void
 319 vm_radix_reclaim_allnodes_int(struct vm_radix_node *rnode)
 320 {
 321         int slot;
 322
 323         KASSERT(rnode->rn_count <= VM_RADIX_COUNT,
 324             ("vm_radix_reclaim_allnodes_int: bad count in rnode %p", rnode));
 325         for (slot = 0; rnode->rn_count != 0; slot++) {
 326                 if (rnode->rn_child[slot] == NULL)
 327                         continue;
 328                 if (!vm_radix_isleaf(rnode->rn_child[slot]))
 329                         vm_radix_reclaim_allnodes_int(rnode->rn_child[slot]);
 330                 rnode->rn_child[slot] = NULL;
 331                 rnode->rn_count--;
 332         }
 333         vm_radix_node_put(rnode);
 334 }
 335
 336 #ifdef INVARIANTS
 337 /*
 338  * Radix node zone destructor.
 339  */
 340 static void
 341 vm_radix_node_zone_dtor(void *mem, int size __unused, void *arg __unused)
 342 {
 343         struct vm_radix_node *rnode;
 344         int slot;
 345
 346         rnode = mem;
 347         KASSERT(rnode->rn_count == 0,
 348             ("vm_radix_node_put: rnode %p has %d children", rnode,
 349             rnode->rn_count));
 350         for (slot = 0; slot < VM_RADIX_COUNT; slot++)
 351                 KASSERT(rnode->rn_child[slot] == NULL,
 352                     ("vm_radix_node_put: rnode %p has a child", rnode));
 353 }
 354 #endif
 355
 356 /*
 357  * Radix node zone initializer.
 358  */
 359 static int
 360 vm_radix_node_zone_init(void *mem, int size __unused, int flags __unused)
 361 {
 362         struct vm_radix_node *rnode;
 363
 364         rnode = mem;
 365         memset(rnode->rn_child, 0, sizeof(rnode->rn_child));
 366         return (0);
 367 }
 368
 369 /*
 370  * Pre-allocate intermediate nodes from the UMA slab zone.
 371  */
 372 static void
 373 vm_radix_prealloc(void *arg __unused)
 374 {
 375
 376         if (!uma_zone_reserve_kva(vm_radix_node_zone, cnt.v_page_count))
 377                 panic("%s: unable to create new zone", __func__);
 378         uma_prealloc(vm_radix_node_zone, cnt.v_page_count);
 379 }
 380 SYSINIT(vm_radix_prealloc, SI_SUB_KMEM, SI_ORDER_SECOND, vm_radix_prealloc,
 381     NULL);
 382
 383 /*
 384  * Initialize the UMA slab zone.
 385  * Until vm_radix_prealloc() is called, the zone will be served by the
 386  * UMA boot-time pre-allocated pool of pages.
 387  */
 388 void
 389 vm_radix_init(void)
 390 {
 391
 392         vm_radix_node_zone = uma_zcreate("RADIX NODE",
 393             sizeof(struct vm_radix_node), NULL,
 394 #ifdef INVARIANTS
 395             vm_radix_node_zone_dtor,
 396 #else
 397             NULL,
 398 #endif
 399             vm_radix_node_zone_init, NULL, VM_RADIX_PAD, UMA_ZONE_VM |
 400             UMA_ZONE_NOFREE);
 401 }
 402
 403 /*
 404  * Inserts the key-value pair into the trie.
 405  * Panics if the key already exists.
 406  */
 407 void
 408 vm_radix_insert(struct vm_radix *rtree, vm_page_t page)
 409 {
 410         vm_pindex_t index, newind;
 411         struct vm_radix_node *rnode, *tmp, *tmp2;
 412         vm_page_t m;
 413         int slot;
 414         uint16_t clev;
 415
 416         index = page->pindex;
 417
 418         /*
 419          * The owner of record for root is not really important because it
 420          * will never be used.
 421          */
 422         rnode = vm_radix_getroot(rtree);
 423         if (rnode == NULL) {
 424                 rnode = vm_radix_node_get(0, 1, 0);
 425                 vm_radix_setroot(rtree, rnode);
 426                 vm_radix_addpage(rnode, index, 0, page);
 427                 return;
 428         }
 429         do {
 430                 slot = vm_radix_slot(index, rnode->rn_clev);
 431                 m = vm_radix_node_page(rnode->rn_child[slot]);
 432                 if (m != NULL) {
 433                         if (m->pindex == index)
 434                                 panic("%s: key %jx is already present",
 435                                     __func__, (uintmax_t)index);
 436                         clev = vm_radix_keydiff(m->pindex, index);
 437                         tmp = vm_radix_node_get(vm_radix_trimkey(index,
 438                             clev - 1), 2, clev);
 439                         rnode->rn_child[slot] = tmp;
 440                         vm_radix_addpage(tmp, index, clev, page);
 441                         vm_radix_addpage(tmp, m->pindex, clev, m);
 442                         return;
 443                 }
 444                 if (rnode->rn_child[slot] == NULL) {
 445                         rnode->rn_count++;
 446                         vm_radix_addpage(rnode, index, rnode->rn_clev, page);
 447                         return;
 448                 }
 449                 rnode = rnode->rn_child[slot];
 450         } while (!vm_radix_keybarr(rnode, index));
 451
 452         /*
 453          * Scan the trie from the top and find the parent to insert
 454          * the new object.
 455          */
 456         newind = rnode->rn_owner;
 457         clev = vm_radix_keydiff(newind, index);
 458         slot = VM_RADIX_COUNT;
 459         for (rnode = vm_radix_getroot(rtree); ; rnode = tmp) {
 460                 KASSERT(rnode != NULL, ("%s: edge cannot be NULL in the scan",
 461                     __func__));
 462                 KASSERT(clev >= rnode->rn_clev,
 463                     ("%s: unexpected trie depth: clev: %d, rnode->rn_clev: %d",
 464                     __func__, clev, rnode->rn_clev));
 465                 slot = vm_radix_slot(index, rnode->rn_clev);
 466                 tmp = rnode->rn_child[slot];
 467                 KASSERT(tmp != NULL && !vm_radix_isleaf(tmp),
 468                     ("%s: unexpected lookup interruption", __func__));
 469                 if (tmp->rn_clev > clev)
 470                         break;
 471         }
 472         KASSERT(rnode != NULL && tmp != NULL && slot < VM_RADIX_COUNT,
 473             ("%s: invalid scan parameters rnode: %p, tmp: %p, slot: %d",
 474             __func__, (void *)rnode, (void *)tmp, slot));
 475
 476         /*
 477          * A new node is needed because the right insertion level is reached.
 478          * Setup the new intermediate node and add the 2 children: the
 479          * new object and the older edge.
 480          */
 481         tmp2 = vm_radix_node_get(vm_radix_trimkey(index, clev - 1), 2,
 482             clev);
 483         rnode->rn_child[slot] = tmp2;
 484         vm_radix_addpage(tmp2, index, clev, page);
 485         slot = vm_radix_slot(newind, clev);
 486         tmp2->rn_child[slot] = tmp;
 487 }
 488
 489 /*
 490  * Returns the value stored at the index.  If the index is not present,
 491  * NULL is returned.
 492  */
 493 vm_page_t
 494 vm_radix_lookup(struct vm_radix *rtree, vm_pindex_t index)
 495 {
 496         struct vm_radix_node *rnode;
 497         vm_page_t m;
 498         int slot;
 499
 500         rnode = vm_radix_getroot(rtree);
 501         while (rnode != NULL) {
 502                 if (vm_radix_keybarr(rnode, index))
 503                         return (NULL);
 504                 slot = vm_radix_slot(index, rnode->rn_clev);
 505                 rnode = rnode->rn_child[slot];
 506                 m = vm_radix_node_page(rnode);
 507                 if (m != NULL) {
 508                         if (m->pindex == index)
 509                                 return (m);
 510                         else
 511                                 return (NULL);
 512                 }
 513         }
 514         return (NULL);
 515 }
 516
 517 /*
 518  * Look up the nearest entry at a position bigger than or equal to index.
 519  */
 520 vm_page_t
 521 vm_radix_lookup_ge(struct vm_radix *rtree, vm_pindex_t index)
 522 {
 523         vm_pindex_t inc;
 524         vm_page_t m;
 525         struct vm_radix_node *rnode;
 526         int slot;
 527         uint16_t difflev;
 528         boolean_t maplevels[VM_RADIX_LIMIT + 1];
 529 #ifdef INVARIANTS
 530         int loops = 0;
 531 #endif
 532
 533 restart:
 534         KASSERT(++loops < 1000, ("%s: too many loops", __func__));
 535         for (difflev = 0; difflev < (VM_RADIX_LIMIT + 1); difflev++)
 536                 maplevels[difflev] = FALSE;
 537         rnode = vm_radix_getroot(rtree);
 538         while (rnode != NULL) {
 539                 maplevels[rnode->rn_clev] = TRUE;
 540
 541                 /*
 542                  * If the keys differ before the current bisection node
 543                  * the search key might rollback to the earliest
 544                  * available bisection node, or to the smaller value
 545                  * in the current domain (if the owner is bigger than the
 546                  * search key).
 547                  * The maplevels array records any node has been seen
 548                  * at a given level.  This aids the search for a valid
 549                  * bisection node.
 550                  */
 551                 if (vm_radix_keybarr(rnode, index)) {
 552                         difflev = vm_radix_keydiff(index, rnode->rn_owner);
 553                         if (index > rnode->rn_owner) {
 554                                 if (vm_radix_addlev(&index, maplevels,
 555                                     difflev) > 0)
 556                                         break;
 557                         } else
 558                                 index = vm_radix_trimkey(rnode->rn_owner,
 559                                     difflev);
 560                         goto restart;
 561                 }
 562                 slot = vm_radix_slot(index, rnode->rn_clev);
 563                 m = vm_radix_node_page(rnode->rn_child[slot]);
 564                 if (m != NULL && m->pindex >= index)
 565                         return (m);
 566                 if (rnode->rn_child[slot] != NULL && m == NULL) {
 567                         rnode = rnode->rn_child[slot];
 568                         continue;
 569                 }
 570
 571                 /*
 572                  * Look for an available edge or page within the current
 573                  * bisection node.
 574                  */
 575                 if (slot < (VM_RADIX_COUNT - 1)) {
 576                         inc = VM_RADIX_UNITLEVEL(rnode->rn_clev);
 577                         index = vm_radix_trimkey(index, rnode->rn_clev);
 578                         index += inc;
 579                         slot++;
 580                         for (;; index += inc, slot++) {
 581                                 m = vm_radix_node_page(rnode->rn_child[slot]);
 582                                 if (m != NULL && m->pindex >= index)
 583                                         return (m);
 584                                 if ((rnode->rn_child[slot] != NULL &&
 585                                     m == NULL) || slot == (VM_RADIX_COUNT - 1))
 586                                         break;
 587                         }
 588                 }
 589
 590                 /*
 591                  * If a valid page or edge bigger than the search slot is
 592                  * found in the traversal, skip to the next higher-level key.
 593                  */
 594                 if (slot == (VM_RADIX_COUNT - 1) &&
 595                     (rnode->rn_child[slot] == NULL || m != NULL)) {
 596                         if (rnode->rn_clev == 0  || vm_radix_addlev(&index,
 597                             maplevels, rnode->rn_clev - 1) > 0)
 598                                 break;
 599                         goto restart;
 600                 }
 601                 rnode = rnode->rn_child[slot];
 602         }
 603         return (NULL);
 604 }
 605
 606 /*
 607  * Look up the nearest entry at a position less than or equal to index.
 608  */
 609 vm_page_t
 610 vm_radix_lookup_le(struct vm_radix *rtree, vm_pindex_t index)
 611 {
 612         vm_pindex_t inc;
 613         vm_page_t m;
 614         struct vm_radix_node *rnode;
 615         int slot;
 616         uint16_t difflev;
 617         boolean_t maplevels[VM_RADIX_LIMIT + 1];
 618 #ifdef INVARIANTS
 619         int loops = 0;
 620 #endif
 621
 622 restart:
 623         KASSERT(++loops < 1000, ("%s: too many loops", __func__));
 624         for (difflev = 0; difflev < (VM_RADIX_LIMIT + 1); difflev++)
 625                 maplevels[difflev] = FALSE;
 626         rnode = vm_radix_getroot(rtree);
 627         while (rnode != NULL) {
 628                 maplevels[rnode->rn_clev] = TRUE;
 629
 630                 /*
 631                  * If the keys differ before the current bisection node
 632                  * the search key might rollback to the earliest
 633                  * available bisection node, or to the higher value
 634                  * in the current domain (if the owner is smaller than the
 635                  * search key).
 636                  * The maplevels array records any node has been seen
 637                  * at a given level.  This aids the search for a valid
 638                  * bisection node.
 639                  */
 640                 if (vm_radix_keybarr(rnode, index)) {
 641                         difflev = vm_radix_keydiff(index, rnode->rn_owner);
 642                         if (index > rnode->rn_owner) {
 643                                 index = vm_radix_trimkey(rnode->rn_owner,
 644                                     difflev);
 645                                 index |= VM_RADIX_UNITLEVEL(difflev) - 1;
 646                         } else if (vm_radix_declev(&index, maplevels,
 647                             difflev) > 0)
 648                                 break;
 649                         goto restart;
 650                 }
 651                 slot = vm_radix_slot(index, rnode->rn_clev);
 652                 m = vm_radix_node_page(rnode->rn_child[slot]);
 653                 if (m != NULL && m->pindex <= index)
 654                         return (m);
 655                 if (rnode->rn_child[slot] != NULL && m == NULL) {
 656                         rnode = rnode->rn_child[slot];
 657                         continue;
 658                 }
 659
 660                 /*
 661                  * Look for an available edge or page within the current
 662                  * bisection node.
 663                  */
 664                 if (slot > 0) {
 665                         inc = VM_RADIX_UNITLEVEL(rnode->rn_clev);
 666                         index = vm_radix_trimkey(index, rnode->rn_clev);
 667                         index |= inc - 1;
 668                         index -= inc;
 669                         slot--;
 670                         for (;; index -= inc, slot--) {
 671                                 m = vm_radix_node_page(rnode->rn_child[slot]);
 672                                 if (m != NULL && m->pindex <= index)
 673                                         return (m);
 674                                 if ((rnode->rn_child[slot] != NULL &&
 675                                     m == NULL) || slot == 0)
 676                                         break;
 677                         }
 678                 }
 679
 680                 /*
 681                  * If a valid page or edge smaller than the search slot is
 682                  * found in the traversal, skip to the next higher-level key.
 683                  */
 684                 if (slot == 0 && (rnode->rn_child[slot] == NULL || m != NULL)) {
 685                         if (rnode->rn_clev == 0 || vm_radix_declev(&index,
 686                             maplevels, rnode->rn_clev - 1) > 0)
 687                                 break;
 688                         goto restart;
 689                 }
 690                 rnode = rnode->rn_child[slot];
 691         }
 692         return (NULL);
 693 }
 694
 695 /*
 696  * Remove the specified index from the tree.
 697  * Panics if the key is not present.
 698  */
 699 void
 700 vm_radix_remove(struct vm_radix *rtree, vm_pindex_t index)
 701 {
 702         struct vm_radix_node *rnode, *parent;
 703         vm_page_t m;
 704         int i, slot;
 705
 706         parent = NULL;
 707         rnode = vm_radix_getroot(rtree);
 708         for (;;) {
 709                 if (rnode == NULL)
 710                         panic("vm_radix_remove: impossible to locate the key");
 711                 slot = vm_radix_slot(index, rnode->rn_clev);
 712                 m = vm_radix_node_page(rnode->rn_child[slot]);
 713                 if (m != NULL && m->pindex == index) {
 714                         rnode->rn_child[slot] = NULL;
 715                         rnode->rn_count--;
 716                         if (rnode->rn_count > 1)
 717                                 break;
 718                         if (parent == NULL) {
 719                                 if (rnode->rn_count == 0) {
 720                                         vm_radix_node_put(rnode);
 721                                         vm_radix_setroot(rtree, NULL);
 722                                 }
 723                                 break;
 724                         }
 725                         for (i = 0; i < VM_RADIX_COUNT; i++)
 726                                 if (rnode->rn_child[i] != NULL)
 727                                         break;
 728                         KASSERT(i != VM_RADIX_COUNT,
 729                             ("%s: invalid node configuration", __func__));
 730                         slot = vm_radix_slot(index, parent->rn_clev);
 731                         KASSERT(parent->rn_child[slot] == rnode,
 732                             ("%s: invalid child value", __func__));
 733                         parent->rn_child[slot] = rnode->rn_child[i];
 734                         rnode->rn_count--;
 735                         rnode->rn_child[i] = NULL;
 736                         vm_radix_node_put(rnode);
 737                         break;
 738                 }
 739                 if (m != NULL && m->pindex != index)
 740                         panic("%s: invalid key found", __func__);
 741                 parent = rnode;
 742                 rnode = rnode->rn_child[slot];
 743         }
 744 }
 745
 746 /*
 747  * Remove and free all the nodes from the radix tree.
 748  * This function is recursive but there is a tight control on it as the
 749  * maximum depth of the tree is fixed.
 750  */
 751 void
 752 vm_radix_reclaim_allnodes(struct vm_radix *rtree)
 753 {
 754         struct vm_radix_node *root;
 755
 756         root = vm_radix_getroot(rtree);
 757         if (root == NULL)
 758                 return;
 759         vm_radix_setroot(rtree, NULL);
 760         vm_radix_reclaim_allnodes_int(root);
 761 }
 762
 763 #ifdef DDB
 764 /*
 765  * Show details about the given radix node.
 766  */
 767 DB_SHOW_COMMAND(radixnode, db_show_radixnode)
 768 {
 769         struct vm_radix_node *rnode;
 770         int i;
 771
 772         if (!have_addr)
 773                 return;
 774         rnode = (struct vm_radix_node *)addr;
 775         db_printf("radixnode %p, owner %jx, children count %u, level %u:\n",
 776             (void *)rnode, (uintmax_t)rnode->rn_owner, rnode->rn_count,
 777             rnode->rn_clev);
 778         for (i = 0; i < VM_RADIX_COUNT; i++)
 779                 if (rnode->rn_child[i] != NULL)
 780                         db_printf("slot: %d, val: %p, page: %p, clev: %d\n",
 781                             i, (void *)rnode->rn_child[i],
 782                             (void *)vm_radix_node_page(rnode->rn_child[i]),
 783                             rnode->rn_clev);
 784 }
 785 #endif /* DDB */