.\" 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
.\"
-.\" .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_GETEVENTS 2 2008-07-04 "Linux" "Linux Programmer's Manual"
+.TH IO_GETEVENTS 2 2013-04-08 "Linux" "Linux Programmer's Manual"
.SH NAME
io_getevents \- read asynchronous I/O events from the completion queue
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.nf
-.\" .ad l
-.\" .hy 0
-.B #include <linux/time.h>
-.B #include <libaio.h>
-.\" #include <linux/aio.h>
-.sp
-.\" .HP 19
+.BR "#include <linux/aio_abi.h>" " /* Defines needed types */"
+.BR "#include <linux/time.h>" " /* Defines 'struct timespec' */"
+
.BI "int io_getevents(aio_context_t " ctx_id ", long " min_nr ", long " nr ,
.BI " struct io_event *" events \
", struct timespec *" timeout );
-.\" .ad
-.\" .hy
-.sp
-Link with \fI\-laio\fP.
.fi
-.SH "DESCRIPTION"
+
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
+.SH DESCRIPTION
.PP
+The
.BR io_getevents ()
+system call
attempts to read at least \fImin_nr\fP events and
up to \fInr\fP events from the completion queue of the AIO context
specified by \fIctx_id\fP.
-\fItimeout\fP specifies the amount of time to wait for events,
+The \fItimeout\fP argument specifies the amount of time to wait for events,
where a NULL timeout waits until at least \fImin_nr\fP events
have been seen.
-Note that \fItimeout\fP is relative and will be updated if not NULL
-and the operation blocks.
-.SH "RETURN VALUE"
+Note that \fItimeout\fP is relative.
+.SH RETURN VALUE
On success,
.BR io_getevents ()
returns the number of events read: 0 if no events are
available, or less than \fImin_nr\fP if the \fItimeout\fP has elapsed.
For the failure return, see NOTES.
-.SH "ERRORS"
+.SH ERRORS
.TP
.B EFAULT
Either \fIevents\fP or \fItimeout\fP is an invalid pointer.
.B ENOSYS
.BR io_getevents ()
is not implemented on this architecture.
-.SH "VERSIONS"
+.SH VERSIONS
.PP
-The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
-.SH "CONFORMING TO"
+The asynchronous I/O system calls first appeared in Linux 2.5.
+.SH CONFORMING TO
.PP
.BR io_getevents ()
is Linux-specific and should not be used in
programs that are intended to be portable.
.SH NOTES
Glibc does not provide a wrapper function for this system call.
+You could invoke it using
+.BR syscall (2).
+But instead, you probably want to use the
+.BR io_getevents ()
+wrapper function provided by
+.\" http://git.fedorahosted.org/git/?p=libaio.git
+.IR libaio .
-The wrapper provided in
+Note that the
.I libaio
-for
-.BR io_getevents ()
-does not follow the usual C library conventions for indicating error:
+wrapper function uses a different type
+.RI ( io_context_t )
+.\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
+.\" the system call.
+for the
+.I ctx_id
+argument.
+Note also that the
+.I libaio
+wrapper does not follow the usual C library conventions for indicating errors:
on error it returns a negated error number
(the negative of one of the values listed in ERRORS).
If the system call is invoked via
indicating an error: \-1, with
.I errno
set to a (positive) value that indicates the error.
-.SH "SEE ALSO"
+.SH BUGS
+An invalid
+.IR ctx_id
+may cause a segmentation fault instead of generating the error
+.BR EINVAL .
+.SH SEE ALSO
.PP
.BR io_cancel (2),
.BR io_destroy (2),
.BR io_submit (2),
.BR aio (7),
.BR time (7)
-.\" .SH "NOTES"
-.\"
-.\" .PP
-.\" The asynchronous I/O system calls were written by Benjamin LaHaise.
-.\"
.\" .SH AUTHOR
.\" Kent Yoder.
+.SH COLOPHON
+This page is part of release 3.68 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.
OSDN Git Service
