1 .\" This manpage is copyright (C) 2001 Paul Sheer.
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" very minor changes, aeb
27 .\" Modified 5 June 2002, Michael Kerrisk <mtk.manpages@gmail.com>
28 .\" 2006-05-13, mtk, removed much material that is redundant with select.2
29 .\" various other changes
30 .\" 2008-01-26, mtk, substantial changes and rewrites
32 .\"*******************************************************************
34 .\" This file was generated with po4a. Translate the source file.
36 .\"*******************************************************************
37 .TH SELECT_TUT 2 2012\-08\-03 Linux "Linux Programmer's Manual"
39 select, pselect, FD_CLR, FD_ISSET, FD_SET, FD_ZERO \- 同期 I/O の多重化
42 /* POSIX.1\-2001 に従う場合 */
44 \fB#include <sys/select.h>\fP
48 \fB#include <sys/time.h>\fP
50 \fB#include <sys/types.h>\fP
52 \fB#include <unistd.h>\fP
54 \fBint select(int \fP\fInfds\fP\fB, fd_set *\fP\fIreadfds\fP\fB, fd_set *\fP\fIwritefds\fP\fB,\fP
55 \fB fd_set *\fP\fIexceptfds\fP\fB, struct timeval *\fP\fIutimeout\fP\fB);\fP
57 \fBvoid FD_CLR(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
59 \fBint FD_ISSET(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
61 \fBvoid FD_SET(int \fP\fIfd\fP\fB, fd_set *\fP\fIset\fP\fB);\fP
63 \fBvoid FD_ZERO(fd_set *\fP\fIset\fP\fB);\fP
65 \fB#include <sys/select.h>\fP
67 \fBint pselect(int \fP\fInfds\fP\fB, fd_set *\fP\fIreadfds\fP\fB, fd_set *\fP\fIwritefds\fP\fB,\fP
68 \fB fd_set *\fP\fIexceptfds\fP\fB, const struct timespec *\fP\fIntimeout\fP\fB,\fP
69 \fB const sigset_t *\fP\fIsigmask\fP\fB);\fP
73 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7) 参照):
76 \fBpselect\fP(): _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
78 \fBselect\fP() (や \fBpselect\fP()) を使うと、効率的に複数のファイルディスクリプタを監視し、
79 そのファイルディスクリプタのいずれかが 「ready (準備ができた)」状態、つまり I/O (入出力) が可能になっているかや、
80 ファイルディスクリプタのいずれかが 「例外状態 (exceptional condition)」が発生したか、を調べることができる。
82 この関数の主要な引き数は、3種類のファイルディスクリプタの「集合」 \fIreadfds\fP, \fIwritefds\fP, \fIexceptfds\fP である。
83 各々の集合は \fBfd_set\fP として宣言され、その内容は \fBFD_CLR\fP(), \fBFD_ISSET\fP(), \fBFD_SET\fP(),
84 \fBFD_ZERO\fP() といったマクロによって操作できる。 新しく宣言された集合は、まず最初に \fBFD_ZERO\fP()
85 を使ってクリアすべきである。 \fBselect\fP() はこれらの集合の内容を、以降に述べる規則に従って修正する。 \fBselect\fP()
86 を呼んだ後、ファイルディスクリプタがまだ集合に存在しているかどうかは、 \fBFD_ISSET\fP() マクロによって調べることができる。
87 \fBFD_ISSET\fP() は指定されたディスクリプタが集合に存在していれば 0 以外の値を返し、 存在しなければ 0 を返す。
88 \fBFD_CLR\fP() は集合からのファイルディスクリプタの削除を行う。
92 この集合に含まれるいずれかのファイルディスクリプタで、 データの読み込みが可能になったかどうかを監視する。 \fBselect\fP()
93 から戻る時に、\fIreadfds\fP のうち、 直ちに読み込み可能なファイルディスクリプタ以外は 集合から削除される。
96 この集合に含まれるいずれかのファイルディスクリプタで、 データを書き込むスペースがあるかどうかを監視する。 \fBselect\fP()
97 から戻る時に、\fIwritefds\fP のうち、 直ちに書き込み可能なファイルディスクリプタ以外は 集合から削除される。
100 この集合に含まれるいずれかのファイルディスクリプタで、 「例外状態 (exceptional condition)」が発生したかどうかを監視する。
101 実際の動作では、普通に起こり得る例外状態は一つだけであり、 それは TCP ソケットで \fI帯域外 (out\-of\-band; OOB)\fP データが
102 読み込み可能な場合である。 OOB データの詳細については、 \fBrecv\fP(2), \fBsend\fP(2), \fBtcp\fP(7) を参照のこと。
103 (これ以外では、まれなことだが、 パケットモードの擬似端末 (pseudoterminals) で \fBselect\fP()
104 が例外状態を示すことがある。) \fBselect\fP() が返る時に、\fIexceptfds\fP のうち、
105 例外状態が発生したディスクリプタ以外は集合から削除される。
108 全ての集合に含まれるファイルディスクリプタのうち、 値が最大のものに 1 を足した整数である。
109 すなわち、ファイルディスクリプタを各集合に加える作業の途中で、 全てのファイルディスクリプタを見て最大値を求め、 それに 1 を加えて \fInfds\fP
113 (何も起こらなかった場合に) \fBselect\fP() が戻る前に待つ最大時間である。 この値に NULL を渡すと、 \fBselect\fP()
114 はファイルディスクリプタのいずれかが ready (準備ができた) 状態に なるまで待ち続けてずっと停止する。 \fIutimeout\fP は 0
115 秒にすることもでき、 この場合 \fBselect\fP() は直ちに返り、呼び出し時点のファイルディスクリプタの状態に 関する情報が返される。 構造体
116 \fIstruct timeval\fP は次のように定義されている:
121 time_t tv_sec; /* seconds */
122 long tv_usec; /* microseconds */
128 \fBpselect\fP() のこの引き数は \fIutimeout\fP と同じ意味を持つが、 \fIstruct timespec\fP
134 long tv_sec; /* seconds */
135 long tv_nsec; /* nanoseconds */
141 この引き数は、呼び出し側が \fBpselect\fP() 内部で停止している間に、カーネルが通知を許可すべきシグナル集合
142 (すなわち、呼び出したスレッドのシグナルマスクから削除すべきシグナル集合) を保持する (\fBsigaddset\fP(3) と
143 \fBsigprocmask\fP(2) を参照)。 この引き数は NULL にすることもでき、その場合はこの関数へ
144 入るとき・出るときにシグナルマスクを変更しない。 この場合、 \fBpselect\fP() は \fBselect\fP() と全く同じ動作となる。
145 .SS シグナルとデータイベントを組み合わせる
146 ファイルディスクリプタが I/O 可能な状態になるのと同時に シグナルも待ちたい場合には、 \fBpselect\fP() が便利である。
147 シグナルを受信するプログラムは、通常は、 シグナルハンドラをグローバルなフラグを立てるためだけに使う。 このグローバルなフラグは、
148 そのイベントをプログラムのメインループで 処理しなければならないことを示す。 シグナルを受けると \fBselect\fP() (や
149 \fBpselect\fP()) は \fIerrno\fP に \fBEINTR\fP をセットして戻ることになる。
150 シグナルがプログラムのメインループで処理されるためにはこの動作が不可欠で、 これがないと \fBselect\fP() は永遠に停止し続けることになる。
151 さて、メインループのどこかにこのグローバルフラグをチェックする 条件文があるとしよう。ここで少し考えてみないといけない。 「シグナルが条件文の後、しかし
152 \fBselect\fP() コールの前に到着したら どうなるのか?」 答えは「その \fBselect\fP()
153 は、たとえ解決待ちのイベントがあったとしても、 永遠に停止する」である。 この競合状態は \fBpselect\fP() コールによって解決できる。
154 このコールを使うと、 \fBpselect\fP() で受信したいシグナルの集合だけをシグナルマスクに設定することができる。
155 例えば、問題となっているイベントが子プロセスの終了の場合を考えよう。 メインループが始まる前に、 \fBSIGCHLD\fP を
156 \fBsigprocmask\fP(2) でブロックする。 \fBpselect\fP() コールでは \fBSIGCHLD\fP
157 を、もともとのシグナルマスクを使って有効にするのだ。 このプログラムは次のようになる。
160 static volatile sig_atomic_t got_SIGCHLD = 0;
163 child_sig_handler(int sig)
169 main(int argc, char *argv[])
171 sigset_t sigmask, empty_mask;
173 fd_set readfds, writefds, exceptfds;
176 sigemptyset(&sigmask);
177 sigaddset(&sigmask, SIGCHLD);
178 if (sigprocmask(SIG_BLOCK, &sigmask, NULL) == \-1) {
179 perror("sigprocmask");
184 sa.sa_handler = child_sig_handler;
185 sigemptyset(&sa.sa_mask);
186 if (sigaction(SIGCHLD, &sa, NULL) == \-1) {
191 sigemptyset(&empty_mask);
193 for (;;) { /* main loop */
194 /* Initialize readfds, writefds, and exceptfds
195 before the pselect() call. (Code omitted.) */
197 r = pselect(nfds, &readfds, &writefds, &exceptfds,
199 if (r == \-1 && errno != EINTR) {
206 /* Handle signalled event here; e.g., wait() for all
207 terminated children. (Code omitted.) */
210 /* main body of program */
215 実際のところ \fBselect\fP() の大事な点は何なのか? ディスクリプタは好きなときに読み書きできるんじゃないの? \fBselect\fP()
216 の重要なところは、複数のディスクリプタを同時に監視でき、 なんの動きもなければプロセスを適切にスリープ状態に移行するところにあるのだ。 UNIX
217 プログラマは、 複数のファイルディスクリプタの入出力を同時に扱わねばならず、 しかもデータの流れは間欠的である、という状況によく出会う。 単に
218 \fBread\fP(2) や \fBwrite\fP(2) コールのシーケンスを作るだけでは、それらのコールのどれかが
219 ファイルディスクリプタからのデータを待ってブロックしており、 別のファイルディスクリプタには I/O が可能なのに使えない、
220 ということになってしまうだろう。 \fBselect\fP() を使うとこの状況に効果的に対処できる。
222 \fBselect\fP() を使おうとした多くの人は、理解しにくい挙動に出くわし、結果的に
223 できたものは移植性がないか、よくてもギリギリのものになってしまう。 例えば、上記のプログラムは、 集合に含まれるファイルディスクリプタを非停止
224 (nonblocking) モード にしなくても、どこにもブロックが生じないよう注意して書かれている。 微妙な間違いによって、 \fBselect\fP()
225 を使う利点は簡単に失われてしまう。 そこで、 \fBselect\fP() コールを使うときに注意すべき重要事項を列挙しておくことにする。
228 \fBselect\fP() を使うときは、タイムアウトは設定すべきでない。 処理するデータが無いときには、
229 あなたのプログラムには何もすることは無いはずである。 タイムアウトに依存したコードは通常移植性がなく、 デバッグも難しくなる。
232 上述したように、 効率的なプログラムを書くには \fInfds\fP の値を適切に計算して与えなければならない。
235 \fBselect\fP() コールの終了後に結果をチェックして、 適切に対応するつもりのないファイルディスクリプタは、 どの集合にも加えてはならない。
239 \fBselect\fP() から返った後には、全ての集合の全てのファイルディスクリプタについて 読み書き可能な状態になっているかをチェックすべきである。
242 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2)
243 といった関数は、こちらが要求した全データを読み書きする必要は\fIない\fP。 もし全データを読み書きするなら、それはトラフィックの負荷が小さく、
244 ストリームが速い場合だろう。この条件は常に満たされるとは限らない。 これらの関数が頑張っても 1 バイトしか送受信できないような場合も
248 処理するデータ量が小さいことがはっきりとわかっている場合を除いて、 一度に 1 バイトずつ読み書きするようなことはしてはならない。
249 バッファの許すかぎりのデータをまとめて読み書きしないと、 非常に効率が悪い。下記の例ではバッファは 1024 バイトにしているが、
253 .\" Nonetheless, you should still cope with these errors for completeness.
254 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2) などの関数や \fBselect\fP() コールは、
255 \fIerrno\fP を \fBEINTR や EAGAIN\fP (\fBEWOULDBLOCK\fP) にして \-1 を返すことがある。
256 このような結果に対して適切に対応してやらなければならない (上記の例ではしていない)。 書いているプログラムがシグナルを受ける予定がなければ、
257 \fBEINTR\fP が返されることはあまり考えられない。 書いているプログラムで非ブロック I/O をセットしていない場合は、 \fBEAGAIN\fP
261 決して、引き数に長さ 0 のバッファを指定して \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2)
265 \fBread\fP(2), \fBrecv\fP(2), \fBwrite\fP(2), \fBsend\fP(2) が \fB7.\fP に示した以外のエラーで失敗した場合や、
266 入力系の関数の一つがファイル末尾を表す 0 を返した場合は、 そのディスクリプタをもう一度 select に渡しては\fIならない\fP。
267 下記の例では、そのディスクリプタをただちにクローズし、 そこには \-1 をセットして、 それが集合に含まれ続けるのを許さないようにしている。
270 タイムアウトの値は \fBselect\fP() を呼ぶたびに初期化すべきである。 OS によっては timeout
271 構造体が変更される場合があるからである。 但し、 \fBpselect\fP() は自分の timeout 構造体を変更することはない。
274 .\" "I have heard" does not fill me with confidence, and doesn't
275 .\" belong in a man page, so I've commented this point out.
278 .\" I have heard that the Windows socket layer does not cope with OOB data
280 .\" It also does not cope with
282 .\" calls when no file descriptors are set at all.
283 .\" Having no file descriptors set is a useful
284 .\" way to sleep the process with subsecond precision by using the timeout.
285 .\" (See further on.)
286 \fBselect\fP() はファイルディスクリプタ集合を変更するので、 \fBselect\fP()
287 がループの中で使用されている場合には、呼び出しを行う前に毎回 ディスクリプタ集合を初期化し直さなければならない。
288 .SS "usleep エミュレーション"
289 \fBusleep\fP(3) 関数を持たないシステムでは、 有限のタイムアウトを指定し、ファイルディスクリプタを全くセットせずに \fBselect\fP()
290 を呼び出すことで、これを代用できる。 以下のようにする。
295 tv.tv_usec = 200000; /* 0.2 seconds */
296 select(0, NULL, NULL, NULL, &tv);
299 但し、これが動くと保証されているのは UNIX システムに限られる。
301 成功すると、 \fBselect\fP() はファイルディスクリプタ集合に残っている ファイルディスクリプタの総数を返す。
303 \fBselect\fP() がタイムアウトすると、返り値は 0 になる。 その時、ファイルディスクリプタ集合はすべて空である
306 返り値が \-1 の場合はエラーを意味し、 \fIerrno\fP が適切にセットされる。エラーが起こった場合、 返された集合の内容や構造体 \fIstruct
307 timeout\fP の内容は 未定義となっており、使用すべきではない。 しかし \fBpselect\fP() は決して \fIntimeout\fP
310 一般的に言って、ソケットをサポートする全てのオペレーティングシステムは \fBselect\fP() もサポートしている。 \fBselect\fP()
311 を使うと、プログラマがスレッド、フォーク、IPC、シグナル、メモリ共有、 等々を使ってもっと複雑な方法で解決しようとする多くの問題が、
312 移植性がありかつ効率的な方法で解決できる。
314 \fBpoll\fP(2) システムコールは \fBselect\fP() と同じ機能を持っており、 まばらなファイルディスクリプタ集合を監視する場合に
315 いくらか効率がよい。 現在では広く利用可能であるが、以前は \fBselect\fP() より移植性の面で劣っていた。
317 Linux 独自の \fBepoll\fP(7) API は、多数のファイルディスクリプタを監視する場合に \fBselect\fP(2) や
318 \fBpoll\fP(2) よりも効率的なインタフェースを提供している。
320 \fBselect\fP() の本当に便利な点を示す、よい例を紹介する。 以下のリストは、ある TCP ポートから別のポートへ転送を行う TCP
327 #include <sys/time.h>
328 #include <sys/types.h>
331 #include <sys/socket.h>
332 #include <netinet/in.h>
333 #include <arpa/inet.h>
336 static int forward_port;
339 #define max(x,y) ((x) > (y) ? (x) : (y))
342 listen_socket(int listen_port)
344 struct sockaddr_in a;
348 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
353 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
354 &yes, sizeof(yes)) == \-1) {
355 perror("setsockopt");
359 memset(&a, 0, sizeof(a));
360 a.sin_port = htons(listen_port);
361 a.sin_family = AF_INET;
362 if (bind(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
367 printf("accepting connections on port %d\en", listen_port);
373 connect_socket(int connect_port, char *address)
375 struct sockaddr_in a;
378 if ((s = socket(AF_INET, SOCK_STREAM, 0)) == \-1) {
384 memset(&a, 0, sizeof(a));
385 a.sin_port = htons(connect_port);
386 a.sin_family = AF_INET;
388 if (!inet_aton(address, (struct in_addr *) &a.sin_addr.s_addr)) {
389 perror("bad IP address format");
394 if (connect(s, (struct sockaddr *) &a, sizeof(a)) == \-1) {
396 shutdown(s, SHUT_RDWR);
403 #define SHUT_FD1 do { \e
405 shutdown(fd1, SHUT_RDWR); \e
411 #define SHUT_FD2 do { \e
413 shutdown(fd2, SHUT_RDWR); \e
419 #define BUF_SIZE 1024
422 main(int argc, char *argv[])
425 int fd1 = \-1, fd2 = \-1;
426 char buf1[BUF_SIZE], buf2[BUF_SIZE];
427 int buf1_avail, buf1_written;
428 int buf2_avail, buf2_written;
431 fprintf(stderr, "Usage\en\etfwd <listen\-port> "
432 "<forward\-to\-port> <forward\-to\-ip\-address>\en");
436 signal(SIGPIPE, SIG_IGN);
438 forward_port = atoi(argv[2]);
440 h = listen_socket(atoi(argv[1]));
453 if (fd1 > 0 && buf1_avail < BUF_SIZE) {
455 nfds = max(nfds, fd1);
457 if (fd2 > 0 && buf2_avail < BUF_SIZE) {
459 nfds = max(nfds, fd2);
461 if (fd1 > 0 && buf2_avail \- buf2_written > 0) {
463 nfds = max(nfds, fd1);
465 if (fd2 > 0 && buf1_avail \- buf1_written > 0) {
467 nfds = max(nfds, fd2);
471 nfds = max(nfds, fd1);
475 nfds = max(nfds, fd2);
478 r = select(nfds + 1, &rd, &wr, &er, NULL);
480 if (r == \-1 && errno == EINTR)
488 if (FD_ISSET(h, &rd)) {
490 struct sockaddr_in client_address;
492 memset(&client_address, 0, l = sizeof(client_address));
493 r = accept(h, (struct sockaddr *) &client_address, &l);
499 buf1_avail = buf1_written = 0;
500 buf2_avail = buf2_written = 0;
502 fd2 = connect_socket(forward_port, argv[3]);
506 printf("connect from %s\en",
507 inet_ntoa(client_address.sin_addr));
511 /* NB: read oob data before normal reads */
514 if (FD_ISSET(fd1, &er)) {
517 r = recv(fd1, &c, 1, MSG_OOB);
521 send(fd2, &c, 1, MSG_OOB);
524 if (FD_ISSET(fd2, &er)) {
527 r = recv(fd2, &c, 1, MSG_OOB);
531 send(fd1, &c, 1, MSG_OOB);
534 if (FD_ISSET(fd1, &rd)) {
535 r = read(fd1, buf1 + buf1_avail,
536 BUF_SIZE \- buf1_avail);
543 if (FD_ISSET(fd2, &rd)) {
544 r = read(fd2, buf2 + buf2_avail,
545 BUF_SIZE \- buf2_avail);
552 if (FD_ISSET(fd1, &wr)) {
553 r = write(fd1, buf2 + buf2_written,
554 buf2_avail \- buf2_written);
561 if (FD_ISSET(fd2, &wr)) {
562 r = write(fd2, buf1 + buf1_written,
563 buf1_avail \- buf1_written);
570 /* check if write data has caught read data */
572 if (buf1_written == buf1_avail)
573 buf1_written = buf1_avail = 0;
574 if (buf2_written == buf2_avail)
575 buf2_written = buf2_avail = 0;
577 /* one side has closed the connection, keep
578 writing to the other side until empty */
580 if (fd1 < 0 && buf1_avail \- buf1_written == 0)
582 if (fd2 < 0 && buf2_avail \- buf2_written == 0)
589 上記のプログラムは、ほとんどの種類の TCP 接続をフォワードする。 \fBtelnet\fP サーバによって中継される OOB シグナルデータも扱える。
590 このプログラムは、データフローを双方向に同時に送るという、 ややこしい問題も処理できる。 \fBfork\fP(2)
591 コールを使って、各ストリームごとに専用のスレッドを用いるほうが効率的だ、 という人もいるかもしれない。しかし、これは考えているよりずっとややこしい。
592 あるいは、 \fBfcntl\fP(2) を使って非ブロック I/O をセットすれば良い、というアイデアもあるだろう。
593 これにも実際には問題があり、タイムアウトが非効率的に起こってしまう。
595 このプログラムは一度にひとつ以上の同時接続を扱うことはできないが、 その様に拡張するのは簡単で、バッファのリンクリストを (接続ごとにひとつずつ)
596 使えばよい。 現時点のものでは、新しい接続がくると古い接続は落ちてしまう。
599 .\" This man page was written by Paul Sheer.
600 \fBaccept\fP(2), \fBconnect\fP(2), \fBioctl\fP(2), \fBpoll\fP(2), \fBread\fP(2),
601 \fBrecv\fP(2), \fBselect\fP(2), \fBsend\fP(2), \fBsigprocmask\fP(2), \fBwrite\fP(2),
602 \fBsigaddset\fP(3), \fBsigdelset\fP(3), \fBsigemptyset\fP(3), \fBsigfillset\fP(3),
603 \fBsigismember\fP(3), \fBepoll\fP(7)
605 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
606 である。プロジェクトの説明とバグ報告に関する情報は
607 http://www.kernel.org/doc/man\-pages/ に書かれている。