share/man/man9/pmap_is_prefaultable.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_IS_PREFAULTABLE 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_is_prefaultable
  33 .Nd determine if a page may be prefaulted
  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_is_prefaultable "pmap_t pmap" "vm_offset_t va"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pmap_is_prefaultable
  43 function provides a means of determining if the page residing at
  44 virtual address
  45 .Fa va
  46 in the physical map
  47 .Fa pmap
  48 may be pre-faulted into main memory.
  49 .Pp
  50 This is a helper function which is called by
  51 .Xr vm_fault_prefault 9 .
  52 .Sh SEE ALSO
  53 .Xr pmap 9 ,
  54 .Xr vm_fault_prefault 9
  55 .Sh AUTHORS
  56 This manual page was written by
  57 .An Bruce M Simpson Aq bms@spc.org .