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 .TH FALLOCATE 2 2013\-06\-10 Linux "Linux Programmer's Manual"
  17 .SH 名前
  18 fallocate \- ファイル空間の操作
  19 .SH 書式
  20 .nf
  21 \fB#define _GNU_SOURCE\fP             /* feature_test_macros(7) 参照 */
  22 \fB#include <fcntl.h>\fP
  23
  24 \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
  25 .fi
  26 .SH 説明
  27 このシステムコールは、移植性のない、Linux 固有のシステムコールである。 移植性が必要な場合は、ファイルに対してディスク空間を確実に確保するために、
  28 POSIX.1 で規定された方法である \fBposix_fallocate\fP(3)  を使うこと。
  29
  30 \fBfallocate\fP()  を使うと、 \fIfd\fP が参照するファイルに割り当てられたディスク空間を直接操作できる。 操作対象は、
  31 \fIoffset\fP から始まる長さ \fIlen\fP バイトの領域である。
  32
  33 \fImode\fP 引き数は、指定された領域に対して実行する操作を指定する。
  34 サポートされている操作の詳細は以下のサブセクションで説明する。
  35 .SS ディスク領域の割り当て
  36 \fBfallocate\fP() のデフォルトの動作 (つまり \fImode\fP が 0 の場合) は、
  37 \fIoffset\fP と \fIlen\fP で指定された範囲のディスク領域の割り当てと初期化を行う。
  38 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きかった場合、
  39 (\fBstat\fP(2) で報告される) ファイルサイズが変更される。このデフォルトの動作は、
  40 ライブラリ関数 \fBposix_fallocate\fP(3) の動作と非常に似ている。これは、
  41 このシステムコールが \fBposix_fallocate\fP(3) を最適に実装する手段を提供する
  42 ことを目的としているからである。
  43
  44 呼び出しが成功した場合、
  45 \fIoffset\fP と \fIlen\fP で指定された範囲へのそれ以降の書き込みでは、
  46 ディスクの領域不足での書き込み失敗が起こらないことが保証される。
  47
  48 \fBFALLOC_FL_KEEP_SIZE\fP フラグが \fImode\fP に指定された場合、このシステムコール
  49 の動作は似ているが、 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きい場合で
  50 あってもファイルサイズは変更されない点が異なる。この場合のファイルの末尾
  51 よりも後ろの前もって割り当てられた 0 で埋められたブロックは、ファイルへの
  52 追記を最適化したい場合に役に立つ。
  53 .PP
  54 割り当てはブロックサイズ単位で行われるため、 \fBfallocate\fP() は指定されたより
  55 も大きなディスク領域を割り当てることがある。
  56 .SS ファイル空間の割り当て解除
  57 \fBFALLOC_FL_PUNCH_HOLE\fP フラグ (Linux 2.6.38 以降で利用可能) を \fImode\fP に指定すると、
  58 \fIoffset\fP で始まる \fIlen\fP バイトの領域の空間を解放する (ホールを作成する)。 指定された範囲のうち、
  59 部分的に使用しているファイルシステムブロックは 0 で埋められ、 全体を使用しているファイルシステムブロックはそのファイルから削除される。
  60 呼び出しが成功すると、 これ以降のこの範囲からの読み出しでは 0 を返す。
  61
  62 \fBFALLOC_FL_PUNCH_HOLE\fP フラグは \fBFALLOC_FL_KEEP_SIZE\fP と論理和 (OR) をとって \fImode\fP
  63 に指定しなければならない。 つまり、 ファイル末尾の punch off を行った場合でも、 (\fBstat\fP(2) で報告される)
  64 ファイルサイズが変化しない。
  65
  66 すべてのファイルシステムで \fBFALLOC_FL_PUNCH_HOLE\fP がサポートされているわけではない。
  67 ファイルシステムがこの操作をサポートしていない場合は、 エラーが返る。
  68 .SH 返り値
  69 成功の場合、 \fBfallocate\fP() は 0 を返す。 エラーの場合、\-1 を返し、 \fIerror\fP にエラーを示す値を設定する。
  70 .SH エラー
  71 .TP
  72 \fBEBADF\fP
  73 \fIfd\fP が有効なファイルディスクリプタでないか、 書き込み用としてオープンされていない。
  74 .TP
  75 \fBEFBIG\fP
  76 \fIoffset + len\fP がファイルサイズの最大値よりも大きい。
  77 .TP
  78 \fBEINTR\fP
  79 実行中にシグナルが捕捉された。
  80 .TP
  81 \fBEINVAL\fP
  82 .\" FIXME (raise a kernel bug) Probably the len==0 case should be
  83 .\" a no-op, rather than an error. That would be consistent with
  84 .\" similar APIs for the len==0 case.
  85 .\" See "Re: [PATCH] fallocate.2: add FALLOC_FL_PUNCH_HOLE flag definition"
  86 .\" 21 Sep 2012
  87 .\" http://thread.gmane.org/gmane.linux.file-systems/48331/focus=1193526
  88 \fIoffset\fP が 0 未満だったか、 \fIlen\fP が 0 以下だった。
  89 .TP
  90 \fBEIO\fP
  91 ファイルシステムとの読み書き中に入出力エラーが発生した。
  92 .TP
  93 \fBENODEV\fP
  94 \fIfd\fP が通常のファイルかディレクトリを参照していない (\fIfd\fP がパイプや FIFO を参照している場合、別のエラーが発生する)。
  95 .TP
  96 \fBENOSPC\fP
  97 \fIfd\fP が参照するファイルを含むデバイスに十分な空き領域がない。
  98 .TP
  99 \fBENOSYS\fP
 100 このカーネルでは \fBfallocate\fP() は実装されていない。
 101 .TP
 102 \fBEOPNOTSUPP\fP
 103 \fIfd\fP が参照するファイルを含むファイルシステムが 指定された操作を
 104 サポートしていない。 \fIfd\fP が参照するファイルを含むファイルシステムが
 105 \fImode\fP をサポートしていない。
 106 .TP
 107 \fBEPERM\fP
 108 \fIfd\fP が参照するファイルに変更不可 (immutable) の属性が付いている (\fBchattr\fP(1) 参照)。 \fImode\fP に
 109 \fBFALLOC_FL_PUNCH_HOLE\fP が指定されたが、 \fIfd\fP が参照するファイルに追加のみ (append\-only)
 110 の属性が付いている (\fBchattr\fP(1) 参照)。
 111 .TP
 112 \fBESPIPE\fP
 113 \fIfd\fP がパイプか FIFO を参照している。
 114 .SH バージョン
 115 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=14964
 116 \fBfallocate\fP()  はカーネル 2.6.23 以降の Linux で利用可能である。 glibc での対応はバージョン 3.10
 117 以降で行われている。 \fBFALLOC_FL_*\fP が glibc のヘッダファイルで定義されているのは、バージョン 2.18 以降のみである。
 118 .SH 準拠
 119 \fBfallocate\fP()  は Linux 固有である。
 120 .SH 関連項目
 121 \fBfallocate\fP(1), \fBftruncate\fP(2), \fBposix_fadvise\fP(3), \fBposix_fallocate\fP(3)
 122 .SH この文書について
 123 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 124 である。プロジェクトの説明とバグ報告に関する情報は
 125 http://www.kernel.org/doc/man\-pages/ に書かれている。