draft/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\-12\-31 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 .PP
  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 .IP * 3
 182 上記でアスタリスク (*) が付いたイベントは、 ディレクトリ自身とディレクトリ内のオブジェクトのどちらに対しても発生する。
 183 .IP *
 184 上記でプラス記号 (+) が付いたイベントは、 ディレクトリ内のオブジェクトに対してのみ発生する (ディレクトリ自身に対しては発生しない)。
 185 .PP
 186 監視対象のディレクトリ内のオブジェクトに対してイベントが発生した場合、 \fIinotify_event\fP 構造体で返される \fIname\fP
 187 フィールドは、ディレクトリ内のファイル名を表す。
 188 .PP
 189 \fBIN_ALL_EVENTS\fP マクロは上記のイベント全てのマスクとして定義される。 このマクロは \fBinotify_add_watch\fP(2)
 190 を呼び出すときの \fImask\fP 引き数として使える。
 191
 192 以下の 2 つの便利なマクロが定義されている。
 193 .RS 4
 194 .TP
 195 \fBIN_MOVE\fP
 196 \fBIN_MOVED_FROM | IN_MOVED_TO\fP と等価。
 197 .TP
 198 \fBIN_CLOSE\fP
 199 \fBIN_CLOSE_WRITE | IN_CLOSE_NOWRITE\fP と等価。
 200 .RE
 201 .PP
 202 その他にも以下のビットを \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定できる:
 203 .RS 4
 204 .TP
 205 \fBIN_DONT_FOLLOW\fP (Linux 2.6.15 以降)
 206 \fIpathname\fP がシンボリックリンクである場合に辿らない。 (Linux 2.6.15 以降)
 207 .TP
 208 \fBIN_EXCL_UNLINK\fP (Linux 2.6.36 以降)
 209 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
 210 デフォルトでは、あるディレクトリの子ファイルに関するイベントを監視 (watch) した際、ディレクトリからその子ファイルが削除 (unlink)
 211 された場合であってもその子ファイルに対してイベントが生成される。このことは、アプリケーションによってはあまり興味のないイベントが大量に発生することにつながる
 212 (例えば、\fI/tmp\fP を監視している場合、たくさんのアプリケーションが、すぐにその名前が削除される一時ファイルをそのディレクトリに作成する)。
 213 \fBIN_EXCL_UNLINK\fP
 214 を指定するとこのデフォルトの動作を変更でき、監視対象のディレクトリから子ファイルが削除された後に子ファイルに関するイベントが生成されなくなる。
 215 .TP
 216 \fBIN_MASK_ADD\fP
 217 監視インスタンスが \fIpathname\fP に対応するファイルシステムオブジェクトに対してすでに存在する場合に、 (マスクを置き換えるのではなく)
 218 監視マスクに \fImask\fP で指定されたイベントを追加 (OR) する。
 219 .TP
 220 \fBIN_ONESHOT\fP
 221 \fIpathname\fP に対応するファイルシステムオブジェクトを 1 イベントについてだけ監視し、 イベントが発生したら監視対象リストから削除する。
 222 .TP
 223 \fBIN_ONLYDIR\fP (Linux 2.6.15 以降)
 224 \fIpathname\fP がディレクトリの場合のみ監視する。
 225 このフラグを使うことで、アプリケーションは、競合状態を考慮せずに、監視するオブジェクトがディレクトリであることを保証することができるようになる。
 226 .RE
 227 .PP
 228 以下のビットが \fBread\fP(2)  で返される \fImask\fP フィールドに設定される:
 229 .RS 4
 230 .TP
 231 \fBIN_IGNORED\fP
 232 監視対象が (\fBinotify_rm_watch\fP(2) により) 明示的に 削除された。もしくは (ファイルの削除、またはファイル
 233 システムのアンマウントにより) 自動的に削除された。「バグ」も参照のこと。
 234 .TP
 235 \fBIN_ISDIR\fP
 236 このイベントの対象がディレクトリである。
 237 .TP
 238 \fBIN_Q_OVERFLOW\fP
 239 イベントキューが溢れた (このイベントの場合、\fIwd\fP は \-1 である)。
 240 .TP
 241 \fBIN_UNMOUNT\fP
 242 監視対象オブジェクトを含むファイルシステムがアンマウントされた。さらに、この監視対象ディスクリプターに対して \fBIN_IGNORED\fP
 243 イベントが生成される。
 244 .RE
 245 .SS 例
 246 アプリケーションがディレクトリ \fIdir\fP とファイル \fIdir/myfile\fP のすべてのイベントを監視しているとする。 以下に、これらの 2
 247 つのオブジェクトに対して生成されるイベントの例を示す。
 248 .RS 4
 249 .TP
 250 fd = open("dir/myfile", O_RDWR);
 251 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_OPEN\fP イベントが生成される。
 252 .TP
 253 read(fd, buf, count);
 254 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ACCESS\fP イベントが生成される
 255 .TP
 256 write(fd, buf, count);
 257 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_MODIFY\fP イベントが生成される
 258 .TP
 259 fchmod(fd, mode);
 260 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ATTRIB\fP イベントが生成される
 261 .TP
 262 close(fd);
 263 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_CLOSE_WRITE\fP イベントが生成される
 264 .RE
 265 .PP
 266 アプリケーションがディレクトリ \fIdir1\fP と \fIdir2\fP、およびファイル \fIdir1/myfile\fP を監視しているとする。
 267 以下に生成されるイベントの例を示す。
 268 .RS 4
 269 .TP
 270 link("dir1/myfile", "dir2/new");
 271 \fImyfile\fP に対して \fBIN_ATTRIB\fP イベントが生成され、 \fIdir2\fP に対して \fBIN_CREATE\fP イベントが生成される。
 272 .TP
 273 rename("dir1/myfile", "dir2/myfile");
 274 \fIdir1\fP に対してイベント \fBIN_MOVED_FROM\fP が、 \fIdir2\fP に対してイベント \fBIN_MOVED_TO\fP が、
 275 \fImyfile\fP に対してイベント \fBIN_MOVE_SELF\fP が生成される。この際 イベント \fBIN_MOVED_FROM\fP と
 276 \fBIN_MOVED_TO\fP は同じ \fIcookie\fP 値を持つ。
 277 .RE
 278 .PP
 279 \fIdir1/xx\fP と \fIdir2/yy\fP は同じファイルを参照するリンクで (他のリンクはないものとする)、 アプリケーションは \fIdir1\fP,
 280 \fIdir2\fP, \fIdir1/xx\fP, \fIdir2/yy\fP を監視しているものとする。
 281 以下に示す順序で下記の呼び出しを実行すると、以下のイベントが生成される。
 282 .RS 4
 283 .TP
 284 unlink("dir2/yy");
 285 \fIxx\fP に対して \fBIN_ATTRIB\fP イベントが生成され (リンク数が変化したため)、 \fIdir2\fP に対して \fBIN_DELETE\fP
 286 イベントが生成される。
 287 .TP
 288 unlink("dir1/xx");
 289 \fIxx\fP に対してイベント \fBIN_ATTRIB\fP, \fBIN_DELETE_SELF\fP, \fBIN_IGNORED\fP が生成され、 \fIdir1\fP
 290 に対して \fBIN_DELETE\fP イベントが生成される。
 291 .RE
 292 .PP
 293 アプリケーションがディレクトリ \fIdir\fP と (空の) ディレクトリ \fIdir/subdir\fP を監視しているものとする。
 294 以下に生成されるイベントの例を示す。
 295 .RS 4
 296 .TP
 297 mkdir("dir/new", mode);
 298 \fIdir\fP に対して \fBIN_CREATE | IN_ISDIR\fP イベントが生成される。
 299 .TP
 300 rmdir("dir/subdir");
 301 \fIsubdir\fP に対してイベント \fBIN_DELETE_SELF\fP と \fBIN_IGNORED\fP が生成され、 \fIdir\fP に対して
 302 \fBIN_DELETE | IN_ISDIR\fP イベントが生成される。
 303 .RE
 304 .SS "/proc インターフェース"
 305 以下のインターフェースは、inotify で消費される カーネルメモリの総量を制限するのに使用できる:
 306 .TP
 307 \fI/proc/sys/fs/inotify/max_queued_events\fP
 308 このファイルの値は、アプリケーションが \fBinotify_init\fP(2)  を呼び出すときに使用され、対応する inotify インスタンスについて
 309 キューに入れられるイベントの数の上限を設定する。 この制限を超えたイベントは破棄されるが、 \fBIN_Q_OVERFLOW\fP イベントが常に生成される。
 310 .TP
 311 \fI/proc/sys/fs/inotify/max_user_instances\fP
 312 1 つの実ユーザ ID に対して生成できる inotify インスタンスの数の上限を指定する。
 313 .TP
 314 \fI/proc/sys/fs/inotify/max_user_watches\fP
 315 作成可能な監視対象の数の実 UID 単位の上限を指定する。
 316 .SH バージョン
 317 inotify は 2.6.13 の Linux カーネルに組込まれた。 これに必要なライブラリのインターフェースは、 glibc のバージョン 2.4
 318 に追加された (\fBIN_DONT_FOLLOW\fP, \fBIN_MASK_ADD\fP, \fBIN_ONLYDIR\fP は glibc バージョン 2.5
 319 で追加された)。
 320 .SH 準拠
 321 inotify API は Linux 独自のものである。
 322 .SH 注意
 323 inotify ファイルディスクリプターは \fBselect\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)  を使って監視できる。
 324 イベントがある場合、ファイルディスクリプターは読み込み可能と通知する。
 325
 326 Linux 2.6.25 以降では、シグナル駆動 (signal\-driven) I/O の通知が inotify
 327 ファイルディスクリプターについて利用可能である。 \fBfcntl\fP(2)  に書かれている (\fBO_ASYNC\fP フラグを設定するための)
 328 \fBF_SETFL\fP, \fBF_SETOWN\fP, \fBF_SETSIG\fP の議論を参照のこと。 シグナルハンドラに渡される \fIsiginfo_t\fP
 329 構造体は、以下のフィールドが設定される (\fIsiginfo_t\fP は \fBsigaction\fP(2)  で説明されている)。 \fIsi_fd\fP には
 330 inotify ファイルディスクリプター番号が、 \fIsi_signo\fP にはシグナル番号が、 \fIsi_code\fP には \fBPOLL_IN\fP が、
 331 \fIsi_band\fP には \fBPOLLIN\fP が設定される。
 332
 333 inotify ファイルディスクリプターに対して 連続して生成される出力 inotify イベントが同一の場合 (\fIwd\fP, \fImask\fP,
 334 \fIcookie\fP, \fIname\fP が等しい場合)、 前のイベントがまだ読み込まれていなければ、 連続するイベントが 1 つのイベントにまとめられる
 335 (ただし「バグ」の節も参照のこと)。 これによりイベントキューに必要なカーネルメモリ量が減るが、
 336 これはまたアプリケーションがファイルイベント数を信頼性を持って数えるのに inotify を使用できないということでもある。
 337
 338 inotify ファイルディスクリプターの読み込みで返されるイベントは、 順序付けられたキューになる。
 339 従って、たとえば、あるディレクトリの名前を別の名前に変更した場合、 inotify ファイルディスクリプターについての正しい順番で
 340 イベントが生成されることが保証される。
 341
 342 \fBFIONREAD\fP \fBioctl\fP(2)  は inotify ファイルディスクリプターから何バイト読み込めるかを返す。
 343 .SS 制限と警告
 344 inotify API では、inotify イベントが発生するきっかけとなったユーザやプロセスに関する情報は提供されない。とりわけ、inotify
 345 経由でイベントを監視しているプロセスが、自分自身がきっかけとなったイベントと他のプロセスがきっかけとなったイベントを区別する簡単な手段はない。
 346
 347 inotify は、ファイルシステム API 経由でユーザー空間プログラムがきっかけとなったイベントだけを報告する。 結果として、 inotify
 348 はネットワークファイルシステムで発生したリモートのイベントを捉えることはできない
 349 (このようなイベントを捉えるにはアプリケーションはファイルシステムをポーリングする必要がある)。 さらに、 \fI/proc\fP, \fI/sys\fP,
 350 \fI/dev/pts\fP といったいくつかの疑似ファイルシステムは inotify で監視することができない。
 351
 352 inotify API は \fBmmap\fP(2), \fBmsync\fP(2), \fBmunmap\fP(2)
 353 により起こったファイルのアクセスと変更を報告しない。
 354
 355 inotify API では影響が受けるファイルをファイル名で特定する。
 356 しかしながら、アプリケーションが inotify イベントを処理する時点では、
 357 そのファイル名がすでに削除されたり変更されたりしている可能性がある。
 358
 359 inotify API では監視対象ディスクリプターを通してイベントが区別される。 (必要であれば)
 360 監視対象ディスクリプターとパス名のマッピングをキャッシュしておくのはアプリケーションの役目である。
 361 ディレクトリの名前変更の場合、キャッシュしている複数のパス名に影響がある点に注意すること。
 362
 363 inotify によるディレクトリの監視は再帰的に行われない: あるディレクトリ以下の
 364 サブディレクトリを監視する場合、 監視対象を追加で作成しなければならない。
 365 大きなディレクトリツリーの場合には、この作業にかなり時間がかかることがある。
 366
 367 ディレクトリツリー全体を監視していて、 そのツリー内に新しいサブディレクトリが作成されるか、
 368 既存のディレクトリが名前が変更されそのツリー内に移動した場合、 新しいサブディレクトリに対する watch を作成するまでに、 新しいファイル
 369 (やサブディレクトリ) がそのサブディレクトリ内にすでに作成されている場合がある点に注意すること。 したがって、watch
 370 を追加した直後にサブディレクトリの内容をスキャンしたいと思う場合もあるだろう (必要ならそのサブディレクトリ内のサブディレクトリに対する watch
 371 も再帰的に追加することもあるだろう)。
 372
 373 イベントキューはオーバーフローする場合があることに注意すること。 この場合、イベントは失なわれる。 ロバスト性が求められるアプリケーションでは、
 374 イベントが失なわれる可能性も含めて適切に処理を行うべきである。
 375 例えば、アプリケーション内のキャッシュの一部分または全てを再構築する必要があるかもしれない。 (単純だが、おそらくコストがかかる方法は、 inotify
 376 ファイルディスクリプターをクローズし、 キャッシュを空にし、 新しい inotify ファイルディスクリプターを作成し、
 377 監視しているオブジェクトの監視対象ディスクリプターとキャッシュエントリーの再作成を行う方法である。)
 378 .SS "rename() イベントの取り扱い"
 379 上述の通り、 \fBrename\fP(2) により生成される \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントの組は、共有される
 380 cookie 値によって対応を取ることができる。 しかし、対応を取る場合にはいくつか難しい点がある。
 381
 382 これらの 2 つのイベントは、 inotify ファイルディスクリプターから読み出しを行った場合に、通常はイベントストリーム内で連続している。
 383 しかしながら、連続していることは保証されていない。 複数のプロセスが監視対象オブジェクトでイベントを発生させた場合、 (めったに起こらないことだが)
 384 イベント \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP の間に任意の数の他のイベントがはさまる可能性がある。
 385 さらに、対となるイベントがアトミックにキューに挿入されることも保証されていない。 \fBIN_MOVED_FROM\fP が現れたが
 386 \fBIN_MOVED_TO\fP は現れていないという短い期間がありえるということだ。
 387
 388 したがって、 \fBrename\fP(2) により生成された \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP
 389 のイベントの組の対応を取るのは本質的に難しいことである (監視対象のディレクトリの外へオブジェクトの rename が行われた場合には
 390 \fBIN_MOVED_TO\fP イベントは存在しさえしないことを忘れてはならない)。 (イベントは常に連続しているとの仮定を置くといった)
 391 発見的な方法を使うと、ほとんどの場合でイベントの組をうまく見つけることができるが、 いくつかの場合に見逃すことが避けられず、 アプリケーションが
 392 \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントが無関係だとみなしてしまう可能性がある。
 393 結果的に、監視対象ディスクリプターが破棄され再作成された場合、これらの監視対象ディスクリプターは、処理待ちイベントの監視対象ディスクリプターと一貫性のないものになってしまう
 394 (inotify ファイルディスクリプタの再作成とキャッシュの再構成はこの状況に対処するのに有用な方法なのだが)。
 395
 396 また、アプリケーションは、 \fBIN_MOVED_FROM\fP イベントが今行った \fBread\fP(2)
 397 の呼び出しで返されたバッファーのちょうど一番最後のイベントで、 \fBIN_MOVED_TO\fP イベントは次の \fBread\fP(2)
 398 を行わないと取得できない可能性も考慮に入れる必要がある。 2 つ目の \fBread\fP(2) は (短い) タイムアウトで行うべきである。 これは、
 399 \fBIN_MOVED_FROM\fP\-\fBIN_MOVED_TO\fP のイベントペアのキューへの挿入はアトミックではなく、 また \fBIN_MOVED_TO\fP
 400 イベントが全く発生しない可能性もあるという事実を考慮に入れておく必要があるからである。
 401 .SH バグ
 402 カーネル 3.17 時点では、 \fBfallocate\fP(2) の呼び出しでは inotify イベントが生成されない。
 403
 404 .\" FIXME . kernel commit 611da04f7a31b2208e838be55a42c7a1310ae321
 405 .\" implies that unmount events were buggy 2.6.11 to 2.6.36
 406 .\"
 407 2.6.16 以前のカーネルでは \fBIN_ONESHOT\fP \fImask\fP フラグが働かない。
 408
 409 元々は設計/実装時の意図通り、 イベントが一つ発生し watch が削除された際に \fBIN_ONESHOT\fP フラグでは \fBIN_IGNORED\fP
 410 イベントが発生しなかった。 しかし、 別の変更での意図していなかった影響により、 Linux 2.6.36 以降では、 この場合に
 411 \fBIN_IGNORED\fP イベントが生成される。
 412
 413 .\" commit 1c17d18e3775485bf1e0ce79575eb637a94494a2
 414 カーネル 2.6.25 より前では、 連続する同一のイベントを一つにまとめることを意図したコード (古い方のイベントがまだ読み込まれていない場合に、
 415 最新の 2 つのイベントを一つにまとめられる可能性がある) が、 最新のイベントが「最も古い」読み込まれていないイベントとまとめられるか
 416 をチェックするようになっていた。
 417
 418 .\" FIXME . https://bugzilla.kernel.org/show_bug.cgi?id=77111
 419 \fBinotify_rm_watch\fP(2) の呼び出しにより監視対象ディスクリプターが削除された場合
 420 (なお、監視対象ファイルの削除や監視対象ファイルが含まれるファイルシステムのアンマウントによっても監視対象ディスクリプターは削除される)、
 421 この監視対象ディスクリプター関連の処理待ちの未読み出しイベントは、 読み出し可能なままとなる。 監視対象ディスクリプターは
 422 \fBinotify_add_watch\fP(2) によって後で割り当てられるため、 カーネルは利用可能な監視対象ディスクリプターの範囲 (0 から
 423 \fBINT_MAX\fP) から昇順にサイクリックに割り当てを行う。未使用の監視対象ディスクリプターを割り当てる際、 その監視対象ディスクリプター番号に
 424 inotify キューで処理待ちの未読み出しイベントがあるかの確認は行われない。 したがって、監視対象ディスクリプターが再割り当てされた際に、
 425 その監視対象ディスクリプターの一つ前の使用時に発生した処理待ちの未読み出しイベントが存在するということが起こりうる。
 426 その結果、アプリケーションはこれらのイベントを読み出す可能性があり、
 427 これらのイベントが新しく再利用された監視対象ディスクリプターに関連付けられたファイルに属するものかを解釈する必要が出て来る。
 428 実際のところ、このバグを踏む可能性は極めて低い。 それは、このバグを踏むためには、アプリケーションが \fBINT_MAX\fP
 429 個の監視対象ディスクリプターが一周させて、 キューに未読み出しイベントが残っている監視対象ディスクリプターを解放し、
 430 その監視対象ディスクリプターを再利用する必要があるからである。 この理由と、実世界のアプリケーションで発生したというバグ報告がないことから、 Linux
 431 3.15 時点では、この計算上は起こりうるバグを取り除くためのカーネルの変更は行われていない。
 432 .SH 例
 433 以下のプログラムは inotify API の使用例を示したものである。 コマンドライン引き数で渡されたディレクトリに印を付け、 タイプが
 434 \fBIN_OPEN\fP, \fBIN_CLOSE_NOWRITE\fP \fBIN_CLOSE_WRITE\fP のイベントを待つ。
 435 .PP
 436 以下は、 ファイル \fI/home/user/temp/foo\fP を編集し、 ディレクトリ \fI/tmp\fP の一覧表示を行った場合の出力である。
 437 対象のファイルとディレクトリがオープンされる前に、イベント \fBIN_OPEN\fP が発生している。 対象ファイルがクローズされた後にイベント
 438 \fBIN_CLOSE_WRITE\fP が発生している。 対象ディレクトリがクローズされた後にイベント \fBIN_CLOSE_NOWRITE\fP
 439 が発生している。 ユーザーが ENTER キーを押すると、プログラムの実行は終了する。
 440 .SS 出力例
 441 .in +4n
 442 .nf
 443 $ \fB./a.out /tmp /home/user/temp\fP
 444 Press enter key to terminate.
 445 Listening for events.
 446 IN_OPEN: /home/user/temp/foo [file]
 447 IN_CLOSE_WRITE: /home/user/temp/foo [file]
 448 IN_OPEN: /tmp/ [directory]
 449 IN_CLOSE_NOWRITE: /tmp/ [directory]
 450
 451 Listening for events stopped.
 452 .fi
 453 .in
 454 .SS プログラムソース
 455 .nf
 456 #include <errno.h>
 457 #include <poll.h>
 458 #include <stdio.h>
 459 #include <stdlib.h>
 460 #include <sys/inotify.h>
 461 #include <unistd.h>
 462
 463 /* Read all available inotify events from the file descriptor 'fd'.
 464    wd is the table of watch descriptors for the directories in argv.
 465    argc is the length of wd and argv.
 466    argv is the list of watched directories.
 467    Entry 0 of wd and argv is unused. */
 468
 469 static void
 470 handle_events(int fd, int *wd, int argc, char* argv[])
 471 {
 472     /* Some systems cannot read integer variables if they are not
 473        properly aligned. On other systems, incorrect alignment may
 474        decrease performance. Hence, the buffer used for reading from
 475        the inotify file descriptor should have the same alignment as
 476        struct inotify_event. */
 477
 478     char buf[4096]
 479         __attribute__ ((aligned(__alignof__(struct inotify_event))));
 480     const struct inotify_event *event;
 481     int i;
 482     ssize_t len;
 483     char *ptr;
 484
 485     /* Loop while events can be read from inotify file descriptor. */
 486
 487     for (;;) {
 488
 489         /* Read some events. */
 490
 491         len = read(fd, buf, sizeof buf);
 492         if (len == \-1 && errno != EAGAIN) {
 493             perror("read");
 494             exit(EXIT_FAILURE);
 495         }
 496
 497         /* If the nonblocking read() found no events to read, then
 498            it returns \-1 with errno set to EAGAIN. In that case,
 499            we exit the loop. */
 500
 501         if (len <= 0)
 502             break;
 503
 504         /* バッファー内の全イベントを処理する */
 505
 506         for (ptr = buf; ptr < buf + len;
 507                 ptr += sizeof(struct inotify_event) + event\->len) {
 508
 509             event = (const struct inotify_event *) ptr;
 510
 511             /* Print event type */
 512
 513             if (event\->mask & IN_OPEN)
 514                 printf("IN_OPEN: ");
 515             if (event\->mask & IN_CLOSE_NOWRITE)
 516                 printf("IN_CLOSE_NOWRITE: ");
 517             if (event\->mask & IN_CLOSE_WRITE)
 518                 printf("IN_CLOSE_WRITE: ");
 519
 520             /* Print the name of the watched directory */
 521
 522             for (i = 1; i < argc; ++i) {
 523                 if (wd[i] == event\->wd) {
 524                     printf("%s/", argv[i]);
 525                     break;
 526                 }
 527             }
 528
 529             /* Print the name of the file */
 530
 531             if (event\->len)
 532                 printf("%s", event\->name);
 533
 534             /* Print type of filesystem object */
 535
 536             if (event\->mask & IN_ISDIR)
 537                 printf(" [directory]\en");
 538             else
 539                 printf(" [file]\en");
 540         }
 541     }
 542 }
 543
 544 int
 545 main(int argc, char* argv[])
 546 {
 547     char buf;
 548     int fd, i, poll_num;
 549     int *wd;
 550     nfds_t nfds;
 551     struct pollfd fds[2];
 552
 553     if (argc < 2) {
 554         printf("Usage: %s PATH [PATH ...]\en", argv[0]);
 555         exit(EXIT_FAILURE);
 556     }
 557
 558     printf("Press ENTER key to terminate.\en");
 559
 560     /* Create the file descriptor for accessing the inotify API */
 561
 562     fd = inotify_init1(IN_NONBLOCK);
 563     if (fd == \-1) {
 564         perror("inotify_init1");
 565         exit(EXIT_FAILURE);
 566     }
 567
 568     /* Allocate memory for watch descriptors */
 569
 570     wd = calloc(argc, sizeof(int));
 571     if (wd == NULL) {
 572         perror("calloc");
 573         exit(EXIT_FAILURE);
 574     }
 575
 576     /* Mark directories for events
 577        \- file was opened
 578        \- file was closed */
 579
 580     for (i = 1; i < argc; i++) {
 581         wd[i] = inotify_add_watch(fd, argv[i],
 582                                   IN_OPEN | IN_CLOSE);
 583         if (wd[i] == \-1) {
 584             fprintf(stderr, "Cannot watch '%s'\en", argv[i]);
 585             perror("inotify_add_watch");
 586             exit(EXIT_FAILURE);
 587         }
 588     }
 589
 590     /* ポーリングの準備 */
 591
 592     nfds = 2;
 593
 594     /* コンソールの入力 */
 595
 596     fds[0].fd = STDIN_FILENO;
 597     fds[0].events = POLLIN;
 598
 599     /* Inotify input */
 600
 601     fds[1].fd = fd;
 602     fds[1].events = POLLIN;
 603
 604     /* Wait for events and/or terminal input */
 605
 606     printf("Listening for events.\en");
 607     while (1) {
 608         poll_num = poll(fds, nfds, \-1);
 609         if (poll_num == \-1) {
 610             if (errno == EINTR)
 611                 continue;
 612             perror("poll");
 613             exit(EXIT_FAILURE);
 614         }
 615
 616         if (poll_num > 0) {
 617
 618             if (fds[0].revents & POLLIN) {
 619
 620                 /* Console input is available. Empty stdin and quit */
 621
 622                 while (read(STDIN_FILENO, &buf, 1) > 0 && buf != '\en')
 623                     continue;
 624                 break;
 625             }
 626
 627             if (fds[1].revents & POLLIN) {
 628
 629                 /* Inotify events are available */
 630
 631                 handle_events(fd, wd, argc, argv);
 632             }
 633         }
 634     }
 635
 636     printf("Listening for events stopped.\en");
 637
 638     /* Close inotify file descriptor */
 639
 640     close(fd);
 641
 642     free(wd);
 643     exit(EXIT_SUCCESS);
 644 }
 645 .fi
 646 .SH 関連項目
 647 \fBinotifywait\fP(1), \fBinotifywatch\fP(1), \fBinotify_add_watch\fP(2),
 648 \fBinotify_init\fP(2), \fBinotify_init1\fP(2), \fBinotify_rm_watch\fP(2), \fBread\fP(2),
 649 \fBstat\fP(2), \fBfanotify\fP(7)
 650
 651 Linux カーネルソース内の \fIDocumentation/filesystems/inotify.txt\fP
 652 .SH この文書について
 653 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.76 の一部
 654 である。プロジェクトの説明とバグ報告に関する情報は
 655 http://www.kernel.org/doc/man\-pages/ に書かれている。