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