SELECT_TUT(2)

名前
select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO - 同期 I/O の多重化

書式
/* POSIX.1-2001 に従う場合 */
#include <sys/select.h>

/* 以前の規格に従う場合 */
#include <sys/time.h>
#include <sys/types.h>
#include <unistd.h>

int select(int nfds, fd_set *readfds, fd_set *writefds,
           fd_set *exceptfds, struct timeval *utimeout);

void FD_CLR(int fd, fd_set *set);
int  FD_ISSET(int fd, fd_set *set);
void FD_SET(int fd, fd_set *set);
void FD_ZERO(fd_set *set);

#include <sys/select.h>

int pselect(int nfds, fd_set *readfds, fd_set *writefds,
            fd_set *exceptfds, const struct timespec *ntimeout,
            const sigset_t *sigmask);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

pselect(): _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600

説明
select() (や pselect()) を使うと、効率的に複数のファイルディスクリプターを監視し、 そのファイルディスクリプターのいずれかが 「ready (準備ができた)」状態、つまり I/O (入出力) が可能になっているかや、 ファイルディスクリプターのいずれかが 「例外状態 (exceptional condition)」が発生したか、を調べることができる。 この関数の主要な引き数は、3種類のファイルディスクリプターの「集合」 readfds, writefds, exceptfds である。 各々の集合は fd_set として宣言され、その内容は FD_CLR(), FD_ISSET(), FD_SET(), FD_ZERO() といったマクロによって操作できる。 新しく宣言された集合は、まず最初に FD_ZERO() を使ってクリアすべきである。 select() はこれらの集合の内容を、以降に述べる規則に従って修正する。 select() を呼んだ後、ファイルディスクリプターがまだ集合に存在しているかどうかは、 FD_ISSET() マクロによって調べることができる。 FD_ISSET() は指定されたディスクリプターが集合に存在していれば 0 以外の値を返し、 存在しなければ 0 を返す。 FD_CLR() は集合からのファイルディスクリプターの削除を行う。

  引き数

readfds
    この集合に含まれるいずれかのファイルディスクリプターで、 データの読み込みが可能になったかどうかを監視する。 select() から戻る時に、readfds のうち、 直ちに読み込み可能なファイルディスクリプター以外は 集合から削除される。

writefds
    この集合に含まれるいずれかのファイルディスクリプターで、 データを書き込むスペースがあるかどうかを監視する。 select() から戻る時に、writefds のうち、 直ちに書き込み可能なファイルディスクリプター以外は 集合から削除される。

exceptfds
    この集合に含まれるいずれかのファイルディスクリプターで、 「例外状態 (exceptional condition)」が発生したかどうかを監視する。 実際の動作では、普通に起こり得る例外状態は一つだけであり、 それは TCP ソケットで 帯域外 (out-of-band; OOB) データが 読み込み可能な場合である。 OOB データの詳細については、 recv(2), send(2), tcp(7) を参照のこと。 (これ以外では、まれなことだが、 パケットモードの擬似端末 (pseudoterminals) で select() が例外状態を示すことがある。) select() が返る時に、exceptfds のうち、 例外状態が発生したディスクリプター以外は集合から削除される。

nfds
    全ての集合に含まれるファイルディスクリプターのうち、 値が最大のものに 1 を足した整数である。 すなわち、ファイルディスクリプターを各集合に加える作業の途中で、 全てのファイルディスクリプターを見て最大値を求め、 それに 1 を加えて nfds として渡さないといけない、ということだ。

utimeout
    (何も起こらなかった場合に) select() が戻る前に待つ最大時間である。 この値に NULL を渡すと、 select() はファイルディスクリプターのいずれかが ready (準備ができた) 状態に なるまで待ち続けてずっと停止する。 utimeout は 0 秒にすることもでき、 この場合 select() は直ちに返り、呼び出し時点のファイルディスクリプターの状態に 関する情報が返される。 構造体 struct timeval は次のように定義されている:

    struct timeval {
        time_t tv_sec;    /* seconds */
        long tv_usec;     /* microseconds */
    };

ntimeout
    pselect() のこの引き数は utimeout と同じ意味を持つが、 struct timespec は次に示すようにナノ秒の精度を持つ。

    struct timespec {
        long tv_sec;    /* seconds */
        long tv_nsec;   /* nanoseconds */
    };

