$NetBSD: msync.2,v 1.25 2014/05/09 17:25:11 njoly Exp $ Copyright (c) 1991, 1993 The Regents of the University of California. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. @(#)msync.2 8.2 (Berkeley) 6/21/94.Dd May 9, 2014
.Dt MSYNC 2
.Os
.Sh NAME
.Nm msync
.Nd synchronize a mapped region
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
n sys/mman.h .Ft int
.Fn msync "void *addr" "size_t len" "int flags"
.Sh DESCRIPTION
The
.Fn msync
system call writes all pages with shared modifications
in the specified
region of the process's address space back to permanent
storage, and, if requested, invalidates cached data mapped
in the region.
If
.Fa len
is 0, all modified pages within the region containing
.Fa addr
will be flushed;
if
.Fa len
is non-zero, only modified pages containing
.Fa addr
and
.Fa len
succeeding locations will be flushed.
Any required synchronization of memory caches
will also take place at this time.
Filesystem operations on a file that is mapped for shared modifications
are unpredictable except after an
.Fn msync .
p
The
.Fa flags
argument is formed by
.Em or Ns 'ing
the following values
p
l -column -offset indent -compact MS_INVALIDATE t Dv MS_ASYNC Ta Perform asynchronous writes. t Dv MS_SYNC Ta Perform synchronous writes. t Dv MS_INVALIDATE Ta Invalidate cached data after writing. .El
.Sh RETURN VALUES
Upon successful completion,
a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
The following errors may be reported:
l -tag -width Er t Bq Er EBUSY The
.Dv MS_INVALIDATE
flag was specified and a portion of the specified region
was locked with
.Xr mlock 2 .
t Bq Er EINVAL The specified
.Fa flags
argument was invalid.
t Bq Er EINVAL The
.Fa addr
parameter was not page aligned.
t Bq Er EINVAL The
.Fa addr
parameter did not specify an address part of a mapped region.
t Bq Er EIO An I/O error occurred while writing to the file system.
t Bq Er ENOMEM Addresses in the specified region are outside the range allowed
for the address space of the process, or specify one or more pages
which are unmapped.
.El
.Sh SEE ALSO
.Xr mlock 2 ,
.Xr mmap 2 ,
.Xr munlock 2
.Sh STANDARDS
The
.Fn msync
function conforms to
.St -p1003.1b-93
.Sh HISTORY
The
.Fn msync
function first appeared in
x 4.4 . It was modified to conform to
.St -p1003.1b-93
in
.Nx 1.3 .