Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
#include <sys/mman.h> int msync(void *addr, size_t len, int flags);
The msync() function writes all modified copies of pages over the range [addr, addr + len) to the underlying hardware, or invalidates any copies so that further references to the pages will be obtained by the system from their permanent storage locations. The permanent storage for a modified MAP_SHARED mapping is the file the page is mapped to; the permanent storage for a modified MAP_PRIVATE mapping is its swap area.
The flags argument is a bit pattern built from the following values: MS_ASYNC
perform asynchronous writes
perform synchronous writes
invalidate mappings
If flags is MS_ASYNC or MS_SYNC, the function synchronizes the file contents to match the current contents of the memory region.
All write references to the memory region made prior to the call are visible by subsequent read operations on the file.
All writes to the same portion of the file prior to the call may or may not be visible by read references to the memory region.
Unmodified pages in the specified range are not written to the underlying hardware.
If flags is MS_ASYNC, the function may return immediately once all write operations are scheduled; if flags is MS_SYNC, the function does not return until all write operations are completed.
If flags is MS_INVALIDATE, the function synchronizes the contents of the memory region to match the current file contents.
All writes to the mapped portion of the file made prior to the call are visible by subsequent read references to the mapped memory region.
All write references prior to the call, by any process, to memory regions mapped to the same portion of the file using MAP_SHARED, are visible by read references to the region.
If msync() causes any write to the file, then the file's st_ctime and st_mtime fields are marked for update.
Upon successful completion, msync() returns 0; otherwise, it returns -1 and sets errno to indicate the error.
The msync() function will fail if: EBUSY
Some or all of the addresses in the range [addr, addr + len) are locked and MS_SYNC with the MS_INVALIDATE option is specified.
Some or all pages in the range [addr, addr + len) are locked for I/O.
The addr argument is not a multiple of the page size as returned by sysconf(3C). The flags argument is not some combination of MS_ASYNC and MS_INVALIDATE.
An I/O error occurred while reading from or writing to the file system.
Addresses in the range [addr, addr + len) are outside the valid range for the address space of a process, or specify one or more pages that are not mapped.
MS_INVALIDATE was specified and one or more of the pages is locked in memory.
The msync() function should be used by programs that require a memory object to be in a known state, for example in building transaction facilities.
Normal system activity can cause pages to be written to disk. Therefore, there are no guarantees that msync() is the only control over when pages are or are not written to disk.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
| MT-Level MT-Safe |
memcntl(2), mmap(2), sysconf(3C), attributes(5), standards(5)