… | |
… | |
186 | |
186 | |
187 | package IO::AIO; |
187 | package IO::AIO; |
188 | |
188 | |
189 | use Carp (); |
189 | use Carp (); |
190 | |
190 | |
191 | no warnings; |
191 | use common::sense; |
192 | use strict 'vars'; |
|
|
193 | |
192 | |
194 | use base 'Exporter'; |
193 | use base 'Exporter'; |
195 | |
194 | |
196 | BEGIN { |
195 | BEGIN { |
197 | our $VERSION = '3.23'; |
196 | our $VERSION = '3.31'; |
198 | |
197 | |
199 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
200 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
199 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
201 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
200 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
201 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
… | |
… | |
206 | |
205 | |
207 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
206 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
208 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
207 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | min_parallel max_parallel max_idle |
208 | min_parallel max_parallel max_idle |
210 | nreqs nready npending nthreads |
209 | nreqs nready npending nthreads |
211 | max_poll_time max_poll_reqs); |
210 | max_poll_time max_poll_reqs |
|
|
211 | sendfile fadvise); |
212 | |
212 | |
213 | push @AIO_REQ, qw(aio_busy); # not exported |
213 | push @AIO_REQ, qw(aio_busy); # not exported |
214 | |
214 | |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | |
216 | |
… | |
… | |
380 | |
380 | |
381 | This call tries to make use of a native C<sendfile> syscall to provide |
381 | This call tries to make use of a native C<sendfile> syscall to provide |
382 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
382 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
383 | socket, and C<$in_fh> should refer to mmap'able file. |
383 | socket, and C<$in_fh> should refer to mmap'able file. |
384 | |
384 | |
385 | If the native sendfile call fails or is not implemented, it will be |
385 | If the native sendfile call fails with C<ENOSYS>, C<ENOTSUP>, |
|
|
386 | C<EOPNOTSUPP> or C<ENOTSOCK>, or is not implemented, it will be emulated, |
386 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
387 | so you can call C<aio_sendfile> on any type of filehandle regardless of |
387 | regardless of the limitations of the operating system. |
388 | the limitations of the operating system. |
388 | |
389 | |
389 | Please note, however, that C<aio_sendfile> can read more bytes from |
390 | Please note, however, that C<aio_sendfile> can read more bytes from |
390 | C<$in_fh> than are written, and there is no way to find out how many |
391 | C<$in_fh> than are written, and there is no way to find out how many |
391 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
392 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
392 | provides the number of bytes written to C<$out_fh>. Only if the result |
393 | provides the number of bytes written to C<$out_fh>. Only if the result |
… | |
… | |
634 | |
635 | |
635 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
636 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
636 | |
637 | |
637 | Try to copy the I<file> (directories not supported as either source or |
638 | Try to copy the I<file> (directories not supported as either source or |
638 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | the C<0> (error) or C<-1> ok. |
640 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
640 | |
641 | |
641 | This is a composite request that creates the destination file with |
642 | This is a composite request that creates the destination file with |
642 | mode 0200 and copies the contents of the source file into it using |
643 | mode 0200 and copies the contents of the source file into it using |
643 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
644 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
644 | uid/gid, in that order. |
645 | uid/gid, in that order. |
… | |
… | |
656 | my $grp = aio_group $cb; |
657 | my $grp = aio_group $cb; |
657 | |
658 | |
658 | aioreq_pri $pri; |
659 | aioreq_pri $pri; |
659 | add $grp aio_open $src, O_RDONLY, 0, sub { |
660 | add $grp aio_open $src, O_RDONLY, 0, sub { |
660 | if (my $src_fh = $_[0]) { |
661 | if (my $src_fh = $_[0]) { |
661 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
662 | my @stat = stat $src_fh; # hmm, might block over nfs? |
662 | |
663 | |
663 | aioreq_pri $pri; |
664 | aioreq_pri $pri; |
664 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
665 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
665 | if (my $dst_fh = $_[0]) { |
666 | if (my $dst_fh = $_[0]) { |
666 | aioreq_pri $pri; |
667 | aioreq_pri $pri; |
… | |
… | |
713 | |
714 | |
714 | =item aio_move $srcpath, $dstpath, $callback->($status) |
715 | =item aio_move $srcpath, $dstpath, $callback->($status) |
715 | |
716 | |
716 | Try to move the I<file> (directories not supported as either source or |
717 | Try to move the I<file> (directories not supported as either source or |
717 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
718 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
718 | the C<0> (error) or C<-1> ok. |
719 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
719 | |
720 | |
720 | This is a composite request that tries to rename(2) the file first; if |
721 | This is a composite request that tries to rename(2) the file first; if |
721 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
722 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
722 | that is successful, unlinks the C<$srcpath>. |
723 | that is successful, unlinks the C<$srcpath>. |
723 | |
724 | |
… | |
… | |
957 | (E.g. rename). This might not work on all operating systems or have any |
958 | (E.g. rename). This might not work on all operating systems or have any |
958 | specific effect, but usually it makes sure that directory changes get |
959 | specific effect, but usually it makes sure that directory changes get |
959 | written to disc. It works for anything that can be opened for read-only, |
960 | written to disc. It works for anything that can be opened for read-only, |
960 | not just directories. |
961 | not just directories. |
961 | |
962 | |
|
|
963 | Future versions of this function might fall back to other methods when |
|
|
964 | C<fsync> on the directory fails (such as calling C<sync>). |
|
|
965 | |
962 | Passes C<0> when everything went ok, and C<-1> on error. |
966 | Passes C<0> when everything went ok, and C<-1> on error. |
963 | |
967 | |
964 | =cut |
968 | =cut |
965 | |
969 | |
966 | sub aio_pathsync($;$) { |
970 | sub aio_pathsync($;$) { |
… | |
… | |
1130 | =item $grp->cancel_subs |
1134 | =item $grp->cancel_subs |
1131 | |
1135 | |
1132 | Cancel all subrequests and clears any feeder, but not the group request |
1136 | Cancel all subrequests and clears any feeder, but not the group request |
1133 | itself. Useful when you queued a lot of events but got a result early. |
1137 | itself. Useful when you queued a lot of events but got a result early. |
1134 | |
1138 | |
|
|
1139 | The group request will finish normally (you cannot add requests to the |
|
|
1140 | group). |
|
|
1141 | |
1135 | =item $grp->result (...) |
1142 | =item $grp->result (...) |
1136 | |
1143 | |
1137 | Set the result value(s) that will be passed to the group callback when all |
1144 | Set the result value(s) that will be passed to the group callback when all |
1138 | subrequests have finished and set the groups errno to the current value |
1145 | subrequests have finished and set the groups errno to the current value |
1139 | of errno (just like calling C<errno> without an error number). By default, |
1146 | of errno (just like calling C<errno> without an error number). By default, |
… | |
… | |
1391 | |
1398 | |
1392 | =item IO::AIO::npending |
1399 | =item IO::AIO::npending |
1393 | |
1400 | |
1394 | Returns the number of requests currently in the pending state (executed, |
1401 | Returns the number of requests currently in the pending state (executed, |
1395 | but not yet processed by poll_cb). |
1402 | but not yet processed by poll_cb). |
|
|
1403 | |
|
|
1404 | =back |
|
|
1405 | |
|
|
1406 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1407 | |
|
|
1408 | IO::AIO implements some functions that might be useful, but are not |
|
|
1409 | asynchronous. |
|
|
1410 | |
|
|
1411 | =over 4 |
|
|
1412 | |
|
|
1413 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1414 | |
|
|
1415 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1416 | but is blocking (this makes most sense if you know the input data is |
|
|
1417 | likely cached already and the output filehandle is set to non-blocking |
|
|
1418 | operations). |
|
|
1419 | |
|
|
1420 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1421 | |
|
|
1422 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1423 | |
|
|
1424 | Simply calls the C<posix_fadvise> function (see it's |
|
|
1425 | manpage for details). The following advice constants are |
|
|
1426 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1427 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1428 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1429 | |
|
|
1430 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1431 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1396 | |
1432 | |
1397 | =back |
1433 | =back |
1398 | |
1434 | |
1399 | =cut |
1435 | =cut |
1400 | |
1436 | |