(split) LDP v3.30, v3.31 の定型的な変更内容を反映。

[linuxjm/LDP_man-pages.git] / draft / man2 / msync.2

.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright (C) 1996 Andries Brouwer (aeb@cwi.nl)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
.\"         all rights reserved.
.\" Translated Sun Feb 23 19:45:43 JST 1997
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated and revised Fri Oct 24 23:34:51 JST 2003
.\"         by Suzuki Takashi.
.\" Updated 2007-01-01 by Kentaro Shirakata <argrath@ub32.org>
.\"
.\"WORD: in-core                ¥á¥â¥ê¾å¤Î
.\"
.TH MSYNC 2 2008-04-22 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O msync \- synchronize a file with a memory map
msync \- ¥Õ¥¡¥¤¥ë¤ò¥Þ¥Ã¥×¤·¤¿¥á¥â¥ê¤ÈƱ´ü¤µ¤»¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #include <sys/mman.h>
.sp
.BI "int msync(void *" addr ", size_t " length ", int " flags );
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .BR msync ()
.\"O flushes changes made to the in-core copy of a file that was mapped
.\"O into memory using
.\"O .BR mmap (2)
.\"O back to disk.
.\"O Without use of this call
.\"O there is no guarantee that changes are written back before
.\"O .BR munmap (2)
.\"O is called.
.\"O To be more precise, the part of the file that
.\"O corresponds to the memory area starting at
.\"O .I addr
.\"O and having length
.\"O .I length
.\"O is updated.
.BR msync ()
¤Ï
.BR mmap (2)
¤ò»È¤Ã¤Æ¥á¥â¥ê¤Ë¥Þ¥Ã¥×¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤Î¡¢
¥á¥â¥ê¾å¤Î¥³¥Ô¡¼¤Ë¤Ê¤µ¤ì¤¿Êѹ¹¤ò¥Ç¥£¥¹¥¯¤ËÈ¿±Ç¤µ¤»¤ë¡£
¤³¤Î´Ø¿ô¤ò»ÈÍѤ·¤Ê¤¤¤È¡¢
.BR munmap (2)
¤¬¸Æ¤Ó½Ð¤µ¤ì¤ë¤Þ¤ÇÊѹ¹¤¬½ñ¤­Ìᤵ¤ì¤ëÊݾڤϤʤ¤¡£
¤è¤êÀµ³Î¤Ë¤Ï¡¢¥Õ¥¡¥¤¥ë¤Î¤¦¤Á
.I addr
¤«¤é»Ï¤Þ¤êŤµ
.I length
¤Î¥á¥â¥êÎΰè¤ËÂбþ¤¹¤ëÉôʬ¤¬¹¹¿·¤µ¤ì¤ë¡£

