xref: /freebsd/share/man/man9/pmap_is_modified.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_IS_MODIFIED 9
30.Sh NAME
31.Nm pmap_is_modified ,
32.Nm pmap_ts_modified
33.Nd return information about physical pages
34.Sh SYNOPSIS
35.In sys/param.h
36.In vm/vm.h
37.In vm/pmap.h
38.Ft boolean_t
39.Fn pmap_is_modified "vm_page_t m"
40.Ft int
41.Fn pmap_ts_referenced "vm_page_t m"
42.Sh DESCRIPTION
43The
44.Fn pmap_is_modified
45and
46.Fn pmap_ts_referenced
47functions return information about physical pages.
48.Sh RETURN VALUES
49The
50.Fn pmap_is_modified
51function returns the status of the
52.Sq "page modified"
53bit for the physical page
54.Fa m .
55.Pp
56The
57.Fn pmap_ts_referenced
58function returns a count of reference bits for a page
59.Fa m ,
60clearing those bits.
61It is not necessary for every reference bit to be cleared, but it is
62necessary that 0 only be returned when there are no remaining reference
63bits set on the page.
64.Sh SEE ALSO
65.Xr pmap 9 ,
66.Xr pmap_clear_modify 9 ,
67.Xr pmap_clear_reference 9
68.Sh AUTHORS
69This manual page was written by
70.An Bruce M Simpson Aq bms@spc.org .
71