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 .\"*******************************************************************
32 .\" This file was generated with po4a. Translate the source file.
34 .\"*******************************************************************
35 .TH SELECT_TUT 2 2010\-06\-10 Linux "Linux Programmer's Manual"
37 select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- 同期 I/O の多重化
40 /* POSIX.1\-2001 に従う場合 */
42 \fB#include <sys/select.h>\fP
46 \fB#include <sys/time.h>\fP
48 \fB#include <sys/types.h>\fP
50 \fB#include <unistd.h>\fP
52 \fBint select(int \fP\fInfds\fP\fB, fd_set *\fP\fIreadfds\fP\fB, fd_set *\fP\fIwritefds\fP\fB,\fP
53 \fB fd_set *\fP\fIexceptfds\fP\fB, struct timeval *\fP\fIutimeout\fP\fB);\fP
55 \fBvoid FD_CLR(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
57 \fBint FD_ISSET(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
59 \fBvoid FD_SET(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
61 \fBvoid FD_ZERO(fd_set *\fP\fIset\fP\fB);\fP
63 \fB#include <sys/select.h>\fP
65 \fBint pselect(int \fP\fInfds\fP\fB, fd_set *\fP\fIreadfds\fP\fB, fd_set *\fP\fIwritefds\fP\fB,\fP
66 \fB fd_set *\fP\fIexceptfds\fP\fB, const struct timespec *\fP\fIntimeout\fP\fB,\fP
67 \fB const sigset_t *\fP\fIsigmask\fP\fB);\fP
71 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7) 参照):
74 \fBpselect\fP(): _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
76 \fBselect\fP() (や \fBpselect\fP()) を使うと、効率的に複数のファイルディスクリプタを監視し、
77 そのファイルディスクリプタのいずれかが 「ready (準備ができた)」状態、つまり I/O (入出力) が可能になっているかや、
78 ファイルディスクリプタのいずれかが 「例外状態 (exceptional condition)」が発生したか、を調べることができる。
80 この関数の主要な引き数は、3種類のファイルディスクリプタの「集合」 \fIreadfds\fP, \fIwritefds\fP, \fIexceptfds\fP である。
81 各々の集合は \fBfd_set\fP として宣言され、その内容は \fBFD_CLR\fP(), \fBFD_ISSET\fP(), \fBFD_SET\fP(),
82 \fBFD_ZERO\fP() といったマクロによって操作できる。 新しく宣言された集合は、まず最初に \fBFD_ZERO\fP()
83 を使ってクリアすべきである。 \fBselect\fP() はこれらの集合の内容を、以降に述べる規則に従って修正する。 \fBselect\fP()
84 を呼んだ後、ファイルディスクリプタがまだ集合に存在しているかどうかは、 \fBFD_ISSET\fP() マクロによって調べることができる。
85 \fBFD_ISSET\fP() は指定されたディスクリプタが集合に存在していれば 0 以外の値を返し、 存在しなければ 0 を返す。
86 \fBFD_CLR\fP() は集合からのファイルディスクリプタの削除を行う。
90 この集合に含まれるいずれかのファイルディスクリプタで、 データの読み込みが可能になったかどうかを監視する。 \fBselect\fP()
91 から戻る時に、\fIreadfds\fP のうち、 直ちに読み込み可能なファイルディスクリプタ以外は 集合から削除される。
94 この集合に含まれるいずれかのファイルディスクリプタで、 データを書き込むスペースがあるかどうかを監視する。 \fBselect\fP()
95 から戻る時に、\fIwritefds\fP のうち、 直ちに書き込み可能なファイルディスクリプタ以外は 集合から削除される。
98 この集合に含まれるいずれかのファイルディスクリプタで、 「例外状態 (exceptional condition)」が発生したかどうかを監視する。
99 実際の動作では、普通に起こり得る例外状態は一つだけであり、 それは TCP ソケットで \fI帯域外 (out\-of\-band; OOB)\fP データが
100 読み込み可能な場合である。 OOB データの詳細については、 \fBrecv\fP(2), \fBsend\fP(2), \fBtcp\fP(7) を参照のこと。
101 (これ以外では、まれなことだが、 パケットモードの擬似端末 (pseudoterminals) で \fBselect\fP()
102 が例外状態を示すことがある。) \fBselect\fP() が返る時に、\fIexceptfds\fP のうち、
103 例外状態が発生したディスクリプタ以外は集合から削除される。
106 全ての集合に含まれるファイルディスクリプタのうち、 値が最大のものに 1 を足した整数である。
107 すなわち、ファイルディスクリプタを各集合に加える作業の途中で、 全てのファイルディスクリプタを見て最大値を求め、 それに 1 を加えて \fInfds\fP
111 (何も起こらなかった場合に) \fBselect\fP() が戻る前に待つ最大時間である。 この値に NULL を渡すと、 \fBselect\fP()
112 はファイルディスクリプタのいずれかが ready (準備ができた) 状態に なるまで待ち続けてずっと停止する。 \fIutimeout\fP は 0
113 秒にすることもでき、 この場合 \fBselect\fP() は直ちに返り、呼び出し時点のファイルディスクリプタの状態に 関する情報が返される。 構造体
114 \fIstruct timeval\fP は次のように定義されている:
119 time_t tv_sec; /* seconds */
120 long tv_usec; /* microseconds */
126 \fBpselect\fP() のこの引き数は \fIutimeout\fP と同じ意味を持つが、 \fIstruct timespec\fP
132 long tv_sec; /* seconds */
133 long tv_nsec; /* nanoseconds */
139 この引き数は、呼び出し側が \fBpselect\fP() 内部で停止している間に、カーネルが通知を許可すべきシグナル集合
140 (すなわち、呼び出したスレッドのシグナルマスクから削除すべきシグナル集合) を保持する (\fBsigaddset\fP(3) と
141 \fBsigprocmask\fP(2) を参照)。 この引き数は NULL にすることもでき、その場合はこの関数へ
142 入るとき・出るときにシグナルマスクを変更しない。 この場合、 \fBpselect\fP() は \fBselect\fP() と全く同じ動作となる。
143 .SS シグナルとデータイベントを組み合わせる
144 ファイルディスクリプタが I/O 可能な状態になるのと同時に シグナルも待ちたい場合には、 \fBpselect\fP() が便利である。
145 シグナルを受信するプログラムは、通常は、 シグナルハンドラをグローバルなフラグを立てるためだけに使う。 このグローバルなフラグは、
146 そのイベントをプログラムのメインループで 処理しなければならないことを示す。 シグナルを受けると \fBselect\fP() (や
147 \fBpselect\fP()) は \fIerrno\fP に \fBEINTR\fP をセットして戻ることになる。
148 シグナルがプログラムのメインループで処理されるためにはこの動作が不可欠で、 これがないと \fBselect\fP() は永遠に停止し続けることになる。
149 さて、メインループのどこかにこのグローバルフラグをチェックする 条件文があるとしよう。ここで少し考えてみないといけない。 「シグナルが条件文の後、しかし
150 \fBselect\fP() コールの前に到着したら どうなるのか?」 答えは「その \fBselect\fP()
151 は、たとえ解決待ちのイベントがあったとしても、 永遠に停止する」である。 この競合状態は \fBpselect\fP() コールによって解決できる。
152 このコールを使うと、 \fBpselect\fP() で受信したいシグナルの集合だけをシグナルマスクに設定することができる。
153 例えば、問題となっているイベントが子プロセスの終了の場合を考えよう。 メインループが始まる前に、 \fBSIGCHLD\fP を
154 \fBsigprocmask\fP(2) でブロックする。 \fBpselect\fP() コールでは \fBSIGCHLD\fP
155 を、もともとのシグナルマスクを使って有効にするのだ。 このプログラムは次のようになる。
158 static volatile sig_atomic_t got_SIGCHLD = 0;
161 child_sig_handler(int sig)
167 main(int argc, char *argv[])
169 sigset_t sigmask, empty_mask;
171 fd_set readfds, writefds, exceptfds;
174 sigemptyset(&sigmask);
175 sigaddset(&sigmask, SIGCHLD);
176 if (sigprocmask(SIG_BLOCK, &sigmask, NULL) == \-1) {
177 perror("sigprocmask");
182 sa.sa_handler = child_sig_handler;
183 sigemptyset(&sa.sa_mask);
184 if (sigaction(SIGCHLD, &sa, NULL) == \-1) {
189 sigemptyset(&empty_mask);
191 for (;;) { /* main loop */
192 /* Initialize readfds, writefds, and exceptfds
193 before the pselect() call. (Code omitted.) */
195 r = pselect(nfds, &readfds, &writefds, &exceptfds,
197 if (r == \-1 && errno != EINTR) {
204 /* Handle signalled event here; e.g., wait() for all
205 terminated children. (Code omitted.) */
208 /* main body of program */
213 実際のところ \fBselect\fP() の大事な点は何なのか? ディスクリプタは好きなときに読み書きできるんじゃないの? \fBselect\fP()
214 の重要なところは、複数のディスクリプタを同時に監視でき、 なんの動きもなければプロセスを適切にスリープ状態に移行するところにあるのだ。 UNIX
215 プログラマは、 複数のファイルディスクリプタの入出力を同時に扱わねばならず、 しかもデータの流れは間欠的である、という状況によく出会う。 単に
216 \fBread\fP(2) や \fBwrite\fP(2) コールのシーケンスを作るだけでは、それらのコールのどれかが
217 ファイルディスクリプタからのデータを待ってブロックしており、 別のファイルディスクリプタには I/O が可能なのに使えない、
218 ということになってしまうだろう。 \fBselect\fP() を使うとこの状況に効果的に対処できる。
220 \fBselect\fP() を使おうとした多くの人は、理解しにくい挙動に出くわし、結果的に
221 できたものは移植性がないか、よくてもギリギリのものになってしまう。 例えば、上記のプログラムは、 集合に含まれるファイルディスクリプタを非停止
222 (nonblocking) モード にしなくても、どこにもブロックが生じないよう注意して書かれている。 微妙な間違いによって、 \fBselect\fP()
223 を使う利点は簡単に失われてしまう。 そこで、 \fBselect\fP() コールを使うときに注意すべき重要事項を列挙しておくことにする。
226 \fBselect\fP() を使うときは、タイムアウトは設定すべきでない。 処理するデータが無いときには、
227 あなたのプログラムには何もすることは無いはずである。 タイムアウトに依存したコードは通常移植性がなく、 デバッグも難しくなる。
230 上述したように、 効率的なプログラムを書くには \fInfds\fP の値を適切に計算して与えなければならない。
233 \fBselect\fP() コールの終了後に結果をチェックして、 適切に対応するつもりのないファイルディスクリプタは、 どの集合にも加えてはならない。
237 \fBselect\fP() から返った後には、全ての集合の全てのファイルディスクリプタについて 読み書き可能な状態になっているかをチェックすべきである。
240 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2)
241 といった関数は、こちらが要求した全データを読み書きする必要は\fIない\fP。 もし全データを読み書きするなら、それはトラフィックの負荷が小さく、
242 ストリームが速い場合だろう。この条件は常に満たされるとは限らない。 これらの関数が頑張っても 1 バイトしか送受信できないような場合も
246 処理するデータ量が小さいことがはっきりとわかっている場合を除いて、 一度に 1 バイトずつ読み書きするようなことはしてはならない。
247 バッファの許すかぎりのデータをまとめて読み書きしないと、 非常に効率が悪い。下記の例ではバッファは 1024 バイトにしているが、
251 .\" Nonetheless, you should still cope with these errors for completeness.
252 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2) などの関数や \fBselect\fP() コールは、
253 \fIerrno\fP を \fBEINTR や EAGAIN\fP (\fBEWOULDBLOCK\fP) にして \-1 を返すことがある。
254 このような結果に対して適切に対応してやらなければならない (上記の例ではしていない)。 書いているプログラムがシグナルを受ける予定がなければ、
255 \fBEINTR\fP が返されることはあまり考えられない。 書いているプログラムで非ブロック I/O をセットしていない場合は、 \fBEAGAIN\fP
259 決して、引き数に長さ 0 のバッファを指定して \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2)
263 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2) が \fB7.\fP に示した以外のエラーで失敗した場合や、
264 入力系の関数の一つがファイル末尾を表す 0 を返した場合は、 そのディスクリプタをもう一度 select に渡しては\fIならない\fP。
265 下記の例では、そのディスクリプタをただちにクローズし、 そこには \-1 をセットして、 それが集合に含まれ続けるのを許さないようにしている。
268 タイムアウトの値は \fBselect\fP() を呼ぶたびに初期化すべきである。 OS によっては timeout
269 構造体が変更される場合があるからである。 但し、 \fBpselect\fP() は自分の timeout 構造体を変更することはない。
272 .\" "I have heard" does not fill me with confidence, and doesn't
273 .\" belong in a man page, so I've commented this point out.
276 .\" I have heard that the Windows socket layer does not cope with OOB data
278 .\" It also does not cope with
280 .\" calls when no file descriptors are set at all.
281 .\" Having no file descriptors set is a useful
282 .\" way to sleep the process with subsecond precision by using the timeout.
283 .\" (See further on.)
284 \fBselect\fP() はファイルディスクリプタ集合を変更するので、 \fBselect\fP()
285 がループの中で使用されている場合には、呼び出しを行う前に毎回 ディスクリプタ集合を初期化し直さなければならない。
286 .SS "usleep エミュレーション"
287 \fBusleep\fP(3) 関数を持たないシステムでは、 有限のタイムアウトを指定し、ファイルディスクリプタを全くセットせずに \fBselect\fP()
288 を呼び出すことで、これを代用できる。 以下のようにする。
293 tv.tv_usec = 200000; /* 0.2 seconds */
294 select(0, NULL, NULL, NULL, &tv);
297 但し、これが動くと保証されているのは UNIX システムに限られる。
299 成功すると、 \fBselect\fP() はファイルディスクリプタ集合に残っている ファイルディスクリプタの総数を返す。
301 \fBselect\fP() がタイムアウトすると、返り値は 0 になる。 その時、ファイルディスクリプタ集合はすべて空である
304 返り値が \-1 の場合はエラーを意味し、 \fIerrno\fP が適切にセットされる。エラーが起こった場合、 返された集合の内容や構造体 \fIstruct
305 timeout\fP の内容は 未定義となっており、使用すべきではない。 しかし \fBpselect\fP() は決して \fIntimeout\fP
308 一般的に言って、ソケットをサポートする全てのオペレーティングシステムは \fBselect\fP() もサポートしている。 \fBselect\fP()
309 を使うと、プログラマがスレッド、フォーク、IPC、シグナル、メモリ共有、 等々を使ってもっと複雑な方法で解決しようとする多くの問題が、
310 移植性がありかつ効率的な方法で解決できる。
312 \fBpoll\fP(2) システムコールは \fBselect\fP() と同じ機能を持っており、 まばらなファイルディスクリプタ集合を監視する場合に
313 いくらか効率がよい。 現在では広く利用可能であるが、以前は \fBselect\fP() より移植性の面で劣っていた。
315 Linux 独自の \fBepoll\fP(7) API は、多数のファイルディスクリプタを監視する場合に \fBselect\fP(2) や
316 \fBpoll\fP(2) よりも効率的なインタフェースを提供している。
318 \fBselect\fP() の本当に便利な点を示す、よい例を紹介する。 以下のリストは、ある TCP ポートから別のポートへ転送を行う TCP
325 #include <sys/time.h>
326 #include <sys/types.h>
329 #include <sys/socket.h>
330 #include <netinet/in.h>
331 #include <arpa/inet.h>
334 static int forward_port;
337 #define max(x,y) ((x) > (y) ? (x) : (y))
340 listen_socket(int listen_port)
342 struct sockaddr_in a;
346 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
351 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
352 (char *) &yes, sizeof(yes)) == \-1) {
353 perror("setsockopt");
357 memset(&a, 0, sizeof(a));
358 a.sin_port = htons(listen_port);
359 a.sin_family = AF_INET;
360 if (bind(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
365 printf("accepting connections on port %d\en", listen_port);
371 connect_socket(int connect_port, char *address)
373 struct sockaddr_in a;
376 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
382 memset(&a, 0, sizeof(a));
383 a.sin_port = htons(connect_port);
384 a.sin_family = AF_INET;
386 if (!inet_aton(address, (struct in_addr *) &a.sin_addr.s_addr)) {
387 perror("bad IP address format");
392 if (connect(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
394 shutdown(s, SHUT_RDWR);
401 #define SHUT_FD1 do { \e
403 shutdown(fd1, SHUT_RDWR); \e
409 #define SHUT_FD2 do { \e
411 shutdown(fd2, SHUT_RDWR); \e
417 #define BUF_SIZE 1024
420 main(int argc, char *argv[])
423 int fd1 = \-1, fd2 = \-1;
424 char buf1[BUF_SIZE], buf2[BUF_SIZE];
425 int buf1_avail, buf1_written;
426 int buf2_avail, buf2_written;
429 fprintf(stderr, "Usage\en\etfwd <listen\-port> "
430 "<forward\-to\-port> <forward\-to\-ip\-address>\en");
434 signal(SIGPIPE, SIG_IGN);
436 forward_port = atoi(argv[2]);
438 h = listen_socket(atoi(argv[1]));
451 if (fd1 > 0 && buf1_avail < BUF_SIZE) {
453 nfds = max(nfds, fd1);
455 if (fd2 > 0 && buf2_avail < BUF_SIZE) {
457 nfds = max(nfds, fd2);
459 if (fd1 > 0 && buf2_avail \- buf2_written > 0) {
461 nfds = max(nfds, fd1);
463 if (fd2 > 0 && buf1_avail \- buf1_written > 0) {
465 nfds = max(nfds, fd2);
469 nfds = max(nfds, fd1);
473 nfds = max(nfds, fd2);
476 r = select(nfds + 1, &rd, &wr, &er, NULL);
478 if (r == \-1 && errno == EINTR)
486 if (FD_ISSET(h, &rd)) {
488 struct sockaddr_in client_address;
490 memset(&client_address, 0, l = sizeof(client_address));
491 r = accept(h, (struct sockaddr *) &client_address, &l);
497 buf1_avail = buf1_written = 0;
498 buf2_avail = buf2_written = 0;
500 fd2 = connect_socket(forward_port, argv[3]);
504 printf("connect from %s\en",
505 inet_ntoa(client_address.sin_addr));
509 /* NB: read oob data before normal reads */
512 if (FD_ISSET(fd1, &er)) {
515 r = recv(fd1, &c, 1, MSG_OOB);
519 send(fd2, &c, 1, MSG_OOB);
522 if (FD_ISSET(fd2, &er)) {
525 r = recv(fd2, &c, 1, MSG_OOB);
529 send(fd1, &c, 1, MSG_OOB);
532 if (FD_ISSET(fd1, &rd)) {
533 r = read(fd1, buf1 + buf1_avail,
534 BUF_SIZE \- buf1_avail);
541 if (FD_ISSET(fd2, &rd)) {
542 r = read(fd2, buf2 + buf2_avail,
543 BUF_SIZE \- buf2_avail);
550 if (FD_ISSET(fd1, &wr)) {
551 r = write(fd1, buf2 + buf2_written,
552 buf2_avail \- buf2_written);
559 if (FD_ISSET(fd2, &wr)) {
560 r = write(fd2, buf1 + buf1_written,
561 buf1_avail \- buf1_written);
568 /* check if write data has caught read data */
570 if (buf1_written == buf1_avail)
571 buf1_written = buf1_avail = 0;
572 if (buf2_written == buf2_avail)
573 buf2_written = buf2_avail = 0;
575 /* one side has closed the connection, keep
576 writing to the other side until empty */
578 if (fd1 < 0 && buf1_avail \- buf1_written == 0)
580 if (fd2 < 0 && buf2_avail \- buf2_written == 0)
587 上記のプログラムは、ほとんどの種類の TCP 接続をフォワードする。 \fBtelnet\fP サーバによって中継される OOB シグナルデータも扱える。
588 このプログラムは、データフローを双方向に同時に送るという、 ややこしい問題も処理できる。 \fBfork\fP(2)
589 コールを使って、各ストリームごとに専用のスレッドを用いるほうが効率的だ、 という人もいるかもしれない。しかし、これは考えているよりずっとややこしい。
590 あるいは、 \fBfcntl\fP(2) を使って非ブロック I/O をセットすれば良い、というアイデアもあるだろう。
591 これにも実際には問題があり、タイムアウトが非効率的に起こってしまう。
593 このプログラムは一度にひとつ以上の同時接続を扱うことはできないが、 その様に拡張するのは簡単で、バッファのリンクリストを (接続ごとにひとつずつ)
594 使えばよい。 現時点のものでは、新しい接続がくると古い接続は落ちてしまう。
596 \fBaccept\fP(2), \fBconnect\fP(2), \fBioctl\fP(2), \fBpoll\fP(2), \fBread\fP(2),
597 \fBrecv\fP(2), \fBselect\fP(2), \fBsend\fP(2), \fBsigprocmask\fP(2), \fBwrite\fP(2),
598 \fBsigaddset\fP(3), \fBsigdelset\fP(3), \fBsigemptyset\fP(3), \fBsigfillset\fP(3),
599 \fBsigismember\fP(3), \fBepoll\fP(7)
601 .\" This man page was written by Paul Sheer.