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.56 by root, Sun Oct 22 00:53:47 2006 UTC vs.
Revision 1.68 by root, Tue Oct 24 03:17:39 2006 UTC

18 }; 18 };
19 19
20 # version 2+ has request and group objects 20 # version 2+ has request and group objects
21 use IO::AIO 2; 21 use IO::AIO 2;
22 22
23 aioreq_pri 4; # give next request a very high priority
23 my $req = aio_unlink "/tmp/file", sub { }; 24 my $req = aio_unlink "/tmp/file", sub { };
24 $req->cancel; # cancel request if still in queue 25 $req->cancel; # cancel request if still in queue
25 26
26 my $grp = aio_group sub { print "all stats done\n" }; 27 my $grp = aio_group sub { print "all stats done\n" };
27 add $grp aio_stat "..." for ...; 28 add $grp aio_stat "..." for ...;
51 52
52This module implements asynchronous I/O using whatever means your 53This module implements asynchronous I/O using whatever means your
53operating system supports. 54operating system supports.
54 55
55Currently, a number of threads are started that execute your read/writes 56Currently, a number of threads are started that execute your read/writes
56and signal their completion. You don't need thread support in your libc or 57and signal their completion. You don't need thread support in perl, and
57perl, and the threads created by this module will not be visible to the 58the threads created by this module will not be visible to perl. In the
58pthreads library. In the future, this module might make use of the native 59future, this module might make use of the native aio functions available
59aio functions available on many operating systems. However, they are often 60on many operating systems. However, they are often not well-supported
60not well-supported (Linux doesn't allow them on normal files currently, 61(Linux doesn't allow them on normal files currently, for example),
61for example), and they would only support aio_read and aio_write, so the 62and they would only support aio_read and aio_write, so the remaining
62remaining functionality would have to be implemented using threads anyway. 63functionality would have to be implemented using threads anyway.
63 64
64Although the module will work with in the presence of other threads, it is 65Although the module will work with in the presence of other threads,
65currently not reentrant, so use appropriate locking yourself, always call 66it is currently not reentrant in any way, so use appropriate locking
66C<poll_cb> from within the same thread, or never call C<poll_cb> (or other 67yourself, always call C<poll_cb> from within the same thread, or never
67C<aio_> functions) recursively. 68call C<poll_cb> (or other C<aio_> functions) recursively.
68 69
69=cut 70=cut
70 71
71package IO::AIO; 72package IO::AIO;
72 73
76use base 'Exporter'; 77use base 'Exporter';
77 78
78BEGIN { 79BEGIN {
79 our $VERSION = '2.0'; 80 our $VERSION = '2.0';
80 81
81 our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 82 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
82 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 83 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
83 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 84 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
84 aio_group); 85 aio_group aio_nop);
85 our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); 86 our @EXPORT = (@AIO_REQ, qw(aioreq_pri));
87 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
88 min_parallel max_parallel max_outstanding nreqs);
86 89
87 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 90 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
88 91
89 require XSLoader; 92 require XSLoader;
90 XSLoader::load ("IO::AIO", $VERSION); 93 XSLoader::load ("IO::AIO", $VERSION);
120your pathnames to the locale (or other) encoding in effect in the user 123your pathnames to the locale (or other) encoding in effect in the user
121environment, d) use Glib::filename_from_unicode on unicode filenames or e) 124environment, d) use Glib::filename_from_unicode on unicode filenames or e)
122use something else. 125use something else.
123 126
124=over 4 127=over 4
128
129=item aioreq_pri $pri
130
131Sets the priority for the next aio request. The default priority
132is C<0>, the minimum and maximum priorities are C<-4> and C<4>,
133respectively. Requests with higher priority will be serviced first.
134
135The priority will be reset to C<0> after each call to one of the C<aio_>
136functions.
125 137
126=item aio_open $pathname, $flags, $mode, $callback->($fh) 138=item aio_open $pathname, $flags, $mode, $callback->($fh)
127 139
128Asynchronously open or create a file and call the callback with a newly 140Asynchronously open or create a file and call the callback with a newly
129created filehandle for the file. 141created filehandle for the file.
182 print "read $_[0] bytes: <$buffer>\n"; 194 print "read $_[0] bytes: <$buffer>\n";
183 }; 195 };
184 196
185=item aio_move $srcpath, $dstpath, $callback->($status) 197=item aio_move $srcpath, $dstpath, $callback->($status)
186 198
199[EXPERIMENTAL due to internal aio_group use]
200
187Try to move the I<file> (directories not supported as either source or 201Try to move the I<file> (directories not supported as either source or
188destination) from C<$srcpath> to C<$dstpath> and call the callback with 202destination) from C<$srcpath> to C<$dstpath> and call the callback with
189the C<0> (error) or C<-1> ok. 203the C<0> (error) or C<-1> ok.
190 204
191This is a composite request that tries to rename(2) the file first. If 205This is a composite request that tries to rename(2) the file first. If
201=cut 215=cut
202 216
203sub aio_move($$$) { 217sub aio_move($$$) {
204 my ($src, $dst, $cb) = @_; 218 my ($src, $dst, $cb) = @_;
205 219
206 my $grp = aio_group; 220 my $grp = aio_group $cb;
207 221
208 add $grp aio_rename $src, $dst, sub { 222 add $grp aio_rename $src, $dst, sub {
209 if ($_[0] && $! == EXDEV) { 223 if ($_[0] && $! == EXDEV) {
210 add $grp aio_open $src, O_RDONLY, 0, sub { 224 add $grp aio_open $src, O_RDONLY, 0, sub {
211 if (my $src_fh = $_[0]) { 225 if (my $src_fh = $_[0]) {
221 chmod $stat[2] & 07777, $dst_fh; 235 chmod $stat[2] & 07777, $dst_fh;
222 chown $stat[4], $stat[5], $dst_fh; 236 chown $stat[4], $stat[5], $dst_fh;
223 close $dst_fh; 237 close $dst_fh;
224 238
225 add $grp aio_unlink $src, sub { 239 add $grp aio_unlink $src, sub {
226 $cb->($_[0]); 240 $grp->result ($_[0]);
227 }; 241 };
228 } else { 242 } else {
229 my $errno = $!; 243 my $errno = $!;
230 add $grp aio_unlink $dst, sub { 244 add $grp aio_unlink $dst, sub {
231 $! = $errno; 245 $! = $errno;
232 $cb->(-1); 246 $grp->result (-1);
233 }; 247 };
234 } 248 }
235 }; 249 };
236 } else { 250 } else {
237 $cb->(-1); 251 $grp->result (-1);
238 } 252 }
239 }, 253 },
240 254
241 } else { 255 } else {
242 $cb->(-1); 256 $grp->result (-1);
243 } 257 }
244 }; 258 };
245 } else { 259 } else {
246 $cb->($_[0]); 260 $grp->result ($_[0]);
247 } 261 }
248 }; 262 };
249 263
250 $grp 264 $grp
251} 265}
343The callback a single argument which is either C<undef> or an array-ref 357The callback a single argument which is either C<undef> or an array-ref
344with the filenames. 358with the filenames.
345 359
346=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 360=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
347 361
362[EXPERIMENTAL due to internal aio_group use]
363
348Scans a directory (similar to C<aio_readdir>) but additionally tries to 364Scans a directory (similar to C<aio_readdir>) but additionally tries to
349separate the entries of directory C<$path> into two sets of names, ones 365separate the entries of directory C<$path> into two sets of names, ones
350you can recurse into (directories or links to them), and ones you cannot 366you can recurse into (directories or links to them), and ones you cannot
351recurse into (everything else). 367recurse into (everything else).
352 368
353C<aio_scandir> is a composite request that consists of many sub 369C<aio_scandir> is a composite request that creates of many sub requests_
354requests. C<$maxreq> specifies the maximum number of outstanding aio 370C<$maxreq> specifies the maximum number of outstanding aio requests that
355requests that this function generates. If it is C<< <= 0 >>, then a 371this function generates. If it is C<< <= 0 >>, then a suitable default
356suitable default will be chosen (currently 8). 372will be chosen (currently 6).
357 373
358On error, the callback is called without arguments, otherwise it receives 374On error, the callback is called without arguments, otherwise it receives
359two array-refs with path-relative entry names. 375two array-refs with path-relative entry names.
360 376
361Example: 377Example:
398=cut 414=cut
399 415
400sub aio_scandir($$$) { 416sub aio_scandir($$$) {
401 my ($path, $maxreq, $cb) = @_; 417 my ($path, $maxreq, $cb) = @_;
402 418
403 my $grp = aio_group; 419 my $grp = aio_group $cb;
404 420
405 $maxreq = 8 if $maxreq <= 0; 421 $maxreq = 6 if $maxreq <= 0;
406 422
407 # stat once 423 # stat once
408 add $grp aio_stat $path, sub { 424 add $grp aio_stat $path, sub {
409 return $cb->() if $_[0]; 425 return $grp->result () if $_[0];
410 my $now = time; 426 my $now = time;
411 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 427 my $hash1 = join ":", (stat _)[0,1,3,7,9];
412 428
413 # read the directory entries 429 # read the directory entries
414 add $grp aio_readdir $path, sub { 430 add $grp aio_readdir $path, sub {
415 my $entries = shift 431 my $entries = shift
416 or return $cb->(); 432 or return $grp->result ();
417 433
418 # stat the dir another time 434 # stat the dir another time
419 add $grp aio_stat $path, sub { 435 add $grp aio_stat $path, sub {
420 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 436 my $hash2 = join ":", (stat _)[0,1,3,7,9];
421 437
426 $ndirs = -1; 442 $ndirs = -1;
427 } else { 443 } else {
428 # if nlink == 2, we are finished 444 # if nlink == 2, we are finished
429 # on non-posix-fs's, we rely on nlink < 2 445 # on non-posix-fs's, we rely on nlink < 2
430 $ndirs = (stat _)[3] - 2 446 $ndirs = (stat _)[3] - 2
431 or return $cb->([], $entries); 447 or return $grp->result ([], $entries);
432 } 448 }
433 449
434 # sort into likely dirs and likely nondirs 450 # sort into likely dirs and likely nondirs
435 # dirs == files without ".", short entries first 451 # dirs == files without ".", short entries first
436 $entries = [map $_->[0], 452 $entries = [map $_->[0],
441 my (@dirs, @nondirs); 457 my (@dirs, @nondirs);
442 458
443 my ($statcb, $schedcb); 459 my ($statcb, $schedcb);
444 my $nreq = 0; 460 my $nreq = 0;
445 461
462 my $statgrp = add $grp aio_group;
463
446 $schedcb = sub { 464 $schedcb = sub {
447 if (@$entries) { 465 if (@$entries) {
448 if ($nreq < $maxreq) { 466 if ($nreq < $maxreq) {
449 my $ent = pop @$entries; 467 my $ent = pop @$entries;
450 $nreq++; 468 $nreq++;
451 add $grp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) }; 469 add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
452 } 470 }
453 } elsif (!$nreq) { 471 } elsif (!$nreq) {
454 # finished 472 # finished
473 $statgrp->cancel;
455 undef $statcb; 474 undef $statcb;
456 undef $schedcb; 475 undef $schedcb;
457 $cb->(\@dirs, \@nondirs) if $cb; 476 $grp->result (\@dirs, \@nondirs);
458 undef $cb;
459 } 477 }
460 }; 478 };
461 $statcb = sub { 479 $statcb = sub {
462 my ($status, $entry) = @_; 480 my ($status, $entry) = @_;
463 481
505callback with the fdatasync result code. 523callback with the fdatasync result code.
506 524
507If this call isn't available because your OS lacks it or it couldn't be 525If this call isn't available because your OS lacks it or it couldn't be
508detected, it will be emulated by calling C<fsync> instead. 526detected, it will be emulated by calling C<fsync> instead.
509 527
510=item aio_group $callback->() 528=item aio_group $callback->(...)
511 529
512[EXPERIMENTAL] 530[EXPERIMENTAL]
513 531
514This is a very special aio request: Instead of doing something, it is a 532This is a very special aio request: Instead of doing something, it is a
515container for other aio requests, which is useful if you want to bundle 533container for other aio requests, which is useful if you want to bundle
526 544
527 add $grp 545 add $grp
528 (aio_stat ...), 546 (aio_stat ...),
529 (aio_stat ...), 547 (aio_stat ...),
530 ...; 548 ...;
549
550=item aio_nop $callback->()
551
552This is a special request - it does nothing in itself and is only used for
553side effects, such as when you want to add a dummy request to a group so
554that finishing the requests in the group depends on executing the given
555code.
556
557While this request does nothing, it still goes through the execution
558phase and still requires a worker thread. Thus, the callback will not
559be executed immediately but only after other requests in the queue have
560entered their execution phase. This can be used to measure request
561latency.
531 562
532=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* 563=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED*
533 564
534Mainly used for debugging and benchmarking, this aio request puts one of 565Mainly used for debugging and benchmarking, this aio request puts one of
535the request workers to sleep for the given time. 566the request workers to sleep for the given time.
554callback) and B<done> (request has reached the end of its lifetime and 585callback) and B<done> (request has reached the end of its lifetime and
555holds no resources anymore). 586holds no resources anymore).
556 587
557=over 4 588=over 4
558 589
559=item $req->cancel 590=item cancel $req
560 591
561Cancels the request, if possible. Has the effect of skipping execution 592Cancels the request, if possible. Has the effect of skipping execution
562when entering the B<execute> state and skipping calling the callback when 593when entering the B<execute> state and skipping calling the callback when
563entering the the B<result> state, but will leave the request otherwise 594entering the the B<result> state, but will leave the request otherwise
564untouched. That means that requests that currently execute will not be 595untouched. That means that requests that currently execute will not be
565stopped and resources held by the request will not be freed prematurely. 596stopped and resources held by the request will not be freed prematurely.
566 597
598=item cb $req $callback->(...)
599
600Replace (or simply set) the callback registered to the request.
601
567=back 602=back
568 603
569=head2 IO::AIO::GRP CLASS 604=head2 IO::AIO::GRP CLASS
570 605
571This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to 606This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
585You add requests by calling the C<add> method with one or more 620You add requests by calling the C<add> method with one or more
586C<IO::AIO::REQ> objects: 621C<IO::AIO::REQ> objects:
587 622
588 $grp->add (aio_unlink "..."); 623 $grp->add (aio_unlink "...");
589 624
590 add $grp aio_stat "...", sub { ... }; 625 add $grp aio_stat "...", sub {
626 $_[0] or return $grp->result ("error");
627
628 # add another request dynamically, if first succeeded
629 add $grp aio_open "...", sub {
630 $grp->result ("ok");
631 };
632 };
591 633
592This makes it very easy to create composite requests (see the source of 634This makes it very easy to create composite requests (see the source of
593C<aio_move> for an application) that work and feel like simple requests. 635C<aio_move> for an application) that work and feel like simple requests.
594 636
637=over 4
638
595The IO::AIO::GRP objects will be cleaned up during calls to 639=item * The IO::AIO::GRP objects will be cleaned up during calls to
596C<IO::AIO::poll_cb>, just like any other request. 640C<IO::AIO::poll_cb>, just like any other request.
597 641
598They can be canceled like any other request. Canceling will cancel not 642=item * They can be canceled like any other request. Canceling will cancel not
599just the request itself, but also all requests it contains. 643only the request itself, but also all requests it contains.
600 644
601They can also can also be added to other IO::AIO::GRP objects. 645=item * They can also can also be added to other IO::AIO::GRP objects.
646
647=item * You must not add requests to a group from within the group callback (or
648any later time).
649
650=item * This does not harmonise well with C<max_outstanding>, so best do
651not combine C<aio_group> with it. Groups and feeders are recommended for
652this kind of concurrency-limiting.
653
654=back
602 655
603Their lifetime, simplified, looks like this: when they are empty, they 656Their lifetime, simplified, looks like this: when they are empty, they
604will finish very quickly. If they contain only requests that are in the 657will finish very quickly. If they contain only requests that are in the
605C<done> state, they will also finish. Otherwise they will continue to 658C<done> state, they will also finish. Otherwise they will continue to
606exist. 659exist.
607 660
661That means after creating a group you have some time to add requests. And
662in the callbacks of those requests, you can add further requests to the
663group. And only when all those requests have finished will the the group
664itself finish.
665
608=over 4 666=over 4
609 667
668=item add $grp ...
669
610=item $grp->add (...) 670=item $grp->add (...)
611 671
612=item add $grp ... 672Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
673be added, including other groups, as long as you do not create circular
674dependencies.
613 675
614Add one or more 676Returns all its arguments.
615Cancels the request, if possible. Has the effect of skipping execution 677
616when entering the B<execute> state and skipping calling the callback when 678=item $grp->result (...)
617entering the the B<result> state, but will leave the request otherwise 679
618untouched. That means that requests that currently execute will not be 680Set the result value(s) that will be passed to the group callback when all
619stopped and resources held by the request will not be freed prematurely. 681subrequests have finished. By default, no argument will be passed.
682
683=item feed $grp $callback->($grp)
684
685[VERY EXPERIMENTAL]
686
687Sets a feeder/generator on this group: every group can have an attached
688generator that generates requests if idle. The idea behind this is that,
689although you could just queue as many requests as you want in a group,
690this might starve other requests for a potentially long time. For
691example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
692requests, delaying any later requests for a long time.
693
694To avoid this, and allow incremental generation of requests, you can
695instead a group and set a feeder on it that generates those requests. The
696feed callback will be called whenever there are few enough (see C<limit>,
697below) requests active in the group itself and is expected to queue more
698requests.
699
700The feed callback can queue as many requests as it likes (i.e. C<add> does
701not impose any limits).
702
703If the feed does not queue more requests when called, it will be
704automatically removed from the group.
705
706If the feed limit is C<0>, it will be set to C<2> automatically.
707
708Example:
709
710 # stat all files in @files, but only ever use four aio requests concurrently:
711
712 my $grp = aio_group sub { print "finished\n" };
713 limit $grp 4;
714 feed $grp sub {
715 my $file = pop @files
716 or return;
717
718 add $grp aio_stat $file, sub { ... };
719 };
720
721=item limit $grp $num
722
723Sets the feeder limit for the group: The feeder will be called whenever
724the group contains less than this many requests.
725
726Setting the limit to C<0> will pause the feeding process.
620 727
621=back 728=back
622 729
623=head2 SUPPORT FUNCTIONS 730=head2 SUPPORT FUNCTIONS
624 731
682 IO::AIO::poll_wait, IO::AIO::poll_cb 789 IO::AIO::poll_wait, IO::AIO::poll_cb
683 if IO::AIO::nreqs; 790 if IO::AIO::nreqs;
684 791
685=item IO::AIO::min_parallel $nthreads 792=item IO::AIO::min_parallel $nthreads
686 793
687Set the minimum number of AIO threads to C<$nthreads>. The current default 794Set the minimum number of AIO threads to C<$nthreads>. The current
688is C<4>, which means four asynchronous operations can be done at one time 795default is C<8>, which means eight asynchronous operations can execute
689(the number of outstanding operations, however, is unlimited). 796concurrently at any one time (the number of outstanding requests,
797however, is unlimited).
690 798
691IO::AIO starts threads only on demand, when an AIO request is queued and 799IO::AIO starts threads only on demand, when an AIO request is queued and
692no free thread exists. 800no free thread exists.
693 801
694It is recommended to keep the number of threads low, as some Linux 802It is recommended to keep the number of threads relatively low, as some
695kernel versions will scale negatively with the number of threads (higher 803Linux kernel versions will scale negatively with the number of threads
696parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 804(higher parallelity => MUCH higher latency). With current Linux 2.6
697threads should be fine. 805versions, 4-32 threads should be fine.
698 806
699Under most circumstances you don't need to call this function, as the 807Under most circumstances you don't need to call this function, as the
700module selects a default that is suitable for low to moderate load. 808module selects a default that is suitable for low to moderate load.
701 809
702=item IO::AIO::max_parallel $nthreads 810=item IO::AIO::max_parallel $nthreads
713 821
714Under normal circumstances you don't need to call this function. 822Under normal circumstances you don't need to call this function.
715 823
716=item $oldnreqs = IO::AIO::max_outstanding $nreqs 824=item $oldnreqs = IO::AIO::max_outstanding $nreqs
717 825
826[DEPRECATED]
827
718Sets the maximum number of outstanding requests to C<$nreqs>. If you 828Sets the maximum number of outstanding requests to C<$nreqs>. If you
719try to queue up more than this number of requests, the caller will block until 829try to queue up more than this number of requests, the caller will block until
720some requests have been handled. 830some requests have been handled.
721 831
722The default is very large, so normally there is no practical limit. If you 832The default is very large, so normally there is no practical limit. If you
723queue up many requests in a loop it often improves speed if you set 833queue up many requests in a loop it often improves speed if you set
724this to a relatively low number, such as C<100>. 834this to a relatively low number, such as C<100>.
835
836This function does not work well together with C<aio_group>'s, and their
837feeder interface is better suited to limiting concurrency, so do not use
838this function.
725 839
726Under normal circumstances you don't need to call this function. 840Under normal circumstances you don't need to call this function.
727 841
728=back 842=back
729 843
743 or return undef; 857 or return undef;
744 858
745 *$sym 859 *$sym
746} 860}
747 861
748min_parallel 4; 862min_parallel 8;
749 863
750END { 864END {
751 max_parallel 0; 865 max_parallel 0;
752} 866}
753 867
767 881
768In short: the parent will, after a short pause, continue as if fork had 882In short: the parent will, after a short pause, continue as if fork had
769not been called, while the child will act as if IO::AIO has not been used 883not been called, while the child will act as if IO::AIO has not been used
770yet. 884yet.
771 885
886=head2 MEMORY USAGE
887
888Each aio request uses - depending on your architecture - around 128 bytes
889of memory. In addition, stat requests need a stat buffer (possibly a few
890hundred bytes). Perl scalars and other data passed into aio requests will
891also be locked.
892
893This is now awfully much, so queuing lots of requests is not usually a
894problem.
895
896Each thread needs a stack area which is usually around 16k, sometimes much
897larger, depending on the OS.
898
772=head1 SEE ALSO 899=head1 SEE ALSO
773 900
774L<Coro>, L<Linux::AIO> (obsolete). 901L<Coro::AIO>.
775 902
776=head1 AUTHOR 903=head1 AUTHOR
777 904
778 Marc Lehmann <schmorp@schmorp.de> 905 Marc Lehmann <schmorp@schmorp.de>
779 http://home.schmorp.de/ 906 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines