sys/vm/vm_page.h

   1 /*
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * The Mach Operating System project at Carnegie-Mellon University.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      from: @(#)vm_page.h     8.2 (Berkeley) 12/13/93
  37  *
  38  *
  39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  40  * All rights reserved.
  41  *
  42  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  43  *
  44  * Permission to use, copy, modify and distribute this software and
  45  * its documentation is hereby granted, provided that both the copyright
  46  * notice and this permission notice appear in all copies of the
  47  * software, derivative works or modified versions, and any portions
  48  * thereof, and that both notices appear in supporting documentation.
  49  *
  50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  53  *
  54  * Carnegie Mellon requests users of this software to return to
  55  *
  56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  57  *  School of Computer Science
  58  *  Carnegie Mellon University
  59  *  Pittsburgh PA 15213-3890
  60  *
  61  * any improvements or extensions that they make and grant Carnegie the
  62  * rights to redistribute these changes.
  63  *
  64  * $FreeBSD: src/sys/vm/vm_page.h,v 1.75.2.8 2002/03/06 01:07:09 dillon Exp $
  65  */
  66
  67 /*
  68  *      Resident memory system definitions.
  69  */
  70
  71 #ifndef _VM_VM_PAGE_H_
  72 #define _VM_VM_PAGE_H_
  73
  74 #if !defined(KLD_MODULE) && defined(_KERNEL)
  75 #include "opt_vmpage.h"
  76 #endif
  77
  78 #ifndef _SYS_TYPES_H_
  79 #include <sys/types.h>
  80 #endif
  81 #ifndef _SYS_TREE_H_
  82 #include <sys/tree.h>
  83 #endif
  84 #ifndef _MACHINE_PMAP_H_
  85 #include <machine/pmap.h>
  86 #endif
  87 #ifndef _VM_PMAP_H_
  88 #include <vm/pmap.h>
  89 #endif
  90 #include <machine/atomic.h>
  91
  92 #ifdef _KERNEL
  93
  94 #ifndef _SYS_SYSTM_H_
  95 #include <sys/systm.h>
  96 #endif
  97 #ifndef _SYS_THREAD2_H_
  98 #include <sys/thread2.h>
  99 #endif
 100
 101 #ifdef __x86_64__
 102 #include <machine/vmparam.h>
 103 #endif
 104
 105 #endif
 106
 107 typedef enum vm_page_event { VMEVENT_NONE, VMEVENT_COW } vm_page_event_t;
 108
 109 struct vm_page_action {
 110         LIST_ENTRY(vm_page_action) entry;
 111         struct vm_page          *m;
 112         vm_page_event_t         event;
 113         void                    (*func)(struct vm_page *,
 114                                         struct vm_page_action *);
 115         void                    *data;
 116 };
 117
 118 typedef struct vm_page_action *vm_page_action_t;
 119
 120 /*
 121  *      Management of resident (logical) pages.
 122  *
 123  *      A small structure is kept for each resident
 124  *      page, indexed by page number.  Each structure
 125  *      is an element of several lists:
 126  *
 127  *              A hash table bucket used to quickly
 128  *              perform object/offset lookups
 129  *
 130  *              A list of all pages for a given object,
 131  *              so they can be quickly deactivated at
 132  *              time of deallocation.
 133  *
 134  *              An ordered list of pages due for pageout.
 135  *
 136  *      In addition, the structure contains the object
 137  *      and offset to which this page belongs (for pageout),
 138  *      and sundry status bits.
 139  *
 140  *      Fields in this structure are locked either by the lock on the
 141  *      object that the page belongs to (O) or by the lock on the page
 142  *      queues (P).
 143  *
 144  *      The 'valid' and 'dirty' fields are distinct.  A page may have dirty
 145  *      bits set without having associated valid bits set.  This is used by
 146  *      NFS to implement piecemeal writes.
 147  */
 148
 149 TAILQ_HEAD(pglist, vm_page);
 150
 151 struct vm_object;
 152
 153 int rb_vm_page_compare(struct vm_page *, struct vm_page *);
 154
 155 struct vm_page_rb_tree;
 156 RB_PROTOTYPE2(vm_page_rb_tree, vm_page, rb_entry, rb_vm_page_compare, vm_pindex_t);
 157
 158 struct vm_page {
 159         TAILQ_ENTRY(vm_page) pageq;     /* vm_page_queues[] list (P)    */
 160         RB_ENTRY(vm_page) rb_entry;     /* Red-Black tree based at object */
 161
 162         struct vm_object *object;       /* which object am I in (O,P)*/
 163         vm_pindex_t pindex;             /* offset into object (O,P) */
 164         vm_paddr_t phys_addr;           /* physical address of page */
 165         struct md_page md;              /* machine dependant stuff */
 166         u_short queue;                  /* page queue index */
 167         u_short pc;                     /* page color */
 168         u_char  act_count;              /* page usage count */
 169         u_char  busy;                   /* page busy count */
 170         u_char  unused01;
 171         u_char  unused02;
 172         u_int32_t flags;                /* see below */
 173         u_int   wire_count;             /* wired down maps refs (P) */
 174         int     hold_count;             /* page hold count */
 175
 176         /*
 177          * NOTE that these must support one bit per DEV_BSIZE in a page!!!
 178          * so, on normal X86 kernels, they must be at least 8 bits wide.
 179          */
 180         u_char  valid;                  /* map of valid DEV_BSIZE chunks */
 181         u_char  dirty;                  /* map of dirty DEV_BSIZE chunks */
 182
 183         int     ku_pagecnt;             /* kmalloc helper */
 184 #ifdef VM_PAGE_DEBUG
 185         const char *busy_func;
 186         int     busy_line;
 187 #endif
 188 };
 189
 190 #ifdef VM_PAGE_DEBUG
 191 #define VM_PAGE_DEBUG_EXT(name) name ## _debug
 192 #define VM_PAGE_DEBUG_ARGS      , const char *func, int lineno
 193 #else
 194 #define VM_PAGE_DEBUG_EXT(name) name
 195 #define VM_PAGE_DEBUG_ARGS
 196 #endif
 197
 198 #ifndef __VM_PAGE_T_DEFINED__
 199 #define __VM_PAGE_T_DEFINED__
 200 typedef struct vm_page *vm_page_t;
 201 #endif
 202
 203 /*
 204  * Page coloring parameters.  We default to a middle of the road optimization.
 205  * Larger selections would not really hurt us but if a machine does not have
 206  * a lot of memory it could cause vm_page_alloc() to eat more cpu cycles
 207  * looking for free pages.
 208  *
 209  * Page coloring cannot be disabled.  Modules do not have access to most PQ
 210  * constants because they can change between builds.
 211  */
 212 #if defined(_KERNEL) && !defined(KLD_MODULE)
 213
 214 #if !defined(PQ_CACHESIZE)
 215 #define PQ_CACHESIZE 256        /* max is 1024 (MB) */
 216 #endif
 217
 218 #if PQ_CACHESIZE >= 1024
 219 #define PQ_PRIME1 31    /* Prime number somewhat less than PQ_HASH_SIZE */
 220 #define PQ_PRIME2 23    /* Prime number somewhat less than PQ_HASH_SIZE */
 221 #define PQ_L2_SIZE 256  /* A number of colors opt for 1M cache */
 222
 223 #elif PQ_CACHESIZE >= 512
 224 #define PQ_PRIME1 31    /* Prime number somewhat less than PQ_HASH_SIZE */
 225 #define PQ_PRIME2 23    /* Prime number somewhat less than PQ_HASH_SIZE */
 226 #define PQ_L2_SIZE 128  /* A number of colors opt for 512K cache */
 227
 228 #elif PQ_CACHESIZE >= 256
 229 #define PQ_PRIME1 13    /* Prime number somewhat less than PQ_HASH_SIZE */
 230 #define PQ_PRIME2 7     /* Prime number somewhat less than PQ_HASH_SIZE */
 231 #define PQ_L2_SIZE 64   /* A number of colors opt for 256K cache */
 232
 233 #elif PQ_CACHESIZE >= 128
 234 #define PQ_PRIME1 9     /* Produces a good PQ_L2_SIZE/3 + PQ_PRIME1 */
 235 #define PQ_PRIME2 5     /* Prime number somewhat less than PQ_HASH_SIZE */
 236 #define PQ_L2_SIZE 32   /* A number of colors opt for 128k cache */
 237
 238 #else
 239 #define PQ_PRIME1 5     /* Prime number somewhat less than PQ_HASH_SIZE */
 240 #define PQ_PRIME2 3     /* Prime number somewhat less than PQ_HASH_SIZE */
 241 #define PQ_L2_SIZE 16   /* A reasonable number of colors (opt for 64K cache) */
 242
 243 #endif
 244
 245 #define PQ_L2_MASK      (PQ_L2_SIZE - 1)
 246
 247 #endif /* KERNEL && !KLD_MODULE */
 248
 249 /*
 250  *
 251  * The queue array is always based on PQ_MAXL2_SIZE regardless of the actual
 252  * cache size chosen in order to present a uniform interface for modules.
 253  */
 254 #define PQ_MAXL2_SIZE   256     /* fixed maximum (in pages) / module compat */
 255
 256 #if PQ_L2_SIZE > PQ_MAXL2_SIZE
 257 #error "Illegal PQ_L2_SIZE"
 258 #endif
 259
 260 #define PQ_NONE         0
 261 #define PQ_FREE         1
 262 #define PQ_INACTIVE     (1 + 1*PQ_MAXL2_SIZE)
 263 #define PQ_ACTIVE       (2 + 1*PQ_MAXL2_SIZE)
 264 #define PQ_CACHE        (3 + 1*PQ_MAXL2_SIZE)
 265 #define PQ_HOLD         (3 + 2*PQ_MAXL2_SIZE)
 266 #define PQ_COUNT        (4 + 2*PQ_MAXL2_SIZE)
 267
 268 /*
 269  * Scan support
 270  */
 271 struct vm_map;
 272
 273 struct rb_vm_page_scan_info {
 274         vm_pindex_t     start_pindex;
 275         vm_pindex_t     end_pindex;
 276         int             limit;
 277         int             desired;
 278         int             error;
 279         int             pagerflags;
 280         vm_offset_t     addr;
 281         vm_pindex_t     backing_offset_index;
 282         struct vm_object *object;
 283         struct vm_object *backing_object;
 284         struct vm_page  *mpte;
 285         struct pmap     *pmap;
 286         struct vm_map   *map;
 287 };
 288
 289 int rb_vm_page_scancmp(struct vm_page *, void *);
 290
 291 struct vpgqueues {
 292         struct pglist pl;
 293         int     *cnt;
 294         int     lcnt;
 295         int     flipflop;       /* probably not the best place */
 296         struct spinlock spin;
 297         char    unused[64 - sizeof(struct pglist) -
 298                         sizeof(int *) - sizeof(int) * 2];
 299 };
 300
 301 extern struct vpgqueues vm_page_queues[PQ_COUNT];
 302
 303 /*
 304  * These are the flags defined for vm_page.
 305  *
 306  *  PG_UNMANAGED (used by OBJT_PHYS) indicates that the page is
 307  *  not under PV management but otherwise should be treated as a
 308  *  normal page.  Pages not under PV management cannot be paged out
 309  *  via the object/vm_page_t because there is no knowledge of their
 310  *  pte mappings, nor can they be removed from their objects via
 311  *  the object, and such pages are also not on any PQ queue.  The
 312  *  PG_MAPPED and PG_WRITEABLE flags are not applicable.
 313  *
 314  *  PG_MAPPED only applies to managed pages, indicating whether the page
 315  *  is mapped onto one or more pmaps.  A page might still be mapped to
 316  *  special pmaps in an unmanaged fashion, for example when mapped into a
 317  *  buffer cache buffer, without setting PG_MAPPED.
 318  *
 319  *  PG_WRITEABLE indicates that there may be a writeable managed pmap entry
 320  *  somewhere, and that the page can be dirtied by hardware at any time
 321  *  and may have to be tested for that.  The modified bit in unmanaged
 322  *  mappings or in the special clean map is not tested.
 323  *
 324  *  PG_SWAPPED indicates that the page is backed by a swap block.  Any
 325  *  VM object type other than OBJT_DEFAULT can have swap-backed pages now.
 326  *
 327  *  PG_SBUSY is set when m->busy != 0.  PG_SBUSY and m->busy are only modified
 328  *  when the page is PG_BUSY.
 329  */
 330 #define PG_BUSY         0x00000001      /* page is in transit (O) */
 331 #define PG_WANTED       0x00000002      /* someone is waiting for page (O) */
 332 #define PG_WINATCFLS    0x00000004      /* flush dirty page on inactive q */
 333 #define PG_FICTITIOUS   0x00000008      /* physical page doesn't exist (O) */
 334 #define PG_WRITEABLE    0x00000010      /* page is writeable */
 335 #define PG_MAPPED       0x00000020      /* page is mapped (managed) */
 336 #define PG_ZERO         0x00000040      /* page is zeroed */
 337 #define PG_REFERENCED   0x00000080      /* page has been referenced */
 338 #define PG_CLEANCHK     0x00000100      /* page will be checked for cleaning */
 339 #define PG_SWAPINPROG   0x00000200      /* swap I/O in progress on page      */
 340 #define PG_NOSYNC       0x00000400      /* do not collect for syncer */
 341 #define PG_UNMANAGED    0x00000800      /* No PV management for page */
 342 #define PG_MARKER       0x00001000      /* special queue marker page */
 343 #define PG_RAM          0x00002000      /* read ahead mark */
 344 #define PG_SWAPPED      0x00004000      /* backed by swap */
 345 #define PG_NOTMETA      0x00008000      /* do not back with swap */
 346 #define PG_ACTIONLIST   0x00010000      /* lookaside action list present */
 347 #define PG_SBUSY        0x00020000      /* soft-busy also set */
 348
 349 /*
 350  * Misc constants.
 351  */
 352
 353 #define ACT_DECLINE             1
 354 #define ACT_ADVANCE             3
 355 #define ACT_INIT                5
 356 #define ACT_MAX                 64
 357
 358 #ifdef _KERNEL
 359 /*
 360  * Each pageable resident page falls into one of four lists:
 361  *
 362  *      free
 363  *              Available for allocation now.
 364  *
 365  * The following are all LRU sorted:
 366  *
 367  *      cache
 368  *              Almost available for allocation. Still in an
 369  *              object, but clean and immediately freeable at
 370  *              non-interrupt times.
 371  *
 372  *      inactive
 373  *              Low activity, candidates for reclamation.
 374  *              This is the list of pages that should be
 375  *              paged out next.
 376  *
 377  *      active
 378  *              Pages that are "active" i.e. they have been
 379  *              recently referenced.
 380  *
 381  *      zero
 382  *              Pages that are really free and have been pre-zeroed
 383  *
 384  */
 385
 386 extern int vm_page_zero_count;
 387 extern struct vm_page *vm_page_array;   /* First resident page in table */
 388 extern int vm_page_array_size;          /* number of vm_page_t's */
 389 extern long first_page;                 /* first physical page number */
 390
 391 #define VM_PAGE_TO_PHYS(entry)  \
 392                 ((entry)->phys_addr)
 393
 394 #define PHYS_TO_VM_PAGE(pa)     \
 395                 (&vm_page_array[atop(pa) - first_page])
 396
 397 /*
 398  *      Functions implemented as macros
 399  */
 400
 401 static __inline void
 402 vm_page_flag_set(vm_page_t m, unsigned int bits)
 403 {
 404         atomic_set_int(&(m)->flags, bits);
 405 }
 406
 407 static __inline void
 408 vm_page_flag_clear(vm_page_t m, unsigned int bits)
 409 {
 410         atomic_clear_int(&(m)->flags, bits);
 411 }
 412
 413 /*
 414  * Wakeup anyone waiting for the page after potentially unbusying
 415  * (hard or soft) or doing other work on a page that might make a
 416  * waiter ready.  The setting of PG_WANTED is integrated into the
 417  * related flags and it can't be set once the flags are already
 418  * clear, so there should be no races here.
 419  */
 420
 421 static __inline void
 422 vm_page_flash(vm_page_t m)
 423 {
 424         if (m->flags & PG_WANTED) {
 425                 vm_page_flag_clear(m, PG_WANTED);
 426                 wakeup(m);
 427         }
 428 }
 429
 430 #if PAGE_SIZE == 4096
 431 #define VM_PAGE_BITS_ALL 0xff
 432 #endif
 433
 434 /*
 435  * Note: the code will always use nominally free pages from the free list
 436  * before trying other flag-specified sources.
 437  *
 438  * At least one of VM_ALLOC_NORMAL|VM_ALLOC_SYSTEM|VM_ALLOC_INTERRUPT
 439  * must be specified.  VM_ALLOC_RETRY may only be specified if VM_ALLOC_NORMAL
 440  * is also specified.
 441  */
 442 #define VM_ALLOC_NORMAL         0x01    /* ok to use cache pages */
 443 #define VM_ALLOC_SYSTEM         0x02    /* ok to exhaust most of free list */
 444 #define VM_ALLOC_INTERRUPT      0x04    /* ok to exhaust entire free list */
 445 #define VM_ALLOC_ZERO           0x08    /* req pre-zero'd memory if avail */
 446 #define VM_ALLOC_QUICK          0x10    /* like NORMAL but do not use cache */
 447 #define VM_ALLOC_RETRY          0x80    /* indefinite block (vm_page_grab()) */
 448
 449 void vm_page_queue_spin_lock(vm_page_t);
 450 void vm_page_queues_spin_lock(u_short);
 451 void vm_page_and_queue_spin_lock(vm_page_t);
 452
 453 void vm_page_queue_spin_unlock(vm_page_t);
 454 void vm_page_queues_spin_unlock(u_short);
 455 void vm_page_and_queue_spin_unlock(vm_page_t m);
 456
 457 void vm_page_io_finish(vm_page_t m);
 458 void vm_page_io_start(vm_page_t m);
 459 void vm_page_wakeup(vm_page_t m);
 460 void vm_page_hold(vm_page_t);
 461 void vm_page_unhold(vm_page_t);
 462 void vm_page_activate (vm_page_t);
 463 vm_page_t vm_page_alloc (struct vm_object *, vm_pindex_t, int);
 464 vm_page_t vm_page_grab (struct vm_object *, vm_pindex_t, int);
 465 void vm_page_cache (vm_page_t);
 466 int vm_page_try_to_cache (vm_page_t);
 467 int vm_page_try_to_free (vm_page_t);
 468 void vm_page_dontneed (vm_page_t);
 469 void vm_page_deactivate (vm_page_t);
 470 void vm_page_deactivate_locked (vm_page_t);
 471 void vm_page_insert (vm_page_t, struct vm_object *, vm_pindex_t);
 472 vm_page_t vm_page_lookup (struct vm_object *, vm_pindex_t);
 473 vm_page_t VM_PAGE_DEBUG_EXT(vm_page_lookup_busy_wait)(struct vm_object *, vm_pindex_t,
 474                                 int, const char * VM_PAGE_DEBUG_ARGS);
 475 vm_page_t VM_PAGE_DEBUG_EXT(vm_page_lookup_busy_try)(struct vm_object *, vm_pindex_t, int, int * VM_PAGE_DEBUG_ARGS);
 476 void vm_page_remove (vm_page_t);
 477 void vm_page_rename (vm_page_t, struct vm_object *, vm_pindex_t);
 478 void vm_page_startup (void);
 479 void vm_page_unmanage (vm_page_t);
 480 void vm_page_unwire (vm_page_t, int);
 481 void vm_page_wire (vm_page_t);
 482 void vm_page_unqueue (vm_page_t);
 483 void vm_page_unqueue_nowakeup (vm_page_t);
 484 vm_page_t vm_page_next (vm_page_t);
 485 void vm_page_set_validclean (vm_page_t, int, int);
 486 void vm_page_set_validdirty (vm_page_t, int, int);
 487 void vm_page_set_valid (vm_page_t, int, int);
 488 void vm_page_set_dirty (vm_page_t, int, int);
 489 void vm_page_clear_dirty (vm_page_t, int, int);
 490 void vm_page_set_invalid (vm_page_t, int, int);
 491 int vm_page_is_valid (vm_page_t, int, int);
 492 void vm_page_test_dirty (vm_page_t);
 493 int vm_page_bits (int, int);
 494 vm_page_t vm_page_list_find(int basequeue, int index, boolean_t prefer_zero);
 495 void vm_page_zero_invalid(vm_page_t m, boolean_t setvalid);
 496 void vm_page_free_toq(vm_page_t m);
 497 vm_page_t vm_page_free_fromq_fast(void);
 498 void vm_page_event_internal(vm_page_t, vm_page_event_t);
 499 void vm_page_dirty(vm_page_t m);
 500 void vm_page_register_action(vm_page_action_t action, vm_page_event_t event);
 501 void vm_page_unregister_action(vm_page_action_t action);
 502 void vm_page_sleep_busy(vm_page_t m, int also_m_busy, const char *msg);
 503 void VM_PAGE_DEBUG_EXT(vm_page_busy_wait)(vm_page_t m, int also_m_busy, const char *wmsg VM_PAGE_DEBUG_ARGS);
 504 int VM_PAGE_DEBUG_EXT(vm_page_busy_try)(vm_page_t m, int also_m_busy VM_PAGE_DEBUG_ARGS);
 505
 506 #ifdef VM_PAGE_DEBUG
 507
 508 #define vm_page_lookup_busy_wait(object, pindex, alsob, msg)            \
 509         vm_page_lookup_busy_wait_debug(object, pindex, alsob, msg,      \
 510                                         __func__, __LINE__)
 511
 512 #define vm_page_lookup_busy_try(object, pindex, alsob, errorp)          \
 513         vm_page_lookup_busy_try_debug(object, pindex, alsob, errorp,    \
 514                                         __func__, __LINE__)
 515
 516 #define vm_page_busy_wait(m, alsob, msg)                                \
 517         vm_page_busy_wait_debug(m, alsob, msg, __func__, __LINE__)
 518
 519 #define vm_page_busy_try(m, alsob)                                      \
 520         vm_page_busy_try_debug(m, alsob, __func__, __LINE__)
 521
 522 #endif
 523
 524 /*
 525  * Reduce the protection of a page.  This routine never raises the
 526  * protection and therefore can be safely called if the page is already
 527  * at VM_PROT_NONE (it will be a NOP effectively ).
 528  *
 529  * VM_PROT_NONE will remove all user mappings of a page.  This is often
 530  * necessary when a page changes state (for example, turns into a copy-on-write
 531  * page or needs to be frozen for write I/O) in order to force a fault, or
 532  * to force a page's dirty bits to be synchronized and avoid hardware
 533  * (modified/accessed) bit update races with pmap changes.
 534  *
 535  * Since 'prot' is usually a constant, this inline usually winds up optimizing
 536  * out the primary conditional.
 537  *
 538  * WARNING: VM_PROT_NONE can block, but will loop until all mappings have
 539  * been cleared.  Callers should be aware that other page related elements
 540  * might have changed, however.
 541  */
 542 static __inline void
 543 vm_page_protect(vm_page_t m, int prot)
 544 {
 545         KKASSERT(m->flags & PG_BUSY);
 546         if (prot == VM_PROT_NONE) {
 547                 if (m->flags & (PG_WRITEABLE|PG_MAPPED)) {
 548                         pmap_page_protect(m, VM_PROT_NONE);
 549                         /* PG_WRITEABLE & PG_MAPPED cleared by call */
 550                 }
 551         } else if ((prot == VM_PROT_READ) && (m->flags & PG_WRITEABLE)) {
 552                 pmap_page_protect(m, VM_PROT_READ);
 553                 /* PG_WRITEABLE cleared by call */
 554         }
 555 }
 556
 557 /*
 558  * Zero-fill the specified page.  The entire contents of the page will be
 559  * zero'd out.
 560  */
 561 static __inline boolean_t
 562 vm_page_zero_fill(vm_page_t m)
 563 {
 564         pmap_zero_page(VM_PAGE_TO_PHYS(m));
 565         return (TRUE);
 566 }
 567
 568 /*
 569  * Copy the contents of src_m to dest_m.  The pages must be stable but spl
 570  * and other protections depend on context.
 571  */
 572 static __inline void
 573 vm_page_copy(vm_page_t src_m, vm_page_t dest_m)
 574 {
 575         pmap_copy_page(VM_PAGE_TO_PHYS(src_m), VM_PAGE_TO_PHYS(dest_m));
 576         dest_m->valid = VM_PAGE_BITS_ALL;
 577         dest_m->dirty = VM_PAGE_BITS_ALL;
 578 }
 579
 580 /*
 581  * Free a page.  The page must be marked BUSY.
 582  *
 583  * The clearing of PG_ZERO is a temporary safety until the code can be
 584  * reviewed to determine that PG_ZERO is being properly cleared on
 585  * write faults or maps.  PG_ZERO was previously cleared in
 586  * vm_page_alloc().
 587  */
 588 static __inline void
 589 vm_page_free(vm_page_t m)
 590 {
 591         vm_page_flag_clear(m, PG_ZERO);
 592         vm_page_free_toq(m);
 593 }
 594
 595 /*
 596  * Free a page to the zerod-pages queue
 597  */
 598 static __inline void
 599 vm_page_free_zero(vm_page_t m)
 600 {
 601 #ifdef __x86_64__
 602         /* JG DEBUG64 We check if the page is really zeroed. */
 603         char *p = (char *)PHYS_TO_DMAP(VM_PAGE_TO_PHYS(m));
 604         int i;
 605
 606         for (i = 0; i < PAGE_SIZE; i++) {
 607                 if (p[i] != 0) {
 608                         panic("non-zero page in vm_page_free_zero()");
 609                 }
 610         }
 611
 612 #endif
 613         vm_page_flag_set(m, PG_ZERO);
 614         vm_page_free_toq(m);
 615 }
 616
 617 /*
 618  * Set page to not be dirty.  Note: does not clear pmap modify bits .
 619  */
 620 static __inline void
 621 vm_page_undirty(vm_page_t m)
 622 {
 623         m->dirty = 0;
 624 }
 625
 626 #endif                          /* _KERNEL */
 627 #endif                          /* !_VM_VM_PAGE_H_ */