FALLOCATE(2)

名前
fallocate - ファイル空間の操作

書式
#define _GNU_SOURCE             /* feature_test_macros(7) 参照 */
#include <fcntl.h>
int fallocate(int fd, int mode, off_t offset, off_t len);

説明
このシステムコールは、移植性のない、Linux 固有のシステムコールである。 移植性が必要な場合は、ファイルに対してディスク空間を確実に確保するために、 POSIX.1 で規定された方法である posix_fallocate(3) を使うこと。 fallocate() を使うと、 fd が参照するファイルに割り当てられたディスク空間を直接操作できる。 操作対象は、 offset から始まる長さ len バイトの領域である。 mode 引き数は、指定された領域に対して実行する操作を指定する。 サポートされている操作の詳細は以下のサブセクションで説明する。

  ディスク領域の割り当て
fallocate() のデフォルトの動作 (つまり mode が 0 の場合) は、 offset と len で指定された範囲のディスク領域の割り当てと初期化を行う。 offset+len がファイルサイズよりも大きかった場合、 (stat(2) で報告される) ファイルサイズが変更される。このデフォルトの動作は、 ライブラリ関数 posix_fallocate(3) の動作と非常に似ている。これは、 このシステムコールが posix_fallocate(3) を最適に実装する手段を提供する ことを目的としているからである。 呼び出しが成功した場合、 offset と len で指定された範囲へのそれ以降の書き込みでは、 ディスクの領域不足での書き込み失敗が起こらないことが保証される。 FALLOC_FL_KEEP_SIZE フラグが mode に指定された場合、このシステムコール の動作は似ているが、 offset+len がファイルサイズよりも大きい場合で あってもファイルサイズは変更されない点が異なる。この場合のファイルの末尾 よりも後ろの前もって割り当てられた 0 で埋められたブロックは、ファイルへの 追記を最適化したい場合に役に立つ。

割り当てはブロックサイズ単位で行われるため、 fallocate() は指定されたより も大きなディスク領域を割り当てることがある。

  ファイル空間の割り当て解除
Specifying the FALLOC_FL_PUNCH_HOLE flag (available since Linux 2.6.38) in mode deallocates space (i.e., creates a hole) in the byte range starting at offset and continuing for len bytes. Within the specified range, partial file system blocks are zeroed, and whole file system blocks are removed from the file. After a successful call, subsequent reads from this range will return zeroes. The FALLOC_FL_PUNCH_HOLE flag must be ORed with FALLOC_FL_KEEP_SIZE in mode; in other words, even when punching off the end of the file, the file size (as reported by stat(2)) does not change. Not all file systems support FALLOC_FL_PUNCH_HOLE; if a file system doesn't support the operation, an error is returned.

返り値
fallocate() は成功すると 0 を返し、エラーの場合は -1 を返す。

エラー

EBADF
    fd が有効なファイルディスクリプタでないか、 書き込み用としてオープンされていない。

EFBIG
    offset + len がファイルサイズの最大値よりも大きい。

EINTR
    実行中にシグナルが捕捉された。

EINVAL
    offset が 0 未満だったか、 len が 0 以下だった。

EIO ファイルシステムとの読み書き中に入出力エラーが発生した。

ENODEV
    fd が通常のファイルかディレクトリを参照していない (fd がパイプや FIFO を参照している場合、別のエラーが発生する)。

ENOSPC
    fd が参照するファイルを含むデバイスに十分な空き領域がない。

ENOSYS
    このカーネルでは fallocate() は実装されていない。

EOPNOTSUPP
    fd が参照するファイルを含むファイルシステムが 指定された操作を サポートしていない。 fd が参照するファイルを含むファイルシステムが mode をサポートしていない。

EPERM
    The file referred to by fd is marked immutable (see chattr(1)). Or: mode specifies FALLOC_FL_PUNCH_HOLE and the file referred to by fd is marked append-only (see chattr(1)).

ESPIPE
    fd がパイプか FIFO を参照している。

バージョン
fallocate() はカーネル 2.6.23 以降の Linux で利用可能である。 glibc での対応はバージョン 3.10 以降で行われている。 FALLOC_FL_* が glibc のヘッダファイルで定義されているのは、バージョン 2.18 以降のみである。

準拠
fallocate() は Linux 固有である。

関連項目
fallocate(1), ftruncate(2), posix_fadvise(3), posix_fallocate(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.51 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。