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.92 by root, Wed Nov 8 01:57:42 2006 UTC vs.
Revision 1.108 by root, Fri Jun 1 13:25:50 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 most of this works on all types of file descriptors (for example 67While most of this works on all types of file descriptors (for
67sockets), using these functions on file descriptors that support 68example sockets), using these functions on file descriptors that
68nonblocking operation (again, sockets, pipes etc.) is very inefficient or 69support nonblocking operation (again, sockets, pipes etc.) is very
69might not work (aio_read fails on sockets/pipes/fifos). Use an event loop 70inefficient. Use an event loop for that (such as the L<Event|Event>
70for that (such as the L<Event|Event> module): IO::AIO will naturally fit 71module): IO::AIO will naturally fit into such an event loop itself.
71into such an event loop itself.
72 72
73In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
74requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
75in 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
76to 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
78not 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
79files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
80aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
81using threads anyway. 81using threads anyway.
82 82
83Although the module will work with in the presence of other (Perl-) 83Although the module will work in the presence of other (Perl-) threads,
84threads, it is currently not reentrant in any way, so use appropriate 84it is currently not reentrant in any way, so use appropriate locking
85locking 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
86never call C<poll_cb> (or other C<aio_> functions) recursively. 86call C<poll_cb> (or other C<aio_> functions) recursively.
87 87
88=head2 EXAMPLE 88=head2 EXAMPLE
89 89
90This is a simple example that uses the Event module and loads 90This is a simple example that uses the Event module and loads
91F</etc/passwd> asynchronously: 91F</etc/passwd> asynchronously:
99 poll => 'r', 99 poll => 'r',
100 cb => \&IO::AIO::poll_cb); 100 cb => \&IO::AIO::poll_cb);
101 101
102 # queue the request to open /etc/passwd 102 # queue the request to open /etc/passwd
103 aio_open "/etc/passwd", O_RDONLY, 0, sub { 103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
104 my $fh = $_[0] 104 my $fh = shift
105 or die "error while opening: $!"; 105 or die "error while opening: $!";
106 106
107 # stat'ing filehandles is generally non-blocking 107 # stat'ing filehandles is generally non-blocking
108 my $size = -s $fh; 108 my $size = -s $fh;
109 109
189use strict 'vars'; 189use strict 'vars';
190 190
191use base 'Exporter'; 191use base 'Exporter';
192 192
193BEGIN { 193BEGIN {
194 our $VERSION = '2.2'; 194 our $VERSION = '2.4';
195 195
196 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
197 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
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
199 aio_move 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);
200 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
201 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
202 min_parallel max_parallel max_idle 203 min_parallel max_parallel max_idle
203 nreqs nready npending nthreads 204 nreqs nready npending nthreads
204 max_poll_time max_poll_reqs); 205 max_poll_time max_poll_reqs);
205 206
270 aio_read $_[0], ..., sub { 271 aio_read $_[0], ..., sub {
271 ... 272 ...
272 }; 273 };
273 }; 274 };
274 275
276
275=item aioreq_nice $pri_adjust 277=item aioreq_nice $pri_adjust
276 278
277Similar 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
278priority, so the effect is cumulative. 280priority, so the effect is cumulative.
281
279 282
280=item aio_open $pathname, $flags, $mode, $callback->($fh) 283=item aio_open $pathname, $flags, $mode, $callback->($fh)
281 284
282Asynchronously 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
283created filehandle for the file. 286created filehandle for the file.
289list. They are the same as used by C<sysopen>. 292list. They are the same as used by C<sysopen>.
290 293
291Likewise, 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
292didn'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>,
293except 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,
294and 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.
295 300
296Example: 301Example:
297 302
298 aio_open "/etc/passwd", O_RDONLY, 0, sub { 303 aio_open "/etc/passwd", O_RDONLY, 0, sub {
299 if ($_[0]) { 304 if ($_[0]) {
302 } else { 307 } else {
303 die "open failed: $!\n"; 308 die "open failed: $!\n";
304 } 309 }
305 }; 310 };
306 311
312
307=item aio_close $fh, $callback->($status) 313=item aio_close $fh, $callback->($status)
308 314
309Asynchronously close a file and call the callback with the result 315Asynchronously close a file and call the callback with the result
310code. I<WARNING:> although accepted, you should not pass in a perl 316code. I<WARNING:> although accepted, you should not pass in a perl
311filehandle here, as perl will likely close the file descriptor another 317filehandle here, as perl will likely close the file descriptor another
313C<close> or just let filehandles go out of scope. 319C<close> or just let filehandles go out of scope.
314 320
315This 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
316therefore best to avoid this function. 322therefore best to avoid this function.
317 323
324
318=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
319 326
320=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
321 328
322Reads 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>
323into 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
324callback 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
325like the syscall). 332like the syscall). If C<offset> is undefined, then the current file offset
333will be used (and updated), otherwise the file offset will not be changed
334by these calls.
326 335
327The C<$data> scalar I<MUST NOT> be modified in any way while the request 336The C<$data> scalar I<MUST NOT> be modified in any way while the request
328is outstanding. Modifying it can result in segfaults or WW3 (if the 337is outstanding. Modifying it can result in segfaults or World War III (if
329necessary/optional hardware is installed). 338the necessary/optional hardware is installed).
330 339
331Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 340Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
332offset C<0> within the scalar: 341offset C<0> within the scalar:
333 342
334 aio_read $fh, 7, 15, $buffer, 0, sub { 343 aio_read $fh, 7, 15, $buffer, 0, sub {
335 $_[0] > 0 or die "read error: $!"; 344 $_[0] > 0 or die "read error: $!";
336 print "read $_[0] bytes: <$buffer>\n"; 345 print "read $_[0] bytes: <$buffer>\n";
337 }; 346 };
347
338 348
339=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 349=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
340 350
341Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 351Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
342reading at byte offset C<$in_offset>, and starts writing at the current 352reading at byte offset C<$in_offset>, and starts writing at the current
356C<$in_fh> than are written, and there is no way to find out how many 366C<$in_fh> than are written, and there is no way to find out how many
357bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 367bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
358provides the number of bytes written to C<$out_fh>. Only if the result 368provides the number of bytes written to C<$out_fh>. Only if the result
359value equals C<$length> one can assume that C<$length> bytes have been 369value equals C<$length> one can assume that C<$length> bytes have been
360read. 370read.
371
361 372
362=item aio_readahead $fh,$offset,$length, $callback->($retval) 373=item aio_readahead $fh,$offset,$length, $callback->($retval)
363 374
364C<aio_readahead> populates the page cache with data from a file so that 375C<aio_readahead> populates the page cache with data from a file so that
365subsequent reads from that file will not block on disk I/O. The C<$offset> 376subsequent reads from that file will not block on disk I/O. The C<$offset>
371file. The current file offset of the file is left unchanged. 382file. The current file offset of the file is left unchanged.
372 383
373If that syscall doesn't exist (likely if your OS isn't Linux) it will be 384If that syscall doesn't exist (likely if your OS isn't Linux) it will be
374emulated by simply reading the data, which would have a similar effect. 385emulated by simply reading the data, which would have a similar effect.
375 386
387
376=item aio_stat $fh_or_path, $callback->($status) 388=item aio_stat $fh_or_path, $callback->($status)
377 389
378=item aio_lstat $fh, $callback->($status) 390=item aio_lstat $fh, $callback->($status)
379 391
380Works like perl's C<stat> or C<lstat> in void context. The callback will 392Works like perl's C<stat> or C<lstat> in void context. The callback will
393 aio_stat "/etc/passwd", sub { 405 aio_stat "/etc/passwd", sub {
394 $_[0] and die "stat failed: $!"; 406 $_[0] and die "stat failed: $!";
395 print "size is ", -s _, "\n"; 407 print "size is ", -s _, "\n";
396 }; 408 };
397 409
410
411=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
412
413Works like perl's C<utime> function (including the special case of $atime
414and $mtime being undef). Fractional times are supported if the underlying
415syscalls support them.
416
417When called with a pathname, uses utimes(2) if available, otherwise
418utime(2). If called on a file descriptor, uses futimes(2) if available,
419otherwise returns ENOSYS, so this is not portable.
420
421Examples:
422
423 # set atime and mtime to current time (basically touch(1)):
424 aio_utime "path", undef, undef;
425 # set atime to current time and mtime to beginning of the epoch:
426 aio_utime "path", time, undef; # undef==0
427
428
429=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
430
431Works like perl's C<chown> function, except that C<undef> for either $uid
432or $gid is being interpreted as "do not change" (but -1 can also be used).
433
434Examples:
435
436 # same as "chown root path" in the shell:
437 aio_chown "path", 0, -1;
438 # same as above:
439 aio_chown "path", 0, undef;
440
441
442=item aio_chmod $fh_or_path, $mode, $callback->($status)
443
444Works like perl's C<chmod> function.
445
446
398=item aio_unlink $pathname, $callback->($status) 447=item aio_unlink $pathname, $callback->($status)
399 448
400Asynchronously unlink (delete) a file and call the callback with the 449Asynchronously unlink (delete) a file and call the callback with the
401result code. 450result code.
402 451
452
403=item aio_mknod $path, $mode, $dev, $callback->($status) 453=item aio_mknod $path, $mode, $dev, $callback->($status)
404 454
405[EXPERIMENTAL] 455[EXPERIMENTAL]
406 456
407Asynchronously create a device node (or fifo). See mknod(2). 457Asynchronously create a device node (or fifo). See mknod(2).
408 458
409The only (POSIX-) portable way of calling this function is: 459The only (POSIX-) portable way of calling this function is:
410 460
411 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 461 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
462
412 463
413=item aio_link $srcpath, $dstpath, $callback->($status) 464=item aio_link $srcpath, $dstpath, $callback->($status)
414 465
415Asynchronously create a new link to the existing object at C<$srcpath> at 466Asynchronously create a new link to the existing object at C<$srcpath> at
416the path C<$dstpath> and call the callback with the result code. 467the path C<$dstpath> and call the callback with the result code.
417 468
469
418=item aio_symlink $srcpath, $dstpath, $callback->($status) 470=item aio_symlink $srcpath, $dstpath, $callback->($status)
419 471
420Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 472Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
421the path C<$dstpath> and call the callback with the result code. 473the path C<$dstpath> and call the callback with the result code.
474
422 475
423=item aio_readlink $path, $callback->($link) 476=item aio_readlink $path, $callback->($link)
424 477
425Asynchronously read the symlink specified by C<$path> and pass it to 478Asynchronously read the symlink specified by C<$path> and pass it to
426the callback. If an error occurs, nothing or undef gets passed to the 479the callback. If an error occurs, nothing or undef gets passed to the
427callback. 480callback.
428 481
482
429=item aio_rename $srcpath, $dstpath, $callback->($status) 483=item aio_rename $srcpath, $dstpath, $callback->($status)
430 484
431Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 485Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
432rename(2) and call the callback with the result code. 486rename(2) and call the callback with the result code.
433 487
488
489=item aio_mkdir $pathname, $mode, $callback->($status)
490
491Asynchronously mkdir (create) a directory and call the callback with
492the result code. C<$mode> will be modified by the umask at the time the
493request is executed, so do not change your umask.
494
495
434=item aio_rmdir $pathname, $callback->($status) 496=item aio_rmdir $pathname, $callback->($status)
435 497
436Asynchronously rmdir (delete) a directory and call the callback with the 498Asynchronously rmdir (delete) a directory and call the callback with the
437result code. 499result code.
500
438 501
439=item aio_readdir $pathname, $callback->($entries) 502=item aio_readdir $pathname, $callback->($entries)
440 503
441Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 504Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
442directory (i.e. opendir + readdir + closedir). The entries will not be 505directory (i.e. opendir + readdir + closedir). The entries will not be
443sorted, and will B<NOT> include the C<.> and C<..> entries. 506sorted, and will B<NOT> include the C<.> and C<..> entries.
444 507
445The callback a single argument which is either C<undef> or an array-ref 508The callback a single argument which is either C<undef> or an array-ref
446with the filenames. 509with the filenames.
510
511
512=item aio_load $path, $data, $callback->($status)
513
514This is a composite request that tries to fully load the given file into
515memory. Status is the same as with aio_read.
516
517=cut
518
519sub aio_load($$;$) {
520 aio_block {
521 my ($path, undef, $cb) = @_;
522 my $data = \$_[1];
523
524 my $pri = aioreq_pri;
525 my $grp = aio_group $cb;
526
527 aioreq_pri $pri;
528 add $grp aio_open $path, O_RDONLY, 0, sub {
529 my $fh = shift
530 or return $grp->result (-1);
531
532 aioreq_pri $pri;
533 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
534 $grp->result ($_[0]);
535 };
536 };
537
538 $grp
539 }
540}
447 541
448=item aio_copy $srcpath, $dstpath, $callback->($status) 542=item aio_copy $srcpath, $dstpath, $callback->($status)
449 543
450Try to copy the I<file> (directories not supported as either source or 544Try to copy the I<file> (directories not supported as either source or
451destination) from C<$srcpath> to C<$dstpath> and call the callback with 545destination) from C<$srcpath> to C<$dstpath> and call the callback with
461errors are being ignored. 555errors are being ignored.
462 556
463=cut 557=cut
464 558
465sub aio_copy($$;$) { 559sub aio_copy($$;$) {
560 aio_block {
466 my ($src, $dst, $cb) = @_; 561 my ($src, $dst, $cb) = @_;
467 562
468 my $pri = aioreq_pri; 563 my $pri = aioreq_pri;
469 my $grp = aio_group $cb; 564 my $grp = aio_group $cb;
470 565
471 aioreq_pri $pri; 566 aioreq_pri $pri;
472 add $grp aio_open $src, O_RDONLY, 0, sub { 567 add $grp aio_open $src, O_RDONLY, 0, sub {
473 if (my $src_fh = $_[0]) { 568 if (my $src_fh = $_[0]) {
474 my @stat = stat $src_fh; 569 my @stat = stat $src_fh;
475 570
476 aioreq_pri $pri; 571 aioreq_pri $pri;
477 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 572 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
478 if (my $dst_fh = $_[0]) { 573 if (my $dst_fh = $_[0]) {
479 aioreq_pri $pri; 574 aioreq_pri $pri;
480 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 575 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
481 if ($_[0] == $stat[7]) { 576 if ($_[0] == $stat[7]) {
482 $grp->result (0); 577 $grp->result (0);
483 close $src_fh; 578 close $src_fh;
484 579
485 # those should not normally block. should. should. 580 # those should not normally block. should. should.
486 utime $stat[8], $stat[9], $dst; 581 utime $stat[8], $stat[9], $dst;
487 chmod $stat[2] & 07777, $dst_fh; 582 chmod $stat[2] & 07777, $dst_fh;
488 chown $stat[4], $stat[5], $dst_fh; 583 chown $stat[4], $stat[5], $dst_fh;
489 close $dst_fh; 584 close $dst_fh;
490 } else { 585 } else {
491 $grp->result (-1); 586 $grp->result (-1);
492 close $src_fh; 587 close $src_fh;
493 close $dst_fh; 588 close $dst_fh;
494 589
495 aioreq $pri; 590 aioreq $pri;
496 add $grp aio_unlink $dst; 591 add $grp aio_unlink $dst;
592 }
497 } 593 };
594 } else {
595 $grp->result (-1);
498 }; 596 }
499 } else {
500 $grp->result (-1);
501 } 597 },
598
599 } else {
600 $grp->result (-1);
502 }, 601 }
503
504 } else {
505 $grp->result (-1);
506 } 602 };
603
604 $grp
507 }; 605 }
508
509 $grp
510} 606}
511 607
512=item aio_move $srcpath, $dstpath, $callback->($status) 608=item aio_move $srcpath, $dstpath, $callback->($status)
513 609
514Try to move the I<file> (directories not supported as either source or 610Try to move the I<file> (directories not supported as either source or
520that is successful, unlinking the C<$srcpath>. 616that is successful, unlinking the C<$srcpath>.
521 617
522=cut 618=cut
523 619
524sub aio_move($$;$) { 620sub aio_move($$;$) {
621 aio_block {
525 my ($src, $dst, $cb) = @_; 622 my ($src, $dst, $cb) = @_;
526 623
527 my $pri = aioreq_pri; 624 my $pri = aioreq_pri;
528 my $grp = aio_group $cb; 625 my $grp = aio_group $cb;
529 626
530 aioreq_pri $pri; 627 aioreq_pri $pri;
531 add $grp aio_rename $src, $dst, sub { 628 add $grp aio_rename $src, $dst, sub {
532 if ($_[0] && $! == EXDEV) { 629 if ($_[0] && $! == EXDEV) {
533 aioreq_pri $pri; 630 aioreq_pri $pri;
534 add $grp aio_copy $src, $dst, sub { 631 add $grp aio_copy $src, $dst, sub {
632 $grp->result ($_[0]);
633
634 if (!$_[0]) {
635 aioreq_pri $pri;
636 add $grp aio_unlink $src;
637 }
638 };
639 } else {
535 $grp->result ($_[0]); 640 $grp->result ($_[0]);
536
537 if (!$_[0]) {
538 aioreq_pri $pri;
539 add $grp aio_unlink $src;
540 }
541 }; 641 }
542 } else {
543 $grp->result ($_[0]);
544 } 642 };
643
644 $grp
545 }; 645 }
546
547 $grp
548} 646}
549 647
550=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 648=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
551 649
552Scans a directory (similar to C<aio_readdir>) but additionally tries to 650Scans a directory (similar to C<aio_readdir>) but additionally tries to
599as those tend to return 0 or 1 as link counts, which disables the 697as those tend to return 0 or 1 as link counts, which disables the
600directory counting heuristic. 698directory counting heuristic.
601 699
602=cut 700=cut
603 701
604sub aio_scandir($$$) { 702sub aio_scandir($$;$) {
703 aio_block {
605 my ($path, $maxreq, $cb) = @_; 704 my ($path, $maxreq, $cb) = @_;
606 705
607 my $pri = aioreq_pri; 706 my $pri = aioreq_pri;
608 707
609 my $grp = aio_group $cb; 708 my $grp = aio_group $cb;
610 709
611 $maxreq = 4 if $maxreq <= 0; 710 $maxreq = 4 if $maxreq <= 0;
612 711
613 # stat once 712 # stat once
614 aioreq_pri $pri;
615 add $grp aio_stat $path, sub {
616 return $grp->result () if $_[0];
617 my $now = time;
618 my $hash1 = join ":", (stat _)[0,1,3,7,9];
619
620 # read the directory entries
621 aioreq_pri $pri; 713 aioreq_pri $pri;
622 add $grp aio_readdir $path, sub { 714 add $grp aio_stat $path, sub {
623 my $entries = shift
624 or return $grp->result (); 715 return $grp->result () if $_[0];
716 my $now = time;
717 my $hash1 = join ":", (stat _)[0,1,3,7,9];
625 718
626 # stat the dir another time 719 # read the directory entries
627 aioreq_pri $pri; 720 aioreq_pri $pri;
721 add $grp aio_readdir $path, sub {
722 my $entries = shift
723 or return $grp->result ();
724
725 # stat the dir another time
726 aioreq_pri $pri;
628 add $grp aio_stat $path, sub { 727 add $grp aio_stat $path, sub {
629 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 728 my $hash2 = join ":", (stat _)[0,1,3,7,9];
630 729
631 my $ndirs; 730 my $ndirs;
632 731
633 # take the slow route if anything looks fishy 732 # take the slow route if anything looks fishy
634 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 733 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
635 $ndirs = -1; 734 $ndirs = -1;
636 } else { 735 } else {
637 # if nlink == 2, we are finished 736 # if nlink == 2, we are finished
638 # on non-posix-fs's, we rely on nlink < 2 737 # on non-posix-fs's, we rely on nlink < 2
639 $ndirs = (stat _)[3] - 2 738 $ndirs = (stat _)[3] - 2
640 or return $grp->result ([], $entries); 739 or return $grp->result ([], $entries);
641 } 740 }
642 741
643 # sort into likely dirs and likely nondirs 742 # sort into likely dirs and likely nondirs
644 # dirs == files without ".", short entries first 743 # dirs == files without ".", short entries first
645 $entries = [map $_->[0], 744 $entries = [map $_->[0],
646 sort { $b->[1] cmp $a->[1] } 745 sort { $b->[1] cmp $a->[1] }
647 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 746 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
648 @$entries]; 747 @$entries];
649 748
650 my (@dirs, @nondirs); 749 my (@dirs, @nondirs);
651 750
652 my $statgrp = add $grp aio_group sub { 751 my $statgrp = add $grp aio_group sub {
653 $grp->result (\@dirs, \@nondirs); 752 $grp->result (\@dirs, \@nondirs);
654 }; 753 };
655 754
656 limit $statgrp $maxreq; 755 limit $statgrp $maxreq;
657 feed $statgrp sub { 756 feed $statgrp sub {
658 return unless @$entries; 757 return unless @$entries;
659 my $entry = pop @$entries; 758 my $entry = pop @$entries;
660 759
661 aioreq_pri $pri; 760 aioreq_pri $pri;
662 add $statgrp aio_stat "$path/$entry/.", sub { 761 add $statgrp aio_stat "$path/$entry/.", sub {
663 if ($_[0] < 0) { 762 if ($_[0] < 0) {
664 push @nondirs, $entry; 763 push @nondirs, $entry;
665 } else { 764 } else {
666 # need to check for real directory 765 # need to check for real directory
667 aioreq_pri $pri; 766 aioreq_pri $pri;
668 add $statgrp aio_lstat "$path/$entry", sub { 767 add $statgrp aio_lstat "$path/$entry", sub {
669 if (-d _) { 768 if (-d _) {
670 push @dirs, $entry; 769 push @dirs, $entry;
671 770
672 unless (--$ndirs) { 771 unless (--$ndirs) {
673 push @nondirs, @$entries; 772 push @nondirs, @$entries;
674 feed $statgrp; 773 feed $statgrp;
774 }
775 } else {
776 push @nondirs, $entry;
675 } 777 }
676 } else {
677 push @nondirs, $entry;
678 } 778 }
679 } 779 }
680 } 780 };
681 }; 781 };
682 }; 782 };
683 }; 783 };
684 }; 784 };
785
786 $grp
685 }; 787 }
788}
686 789
790=item aio_rmtree $path, $callback->($status)
791
792Delete a directory tree starting (and including) C<$path>, return the
793status of the final C<rmdir> only. This is a composite request that
794uses C<aio_scandir> to recurse into and rmdir directories, and unlink
795everything else.
796
797=cut
798
799sub aio_rmtree;
800sub aio_rmtree($;$) {
801 aio_block {
802 my ($path, $cb) = @_;
803
804 my $pri = aioreq_pri;
805 my $grp = aio_group $cb;
806
807 aioreq_pri $pri;
808 add $grp aio_scandir $path, 0, sub {
809 my ($dirs, $nondirs) = @_;
810
811 my $dirgrp = aio_group sub {
812 add $grp aio_rmdir $path, sub {
813 $grp->result ($_[0]);
814 };
815 };
816
817 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
818 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
819
820 add $grp $dirgrp;
821 };
822
687 $grp 823 $grp
824 }
688} 825}
689 826
690=item aio_fsync $fh, $callback->($status) 827=item aio_fsync $fh, $callback->($status)
691 828
692Asynchronously call fsync on the given filehandle and call the callback 829Asynchronously call fsync on the given filehandle and call the callback
971 poll => 'r', nice => 1, 1108 poll => 'r', nice => 1,
972 cb => &IO::AIO::poll_cb); 1109 cb => &IO::AIO::poll_cb);
973 1110
974=item IO::AIO::poll_wait 1111=item IO::AIO::poll_wait
975 1112
976If there are any outstanding requests, wait till the result filehandle 1113If there are any outstanding requests and none of them in the result
977becomes ready for reading (simply does a C<select> on the filehandle. This 1114phase, wait till the result filehandle becomes ready for reading (simply
1115does a C<select> on the filehandle. This is useful if you want to
978is useful if you want to synchronously wait for some requests to finish). 1116synchronously wait for some requests to finish).
979 1117
980See C<nreqs> for an example. 1118See C<nreqs> for an example.
981 1119
982=item IO::AIO::poll 1120=item IO::AIO::poll
983 1121
985 1123
986Returns the number of requests processed, but is otherwise strictly 1124Returns the number of requests processed, but is otherwise strictly
987equivalent to: 1125equivalent to:
988 1126
989 IO::AIO::poll_wait, IO::AIO::poll_cb 1127 IO::AIO::poll_wait, IO::AIO::poll_cb
990 if IO::AIO::nreqs;
991 1128
992=item IO::AIO::flush 1129=item IO::AIO::flush
993 1130
994Wait till all outstanding AIO requests have been handled. 1131Wait till all outstanding AIO requests have been handled.
995 1132
996Strictly equivalent to: 1133Strictly equivalent to:
997 1134
998 IO::AIO::poll_wait, IO::AIO::poll_cb 1135 IO::AIO::poll_wait, IO::AIO::poll_cb
999 while IO::AIO::nreqs; 1136 while IO::AIO::nreqs;
1000 1137
1138=back
1139
1001=head3 CONTROLLING THE NUMBER OF THREADS 1140=head3 CONTROLLING THE NUMBER OF THREADS
1141
1142=over
1002 1143
1003=item IO::AIO::min_parallel $nthreads 1144=item IO::AIO::min_parallel $nthreads
1004 1145
1005Set the minimum number of AIO threads to C<$nthreads>. The current 1146Set the minimum number of AIO threads to C<$nthreads>. The current
1006default is C<8>, which means eight asynchronous operations can execute 1147default is C<8>, which means eight asynchronous operations can execute
1065 1206
1066You can still queue as many requests as you want. Therefore, 1207You can still queue as many requests as you want. Therefore,
1067C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1208C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1068as a stop gap to shield against fatal memory overflow (with large values). 1209as a stop gap to shield against fatal memory overflow (with large values).
1069 1210
1211=back
1212
1070=head3 STATISTICAL INFORMATION 1213=head3 STATISTICAL INFORMATION
1214
1215=over
1071 1216
1072=item IO::AIO::nreqs 1217=item IO::AIO::nreqs
1073 1218
1074Returns the number of requests currently in the ready, execute or pending 1219Returns the number of requests currently in the ready, execute or pending
1075states (i.e. for which their callback has not been invoked yet). 1220states (i.e. for which their callback has not been invoked yet).
1109 *$sym 1254 *$sym
1110} 1255}
1111 1256
1112min_parallel 8; 1257min_parallel 8;
1113 1258
1114END { 1259END { flush }
1115 min_parallel 1;
1116 flush;
1117};
1118 1260
11191; 12611;
1120 1262
1121=head2 FORK BEHAVIOUR 1263=head2 FORK BEHAVIOUR
1122 1264

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines