OSDN Git Service

7c280c24995b258a5be2a8ad2cca07ac18802e2a
[linuxjm/LDP_man-pages.git] / release / man7 / inotify.7
1 .\" t
2 .\" Copyright (C) 2006, 2014 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 .\"
32 .\" Japanese Version Copyright (c) 2006 Yuichi SATO
33 .\"     and Copyright (c) 2007-2008 Akihiro MOTOKI
34 .\" Translated 2006-07-05 by Yuichi SATO <ysato444@yahoo.co.jp>, LDP v2.29
35 .\" Updated 2006-07-20 by Yuichi SATO, LDP v2.36
36 .\" Updated 2007-06-13, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.55
37 .\" Updated 2008-08-10, Akihiro MOTOKI, LDP v3.05
38 .\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.08
39 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
40 .\" Updated 2012-05-01, Akihiro MOTOKI <amotoki@gmail.com>
41 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
42 .\" Updated 2013-07-22, Akihiro MOTOKI <amotoki@gmail.com>
43 .\" Updated 2013-08-21, Akihiro MOTOKI <amotoki@gmail.com>, LDP v3.53
44 .\"
45 .TH INOTIFY 7 2014\-04\-01 Linux "Linux Programmer's Manual"
46 .SH 名前
47 inotify \- ファイルシステムイベントを監視する
48 .SH 説明
49 \fIinotify\fP API はファイルシステムイベントを監視するための機構を提供する。 inotify
50 は個々のファイルやディレクトリを監視するのに使える。 ディレクトリを監視する場合、inotify はディレクトリ自身と
51 ディレクトリ内のファイルのイベントを返す。
52
53 この API では以下のシステムコールが使用される。
54 .IP * 3
55 \fBinotify_init\fP(2)  は inotify インスタンスを作成し、inotify インスタンスを参照する ファイルディスクリプタを返す。
56 より新しい \fBinotify_init1\fP(2)  も \fBinotify_init\fP(2)  と同様だが、
57 こちらにはいくつかの追加の機能を利用するための \fIflags\fP 引き数がある。
58 .IP *
59 \fBinotify_add_watch\fP(2)  は inotify インスタンスに関連づけられた「監視対象 (watch) リスト」を操作する。
60 監視対象リストの各アイテム ("watch") は、 ファイルまたはディレクトリのパス名と、 そのパス名で参照されるファイルに対して
61 カーネルが監視する複数のイベントの集合を指定する。 \fBinotify_add_watch\fP(2)
62 は新しい監視アイテムの作成や既存の監視対象の変更ができる。 各監視対象は一意の「監視対象ディスクリプタ」を持つ。 これは監視対象を作成したときに
63 \fBinotify_add_watch\fP(2)  から返される整数である。
64 .IP *
65 監視しているファイルやディレクトリでイベントが起こると、 それらのイベントはアプリケーションから inotify ファイルディスクリプタから
66 \fBread\fP(2) を使って構造化データとして読み出すことができる (下記参照)。
67 .IP *
68 \fBinotify_rm_watch\fP(2)  は inotify の監視対象リストからアイテムを削除する。
69 .IP *
70 inotify インスタンスを指している 全てのファイルディスクリプタが (\fBclose\fP(2) を使って) クローズされた場合、
71 その下層にあるオブジェクトとそのリソースは、 カーネルで再利用するために解放される。 関連が切られた監視対象は自動的に解放される。
72
73 注意深くプログラミングすることで、 アプリケーションは inotify
74 を使ってファイルシステムオブジェクトの集合の状態を効率的に監視しキャッシュしておくことができる。
75 しかしながら、ロバストなアプリケーションでは、監視ロジックのバグや以下に説明があるような種類の競合条件によりファイルシステムの状態とキャッシュが一致しない状態になることがあるという事実も考慮に入れておくべきである。
76 おそらく何らかの一貫性のチェックを行い、不一致が検出された場合にはキャッシュを再構築するのが懸命だろう。
77 .SS "inotify ファイルディスクリプタからのイベントの読み出し"
78 どのようなイベントが起こっていたかを知るには、 アプリケーションで inotify ファイルディスクリプタを \fBread\fP(2)  すればよい。
79 これまでに何もイベントが起こっていない場合、 停止 (blocking) モードのファイルディスクリプタであれば、 少なくとも 1
80 つのイベントが起こるまで \fBread\fP(2)  は停止する (シグナルにより割り込まれなかった場合。
81 シグナルによる割り込みがあった場合、呼び出しはエラー \fBEINTR\fP で失敗する。 \fBsignal\fP(7)  参照)。
82
83 \fBread\fP(2)  が成功すると、以下の構造体を 1 つ以上含むバッファが返される:
84 .in +4n
85 .nf
86
87 .\" FIXME . The type of the 'wd' field should probably be "int32_t".
88 .\" I submitted a patch to fix this.  See the LKML thread
89 .\" "[patch] Fix type errors in inotify interfaces", 18 Nov 2008
90 .\" Glibc bug filed: http://sources.redhat.com/bugzilla/show_bug.cgi?id=7040
91 struct inotify_event {
92     int      wd;       /* 監視対象ディスクリプタ */
93     uint32_t mask;     /* イベントのマスク */
94     uint32_t cookie;   /* 関連するイベント群を関連づける
95                           一意なクッキー (rename(2) 用) */
96     uint32_t len;      /* \(aqname\(aq フィールドのサイズ */
97     char     name[];   /* ヌルで終端された任意の名前 */
98 };
99 .fi
100 .in
101
102 \fIwd\fP はイベント発生の監視対象を指定する。 これは、前もって行われた \fBinotify_add_watch\fP(2)
103 呼び出しで返された監視対象ディスクリプタのうちの 1 つである。
104
105 \fImask\fP には発生したイベント (下記参照) を記述するためのビットが含まれる。
106
107 \fIcookie\fP は関連するイベントを関連づけるための一意な整数である。
108 現在のところ、この値は rename イベントに対してのみ使われており、
109 結果のペアである \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントを
110 アプリケーションで関連づけることができる。
111 他のイベント種別の場合には、 \fIcookie\fP は 0 に設定する。
112
113 \fIname\fP フィールドは監視しているディレクトリ内のファイルに対して イベントが返される場合のためにだけ存在する。
114 監視するディレクトリからのファイルの相対パス名を表す。 このパス名はヌルで終端され、 その後の読み込みで適切なアドレス境界に調整するために、
115 さらにヌルバイト (\(aq\e0\(aq) が含まれる場合もある。
116
117 \fIlen\fP フィールドはヌルバイトを含む \fIname\fP の全てのバイト数を表す。
118 よって、 \fIinotify_event\fP 構造体のサイズは
119 \fIsizeof(struct inotify_event)+len\fP である。
120
121 \fBread\fP(2) に渡されたバッファが小さすぎて次のイベントに関する情報を返せ
122 ない場合の動作はカーネルのバージョンにより異なる。 2.6.21 より前のカー
123 ネルでは、 \fBread\fP(2) は 0 を返す。 2.6.21 以降のカーネルでは、
124 \fBread\fP(2) はエラー \fBEINVAL\fP で失敗する。
125 バッファサイズとして
126
127     sizeof(struct inotify_event) + NAME_MAX + 1
128
129 を指定すれば、少なくとも 1 イベントで読み出しを行うには十分である。
130 .SS "inotify イベント"
131 \fBinotify_add_watch\fP(2)  の \fImask\fP 引き数と、inotify ファイル構造体を \fBread\fP(2)
132 したときに返される \fIinotify_event\fP 構造体の \fImask\fP フィールドは、ともに inotify イベントを識別するための
133 ビットマスクである。 以下のビットが \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定可能であり、
134 \fBread\fP(2)  で返される \fImask\fP フィールドで返される:
135 .RS 4
136 .TP 
137 \fBIN_ACCESS\fP (*)
138 (\fBread\fP(2), \fBexecve\fP(2) などで) ファイルがアクセスされた。
139 .TP 
140 \fBIN_ATTRIB\fP (*)
141 メタデータが変更された。 メタデータとは、例えば、アクセス許可 (\fBchmod\fP(2))、タイムスタンプ (\fButimensat\fP(2)
142 など)、拡張属性 (\fBsetxattr\fP(2))、 リンクカウント (Linux 2.6.25 以降; \fBlink\fP(2) のリンク先や
143 \fBunlink\fP(2) など)、ユーザー/グループ ID (\fBchown\fP(2) など) などである。
144 .TP 
145 \fBIN_CLOSE_WRITE\fP (*)
146 書き込みのためにオープンされたファイルがクローズされた。
147 .TP 
148 \fBIN_CLOSE_NOWRITE\fP (*)
149 書き込み以外のためにオープンされたファイルがクローズされた。
150 .TP 
151 \fBIN_CREATE\fP (*)
152 監視対象ディレクトリ内でファイルやディレクトリが作成された (\fBopen\fP(2)  \fBO_CREAT\fP, \fBmkdir\fP(2),
153 \fBlink\fP(2), \fBsymlink\fP(2), UNIX ドメインソケットに対する \fBbind\fP(2) など)。
154 .TP 
155 \fBIN_DELETE\fP (*)
156 監視対象ディレクトリ内でファイルやディレクトリが削除された。
157 .TP 
158 \fBIN_DELETE_SELF\fP
159 監視対象のファイルやディレクトリ自身が削除あれた。 (このイベントはオブジェクトが別のファイルシステムに移動された場合にも発生する。 \fBmv\fP(1)
160 は実際には別のファイルシステムにファイルをコピーした後、元のファイルシステムからそのファイルを削除するからである。) また、
161 結果的に監視ディスクリプタに対して \fBIN_IGNORED\fP イベントも生成される。
162 .TP 
163 \fBIN_MODIFY\fP (*)
164 ファイルが変更された (\fBwrite\fP(2), \fBtruncate\fP(2) など)。
165 .TP 
166 \fBIN_MOVE_SELF\fP
167 監視対象のディレクトリまたはファイル自身が移動された。
168 .TP 
169 \fBIN_MOVED_FROM\fP (*)
170 ファイル名の変更を行った際に変更前のファイル名が含まれるディレクトリに対して生成される。
171 .TP 
172 \fBIN_MOVED_TO\fP (*)
173 ファイル名の変更を行った際に新しいファイル名が含まれるディレクトリに対して生成される。
174 .TP 
175 \fBIN_OPEN\fP (*)
176 ファイルがオープンされた。
177 .RE
178 .PP
179 ディレクトリを監視する場合、 上記でアスタリスク (*) を付けたイベントは、 そのディレクトリ内のファイルに対して発生する。 このとき
180 \fIinotify_event\fP 構造体で返される \fIname\fP フィールドは、ディレクトリ内のファイル名を表す。
181 .PP
182 \fBIN_ALL_EVENTS\fP マクロは上記のイベント全てのマスクとして定義される。 このマクロは \fBinotify_add_watch\fP(2)
183 を呼び出すときの \fImask\fP 引き数として使える。
184
185 以下の 2 つの便利なマクロが定義されている。
186 .RS 4
187 .TP 
188 \fBIN_MOVE\fP
189 \fBIN_MOVED_FROM | IN_MOVED_TO\fP と等価。
190 .TP 
191 \fBIN_CLOSE\fP
192 \fBIN_CLOSE_WRITE | IN_CLOSE_NOWRITE\fP と等価。
193 .RE
194 .PP
195 その他にも以下のビットを \fBinotify_add_watch\fP(2)  を呼ぶときの \fImask\fP に指定できる:
196 .RS 4
197 .TP 
198 \fBIN_DONT_FOLLOW\fP (Linux 2.6.15 以降)
199 \fIpathname\fP がシンボリックリンクである場合に辿らない。 (Linux 2.6.15 以降)
200 .TP 
201 \fBIN_EXCL_UNLINK\fP (Linux 2.6.36 以降)
202 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
203 デフォルトでは、あるディレクトリの子ファイルに関するイベントを監視 (watch) した際、ディレクトリからその子ファイルが削除 (unlink)
204 された場合であってもその子ファイルに対してイベントが生成される。このことは、アプリケーションによってはあまり興味のないイベントが大量に発生することにつながる
205 (例えば、\fI/tmp\fP を監視している場合、たくさんのアプリケーションが、すぐにその名前が削除される一時ファイルをそのディレクトリに作成する)。
206 \fBIN_EXCL_UNLINK\fP
207 を指定するとこのデフォルトの動作を変更でき、監視対象のディレクトリから子ファイルが削除された後に子ファイルに関するイベントが生成されなくなる。
208 .TP 
209 \fBIN_MASK_ADD\fP
210 \fIpathname\fP に対する監視マスクが既に存在する場合、 (マスクの置き換えではなく) イベントを追加 (OR) する。
211 .TP 
212 \fBIN_ONESHOT\fP
213 1 つのイベントについて \fIpathname\fP を監視し、 イベントが発生したら監視対象リストから削除する。
214 .TP 
215 \fBIN_ONLYDIR\fP (Linux 2.6.15 以降)
216 \fIpathname\fP がディレクトリの場合にのみ監視する。
217 .RE
218 .PP
219 以下のビットが \fBread\fP(2)  で返される \fImask\fP フィールドに設定される:
220 .RS 4
221 .TP 
222 \fBIN_IGNORED\fP
223 監視対象が (\fBinotify_rm_watch\fP(2) により) 明示的に 削除された。もしくは (ファイルの削除、またはファイル
224 システムのアンマウントにより) 自動的に削除された。「バグ」も参照のこと。
225 .TP 
226 \fBIN_ISDIR\fP
227 このイベントの対象がディレクトリである。
228 .TP 
229 \fBIN_Q_OVERFLOW\fP
230 イベントキューが溢れた (このイベントの場合、\fIwd\fP は \-1 である)。
231 .TP 
232 \fBIN_UNMOUNT\fP
233 監視対象オブジェクトを含むファイルシステムがアンマウントされた。さらに、この監視対象ディスクリプタに対して \fBIN_IGNORED\fP
234 イベントが生成される。
235 .RE
236 .SS 例
237 アプリケーションがディレクトリ \fIdir\fP とファイル \fIdir/myfile\fP のすべてのイベントを監視しているとする。 以下に、これらの 2
238 つのオブジェクトに対して生成されるイベントの例を示す。
239 .RS 4
240 .TP 
241 fd = open("dir/myfile", O_RDWR);
242 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_OPEN\fP イベントが生成される。
243 .TP 
244 read(fd, buf, count);
245 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ACCESS\fP イベントが生成される
246 .TP 
247 write(fd, buf, count);
248 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_MODIFY\fP イベントが生成される
249 .TP 
250 fchmod(fd, mode);
251 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_ATTRIB\fP イベントが生成される
252 .TP 
253 close(fd);
254 \fIdir\fP と \fIdir/myfile\fP の両方に対して \fBIN_CLOSE_WRITE\fP イベントが生成される
255 .RE
256 .PP
257 アプリケーションがディレクトリ \fIdir1\fP と \fIdir2\fP、およびファイル \fIdir1/myfile\fP を監視しているとする。
258 以下に生成されるイベントの例を示す。
259 .RS 4
260 .TP 
261 link("dir1/myfile", "dir2/new");
262 \fImyfile\fP に対して \fBIN_ATTRIB\fP イベントが生成され、 \fIdir2\fP に対して \fBIN_CREATE\fP イベントが生成される。
263 .TP 
264 rename("dir1/myfile", "dir2/myfile");
265 \fIdir1\fP に対してイベント \fBIN_MOVED_FROM\fP が、 \fIdir2\fP に対してイベント \fBIN_MOVED_TO\fP が、
266 \fImyfile\fP に対してイベント \fBIN_MOVE_SELF\fP が生成される。この際 イベント \fBIN_MOVED_FROM\fP と
267 \fBIN_MOVED_TO\fP は同じ \fIcookie\fP 値を持つ。
268 .RE
269 .PP
270 \fIdir1/xx\fP と \fIdir2/yy\fP は同じファイルを参照するリンクで (他のリンクはないものとする)、 アプリケーションは \fIdir1\fP,
271 \fIdir2\fP, \fIdir1/xx\fP, \fIdir2/yy\fP を監視しているものとする。
272 以下に示す順序で下記の呼び出しを実行すると、以下のイベントが生成される。
273 .RS 4
274 .TP 
275 unlink("dir2/yy");
276 \fIxx\fP に対して \fBIN_ATTRIB\fP イベントが生成され (リンク数が変化したため)、 \fIdir2\fP に対して \fBIN_DELETE\fP
277 イベントが生成される。
278 .TP 
279 unlink("dir1/xx");
280 \fIxx\fP に対してイベント \fBIN_ATTRIB\fP, \fBIN_DELETE_SELF\fP, \fBIN_IGNORED\fP が生成され、 \fIdir1\fP
281 に対して \fBIN_DELETE\fP イベントが生成される。
282 .RE
283 .PP
284 アプリケーションがディレクトリ \fIdir\fP と (空の) ディレクトリ \fIdir/subdir\fP を監視しているものとする。
285 以下に生成されるイベントの例を示す。
286 .RS 4
287 .TP 
288 mkdir("dir/new", mode);
289 \fIdir\fP に対して \fBIN_CREATE | IN_ISDIR\fP イベントが生成される。
290 .TP 
291 rmdir("dir/subdir");
292 \fIsubdir\fP に対してイベント \fBIN_DELETE_SELF\fP と \fBIN_IGNORED\fP が生成され、 \fIdir\fP に対して
293 \fBIN_DELETE | IN_ISDIR\fP イベントが生成される。
294 .RE
295 .SS "/proc インターフェース"
296 以下のインターフェースは、inotify で消費される カーネルメモリの総量を制限するのに使用できる:
297 .TP 
298 \fI/proc/sys/fs/inotify/max_queued_events\fP
299 このファイルの値は、アプリケーションが \fBinotify_init\fP(2)  を呼び出すときに使用され、対応する inotify インスタンスについて
300 キューに入れられるイベントの数の上限を設定する。 この制限を超えたイベントは破棄されるが、 \fBIN_Q_OVERFLOW\fP イベントが常に生成される。
301 .TP 
302 \fI/proc/sys/fs/inotify/max_user_instances\fP
303 1 つの実ユーザ ID に対して生成できる inotify インスタンスの数の上限を指定する。
304 .TP 
305 \fI/proc/sys/fs/inotify/max_user_watches\fP
306 作成可能な監視対象の数の実 UID 単位の上限を指定する。
307 .SH バージョン
308 inotify は 2.6.13 の Linux カーネルに組込まれた。 これに必要なライブラリのインターフェースは、 glibc のバージョン 2.4
309 に追加された (\fBIN_DONT_FOLLOW\fP, \fBIN_MASK_ADD\fP, \fBIN_ONLYDIR\fP は glibc バージョン 2.5
310 で追加された)。
311 .SH 準拠
312 inotify API は Linux 独自のものである。
313 .SH 注意
314 inotify ファイルディスクリプタは \fBselect\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)  を使って監視できる。
315 イベントがある場合、ファイルディスクリプタは読み込み可能と通知する。
316
317 Linux 2.6.25 以降では、シグナル駆動 (signal\-driven) I/O の通知が inotify
318 ファイルディスクリプタについて利用可能である。 \fBfcntl\fP(2)  に書かれている (\fBO_ASYNC\fP フラグを設定するための)
319 \fBF_SETFL\fP, \fBF_SETOWN\fP, \fBF_SETSIG\fP の議論を参照のこと。 シグナルハンドラに渡される \fIsiginfo_t\fP
320 構造体は、以下のフィールドが設定される (\fIsiginfo_t\fP は \fBsigaction\fP(2)  で説明されている)。 \fIsi_fd\fP には
321 inotify ファイルディスクリプタ番号が、 \fIsi_signo\fP にはシグナル番号が、 \fIsi_code\fP には \fBPOLL_IN\fP が、
322 \fIsi_band\fP には \fBPOLLIN\fP が設定される。
323
324 inotify ファイルディスクリプタに対して 連続して生成される出力 inotify イベントが同一の場合 (\fIwd\fP, \fImask\fP,
325 \fIcookie\fP, \fIname\fP が等しい場合)、 前のイベントがまだ読み込まれていなければ、 連続するイベントが 1 つのイベントにまとめられる
326 (ただし「バグ」の節も参照のこと)。 これによりイベントキューに必要なカーネルメモリ量が減るが、
327 これはまたアプリケーションがファイルイベント数を信頼性を持って数えるのに inotify を使用できないということでもある。
328
329 inotify ファイルディスクリプタの読み込みで返されるイベントは、 順序付けられたキューになる。
330 従って、たとえば、あるディレクトリの名前を別の名前に変更した場合、 inotify ファイルディスクリプタについての正しい順番で
331 イベントが生成されることが保証される。
332
333 \fBFIONREAD\fP \fBioctl\fP(2)  は inotify ファイルディスクリプタから何バイト読み込めるかを返す。
334 .SS 制限と警告
335 inotify API では、inotify イベントが発生するきっかけとなったユーザやプロセスに関する情報は提供されない。とりわけ、inotify
336 経由でイベントを監視しているプロセスが、自分自身がきっかけとなったイベントと他のプロセスがきっかけとなったイベントを区別する簡単な手段はない。
337
338 inotify は、ファイルシステム API 経由でユーザー空間プログラムがきっかけとなったイベントだけを報告する。 結果として、 inotify
339 はネットワークファイルシステムで発生したリモートのイベントを捉えることはできない
340 (このようなイベントを捉えるにはアプリケーションはファイルシステムをポーリングする必要がある)。 さらに、 \fI/proc\fP, \fI/sys\fP,
341 \fI/dev/pts\fP といったいくつかの疑似ファイルシステムは inotify で監視することができない。
342
343 inotify API は \fBmmap\fP(2) と \fBmsync\fP(2) により起こったファイルのアクセスと変更を報告しない。
344
345 inotify API では影響が受けるファイルをファイル名で特定する。
346 しかしながら、アプリケーションが inotify イベントを処理する時点では、
347 そのファイル名がすでに削除されたり変更されたりしている可能性がある。
348
349 inotify API では監視対象ディスクリプタを通してイベントが区別される。 (必要であれば)
350 監視対象ディスクリプタとパス名のマッピングをキャッシュしておくのはアプリケーションの役目である。
351 ディレクトリの名前変更の場合、キャッシュしている複数のパス名に影響がある点に注意すること。
352
353 inotify によるディレクトリの監視は再帰的に行われない: あるディレクトリ以下の
354 サブディレクトリを監視する場合、 監視対象を追加で作成しなければならない。
355 大きなディレクトリツリーの場合には、この作業にかなり時間がかかることがある。
356
357 ディレクトリツリー全体を監視していて、 そのツリー内に新しいサブディレクトリが作成されるか、
358 既存のディレクトリが名前が変更されそのツリー内に移動した場合、 新しいサブディレクトリに対する watch を作成するまでに、 新しいファイル
359 (やサブディレクトリ) がそのサブディレクトリ内にすでに作成されている場合がある点に注意すること。 したがって、watch
360 を追加した直後にサブディレクトリの内容をスキャンしたいと思う場合もあるだろう (必要ならそのサブディレクトリ内のサブディレクトリに対する watch
361 も再帰的に追加することもあるだろう)。
362
363 イベントキューはオーバーフローする場合があることに注意すること。 この場合、イベントは失なわれる。 ロバスト性が求められるアプリケーションでは、
364 イベントが失なわれる可能性も含めて適切に処理を行うべきである。
365 例えば、アプリケーション内のキャッシュの一部分または全てを再構築する必要があるかもしれない。 (単純だが、おそらくコストがかかる方法は、 inotify
366 ファイルディスクリプタをクローズし、 キャッシュを空にし、 新しい inotify ファイルディスクリプタを作成し、
367 監視しているオブジェクトの監視対象ディスクリプタとキャッシュエントリーの再作成を行う方法である。)
368 .SS "rename() イベントの取り扱い"
369 上述の通り、 \fBrename\fP(2) により生成される \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントの組は、共有される
370 cookie 値によって対応を取ることができる。 しかし、対応を取る場合にはいくつか難しい点がある。
371
372 これらの 2 つのイベントは、 inotify ファイルディスクリプタから読み出しを行った場合に、通常はイベントストリーム内で連続している。
373 しかしながら、連続していることは保証されていない。 複数のプロセスが監視対象オブジェクトでイベントを発生させた場合、 (めったに起こらないことだが)
374 イベント \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP の間に任意の数の他のイベントがはさまる可能性がある。
375
376 したがって、 \fBrename\fP(2) により生成された \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP
377 のイベントの組の対応を取るのは本質的に難しいことである (監視対象のディレクトリの外へオブジェクトの rename が行われた場合には
378 \fBIN_MOVED_TO\fP イベントは存在しさえしないことを忘れてはならない)。 (イベントは常に連続しているとの仮定を置くといった)
379 発見的な方法を使うと、ほとんどの場合でイベントの組をうまく見つけることができるが、 いくつかの場合に見逃すことが避けられず、 アプリケーションが
380 \fBIN_MOVED_FROM\fP と \fBIN_MOVED_TO\fP イベントが無関係だとみなしてしまう可能性がある。
381 結果的に、監視対象ディスクリプタが破棄され再作成された場合、これらの監視対象ディスクリプタは、処理待ちイベントの監視対象ディスクリプタと一貫性のないものになってしまう
382 (inotify ファイルディスクリプタの再作成とキャッシュの再構成はこの状況に対処するのに有用な方法なのだが)。
383
384 また、アプリケーションは、 \fBIN_MOVED_FROM\fP イベントが今行った \fBread\fP(2)
385 の呼び出しで返されたバッファのちょうど一番最後のイベントで、 \fBIN_MOVED_TO\fP イベントは次の \fBread\fP(2)
386 を行わないと取得できない可能性も考慮に入れる必要がある。
387 .SH バグ
388 .\" FIXME kernel commit 611da04f7a31b2208e838be55a42c7a1310ae321
389 .\" implies that unmount events were buggy 2.6.11 to 2.6.36
390 .\"
391 2.6.16 以前のカーネルでは \fBIN_ONESHOT\fP \fImask\fP フラグが働かない。
392
393 元々は設計/実装時の意図通り、 イベントが一つ発生し watch が削除された際に \fBIN_ONESHOT\fP フラグでは \fBIN_IGNORED\fP
394 イベントが発生しなかった。 しかし、 別の変更での意図していなかった影響により、 Linux 2.6.36 以降では、 この場合に
395 \fBIN_IGNORED\fP イベントが生成される。
396
397 .\" commit 1c17d18e3775485bf1e0ce79575eb637a94494a2
398 カーネル 2.6.25 より前では、 連続する同一のイベントを一つにまとめることを意図したコード (古い方のイベントがまだ読み込まれていない場合に、
399 最新の 2 つのイベントを一つにまとめられる可能性がある) が、 最新のイベントが「最も古い」読み込まれていないイベントとまとめられるか
400 をチェックするようになっていた。
401 .SH 関連項目
402 \fBinotifywait\fP(1), \fBinotifywatch\fP(1), \fBinotify_add_watch\fP(2),
403 \fBinotify_init\fP(2), \fBinotify_init1\fP(2), \fBinotify_rm_watch\fP(2), \fBread\fP(2),
404 \fBstat\fP(2)
405
406 Linux カーネルソース内の \fIDocumentation/filesystems/inotify.txt\fP
407 .SH この文書について
408 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.65 の一部
409 である。プロジェクトの説明とバグ報告に関する情報は
410 http://www.kernel.org/doc/man\-pages/ に書かれている。