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.119 by root, Sun Dec 2 20:54:33 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, 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.6'; 198 our $VERSION = '3.17';
200 199
201 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
202 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
203 aio_readlink aio_sync 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
204 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
205 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads 211 nreqs nready npending nthreads
210 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
211 215
212 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
213 217
214 require XSLoader; 218 require XSLoader;
215 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
222All 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
223with 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,
224and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
225which 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
226the 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
227perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
228syscall has been executed asynchronously. 232syscall has been executed asynchronously.
229 233
230All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
231internally until the request has finished. 235internally until the request has finished.
232 236
… …
246your 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
247environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
248use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
249 253
250This 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
251handles correctly wether it is set or not. 255handles correctly whether it is set or not.
252 256
253=over 4 257=over 4
254 258
255=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
256 260
… …
319 323
320Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
321code. 325code.
322 326
323Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
324closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
325what aio_close will try:
326 329
327 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
328 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
329 3. dup()licate the fd once more 332(the pipe fd will be created on demand and will be cached).
330 4. let perl close() the filehandle
331 5. asynchronously close the duplicated fd
332 333
333The idea is that the first close() flushes stuff to disk that closing an 334Or in other words: the file descriptor will be closed, but it will not be
334fd will flush, so when perl closes the fd, nothing much will need to be 335free for reuse until the perl filehandle is closed.
335flushed. The second async. close() will then flush stuff to disk that
336closing the last fd to the file will flush.
337
338Just FYI, SuSv3 has this to say on close:
339
340 All outstanding record locks owned by the process on the file
341 associated with the file descriptor shall be removed.
342
343 If fildes refers to a socket, close() shall cause the socket to be
344 destroyed. ... close() shall block for up to the current linger
345 interval until all data is transmitted.
346 [this actually sounds like a specification bug, but who knows]
347
348And at least Linux additionally actually flushes stuff on every close,
349even when the file itself is still open.
350
351Sounds enourmously inefficient and complicated? Yes... please show me how
352to nuke perl's fd out of existence...
353 336
354=cut 337=cut
355
356sub aio_close($;$) {
357 aio_block {
358 my ($fh, $cb) = @_;
359
360 my $pri = aioreq_pri;
361 my $grp = aio_group $cb;
362
363 my $fd = fileno $fh;
364
365 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
366
367 # if the dups fail we will simply get EBADF
368 my $fd2 = _dup $fd;
369 aioreq_pri $pri;
370 add $grp _aio_close $fd2, sub {
371 my $fd2 = _dup $fd;
372 close $fh;
373 aioreq_pri $pri;
374 add $grp _aio_close $fd2, sub {
375 $grp->result ($_[0]);
376 };
377 };
378
379 $grp
380 }
381}
382
383 338
384=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
385 340
386=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
387 342
… …
586memory. Status is the same as with aio_read. 541memory. Status is the same as with aio_read.
587 542
588=cut 543=cut
589 544
590sub aio_load($$;$) { 545sub aio_load($$;$) {
591 aio_block {
592 my ($path, undef, $cb) = @_; 546 my ($path, undef, $cb) = @_;
593 my $data = \$_[1]; 547 my $data = \$_[1];
594 548
595 my $pri = aioreq_pri; 549 my $pri = aioreq_pri;
596 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);
597 556
598 aioreq_pri $pri; 557 aioreq_pri $pri;
599 add $grp aio_open $path, O_RDONLY, 0, sub {
600 my $fh = shift
601 or return $grp->result (-1);
602
603 aioreq_pri $pri;
604 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
605 $grp->result ($_[0]); 559 $grp->result ($_[0]);
606 };
607 }; 560 };
608
609 $grp
610 } 561 };
562
563 $grp
611} 564}
612 565
613=item aio_copy $srcpath, $dstpath, $callback->($status) 566=item aio_copy $srcpath, $dstpath, $callback->($status)
614 567
615Try 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
616destination) from C<$srcpath> to C<$dstpath> and call the callback with 569destination) from C<$srcpath> to C<$dstpath> and call the callback with
617the C<0> (error) or C<-1> ok. 570the C<0> (error) or C<-1> ok.
618 571
619This is a composite request that it creates the destination file with 572This is a composite request that creates the destination file with
620mode 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
621C<aio_sendfile>, followed by restoring atime, mtime, access mode and 574C<aio_sendfile>, followed by restoring atime, mtime, access mode and
622uid/gid, in that order. 575uid/gid, in that order.
623 576
624If an error occurs, the partial destination file will be unlinked, if 577If an error occurs, the partial destination file will be unlinked, if
… …
626errors are being ignored. 579errors are being ignored.
627 580
628=cut 581=cut
629 582
630sub aio_copy($$;$) { 583sub aio_copy($$;$) {
631 aio_block {
632 my ($src, $dst, $cb) = @_; 584 my ($src, $dst, $cb) = @_;
633 585
634 my $pri = aioreq_pri; 586 my $pri = aioreq_pri;
635 my $grp = aio_group $cb; 587 my $grp = aio_group $cb;
636 588
637 aioreq_pri $pri; 589 aioreq_pri $pri;
638 add $grp aio_open $src, O_RDONLY, 0, sub { 590 add $grp aio_open $src, O_RDONLY, 0, sub {
639 if (my $src_fh = $_[0]) { 591 if (my $src_fh = $_[0]) {
640 my @stat = stat $src_fh; 592 my @stat = stat $src_fh;
641 593
642 aioreq_pri $pri; 594 aioreq_pri $pri;
643 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 {
644 if (my $dst_fh = $_[0]) { 596 if (my $dst_fh = $_[0]) {
645 aioreq_pri $pri; 597 aioreq_pri $pri;
646 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 {
647 if ($_[0] == $stat[7]) { 599 if ($_[0] == $stat[7]) {
648 $grp->result (0); 600 $grp->result (0);
649 close $src_fh; 601 close $src_fh;
650 602
651 # those should not normally block. should. should. 603 # those should not normally block. should. should.
652 utime $stat[8], $stat[9], $dst; 604 utime $stat[8], $stat[9], $dst;
653 chmod $stat[2] & 07777, $dst_fh; 605 chmod $stat[2] & 07777, $dst_fh;
654 chown $stat[4], $stat[5], $dst_fh; 606 chown $stat[4], $stat[5], $dst_fh;
607
608 aioreq_pri $pri;
655 close $dst_fh; 609 add $grp aio_close $dst_fh;
656 } else { 610 } else {
657 $grp->result (-1); 611 $grp->result (-1);
658 close $src_fh; 612 close $src_fh;
659 close $dst_fh; 613 close $dst_fh;
660 614
661 aioreq $pri; 615 aioreq $pri;
662 add $grp aio_unlink $dst; 616 add $grp aio_unlink $dst;
663 }
664 }; 617 }
665 } else {
666 $grp->result (-1);
667 } 618 };
619 } else {
620 $grp->result (-1);
668 }, 621 }
669
670 } else {
671 $grp->result (-1);
672 } 622 },
623
624 } else {
625 $grp->result (-1);
673 }; 626 }
674
675 $grp
676 } 627 };
628
629 $grp
677} 630}
678 631
679=item aio_move $srcpath, $dstpath, $callback->($status) 632=item aio_move $srcpath, $dstpath, $callback->($status)
680 633
681Try 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
682destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
683the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
684 637
685This 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
686rename 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
687that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
688 641
689=cut 642=cut
690 643
691sub aio_move($$;$) { 644sub aio_move($$;$) {
692 aio_block {
693 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
694 646
695 my $pri = aioreq_pri; 647 my $pri = aioreq_pri;
696 my $grp = aio_group $cb; 648 my $grp = aio_group $cb;
697 649
698 aioreq_pri $pri; 650 aioreq_pri $pri;
699 add $grp aio_rename $src, $dst, sub { 651 add $grp aio_rename $src, $dst, sub {
700 if ($_[0] && $! == EXDEV) { 652 if ($_[0] && $! == EXDEV) {
701 aioreq_pri $pri; 653 aioreq_pri $pri;
702 add $grp aio_copy $src, $dst, sub { 654 add $grp aio_copy $src, $dst, sub {
703 $grp->result ($_[0]);
704
705 if (!$_[0]) {
706 aioreq_pri $pri;
707 add $grp aio_unlink $src;
708 }
709 };
710 } else {
711 $grp->result ($_[0]); 655 $grp->result ($_[0]);
656
657 if (!$_[0]) {
658 aioreq_pri $pri;
659 add $grp aio_unlink $src;
660 }
712 } 661 };
662 } else {
663 $grp->result ($_[0]);
713 }; 664 }
714
715 $grp
716 } 665 };
666
667 $grp
717} 668}
718 669
719=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 670=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
720 671
721Scans a directory (similar to C<aio_readdir>) but additionally tries to 672Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
769directory counting heuristic. 720directory counting heuristic.
770 721
771=cut 722=cut
772 723
773sub aio_scandir($$;$) { 724sub aio_scandir($$;$) {
774 aio_block {
775 my ($path, $maxreq, $cb) = @_; 725 my ($path, $maxreq, $cb) = @_;
776 726
777 my $pri = aioreq_pri; 727 my $pri = aioreq_pri;
778 728
779 my $grp = aio_group $cb; 729 my $grp = aio_group $cb;
780 730
781 $maxreq = 4 if $maxreq <= 0; 731 $maxreq = 4 if $maxreq <= 0;
782 732
783 # 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
784 aioreq_pri $pri; 741 aioreq_pri $pri;
785 add $grp aio_stat $path, sub { 742 add $grp aio_readdir $path, sub {
743 my $entries = shift
786 return $grp->result () if $_[0]; 744 or return $grp->result ();
787 my $now = time;
788 my $hash1 = join ":", (stat _)[0,1,3,7,9];
789 745
790 # read the directory entries 746 # stat the dir another time
791 aioreq_pri $pri; 747 aioreq_pri $pri;
792 add $grp aio_readdir $path, sub {
793 my $entries = shift
794 or return $grp->result ();
795
796 # stat the dir another time
797 aioreq_pri $pri;
798 add $grp aio_stat $path, sub { 748 add $grp aio_stat $path, sub {
799 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 749 my $hash2 = join ":", (stat _)[0,1,3,7,9];
800 750
801 my $ndirs; 751 my $ndirs;
802 752
803 # take the slow route if anything looks fishy 753 # take the slow route if anything looks fishy
804 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 754 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
805 $ndirs = -1; 755 $ndirs = -1;
806 } else { 756 } else {
807 # if nlink == 2, we are finished 757 # if nlink == 2, we are finished
808 # on non-posix-fs's, we rely on nlink < 2 758 # on non-posix-fs's, we rely on nlink < 2
809 $ndirs = (stat _)[3] - 2 759 $ndirs = (stat _)[3] - 2
810 or return $grp->result ([], $entries); 760 or return $grp->result ([], $entries);
811 } 761 }
812 762
813 # sort into likely dirs and likely nondirs 763 # sort into likely dirs and likely nondirs
814 # dirs == files without ".", short entries first 764 # dirs == files without ".", short entries first
815 $entries = [map $_->[0], 765 $entries = [map $_->[0],
816 sort { $b->[1] cmp $a->[1] } 766 sort { $b->[1] cmp $a->[1] }
817 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 767 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
818 @$entries]; 768 @$entries];
819 769
820 my (@dirs, @nondirs); 770 my (@dirs, @nondirs);
821 771
822 my $statgrp = add $grp aio_group sub { 772 my $statgrp = add $grp aio_group sub {
823 $grp->result (\@dirs, \@nondirs); 773 $grp->result (\@dirs, \@nondirs);
824 }; 774 };
825 775
826 limit $statgrp $maxreq; 776 limit $statgrp $maxreq;
827 feed $statgrp sub { 777 feed $statgrp sub {
828 return unless @$entries; 778 return unless @$entries;
829 my $entry = pop @$entries; 779 my $entry = pop @$entries;
830 780
831 aioreq_pri $pri; 781 aioreq_pri $pri;
832 add $statgrp aio_stat "$path/$entry/.", sub { 782 add $statgrp aio_stat "$path/$entry/.", sub {
833 if ($_[0] < 0) { 783 if ($_[0] < 0) {
834 push @nondirs, $entry; 784 push @nondirs, $entry;
835 } else { 785 } else {
836 # need to check for real directory 786 # need to check for real directory
837 aioreq_pri $pri; 787 aioreq_pri $pri;
838 add $statgrp aio_lstat "$path/$entry", sub { 788 add $statgrp aio_lstat "$path/$entry", sub {
839 if (-d _) { 789 if (-d _) {
840 push @dirs, $entry; 790 push @dirs, $entry;
841 791
842 unless (--$ndirs) { 792 unless (--$ndirs) {
843 push @nondirs, @$entries; 793 push @nondirs, @$entries;
844 feed $statgrp; 794 feed $statgrp;
845 }
846 } else {
847 push @nondirs, $entry;
848 } 795 }
796 } else {
797 push @nondirs, $entry;
849 } 798 }
850 } 799 }
851 }; 800 }
852 }; 801 };
853 }; 802 };
854 }; 803 };
855 }; 804 };
856
857 $grp
858 } 805 };
806
807 $grp
859} 808}
860 809
861=item aio_rmtree $path, $callback->($status) 810=item aio_rmtree $path, $callback->($status)
862 811
863Delete a directory tree starting (and including) C<$path>, return the 812Delete a directory tree starting (and including) C<$path>, return the
… …
867 816
868=cut 817=cut
869 818
870sub aio_rmtree; 819sub aio_rmtree;
871sub aio_rmtree($;$) { 820sub aio_rmtree($;$) {
872 aio_block {
873 my ($path, $cb) = @_; 821 my ($path, $cb) = @_;
874 822
875 my $pri = aioreq_pri; 823 my $pri = aioreq_pri;
876 my $grp = aio_group $cb; 824 my $grp = aio_group $cb;
877 825
878 aioreq_pri $pri; 826 aioreq_pri $pri;
879 add $grp aio_scandir $path, 0, sub { 827 add $grp aio_scandir $path, 0, sub {
880 my ($dirs, $nondirs) = @_; 828 my ($dirs, $nondirs) = @_;
881 829
882 my $dirgrp = aio_group sub { 830 my $dirgrp = aio_group sub {
883 add $grp aio_rmdir $path, sub { 831 add $grp aio_rmdir $path, sub {
884 $grp->result ($_[0]); 832 $grp->result ($_[0]);
885 };
886 }; 833 };
887
888 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
889 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
890
891 add $grp $dirgrp;
892 }; 834 };
893 835
894 $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;
895 } 840 };
841
842 $grp
896} 843}
897 844
898=item aio_sync $callback->($status) 845=item aio_sync $callback->($status)
899 846
900Asynchronously call sync and call the callback when finished. 847Asynchronously call sync and call the callback when finished.
… …
909Asynchronously call fdatasync on the given filehandle and call the 856Asynchronously call fdatasync on the given filehandle and call the
910callback with the fdatasync result code. 857callback with the fdatasync result code.
911 858
912If 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
913detected, 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}
914 911
915=item aio_group $callback->(...) 912=item aio_group $callback->(...)
916 913
917This 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
918container 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
… …
1030Their lifetime, simplified, looks like this: when they are empty, they 1027Their lifetime, simplified, looks like this: when they are empty, they
1031will 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
1032C<done> state, they will also finish. Otherwise they will continue to 1029C<done> state, they will also finish. Otherwise they will continue to
1033exist. 1030exist.
1034 1031
1035That 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
1036in 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
1037group. 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
1038itself finish. 1035further requests to the group. And only when all those requests have
1036finished will the the group itself finish.
1039 1037
1040=over 4 1038=over 4
1041 1039
1042=item add $grp ... 1040=item add $grp ...
1043 1041
… …
1055itself. 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.
1056 1054
1057=item $grp->result (...) 1055=item $grp->result (...)
1058 1056
1059Set 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
1060subrequests have finished and set thre groups errno to the current value 1058subrequests have finished and set the groups errno to the current value
1061of 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,
1062no argument will be passed and errno is zero. 1060no argument will be passed and errno is zero.
1063 1061
1064=item $grp->errno ([$errno]) 1062=item $grp->errno ([$errno])
1065 1063
… …
1076=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1077 1075
1078Sets 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
1079generator that generates requests if idle. The idea behind this is that, 1077generator that generates requests if idle. The idea behind this is that,
1080although 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,
1081this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1082example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1083requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1084 1082
1085To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1086instead 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
1087feed 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>,
1088below) 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
… …
1092not impose any limits). 1090not impose any limits).
1093 1091
1094If 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
1095automatically removed from the group. 1093automatically removed from the group.
1096 1094
1097If 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.
1098 1097
1099Example: 1098Example:
1100 1099
1101 # 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:
1102 1101
… …
1114Sets 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
1115the group contains less than this many requests. 1114the group contains less than this many requests.
1116 1115
1117Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1118 1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1120
1119=back 1121=back
1120 1122
1121=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1122 1124
1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1125=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1134See C<poll_cb> for an example. 1136See C<poll_cb> for an example.
1135 1137
1136=item IO::AIO::poll_cb 1138=item IO::AIO::poll_cb
1137 1139
1138Process 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
1139regularly. 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
1140when no events are outstanding. The amount of events processed depends on 1143are outstanding. The amount of events processed depends on the settings of
1141the 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>.
1142 1145
1143If not all requests were processed for whatever reason, the filehandle 1146If not all requests were processed for whatever reason, the filehandle
1144will 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.
1145 1149
1146Example: Install an Event watcher that automatically calls 1150Example: Install an Event watcher that automatically calls
1147IO::AIO::poll_cb with high priority: 1151IO::AIO::poll_cb with high priority:
1148 1152
1149 Event->io (fd => IO::AIO::poll_fileno, 1153 Event->io (fd => IO::AIO::poll_fileno,
… …
1263 1267
1264The default is probably ok in most situations, especially if thread 1268The default is probably ok in most situations, especially if thread
1265creation 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
1266want to use larger values. 1270want to use larger values.
1267 1271
1268=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1272=item IO::AIO::max_outstanding $maxreqs
1269 1273
1270This 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
1271blocks, 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
1272use an C<aio_group> together with a feed callback. 1276use an C<aio_group> together with a feed callback.
1273 1277
… …
1278 1282
1279The 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
1280number of outstanding requests. 1284number of outstanding requests.
1281 1285
1282You can still queue as many requests as you want. Therefore, 1286You can still queue as many requests as you want. Therefore,
1283C<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
1284as 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).
1285 1289
1286=back 1290=back
1287 1291
1288=head3 STATISTICAL INFORMATION 1292=head3 STATISTICAL INFORMATION
… …
1358 1362
1359Known bugs will be fixed in the next release. 1363Known bugs will be fixed in the next release.
1360 1364
1361=head1 SEE ALSO 1365=head1 SEE ALSO
1362 1366
1363L<Coro::AIO>. 1367L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1368more natural syntax.
1364 1369
1365=head1 AUTHOR 1370=head1 AUTHOR
1366 1371
1367 Marc Lehmann <schmorp@schmorp.de> 1372 Marc Lehmann <schmorp@schmorp.de>
1368 http://home.schmorp.de/ 1373 http://home.schmorp.de/

Diff Legend

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