… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | use AnyEvent::AIO; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
33 | |
35 | # EV integration |
34 | # EV integration |
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
37 | |
36 | |
38 | # Event integration |
37 | # Event integration |
… | |
… | |
194 | use strict 'vars'; |
193 | use strict 'vars'; |
195 | |
194 | |
196 | use base 'Exporter'; |
195 | use base 'Exporter'; |
197 | |
196 | |
198 | BEGIN { |
197 | BEGIN { |
199 | our $VERSION = '2.61'; |
198 | our $VERSION = '3.18'; |
200 | |
199 | |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
204 | aio_fdatasync aio_pathsync aio_readahead |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
205 | aio_rename aio_link aio_move aio_copy aio_group |
204 | aio_rename aio_link aio_move aio_copy aio_group |
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
207 | aio_chmod aio_utime aio_truncate); |
206 | aio_chmod aio_utime aio_truncate); |
208 | |
207 | |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
211 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
212 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
213 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
214 | |
215 | |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | |
217 | |
217 | require XSLoader; |
218 | require XSLoader; |
218 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
225 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | and they all accept an additional (and optional) C<$callback> argument |
228 | and they all accept an additional (and optional) C<$callback> argument |
228 | which must be a code reference. This code reference will get called with |
229 | which must be a code reference. This code reference will get called with |
229 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | perl, which usually delivers "false") as it's sole argument when the given |
231 | perl, which usually delivers "false") as its sole argument after the given |
231 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
232 | |
233 | |
233 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
234 | internally until the request has finished. |
235 | internally until the request has finished. |
235 | |
236 | |
… | |
… | |
249 | your pathnames to the locale (or other) encoding in effect in the user |
250 | your pathnames to the locale (or other) encoding in effect in the user |
250 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
252 | |
253 | |
253 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
255 | |
256 | |
256 | =over 4 |
257 | =over 4 |
257 | |
258 | |
258 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
259 | |
260 | |
… | |
… | |
337 | |
338 | |
338 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | |
340 | |
340 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | |
342 | |
342 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
343 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
344 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
345 | like the syscall). |
346 | error, just like the syscall). |
346 | |
347 | |
347 | If C<$offset> is undefined, then the current file descriptor offset will |
348 | If C<$offset> is undefined, then the current file descriptor offset will |
348 | be used (and updated), otherwise the file descriptor offset will not be |
349 | be used (and updated), otherwise the file descriptor offset will not be |
349 | changed by these calls. |
350 | changed by these calls. |
350 | |
351 | |
351 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
352 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
353 | C<$data>. |
352 | |
354 | |
353 | If C<$dataoffset> is less than zero, it will be counted from the end of |
355 | If C<$dataoffset> is less than zero, it will be counted from the end of |
354 | C<$data>. |
356 | C<$data>. |
355 | |
357 | |
356 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
358 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
… | |
… | |
540 | memory. Status is the same as with aio_read. |
542 | memory. Status is the same as with aio_read. |
541 | |
543 | |
542 | =cut |
544 | =cut |
543 | |
545 | |
544 | sub aio_load($$;$) { |
546 | sub aio_load($$;$) { |
545 | aio_block { |
|
|
546 | my ($path, undef, $cb) = @_; |
547 | my ($path, undef, $cb) = @_; |
547 | my $data = \$_[1]; |
548 | my $data = \$_[1]; |
548 | |
549 | |
549 | my $pri = aioreq_pri; |
550 | my $pri = aioreq_pri; |
550 | my $grp = aio_group $cb; |
551 | my $grp = aio_group $cb; |
|
|
552 | |
|
|
553 | aioreq_pri $pri; |
|
|
554 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
555 | my $fh = shift |
|
|
556 | or return $grp->result (-1); |
551 | |
557 | |
552 | aioreq_pri $pri; |
558 | aioreq_pri $pri; |
553 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
554 | my $fh = shift |
|
|
555 | or return $grp->result (-1); |
|
|
556 | |
|
|
557 | aioreq_pri $pri; |
|
|
558 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
559 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
559 | $grp->result ($_[0]); |
560 | $grp->result ($_[0]); |
560 | }; |
|
|
561 | }; |
561 | }; |
562 | |
|
|
563 | $grp |
|
|
564 | } |
562 | }; |
|
|
563 | |
|
|
564 | $grp |
565 | } |
565 | } |
566 | |
566 | |
567 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
567 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
568 | |
568 | |
569 | Try to copy the I<file> (directories not supported as either source or |
569 | Try to copy the I<file> (directories not supported as either source or |
570 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
570 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
571 | the C<0> (error) or C<-1> ok. |
571 | the C<0> (error) or C<-1> ok. |
572 | |
572 | |
573 | This is a composite request that it creates the destination file with |
573 | This is a composite request that creates the destination file with |
574 | mode 0200 and copies the contents of the source file into it using |
574 | mode 0200 and copies the contents of the source file into it using |
575 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
575 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
576 | uid/gid, in that order. |
576 | uid/gid, in that order. |
577 | |
577 | |
578 | If an error occurs, the partial destination file will be unlinked, if |
578 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
580 | errors are being ignored. |
580 | errors are being ignored. |
581 | |
581 | |
582 | =cut |
582 | =cut |
583 | |
583 | |
584 | sub aio_copy($$;$) { |
584 | sub aio_copy($$;$) { |
585 | aio_block { |
|
|
586 | my ($src, $dst, $cb) = @_; |
585 | my ($src, $dst, $cb) = @_; |
587 | |
586 | |
588 | my $pri = aioreq_pri; |
587 | my $pri = aioreq_pri; |
589 | my $grp = aio_group $cb; |
588 | my $grp = aio_group $cb; |
590 | |
589 | |
591 | aioreq_pri $pri; |
590 | aioreq_pri $pri; |
592 | add $grp aio_open $src, O_RDONLY, 0, sub { |
591 | add $grp aio_open $src, O_RDONLY, 0, sub { |
593 | if (my $src_fh = $_[0]) { |
592 | if (my $src_fh = $_[0]) { |
594 | my @stat = stat $src_fh; |
593 | my @stat = stat $src_fh; |
595 | |
594 | |
596 | aioreq_pri $pri; |
595 | aioreq_pri $pri; |
597 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
596 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
598 | if (my $dst_fh = $_[0]) { |
597 | if (my $dst_fh = $_[0]) { |
599 | aioreq_pri $pri; |
598 | aioreq_pri $pri; |
600 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
599 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
601 | if ($_[0] == $stat[7]) { |
600 | if ($_[0] == $stat[7]) { |
602 | $grp->result (0); |
601 | $grp->result (0); |
603 | close $src_fh; |
602 | close $src_fh; |
604 | |
603 | |
605 | # those should not normally block. should. should. |
604 | # those should not normally block. should. should. |
606 | utime $stat[8], $stat[9], $dst; |
605 | utime $stat[8], $stat[9], $dst; |
607 | chmod $stat[2] & 07777, $dst_fh; |
606 | chmod $stat[2] & 07777, $dst_fh; |
608 | chown $stat[4], $stat[5], $dst_fh; |
607 | chown $stat[4], $stat[5], $dst_fh; |
609 | |
608 | |
610 | aioreq_pri $pri; |
609 | aioreq_pri $pri; |
611 | add $grp aio_close $dst_fh; |
610 | add $grp aio_close $dst_fh; |
612 | } else { |
611 | } else { |
613 | $grp->result (-1); |
612 | $grp->result (-1); |
614 | close $src_fh; |
613 | close $src_fh; |
615 | close $dst_fh; |
614 | close $dst_fh; |
616 | |
615 | |
617 | aioreq $pri; |
616 | aioreq $pri; |
618 | add $grp aio_unlink $dst; |
617 | add $grp aio_unlink $dst; |
619 | } |
|
|
620 | }; |
618 | } |
621 | } else { |
|
|
622 | $grp->result (-1); |
|
|
623 | } |
619 | }; |
|
|
620 | } else { |
|
|
621 | $grp->result (-1); |
624 | }, |
622 | } |
625 | |
|
|
626 | } else { |
|
|
627 | $grp->result (-1); |
|
|
628 | } |
623 | }, |
|
|
624 | |
|
|
625 | } else { |
|
|
626 | $grp->result (-1); |
629 | }; |
627 | } |
630 | |
|
|
631 | $grp |
|
|
632 | } |
628 | }; |
|
|
629 | |
|
|
630 | $grp |
633 | } |
631 | } |
634 | |
632 | |
635 | =item aio_move $srcpath, $dstpath, $callback->($status) |
633 | =item aio_move $srcpath, $dstpath, $callback->($status) |
636 | |
634 | |
637 | Try to move the I<file> (directories not supported as either source or |
635 | Try to move the I<file> (directories not supported as either source or |
638 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
636 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
639 | the C<0> (error) or C<-1> ok. |
637 | the C<0> (error) or C<-1> ok. |
640 | |
638 | |
641 | This is a composite request that tries to rename(2) the file first. If |
639 | This is a composite request that tries to rename(2) the file first; if |
642 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
640 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
643 | that is successful, unlinking the C<$srcpath>. |
641 | that is successful, unlinks the C<$srcpath>. |
644 | |
642 | |
645 | =cut |
643 | =cut |
646 | |
644 | |
647 | sub aio_move($$;$) { |
645 | sub aio_move($$;$) { |
648 | aio_block { |
|
|
649 | my ($src, $dst, $cb) = @_; |
646 | my ($src, $dst, $cb) = @_; |
650 | |
647 | |
651 | my $pri = aioreq_pri; |
648 | my $pri = aioreq_pri; |
652 | my $grp = aio_group $cb; |
649 | my $grp = aio_group $cb; |
653 | |
650 | |
654 | aioreq_pri $pri; |
651 | aioreq_pri $pri; |
655 | add $grp aio_rename $src, $dst, sub { |
652 | add $grp aio_rename $src, $dst, sub { |
656 | if ($_[0] && $! == EXDEV) { |
653 | if ($_[0] && $! == EXDEV) { |
657 | aioreq_pri $pri; |
654 | aioreq_pri $pri; |
658 | add $grp aio_copy $src, $dst, sub { |
655 | add $grp aio_copy $src, $dst, sub { |
659 | $grp->result ($_[0]); |
|
|
660 | |
|
|
661 | if (!$_[0]) { |
|
|
662 | aioreq_pri $pri; |
|
|
663 | add $grp aio_unlink $src; |
|
|
664 | } |
|
|
665 | }; |
|
|
666 | } else { |
|
|
667 | $grp->result ($_[0]); |
656 | $grp->result ($_[0]); |
|
|
657 | |
|
|
658 | if (!$_[0]) { |
|
|
659 | aioreq_pri $pri; |
|
|
660 | add $grp aio_unlink $src; |
|
|
661 | } |
668 | } |
662 | }; |
|
|
663 | } else { |
|
|
664 | $grp->result ($_[0]); |
669 | }; |
665 | } |
670 | |
|
|
671 | $grp |
|
|
672 | } |
666 | }; |
|
|
667 | |
|
|
668 | $grp |
673 | } |
669 | } |
674 | |
670 | |
675 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
671 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
676 | |
672 | |
677 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
673 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
725 | directory counting heuristic. |
721 | directory counting heuristic. |
726 | |
722 | |
727 | =cut |
723 | =cut |
728 | |
724 | |
729 | sub aio_scandir($$;$) { |
725 | sub aio_scandir($$;$) { |
730 | aio_block { |
|
|
731 | my ($path, $maxreq, $cb) = @_; |
726 | my ($path, $maxreq, $cb) = @_; |
732 | |
727 | |
733 | my $pri = aioreq_pri; |
728 | my $pri = aioreq_pri; |
734 | |
729 | |
735 | my $grp = aio_group $cb; |
730 | my $grp = aio_group $cb; |
736 | |
731 | |
737 | $maxreq = 4 if $maxreq <= 0; |
732 | $maxreq = 4 if $maxreq <= 0; |
738 | |
733 | |
739 | # stat once |
734 | # stat once |
|
|
735 | aioreq_pri $pri; |
|
|
736 | add $grp aio_stat $path, sub { |
|
|
737 | return $grp->result () if $_[0]; |
|
|
738 | my $now = time; |
|
|
739 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
740 | |
|
|
741 | # read the directory entries |
740 | aioreq_pri $pri; |
742 | aioreq_pri $pri; |
741 | add $grp aio_stat $path, sub { |
743 | add $grp aio_readdir $path, sub { |
|
|
744 | my $entries = shift |
742 | return $grp->result () if $_[0]; |
745 | or return $grp->result (); |
743 | my $now = time; |
|
|
744 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
745 | |
746 | |
746 | # read the directory entries |
747 | # stat the dir another time |
747 | aioreq_pri $pri; |
748 | aioreq_pri $pri; |
748 | add $grp aio_readdir $path, sub { |
|
|
749 | my $entries = shift |
|
|
750 | or return $grp->result (); |
|
|
751 | |
|
|
752 | # stat the dir another time |
|
|
753 | aioreq_pri $pri; |
|
|
754 | add $grp aio_stat $path, sub { |
749 | add $grp aio_stat $path, sub { |
755 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
750 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
756 | |
751 | |
757 | my $ndirs; |
752 | my $ndirs; |
758 | |
753 | |
759 | # take the slow route if anything looks fishy |
754 | # take the slow route if anything looks fishy |
760 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
755 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
761 | $ndirs = -1; |
756 | $ndirs = -1; |
762 | } else { |
757 | } else { |
763 | # if nlink == 2, we are finished |
758 | # if nlink == 2, we are finished |
764 | # on non-posix-fs's, we rely on nlink < 2 |
759 | # on non-posix-fs's, we rely on nlink < 2 |
765 | $ndirs = (stat _)[3] - 2 |
760 | $ndirs = (stat _)[3] - 2 |
766 | or return $grp->result ([], $entries); |
761 | or return $grp->result ([], $entries); |
767 | } |
762 | } |
768 | |
763 | |
769 | # sort into likely dirs and likely nondirs |
764 | # sort into likely dirs and likely nondirs |
770 | # dirs == files without ".", short entries first |
765 | # dirs == files without ".", short entries first |
771 | $entries = [map $_->[0], |
766 | $entries = [map $_->[0], |
772 | sort { $b->[1] cmp $a->[1] } |
767 | sort { $b->[1] cmp $a->[1] } |
773 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
768 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
774 | @$entries]; |
769 | @$entries]; |
775 | |
770 | |
776 | my (@dirs, @nondirs); |
771 | my (@dirs, @nondirs); |
777 | |
772 | |
778 | my $statgrp = add $grp aio_group sub { |
773 | my $statgrp = add $grp aio_group sub { |
779 | $grp->result (\@dirs, \@nondirs); |
774 | $grp->result (\@dirs, \@nondirs); |
780 | }; |
775 | }; |
781 | |
776 | |
782 | limit $statgrp $maxreq; |
777 | limit $statgrp $maxreq; |
783 | feed $statgrp sub { |
778 | feed $statgrp sub { |
784 | return unless @$entries; |
779 | return unless @$entries; |
785 | my $entry = pop @$entries; |
780 | my $entry = pop @$entries; |
786 | |
781 | |
787 | aioreq_pri $pri; |
782 | aioreq_pri $pri; |
788 | add $statgrp aio_stat "$path/$entry/.", sub { |
783 | add $statgrp aio_stat "$path/$entry/.", sub { |
789 | if ($_[0] < 0) { |
784 | if ($_[0] < 0) { |
790 | push @nondirs, $entry; |
785 | push @nondirs, $entry; |
791 | } else { |
786 | } else { |
792 | # need to check for real directory |
787 | # need to check for real directory |
793 | aioreq_pri $pri; |
788 | aioreq_pri $pri; |
794 | add $statgrp aio_lstat "$path/$entry", sub { |
789 | add $statgrp aio_lstat "$path/$entry", sub { |
795 | if (-d _) { |
790 | if (-d _) { |
796 | push @dirs, $entry; |
791 | push @dirs, $entry; |
797 | |
792 | |
798 | unless (--$ndirs) { |
793 | unless (--$ndirs) { |
799 | push @nondirs, @$entries; |
794 | push @nondirs, @$entries; |
800 | feed $statgrp; |
795 | feed $statgrp; |
801 | } |
|
|
802 | } else { |
|
|
803 | push @nondirs, $entry; |
|
|
804 | } |
796 | } |
|
|
797 | } else { |
|
|
798 | push @nondirs, $entry; |
805 | } |
799 | } |
806 | } |
800 | } |
807 | }; |
801 | } |
808 | }; |
802 | }; |
809 | }; |
803 | }; |
810 | }; |
804 | }; |
811 | }; |
805 | }; |
812 | |
|
|
813 | $grp |
|
|
814 | } |
806 | }; |
|
|
807 | |
|
|
808 | $grp |
815 | } |
809 | } |
816 | |
810 | |
817 | =item aio_rmtree $path, $callback->($status) |
811 | =item aio_rmtree $path, $callback->($status) |
818 | |
812 | |
819 | Delete a directory tree starting (and including) C<$path>, return the |
813 | Delete a directory tree starting (and including) C<$path>, return the |
… | |
… | |
823 | |
817 | |
824 | =cut |
818 | =cut |
825 | |
819 | |
826 | sub aio_rmtree; |
820 | sub aio_rmtree; |
827 | sub aio_rmtree($;$) { |
821 | sub aio_rmtree($;$) { |
828 | aio_block { |
|
|
829 | my ($path, $cb) = @_; |
822 | my ($path, $cb) = @_; |
830 | |
823 | |
831 | my $pri = aioreq_pri; |
824 | my $pri = aioreq_pri; |
832 | my $grp = aio_group $cb; |
825 | my $grp = aio_group $cb; |
833 | |
826 | |
834 | aioreq_pri $pri; |
827 | aioreq_pri $pri; |
835 | add $grp aio_scandir $path, 0, sub { |
828 | add $grp aio_scandir $path, 0, sub { |
836 | my ($dirs, $nondirs) = @_; |
829 | my ($dirs, $nondirs) = @_; |
837 | |
830 | |
838 | my $dirgrp = aio_group sub { |
831 | my $dirgrp = aio_group sub { |
839 | add $grp aio_rmdir $path, sub { |
832 | add $grp aio_rmdir $path, sub { |
840 | $grp->result ($_[0]); |
833 | $grp->result ($_[0]); |
841 | }; |
|
|
842 | }; |
834 | }; |
843 | |
|
|
844 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
845 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
846 | |
|
|
847 | add $grp $dirgrp; |
|
|
848 | }; |
835 | }; |
849 | |
836 | |
850 | $grp |
837 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
838 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
839 | |
|
|
840 | add $grp $dirgrp; |
851 | } |
841 | }; |
|
|
842 | |
|
|
843 | $grp |
852 | } |
844 | } |
853 | |
845 | |
854 | =item aio_sync $callback->($status) |
846 | =item aio_sync $callback->($status) |
855 | |
847 | |
856 | Asynchronously call sync and call the callback when finished. |
848 | Asynchronously call sync and call the callback when finished. |
… | |
… | |
866 | callback with the fdatasync result code. |
858 | callback with the fdatasync result code. |
867 | |
859 | |
868 | If this call isn't available because your OS lacks it or it couldn't be |
860 | If this call isn't available because your OS lacks it or it couldn't be |
869 | detected, it will be emulated by calling C<fsync> instead. |
861 | detected, it will be emulated by calling C<fsync> instead. |
870 | |
862 | |
|
|
863 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
864 | |
|
|
865 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
866 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
867 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
868 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
869 | |
|
|
870 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
871 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
872 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
873 | manpage for details. |
|
|
874 | |
871 | =item aio_pathsync $path, $callback->($status) |
875 | =item aio_pathsync $path, $callback->($status) |
872 | |
876 | |
873 | This request tries to open, fsync and close the given path. This is a |
877 | This request tries to open, fsync and close the given path. This is a |
874 | composite request intended tosync directories after directory operations |
878 | composite request intended to sync directories after directory operations |
875 | (E.g. rename). This might not work on all operating systems or have any |
879 | (E.g. rename). This might not work on all operating systems or have any |
876 | specific effect, but usually it makes sure that directory changes get |
880 | specific effect, but usually it makes sure that directory changes get |
877 | written to disc. It works for anything that can be opened for read-only, |
881 | written to disc. It works for anything that can be opened for read-only, |
878 | not just directories. |
882 | not just directories. |
879 | |
883 | |
880 | Passes C<0> when everything went ok, and C<-1> on error. |
884 | Passes C<0> when everything went ok, and C<-1> on error. |
881 | |
885 | |
882 | =cut |
886 | =cut |
883 | |
887 | |
884 | sub aio_pathsync($;$) { |
888 | sub aio_pathsync($;$) { |
885 | aio_block { |
|
|
886 | my ($path, $cb) = @_; |
889 | my ($path, $cb) = @_; |
887 | |
890 | |
888 | my $pri = aioreq_pri; |
891 | my $pri = aioreq_pri; |
889 | my $grp = aio_group $cb; |
892 | my $grp = aio_group $cb; |
890 | |
893 | |
891 | aioreq_pri $pri; |
894 | aioreq_pri $pri; |
892 | add $grp aio_open $path, O_RDONLY, 0, sub { |
895 | add $grp aio_open $path, O_RDONLY, 0, sub { |
893 | my ($fh) = @_; |
896 | my ($fh) = @_; |
894 | if ($fh) { |
897 | if ($fh) { |
|
|
898 | aioreq_pri $pri; |
|
|
899 | add $grp aio_fsync $fh, sub { |
|
|
900 | $grp->result ($_[0]); |
|
|
901 | |
895 | aioreq_pri $pri; |
902 | aioreq_pri $pri; |
896 | add $grp aio_fsync $fh, sub { |
|
|
897 | $grp->result ($_[0]); |
|
|
898 | |
|
|
899 | aioreq_pri $pri; |
|
|
900 | add $grp aio_close $fh; |
903 | add $grp aio_close $fh; |
901 | }; |
|
|
902 | } else { |
|
|
903 | $grp->result (-1); |
|
|
904 | } |
904 | }; |
|
|
905 | } else { |
|
|
906 | $grp->result (-1); |
905 | }; |
907 | } |
906 | |
|
|
907 | $grp |
|
|
908 | } |
908 | }; |
|
|
909 | |
|
|
910 | $grp |
909 | } |
911 | } |
910 | |
912 | |
911 | =item aio_group $callback->(...) |
913 | =item aio_group $callback->(...) |
912 | |
914 | |
913 | This is a very special aio request: Instead of doing something, it is a |
915 | This is a very special aio request: Instead of doing something, it is a |
… | |
… | |
1026 | Their lifetime, simplified, looks like this: when they are empty, they |
1028 | Their lifetime, simplified, looks like this: when they are empty, they |
1027 | will finish very quickly. If they contain only requests that are in the |
1029 | will finish very quickly. If they contain only requests that are in the |
1028 | C<done> state, they will also finish. Otherwise they will continue to |
1030 | C<done> state, they will also finish. Otherwise they will continue to |
1029 | exist. |
1031 | exist. |
1030 | |
1032 | |
1031 | That means after creating a group you have some time to add requests. And |
1033 | That means after creating a group you have some time to add requests |
1032 | in the callbacks of those requests, you can add further requests to the |
1034 | (precisely before the callback has been invoked, which is only done within |
1033 | group. And only when all those requests have finished will the the group |
1035 | the C<poll_cb>). And in the callbacks of those requests, you can add |
1034 | itself finish. |
1036 | further requests to the group. And only when all those requests have |
|
|
1037 | finished will the the group itself finish. |
1035 | |
1038 | |
1036 | =over 4 |
1039 | =over 4 |
1037 | |
1040 | |
1038 | =item add $grp ... |
1041 | =item add $grp ... |
1039 | |
1042 | |
… | |
… | |
1072 | =item feed $grp $callback->($grp) |
1075 | =item feed $grp $callback->($grp) |
1073 | |
1076 | |
1074 | Sets a feeder/generator on this group: every group can have an attached |
1077 | Sets a feeder/generator on this group: every group can have an attached |
1075 | generator that generates requests if idle. The idea behind this is that, |
1078 | generator that generates requests if idle. The idea behind this is that, |
1076 | although you could just queue as many requests as you want in a group, |
1079 | although you could just queue as many requests as you want in a group, |
1077 | this might starve other requests for a potentially long time. For |
1080 | this might starve other requests for a potentially long time. For example, |
1078 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1081 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1079 | requests, delaying any later requests for a long time. |
1082 | delaying any later requests for a long time. |
1080 | |
1083 | |
1081 | To avoid this, and allow incremental generation of requests, you can |
1084 | To avoid this, and allow incremental generation of requests, you can |
1082 | instead a group and set a feeder on it that generates those requests. The |
1085 | instead a group and set a feeder on it that generates those requests. The |
1083 | feed callback will be called whenever there are few enough (see C<limit>, |
1086 | feed callback will be called whenever there are few enough (see C<limit>, |
1084 | below) requests active in the group itself and is expected to queue more |
1087 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1088 | not impose any limits). |
1091 | not impose any limits). |
1089 | |
1092 | |
1090 | If the feed does not queue more requests when called, it will be |
1093 | If the feed does not queue more requests when called, it will be |
1091 | automatically removed from the group. |
1094 | automatically removed from the group. |
1092 | |
1095 | |
1093 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1096 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1097 | C<2> automatically. |
1094 | |
1098 | |
1095 | Example: |
1099 | Example: |
1096 | |
1100 | |
1097 | # stat all files in @files, but only ever use four aio requests concurrently: |
1101 | # stat all files in @files, but only ever use four aio requests concurrently: |
1098 | |
1102 | |
… | |
… | |
1110 | Sets the feeder limit for the group: The feeder will be called whenever |
1114 | Sets the feeder limit for the group: The feeder will be called whenever |
1111 | the group contains less than this many requests. |
1115 | the group contains less than this many requests. |
1112 | |
1116 | |
1113 | Setting the limit to C<0> will pause the feeding process. |
1117 | Setting the limit to C<0> will pause the feeding process. |
1114 | |
1118 | |
|
|
1119 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1120 | automatically bumps it up to C<2>. |
|
|
1121 | |
1115 | =back |
1122 | =back |
1116 | |
1123 | |
1117 | =head2 SUPPORT FUNCTIONS |
1124 | =head2 SUPPORT FUNCTIONS |
1118 | |
1125 | |
1119 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1126 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1130 | See C<poll_cb> for an example. |
1137 | See C<poll_cb> for an example. |
1131 | |
1138 | |
1132 | =item IO::AIO::poll_cb |
1139 | =item IO::AIO::poll_cb |
1133 | |
1140 | |
1134 | Process some outstanding events on the result pipe. You have to call this |
1141 | Process some outstanding events on the result pipe. You have to call this |
1135 | regularly. Returns the number of events processed. Returns immediately |
1142 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1143 | returned earlier for whatever reason. Returns immediately when no events |
1136 | when no events are outstanding. The amount of events processed depends on |
1144 | are outstanding. The amount of events processed depends on the settings of |
1137 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1145 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1138 | |
1146 | |
1139 | If not all requests were processed for whatever reason, the filehandle |
1147 | If not all requests were processed for whatever reason, the filehandle |
1140 | will still be ready when C<poll_cb> returns. |
1148 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1149 | do anything special to have it called later. |
1141 | |
1150 | |
1142 | Example: Install an Event watcher that automatically calls |
1151 | Example: Install an Event watcher that automatically calls |
1143 | IO::AIO::poll_cb with high priority: |
1152 | IO::AIO::poll_cb with high priority: |
1144 | |
1153 | |
1145 | Event->io (fd => IO::AIO::poll_fileno, |
1154 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1259 | |
1268 | |
1260 | The default is probably ok in most situations, especially if thread |
1269 | The default is probably ok in most situations, especially if thread |
1261 | creation is fast. If thread creation is very slow on your system you might |
1270 | creation is fast. If thread creation is very slow on your system you might |
1262 | want to use larger values. |
1271 | want to use larger values. |
1263 | |
1272 | |
1264 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1273 | =item IO::AIO::max_outstanding $maxreqs |
1265 | |
1274 | |
1266 | This is a very bad function to use in interactive programs because it |
1275 | This is a very bad function to use in interactive programs because it |
1267 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1276 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1268 | use an C<aio_group> together with a feed callback. |
1277 | use an C<aio_group> together with a feed callback. |
1269 | |
1278 | |
… | |
… | |
1274 | |
1283 | |
1275 | The default value is very large, so there is no practical limit on the |
1284 | The default value is very large, so there is no practical limit on the |
1276 | number of outstanding requests. |
1285 | number of outstanding requests. |
1277 | |
1286 | |
1278 | You can still queue as many requests as you want. Therefore, |
1287 | You can still queue as many requests as you want. Therefore, |
1279 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1288 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1280 | as a stop gap to shield against fatal memory overflow (with large values). |
1289 | as a stop gap to shield against fatal memory overflow (with large values). |
1281 | |
1290 | |
1282 | =back |
1291 | =back |
1283 | |
1292 | |
1284 | =head3 STATISTICAL INFORMATION |
1293 | =head3 STATISTICAL INFORMATION |
… | |
… | |
1354 | |
1363 | |
1355 | Known bugs will be fixed in the next release. |
1364 | Known bugs will be fixed in the next release. |
1356 | |
1365 | |
1357 | =head1 SEE ALSO |
1366 | =head1 SEE ALSO |
1358 | |
1367 | |
1359 | L<Coro::AIO>. |
1368 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1369 | more natural syntax. |
1360 | |
1370 | |
1361 | =head1 AUTHOR |
1371 | =head1 AUTHOR |
1362 | |
1372 | |
1363 | Marc Lehmann <schmorp@schmorp.de> |
1373 | Marc Lehmann <schmorp@schmorp.de> |
1364 | http://home.schmorp.de/ |
1374 | http://home.schmorp.de/ |