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