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.115 by root, Mon Sep 24 18:14:00 2007 UTC vs.
Revision 1.146 by root, Tue Apr 21 20:06:05 2009 UTC

… …
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
31 # AnyEvent integration 34 # EV integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 36
35 # Event integration 37 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 39 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
… …
183 185
184=cut 186=cut
185 187
186package IO::AIO; 188package IO::AIO;
187 189
190use Carp ();
191
188no warnings; 192no warnings;
189use strict 'vars'; 193use strict 'vars';
190 194
191use base 'Exporter'; 195use base 'Exporter';
192 196
193BEGIN { 197BEGIN {
194 our $VERSION = '2.41'; 198 our $VERSION = '3.19';
195 199
196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group
199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir 205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200 aio_chown aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 211 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
206 215
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208 217
209 require XSLoader; 218 require XSLoader;
210 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
217All the C<aio_*> calls are more or less thin wrappers around the syscall 226All the C<aio_*> calls are more or less thin wrappers around the syscall
218with the same name (sans C<aio_>). The arguments are similar or identical, 227with the same name (sans C<aio_>). The arguments are similar or identical,
219and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
220which must be a code reference. This code reference will get called with 229which must be a code reference. This code reference will get called with
221the syscall return code (e.g. most syscalls return C<-1> on error, unlike 230the syscall return code (e.g. most syscalls return C<-1> on error, unlike
222perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 232syscall has been executed asynchronously.
224 233
225All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 235internally until the request has finished.
227 236
… …
241your pathnames to the locale (or other) encoding in effect in the user 250your pathnames to the locale (or other) encoding in effect in the user
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
244 253
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO 254This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not. 255handles correctly whether it is set or not.
247 256
248=over 4 257=over 4
249 258
250=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
251 260
… …
311 320
312 321
313=item aio_close $fh, $callback->($status) 322=item aio_close $fh, $callback->($status)
314 323
315Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
316code. I<WARNING:> although accepted, you should not pass in a perl 325code.
317filehandle here, as perl will likely close the file descriptor another
318time when the filehandle is destroyed. Normally, you can safely call perls
319C<close> or just let filehandles go out of scope.
320 326
321This is supposed to be a bug in the API, so that might change. It's 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 328closing the file descriptor associated with the filehandle itself.
323 329
330Therefore, C<aio_close> will not close the filehandle - instead it will
331use dup2 to overwrite the file descriptor with the write-end of a pipe
332(the pipe fd will be created on demand and will be cached).
333
334Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed.
336
337=cut
324 338
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 340
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 342
329Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
330into the scalar given by C<$data> and offset C<$dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
331callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
332like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
333 350
334If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
335be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
336changed by these calls. 353changed by these calls.
337 354
338If 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>.
339 357
340If 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
341C<$data>. 359C<$data>.
342 360
343The 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
… …
527memory. Status is the same as with aio_read. 545memory. Status is the same as with aio_read.
528 546
529=cut 547=cut
530 548
531sub aio_load($$;$) { 549sub aio_load($$;$) {
532 aio_block {
533 my ($path, undef, $cb) = @_; 550 my ($path, undef, $cb) = @_;
534 my $data = \$_[1]; 551 my $data = \$_[1];
535 552
536 my $pri = aioreq_pri; 553 my $pri = aioreq_pri;
537 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);
538 560
539 aioreq_pri $pri; 561 aioreq_pri $pri;
540 add $grp aio_open $path, O_RDONLY, 0, sub {
541 my $fh = shift
542 or return $grp->result (-1);
543
544 aioreq_pri $pri;
545 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
546 $grp->result ($_[0]); 563 $grp->result ($_[0]);
547 };
548 }; 564 };
549
550 $grp
551 } 565 };
566
567 $grp
552} 568}
553 569
554=item aio_copy $srcpath, $dstpath, $callback->($status) 570=item aio_copy $srcpath, $dstpath, $callback->($status)
555 571
556Try 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
557destination) from C<$srcpath> to C<$dstpath> and call the callback with 573destination) from C<$srcpath> to C<$dstpath> and call the callback with
558the C<0> (error) or C<-1> ok. 574the C<0> (error) or C<-1> ok.
559 575
560This is a composite request that it creates the destination file with 576This is a composite request that creates the destination file with
561mode 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
562C<aio_sendfile>, followed by restoring atime, mtime, access mode and 578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
563uid/gid, in that order. 579uid/gid, in that order.
564 580
565If an error occurs, the partial destination file will be unlinked, if 581If an error occurs, the partial destination file will be unlinked, if
… …
567errors are being ignored. 583errors are being ignored.
568 584
569=cut 585=cut
570 586
571sub aio_copy($$;$) { 587sub aio_copy($$;$) {
572 aio_block {
573 my ($src, $dst, $cb) = @_; 588 my ($src, $dst, $cb) = @_;
574 589
575 my $pri = aioreq_pri; 590 my $pri = aioreq_pri;
576 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
577 592
578 aioreq_pri $pri; 593 aioreq_pri $pri;
579 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
580 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
581 my @stat = stat $src_fh; 596 my @stat = stat $src_fh;
582 597
583 aioreq_pri $pri; 598 aioreq_pri $pri;
584 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 {
585 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
586 aioreq_pri $pri; 601 aioreq_pri $pri;
587 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 {
588 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
589 $grp->result (0); 604 $grp->result (0);
590 close $src_fh; 605 close $src_fh;
591 606
592 # those should not normally block. should. should. 607 # those should not normally block. should. should.
593 utime $stat[8], $stat[9], $dst; 608 utime $stat[8], $stat[9], $dst;
594 chmod $stat[2] & 07777, $dst_fh; 609 chmod $stat[2] & 07777, $dst_fh;
595 chown $stat[4], $stat[5], $dst_fh; 610 chown $stat[4], $stat[5], $dst_fh;
611
612 aioreq_pri $pri;
596 close $dst_fh; 613 add $grp aio_close $dst_fh;
597 } else { 614 } else {
598 $grp->result (-1); 615 $grp->result (-1);
599 close $src_fh; 616 close $src_fh;
600 close $dst_fh; 617 close $dst_fh;
601 618
602 aioreq $pri; 619 aioreq $pri;
603 add $grp aio_unlink $dst; 620 add $grp aio_unlink $dst;
604 }
605 }; 621 }
606 } else {
607 $grp->result (-1);
608 } 622 };
623 } else {
624 $grp->result (-1);
609 }, 625 }
610
611 } else {
612 $grp->result (-1);
613 } 626 },
627
628 } else {
629 $grp->result (-1);
614 }; 630 }
615
616 $grp
617 } 631 };
632
633 $grp
618} 634}
619 635
620=item aio_move $srcpath, $dstpath, $callback->($status) 636=item aio_move $srcpath, $dstpath, $callback->($status)
621 637
622Try to move the I<file> (directories not supported as either source or 638Try to move the I<file> (directories not supported as either source or
623destination) from C<$srcpath> to C<$dstpath> and call the callback with 639destination) from C<$srcpath> to C<$dstpath> and call the callback with
624the C<0> (error) or C<-1> ok. 640the C<0> (error) or C<-1> ok.
625 641
626This is a composite request that tries to rename(2) the file first. If 642This is a composite request that tries to rename(2) the file first; if
627rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 643rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
628that is successful, unlinking the C<$srcpath>. 644that is successful, unlinks the C<$srcpath>.
629 645
630=cut 646=cut
631 647
632sub aio_move($$;$) { 648sub aio_move($$;$) {
633 aio_block {
634 my ($src, $dst, $cb) = @_; 649 my ($src, $dst, $cb) = @_;
635 650
636 my $pri = aioreq_pri; 651 my $pri = aioreq_pri;
637 my $grp = aio_group $cb; 652 my $grp = aio_group $cb;
638 653
639 aioreq_pri $pri; 654 aioreq_pri $pri;
640 add $grp aio_rename $src, $dst, sub { 655 add $grp aio_rename $src, $dst, sub {
641 if ($_[0] && $! == EXDEV) { 656 if ($_[0] && $! == EXDEV) {
642 aioreq_pri $pri; 657 aioreq_pri $pri;
643 add $grp aio_copy $src, $dst, sub { 658 add $grp aio_copy $src, $dst, sub {
644 $grp->result ($_[0]);
645
646 if (!$_[0]) {
647 aioreq_pri $pri;
648 add $grp aio_unlink $src;
649 }
650 };
651 } else {
652 $grp->result ($_[0]); 659 $grp->result ($_[0]);
660
661 if (!$_[0]) {
662 aioreq_pri $pri;
663 add $grp aio_unlink $src;
664 }
653 } 665 };
666 } else {
667 $grp->result ($_[0]);
654 }; 668 }
655
656 $grp
657 } 669 };
670
671 $grp
658} 672}
659 673
660=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 674=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
661 675
662Scans a directory (similar to C<aio_readdir>) but additionally tries to 676Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
710directory counting heuristic. 724directory counting heuristic.
711 725
712=cut 726=cut
713 727
714sub aio_scandir($$;$) { 728sub aio_scandir($$;$) {
715 aio_block {
716 my ($path, $maxreq, $cb) = @_; 729 my ($path, $maxreq, $cb) = @_;
717 730
718 my $pri = aioreq_pri; 731 my $pri = aioreq_pri;
719 732
720 my $grp = aio_group $cb; 733 my $grp = aio_group $cb;
721 734
722 $maxreq = 4 if $maxreq <= 0; 735 $maxreq = 4 if $maxreq <= 0;
723 736
724 # stat once 737 # stat once
738 aioreq_pri $pri;
739 add $grp aio_stat $path, sub {
740 return $grp->result () if $_[0];
741 my $now = time;
742 my $hash1 = join ":", (stat _)[0,1,3,7,9];
743
744 # read the directory entries
725 aioreq_pri $pri; 745 aioreq_pri $pri;
726 add $grp aio_stat $path, sub { 746 add $grp aio_readdir $path, sub {
747 my $entries = shift
727 return $grp->result () if $_[0]; 748 or return $grp->result ();
728 my $now = time;
729 my $hash1 = join ":", (stat _)[0,1,3,7,9];
730 749
731 # read the directory entries 750 # stat the dir another time
732 aioreq_pri $pri; 751 aioreq_pri $pri;
733 add $grp aio_readdir $path, sub {
734 my $entries = shift
735 or return $grp->result ();
736
737 # stat the dir another time
738 aioreq_pri $pri;
739 add $grp aio_stat $path, sub { 752 add $grp aio_stat $path, sub {
740 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 753 my $hash2 = join ":", (stat _)[0,1,3,7,9];
741 754
742 my $ndirs; 755 my $ndirs;
743 756
744 # take the slow route if anything looks fishy 757 # take the slow route if anything looks fishy
745 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 758 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
746 $ndirs = -1; 759 $ndirs = -1;
747 } else { 760 } else {
748 # if nlink == 2, we are finished 761 # if nlink == 2, we are finished
749 # on non-posix-fs's, we rely on nlink < 2 762 # on non-posix-fs's, we rely on nlink < 2
750 $ndirs = (stat _)[3] - 2 763 $ndirs = (stat _)[3] - 2
751 or return $grp->result ([], $entries); 764 or return $grp->result ([], $entries);
752 } 765 }
753 766
754 # sort into likely dirs and likely nondirs 767 # sort into likely dirs and likely nondirs
755 # dirs == files without ".", short entries first 768 # dirs == files without ".", short entries first
756 $entries = [map $_->[0], 769 $entries = [map $_->[0],
757 sort { $b->[1] cmp $a->[1] } 770 sort { $b->[1] cmp $a->[1] }
758 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 771 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
759 @$entries]; 772 @$entries];
760 773
761 my (@dirs, @nondirs); 774 my (@dirs, @nondirs);
762 775
763 my $statgrp = add $grp aio_group sub { 776 my $statgrp = add $grp aio_group sub {
764 $grp->result (\@dirs, \@nondirs); 777 $grp->result (\@dirs, \@nondirs);
765 }; 778 };
766 779
767 limit $statgrp $maxreq; 780 limit $statgrp $maxreq;
768 feed $statgrp sub { 781 feed $statgrp sub {
769 return unless @$entries; 782 return unless @$entries;
770 my $entry = pop @$entries; 783 my $entry = pop @$entries;
771 784
772 aioreq_pri $pri; 785 aioreq_pri $pri;
773 add $statgrp aio_stat "$path/$entry/.", sub { 786 add $statgrp aio_stat "$path/$entry/.", sub {
774 if ($_[0] < 0) { 787 if ($_[0] < 0) {
775 push @nondirs, $entry; 788 push @nondirs, $entry;
776 } else { 789 } else {
777 # need to check for real directory 790 # need to check for real directory
778 aioreq_pri $pri; 791 aioreq_pri $pri;
779 add $statgrp aio_lstat "$path/$entry", sub { 792 add $statgrp aio_lstat "$path/$entry", sub {
780 if (-d _) { 793 if (-d _) {
781 push @dirs, $entry; 794 push @dirs, $entry;
782 795
783 unless (--$ndirs) { 796 unless (--$ndirs) {
784 push @nondirs, @$entries; 797 push @nondirs, @$entries;
785 feed $statgrp; 798 feed $statgrp;
786 }
787 } else {
788 push @nondirs, $entry;
789 } 799 }
800 } else {
801 push @nondirs, $entry;
790 } 802 }
791 } 803 }
792 }; 804 }
793 }; 805 };
794 }; 806 };
795 }; 807 };
796 }; 808 };
797
798 $grp
799 } 809 };
810
811 $grp
800} 812}
801 813
802=item aio_rmtree $path, $callback->($status) 814=item aio_rmtree $path, $callback->($status)
803 815
804Delete a directory tree starting (and including) C<$path>, return the 816Delete a directory tree starting (and including) C<$path>, return the
… …
808 820
809=cut 821=cut
810 822
811sub aio_rmtree; 823sub aio_rmtree;
812sub aio_rmtree($;$) { 824sub aio_rmtree($;$) {
813 aio_block {
814 my ($path, $cb) = @_; 825 my ($path, $cb) = @_;
815 826
816 my $pri = aioreq_pri; 827 my $pri = aioreq_pri;
817 my $grp = aio_group $cb; 828 my $grp = aio_group $cb;
818 829
819 aioreq_pri $pri; 830 aioreq_pri $pri;
820 add $grp aio_scandir $path, 0, sub { 831 add $grp aio_scandir $path, 0, sub {
821 my ($dirs, $nondirs) = @_; 832 my ($dirs, $nondirs) = @_;
822 833
823 my $dirgrp = aio_group sub { 834 my $dirgrp = aio_group sub {
824 add $grp aio_rmdir $path, sub { 835 add $grp aio_rmdir $path, sub {
825 $grp->result ($_[0]); 836 $grp->result ($_[0]);
826 };
827 }; 837 };
828
829 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
830 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
831
832 add $grp $dirgrp;
833 }; 838 };
834 839
835 $grp 840 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
841 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
842
843 add $grp $dirgrp;
836 } 844 };
845
846 $grp
837} 847}
848
849=item aio_sync $callback->($status)
850
851Asynchronously call sync and call the callback when finished.
838 852
839=item aio_fsync $fh, $callback->($status) 853=item aio_fsync $fh, $callback->($status)
840 854
841Asynchronously call fsync on the given filehandle and call the callback 855Asynchronously call fsync on the given filehandle and call the callback
842with the fsync result code. 856with the fsync result code.
… …
846Asynchronously call fdatasync on the given filehandle and call the 860Asynchronously call fdatasync on the given filehandle and call the
847callback with the fdatasync result code. 861callback with the fdatasync result code.
848 862
849If this call isn't available because your OS lacks it or it couldn't be 863If this call isn't available because your OS lacks it or it couldn't be
850detected, it will be emulated by calling C<fsync> instead. 864detected, it will be emulated by calling C<fsync> instead.
865
866=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
867
868Sync the data portion of the file specified by C<$offset> and C<$length>
869to disk (but NOT the metadata), by calling the Linux-specific
870sync_file_range call. If sync_file_range is not available or it returns
871ENOSYS, then fdatasync or fsync is being substituted.
872
873C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
874C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
875C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
876manpage for details.
877
878=item aio_pathsync $path, $callback->($status)
879
880This request tries to open, fsync and close the given path. This is a
881composite request intended to sync directories after directory operations
882(E.g. rename). This might not work on all operating systems or have any
883specific effect, but usually it makes sure that directory changes get
884written to disc. It works for anything that can be opened for read-only,
885not just directories.
886
887Passes C<0> when everything went ok, and C<-1> on error.
888
889=cut
890
891sub aio_pathsync($;$) {
892 my ($path, $cb) = @_;
893
894 my $pri = aioreq_pri;
895 my $grp = aio_group $cb;
896
897 aioreq_pri $pri;
898 add $grp aio_open $path, O_RDONLY, 0, sub {
899 my ($fh) = @_;
900 if ($fh) {
901 aioreq_pri $pri;
902 add $grp aio_fsync $fh, sub {
903 $grp->result ($_[0]);
904
905 aioreq_pri $pri;
906 add $grp aio_close $fh;
907 };
908 } else {
909 $grp->result (-1);
910 }
911 };
912
913 $grp
914}
851 915
852=item aio_group $callback->(...) 916=item aio_group $callback->(...)
853 917
854This is a very special aio request: Instead of doing something, it is a 918This is a very special aio request: Instead of doing something, it is a
855container for other aio requests, which is useful if you want to bundle 919container for other aio requests, which is useful if you want to bundle
… …
967Their lifetime, simplified, looks like this: when they are empty, they 1031Their lifetime, simplified, looks like this: when they are empty, they
968will finish very quickly. If they contain only requests that are in the 1032will finish very quickly. If they contain only requests that are in the
969C<done> state, they will also finish. Otherwise they will continue to 1033C<done> state, they will also finish. Otherwise they will continue to
970exist. 1034exist.
971 1035
972That means after creating a group you have some time to add requests. And 1036That means after creating a group you have some time to add requests
973in the callbacks of those requests, you can add further requests to the 1037(precisely before the callback has been invoked, which is only done within
974group. And only when all those requests have finished will the the group 1038the C<poll_cb>). And in the callbacks of those requests, you can add
975itself finish. 1039further requests to the group. And only when all those requests have
1040finished will the the group itself finish.
976 1041
977=over 4 1042=over 4
978 1043
979=item add $grp ... 1044=item add $grp ...
980 1045
… …
992itself. Useful when you queued a lot of events but got a result early. 1057itself. Useful when you queued a lot of events but got a result early.
993 1058
994=item $grp->result (...) 1059=item $grp->result (...)
995 1060
996Set the result value(s) that will be passed to the group callback when all 1061Set the result value(s) that will be passed to the group callback when all
997subrequests have finished and set thre groups errno to the current value 1062subrequests have finished and set the groups errno to the current value
998of errno (just like calling C<errno> without an error number). By default, 1063of errno (just like calling C<errno> without an error number). By default,
999no argument will be passed and errno is zero. 1064no argument will be passed and errno is zero.
1000 1065
1001=item $grp->errno ([$errno]) 1066=item $grp->errno ([$errno])
1002 1067
… …
1013=item feed $grp $callback->($grp) 1078=item feed $grp $callback->($grp)
1014 1079
1015Sets a feeder/generator on this group: every group can have an attached 1080Sets a feeder/generator on this group: every group can have an attached
1016generator that generates requests if idle. The idea behind this is that, 1081generator that generates requests if idle. The idea behind this is that,
1017although you could just queue as many requests as you want in a group, 1082although you could just queue as many requests as you want in a group,
1018this might starve other requests for a potentially long time. For 1083this might starve other requests for a potentially long time. For example,
1019example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1084C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1020requests, delaying any later requests for a long time. 1085delaying any later requests for a long time.
1021 1086
1022To avoid this, and allow incremental generation of requests, you can 1087To avoid this, and allow incremental generation of requests, you can
1023instead a group and set a feeder on it that generates those requests. The 1088instead a group and set a feeder on it that generates those requests. The
1024feed callback will be called whenever there are few enough (see C<limit>, 1089feed callback will be called whenever there are few enough (see C<limit>,
1025below) requests active in the group itself and is expected to queue more 1090below) requests active in the group itself and is expected to queue more
… …
1029not impose any limits). 1094not impose any limits).
1030 1095
1031If the feed does not queue more requests when called, it will be 1096If the feed does not queue more requests when called, it will be
1032automatically removed from the group. 1097automatically removed from the group.
1033 1098
1034If the feed limit is C<0>, it will be set to C<2> automatically. 1099If the feed limit is C<0> when this method is called, it will be set to
1100C<2> automatically.
1035 1101
1036Example: 1102Example:
1037 1103
1038 # stat all files in @files, but only ever use four aio requests concurrently: 1104 # stat all files in @files, but only ever use four aio requests concurrently:
1039 1105
… …
1051Sets the feeder limit for the group: The feeder will be called whenever 1117Sets the feeder limit for the group: The feeder will be called whenever
1052the group contains less than this many requests. 1118the group contains less than this many requests.
1053 1119
1054Setting the limit to C<0> will pause the feeding process. 1120Setting the limit to C<0> will pause the feeding process.
1055 1121
1122The default value for the limit is C<0>, but note that setting a feeder
1123automatically bumps it up to C<2>.
1124
1056=back 1125=back
1057 1126
1058=head2 SUPPORT FUNCTIONS 1127=head2 SUPPORT FUNCTIONS
1059 1128
1060=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1129=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1071See C<poll_cb> for an example. 1140See C<poll_cb> for an example.
1072 1141
1073=item IO::AIO::poll_cb 1142=item IO::AIO::poll_cb
1074 1143
1075Process some outstanding events on the result pipe. You have to call this 1144Process some outstanding events on the result pipe. You have to call this
1076regularly. Returns the number of events processed. Returns immediately 1145regularly. Returns C<0> if all events could be processed, or C<-1> if it
1146returned earlier for whatever reason. Returns immediately when no events
1077when no events are outstanding. The amount of events processed depends on 1147are outstanding. The amount of events processed depends on the settings of
1078the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1148C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1079 1149
1080If not all requests were processed for whatever reason, the filehandle 1150If not all requests were processed for whatever reason, the filehandle
1081will still be ready when C<poll_cb> returns. 1151will still be ready when C<poll_cb> returns, so normally you don't have to
1152do anything special to have it called later.
1082 1153
1083Example: Install an Event watcher that automatically calls 1154Example: Install an Event watcher that automatically calls
1084IO::AIO::poll_cb with high priority: 1155IO::AIO::poll_cb with high priority:
1085 1156
1086 Event->io (fd => IO::AIO::poll_fileno, 1157 Event->io (fd => IO::AIO::poll_fileno,
… …
1200 1271
1201The default is probably ok in most situations, especially if thread 1272The default is probably ok in most situations, especially if thread
1202creation is fast. If thread creation is very slow on your system you might 1273creation is fast. If thread creation is very slow on your system you might
1203want to use larger values. 1274want to use larger values.
1204 1275
1205=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1276=item IO::AIO::max_outstanding $maxreqs
1206 1277
1207This is a very bad function to use in interactive programs because it 1278This is a very bad function to use in interactive programs because it
1208blocks, and a bad way to reduce concurrency because it is inexact: Better 1279blocks, and a bad way to reduce concurrency because it is inexact: Better
1209use an C<aio_group> together with a feed callback. 1280use an C<aio_group> together with a feed callback.
1210 1281
… …
1215 1286
1216The default value is very large, so there is no practical limit on the 1287The default value is very large, so there is no practical limit on the
1217number of outstanding requests. 1288number of outstanding requests.
1218 1289
1219You can still queue as many requests as you want. Therefore, 1290You can still queue as many requests as you want. Therefore,
1220C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1291C<max_outstanding> is mainly useful in simple scripts (with low values) or
1221as a stop gap to shield against fatal memory overflow (with large values). 1292as a stop gap to shield against fatal memory overflow (with large values).
1222 1293
1223=back 1294=back
1224 1295
1225=head3 STATISTICAL INFORMATION 1296=head3 STATISTICAL INFORMATION
… …
1247but not yet processed by poll_cb). 1318but not yet processed by poll_cb).
1248 1319
1249=back 1320=back
1250 1321
1251=cut 1322=cut
1252
1253# support function to convert a fd into a perl filehandle
1254sub _fd2fh {
1255 return undef if $_[0] < 0;
1256
1257 # try to generate nice filehandles
1258 my $sym = "IO::AIO::fd#$_[0]";
1259 local *$sym;
1260
1261 open *$sym, "+<&=$_[0]" # usually works under any unix
1262 or open *$sym, "<&=$_[0]" # cygwin needs this
1263 or open *$sym, ">&=$_[0]" # or this
1264 or return undef;
1265
1266 *$sym
1267}
1268 1323
1269min_parallel 8; 1324min_parallel 8;
1270 1325
1271END { flush } 1326END { flush }
1272 1327
… …
1311 1366
1312Known bugs will be fixed in the next release. 1367Known bugs will be fixed in the next release.
1313 1368
1314=head1 SEE ALSO 1369=head1 SEE ALSO
1315 1370
1316L<Coro::AIO>. 1371L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1372more natural syntax.
1317 1373
1318=head1 AUTHOR 1374=head1 AUTHOR
1319 1375
1320 Marc Lehmann <schmorp@schmorp.de> 1376 Marc Lehmann <schmorp@schmorp.de>
1321 http://home.schmorp.de/ 1377 http://home.schmorp.de/

Diff Legend

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