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.106 by root, Fri Jun 1 05:51:21 2007 UTC vs.
Revision 1.136 by root, Tue Sep 30 14:07:59 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);
62etc.), but can also be used to easily do operations in parallel that are 64etc.), but can also be used to easily do operations in parallel that are
63normally done sequentially, e.g. stat'ing many files, which is much faster 65normally done sequentially, e.g. stat'ing many files, which is much faster
64on a RAID volume or over NFS when you do a number of stat operations 66on a RAID volume or over NFS when you do a number of stat operations
65concurrently. 67concurrently.
66 68
67While most of this works on all types of file descriptors (for example 69While most of this works on all types of file descriptors (for
68sockets), using these functions on file descriptors that support 70example sockets), using these functions on file descriptors that
69nonblocking operation (again, sockets, pipes etc.) is very inefficient or 71support nonblocking operation (again, sockets, pipes etc.) is very
70might not work (aio_read fails on sockets/pipes/fifos). Use an event loop 72inefficient. Use an event loop for that (such as the L<Event|Event>
71for that (such as the L<Event|Event> module): IO::AIO will naturally fit 73module): IO::AIO will naturally fit into such an event loop itself.
72into such an event loop itself.
73 74
74In this version, a number of threads are started that execute your 75In this version, a number of threads are started that execute your
75requests and signal their completion. You don't need thread support 76requests and signal their completion. You don't need thread support
76in perl, and the threads created by this module will not be visible 77in perl, and the threads created by this module will not be visible
77to perl. In the future, this module might make use of the native aio 78to perl. In the future, this module might make use of the native aio
79not well-supported or restricted (GNU/Linux doesn't allow them on normal 80not well-supported or restricted (GNU/Linux doesn't allow them on normal
80files currently, for example), and they would only support aio_read and 81files currently, for example), and they would only support aio_read and
81aio_write, so the remaining functionality would have to be implemented 82aio_write, so the remaining functionality would have to be implemented
82using threads anyway. 83using threads anyway.
83 84
84Although the module will work with in the presence of other (Perl-) 85Although the module will work in the presence of other (Perl-) threads,
85threads, it is currently not reentrant in any way, so use appropriate 86it is currently not reentrant in any way, so use appropriate locking
86locking yourself, always call C<poll_cb> from within the same thread, or 87yourself, always call C<poll_cb> from within the same thread, or never
87never call C<poll_cb> (or other C<aio_> functions) recursively. 88call C<poll_cb> (or other C<aio_> functions) recursively.
88 89
89=head2 EXAMPLE 90=head2 EXAMPLE
90 91
91This is a simple example that uses the Event module and loads 92This is a simple example that uses the Event module and loads
92F</etc/passwd> asynchronously: 93F</etc/passwd> asynchronously:
184 185
185=cut 186=cut
186 187
187package IO::AIO; 188package IO::AIO;
188 189
190use Carp ();
191
189no warnings; 192no warnings;
190use strict 'vars'; 193use strict 'vars';
191 194
192use base 'Exporter'; 195use base 'Exporter';
193 196
194BEGIN { 197BEGIN {
195 our $VERSION = '2.4'; 198 our $VERSION = '3.1';
196 199
197 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
198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
199 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_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group
200 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
201 aio_chown aio_chmod aio_utime); 206 aio_chmod aio_utime aio_truncate);
207
202 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
203 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
204 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
205 nreqs nready npending nthreads 211 nreqs nready npending nthreads
206 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
207 213
218All 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
219with 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,
220and they all accept an additional (and optional) C<$callback> argument 226and they all accept an additional (and optional) C<$callback> argument
221which 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
222the 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
223perl, which usually delivers "false") as it's sole argument when the given 229perl, which usually delivers "false") as its sole argument after the given
224syscall has been executed asynchronously. 230syscall has been executed asynchronously.
225 231
226All functions expecting a filehandle keep a copy of the filehandle 232All functions expecting a filehandle keep a copy of the filehandle
227internally until the request has finished. 233internally until the request has finished.
228 234
242your 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
243environment, d) use Glib::filename_from_unicode on unicode filenames or e) 249environment, d) use Glib::filename_from_unicode on unicode filenames or e)
244use something else to ensure your scalar has the correct contents. 250use something else to ensure your scalar has the correct contents.
245 251
246This 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
247handles correctly wether it is set or not. 253handles correctly whether it is set or not.
248 254
249=over 4 255=over 4
250 256
251=item $prev_pri = aioreq_pri [$pri] 257=item $prev_pri = aioreq_pri [$pri]
252 258
312 318
313 319
314=item aio_close $fh, $callback->($status) 320=item aio_close $fh, $callback->($status)
315 321
316Asynchronously close a file and call the callback with the result 322Asynchronously close a file and call the callback with the result
317code. I<WARNING:> although accepted, you should not pass in a perl 323code.
318filehandle here, as perl will likely close the file descriptor another
319time when the filehandle is destroyed. Normally, you can safely call perls
320C<close> or just let filehandles go out of scope.
321 324
322This 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
323therefore best to avoid this function. 326closing the file descriptor associated with the filehandle itself.
324 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
325 336
326=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 337=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
327 338
328=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
329 340
330Reads 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>
331into 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
332callback 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
333like the syscall). 344like the syscall).
334 345
346If C<$offset> is undefined, then the current file descriptor offset will
347be used (and updated), otherwise the file descriptor offset will not be
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>.
354
335The 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
336is outstanding. Modifying it can result in segfaults or WW3 (if the 356is outstanding. Modifying it can result in segfaults or World War III (if
337necessary/optional hardware is installed). 357the necessary/optional hardware is installed).
338 358
339Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 359Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
340offset C<0> within the scalar: 360offset C<0> within the scalar:
341 361
342 aio_read $fh, 7, 15, $buffer, 0, sub { 362 aio_read $fh, 7, 15, $buffer, 0, sub {
417utime(2). If called on a file descriptor, uses futimes(2) if available, 437utime(2). If called on a file descriptor, uses futimes(2) if available,
418otherwise returns ENOSYS, so this is not portable. 438otherwise returns ENOSYS, so this is not portable.
419 439
420Examples: 440Examples:
421 441
422 # set atime and mtime to current time: 442 # set atime and mtime to current time (basically touch(1)):
423 aio_utime "path", undef, undef; 443 aio_utime "path", undef, undef;
424 # set atime to current time and mtime to beginning of the epoch: 444 # set atime to current time and mtime to beginning of the epoch:
425 aio_utime "path", time, undef; # undef==0 445 aio_utime "path", time, undef; # undef==0
426 446
427 447
436 aio_chown "path", 0, -1; 456 aio_chown "path", 0, -1;
437 # same as above: 457 # same as above:
438 aio_chown "path", 0, undef; 458 aio_chown "path", 0, undef;
439 459
440 460
461=item aio_truncate $fh_or_path, $offset, $callback->($status)
462
463Works like truncate(2) or ftruncate(2).
464
465
441=item aio_chmod $fh_or_path, $mode, $callback->($status) 466=item aio_chmod $fh_or_path, $mode, $callback->($status)
442 467
443Works like perl's C<chmod> function. 468Works like perl's C<chmod> function.
444 469
445 470
514memory. Status is the same as with aio_read. 539memory. Status is the same as with aio_read.
515 540
516=cut 541=cut
517 542
518sub aio_load($$;$) { 543sub aio_load($$;$) {
519 aio_block {
520 my ($path, undef, $cb) = @_; 544 my ($path, undef, $cb) = @_;
521 my $data = \$_[1]; 545 my $data = \$_[1];
522 546
523 my $pri = aioreq_pri; 547 my $pri = aioreq_pri;
524 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);
525 554
526 aioreq_pri $pri; 555 aioreq_pri $pri;
527 add $grp aio_open $path, O_RDONLY, 0, sub {
528 my $fh = shift
529 or return $grp->result (-1);
530
531 aioreq_pri $pri;
532 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 556 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
533 $grp->result ($_[0]); 557 $grp->result ($_[0]);
534 };
535 }; 558 };
536
537 $grp
538 } 559 };
560
561 $grp
539} 562}
540 563
541=item aio_copy $srcpath, $dstpath, $callback->($status) 564=item aio_copy $srcpath, $dstpath, $callback->($status)
542 565
543Try 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
544destination) from C<$srcpath> to C<$dstpath> and call the callback with 567destination) from C<$srcpath> to C<$dstpath> and call the callback with
545the C<0> (error) or C<-1> ok. 568the C<0> (error) or C<-1> ok.
546 569
547This is a composite request that it creates the destination file with 570This is a composite request that creates the destination file with
548mode 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
549C<aio_sendfile>, followed by restoring atime, mtime, access mode and 572C<aio_sendfile>, followed by restoring atime, mtime, access mode and
550uid/gid, in that order. 573uid/gid, in that order.
551 574
552If an error occurs, the partial destination file will be unlinked, if 575If an error occurs, the partial destination file will be unlinked, if
554errors are being ignored. 577errors are being ignored.
555 578
556=cut 579=cut
557 580
558sub aio_copy($$;$) { 581sub aio_copy($$;$) {
559 aio_block {
560 my ($src, $dst, $cb) = @_; 582 my ($src, $dst, $cb) = @_;
561 583
562 my $pri = aioreq_pri; 584 my $pri = aioreq_pri;
563 my $grp = aio_group $cb; 585 my $grp = aio_group $cb;
564 586
565 aioreq_pri $pri; 587 aioreq_pri $pri;
566 add $grp aio_open $src, O_RDONLY, 0, sub { 588 add $grp aio_open $src, O_RDONLY, 0, sub {
567 if (my $src_fh = $_[0]) { 589 if (my $src_fh = $_[0]) {
568 my @stat = stat $src_fh; 590 my @stat = stat $src_fh;
569 591
570 aioreq_pri $pri; 592 aioreq_pri $pri;
571 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 {
572 if (my $dst_fh = $_[0]) { 594 if (my $dst_fh = $_[0]) {
573 aioreq_pri $pri; 595 aioreq_pri $pri;
574 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 {
575 if ($_[0] == $stat[7]) { 597 if ($_[0] == $stat[7]) {
576 $grp->result (0); 598 $grp->result (0);
577 close $src_fh; 599 close $src_fh;
578 600
579 # those should not normally block. should. should. 601 # those should not normally block. should. should.
580 utime $stat[8], $stat[9], $dst; 602 utime $stat[8], $stat[9], $dst;
581 chmod $stat[2] & 07777, $dst_fh; 603 chmod $stat[2] & 07777, $dst_fh;
582 chown $stat[4], $stat[5], $dst_fh; 604 chown $stat[4], $stat[5], $dst_fh;
605
606 aioreq_pri $pri;
583 close $dst_fh; 607 add $grp aio_close $dst_fh;
584 } else { 608 } else {
585 $grp->result (-1); 609 $grp->result (-1);
586 close $src_fh; 610 close $src_fh;
587 close $dst_fh; 611 close $dst_fh;
588 612
589 aioreq $pri; 613 aioreq $pri;
590 add $grp aio_unlink $dst; 614 add $grp aio_unlink $dst;
591 }
592 }; 615 }
593 } else {
594 $grp->result (-1);
595 } 616 };
617 } else {
618 $grp->result (-1);
596 }, 619 }
597
598 } else {
599 $grp->result (-1);
600 } 620 },
621
622 } else {
623 $grp->result (-1);
601 }; 624 }
602
603 $grp
604 } 625 };
626
627 $grp
605} 628}
606 629
607=item aio_move $srcpath, $dstpath, $callback->($status) 630=item aio_move $srcpath, $dstpath, $callback->($status)
608 631
609Try 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
615that is successful, unlinking the C<$srcpath>. 638that is successful, unlinking the C<$srcpath>.
616 639
617=cut 640=cut
618 641
619sub aio_move($$;$) { 642sub aio_move($$;$) {
620 aio_block {
621 my ($src, $dst, $cb) = @_; 643 my ($src, $dst, $cb) = @_;
622 644
623 my $pri = aioreq_pri; 645 my $pri = aioreq_pri;
624 my $grp = aio_group $cb; 646 my $grp = aio_group $cb;
625 647
626 aioreq_pri $pri; 648 aioreq_pri $pri;
627 add $grp aio_rename $src, $dst, sub { 649 add $grp aio_rename $src, $dst, sub {
628 if ($_[0] && $! == EXDEV) { 650 if ($_[0] && $! == EXDEV) {
629 aioreq_pri $pri; 651 aioreq_pri $pri;
630 add $grp aio_copy $src, $dst, sub { 652 add $grp aio_copy $src, $dst, sub {
631 $grp->result ($_[0]);
632
633 if (!$_[0]) {
634 aioreq_pri $pri;
635 add $grp aio_unlink $src;
636 }
637 };
638 } else {
639 $grp->result ($_[0]); 653 $grp->result ($_[0]);
654
655 if (!$_[0]) {
656 aioreq_pri $pri;
657 add $grp aio_unlink $src;
658 }
640 } 659 };
660 } else {
661 $grp->result ($_[0]);
641 }; 662 }
642
643 $grp
644 } 663 };
664
665 $grp
645} 666}
646 667
647=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 668=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
648 669
649Scans a directory (similar to C<aio_readdir>) but additionally tries to 670Scans a directory (similar to C<aio_readdir>) but additionally tries to
697directory counting heuristic. 718directory counting heuristic.
698 719
699=cut 720=cut
700 721
701sub aio_scandir($$;$) { 722sub aio_scandir($$;$) {
702 aio_block {
703 my ($path, $maxreq, $cb) = @_; 723 my ($path, $maxreq, $cb) = @_;
704 724
705 my $pri = aioreq_pri; 725 my $pri = aioreq_pri;
706 726
707 my $grp = aio_group $cb; 727 my $grp = aio_group $cb;
708 728
709 $maxreq = 4 if $maxreq <= 0; 729 $maxreq = 4 if $maxreq <= 0;
710 730
711 # 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
712 aioreq_pri $pri; 739 aioreq_pri $pri;
713 add $grp aio_stat $path, sub { 740 add $grp aio_readdir $path, sub {
741 my $entries = shift
714 return $grp->result () if $_[0]; 742 or return $grp->result ();
715 my $now = time;
716 my $hash1 = join ":", (stat _)[0,1,3,7,9];
717 743
718 # read the directory entries 744 # stat the dir another time
719 aioreq_pri $pri; 745 aioreq_pri $pri;
720 add $grp aio_readdir $path, sub {
721 my $entries = shift
722 or return $grp->result ();
723
724 # stat the dir another time
725 aioreq_pri $pri;
726 add $grp aio_stat $path, sub { 746 add $grp aio_stat $path, sub {
727 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 747 my $hash2 = join ":", (stat _)[0,1,3,7,9];
728 748
729 my $ndirs; 749 my $ndirs;
730 750
731 # take the slow route if anything looks fishy 751 # take the slow route if anything looks fishy
732 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 752 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
733 $ndirs = -1; 753 $ndirs = -1;
734 } else { 754 } else {
735 # if nlink == 2, we are finished 755 # if nlink == 2, we are finished
736 # on non-posix-fs's, we rely on nlink < 2 756 # on non-posix-fs's, we rely on nlink < 2
737 $ndirs = (stat _)[3] - 2 757 $ndirs = (stat _)[3] - 2
738 or return $grp->result ([], $entries); 758 or return $grp->result ([], $entries);
739 } 759 }
740 760
741 # sort into likely dirs and likely nondirs 761 # sort into likely dirs and likely nondirs
742 # dirs == files without ".", short entries first 762 # dirs == files without ".", short entries first
743 $entries = [map $_->[0], 763 $entries = [map $_->[0],
744 sort { $b->[1] cmp $a->[1] } 764 sort { $b->[1] cmp $a->[1] }
745 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 765 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
746 @$entries]; 766 @$entries];
747 767
748 my (@dirs, @nondirs); 768 my (@dirs, @nondirs);
749 769
750 my $statgrp = add $grp aio_group sub { 770 my $statgrp = add $grp aio_group sub {
751 $grp->result (\@dirs, \@nondirs); 771 $grp->result (\@dirs, \@nondirs);
752 }; 772 };
753 773
754 limit $statgrp $maxreq; 774 limit $statgrp $maxreq;
755 feed $statgrp sub { 775 feed $statgrp sub {
756 return unless @$entries; 776 return unless @$entries;
757 my $entry = pop @$entries; 777 my $entry = pop @$entries;
758 778
759 aioreq_pri $pri; 779 aioreq_pri $pri;
760 add $statgrp aio_stat "$path/$entry/.", sub { 780 add $statgrp aio_stat "$path/$entry/.", sub {
761 if ($_[0] < 0) { 781 if ($_[0] < 0) {
762 push @nondirs, $entry; 782 push @nondirs, $entry;
763 } else { 783 } else {
764 # need to check for real directory 784 # need to check for real directory
765 aioreq_pri $pri; 785 aioreq_pri $pri;
766 add $statgrp aio_lstat "$path/$entry", sub { 786 add $statgrp aio_lstat "$path/$entry", sub {
767 if (-d _) { 787 if (-d _) {
768 push @dirs, $entry; 788 push @dirs, $entry;
769 789
770 unless (--$ndirs) { 790 unless (--$ndirs) {
771 push @nondirs, @$entries; 791 push @nondirs, @$entries;
772 feed $statgrp; 792 feed $statgrp;
773 }
774 } else {
775 push @nondirs, $entry;
776 } 793 }
794 } else {
795 push @nondirs, $entry;
777 } 796 }
778 } 797 }
779 }; 798 }
780 }; 799 };
781 }; 800 };
782 }; 801 };
783 }; 802 };
784
785 $grp
786 } 803 };
804
805 $grp
787} 806}
788 807
789=item aio_rmtree $path, $callback->($status) 808=item aio_rmtree $path, $callback->($status)
790 809
791Delete a directory tree starting (and including) C<$path>, return the 810Delete a directory tree starting (and including) C<$path>, return the
795 814
796=cut 815=cut
797 816
798sub aio_rmtree; 817sub aio_rmtree;
799sub aio_rmtree($;$) { 818sub aio_rmtree($;$) {
800 aio_block {
801 my ($path, $cb) = @_; 819 my ($path, $cb) = @_;
802 820
803 my $pri = aioreq_pri; 821 my $pri = aioreq_pri;
804 my $grp = aio_group $cb; 822 my $grp = aio_group $cb;
805 823
806 aioreq_pri $pri; 824 aioreq_pri $pri;
807 add $grp aio_scandir $path, 0, sub { 825 add $grp aio_scandir $path, 0, sub {
808 my ($dirs, $nondirs) = @_; 826 my ($dirs, $nondirs) = @_;
809 827
810 my $dirgrp = aio_group sub { 828 my $dirgrp = aio_group sub {
811 add $grp aio_rmdir $path, sub { 829 add $grp aio_rmdir $path, sub {
812 $grp->result ($_[0]); 830 $grp->result ($_[0]);
813 };
814 }; 831 };
815
816 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
817 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
818
819 add $grp $dirgrp;
820 }; 832 };
821 833
822 $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;
823 } 838 };
839
840 $grp
824} 841}
842
843=item aio_sync $callback->($status)
844
845Asynchronously call sync and call the callback when finished.
825 846
826=item aio_fsync $fh, $callback->($status) 847=item aio_fsync $fh, $callback->($status)
827 848
828Asynchronously call fsync on the given filehandle and call the callback 849Asynchronously call fsync on the given filehandle and call the callback
829with the fsync result code. 850with the fsync result code.
833Asynchronously call fdatasync on the given filehandle and call the 854Asynchronously call fdatasync on the given filehandle and call the
834callback with the fdatasync result code. 855callback with the fdatasync result code.
835 856
836If 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
837detected, it will be emulated by calling C<fsync> instead. 858detected, it will be emulated by calling C<fsync> instead.
859
860=item aio_pathsync $path, $callback->($status)
861
862This request tries to open, fsync and close the given path. This is a
863composite request intended to sync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any
865specific effect, but usually it makes sure that directory changes get
866written to disc. It works for anything that can be opened for read-only,
867not just directories.
868
869Passes C<0> when everything went ok, and C<-1> on error.
870
871=cut
872
873sub aio_pathsync($;$) {
874 my ($path, $cb) = @_;
875
876 my $pri = aioreq_pri;
877 my $grp = aio_group $cb;
878
879 aioreq_pri $pri;
880 add $grp aio_open $path, O_RDONLY, 0, sub {
881 my ($fh) = @_;
882 if ($fh) {
883 aioreq_pri $pri;
884 add $grp aio_fsync $fh, sub {
885 $grp->result ($_[0]);
886
887 aioreq_pri $pri;
888 add $grp aio_close $fh;
889 };
890 } else {
891 $grp->result (-1);
892 }
893 };
894
895 $grp
896}
838 897
839=item aio_group $callback->(...) 898=item aio_group $callback->(...)
840 899
841This is a very special aio request: Instead of doing something, it is a 900This is a very special aio request: Instead of doing something, it is a
842container for other aio requests, which is useful if you want to bundle 901container for other aio requests, which is useful if you want to bundle
954Their lifetime, simplified, looks like this: when they are empty, they 1013Their lifetime, simplified, looks like this: when they are empty, they
955will finish very quickly. If they contain only requests that are in the 1014will finish very quickly. If they contain only requests that are in the
956C<done> state, they will also finish. Otherwise they will continue to 1015C<done> state, they will also finish. Otherwise they will continue to
957exist. 1016exist.
958 1017
959That means after creating a group you have some time to add requests. And 1018That means after creating a group you have some time to add requests
960in the callbacks of those requests, you can add further requests to the 1019(precisely before the callback has been invoked, which is only done within
961group. And only when all those requests have finished will the the group 1020the C<poll_cb>). And in the callbacks of those requests, you can add
962itself finish. 1021further requests to the group. And only when all those requests have
1022finished will the the group itself finish.
963 1023
964=over 4 1024=over 4
965 1025
966=item add $grp ... 1026=item add $grp ...
967 1027
979itself. Useful when you queued a lot of events but got a result early. 1039itself. Useful when you queued a lot of events but got a result early.
980 1040
981=item $grp->result (...) 1041=item $grp->result (...)
982 1042
983Set the result value(s) that will be passed to the group callback when all 1043Set the result value(s) that will be passed to the group callback when all
984subrequests have finished and set thre groups errno to the current value 1044subrequests have finished and set the groups errno to the current value
985of errno (just like calling C<errno> without an error number). By default, 1045of errno (just like calling C<errno> without an error number). By default,
986no argument will be passed and errno is zero. 1046no argument will be passed and errno is zero.
987 1047
988=item $grp->errno ([$errno]) 1048=item $grp->errno ([$errno])
989 1049
1058See C<poll_cb> for an example. 1118See C<poll_cb> for an example.
1059 1119
1060=item IO::AIO::poll_cb 1120=item IO::AIO::poll_cb
1061 1121
1062Process some outstanding events on the result pipe. You have to call this 1122Process some outstanding events on the result pipe. You have to call this
1063regularly. Returns the number of events processed. Returns immediately 1123regularly. Returns C<0> if all events could be processed, or C<-1> if it
1124returned earlier for whatever reason. Returns immediately when no events
1064when no events are outstanding. The amount of events processed depends on 1125are outstanding. The amount of events processed depends on the settings of
1065the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1126C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1066 1127
1067If not all requests were processed for whatever reason, the filehandle 1128If not all requests were processed for whatever reason, the filehandle
1068will still be ready when C<poll_cb> returns. 1129will still be ready when C<poll_cb> returns, so normally you don't have to
1130do anything special to have it called later.
1069 1131
1070Example: Install an Event watcher that automatically calls 1132Example: Install an Event watcher that automatically calls
1071IO::AIO::poll_cb with high priority: 1133IO::AIO::poll_cb with high priority:
1072 1134
1073 Event->io (fd => IO::AIO::poll_fileno, 1135 Event->io (fd => IO::AIO::poll_fileno,
1187 1249
1188The default is probably ok in most situations, especially if thread 1250The default is probably ok in most situations, especially if thread
1189creation is fast. If thread creation is very slow on your system you might 1251creation is fast. If thread creation is very slow on your system you might
1190want to use larger values. 1252want to use larger values.
1191 1253
1192=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1254=item IO::AIO::max_outstanding $maxreqs
1193 1255
1194This is a very bad function to use in interactive programs because it 1256This is a very bad function to use in interactive programs because it
1195blocks, and a bad way to reduce concurrency because it is inexact: Better 1257blocks, and a bad way to reduce concurrency because it is inexact: Better
1196use an C<aio_group> together with a feed callback. 1258use an C<aio_group> together with a feed callback.
1197 1259
1198Sets the maximum number of outstanding requests to C<$nreqs>. If you 1260Sets the maximum number of outstanding requests to C<$nreqs>. If you
1199to queue up more than this number of requests, the next call to the 1261do queue up more than this number of requests, the next call to the
1200C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1262C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1201function will block until the limit is no longer exceeded. 1263function will block until the limit is no longer exceeded.
1202 1264
1203The default value is very large, so there is no practical limit on the 1265The default value is very large, so there is no practical limit on the
1204number of outstanding requests. 1266number of outstanding requests.
1205 1267
1206You can still queue as many requests as you want. Therefore, 1268You can still queue as many requests as you want. Therefore,
1207C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1269C<max_outstanding> is mainly useful in simple scripts (with low values) or
1208as a stop gap to shield against fatal memory overflow (with large values). 1270as a stop gap to shield against fatal memory overflow (with large values).
1209 1271
1210=back 1272=back
1211 1273
1212=head3 STATISTICAL INFORMATION 1274=head3 STATISTICAL INFORMATION
1234but not yet processed by poll_cb). 1296but not yet processed by poll_cb).
1235 1297
1236=back 1298=back
1237 1299
1238=cut 1300=cut
1239
1240# support function to convert a fd into a perl filehandle
1241sub _fd2fh {
1242 return undef if $_[0] < 0;
1243
1244 # try to generate nice filehandles
1245 my $sym = "IO::AIO::fd#$_[0]";
1246 local *$sym;
1247
1248 open *$sym, "+<&=$_[0]" # usually works under any unix
1249 or open *$sym, "<&=$_[0]" # cygwin needs this
1250 or open *$sym, ">&=$_[0]" # or this
1251 or return undef;
1252
1253 *$sym
1254}
1255 1301
1256min_parallel 8; 1302min_parallel 8;
1257 1303
1258END { flush } 1304END { flush }
1259 1305
1283bytes of memory. In addition, stat requests need a stat buffer (possibly 1329bytes of memory. In addition, stat requests need a stat buffer (possibly
1284a few hundred bytes), readdir requires a result buffer and so on. Perl 1330a few hundred bytes), readdir requires a result buffer and so on. Perl
1285scalars and other data passed into aio requests will also be locked and 1331scalars and other data passed into aio requests will also be locked and
1286will consume memory till the request has entered the done state. 1332will consume memory till the request has entered the done state.
1287 1333
1288This is now awfully much, so queuing lots of requests is not usually a 1334This is not awfully much, so queuing lots of requests is not usually a
1289problem. 1335problem.
1290 1336
1291Per-thread usage: 1337Per-thread usage:
1292 1338
1293In the execution phase, some aio requests require more memory for 1339In the execution phase, some aio requests require more memory for
1298 1344
1299Known bugs will be fixed in the next release. 1345Known bugs will be fixed in the next release.
1300 1346
1301=head1 SEE ALSO 1347=head1 SEE ALSO
1302 1348
1303L<Coro::AIO>. 1349L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1350more natural syntax.
1304 1351
1305=head1 AUTHOR 1352=head1 AUTHOR
1306 1353
1307 Marc Lehmann <schmorp@schmorp.de> 1354 Marc Lehmann <schmorp@schmorp.de>
1308 http://home.schmorp.de/ 1355 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines