release/man2/posix_fadvise.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright 2003 Abhijit Menon-Sen <ams@wiw.org>
   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 .\"
  24 .\" 2005-04-08 mtk, noted kernel version and added BUGS
  25 .\" 2010-10-09, mtk, document arm_fadvise64_64()
  26 .\"
  27 .\"*******************************************************************
  28 .\"
  29 .\" This file was generated with po4a. Translate the source file.
  30 .\"
  31 .\"*******************************************************************
  32 .TH POSIX_FADVISE 2 2010\-10\-09 Linux "Linux Programmer's Manual"
  33 .SH 名前
  34 posix_fadvise \- ファイルデータのアクセスパターンをあらかじめ宣言する
  35 .SH 書式
  36 .nf
  37 \fB#include <fcntl.h>\fP
  38 .sp
  39 \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
  40 .fi
  41 .sp
  42 .ad l
  43 .in -4n
  44 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  45 .in
  46 .sp
  47 \fBposix_fadvise\fP():
  48 .RS 4
  49 _XOPEN_SOURCE\ >=\ 600 || _POSIX_C_SOURCE\ >=\ 200112L
  50 .RE
  51 .ad
  52 .SH 説明
  53 プログラムは、将来特定のパターンでファイルデータに アクセスする意思を伝えるために \fBposix_fadvise\fP()  を使うことができる。
  54 これにより、カーネルが適切な最適化を実行することが可能になる。
  55
  56 \fIadvice\fP は \fIfd\fP が参照しているファイルの \fIoffset\fP から始まる \fIlen\fP バイ
  57 トの範囲内 (\fIlen\fP が 0 の場合はファイルの終りまで) の (必ずしも存在しない)
  58 領域に適用される。 \fIadvice\fP は義務づけではない。 \fIadvice\fP は単にアプリケー
  59 ションのために可能性を構成するだけである。
  60
  61 \fIadvice\fP に許される値には、以下のものが含まれる:
  62 .TP
  63 \fBPOSIX_FADV_NORMAL\fP
  64 指定されたデータのアクセスパターンを指示するアドバイスを アプリケーションが何も持っていないことを示す。
  65 オープンされたファイルにアドバイスが指定されない場合、 これがデフォルトで仮定される。
  66 .TP
  67 \fBPOSIX_FADV_SEQUENTIAL\fP
  68 アプリケーションは指定されたデータがシーケンシャルに (大きなオフセットの前に小さなオフセットのデータを読むように)  アクセスされることを期待する。
  69 .TP
  70 \fBPOSIX_FADV_RANDOM\fP
  71 指定されたデータがランダムな順番でアクセスされる。
  72 .TP
  73 \fBPOSIX_FADV_NOREUSE\fP
  74 指定されたデータは 1 度しかアクセスされない。
  75 .TP
  76 \fBPOSIX_FADV_WILLNEED\fP
  77 指定されたデータは近い将来アクセスされる。
  78 .TP
  79 \fBPOSIX_FADV_DONTNEED\fP
  80 指定されたデータは近い将来アクセスされない。
  81 .SH 返り値
  82 成功した場合は 0 が返される。 失敗した場合はエラー番号が返される。
  83 .SH エラー
  84 .TP
  85 \fBEBADF\fP
  86 \fIfd\fP 引き数が有効なファイルディスクリプタでない。
  87 .TP
  88 \fBEINVAL\fP
  89 無効な値が \fIadvice\fP に指定された。
  90 .TP
  91 \fBESPIPE\fP
  92 指定されたファイルディスクリプタがパイプまたは FIFO を参照している (この場合、Linux は実際には \fBEINVAL\fP を返す)。
  93 .SH バージョン
  94 .\" of fadvise64_64()
  95 カーネルによるサポートは Linux 2.5.60 で最初に登場し、
  96 対応するシステムコールは \fBfadvise64\fP() という名前である。
  97 ライブラリによるサポートは glibc バージョン 2.2 以降で提供されており、
  98 ラッパー関数は \fBposix_fadvise\fP() という名前である。
  99 .SH 準拠
 100 POSIX.1\-2001.  \fIlen\fP 引き数の型が POSIX.1\-2003 TC1 において \fIsize_t\fP から \fIoff_t\fP
 101 に変更された点に注意すること。
 102 .SH 注意
 103 Linux では、\fBPOSIX_FADV_NORMAL\fP はバッキングデバイスの デフォルトサイズに先読み (readahead)
 104 ウインドウを設定する。 \fBPOSIX_FADV_SEQUENTIAL\fP はこのサイズを 2 倍し、 \fBPOSIX_FADV_RANDOM\fP
 105 は先読みを全く無効にする。 これらの変更はファイル全体に影響し、指定された領域のみに影響するわけではない
 106 (しかし同じファイルに対する他のオープンファイルハンドルは影響を受けない)。
 107
 108 \fBPOSIX_FADV_WILLNEED\fP は、 ページキャッシュに指定領域のブロックされない読み込みを開始する。 読み込まれるデータの総量は、
 109 仮想メモリの負荷に依ってカーネルが減らすかもしれない (数メガバイトであれば通常は全く十分であり、 それより多くてもめったに役に立たない)。
 110
 111 2.6.18 より前のカーネルでは、\fBPOSIX_FADV_NOREUSE\fP は \fBPOSIX_FADV_WILLNEED\fP と同じ意味であった。
 112 これは多分バグであった。 カーネル 2.6.18 以降では、このフラグは何も行わない。
 113
 114 \fBPOSIX_FADV_DONTNEED\fP は指定された領域に関連付けられた キャッシュページを解放しようとする。
 115 例えば、これは大きなファイルをストリーミングするときに役立つ。 プログラムは、使用済みのキャッシュされたデータを解放するように、
 116 定期的にカーネルに要求するかもしれない。 そうすることにより、さらに有効なキャッシュされたページが、 代わりに破棄されることはない。
 117
 118 まだ書き出されていないページは影響を受けないので、 そのページの解放が保証されることをアプリケーションが望んでいるなら、 最初に \fBfsync\fP(2)
 119 または \fBfdatasync\fP(2)  を呼ぶべきである。
 120 .SS arm_fadvise()
 121 ARM アーキテクチャでは、64 ビットの引き数は適切なレジスタの組に割り当て
 122 る必要がある。このアーキテクチャでは、\fBposix_fadvise\fP() の呼び出し方に
 123 は欠陥があり、それはこのシステムコールでは引き数 \fIfd\fP と \fIlen\fP の間の
 124 パディング (詰めもの) でレジスタが一つ消費されてしまうというものである。
 125 そのため、Linux 2.6.14 以降では、ARM では引き数が適切な順序になった別の
 126 システムコールが定義されている。
 127 .PP
 128 .in +4n
 129 .nf
 130 \fBlong arm_fadvise64_64(int \fP\fIfd\fP\fB, int \fP\fIadvice\fP\fB,\fP
 131 \fB                      loff_t \fP\fIoffset\fP\fB, loff_t \fP\fIlen\fP\fB);\fP
 132 .fi
 133 .in
 134 .PP
 135 .\" No ARM support in glibc.
 136 上記の点以外は、このシステムコールの動作は \fBposix_fadvise\fP() と全く
 137 同じである。このシステムコールに対するライブラリによるサポートは glibc
 138 では提供されていない。
 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.41 の一部
 148 である。プロジェクトの説明とバグ報告に関する情報は
 149 http://www.kernel.org/doc/man\-pages/ に書かれている。