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.111 by root, Mon Aug 13 12:08:13 2007 UTC vs.
Revision 1.138 by root, Sun Oct 12 21:51:33 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.4'; 198 our $VERSION = '3.1';
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_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);
206 213
… …
217All the C<aio_*> calls are more or less thin wrappers around the syscall 224All 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, 225with the same name (sans C<aio_>). The arguments are similar or identical,
219and they all accept an additional (and optional) C<$callback> argument 226and they all accept an additional (and optional) C<$callback> argument
220which must be a code reference. This code reference will get called with 227which 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 228the 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 229perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 230syscall has been executed asynchronously.
224 231
225All functions expecting a filehandle keep a copy of the filehandle 232All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 233internally until the request has finished.
227 234
… …
241your pathnames to the locale (or other) encoding in effect in the user 248your pathnames to the locale (or other) encoding in effect in the user
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 249environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 250use something else to ensure your scalar has the correct contents.
244 251
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO 252This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not. 253handles correctly whether it is set or not.
247 254
248=over 4 255=over 4
249 256
250=item $prev_pri = aioreq_pri [$pri] 257=item $prev_pri = aioreq_pri [$pri]
251 258
… …
311 318
312 319
313=item aio_close $fh, $callback->($status) 320=item aio_close $fh, $callback->($status)
314 321
315Asynchronously close a file and call the callback with the result 322Asynchronously close a file and call the callback with the result
316code. I<WARNING:> although accepted, you should not pass in a perl 323code.
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 324
321This is supposed to be a bug in the API, so that might change. It's 325Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 326closing the file descriptor associated with the filehandle itself.
323 327
328Therefore, C<aio_close> will not close the filehandle - instead it will
329use dup2 to overwrite the file descriptor with the write-end of a pipe
330(the pipe fd will be created on demand and will be cached).
331
332Or in other words: the file descriptor will be closed, but it will not be
333free for reuse until the perl filehandle is closed.
334
335=cut
324 336
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 337=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 338
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 340
329Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 341Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
330into the scalar given by C<$data> and offset C<$dataoffset> and calls the 342into the scalar given by C<$data> and offset C<$dataoffset> and calls the
331callback without the actual number of bytes read (or -1 on error, just 343callback without the actual number of bytes read (or -1 on error, just
332like the syscall). 344like the syscall).
333 345
334If C<$offset> is undefined, then the current file offset will be used (and 346If C<$offset> is undefined, then the current file descriptor offset will
335updated), otherwise the file offset will not be changed by these calls. 347be used (and updated), otherwise the file descriptor offset will not be
348changed by these calls.
336 349
337If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 350If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
338 351
339If C<$dataoffset> is less than zero, it will be counted from the end of 352If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>. 353C<$data>.
341 354
342The C<$data> scalar I<MUST NOT> be modified in any way while the request 355The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
526memory. Status is the same as with aio_read. 539memory. Status is the same as with aio_read.
527 540
528=cut 541=cut
529 542
530sub aio_load($$;$) { 543sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_; 544 my ($path, undef, $cb) = @_;
533 my $data = \$_[1]; 545 my $data = \$_[1];
534 546
535 my $pri = aioreq_pri; 547 my $pri = aioreq_pri;
536 my $grp = aio_group $cb; 548 my $grp = aio_group $cb;
549
550 aioreq_pri $pri;
551 add $grp aio_open $path, O_RDONLY, 0, sub {
552 my $fh = shift
553 or return $grp->result (-1);
537 554
538 aioreq_pri $pri; 555 aioreq_pri $pri;
539 add $grp aio_open $path, O_RDONLY, 0, sub {
540 my $fh = shift
541 or return $grp->result (-1);
542
543 aioreq_pri $pri;
544 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 556 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]); 557 $grp->result ($_[0]);
546 };
547 }; 558 };
548
549 $grp
550 } 559 };
560
561 $grp
551} 562}
552 563
553=item aio_copy $srcpath, $dstpath, $callback->($status) 564=item aio_copy $srcpath, $dstpath, $callback->($status)
554 565
555Try to copy the I<file> (directories not supported as either source or 566Try to copy the I<file> (directories not supported as either source or
556destination) from C<$srcpath> to C<$dstpath> and call the callback with 567destination) from C<$srcpath> to C<$dstpath> and call the callback with
557the C<0> (error) or C<-1> ok. 568the C<0> (error) or C<-1> ok.
558 569
559This is a composite request that it creates the destination file with 570This is a composite request that creates the destination file with
560mode 0200 and copies the contents of the source file into it using 571mode 0200 and copies the contents of the source file into it using
561C<aio_sendfile>, followed by restoring atime, mtime, access mode and 572C<aio_sendfile>, followed by restoring atime, mtime, access mode and
562uid/gid, in that order. 573uid/gid, in that order.
563 574
564If an error occurs, the partial destination file will be unlinked, if 575If an error occurs, the partial destination file will be unlinked, if
… …
566errors are being ignored. 577errors are being ignored.
567 578
568=cut 579=cut
569 580
570sub aio_copy($$;$) { 581sub aio_copy($$;$) {
571 aio_block {
572 my ($src, $dst, $cb) = @_; 582 my ($src, $dst, $cb) = @_;
573 583
574 my $pri = aioreq_pri; 584 my $pri = aioreq_pri;
575 my $grp = aio_group $cb; 585 my $grp = aio_group $cb;
576 586
577 aioreq_pri $pri; 587 aioreq_pri $pri;
578 add $grp aio_open $src, O_RDONLY, 0, sub { 588 add $grp aio_open $src, O_RDONLY, 0, sub {
579 if (my $src_fh = $_[0]) { 589 if (my $src_fh = $_[0]) {
580 my @stat = stat $src_fh; 590 my @stat = stat $src_fh;
581 591
582 aioreq_pri $pri; 592 aioreq_pri $pri;
583 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 593 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
584 if (my $dst_fh = $_[0]) { 594 if (my $dst_fh = $_[0]) {
585 aioreq_pri $pri; 595 aioreq_pri $pri;
586 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 596 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
587 if ($_[0] == $stat[7]) { 597 if ($_[0] == $stat[7]) {
588 $grp->result (0); 598 $grp->result (0);
589 close $src_fh; 599 close $src_fh;
590 600
591 # those should not normally block. should. should. 601 # those should not normally block. should. should.
592 utime $stat[8], $stat[9], $dst; 602 utime $stat[8], $stat[9], $dst;
593 chmod $stat[2] & 07777, $dst_fh; 603 chmod $stat[2] & 07777, $dst_fh;
594 chown $stat[4], $stat[5], $dst_fh; 604 chown $stat[4], $stat[5], $dst_fh;
605
606 aioreq_pri $pri;
595 close $dst_fh; 607 add $grp aio_close $dst_fh;
596 } else { 608 } else {
597 $grp->result (-1); 609 $grp->result (-1);
598 close $src_fh; 610 close $src_fh;
599 close $dst_fh; 611 close $dst_fh;
600 612
601 aioreq $pri; 613 aioreq $pri;
602 add $grp aio_unlink $dst; 614 add $grp aio_unlink $dst;
603 }
604 }; 615 }
605 } else {
606 $grp->result (-1);
607 } 616 };
617 } else {
618 $grp->result (-1);
608 }, 619 }
609
610 } else {
611 $grp->result (-1);
612 } 620 },
621
622 } else {
623 $grp->result (-1);
613 }; 624 }
614
615 $grp
616 } 625 };
626
627 $grp
617} 628}
618 629
619=item aio_move $srcpath, $dstpath, $callback->($status) 630=item aio_move $srcpath, $dstpath, $callback->($status)
620 631
621Try to move the I<file> (directories not supported as either source or 632Try to move the I<file> (directories not supported as either source or
622destination) from C<$srcpath> to C<$dstpath> and call the callback with 633destination) from C<$srcpath> to C<$dstpath> and call the callback with
623the C<0> (error) or C<-1> ok. 634the C<0> (error) or C<-1> ok.
624 635
625This is a composite request that tries to rename(2) the file first. If 636This is a composite request that tries to rename(2) the file first; if
626rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 637rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
627that is successful, unlinking the C<$srcpath>. 638that is successful, unlinks the C<$srcpath>.
628 639
629=cut 640=cut
630 641
631sub aio_move($$;$) { 642sub aio_move($$;$) {
632 aio_block {
633 my ($src, $dst, $cb) = @_; 643 my ($src, $dst, $cb) = @_;
634 644
635 my $pri = aioreq_pri; 645 my $pri = aioreq_pri;
636 my $grp = aio_group $cb; 646 my $grp = aio_group $cb;
637 647
638 aioreq_pri $pri; 648 aioreq_pri $pri;
639 add $grp aio_rename $src, $dst, sub { 649 add $grp aio_rename $src, $dst, sub {
640 if ($_[0] && $! == EXDEV) { 650 if ($_[0] && $! == EXDEV) {
641 aioreq_pri $pri; 651 aioreq_pri $pri;
642 add $grp aio_copy $src, $dst, sub { 652 add $grp aio_copy $src, $dst, sub {
643 $grp->result ($_[0]);
644
645 if (!$_[0]) {
646 aioreq_pri $pri;
647 add $grp aio_unlink $src;
648 }
649 };
650 } else {
651 $grp->result ($_[0]); 653 $grp->result ($_[0]);
654
655 if (!$_[0]) {
656 aioreq_pri $pri;
657 add $grp aio_unlink $src;
658 }
652 } 659 };
660 } else {
661 $grp->result ($_[0]);
653 }; 662 }
654
655 $grp
656 } 663 };
664
665 $grp
657} 666}
658 667
659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 668=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
660 669
661Scans a directory (similar to C<aio_readdir>) but additionally tries to 670Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
709directory counting heuristic. 718directory counting heuristic.
710 719
711=cut 720=cut
712 721
713sub aio_scandir($$;$) { 722sub aio_scandir($$;$) {
714 aio_block {
715 my ($path, $maxreq, $cb) = @_; 723 my ($path, $maxreq, $cb) = @_;
716 724
717 my $pri = aioreq_pri; 725 my $pri = aioreq_pri;
718 726
719 my $grp = aio_group $cb; 727 my $grp = aio_group $cb;
720 728
721 $maxreq = 4 if $maxreq <= 0; 729 $maxreq = 4 if $maxreq <= 0;
722 730
723 # stat once 731 # stat once
732 aioreq_pri $pri;
733 add $grp aio_stat $path, sub {
734 return $grp->result () if $_[0];
735 my $now = time;
736 my $hash1 = join ":", (stat _)[0,1,3,7,9];
737
738 # read the directory entries
724 aioreq_pri $pri; 739 aioreq_pri $pri;
725 add $grp aio_stat $path, sub { 740 add $grp aio_readdir $path, sub {
741 my $entries = shift
726 return $grp->result () if $_[0]; 742 or return $grp->result ();
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
729 743
730 # read the directory entries 744 # stat the dir another time
731 aioreq_pri $pri; 745 aioreq_pri $pri;
732 add $grp aio_readdir $path, sub {
733 my $entries = shift
734 or return $grp->result ();
735
736 # stat the dir another time
737 aioreq_pri $pri;
738 add $grp aio_stat $path, sub { 746 add $grp aio_stat $path, sub {
739 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 747 my $hash2 = join ":", (stat _)[0,1,3,7,9];
740 748
741 my $ndirs; 749 my $ndirs;
742 750
743 # take the slow route if anything looks fishy 751 # take the slow route if anything looks fishy
744 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 752 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
745 $ndirs = -1; 753 $ndirs = -1;
746 } else { 754 } else {
747 # if nlink == 2, we are finished 755 # if nlink == 2, we are finished
748 # on non-posix-fs's, we rely on nlink < 2 756 # on non-posix-fs's, we rely on nlink < 2
749 $ndirs = (stat _)[3] - 2 757 $ndirs = (stat _)[3] - 2
750 or return $grp->result ([], $entries); 758 or return $grp->result ([], $entries);
751 } 759 }
752 760
753 # sort into likely dirs and likely nondirs 761 # sort into likely dirs and likely nondirs
754 # dirs == files without ".", short entries first 762 # dirs == files without ".", short entries first
755 $entries = [map $_->[0], 763 $entries = [map $_->[0],
756 sort { $b->[1] cmp $a->[1] } 764 sort { $b->[1] cmp $a->[1] }
757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 765 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
758 @$entries]; 766 @$entries];
759 767
760 my (@dirs, @nondirs); 768 my (@dirs, @nondirs);
761 769
762 my $statgrp = add $grp aio_group sub { 770 my $statgrp = add $grp aio_group sub {
763 $grp->result (\@dirs, \@nondirs); 771 $grp->result (\@dirs, \@nondirs);
764 }; 772 };
765 773
766 limit $statgrp $maxreq; 774 limit $statgrp $maxreq;
767 feed $statgrp sub { 775 feed $statgrp sub {
768 return unless @$entries; 776 return unless @$entries;
769 my $entry = pop @$entries; 777 my $entry = pop @$entries;
770 778
771 aioreq_pri $pri; 779 aioreq_pri $pri;
772 add $statgrp aio_stat "$path/$entry/.", sub { 780 add $statgrp aio_stat "$path/$entry/.", sub {
773 if ($_[0] < 0) { 781 if ($_[0] < 0) {
774 push @nondirs, $entry; 782 push @nondirs, $entry;
775 } else { 783 } else {
776 # need to check for real directory 784 # need to check for real directory
777 aioreq_pri $pri; 785 aioreq_pri $pri;
778 add $statgrp aio_lstat "$path/$entry", sub { 786 add $statgrp aio_lstat "$path/$entry", sub {
779 if (-d _) { 787 if (-d _) {
780 push @dirs, $entry; 788 push @dirs, $entry;
781 789
782 unless (--$ndirs) { 790 unless (--$ndirs) {
783 push @nondirs, @$entries; 791 push @nondirs, @$entries;
784 feed $statgrp; 792 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
788 } 793 }
794 } else {
795 push @nondirs, $entry;
789 } 796 }
790 } 797 }
791 }; 798 }
792 }; 799 };
793 }; 800 };
794 }; 801 };
795 }; 802 };
796
797 $grp
798 } 803 };
804
805 $grp
799} 806}
800 807
801=item aio_rmtree $path, $callback->($status) 808=item aio_rmtree $path, $callback->($status)
802 809
803Delete a directory tree starting (and including) C<$path>, return the 810Delete a directory tree starting (and including) C<$path>, return the
… …
807 814
808=cut 815=cut
809 816
810sub aio_rmtree; 817sub aio_rmtree;
811sub aio_rmtree($;$) { 818sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_; 819 my ($path, $cb) = @_;
814 820
815 my $pri = aioreq_pri; 821 my $pri = aioreq_pri;
816 my $grp = aio_group $cb; 822 my $grp = aio_group $cb;
817 823
818 aioreq_pri $pri; 824 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub { 825 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_; 826 my ($dirs, $nondirs) = @_;
821 827
822 my $dirgrp = aio_group sub { 828 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub { 829 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]); 830 $grp->result ($_[0]);
825 };
826 }; 831 };
827
828 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
829 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
830
831 add $grp $dirgrp;
832 }; 832 };
833 833
834 $grp 834 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
835 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
836
837 add $grp $dirgrp;
835 } 838 };
839
840 $grp
836} 841}
842
843=item aio_sync $callback->($status)
844
845Asynchronously call sync and call the callback when finished.
837 846
838=item aio_fsync $fh, $callback->($status) 847=item aio_fsync $fh, $callback->($status)
839 848
840Asynchronously call fsync on the given filehandle and call the callback 849Asynchronously call fsync on the given filehandle and call the callback
841with the fsync result code. 850with the fsync result code.
… …
845Asynchronously call fdatasync on the given filehandle and call the 854Asynchronously call fdatasync on the given filehandle and call the
846callback with the fdatasync result code. 855callback with the fdatasync result code.
847 856
848If this call isn't available because your OS lacks it or it couldn't be 857If this call isn't available because your OS lacks it or it couldn't be
849detected, it will be emulated by calling C<fsync> instead. 858detected, it will be emulated by calling C<fsync> instead.
859
860=item aio_pathsync $path, $callback->($status)
861
862This request tries to open, fsync and close the given path. This is a
863composite request intended to sync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any
865specific effect, but usually it makes sure that directory changes get
866written to disc. It works for anything that can be opened for read-only,
867not just directories.
868
869Passes C<0> when everything went ok, and C<-1> on error.
870
871=cut
872
873sub aio_pathsync($;$) {
874 my ($path, $cb) = @_;
875
876 my $pri = aioreq_pri;
877 my $grp = aio_group $cb;
878
879 aioreq_pri $pri;
880 add $grp aio_open $path, O_RDONLY, 0, sub {
881 my ($fh) = @_;
882 if ($fh) {
883 aioreq_pri $pri;
884 add $grp aio_fsync $fh, sub {
885 $grp->result ($_[0]);
886
887 aioreq_pri $pri;
888 add $grp aio_close $fh;
889 };
890 } else {
891 $grp->result (-1);
892 }
893 };
894
895 $grp
896}
850 897
851=item aio_group $callback->(...) 898=item aio_group $callback->(...)
852 899
853This is a very special aio request: Instead of doing something, it is a 900This is a very special aio request: Instead of doing something, it is a
854container for other aio requests, which is useful if you want to bundle 901container for other aio requests, which is useful if you want to bundle
… …
966Their lifetime, simplified, looks like this: when they are empty, they 1013Their lifetime, simplified, looks like this: when they are empty, they
967will finish very quickly. If they contain only requests that are in the 1014will finish very quickly. If they contain only requests that are in the
968C<done> state, they will also finish. Otherwise they will continue to 1015C<done> state, they will also finish. Otherwise they will continue to
969exist. 1016exist.
970 1017
971That means after creating a group you have some time to add requests. And 1018That means after creating a group you have some time to add requests
972in the callbacks of those requests, you can add further requests to the 1019(precisely before the callback has been invoked, which is only done within
973group. And only when all those requests have finished will the the group 1020the C<poll_cb>). And in the callbacks of those requests, you can add
974itself finish. 1021further requests to the group. And only when all those requests have
1022finished will the the group itself finish.
975 1023
976=over 4 1024=over 4
977 1025
978=item add $grp ... 1026=item add $grp ...
979 1027
… …
991itself. Useful when you queued a lot of events but got a result early. 1039itself. Useful when you queued a lot of events but got a result early.
992 1040
993=item $grp->result (...) 1041=item $grp->result (...)
994 1042
995Set the result value(s) that will be passed to the group callback when all 1043Set the result value(s) that will be passed to the group callback when all
996subrequests have finished and set thre groups errno to the current value 1044subrequests have finished and set the groups errno to the current value
997of errno (just like calling C<errno> without an error number). By default, 1045of errno (just like calling C<errno> without an error number). By default,
998no argument will be passed and errno is zero. 1046no argument will be passed and errno is zero.
999 1047
1000=item $grp->errno ([$errno]) 1048=item $grp->errno ([$errno])
1001 1049
… …
1028not impose any limits). 1076not impose any limits).
1029 1077
1030If the feed does not queue more requests when called, it will be 1078If the feed does not queue more requests when called, it will be
1031automatically removed from the group. 1079automatically removed from the group.
1032 1080
1033If the feed limit is C<0>, it will be set to C<2> automatically. 1081If the feed limit is C<0> when this method is called, it will be set to
1082C<2> automatically.
1034 1083
1035Example: 1084Example:
1036 1085
1037 # stat all files in @files, but only ever use four aio requests concurrently: 1086 # stat all files in @files, but only ever use four aio requests concurrently:
1038 1087
… …
1050Sets the feeder limit for the group: The feeder will be called whenever 1099Sets the feeder limit for the group: The feeder will be called whenever
1051the group contains less than this many requests. 1100the group contains less than this many requests.
1052 1101
1053Setting the limit to C<0> will pause the feeding process. 1102Setting the limit to C<0> will pause the feeding process.
1054 1103
1104The default value for the limit is C<0>, but note that setting a feeder
1105automatically bumps it up to C<2>.
1106
1055=back 1107=back
1056 1108
1057=head2 SUPPORT FUNCTIONS 1109=head2 SUPPORT FUNCTIONS
1058 1110
1059=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1111=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1070See C<poll_cb> for an example. 1122See C<poll_cb> for an example.
1071 1123
1072=item IO::AIO::poll_cb 1124=item IO::AIO::poll_cb
1073 1125
1074Process some outstanding events on the result pipe. You have to call this 1126Process some outstanding events on the result pipe. You have to call this
1075regularly. Returns the number of events processed. Returns immediately 1127regularly. Returns C<0> if all events could be processed, or C<-1> if it
1128returned earlier for whatever reason. Returns immediately when no events
1076when no events are outstanding. The amount of events processed depends on 1129are outstanding. The amount of events processed depends on the settings of
1077the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1130C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1078 1131
1079If not all requests were processed for whatever reason, the filehandle 1132If not all requests were processed for whatever reason, the filehandle
1080will still be ready when C<poll_cb> returns. 1133will still be ready when C<poll_cb> returns, so normally you don't have to
1134do anything special to have it called later.
1081 1135
1082Example: Install an Event watcher that automatically calls 1136Example: Install an Event watcher that automatically calls
1083IO::AIO::poll_cb with high priority: 1137IO::AIO::poll_cb with high priority:
1084 1138
1085 Event->io (fd => IO::AIO::poll_fileno, 1139 Event->io (fd => IO::AIO::poll_fileno,
… …
1199 1253
1200The default is probably ok in most situations, especially if thread 1254The default is probably ok in most situations, especially if thread
1201creation is fast. If thread creation is very slow on your system you might 1255creation is fast. If thread creation is very slow on your system you might
1202want to use larger values. 1256want to use larger values.
1203 1257
1204=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1258=item IO::AIO::max_outstanding $maxreqs
1205 1259
1206This is a very bad function to use in interactive programs because it 1260This is a very bad function to use in interactive programs because it
1207blocks, and a bad way to reduce concurrency because it is inexact: Better 1261blocks, and a bad way to reduce concurrency because it is inexact: Better
1208use an C<aio_group> together with a feed callback. 1262use an C<aio_group> together with a feed callback.
1209 1263
1210Sets the maximum number of outstanding requests to C<$nreqs>. If you 1264Sets the maximum number of outstanding requests to C<$nreqs>. If you
1211to queue up more than this number of requests, the next call to the 1265do queue up more than this number of requests, the next call to the
1212C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1266C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213function will block until the limit is no longer exceeded. 1267function will block until the limit is no longer exceeded.
1214 1268
1215The default value is very large, so there is no practical limit on the 1269The default value is very large, so there is no practical limit on the
1216number of outstanding requests. 1270number of outstanding requests.
1217 1271
1218You can still queue as many requests as you want. Therefore, 1272You can still queue as many requests as you want. Therefore,
1219C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1273C<max_outstanding> is mainly useful in simple scripts (with low values) or
1220as a stop gap to shield against fatal memory overflow (with large values). 1274as a stop gap to shield against fatal memory overflow (with large values).
1221 1275
1222=back 1276=back
1223 1277
1224=head3 STATISTICAL INFORMATION 1278=head3 STATISTICAL INFORMATION
… …
1246but not yet processed by poll_cb). 1300but not yet processed by poll_cb).
1247 1301
1248=back 1302=back
1249 1303
1250=cut 1304=cut
1251
1252# support function to convert a fd into a perl filehandle
1253sub _fd2fh {
1254 return undef if $_[0] < 0;
1255
1256 # try to generate nice filehandles
1257 my $sym = "IO::AIO::fd#$_[0]";
1258 local *$sym;
1259
1260 open *$sym, "+<&=$_[0]" # usually works under any unix
1261 or open *$sym, "<&=$_[0]" # cygwin needs this
1262 or open *$sym, ">&=$_[0]" # or this
1263 or return undef;
1264
1265 *$sym
1266}
1267 1305
1268min_parallel 8; 1306min_parallel 8;
1269 1307
1270END { flush } 1308END { flush }
1271 1309
… …
1310 1348
1311Known bugs will be fixed in the next release. 1349Known bugs will be fixed in the next release.
1312 1350
1313=head1 SEE ALSO 1351=head1 SEE ALSO
1314 1352
1315L<Coro::AIO>. 1353L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1354more natural syntax.
1316 1355
1317=head1 AUTHOR 1356=head1 AUTHOR
1318 1357
1319 Marc Lehmann <schmorp@schmorp.de> 1358 Marc Lehmann <schmorp@schmorp.de>
1320 http://home.schmorp.de/ 1359 http://home.schmorp.de/

Diff Legend

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