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.119 by root, Sun Dec 2 20:54:33 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, urxvt, pureperl...) 31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 use AnyEvent::AIO;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 33
35 # EV integration 34 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37 36
38 # Event integration 37 # Event integration
… …
194use strict 'vars'; 193use strict 'vars';
195 194
196use base 'Exporter'; 195use base 'Exporter';
197 196
198BEGIN { 197BEGIN {
199 our $VERSION = '2.6'; 198 our $VERSION = '3.19';
200 199
201 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
202 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
203 aio_readlink aio_sync 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
204 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
205 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads 211 nreqs nready npending nthreads
210 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
211 215
212 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
213 217
214 require XSLoader; 218 require XSLoader;
215 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
222All 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
223with 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,
224and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
225which 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
226the 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
227perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
228syscall has been executed asynchronously. 232syscall has been executed asynchronously.
229 233
230All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
231internally until the request has finished. 235internally until the request has finished.
232 236
… …
246your 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
247environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
248use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
249 253
250This 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
251handles correctly wether it is set or not. 255handles correctly whether it is set or not.
252 256
253=over 4 257=over 4
254 258
255=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
256 260
… …
319 323
320Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
321code. 325code.
322 326
323Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
324closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
325what aio_close will try:
326 329
327 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
328 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
329 3. dup()licate the fd once more 332(the pipe fd will be created on demand and will be cached).
330 4. let perl close() the filehandle
331 5. asynchronously close the duplicated fd
332 333
333The idea is that the first close() flushes stuff to disk that closing an 334Or in other words: the file descriptor will be closed, but it will not be
334fd will flush, so when perl closes the fd, nothing much will need to be 335free for reuse until the perl filehandle is closed.
335flushed. The second async. close() will then flush stuff to disk that
336closing the last fd to the file will flush.
337
338Just FYI, SuSv3 has this to say on close:
339
340 All outstanding record locks owned by the process on the file
341 associated with the file descriptor shall be removed.
342
343 If fildes refers to a socket, close() shall cause the socket to be
344 destroyed. ... close() shall block for up to the current linger
345 interval until all data is transmitted.
346 [this actually sounds like a specification bug, but who knows]
347
348And at least Linux additionally actually flushes stuff on every close,
349even when the file itself is still open.
350
351Sounds enourmously inefficient and complicated? Yes... please show me how
352to nuke perl's fd out of existence...
353 336
354=cut 337=cut
355 338
356sub aio_close($;$) {
357 aio_block {
358 my ($fh, $cb) = @_;
359
360 my $pri = aioreq_pri;
361 my $grp = aio_group $cb;
362
363 my $fd = fileno $fh;
364
365 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
366
367 # if the dups fail we will simply get EBADF
368 my $fd2 = _dup $fd;
369 aioreq_pri $pri;
370 add $grp _aio_close $fd2, sub {
371 my $fd2 = _dup $fd;
372 close $fh;
373 aioreq_pri $pri;
374 add $grp _aio_close $fd2, sub {
375 $grp->result ($_[0]);
376 };
377 };
378
379 $grp
380 }
381}
382
383
384=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
385 340
386=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
387 342
388Reads 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
389into 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>
390callback 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
391like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
392 350
393If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
394be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
395changed by these calls. 353changed by these calls.
396 354
397If 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>.
398 357
399If 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
400C<$data>. 359C<$data>.
401 360
402The 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
… …
586memory. Status is the same as with aio_read. 545memory. Status is the same as with aio_read.
587 546
588=cut 547=cut
589 548
590sub aio_load($$;$) { 549sub aio_load($$;$) {
591 aio_block {
592 my ($path, undef, $cb) = @_; 550 my ($path, undef, $cb) = @_;
593 my $data = \$_[1]; 551 my $data = \$_[1];
594 552
595 my $pri = aioreq_pri; 553 my $pri = aioreq_pri;
596 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);
597 560
598 aioreq_pri $pri; 561 aioreq_pri $pri;
599 add $grp aio_open $path, O_RDONLY, 0, sub {
600 my $fh = shift
601 or return $grp->result (-1);
602
603 aioreq_pri $pri;
604 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
605 $grp->result ($_[0]); 563 $grp->result ($_[0]);
606 };
607 }; 564 };
608
609 $grp
610 } 565 };
566
567 $grp
611} 568}
612 569
613=item aio_copy $srcpath, $dstpath, $callback->($status) 570=item aio_copy $srcpath, $dstpath, $callback->($status)
614 571
615Try 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
616destination) from C<$srcpath> to C<$dstpath> and call the callback with 573destination) from C<$srcpath> to C<$dstpath> and call the callback with
617the C<0> (error) or C<-1> ok. 574the C<0> (error) or C<-1> ok.
618 575
619This is a composite request that it creates the destination file with 576This is a composite request that creates the destination file with
620mode 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
621C<aio_sendfile>, followed by restoring atime, mtime, access mode and 578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
622uid/gid, in that order. 579uid/gid, in that order.
623 580
624If an error occurs, the partial destination file will be unlinked, if 581If an error occurs, the partial destination file will be unlinked, if
… …
626errors are being ignored. 583errors are being ignored.
627 584
628=cut 585=cut
629 586
630sub aio_copy($$;$) { 587sub aio_copy($$;$) {
631 aio_block {
632 my ($src, $dst, $cb) = @_; 588 my ($src, $dst, $cb) = @_;
633 589
634 my $pri = aioreq_pri; 590 my $pri = aioreq_pri;
635 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
636 592
637 aioreq_pri $pri; 593 aioreq_pri $pri;
638 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
639 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
640 my @stat = stat $src_fh; 596 my @stat = stat $src_fh; # hmm, might bock over nfs?
641 597
642 aioreq_pri $pri; 598 aioreq_pri $pri;
643 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 {
644 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
645 aioreq_pri $pri; 601 aioreq_pri $pri;
646 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 {
647 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
648 $grp->result (0); 604 $grp->result (0);
649 close $src_fh; 605 close $src_fh;
650 606
651 # those should not normally block. should. should.
652 utime $stat[8], $stat[9], $dst;
653 chmod $stat[2] & 07777, $dst_fh;
654 chown $stat[4], $stat[5], $dst_fh;
655 close $dst_fh;
656 } else { 607 my $ch = sub {
657 $grp->result (-1);
658 close $src_fh;
659 close $dst_fh;
660
661 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;
662 add $grp aio_unlink $dst; 613 add $grp aio_close $dst_fh;
614 }
615 };
663 } 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;
664 }; 634 }
665 } else {
666 $grp->result (-1);
667 } 635 };
636 } else {
637 $grp->result (-1);
668 }, 638 }
669
670 } else {
671 $grp->result (-1);
672 } 639 },
640
641 } else {
642 $grp->result (-1);
673 }; 643 }
674
675 $grp
676 } 644 };
645
646 $grp
677} 647}
678 648
679=item aio_move $srcpath, $dstpath, $callback->($status) 649=item aio_move $srcpath, $dstpath, $callback->($status)
680 650
681Try 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
682destination) from C<$srcpath> to C<$dstpath> and call the callback with 652destination) from C<$srcpath> to C<$dstpath> and call the callback with
683the C<0> (error) or C<-1> ok. 653the C<0> (error) or C<-1> ok.
684 654
685This 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
686rename 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
687that is successful, unlinking the C<$srcpath>. 657that is successful, unlinks the C<$srcpath>.
688 658
689=cut 659=cut
690 660
691sub aio_move($$;$) { 661sub aio_move($$;$) {
692 aio_block {
693 my ($src, $dst, $cb) = @_; 662 my ($src, $dst, $cb) = @_;
694 663
695 my $pri = aioreq_pri; 664 my $pri = aioreq_pri;
696 my $grp = aio_group $cb; 665 my $grp = aio_group $cb;
697 666
698 aioreq_pri $pri; 667 aioreq_pri $pri;
699 add $grp aio_rename $src, $dst, sub { 668 add $grp aio_rename $src, $dst, sub {
700 if ($_[0] && $! == EXDEV) { 669 if ($_[0] && $! == EXDEV) {
701 aioreq_pri $pri; 670 aioreq_pri $pri;
702 add $grp aio_copy $src, $dst, sub { 671 add $grp aio_copy $src, $dst, sub {
703 $grp->result ($_[0]);
704
705 if (!$_[0]) {
706 aioreq_pri $pri;
707 add $grp aio_unlink $src;
708 }
709 };
710 } else {
711 $grp->result ($_[0]); 672 $grp->result ($_[0]);
673
674 if (!$_[0]) {
675 aioreq_pri $pri;
676 add $grp aio_unlink $src;
677 }
712 } 678 };
679 } else {
680 $grp->result ($_[0]);
713 }; 681 }
714
715 $grp
716 } 682 };
683
684 $grp
717} 685}
718 686
719=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 687=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
720 688
721Scans a directory (similar to C<aio_readdir>) but additionally tries to 689Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
769directory counting heuristic. 737directory counting heuristic.
770 738
771=cut 739=cut
772 740
773sub aio_scandir($$;$) { 741sub aio_scandir($$;$) {
774 aio_block {
775 my ($path, $maxreq, $cb) = @_; 742 my ($path, $maxreq, $cb) = @_;
776 743
777 my $pri = aioreq_pri; 744 my $pri = aioreq_pri;
778 745
779 my $grp = aio_group $cb; 746 my $grp = aio_group $cb;
780 747
781 $maxreq = 4 if $maxreq <= 0; 748 $maxreq = 4 if $maxreq <= 0;
782 749
783 # 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
784 aioreq_pri $pri; 758 aioreq_pri $pri;
785 add $grp aio_stat $path, sub { 759 add $grp aio_readdir $path, sub {
760 my $entries = shift
786 return $grp->result () if $_[0]; 761 or return $grp->result ();
787 my $now = time;
788 my $hash1 = join ":", (stat _)[0,1,3,7,9];
789 762
790 # read the directory entries 763 # stat the dir another time
791 aioreq_pri $pri; 764 aioreq_pri $pri;
792 add $grp aio_readdir $path, sub {
793 my $entries = shift
794 or return $grp->result ();
795
796 # stat the dir another time
797 aioreq_pri $pri;
798 add $grp aio_stat $path, sub { 765 add $grp aio_stat $path, sub {
799 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 766 my $hash2 = join ":", (stat _)[0,1,3,7,9];
800 767
801 my $ndirs; 768 my $ndirs;
802 769
803 # take the slow route if anything looks fishy 770 # take the slow route if anything looks fishy
804 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 771 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
805 $ndirs = -1; 772 $ndirs = -1;
806 } else { 773 } else {
807 # if nlink == 2, we are finished 774 # if nlink == 2, we are finished
808 # on non-posix-fs's, we rely on nlink < 2 775 # on non-posix-fs's, we rely on nlink < 2
809 $ndirs = (stat _)[3] - 2 776 $ndirs = (stat _)[3] - 2
810 or return $grp->result ([], $entries); 777 or return $grp->result ([], $entries);
811 } 778 }
812 779
813 # sort into likely dirs and likely nondirs 780 # sort into likely dirs and likely nondirs
814 # dirs == files without ".", short entries first 781 # dirs == files without ".", short entries first
815 $entries = [map $_->[0], 782 $entries = [map $_->[0],
816 sort { $b->[1] cmp $a->[1] } 783 sort { $b->[1] cmp $a->[1] }
817 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 784 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
818 @$entries]; 785 @$entries];
819 786
820 my (@dirs, @nondirs); 787 my (@dirs, @nondirs);
821 788
822 my $statgrp = add $grp aio_group sub { 789 my $statgrp = add $grp aio_group sub {
823 $grp->result (\@dirs, \@nondirs); 790 $grp->result (\@dirs, \@nondirs);
824 }; 791 };
825 792
826 limit $statgrp $maxreq; 793 limit $statgrp $maxreq;
827 feed $statgrp sub { 794 feed $statgrp sub {
828 return unless @$entries; 795 return unless @$entries;
829 my $entry = pop @$entries; 796 my $entry = pop @$entries;
830 797
831 aioreq_pri $pri; 798 aioreq_pri $pri;
832 add $statgrp aio_stat "$path/$entry/.", sub { 799 add $statgrp aio_stat "$path/$entry/.", sub {
833 if ($_[0] < 0) { 800 if ($_[0] < 0) {
834 push @nondirs, $entry; 801 push @nondirs, $entry;
835 } else { 802 } else {
836 # need to check for real directory 803 # need to check for real directory
837 aioreq_pri $pri; 804 aioreq_pri $pri;
838 add $statgrp aio_lstat "$path/$entry", sub { 805 add $statgrp aio_lstat "$path/$entry", sub {
839 if (-d _) { 806 if (-d _) {
840 push @dirs, $entry; 807 push @dirs, $entry;
841 808
842 unless (--$ndirs) { 809 unless (--$ndirs) {
843 push @nondirs, @$entries; 810 push @nondirs, @$entries;
844 feed $statgrp; 811 feed $statgrp;
845 }
846 } else {
847 push @nondirs, $entry;
848 } 812 }
813 } else {
814 push @nondirs, $entry;
849 } 815 }
850 } 816 }
851 }; 817 }
852 }; 818 };
853 }; 819 };
854 }; 820 };
855 }; 821 };
856
857 $grp
858 } 822 };
823
824 $grp
859} 825}
860 826
861=item aio_rmtree $path, $callback->($status) 827=item aio_rmtree $path, $callback->($status)
862 828
863Delete a directory tree starting (and including) C<$path>, return the 829Delete a directory tree starting (and including) C<$path>, return the
… …
867 833
868=cut 834=cut
869 835
870sub aio_rmtree; 836sub aio_rmtree;
871sub aio_rmtree($;$) { 837sub aio_rmtree($;$) {
872 aio_block {
873 my ($path, $cb) = @_; 838 my ($path, $cb) = @_;
874 839
875 my $pri = aioreq_pri; 840 my $pri = aioreq_pri;
876 my $grp = aio_group $cb; 841 my $grp = aio_group $cb;
877 842
878 aioreq_pri $pri; 843 aioreq_pri $pri;
879 add $grp aio_scandir $path, 0, sub { 844 add $grp aio_scandir $path, 0, sub {
880 my ($dirs, $nondirs) = @_; 845 my ($dirs, $nondirs) = @_;
881 846
882 my $dirgrp = aio_group sub { 847 my $dirgrp = aio_group sub {
883 add $grp aio_rmdir $path, sub { 848 add $grp aio_rmdir $path, sub {
884 $grp->result ($_[0]); 849 $grp->result ($_[0]);
885 };
886 }; 850 };
887
888 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
889 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
890
891 add $grp $dirgrp;
892 }; 851 };
893 852
894 $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;
895 } 857 };
858
859 $grp
896} 860}
897 861
898=item aio_sync $callback->($status) 862=item aio_sync $callback->($status)
899 863
900Asynchronously call sync and call the callback when finished. 864Asynchronously call sync and call the callback when finished.
… …
909Asynchronously call fdatasync on the given filehandle and call the 873Asynchronously call fdatasync on the given filehandle and call the
910callback with the fdatasync result code. 874callback with the fdatasync result code.
911 875
912If 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
913detected, 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}
914 928
915=item aio_group $callback->(...) 929=item aio_group $callback->(...)
916 930
917This 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
918container 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
… …
1030Their lifetime, simplified, looks like this: when they are empty, they 1044Their lifetime, simplified, looks like this: when they are empty, they
1031will 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
1032C<done> state, they will also finish. Otherwise they will continue to 1046C<done> state, they will also finish. Otherwise they will continue to
1033exist. 1047exist.
1034 1048
1035That 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
1036in 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
1037group. 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
1038itself finish. 1052further requests to the group. And only when all those requests have
1053finished will the the group itself finish.
1039 1054
1040=over 4 1055=over 4
1041 1056
1042=item add $grp ... 1057=item add $grp ...
1043 1058
… …
1055itself. 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.
1056 1071
1057=item $grp->result (...) 1072=item $grp->result (...)
1058 1073
1059Set 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
1060subrequests have finished and set thre groups errno to the current value 1075subrequests have finished and set the groups errno to the current value
1061of 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,
1062no argument will be passed and errno is zero. 1077no argument will be passed and errno is zero.
1063 1078
1064=item $grp->errno ([$errno]) 1079=item $grp->errno ([$errno])
1065 1080
… …
1076=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
1077 1092
1078Sets 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
1079generator that generates requests if idle. The idea behind this is that, 1094generator that generates requests if idle. The idea behind this is that,
1080although 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,
1081this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
1082example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1083requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
1084 1099
1085To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
1086instead 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
1087feed 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>,
1088below) 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
… …
1092not impose any limits). 1107not impose any limits).
1093 1108
1094If 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
1095automatically removed from the group. 1110automatically removed from the group.
1096 1111
1097If 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.
1098 1114
1099Example: 1115Example:
1100 1116
1101 # 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:
1102 1118
… …
1114Sets 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
1115the group contains less than this many requests. 1131the group contains less than this many requests.
1116 1132
1117Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
1118 1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1137
1119=back 1138=back
1120 1139
1121=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
1122 1141
1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1142=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1134See C<poll_cb> for an example. 1153See C<poll_cb> for an example.
1135 1154
1136=item IO::AIO::poll_cb 1155=item IO::AIO::poll_cb
1137 1156
1138Process 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
1139regularly. 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
1140when no events are outstanding. The amount of events processed depends on 1160are outstanding. The amount of events processed depends on the settings of
1141the 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>.
1142 1162
1143If not all requests were processed for whatever reason, the filehandle 1163If not all requests were processed for whatever reason, the filehandle
1144will 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.
1145 1166
1146Example: Install an Event watcher that automatically calls 1167Example: Install an Event watcher that automatically calls
1147IO::AIO::poll_cb with high priority: 1168IO::AIO::poll_cb with high priority:
1148 1169
1149 Event->io (fd => IO::AIO::poll_fileno, 1170 Event->io (fd => IO::AIO::poll_fileno,
… …
1263 1284
1264The default is probably ok in most situations, especially if thread 1285The default is probably ok in most situations, especially if thread
1265creation 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
1266want to use larger values. 1287want to use larger values.
1267 1288
1268=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1289=item IO::AIO::max_outstanding $maxreqs
1269 1290
1270This 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
1271blocks, 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
1272use an C<aio_group> together with a feed callback. 1293use an C<aio_group> together with a feed callback.
1273 1294
… …
1278 1299
1279The 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
1280number of outstanding requests. 1301number of outstanding requests.
1281 1302
1282You can still queue as many requests as you want. Therefore, 1303You can still queue as many requests as you want. Therefore,
1283C<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
1284as 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).
1285 1306
1286=back 1307=back
1287 1308
1288=head3 STATISTICAL INFORMATION 1309=head3 STATISTICAL INFORMATION
… …
1358 1379
1359Known bugs will be fixed in the next release. 1380Known bugs will be fixed in the next release.
1360 1381
1361=head1 SEE ALSO 1382=head1 SEE ALSO
1362 1383
1363L<Coro::AIO>. 1384L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1385more natural syntax.
1364 1386
1365=head1 AUTHOR 1387=head1 AUTHOR
1366 1388
1367 Marc Lehmann <schmorp@schmorp.de> 1389 Marc Lehmann <schmorp@schmorp.de>
1368 http://home.schmorp.de/ 1390 http://home.schmorp.de/

Diff Legend

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