sys/vm/vm_page.h

   1 /*-
   2  * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
   3  *
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * The Mach Operating System project at Carnegie-Mellon University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      from: @(#)vm_page.h     8.2 (Berkeley) 12/13/93
  35  *
  36  *
  37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  38  * All rights reserved.
  39  *
  40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  41  *
  42  * Permission to use, copy, modify and distribute this software and
  43  * its documentation is hereby granted, provided that both the copyright
  44  * notice and this permission notice appear in all copies of the
  45  * software, derivative works or modified versions, and any portions
  46  * thereof, and that both notices appear in supporting documentation.
  47  *
  48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  51  *
  52  * Carnegie Mellon requests users of this software to return to
  53  *
  54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  55  *  School of Computer Science
  56  *  Carnegie Mellon University
  57  *  Pittsburgh PA 15213-3890
  58  *
  59  * any improvements or extensions that they make and grant Carnegie the
  60  * rights to redistribute these changes.
  61  *
  62  * $FreeBSD$
  63  */
  64
  65 /*
  66  *      Resident memory system definitions.
  67  */
  68
  69 #ifndef _VM_PAGE_
  70 #define _VM_PAGE_
  71
  72 #include <vm/pmap.h>
  73
  74 /*
  75  *      Management of resident (logical) pages.
  76  *
  77  *      A small structure is kept for each resident
  78  *      page, indexed by page number.  Each structure
  79  *      is an element of several collections:
  80  *
  81  *              A radix tree used to quickly
  82  *              perform object/offset lookups
  83  *
  84  *              A list of all pages for a given object,
  85  *              so they can be quickly deactivated at
  86  *              time of deallocation.
  87  *
  88  *              An ordered list of pages due for pageout.
  89  *
  90  *      In addition, the structure contains the object
  91  *      and offset to which this page belongs (for pageout),
  92  *      and sundry status bits.
  93  *
  94  *      In general, operations on this structure's mutable fields are
  95  *      synchronized using either one of or a combination of the lock on the
  96  *      object that the page belongs to (O), the pool lock for the page (P),
  97  *      or the lock for either the free or paging queue (Q).  If a field is
  98  *      annotated below with two of these locks, then holding either lock is
  99  *      sufficient for read access, but both locks are required for write
 100  *      access.
 101  *
 102  *      In contrast, the synchronization of accesses to the page's
 103  *      dirty field is machine dependent (M).  In the
 104  *      machine-independent layer, the lock on the object that the
 105  *      page belongs to must be held in order to operate on the field.
 106  *      However, the pmap layer is permitted to set all bits within
 107  *      the field without holding that lock.  If the underlying
 108  *      architecture does not support atomic read-modify-write
 109  *      operations on the field's type, then the machine-independent
 110  *      layer uses a 32-bit atomic on the aligned 32-bit word that
 111  *      contains the dirty field.  In the machine-independent layer,
 112  *      the implementation of read-modify-write operations on the
 113  *      field is encapsulated in vm_page_clear_dirty_mask().
 114  */
 115
 116 #if PAGE_SIZE == 4096
 117 #define VM_PAGE_BITS_ALL 0xffu
 118 typedef uint8_t vm_page_bits_t;
 119 #elif PAGE_SIZE == 8192
 120 #define VM_PAGE_BITS_ALL 0xffffu
 121 typedef uint16_t vm_page_bits_t;
 122 #elif PAGE_SIZE == 16384
 123 #define VM_PAGE_BITS_ALL 0xffffffffu
 124 typedef uint32_t vm_page_bits_t;
 125 #elif PAGE_SIZE == 32768
 126 #define VM_PAGE_BITS_ALL 0xfffffffffffffffflu
 127 typedef uint64_t vm_page_bits_t;
 128 #endif
 129
 130 struct vm_page {
 131         union {
 132                 TAILQ_ENTRY(vm_page) q; /* page queue or free list (Q) */
 133                 struct {
 134                         SLIST_ENTRY(vm_page) ss; /* private slists */
 135                         void *pv;
 136                 } s;
 137                 struct {
 138                         u_long p;
 139                         u_long v;
 140                 } memguard;
 141         } plinks;
 142         TAILQ_ENTRY(vm_page) listq;     /* pages in same object (O) */
 143         vm_object_t object;             /* which object am I in (O,P) */
 144         vm_pindex_t pindex;             /* offset into object (O,P) */
 145         vm_paddr_t phys_addr;           /* physical address of page */
 146         struct md_page md;              /* machine dependent stuff */
 147         u_int wire_count;               /* wired down maps refs (P) */
 148         volatile u_int busy_lock;       /* busy owners lock */
 149         uint16_t hold_count;            /* page hold count (P) */
 150         uint16_t flags;                 /* page PG_* flags (P) */
 151         uint8_t aflags;                 /* access is atomic */
 152         uint8_t oflags;                 /* page VPO_* flags (O) */
 153         uint8_t queue;                  /* page queue index (P,Q) */
 154         int8_t psind;                   /* pagesizes[] index (O) */
 155         int8_t segind;
 156         uint8_t order;                  /* index of the buddy queue */
 157         uint8_t pool;
 158         u_char  act_count;              /* page usage count (P) */
 159         /* NOTE that these must support one bit per DEV_BSIZE in a page */
 160         /* so, on normal X86 kernels, they must be at least 8 bits wide */
 161         vm_page_bits_t valid;           /* map of valid DEV_BSIZE chunks (O) */
 162         vm_page_bits_t dirty;           /* map of dirty DEV_BSIZE chunks (M) */
 163 };
 164
 165 /*
 166  * Page flags stored in oflags:
 167  *
 168  * Access to these page flags is synchronized by the lock on the object
 169  * containing the page (O).
 170  *
 171  * Note: VPO_UNMANAGED (used by OBJT_DEVICE, OBJT_PHYS and OBJT_SG)
 172  *       indicates that the page is not under PV management but
 173  *       otherwise should be treated as a normal page.  Pages not
 174  *       under PV management cannot be paged out via the
 175  *       object/vm_page_t because there is no knowledge of their pte
 176  *       mappings, and such pages are also not on any PQ queue.
 177  *
 178  */
 179 #define VPO_UNUSED01    0x01            /* --available-- */
 180 #define VPO_SWAPSLEEP   0x02            /* waiting for swap to finish */
 181 #define VPO_UNMANAGED   0x04            /* no PV management for page */
 182 #define VPO_SWAPINPROG  0x08            /* swap I/O in progress on page */
 183 #define VPO_NOSYNC      0x10            /* do not collect for syncer */
 184
 185 /*
 186  * Busy page implementation details.
 187  * The algorithm is taken mostly by rwlock(9) and sx(9) locks implementation,
 188  * even if the support for owner identity is removed because of size
 189  * constraints.  Checks on lock recursion are then not possible, while the
 190  * lock assertions effectiveness is someway reduced.
 191  */
 192 #define VPB_BIT_SHARED          0x01
 193 #define VPB_BIT_EXCLUSIVE       0x02
 194 #define VPB_BIT_WAITERS         0x04
 195 #define VPB_BIT_FLAGMASK                                                \
 196         (VPB_BIT_SHARED | VPB_BIT_EXCLUSIVE | VPB_BIT_WAITERS)
 197
 198 #define VPB_SHARERS_SHIFT       3
 199 #define VPB_SHARERS(x)                                                  \
 200         (((x) & ~VPB_BIT_FLAGMASK) >> VPB_SHARERS_SHIFT)
 201 #define VPB_SHARERS_WORD(x)     ((x) << VPB_SHARERS_SHIFT | VPB_BIT_SHARED)
 202 #define VPB_ONE_SHARER          (1 << VPB_SHARERS_SHIFT)
 203
 204 #define VPB_SINGLE_EXCLUSIVER   VPB_BIT_EXCLUSIVE
 205
 206 #define VPB_UNBUSIED            VPB_SHARERS_WORD(0)
 207
 208 #define PQ_NONE         255
 209 #define PQ_INACTIVE     0
 210 #define PQ_ACTIVE       1
 211 #define PQ_LAUNDRY      2
 212 #define PQ_UNSWAPPABLE  3
 213 #define PQ_COUNT        4
 214
 215 #ifndef VM_PAGE_HAVE_PGLIST
 216 TAILQ_HEAD(pglist, vm_page);
 217 #define VM_PAGE_HAVE_PGLIST
 218 #endif
 219 SLIST_HEAD(spglist, vm_page);
 220
 221 struct vm_pagequeue {
 222         struct mtx      pq_mutex;
 223         struct pglist   pq_pl;
 224         int             pq_cnt;
 225         u_int           * const pq_vcnt;
 226         const char      * const pq_name;
 227 } __aligned(CACHE_LINE_SIZE);
 228
 229
 230 struct vm_domain {
 231         struct vm_pagequeue vmd_pagequeues[PQ_COUNT];
 232         struct vmem *vmd_kernel_arena;
 233         u_int vmd_page_count;
 234         u_int vmd_free_count;
 235         long vmd_segs;  /* bitmask of the segments */
 236         boolean_t vmd_oom;
 237         int vmd_oom_seq;
 238         int vmd_last_active_scan;
 239         struct vm_page vmd_laundry_marker;
 240         struct vm_page vmd_marker; /* marker for pagedaemon private use */
 241         struct vm_page vmd_inacthead; /* marker for LRU-defeating insertions */
 242 };
 243
 244 extern struct vm_domain vm_dom[MAXMEMDOM];
 245
 246 #define vm_pagequeue_assert_locked(pq)  mtx_assert(&(pq)->pq_mutex, MA_OWNED)
 247 #define vm_pagequeue_lock(pq)           mtx_lock(&(pq)->pq_mutex)
 248 #define vm_pagequeue_lockptr(pq)        (&(pq)->pq_mutex)
 249 #define vm_pagequeue_unlock(pq)         mtx_unlock(&(pq)->pq_mutex)
 250
 251 #ifdef _KERNEL
 252 extern vm_page_t bogus_page;
 253
 254 static __inline void
 255 vm_pagequeue_cnt_add(struct vm_pagequeue *pq, int addend)
 256 {
 257
 258 #ifdef notyet
 259         vm_pagequeue_assert_locked(pq);
 260 #endif
 261         pq->pq_cnt += addend;
 262         atomic_add_int(pq->pq_vcnt, addend);
 263 }
 264 #define vm_pagequeue_cnt_inc(pq)        vm_pagequeue_cnt_add((pq), 1)
 265 #define vm_pagequeue_cnt_dec(pq)        vm_pagequeue_cnt_add((pq), -1)
 266 #endif  /* _KERNEL */
 267
 268 extern struct mtx_padalign vm_page_queue_free_mtx;
 269 extern struct mtx_padalign pa_lock[];
 270
 271 #if defined(__arm__)
 272 #define PDRSHIFT        PDR_SHIFT
 273 #elif !defined(PDRSHIFT)
 274 #define PDRSHIFT        21
 275 #endif
 276
 277 #define pa_index(pa)    ((pa) >> PDRSHIFT)
 278 #define PA_LOCKPTR(pa)  ((struct mtx *)(&pa_lock[pa_index(pa) % PA_LOCK_COUNT]))
 279 #define PA_LOCKOBJPTR(pa)       ((struct lock_object *)PA_LOCKPTR((pa)))
 280 #define PA_LOCK(pa)     mtx_lock(PA_LOCKPTR(pa))
 281 #define PA_TRYLOCK(pa)  mtx_trylock(PA_LOCKPTR(pa))
 282 #define PA_UNLOCK(pa)   mtx_unlock(PA_LOCKPTR(pa))
 283 #define PA_UNLOCK_COND(pa)                      \
 284         do {                                    \
 285                 if ((pa) != 0) {                \
 286                         PA_UNLOCK((pa));        \
 287                         (pa) = 0;               \
 288                 }                               \
 289         } while (0)
 290
 291 #define PA_LOCK_ASSERT(pa, a)   mtx_assert(PA_LOCKPTR(pa), (a))
 292
 293 #ifdef KLD_MODULE
 294 #define vm_page_lock(m)         vm_page_lock_KBI((m), LOCK_FILE, LOCK_LINE)
 295 #define vm_page_unlock(m)       vm_page_unlock_KBI((m), LOCK_FILE, LOCK_LINE)
 296 #define vm_page_trylock(m)      vm_page_trylock_KBI((m), LOCK_FILE, LOCK_LINE)
 297 #else   /* !KLD_MODULE */
 298 #define vm_page_lockptr(m)      (PA_LOCKPTR(VM_PAGE_TO_PHYS((m))))
 299 #define vm_page_lock(m)         mtx_lock(vm_page_lockptr((m)))
 300 #define vm_page_unlock(m)       mtx_unlock(vm_page_lockptr((m)))
 301 #define vm_page_trylock(m)      mtx_trylock(vm_page_lockptr((m)))
 302 #endif
 303 #if defined(INVARIANTS)
 304 #define vm_page_assert_locked(m)                \
 305     vm_page_assert_locked_KBI((m), __FILE__, __LINE__)
 306 #define vm_page_lock_assert(m, a)               \
 307     vm_page_lock_assert_KBI((m), (a), __FILE__, __LINE__)
 308 #else
 309 #define vm_page_assert_locked(m)
 310 #define vm_page_lock_assert(m, a)
 311 #endif
 312
 313 /*
 314  * The vm_page's aflags are updated using atomic operations.  To set or clear
 315  * these flags, the functions vm_page_aflag_set() and vm_page_aflag_clear()
 316  * must be used.  Neither these flags nor these functions are part of the KBI.
 317  *
 318  * PGA_REFERENCED may be cleared only if the page is locked.  It is set by
 319  * both the MI and MD VM layers.  However, kernel loadable modules should not
 320  * directly set this flag.  They should call vm_page_reference() instead.
 321  *
 322  * PGA_WRITEABLE is set exclusively on managed pages by pmap_enter().
 323  * When it does so, the object must be locked, or the page must be
 324  * exclusive busied.  The MI VM layer must never access this flag
 325  * directly.  Instead, it should call pmap_page_is_write_mapped().
 326  *
 327  * PGA_EXECUTABLE may be set by pmap routines, and indicates that a page has
 328  * at least one executable mapping.  It is not consumed by the MI VM layer.
 329  */
 330 #define PGA_WRITEABLE   0x01            /* page may be mapped writeable */
 331 #define PGA_REFERENCED  0x02            /* page has been referenced */
 332 #define PGA_EXECUTABLE  0x04            /* page may be mapped executable */
 333
 334 /*
 335  * Page flags.  If changed at any other time than page allocation or
 336  * freeing, the modification must be protected by the vm_page lock.
 337  */
 338 #define PG_FICTITIOUS   0x0004          /* physical page doesn't exist */
 339 #define PG_ZERO         0x0008          /* page is zeroed */
 340 #define PG_MARKER       0x0010          /* special queue marker page */
 341 #define PG_NODUMP       0x0080          /* don't include this page in a dump */
 342 #define PG_UNHOLDFREE   0x0100          /* delayed free of a held page */
 343
 344 /*
 345  * Misc constants.
 346  */
 347 #define ACT_DECLINE             1
 348 #define ACT_ADVANCE             3
 349 #define ACT_INIT                5
 350 #define ACT_MAX                 64
 351
 352 #ifdef _KERNEL
 353
 354 #include <sys/systm.h>
 355
 356 #include <machine/atomic.h>
 357
 358 /*
 359  * Each pageable resident page falls into one of five lists:
 360  *
 361  *      free
 362  *              Available for allocation now.
 363  *
 364  *      inactive
 365  *              Low activity, candidates for reclamation.
 366  *              This list is approximately LRU ordered.
 367  *
 368  *      laundry
 369  *              This is the list of pages that should be
 370  *              paged out next.
 371  *
 372  *      unswappable
 373  *              Dirty anonymous pages that cannot be paged
 374  *              out because no swap device is configured.
 375  *
 376  *      active
 377  *              Pages that are "active", i.e., they have been
 378  *              recently referenced.
 379  *
 380  */
 381
 382 extern int vm_page_zero_count;
 383
 384 extern vm_page_t vm_page_array;         /* First resident page in table */
 385 extern long vm_page_array_size;         /* number of vm_page_t's */
 386 extern long first_page;                 /* first physical page number */
 387
 388 #define VM_PAGE_TO_PHYS(entry)  ((entry)->phys_addr)
 389
 390 /*
 391  * PHYS_TO_VM_PAGE() returns the vm_page_t object that represents a memory
 392  * page to which the given physical address belongs. The correct vm_page_t
 393  * object is returned for addresses that are not page-aligned.
 394  */
 395 vm_page_t PHYS_TO_VM_PAGE(vm_paddr_t pa);
 396
 397 /*
 398  * Page allocation parameters for vm_page for the functions
 399  * vm_page_alloc(), vm_page_grab(), vm_page_alloc_contig() and
 400  * vm_page_alloc_freelist().  Some functions support only a subset
 401  * of the flags, and ignore others, see the flags legend.
 402  *
 403  * The meaning of VM_ALLOC_ZERO differs slightly between the vm_page_alloc*()
 404  * and the vm_page_grab*() functions.  See these functions for details.
 405  *
 406  * Bits 0 - 1 define class.
 407  * Bits 2 - 15 dedicated for flags.
 408  * Legend:
 409  * (a) - vm_page_alloc() supports the flag.
 410  * (c) - vm_page_alloc_contig() supports the flag.
 411  * (f) - vm_page_alloc_freelist() supports the flag.
 412  * (g) - vm_page_grab() supports the flag.
 413  * (p) - vm_page_grab_pages() supports the flag.
 414  * Bits above 15 define the count of additional pages that the caller
 415  * intends to allocate.
 416  */
 417 #define VM_ALLOC_NORMAL         0
 418 #define VM_ALLOC_INTERRUPT      1
 419 #define VM_ALLOC_SYSTEM         2
 420 #define VM_ALLOC_CLASS_MASK     3
 421 #define VM_ALLOC_WAITOK         0x0008  /* (acf) Sleep and retry */
 422 #define VM_ALLOC_WAITFAIL       0x0010  /* (acf) Sleep and return error */
 423 #define VM_ALLOC_WIRED          0x0020  /* (acfgp) Allocate a wired page */
 424 #define VM_ALLOC_ZERO           0x0040  /* (acfgp) Allocate a prezeroed page */
 425 #define VM_ALLOC_NOOBJ          0x0100  /* (acg) No associated object */
 426 #define VM_ALLOC_NOBUSY         0x0200  /* (acgp) Do not excl busy the page */
 427 #define VM_ALLOC_IGN_SBUSY      0x1000  /* (gp) Ignore shared busy flag */
 428 #define VM_ALLOC_NODUMP         0x2000  /* (ag) don't include in dump */
 429 #define VM_ALLOC_SBUSY          0x4000  /* (acgp) Shared busy the page */
 430 #define VM_ALLOC_NOWAIT         0x8000  /* (acfgp) Do not sleep */
 431 #define VM_ALLOC_COUNT_SHIFT    16
 432 #define VM_ALLOC_COUNT(count)   ((count) << VM_ALLOC_COUNT_SHIFT)
 433
 434 #ifdef M_NOWAIT
 435 static inline int
 436 malloc2vm_flags(int malloc_flags)
 437 {
 438         int pflags;
 439
 440         KASSERT((malloc_flags & M_USE_RESERVE) == 0 ||
 441             (malloc_flags & M_NOWAIT) != 0,
 442             ("M_USE_RESERVE requires M_NOWAIT"));
 443         pflags = (malloc_flags & M_USE_RESERVE) != 0 ? VM_ALLOC_INTERRUPT :
 444             VM_ALLOC_SYSTEM;
 445         if ((malloc_flags & M_ZERO) != 0)
 446                 pflags |= VM_ALLOC_ZERO;
 447         if ((malloc_flags & M_NODUMP) != 0)
 448                 pflags |= VM_ALLOC_NODUMP;
 449         if ((malloc_flags & M_NOWAIT))
 450                 pflags |= VM_ALLOC_NOWAIT;
 451         if ((malloc_flags & M_WAITOK))
 452                 pflags |= VM_ALLOC_WAITOK;
 453         return (pflags);
 454 }
 455 #endif
 456
 457 /*
 458  * Predicates supported by vm_page_ps_test():
 459  *
 460  *      PS_ALL_DIRTY is true only if the entire (super)page is dirty.
 461  *      However, it can be spuriously false when the (super)page has become
 462  *      dirty in the pmap but that information has not been propagated to the
 463  *      machine-independent layer.
 464  */
 465 #define PS_ALL_DIRTY    0x1
 466 #define PS_ALL_VALID    0x2
 467 #define PS_NONE_BUSY    0x4
 468
 469 void vm_page_busy_downgrade(vm_page_t m);
 470 void vm_page_busy_sleep(vm_page_t m, const char *msg, bool nonshared);
 471 void vm_page_flash(vm_page_t m);
 472 void vm_page_hold(vm_page_t mem);
 473 void vm_page_unhold(vm_page_t mem);
 474 void vm_page_free(vm_page_t m);
 475 void vm_page_free_zero(vm_page_t m);
 476
 477 void vm_page_activate (vm_page_t);
 478 void vm_page_advise(vm_page_t m, int advice);
 479 vm_page_t vm_page_alloc(vm_object_t, vm_pindex_t, int);
 480 vm_page_t vm_page_alloc_domain(vm_object_t, vm_pindex_t, int, int);
 481 vm_page_t vm_page_alloc_after(vm_object_t, vm_pindex_t, int, vm_page_t);
 482 vm_page_t vm_page_alloc_domain_after(vm_object_t, vm_pindex_t, int, int,
 483     vm_page_t);
 484 vm_page_t vm_page_alloc_contig(vm_object_t object, vm_pindex_t pindex, int req,
 485     u_long npages, vm_paddr_t low, vm_paddr_t high, u_long alignment,
 486     vm_paddr_t boundary, vm_memattr_t memattr);
 487 vm_page_t vm_page_alloc_contig_domain(vm_object_t object,
 488     vm_pindex_t pindex, int domain, int req, u_long npages, vm_paddr_t low,
 489     vm_paddr_t high, u_long alignment, vm_paddr_t boundary,
 490     vm_memattr_t memattr);
 491 vm_page_t vm_page_alloc_freelist(int, int);
 492 vm_page_t vm_page_alloc_freelist_domain(int, int, int);
 493 void vm_page_change_lock(vm_page_t m, struct mtx **mtx);
 494 vm_page_t vm_page_grab (vm_object_t, vm_pindex_t, int);
 495 int vm_page_grab_pages(vm_object_t object, vm_pindex_t pindex, int allocflags,
 496     vm_page_t *ma, int count);
 497 void vm_page_deactivate(vm_page_t);
 498 void vm_page_deactivate_noreuse(vm_page_t);
 499 void vm_page_dequeue(vm_page_t m);
 500 void vm_page_dequeue_locked(vm_page_t m);
 501 vm_page_t vm_page_find_least(vm_object_t, vm_pindex_t);
 502 void vm_page_free_phys_pglist(struct pglist *tq);
 503 bool vm_page_free_prep(vm_page_t m, bool pagequeue_locked);
 504 vm_page_t vm_page_getfake(vm_paddr_t paddr, vm_memattr_t memattr);
 505 void vm_page_initfake(vm_page_t m, vm_paddr_t paddr, vm_memattr_t memattr);
 506 int vm_page_insert (vm_page_t, vm_object_t, vm_pindex_t);
 507 void vm_page_launder(vm_page_t m);
 508 vm_page_t vm_page_lookup (vm_object_t, vm_pindex_t);
 509 vm_page_t vm_page_next(vm_page_t m);
 510 int vm_page_pa_tryrelock(pmap_t, vm_paddr_t, vm_paddr_t *);
 511 struct vm_pagequeue *vm_page_pagequeue(vm_page_t m);
 512 vm_page_t vm_page_prev(vm_page_t m);
 513 bool vm_page_ps_test(vm_page_t m, int flags, vm_page_t skip_m);
 514 void vm_page_putfake(vm_page_t m);
 515 void vm_page_readahead_finish(vm_page_t m);
 516 bool vm_page_reclaim_contig(int req, u_long npages, vm_paddr_t low,
 517     vm_paddr_t high, u_long alignment, vm_paddr_t boundary);
 518 bool vm_page_reclaim_contig_domain(int domain, int req, u_long npages,
 519     vm_paddr_t low, vm_paddr_t high, u_long alignment, vm_paddr_t boundary);
 520 void vm_page_reference(vm_page_t m);
 521 void vm_page_remove (vm_page_t);
 522 int vm_page_rename (vm_page_t, vm_object_t, vm_pindex_t);
 523 vm_page_t vm_page_replace(vm_page_t mnew, vm_object_t object,
 524     vm_pindex_t pindex);
 525 void vm_page_requeue(vm_page_t m);
 526 void vm_page_requeue_locked(vm_page_t m);
 527 int vm_page_sbusied(vm_page_t m);
 528 vm_page_t vm_page_scan_contig(u_long npages, vm_page_t m_start,
 529     vm_page_t m_end, u_long alignment, vm_paddr_t boundary, int options);
 530 void vm_page_set_valid_range(vm_page_t m, int base, int size);
 531 int vm_page_sleep_if_busy(vm_page_t m, const char *msg);
 532 vm_offset_t vm_page_startup(vm_offset_t vaddr);
 533 void vm_page_sunbusy(vm_page_t m);
 534 bool vm_page_try_to_free(vm_page_t m);
 535 int vm_page_trysbusy(vm_page_t m);
 536 void vm_page_unhold_pages(vm_page_t *ma, int count);
 537 void vm_page_unswappable(vm_page_t m);
 538 boolean_t vm_page_unwire(vm_page_t m, uint8_t queue);
 539 void vm_page_updatefake(vm_page_t m, vm_paddr_t paddr, vm_memattr_t memattr);
 540 void vm_page_wire (vm_page_t);
 541 void vm_page_xunbusy_hard(vm_page_t m);
 542 void vm_page_xunbusy_maybelocked(vm_page_t m);
 543 void vm_page_set_validclean (vm_page_t, int, int);
 544 void vm_page_clear_dirty (vm_page_t, int, int);
 545 void vm_page_set_invalid (vm_page_t, int, int);
 546 int vm_page_is_valid (vm_page_t, int, int);
 547 void vm_page_test_dirty (vm_page_t);
 548 vm_page_bits_t vm_page_bits(int base, int size);
 549 void vm_page_zero_invalid(vm_page_t m, boolean_t setvalid);
 550 void vm_page_free_toq(vm_page_t m);
 551
 552 void vm_page_dirty_KBI(vm_page_t m);
 553 void vm_page_lock_KBI(vm_page_t m, const char *file, int line);
 554 void vm_page_unlock_KBI(vm_page_t m, const char *file, int line);
 555 int vm_page_trylock_KBI(vm_page_t m, const char *file, int line);
 556 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 557 void vm_page_assert_locked_KBI(vm_page_t m, const char *file, int line);
 558 void vm_page_lock_assert_KBI(vm_page_t m, int a, const char *file, int line);
 559 #endif
 560
 561 #define vm_page_assert_sbusied(m)                                       \
 562         KASSERT(vm_page_sbusied(m),                                     \
 563             ("vm_page_assert_sbusied: page %p not shared busy @ %s:%d", \
 564             (m), __FILE__, __LINE__))
 565
 566 #define vm_page_assert_unbusied(m)                                      \
 567         KASSERT(!vm_page_busied(m),                                     \
 568             ("vm_page_assert_unbusied: page %p busy @ %s:%d",           \
 569             (m), __FILE__, __LINE__))
 570
 571 #define vm_page_assert_xbusied(m)                                       \
 572         KASSERT(vm_page_xbusied(m),                                     \
 573             ("vm_page_assert_xbusied: page %p not exclusive busy @ %s:%d", \
 574             (m), __FILE__, __LINE__))
 575
 576 #define vm_page_busied(m)                                               \
 577         ((m)->busy_lock != VPB_UNBUSIED)
 578
 579 #define vm_page_sbusy(m) do {                                           \
 580         if (!vm_page_trysbusy(m))                                       \
 581                 panic("%s: page %p failed shared busying", __func__,    \
 582                     (m));                                               \
 583 } while (0)
 584
 585 #define vm_page_tryxbusy(m)                                             \
 586         (atomic_cmpset_acq_int(&(m)->busy_lock, VPB_UNBUSIED,           \
 587             VPB_SINGLE_EXCLUSIVER))
 588
 589 #define vm_page_xbusied(m)                                              \
 590         (((m)->busy_lock & VPB_SINGLE_EXCLUSIVER) != 0)
 591
 592 #define vm_page_xbusy(m) do {                                           \
 593         if (!vm_page_tryxbusy(m))                                       \
 594                 panic("%s: page %p failed exclusive busying", __func__, \
 595                     (m));                                               \
 596 } while (0)
 597
 598 /* Note: page m's lock must not be owned by the caller. */
 599 #define vm_page_xunbusy(m) do {                                         \
 600         if (!atomic_cmpset_rel_int(&(m)->busy_lock,                     \
 601             VPB_SINGLE_EXCLUSIVER, VPB_UNBUSIED))                       \
 602                 vm_page_xunbusy_hard(m);                                \
 603 } while (0)
 604
 605 #ifdef INVARIANTS
 606 void vm_page_object_lock_assert(vm_page_t m);
 607 #define VM_PAGE_OBJECT_LOCK_ASSERT(m)   vm_page_object_lock_assert(m)
 608 void vm_page_assert_pga_writeable(vm_page_t m, uint8_t bits);
 609 #define VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits)                           \
 610         vm_page_assert_pga_writeable(m, bits)
 611 #else
 612 #define VM_PAGE_OBJECT_LOCK_ASSERT(m)   (void)0
 613 #define VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits)   (void)0
 614 #endif
 615
 616 /*
 617  * We want to use atomic updates for the aflags field, which is 8 bits wide.
 618  * However, not all architectures support atomic operations on 8-bit
 619  * destinations.  In order that we can easily use a 32-bit operation, we
 620  * require that the aflags field be 32-bit aligned.
 621  */
 622 CTASSERT(offsetof(struct vm_page, aflags) % sizeof(uint32_t) == 0);
 623
 624 /*
 625  *      Clear the given bits in the specified page.
 626  */
 627 static inline void
 628 vm_page_aflag_clear(vm_page_t m, uint8_t bits)
 629 {
 630         uint32_t *addr, val;
 631
 632         /*
 633          * The PGA_REFERENCED flag can only be cleared if the page is locked.
 634          */
 635         if ((bits & PGA_REFERENCED) != 0)
 636                 vm_page_assert_locked(m);
 637
 638         /*
 639          * Access the whole 32-bit word containing the aflags field with an
 640          * atomic update.  Parallel non-atomic updates to the other fields
 641          * within this word are handled properly by the atomic update.
 642          */
 643         addr = (void *)&m->aflags;
 644         KASSERT(((uintptr_t)addr & (sizeof(uint32_t) - 1)) == 0,
 645             ("vm_page_aflag_clear: aflags is misaligned"));
 646         val = bits;
 647 #if BYTE_ORDER == BIG_ENDIAN
 648         val <<= 24;
 649 #endif
 650         atomic_clear_32(addr, val);
 651 }
 652
 653 /*
 654  *      Set the given bits in the specified page.
 655  */
 656 static inline void
 657 vm_page_aflag_set(vm_page_t m, uint8_t bits)
 658 {
 659         uint32_t *addr, val;
 660
 661         VM_PAGE_ASSERT_PGA_WRITEABLE(m, bits);
 662
 663         /*
 664          * Access the whole 32-bit word containing the aflags field with an
 665          * atomic update.  Parallel non-atomic updates to the other fields
 666          * within this word are handled properly by the atomic update.
 667          */
 668         addr = (void *)&m->aflags;
 669         KASSERT(((uintptr_t)addr & (sizeof(uint32_t) - 1)) == 0,
 670             ("vm_page_aflag_set: aflags is misaligned"));
 671         val = bits;
 672 #if BYTE_ORDER == BIG_ENDIAN
 673         val <<= 24;
 674 #endif
 675         atomic_set_32(addr, val);
 676 }
 677
 678 /*
 679  *      vm_page_dirty:
 680  *
 681  *      Set all bits in the page's dirty field.
 682  *
 683  *      The object containing the specified page must be locked if the
 684  *      call is made from the machine-independent layer.
 685  *
 686  *      See vm_page_clear_dirty_mask().
 687  */
 688 static __inline void
 689 vm_page_dirty(vm_page_t m)
 690 {
 691
 692         /* Use vm_page_dirty_KBI() under INVARIANTS to save memory. */
 693 #if defined(KLD_MODULE) || defined(INVARIANTS)
 694         vm_page_dirty_KBI(m);
 695 #else
 696         m->dirty = VM_PAGE_BITS_ALL;
 697 #endif
 698 }
 699
 700 /*
 701  *      vm_page_remque:
 702  *
 703  *      If the given page is in a page queue, then remove it from that page
 704  *      queue.
 705  *
 706  *      The page must be locked.
 707  */
 708 static inline void
 709 vm_page_remque(vm_page_t m)
 710 {
 711
 712         if (m->queue != PQ_NONE)
 713                 vm_page_dequeue(m);
 714 }
 715
 716 /*
 717  *      vm_page_undirty:
 718  *
 719  *      Set page to not be dirty.  Note: does not clear pmap modify bits
 720  */
 721 static __inline void
 722 vm_page_undirty(vm_page_t m)
 723 {
 724
 725         VM_PAGE_OBJECT_LOCK_ASSERT(m);
 726         m->dirty = 0;
 727 }
 728
 729 static inline void
 730 vm_page_replace_checked(vm_page_t mnew, vm_object_t object, vm_pindex_t pindex,
 731     vm_page_t mold)
 732 {
 733         vm_page_t mret;
 734
 735         mret = vm_page_replace(mnew, object, pindex);
 736         KASSERT(mret == mold,
 737             ("invalid page replacement, mold=%p, mret=%p", mold, mret));
 738
 739         /* Unused if !INVARIANTS. */
 740         (void)mold;
 741         (void)mret;
 742 }
 743
 744 static inline bool
 745 vm_page_active(vm_page_t m)
 746 {
 747
 748         return (m->queue == PQ_ACTIVE);
 749 }
 750
 751 static inline bool
 752 vm_page_inactive(vm_page_t m)
 753 {
 754
 755         return (m->queue == PQ_INACTIVE);
 756 }
 757
 758 static inline bool
 759 vm_page_in_laundry(vm_page_t m)
 760 {
 761
 762         return (m->queue == PQ_LAUNDRY || m->queue == PQ_UNSWAPPABLE);
 763 }
 764
 765 #endif                          /* _KERNEL */
 766 #endif                          /* !_VM_PAGE_ */