lib/libcr/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: src/lib/libc/sys/aio_read.2,v 1.6.2.5 2002/12/29 16:35:34 schweikh Exp $
  26 .\" $DragonFly: src/lib/libcr/sys/Attic/aio_read.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  27 .\"
  28 .Dd November 17, 1998
  29 .Dt AIO_READ 2
  30 .Os
  31 .Sh NAME
  32 .Nm aio_read
  33 .Nd asynchronous read from a file (REALTIME)
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In time.h
  38 .In aio.h
  39 .Ft int
  40 .Fn aio_read "struct aiocb *iocb"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn aio_read
  44 function allows the calling process to read
  45 .Fa iocb->aio_nbytes
  46 from the descriptor
  47 .Fa iocb->aio_fildes
  48 beginning at the offset
  49 .Fa iocb->aio_offset
  50 into the buffer pointed to by
  51 .Fa iocb->aio_buf .
  52 The call returns immediately after the read request has
  53 been enqueued to the descriptor; the read may or may not have
  54 completed at the time the call returns.
  55 .Pp
  56 If _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it,
  57 then the enqueued operation is submitted at a priority equal to that
  58 of the calling process minus
  59 .Fa iocb->aio_reqprio .
  60 .Pp
  61 The
  62 .Fa iocb->aio_lio_opcode
  63 is ignored by the
  64 .Fn aio_read
  65 call.
  66 .Pp
  67 The
  68 .Fa iocb
  69 pointer may be subsequently used as an argument to
  70 .Fn aio_return
  71 and
  72 .Fn aio_error
  73 in order to determine return or error status for the enqueued operation
  74 while it is in progress.
  75 .Pp
  76 If the request could not be enqueued (generally due to invalid arguments),
  77 then the call returns without having enqueued the request.
  78 .Pp
  79 If the request is successfully enqueued, the value of
  80 .Fa iocb->aio_offset
  81 can be modified during the request as context, so this value must
  82 not be referenced after the request is enqueued.
  83 .Sh RESTRICTIONS
  84 The Asynchronous I/O Control Block structure pointed to by
  85 .Fa iocb
  86 and the buffer that the
  87 .Fa iocb->aio_buf
  88 member of that structure references must remain valid until the
  89 operation has completed.  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 function 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 call is not supported.
 122 .El
 123 .Pp
 124 The following conditions may be synchronously detected when the
 125 .Fn aio_read
 126 call is made, or asynchronously, at any time thereafter.  If they
 127 are detected at call time,
 128 .Fn aio_read
 129 returns -1 and sets
 130 .Va errno
 131 appropriately; otherwise the
 132 .Fn aio_return
 133 function must be called, and will return -1, and
 134 .Fn aio_error
 135 must be called to determine the actual value that would have been
 136 returned in
 137 .Va errno .
 138 .Pp
 139 .Bl -tag -width Er
 140 .It Bq Er EBADF
 141 .Fa iocb->aio_fildes
 142 is invalid.
 143 .It Bq Er EINVAL
 144 The offset
 145 .Fa iocb->aio_offset
 146 is not valid, the priority specified by
 147 .Fa iocb->aio_reqprio
 148 is not a valid priority, or the number of bytes specified by
 149 .Fa iocb->aio_nbytes
 150 is not valid.
 151 .It Bq Er EOVERFLOW
 152 The file is a regular file,
 153 .Fa iocb->aio_nbytes
 154 is greater than zero, the starting offset in
 155 .Fa iocb->aio_offset
 156 is before the end of the file, but is at or beyond the
 157 .Fa iocb->aio_fildes
 158 offset maximum.
 159 .El
 160 .Pp
 161 If the request is successfully enqueued, but subsequently cancelled
 162 or an error occurs, the value returned by the
 163 .Fn aio_return
 164 function is per the
 165 .Xr read 2
 166 call, and the value returned by the
 167 .Fn aio_error
 168 function is either one of the error returns from the
 169 .Xr read 2
 170 call, or one of:
 171 .Bl -tag -width Er
 172 .It Bq Er EBADF
 173 .Fa iocb->aio_fildes
 174 is invalid for reading.
 175 .It Bq Er ECANCELED
 176 The request was explicitly cancelled via a call to
 177 .Fn aio_cancel .
 178 .It Bq Er EINVAL
 179 The offset
 180 .Fa iocb->aio_offset
 181 would be invalid.
 182 .El
 183 .Sh STANDARDS
 184 The
 185 .Fn aio_read
 186 call is expected to conform to the
 187 .St -p1003.2
 188 standard.
 189 .Sh HISTORY
 190 The
 191 .Nm
 192 function first appeared in
 193 .Fx 3.0 .
 194 .Sh AUTHORS
 195 This
 196 manual page was written by
 197 .An Terry Lambert Aq terry@whistle.com .
 198 .Sh BUGS
 199 The value of
 200 .Fa iocb->aio_offset
 201 is ignored.  Invalid information in
 202 .Fa iocb->_aiocb_private
 203 may confuse the kernel.