… | |
… | |
171 | use common::sense; |
171 | use common::sense; |
172 | |
172 | |
173 | use base 'Exporter'; |
173 | use base 'Exporter'; |
174 | |
174 | |
175 | BEGIN { |
175 | BEGIN { |
176 | our $VERSION = 4.35; |
176 | our $VERSION = 4.6; |
177 | |
177 | |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
… | |
… | |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
185 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
187 | aio_statvfs |
187 | aio_statvfs |
|
|
188 | aio_slurp |
188 | aio_wd); |
189 | aio_wd); |
189 | |
190 | |
190 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
193 | nreqs nready npending nthreads |
194 | nreqs nready npending nthreads |
194 | max_poll_time max_poll_reqs |
195 | max_poll_time max_poll_reqs |
195 | sendfile fadvise madvise |
196 | sendfile fadvise madvise |
196 | mmap munmap munlock munlockall); |
197 | mmap munmap mremap munlock munlockall); |
197 | |
198 | |
198 | push @AIO_REQ, qw(aio_busy); # not exported |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
199 | |
200 | |
200 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
201 | |
202 | |
… | |
… | |
277 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
280 | IO::AIO::nready |
281 | IO::AIO::nready |
281 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
282 | IO::AIO::min_fdlimit $nfd; |
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
283 | |
285 | |
284 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
285 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
286 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
287 | IO::AIO::munmap $scalar |
289 | IO::AIO::munmap $scalar |
|
|
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
288 | IO::AIO::madvise $scalar, $offset, $length, $advice |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
289 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
290 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
291 | IO::AIO::munlockall |
294 | IO::AIO::munlockall |
292 | |
295 | |
… | |
… | |
402 | following POSIX and non-POSIX constants are available (missing ones on |
405 | following POSIX and non-POSIX constants are available (missing ones on |
403 | your system are, as usual, C<0>): |
406 | your system are, as usual, C<0>): |
404 | |
407 | |
405 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
408 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
406 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
409 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
407 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. |
410 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>. |
408 | |
411 | |
409 | |
412 | |
410 | =item aio_close $fh, $callback->($status) |
413 | =item aio_close $fh, $callback->($status) |
411 | |
414 | |
412 | Asynchronously close a file and call the callback with the result |
415 | Asynchronously close a file and call the callback with the result |
… | |
… | |
538 | |
541 | |
539 | =item aio_stat $fh_or_path, $callback->($status) |
542 | =item aio_stat $fh_or_path, $callback->($status) |
540 | |
543 | |
541 | =item aio_lstat $fh, $callback->($status) |
544 | =item aio_lstat $fh, $callback->($status) |
542 | |
545 | |
543 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
546 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
544 | be called after the stat and the results will be available using C<stat _> |
547 | callback will be called after the stat and the results will be available |
545 | or C<-s _> etc... |
548 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
|
|
549 | and C<-T>). |
546 | |
550 | |
547 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
551 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
548 | for an explanation. |
552 | for an explanation. |
549 | |
553 | |
550 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
554 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
… | |
… | |
557 | behaviour). |
561 | behaviour). |
558 | |
562 | |
559 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
563 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
560 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
564 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
561 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
565 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
566 | |
|
|
567 | To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME |
|
|
568 | ACCESS>. |
562 | |
569 | |
563 | Example: Print the length of F</etc/passwd>: |
570 | Example: Print the length of F</etc/passwd>: |
564 | |
571 | |
565 | aio_stat "/etc/passwd", sub { |
572 | aio_stat "/etc/passwd", sub { |
566 | $_[0] and die "stat failed: $!"; |
573 | $_[0] and die "stat failed: $!"; |
… | |
… | |
610 | namemax => 255, |
617 | namemax => 255, |
611 | frsize => 1024, |
618 | frsize => 1024, |
612 | fsid => 1810 |
619 | fsid => 1810 |
613 | } |
620 | } |
614 | |
621 | |
615 | Here is a (likely partial - send me updates!) list of fsid values used by |
|
|
616 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
|
|
617 | |
|
|
618 | 0x0000adf5 adfs |
|
|
619 | 0x0000adff affs |
|
|
620 | 0x5346414f afs |
|
|
621 | 0x09041934 anon-inode filesystem |
|
|
622 | 0x00000187 autofs |
|
|
623 | 0x42465331 befs |
|
|
624 | 0x1badface bfs |
|
|
625 | 0x42494e4d binfmt_misc |
|
|
626 | 0x9123683e btrfs |
|
|
627 | 0x0027e0eb cgroupfs |
|
|
628 | 0xff534d42 cifs |
|
|
629 | 0x73757245 coda |
|
|
630 | 0x012ff7b7 coh |
|
|
631 | 0x28cd3d45 cramfs |
|
|
632 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
633 | 0x64626720 debugfs |
|
|
634 | 0x00001373 devfs |
|
|
635 | 0x00001cd1 devpts |
|
|
636 | 0x0000f15f ecryptfs |
|
|
637 | 0x00414a53 efs |
|
|
638 | 0x0000137d ext |
|
|
639 | 0x0000ef53 ext2/ext3/ext4 |
|
|
640 | 0x0000ef51 ext2 |
|
|
641 | 0xf2f52010 f2fs |
|
|
642 | 0x00004006 fat |
|
|
643 | 0x65735546 fuseblk |
|
|
644 | 0x65735543 fusectl |
|
|
645 | 0x0bad1dea futexfs |
|
|
646 | 0x01161970 gfs2 |
|
|
647 | 0x47504653 gpfs |
|
|
648 | 0x00004244 hfs |
|
|
649 | 0xf995e849 hpfs |
|
|
650 | 0x00c0ffee hostfs |
|
|
651 | 0x958458f6 hugetlbfs |
|
|
652 | 0x2bad1dea inotifyfs |
|
|
653 | 0x00009660 isofs |
|
|
654 | 0x000072b6 jffs2 |
|
|
655 | 0x3153464a jfs |
|
|
656 | 0x6b414653 k-afs |
|
|
657 | 0x0bd00bd0 lustre |
|
|
658 | 0x0000137f minix |
|
|
659 | 0x0000138f minix 30 char names |
|
|
660 | 0x00002468 minix v2 |
|
|
661 | 0x00002478 minix v2 30 char names |
|
|
662 | 0x00004d5a minix v3 |
|
|
663 | 0x19800202 mqueue |
|
|
664 | 0x00004d44 msdos |
|
|
665 | 0x0000564c novell |
|
|
666 | 0x00006969 nfs |
|
|
667 | 0x6e667364 nfsd |
|
|
668 | 0x00003434 nilfs |
|
|
669 | 0x5346544e ntfs |
|
|
670 | 0x00009fa1 openprom |
|
|
671 | 0x7461636F ocfs2 |
|
|
672 | 0x00009fa0 proc |
|
|
673 | 0x6165676c pstorefs |
|
|
674 | 0x0000002f qnx4 |
|
|
675 | 0x68191122 qnx6 |
|
|
676 | 0x858458f6 ramfs |
|
|
677 | 0x52654973 reiserfs |
|
|
678 | 0x00007275 romfs |
|
|
679 | 0x67596969 rpc_pipefs |
|
|
680 | 0x73636673 securityfs |
|
|
681 | 0xf97cff8c selinux |
|
|
682 | 0x0000517b smb |
|
|
683 | 0x534f434b sockfs |
|
|
684 | 0x73717368 squashfs |
|
|
685 | 0x62656572 sysfs |
|
|
686 | 0x012ff7b6 sysv2 |
|
|
687 | 0x012ff7b5 sysv4 |
|
|
688 | 0x01021994 tmpfs |
|
|
689 | 0x15013346 udf |
|
|
690 | 0x00011954 ufs |
|
|
691 | 0x54190100 ufs byteswapped |
|
|
692 | 0x00009fa2 usbdevfs |
|
|
693 | 0x01021997 v9fs |
|
|
694 | 0xa501fcf5 vxfs |
|
|
695 | 0xabba1974 xenfs |
|
|
696 | 0x012ff7b4 xenix |
|
|
697 | 0x58465342 xfs |
|
|
698 | 0x012fd16d xia |
|
|
699 | |
|
|
700 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
622 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
701 | |
623 | |
702 | Works like perl's C<utime> function (including the special case of $atime |
624 | Works like perl's C<utime> function (including the special case of $atime |
703 | and $mtime being undef). Fractional times are supported if the underlying |
625 | and $mtime being undef). Fractional times are supported if the underlying |
704 | syscalls support them. |
626 | syscalls support them. |
705 | |
627 | |
706 | When called with a pathname, uses utimes(2) if available, otherwise |
628 | When called with a pathname, uses utimensat(2) or utimes(2) if available, |
707 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
629 | otherwise utime(2). If called on a file descriptor, uses futimens(2) |
708 | otherwise returns ENOSYS, so this is not portable. |
630 | or futimes(2) if available, otherwise returns ENOSYS, so this is not |
|
|
631 | portable. |
709 | |
632 | |
710 | Examples: |
633 | Examples: |
711 | |
634 | |
712 | # set atime and mtime to current time (basically touch(1)): |
635 | # set atime and mtime to current time (basically touch(1)): |
713 | aio_utime "path", undef, undef; |
636 | aio_utime "path", undef, undef; |
… | |
… | |
872 | |
795 | |
873 | =over 4 |
796 | =over 4 |
874 | |
797 | |
875 | =item IO::AIO::READDIR_DENTS |
798 | =item IO::AIO::READDIR_DENTS |
876 | |
799 | |
877 | When this flag is off, then the callback gets an arrayref consisting of |
800 | Normally the callback gets an arrayref consisting of names only (as |
878 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
801 | with C<aio_readdir>). If this flag is set, then the callback gets an |
879 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
802 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
880 | entry in more detail. |
803 | single directory entry in more detail: |
881 | |
804 | |
882 | C<$name> is the name of the entry. |
805 | C<$name> is the name of the entry. |
883 | |
806 | |
884 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
807 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
885 | |
808 | |
886 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
809 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
887 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
810 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
888 | C<IO::AIO::DT_WHT>. |
811 | C<IO::AIO::DT_WHT>. |
889 | |
812 | |
890 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
813 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
891 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
814 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
892 | scalars are read-only: you can not modify them. |
815 | the C<$type> scalars are read-only: you must not modify them. |
893 | |
816 | |
894 | C<$inode> is the inode number (which might not be exact on systems with 64 |
817 | C<$inode> is the inode number (which might not be exact on systems with 64 |
895 | bit inode numbers and 32 bit perls). This field has unspecified content on |
818 | bit inode numbers and 32 bit perls). This field has unspecified content on |
896 | systems that do not deliver the inode information. |
819 | systems that do not deliver the inode information. |
897 | |
820 | |
… | |
… | |
908 | short names are tried first. |
831 | short names are tried first. |
909 | |
832 | |
910 | =item IO::AIO::READDIR_STAT_ORDER |
833 | =item IO::AIO::READDIR_STAT_ORDER |
911 | |
834 | |
912 | When this flag is set, then the names will be returned in an order |
835 | When this flag is set, then the names will be returned in an order |
913 | suitable for stat()'ing each one. That is, when you plan to stat() |
836 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
914 | all files in the given directory, then the returned order will likely |
837 | all files in the given directory, then the returned order will likely be |
915 | be fastest. |
838 | faster. |
916 | |
839 | |
917 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
840 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
918 | the likely dirs come first, resulting in a less optimal stat order. |
841 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
842 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
843 | subdirectories. |
919 | |
844 | |
920 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
845 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
921 | |
846 | |
922 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
847 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
923 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
848 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
925 | C<$type>'s are known, which can be used to speed up some algorithms. |
850 | C<$type>'s are known, which can be used to speed up some algorithms. |
926 | |
851 | |
927 | =back |
852 | =back |
928 | |
853 | |
929 | |
854 | |
|
|
855 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
856 | |
|
|
857 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
858 | which is resized as required. |
|
|
859 | |
|
|
860 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
861 | |
|
|
862 | If C<$length> is zero, then the remaining length of the file is |
|
|
863 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
864 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
865 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
866 | C<$length> results in a performance advantage. |
|
|
867 | |
|
|
868 | This request is similar to the older C<aio_load> request, but since it is |
|
|
869 | a single request, it might be more efficient to use. |
|
|
870 | |
|
|
871 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
872 | |
|
|
873 | my $passwd; |
|
|
874 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
875 | $_[0] >= 0 |
|
|
876 | or die "/etc/passwd: $!\n"; |
|
|
877 | |
|
|
878 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
879 | print $passwd; |
|
|
880 | }; |
|
|
881 | IO::AIO::flush; |
|
|
882 | |
|
|
883 | |
930 | =item aio_load $pathname, $data, $callback->($status) |
884 | =item aio_load $pathname, $data, $callback->($status) |
931 | |
885 | |
932 | This is a composite request that tries to fully load the given file into |
886 | This is a composite request that tries to fully load the given file into |
933 | memory. Status is the same as with aio_read. |
887 | memory. Status is the same as with aio_read. |
|
|
888 | |
|
|
889 | Using C<aio_slurp> might be more efficient, as it is a single request. |
934 | |
890 | |
935 | =cut |
891 | =cut |
936 | |
892 | |
937 | sub aio_load($$;$) { |
893 | sub aio_load($$;$) { |
938 | my ($path, undef, $cb) = @_; |
894 | my ($path, undef, $cb) = @_; |
… | |
… | |
1482 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1438 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1483 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1439 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1484 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1440 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1485 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1441 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1486 | |
1442 | |
1487 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1443 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1488 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1444 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1489 | it to return all extents of a range for files with large number of |
1445 | it to return all extents of a range for files with a large number of |
1490 | extents. The code works around all these issues if C<$count> is undef. |
1446 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1447 | C<undef>. |
1491 | |
1448 | |
1492 | =item aio_group $callback->(...) |
1449 | =item aio_group $callback->(...) |
1493 | |
1450 | |
1494 | This is a very special aio request: Instead of doing something, it is a |
1451 | This is a very special aio request: Instead of doing something, it is a |
1495 | container for other aio requests, which is useful if you want to bundle |
1452 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1827 | The default value for the limit is C<0>, but note that setting a feeder |
1784 | The default value for the limit is C<0>, but note that setting a feeder |
1828 | automatically bumps it up to C<2>. |
1785 | automatically bumps it up to C<2>. |
1829 | |
1786 | |
1830 | =back |
1787 | =back |
1831 | |
1788 | |
|
|
1789 | |
1832 | =head2 SUPPORT FUNCTIONS |
1790 | =head2 SUPPORT FUNCTIONS |
1833 | |
1791 | |
1834 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1792 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1835 | |
1793 | |
1836 | =over 4 |
1794 | =over 4 |
… | |
… | |
1901 | Strictly equivalent to: |
1859 | Strictly equivalent to: |
1902 | |
1860 | |
1903 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1861 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1904 | while IO::AIO::nreqs; |
1862 | while IO::AIO::nreqs; |
1905 | |
1863 | |
|
|
1864 | This function can be useful at program aborts, to make sure outstanding |
|
|
1865 | I/O has been done (C<IO::AIO> uses an C<END> block which already calls |
|
|
1866 | this function on normal exits), or when you are merely using C<IO::AIO> |
|
|
1867 | for its more advanced functions, rather than for async I/O, e.g.: |
|
|
1868 | |
|
|
1869 | my ($dirs, $nondirs); |
|
|
1870 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1871 | IO::AIO::flush; |
|
|
1872 | # $dirs, $nondirs are now set |
|
|
1873 | |
1906 | =item IO::AIO::max_poll_reqs $nreqs |
1874 | =item IO::AIO::max_poll_reqs $nreqs |
1907 | |
1875 | |
1908 | =item IO::AIO::max_poll_time $seconds |
1876 | =item IO::AIO::max_poll_time $seconds |
1909 | |
1877 | |
1910 | These set the maximum number of requests (default C<0>, meaning infinity) |
1878 | These set the maximum number of requests (default C<0>, meaning infinity) |
… | |
… | |
1936 | poll => 'r', nice => 1, |
1904 | poll => 'r', nice => 1, |
1937 | cb => &IO::AIO::poll_cb); |
1905 | cb => &IO::AIO::poll_cb); |
1938 | |
1906 | |
1939 | =back |
1907 | =back |
1940 | |
1908 | |
|
|
1909 | |
1941 | =head3 CONTROLLING THE NUMBER OF THREADS |
1910 | =head3 CONTROLLING THE NUMBER OF THREADS |
1942 | |
1911 | |
1943 | =over |
1912 | =over |
1944 | |
1913 | |
1945 | =item IO::AIO::min_parallel $nthreads |
1914 | =item IO::AIO::min_parallel $nthreads |
… | |
… | |
2032 | The default value for C<max_outstanding> is very large, so there is no |
2001 | The default value for C<max_outstanding> is very large, so there is no |
2033 | practical limit on the number of outstanding requests. |
2002 | practical limit on the number of outstanding requests. |
2034 | |
2003 | |
2035 | =back |
2004 | =back |
2036 | |
2005 | |
|
|
2006 | |
2037 | =head3 STATISTICAL INFORMATION |
2007 | =head3 STATISTICAL INFORMATION |
2038 | |
2008 | |
2039 | =over |
2009 | =over |
2040 | |
2010 | |
2041 | =item IO::AIO::nreqs |
2011 | =item IO::AIO::nreqs |
… | |
… | |
2057 | |
2027 | |
2058 | Returns the number of requests currently in the pending state (executed, |
2028 | Returns the number of requests currently in the pending state (executed, |
2059 | but not yet processed by poll_cb). |
2029 | but not yet processed by poll_cb). |
2060 | |
2030 | |
2061 | =back |
2031 | =back |
|
|
2032 | |
|
|
2033 | |
|
|
2034 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2035 | |
|
|
2036 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
|
|
2037 | generally find access/modification and change times with subsecond time |
|
|
2038 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2039 | return the integer part. |
|
|
2040 | |
|
|
2041 | The following functions return the timestamps of the most recent |
|
|
2042 | stat with subsecond precision on most systems and work both after |
|
|
2043 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2044 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2045 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2046 | |
|
|
2047 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2048 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2049 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2050 | do not act like their perl counterparts. |
|
|
2051 | |
|
|
2052 | On operating systems or file systems where subsecond time resolution is |
|
|
2053 | not supported or could not be detected, a fractional part of C<0> is |
|
|
2054 | returned, so it is always safe to call these functions. |
|
|
2055 | |
|
|
2056 | =over 4 |
|
|
2057 | |
|
|
2058 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
2059 | |
|
|
2060 | Return the access, modication, change or birth time, respectively, |
|
|
2061 | including fractional part. Due to the limited precision of floating point, |
|
|
2062 | the accuracy on most platforms is only a bit better than milliseconds |
|
|
2063 | for times around now - see the I<nsec> function family, below, for full |
|
|
2064 | accuracy. |
|
|
2065 | |
|
|
2066 | File birth time is only available when the OS and perl support it (on |
|
|
2067 | FreeBSD and NetBSD at the time of this writing, although support is |
|
|
2068 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
|
|
2069 | it). On systems where it isn't available, C<0> is currently returned, but |
|
|
2070 | this might change to C<undef> in a future version. |
|
|
2071 | |
|
|
2072 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
2073 | |
|
|
2074 | Returns access, modification, change and birth time all in one go, and |
|
|
2075 | maybe more times in the future version. |
|
|
2076 | |
|
|
2077 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
2078 | |
|
|
2079 | Return the fractional access, modifcation, change or birth time, in nanoseconds, |
|
|
2080 | as an integer in the range C<0> to C<999999999>. |
|
|
2081 | |
|
|
2082 | Note that no accessors are provided for access, modification and |
|
|
2083 | change times - you need to get those from C<stat _> if required (C<int |
|
|
2084 | IO::AIO::st_atime> and so on will I<not> generally give you the correct |
|
|
2085 | value). |
|
|
2086 | |
|
|
2087 | =item $seconds = IO::AIO::st_btimesec |
|
|
2088 | |
|
|
2089 | The (integral) seconds part of the file birth time, if available. |
|
|
2090 | |
|
|
2091 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
2092 | |
|
|
2093 | Like the functions above, but returns all four times in one go (and maybe |
|
|
2094 | more in future versions). |
|
|
2095 | |
|
|
2096 | =item $counter = IO::AIO::st_gen |
|
|
2097 | |
|
|
2098 | Returns the generation counter (in practice this is just a random number) |
|
|
2099 | of the file. This is only available on platforms which have this member in |
|
|
2100 | their C<struct stat> (most BSDs at the time of this writing) and generally |
|
|
2101 | only to the root usert. If unsupported, C<0> is returned, but this might |
|
|
2102 | change to C<undef> in a future version. |
|
|
2103 | |
|
|
2104 | =back |
|
|
2105 | |
|
|
2106 | Example: print the high resolution modification time of F</etc>, using |
|
|
2107 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2108 | |
|
|
2109 | if (stat "/etc") { |
|
|
2110 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2111 | } |
|
|
2112 | |
|
|
2113 | IO::AIO::aio_stat "/etc", sub { |
|
|
2114 | $_[0] |
|
|
2115 | and return; |
|
|
2116 | |
|
|
2117 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2118 | }; |
|
|
2119 | |
|
|
2120 | IO::AIO::flush; |
|
|
2121 | |
|
|
2122 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2123 | |
|
|
2124 | stat(/etc) mtime: 1534043702.020808 |
|
|
2125 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2126 | |
2062 | |
2127 | |
2063 | =head3 MISCELLANEOUS FUNCTIONS |
2128 | =head3 MISCELLANEOUS FUNCTIONS |
2064 | |
2129 | |
2065 | IO::AIO implements some functions that are useful when you want to use |
2130 | IO::AIO implements some functions that are useful when you want to use |
2066 | some "Advanced I/O" function not available to in Perl, without going the |
2131 | some "Advanced I/O" function not available to in Perl, without going the |
… | |
… | |
2069 | |
2134 | |
2070 | =over 4 |
2135 | =over 4 |
2071 | |
2136 | |
2072 | =item $numfd = IO::AIO::get_fdlimit |
2137 | =item $numfd = IO::AIO::get_fdlimit |
2073 | |
2138 | |
|
|
2139 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2140 | |
2074 | Tries to find the current file descriptor limit and returns it, or |
2141 | Tries to find the current file descriptor limit and returns it, or |
2075 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2142 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2076 | the highest valid file descriptor number. |
2143 | the highest valid file descriptor number. |
2077 | |
2144 | |
2078 | =item IO::AIO::min_fdlimit [$numfd] |
2145 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2146 | |
|
|
2147 | This function is I<EXPERIMENTAL> and subject to change. |
2079 | |
2148 | |
2080 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2149 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2081 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2150 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2082 | is missing, it will try to set a very high limit, although this is not |
2151 | is missing, it will try to set a very high limit, although this is not |
2083 | recommended when you know the actual minimum that you require. |
2152 | recommended when you know the actual minimum that you require. |
… | |
… | |
2203 | |
2272 | |
2204 | =item IO::AIO::munmap $scalar |
2273 | =item IO::AIO::munmap $scalar |
2205 | |
2274 | |
2206 | Removes a previous mmap and undefines the C<$scalar>. |
2275 | Removes a previous mmap and undefines the C<$scalar>. |
2207 | |
2276 | |
|
|
2277 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2278 | |
|
|
2279 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2280 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2281 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2282 | |
|
|
2283 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2284 | region has changed address, then the true value has the numerical value |
|
|
2285 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2286 | |
|
|
2287 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2288 | or die "mremap: $!"; |
|
|
2289 | |
|
|
2290 | if ($success*1) { |
|
|
2291 | warn "scalar has chanegd address in memory\n"; |
|
|
2292 | } |
|
|
2293 | |
|
|
2294 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2295 | implemented, but not supported and might go away in a future version. |
|
|
2296 | |
|
|
2297 | On systems where this call is not supported or is not emulated, this call |
|
|
2298 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2299 | |
2208 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2300 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2209 | |
2301 | |
2210 | Calls the C<munlock> function, undoing the effects of a previous |
2302 | Calls the C<munlock> function, undoing the effects of a previous |
2211 | C<aio_mlock> call (see its description for details). |
2303 | C<aio_mlock> call (see its description for details). |
2212 | |
2304 | |
… | |
… | |
2261 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2353 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2262 | |
2354 | |
2263 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2355 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2264 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2356 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2265 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2357 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
|
|
2358 | |
|
|
2359 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2360 | |
|
|
2361 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2362 | or die "pipe2: $!\n"; |
|
|
2363 | |
|
|
2364 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2365 | |
|
|
2366 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2367 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2368 | |
|
|
2369 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2370 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2371 | |
|
|
2372 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2373 | |
|
|
2374 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2375 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2376 | |
|
|
2377 | Example: create a new eventfd filehandle: |
|
|
2378 | |
|
|
2379 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2380 | or die "eventfd: $!\n"; |
|
|
2381 | |
|
|
2382 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2383 | |
|
|
2384 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2385 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2386 | |
|
|
2387 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2388 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2389 | |
|
|
2390 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2391 | |
|
|
2392 | The following C<$clockid> values are |
|
|
2393 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2394 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2395 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2396 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2397 | |
|
|
2398 | The following C<$flags> values are available (Linux |
|
|
2399 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2400 | |
|
|
2401 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2402 | then wait for two alarms: |
|
|
2403 | |
|
|
2404 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2405 | or die "timerfd_create: $!\n"; |
|
|
2406 | |
|
|
2407 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2408 | or die "timerfd_settime: $!\n"; |
|
|
2409 | |
|
|
2410 | for (1..2) { |
|
|
2411 | 8 == sysread $fh, my $buf, 8 |
|
|
2412 | or die "timerfd read failure\n"; |
|
|
2413 | |
|
|
2414 | printf "number of expirations (likely 1): %d\n", |
|
|
2415 | unpack "Q", $buf; |
|
|
2416 | } |
|
|
2417 | |
|
|
2418 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2419 | |
|
|
2420 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2421 | call. Please refer to its manpage for more info on this call. |
|
|
2422 | |
|
|
2423 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2424 | values, C<$new_interval> and C<$new_value>). |
|
|
2425 | |
|
|
2426 | On success, the current interval and value are returned (as per |
|
|
2427 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2428 | |
|
|
2429 | The following C<$flags> values are |
|
|
2430 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2431 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2432 | |
|
|
2433 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2434 | |
|
|
2435 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2436 | |
|
|
2437 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2438 | call. Please refer to its manpage for more info on this call. |
|
|
2439 | |
|
|
2440 | On success, returns the current values of interval and value for the given |
|
|
2441 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2442 | list is returned. |
2266 | |
2443 | |
2267 | =back |
2444 | =back |
2268 | |
2445 | |
2269 | =cut |
2446 | =cut |
2270 | |
2447 | |
… | |
… | |
2336 | the process will result in undefined behaviour. Calling it at any time |
2513 | the process will result in undefined behaviour. Calling it at any time |
2337 | will also result in any undefined (by POSIX) behaviour. |
2514 | will also result in any undefined (by POSIX) behaviour. |
2338 | |
2515 | |
2339 | =back |
2516 | =back |
2340 | |
2517 | |
|
|
2518 | =head2 LINUX-SPECIFIC CALLS |
|
|
2519 | |
|
|
2520 | When a call is documented as "linux-specific" then this means it |
|
|
2521 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2522 | availability and compatibility of such calls regardless of the platform |
|
|
2523 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2524 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2525 | C<ENOSYS>. |
|
|
2526 | |
2341 | =head2 MEMORY USAGE |
2527 | =head2 MEMORY USAGE |
2342 | |
2528 | |
2343 | Per-request usage: |
2529 | Per-request usage: |
2344 | |
2530 | |
2345 | Each aio request uses - depending on your architecture - around 100-200 |
2531 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2357 | temporary buffers, and each thread requires a stack and other data |
2543 | temporary buffers, and each thread requires a stack and other data |
2358 | structures (usually around 16k-128k, depending on the OS). |
2544 | structures (usually around 16k-128k, depending on the OS). |
2359 | |
2545 | |
2360 | =head1 KNOWN BUGS |
2546 | =head1 KNOWN BUGS |
2361 | |
2547 | |
2362 | Known bugs will be fixed in the next release. |
2548 | Known bugs will be fixed in the next release :) |
|
|
2549 | |
|
|
2550 | =head1 KNOWN ISSUES |
|
|
2551 | |
|
|
2552 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2553 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2554 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2555 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2556 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2557 | |
|
|
2558 | I am not sure anything can be done about this, so this is considered a |
|
|
2559 | known issue, rather than a bug. |
2363 | |
2560 | |
2364 | =head1 SEE ALSO |
2561 | =head1 SEE ALSO |
2365 | |
2562 | |
2366 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2563 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2367 | more natural syntax. |
2564 | more natural syntax. |