… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | use AnyEvent::AIO; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
33 | |
35 | # EV integration |
34 | # EV integration |
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
37 | |
36 | |
38 | # Event integration |
37 | # Event integration |
… | |
… | |
194 | use strict 'vars'; |
193 | use strict 'vars'; |
195 | |
194 | |
196 | use base 'Exporter'; |
195 | use base 'Exporter'; |
197 | |
196 | |
198 | BEGIN { |
197 | BEGIN { |
199 | our $VERSION = '2.6'; |
198 | our $VERSION = '3.19'; |
200 | |
199 | |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
204 | aio_fdatasync aio_pathsync aio_readahead |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
205 | aio_rename aio_link aio_move aio_copy aio_group |
204 | aio_rename aio_link aio_move aio_copy aio_group |
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
207 | aio_chmod aio_utime aio_truncate); |
206 | aio_chmod aio_utime aio_truncate); |
208 | |
207 | |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
211 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
212 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
213 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
214 | |
215 | |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | |
217 | |
217 | require XSLoader; |
218 | require XSLoader; |
218 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
225 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | and they all accept an additional (and optional) C<$callback> argument |
228 | and they all accept an additional (and optional) C<$callback> argument |
228 | which must be a code reference. This code reference will get called with |
229 | which must be a code reference. This code reference will get called with |
229 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | perl, which usually delivers "false") as it's sole argument when the given |
231 | perl, which usually delivers "false") as its sole argument after the given |
231 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
232 | |
233 | |
233 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
234 | internally until the request has finished. |
235 | internally until the request has finished. |
235 | |
236 | |
… | |
… | |
249 | your pathnames to the locale (or other) encoding in effect in the user |
250 | your pathnames to the locale (or other) encoding in effect in the user |
250 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
252 | |
253 | |
253 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
255 | |
256 | |
256 | =over 4 |
257 | =over 4 |
257 | |
258 | |
258 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
259 | |
260 | |
… | |
… | |
322 | |
323 | |
323 | Asynchronously close a file and call the callback with the result |
324 | Asynchronously close a file and call the callback with the result |
324 | code. |
325 | code. |
325 | |
326 | |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
327 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
327 | closing the file descriptor associated with the filehandle itself. Here is |
328 | closing the file descriptor associated with the filehandle itself. |
328 | what aio_close will try: |
|
|
329 | |
329 | |
330 | 1. dup()licate the fd |
330 | Therefore, C<aio_close> will not close the filehandle - instead it will |
331 | 2. asynchronously close() the duplicated fd |
331 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
332 | 3. dup()licate the fd once more |
332 | (the pipe fd will be created on demand and will be cached). |
333 | 4. let perl close() the filehandle |
|
|
334 | 5. asynchronously close the duplicated fd |
|
|
335 | |
333 | |
336 | The idea is that the first close() flushes stuff to disk that closing an |
334 | Or in other words: the file descriptor will be closed, but it will not be |
337 | fd will flush, so when perl closes the fd, nothing much will need to be |
335 | free for reuse until the perl filehandle is closed. |
338 | flushed. The second async. close() will then flush stuff to disk that |
|
|
339 | closing the last fd to the file will flush. |
|
|
340 | |
|
|
341 | Just FYI, SuSv3 has this to say on close: |
|
|
342 | |
|
|
343 | All outstanding record locks owned by the process on the file |
|
|
344 | associated with the file descriptor shall be removed. |
|
|
345 | |
|
|
346 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
347 | destroyed. ... close() shall block for up to the current linger |
|
|
348 | interval until all data is transmitted. |
|
|
349 | [this actually sounds like a specification bug, but who knows] |
|
|
350 | |
|
|
351 | And at least Linux additionally actually flushes stuff on every close, |
|
|
352 | even when the file itself is still open. |
|
|
353 | |
|
|
354 | Sounds enourmously inefficient and complicated? Yes... please show me how |
|
|
355 | to nuke perl's fd out of existence... |
|
|
356 | |
336 | |
357 | =cut |
337 | =cut |
358 | |
338 | |
359 | sub aio_close($;$) { |
|
|
360 | aio_block { |
|
|
361 | my ($fh, $cb) = @_; |
|
|
362 | |
|
|
363 | my $pri = aioreq_pri; |
|
|
364 | my $grp = aio_group $cb; |
|
|
365 | |
|
|
366 | my $fd = fileno $fh; |
|
|
367 | |
|
|
368 | defined $fd or Carp::croak "aio_close called with fd-less filehandle"; |
|
|
369 | |
|
|
370 | # if the dups fail we will simply get EBADF |
|
|
371 | my $fd2 = _dup $fd; |
|
|
372 | aioreq_pri $pri; |
|
|
373 | add $grp _aio_close $fd2, sub { |
|
|
374 | my $fd2 = _dup $fd; |
|
|
375 | close $fh; |
|
|
376 | aioreq_pri $pri; |
|
|
377 | add $grp _aio_close $fd2, sub { |
|
|
378 | $grp->result ($_[0]); |
|
|
379 | }; |
|
|
380 | }; |
|
|
381 | |
|
|
382 | $grp |
|
|
383 | } |
|
|
384 | } |
|
|
385 | |
|
|
386 | |
|
|
387 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
388 | |
340 | |
389 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
390 | |
342 | |
391 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
392 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
393 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
394 | like the syscall). |
346 | error, just like the syscall). |
|
|
347 | |
|
|
348 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
349 | offset plus the actual number of bytes read. |
395 | |
350 | |
396 | If C<$offset> is undefined, then the current file descriptor offset will |
351 | If C<$offset> is undefined, then the current file descriptor offset will |
397 | be used (and updated), otherwise the file descriptor offset will not be |
352 | be used (and updated), otherwise the file descriptor offset will not be |
398 | changed by these calls. |
353 | changed by these calls. |
399 | |
354 | |
400 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
401 | |
357 | |
402 | If C<$dataoffset> is less than zero, it will be counted from the end of |
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
403 | C<$data>. |
359 | C<$data>. |
404 | |
360 | |
405 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
361 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
… | |
… | |
577 | |
533 | |
578 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
534 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
579 | directory (i.e. opendir + readdir + closedir). The entries will not be |
535 | directory (i.e. opendir + readdir + closedir). The entries will not be |
580 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
536 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
581 | |
537 | |
582 | The callback a single argument which is either C<undef> or an array-ref |
538 | The callback is passed a single argument which is either C<undef> or an |
583 | with the filenames. |
539 | array-ref with the filenames. |
|
|
540 | |
|
|
541 | |
|
|
542 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
543 | |
|
|
544 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
|
|
545 | behaviour and output format. In case of an error, C<$entries> will be |
|
|
546 | C<undef>. |
|
|
547 | |
|
|
548 | The flags are a combination of the following constants, ORed together (the |
|
|
549 | flags will also be passed to the callback, possibly modified): |
|
|
550 | |
|
|
551 | =over 4 |
|
|
552 | |
|
|
553 | =item AIO::READDIR_DENTS |
|
|
554 | |
|
|
555 | When this flag is off, then the callback gets an arrayref with of names |
|
|
556 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
|
|
557 | C<[$name, $inode, $type]> arrayrefs, each describing a single directory |
|
|
558 | entry in more detail. |
|
|
559 | |
|
|
560 | C<$name> is the name of the entry. |
|
|
561 | |
|
|
562 | C<$inode> is the inode number (which might not be exact on systems with 64 |
|
|
563 | bit inode numbers and 32 bit perls). On systems that do not deliver the |
|
|
564 | inode information, this will always be zero. |
|
|
565 | |
|
|
566 | C<$type> is one of the C<AIO::DT_xxx> constants: |
|
|
567 | |
|
|
568 | C<AIO::DT_UNKNOWN>, C<AIO::DT_FIFO>, C<AIO::DT_CHR>, C<AIO::DT_DIR>, |
|
|
569 | C<AIO::DT_BLK>, C<AIO::DT_REG>, C<AIO::DT_LNK>, C<AIO::DT_SOCK>, |
|
|
570 | C<AIO::DT_WHT>. |
|
|
571 | |
|
|
572 | C<AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
|
|
573 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
|
|
574 | scalars are read-only: you can not modify them. |
|
|
575 | |
|
|
576 | =item AIO::READDIR_DIRS_FIRST |
|
|
577 | |
|
|
578 | When this flag is set, then the names will be returned in an order where |
|
|
579 | likely directories come first. This is useful when you need to quickly |
|
|
580 | find directories, or you want to find all directories while avoiding to |
|
|
581 | stat() each entry. |
|
|
582 | |
|
|
583 | =item AIO::READDIR_STAT_ORDER |
|
|
584 | |
|
|
585 | When this flag is set, then the names will be returned in an order |
|
|
586 | suitable for stat()'ing each one. That is, when you plan to stat() |
|
|
587 | all files in the given directory, then the returned order will likely |
|
|
588 | be fastest. |
|
|
589 | |
|
|
590 | If both this flag and IO::READDIR_DIRS_FIRST are specified, then the |
|
|
591 | likely dirs come first, resulting in a less optimal stat order. |
|
|
592 | |
|
|
593 | =item AIO::READDIR_FOUND_UNKNOWN |
|
|
594 | |
|
|
595 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
|
|
596 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
|
|
597 | C<AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
|
|
598 | C<$type>'s are known, which can be used to speed up some algorithms. |
|
|
599 | |
|
|
600 | =back |
584 | |
601 | |
585 | |
602 | |
586 | =item aio_load $path, $data, $callback->($status) |
603 | =item aio_load $path, $data, $callback->($status) |
587 | |
604 | |
588 | This is a composite request that tries to fully load the given file into |
605 | This is a composite request that tries to fully load the given file into |
589 | memory. Status is the same as with aio_read. |
606 | memory. Status is the same as with aio_read. |
590 | |
607 | |
591 | =cut |
608 | =cut |
592 | |
609 | |
593 | sub aio_load($$;$) { |
610 | sub aio_load($$;$) { |
594 | aio_block { |
|
|
595 | my ($path, undef, $cb) = @_; |
611 | my ($path, undef, $cb) = @_; |
596 | my $data = \$_[1]; |
612 | my $data = \$_[1]; |
597 | |
613 | |
598 | my $pri = aioreq_pri; |
614 | my $pri = aioreq_pri; |
599 | my $grp = aio_group $cb; |
615 | my $grp = aio_group $cb; |
|
|
616 | |
|
|
617 | aioreq_pri $pri; |
|
|
618 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
619 | my $fh = shift |
|
|
620 | or return $grp->result (-1); |
600 | |
621 | |
601 | aioreq_pri $pri; |
622 | aioreq_pri $pri; |
602 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
603 | my $fh = shift |
|
|
604 | or return $grp->result (-1); |
|
|
605 | |
|
|
606 | aioreq_pri $pri; |
|
|
607 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
623 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
608 | $grp->result ($_[0]); |
624 | $grp->result ($_[0]); |
609 | }; |
|
|
610 | }; |
625 | }; |
611 | |
|
|
612 | $grp |
|
|
613 | } |
626 | }; |
|
|
627 | |
|
|
628 | $grp |
614 | } |
629 | } |
615 | |
630 | |
616 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
631 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
617 | |
632 | |
618 | Try to copy the I<file> (directories not supported as either source or |
633 | Try to copy the I<file> (directories not supported as either source or |
619 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
634 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
620 | the C<0> (error) or C<-1> ok. |
635 | the C<0> (error) or C<-1> ok. |
621 | |
636 | |
622 | This is a composite request that it creates the destination file with |
637 | This is a composite request that creates the destination file with |
623 | mode 0200 and copies the contents of the source file into it using |
638 | mode 0200 and copies the contents of the source file into it using |
624 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
639 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
625 | uid/gid, in that order. |
640 | uid/gid, in that order. |
626 | |
641 | |
627 | If an error occurs, the partial destination file will be unlinked, if |
642 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
629 | errors are being ignored. |
644 | errors are being ignored. |
630 | |
645 | |
631 | =cut |
646 | =cut |
632 | |
647 | |
633 | sub aio_copy($$;$) { |
648 | sub aio_copy($$;$) { |
634 | aio_block { |
|
|
635 | my ($src, $dst, $cb) = @_; |
649 | my ($src, $dst, $cb) = @_; |
636 | |
650 | |
637 | my $pri = aioreq_pri; |
651 | my $pri = aioreq_pri; |
638 | my $grp = aio_group $cb; |
652 | my $grp = aio_group $cb; |
639 | |
653 | |
640 | aioreq_pri $pri; |
654 | aioreq_pri $pri; |
641 | add $grp aio_open $src, O_RDONLY, 0, sub { |
655 | add $grp aio_open $src, O_RDONLY, 0, sub { |
642 | if (my $src_fh = $_[0]) { |
656 | if (my $src_fh = $_[0]) { |
643 | my @stat = stat $src_fh; |
657 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
644 | |
658 | |
645 | aioreq_pri $pri; |
659 | aioreq_pri $pri; |
646 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
660 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
647 | if (my $dst_fh = $_[0]) { |
661 | if (my $dst_fh = $_[0]) { |
648 | aioreq_pri $pri; |
662 | aioreq_pri $pri; |
649 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
663 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
650 | if ($_[0] == $stat[7]) { |
664 | if ($_[0] == $stat[7]) { |
651 | $grp->result (0); |
665 | $grp->result (0); |
652 | close $src_fh; |
666 | close $src_fh; |
653 | |
667 | |
654 | # those should not normally block. should. should. |
668 | my $ch = sub { |
655 | utime $stat[8], $stat[9], $dst; |
|
|
656 | chmod $stat[2] & 07777, $dst_fh; |
|
|
657 | chown $stat[4], $stat[5], $dst_fh; |
|
|
658 | |
|
|
659 | aioreq_pri $pri; |
669 | aioreq_pri $pri; |
|
|
670 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
|
|
671 | aioreq_pri $pri; |
|
|
672 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
673 | aioreq_pri $pri; |
660 | add $grp aio_close $dst_fh; |
674 | add $grp aio_close $dst_fh; |
661 | } else { |
675 | } |
662 | $grp->result (-1); |
|
|
663 | close $src_fh; |
|
|
664 | close $dst_fh; |
|
|
665 | |
|
|
666 | aioreq $pri; |
676 | }; |
667 | add $grp aio_unlink $dst; |
|
|
668 | } |
677 | }; |
|
|
678 | |
|
|
679 | aioreq_pri $pri; |
|
|
680 | add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub { |
|
|
681 | if ($_[0] < 0 && $! == ENOSYS) { |
|
|
682 | aioreq_pri $pri; |
|
|
683 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
|
|
684 | } else { |
|
|
685 | $ch->(); |
|
|
686 | } |
|
|
687 | }; |
|
|
688 | } else { |
|
|
689 | $grp->result (-1); |
|
|
690 | close $src_fh; |
|
|
691 | close $dst_fh; |
|
|
692 | |
|
|
693 | aioreq $pri; |
|
|
694 | add $grp aio_unlink $dst; |
669 | }; |
695 | } |
670 | } else { |
|
|
671 | $grp->result (-1); |
|
|
672 | } |
696 | }; |
|
|
697 | } else { |
|
|
698 | $grp->result (-1); |
673 | }, |
699 | } |
674 | |
|
|
675 | } else { |
|
|
676 | $grp->result (-1); |
|
|
677 | } |
700 | }, |
|
|
701 | |
|
|
702 | } else { |
|
|
703 | $grp->result (-1); |
678 | }; |
704 | } |
679 | |
|
|
680 | $grp |
|
|
681 | } |
705 | }; |
|
|
706 | |
|
|
707 | $grp |
682 | } |
708 | } |
683 | |
709 | |
684 | =item aio_move $srcpath, $dstpath, $callback->($status) |
710 | =item aio_move $srcpath, $dstpath, $callback->($status) |
685 | |
711 | |
686 | Try to move the I<file> (directories not supported as either source or |
712 | Try to move the I<file> (directories not supported as either source or |
687 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
713 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
688 | the C<0> (error) or C<-1> ok. |
714 | the C<0> (error) or C<-1> ok. |
689 | |
715 | |
690 | This is a composite request that tries to rename(2) the file first. If |
716 | This is a composite request that tries to rename(2) the file first; if |
691 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
717 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
692 | that is successful, unlinking the C<$srcpath>. |
718 | that is successful, unlinks the C<$srcpath>. |
693 | |
719 | |
694 | =cut |
720 | =cut |
695 | |
721 | |
696 | sub aio_move($$;$) { |
722 | sub aio_move($$;$) { |
697 | aio_block { |
|
|
698 | my ($src, $dst, $cb) = @_; |
723 | my ($src, $dst, $cb) = @_; |
699 | |
724 | |
700 | my $pri = aioreq_pri; |
725 | my $pri = aioreq_pri; |
701 | my $grp = aio_group $cb; |
726 | my $grp = aio_group $cb; |
702 | |
727 | |
703 | aioreq_pri $pri; |
728 | aioreq_pri $pri; |
704 | add $grp aio_rename $src, $dst, sub { |
729 | add $grp aio_rename $src, $dst, sub { |
705 | if ($_[0] && $! == EXDEV) { |
730 | if ($_[0] && $! == EXDEV) { |
706 | aioreq_pri $pri; |
731 | aioreq_pri $pri; |
707 | add $grp aio_copy $src, $dst, sub { |
732 | add $grp aio_copy $src, $dst, sub { |
708 | $grp->result ($_[0]); |
|
|
709 | |
|
|
710 | if (!$_[0]) { |
|
|
711 | aioreq_pri $pri; |
|
|
712 | add $grp aio_unlink $src; |
|
|
713 | } |
|
|
714 | }; |
|
|
715 | } else { |
|
|
716 | $grp->result ($_[0]); |
733 | $grp->result ($_[0]); |
|
|
734 | |
|
|
735 | if (!$_[0]) { |
|
|
736 | aioreq_pri $pri; |
|
|
737 | add $grp aio_unlink $src; |
|
|
738 | } |
717 | } |
739 | }; |
|
|
740 | } else { |
|
|
741 | $grp->result ($_[0]); |
718 | }; |
742 | } |
719 | |
|
|
720 | $grp |
|
|
721 | } |
743 | }; |
|
|
744 | |
|
|
745 | $grp |
722 | } |
746 | } |
723 | |
747 | |
724 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
748 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
725 | |
749 | |
726 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
750 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
774 | directory counting heuristic. |
798 | directory counting heuristic. |
775 | |
799 | |
776 | =cut |
800 | =cut |
777 | |
801 | |
778 | sub aio_scandir($$;$) { |
802 | sub aio_scandir($$;$) { |
779 | aio_block { |
|
|
780 | my ($path, $maxreq, $cb) = @_; |
803 | my ($path, $maxreq, $cb) = @_; |
781 | |
804 | |
782 | my $pri = aioreq_pri; |
805 | my $pri = aioreq_pri; |
783 | |
806 | |
784 | my $grp = aio_group $cb; |
807 | my $grp = aio_group $cb; |
785 | |
808 | |
786 | $maxreq = 4 if $maxreq <= 0; |
809 | $maxreq = 4 if $maxreq <= 0; |
787 | |
810 | |
788 | # stat once |
811 | # stat once |
|
|
812 | aioreq_pri $pri; |
|
|
813 | add $grp aio_stat $path, sub { |
|
|
814 | return $grp->result () if $_[0]; |
|
|
815 | my $now = time; |
|
|
816 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
817 | |
|
|
818 | # read the directory entries |
789 | aioreq_pri $pri; |
819 | aioreq_pri $pri; |
790 | add $grp aio_stat $path, sub { |
820 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
|
|
821 | my $entries = shift |
791 | return $grp->result () if $_[0]; |
822 | or return $grp->result (); |
792 | my $now = time; |
|
|
793 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
794 | |
823 | |
795 | # read the directory entries |
824 | # stat the dir another time |
796 | aioreq_pri $pri; |
825 | aioreq_pri $pri; |
797 | add $grp aio_readdir $path, sub { |
|
|
798 | my $entries = shift |
|
|
799 | or return $grp->result (); |
|
|
800 | |
|
|
801 | # stat the dir another time |
|
|
802 | aioreq_pri $pri; |
|
|
803 | add $grp aio_stat $path, sub { |
826 | add $grp aio_stat $path, sub { |
804 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
827 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
805 | |
828 | |
806 | my $ndirs; |
829 | my $ndirs; |
807 | |
830 | |
808 | # take the slow route if anything looks fishy |
831 | # take the slow route if anything looks fishy |
809 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
832 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
810 | $ndirs = -1; |
833 | $ndirs = -1; |
811 | } else { |
834 | } else { |
812 | # if nlink == 2, we are finished |
835 | # if nlink == 2, we are finished |
813 | # on non-posix-fs's, we rely on nlink < 2 |
836 | # on non-posix-fs's, we rely on nlink < 2 |
814 | $ndirs = (stat _)[3] - 2 |
837 | $ndirs = (stat _)[3] - 2 |
815 | or return $grp->result ([], $entries); |
838 | or return $grp->result ([], $entries); |
816 | } |
839 | } |
817 | |
840 | |
818 | # sort into likely dirs and likely nondirs |
841 | # sort into likely dirs and likely nondirs |
819 | # dirs == files without ".", short entries first |
842 | # dirs == files without ".", short entries first |
820 | $entries = [map $_->[0], |
843 | $entries = [map $_->[0], |
821 | sort { $b->[1] cmp $a->[1] } |
844 | sort { $b->[1] cmp $a->[1] } |
822 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
845 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
823 | @$entries]; |
846 | @$entries]; |
824 | |
847 | |
825 | my (@dirs, @nondirs); |
848 | my (@dirs, @nondirs); |
826 | |
849 | |
827 | my $statgrp = add $grp aio_group sub { |
850 | my $statgrp = add $grp aio_group sub { |
828 | $grp->result (\@dirs, \@nondirs); |
851 | $grp->result (\@dirs, \@nondirs); |
829 | }; |
852 | }; |
830 | |
853 | |
831 | limit $statgrp $maxreq; |
854 | limit $statgrp $maxreq; |
832 | feed $statgrp sub { |
855 | feed $statgrp sub { |
833 | return unless @$entries; |
856 | return unless @$entries; |
834 | my $entry = pop @$entries; |
857 | my $entry = pop @$entries; |
835 | |
858 | |
836 | aioreq_pri $pri; |
859 | aioreq_pri $pri; |
837 | add $statgrp aio_stat "$path/$entry/.", sub { |
860 | add $statgrp aio_stat "$path/$entry/.", sub { |
838 | if ($_[0] < 0) { |
861 | if ($_[0] < 0) { |
839 | push @nondirs, $entry; |
862 | push @nondirs, $entry; |
840 | } else { |
863 | } else { |
841 | # need to check for real directory |
864 | # need to check for real directory |
842 | aioreq_pri $pri; |
865 | aioreq_pri $pri; |
843 | add $statgrp aio_lstat "$path/$entry", sub { |
866 | add $statgrp aio_lstat "$path/$entry", sub { |
844 | if (-d _) { |
867 | if (-d _) { |
845 | push @dirs, $entry; |
868 | push @dirs, $entry; |
846 | |
869 | |
847 | unless (--$ndirs) { |
870 | unless (--$ndirs) { |
848 | push @nondirs, @$entries; |
871 | push @nondirs, @$entries; |
849 | feed $statgrp; |
872 | feed $statgrp; |
850 | } |
|
|
851 | } else { |
|
|
852 | push @nondirs, $entry; |
|
|
853 | } |
873 | } |
|
|
874 | } else { |
|
|
875 | push @nondirs, $entry; |
854 | } |
876 | } |
855 | } |
877 | } |
856 | }; |
878 | } |
857 | }; |
879 | }; |
858 | }; |
880 | }; |
859 | }; |
881 | }; |
860 | }; |
882 | }; |
861 | |
|
|
862 | $grp |
|
|
863 | } |
883 | }; |
|
|
884 | |
|
|
885 | $grp |
864 | } |
886 | } |
865 | |
887 | |
866 | =item aio_rmtree $path, $callback->($status) |
888 | =item aio_rmtree $path, $callback->($status) |
867 | |
889 | |
868 | Delete a directory tree starting (and including) C<$path>, return the |
890 | Delete a directory tree starting (and including) C<$path>, return the |
… | |
… | |
872 | |
894 | |
873 | =cut |
895 | =cut |
874 | |
896 | |
875 | sub aio_rmtree; |
897 | sub aio_rmtree; |
876 | sub aio_rmtree($;$) { |
898 | sub aio_rmtree($;$) { |
877 | aio_block { |
|
|
878 | my ($path, $cb) = @_; |
899 | my ($path, $cb) = @_; |
879 | |
900 | |
880 | my $pri = aioreq_pri; |
901 | my $pri = aioreq_pri; |
881 | my $grp = aio_group $cb; |
902 | my $grp = aio_group $cb; |
882 | |
903 | |
883 | aioreq_pri $pri; |
904 | aioreq_pri $pri; |
884 | add $grp aio_scandir $path, 0, sub { |
905 | add $grp aio_scandir $path, 0, sub { |
885 | my ($dirs, $nondirs) = @_; |
906 | my ($dirs, $nondirs) = @_; |
886 | |
907 | |
887 | my $dirgrp = aio_group sub { |
908 | my $dirgrp = aio_group sub { |
888 | add $grp aio_rmdir $path, sub { |
909 | add $grp aio_rmdir $path, sub { |
889 | $grp->result ($_[0]); |
910 | $grp->result ($_[0]); |
890 | }; |
|
|
891 | }; |
911 | }; |
892 | |
|
|
893 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
894 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
895 | |
|
|
896 | add $grp $dirgrp; |
|
|
897 | }; |
912 | }; |
898 | |
913 | |
899 | $grp |
914 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
915 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
916 | |
|
|
917 | add $grp $dirgrp; |
900 | } |
918 | }; |
|
|
919 | |
|
|
920 | $grp |
901 | } |
921 | } |
902 | |
922 | |
903 | =item aio_sync $callback->($status) |
923 | =item aio_sync $callback->($status) |
904 | |
924 | |
905 | Asynchronously call sync and call the callback when finished. |
925 | Asynchronously call sync and call the callback when finished. |
… | |
… | |
915 | callback with the fdatasync result code. |
935 | callback with the fdatasync result code. |
916 | |
936 | |
917 | If this call isn't available because your OS lacks it or it couldn't be |
937 | If this call isn't available because your OS lacks it or it couldn't be |
918 | detected, it will be emulated by calling C<fsync> instead. |
938 | detected, it will be emulated by calling C<fsync> instead. |
919 | |
939 | |
|
|
940 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
941 | |
|
|
942 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
943 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
944 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
945 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
946 | |
|
|
947 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
948 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
949 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
950 | manpage for details. |
|
|
951 | |
920 | =item aio_pathsync $path, $callback->($status) |
952 | =item aio_pathsync $path, $callback->($status) |
921 | |
953 | |
922 | This request tries to open, fsync and close the given path. This is a |
954 | This request tries to open, fsync and close the given path. This is a |
923 | composite request intended tosync directories after directory operations |
955 | composite request intended to sync directories after directory operations |
924 | (E.g. rename). This might not work on all operating systems or have any |
956 | (E.g. rename). This might not work on all operating systems or have any |
925 | specific effect, but usually it makes sure that directory changes get |
957 | specific effect, but usually it makes sure that directory changes get |
926 | written to disc. It works for anything that can be opened for read-only, |
958 | written to disc. It works for anything that can be opened for read-only, |
927 | not just directories. |
959 | not just directories. |
928 | |
960 | |
929 | Passes C<0> when everything went ok, and C<-1> on error. |
961 | Passes C<0> when everything went ok, and C<-1> on error. |
930 | |
962 | |
931 | =cut |
963 | =cut |
932 | |
964 | |
933 | sub aio_pathsync($;$) { |
965 | sub aio_pathsync($;$) { |
934 | aio_block { |
|
|
935 | my ($path, $cb) = @_; |
966 | my ($path, $cb) = @_; |
936 | |
967 | |
937 | my $pri = aioreq_pri; |
968 | my $pri = aioreq_pri; |
938 | my $grp = aio_group $cb; |
969 | my $grp = aio_group $cb; |
939 | |
970 | |
940 | aioreq_pri $pri; |
971 | aioreq_pri $pri; |
941 | add $grp aio_open $path, O_RDONLY, 0, sub { |
972 | add $grp aio_open $path, O_RDONLY, 0, sub { |
942 | my ($fh) = @_; |
973 | my ($fh) = @_; |
943 | if ($fh) { |
974 | if ($fh) { |
|
|
975 | aioreq_pri $pri; |
|
|
976 | add $grp aio_fsync $fh, sub { |
|
|
977 | $grp->result ($_[0]); |
|
|
978 | |
944 | aioreq_pri $pri; |
979 | aioreq_pri $pri; |
945 | add $grp aio_fsync $fh, sub { |
|
|
946 | $grp->result ($_[0]); |
|
|
947 | |
|
|
948 | aioreq_pri $pri; |
|
|
949 | add $grp aio_close $fh; |
980 | add $grp aio_close $fh; |
950 | }; |
|
|
951 | } else { |
|
|
952 | $grp->result (-1); |
|
|
953 | } |
981 | }; |
|
|
982 | } else { |
|
|
983 | $grp->result (-1); |
954 | }; |
984 | } |
955 | |
|
|
956 | $grp |
|
|
957 | } |
985 | }; |
|
|
986 | |
|
|
987 | $grp |
958 | } |
988 | } |
959 | |
989 | |
960 | =item aio_group $callback->(...) |
990 | =item aio_group $callback->(...) |
961 | |
991 | |
962 | This is a very special aio request: Instead of doing something, it is a |
992 | This is a very special aio request: Instead of doing something, it is a |
… | |
… | |
1075 | Their lifetime, simplified, looks like this: when they are empty, they |
1105 | Their lifetime, simplified, looks like this: when they are empty, they |
1076 | will finish very quickly. If they contain only requests that are in the |
1106 | will finish very quickly. If they contain only requests that are in the |
1077 | C<done> state, they will also finish. Otherwise they will continue to |
1107 | C<done> state, they will also finish. Otherwise they will continue to |
1078 | exist. |
1108 | exist. |
1079 | |
1109 | |
1080 | That means after creating a group you have some time to add requests. And |
1110 | That means after creating a group you have some time to add requests |
1081 | in the callbacks of those requests, you can add further requests to the |
1111 | (precisely before the callback has been invoked, which is only done within |
1082 | group. And only when all those requests have finished will the the group |
1112 | the C<poll_cb>). And in the callbacks of those requests, you can add |
1083 | itself finish. |
1113 | further requests to the group. And only when all those requests have |
|
|
1114 | finished will the the group itself finish. |
1084 | |
1115 | |
1085 | =over 4 |
1116 | =over 4 |
1086 | |
1117 | |
1087 | =item add $grp ... |
1118 | =item add $grp ... |
1088 | |
1119 | |
… | |
… | |
1121 | =item feed $grp $callback->($grp) |
1152 | =item feed $grp $callback->($grp) |
1122 | |
1153 | |
1123 | Sets a feeder/generator on this group: every group can have an attached |
1154 | Sets a feeder/generator on this group: every group can have an attached |
1124 | generator that generates requests if idle. The idea behind this is that, |
1155 | generator that generates requests if idle. The idea behind this is that, |
1125 | although you could just queue as many requests as you want in a group, |
1156 | although you could just queue as many requests as you want in a group, |
1126 | this might starve other requests for a potentially long time. For |
1157 | this might starve other requests for a potentially long time. For example, |
1127 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1158 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1128 | requests, delaying any later requests for a long time. |
1159 | delaying any later requests for a long time. |
1129 | |
1160 | |
1130 | To avoid this, and allow incremental generation of requests, you can |
1161 | To avoid this, and allow incremental generation of requests, you can |
1131 | instead a group and set a feeder on it that generates those requests. The |
1162 | instead a group and set a feeder on it that generates those requests. The |
1132 | feed callback will be called whenever there are few enough (see C<limit>, |
1163 | feed callback will be called whenever there are few enough (see C<limit>, |
1133 | below) requests active in the group itself and is expected to queue more |
1164 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1137 | not impose any limits). |
1168 | not impose any limits). |
1138 | |
1169 | |
1139 | If the feed does not queue more requests when called, it will be |
1170 | If the feed does not queue more requests when called, it will be |
1140 | automatically removed from the group. |
1171 | automatically removed from the group. |
1141 | |
1172 | |
1142 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1173 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1174 | C<2> automatically. |
1143 | |
1175 | |
1144 | Example: |
1176 | Example: |
1145 | |
1177 | |
1146 | # stat all files in @files, but only ever use four aio requests concurrently: |
1178 | # stat all files in @files, but only ever use four aio requests concurrently: |
1147 | |
1179 | |
… | |
… | |
1159 | Sets the feeder limit for the group: The feeder will be called whenever |
1191 | Sets the feeder limit for the group: The feeder will be called whenever |
1160 | the group contains less than this many requests. |
1192 | the group contains less than this many requests. |
1161 | |
1193 | |
1162 | Setting the limit to C<0> will pause the feeding process. |
1194 | Setting the limit to C<0> will pause the feeding process. |
1163 | |
1195 | |
|
|
1196 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1197 | automatically bumps it up to C<2>. |
|
|
1198 | |
1164 | =back |
1199 | =back |
1165 | |
1200 | |
1166 | =head2 SUPPORT FUNCTIONS |
1201 | =head2 SUPPORT FUNCTIONS |
1167 | |
1202 | |
1168 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1203 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
1179 | See C<poll_cb> for an example. |
1214 | See C<poll_cb> for an example. |
1180 | |
1215 | |
1181 | =item IO::AIO::poll_cb |
1216 | =item IO::AIO::poll_cb |
1182 | |
1217 | |
1183 | Process some outstanding events on the result pipe. You have to call this |
1218 | Process some outstanding events on the result pipe. You have to call this |
1184 | regularly. Returns the number of events processed. Returns immediately |
1219 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1220 | returned earlier for whatever reason. Returns immediately when no events |
1185 | when no events are outstanding. The amount of events processed depends on |
1221 | are outstanding. The amount of events processed depends on the settings of |
1186 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1222 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1187 | |
1223 | |
1188 | If not all requests were processed for whatever reason, the filehandle |
1224 | If not all requests were processed for whatever reason, the filehandle |
1189 | will still be ready when C<poll_cb> returns. |
1225 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1226 | do anything special to have it called later. |
1190 | |
1227 | |
1191 | Example: Install an Event watcher that automatically calls |
1228 | Example: Install an Event watcher that automatically calls |
1192 | IO::AIO::poll_cb with high priority: |
1229 | IO::AIO::poll_cb with high priority: |
1193 | |
1230 | |
1194 | Event->io (fd => IO::AIO::poll_fileno, |
1231 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1308 | |
1345 | |
1309 | The default is probably ok in most situations, especially if thread |
1346 | The default is probably ok in most situations, especially if thread |
1310 | creation is fast. If thread creation is very slow on your system you might |
1347 | creation is fast. If thread creation is very slow on your system you might |
1311 | want to use larger values. |
1348 | want to use larger values. |
1312 | |
1349 | |
1313 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1350 | =item IO::AIO::max_outstanding $maxreqs |
1314 | |
1351 | |
1315 | This is a very bad function to use in interactive programs because it |
1352 | This is a very bad function to use in interactive programs because it |
1316 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1353 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1317 | use an C<aio_group> together with a feed callback. |
1354 | use an C<aio_group> together with a feed callback. |
1318 | |
1355 | |
… | |
… | |
1323 | |
1360 | |
1324 | The default value is very large, so there is no practical limit on the |
1361 | The default value is very large, so there is no practical limit on the |
1325 | number of outstanding requests. |
1362 | number of outstanding requests. |
1326 | |
1363 | |
1327 | You can still queue as many requests as you want. Therefore, |
1364 | You can still queue as many requests as you want. Therefore, |
1328 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1365 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1329 | as a stop gap to shield against fatal memory overflow (with large values). |
1366 | as a stop gap to shield against fatal memory overflow (with large values). |
1330 | |
1367 | |
1331 | =back |
1368 | =back |
1332 | |
1369 | |
1333 | =head3 STATISTICAL INFORMATION |
1370 | =head3 STATISTICAL INFORMATION |
… | |
… | |
1403 | |
1440 | |
1404 | Known bugs will be fixed in the next release. |
1441 | Known bugs will be fixed in the next release. |
1405 | |
1442 | |
1406 | =head1 SEE ALSO |
1443 | =head1 SEE ALSO |
1407 | |
1444 | |
1408 | L<Coro::AIO>. |
1445 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1446 | more natural syntax. |
1409 | |
1447 | |
1410 | =head1 AUTHOR |
1448 | =head1 AUTHOR |
1411 | |
1449 | |
1412 | Marc Lehmann <schmorp@schmorp.de> |
1450 | Marc Lehmann <schmorp@schmorp.de> |
1413 | http://home.schmorp.de/ |
1451 | http://home.schmorp.de/ |