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.93 by root, Wed Nov 8 01:59:58 2006 UTC vs.
Revision 1.117 by root, Sat Oct 6 14:05:19 2007 UTC

5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", O_RDONLY, 0, sub {
10 my ($fh) = @_; 10 my $fh = shift
11 or die "/etc/passwd: $!";
11 ... 12 ...
12 }; 13 };
13 14
14 aio_unlink "/tmp/file", sub { }; 15 aio_unlink "/tmp/file", sub { };
15 16
61etc.), but can also be used to easily do operations in parallel that are 62etc.), but can also be used to easily do operations in parallel that are
62normally done sequentially, e.g. stat'ing many files, which is much faster 63normally done sequentially, e.g. stat'ing many files, which is much faster
63on a RAID volume or over NFS when you do a number of stat operations 64on a RAID volume or over NFS when you do a number of stat operations
64concurrently. 65concurrently.
65 66
66While most of this works on all types of file descriptors (for example 67While most of this works on all types of file descriptors (for
67sockets), using these functions on file descriptors that support 68example sockets), using these functions on file descriptors that
68nonblocking operation (again, sockets, pipes etc.) is very inefficient or 69support nonblocking operation (again, sockets, pipes etc.) is very
69might not work (aio_read fails on sockets/pipes/fifos). Use an event loop 70inefficient. Use an event loop for that (such as the L<Event|Event>
70for that (such as the L<Event|Event> module): IO::AIO will naturally fit 71module): IO::AIO will naturally fit into such an event loop itself.
71into such an event loop itself.
72 72
73In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
74requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
75in perl, and the threads created by this module will not be visible 75in perl, and the threads created by this module will not be visible
76to perl. In the future, this module might make use of the native aio 76to perl. In the future, this module might make use of the native aio
78not well-supported or restricted (GNU/Linux doesn't allow them on normal 78not well-supported or restricted (GNU/Linux doesn't allow them on normal
79files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
80aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
81using threads anyway. 81using threads anyway.
82 82
83Although the module will work with in the presence of other (Perl-) 83Although the module will work in the presence of other (Perl-) threads,
84threads, it is currently not reentrant in any way, so use appropriate 84it is currently not reentrant in any way, so use appropriate locking
85locking yourself, always call C<poll_cb> from within the same thread, or 85yourself, always call C<poll_cb> from within the same thread, or never
86never call C<poll_cb> (or other C<aio_> functions) recursively. 86call C<poll_cb> (or other C<aio_> functions) recursively.
87 87
88=head2 EXAMPLE 88=head2 EXAMPLE
89 89
90This is a simple example that uses the Event module and loads 90This is a simple example that uses the Event module and loads
91F</etc/passwd> asynchronously: 91F</etc/passwd> asynchronously:
99 poll => 'r', 99 poll => 'r',
100 cb => \&IO::AIO::poll_cb); 100 cb => \&IO::AIO::poll_cb);
101 101
102 # queue the request to open /etc/passwd 102 # queue the request to open /etc/passwd
103 aio_open "/etc/passwd", O_RDONLY, 0, sub { 103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
104 my $fh = $_[0] 104 my $fh = shift
105 or die "error while opening: $!"; 105 or die "error while opening: $!";
106 106
107 # stat'ing filehandles is generally non-blocking 107 # stat'ing filehandles is generally non-blocking
108 my $size = -s $fh; 108 my $size = -s $fh;
109 109
183 183
184=cut 184=cut
185 185
186package IO::AIO; 186package IO::AIO;
187 187
188use Carp ();
189
188no warnings; 190no warnings;
189use strict 'vars'; 191use strict 'vars';
190 192
191use base 'Exporter'; 193use base 'Exporter';
192 194
193BEGIN { 195BEGIN {
194 our $VERSION = '2.2'; 196 our $VERSION = '2.51';
195 197
196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 199 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 200 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
199 aio_move aio_copy aio_group aio_nop aio_mknod); 201 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
202 aio_chown aio_chmod aio_utime aio_truncate);
200 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 203 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
201 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 204 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
202 min_parallel max_parallel max_idle 205 min_parallel max_parallel max_idle
203 nreqs nready npending nthreads 206 nreqs nready npending nthreads
204 max_poll_time max_poll_reqs); 207 max_poll_time max_poll_reqs);
205 208
270 aio_read $_[0], ..., sub { 273 aio_read $_[0], ..., sub {
271 ... 274 ...
272 }; 275 };
273 }; 276 };
274 277
278
275=item aioreq_nice $pri_adjust 279=item aioreq_nice $pri_adjust
276 280
277Similar to C<aioreq_pri>, but subtracts the given value from the current 281Similar to C<aioreq_pri>, but subtracts the given value from the current
278priority, so the effect is cumulative. 282priority, so the effect is cumulative.
283
279 284
280=item aio_open $pathname, $flags, $mode, $callback->($fh) 285=item aio_open $pathname, $flags, $mode, $callback->($fh)
281 286
282Asynchronously open or create a file and call the callback with a newly 287Asynchronously open or create a file and call the callback with a newly
283created filehandle for the file. 288created filehandle for the file.
289list. They are the same as used by C<sysopen>. 294list. They are the same as used by C<sysopen>.
290 295
291Likewise, C<$mode> specifies the mode of the newly created file, if it 296Likewise, C<$mode> specifies the mode of the newly created file, if it
292didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 297didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
293except that it is mandatory (i.e. use C<0> if you don't create new files, 298except that it is mandatory (i.e. use C<0> if you don't create new files,
294and C<0666> or C<0777> if you do). 299and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
300by the umask in effect then the request is being executed, so better never
301change the umask.
295 302
296Example: 303Example:
297 304
298 aio_open "/etc/passwd", O_RDONLY, 0, sub { 305 aio_open "/etc/passwd", O_RDONLY, 0, sub {
299 if ($_[0]) { 306 if ($_[0]) {
302 } else { 309 } else {
303 die "open failed: $!\n"; 310 die "open failed: $!\n";
304 } 311 }
305 }; 312 };
306 313
314
307=item aio_close $fh, $callback->($status) 315=item aio_close $fh, $callback->($status)
308 316
309Asynchronously close a file and call the callback with the result 317Asynchronously close a file and call the callback with the result
310code. I<WARNING:> although accepted, you should not pass in a perl 318code.
311filehandle here, as perl will likely close the file descriptor another
312time when the filehandle is destroyed. Normally, you can safely call perls
313C<close> or just let filehandles go out of scope.
314 319
315This is supposed to be a bug in the API, so that might change. It's 320Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
316therefore best to avoid this function. 321closing the file descriptor associated with the filehandle itself. Here is
322what aio_close will try:
323
324 1. dup()licate the fd
325 2. asynchronously close() the duplicated fd
326 3. dup()licate the fd once more
327 4. let perl close() the filehandle
328 5. asynchronously close the duplicated fd
329
330The idea is that the first close() flushes stuff to disk that closing an
331fd will flush, so when perl closes the fd, nothing much will need to be
332flushed. The second async. close() will then flush stuff to disk that
333closing the last fd to the file will flush.
334
335Just FYI, SuSv3 has this to say on close:
336
337 All outstanding record locks owned by the process on the file
338 associated with the file descriptor shall be removed.
339
340 If fildes refers to a socket, close() shall cause the socket to be
341 destroyed. ... close() shall block for up to the current linger
342 interval until all data is transmitted.
343 [this actually sounds like a specification bug, but who knows]
344
345And at least Linux additionally actually flushes stuff on every close,
346even when the file itself is still open.
347
348Sounds enourmously inefficient and complicated? Yes... please show me how
349to nuke perl's fd out of existence...
350
351=cut
352
353sub aio_close($;$) {
354 aio_block {
355 my ($fh, $cb) = @_;
356
357 my $pri = aioreq_pri;
358 my $grp = aio_group $cb;
359
360 my $fd = fileno $fh;
361
362 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
363
364 # if the dups fail we will simply get EBADF
365 my $fd2 = _dup $fd;
366 aioreq_pri $pri;
367 add $grp _aio_close $fd2, sub {
368 my $fd2 = _dup $fd;
369 close $fh;
370 aioreq_pri $pri;
371 add $grp _aio_close $fd2, sub {
372 $grp->result ($_[0]);
373 };
374 };
375
376 $grp
377 }
378}
379
317 380
318=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 381=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
319 382
320=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 383=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
321 384
322Reads or writes C<length> bytes from the specified C<fh> and C<offset> 385Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
323into the scalar given by C<data> and offset C<dataoffset> and calls the 386into the scalar given by C<$data> and offset C<$dataoffset> and calls the
324callback without the actual number of bytes read (or -1 on error, just 387callback without the actual number of bytes read (or -1 on error, just
325like the syscall). 388like the syscall).
326 389
390If C<$offset> is undefined, then the current file descriptor offset will
391be used (and updated), otherwise the file descriptor offset will not be
392changed by these calls.
393
394If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
395
396If C<$dataoffset> is less than zero, it will be counted from the end of
397C<$data>.
398
327The C<$data> scalar I<MUST NOT> be modified in any way while the request 399The C<$data> scalar I<MUST NOT> be modified in any way while the request
328is outstanding. Modifying it can result in segfaults or WW3 (if the 400is outstanding. Modifying it can result in segfaults or World War III (if
329necessary/optional hardware is installed). 401the necessary/optional hardware is installed).
330 402
331Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 403Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
332offset C<0> within the scalar: 404offset C<0> within the scalar:
333 405
334 aio_read $fh, 7, 15, $buffer, 0, sub { 406 aio_read $fh, 7, 15, $buffer, 0, sub {
335 $_[0] > 0 or die "read error: $!"; 407 $_[0] > 0 or die "read error: $!";
336 print "read $_[0] bytes: <$buffer>\n"; 408 print "read $_[0] bytes: <$buffer>\n";
337 }; 409 };
410
338 411
339=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 412=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
340 413
341Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 414Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
342reading at byte offset C<$in_offset>, and starts writing at the current 415reading at byte offset C<$in_offset>, and starts writing at the current
356C<$in_fh> than are written, and there is no way to find out how many 429C<$in_fh> than are written, and there is no way to find out how many
357bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 430bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
358provides the number of bytes written to C<$out_fh>. Only if the result 431provides the number of bytes written to C<$out_fh>. Only if the result
359value equals C<$length> one can assume that C<$length> bytes have been 432value equals C<$length> one can assume that C<$length> bytes have been
360read. 433read.
434
361 435
362=item aio_readahead $fh,$offset,$length, $callback->($retval) 436=item aio_readahead $fh,$offset,$length, $callback->($retval)
363 437
364C<aio_readahead> populates the page cache with data from a file so that 438C<aio_readahead> populates the page cache with data from a file so that
365subsequent reads from that file will not block on disk I/O. The C<$offset> 439subsequent reads from that file will not block on disk I/O. The C<$offset>
371file. The current file offset of the file is left unchanged. 445file. The current file offset of the file is left unchanged.
372 446
373If that syscall doesn't exist (likely if your OS isn't Linux) it will be 447If that syscall doesn't exist (likely if your OS isn't Linux) it will be
374emulated by simply reading the data, which would have a similar effect. 448emulated by simply reading the data, which would have a similar effect.
375 449
450
376=item aio_stat $fh_or_path, $callback->($status) 451=item aio_stat $fh_or_path, $callback->($status)
377 452
378=item aio_lstat $fh, $callback->($status) 453=item aio_lstat $fh, $callback->($status)
379 454
380Works like perl's C<stat> or C<lstat> in void context. The callback will 455Works like perl's C<stat> or C<lstat> in void context. The callback will
393 aio_stat "/etc/passwd", sub { 468 aio_stat "/etc/passwd", sub {
394 $_[0] and die "stat failed: $!"; 469 $_[0] and die "stat failed: $!";
395 print "size is ", -s _, "\n"; 470 print "size is ", -s _, "\n";
396 }; 471 };
397 472
473
474=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
475
476Works like perl's C<utime> function (including the special case of $atime
477and $mtime being undef). Fractional times are supported if the underlying
478syscalls support them.
479
480When called with a pathname, uses utimes(2) if available, otherwise
481utime(2). If called on a file descriptor, uses futimes(2) if available,
482otherwise returns ENOSYS, so this is not portable.
483
484Examples:
485
486 # set atime and mtime to current time (basically touch(1)):
487 aio_utime "path", undef, undef;
488 # set atime to current time and mtime to beginning of the epoch:
489 aio_utime "path", time, undef; # undef==0
490
491
492=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
493
494Works like perl's C<chown> function, except that C<undef> for either $uid
495or $gid is being interpreted as "do not change" (but -1 can also be used).
496
497Examples:
498
499 # same as "chown root path" in the shell:
500 aio_chown "path", 0, -1;
501 # same as above:
502 aio_chown "path", 0, undef;
503
504
505=item aio_truncate $fh_or_path, $offset, $callback->($status)
506
507Works like truncate(2) or ftruncate(2).
508
509
510=item aio_chmod $fh_or_path, $mode, $callback->($status)
511
512Works like perl's C<chmod> function.
513
514
398=item aio_unlink $pathname, $callback->($status) 515=item aio_unlink $pathname, $callback->($status)
399 516
400Asynchronously unlink (delete) a file and call the callback with the 517Asynchronously unlink (delete) a file and call the callback with the
401result code. 518result code.
402 519
520
403=item aio_mknod $path, $mode, $dev, $callback->($status) 521=item aio_mknod $path, $mode, $dev, $callback->($status)
404 522
405[EXPERIMENTAL] 523[EXPERIMENTAL]
406 524
407Asynchronously create a device node (or fifo). See mknod(2). 525Asynchronously create a device node (or fifo). See mknod(2).
408 526
409The only (POSIX-) portable way of calling this function is: 527The only (POSIX-) portable way of calling this function is:
410 528
411 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 529 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
530
412 531
413=item aio_link $srcpath, $dstpath, $callback->($status) 532=item aio_link $srcpath, $dstpath, $callback->($status)
414 533
415Asynchronously create a new link to the existing object at C<$srcpath> at 534Asynchronously create a new link to the existing object at C<$srcpath> at
416the path C<$dstpath> and call the callback with the result code. 535the path C<$dstpath> and call the callback with the result code.
417 536
537
418=item aio_symlink $srcpath, $dstpath, $callback->($status) 538=item aio_symlink $srcpath, $dstpath, $callback->($status)
419 539
420Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 540Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
421the path C<$dstpath> and call the callback with the result code. 541the path C<$dstpath> and call the callback with the result code.
542
422 543
423=item aio_readlink $path, $callback->($link) 544=item aio_readlink $path, $callback->($link)
424 545
425Asynchronously read the symlink specified by C<$path> and pass it to 546Asynchronously read the symlink specified by C<$path> and pass it to
426the callback. If an error occurs, nothing or undef gets passed to the 547the callback. If an error occurs, nothing or undef gets passed to the
427callback. 548callback.
428 549
550
429=item aio_rename $srcpath, $dstpath, $callback->($status) 551=item aio_rename $srcpath, $dstpath, $callback->($status)
430 552
431Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 553Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
432rename(2) and call the callback with the result code. 554rename(2) and call the callback with the result code.
433 555
556
557=item aio_mkdir $pathname, $mode, $callback->($status)
558
559Asynchronously mkdir (create) a directory and call the callback with
560the result code. C<$mode> will be modified by the umask at the time the
561request is executed, so do not change your umask.
562
563
434=item aio_rmdir $pathname, $callback->($status) 564=item aio_rmdir $pathname, $callback->($status)
435 565
436Asynchronously rmdir (delete) a directory and call the callback with the 566Asynchronously rmdir (delete) a directory and call the callback with the
437result code. 567result code.
568
438 569
439=item aio_readdir $pathname, $callback->($entries) 570=item aio_readdir $pathname, $callback->($entries)
440 571
441Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 572Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
442directory (i.e. opendir + readdir + closedir). The entries will not be 573directory (i.e. opendir + readdir + closedir). The entries will not be
443sorted, and will B<NOT> include the C<.> and C<..> entries. 574sorted, and will B<NOT> include the C<.> and C<..> entries.
444 575
445The callback a single argument which is either C<undef> or an array-ref 576The callback a single argument which is either C<undef> or an array-ref
446with the filenames. 577with the filenames.
578
579
580=item aio_load $path, $data, $callback->($status)
581
582This is a composite request that tries to fully load the given file into
583memory. Status is the same as with aio_read.
584
585=cut
586
587sub aio_load($$;$) {
588 aio_block {
589 my ($path, undef, $cb) = @_;
590 my $data = \$_[1];
591
592 my $pri = aioreq_pri;
593 my $grp = aio_group $cb;
594
595 aioreq_pri $pri;
596 add $grp aio_open $path, O_RDONLY, 0, sub {
597 my $fh = shift
598 or return $grp->result (-1);
599
600 aioreq_pri $pri;
601 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
602 $grp->result ($_[0]);
603 };
604 };
605
606 $grp
607 }
608}
447 609
448=item aio_copy $srcpath, $dstpath, $callback->($status) 610=item aio_copy $srcpath, $dstpath, $callback->($status)
449 611
450Try to copy the I<file> (directories not supported as either source or 612Try to copy the I<file> (directories not supported as either source or
451destination) from C<$srcpath> to C<$dstpath> and call the callback with 613destination) from C<$srcpath> to C<$dstpath> and call the callback with
461errors are being ignored. 623errors are being ignored.
462 624
463=cut 625=cut
464 626
465sub aio_copy($$;$) { 627sub aio_copy($$;$) {
628 aio_block {
466 my ($src, $dst, $cb) = @_; 629 my ($src, $dst, $cb) = @_;
467 630
468 my $pri = aioreq_pri; 631 my $pri = aioreq_pri;
469 my $grp = aio_group $cb; 632 my $grp = aio_group $cb;
470 633
471 aioreq_pri $pri; 634 aioreq_pri $pri;
472 add $grp aio_open $src, O_RDONLY, 0, sub { 635 add $grp aio_open $src, O_RDONLY, 0, sub {
473 if (my $src_fh = $_[0]) { 636 if (my $src_fh = $_[0]) {
474 my @stat = stat $src_fh; 637 my @stat = stat $src_fh;
475 638
476 aioreq_pri $pri; 639 aioreq_pri $pri;
477 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 640 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
478 if (my $dst_fh = $_[0]) { 641 if (my $dst_fh = $_[0]) {
479 aioreq_pri $pri; 642 aioreq_pri $pri;
480 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 643 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
481 if ($_[0] == $stat[7]) { 644 if ($_[0] == $stat[7]) {
482 $grp->result (0); 645 $grp->result (0);
483 close $src_fh; 646 close $src_fh;
484 647
485 # those should not normally block. should. should. 648 # those should not normally block. should. should.
486 utime $stat[8], $stat[9], $dst; 649 utime $stat[8], $stat[9], $dst;
487 chmod $stat[2] & 07777, $dst_fh; 650 chmod $stat[2] & 07777, $dst_fh;
488 chown $stat[4], $stat[5], $dst_fh; 651 chown $stat[4], $stat[5], $dst_fh;
489 close $dst_fh; 652 close $dst_fh;
490 } else { 653 } else {
491 $grp->result (-1); 654 $grp->result (-1);
492 close $src_fh; 655 close $src_fh;
493 close $dst_fh; 656 close $dst_fh;
494 657
495 aioreq $pri; 658 aioreq $pri;
496 add $grp aio_unlink $dst; 659 add $grp aio_unlink $dst;
660 }
497 } 661 };
662 } else {
663 $grp->result (-1);
498 }; 664 }
499 } else {
500 $grp->result (-1);
501 } 665 },
666
667 } else {
668 $grp->result (-1);
502 }, 669 }
503
504 } else {
505 $grp->result (-1);
506 } 670 };
671
672 $grp
507 }; 673 }
508
509 $grp
510} 674}
511 675
512=item aio_move $srcpath, $dstpath, $callback->($status) 676=item aio_move $srcpath, $dstpath, $callback->($status)
513 677
514Try to move the I<file> (directories not supported as either source or 678Try to move the I<file> (directories not supported as either source or
520that is successful, unlinking the C<$srcpath>. 684that is successful, unlinking the C<$srcpath>.
521 685
522=cut 686=cut
523 687
524sub aio_move($$;$) { 688sub aio_move($$;$) {
689 aio_block {
525 my ($src, $dst, $cb) = @_; 690 my ($src, $dst, $cb) = @_;
526 691
527 my $pri = aioreq_pri; 692 my $pri = aioreq_pri;
528 my $grp = aio_group $cb; 693 my $grp = aio_group $cb;
529 694
530 aioreq_pri $pri; 695 aioreq_pri $pri;
531 add $grp aio_rename $src, $dst, sub { 696 add $grp aio_rename $src, $dst, sub {
532 if ($_[0] && $! == EXDEV) { 697 if ($_[0] && $! == EXDEV) {
533 aioreq_pri $pri; 698 aioreq_pri $pri;
534 add $grp aio_copy $src, $dst, sub { 699 add $grp aio_copy $src, $dst, sub {
700 $grp->result ($_[0]);
701
702 if (!$_[0]) {
703 aioreq_pri $pri;
704 add $grp aio_unlink $src;
705 }
706 };
707 } else {
535 $grp->result ($_[0]); 708 $grp->result ($_[0]);
536
537 if (!$_[0]) {
538 aioreq_pri $pri;
539 add $grp aio_unlink $src;
540 }
541 }; 709 }
542 } else {
543 $grp->result ($_[0]);
544 } 710 };
711
712 $grp
545 }; 713 }
546
547 $grp
548} 714}
549 715
550=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 716=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
551 717
552Scans a directory (similar to C<aio_readdir>) but additionally tries to 718Scans a directory (similar to C<aio_readdir>) but additionally tries to
599as those tend to return 0 or 1 as link counts, which disables the 765as those tend to return 0 or 1 as link counts, which disables the
600directory counting heuristic. 766directory counting heuristic.
601 767
602=cut 768=cut
603 769
604sub aio_scandir($$$) { 770sub aio_scandir($$;$) {
771 aio_block {
605 my ($path, $maxreq, $cb) = @_; 772 my ($path, $maxreq, $cb) = @_;
606 773
607 my $pri = aioreq_pri; 774 my $pri = aioreq_pri;
608 775
609 my $grp = aio_group $cb; 776 my $grp = aio_group $cb;
610 777
611 $maxreq = 4 if $maxreq <= 0; 778 $maxreq = 4 if $maxreq <= 0;
612 779
613 # stat once 780 # stat once
614 aioreq_pri $pri;
615 add $grp aio_stat $path, sub {
616 return $grp->result () if $_[0];
617 my $now = time;
618 my $hash1 = join ":", (stat _)[0,1,3,7,9];
619
620 # read the directory entries
621 aioreq_pri $pri; 781 aioreq_pri $pri;
622 add $grp aio_readdir $path, sub { 782 add $grp aio_stat $path, sub {
623 my $entries = shift
624 or return $grp->result (); 783 return $grp->result () if $_[0];
784 my $now = time;
785 my $hash1 = join ":", (stat _)[0,1,3,7,9];
625 786
626 # stat the dir another time 787 # read the directory entries
627 aioreq_pri $pri; 788 aioreq_pri $pri;
789 add $grp aio_readdir $path, sub {
790 my $entries = shift
791 or return $grp->result ();
792
793 # stat the dir another time
794 aioreq_pri $pri;
628 add $grp aio_stat $path, sub { 795 add $grp aio_stat $path, sub {
629 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 796 my $hash2 = join ":", (stat _)[0,1,3,7,9];
630 797
631 my $ndirs; 798 my $ndirs;
632 799
633 # take the slow route if anything looks fishy 800 # take the slow route if anything looks fishy
634 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 801 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
635 $ndirs = -1; 802 $ndirs = -1;
636 } else { 803 } else {
637 # if nlink == 2, we are finished 804 # if nlink == 2, we are finished
638 # on non-posix-fs's, we rely on nlink < 2 805 # on non-posix-fs's, we rely on nlink < 2
639 $ndirs = (stat _)[3] - 2 806 $ndirs = (stat _)[3] - 2
640 or return $grp->result ([], $entries); 807 or return $grp->result ([], $entries);
641 } 808 }
642 809
643 # sort into likely dirs and likely nondirs 810 # sort into likely dirs and likely nondirs
644 # dirs == files without ".", short entries first 811 # dirs == files without ".", short entries first
645 $entries = [map $_->[0], 812 $entries = [map $_->[0],
646 sort { $b->[1] cmp $a->[1] } 813 sort { $b->[1] cmp $a->[1] }
647 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 814 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
648 @$entries]; 815 @$entries];
649 816
650 my (@dirs, @nondirs); 817 my (@dirs, @nondirs);
651 818
652 my $statgrp = add $grp aio_group sub { 819 my $statgrp = add $grp aio_group sub {
653 $grp->result (\@dirs, \@nondirs); 820 $grp->result (\@dirs, \@nondirs);
654 }; 821 };
655 822
656 limit $statgrp $maxreq; 823 limit $statgrp $maxreq;
657 feed $statgrp sub { 824 feed $statgrp sub {
658 return unless @$entries; 825 return unless @$entries;
659 my $entry = pop @$entries; 826 my $entry = pop @$entries;
660 827
661 aioreq_pri $pri; 828 aioreq_pri $pri;
662 add $statgrp aio_stat "$path/$entry/.", sub { 829 add $statgrp aio_stat "$path/$entry/.", sub {
663 if ($_[0] < 0) { 830 if ($_[0] < 0) {
664 push @nondirs, $entry; 831 push @nondirs, $entry;
665 } else { 832 } else {
666 # need to check for real directory 833 # need to check for real directory
667 aioreq_pri $pri; 834 aioreq_pri $pri;
668 add $statgrp aio_lstat "$path/$entry", sub { 835 add $statgrp aio_lstat "$path/$entry", sub {
669 if (-d _) { 836 if (-d _) {
670 push @dirs, $entry; 837 push @dirs, $entry;
671 838
672 unless (--$ndirs) { 839 unless (--$ndirs) {
673 push @nondirs, @$entries; 840 push @nondirs, @$entries;
674 feed $statgrp; 841 feed $statgrp;
842 }
843 } else {
844 push @nondirs, $entry;
675 } 845 }
676 } else {
677 push @nondirs, $entry;
678 } 846 }
679 } 847 }
680 } 848 };
681 }; 849 };
682 }; 850 };
683 }; 851 };
684 }; 852 };
853
854 $grp
685 }; 855 }
856}
686 857
858=item aio_rmtree $path, $callback->($status)
859
860Delete a directory tree starting (and including) C<$path>, return the
861status of the final C<rmdir> only. This is a composite request that
862uses C<aio_scandir> to recurse into and rmdir directories, and unlink
863everything else.
864
865=cut
866
867sub aio_rmtree;
868sub aio_rmtree($;$) {
869 aio_block {
870 my ($path, $cb) = @_;
871
872 my $pri = aioreq_pri;
873 my $grp = aio_group $cb;
874
875 aioreq_pri $pri;
876 add $grp aio_scandir $path, 0, sub {
877 my ($dirs, $nondirs) = @_;
878
879 my $dirgrp = aio_group sub {
880 add $grp aio_rmdir $path, sub {
881 $grp->result ($_[0]);
882 };
883 };
884
885 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
886 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
887
888 add $grp $dirgrp;
889 };
890
687 $grp 891 $grp
892 }
688} 893}
689 894
690=item aio_fsync $fh, $callback->($status) 895=item aio_fsync $fh, $callback->($status)
691 896
692Asynchronously call fsync on the given filehandle and call the callback 897Asynchronously call fsync on the given filehandle and call the callback
996Strictly equivalent to: 1201Strictly equivalent to:
997 1202
998 IO::AIO::poll_wait, IO::AIO::poll_cb 1203 IO::AIO::poll_wait, IO::AIO::poll_cb
999 while IO::AIO::nreqs; 1204 while IO::AIO::nreqs;
1000 1205
1206=back
1207
1001=head3 CONTROLLING THE NUMBER OF THREADS 1208=head3 CONTROLLING THE NUMBER OF THREADS
1209
1210=over
1002 1211
1003=item IO::AIO::min_parallel $nthreads 1212=item IO::AIO::min_parallel $nthreads
1004 1213
1005Set the minimum number of AIO threads to C<$nthreads>. The current 1214Set the minimum number of AIO threads to C<$nthreads>. The current
1006default is C<8>, which means eight asynchronous operations can execute 1215default is C<8>, which means eight asynchronous operations can execute
1054This is a very bad function to use in interactive programs because it 1263This is a very bad function to use in interactive programs because it
1055blocks, and a bad way to reduce concurrency because it is inexact: Better 1264blocks, and a bad way to reduce concurrency because it is inexact: Better
1056use an C<aio_group> together with a feed callback. 1265use an C<aio_group> together with a feed callback.
1057 1266
1058Sets the maximum number of outstanding requests to C<$nreqs>. If you 1267Sets the maximum number of outstanding requests to C<$nreqs>. If you
1059to queue up more than this number of requests, the next call to the 1268do queue up more than this number of requests, the next call to the
1060C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1269C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1061function will block until the limit is no longer exceeded. 1270function will block until the limit is no longer exceeded.
1062 1271
1063The default value is very large, so there is no practical limit on the 1272The default value is very large, so there is no practical limit on the
1064number of outstanding requests. 1273number of outstanding requests.
1065 1274
1066You can still queue as many requests as you want. Therefore, 1275You can still queue as many requests as you want. Therefore,
1067C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1276C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1068as a stop gap to shield against fatal memory overflow (with large values). 1277as a stop gap to shield against fatal memory overflow (with large values).
1069 1278
1279=back
1280
1070=head3 STATISTICAL INFORMATION 1281=head3 STATISTICAL INFORMATION
1282
1283=over
1071 1284
1072=item IO::AIO::nreqs 1285=item IO::AIO::nreqs
1073 1286
1074Returns the number of requests currently in the ready, execute or pending 1287Returns the number of requests currently in the ready, execute or pending
1075states (i.e. for which their callback has not been invoked yet). 1288states (i.e. for which their callback has not been invoked yet).
1091 1304
1092=back 1305=back
1093 1306
1094=cut 1307=cut
1095 1308
1096# support function to convert a fd into a perl filehandle
1097sub _fd2fh {
1098 return undef if $_[0] < 0;
1099
1100 # try to generate nice filehandles
1101 my $sym = "IO::AIO::fd#$_[0]";
1102 local *$sym;
1103
1104 open *$sym, "+<&=$_[0]" # usually works under any unix
1105 or open *$sym, "<&=$_[0]" # cygwin needs this
1106 or open *$sym, ">&=$_[0]" # or this
1107 or return undef;
1108
1109 *$sym
1110}
1111
1112min_parallel 8; 1309min_parallel 8;
1113 1310
1114END { 1311END { flush }
1115 min_parallel 1;
1116 flush;
1117};
1118 1312
11191; 13131;
1120 1314
1121=head2 FORK BEHAVIOUR 1315=head2 FORK BEHAVIOUR
1122 1316
1142bytes of memory. In addition, stat requests need a stat buffer (possibly 1336bytes of memory. In addition, stat requests need a stat buffer (possibly
1143a few hundred bytes), readdir requires a result buffer and so on. Perl 1337a few hundred bytes), readdir requires a result buffer and so on. Perl
1144scalars and other data passed into aio requests will also be locked and 1338scalars and other data passed into aio requests will also be locked and
1145will consume memory till the request has entered the done state. 1339will consume memory till the request has entered the done state.
1146 1340
1147This is now awfully much, so queuing lots of requests is not usually a 1341This is not awfully much, so queuing lots of requests is not usually a
1148problem. 1342problem.
1149 1343
1150Per-thread usage: 1344Per-thread usage:
1151 1345
1152In the execution phase, some aio requests require more memory for 1346In the execution phase, some aio requests require more memory for

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines