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.110 by root, Sun Jul 8 09:09:34 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);
… …
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.17';
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 the specified C<$fh> and C<$offset>
330into the scalar given by C<$data> and offset C<$dataoffset> and calls the 344into the scalar given by C<$data> and offset C<$dataoffset> and calls the
331callback without the actual number of bytes read (or -1 on error, just 345callback without the actual number of bytes read (or -1 on error, just
332like the syscall). 346like 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 C<$data>.
338 353
339If C<$dataoffset> is less than zero, it will be counted from the end of 354If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>. 355C<$data>.
341 356
342The C<$data> scalar I<MUST NOT> be modified in any way while the request 357The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
526memory. Status is the same as with aio_read. 541memory. Status is the same as with aio_read.
527 542
528=cut 543=cut
529 544
530sub aio_load($$;$) { 545sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_; 546 my ($path, undef, $cb) = @_;
533 my $data = \$_[1]; 547 my $data = \$_[1];
534 548
535 my $pri = aioreq_pri; 549 my $pri = aioreq_pri;
536 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);
537 556
538 aioreq_pri $pri; 557 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 { 558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]); 559 $grp->result ($_[0]);
546 };
547 }; 560 };
548
549 $grp
550 } 561 };
562
563 $grp
551} 564}
552 565
553=item aio_copy $srcpath, $dstpath, $callback->($status) 566=item aio_copy $srcpath, $dstpath, $callback->($status)
554 567
555Try 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
556destination) from C<$srcpath> to C<$dstpath> and call the callback with 569destination) from C<$srcpath> to C<$dstpath> and call the callback with
557the C<0> (error) or C<-1> ok. 570the C<0> (error) or C<-1> ok.
558 571
559This is a composite request that it creates the destination file with 572This is a composite request that creates the destination file with
560mode 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
561C<aio_sendfile>, followed by restoring atime, mtime, access mode and 574C<aio_sendfile>, followed by restoring atime, mtime, access mode and
562uid/gid, in that order. 575uid/gid, in that order.
563 576
564If an error occurs, the partial destination file will be unlinked, if 577If an error occurs, the partial destination file will be unlinked, if
… …
566errors are being ignored. 579errors are being ignored.
567 580
568=cut 581=cut
569 582
570sub aio_copy($$;$) { 583sub aio_copy($$;$) {
571 aio_block {
572 my ($src, $dst, $cb) = @_; 584 my ($src, $dst, $cb) = @_;
573 585
574 my $pri = aioreq_pri; 586 my $pri = aioreq_pri;
575 my $grp = aio_group $cb; 587 my $grp = aio_group $cb;
576 588
577 aioreq_pri $pri; 589 aioreq_pri $pri;
578 add $grp aio_open $src, O_RDONLY, 0, sub { 590 add $grp aio_open $src, O_RDONLY, 0, sub {
579 if (my $src_fh = $_[0]) { 591 if (my $src_fh = $_[0]) {
580 my @stat = stat $src_fh; 592 my @stat = stat $src_fh;
581 593
582 aioreq_pri $pri; 594 aioreq_pri $pri;
583 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 {
584 if (my $dst_fh = $_[0]) { 596 if (my $dst_fh = $_[0]) {
585 aioreq_pri $pri; 597 aioreq_pri $pri;
586 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 {
587 if ($_[0] == $stat[7]) { 599 if ($_[0] == $stat[7]) {
588 $grp->result (0); 600 $grp->result (0);
589 close $src_fh; 601 close $src_fh;
590 602
591 # those should not normally block. should. should. 603 # those should not normally block. should. should.
592 utime $stat[8], $stat[9], $dst; 604 utime $stat[8], $stat[9], $dst;
593 chmod $stat[2] & 07777, $dst_fh; 605 chmod $stat[2] & 07777, $dst_fh;
594 chown $stat[4], $stat[5], $dst_fh; 606 chown $stat[4], $stat[5], $dst_fh;
607
608 aioreq_pri $pri;
595 close $dst_fh; 609 add $grp aio_close $dst_fh;
596 } else { 610 } else {
597 $grp->result (-1); 611 $grp->result (-1);
598 close $src_fh; 612 close $src_fh;
599 close $dst_fh; 613 close $dst_fh;
600 614
601 aioreq $pri; 615 aioreq $pri;
602 add $grp aio_unlink $dst; 616 add $grp aio_unlink $dst;
603 }
604 }; 617 }
605 } else {
606 $grp->result (-1);
607 } 618 };
619 } else {
620 $grp->result (-1);
608 }, 621 }
609
610 } else {
611 $grp->result (-1);
612 } 622 },
623
624 } else {
625 $grp->result (-1);
613 }; 626 }
614
615 $grp
616 } 627 };
628
629 $grp
617} 630}
618 631
619=item aio_move $srcpath, $dstpath, $callback->($status) 632=item aio_move $srcpath, $dstpath, $callback->($status)
620 633
621Try 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
622destination) from C<$srcpath> to C<$dstpath> and call the callback with 635destination) from C<$srcpath> to C<$dstpath> and call the callback with
623the C<0> (error) or C<-1> ok. 636the C<0> (error) or C<-1> ok.
624 637
625This 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
626rename 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
627that is successful, unlinking the C<$srcpath>. 640that is successful, unlinks the C<$srcpath>.
628 641
629=cut 642=cut
630 643
631sub aio_move($$;$) { 644sub aio_move($$;$) {
632 aio_block {
633 my ($src, $dst, $cb) = @_; 645 my ($src, $dst, $cb) = @_;
634 646
635 my $pri = aioreq_pri; 647 my $pri = aioreq_pri;
636 my $grp = aio_group $cb; 648 my $grp = aio_group $cb;
637 649
638 aioreq_pri $pri; 650 aioreq_pri $pri;
639 add $grp aio_rename $src, $dst, sub { 651 add $grp aio_rename $src, $dst, sub {
640 if ($_[0] && $! == EXDEV) { 652 if ($_[0] && $! == EXDEV) {
641 aioreq_pri $pri; 653 aioreq_pri $pri;
642 add $grp aio_copy $src, $dst, sub { 654 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]); 655 $grp->result ($_[0]);
656
657 if (!$_[0]) {
658 aioreq_pri $pri;
659 add $grp aio_unlink $src;
660 }
652 } 661 };
662 } else {
663 $grp->result ($_[0]);
653 }; 664 }
654
655 $grp
656 } 665 };
666
667 $grp
657} 668}
658 669
659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 670=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
660 671
661Scans a directory (similar to C<aio_readdir>) but additionally tries to 672Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
709directory counting heuristic. 720directory counting heuristic.
710 721
711=cut 722=cut
712 723
713sub aio_scandir($$;$) { 724sub aio_scandir($$;$) {
714 aio_block {
715 my ($path, $maxreq, $cb) = @_; 725 my ($path, $maxreq, $cb) = @_;
716 726
717 my $pri = aioreq_pri; 727 my $pri = aioreq_pri;
718 728
719 my $grp = aio_group $cb; 729 my $grp = aio_group $cb;
720 730
721 $maxreq = 4 if $maxreq <= 0; 731 $maxreq = 4 if $maxreq <= 0;
722 732
723 # 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
724 aioreq_pri $pri; 741 aioreq_pri $pri;
725 add $grp aio_stat $path, sub { 742 add $grp aio_readdir $path, sub {
743 my $entries = shift
726 return $grp->result () if $_[0]; 744 or return $grp->result ();
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
729 745
730 # read the directory entries 746 # stat the dir another time
731 aioreq_pri $pri; 747 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 { 748 add $grp aio_stat $path, sub {
739 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 749 my $hash2 = join ":", (stat _)[0,1,3,7,9];
740 750
741 my $ndirs; 751 my $ndirs;
742 752
743 # take the slow route if anything looks fishy 753 # take the slow route if anything looks fishy
744 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 754 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
745 $ndirs = -1; 755 $ndirs = -1;
746 } else { 756 } else {
747 # if nlink == 2, we are finished 757 # if nlink == 2, we are finished
748 # on non-posix-fs's, we rely on nlink < 2 758 # on non-posix-fs's, we rely on nlink < 2
749 $ndirs = (stat _)[3] - 2 759 $ndirs = (stat _)[3] - 2
750 or return $grp->result ([], $entries); 760 or return $grp->result ([], $entries);
751 } 761 }
752 762
753 # sort into likely dirs and likely nondirs 763 # sort into likely dirs and likely nondirs
754 # dirs == files without ".", short entries first 764 # dirs == files without ".", short entries first
755 $entries = [map $_->[0], 765 $entries = [map $_->[0],
756 sort { $b->[1] cmp $a->[1] } 766 sort { $b->[1] cmp $a->[1] }
757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 767 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
758 @$entries]; 768 @$entries];
759 769
760 my (@dirs, @nondirs); 770 my (@dirs, @nondirs);
761 771
762 my $statgrp = add $grp aio_group sub { 772 my $statgrp = add $grp aio_group sub {
763 $grp->result (\@dirs, \@nondirs); 773 $grp->result (\@dirs, \@nondirs);
764 }; 774 };
765 775
766 limit $statgrp $maxreq; 776 limit $statgrp $maxreq;
767 feed $statgrp sub { 777 feed $statgrp sub {
768 return unless @$entries; 778 return unless @$entries;
769 my $entry = pop @$entries; 779 my $entry = pop @$entries;
770 780
771 aioreq_pri $pri; 781 aioreq_pri $pri;
772 add $statgrp aio_stat "$path/$entry/.", sub { 782 add $statgrp aio_stat "$path/$entry/.", sub {
773 if ($_[0] < 0) { 783 if ($_[0] < 0) {
774 push @nondirs, $entry; 784 push @nondirs, $entry;
775 } else { 785 } else {
776 # need to check for real directory 786 # need to check for real directory
777 aioreq_pri $pri; 787 aioreq_pri $pri;
778 add $statgrp aio_lstat "$path/$entry", sub { 788 add $statgrp aio_lstat "$path/$entry", sub {
779 if (-d _) { 789 if (-d _) {
780 push @dirs, $entry; 790 push @dirs, $entry;
781 791
782 unless (--$ndirs) { 792 unless (--$ndirs) {
783 push @nondirs, @$entries; 793 push @nondirs, @$entries;
784 feed $statgrp; 794 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
788 } 795 }
796 } else {
797 push @nondirs, $entry;
789 } 798 }
790 } 799 }
791 }; 800 }
792 }; 801 };
793 }; 802 };
794 }; 803 };
795 }; 804 };
796
797 $grp
798 } 805 };
806
807 $grp
799} 808}
800 809
801=item aio_rmtree $path, $callback->($status) 810=item aio_rmtree $path, $callback->($status)
802 811
803Delete a directory tree starting (and including) C<$path>, return the 812Delete a directory tree starting (and including) C<$path>, return the
… …
807 816
808=cut 817=cut
809 818
810sub aio_rmtree; 819sub aio_rmtree;
811sub aio_rmtree($;$) { 820sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_; 821 my ($path, $cb) = @_;
814 822
815 my $pri = aioreq_pri; 823 my $pri = aioreq_pri;
816 my $grp = aio_group $cb; 824 my $grp = aio_group $cb;
817 825
818 aioreq_pri $pri; 826 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub { 827 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_; 828 my ($dirs, $nondirs) = @_;
821 829
822 my $dirgrp = aio_group sub { 830 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub { 831 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]); 832 $grp->result ($_[0]);
825 };
826 }; 833 };
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 }; 834 };
833 835
834 $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;
835 } 840 };
841
842 $grp
836} 843}
844
845=item aio_sync $callback->($status)
846
847Asynchronously call sync and call the callback when finished.
837 848
838=item aio_fsync $fh, $callback->($status) 849=item aio_fsync $fh, $callback->($status)
839 850
840Asynchronously call fsync on the given filehandle and call the callback 851Asynchronously call fsync on the given filehandle and call the callback
841with the fsync result code. 852with the fsync result code.
… …
845Asynchronously call fdatasync on the given filehandle and call the 856Asynchronously call fdatasync on the given filehandle and call the
846callback with the fdatasync result code. 857callback with the fdatasync result code.
847 858
848If 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
849detected, 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}
850 911
851=item aio_group $callback->(...) 912=item aio_group $callback->(...)
852 913
853This 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
854container 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
… …
966Their lifetime, simplified, looks like this: when they are empty, they 1027Their lifetime, simplified, looks like this: when they are empty, they
967will 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
968C<done> state, they will also finish. Otherwise they will continue to 1029C<done> state, they will also finish. Otherwise they will continue to
969exist. 1030exist.
970 1031
971That 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
972in 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
973group. 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
974itself finish. 1035further requests to the group. And only when all those requests have
1036finished will the the group itself finish.
975 1037
976=over 4 1038=over 4
977 1039
978=item add $grp ... 1040=item add $grp ...
979 1041
… …
991itself. 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.
992 1054
993=item $grp->result (...) 1055=item $grp->result (...)
994 1056
995Set 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
996subrequests have finished and set thre groups errno to the current value 1058subrequests have finished and set the groups errno to the current value
997of 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,
998no argument will be passed and errno is zero. 1060no argument will be passed and errno is zero.
999 1061
1000=item $grp->errno ([$errno]) 1062=item $grp->errno ([$errno])
1001 1063
… …
1012=item feed $grp $callback->($grp) 1074=item feed $grp $callback->($grp)
1013 1075
1014Sets 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
1015generator that generates requests if idle. The idea behind this is that, 1077generator 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, 1078although you could just queue as many requests as you want in a group,
1017this might starve other requests for a potentially long time. For 1079this might starve other requests for a potentially long time. For example,
1018example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1080C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1019requests, delaying any later requests for a long time. 1081delaying any later requests for a long time.
1020 1082
1021To avoid this, and allow incremental generation of requests, you can 1083To avoid this, and allow incremental generation of requests, you can
1022instead 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
1023feed 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>,
1024below) 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
… …
1028not impose any limits). 1090not impose any limits).
1029 1091
1030If 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
1031automatically removed from the group. 1093automatically removed from the group.
1032 1094
1033If 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.
1034 1097
1035Example: 1098Example:
1036 1099
1037 # 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:
1038 1101
… …
1050Sets 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
1051the group contains less than this many requests. 1114the group contains less than this many requests.
1052 1115
1053Setting the limit to C<0> will pause the feeding process. 1116Setting the limit to C<0> will pause the feeding process.
1054 1117
1118The default value for the limit is C<0>, but note that setting a feeder
1119automatically bumps it up to C<2>.
1120
1055=back 1121=back
1056 1122
1057=head2 SUPPORT FUNCTIONS 1123=head2 SUPPORT FUNCTIONS
1058 1124
1059=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1125=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1070See C<poll_cb> for an example. 1136See C<poll_cb> for an example.
1071 1137
1072=item IO::AIO::poll_cb 1138=item IO::AIO::poll_cb
1073 1139
1074Process 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
1075regularly. 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
1076when no events are outstanding. The amount of events processed depends on 1143are 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>. 1144C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1078 1145
1079If not all requests were processed for whatever reason, the filehandle 1146If not all requests were processed for whatever reason, the filehandle
1080will 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.
1081 1149
1082Example: Install an Event watcher that automatically calls 1150Example: Install an Event watcher that automatically calls
1083IO::AIO::poll_cb with high priority: 1151IO::AIO::poll_cb with high priority:
1084 1152
1085 Event->io (fd => IO::AIO::poll_fileno, 1153 Event->io (fd => IO::AIO::poll_fileno,
… …
1199 1267
1200The default is probably ok in most situations, especially if thread 1268The default is probably ok in most situations, especially if thread
1201creation 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
1202want to use larger values. 1270want to use larger values.
1203 1271
1204=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1272=item IO::AIO::max_outstanding $maxreqs
1205 1273
1206This 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
1207blocks, 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
1208use an C<aio_group> together with a feed callback. 1276use an C<aio_group> together with a feed callback.
1209 1277
1210Sets the maximum number of outstanding requests to C<$nreqs>. If you 1278Sets 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 1279do 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>) 1280C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213function will block until the limit is no longer exceeded. 1281function will block until the limit is no longer exceeded.
1214 1282
1215The 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
1216number of outstanding requests. 1284number of outstanding requests.
1217 1285
1218You can still queue as many requests as you want. Therefore, 1286You can still queue as many requests as you want. Therefore,
1219C<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
1220as 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).
1221 1289
1222=back 1290=back
1223 1291
1224=head3 STATISTICAL INFORMATION 1292=head3 STATISTICAL INFORMATION
… …
1246but not yet processed by poll_cb). 1314but not yet processed by poll_cb).
1247 1315
1248=back 1316=back
1249 1317
1250=cut 1318=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 1319
1268min_parallel 8; 1320min_parallel 8;
1269 1321
1270END { flush } 1322END { flush }
1271 1323
… …
1295bytes of memory. In addition, stat requests need a stat buffer (possibly 1347bytes of memory. In addition, stat requests need a stat buffer (possibly
1296a few hundred bytes), readdir requires a result buffer and so on. Perl 1348a few hundred bytes), readdir requires a result buffer and so on. Perl
1297scalars and other data passed into aio requests will also be locked and 1349scalars and other data passed into aio requests will also be locked and
1298will consume memory till the request has entered the done state. 1350will consume memory till the request has entered the done state.
1299 1351
1300This is now awfully much, so queuing lots of requests is not usually a 1352This is not awfully much, so queuing lots of requests is not usually a
1301problem. 1353problem.
1302 1354
1303Per-thread usage: 1355Per-thread usage:
1304 1356
1305In the execution phase, some aio requests require more memory for 1357In the execution phase, some aio requests require more memory for
… …
1310 1362
1311Known bugs will be fixed in the next release. 1363Known bugs will be fixed in the next release.
1312 1364
1313=head1 SEE ALSO 1365=head1 SEE ALSO
1314 1366
1315L<Coro::AIO>. 1367L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1368more natural syntax.
1316 1369
1317=head1 AUTHOR 1370=head1 AUTHOR
1318 1371
1319 Marc Lehmann <schmorp@schmorp.de> 1372 Marc Lehmann <schmorp@schmorp.de>
1320 http://home.schmorp.de/ 1373 http://home.schmorp.de/

Diff Legend

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