lib/librt/lio_listio.3

   1 .\" $NetBSD: lio_listio.3,v 1.1 2007/05/04 22:37:36 rmind Exp $
   2 .\"
   3 .\" Copyright (c) 2003 Tim J. Robbins
   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 THE AUTHOR 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 THE AUTHOR 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/lio_listio.2,v 1.6 2006/10/07 05:13:32 trhodes Exp $
  28 .\"
  29 .Dd May 4, 2007
  30 .Dt LIO_LISTIO 3
  31 .Os
  32 .Sh NAME
  33 .Nm lio_listio
  34 .Nd list directed I/O (REALTIME)
  35 .Sh LIBRARY
  36 .Lb librt
  37 .Sh SYNOPSIS
  38 .In aio.h
  39 .Ft int
  40 .Fo lio_listio
  41 .Fa "int mode"
  42 .Fa "struct aiocb * const list[]"
  43 .Fa "int nent"
  44 .Fa "struct sigevent *sig"
  45 .Fc
  46 .Sh DESCRIPTION
  47 The
  48 .Fn lio_listio
  49 function initiates a list of I/O requests with a single function call.
  50 The
  51 .Fa list
  52 argument is an array of pointers to
  53 .Vt aiocb
  54 structures describing each operation to perform,
  55 with
  56 .Fa nent
  57 elements.
  58 .Dv NULL
  59 elements are ignored.
  60 .Pp
  61 The
  62 .Va aio_lio_opcode
  63 field of each
  64 .Vt aiocb
  65 specifies the operation to be performed.
  66 The following operations are supported:
  67 .Bl -tag -width ".Dv LIO_WRITE"
  68 .It Dv LIO_READ
  69 Read data as if by a call to
  70 .Xr aio_read 3 .
  71 .It Dv LIO_NOP
  72 No operation.
  73 .It Dv LIO_WRITE
  74 Write data as if by a call to
  75 .Xr aio_write 3 .
  76 .El
  77 .Pp
  78 If the
  79 .Fa mode
  80 argument is
  81 .Dv LIO_WAIT ,
  82 .Fn lio_listio
  83 does not return until all the requested operations have been completed.
  84 If
  85 .Fa mode
  86 is
  87 .Dv LIO_NOWAIT ,
  88 the requests are processed asynchronously, and the signal specified by
  89 .Fa sig
  90 is sent when all operations have completed.
  91 If
  92 .Fa sig
  93 is
  94 .Dv NULL ,
  95 the calling process is not notified of I/O completion.
  96 .Pp
  97 The order in which the requests are carried out is not specified,
  98 and there is no guarantee that they will be executed sequentially.
  99 .Sh RETURN VALUES
 100 If
 101 .Fa mode
 102 is
 103 .Dv LIO_WAIT ,
 104 the
 105 .Fn lio_listio
 106 function returns 0 if the operations completed successfully,
 107 otherwise \-1.
 108 .Pp
 109 If
 110 .Fa mode
 111 is
 112 .Dv LIO_NOWAIT ,
 113 the
 114 .Fn lio_listio
 115 function returns 0 if the operations are successfully queued,
 116 otherwise \-1.
 117 .Sh ERRORS
 118 The
 119 .Fn lio_listio
 120 function will fail if:
 121 .Bl -tag -width Er
 122 .It Bq Er EAGAIN
 123 There are not enough resources to enqueue the requests.
 124 .It Bq Er EAGAIN
 125 The request would cause the system-wide limit
 126 .Dv AIO_MAX
 127 to be exceeded.
 128 .It Bq Er EINTR
 129 A signal interrupted the system call before it could be completed.
 130 .It Bq Er EINVAL
 131 The
 132 .Fa mode
 133 argument is neither
 134 .Dv LIO_WAIT
 135 nor
 136 .Dv LIO_NOWAIT ,
 137 or
 138 .Fa nent
 139 is greater than
 140 .Dv AIO_LISTIO_MAX .
 141 .It Bq Er EIO
 142 One or more requests failed.
 143 .El
 144 .Pp
 145 In addition, the
 146 .Fn lio_listio
 147 function may fail for any of the reasons listed for
 148 .Xr aio_read 3
 149 and
 150 .Xr aio_write 3 .
 151 .Pp
 152 If
 153 .Fn lio_listio
 154 succeeds, or fails with an error code of
 155 .Er EAGAIN , EINTR ,
 156 or
 157 .Er EIO ,
 158 some of the requests may have been initiated.
 159 The caller should check the error status of each
 160 .Vt aiocb
 161 structure individually by calling
 162 .Xr aio_error 3 .
 163 .Sh SEE ALSO
 164 .Xr read 2 ,
 165 .Xr siginfo 2 ,
 166 .Xr write 2 ,
 167 .Xr aio_error 3 ,
 168 .Xr aio_read 3 ,
 169 .Xr aio_write 3
 170 .Sh STANDARDS
 171 The
 172 .Fn lio_listio
 173 function is expected to conform to
 174 .St -p1003.1-2001 .