ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.122 by root, Sat Apr 26 12:00:23 2008 UTC vs.
Revision 1.147 by root, Wed Jun 3 12:24:49 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines