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