epoll_ctlのヘルプ・マニュアル
日本語 英語
epoll_ctl --help
man epoll_ctl
EPOLL_CTL(2) Linux Programmer’s Manual EPOLL_CTL(2)
名前
epoll_ctl - epoll ディスクリプタのインタフェースを操作する
書式
#include
int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);
説明
このシステムコールは、ファイルディスクリプタ epfd が参照する epoll イン
スタンスに対する操作を行う。対象のファイルディスクリプタ 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 behav-
ior) を設定する。これはイベントが epoll_wait(2) によって引き出さ
れた後、関連付けられたファイルディスクリプタが内部的に破棄され、
epoll インタフェースによってイベントが報告されなくなることを意味
する。新しいイベントマスクでファイルディスクリプタを再度有効にす
るためには、 epoll_ctl() に EPOLL_CTL_MOD を指定して呼び出さなけ
ればならない。 op 引き数に指定できる有効な値は、以下の通り:
返り値
成 功 し た 場 合 、 epoll_ctl() は 0 を返す。エラーが起こった場合、
epoll_ctl() は -1 を返し、 errno を適切に設定する。
エラー
EBADF epfd か fd が有効なファイルディスクリプタでない。
EEXIST op が EPOLL_CTL_ADD であり、かつ与えられたファイルディスクリプタ
fd がこの epoll インスタンスに既に登録されている。
EINVAL epfd が epoll ファイルディスクリプタでない。または fd が epfd と
同一である。または要求された操作 op がこのインタフェースでサポー
トされていない。
ENOENT op が EPOLL_CTL_MOD または EPOLL_CTL_DEL で、かつ fd がこの
epoll インスタンスに登録されていない。
ENOMEM 要求された op 制御操作を扱うのに十分なメモリがない。
ENOSPC epoll インスタンスに新しいファイル デ ィ ス ク リ プ タ を 登 録
(EPOLL_CTL_ADD) し よ う と し た 際 に 、
/proc/sys/fs/epoll/max_user_watches で決まる上限に達した。詳細は
epoll(7) を参照。
EPERM 対象ファイル fd が epoll をサポートしていない。
準拠
epoll_ctl() は Linux 独自であり、カーネル 2.5.44 で導入された。
備考
epoll インタフェースは、 poll(2) に対応している全てのファイルディスクリ
プタに対応している。
バグ
Linux 2.6.9 より前では、 EPOLL_CTL_DEL 操作の際、引き数 event に (た と
え無視される場合であっても) NULL でないポインタを渡す必要があった。カー
ネル 2.6.9 以降では、 EPOLL_CTL_DEL を使う際に event に NULL を指定でき
るようになっている。 2.6.9 より前のカーネルへの移植性が必要なアプリケー
ションでは、 event に NULL でないポインタを指定すべきである。
関連項目
epoll_create(2), epoll_wait(2), poll(2), epoll(7)
Linux 2009-01-17 EPOLL_CTL(2)
EPOLL_CTL(2) Linux Programmer’s Manual EPOLL_CTL(2)
NAME
epoll_ctl - control interface for an epoll descriptor
SYNOPSIS
#include
int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);
DESCRIPTION
This system call performs control operations on the epoll instance
referred to by the file descriptor epfd. It requests that the opera-
tion op be performed for the target file descriptor, fd.
Valid values for the op argument are :
EPOLL_CTL_ADD
Register the target file descriptor fd on the epoll instance
referred to by the file descriptor epfd and associate the event
event with the internal file linked to fd.
EPOLL_CTL_MOD
Change the event event associated with the target file descrip-
tor fd.
EPOLL_CTL_DEL
Remove (deregister) the target file descriptor fd from the epoll
instance referred to by epfd. The event is ignored and can be
NULL (but see BUGS below).
The event argument describes the object linked to the file descriptor
fd. The struct epoll_event is defined as :
typedef union epoll_data {
void *ptr;
int fd;
__uint32_t u32;
__uint64_t u64;
} epoll_data_t;
struct epoll_event {
__uint32_t events; /* Epoll events */
epoll_data_t data; /* User data variable */
};
The events member is a bit set composed using the following available
event types:
EPOLLIN
The associated file is available for read(2) operations.
EPOLLOUT
The associated file is available for write(2) operations.
EPOLLRDHUP (since Linux 2.6.17)
Stream socket peer closed connection, or shut down writing half
of connection. (This flag is especially useful for writing sim-
ple code to detect peer shutdown when using Edge Triggered moni-
toring.)
EPOLLPRI
There is urgent data available for read(2) operations.
EPOLLERR
Error condition happened on the associated file descriptor.
epoll_wait(2) will always wait for this event; it is not neces-
sary to set it in events.
EPOLLHUP
Hang up happened on the associated file descriptor.
epoll_wait(2) will always wait for this event; it is not neces-
sary to set it in events.
EPOLLET
Sets the Edge Triggered behavior for the associated file
descriptor. The default behavior for epoll is Level Triggered.
See epoll(7) for more detailed information about Edge and Level
Triggered event distribution architectures.
EPOLLONESHOT (since Linux 2.6.2)
Sets the one-shot behavior for the associated file descriptor.
This means that after an event is pulled out with epoll_wait(2)
the associated file descriptor is internally disabled and no
other events will be reported by the epoll interface. The user
must call epoll_ctl() with EPOLL_CTL_MOD to re-arm the file
descriptor with a new event mask.
RETURN VALUE
When successful, epoll_ctl() returns zero. When an error occurs,
epoll_ctl() returns -1 and errno is set appropriately.
ERRORS
EBADF epfd or fd is not a valid file descriptor.
EEXIST op was EPOLL_CTL_ADD, and the supplied file descriptor fd is
already registered with this epoll instance.
EINVAL epfd is not an epoll file descriptor, or fd is the same as epfd,
or the requested operation op is not supported by this inter-
face.
ENOENT op was EPOLL_CTL_MOD or EPOLL_CTL_DEL, and fd is not registered
on with this epoll instance.
ENOMEM There was insufficient memory to handle the requested op control
operation.
The limit imposed by
/proc/sys/fs/epoll/max_user_watches was encountered while trying
to register (EPOLL_CTL_ADD) a new file descriptor on an epoll
instance. See epoll(7) for further details.
EPERM The target file fd does not support epoll.
CONFORMING TO
epoll_ctl() is Linux-specific, and was introduced in kernel 2.5.44.
NOTES
The epoll interface supports all file descriptors that support poll(2).
BUGS
In kernel versions before 2.6.9, the EPOLL_CTL_DEL operation required a
non-NULL pointer in event, even though this argument is ignored. Since
Linux 2.6.9, event can be specified as NULL when using EPOLL_CTL_DEL.
Applications that need to be portable to kernels before 2.6.9 should
specify a non-NULL pointer in event.
SEE ALSO
epoll_create(2), epoll_wait(2), poll(2), epoll(7)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2009-01-17 EPOLL_CTL(2)