release/man2/eventfd.2

   1 .\" Copyright (C) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" starting from a version by Davide Libenzi <davidel@xmailserver.org>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
   5 .\" This program is free software; you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation; either version 2 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" This program is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public
  16 .\" License along with this manual; if not, see
  17 .\" <http://www.gnu.org/licenses/>.
  18 .\" %%%LICENSE_END
  19 .\"
  20 .\" 2008-10-10, mtk: describe eventfd2(), and EFD_NONBLOCK and EFD_CLOEXEC
  21 .\"
  22 .\"*******************************************************************
  23 .\"
  24 .\" This file was generated with po4a. Translate the source file.
  25 .\"
  26 .\"*******************************************************************
  27 .TH EVENTFD 2 2010\-08\-30 Linux "Linux Programmer's Manual"
  28 .SH 名前
  29 eventfd \- イベント通知用のファイルディスクリプタを生成する
  30 .SH 書式
  31 \fB#include <sys/eventfd.h>\fP
  32 .sp
  33 \fBint eventfd(unsigned int \fP\fIinitval\fP\fB, int \fP\fIflags\fP\fB);\fP
  34 .SH 説明
  35 \fBeventfd\fP()  は "eventfd オブジェクト" を生成する。 eventfd
  36 オブジェクトはユーザ空間アプリケーションがイベント待ち受け/通知用の 仕組みとして使うことができる。また、カーネルがユーザ空間アプリケーションに
  37 イベントを通知するためにも使うことができる。 このオブジェクトには、unsigned の 64 ビット整数 (\fIuint64_t\fP)
  38 型のカウンタが含まれており、このカウンタはカーネルにより管理される。 このカウンタは \fIinitval\fP 引き数で指定された値で初期化される。
  39
  40 以下の値のいくつかをビット単位の論理和 (OR) で指定することで、
  41 \fBeventfd\fP() の振舞いを変更することができる。
  42 .TP
  43 \fBEFD_CLOEXEC\fP (Linux 2.6.27 以降)
  44 新しいファイルディスクリプタに対して close\-on\-exec (\fBFD_CLOEXEC\fP)  フラグをセットする。
  45 このフラグが役に立つ理由については、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP フラグの説明を参照のこと。
  46 .TP
  47 \fBEFD_NONBLOCK\fP (Linux 2.6.27 以降)
  48 新しく生成されるオープンファイル記述 (open file description) の \fBO_NONBLOCK\fP
  49 ファイルステータスフラグをセットする。 このフラグを使うことで、 \fBO_NONBLOCK\fP をセットするために \fBfcntl\fP(2)
  50 を追加で呼び出す必要がなくなる。
  51 .TP
  52 \fBEFD_SEMAPHORE\fP (Linux 2.6.30 以降)
  53 新しいファイルディスクリプタからの読み出しにおいて、セマフォ風の動作を行う。
  54 下記参照。
  55 .PP
  56 バージョン 2.6.26 以前の Linux では、 \fIflags\fP 引き数は未使用であり、0 を指定しなければならない。
  57
  58 \fBeventfd\fP()  は eventfd オブジェクトを参照するのに使用できる新しいファイルディスクリプタ
  59 を返す。返されたファイルディスクリプタに対しては以下の操作を実行できる。
  60 .TP
  61 \fBread\fP(2)
  62 \fBread\fP(2) は成功すると、8 バイトの整数を返す。
  63 渡されたバッファの大きさが 8 バイト未満の場合、
  64 \fBread\fP(2)  はエラー \fBEINVAL\fP で失敗する。
  65 .IP
  66 \fBread\fP(2) が返す値は、ホストバイトオーダ、つまり
  67 そのホストマシンにおける整数の通常のバイトオーダである。
  68 .IP
  69 \fBread\fP(2) の動作は、 eventfd カウンタの現在の値が 0 以外であるかと、
  70 eventfd ファイルディスクリプタを作成する際に \fBEFD_SEMAPHORE\fP フラグが
  71 指定されたか、により変化する。
  72 .RS
  73 .IP * 3
  74 \fBEFD_SEMAPHORE\fP が指定されておらず、eventfd カウンタが 0 以外の値
  75 の場合、 \fBread\fP(2) はカウンタ値を格納した 8 バイトの値を返し、
  76 カウンタ値は 0 にリセットされる。
  77 .IP *
  78 \fBEFD_SEMAPHORE\fP が指定されていて eventfd カウンタが 0 以外の値の場合、
  79 \fBread\fP(2) は値 1 の 8 バイト値を返し、カウンタ値は 1 減算される。
  80 .IP *
  81 \fBread\fP(2) を呼び出した時点で eventfd カウンタが 0 の場合、 \fBread\fP(2)
  82 はカウンタが 0 以外になるまで停止 (block) する (0 以外になった時点で
  83 \fBread\fP(2) は上記で述べた通り実行を再開する)、 もしくはファイルディスク
  84 リプタが非停止 (nonblocking) に設定されている場合はエラー \fBEAGAIN\fPで
  85 失敗する。
  86 .RE
  87 .TP
  88 \fBwrite\fP(2)
  89 \fBwrite\fP(2)  は、引き数のバッファで渡された 8 バイトの整数値をカウンタに加算する。 カウンタに格納可能な最大値は unsigned の
  90 64 ビット整数の最大値から 1 を引いた値 (すなわち 0xfffffffffffffffe) である。
  91 加算を行うとカウンタ値が最大値を超過する場合には、 そのファイルディスクリプタに対して \fBread\fP(2)  が実行されるまで、
  92 \fBwrite\fP(2)  は停止 (block) する、 もしくはファイルディスクリプタが非停止 (nonblocking)
  93 に設定されている場合はエラー \fBEAGAIN\fP で失敗する。
  94 .IP
  95 渡されたバッファの大きさが 8 バイト未満の場合、もしくは 値 0xffffffffffffffff を書き込もうとした場合、 \fBwrite\fP(2)
  96 はエラー \fBEINVAL\fP で失敗する。
  97 .TP
  98 \fBpoll\fP(2), \fBselect\fP(2) (と同様の操作)
  99 返されたファイルディスクリプタは、 \fBpoll\fP(2)  (\fBepoll\fP(7)  も同じ) や \fBselect\fP(2)
 100 をサポートしており、以下のような動作をする。
 101 .RS
 102 .IP * 3
 103 カウンタが 0 より大きい値の場合、 ファイルディスクリプタは読み出し可能となる (\fBselect\fP(2)  の \fIreadfds\fP 引き数や
 104 \fBpoll\fP(2)  の \fBPOLLIN\fP フラグ)。
 105 .IP *
 106 少なくとも値 "1" を、停止 (block) を伴わずに書き込める場合、 ファイルディスクリプタは書き込み可能となる (\fBselect\fP(2)  の
 107 \fIwritefds\fP 引き数や \fBpoll\fP(2)  の \fBPOLLOUT\fP フラグ)。
 108 .IP *
 109 カウンタ値のオーバーフローが検出された場合、 \fBselect\fP(2)  はファイルディスクリプタは読み出し可能と書き込み可能の両方を通知し、
 110 \fBpoll\fP(2)  は \fBPOLLERR\fP イベントを返す。 上述の通り、 \fBwrite\fP(2)
 111 でカウンタがオーバーフローすることは決してない。 しかしながら、 KAIO サブシステムによって 2^64 回の eventfd "signal
 112 posts" が 実行された場合にはオーバーフローが起こり得る (理論的にはあり得るが、実用的にはあり得ない)。 オーバーフローが発生した場合、
 113 \fBread\fP(2)  は \fIuint64_t\fP の最大値 (すなわち 0xffffffffffffffff) を返す。
 114 .RE
 115 .IP
 116 eventfd ファイルディスクリプタは、これ以外のファイルディスクリプタ 多重 API である \fBpselect\fP(2) と \fBppoll\fP(2)
 117 もサポートしている。
 118 .TP
 119 \fBclose\fP(2)
 120 ファイルディスクリプタがそれ以降は必要なくなった際には、クローズすべきである。 同じ eventfd
 121 オブジェクトに関連付けられたファイルディスクリプタが全て クローズされると、そのオブジェクト用の資源がカーネルにより解放される。
 122 .PP
 123 \fBfork\fP(2) で生成された子プロセスは、 \fBeventfd\fP() で生成されたファイル
 124 ディスクリプタのコピーを継承する。 複製されたファイルディスクリプタは同
 125 じ eventfd オブジェクトに関連付けられる。
 126 close\-on\-exec フラグが設定されていない場合、 \fBexecve\fP(2) の前後で
 127 \fBeventfd\fP() で生成されたファイルディスクリプタは保持される。
 128 .SH 返り値
 129 成功すると、 \fBeventfd\fP()  は新規の eventfd ファイルディスクリプタを返す。 エラーの場合、\-1 を返し、 \fIerrno\fP
 130 にエラーを示す値を設定する。
 131 .SH エラー
 132 .TP
 133 \fBEINVAL\fP
 134 \fIflags\fP にサポートされていない値が指定された。
 135 .TP
 136 \fBEMFILE\fP
 137 オープン済みのファイルディスクリプタの数がプロセスあたりの上限に 達していた。
 138 .TP
 139 \fBENFILE\fP
 140 オープン済みのファイル総数がシステム全体の上限に達していた。
 141 .TP
 142 \fBENODEV\fP
 143 .\" Note from Davide:
 144 .\" The ENODEV error is basically never going to happen if
 145 .\" the kernel boots correctly. That error happen only if during
 146 .\" the kernel initialization, some error occur in the anonymous
 147 .\" inode source initialization.
 148 (カーネル内の) 無名 inode デバイスをマウントできなかった。
 149 .TP
 150 \fBENOMEM\fP
 151 新しい eventfd ファイルディスクリプタを生成するのに十分なメモリがなかった。
 152 .SH バージョン
 153 .\" eventfd() is in glibc 2.7, but reportedly does not build
 154 \fBeventfd\fP()  はカーネル 2.6.22 以降の Linux で利用可能である。 正しく動作する glibc 側のサポートはバージョン
 155 2.8 以降で提供されている。 \fBeventfd2\fP()  システムコール (「注意」参照) は カーネル 2.6.27 以降の Linux
 156 で利用可能である。 バージョン 2.9 以降では、glibc の \fBeventfd\fP()  のラッパー関数は、カーネルが対応していれば
 157 \fBeventfd2\fP()  システムコールを利用する。
 158 .SH 準拠
 159 \fBeventfd\fP()  と \fBeventfd2\fP()  は Linux 固有である。
 160 .SH 注意
 161 アプリケーションは、パイプをイベントを通知するためだけに使用している 全ての場面において、パイプの代わりに eventfd ファイルディスクリプタを
 162 使用することができる。 eventfd ファイルディスクリプタを使う方が、パイプを使う場合に比べて
 163 カーネルでのオーバヘッドは比べるとずっと小さく、ファイルディスクリプタも 一つしか必要としない (パイプの場合は二つ必要である)。
 164
 165 .\" or eventually syslets/threadlets
 166 カーネル内で使用すると、eventfd ファイルディスクリプタはカーネル空間からユーザ空間へのブリッジ機能を提供することができ、 例えば KAIO
 167 (kernel AIO)  のような機能が、あるファイルディスクリプタに何らかの操作が完了したことを 通知することができる。
 168
 169 eventfd ファイルディスクリプタの重要な点は、 eventfd ファイルディスクリプタが \fBselect\fP(2), \fBpoll\fP(2),
 170 \fBepoll\fP(7)  を使って他のファイルディスクリプタと全く同様に監視できる点である。 このことは、アプリケーションは「従来の
 171 (traditional)」 ファイルの状態変化と eventfd インタフェースをサポートする他のカーネル機構の状態変化を同時に監視
 172 できることを意味する (\fBeventfd\fP()  インタフェースがない時には、これらのカーネル機構は \fBselect\fP(2),
 173 \fBpoll\fP(2), \fBepoll\fP(7)  経由で多重することはできなかった)。
 174 .SS "下層にある Linux のシステムコール"
 175 下層にある Linux システムコールは二種類あり、 \fBeventfd\fP()  と、もっと新しい \fBeventfd2\fP()  である。
 176 \fBeventfd\fP()  は \fIflags\fP 引き数を実装していない。 \fBeventfd2\fP()  では上記の値の \fIflags\fP
 177 が実装されている。 glibc のラッパー関数は、 \fBeventfd2\fP()  が利用可能であれば、これを使用する。
 178 .SS "glibc の追加機能"
 179 GNU C ライブラリは、eventfd ファイルディスクリプタの読み出しと書き込みに
 180 を関する詳細のいくつか抽象化するために、一つの型と、二つの関数を追加で 定義している。
 181 .in +4n
 182 .nf
 183
 184 typedef uint64_t eventfd_t;
 185
 186 int eventfd_read(int fd, eventfd_t *value);
 187 int eventfd_write(int fd, eventfd_t value);
 188 .fi
 189 .in
 190
 191 これらの関数は、eventfd ファイルディスクリプタに対する読み出しと 書き込みの操作を実行し、正しいバイト数が転送された場合には 0
 192 を返し、そうでない場合は \-1 を返す。
 193 .SH 例
 194 .PP
 195 以下のプログラムは eventfd ファイルディスクリプタを生成し、 その後 fork を実行して子プロセスを生成する。 親プロセスが少しの間
 196 sleep する間に、子プロセスは プログラムのコマンドライン引き数で指定された整数(列)をそれぞれ eventfd ファイルディスクリプタに書き込む。
 197 親プロセスは sleep を完了すると eventfd ファイルディスクリプタから 読み出しを行う。
 198
 199 以下に示すシェルセッションにこのプログラムの使い方を示す。
 200 .in +4n
 201 .nf
 202
 203 $\fB ./a.out 1 2 4 7 14\fP
 204 Child writing 1 to efd
 205 Child writing 2 to efd
 206 Child writing 4 to efd
 207 Child writing 7 to efd
 208 Child writing 14 to efd
 209 Child completed write loop
 210 Parent about to read
 211 Parent read 28 (0x1c) from efd
 212 .fi
 213 .in
 214 .SS プログラムのソース
 215 \&
 216 .nf
 217 #include <sys/eventfd.h>
 218 #include <unistd.h>
 219 #include <stdlib.h>
 220 #include <stdio.h>
 221 #include <stdint.h>             /* Definition of uint64_t */
 222
 223 #define handle_error(msg) \e
 224     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 225
 226 int
 227 main(int argc, char *argv[])
 228 {
 229     int efd, j;
 230     uint64_t u;
 231     ssize_t s;
 232
 233     if (argc < 2) {
 234         fprintf(stderr, "Usage: %s <num>...\en", argv[0]);
 235         exit(EXIT_FAILURE);
 236     }
 237
 238     efd = eventfd(0, 0);
 239     if (efd == \-1)
 240         handle_error("eventfd");
 241
 242     switch (fork()) {
 243     case 0:
 244         for (j = 1; j < argc; j++) {
 245             printf("Child writing %s to efd\en", argv[j]);
 246             u = strtoull(argv[j], NULL, 0);
 247                     /* strtoull() allows various bases */
 248             s = write(efd, &u, sizeof(uint64_t));
 249             if (s != sizeof(uint64_t))
 250                 handle_error("write");
 251         }
 252         printf("Child completed write loop\en");
 253
 254         exit(EXIT_SUCCESS);
 255
 256     default:
 257         sleep(2);
 258
 259         printf("Parent about to read\en");
 260         s = read(efd, &u, sizeof(uint64_t));
 261         if (s != sizeof(uint64_t))
 262             handle_error("read");
 263         printf("Parent read %llu (0x%llx) from efd\en",
 264                 (unsigned long long) u, (unsigned long long) u);
 265         exit(EXIT_SUCCESS);
 266
 267     case \-1:
 268         handle_error("fork");
 269     }
 270 }
 271 .fi
 272 .SH 関連項目
 273 \fBfutex\fP(2), \fBpipe\fP(2), \fBpoll\fP(2), \fBread\fP(2), \fBselect\fP(2),
 274 \fBsignalfd\fP(2), \fBtimerfd_create\fP(2), \fBwrite\fP(2), \fBepoll\fP(7),
 275 \fBsem_overview\fP(7)
 276 .SH この文書について
 277 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 278 である。プロジェクトの説明とバグ報告に関する情報は
 279 http://www.kernel.org/doc/man\-pages/ に書かれている。