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.142 by root, Wed Oct 22 18:15:36 2008 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.16';
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);
206 213
… …
217All the C<aio_*> calls are more or less thin wrappers around the syscall 224All 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, 225with the same name (sans C<aio_>). The arguments are similar or identical,
219and they all accept an additional (and optional) C<$callback> argument 226and they all accept an additional (and optional) C<$callback> argument
220which must be a code reference. This code reference will get called with 227which 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 228the 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 229perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 230syscall has been executed asynchronously.
224 231
225All functions expecting a filehandle keep a copy of the filehandle 232All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 233internally until the request has finished.
227 234
… …
241your pathnames to the locale (or other) encoding in effect in the user 248your pathnames to the locale (or other) encoding in effect in the user
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 249environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 250use something else to ensure your scalar has the correct contents.
244 251
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO 252This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not. 253handles correctly whether it is set or not.
247 254
248=over 4 255=over 4
249 256
250=item $prev_pri = aioreq_pri [$pri] 257=item $prev_pri = aioreq_pri [$pri]
251 258
… …
311 318
312 319
313=item aio_close $fh, $callback->($status) 320=item aio_close $fh, $callback->($status)
314 321
315Asynchronously close a file and call the callback with the result 322Asynchronously close a file and call the callback with the result
316code. I<WARNING:> although accepted, you should not pass in a perl 323code.
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 324
321This is supposed to be a bug in the API, so that might change. It's 325Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 326closing the file descriptor associated with the filehandle itself.
323 327
328Therefore, C<aio_close> will not close the filehandle - instead it will
329use dup2 to overwrite the file descriptor with the write-end of a pipe
330(the pipe fd will be created on demand and will be cached).
331
332Or in other words: the file descriptor will be closed, but it will not be
333free for reuse until the perl filehandle is closed.
334
335=cut
324 336
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 337=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 338
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 340
329Reads or writes C<length> bytes from the specified C<fh> and C<offset> 341Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
330into the scalar given by C<data> and offset C<dataoffset> and calls the 342into the scalar given by C<$data> and offset C<$dataoffset> and calls the
331callback without the actual number of bytes read (or -1 on error, just 343callback without the actual number of bytes read (or -1 on error, just
344like the syscall).
345
332like the syscall). If C<offset> is undefined, then the current file offset 346If C<$offset> is undefined, then the current file descriptor offset will
333will be used (and updated), otherwise the file offset will not be changed 347be used (and updated), otherwise the file descriptor offset will not be
334by these calls. 348changed by these calls.
349
350If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
351
352If C<$dataoffset> is less than zero, it will be counted from the end of
353C<$data>.
335 354
336The C<$data> scalar I<MUST NOT> be modified in any way while the request 355The 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 356is outstanding. Modifying it can result in segfaults or World War III (if
338the necessary/optional hardware is installed). 357the necessary/optional hardware is installed).
339 358
… …
437 aio_chown "path", 0, -1; 456 aio_chown "path", 0, -1;
438 # same as above: 457 # same as above:
439 aio_chown "path", 0, undef; 458 aio_chown "path", 0, undef;
440 459
441 460
461=item aio_truncate $fh_or_path, $offset, $callback->($status)
462
463Works like truncate(2) or ftruncate(2).
464
465
442=item aio_chmod $fh_or_path, $mode, $callback->($status) 466=item aio_chmod $fh_or_path, $mode, $callback->($status)
443 467
444Works like perl's C<chmod> function. 468Works like perl's C<chmod> function.
445 469
446 470
… …
515memory. Status is the same as with aio_read. 539memory. Status is the same as with aio_read.
516 540
517=cut 541=cut
518 542
519sub aio_load($$;$) { 543sub aio_load($$;$) {
520 aio_block {
521 my ($path, undef, $cb) = @_; 544 my ($path, undef, $cb) = @_;
522 my $data = \$_[1]; 545 my $data = \$_[1];
523 546
524 my $pri = aioreq_pri; 547 my $pri = aioreq_pri;
525 my $grp = aio_group $cb; 548 my $grp = aio_group $cb;
549
550 aioreq_pri $pri;
551 add $grp aio_open $path, O_RDONLY, 0, sub {
552 my $fh = shift
553 or return $grp->result (-1);
526 554
527 aioreq_pri $pri; 555 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 { 556 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
534 $grp->result ($_[0]); 557 $grp->result ($_[0]);
535 };
536 }; 558 };
537
538 $grp
539 } 559 };
560
561 $grp
540} 562}
541 563
542=item aio_copy $srcpath, $dstpath, $callback->($status) 564=item aio_copy $srcpath, $dstpath, $callback->($status)
543 565
544Try to copy the I<file> (directories not supported as either source or 566Try to copy the I<file> (directories not supported as either source or
545destination) from C<$srcpath> to C<$dstpath> and call the callback with 567destination) from C<$srcpath> to C<$dstpath> and call the callback with
546the C<0> (error) or C<-1> ok. 568the C<0> (error) or C<-1> ok.
547 569
548This is a composite request that it creates the destination file with 570This is a composite request that creates the destination file with
549mode 0200 and copies the contents of the source file into it using 571mode 0200 and copies the contents of the source file into it using
550C<aio_sendfile>, followed by restoring atime, mtime, access mode and 572C<aio_sendfile>, followed by restoring atime, mtime, access mode and
551uid/gid, in that order. 573uid/gid, in that order.
552 574
553If an error occurs, the partial destination file will be unlinked, if 575If an error occurs, the partial destination file will be unlinked, if
… …
555errors are being ignored. 577errors are being ignored.
556 578
557=cut 579=cut
558 580
559sub aio_copy($$;$) { 581sub aio_copy($$;$) {
560 aio_block {
561 my ($src, $dst, $cb) = @_; 582 my ($src, $dst, $cb) = @_;
562 583
563 my $pri = aioreq_pri; 584 my $pri = aioreq_pri;
564 my $grp = aio_group $cb; 585 my $grp = aio_group $cb;
565 586
566 aioreq_pri $pri; 587 aioreq_pri $pri;
567 add $grp aio_open $src, O_RDONLY, 0, sub { 588 add $grp aio_open $src, O_RDONLY, 0, sub {
568 if (my $src_fh = $_[0]) { 589 if (my $src_fh = $_[0]) {
569 my @stat = stat $src_fh; 590 my @stat = stat $src_fh;
570 591
571 aioreq_pri $pri; 592 aioreq_pri $pri;
572 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 593 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
573 if (my $dst_fh = $_[0]) { 594 if (my $dst_fh = $_[0]) {
574 aioreq_pri $pri; 595 aioreq_pri $pri;
575 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 596 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
576 if ($_[0] == $stat[7]) { 597 if ($_[0] == $stat[7]) {
577 $grp->result (0); 598 $grp->result (0);
578 close $src_fh; 599 close $src_fh;
579 600
580 # those should not normally block. should. should. 601 # those should not normally block. should. should.
581 utime $stat[8], $stat[9], $dst; 602 utime $stat[8], $stat[9], $dst;
582 chmod $stat[2] & 07777, $dst_fh; 603 chmod $stat[2] & 07777, $dst_fh;
583 chown $stat[4], $stat[5], $dst_fh; 604 chown $stat[4], $stat[5], $dst_fh;
605
606 aioreq_pri $pri;
584 close $dst_fh; 607 add $grp aio_close $dst_fh;
585 } else { 608 } else {
586 $grp->result (-1); 609 $grp->result (-1);
587 close $src_fh; 610 close $src_fh;
588 close $dst_fh; 611 close $dst_fh;
589 612
590 aioreq $pri; 613 aioreq $pri;
591 add $grp aio_unlink $dst; 614 add $grp aio_unlink $dst;
592 }
593 }; 615 }
594 } else {
595 $grp->result (-1);
596 } 616 };
617 } else {
618 $grp->result (-1);
597 }, 619 }
598
599 } else {
600 $grp->result (-1);
601 } 620 },
621
622 } else {
623 $grp->result (-1);
602 }; 624 }
603
604 $grp
605 } 625 };
626
627 $grp
606} 628}
607 629
608=item aio_move $srcpath, $dstpath, $callback->($status) 630=item aio_move $srcpath, $dstpath, $callback->($status)
609 631
610Try to move the I<file> (directories not supported as either source or 632Try to move the I<file> (directories not supported as either source or
611destination) from C<$srcpath> to C<$dstpath> and call the callback with 633destination) from C<$srcpath> to C<$dstpath> and call the callback with
612the C<0> (error) or C<-1> ok. 634the C<0> (error) or C<-1> ok.
613 635
614This is a composite request that tries to rename(2) the file first. If 636This 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 637rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
616that is successful, unlinking the C<$srcpath>. 638that is successful, unlinks the C<$srcpath>.
617 639
618=cut 640=cut
619 641
620sub aio_move($$;$) { 642sub aio_move($$;$) {
621 aio_block {
622 my ($src, $dst, $cb) = @_; 643 my ($src, $dst, $cb) = @_;
623 644
624 my $pri = aioreq_pri; 645 my $pri = aioreq_pri;
625 my $grp = aio_group $cb; 646 my $grp = aio_group $cb;
626 647
627 aioreq_pri $pri; 648 aioreq_pri $pri;
628 add $grp aio_rename $src, $dst, sub { 649 add $grp aio_rename $src, $dst, sub {
629 if ($_[0] && $! == EXDEV) { 650 if ($_[0] && $! == EXDEV) {
630 aioreq_pri $pri; 651 aioreq_pri $pri;
631 add $grp aio_copy $src, $dst, sub { 652 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]); 653 $grp->result ($_[0]);
654
655 if (!$_[0]) {
656 aioreq_pri $pri;
657 add $grp aio_unlink $src;
658 }
641 } 659 };
660 } else {
661 $grp->result ($_[0]);
642 }; 662 }
643
644 $grp
645 } 663 };
664
665 $grp
646} 666}
647 667
648=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 668=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
649 669
650Scans a directory (similar to C<aio_readdir>) but additionally tries to 670Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
698directory counting heuristic. 718directory counting heuristic.
699 719
700=cut 720=cut
701 721
702sub aio_scandir($$;$) { 722sub aio_scandir($$;$) {
703 aio_block {
704 my ($path, $maxreq, $cb) = @_; 723 my ($path, $maxreq, $cb) = @_;
705 724
706 my $pri = aioreq_pri; 725 my $pri = aioreq_pri;
707 726
708 my $grp = aio_group $cb; 727 my $grp = aio_group $cb;
709 728
710 $maxreq = 4 if $maxreq <= 0; 729 $maxreq = 4 if $maxreq <= 0;
711 730
712 # stat once 731 # stat once
732 aioreq_pri $pri;
733 add $grp aio_stat $path, sub {
734 return $grp->result () if $_[0];
735 my $now = time;
736 my $hash1 = join ":", (stat _)[0,1,3,7,9];
737
738 # read the directory entries
713 aioreq_pri $pri; 739 aioreq_pri $pri;
714 add $grp aio_stat $path, sub { 740 add $grp aio_readdir $path, sub {
741 my $entries = shift
715 return $grp->result () if $_[0]; 742 or return $grp->result ();
716 my $now = time;
717 my $hash1 = join ":", (stat _)[0,1,3,7,9];
718 743
719 # read the directory entries 744 # stat the dir another time
720 aioreq_pri $pri; 745 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 { 746 add $grp aio_stat $path, sub {
728 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 747 my $hash2 = join ":", (stat _)[0,1,3,7,9];
729 748
730 my $ndirs; 749 my $ndirs;
731 750
732 # take the slow route if anything looks fishy 751 # take the slow route if anything looks fishy
733 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 752 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
734 $ndirs = -1; 753 $ndirs = -1;
735 } else { 754 } else {
736 # if nlink == 2, we are finished 755 # if nlink == 2, we are finished
737 # on non-posix-fs's, we rely on nlink < 2 756 # on non-posix-fs's, we rely on nlink < 2
738 $ndirs = (stat _)[3] - 2 757 $ndirs = (stat _)[3] - 2
739 or return $grp->result ([], $entries); 758 or return $grp->result ([], $entries);
740 } 759 }
741 760
742 # sort into likely dirs and likely nondirs 761 # sort into likely dirs and likely nondirs
743 # dirs == files without ".", short entries first 762 # dirs == files without ".", short entries first
744 $entries = [map $_->[0], 763 $entries = [map $_->[0],
745 sort { $b->[1] cmp $a->[1] } 764 sort { $b->[1] cmp $a->[1] }
746 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 765 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
747 @$entries]; 766 @$entries];
748 767
749 my (@dirs, @nondirs); 768 my (@dirs, @nondirs);
750 769
751 my $statgrp = add $grp aio_group sub { 770 my $statgrp = add $grp aio_group sub {
752 $grp->result (\@dirs, \@nondirs); 771 $grp->result (\@dirs, \@nondirs);
753 }; 772 };
754 773
755 limit $statgrp $maxreq; 774 limit $statgrp $maxreq;
756 feed $statgrp sub { 775 feed $statgrp sub {
757 return unless @$entries; 776 return unless @$entries;
758 my $entry = pop @$entries; 777 my $entry = pop @$entries;
759 778
760 aioreq_pri $pri; 779 aioreq_pri $pri;
761 add $statgrp aio_stat "$path/$entry/.", sub { 780 add $statgrp aio_stat "$path/$entry/.", sub {
762 if ($_[0] < 0) { 781 if ($_[0] < 0) {
763 push @nondirs, $entry; 782 push @nondirs, $entry;
764 } else { 783 } else {
765 # need to check for real directory 784 # need to check for real directory
766 aioreq_pri $pri; 785 aioreq_pri $pri;
767 add $statgrp aio_lstat "$path/$entry", sub { 786 add $statgrp aio_lstat "$path/$entry", sub {
768 if (-d _) { 787 if (-d _) {
769 push @dirs, $entry; 788 push @dirs, $entry;
770 789
771 unless (--$ndirs) { 790 unless (--$ndirs) {
772 push @nondirs, @$entries; 791 push @nondirs, @$entries;
773 feed $statgrp; 792 feed $statgrp;
774 }
775 } else {
776 push @nondirs, $entry;
777 } 793 }
794 } else {
795 push @nondirs, $entry;
778 } 796 }
779 } 797 }
780 }; 798 }
781 }; 799 };
782 }; 800 };
783 }; 801 };
784 }; 802 };
785
786 $grp
787 } 803 };
804
805 $grp
788} 806}
789 807
790=item aio_rmtree $path, $callback->($status) 808=item aio_rmtree $path, $callback->($status)
791 809
792Delete a directory tree starting (and including) C<$path>, return the 810Delete a directory tree starting (and including) C<$path>, return the
… …
796 814
797=cut 815=cut
798 816
799sub aio_rmtree; 817sub aio_rmtree;
800sub aio_rmtree($;$) { 818sub aio_rmtree($;$) {
801 aio_block {
802 my ($path, $cb) = @_; 819 my ($path, $cb) = @_;
803 820
804 my $pri = aioreq_pri; 821 my $pri = aioreq_pri;
805 my $grp = aio_group $cb; 822 my $grp = aio_group $cb;
806 823
807 aioreq_pri $pri; 824 aioreq_pri $pri;
808 add $grp aio_scandir $path, 0, sub { 825 add $grp aio_scandir $path, 0, sub {
809 my ($dirs, $nondirs) = @_; 826 my ($dirs, $nondirs) = @_;
810 827
811 my $dirgrp = aio_group sub { 828 my $dirgrp = aio_group sub {
812 add $grp aio_rmdir $path, sub { 829 add $grp aio_rmdir $path, sub {
813 $grp->result ($_[0]); 830 $grp->result ($_[0]);
814 };
815 }; 831 };
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 }; 832 };
822 833
823 $grp 834 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
835 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
836
837 add $grp $dirgrp;
824 } 838 };
839
840 $grp
825} 841}
842
843=item aio_sync $callback->($status)
844
845Asynchronously call sync and call the callback when finished.
826 846
827=item aio_fsync $fh, $callback->($status) 847=item aio_fsync $fh, $callback->($status)
828 848
829Asynchronously call fsync on the given filehandle and call the callback 849Asynchronously call fsync on the given filehandle and call the callback
830with the fsync result code. 850with the fsync result code.
… …
834Asynchronously call fdatasync on the given filehandle and call the 854Asynchronously call fdatasync on the given filehandle and call the
835callback with the fdatasync result code. 855callback with the fdatasync result code.
836 856
837If this call isn't available because your OS lacks it or it couldn't be 857If 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. 858detected, it will be emulated by calling C<fsync> instead.
859
860=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
861
862Sync the data portion of the file specified by C<$offset> and C<$length>
863to disk (but NOT the metadata), by calling the Linux-specific
864sync_file_range call. If sync_file_range is not available or it returns
865ENOSYS, then fdatasync or fsync is being substituted.
866
867C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
868C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
869C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
870manpage for details.
871
872=item aio_pathsync $path, $callback->($status)
873
874This request tries to open, fsync and close the given path. This is a
875composite request intended to sync directories after directory operations
876(E.g. rename). This might not work on all operating systems or have any
877specific effect, but usually it makes sure that directory changes get
878written to disc. It works for anything that can be opened for read-only,
879not just directories.
880
881Passes C<0> when everything went ok, and C<-1> on error.
882
883=cut
884
885sub aio_pathsync($;$) {
886 my ($path, $cb) = @_;
887
888 my $pri = aioreq_pri;
889 my $grp = aio_group $cb;
890
891 aioreq_pri $pri;
892 add $grp aio_open $path, O_RDONLY, 0, sub {
893 my ($fh) = @_;
894 if ($fh) {
895 aioreq_pri $pri;
896 add $grp aio_fsync $fh, sub {
897 $grp->result ($_[0]);
898
899 aioreq_pri $pri;
900 add $grp aio_close $fh;
901 };
902 } else {
903 $grp->result (-1);
904 }
905 };
906
907 $grp
908}
839 909
840=item aio_group $callback->(...) 910=item aio_group $callback->(...)
841 911
842This is a very special aio request: Instead of doing something, it is a 912This 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 913container for other aio requests, which is useful if you want to bundle
… …
955Their lifetime, simplified, looks like this: when they are empty, they 1025Their lifetime, simplified, looks like this: when they are empty, they
956will finish very quickly. If they contain only requests that are in the 1026will finish very quickly. If they contain only requests that are in the
957C<done> state, they will also finish. Otherwise they will continue to 1027C<done> state, they will also finish. Otherwise they will continue to
958exist. 1028exist.
959 1029
960That means after creating a group you have some time to add requests. And 1030That 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 1031(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 1032the C<poll_cb>). And in the callbacks of those requests, you can add
963itself finish. 1033further requests to the group. And only when all those requests have
1034finished will the the group itself finish.
964 1035
965=over 4 1036=over 4
966 1037
967=item add $grp ... 1038=item add $grp ...
968 1039
… …
980itself. Useful when you queued a lot of events but got a result early. 1051itself. Useful when you queued a lot of events but got a result early.
981 1052
982=item $grp->result (...) 1053=item $grp->result (...)
983 1054
984Set the result value(s) that will be passed to the group callback when all 1055Set 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 1056subrequests have finished and set the groups errno to the current value
986of errno (just like calling C<errno> without an error number). By default, 1057of errno (just like calling C<errno> without an error number). By default,
987no argument will be passed and errno is zero. 1058no argument will be passed and errno is zero.
988 1059
989=item $grp->errno ([$errno]) 1060=item $grp->errno ([$errno])
990 1061
… …
1001=item feed $grp $callback->($grp) 1072=item feed $grp $callback->($grp)
1002 1073
1003Sets a feeder/generator on this group: every group can have an attached 1074Sets a feeder/generator on this group: every group can have an attached
1004generator that generates requests if idle. The idea behind this is that, 1075generator 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, 1076although you could just queue as many requests as you want in a group,
1006this might starve other requests for a potentially long time. For 1077this might starve other requests for a potentially long time. For example,
1007example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1078C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1008requests, delaying any later requests for a long time. 1079delaying any later requests for a long time.
1009 1080
1010To avoid this, and allow incremental generation of requests, you can 1081To avoid this, and allow incremental generation of requests, you can
1011instead a group and set a feeder on it that generates those requests. The 1082instead 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>, 1083feed 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 1084below) requests active in the group itself and is expected to queue more
… …
1017not impose any limits). 1088not impose any limits).
1018 1089
1019If the feed does not queue more requests when called, it will be 1090If the feed does not queue more requests when called, it will be
1020automatically removed from the group. 1091automatically removed from the group.
1021 1092
1022If the feed limit is C<0>, it will be set to C<2> automatically. 1093If the feed limit is C<0> when this method is called, it will be set to
1094C<2> automatically.
1023 1095
1024Example: 1096Example:
1025 1097
1026 # stat all files in @files, but only ever use four aio requests concurrently: 1098 # stat all files in @files, but only ever use four aio requests concurrently:
1027 1099
… …
1039Sets the feeder limit for the group: The feeder will be called whenever 1111Sets the feeder limit for the group: The feeder will be called whenever
1040the group contains less than this many requests. 1112the group contains less than this many requests.
1041 1113
1042Setting the limit to C<0> will pause the feeding process. 1114Setting the limit to C<0> will pause the feeding process.
1043 1115
1116The default value for the limit is C<0>, but note that setting a feeder
1117automatically bumps it up to C<2>.
1118
1044=back 1119=back
1045 1120
1046=head2 SUPPORT FUNCTIONS 1121=head2 SUPPORT FUNCTIONS
1047 1122
1048=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1059See C<poll_cb> for an example. 1134See C<poll_cb> for an example.
1060 1135
1061=item IO::AIO::poll_cb 1136=item IO::AIO::poll_cb
1062 1137
1063Process some outstanding events on the result pipe. You have to call this 1138Process some outstanding events on the result pipe. You have to call this
1064regularly. Returns the number of events processed. Returns immediately 1139regularly. Returns C<0> if all events could be processed, or C<-1> if it
1140returned earlier for whatever reason. Returns immediately when no events
1065when no events are outstanding. The amount of events processed depends on 1141are 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>. 1142C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1067 1143
1068If not all requests were processed for whatever reason, the filehandle 1144If not all requests were processed for whatever reason, the filehandle
1069will still be ready when C<poll_cb> returns. 1145will still be ready when C<poll_cb> returns, so normally you don't have to
1146do anything special to have it called later.
1070 1147
1071Example: Install an Event watcher that automatically calls 1148Example: Install an Event watcher that automatically calls
1072IO::AIO::poll_cb with high priority: 1149IO::AIO::poll_cb with high priority:
1073 1150
1074 Event->io (fd => IO::AIO::poll_fileno, 1151 Event->io (fd => IO::AIO::poll_fileno,
… …
1188 1265
1189The default is probably ok in most situations, especially if thread 1266The default is probably ok in most situations, especially if thread
1190creation is fast. If thread creation is very slow on your system you might 1267creation is fast. If thread creation is very slow on your system you might
1191want to use larger values. 1268want to use larger values.
1192 1269
1193=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1270=item IO::AIO::max_outstanding $maxreqs
1194 1271
1195This is a very bad function to use in interactive programs because it 1272This 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 1273blocks, and a bad way to reduce concurrency because it is inexact: Better
1197use an C<aio_group> together with a feed callback. 1274use an C<aio_group> together with a feed callback.
1198 1275
1199Sets the maximum number of outstanding requests to C<$nreqs>. If you 1276Sets 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 1277do 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>) 1278C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1202function will block until the limit is no longer exceeded. 1279function will block until the limit is no longer exceeded.
1203 1280
1204The default value is very large, so there is no practical limit on the 1281The default value is very large, so there is no practical limit on the
1205number of outstanding requests. 1282number of outstanding requests.
1206 1283
1207You can still queue as many requests as you want. Therefore, 1284You can still queue as many requests as you want. Therefore,
1208C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1285C<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). 1286as a stop gap to shield against fatal memory overflow (with large values).
1210 1287
1211=back 1288=back
1212 1289
1213=head3 STATISTICAL INFORMATION 1290=head3 STATISTICAL INFORMATION
… …
1235but not yet processed by poll_cb). 1312but not yet processed by poll_cb).
1236 1313
1237=back 1314=back
1238 1315
1239=cut 1316=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 1317
1257min_parallel 8; 1318min_parallel 8;
1258 1319
1259END { flush } 1320END { flush }
1260 1321
… …
1284bytes of memory. In addition, stat requests need a stat buffer (possibly 1345bytes of memory. In addition, stat requests need a stat buffer (possibly
1285a few hundred bytes), readdir requires a result buffer and so on. Perl 1346a 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 1347scalars and other data passed into aio requests will also be locked and
1287will consume memory till the request has entered the done state. 1348will consume memory till the request has entered the done state.
1288 1349
1289This is now awfully much, so queuing lots of requests is not usually a 1350This is not awfully much, so queuing lots of requests is not usually a
1290problem. 1351problem.
1291 1352
1292Per-thread usage: 1353Per-thread usage:
1293 1354
1294In the execution phase, some aio requests require more memory for 1355In the execution phase, some aio requests require more memory for
… …
1299 1360
1300Known bugs will be fixed in the next release. 1361Known bugs will be fixed in the next release.
1301 1362
1302=head1 SEE ALSO 1363=head1 SEE ALSO
1303 1364
1304L<Coro::AIO>. 1365L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1366more natural syntax.
1305 1367
1306=head1 AUTHOR 1368=head1 AUTHOR
1307 1369
1308 Marc Lehmann <schmorp@schmorp.de> 1370 Marc Lehmann <schmorp@schmorp.de>
1309 http://home.schmorp.de/ 1371 http://home.schmorp.de/

Diff Legend

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