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.120 by root, Sun Dec 2 21:51:36 2007 UTC vs.
Revision 1.143 by root, Thu Nov 20 09:01:40 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, urxvt, pureperl...) 31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 use AnyEvent::AIO;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 33
35 # EV integration 34 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37 36
38 # Event integration 37 # Event integration
… …
194use strict 'vars'; 193use strict 'vars';
195 194
196use base 'Exporter'; 195use base 'Exporter';
197 196
198BEGIN { 197BEGIN {
199 our $VERSION = '2.6'; 198 our $VERSION = '3.17';
200 199
201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
203 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
204 aio_fdatasync aio_pathsync aio_readahead 203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
205 aio_rename aio_link aio_move aio_copy aio_group 204 aio_rename aio_link aio_move aio_copy aio_group
206 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
207 aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
208 207
209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
211 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
212 nreqs nready npending nthreads 211 nreqs nready npending nthreads
213 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
214 215
215 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216 217
217 require XSLoader; 218 require XSLoader;
218 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
225All 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
226with 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,
227and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
228which 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
229the 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
230perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
231syscall has been executed asynchronously. 232syscall has been executed asynchronously.
232 233
233All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
234internally until the request has finished. 235internally until the request has finished.
235 236
… …
249your 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
250environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
251use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
252 253
253This 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
254handles correctly wether it is set or not. 255handles correctly whether it is set or not.
255 256
256=over 4 257=over 4
257 258
258=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
259 260
… …
322 323
323Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
324code. 325code.
325 326
326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
327closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
328what aio_close will try:
329 329
330 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
331 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
332 3. dup()licate the fd once more 332(the pipe fd will be created on demand and will be cached).
333 4. let perl close() the filehandle
334 5. asynchronously close the duplicated fd
335 333
336The idea is that the first close() flushes stuff to disk that closing an 334Or in other words: the file descriptor will be closed, but it will not be
337fd will flush, so when perl closes the fd, nothing much will need to be 335free for reuse until the perl filehandle is closed.
338flushed. The second async. close() will then flush stuff to disk that
339closing the last fd to the file will flush.
340
341Just FYI, SuSv3 has this to say on close:
342
343 All outstanding record locks owned by the process on the file
344 associated with the file descriptor shall be removed.
345
346 If fildes refers to a socket, close() shall cause the socket to be
347 destroyed. ... close() shall block for up to the current linger
348 interval until all data is transmitted.
349 [this actually sounds like a specification bug, but who knows]
350
351And at least Linux additionally actually flushes stuff on every close,
352even when the file itself is still open.
353
354Sounds enourmously inefficient and complicated? Yes... please show me how
355to nuke perl's fd out of existence...
356 336
357=cut 337=cut
358
359sub aio_close($;$) {
360 aio_block {
361 my ($fh, $cb) = @_;
362
363 my $pri = aioreq_pri;
364 my $grp = aio_group $cb;
365
366 my $fd = fileno $fh;
367
368 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
369
370 # if the dups fail we will simply get EBADF
371 my $fd2 = _dup $fd;
372 aioreq_pri $pri;
373 add $grp _aio_close $fd2, sub {
374 my $fd2 = _dup $fd;
375 close $fh;
376 aioreq_pri $pri;
377 add $grp _aio_close $fd2, sub {
378 $grp->result ($_[0]);
379 };
380 };
381
382 $grp
383 }
384}
385
386 338
387=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
388 340
389=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
390 342
… …
589memory. Status is the same as with aio_read. 541memory. Status is the same as with aio_read.
590 542
591=cut 543=cut
592 544
593sub aio_load($$;$) { 545sub aio_load($$;$) {
594 aio_block {
595 my ($path, undef, $cb) = @_; 546 my ($path, undef, $cb) = @_;
596 my $data = \$_[1]; 547 my $data = \$_[1];
597 548
598 my $pri = aioreq_pri; 549 my $pri = aioreq_pri;
599 my $grp = aio_group $cb; 550 my $grp = aio_group $cb;
551
552 aioreq_pri $pri;
553 add $grp aio_open $path, O_RDONLY, 0, sub {
554 my $fh = shift
555 or return $grp->result (-1);
600 556
601 aioreq_pri $pri; 557 aioreq_pri $pri;
602 add $grp aio_open $path, O_RDONLY, 0, sub {
603 my $fh = shift
604 or return $grp->result (-1);
605
606 aioreq_pri $pri;
607 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
608 $grp->result ($_[0]); 559 $grp->result ($_[0]);
609 };
610 }; 560 };
611
612 $grp
613 } 561 };
562
563 $grp
614} 564}
615 565
616=item aio_copy $srcpath, $dstpath, $callback->($status) 566=item aio_copy $srcpath, $dstpath, $callback->($status)
617 567
618Try to copy the I<file> (directories not supported as either source or 568Try to copy the I<file> (directories not supported as either source or
619destination) from C<$srcpath> to C<$dstpath> and call the callback with 569destination) from C<$srcpath> to C<$dstpath> and call the callback with
620the C<0> (error) or C<-1> ok. 570the C<0> (error) or C<-1> ok.
621 571
622This is a composite request that it creates the destination file with 572This is a composite request that creates the destination file with
623mode 0200 and copies the contents of the source file into it using 573mode 0200 and copies the contents of the source file into it using
624C<aio_sendfile>, followed by restoring atime, mtime, access mode and 574C<aio_sendfile>, followed by restoring atime, mtime, access mode and
625uid/gid, in that order. 575uid/gid, in that order.
626 576
627If an error occurs, the partial destination file will be unlinked, if 577If an error occurs, the partial destination file will be unlinked, if
… …
629errors are being ignored. 579errors are being ignored.
630 580
631=cut 581=cut
632 582
633sub aio_copy($$;$) { 583sub aio_copy($$;$) {
634 aio_block {
635 my ($src, $dst, $cb) = @_; 584 my ($src, $dst, $cb) = @_;
636 585
637 my $pri = aioreq_pri; 586 my $pri = aioreq_pri;
638 my $grp = aio_group $cb; 587 my $grp = aio_group $cb;
639 588
640 aioreq_pri $pri; 589 aioreq_pri $pri;
641 add $grp aio_open $src, O_RDONLY, 0, sub { 590 add $grp aio_open $src, O_RDONLY, 0, sub {
642 if (my $src_fh = $_[0]) { 591 if (my $src_fh = $_[0]) {
643 my @stat = stat $src_fh; 592 my @stat = stat $src_fh;
644 593
645 aioreq_pri $pri; 594 aioreq_pri $pri;
646 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 595 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
647 if (my $dst_fh = $_[0]) { 596 if (my $dst_fh = $_[0]) {
648 aioreq_pri $pri; 597 aioreq_pri $pri;
649 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 598 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
650 if ($_[0] == $stat[7]) { 599 if ($_[0] == $stat[7]) {
651 $grp->result (0); 600 $grp->result (0);
652 close $src_fh; 601 close $src_fh;
653 602
654 # those should not normally block. should. should. 603 # those should not normally block. should. should.
655 utime $stat[8], $stat[9], $dst; 604 utime $stat[8], $stat[9], $dst;
656 chmod $stat[2] & 07777, $dst_fh; 605 chmod $stat[2] & 07777, $dst_fh;
657 chown $stat[4], $stat[5], $dst_fh; 606 chown $stat[4], $stat[5], $dst_fh;
658 607
659 aioreq_pri $pri; 608 aioreq_pri $pri;
660 add $grp aio_close $dst_fh; 609 add $grp aio_close $dst_fh;
661 } else { 610 } else {
662 $grp->result (-1); 611 $grp->result (-1);
663 close $src_fh; 612 close $src_fh;
664 close $dst_fh; 613 close $dst_fh;
665 614
666 aioreq $pri; 615 aioreq $pri;
667 add $grp aio_unlink $dst; 616 add $grp aio_unlink $dst;
668 }
669 }; 617 }
670 } else {
671 $grp->result (-1);
672 } 618 };
619 } else {
620 $grp->result (-1);
673 }, 621 }
674
675 } else {
676 $grp->result (-1);
677 } 622 },
623
624 } else {
625 $grp->result (-1);
678 }; 626 }
679
680 $grp
681 } 627 };
628
629 $grp
682} 630}
683 631
684=item aio_move $srcpath, $dstpath, $callback->($status) 632=item aio_move $srcpath, $dstpath, $callback->($status)
685 633
686Try to move the I<file> (directories not supported as either source or 634Try to move the I<file> (directories not supported as either source or
687destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
688the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
689 637
690This is a composite request that tries to rename(2) the file first. If 638This is a composite request that tries to rename(2) the file first; if
691rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 639rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
692that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
693 641
694=cut 642=cut
695 643
696sub aio_move($$;$) { 644sub aio_move($$;$) {
697 aio_block {
698 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
699 646
700 my $pri = aioreq_pri; 647 my $pri = aioreq_pri;
701 my $grp = aio_group $cb; 648 my $grp = aio_group $cb;
702 649
703 aioreq_pri $pri; 650 aioreq_pri $pri;
704 add $grp aio_rename $src, $dst, sub { 651 add $grp aio_rename $src, $dst, sub {
705 if ($_[0] && $! == EXDEV) { 652 if ($_[0] && $! == EXDEV) {
706 aioreq_pri $pri; 653 aioreq_pri $pri;
707 add $grp aio_copy $src, $dst, sub { 654 add $grp aio_copy $src, $dst, sub {
708 $grp->result ($_[0]);
709
710 if (!$_[0]) {
711 aioreq_pri $pri;
712 add $grp aio_unlink $src;
713 }
714 };
715 } else {
716 $grp->result ($_[0]); 655 $grp->result ($_[0]);
656
657 if (!$_[0]) {
658 aioreq_pri $pri;
659 add $grp aio_unlink $src;
660 }
717 } 661 };
662 } else {
663 $grp->result ($_[0]);
718 }; 664 }
719
720 $grp
721 } 665 };
666
667 $grp
722} 668}
723 669
724=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 670=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
725 671
726Scans a directory (similar to C<aio_readdir>) but additionally tries to 672Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
774directory counting heuristic. 720directory counting heuristic.
775 721
776=cut 722=cut
777 723
778sub aio_scandir($$;$) { 724sub aio_scandir($$;$) {
779 aio_block {
780 my ($path, $maxreq, $cb) = @_; 725 my ($path, $maxreq, $cb) = @_;
781 726
782 my $pri = aioreq_pri; 727 my $pri = aioreq_pri;
783 728
784 my $grp = aio_group $cb; 729 my $grp = aio_group $cb;
785 730
786 $maxreq = 4 if $maxreq <= 0; 731 $maxreq = 4 if $maxreq <= 0;
787 732
788 # stat once 733 # stat once
734 aioreq_pri $pri;
735 add $grp aio_stat $path, sub {
736 return $grp->result () if $_[0];
737 my $now = time;
738 my $hash1 = join ":", (stat _)[0,1,3,7,9];
739
740 # read the directory entries
789 aioreq_pri $pri; 741 aioreq_pri $pri;
790 add $grp aio_stat $path, sub { 742 add $grp aio_readdir $path, sub {
743 my $entries = shift
791 return $grp->result () if $_[0]; 744 or return $grp->result ();
792 my $now = time;
793 my $hash1 = join ":", (stat _)[0,1,3,7,9];
794 745
795 # read the directory entries 746 # stat the dir another time
796 aioreq_pri $pri; 747 aioreq_pri $pri;
797 add $grp aio_readdir $path, sub {
798 my $entries = shift
799 or return $grp->result ();
800
801 # stat the dir another time
802 aioreq_pri $pri;
803 add $grp aio_stat $path, sub { 748 add $grp aio_stat $path, sub {
804 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 749 my $hash2 = join ":", (stat _)[0,1,3,7,9];
805 750
806 my $ndirs; 751 my $ndirs;
807 752
808 # take the slow route if anything looks fishy 753 # take the slow route if anything looks fishy
809 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 754 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
810 $ndirs = -1; 755 $ndirs = -1;
811 } else { 756 } else {
812 # if nlink == 2, we are finished 757 # if nlink == 2, we are finished
813 # on non-posix-fs's, we rely on nlink < 2 758 # on non-posix-fs's, we rely on nlink < 2
814 $ndirs = (stat _)[3] - 2 759 $ndirs = (stat _)[3] - 2
815 or return $grp->result ([], $entries); 760 or return $grp->result ([], $entries);
816 } 761 }
817 762
818 # sort into likely dirs and likely nondirs 763 # sort into likely dirs and likely nondirs
819 # dirs == files without ".", short entries first 764 # dirs == files without ".", short entries first
820 $entries = [map $_->[0], 765 $entries = [map $_->[0],
821 sort { $b->[1] cmp $a->[1] } 766 sort { $b->[1] cmp $a->[1] }
822 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 767 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
823 @$entries]; 768 @$entries];
824 769
825 my (@dirs, @nondirs); 770 my (@dirs, @nondirs);
826 771
827 my $statgrp = add $grp aio_group sub { 772 my $statgrp = add $grp aio_group sub {
828 $grp->result (\@dirs, \@nondirs); 773 $grp->result (\@dirs, \@nondirs);
829 }; 774 };
830 775
831 limit $statgrp $maxreq; 776 limit $statgrp $maxreq;
832 feed $statgrp sub { 777 feed $statgrp sub {
833 return unless @$entries; 778 return unless @$entries;
834 my $entry = pop @$entries; 779 my $entry = pop @$entries;
835 780
836 aioreq_pri $pri; 781 aioreq_pri $pri;
837 add $statgrp aio_stat "$path/$entry/.", sub { 782 add $statgrp aio_stat "$path/$entry/.", sub {
838 if ($_[0] < 0) { 783 if ($_[0] < 0) {
839 push @nondirs, $entry; 784 push @nondirs, $entry;
840 } else { 785 } else {
841 # need to check for real directory 786 # need to check for real directory
842 aioreq_pri $pri; 787 aioreq_pri $pri;
843 add $statgrp aio_lstat "$path/$entry", sub { 788 add $statgrp aio_lstat "$path/$entry", sub {
844 if (-d _) { 789 if (-d _) {
845 push @dirs, $entry; 790 push @dirs, $entry;
846 791
847 unless (--$ndirs) { 792 unless (--$ndirs) {
848 push @nondirs, @$entries; 793 push @nondirs, @$entries;
849 feed $statgrp; 794 feed $statgrp;
850 }
851 } else {
852 push @nondirs, $entry;
853 } 795 }
796 } else {
797 push @nondirs, $entry;
854 } 798 }
855 } 799 }
856 }; 800 }
857 }; 801 };
858 }; 802 };
859 }; 803 };
860 }; 804 };
861
862 $grp
863 } 805 };
806
807 $grp
864} 808}
865 809
866=item aio_rmtree $path, $callback->($status) 810=item aio_rmtree $path, $callback->($status)
867 811
868Delete a directory tree starting (and including) C<$path>, return the 812Delete a directory tree starting (and including) C<$path>, return the
… …
872 816
873=cut 817=cut
874 818
875sub aio_rmtree; 819sub aio_rmtree;
876sub aio_rmtree($;$) { 820sub aio_rmtree($;$) {
877 aio_block {
878 my ($path, $cb) = @_; 821 my ($path, $cb) = @_;
879 822
880 my $pri = aioreq_pri; 823 my $pri = aioreq_pri;
881 my $grp = aio_group $cb; 824 my $grp = aio_group $cb;
882 825
883 aioreq_pri $pri; 826 aioreq_pri $pri;
884 add $grp aio_scandir $path, 0, sub { 827 add $grp aio_scandir $path, 0, sub {
885 my ($dirs, $nondirs) = @_; 828 my ($dirs, $nondirs) = @_;
886 829
887 my $dirgrp = aio_group sub { 830 my $dirgrp = aio_group sub {
888 add $grp aio_rmdir $path, sub { 831 add $grp aio_rmdir $path, sub {
889 $grp->result ($_[0]); 832 $grp->result ($_[0]);
890 };
891 }; 833 };
892
893 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
894 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
895
896 add $grp $dirgrp;
897 }; 834 };
898 835
899 $grp 836 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
837 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
838
839 add $grp $dirgrp;
900 } 840 };
841
842 $grp
901} 843}
902 844
903=item aio_sync $callback->($status) 845=item aio_sync $callback->($status)
904 846
905Asynchronously call sync and call the callback when finished. 847Asynchronously call sync and call the callback when finished.
… …
915callback with the fdatasync result code. 857callback with the fdatasync result code.
916 858
917If this call isn't available because your OS lacks it or it couldn't be 859If this call isn't available because your OS lacks it or it couldn't be
918detected, it will be emulated by calling C<fsync> instead. 860detected, it will be emulated by calling C<fsync> instead.
919 861
862=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
863
864Sync the data portion of the file specified by C<$offset> and C<$length>
865to disk (but NOT the metadata), by calling the Linux-specific
866sync_file_range call. If sync_file_range is not available or it returns
867ENOSYS, then fdatasync or fsync is being substituted.
868
869C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
870C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
871C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
872manpage for details.
873
920=item aio_pathsync $path, $callback->($status) 874=item aio_pathsync $path, $callback->($status)
921 875
922This request tries to open, fsync and close the given path. This is a 876This request tries to open, fsync and close the given path. This is a
923composite request intended tosync directories after directory operations 877composite request intended to sync directories after directory operations
924(E.g. rename). This might not work on all operating systems or have any 878(E.g. rename). This might not work on all operating systems or have any
925specific effect, but usually it makes sure that directory changes get 879specific effect, but usually it makes sure that directory changes get
926written to disc. It works for anything that can be opened for read-only, 880written to disc. It works for anything that can be opened for read-only,
927not just directories. 881not just directories.
928 882
929Passes C<0> when everything went ok, and C<-1> on error. 883Passes C<0> when everything went ok, and C<-1> on error.
930 884
931=cut 885=cut
932 886
933sub aio_pathsync($;$) { 887sub aio_pathsync($;$) {
934 aio_block {
935 my ($path, $cb) = @_; 888 my ($path, $cb) = @_;
936 889
937 my $pri = aioreq_pri; 890 my $pri = aioreq_pri;
938 my $grp = aio_group $cb; 891 my $grp = aio_group $cb;
939 892
940 aioreq_pri $pri; 893 aioreq_pri $pri;
941 add $grp aio_open $path, O_RDONLY, 0, sub { 894 add $grp aio_open $path, O_RDONLY, 0, sub {
942 my ($fh) = @_; 895 my ($fh) = @_;
943 if ($fh) { 896 if ($fh) {
897 aioreq_pri $pri;
898 add $grp aio_fsync $fh, sub {
899 $grp->result ($_[0]);
900
944 aioreq_pri $pri; 901 aioreq_pri $pri;
945 add $grp aio_fsync $fh, sub {
946 $grp->result ($_[0]);
947
948 aioreq_pri $pri;
949 add $grp aio_close $fh; 902 add $grp aio_close $fh;
950 };
951 } else {
952 $grp->result (-1);
953 } 903 };
904 } else {
905 $grp->result (-1);
954 }; 906 }
955
956 $grp
957 } 907 };
908
909 $grp
958} 910}
959 911
960=item aio_group $callback->(...) 912=item aio_group $callback->(...)
961 913
962This is a very special aio request: Instead of doing something, it is a 914This is a very special aio request: Instead of doing something, it is a
… …
1075Their lifetime, simplified, looks like this: when they are empty, they 1027Their lifetime, simplified, looks like this: when they are empty, they
1076will finish very quickly. If they contain only requests that are in the 1028will finish very quickly. If they contain only requests that are in the
1077C<done> state, they will also finish. Otherwise they will continue to 1029C<done> state, they will also finish. Otherwise they will continue to
1078exist. 1030exist.
1079 1031
1080That means after creating a group you have some time to add requests. And 1032That means after creating a group you have some time to add requests
1081in the callbacks of those requests, you can add further requests to the 1033(precisely before the callback has been invoked, which is only done within
1082group. And only when all those requests have finished will the the group 1034the C<poll_cb>). And in the callbacks of those requests, you can add
1083itself finish. 1035further requests to the group. And only when all those requests have
1036finished will the the group itself finish.
1084 1037
1085=over 4 1038=over 4
1086 1039
1087=item add $grp ... 1040=item add $grp ...
1088 1041
… …
1121=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1122 1075
1123Sets a feeder/generator on this group: every group can have an attached 1076Sets a feeder/generator on this group: every group can have an attached
1124generator that generates requests if idle. The idea behind this is that, 1077generator that generates requests if idle. The idea behind this is that,
1125although you could just queue as many requests as you want in a group, 1078although you could just queue as many requests as you want in a group,
1126this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1127example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1128requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1129 1082
1130To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1131instead a group and set a feeder on it that generates those requests. The 1084instead a group and set a feeder on it that generates those requests. The
1132feed callback will be called whenever there are few enough (see C<limit>, 1085feed callback will be called whenever there are few enough (see C<limit>,
1133below) requests active in the group itself and is expected to queue more 1086below) requests active in the group itself and is expected to queue more
… …
1137not impose any limits). 1090not impose any limits).
1138 1091
1139If the feed does not queue more requests when called, it will be 1092If the feed does not queue more requests when called, it will be
1140automatically removed from the group. 1093automatically removed from the group.
1141 1094
1142If the feed limit is C<0>, it will be set to C<2> automatically. 1095If the feed limit is C<0> when this method is called, it will be set to
1096C<2> automatically.
1143 1097
1144Example: 1098Example:
1145 1099
1146 # stat all files in @files, but only ever use four aio requests concurrently: 1100 # stat all files in @files, but only ever use four aio requests concurrently:
1147 1101
… …
1159Sets the feeder limit for the group: The feeder will be called whenever 1113Sets the feeder limit for the group: The feeder will be called whenever
1160the group contains less than this many requests. 1114the group contains less than this many requests.
1161 1115
1162Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1163 1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1120
1164=back 1121=back
1165 1122
1166=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1167 1124
1168=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1125=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1179See C<poll_cb> for an example. 1136See C<poll_cb> for an example.
1180 1137
1181=item IO::AIO::poll_cb 1138=item IO::AIO::poll_cb
1182 1139
1183Process some outstanding events on the result pipe. You have to call this 1140Process some outstanding events on the result pipe. You have to call this
1184regularly. Returns the number of events processed. Returns immediately 1141regularly. Returns C<0> if all events could be processed, or C<-1> if it
1142returned earlier for whatever reason. Returns immediately when no events
1185when no events are outstanding. The amount of events processed depends on 1143are outstanding. The amount of events processed depends on the settings of
1186the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1144C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1187 1145
1188If not all requests were processed for whatever reason, the filehandle 1146If not all requests were processed for whatever reason, the filehandle
1189will still be ready when C<poll_cb> returns. 1147will still be ready when C<poll_cb> returns, so normally you don't have to
1148do anything special to have it called later.
1190 1149
1191Example: Install an Event watcher that automatically calls 1150Example: Install an Event watcher that automatically calls
1192IO::AIO::poll_cb with high priority: 1151IO::AIO::poll_cb with high priority:
1193 1152
1194 Event->io (fd => IO::AIO::poll_fileno, 1153 Event->io (fd => IO::AIO::poll_fileno,
… …
1308 1267
1309The default is probably ok in most situations, especially if thread 1268The default is probably ok in most situations, especially if thread
1310creation is fast. If thread creation is very slow on your system you might 1269creation is fast. If thread creation is very slow on your system you might
1311want to use larger values. 1270want to use larger values.
1312 1271
1313=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1272=item IO::AIO::max_outstanding $maxreqs
1314 1273
1315This is a very bad function to use in interactive programs because it 1274This is a very bad function to use in interactive programs because it
1316blocks, and a bad way to reduce concurrency because it is inexact: Better 1275blocks, and a bad way to reduce concurrency because it is inexact: Better
1317use an C<aio_group> together with a feed callback. 1276use an C<aio_group> together with a feed callback.
1318 1277
… …
1323 1282
1324The default value is very large, so there is no practical limit on the 1283The default value is very large, so there is no practical limit on the
1325number of outstanding requests. 1284number of outstanding requests.
1326 1285
1327You can still queue as many requests as you want. Therefore, 1286You can still queue as many requests as you want. Therefore,
1328C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1287C<max_outstanding> is mainly useful in simple scripts (with low values) or
1329as a stop gap to shield against fatal memory overflow (with large values). 1288as a stop gap to shield against fatal memory overflow (with large values).
1330 1289
1331=back 1290=back
1332 1291
1333=head3 STATISTICAL INFORMATION 1292=head3 STATISTICAL INFORMATION
… …
1403 1362
1404Known bugs will be fixed in the next release. 1363Known bugs will be fixed in the next release.
1405 1364
1406=head1 SEE ALSO 1365=head1 SEE ALSO
1407 1366
1408L<Coro::AIO>. 1367L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1368more natural syntax.
1409 1369
1410=head1 AUTHOR 1370=head1 AUTHOR
1411 1371
1412 Marc Lehmann <schmorp@schmorp.de> 1372 Marc Lehmann <schmorp@schmorp.de>
1413 http://home.schmorp.de/ 1373 http://home.schmorp.de/

Diff Legend

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