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.113 by root, Thu Sep 20 14:06:21 2007 UTC vs.
Revision 1.123 by root, Sat May 10 18:06:41 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.4'; 199 our $VERSION = '2.62';
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
… …
311 319
312 320
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. I<WARNING:> although accepted, you should not pass in a perl 324code.
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 325
321This is supposed to be a bug in the API, so that might change. It's 326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 327closing the file descriptor associated with the filehandle itself.
323 328
329Therefore, C<aio_close> will not close the filehandle - instead it will
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).
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
324 337
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 339
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 341
… …
333 346
334If C<$offset> is undefined, then the current file descriptor offset will 347If C<$offset> is undefined, then the current file descriptor offset will
335be used (and updated), otherwise the file descriptor offset will not be 348be used (and updated), otherwise the file descriptor offset will not be
336changed by these calls. 349changed by these calls.
337 350
338If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 351If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
339 352
340If C<$dataoffset> is less than zero, it will be counted from the end of 353If C<$dataoffset> is less than zero, it will be counted from the end of
341C<$data>. 354C<$data>.
342 355
343The C<$data> scalar I<MUST NOT> be modified in any way while the request 356The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
527memory. Status is the same as with aio_read. 540memory. Status is the same as with aio_read.
528 541
529=cut 542=cut
530 543
531sub aio_load($$;$) { 544sub aio_load($$;$) {
532 aio_block {
533 my ($path, undef, $cb) = @_; 545 my ($path, undef, $cb) = @_;
534 my $data = \$_[1]; 546 my $data = \$_[1];
535 547
536 my $pri = aioreq_pri; 548 my $pri = aioreq_pri;
537 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);
538 555
539 aioreq_pri $pri; 556 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 { 557 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
546 $grp->result ($_[0]); 558 $grp->result ($_[0]);
547 };
548 }; 559 };
549
550 $grp
551 } 560 };
561
562 $grp
552} 563}
553 564
554=item aio_copy $srcpath, $dstpath, $callback->($status) 565=item aio_copy $srcpath, $dstpath, $callback->($status)
555 566
556Try 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
… …
567errors are being ignored. 578errors are being ignored.
568 579
569=cut 580=cut
570 581
571sub aio_copy($$;$) { 582sub aio_copy($$;$) {
572 aio_block {
573 my ($src, $dst, $cb) = @_; 583 my ($src, $dst, $cb) = @_;
574 584
575 my $pri = aioreq_pri; 585 my $pri = aioreq_pri;
576 my $grp = aio_group $cb; 586 my $grp = aio_group $cb;
577 587
578 aioreq_pri $pri; 588 aioreq_pri $pri;
579 add $grp aio_open $src, O_RDONLY, 0, sub { 589 add $grp aio_open $src, O_RDONLY, 0, sub {
580 if (my $src_fh = $_[0]) { 590 if (my $src_fh = $_[0]) {
581 my @stat = stat $src_fh; 591 my @stat = stat $src_fh;
582 592
583 aioreq_pri $pri; 593 aioreq_pri $pri;
584 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 {
585 if (my $dst_fh = $_[0]) { 595 if (my $dst_fh = $_[0]) {
586 aioreq_pri $pri; 596 aioreq_pri $pri;
587 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 {
588 if ($_[0] == $stat[7]) { 598 if ($_[0] == $stat[7]) {
589 $grp->result (0); 599 $grp->result (0);
590 close $src_fh; 600 close $src_fh;
591 601
592 # those should not normally block. should. should. 602 # those should not normally block. should. should.
593 utime $stat[8], $stat[9], $dst; 603 utime $stat[8], $stat[9], $dst;
594 chmod $stat[2] & 07777, $dst_fh; 604 chmod $stat[2] & 07777, $dst_fh;
595 chown $stat[4], $stat[5], $dst_fh; 605 chown $stat[4], $stat[5], $dst_fh;
606
607 aioreq_pri $pri;
596 close $dst_fh; 608 add $grp aio_close $dst_fh;
597 } else { 609 } else {
598 $grp->result (-1); 610 $grp->result (-1);
599 close $src_fh; 611 close $src_fh;
600 close $dst_fh; 612 close $dst_fh;
601 613
602 aioreq $pri; 614 aioreq $pri;
603 add $grp aio_unlink $dst; 615 add $grp aio_unlink $dst;
604 }
605 }; 616 }
606 } else {
607 $grp->result (-1);
608 } 617 };
618 } else {
619 $grp->result (-1);
609 }, 620 }
610
611 } else {
612 $grp->result (-1);
613 } 621 },
622
623 } else {
624 $grp->result (-1);
614 }; 625 }
615
616 $grp
617 } 626 };
627
628 $grp
618} 629}
619 630
620=item aio_move $srcpath, $dstpath, $callback->($status) 631=item aio_move $srcpath, $dstpath, $callback->($status)
621 632
622Try 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
… …
628that is successful, unlinking the C<$srcpath>. 639that is successful, unlinking the C<$srcpath>.
629 640
630=cut 641=cut
631 642
632sub aio_move($$;$) { 643sub aio_move($$;$) {
633 aio_block {
634 my ($src, $dst, $cb) = @_; 644 my ($src, $dst, $cb) = @_;
635 645
636 my $pri = aioreq_pri; 646 my $pri = aioreq_pri;
637 my $grp = aio_group $cb; 647 my $grp = aio_group $cb;
638 648
639 aioreq_pri $pri; 649 aioreq_pri $pri;
640 add $grp aio_rename $src, $dst, sub { 650 add $grp aio_rename $src, $dst, sub {
641 if ($_[0] && $! == EXDEV) { 651 if ($_[0] && $! == EXDEV) {
642 aioreq_pri $pri; 652 aioreq_pri $pri;
643 add $grp aio_copy $src, $dst, sub { 653 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]); 654 $grp->result ($_[0]);
655
656 if (!$_[0]) {
657 aioreq_pri $pri;
658 add $grp aio_unlink $src;
659 }
653 } 660 };
661 } else {
662 $grp->result ($_[0]);
654 }; 663 }
655
656 $grp
657 } 664 };
665
666 $grp
658} 667}
659 668
660=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 669=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
661 670
662Scans a directory (similar to C<aio_readdir>) but additionally tries to 671Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
710directory counting heuristic. 719directory counting heuristic.
711 720
712=cut 721=cut
713 722
714sub aio_scandir($$;$) { 723sub aio_scandir($$;$) {
715 aio_block {
716 my ($path, $maxreq, $cb) = @_; 724 my ($path, $maxreq, $cb) = @_;
717 725
718 my $pri = aioreq_pri; 726 my $pri = aioreq_pri;
719 727
720 my $grp = aio_group $cb; 728 my $grp = aio_group $cb;
721 729
722 $maxreq = 4 if $maxreq <= 0; 730 $maxreq = 4 if $maxreq <= 0;
723 731
724 # 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
725 aioreq_pri $pri; 740 aioreq_pri $pri;
726 add $grp aio_stat $path, sub { 741 add $grp aio_readdir $path, sub {
742 my $entries = shift
727 return $grp->result () if $_[0]; 743 or return $grp->result ();
728 my $now = time;
729 my $hash1 = join ":", (stat _)[0,1,3,7,9];
730 744
731 # read the directory entries 745 # stat the dir another time
732 aioreq_pri $pri; 746 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 { 747 add $grp aio_stat $path, sub {
740 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 748 my $hash2 = join ":", (stat _)[0,1,3,7,9];
741 749
742 my $ndirs; 750 my $ndirs;
743 751
744 # take the slow route if anything looks fishy 752 # take the slow route if anything looks fishy
745 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 753 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
746 $ndirs = -1; 754 $ndirs = -1;
747 } else { 755 } else {
748 # if nlink == 2, we are finished 756 # if nlink == 2, we are finished
749 # on non-posix-fs's, we rely on nlink < 2 757 # on non-posix-fs's, we rely on nlink < 2
750 $ndirs = (stat _)[3] - 2 758 $ndirs = (stat _)[3] - 2
751 or return $grp->result ([], $entries); 759 or return $grp->result ([], $entries);
752 } 760 }
753 761
754 # sort into likely dirs and likely nondirs 762 # sort into likely dirs and likely nondirs
755 # dirs == files without ".", short entries first 763 # dirs == files without ".", short entries first
756 $entries = [map $_->[0], 764 $entries = [map $_->[0],
757 sort { $b->[1] cmp $a->[1] } 765 sort { $b->[1] cmp $a->[1] }
758 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 766 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
759 @$entries]; 767 @$entries];
760 768
761 my (@dirs, @nondirs); 769 my (@dirs, @nondirs);
762 770
763 my $statgrp = add $grp aio_group sub { 771 my $statgrp = add $grp aio_group sub {
764 $grp->result (\@dirs, \@nondirs); 772 $grp->result (\@dirs, \@nondirs);
765 }; 773 };
766 774
767 limit $statgrp $maxreq; 775 limit $statgrp $maxreq;
768 feed $statgrp sub { 776 feed $statgrp sub {
769 return unless @$entries; 777 return unless @$entries;
770 my $entry = pop @$entries; 778 my $entry = pop @$entries;
771 779
772 aioreq_pri $pri; 780 aioreq_pri $pri;
773 add $statgrp aio_stat "$path/$entry/.", sub { 781 add $statgrp aio_stat "$path/$entry/.", sub {
774 if ($_[0] < 0) { 782 if ($_[0] < 0) {
775 push @nondirs, $entry; 783 push @nondirs, $entry;
776 } else { 784 } else {
777 # need to check for real directory 785 # need to check for real directory
778 aioreq_pri $pri; 786 aioreq_pri $pri;
779 add $statgrp aio_lstat "$path/$entry", sub { 787 add $statgrp aio_lstat "$path/$entry", sub {
780 if (-d _) { 788 if (-d _) {
781 push @dirs, $entry; 789 push @dirs, $entry;
782 790
783 unless (--$ndirs) { 791 unless (--$ndirs) {
784 push @nondirs, @$entries; 792 push @nondirs, @$entries;
785 feed $statgrp; 793 feed $statgrp;
786 }
787 } else {
788 push @nondirs, $entry;
789 } 794 }
795 } else {
796 push @nondirs, $entry;
790 } 797 }
791 } 798 }
792 }; 799 }
793 }; 800 };
794 }; 801 };
795 }; 802 };
796 }; 803 };
797
798 $grp
799 } 804 };
805
806 $grp
800} 807}
801 808
802=item aio_rmtree $path, $callback->($status) 809=item aio_rmtree $path, $callback->($status)
803 810
804Delete a directory tree starting (and including) C<$path>, return the 811Delete a directory tree starting (and including) C<$path>, return the
… …
808 815
809=cut 816=cut
810 817
811sub aio_rmtree; 818sub aio_rmtree;
812sub aio_rmtree($;$) { 819sub aio_rmtree($;$) {
813 aio_block {
814 my ($path, $cb) = @_; 820 my ($path, $cb) = @_;
815 821
816 my $pri = aioreq_pri; 822 my $pri = aioreq_pri;
817 my $grp = aio_group $cb; 823 my $grp = aio_group $cb;
818 824
819 aioreq_pri $pri; 825 aioreq_pri $pri;
820 add $grp aio_scandir $path, 0, sub { 826 add $grp aio_scandir $path, 0, sub {
821 my ($dirs, $nondirs) = @_; 827 my ($dirs, $nondirs) = @_;
822 828
823 my $dirgrp = aio_group sub { 829 my $dirgrp = aio_group sub {
824 add $grp aio_rmdir $path, sub { 830 add $grp aio_rmdir $path, sub {
825 $grp->result ($_[0]); 831 $grp->result ($_[0]);
826 };
827 }; 832 };
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 }; 833 };
834 834
835 $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;
836 } 839 };
840
841 $grp
837} 842}
843
844=item aio_sync $callback->($status)
845
846Asynchronously call sync and call the callback when finished.
838 847
839=item aio_fsync $fh, $callback->($status) 848=item aio_fsync $fh, $callback->($status)
840 849
841Asynchronously call fsync on the given filehandle and call the callback 850Asynchronously call fsync on the given filehandle and call the callback
842with the fsync result code. 851with the fsync result code.
… …
846Asynchronously call fdatasync on the given filehandle and call the 855Asynchronously call fdatasync on the given filehandle and call the
847callback with the fdatasync result code. 856callback with the fdatasync result code.
848 857
849If 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
850detected, 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}
851 898
852=item aio_group $callback->(...) 899=item aio_group $callback->(...)
853 900
854This 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
855container 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
… …
992itself. 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.
993 1040
994=item $grp->result (...) 1041=item $grp->result (...)
995 1042
996Set 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
997subrequests have finished and set thre groups errno to the current value 1044subrequests have finished and set the groups errno to the current value
998of 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,
999no argument will be passed and errno is zero. 1046no argument will be passed and errno is zero.
1000 1047
1001=item $grp->errno ([$errno]) 1048=item $grp->errno ([$errno])
1002 1049
… …
1200 1247
1201The default is probably ok in most situations, especially if thread 1248The default is probably ok in most situations, especially if thread
1202creation 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
1203want to use larger values. 1250want to use larger values.
1204 1251
1205=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1252=item IO::AIO::max_outstanding $maxreqs
1206 1253
1207This 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
1208blocks, 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
1209use an C<aio_group> together with a feed callback. 1256use an C<aio_group> together with a feed callback.
1210 1257
… …
1215 1262
1216The 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
1217number of outstanding requests. 1264number of outstanding requests.
1218 1265
1219You can still queue as many requests as you want. Therefore, 1266You can still queue as many requests as you want. Therefore,
1220C<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
1221as 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).
1222 1269
1223=back 1270=back
1224 1271
1225=head3 STATISTICAL INFORMATION 1272=head3 STATISTICAL INFORMATION
… …
1247but not yet processed by poll_cb). 1294but not yet processed by poll_cb).
1248 1295
1249=back 1296=back
1250 1297
1251=cut 1298=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 1299
1269min_parallel 8; 1300min_parallel 8;
1270 1301
1271END { flush } 1302END { flush }
1272 1303

Diff Legend

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