1 .\" This manpage is copyright (C) 2001 Paul Sheer.
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" very minor changes, aeb
25 .\" Modified 5 June 2002, Michael Kerrisk <mtk.manpages@gmail.com>
26 .\" 2006-05-13, mtk, removed much material that is redundant with select.2
27 .\" various other changes
28 .\" 2008-01-26, mtk, substantial changes and rewrites
30 .\" Translated 2002-02-21, NAKANO Takeo <nakano@apm.seikei.ac.jp>
31 .\" Updated 2002-09-23, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
32 .\" Updated 2005-03-15, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
33 .\" Updated 2006-07-21, Akihiro MOTOKI, LDP v2.36
34 .\" Updated 2009-02-13, Akihiro MOTOKI, LDP v3.18
36 .\"WORD: file descriptor ファイルディスクリプタ
37 .\"WORD: exceptional condition 例外状態
39 .TH SELECT_TUT 2 2010-06-10 "Linux" "Linux Programmer's Manual"
41 select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- 同期 I/O の多重化
44 /* POSIX.1-2001 に従う場合 */
46 .B #include <sys/select.h>
50 .B #include <sys/time.h>
52 .B #include <sys/types.h>
54 .B #include <unistd.h>
56 .BI "int select(int " nfds ", fd_set *" readfds ", fd_set *" writefds ,
57 .BI " fd_set *" exceptfds ", struct timeval *" utimeout );
59 .BI "void FD_CLR(int " fd ", fd_set *" set );
61 .BI "int FD_ISSET(int " fd ", fd_set *" set );
63 .BI "void FD_SET(int " fd ", fd_set *" set );
65 .BI "void FD_ZERO(fd_set *" set );
67 .B #include <sys/select.h>
69 .BI "int pselect(int " nfds ", fd_set *" readfds ", fd_set *" writefds ,
70 .BI " fd_set *" exceptfds ", const struct timespec *" ntimeout ,
71 .BI " const sigset_t *" sigmask );
76 .RB ( feature_test_macros (7)
81 _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
86 を使うと、効率的に複数のファイルディスクリプタを監視し、
88 「ready (準備ができた)」状態、つまり I/O (入出力) が可能になっているかや、
90 「例外状態 (exceptional condition)」が発生したか、を調べることができる。
92 この関数の主要な引き数は、3種類のファイルディスクリプタの「集合」
93 \fIreadfds\fP, \fIwritefds\fP, \fIexceptfds\fP である。
106 はこれらの集合の内容を、以降に述べる規則に従って修正する。
108 を呼んだ後、ファイルディスクリプタがまだ集合に存在しているかどうかは、
112 は指定されたディスクリプタが集合に存在していれば 0 以外の値を返し、
115 は集合からのファイルディスクリプタの削除を行う。
119 この集合に含まれるいずれかのファイルディスクリプタで、
120 データの読み込みが可能になったかどうかを監視する。
122 から戻る時に、\fIreadfds\fP のうち、
123 直ちに読み込み可能なファイルディスクリプタ以外は
127 この集合に含まれるいずれかのファイルディスクリプタで、
128 データを書き込むスペースがあるかどうかを監視する。
130 から戻る時に、\fIwritefds\fP のうち、
131 直ちに書き込み可能なファイルディスクリプタ以外は
135 この集合に含まれるいずれかのファイルディスクリプタで、
136 「例外状態 (exceptional condition)」が発生したかどうかを監視する。
137 実際の動作では、普通に起こり得る例外状態は一つだけであり、
138 それは TCP ソケットで \fI帯域外 (out-of-band; OOB)\fP データが
146 パケットモードの擬似端末 (pseudoterminals) で
150 が返る時に、\fIexceptfds\fP のうち、
151 例外状態が発生したディスクリプタ以外は集合から削除される。
154 全ての集合に含まれるファイルディスクリプタのうち、
155 値が最大のものに 1 を足した整数である。
156 すなわち、ファイルディスクリプタを各集合に加える作業の途中で、
157 全てのファイルディスクリプタを見て最大値を求め、
158 それに 1 を加えて \fInfds\fP として渡さないといけない、ということだ。
166 はファイルディスクリプタのいずれかが ready (準備ができた) 状態に
168 \fIutimeout\fP は 0 秒にすることもでき、
171 は直ちに返り、呼び出し時点のファイルディスクリプタの状態に
173 構造体 \fIstruct timeval\fP は次のように定義されている:
178 time_t tv_sec; /* seconds */
179 long tv_usec; /* microseconds */
194 long tv_sec; /* seconds */
195 long tv_nsec; /* nanoseconds */
203 内部で停止している間に、カーネルが通知を許可すべきシグナル集合
204 (すなわち、呼び出したスレッドのシグナルマスクから削除すべきシグナル集合)
210 この引き数は NULL にすることもでき、その場合はこの関数へ
211 入るとき・出るときにシグナルマスクを変更しない。
217 .SS シグナルとデータイベントを組み合わせる
218 ファイルディスクリプタが I/O 可能な状態になるのと同時に
223 シグナルハンドラをグローバルなフラグを立てるためだけに使う。
232 \fIerrno\fP に \fBEINTR\fP をセットして戻ることになる。
233 シグナルがプログラムのメインループで処理されるためにはこの動作が不可欠で、
237 さて、メインループのどこかにこのグローバルフラグをチェックする
238 条件文があるとしよう。ここで少し考えてみないといけない。
245 は、たとえ解決待ちのイベントがあったとしても、
252 で受信したいシグナルの集合だけをシグナルマスクに設定することができる。
253 例えば、問題となっているイベントが子プロセスの終了の場合を考えよう。
262 を、もともとのシグナルマスクを使って有効にするのだ。
266 static volatile sig_atomic_t got_SIGCHLD = 0;
269 child_sig_handler(int sig)
275 main(int argc, char *argv[])
277 sigset_t sigmask, empty_mask;
279 fd_set readfds, writefds, exceptfds;
282 sigemptyset(&sigmask);
283 sigaddset(&sigmask, SIGCHLD);
284 if (sigprocmask(SIG_BLOCK, &sigmask, NULL) == \-1) {
285 perror("sigprocmask");
290 sa.sa_handler = child_sig_handler;
291 sigemptyset(&sa.sa_mask);
292 if (sigaction(SIGCHLD, &sa, NULL) == \-1) {
297 sigemptyset(&empty_mask);
299 for (;;) { /* main loop */
300 /* Initialize readfds, writefds, and exceptfds
301 before the pselect() call. (Code omitted.) */
303 r = pselect(nfds, &readfds, &writefds, &exceptfds,
305 if (r == \-1 && errno != EINTR) {
312 /* Handle signalled event here; e.g., wait() for all
313 terminated children. (Code omitted.) */
316 /* main body of program */
324 ディスクリプタは好きなときに読み書きできるんじゃないの?
326 の重要なところは、複数のディスクリプタを同時に監視でき、
327 なんの動きもなければプロセスを適切にスリープ状態に移行するところにあるのだ。
329 複数のファイルディスクリプタの入出力を同時に扱わねばならず、
330 しかもデータの流れは間欠的である、という状況によく出会う。
335 コールのシーケンスを作るだけでは、それらのコールのどれかが
336 ファイルディスクリプタからのデータを待ってブロックしており、
337 別のファイルディスクリプタには I/O が可能なのに使えない、
343 を使おうとした多くの人は、理解しにくい挙動に出くわし、結果的に
344 できたものは移植性がないか、よくてもギリギリのものになってしまう。
346 集合に含まれるファイルディスクリプタを非停止 (nonblocking) モード
347 にしなくても、どこにもブロックが生じないよう注意して書かれている。
353 コールを使うときに注意すべき重要事項を列挙しておくことにする。
357 を使うときは、タイムアウトは設定すべきでない。
359 あなたのプログラムには何もすることは無いはずである。
360 タイムアウトに依存したコードは通常移植性がなく、
367 の値を適切に計算して与えなければならない。
372 適切に対応するつもりのないファイルディスクリプタは、
378 から返った後には、全ての集合の全てのファイルディスクリプタについて
379 読み書き可能な状態になっているかをチェックすべきである。
386 といった関数は、こちらが要求した全データを読み書きする必要は\fIない\fP。
387 もし全データを読み書きするなら、それはトラフィックの負荷が小さく、
388 ストリームが速い場合だろう。この条件は常に満たされるとは限らない。
389 これらの関数が頑張っても 1 バイトしか送受信できないような場合も
393 処理するデータ量が小さいことがはっきりとわかっている場合を除いて、
394 一度に 1 バイトずつ読み書きするようなことはしてはならない。
395 バッファの許すかぎりのデータをまとめて読み書きしないと、
396 非常に効率が悪い。下記の例ではバッファは 1024 バイトにしているが、
409 .B EINTR " や " EAGAIN
412 このような結果に対して適切に対応してやらなければならない
414 書いているプログラムがシグナルを受ける予定がなければ、
417 書いているプログラムで非ブロック I/O をセットしていない場合は、
420 .\" それでもなお、完全を期するならば、
421 .\" これらのエラーを考慮に入れる必要がある。
424 決して、引き数に長さ 0 のバッファを指定して
437 \fB7.\fP に示した以外のエラーで失敗した場合や、
438 入力系の関数の一つがファイル末尾を表す 0 を返した場合は、
439 そのディスクリプタをもう一度 select に渡しては\fIならない\fP。
440 下記の例では、そのディスクリプタをただちにクローズし、
442 それが集合に含まれ続けるのを許さないようにしている。
448 OS によっては timeout 構造体が変更される場合があるからである。
451 は自分の timeout 構造体を変更することはない。
455 はファイルディスクリプタ集合を変更するので、
457 がループの中で使用されている場合には、呼び出しを行う前に毎回
458 ディスクリプタ集合を初期化し直さなければならない。
459 .\" "I have heard" does not fill me with confidence, and doesn't
460 .\" belong in a man page, so I've commented this point out.
462 .\" 聞いたところでは、Windows のソケット層は
463 .\" OOB データを正しく処理しないらしい。
464 .\" また、ファイルディスクリプタが全くセットされていないような
467 .\" ファイルディスクリプタを一切設定しないで timeout を使うやり方は、
468 .\" 1 秒以下の精度でプロセスをスリープさせるには便利な方法なのだが
473 有限のタイムアウトを指定し、ファイルディスクリプタを全くセットせずに
481 tv.tv_usec = 200000; /* 0.2 seconds */
482 select(0, NULL, NULL, NULL, &tv);
485 但し、これが動くと保証されているのは UNIX システムに限られる。
493 がタイムアウトすると、返り値は 0 になる。
494 その時、ファイルディスクリプタ集合はすべて空である
497 返り値が \-1 の場合はエラーを意味し、
499 が適切にセットされる。エラーが起こった場合、
500 返された集合の内容や構造体 \fIstruct timeout\fP の内容は
508 一般的に言って、ソケットをサポートする全てのオペレーティングシステムは
512 を使うと、プログラマがスレッド、フォーク、IPC、シグナル、メモリ共有、
513 等々を使ってもっと複雑な方法で解決しようとする多くの問題が、
514 移植性がありかつ効率的な方法で解決できる。
520 まばらなファイルディスクリプタ集合を監視する場合に
528 API は、多数のファイルディスクリプタを監視する場合に
532 よりも効率的なインタフェースを提供している。
535 の本当に便利な点を示す、よい例を紹介する。
536 以下のリストは、ある TCP ポートから別のポートへ転送を行う
543 #include <sys/time.h>
544 #include <sys/types.h>
547 #include <sys/socket.h>
548 #include <netinet/in.h>
549 #include <arpa/inet.h>
552 static int forward_port;
555 #define max(x,y) ((x) > (y) ? (x) : (y))
558 listen_socket(int listen_port)
560 struct sockaddr_in a;
564 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
569 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
570 (char *) &yes, sizeof(yes)) == \-1) {
571 perror("setsockopt");
575 memset(&a, 0, sizeof(a));
576 a.sin_port = htons(listen_port);
577 a.sin_family = AF_INET;
578 if (bind(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
583 printf("accepting connections on port %d\\n", listen_port);
589 connect_socket(int connect_port, char *address)
591 struct sockaddr_in a;
594 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
600 memset(&a, 0, sizeof(a));
601 a.sin_port = htons(connect_port);
602 a.sin_family = AF_INET;
604 if (!inet_aton(address, (struct in_addr *) &a.sin_addr.s_addr)) {
605 perror("bad IP address format");
610 if (connect(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
612 shutdown(s, SHUT_RDWR);
619 #define SHUT_FD1 do { \\
621 shutdown(fd1, SHUT_RDWR); \\
627 #define SHUT_FD2 do { \\
629 shutdown(fd2, SHUT_RDWR); \\
635 #define BUF_SIZE 1024
638 main(int argc, char *argv[])
641 int fd1 = \-1, fd2 = \-1;
642 char buf1[BUF_SIZE], buf2[BUF_SIZE];
643 int buf1_avail, buf1_written;
644 int buf2_avail, buf2_written;
647 fprintf(stderr, "Usage\\n\\tfwd <listen-port> "
648 "<forward-to-port> <forward-to-ip-address>\\n");
652 signal(SIGPIPE, SIG_IGN);
654 forward_port = atoi(argv[2]);
656 h = listen_socket(atoi(argv[1]));
669 if (fd1 > 0 && buf1_avail < BUF_SIZE) {
671 nfds = max(nfds, fd1);
673 if (fd2 > 0 && buf2_avail < BUF_SIZE) {
675 nfds = max(nfds, fd2);
677 if (fd1 > 0 && buf2_avail \- buf2_written > 0) {
679 nfds = max(nfds, fd1);
681 if (fd2 > 0 && buf1_avail \- buf1_written > 0) {
683 nfds = max(nfds, fd2);
687 nfds = max(nfds, fd1);
691 nfds = max(nfds, fd2);
694 r = select(nfds + 1, &rd, &wr, &er, NULL);
696 if (r == \-1 && errno == EINTR)
704 if (FD_ISSET(h, &rd)) {
706 struct sockaddr_in client_address;
708 memset(&client_address, 0, l = sizeof(client_address));
709 r = accept(h, (struct sockaddr *) &client_address, &l);
715 buf1_avail = buf1_written = 0;
716 buf2_avail = buf2_written = 0;
718 fd2 = connect_socket(forward_port, argv[3]);
722 printf("connect from %s\\n",
723 inet_ntoa(client_address.sin_addr));
727 /* NB: read oob data before normal reads */
730 if (FD_ISSET(fd1, &er)) {
733 r = recv(fd1, &c, 1, MSG_OOB);
737 send(fd2, &c, 1, MSG_OOB);
740 if (FD_ISSET(fd2, &er)) {
743 r = recv(fd2, &c, 1, MSG_OOB);
747 send(fd1, &c, 1, MSG_OOB);
750 if (FD_ISSET(fd1, &rd)) {
751 r = read(fd1, buf1 + buf1_avail,
752 BUF_SIZE \- buf1_avail);
759 if (FD_ISSET(fd2, &rd)) {
760 r = read(fd2, buf2 + buf2_avail,
761 BUF_SIZE \- buf2_avail);
768 if (FD_ISSET(fd1, &wr)) {
769 r = write(fd1, buf2 + buf2_written,
770 buf2_avail \- buf2_written);
777 if (FD_ISSET(fd2, &wr)) {
778 r = write(fd2, buf1 + buf1_written,
779 buf1_avail \- buf1_written);
786 /* check if write data has caught read data */
788 if (buf1_written == buf1_avail)
789 buf1_written = buf1_avail = 0;
790 if (buf2_written == buf2_avail)
791 buf2_written = buf2_avail = 0;
793 /* one side has closed the connection, keep
794 writing to the other side until empty */
796 if (fd1 < 0 && buf1_avail \- buf1_written == 0)
798 if (fd2 < 0 && buf2_avail \- buf2_written == 0)
805 上記のプログラムは、ほとんどの種類の TCP 接続をフォワードする。
807 サーバによって中継される OOB シグナルデータも扱える。
808 このプログラムは、データフローを双方向に同時に送るという、
811 コールを使って、各ストリームごとに専用のスレッドを用いるほうが効率的だ、
812 という人もいるかもしれない。しかし、これは考えているよりずっとややこしい。
815 を使って非ブロック I/O をセットすれば良い、というアイデアもあるだろう。
816 これにも実際には問題があり、タイムアウトが非効率的に起こってしまう。
818 このプログラムは一度にひとつ以上の同時接続を扱うことはできないが、
819 その様に拡張するのは簡単で、バッファのリンクリストを
821 現時点のものでは、新しい接続がくると古い接続は落ちてしまう。
840 .\" This man page was written by Paul Sheer.