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.85 by root, Sat Oct 28 01:40:30 2006 UTC vs.
Revision 1.99 by root, Sun Jan 7 21:32:20 2007 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
… …
82Although the module will work with in the presence of other (Perl-) 84Although the module will work with in the presence of other (Perl-)
83threads, it is currently not reentrant in any way, so use appropriate 85threads, it is currently not reentrant in any way, so use appropriate
84locking yourself, always call C<poll_cb> from within the same thread, or 86locking yourself, always call C<poll_cb> from within the same thread, or
85never call C<poll_cb> (or other C<aio_> functions) recursively. 87never call C<poll_cb> (or other C<aio_> functions) recursively.
86 88
89=head2 EXAMPLE
90
91This is a simple example that uses the Event module and loads
92F</etc/passwd> asynchronously:
93
94 use Fcntl;
95 use Event;
96 use IO::AIO;
97
98 # register the IO::AIO callback with Event
99 Event->io (fd => IO::AIO::poll_fileno,
100 poll => 'r',
101 cb => \&IO::AIO::poll_cb);
102
103 # queue the request to open /etc/passwd
104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
105 my $fh = shift
106 or die "error while opening: $!";
107
108 # stat'ing filehandles is generally non-blocking
109 my $size = -s $fh;
110
111 # queue a request to read the file
112 my $contents;
113 aio_read $fh, 0, $size, $contents, 0, sub {
114 $_[0] == $size
115 or die "short read: $!";
116
117 close $fh;
118
119 # file contents now in $contents
120 print $contents;
121
122 # exit event loop and program
123 Event::unloop;
124 };
125 };
126
127 # possibly queue up other requests, or open GUI windows,
128 # check for sockets etc. etc.
129
130 # process events as long as there are some:
131 Event::loop;
132
87=head1 REQUEST ANATOMY AND LIFETIME 133=head1 REQUEST ANATOMY AND LIFETIME
88 134
89Every C<aio_*> function creates a request. which is a C data structure not 135Every C<aio_*> function creates a request. which is a C data structure not
90directly visible to Perl. 136directly visible to Perl.
91 137
… …
132Request has reached the end of its lifetime and holds no resources anymore 178Request has reached the end of its lifetime and holds no resources anymore
133(except possibly for the Perl object, but its connection to the actual 179(except possibly for the Perl object, but its connection to the actual
134aio request is severed and calling its methods will either do nothing or 180aio request is severed and calling its methods will either do nothing or
135result in a runtime error). 181result in a runtime error).
136 182
183=back
184
137=cut 185=cut
138 186
139package IO::AIO; 187package IO::AIO;
140 188
141no warnings; 189no warnings;
142use strict 'vars'; 190use strict 'vars';
143 191
144use base 'Exporter'; 192use base 'Exporter';
145 193
146BEGIN { 194BEGIN {
147 our $VERSION = '2.0'; 195 our $VERSION = '2.32';
148 196
149 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
150 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
151 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
152 aio_copy aio_group aio_nop aio_mknod); 200 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree);
153 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
154 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
155 min_parallel max_parallel nreqs nready npending); 203 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs);
156 206
157 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
158 208
159 require XSLoader; 209 require XSLoader;
160 XSLoader::load ("IO::AIO", $VERSION); 210 XSLoader::load ("IO::AIO", $VERSION);
161} 211}
162 212
163=head1 FUNCTIONS 213=head1 FUNCTIONS
164 214
165=head2 AIO FUNCTIONS 215=head2 AIO REQUEST FUNCTIONS
166 216
167All the C<aio_*> calls are more or less thin wrappers around the syscall 217All the C<aio_*> calls are more or less thin wrappers around the syscall
168with the same name (sans C<aio_>). The arguments are similar or identical, 218with the same name (sans C<aio_>). The arguments are similar or identical,
169and they all accept an additional (and optional) C<$callback> argument 219and they all accept an additional (and optional) C<$callback> argument
170which must be a code reference. This code reference will get called with 220which must be a code reference. This code reference will get called with
… …
173syscall has been executed asynchronously. 223syscall has been executed asynchronously.
174 224
175All functions expecting a filehandle keep a copy of the filehandle 225All functions expecting a filehandle keep a copy of the filehandle
176internally until the request has finished. 226internally until the request has finished.
177 227
178All requests return objects of type L<IO::AIO::REQ> that allow further 228All functions return request objects of type L<IO::AIO::REQ> that allow
179manipulation of those requests while they are in-flight. 229further manipulation of those requests while they are in-flight.
180 230
181The pathnames you pass to these routines I<must> be absolute and 231The pathnames you pass to these routines I<must> be absolute and
182encoded in byte form. The reason for the former is that at the time the 232encoded as octets. The reason for the former is that at the time the
183request is being executed, the current working directory could have 233request is being executed, the current working directory could have
184changed. Alternatively, you can make sure that you never change the 234changed. Alternatively, you can make sure that you never change the
185current working directory. 235current working directory anywhere in the program and then use relative
236paths.
186 237
187To encode pathnames to byte form, either make sure you either: a) 238To encode pathnames as octets, either make sure you either: a) always pass
188always pass in filenames you got from outside (command line, readdir 239in filenames you got from outside (command line, readdir etc.) without
189etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 240tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
190your pathnames to the locale (or other) encoding in effect in the user 241your pathnames to the locale (or other) encoding in effect in the user
191environment, d) use Glib::filename_from_unicode on unicode filenames or e) 242environment, d) use Glib::filename_from_unicode on unicode filenames or e)
192use something else. 243use something else to ensure your scalar has the correct contents.
244
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not.
193 247
194=over 4 248=over 4
195 249
196=item $prev_pri = aioreq_pri [$pri] 250=item $prev_pri = aioreq_pri [$pri]
197 251
… …
220 }; 274 };
221 275
222=item aioreq_nice $pri_adjust 276=item aioreq_nice $pri_adjust
223 277
224Similar to C<aioreq_pri>, but subtracts the given value from the current 278Similar to C<aioreq_pri>, but subtracts the given value from the current
225priority, so effects are cumulative. 279priority, so the effect is cumulative.
226 280
227=item aio_open $pathname, $flags, $mode, $callback->($fh) 281=item aio_open $pathname, $flags, $mode, $callback->($fh)
228 282
229Asynchronously open or create a file and call the callback with a newly 283Asynchronously open or create a file and call the callback with a newly
230created filehandle for the file. 284created filehandle for the file.
… …
347Asynchronously unlink (delete) a file and call the callback with the 401Asynchronously unlink (delete) a file and call the callback with the
348result code. 402result code.
349 403
350=item aio_mknod $path, $mode, $dev, $callback->($status) 404=item aio_mknod $path, $mode, $dev, $callback->($status)
351 405
406[EXPERIMENTAL]
407
352Asynchronously create a device node (or fifo). See mknod(2). 408Asynchronously create a device node (or fifo). See mknod(2).
353 409
354The only portable (POSIX) way of calling this function is: 410The only (POSIX-) portable way of calling this function is:
355 411
356 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 412 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
357 413
358=item aio_link $srcpath, $dstpath, $callback->($status) 414=item aio_link $srcpath, $dstpath, $callback->($status)
359 415
… …
362 418
363=item aio_symlink $srcpath, $dstpath, $callback->($status) 419=item aio_symlink $srcpath, $dstpath, $callback->($status)
364 420
365Asynchronously 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
366the path C<$dstpath> and call the callback with the result code. 422the path C<$dstpath> and call the callback with the result code.
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.
367 429
368=item aio_rename $srcpath, $dstpath, $callback->($status) 430=item aio_rename $srcpath, $dstpath, $callback->($status)
369 431
370Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 432Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
371rename(2) and call the callback with the result code. 433rename(2) and call the callback with the result code.
… …
381directory (i.e. opendir + readdir + closedir). The entries will not be 443directory (i.e. opendir + readdir + closedir). The entries will not be
382sorted, and will B<NOT> include the C<.> and C<..> entries. 444sorted, and will B<NOT> include the C<.> and C<..> entries.
383 445
384The callback a single argument which is either C<undef> or an array-ref 446The callback a single argument which is either C<undef> or an array-ref
385with the filenames. 447with the filenames.
448
449=item aio_load $path, $data, $callback->($status)
450
451This is a composite request that tries to fully load the given file into
452memory. Status is the same as with aio_read.
453
454=cut
455
456sub aio_load($$;$) {
457 aio_block {
458 my ($path, undef, $cb) = @_;
459 my $data = \$_[1];
460
461 my $pri = aioreq_pri;
462 my $grp = aio_group $cb;
463
464 aioreq_pri $pri;
465 add $grp aio_open $path, O_RDONLY, 0, sub {
466 my ($fh) = @_
467 or return $grp->result (-1);
468
469 aioreq_pri $pri;
470 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
471 $grp->result ($_[0]);
472 };
473 };
474
475 $grp
476 }
477}
386 478
387=item aio_copy $srcpath, $dstpath, $callback->($status) 479=item aio_copy $srcpath, $dstpath, $callback->($status)
388 480
389Try to copy the I<file> (directories not supported as either source or 481Try to copy the I<file> (directories not supported as either source or
390destination) from C<$srcpath> to C<$dstpath> and call the callback with 482destination) from C<$srcpath> to C<$dstpath> and call the callback with
… …
400errors are being ignored. 492errors are being ignored.
401 493
402=cut 494=cut
403 495
404sub aio_copy($$;$) { 496sub aio_copy($$;$) {
497 aio_block {
405 my ($src, $dst, $cb) = @_; 498 my ($src, $dst, $cb) = @_;
406 499
407 my $pri = aioreq_pri; 500 my $pri = aioreq_pri;
408 my $grp = aio_group $cb; 501 my $grp = aio_group $cb;
409 502
410 aioreq_pri $pri; 503 aioreq_pri $pri;
411 add $grp aio_open $src, O_RDONLY, 0, sub { 504 add $grp aio_open $src, O_RDONLY, 0, sub {
412 if (my $src_fh = $_[0]) { 505 if (my $src_fh = $_[0]) {
413 my @stat = stat $src_fh; 506 my @stat = stat $src_fh;
414 507
415 aioreq_pri $pri; 508 aioreq_pri $pri;
416 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 509 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
417 if (my $dst_fh = $_[0]) { 510 if (my $dst_fh = $_[0]) {
418 aioreq_pri $pri; 511 aioreq_pri $pri;
419 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 512 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
420 if ($_[0] == $stat[7]) { 513 if ($_[0] == $stat[7]) {
421 $grp->result (0); 514 $grp->result (0);
422 close $src_fh; 515 close $src_fh;
423 516
424 # those should not normally block. should. should. 517 # those should not normally block. should. should.
425 utime $stat[8], $stat[9], $dst; 518 utime $stat[8], $stat[9], $dst;
426 chmod $stat[2] & 07777, $dst_fh; 519 chmod $stat[2] & 07777, $dst_fh;
427 chown $stat[4], $stat[5], $dst_fh; 520 chown $stat[4], $stat[5], $dst_fh;
428 close $dst_fh; 521 close $dst_fh;
429 } else { 522 } else {
430 $grp->result (-1); 523 $grp->result (-1);
431 close $src_fh; 524 close $src_fh;
432 close $dst_fh; 525 close $dst_fh;
433 526
434 aioreq $pri; 527 aioreq $pri;
435 add $grp aio_unlink $dst; 528 add $grp aio_unlink $dst;
529 }
436 } 530 };
531 } else {
532 $grp->result (-1);
437 }; 533 }
438 } else {
439 $grp->result (-1);
440 } 534 },
535
536 } else {
537 $grp->result (-1);
441 }, 538 }
442
443 } else {
444 $grp->result (-1);
445 } 539 };
540
541 $grp
446 }; 542 }
447
448 $grp
449} 543}
450 544
451=item aio_move $srcpath, $dstpath, $callback->($status) 545=item aio_move $srcpath, $dstpath, $callback->($status)
452 546
453Try to move the I<file> (directories not supported as either source or 547Try to move the I<file> (directories not supported as either source or
… …
459that is successful, unlinking the C<$srcpath>. 553that is successful, unlinking the C<$srcpath>.
460 554
461=cut 555=cut
462 556
463sub aio_move($$;$) { 557sub aio_move($$;$) {
558 aio_block {
464 my ($src, $dst, $cb) = @_; 559 my ($src, $dst, $cb) = @_;
465 560
466 my $pri = aioreq_pri; 561 my $pri = aioreq_pri;
467 my $grp = aio_group $cb; 562 my $grp = aio_group $cb;
468 563
469 aioreq_pri $pri; 564 aioreq_pri $pri;
470 add $grp aio_rename $src, $dst, sub { 565 add $grp aio_rename $src, $dst, sub {
471 if ($_[0] && $! == EXDEV) { 566 if ($_[0] && $! == EXDEV) {
472 aioreq_pri $pri; 567 aioreq_pri $pri;
473 add $grp aio_copy $src, $dst, sub { 568 add $grp aio_copy $src, $dst, sub {
569 $grp->result ($_[0]);
570
571 if (!$_[0]) {
572 aioreq_pri $pri;
573 add $grp aio_unlink $src;
574 }
575 };
576 } else {
474 $grp->result ($_[0]); 577 $grp->result ($_[0]);
475
476 if (!$_[0]) {
477 aioreq_pri $pri;
478 add $grp aio_unlink $src;
479 }
480 }; 578 }
481 } else {
482 $grp->result ($_[0]);
483 } 579 };
580
581 $grp
484 }; 582 }
485
486 $grp
487} 583}
488 584
489=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 585=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
490 586
491Scans a directory (similar to C<aio_readdir>) but additionally tries to 587Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
539directory counting heuristic. 635directory counting heuristic.
540 636
541=cut 637=cut
542 638
543sub aio_scandir($$$) { 639sub aio_scandir($$$) {
640 aio_block {
544 my ($path, $maxreq, $cb) = @_; 641 my ($path, $maxreq, $cb) = @_;
545 642
546 my $pri = aioreq_pri; 643 my $pri = aioreq_pri;
547 644
548 my $grp = aio_group $cb; 645 my $grp = aio_group $cb;
549 646
550 $maxreq = 4 if $maxreq <= 0; 647 $maxreq = 4 if $maxreq <= 0;
551 648
552 # stat once 649 # stat once
553 aioreq_pri $pri;
554 add $grp aio_stat $path, sub {
555 return $grp->result () if $_[0];
556 my $now = time;
557 my $hash1 = join ":", (stat _)[0,1,3,7,9];
558
559 # read the directory entries
560 aioreq_pri $pri; 650 aioreq_pri $pri;
561 add $grp aio_readdir $path, sub { 651 add $grp aio_stat $path, sub {
562 my $entries = shift
563 or return $grp->result (); 652 return $grp->result () if $_[0];
653 my $now = time;
654 my $hash1 = join ":", (stat _)[0,1,3,7,9];
564 655
565 # stat the dir another time 656 # read the directory entries
566 aioreq_pri $pri; 657 aioreq_pri $pri;
658 add $grp aio_readdir $path, sub {
659 my $entries = shift
660 or return $grp->result ();
661
662 # stat the dir another time
663 aioreq_pri $pri;
567 add $grp aio_stat $path, sub { 664 add $grp aio_stat $path, sub {
568 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 665 my $hash2 = join ":", (stat _)[0,1,3,7,9];
569 666
570 my $ndirs; 667 my $ndirs;
571 668
572 # take the slow route if anything looks fishy 669 # take the slow route if anything looks fishy
573 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 670 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
574 $ndirs = -1; 671 $ndirs = -1;
575 } else { 672 } else {
576 # if nlink == 2, we are finished 673 # if nlink == 2, we are finished
577 # on non-posix-fs's, we rely on nlink < 2 674 # on non-posix-fs's, we rely on nlink < 2
578 $ndirs = (stat _)[3] - 2 675 $ndirs = (stat _)[3] - 2
579 or return $grp->result ([], $entries); 676 or return $grp->result ([], $entries);
580 } 677 }
581 678
582 # sort into likely dirs and likely nondirs 679 # sort into likely dirs and likely nondirs
583 # dirs == files without ".", short entries first 680 # dirs == files without ".", short entries first
584 $entries = [map $_->[0], 681 $entries = [map $_->[0],
585 sort { $b->[1] cmp $a->[1] } 682 sort { $b->[1] cmp $a->[1] }
586 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 683 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
587 @$entries]; 684 @$entries];
588 685
589 my (@dirs, @nondirs); 686 my (@dirs, @nondirs);
590 687
591 my $statgrp = add $grp aio_group sub { 688 my $statgrp = add $grp aio_group sub {
592 $grp->result (\@dirs, \@nondirs); 689 $grp->result (\@dirs, \@nondirs);
593 }; 690 };
594 691
595 limit $statgrp $maxreq; 692 limit $statgrp $maxreq;
596 feed $statgrp sub { 693 feed $statgrp sub {
597 return unless @$entries; 694 return unless @$entries;
598 my $entry = pop @$entries; 695 my $entry = pop @$entries;
599 696
600 aioreq_pri $pri; 697 aioreq_pri $pri;
601 add $statgrp aio_stat "$path/$entry/.", sub { 698 add $statgrp aio_stat "$path/$entry/.", sub {
602 if ($_[0] < 0) { 699 if ($_[0] < 0) {
603 push @nondirs, $entry; 700 push @nondirs, $entry;
604 } else { 701 } else {
605 # need to check for real directory 702 # need to check for real directory
606 aioreq_pri $pri; 703 aioreq_pri $pri;
607 add $statgrp aio_lstat "$path/$entry", sub { 704 add $statgrp aio_lstat "$path/$entry", sub {
608 if (-d _) { 705 if (-d _) {
609 push @dirs, $entry; 706 push @dirs, $entry;
610 707
611 unless (--$ndirs) { 708 unless (--$ndirs) {
612 push @nondirs, @$entries; 709 push @nondirs, @$entries;
613 feed $statgrp; 710 feed $statgrp;
711 }
712 } else {
713 push @nondirs, $entry;
614 } 714 }
615 } else {
616 push @nondirs, $entry;
617 } 715 }
618 } 716 }
619 } 717 };
620 }; 718 };
621 }; 719 };
622 }; 720 };
623 }; 721 };
722
723 $grp
624 }; 724 }
725}
625 726
727=item aio_rmtree $path, $callback->($status)
728
729Delete a directory tree starting (and including) C<$path>, return the status of the final C<rmdir> only.
730This is a composite request that uses C<aio_scandir> to recurse into and rmdir directories, and
731unlink everything else.
732
733=cut
734
735sub aio_rmtree;
736sub aio_rmtree {
737 aio_block {
738 my ($path, $cb) = @_;
739
740 my $pri = aioreq_pri;
741 my $grp = aio_group $cb;
742
743 aioreq_pri $pri;
744 add $grp aio_scandir $path, 0, sub {
745 my ($dirs, $nondirs) = @_;
746
747 my $dirgrp = aio_group sub {
748 add $grp aio_rmdir $path, sub {
749 $grp->result ($_[0]);
750 };
751 };
752
753 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
754 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
755
756 add $grp $dirgrp;
757 };
758
626 $grp 759 $grp
760 }
627} 761}
628 762
629=item aio_fsync $fh, $callback->($status) 763=item aio_fsync $fh, $callback->($status)
630 764
631Asynchronously call fsync on the given filehandle and call the callback 765Asynchronously call fsync on the given filehandle and call the callback
… …
845 979
846=back 980=back
847 981
848=head2 SUPPORT FUNCTIONS 982=head2 SUPPORT FUNCTIONS
849 983
984=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
985
850=over 4 986=over 4
851 987
852=item $fileno = IO::AIO::poll_fileno 988=item $fileno = IO::AIO::poll_fileno
853 989
854Return the I<request result pipe file descriptor>. This filehandle must be 990Return the I<request result pipe file descriptor>. This filehandle must be
… …
858 994
859See C<poll_cb> for an example. 995See C<poll_cb> for an example.
860 996
861=item IO::AIO::poll_cb 997=item IO::AIO::poll_cb
862 998
863Process all outstanding events on the result pipe. You have to call this 999Process some outstanding events on the result pipe. You have to call this
864regularly. Returns the number of events processed. Returns immediately 1000regularly. Returns the number of events processed. Returns immediately
865when no events are outstanding. 1001when no events are outstanding. The amount of events processed depends on
1002the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
866 1003
867If not all requests were processed for whatever reason, the filehandle 1004If not all requests were processed for whatever reason, the filehandle
868will still be ready when C<poll_cb> returns. 1005will still be ready when C<poll_cb> returns.
869 1006
870Example: Install an Event watcher that automatically calls 1007Example: Install an Event watcher that automatically calls
… …
872 1009
873 Event->io (fd => IO::AIO::poll_fileno, 1010 Event->io (fd => IO::AIO::poll_fileno,
874 poll => 'r', async => 1, 1011 poll => 'r', async => 1,
875 cb => \&IO::AIO::poll_cb); 1012 cb => \&IO::AIO::poll_cb);
876 1013
877=item IO::AIO::poll_some $max_requests 1014=item IO::AIO::max_poll_reqs $nreqs
878 1015
879Similar to C<poll_cb>, but only processes up to C<$max_requests> requests 1016=item IO::AIO::max_poll_time $seconds
880at a time.
881 1017
882Useful if you want to ensure some level of interactiveness when perl is 1018These set the maximum number of requests (default C<0>, meaning infinity)
883not fast enough to process all requests in time. 1019that are being processed by C<IO::AIO::poll_cb> in one call, respectively
1020the maximum amount of time (default C<0>, meaning infinity) spent in
1021C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
1022of time C<poll_cb> is allowed to use).
1023
1024Setting C<max_poll_time> to a non-zero value creates an overhead of one
1025syscall per request processed, which is not normally a problem unless your
1026callbacks are really really fast or your OS is really really slow (I am
1027not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1028
1029Setting these is useful if you want to ensure some level of
1030interactiveness when perl is not fast enough to process all requests in
1031time.
1032
1033For interactive programs, values such as C<0.01> to C<0.1> should be fine.
884 1034
885Example: Install an Event watcher that automatically calls 1035Example: Install an Event watcher that automatically calls
886IO::AIO::poll_some with low priority, to ensure that other parts of the 1036IO::AIO::poll_cb with low priority, to ensure that other parts of the
887program get the CPU sometimes even under high AIO load. 1037program get the CPU sometimes even under high AIO load.
888 1038
1039 # try not to spend much more than 0.1s in poll_cb
1040 IO::AIO::max_poll_time 0.1;
1041
1042 # use a low priority so other tasks have priority
889 Event->io (fd => IO::AIO::poll_fileno, 1043 Event->io (fd => IO::AIO::poll_fileno,
890 poll => 'r', nice => 1, 1044 poll => 'r', nice => 1,
891 cb => sub { IO::AIO::poll_some 256 }); 1045 cb => &IO::AIO::poll_cb);
892 1046
893=item IO::AIO::poll_wait 1047=item IO::AIO::poll_wait
894 1048
1049If there are any outstanding requests and none of them in the result
895Wait till the result filehandle becomes ready for reading (simply does a 1050phase, wait till the result filehandle becomes ready for reading (simply
896C<select> on the filehandle. This is useful if you want to synchronously wait 1051does a C<select> on the filehandle. This is useful if you want to
897for some requests to finish). 1052synchronously wait for some requests to finish).
898 1053
899See C<nreqs> for an example. 1054See C<nreqs> for an example.
900 1055
1056=item IO::AIO::poll
1057
1058Waits until some requests have been handled.
1059
1060Returns the number of requests processed, but is otherwise strictly
1061equivalent to:
1062
1063 IO::AIO::poll_wait, IO::AIO::poll_cb
1064
901=item IO::AIO::nreqs 1065=item IO::AIO::flush
902 1066
903Returns the number of requests currently in the ready, execute or pending 1067Wait till all outstanding AIO requests have been handled.
904states (i.e. for which their callback has not been invoked yet).
905 1068
906Example: wait till there are no outstanding requests anymore: 1069Strictly equivalent to:
907 1070
908 IO::AIO::poll_wait, IO::AIO::poll_cb 1071 IO::AIO::poll_wait, IO::AIO::poll_cb
909 while IO::AIO::nreqs; 1072 while IO::AIO::nreqs;
910 1073
911=item IO::AIO::nready 1074=head3 CONTROLLING THE NUMBER OF THREADS
912
913Returns the number of requests currently in the ready state (not yet
914executed).
915
916=item IO::AIO::npending
917
918Returns the number of requests currently in the pending state (executed,
919but not yet processed by poll_cb).
920
921=item IO::AIO::flush
922
923Wait till all outstanding AIO requests have been handled.
924
925Strictly equivalent to:
926
927 IO::AIO::poll_wait, IO::AIO::poll_cb
928 while IO::AIO::nreqs;
929
930=item IO::AIO::poll
931
932Waits until some requests have been handled.
933
934Strictly equivalent to:
935
936 IO::AIO::poll_wait, IO::AIO::poll_cb
937 if IO::AIO::nreqs;
938 1075
939=item IO::AIO::min_parallel $nthreads 1076=item IO::AIO::min_parallel $nthreads
940 1077
941Set the minimum number of AIO threads to C<$nthreads>. The current 1078Set the minimum number of AIO threads to C<$nthreads>. The current
942default is C<8>, which means eight asynchronous operations can execute 1079default is C<8>, which means eight asynchronous operations can execute
943concurrently at any one time (the number of outstanding requests, 1080concurrently at any one time (the number of outstanding requests,
944however, is unlimited). 1081however, is unlimited).
945 1082
946IO::AIO starts threads only on demand, when an AIO request is queued and 1083IO::AIO starts threads only on demand, when an AIO request is queued and
947no free thread exists. 1084no free thread exists. Please note that queueing up a hundred requests can
1085create demand for a hundred threads, even if it turns out that everything
1086is in the cache and could have been processed faster by a single thread.
948 1087
949It is recommended to keep the number of threads relatively low, as some 1088It is recommended to keep the number of threads relatively low, as some
950Linux kernel versions will scale negatively with the number of threads 1089Linux kernel versions will scale negatively with the number of threads
951(higher parallelity => MUCH higher latency). With current Linux 2.6 1090(higher parallelity => MUCH higher latency). With current Linux 2.6
952versions, 4-32 threads should be fine. 1091versions, 4-32 threads should be fine.
… …
966This module automatically runs C<max_parallel 0> at program end, to ensure 1105This module automatically runs C<max_parallel 0> at program end, to ensure
967that all threads are killed and that there are no outstanding requests. 1106that all threads are killed and that there are no outstanding requests.
968 1107
969Under normal circumstances you don't need to call this function. 1108Under normal circumstances you don't need to call this function.
970 1109
1110=item IO::AIO::max_idle $nthreads
1111
1112Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1113threads that did not get a request to process within 10 seconds). That
1114means if a thread becomes idle while C<$nthreads> other threads are also
1115idle, it will free its resources and exit.
1116
1117This is useful when you allow a large number of threads (e.g. 100 or 1000)
1118to allow for extremely high load situations, but want to free resources
1119under normal circumstances (1000 threads can easily consume 30MB of RAM).
1120
1121The default is probably ok in most situations, especially if thread
1122creation is fast. If thread creation is very slow on your system you might
1123want to use larger values.
1124
971=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1125=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
972 1126
973This is a very bad function to use in interactive programs because it 1127This is a very bad function to use in interactive programs because it
974blocks, and a bad way to reduce concurrency because it is inexact: Better 1128blocks, and a bad way to reduce concurrency because it is inexact: Better
975use an C<aio_group> together with a feed callback. 1129use an C<aio_group> together with a feed callback.
… …
984 1138
985You can still queue as many requests as you want. Therefore, 1139You can still queue as many requests as you want. Therefore,
986C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1140C<max_oustsanding> is mainly useful in simple scripts (with low values) or
987as a stop gap to shield against fatal memory overflow (with large values). 1141as a stop gap to shield against fatal memory overflow (with large values).
988 1142
1143=head3 STATISTICAL INFORMATION
1144
1145=item IO::AIO::nreqs
1146
1147Returns the number of requests currently in the ready, execute or pending
1148states (i.e. for which their callback has not been invoked yet).
1149
1150Example: wait till there are no outstanding requests anymore:
1151
1152 IO::AIO::poll_wait, IO::AIO::poll_cb
1153 while IO::AIO::nreqs;
1154
1155=item IO::AIO::nready
1156
1157Returns the number of requests currently in the ready state (not yet
1158executed).
1159
1160=item IO::AIO::npending
1161
1162Returns the number of requests currently in the pending state (executed,
1163but not yet processed by poll_cb).
1164
989=back 1165=back
990 1166
991=cut 1167=cut
992 1168
993# support function to convert a fd into a perl filehandle 1169# support function to convert a fd into a perl filehandle
… …
1006 *$sym 1182 *$sym
1007} 1183}
1008 1184
1009min_parallel 8; 1185min_parallel 8;
1010 1186
1011END { 1187END { flush }
1012 min_parallel 1;
1013 flush;
1014};
1015 1188
10161; 11891;
1017 1190
1018=head2 FORK BEHAVIOUR 1191=head2 FORK BEHAVIOUR
1019 1192

Diff Legend

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