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

[linuxjm/LDP_man-pages.git] / release / man2 / sync_file_range.2

.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright (c) 2006 Andrew Morton <akpm@osdl.org>
.\" and Copyright 2006 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" 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.
.\"
.\" 2006-07-05 Initial creation, Michael Kerrisk based on
.\"     Andrew Morton's comments in fs/sync.c
.\"
.\" Japanese Version Copyright (c) 2007 Akihiro MOTOKI
.\"         all rights reserved.
.\" Translated 2007-01-09, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.43
.\" Updated 2008-08-06, Akihiro MOTOKI, LDP v3.05
.\" Updated 2010-04-23, Akihiro MOTOKI, LDP v3.24
.\"
.TH SYNC_FILE_RANGE 2 2010-01-17 "Linux" "Linux Programmer's Manual"
.SH ̾Á°
sync_file_range \- ¥Õ¥¡¥¤¥ë¥»¥°¥á¥ó¥È¤ò¥Ç¥£¥¹¥¯¤ÈƱ´ü¤¹¤ë
.SH ½ñ¼°
.nf
.BR "#define _GNU_SOURCE" "         /* feature_test_macros(7) »²¾È */"
.B #include <fcntl.h>

.BI "int sync_file_range(int " fd ", off64_t " offset ", off64_t " nbytes ,
.BI "                    unsigned int " flags );
.fi
.SH ÀâÌÀ
.BR sync_file_range ()
¤ò»È¤¦¤È¡¢¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
.I fd
¤Ç»²¾È¤µ¤ì¤ë¥ª¡¼¥×¥ó¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤Î¥Ç¥£¥¹¥¯¤È¤ÎƱ´ü¤Ë´Ø¤·¤Æ¡¢
¤­¤áºÙ¤«¤ÊÀ©¸æ¤¬²Äǽ¤È¤Ê¤ë¡£

.I offset
¤Ï¡¢Æ±´ü¤ò¹Ô¤¦¥Õ¥¡¥¤¥ë¤ÎÎΰè¤Î³«»Ï¥Ð¥¤¥È¤Ç¤¢¤ë¡£
.I nbytes
¤Ë¤ÏƱ´ü¤ò¹Ô¤¦Îΰè¤ÎŤµ¤ò¥Ð¥¤¥Èñ°Ì¤Ç»ØÄꤹ¤ë¡£
.I nbytes
¤¬ 0 ¤Î¾ì¹ç¤Ï¡¢
.I offset
¤«¤é¥Õ¥¡¥¤¥ëËöÈø¤Þ¤Ç¤ÎÁ´¥Ð¥¤¥È¤òƱ´ü¤¹¤ë¡£
Ʊ´ü¤Ï¥·¥¹¥Æ¥à¤Î¥Ú¡¼¥¸¥µ¥¤¥º¤Îñ°Ì¤Ç¹Ô¤ï¤ì¤ë¡£
.I offset
¤Ï¥Ú¡¼¥¸¶­³¦¤Ë¤¢¤ï¤»¤ÆÀڤ겼¤²¤é¤ì¡¢
.I (offset+nbytes-1)
¤Ï¥Ú¡¼¥¸¶­³¦¤Ë¤¢¤ï¤»¤ÆÀÚ¤ê¾å¤²¤é¤ì¤ë¡£

