draft/man2/posix_fadvise.2

   1 .\" Copyright 2003 Abhijit Menon-Sen <ams@wiw.org>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" 2005-04-08 mtk, noted kernel version and added BUGS
  26 .\" 2010-10-09, mtk, document arm_fadvise64_64()
  27 .\"
  28 .\"*******************************************************************
  29 .\"
  30 .\" This file was generated with po4a. Translate the source file.
  31 .\"
  32 .\"*******************************************************************
  33 .TH POSIX_FADVISE 2 2013\-04\-01 Linux "Linux Programmer's Manual"
  34 .SH 名前
  35 posix_fadvise \- ファイルデータのアクセスパターンをあらかじめ宣言する
  36 .SH 書式
  37 .nf
  38 \fB#include <fcntl.h>\fP
  39 .sp
  40 \fBint posix_fadvise(int \fP\fIfd\fP\fB, off_t \fP\fIoffset\fP\fB, off_t \fP\fIlen\fP\fB, int \fP\fIadvice\fP\fB);\fP
  41 .fi
  42 .sp
  43 .ad l
  44 .in -4n
  45 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  46 .in
  47 .sp
  48 \fBposix_fadvise\fP():
  49 .RS 4
  50 _XOPEN_SOURCE\ >=\ 600 || _POSIX_C_SOURCE\ >=\ 200112L
  51 .RE
  52 .ad
  53 .SH 説明
  54 プログラムは、将来特定のパターンでファイルデータに アクセスする意思を伝えるために \fBposix_fadvise\fP()  を使うことができる。
  55 これにより、カーネルが適切な最適化を実行することが可能になる。
  56
  57 \fIadvice\fP は \fIfd\fP が参照しているファイルの \fIoffset\fP から始まる \fIlen\fP バイ
  58 トの範囲内 (\fIlen\fP が 0 の場合はファイルの終りまで) の (必ずしも存在しない)
  59 領域に適用される。 \fIadvice\fP は義務づけではない。 \fIadvice\fP は単にアプリケー
  60 ションのために可能性を構成するだけである。
  61
  62 \fIadvice\fP に許される値には、以下のものが含まれる:
  63 .TP
  64 \fBPOSIX_FADV_NORMAL\fP
  65 指定されたデータのアクセスパターンを指示するアドバイスを アプリケーションが何も持っていないことを示す。
  66 オープンされたファイルにアドバイスが指定されない場合、 これがデフォルトで仮定される。
  67 .TP
  68 \fBPOSIX_FADV_SEQUENTIAL\fP
  69 アプリケーションは指定されたデータがシーケンシャルに (大きなオフセットの前に小さなオフセットのデータを読むように)  アクセスされることを期待する。
  70 .TP
  71 \fBPOSIX_FADV_RANDOM\fP
  72 指定されたデータがランダムな順番でアクセスされる。
  73 .TP
  74 \fBPOSIX_FADV_NOREUSE\fP
  75 指定されたデータは 1 度しかアクセスされない。
  76 .TP
  77 \fBPOSIX_FADV_WILLNEED\fP
  78 指定されたデータは近い将来アクセスされる。
  79 .TP
  80 \fBPOSIX_FADV_DONTNEED\fP
  81 指定されたデータは近い将来アクセスされない。
  82 .SH 返り値
  83 成功した場合は 0 が返される。 失敗した場合はエラー番号が返される。
  84 .SH エラー
  85 .TP
  86 \fBEBADF\fP
  87 \fIfd\fP 引き数が有効なファイルディスクリプタでない。
  88 .TP
  89 \fBEINVAL\fP
  90 無効な値が \fIadvice\fP に指定された。
  91 .TP
  92 \fBESPIPE\fP
  93 指定されたファイルディスクリプタがパイプまたは FIFO を参照している (この場合、Linux は実際には \fBEINVAL\fP を返す)。
  94 .SH バージョン
  95 .\" of fadvise64_64()
  96 カーネルによるサポートは Linux 2.5.60 で最初に登場し、
  97 対応するシステムコールは \fBfadvise64\fP() という名前である。
  98 ライブラリによるサポートは glibc バージョン 2.2 以降で提供されており、
  99 ラッパー関数は \fBposix_fadvise\fP() という名前である。
 100 .SH 準拠
 101 POSIX.1\-2001.  \fIlen\fP 引き数の型が POSIX.1\-2003 TC1 において \fIsize_t\fP から \fIoff_t\fP
 102 に変更された点に注意すること。
 103 .SH 注意
 104 Linux では、\fBPOSIX_FADV_NORMAL\fP はバッキングデバイスの デフォルトサイズに先読み (readahead)
 105 ウインドウを設定する。 \fBPOSIX_FADV_SEQUENTIAL\fP はこのサイズを 2 倍し、 \fBPOSIX_FADV_RANDOM\fP
 106 は先読みを全く無効にする。 これらの変更はファイル全体に影響し、指定された領域のみに影響するわけではない
 107 (しかし同じファイルに対する他のオープンファイルハンドルは影響を受けない)。
 108
 109 \fBPOSIX_FADV_WILLNEED\fP は、 ページキャッシュに指定領域のブロックされない読み込みを開始する。 読み込まれるデータの総量は、
 110 仮想メモリの負荷に依ってカーネルが減らすかもしれない (数メガバイトであれば通常は全く十分であり、 それより多くてもめったに役に立たない)。
 111
 112 2.6.18 より前のカーネルでは、\fBPOSIX_FADV_NOREUSE\fP は \fBPOSIX_FADV_WILLNEED\fP と同じ意味であった。
 113 これは多分バグであった。 カーネル 2.6.18 以降では、このフラグは何も行わない。
 114
 115 \fBPOSIX_FADV_DONTNEED\fP は指定された領域に関連付けられた キャッシュページを解放しようとする。
 116 例えば、これは大きなファイルをストリーミングするときに役立つ。 プログラムは、使用済みのキャッシュされたデータを解放するように、
 117 定期的にカーネルに要求するかもしれない。 そうすることにより、さらに有効なキャッシュされたページが、 代わりに破棄されることはない。
 118
 119 まだ書き出されていないページは影響を受けないので、 そのページの解放が保証されることをアプリケーションが望んでいるなら、 最初に \fBfsync\fP(2)
 120 または \fBfdatasync\fP(2)  を呼ぶべきである。
 121 .SS アーキテクチャ固有の派生バージョン
 122 いくつかのアーキテクチャでは、 64 ビットの引き数は適切なレジスタの組に割り当てる必要がある (\fBsyscall\fP(2) 参照)。
 123 このようなアーキテクチャでは、 「書式」に書かれている  \fBposix_fadvise\fP() の呼び出しシグネチャーで、 引き数 \fIfd\fP と
 124 \fIoffset\fP の間のパディング (詰めもの) でレジスタが一つ消費されてしまう。 そのため、
 125 これらのアーキテクチャでは引き数が適切な順序になった別のシステムコールが定義されているが、 それ以外は \fBposix_fadvise\fP()
 126 と全く同じである。
 127
 128 例えば、 Linux 2.6.14 以降では、 ARM には以下のシステムコールが存在する。
 129 .PP
 130 .in +4n
 131 .nf
 132 \fBlong arm_fadvise64_64(int \fP\fIfd\fP\fB, int \fP\fIadvice\fP\fB,\fP
 133 \fB                      loff_t \fP\fIoffset\fP\fB, loff_t \fP\fIlen\fP\fB);\fP
 134 .fi
 135 .in
 136 .PP
 137 通常、 glibc の \fBposix_fadvise\fP() ラッパー関数により、 これらのアーキテクチャ固有の詳細はアプリケーションには見えない。
 138 glibc のラッパー関数では、適切なアーキテクチャ固有のシステムコールが呼び出される。
 139 .SH バグ
 140 2.6.6 より前のカーネルでは、 \fIlen\fP に 0 が指定された場合、 「ファイルの終りまでの全てのバイト」という意味ではなく、 文字通り「0
 141 バイト」として解釈されていた。
 142 .SH 関連項目
 143 .\" FIXME . Write a posix_fadvise(3) page.
 144 \fBreadahead\fP(2), \fBsync_file_range\fP(2), \fBposix_fallocate\fP(3),
 145 \fBposix_madvise\fP(3)
 146 .SH この文書について
 147 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 148 である。プロジェクトの説明とバグ報告に関する情報は
 149 http://www.kernel.org/doc/man\-pages/ に書かれている。