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