diff --git a/lib/libc/sys/aio_cancel.2 b/lib/libc/sys/aio_cancel.2 index c9c5b04ddd61..08102cf9d861 100644 --- a/lib/libc/sys/aio_cancel.2 +++ b/lib/libc/sys/aio_cancel.2 @@ -1,117 +1,117 @@ .\" Copyright (c) 1999 Softweyr LLC. .\" 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 Softweyr LLC 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 Softweyr LLC 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$ .\" .Dd January 19, 2000 .Dt AIO_CANCEL 2 .Os .Sh NAME .Nm aio_cancel .Nd cancel an outstanding asynchronous I/O operation (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fn aio_cancel "int fildes" "struct aiocb * iocb" .Sh DESCRIPTION The .Fn aio_cancel system call cancels the outstanding asynchronous I/O request for the file descriptor specified in .Fa fildes . If .Fa iocb is specified, only that specific asynchronous I/O request is cancelled. .Pp Normal asynchronous notification occurs for cancelled requests. Requests complete with an error result of .Er ECANCELED . .Sh RESTRICTIONS The .Fn aio_cancel system call does not cancel asynchronous I/O requests for raw disk devices. The .Fn aio_cancel system call will always return .Dv AIO_NOTCANCELED for file descriptors associated with raw disk devices. .Sh RETURN VALUES The .Fn aio_cancel system call returns -1 to indicate an error, or one of the following: .Bl -tag -width Dv .It Bq Dv AIO_CANCELED All outstanding requests meeting the criteria specified were cancelled. .It Bq Dv AIO_NOTCANCELED Some requests were not cancelled, status for the requests should be checked with .Xr aio_error 2 . .It Bq Dv AIO_ALLDONE All of the requests meeting the criteria have finished. .El .Sh ERRORS An error return from .Fn aio_cancel indicates: .Bl -tag -width Er .It Bq Er EBADF The .Fa fildes argument is an invalid file descriptor. .El .Sh SEE ALSO .Xr aio_error 2 , .Xr aio_read 2 , .Xr aio_return 2 , .Xr aio_suspend 2 , .Xr aio_write 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_cancel system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_cancel system call first appeared in .Fx 3.0 . The first functional implementation of .Fn aio_cancel appeared in .Fx 4.0 . .Sh AUTHORS .An -nosplit This manual page was originally written by .An Wes Peters Aq wes@softweyr.com . .An Christopher M Sedore Aq cmsedore@maxwell.syr.edu updated it when .Fn aio_cancel was implemented for .Fx 4.0 . diff --git a/lib/libc/sys/aio_error.2 b/lib/libc/sys/aio_error.2 index 0d1e1defebc3..02b0caab5b40 100644 --- a/lib/libc/sys/aio_error.2 +++ b/lib/libc/sys/aio_error.2 @@ -1,100 +1,100 @@ .\" Copyright (c) 1999 Softweyr LLC. .\" 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 Softweyr LLC 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 Softweyr LLC 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$ .\" .Dd June 2, 1999 .Dt AIO_ERROR 2 .Os .Sh NAME .Nm aio_error .Nd retrieve error status of asynchronous I/O operation (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fn aio_error "const struct aiocb *iocb" .Sh DESCRIPTION The .Fn aio_error system call returns the error status of the asynchronous I/O request associated with the structure pointed to by .Fa iocb . .Sh RETURN VALUES If the asynchronous I/O request has completed successfully, .Fn aio_error returns 0. If the request has not yet completed, .Er EINPROGRESS is returned. If the request has completed unsuccessfully the error status is returned as described in .Xr read 2 , .Xr write 2 , or .Xr fsync 2 is returned. On failure, .Fn aio_error returns .Dv -1 and sets .Dv errno to indicate the error condition. .Sh ERRORS The .Fn aio_error system call will fail if: .Bl -tag -width Er .It Bq Er EINVAL The .Fa iocb argument does not reference an outstanding asynchronous I/O request. .El .Sh SEE ALSO .Xr aio_cancel 2 , .Xr aio_read 2 , .Xr aio_return 2 , .Xr aio_suspend 2 , .Xr aio_write 2 , .Xr fsync 2 , .Xr read 2 , .Xr write 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_error system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_error system call first appeared in .Fx 3.0 . .Sh AUTHORS This manual page was written by .An Wes Peters Aq wes@softweyr.com . diff --git a/lib/libc/sys/aio_read.2 b/lib/libc/sys/aio_read.2 index 749044a7f03e..01b2af97bc95 100644 --- a/lib/libc/sys/aio_read.2 +++ b/lib/libc/sys/aio_read.2 @@ -1,213 +1,213 @@ .\" Copyright (c) 1998 Terry Lambert .\" 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$ .\" .Dd November 17, 1998 .Dt AIO_READ 2 .Os .Sh NAME .Nm aio_read .Nd asynchronous read from a file (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In time.h .In aio.h .Ft int .Fn aio_read "struct aiocb *iocb" .Sh DESCRIPTION The .Fn aio_read system call allows the calling process to read .Fa iocb->aio_nbytes from the descriptor .Fa iocb->aio_fildes beginning at the offset .Fa iocb->aio_offset into the buffer pointed to by .Fa iocb->aio_buf . The call returns immediately after the read request has been enqueued to the descriptor; the read may or may not have completed at the time the call returns. .Pp If _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it, then the enqueued operation is submitted at a priority equal to that of the calling process minus .Fa iocb->aio_reqprio . .Pp The .Fa iocb->aio_lio_opcode argument is ignored by the .Fn aio_read system call. .Pp The .Fa iocb pointer may be subsequently used as an argument to .Fn aio_return and .Fn aio_error in order to determine return or error status for the enqueued operation while it is in progress. .Pp If the request could not be enqueued (generally due to invalid arguments), then the call returns without having enqueued the request. .Pp If the request is successfully enqueued, the value of .Fa iocb->aio_offset can be modified during the request as context, so this value must not be referenced after the request is enqueued. .Sh RESTRICTIONS The Asynchronous I/O Control Block structure pointed to by .Fa iocb and the buffer that the .Fa iocb->aio_buf member of that structure references must remain valid until the operation has completed. For this reason, use of auto (stack) variables for these objects is discouraged. .Pp The asynchronous I/O control buffer .Fa iocb should be zeroed before the .Fn aio_read call to avoid passing bogus context information to the kernel. .Pp Modifications of the Asynchronous I/O Control Block structure or the buffer contents after the request has been enqueued, but before the request has completed, are not allowed. .Pp If the file offset in .Fa iocb->aio_offset is past the offset maximum for .Fa iocb->aio_fildes , no I/O will occur. .Sh RETURN VALUES .Rv -std aio_read .Sh DIAGNOSTICS None. .Sh ERRORS The .Fn aio_read system call will fail if: .Bl -tag -width Er .It Bq Er EAGAIN The request was not queued because of system resource limitations. .It Bq Er ENOSYS The .Fn aio_read system call is not supported. .El .Pp The following conditions may be synchronously detected when the .Fn aio_read system call is made, or asynchronously, at any time thereafter. If they are detected at call time, .Fn aio_read returns -1 and sets .Va errno appropriately; otherwise the .Fn aio_return system call must be called, and will return -1, and .Fn aio_error must be called to determine the actual value that would have been returned in .Va errno . .Pp .Bl -tag -width Er .It Bq Er EBADF The .Fa iocb->aio_fildes argument is invalid. .It Bq Er EINVAL The offset .Fa iocb->aio_offset is not valid, the priority specified by .Fa iocb->aio_reqprio is not a valid priority, or the number of bytes specified by .Fa iocb->aio_nbytes is not valid. .It Bq Er EOVERFLOW The file is a regular file, .Fa iocb->aio_nbytes is greater than zero, the starting offset in .Fa iocb->aio_offset is before the end of the file, but is at or beyond the .Fa iocb->aio_fildes offset maximum. .El .Pp If the request is successfully enqueued, but subsequently cancelled or an error occurs, the value returned by the .Fn aio_return system call is per the .Xr read 2 system call, and the value returned by the .Fn aio_error system call is either one of the error returns from the .Xr read 2 system call, or one of: .Bl -tag -width Er .It Bq Er EBADF The .Fa iocb->aio_fildes argument is invalid for reading. .It Bq Er ECANCELED The request was explicitly cancelled via a call to .Fn aio_cancel . .It Bq Er EINVAL The offset .Fa iocb->aio_offset would be invalid. .El .Sh SEE ALSO .Xr aio_cancel 2 , .Xr aio_error 2 , .Xr aio_return 2 , .Xr aio_suspend 2 , .Xr aio_waitcomplete 2 , .Xr aio_write 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_read system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_read system call first appeared in .Fx 3.0 . .Sh AUTHORS This manual page was written by .An Terry Lambert Aq terry@whistle.com . .Sh BUGS Invalid information in .Fa iocb->_aiocb_private may confuse the kernel. diff --git a/lib/libc/sys/aio_return.2 b/lib/libc/sys/aio_return.2 index 07bc0ae75399..4d7282f8623b 100644 --- a/lib/libc/sys/aio_return.2 +++ b/lib/libc/sys/aio_return.2 @@ -1,104 +1,104 @@ .\" Copyright (c) 1999 Softweyr LLC. .\" 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 Softweyr LLC 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 Softweyr LLC 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$ .\" .Dd June 2, 1999 .Dt AIO_RETURN 2 .Os .Sh NAME .Nm aio_return .Nd retrieve return status of asynchronous I/O operation (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fn aio_return "struct aiocb *iocb" .Sh DESCRIPTION The .Fn aio_return system call returns the final status of the asynchronous I/O request associated with the structure pointed to by .Fa iocb . .Pp The .Fn aio_return system call should only be called once, to obtain the final status of an asynchronous I/O operation once .Xr aio_error 2 returns something other than .Er EINPROGRESS . .Sh RETURN VALUES If the asynchronous I/O request has completed, the status is returned as described in .Xr read 2 , .Xr write 2 , or .Xr fsync 2 . On failure, .Fn aio_return returns .Dv -1 and sets .Dv errno to indicate the error condition. .Sh ERRORS The .Fn aio_return system call will fail if: .Bl -tag -width Er .It Bq Er EINVAL The .Fa iocb argument does not reference an outstanding asynchronous I/O request. .El .Sh SEE ALSO .Xr aio_cancel 2 , .Xr aio_error 2 , .Xr aio_suspend 2 , .Xr aio_waitcomplete 2 , .Xr aio_write 2 , .Xr fsync 2 , .Xr read 2 , .Xr write 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_return system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_return system call first appeared in .Fx 3.0 . .Sh AUTHORS This manual page was written by .An Wes Peters Aq wes@softweyr.com . diff --git a/lib/libc/sys/aio_suspend.2 b/lib/libc/sys/aio_suspend.2 index d8e74a95e14b..ec5e5db11c58 100644 --- a/lib/libc/sys/aio_suspend.2 +++ b/lib/libc/sys/aio_suspend.2 @@ -1,114 +1,114 @@ .\" Copyright (c) 1999 Softweyr LLC. .\" 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 Softweyr LLC 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 Softweyr LLC 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$ .\" .Dd June 2, 1999 .Dt AIO_SUSPEND 2 .Os .Sh NAME .Nm aio_suspend .Nd suspend until asynchronous I/O operations or timeout complete (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fn aio_suspend "const struct aiocb * const iocbs[]" "int niocb" "const struct timespec * timeout" .Sh DESCRIPTION The .Fn aio_suspend system call suspends the calling process until at least one of the specified asynchronous I/O requests have completed, a signal is delivered, or the .Fa timeout has passed. .Pp The .Fa iocbs argument is an array of .Fa niocb pointers to asynchronous I/O requests. Array members containing NULL will be silently ignored. .Pp If .Fa timeout is a non-nil pointer, it specifies a maximum interval to suspend. If .Fa timeout is a nil pointer, the suspend blocks indefinitely. To effect a poll, the .Fa timeout should point to a zero-value timespec structure. .Sh RETURN VALUES If one or more of the specified asynchronous I/O requests have completed, .Fn aio_suspend returns 0. Otherwise it returns -1 and sets .Va errno to indicate the error, as enumerated below. .Sh ERRORS The .Fn aio_suspend system call will fail if: .Bl -tag -width Er .It Bq Er EAGAIN the .Fa timeout expired before any I/O requests completed. .It Bq Er EINVAL The .Fa iocbs argument contains more than .Dv AIO_LISTIO_MAX asynchronous I/O requests, or at least one of the requests is not valid. .It Bq Er EINTR the suspend was interrupted by a signal. .El .Sh SEE ALSO .Xr aio_cancel 2 , .Xr aio_error 2 , .Xr aio_return 2 , .Xr aio_waitcomplete 2 , .Xr aio_write 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_suspend system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_suspend system call first appeared in .Fx 3.0 . .Sh AUTHORS This manual page was written by .An Wes Peters Aq wes@softweyr.com . diff --git a/lib/libc/sys/aio_write.2 b/lib/libc/sys/aio_write.2 index 7148c7fd0303..e417f828b3db 100644 --- a/lib/libc/sys/aio_write.2 +++ b/lib/libc/sys/aio_write.2 @@ -1,205 +1,205 @@ .\" Copyright (c) 1999 Softweyr LLC. .\" 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 Softweyr LLC 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 Softweyr LLC 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$ .\" .Dd June 2, 1999 .Dt AIO_WRITE 2 .Os .Sh NAME .Nm aio_write .Nd asynchronous write to a file (REALTIME) .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fn aio_write "struct aiocb *iocb" .Sh DESCRIPTION The .Fn aio_write system call allows the calling process to write .Fa iocb->aio_nbytes from the buffer pointed to by .Fa iocb->aio_buf to the descriptor .Fa iocb->aio_fildes . The call returns immediately after the write request has been enqueued to the descriptor; the write may or may not have completed at the time the call returns. If the request could not be enqueued, generally due to invalid arguments, the call returns without having enqueued the request. .Pp If .Dv O_APPEND is set for .Fa iocb->aio_fildes , .Fn aio_write operations append to the file in the same order as the calls were made. If .Dv O_APPEND is not set for the file descriptor, the write operation will occur at the absolute position from the beginning of the file plus .Fa iocb->aio_offset . .Pp If .Dv _POSIX_PRIORITIZED_IO is defined, and the descriptor supports it, then the enqueued operation is submitted at a priority equal to that of the calling process minus .Fa iocb->aio_reqprio . .Pp The .Fa iocb pointer may be subsequently used as an argument to .Fn aio_return and .Fn aio_error in order to determine return or error status for the enqueued operation while it is in progress. .Pp If the request is successfully enqueued, the value of .Fa iocb->aio_offset can be modified during the request as context, so this value must not be referenced after the request is enqueued. .Sh RESTRICTIONS The Asynchronous I/O Control Block structure pointed to by .Fa iocb and the buffer that the .Fa iocb->aio_buf member of that structure references must remain valid until the operation has completed. For this reason, use of auto (stack) variables for these objects is discouraged. .Pp The asynchronous I/O control buffer .Fa iocb should be zeroed before the .Fn aio_write system call to avoid passing bogus context information to the kernel. .Pp Modifications of the Asynchronous I/O Control Block structure or the buffer contents after the request has been enqueued, but before the request has completed, are not allowed. .Pp If the file offset in .Fa iocb->aio_offset is past the offset maximum for .Fa iocb->aio_fildes , no I/O will occur. .Sh RETURN VALUES .Rv -std aio_write .Sh ERRORS The .Fn aio_write system call will fail if: .Bl -tag -width Er .It Bq Er EAGAIN The request was not queued because of system resource limitations. .It Bq Er ENOSYS The .Fn aio_write system call is not supported. .El .Pp The following conditions may be synchronously detected when the .Fn aio_write system call is made, or asynchronously, at any time thereafter. If they are detected at call time, .Fn aio_write returns -1 and sets .Va errno appropriately; otherwise the .Fn aio_return system call must be called, and will return -1, and .Fn aio_error must be called to determine the actual value that would have been returned in .Va errno . .Pp .Bl -tag -width Er .It Bq Er EBADF The .Fa iocb->aio_fildes argument is invalid, or is not opened for writing. .It Bq Er EINVAL The offset .Fa iocb->aio_offset is not valid, the priority specified by .Fa iocb->aio_reqprio is not a valid priority, or the number of bytes specified by .Fa iocb->aio_nbytes is not valid. .El .Pp If the request is successfully enqueued, but subsequently canceled or an error occurs, the value returned by the .Fn aio_return system call is per the .Xr write 2 system call, and the value returned by the .Fn aio_error system call is either one of the error returns from the .Xr write 2 system call, or one of: .Bl -tag -width Er .It Bq Er EBADF The .Fa iocb->aio_fildes argument is invalid for writing. .It Bq Er ECANCELED The request was explicitly canceled via a call to .Fn aio_cancel . .It Bq Er EINVAL The offset .Fa iocb->aio_offset would be invalid. .El .Sh SEE ALSO .Xr aio_cancel 2 , .Xr aio_error 2 , .Xr aio_return 2 , .Xr aio_suspend 2 , .Xr aio_waitcomplete 2 , .Xr aio 4 .Sh STANDARDS The .Fn aio_write system call is expected to conform to the -.St -p1003.2 +.St -p1003.1 standard. .Sh HISTORY The .Fn aio_write system call first appeared in .Fx 3.0 . .Sh AUTHORS This manual page was written by .An Wes Peters Aq wes@softweyr.com . .Sh BUGS Invalid information in .Fa iocb->_aiocb_private may confuse the kernel.