inotify - 約束事その他の説明 - Linux コマンド集 一覧表

inotify - ファイルシステムイベントを監視する

inotify API はファイルシステムイベントを監視するための機構を提供する。 inotify は個々のファイルやディレクトリを監視するのに使える。 ディレクトリを監視する場合、inotify はディレクトリ自身と ディレクトリ内のファイルのイベントを返す。
以下のシステムコールがこの API と共に使用される。 inotify_init (), inotify_add_watch (), read (), inotify_rm_watch (), close ().
inotify_init (2)は inotify インスタンスを作成し、inotify オブジェクトを参照する ファイルディスクリプタを返す。
inotify_add_watch (2)は inotify に関連づけられた「監視対象 (watch) リスト」を操作する。 監視対象リストの各アイテム ("watch") は、 ファイルまたはディレクトリのパス名と、 そのパス名で参照されるファイルに対して カーネルが監視する複数のイベントの集合を指定する。 inotify_add_watch ()は新しい監視アイテムの作成や既存の監視対象の変更ができる。 各監視対象は一意の「監視対象ディスクリプタ」を持つ。 これは監視対象を作成したときに inotify_add_watch ()から返される整数である。
inotify_rm_watch (2)は inotify の監視対象リストからアイテムを削除する。
inotify オブジェクトを指している 全てのファイルディスクリプタがクローズされた場合、 その下層にあるオブジェクトとそのリソースは、 カーネルで再利用するために解放される。 関連が切られた監視対象は自動的に解放される。
どのようなイベントが起こっていたかを知るには、 アプリケーションで inotify ファイルディスクリプタを   read (2) すればよい。 これまでに何もイベントが起こっていない場合、 停止 (blocking) モードのファイルディスクリプタであれば、 少なくとも 1 つのイベントが起こるまで read ()は停止する。
read ()が成功すると、以下の構造体を 1 つ以上含むバッファが返される:

struct inotify_event {
    int      wd;       /* 監視対象ディスクリプタ */
    uint32_t mask;     /* イベントのマスク */
    uint32_t cookie;   /* 関連するイベント群を関連づける
                          一意なクッキー (rename(2) 用) */
    uint32_t len;      /* 'name' フィールドのサイズ */
    char     name[];   /* NULL で終端された任意の名前 */
};

wd はイベント発生の監視対象を指定する。 これは、前もって行われた inotify_add_watch ()呼び出しで返された監視対象ディスクリプタのうちの 1 つである。
mask には発生したイベント (下記参照) を記述するためのビットが含まれる。
cookie は関連するイベントを関連づけるための一意な整数である。 現在のところ、この値は rename イベントに対してのみ使われており、 結果のペアである IN_MOVE_FROM と IN_MOVE_TO イベントをアプリケーションで関連づけることができる。
name フィールドは監視しているディレクトリ内のファイルに対して イベントが返される場合のためにだけ存在する。 監視するディレクトリからのファイルの相対パス名を表す。 このパス名は NULL で終端され、 その後の読み込みで適切なアドレス境界に調整するために、 さらに NULL バイトが含まれる場合もある。
len フィールドは NULL バイトを含む name の全てのバイト数を表す。 よって、 inotify_event 構造体のサイズは "sizeof(inotify_event)+len" である。

inotify イベント

/proc インターフェース

inotify ファイルディスクリプタは   select (2),   poll (2),   epoll (4) を使って監視できる。
inotify ファイルディスクリプタに対して 連続して生成される出力 inotify イベントが同一の場合 ( wd , mask , cookie , name が等しい場合)、連続するイベントが 1 つのイベントにまとめられる。
inotify ファイルディスクリプタの読み込みで返されるイベントは、 順序付けられたキューになる。 従って、たとえば、あるディレクトリの名前を別の名前に変更した場合、 inotify ファイルディスクリプタについての正しい順番で イベントが生成されることが保証される。
FIONREAD ioctl ()は inotify ファイルディスクリプタから何バイト読み込めるかを返す。
inotify によるディレクトリの監視は再帰的に行われない: あるディレクトリ以下のサブディレクトリを監視する場合、 監視対象を追加で作成しなければならない。

inotify は 2.6.13 の Linux カーネルに組込まれた。 これに必要なライブラリのインターフェースは、 glibc のバージョン 2.4 に追加された。

inotify API は Linux 独自のものである。 他のシステムでも同様な機構を提供しているものがある。 たとえば、FreeBSD には kqueue があり、Solaris には /dev/poll がある。

inotify_add_watch (2), inotify_init (2), inotify_rm_watch (2),  read (2),   stat (2),  Documentation/filesystems/inotify.txt .