lib/libc/sys/aio_write.2

   1 .\" Copyright (c) 1999 Softweyr LLC.
   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 Softweyr LLC 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 Softweyr LLC 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_write.2,v 1.4.2.5 2001/12/14 18:34:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc/sys/aio_write.2,v 1.3 2008/05/02 02:05:04 swildner Exp $
  27 .\"
  28 .Dd June 2, 1999
  29 .Dt AIO_WRITE 2
  30 .Os
  31 .Sh NAME
  32 .Nm aio_write
  33 .Nd asynchronous write to a file (REALTIME)
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In aio.h
  38 .Ft int
  39 .Fn aio_write "struct aiocb *iocb"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn aio_write
  43 function allows the calling process to write
  44 .Fa iocb->aio_nbytes
  45 from the buffer pointed to by
  46 .Fa iocb->aio_buf
  47 to the descriptor
  48 .Fa iocb->aio_fildes .
  49 The call returns immediately after the write request has been enqueued
  50 to the descriptor; the write may or may not have completed at the time
  51 the call returns.  If the request could not be enqueued, generally due
  52 to invalid arguments, the call returns without having enqueued the
  53 request.
  54 .Pp
  55 If
  56 .Dv O_APPEND
  57 is set for
  58 .Fa iocb->aio_fildes ,
  59 .Fn aio_write
  60 operations append to the file in the same order as the calls were
  61 made.  If
  62 .Dv O_APPEND
  63 is not set for the file descriptor, the write operation will occur at
  64 the absolute position from the beginning of the file plus
  65 .Fa iocb->aio_offset .
  66 .Pp
  67 If
  68 .Dv _POSIX_PRIORITIZED_IO
  69 is defined, and the descriptor supports it, then the enqueued
  70 operation is submitted at a priority equal to that of the calling
  71 process minus
  72 .Fa iocb->aio_reqprio .
  73 .Pp
  74 The
  75 .Fa iocb
  76 pointer may be subsequently used as an argument to
  77 .Fn aio_return
  78 and
  79 .Fn aio_error
  80 in order to determine return or error status for the enqueued operation
  81 while it is in progress.
  82 .Pp
  83 If the request is successfully enqueued, the value of
  84 .Fa iocb->aio_offset
  85 can be modified during the request as context, so this value must not
  86 be referenced after the request is enqueued.
  87 .Sh RESTRICTIONS
  88 The Asynchronous I/O Control Block structure pointed to by
  89 .Fa iocb
  90 and the buffer that the
  91 .Fa iocb->aio_buf
  92 member of that structure references must remain valid until the
  93 operation has completed.  For this reason, use of auto (stack) variables
  94 for these objects is discouraged.
  95 .Pp
  96 The asynchronous I/O control buffer
  97 .Fa iocb
  98 should be zeroed before the
  99 .Fn aio_write
 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 after the request has been enqueued, but before the
 104 request has completed, are not allowed.
 105 .Pp
 106 If the file offset in
 107 .Fa iocb->aio_offset
 108 is past the offset maximum  for
 109 .Fa iocb->aio_fildes ,
 110 no I/O will occur.
 111 .Sh RETURN VALUES
 112 .Rv -std aio_write
 113 .Sh ERRORS
 114 The
 115 .Fn aio_write
 116 function will fail if:
 117 .Bl -tag -width Er
 118 .It Bq Er EAGAIN
 119 The request was not queued because of system resource limitations.
 120 .It Bq Er ENOSYS
 121 The
 122 .Fn aio_write
 123 call is not supported.
 124 .El
 125 .Pp
 126 The following conditions may be synchronously detected when the
 127 .Fn aio_write
 128 call is made, or asynchronously, at any time thereafter.  If they
 129 are detected at call time,
 130 .Fn aio_write
 131 returns -1 and sets
 132 .Va errno
 133 appropriately; otherwise the
 134 .Fn aio_return
 135 function must be called, and will return -1, and
 136 .Fn aio_error
 137 must be called to determine the actual value that would have been
 138 returned in
 139 .Va errno .
 140 .Bl -tag -width Er
 141 .It Bq Er EBADF
 142 .Fa iocb->aio_fildes
 143 is invalid, or is not opened for writing.
 144 .It Bq Er EINVAL
 145 The offset
 146 .Fa iocb->aio_offset
 147 is not valid, the priority specified by
 148 .Fa iocb->aio_reqprio
 149 is not a valid priority, or the number of bytes specified by
 150 .Fa iocb->aio_nbytes
 151 is not valid.
 152 .El
 153 .Pp
 154 If the request is successfully enqueued, but subsequently canceled
 155 or an error occurs, the value returned by the
 156 .Fn aio_return
 157 function is per the
 158 .Xr write 2
 159 call, and the value returned by the
 160 .Fn aio_error
 161 function is either one of the error returns from the
 162 .Xr write 2
 163 call, or one of:
 164 .Bl -tag -width Er
 165 .It Bq Er EBADF
 166 .Fa iocb->aio_fildes
 167 is invalid for writing.
 168 .It Bq Er ECANCELED
 169 The request was explicitly canceled via a call to
 170 .Fn aio_cancel .
 171 .It Bq Er EINVAL
 172 The offset
 173 .Fa iocb->aio_offset
 174 would be invalid.
 175 .El
 176 .Sh STANDARDS
 177 .Fn aio_write
 178 is expected to conform to the
 179 .St -p1003.2
 180 standard.
 181 .Sh HISTORY
 182 The
 183 .Nm
 184 Function first appeared in
 185 .Fx 3.0 .
 186 .Sh AUTHORS
 187 This manual page was written by
 188 .An Wes Peters Aq wes@softweyr.com .
 189 .Sh BUGS
 190 Asynchronous I/O operations cannot be canceled in this implementation.
 191 Invalid information in
 192 .Fa iocb->_aiocb_private
 193 may confuse the kernel.