Manpages

名 前

fanotify_init − fanotify グ ル ー プ を 作 成 し 、 初 期 化 す る

書 式

#include <fcntl.h>
#include <sys/fanotify.h>

int fanotify_init(unsigned int flags, unsigned int event_f_flags);

説 明

fanotify API の 概 要 に つ い て は fanotify(7) を 参 照 。

fanotify_init() は 新 し い fanotify グ ル ー プ を 初 期 化 し 、 こ の グ ル ー プ に 関 連 付 け ら れ た イ ベ ン ト キ ュ ー に 対 す る フ ァ イ ル デ ィ ス ク リ プ タ ー を 返 す 。 こ の フ ァ イ ル デ ィ ス ク リ プ タ ー は 、 fanotify_mark(2) の 呼 び 出 し で fanotify イ ベ ン ト が 作 成 さ れ る フ ァ イ ル 、 デ ィ レ ク ト リ 、 マ ウ ン ト を 指 定 す る の に 使 用 で き る 。 fanotify_mark(2) で 指 定 し た フ ァ イ ル 、 こ れ ら の イ ベ ン ト は 、 こ の フ ァ イ ル デ ィ ス ク リ プ タ ー か ら の 読 み 出 し で 受 信 す る 。 い く つ か の イ ベ ン ト は 、 フ ァ イ ル が ア ク セ ス さ れ た こ と を 示 す 単 な る 情 報 で あ る 。 他 の い く つ か の イ ベ ン ト は 、 別 の ア プ リ ケ ー シ ョ ン が フ ァ イ ル や デ ィ レ ク ト リ に ア ク セ ス す る 許 可 を 与 え る か を 判 定 す る の に 使 用 さ れ る 。 フ ァ イ ル シ ス テ ム オ ブ ジ ェ ク ト へ の ア ク セ ス 許 可 イ ベ ン ト に つ い て は 、 承 認 結 果 を こ の フ ァ イ ル デ ィ ス ク リ プ タ ー に 書 き 込 む 。 複 数 の プ ロ グ ラ ム が 同 時 に fanotify イ ン タ ー フ ェ ー ス を 使 っ て 同 じ フ ァ イ ル を 同 時 に 監 視 す る こ と が で き る 。 現 在 の 実 装 で は 、 ユ ー ザ ー あ た り の fanotify グ ル ー プ 数 は 128 に 制 限 さ れ て い る 。 こ の 制 限 は 上 書 き す る こ と が で き な い 。

fanotify_init() を 呼 び 出 す に は CAP_SYS_ADMIN ケ ー パ ビ リ テ ィ ー が 必 要 で あ る 。 こ の 制 約 は 将 来 の バ ー ジ ョ ン の API で 緩 和 さ れ る 可 能 性 が あ る 。 そ の た め 、 以 下 に 示 す ケ ー パ ビ リ テ ィ ー チ ェ ッ ク の い く つ か が 実 装 さ れ て い る 。

flags 引 き 数 は 、 イ ベ ン ト を 待 つ ア プ リ ケ ー シ ョ ン の 通 知 ク ラ ス を 定 義 す る 複 数 ビ ッ ト の フ ィ ー ル ド で あ る 。 こ れ に 加 え て 、 こ の フ ァ イ ル デ ィ ス ク リ プ タ ー の 動 作 を 示 す 1 ビ ッ ト の フ ィ ー ル ド が あ る 。 ア ク セ ス 許 可 イ ベ ン ト を 監 視 し て い る プ ロ グ ラ ム が 複 数 い る 場 合 、 通 知 ク ラ ス を 使 っ て 監 視 す る プ ロ グ ラ ム の イ ベ ン ト 受 信 順 序 が 管 理 さ れ る 。 以 下 の 通 知 ク ラ ス の い ず れ か 一 つ だ け を flags に 指 定 で き る 。
FAN_CLASS_PRE_CONTENT こ の 値 は 、 フ ァ イ ル が ア ク セ ス さ れ た こ と を 通 知 す る イ ベ ン ト と 、 フ ァ イ ル へ の ア ク セ ス す る か の 許 可 の 判 断 を 求 め る イ ベ ン ト を 受 信 す る こ と を 示 す 。 こ れ は イ ベ ン ト 受 信 者 が フ ァ イ ル が 最 終 的 な デ ー タ を 格 納 す る 前 に そ の フ ァ イ ル に ア ク セ ス す る 必 要 が あ る 場 合 に 使 用 さ れ る 。 こ の 通 知 ク ラ ス は 例 え ば 階 層 型 ス ト レ ー ジ 管 理 な ど で 使 用 さ れ る 。
FAN_CLASS_CONTENT こ の 値 は 、 フ ァ イ ル が ア ク セ ス さ れ た こ と を 通 知 す る イ ベ ン ト と 、 フ ァ イ ル へ の ア ク セ ス す る か の 許 可 の 判 断 を 求 め る イ ベ ン ト を 受 信 す る こ と を 示 す 。 こ れ は イ ベ ン ト 受 信 者 が フ ァ イ ル に 最 終 的 な デ ー タ が 格 納 さ れ た 際 に そ の フ ァ イ ル に ア ク セ ス す る 必 要 が あ る 場 合 に 使 用 さ れ る 。 こ の 通 知 ク ラ ス は 例 え ば ウ イ ル ス 検 知 プ ロ グ ラ ム な ど で 使 用 さ れ る 。
FAN_CLASS_NOTIF こ れ は デ フ ォ ル ト 値 で あ る 。 こ の 値 を 指 定 す る 必 要 は な い 。 こ の 値 は 、 フ ァ イ ル が ア ク セ ス さ れ た こ と を 通 知 す る イ ベ ン ト の 受 信 だ け を 行 う こ と を 意 味 す る 。 フ ァ イ ル が ア ク セ ス す る 前 に ア ク セ ス 許 可 の 判 定 を 行 う こ と は で き な い 。 異 な る 通 知 ク ラ ス の 受 信 者 は FAN_CLASS_PRE_CONTENT, FAN_CLASS_CONTENT, FAN_CLASS_NOTIF の 順 序 で イ ベ ン ト を 受 信 す る 。 同 じ 通 知 ク ラ ス の 受 信 者 で の 通 知 順 序 は 不 定 で あ る 。

