Manpages

名 前

epoll_ctl − epoll デ ィ ス ク リ プ タ ー の イ ン タ ー フ ェ ー ス を 操 作 す る

書 式

#include <sys/epoll.h>

int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);

説 明

こ の シ ス テ ム コ ー ル は 、 フ ァ イ ル デ ィ ス ク リ プ タ ー epfd が 参 照 す る epoll(7) イ ン ス タ ン ス に 対 す る 操 作 を 行 う 。 対 象 の フ ァ イ ル デ ィ ス ク リ プ タ ー fd に 対 し て 、 操 作 op の 実 行 が 要 求 さ れ る 。

op 引 き 数 に 指 定 で き る 有 効 な 値 は 以 下 の 通 り で あ る 。
EPOLL_CTL_ADD 対 象 の フ ァ イ ル デ ィ ス ク リ プ タ ー fd を フ ァ イ ル デ ィ ス ク リ プ タ ー epfd が 参 照 す る epoll イ ン ス タ ン ス に 登 録 し 、 イ ベ ン ト event を fd に 結 び 付 け ら れ た 内 部 フ ァ イ ル に 関 連 付 け る 。
EPOLL_CTL_MOD イ ベ ン ト event を 対 象 の フ ァ イ ル デ ィ ス ク リ プ タ ー fd に 関 連 付 け る よ う に 変 更 す る 。
EPOLL_CTL_DEL 対 象 の フ ァ イ ル デ ィ ス ク リ プ タ ー fd を epfd が 参 照 す る epoll イ ン ス タ ン ス か ら 削 除 す る 。 event 引 き 数 は 無 視 さ れ る の で 、 NULL に す る こ と も で き る (但 し 、 下 記 の 「 バ グ 」 を 参 照 )。

event 引 き 数 は 、 フ ァ イ ル デ ィ ス ク リ プ タ ー fd に リ ン ク さ れ た オ ブ ジ ェ ク ト を 表 す 。 struct epoll_event は 以 下 の よ う に 定 義 さ れ る 。

typedef union epoll_data {
void *ptr;
int fd;
uint32_t u32;
uint64_t u64; }
epoll_data_t;

struct epoll_event {
uint32_t events; /* epoll イ ベ ン ト */
epoll_data_t data; /* ユ ー ザ ー デ ー タ 変 数 */ };

events メ ン バ は 、 以 下 の よ う な 使 用 可 能 な イ ベ ン ト タ イ プ を 使 っ て 構 成 さ れ た ビ ッ ト セ ッ ト で あ る 。
EPOLLIN 関 連 付 け ら れ た フ ァ イ ル に 対 し て 、 read(2) 操 作 が 可 能 で あ る 。
EPOLLOUT 関 連 付 け ら れ た フ ァ イ ル に 対 し て 、 write(2) 操 作 が 可 能 で あ る 。
EPOLLRDHUP"(Linux2.6.17以 降 )" ス ト リ ー ム ソ ケ ッ ト の 他 端 が 、 コ ネ ク シ ョ ン の close 、 ま た は コ ネ ク シ ョ ン の 書 き 込 み 側 の shutdown を 行 っ た 。 (こ の フ ラ グ を 使 う と 、 エ ッ ジ ト リ ガ ー の 監 視 を 行 う 場 合 に 、 通 信 の も う 一 端 が 閉 じ ら れ た こ と を 検 知 す る コ ー ド を 非 常 に 簡 潔 に 書 く こ と が で き る 。 )
EPOLLPRI

read(2) 操 作 が 可 能 な 緊 急 (urgent) デ ー タ が あ る 。

EPOLLERR 関 連 付 け ら れ た フ ァ イ ル デ ィ ス ク リ プ タ ー に エ ラ ー 条 件 が 起 こ っ た 。 epoll_wait(2) は 常 に こ の イ ベ ン ト を 待 つ の で 、 events に 設 定 す る 必 要 は な い 。
EPOLLHUP 関 連 付 け ら れ た フ ァ イ ル デ ィ ス ク リ プ タ ー に ハ ン グ ア ッ プ が 起 こ っ た 。 epoll_wait(2) は 常 に こ の イ ベ ン ト を 待 つ の で 、 events に 設 定 す る 必 要 は な い 。
EPOLLET 関 連 付 け ら れ た フ ァ イ ル デ ィ ス ク リ プ タ ー に エ ッ ジ ト リ ガ ー 動 作 (Edge Triggered behavior) を 設 定 す る 。 epoll の デ フ ォ ル ト の 動 作 は 、 レ ベ ル ト リ ガ ー (Level Triggered) で あ る 。 エ ッ ジ ト リ ガ ー と レ ベ ル ト リ ガ ー に よ る イ ベ ン ト 分 配 機 構 (event distribution architectures) に つ い て の 詳 細 な 情 報 は 、 epoll(7) を 参 照 す る こ と 。
EPOLLONESHOT (Linux 2.6.2 以 降 ) 関 連 付 け ら れ た フ ァ イ ル デ ィ ス ク リ プ タ ー に 一 撃 動 作 (One−Shot behavior) を 設 定 す る 。 こ れ は イ ベ ン ト が epoll_wait(2) に よ っ て 引 き 出 さ れ た 後 、 関 連 付 け ら れ た フ ァ イ ル デ ィ ス ク リ プ タ ー が 内 部 的 に 破 棄 さ れ 、 epoll イ ン タ ー フ ェ ー ス に よ っ て イ ベ ン ト が 報 告 さ れ な く な る こ と を 意 味 す る 。 新 し い イ ベ ン ト マ ス ク で フ ァ イ ル デ ィ ス ク リ プ タ ー を 再 度 有 効 に す る た め に は 、 epoll_ctl() に EPOLL_CTL_MOD を 指 定 し て 呼 び 出 さ な け れ ば な ら な い 。 op 引 き 数 に 指 定 で き る 有 効 な 値 は 、 以 下 の 通 り :
EPOLLWAKEUP (Linux 3.5 以 降 )

EPOLLONESHOT と EPOLLET が ク リ ア さ れ て お り 、 プ ロ セ ス が CAP_BLOCK_SUSPEND ケ ー パ ビ リ テ ィ を 持 っ て い る 場 合 、 イ ベ ン ト が 処 理 待 ち か 処 理 中 か に か か わ ら ず 、 必 ず シ ス テ ム が "suspend" や "hibernate" に 入 ら な い よ う に す る こ と 。 epoll_wait(2) の 呼 び 出 し が 返 っ た 時 点 か ら 、 同 じ epoll(7) フ ァ イ ル デ ィ ス ク リ プ タ ー に 対 し て epoll_wait(2) が 次 に 呼 び 出 さ れ る か 、 そ の フ ァ イ ル デ ィ ス ク リ プ タ ー が 閉 じ ら れ る か 、 イ ベ ン ト フ ァ イ ル デ ィ ス ク リ プ タ ー が EPOLL_CTL_DEL で 削 除 さ れ る か 、 EPOLL_CTL_MOD で イ ベ ン ト フ ァ イ ル デ ィ ス ク リ プ タ ー の EPOLLWAKEUP が ク リ ア さ れ る か 、 の い ず れ か に な る ま で 、 イ ベ ン ト は 「 処 理 中 」 で あ る と み な さ れ る 。 「 バ グ 」 の 節 も 参 照 の こ と 。

返 り 値

成 功 し た 場 合 、 epoll_ctl() は 0 を 返 す 。 エ ラ ー が 起 こ っ た 場 合 、 epoll_ctl() は −1 を 返 し 、 errno を 適 切 に 設 定 す る 。

エ ラ ー