lib/libc/sys/aio_read.2

   1 .\" Copyright (c) 1998 Terry Lambert
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd November 17, 1998
  28 .Dt AIO_READ 2
  29 .Os
  30 .Sh NAME
  31 .Nm aio_read
  32 .Nd asynchronous read from a file (REALTIME)
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In aio.h
  37 .Ft int
  38 .Fn aio_read "struct aiocb *iocb"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn aio_read
  42 system call allows the calling process to read
  43 .Fa iocb->aio_nbytes
  44 from the descriptor
  45 .Fa iocb->aio_fildes
  46 beginning at the offset
  47 .Fa iocb->aio_offset
  48 into the buffer pointed to by
  49 .Fa iocb->aio_buf .
  50 The call returns immediately after the read request has
  51 been enqueued to the descriptor; the read may or may not have
  52 completed at the time the call returns.
  53 .Pp
  54 If _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it,
  55 then the enqueued operation is submitted at a priority equal to that
  56 of the calling process minus
  57 .Fa iocb->aio_reqprio .
  58 .Pp
  59 The
  60 .Fa iocb->aio_lio_opcode
  61 argument
  62 is ignored by the
  63 .Fn aio_read
  64 system call.
  65 .Pp
  66 The
  67 .Fa iocb
  68 pointer may be subsequently used as an argument to
  69 .Fn aio_return
  70 and
  71 .Fn aio_error
  72 in order to determine return or error status for the enqueued operation
  73 while it is in progress.
  74 .Pp
  75 If the request could not be enqueued (generally due to invalid arguments),
  76 then the call returns without having enqueued the request.
  77 .Pp
  78 If the request is successfully enqueued, the value of
  79 .Fa iocb->aio_offset
  80 can be modified during the request as context, so this value must
  81 not be referenced after the request is enqueued.
  82 .Sh RESTRICTIONS
  83 The Asynchronous I/O Control Block structure pointed to by
  84 .Fa iocb
  85 and the buffer that the
  86 .Fa iocb->aio_buf
  87 member of that structure references must remain valid until the
  88 operation has completed.
  89 For this reason, use of auto (stack) variables
  90 for these objects is discouraged.
  91 .Pp
  92 The asynchronous I/O control buffer
  93 .Fa iocb
  94 should be zeroed before the
  95 .Fn aio_read
  96 call to avoid passing bogus context information to the kernel.
  97 .Pp
  98 Modifications of the Asynchronous I/O Control Block structure or the
  99 buffer contents after the request has been enqueued, but before the
 100 request has completed, are not allowed.
 101 .Pp
 102 If the file offset in
 103 .Fa iocb->aio_offset
 104 is past the offset maximum for
 105 .Fa iocb->aio_fildes ,
 106 no I/O will occur.
 107 .Sh RETURN VALUES
 108 .Rv -std aio_read
 109 .Sh DIAGNOSTICS
 110 None.
 111 .Sh ERRORS
 112 The
 113 .Fn aio_read
 114 system call will fail if:
 115 .Bl -tag -width Er
 116 .It Bq Er EAGAIN
 117 The request was not queued because of system resource limitations.
 118 .It Bq Er ENOSYS
 119 The
 120 .Fn aio_read
 121 system call is not supported.
 122 .El
 123 .Pp
 124 The following conditions may be synchronously detected when the
 125 .Fn aio_read
 126 system call is made, or asynchronously, at any time thereafter.
 127 If they
 128 are detected at call time,
 129 .Fn aio_read
 130 returns -1 and sets
 131 .Va errno
 132 appropriately; otherwise the
 133 .Fn aio_return
 134 system call must be called, and will return -1, and
 135 .Fn aio_error
 136 must be called to determine the actual value that would have been
 137 returned in
 138 .Va errno .
 139 .Bl -tag -width Er
 140 .It Bq Er EBADF
 141 The
 142 .Fa iocb->aio_fildes
 143 argument
 144 is invalid.
 145 .It Bq Er EINVAL
 146 The offset
 147 .Fa iocb->aio_offset
 148 is not valid, the priority specified by
 149 .Fa iocb->aio_reqprio
 150 is not a valid priority, or the number of bytes specified by
 151 .Fa iocb->aio_nbytes
 152 is not valid.
 153 .It Bq Er EOVERFLOW
 154 The file is a regular file,
 155 .Fa iocb->aio_nbytes
 156 is greater than zero, the starting offset in
 157 .Fa iocb->aio_offset
 158 is before the end of the file, but is at or beyond the
 159 .Fa iocb->aio_fildes
 160 offset maximum.
 161 .El
 162 .Pp
 163 If the request is successfully enqueued, but subsequently cancelled
 164 or an error occurs, the value returned by the
 165 .Fn aio_return
 166 system call is per the
 167 .Xr read 2
 168 system call, and the value returned by the
 169 .Fn aio_error
 170 system call is either one of the error returns from the
 171 .Xr read 2
 172 system call, or one of:
 173 .Bl -tag -width Er
 174 .It Bq Er EBADF
 175 The
 176 .Fa iocb->aio_fildes
 177 argument
 178 is invalid for reading.
 179 .It Bq Er ECANCELED
 180 The request was explicitly cancelled via a call to
 181 .Fn aio_cancel .
 182 .It Bq Er EINVAL
 183 The offset
 184 .Fa iocb->aio_offset
 185 would be invalid.
 186 .El
 187 .Sh SEE ALSO
 188 .Xr aio_cancel 2 ,
 189 .Xr aio_error 2 ,
 190 .Xr aio_return 2 ,
 191 .Xr aio_suspend 2 ,
 192 .Xr aio_waitcomplete 2 ,
 193 .Xr aio_write 2 ,
 194 .Xr siginfo 3 ,
 195 .Xr aio 4
 196 .Sh STANDARDS
 197 The
 198 .Fn aio_read
 199 system call is expected to conform to the
 200 .St -p1003.1
 201 standard.
 202 .Sh HISTORY
 203 The
 204 .Fn aio_read
 205 system call first appeared in
 206 .Fx 3.0 .
 207 .Sh AUTHORS
 208 This
 209 manual page was written by
 210 .An Terry Lambert Aq terry@whistle.com .
 211 .Sh BUGS
 212 Invalid information in
 213 .Fa iocb->_aiocb_private
 214 may confuse the kernel.