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.117 by root, Sat Oct 6 14:05:19 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);
… …
191use strict 'vars'; 194use strict 'vars';
192 195
193use base 'Exporter'; 196use base 'Exporter';
194 197
195BEGIN { 198BEGIN {
196 our $VERSION = '2.51'; 199 our $VERSION = '3.0';
197 200
198 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
199 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
200 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
201 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
202 aio_chown aio_chmod aio_utime aio_truncate); 207 aio_chmod aio_utime aio_truncate);
208
203 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
204 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
205 min_parallel max_parallel max_idle 211 min_parallel max_parallel max_idle
206 nreqs nready npending nthreads 212 nreqs nready npending nthreads
207 max_poll_time max_poll_reqs); 213 max_poll_time max_poll_reqs);
208 214
… …
316 322
317Asynchronously close a file and call the callback with the result 323Asynchronously close a file and call the callback with the result
318code. 324code.
319 325
320Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
321closing the file descriptor associated with the filehandle itself. Here is 327closing the file descriptor associated with the filehandle itself.
322what aio_close will try:
323 328
324 1. dup()licate the fd 329Therefore, C<aio_close> will not close the filehandle - instead it will
325 2. asynchronously close() the duplicated fd 330use dup2 to overwrite the file descriptor with the write-end of a pipe
326 3. dup()licate the fd once more 331(the pipe fd will be created on demand and will be cached).
327 4. let perl close() the filehandle
328 5. asynchronously close the duplicated fd
329 332
330The idea is that the first close() flushes stuff to disk that closing an 333Or in other words: the file descriptor will be closed, but it will not be
331fd will flush, so when perl closes the fd, nothing much will need to be 334free for reuse until the perl filehandle is closed.
332flushed. The second async. close() will then flush stuff to disk that
333closing the last fd to the file will flush.
334
335Just FYI, SuSv3 has this to say on close:
336
337 All outstanding record locks owned by the process on the file
338 associated with the file descriptor shall be removed.
339
340 If fildes refers to a socket, close() shall cause the socket to be
341 destroyed. ... close() shall block for up to the current linger
342 interval until all data is transmitted.
343 [this actually sounds like a specification bug, but who knows]
344
345And at least Linux additionally actually flushes stuff on every close,
346even when the file itself is still open.
347
348Sounds enourmously inefficient and complicated? Yes... please show me how
349to nuke perl's fd out of existence...
350 335
351=cut 336=cut
352
353sub aio_close($;$) {
354 aio_block {
355 my ($fh, $cb) = @_;
356
357 my $pri = aioreq_pri;
358 my $grp = aio_group $cb;
359
360 my $fd = fileno $fh;
361
362 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
363
364 # if the dups fail we will simply get EBADF
365 my $fd2 = _dup $fd;
366 aioreq_pri $pri;
367 add $grp _aio_close $fd2, sub {
368 my $fd2 = _dup $fd;
369 close $fh;
370 aioreq_pri $pri;
371 add $grp _aio_close $fd2, sub {
372 $grp->result ($_[0]);
373 };
374 };
375
376 $grp
377 }
378}
379
380 337
381=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
382 339
383=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
384 341
… …
583memory. Status is the same as with aio_read. 540memory. Status is the same as with aio_read.
584 541
585=cut 542=cut
586 543
587sub aio_load($$;$) { 544sub aio_load($$;$) {
588 aio_block {
589 my ($path, undef, $cb) = @_; 545 my ($path, undef, $cb) = @_;
590 my $data = \$_[1]; 546 my $data = \$_[1];
591 547
592 my $pri = aioreq_pri; 548 my $pri = aioreq_pri;
593 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);
594 555
595 aioreq_pri $pri; 556 aioreq_pri $pri;
596 add $grp aio_open $path, O_RDONLY, 0, sub {
597 my $fh = shift
598 or return $grp->result (-1);
599
600 aioreq_pri $pri;
601 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 557 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
602 $grp->result ($_[0]); 558 $grp->result ($_[0]);
603 };
604 }; 559 };
605
606 $grp
607 } 560 };
561
562 $grp
608} 563}
609 564
610=item aio_copy $srcpath, $dstpath, $callback->($status) 565=item aio_copy $srcpath, $dstpath, $callback->($status)
611 566
612Try 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
… …
623errors are being ignored. 578errors are being ignored.
624 579
625=cut 580=cut
626 581
627sub aio_copy($$;$) { 582sub aio_copy($$;$) {
628 aio_block {
629 my ($src, $dst, $cb) = @_; 583 my ($src, $dst, $cb) = @_;
630 584
631 my $pri = aioreq_pri; 585 my $pri = aioreq_pri;
632 my $grp = aio_group $cb; 586 my $grp = aio_group $cb;
633 587
634 aioreq_pri $pri; 588 aioreq_pri $pri;
635 add $grp aio_open $src, O_RDONLY, 0, sub { 589 add $grp aio_open $src, O_RDONLY, 0, sub {
636 if (my $src_fh = $_[0]) { 590 if (my $src_fh = $_[0]) {
637 my @stat = stat $src_fh; 591 my @stat = stat $src_fh;
638 592
639 aioreq_pri $pri; 593 aioreq_pri $pri;
640 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 {
641 if (my $dst_fh = $_[0]) { 595 if (my $dst_fh = $_[0]) {
642 aioreq_pri $pri; 596 aioreq_pri $pri;
643 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 {
644 if ($_[0] == $stat[7]) { 598 if ($_[0] == $stat[7]) {
645 $grp->result (0); 599 $grp->result (0);
646 close $src_fh; 600 close $src_fh;
647 601
648 # those should not normally block. should. should. 602 # those should not normally block. should. should.
649 utime $stat[8], $stat[9], $dst; 603 utime $stat[8], $stat[9], $dst;
650 chmod $stat[2] & 07777, $dst_fh; 604 chmod $stat[2] & 07777, $dst_fh;
651 chown $stat[4], $stat[5], $dst_fh; 605 chown $stat[4], $stat[5], $dst_fh;
606
607 aioreq_pri $pri;
652 close $dst_fh; 608 add $grp aio_close $dst_fh;
653 } else { 609 } else {
654 $grp->result (-1); 610 $grp->result (-1);
655 close $src_fh; 611 close $src_fh;
656 close $dst_fh; 612 close $dst_fh;
657 613
658 aioreq $pri; 614 aioreq $pri;
659 add $grp aio_unlink $dst; 615 add $grp aio_unlink $dst;
660 }
661 }; 616 }
662 } else {
663 $grp->result (-1);
664 } 617 };
618 } else {
619 $grp->result (-1);
665 }, 620 }
666
667 } else {
668 $grp->result (-1);
669 } 621 },
622
623 } else {
624 $grp->result (-1);
670 }; 625 }
671
672 $grp
673 } 626 };
627
628 $grp
674} 629}
675 630
676=item aio_move $srcpath, $dstpath, $callback->($status) 631=item aio_move $srcpath, $dstpath, $callback->($status)
677 632
678Try 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
… …
684that is successful, unlinking the C<$srcpath>. 639that is successful, unlinking the C<$srcpath>.
685 640
686=cut 641=cut
687 642
688sub aio_move($$;$) { 643sub aio_move($$;$) {
689 aio_block {
690 my ($src, $dst, $cb) = @_; 644 my ($src, $dst, $cb) = @_;
691 645
692 my $pri = aioreq_pri; 646 my $pri = aioreq_pri;
693 my $grp = aio_group $cb; 647 my $grp = aio_group $cb;
694 648
695 aioreq_pri $pri; 649 aioreq_pri $pri;
696 add $grp aio_rename $src, $dst, sub { 650 add $grp aio_rename $src, $dst, sub {
697 if ($_[0] && $! == EXDEV) { 651 if ($_[0] && $! == EXDEV) {
698 aioreq_pri $pri; 652 aioreq_pri $pri;
699 add $grp aio_copy $src, $dst, sub { 653 add $grp aio_copy $src, $dst, sub {
700 $grp->result ($_[0]);
701
702 if (!$_[0]) {
703 aioreq_pri $pri;
704 add $grp aio_unlink $src;
705 }
706 };
707 } else {
708 $grp->result ($_[0]); 654 $grp->result ($_[0]);
655
656 if (!$_[0]) {
657 aioreq_pri $pri;
658 add $grp aio_unlink $src;
659 }
709 } 660 };
661 } else {
662 $grp->result ($_[0]);
710 }; 663 }
711
712 $grp
713 } 664 };
665
666 $grp
714} 667}
715 668
716=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 669=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
717 670
718Scans a directory (similar to C<aio_readdir>) but additionally tries to 671Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
766directory counting heuristic. 719directory counting heuristic.
767 720
768=cut 721=cut
769 722
770sub aio_scandir($$;$) { 723sub aio_scandir($$;$) {
771 aio_block {
772 my ($path, $maxreq, $cb) = @_; 724 my ($path, $maxreq, $cb) = @_;
773 725
774 my $pri = aioreq_pri; 726 my $pri = aioreq_pri;
775 727
776 my $grp = aio_group $cb; 728 my $grp = aio_group $cb;
777 729
778 $maxreq = 4 if $maxreq <= 0; 730 $maxreq = 4 if $maxreq <= 0;
779 731
780 # 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
781 aioreq_pri $pri; 740 aioreq_pri $pri;
782 add $grp aio_stat $path, sub { 741 add $grp aio_readdir $path, sub {
742 my $entries = shift
783 return $grp->result () if $_[0]; 743 or return $grp->result ();
784 my $now = time;
785 my $hash1 = join ":", (stat _)[0,1,3,7,9];
786 744
787 # read the directory entries 745 # stat the dir another time
788 aioreq_pri $pri; 746 aioreq_pri $pri;
789 add $grp aio_readdir $path, sub {
790 my $entries = shift
791 or return $grp->result ();
792
793 # stat the dir another time
794 aioreq_pri $pri;
795 add $grp aio_stat $path, sub { 747 add $grp aio_stat $path, sub {
796 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 748 my $hash2 = join ":", (stat _)[0,1,3,7,9];
797 749
798 my $ndirs; 750 my $ndirs;
799 751
800 # take the slow route if anything looks fishy 752 # take the slow route if anything looks fishy
801 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 753 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
802 $ndirs = -1; 754 $ndirs = -1;
803 } else { 755 } else {
804 # if nlink == 2, we are finished 756 # if nlink == 2, we are finished
805 # on non-posix-fs's, we rely on nlink < 2 757 # on non-posix-fs's, we rely on nlink < 2
806 $ndirs = (stat _)[3] - 2 758 $ndirs = (stat _)[3] - 2
807 or return $grp->result ([], $entries); 759 or return $grp->result ([], $entries);
808 } 760 }
809 761
810 # sort into likely dirs and likely nondirs 762 # sort into likely dirs and likely nondirs
811 # dirs == files without ".", short entries first 763 # dirs == files without ".", short entries first
812 $entries = [map $_->[0], 764 $entries = [map $_->[0],
813 sort { $b->[1] cmp $a->[1] } 765 sort { $b->[1] cmp $a->[1] }
814 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 766 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
815 @$entries]; 767 @$entries];
816 768
817 my (@dirs, @nondirs); 769 my (@dirs, @nondirs);
818 770
819 my $statgrp = add $grp aio_group sub { 771 my $statgrp = add $grp aio_group sub {
820 $grp->result (\@dirs, \@nondirs); 772 $grp->result (\@dirs, \@nondirs);
821 }; 773 };
822 774
823 limit $statgrp $maxreq; 775 limit $statgrp $maxreq;
824 feed $statgrp sub { 776 feed $statgrp sub {
825 return unless @$entries; 777 return unless @$entries;
826 my $entry = pop @$entries; 778 my $entry = pop @$entries;
827 779
828 aioreq_pri $pri; 780 aioreq_pri $pri;
829 add $statgrp aio_stat "$path/$entry/.", sub { 781 add $statgrp aio_stat "$path/$entry/.", sub {
830 if ($_[0] < 0) { 782 if ($_[0] < 0) {
831 push @nondirs, $entry; 783 push @nondirs, $entry;
832 } else { 784 } else {
833 # need to check for real directory 785 # need to check for real directory
834 aioreq_pri $pri; 786 aioreq_pri $pri;
835 add $statgrp aio_lstat "$path/$entry", sub { 787 add $statgrp aio_lstat "$path/$entry", sub {
836 if (-d _) { 788 if (-d _) {
837 push @dirs, $entry; 789 push @dirs, $entry;
838 790
839 unless (--$ndirs) { 791 unless (--$ndirs) {
840 push @nondirs, @$entries; 792 push @nondirs, @$entries;
841 feed $statgrp; 793 feed $statgrp;
842 }
843 } else {
844 push @nondirs, $entry;
845 } 794 }
795 } else {
796 push @nondirs, $entry;
846 } 797 }
847 } 798 }
848 }; 799 }
849 }; 800 };
850 }; 801 };
851 }; 802 };
852 }; 803 };
853
854 $grp
855 } 804 };
805
806 $grp
856} 807}
857 808
858=item aio_rmtree $path, $callback->($status) 809=item aio_rmtree $path, $callback->($status)
859 810
860Delete a directory tree starting (and including) C<$path>, return the 811Delete a directory tree starting (and including) C<$path>, return the
… …
864 815
865=cut 816=cut
866 817
867sub aio_rmtree; 818sub aio_rmtree;
868sub aio_rmtree($;$) { 819sub aio_rmtree($;$) {
869 aio_block {
870 my ($path, $cb) = @_; 820 my ($path, $cb) = @_;
871 821
872 my $pri = aioreq_pri; 822 my $pri = aioreq_pri;
873 my $grp = aio_group $cb; 823 my $grp = aio_group $cb;
874 824
875 aioreq_pri $pri; 825 aioreq_pri $pri;
876 add $grp aio_scandir $path, 0, sub { 826 add $grp aio_scandir $path, 0, sub {
877 my ($dirs, $nondirs) = @_; 827 my ($dirs, $nondirs) = @_;
878 828
879 my $dirgrp = aio_group sub { 829 my $dirgrp = aio_group sub {
880 add $grp aio_rmdir $path, sub { 830 add $grp aio_rmdir $path, sub {
881 $grp->result ($_[0]); 831 $grp->result ($_[0]);
882 };
883 }; 832 };
884
885 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
886 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
887
888 add $grp $dirgrp;
889 }; 833 };
890 834
891 $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;
892 } 839 };
840
841 $grp
893} 842}
843
844=item aio_sync $callback->($status)
845
846Asynchronously call sync and call the callback when finished.
894 847
895=item aio_fsync $fh, $callback->($status) 848=item aio_fsync $fh, $callback->($status)
896 849
897Asynchronously call fsync on the given filehandle and call the callback 850Asynchronously call fsync on the given filehandle and call the callback
898with the fsync result code. 851with the fsync result code.
… …
902Asynchronously call fdatasync on the given filehandle and call the 855Asynchronously call fdatasync on the given filehandle and call the
903callback with the fdatasync result code. 856callback with the fdatasync result code.
904 857
905If 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
906detected, 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}
907 898
908=item aio_group $callback->(...) 899=item aio_group $callback->(...)
909 900
910This 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
911container 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
… …
1048itself. 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.
1049 1040
1050=item $grp->result (...) 1041=item $grp->result (...)
1051 1042
1052Set 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
1053subrequests have finished and set thre groups errno to the current value 1044subrequests have finished and set the groups errno to the current value
1054of 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,
1055no argument will be passed and errno is zero. 1046no argument will be passed and errno is zero.
1056 1047
1057=item $grp->errno ([$errno]) 1048=item $grp->errno ([$errno])
1058 1049
… …
1256 1247
1257The default is probably ok in most situations, especially if thread 1248The default is probably ok in most situations, especially if thread
1258creation 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
1259want to use larger values. 1250want to use larger values.
1260 1251
1261=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1252=item IO::AIO::max_outstanding $maxreqs
1262 1253
1263This 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
1264blocks, 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
1265use an C<aio_group> together with a feed callback. 1256use an C<aio_group> together with a feed callback.
1266 1257
… …
1271 1262
1272The 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
1273number of outstanding requests. 1264number of outstanding requests.
1274 1265
1275You can still queue as many requests as you want. Therefore, 1266You can still queue as many requests as you want. Therefore,
1276C<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
1277as 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).
1278 1269
1279=back 1270=back
1280 1271
1281=head3 STATISTICAL INFORMATION 1272=head3 STATISTICAL INFORMATION

Diff Legend

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