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.71 by root, Tue Oct 24 11:57:30 2006 UTC vs.
Revision 1.80 by root, Thu Oct 26 16:28:33 2006 UTC

51=head1 DESCRIPTION 51=head1 DESCRIPTION
52 52
53This module implements asynchronous I/O using whatever means your 53This module implements asynchronous I/O using whatever means your
54operating system supports. 54operating system supports.
55 55
56Currently, a number of threads are started that execute your read/writes 56In this version, a number of threads are started that execute your
57and signal their completion. You don't need thread support in perl, and 57requests and signal their completion. You don't need thread support
58the threads created by this module will not be visible to perl. In the 58in perl, and the threads created by this module will not be visible
59future, this module might make use of the native aio functions available 59to perl. In the future, this module might make use of the native aio
60on many operating systems. However, they are often not well-supported 60functions available on many operating systems. However, they are often
61(Linux doesn't allow them on normal files currently, for example), 61not well-supported or restricted (Linux doesn't allow them on normal
62and they would only support aio_read and aio_write, so the remaining 62files currently, for example), and they would only support aio_read and
63functionality would have to be implemented using threads anyway. 63aio_write, so the remaining functionality would have to be implemented
64using threads anyway.
64 65
65Although the module will work with in the presence of other threads, 66Although the module will work with in the presence of other (Perl-)
66it is currently not reentrant in any way, so use appropriate locking 67threads, it is currently not reentrant in any way, so use appropriate
67yourself, always call C<poll_cb> from within the same thread, or never 68locking yourself, always call C<poll_cb> from within the same thread, or
68call C<poll_cb> (or other C<aio_> functions) recursively. 69never call C<poll_cb> (or other C<aio_> functions) recursively.
70
71=head1 REQUEST ANATOMY AND LIFETIME
72
73Every C<aio_*> function creates a request. which is a C data structure not
74directly visible to Perl.
75
76If called in non-void context, every request function returns a Perl
77object representing the request. In void context, nothing is returned,
78which saves a bit of memory.
79
80The perl object is a fairly standard ref-to-hash object. The hash contents
81are not used by IO::AIO so you are free to store anything you like in it.
82
83During their existance, aio requests travel through the following states,
84in order:
85
86=over 4
87
88=item ready
89
90Immediately after a request is created it is put into the ready state,
91waiting for a thread to execute it.
92
93=item execute
94
95A thread has accepted the request for processing and is currently
96executing it (e.g. blocking in read).
97
98=item pending
99
100The request has been executed and is waiting for result processing.
101
102While request submission and execution is fully asynchronous, result
103processing is not and relies on the perl interpreter calling C<poll_cb>
104(or another function with the same effect).
105
106=item result
107
108The request results are processed synchronously by C<poll_cb>.
109
110The C<poll_cb> function will process all outstanding aio requests by
111calling their callbacks, freeing memory associated with them and managing
112any groups they are contained in.
113
114=item done
115
116Request has reached the end of its lifetime and holds no resources anymore
117(except possibly for the Perl object, but its connection to the actual
118aio request is severed and calling its methods will either do nothing or
119result in a runtime error).
69 120
70=cut 121=cut
71 122
72package IO::AIO; 123package IO::AIO;
73 124
83 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 134 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
84 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 135 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
85 aio_group aio_nop); 136 aio_group aio_nop);
86 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 137 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
87 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 138 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
88 min_parallel max_parallel max_outstanding nreqs); 139 min_parallel max_parallel nreqs nready npending);
89 140
90 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 141 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
91 142
92 require XSLoader; 143 require XSLoader;
93 XSLoader::load ("IO::AIO", $VERSION); 144 XSLoader::load ("IO::AIO", $VERSION);
124environment, d) use Glib::filename_from_unicode on unicode filenames or e) 175environment, d) use Glib::filename_from_unicode on unicode filenames or e)
125use something else. 176use something else.
126 177
127=over 4 178=over 4
128 179
129=item aioreq_pri $pri 180=item $prev_pri = aioreq_pri [$pri]
130 181
131Sets the priority for the next aio request. The default priority 182Returns the priority value that would be used for the next request and, if
183C<$pri> is given, sets the priority for the next aio request.
184
132is C<0>, the minimum and maximum priorities are C<-4> and C<4>, 185The default priority is C<0>, the minimum and maximum priorities are C<-4>
133respectively. Requests with higher priority will be serviced first. 186and C<4>, respectively. Requests with higher priority will be serviced
187first.
134 188
135The priority will be reset to C<0> after each call to one of the C<aio_> 189The priority will be reset to C<0> after each call to one of the C<aio_*>
136functions. 190functions.
137 191
138Example: open a file with low priority, then read something from it with 192Example: open a file with low priority, then read something from it with
139higher priority so the read request is serviced before other low priority 193higher priority so the read request is serviced before other low priority
140open requests (potentially spamming the cache): 194open requests (potentially spamming the cache):
232=cut 286=cut
233 287
234sub aio_move($$$) { 288sub aio_move($$$) {
235 my ($src, $dst, $cb) = @_; 289 my ($src, $dst, $cb) = @_;
236 290
291 my $pri = aioreq_pri;
237 my $grp = aio_group $cb; 292 my $grp = aio_group $cb;
238 293
294 aioreq_pri $pri;
239 add $grp aio_rename $src, $dst, sub { 295 add $grp aio_rename $src, $dst, sub {
240 if ($_[0] && $! == EXDEV) { 296 if ($_[0] && $! == EXDEV) {
297 aioreq_pri $pri;
241 add $grp aio_open $src, O_RDONLY, 0, sub { 298 add $grp aio_open $src, O_RDONLY, 0, sub {
242 if (my $src_fh = $_[0]) { 299 if (my $src_fh = $_[0]) {
243 my @stat = stat $src_fh; 300 my @stat = stat $src_fh;
244 301
302 aioreq_pri $pri;
245 add $grp aio_open $dst, O_WRONLY, 0200, sub { 303 add $grp aio_open $dst, O_WRONLY, 0200, sub {
246 if (my $dst_fh = $_[0]) { 304 if (my $dst_fh = $_[0]) {
305 aioreq_pri $pri;
247 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 306 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
248 close $src_fh; 307 close $src_fh;
249 308
250 if ($_[0] == $stat[7]) { 309 if ($_[0] == $stat[7]) {
251 utime $stat[8], $stat[9], $dst; 310 utime $stat[8], $stat[9], $dst;
252 chmod $stat[2] & 07777, $dst_fh; 311 chmod $stat[2] & 07777, $dst_fh;
253 chown $stat[4], $stat[5], $dst_fh; 312 chown $stat[4], $stat[5], $dst_fh;
254 close $dst_fh; 313 close $dst_fh;
255 314
315 aioreq_pri $pri;
256 add $grp aio_unlink $src, sub { 316 add $grp aio_unlink $src, sub {
257 $grp->result ($_[0]); 317 $grp->result ($_[0]);
258 }; 318 };
259 } else { 319 } else {
260 my $errno = $!; 320 my $errno = $!;
321 aioreq_pri $pri;
261 add $grp aio_unlink $dst, sub { 322 add $grp aio_unlink $dst, sub {
262 $! = $errno; 323 $! = $errno;
263 $grp->result (-1); 324 $grp->result (-1);
264 }; 325 };
265 } 326 }
375with the filenames. 436with the filenames.
376 437
377=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 438=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
378 439
379Scans a directory (similar to C<aio_readdir>) but additionally tries to 440Scans a directory (similar to C<aio_readdir>) but additionally tries to
380separate the entries of directory C<$path> into two sets of names, ones 441efficiently separate the entries of directory C<$path> into two sets of
381you can recurse into (directories or links to them), and ones you cannot 442names, directories you can recurse into (directories), and ones you cannot
382recurse into (everything else). 443recurse into (everything else, including symlinks to directories).
383 444
384C<aio_scandir> is a composite request that creates of many sub requests_ 445C<aio_scandir> is a composite request that creates of many sub requests_
385C<$maxreq> specifies the maximum number of outstanding aio requests that 446C<$maxreq> specifies the maximum number of outstanding aio requests that
386this function generates. If it is C<< <= 0 >>, then a suitable default 447this function generates. If it is C<< <= 0 >>, then a suitable default
387will be chosen (currently 6). 448will be chosen (currently 6).
429=cut 490=cut
430 491
431sub aio_scandir($$$) { 492sub aio_scandir($$$) {
432 my ($path, $maxreq, $cb) = @_; 493 my ($path, $maxreq, $cb) = @_;
433 494
495 my $pri = aioreq_pri;
496
434 my $grp = aio_group $cb; 497 my $grp = aio_group $cb;
435 498
436 $maxreq = 6 if $maxreq <= 0; 499 $maxreq = 6 if $maxreq <= 0;
437 500
438 # stat once 501 # stat once
502 aioreq_pri $pri;
439 add $grp aio_stat $path, sub { 503 add $grp aio_stat $path, sub {
440 return $grp->result () if $_[0]; 504 return $grp->result () if $_[0];
441 my $now = time; 505 my $now = time;
442 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 506 my $hash1 = join ":", (stat _)[0,1,3,7,9];
443 507
444 # read the directory entries 508 # read the directory entries
509 aioreq_pri $pri;
445 add $grp aio_readdir $path, sub { 510 add $grp aio_readdir $path, sub {
446 my $entries = shift 511 my $entries = shift
447 or return $grp->result (); 512 or return $grp->result ();
448 513
449 # stat the dir another time 514 # stat the dir another time
515 aioreq_pri $pri;
450 add $grp aio_stat $path, sub { 516 add $grp aio_stat $path, sub {
451 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 517 my $hash2 = join ":", (stat _)[0,1,3,7,9];
452 518
453 my $ndirs; 519 my $ndirs;
454 520
469 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 535 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
470 @$entries]; 536 @$entries];
471 537
472 my (@dirs, @nondirs); 538 my (@dirs, @nondirs);
473 539
474 my ($statcb, $schedcb);
475 my $nreq = 0;
476
477 my $statgrp = add $grp aio_group; 540 my $statgrp = add $grp aio_group sub {
541 $grp->result (\@dirs, \@nondirs);
542 };
478 543
479 $schedcb = sub { 544 limit $statgrp $maxreq;
480 if (@$entries) { 545 feed $statgrp sub {
481 if ($nreq < $maxreq) { 546 return unless @$entries;
482 my $ent = pop @$entries; 547 my $entry = pop @$entries;
548
549 aioreq_pri $pri;
550 add $statgrp aio_stat "$path/$entry/.", sub {
551 if ($_[0] < 0) {
552 push @nondirs, $entry;
553 } else {
554 # need to check for real directory
555 aioreq_pri $pri;
556 add $statgrp aio_lstat "$path/$entry", sub {
557 if (-d _) {
558 push @dirs, $entry;
559
560 unless (--$ndirs) {
561 push @nondirs, @$entries;
562 feed $statgrp;
563 }
564 } else {
565 push @nondirs, $entry;
566 }
483 $nreq++; 567 }
484 add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
485 } 568 }
486 } elsif (!$nreq) {
487 # finished
488 $statgrp->cancel;
489 undef $statcb;
490 undef $schedcb;
491 $grp->result (\@dirs, \@nondirs);
492 } 569 };
493 }; 570 };
494 $statcb = sub {
495 my ($status, $entry) = @_;
496
497 if ($status < 0) {
498 $nreq--;
499 push @nondirs, $entry;
500 &$schedcb;
501 } else {
502 # need to check for real directory
503 add $grp aio_lstat "$path/$entry", sub {
504 $nreq--;
505
506 if (-d _) {
507 push @dirs, $entry;
508
509 if (!--$ndirs) {
510 push @nondirs, @$entries;
511 $entries = [];
512 }
513 } else {
514 push @nondirs, $entry;
515 }
516
517 &$schedcb;
518 }
519 }
520 };
521
522 &$schedcb while @$entries && $nreq < $maxreq;
523 }; 571 };
524 }; 572 };
525 }; 573 };
526 574
527 $grp 575 $grp
539 587
540If this call isn't available because your OS lacks it or it couldn't be 588If this call isn't available because your OS lacks it or it couldn't be
541detected, it will be emulated by calling C<fsync> instead. 589detected, it will be emulated by calling C<fsync> instead.
542 590
543=item aio_group $callback->(...) 591=item aio_group $callback->(...)
544
545[EXPERIMENTAL]
546 592
547This is a very special aio request: Instead of doing something, it is a 593This is a very special aio request: Instead of doing something, it is a
548container for other aio requests, which is useful if you want to bundle 594container for other aio requests, which is useful if you want to bundle
549many requests into a single, composite, request with a definite callback 595many requests into a single, composite, request with a definite callback
550and the ability to cancel the whole request with its subrequests. 596and the ability to cancel the whole request with its subrequests.
591=head2 IO::AIO::REQ CLASS 637=head2 IO::AIO::REQ CLASS
592 638
593All non-aggregate C<aio_*> functions return an object of this class when 639All non-aggregate C<aio_*> functions return an object of this class when
594called in non-void context. 640called in non-void context.
595 641
596A request always moves through the following five states in its lifetime,
597in order: B<ready> (request has been created, but has not been executed
598yet), B<execute> (request is currently being executed), B<pending>
599(request has been executed but callback has not been called yet),
600B<result> (results are being processed synchronously, includes calling the
601callback) and B<done> (request has reached the end of its lifetime and
602holds no resources anymore).
603
604=over 4 642=over 4
605 643
606=item cancel $req 644=item cancel $req
607 645
608Cancels the request, if possible. Has the effect of skipping execution 646Cancels the request, if possible. Has the effect of skipping execution
661=item * They can also can also be added to other IO::AIO::GRP objects. 699=item * They can also can also be added to other IO::AIO::GRP objects.
662 700
663=item * You must not add requests to a group from within the group callback (or 701=item * You must not add requests to a group from within the group callback (or
664any later time). 702any later time).
665 703
666=item * This does not harmonise well with C<max_outstanding>, so best do
667not combine C<aio_group> with it. Groups and feeders are recommended for
668this kind of concurrency-limiting.
669
670=back 704=back
671 705
672Their lifetime, simplified, looks like this: when they are empty, they 706Their lifetime, simplified, looks like this: when they are empty, they
673will finish very quickly. If they contain only requests that are in the 707will finish very quickly. If they contain only requests that are in the
674C<done> state, they will also finish. Otherwise they will continue to 708C<done> state, they will also finish. Otherwise they will continue to
689be added, including other groups, as long as you do not create circular 723be added, including other groups, as long as you do not create circular
690dependencies. 724dependencies.
691 725
692Returns all its arguments. 726Returns all its arguments.
693 727
728=item $grp->cancel_subs
729
730Cancel all subrequests and clears any feeder, but not the group request
731itself. Useful when you queued a lot of events but got a result early.
732
694=item $grp->result (...) 733=item $grp->result (...)
695 734
696Set the result value(s) that will be passed to the group callback when all 735Set the result value(s) that will be passed to the group callback when all
697subrequests have finished. By default, no argument will be passed. 736subrequests have finished and set thre groups errno to the current value
737of errno (just like calling C<errno> without an error number). By default,
738no argument will be passed and errno is zero.
739
740=item $grp->errno ([$errno])
741
742Sets the group errno value to C<$errno>, or the current value of errno
743when the argument is missing.
744
745Every aio request has an associated errno value that is restored when
746the callback is invoked. This method lets you change this value from its
747default (0).
748
749Calling C<result> will also set errno, so make sure you either set C<$!>
750before the call to C<result>, or call c<errno> after it.
698 751
699=item feed $grp $callback->($grp) 752=item feed $grp $callback->($grp)
700
701[VERY EXPERIMENTAL]
702 753
703Sets a feeder/generator on this group: every group can have an attached 754Sets a feeder/generator on this group: every group can have an attached
704generator that generates requests if idle. The idea behind this is that, 755generator that generates requests if idle. The idea behind this is that,
705although you could just queue as many requests as you want in a group, 756although you could just queue as many requests as you want in a group,
706this might starve other requests for a potentially long time. For 757this might starve other requests for a potentially long time. For
760 811
761Process all outstanding events on the result pipe. You have to call this 812Process all outstanding events on the result pipe. You have to call this
762regularly. Returns the number of events processed. Returns immediately 813regularly. Returns the number of events processed. Returns immediately
763when no events are outstanding. 814when no events are outstanding.
764 815
816If not all requests were processed for whatever reason, the filehandle
817will still be ready when C<poll_cb> returns.
818
765Example: Install an Event watcher that automatically calls 819Example: Install an Event watcher that automatically calls
766IO::AIO::poll_cb with high priority: 820IO::AIO::poll_cb with high priority:
767 821
768 Event->io (fd => IO::AIO::poll_fileno, 822 Event->io (fd => IO::AIO::poll_fileno,
769 poll => 'r', async => 1, 823 poll => 'r', async => 1,
770 cb => \&IO::AIO::poll_cb); 824 cb => \&IO::AIO::poll_cb);
771 825
826=item IO::AIO::poll_some $max_requests
827
828Similar to C<poll_cb>, but only processes up to C<$max_requests> requests
829at a time.
830
831Useful if you want to ensure some level of interactiveness when perl is
832not fast enough to process all requests in time.
833
834Example: Install an Event watcher that automatically calls
835IO::AIO::poll_some with low priority, to ensure that other parts of the
836program get the CPU sometimes even under high AIO load.
837
838 Event->io (fd => IO::AIO::poll_fileno,
839 poll => 'r', nice => 1,
840 cb => sub { IO::AIO::poll_some 256 });
841
772=item IO::AIO::poll_wait 842=item IO::AIO::poll_wait
773 843
774Wait till the result filehandle becomes ready for reading (simply does a 844Wait till the result filehandle becomes ready for reading (simply does a
775C<select> on the filehandle. This is useful if you want to synchronously wait 845C<select> on the filehandle. This is useful if you want to synchronously wait
776for some requests to finish). 846for some requests to finish).
777 847
778See C<nreqs> for an example. 848See C<nreqs> for an example.
779 849
780=item IO::AIO::nreqs 850=item IO::AIO::nreqs
781 851
782Returns the number of requests currently outstanding (i.e. for which their 852Returns the number of requests currently in the ready, execute or pending
783callback has not been invoked yet). 853states (i.e. for which their callback has not been invoked yet).
784 854
785Example: wait till there are no outstanding requests anymore: 855Example: wait till there are no outstanding requests anymore:
786 856
787 IO::AIO::poll_wait, IO::AIO::poll_cb 857 IO::AIO::poll_wait, IO::AIO::poll_cb
788 while IO::AIO::nreqs; 858 while IO::AIO::nreqs;
859
860=item IO::AIO::nready
861
862Returns the number of requests currently in the ready state (not yet
863executed).
864
865=item IO::AIO::npending
866
867Returns the number of requests currently in the pending state (executed,
868but not yet processed by poll_cb).
789 869
790=item IO::AIO::flush 870=item IO::AIO::flush
791 871
792Wait till all outstanding AIO requests have been handled. 872Wait till all outstanding AIO requests have been handled.
793 873
835This module automatically runs C<max_parallel 0> at program end, to ensure 915This module automatically runs C<max_parallel 0> at program end, to ensure
836that all threads are killed and that there are no outstanding requests. 916that all threads are killed and that there are no outstanding requests.
837 917
838Under normal circumstances you don't need to call this function. 918Under normal circumstances you don't need to call this function.
839 919
840=item $oldnreqs = IO::AIO::max_outstanding $nreqs 920=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
841 921
842[DEPRECATED] 922This is a very bad function to use in interactive programs because it
923blocks, and a bad way to reduce concurrency because it is inexact: Better
924use an C<aio_group> together with a feed callback.
843 925
844Sets the maximum number of outstanding requests to C<$nreqs>. If you 926Sets the maximum number of outstanding requests to C<$nreqs>. If you
845try to queue up more than this number of requests, the caller will block until 927to queue up more than this number of requests, the next call to the
846some requests have been handled. 928C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
929function will block until the limit is no longer exceeded.
847 930
848The default is very large, so normally there is no practical limit. If you 931The default value is very large, so there is no practical limit on the
849queue up many requests in a loop it often improves speed if you set 932number of outstanding requests.
850this to a relatively low number, such as C<100>.
851 933
852This function does not work well together with C<aio_group>'s, and their 934You can still queue as many requests as you want. Therefore,
853feeder interface is better suited to limiting concurrency, so do not use 935C<max_oustsanding> is mainly useful in simple scripts (with low values) or
854this function. 936as a stop gap to shield against fatal memory overflow (with large values).
855
856Under normal circumstances you don't need to call this function.
857 937
858=back 938=back
859 939
860=cut 940=cut
861 941
888This module should do "the right thing" when the process using it forks: 968This module should do "the right thing" when the process using it forks:
889 969
890Before the fork, IO::AIO enters a quiescent state where no requests 970Before the fork, IO::AIO enters a quiescent state where no requests
891can be added in other threads and no results will be processed. After 971can be added in other threads and no results will be processed. After
892the fork the parent simply leaves the quiescent state and continues 972the fork the parent simply leaves the quiescent state and continues
893request/result processing, while the child clears the request/result 973request/result processing, while the child frees the request/result queue
894queue (so the requests started before the fork will only be handled in 974(so that the requests started before the fork will only be handled in the
895the parent). Threads will be started on demand until the limit ste in the 975parent). Threads will be started on demand until the limit set in the
896parent process has been reached again. 976parent process has been reached again.
897 977
898In short: the parent will, after a short pause, continue as if fork had 978In short: the parent will, after a short pause, continue as if fork had
899not been called, while the child will act as if IO::AIO has not been used 979not been called, while the child will act as if IO::AIO has not been used
900yet. 980yet.
901 981
902=head2 MEMORY USAGE 982=head2 MEMORY USAGE
903 983
984Per-request usage:
985
904Each aio request uses - depending on your architecture - around 128 bytes 986Each aio request uses - depending on your architecture - around 100-200
905of memory. In addition, stat requests need a stat buffer (possibly a few 987bytes of memory. In addition, stat requests need a stat buffer (possibly
906hundred bytes). Perl scalars and other data passed into aio requests will 988a few hundred bytes), readdir requires a result buffer and so on. Perl
907also be locked. 989scalars and other data passed into aio requests will also be locked and
990will consume memory till the request has entered the done state.
908 991
909This is now awfully much, so queuing lots of requests is not usually a 992This is now awfully much, so queuing lots of requests is not usually a
910problem. 993problem.
911 994
912Each thread needs a stack area which is usually around 16k, sometimes much 995Per-thread usage:
913larger, depending on the OS. 996
997In the execution phase, some aio requests require more memory for
998temporary buffers, and each thread requires a stack and other data
999structures (usually around 16k-128k, depending on the OS).
1000
1001=head1 KNOWN BUGS
1002
1003Known bugs will be fixed in the next release.
914 1004
915=head1 SEE ALSO 1005=head1 SEE ALSO
916 1006
917L<Coro::AIO>. 1007L<Coro::AIO>.
918 1008

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines