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.88 by root, Sun Oct 29 01:50:29 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 this works on all types of file descriptors (for example sockets), 67While most of this works on all types of file descriptors (for
67using these functions on file descriptors that support nonblocking 68example sockets), using these functions on file descriptors that
68operation (again, sockets, pipes etc.) is very inefficient. Use an event 69support nonblocking operation (again, sockets, pipes etc.) is very
69loop for that (such as the L<Event|Event> module): IO::AIO will naturally 70inefficient. Use an event loop for that (such as the L<Event|Event>
70fit into such an event loop itself. 71module): IO::AIO will naturally fit into such an event loop itself.
71 72
72In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
73requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
74in perl, and the threads created by this module will not be visible 75in perl, and the threads created by this module will not be visible
75to perl. In the future, this module might make use of the native aio 76to perl. In the future, this module might make use of the native aio
… …
77not well-supported or restricted (GNU/Linux doesn't allow them on normal 78not well-supported or restricted (GNU/Linux doesn't allow them on normal
78files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
79aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
80using threads anyway. 81using threads anyway.
81 82
82Although the module will work with in the presence of other (Perl-) 83Although the module will work in the presence of other (Perl-) threads,
83threads, it is currently not reentrant in any way, so use appropriate 84it is currently not reentrant in any way, so use appropriate locking
84locking yourself, always call C<poll_cb> from within the same thread, or 85yourself, always call C<poll_cb> from within the same thread, or never
85never call C<poll_cb> (or other C<aio_> functions) recursively. 86call C<poll_cb> (or other C<aio_> functions) recursively.
86 87
87=head2 EXAMPLE 88=head2 EXAMPLE
88 89
89This is a simple example that uses the Event module and loads 90This is a simple example that uses the Event module and loads
90F</etc/passwd> asynchronously: 91F</etc/passwd> asynchronously:
… …
98 poll => 'r', 99 poll => 'r',
99 cb => \&IO::AIO::poll_cb); 100 cb => \&IO::AIO::poll_cb);
100 101
101 # queue the request to open /etc/passwd 102 # queue the request to open /etc/passwd
102 aio_open "/etc/passwd", O_RDONLY, 0, sub { 103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
103 my $fh = $_[0] 104 my $fh = shift
104 or die "error while opening: $!"; 105 or die "error while opening: $!";
105 106
106 # stat'ing filehandles is generally non-blocking 107 # stat'ing filehandles is generally non-blocking
107 my $size = -s $fh; 108 my $size = -s $fh;
108 109
… …
188use strict 'vars'; 189use strict 'vars';
189 190
190use base 'Exporter'; 191use base 'Exporter';
191 192
192BEGIN { 193BEGIN {
193 our $VERSION = '2.1'; 194 our $VERSION = '2.4';
194 195
195 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
196 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
197 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
198 aio_copy aio_group aio_nop aio_mknod); 200 aio_chown aio_chmod aio_utime);
199 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
200 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
201 min_parallel max_parallel max_idle 203 min_parallel max_parallel max_idle
202 nreqs nready npending nthreads 204 nreqs nready npending nthreads
203 max_poll_time max_poll_reqs); 205 max_poll_time max_poll_reqs);
204 206
… …
269 aio_read $_[0], ..., sub { 271 aio_read $_[0], ..., sub {
270 ... 272 ...
271 }; 273 };
272 }; 274 };
273 275
276
274=item aioreq_nice $pri_adjust 277=item aioreq_nice $pri_adjust
275 278
276Similar 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
277priority, so the effect is cumulative. 280priority, so the effect is cumulative.
281
278 282
279=item aio_open $pathname, $flags, $mode, $callback->($fh) 283=item aio_open $pathname, $flags, $mode, $callback->($fh)
280 284
281Asynchronously 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
282created filehandle for the file. 286created filehandle for the file.
… …
288list. They are the same as used by C<sysopen>. 292list. They are the same as used by C<sysopen>.
289 293
290Likewise, 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
291didn'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>,
292except 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,
293and 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.
294 300
295Example: 301Example:
296 302
297 aio_open "/etc/passwd", O_RDONLY, 0, sub { 303 aio_open "/etc/passwd", O_RDONLY, 0, sub {
298 if ($_[0]) { 304 if ($_[0]) {
… …
301 } else { 307 } else {
302 die "open failed: $!\n"; 308 die "open failed: $!\n";
303 } 309 }
304 }; 310 };
305 311
312
306=item aio_close $fh, $callback->($status) 313=item aio_close $fh, $callback->($status)
307 314
308Asynchronously close a file and call the callback with the result 315Asynchronously close a file and call the callback with the result
309code. I<WARNING:> although accepted, you should not pass in a perl 316code. I<WARNING:> although accepted, you should not pass in a perl
310filehandle here, as perl will likely close the file descriptor another 317filehandle here, as perl will likely close the file descriptor another
… …
312C<close> or just let filehandles go out of scope. 319C<close> or just let filehandles go out of scope.
313 320
314This 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
315therefore best to avoid this function. 322therefore best to avoid this function.
316 323
324
317=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
318 326
319=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
320 328
321Reads 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>
322into 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
323callback 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
324like 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.
325 335
326The 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
327is outstanding. Modifying it can result in segfaults or WW3 (if the 337is outstanding. Modifying it can result in segfaults or World War III (if
328necessary/optional hardware is installed). 338the necessary/optional hardware is installed).
329 339
330Example: 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
331offset C<0> within the scalar: 341offset C<0> within the scalar:
332 342
333 aio_read $fh, 7, 15, $buffer, 0, sub { 343 aio_read $fh, 7, 15, $buffer, 0, sub {
334 $_[0] > 0 or die "read error: $!"; 344 $_[0] > 0 or die "read error: $!";
335 print "read $_[0] bytes: <$buffer>\n"; 345 print "read $_[0] bytes: <$buffer>\n";
336 }; 346 };
347
337 348
338=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)
339 350
340Tries 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
341reading 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
… …
355C<$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
356bytes 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
357provides 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
358value 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
359read. 370read.
371
360 372
361=item aio_readahead $fh,$offset,$length, $callback->($retval) 373=item aio_readahead $fh,$offset,$length, $callback->($retval)
362 374
363C<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
364subsequent 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>
… …
370file. The current file offset of the file is left unchanged. 382file. The current file offset of the file is left unchanged.
371 383
372If 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
373emulated by simply reading the data, which would have a similar effect. 385emulated by simply reading the data, which would have a similar effect.
374 386
387
375=item aio_stat $fh_or_path, $callback->($status) 388=item aio_stat $fh_or_path, $callback->($status)
376 389
377=item aio_lstat $fh, $callback->($status) 390=item aio_lstat $fh, $callback->($status)
378 391
379Works 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
… …
392 aio_stat "/etc/passwd", sub { 405 aio_stat "/etc/passwd", sub {
393 $_[0] and die "stat failed: $!"; 406 $_[0] and die "stat failed: $!";
394 print "size is ", -s _, "\n"; 407 print "size is ", -s _, "\n";
395 }; 408 };
396 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
397=item aio_unlink $pathname, $callback->($status) 447=item aio_unlink $pathname, $callback->($status)
398 448
399Asynchronously unlink (delete) a file and call the callback with the 449Asynchronously unlink (delete) a file and call the callback with the
400result code. 450result code.
401 451
452
402=item aio_mknod $path, $mode, $dev, $callback->($status) 453=item aio_mknod $path, $mode, $dev, $callback->($status)
403 454
404[EXPERIMENTAL] 455[EXPERIMENTAL]
405 456
406Asynchronously create a device node (or fifo). See mknod(2). 457Asynchronously create a device node (or fifo). See mknod(2).
407 458
408The only (POSIX-) portable way of calling this function is: 459The only (POSIX-) portable way of calling this function is:
409 460
410 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 461 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
462
411 463
412=item aio_link $srcpath, $dstpath, $callback->($status) 464=item aio_link $srcpath, $dstpath, $callback->($status)
413 465
414Asynchronously 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
415the path C<$dstpath> and call the callback with the result code. 467the path C<$dstpath> and call the callback with the result code.
416 468
469
417=item aio_symlink $srcpath, $dstpath, $callback->($status) 470=item aio_symlink $srcpath, $dstpath, $callback->($status)
418 471
419Asynchronously 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
420the path C<$dstpath> and call the callback with the result code. 473the path C<$dstpath> and call the callback with the result code.
421 474
475
476=item aio_readlink $path, $callback->($link)
477
478Asynchronously read the symlink specified by C<$path> and pass it to
479the callback. If an error occurs, nothing or undef gets passed to the
480callback.
481
482
422=item aio_rename $srcpath, $dstpath, $callback->($status) 483=item aio_rename $srcpath, $dstpath, $callback->($status)
423 484
424Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 485Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
425rename(2) and call the callback with the result code. 486rename(2) and call the callback with the result code.
426 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
427=item aio_rmdir $pathname, $callback->($status) 496=item aio_rmdir $pathname, $callback->($status)
428 497
429Asynchronously rmdir (delete) a directory and call the callback with the 498Asynchronously rmdir (delete) a directory and call the callback with the
430result code. 499result code.
500
431 501
432=item aio_readdir $pathname, $callback->($entries) 502=item aio_readdir $pathname, $callback->($entries)
433 503
434Unlike 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
435directory (i.e. opendir + readdir + closedir). The entries will not be 505directory (i.e. opendir + readdir + closedir). The entries will not be
436sorted, and will B<NOT> include the C<.> and C<..> entries. 506sorted, and will B<NOT> include the C<.> and C<..> entries.
437 507
438The 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
439with 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}
440 541
441=item aio_copy $srcpath, $dstpath, $callback->($status) 542=item aio_copy $srcpath, $dstpath, $callback->($status)
442 543
443Try 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
444destination) from C<$srcpath> to C<$dstpath> and call the callback with 545destination) from C<$srcpath> to C<$dstpath> and call the callback with
… …
454errors are being ignored. 555errors are being ignored.
455 556
456=cut 557=cut
457 558
458sub aio_copy($$;$) { 559sub aio_copy($$;$) {
560 aio_block {
459 my ($src, $dst, $cb) = @_; 561 my ($src, $dst, $cb) = @_;
460 562
461 my $pri = aioreq_pri; 563 my $pri = aioreq_pri;
462 my $grp = aio_group $cb; 564 my $grp = aio_group $cb;
463 565
464 aioreq_pri $pri; 566 aioreq_pri $pri;
465 add $grp aio_open $src, O_RDONLY, 0, sub { 567 add $grp aio_open $src, O_RDONLY, 0, sub {
466 if (my $src_fh = $_[0]) { 568 if (my $src_fh = $_[0]) {
467 my @stat = stat $src_fh; 569 my @stat = stat $src_fh;
468 570
469 aioreq_pri $pri; 571 aioreq_pri $pri;
470 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 {
471 if (my $dst_fh = $_[0]) { 573 if (my $dst_fh = $_[0]) {
472 aioreq_pri $pri; 574 aioreq_pri $pri;
473 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 {
474 if ($_[0] == $stat[7]) { 576 if ($_[0] == $stat[7]) {
475 $grp->result (0); 577 $grp->result (0);
476 close $src_fh; 578 close $src_fh;
477 579
478 # those should not normally block. should. should. 580 # those should not normally block. should. should.
479 utime $stat[8], $stat[9], $dst; 581 utime $stat[8], $stat[9], $dst;
480 chmod $stat[2] & 07777, $dst_fh; 582 chmod $stat[2] & 07777, $dst_fh;
481 chown $stat[4], $stat[5], $dst_fh; 583 chown $stat[4], $stat[5], $dst_fh;
482 close $dst_fh; 584 close $dst_fh;
483 } else { 585 } else {
484 $grp->result (-1); 586 $grp->result (-1);
485 close $src_fh; 587 close $src_fh;
486 close $dst_fh; 588 close $dst_fh;
487 589
488 aioreq $pri; 590 aioreq $pri;
489 add $grp aio_unlink $dst; 591 add $grp aio_unlink $dst;
592 }
490 } 593 };
594 } else {
595 $grp->result (-1);
491 }; 596 }
492 } else {
493 $grp->result (-1);
494 } 597 },
598
599 } else {
600 $grp->result (-1);
495 }, 601 }
496
497 } else {
498 $grp->result (-1);
499 } 602 };
603
604 $grp
500 }; 605 }
501
502 $grp
503} 606}
504 607
505=item aio_move $srcpath, $dstpath, $callback->($status) 608=item aio_move $srcpath, $dstpath, $callback->($status)
506 609
507Try 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
… …
513that is successful, unlinking the C<$srcpath>. 616that is successful, unlinking the C<$srcpath>.
514 617
515=cut 618=cut
516 619
517sub aio_move($$;$) { 620sub aio_move($$;$) {
621 aio_block {
518 my ($src, $dst, $cb) = @_; 622 my ($src, $dst, $cb) = @_;
519 623
520 my $pri = aioreq_pri; 624 my $pri = aioreq_pri;
521 my $grp = aio_group $cb; 625 my $grp = aio_group $cb;
522 626
523 aioreq_pri $pri; 627 aioreq_pri $pri;
524 add $grp aio_rename $src, $dst, sub { 628 add $grp aio_rename $src, $dst, sub {
525 if ($_[0] && $! == EXDEV) { 629 if ($_[0] && $! == EXDEV) {
526 aioreq_pri $pri; 630 aioreq_pri $pri;
527 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 {
528 $grp->result ($_[0]); 640 $grp->result ($_[0]);
529
530 if (!$_[0]) {
531 aioreq_pri $pri;
532 add $grp aio_unlink $src;
533 }
534 }; 641 }
535 } else {
536 $grp->result ($_[0]);
537 } 642 };
643
644 $grp
538 }; 645 }
539
540 $grp
541} 646}
542 647
543=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 648=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
544 649
545Scans a directory (similar to C<aio_readdir>) but additionally tries to 650Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
592as 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
593directory counting heuristic. 698directory counting heuristic.
594 699
595=cut 700=cut
596 701
597sub aio_scandir($$$) { 702sub aio_scandir($$;$) {
703 aio_block {
598 my ($path, $maxreq, $cb) = @_; 704 my ($path, $maxreq, $cb) = @_;
599 705
600 my $pri = aioreq_pri; 706 my $pri = aioreq_pri;
601 707
602 my $grp = aio_group $cb; 708 my $grp = aio_group $cb;
603 709
604 $maxreq = 4 if $maxreq <= 0; 710 $maxreq = 4 if $maxreq <= 0;
605 711
606 # stat once 712 # stat once
607 aioreq_pri $pri;
608 add $grp aio_stat $path, sub {
609 return $grp->result () if $_[0];
610 my $now = time;
611 my $hash1 = join ":", (stat _)[0,1,3,7,9];
612
613 # read the directory entries
614 aioreq_pri $pri; 713 aioreq_pri $pri;
615 add $grp aio_readdir $path, sub { 714 add $grp aio_stat $path, sub {
616 my $entries = shift
617 or return $grp->result (); 715 return $grp->result () if $_[0];
716 my $now = time;
717 my $hash1 = join ":", (stat _)[0,1,3,7,9];
618 718
619 # stat the dir another time 719 # read the directory entries
620 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;
621 add $grp aio_stat $path, sub { 727 add $grp aio_stat $path, sub {
622 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 728 my $hash2 = join ":", (stat _)[0,1,3,7,9];
623 729
624 my $ndirs; 730 my $ndirs;
625 731
626 # take the slow route if anything looks fishy 732 # take the slow route if anything looks fishy
627 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 733 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
628 $ndirs = -1; 734 $ndirs = -1;
629 } else { 735 } else {
630 # if nlink == 2, we are finished 736 # if nlink == 2, we are finished
631 # on non-posix-fs's, we rely on nlink < 2 737 # on non-posix-fs's, we rely on nlink < 2
632 $ndirs = (stat _)[3] - 2 738 $ndirs = (stat _)[3] - 2
633 or return $grp->result ([], $entries); 739 or return $grp->result ([], $entries);
634 } 740 }
635 741
636 # sort into likely dirs and likely nondirs 742 # sort into likely dirs and likely nondirs
637 # dirs == files without ".", short entries first 743 # dirs == files without ".", short entries first
638 $entries = [map $_->[0], 744 $entries = [map $_->[0],
639 sort { $b->[1] cmp $a->[1] } 745 sort { $b->[1] cmp $a->[1] }
640 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 746 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
641 @$entries]; 747 @$entries];
642 748
643 my (@dirs, @nondirs); 749 my (@dirs, @nondirs);
644 750
645 my $statgrp = add $grp aio_group sub { 751 my $statgrp = add $grp aio_group sub {
646 $grp->result (\@dirs, \@nondirs); 752 $grp->result (\@dirs, \@nondirs);
647 }; 753 };
648 754
649 limit $statgrp $maxreq; 755 limit $statgrp $maxreq;
650 feed $statgrp sub { 756 feed $statgrp sub {
651 return unless @$entries; 757 return unless @$entries;
652 my $entry = pop @$entries; 758 my $entry = pop @$entries;
653 759
654 aioreq_pri $pri; 760 aioreq_pri $pri;
655 add $statgrp aio_stat "$path/$entry/.", sub { 761 add $statgrp aio_stat "$path/$entry/.", sub {
656 if ($_[0] < 0) { 762 if ($_[0] < 0) {
657 push @nondirs, $entry; 763 push @nondirs, $entry;
658 } else { 764 } else {
659 # need to check for real directory 765 # need to check for real directory
660 aioreq_pri $pri; 766 aioreq_pri $pri;
661 add $statgrp aio_lstat "$path/$entry", sub { 767 add $statgrp aio_lstat "$path/$entry", sub {
662 if (-d _) { 768 if (-d _) {
663 push @dirs, $entry; 769 push @dirs, $entry;
664 770
665 unless (--$ndirs) { 771 unless (--$ndirs) {
666 push @nondirs, @$entries; 772 push @nondirs, @$entries;
667 feed $statgrp; 773 feed $statgrp;
774 }
775 } else {
776 push @nondirs, $entry;
668 } 777 }
669 } else {
670 push @nondirs, $entry;
671 } 778 }
672 } 779 }
673 } 780 };
674 }; 781 };
675 }; 782 };
676 }; 783 };
677 }; 784 };
785
786 $grp
678 }; 787 }
788}
679 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
680 $grp 823 $grp
824 }
681} 825}
682 826
683=item aio_fsync $fh, $callback->($status) 827=item aio_fsync $fh, $callback->($status)
684 828
685Asynchronously call fsync on the given filehandle and call the callback 829Asynchronously call fsync on the given filehandle and call the callback
… …
939that are being processed by C<IO::AIO::poll_cb> in one call, respectively 1083that are being processed by C<IO::AIO::poll_cb> in one call, respectively
940the maximum amount of time (default C<0>, meaning infinity) spent in 1084the maximum amount of time (default C<0>, meaning infinity) spent in
941C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount 1085C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
942of time C<poll_cb> is allowed to use). 1086of time C<poll_cb> is allowed to use).
943 1087
1088Setting C<max_poll_time> to a non-zero value creates an overhead of one
1089syscall per request processed, which is not normally a problem unless your
1090callbacks are really really fast or your OS is really really slow (I am
1091not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1092
944Setting these is useful if you want to ensure some level of 1093Setting these is useful if you want to ensure some level of
945interactiveness when perl is not fast enough to process all requests in 1094interactiveness when perl is not fast enough to process all requests in
946time. 1095time.
947 1096
948For interactive programs, values such as C<0.01> to C<0.1> should be fine. 1097For interactive programs, values such as C<0.01> to C<0.1> should be fine.
949 1098
950Example: Install an Event watcher that automatically calls 1099Example: Install an Event watcher that automatically calls
951IO::AIO::poll_some with low priority, to ensure that other parts of the 1100IO::AIO::poll_cb with low priority, to ensure that other parts of the
952program get the CPU sometimes even under high AIO load. 1101program get the CPU sometimes even under high AIO load.
953 1102
954 # try not to spend much more than 0.1s in poll_cb 1103 # try not to spend much more than 0.1s in poll_cb
955 IO::AIO::max_poll_time 0.1; 1104 IO::AIO::max_poll_time 0.1;
956 1105
… …
959 poll => 'r', nice => 1, 1108 poll => 'r', nice => 1,
960 cb => &IO::AIO::poll_cb); 1109 cb => &IO::AIO::poll_cb);
961 1110
962=item IO::AIO::poll_wait 1111=item IO::AIO::poll_wait
963 1112
1113If there are any outstanding requests and none of them in the result
964Wait till the result filehandle becomes ready for reading (simply does a 1114phase, wait till the result filehandle becomes ready for reading (simply
965C<select> on the filehandle. This is useful if you want to synchronously 1115does a C<select> on the filehandle. This is useful if you want to
966wait for some requests to finish). 1116synchronously wait for some requests to finish).
967 1117
968See C<nreqs> for an example. 1118See C<nreqs> for an example.
969 1119
970=item IO::AIO::poll 1120=item IO::AIO::poll
971 1121
972Waits until some requests have been handled. 1122Waits until some requests have been handled.
973 1123
1124Returns the number of requests processed, but is otherwise strictly
974Strictly equivalent to: 1125equivalent to:
975 1126
976 IO::AIO::poll_wait, IO::AIO::poll_cb 1127 IO::AIO::poll_wait, IO::AIO::poll_cb
977 if IO::AIO::nreqs;
978 1128
979=item IO::AIO::flush 1129=item IO::AIO::flush
980 1130
981Wait till all outstanding AIO requests have been handled. 1131Wait till all outstanding AIO requests have been handled.
982 1132
983Strictly equivalent to: 1133Strictly equivalent to:
984 1134
985 IO::AIO::poll_wait, IO::AIO::poll_cb 1135 IO::AIO::poll_wait, IO::AIO::poll_cb
986 while IO::AIO::nreqs; 1136 while IO::AIO::nreqs;
987 1137
1138=back
1139
988=head3 CONTROLLING THE NUMBER OF THREADS 1140=head3 CONTROLLING THE NUMBER OF THREADS
1141
1142=over
989 1143
990=item IO::AIO::min_parallel $nthreads 1144=item IO::AIO::min_parallel $nthreads
991 1145
992Set the minimum number of AIO threads to C<$nthreads>. The current 1146Set the minimum number of AIO threads to C<$nthreads>. The current
993default is C<8>, which means eight asynchronous operations can execute 1147default is C<8>, which means eight asynchronous operations can execute
… …
1052 1206
1053You can still queue as many requests as you want. Therefore, 1207You can still queue as many requests as you want. Therefore,
1054C<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
1055as 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).
1056 1210
1211=back
1212
1057=head3 STATISTICAL INFORMATION 1213=head3 STATISTICAL INFORMATION
1214
1215=over
1058 1216
1059=item IO::AIO::nreqs 1217=item IO::AIO::nreqs
1060 1218
1061Returns the number of requests currently in the ready, execute or pending 1219Returns the number of requests currently in the ready, execute or pending
1062states (i.e. for which their callback has not been invoked yet). 1220states (i.e. for which their callback has not been invoked yet).
… …
1096 *$sym 1254 *$sym
1097} 1255}
1098 1256
1099min_parallel 8; 1257min_parallel 8;
1100 1258
1101END { 1259END { flush }
1102 min_parallel 1;
1103 flush;
1104};
1105 1260
11061; 12611;
1107 1262
1108=head2 FORK BEHAVIOUR 1263=head2 FORK BEHAVIOUR
1109 1264

Diff Legend

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