OSDN Git Service

(split) LDP: Update draft and release pages (based on the previous commit)
[linuxjm/LDP_man-pages.git] / release / man2 / io_cancel.2
index 29cd98b..c7d84c1 100644 (file)
 .\" Copyright (C) 2003 Free Software Foundation, Inc.
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
 .\" This file is distributed according to the GNU General Public License.
-.\" See the file COPYING in the top level source directory for details.
+.\" %%%LICENSE_END
 .\"
-.\" Japanese Version Copyright (c) 2003 Akihiro MOTOKI, all rights reserved.
-.\" Translated Mon Mar  8 2003 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
+.\"*******************************************************************
 .\"
-.\"WORD:       operation       Áàºî
-.\"WORD:       completion queue        ´°Î»¥­¥å¡¼
+.\" This file was generated with po4a. Translate the source file.
 .\"
-.\" .de Sh \" Subsection
-.\" .br
-.\" .if t .Sp
-.\" .ne 5
-.\" .PP
-.\" \fB\\$1\fP
-.\" .PP
-.\" ..
-.\" .de Sp \" Vertical space (when we can't use .PP)
-.\" .if t .sp .5v
-.\" .if n .sp
-.\" ..
-.\" .de Ip \" List item
-.\" .br
-.\" .ie \\n(.$>=3 .ne \\$3
-.\" .el .ne 3
-.\" .IP "\\$1" \\$2
-.\" ..
-.TH IO_CANCEL 2 2008-06-18 "Linux" "Linux Programmer's Manual"
-.SH Ì¾Á°
-io_cancel \- Ì¤½èÍý¤ÎÈóƱ´ü I/O Áàºî¤Î¼è¤ê¾Ã¤·
-.SH ½ñ¼°
+.\"*******************************************************************
+.TH IO_CANCEL 2 2012\-07\-13 Linux "Linux Programmer's Manual"
+.SH 名前
+io_cancel \- 未処理の非同期 I/O 操作の取り消し
+.SH 書式
 .nf
-.\" .ad l
-.\" .hy 0
-.\"
-.B #include <libaio.h>
-.\"#include <linux/aio.h>
-.sp
-.\" .HP 16
-.BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
-.BI "              struct io_event *" result );
-.\" .ad
-.\" .hy
-.sp
-\fI\-laio\fP ¤È¥ê¥ó¥¯¤¹¤ë¡£
+\fB#include <linux/aio_abi.h>\fP          /* 必要な型の定義 */
+
+\fBint io_cancel(aio_context_t \fP\fIctx_id\fP\fB, struct iocb *\fP\fIiocb\fP\fB,\fP
+\fB              struct io_event *\fP\fIresult\fP\fB);\fP
 .fi
-.SH ÀâÌÀ
+
+\fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
+.SH 説明
 .PP
-.BR io_cancel ()
-¤Ï¡¢²áµî¤Ë
-.BR io_submit (2)
-¤ò»È¤Ã¤ÆÅÐÏ¿¤µ¤ì¤¿ÈóƱ´ü I/O (AIO) Áàºî¤Î¼è¤ê¾Ã¤·¤ò¹Ô¤ª¤¦¤È¤¹¤ë¡£
-\fIctx_id\fP ¤Ï¡¢¼è¤ê¾Ã¤·¤ò¹Ô¤¦Áàºî¤Î AIO ¥³¥ó¥Æ¥­¥¹¥È¤Î ID ¤Ç¤¢¤ë¡£
-»ØÄꤷ¤¿ AIO ¥³¥ó¥Æ¥­¥¹¥È¤¬¸«¤Ä¤«¤ë¤È¡¢
-ÂоݤΥ¤¥Ù¥ó¥È¤Î¼è¤ê¾Ã¤·¤¬¹Ô¤ï¤ì¡¢¤½¤Î¸å \fIresult\fP ¤Ç»Ø¤µ¤ì¤¿¥á¥â¥ê¤Ë
-¥³¥Ô¡¼¤µ¤ì¤ë (¤³¤Î¤È¤­¡¢´°Î»¥­¥å¡¼¤Ø¤Î°ÜÆ°¤Ï¹Ô¤ï¤ì¤Ê¤¤)¡£
-.SH ÊÖ¤êÃÍ
-À®¸ù¤·¤¿¾ì¹ç¡¢
-.BR io_cancel ()
-¤Ï 0 ¤òÊÖ¤¹¡£
-¼ºÇÔ»þ¤ÎÊÖ¤êÃͤˤĤ¤¤Æ¤Ï¡¢¡ÖÃí°Õ¡×¤ÎÀá¤ò»²¾È¤¹¤ë¤³¤È¡£
-.SH ¥¨¥é¡¼
-.TP
-.B EAGAIN
-»ØÄꤵ¤ì¤¿ \fIiocb\fP ¤Î¼è¤ê¾Ã¤·¤¬¹Ô¤ï¤ì¤Ê¤«¤Ã¤¿¡£
-.TP
-.B EFAULT
-¥Ç¡¼¥¿¹½Â¤¤ÎÃæ¤Ë̵¸ú¤Ê¥Ç¡¼¥¿¤ò»Ø¤·¤Æ¤¤¤ë¤â¤Î¤¬¤¢¤ë¡£
-.TP
-.B EINVAL
-\fIctx_id\fP ¤Ç»ØÄꤵ¤ì¤¿ AIO ¥³¥ó¥Æ¥­¥¹¥È¤¬Ìµ¸ú¤Ç¤¢¤ë¡£
-.TP
-.B ENOSYS
-.BR io_cancel ()
-¤Ï¤³¤Î¥¢¡¼¥­¥Æ¥¯¥Á¥ã¤Ç¤Ï¼ÂÁõ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
-.SH ¥Ð¡¼¥¸¥ç¥ó
+\fBio_cancel\fP() システムコールは、過去に \fBio_submit\fP(2) を使って登録さ
+れた非同期 I/O (AIO) 操作の取り消しを行おうとする。 \fIctx_id\fP 引き数は、
+取り消しを行う操作の AIO コンテキストの ID である。指定した AIO コンテ
+キストが見つかると、対象のイベントの取り消しが行われ、その後 \fIresult\fP
+で指されたメモリに コピーされる (このとき、完了キューへの移動は行われな
+い)。
+.SH 返り値
+成功した場合、 \fBio_cancel\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
+.SH エラー
+.TP 
+\fBEAGAIN\fP
+指定された \fIiocb\fP の取り消しが行われなかった。
+.TP 
+\fBEFAULT\fP
+データ構造の中に無効なデータを指しているものがある。
+.TP 
+\fBEINVAL\fP
+\fIctx_id\fP で指定された AIO コンテキストが無効である。
+.TP 
+\fBENOSYS\fP
+\fBio_cancel\fP()  はこのアーキテクチャでは実装されていない。
+.SH バージョン
 .PP
