名 前
io_cancel − 未 処 理 の 非 同 期 I/O 操 作 の 取 り 消 し
書 式
#include <linux/aio_abi.h> /* 必 要 な 型 の 定 義 */
int
io_cancel(aio_context_t ctx_id, struct iocb
*iocb,
struct io_event *result); 注
: こ の シ ス テ ム
コ ー ル に は glibc の
ラ ッ パ ー 関 数
は 存 在 し な い
。 「 注 意 」 の
節 を 参 照 。
説 明
io_cancel() シ ス テ ム コ ー ル は 、 過 去 に io_submit(2) を 使 っ て 登 録 さ れ た 非 同 期 I/O (AIO) 操 作 の 取 り 消 し を 行 お う と す る 。 iocb 引 き 数 は 取 り 消 し た い 操 作 が 示 し 、 ctx_id 引 き 数 は 、 取 り 消 し を 行 う 操 作 が 登 録 さ れ た AIO コ ン テ キ ス ト で あ る 。 操 作 の 取 り 消 し に 成 功 す る と 、 対 象 の イ ベ ン ト は result で 指 さ れ た メ モ リ ー に コ ピ ー さ れ る (こ の と き 、 完 了 キ ュ ー へ の 移 動 は 行 わ れ な い )。
返 り 値
成 功 し た 場 合 、 io_cancel() は 0 を 返 す 。 失 敗 時 の 返 り 値 に つ い て は 、 「 注 意 」 の 節 を 参 照 す る こ と 。
エ ラ ー
EAGAIN 指 定 さ れ た |
iocb の 取 り 消 し が 行 わ れ な か っ た 。 |
||
EFAULT デ ー タ 構 造 の |
中 に 無 効 な デ ー タ を 指 し て い る も の が あ る 。
EINVAL |
ctx_id で 指 定 さ れ た AIO コ ン テ キ ス ト が 無 効 で あ る 。 | ||
ENOSYS |
io_cancel() は こ の ア ー キ テ ク チ ャ ー で は 実 装 さ れ て い な い 。 |
バ ー ジ ョ ン
非 同 期 I/O シ ス テ ム コ ー ル は Linux 2.5 で 初 め て 登 場 し た 。
準 拠
io_cancel() は Linux 固 有 で あ り 、 移 植 を 想 定 し た プ ロ グ ラ ム で 使 用 す べ き で は な い 。
注 意
glibc は
こ の シ ス テ ム
コ ー ル の ラ ッ
パ ー 関 数 を 提
供 し て い な い
。 syscall(2) を 使 っ
て こ の シ ス テ
ム コ ー ル を 起
動 す る こ と が
で き る 。 し か
し 、 た い て い
は 、 こ の シ ス
テ ム コ ー ル を
呼 び 出 し た い
の で は な く 、
libaio が 提 供 し て
い る io_cancel ラ ッ
パ ー 関 数 を 呼
び 出 し た い 場
合 が ほ と ん ど
で あ ろ う 。
libaio の ラ ッ パ ー 関 数 で は ctx_id 引 き 数 に 別 の 型 (io_context_t) が 使 わ れ る こ と に 注 意 す る こ と 。 ま た 、 libaio の ラ ッ パ ー 関 数 は 、 エ ラ ー の 通 知 が 通 常 の C ラ イ ブ ラ リ の 慣 習 に し た が っ て お ら ず 、 エ ラ ー の 場 合 に は 負 の エ ラ ー 番 号 (エ ラ ー の 節 に 列 挙 さ れ て い る 値 の 一 つ を 負 に し た も の ) が 返 り 値 と な る 点 に も 注 意 す る こ と 。 syscall(2) 経 由 で シ ス テ ム コ ー ル を 起 動 す る と 、 返 り 値 は 通 常 の エ ラ ー 通 知 の 慣 習 に し た が っ て も の と な り 、 エ ラ ー の 場 合 に は −1 が 返 り 、 errno に エ ラ ー を 示 す (正 の ) 値 が 設 定 さ れ る 。
関 連 項 目
io_destroy(2), io_getevents(2), io_setup(2), io_submit(2), aio(7)
こ の 文 書 に つ い て
こ の man ペ ー ジ は Linux man−pages プ ロ ジ ェ ク ト の リ リ ー ス 3.79 の 一 部 で あ る 。 プ ロ ジ ェ ク ト の 説 明 と バ グ 報 告 に 関 す る 情 報 は http://www.kernel.org/doc/man−pages/ に 書 か れ て い る 。