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.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.4'; 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
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
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
350
334If C<$offset> is undefined, then the current file offset will be used (and 351If C<$offset> is undefined, then the current file descriptor offset will
335updated), otherwise the file offset will not be changed by these calls. 352be used (and updated), otherwise the file descriptor offset will not be
353changed by these calls.
336 354
337If 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>.
338 357
339If 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
340C<$data>. 359C<$data>.
341 360
342The 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
526memory. Status is the same as with aio_read. 545memory. Status is the same as with aio_read.
527 546
528=cut 547=cut
529 548
530sub aio_load($$;$) { 549sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_; 550 my ($path, undef, $cb) = @_;
533 my $data = \$_[1]; 551 my $data = \$_[1];
534 552
535 my $pri = aioreq_pri; 553 my $pri = aioreq_pri;
536 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);
537 560
538 aioreq_pri $pri; 561 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 { 562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]); 563 $grp->result ($_[0]);
546 };
547 }; 564 };
548
549 $grp
550 } 565 };
566
567 $grp
551} 568}
552 569
553=item aio_copy $srcpath, $dstpath, $callback->($status) 570=item aio_copy $srcpath, $dstpath, $callback->($status)
554 571
555Try 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
556destination) from C<$srcpath> to C<$dstpath> and call the callback with 573destination) from C<$srcpath> to C<$dstpath> and call the callback with
557the C<0> (error) or C<-1> ok. 574the C<0> (error) or C<-1> ok.
558 575
559This is a composite request that it creates the destination file with 576This is a composite request that creates the destination file with
560mode 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
561C<aio_sendfile>, followed by restoring atime, mtime, access mode and 578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
562uid/gid, in that order. 579uid/gid, in that order.
563 580
564If an error occurs, the partial destination file will be unlinked, if 581If an error occurs, the partial destination file will be unlinked, if
566errors are being ignored. 583errors are being ignored.
567 584
568=cut 585=cut
569 586
570sub aio_copy($$;$) { 587sub aio_copy($$;$) {
571 aio_block {
572 my ($src, $dst, $cb) = @_; 588 my ($src, $dst, $cb) = @_;
573 589
574 my $pri = aioreq_pri; 590 my $pri = aioreq_pri;
575 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
576 592
577 aioreq_pri $pri; 593 aioreq_pri $pri;
578 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
579 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
580 my @stat = stat $src_fh; 596 my @stat = stat $src_fh; # hmm, might bock over nfs?
581 597
582 aioreq_pri $pri; 598 aioreq_pri $pri;
583 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 {
584 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
585 aioreq_pri $pri; 601 aioreq_pri $pri;
586 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 {
587 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
588 $grp->result (0); 604 $grp->result (0);
589 close $src_fh; 605 close $src_fh;
590 606
591 # those should not normally block. should. should.
592 utime $stat[8], $stat[9], $dst;
593 chmod $stat[2] & 07777, $dst_fh;
594 chown $stat[4], $stat[5], $dst_fh;
595 close $dst_fh;
596 } else { 607 my $ch = sub {
597 $grp->result (-1);
598 close $src_fh;
599 close $dst_fh;
600
601 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;
602 add $grp aio_unlink $dst; 613 add $grp aio_close $dst_fh;
614 }
615 };
603 } 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;
604 }; 634 }
605 } else {
606 $grp->result (-1);
607 } 635 };
636 } else {
637 $grp->result (-1);
608 }, 638 }
609
610 } else {
611 $grp->result (-1);
612 } 639 },
640
641 } else {
642 $grp->result (-1);
613 }; 643 }
614
615 $grp
616 } 644 };
645
646 $grp
617} 647}
618 648
619=item aio_move $srcpath, $dstpath, $callback->($status) 649=item aio_move $srcpath, $dstpath, $callback->($status)
620 650
621Try 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
622destination) from C<$srcpath> to C<$dstpath> and call the callback with 652destination) from C<$srcpath> to C<$dstpath> and call the callback with
623the C<0> (error) or C<-1> ok. 653the C<0> (error) or C<-1> ok.
624 654
625This 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
626rename 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
627that is successful, unlinking the C<$srcpath>. 657that is successful, unlinks the C<$srcpath>.
628 658
629=cut 659=cut
630 660
631sub aio_move($$;$) { 661sub aio_move($$;$) {
632 aio_block {
633 my ($src, $dst, $cb) = @_; 662 my ($src, $dst, $cb) = @_;
634 663
635 my $pri = aioreq_pri; 664 my $pri = aioreq_pri;
636 my $grp = aio_group $cb; 665 my $grp = aio_group $cb;
637 666
638 aioreq_pri $pri; 667 aioreq_pri $pri;
639 add $grp aio_rename $src, $dst, sub { 668 add $grp aio_rename $src, $dst, sub {
640 if ($_[0] && $! == EXDEV) { 669 if ($_[0] && $! == EXDEV) {
641 aioreq_pri $pri; 670 aioreq_pri $pri;
642 add $grp aio_copy $src, $dst, sub { 671 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]); 672 $grp->result ($_[0]);
673
674 if (!$_[0]) {
675 aioreq_pri $pri;
676 add $grp aio_unlink $src;
677 }
652 } 678 };
679 } else {
680 $grp->result ($_[0]);
653 }; 681 }
654
655 $grp
656 } 682 };
683
684 $grp
657} 685}
658 686
659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 687=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
660 688
661Scans a directory (similar to C<aio_readdir>) but additionally tries to 689Scans a directory (similar to C<aio_readdir>) but additionally tries to
709directory counting heuristic. 737directory counting heuristic.
710 738
711=cut 739=cut
712 740
713sub aio_scandir($$;$) { 741sub aio_scandir($$;$) {
714 aio_block {
715 my ($path, $maxreq, $cb) = @_; 742 my ($path, $maxreq, $cb) = @_;
716 743
717 my $pri = aioreq_pri; 744 my $pri = aioreq_pri;
718 745
719 my $grp = aio_group $cb; 746 my $grp = aio_group $cb;
720 747
721 $maxreq = 4 if $maxreq <= 0; 748 $maxreq = 4 if $maxreq <= 0;
722 749
723 # 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
724 aioreq_pri $pri; 758 aioreq_pri $pri;
725 add $grp aio_stat $path, sub { 759 add $grp aio_readdir $path, sub {
760 my $entries = shift
726 return $grp->result () if $_[0]; 761 or return $grp->result ();
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
729 762
730 # read the directory entries 763 # stat the dir another time
731 aioreq_pri $pri; 764 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 { 765 add $grp aio_stat $path, sub {
739 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 766 my $hash2 = join ":", (stat _)[0,1,3,7,9];
740 767
741 my $ndirs; 768 my $ndirs;
742 769
743 # take the slow route if anything looks fishy 770 # take the slow route if anything looks fishy
744 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 771 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
745 $ndirs = -1; 772 $ndirs = -1;
746 } else { 773 } else {
747 # if nlink == 2, we are finished 774 # if nlink == 2, we are finished
748 # on non-posix-fs's, we rely on nlink < 2 775 # on non-posix-fs's, we rely on nlink < 2
749 $ndirs = (stat _)[3] - 2 776 $ndirs = (stat _)[3] - 2
750 or return $grp->result ([], $entries); 777 or return $grp->result ([], $entries);
751 } 778 }
752 779
753 # sort into likely dirs and likely nondirs 780 # sort into likely dirs and likely nondirs
754 # dirs == files without ".", short entries first 781 # dirs == files without ".", short entries first
755 $entries = [map $_->[0], 782 $entries = [map $_->[0],
756 sort { $b->[1] cmp $a->[1] } 783 sort { $b->[1] cmp $a->[1] }
757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 784 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
758 @$entries]; 785 @$entries];
759 786
760 my (@dirs, @nondirs); 787 my (@dirs, @nondirs);
761 788
762 my $statgrp = add $grp aio_group sub { 789 my $statgrp = add $grp aio_group sub {
763 $grp->result (\@dirs, \@nondirs); 790 $grp->result (\@dirs, \@nondirs);
764 }; 791 };
765 792
766 limit $statgrp $maxreq; 793 limit $statgrp $maxreq;
767 feed $statgrp sub { 794 feed $statgrp sub {
768 return unless @$entries; 795 return unless @$entries;
769 my $entry = pop @$entries; 796 my $entry = pop @$entries;
770 797
771 aioreq_pri $pri; 798 aioreq_pri $pri;
772 add $statgrp aio_stat "$path/$entry/.", sub { 799 add $statgrp aio_stat "$path/$entry/.", sub {
773 if ($_[0] < 0) { 800 if ($_[0] < 0) {
774 push @nondirs, $entry; 801 push @nondirs, $entry;
775 } else { 802 } else {
776 # need to check for real directory 803 # need to check for real directory
777 aioreq_pri $pri; 804 aioreq_pri $pri;
778 add $statgrp aio_lstat "$path/$entry", sub { 805 add $statgrp aio_lstat "$path/$entry", sub {
779 if (-d _) { 806 if (-d _) {
780 push @dirs, $entry; 807 push @dirs, $entry;
781 808
782 unless (--$ndirs) { 809 unless (--$ndirs) {
783 push @nondirs, @$entries; 810 push @nondirs, @$entries;
784 feed $statgrp; 811 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
788 } 812 }
813 } else {
814 push @nondirs, $entry;
789 } 815 }
790 } 816 }
791 }; 817 }
792 }; 818 };
793 }; 819 };
794 }; 820 };
795 }; 821 };
796
797 $grp
798 } 822 };
823
824 $grp
799} 825}
800 826
801=item aio_rmtree $path, $callback->($status) 827=item aio_rmtree $path, $callback->($status)
802 828
803Delete a directory tree starting (and including) C<$path>, return the 829Delete a directory tree starting (and including) C<$path>, return the
807 833
808=cut 834=cut
809 835
810sub aio_rmtree; 836sub aio_rmtree;
811sub aio_rmtree($;$) { 837sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_; 838 my ($path, $cb) = @_;
814 839
815 my $pri = aioreq_pri; 840 my $pri = aioreq_pri;
816 my $grp = aio_group $cb; 841 my $grp = aio_group $cb;
817 842
818 aioreq_pri $pri; 843 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub { 844 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_; 845 my ($dirs, $nondirs) = @_;
821 846
822 my $dirgrp = aio_group sub { 847 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub { 848 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]); 849 $grp->result ($_[0]);
825 };
826 }; 850 };
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 }; 851 };
833 852
834 $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;
835 } 857 };
858
859 $grp
836} 860}
861
862=item aio_sync $callback->($status)
863
864Asynchronously call sync and call the callback when finished.
837 865
838=item aio_fsync $fh, $callback->($status) 866=item aio_fsync $fh, $callback->($status)
839 867
840Asynchronously call fsync on the given filehandle and call the callback 868Asynchronously call fsync on the given filehandle and call the callback
841with the fsync result code. 869with the fsync result code.
845Asynchronously call fdatasync on the given filehandle and call the 873Asynchronously call fdatasync on the given filehandle and call the
846callback with the fdatasync result code. 874callback with the fdatasync result code.
847 875
848If 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
849detected, 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}
850 928
851=item aio_group $callback->(...) 929=item aio_group $callback->(...)
852 930
853This 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
854container 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
966Their lifetime, simplified, looks like this: when they are empty, they 1044Their lifetime, simplified, looks like this: when they are empty, they
967will 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
968C<done> state, they will also finish. Otherwise they will continue to 1046C<done> state, they will also finish. Otherwise they will continue to
969exist. 1047exist.
970 1048
971That 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
972in 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
973group. 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
974itself finish. 1052further requests to the group. And only when all those requests have
1053finished will the the group itself finish.
975 1054
976=over 4 1055=over 4
977 1056
978=item add $grp ... 1057=item add $grp ...
979 1058
991itself. 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.
992 1071
993=item $grp->result (...) 1072=item $grp->result (...)
994 1073
995Set 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
996subrequests have finished and set thre groups errno to the current value 1075subrequests have finished and set the groups errno to the current value
997of 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,
998no argument will be passed and errno is zero. 1077no argument will be passed and errno is zero.
999 1078
1000=item $grp->errno ([$errno]) 1079=item $grp->errno ([$errno])
1001 1080
1012=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
1013 1092
1014Sets 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
1015generator that generates requests if idle. The idea behind this is that, 1094generator 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, 1095although you could just queue as many requests as you want in a group,
1017this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
1018example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1019requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
1020 1099
1021To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
1022instead 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
1023feed 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>,
1024below) 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
1028not impose any limits). 1107not impose any limits).
1029 1108
1030If 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
1031automatically removed from the group. 1110automatically removed from the group.
1032 1111
1033If 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.
1034 1114
1035Example: 1115Example:
1036 1116
1037 # 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:
1038 1118
1050Sets 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
1051the group contains less than this many requests. 1131the group contains less than this many requests.
1052 1132
1053Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
1054 1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1137
1055=back 1138=back
1056 1139
1057=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
1058 1141
1059=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1142=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1070See C<poll_cb> for an example. 1153See C<poll_cb> for an example.
1071 1154
1072=item IO::AIO::poll_cb 1155=item IO::AIO::poll_cb
1073 1156
1074Process 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
1075regularly. 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
1076when no events are outstanding. The amount of events processed depends on 1160are 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>. 1161C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1078 1162
1079If not all requests were processed for whatever reason, the filehandle 1163If not all requests were processed for whatever reason, the filehandle
1080will 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.
1081 1166
1082Example: Install an Event watcher that automatically calls 1167Example: Install an Event watcher that automatically calls
1083IO::AIO::poll_cb with high priority: 1168IO::AIO::poll_cb with high priority:
1084 1169
1085 Event->io (fd => IO::AIO::poll_fileno, 1170 Event->io (fd => IO::AIO::poll_fileno,
1199 1284
1200The default is probably ok in most situations, especially if thread 1285The default is probably ok in most situations, especially if thread
1201creation 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
1202want to use larger values. 1287want to use larger values.
1203 1288
1204=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1289=item IO::AIO::max_outstanding $maxreqs
1205 1290
1206This 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
1207blocks, 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
1208use an C<aio_group> together with a feed callback. 1293use an C<aio_group> together with a feed callback.
1209 1294
1210Sets the maximum number of outstanding requests to C<$nreqs>. If you 1295Sets 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 1296do 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>) 1297C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213function will block until the limit is no longer exceeded. 1298function will block until the limit is no longer exceeded.
1214 1299
1215The 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
1216number of outstanding requests. 1301number of outstanding requests.
1217 1302
1218You can still queue as many requests as you want. Therefore, 1303You can still queue as many requests as you want. Therefore,
1219C<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
1220as 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).
1221 1306
1222=back 1307=back
1223 1308
1224=head3 STATISTICAL INFORMATION 1309=head3 STATISTICAL INFORMATION
1246but not yet processed by poll_cb). 1331but not yet processed by poll_cb).
1247 1332
1248=back 1333=back
1249 1334
1250=cut 1335=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 1336
1268min_parallel 8; 1337min_parallel 8;
1269 1338
1270END { flush } 1339END { flush }
1271 1340
1295bytes of memory. In addition, stat requests need a stat buffer (possibly 1364bytes of memory. In addition, stat requests need a stat buffer (possibly
1296a few hundred bytes), readdir requires a result buffer and so on. Perl 1365a 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 1366scalars and other data passed into aio requests will also be locked and
1298will consume memory till the request has entered the done state. 1367will consume memory till the request has entered the done state.
1299 1368
1300This is now awfully much, so queuing lots of requests is not usually a 1369This is not awfully much, so queuing lots of requests is not usually a
1301problem. 1370problem.
1302 1371
1303Per-thread usage: 1372Per-thread usage:
1304 1373
1305In the execution phase, some aio requests require more memory for 1374In the execution phase, some aio requests require more memory for
1310 1379
1311Known bugs will be fixed in the next release. 1380Known bugs will be fixed in the next release.
1312 1381
1313=head1 SEE ALSO 1382=head1 SEE ALSO
1314 1383
1315L<Coro::AIO>. 1384L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1385more natural syntax.
1316 1386
1317=head1 AUTHOR 1387=head1 AUTHOR
1318 1388
1319 Marc Lehmann <schmorp@schmorp.de> 1389 Marc Lehmann <schmorp@schmorp.de>
1320 http://home.schmorp.de/ 1390 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines