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.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, 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.17';
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_sync_file_range 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);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
208 215
209 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
210 217
211 require XSLoader; 218 require XSLoader;
212 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
219All 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
220with 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,
221and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
222which 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
223the 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
224perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
225syscall has been executed asynchronously. 232syscall has been executed asynchronously.
226 233
227All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
228internally until the request has finished. 235internally until the request has finished.
229 236
… …
243your 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
244environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
245use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
246 253
247This 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
248handles correctly wether it is set or not. 255handles correctly whether it is set or not.
249 256
250=over 4 257=over 4
251 258
252=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
253 260
… …
316 323
317Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
318code. 325code.
319 326
320Unfortunately, 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
321closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
322what aio_close will try:
323 329
324 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
325 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
326 3. dup()licate the fd once more 332(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 333
330The 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
331fd will flush, so when perl closes the fd, nothing much will need to be 335free 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 336
351=cut 337=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 338
381=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
382 340
383=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
384 342
… …
583memory. Status is the same as with aio_read. 541memory. Status is the same as with aio_read.
584 542
585=cut 543=cut
586 544
587sub aio_load($$;$) { 545sub aio_load($$;$) {
588 aio_block {
589 my ($path, undef, $cb) = @_; 546 my ($path, undef, $cb) = @_;
590 my $data = \$_[1]; 547 my $data = \$_[1];
591 548
592 my $pri = aioreq_pri; 549 my $pri = aioreq_pri;
593 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);
594 556
595 aioreq_pri $pri; 557 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 { 558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
602 $grp->result ($_[0]); 559 $grp->result ($_[0]);
603 };
604 }; 560 };
605
606 $grp
607 } 561 };
562
563 $grp
608} 564}
609 565
610=item aio_copy $srcpath, $dstpath, $callback->($status) 566=item aio_copy $srcpath, $dstpath, $callback->($status)
611 567
612Try 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
613destination) from C<$srcpath> to C<$dstpath> and call the callback with 569destination) from C<$srcpath> to C<$dstpath> and call the callback with
614the C<0> (error) or C<-1> ok. 570the C<0> (error) or C<-1> ok.
615 571
616This is a composite request that it creates the destination file with 572This is a composite request that creates the destination file with
617mode 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
618C<aio_sendfile>, followed by restoring atime, mtime, access mode and 574C<aio_sendfile>, followed by restoring atime, mtime, access mode and
619uid/gid, in that order. 575uid/gid, in that order.
620 576
621If an error occurs, the partial destination file will be unlinked, if 577If an error occurs, the partial destination file will be unlinked, if
… …
623errors are being ignored. 579errors are being ignored.
624 580
625=cut 581=cut
626 582
627sub aio_copy($$;$) { 583sub aio_copy($$;$) {
628 aio_block {
629 my ($src, $dst, $cb) = @_; 584 my ($src, $dst, $cb) = @_;
630 585
631 my $pri = aioreq_pri; 586 my $pri = aioreq_pri;
632 my $grp = aio_group $cb; 587 my $grp = aio_group $cb;
633 588
634 aioreq_pri $pri; 589 aioreq_pri $pri;
635 add $grp aio_open $src, O_RDONLY, 0, sub { 590 add $grp aio_open $src, O_RDONLY, 0, sub {
636 if (my $src_fh = $_[0]) { 591 if (my $src_fh = $_[0]) {
637 my @stat = stat $src_fh; 592 my @stat = stat $src_fh;
638 593
639 aioreq_pri $pri; 594 aioreq_pri $pri;
640 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 {
641 if (my $dst_fh = $_[0]) { 596 if (my $dst_fh = $_[0]) {
642 aioreq_pri $pri; 597 aioreq_pri $pri;
643 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 {
644 if ($_[0] == $stat[7]) { 599 if ($_[0] == $stat[7]) {
645 $grp->result (0); 600 $grp->result (0);
646 close $src_fh; 601 close $src_fh;
647 602
648 # those should not normally block. should. should. 603 # those should not normally block. should. should.
649 utime $stat[8], $stat[9], $dst; 604 utime $stat[8], $stat[9], $dst;
650 chmod $stat[2] & 07777, $dst_fh; 605 chmod $stat[2] & 07777, $dst_fh;
651 chown $stat[4], $stat[5], $dst_fh; 606 chown $stat[4], $stat[5], $dst_fh;
607
608 aioreq_pri $pri;
652 close $dst_fh; 609 add $grp aio_close $dst_fh;
653 } else { 610 } else {
654 $grp->result (-1); 611 $grp->result (-1);
655 close $src_fh; 612 close $src_fh;
656 close $dst_fh; 613 close $dst_fh;
657 614
658 aioreq $pri; 615 aioreq $pri;
659 add $grp aio_unlink $dst; 616 add $grp aio_unlink $dst;
660 }
661 }; 617 }
662 } else {
663 $grp->result (-1);
664 } 618 };
619 } else {
620 $grp->result (-1);
665 }, 621 }
666
667 } else {
668 $grp->result (-1);
669 } 622 },
623
624 } else {
625 $grp->result (-1);
670 }; 626 }
671
672 $grp
673 } 627 };
628
629 $grp
674} 630}
675 631
676=item aio_move $srcpath, $dstpath, $callback->($status) 632=item aio_move $srcpath, $dstpath, $callback->($status)
677 633
678Try 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
679destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
680the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
681 637
682This 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
683rename 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
684that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
685 641
686=cut 642=cut
687 643
688sub aio_move($$;$) { 644sub aio_move($$;$) {
689 aio_block {
690 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
691 646
692 my $pri = aioreq_pri; 647 my $pri = aioreq_pri;
693 my $grp = aio_group $cb; 648 my $grp = aio_group $cb;
694 649
695 aioreq_pri $pri; 650 aioreq_pri $pri;
696 add $grp aio_rename $src, $dst, sub { 651 add $grp aio_rename $src, $dst, sub {
697 if ($_[0] && $! == EXDEV) { 652 if ($_[0] && $! == EXDEV) {
698 aioreq_pri $pri; 653 aioreq_pri $pri;
699 add $grp aio_copy $src, $dst, sub { 654 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]); 655 $grp->result ($_[0]);
656
657 if (!$_[0]) {
658 aioreq_pri $pri;
659 add $grp aio_unlink $src;
660 }
709 } 661 };
662 } else {
663 $grp->result ($_[0]);
710 }; 664 }
711
712 $grp
713 } 665 };
666
667 $grp
714} 668}
715 669
716=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 670=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
717 671
718Scans a directory (similar to C<aio_readdir>) but additionally tries to 672Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
766directory counting heuristic. 720directory counting heuristic.
767 721
768=cut 722=cut
769 723
770sub aio_scandir($$;$) { 724sub aio_scandir($$;$) {
771 aio_block {
772 my ($path, $maxreq, $cb) = @_; 725 my ($path, $maxreq, $cb) = @_;
773 726
774 my $pri = aioreq_pri; 727 my $pri = aioreq_pri;
775 728
776 my $grp = aio_group $cb; 729 my $grp = aio_group $cb;
777 730
778 $maxreq = 4 if $maxreq <= 0; 731 $maxreq = 4 if $maxreq <= 0;
779 732
780 # 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
781 aioreq_pri $pri; 741 aioreq_pri $pri;
782 add $grp aio_stat $path, sub { 742 add $grp aio_readdir $path, sub {
743 my $entries = shift
783 return $grp->result () if $_[0]; 744 or return $grp->result ();
784 my $now = time;
785 my $hash1 = join ":", (stat _)[0,1,3,7,9];
786 745
787 # read the directory entries 746 # stat the dir another time
788 aioreq_pri $pri; 747 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 { 748 add $grp aio_stat $path, sub {
796 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 749 my $hash2 = join ":", (stat _)[0,1,3,7,9];
797 750
798 my $ndirs; 751 my $ndirs;
799 752
800 # take the slow route if anything looks fishy 753 # take the slow route if anything looks fishy
801 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 754 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
802 $ndirs = -1; 755 $ndirs = -1;
803 } else { 756 } else {
804 # if nlink == 2, we are finished 757 # if nlink == 2, we are finished
805 # on non-posix-fs's, we rely on nlink < 2 758 # on non-posix-fs's, we rely on nlink < 2
806 $ndirs = (stat _)[3] - 2 759 $ndirs = (stat _)[3] - 2
807 or return $grp->result ([], $entries); 760 or return $grp->result ([], $entries);
808 } 761 }
809 762
810 # sort into likely dirs and likely nondirs 763 # sort into likely dirs and likely nondirs
811 # dirs == files without ".", short entries first 764 # dirs == files without ".", short entries first
812 $entries = [map $_->[0], 765 $entries = [map $_->[0],
813 sort { $b->[1] cmp $a->[1] } 766 sort { $b->[1] cmp $a->[1] }
814 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 767 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
815 @$entries]; 768 @$entries];
816 769
817 my (@dirs, @nondirs); 770 my (@dirs, @nondirs);
818 771
819 my $statgrp = add $grp aio_group sub { 772 my $statgrp = add $grp aio_group sub {
820 $grp->result (\@dirs, \@nondirs); 773 $grp->result (\@dirs, \@nondirs);
821 }; 774 };
822 775
823 limit $statgrp $maxreq; 776 limit $statgrp $maxreq;
824 feed $statgrp sub { 777 feed $statgrp sub {
825 return unless @$entries; 778 return unless @$entries;
826 my $entry = pop @$entries; 779 my $entry = pop @$entries;
827 780
828 aioreq_pri $pri; 781 aioreq_pri $pri;
829 add $statgrp aio_stat "$path/$entry/.", sub { 782 add $statgrp aio_stat "$path/$entry/.", sub {
830 if ($_[0] < 0) { 783 if ($_[0] < 0) {
831 push @nondirs, $entry; 784 push @nondirs, $entry;
832 } else { 785 } else {
833 # need to check for real directory 786 # need to check for real directory
834 aioreq_pri $pri; 787 aioreq_pri $pri;
835 add $statgrp aio_lstat "$path/$entry", sub { 788 add $statgrp aio_lstat "$path/$entry", sub {
836 if (-d _) { 789 if (-d _) {
837 push @dirs, $entry; 790 push @dirs, $entry;
838 791
839 unless (--$ndirs) { 792 unless (--$ndirs) {
840 push @nondirs, @$entries; 793 push @nondirs, @$entries;
841 feed $statgrp; 794 feed $statgrp;
842 }
843 } else {
844 push @nondirs, $entry;
845 } 795 }
796 } else {
797 push @nondirs, $entry;
846 } 798 }
847 } 799 }
848 }; 800 }
849 }; 801 };
850 }; 802 };
851 }; 803 };
852 }; 804 };
853
854 $grp
855 } 805 };
806
807 $grp
856} 808}
857 809
858=item aio_rmtree $path, $callback->($status) 810=item aio_rmtree $path, $callback->($status)
859 811
860Delete a directory tree starting (and including) C<$path>, return the 812Delete a directory tree starting (and including) C<$path>, return the
… …
864 816
865=cut 817=cut
866 818
867sub aio_rmtree; 819sub aio_rmtree;
868sub aio_rmtree($;$) { 820sub aio_rmtree($;$) {
869 aio_block {
870 my ($path, $cb) = @_; 821 my ($path, $cb) = @_;
871 822
872 my $pri = aioreq_pri; 823 my $pri = aioreq_pri;
873 my $grp = aio_group $cb; 824 my $grp = aio_group $cb;
874 825
875 aioreq_pri $pri; 826 aioreq_pri $pri;
876 add $grp aio_scandir $path, 0, sub { 827 add $grp aio_scandir $path, 0, sub {
877 my ($dirs, $nondirs) = @_; 828 my ($dirs, $nondirs) = @_;
878 829
879 my $dirgrp = aio_group sub { 830 my $dirgrp = aio_group sub {
880 add $grp aio_rmdir $path, sub { 831 add $grp aio_rmdir $path, sub {
881 $grp->result ($_[0]); 832 $grp->result ($_[0]);
882 };
883 }; 833 };
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 }; 834 };
890 835
891 $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;
892 } 840 };
841
842 $grp
893} 843}
844
845=item aio_sync $callback->($status)
846
847Asynchronously call sync and call the callback when finished.
894 848
895=item aio_fsync $fh, $callback->($status) 849=item aio_fsync $fh, $callback->($status)
896 850
897Asynchronously call fsync on the given filehandle and call the callback 851Asynchronously call fsync on the given filehandle and call the callback
898with the fsync result code. 852with the fsync result code.
… …
902Asynchronously call fdatasync on the given filehandle and call the 856Asynchronously call fdatasync on the given filehandle and call the
903callback with the fdatasync result code. 857callback with the fdatasync result code.
904 858
905If 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
906detected, it will be emulated by calling C<fsync> instead. 860detected, it will be emulated by calling C<fsync> instead.
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
874=item aio_pathsync $path, $callback->($status)
875
876This request tries to open, fsync and close the given path. This is a
877composite request intended to sync directories after directory operations
878(E.g. rename). This might not work on all operating systems or have any
879specific effect, but usually it makes sure that directory changes get
880written to disc. It works for anything that can be opened for read-only,
881not just directories.
882
883Passes C<0> when everything went ok, and C<-1> on error.
884
885=cut
886
887sub aio_pathsync($;$) {
888 my ($path, $cb) = @_;
889
890 my $pri = aioreq_pri;
891 my $grp = aio_group $cb;
892
893 aioreq_pri $pri;
894 add $grp aio_open $path, O_RDONLY, 0, sub {
895 my ($fh) = @_;
896 if ($fh) {
897 aioreq_pri $pri;
898 add $grp aio_fsync $fh, sub {
899 $grp->result ($_[0]);
900
901 aioreq_pri $pri;
902 add $grp aio_close $fh;
903 };
904 } else {
905 $grp->result (-1);
906 }
907 };
908
909 $grp
910}
907 911
908=item aio_group $callback->(...) 912=item aio_group $callback->(...)
909 913
910This 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
911container for other aio requests, which is useful if you want to bundle 915container for other aio requests, which is useful if you want to bundle
… …
1023Their lifetime, simplified, looks like this: when they are empty, they 1027Their lifetime, simplified, looks like this: when they are empty, they
1024will 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
1025C<done> state, they will also finish. Otherwise they will continue to 1029C<done> state, they will also finish. Otherwise they will continue to
1026exist. 1030exist.
1027 1031
1028That 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
1029in 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
1030group. 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
1031itself finish. 1035further requests to the group. And only when all those requests have
1036finished will the the group itself finish.
1032 1037
1033=over 4 1038=over 4
1034 1039
1035=item add $grp ... 1040=item add $grp ...
1036 1041
… …
1048itself. Useful when you queued a lot of events but got a result early. 1053itself. Useful when you queued a lot of events but got a result early.
1049 1054
1050=item $grp->result (...) 1055=item $grp->result (...)
1051 1056
1052Set the result value(s) that will be passed to the group callback when all 1057Set 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 1058subrequests have finished and set the groups errno to the current value
1054of errno (just like calling C<errno> without an error number). By default, 1059of errno (just like calling C<errno> without an error number). By default,
1055no argument will be passed and errno is zero. 1060no argument will be passed and errno is zero.
1056 1061
1057=item $grp->errno ([$errno]) 1062=item $grp->errno ([$errno])
1058 1063
… …
1069=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1070 1075
1071Sets 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
1072generator that generates requests if idle. The idea behind this is that, 1077generator that generates requests if idle. The idea behind this is that,
1073although 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,
1074this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1075example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1076requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1077 1082
1078To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1079instead 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
1080feed 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>,
1081below) 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
… …
1085not impose any limits). 1090not impose any limits).
1086 1091
1087If 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
1088automatically removed from the group. 1093automatically removed from the group.
1089 1094
1090If 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.
1091 1097
1092Example: 1098Example:
1093 1099
1094 # 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:
1095 1101
… …
1107Sets 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
1108the group contains less than this many requests. 1114the group contains less than this many requests.
1109 1115
1110Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1111 1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1120
1112=back 1121=back
1113 1122
1114=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1115 1124
1116=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1125=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1127See C<poll_cb> for an example. 1136See C<poll_cb> for an example.
1128 1137
1129=item IO::AIO::poll_cb 1138=item IO::AIO::poll_cb
1130 1139
1131Process 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
1132regularly. 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
1133when no events are outstanding. The amount of events processed depends on 1143are outstanding. The amount of events processed depends on the settings of
1134the 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>.
1135 1145
1136If not all requests were processed for whatever reason, the filehandle 1146If not all requests were processed for whatever reason, the filehandle
1137will 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.
1138 1149
1139Example: Install an Event watcher that automatically calls 1150Example: Install an Event watcher that automatically calls
1140IO::AIO::poll_cb with high priority: 1151IO::AIO::poll_cb with high priority:
1141 1152
1142 Event->io (fd => IO::AIO::poll_fileno, 1153 Event->io (fd => IO::AIO::poll_fileno,
… …
1256 1267
1257The default is probably ok in most situations, especially if thread 1268The default is probably ok in most situations, especially if thread
1258creation 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
1259want to use larger values. 1270want to use larger values.
1260 1271
1261=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1272=item IO::AIO::max_outstanding $maxreqs
1262 1273
1263This 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
1264blocks, 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
1265use an C<aio_group> together with a feed callback. 1276use an C<aio_group> together with a feed callback.
1266 1277
… …
1271 1282
1272The 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
1273number of outstanding requests. 1284number of outstanding requests.
1274 1285
1275You can still queue as many requests as you want. Therefore, 1286You can still queue as many requests as you want. Therefore,
1276C<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
1277as 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).
1278 1289
1279=back 1290=back
1280 1291
1281=head3 STATISTICAL INFORMATION 1292=head3 STATISTICAL INFORMATION
… …
1351 1362
1352Known bugs will be fixed in the next release. 1363Known bugs will be fixed in the next release.
1353 1364
1354=head1 SEE ALSO 1365=head1 SEE ALSO
1355 1366
1356L<Coro::AIO>. 1367L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1368more natural syntax.
1357 1369
1358=head1 AUTHOR 1370=head1 AUTHOR
1359 1371
1360 Marc Lehmann <schmorp@schmorp.de> 1372 Marc Lehmann <schmorp@schmorp.de>
1361 http://home.schmorp.de/ 1373 http://home.schmorp.de/

Diff Legend

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