¥Ó¥Ã¥È¥Þ¥¹¥¯°ú¤­¿ô
.I flags
¤Ë¤Ï°Ê²¼¤ÎÃͤò»ØÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤ë:
.TP
.B SYNC_FILE_RANGE_WAIT_BEFORE
²¿¤é¤«¤Î½ñ¤­¹þ¤ß¤ò¹Ô¤¦Á°¤Ë¡¢»ØÄꤵ¤ì¤¿Îΰè¤Î¥Ú¡¼¥¸¤Ç
½ñ¤­½Ð¤·¤ò¹Ô¤¦¤è¤¦¤Ë¥Ç¥Ð¥¤¥¹¥É¥é¥¤¥Ð¤Ë¤¹¤Ç¤ËÍ׵᤬ȯ¹Ô¤µ¤ì¤Æ¤¤¤ë
¥Ú¡¼¥¸¤Î½ñ¤­½Ð¤·¤¬Á´¤Æ´°Î»¤¹¤ë¤Î¤òÂԤġ£
.TP
.B SYNC_FILE_RANGE_WRITE
»ØÄꤵ¤ì¤¿Îΰè¤Î¥Ú¡¼¥¸¤Ç¡¢½ñ¤­½Ð¤·Í׵᤬ȯ¹Ô¤µ¤ì¤Æ¤¤¤Ê¤¤
Á´¤Æ¤Î dirty (¥­¥ã¥Ã¥·¥å¤À¤±¤¬Êѹ¹¤µ¤ì¤Æ¤¤¤ë) ¥Ú¡¼¥¸¤Î
½ñ¤­½Ð¤·¤ò³«»Ï¤¹¤ë¡£
¥ê¥¯¥¨¥¹¥È¥­¥å¡¼¤ÎÂ礭¤µ¤è¤ê¿¤¯½ñ¤­¹þ¤â¤¦¤È¤·¤¿¾ì¹ç¤Ë¤Ï¡¢
¤³¤Î½èÍý¤ÏÄä»ß (block) ¤¹¤ë²ÄǽÀ­¤¬¤¢¤ëÅÀ¤ËÃí°Õ¤¹¤ë¤³¤È¡£
.TP
.B SYNC_FILE_RANGE_WAIT_AFTER
²¿¤é¤«¤Î½ñ¤­¹þ¤ß¸å¤Ë¡¢»ØÄꤵ¤ì¤¿Îΰè¤ÎÁ´¤Æ¤Î¥Ú¡¼¥¸¤Î
½ñ¤­½Ð¤·¤¬¹Ô¤ï¤ì¤ë¤Î¤òÂԤġ£
.PP
.I flags
¤Ë 0 ¤ò»ØÄꤷ¤¿¾ì¹ç¡¢²¿¤â¤·¤Ê¤¤¤³¤È¤òɽ¤¹¡£
.SS ·Ù¹ð
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤ÏÈó¾ï¤Ë´í¸±¤Ç¤¢¤ê¡¢
°Ü¿¢À­¤¬É¬Í×¤Ê¥×¥í¥°¥é¥à¤Ç»ÈÍѤ¹¤Ù¤­¤Ç¤Ï¤Ê¤¤¡£
¤³¤ì¤é¤ÎÁàºî¤Ç¤Ï¤É¤ì¤â¥Õ¥¡¥¤¥ë¤Î¥á¥¿¥Ç¡¼¥¿¤Î½ñ¤­½Ð¤·¤ò¹Ô¤ï¤Ê¤¤¡£
¤·¤¿¤¬¤Ã¤Æ¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ë¤è¤êºîÀ®ºÑ¤ß¤Î¥Ç¥£¥¹¥¯¥Ö¥í¥Ã¥¯¤Î
¾å½ñ¤­¤Î¼Â¹Ô¤¬³Î¼Â¤Ë¹Ô¤ï¤ì¤Ê¤¤¸Â¤ê¡¢¥¯¥é¥Ã¥·¥å¤Î¸å¤Ç¤â¥Ç¡¼¥¿¤¬
ÍøÍѤǤ­¤ëÊݾڤϤʤ¤¡£
½ñ¤­¹þ¤ß¤¬¾å½ñ¤­¤À¤±¤Ç¤¢¤ë¤«¤òÃΤ뤿¤á¤Î¥æ¡¼¥¶¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ï¸ºß¤·¤Ê¤¤¡£
.RI ( btrfs
¤Ê¤É¤Î) copy-on-write Æ°ºî¤ò»È¤Ã¤¿¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ç¤Ï¡¢
´û¸¤Î³ä¤êÅö¤ÆºÑ¤ß¤Î¥Ö¥í¥Ã¥¯¤ËÂФ¹¤ë¾å½ñ¤­¼«ÂΤ¬¤Ç¤­¤Ê¤¤¡£
Á°¤â¤Ã¤Æ³ä¤êÅö¤Æ¤é¤ì¤¿Îΰè¤Ë½ñ¤­¹þ¤ß¤ò¹Ô¤¦¾ì¹ç¡¢
¿¤¯¤Î¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ç¤Ï block allocator ¤Ø¤Î½ñ¤­¹þ¤ß¤âɬÍפȤʤ뤬¡¢
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï block allocator ¤Î¥Ç¥£¥¹¥¯¤Ø¤ÎƱ´ü¤ò¹Ô¤ï¤Ê¤¤¡£
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï¥Ç¥£¥¹¥¯½ñ¤­¹þ¤ß¥­¥ã¥Ã¥·¥å¤Î¥Õ¥é¥Ã¥·¥å¤ò
¹Ô¤ï¤Ê¤¤¤Î¤Ç¡¢´øȯÀ­¤Î¥Ç¥£¥¹¥¯½ñ¤­¹þ¤ß¥­¥ã¥Ã¥·¥å¤ò»È¤Ã¤¿¥·¥¹¥Æ¥à¤Ç¤Ï
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ç¤Ï¥Ç¡¼¥¿¤Î°ì´ÓÀ­¤ò³ÎÊݤǤ­¤Ê¤¤¤³¤È¤Ë¤Ê¤ë¡£
.SS ¾ÜºÙ
.B SYNC_FILE_RANGE_WAIT_BEFORE
¤È
.B SYNC_FILE_RANGE_WAIT_AFTER
¤Ï I/O ¥¨¥é¡¼¤ä
.B ENOSPC
¾õÂÖ¤ò¸¡½Ð¤·¡¢¸Æ¤Ó½Ð¤·¸µ¤Ë¤³¤ì¤é¤Î¾ðÊó¤òÊÖ¤¹¡£

