xref: /freebsd-14.2/lib/libc/sys/msync.2 (revision fbc400a6)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)msync.2	8.2 (Berkeley) 6/21/94
33.\"	$Id$
34.\"
35.Dd June 21, 1994
36.Dt MSYNC 2
37.Os
38.Sh NAME
39.Nm msync
40.Nd synchronize a mapped region
41.Sh SYNOPSIS
42.Fd #include <sys/types.h>
43.Fd #include <sys/mman.h>
44.Ft int
45.Fn msync "void *addr" "size_t len" "int flags"
46.Sh DESCRIPTION
47The
48.Fn msync
49system call
50writes any modified pages back to the filesystem and updates
51the file modification time.
52If
53.Fa len
54is 0, all modified pages within the region containing
55.Fa addr
56will be flushed;
57if
58.Fa len
59is non-zero, only those pages containing
60.Fa addr
61and
62.Fa len-1
63succeeding locations will be examined.
64The
65.Fa flags
66argument may be specified as follows:
67.Bd -literal
68MS_ASYNC	Return immediately (not currently implemented)
69MS_SYNC		Perform synchronous writes
70MS_INVALIDATE	Invalidate all cached data
71.Ed
72.Sh RETURN VALUES
73If any errors occur, -1 is returned and errno is set to indicate the
74error. Otherwise, a 0 value is returned.
75.Sh ERRORS
76.Fn msync
77will fail if:
78.Bl -tag -width Er
79.It Bq Er EINVAL
80.Fa addr
81is not a multiple of the hardware page size.
82.It Bq Er EINVAL
83.Fa len
84is too large or negative.
85.It Bq Er EINVAL
86.Fa flags
87was both MS_ASYNC and MS_INVALIDATE. Only one of these flags is allowed.
88.It Bq Er EIO
89An I/O error occurred while writing to the file system.
90.Sh SEE ALSO
91.Xr madvise 2 ,
92.Xr mincore 2 ,
93.Xr mprotect 2 ,
94.Xr munmap 2
95.Sh HISTORY
96The
97.Fn msync
98function first appeared in
99.Bx 4.4 .
100