sigmask
    この引き数は、呼び出し側が pselect() 内部で停止している間に、カーネルが通知を許可すべきシグナル集合 (すなわち、呼び出したスレッドのシグナルマスクから削除すべきシグナル集合) を保持する (sigaddset(3) と sigprocmask(2) を参照)。 この引き数は NULL にすることもでき、その場合はこの関数へ 入るとき・出るときにシグナルマスクを変更しない。 この場合、 pselect() は select() と全く同じ動作となる。

  シグナルとデータイベントを組み合わせる
ファイルディスクリプターが I/O 可能な状態になるのと同時に シグナルも待ちたい場合には、 pselect() が便利である。 シグナルを受信するプログラムは、通常は、 シグナルハンドラーをグローバルなフラグを立てるためだけに使う。 このグローバルなフラグは、 そのイベントをプログラムのメインループで 処理しなければならないことを示す。 シグナルを受けると select() (や pselect()) は errno に EINTR をセットして戻ることになる。 シグナルがプログラムのメインループで処理されるためにはこの動作が不可欠で、 これがないと select() は永遠に停止し続けることになる。 さて、メインループのどこかにこのグローバルフラグをチェックする 条件文があるとしよう。ここで少し考えてみないといけない。 「シグナルが条件文の後、しかし select() コールの前に到着したら どうなるのか？」 答えは「その select() は、たとえ解決待ちのイベントがあったとしても、 永遠に停止する」である。 この競合状態は pselect() コールによって解決できる。 このコールを使うと、 pselect() でのみ受信したいシグナルの集合をシグナルマスクに設定することができる。 例えば、問題となっているイベントが子プロセスの終了の場合を考えよう。 メインループが始まる前に、 SIGCHLD を sigprocmask(2) でブロックする。 pselect() コールでは SIGCHLD を、もともとのシグナルマスクを使って有効にするのだ。 このプログラムは次のようになる。

static volatile sig_atomic_t got_SIGCHLD = 0;
static void
child_sig_handler(int sig)
{
    got_SIGCHLD = 1;
}
int
main(int argc, char *argv[])
{
    sigset_t sigmask, empty_mask;
    struct sigaction sa;
    fd_set readfds, writefds, exceptfds;
    int r;
    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGCHLD);
    if (sigprocmask(SIG_BLOCK, &sigmask, NULL) == -1) {
        perror("sigprocmask");
        exit(EXIT_FAILURE);
    }
    sa.sa_flags = 0;
    sa.sa_handler = child_sig_handler;
    sigemptyset(&sa.sa_mask);
    if (sigaction(SIGCHLD, &sa, NULL) == -1) {
        perror("sigaction");
        exit(EXIT_FAILURE);
    }
    sigemptyset(&empty_mask);
    for (;;) {          /* main loop */
        /* Initialize readfds, writefds, and exceptfds
           before the pselect() call. (Code omitted.) */
        r = pselect(nfds, &readfds, &writefds, &exceptfds,
                    NULL, &empty_mask);
        if (r == -1 && errno != EINTR) {
            /* Handle error */
        }
        if (got_SIGCHLD) {
            got_SIGCHLD = 0;
            /* Handle signalled event here; e.g., wait() for all
               terminated children. (Code omitted.) */
        }
        /* main body of program */
    }
}

  実例
実際のところ select() の大事な点は何なのか？ ディスクリプターは好きなときに読み書きできるんじゃないの？ select() の重要なところは、複数のディスクリプターを同時に監視でき、 なんの動きもなければプロセスを適切にスリープ状態に移行するところにあるのだ。 UNIX プログラマは、 複数のファイルディスクリプターの入出力を同時に扱わねばならず、 しかもデータの流れは間欠的である、という状況によく出会う。 単に read(2) や write(2) コールのシーケンスを作るだけでは、それらのコールのどれかが ファイルディスクリプターからのデータを待ってブロックしており、 別のファイルディスクリプターには I/O が可能なのに使えない、 ということになってしまうだろう。 select() を使うとこの状況に効果的に対処できる。

  SELECT の掟
select() を使おうとした多くの人は、理解しにくい挙動に出くわし、結果的に できたものは移植性がないか、よくてもギリギリのものになってしまう。 例えば、上記のプログラムは、 集合に含まれるファイルディスクリプターを非停止 (nonblocking) モード にしなくても、どこにもブロックが生じないよう注意して書かれている。 微妙な間違いによって、 select() を使う利点は簡単に失われてしまう。 そこで、 select() コールを使うときに注意すべき重要事項を列挙しておくことにする。