.I flags
¤ÎÌò¤ËΩ¤Ä¥Ó¥Ã¥È¤ÎÁȤ߹ç¤ï¤»¤ò°Ê²¼¤Ë¼¨¤¹:
.TP
.B SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE
»ØÄꤵ¤ì¤¿ÈÏ°ÏÆâ¤Î¥Ú¡¼¥¸¤Ç¡¢
.BR sync_file_range ()
¤¬¸Æ¤Ó½Ð¤µ¤ì¤¿ºÝ¤Ë dirty ¤Ç¤¢¤Ã¤¿Á´¤Æ¤Î¥Ú¡¼¥¸¤¬¡¢
³Î¼Â¤Ë½ñ¤­½Ð¤·ÂоݤȤʤë¤è¤¦¤Ë¤¹¤ë¡£
¤³¤ì¤Ï¡¢start-write-for-data-integrity Áàºî
(¥Ç¡¼¥¿´°Á´À­³ÎÊݤΤ¿¤á¤Î½ñ¤­¹þ¤ß³«»Ï¤ÎÁàºî) ¤Ç¤¢¤ë¡£
.TP
.B SYNC_FILE_RANGE_WRITE
»ØÄꤵ¤ì¤¿ÈÏ°ÏÆâ¤Î¥Ú¡¼¥¸¤Ç¡¢¸½ºß½ñ¤­½Ð¤·Ãæ¤Ç¤Ê¤¤Á´¤Æ¤Î dirty ¥Ú¡¼¥¸¤Î
½ñ¤­½Ð¤·¤ò³«»Ï¤¹¤ë¡£¤³¤ì¤ÏÈóƱ´ü¤Î¥Ç¥£¥¹¥¯¤Ø¤Î¥Õ¥é¥Ã¥·¥å (flush-to-disk)
Áàºî¤Ç¤¢¤ë¡£¥Ç¡¼¥¿´°Á´À­³ÎÊݤ¬É¬ÍפÊÁàºî¤È¤·¤Æ¤ÏŬÀڤǤϤʤ¤¡£
.TP
.BR SYNC_FILE_RANGE_WAIT_BEFORE " (or " SYNC_FILE_RANGE_WAIT_AFTER )
»ØÄꤵ¤ì¤¿ÈÏ°ÏÆâ¤ÎÁ´¤Æ¤Î¥Ú¡¼¥¸¤Î½ñ¤­½Ð¤·¤Î´°Î»¤òÂԤġ£
¤³¤Î¥Õ¥é¥°¤Ï¡¢Á°¤Ë¹Ô¤ï¤ì¤¿Áàºî
.B SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE
¤Î¸å¤Ë»ÈÍѤǤ­¡¢¤³¤ÎÁàºî¤Î´°Î»¤òÂÔ¤Á¡¢·ë²Ì¤ò¼èÆÀ¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.TP
.B SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE | \
SYNC_FILE_RANGE_WAIT_AFTER
¤³¤ì¤Ï write-for-data-integrity Áàºî
(¥Ç¡¼¥¿´°Á´À­³ÎÊݤΤ¿¤á¤Î½ñ¤­¹þ¤ß) ¤Ç¤¢¤ê¡¢»ØÄꤵ¤ì¤¿ÈÏ°ÏÆâ¤Î¡¢
.BR sync_file_range ()
¤¬¸Æ¤Ð¤ì¤¿»þÅÀ¤Ç dirty ¤ÊÁ´¤Æ¤Î¥Ú¡¼¥¸¤¬
¥Ç¥£¥¹¥¯¤Ë³ÊǼ¤µ¤ì¤ë¤³¤È¤¬Êݾڤµ¤ì¤ë¡£
.SH ÊÖ¤êÃÍ
À®¸ù¤Î¾ì¹ç¡¢
.BR sync_file_range ()
¤Ï 0 ¤òÊÖ¤¹¡£¼ºÇԤξì¹ç¡¢\-1 ¤òÊÖ¤·¡¢
.I error
¤Ë¥¨¥é¡¼¤ò¼¨¤¹ÃͤòÀßÄꤹ¤ë¡£
.SH ¥¨¥é¡¼
.TP
.B EBADF
.I fd
¤¬Í­¸ú¤Ê¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿¤Ç¤Ï¤Ê¤¤¡£
.TP
.B EINVAL
.I flags
¤ËÉÔÀµ¤Ê¥Ó¥Ã¥È¤¬»ØÄꤵ¤ì¤Æ¤¤¤ë¡£¤Þ¤¿¤Ï
.I offset
¤«
.I nbytes
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
.TP
.B EIO
I/O ¥¨¥é¡¼¡£
.TP
.B ENOMEM
¥á¥â¥êÉÔ­¤Ç¤¢¤ë¡£
.TP
.B ENOSPC
¥Ç¥£¥¹¥¯ÎΰèÉÔ­¤Ç¤¢¤ë¡£
.TP
.B ESPIPE
.I fd
¤¬¡¢Ä̾ï¤Î¥Õ¥¡¥¤¥ë¡¢¥Ö¥í¥Ã¥¯¥Ç¥Ð¥¤¥¹¡¢¥Ç¥£¥ì¥¯¥È¥ê¡¢¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯
°Ê³°¤Î¤â¤Î¤ò»Ø¤·¤Æ¤¤¤ë¡£
.\" FIXME . (bug?) Actually, how can 'fd' refer to a symbolic link (S_ISLNK)?
.\" (In userspace at least) it isn't possible to obtain a file descriptor
.\" for a symbolic link.
.SH ¥Ð¡¼¥¸¥ç¥ó
.BR sync_file_range ()
¤Ï¥«¡¼¥Í¥ë 2.6.17 ¤Ç Linux ¤ËÅо줷¤¿¡£
.SH ½àµò
¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤Ï Linux Æȼ«¤Ç¤¢¤ê¡¢
°Ü¿¢À­¤¬É¬Í×¤Ê¥×¥í¥°¥é¥à¤Ç¤Ï»ÈÍѤòÈò¤±¤ë¤Ù¤­¤Ç¤¢¤ë¡£
.SH ´ØÏ¢¹àÌÜ
.BR fdatasync (2),
.BR fsync (2),
.BR msync (2),
.BR sync (2)