share/man/man9/pmap_page_exists_quick.9

   1 .\"
   2 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 21, 2003
  29 .Dt PMAP_PAGE_EXISTS_QUICK 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_page_exists_quick
  33 .Nd determine if a page exists in a physical map
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft boolean_t
  39 .Fn pmap_page_exists_quick "pmap_t pmap" "vm_page_t m"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pmap_page_exists_quick
  43 function is used to quickly determine if the page
  44 .Fa m
  45 exists in the physical map
  46 .Fa pmap .
  47 It is typically called from the VM paging code.
  48 .Sh IMPLEMENTATION NOTES
  49 The PV count used above may be changed upwards or downwards in future;
  50 it is only necessary that
  51 .Dv TRUE
  52 be returned for a small subset of pmaps for proper page aging.
  53 .Sh RETURN VALUES
  54 The
  55 .Fn pmap_page_exists_quick
  56 returns
  57 .Dv TRUE
  58 only if the PV entry for the physical map
  59 .Fa pmap
  60 is one of the first 16 PVs linked from the page
  61 .Fa m .
  62 .Sh SEE ALSO
  63 .Xr pmap 9
  64 .Sh AUTHORS
  65 This manual page was written by
  66 .An Bruce M Simpson Aq bms@spc.org .