release/man2/poll.2

   1 .\" Copyright (C) 1997 Andries Brouwer (aeb@cwi.nl)
   2 .\" and Copyright (C) 2006, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Additions from Richard Gooch <rgooch@atnf.CSIRO.AU> and aeb, 971207
  27 .\" 2006-03-13, mtk, Added ppoll() + various other rewordings
  28 .\" 2006-07-01, mtk, Added POLLRDHUP + various other wording and
  29 .\"     formatting changes.
  30 .\"
  31 .\"*******************************************************************
  32 .\"
  33 .\" This file was generated with po4a. Translate the source file.
  34 .\"
  35 .\"*******************************************************************
  36 .TH POLL 2 2012\-08\-17 Linux "Linux Programmer's Manual"
  37 .SH 名前
  38 poll, ppoll \- ファイルディスクリプタにおけるイベントを待つ
  39 .SH 書式
  40 .nf
  41 \fB#include <poll.h>\fP
  42 .sp
  43 \fBint poll(struct pollfd *\fP\fIfds\fP\fB, nfds_t \fP\fInfds\fP\fB, int \fP\fItimeout\fP\fB);\fP
  44 .sp
  45 \fB#define _GNU_SOURCE\fP         /* feature_test_macros(7) 参照 */
  46 \fB#include <poll.h>\fP
  47 .sp
  48 \fBint ppoll(struct pollfd *\fP\fIfds\fP\fB, nfds_t \fP\fInfds\fP\fB, \fP
  49 \fB        const struct timespec *\fP\fItimeout_ts\fP\fB, const sigset_t *\fP\fIsigmask\fP\fB);\fP
  50 .fi
  51 .SH 説明
  52 \fBpoll\fP()  は \fBselect\fP(2)  と同様の仕事を行う、つまり、ファイルディスクリプタ集合のいずれか一つが I/O
  53 を実行可能な状態になるのを待つ。
  54
  55 監視するファイルディスクリプタ集合は、 \fIfds\fP 引き数で指定する。 \fIfds\fP は、以下の型の構造体の配列である。
  56 .in +4n
  57 .nf
  58
  59 struct pollfd {
  60     int   fd;         /* file descriptor */
  61     short events;     /* requested events */
  62     short revents;    /* returned events */
  63 };
  64 .in
  65 .fi
  66 .PP
  67 \fInfds\fP には、 \fIfds\fP 配列の要素数を指定する。
  68
  69 \fIfd\fP フィールドには、オープンされたファイルのファイルディスクリプタが入る。
  70 このフィールドが負の場合、対応する \fIevents\fP フィールドは無視され、
  71 \fIrevents\fP には 0 が返される。(この機能により、一つの \fBpoll\fP() の呼び出しで
  72 簡単にあるファイルディスクリプタを無視することができる。
  73 単に \fIfd\fP フィールドの符号を反転するだけでよい。)
  74
  75 構造体の \fIevents\fP 要素は入力パラメータで、
  76 ファイルディスクリプタ \fIfd\fP に関して、
  77 アプリケーションが興味を持っているイベントのビットマスクを指定する。
  78 このフィールドに 0 が指定された場合は、\fIfd\fP の全てのイベントが無視され、
  79 \fIrevents\fP には 0 が返される。
  80
  81 \fIrevents\fP 要素は出力パラメータで、実際に起こったイベントがカーネルにより設定される。 \fIrevents\fP で返されるビット列には、
  82 \fIevents\fP で指定したもののどれか、もしくは \fBPOLLERR\fP, \fBPOLLHUP\fP, \fBPOLLNVAL\fP のうちの一つが含まれる
  83 (\fBPOLLERR\fP, \fBPOLLHUP\fP, \fBPOLLNVAL\fP の 3つのビットは \fIevents\fP
  84 に指定しても意味がなく、対応した状態が真の場合に \fIrevents\fP に設定される)。
  85
  86 どのファイルディスクリプタにも要求したイベントが発生しておらず、 エラーも起こらない場合、 \fBpoll\fP()
  87 はイベントのうちいずれか一つが発生するまで停止 (block) する。
  88
  89 \fItimeout\fP 引き数は、 \fBpoll\fP() が停止する最小時間をミリ秒で指定する
  90 (この停止時間はシステムクロックの粒度に切り上げられ、カーネルの
  91 スケジューリング遅延により少しだけ長くなる可能性がある)。
  92 \fItimeout\fP に負の値を指定した場合、タイムアウト時間が無限大を意味する。
  93 \fItimeout\fP を 0 に指定した場合、I/O 可能なファイルディスクリプタが
  94 ない場合であっても、 \fBpoll\fP() はすぐに返る。
  95
  96 \fIevents\fP に指定したり、 \fIrevents\fP で返されるビットは \fI<poll.h>\fP で定義されている:
  97 .RS
  98 .TP
  99 \fBPOLLIN\fP
 100 読み出し可能なデータがある。
 101 .TP
 102 \fBPOLLPRI\fP
 103 読み出し可能な緊急データ (urgent data) がある (例えば、TCP ソケットの帯域外 (out\-of\-band data)
 104 データを受信した場合や、 パケットモードの擬似端末のマスタがスレーブ側の変化を見つけたとき)。
 105 .TP
 106 \fBPOLLOUT\fP
 107 書き込みが停止 (block) しない状態である。
 108 .TP
 109 \fBPOLLRDHUP\fP (Linux 2.6.17 以降)
 110 ストリームソケットの他端が、コネクションを close したか、 コネクションの書き込み側を shutdown した。 この定義を有効にするには、
 111 (「どの」ヘッダファイルをインクルードするよりも前に)  \fB_GNU_SOURCE\fP 機能検査マクロを定義しなければならない。
 112 .TP
 113 \fBPOLLERR\fP
 114 エラー状態 (出力の場合のみ)。
 115 .TP
 116 \fBPOLLHUP\fP
 117 ハングアップした (出力の場合のみ)。
 118 .TP
 119 \fBPOLLNVAL\fP
 120 不正な要求: \fIfd\fP がオープンされていない (出力の場合のみ)。
 121 .RE
 122 .PP
 123 \fB_XOPEN_SOURCE\fP を定義してコンパイルした場合には、以下の定義も行われる。
 124 ただし、上記のリストにあるビット以上の情報が得られる訳ではない。
 125 .RS
 126 .TP
 127 \fBPOLLRDNORM\fP
 128 \fBPOLLIN\fP と同じ。
 129 .TP
 130 \fBPOLLRDBAND\fP
 131 .\" POLLRDBAND is used in the DECnet protocol.
 132 優先帯域データ (priority band data) が読み出し可能である (普通は Linux では使用されない)。
 133 .TP
 134 \fBPOLLWRNORM\fP
 135 \fBPOLLOUT\fP と同じ。
 136 .TP
 137 \fBPOLLWRBAND\fP
 138 優先帯域データ (priority data) が書き込み可能である。
 139 .RE
 140 .PP
 141 Linux では \fBPOLLMSG\fP も定義されているが、使用されていない。
 142 .SS ppoll()
 143 \fBpoll\fP()  と \fBppoll\fP()  の関係は \fBselect\fP(2)  と \fBpselect\fP(2)  の関係と同じようなものである:
 144 \fBpselect\fP(2)  と同様に、 \fBppoll\fP()  を使うと、アプリケーションはファイルディスクリプタの状態変化
 145 もしくはシグナルの捕捉を安全に待つことができる。
 146 .PP
 147 \fItimeout\fP 引き数の精度の違いを除くと、以下の \fBppoll\fP()  の呼び出しは、
 148 .nf
 149
 150     ready = ppoll(&fds, nfds, timeout_ts, &sigmask);
 151
 152 .fi
 153 次の呼び出しを \fIatomic\fP に実行するのと等価である。
 154 .nf
 155
 156     sigset_t origmask;
 157     int timeout;
 158
 159     timeout = (timeout_ts == NULL) ? \-1 :
 160               (timeout_ts.tv_sec * 1000 + timeout_ts.tv_nsec / 1000000);
 161     sigprocmask(SIG_SETMASK, &sigmask, &origmask);
 162     ready = poll(&fds, nfds, timeout);
 163     sigprocmask(SIG_SETMASK, &origmask, NULL);
 164 .fi
 165 .PP
 166 なぜ \fBppoll\fP()  が必要なのかについての説明は \fBpselect\fP(2)  の説明を参照のこと。
 167
 168 \fIsigmask\fP 引き数に NULL が指定された場合、シグナルマスクの操作は行われない (したがって、 \fBppoll\fP()  の
 169 \fBpoll\fP()  との違いは \fItimeout\fP 引き数の精度だけとなる)。
 170
 171 \fItimeout\fP 引き数は \fBppoll\fP()  が停止する時間の上限を指定するものである。
 172 この引き数には以下の型の構造体へのポインタを指定する。
 173 .in +4n
 174 .nf
 175
 176 struct timespec {
 177     long    tv_sec;         /* seconds */
 178     long    tv_nsec;        /* nanoseconds */
 179 };
 180 .fi
 181 .in
 182
 183 \fItimeout_ts\fP に NULL が指定された場合、 \fBppoll\fP は無限に停止することがあり得る。
 184 .SH 返り値
 185 成功した場合は正の数を返す。この数は 0 以外の \fIrevents\fP 要素を持つ構造体の数である (別の言い方をすると、これらのディスクリプタ
 186 にはイベントかエラー報告がある)。 値 0 は、タイムアウトとなり、どのファイルディスクリプタでもイベントが 発生しなかったことを示す。エラーの場合は
 187 \-1 が返され、 \fIerrno\fP が適切に設定される。
 188 .SH エラー
 189 .TP
 190 \fBEFAULT\fP
 191 引き数として指定した配列が、呼び出したプロセスのアドレス空間に 含まれていない。
 192 .TP
 193 \fBEINTR\fP
 194 要求されたイベントのどれかが起こる前にシグナルが発生した。 \fBsignal\fP(7)  参照。
 195 .TP
 196 \fBEINVAL\fP
 197 \fInfds\fP の値が \fBRLIMIT_NOFILE\fP を超えた。
 198 .TP
 199 \fBENOMEM\fP
 200 ファイルディスクリプタ・テーブルを確保するためのメモリがない。
 201 .SH バージョン
 202 .\" library call was introduced in libc 5.4.28
 203 \fBpoll\fP() システムコールは Linux 2.1.23 で導入された。
 204 このシステムコールが存在しない古いカーネルでは、
 205 glibc (や古い Linux libc) は \fBselect\fP(2) を使用して \fBpoll\fP()
 206 ラッパー関数のエミュレーションを行う。
 207
 208 \fBppoll\fP()  システムコールは カーネル 2.6.16 で Linux に追加された。 \fBppoll\fP()  ライブラリコールは glibc
 209 2.4 に追加された。
 210 .SH 準拠
 211 .\" NetBSD 3.0 has a pollts() which is like Linux ppoll().
 212 \fBpoll\fP()  は POSIX.1\-2001 に準拠している。 \fBppoll\fP()  は Linux 固有である。
 213 .SH 注意
 214 いくつかの実装では、値 \-1 を持った非標準の定数 \fBINFTIM\fP が定義されており、 \fBpoll\fP()  の \fItimeout\fP
 215 の指定に使用できる。 この定数は glibc では定義されていない。
 216
 217 \fBpoll\fP() で監視中のファイルディスクリプタが別のスレッドによってクローズされた場合に何が起こるかの議論については、 \fBselect\fP(2)
 218 を参照してほしい。
 219 .SS "Linux での注意"
 220 Linux の \fBppoll\fP()  システムコールは \fItimeout_ts\fP 引き数を変更する。 しかし、glibc
 221 のラッパー関数は、システムコールに渡す timeout 引き数 としてローカル変数を使うことでこの動作を隠蔽している。 このため、glibc の
 222 \fBppoll\fP()  関数では \fItimeout_ts\fP 引き数は変更されない。
 223 .SH バグ
 224 \fBselect\fP(2)  の「バグ」の節に書かれている、誤った準備完了通知 (spurious readiness notifications)
 225 についての議論を参照のこと。
 226 .SH 関連項目
 227 \fBselect\fP(2), \fBselect_tut\fP(2), \fBtime\fP(7)
 228 .SH この文書について
 229 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 230 である。プロジェクトの説明とバグ報告に関する情報は
 231 http://www.kernel.org/doc/man\-pages/ に書かれている。