書式
#include <linux/aio_abi.h> /* 必要な型の定義 */
#include <linux/time.h> /* 'struct timespec' の定義 */
int io_getevents(aio_context_t ctx_id, long min_nr, long nr,
struct io_event *events, struct timespec *timeout);
注: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
説明
io_getevents() システムコールは、少なくとも min_nr の、最大 nr 個のイベントを、 ctx_id 引き数で指定された AIO (非同期 I/O) コンテキストの 完了キューから読み出そうとする。 timeout はイベント 読み出しの待ち時間の合計を指定する。 タイムアウトに NULL を指定した場合、 少なくとも min_nr 個のイベントが 読み出されるまで待つことを意味する。 注意点を以下にあげる: timeout は相対的な指定である。
返り値
成功すると、 io_getevents() は読み出したイベント数を返す。 イベントが一つも読み出されなかった場合は 0 が返され、 timeout 時間が経過した場合は min_nr 未満の値が返される。 失敗時の返り値については、「注意」の節を参照すること。エラー
- EFAULT
- events または timeout が無効なポインタである。
- EINVAL
- ctx_id が無効である。もしくは、min_nr または nr が 範囲外の値である。
- EINTR
- シグナルハンドラにより割り込まれた。 signal(7) 参照。
- ENOSYS
- io_getevents() がこのアーキテクチャでは実装されていない。
バージョン
非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
準拠
io_getevents() は Linux 固有であり、移植を想定したプログラムで 使用すべきではない。
注意
glibc はこのシステムコールのラッパー関数を提供していない。 syscall(2) を使ってこのシステムコールを起動することができる。 しかし、たいていは、このシステムコールを呼び出したいのではなく、libaio が提供している io_getevents ラッパー関数を呼び出したい 場合がほとんどであろう。
libaio のラッパー関数では ctx_id 引き数に別の型 (io_context_t) が使われることに注意すること。 また、libaio のラッパー関数は、エラーの通知が通常の C ライブラリの 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列 挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。 syscall(2) 経由でシステムコールを起動すると、返り値は通常のエラー通 知の慣習に したがってものとなり、エラーの場合には -1 が返り、 errno にエラーを示す (正の) 値が設定される。
バグ
無効な ctx_id を指定した場合、エラー EINVAL が生成されず、セグメンテーション違反 (segmentation fault) が発生する場合がある。この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.65 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。