Copyright (c) 2003 Tim J. Robbins
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: /repoman/r/ncvs/src/lib/libc/sys/lio_listio.2,v 1.6 2006/10/07 05:13:32 trhodes Exp $
.Dd August 12, 2011 .Dt LIO_LISTIO 3 .Os .Sh NAME .Nm lio_listio .Nd list directed I/O (REALTIME) .Sh LIBRARY .Lb librt .Sh SYNOPSIS n aio.h .Ft int .Fo lio_listio .Fa "int mode" .Fa "struct aiocb * const list[]" .Fa "int nent" .Fa "struct sigevent *sig" .Fc .Sh DESCRIPTION The .Fn lio_listio function initiates a list of I/O requests with a single function call. The .Fa list argument is an array of pointers to .Vt aiocb structures describing each operation to perform, with .Fa nent elements. .Dv NULL elements are ignored.
p The .Va aio_lio_opcode field of each .Vt aiocb specifies the operation to be performed. The following operations are supported: l -tag -width ".Dv LIO_WRITE" -offset indent t Dv LIO_READ Read data as if by a call to .Xr aio_read 3 . t Dv LIO_NOP No operation. t Dv LIO_WRITE Write data as if by a call to .Xr aio_write 3 . .El
p If the .Fa mode argument is .Dv LIO_WAIT , .Fn lio_listio does not return until all the requested operations have been completed. If .Fa mode is .Dv LIO_NOWAIT , the requests are processed asynchronously, and the signal specified by .Fa sig is sent when all operations have completed. If .Fa sig is .Dv NULL , the calling process is not notified of I/O completion.
p The order in which the requests are carried out is not specified, and there is no guarantee that they will be executed sequentially. .Sh RETURN VALUES If .Fa mode is .Dv LIO_WAIT , the .Fn lio_listio function returns 0 if the operations completed successfully, otherwise -1.
p If .Fa mode is .Dv LIO_NOWAIT , the .Fn lio_listio function returns 0 if the operations are successfully queued, otherwise -1. .Sh ERRORS The .Fn lio_listio function will fail if: l -tag -width Er t Bq Er EAGAIN There are not enough resources to enqueue the requests; or the request would cause the system-wide limit .Dv AIO_MAX to be exceeded. t Bq Er EINTR A signal interrupted the system call before it could be completed. t Bq Er EINVAL The .Fa mode argument is neither .Dv LIO_WAIT nor .Dv LIO_NOWAIT , or .Fa nent is greater than .Dv AIO_LISTIO_MAX . t Bq Er EIO One or more requests failed. .El
p In addition, the .Fn lio_listio function may fail for any of the reasons listed for .Xr aio_read 3 and .Xr aio_write 3 .
p If .Fn lio_listio succeeds, or fails with an error code of .Er EAGAIN , EINTR , or .Er EIO , some of the requests may have been initiated. The caller should check the error status of each .Vt aiocb structure individually by calling .Xr aio_error 3 . .Sh SEE ALSO .Xr read 2 , .Xr siginfo 2 , .Xr write 2 , .Xr aio 3 , .Xr sigevent 3 .Sh STANDARDS The .Fn lio_listio function is expected to conform to .St -p1003.1-2001 .
Indexes created Sun Sep 21 20:09:37 GMT 2025