draft/man2/fallocate.2

   1 .\" Copyright (c) 2007 Silicon Graphics, Inc. All Rights Reserved
   2 .\" Written by Dave Chinner <dgc@sgi.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2_ONELINE)
   5 .\" May be distributed as per GNU General Public License version 2.
   6 .\" %%%LICENSE_END
   7 .\"
   8 .\" 2011-09-19: Added FALLOC_FL_PUNCH_HOLE
   9 .\" 2011-09-19: Substantial restructuring of the page
  10 .\"
  11 .\"*******************************************************************
  12 .\"
  13 .\" This file was generated with po4a. Translate the source file.
  14 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" Japanese Version Copyright (c) 2007  Akihiro MOTOKI
  18 .\"         all rights reserved.
  19 .\" Translated 2007-10-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.66
  20 .\" Updated 2008-10-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.11
  21 .\" Updated 2013-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  22 .\" Updated 2013-05-07, Akihiro MOTOKI <amotoki@gmail.com>
  23 .\" Updated 2013-07-22, Akihiro MOTOKI <amotoki@gmail.com>
  24 .\"
  25 .TH FALLOCATE 2 2014\-05\-08 Linux "Linux Programmer's Manual"
  26 .SH 名前
  27 fallocate \- ファイル空間の操作
  28 .SH 書式
  29 .nf
  30 \fB#define _GNU_SOURCE\fP             /* feature_test_macros(7) 参照 */
  31 \fB#include <fcntl.h>\fP
  32
  33 \fBint fallocate(int \fP\fIfd\fP\fB, int \fP\fImode\fP\fB, off_t \fP\fIoffset\fP\fB, off_t \fP\fIlen\fP\fB);\fP
  34 .fi
  35 .SH 説明
  36 このシステムコールは、移植性のない、Linux 固有のシステムコールである。 移植性が必要な場合は、ファイルに対してディスク空間を確実に確保するために、
  37 POSIX.1 で規定された方法である \fBposix_fallocate\fP(3)  を使うこと。
  38
  39 \fBfallocate\fP()  を使うと、 \fIfd\fP が参照するファイルに割り当てられたディスク空間を直接操作できる。 操作対象は、
  40 \fIoffset\fP から始まる長さ \fIlen\fP バイトの領域である。
  41
  42 \fImode\fP 引き数は、指定された領域に対して実行する操作を指定する。
  43 サポートされている操作の詳細は以下のサブセクションで説明する。
  44 .SS ディスク領域の割り当て
  45 \fBfallocate\fP() のデフォルトの動作 (つまり \fImode\fP が 0 の場合) は、 \fIoffset\fP と \fIlen\fP
  46 で指定された範囲のディスク領域の割り当てを行う。 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きかった場合、 (\fBstat\fP(2)
  47 で報告される) ファイルサイズが変更される。 \fIoffset\fP と \fIlen\fP で指定される範囲のサブ領域で、
  48 呼び出し前にデータを保持していなかった場合、そのサブ領域は 0 で初期化される。 このデフォルトの動作は、 ライブラリ関数
  49 \fBposix_fallocate\fP(3) の動作と非常に似ている。 これは、 このシステムコールが \fBposix_fallocate\fP(3)
  50 を最適に実装する手段を提供することを目的としているからである。
  51
  52 呼び出しが成功した場合、
  53 \fIoffset\fP と \fIlen\fP で指定された範囲へのそれ以降の書き込みでは、
  54 ディスクの領域不足での書き込み失敗が起こらないことが保証される。
  55
  56 \fBFALLOC_FL_KEEP_SIZE\fP フラグが \fImode\fP に指定された場合、このシステムコール
  57 の動作は似ているが、 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きい場合で
  58 あってもファイルサイズは変更されない点が異なる。この場合のファイルの末尾
  59 よりも後ろの前もって割り当てられた 0 で埋められたブロックは、ファイルへの
  60 追記を最適化したい場合に役に立つ。
  61 .PP
  62 割り当てはブロックサイズ単位で行われるため、 \fBfallocate\fP() は指定されたより
  63 も大きなディスク領域を割り当てることがある。
  64 .SS ファイル空間の割り当て解除
  65 \fBFALLOC_FL_PUNCH_HOLE\fP フラグ (Linux 2.6.38 以降で利用可能) を \fImode\fP に指定すると、
  66 \fIoffset\fP で始まる \fIlen\fP バイトの領域の空間を解放する (ホールを作成する)。 指定された範囲のうち、
  67 部分的に使用しているファイルシステムブロックは 0 で埋められ、 全体を使用しているファイルシステムブロックはそのファイルから削除される。
  68 呼び出しが成功すると、 これ以降のこの範囲からの読み出しでは 0 を返す。
  69
  70 \fBFALLOC_FL_PUNCH_HOLE\fP フラグは \fBFALLOC_FL_KEEP_SIZE\fP と論理和 (OR) をとって \fImode\fP
  71 に指定しなければならない。 つまり、 ファイル末尾の punch off を行った場合でも、 (\fBstat\fP(2) で報告される)
  72 ファイルサイズが変化しない。
  73
  74 すべてのファイルシステムで \fBFALLOC_FL_PUNCH_HOLE\fP がサポートされているわけではない。
  75 ファイルシステムがこの操作をサポートしていない場合は、 エラーが返る。 この操作は少なくとも以下のファイルシステムでサポートされている。
  76 .IP * 3
  77 XFS (Linux 2.6.38 以降)
  78 .IP *
  79 .\" commit a4bb6b64e39abc0e41ca077725f2a72c868e7622
  80 ext4 (Linux 3.0 以降)
  81 .IP *
  82 Btrfs (Linux 3.7 以降)
  83 .IP *
  84 .\" commit 83e4fa9c16e4af7122e31be3eca5d57881d236fe
  85 tmpfs (Linux 3.5 以降)
  86 .SS ファイル空間の一部削除
  87 .\" commit 00f5e61998dd17f5375d9dfc01331f104b83f841
  88 \fBFALLOC_FL_COLLAPSE_RANGE\fP フラグ (Linux 3.15 以降で利用可能) を \fImode\fP に指定すると、
  89 指定したバイト範囲をファイルから削除する。 その際、ホールを残らない。 削除されるバイト範囲は \fIoffset\fP から始まる \fIlen\fP
  90 バイトの範囲である。 操作が完了すると、 ファイルの \fIoffset+len\fP の位置から始まる内容が \fIoffset\fP の位置に見えるようになり、
  91 ファイルのサイズは \fIlen\fP バイトだけ小さくなる。
  92
  93 効率的に動作する実装にするため、ファイルシステムはこの操作の粒度に制限を設けることがある。 通常は \fIoffset\fP と \fIlen\fP
  94 はファイルシステムの論理ブロックサイズの倍数でなければならない。 論理ブロックサイズはファイルシステムの種類や設定により様々である。
  95 ファイルシステムにこのような要求条件がある場合、 その要求条件が満たされていなければ、 \fBfallocate\fP はエラー \fBEINVAL\fP
  96 で失敗する。
  97
  98 \fIoffset\fP と \fIlen\fP で指定された範囲がファイルの末尾かそれより先まで達している場合、 エラーが返される。
  99 代わりに、ファイルの切り詰めを行う \fBftruncate\fP(2) を使用すること。
 100
 101 \fBFALLOC_FL_COLLAPSE_RANGE\fP と他のフラグを同時に \fImode\fP に指定することはできない。
 102
 103 .\" commit 9eb79482a97152930b113b51dff530aba9e28c8e
 104 .\" commit e1d8fb88a64c1f8094b9f6c3b6d2d9e6719c970d
 105 Linux 3.15 時点では \fBFALLOC_FL_COLLAPSE_RANGE\fP は ext4 (エクステントベースのファイル) と XFS
 106 でサポートされている。
 107 .SS "Zeroing file space"
 108 .\" commit 409332b65d3ed8cfa7a8030f1e9d52f372219642
 109 Specifying the \fBFALLOC_FL_ZERO_RANGE\fP flag (available since Linux 3.14)  in
 110 \fImode\fP zeroes space in the byte range starting at \fIoffset\fP and continuing
 111 for \fIlen\fP bytes.  Within the specified range, blocks are preallocated for
 112 the regions that span the holes in the file.  After a successful call,
 113 subsequent reads from this range will return zeroes.
 114
 115 Zeroing is done within the filesystem preferably by converting the range
 116 into unwritten extents.  This approach means that the specified range will
 117 not be physically zeroed out on the device (except for partial blocks at the
 118 either end of the range), and I/O is (otherwise) required only to update
 119 metadata.
 120
 121 If the \fBFALLOC_FL_KEEP_SIZE\fP flag is additionally specified in \fImode\fP, the
 122 behavior of the call is similar, but the file size will not be changed even
 123 if \fIoffset\fP+\fIlen\fP is greater than the file size.  This behaviour is the
 124 same as when preallocating space with \fBFALLOC_FL_KEEP_SIZE\fP specified.
 125
 126 すべてのファイルシステムで \fBFALLOC_FL_ZERO_RANGE\fP がサポートされているわけではない。
 127 ファイルシステムがこの操作をサポートしていない場合は、 エラーが返る。 この操作は少なくとも以下のファイルシステムでサポートされている。
 128 .IP * 3
 129 .\" commit 376ba313147b4172f3e8cf620b9fb591f3e8cdfa
 130 XFS (Linux 3.14 以降)
 131 .IP *
 132 .\" commit b8a8684502a0fc852afa0056c6bb2a9273f6fcc0
 133 ext4, for extent\-based files (since Linux 3.14)
 134 .SH 返り値
 135 成功の場合、 \fBfallocate\fP() は 0 を返す。 エラーの場合、\-1 を返し、 \fIerror\fP にエラーを示す値を設定する。
 136 .SH エラー
 137 .TP
 138 \fBEBADF\fP
 139 \fIfd\fP が有効なファイルディスクリプタでないか、 書き込み用としてオープンされていない。
 140 .TP
 141 \fBEFBIG\fP
 142 \fIoffset + len\fP がファイルサイズの最大値よりも大きい。
 143 .TP
 144 \fBEINTR\fP
 145 実行中にシグナルが捕捉された。
 146 .TP
 147 \fBEINVAL\fP
 148 .\" FIXME (raise a kernel bug) Probably the len==0 case should be
 149 .\" a no-op, rather than an error. That would be consistent with
 150 .\" similar APIs for the len==0 case.
 151 .\" See "Re: [PATCH] fallocate.2: add FALLOC_FL_PUNCH_HOLE flag definition"
 152 .\" 21 Sep 2012
 153 .\" http://thread.gmane.org/gmane.linux.file-systems/48331/focus=1193526
 154 \fIoffset\fP が 0 未満だったか、 \fIlen\fP が 0 以下だった。
 155 .TP
 156 \fBEINVAL\fP
 157 \fImode\fP が \fBFALLOC_FL_COLLAPSE_RANGE\fP で、 \fIoffset\fP と \fIlen\fP
 158 で指定された範囲がファイルの末尾かそれより先まで達している。
 159 .TP
 160 \fBEINVAL\fP
 161 \fImode\fP が \fBFALLOC_FL_COLLAPSE_RANGE\fP だが、 \fIoffset\fP か \fIlen\fP
 162 のいずれかがファイルシステムのブロックサイズの倍数ではない。
 163 .TP
 164 \fBEINVAL\fP
 165 \fImode\fP に \fBFALLOC_FL_COLLAPSE_RANGE\fP と他のフラグの両方が指定されている。
 166 \fBFALLOC_FL_COLLAPSE_RANGE\fP と他のフラグを一緒に使うことができない。
 167 .TP
 168 \fBEINVAL\fP
 169 .\" There was a inconsistency in 3.15-rc1, that should be resolved so that all
 170 .\" filesystems use this error for this case. (Tytso says ex4 will change.)
 171 .\" http://thread.gmane.org/gmane.comp.file-systems.xfs.general/60485/focus=5521
 172 .\" From: Michael Kerrisk (man-pages <mtk.manpages@...>
 173 .\" Subject: Re: [PATCH v5 10/10] manpage: update FALLOC_FL_COLLAPSE_RANGE flag in fallocate
 174 .\" Newsgroups: gmane.linux.man, gmane.linux.file-systems
 175 .\" Date: 2014-04-17 13:40:05 GMT
 176 \fImode\fP が \fBFALLOC_FL_COLLAPSE_RANGE\fP か \fBFALLOC_FL_ZERO_RANGE\fP だが、 \fIfd\fP
 177 が参照しているファイルが通常のファイルではない。
 178 .TP
 179 \fBEIO\fP
 180 ファイルシステムとの読み書き中に入出力エラーが発生した。
 181 .TP
 182 \fBENODEV\fP
 183 \fIfd\fP が通常のファイルかディレクトリを参照していない (\fIfd\fP がパイプや FIFO を参照している場合、別のエラーが発生する)。
 184 .TP
 185 \fBENOSPC\fP
 186 \fIfd\fP が参照するファイルを含むデバイスに十分な空き領域がない。
 187 .TP
 188 \fBENOSYS\fP
 189 このカーネルでは \fBfallocate\fP() は実装されていない。
 190 .TP
 191 \fBEOPNOTSUPP\fP
 192 \fIfd\fP が参照するファイルを含むファイルシステムが 指定された操作を
 193 サポートしていない。 \fIfd\fP が参照するファイルを含むファイルシステムが
 194 \fImode\fP をサポートしていない。
 195 .TP
 196 \fBEPERM\fP
 197 \fIfd\fP が参照するファイルに変更不可 (immutable) の属性が付いている (\fBchattr\fP(1) 参照)。 \fImode\fP に
 198 \fBFALLOC_FL_PUNCH_HOLE\fP か \fBFALLOC_FL_COLLAPSE_RANGE\fP が指定されたが、 \fIfd\fP
 199 が参照するファイルに追加のみ (append\-only) の属性が付いている (\fBchattr\fP(1) 参照)。
 200 .TP
 201 \fBESPIPE\fP
 202 \fIfd\fP がパイプか FIFO を参照している。
 203 .TP
 204 \fBETXTBSY\fP
 205 \fImode\fP に \fBFALLOC_FL_COLLAPSE_RANGE\fP が指定されたが、 \fIfd\fP が参照するファイルは現在実行中である。
 206 .SH バージョン
 207 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=14964
 208 \fBfallocate\fP()  はカーネル 2.6.23 以降の Linux で利用可能である。 glibc での対応はバージョン 3.10
 209 以降で行われている。 \fBFALLOC_FL_*\fP が glibc のヘッダファイルで定義されているのは、バージョン 2.18 以降のみである。
 210 .SH 準拠
 211 \fBfallocate\fP()  は Linux 固有である。
 212 .SH 関連項目
 213 \fBfallocate\fP(1), \fBftruncate\fP(2), \fBposix_fadvise\fP(3), \fBposix_fallocate\fP(3)
 214 .SH この文書について
 215 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.67 の一部
 216 である。プロジェクトの説明とバグ報告に関する情報は
 217 http://www.kernel.org/doc/man\-pages/ に書かれている。