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.91 by root, Mon Oct 30 23:30:29 2006 UTC vs.
Revision 1.109 by root, Sun Jun 3 09:44:17 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).
326 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
327The 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
328is outstanding. Modifying it can result in segfaults or WW3 (if the 343is outstanding. Modifying it can result in segfaults or World War III (if
329necessary/optional hardware is installed). 344the necessary/optional hardware is installed).
330 345
331Example: 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
332offset C<0> within the scalar: 347offset C<0> within the scalar:
333 348
334 aio_read $fh, 7, 15, $buffer, 0, sub { 349 aio_read $fh, 7, 15, $buffer, 0, sub {
335 $_[0] > 0 or die "read error: $!"; 350 $_[0] > 0 or die "read error: $!";
336 print "read $_[0] bytes: <$buffer>\n"; 351 print "read $_[0] bytes: <$buffer>\n";
337 }; 352 };
353
338 354
339=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)
340 356
341Tries 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
342reading 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
… …
356C<$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
357bytes 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
358provides 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
359value 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
360read. 376read.
377
361 378
362=item aio_readahead $fh,$offset,$length, $callback->($retval) 379=item aio_readahead $fh,$offset,$length, $callback->($retval)
363 380
364C<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
365subsequent 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>
… …
371file. The current file offset of the file is left unchanged. 388file. The current file offset of the file is left unchanged.
372 389
373If 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
374emulated by simply reading the data, which would have a similar effect. 391emulated by simply reading the data, which would have a similar effect.
375 392
393
376=item aio_stat $fh_or_path, $callback->($status) 394=item aio_stat $fh_or_path, $callback->($status)
377 395
378=item aio_lstat $fh, $callback->($status) 396=item aio_lstat $fh, $callback->($status)
379 397
380Works 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
… …
393 aio_stat "/etc/passwd", sub { 411 aio_stat "/etc/passwd", sub {
394 $_[0] and die "stat failed: $!"; 412 $_[0] and die "stat failed: $!";
395 print "size is ", -s _, "\n"; 413 print "size is ", -s _, "\n";
396 }; 414 };
397 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_chmod $fh_or_path, $mode, $callback->($status)
449
450Works like perl's C<chmod> function.
451
452
398=item aio_unlink $pathname, $callback->($status) 453=item aio_unlink $pathname, $callback->($status)
399 454
400Asynchronously unlink (delete) a file and call the callback with the 455Asynchronously unlink (delete) a file and call the callback with the
401result code. 456result code.
402 457
458
403=item aio_mknod $path, $mode, $dev, $callback->($status) 459=item aio_mknod $path, $mode, $dev, $callback->($status)
404 460
405[EXPERIMENTAL] 461[EXPERIMENTAL]
406 462
407Asynchronously create a device node (or fifo). See mknod(2). 463Asynchronously create a device node (or fifo). See mknod(2).
408 464
409The only (POSIX-) portable way of calling this function is: 465The only (POSIX-) portable way of calling this function is:
410 466
411 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 467 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
468
412 469
413=item aio_link $srcpath, $dstpath, $callback->($status) 470=item aio_link $srcpath, $dstpath, $callback->($status)
414 471
415Asynchronously create a new link to the existing object at C<$srcpath> at 472Asynchronously create a new link to the existing object at C<$srcpath> at
416the path C<$dstpath> and call the callback with the result code. 473the path C<$dstpath> and call the callback with the result code.
417 474
475
418=item aio_symlink $srcpath, $dstpath, $callback->($status) 476=item aio_symlink $srcpath, $dstpath, $callback->($status)
419 477
420Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 478Asynchronously 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. 479the path C<$dstpath> and call the callback with the result code.
480
422 481
423=item aio_readlink $path, $callback->($link) 482=item aio_readlink $path, $callback->($link)
424 483
425Asynchronously read the symlink specified by C<$path> and pass it to 484Asynchronously read the symlink specified by C<$path> and pass it to
426the callback. If an error occurs, nothing or undef gets passed to the 485the callback. If an error occurs, nothing or undef gets passed to the
427callback. 486callback.
428 487
488
429=item aio_rename $srcpath, $dstpath, $callback->($status) 489=item aio_rename $srcpath, $dstpath, $callback->($status)
430 490
431Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 491Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
432rename(2) and call the callback with the result code. 492rename(2) and call the callback with the result code.
433 493
494
495=item aio_mkdir $pathname, $mode, $callback->($status)
496
497Asynchronously mkdir (create) a directory and call the callback with
498the result code. C<$mode> will be modified by the umask at the time the
499request is executed, so do not change your umask.
500
501
434=item aio_rmdir $pathname, $callback->($status) 502=item aio_rmdir $pathname, $callback->($status)
435 503
436Asynchronously rmdir (delete) a directory and call the callback with the 504Asynchronously rmdir (delete) a directory and call the callback with the
437result code. 505result code.
506
438 507
439=item aio_readdir $pathname, $callback->($entries) 508=item aio_readdir $pathname, $callback->($entries)
440 509
441Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 510Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
442directory (i.e. opendir + readdir + closedir). The entries will not be 511directory (i.e. opendir + readdir + closedir). The entries will not be
443sorted, and will B<NOT> include the C<.> and C<..> entries. 512sorted, and will B<NOT> include the C<.> and C<..> entries.
444 513
445The callback a single argument which is either C<undef> or an array-ref 514The callback a single argument which is either C<undef> or an array-ref
446with the filenames. 515with the filenames.
516
517
518=item aio_load $path, $data, $callback->($status)
519
520This is a composite request that tries to fully load the given file into
521memory. Status is the same as with aio_read.
522
523=cut
524
525sub aio_load($$;$) {
526 aio_block {
527 my ($path, undef, $cb) = @_;
528 my $data = \$_[1];
529
530 my $pri = aioreq_pri;
531 my $grp = aio_group $cb;
532
533 aioreq_pri $pri;
534 add $grp aio_open $path, O_RDONLY, 0, sub {
535 my $fh = shift
536 or return $grp->result (-1);
537
538 aioreq_pri $pri;
539 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
540 $grp->result ($_[0]);
541 };
542 };
543
544 $grp
545 }
546}
447 547
448=item aio_copy $srcpath, $dstpath, $callback->($status) 548=item aio_copy $srcpath, $dstpath, $callback->($status)
449 549
450Try to copy the I<file> (directories not supported as either source or 550Try to copy the I<file> (directories not supported as either source or
451destination) from C<$srcpath> to C<$dstpath> and call the callback with 551destination) from C<$srcpath> to C<$dstpath> and call the callback with
… …
461errors are being ignored. 561errors are being ignored.
462 562
463=cut 563=cut
464 564
465sub aio_copy($$;$) { 565sub aio_copy($$;$) {
566 aio_block {
466 my ($src, $dst, $cb) = @_; 567 my ($src, $dst, $cb) = @_;
467 568
468 my $pri = aioreq_pri; 569 my $pri = aioreq_pri;
469 my $grp = aio_group $cb; 570 my $grp = aio_group $cb;
470 571
471 aioreq_pri $pri; 572 aioreq_pri $pri;
472 add $grp aio_open $src, O_RDONLY, 0, sub { 573 add $grp aio_open $src, O_RDONLY, 0, sub {
473 if (my $src_fh = $_[0]) { 574 if (my $src_fh = $_[0]) {
474 my @stat = stat $src_fh; 575 my @stat = stat $src_fh;
475 576
476 aioreq_pri $pri; 577 aioreq_pri $pri;
477 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 578 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
478 if (my $dst_fh = $_[0]) { 579 if (my $dst_fh = $_[0]) {
479 aioreq_pri $pri; 580 aioreq_pri $pri;
480 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 581 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
481 if ($_[0] == $stat[7]) { 582 if ($_[0] == $stat[7]) {
482 $grp->result (0); 583 $grp->result (0);
483 close $src_fh; 584 close $src_fh;
484 585
485 # those should not normally block. should. should. 586 # those should not normally block. should. should.
486 utime $stat[8], $stat[9], $dst; 587 utime $stat[8], $stat[9], $dst;
487 chmod $stat[2] & 07777, $dst_fh; 588 chmod $stat[2] & 07777, $dst_fh;
488 chown $stat[4], $stat[5], $dst_fh; 589 chown $stat[4], $stat[5], $dst_fh;
489 close $dst_fh; 590 close $dst_fh;
490 } else { 591 } else {
491 $grp->result (-1); 592 $grp->result (-1);
492 close $src_fh; 593 close $src_fh;
493 close $dst_fh; 594 close $dst_fh;
494 595
495 aioreq $pri; 596 aioreq $pri;
496 add $grp aio_unlink $dst; 597 add $grp aio_unlink $dst;
598 }
497 } 599 };
600 } else {
601 $grp->result (-1);
498 }; 602 }
499 } else {
500 $grp->result (-1);
501 } 603 },
604
605 } else {
606 $grp->result (-1);
502 }, 607 }
503
504 } else {
505 $grp->result (-1);
506 } 608 };
609
610 $grp
507 }; 611 }
508
509 $grp
510} 612}
511 613
512=item aio_move $srcpath, $dstpath, $callback->($status) 614=item aio_move $srcpath, $dstpath, $callback->($status)
513 615
514Try to move the I<file> (directories not supported as either source or 616Try to move the I<file> (directories not supported as either source or
… …
520that is successful, unlinking the C<$srcpath>. 622that is successful, unlinking the C<$srcpath>.
521 623
522=cut 624=cut
523 625
524sub aio_move($$;$) { 626sub aio_move($$;$) {
627 aio_block {
525 my ($src, $dst, $cb) = @_; 628 my ($src, $dst, $cb) = @_;
526 629
527 my $pri = aioreq_pri; 630 my $pri = aioreq_pri;
528 my $grp = aio_group $cb; 631 my $grp = aio_group $cb;
529 632
530 aioreq_pri $pri; 633 aioreq_pri $pri;
531 add $grp aio_rename $src, $dst, sub { 634 add $grp aio_rename $src, $dst, sub {
532 if ($_[0] && $! == EXDEV) { 635 if ($_[0] && $! == EXDEV) {
533 aioreq_pri $pri; 636 aioreq_pri $pri;
534 add $grp aio_copy $src, $dst, sub { 637 add $grp aio_copy $src, $dst, sub {
638 $grp->result ($_[0]);
639
640 if (!$_[0]) {
641 aioreq_pri $pri;
642 add $grp aio_unlink $src;
643 }
644 };
645 } else {
535 $grp->result ($_[0]); 646 $grp->result ($_[0]);
536
537 if (!$_[0]) {
538 aioreq_pri $pri;
539 add $grp aio_unlink $src;
540 }
541 }; 647 }
542 } else {
543 $grp->result ($_[0]);
544 } 648 };
649
650 $grp
545 }; 651 }
546
547 $grp
548} 652}
549 653
550=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 654=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
551 655
552Scans a directory (similar to C<aio_readdir>) but additionally tries to 656Scans 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 703as those tend to return 0 or 1 as link counts, which disables the
600directory counting heuristic. 704directory counting heuristic.
601 705
602=cut 706=cut
603 707
604sub aio_scandir($$$) { 708sub aio_scandir($$;$) {
709 aio_block {
605 my ($path, $maxreq, $cb) = @_; 710 my ($path, $maxreq, $cb) = @_;
606 711
607 my $pri = aioreq_pri; 712 my $pri = aioreq_pri;
608 713
609 my $grp = aio_group $cb; 714 my $grp = aio_group $cb;
610 715
611 $maxreq = 4 if $maxreq <= 0; 716 $maxreq = 4 if $maxreq <= 0;
612 717
613 # stat once 718 # 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; 719 aioreq_pri $pri;
622 add $grp aio_readdir $path, sub { 720 add $grp aio_stat $path, sub {
623 my $entries = shift
624 or return $grp->result (); 721 return $grp->result () if $_[0];
722 my $now = time;
723 my $hash1 = join ":", (stat _)[0,1,3,7,9];
625 724
626 # stat the dir another time 725 # read the directory entries
627 aioreq_pri $pri; 726 aioreq_pri $pri;
727 add $grp aio_readdir $path, sub {
728 my $entries = shift
729 or return $grp->result ();
730
731 # stat the dir another time
732 aioreq_pri $pri;
628 add $grp aio_stat $path, sub { 733 add $grp aio_stat $path, sub {
629 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 734 my $hash2 = join ":", (stat _)[0,1,3,7,9];
630 735
631 my $ndirs; 736 my $ndirs;
632 737
633 # take the slow route if anything looks fishy 738 # take the slow route if anything looks fishy
634 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 739 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
635 $ndirs = -1; 740 $ndirs = -1;
636 } else { 741 } else {
637 # if nlink == 2, we are finished 742 # if nlink == 2, we are finished
638 # on non-posix-fs's, we rely on nlink < 2 743 # on non-posix-fs's, we rely on nlink < 2
639 $ndirs = (stat _)[3] - 2 744 $ndirs = (stat _)[3] - 2
640 or return $grp->result ([], $entries); 745 or return $grp->result ([], $entries);
641 } 746 }
642 747
643 # sort into likely dirs and likely nondirs 748 # sort into likely dirs and likely nondirs
644 # dirs == files without ".", short entries first 749 # dirs == files without ".", short entries first
645 $entries = [map $_->[0], 750 $entries = [map $_->[0],
646 sort { $b->[1] cmp $a->[1] } 751 sort { $b->[1] cmp $a->[1] }
647 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 752 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
648 @$entries]; 753 @$entries];
649 754
650 my (@dirs, @nondirs); 755 my (@dirs, @nondirs);
651 756
652 my $statgrp = add $grp aio_group sub { 757 my $statgrp = add $grp aio_group sub {
653 $grp->result (\@dirs, \@nondirs); 758 $grp->result (\@dirs, \@nondirs);
654 }; 759 };
655 760
656 limit $statgrp $maxreq; 761 limit $statgrp $maxreq;
657 feed $statgrp sub { 762 feed $statgrp sub {
658 return unless @$entries; 763 return unless @$entries;
659 my $entry = pop @$entries; 764 my $entry = pop @$entries;
660 765
661 aioreq_pri $pri; 766 aioreq_pri $pri;
662 add $statgrp aio_stat "$path/$entry/.", sub { 767 add $statgrp aio_stat "$path/$entry/.", sub {
663 if ($_[0] < 0) { 768 if ($_[0] < 0) {
664 push @nondirs, $entry; 769 push @nondirs, $entry;
665 } else { 770 } else {
666 # need to check for real directory 771 # need to check for real directory
667 aioreq_pri $pri; 772 aioreq_pri $pri;
668 add $statgrp aio_lstat "$path/$entry", sub { 773 add $statgrp aio_lstat "$path/$entry", sub {
669 if (-d _) { 774 if (-d _) {
670 push @dirs, $entry; 775 push @dirs, $entry;
671 776
672 unless (--$ndirs) { 777 unless (--$ndirs) {
673 push @nondirs, @$entries; 778 push @nondirs, @$entries;
674 feed $statgrp; 779 feed $statgrp;
780 }
781 } else {
782 push @nondirs, $entry;
675 } 783 }
676 } else {
677 push @nondirs, $entry;
678 } 784 }
679 } 785 }
680 } 786 };
681 }; 787 };
682 }; 788 };
683 }; 789 };
684 }; 790 };
791
792 $grp
685 }; 793 }
794}
686 795
796=item aio_rmtree $path, $callback->($status)
797
798Delete a directory tree starting (and including) C<$path>, return the
799status of the final C<rmdir> only. This is a composite request that
800uses C<aio_scandir> to recurse into and rmdir directories, and unlink
801everything else.
802
803=cut
804
805sub aio_rmtree;
806sub aio_rmtree($;$) {
807 aio_block {
808 my ($path, $cb) = @_;
809
810 my $pri = aioreq_pri;
811 my $grp = aio_group $cb;
812
813 aioreq_pri $pri;
814 add $grp aio_scandir $path, 0, sub {
815 my ($dirs, $nondirs) = @_;
816
817 my $dirgrp = aio_group sub {
818 add $grp aio_rmdir $path, sub {
819 $grp->result ($_[0]);
820 };
821 };
822
823 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
824 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
825
826 add $grp $dirgrp;
827 };
828
687 $grp 829 $grp
830 }
688} 831}
689 832
690=item aio_fsync $fh, $callback->($status) 833=item aio_fsync $fh, $callback->($status)
691 834
692Asynchronously call fsync on the given filehandle and call the callback 835Asynchronously call fsync on the given filehandle and call the callback
… …
971 poll => 'r', nice => 1, 1114 poll => 'r', nice => 1,
972 cb => &IO::AIO::poll_cb); 1115 cb => &IO::AIO::poll_cb);
973 1116
974=item IO::AIO::poll_wait 1117=item IO::AIO::poll_wait
975 1118
1119If there are any outstanding requests and none of them in the result
976Wait till the result filehandle becomes ready for reading (simply does a 1120phase, wait till the result filehandle becomes ready for reading (simply
977C<select> on the filehandle. This is useful if you want to synchronously 1121does a C<select> on the filehandle. This is useful if you want to
978wait for some requests to finish). 1122synchronously wait for some requests to finish).
979 1123
980See C<nreqs> for an example. 1124See C<nreqs> for an example.
981 1125
982=item IO::AIO::poll 1126=item IO::AIO::poll
983 1127
984Waits until some requests have been handled. 1128Waits until some requests have been handled.
985 1129
1130Returns the number of requests processed, but is otherwise strictly
986Strictly equivalent to: 1131equivalent to:
987 1132
988 IO::AIO::poll_wait, IO::AIO::poll_cb 1133 IO::AIO::poll_wait, IO::AIO::poll_cb
989 if IO::AIO::nreqs;
990 1134
991=item IO::AIO::flush 1135=item IO::AIO::flush
992 1136
993Wait till all outstanding AIO requests have been handled. 1137Wait till all outstanding AIO requests have been handled.
994 1138
995Strictly equivalent to: 1139Strictly equivalent to:
996 1140
997 IO::AIO::poll_wait, IO::AIO::poll_cb 1141 IO::AIO::poll_wait, IO::AIO::poll_cb
998 while IO::AIO::nreqs; 1142 while IO::AIO::nreqs;
999 1143
1144=back
1145
1000=head3 CONTROLLING THE NUMBER OF THREADS 1146=head3 CONTROLLING THE NUMBER OF THREADS
1147
1148=over
1001 1149
1002=item IO::AIO::min_parallel $nthreads 1150=item IO::AIO::min_parallel $nthreads
1003 1151
1004Set the minimum number of AIO threads to C<$nthreads>. The current 1152Set the minimum number of AIO threads to C<$nthreads>. The current
1005default is C<8>, which means eight asynchronous operations can execute 1153default is C<8>, which means eight asynchronous operations can execute
… …
1064 1212
1065You can still queue as many requests as you want. Therefore, 1213You can still queue as many requests as you want. Therefore,
1066C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1214C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1067as a stop gap to shield against fatal memory overflow (with large values). 1215as a stop gap to shield against fatal memory overflow (with large values).
1068 1216
1217=back
1218
1069=head3 STATISTICAL INFORMATION 1219=head3 STATISTICAL INFORMATION
1220
1221=over
1070 1222
1071=item IO::AIO::nreqs 1223=item IO::AIO::nreqs
1072 1224
1073Returns the number of requests currently in the ready, execute or pending 1225Returns the number of requests currently in the ready, execute or pending
1074states (i.e. for which their callback has not been invoked yet). 1226states (i.e. for which their callback has not been invoked yet).
… …
1108 *$sym 1260 *$sym
1109} 1261}
1110 1262
1111min_parallel 8; 1263min_parallel 8;
1112 1264
1113END { 1265END { flush }
1114 min_parallel 1;
1115 flush;
1116};
1117 1266
11181; 12671;
1119 1268
1120=head2 FORK BEHAVIOUR 1269=head2 FORK BEHAVIOUR
1121 1270

Diff Legend

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