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$
  26 .\"
  27 .Dd July 15, 2016
  28 .Dt AIO_WRITE 2
  29 .Os
  30 .Sh NAME
  31 .Nm aio_write
  32 .Nd asynchronous write to a file (REALTIME)
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In aio.h
  37 .Ft int
  38 .Fn aio_write "struct aiocb *iocb"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn aio_write
  42 system call allows the calling process to write
  43 .Fa iocb->aio_nbytes
  44 from the buffer pointed to by
  45 .Fa iocb->aio_buf
  46 to the descriptor
  47 .Fa iocb->aio_fildes .
  48 The call returns immediately after the write request has been enqueued
  49 to the descriptor; the write may or may not have completed at the time
  50 the call returns.
  51 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.
  62 If
  63 .Dv O_APPEND
  64 is not set for the file descriptor, the write operation will occur at
  65 the absolute position from the beginning of the file plus
  66 .Fa iocb->aio_offset .
  67 .Pp
  68 If
  69 .Dv _POSIX_PRIORITIZED_IO
  70 is defined, and the descriptor supports it, then the enqueued
  71 operation is submitted at a priority equal to that of the calling
  72 process minus
  73 .Fa iocb->aio_reqprio .
  74 .Pp
  75 The
  76 .Fa iocb
  77 pointer may be subsequently used as an argument to
  78 .Fn aio_return
  79 and
  80 .Fn aio_error
  81 in order to determine return or error status for the enqueued operation
  82 while it is in progress.
  83 .Pp
  84 If the request is successfully enqueued, the value of
  85 .Fa iocb->aio_offset
  86 can be modified during the request as context, so this value must not
  87 be referenced after the request is enqueued.
  88 .Pp
  89 The
  90 .Fa iocb->aio_sigevent
  91 structure can be used to request notification of the request's
  92 completion as described in
  93 .Xr aio 4 .
  94 .Sh RESTRICTIONS
  95 The Asynchronous I/O Control Block structure pointed to by
  96 .Fa iocb
  97 and the buffer that the
  98 .Fa iocb->aio_buf
  99 member of that structure references must remain valid until the
 100 operation has completed.
 101 For this reason, use of auto (stack) variables
 102 for these objects is discouraged.
 103 .Pp
 104 The asynchronous I/O control buffer
 105 .Fa iocb
 106 should be zeroed before the
 107 .Fn aio_write
 108 system call to avoid passing bogus context information to the kernel.
 109 .Pp
 110 Modifications of the Asynchronous I/O Control Block structure or the
 111 buffer contents after the request has been enqueued, but before the
 112 request has completed, are not allowed.
 113 .Pp
 114 If the file offset in
 115 .Fa iocb->aio_offset
 116 is past the offset maximum for
 117 .Fa iocb->aio_fildes ,
 118 no I/O will occur.
 119 .Sh RETURN VALUES
 120 .Rv -std aio_write
 121 .Sh ERRORS
 122 The
 123 .Fn aio_write
 124 system call will fail if:
 125 .Bl -tag -width Er
 126 .It Bq Er EAGAIN
 127 The request was not queued because of system resource limitations.
 128 .It Bq Er EINVAL
 129 The asynchronous notification method in
 130 .Fa iocb->aio_sigevent.sigev_notify
 131 is invalid or not supported.
 132 .It Bq Er ENOSYS
 133 The
 134 .Fn aio_write
 135 system call is not supported.
 136 .El
 137 .Pp
 138 The following conditions may be synchronously detected when the
 139 .Fn aio_write
 140 system call is made, or asynchronously, at any time thereafter.
 141 If they
 142 are detected at call time,
 143 .Fn aio_write
 144 returns -1 and sets
 145 .Va errno
 146 appropriately; otherwise the
 147 .Fn aio_return
 148 system call must be called, and will return -1, and
 149 .Fn aio_error
 150 must be called to determine the actual value that would have been
 151 returned in
 152 .Va errno .
 153 .Bl -tag -width Er
 154 .It Bq Er EBADF
 155 The
 156 .Fa iocb->aio_fildes
 157 argument
 158 is invalid, or is not opened for writing.
 159 .It Bq Er EINVAL
 160 The offset
 161 .Fa iocb->aio_offset
 162 is not valid, the priority specified by
 163 .Fa iocb->aio_reqprio
 164 is not a valid priority, or the number of bytes specified by
 165 .Fa iocb->aio_nbytes
 166 is not valid.
 167 .El
 168 .Pp
 169 If the request is successfully enqueued, but subsequently canceled
 170 or an error occurs, the value returned by the
 171 .Fn aio_return
 172 system call is per the
 173 .Xr write 2
 174 system call, and the value returned by the
 175 .Fn aio_error
 176 system call is either one of the error returns from the
 177 .Xr write 2
 178 system call, or one of:
 179 .Bl -tag -width Er
 180 .It Bq Er EBADF
 181 The
 182 .Fa iocb->aio_fildes
 183 argument
 184 is invalid for writing.
 185 .It Bq Er ECANCELED
 186 The request was explicitly canceled via a call to
 187 .Fn aio_cancel .
 188 .It Bq Er EINVAL
 189 The offset
 190 .Fa iocb->aio_offset
 191 would be invalid.
 192 .El
 193 .Sh SEE ALSO
 194 .Xr aio_cancel 2 ,
 195 .Xr aio_error 2 ,
 196 .Xr aio_return 2 ,
 197 .Xr aio_suspend 2 ,
 198 .Xr aio_waitcomplete 2 ,
 199 .Xr sigevent 3 ,
 200 .Xr siginfo 3 ,
 201 .Xr aio 4
 202 .Sh STANDARDS
 203 The
 204 .Fn aio_write
 205 system call
 206 is expected to conform to the
 207 .St -p1003.1
 208 standard.
 209 .Sh HISTORY
 210 The
 211 .Fn aio_write
 212 system call first appeared in
 213 .Fx 3.0 .
 214 .Sh AUTHORS
 215 This manual page was written by
 216 .An Wes Peters Aq wes@softweyr.com .
 217 .Sh BUGS
 218 Invalid information in
 219 .Fa iocb->_aiocb_private
 220 may confuse the kernel.