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.111 by root, Mon Aug 13 12:08:13 2007 UTC vs.
Revision 1.145 by root, Sun Apr 19 19:20:10 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.4'; 198 our $VERSION = '3.18';
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
… …
311 320
312 321
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. I<WARNING:> although accepted, you should not pass in a perl 325code.
317filehandle here, as perl will likely close the file descriptor another
318time when the filehandle is destroyed. Normally, you can safely call perls
319C<close> or just let filehandles go out of scope.
320 326
321This is supposed to be a bug in the API, so that might change. It's 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 328closing the file descriptor associated with the filehandle itself.
323 329
330Therefore, C<aio_close> will not close the filehandle - instead it will
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).
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
324 338
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 340
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 342
329Reads 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
330into 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>
331callback 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
332like the syscall). 346error, just like the syscall).
333 347
334If C<$offset> is undefined, then the current file offset will be used (and 348If C<$offset> is undefined, then the current file descriptor offset will
335updated), otherwise the file offset will not be changed by these calls. 349be used (and updated), otherwise the file descriptor offset will not be
350changed by these calls.
336 351
337If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 352If C<$length> is undefined in C<aio_write>, use the remaining length of
353C<$data>.
338 354
339If C<$dataoffset> is less than zero, it will be counted from the end of 355If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>. 356C<$data>.
341 357
342The C<$data> scalar I<MUST NOT> be modified in any way while the request 358The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
526memory. Status is the same as with aio_read. 542memory. Status is the same as with aio_read.
527 543
528=cut 544=cut
529 545
530sub aio_load($$;$) { 546sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_; 547 my ($path, undef, $cb) = @_;
533 my $data = \$_[1]; 548 my $data = \$_[1];
534 549
535 my $pri = aioreq_pri; 550 my $pri = aioreq_pri;
536 my $grp = aio_group $cb; 551 my $grp = aio_group $cb;
552
553 aioreq_pri $pri;
554 add $grp aio_open $path, O_RDONLY, 0, sub {
555 my $fh = shift
556 or return $grp->result (-1);
537 557
538 aioreq_pri $pri; 558 aioreq_pri $pri;
539 add $grp aio_open $path, O_RDONLY, 0, sub {
540 my $fh = shift
541 or return $grp->result (-1);
542
543 aioreq_pri $pri;
544 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 559 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]); 560 $grp->result ($_[0]);
546 };
547 }; 561 };
548
549 $grp
550 } 562 };
563
564 $grp
551} 565}
552 566
553=item aio_copy $srcpath, $dstpath, $callback->($status) 567=item aio_copy $srcpath, $dstpath, $callback->($status)
554 568
555Try to copy the I<file> (directories not supported as either source or 569Try to copy the I<file> (directories not supported as either source or
556destination) from C<$srcpath> to C<$dstpath> and call the callback with 570destination) from C<$srcpath> to C<$dstpath> and call the callback with
557the C<0> (error) or C<-1> ok. 571the C<0> (error) or C<-1> ok.
558 572
559This is a composite request that it creates the destination file with 573This is a composite request that creates the destination file with
560mode 0200 and copies the contents of the source file into it using 574mode 0200 and copies the contents of the source file into it using
561C<aio_sendfile>, followed by restoring atime, mtime, access mode and 575C<aio_sendfile>, followed by restoring atime, mtime, access mode and
562uid/gid, in that order. 576uid/gid, in that order.
563 577
564If an error occurs, the partial destination file will be unlinked, if 578If an error occurs, the partial destination file will be unlinked, if
… …
566errors are being ignored. 580errors are being ignored.
567 581
568=cut 582=cut
569 583
570sub aio_copy($$;$) { 584sub aio_copy($$;$) {
571 aio_block {
572 my ($src, $dst, $cb) = @_; 585 my ($src, $dst, $cb) = @_;
573 586
574 my $pri = aioreq_pri; 587 my $pri = aioreq_pri;
575 my $grp = aio_group $cb; 588 my $grp = aio_group $cb;
576 589
577 aioreq_pri $pri; 590 aioreq_pri $pri;
578 add $grp aio_open $src, O_RDONLY, 0, sub { 591 add $grp aio_open $src, O_RDONLY, 0, sub {
579 if (my $src_fh = $_[0]) { 592 if (my $src_fh = $_[0]) {
580 my @stat = stat $src_fh; 593 my @stat = stat $src_fh;
581 594
582 aioreq_pri $pri; 595 aioreq_pri $pri;
583 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 596 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
584 if (my $dst_fh = $_[0]) { 597 if (my $dst_fh = $_[0]) {
585 aioreq_pri $pri; 598 aioreq_pri $pri;
586 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 599 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
587 if ($_[0] == $stat[7]) { 600 if ($_[0] == $stat[7]) {
588 $grp->result (0); 601 $grp->result (0);
589 close $src_fh; 602 close $src_fh;
590 603
591 # those should not normally block. should. should. 604 # those should not normally block. should. should.
592 utime $stat[8], $stat[9], $dst; 605 utime $stat[8], $stat[9], $dst;
593 chmod $stat[2] & 07777, $dst_fh; 606 chmod $stat[2] & 07777, $dst_fh;
594 chown $stat[4], $stat[5], $dst_fh; 607 chown $stat[4], $stat[5], $dst_fh;
608
609 aioreq_pri $pri;
595 close $dst_fh; 610 add $grp aio_close $dst_fh;
596 } else { 611 } else {
597 $grp->result (-1); 612 $grp->result (-1);
598 close $src_fh; 613 close $src_fh;
599 close $dst_fh; 614 close $dst_fh;
600 615
601 aioreq $pri; 616 aioreq $pri;
602 add $grp aio_unlink $dst; 617 add $grp aio_unlink $dst;
603 }
604 }; 618 }
605 } else {
606 $grp->result (-1);
607 } 619 };
620 } else {
621 $grp->result (-1);
608 }, 622 }
609
610 } else {
611 $grp->result (-1);
612 } 623 },
624
625 } else {
626 $grp->result (-1);
613 }; 627 }
614
615 $grp
616 } 628 };
629
630 $grp
617} 631}
618 632
619=item aio_move $srcpath, $dstpath, $callback->($status) 633=item aio_move $srcpath, $dstpath, $callback->($status)
620 634
621Try to move the I<file> (directories not supported as either source or 635Try to move the I<file> (directories not supported as either source or
622destination) from C<$srcpath> to C<$dstpath> and call the callback with 636destination) from C<$srcpath> to C<$dstpath> and call the callback with
623the C<0> (error) or C<-1> ok. 637the C<0> (error) or C<-1> ok.
624 638
625This is a composite request that tries to rename(2) the file first. If 639This is a composite request that tries to rename(2) the file first; if
626rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 640rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
627that is successful, unlinking the C<$srcpath>. 641that is successful, unlinks the C<$srcpath>.
628 642
629=cut 643=cut
630 644
631sub aio_move($$;$) { 645sub aio_move($$;$) {
632 aio_block {
633 my ($src, $dst, $cb) = @_; 646 my ($src, $dst, $cb) = @_;
634 647
635 my $pri = aioreq_pri; 648 my $pri = aioreq_pri;
636 my $grp = aio_group $cb; 649 my $grp = aio_group $cb;
637 650
638 aioreq_pri $pri; 651 aioreq_pri $pri;
639 add $grp aio_rename $src, $dst, sub { 652 add $grp aio_rename $src, $dst, sub {
640 if ($_[0] && $! == EXDEV) { 653 if ($_[0] && $! == EXDEV) {
641 aioreq_pri $pri; 654 aioreq_pri $pri;
642 add $grp aio_copy $src, $dst, sub { 655 add $grp aio_copy $src, $dst, sub {
643 $grp->result ($_[0]);
644
645 if (!$_[0]) {
646 aioreq_pri $pri;
647 add $grp aio_unlink $src;
648 }
649 };
650 } else {
651 $grp->result ($_[0]); 656 $grp->result ($_[0]);
657
658 if (!$_[0]) {
659 aioreq_pri $pri;
660 add $grp aio_unlink $src;
661 }
652 } 662 };
663 } else {
664 $grp->result ($_[0]);
653 }; 665 }
654
655 $grp
656 } 666 };
667
668 $grp
657} 669}
658 670
659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 671=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
660 672
661Scans a directory (similar to C<aio_readdir>) but additionally tries to 673Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
709directory counting heuristic. 721directory counting heuristic.
710 722
711=cut 723=cut
712 724
713sub aio_scandir($$;$) { 725sub aio_scandir($$;$) {
714 aio_block {
715 my ($path, $maxreq, $cb) = @_; 726 my ($path, $maxreq, $cb) = @_;
716 727
717 my $pri = aioreq_pri; 728 my $pri = aioreq_pri;
718 729
719 my $grp = aio_group $cb; 730 my $grp = aio_group $cb;
720 731
721 $maxreq = 4 if $maxreq <= 0; 732 $maxreq = 4 if $maxreq <= 0;
722 733
723 # stat once 734 # stat once
735 aioreq_pri $pri;
736 add $grp aio_stat $path, sub {
737 return $grp->result () if $_[0];
738 my $now = time;
739 my $hash1 = join ":", (stat _)[0,1,3,7,9];
740
741 # read the directory entries
724 aioreq_pri $pri; 742 aioreq_pri $pri;
725 add $grp aio_stat $path, sub { 743 add $grp aio_readdir $path, sub {
744 my $entries = shift
726 return $grp->result () if $_[0]; 745 or return $grp->result ();
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
729 746
730 # read the directory entries 747 # stat the dir another time
731 aioreq_pri $pri; 748 aioreq_pri $pri;
732 add $grp aio_readdir $path, sub {
733 my $entries = shift
734 or return $grp->result ();
735
736 # stat the dir another time
737 aioreq_pri $pri;
738 add $grp aio_stat $path, sub { 749 add $grp aio_stat $path, sub {
739 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 750 my $hash2 = join ":", (stat _)[0,1,3,7,9];
740 751
741 my $ndirs; 752 my $ndirs;
742 753
743 # take the slow route if anything looks fishy 754 # take the slow route if anything looks fishy
744 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 755 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
745 $ndirs = -1; 756 $ndirs = -1;
746 } else { 757 } else {
747 # if nlink == 2, we are finished 758 # if nlink == 2, we are finished
748 # on non-posix-fs's, we rely on nlink < 2 759 # on non-posix-fs's, we rely on nlink < 2
749 $ndirs = (stat _)[3] - 2 760 $ndirs = (stat _)[3] - 2
750 or return $grp->result ([], $entries); 761 or return $grp->result ([], $entries);
751 } 762 }
752 763
753 # sort into likely dirs and likely nondirs 764 # sort into likely dirs and likely nondirs
754 # dirs == files without ".", short entries first 765 # dirs == files without ".", short entries first
755 $entries = [map $_->[0], 766 $entries = [map $_->[0],
756 sort { $b->[1] cmp $a->[1] } 767 sort { $b->[1] cmp $a->[1] }
757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 768 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
758 @$entries]; 769 @$entries];
759 770
760 my (@dirs, @nondirs); 771 my (@dirs, @nondirs);
761 772
762 my $statgrp = add $grp aio_group sub { 773 my $statgrp = add $grp aio_group sub {
763 $grp->result (\@dirs, \@nondirs); 774 $grp->result (\@dirs, \@nondirs);
764 }; 775 };
765 776
766 limit $statgrp $maxreq; 777 limit $statgrp $maxreq;
767 feed $statgrp sub { 778 feed $statgrp sub {
768 return unless @$entries; 779 return unless @$entries;
769 my $entry = pop @$entries; 780 my $entry = pop @$entries;
770 781
771 aioreq_pri $pri; 782 aioreq_pri $pri;
772 add $statgrp aio_stat "$path/$entry/.", sub { 783 add $statgrp aio_stat "$path/$entry/.", sub {
773 if ($_[0] < 0) { 784 if ($_[0] < 0) {
774 push @nondirs, $entry; 785 push @nondirs, $entry;
775 } else { 786 } else {
776 # need to check for real directory 787 # need to check for real directory
777 aioreq_pri $pri; 788 aioreq_pri $pri;
778 add $statgrp aio_lstat "$path/$entry", sub { 789 add $statgrp aio_lstat "$path/$entry", sub {
779 if (-d _) { 790 if (-d _) {
780 push @dirs, $entry; 791 push @dirs, $entry;
781 792
782 unless (--$ndirs) { 793 unless (--$ndirs) {
783 push @nondirs, @$entries; 794 push @nondirs, @$entries;
784 feed $statgrp; 795 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
788 } 796 }
797 } else {
798 push @nondirs, $entry;
789 } 799 }
790 } 800 }
791 }; 801 }
792 }; 802 };
793 }; 803 };
794 }; 804 };
795 }; 805 };
796
797 $grp
798 } 806 };
807
808 $grp
799} 809}
800 810
801=item aio_rmtree $path, $callback->($status) 811=item aio_rmtree $path, $callback->($status)
802 812
803Delete a directory tree starting (and including) C<$path>, return the 813Delete a directory tree starting (and including) C<$path>, return the
… …
807 817
808=cut 818=cut
809 819
810sub aio_rmtree; 820sub aio_rmtree;
811sub aio_rmtree($;$) { 821sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_; 822 my ($path, $cb) = @_;
814 823
815 my $pri = aioreq_pri; 824 my $pri = aioreq_pri;
816 my $grp = aio_group $cb; 825 my $grp = aio_group $cb;
817 826
818 aioreq_pri $pri; 827 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub { 828 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_; 829 my ($dirs, $nondirs) = @_;
821 830
822 my $dirgrp = aio_group sub { 831 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub { 832 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]); 833 $grp->result ($_[0]);
825 };
826 }; 834 };
827
828 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
829 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
830
831 add $grp $dirgrp;
832 }; 835 };
833 836
834 $grp 837 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
838 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
839
840 add $grp $dirgrp;
835 } 841 };
842
843 $grp
836} 844}
845
846=item aio_sync $callback->($status)
847
848Asynchronously call sync and call the callback when finished.
837 849
838=item aio_fsync $fh, $callback->($status) 850=item aio_fsync $fh, $callback->($status)
839 851
840Asynchronously call fsync on the given filehandle and call the callback 852Asynchronously call fsync on the given filehandle and call the callback
841with the fsync result code. 853with the fsync result code.
… …
845Asynchronously call fdatasync on the given filehandle and call the 857Asynchronously call fdatasync on the given filehandle and call the
846callback with the fdatasync result code. 858callback with the fdatasync result code.
847 859
848If this call isn't available because your OS lacks it or it couldn't be 860If this call isn't available because your OS lacks it or it couldn't be
849detected, it will be emulated by calling C<fsync> instead. 861detected, it will be emulated by calling C<fsync> instead.
862
863=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
864
865Sync the data portion of the file specified by C<$offset> and C<$length>
866to disk (but NOT the metadata), by calling the Linux-specific
867sync_file_range call. If sync_file_range is not available or it returns
868ENOSYS, then fdatasync or fsync is being substituted.
869
870C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
871C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
872C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
873manpage for details.
874
875=item aio_pathsync $path, $callback->($status)
876
877This request tries to open, fsync and close the given path. This is a
878composite request intended to sync directories after directory operations
879(E.g. rename). This might not work on all operating systems or have any
880specific effect, but usually it makes sure that directory changes get
881written to disc. It works for anything that can be opened for read-only,
882not just directories.
883
884Passes C<0> when everything went ok, and C<-1> on error.
885
886=cut
887
888sub aio_pathsync($;$) {
889 my ($path, $cb) = @_;
890
891 my $pri = aioreq_pri;
892 my $grp = aio_group $cb;
893
894 aioreq_pri $pri;
895 add $grp aio_open $path, O_RDONLY, 0, sub {
896 my ($fh) = @_;
897 if ($fh) {
898 aioreq_pri $pri;
899 add $grp aio_fsync $fh, sub {
900 $grp->result ($_[0]);
901
902 aioreq_pri $pri;
903 add $grp aio_close $fh;
904 };
905 } else {
906 $grp->result (-1);
907 }
908 };
909
910 $grp
911}
850 912
851=item aio_group $callback->(...) 913=item aio_group $callback->(...)
852 914
853This is a very special aio request: Instead of doing something, it is a 915This is a very special aio request: Instead of doing something, it is a
854container for other aio requests, which is useful if you want to bundle 916container for other aio requests, which is useful if you want to bundle
… …
966Their lifetime, simplified, looks like this: when they are empty, they 1028Their lifetime, simplified, looks like this: when they are empty, they
967will finish very quickly. If they contain only requests that are in the 1029will finish very quickly. If they contain only requests that are in the
968C<done> state, they will also finish. Otherwise they will continue to 1030C<done> state, they will also finish. Otherwise they will continue to
969exist. 1031exist.
970 1032
971That means after creating a group you have some time to add requests. And 1033That means after creating a group you have some time to add requests
972in the callbacks of those requests, you can add further requests to the 1034(precisely before the callback has been invoked, which is only done within
973group. And only when all those requests have finished will the the group 1035the C<poll_cb>). And in the callbacks of those requests, you can add
974itself finish. 1036further requests to the group. And only when all those requests have
1037finished will the the group itself finish.
975 1038
976=over 4 1039=over 4
977 1040
978=item add $grp ... 1041=item add $grp ...
979 1042
… …
991itself. Useful when you queued a lot of events but got a result early. 1054itself. Useful when you queued a lot of events but got a result early.
992 1055
993=item $grp->result (...) 1056=item $grp->result (...)
994 1057
995Set the result value(s) that will be passed to the group callback when all 1058Set the result value(s) that will be passed to the group callback when all
996subrequests have finished and set thre groups errno to the current value 1059subrequests have finished and set the groups errno to the current value
997of errno (just like calling C<errno> without an error number). By default, 1060of errno (just like calling C<errno> without an error number). By default,
998no argument will be passed and errno is zero. 1061no argument will be passed and errno is zero.
999 1062
1000=item $grp->errno ([$errno]) 1063=item $grp->errno ([$errno])
1001 1064
… …
1012=item feed $grp $callback->($grp) 1075=item feed $grp $callback->($grp)
1013 1076
1014Sets a feeder/generator on this group: every group can have an attached 1077Sets a feeder/generator on this group: every group can have an attached
1015generator that generates requests if idle. The idea behind this is that, 1078generator that generates requests if idle. The idea behind this is that,
1016although you could just queue as many requests as you want in a group, 1079although you could just queue as many requests as you want in a group,
1017this might starve other requests for a potentially long time. For 1080this might starve other requests for a potentially long time. For example,
1018example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1081C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1019requests, delaying any later requests for a long time. 1082delaying any later requests for a long time.
1020 1083
1021To avoid this, and allow incremental generation of requests, you can 1084To avoid this, and allow incremental generation of requests, you can
1022instead a group and set a feeder on it that generates those requests. The 1085instead a group and set a feeder on it that generates those requests. The
1023feed callback will be called whenever there are few enough (see C<limit>, 1086feed callback will be called whenever there are few enough (see C<limit>,
1024below) requests active in the group itself and is expected to queue more 1087below) requests active in the group itself and is expected to queue more
… …
1028not impose any limits). 1091not impose any limits).
1029 1092
1030If the feed does not queue more requests when called, it will be 1093If the feed does not queue more requests when called, it will be
1031automatically removed from the group. 1094automatically removed from the group.
1032 1095
1033If the feed limit is C<0>, it will be set to C<2> automatically. 1096If the feed limit is C<0> when this method is called, it will be set to
1097C<2> automatically.
1034 1098
1035Example: 1099Example:
1036 1100
1037 # stat all files in @files, but only ever use four aio requests concurrently: 1101 # stat all files in @files, but only ever use four aio requests concurrently:
1038 1102
… …
1050Sets the feeder limit for the group: The feeder will be called whenever 1114Sets the feeder limit for the group: The feeder will be called whenever
1051the group contains less than this many requests. 1115the group contains less than this many requests.
1052 1116
1053Setting the limit to C<0> will pause the feeding process. 1117Setting the limit to C<0> will pause the feeding process.
1054 1118
1119The default value for the limit is C<0>, but note that setting a feeder
1120automatically bumps it up to C<2>.
1121
1055=back 1122=back
1056 1123
1057=head2 SUPPORT FUNCTIONS 1124=head2 SUPPORT FUNCTIONS
1058 1125
1059=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1126=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1070See C<poll_cb> for an example. 1137See C<poll_cb> for an example.
1071 1138
1072=item IO::AIO::poll_cb 1139=item IO::AIO::poll_cb
1073 1140
1074Process some outstanding events on the result pipe. You have to call this 1141Process some outstanding events on the result pipe. You have to call this
1075regularly. Returns the number of events processed. Returns immediately 1142regularly. Returns C<0> if all events could be processed, or C<-1> if it
1143returned earlier for whatever reason. Returns immediately when no events
1076when no events are outstanding. The amount of events processed depends on 1144are outstanding. The amount of events processed depends on the settings of
1077the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1145C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1078 1146
1079If not all requests were processed for whatever reason, the filehandle 1147If not all requests were processed for whatever reason, the filehandle
1080will still be ready when C<poll_cb> returns. 1148will still be ready when C<poll_cb> returns, so normally you don't have to
1149do anything special to have it called later.
1081 1150
1082Example: Install an Event watcher that automatically calls 1151Example: Install an Event watcher that automatically calls
1083IO::AIO::poll_cb with high priority: 1152IO::AIO::poll_cb with high priority:
1084 1153
1085 Event->io (fd => IO::AIO::poll_fileno, 1154 Event->io (fd => IO::AIO::poll_fileno,
… …
1199 1268
1200The default is probably ok in most situations, especially if thread 1269The default is probably ok in most situations, especially if thread
1201creation is fast. If thread creation is very slow on your system you might 1270creation is fast. If thread creation is very slow on your system you might
1202want to use larger values. 1271want to use larger values.
1203 1272
1204=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1273=item IO::AIO::max_outstanding $maxreqs
1205 1274
1206This is a very bad function to use in interactive programs because it 1275This is a very bad function to use in interactive programs because it
1207blocks, and a bad way to reduce concurrency because it is inexact: Better 1276blocks, and a bad way to reduce concurrency because it is inexact: Better
1208use an C<aio_group> together with a feed callback. 1277use an C<aio_group> together with a feed callback.
1209 1278
1210Sets the maximum number of outstanding requests to C<$nreqs>. If you 1279Sets the maximum number of outstanding requests to C<$nreqs>. If you
1211to queue up more than this number of requests, the next call to the 1280do queue up more than this number of requests, the next call to the
1212C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1281C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213function will block until the limit is no longer exceeded. 1282function will block until the limit is no longer exceeded.
1214 1283
1215The default value is very large, so there is no practical limit on the 1284The default value is very large, so there is no practical limit on the
1216number of outstanding requests. 1285number of outstanding requests.
1217 1286
1218You can still queue as many requests as you want. Therefore, 1287You can still queue as many requests as you want. Therefore,
1219C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1288C<max_outstanding> is mainly useful in simple scripts (with low values) or
1220as a stop gap to shield against fatal memory overflow (with large values). 1289as a stop gap to shield against fatal memory overflow (with large values).
1221 1290
1222=back 1291=back
1223 1292
1224=head3 STATISTICAL INFORMATION 1293=head3 STATISTICAL INFORMATION
… …
1246but not yet processed by poll_cb). 1315but not yet processed by poll_cb).
1247 1316
1248=back 1317=back
1249 1318
1250=cut 1319=cut
1251
1252# support function to convert a fd into a perl filehandle
1253sub _fd2fh {
1254 return undef if $_[0] < 0;
1255
1256 # try to generate nice filehandles
1257 my $sym = "IO::AIO::fd#$_[0]";
1258 local *$sym;
1259
1260 open *$sym, "+<&=$_[0]" # usually works under any unix
1261 or open *$sym, "<&=$_[0]" # cygwin needs this
1262 or open *$sym, ">&=$_[0]" # or this
1263 or return undef;
1264
1265 *$sym
1266}
1267 1320
1268min_parallel 8; 1321min_parallel 8;
1269 1322
1270END { flush } 1323END { flush }
1271 1324
… …
1310 1363
1311Known bugs will be fixed in the next release. 1364Known bugs will be fixed in the next release.
1312 1365
1313=head1 SEE ALSO 1366=head1 SEE ALSO
1314 1367
1315L<Coro::AIO>. 1368L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1369more natural syntax.
1316 1370
1317=head1 AUTHOR 1371=head1 AUTHOR
1318 1372
1319 Marc Lehmann <schmorp@schmorp.de> 1373 Marc Lehmann <schmorp@schmorp.de>
1320 http://home.schmorp.de/ 1374 http://home.schmorp.de/

Diff Legend

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