… | |
… | |
193 | use strict 'vars'; |
193 | use strict 'vars'; |
194 | |
194 | |
195 | use base 'Exporter'; |
195 | use base 'Exporter'; |
196 | |
196 | |
197 | BEGIN { |
197 | BEGIN { |
198 | our $VERSION = '3.1'; |
198 | our $VERSION = '3.19'; |
199 | |
199 | |
200 | 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 |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
203 | aio_fdatasync aio_pathsync aio_readahead |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
204 | aio_rename aio_link aio_move aio_copy aio_group |
205 | 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 |
206 | aio_chmod aio_utime aio_truncate); |
206 | aio_chmod aio_utime aio_truncate); |
207 | |
207 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
211 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
213 | |
215 | |
214 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
215 | |
217 | |
216 | require XSLoader; |
218 | require XSLoader; |
217 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
336 | |
338 | |
337 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | |
340 | |
339 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | |
342 | |
341 | 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 |
342 | 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> |
343 | 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 |
344 | 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. |
345 | |
350 | |
346 | 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 |
347 | 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 |
348 | changed by these calls. |
353 | changed by these calls. |
349 | |
354 | |
350 | 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>. |
351 | |
357 | |
352 | 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 |
353 | C<$data>. |
359 | C<$data>. |
354 | |
360 | |
355 | 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 |
… | |
… | |
527 | |
533 | |
528 | 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 |
529 | directory (i.e. opendir + readdir + closedir). The entries will not be |
535 | directory (i.e. opendir + readdir + closedir). The entries will not be |
530 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
536 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
531 | |
537 | |
532 | 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 |
533 | 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 |
534 | |
601 | |
535 | |
602 | |
536 | =item aio_load $path, $data, $callback->($status) |
603 | =item aio_load $path, $data, $callback->($status) |
537 | |
604 | |
538 | 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 |
… | |
… | |
585 | my $grp = aio_group $cb; |
652 | my $grp = aio_group $cb; |
586 | |
653 | |
587 | aioreq_pri $pri; |
654 | aioreq_pri $pri; |
588 | add $grp aio_open $src, O_RDONLY, 0, sub { |
655 | add $grp aio_open $src, O_RDONLY, 0, sub { |
589 | if (my $src_fh = $_[0]) { |
656 | if (my $src_fh = $_[0]) { |
590 | my @stat = stat $src_fh; |
657 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
591 | |
658 | |
592 | aioreq_pri $pri; |
659 | aioreq_pri $pri; |
593 | 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 { |
594 | if (my $dst_fh = $_[0]) { |
661 | if (my $dst_fh = $_[0]) { |
595 | aioreq_pri $pri; |
662 | aioreq_pri $pri; |
596 | 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 { |
597 | if ($_[0] == $stat[7]) { |
664 | if ($_[0] == $stat[7]) { |
598 | $grp->result (0); |
665 | $grp->result (0); |
599 | close $src_fh; |
666 | close $src_fh; |
600 | |
667 | |
601 | # those should not normally block. should. should. |
668 | my $ch = sub { |
602 | utime $stat[8], $stat[9], $dst; |
669 | aioreq_pri $pri; |
603 | chmod $stat[2] & 07777, $dst_fh; |
670 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
604 | chown $stat[4], $stat[5], $dst_fh; |
671 | aioreq_pri $pri; |
|
|
672 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
673 | aioreq_pri $pri; |
|
|
674 | add $grp aio_close $dst_fh; |
|
|
675 | } |
|
|
676 | }; |
|
|
677 | }; |
605 | |
678 | |
606 | aioreq_pri $pri; |
679 | aioreq_pri $pri; |
607 | add $grp aio_close $dst_fh; |
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 | }; |
608 | } else { |
688 | } else { |
609 | $grp->result (-1); |
689 | $grp->result (-1); |
610 | close $src_fh; |
690 | close $src_fh; |
611 | close $dst_fh; |
691 | close $dst_fh; |
612 | |
692 | |
… | |
… | |
735 | my $now = time; |
815 | my $now = time; |
736 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
816 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
737 | |
817 | |
738 | # read the directory entries |
818 | # read the directory entries |
739 | aioreq_pri $pri; |
819 | aioreq_pri $pri; |
740 | add $grp aio_readdir $path, sub { |
820 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
741 | my $entries = shift |
821 | my $entries = shift |
742 | or return $grp->result (); |
822 | or return $grp->result (); |
743 | |
823 | |
744 | # stat the dir another time |
824 | # stat the dir another time |
745 | aioreq_pri $pri; |
825 | aioreq_pri $pri; |
… | |
… | |
855 | callback with the fdatasync result code. |
935 | callback with the fdatasync result code. |
856 | |
936 | |
857 | 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 |
858 | detected, it will be emulated by calling C<fsync> instead. |
938 | detected, it will be emulated by calling C<fsync> instead. |
859 | |
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 | |
860 | =item aio_pathsync $path, $callback->($status) |
952 | =item aio_pathsync $path, $callback->($status) |
861 | |
953 | |
862 | 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 |
863 | composite request intended to sync directories after directory operations |
955 | composite request intended to sync directories after directory operations |
864 | (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 |
… | |
… | |
1060 | =item feed $grp $callback->($grp) |
1152 | =item feed $grp $callback->($grp) |
1061 | |
1153 | |
1062 | 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 |
1063 | 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, |
1064 | 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, |
1065 | this might starve other requests for a potentially long time. For |
1157 | this might starve other requests for a potentially long time. For example, |
1066 | 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, |
1067 | requests, delaying any later requests for a long time. |
1159 | delaying any later requests for a long time. |
1068 | |
1160 | |
1069 | To avoid this, and allow incremental generation of requests, you can |
1161 | To avoid this, and allow incremental generation of requests, you can |
1070 | 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 |
1071 | 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>, |
1072 | 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 |