flags に は 以 下 の ビ ッ ト を 追 加 で セ ッ ト す る こ と が で き る 。
FAN_CLOEXEC

close−on−exec フ ラ グ (FD_CLOEXEC) を 新 し い フ ァ イ ル デ ィ ス ク リ プ タ ー に セ ッ ト す る 。 open(2) の O_CLOEXEC フ ラ グ の 説 明 を 参 照 。

FAN_NONBLOCK ノ ン ブ ロ ッ キ ン グ フ ラ グ (O_NONBLOCK) を そ の フ ァ イ ル デ ィ ス ク リ プ タ ー で 有 効 に す る 。 こ の フ ァ イ ル デ ィ ス ク リ プ タ ー か ら の 読 み 出 し は 停 止 し な い 。 そ の 代 わ り 、 読 み だ し 可 能 な デ ー タ が 何 も な い 場 合 、 read(2) は エ ラ ー EAGAIN で 失 敗 す る 。
FAN_UNLIMITED_QUEUE そ の イ ベ ン ト キ ュ ー の 16384 イ ベ ン ト の 上 限 を 削 除 す る 。 こ の フ ラ グ を 使 用 す る に は CAP_SYS_ADMIN ケ ー パ ビ リ テ ィ ー が 必 要 で あ る 。
FAN_UNLIMITED_MARKS

8192 マ ー ク の 上 限 を 削 除 す る 。 こ の フ ラ グ を 使 用 す る に は CAP_SYS_ADMIN ケ ー パ ビ リ テ ィ ー が 必 要 で あ る 。

event_f_flags 引 き 数 は fanotify イ ベ ン ト が 作 成 さ れ る オ ー プ ン フ ァ イ ル 記 述 に セ ッ ト さ れ る フ ァ イ ル 状 態 フ ラ グ を 定 義 す る 。 こ れ ら の フ ラ グ の 詳 細 に つ い て は open(2) の flags 値 の 説 明 を 参 照 の こ と 。 event_f_flags に は ア ク セ ス モ ー ド の ビ ッ ト を 複 数 入 れ る こ と が で き る 。 こ の フ ィ ー ル ド に は 以 下 の 値 も 指 定 す る こ と が で き る 。
O_RDONLY 読 み 出 し ア ク セ ス の み を 許 可 す る 。
O_WRONLY 書 き 込 み ア ク セ ス の み を 許 可 す る 。

event_f_flags も セ ッ ト す る こ と が で き る 。 役 立 つ で あ ろ う 値 は 以 下 で あ る 。
O_LARGEFILE

2 GB を 超 え る フ ァ イ ル の サ ポ ー ト を 有 効 に す る 。 こ の フ ラ グ の セ ッ ト に 失 敗 す る と 、 32 ビ ッ ト シ ス テ ム で fanotify グ ル ー プ が 監 視 す る ラ ー ジ フ ァ イ ル を オ ー プ ン し よ う と し た 際 に EOVERFLOW エ ラ ー と な る 。

O_CLOEXEC こ の フ ァ イ ル デ ィ ス ク リ プ タ ー で close−on−exec フ ラ グ を 有 効 に す る 。 こ の フ ラ グ が 役 立 つ 理 由 に つ い て は open(2) の O_CLOEXEC フ ラ グ の 説 明 を 参 照 。

O_APPEND, O_DSYNC, O_NOATIME, O_NONBLOCK, O_SYNC も 指 定 す る こ と が で き る 。 event_f_flags に こ れ 以 外 の フ ラ グ を 指 定 す る と 、 エ ラ ー EINVAL が 起 こ る (た だ し 、 バ グ を 参 照 )。

返 り 値

成 功 す る と fanotify_init() は 新 し い フ ァ イ ル デ ィ ス ク リ プ タ ー を 返 す 。 エ ラ ー の 場 合 、 −1 を 返 し 、 errno に エ ラ ー を 示 す 値 を 設 定 す る 。

エ ラ ー