--- IO-AIO/AIO.pm 2005/07/10 20:57:00 1.4 +++ IO-AIO/AIO.pm 2005/07/10 21:04:24 1.5 @@ -23,25 +23,6 @@ Although the module will work with in the presence of other threads, it is currently not reentrant, so use appropriate locking yourself. -=head2 API NOTES - -All the C calls are more or less thin wrappers around the syscall -with the same name (sans C). The arguments are similar or identical, -and they all accept an additional C<$callback> argument which must be -a code reference. This code reference will get called with the syscall -return code (e.g. most syscalls return C<-1> on error, unlike perl, which -usually delivers "false") as it's sole argument when the given syscall has -been executed asynchronously. - -All functions that expect a filehandle will also accept a file descriptor. - -The filenames you pass to these routines I be absolute. The reason -is that at the time the request is being executed, the current working -directory could have changed. Alternatively, you can make sure that you -never change the current working directory. - -=over 4 - =cut package IO::AIO; @@ -61,81 +42,26 @@ XSLoader::load IO::AIO, $VERSION; } -=item IO::AIO::min_parallel $nthreads - -Set the minimum number of AIO threads to C<$nthreads>. The default is -C<1>, which means a single asynchronous operation can be done at one time -(the number of outstanding operations, however, is unlimited). - -It is recommended to keep the number of threads low, as some Linux -kernel versions will scale negatively with the number of threads (higher -parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 -threads should be fine. - -Under normal circumstances you don't need to call this function, as this -module automatically starts some threads (the exact number might change, -and is currently 4). - -=item IO::AIO::max_parallel $nthreads - -Sets the maximum number of AIO threads to C<$nthreads>. If more than -the specified number of threads are currently running, kill them. This -function blocks until the limit is reached. - -This module automatically runs C at program end, to ensure -that all threads are killed and that there are no outstanding requests. - -Under normal circumstances you don't need to call this function. - -=item $oldnreqs = IO::AIO::max_outstanding $nreqs - -Sets the maximum number of outstanding requests to C<$nreqs>. If you -try to queue up more than this number of requests, the caller will block until -some requests have been handled. - -The default is very large, so normally there is no practical limit. If you -queue up many requests in a loop it it often improves speed if you set -this to a relatively low number, such as C<100>. - -Under normal circumstances you don't need to call this function. - -=item $fileno = IO::AIO::poll_fileno - -Return the I. This filehandle must be -polled for reading by some mechanism outside this module (e.g. Event -or select, see below). If the pipe becomes readable you have to call -C to check the results. - -See C for an example. - -=item IO::AIO::poll_cb - -Process all outstanding events on the result pipe. You have to call this -regularly. Returns the number of events processed. Returns immediately -when no events are outstanding. +=head1 FUNCTIONS -You can use Event to multiplex, e.g.: +=head2 AIO FUNCTIONS - Event->io (fd => IO::AIO::poll_fileno, - poll => 'r', async => 1, - cb => \&IO::AIO::poll_cb); - -=item IO::AIO::poll_wait - -Wait till the result filehandle becomes ready for reading (simply does a -select on the filehandle. This is useful if you want to synchronously wait -for some requests to finish). - -See C for an example. - -=item IO::AIO::nreqs +All the C calls are more or less thin wrappers around the syscall +with the same name (sans C). The arguments are similar or identical, +and they all accept an additional C<$callback> argument which must be +a code reference. This code reference will get called with the syscall +return code (e.g. most syscalls return C<-1> on error, unlike perl, which +usually delivers "false") as it's sole argument when the given syscall has +been executed asynchronously. -Returns the number of requests currently outstanding. +All functions that expect a filehandle will also accept a file descriptor. -Example: wait till there are no outstanding requests anymore: +The filenames you pass to these routines I be absolute. The reason +is that at the time the request is being executed, the current working +directory could have changed. Alternatively, you can make sure that you +never change the current working directory. - IO::AIO::poll_wait, IO::AIO::poll_cb - while IO::AIO::nreqs; +=over 4 =item aio_open $pathname, $flags, $mode, $callback @@ -236,6 +162,90 @@ Asynchronously call fdatasync on the given filehandle and call the callback with the fdatasync result code. +=back + +=head2 SUPPORT FUNCTIONS + +=over 4 + +=item $fileno = IO::AIO::poll_fileno + +Return the I. This filehandle must be +polled for reading by some mechanism outside this module (e.g. Event +or select, see below). If the pipe becomes readable you have to call +C to check the results. + +See C for an example. + +=item IO::AIO::poll_cb + +Process all outstanding events on the result pipe. You have to call this +regularly. Returns the number of events processed. Returns immediately +when no events are outstanding. + +You can use Event to multiplex, e.g.: + + Event->io (fd => IO::AIO::poll_fileno, + poll => 'r', async => 1, + cb => \&IO::AIO::poll_cb); + +=item IO::AIO::poll_wait + +Wait till the result filehandle becomes ready for reading (simply does a +select on the filehandle. This is useful if you want to synchronously wait +for some requests to finish). + +See C for an example. + +=item IO::AIO::nreqs + +Returns the number of requests currently outstanding. + +Example: wait till there are no outstanding requests anymore: + + IO::AIO::poll_wait, IO::AIO::poll_cb + while IO::AIO::nreqs; + +=item IO::AIO::min_parallel $nthreads + +Set the minimum number of AIO threads to C<$nthreads>. The default is +C<1>, which means a single asynchronous operation can be done at one time +(the number of outstanding operations, however, is unlimited). + +It is recommended to keep the number of threads low, as some Linux +kernel versions will scale negatively with the number of threads (higher +parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 +threads should be fine. + +Under normal circumstances you don't need to call this function, as this +module automatically starts some threads (the exact number might change, +and is currently 4). + +=item IO::AIO::max_parallel $nthreads + +Sets the maximum number of AIO threads to C<$nthreads>. If more than +the specified number of threads are currently running, kill them. This +function blocks until the limit is reached. + +This module automatically runs C at program end, to ensure +that all threads are killed and that there are no outstanding requests. + +Under normal circumstances you don't need to call this function. + +=item $oldnreqs = IO::AIO::max_outstanding $nreqs + +Sets the maximum number of outstanding requests to C<$nreqs>. If you +try to queue up more than this number of requests, the caller will block until +some requests have been handled. + +The default is very large, so normally there is no practical limit. If you +queue up many requests in a loop it it often improves speed if you set +this to a relatively low number, such as C<100>. + +Under normal circumstances you don't need to call this function. + +=back + =cut # support function to convert a fd into a perl filehandle @@ -258,12 +268,6 @@ 1; -=back - -=head1 BUGS - - - could be optimized to use more semaphores instead of filehandles. - =head1 SEE ALSO L, L.