2004-11-03 13:51:07 +00:00
|
|
|
.\" 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.
|
|
|
|
|
.\"
|
2007-04-03 12:47:21 +00:00
|
|
|
.\" .de Sh \" Subsection
|
|
|
|
|
.\" .br
|
|
|
|
|
.\" .if t .Sp
|
|
|
|
|
.\" .ne 5
|
|
|
|
|
.\" .PP
|
2007-07-18 20:24:30 +00:00
|
|
|
.\" \fB\\$1\fP
|
2007-04-03 12:47:21 +00:00
|
|
|
.\" .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
|
|
|
|
|
.\" ..
|
2007-05-30 05:36:26 +00:00
|
|
|
.TH IO_SETUP 2 2003-02-21 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2007-04-03 12:47:21 +00:00
|
|
|
io_setup \- create an asynchronous I/O context
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SYNOPSIS"
|
2007-04-03 12:47:21 +00:00
|
|
|
.nf
|
|
|
|
|
.\" .ad l
|
|
|
|
|
.\" .hy 0
|
|
|
|
|
.B #include <libaio.h>
|
2006-12-01 04:23:44 +00:00
|
|
|
.\" #include <linux/aio.h>
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-03 12:47:21 +00:00
|
|
|
.\" .HP 15
|
|
|
|
|
.BI "int io_setup(unsigned " nr_events ", aio_context_t *" ctxp );
|
|
|
|
|
.\" .ad
|
|
|
|
|
.\" .hy
|
2007-06-15 05:47:32 +00:00
|
|
|
.sp
|
2007-07-21 05:25:03 +00:00
|
|
|
Link with \fI\-laio\fP.
|
2007-04-03 12:47:21 +00:00
|
|
|
.fi
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "DESCRIPTION"
|
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR io_setup ()
|
|
|
|
|
creates an asynchronous I/O context capable of receiving
|
2007-07-18 20:24:30 +00:00
|
|
|
at least \fInr_events\fP.
|
|
|
|
|
\fIctxp\fP must not point to an AIO context that already exists, and must
|
2007-04-12 22:42:49 +00:00
|
|
|
be initialized to 0 prior to the call.
|
2007-07-18 20:24:30 +00:00
|
|
|
On successful creation of the AIO context, \fI*ctxp\fP is filled in
|
2004-11-03 13:51:07 +00:00
|
|
|
with the resulting handle.
|
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR io_setup ()
|
|
|
|
|
returns 0 on success;
|
2007-04-03 12:47:21 +00:00
|
|
|
on failure, it returns one of the errors listed under ERRORS.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "ERRORS"
|
|
|
|
|
.TP
|
2007-04-03 12:47:21 +00:00
|
|
|
.B EINVAL
|
2007-07-18 20:24:30 +00:00
|
|
|
\fIctxp\fP is not initialized, or the specified \fInr_events\fP
|
|
|
|
|
exceeds internal limits. \fInr_events\fP should be greater than 0.
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
2007-04-03 12:47:21 +00:00
|
|
|
.B EFAULT
|
2007-07-18 20:24:30 +00:00
|
|
|
An invalid pointer is passed for \fIctxp\fP.
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
2007-04-03 12:47:21 +00:00
|
|
|
.B ENOMEM
|
2004-11-03 13:51:07 +00:00
|
|
|
Insufficient kernel resources are available.
|
|
|
|
|
.TP
|
2007-04-03 12:47:21 +00:00
|
|
|
.B EAGAIN
|
2007-07-18 20:24:30 +00:00
|
|
|
The specified \fInr_events\fP exceeds the user's limit of available events.
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
2007-04-03 12:47:21 +00:00
|
|
|
.B ENOSYS
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR io_setup ()
|
|
|
|
|
is not implemented on this architecture.
|
2007-05-18 16:06:42 +00:00
|
|
|
.SH "VERSIONS"
|
|
|
|
|
.PP
|
|
|
|
|
The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR io_setup ()
|
|
|
|
|
is Linux specific and should not be used in programs
|
2004-11-03 13:51:07 +00:00
|
|
|
that are intended to be portable.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR io_destroy (2),
|
|
|
|
|
.BR io_getevents (2),
|
|
|
|
|
.BR io_submit (2),
|
2007-05-22 21:49:38 +00:00
|
|
|
.BR io_cancel (2)
|
2007-04-03 12:47:21 +00:00
|
|
|
.\" .SH "NOTES"
|
|
|
|
|
.\" .PP
|
|
|
|
|
.\" The asynchronous I/O system calls were written by Benjamin LaHaise.
|
|
|
|
|
.\" .SH AUTHOR
|
|
|
|
|
.\" Kent Yoder.
|
