… | |
… | |
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.261'; |
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 aio_statvfs); |
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 |
… | |
… | |
430 | $_[0] and die "stat failed: $!"; |
432 | $_[0] and die "stat failed: $!"; |
431 | print "size is ", -s _, "\n"; |
433 | print "size is ", -s _, "\n"; |
432 | }; |
434 | }; |
433 | |
435 | |
434 | |
436 | |
|
|
437 | =item aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
438 | |
|
|
439 | Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on |
|
|
440 | whether a file handle or path was passed. |
|
|
441 | |
|
|
442 | On success, the callback is passed a hash reference with the following |
|
|
443 | members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>, |
|
|
444 | C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef> |
|
|
445 | is passed. |
|
|
446 | |
|
|
447 | The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and |
|
|
448 | C<ST_NOSUID>. |
|
|
449 | |
|
|
450 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
451 | their correct value when available, or to C<0> on systems that do |
|
|
452 | not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>, |
|
|
453 | C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>, |
|
|
454 | C<ST_NODIRATIME> and C<ST_RELATIME>. |
|
|
455 | |
|
|
456 | Example: stat C</wd> and dump out the data if successful. |
|
|
457 | |
|
|
458 | aio_statvfs "/wd", sub { |
|
|
459 | my $f = $_[0] |
|
|
460 | or die "statvfs: $!"; |
|
|
461 | |
|
|
462 | use Data::Dumper; |
|
|
463 | say Dumper $f; |
|
|
464 | }; |
|
|
465 | |
|
|
466 | # result: |
|
|
467 | { |
|
|
468 | bsize => 1024, |
|
|
469 | bfree => 4333064312, |
|
|
470 | blocks => 10253828096, |
|
|
471 | files => 2050765568, |
|
|
472 | flag => 4096, |
|
|
473 | favail => 2042092649, |
|
|
474 | bavail => 4333064312, |
|
|
475 | ffree => 2042092649, |
|
|
476 | namemax => 255, |
|
|
477 | frsize => 1024, |
|
|
478 | fsid => 1810 |
|
|
479 | } |
|
|
480 | |
|
|
481 | |
435 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
482 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
436 | |
483 | |
437 | Works like perl's C<utime> function (including the special case of $atime |
484 | Works like perl's C<utime> function (including the special case of $atime |
438 | and $mtime being undef). Fractional times are supported if the underlying |
485 | and $mtime being undef). Fractional times are supported if the underlying |
439 | syscalls support them. |
486 | syscalls support them. |
… | |
… | |
634 | |
681 | |
635 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
682 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
636 | |
683 | |
637 | Try to copy the I<file> (directories not supported as either source or |
684 | 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 |
685 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | the C<0> (error) or C<-1> ok. |
686 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
640 | |
687 | |
641 | This is a composite request that creates the destination file with |
688 | 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 |
689 | 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 |
690 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
644 | uid/gid, in that order. |
691 | uid/gid, in that order. |
… | |
… | |
656 | my $grp = aio_group $cb; |
703 | my $grp = aio_group $cb; |
657 | |
704 | |
658 | aioreq_pri $pri; |
705 | aioreq_pri $pri; |
659 | add $grp aio_open $src, O_RDONLY, 0, sub { |
706 | add $grp aio_open $src, O_RDONLY, 0, sub { |
660 | if (my $src_fh = $_[0]) { |
707 | if (my $src_fh = $_[0]) { |
661 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
708 | my @stat = stat $src_fh; # hmm, might block over nfs? |
662 | |
709 | |
663 | aioreq_pri $pri; |
710 | aioreq_pri $pri; |
664 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
711 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
665 | if (my $dst_fh = $_[0]) { |
712 | if (my $dst_fh = $_[0]) { |
666 | aioreq_pri $pri; |
713 | aioreq_pri $pri; |
… | |
… | |
713 | |
760 | |
714 | =item aio_move $srcpath, $dstpath, $callback->($status) |
761 | =item aio_move $srcpath, $dstpath, $callback->($status) |
715 | |
762 | |
716 | Try to move the I<file> (directories not supported as either source or |
763 | 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 |
764 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
718 | the C<0> (error) or C<-1> ok. |
765 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
719 | |
766 | |
720 | This is a composite request that tries to rename(2) the file first; if |
767 | 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 |
768 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
722 | that is successful, unlinks the C<$srcpath>. |
769 | that is successful, unlinks the C<$srcpath>. |
723 | |
770 | |
… | |
… | |
989 | }; |
1036 | }; |
990 | |
1037 | |
991 | $grp |
1038 | $grp |
992 | } |
1039 | } |
993 | |
1040 | |
|
|
1041 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1042 | |
|
|
1043 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
1044 | scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note |
|
|
1045 | that the scalar must only be modified in-place while an aio operation is |
|
|
1046 | pending on it). |
|
|
1047 | |
|
|
1048 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1049 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1050 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1051 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1052 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1053 | C<IO::AIO::MS_SYNC>. |
|
|
1054 | |
|
|
1055 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1056 | |
|
|
1057 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1058 | scalars. |
|
|
1059 | |
|
|
1060 | It touches (reads or writes) all memory pages in the specified |
|
|
1061 | range inside the scalar. All caveats and parameters are the same |
|
|
1062 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1063 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1064 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1065 | writing an octet from it, which dirties the page). |
|
|
1066 | |
994 | =item aio_group $callback->(...) |
1067 | =item aio_group $callback->(...) |
995 | |
1068 | |
996 | This is a very special aio request: Instead of doing something, it is a |
1069 | 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 |
1070 | 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 |
1071 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1132 | |
1205 | |
1133 | =item $grp->cancel_subs |
1206 | =item $grp->cancel_subs |
1134 | |
1207 | |
1135 | Cancel all subrequests and clears any feeder, but not the group request |
1208 | 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. |
1209 | itself. Useful when you queued a lot of events but got a result early. |
|
|
1210 | |
|
|
1211 | The group request will finish normally (you cannot add requests to the |
|
|
1212 | group). |
1137 | |
1213 | |
1138 | =item $grp->result (...) |
1214 | =item $grp->result (...) |
1139 | |
1215 | |
1140 | Set the result value(s) that will be passed to the group callback when all |
1216 | 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 |
1217 | subrequests have finished and set the groups errno to the current value |