xref: /freebsd/share/man/man9/pmap_remove.9 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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_REMOVE 9
28.Os
29.Sh NAME
30.Nm pmap_remove ,
31.Nm pmap_remove_all ,
32.Nm pmap_remove_pages
33.Nd remove pages from a physical map
34.Sh SYNOPSIS
35.In sys/param.h
36.In vm/vm.h
37.In vm/pmap.h
38.Ft void
39.Fn pmap_remove "pmap_t pmap" "vm_offset_t sva" "vm_offset_t eva"
40.Ft void
41.Fn pmap_remove_all "vm_page_t m"
42.Ft void
43.Fn pmap_remove_pages "pmap_t pmap"
44.Sh DESCRIPTION
45The
46.Fn pmap_remove
47function removes the range of addresses between
48.Fa sva
49and
50.Fa eva
51from the physical map
52.Fa pmap .
53If
54.Fa eva
55is less than
56.Fa sva ,
57then the result is undefined.
58It is assumed that both
59.Fa sva
60and
61.Fa eva
62are page-aligned addresses.
63.Pp
64The
65.Fn pmap_remove_all
66removes the physical page
67.Fa m
68from all physical maps in which it resides, and reflects back the modify
69bits to the appropriate pager.
70.Pp
71The
72.Fn pmap_remove_pages
73function removes all user pages from the physical map
74.Fa pmap .
75This function is called when a process exits to run down its address space
76more quickly than would be the case for calling
77.Fn pmap_remove .
78.Sh SEE ALSO
79.Fn pmap 9
80.Sh AUTHORS
81This manual page was written by
82.An Bruce M Simpson Aq Mt bms@spc.org .
83