-ÈóƱ´ü I/O ¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï 2002ǯ8·î¤Ë Linux 2.5 ¤Ç½é¤á¤ÆÅо줷¤¿¡£
-.SH ½àµò
+非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
+.SH 準拠
 .PP
-.BR io_cancel ()
-¤Ï Linux ¸ÇÍ­¤Ç¤¢¤ê¡¢°Ü¿¢¤òÁÛÄꤷ¤¿¥×¥í¥°¥é¥à¤Ç»ÈÍѤ¹¤Ù¤­¤Ç¤Ï¤Ê¤¤¡£
-.SH Ãí°Õ
-glibc ¤Ï¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ëÍѤΥé¥Ã¥Ñ¡¼´Ø¿ô¤òÄ󶡤·¤Æ¤¤¤Ê¤¤¡£
+\fBio_cancel\fP()  は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
+.SH 注意
+.\" http://git.fedorahosted.org/git/?p=libaio.git
+glibc はこのシステムコールのラッパー関数を提供していない。
+\fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
+しかし、たいていは、このシステムコールを呼び出したいのではなく、
+ \fIlibaio\fP が提供している \fBio_cancel\fP ラッパー関数を呼び出したい
+場合がほとんどであろう。
 
-.I libaio
-¤Ç
-.BR io_cancel ()
-ÍѤËÄ󶡤µ¤ì¤Æ¤¤¤ë¥é¥Ã¥Ñ¡¼´Ø¿ô¤Ï¡¢¥¨¥é¡¼¤ÎÄÌÃΤ¬Ä̾ï¤Î C ¥é¥¤¥Ö¥é¥ê¤Î
-´·½¬¤Ë¤·¤¿¤¬¤Ã¤Æ¤ª¤é¤º¡¢¥¨¥é¡¼¤Î¾ì¹ç¤Ë¤ÏÉé¤Î¥¨¥é¡¼ÈÖ¹æ
-(¥¨¥é¡¼¤ÎÀá¤ËÎóµó¤µ¤ì¤Æ¤¤¤ëÃͤΰì¤Ä¤òÉé¤Ë¤·¤¿¤â¤Î) ¤¬ÊÖ¤êÃͤȤʤ롣
-.BR syscall (2)
-·Ðͳ¤Ç¥·¥¹¥Æ¥à¥³¡¼¥ë¤òµ¯Æ°¤¹¤ë¤È¡¢ÊÖ¤êÃͤÏÄ̾ï¤Î¥¨¥é¡¼ÄÌÃΤδ·½¬¤Ë
-¤·¤¿¤¬¤Ã¤Æ¤â¤Î¤È¤Ê¤ê¡¢¥¨¥é¡¼¤Î¾ì¹ç¤Ë¤Ï \-1 ¤¬Ê֤ꡢ
-.I errno
-¤Ë¥¨¥é¡¼¤ò¼¨¤¹ (Àµ¤Î) Ãͤ¬ÀßÄꤵ¤ì¤ë¡£
-.SH ´ØÏ¢¹àÌÜ
-.BR io_destroy (2),
-.BR io_getevents (2),
-.BR io_setup (2),
-.BR io_submit (2)
-.\" .SH Ãí
-.\" .PP
-.\" ÈóƱ´ü I/O ¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï Benjamin LaHaise ¤¬½ñ¤¤¤¿¡£
-.\" .SH Ãø¼Ô
+.\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
+.\" the system call.
+\fIlibaio\fP のラッパー関数では \fIctx_id\fP 引き数に別の型
+(\fIio_context_t\fP) が使われることに注意すること。
+また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
+慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
+挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
+\fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー通
+知の慣習に したがってものとなり、エラーの場合には \-1 が返り、 \fIerrno\fP
+にエラーを示す (正の) 値が設定される。
+.SH 関連項目
+.\" .SH AUTHOR
 .\" Kent Yoder.
+\fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
+\fBaio\fP(7)
+.SH この文書について
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
+である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man\-pages/ に書かれている。