diff options
Diffstat (limited to 'man7/aio.7')
-rw-r--r-- | man7/aio.7 | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/man7/aio.7 b/man7/aio.7 index 513fbbb73..234ccabb7 100644 --- a/man7/aio.7 +++ b/man7/aio.7 @@ -16,38 +16,38 @@ or no notification at all. .P The POSIX AIO interface consists of the following functions: .TP -.BR aio_read (3) +.MR aio_read 3 Enqueue a read request. This is the asynchronous analog of -.BR read (2). +.MR read 2 . .TP -.BR aio_write (3) +.MR aio_write 3 Enqueue a write request. This is the asynchronous analog of -.BR write (2). +.MR write 2 . .TP -.BR aio_fsync (3) +.MR aio_fsync 3 Enqueue a sync request for the I/O operations on a file descriptor. This is the asynchronous analog of -.BR fsync (2) +.MR fsync 2 and -.BR fdatasync (2). +.MR fdatasync 2 . .TP -.BR aio_error (3) +.MR aio_error 3 Obtain the error status of an enqueued I/O request. .TP -.BR aio_return (3) +.MR aio_return 3 Obtain the return status of a completed I/O request. .TP -.BR aio_suspend (3) +.MR aio_suspend 3 Suspend the caller until one or more of a specified set of I/O requests completes. .TP -.BR aio_cancel (3) +.MR aio_cancel 3 Attempt to cancel outstanding I/O requests on a specified file descriptor. .TP -.BR lio_listio (3) +.MR lio_listio 3 Enqueue multiple I/O requests using a single function call. .P The @@ -101,7 +101,7 @@ This is the size of the buffer pointed to by This field specifies a value that is subtracted from the calling thread's real-time priority in order to determine the priority for execution of this I/O request (see -.BR pthread_setschedparam (3)). +.MR pthread_setschedparam 3 ). The specified value must be between 0 and the value returned by .IR sysconf(_SC_AIO_PRIO_DELTA_MAX) . This field is ignored for file synchronization operations. @@ -117,17 +117,17 @@ are and .BR SIGEV_THREAD . See -.BR sigevent (3type) +.MR sigevent 3type for further details. .TP .I aio_lio_opcode The type of operation to be performed; used only for -.BR lio_listio (3). +.MR lio_listio 3 . .P In addition to the standard functions listed above, the GNU C library provides the following extension to the POSIX AIO API: .TP -.BR aio_init (3) +.MR aio_init 3 Set parameters for tuning the behavior of the glibc POSIX AIO implementation. .SH ERRORS .TP @@ -146,7 +146,7 @@ POSIX.1-2001. glibc 2.1. .SH NOTES It is a good idea to zero out the control block buffer before use (see -.BR memset (3)). +.MR memset 3 ). The control block buffer and the buffer pointed to by .I aio_buf must not be changed while the I/O operation is in progress. @@ -162,11 +162,11 @@ threads to perform I/O operations is expensive and scales poorly. Work has been in progress for some time on a kernel state-machine-based implementation of asynchronous I/O (see -.BR io_submit (2), -.BR io_setup (2), -.BR io_cancel (2), -.BR io_destroy (2), -.BR io_getevents (2)), +.MR io_submit 2 , +.MR io_setup 2 , +.MR io_cancel 2 , +.MR io_destroy 2 , +.MR io_getevents 2 ), but this implementation hasn't yet matured to the point where the POSIX AIO implementation can be completely reimplemented using the kernel system calls. @@ -176,22 +176,22 @@ reimplemented using the kernel system calls. .SH EXAMPLES The program below opens each of the files named in its command-line arguments and queues a request on the resulting file descriptor using -.BR aio_read (3). +.MR aio_read 3 . The program then loops, periodically monitoring each of the I/O operations that is still in progress using -.BR aio_error (3). +.MR aio_error 3 . Each of the I/O requests is set up to provide notification by delivery of a signal. After all I/O requests have completed, the program retrieves their status using -.BR aio_return (3). +.MR aio_return 3 . .P The .B SIGQUIT signal (generated by typing control-\e) causes the program to request cancelation of each of the outstanding requests using -.BR aio_cancel (3). +.MR aio_cancel 3 . .P Here is an example of what we might see when running this program. In this example, the program queues two requests to standard input, @@ -426,18 +426,18 @@ main(int argc, char *argv[]) .SH SEE ALSO .ad l .nh -.BR io_cancel (2), -.BR io_destroy (2), -.BR io_getevents (2), -.BR io_setup (2), -.BR io_submit (2), -.BR aio_cancel (3), -.BR aio_error (3), -.BR aio_init (3), -.BR aio_read (3), -.BR aio_return (3), -.BR aio_write (3), -.BR lio_listio (3) +.MR io_cancel 2 , +.MR io_destroy 2 , +.MR io_getevents 2 , +.MR io_setup 2 , +.MR io_submit 2 , +.MR aio_cancel 3 , +.MR aio_error 3 , +.MR aio_init 3 , +.MR aio_read 3 , +.MR aio_return 3 , +.MR aio_write 3 , +.MR lio_listio 3 .P "Asynchronous I/O Support in Linux 2.5", Bhattacharya, Pratt, Pulavarty, and Morgan, |