1.  select() を使うときは、タイムアウトは設定すべきでない。 処理するデータが無いときには、 あなたのプログラムには何もすることは無いはずである。 タイムアウトに依存したコードは通常移植性がなく、 デバッグも難しくなる。

2.  上述したように、 効率的なプログラムを書くには nfds の値を適切に計算して与えなければならない。

3.  select() コールの終了後に結果をチェックして、 適切に対応するつもりのないファイルディスクリプターは、 どの集合にも加えてはならない。 次のルールも参照。

4.  select() から返った後には、全ての集合の全てのファイルディスクリプターについて 読み書き可能な状態になっているかをチェックすべきである。

5.  read(2), recv(2), write(2), send(2) といった関数は、こちらが要求した全データを読み書きする必要はない。 もし全データを読み書きするなら、それはトラフィックの負荷が小さく、 ストリームが速い場合だろう。この条件は常に満たされるとは限らない。 これらの関数が頑張っても 1 バイトしか送受信できないような場合も 考慮に入れてやらなければならない。

6.  処理するデータ量が小さいことがはっきりとわかっている場合を除いて、 一度に 1 バイトずつ読み書きするようなことはしてはならない。 バッファーの許すかぎりのデータをまとめて読み書きしないと、 非常に効率が悪い。下記の例ではバッファーは 1024 バイトにしているが、 このサイズを大きくするのは簡単だろう。

7.  read(2), recv(2), write(2), send(2) などの関数や select() コールは、 errno を EINTR や EAGAIN (EWOULDBLOCK) にして -1 を返すことがある。 このような結果に対して適切に対応してやらなければならない (上記の例ではしていない)。 書いているプログラムがシグナルを受ける予定がなければ、 EINTR が返されることはあまり考えられない。 書いているプログラムで非ブロック I/O をセットしていない場合は、 EAGAIN が返されることはないだろう。

8.  決して、引き数に長さ 0 のバッファーを指定して read(2), recv(2), write(2), send(2) を呼び出してはならない。

9.  read(2), recv(2), write(2), send(2) が 7. に示した以外のエラーで失敗した場合や、 入力系の関数の一つがファイル末尾を表す 0 を返した場合は、 そのディスクリプターをもう一度 select に渡してはならない。 下記の例では、そのディスクリプターをただちにクローズし、 そこには -1 をセットして、 それが集合に含まれ続けるのを許さないようにしている。

10. タイムアウトの値は select() を呼ぶたびに初期化すべきである。 OS によっては timeout 構造体が変更される場合があるからである。 但し、 pselect() は自分の timeout 構造体を変更することはない。

11. select() はファイルディスクリプター集合を変更するので、 select() がループの中で使用されている場合には、呼び出しを行う前に毎回 ディスクリプター集合を初期化し直さなければならない。

  usleep エミュレーション
usleep(3) 関数を持たないシステムでは、 有限のタイムアウトを指定し、ファイルディスクリプターを全くセットせずに select() を呼び出すことで、これを代用できる。 以下のようにする。

    struct timeval tv;
    tv.tv_sec = 0;
    tv.tv_usec = 200000;  /* 0.2 seconds */
    select(0, NULL, NULL, NULL, &tv);

但し、これが動くと保証されているのは UNIX システムに限られる。

返り値
成功すると、 select() はファイルディスクリプター集合に残っている ファイルディスクリプターの総数を返す。 select() がタイムアウトすると、返り値は 0 になる。 その時、ファイルディスクリプター集合はすべて空である (しかしそうならないシステムもある)。 返り値が -1 の場合はエラーを意味し、 errno が適切にセットされる。エラーが起こった場合、 返された集合の内容や構造体 struct timeout の内容は 未定義となっており、使用すべきではない。 しかし pselect() は決して ntimeout を変更しない。

注意
一般的に言って、ソケットをサポートする全てのオペレーティングシステムは select() もサポートしている。 select() を使うと、プログラマがスレッド、フォーク、IPC、シグナル、メモリー共有、 等々を使ってもっと複雑な方法で解決しようとする多くの問題が、 移植性がありかつ効率的な方法で解決できる。

poll(2) システムコールは select() と同じ機能を持っており、 まばらなファイルディスクリプター集合を監視する場合に いくらか効率がよい。 現在では広く利用可能であるが、以前は select() より移植性の面で劣っていた。

