share/man/man9/pmap_mincore.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_MINCORE 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_mincore
  33 .Nd determine if a virtual address is resident in physical memory
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In vm/vm.h
  37 .In vm/pmap.h
  38 .Ft int
  39 .Fn pmap_mincore "pmap_t pmap" "vm_offset_t addr"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pmap_mincore
  43 function determines if the page at the virtual address
  44 .Fa addr
  45 in the physical map
  46 .Fa pmap
  47 is resident in physical memory.
  48 It is the machine-dependent interface used by the
  49 .Xr mincore 2
  50 system call.
  51 .Sh RETURN VALUES
  52 If the page is resident in physical memory,
  53 a mask of flags is returned,
  54 whose meaning is documented in
  55 .Xr mincore 2 ;
  56 otherwise,
  57 0
  58 is returned.
  59 .Pp
  60 The
  61 .Fa pmap
  62 must exist and
  63 .Fa addr
  64 must be mapped into the
  65 .Fa pmap .
  66 If any error occurs, the machine-dependent implementation should
  67 return
  68 0.
  69 .Sh SEE ALSO
  70 .Xr mincore 2 ,
  71 .Xr pmap 9
  72 .Sh AUTHORS
  73 This manual page was written by
  74 .An Bruce M Simpson Aq bms@spc.org .