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.125 by root, Sat May 10 22:47:34 2008 UTC

… …
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, 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);
… …
191use strict 'vars'; 193use strict 'vars';
192 194
193use base 'Exporter'; 195use base 'Exporter';
194 196
195BEGIN { 197BEGIN {
196 our $VERSION = '2.51'; 198 our $VERSION = '3.0';
197 199
198 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
199 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
200 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_pathsync aio_readahead
204 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 205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
202 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
203 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
204 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
205 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
206 nreqs nready npending nthreads 211 nreqs nready npending nthreads
207 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
208 213
… …
316 321
317Asynchronously close a file and call the callback with the result 322Asynchronously close a file and call the callback with the result
318code. 323code.
319 324
320Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 325Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
321closing the file descriptor associated with the filehandle itself. Here is 326closing the file descriptor associated with the filehandle itself.
322what aio_close will try:
323 327
324 1. dup()licate the fd 328Therefore, C<aio_close> will not close the filehandle - instead it will
325 2. asynchronously close() the duplicated fd 329use dup2 to overwrite the file descriptor with the write-end of a pipe
326 3. dup()licate the fd once more 330(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 331
330The idea is that the first close() flushes stuff to disk that closing an 332Or 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 333free 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 334
351=cut 335=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 336
381=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 337=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
382 338
383=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
384 340
… …
583memory. Status is the same as with aio_read. 539memory. Status is the same as with aio_read.
584 540
585=cut 541=cut
586 542
587sub aio_load($$;$) { 543sub aio_load($$;$) {
588 aio_block {
589 my ($path, undef, $cb) = @_; 544 my ($path, undef, $cb) = @_;
590 my $data = \$_[1]; 545 my $data = \$_[1];
591 546
592 my $pri = aioreq_pri; 547 my $pri = aioreq_pri;
593 my $grp = aio_group $cb; 548 my $grp = aio_group $cb;
549
550 aioreq_pri $pri;
551 add $grp aio_open $path, O_RDONLY, 0, sub {
552 my $fh = shift
553 or return $grp->result (-1);
594 554
595 aioreq_pri $pri; 555 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 { 556 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
602 $grp->result ($_[0]); 557 $grp->result ($_[0]);
603 };
604 }; 558 };
605
606 $grp
607 } 559 };
560
561 $grp
608} 562}
609 563
610=item aio_copy $srcpath, $dstpath, $callback->($status) 564=item aio_copy $srcpath, $dstpath, $callback->($status)
611 565
612Try to copy the I<file> (directories not supported as either source or 566Try to copy the I<file> (directories not supported as either source or
… …
623errors are being ignored. 577errors are being ignored.
624 578
625=cut 579=cut
626 580
627sub aio_copy($$;$) { 581sub aio_copy($$;$) {
628 aio_block {
629 my ($src, $dst, $cb) = @_; 582 my ($src, $dst, $cb) = @_;
630 583
631 my $pri = aioreq_pri; 584 my $pri = aioreq_pri;
632 my $grp = aio_group $cb; 585 my $grp = aio_group $cb;
633 586
634 aioreq_pri $pri; 587 aioreq_pri $pri;
635 add $grp aio_open $src, O_RDONLY, 0, sub { 588 add $grp aio_open $src, O_RDONLY, 0, sub {
636 if (my $src_fh = $_[0]) { 589 if (my $src_fh = $_[0]) {
637 my @stat = stat $src_fh; 590 my @stat = stat $src_fh;
638 591
639 aioreq_pri $pri; 592 aioreq_pri $pri;
640 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 593 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
641 if (my $dst_fh = $_[0]) { 594 if (my $dst_fh = $_[0]) {
642 aioreq_pri $pri; 595 aioreq_pri $pri;
643 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 596 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
644 if ($_[0] == $stat[7]) { 597 if ($_[0] == $stat[7]) {
645 $grp->result (0); 598 $grp->result (0);
646 close $src_fh; 599 close $src_fh;
647 600
648 # those should not normally block. should. should. 601 # those should not normally block. should. should.
649 utime $stat[8], $stat[9], $dst; 602 utime $stat[8], $stat[9], $dst;
650 chmod $stat[2] & 07777, $dst_fh; 603 chmod $stat[2] & 07777, $dst_fh;
651 chown $stat[4], $stat[5], $dst_fh; 604 chown $stat[4], $stat[5], $dst_fh;
605
606 aioreq_pri $pri;
652 close $dst_fh; 607 add $grp aio_close $dst_fh;
653 } else { 608 } else {
654 $grp->result (-1); 609 $grp->result (-1);
655 close $src_fh; 610 close $src_fh;
656 close $dst_fh; 611 close $dst_fh;
657 612
658 aioreq $pri; 613 aioreq $pri;
659 add $grp aio_unlink $dst; 614 add $grp aio_unlink $dst;
660 }
661 }; 615 }
662 } else {
663 $grp->result (-1);
664 } 616 };
617 } else {
618 $grp->result (-1);
665 }, 619 }
666
667 } else {
668 $grp->result (-1);
669 } 620 },
621
622 } else {
623 $grp->result (-1);
670 }; 624 }
671
672 $grp
673 } 625 };
626
627 $grp
674} 628}
675 629
676=item aio_move $srcpath, $dstpath, $callback->($status) 630=item aio_move $srcpath, $dstpath, $callback->($status)
677 631
678Try to move the I<file> (directories not supported as either source or 632Try to move the I<file> (directories not supported as either source or
… …
684that is successful, unlinking the C<$srcpath>. 638that is successful, unlinking the C<$srcpath>.
685 639
686=cut 640=cut
687 641
688sub aio_move($$;$) { 642sub aio_move($$;$) {
689 aio_block {
690 my ($src, $dst, $cb) = @_; 643 my ($src, $dst, $cb) = @_;
691 644
692 my $pri = aioreq_pri; 645 my $pri = aioreq_pri;
693 my $grp = aio_group $cb; 646 my $grp = aio_group $cb;
694 647
695 aioreq_pri $pri; 648 aioreq_pri $pri;
696 add $grp aio_rename $src, $dst, sub { 649 add $grp aio_rename $src, $dst, sub {
697 if ($_[0] && $! == EXDEV) { 650 if ($_[0] && $! == EXDEV) {
698 aioreq_pri $pri; 651 aioreq_pri $pri;
699 add $grp aio_copy $src, $dst, sub { 652 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]); 653 $grp->result ($_[0]);
654
655 if (!$_[0]) {
656 aioreq_pri $pri;
657 add $grp aio_unlink $src;
658 }
709 } 659 };
660 } else {
661 $grp->result ($_[0]);
710 }; 662 }
711
712 $grp
713 } 663 };
664
665 $grp
714} 666}
715 667
716=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 668=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
717 669
718Scans a directory (similar to C<aio_readdir>) but additionally tries to 670Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
766directory counting heuristic. 718directory counting heuristic.
767 719
768=cut 720=cut
769 721
770sub aio_scandir($$;$) { 722sub aio_scandir($$;$) {
771 aio_block {
772 my ($path, $maxreq, $cb) = @_; 723 my ($path, $maxreq, $cb) = @_;
773 724
774 my $pri = aioreq_pri; 725 my $pri = aioreq_pri;
775 726
776 my $grp = aio_group $cb; 727 my $grp = aio_group $cb;
777 728
778 $maxreq = 4 if $maxreq <= 0; 729 $maxreq = 4 if $maxreq <= 0;
779 730
780 # stat once 731 # stat once
732 aioreq_pri $pri;
733 add $grp aio_stat $path, sub {
734 return $grp->result () if $_[0];
735 my $now = time;
736 my $hash1 = join ":", (stat _)[0,1,3,7,9];
737
738 # read the directory entries
781 aioreq_pri $pri; 739 aioreq_pri $pri;
782 add $grp aio_stat $path, sub { 740 add $grp aio_readdir $path, sub {
741 my $entries = shift
783 return $grp->result () if $_[0]; 742 or return $grp->result ();
784 my $now = time;
785 my $hash1 = join ":", (stat _)[0,1,3,7,9];
786 743
787 # read the directory entries 744 # stat the dir another time
788 aioreq_pri $pri; 745 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 { 746 add $grp aio_stat $path, sub {
796 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 747 my $hash2 = join ":", (stat _)[0,1,3,7,9];
797 748
798 my $ndirs; 749 my $ndirs;
799 750
800 # take the slow route if anything looks fishy 751 # take the slow route if anything looks fishy
801 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 752 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
802 $ndirs = -1; 753 $ndirs = -1;
803 } else { 754 } else {
804 # if nlink == 2, we are finished 755 # if nlink == 2, we are finished
805 # on non-posix-fs's, we rely on nlink < 2 756 # on non-posix-fs's, we rely on nlink < 2
806 $ndirs = (stat _)[3] - 2 757 $ndirs = (stat _)[3] - 2
807 or return $grp->result ([], $entries); 758 or return $grp->result ([], $entries);
808 } 759 }
809 760
810 # sort into likely dirs and likely nondirs 761 # sort into likely dirs and likely nondirs
811 # dirs == files without ".", short entries first 762 # dirs == files without ".", short entries first
812 $entries = [map $_->[0], 763 $entries = [map $_->[0],
813 sort { $b->[1] cmp $a->[1] } 764 sort { $b->[1] cmp $a->[1] }
814 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 765 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
815 @$entries]; 766 @$entries];
816 767
817 my (@dirs, @nondirs); 768 my (@dirs, @nondirs);
818 769
819 my $statgrp = add $grp aio_group sub { 770 my $statgrp = add $grp aio_group sub {
820 $grp->result (\@dirs, \@nondirs); 771 $grp->result (\@dirs, \@nondirs);
821 }; 772 };
822 773
823 limit $statgrp $maxreq; 774 limit $statgrp $maxreq;
824 feed $statgrp sub { 775 feed $statgrp sub {
825 return unless @$entries; 776 return unless @$entries;
826 my $entry = pop @$entries; 777 my $entry = pop @$entries;
827 778
828 aioreq_pri $pri; 779 aioreq_pri $pri;
829 add $statgrp aio_stat "$path/$entry/.", sub { 780 add $statgrp aio_stat "$path/$entry/.", sub {
830 if ($_[0] < 0) { 781 if ($_[0] < 0) {
831 push @nondirs, $entry; 782 push @nondirs, $entry;
832 } else { 783 } else {
833 # need to check for real directory 784 # need to check for real directory
834 aioreq_pri $pri; 785 aioreq_pri $pri;
835 add $statgrp aio_lstat "$path/$entry", sub { 786 add $statgrp aio_lstat "$path/$entry", sub {
836 if (-d _) { 787 if (-d _) {
837 push @dirs, $entry; 788 push @dirs, $entry;
838 789
839 unless (--$ndirs) { 790 unless (--$ndirs) {
840 push @nondirs, @$entries; 791 push @nondirs, @$entries;
841 feed $statgrp; 792 feed $statgrp;
842 }
843 } else {
844 push @nondirs, $entry;
845 } 793 }
794 } else {
795 push @nondirs, $entry;
846 } 796 }
847 } 797 }
848 }; 798 }
849 }; 799 };
850 }; 800 };
851 }; 801 };
852 }; 802 };
853
854 $grp
855 } 803 };
804
805 $grp
856} 806}
857 807
858=item aio_rmtree $path, $callback->($status) 808=item aio_rmtree $path, $callback->($status)
859 809
860Delete a directory tree starting (and including) C<$path>, return the 810Delete a directory tree starting (and including) C<$path>, return the
… …
864 814
865=cut 815=cut
866 816
867sub aio_rmtree; 817sub aio_rmtree;
868sub aio_rmtree($;$) { 818sub aio_rmtree($;$) {
869 aio_block {
870 my ($path, $cb) = @_; 819 my ($path, $cb) = @_;
871 820
872 my $pri = aioreq_pri; 821 my $pri = aioreq_pri;
873 my $grp = aio_group $cb; 822 my $grp = aio_group $cb;
874 823
875 aioreq_pri $pri; 824 aioreq_pri $pri;
876 add $grp aio_scandir $path, 0, sub { 825 add $grp aio_scandir $path, 0, sub {
877 my ($dirs, $nondirs) = @_; 826 my ($dirs, $nondirs) = @_;
878 827
879 my $dirgrp = aio_group sub { 828 my $dirgrp = aio_group sub {
880 add $grp aio_rmdir $path, sub { 829 add $grp aio_rmdir $path, sub {
881 $grp->result ($_[0]); 830 $grp->result ($_[0]);
882 };
883 }; 831 };
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 }; 832 };
890 833
891 $grp 834 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
835 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
836
837 add $grp $dirgrp;
892 } 838 };
839
840 $grp
893} 841}
842
843=item aio_sync $callback->($status)
844
845Asynchronously call sync and call the callback when finished.
894 846
895=item aio_fsync $fh, $callback->($status) 847=item aio_fsync $fh, $callback->($status)
896 848
897Asynchronously call fsync on the given filehandle and call the callback 849Asynchronously call fsync on the given filehandle and call the callback
898with the fsync result code. 850with the fsync result code.
… …
902Asynchronously call fdatasync on the given filehandle and call the 854Asynchronously call fdatasync on the given filehandle and call the
903callback with the fdatasync result code. 855callback with the fdatasync result code.
904 856
905If this call isn't available because your OS lacks it or it couldn't be 857If 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. 858detected, it will be emulated by calling C<fsync> instead.
859
860=item aio_pathsync $path, $callback->($status)
861
862This request tries to open, fsync and close the given path. This is a
863composite request intended tosync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any
865specific effect, but usually it makes sure that directory changes get
866written to disc. It works for anything that can be opened for read-only,
867not just directories.
868
869Passes C<0> when everything went ok, and C<-1> on error.
870
871=cut
872
873sub aio_pathsync($;$) {
874 my ($path, $cb) = @_;
875
876 my $pri = aioreq_pri;
877 my $grp = aio_group $cb;
878
879 aioreq_pri $pri;
880 add $grp aio_open $path, O_RDONLY, 0, sub {
881 my ($fh) = @_;
882 if ($fh) {
883 aioreq_pri $pri;
884 add $grp aio_fsync $fh, sub {
885 $grp->result ($_[0]);
886
887 aioreq_pri $pri;
888 add $grp aio_close $fh;
889 };
890 } else {
891 $grp->result (-1);
892 }
893 };
894
895 $grp
896}
907 897
908=item aio_group $callback->(...) 898=item aio_group $callback->(...)
909 899
910This is a very special aio request: Instead of doing something, it is a 900This 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 901container 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. 1038itself. Useful when you queued a lot of events but got a result early.
1049 1039
1050=item $grp->result (...) 1040=item $grp->result (...)
1051 1041
1052Set the result value(s) that will be passed to the group callback when all 1042Set 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 1043subrequests have finished and set the groups errno to the current value
1054of errno (just like calling C<errno> without an error number). By default, 1044of errno (just like calling C<errno> without an error number). By default,
1055no argument will be passed and errno is zero. 1045no argument will be passed and errno is zero.
1056 1046
1057=item $grp->errno ([$errno]) 1047=item $grp->errno ([$errno])
1058 1048
… …
1256 1246
1257The default is probably ok in most situations, especially if thread 1247The default is probably ok in most situations, especially if thread
1258creation is fast. If thread creation is very slow on your system you might 1248creation is fast. If thread creation is very slow on your system you might
1259want to use larger values. 1249want to use larger values.
1260 1250
1261=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1251=item IO::AIO::max_outstanding $maxreqs
1262 1252
1263This is a very bad function to use in interactive programs because it 1253This 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 1254blocks, and a bad way to reduce concurrency because it is inexact: Better
1265use an C<aio_group> together with a feed callback. 1255use an C<aio_group> together with a feed callback.
1266 1256
… …
1271 1261
1272The default value is very large, so there is no practical limit on the 1262The default value is very large, so there is no practical limit on the
1273number of outstanding requests. 1263number of outstanding requests.
1274 1264
1275You can still queue as many requests as you want. Therefore, 1265You can still queue as many requests as you want. Therefore,
1276C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1266C<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). 1267as a stop gap to shield against fatal memory overflow (with large values).
1278 1268
1279=back 1269=back
1280 1270
1281=head3 STATISTICAL INFORMATION 1271=head3 STATISTICAL INFORMATION
… …
1351 1341
1352Known bugs will be fixed in the next release. 1342Known bugs will be fixed in the next release.
1353 1343
1354=head1 SEE ALSO 1344=head1 SEE ALSO
1355 1345
1356L<Coro::AIO>. 1346L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1347more natural syntax.
1357 1348
1358=head1 AUTHOR 1349=head1 AUTHOR
1359 1350
1360 Marc Lehmann <schmorp@schmorp.de> 1351 Marc Lehmann <schmorp@schmorp.de>
1361 http://home.schmorp.de/ 1352 http://home.schmorp.de/

Diff Legend

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