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 2013\-06\-10 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 の場合) は、
  46 \fIoffset\fP と \fIlen\fP で指定された範囲のディスク領域の割り当てと初期化を行う。
  47 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きかった場合、
  48 (\fBstat\fP(2) で報告される) ファイルサイズが変更される。このデフォルトの動作は、
  49 ライブラリ関数 \fBposix_fallocate\fP(3) の動作と非常に似ている。これは、
  50 このシステムコールが \fBposix_fallocate\fP(3) を最適に実装する手段を提供する
  51 ことを目的としているからである。
  52
  53 呼び出しが成功した場合、
  54 \fIoffset\fP と \fIlen\fP で指定された範囲へのそれ以降の書き込みでは、
  55 ディスクの領域不足での書き込み失敗が起こらないことが保証される。
  56
  57 \fBFALLOC_FL_KEEP_SIZE\fP フラグが \fImode\fP に指定された場合、このシステムコール
  58 の動作は似ているが、 \fIoffset\fP+\fIlen\fP がファイルサイズよりも大きい場合で
  59 あってもファイルサイズは変更されない点が異なる。この場合のファイルの末尾
  60 よりも後ろの前もって割り当てられた 0 で埋められたブロックは、ファイルへの
  61 追記を最適化したい場合に役に立つ。
  62 .PP
  63 割り当てはブロックサイズ単位で行われるため、 \fBfallocate\fP() は指定されたより
  64 も大きなディスク領域を割り当てることがある。
  65 .SS ファイル空間の割り当て解除
  66 Specifying the \fBFALLOC_FL_PUNCH_HOLE\fP flag (available since Linux 2.6.38)
  67 in \fImode\fP deallocates space (i.e., creates a hole)  in the byte range
  68 starting at \fIoffset\fP and continuing for \fIlen\fP bytes.  Within the specified
  69 range, partial filesystem blocks are zeroed, and whole filesystem blocks are
  70 removed from the file.  After a successful call, subsequent reads from this
  71 range will return zeroes.
  72
  73 \fBFALLOC_FL_PUNCH_HOLE\fP フラグは \fBFALLOC_FL_KEEP_SIZE\fP と論理和 (OR) をとって \fImode\fP
  74 に指定しなければならない。 つまり、 ファイル末尾の punch off を行った場合でも、 (\fBstat\fP(2) で報告される)
  75 ファイルサイズが変化しない。
  76
  77 Not all filesystems support \fBFALLOC_FL_PUNCH_HOLE\fP; if a filesystem doesn't
  78 support the operation, an error is returned.
  79 .SH 返り値
  80 成功の場合、 \fBfallocate\fP() は 0 を返す。 エラーの場合、\-1 を返し、 \fIerror\fP にエラーを示す値を設定する。
  81 .SH エラー
  82 .TP
  83 \fBEBADF\fP
  84 \fIfd\fP が有効なファイルディスクリプタでないか、 書き込み用としてオープンされていない。
  85 .TP
  86 \fBEFBIG\fP
  87 \fIoffset + len\fP がファイルサイズの最大値よりも大きい。
  88 .TP
  89 \fBEINTR\fP
  90 実行中にシグナルが捕捉された。
  91 .TP
  92 \fBEINVAL\fP
  93 .\" FIXME (raise a kernel bug) Probably the len==0 case should be
  94 .\" a no-op, rather than an error. That would be consistent with
  95 .\" similar APIs for the len==0 case.
  96 .\" See "Re: [PATCH] fallocate.2: add FALLOC_FL_PUNCH_HOLE flag definition"
  97 .\" 21 Sep 2012
  98 .\" http://thread.gmane.org/gmane.linux.file-systems/48331/focus=1193526
  99 \fIoffset\fP が 0 未満だったか、 \fIlen\fP が 0 以下だった。
 100 .TP
 101 \fBEIO\fP
 102 An I/O error occurred while reading from or writing to a filesystem.
 103 .TP
 104 \fBENODEV\fP
 105 \fIfd\fP が通常のファイルかディレクトリを参照していない (\fIfd\fP がパイプや FIFO を参照している場合、別のエラーが発生する)。
 106 .TP
 107 \fBENOSPC\fP
 108 \fIfd\fP が参照するファイルを含むデバイスに十分な空き領域がない。
 109 .TP
 110 \fBENOSYS\fP
 111 このカーネルでは \fBfallocate\fP() は実装されていない。
 112 .TP
 113 \fBEOPNOTSUPP\fP
 114 The filesystem containing the file referred to by \fIfd\fP does not support
 115 this operation; or the \fImode\fP is not supported by the filesystem containing
 116 the file referred to by \fIfd\fP.
 117 .TP
 118 \fBEPERM\fP
 119 \fIfd\fP が参照するファイルに変更不可 (immutable) の属性が付いている (\fBchattr\fP(1) 参照)。 \fImode\fP に
 120 \fBFALLOC_FL_PUNCH_HOLE\fP が指定されたが、 \fIfd\fP が参照するファイルに追加のみ (append\-only)
 121 の属性が付いている (\fBchattr\fP(1) 参照)。
 122 .TP
 123 \fBESPIPE\fP
 124 \fIfd\fP がパイプか FIFO を参照している。
 125 .SH バージョン
 126 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=14964
 127 \fBfallocate\fP()  はカーネル 2.6.23 以降の Linux で利用可能である。 glibc での対応はバージョン 3.10
 128 以降で行われている。 \fBFALLOC_FL_*\fP が glibc のヘッダファイルで定義されているのは、バージョン 2.18 以降のみである。
 129 .SH 準拠
 130 \fBfallocate\fP()  は Linux 固有である。
 131 .SH 関連項目
 132 \fBfallocate\fP(1), \fBftruncate\fP(2), \fBposix_fadvise\fP(3), \fBposix_fallocate\fP(3)
 133 .SH この文書について
 134 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.54 の一部
 135 である。プロジェクトの説明とバグ報告に関する情報は
 136 http://www.kernel.org/doc/man\-pages/ に書かれている。