sys/vm/vm_reserv.c

   1 /*-
   2  * Copyright (c) 2002-2006 Rice University
   3  * Copyright (c) 2007-2008 Alan L. Cox <alc@cs.rice.edu>
   4  * All rights reserved.
   5  *
   6  * This software was developed for the FreeBSD Project by Alan L. Cox,
   7  * Olivier Crameri, Peter Druschel, Sitaram Iyer, and Juan Navarro.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  25  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  28  * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  *      Superpage reservation management module
  34  *
  35  * Any external functions defined by this module are only to be used by the
  36  * virtual memory system.
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include "opt_vm.h"
  43
  44 #include <sys/param.h>
  45 #include <sys/kernel.h>
  46 #include <sys/lock.h>
  47 #include <sys/malloc.h>
  48 #include <sys/mutex.h>
  49 #include <sys/queue.h>
  50 #include <sys/sbuf.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/systm.h>
  53
  54 #include <vm/vm.h>
  55 #include <vm/vm_param.h>
  56 #include <vm/vm_object.h>
  57 #include <vm/vm_page.h>
  58 #include <vm/vm_phys.h>
  59 #include <vm/vm_radix.h>
  60 #include <vm/vm_reserv.h>
  61
  62 /*
  63  * The reservation system supports the speculative allocation of large physical
  64  * pages ("superpages").  Speculative allocation enables the fully-automatic
  65  * utilization of superpages by the virtual memory system.  In other words, no
  66  * programmatic directives are required to use superpages.
  67  */
  68
  69 #if VM_NRESERVLEVEL > 0
  70
  71 /*
  72  * The number of small pages that are contained in a level 0 reservation
  73  */
  74 #define VM_LEVEL_0_NPAGES       (1 << VM_LEVEL_0_ORDER)
  75
  76 /*
  77  * The number of bits by which a physical address is shifted to obtain the
  78  * reservation number
  79  */
  80 #define VM_LEVEL_0_SHIFT        (VM_LEVEL_0_ORDER + PAGE_SHIFT)
  81
  82 /*
  83  * The size of a level 0 reservation in bytes
  84  */
  85 #define VM_LEVEL_0_SIZE         (1 << VM_LEVEL_0_SHIFT)
  86
  87 /*
  88  * Computes the index of the small page underlying the given (object, pindex)
  89  * within the reservation's array of small pages.
  90  */
  91 #define VM_RESERV_INDEX(object, pindex) \
  92     (((object)->pg_color + (pindex)) & (VM_LEVEL_0_NPAGES - 1))
  93
  94 /*
  95  * The reservation structure
  96  *
  97  * A reservation structure is constructed whenever a large physical page is
  98  * speculatively allocated to an object.  The reservation provides the small
  99  * physical pages for the range [pindex, pindex + VM_LEVEL_0_NPAGES) of offsets
 100  * within that object.  The reservation's "popcnt" tracks the number of these
 101  * small physical pages that are in use at any given time.  When and if the
 102  * reservation is not fully utilized, it appears in the queue of partially-
 103  * populated reservations.  The reservation always appears on the containing
 104  * object's list of reservations.
 105  *
 106  * A partially-populated reservation can be broken and reclaimed at any time.
 107  */
 108 struct vm_reserv {
 109         TAILQ_ENTRY(vm_reserv) partpopq;
 110         LIST_ENTRY(vm_reserv) objq;
 111         vm_object_t     object;                 /* containing object */
 112         vm_pindex_t     pindex;                 /* offset within object */
 113         vm_page_t       pages;                  /* first page of a superpage */
 114         int             popcnt;                 /* # of pages in use */
 115         char            inpartpopq;
 116 };
 117
 118 /*
 119  * The reservation array
 120  *
 121  * This array is analoguous in function to vm_page_array.  It differs in the
 122  * respect that it may contain a greater number of useful reservation
 123  * structures than there are (physical) superpages.  These "invalid"
 124  * reservation structures exist to trade-off space for time in the
 125  * implementation of vm_reserv_from_page().  Invalid reservation structures are
 126  * distinguishable from "valid" reservation structures by inspecting the
 127  * reservation's "pages" field.  Invalid reservation structures have a NULL
 128  * "pages" field.
 129  *
 130  * vm_reserv_from_page() maps a small (physical) page to an element of this
 131  * array by computing a physical reservation number from the page's physical
 132  * address.  The physical reservation number is used as the array index.
 133  *
 134  * An "active" reservation is a valid reservation structure that has a non-NULL
 135  * "object" field and a non-zero "popcnt" field.  In other words, every active
 136  * reservation belongs to a particular object.  Moreover, every active
 137  * reservation has an entry in the containing object's list of reservations.
 138  */
 139 static vm_reserv_t vm_reserv_array;
 140
 141 /*
 142  * The partially-populated reservation queue
 143  *
 144  * This queue enables the fast recovery of an unused cached or free small page
 145  * from a partially-populated reservation.  The reservation at the head of
 146  * this queue is the least-recently-changed, partially-populated reservation.
 147  *
 148  * Access to this queue is synchronized by the free page queue lock.
 149  */
 150 static TAILQ_HEAD(, vm_reserv) vm_rvq_partpop =
 151                             TAILQ_HEAD_INITIALIZER(vm_rvq_partpop);
 152
 153 static SYSCTL_NODE(_vm, OID_AUTO, reserv, CTLFLAG_RD, 0, "Reservation Info");
 154
 155 static long vm_reserv_broken;
 156 SYSCTL_LONG(_vm_reserv, OID_AUTO, broken, CTLFLAG_RD,
 157     &vm_reserv_broken, 0, "Cumulative number of broken reservations");
 158
 159 static long vm_reserv_freed;
 160 SYSCTL_LONG(_vm_reserv, OID_AUTO, freed, CTLFLAG_RD,
 161     &vm_reserv_freed, 0, "Cumulative number of freed reservations");
 162
 163 static int sysctl_vm_reserv_partpopq(SYSCTL_HANDLER_ARGS);
 164
 165 SYSCTL_OID(_vm_reserv, OID_AUTO, partpopq, CTLTYPE_STRING | CTLFLAG_RD, NULL, 0,
 166     sysctl_vm_reserv_partpopq, "A", "Partially-populated reservation queues");
 167
 168 static long vm_reserv_reclaimed;
 169 SYSCTL_LONG(_vm_reserv, OID_AUTO, reclaimed, CTLFLAG_RD,
 170     &vm_reserv_reclaimed, 0, "Cumulative number of reclaimed reservations");
 171
 172 static void             vm_reserv_depopulate(vm_reserv_t rv);
 173 static vm_reserv_t      vm_reserv_from_page(vm_page_t m);
 174 static boolean_t        vm_reserv_has_pindex(vm_reserv_t rv,
 175                             vm_pindex_t pindex);
 176 static void             vm_reserv_populate(vm_reserv_t rv);
 177 static void             vm_reserv_reclaim(vm_reserv_t rv);
 178
 179 /*
 180  * Describes the current state of the partially-populated reservation queue.
 181  */
 182 static int
 183 sysctl_vm_reserv_partpopq(SYSCTL_HANDLER_ARGS)
 184 {
 185         struct sbuf sbuf;
 186         vm_reserv_t rv;
 187         int counter, error, level, unused_pages;
 188
 189         error = sysctl_wire_old_buffer(req, 0);
 190         if (error != 0)
 191                 return (error);
 192         sbuf_new_for_sysctl(&sbuf, NULL, 128, req);
 193         sbuf_printf(&sbuf, "\nLEVEL     SIZE  NUMBER\n\n");
 194         for (level = -1; level <= VM_NRESERVLEVEL - 2; level++) {
 195                 counter = 0;
 196                 unused_pages = 0;
 197                 mtx_lock(&vm_page_queue_free_mtx);
 198                 TAILQ_FOREACH(rv, &vm_rvq_partpop/*[level]*/, partpopq) {
 199                         counter++;
 200                         unused_pages += VM_LEVEL_0_NPAGES - rv->popcnt;
 201                 }
 202                 mtx_unlock(&vm_page_queue_free_mtx);
 203                 sbuf_printf(&sbuf, "%5d: %6dK, %6d\n", level,
 204                     unused_pages * ((int)PAGE_SIZE / 1024), counter);
 205         }
 206         error = sbuf_finish(&sbuf);
 207         sbuf_delete(&sbuf);
 208         return (error);
 209 }
 210
 211 /*
 212  * Reduces the given reservation's population count.  If the population count
 213  * becomes zero, the reservation is destroyed.  Additionally, moves the
 214  * reservation to the tail of the partially-populated reservations queue if the
 215  * population count is non-zero.
 216  *
 217  * The free page queue lock must be held.
 218  */
 219 static void
 220 vm_reserv_depopulate(vm_reserv_t rv)
 221 {
 222
 223         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 224         KASSERT(rv->object != NULL,
 225             ("vm_reserv_depopulate: reserv %p is free", rv));
 226         KASSERT(rv->popcnt > 0,
 227             ("vm_reserv_depopulate: reserv %p's popcnt is corrupted", rv));
 228         if (rv->inpartpopq) {
 229                 TAILQ_REMOVE(&vm_rvq_partpop, rv, partpopq);
 230                 rv->inpartpopq = FALSE;
 231         }
 232         rv->popcnt--;
 233         if (rv->popcnt == 0) {
 234                 LIST_REMOVE(rv, objq);
 235                 rv->object = NULL;
 236                 vm_phys_free_pages(rv->pages, VM_LEVEL_0_ORDER);
 237                 vm_reserv_freed++;
 238         } else {
 239                 rv->inpartpopq = TRUE;
 240                 TAILQ_INSERT_TAIL(&vm_rvq_partpop, rv, partpopq);
 241         }
 242 }
 243
 244 /*
 245  * Returns the reservation to which the given page might belong.
 246  */
 247 static __inline vm_reserv_t
 248 vm_reserv_from_page(vm_page_t m)
 249 {
 250
 251         return (&vm_reserv_array[VM_PAGE_TO_PHYS(m) >> VM_LEVEL_0_SHIFT]);
 252 }
 253
 254 /*
 255  * Returns TRUE if the given reservation contains the given page index and
 256  * FALSE otherwise.
 257  */
 258 static __inline boolean_t
 259 vm_reserv_has_pindex(vm_reserv_t rv, vm_pindex_t pindex)
 260 {
 261
 262         return (((pindex - rv->pindex) & ~(VM_LEVEL_0_NPAGES - 1)) == 0);
 263 }
 264
 265 /*
 266  * Increases the given reservation's population count.  Moves the reservation
 267  * to the tail of the partially-populated reservation queue.
 268  *
 269  * The free page queue must be locked.
 270  */
 271 static void
 272 vm_reserv_populate(vm_reserv_t rv)
 273 {
 274
 275         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 276         KASSERT(rv->object != NULL,
 277             ("vm_reserv_populate: reserv %p is free", rv));
 278         KASSERT(rv->popcnt < VM_LEVEL_0_NPAGES,
 279             ("vm_reserv_populate: reserv %p is already full", rv));
 280         if (rv->inpartpopq) {
 281                 TAILQ_REMOVE(&vm_rvq_partpop, rv, partpopq);
 282                 rv->inpartpopq = FALSE;
 283         }
 284         rv->popcnt++;
 285         if (rv->popcnt < VM_LEVEL_0_NPAGES) {
 286                 rv->inpartpopq = TRUE;
 287                 TAILQ_INSERT_TAIL(&vm_rvq_partpop, rv, partpopq);
 288         }
 289 }
 290
 291 /*
 292  * Allocates a contiguous set of physical pages of the given size "npages"
 293  * from an existing or newly-created reservation.  All of the physical pages
 294  * must be at or above the given physical address "low" and below the given
 295  * physical address "high".  The given value "alignment" determines the
 296  * alignment of the first physical page in the set.  If the given value
 297  * "boundary" is non-zero, then the set of physical pages cannot cross any
 298  * physical address boundary that is a multiple of that value.  Both
 299  * "alignment" and "boundary" must be a power of two.
 300  *
 301  * The object and free page queue must be locked.
 302  */
 303 vm_page_t
 304 vm_reserv_alloc_contig(vm_object_t object, vm_pindex_t pindex, u_long npages,
 305     vm_paddr_t low, vm_paddr_t high, u_long alignment, vm_paddr_t boundary)
 306 {
 307         vm_paddr_t pa, size;
 308         vm_page_t m, m_ret, mpred, msucc;
 309         vm_pindex_t first, leftcap, rightcap;
 310         vm_reserv_t rv;
 311         u_long allocpages, maxpages, minpages;
 312         int i, index, n;
 313
 314         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 315         VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
 316         KASSERT(npages != 0, ("vm_reserv_alloc_contig: npages is 0"));
 317
 318         /*
 319          * Is a reservation fundamentally impossible?
 320          */
 321         if (pindex < VM_RESERV_INDEX(object, pindex) ||
 322             pindex + npages > object->size)
 323                 return (NULL);
 324
 325         /*
 326          * All reservations of a particular size have the same alignment.
 327          * Assuming that the first page is allocated from a reservation, the
 328          * least significant bits of its physical address can be determined
 329          * from its offset from the beginning of the reservation and the size
 330          * of the reservation.
 331          *
 332          * Could the specified index within a reservation of the smallest
 333          * possible size satisfy the alignment and boundary requirements?
 334          */
 335         pa = VM_RESERV_INDEX(object, pindex) << PAGE_SHIFT;
 336         if ((pa & (alignment - 1)) != 0)
 337                 return (NULL);
 338         size = npages << PAGE_SHIFT;
 339         if (((pa ^ (pa + size - 1)) & ~(boundary - 1)) != 0)
 340                 return (NULL);
 341
 342         /*
 343          * Look for an existing reservation.
 344          */
 345         mpred = vm_radix_lookup_le(&object->rtree, pindex);
 346         if (mpred != NULL) {
 347                 KASSERT(mpred->pindex < pindex,
 348                     ("vm_reserv_alloc_contig: pindex already allocated"));
 349                 rv = vm_reserv_from_page(mpred);
 350                 if (rv->object == object && vm_reserv_has_pindex(rv, pindex))
 351                         goto found;
 352                 msucc = TAILQ_NEXT(mpred, listq);
 353         } else
 354                 msucc = vm_radix_lookup_ge(&object->rtree, pindex);
 355         if (msucc != NULL) {
 356                 KASSERT(msucc->pindex > pindex,
 357                     ("vm_reserv_alloc_page: pindex already allocated"));
 358                 rv = vm_reserv_from_page(msucc);
 359                 if (rv->object == object && vm_reserv_has_pindex(rv, pindex))
 360                         goto found;
 361         }
 362
 363         /*
 364          * Could at least one reservation fit between the first index to the
 365          * left that can be used and the first index to the right that cannot
 366          * be used?
 367          */
 368         first = pindex - VM_RESERV_INDEX(object, pindex);
 369         if (mpred != NULL) {
 370                 if ((rv = vm_reserv_from_page(mpred))->object != object)
 371                         leftcap = mpred->pindex + 1;
 372                 else
 373                         leftcap = rv->pindex + VM_LEVEL_0_NPAGES;
 374                 if (leftcap > first)
 375                         return (NULL);
 376         }
 377         minpages = VM_RESERV_INDEX(object, pindex) + npages;
 378         maxpages = roundup2(minpages, VM_LEVEL_0_NPAGES);
 379         allocpages = maxpages;
 380         if (msucc != NULL) {
 381                 if ((rv = vm_reserv_from_page(msucc))->object != object)
 382                         rightcap = msucc->pindex;
 383                 else
 384                         rightcap = rv->pindex;
 385                 if (first + maxpages > rightcap) {
 386                         if (maxpages == VM_LEVEL_0_NPAGES)
 387                                 return (NULL);
 388                         allocpages = minpages;
 389                 }
 390         }
 391
 392         /*
 393          * Would the last new reservation extend past the end of the object?
 394          */
 395         if (first + maxpages > object->size) {
 396                 /*
 397                  * Don't allocate the last new reservation if the object is a
 398                  * vnode or backed by another object that is a vnode.
 399                  */
 400                 if (object->type == OBJT_VNODE ||
 401                     (object->backing_object != NULL &&
 402                     object->backing_object->type == OBJT_VNODE)) {
 403                         if (maxpages == VM_LEVEL_0_NPAGES)
 404                                 return (NULL);
 405                         allocpages = minpages;
 406                 }
 407                 /* Speculate that the object may grow. */
 408         }
 409
 410         /*
 411          * Allocate and populate the new reservations.  The alignment and
 412          * boundary specified for this allocation may be different from the
 413          * alignment and boundary specified for the requested pages.  For
 414          * instance, the specified index may not be the first page within the
 415          * first new reservation.
 416          */
 417         m = vm_phys_alloc_contig(allocpages, low, high, ulmax(alignment,
 418             VM_LEVEL_0_SIZE), boundary > VM_LEVEL_0_SIZE ? boundary : 0);
 419         if (m == NULL)
 420                 return (NULL);
 421         m_ret = NULL;
 422         index = VM_RESERV_INDEX(object, pindex);
 423         do {
 424                 rv = vm_reserv_from_page(m);
 425                 KASSERT(rv->pages == m,
 426                     ("vm_reserv_alloc_contig: reserv %p's pages is corrupted",
 427                     rv));
 428                 KASSERT(rv->object == NULL,
 429                     ("vm_reserv_alloc_contig: reserv %p isn't free", rv));
 430                 LIST_INSERT_HEAD(&object->rvq, rv, objq);
 431                 rv->object = object;
 432                 rv->pindex = first;
 433                 KASSERT(rv->popcnt == 0,
 434                     ("vm_reserv_alloc_contig: reserv %p's popcnt is corrupted",
 435                     rv));
 436                 KASSERT(!rv->inpartpopq,
 437                     ("vm_reserv_alloc_contig: reserv %p's inpartpopq is TRUE",
 438                     rv));
 439                 n = ulmin(VM_LEVEL_0_NPAGES - index, npages);
 440                 for (i = 0; i < n; i++)
 441                         vm_reserv_populate(rv);
 442                 npages -= n;
 443                 if (m_ret == NULL) {
 444                         m_ret = &rv->pages[index];
 445                         index = 0;
 446                 }
 447                 m += VM_LEVEL_0_NPAGES;
 448                 first += VM_LEVEL_0_NPAGES;
 449                 allocpages -= VM_LEVEL_0_NPAGES;
 450         } while (allocpages > 0);
 451         return (m_ret);
 452
 453         /*
 454          * Found a matching reservation.
 455          */
 456 found:
 457         index = VM_RESERV_INDEX(object, pindex);
 458         /* Does the allocation fit within the reservation? */
 459         if (index + npages > VM_LEVEL_0_NPAGES)
 460                 return (NULL);
 461         m = &rv->pages[index];
 462         pa = VM_PAGE_TO_PHYS(m);
 463         if (pa < low || pa + size > high || (pa & (alignment - 1)) != 0 ||
 464             ((pa ^ (pa + size - 1)) & ~(boundary - 1)) != 0)
 465                 return (NULL);
 466         /* Handle vm_page_rename(m, new_object, ...). */
 467         for (i = 0; i < npages; i++)
 468                 if ((rv->pages[index + i].flags & (PG_CACHED | PG_FREE)) == 0)
 469                         return (NULL);
 470         for (i = 0; i < npages; i++)
 471                 vm_reserv_populate(rv);
 472         return (m);
 473 }
 474
 475 /*
 476  * Allocates a page from an existing or newly-created reservation.
 477  *
 478  * The object and free page queue must be locked.
 479  */
 480 vm_page_t
 481 vm_reserv_alloc_page(vm_object_t object, vm_pindex_t pindex)
 482 {
 483         vm_page_t m, mpred, msucc;
 484         vm_pindex_t first, leftcap, rightcap;
 485         vm_reserv_t rv;
 486
 487         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 488         VM_OBJECT_LOCK_ASSERT(object, MA_OWNED);
 489
 490         /*
 491          * Is a reservation fundamentally impossible?
 492          */
 493         if (pindex < VM_RESERV_INDEX(object, pindex) ||
 494             pindex >= object->size)
 495                 return (NULL);
 496
 497         /*
 498          * Look for an existing reservation.
 499          */
 500         mpred = vm_radix_lookup_le(&object->rtree, pindex);
 501         if (mpred != NULL) {
 502                 KASSERT(mpred->pindex < pindex,
 503                     ("vm_reserv_alloc_page: pindex already allocated"));
 504                 rv = vm_reserv_from_page(mpred);
 505                 if (rv->object == object && vm_reserv_has_pindex(rv, pindex))
 506                         goto found;
 507                 msucc = TAILQ_NEXT(mpred, listq);
 508         } else
 509                 msucc = vm_radix_lookup_ge(&object->rtree, pindex);
 510         if (msucc != NULL) {
 511                 KASSERT(msucc->pindex > pindex,
 512                     ("vm_reserv_alloc_page: pindex already allocated"));
 513                 rv = vm_reserv_from_page(msucc);
 514                 if (rv->object == object && vm_reserv_has_pindex(rv, pindex))
 515                         goto found;
 516         }
 517
 518         /*
 519          * Could a reservation fit between the first index to the left that
 520          * can be used and the first index to the right that cannot be used?
 521          */
 522         first = pindex - VM_RESERV_INDEX(object, pindex);
 523         if (mpred != NULL) {
 524                 if ((rv = vm_reserv_from_page(mpred))->object != object)
 525                         leftcap = mpred->pindex + 1;
 526                 else
 527                         leftcap = rv->pindex + VM_LEVEL_0_NPAGES;
 528                 if (leftcap > first)
 529                         return (NULL);
 530         }
 531         if (msucc != NULL) {
 532                 if ((rv = vm_reserv_from_page(msucc))->object != object)
 533                         rightcap = msucc->pindex;
 534                 else
 535                         rightcap = rv->pindex;
 536                 if (first + VM_LEVEL_0_NPAGES > rightcap)
 537                         return (NULL);
 538         }
 539
 540         /*
 541          * Would a new reservation extend past the end of the object?
 542          */
 543         if (first + VM_LEVEL_0_NPAGES > object->size) {
 544                 /*
 545                  * Don't allocate a new reservation if the object is a vnode or
 546                  * backed by another object that is a vnode.
 547                  */
 548                 if (object->type == OBJT_VNODE ||
 549                     (object->backing_object != NULL &&
 550                     object->backing_object->type == OBJT_VNODE))
 551                         return (NULL);
 552                 /* Speculate that the object may grow. */
 553         }
 554
 555         /*
 556          * Allocate and populate the new reservation.
 557          */
 558         m = vm_phys_alloc_pages(VM_FREEPOOL_DEFAULT, VM_LEVEL_0_ORDER);
 559         if (m == NULL)
 560                 return (NULL);
 561         rv = vm_reserv_from_page(m);
 562         KASSERT(rv->pages == m,
 563             ("vm_reserv_alloc_page: reserv %p's pages is corrupted", rv));
 564         KASSERT(rv->object == NULL,
 565             ("vm_reserv_alloc_page: reserv %p isn't free", rv));
 566         LIST_INSERT_HEAD(&object->rvq, rv, objq);
 567         rv->object = object;
 568         rv->pindex = first;
 569         KASSERT(rv->popcnt == 0,
 570             ("vm_reserv_alloc_page: reserv %p's popcnt is corrupted", rv));
 571         KASSERT(!rv->inpartpopq,
 572             ("vm_reserv_alloc_page: reserv %p's inpartpopq is TRUE", rv));
 573         vm_reserv_populate(rv);
 574         return (&rv->pages[VM_RESERV_INDEX(object, pindex)]);
 575
 576         /*
 577          * Found a matching reservation.
 578          */
 579 found:
 580         m = &rv->pages[VM_RESERV_INDEX(object, pindex)];
 581         /* Handle vm_page_rename(m, new_object, ...). */
 582         if ((m->flags & (PG_CACHED | PG_FREE)) == 0)
 583                 return (NULL);
 584         vm_reserv_populate(rv);
 585         return (m);
 586 }
 587
 588 /*
 589  * Breaks all reservations belonging to the given object.
 590  */
 591 void
 592 vm_reserv_break_all(vm_object_t object)
 593 {
 594         vm_reserv_t rv;
 595         int i;
 596
 597         mtx_lock(&vm_page_queue_free_mtx);
 598         while ((rv = LIST_FIRST(&object->rvq)) != NULL) {
 599                 KASSERT(rv->object == object,
 600                     ("vm_reserv_break_all: reserv %p is corrupted", rv));
 601                 if (rv->inpartpopq) {
 602                         TAILQ_REMOVE(&vm_rvq_partpop, rv, partpopq);
 603                         rv->inpartpopq = FALSE;
 604                 }
 605                 LIST_REMOVE(rv, objq);
 606                 rv->object = NULL;
 607                 for (i = 0; i < VM_LEVEL_0_NPAGES; i++) {
 608                         if ((rv->pages[i].flags & (PG_CACHED | PG_FREE)) != 0)
 609                                 vm_phys_free_pages(&rv->pages[i], 0);
 610                         else
 611                                 rv->popcnt--;
 612                 }
 613                 KASSERT(rv->popcnt == 0,
 614                     ("vm_reserv_break_all: reserv %p's popcnt is corrupted",
 615                     rv));
 616                 vm_reserv_broken++;
 617         }
 618         mtx_unlock(&vm_page_queue_free_mtx);
 619 }
 620
 621 /*
 622  * Frees the given page if it belongs to a reservation.  Returns TRUE if the
 623  * page is freed and FALSE otherwise.
 624  *
 625  * The free page queue lock must be held.
 626  */
 627 boolean_t
 628 vm_reserv_free_page(vm_page_t m)
 629 {
 630         vm_reserv_t rv;
 631
 632         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 633         rv = vm_reserv_from_page(m);
 634         if (rv->object == NULL)
 635                 return (FALSE);
 636         if ((m->flags & PG_CACHED) != 0 && m->pool != VM_FREEPOOL_CACHE)
 637                 vm_phys_set_pool(VM_FREEPOOL_CACHE, rv->pages,
 638                     VM_LEVEL_0_ORDER);
 639         vm_reserv_depopulate(rv);
 640         return (TRUE);
 641 }
 642
 643 /*
 644  * Initializes the reservation management system.  Specifically, initializes
 645  * the reservation array.
 646  *
 647  * Requires that vm_page_array and first_page are initialized!
 648  */
 649 void
 650 vm_reserv_init(void)
 651 {
 652         vm_paddr_t paddr;
 653         int i;
 654
 655         /*
 656          * Initialize the reservation array.  Specifically, initialize the
 657          * "pages" field for every element that has an underlying superpage.
 658          */
 659         for (i = 0; phys_avail[i + 1] != 0; i += 2) {
 660                 paddr = roundup2(phys_avail[i], VM_LEVEL_0_SIZE);
 661                 while (paddr + VM_LEVEL_0_SIZE <= phys_avail[i + 1]) {
 662                         vm_reserv_array[paddr >> VM_LEVEL_0_SHIFT].pages =
 663                             PHYS_TO_VM_PAGE(paddr);
 664                         paddr += VM_LEVEL_0_SIZE;
 665                 }
 666         }
 667 }
 668
 669 /*
 670  * Returns a reservation level if the given page belongs to a fully-populated
 671  * reservation and -1 otherwise.
 672  */
 673 int
 674 vm_reserv_level_iffullpop(vm_page_t m)
 675 {
 676         vm_reserv_t rv;
 677
 678         rv = vm_reserv_from_page(m);
 679         return (rv->popcnt == VM_LEVEL_0_NPAGES ? 0 : -1);
 680 }
 681
 682 /*
 683  * Prepare for the reactivation of a cached page.
 684  *
 685  * First, suppose that the given page "m" was allocated individually, i.e., not
 686  * as part of a reservation, and cached.  Then, suppose a reservation
 687  * containing "m" is allocated by the same object.  Although "m" and the
 688  * reservation belong to the same object, "m"'s pindex may not match the
 689  * reservation's.
 690  *
 691  * The free page queue must be locked.
 692  */
 693 boolean_t
 694 vm_reserv_reactivate_page(vm_page_t m)
 695 {
 696         vm_reserv_t rv;
 697         int i, m_index;
 698
 699         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 700         rv = vm_reserv_from_page(m);
 701         if (rv->object == NULL)
 702                 return (FALSE);
 703         KASSERT((m->flags & PG_CACHED) != 0,
 704             ("vm_reserv_uncache_page: page %p is not cached", m));
 705         if (m->object == rv->object &&
 706             m->pindex - rv->pindex == VM_RESERV_INDEX(m->object, m->pindex))
 707                 vm_reserv_populate(rv);
 708         else {
 709                 KASSERT(rv->inpartpopq,
 710                     ("vm_reserv_uncache_page: reserv %p's inpartpopq is FALSE",
 711                     rv));
 712                 TAILQ_REMOVE(&vm_rvq_partpop, rv, partpopq);
 713                 rv->inpartpopq = FALSE;
 714                 LIST_REMOVE(rv, objq);
 715                 rv->object = NULL;
 716                 /* Don't vm_phys_free_pages(m, 0). */
 717                 m_index = m - rv->pages;
 718                 for (i = 0; i < m_index; i++) {
 719                         if ((rv->pages[i].flags & (PG_CACHED | PG_FREE)) != 0)
 720                                 vm_phys_free_pages(&rv->pages[i], 0);
 721                         else
 722                                 rv->popcnt--;
 723                 }
 724                 for (i++; i < VM_LEVEL_0_NPAGES; i++) {
 725                         if ((rv->pages[i].flags & (PG_CACHED | PG_FREE)) != 0)
 726                                 vm_phys_free_pages(&rv->pages[i], 0);
 727                         else
 728                                 rv->popcnt--;
 729                 }
 730                 KASSERT(rv->popcnt == 0,
 731                     ("vm_reserv_uncache_page: reserv %p's popcnt is corrupted",
 732                     rv));
 733                 vm_reserv_broken++;
 734         }
 735         return (TRUE);
 736 }
 737
 738 /*
 739  * Breaks the given partially-populated reservation, releasing its cached and
 740  * free pages to the physical memory allocator.
 741  *
 742  * The free page queue lock must be held.
 743  */
 744 static void
 745 vm_reserv_reclaim(vm_reserv_t rv)
 746 {
 747         int i;
 748
 749         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 750         KASSERT(rv->inpartpopq,
 751             ("vm_reserv_reclaim: reserv %p's inpartpopq is corrupted", rv));
 752         TAILQ_REMOVE(&vm_rvq_partpop, rv, partpopq);
 753         rv->inpartpopq = FALSE;
 754         KASSERT(rv->object != NULL,
 755             ("vm_reserv_reclaim: reserv %p is free", rv));
 756         LIST_REMOVE(rv, objq);
 757         rv->object = NULL;
 758         for (i = 0; i < VM_LEVEL_0_NPAGES; i++) {
 759                 if ((rv->pages[i].flags & (PG_CACHED | PG_FREE)) != 0)
 760                         vm_phys_free_pages(&rv->pages[i], 0);
 761                 else
 762                         rv->popcnt--;
 763         }
 764         KASSERT(rv->popcnt == 0,
 765             ("vm_reserv_reclaim: reserv %p's popcnt is corrupted", rv));
 766         vm_reserv_reclaimed++;
 767 }
 768
 769 /*
 770  * Breaks the reservation at the head of the partially-populated reservation
 771  * queue, releasing its cached and free pages to the physical memory
 772  * allocator.  Returns TRUE if a reservation is broken and FALSE otherwise.
 773  *
 774  * The free page queue lock must be held.
 775  */
 776 boolean_t
 777 vm_reserv_reclaim_inactive(void)
 778 {
 779         vm_reserv_t rv;
 780
 781         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 782         if ((rv = TAILQ_FIRST(&vm_rvq_partpop)) != NULL) {
 783                 vm_reserv_reclaim(rv);
 784                 return (TRUE);
 785         }
 786         return (FALSE);
 787 }
 788
 789 /*
 790  * Searches the partially-populated reservation queue for the least recently
 791  * active reservation with unused pages, i.e., cached or free, that satisfy the
 792  * given request for contiguous physical memory.  If a satisfactory reservation
 793  * is found, it is broken.  Returns TRUE if a reservation is broken and FALSE
 794  * otherwise.
 795  *
 796  * The free page queue lock must be held.
 797  */
 798 boolean_t
 799 vm_reserv_reclaim_contig(u_long npages, vm_paddr_t low, vm_paddr_t high,
 800     u_long alignment, vm_paddr_t boundary)
 801 {
 802         vm_paddr_t pa, pa_length, size;
 803         vm_reserv_t rv;
 804         int i;
 805
 806         mtx_assert(&vm_page_queue_free_mtx, MA_OWNED);
 807         if (npages > VM_LEVEL_0_NPAGES - 1)
 808                 return (FALSE);
 809         size = npages << PAGE_SHIFT;
 810         TAILQ_FOREACH(rv, &vm_rvq_partpop, partpopq) {
 811                 pa = VM_PAGE_TO_PHYS(&rv->pages[VM_LEVEL_0_NPAGES - 1]);
 812                 if (pa + PAGE_SIZE - size < low) {
 813                         /* this entire reservation is too low; go to next */
 814                         continue;
 815                 }
 816                 pa_length = 0;
 817                 for (i = 0; i < VM_LEVEL_0_NPAGES; i++)
 818                         if ((rv->pages[i].flags & (PG_CACHED | PG_FREE)) != 0) {
 819                                 pa_length += PAGE_SIZE;
 820                                 if (pa_length == PAGE_SIZE) {
 821                                         pa = VM_PAGE_TO_PHYS(&rv->pages[i]);
 822                                         if (pa + size > high) {
 823                                                 /* skip to next reservation */
 824                                                 break;
 825                                         } else if (pa < low ||
 826                                             (pa & (alignment - 1)) != 0 ||
 827                                             ((pa ^ (pa + size - 1)) &
 828                                             ~(boundary - 1)) != 0)
 829                                                 pa_length = 0;
 830                                 }
 831                                 if (pa_length >= size) {
 832                                         vm_reserv_reclaim(rv);
 833                                         return (TRUE);
 834                                 }
 835                         } else
 836                                 pa_length = 0;
 837         }
 838         return (FALSE);
 839 }
 840
 841 /*
 842  * Transfers the reservation underlying the given page to a new object.
 843  *
 844  * The object must be locked.
 845  */
 846 void
 847 vm_reserv_rename(vm_page_t m, vm_object_t new_object, vm_object_t old_object,
 848     vm_pindex_t old_object_offset)
 849 {
 850         vm_reserv_t rv;
 851
 852         VM_OBJECT_LOCK_ASSERT(new_object, MA_OWNED);
 853         rv = vm_reserv_from_page(m);
 854         if (rv->object == old_object) {
 855                 mtx_lock(&vm_page_queue_free_mtx);
 856                 if (rv->object == old_object) {
 857                         LIST_REMOVE(rv, objq);
 858                         LIST_INSERT_HEAD(&new_object->rvq, rv, objq);
 859                         rv->object = new_object;
 860                         rv->pindex -= old_object_offset;
 861                 }
 862                 mtx_unlock(&vm_page_queue_free_mtx);
 863         }
 864 }
 865
 866 /*
 867  * Allocates the virtual and physical memory required by the reservation
 868  * management system's data structures, in particular, the reservation array.
 869  */
 870 vm_paddr_t
 871 vm_reserv_startup(vm_offset_t *vaddr, vm_paddr_t end, vm_paddr_t high_water)
 872 {
 873         vm_paddr_t new_end;
 874         size_t size;
 875
 876         /*
 877          * Calculate the size (in bytes) of the reservation array.  Round up
 878          * from "high_water" because every small page is mapped to an element
 879          * in the reservation array based on its physical address.  Thus, the
 880          * number of elements in the reservation array can be greater than the
 881          * number of superpages.
 882          */
 883         size = howmany(high_water, VM_LEVEL_0_SIZE) * sizeof(struct vm_reserv);
 884
 885         /*
 886          * Allocate and map the physical memory for the reservation array.  The
 887          * next available virtual address is returned by reference.
 888          */
 889         new_end = end - round_page(size);
 890         vm_reserv_array = (void *)(uintptr_t)pmap_map(vaddr, new_end, end,
 891             VM_PROT_READ | VM_PROT_WRITE);
 892         bzero(vm_reserv_array, size);
 893
 894         /*
 895          * Return the next available physical address.
 896          */
 897         return (new_end);
 898 }
 899
 900 #endif  /* VM_NRESERVLEVEL > 0 */