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

Diff Legend

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