Linux 独自の epoll(7) API は、多数のファイルディスクリプターを監視する場合に select(2) や poll(2) よりも効率的なインターフェースを提供している。

例
select() の本当に便利な点を示す、よい例を紹介する。 以下のリストは、ある TCP ポートから別のポートへ転送を行う TCP フォワードプログラムである。

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <sys/time.h>
#include <sys/types.h>
#include <string.h>
#include <signal.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <errno.h>
static int forward_port;
#undef max
#define max(x,y) ((x) > (y) ? (x) : (y))
static int
listen_socket(int listen_port)
{
    struct sockaddr_in a;
    int s;
    int yes;
    if ((s = socket(AF_INET, SOCK_STREAM, 0)) == -1) {
        perror("socket");
        return -1;
    }
    yes = 1;
    if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
            &yes, sizeof(yes)) == -1) {
        perror("setsockopt");
        close(s);
        return -1;
    }
    memset(&a, 0, sizeof(a));
    a.sin_port = htons(listen_port);
    a.sin_family = AF_INET;
    if (bind(s, (struct sockaddr *) &a, sizeof(a)) == -1) {
        perror("bind");
        close(s);
        return -1;
    }
    printf("accepting connections on port %d\n", listen_port);
    listen(s, 10);
    return s;
}
static int
connect_socket(int connect_port, char *address)
{
    struct sockaddr_in a;
    int s;
    s = socket(AF_INET, SOCK_STREAM, 0);
    if (s == -1) {
        perror("socket");
        close(s);
        return -1;
    }
    memset(&a, 0, sizeof(a));
    a.sin_port = htons(connect_port);
    a.sin_family = AF_INET;
    if (!inet_aton(address, (struct in_addr *) &a.sin_addr.s_addr)) {
        perror("bad IP address format");
        close(s);
        return -1;
    }
    if (connect(s, (struct sockaddr *) &a, sizeof(a)) == -1) {
        perror("connect()");
        shutdown(s, SHUT_RDWR);
        close(s);
        return -1;
    }
    return s;
}
#define SHUT_FD1 do {                                \
                     if (fd1 >= 0) {                 \
                         shutdown(fd1, SHUT_RDWR);   \
                         close(fd1);                 \
                         fd1 = -1;                   \
                     }                               \
                 } while (0)
#define SHUT_FD2 do {                                \
                     if (fd2 >= 0) {                 \
                         shutdown(fd2, SHUT_RDWR);   \
                         close(fd2);                 \
                         fd2 = -1;                   \
                     }                               \
                 } while (0)
