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.108 by root, Fri Jun 1 13:25:50 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, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
31 # AnyEvent integration 34 # EV integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 36
35 # Event integration 37 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 39 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
183 185
184=cut 186=cut
185 187
186package IO::AIO; 188package IO::AIO;
187 189
190use Carp ();
191
188no warnings; 192no warnings;
189use strict 'vars'; 193use strict 'vars';
190 194
191use base 'Exporter'; 195use base 'Exporter';
192 196
193BEGIN { 197BEGIN {
194 our $VERSION = '2.4'; 198 our $VERSION = '3.18';
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); 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
346error, just like the syscall).
347
332like the syscall). If C<offset> is undefined, then the current file offset 348If C<$offset> is undefined, then the current file descriptor offset will
333will be used (and updated), otherwise the file offset will not be changed 349be used (and updated), otherwise the file descriptor offset will not be
334by these calls. 350changed by these calls.
351
352If C<$length> is undefined in C<aio_write>, use the remaining length of
353C<$data>.
354
355If C<$dataoffset> is less than zero, it will be counted from the end of
356C<$data>.
335 357
336The 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
337is outstanding. Modifying it can result in segfaults or World War III (if 359is outstanding. Modifying it can result in segfaults or World War III (if
338the necessary/optional hardware is installed). 360the necessary/optional hardware is installed).
339 361
437 aio_chown "path", 0, -1; 459 aio_chown "path", 0, -1;
438 # same as above: 460 # same as above:
439 aio_chown "path", 0, undef; 461 aio_chown "path", 0, undef;
440 462
441 463
464=item aio_truncate $fh_or_path, $offset, $callback->($status)
465
466Works like truncate(2) or ftruncate(2).
467
468
442=item aio_chmod $fh_or_path, $mode, $callback->($status) 469=item aio_chmod $fh_or_path, $mode, $callback->($status)
443 470
444Works like perl's C<chmod> function. 471Works like perl's C<chmod> function.
445 472
446 473
515memory. Status is the same as with aio_read. 542memory. Status is the same as with aio_read.
516 543
517=cut 544=cut
518 545
519sub aio_load($$;$) { 546sub aio_load($$;$) {
520 aio_block {
521 my ($path, undef, $cb) = @_; 547 my ($path, undef, $cb) = @_;
522 my $data = \$_[1]; 548 my $data = \$_[1];
523 549
524 my $pri = aioreq_pri; 550 my $pri = aioreq_pri;
525 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);
526 557
527 aioreq_pri $pri; 558 aioreq_pri $pri;
528 add $grp aio_open $path, O_RDONLY, 0, sub {
529 my $fh = shift
530 or return $grp->result (-1);
531
532 aioreq_pri $pri;
533 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 559 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
534 $grp->result ($_[0]); 560 $grp->result ($_[0]);
535 };
536 }; 561 };
537
538 $grp
539 } 562 };
563
564 $grp
540} 565}
541 566
542=item aio_copy $srcpath, $dstpath, $callback->($status) 567=item aio_copy $srcpath, $dstpath, $callback->($status)
543 568
544Try 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
545destination) from C<$srcpath> to C<$dstpath> and call the callback with 570destination) from C<$srcpath> to C<$dstpath> and call the callback with
546the C<0> (error) or C<-1> ok. 571the C<0> (error) or C<-1> ok.
547 572
548This is a composite request that it creates the destination file with 573This is a composite request that creates the destination file with
549mode 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
550C<aio_sendfile>, followed by restoring atime, mtime, access mode and 575C<aio_sendfile>, followed by restoring atime, mtime, access mode and
551uid/gid, in that order. 576uid/gid, in that order.
552 577
553If an error occurs, the partial destination file will be unlinked, if 578If an error occurs, the partial destination file will be unlinked, if
555errors are being ignored. 580errors are being ignored.
556 581
557=cut 582=cut
558 583
559sub aio_copy($$;$) { 584sub aio_copy($$;$) {
560 aio_block {
561 my ($src, $dst, $cb) = @_; 585 my ($src, $dst, $cb) = @_;
562 586
563 my $pri = aioreq_pri; 587 my $pri = aioreq_pri;
564 my $grp = aio_group $cb; 588 my $grp = aio_group $cb;
565 589
566 aioreq_pri $pri; 590 aioreq_pri $pri;
567 add $grp aio_open $src, O_RDONLY, 0, sub { 591 add $grp aio_open $src, O_RDONLY, 0, sub {
568 if (my $src_fh = $_[0]) { 592 if (my $src_fh = $_[0]) {
569 my @stat = stat $src_fh; 593 my @stat = stat $src_fh;
570 594
571 aioreq_pri $pri; 595 aioreq_pri $pri;
572 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 {
573 if (my $dst_fh = $_[0]) { 597 if (my $dst_fh = $_[0]) {
574 aioreq_pri $pri; 598 aioreq_pri $pri;
575 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 {
576 if ($_[0] == $stat[7]) { 600 if ($_[0] == $stat[7]) {
577 $grp->result (0); 601 $grp->result (0);
578 close $src_fh; 602 close $src_fh;
579 603
580 # those should not normally block. should. should. 604 # those should not normally block. should. should.
581 utime $stat[8], $stat[9], $dst; 605 utime $stat[8], $stat[9], $dst;
582 chmod $stat[2] & 07777, $dst_fh; 606 chmod $stat[2] & 07777, $dst_fh;
583 chown $stat[4], $stat[5], $dst_fh; 607 chown $stat[4], $stat[5], $dst_fh;
608
609 aioreq_pri $pri;
584 close $dst_fh; 610 add $grp aio_close $dst_fh;
585 } else { 611 } else {
586 $grp->result (-1); 612 $grp->result (-1);
587 close $src_fh; 613 close $src_fh;
588 close $dst_fh; 614 close $dst_fh;
589 615
590 aioreq $pri; 616 aioreq $pri;
591 add $grp aio_unlink $dst; 617 add $grp aio_unlink $dst;
592 }
593 }; 618 }
594 } else {
595 $grp->result (-1);
596 } 619 };
620 } else {
621 $grp->result (-1);
597 }, 622 }
598
599 } else {
600 $grp->result (-1);
601 } 623 },
624
625 } else {
626 $grp->result (-1);
602 }; 627 }
603
604 $grp
605 } 628 };
629
630 $grp
606} 631}
607 632
608=item aio_move $srcpath, $dstpath, $callback->($status) 633=item aio_move $srcpath, $dstpath, $callback->($status)
609 634
610Try 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
611destination) from C<$srcpath> to C<$dstpath> and call the callback with 636destination) from C<$srcpath> to C<$dstpath> and call the callback with
612the C<0> (error) or C<-1> ok. 637the C<0> (error) or C<-1> ok.
613 638
614This 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
615rename 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
616that is successful, unlinking the C<$srcpath>. 641that is successful, unlinks the C<$srcpath>.
617 642
618=cut 643=cut
619 644
620sub aio_move($$;$) { 645sub aio_move($$;$) {
621 aio_block {
622 my ($src, $dst, $cb) = @_; 646 my ($src, $dst, $cb) = @_;
623 647
624 my $pri = aioreq_pri; 648 my $pri = aioreq_pri;
625 my $grp = aio_group $cb; 649 my $grp = aio_group $cb;
626 650
627 aioreq_pri $pri; 651 aioreq_pri $pri;
628 add $grp aio_rename $src, $dst, sub { 652 add $grp aio_rename $src, $dst, sub {
629 if ($_[0] && $! == EXDEV) { 653 if ($_[0] && $! == EXDEV) {
630 aioreq_pri $pri; 654 aioreq_pri $pri;
631 add $grp aio_copy $src, $dst, sub { 655 add $grp aio_copy $src, $dst, sub {
632 $grp->result ($_[0]);
633
634 if (!$_[0]) {
635 aioreq_pri $pri;
636 add $grp aio_unlink $src;
637 }
638 };
639 } else {
640 $grp->result ($_[0]); 656 $grp->result ($_[0]);
657
658 if (!$_[0]) {
659 aioreq_pri $pri;
660 add $grp aio_unlink $src;
661 }
641 } 662 };
663 } else {
664 $grp->result ($_[0]);
642 }; 665 }
643
644 $grp
645 } 666 };
667
668 $grp
646} 669}
647 670
648=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 671=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
649 672
650Scans a directory (similar to C<aio_readdir>) but additionally tries to 673Scans a directory (similar to C<aio_readdir>) but additionally tries to
698directory counting heuristic. 721directory counting heuristic.
699 722
700=cut 723=cut
701 724
702sub aio_scandir($$;$) { 725sub aio_scandir($$;$) {
703 aio_block {
704 my ($path, $maxreq, $cb) = @_; 726 my ($path, $maxreq, $cb) = @_;
705 727
706 my $pri = aioreq_pri; 728 my $pri = aioreq_pri;
707 729
708 my $grp = aio_group $cb; 730 my $grp = aio_group $cb;
709 731
710 $maxreq = 4 if $maxreq <= 0; 732 $maxreq = 4 if $maxreq <= 0;
711 733
712 # 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
713 aioreq_pri $pri; 742 aioreq_pri $pri;
714 add $grp aio_stat $path, sub { 743 add $grp aio_readdir $path, sub {
744 my $entries = shift
715 return $grp->result () if $_[0]; 745 or return $grp->result ();
716 my $now = time;
717 my $hash1 = join ":", (stat _)[0,1,3,7,9];
718 746
719 # read the directory entries 747 # stat the dir another time
720 aioreq_pri $pri; 748 aioreq_pri $pri;
721 add $grp aio_readdir $path, sub {
722 my $entries = shift
723 or return $grp->result ();
724
725 # stat the dir another time
726 aioreq_pri $pri;
727 add $grp aio_stat $path, sub { 749 add $grp aio_stat $path, sub {
728 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 750 my $hash2 = join ":", (stat _)[0,1,3,7,9];
729 751
730 my $ndirs; 752 my $ndirs;
731 753
732 # take the slow route if anything looks fishy 754 # take the slow route if anything looks fishy
733 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 755 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
734 $ndirs = -1; 756 $ndirs = -1;
735 } else { 757 } else {
736 # if nlink == 2, we are finished 758 # if nlink == 2, we are finished
737 # on non-posix-fs's, we rely on nlink < 2 759 # on non-posix-fs's, we rely on nlink < 2
738 $ndirs = (stat _)[3] - 2 760 $ndirs = (stat _)[3] - 2
739 or return $grp->result ([], $entries); 761 or return $grp->result ([], $entries);
740 } 762 }
741 763
742 # sort into likely dirs and likely nondirs 764 # sort into likely dirs and likely nondirs
743 # dirs == files without ".", short entries first 765 # dirs == files without ".", short entries first
744 $entries = [map $_->[0], 766 $entries = [map $_->[0],
745 sort { $b->[1] cmp $a->[1] } 767 sort { $b->[1] cmp $a->[1] }
746 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 768 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
747 @$entries]; 769 @$entries];
748 770
749 my (@dirs, @nondirs); 771 my (@dirs, @nondirs);
750 772
751 my $statgrp = add $grp aio_group sub { 773 my $statgrp = add $grp aio_group sub {
752 $grp->result (\@dirs, \@nondirs); 774 $grp->result (\@dirs, \@nondirs);
753 }; 775 };
754 776
755 limit $statgrp $maxreq; 777 limit $statgrp $maxreq;
756 feed $statgrp sub { 778 feed $statgrp sub {
757 return unless @$entries; 779 return unless @$entries;
758 my $entry = pop @$entries; 780 my $entry = pop @$entries;
759 781
760 aioreq_pri $pri; 782 aioreq_pri $pri;
761 add $statgrp aio_stat "$path/$entry/.", sub { 783 add $statgrp aio_stat "$path/$entry/.", sub {
762 if ($_[0] < 0) { 784 if ($_[0] < 0) {
763 push @nondirs, $entry; 785 push @nondirs, $entry;
764 } else { 786 } else {
765 # need to check for real directory 787 # need to check for real directory
766 aioreq_pri $pri; 788 aioreq_pri $pri;
767 add $statgrp aio_lstat "$path/$entry", sub { 789 add $statgrp aio_lstat "$path/$entry", sub {
768 if (-d _) { 790 if (-d _) {
769 push @dirs, $entry; 791 push @dirs, $entry;
770 792
771 unless (--$ndirs) { 793 unless (--$ndirs) {
772 push @nondirs, @$entries; 794 push @nondirs, @$entries;
773 feed $statgrp; 795 feed $statgrp;
774 }
775 } else {
776 push @nondirs, $entry;
777 } 796 }
797 } else {
798 push @nondirs, $entry;
778 } 799 }
779 } 800 }
780 }; 801 }
781 }; 802 };
782 }; 803 };
783 }; 804 };
784 }; 805 };
785
786 $grp
787 } 806 };
807
808 $grp
788} 809}
789 810
790=item aio_rmtree $path, $callback->($status) 811=item aio_rmtree $path, $callback->($status)
791 812
792Delete a directory tree starting (and including) C<$path>, return the 813Delete a directory tree starting (and including) C<$path>, return the
796 817
797=cut 818=cut
798 819
799sub aio_rmtree; 820sub aio_rmtree;
800sub aio_rmtree($;$) { 821sub aio_rmtree($;$) {
801 aio_block {
802 my ($path, $cb) = @_; 822 my ($path, $cb) = @_;
803 823
804 my $pri = aioreq_pri; 824 my $pri = aioreq_pri;
805 my $grp = aio_group $cb; 825 my $grp = aio_group $cb;
806 826
807 aioreq_pri $pri; 827 aioreq_pri $pri;
808 add $grp aio_scandir $path, 0, sub { 828 add $grp aio_scandir $path, 0, sub {
809 my ($dirs, $nondirs) = @_; 829 my ($dirs, $nondirs) = @_;
810 830
811 my $dirgrp = aio_group sub { 831 my $dirgrp = aio_group sub {
812 add $grp aio_rmdir $path, sub { 832 add $grp aio_rmdir $path, sub {
813 $grp->result ($_[0]); 833 $grp->result ($_[0]);
814 };
815 }; 834 };
816
817 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
818 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
819
820 add $grp $dirgrp;
821 }; 835 };
822 836
823 $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;
824 } 841 };
842
843 $grp
825} 844}
845
846=item aio_sync $callback->($status)
847
848Asynchronously call sync and call the callback when finished.
826 849
827=item aio_fsync $fh, $callback->($status) 850=item aio_fsync $fh, $callback->($status)
828 851
829Asynchronously call fsync on the given filehandle and call the callback 852Asynchronously call fsync on the given filehandle and call the callback
830with the fsync result code. 853with the fsync result code.
834Asynchronously call fdatasync on the given filehandle and call the 857Asynchronously call fdatasync on the given filehandle and call the
835callback with the fdatasync result code. 858callback with the fdatasync result code.
836 859
837If 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
838detected, 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}
839 912
840=item aio_group $callback->(...) 913=item aio_group $callback->(...)
841 914
842This 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
843container 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
955Their lifetime, simplified, looks like this: when they are empty, they 1028Their lifetime, simplified, looks like this: when they are empty, they
956will 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
957C<done> state, they will also finish. Otherwise they will continue to 1030C<done> state, they will also finish. Otherwise they will continue to
958exist. 1031exist.
959 1032
960That 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
961in 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
962group. 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
963itself finish. 1036further requests to the group. And only when all those requests have
1037finished will the the group itself finish.
964 1038
965=over 4 1039=over 4
966 1040
967=item add $grp ... 1041=item add $grp ...
968 1042
980itself. 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.
981 1055
982=item $grp->result (...) 1056=item $grp->result (...)
983 1057
984Set 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
985subrequests have finished and set thre groups errno to the current value 1059subrequests have finished and set the groups errno to the current value
986of 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,
987no argument will be passed and errno is zero. 1061no argument will be passed and errno is zero.
988 1062
989=item $grp->errno ([$errno]) 1063=item $grp->errno ([$errno])
990 1064
1001=item feed $grp $callback->($grp) 1075=item feed $grp $callback->($grp)
1002 1076
1003Sets 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
1004generator that generates requests if idle. The idea behind this is that, 1078generator that generates requests if idle. The idea behind this is that,
1005although 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,
1006this might starve other requests for a potentially long time. For 1080this might starve other requests for a potentially long time. For example,
1007example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1081C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1008requests, delaying any later requests for a long time. 1082delaying any later requests for a long time.
1009 1083
1010To avoid this, and allow incremental generation of requests, you can 1084To avoid this, and allow incremental generation of requests, you can
1011instead 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
1012feed 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>,
1013below) 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
1017not impose any limits). 1091not impose any limits).
1018 1092
1019If 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
1020automatically removed from the group. 1094automatically removed from the group.
1021 1095
1022If 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.
1023 1098
1024Example: 1099Example:
1025 1100
1026 # 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:
1027 1102
1039Sets 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
1040the group contains less than this many requests. 1115the group contains less than this many requests.
1041 1116
1042Setting the limit to C<0> will pause the feeding process. 1117Setting the limit to C<0> will pause the feeding process.
1043 1118
1119The default value for the limit is C<0>, but note that setting a feeder
1120automatically bumps it up to C<2>.
1121
1044=back 1122=back
1045 1123
1046=head2 SUPPORT FUNCTIONS 1124=head2 SUPPORT FUNCTIONS
1047 1125
1048=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1126=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1059See C<poll_cb> for an example. 1137See C<poll_cb> for an example.
1060 1138
1061=item IO::AIO::poll_cb 1139=item IO::AIO::poll_cb
1062 1140
1063Process 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
1064regularly. 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
1065when no events are outstanding. The amount of events processed depends on 1144are outstanding. The amount of events processed depends on the settings of
1066the 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>.
1067 1146
1068If not all requests were processed for whatever reason, the filehandle 1147If not all requests were processed for whatever reason, the filehandle
1069will 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.
1070 1150
1071Example: Install an Event watcher that automatically calls 1151Example: Install an Event watcher that automatically calls
1072IO::AIO::poll_cb with high priority: 1152IO::AIO::poll_cb with high priority:
1073 1153
1074 Event->io (fd => IO::AIO::poll_fileno, 1154 Event->io (fd => IO::AIO::poll_fileno,
1188 1268
1189The default is probably ok in most situations, especially if thread 1269The default is probably ok in most situations, especially if thread
1190creation 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
1191want to use larger values. 1271want to use larger values.
1192 1272
1193=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1273=item IO::AIO::max_outstanding $maxreqs
1194 1274
1195This 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
1196blocks, 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
1197use an C<aio_group> together with a feed callback. 1277use an C<aio_group> together with a feed callback.
1198 1278
1199Sets the maximum number of outstanding requests to C<$nreqs>. If you 1279Sets the maximum number of outstanding requests to C<$nreqs>. If you
1200to queue up more than this number of requests, the next call to the 1280do queue up more than this number of requests, the next call to the
1201C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1281C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1202function will block until the limit is no longer exceeded. 1282function will block until the limit is no longer exceeded.
1203 1283
1204The 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
1205number of outstanding requests. 1285number of outstanding requests.
1206 1286
1207You can still queue as many requests as you want. Therefore, 1287You can still queue as many requests as you want. Therefore,
1208C<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
1209as 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).
1210 1290
1211=back 1291=back
1212 1292
1213=head3 STATISTICAL INFORMATION 1293=head3 STATISTICAL INFORMATION
1235but not yet processed by poll_cb). 1315but not yet processed by poll_cb).
1236 1316
1237=back 1317=back
1238 1318
1239=cut 1319=cut
1240
1241# support function to convert a fd into a perl filehandle
1242sub _fd2fh {
1243 return undef if $_[0] < 0;
1244
1245 # try to generate nice filehandles
1246 my $sym = "IO::AIO::fd#$_[0]";
1247 local *$sym;
1248
1249 open *$sym, "+<&=$_[0]" # usually works under any unix
1250 or open *$sym, "<&=$_[0]" # cygwin needs this
1251 or open *$sym, ">&=$_[0]" # or this
1252 or return undef;
1253
1254 *$sym
1255}
1256 1320
1257min_parallel 8; 1321min_parallel 8;
1258 1322
1259END { flush } 1323END { flush }
1260 1324
1284bytes of memory. In addition, stat requests need a stat buffer (possibly 1348bytes of memory. In addition, stat requests need a stat buffer (possibly
1285a few hundred bytes), readdir requires a result buffer and so on. Perl 1349a few hundred bytes), readdir requires a result buffer and so on. Perl
1286scalars and other data passed into aio requests will also be locked and 1350scalars and other data passed into aio requests will also be locked and
1287will consume memory till the request has entered the done state. 1351will consume memory till the request has entered the done state.
1288 1352
1289This is now awfully much, so queuing lots of requests is not usually a 1353This is not awfully much, so queuing lots of requests is not usually a
1290problem. 1354problem.
1291 1355
1292Per-thread usage: 1356Per-thread usage:
1293 1357
1294In the execution phase, some aio requests require more memory for 1358In the execution phase, some aio requests require more memory for
1299 1363
1300Known bugs will be fixed in the next release. 1364Known bugs will be fixed in the next release.
1301 1365
1302=head1 SEE ALSO 1366=head1 SEE ALSO
1303 1367
1304L<Coro::AIO>. 1368L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1369more natural syntax.
1305 1370
1306=head1 AUTHOR 1371=head1 AUTHOR
1307 1372
1308 Marc Lehmann <schmorp@schmorp.de> 1373 Marc Lehmann <schmorp@schmorp.de>
1309 http://home.schmorp.de/ 1374 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines