ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

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

Diff Legend

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