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.88 by root, Sun Oct 29 01:50:29 2006 UTC vs.
Revision 1.97 by root, Sat Dec 23 04:49:37 2006 UTC

… …
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", O_RDONLY, 0, sub {
10 my ($fh) = @_; 10 my $fh = shift
11 or die "/etc/passwd: $!";
11 ... 12 ...
12 }; 13 };
13 14
14 aio_unlink "/tmp/file", sub { }; 15 aio_unlink "/tmp/file", sub { };
15 16
… …
61etc.), but can also be used to easily do operations in parallel that are 62etc.), but can also be used to easily do operations in parallel that are
62normally done sequentially, e.g. stat'ing many files, which is much faster 63normally done sequentially, e.g. stat'ing many files, which is much faster
63on a RAID volume or over NFS when you do a number of stat operations 64on a RAID volume or over NFS when you do a number of stat operations
64concurrently. 65concurrently.
65 66
66While this works on all types of file descriptors (for example sockets), 67While most of this works on all types of file descriptors (for example
67using these functions on file descriptors that support nonblocking 68sockets), using these functions on file descriptors that support
68operation (again, sockets, pipes etc.) is very inefficient. Use an event 69nonblocking operation (again, sockets, pipes etc.) is very inefficient or
70might not work (aio_read fails on sockets/pipes/fifos). Use an event loop
69loop for that (such as the L<Event|Event> module): IO::AIO will naturally 71for that (such as the L<Event|Event> module): IO::AIO will naturally fit
70fit into such an event loop itself. 72into such an event loop itself.
71 73
72In this version, a number of threads are started that execute your 74In this version, a number of threads are started that execute your
73requests and signal their completion. You don't need thread support 75requests and signal their completion. You don't need thread support
74in perl, and the threads created by this module will not be visible 76in perl, and the threads created by this module will not be visible
75to perl. In the future, this module might make use of the native aio 77to perl. In the future, this module might make use of the native aio
… …
98 poll => 'r', 100 poll => 'r',
99 cb => \&IO::AIO::poll_cb); 101 cb => \&IO::AIO::poll_cb);
100 102
101 # queue the request to open /etc/passwd 103 # queue the request to open /etc/passwd
102 aio_open "/etc/passwd", O_RDONLY, 0, sub { 104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
103 my $fh = $_[0] 105 my $fh = shift
104 or die "error while opening: $!"; 106 or die "error while opening: $!";
105 107
106 # stat'ing filehandles is generally non-blocking 108 # stat'ing filehandles is generally non-blocking
107 my $size = -s $fh; 109 my $size = -s $fh;
108 110
… …
188use strict 'vars'; 190use strict 'vars';
189 191
190use base 'Exporter'; 192use base 'Exporter';
191 193
192BEGIN { 194BEGIN {
193 our $VERSION = '2.1'; 195 our $VERSION = '2.3';
194 196
195 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
196 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
197 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
198 aio_copy aio_group aio_nop aio_mknod); 200 aio_move aio_copy aio_group aio_nop aio_mknod);
199 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
200 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
201 min_parallel max_parallel max_idle 203 min_parallel max_parallel max_idle
202 nreqs nready npending nthreads 204 nreqs nready npending nthreads
203 max_poll_time max_poll_reqs); 205 max_poll_time max_poll_reqs);
204 206
… …
417=item aio_symlink $srcpath, $dstpath, $callback->($status) 419=item aio_symlink $srcpath, $dstpath, $callback->($status)
418 420
419Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 421Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
420the path C<$dstpath> and call the callback with the result code. 422the path C<$dstpath> and call the callback with the result code.
421 423
424=item aio_readlink $path, $callback->($link)
425
426Asynchronously read the symlink specified by C<$path> and pass it to
427the callback. If an error occurs, nothing or undef gets passed to the
428callback.
429
422=item aio_rename $srcpath, $dstpath, $callback->($status) 430=item aio_rename $srcpath, $dstpath, $callback->($status)
423 431
424Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 432Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
425rename(2) and call the callback with the result code. 433rename(2) and call the callback with the result code.
426 434
… …
454errors are being ignored. 462errors are being ignored.
455 463
456=cut 464=cut
457 465
458sub aio_copy($$;$) { 466sub aio_copy($$;$) {
467 aio_block {
459 my ($src, $dst, $cb) = @_; 468 my ($src, $dst, $cb) = @_;
460 469
461 my $pri = aioreq_pri; 470 my $pri = aioreq_pri;
462 my $grp = aio_group $cb; 471 my $grp = aio_group $cb;
463 472
464 aioreq_pri $pri; 473 aioreq_pri $pri;
465 add $grp aio_open $src, O_RDONLY, 0, sub { 474 add $grp aio_open $src, O_RDONLY, 0, sub {
466 if (my $src_fh = $_[0]) { 475 if (my $src_fh = $_[0]) {
467 my @stat = stat $src_fh; 476 my @stat = stat $src_fh;
468 477
469 aioreq_pri $pri; 478 aioreq_pri $pri;
470 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 479 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
471 if (my $dst_fh = $_[0]) { 480 if (my $dst_fh = $_[0]) {
472 aioreq_pri $pri; 481 aioreq_pri $pri;
473 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 482 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
474 if ($_[0] == $stat[7]) { 483 if ($_[0] == $stat[7]) {
475 $grp->result (0); 484 $grp->result (0);
476 close $src_fh; 485 close $src_fh;
477 486
478 # those should not normally block. should. should. 487 # those should not normally block. should. should.
479 utime $stat[8], $stat[9], $dst; 488 utime $stat[8], $stat[9], $dst;
480 chmod $stat[2] & 07777, $dst_fh; 489 chmod $stat[2] & 07777, $dst_fh;
481 chown $stat[4], $stat[5], $dst_fh; 490 chown $stat[4], $stat[5], $dst_fh;
482 close $dst_fh; 491 close $dst_fh;
483 } else { 492 } else {
484 $grp->result (-1); 493 $grp->result (-1);
485 close $src_fh; 494 close $src_fh;
486 close $dst_fh; 495 close $dst_fh;
487 496
488 aioreq $pri; 497 aioreq $pri;
489 add $grp aio_unlink $dst; 498 add $grp aio_unlink $dst;
499 }
490 } 500 };
501 } else {
502 $grp->result (-1);
491 }; 503 }
492 } else {
493 $grp->result (-1);
494 } 504 },
505
506 } else {
507 $grp->result (-1);
495 }, 508 }
496
497 } else {
498 $grp->result (-1);
499 } 509 };
510
511 $grp
500 }; 512 }
501
502 $grp
503} 513}
504 514
505=item aio_move $srcpath, $dstpath, $callback->($status) 515=item aio_move $srcpath, $dstpath, $callback->($status)
506 516
507Try to move the I<file> (directories not supported as either source or 517Try to move the I<file> (directories not supported as either source or
… …
513that is successful, unlinking the C<$srcpath>. 523that is successful, unlinking the C<$srcpath>.
514 524
515=cut 525=cut
516 526
517sub aio_move($$;$) { 527sub aio_move($$;$) {
528 aio_block {
518 my ($src, $dst, $cb) = @_; 529 my ($src, $dst, $cb) = @_;
519 530
520 my $pri = aioreq_pri; 531 my $pri = aioreq_pri;
521 my $grp = aio_group $cb; 532 my $grp = aio_group $cb;
522 533
523 aioreq_pri $pri; 534 aioreq_pri $pri;
524 add $grp aio_rename $src, $dst, sub { 535 add $grp aio_rename $src, $dst, sub {
525 if ($_[0] && $! == EXDEV) { 536 if ($_[0] && $! == EXDEV) {
526 aioreq_pri $pri; 537 aioreq_pri $pri;
527 add $grp aio_copy $src, $dst, sub { 538 add $grp aio_copy $src, $dst, sub {
539 $grp->result ($_[0]);
540
541 if (!$_[0]) {
542 aioreq_pri $pri;
543 add $grp aio_unlink $src;
544 }
545 };
546 } else {
528 $grp->result ($_[0]); 547 $grp->result ($_[0]);
529
530 if (!$_[0]) {
531 aioreq_pri $pri;
532 add $grp aio_unlink $src;
533 }
534 }; 548 }
535 } else {
536 $grp->result ($_[0]);
537 } 549 };
550
551 $grp
538 }; 552 }
539
540 $grp
541} 553}
542 554
543=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 555=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
544 556
545Scans a directory (similar to C<aio_readdir>) but additionally tries to 557Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
593directory counting heuristic. 605directory counting heuristic.
594 606
595=cut 607=cut
596 608
597sub aio_scandir($$$) { 609sub aio_scandir($$$) {
610 aio_block {
598 my ($path, $maxreq, $cb) = @_; 611 my ($path, $maxreq, $cb) = @_;
599 612
600 my $pri = aioreq_pri; 613 my $pri = aioreq_pri;
601 614
602 my $grp = aio_group $cb; 615 my $grp = aio_group $cb;
603 616
604 $maxreq = 4 if $maxreq <= 0; 617 $maxreq = 4 if $maxreq <= 0;
605 618
606 # stat once 619 # stat once
607 aioreq_pri $pri;
608 add $grp aio_stat $path, sub {
609 return $grp->result () if $_[0];
610 my $now = time;
611 my $hash1 = join ":", (stat _)[0,1,3,7,9];
612
613 # read the directory entries
614 aioreq_pri $pri; 620 aioreq_pri $pri;
615 add $grp aio_readdir $path, sub { 621 add $grp aio_stat $path, sub {
616 my $entries = shift
617 or return $grp->result (); 622 return $grp->result () if $_[0];
623 my $now = time;
624 my $hash1 = join ":", (stat _)[0,1,3,7,9];
618 625
619 # stat the dir another time 626 # read the directory entries
620 aioreq_pri $pri; 627 aioreq_pri $pri;
628 add $grp aio_readdir $path, sub {
629 my $entries = shift
630 or return $grp->result ();
631
632 # stat the dir another time
633 aioreq_pri $pri;
621 add $grp aio_stat $path, sub { 634 add $grp aio_stat $path, sub {
622 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 635 my $hash2 = join ":", (stat _)[0,1,3,7,9];
623 636
624 my $ndirs; 637 my $ndirs;
625 638
626 # take the slow route if anything looks fishy 639 # take the slow route if anything looks fishy
627 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 640 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
628 $ndirs = -1; 641 $ndirs = -1;
629 } else { 642 } else {
630 # if nlink == 2, we are finished 643 # if nlink == 2, we are finished
631 # on non-posix-fs's, we rely on nlink < 2 644 # on non-posix-fs's, we rely on nlink < 2
632 $ndirs = (stat _)[3] - 2 645 $ndirs = (stat _)[3] - 2
633 or return $grp->result ([], $entries); 646 or return $grp->result ([], $entries);
634 } 647 }
635 648
636 # sort into likely dirs and likely nondirs 649 # sort into likely dirs and likely nondirs
637 # dirs == files without ".", short entries first 650 # dirs == files without ".", short entries first
638 $entries = [map $_->[0], 651 $entries = [map $_->[0],
639 sort { $b->[1] cmp $a->[1] } 652 sort { $b->[1] cmp $a->[1] }
640 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 653 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
641 @$entries]; 654 @$entries];
642 655
643 my (@dirs, @nondirs); 656 my (@dirs, @nondirs);
644 657
645 my $statgrp = add $grp aio_group sub { 658 my $statgrp = add $grp aio_group sub {
646 $grp->result (\@dirs, \@nondirs); 659 $grp->result (\@dirs, \@nondirs);
647 }; 660 };
648 661
649 limit $statgrp $maxreq; 662 limit $statgrp $maxreq;
650 feed $statgrp sub { 663 feed $statgrp sub {
651 return unless @$entries; 664 return unless @$entries;
652 my $entry = pop @$entries; 665 my $entry = pop @$entries;
653 666
654 aioreq_pri $pri; 667 aioreq_pri $pri;
655 add $statgrp aio_stat "$path/$entry/.", sub { 668 add $statgrp aio_stat "$path/$entry/.", sub {
656 if ($_[0] < 0) { 669 if ($_[0] < 0) {
657 push @nondirs, $entry; 670 push @nondirs, $entry;
658 } else { 671 } else {
659 # need to check for real directory 672 # need to check for real directory
660 aioreq_pri $pri; 673 aioreq_pri $pri;
661 add $statgrp aio_lstat "$path/$entry", sub { 674 add $statgrp aio_lstat "$path/$entry", sub {
662 if (-d _) { 675 if (-d _) {
663 push @dirs, $entry; 676 push @dirs, $entry;
664 677
665 unless (--$ndirs) { 678 unless (--$ndirs) {
666 push @nondirs, @$entries; 679 push @nondirs, @$entries;
667 feed $statgrp; 680 feed $statgrp;
681 }
682 } else {
683 push @nondirs, $entry;
668 } 684 }
669 } else {
670 push @nondirs, $entry;
671 } 685 }
672 } 686 }
673 } 687 };
674 }; 688 };
675 }; 689 };
676 }; 690 };
677 }; 691 };
692
693 $grp
678 }; 694 }
679
680 $grp
681} 695}
682 696
683=item aio_fsync $fh, $callback->($status) 697=item aio_fsync $fh, $callback->($status)
684 698
685Asynchronously call fsync on the given filehandle and call the callback 699Asynchronously call fsync on the given filehandle and call the callback
… …
939that are being processed by C<IO::AIO::poll_cb> in one call, respectively 953that are being processed by C<IO::AIO::poll_cb> in one call, respectively
940the maximum amount of time (default C<0>, meaning infinity) spent in 954the maximum amount of time (default C<0>, meaning infinity) spent in
941C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount 955C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
942of time C<poll_cb> is allowed to use). 956of time C<poll_cb> is allowed to use).
943 957
958Setting C<max_poll_time> to a non-zero value creates an overhead of one
959syscall per request processed, which is not normally a problem unless your
960callbacks are really really fast or your OS is really really slow (I am
961not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
962
944Setting these is useful if you want to ensure some level of 963Setting these is useful if you want to ensure some level of
945interactiveness when perl is not fast enough to process all requests in 964interactiveness when perl is not fast enough to process all requests in
946time. 965time.
947 966
948For interactive programs, values such as C<0.01> to C<0.1> should be fine. 967For interactive programs, values such as C<0.01> to C<0.1> should be fine.
949 968
950Example: Install an Event watcher that automatically calls 969Example: Install an Event watcher that automatically calls
951IO::AIO::poll_some with low priority, to ensure that other parts of the 970IO::AIO::poll_cb with low priority, to ensure that other parts of the
952program get the CPU sometimes even under high AIO load. 971program get the CPU sometimes even under high AIO load.
953 972
954 # try not to spend much more than 0.1s in poll_cb 973 # try not to spend much more than 0.1s in poll_cb
955 IO::AIO::max_poll_time 0.1; 974 IO::AIO::max_poll_time 0.1;
956 975
… …
959 poll => 'r', nice => 1, 978 poll => 'r', nice => 1,
960 cb => &IO::AIO::poll_cb); 979 cb => &IO::AIO::poll_cb);
961 980
962=item IO::AIO::poll_wait 981=item IO::AIO::poll_wait
963 982
983If there are any outstanding requests and none of them in the result
964Wait till the result filehandle becomes ready for reading (simply does a 984phase, wait till the result filehandle becomes ready for reading (simply
965C<select> on the filehandle. This is useful if you want to synchronously 985does a C<select> on the filehandle. This is useful if you want to
966wait for some requests to finish). 986synchronously wait for some requests to finish).
967 987
968See C<nreqs> for an example. 988See C<nreqs> for an example.
969 989
970=item IO::AIO::poll 990=item IO::AIO::poll
971 991
972Waits until some requests have been handled. 992Waits until some requests have been handled.
973 993
994Returns the number of requests processed, but is otherwise strictly
974Strictly equivalent to: 995equivalent to:
975 996
976 IO::AIO::poll_wait, IO::AIO::poll_cb 997 IO::AIO::poll_wait, IO::AIO::poll_cb
977 if IO::AIO::nreqs;
978 998
979=item IO::AIO::flush 999=item IO::AIO::flush
980 1000
981Wait till all outstanding AIO requests have been handled. 1001Wait till all outstanding AIO requests have been handled.
982 1002
… …
1096 *$sym 1116 *$sym
1097} 1117}
1098 1118
1099min_parallel 8; 1119min_parallel 8;
1100 1120
1101END { 1121END { flush }
1102 min_parallel 1;
1103 flush;
1104};
1105 1122
11061; 11231;
1107 1124
1108=head2 FORK BEHAVIOUR 1125=head2 FORK BEHAVIOUR
1109 1126

Diff Legend

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