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.145 by root, Sun Apr 19 19:20:10 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, 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.18';
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
329Reads 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
330into 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>
331callback 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
332like the syscall). 346error, just like the syscall).
333 347
334If C<$offset> is undefined, then the current file descriptor offset will 348If C<$offset> is undefined, then the current file descriptor offset will
335be used (and updated), otherwise the file descriptor offset will not be 349be used (and updated), otherwise the file descriptor offset will not be
336changed by these calls. 350changed by these calls.
337 351
338If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 352If C<$length> is undefined in C<aio_write>, use the remaining length of
353C<$data>.
339 354
340If C<$dataoffset> is less than zero, it will be counted from the end of 355If C<$dataoffset> is less than zero, it will be counted from the end of
341C<$data>. 356C<$data>.
342 357
343The C<$data> scalar I<MUST NOT> be modified in any way while the request 358The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
527memory. Status is the same as with aio_read. 542memory. Status is the same as with aio_read.
528 543
529=cut 544=cut
530 545
531sub aio_load($$;$) { 546sub aio_load($$;$) {
532 aio_block {
533 my ($path, undef, $cb) = @_; 547 my ($path, undef, $cb) = @_;
534 my $data = \$_[1]; 548 my $data = \$_[1];
535 549
536 my $pri = aioreq_pri; 550 my $pri = aioreq_pri;
537 my $grp = aio_group $cb; 551 my $grp = aio_group $cb;
552
553 aioreq_pri $pri;
554 add $grp aio_open $path, O_RDONLY, 0, sub {
555 my $fh = shift
556 or return $grp->result (-1);
538 557
539 aioreq_pri $pri; 558 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 { 559 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
546 $grp->result ($_[0]); 560 $grp->result ($_[0]);
547 };
548 }; 561 };
549
550 $grp
551 } 562 };
563
564 $grp
552} 565}
553 566
554=item aio_copy $srcpath, $dstpath, $callback->($status) 567=item aio_copy $srcpath, $dstpath, $callback->($status)
555 568
556Try to copy the I<file> (directories not supported as either source or 569Try to copy the I<file> (directories not supported as either source or
557destination) from C<$srcpath> to C<$dstpath> and call the callback with 570destination) from C<$srcpath> to C<$dstpath> and call the callback with
558the C<0> (error) or C<-1> ok. 571the C<0> (error) or C<-1> ok.
559 572
560This is a composite request that it creates the destination file with 573This is a composite request that creates the destination file with
561mode 0200 and copies the contents of the source file into it using 574mode 0200 and copies the contents of the source file into it using
562C<aio_sendfile>, followed by restoring atime, mtime, access mode and 575C<aio_sendfile>, followed by restoring atime, mtime, access mode and
563uid/gid, in that order. 576uid/gid, in that order.
564 577
565If an error occurs, the partial destination file will be unlinked, if 578If an error occurs, the partial destination file will be unlinked, if
… …
567errors are being ignored. 580errors are being ignored.
568 581
569=cut 582=cut
570 583
571sub aio_copy($$;$) { 584sub aio_copy($$;$) {
572 aio_block {
573 my ($src, $dst, $cb) = @_; 585 my ($src, $dst, $cb) = @_;
574 586
575 my $pri = aioreq_pri; 587 my $pri = aioreq_pri;
576 my $grp = aio_group $cb; 588 my $grp = aio_group $cb;
577 589
578 aioreq_pri $pri; 590 aioreq_pri $pri;
579 add $grp aio_open $src, O_RDONLY, 0, sub { 591 add $grp aio_open $src, O_RDONLY, 0, sub {
580 if (my $src_fh = $_[0]) { 592 if (my $src_fh = $_[0]) {
581 my @stat = stat $src_fh; 593 my @stat = stat $src_fh;
582 594
583 aioreq_pri $pri; 595 aioreq_pri $pri;
584 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 596 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
585 if (my $dst_fh = $_[0]) { 597 if (my $dst_fh = $_[0]) {
586 aioreq_pri $pri; 598 aioreq_pri $pri;
587 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 599 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
588 if ($_[0] == $stat[7]) { 600 if ($_[0] == $stat[7]) {
589 $grp->result (0); 601 $grp->result (0);
590 close $src_fh; 602 close $src_fh;
591 603
592 # those should not normally block. should. should. 604 # those should not normally block. should. should.
593 utime $stat[8], $stat[9], $dst; 605 utime $stat[8], $stat[9], $dst;
594 chmod $stat[2] & 07777, $dst_fh; 606 chmod $stat[2] & 07777, $dst_fh;
595 chown $stat[4], $stat[5], $dst_fh; 607 chown $stat[4], $stat[5], $dst_fh;
608
609 aioreq_pri $pri;
596 close $dst_fh; 610 add $grp aio_close $dst_fh;
597 } else { 611 } else {
598 $grp->result (-1); 612 $grp->result (-1);
599 close $src_fh; 613 close $src_fh;
600 close $dst_fh; 614 close $dst_fh;
601 615
602 aioreq $pri; 616 aioreq $pri;
603 add $grp aio_unlink $dst; 617 add $grp aio_unlink $dst;
604 }
605 }; 618 }
606 } else {
607 $grp->result (-1);
608 } 619 };
620 } else {
621 $grp->result (-1);
609 }, 622 }
610
611 } else {
612 $grp->result (-1);
613 } 623 },
624
625 } else {
626 $grp->result (-1);
614 }; 627 }
615
616 $grp
617 } 628 };
629
630 $grp
618} 631}
619 632
620=item aio_move $srcpath, $dstpath, $callback->($status) 633=item aio_move $srcpath, $dstpath, $callback->($status)
621 634
622Try to move the I<file> (directories not supported as either source or 635Try to move the I<file> (directories not supported as either source or
623destination) from C<$srcpath> to C<$dstpath> and call the callback with 636destination) from C<$srcpath> to C<$dstpath> and call the callback with
624the C<0> (error) or C<-1> ok. 637the C<0> (error) or C<-1> ok.
625 638
626This is a composite request that tries to rename(2) the file first. If 639This 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 640rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
628that is successful, unlinking the C<$srcpath>. 641that is successful, unlinks the C<$srcpath>.
629 642
630=cut 643=cut
631 644
632sub aio_move($$;$) { 645sub aio_move($$;$) {
633 aio_block {
634 my ($src, $dst, $cb) = @_; 646 my ($src, $dst, $cb) = @_;
635 647
636 my $pri = aioreq_pri; 648 my $pri = aioreq_pri;
637 my $grp = aio_group $cb; 649 my $grp = aio_group $cb;
638 650
639 aioreq_pri $pri; 651 aioreq_pri $pri;
640 add $grp aio_rename $src, $dst, sub { 652 add $grp aio_rename $src, $dst, sub {
641 if ($_[0] && $! == EXDEV) { 653 if ($_[0] && $! == EXDEV) {
642 aioreq_pri $pri; 654 aioreq_pri $pri;
643 add $grp aio_copy $src, $dst, sub { 655 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]); 656 $grp->result ($_[0]);
657
658 if (!$_[0]) {
659 aioreq_pri $pri;
660 add $grp aio_unlink $src;
661 }
653 } 662 };
663 } else {
664 $grp->result ($_[0]);
654 }; 665 }
655
656 $grp
657 } 666 };
667
668 $grp
658} 669}
659 670
660=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 671=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
661 672
662Scans a directory (similar to C<aio_readdir>) but additionally tries to 673Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
710directory counting heuristic. 721directory counting heuristic.
711 722
712=cut 723=cut
713 724
714sub aio_scandir($$;$) { 725sub aio_scandir($$;$) {
715 aio_block {
716 my ($path, $maxreq, $cb) = @_; 726 my ($path, $maxreq, $cb) = @_;
717 727
718 my $pri = aioreq_pri; 728 my $pri = aioreq_pri;
719 729
720 my $grp = aio_group $cb; 730 my $grp = aio_group $cb;
721 731
722 $maxreq = 4 if $maxreq <= 0; 732 $maxreq = 4 if $maxreq <= 0;
723 733
724 # stat once 734 # stat once
735 aioreq_pri $pri;
736 add $grp aio_stat $path, sub {
737 return $grp->result () if $_[0];
738 my $now = time;
739 my $hash1 = join ":", (stat _)[0,1,3,7,9];
740
741 # read the directory entries
725 aioreq_pri $pri; 742 aioreq_pri $pri;
726 add $grp aio_stat $path, sub { 743 add $grp aio_readdir $path, sub {
744 my $entries = shift
727 return $grp->result () if $_[0]; 745 or return $grp->result ();
728 my $now = time;
729 my $hash1 = join ":", (stat _)[0,1,3,7,9];
730 746
731 # read the directory entries 747 # stat the dir another time
732 aioreq_pri $pri; 748 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 { 749 add $grp aio_stat $path, sub {
740 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 750 my $hash2 = join ":", (stat _)[0,1,3,7,9];
741 751
742 my $ndirs; 752 my $ndirs;
743 753
744 # take the slow route if anything looks fishy 754 # take the slow route if anything looks fishy
745 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 755 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
746 $ndirs = -1; 756 $ndirs = -1;
747 } else { 757 } else {
748 # if nlink == 2, we are finished 758 # if nlink == 2, we are finished
749 # on non-posix-fs's, we rely on nlink < 2 759 # on non-posix-fs's, we rely on nlink < 2
750 $ndirs = (stat _)[3] - 2 760 $ndirs = (stat _)[3] - 2
751 or return $grp->result ([], $entries); 761 or return $grp->result ([], $entries);
752 } 762 }
753 763
754 # sort into likely dirs and likely nondirs 764 # sort into likely dirs and likely nondirs
755 # dirs == files without ".", short entries first 765 # dirs == files without ".", short entries first
756 $entries = [map $_->[0], 766 $entries = [map $_->[0],
757 sort { $b->[1] cmp $a->[1] } 767 sort { $b->[1] cmp $a->[1] }
758 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 768 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
759 @$entries]; 769 @$entries];
760 770
761 my (@dirs, @nondirs); 771 my (@dirs, @nondirs);
762 772
763 my $statgrp = add $grp aio_group sub { 773 my $statgrp = add $grp aio_group sub {
764 $grp->result (\@dirs, \@nondirs); 774 $grp->result (\@dirs, \@nondirs);
765 }; 775 };
766 776
767 limit $statgrp $maxreq; 777 limit $statgrp $maxreq;
768 feed $statgrp sub { 778 feed $statgrp sub {
769 return unless @$entries; 779 return unless @$entries;
770 my $entry = pop @$entries; 780 my $entry = pop @$entries;
771 781
772 aioreq_pri $pri; 782 aioreq_pri $pri;
773 add $statgrp aio_stat "$path/$entry/.", sub { 783 add $statgrp aio_stat "$path/$entry/.", sub {
774 if ($_[0] < 0) { 784 if ($_[0] < 0) {
775 push @nondirs, $entry; 785 push @nondirs, $entry;
776 } else { 786 } else {
777 # need to check for real directory 787 # need to check for real directory
778 aioreq_pri $pri; 788 aioreq_pri $pri;
779 add $statgrp aio_lstat "$path/$entry", sub { 789 add $statgrp aio_lstat "$path/$entry", sub {
780 if (-d _) { 790 if (-d _) {
781 push @dirs, $entry; 791 push @dirs, $entry;
782 792
783 unless (--$ndirs) { 793 unless (--$ndirs) {
784 push @nondirs, @$entries; 794 push @nondirs, @$entries;
785 feed $statgrp; 795 feed $statgrp;
786 }
787 } else {
788 push @nondirs, $entry;
789 } 796 }
797 } else {
798 push @nondirs, $entry;
790 } 799 }
791 } 800 }
792 }; 801 }
793 }; 802 };
794 }; 803 };
795 }; 804 };
796 }; 805 };
797
798 $grp
799 } 806 };
807
808 $grp
800} 809}
801 810
802=item aio_rmtree $path, $callback->($status) 811=item aio_rmtree $path, $callback->($status)
803 812
804Delete a directory tree starting (and including) C<$path>, return the 813Delete a directory tree starting (and including) C<$path>, return the
… …
808 817
809=cut 818=cut
810 819
811sub aio_rmtree; 820sub aio_rmtree;
812sub aio_rmtree($;$) { 821sub aio_rmtree($;$) {
813 aio_block {
814 my ($path, $cb) = @_; 822 my ($path, $cb) = @_;
815 823
816 my $pri = aioreq_pri; 824 my $pri = aioreq_pri;
817 my $grp = aio_group $cb; 825 my $grp = aio_group $cb;
818 826
819 aioreq_pri $pri; 827 aioreq_pri $pri;
820 add $grp aio_scandir $path, 0, sub { 828 add $grp aio_scandir $path, 0, sub {
821 my ($dirs, $nondirs) = @_; 829 my ($dirs, $nondirs) = @_;
822 830
823 my $dirgrp = aio_group sub { 831 my $dirgrp = aio_group sub {
824 add $grp aio_rmdir $path, sub { 832 add $grp aio_rmdir $path, sub {
825 $grp->result ($_[0]); 833 $grp->result ($_[0]);
826 };
827 }; 834 };
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 }; 835 };
834 836
835 $grp 837 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
838 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
839
840 add $grp $dirgrp;
836 } 841 };
842
843 $grp
837} 844}
845
846=item aio_sync $callback->($status)
847
848Asynchronously call sync and call the callback when finished.
838 849
839=item aio_fsync $fh, $callback->($status) 850=item aio_fsync $fh, $callback->($status)
840 851
841Asynchronously call fsync on the given filehandle and call the callback 852Asynchronously call fsync on the given filehandle and call the callback
842with the fsync result code. 853with the fsync result code.
… …
846Asynchronously call fdatasync on the given filehandle and call the 857Asynchronously call fdatasync on the given filehandle and call the
847callback with the fdatasync result code. 858callback with the fdatasync result code.
848 859
849If this call isn't available because your OS lacks it or it couldn't be 860If 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. 861detected, it will be emulated by calling C<fsync> instead.
862
863=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
864
865Sync the data portion of the file specified by C<$offset> and C<$length>
866to disk (but NOT the metadata), by calling the Linux-specific
867sync_file_range call. If sync_file_range is not available or it returns
868ENOSYS, then fdatasync or fsync is being substituted.
869
870C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
871C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
872C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
873manpage for details.
874
875=item aio_pathsync $path, $callback->($status)
876
877This request tries to open, fsync and close the given path. This is a
878composite request intended to sync directories after directory operations
879(E.g. rename). This might not work on all operating systems or have any
880specific effect, but usually it makes sure that directory changes get
881written to disc. It works for anything that can be opened for read-only,
882not just directories.
883
884Passes C<0> when everything went ok, and C<-1> on error.
885
886=cut
887
888sub aio_pathsync($;$) {
889 my ($path, $cb) = @_;
890
891 my $pri = aioreq_pri;
892 my $grp = aio_group $cb;
893
894 aioreq_pri $pri;
895 add $grp aio_open $path, O_RDONLY, 0, sub {
896 my ($fh) = @_;
897 if ($fh) {
898 aioreq_pri $pri;
899 add $grp aio_fsync $fh, sub {
900 $grp->result ($_[0]);
901
902 aioreq_pri $pri;
903 add $grp aio_close $fh;
904 };
905 } else {
906 $grp->result (-1);
907 }
908 };
909
910 $grp
911}
851 912
852=item aio_group $callback->(...) 913=item aio_group $callback->(...)
853 914
854This is a very special aio request: Instead of doing something, it is a 915This 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 916container for other aio requests, which is useful if you want to bundle
… …
967Their lifetime, simplified, looks like this: when they are empty, they 1028Their lifetime, simplified, looks like this: when they are empty, they
968will finish very quickly. If they contain only requests that are in the 1029will finish very quickly. If they contain only requests that are in the
969C<done> state, they will also finish. Otherwise they will continue to 1030C<done> state, they will also finish. Otherwise they will continue to
970exist. 1031exist.
971 1032
972That means after creating a group you have some time to add requests. And 1033That 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 1034(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 1035the C<poll_cb>). And in the callbacks of those requests, you can add
975itself finish. 1036further requests to the group. And only when all those requests have
1037finished will the the group itself finish.
976 1038
977=over 4 1039=over 4
978 1040
979=item add $grp ... 1041=item add $grp ...
980 1042
… …
992itself. Useful when you queued a lot of events but got a result early. 1054itself. Useful when you queued a lot of events but got a result early.
993 1055
994=item $grp->result (...) 1056=item $grp->result (...)
995 1057
996Set the result value(s) that will be passed to the group callback when all 1058Set 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 1059subrequests have finished and set the groups errno to the current value
998of errno (just like calling C<errno> without an error number). By default, 1060of errno (just like calling C<errno> without an error number). By default,
999no argument will be passed and errno is zero. 1061no argument will be passed and errno is zero.
1000 1062
1001=item $grp->errno ([$errno]) 1063=item $grp->errno ([$errno])
1002 1064
… …
1013=item feed $grp $callback->($grp) 1075=item feed $grp $callback->($grp)
1014 1076
1015Sets a feeder/generator on this group: every group can have an attached 1077Sets a feeder/generator on this group: every group can have an attached
1016generator that generates requests if idle. The idea behind this is that, 1078generator 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, 1079although you could just queue as many requests as you want in a group,
1018this might starve other requests for a potentially long time. For 1080this might starve other requests for a potentially long time. For example,
1019example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1081C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1020requests, delaying any later requests for a long time. 1082delaying any later requests for a long time.
1021 1083
1022To avoid this, and allow incremental generation of requests, you can 1084To avoid this, and allow incremental generation of requests, you can
1023instead a group and set a feeder on it that generates those requests. The 1085instead 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>, 1086feed 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 1087below) requests active in the group itself and is expected to queue more
… …
1029not impose any limits). 1091not impose any limits).
1030 1092
1031If the feed does not queue more requests when called, it will be 1093If the feed does not queue more requests when called, it will be
1032automatically removed from the group. 1094automatically removed from the group.
1033 1095
1034If the feed limit is C<0>, it will be set to C<2> automatically. 1096If the feed limit is C<0> when this method is called, it will be set to
1097C<2> automatically.
1035 1098
1036Example: 1099Example:
1037 1100
1038 # stat all files in @files, but only ever use four aio requests concurrently: 1101 # stat all files in @files, but only ever use four aio requests concurrently:
1039 1102
… …
1051Sets the feeder limit for the group: The feeder will be called whenever 1114Sets the feeder limit for the group: The feeder will be called whenever
1052the group contains less than this many requests. 1115the group contains less than this many requests.
1053 1116
1054Setting the limit to C<0> will pause the feeding process. 1117Setting the limit to C<0> will pause the feeding process.
1055 1118
1119The default value for the limit is C<0>, but note that setting a feeder
1120automatically bumps it up to C<2>.
1121
1056=back 1122=back
1057 1123
1058=head2 SUPPORT FUNCTIONS 1124=head2 SUPPORT FUNCTIONS
1059 1125
1060=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1126=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1071See C<poll_cb> for an example. 1137See C<poll_cb> for an example.
1072 1138
1073=item IO::AIO::poll_cb 1139=item IO::AIO::poll_cb
1074 1140
1075Process some outstanding events on the result pipe. You have to call this 1141Process some outstanding events on the result pipe. You have to call this
1076regularly. Returns the number of events processed. Returns immediately 1142regularly. Returns C<0> if all events could be processed, or C<-1> if it
1143returned earlier for whatever reason. Returns immediately when no events
1077when no events are outstanding. The amount of events processed depends on 1144are 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>. 1145C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1079 1146
1080If not all requests were processed for whatever reason, the filehandle 1147If not all requests were processed for whatever reason, the filehandle
1081will still be ready when C<poll_cb> returns. 1148will still be ready when C<poll_cb> returns, so normally you don't have to
1149do anything special to have it called later.
1082 1150
1083Example: Install an Event watcher that automatically calls 1151Example: Install an Event watcher that automatically calls
1084IO::AIO::poll_cb with high priority: 1152IO::AIO::poll_cb with high priority:
1085 1153
1086 Event->io (fd => IO::AIO::poll_fileno, 1154 Event->io (fd => IO::AIO::poll_fileno,
… …
1200 1268
1201The default is probably ok in most situations, especially if thread 1269The default is probably ok in most situations, especially if thread
1202creation is fast. If thread creation is very slow on your system you might 1270creation is fast. If thread creation is very slow on your system you might
1203want to use larger values. 1271want to use larger values.
1204 1272
1205=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1273=item IO::AIO::max_outstanding $maxreqs
1206 1274
1207This is a very bad function to use in interactive programs because it 1275This 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 1276blocks, and a bad way to reduce concurrency because it is inexact: Better
1209use an C<aio_group> together with a feed callback. 1277use an C<aio_group> together with a feed callback.
1210 1278
… …
1215 1283
1216The default value is very large, so there is no practical limit on the 1284The default value is very large, so there is no practical limit on the
1217number of outstanding requests. 1285number of outstanding requests.
1218 1286
1219You can still queue as many requests as you want. Therefore, 1287You can still queue as many requests as you want. Therefore,
1220C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1288C<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). 1289as a stop gap to shield against fatal memory overflow (with large values).
1222 1290
1223=back 1291=back
1224 1292
1225=head3 STATISTICAL INFORMATION 1293=head3 STATISTICAL INFORMATION
… …
1247but not yet processed by poll_cb). 1315but not yet processed by poll_cb).
1248 1316
1249=back 1317=back
1250 1318
1251=cut 1319=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 1320
1269min_parallel 8; 1321min_parallel 8;
1270 1322
1271END { flush } 1323END { flush }
1272 1324
… …
1311 1363
1312Known bugs will be fixed in the next release. 1364Known bugs will be fixed in the next release.
1313 1365
1314=head1 SEE ALSO 1366=head1 SEE ALSO
1315 1367
1316L<Coro::AIO>. 1368L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1369more natural syntax.
1317 1370
1318=head1 AUTHOR 1371=head1 AUTHOR
1319 1372
1320 Marc Lehmann <schmorp@schmorp.de> 1373 Marc Lehmann <schmorp@schmorp.de>
1321 http://home.schmorp.de/ 1374 http://home.schmorp.de/

Diff Legend

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