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.116 by root, Wed Oct 3 21:27:51 2007 UTC vs.
Revision 1.124 by root, Sat May 10 19:25: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 31 # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); 33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
34 37
35 # Event integration 38 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 39 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 40 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 41 cb => \&IO::AIO::poll_cb);
… …
183 186
184=cut 187=cut
185 188
186package IO::AIO; 189package IO::AIO;
187 190
191use Carp ();
192
188no warnings; 193no warnings;
189use strict 'vars'; 194use strict 'vars';
190 195
191use base 'Exporter'; 196use base 'Exporter';
192 197
193BEGIN { 198BEGIN {
194 our $VERSION = '2.5'; 199 our $VERSION = '3.0';
195 200
196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 201 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 202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 203 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
204 aio_fdatasync aio_pathsync aio_readahead
205 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 206 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200 aio_chown aio_chmod aio_utime aio_truncate); 207 aio_chmod aio_utime aio_truncate);
208
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 211 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 212 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 213 max_poll_time max_poll_reqs);
206 214
… …
313=item aio_close $fh, $callback->($status) 321=item aio_close $fh, $callback->($status)
314 322
315Asynchronously close a file and call the callback with the result 323Asynchronously close a file and call the callback with the result
316code. 324code.
317 325
318Unlike the other functions operating on files, this function uses the 326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
319PerlIO layer to close the filehandle. The reason is that the PerlIO API 327closing the file descriptor associated with the filehandle itself.
320insists on closing the underlying fd itself, no matter what, and doesn't
321allow modifications to the fd. Unfortunately, it is not clear that you can
322call PerlIO from different threads (actually, its quite clear that this
323won't work in some cases), so while it likely works perfectly with simple
324file handles (such as the ones created by C<aio_open>) it might fail in
325interesting ways for others.
326 328
327Having said that, aio_close tries to clean up the filehandle as much as 329Therefore, C<aio_close> will not close the filehandle - instead it will
328possible before handing it to an io thread, and generally does work. 330use dup2 to overwrite the file descriptor with the write-end of a pipe
331(the pipe fd will be created on demand and will be cached).
329 332
333Or in other words: the file descriptor will be closed, but it will not be
334free for reuse until the perl filehandle is closed.
335
336=cut
330 337
331=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
332 339
333=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
334 341
… …
533memory. Status is the same as with aio_read. 540memory. Status is the same as with aio_read.
534 541
535=cut 542=cut
536 543
537sub aio_load($$;$) { 544sub aio_load($$;$) {
538 aio_block {
539 my ($path, undef, $cb) = @_; 545 my ($path, undef, $cb) = @_;
540 my $data = \$_[1]; 546 my $data = \$_[1];
541 547
542 my $pri = aioreq_pri; 548 my $pri = aioreq_pri;
543 my $grp = aio_group $cb; 549 my $grp = aio_group $cb;
550
551 aioreq_pri $pri;
552 add $grp aio_open $path, O_RDONLY, 0, sub {
553 my $fh = shift
554 or return $grp->result (-1);
544 555
545 aioreq_pri $pri; 556 aioreq_pri $pri;
546 add $grp aio_open $path, O_RDONLY, 0, sub {
547 my $fh = shift
548 or return $grp->result (-1);
549
550 aioreq_pri $pri;
551 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 557 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
552 $grp->result ($_[0]); 558 $grp->result ($_[0]);
553 };
554 }; 559 };
555
556 $grp
557 } 560 };
561
562 $grp
558} 563}
559 564
560=item aio_copy $srcpath, $dstpath, $callback->($status) 565=item aio_copy $srcpath, $dstpath, $callback->($status)
561 566
562Try to copy the I<file> (directories not supported as either source or 567Try to copy the I<file> (directories not supported as either source or
… …
573errors are being ignored. 578errors are being ignored.
574 579
575=cut 580=cut
576 581
577sub aio_copy($$;$) { 582sub aio_copy($$;$) {
578 aio_block {
579 my ($src, $dst, $cb) = @_; 583 my ($src, $dst, $cb) = @_;
580 584
581 my $pri = aioreq_pri; 585 my $pri = aioreq_pri;
582 my $grp = aio_group $cb; 586 my $grp = aio_group $cb;
583 587
584 aioreq_pri $pri; 588 aioreq_pri $pri;
585 add $grp aio_open $src, O_RDONLY, 0, sub { 589 add $grp aio_open $src, O_RDONLY, 0, sub {
586 if (my $src_fh = $_[0]) { 590 if (my $src_fh = $_[0]) {
587 my @stat = stat $src_fh; 591 my @stat = stat $src_fh;
588 592
589 aioreq_pri $pri; 593 aioreq_pri $pri;
590 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 594 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
591 if (my $dst_fh = $_[0]) { 595 if (my $dst_fh = $_[0]) {
592 aioreq_pri $pri; 596 aioreq_pri $pri;
593 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 597 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
594 if ($_[0] == $stat[7]) { 598 if ($_[0] == $stat[7]) {
595 $grp->result (0); 599 $grp->result (0);
596 close $src_fh; 600 close $src_fh;
597 601
598 # those should not normally block. should. should. 602 # those should not normally block. should. should.
599 utime $stat[8], $stat[9], $dst; 603 utime $stat[8], $stat[9], $dst;
600 chmod $stat[2] & 07777, $dst_fh; 604 chmod $stat[2] & 07777, $dst_fh;
601 chown $stat[4], $stat[5], $dst_fh; 605 chown $stat[4], $stat[5], $dst_fh;
606
607 aioreq_pri $pri;
602 close $dst_fh; 608 add $grp aio_close $dst_fh;
603 } else { 609 } else {
604 $grp->result (-1); 610 $grp->result (-1);
605 close $src_fh; 611 close $src_fh;
606 close $dst_fh; 612 close $dst_fh;
607 613
608 aioreq $pri; 614 aioreq $pri;
609 add $grp aio_unlink $dst; 615 add $grp aio_unlink $dst;
610 }
611 }; 616 }
612 } else {
613 $grp->result (-1);
614 } 617 };
618 } else {
619 $grp->result (-1);
615 }, 620 }
616
617 } else {
618 $grp->result (-1);
619 } 621 },
622
623 } else {
624 $grp->result (-1);
620 }; 625 }
621
622 $grp
623 } 626 };
627
628 $grp
624} 629}
625 630
626=item aio_move $srcpath, $dstpath, $callback->($status) 631=item aio_move $srcpath, $dstpath, $callback->($status)
627 632
628Try to move the I<file> (directories not supported as either source or 633Try to move the I<file> (directories not supported as either source or
… …
634that is successful, unlinking the C<$srcpath>. 639that is successful, unlinking the C<$srcpath>.
635 640
636=cut 641=cut
637 642
638sub aio_move($$;$) { 643sub aio_move($$;$) {
639 aio_block {
640 my ($src, $dst, $cb) = @_; 644 my ($src, $dst, $cb) = @_;
641 645
642 my $pri = aioreq_pri; 646 my $pri = aioreq_pri;
643 my $grp = aio_group $cb; 647 my $grp = aio_group $cb;
644 648
645 aioreq_pri $pri; 649 aioreq_pri $pri;
646 add $grp aio_rename $src, $dst, sub { 650 add $grp aio_rename $src, $dst, sub {
647 if ($_[0] && $! == EXDEV) { 651 if ($_[0] && $! == EXDEV) {
648 aioreq_pri $pri; 652 aioreq_pri $pri;
649 add $grp aio_copy $src, $dst, sub { 653 add $grp aio_copy $src, $dst, sub {
650 $grp->result ($_[0]);
651
652 if (!$_[0]) {
653 aioreq_pri $pri;
654 add $grp aio_unlink $src;
655 }
656 };
657 } else {
658 $grp->result ($_[0]); 654 $grp->result ($_[0]);
655
656 if (!$_[0]) {
657 aioreq_pri $pri;
658 add $grp aio_unlink $src;
659 }
659 } 660 };
661 } else {
662 $grp->result ($_[0]);
660 }; 663 }
661
662 $grp
663 } 664 };
665
666 $grp
664} 667}
665 668
666=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 669=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
667 670
668Scans a directory (similar to C<aio_readdir>) but additionally tries to 671Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
716directory counting heuristic. 719directory counting heuristic.
717 720
718=cut 721=cut
719 722
720sub aio_scandir($$;$) { 723sub aio_scandir($$;$) {
721 aio_block {
722 my ($path, $maxreq, $cb) = @_; 724 my ($path, $maxreq, $cb) = @_;
723 725
724 my $pri = aioreq_pri; 726 my $pri = aioreq_pri;
725 727
726 my $grp = aio_group $cb; 728 my $grp = aio_group $cb;
727 729
728 $maxreq = 4 if $maxreq <= 0; 730 $maxreq = 4 if $maxreq <= 0;
729 731
730 # stat once 732 # stat once
733 aioreq_pri $pri;
734 add $grp aio_stat $path, sub {
735 return $grp->result () if $_[0];
736 my $now = time;
737 my $hash1 = join ":", (stat _)[0,1,3,7,9];
738
739 # read the directory entries
731 aioreq_pri $pri; 740 aioreq_pri $pri;
732 add $grp aio_stat $path, sub { 741 add $grp aio_readdir $path, sub {
742 my $entries = shift
733 return $grp->result () if $_[0]; 743 or return $grp->result ();
734 my $now = time;
735 my $hash1 = join ":", (stat _)[0,1,3,7,9];
736 744
737 # read the directory entries 745 # stat the dir another time
738 aioreq_pri $pri; 746 aioreq_pri $pri;
739 add $grp aio_readdir $path, sub {
740 my $entries = shift
741 or return $grp->result ();
742
743 # stat the dir another time
744 aioreq_pri $pri;
745 add $grp aio_stat $path, sub { 747 add $grp aio_stat $path, sub {
746 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 748 my $hash2 = join ":", (stat _)[0,1,3,7,9];
747 749
748 my $ndirs; 750 my $ndirs;
749 751
750 # take the slow route if anything looks fishy 752 # take the slow route if anything looks fishy
751 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 753 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
752 $ndirs = -1; 754 $ndirs = -1;
753 } else { 755 } else {
754 # if nlink == 2, we are finished 756 # if nlink == 2, we are finished
755 # on non-posix-fs's, we rely on nlink < 2 757 # on non-posix-fs's, we rely on nlink < 2
756 $ndirs = (stat _)[3] - 2 758 $ndirs = (stat _)[3] - 2
757 or return $grp->result ([], $entries); 759 or return $grp->result ([], $entries);
758 } 760 }
759 761
760 # sort into likely dirs and likely nondirs 762 # sort into likely dirs and likely nondirs
761 # dirs == files without ".", short entries first 763 # dirs == files without ".", short entries first
762 $entries = [map $_->[0], 764 $entries = [map $_->[0],
763 sort { $b->[1] cmp $a->[1] } 765 sort { $b->[1] cmp $a->[1] }
764 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 766 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
765 @$entries]; 767 @$entries];
766 768
767 my (@dirs, @nondirs); 769 my (@dirs, @nondirs);
768 770
769 my $statgrp = add $grp aio_group sub { 771 my $statgrp = add $grp aio_group sub {
770 $grp->result (\@dirs, \@nondirs); 772 $grp->result (\@dirs, \@nondirs);
771 }; 773 };
772 774
773 limit $statgrp $maxreq; 775 limit $statgrp $maxreq;
774 feed $statgrp sub { 776 feed $statgrp sub {
775 return unless @$entries; 777 return unless @$entries;
776 my $entry = pop @$entries; 778 my $entry = pop @$entries;
777 779
778 aioreq_pri $pri; 780 aioreq_pri $pri;
779 add $statgrp aio_stat "$path/$entry/.", sub { 781 add $statgrp aio_stat "$path/$entry/.", sub {
780 if ($_[0] < 0) { 782 if ($_[0] < 0) {
781 push @nondirs, $entry; 783 push @nondirs, $entry;
782 } else { 784 } else {
783 # need to check for real directory 785 # need to check for real directory
784 aioreq_pri $pri; 786 aioreq_pri $pri;
785 add $statgrp aio_lstat "$path/$entry", sub { 787 add $statgrp aio_lstat "$path/$entry", sub {
786 if (-d _) { 788 if (-d _) {
787 push @dirs, $entry; 789 push @dirs, $entry;
788 790
789 unless (--$ndirs) { 791 unless (--$ndirs) {
790 push @nondirs, @$entries; 792 push @nondirs, @$entries;
791 feed $statgrp; 793 feed $statgrp;
792 }
793 } else {
794 push @nondirs, $entry;
795 } 794 }
795 } else {
796 push @nondirs, $entry;
796 } 797 }
797 } 798 }
798 }; 799 }
799 }; 800 };
800 }; 801 };
801 }; 802 };
802 }; 803 };
803
804 $grp
805 } 804 };
805
806 $grp
806} 807}
807 808
808=item aio_rmtree $path, $callback->($status) 809=item aio_rmtree $path, $callback->($status)
809 810
810Delete a directory tree starting (and including) C<$path>, return the 811Delete a directory tree starting (and including) C<$path>, return the
… …
814 815
815=cut 816=cut
816 817
817sub aio_rmtree; 818sub aio_rmtree;
818sub aio_rmtree($;$) { 819sub aio_rmtree($;$) {
819 aio_block {
820 my ($path, $cb) = @_; 820 my ($path, $cb) = @_;
821 821
822 my $pri = aioreq_pri; 822 my $pri = aioreq_pri;
823 my $grp = aio_group $cb; 823 my $grp = aio_group $cb;
824 824
825 aioreq_pri $pri; 825 aioreq_pri $pri;
826 add $grp aio_scandir $path, 0, sub { 826 add $grp aio_scandir $path, 0, sub {
827 my ($dirs, $nondirs) = @_; 827 my ($dirs, $nondirs) = @_;
828 828
829 my $dirgrp = aio_group sub { 829 my $dirgrp = aio_group sub {
830 add $grp aio_rmdir $path, sub { 830 add $grp aio_rmdir $path, sub {
831 $grp->result ($_[0]); 831 $grp->result ($_[0]);
832 };
833 }; 832 };
834
835 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
836 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
837
838 add $grp $dirgrp;
839 }; 833 };
840 834
841 $grp 835 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
836 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
837
838 add $grp $dirgrp;
842 } 839 };
840
841 $grp
843} 842}
843
844=item aio_sync $callback->($status)
845
846Asynchronously call sync and call the callback when finished.
844 847
845=item aio_fsync $fh, $callback->($status) 848=item aio_fsync $fh, $callback->($status)
846 849
847Asynchronously call fsync on the given filehandle and call the callback 850Asynchronously call fsync on the given filehandle and call the callback
848with the fsync result code. 851with the fsync result code.
… …
852Asynchronously call fdatasync on the given filehandle and call the 855Asynchronously call fdatasync on the given filehandle and call the
853callback with the fdatasync result code. 856callback with the fdatasync result code.
854 857
855If this call isn't available because your OS lacks it or it couldn't be 858If this call isn't available because your OS lacks it or it couldn't be
856detected, it will be emulated by calling C<fsync> instead. 859detected, it will be emulated by calling C<fsync> instead.
860
861=item aio_pathsync $path, $callback->($status)
862
863This request tries to open, fsync and close the given path. This is a
864composite request intended tosync directories after directory operations
865(E.g. rename). This might not work on all operating systems or have any
866specific effect, but usually it makes sure that directory changes get
867written to disc. It works for anything that can be opened for read-only,
868not just directories.
869
870Passes C<0> when everything went ok, and C<-1> on error.
871
872=cut
873
874sub aio_pathsync($;$) {
875 my ($path, $cb) = @_;
876
877 my $pri = aioreq_pri;
878 my $grp = aio_group $cb;
879
880 aioreq_pri $pri;
881 add $grp aio_open $path, O_RDONLY, 0, sub {
882 my ($fh) = @_;
883 if ($fh) {
884 aioreq_pri $pri;
885 add $grp aio_fsync $fh, sub {
886 $grp->result ($_[0]);
887
888 aioreq_pri $pri;
889 add $grp aio_close $fh;
890 };
891 } else {
892 $grp->result (-1);
893 }
894 };
895
896 $grp
897}
857 898
858=item aio_group $callback->(...) 899=item aio_group $callback->(...)
859 900
860This is a very special aio request: Instead of doing something, it is a 901This is a very special aio request: Instead of doing something, it is a
861container for other aio requests, which is useful if you want to bundle 902container for other aio requests, which is useful if you want to bundle
… …
998itself. 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.
999 1040
1000=item $grp->result (...) 1041=item $grp->result (...)
1001 1042
1002Set 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
1003subrequests have finished and set thre groups errno to the current value 1044subrequests have finished and set the groups errno to the current value
1004of 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,
1005no argument will be passed and errno is zero. 1046no argument will be passed and errno is zero.
1006 1047
1007=item $grp->errno ([$errno]) 1048=item $grp->errno ([$errno])
1008 1049
… …
1206 1247
1207The default is probably ok in most situations, especially if thread 1248The default is probably ok in most situations, especially if thread
1208creation is fast. If thread creation is very slow on your system you might 1249creation is fast. If thread creation is very slow on your system you might
1209want to use larger values. 1250want to use larger values.
1210 1251
1211=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1252=item IO::AIO::max_outstanding $maxreqs
1212 1253
1213This is a very bad function to use in interactive programs because it 1254This is a very bad function to use in interactive programs because it
1214blocks, and a bad way to reduce concurrency because it is inexact: Better 1255blocks, and a bad way to reduce concurrency because it is inexact: Better
1215use an C<aio_group> together with a feed callback. 1256use an C<aio_group> together with a feed callback.
1216 1257
… …
1221 1262
1222The default value is very large, so there is no practical limit on the 1263The default value is very large, so there is no practical limit on the
1223number of outstanding requests. 1264number of outstanding requests.
1224 1265
1225You can still queue as many requests as you want. Therefore, 1266You can still queue as many requests as you want. Therefore,
1226C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1267C<max_outstanding> is mainly useful in simple scripts (with low values) or
1227as a stop gap to shield against fatal memory overflow (with large values). 1268as a stop gap to shield against fatal memory overflow (with large values).
1228 1269
1229=back 1270=back
1230 1271
1231=head3 STATISTICAL INFORMATION 1272=head3 STATISTICAL INFORMATION

Diff Legend

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