lib/librt/aio_write.3

   1 .\" $NetBSD: aio_write.3,v 1.2 2007/05/05 19:16:01 ad Exp $
   2 .\"
   3 .\" Copyright (c) 1999 Softweyr LLC.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/sys/aio_write.2,v 1.20 2005/12/13 13:43:35 davidxu Exp $
  28 .\"
  29 .Dd May 4, 2007
  30 .Dt AIO_WRITE 3
  31 .Os
  32 .Sh NAME
  33 .Nm aio_write
  34 .Nd asynchronous write to a file (REALTIME)
  35 .Sh LIBRARY
  36 .Lb librt
  37 .Sh SYNOPSIS
  38 .In aio.h
  39 .Ft int
  40 .Fn aio_write "struct aiocb *aiocbp"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn aio_write
  44 system call allows the calling process to write
  45 .Fa aiocbp-\*[Gt]aio_nbytes
  46 from the buffer pointed to by
  47 .Fa aiocbp-\*[Gt]aio_buf
  48 to the descriptor
  49 .Fa aiocbp-\*[Gt]aio_fildes .
  50 The call returns immediately after the write request has been enqueued
  51 to the descriptor; the write may or may not have completed at the time
  52 the call returns.
  53 If the request could not be enqueued, generally due
  54 to invalid arguments, the call returns without having enqueued the
  55 request.
  56 .Pp
  57 If
  58 .Dv O_APPEND
  59 is set for
  60 .Fa aiocbp-\*[Gt]aio_fildes ,
  61 .Fn aio_write
  62 operations append to the file in the same order as the calls were
  63 made.
  64 If
  65 .Dv O_APPEND
  66 is not set for the file descriptor, the write operation will occur at
  67 the absolute position from the beginning of the file plus
  68 .Fa aiocbp-\*[Gt]aio_offset .
  69 .Pp
  70 If
  71 .Dv _POSIX_PRIORITIZED_IO
  72 is defined, and the descriptor supports it, then the enqueued
  73 operation is submitted at a priority equal to that of the calling
  74 process minus
  75 .Fa aiocbp-\*[Gt]aio_reqprio .
  76 .Pp
  77 The
  78 .Fa aiocbp
  79 pointer may be subsequently used as an argument to
  80 .Fn aio_return
  81 and
  82 .Fn aio_error
  83 in order to determine return or error status for the enqueued operation
  84 while it is in progress.
  85 .Pp
  86 If the request is successfully enqueued, the value of
  87 .Fa aiocbp-\*[Gt]aio_offset
  88 can be modified during the request as context, so this value must not
  89 be referenced after the request is enqueued.
  90 .Sh RESTRICTIONS
  91 The Asynchronous I/O Control Block structure pointed to by
  92 .Fa aiocbp
  93 and the buffer that the
  94 .Fa aiocbp-\*[Gt]aio_buf
  95 member of that structure references must remain valid until the
  96 operation has completed.
  97 For this reason, use of auto (stack) variables
  98 for these objects is discouraged.
  99 .Pp
 100 The asynchronous I/O control buffer
 101 .Fa aiocbp
 102 should be zeroed before the
 103 .Fn aio_write
 104 system call to avoid passing bogus context information to the kernel.
 105 .Pp
 106 Modifications of the Asynchronous I/O Control Block structure or the
 107 buffer contents after the request has been enqueued, but before the
 108 request has completed, are not allowed.
 109 .Pp
 110 If the file offset in
 111 .Fa aiocbp-\*[Gt]aio_offset
 112 is past the offset maximum for
 113 .Fa aiocbp-\*[Gt]aio_fildes ,
 114 no I/O will occur.
 115 .Sh RETURN VALUES
 116 .Rv -std aio_write
 117 .Sh ERRORS
 118 The
 119 .Fn aio_write
 120 system call will fail if:
 121 .Bl -tag -width Er
 122 .It Bq Er EAGAIN
 123 The request was not queued because of system resource limitations.
 124 .El
 125 .Pp
 126 The following conditions may be synchronously detected when the
 127 .Fn aio_write
 128 system call is made, or asynchronously, at any time thereafter.
 129 If they
 130 are detected at call time,
 131 .Fn aio_write
 132 returns \-1 and sets
 133 .Va errno
 134 appropriately; otherwise the
 135 .Fn aio_return
 136 system call must be called, and will return \-1, and
 137 .Fn aio_error
 138 must be called to determine the actual value that would have been
 139 returned in
 140 .Va errno .
 141 .Pp
 142 .Bl -tag -width Er
 143 .It Bq Er EBADF
 144 The
 145 .Fa aiocbp-\*[Gt]aio_fildes
 146 argument
 147 is invalid, or is not opened for writing.
 148 .It Bq Er EINVAL
 149 The offset
 150 .Fa aiocbp-\*[Gt]aio_offset
 151 is not valid, the priority specified by
 152 .Fa aiocbp-\*[Gt]aio_reqprio
 153 is not a valid priority, or the number of bytes specified by
 154 .Fa aiocbp-\*[Gt]aio_nbytes
 155 is not valid.
 156 .El
 157 .Pp
 158 If the request is successfully enqueued, but subsequently canceled
 159 or an error occurs, the value returned by the
 160 .Fn aio_return
 161 system call is per the
 162 .Xr write 2
 163 system call, and the value returned by the
 164 .Fn aio_error
 165 system call is either one of the error returns from the
 166 .Xr write 2
 167 system call, or one of:
 168 .Bl -tag -width Er
 169 .It Bq Er EBADF
 170 The
 171 .Fa aiocbp-\*[Gt]aio_fildes
 172 argument
 173 is invalid for writing.
 174 .It Bq Er ECANCELED
 175 The request was explicitly canceled via a call to
 176 .Fn aio_cancel .
 177 .It Bq Er EINVAL
 178 The offset
 179 .Fa aiocbp-\*[Gt]aio_offset
 180 would be invalid.
 181 .El
 182 .Sh SEE ALSO
 183 .Xr siginfo 2 ,
 184 .Xr aio_cancel 3 ,
 185 .Xr aio_error 3 ,
 186 .Xr aio_return 3 ,
 187 .Xr aio_suspend 3
 188 .Sh STANDARDS
 189 The
 190 .Fn aio_write
 191 system call
 192 is expected to conform to the
 193 .St -p1003.1-2001
 194 standard.
 195 .Sh HISTORY
 196 The
 197 .Fn aio_write
 198 system call first appeared in
 199 .Nx 5.0 .