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.115 by root, Mon Sep 24 18:14:00 2007 UTC vs.
Revision 1.143 by root, Thu Nov 20 09:01:40 2008 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, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
31 # AnyEvent integration 34 # EV integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 36
35 # Event integration 37 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 39 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
… …
183 185
184=cut 186=cut
185 187
186package IO::AIO; 188package IO::AIO;
187 189
190use Carp ();
191
188no warnings; 192no warnings;
189use strict 'vars'; 193use strict 'vars';
190 194
191use base 'Exporter'; 195use base 'Exporter';
192 196
193BEGIN { 197BEGIN {
194 our $VERSION = '2.41'; 198 our $VERSION = '3.17';
195 199
196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group
199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir 205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 211 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
206 215
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208 217
209 require XSLoader; 218 require XSLoader;
210 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
217All 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
218with 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,
219and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
220which 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
221the 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
222perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 232syscall has been executed asynchronously.
224 233
225All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 235internally until the request has finished.
227 236
… …
241your 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
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
244 253
245This 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
246handles correctly wether it is set or not. 255handles correctly whether it is set or not.
247 256
248=over 4 257=over 4
249 258
250=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
251 260
… …
311 320
312 321
313=item aio_close $fh, $callback->($status) 322=item aio_close $fh, $callback->($status)
314 323
315Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
316code. I<WARNING:> although accepted, you should not pass in a perl 325code.
317filehandle here, as perl will likely close the file descriptor another
318time when the filehandle is destroyed. Normally, you can safely call perls
319C<close> or just let filehandles go out of scope.
320 326
321This is supposed to be a bug in the API, so that might change. It's 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 328closing the file descriptor associated with the filehandle itself.
323 329
330Therefore, C<aio_close> will not close the filehandle - instead it will
331use dup2 to overwrite the file descriptor with the write-end of a pipe
332(the pipe fd will be created on demand and will be cached).
333
334Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed.
336
337=cut
324 338
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 340
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 342
… …
527memory. Status is the same as with aio_read. 541memory. Status is the same as with aio_read.
528 542
529=cut 543=cut
530 544
531sub aio_load($$;$) { 545sub aio_load($$;$) {
532 aio_block {
533 my ($path, undef, $cb) = @_; 546 my ($path, undef, $cb) = @_;
534 my $data = \$_[1]; 547 my $data = \$_[1];
535 548
536 my $pri = aioreq_pri; 549 my $pri = aioreq_pri;
537 my $grp = aio_group $cb; 550 my $grp = aio_group $cb;
551
552 aioreq_pri $pri;
553 add $grp aio_open $path, O_RDONLY, 0, sub {
554 my $fh = shift
555 or return $grp->result (-1);
538 556
539 aioreq_pri $pri; 557 aioreq_pri $pri;
540 add $grp aio_open $path, O_RDONLY, 0, sub {
541 my $fh = shift
542 or return $grp->result (-1);
543
544 aioreq_pri $pri;
545 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
546 $grp->result ($_[0]); 559 $grp->result ($_[0]);
547 };
548 }; 560 };
549
550 $grp
551 } 561 };
562
563 $grp
552} 564}
553 565
554=item aio_copy $srcpath, $dstpath, $callback->($status) 566=item aio_copy $srcpath, $dstpath, $callback->($status)
555 567
556Try to copy the I<file> (directories not supported as either source or 568Try to copy the I<file> (directories not supported as either source or
557destination) from C<$srcpath> to C<$dstpath> and call the callback with 569destination) from C<$srcpath> to C<$dstpath> and call the callback with
558the C<0> (error) or C<-1> ok. 570the C<0> (error) or C<-1> ok.
559 571
560This is a composite request that it creates the destination file with 572This is a composite request that creates the destination file with
561mode 0200 and copies the contents of the source file into it using 573mode 0200 and copies the contents of the source file into it using
562C<aio_sendfile>, followed by restoring atime, mtime, access mode and 574C<aio_sendfile>, followed by restoring atime, mtime, access mode and
563uid/gid, in that order. 575uid/gid, in that order.
564 576
565If an error occurs, the partial destination file will be unlinked, if 577If an error occurs, the partial destination file will be unlinked, if
… …
567errors are being ignored. 579errors are being ignored.
568 580
569=cut 581=cut
570 582
571sub aio_copy($$;$) { 583sub aio_copy($$;$) {
572 aio_block {
573 my ($src, $dst, $cb) = @_; 584 my ($src, $dst, $cb) = @_;
574 585
575 my $pri = aioreq_pri; 586 my $pri = aioreq_pri;
576 my $grp = aio_group $cb; 587 my $grp = aio_group $cb;
577 588
578 aioreq_pri $pri; 589 aioreq_pri $pri;
579 add $grp aio_open $src, O_RDONLY, 0, sub { 590 add $grp aio_open $src, O_RDONLY, 0, sub {
580 if (my $src_fh = $_[0]) { 591 if (my $src_fh = $_[0]) {
581 my @stat = stat $src_fh; 592 my @stat = stat $src_fh;
582 593
583 aioreq_pri $pri; 594 aioreq_pri $pri;
584 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 595 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
585 if (my $dst_fh = $_[0]) { 596 if (my $dst_fh = $_[0]) {
586 aioreq_pri $pri; 597 aioreq_pri $pri;
587 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 598 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
588 if ($_[0] == $stat[7]) { 599 if ($_[0] == $stat[7]) {
589 $grp->result (0); 600 $grp->result (0);
590 close $src_fh; 601 close $src_fh;
591 602
592 # those should not normally block. should. should. 603 # those should not normally block. should. should.
593 utime $stat[8], $stat[9], $dst; 604 utime $stat[8], $stat[9], $dst;
594 chmod $stat[2] & 07777, $dst_fh; 605 chmod $stat[2] & 07777, $dst_fh;
595 chown $stat[4], $stat[5], $dst_fh; 606 chown $stat[4], $stat[5], $dst_fh;
607
608 aioreq_pri $pri;
596 close $dst_fh; 609 add $grp aio_close $dst_fh;
597 } else { 610 } else {
598 $grp->result (-1); 611 $grp->result (-1);
599 close $src_fh; 612 close $src_fh;
600 close $dst_fh; 613 close $dst_fh;
601 614
602 aioreq $pri; 615 aioreq $pri;
603 add $grp aio_unlink $dst; 616 add $grp aio_unlink $dst;
604 }
605 }; 617 }
606 } else {
607 $grp->result (-1);
608 } 618 };
619 } else {
620 $grp->result (-1);
609 }, 621 }
610
611 } else {
612 $grp->result (-1);
613 } 622 },
623
624 } else {
625 $grp->result (-1);
614 }; 626 }
615
616 $grp
617 } 627 };
628
629 $grp
618} 630}
619 631
620=item aio_move $srcpath, $dstpath, $callback->($status) 632=item aio_move $srcpath, $dstpath, $callback->($status)
621 633
622Try to move the I<file> (directories not supported as either source or 634Try to move the I<file> (directories not supported as either source or
623destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
624the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
625 637
626This is a composite request that tries to rename(2) the file first. If 638This is a composite request that tries to rename(2) the file first; if
627rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 639rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
628that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
629 641
630=cut 642=cut
631 643
632sub aio_move($$;$) { 644sub aio_move($$;$) {
633 aio_block {
634 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
635 646
636 my $pri = aioreq_pri; 647 my $pri = aioreq_pri;
637 my $grp = aio_group $cb; 648 my $grp = aio_group $cb;
638 649
639 aioreq_pri $pri; 650 aioreq_pri $pri;
640 add $grp aio_rename $src, $dst, sub { 651 add $grp aio_rename $src, $dst, sub {
641 if ($_[0] && $! == EXDEV) { 652 if ($_[0] && $! == EXDEV) {
642 aioreq_pri $pri; 653 aioreq_pri $pri;
643 add $grp aio_copy $src, $dst, sub { 654 add $grp aio_copy $src, $dst, sub {
644 $grp->result ($_[0]);
645
646 if (!$_[0]) {
647 aioreq_pri $pri;
648 add $grp aio_unlink $src;
649 }
650 };
651 } else {
652 $grp->result ($_[0]); 655 $grp->result ($_[0]);
656
657 if (!$_[0]) {
658 aioreq_pri $pri;
659 add $grp aio_unlink $src;
660 }
653 } 661 };
662 } else {
663 $grp->result ($_[0]);
654 }; 664 }
655
656 $grp
657 } 665 };
666
667 $grp
658} 668}
659 669
660=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 670=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
661 671
662Scans a directory (similar to C<aio_readdir>) but additionally tries to 672Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
710directory counting heuristic. 720directory counting heuristic.
711 721
712=cut 722=cut
713 723
714sub aio_scandir($$;$) { 724sub aio_scandir($$;$) {
715 aio_block {
716 my ($path, $maxreq, $cb) = @_; 725 my ($path, $maxreq, $cb) = @_;
717 726
718 my $pri = aioreq_pri; 727 my $pri = aioreq_pri;
719 728
720 my $grp = aio_group $cb; 729 my $grp = aio_group $cb;
721 730
722 $maxreq = 4 if $maxreq <= 0; 731 $maxreq = 4 if $maxreq <= 0;
723 732
724 # stat once 733 # stat once
734 aioreq_pri $pri;
735 add $grp aio_stat $path, sub {
736 return $grp->result () if $_[0];
737 my $now = time;
738 my $hash1 = join ":", (stat _)[0,1,3,7,9];
739
740 # read the directory entries
725 aioreq_pri $pri; 741 aioreq_pri $pri;
726 add $grp aio_stat $path, sub { 742 add $grp aio_readdir $path, sub {
743 my $entries = shift
727 return $grp->result () if $_[0]; 744 or return $grp->result ();
728 my $now = time;
729 my $hash1 = join ":", (stat _)[0,1,3,7,9];
730 745
731 # read the directory entries 746 # stat the dir another time
732 aioreq_pri $pri; 747 aioreq_pri $pri;
733 add $grp aio_readdir $path, sub {
734 my $entries = shift
735 or return $grp->result ();
736
737 # stat the dir another time
738 aioreq_pri $pri;
739 add $grp aio_stat $path, sub { 748 add $grp aio_stat $path, sub {
740 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 749 my $hash2 = join ":", (stat _)[0,1,3,7,9];
741 750
742 my $ndirs; 751 my $ndirs;
743 752
744 # take the slow route if anything looks fishy 753 # take the slow route if anything looks fishy
745 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 754 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
746 $ndirs = -1; 755 $ndirs = -1;
747 } else { 756 } else {
748 # if nlink == 2, we are finished 757 # if nlink == 2, we are finished
749 # on non-posix-fs's, we rely on nlink < 2 758 # on non-posix-fs's, we rely on nlink < 2
750 $ndirs = (stat _)[3] - 2 759 $ndirs = (stat _)[3] - 2
751 or return $grp->result ([], $entries); 760 or return $grp->result ([], $entries);
752 } 761 }
753 762
754 # sort into likely dirs and likely nondirs 763 # sort into likely dirs and likely nondirs
755 # dirs == files without ".", short entries first 764 # dirs == files without ".", short entries first
756 $entries = [map $_->[0], 765 $entries = [map $_->[0],
757 sort { $b->[1] cmp $a->[1] } 766 sort { $b->[1] cmp $a->[1] }
758 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 767 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
759 @$entries]; 768 @$entries];
760 769
761 my (@dirs, @nondirs); 770 my (@dirs, @nondirs);
762 771
763 my $statgrp = add $grp aio_group sub { 772 my $statgrp = add $grp aio_group sub {
764 $grp->result (\@dirs, \@nondirs); 773 $grp->result (\@dirs, \@nondirs);
765 }; 774 };
766 775
767 limit $statgrp $maxreq; 776 limit $statgrp $maxreq;
768 feed $statgrp sub { 777 feed $statgrp sub {
769 return unless @$entries; 778 return unless @$entries;
770 my $entry = pop @$entries; 779 my $entry = pop @$entries;
771 780
772 aioreq_pri $pri; 781 aioreq_pri $pri;
773 add $statgrp aio_stat "$path/$entry/.", sub { 782 add $statgrp aio_stat "$path/$entry/.", sub {
774 if ($_[0] < 0) { 783 if ($_[0] < 0) {
775 push @nondirs, $entry; 784 push @nondirs, $entry;
776 } else { 785 } else {
777 # need to check for real directory 786 # need to check for real directory
778 aioreq_pri $pri; 787 aioreq_pri $pri;
779 add $statgrp aio_lstat "$path/$entry", sub { 788 add $statgrp aio_lstat "$path/$entry", sub {
780 if (-d _) { 789 if (-d _) {
781 push @dirs, $entry; 790 push @dirs, $entry;
782 791
783 unless (--$ndirs) { 792 unless (--$ndirs) {
784 push @nondirs, @$entries; 793 push @nondirs, @$entries;
785 feed $statgrp; 794 feed $statgrp;
786 }
787 } else {
788 push @nondirs, $entry;
789 } 795 }
796 } else {
797 push @nondirs, $entry;
790 } 798 }
791 } 799 }
792 }; 800 }
793 }; 801 };
794 }; 802 };
795 }; 803 };
796 }; 804 };
797
798 $grp
799 } 805 };
806
807 $grp
800} 808}
801 809
802=item aio_rmtree $path, $callback->($status) 810=item aio_rmtree $path, $callback->($status)
803 811
804Delete a directory tree starting (and including) C<$path>, return the 812Delete a directory tree starting (and including) C<$path>, return the
… …
808 816
809=cut 817=cut
810 818
811sub aio_rmtree; 819sub aio_rmtree;
812sub aio_rmtree($;$) { 820sub aio_rmtree($;$) {
813 aio_block {
814 my ($path, $cb) = @_; 821 my ($path, $cb) = @_;
815 822
816 my $pri = aioreq_pri; 823 my $pri = aioreq_pri;
817 my $grp = aio_group $cb; 824 my $grp = aio_group $cb;
818 825
819 aioreq_pri $pri; 826 aioreq_pri $pri;
820 add $grp aio_scandir $path, 0, sub { 827 add $grp aio_scandir $path, 0, sub {
821 my ($dirs, $nondirs) = @_; 828 my ($dirs, $nondirs) = @_;
822 829
823 my $dirgrp = aio_group sub { 830 my $dirgrp = aio_group sub {
824 add $grp aio_rmdir $path, sub { 831 add $grp aio_rmdir $path, sub {
825 $grp->result ($_[0]); 832 $grp->result ($_[0]);
826 };
827 }; 833 };
828
829 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
830 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
831
832 add $grp $dirgrp;
833 }; 834 };
834 835
835 $grp 836 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
837 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
838
839 add $grp $dirgrp;
836 } 840 };
841
842 $grp
837} 843}
844
845=item aio_sync $callback->($status)
846
847Asynchronously call sync and call the callback when finished.
838 848
839=item aio_fsync $fh, $callback->($status) 849=item aio_fsync $fh, $callback->($status)
840 850
841Asynchronously call fsync on the given filehandle and call the callback 851Asynchronously call fsync on the given filehandle and call the callback
842with the fsync result code. 852with the fsync result code.
… …
846Asynchronously call fdatasync on the given filehandle and call the 856Asynchronously call fdatasync on the given filehandle and call the
847callback with the fdatasync result code. 857callback with the fdatasync result code.
848 858
849If this call isn't available because your OS lacks it or it couldn't be 859If this call isn't available because your OS lacks it or it couldn't be
850detected, it will be emulated by calling C<fsync> instead. 860detected, it will be emulated by calling C<fsync> instead.
861
862=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
863
864Sync the data portion of the file specified by C<$offset> and C<$length>
865to disk (but NOT the metadata), by calling the Linux-specific
866sync_file_range call. If sync_file_range is not available or it returns
867ENOSYS, then fdatasync or fsync is being substituted.
868
869C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
870C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
871C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
872manpage for details.
873
874=item aio_pathsync $path, $callback->($status)
875
876This request tries to open, fsync and close the given path. This is a
877composite request intended to sync directories after directory operations
878(E.g. rename). This might not work on all operating systems or have any
879specific effect, but usually it makes sure that directory changes get
880written to disc. It works for anything that can be opened for read-only,
881not just directories.
882
883Passes C<0> when everything went ok, and C<-1> on error.
884
885=cut
886
887sub aio_pathsync($;$) {
888 my ($path, $cb) = @_;
889
890 my $pri = aioreq_pri;
891 my $grp = aio_group $cb;
892
893 aioreq_pri $pri;
894 add $grp aio_open $path, O_RDONLY, 0, sub {
895 my ($fh) = @_;
896 if ($fh) {
897 aioreq_pri $pri;
898 add $grp aio_fsync $fh, sub {
899 $grp->result ($_[0]);
900
901 aioreq_pri $pri;
902 add $grp aio_close $fh;
903 };
904 } else {
905 $grp->result (-1);
906 }
907 };
908
909 $grp
910}
851 911
852=item aio_group $callback->(...) 912=item aio_group $callback->(...)
853 913
854This is a very special aio request: Instead of doing something, it is a 914This is a very special aio request: Instead of doing something, it is a
855container for other aio requests, which is useful if you want to bundle 915container for other aio requests, which is useful if you want to bundle
… …
967Their lifetime, simplified, looks like this: when they are empty, they 1027Their lifetime, simplified, looks like this: when they are empty, they
968will finish very quickly. If they contain only requests that are in the 1028will finish very quickly. If they contain only requests that are in the
969C<done> state, they will also finish. Otherwise they will continue to 1029C<done> state, they will also finish. Otherwise they will continue to
970exist. 1030exist.
971 1031
972That means after creating a group you have some time to add requests. And 1032That means after creating a group you have some time to add requests
973in the callbacks of those requests, you can add further requests to the 1033(precisely before the callback has been invoked, which is only done within
974group. And only when all those requests have finished will the the group 1034the C<poll_cb>). And in the callbacks of those requests, you can add
975itself finish. 1035further requests to the group. And only when all those requests have
1036finished will the the group itself finish.
976 1037
977=over 4 1038=over 4
978 1039
979=item add $grp ... 1040=item add $grp ...
980 1041
… …
992itself. Useful when you queued a lot of events but got a result early. 1053itself. Useful when you queued a lot of events but got a result early.
993 1054
994=item $grp->result (...) 1055=item $grp->result (...)
995 1056
996Set the result value(s) that will be passed to the group callback when all 1057Set the result value(s) that will be passed to the group callback when all
997subrequests have finished and set thre groups errno to the current value 1058subrequests have finished and set the groups errno to the current value
998of errno (just like calling C<errno> without an error number). By default, 1059of errno (just like calling C<errno> without an error number). By default,
999no argument will be passed and errno is zero. 1060no argument will be passed and errno is zero.
1000 1061
1001=item $grp->errno ([$errno]) 1062=item $grp->errno ([$errno])
1002 1063
… …
1013=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1014 1075
1015Sets a feeder/generator on this group: every group can have an attached 1076Sets a feeder/generator on this group: every group can have an attached
1016generator that generates requests if idle. The idea behind this is that, 1077generator that generates requests if idle. The idea behind this is that,
1017although you could just queue as many requests as you want in a group, 1078although you could just queue as many requests as you want in a group,
1018this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1019example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1020requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1021 1082
1022To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1023instead a group and set a feeder on it that generates those requests. The 1084instead a group and set a feeder on it that generates those requests. The
1024feed callback will be called whenever there are few enough (see C<limit>, 1085feed callback will be called whenever there are few enough (see C<limit>,
1025below) requests active in the group itself and is expected to queue more 1086below) requests active in the group itself and is expected to queue more
… …
1029not impose any limits). 1090not impose any limits).
1030 1091
1031If the feed does not queue more requests when called, it will be 1092If the feed does not queue more requests when called, it will be
1032automatically removed from the group. 1093automatically removed from the group.
1033 1094
1034If the feed limit is C<0>, it will be set to C<2> automatically. 1095If the feed limit is C<0> when this method is called, it will be set to
1096C<2> automatically.
1035 1097
1036Example: 1098Example:
1037 1099
1038 # stat all files in @files, but only ever use four aio requests concurrently: 1100 # stat all files in @files, but only ever use four aio requests concurrently:
1039 1101
… …
1051Sets the feeder limit for the group: The feeder will be called whenever 1113Sets the feeder limit for the group: The feeder will be called whenever
1052the group contains less than this many requests. 1114the group contains less than this many requests.
1053 1115
1054Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1055 1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1120
1056=back 1121=back
1057 1122
1058=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1059 1124
1060=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1125=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1071See C<poll_cb> for an example. 1136See C<poll_cb> for an example.
1072 1137
1073=item IO::AIO::poll_cb 1138=item IO::AIO::poll_cb
1074 1139
1075Process some outstanding events on the result pipe. You have to call this 1140Process some outstanding events on the result pipe. You have to call this
1076regularly. Returns the number of events processed. Returns immediately 1141regularly. Returns C<0> if all events could be processed, or C<-1> if it
1142returned earlier for whatever reason. Returns immediately when no events
1077when no events are outstanding. The amount of events processed depends on 1143are outstanding. The amount of events processed depends on the settings of
1078the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1144C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1079 1145
1080If not all requests were processed for whatever reason, the filehandle 1146If not all requests were processed for whatever reason, the filehandle
1081will still be ready when C<poll_cb> returns. 1147will still be ready when C<poll_cb> returns, so normally you don't have to
1148do anything special to have it called later.
1082 1149
1083Example: Install an Event watcher that automatically calls 1150Example: Install an Event watcher that automatically calls
1084IO::AIO::poll_cb with high priority: 1151IO::AIO::poll_cb with high priority:
1085 1152
1086 Event->io (fd => IO::AIO::poll_fileno, 1153 Event->io (fd => IO::AIO::poll_fileno,
… …
1200 1267
1201The default is probably ok in most situations, especially if thread 1268The default is probably ok in most situations, especially if thread
1202creation is fast. If thread creation is very slow on your system you might 1269creation is fast. If thread creation is very slow on your system you might
1203want to use larger values. 1270want to use larger values.
1204 1271
1205=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1272=item IO::AIO::max_outstanding $maxreqs
1206 1273
1207This is a very bad function to use in interactive programs because it 1274This is a very bad function to use in interactive programs because it
1208blocks, and a bad way to reduce concurrency because it is inexact: Better 1275blocks, and a bad way to reduce concurrency because it is inexact: Better
1209use an C<aio_group> together with a feed callback. 1276use an C<aio_group> together with a feed callback.
1210 1277
… …
1215 1282
1216The default value is very large, so there is no practical limit on the 1283The default value is very large, so there is no practical limit on the
1217number of outstanding requests. 1284number of outstanding requests.
1218 1285
1219You can still queue as many requests as you want. Therefore, 1286You can still queue as many requests as you want. Therefore,
1220C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1287C<max_outstanding> is mainly useful in simple scripts (with low values) or
1221as a stop gap to shield against fatal memory overflow (with large values). 1288as a stop gap to shield against fatal memory overflow (with large values).
1222 1289
1223=back 1290=back
1224 1291
1225=head3 STATISTICAL INFORMATION 1292=head3 STATISTICAL INFORMATION
… …
1247but not yet processed by poll_cb). 1314but not yet processed by poll_cb).
1248 1315
1249=back 1316=back
1250 1317
1251=cut 1318=cut
1252
1253# support function to convert a fd into a perl filehandle
1254sub _fd2fh {
1255 return undef if $_[0] < 0;
1256
1257 # try to generate nice filehandles
1258 my $sym = "IO::AIO::fd#$_[0]";
1259 local *$sym;
1260
1261 open *$sym, "+<&=$_[0]" # usually works under any unix
1262 or open *$sym, "<&=$_[0]" # cygwin needs this
1263 or open *$sym, ">&=$_[0]" # or this
1264 or return undef;
1265
1266 *$sym
1267}
1268 1319
1269min_parallel 8; 1320min_parallel 8;
1270 1321
1271END { flush } 1322END { flush }
1272 1323
… …
1311 1362
1312Known bugs will be fixed in the next release. 1363Known bugs will be fixed in the next release.
1313 1364
1314=head1 SEE ALSO 1365=head1 SEE ALSO
1315 1366
1316L<Coro::AIO>. 1367L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1368more natural syntax.
1317 1369
1318=head1 AUTHOR 1370=head1 AUTHOR
1319 1371
1320 Marc Lehmann <schmorp@schmorp.de> 1372 Marc Lehmann <schmorp@schmorp.de>
1321 http://home.schmorp.de/ 1373 http://home.schmorp.de/

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines