… | |
… | |
191 | use common::sense; |
191 | use common::sense; |
192 | |
192 | |
193 | use base 'Exporter'; |
193 | use base 'Exporter'; |
194 | |
194 | |
195 | BEGIN { |
195 | BEGIN { |
196 | our $VERSION = '3.3'; |
196 | our $VERSION = '3.4'; |
197 | |
197 | |
198 | 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 |
199 | 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 |
200 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
200 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
201 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
201 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
202 | aio_rename aio_link aio_move aio_copy aio_group |
202 | aio_rename aio_link aio_move aio_copy aio_group |
203 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
203 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
204 | aio_chmod aio_utime aio_truncate); |
204 | aio_chmod aio_utime aio_truncate |
|
|
205 | aio_msync aio_mtouch); |
205 | |
206 | |
206 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
207 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
207 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
208 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
208 | min_parallel max_parallel max_idle |
209 | min_parallel max_parallel max_idle |
209 | nreqs nready npending nthreads |
210 | nreqs nready npending nthreads |
… | |
… | |
380 | |
381 | |
381 | This call tries to make use of a native C<sendfile> syscall to provide |
382 | 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 |
383 | 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. |
384 | socket, and C<$in_fh> should refer to mmap'able file. |
384 | |
385 | |
385 | If the native sendfile call fails or is not implemented, it will be |
386 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
|
|
387 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
386 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
388 | it will be emulated, so you can call C<aio_sendfile> on any type of |
387 | regardless of the limitations of the operating system. |
389 | filehandle regardless of the limitations of the operating system. |
388 | |
390 | |
389 | Please note, however, that C<aio_sendfile> can read more bytes from |
391 | 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 |
392 | 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 |
393 | 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 |
394 | provides the number of bytes written to C<$out_fh>. Only if the result |
… | |
… | |
634 | |
636 | |
635 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
637 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
636 | |
638 | |
637 | Try to copy the I<file> (directories not supported as either source or |
639 | 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 |
640 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | the C<0> (error) or C<-1> ok. |
641 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
640 | |
642 | |
641 | This is a composite request that creates the destination file with |
643 | 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 |
644 | 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 |
645 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
644 | uid/gid, in that order. |
646 | uid/gid, in that order. |
… | |
… | |
656 | my $grp = aio_group $cb; |
658 | my $grp = aio_group $cb; |
657 | |
659 | |
658 | aioreq_pri $pri; |
660 | aioreq_pri $pri; |
659 | add $grp aio_open $src, O_RDONLY, 0, sub { |
661 | add $grp aio_open $src, O_RDONLY, 0, sub { |
660 | if (my $src_fh = $_[0]) { |
662 | if (my $src_fh = $_[0]) { |
661 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
663 | my @stat = stat $src_fh; # hmm, might block over nfs? |
662 | |
664 | |
663 | aioreq_pri $pri; |
665 | aioreq_pri $pri; |
664 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
666 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
665 | if (my $dst_fh = $_[0]) { |
667 | if (my $dst_fh = $_[0]) { |
666 | aioreq_pri $pri; |
668 | aioreq_pri $pri; |
… | |
… | |
713 | |
715 | |
714 | =item aio_move $srcpath, $dstpath, $callback->($status) |
716 | =item aio_move $srcpath, $dstpath, $callback->($status) |
715 | |
717 | |
716 | Try to move the I<file> (directories not supported as either source or |
718 | 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 |
719 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
718 | the C<0> (error) or C<-1> ok. |
720 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
719 | |
721 | |
720 | This is a composite request that tries to rename(2) the file first; if |
722 | 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 |
723 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
722 | that is successful, unlinks the C<$srcpath>. |
724 | that is successful, unlinks the C<$srcpath>. |
723 | |
725 | |
… | |
… | |
989 | }; |
991 | }; |
990 | |
992 | |
991 | $grp |
993 | $grp |
992 | } |
994 | } |
993 | |
995 | |
|
|
996 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
997 | |
|
|
998 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
999 | scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note |
|
|
1000 | that the scalar must only be modified in-place while an aio operation is |
|
|
1001 | pending on it). |
|
|
1002 | |
|
|
1003 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1004 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1005 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1006 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1007 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1008 | C<IO::AIO::MS_SYNC>. |
|
|
1009 | |
|
|
1010 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1011 | |
|
|
1012 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1013 | scalars. |
|
|
1014 | |
|
|
1015 | It touches (reads or writes) all memory pages in the specified |
|
|
1016 | range inside the scalar. All caveats and parameters are the same |
|
|
1017 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1018 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1019 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1020 | writing an octet from it, which dirties the page). |
|
|
1021 | |
994 | =item aio_group $callback->(...) |
1022 | =item aio_group $callback->(...) |
995 | |
1023 | |
996 | This is a very special aio request: Instead of doing something, it is a |
1024 | This is a very special aio request: Instead of doing something, it is a |
997 | container for other aio requests, which is useful if you want to bundle |
1025 | container for other aio requests, which is useful if you want to bundle |
998 | many requests into a single, composite, request with a definite callback |
1026 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1132 | |
1160 | |
1133 | =item $grp->cancel_subs |
1161 | =item $grp->cancel_subs |
1134 | |
1162 | |
1135 | Cancel all subrequests and clears any feeder, but not the group request |
1163 | Cancel all subrequests and clears any feeder, but not the group request |
1136 | itself. Useful when you queued a lot of events but got a result early. |
1164 | itself. Useful when you queued a lot of events but got a result early. |
|
|
1165 | |
|
|
1166 | The group request will finish normally (you cannot add requests to the |
|
|
1167 | group). |
1137 | |
1168 | |
1138 | =item $grp->result (...) |
1169 | =item $grp->result (...) |
1139 | |
1170 | |
1140 | Set the result value(s) that will be passed to the group callback when all |
1171 | Set the result value(s) that will be passed to the group callback when all |
1141 | subrequests have finished and set the groups errno to the current value |
1172 | subrequests have finished and set the groups errno to the current value |