diff options
author | Bruce M Simpson <bms@FreeBSD.org> | 2003-10-06 01:49:35 +0000 |
---|---|---|
committer | Bruce M Simpson <bms@FreeBSD.org> | 2003-10-06 01:49:35 +0000 |
commit | 1aba005ab512f7ca0080011381ec3820449cd951 (patch) | |
tree | 1837b5e544d86d58a811baaf0a47585a3925a7f9 /share/man/man9 | |
parent | 2bc7dd566109712f59c836995384613c88bdd803 (diff) | |
download | src-1aba005ab512f7ca0080011381ec3820449cd951.tar.gz src-1aba005ab512f7ca0080011381ec3820449cd951.zip |
Add pmap_wired_count() and pmap_resident_count() to the pmap documentation.
Discussed with: peter
Notes
Notes:
svn path=/head/; revision=120832
Diffstat (limited to 'share/man/man9')
-rw-r--r-- | share/man/man9/Makefile | 3 | ||||
-rw-r--r-- | share/man/man9/pmap.9 | 8 | ||||
-rw-r--r-- | share/man/man9/pmap_resident_count.9 | 73 |
3 files changed, 82 insertions, 2 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index b7ba33e9c8bc..5690606df151 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -66,7 +66,7 @@ MAN= BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9 BUF_REFCNT.9 \ pmap_is_prefaultable.9 pmap_map.9 \ pmap_mincore.9 pmap_object_init_pt.9 pmap_page_exists_quick.9 \ pmap_page_protect.9 pmap_pinit.9 pmap_qenter.9 \ - pmap_release.9 pmap_remove.9 pmap_zero_page.9 \ + pmap_release.9 pmap_remove.9 pmap_resident_count.9 pmap_zero_page.9 \ random.9 resettodr.9 resource_int_value.9 resource_query_string.9 \ rtalloc.9 rtentry.9 runqueue.9 random_harvest.9 rijndael.9 \ rman.9 \ @@ -231,6 +231,7 @@ MLINKS+=pmap_pinit.9 pmap_pinit2.9 MLINKS+=pmap_qenter.9 pmap_qremove.9 MLINKS+=pmap_remove.9 pmap_remove_all.9 MLINKS+=pmap_remove.9 pmap_remove_pages.9 +MLINKS+=pmap_resident_count.9 pmap_wired_count.9 MLINKS+=pmap_zero_page.9 pmap_zero_idle.9 MLINKS+=pmap_zero_page.9 pmap_zero_area.9 MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9 diff --git a/share/man/man9/pmap.9 b/share/man/man9/pmap.9 index 5ea17545e93c..6f59a3d1603d 100644 --- a/share/man/man9/pmap.9 +++ b/share/man/man9/pmap.9 @@ -78,7 +78,13 @@ struct pmap_statistics { }; .Ed .Pp -Each implementation is expected to maintain the statistics in this structure. +The implementation's +.Vt struct pmap +must contain an instance of this structure having the name +.Va pm_stats , +and it must be updated by the implementation after each relevant +.Nm pmap +operation. .Sh SEE ALSO .Xr pmap 9 , .Xr pmap_activate 9 , diff --git a/share/man/man9/pmap_resident_count.9 b/share/man/man9/pmap_resident_count.9 new file mode 100644 index 000000000000..293fb3498e27 --- /dev/null +++ b/share/man/man9/pmap_resident_count.9 @@ -0,0 +1,73 @@ +.\" +.\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd July 21, 2003 +.Dt PMAP_RESIDENT_COUNT 9 +.Sh NAME +.Nm pmap_resident_count , +.Nm pmap_wired_count +.Nd return page resident and wiring statistics +.Sh SYNOPSIS +.In sys/param.h +.In vm/vm.h +.In vm/pmap.h +.Ft long +.Fn pmap_resident_count "pmap_t pmap" +.Ft long +.Fn pmap_wired_count "pmap_t pmap" +.Sh DESCRIPTION +The +.Fn pmap_resident_count +and +.Fn pmap_wired_count +macros allow +.Nm pmap +consumers to retrieve statistics from the +.Va pm_stats +member of the machine-dependent structure +.Vt struct pmap . +.Sh IMPLEMENTATION NOTES +Both functions are defined as in-line macros. +The members which they access have type +.Vt long . +.Sh RETURN VALUES +The +.Fn pmap_resident_count +returns the number of pages in the physical map +.Va pmap +which are currently resident in main memory. +.Pp +The +.Fn pmap_wired_count +returns the number of pages in the physical map +.Va pmap +which are currently wired into in main memory. +.Sh SEE ALSO +.Xr pmap 9 +.Sh AUTHORS +This manual page was written by +.An Bruce M Simpson Aq bms@spc.org . |