ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines