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

Diff Legend

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