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.77 by root, Wed Oct 25 17:57:30 2006 UTC vs.
Revision 1.91 by root, Mon Oct 30 23:30:29 2006 UTC

50 50
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
56Asynchronous means that operations that can normally block your program
57(e.g. reading from disk) will be done asynchronously: the operation
58will still block, but you can do something else in the meantime. This
59is extremely useful for programs that need to stay interactive even
60when doing heavy I/O (GUI programs, high performance network servers
61etc.), 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
63on a RAID volume or over NFS when you do a number of stat operations
64concurrently.
65
66While most of this works on all types of file descriptors (for example
67sockets), using these functions on file descriptors that support
68nonblocking operation (again, sockets, pipes etc.) is very inefficient or
69might not work (aio_read fails on sockets/pipes/fifos). Use an event loop
70for that (such as the L<Event|Event> module): IO::AIO will naturally fit
71into such an event loop itself.
55 72
56In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
57requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
58in perl, and the threads created by this module will not be visible 75in perl, and the threads created by this module will not be visible
59to perl. In the future, this module might make use of the native aio 76to perl. In the future, this module might make use of the native aio
60functions available on many operating systems. However, they are often 77functions available on many operating systems. However, they are often
61not well-supported or restricted (Linux doesn't allow them on normal 78not well-supported or restricted (GNU/Linux doesn't allow them on normal
62files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
63aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
64using threads anyway. 81using threads anyway.
65 82
66Although the module will work with in the presence of other (Perl-) 83Although the module will work with in the presence of other (Perl-)
67threads, it is currently not reentrant in any way, so use appropriate 84threads, it is currently not reentrant in any way, so use appropriate
68locking yourself, always call C<poll_cb> from within the same thread, or 85locking yourself, always call C<poll_cb> from within the same thread, or
69never call C<poll_cb> (or other C<aio_> functions) recursively. 86never call C<poll_cb> (or other C<aio_> functions) recursively.
70 87
88=head2 EXAMPLE
89
90This is a simple example that uses the Event module and loads
91F</etc/passwd> asynchronously:
92
93 use Fcntl;
94 use Event;
95 use IO::AIO;
96
97 # register the IO::AIO callback with Event
98 Event->io (fd => IO::AIO::poll_fileno,
99 poll => 'r',
100 cb => \&IO::AIO::poll_cb);
101
102 # queue the request to open /etc/passwd
103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
104 my $fh = $_[0]
105 or die "error while opening: $!";
106
107 # stat'ing filehandles is generally non-blocking
108 my $size = -s $fh;
109
110 # queue a request to read the file
111 my $contents;
112 aio_read $fh, 0, $size, $contents, 0, sub {
113 $_[0] == $size
114 or die "short read: $!";
115
116 close $fh;
117
118 # file contents now in $contents
119 print $contents;
120
121 # exit event loop and program
122 Event::unloop;
123 };
124 };
125
126 # possibly queue up other requests, or open GUI windows,
127 # check for sockets etc. etc.
128
129 # process events as long as there are some:
130 Event::loop;
131
71=head1 REQUEST ANATOMY AND LIFETIME 132=head1 REQUEST ANATOMY AND LIFETIME
72 133
73Every C<aio_*> function creates a request. which is a C data structure not 134Every C<aio_*> function creates a request. which is a C data structure not
74directly visible to Perl. 135directly visible to Perl.
75 136
116Request has reached the end of its lifetime and holds no resources anymore 177Request 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 178(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 179aio request is severed and calling its methods will either do nothing or
119result in a runtime error). 180result in a runtime error).
120 181
182=back
183
121=cut 184=cut
122 185
123package IO::AIO; 186package IO::AIO;
124 187
125no warnings; 188no warnings;
126use strict 'vars'; 189use strict 'vars';
127 190
128use base 'Exporter'; 191use base 'Exporter';
129 192
130BEGIN { 193BEGIN {
131 our $VERSION = '2.0'; 194 our $VERSION = '2.2';
132 195
133 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
134 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
135 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
136 aio_group aio_nop); 199 aio_move aio_copy aio_group aio_nop aio_mknod);
137 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 200 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
138 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 201 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
139 min_parallel max_parallel nreqs); 202 min_parallel max_parallel max_idle
203 nreqs nready npending nthreads
204 max_poll_time max_poll_reqs);
140 205
141 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 206 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
142 207
143 require XSLoader; 208 require XSLoader;
144 XSLoader::load ("IO::AIO", $VERSION); 209 XSLoader::load ("IO::AIO", $VERSION);
145} 210}
146 211
147=head1 FUNCTIONS 212=head1 FUNCTIONS
148 213
149=head2 AIO FUNCTIONS 214=head2 AIO REQUEST FUNCTIONS
150 215
151All the C<aio_*> calls are more or less thin wrappers around the syscall 216All the C<aio_*> calls are more or less thin wrappers around the syscall
152with the same name (sans C<aio_>). The arguments are similar or identical, 217with the same name (sans C<aio_>). The arguments are similar or identical,
153and they all accept an additional (and optional) C<$callback> argument 218and they all accept an additional (and optional) C<$callback> argument
154which must be a code reference. This code reference will get called with 219which must be a code reference. This code reference will get called with
157syscall has been executed asynchronously. 222syscall has been executed asynchronously.
158 223
159All functions expecting a filehandle keep a copy of the filehandle 224All functions expecting a filehandle keep a copy of the filehandle
160internally until the request has finished. 225internally until the request has finished.
161 226
162All requests return objects of type L<IO::AIO::REQ> that allow further 227All functions return request objects of type L<IO::AIO::REQ> that allow
163manipulation of those requests while they are in-flight. 228further manipulation of those requests while they are in-flight.
164 229
165The pathnames you pass to these routines I<must> be absolute and 230The pathnames you pass to these routines I<must> be absolute and
166encoded in byte form. The reason for the former is that at the time the 231encoded as octets. The reason for the former is that at the time the
167request is being executed, the current working directory could have 232request is being executed, the current working directory could have
168changed. Alternatively, you can make sure that you never change the 233changed. Alternatively, you can make sure that you never change the
169current working directory. 234current working directory anywhere in the program and then use relative
235paths.
170 236
171To encode pathnames to byte form, either make sure you either: a) 237To encode pathnames as octets, either make sure you either: a) always pass
172always pass in filenames you got from outside (command line, readdir 238in filenames you got from outside (command line, readdir etc.) without
173etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 239tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
174your pathnames to the locale (or other) encoding in effect in the user 240your pathnames to the locale (or other) encoding in effect in the user
175environment, d) use Glib::filename_from_unicode on unicode filenames or e) 241environment, d) use Glib::filename_from_unicode on unicode filenames or e)
176use something else. 242use something else to ensure your scalar has the correct contents.
243
244This works, btw. independent of the internal UTF-8 bit, which IO::AIO
245handles correctly wether it is set or not.
177 246
178=over 4 247=over 4
179 248
180=item aioreq_pri $pri 249=item $prev_pri = aioreq_pri [$pri]
181 250
182Sets the priority for the next aio request. The default priority 251Returns the priority value that would be used for the next request and, if
252C<$pri> is given, sets the priority for the next aio request.
253
183is C<0>, the minimum and maximum priorities are C<-4> and C<4>, 254The default priority is C<0>, the minimum and maximum priorities are C<-4>
184respectively. Requests with higher priority will be serviced first. 255and C<4>, respectively. Requests with higher priority will be serviced
256first.
185 257
186The priority will be reset to C<0> after each call to one of the C<aio_> 258The priority will be reset to C<0> after each call to one of the C<aio_*>
187functions. 259functions.
188 260
189Example: open a file with low priority, then read something from it with 261Example: open a file with low priority, then read something from it with
190higher priority so the read request is serviced before other low priority 262higher priority so the read request is serviced before other low priority
191open requests (potentially spamming the cache): 263open requests (potentially spamming the cache):
201 }; 273 };
202 274
203=item aioreq_nice $pri_adjust 275=item aioreq_nice $pri_adjust
204 276
205Similar to C<aioreq_pri>, but subtracts the given value from the current 277Similar to C<aioreq_pri>, but subtracts the given value from the current
206priority, so effects are cumulative. 278priority, so the effect is cumulative.
207 279
208=item aio_open $pathname, $flags, $mode, $callback->($fh) 280=item aio_open $pathname, $flags, $mode, $callback->($fh)
209 281
210Asynchronously open or create a file and call the callback with a newly 282Asynchronously open or create a file and call the callback with a newly
211created filehandle for the file. 283created filehandle for the file.
261 333
262 aio_read $fh, 7, 15, $buffer, 0, sub { 334 aio_read $fh, 7, 15, $buffer, 0, sub {
263 $_[0] > 0 or die "read error: $!"; 335 $_[0] > 0 or die "read error: $!";
264 print "read $_[0] bytes: <$buffer>\n"; 336 print "read $_[0] bytes: <$buffer>\n";
265 }; 337 };
266
267=item aio_move $srcpath, $dstpath, $callback->($status)
268
269Try to move the I<file> (directories not supported as either source or
270destination) from C<$srcpath> to C<$dstpath> and call the callback with
271the C<0> (error) or C<-1> ok.
272
273This is a composite request that tries to rename(2) the file first. If
274rename files with C<EXDEV>, it creates the destination file with mode 0200
275and copies the contents of the source file into it using C<aio_sendfile>,
276followed by restoring atime, mtime, access mode and uid/gid, in that
277order, and unlinking the C<$srcpath>.
278
279If an error occurs, the partial destination file will be unlinked, if
280possible, except when setting atime, mtime, access mode and uid/gid, where
281errors are being ignored.
282
283=cut
284
285sub aio_move($$$) {
286 my ($src, $dst, $cb) = @_;
287
288 my $grp = aio_group $cb;
289
290 add $grp aio_rename $src, $dst, sub {
291 if ($_[0] && $! == EXDEV) {
292 add $grp aio_open $src, O_RDONLY, 0, sub {
293 if (my $src_fh = $_[0]) {
294 my @stat = stat $src_fh;
295
296 add $grp aio_open $dst, O_WRONLY, 0200, sub {
297 if (my $dst_fh = $_[0]) {
298 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
299 close $src_fh;
300
301 if ($_[0] == $stat[7]) {
302 utime $stat[8], $stat[9], $dst;
303 chmod $stat[2] & 07777, $dst_fh;
304 chown $stat[4], $stat[5], $dst_fh;
305 close $dst_fh;
306
307 add $grp aio_unlink $src, sub {
308 $grp->result ($_[0]);
309 };
310 } else {
311 my $errno = $!;
312 add $grp aio_unlink $dst, sub {
313 $! = $errno;
314 $grp->result (-1);
315 };
316 }
317 };
318 } else {
319 $grp->result (-1);
320 }
321 },
322
323 } else {
324 $grp->result (-1);
325 }
326 };
327 } else {
328 $grp->result ($_[0]);
329 }
330 };
331
332 $grp
333}
334 338
335=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 339=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
336 340
337Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 341Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
338reading at byte offset C<$in_offset>, and starts writing at the current 342reading at byte offset C<$in_offset>, and starts writing at the current
394=item aio_unlink $pathname, $callback->($status) 398=item aio_unlink $pathname, $callback->($status)
395 399
396Asynchronously unlink (delete) a file and call the callback with the 400Asynchronously unlink (delete) a file and call the callback with the
397result code. 401result code.
398 402
403=item aio_mknod $path, $mode, $dev, $callback->($status)
404
405[EXPERIMENTAL]
406
407Asynchronously create a device node (or fifo). See mknod(2).
408
409The only (POSIX-) portable way of calling this function is:
410
411 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
412
399=item aio_link $srcpath, $dstpath, $callback->($status) 413=item aio_link $srcpath, $dstpath, $callback->($status)
400 414
401Asynchronously create a new link to the existing object at C<$srcpath> at 415Asynchronously create a new link to the existing object at C<$srcpath> at
402the path C<$dstpath> and call the callback with the result code. 416the path C<$dstpath> and call the callback with the result code.
403 417
404=item aio_symlink $srcpath, $dstpath, $callback->($status) 418=item aio_symlink $srcpath, $dstpath, $callback->($status)
405 419
406Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 420Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
407the path C<$dstpath> and call the callback with the result code. 421the path C<$dstpath> and call the callback with the result code.
422
423=item aio_readlink $path, $callback->($link)
424
425Asynchronously read the symlink specified by C<$path> and pass it to
426the callback. If an error occurs, nothing or undef gets passed to the
427callback.
408 428
409=item aio_rename $srcpath, $dstpath, $callback->($status) 429=item aio_rename $srcpath, $dstpath, $callback->($status)
410 430
411Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 431Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
412rename(2) and call the callback with the result code. 432rename(2) and call the callback with the result code.
422directory (i.e. opendir + readdir + closedir). The entries will not be 442directory (i.e. opendir + readdir + closedir). The entries will not be
423sorted, and will B<NOT> include the C<.> and C<..> entries. 443sorted, and will B<NOT> include the C<.> and C<..> entries.
424 444
425The callback a single argument which is either C<undef> or an array-ref 445The callback a single argument which is either C<undef> or an array-ref
426with the filenames. 446with the filenames.
447
448=item aio_copy $srcpath, $dstpath, $callback->($status)
449
450Try to copy the I<file> (directories not supported as either source or
451destination) from C<$srcpath> to C<$dstpath> and call the callback with
452the C<0> (error) or C<-1> ok.
453
454This is a composite request that it creates the destination file with
455mode 0200 and copies the contents of the source file into it using
456C<aio_sendfile>, followed by restoring atime, mtime, access mode and
457uid/gid, in that order.
458
459If an error occurs, the partial destination file will be unlinked, if
460possible, except when setting atime, mtime, access mode and uid/gid, where
461errors are being ignored.
462
463=cut
464
465sub aio_copy($$;$) {
466 my ($src, $dst, $cb) = @_;
467
468 my $pri = aioreq_pri;
469 my $grp = aio_group $cb;
470
471 aioreq_pri $pri;
472 add $grp aio_open $src, O_RDONLY, 0, sub {
473 if (my $src_fh = $_[0]) {
474 my @stat = stat $src_fh;
475
476 aioreq_pri $pri;
477 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
478 if (my $dst_fh = $_[0]) {
479 aioreq_pri $pri;
480 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
481 if ($_[0] == $stat[7]) {
482 $grp->result (0);
483 close $src_fh;
484
485 # those should not normally block. should. should.
486 utime $stat[8], $stat[9], $dst;
487 chmod $stat[2] & 07777, $dst_fh;
488 chown $stat[4], $stat[5], $dst_fh;
489 close $dst_fh;
490 } else {
491 $grp->result (-1);
492 close $src_fh;
493 close $dst_fh;
494
495 aioreq $pri;
496 add $grp aio_unlink $dst;
497 }
498 };
499 } else {
500 $grp->result (-1);
501 }
502 },
503
504 } else {
505 $grp->result (-1);
506 }
507 };
508
509 $grp
510}
511
512=item aio_move $srcpath, $dstpath, $callback->($status)
513
514Try to move the I<file> (directories not supported as either source or
515destination) from C<$srcpath> to C<$dstpath> and call the callback with
516the C<0> (error) or C<-1> ok.
517
518This is a composite request that tries to rename(2) the file first. If
519rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
520that is successful, unlinking the C<$srcpath>.
521
522=cut
523
524sub aio_move($$;$) {
525 my ($src, $dst, $cb) = @_;
526
527 my $pri = aioreq_pri;
528 my $grp = aio_group $cb;
529
530 aioreq_pri $pri;
531 add $grp aio_rename $src, $dst, sub {
532 if ($_[0] && $! == EXDEV) {
533 aioreq_pri $pri;
534 add $grp aio_copy $src, $dst, sub {
535 $grp->result ($_[0]);
536
537 if (!$_[0]) {
538 aioreq_pri $pri;
539 add $grp aio_unlink $src;
540 }
541 };
542 } else {
543 $grp->result ($_[0]);
544 }
545 };
546
547 $grp
548}
427 549
428=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 550=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
429 551
430Scans a directory (similar to C<aio_readdir>) but additionally tries to 552Scans a directory (similar to C<aio_readdir>) but additionally tries to
431efficiently separate the entries of directory C<$path> into two sets of 553efficiently separate the entries of directory C<$path> into two sets of
433recurse into (everything else, including symlinks to directories). 555recurse into (everything else, including symlinks to directories).
434 556
435C<aio_scandir> is a composite request that creates of many sub requests_ 557C<aio_scandir> is a composite request that creates of many sub requests_
436C<$maxreq> specifies the maximum number of outstanding aio requests that 558C<$maxreq> specifies the maximum number of outstanding aio requests that
437this function generates. If it is C<< <= 0 >>, then a suitable default 559this function generates. If it is C<< <= 0 >>, then a suitable default
438will be chosen (currently 6). 560will be chosen (currently 4).
439 561
440On error, the callback is called without arguments, otherwise it receives 562On error, the callback is called without arguments, otherwise it receives
441two array-refs with path-relative entry names. 563two array-refs with path-relative entry names.
442 564
443Example: 565Example:
480=cut 602=cut
481 603
482sub aio_scandir($$$) { 604sub aio_scandir($$$) {
483 my ($path, $maxreq, $cb) = @_; 605 my ($path, $maxreq, $cb) = @_;
484 606
607 my $pri = aioreq_pri;
608
485 my $grp = aio_group $cb; 609 my $grp = aio_group $cb;
486 610
487 $maxreq = 6 if $maxreq <= 0; 611 $maxreq = 4 if $maxreq <= 0;
488 612
489 # stat once 613 # stat once
614 aioreq_pri $pri;
490 add $grp aio_stat $path, sub { 615 add $grp aio_stat $path, sub {
491 return $grp->result () if $_[0]; 616 return $grp->result () if $_[0];
492 my $now = time; 617 my $now = time;
493 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 618 my $hash1 = join ":", (stat _)[0,1,3,7,9];
494 619
495 # read the directory entries 620 # read the directory entries
621 aioreq_pri $pri;
496 add $grp aio_readdir $path, sub { 622 add $grp aio_readdir $path, sub {
497 my $entries = shift 623 my $entries = shift
498 or return $grp->result (); 624 or return $grp->result ();
499 625
500 # stat the dir another time 626 # stat the dir another time
627 aioreq_pri $pri;
501 add $grp aio_stat $path, sub { 628 add $grp aio_stat $path, sub {
502 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 629 my $hash2 = join ":", (stat _)[0,1,3,7,9];
503 630
504 my $ndirs; 631 my $ndirs;
505 632
529 limit $statgrp $maxreq; 656 limit $statgrp $maxreq;
530 feed $statgrp sub { 657 feed $statgrp sub {
531 return unless @$entries; 658 return unless @$entries;
532 my $entry = pop @$entries; 659 my $entry = pop @$entries;
533 660
661 aioreq_pri $pri;
534 add $statgrp aio_stat "$path/$entry/.", sub { 662 add $statgrp aio_stat "$path/$entry/.", sub {
535 if ($_[0] < 0) { 663 if ($_[0] < 0) {
536 push @nondirs, $entry; 664 push @nondirs, $entry;
537 } else { 665 } else {
538 # need to check for real directory 666 # need to check for real directory
667 aioreq_pri $pri;
539 add $statgrp aio_lstat "$path/$entry", sub { 668 add $statgrp aio_lstat "$path/$entry", sub {
540 if (-d _) { 669 if (-d _) {
541 push @dirs, $entry; 670 push @dirs, $entry;
542 671
543 unless (--$ndirs) { 672 unless (--$ndirs) {
714itself. Useful when you queued a lot of events but got a result early. 843itself. Useful when you queued a lot of events but got a result early.
715 844
716=item $grp->result (...) 845=item $grp->result (...)
717 846
718Set the result value(s) that will be passed to the group callback when all 847Set the result value(s) that will be passed to the group callback when all
719subrequests have finished. By default, no argument will be passed. 848subrequests have finished and set thre groups errno to the current value
849of errno (just like calling C<errno> without an error number). By default,
850no argument will be passed and errno is zero.
851
852=item $grp->errno ([$errno])
853
854Sets the group errno value to C<$errno>, or the current value of errno
855when the argument is missing.
856
857Every aio request has an associated errno value that is restored when
858the callback is invoked. This method lets you change this value from its
859default (0).
860
861Calling C<result> will also set errno, so make sure you either set C<$!>
862before the call to C<result>, or call c<errno> after it.
720 863
721=item feed $grp $callback->($grp) 864=item feed $grp $callback->($grp)
722 865
723Sets a feeder/generator on this group: every group can have an attached 866Sets a feeder/generator on this group: every group can have an attached
724generator that generates requests if idle. The idea behind this is that, 867generator that generates requests if idle. The idea behind this is that,
763 906
764=back 907=back
765 908
766=head2 SUPPORT FUNCTIONS 909=head2 SUPPORT FUNCTIONS
767 910
911=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
912
768=over 4 913=over 4
769 914
770=item $fileno = IO::AIO::poll_fileno 915=item $fileno = IO::AIO::poll_fileno
771 916
772Return the I<request result pipe file descriptor>. This filehandle must be 917Return the I<request result pipe file descriptor>. This filehandle must be
776 921
777See C<poll_cb> for an example. 922See C<poll_cb> for an example.
778 923
779=item IO::AIO::poll_cb 924=item IO::AIO::poll_cb
780 925
781Process all outstanding events on the result pipe. You have to call this 926Process some outstanding events on the result pipe. You have to call this
782regularly. Returns the number of events processed. Returns immediately 927regularly. Returns the number of events processed. Returns immediately
783when no events are outstanding. 928when no events are outstanding. The amount of events processed depends on
929the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
930
931If not all requests were processed for whatever reason, the filehandle
932will still be ready when C<poll_cb> returns.
784 933
785Example: Install an Event watcher that automatically calls 934Example: Install an Event watcher that automatically calls
786IO::AIO::poll_cb with high priority: 935IO::AIO::poll_cb with high priority:
787 936
788 Event->io (fd => IO::AIO::poll_fileno, 937 Event->io (fd => IO::AIO::poll_fileno,
789 poll => 'r', async => 1, 938 poll => 'r', async => 1,
790 cb => \&IO::AIO::poll_cb); 939 cb => \&IO::AIO::poll_cb);
791 940
941=item IO::AIO::max_poll_reqs $nreqs
942
943=item IO::AIO::max_poll_time $seconds
944
945These set the maximum number of requests (default C<0>, meaning infinity)
946that are being processed by C<IO::AIO::poll_cb> in one call, respectively
947the maximum amount of time (default C<0>, meaning infinity) spent in
948C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
949of time C<poll_cb> is allowed to use).
950
951Setting C<max_poll_time> to a non-zero value creates an overhead of one
952syscall per request processed, which is not normally a problem unless your
953callbacks are really really fast or your OS is really really slow (I am
954not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
955
956Setting these is useful if you want to ensure some level of
957interactiveness when perl is not fast enough to process all requests in
958time.
959
960For interactive programs, values such as C<0.01> to C<0.1> should be fine.
961
962Example: Install an Event watcher that automatically calls
963IO::AIO::poll_cb with low priority, to ensure that other parts of the
964program get the CPU sometimes even under high AIO load.
965
966 # try not to spend much more than 0.1s in poll_cb
967 IO::AIO::max_poll_time 0.1;
968
969 # use a low priority so other tasks have priority
970 Event->io (fd => IO::AIO::poll_fileno,
971 poll => 'r', nice => 1,
972 cb => &IO::AIO::poll_cb);
973
792=item IO::AIO::poll_wait 974=item IO::AIO::poll_wait
793 975
794Wait till the result filehandle becomes ready for reading (simply does a 976Wait till the result filehandle becomes ready for reading (simply does a
795C<select> on the filehandle. This is useful if you want to synchronously wait 977C<select> on the filehandle. This is useful if you want to synchronously
796for some requests to finish). 978wait for some requests to finish).
797 979
798See C<nreqs> for an example. 980See C<nreqs> for an example.
799 981
982=item IO::AIO::poll
983
984Waits until some requests have been handled.
985
986Strictly equivalent to:
987
988 IO::AIO::poll_wait, IO::AIO::poll_cb
989 if IO::AIO::nreqs;
990
800=item IO::AIO::nreqs 991=item IO::AIO::flush
801 992
802Returns the number of requests currently outstanding (i.e. for which their 993Wait till all outstanding AIO requests have been handled.
803callback has not been invoked yet).
804 994
805Example: wait till there are no outstanding requests anymore: 995Strictly equivalent to:
806 996
807 IO::AIO::poll_wait, IO::AIO::poll_cb 997 IO::AIO::poll_wait, IO::AIO::poll_cb
808 while IO::AIO::nreqs; 998 while IO::AIO::nreqs;
809 999
810=item IO::AIO::flush 1000=head3 CONTROLLING THE NUMBER OF THREADS
811
812Wait till all outstanding AIO requests have been handled.
813
814Strictly equivalent to:
815
816 IO::AIO::poll_wait, IO::AIO::poll_cb
817 while IO::AIO::nreqs;
818
819=item IO::AIO::poll
820
821Waits until some requests have been handled.
822
823Strictly equivalent to:
824
825 IO::AIO::poll_wait, IO::AIO::poll_cb
826 if IO::AIO::nreqs;
827 1001
828=item IO::AIO::min_parallel $nthreads 1002=item IO::AIO::min_parallel $nthreads
829 1003
830Set the minimum number of AIO threads to C<$nthreads>. The current 1004Set the minimum number of AIO threads to C<$nthreads>. The current
831default is C<8>, which means eight asynchronous operations can execute 1005default is C<8>, which means eight asynchronous operations can execute
832concurrently at any one time (the number of outstanding requests, 1006concurrently at any one time (the number of outstanding requests,
833however, is unlimited). 1007however, is unlimited).
834 1008
835IO::AIO starts threads only on demand, when an AIO request is queued and 1009IO::AIO starts threads only on demand, when an AIO request is queued and
836no free thread exists. 1010no free thread exists. Please note that queueing up a hundred requests can
1011create demand for a hundred threads, even if it turns out that everything
1012is in the cache and could have been processed faster by a single thread.
837 1013
838It is recommended to keep the number of threads relatively low, as some 1014It is recommended to keep the number of threads relatively low, as some
839Linux kernel versions will scale negatively with the number of threads 1015Linux kernel versions will scale negatively with the number of threads
840(higher parallelity => MUCH higher latency). With current Linux 2.6 1016(higher parallelity => MUCH higher latency). With current Linux 2.6
841versions, 4-32 threads should be fine. 1017versions, 4-32 threads should be fine.
855This module automatically runs C<max_parallel 0> at program end, to ensure 1031This module automatically runs C<max_parallel 0> at program end, to ensure
856that all threads are killed and that there are no outstanding requests. 1032that all threads are killed and that there are no outstanding requests.
857 1033
858Under normal circumstances you don't need to call this function. 1034Under normal circumstances you don't need to call this function.
859 1035
1036=item IO::AIO::max_idle $nthreads
1037
1038Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1039threads that did not get a request to process within 10 seconds). That
1040means if a thread becomes idle while C<$nthreads> other threads are also
1041idle, it will free its resources and exit.
1042
1043This is useful when you allow a large number of threads (e.g. 100 or 1000)
1044to allow for extremely high load situations, but want to free resources
1045under normal circumstances (1000 threads can easily consume 30MB of RAM).
1046
1047The default is probably ok in most situations, especially if thread
1048creation is fast. If thread creation is very slow on your system you might
1049want to use larger values.
1050
860=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1051=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
861 1052
862[REMOVED] 1053This is a very bad function to use in interactive programs because it
1054blocks, and a bad way to reduce concurrency because it is inexact: Better
1055use an C<aio_group> together with a feed callback.
863 1056
864Pre-2.x versions used max_outstanding for a crude request queue length limit.
865
866In 2.x+ you are advised to use a group and a feeder to limit
867concurrency. The max_outstanding feature ran very unstable (endless
868recursions causing segfaults, bad interaction with groups etc.) and was
869removed.
870
871I am deeply sorry, but I am still on the hunt for a good limiting interface.
872
873Original description was as follows:
874
875Sets the maximum number of outstanding requests to C<$nreqs>. If you try 1057Sets the maximum number of outstanding requests to C<$nreqs>. If you
876to queue up more than this number of requests, the caller will block until 1058to queue up more than this number of requests, the next call to the
877some requests have been handled. 1059C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1060function will block until the limit is no longer exceeded.
1061
1062The default value is very large, so there is no practical limit on the
1063number of outstanding requests.
1064
1065You can still queue as many requests as you want. Therefore,
1066C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1067as a stop gap to shield against fatal memory overflow (with large values).
1068
1069=head3 STATISTICAL INFORMATION
1070
1071=item IO::AIO::nreqs
1072
1073Returns the number of requests currently in the ready, execute or pending
1074states (i.e. for which their callback has not been invoked yet).
1075
1076Example: wait till there are no outstanding requests anymore:
1077
1078 IO::AIO::poll_wait, IO::AIO::poll_cb
1079 while IO::AIO::nreqs;
1080
1081=item IO::AIO::nready
1082
1083Returns the number of requests currently in the ready state (not yet
1084executed).
1085
1086=item IO::AIO::npending
1087
1088Returns the number of requests currently in the pending state (executed,
1089but not yet processed by poll_cb).
878 1090
879=back 1091=back
880 1092
881=cut 1093=cut
882 1094
897} 1109}
898 1110
899min_parallel 8; 1111min_parallel 8;
900 1112
901END { 1113END {
902 max_parallel 0; 1114 min_parallel 1;
903} 1115 flush;
1116};
904 1117
9051; 11181;
906 1119
907=head2 FORK BEHAVIOUR 1120=head2 FORK BEHAVIOUR
908 1121

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines