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.110 by root, Sun Jul 8 09:09:34 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
198 aio_copy aio_group aio_nop aio_mknod); 199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
200 aio_chown aio_chmod aio_utime aio_truncate);
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).
325 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
326The 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
327is outstanding. Modifying it can result in segfaults or WW3 (if the 343is outstanding. Modifying it can result in segfaults or World War III (if
328necessary/optional hardware is installed). 344the necessary/optional hardware is installed).
329 345
330Example: 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
331offset C<0> within the scalar: 347offset C<0> within the scalar:
332 348
333 aio_read $fh, 7, 15, $buffer, 0, sub { 349 aio_read $fh, 7, 15, $buffer, 0, sub {
334 $_[0] > 0 or die "read error: $!"; 350 $_[0] > 0 or die "read error: $!";
335 print "read $_[0] bytes: <$buffer>\n"; 351 print "read $_[0] bytes: <$buffer>\n";
336 }; 352 };
353
337 354
338=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)
339 356
340Tries 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
341reading 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
… …
355C<$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
356bytes 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
357provides 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
358value 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
359read. 376read.
377
360 378
361=item aio_readahead $fh,$offset,$length, $callback->($retval) 379=item aio_readahead $fh,$offset,$length, $callback->($retval)
362 380
363C<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
364subsequent 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>
… …
370file. The current file offset of the file is left unchanged. 388file. The current file offset of the file is left unchanged.
371 389
372If 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
373emulated by simply reading the data, which would have a similar effect. 391emulated by simply reading the data, which would have a similar effect.
374 392
393
375=item aio_stat $fh_or_path, $callback->($status) 394=item aio_stat $fh_or_path, $callback->($status)
376 395
377=item aio_lstat $fh, $callback->($status) 396=item aio_lstat $fh, $callback->($status)
378 397
379Works 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
… …
392 aio_stat "/etc/passwd", sub { 411 aio_stat "/etc/passwd", sub {
393 $_[0] and die "stat failed: $!"; 412 $_[0] and die "stat failed: $!";
394 print "size is ", -s _, "\n"; 413 print "size is ", -s _, "\n";
395 }; 414 };
396 415
416
417=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
418
419Works like perl's C<utime> function (including the special case of $atime
420and $mtime being undef). Fractional times are supported if the underlying
421syscalls support them.
422
423When called with a pathname, uses utimes(2) if available, otherwise
424utime(2). If called on a file descriptor, uses futimes(2) if available,
425otherwise returns ENOSYS, so this is not portable.
426
427Examples:
428
429 # set atime and mtime to current time (basically touch(1)):
430 aio_utime "path", undef, undef;
431 # set atime to current time and mtime to beginning of the epoch:
432 aio_utime "path", time, undef; # undef==0
433
434
435=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
436
437Works like perl's C<chown> function, except that C<undef> for either $uid
438or $gid is being interpreted as "do not change" (but -1 can also be used).
439
440Examples:
441
442 # same as "chown root path" in the shell:
443 aio_chown "path", 0, -1;
444 # same as above:
445 aio_chown "path", 0, undef;
446
447
448=item aio_truncate $fh_or_path, $offset, $callback->($status)
449
450Works like truncate(2) or ftruncate(2).
451
452
453=item aio_chmod $fh_or_path, $mode, $callback->($status)
454
455Works like perl's C<chmod> function.
456
457
397=item aio_unlink $pathname, $callback->($status) 458=item aio_unlink $pathname, $callback->($status)
398 459
399Asynchronously unlink (delete) a file and call the callback with the 460Asynchronously unlink (delete) a file and call the callback with the
400result code. 461result code.
401 462
463
402=item aio_mknod $path, $mode, $dev, $callback->($status) 464=item aio_mknod $path, $mode, $dev, $callback->($status)
403 465
404[EXPERIMENTAL] 466[EXPERIMENTAL]
405 467
406Asynchronously create a device node (or fifo). See mknod(2). 468Asynchronously create a device node (or fifo). See mknod(2).
407 469
408The only (POSIX-) portable way of calling this function is: 470The only (POSIX-) portable way of calling this function is:
409 471
410 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 472 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
473
411 474
412=item aio_link $srcpath, $dstpath, $callback->($status) 475=item aio_link $srcpath, $dstpath, $callback->($status)
413 476
414Asynchronously create a new link to the existing object at C<$srcpath> at 477Asynchronously create a new link to the existing object at C<$srcpath> at
415the path C<$dstpath> and call the callback with the result code. 478the path C<$dstpath> and call the callback with the result code.
416 479
480
417=item aio_symlink $srcpath, $dstpath, $callback->($status) 481=item aio_symlink $srcpath, $dstpath, $callback->($status)
418 482
419Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 483Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
420the path C<$dstpath> and call the callback with the result code. 484the path C<$dstpath> and call the callback with the result code.
421 485
486
487=item aio_readlink $path, $callback->($link)
488
489Asynchronously read the symlink specified by C<$path> and pass it to
490the callback. If an error occurs, nothing or undef gets passed to the
491callback.
492
493
422=item aio_rename $srcpath, $dstpath, $callback->($status) 494=item aio_rename $srcpath, $dstpath, $callback->($status)
423 495
424Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 496Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
425rename(2) and call the callback with the result code. 497rename(2) and call the callback with the result code.
426 498
499
500=item aio_mkdir $pathname, $mode, $callback->($status)
501
502Asynchronously mkdir (create) a directory and call the callback with
503the result code. C<$mode> will be modified by the umask at the time the
504request is executed, so do not change your umask.
505
506
427=item aio_rmdir $pathname, $callback->($status) 507=item aio_rmdir $pathname, $callback->($status)
428 508
429Asynchronously rmdir (delete) a directory and call the callback with the 509Asynchronously rmdir (delete) a directory and call the callback with the
430result code. 510result code.
511
431 512
432=item aio_readdir $pathname, $callback->($entries) 513=item aio_readdir $pathname, $callback->($entries)
433 514
434Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 515Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
435directory (i.e. opendir + readdir + closedir). The entries will not be 516directory (i.e. opendir + readdir + closedir). The entries will not be
436sorted, and will B<NOT> include the C<.> and C<..> entries. 517sorted, and will B<NOT> include the C<.> and C<..> entries.
437 518
438The callback a single argument which is either C<undef> or an array-ref 519The callback a single argument which is either C<undef> or an array-ref
439with the filenames. 520with the filenames.
521
522
523=item aio_load $path, $data, $callback->($status)
524
525This is a composite request that tries to fully load the given file into
526memory. Status is the same as with aio_read.
527
528=cut
529
530sub aio_load($$;$) {
531 aio_block {
532 my ($path, undef, $cb) = @_;
533 my $data = \$_[1];
534
535 my $pri = aioreq_pri;
536 my $grp = aio_group $cb;
537
538 aioreq_pri $pri;
539 add $grp aio_open $path, O_RDONLY, 0, sub {
540 my $fh = shift
541 or return $grp->result (-1);
542
543 aioreq_pri $pri;
544 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545 $grp->result ($_[0]);
546 };
547 };
548
549 $grp
550 }
551}
440 552
441=item aio_copy $srcpath, $dstpath, $callback->($status) 553=item aio_copy $srcpath, $dstpath, $callback->($status)
442 554
443Try to copy the I<file> (directories not supported as either source or 555Try to copy the I<file> (directories not supported as either source or
444destination) from C<$srcpath> to C<$dstpath> and call the callback with 556destination) from C<$srcpath> to C<$dstpath> and call the callback with
… …
454errors are being ignored. 566errors are being ignored.
455 567
456=cut 568=cut
457 569
458sub aio_copy($$;$) { 570sub aio_copy($$;$) {
571 aio_block {
459 my ($src, $dst, $cb) = @_; 572 my ($src, $dst, $cb) = @_;
460 573
461 my $pri = aioreq_pri; 574 my $pri = aioreq_pri;
462 my $grp = aio_group $cb; 575 my $grp = aio_group $cb;
463 576
464 aioreq_pri $pri; 577 aioreq_pri $pri;
465 add $grp aio_open $src, O_RDONLY, 0, sub { 578 add $grp aio_open $src, O_RDONLY, 0, sub {
466 if (my $src_fh = $_[0]) { 579 if (my $src_fh = $_[0]) {
467 my @stat = stat $src_fh; 580 my @stat = stat $src_fh;
468 581
469 aioreq_pri $pri; 582 aioreq_pri $pri;
470 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 583 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
471 if (my $dst_fh = $_[0]) { 584 if (my $dst_fh = $_[0]) {
472 aioreq_pri $pri; 585 aioreq_pri $pri;
473 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 586 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
474 if ($_[0] == $stat[7]) { 587 if ($_[0] == $stat[7]) {
475 $grp->result (0); 588 $grp->result (0);
476 close $src_fh; 589 close $src_fh;
477 590
478 # those should not normally block. should. should. 591 # those should not normally block. should. should.
479 utime $stat[8], $stat[9], $dst; 592 utime $stat[8], $stat[9], $dst;
480 chmod $stat[2] & 07777, $dst_fh; 593 chmod $stat[2] & 07777, $dst_fh;
481 chown $stat[4], $stat[5], $dst_fh; 594 chown $stat[4], $stat[5], $dst_fh;
482 close $dst_fh; 595 close $dst_fh;
483 } else { 596 } else {
484 $grp->result (-1); 597 $grp->result (-1);
485 close $src_fh; 598 close $src_fh;
486 close $dst_fh; 599 close $dst_fh;
487 600
488 aioreq $pri; 601 aioreq $pri;
489 add $grp aio_unlink $dst; 602 add $grp aio_unlink $dst;
603 }
490 } 604 };
605 } else {
606 $grp->result (-1);
491 }; 607 }
492 } else {
493 $grp->result (-1);
494 } 608 },
609
610 } else {
611 $grp->result (-1);
495 }, 612 }
496
497 } else {
498 $grp->result (-1);
499 } 613 };
614
615 $grp
500 }; 616 }
501
502 $grp
503} 617}
504 618
505=item aio_move $srcpath, $dstpath, $callback->($status) 619=item aio_move $srcpath, $dstpath, $callback->($status)
506 620
507Try to move the I<file> (directories not supported as either source or 621Try to move the I<file> (directories not supported as either source or
… …
513that is successful, unlinking the C<$srcpath>. 627that is successful, unlinking the C<$srcpath>.
514 628
515=cut 629=cut
516 630
517sub aio_move($$;$) { 631sub aio_move($$;$) {
632 aio_block {
518 my ($src, $dst, $cb) = @_; 633 my ($src, $dst, $cb) = @_;
519 634
520 my $pri = aioreq_pri; 635 my $pri = aioreq_pri;
521 my $grp = aio_group $cb; 636 my $grp = aio_group $cb;
522 637
523 aioreq_pri $pri; 638 aioreq_pri $pri;
524 add $grp aio_rename $src, $dst, sub { 639 add $grp aio_rename $src, $dst, sub {
525 if ($_[0] && $! == EXDEV) { 640 if ($_[0] && $! == EXDEV) {
526 aioreq_pri $pri; 641 aioreq_pri $pri;
527 add $grp aio_copy $src, $dst, sub { 642 add $grp aio_copy $src, $dst, sub {
643 $grp->result ($_[0]);
644
645 if (!$_[0]) {
646 aioreq_pri $pri;
647 add $grp aio_unlink $src;
648 }
649 };
650 } else {
528 $grp->result ($_[0]); 651 $grp->result ($_[0]);
529
530 if (!$_[0]) {
531 aioreq_pri $pri;
532 add $grp aio_unlink $src;
533 }
534 }; 652 }
535 } else {
536 $grp->result ($_[0]);
537 } 653 };
654
655 $grp
538 }; 656 }
539
540 $grp
541} 657}
542 658
543=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 659=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
544 660
545Scans a directory (similar to C<aio_readdir>) but additionally tries to 661Scans 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 708as those tend to return 0 or 1 as link counts, which disables the
593directory counting heuristic. 709directory counting heuristic.
594 710
595=cut 711=cut
596 712
597sub aio_scandir($$$) { 713sub aio_scandir($$;$) {
714 aio_block {
598 my ($path, $maxreq, $cb) = @_; 715 my ($path, $maxreq, $cb) = @_;
599 716
600 my $pri = aioreq_pri; 717 my $pri = aioreq_pri;
601 718
602 my $grp = aio_group $cb; 719 my $grp = aio_group $cb;
603 720
604 $maxreq = 4 if $maxreq <= 0; 721 $maxreq = 4 if $maxreq <= 0;
605 722
606 # stat once 723 # 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; 724 aioreq_pri $pri;
615 add $grp aio_readdir $path, sub { 725 add $grp aio_stat $path, sub {
616 my $entries = shift
617 or return $grp->result (); 726 return $grp->result () if $_[0];
727 my $now = time;
728 my $hash1 = join ":", (stat _)[0,1,3,7,9];
618 729
619 # stat the dir another time 730 # read the directory entries
620 aioreq_pri $pri; 731 aioreq_pri $pri;
732 add $grp aio_readdir $path, sub {
733 my $entries = shift
734 or return $grp->result ();
735
736 # stat the dir another time
737 aioreq_pri $pri;
621 add $grp aio_stat $path, sub { 738 add $grp aio_stat $path, sub {
622 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 739 my $hash2 = join ":", (stat _)[0,1,3,7,9];
623 740
624 my $ndirs; 741 my $ndirs;
625 742
626 # take the slow route if anything looks fishy 743 # take the slow route if anything looks fishy
627 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 744 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
628 $ndirs = -1; 745 $ndirs = -1;
629 } else { 746 } else {
630 # if nlink == 2, we are finished 747 # if nlink == 2, we are finished
631 # on non-posix-fs's, we rely on nlink < 2 748 # on non-posix-fs's, we rely on nlink < 2
632 $ndirs = (stat _)[3] - 2 749 $ndirs = (stat _)[3] - 2
633 or return $grp->result ([], $entries); 750 or return $grp->result ([], $entries);
634 } 751 }
635 752
636 # sort into likely dirs and likely nondirs 753 # sort into likely dirs and likely nondirs
637 # dirs == files without ".", short entries first 754 # dirs == files without ".", short entries first
638 $entries = [map $_->[0], 755 $entries = [map $_->[0],
639 sort { $b->[1] cmp $a->[1] } 756 sort { $b->[1] cmp $a->[1] }
640 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 757 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
641 @$entries]; 758 @$entries];
642 759
643 my (@dirs, @nondirs); 760 my (@dirs, @nondirs);
644 761
645 my $statgrp = add $grp aio_group sub { 762 my $statgrp = add $grp aio_group sub {
646 $grp->result (\@dirs, \@nondirs); 763 $grp->result (\@dirs, \@nondirs);
647 }; 764 };
648 765
649 limit $statgrp $maxreq; 766 limit $statgrp $maxreq;
650 feed $statgrp sub { 767 feed $statgrp sub {
651 return unless @$entries; 768 return unless @$entries;
652 my $entry = pop @$entries; 769 my $entry = pop @$entries;
653 770
654 aioreq_pri $pri; 771 aioreq_pri $pri;
655 add $statgrp aio_stat "$path/$entry/.", sub { 772 add $statgrp aio_stat "$path/$entry/.", sub {
656 if ($_[0] < 0) { 773 if ($_[0] < 0) {
657 push @nondirs, $entry; 774 push @nondirs, $entry;
658 } else { 775 } else {
659 # need to check for real directory 776 # need to check for real directory
660 aioreq_pri $pri; 777 aioreq_pri $pri;
661 add $statgrp aio_lstat "$path/$entry", sub { 778 add $statgrp aio_lstat "$path/$entry", sub {
662 if (-d _) { 779 if (-d _) {
663 push @dirs, $entry; 780 push @dirs, $entry;
664 781
665 unless (--$ndirs) { 782 unless (--$ndirs) {
666 push @nondirs, @$entries; 783 push @nondirs, @$entries;
667 feed $statgrp; 784 feed $statgrp;
785 }
786 } else {
787 push @nondirs, $entry;
668 } 788 }
669 } else {
670 push @nondirs, $entry;
671 } 789 }
672 } 790 }
673 } 791 };
674 }; 792 };
675 }; 793 };
676 }; 794 };
677 }; 795 };
796
797 $grp
678 }; 798 }
799}
679 800
801=item aio_rmtree $path, $callback->($status)
802
803Delete a directory tree starting (and including) C<$path>, return the
804status of the final C<rmdir> only. This is a composite request that
805uses C<aio_scandir> to recurse into and rmdir directories, and unlink
806everything else.
807
808=cut
809
810sub aio_rmtree;
811sub aio_rmtree($;$) {
812 aio_block {
813 my ($path, $cb) = @_;
814
815 my $pri = aioreq_pri;
816 my $grp = aio_group $cb;
817
818 aioreq_pri $pri;
819 add $grp aio_scandir $path, 0, sub {
820 my ($dirs, $nondirs) = @_;
821
822 my $dirgrp = aio_group sub {
823 add $grp aio_rmdir $path, sub {
824 $grp->result ($_[0]);
825 };
826 };
827
828 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
829 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
830
831 add $grp $dirgrp;
832 };
833
680 $grp 834 $grp
835 }
681} 836}
682 837
683=item aio_fsync $fh, $callback->($status) 838=item aio_fsync $fh, $callback->($status)
684 839
685Asynchronously call fsync on the given filehandle and call the callback 840Asynchronously call fsync on the given filehandle and call the callback
… …
939that are being processed by C<IO::AIO::poll_cb> in one call, respectively 1094that are being processed by C<IO::AIO::poll_cb> in one call, respectively
940the maximum amount of time (default C<0>, meaning infinity) spent in 1095the maximum amount of time (default C<0>, meaning infinity) spent in
941C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount 1096C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
942of time C<poll_cb> is allowed to use). 1097of time C<poll_cb> is allowed to use).
943 1098
1099Setting C<max_poll_time> to a non-zero value creates an overhead of one
1100syscall per request processed, which is not normally a problem unless your
1101callbacks are really really fast or your OS is really really slow (I am
1102not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1103
944Setting these is useful if you want to ensure some level of 1104Setting these is useful if you want to ensure some level of
945interactiveness when perl is not fast enough to process all requests in 1105interactiveness when perl is not fast enough to process all requests in
946time. 1106time.
947 1107
948For interactive programs, values such as C<0.01> to C<0.1> should be fine. 1108For interactive programs, values such as C<0.01> to C<0.1> should be fine.
949 1109
950Example: Install an Event watcher that automatically calls 1110Example: Install an Event watcher that automatically calls
951IO::AIO::poll_some with low priority, to ensure that other parts of the 1111IO::AIO::poll_cb with low priority, to ensure that other parts of the
952program get the CPU sometimes even under high AIO load. 1112program get the CPU sometimes even under high AIO load.
953 1113
954 # try not to spend much more than 0.1s in poll_cb 1114 # try not to spend much more than 0.1s in poll_cb
955 IO::AIO::max_poll_time 0.1; 1115 IO::AIO::max_poll_time 0.1;
956 1116
… …
959 poll => 'r', nice => 1, 1119 poll => 'r', nice => 1,
960 cb => &IO::AIO::poll_cb); 1120 cb => &IO::AIO::poll_cb);
961 1121
962=item IO::AIO::poll_wait 1122=item IO::AIO::poll_wait
963 1123
1124If there are any outstanding requests and none of them in the result
964Wait till the result filehandle becomes ready for reading (simply does a 1125phase, wait till the result filehandle becomes ready for reading (simply
965C<select> on the filehandle. This is useful if you want to synchronously 1126does a C<select> on the filehandle. This is useful if you want to
966wait for some requests to finish). 1127synchronously wait for some requests to finish).
967 1128
968See C<nreqs> for an example. 1129See C<nreqs> for an example.
969 1130
970=item IO::AIO::poll 1131=item IO::AIO::poll
971 1132
972Waits until some requests have been handled. 1133Waits until some requests have been handled.
973 1134
1135Returns the number of requests processed, but is otherwise strictly
974Strictly equivalent to: 1136equivalent to:
975 1137
976 IO::AIO::poll_wait, IO::AIO::poll_cb 1138 IO::AIO::poll_wait, IO::AIO::poll_cb
977 if IO::AIO::nreqs;
978 1139
979=item IO::AIO::flush 1140=item IO::AIO::flush
980 1141
981Wait till all outstanding AIO requests have been handled. 1142Wait till all outstanding AIO requests have been handled.
982 1143
983Strictly equivalent to: 1144Strictly equivalent to:
984 1145
985 IO::AIO::poll_wait, IO::AIO::poll_cb 1146 IO::AIO::poll_wait, IO::AIO::poll_cb
986 while IO::AIO::nreqs; 1147 while IO::AIO::nreqs;
987 1148
1149=back
1150
988=head3 CONTROLLING THE NUMBER OF THREADS 1151=head3 CONTROLLING THE NUMBER OF THREADS
1152
1153=over
989 1154
990=item IO::AIO::min_parallel $nthreads 1155=item IO::AIO::min_parallel $nthreads
991 1156
992Set the minimum number of AIO threads to C<$nthreads>. The current 1157Set the minimum number of AIO threads to C<$nthreads>. The current
993default is C<8>, which means eight asynchronous operations can execute 1158default is C<8>, which means eight asynchronous operations can execute
… …
1052 1217
1053You can still queue as many requests as you want. Therefore, 1218You can still queue as many requests as you want. Therefore,
1054C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1219C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1055as a stop gap to shield against fatal memory overflow (with large values). 1220as a stop gap to shield against fatal memory overflow (with large values).
1056 1221
1222=back
1223
1057=head3 STATISTICAL INFORMATION 1224=head3 STATISTICAL INFORMATION
1225
1226=over
1058 1227
1059=item IO::AIO::nreqs 1228=item IO::AIO::nreqs
1060 1229
1061Returns the number of requests currently in the ready, execute or pending 1230Returns the number of requests currently in the ready, execute or pending
1062states (i.e. for which their callback has not been invoked yet). 1231states (i.e. for which their callback has not been invoked yet).
… …
1096 *$sym 1265 *$sym
1097} 1266}
1098 1267
1099min_parallel 8; 1268min_parallel 8;
1100 1269
1101END { 1270END { flush }
1102 min_parallel 1;
1103 flush;
1104};
1105 1271
11061; 12721;
1107 1273
1108=head2 FORK BEHAVIOUR 1274=head2 FORK BEHAVIOUR
1109 1275

Diff Legend

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