xref: /freebsd/share/man/man9/vm_map_sync.9 (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
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 9, 2011
27.Dt VM_MAP_SYNC 9
28.Os
29.Sh NAME
30.Nm vm_map_sync
31.Nd push dirty pages to their pager
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/vm_map.h
36.Ft int
37.Fo vm_map_sync
38.Fa "vm_map_t map" "vm_offset_t start" "vm_offset_t end" "boolean_t syncio"
39.Fa "boolean_t invalidate"
40.Fc
41.Sh DESCRIPTION
42The
43.Fn vm_map_sync
44function forces any dirty cached pages in the range
45.Fa start
46to
47.Fa end
48within the
49.Fa map
50to be pushed to their underlying pager.
51.Pp
52If
53.Fa syncio
54is TRUE, dirty pages are written synchronously.
55.Pp
56If
57.Fa invalidate
58is TRUE, any cached pages are also freed.
59.Pp
60The range provided must be contiguous, it MUST NOT contain holes.
61The range provided MUST NOT contain any sub-map entries.
62.Sh RETURN VALUES
63The
64.Fn vm_map_sync
65function returns
66.Dv KERN_SUCCESS
67if successful.
68.Pp
69Otherwise,
70.Dv KERN_INVALID_ADDRESS
71will be returned if the function encountered a sub-map entry;
72.Dv KERN_INVALID_ARGUMENT
73will be returned if the function encountered a hole in the region provided,
74or if an entry could not be found for the given start address.
75.Sh SEE ALSO
76.Xr vm_map 9
77.Sh AUTHORS
78This manual page was written by
79.An Bruce M Simpson Aq Mt bms@spc.org .
80