release/man7/inotify.7

   1 .\" t
   2 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\"*******************************************************************
  27 .\"
  28 .\" This file was generated with po4a. Translate the source file.
  29 .\"
  30 .\"*******************************************************************
  31 .TH INOTIFY 7 2013\-02\-25 Linux "Linux Programmer's Manual"
  32 .SH 名前
  33 inotify \- ファイルシステムイベントを監視する
  34 .SH 説明
  35 \fIinotify\fP API はファイルシステムイベントを監視するための機構を提供する。 inotify
  36 は個々のファイルやディレクトリを監視するのに使える。 ディレクトリを監視する場合、inotify はディレクトリ自身と
  37 ディレクトリ内のファイルのイベントを返す。
  38
  39 以下のシステムコールがこの API と共に使用される: \fBinotify_init\fP(2)  (や \fBinotify_init1\fP(2)),
  40 \fBinotify_add_watch\fP(2), \fBinotify_rm_watch\fP(2), \fBread\fP(2), \fBclose\fP(2).
  41
  42 \fBinotify_init\fP(2)  は inotify インスタンスを作成し、inotify インスタンスを参照する ファイルディスクリプタを返す。
  43 もっと新しい \fBinotify_init1\fP(2)  も \fBinotify_init\fP(2)  と同様だが、いくつかの追加の機能が提供されている。
  44
  45 \fBinotify_add_watch\fP(2)  は inotify インスタンスに関連づけられた「監視対象 (watch) リスト」を操作する。
  46 監視対象リストの各アイテム ("watch") は、 ファイルまたはディレクトリのパス名と、 そのパス名で参照されるファイルに対して
  47 カーネルが監視する複数のイベントの集合を指定する。 \fBinotify_add_watch\fP(2)
  48 は新しい監視アイテムの作成や既存の監視対象の変更ができる。 各監視対象は一意の「監視対象ディスクリプタ」を持つ。 これは監視対象を作成したときに
  49 \fBinotify_add_watch\fP(2)  から返される整数である。
  50
  51 \fBinotify_rm_watch\fP(2)  は inotify の監視対象リストからアイテムを削除する。
  52
  53 inotify インスタンスを指している 全てのファイルディスクリプタがクローズされた場合、 その下層にあるオブジェクトとそのリソースは、
  54 カーネルで再利用するために解放される。 関連が切られた監視対象は自動的に解放される。
  55
  56 どのようなイベントが起こっていたかを知るには、 アプリケーションで inotify ファイルディスクリプタを \fBread\fP(2)  すればよい。
  57 これまでに何もイベントが起こっていない場合、 停止 (blocking) モードのファイルディスクリプタであれば、 少なくとも 1
  58 つのイベントが起こるまで \fBread\fP(2)  は停止する (シグナルにより割り込まれなかった場合。
  59 シグナルによる割り込みがあった場合、呼び出しはエラー \fBEINTR\fP で失敗する。 \fBsignal\fP(7)  参照)。
  60
  61 \fBread\fP(2)  が成功すると、以下の構造体を 1 つ以上含むバッファが返される:
  62 .in +4n
  63 .nf
  64
  65 .\" FIXME . The type of the 'wd' field should probably be "int32_t".
  66 .\" I submitted a patch to fix this.  See the LKML thread
  67 .\" "[patch] Fix type errors in inotify interfaces", 18 Nov 2008
  68 .\" Glibc bug filed: http://sources.redhat.com/bugzilla/show_bug.cgi?id=7040
  69 struct inotify_event {
  70     int      wd;       /* 監視対象ディスクリプタ */
  71     uint32_t mask;     /* イベントのマスク */
  72     uint32_t cookie;   /* 関連するイベント群を関連づける
  73                           一意なクッキー (rename(2) 用) */
  74     uint32_t len;      /* \(aqname\(aq フィールドのサイズ */
  75     char     name[];   /* NULL で終端された任意の名前 */
  76 };
  77 .fi
  78 .in
  79
  80 \fIwd\fP はイベント発生の監視対象を指定する。 これは、前もって行われた \fBinotify_add_watch\fP(2)
  81 呼び出しで返された監視対象ディスクリプタのうちの 1 つである。
  82
  83 \fImask\fP には発生したイベント (下記参照) を記述するためのビットが含まれる。
  84
  85 \fIcookie\fP は関連するイベントを関連づけるための一意な整数である。
  86 現在のところ、この値は rename イベントに対してのみ使われており、
  87 結果のペアである \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントを
  88 アプリケーションで関連づけることができる。
  89 他のイベント種別の場合には、 \fIcookie\fP は 0 に設定する。
  90
  91 \fIname\fP フィールドは監視しているディレクトリ内のファイルに対して イベントが返される場合のためにだけ存在する。
  92 監視するディレクトリからのファイルの相対パス名を表す。 このパス名は NULL で終端され、 その後の読み込みで適切なアドレス境界に調整するために、
  93 さらに NULL バイトが含まれる場合もある。
  94
  95 \fIlen\fP フィールドは NULL バイトを含む \fIname\fP の全てのバイト数を表す。
  96 よって、 \fIinotify_event\fP 構造体のサイズは
  97 \fIsizeof(struct inotify_event)+len\fP である。
  98
  99 \fBread\fP(2) に渡されたバッファが小さすぎて次のイベントに関する情報を返せ
 100 ない場合の動作はカーネルのバージョンにより異なる。 2.6.21 より前のカー
 101 ネルでは、 \fBread\fP(2) は 0 を返す。 2.6.21 以降のカーネルでは、
 102 \fBread\fP(2) はエラー \fBEINVAL\fP で失敗する。
 103 バッファサイズとして
 104
 105     sizeof(struct inotify_event) + NAME_MAX + 1
 106
 107 を指定すれば、少なくとも 1 イベントで読み出しを行うには十分である。
 108 .SS "inotify イベント"
 109 \fBinotify_add_watch\fP(2)  の \fImask\fP 引き数と、inotify ファイル構造体を \fBread\fP(2)
 110 したときに返される \fIinotify_event\fP 構造体の \fImask\fP フィールドは、ともに inotify イベントを識別するための
 111 ビットマスクである。 以下のビットが \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定可能であり、
 112 \fBread\fP(2)  で返される \fImask\fP フィールドで返される:
 113 .RS 4
 114 .sp
 115 .PD 0
 116 .TP  18
 117 \fBIN_ACCESS\fP
 118 ファイルがアクセス (read) された。(*)
 119 .TP
 120 \fBIN_ATTRIB\fP
 121 メタデータが変更された。 メタデータとは、例えば、許可 (permission)、タイムスタンプ、拡張属性、 リンクカウント (Linux 2.6.25
 122 以降)、UID、GID などである。(*)
 123 .TP
 124 \fBIN_CLOSE_WRITE\fP
 125 書き込みのためにオープンされたファイルがクローズされた。(*)
 126 .TP
 127 \fBIN_CLOSE_NOWRITE\fP
 128 書き込み以外のためにオープンされたファイルがクローズされた。(*)
 129 .TP
 130 \fBIN_CREATE\fP
 131 監視対象ディレクトリ内でファイルやディレクトリが作成された。(*)
 132 .TP
 133 \fBIN_DELETE\fP
 134 監視対象ディレクトリ内でファイルやディレクトリが削除された。(*)
 135 .TP
 136 \fBIN_DELETE_SELF\fP
 137 監視対象のディレクトリまたはファイル自身が削除された。
 138 .TP
 139 \fBIN_MODIFY\fP
 140 ファイルが修正された。(*)
 141 .TP
 142 \fBIN_MOVE_SELF\fP
 143 監視対象のディレクトリまたはファイル自身が移動された。
 144 .TP
 145 \fBIN_MOVED_FROM\fP
 146 ファイルが監視対象ディレクトリ外へ移動された。(*)
 147 .TP
 148 \fBIN_MOVED_TO\fP
 149 ファイルが監視対象ディレクトリ内へ移動された。(*)
 150 .TP
 151 \fBIN_OPEN\fP
 152 ファイルがオープンされた。(*)
 153 .PD
 154 .RE
 155 .PP
 156 ディレクトリを監視する場合、 上記でアスタリスク (*) を付けたイベントは、 そのディレクトリ内のファイルに対して発生する。 このとき
 157 \fIinotify_event\fP 構造体で返される \fIname\fP フィールドは、ディレクトリ内のファイル名を表す。
 158 .PP
 159 \fBIN_ALL_EVENTS\fP マクロは上記のイベント全てのマスクとして定義される。 このマクロは \fBinotify_add_watch\fP(2)
 160 を呼び出すときの \fImask\fP 引き数として使える。
 161
 162 さらに 2 つの便利なマクロがある。
 163 \fBIN_MOVE\fP は IN_MOVED_FROM|IN_MOVED_TO と同じで、
 164 \fBIN_CLOSE\fP は IN_CLOSE_WRITE|IN_CLOSE_NOWRITE と同じである。
 165 .PP
 166 その他にも以下のビットを \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定できる:
 167 .RS 4
 168 .sp
 169 .PD 0
 170 .TP  18
 171 \fBIN_DONT_FOLLOW\fP
 172 \fIpathname\fP がシンボリックリンクである場合に辿らない。 (Linux 2.6.15 以降)
 173 .TP
 174 \fBIN_EXCL_UNLINK\fP (Linux 2.6.36 以降)
 175 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
 176 デフォルトでは、あるディレクトリの子ファイルに関するイベントを監視 (watch)
 177 した際、ディレクトリからその子ファイルが削除 (unlink) された場合であっても
 178 その子ファイルに対してイベントが生成される。このことは、アプリケーションに
 179 よってはあまり興味のないイベントが大量に発生することにつながる (例えば、\fI/tmp\fP
 180 を監視している場合、たくさんのアプリケーションが、すぐにその名前が削除される
 181 一時ファイルをそのディレクトリにに作成する)。 \fBIN_EXCL_UNLINK\fP を指定すると
 182 このデフォルトの動作を変更でき、監視対象のディレクトリから子ファイルが削除
 183 された後に子ファイルに関するイベントが生成されなくなる。
 184 .TP
 185 \fBIN_MASK_ADD\fP
 186 \fIpathname\fP に対する監視マスクが既に存在する場合、 (マスクの置き換えではなく) イベントを追加 (OR) する。
 187 .TP
 188 \fBIN_ONESHOT\fP
 189 1 つのイベントについて \fIpathname\fP を監視し、 イベントが発生したら監視対象リストから削除する。
 190 .TP
 191 \fBIN_ONLYDIR\fP (Linux 2.6.15 以降)
 192 \fIpathname\fP がディレクトリの場合にのみ監視する。
 193 .PD
 194 .RE
 195 .PP
 196 以下のビットが \fBread\fP(2)  で返される \fImask\fP フィールドに設定される:
 197 .RS 4
 198 .sp
 199 .PD 0
 200 .TP  18
 201 \fBIN_IGNORED\fP
 202 監視対象が (\fBinotify_rm_watch\fP(2) により) 明示的に 削除された。もしくは (ファイルの削除、またはファイル
 203 システムのアンマウントにより) 自動的に削除された。
 204 .TP
 205 \fBIN_ISDIR\fP
 206 このイベントの対象がディレクトリである。
 207 .TP
 208 \fBIN_Q_OVERFLOW\fP
 209 イベントキューが溢れた (このイベントの場合、\fIwd\fP は \-1 である)。
 210 .TP
 211 \fBIN_UNMOUNT\fP
 212 監視対象オブジェクトを含むファイルシステムがアンマウントされた。
 213 .PD
 214 .RE
 215 .SS "/proc インターフェース"
 216 以下のインターフェースは、inotify で消費される カーネルメモリの総量を制限するのに使用できる:
 217 .TP
 218 \fI/proc/sys/fs/inotify/max_queued_events\fP
 219 このファイルの値は、アプリケーションが \fBinotify_init\fP(2)  を呼び出すときに使用され、対応する inotify インスタンスについて
 220 キューに入れられるイベントの数の上限を設定する。 この制限を超えたイベントは破棄されるが、 \fBIN_Q_OVERFLOW\fP イベントが常に生成される。
 221 .TP
 222 \fI/proc/sys/fs/inotify/max_user_instances\fP
 223 1 つの実ユーザ ID に対して生成できる inotify インスタンスの数の上限を指定する。
 224 .TP
 225 \fI/proc/sys/fs/inotify/max_user_watches\fP
 226 作成可能な監視対象の数の実 UID 単位の上限を指定する。
 227 .SH バージョン
 228 inotify は 2.6.13 の Linux カーネルに組込まれた。 これに必要なライブラリのインターフェースは、 glibc のバージョン 2.4
 229 に追加された (\fBIN_DONT_FOLLOW\fP, \fBIN_MASK_ADD\fP, \fBIN_ONLYDIR\fP だけはバージョン 2.5
 230 で追加された)。
 231 .SH 準拠
 232 inotify API は Linux 独自のものである。
 233 .SH 注意
 234 inotify ファイルディスクリプタは \fBselect\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)  を使って監視できる。
 235 イベントがある場合、ファイルディスクリプタは読み込み可能と通知する。
 236
 237 Linux 2.6.25 以降では、シグナル駆動 (signal\-driven) I/O の通知が inotify
 238 ファイルディスクリプタについて利用可能である。 \fBfcntl\fP(2)  に書かれている (\fBO_ASYNC\fP フラグを設定するための)
 239 \fBF_SETFL\fP, \fBF_SETOWN\fP, \fBF_SETSIG\fP の議論を参照のこと。 シグナルハンドラに渡される \fIsiginfo_t\fP
 240 構造体は、以下のフィールドが設定される (\fIsiginfo_t\fP は \fBsigaction\fP(2)  で説明されている)。 \fIsi_fd\fP には
 241 inotify ファイルディスクリプタ番号が、 \fIsi_signo\fP にはシグナル番号が、 \fIsi_code\fP には \fBPOLL_IN\fP が、
 242 \fIsi_band\fP には \fBPOLLIN\fP が設定される。
 243
 244 inotify ファイルディスクリプタに対して 連続して生成される出力 inotify イベントが同一の場合 (\fIwd\fP, \fImask\fP,
 245 \fIcookie\fP, \fIname\fP が等しい場合)、 前のイベントがまだ読み込まれていなければ、 連続するイベントが 1 つのイベントにまとめられる
 246 (ただし「バグ」の節も参照のこと)。
 247
 248 inotify ファイルディスクリプタの読み込みで返されるイベントは、 順序付けられたキューになる。
 249 従って、たとえば、あるディレクトリの名前を別の名前に変更した場合、 inotify ファイルディスクリプタについての正しい順番で
 250 イベントが生成されることが保証される。
 251
 252 \fBFIONREAD\fP \fBioctl\fP(2)  は inotify ファイルディスクリプタから何バイト読み込めるかを返す。
 253 .SS 制限と警告
 254 inotify によるディレクトリの監視は再帰的に行われない: あるディレクトリ以下の
 255 サブディレクトリを監視する場合、 監視対象を追加で作成しなければならない。
 256 大きなディレクトリツリーの場合には、この作業にかなり時間がかかることがある。
 257
 258 inotify API では、inotify イベントが発生するきっかけとなったユーザやプロセスに関する情報は提供されない。とりわけ、inotify
 259 経由でイベントを監視しているプロセスが、自分自身がきっかけとなったイベントと他のプロセスがきっかけとなったイベントを区別する簡単な手段はない。
 260
 261 イベントキューは溢れる場合があることに注意すること。この場合にはイベントは
 262 失われてしまう。堅牢性が必要なアプリケーションでは、イベントが失われる可能性
 263 を適切に扱う必要がある。
 264
 265 inotify API では影響が受けるファイルをファイル名で特定する。
 266 しかしながら、アプリケーションが inotify イベントを処理する時点では、
 267 そのファイル名がすでに削除されたり変更されたりしている可能性がある。
 268
 269 ディレクトリツリー全体を監視していて、そのツリー内に新しいサブディレクトリが
 270 作成される場合、新しいサブディレクトリに対する watch を作成するまでに、
 271 新しいファイルがそのサブディレクトリ内にすでに作成されている場合がある点に
 272 注意すること。したがって、watch を追加した直後にサブディレクトリの内容を
 273 スキャンしたいと思う場合もあるだろう。
 274 .SH バグ
 275 2.6.16 以前のカーネルでは \fBIN_ONESHOT\fP \fImask\fP フラグが働かない。
 276
 277 カーネル 2.6.25 より前では、 連続する同一のイベントを一つにまとめることを意図したコード (古い方のイベントがまだ読み込まれていない場合に、
 278 最新の 2 つのイベントを一つにまとめられる可能性がある) が、 最新のイベントが「最も古い」読み込まれていないイベントとまとめられるか
 279 をチェックするようになっていた。
 280 .SH 関連項目
 281 \fBinotify_add_watch\fP(2), \fBinotify_init\fP(2), \fBinotify_init1\fP(2),
 282 \fBinotify_rm_watch\fP(2), \fBread\fP(2), \fBstat\fP(2)
 283
 284 Linux カーネルソース内の \fIDocumentation/filesystems/inotify.txt\fP
 285 .SH この文書について
 286 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
 287 である。プロジェクトの説明とバグ報告に関する情報は
 288 http://www.kernel.org/doc/man\-pages/ に書かれている。