#define BUF_SIZE 1024
int
main(int argc, char *argv[])
{
    int h;
    int fd1 = -1, fd2 = -1;
    char buf1[BUF_SIZE], buf2[BUF_SIZE];
    int buf1_avail, buf1_written;
    int buf2_avail, buf2_written;
    if (argc != 4) {
        fprintf(stderr, "Usage\n\tfwd <listen-port> "
                 "<forward-to-port> <forward-to-ip-address>\n");
        exit(EXIT_FAILURE);
    }
    signal(SIGPIPE, SIG_IGN);
    forward_port = atoi(argv[2]);
    h = listen_socket(atoi(argv[1]));
    if (h == -1)
        exit(EXIT_FAILURE);
    for (;;) {
        int r, nfds = 0;
        fd_set rd, wr, er;
        FD_ZERO(&rd);
        FD_ZERO(&wr);
        FD_ZERO(&er);
        FD_SET(h, &rd);
        nfds = max(nfds, h);
        if (fd1 > 0 && buf1_avail < BUF_SIZE) {
            FD_SET(fd1, &rd);
            nfds = max(nfds, fd1);
        }
        if (fd2 > 0 && buf2_avail < BUF_SIZE) {
            FD_SET(fd2, &rd);
            nfds = max(nfds, fd2);
        }
        if (fd1 > 0 && buf2_avail - buf2_written > 0) {
            FD_SET(fd1, &wr);
            nfds = max(nfds, fd1);
        }
        if (fd2 > 0 && buf1_avail - buf1_written > 0) {
            FD_SET(fd2, &wr);
            nfds = max(nfds, fd2);
        }
        if (fd1 > 0) {
            FD_SET(fd1, &er);
            nfds = max(nfds, fd1);
        }
        if (fd2 > 0) {
            FD_SET(fd2, &er);
            nfds = max(nfds, fd2);
        }
        r = select(nfds + 1, &rd, &wr, &er, NULL);
        if (r == -1 && errno == EINTR)
            continue;
        if (r == -1) {
            perror("select()");
            exit(EXIT_FAILURE);
        }
        if (FD_ISSET(h, &rd)) {
            unsigned int l;
            struct sockaddr_in client_address;
            memset(&client_address, 0, l = sizeof(client_address));
            r = accept(h, (struct sockaddr *) &client_address, &l);
            if (r == -1) {
                perror("accept()");
            } else {
                SHUT_FD1;
                SHUT_FD2;
                buf1_avail = buf1_written = 0;
                buf2_avail = buf2_written = 0;
                fd1 = r;
                fd2 = connect_socket(forward_port, argv[3]);
                if (fd2 == -1)
                    SHUT_FD1;
                else
                    printf("connect from %s\n",
                            inet_ntoa(client_address.sin_addr));
            }
        }
        /* NB: read oob data before normal reads */
        if (fd1 > 0)
            if (FD_ISSET(fd1, &er)) {
                char c;
                r = recv(fd1, &c, 1, MSG_OOB);
                if (r < 1)
                    SHUT_FD1;
                else
                    send(fd2, &c, 1, MSG_OOB);
            }
        if (fd2 > 0)
            if (FD_ISSET(fd2, &er)) {
                char c;
                r = recv(fd2, &c, 1, MSG_OOB);
                if (r < 1)
                    SHUT_FD2;
                else
                    send(fd1, &c, 1, MSG_OOB);
            }
        if (fd1 > 0)
            if (FD_ISSET(fd1, &rd)) {
                r = read(fd1, buf1 + buf1_avail,
                          BUF_SIZE - buf1_avail);
                if (r < 1)
                    SHUT_FD1;
                else
                    buf1_avail += r;
            }
        if (fd2 > 0)
            if (FD_ISSET(fd2, &rd)) {
                r = read(fd2, buf2 + buf2_avail,
                          BUF_SIZE - buf2_avail);
                if (r < 1)
                    SHUT_FD2;
                else
                    buf2_avail += r;
            }
        if (fd1 > 0)
            if (FD_ISSET(fd1, &wr)) {
                r = write(fd1, buf2 + buf2_written,
                           buf2_avail - buf2_written);
                if (r < 1)
                    SHUT_FD1;
                else
                    buf2_written += r;
            }
        if (fd2 > 0)
            if (FD_ISSET(fd2, &wr)) {
                r = write(fd2, buf1 + buf1_written,
                           buf1_avail - buf1_written);
                if (r < 1)
                    SHUT_FD2;
                else
                    buf1_written += r;
            }
        /* check if write data has caught read data */
        if (buf1_written == buf1_avail)
            buf1_written = buf1_avail = 0;
        if (buf2_written == buf2_avail)
            buf2_written = buf2_avail = 0;
        /* one side has closed the connection, keep
           writing to the other side until empty */
        if (fd1 < 0 && buf1_avail - buf1_written == 0)
            SHUT_FD2;
        if (fd2 < 0 && buf2_avail - buf2_written == 0)
            SHUT_FD1;
    }
    exit(EXIT_SUCCESS);
}

上記のプログラムは、ほとんどの種類の TCP 接続をフォワードする。 telnet サーバによって中継される OOB シグナルデータも扱える。 このプログラムは、データフローを双方向に同時に送るという、 ややこしい問題も処理できる。 fork(2) コールを使って、各ストリームごとに専用のスレッドを用いるほうが効率的だ、 という人もいるかもしれない。しかし、これは考えているよりずっとややこしい。 あるいは、 fcntl(2) を使って非ブロック I/O をセットすれば良い、というアイデアもあるだろう。 これにも実際には問題があり、タイムアウトが非効率的に起こってしまう。 このプログラムは一度にひとつ以上の同時接続を扱うことはできないが、 その様に拡張するのは簡単で、バッファーのリンクリストを (接続ごとにひとつずつ) 使えばよい。 現時点のものでは、新しい接続がくると古い接続は落ちてしまう。

関連項目
accept(2), connect(2), ioctl(2), poll(2), read(2), recv(2), select(2), send(2), sigprocmask(2), write(2), sigaddset(3), sigdelset(3), sigemptyset(3), sigfillset(3), sigismember(3), epoll(7)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.79 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。