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