.\"O The
.\"O .I flags
.\"O argument may have the bits
.\"O .BR MS_ASYNC ,
.\"O .BR MS_SYNC ,
.\"O and
.\"O .B MS_INVALIDATE
.\"O set, but not both
.\"O .B MS_ASYNC
.\"O and
.\"O .BR MS_SYNC .
.I flags
°ú¿ô¤Ë¤Ï¥Ó¥Ã¥È
.BR MS_ASYNC ,
.BR MS_SYNC ,
.B MS_INVALIDATE
¤òÀßÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤ë¤¬¡¢
.B MS_ASYNC
¤È
.B MS_SYNC
¤òƱ»þ¤Ë»ØÄꤹ¤ë¤³¤È¤Ï¤Ç¤­¤Ê¤¤¡£
.\"O .B MS_ASYNC
.\"O specifies that an update be scheduled, but the call
.\"O returns immediately.
.B MS_ASYNC
¤Ï¹¹¿·¤òͽÄê¤ËÁȤ߹þ¤à¤³¤È¤òɽ¤·¡¢¸Æ¤Ó½Ð¤·¤Ïľ¤Á¤ËÊ֤롣
.\"O .B MS_SYNC
.\"O asks for an update and waits for it to complete.
.B MS_SYNC
¤Ï¹¹¿·¤òÍ׵ᤷ¡¢¹¹¿·¤¬´°Î»¤¹¤ë¤Þ¤ÇÂԤġ£
.\"O .B MS_INVALIDATE
.\"O asks to invalidate other mappings of the same file
.\"O (so that they can be updated with the fresh values just written).
.B MS_INVALIDATE
¤Ï(¤¿¤Ã¤¿º£½ñ¤­¹þ¤ó¤À¿·¤·¤¤Ãͤǥޥåԥ󥰤ò¹¹¿·¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¤è¤¦¤Ë)
Ʊ¤¸¥Õ¥¡¥¤¥ë¤ËÂФ¹¤ë¾¤Î¥Þ¥Ã¥Ô¥ó¥°¤ò̵¸ú¤Ë¤¹¤ë¤³¤È¤òÍ׵᤹¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, zero is returned.
.\"O On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¡¢ 0 ¤¬Ê֤롣¥¨¥é¡¼¤Î¾ì¹ç¡¢ \-1 ¤¬Ê֤ꡢ
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EBUSY
.\"O .B MS_INVALIDATE
.\"O was specified in
.\"O .IR flags ,
.\"O and a memory lock exists for the specified address range.
I flags
¤Ë
.B MS_INVALIDATE
¤¬»ØÄꤵ¤ì¤¿¤¬¡¢»ØÄꤵ¤ì¤¿¥¢¥É¥ì¥¹ÈϰϤ˥í¥Ã¥¯¤¬Â¸ºß¤¹¤ë¡£
.TP
.B EINVAL
.\"O .I addr
.\"O is not a multiple of PAGESIZE; or any bit other than
.\"O .BR MS_ASYNC " | " MS_INVALIDATE " | " MS_SYNC
.\"O is set in
.\"O .IR flags ;
.\"O or both
.\"O .B MS_SYNC
.\"O and
.\"O .B MS_ASYNC
.\"O are set in
.\"O .IR flags .
.I addr
¤¬ PAGESIZE ¤ÎÇÜ¿ô¤Ç¤Ê¤¤¡£¤Þ¤¿¤Ï¡¢
.I flags
¤Ë
.BR MS_ASYNC ¡¢ MS_INVALIDATE ¡¢ MS_SYNC
°Ê³°¤Î¥Ó¥Ã¥È¤¬ÀßÄꤵ¤ì¤¿¡£
¤Þ¤¿¤Ï¡¢
.I flags
¤Ë
.B MS_SYNC
¤È
.B MS_ASYNC
¤ÎξÊý¤¬ÀßÄꤵ¤ì¤¿¡£
.TP
.B ENOMEM
.\"O The indicated memory (or part of it) was not mapped.
»ØÄꤵ¤ì¤¿¥á¥â¥ê (¤Þ¤¿¤Ï¤½¤Î°ìÉô) ¤¬¥Þ¥Ã¥×¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.

.\"O This call was introduced in Linux 1.3.21, and then used
.\"O .B EFAULT
.\"O instead of
.\"O .BR ENOMEM .
.\"O In Linux 2.4.19 this was changed to the POSIX value
.\"O .BR ENOMEM .
¤³¤Î´Ø¿ô¤Ï Linux 1.3.21 ¤ÇƳÆþ¤µ¤ì¤¿¤¬¡¢
.B ENOMEM
¤Ç¤Ï¤Ê¤¯
.B EFAULT
¤¬»È¤ï¤ì¤Æ¤¤¤¿¡£
¤³¤ì¤Ï Linux 2.4.19 ¤Ç POSIX ¤Ë¤ª¤±¤ëÃÍ
.B ENOMEM
¤ËÊѹ¹¤µ¤ì¤¿¡£
.\"O .SH AVAILABILITY
.SH ²ÄÍÑÀ­
.\"O On POSIX systems on which
.\"O .BR msync ()
.\"O is available, both
.\"O .B _POSIX_MAPPED_FILES
.\"O and
.\"O .B _POSIX_SYNCHRONIZED_IO
.\"O are defined in \fI<unistd.h>\fP to a value greater than 0.
.\"O (See also
.\"O .BR sysconf (3).)
.BR msync ()
¤¬»ÈÍѲÄǽ¤Ê POSIX ¥·¥¹¥Æ¥à¤Ç¤Ï
.B _POSIX_MAPPED_FILES
¤È
.B _POSIX_SYNCHRONIZED_IO
¤ÎξÊý¤¬ \fI<unistd.h>\fP ¤Ç 0 ¤è¤êÂ礭¤¤ÃͤËÄêµÁ¤µ¤ì¤ë¡£
.RB ( sysconf (3)
¤ò»²¾È¤¹¤ë¤³¤È¡£ )
.\"O .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L.
.\"O .\" -1: unavailable, 0: ask using sysconf().
.\"O .\" glibc defines them to 1.
.\" POSIX.1-2001: ¤³¤ì¤é¤ÎÃÍ¤Ï -1 ¤Þ¤¿¤Ï 0 ¤Þ¤¿¤Ï 200112L ¤ÈÄêµÁ¤µ¤ì¤ë¡£
.\" -1 ¤Ï»ÈÍÑÉÔ²Äǽ¡¢ 0 ¤Ï sysconf() ¤ËÌ䤤¹ç¤ï¤»¤ë
.\" glibc ¤Ç¤Ï 1 ¤ÈÄêµÁ¤·¤Æ¤¤¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR mmap (2)
.br
B.O. Gallmeister, POSIX.4, O'Reilly, pp. 128-129 and 389-391.