release/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\-01\-24 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 The default operation (i.e., \fImode\fP is zero) of \fBfallocate\fP()  allocates
  46 the disk space within the range specified by \fIoffset\fP and \fIlen\fP.  The file
  47 size (as reported by \fBstat\fP(2))  will be changed if \fIoffset\fP+\fIlen\fP is
  48 greater than the file size.  Any subregion within the range specified by
  49 \fIoffset\fP and \fIlen\fP that did not contain data before the call will be
  50 initialized to zero.  This default behavior closely resembles the behavior
  51 of the \fBposix_fallocate\fP(3)  library function, and is intended as a method
  52 of optimally implementing that function.
  53
  54 呼び出しが成功した場合、
  55 \fIoffset\fP と \fIlen\fP で指定された範囲へのそれ以降の書き込みでは、
  56 ディスクの領域不足での書き込み失敗が起こらないことが保証される。
  57
  58 \fBFALLOC_FL_KEEP_SIZE\fP フラグが \fImode\fP に指定された場合、このシステムコール
  59 の動作は似ているが、 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きい場合で
  60 あってもファイルサイズは変更されない点が異なる。この場合のファイルの末尾
  61 よりも後ろの前もって割り当てられた 0 で埋められたブロックは、ファイルへの
  62 追記を最適化したい場合に役に立つ。
  63 .PP
  64 割り当てはブロックサイズ単位で行われるため、 \fBfallocate\fP() は指定されたより
  65 も大きなディスク領域を割り当てることがある。
  66 .SS ファイル空間の割り当て解除
  67 \fBFALLOC_FL_PUNCH_HOLE\fP フラグ (Linux 2.6.38 以降で利用可能) を \fImode\fP に指定すると、
  68 \fIoffset\fP で始まる \fIlen\fP バイトの領域の空間を解放する (ホールを作成する)。 指定された範囲のうち、
  69 部分的に使用しているファイルシステムブロックは 0 で埋められ、 全体を使用しているファイルシステムブロックはそのファイルから削除される。
  70 呼び出しが成功すると、 これ以降のこの範囲からの読み出しでは 0 を返す。
  71
  72 \fBFALLOC_FL_PUNCH_HOLE\fP フラグは \fBFALLOC_FL_KEEP_SIZE\fP と論理和 (OR) をとって \fImode\fP
  73 に指定しなければならない。 つまり、 ファイル末尾の punch off を行った場合でも、 (\fBstat\fP(2) で報告される)
  74 ファイルサイズが変化しない。
  75
  76 Not all filesystems support \fBFALLOC_FL_PUNCH_HOLE\fP; if a filesystem doesn't
  77 support the operation, an error is returned.  The operation is supported on
  78 at least the following filesystems
  79 .IP * 3
  80 XFS (Linux 2.6.38 以降)
  81 .IP *
  82 .\" commit a4bb6b64e39abc0e41ca077725f2a72c868e7622
  83 ext4 (Linux 3.0 以降)
  84 .IP *
  85 Btrfs (Linux 3.7 以降)
  86 .IP *
  87 .\" commit 83e4fa9c16e4af7122e31be3eca5d57881d236fe
  88 tmpfs (Linux 3.5 以降)
  89 .SH 返り値
  90 成功の場合、 \fBfallocate\fP() は 0 を返す。 エラーの場合、\-1 を返し、 \fIerror\fP にエラーを示す値を設定する。
  91 .SH エラー
  92 .TP
  93 \fBEBADF\fP
  94 \fIfd\fP が有効なファイルディスクリプタでないか、 書き込み用としてオープンされていない。
  95 .TP
  96 \fBEFBIG\fP
  97 \fIoffset + len\fP がファイルサイズの最大値よりも大きい。
  98 .TP
  99 \fBEINTR\fP
 100 実行中にシグナルが捕捉された。
 101 .TP
 102 \fBEINVAL\fP
 103 .\" FIXME (raise a kernel bug) Probably the len==0 case should be
 104 .\" a no-op, rather than an error. That would be consistent with
 105 .\" similar APIs for the len==0 case.
 106 .\" See "Re: [PATCH] fallocate.2: add FALLOC_FL_PUNCH_HOLE flag definition"
 107 .\" 21 Sep 2012
 108 .\" http://thread.gmane.org/gmane.linux.file-systems/48331/focus=1193526
 109 \fIoffset\fP が 0 未満だったか、 \fIlen\fP が 0 以下だった。
 110 .TP
 111 \fBEIO\fP
 112 ファイルシステムとの読み書き中に入出力エラーが発生した。
 113 .TP
 114 \fBENODEV\fP
 115 \fIfd\fP が通常のファイルかディレクトリを参照していない (\fIfd\fP がパイプや FIFO を参照している場合、別のエラーが発生する)。
 116 .TP
 117 \fBENOSPC\fP
 118 \fIfd\fP が参照するファイルを含むデバイスに十分な空き領域がない。
 119 .TP
 120 \fBENOSYS\fP
 121 このカーネルでは \fBfallocate\fP() は実装されていない。
 122 .TP
 123 \fBEOPNOTSUPP\fP
 124 \fIfd\fP が参照するファイルを含むファイルシステムが 指定された操作を
 125 サポートしていない。 \fIfd\fP が参照するファイルを含むファイルシステムが
 126 \fImode\fP をサポートしていない。
 127 .TP
 128 \fBEPERM\fP
 129 \fIfd\fP が参照するファイルに変更不可 (immutable) の属性が付いている (\fBchattr\fP(1) 参照)。 \fImode\fP に
 130 \fBFALLOC_FL_PUNCH_HOLE\fP が指定されたが、 \fIfd\fP が参照するファイルに追加のみ (append\-only)
 131 の属性が付いている (\fBchattr\fP(1) 参照)。
 132 .TP
 133 \fBESPIPE\fP
 134 \fIfd\fP がパイプか FIFO を参照している。
 135 .SH バージョン
 136 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=14964
 137 \fBfallocate\fP()  はカーネル 2.6.23 以降の Linux で利用可能である。 glibc での対応はバージョン 3.10
 138 以降で行われている。 \fBFALLOC_FL_*\fP が glibc のヘッダファイルで定義されているのは、バージョン 2.18 以降のみである。
 139 .SH 準拠
 140 \fBfallocate\fP()  は Linux 固有である。
 141 .SH 関連項目
 142 \fBfallocate\fP(1), \fBftruncate\fP(2), \fBposix_fadvise\fP(3), \fBposix_fallocate\fP(3)
 143 .SH この文書について
 144 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.64 の一部
 145 である。プロジェクトの説明とバグ報告に関する情報は
 146 http://www.kernel.org/doc/man\-pages/ に書かれている。