xref: /netbsd-src/lib/libc/sys/msync.2 (revision ce0bb6e8d2e560ecacbe865a848624f94498063b)
1.\"	$NetBSD: msync.2,v 1.7 1995/02/27 10:41:44 cgd Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)msync.2	8.1 (Berkeley) 6/9/93
35.\"
36.Dd June 9, 1993
37.Dt MSYNC 2
38.Os
39.Sh NAME
40.Nm msync
41.Nd synchronize a mapped region
42.Sh SYNOPSIS
43.Fn msync "caddr_t addr" "int len"
44.Sh DESCRIPTION
45The
46.Fn msync
47system call
48writes any modified pages back to the filesystem and updates
49the file modification time.
50If
51.Fa len
52is 0, all modified pages within the region containing
53.Fa addr
54will be flushed;
55if
56.Fa len
57is non-zero, only the pages containing
58.Fa addr
59and
60.Fa len
61succeeding locations will be examined.
62Any required synchronization of memory caches
63will also take place at this time.
64Filesystem operations on a file that is mapped for shared modifications
65are unpredictable except after an
66.Fn msync .
67.Sh ERRORS
68The following errors may be reported:
69.Bl -tag -width Er
70.It Bq Er EINVAL
71The
72.Fa addr
73parameter was not page aligned.
74.It Bq Er EINVAL
75The
76.Fa addr
77parameter did not specify an address part of a mapped region.
78.It Bq Er EINVAL
79The
80.Fa len
81parameter was negative.
82.It Bq Er EIO
83An I/O error occured while writing to the file system.
84.Sh SEE ALSO
85.Xr madvise 2 ,
86.Xr munmap 2 ,
87.Xr mprotect 2 ,
88.Xr mincore 2
89.Sh HISTORY
90The
91.Fn msync
92function first appeared in 4.4BSD.
93