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