release/man7/inotify.7

   1 .\" t
   2 .\" Copyright (C) 2006, 2014 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\" Copyright (C) 2014 Heinrich Schuchardt <xypron.glpk@gmx.de>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\"*******************************************************************
  28 .\"
  29 .\" This file was generated with po4a. Translate the source file.
  30 .\"
  31 .\"*******************************************************************
  32 .\"
  33 .\" Japanese Version Copyright (c) 2006 Yuichi SATO
  34 .\"     and Copyright (c) 2007-2008 Akihiro MOTOKI
  35 .\" Translated 2006-07-05 by Yuichi SATO <ysato444@yahoo.co.jp>, LDP v2.29
  36 .\" Updated 2006-07-20 by Yuichi SATO, LDP v2.36
  37 .\" Updated 2007-06-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.55
  38 .\" Updated 2008-08-10, Akihiro MOTOKI, LDP v3.05
  39 .\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.08
  40 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
  41 .\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
  42 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
  43 .\" Updated 2013-07-22, Akihiro MOTOKI <amotoki@gmail.com>
  44 .\" Updated 2013-08-21, Akihiro MOTOKI <amotoki@gmail.com>, LDP v3.53
  45 .\"
  46 .TH INOTIFY 7 2014\-05\-23 Linux "Linux Programmer's Manual"
  47 .SH 名前
  48 inotify \- ファイルシステムイベントを監視する
  49 .SH 説明
  50 \fIinotify\fP API はファイルシステムイベントを監視するための機構を提供する。 inotify
  51 は個々のファイルやディレクトリを監視するのに使える。 ディレクトリを監視する場合、inotify はディレクトリ自身と
  52 ディレクトリ内のファイルのイベントを返す。
  53
  54 この API では以下のシステムコールが使用される。
  55 .IP * 3
  56 \fBinotify_init\fP(2)  は inotify インスタンスを作成し、inotify インスタンスを参照する ファイルディスクリプタを返す。
  57 より新しい \fBinotify_init1\fP(2)  も \fBinotify_init\fP(2)  と同様だが、
  58 こちらにはいくつかの追加の機能を利用するための \fIflags\fP 引き数がある。
  59 .IP *
  60 \fBinotify_add_watch\fP(2)  は inotify インスタンスに関連づけられた「監視対象 (watch) リスト」を操作する。
  61 監視対象リストの各アイテム ("watch") は、 ファイルまたはディレクトリのパス名と、 そのパス名で参照されるファイルに対して
  62 カーネルが監視する複数のイベントの集合を指定する。 \fBinotify_add_watch\fP(2)
  63 は新しい監視アイテムの作成や既存の監視対象の変更ができる。 各監視対象は一意の「監視対象ディスクリプタ」を持つ。 これは監視対象を作成したときに
  64 \fBinotify_add_watch\fP(2)  から返される整数である。
  65 .IP *
  66 監視しているファイルやディレクトリでイベントが起こると、 それらのイベントはアプリケーションから inotify ファイルディスクリプタから
  67 \fBread\fP(2) を使って構造化データとして読み出すことができる (下記参照)。
  68 .IP *
  69 \fBinotify_rm_watch\fP(2)  は inotify の監視対象リストからアイテムを削除する。
  70 .IP *
  71 inotify インスタンスを指している 全てのファイルディスクリプタが (\fBclose\fP(2) を使って) クローズされた場合、
  72 その下層にあるオブジェクトとそのリソースは、 カーネルで再利用するために解放される。 関連が切られた監視対象は自動的に解放される。
  73
  74 注意深くプログラミングすることで、 アプリケーションは inotify
  75 を使ってファイルシステムオブジェクトの集合の状態を効率的に監視しキャッシュしておくことができる。
  76 しかしながら、ロバストなアプリケーションでは、監視ロジックのバグや以下に説明があるような種類の競合条件によりファイルシステムの状態とキャッシュが一致しない状態になることがあるという事実も考慮に入れておくべきである。
  77 おそらく何らかの一貫性のチェックを行い、不一致が検出された場合にはキャッシュを再構築するのが懸命だろう。
  78 .SS "inotify ファイルディスクリプタからのイベントの読み出し"
  79 どのようなイベントが起こっていたかを知るには、 アプリケーションで inotify ファイルディスクリプタを \fBread\fP(2)  すればよい。
  80 これまでに何もイベントが起こっていない場合、 停止 (blocking) モードのファイルディスクリプタであれば、 少なくとも 1
  81 つのイベントが起こるまで \fBread\fP(2)  は停止する (シグナルにより割り込まれなかった場合。
  82 シグナルによる割り込みがあった場合、呼び出しはエラー \fBEINTR\fP で失敗する。 \fBsignal\fP(7)  参照)。
  83
  84 \fBread\fP(2)  が成功すると、以下の構造体を 1 つ以上含むバッファが返される:
  85 .in +4n
  86 .nf
  87
  88 .\" FIXME . The type of the 'wd' field should probably be "int32_t".
  89 .\" I submitted a patch to fix this.  See the LKML thread
  90 .\" "[patch] Fix type errors in inotify interfaces", 18 Nov 2008
  91 .\" Glibc bug filed: http://sources.redhat.com/bugzilla/show_bug.cgi?id=7040
  92 struct inotify_event {
  93     int      wd;       /* 監視対象ディスクリプタ */
  94     uint32_t mask;     /* イベントのマスク */
  95     uint32_t cookie;   /* 関連するイベント群を関連づける
  96                           一意なクッキー (rename(2) 用) */
  97     uint32_t len;      /* \(aqname\(aq フィールドのサイズ */
  98     char     name[];   /* ヌルで終端された任意の名前 */
  99 };
 100 .fi
 101 .in
 102
 103 \fIwd\fP はイベント発生の監視対象を指定する。 これは、前もって行われた \fBinotify_add_watch\fP(2)
 104 呼び出しで返された監視対象ディスクリプタのうちの 1 つである。
 105
 106 \fImask\fP には発生したイベント (下記参照) を記述するためのビットが含まれる。
 107
 108 \fIcookie\fP は関連するイベントを関連づけるための一意な整数である。
 109 現在のところ、この値は rename イベントに対してのみ使われており、
 110 結果のペアである \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントを
 111 アプリケーションで関連づけることができる。
 112 他のイベント種別の場合には、 \fIcookie\fP は 0 に設定する。
 113
 114 \fIname\fP フィールドは監視しているディレクトリ内のファイルに対して イベントが返される場合のためにだけ存在する。
 115 監視するディレクトリからのファイルの相対パス名を表す。 このパス名はヌルで終端され、 その後の読み込みで適切なアドレス境界に調整するために、
 116 さらにヌルバイト (\(aq\e0\(aq) が含まれる場合もある。
 117
 118 \fIlen\fP フィールドはヌルバイトを含む \fIname\fP の全てのバイト数を表す。
 119 よって、 \fIinotify_event\fP 構造体のサイズは
 120 \fIsizeof(struct inotify_event)+len\fP である。
 121
 122 \fBread\fP(2) に渡されたバッファが小さすぎて次のイベントに関する情報を返せ
 123 ない場合の動作はカーネルのバージョンにより異なる。 2.6.21 より前のカー
 124 ネルでは、 \fBread\fP(2) は 0 を返す。 2.6.21 以降のカーネルでは、
 125 \fBread\fP(2) はエラー \fBEINVAL\fP で失敗する。
 126 バッファサイズとして
 127
 128     sizeof(struct inotify_event) + NAME_MAX + 1
 129
 130 を指定すれば、少なくとも 1 イベントで読み出しを行うには十分である。
 131 .SS "inotify イベント"
 132 \fBinotify_add_watch\fP(2)  の \fImask\fP 引き数と、inotify ファイル構造体を \fBread\fP(2)
 133 したときに返される \fIinotify_event\fP 構造体の \fImask\fP フィールドは、ともに inotify イベントを識別するための
 134 ビットマスクである。 以下のビットが \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定可能であり、
 135 \fBread\fP(2)  で返される \fImask\fP フィールドで返される:
 136 .RS 4
 137 .TP
 138 \fBIN_ACCESS\fP (*)
 139 (\fBread\fP(2), \fBexecve\fP(2) などで) ファイルがアクセスされた。
 140 .TP
 141 \fBIN_ATTRIB\fP (*)
 142 メタデータが変更された。 メタデータとは、例えば、アクセス許可 (\fBchmod\fP(2))、タイムスタンプ (\fButimensat\fP(2)
 143 など)、拡張属性 (\fBsetxattr\fP(2))、 リンクカウント (Linux 2.6.25 以降; \fBlink\fP(2) のリンク先や
 144 \fBunlink\fP(2) など)、ユーザー/グループ ID (\fBchown\fP(2) など) などである。
 145 .TP
 146 \fBIN_CLOSE_WRITE\fP (*)
 147 書き込みのためにオープンされたファイルがクローズされた。
 148 .TP
 149 \fBIN_CLOSE_NOWRITE\fP (*)
 150 書き込み以外のためにオープンされたファイルがクローズされた。
 151 .TP
 152 \fBIN_CREATE\fP (*)
 153 監視対象ディレクトリ内でファイルやディレクトリが作成された (\fBopen\fP(2)  \fBO_CREAT\fP, \fBmkdir\fP(2),
 154 \fBlink\fP(2), \fBsymlink\fP(2), UNIX ドメインソケットに対する \fBbind\fP(2) など)。
 155 .TP
 156 \fBIN_DELETE\fP (*)
 157 監視対象ディレクトリ内でファイルやディレクトリが削除された。
 158 .TP
 159 \fBIN_DELETE_SELF\fP
 160 監視対象のファイルやディレクトリ自身が削除あれた。 (このイベントはオブジェクトが別のファイルシステムに移動された場合にも発生する。 \fBmv\fP(1)
 161 は実際には別のファイルシステムにファイルをコピーした後、元のファイルシステムからそのファイルを削除するからである。) また、
 162 結果的に監視ディスクリプタに対して \fBIN_IGNORED\fP イベントも生成される。
 163 .TP
 164 \fBIN_MODIFY\fP (*)
 165 ファイルが変更された (\fBwrite\fP(2), \fBtruncate\fP(2) など)。
 166 .TP
 167 \fBIN_MOVE_SELF\fP
 168 監視対象のディレクトリまたはファイル自身が移動された。
 169 .TP
 170 \fBIN_MOVED_FROM\fP (*)
 171 ファイル名の変更を行った際に変更前のファイル名が含まれるディレクトリに対して生成される。
 172 .TP
 173 \fBIN_MOVED_TO\fP (*)
 174 ファイル名の変更を行った際に新しいファイル名が含まれるディレクトリに対して生成される。
 175 .TP
 176 \fBIN_OPEN\fP (*)
 177 ファイルがオープンされた。
 178 .RE
 179 .PP
 180 ディレクトリを監視する場合、 上記でアスタリスク (*) を付けたイベントは、 そのディレクトリ内のファイルに対して発生する。 このとき
 181 \fIinotify_event\fP 構造体で返される \fIname\fP フィールドは、ディレクトリ内のファイル名を表す。
 182 .PP
 183 \fBIN_ALL_EVENTS\fP マクロは上記のイベント全てのマスクとして定義される。 このマクロは \fBinotify_add_watch\fP(2)
 184 を呼び出すときの \fImask\fP 引き数として使える。
 185
 186 以下の 2 つの便利なマクロが定義されている。
 187 .RS 4
 188 .TP
 189 \fBIN_MOVE\fP
 190 \fBIN_MOVED_FROM | IN_MOVED_TO\fP と等価。
 191 .TP
 192 \fBIN_CLOSE\fP
 193 \fBIN_CLOSE_WRITE | IN_CLOSE_NOWRITE\fP と等価。
 194 .RE
 195 .PP
 196 その他にも以下のビットを \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定できる:
 197 .RS 4
 198 .TP
 199 \fBIN_DONT_FOLLOW\fP (Linux 2.6.15 以降)
 200 \fIpathname\fP がシンボリックリンクである場合に辿らない。 (Linux 2.6.15 以降)
 201 .TP
 202 \fBIN_EXCL_UNLINK\fP (Linux 2.6.36 以降)
 203 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
 204 デフォルトでは、あるディレクトリの子ファイルに関するイベントを監視 (watch) した際、ディレクトリからその子ファイルが削除 (unlink)
 205 された場合であってもその子ファイルに対してイベントが生成される。このことは、アプリケーションによってはあまり興味のないイベントが大量に発生することにつながる
 206 (例えば、\fI/tmp\fP を監視している場合、たくさんのアプリケーションが、すぐにその名前が削除される一時ファイルをそのディレクトリに作成する)。
 207 \fBIN_EXCL_UNLINK\fP
 208 を指定するとこのデフォルトの動作を変更でき、監視対象のディレクトリから子ファイルが削除された後に子ファイルに関するイベントが生成されなくなる。
 209 .TP
 210 \fBIN_MASK_ADD\fP
 211 \fIpathname\fP に対する監視マスクが既に存在する場合、 (マスクの置き換えではなく) イベントを追加 (OR) する。
 212 .TP
 213 \fBIN_ONESHOT\fP
 214 1 つのイベントについて \fIpathname\fP を監視し、 イベントが発生したら監視対象リストから削除する。
 215 .TP
 216 \fBIN_ONLYDIR\fP (Linux 2.6.15 以降)
 217 \fIpathname\fP がディレクトリの場合にのみ監視する。
 218 .RE
 219 .PP
 220 以下のビットが \fBread\fP(2)  で返される \fImask\fP フィールドに設定される:
 221 .RS 4
 222 .TP
 223 \fBIN_IGNORED\fP
 224 監視対象が (\fBinotify_rm_watch\fP(2) により) 明示的に 削除された。もしくは (ファイルの削除、またはファイル
 225 システムのアンマウントにより) 自動的に削除された。「バグ」も参照のこと。
 226 .TP
 227 \fBIN_ISDIR\fP
 228 このイベントの対象がディレクトリである。
 229 .TP
 230 \fBIN_Q_OVERFLOW\fP
 231 イベントキューが溢れた (このイベントの場合、\fIwd\fP は \-1 である)。
 232 .TP
 233 \fBIN_UNMOUNT\fP
 234 監視対象オブジェクトを含むファイルシステムがアンマウントされた。さらに、この監視対象ディスクリプタに対して \fBIN_IGNORED\fP
 235 イベントが生成される。
 236 .RE
 237 .SS 例
 238 アプリケーションがディレクトリ \fIdir\fP とファイル \fIdir/myfile\fP のすべてのイベントを監視しているとする。 以下に、これらの 2
 239 つのオブジェクトに対して生成されるイベントの例を示す。
 240 .RS 4
 241 .TP
 242 fd = open("dir/myfile", O_RDWR);
 243 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_OPEN\fP イベントが生成される。
 244 .TP
 245 read(fd, buf, count);
 246 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ACCESS\fP イベントが生成される
 247 .TP
 248 write(fd, buf, count);
 249 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_MODIFY\fP イベントが生成される
 250 .TP
 251 fchmod(fd, mode);
 252 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ATTRIB\fP イベントが生成される
 253 .TP
 254 close(fd);
 255 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_CLOSE_WRITE\fP イベントが生成される
 256 .RE
 257 .PP
 258 アプリケーションがディレクトリ \fIdir1\fP と \fIdir2\fP、およびファイル \fIdir1/myfile\fP を監視しているとする。
 259 以下に生成されるイベントの例を示す。
 260 .RS 4
 261 .TP
 262 link("dir1/myfile", "dir2/new");
 263 \fImyfile\fP に対して \fBIN_ATTRIB\fP イベントが生成され、 \fIdir2\fP に対して \fBIN_CREATE\fP イベントが生成される。
 264 .TP
 265 rename("dir1/myfile", "dir2/myfile");
 266 \fIdir1\fP に対してイベント \fBIN_MOVED_FROM\fP が、 \fIdir2\fP に対してイベント \fBIN_MOVED_TO\fP が、
 267 \fImyfile\fP に対してイベント \fBIN_MOVE_SELF\fP が生成される。この際 イベント \fBIN_MOVED_FROM\fP と
 268 \fBIN_MOVED_TO\fP は同じ \fIcookie\fP 値を持つ。
 269 .RE
 270 .PP
 271 \fIdir1/xx\fP と \fIdir2/yy\fP は同じファイルを参照するリンクで (他のリンクはないものとする)、 アプリケーションは \fIdir1\fP,
 272 \fIdir2\fP, \fIdir1/xx\fP, \fIdir2/yy\fP を監視しているものとする。
 273 以下に示す順序で下記の呼び出しを実行すると、以下のイベントが生成される。
 274 .RS 4
 275 .TP
 276 unlink("dir2/yy");
 277 \fIxx\fP に対して \fBIN_ATTRIB\fP イベントが生成され (リンク数が変化したため)、 \fIdir2\fP に対して \fBIN_DELETE\fP
 278 イベントが生成される。
 279 .TP
 280 unlink("dir1/xx");
 281 \fIxx\fP に対してイベント \fBIN_ATTRIB\fP, \fBIN_DELETE_SELF\fP, \fBIN_IGNORED\fP が生成され、 \fIdir1\fP
 282 に対して \fBIN_DELETE\fP イベントが生成される。
 283 .RE
 284 .PP
 285 アプリケーションがディレクトリ \fIdir\fP と (空の) ディレクトリ \fIdir/subdir\fP を監視しているものとする。
 286 以下に生成されるイベントの例を示す。
 287 .RS 4
 288 .TP
 289 mkdir("dir/new", mode);
 290 \fIdir\fP に対して \fBIN_CREATE | IN_ISDIR\fP イベントが生成される。
 291 .TP
 292 rmdir("dir/subdir");
 293 \fIsubdir\fP に対してイベント \fBIN_DELETE_SELF\fP と \fBIN_IGNORED\fP が生成され、 \fIdir\fP に対して
 294 \fBIN_DELETE | IN_ISDIR\fP イベントが生成される。
 295 .RE
 296 .SS "/proc インターフェース"
 297 以下のインターフェースは、inotify で消費される カーネルメモリの総量を制限するのに使用できる:
 298 .TP
 299 \fI/proc/sys/fs/inotify/max_queued_events\fP
 300 このファイルの値は、アプリケーションが \fBinotify_init\fP(2)  を呼び出すときに使用され、対応する inotify インスタンスについて
 301 キューに入れられるイベントの数の上限を設定する。 この制限を超えたイベントは破棄されるが、 \fBIN_Q_OVERFLOW\fP イベントが常に生成される。
 302 .TP
 303 \fI/proc/sys/fs/inotify/max_user_instances\fP
 304 1 つの実ユーザ ID に対して生成できる inotify インスタンスの数の上限を指定する。
 305 .TP
 306 \fI/proc/sys/fs/inotify/max_user_watches\fP
 307 作成可能な監視対象の数の実 UID 単位の上限を指定する。
 308 .SH バージョン
 309 inotify は 2.6.13 の Linux カーネルに組込まれた。 これに必要なライブラリのインターフェースは、 glibc のバージョン 2.4
 310 に追加された (\fBIN_DONT_FOLLOW\fP, \fBIN_MASK_ADD\fP, \fBIN_ONLYDIR\fP は glibc バージョン 2.5
 311 で追加された)。
 312 .SH 準拠
 313 inotify API は Linux 独自のものである。
 314 .SH 注意
 315 inotify ファイルディスクリプタは \fBselect\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)  を使って監視できる。
 316 イベントがある場合、ファイルディスクリプタは読み込み可能と通知する。
 317
 318 Linux 2.6.25 以降では、シグナル駆動 (signal\-driven) I/O の通知が inotify
 319 ファイルディスクリプタについて利用可能である。 \fBfcntl\fP(2)  に書かれている (\fBO_ASYNC\fP フラグを設定するための)
 320 \fBF_SETFL\fP, \fBF_SETOWN\fP, \fBF_SETSIG\fP の議論を参照のこと。 シグナルハンドラに渡される \fIsiginfo_t\fP
 321 構造体は、以下のフィールドが設定される (\fIsiginfo_t\fP は \fBsigaction\fP(2)  で説明されている)。 \fIsi_fd\fP には
 322 inotify ファイルディスクリプタ番号が、 \fIsi_signo\fP にはシグナル番号が、 \fIsi_code\fP には \fBPOLL_IN\fP が、
 323 \fIsi_band\fP には \fBPOLLIN\fP が設定される。
 324
 325 inotify ファイルディスクリプタに対して 連続して生成される出力 inotify イベントが同一の場合 (\fIwd\fP, \fImask\fP,
 326 \fIcookie\fP, \fIname\fP が等しい場合)、 前のイベントがまだ読み込まれていなければ、 連続するイベントが 1 つのイベントにまとめられる
 327 (ただし「バグ」の節も参照のこと)。 これによりイベントキューに必要なカーネルメモリ量が減るが、
 328 これはまたアプリケーションがファイルイベント数を信頼性を持って数えるのに inotify を使用できないということでもある。
 329
 330 inotify ファイルディスクリプタの読み込みで返されるイベントは、 順序付けられたキューになる。
 331 従って、たとえば、あるディレクトリの名前を別の名前に変更した場合、 inotify ファイルディスクリプタについての正しい順番で
 332 イベントが生成されることが保証される。
 333
 334 \fBFIONREAD\fP \fBioctl\fP(2)  は inotify ファイルディスクリプタから何バイト読み込めるかを返す。
 335 .SS 制限と警告
 336 inotify API では、inotify イベントが発生するきっかけとなったユーザやプロセスに関する情報は提供されない。とりわけ、inotify
 337 経由でイベントを監視しているプロセスが、自分自身がきっかけとなったイベントと他のプロセスがきっかけとなったイベントを区別する簡単な手段はない。
 338
 339 inotify は、ファイルシステム API 経由でユーザー空間プログラムがきっかけとなったイベントだけを報告する。 結果として、 inotify
 340 はネットワークファイルシステムで発生したリモートのイベントを捉えることはできない
 341 (このようなイベントを捉えるにはアプリケーションはファイルシステムをポーリングする必要がある)。 さらに、 \fI/proc\fP, \fI/sys\fP,
 342 \fI/dev/pts\fP といったいくつかの疑似ファイルシステムは inotify で監視することができない。
 343
 344 inotify API は \fBmmap\fP(2), \fBmsync\fP(2), \fBmunmap\fP(2)
 345 により起こったファイルのアクセスと変更を報告しない。
 346
 347 inotify API では影響が受けるファイルをファイル名で特定する。
 348 しかしながら、アプリケーションが inotify イベントを処理する時点では、
 349 そのファイル名がすでに削除されたり変更されたりしている可能性がある。
 350
 351 inotify API では監視対象ディスクリプタを通してイベントが区別される。 (必要であれば)
 352 監視対象ディスクリプタとパス名のマッピングをキャッシュしておくのはアプリケーションの役目である。
 353 ディレクトリの名前変更の場合、キャッシュしている複数のパス名に影響がある点に注意すること。
 354
 355 inotify によるディレクトリの監視は再帰的に行われない: あるディレクトリ以下の
 356 サブディレクトリを監視する場合、 監視対象を追加で作成しなければならない。
 357 大きなディレクトリツリーの場合には、この作業にかなり時間がかかることがある。
 358
 359 ディレクトリツリー全体を監視していて、 そのツリー内に新しいサブディレクトリが作成されるか、
 360 既存のディレクトリが名前が変更されそのツリー内に移動した場合、 新しいサブディレクトリに対する watch を作成するまでに、 新しいファイル
 361 (やサブディレクトリ) がそのサブディレクトリ内にすでに作成されている場合がある点に注意すること。 したがって、watch
 362 を追加した直後にサブディレクトリの内容をスキャンしたいと思う場合もあるだろう (必要ならそのサブディレクトリ内のサブディレクトリに対する watch
 363 も再帰的に追加することもあるだろう)。
 364
 365 イベントキューはオーバーフローする場合があることに注意すること。 この場合、イベントは失なわれる。 ロバスト性が求められるアプリケーションでは、
 366 イベントが失なわれる可能性も含めて適切に処理を行うべきである。
 367 例えば、アプリケーション内のキャッシュの一部分または全てを再構築する必要があるかもしれない。 (単純だが、おそらくコストがかかる方法は、 inotify
 368 ファイルディスクリプタをクローズし、 キャッシュを空にし、 新しい inotify ファイルディスクリプタを作成し、
 369 監視しているオブジェクトの監視対象ディスクリプタとキャッシュエントリーの再作成を行う方法である。)
 370 .SS "rename() イベントの取り扱い"
 371 上述の通り、 \fBrename\fP(2) により生成される \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントの組は、共有される
 372 cookie 値によって対応を取ることができる。 しかし、対応を取る場合にはいくつか難しい点がある。
 373
 374 これらの 2 つのイベントは、 inotify ファイルディスクリプタから読み出しを行った場合に、通常はイベントストリーム内で連続している。
 375 しかしながら、連続していることは保証されていない。 複数のプロセスが監視対象オブジェクトでイベントを発生させた場合、 (めったに起こらないことだが)
 376 イベント \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP の間に任意の数の他のイベントがはさまる可能性がある。
 377
 378 したがって、 \fBrename\fP(2) により生成された \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP
 379 のイベントの組の対応を取るのは本質的に難しいことである (監視対象のディレクトリの外へオブジェクトの rename が行われた場合には
 380 \fBIN_MOVED_TO\fP イベントは存在しさえしないことを忘れてはならない)。 (イベントは常に連続しているとの仮定を置くといった)
 381 発見的な方法を使うと、ほとんどの場合でイベントの組をうまく見つけることができるが、 いくつかの場合に見逃すことが避けられず、 アプリケーションが
 382 \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントが無関係だとみなしてしまう可能性がある。
 383 結果的に、監視対象ディスクリプタが破棄され再作成された場合、これらの監視対象ディスクリプタは、処理待ちイベントの監視対象ディスクリプタと一貫性のないものになってしまう
 384 (inotify ファイルディスクリプタの再作成とキャッシュの再構成はこの状況に対処するのに有用な方法なのだが)。
 385
 386 また、アプリケーションは、 \fBIN_MOVED_FROM\fP イベントが今行った \fBread\fP(2)
 387 の呼び出しで返されたバッファのちょうど一番最後のイベントで、 \fBIN_MOVED_TO\fP イベントは次の \fBread\fP(2)
 388 を行わないと取得できない可能性も考慮に入れる必要がある。
 389 .SH バグ
 390 .\" FIXME kernel commit 611da04f7a31b2208e838be55a42c7a1310ae321
 391 .\" implies that unmount events were buggy 2.6.11 to 2.6.36
 392 .\"
 393 2.6.16 以前のカーネルでは \fBIN_ONESHOT\fP \fImask\fP フラグが働かない。
 394
 395 元々は設計/実装時の意図通り、 イベントが一つ発生し watch が削除された際に \fBIN_ONESHOT\fP フラグでは \fBIN_IGNORED\fP
 396 イベントが発生しなかった。 しかし、 別の変更での意図していなかった影響により、 Linux 2.6.36 以降では、 この場合に
 397 \fBIN_IGNORED\fP イベントが生成される。
 398
 399 .\" commit 1c17d18e3775485bf1e0ce79575eb637a94494a2
 400 カーネル 2.6.25 より前では、 連続する同一のイベントを一つにまとめることを意図したコード (古い方のイベントがまだ読み込まれていない場合に、
 401 最新の 2 つのイベントを一つにまとめられる可能性がある) が、 最新のイベントが「最も古い」読み込まれていないイベントとまとめられるか
 402 をチェックするようになっていた。
 403 .SH 例
 404 The following program demonstrates the usage of the inotify API.  It marks
 405 the directories passed as a command\-line arguments and waits for events of
 406 type \fBIN_OPEN\fP, \fBIN_CLOSE_NOWRITE\fP and \fBIN_CLOSE_WRITE\fP.
 407 .PP
 408 The following output was recorded while editing the file
 409 \fI/home/user/temp/foo\fP and listing directory \fI/tmp\fP.  Before the file and
 410 the directory were opened, \fBIN_OPEN\fP events occurred.  After the file was
 411 closed, an \fBIN_CLOSE_WRITE\fP event occurred.  After the directory was
 412 closed, an \fBIN_CLOSE_NOWRITE\fP event occurred.  Execution of the program
 413 ended when the user pressed the ENTER key.
 414 .SS 出力例
 415 .in +4n
 416 .nf
 417 $ \fB./a.out /tmp /home/user/temp\fP
 418 Press enter key to terminate.
 419 Listening for events.
 420 IN_OPEN: /home/user/temp/foo [file]
 421 IN_CLOSE_WRITE: /home/user/temp/foo [file]
 422 IN_OPEN: /tmp/ [directory]
 423 IN_CLOSE_NOWRITE: /tmp/ [directory]
 424
 425 Listening for events stopped.
 426 .fi
 427 .in
 428 .SS プログラムソース
 429 .nf
 430 #include <errno.h>
 431 #include <poll.h>
 432 #include <stdio.h>
 433 #include <stdlib.h>
 434 #include <sys/inotify.h>
 435 #include <unistd.h>
 436
 437 /* Read all available inotify events from the file descriptor 'fd'.
 438    wd is the table of watch descriptors for the directories in argv.
 439    argc is the length of wd and argv.
 440    argv is the list of watched directories.
 441    Entry 0 of wd and argv is unused. */
 442
 443 static void
 444 handle_events(int fd, int *wd, int argc, char* argv[])
 445 {
 446     /* Some systems cannot read integer variables if they are not
 447        properly aligned. On other systems, incorrect alignment may
 448        decrease performance. Hence, the buffer used for reading from
 449        the inotify file descriptor should have the same alignment as
 450        struct inotify_event. */
 451
 452     char buf[4096]
 453         __attribute__ ((aligned(__alignof__(struct inotify_event))));
 454     const struct inotify_event *event;
 455     int i;
 456     ssize_t len;
 457     char *ptr;
 458
 459     /* Loop while events can be read from inotify file descriptor. */
 460
 461     for (;;) {
 462
 463         /* Read some events. */
 464
 465         len = read(fd, buf, sizeof buf);
 466         if (len == \-1 && errno != EAGAIN) {
 467             perror("read");
 468             exit(EXIT_FAILURE);
 469         }
 470
 471         /* If the nonblocking read() found no events to read, then
 472            it returns \-1 with errno set to EAGAIN. In that case,
 473            we exit the loop. */
 474
 475         if (len <= 0)
 476             break;
 477
 478         /* Loop over all events in the buffer */
 479
 480         for (ptr = buf; ptr < buf + len;
 481                 ptr += sizeof(struct inotify_event) + event\->len) {
 482
 483             event = (const struct inotify_event *) ptr;
 484
 485             /* Print event type */
 486
 487             if (event\->mask & IN_OPEN)
 488                 printf("IN_OPEN: ");
 489             if (event\->mask & IN_CLOSE_NOWRITE)
 490                 printf("IN_CLOSE_NOWRITE: ");
 491             if (event\->mask & IN_CLOSE_WRITE)
 492                 printf("IN_CLOSE_WRITE: ");
 493
 494             /* Print the name of the watched directory */
 495
 496             for (i = 1; i < argc; ++i) {
 497                 if (wd[i] == event\->wd) {
 498                     printf("%s/", argv[i]);
 499                     break;
 500                 }
 501             }
 502
 503             /* Print the name of the file */
 504
 505             if (event\->len)
 506                 printf("%s", event\->name);
 507
 508             /* Print type of filesystem object */
 509
 510             if (event\->mask & IN_ISDIR)
 511                 printf(" [directory]\en");
 512             else
 513                 printf(" [file]\en");
 514         }
 515     }
 516 }
 517
 518 int
 519 main(int argc, char* argv[])
 520 {
 521     char buf;
 522     int fd, i, poll_num;
 523     int *wd;
 524     nfds_t nfds;
 525     struct pollfd fds[2];
 526
 527     if (argc < 2) {
 528         printf("Usage: %s PATH [PATH ...]\en", argv[0]);
 529         exit(EXIT_FAILURE);
 530     }
 531
 532     printf("Press ENTER key to terminate.\en");
 533
 534     /* Create the file descriptor for accessing the inotify API */
 535
 536     fd = inotify_init1(IN_NONBLOCK);
 537     if (fd == \-1) {
 538         perror("inotify_init1");
 539         exit(EXIT_FAILURE);
 540     }
 541
 542     /* Allocate memory for watch descriptors */
 543
 544     wd = calloc(argc, sizeof(int));
 545     if (wd == NULL) {
 546         perror("calloc");
 547         exit(EXIT_FAILURE);
 548     }
 549
 550     /* Mark directories for events
 551        \- file was opened
 552        \- file was closed */
 553
 554     for (i = 1; i < argc; i++) {
 555         wd[i] = inotify_add_watch(fd, argv[i],
 556                                   IN_OPEN | IN_CLOSE);
 557         if (wd[i] == \-1) {
 558             fprintf(stderr, "Cannot watch '%s'\en", argv[i]);
 559             perror("inotify_add_watch");
 560             exit(EXIT_FAILURE);
 561         }
 562     }
 563
 564     /* Prepare for polling */
 565
 566     nfds = 2;
 567
 568     /* Console input */
 569
 570     fds[0].fd = STDIN_FILENO;
 571     fds[0].events = POLLIN;
 572
 573     /* Inotify input */
 574
 575     fds[1].fd = fd;
 576     fds[1].events = POLLIN;
 577
 578     /* Wait for events and/or terminal input */
 579
 580     printf("Listening for events.\en");
 581     while (1) {
 582         poll_num = poll(fds, nfds, \-1);
 583         if (poll_num == \-1) {
 584             if (errno == EINTR)
 585                 continue;
 586             perror("poll");
 587             exit(EXIT_FAILURE);
 588         }
 589
 590         if (poll_num > 0) {
 591
 592             if (fds[0].revents & POLLIN) {
 593
 594                 /* Console input is available. Empty stdin and quit */
 595
 596                 while (read(STDIN_FILENO, &buf, 1) > 0 && buf != '\en')
 597                     continue;
 598                 break;
 599             }
 600
 601             if (fds[1].revents & POLLIN) {
 602
 603                 /* Inotify events are available */
 604
 605                 handle_events(fd, wd, argc, argv);
 606             }
 607         }
 608     }
 609
 610     printf("Listening for events stopped.\en");
 611
 612     /* Close inotify file descriptor */
 613
 614     close(fd);
 615
 616     free(wd);
 617     exit(EXIT_SUCCESS);
 618 }
 619 .fi
 620 .SH 関連項目
 621 \fBinotifywait\fP(1), \fBinotifywatch\fP(1), \fBinotify_add_watch\fP(2),
 622 \fBinotify_init\fP(2), \fBinotify_init1\fP(2), \fBinotify_rm_watch\fP(2), \fBread\fP(2),
 623 \fBstat\fP(2), \fBfanotify\fP(7)
 624
 625 Linux カーネルソース内の \fIDocumentation/filesystems/inotify.txt\fP
 626 .SH この文書について
 627 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.68 の一部
 628 である。プロジェクトの説明とバグ報告に関する情報は
 629 http://www.kernel.org/doc/man\-pages/ に書かれている。