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.116 by root, Wed Oct 3 21:27:51 2007 UTC vs.
Revision 1.147 by root, Wed Jun 3 12:24:49 2009 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);
183 185
184=cut 186=cut
185 187
186package IO::AIO; 188package IO::AIO;
187 189
190use Carp ();
191
188no warnings; 192no warnings;
189use strict 'vars'; 193use strict 'vars';
190 194
191use base 'Exporter'; 195use base 'Exporter';
192 196
193BEGIN { 197BEGIN {
194 our $VERSION = '2.5'; 198 our $VERSION = '3.19';
195 199
196 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
197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
198 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
199 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
200 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 211 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
206 215
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208 217
209 require XSLoader; 218 require XSLoader;
210 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
217All 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
218with 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,
219and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
220which 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
221the 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
222perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 232syscall has been executed asynchronously.
224 233
225All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 235internally until the request has finished.
227 236
241your 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
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
244 253
245This 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
246handles correctly wether it is set or not. 255handles correctly whether it is set or not.
247 256
248=over 4 257=over 4
249 258
250=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
251 260
313=item aio_close $fh, $callback->($status) 322=item aio_close $fh, $callback->($status)
314 323
315Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
316code. 325code.
317 326
318Unlike the other functions operating on files, this function uses the 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
319PerlIO layer to close the filehandle. The reason is that the PerlIO API 328closing the file descriptor associated with the filehandle itself.
320insists on closing the underlying fd itself, no matter what, and doesn't
321allow modifications to the fd. Unfortunately, it is not clear that you can
322call PerlIO from different threads (actually, its quite clear that this
323won't work in some cases), so while it likely works perfectly with simple
324file handles (such as the ones created by C<aio_open>) it might fail in
325interesting ways for others.
326 329
327Having said that, aio_close tries to clean up the filehandle as much as 330Therefore, C<aio_close> will not close the filehandle - instead it will
328possible before handing it to an io thread, and generally does work. 331use dup2 to overwrite the file descriptor with the write-end of a pipe
332(the pipe fd will be created on demand and will be cached).
329 333
334Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed.
336
337=cut
330 338
331=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
332 340
333=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
334 342
335Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
336into the scalar given by C<$data> and offset C<$dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
337callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
338like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
339 350
340If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
341be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
342changed by these calls. 353changed by these calls.
343 354
344If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 355If C<$length> is undefined in C<aio_write>, use the remaining length of
356C<$data>.
345 357
346If C<$dataoffset> is less than zero, it will be counted from the end of 358If C<$dataoffset> is less than zero, it will be counted from the end of
347C<$data>. 359C<$data>.
348 360
349The C<$data> scalar I<MUST NOT> be modified in any way while the request 361The C<$data> scalar I<MUST NOT> be modified in any way while the request
533memory. Status is the same as with aio_read. 545memory. Status is the same as with aio_read.
534 546
535=cut 547=cut
536 548
537sub aio_load($$;$) { 549sub aio_load($$;$) {
538 aio_block {
539 my ($path, undef, $cb) = @_; 550 my ($path, undef, $cb) = @_;
540 my $data = \$_[1]; 551 my $data = \$_[1];
541 552
542 my $pri = aioreq_pri; 553 my $pri = aioreq_pri;
543 my $grp = aio_group $cb; 554 my $grp = aio_group $cb;
555
556 aioreq_pri $pri;
557 add $grp aio_open $path, O_RDONLY, 0, sub {
558 my $fh = shift
559 or return $grp->result (-1);
544 560
545 aioreq_pri $pri; 561 aioreq_pri $pri;
546 add $grp aio_open $path, O_RDONLY, 0, sub {
547 my $fh = shift
548 or return $grp->result (-1);
549
550 aioreq_pri $pri;
551 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
552 $grp->result ($_[0]); 563 $grp->result ($_[0]);
553 };
554 }; 564 };
555
556 $grp
557 } 565 };
566
567 $grp
558} 568}
559 569
560=item aio_copy $srcpath, $dstpath, $callback->($status) 570=item aio_copy $srcpath, $dstpath, $callback->($status)
561 571
562Try to copy the I<file> (directories not supported as either source or 572Try to copy the I<file> (directories not supported as either source or
563destination) from C<$srcpath> to C<$dstpath> and call the callback with 573destination) from C<$srcpath> to C<$dstpath> and call the callback with
564the C<0> (error) or C<-1> ok. 574the C<0> (error) or C<-1> ok.
565 575
566This is a composite request that it creates the destination file with 576This is a composite request that creates the destination file with
567mode 0200 and copies the contents of the source file into it using 577mode 0200 and copies the contents of the source file into it using
568C<aio_sendfile>, followed by restoring atime, mtime, access mode and 578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
569uid/gid, in that order. 579uid/gid, in that order.
570 580
571If an error occurs, the partial destination file will be unlinked, if 581If an error occurs, the partial destination file will be unlinked, if
573errors are being ignored. 583errors are being ignored.
574 584
575=cut 585=cut
576 586
577sub aio_copy($$;$) { 587sub aio_copy($$;$) {
578 aio_block {
579 my ($src, $dst, $cb) = @_; 588 my ($src, $dst, $cb) = @_;
580 589
581 my $pri = aioreq_pri; 590 my $pri = aioreq_pri;
582 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
583 592
584 aioreq_pri $pri; 593 aioreq_pri $pri;
585 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
586 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
587 my @stat = stat $src_fh; 596 my @stat = stat $src_fh; # hmm, might bock over nfs?
588 597
589 aioreq_pri $pri; 598 aioreq_pri $pri;
590 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 599 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
591 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
592 aioreq_pri $pri; 601 aioreq_pri $pri;
593 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 602 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
594 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
595 $grp->result (0); 604 $grp->result (0);
596 close $src_fh; 605 close $src_fh;
597 606
598 # those should not normally block. should. should.
599 utime $stat[8], $stat[9], $dst;
600 chmod $stat[2] & 07777, $dst_fh;
601 chown $stat[4], $stat[5], $dst_fh;
602 close $dst_fh;
603 } else { 607 my $ch = sub {
604 $grp->result (-1);
605 close $src_fh;
606 close $dst_fh;
607
608 aioreq $pri; 608 aioreq_pri $pri;
609 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
610 aioreq_pri $pri;
611 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
612 aioreq_pri $pri;
609 add $grp aio_unlink $dst; 613 add $grp aio_close $dst_fh;
614 }
615 };
610 } 616 };
617
618 aioreq_pri $pri;
619 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
620 if ($_[0] < 0 && $! == ENOSYS) {
621 aioreq_pri $pri;
622 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
623 } else {
624 $ch->();
625 }
626 };
627 } else {
628 $grp->result (-1);
629 close $src_fh;
630 close $dst_fh;
631
632 aioreq $pri;
633 add $grp aio_unlink $dst;
611 }; 634 }
612 } else {
613 $grp->result (-1);
614 } 635 };
636 } else {
637 $grp->result (-1);
615 }, 638 }
616
617 } else {
618 $grp->result (-1);
619 } 639 },
640
641 } else {
642 $grp->result (-1);
620 }; 643 }
621
622 $grp
623 } 644 };
645
646 $grp
624} 647}
625 648
626=item aio_move $srcpath, $dstpath, $callback->($status) 649=item aio_move $srcpath, $dstpath, $callback->($status)
627 650
628Try to move the I<file> (directories not supported as either source or 651Try to move the I<file> (directories not supported as either source or
629destination) from C<$srcpath> to C<$dstpath> and call the callback with 652destination) from C<$srcpath> to C<$dstpath> and call the callback with
630the C<0> (error) or C<-1> ok. 653the C<0> (error) or C<-1> ok.
631 654
632This is a composite request that tries to rename(2) the file first. If 655This is a composite request that tries to rename(2) the file first; if
633rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 656rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
634that is successful, unlinking the C<$srcpath>. 657that is successful, unlinks the C<$srcpath>.
635 658
636=cut 659=cut
637 660
638sub aio_move($$;$) { 661sub aio_move($$;$) {
639 aio_block {
640 my ($src, $dst, $cb) = @_; 662 my ($src, $dst, $cb) = @_;
641 663
642 my $pri = aioreq_pri; 664 my $pri = aioreq_pri;
643 my $grp = aio_group $cb; 665 my $grp = aio_group $cb;
644 666
645 aioreq_pri $pri; 667 aioreq_pri $pri;
646 add $grp aio_rename $src, $dst, sub { 668 add $grp aio_rename $src, $dst, sub {
647 if ($_[0] && $! == EXDEV) { 669 if ($_[0] && $! == EXDEV) {
648 aioreq_pri $pri; 670 aioreq_pri $pri;
649 add $grp aio_copy $src, $dst, sub { 671 add $grp aio_copy $src, $dst, sub {
650 $grp->result ($_[0]);
651
652 if (!$_[0]) {
653 aioreq_pri $pri;
654 add $grp aio_unlink $src;
655 }
656 };
657 } else {
658 $grp->result ($_[0]); 672 $grp->result ($_[0]);
673
674 if (!$_[0]) {
675 aioreq_pri $pri;
676 add $grp aio_unlink $src;
677 }
659 } 678 };
679 } else {
680 $grp->result ($_[0]);
660 }; 681 }
661
662 $grp
663 } 682 };
683
684 $grp
664} 685}
665 686
666=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 687=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
667 688
668Scans a directory (similar to C<aio_readdir>) but additionally tries to 689Scans a directory (similar to C<aio_readdir>) but additionally tries to
716directory counting heuristic. 737directory counting heuristic.
717 738
718=cut 739=cut
719 740
720sub aio_scandir($$;$) { 741sub aio_scandir($$;$) {
721 aio_block {
722 my ($path, $maxreq, $cb) = @_; 742 my ($path, $maxreq, $cb) = @_;
723 743
724 my $pri = aioreq_pri; 744 my $pri = aioreq_pri;
725 745
726 my $grp = aio_group $cb; 746 my $grp = aio_group $cb;
727 747
728 $maxreq = 4 if $maxreq <= 0; 748 $maxreq = 4 if $maxreq <= 0;
729 749
730 # stat once 750 # stat once
751 aioreq_pri $pri;
752 add $grp aio_stat $path, sub {
753 return $grp->result () if $_[0];
754 my $now = time;
755 my $hash1 = join ":", (stat _)[0,1,3,7,9];
756
757 # read the directory entries
731 aioreq_pri $pri; 758 aioreq_pri $pri;
732 add $grp aio_stat $path, sub { 759 add $grp aio_readdir $path, sub {
760 my $entries = shift
733 return $grp->result () if $_[0]; 761 or return $grp->result ();
734 my $now = time;
735 my $hash1 = join ":", (stat _)[0,1,3,7,9];
736 762
737 # read the directory entries 763 # stat the dir another time
738 aioreq_pri $pri; 764 aioreq_pri $pri;
739 add $grp aio_readdir $path, sub {
740 my $entries = shift
741 or return $grp->result ();
742
743 # stat the dir another time
744 aioreq_pri $pri;
745 add $grp aio_stat $path, sub { 765 add $grp aio_stat $path, sub {
746 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 766 my $hash2 = join ":", (stat _)[0,1,3,7,9];
747 767
748 my $ndirs; 768 my $ndirs;
749 769
750 # take the slow route if anything looks fishy 770 # take the slow route if anything looks fishy
751 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 771 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
752 $ndirs = -1; 772 $ndirs = -1;
753 } else { 773 } else {
754 # if nlink == 2, we are finished 774 # if nlink == 2, we are finished
755 # on non-posix-fs's, we rely on nlink < 2 775 # on non-posix-fs's, we rely on nlink < 2
756 $ndirs = (stat _)[3] - 2 776 $ndirs = (stat _)[3] - 2
757 or return $grp->result ([], $entries); 777 or return $grp->result ([], $entries);
758 } 778 }
759 779
760 # sort into likely dirs and likely nondirs 780 # sort into likely dirs and likely nondirs
761 # dirs == files without ".", short entries first 781 # dirs == files without ".", short entries first
762 $entries = [map $_->[0], 782 $entries = [map $_->[0],
763 sort { $b->[1] cmp $a->[1] } 783 sort { $b->[1] cmp $a->[1] }
764 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 784 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
765 @$entries]; 785 @$entries];
766 786
767 my (@dirs, @nondirs); 787 my (@dirs, @nondirs);
768 788
769 my $statgrp = add $grp aio_group sub { 789 my $statgrp = add $grp aio_group sub {
770 $grp->result (\@dirs, \@nondirs); 790 $grp->result (\@dirs, \@nondirs);
771 }; 791 };
772 792
773 limit $statgrp $maxreq; 793 limit $statgrp $maxreq;
774 feed $statgrp sub { 794 feed $statgrp sub {
775 return unless @$entries; 795 return unless @$entries;
776 my $entry = pop @$entries; 796 my $entry = pop @$entries;
777 797
778 aioreq_pri $pri; 798 aioreq_pri $pri;
779 add $statgrp aio_stat "$path/$entry/.", sub { 799 add $statgrp aio_stat "$path/$entry/.", sub {
780 if ($_[0] < 0) { 800 if ($_[0] < 0) {
781 push @nondirs, $entry; 801 push @nondirs, $entry;
782 } else { 802 } else {
783 # need to check for real directory 803 # need to check for real directory
784 aioreq_pri $pri; 804 aioreq_pri $pri;
785 add $statgrp aio_lstat "$path/$entry", sub { 805 add $statgrp aio_lstat "$path/$entry", sub {
786 if (-d _) { 806 if (-d _) {
787 push @dirs, $entry; 807 push @dirs, $entry;
788 808
789 unless (--$ndirs) { 809 unless (--$ndirs) {
790 push @nondirs, @$entries; 810 push @nondirs, @$entries;
791 feed $statgrp; 811 feed $statgrp;
792 }
793 } else {
794 push @nondirs, $entry;
795 } 812 }
813 } else {
814 push @nondirs, $entry;
796 } 815 }
797 } 816 }
798 }; 817 }
799 }; 818 };
800 }; 819 };
801 }; 820 };
802 }; 821 };
803
804 $grp
805 } 822 };
823
824 $grp
806} 825}
807 826
808=item aio_rmtree $path, $callback->($status) 827=item aio_rmtree $path, $callback->($status)
809 828
810Delete a directory tree starting (and including) C<$path>, return the 829Delete a directory tree starting (and including) C<$path>, return the
814 833
815=cut 834=cut
816 835
817sub aio_rmtree; 836sub aio_rmtree;
818sub aio_rmtree($;$) { 837sub aio_rmtree($;$) {
819 aio_block {
820 my ($path, $cb) = @_; 838 my ($path, $cb) = @_;
821 839
822 my $pri = aioreq_pri; 840 my $pri = aioreq_pri;
823 my $grp = aio_group $cb; 841 my $grp = aio_group $cb;
824 842
825 aioreq_pri $pri; 843 aioreq_pri $pri;
826 add $grp aio_scandir $path, 0, sub { 844 add $grp aio_scandir $path, 0, sub {
827 my ($dirs, $nondirs) = @_; 845 my ($dirs, $nondirs) = @_;
828 846
829 my $dirgrp = aio_group sub { 847 my $dirgrp = aio_group sub {
830 add $grp aio_rmdir $path, sub { 848 add $grp aio_rmdir $path, sub {
831 $grp->result ($_[0]); 849 $grp->result ($_[0]);
832 };
833 }; 850 };
834
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;
839 }; 851 };
840 852
841 $grp 853 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
854 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
855
856 add $grp $dirgrp;
842 } 857 };
858
859 $grp
843} 860}
861
862=item aio_sync $callback->($status)
863
864Asynchronously call sync and call the callback when finished.
844 865
845=item aio_fsync $fh, $callback->($status) 866=item aio_fsync $fh, $callback->($status)
846 867
847Asynchronously call fsync on the given filehandle and call the callback 868Asynchronously call fsync on the given filehandle and call the callback
848with the fsync result code. 869with the fsync result code.
852Asynchronously call fdatasync on the given filehandle and call the 873Asynchronously call fdatasync on the given filehandle and call the
853callback with the fdatasync result code. 874callback with the fdatasync result code.
854 875
855If this call isn't available because your OS lacks it or it couldn't be 876If this call isn't available because your OS lacks it or it couldn't be
856detected, it will be emulated by calling C<fsync> instead. 877detected, it will be emulated by calling C<fsync> instead.
878
879=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
880
881Sync the data portion of the file specified by C<$offset> and C<$length>
882to disk (but NOT the metadata), by calling the Linux-specific
883sync_file_range call. If sync_file_range is not available or it returns
884ENOSYS, then fdatasync or fsync is being substituted.
885
886C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
887C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
888C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
889manpage for details.
890
891=item aio_pathsync $path, $callback->($status)
892
893This request tries to open, fsync and close the given path. This is a
894composite request intended to sync directories after directory operations
895(E.g. rename). This might not work on all operating systems or have any
896specific effect, but usually it makes sure that directory changes get
897written to disc. It works for anything that can be opened for read-only,
898not just directories.
899
900Passes C<0> when everything went ok, and C<-1> on error.
901
902=cut
903
904sub aio_pathsync($;$) {
905 my ($path, $cb) = @_;
906
907 my $pri = aioreq_pri;
908 my $grp = aio_group $cb;
909
910 aioreq_pri $pri;
911 add $grp aio_open $path, O_RDONLY, 0, sub {
912 my ($fh) = @_;
913 if ($fh) {
914 aioreq_pri $pri;
915 add $grp aio_fsync $fh, sub {
916 $grp->result ($_[0]);
917
918 aioreq_pri $pri;
919 add $grp aio_close $fh;
920 };
921 } else {
922 $grp->result (-1);
923 }
924 };
925
926 $grp
927}
857 928
858=item aio_group $callback->(...) 929=item aio_group $callback->(...)
859 930
860This is a very special aio request: Instead of doing something, it is a 931This is a very special aio request: Instead of doing something, it is a
861container for other aio requests, which is useful if you want to bundle 932container for other aio requests, which is useful if you want to bundle
973Their lifetime, simplified, looks like this: when they are empty, they 1044Their lifetime, simplified, looks like this: when they are empty, they
974will finish very quickly. If they contain only requests that are in the 1045will finish very quickly. If they contain only requests that are in the
975C<done> state, they will also finish. Otherwise they will continue to 1046C<done> state, they will also finish. Otherwise they will continue to
976exist. 1047exist.
977 1048
978That means after creating a group you have some time to add requests. And 1049That means after creating a group you have some time to add requests
979in the callbacks of those requests, you can add further requests to the 1050(precisely before the callback has been invoked, which is only done within
980group. And only when all those requests have finished will the the group 1051the C<poll_cb>). And in the callbacks of those requests, you can add
981itself finish. 1052further requests to the group. And only when all those requests have
1053finished will the the group itself finish.
982 1054
983=over 4 1055=over 4
984 1056
985=item add $grp ... 1057=item add $grp ...
986 1058
998itself. Useful when you queued a lot of events but got a result early. 1070itself. Useful when you queued a lot of events but got a result early.
999 1071
1000=item $grp->result (...) 1072=item $grp->result (...)
1001 1073
1002Set the result value(s) that will be passed to the group callback when all 1074Set the result value(s) that will be passed to the group callback when all
1003subrequests have finished and set thre groups errno to the current value 1075subrequests have finished and set the groups errno to the current value
1004of errno (just like calling C<errno> without an error number). By default, 1076of errno (just like calling C<errno> without an error number). By default,
1005no argument will be passed and errno is zero. 1077no argument will be passed and errno is zero.
1006 1078
1007=item $grp->errno ([$errno]) 1079=item $grp->errno ([$errno])
1008 1080
1019=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
1020 1092
1021Sets a feeder/generator on this group: every group can have an attached 1093Sets a feeder/generator on this group: every group can have an attached
1022generator that generates requests if idle. The idea behind this is that, 1094generator that generates requests if idle. The idea behind this is that,
1023although you could just queue as many requests as you want in a group, 1095although you could just queue as many requests as you want in a group,
1024this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
1025example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1026requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
1027 1099
1028To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
1029instead a group and set a feeder on it that generates those requests. The 1101instead a group and set a feeder on it that generates those requests. The
1030feed callback will be called whenever there are few enough (see C<limit>, 1102feed callback will be called whenever there are few enough (see C<limit>,
1031below) requests active in the group itself and is expected to queue more 1103below) requests active in the group itself and is expected to queue more
1035not impose any limits). 1107not impose any limits).
1036 1108
1037If the feed does not queue more requests when called, it will be 1109If the feed does not queue more requests when called, it will be
1038automatically removed from the group. 1110automatically removed from the group.
1039 1111
1040If the feed limit is C<0>, it will be set to C<2> automatically. 1112If the feed limit is C<0> when this method is called, it will be set to
1113C<2> automatically.
1041 1114
1042Example: 1115Example:
1043 1116
1044 # stat all files in @files, but only ever use four aio requests concurrently: 1117 # stat all files in @files, but only ever use four aio requests concurrently:
1045 1118
1057Sets the feeder limit for the group: The feeder will be called whenever 1130Sets the feeder limit for the group: The feeder will be called whenever
1058the group contains less than this many requests. 1131the group contains less than this many requests.
1059 1132
1060Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
1061 1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1137
1062=back 1138=back
1063 1139
1064=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
1065 1141
1066=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1142=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1077See C<poll_cb> for an example. 1153See C<poll_cb> for an example.
1078 1154
1079=item IO::AIO::poll_cb 1155=item IO::AIO::poll_cb
1080 1156
1081Process some outstanding events on the result pipe. You have to call this 1157Process some outstanding events on the result pipe. You have to call this
1082regularly. Returns the number of events processed. Returns immediately 1158regularly. Returns C<0> if all events could be processed, or C<-1> if it
1159returned earlier for whatever reason. Returns immediately when no events
1083when no events are outstanding. The amount of events processed depends on 1160are outstanding. The amount of events processed depends on the settings of
1084the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1161C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1085 1162
1086If not all requests were processed for whatever reason, the filehandle 1163If not all requests were processed for whatever reason, the filehandle
1087will still be ready when C<poll_cb> returns. 1164will still be ready when C<poll_cb> returns, so normally you don't have to
1165do anything special to have it called later.
1088 1166
1089Example: Install an Event watcher that automatically calls 1167Example: Install an Event watcher that automatically calls
1090IO::AIO::poll_cb with high priority: 1168IO::AIO::poll_cb with high priority:
1091 1169
1092 Event->io (fd => IO::AIO::poll_fileno, 1170 Event->io (fd => IO::AIO::poll_fileno,
1206 1284
1207The default is probably ok in most situations, especially if thread 1285The default is probably ok in most situations, especially if thread
1208creation is fast. If thread creation is very slow on your system you might 1286creation is fast. If thread creation is very slow on your system you might
1209want to use larger values. 1287want to use larger values.
1210 1288
1211=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1289=item IO::AIO::max_outstanding $maxreqs
1212 1290
1213This is a very bad function to use in interactive programs because it 1291This is a very bad function to use in interactive programs because it
1214blocks, and a bad way to reduce concurrency because it is inexact: Better 1292blocks, and a bad way to reduce concurrency because it is inexact: Better
1215use an C<aio_group> together with a feed callback. 1293use an C<aio_group> together with a feed callback.
1216 1294
1221 1299
1222The default value is very large, so there is no practical limit on the 1300The default value is very large, so there is no practical limit on the
1223number of outstanding requests. 1301number of outstanding requests.
1224 1302
1225You can still queue as many requests as you want. Therefore, 1303You can still queue as many requests as you want. Therefore,
1226C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1304C<max_outstanding> is mainly useful in simple scripts (with low values) or
1227as a stop gap to shield against fatal memory overflow (with large values). 1305as a stop gap to shield against fatal memory overflow (with large values).
1228 1306
1229=back 1307=back
1230 1308
1231=head3 STATISTICAL INFORMATION 1309=head3 STATISTICAL INFORMATION
1301 1379
1302Known bugs will be fixed in the next release. 1380Known bugs will be fixed in the next release.
1303 1381
1304=head1 SEE ALSO 1382=head1 SEE ALSO
1305 1383
1306L<Coro::AIO>. 1384L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1385more natural syntax.
1307 1386
1308=head1 AUTHOR 1387=head1 AUTHOR
1309 1388
1310 Marc Lehmann <schmorp@schmorp.de> 1389 Marc Lehmann <schmorp@schmorp.de>
1311 http://home.schmorp.de/ 1390 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines