mirror of https://github.com/mkerrisk/man-pages
85 lines
2.2 KiB
Groff
85 lines
2.2 KiB
Groff
.\" Copyright (C) 2003 Free Software Foundation, Inc.
|
|
.\" This file is distributed according to the GNU General Public License.
|
|
.\" See the file COPYING in the top level source directory for details.
|
|
.\"
|
|
.\" .de Sh \" Subsection
|
|
.\" .br
|
|
.\" .if t .Sp
|
|
.\" .ne 5
|
|
.\" .PP
|
|
.\" \fB\\$1\fR
|
|
.\" .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_SUBMIT" 2 "2003-02-21" "Linux 2.4" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
io_submit \- submit asynchronous I/O blocks for processing
|
|
.SH "SYNOPSIS"
|
|
.nf
|
|
.\" .ad l
|
|
.\" .hy 0
|
|
.B #include <linux/aio.h>
|
|
.sp
|
|
.\" .HP 16
|
|
.BI "int io_submit(aio_context_t " ctx_id ", long " nr \
|
|
", struct iocb **" iocbpp );
|
|
.\" .ad
|
|
.\" .hy
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBio_submit\fR() queues \fInr\fR I/O request blocks for processing in
|
|
the AIO context \fIctx_id\fR. \fIiocbpp\fR should be an array of
|
|
\fInr\fR AIO request blocks,
|
|
which will be submitted to context \fIctx_id\fR.
|
|
.SH "RETURN VALUE"
|
|
.PP
|
|
On success,
|
|
\fBio_submit\fR() returns the number of \fIiocb\fRs submitted (which may be
|
|
0 if \fInr\fR is zero);
|
|
on failure, it returns one of the errors listed under ERRORS.
|
|
.SH "ERRORS"
|
|
.TP
|
|
.B EINVAL
|
|
The \fIaio_context\fR specified by \fIctx_id\fR is invalid.
|
|
\fInr\fR is less than 0. The \fIiocb\fR at *iocbpp[0] is not properly
|
|
initialized, or the operation specified is invalid for the file descriptor
|
|
in the \fIiocb\fR.
|
|
.TP
|
|
.B EFAULT
|
|
One of the data structures points to invalid data.
|
|
.TP
|
|
.B EBADF
|
|
The file descriptor specified in the first \fIiocb\fR is invalid.
|
|
.TP
|
|
.B EAGAIN
|
|
Insufficient resources are available to queue any \fIiocb\fRs.
|
|
.TP
|
|
.B ENOSYS
|
|
\fBio_submit\fR() is not implemented on this architecture.
|
|
.SH "CONFORMING TO"
|
|
.PP
|
|
\fBio_submit\fR() is Linux specific and should not be used in
|
|
programs that are intended to be portable.
|
|
.SH "VERSIONS"
|
|
.PP
|
|
The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBio_setup\fR(2), \fBio_destroy\fR(2), \fBio_getevents\fR(2),
|
|
\fBio_cancel\fR(2).
|
|
.\" .SH "NOTES"
|
|
.\" .PP
|
|
.\" The asynchronous I/O system calls were written by Benjamin LaHaise.
|
|
.\" .SH AUTHOR
|
|
.\" Kent Yoder.
|