… | |
… | |
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.41; |
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] |
|
|
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
282 | |
285 | |
283 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
284 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
285 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
286 | IO::AIO::munmap $scalar |
289 | IO::AIO::munmap $scalar |
|
|
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
287 | IO::AIO::madvise $scalar, $offset, $length, $advice |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
288 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
289 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
290 | IO::AIO::munlockall |
294 | IO::AIO::munlockall |
291 | |
295 | |
… | |
… | |
609 | namemax => 255, |
613 | namemax => 255, |
610 | frsize => 1024, |
614 | frsize => 1024, |
611 | fsid => 1810 |
615 | fsid => 1810 |
612 | } |
616 | } |
613 | |
617 | |
614 | Here is a (likely partial - send me updates!) list of fsid values used by |
|
|
615 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
|
|
616 | |
|
|
617 | 0x0000adf5 adfs |
|
|
618 | 0x0000adff affs |
|
|
619 | 0x5346414f afs |
|
|
620 | 0x09041934 anon-inode filesystem |
|
|
621 | 0x00000187 autofs |
|
|
622 | 0x42465331 befs |
|
|
623 | 0x1badface bfs |
|
|
624 | 0x42494e4d binfmt_misc |
|
|
625 | 0x9123683e btrfs |
|
|
626 | 0x0027e0eb cgroupfs |
|
|
627 | 0xff534d42 cifs |
|
|
628 | 0x73757245 coda |
|
|
629 | 0x012ff7b7 coh |
|
|
630 | 0x28cd3d45 cramfs |
|
|
631 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
632 | 0x64626720 debugfs |
|
|
633 | 0x00001373 devfs |
|
|
634 | 0x00001cd1 devpts |
|
|
635 | 0x0000f15f ecryptfs |
|
|
636 | 0x00414a53 efs |
|
|
637 | 0x0000137d ext |
|
|
638 | 0x0000ef53 ext2/ext3/ext4 |
|
|
639 | 0x0000ef51 ext2 |
|
|
640 | 0xf2f52010 f2fs |
|
|
641 | 0x00004006 fat |
|
|
642 | 0x65735546 fuseblk |
|
|
643 | 0x65735543 fusectl |
|
|
644 | 0x0bad1dea futexfs |
|
|
645 | 0x01161970 gfs2 |
|
|
646 | 0x47504653 gpfs |
|
|
647 | 0x00004244 hfs |
|
|
648 | 0xf995e849 hpfs |
|
|
649 | 0x00c0ffee hostfs |
|
|
650 | 0x958458f6 hugetlbfs |
|
|
651 | 0x2bad1dea inotifyfs |
|
|
652 | 0x00009660 isofs |
|
|
653 | 0x000072b6 jffs2 |
|
|
654 | 0x3153464a jfs |
|
|
655 | 0x6b414653 k-afs |
|
|
656 | 0x0bd00bd0 lustre |
|
|
657 | 0x0000137f minix |
|
|
658 | 0x0000138f minix 30 char names |
|
|
659 | 0x00002468 minix v2 |
|
|
660 | 0x00002478 minix v2 30 char names |
|
|
661 | 0x00004d5a minix v3 |
|
|
662 | 0x19800202 mqueue |
|
|
663 | 0x00004d44 msdos |
|
|
664 | 0x0000564c novell |
|
|
665 | 0x00006969 nfs |
|
|
666 | 0x6e667364 nfsd |
|
|
667 | 0x00003434 nilfs |
|
|
668 | 0x5346544e ntfs |
|
|
669 | 0x00009fa1 openprom |
|
|
670 | 0x7461636F ocfs2 |
|
|
671 | 0x00009fa0 proc |
|
|
672 | 0x6165676c pstorefs |
|
|
673 | 0x0000002f qnx4 |
|
|
674 | 0x68191122 qnx6 |
|
|
675 | 0x858458f6 ramfs |
|
|
676 | 0x52654973 reiserfs |
|
|
677 | 0x00007275 romfs |
|
|
678 | 0x67596969 rpc_pipefs |
|
|
679 | 0x73636673 securityfs |
|
|
680 | 0xf97cff8c selinux |
|
|
681 | 0x0000517b smb |
|
|
682 | 0x534f434b sockfs |
|
|
683 | 0x73717368 squashfs |
|
|
684 | 0x62656572 sysfs |
|
|
685 | 0x012ff7b6 sysv2 |
|
|
686 | 0x012ff7b5 sysv4 |
|
|
687 | 0x01021994 tmpfs |
|
|
688 | 0x15013346 udf |
|
|
689 | 0x00011954 ufs |
|
|
690 | 0x54190100 ufs byteswapped |
|
|
691 | 0x00009fa2 usbdevfs |
|
|
692 | 0x01021997 v9fs |
|
|
693 | 0xa501fcf5 vxfs |
|
|
694 | 0xabba1974 xenfs |
|
|
695 | 0x012ff7b4 xenix |
|
|
696 | 0x58465342 xfs |
|
|
697 | 0x012fd16d xia |
|
|
698 | |
|
|
699 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
618 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
700 | |
619 | |
701 | Works like perl's C<utime> function (including the special case of $atime |
620 | Works like perl's C<utime> function (including the special case of $atime |
702 | and $mtime being undef). Fractional times are supported if the underlying |
621 | and $mtime being undef). Fractional times are supported if the underlying |
703 | syscalls support them. |
622 | syscalls support them. |
… | |
… | |
740 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
659 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
741 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
660 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
742 | to deallocate a file range. |
661 | to deallocate a file range. |
743 | |
662 | |
744 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
663 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
745 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
664 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
746 | your L<fallocate(2)> manpage). |
665 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
666 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
747 | |
667 | |
748 | The file system block size used by C<fallocate> is presumably the |
668 | The file system block size used by C<fallocate> is presumably the |
749 | C<f_bsize> returned by C<statvfs>. |
669 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
670 | can dictate other limitations. |
750 | |
671 | |
751 | If C<fallocate> isn't available or cannot be emulated (currently no |
672 | If C<fallocate> isn't available or cannot be emulated (currently no |
752 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
673 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
753 | |
674 | |
754 | |
675 | |
… | |
… | |
869 | |
790 | |
870 | =over 4 |
791 | =over 4 |
871 | |
792 | |
872 | =item IO::AIO::READDIR_DENTS |
793 | =item IO::AIO::READDIR_DENTS |
873 | |
794 | |
874 | When this flag is off, then the callback gets an arrayref consisting of |
795 | Normally the callback gets an arrayref consisting of names only (as |
875 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
796 | with C<aio_readdir>). If this flag is set, then the callback gets an |
876 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
797 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
877 | entry in more detail. |
798 | single directory entry in more detail: |
878 | |
799 | |
879 | C<$name> is the name of the entry. |
800 | C<$name> is the name of the entry. |
880 | |
801 | |
881 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
802 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
882 | |
803 | |
883 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
804 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
884 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
805 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
885 | C<IO::AIO::DT_WHT>. |
806 | C<IO::AIO::DT_WHT>. |
886 | |
807 | |
887 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
808 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
888 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
809 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
889 | scalars are read-only: you can not modify them. |
810 | the C<$type> scalars are read-only: you must not modify them. |
890 | |
811 | |
891 | C<$inode> is the inode number (which might not be exact on systems with 64 |
812 | C<$inode> is the inode number (which might not be exact on systems with 64 |
892 | bit inode numbers and 32 bit perls). This field has unspecified content on |
813 | bit inode numbers and 32 bit perls). This field has unspecified content on |
893 | systems that do not deliver the inode information. |
814 | systems that do not deliver the inode information. |
894 | |
815 | |
… | |
… | |
905 | short names are tried first. |
826 | short names are tried first. |
906 | |
827 | |
907 | =item IO::AIO::READDIR_STAT_ORDER |
828 | =item IO::AIO::READDIR_STAT_ORDER |
908 | |
829 | |
909 | When this flag is set, then the names will be returned in an order |
830 | When this flag is set, then the names will be returned in an order |
910 | suitable for stat()'ing each one. That is, when you plan to stat() |
831 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
911 | all files in the given directory, then the returned order will likely |
832 | all files in the given directory, then the returned order will likely be |
912 | be fastest. |
833 | faster. |
913 | |
834 | |
914 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
835 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
915 | the likely dirs come first, resulting in a less optimal stat order. |
836 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
837 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
838 | subdirectories. |
916 | |
839 | |
917 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
840 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
918 | |
841 | |
919 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
842 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
920 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
843 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
922 | C<$type>'s are known, which can be used to speed up some algorithms. |
845 | C<$type>'s are known, which can be used to speed up some algorithms. |
923 | |
846 | |
924 | =back |
847 | =back |
925 | |
848 | |
926 | |
849 | |
|
|
850 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
851 | |
|
|
852 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
853 | which is resized as required. |
|
|
854 | |
|
|
855 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
856 | |
|
|
857 | If C<$length> is zero, then the remaining length of the file is |
|
|
858 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
859 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
860 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
861 | C<$length> results in a performance advantage. |
|
|
862 | |
|
|
863 | This request is similar to the older C<aio_load> request, but since it is |
|
|
864 | a single request, it might be more efficient to use. |
|
|
865 | |
|
|
866 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
867 | |
|
|
868 | my $passwd; |
|
|
869 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
870 | $_[0] >= 0 |
|
|
871 | or die "/etc/passwd: $!\n"; |
|
|
872 | |
|
|
873 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
874 | print $passwd; |
|
|
875 | }; |
|
|
876 | IO::AIO::flush; |
|
|
877 | |
|
|
878 | |
927 | =item aio_load $pathname, $data, $callback->($status) |
879 | =item aio_load $pathname, $data, $callback->($status) |
928 | |
880 | |
929 | This is a composite request that tries to fully load the given file into |
881 | This is a composite request that tries to fully load the given file into |
930 | memory. Status is the same as with aio_read. |
882 | memory. Status is the same as with aio_read. |
|
|
883 | |
|
|
884 | Using C<aio_slurp> might be more efficient, as it is a single request. |
931 | |
885 | |
932 | =cut |
886 | =cut |
933 | |
887 | |
934 | sub aio_load($$;$) { |
888 | sub aio_load($$;$) { |
935 | my ($path, undef, $cb) = @_; |
889 | my ($path, undef, $cb) = @_; |
… | |
… | |
955 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
909 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
956 | |
910 | |
957 | Try to copy the I<file> (directories not supported as either source or |
911 | Try to copy the I<file> (directories not supported as either source or |
958 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
912 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
959 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
913 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
914 | |
|
|
915 | Existing destination files will be truncated. |
960 | |
916 | |
961 | This is a composite request that creates the destination file with |
917 | This is a composite request that creates the destination file with |
962 | mode 0200 and copies the contents of the source file into it using |
918 | mode 0200 and copies the contents of the source file into it using |
963 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
919 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
964 | uid/gid, in that order. |
920 | uid/gid, in that order. |
… | |
… | |
1074 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1030 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1075 | efficiently separate the entries of directory C<$path> into two sets of |
1031 | efficiently separate the entries of directory C<$path> into two sets of |
1076 | names, directories you can recurse into (directories), and ones you cannot |
1032 | names, directories you can recurse into (directories), and ones you cannot |
1077 | recurse into (everything else, including symlinks to directories). |
1033 | recurse into (everything else, including symlinks to directories). |
1078 | |
1034 | |
1079 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1035 | C<aio_scandir> is a composite request that generates many sub requests. |
1080 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1036 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1081 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1037 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1082 | will be chosen (currently 4). |
1038 | will be chosen (currently 4). |
1083 | |
1039 | |
1084 | On error, the callback is called without arguments, otherwise it receives |
1040 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1477 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1433 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1478 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1434 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1479 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1435 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1480 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1436 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1481 | |
1437 | |
1482 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1438 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1483 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1439 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1484 | it to return all extents of a range for files with large number of |
1440 | it to return all extents of a range for files with a large number of |
1485 | extents. The code works around all these issues if C<$count> is undef. |
1441 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1442 | C<undef>. |
1486 | |
1443 | |
1487 | =item aio_group $callback->(...) |
1444 | =item aio_group $callback->(...) |
1488 | |
1445 | |
1489 | This is a very special aio request: Instead of doing something, it is a |
1446 | This is a very special aio request: Instead of doing something, it is a |
1490 | container for other aio requests, which is useful if you want to bundle |
1447 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1603 | There are some caveats: when directories get renamed (or deleted), the |
1560 | There are some caveats: when directories get renamed (or deleted), the |
1604 | pathname string doesn't change, so will point to the new directory (or |
1561 | pathname string doesn't change, so will point to the new directory (or |
1605 | nowhere at all), while the directory fd, if available on the system, |
1562 | nowhere at all), while the directory fd, if available on the system, |
1606 | will still point to the original directory. Most functions accepting a |
1563 | will still point to the original directory. Most functions accepting a |
1607 | pathname will use the directory fd on newer systems, and the string on |
1564 | pathname will use the directory fd on newer systems, and the string on |
1608 | older systems. Some functions (such as realpath) will always rely on the |
1565 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1609 | string form of the pathname. |
1566 | the string form of the pathname. |
1610 | |
1567 | |
1611 | So this functionality is mainly useful to get some protection against |
1568 | So this functionality is mainly useful to get some protection against |
1612 | C<chdir>, to easily get an absolute path out of a relative path for future |
1569 | C<chdir>, to easily get an absolute path out of a relative path for future |
1613 | reference, and to speed up doing many operations in the same directory |
1570 | reference, and to speed up doing many operations in the same directory |
1614 | (e.g. when stat'ing all files in a directory). |
1571 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
2006 | This is a very bad function to use in interactive programs because it |
1963 | This is a very bad function to use in interactive programs because it |
2007 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1964 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2008 | use an C<aio_group> together with a feed callback. |
1965 | use an C<aio_group> together with a feed callback. |
2009 | |
1966 | |
2010 | Its main use is in scripts without an event loop - when you want to stat |
1967 | Its main use is in scripts without an event loop - when you want to stat |
2011 | a lot of files, you can write somehting like this: |
1968 | a lot of files, you can write something like this: |
2012 | |
1969 | |
2013 | IO::AIO::max_outstanding 32; |
1970 | IO::AIO::max_outstanding 32; |
2014 | |
1971 | |
2015 | for my $path (...) { |
1972 | for my $path (...) { |
2016 | aio_stat $path , ...; |
1973 | aio_stat $path , ...; |
… | |
… | |
2061 | some "Advanced I/O" function not available to in Perl, without going the |
2018 | some "Advanced I/O" function not available to in Perl, without going the |
2062 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2019 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2063 | counterpart. |
2020 | counterpart. |
2064 | |
2021 | |
2065 | =over 4 |
2022 | =over 4 |
|
|
2023 | |
|
|
2024 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2025 | |
|
|
2026 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2027 | |
|
|
2028 | Tries to find the current file descriptor limit and returns it, or |
|
|
2029 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2030 | the highest valid file descriptor number. |
|
|
2031 | |
|
|
2032 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2033 | |
|
|
2034 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2035 | |
|
|
2036 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2037 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2038 | is missing, it will try to set a very high limit, although this is not |
|
|
2039 | recommended when you know the actual minimum that you require. |
|
|
2040 | |
|
|
2041 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2042 | attempt to increase the limit as much as possible, using various |
|
|
2043 | tricks, while still failing. You can query the resulting limit using |
|
|
2044 | C<IO::AIO::get_fdlimit>. |
|
|
2045 | |
|
|
2046 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2047 | true. |
2066 | |
2048 | |
2067 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2049 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2068 | |
2050 | |
2069 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2051 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2070 | but is blocking (this makes most sense if you know the input data is |
2052 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2087 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2069 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2088 | |
2070 | |
2089 | Simply calls the C<posix_madvise> function (see its |
2071 | Simply calls the C<posix_madvise> function (see its |
2090 | manpage for details). The following advice constants are |
2072 | manpage for details). The following advice constants are |
2091 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2073 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2092 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, |
2074 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
2093 | C<IO::AIO::MADV_FREE>. |
2075 | C<IO::AIO::MADV_DONTNEED>. |
2094 | |
2076 | |
2095 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
2077 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
2096 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
2078 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
2097 | will be reduced to fit into the C<$scalar>. |
2079 | will be reduced to fit into the C<$scalar>. |
2098 | |
2080 | |
… | |
… | |
2177 | |
2159 | |
2178 | =item IO::AIO::munmap $scalar |
2160 | =item IO::AIO::munmap $scalar |
2179 | |
2161 | |
2180 | Removes a previous mmap and undefines the C<$scalar>. |
2162 | Removes a previous mmap and undefines the C<$scalar>. |
2181 | |
2163 | |
|
|
2164 | =item IO::AIO::mremap $scalar, $new_length, $flags = 0[, $new_address = 0] |
|
|
2165 | |
|
|
2166 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2167 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2168 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2169 | |
|
|
2170 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2171 | region has changed address, then the true value has the numerical value |
|
|
2172 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2173 | |
|
|
2174 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2175 | or die "mremap: $!"; |
|
|
2176 | |
|
|
2177 | if ($success*1) { |
|
|
2178 | warn "scalar has chanegd address in memory\n"; |
|
|
2179 | } |
|
|
2180 | |
|
|
2181 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2182 | implemented, but not supported and might go away in a future version. |
|
|
2183 | |
|
|
2184 | On systems where this call is not supported or is not emulated, this call |
|
|
2185 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2186 | |
2182 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2187 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2183 | |
2188 | |
2184 | Calls the C<munlock> function, undoing the effects of a previous |
2189 | Calls the C<munlock> function, undoing the effects of a previous |
2185 | C<aio_mlock> call (see its description for details). |
2190 | C<aio_mlock> call (see its description for details). |
2186 | |
2191 | |
… | |
… | |
2235 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2240 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2236 | |
2241 | |
2237 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2242 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2238 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2243 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
2239 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2244 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
|
|
2245 | |
|
|
2246 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2247 | |
|
|
2248 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2249 | or die "pipe2: $!\n"; |
|
|
2250 | |
|
|
2251 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2252 | |
|
|
2253 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2254 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2255 | |
|
|
2256 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2257 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2258 | |
|
|
2259 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2260 | |
|
|
2261 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2262 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2263 | |
|
|
2264 | Example: create a new eventfd filehandle: |
|
|
2265 | |
|
|
2266 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2267 | or die "eventfd: $!\n"; |
|
|
2268 | |
|
|
2269 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2270 | |
|
|
2271 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2272 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2273 | |
|
|
2274 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2275 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2276 | |
|
|
2277 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2278 | |
|
|
2279 | The following C<$clockid> values are |
|
|
2280 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2281 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2282 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2283 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2284 | |
|
|
2285 | The following C<$flags> values are available (Linux |
|
|
2286 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2287 | |
|
|
2288 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2289 | then wait for two alarms: |
|
|
2290 | |
|
|
2291 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2292 | or die "timerfd_create: $!\n"; |
|
|
2293 | |
|
|
2294 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2295 | or die "timerfd_settime: $!\n"; |
|
|
2296 | |
|
|
2297 | for (1..2) { |
|
|
2298 | 8 == sysread $fh, my $buf, 8 |
|
|
2299 | or die "timerfd read failure\n"; |
|
|
2300 | |
|
|
2301 | printf "number of expirations (likely 1): %d\n", |
|
|
2302 | unpack "Q", $buf; |
|
|
2303 | } |
|
|
2304 | |
|
|
2305 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2306 | |
|
|
2307 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2308 | call. Please refer to its manpage for more info on this call. |
|
|
2309 | |
|
|
2310 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2311 | values, C<$new_interval> and C<$new_value>). |
|
|
2312 | |
|
|
2313 | On success, the current interval and value are returned (as per |
|
|
2314 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2315 | |
|
|
2316 | The following C<$flags> values are |
|
|
2317 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2318 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2319 | |
|
|
2320 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2321 | |
|
|
2322 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2323 | |
|
|
2324 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2325 | call. Please refer to its manpage for more info on this call. |
|
|
2326 | |
|
|
2327 | On success, returns the current values of interval and value for the given |
|
|
2328 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2329 | list is returned. |
2240 | |
2330 | |
2241 | =back |
2331 | =back |
2242 | |
2332 | |
2243 | =cut |
2333 | =cut |
2244 | |
2334 | |
… | |
… | |
2310 | the process will result in undefined behaviour. Calling it at any time |
2400 | the process will result in undefined behaviour. Calling it at any time |
2311 | will also result in any undefined (by POSIX) behaviour. |
2401 | will also result in any undefined (by POSIX) behaviour. |
2312 | |
2402 | |
2313 | =back |
2403 | =back |
2314 | |
2404 | |
|
|
2405 | =head2 LINUX-SPECIFIC CALLS |
|
|
2406 | |
|
|
2407 | When a call is documented as "linux-specific" then this means it |
|
|
2408 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2409 | availability and compatibility of such calls regardless of the platform |
|
|
2410 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2411 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2412 | C<ENOSYS>. |
|
|
2413 | |
2315 | =head2 MEMORY USAGE |
2414 | =head2 MEMORY USAGE |
2316 | |
2415 | |
2317 | Per-request usage: |
2416 | Per-request usage: |
2318 | |
2417 | |
2319 | Each aio request uses - depending on your architecture - around 100-200 |
2418 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2331 | temporary buffers, and each thread requires a stack and other data |
2430 | temporary buffers, and each thread requires a stack and other data |
2332 | structures (usually around 16k-128k, depending on the OS). |
2431 | structures (usually around 16k-128k, depending on the OS). |
2333 | |
2432 | |
2334 | =head1 KNOWN BUGS |
2433 | =head1 KNOWN BUGS |
2335 | |
2434 | |
2336 | Known bugs will be fixed in the next release. |
2435 | Known bugs will be fixed in the next release :) |
|
|
2436 | |
|
|
2437 | =head1 KNOWN ISSUES |
|
|
2438 | |
|
|
2439 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2440 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2441 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2442 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2443 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2444 | |
|
|
2445 | I am not sure anything can be done about this, so this is considered a |
|
|
2446 | known issue, rather than a bug. |
2337 | |
2447 | |
2338 | =head1 SEE ALSO |
2448 | =head1 SEE ALSO |
2339 | |
2449 | |
2340 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2450 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2341 | more natural syntax. |
2451 | more natural syntax. |