share/man/man9/pmap_resident_count.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_RESIDENT_COUNT 9
  30 .Os
  31 .Sh NAME
  32 .Nm pmap_resident_count ,
  33 .Nm pmap_wired_count
  34 .Nd return page resident and wiring statistics
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In vm/vm.h
  38 .In vm/pmap.h
  39 .Ft long
  40 .Fn pmap_resident_count "pmap_t pmap"
  41 .Ft long
  42 .Fn pmap_wired_count "pmap_t pmap"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pmap_resident_count
  46 and
  47 .Fn pmap_wired_count
  48 macros allow
  49 .Nm pmap
  50 consumers to retrieve statistics from the
  51 .Va pm_stats
  52 member of the machine-dependent structure
  53 .Vt struct pmap .
  54 .Sh IMPLEMENTATION NOTES
  55 Both functions are defined as in-line macros.
  56 The members which they access have type
  57 .Vt long .
  58 .Sh RETURN VALUES
  59 The
  60 .Fn pmap_resident_count
  61 returns the number of pages in the physical map
  62 .Va pmap
  63 which are currently resident in main memory.
  64 .Pp
  65 The
  66 .Fn pmap_wired_count
  67 returns the number of pages in the physical map
  68 .Va pmap
  69 which are currently wired into in main memory.
  70 .Sh SEE ALSO
  71 .Xr pmap 9
  72 .Sh AUTHORS
  73 This manual page was written by
  74 .An Bruce M Simpson Aq bms@spc.org .