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 July 15, 2016
  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 .Pp
  83 The
  84 .Fa iocb->aio_sigevent
  85 structure can be used to request notification of the request's
  86 completion as described in
  87 .Xr aio 4 .
  88 .Sh RESTRICTIONS
  89 The Asynchronous I/O Control Block structure pointed to by
  90 .Fa iocb
  91 and the buffer that the
  92 .Fa iocb->aio_buf
  93 member of that structure references must remain valid until the
  94 operation has completed.
  95 For this reason, use of auto (stack) variables
  96 for these objects is discouraged.
  97 .Pp
  98 The asynchronous I/O control buffer
  99 .Fa iocb
 100 should be zeroed before the
 101 .Fn aio_read
 102 call to avoid passing bogus context information to the kernel.
 103 .Pp
 104 Modifications of the Asynchronous I/O Control Block structure or the
 105 buffer contents after the request has been enqueued, but before the
 106 request has completed, are not allowed.
 107 .Pp
 108 If the file offset in
 109 .Fa iocb->aio_offset
 110 is past the offset maximum for
 111 .Fa iocb->aio_fildes ,
 112 no I/O will occur.
 113 .Sh RETURN VALUES
 114 .Rv -std aio_read
 115 .Sh DIAGNOSTICS
 116 None.
 117 .Sh ERRORS
 118 The
 119 .Fn aio_read
 120 system call will fail if:
 121 .Bl -tag -width Er
 122 .It Bq Er EAGAIN
 123 The request was not queued because of system resource limitations.
 124 .It Bq Er EINVAL
 125 The asynchronous notification method in
 126 .Fa iocb->aio_sigevent.sigev_notify
 127 is invalid or not supported.
 128 .It Bq Er ENOSYS
 129 The
 130 .Fn aio_read
 131 system call is not supported.
 132 .El
 133 .Pp
 134 The following conditions may be synchronously detected when the
 135 .Fn aio_read
 136 system call is made, or asynchronously, at any time thereafter.
 137 If they
 138 are detected at call time,
 139 .Fn aio_read
 140 returns -1 and sets
 141 .Va errno
 142 appropriately; otherwise the
 143 .Fn aio_return
 144 system call must be called, and will return -1, and
 145 .Fn aio_error
 146 must be called to determine the actual value that would have been
 147 returned in
 148 .Va errno .
 149 .Bl -tag -width Er
 150 .It Bq Er EBADF
 151 The
 152 .Fa iocb->aio_fildes
 153 argument
 154 is invalid.
 155 .It Bq Er EINVAL
 156 The offset
 157 .Fa iocb->aio_offset
 158 is not valid, the priority specified by
 159 .Fa iocb->aio_reqprio
 160 is not a valid priority, or the number of bytes specified by
 161 .Fa iocb->aio_nbytes
 162 is not valid.
 163 .It Bq Er EOVERFLOW
 164 The file is a regular file,
 165 .Fa iocb->aio_nbytes
 166 is greater than zero, the starting offset in
 167 .Fa iocb->aio_offset
 168 is before the end of the file, but is at or beyond the
 169 .Fa iocb->aio_fildes
 170 offset maximum.
 171 .El
 172 .Pp
 173 If the request is successfully enqueued, but subsequently cancelled
 174 or an error occurs, the value returned by the
 175 .Fn aio_return
 176 system call is per the
 177 .Xr read 2
 178 system call, and the value returned by the
 179 .Fn aio_error
 180 system call is either one of the error returns from the
 181 .Xr read 2
 182 system call, or one of:
 183 .Bl -tag -width Er
 184 .It Bq Er EBADF
 185 The
 186 .Fa iocb->aio_fildes
 187 argument
 188 is invalid for reading.
 189 .It Bq Er ECANCELED
 190 The request was explicitly cancelled via a call to
 191 .Fn aio_cancel .
 192 .It Bq Er EINVAL
 193 The offset
 194 .Fa iocb->aio_offset
 195 would be invalid.
 196 .El
 197 .Sh SEE ALSO
 198 .Xr aio_cancel 2 ,
 199 .Xr aio_error 2 ,
 200 .Xr aio_return 2 ,
 201 .Xr aio_suspend 2 ,
 202 .Xr aio_waitcomplete 2 ,
 203 .Xr aio_write 2 ,
 204 .Xr sigevent 3 ,
 205 .Xr siginfo 3 ,
 206 .Xr aio 4
 207 .Sh STANDARDS
 208 The
 209 .Fn aio_read
 210 system call is expected to conform to the
 211 .St -p1003.1
 212 standard.
 213 .Sh HISTORY
 214 The
 215 .Fn aio_read
 216 system call first appeared in
 217 .Fx 3.0 .
 218 .Sh AUTHORS
 219 This
 220 manual page was written by
 221 .An Terry Lambert Aq terry@whistle.com .
 222 .Sh BUGS
 223 Invalid information in
 224 .Fa iocb->_aiocb_private
 225 may confuse the kernel.