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.145 by root, Sun Apr 19 19:20:10 2009 UTC

… …
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, 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.18';
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).
392 347
393If C<$offset> is undefined, then the current file descriptor offset will 348If C<$offset> is undefined, then the current file descriptor offset will
394be used (and updated), otherwise the file descriptor offset will not be 349be used (and updated), otherwise the file descriptor offset will not be
395changed by these calls. 350changed by these calls.
396 351
397If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 352If C<$length> is undefined in C<aio_write>, use the remaining length of
353C<$data>.
398 354
399If C<$dataoffset> is less than zero, it will be counted from the end of 355If C<$dataoffset> is less than zero, it will be counted from the end of
400C<$data>. 356C<$data>.
401 357
402The C<$data> scalar I<MUST NOT> be modified in any way while the request 358The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
586memory. Status is the same as with aio_read. 542memory. Status is the same as with aio_read.
587 543
588=cut 544=cut
589 545
590sub aio_load($$;$) { 546sub aio_load($$;$) {
591 aio_block {
592 my ($path, undef, $cb) = @_; 547 my ($path, undef, $cb) = @_;
593 my $data = \$_[1]; 548 my $data = \$_[1];
594 549
595 my $pri = aioreq_pri; 550 my $pri = aioreq_pri;
596 my $grp = aio_group $cb; 551 my $grp = aio_group $cb;
552
553 aioreq_pri $pri;
554 add $grp aio_open $path, O_RDONLY, 0, sub {
555 my $fh = shift
556 or return $grp->result (-1);
597 557
598 aioreq_pri $pri; 558 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 { 559 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
605 $grp->result ($_[0]); 560 $grp->result ($_[0]);
606 };
607 }; 561 };
608
609 $grp
610 } 562 };
563
564 $grp
611} 565}
612 566
613=item aio_copy $srcpath, $dstpath, $callback->($status) 567=item aio_copy $srcpath, $dstpath, $callback->($status)
614 568
615Try to copy the I<file> (directories not supported as either source or 569Try to copy the I<file> (directories not supported as either source or
616destination) from C<$srcpath> to C<$dstpath> and call the callback with 570destination) from C<$srcpath> to C<$dstpath> and call the callback with
617the C<0> (error) or C<-1> ok. 571the C<0> (error) or C<-1> ok.
618 572
619This is a composite request that it creates the destination file with 573This is a composite request that creates the destination file with
620mode 0200 and copies the contents of the source file into it using 574mode 0200 and copies the contents of the source file into it using
621C<aio_sendfile>, followed by restoring atime, mtime, access mode and 575C<aio_sendfile>, followed by restoring atime, mtime, access mode and
622uid/gid, in that order. 576uid/gid, in that order.
623 577
624If an error occurs, the partial destination file will be unlinked, if 578If an error occurs, the partial destination file will be unlinked, if
… …
626errors are being ignored. 580errors are being ignored.
627 581
628=cut 582=cut
629 583
630sub aio_copy($$;$) { 584sub aio_copy($$;$) {
631 aio_block {
632 my ($src, $dst, $cb) = @_; 585 my ($src, $dst, $cb) = @_;
633 586
634 my $pri = aioreq_pri; 587 my $pri = aioreq_pri;
635 my $grp = aio_group $cb; 588 my $grp = aio_group $cb;
636 589
637 aioreq_pri $pri; 590 aioreq_pri $pri;
638 add $grp aio_open $src, O_RDONLY, 0, sub { 591 add $grp aio_open $src, O_RDONLY, 0, sub {
639 if (my $src_fh = $_[0]) { 592 if (my $src_fh = $_[0]) {
640 my @stat = stat $src_fh; 593 my @stat = stat $src_fh;
641 594
642 aioreq_pri $pri; 595 aioreq_pri $pri;
643 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 596 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
644 if (my $dst_fh = $_[0]) { 597 if (my $dst_fh = $_[0]) {
645 aioreq_pri $pri; 598 aioreq_pri $pri;
646 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 599 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
647 if ($_[0] == $stat[7]) { 600 if ($_[0] == $stat[7]) {
648 $grp->result (0); 601 $grp->result (0);
649 close $src_fh; 602 close $src_fh;
650 603
651 # those should not normally block. should. should. 604 # those should not normally block. should. should.
652 utime $stat[8], $stat[9], $dst; 605 utime $stat[8], $stat[9], $dst;
653 chmod $stat[2] & 07777, $dst_fh; 606 chmod $stat[2] & 07777, $dst_fh;
654 chown $stat[4], $stat[5], $dst_fh; 607 chown $stat[4], $stat[5], $dst_fh;
608
609 aioreq_pri $pri;
655 close $dst_fh; 610 add $grp aio_close $dst_fh;
656 } else { 611 } else {
657 $grp->result (-1); 612 $grp->result (-1);
658 close $src_fh; 613 close $src_fh;
659 close $dst_fh; 614 close $dst_fh;
660 615
661 aioreq $pri; 616 aioreq $pri;
662 add $grp aio_unlink $dst; 617 add $grp aio_unlink $dst;
663 }
664 }; 618 }
665 } else {
666 $grp->result (-1);
667 } 619 };
620 } else {
621 $grp->result (-1);
668 }, 622 }
669
670 } else {
671 $grp->result (-1);
672 } 623 },
624
625 } else {
626 $grp->result (-1);
673 }; 627 }
674
675 $grp
676 } 628 };
629
630 $grp
677} 631}
678 632
679=item aio_move $srcpath, $dstpath, $callback->($status) 633=item aio_move $srcpath, $dstpath, $callback->($status)
680 634
681Try to move the I<file> (directories not supported as either source or 635Try to move the I<file> (directories not supported as either source or
682destination) from C<$srcpath> to C<$dstpath> and call the callback with 636destination) from C<$srcpath> to C<$dstpath> and call the callback with
683the C<0> (error) or C<-1> ok. 637the C<0> (error) or C<-1> ok.
684 638
685This is a composite request that tries to rename(2) the file first. If 639This is a composite request that tries to rename(2) the file first; if
686rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 640rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
687that is successful, unlinking the C<$srcpath>. 641that is successful, unlinks the C<$srcpath>.
688 642
689=cut 643=cut
690 644
691sub aio_move($$;$) { 645sub aio_move($$;$) {
692 aio_block {
693 my ($src, $dst, $cb) = @_; 646 my ($src, $dst, $cb) = @_;
694 647
695 my $pri = aioreq_pri; 648 my $pri = aioreq_pri;
696 my $grp = aio_group $cb; 649 my $grp = aio_group $cb;
697 650
698 aioreq_pri $pri; 651 aioreq_pri $pri;
699 add $grp aio_rename $src, $dst, sub { 652 add $grp aio_rename $src, $dst, sub {
700 if ($_[0] && $! == EXDEV) { 653 if ($_[0] && $! == EXDEV) {
701 aioreq_pri $pri; 654 aioreq_pri $pri;
702 add $grp aio_copy $src, $dst, sub { 655 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]); 656 $grp->result ($_[0]);
657
658 if (!$_[0]) {
659 aioreq_pri $pri;
660 add $grp aio_unlink $src;
661 }
712 } 662 };
663 } else {
664 $grp->result ($_[0]);
713 }; 665 }
714
715 $grp
716 } 666 };
667
668 $grp
717} 669}
718 670
719=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 671=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
720 672
721Scans a directory (similar to C<aio_readdir>) but additionally tries to 673Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
769directory counting heuristic. 721directory counting heuristic.
770 722
771=cut 723=cut
772 724
773sub aio_scandir($$;$) { 725sub aio_scandir($$;$) {
774 aio_block {
775 my ($path, $maxreq, $cb) = @_; 726 my ($path, $maxreq, $cb) = @_;
776 727
777 my $pri = aioreq_pri; 728 my $pri = aioreq_pri;
778 729
779 my $grp = aio_group $cb; 730 my $grp = aio_group $cb;
780 731
781 $maxreq = 4 if $maxreq <= 0; 732 $maxreq = 4 if $maxreq <= 0;
782 733
783 # stat once 734 # stat once
735 aioreq_pri $pri;
736 add $grp aio_stat $path, sub {
737 return $grp->result () if $_[0];
738 my $now = time;
739 my $hash1 = join ":", (stat _)[0,1,3,7,9];
740
741 # read the directory entries
784 aioreq_pri $pri; 742 aioreq_pri $pri;
785 add $grp aio_stat $path, sub { 743 add $grp aio_readdir $path, sub {
744 my $entries = shift
786 return $grp->result () if $_[0]; 745 or return $grp->result ();
787 my $now = time;
788 my $hash1 = join ":", (stat _)[0,1,3,7,9];
789 746
790 # read the directory entries 747 # stat the dir another time
791 aioreq_pri $pri; 748 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 { 749 add $grp aio_stat $path, sub {
799 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 750 my $hash2 = join ":", (stat _)[0,1,3,7,9];
800 751
801 my $ndirs; 752 my $ndirs;
802 753
803 # take the slow route if anything looks fishy 754 # take the slow route if anything looks fishy
804 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 755 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
805 $ndirs = -1; 756 $ndirs = -1;
806 } else { 757 } else {
807 # if nlink == 2, we are finished 758 # if nlink == 2, we are finished
808 # on non-posix-fs's, we rely on nlink < 2 759 # on non-posix-fs's, we rely on nlink < 2
809 $ndirs = (stat _)[3] - 2 760 $ndirs = (stat _)[3] - 2
810 or return $grp->result ([], $entries); 761 or return $grp->result ([], $entries);
811 } 762 }
812 763
813 # sort into likely dirs and likely nondirs 764 # sort into likely dirs and likely nondirs
814 # dirs == files without ".", short entries first 765 # dirs == files without ".", short entries first
815 $entries = [map $_->[0], 766 $entries = [map $_->[0],
816 sort { $b->[1] cmp $a->[1] } 767 sort { $b->[1] cmp $a->[1] }
817 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 768 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
818 @$entries]; 769 @$entries];
819 770
820 my (@dirs, @nondirs); 771 my (@dirs, @nondirs);
821 772
822 my $statgrp = add $grp aio_group sub { 773 my $statgrp = add $grp aio_group sub {
823 $grp->result (\@dirs, \@nondirs); 774 $grp->result (\@dirs, \@nondirs);
824 }; 775 };
825 776
826 limit $statgrp $maxreq; 777 limit $statgrp $maxreq;
827 feed $statgrp sub { 778 feed $statgrp sub {
828 return unless @$entries; 779 return unless @$entries;
829 my $entry = pop @$entries; 780 my $entry = pop @$entries;
830 781
831 aioreq_pri $pri; 782 aioreq_pri $pri;
832 add $statgrp aio_stat "$path/$entry/.", sub { 783 add $statgrp aio_stat "$path/$entry/.", sub {
833 if ($_[0] < 0) { 784 if ($_[0] < 0) {
834 push @nondirs, $entry; 785 push @nondirs, $entry;
835 } else { 786 } else {
836 # need to check for real directory 787 # need to check for real directory
837 aioreq_pri $pri; 788 aioreq_pri $pri;
838 add $statgrp aio_lstat "$path/$entry", sub { 789 add $statgrp aio_lstat "$path/$entry", sub {
839 if (-d _) { 790 if (-d _) {
840 push @dirs, $entry; 791 push @dirs, $entry;
841 792
842 unless (--$ndirs) { 793 unless (--$ndirs) {
843 push @nondirs, @$entries; 794 push @nondirs, @$entries;
844 feed $statgrp; 795 feed $statgrp;
845 }
846 } else {
847 push @nondirs, $entry;
848 } 796 }
797 } else {
798 push @nondirs, $entry;
849 } 799 }
850 } 800 }
851 }; 801 }
852 }; 802 };
853 }; 803 };
854 }; 804 };
855 }; 805 };
856
857 $grp
858 } 806 };
807
808 $grp
859} 809}
860 810
861=item aio_rmtree $path, $callback->($status) 811=item aio_rmtree $path, $callback->($status)
862 812
863Delete a directory tree starting (and including) C<$path>, return the 813Delete a directory tree starting (and including) C<$path>, return the
… …
867 817
868=cut 818=cut
869 819
870sub aio_rmtree; 820sub aio_rmtree;
871sub aio_rmtree($;$) { 821sub aio_rmtree($;$) {
872 aio_block {
873 my ($path, $cb) = @_; 822 my ($path, $cb) = @_;
874 823
875 my $pri = aioreq_pri; 824 my $pri = aioreq_pri;
876 my $grp = aio_group $cb; 825 my $grp = aio_group $cb;
877 826
878 aioreq_pri $pri; 827 aioreq_pri $pri;
879 add $grp aio_scandir $path, 0, sub { 828 add $grp aio_scandir $path, 0, sub {
880 my ($dirs, $nondirs) = @_; 829 my ($dirs, $nondirs) = @_;
881 830
882 my $dirgrp = aio_group sub { 831 my $dirgrp = aio_group sub {
883 add $grp aio_rmdir $path, sub { 832 add $grp aio_rmdir $path, sub {
884 $grp->result ($_[0]); 833 $grp->result ($_[0]);
885 };
886 }; 834 };
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 }; 835 };
893 836
894 $grp 837 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
838 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
839
840 add $grp $dirgrp;
895 } 841 };
842
843 $grp
896} 844}
897 845
898=item aio_sync $callback->($status) 846=item aio_sync $callback->($status)
899 847
900Asynchronously call sync and call the callback when finished. 848Asynchronously call sync and call the callback when finished.
… …
909Asynchronously call fdatasync on the given filehandle and call the 857Asynchronously call fdatasync on the given filehandle and call the
910callback with the fdatasync result code. 858callback with the fdatasync result code.
911 859
912If this call isn't available because your OS lacks it or it couldn't be 860If this call isn't available because your OS lacks it or it couldn't be
913detected, it will be emulated by calling C<fsync> instead. 861detected, it will be emulated by calling C<fsync> instead.
862
863=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
864
865Sync the data portion of the file specified by C<$offset> and C<$length>
866to disk (but NOT the metadata), by calling the Linux-specific
867sync_file_range call. If sync_file_range is not available or it returns
868ENOSYS, then fdatasync or fsync is being substituted.
869
870C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
871C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
872C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
873manpage for details.
874
875=item aio_pathsync $path, $callback->($status)
876
877This request tries to open, fsync and close the given path. This is a
878composite request intended to sync directories after directory operations
879(E.g. rename). This might not work on all operating systems or have any
880specific effect, but usually it makes sure that directory changes get
881written to disc. It works for anything that can be opened for read-only,
882not just directories.
883
884Passes C<0> when everything went ok, and C<-1> on error.
885
886=cut
887
888sub aio_pathsync($;$) {
889 my ($path, $cb) = @_;
890
891 my $pri = aioreq_pri;
892 my $grp = aio_group $cb;
893
894 aioreq_pri $pri;
895 add $grp aio_open $path, O_RDONLY, 0, sub {
896 my ($fh) = @_;
897 if ($fh) {
898 aioreq_pri $pri;
899 add $grp aio_fsync $fh, sub {
900 $grp->result ($_[0]);
901
902 aioreq_pri $pri;
903 add $grp aio_close $fh;
904 };
905 } else {
906 $grp->result (-1);
907 }
908 };
909
910 $grp
911}
914 912
915=item aio_group $callback->(...) 913=item aio_group $callback->(...)
916 914
917This is a very special aio request: Instead of doing something, it is a 915This is a very special aio request: Instead of doing something, it is a
918container for other aio requests, which is useful if you want to bundle 916container for other aio requests, which is useful if you want to bundle
… …
1030Their lifetime, simplified, looks like this: when they are empty, they 1028Their lifetime, simplified, looks like this: when they are empty, they
1031will finish very quickly. If they contain only requests that are in the 1029will finish very quickly. If they contain only requests that are in the
1032C<done> state, they will also finish. Otherwise they will continue to 1030C<done> state, they will also finish. Otherwise they will continue to
1033exist. 1031exist.
1034 1032
1035That means after creating a group you have some time to add requests. And 1033That means after creating a group you have some time to add requests
1036in the callbacks of those requests, you can add further requests to the 1034(precisely before the callback has been invoked, which is only done within
1037group. And only when all those requests have finished will the the group 1035the C<poll_cb>). And in the callbacks of those requests, you can add
1038itself finish. 1036further requests to the group. And only when all those requests have
1037finished will the the group itself finish.
1039 1038
1040=over 4 1039=over 4
1041 1040
1042=item add $grp ... 1041=item add $grp ...
1043 1042
… …
1055itself. Useful when you queued a lot of events but got a result early. 1054itself. Useful when you queued a lot of events but got a result early.
1056 1055
1057=item $grp->result (...) 1056=item $grp->result (...)
1058 1057
1059Set the result value(s) that will be passed to the group callback when all 1058Set the result value(s) that will be passed to the group callback when all
1060subrequests have finished and set thre groups errno to the current value 1059subrequests have finished and set the groups errno to the current value
1061of errno (just like calling C<errno> without an error number). By default, 1060of errno (just like calling C<errno> without an error number). By default,
1062no argument will be passed and errno is zero. 1061no argument will be passed and errno is zero.
1063 1062
1064=item $grp->errno ([$errno]) 1063=item $grp->errno ([$errno])
1065 1064
… …
1076=item feed $grp $callback->($grp) 1075=item feed $grp $callback->($grp)
1077 1076
1078Sets a feeder/generator on this group: every group can have an attached 1077Sets a feeder/generator on this group: every group can have an attached
1079generator that generates requests if idle. The idea behind this is that, 1078generator 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, 1079although you could just queue as many requests as you want in a group,
1081this might starve other requests for a potentially long time. For 1080this might starve other requests for a potentially long time. For example,
1082example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1081C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1083requests, delaying any later requests for a long time. 1082delaying any later requests for a long time.
1084 1083
1085To avoid this, and allow incremental generation of requests, you can 1084To avoid this, and allow incremental generation of requests, you can
1086instead a group and set a feeder on it that generates those requests. The 1085instead a group and set a feeder on it that generates those requests. The
1087feed callback will be called whenever there are few enough (see C<limit>, 1086feed callback will be called whenever there are few enough (see C<limit>,
1088below) requests active in the group itself and is expected to queue more 1087below) requests active in the group itself and is expected to queue more
… …
1092not impose any limits). 1091not impose any limits).
1093 1092
1094If the feed does not queue more requests when called, it will be 1093If the feed does not queue more requests when called, it will be
1095automatically removed from the group. 1094automatically removed from the group.
1096 1095
1097If the feed limit is C<0>, it will be set to C<2> automatically. 1096If the feed limit is C<0> when this method is called, it will be set to
1097C<2> automatically.
1098 1098
1099Example: 1099Example:
1100 1100
1101 # stat all files in @files, but only ever use four aio requests concurrently: 1101 # stat all files in @files, but only ever use four aio requests concurrently:
1102 1102
… …
1114Sets the feeder limit for the group: The feeder will be called whenever 1114Sets the feeder limit for the group: The feeder will be called whenever
1115the group contains less than this many requests. 1115the group contains less than this many requests.
1116 1116
1117Setting the limit to C<0> will pause the feeding process. 1117Setting the limit to C<0> will pause the feeding process.
1118 1118
1119The default value for the limit is C<0>, but note that setting a feeder
1120automatically bumps it up to C<2>.
1121
1119=back 1122=back
1120 1123
1121=head2 SUPPORT FUNCTIONS 1124=head2 SUPPORT FUNCTIONS
1122 1125
1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1126=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1134See C<poll_cb> for an example. 1137See C<poll_cb> for an example.
1135 1138
1136=item IO::AIO::poll_cb 1139=item IO::AIO::poll_cb
1137 1140
1138Process some outstanding events on the result pipe. You have to call this 1141Process some outstanding events on the result pipe. You have to call this
1139regularly. Returns the number of events processed. Returns immediately 1142regularly. Returns C<0> if all events could be processed, or C<-1> if it
1143returned earlier for whatever reason. Returns immediately when no events
1140when no events are outstanding. The amount of events processed depends on 1144are 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>. 1145C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1142 1146
1143If not all requests were processed for whatever reason, the filehandle 1147If not all requests were processed for whatever reason, the filehandle
1144will still be ready when C<poll_cb> returns. 1148will still be ready when C<poll_cb> returns, so normally you don't have to
1149do anything special to have it called later.
1145 1150
1146Example: Install an Event watcher that automatically calls 1151Example: Install an Event watcher that automatically calls
1147IO::AIO::poll_cb with high priority: 1152IO::AIO::poll_cb with high priority:
1148 1153
1149 Event->io (fd => IO::AIO::poll_fileno, 1154 Event->io (fd => IO::AIO::poll_fileno,
… …
1263 1268
1264The default is probably ok in most situations, especially if thread 1269The default is probably ok in most situations, especially if thread
1265creation is fast. If thread creation is very slow on your system you might 1270creation is fast. If thread creation is very slow on your system you might
1266want to use larger values. 1271want to use larger values.
1267 1272
1268=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1273=item IO::AIO::max_outstanding $maxreqs
1269 1274
1270This is a very bad function to use in interactive programs because it 1275This is a very bad function to use in interactive programs because it
1271blocks, and a bad way to reduce concurrency because it is inexact: Better 1276blocks, and a bad way to reduce concurrency because it is inexact: Better
1272use an C<aio_group> together with a feed callback. 1277use an C<aio_group> together with a feed callback.
1273 1278
… …
1278 1283
1279The default value is very large, so there is no practical limit on the 1284The default value is very large, so there is no practical limit on the
1280number of outstanding requests. 1285number of outstanding requests.
1281 1286
1282You can still queue as many requests as you want. Therefore, 1287You can still queue as many requests as you want. Therefore,
1283C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1288C<max_outstanding> is mainly useful in simple scripts (with low values) or
1284as a stop gap to shield against fatal memory overflow (with large values). 1289as a stop gap to shield against fatal memory overflow (with large values).
1285 1290
1286=back 1291=back
1287 1292
1288=head3 STATISTICAL INFORMATION 1293=head3 STATISTICAL INFORMATION
… …
1358 1363
1359Known bugs will be fixed in the next release. 1364Known bugs will be fixed in the next release.
1360 1365
1361=head1 SEE ALSO 1366=head1 SEE ALSO
1362 1367
1363L<Coro::AIO>. 1368L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1369more natural syntax.
1364 1370
1365=head1 AUTHOR 1371=head1 AUTHOR
1366 1372
1367 Marc Lehmann <schmorp@schmorp.de> 1373 Marc Lehmann <schmorp@schmorp.de>
1368 http://home.schmorp.de/ 1374 http://home.schmorp.de/

Diff Legend

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