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.87 by root, Sun Oct 29 00:52:02 2006 UTC vs.
Revision 1.111 by root, Mon Aug 13 12:08:13 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
67using these functions on file descriptors that support nonblocking 68example sockets), using these functions on file descriptors that
68operation (again, sockets, pipes etc.) is very inefficient. Use an event 69support nonblocking operation (again, sockets, pipes etc.) is very
69loop for that (such as the L<Event|Event> module): IO::AIO will naturally 70inefficient. Use an event loop for that (such as the L<Event|Event>
70fit into such an event loop itself. 71module): IO::AIO will naturally fit into such an event loop itself.
71 72
72In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
73requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
74in 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
75to 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
77not well-supported or restricted (GNU/Linux doesn't allow them on normal 78not well-supported or restricted (GNU/Linux doesn't allow them on normal
78files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
79aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
80using threads anyway. 81using threads anyway.
81 82
82Although the module will work with in the presence of other (Perl-) 83Although the module will work in the presence of other (Perl-) threads,
83threads, it is currently not reentrant in any way, so use appropriate 84it is currently not reentrant in any way, so use appropriate locking
84locking yourself, always call C<poll_cb> from within the same thread, or 85yourself, always call C<poll_cb> from within the same thread, or never
85never call C<poll_cb> (or other C<aio_> functions) recursively. 86call C<poll_cb> (or other C<aio_> functions) recursively.
86 87
87=head2 EXAMPLE 88=head2 EXAMPLE
88 89
89This is a simple example that uses the Event module and loads 90This is a simple example that uses the Event module and loads
90F</etc/passwd> asynchronously: 91F</etc/passwd> asynchronously:
98 poll => 'r', 99 poll => 'r',
99 cb => \&IO::AIO::poll_cb); 100 cb => \&IO::AIO::poll_cb);
100 101
101 # queue the request to open /etc/passwd 102 # queue the request to open /etc/passwd
102 aio_open "/etc/passwd", O_RDONLY, 0, sub { 103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
103 my $fh = $_[0] 104 my $fh = shift
104 or die "error while opening: $!"; 105 or die "error while opening: $!";
105 106
106 # stat'ing filehandles is generally non-blocking 107 # stat'ing filehandles is generally non-blocking
107 my $size = -s $fh; 108 my $size = -s $fh;
108 109
176Request 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
177(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
178aio 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
179result in a runtime error). 180result in a runtime error).
180 181
182=back
183
181=cut 184=cut
182 185
183package IO::AIO; 186package IO::AIO;
184 187
185no warnings; 188no warnings;
186use strict 'vars'; 189use strict 'vars';
187 190
188use base 'Exporter'; 191use base 'Exporter';
189 192
190BEGIN { 193BEGIN {
191 our $VERSION = '2.1'; 194 our $VERSION = '2.4';
192 195
193 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
194 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
195 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
196 aio_copy aio_group aio_nop aio_mknod); 199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
200 aio_chown aio_chmod aio_utime aio_truncate);
197 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
198 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
199 min_parallel max_parallel max_idle 203 min_parallel max_parallel max_idle
200 nreqs nready npending nthreads 204 nreqs nready npending nthreads
201 max_poll_time max_poll_reqs); 205 max_poll_time max_poll_reqs);
202 206
267 aio_read $_[0], ..., sub { 271 aio_read $_[0], ..., sub {
268 ... 272 ...
269 }; 273 };
270 }; 274 };
271 275
276
272=item aioreq_nice $pri_adjust 277=item aioreq_nice $pri_adjust
273 278
274Similar to C<aioreq_pri>, but subtracts the given value from the current 279Similar to C<aioreq_pri>, but subtracts the given value from the current
275priority, so the effect is cumulative. 280priority, so the effect is cumulative.
281
276 282
277=item aio_open $pathname, $flags, $mode, $callback->($fh) 283=item aio_open $pathname, $flags, $mode, $callback->($fh)
278 284
279Asynchronously open or create a file and call the callback with a newly 285Asynchronously open or create a file and call the callback with a newly
280created filehandle for the file. 286created filehandle for the file.
286list. They are the same as used by C<sysopen>. 292list. They are the same as used by C<sysopen>.
287 293
288Likewise, C<$mode> specifies the mode of the newly created file, if it 294Likewise, C<$mode> specifies the mode of the newly created file, if it
289didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 295didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
290except that it is mandatory (i.e. use C<0> if you don't create new files, 296except that it is mandatory (i.e. use C<0> if you don't create new files,
291and C<0666> or C<0777> if you do). 297and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
298by the umask in effect then the request is being executed, so better never
299change the umask.
292 300
293Example: 301Example:
294 302
295 aio_open "/etc/passwd", O_RDONLY, 0, sub { 303 aio_open "/etc/passwd", O_RDONLY, 0, sub {
296 if ($_[0]) { 304 if ($_[0]) {
299 } else { 307 } else {
300 die "open failed: $!\n"; 308 die "open failed: $!\n";
301 } 309 }
302 }; 310 };
303 311
312
304=item aio_close $fh, $callback->($status) 313=item aio_close $fh, $callback->($status)
305 314
306Asynchronously close a file and call the callback with the result 315Asynchronously close a file and call the callback with the result
307code. I<WARNING:> although accepted, you should not pass in a perl 316code. I<WARNING:> although accepted, you should not pass in a perl
308filehandle here, as perl will likely close the file descriptor another 317filehandle here, as perl will likely close the file descriptor another
310C<close> or just let filehandles go out of scope. 319C<close> or just let filehandles go out of scope.
311 320
312This is supposed to be a bug in the API, so that might change. It's 321This is supposed to be a bug in the API, so that might change. It's
313therefore best to avoid this function. 322therefore best to avoid this function.
314 323
324
315=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
316 326
317=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
318 328
319Reads or writes C<length> bytes from the specified C<fh> and C<offset> 329Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
320into the scalar given by C<data> and offset C<dataoffset> and calls the 330into the scalar given by C<$data> and offset C<$dataoffset> and calls the
321callback without the actual number of bytes read (or -1 on error, just 331callback without the actual number of bytes read (or -1 on error, just
322like the syscall). 332like the syscall).
323 333
334If C<$offset> is undefined, then the current file offset will be used (and
335updated), otherwise the file offset will not be changed by these calls.
336
337If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
338
339If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>.
341
324The C<$data> scalar I<MUST NOT> be modified in any way while the request 342The C<$data> scalar I<MUST NOT> be modified in any way while the request
325is outstanding. Modifying it can result in segfaults or WW3 (if the 343is outstanding. Modifying it can result in segfaults or World War III (if
326necessary/optional hardware is installed). 344the necessary/optional hardware is installed).
327 345
328Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 346Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
329offset C<0> within the scalar: 347offset C<0> within the scalar:
330 348
331 aio_read $fh, 7, 15, $buffer, 0, sub { 349 aio_read $fh, 7, 15, $buffer, 0, sub {
332 $_[0] > 0 or die "read error: $!"; 350 $_[0] > 0 or die "read error: $!";
333 print "read $_[0] bytes: <$buffer>\n"; 351 print "read $_[0] bytes: <$buffer>\n";
334 }; 352 };
353
335 354
336=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 355=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
337 356
338Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 357Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
339reading at byte offset C<$in_offset>, and starts writing at the current 358reading at byte offset C<$in_offset>, and starts writing at the current
353C<$in_fh> than are written, and there is no way to find out how many 372C<$in_fh> than are written, and there is no way to find out how many
354bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 373bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
355provides the number of bytes written to C<$out_fh>. Only if the result 374provides the number of bytes written to C<$out_fh>. Only if the result
356value equals C<$length> one can assume that C<$length> bytes have been 375value equals C<$length> one can assume that C<$length> bytes have been
357read. 376read.
377
358 378
359=item aio_readahead $fh,$offset,$length, $callback->($retval) 379=item aio_readahead $fh,$offset,$length, $callback->($retval)
360 380
361C<aio_readahead> populates the page cache with data from a file so that 381C<aio_readahead> populates the page cache with data from a file so that
362subsequent reads from that file will not block on disk I/O. The C<$offset> 382subsequent reads from that file will not block on disk I/O. The C<$offset>
368file. The current file offset of the file is left unchanged. 388file. The current file offset of the file is left unchanged.
369 389
370If that syscall doesn't exist (likely if your OS isn't Linux) it will be 390If that syscall doesn't exist (likely if your OS isn't Linux) it will be
371emulated by simply reading the data, which would have a similar effect. 391emulated by simply reading the data, which would have a similar effect.
372 392
393
373=item aio_stat $fh_or_path, $callback->($status) 394=item aio_stat $fh_or_path, $callback->($status)
374 395
375=item aio_lstat $fh, $callback->($status) 396=item aio_lstat $fh, $callback->($status)
376 397
377Works like perl's C<stat> or C<lstat> in void context. The callback will 398Works like perl's C<stat> or C<lstat> in void context. The callback will
390 aio_stat "/etc/passwd", sub { 411 aio_stat "/etc/passwd", sub {
391 $_[0] and die "stat failed: $!"; 412 $_[0] and die "stat failed: $!";
392 print "size is ", -s _, "\n"; 413 print "size is ", -s _, "\n";
393 }; 414 };
394 415
416
417=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
418
419Works like perl's C<utime> function (including the special case of $atime
420and $mtime being undef). Fractional times are supported if the underlying
421syscalls support them.
422
423When called with a pathname, uses utimes(2) if available, otherwise
424utime(2). If called on a file descriptor, uses futimes(2) if available,
425otherwise returns ENOSYS, so this is not portable.
426
427Examples:
428
429 # set atime and mtime to current time (basically touch(1)):
430 aio_utime "path", undef, undef;
431 # set atime to current time and mtime to beginning of the epoch:
432 aio_utime "path", time, undef; # undef==0
433
434
435=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
436
437Works like perl's C<chown> function, except that C<undef> for either $uid
438or $gid is being interpreted as "do not change" (but -1 can also be used).
439
440Examples:
441
442 # same as "chown root path" in the shell:
443 aio_chown "path", 0, -1;
444 # same as above:
445 aio_chown "path", 0, undef;
446
447
448=item aio_truncate $fh_or_path, $offset, $callback->($status)
449
450Works like truncate(2) or ftruncate(2).
451
452
453=item aio_chmod $fh_or_path, $mode, $callback->($status)
454
455Works like perl's C<chmod> function.
456
457
395=item aio_unlink $pathname, $callback->($status) 458=item aio_unlink $pathname, $callback->($status)
396 459
397Asynchronously unlink (delete) a file and call the callback with the 460Asynchronously unlink (delete) a file and call the callback with the
398result code. 461result code.
399 462
463
400=item aio_mknod $path, $mode, $dev, $callback->($status) 464=item aio_mknod $path, $mode, $dev, $callback->($status)
401 465
402[EXPERIMENTAL] 466[EXPERIMENTAL]
403 467
404Asynchronously create a device node (or fifo). See mknod(2). 468Asynchronously create a device node (or fifo). See mknod(2).
405 469
406The only (POSIX-) portable way of calling this function is: 470The only (POSIX-) portable way of calling this function is:
407 471
408 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 472 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
473
409 474
410=item aio_link $srcpath, $dstpath, $callback->($status) 475=item aio_link $srcpath, $dstpath, $callback->($status)
411 476
412Asynchronously create a new link to the existing object at C<$srcpath> at 477Asynchronously create a new link to the existing object at C<$srcpath> at
413the path C<$dstpath> and call the callback with the result code. 478the path C<$dstpath> and call the callback with the result code.
414 479
480
415=item aio_symlink $srcpath, $dstpath, $callback->($status) 481=item aio_symlink $srcpath, $dstpath, $callback->($status)
416 482
417Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 483Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
418the path C<$dstpath> and call the callback with the result code. 484the path C<$dstpath> and call the callback with the result code.
419 485
486
487=item aio_readlink $path, $callback->($link)
488
489Asynchronously read the symlink specified by C<$path> and pass it to
490the callback. If an error occurs, nothing or undef gets passed to the
491callback.
492
493
420=item aio_rename $srcpath, $dstpath, $callback->($status) 494=item aio_rename $srcpath, $dstpath, $callback->($status)
421 495
422Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 496Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
423rename(2) and call the callback with the result code. 497rename(2) and call the callback with the result code.
424 498
499
500=item aio_mkdir $pathname, $mode, $callback->($status)
501
502Asynchronously mkdir (create) a directory and call the callback with
503the result code. C<$mode> will be modified by the umask at the time the
504request is executed, so do not change your umask.
505
506
425=item aio_rmdir $pathname, $callback->($status) 507=item aio_rmdir $pathname, $callback->($status)
426 508
427Asynchronously rmdir (delete) a directory and call the callback with the 509Asynchronously rmdir (delete) a directory and call the callback with the
428result code. 510result code.
511
429 512
430=item aio_readdir $pathname, $callback->($entries) 513=item aio_readdir $pathname, $callback->($entries)
431 514
432Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 515Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
433directory (i.e. opendir + readdir + closedir). The entries will not be 516directory (i.e. opendir + readdir + closedir). The entries will not be
434sorted, and will B<NOT> include the C<.> and C<..> entries. 517sorted, and will B<NOT> include the C<.> and C<..> entries.
435 518
436The callback a single argument which is either C<undef> or an array-ref 519The callback a single argument which is either C<undef> or an array-ref
437with the filenames. 520with the filenames.
521
522
523=item aio_load $path, $data, $callback->($status)
524
525This is a composite request that tries to fully load the given file into
526memory. Status is the same as with aio_read.
527
528=cut
529
530sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_;
533 my $data = \$_[1];
534
535 my $pri = aioreq_pri;
536 my $grp = aio_group $cb;
537
538 aioreq_pri $pri;
539 add $grp aio_open $path, O_RDONLY, 0, sub {
540 my $fh = shift
541 or return $grp->result (-1);
542
543 aioreq_pri $pri;
544 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]);
546 };
547 };
548
549 $grp
550 }
551}
438 552
439=item aio_copy $srcpath, $dstpath, $callback->($status) 553=item aio_copy $srcpath, $dstpath, $callback->($status)
440 554
441Try to copy the I<file> (directories not supported as either source or 555Try to copy the I<file> (directories not supported as either source or
442destination) from C<$srcpath> to C<$dstpath> and call the callback with 556destination) from C<$srcpath> to C<$dstpath> and call the callback with
452errors are being ignored. 566errors are being ignored.
453 567
454=cut 568=cut
455 569
456sub aio_copy($$;$) { 570sub aio_copy($$;$) {
571 aio_block {
457 my ($src, $dst, $cb) = @_; 572 my ($src, $dst, $cb) = @_;
458 573
459 my $pri = aioreq_pri; 574 my $pri = aioreq_pri;
460 my $grp = aio_group $cb; 575 my $grp = aio_group $cb;
461 576
462 aioreq_pri $pri; 577 aioreq_pri $pri;
463 add $grp aio_open $src, O_RDONLY, 0, sub { 578 add $grp aio_open $src, O_RDONLY, 0, sub {
464 if (my $src_fh = $_[0]) { 579 if (my $src_fh = $_[0]) {
465 my @stat = stat $src_fh; 580 my @stat = stat $src_fh;
466 581
467 aioreq_pri $pri; 582 aioreq_pri $pri;
468 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 583 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
469 if (my $dst_fh = $_[0]) { 584 if (my $dst_fh = $_[0]) {
470 aioreq_pri $pri; 585 aioreq_pri $pri;
471 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 586 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
472 if ($_[0] == $stat[7]) { 587 if ($_[0] == $stat[7]) {
473 $grp->result (0); 588 $grp->result (0);
474 close $src_fh; 589 close $src_fh;
475 590
476 # those should not normally block. should. should. 591 # those should not normally block. should. should.
477 utime $stat[8], $stat[9], $dst; 592 utime $stat[8], $stat[9], $dst;
478 chmod $stat[2] & 07777, $dst_fh; 593 chmod $stat[2] & 07777, $dst_fh;
479 chown $stat[4], $stat[5], $dst_fh; 594 chown $stat[4], $stat[5], $dst_fh;
480 close $dst_fh; 595 close $dst_fh;
481 } else { 596 } else {
482 $grp->result (-1); 597 $grp->result (-1);
483 close $src_fh; 598 close $src_fh;
484 close $dst_fh; 599 close $dst_fh;
485 600
486 aioreq $pri; 601 aioreq $pri;
487 add $grp aio_unlink $dst; 602 add $grp aio_unlink $dst;
603 }
488 } 604 };
605 } else {
606 $grp->result (-1);
489 }; 607 }
490 } else {
491 $grp->result (-1);
492 } 608 },
609
610 } else {
611 $grp->result (-1);
493 }, 612 }
494
495 } else {
496 $grp->result (-1);
497 } 613 };
614
615 $grp
498 }; 616 }
499
500 $grp
501} 617}
502 618
503=item aio_move $srcpath, $dstpath, $callback->($status) 619=item aio_move $srcpath, $dstpath, $callback->($status)
504 620
505Try to move the I<file> (directories not supported as either source or 621Try to move the I<file> (directories not supported as either source or
511that is successful, unlinking the C<$srcpath>. 627that is successful, unlinking the C<$srcpath>.
512 628
513=cut 629=cut
514 630
515sub aio_move($$;$) { 631sub aio_move($$;$) {
632 aio_block {
516 my ($src, $dst, $cb) = @_; 633 my ($src, $dst, $cb) = @_;
517 634
518 my $pri = aioreq_pri; 635 my $pri = aioreq_pri;
519 my $grp = aio_group $cb; 636 my $grp = aio_group $cb;
520 637
521 aioreq_pri $pri; 638 aioreq_pri $pri;
522 add $grp aio_rename $src, $dst, sub { 639 add $grp aio_rename $src, $dst, sub {
523 if ($_[0] && $! == EXDEV) { 640 if ($_[0] && $! == EXDEV) {
524 aioreq_pri $pri; 641 aioreq_pri $pri;
525 add $grp aio_copy $src, $dst, sub { 642 add $grp aio_copy $src, $dst, sub {
643 $grp->result ($_[0]);
644
645 if (!$_[0]) {
646 aioreq_pri $pri;
647 add $grp aio_unlink $src;
648 }
649 };
650 } else {
526 $grp->result ($_[0]); 651 $grp->result ($_[0]);
527
528 if (!$_[0]) {
529 aioreq_pri $pri;
530 add $grp aio_unlink $src;
531 }
532 }; 652 }
533 } else {
534 $grp->result ($_[0]);
535 } 653 };
654
655 $grp
536 }; 656 }
537
538 $grp
539} 657}
540 658
541=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
542 660
543Scans a directory (similar to C<aio_readdir>) but additionally tries to 661Scans a directory (similar to C<aio_readdir>) but additionally tries to
590as those tend to return 0 or 1 as link counts, which disables the 708as those tend to return 0 or 1 as link counts, which disables the
591directory counting heuristic. 709directory counting heuristic.
592 710
593=cut 711=cut
594 712
595sub aio_scandir($$$) { 713sub aio_scandir($$;$) {
714 aio_block {
596 my ($path, $maxreq, $cb) = @_; 715 my ($path, $maxreq, $cb) = @_;
597 716
598 my $pri = aioreq_pri; 717 my $pri = aioreq_pri;
599 718
600 my $grp = aio_group $cb; 719 my $grp = aio_group $cb;
601 720
602 $maxreq = 4 if $maxreq <= 0; 721 $maxreq = 4 if $maxreq <= 0;
603 722
604 # stat once 723 # stat once
605 aioreq_pri $pri;
606 add $grp aio_stat $path, sub {
607 return $grp->result () if $_[0];
608 my $now = time;
609 my $hash1 = join ":", (stat _)[0,1,3,7,9];
610
611 # read the directory entries
612 aioreq_pri $pri; 724 aioreq_pri $pri;
613 add $grp aio_readdir $path, sub { 725 add $grp aio_stat $path, sub {
614 my $entries = shift
615 or return $grp->result (); 726 return $grp->result () if $_[0];
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
616 729
617 # stat the dir another time 730 # read the directory entries
618 aioreq_pri $pri; 731 aioreq_pri $pri;
732 add $grp aio_readdir $path, sub {
733 my $entries = shift
734 or return $grp->result ();
735
736 # stat the dir another time
737 aioreq_pri $pri;
619 add $grp aio_stat $path, sub { 738 add $grp aio_stat $path, sub {
620 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 739 my $hash2 = join ":", (stat _)[0,1,3,7,9];
621 740
622 my $ndirs; 741 my $ndirs;
623 742
624 # take the slow route if anything looks fishy 743 # take the slow route if anything looks fishy
625 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 744 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
626 $ndirs = -1; 745 $ndirs = -1;
627 } else { 746 } else {
628 # if nlink == 2, we are finished 747 # if nlink == 2, we are finished
629 # on non-posix-fs's, we rely on nlink < 2 748 # on non-posix-fs's, we rely on nlink < 2
630 $ndirs = (stat _)[3] - 2 749 $ndirs = (stat _)[3] - 2
631 or return $grp->result ([], $entries); 750 or return $grp->result ([], $entries);
632 } 751 }
633 752
634 # sort into likely dirs and likely nondirs 753 # sort into likely dirs and likely nondirs
635 # dirs == files without ".", short entries first 754 # dirs == files without ".", short entries first
636 $entries = [map $_->[0], 755 $entries = [map $_->[0],
637 sort { $b->[1] cmp $a->[1] } 756 sort { $b->[1] cmp $a->[1] }
638 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
639 @$entries]; 758 @$entries];
640 759
641 my (@dirs, @nondirs); 760 my (@dirs, @nondirs);
642 761
643 my $statgrp = add $grp aio_group sub { 762 my $statgrp = add $grp aio_group sub {
644 $grp->result (\@dirs, \@nondirs); 763 $grp->result (\@dirs, \@nondirs);
645 }; 764 };
646 765
647 limit $statgrp $maxreq; 766 limit $statgrp $maxreq;
648 feed $statgrp sub { 767 feed $statgrp sub {
649 return unless @$entries; 768 return unless @$entries;
650 my $entry = pop @$entries; 769 my $entry = pop @$entries;
651 770
652 aioreq_pri $pri; 771 aioreq_pri $pri;
653 add $statgrp aio_stat "$path/$entry/.", sub { 772 add $statgrp aio_stat "$path/$entry/.", sub {
654 if ($_[0] < 0) { 773 if ($_[0] < 0) {
655 push @nondirs, $entry; 774 push @nondirs, $entry;
656 } else { 775 } else {
657 # need to check for real directory 776 # need to check for real directory
658 aioreq_pri $pri; 777 aioreq_pri $pri;
659 add $statgrp aio_lstat "$path/$entry", sub { 778 add $statgrp aio_lstat "$path/$entry", sub {
660 if (-d _) { 779 if (-d _) {
661 push @dirs, $entry; 780 push @dirs, $entry;
662 781
663 unless (--$ndirs) { 782 unless (--$ndirs) {
664 push @nondirs, @$entries; 783 push @nondirs, @$entries;
665 feed $statgrp; 784 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
666 } 788 }
667 } else {
668 push @nondirs, $entry;
669 } 789 }
670 } 790 }
671 } 791 };
672 }; 792 };
673 }; 793 };
674 }; 794 };
675 }; 795 };
796
797 $grp
676 }; 798 }
799}
677 800
801=item aio_rmtree $path, $callback->($status)
802
803Delete a directory tree starting (and including) C<$path>, return the
804status of the final C<rmdir> only. This is a composite request that
805uses C<aio_scandir> to recurse into and rmdir directories, and unlink
806everything else.
807
808=cut
809
810sub aio_rmtree;
811sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_;
814
815 my $pri = aioreq_pri;
816 my $grp = aio_group $cb;
817
818 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_;
821
822 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]);
825 };
826 };
827
828 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
829 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
830
831 add $grp $dirgrp;
832 };
833
678 $grp 834 $grp
835 }
679} 836}
680 837
681=item aio_fsync $fh, $callback->($status) 838=item aio_fsync $fh, $callback->($status)
682 839
683Asynchronously call fsync on the given filehandle and call the callback 840Asynchronously call fsync on the given filehandle and call the callback
937that are being processed by C<IO::AIO::poll_cb> in one call, respectively 1094that are being processed by C<IO::AIO::poll_cb> in one call, respectively
938the maximum amount of time (default C<0>, meaning infinity) spent in 1095the maximum amount of time (default C<0>, meaning infinity) spent in
939C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount 1096C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
940of time C<poll_cb> is allowed to use). 1097of time C<poll_cb> is allowed to use).
941 1098
1099Setting C<max_poll_time> to a non-zero value creates an overhead of one
1100syscall per request processed, which is not normally a problem unless your
1101callbacks are really really fast or your OS is really really slow (I am
1102not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1103
942Setting these is useful if you want to ensure some level of 1104Setting these is useful if you want to ensure some level of
943interactiveness when perl is not fast enough to process all requests in 1105interactiveness when perl is not fast enough to process all requests in
944time. 1106time.
945 1107
946For interactive programs, values such as C<0.01> to C<0.1> should be fine. 1108For interactive programs, values such as C<0.01> to C<0.1> should be fine.
947 1109
948Example: Install an Event watcher that automatically calls 1110Example: Install an Event watcher that automatically calls
949IO::AIO::poll_some with low priority, to ensure that other parts of the 1111IO::AIO::poll_cb with low priority, to ensure that other parts of the
950program get the CPU sometimes even under high AIO load. 1112program get the CPU sometimes even under high AIO load.
951 1113
952 # try not to spend much more than 0.1s in poll_cb 1114 # try not to spend much more than 0.1s in poll_cb
953 IO::AIO::max_poll_time 0.1; 1115 IO::AIO::max_poll_time 0.1;
954 1116
957 poll => 'r', nice => 1, 1119 poll => 'r', nice => 1,
958 cb => &IO::AIO::poll_cb); 1120 cb => &IO::AIO::poll_cb);
959 1121
960=item IO::AIO::poll_wait 1122=item IO::AIO::poll_wait
961 1123
1124If there are any outstanding requests and none of them in the result
962Wait till the result filehandle becomes ready for reading (simply does a 1125phase, wait till the result filehandle becomes ready for reading (simply
963C<select> on the filehandle. This is useful if you want to synchronously 1126does a C<select> on the filehandle. This is useful if you want to
964wait for some requests to finish). 1127synchronously wait for some requests to finish).
965 1128
966See C<nreqs> for an example. 1129See C<nreqs> for an example.
967 1130
968=item IO::AIO::poll 1131=item IO::AIO::poll
969 1132
970Waits until some requests have been handled. 1133Waits until some requests have been handled.
971 1134
1135Returns the number of requests processed, but is otherwise strictly
972Strictly equivalent to: 1136equivalent to:
973 1137
974 IO::AIO::poll_wait, IO::AIO::poll_cb 1138 IO::AIO::poll_wait, IO::AIO::poll_cb
975 if IO::AIO::nreqs;
976 1139
977=item IO::AIO::flush 1140=item IO::AIO::flush
978 1141
979Wait till all outstanding AIO requests have been handled. 1142Wait till all outstanding AIO requests have been handled.
980 1143
981Strictly equivalent to: 1144Strictly equivalent to:
982 1145
983 IO::AIO::poll_wait, IO::AIO::poll_cb 1146 IO::AIO::poll_wait, IO::AIO::poll_cb
984 while IO::AIO::nreqs; 1147 while IO::AIO::nreqs;
985 1148
1149=back
1150
986=head3 CONTROLLING THE NUMBER OF THREADS 1151=head3 CONTROLLING THE NUMBER OF THREADS
1152
1153=over
987 1154
988=item IO::AIO::min_parallel $nthreads 1155=item IO::AIO::min_parallel $nthreads
989 1156
990Set the minimum number of AIO threads to C<$nthreads>. The current 1157Set the minimum number of AIO threads to C<$nthreads>. The current
991default is C<8>, which means eight asynchronous operations can execute 1158default is C<8>, which means eight asynchronous operations can execute
1050 1217
1051You can still queue as many requests as you want. Therefore, 1218You can still queue as many requests as you want. Therefore,
1052C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1219C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1053as a stop gap to shield against fatal memory overflow (with large values). 1220as a stop gap to shield against fatal memory overflow (with large values).
1054 1221
1222=back
1223
1055=head3 STATISTICAL INFORMATION 1224=head3 STATISTICAL INFORMATION
1225
1226=over
1056 1227
1057=item IO::AIO::nreqs 1228=item IO::AIO::nreqs
1058 1229
1059Returns the number of requests currently in the ready, execute or pending 1230Returns the number of requests currently in the ready, execute or pending
1060states (i.e. for which their callback has not been invoked yet). 1231states (i.e. for which their callback has not been invoked yet).
1094 *$sym 1265 *$sym
1095} 1266}
1096 1267
1097min_parallel 8; 1268min_parallel 8;
1098 1269
1099END { 1270END { flush }
1100 min_parallel 1;
1101 flush;
1102};
1103 1271
11041; 12721;
1105 1273
1106=head2 FORK BEHAVIOUR 1274=head2 FORK BEHAVIOUR
1107 1275
1127bytes of memory. In addition, stat requests need a stat buffer (possibly 1295bytes of memory. In addition, stat requests need a stat buffer (possibly
1128a few hundred bytes), readdir requires a result buffer and so on. Perl 1296a few hundred bytes), readdir requires a result buffer and so on. Perl
1129scalars and other data passed into aio requests will also be locked and 1297scalars and other data passed into aio requests will also be locked and
1130will consume memory till the request has entered the done state. 1298will consume memory till the request has entered the done state.
1131 1299
1132This is now awfully much, so queuing lots of requests is not usually a 1300This is not awfully much, so queuing lots of requests is not usually a
1133problem. 1301problem.
1134 1302
1135Per-thread usage: 1303Per-thread usage:
1136 1304
1137In the execution phase, some aio requests require more memory for 1305In the execution phase, some aio requests require more memory for

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines