epoll(7) について

並行プログラミング入門を読んでいて
epoll(7) に関して自分の理解できている範囲でまとめてみました。

epoll(7) とは

https://manpages.ubuntu.com/manpages/focal/ja/man7/epoll.7.html　には以下のように書かれています。

epoll API は poll(2) と同様の処理を行う、つまり、複数のファイルディスクリプタを監視し、その中のいずれかが入出力可能な状態であるかを確認する。 epoll API は、エッジトリガーインターフェースとレベルトリガーインターフェースのいずれとしても使用することができ、監視するファイルディスクリプターの数が多い場合にも使用できる。

説明そのままなのだが、ファイルディスクリプタを監視して I/O が可能かどうかを監視するLinuxのシステムコールである。
ちなみに epoll(7) はLinux専用のシステムコールで mac では kqueueが使われる。

そもそも epoll(7) は、複数のAPIからなっているようです。

epoll_create(2)

epoll(7)インスタンスを作成します。

epoll_create1(2)

epoll_crate(2)と同じくepoll(7)インスタンスを作成します。
https://manpages.ubuntu.com/manpages/focal/ja/man7/epoll.7.html には以下のように書かれています。

epoll_create(2) は epoll インスタンスを作成し、そのインスタンスを参照するファイルディスクリプターを返す。(もっと新しい epoll_create1(2) では、 epoll_create(2) の機能が拡張されている)。

epoll_create1(2)ではEPOLL_CLOEXECフラグを引数に設定します。
このフラグを設定することで設定されたファイルディスクリプタはexec時にcloseされるようになります。
参考：https://atmarkit.itmedia.co.jp/flinux/rensai/watch2008/watch08a.html

epoll_ctl(2)

epoll(7)インスタンスの監視対象となっているファイルディスクリプタに対して操作をする。
操作の種類としては以下がある。

EPOLL_CTL_ADD
- 監視対象にファイルディスクリプタを追加する
EPOLL_CTL_MOD
- ファイルディスクリプタの設定を変更
EPOLL_CTL_DEL
- 監視対象からファイルディスクリプタを削除する

epoll_wait(2)

epoll(7)インスタンスのイベントを待ちます。

使用例

これはhttps://manpages.ubuntu.com/manpages/focal/ja/man7/epoll.7.html のコードをそのまま記載します。

#define MAX_EVENTS 10
struct epoll_event ev, events[MAX_EVENTS];
int listen_sock, conn_sock, nfds, epollfd;

/* Code to set up listening socket, 'listen_sock',
  (socket(), bind(), listen()) omitted */

epollfd = epoll_create1(0);
if (epollfd == -1) {
   perror("epoll_create1");
   exit(EXIT_FAILURE);
}

ev.events = EPOLLIN;
ev.data.fd = listen_sock;
if (epoll_ctl(epollfd, EPOLL_CTL_ADD, listen_sock, &ev) == -1) {
   perror("epoll_ctl: listen_sock");
   exit(EXIT_FAILURE);
}

for (;;) {
   nfds = epoll_wait(epollfd, events, MAX_EVENTS, -1);
   if (nfds == -1) {
       perror("epoll_pwait");
       exit(EXIT_FAILURE);
   }

   for (n = 0; n < nfds; ++n) {
       if (events[n].data.fd == listen_sock) {
           conn_sock = accept(listen_sock,
                           (struct sockaddr *) &local, &addrlen);
           if (conn_sock == -1) {
               perror("accept");
               exit(EXIT_FAILURE);
           }
           setnonblocking(conn_sock);
           ev.events = EPOLLIN | EPOLLET;
           ev.data.fd = conn_sock;
           if (epoll_ctl(epollfd, EPOLL_CTL_ADD, conn_sock,
                       &ev) == -1) {
               perror("epoll_ctl: conn_sock");
               exit(EXIT_FAILURE);
           }
       } else {
           do_use_fd(events[n].data.fd);
       }
   }
}

epoll_create1(2)でepollインスタンスを作る
epoll_ctl(2)でepollインスタンスのファイルディスクリプタと監視対象のファイルディスクリプタを紐付ける
epoll_wait(2)でイベントの発生を待つ

という流れになっています。

 if (events[n].data.fd == listen_sock) {
     conn_sock = accept(listen_sock,
                     (struct sockaddr *) &local, &addrlen);
     if (conn_sock == -1) {
         perror("accept");
         exit(EXIT_FAILURE);
     }
     setnonblocking(conn_sock);
     ev.events = EPOLLIN | EPOLLET;
     ev.data.fd = conn_sock;
     if (epoll_ctl(epollfd, EPOLL_CTL_ADD, conn_sock,
                 &ev) == -1) {
         perror("epoll_ctl: conn_sock");
         exit(EXIT_FAILURE);
     }
 } else {
     do_use_fd(events[n].data.fd);
 }

最初見た時にこの条件分岐をなぜ行っているのかよくわかりませんでした。
しかし、サーバー入門、非同期処理入門、epoll 入門 | blog.ojisan.io を見てみるとその理由がわかりました。この条件分岐でリッスンソケットにイベントが発生した時、
acceptしてそのソケットをepoll_ctl(2)で監視対象に追加しています。
こうすることで、このソケットにイベントが発生した場合にイベントを捕捉できるようになります。
リッスンソケットに対するイベント発生時の処理と他のソケットに対するイベント発生時の処理が
異なるので、この条件分岐を行っているのだと理解しました。

参考文献：