lib/librt/aio_read.3

   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 .\"
  27 .Dd November 17, 1998
  28 .Dt AIO_READ 3
  29 .Os
  30 .Sh NAME
  31 .Nm aio_read
  32 .Nd asynchronous read from a file (REALTIME)
  33 .Sh LIBRARY
  34 .Lb librt
  35 .Sh SYNOPSIS
  36 .In time.h
  37 .In aio.h
  38 .Ft int
  39 .Fn aio_read "struct aiocb *iocb"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn aio_read
  43 function allows the calling process to read
  44 .Fa iocb->aio_nbytes
  45 from the descriptor
  46 .Fa iocb->aio_fildes
  47 beginning at the offset
  48 .Fa iocb->aio_offset
  49 into the buffer pointed to by
  50 .Fa iocb->aio_buf .
  51 The call returns immediately after the read request has
  52 been enqueued to the descriptor; the read may or may not have
  53 completed at the time the call returns.
  54 .Pp
  55 If _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it,
  56 then the enqueued operation is submitted at a priority equal to that
  57 of the calling process minus
  58 .Fa iocb->aio_reqprio .
  59 .Pp
  60 The
  61 .Fa iocb->aio_lio_opcode
  62 is ignored by the
  63 .Fn aio_read
  64 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.  For this reason, use of auto (stack) variables
  89 for these objects is discouraged.
  90 .Pp
  91 The asynchronous I/O control buffer
  92 .Fa iocb
  93 should be zeroed before the
  94 .Fn aio_read
  95 call to avoid passing bogus context information to the kernel.
  96 .Pp
  97 Modifications of the Asynchronous I/O Control Block structure or the
  98 buffer contents after the request has been enqueued, but before the
  99 request has completed, are not allowed.
 100 .Pp
 101 If the file offset in
 102 .Fa iocb->aio_offset
 103 is past the offset maximum  for
 104 .Fa iocb->aio_fildes ,
 105 no I/O will occur.
 106 .Sh RETURN VALUES
 107 .Rv -std aio_read
 108 .Sh DIAGNOSTICS
 109 None.
 110 .Sh ERRORS
 111 The
 112 .Fn aio_read
 113 function will fail if:
 114 .Bl -tag -width Er
 115 .It Bq Er EAGAIN
 116 The request was not queued because of system resource limitations.
 117 .It Bq Er ENOSYS
 118 The
 119 .Fn aio_read
 120 call is not supported.
 121 .El
 122 .Pp
 123 The following conditions may be synchronously detected when the
 124 .Fn aio_read
 125 call is made, or asynchronously, at any time thereafter.  If they
 126 are detected at call time,
 127 .Fn aio_read
 128 returns -1 and sets
 129 .Va errno
 130 appropriately; otherwise the
 131 .Fn aio_return
 132 function must be called, and will return -1, and
 133 .Fn aio_error
 134 must be called to determine the actual value that would have been
 135 returned in
 136 .Va errno .
 137 .Bl -tag -width Er
 138 .It Bq Er EBADF
 139 .Fa iocb->aio_fildes
 140 is invalid.
 141 .It Bq Er EINVAL
 142 The offset
 143 .Fa iocb->aio_offset
 144 is not valid, the priority specified by
 145 .Fa iocb->aio_reqprio
 146 is not a valid priority, or the number of bytes specified by
 147 .Fa iocb->aio_nbytes
 148 is not valid.
 149 .It Bq Er EOVERFLOW
 150 The file is a regular file,
 151 .Fa iocb->aio_nbytes
 152 is greater than zero, the starting offset in
 153 .Fa iocb->aio_offset
 154 is before the end of the file, but is at or beyond the
 155 .Fa iocb->aio_fildes
 156 offset maximum.
 157 .El
 158 .Pp
 159 If the request is successfully enqueued, but subsequently cancelled
 160 or an error occurs, the value returned by the
 161 .Fn aio_return
 162 function is per the
 163 .Xr read 2
 164 call, and the value returned by the
 165 .Fn aio_error
 166 function is either one of the error returns from the
 167 .Xr read 2
 168 call, or one of:
 169 .Bl -tag -width Er
 170 .It Bq Er EBADF
 171 .Fa iocb->aio_fildes
 172 is invalid for reading.
 173 .It Bq Er ECANCELED
 174 The request was explicitly cancelled via a call to
 175 .Fn aio_cancel .
 176 .It Bq Er EINVAL
 177 The offset
 178 .Fa iocb->aio_offset
 179 would be invalid.
 180 .El
 181 .Sh STANDARDS
 182 The
 183 .Fn aio_read
 184 call is expected to conform to the
 185 .St -p1003.2
 186 standard.
 187 .Sh HISTORY
 188 The
 189 .Nm
 190 function first appeared in
 191 .Fx 3.0 .
 192 .Sh AUTHORS
 193 This
 194 manual page was written by
 195 .An Terry Lambert Aq terry@whistle.com .
 196 .Sh BUGS
 197 The value of
 198 .Fa iocb->aio_offset
 199 is ignored.  Invalid information in
 200 .Fa iocb->_aiocb_private
 201 may confuse the kernel.