release/man2/io_setup.2

   1 .\" Copyright (C) 2003 Free Software Foundation, Inc.
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" This file is distributed according to the GNU General Public License.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\"*******************************************************************
   8 .\"
   9 .\" This file was generated with po4a. Translate the source file.
  10 .\"
  11 .\"*******************************************************************
  12 .TH IO_SETUP 2 2013\-04\-08 Linux "Linux Programmer's Manual"
  13 .SH 名前
  14 io_setup \- 非同期 I/O コンテキストを作成する
  15 .SH 書式
  16 .nf
  17 \fB#include <linux/aio_abi.h>\fP          /* 必要な型の定義 */
  18
  19 \fBint io_setup(unsigned \fP\fInr_events\fP\fB, aio_context_t *\fP\fIctx_idp\fP\fB);\fP
  20 .fi
  21
  22 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
  23 .SH 説明
  24 .PP
  25 \fBio_setup\fP() システムコールは、少なくとも \fInr_events\fP 個のイベントを
  26 同時に実行可能な非同期 I/O (AIO) コンテキストの作成を行う。 \fIctx_idp\fP 引き数
  27 は、すでに存在する AIO コンテキストを指していてはならず、
  28 \fBio_setup\fP() の呼び出しの前に 0 に初期化されていなければならない。
  29 AIO コンテキストの作成に成功すると、 \fI*ctx_idp\fP に作成された AIO
  30 コンテキストへのポインタがセットされる。
  31 .SH 返り値
  32 成功した場合、 \fBio_setup\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
  33 .SH エラー
  34 .TP
  35 \fBEAGAIN\fP
  36 指定された \fInr_events\fP がユーザが使用できるイベント数の上限を越えている。イベント数の上限は
  37 \fI/proc/sys/fs/aio\-max\-nr\fP で定義されている。
  38 .TP
  39 \fBEFAULT\fP
  40 \fIctx_idp\fP に無効なポインタが指定されている。
  41 .TP
  42 \fBEINVAL\fP
  43 \fIctx_idp\fP が初期化されていないか、指定された \fInr_events\fP が内部の
  44 制限値を越えている。また、 \fInr_events\fP は 0 より大きい値に設定
  45 すべきである。
  46 .TP
  47 \fBENOMEM\fP
  48 必要なカーネル・リソースを得られない。
  49 .TP
  50 \fBENOSYS\fP
  51 \fBio_setup\fP()  がこのアーキテクチャでは実装されていない。
  52 .SH バージョン
  53 .PP
  54 非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
  55 .SH 準拠
  56 .PP
  57 \fBio_setup\fP()  は Linux 固有であり、移植を想定したプログラムで 使用すべきではない。
  58 .SH 注意
  59 .\" http://git.fedorahosted.org/git/?p=libaio.git
  60 glibc はこのシステムコールのラッパー関数を提供していない。
  61 \fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
  62 しかし、たいていは、このシステムコールを呼び出したいのではなく、
  63  \fIlibaio\fP が提供している \fBio_setup\fP ラッパー関数を呼び出したい
  64 場合がほとんどであろう。
  65
  66 .\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
  67 .\" the system call.
  68 \fIlibaio\fP のラッパー関数では \fIctx_idp\fP 引き数に別の型
  69 (\fIio_context_t\ *\fP) が使われることに注意すること。
  70 また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
  71 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
  72 挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
  73 \fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー
  74 通知の慣習に したがってものとなり、エラーの場合には \-1 が返り、
  75 \fIerrno\fP にエラーを示す (正の) 値が設定される。
  76 .SH 関連項目
  77 .\" .SH AUTHOR
  78 .\" Kent Yoder.
  79 \fBio_cancel\fP(2), \fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_submit\fP(2),
  80 \fBaio\fP(7)
  81 .SH この文書について
  82 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
  83 である。プロジェクトの説明とバグ報告に関する情報は
  84 http://www.kernel.org/doc/man\-pages/ に書かれている。