… | |
… | |
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] |
|
|
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 | |
… | |
… | |
401 | following POSIX and non-POSIX constants are available (missing ones on |
405 | following POSIX and non-POSIX constants are available (missing ones on |
402 | your system are, as usual, C<0>): |
406 | your system are, as usual, C<0>): |
403 | |
407 | |
404 | 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>, |
405 | 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>, |
406 | 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>. |
407 | |
411 | |
408 | |
412 | |
409 | =item aio_close $fh, $callback->($status) |
413 | =item aio_close $fh, $callback->($status) |
410 | |
414 | |
411 | Asynchronously close a file and call the callback with the result |
415 | Asynchronously close a file and call the callback with the result |
… | |
… | |
537 | |
541 | |
538 | =item aio_stat $fh_or_path, $callback->($status) |
542 | =item aio_stat $fh_or_path, $callback->($status) |
539 | |
543 | |
540 | =item aio_lstat $fh, $callback->($status) |
544 | =item aio_lstat $fh, $callback->($status) |
541 | |
545 | |
542 | 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 |
543 | 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 |
544 | or C<-s _> etc... |
548 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
|
|
549 | and C<-T>). |
545 | |
550 | |
546 | 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, |
547 | for an explanation. |
552 | for an explanation. |
548 | |
553 | |
549 | 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 |
… | |
… | |
556 | behaviour). |
561 | behaviour). |
557 | |
562 | |
558 | 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>, |
559 | 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>, |
560 | 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>. |
561 | |
569 | |
562 | Example: Print the length of F</etc/passwd>: |
570 | Example: Print the length of F</etc/passwd>: |
563 | |
571 | |
564 | aio_stat "/etc/passwd", sub { |
572 | aio_stat "/etc/passwd", sub { |
565 | $_[0] and die "stat failed: $!"; |
573 | $_[0] and die "stat failed: $!"; |
… | |
… | |
609 | namemax => 255, |
617 | namemax => 255, |
610 | frsize => 1024, |
618 | frsize => 1024, |
611 | fsid => 1810 |
619 | fsid => 1810 |
612 | } |
620 | } |
613 | |
621 | |
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) |
622 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
700 | |
623 | |
701 | 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 |
702 | and $mtime being undef). Fractional times are supported if the underlying |
625 | and $mtime being undef). Fractional times are supported if the underlying |
703 | syscalls support them. |
626 | syscalls support them. |
704 | |
627 | |
705 | 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, |
706 | 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) |
707 | otherwise returns ENOSYS, so this is not portable. |
630 | or futimes(2) if available, otherwise returns ENOSYS, so this is not |
|
|
631 | portable. |
708 | |
632 | |
709 | Examples: |
633 | Examples: |
710 | |
634 | |
711 | # set atime and mtime to current time (basically touch(1)): |
635 | # set atime and mtime to current time (basically touch(1)): |
712 | aio_utime "path", undef, undef; |
636 | aio_utime "path", undef, undef; |
… | |
… | |
740 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
664 | 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>, |
665 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
742 | to deallocate a file range. |
666 | to deallocate a file range. |
743 | |
667 | |
744 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
668 | 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 |
669 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
746 | your L<fallocate(2)> manpage). |
670 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
671 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
747 | |
672 | |
748 | The file system block size used by C<fallocate> is presumably the |
673 | The file system block size used by C<fallocate> is presumably the |
749 | C<f_bsize> returned by C<statvfs>. |
674 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
675 | can dictate other limitations. |
750 | |
676 | |
751 | If C<fallocate> isn't available or cannot be emulated (currently no |
677 | 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>. |
678 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
753 | |
679 | |
754 | |
680 | |
… | |
… | |
869 | |
795 | |
870 | =over 4 |
796 | =over 4 |
871 | |
797 | |
872 | =item IO::AIO::READDIR_DENTS |
798 | =item IO::AIO::READDIR_DENTS |
873 | |
799 | |
874 | 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 |
875 | 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 |
876 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
802 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
877 | entry in more detail. |
803 | single directory entry in more detail: |
878 | |
804 | |
879 | C<$name> is the name of the entry. |
805 | C<$name> is the name of the entry. |
880 | |
806 | |
881 | 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: |
882 | |
808 | |
883 | 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>, |
884 | 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>, |
885 | C<IO::AIO::DT_WHT>. |
811 | C<IO::AIO::DT_WHT>. |
886 | |
812 | |
887 | 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 |
888 | 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, |
889 | scalars are read-only: you can not modify them. |
815 | the C<$type> scalars are read-only: you must not modify them. |
890 | |
816 | |
891 | 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 |
892 | 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 |
893 | systems that do not deliver the inode information. |
819 | systems that do not deliver the inode information. |
894 | |
820 | |
… | |
… | |
905 | short names are tried first. |
831 | short names are tried first. |
906 | |
832 | |
907 | =item IO::AIO::READDIR_STAT_ORDER |
833 | =item IO::AIO::READDIR_STAT_ORDER |
908 | |
834 | |
909 | 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 |
910 | 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 |
911 | 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 |
912 | be fastest. |
838 | faster. |
913 | |
839 | |
914 | 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, |
915 | 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. |
916 | |
844 | |
917 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
845 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
918 | |
846 | |
919 | 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 |
920 | 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 |
… | |
… | |
922 | 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. |
923 | |
851 | |
924 | =back |
852 | =back |
925 | |
853 | |
926 | |
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 | |
927 | =item aio_load $pathname, $data, $callback->($status) |
884 | =item aio_load $pathname, $data, $callback->($status) |
928 | |
885 | |
929 | 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 |
930 | 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. |
931 | |
890 | |
932 | =cut |
891 | =cut |
933 | |
892 | |
934 | sub aio_load($$;$) { |
893 | sub aio_load($$;$) { |
935 | my ($path, undef, $cb) = @_; |
894 | my ($path, undef, $cb) = @_; |
… | |
… | |
955 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
914 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
956 | |
915 | |
957 | Try to copy the I<file> (directories not supported as either source or |
916 | 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 |
917 | 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<$!>). |
918 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
919 | |
|
|
920 | Existing destination files will be truncated. |
960 | |
921 | |
961 | This is a composite request that creates the destination file with |
922 | 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 |
923 | 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 |
924 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
964 | uid/gid, in that order. |
925 | uid/gid, in that order. |
… | |
… | |
1074 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1035 | 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 |
1036 | efficiently separate the entries of directory C<$path> into two sets of |
1076 | names, directories you can recurse into (directories), and ones you cannot |
1037 | names, directories you can recurse into (directories), and ones you cannot |
1077 | recurse into (everything else, including symlinks to directories). |
1038 | recurse into (everything else, including symlinks to directories). |
1078 | |
1039 | |
1079 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1040 | C<aio_scandir> is a composite request that generates many sub requests. |
1080 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1041 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1081 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1042 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1082 | will be chosen (currently 4). |
1043 | will be chosen (currently 4). |
1083 | |
1044 | |
1084 | On error, the callback is called without arguments, otherwise it receives |
1045 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1424 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1385 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1425 | aio_mlock $data; # mlock in background |
1386 | aio_mlock $data; # mlock in background |
1426 | |
1387 | |
1427 | =item aio_mlockall $flags, $callback->($status) |
1388 | =item aio_mlockall $flags, $callback->($status) |
1428 | |
1389 | |
1429 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1390 | Calls the C<mlockall> function with the given C<$flags> (a |
1430 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1391 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1392 | C<IO::AIO::MCL_ONFAULT>). |
1431 | |
1393 | |
1432 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1394 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1433 | and sets errno to C<ENOSYS>. |
1395 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1396 | by the system result in a return value of C<-1> with errno being set to |
|
|
1397 | C<EINVAL>. |
1434 | |
1398 | |
1435 | Note that the corresponding C<munlockall> is synchronous and is |
1399 | Note that the corresponding C<munlockall> is synchronous and is |
1436 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1400 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1437 | |
1401 | |
1438 | Example: asynchronously lock all current and future pages into memory. |
1402 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1477 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1441 | 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>, |
1442 | 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 |
1443 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1480 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1444 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1481 | |
1445 | |
1482 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1446 | 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 |
1447 | 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 |
1448 | 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. |
1449 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1450 | C<undef>. |
1486 | |
1451 | |
1487 | =item aio_group $callback->(...) |
1452 | =item aio_group $callback->(...) |
1488 | |
1453 | |
1489 | This is a very special aio request: Instead of doing something, it is a |
1454 | 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 |
1455 | 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 |
1568 | 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 |
1569 | 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, |
1570 | nowhere at all), while the directory fd, if available on the system, |
1606 | will still point to the original directory. Most functions accepting a |
1571 | 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 |
1572 | 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 |
1573 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1609 | string form of the pathname. |
1574 | the string form of the pathname. |
1610 | |
1575 | |
1611 | So this functionality is mainly useful to get some protection against |
1576 | 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 |
1577 | 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 |
1578 | reference, and to speed up doing many operations in the same directory |
1614 | (e.g. when stat'ing all files in a directory). |
1579 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1822 | The default value for the limit is C<0>, but note that setting a feeder |
1787 | The default value for the limit is C<0>, but note that setting a feeder |
1823 | automatically bumps it up to C<2>. |
1788 | automatically bumps it up to C<2>. |
1824 | |
1789 | |
1825 | =back |
1790 | =back |
1826 | |
1791 | |
|
|
1792 | |
1827 | =head2 SUPPORT FUNCTIONS |
1793 | =head2 SUPPORT FUNCTIONS |
1828 | |
1794 | |
1829 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1795 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1830 | |
1796 | |
1831 | =over 4 |
1797 | =over 4 |
… | |
… | |
1896 | Strictly equivalent to: |
1862 | Strictly equivalent to: |
1897 | |
1863 | |
1898 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1864 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1899 | while IO::AIO::nreqs; |
1865 | while IO::AIO::nreqs; |
1900 | |
1866 | |
|
|
1867 | This function can be useful at program aborts, to make sure outstanding |
|
|
1868 | I/O has been done (C<IO::AIO> uses an C<END> block which already calls |
|
|
1869 | this function on normal exits), or when you are merely using C<IO::AIO> |
|
|
1870 | for its more advanced functions, rather than for async I/O, e.g.: |
|
|
1871 | |
|
|
1872 | my ($dirs, $nondirs); |
|
|
1873 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1874 | IO::AIO::flush; |
|
|
1875 | # $dirs, $nondirs are now set |
|
|
1876 | |
1901 | =item IO::AIO::max_poll_reqs $nreqs |
1877 | =item IO::AIO::max_poll_reqs $nreqs |
1902 | |
1878 | |
1903 | =item IO::AIO::max_poll_time $seconds |
1879 | =item IO::AIO::max_poll_time $seconds |
1904 | |
1880 | |
1905 | These set the maximum number of requests (default C<0>, meaning infinity) |
1881 | These set the maximum number of requests (default C<0>, meaning infinity) |
… | |
… | |
1931 | poll => 'r', nice => 1, |
1907 | poll => 'r', nice => 1, |
1932 | cb => &IO::AIO::poll_cb); |
1908 | cb => &IO::AIO::poll_cb); |
1933 | |
1909 | |
1934 | =back |
1910 | =back |
1935 | |
1911 | |
|
|
1912 | |
1936 | =head3 CONTROLLING THE NUMBER OF THREADS |
1913 | =head3 CONTROLLING THE NUMBER OF THREADS |
1937 | |
1914 | |
1938 | =over |
1915 | =over |
1939 | |
1916 | |
1940 | =item IO::AIO::min_parallel $nthreads |
1917 | =item IO::AIO::min_parallel $nthreads |
… | |
… | |
2006 | This is a very bad function to use in interactive programs because it |
1983 | 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 |
1984 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2008 | use an C<aio_group> together with a feed callback. |
1985 | use an C<aio_group> together with a feed callback. |
2009 | |
1986 | |
2010 | Its main use is in scripts without an event loop - when you want to stat |
1987 | 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: |
1988 | a lot of files, you can write something like this: |
2012 | |
1989 | |
2013 | IO::AIO::max_outstanding 32; |
1990 | IO::AIO::max_outstanding 32; |
2014 | |
1991 | |
2015 | for my $path (...) { |
1992 | for my $path (...) { |
2016 | aio_stat $path , ...; |
1993 | aio_stat $path , ...; |
… | |
… | |
2027 | The default value for C<max_outstanding> is very large, so there is no |
2004 | The default value for C<max_outstanding> is very large, so there is no |
2028 | practical limit on the number of outstanding requests. |
2005 | practical limit on the number of outstanding requests. |
2029 | |
2006 | |
2030 | =back |
2007 | =back |
2031 | |
2008 | |
|
|
2009 | |
2032 | =head3 STATISTICAL INFORMATION |
2010 | =head3 STATISTICAL INFORMATION |
2033 | |
2011 | |
2034 | =over |
2012 | =over |
2035 | |
2013 | |
2036 | =item IO::AIO::nreqs |
2014 | =item IO::AIO::nreqs |
… | |
… | |
2052 | |
2030 | |
2053 | Returns the number of requests currently in the pending state (executed, |
2031 | Returns the number of requests currently in the pending state (executed, |
2054 | but not yet processed by poll_cb). |
2032 | but not yet processed by poll_cb). |
2055 | |
2033 | |
2056 | =back |
2034 | =back |
|
|
2035 | |
|
|
2036 | |
|
|
2037 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2038 | |
|
|
2039 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
|
|
2040 | generally find access/modification and change times with subsecond time |
|
|
2041 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2042 | return the integer part. |
|
|
2043 | |
|
|
2044 | The following functions return the timestamps of the most recent |
|
|
2045 | stat with subsecond precision on most systems and work both after |
|
|
2046 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2047 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2048 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2049 | |
|
|
2050 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2051 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2052 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2053 | do not act like their perl counterparts. |
|
|
2054 | |
|
|
2055 | On operating systems or file systems where subsecond time resolution is |
|
|
2056 | not supported or could not be detected, a fractional part of C<0> is |
|
|
2057 | returned, so it is always safe to call these functions. |
|
|
2058 | |
|
|
2059 | =over 4 |
|
|
2060 | |
|
|
2061 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
2062 | |
|
|
2063 | Return the access, modication, change or birth time, respectively, |
|
|
2064 | including fractional part. Due to the limited precision of floating point, |
|
|
2065 | the accuracy on most platforms is only a bit better than milliseconds |
|
|
2066 | for times around now - see the I<nsec> function family, below, for full |
|
|
2067 | accuracy. |
|
|
2068 | |
|
|
2069 | File birth time is only available when the OS and perl support it (on |
|
|
2070 | FreeBSD and NetBSD at the time of this writing, although support is |
|
|
2071 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
|
|
2072 | it). On systems where it isn't available, C<0> is currently returned, but |
|
|
2073 | this might change to C<undef> in a future version. |
|
|
2074 | |
|
|
2075 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
2076 | |
|
|
2077 | Returns access, modification, change and birth time all in one go, and |
|
|
2078 | maybe more times in the future version. |
|
|
2079 | |
|
|
2080 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
2081 | |
|
|
2082 | Return the fractional access, modifcation, change or birth time, in nanoseconds, |
|
|
2083 | as an integer in the range C<0> to C<999999999>. |
|
|
2084 | |
|
|
2085 | Note that no accessors are provided for access, modification and |
|
|
2086 | change times - you need to get those from C<stat _> if required (C<int |
|
|
2087 | IO::AIO::st_atime> and so on will I<not> generally give you the correct |
|
|
2088 | value). |
|
|
2089 | |
|
|
2090 | =item $seconds = IO::AIO::st_btimesec |
|
|
2091 | |
|
|
2092 | The (integral) seconds part of the file birth time, if available. |
|
|
2093 | |
|
|
2094 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
2095 | |
|
|
2096 | Like the functions above, but returns all four times in one go (and maybe |
|
|
2097 | more in future versions). |
|
|
2098 | |
|
|
2099 | =item $counter = IO::AIO::st_gen |
|
|
2100 | |
|
|
2101 | Returns the generation counter (in practice this is just a random number) |
|
|
2102 | of the file. This is only available on platforms which have this member in |
|
|
2103 | their C<struct stat> (most BSDs at the time of this writing) and generally |
|
|
2104 | only to the root usert. If unsupported, C<0> is returned, but this might |
|
|
2105 | change to C<undef> in a future version. |
|
|
2106 | |
|
|
2107 | =back |
|
|
2108 | |
|
|
2109 | Example: print the high resolution modification time of F</etc>, using |
|
|
2110 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2111 | |
|
|
2112 | if (stat "/etc") { |
|
|
2113 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2114 | } |
|
|
2115 | |
|
|
2116 | IO::AIO::aio_stat "/etc", sub { |
|
|
2117 | $_[0] |
|
|
2118 | and return; |
|
|
2119 | |
|
|
2120 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2121 | }; |
|
|
2122 | |
|
|
2123 | IO::AIO::flush; |
|
|
2124 | |
|
|
2125 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2126 | |
|
|
2127 | stat(/etc) mtime: 1534043702.020808 |
|
|
2128 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2129 | |
2057 | |
2130 | |
2058 | =head3 MISCELLANEOUS FUNCTIONS |
2131 | =head3 MISCELLANEOUS FUNCTIONS |
2059 | |
2132 | |
2060 | IO::AIO implements some functions that are useful when you want to use |
2133 | IO::AIO implements some functions that are useful when you want to use |
2061 | some "Advanced I/O" function not available to in Perl, without going the |
2134 | 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_*> |
2135 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2063 | counterpart. |
2136 | counterpart. |
2064 | |
2137 | |
2065 | =over 4 |
2138 | =over 4 |
|
|
2139 | |
|
|
2140 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2141 | |
|
|
2142 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2143 | |
|
|
2144 | Tries to find the current file descriptor limit and returns it, or |
|
|
2145 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2146 | the highest valid file descriptor number. |
|
|
2147 | |
|
|
2148 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2149 | |
|
|
2150 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2151 | |
|
|
2152 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2153 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2154 | is missing, it will try to set a very high limit, although this is not |
|
|
2155 | recommended when you know the actual minimum that you require. |
|
|
2156 | |
|
|
2157 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2158 | attempt to increase the limit as much as possible, using various |
|
|
2159 | tricks, while still failing. You can query the resulting limit using |
|
|
2160 | C<IO::AIO::get_fdlimit>. |
|
|
2161 | |
|
|
2162 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2163 | true. |
2066 | |
2164 | |
2067 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2165 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2068 | |
2166 | |
2069 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2167 | 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 |
2168 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2087 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2185 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2088 | |
2186 | |
2089 | Simply calls the C<posix_madvise> function (see its |
2187 | Simply calls the C<posix_madvise> function (see its |
2090 | manpage for details). The following advice constants are |
2188 | manpage for details). The following advice constants are |
2091 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2189 | 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>, |
2190 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
2093 | C<IO::AIO::MADV_FREE>. |
2191 | C<IO::AIO::MADV_DONTNEED>. |
2094 | |
2192 | |
2095 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
2193 | 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> |
2194 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
2097 | will be reduced to fit into the C<$scalar>. |
2195 | will be reduced to fit into the C<$scalar>. |
2098 | |
2196 | |
… | |
… | |
2177 | |
2275 | |
2178 | =item IO::AIO::munmap $scalar |
2276 | =item IO::AIO::munmap $scalar |
2179 | |
2277 | |
2180 | Removes a previous mmap and undefines the C<$scalar>. |
2278 | Removes a previous mmap and undefines the C<$scalar>. |
2181 | |
2279 | |
|
|
2280 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2281 | |
|
|
2282 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2283 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2284 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2285 | |
|
|
2286 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2287 | region has changed address, then the true value has the numerical value |
|
|
2288 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2289 | |
|
|
2290 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2291 | or die "mremap: $!"; |
|
|
2292 | |
|
|
2293 | if ($success*1) { |
|
|
2294 | warn "scalar has chanegd address in memory\n"; |
|
|
2295 | } |
|
|
2296 | |
|
|
2297 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2298 | implemented, but not supported and might go away in a future version. |
|
|
2299 | |
|
|
2300 | On systems where this call is not supported or is not emulated, this call |
|
|
2301 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2302 | |
|
|
2303 | =item IO::AIO::mlockall $flags |
|
|
2304 | |
|
|
2305 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2306 | but is blocking. |
|
|
2307 | |
2182 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2308 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2183 | |
2309 | |
2184 | Calls the C<munlock> function, undoing the effects of a previous |
2310 | Calls the C<munlock> function, undoing the effects of a previous |
2185 | C<aio_mlock> call (see its description for details). |
2311 | C<aio_mlock> call (see its description for details). |
2186 | |
2312 | |
… | |
… | |
2235 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2361 | C<$flags> is non-zero, fails with C<ENOSYS>. |
2236 | |
2362 | |
2237 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
2363 | 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 |
2364 | 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. |
2365 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
|
|
2366 | |
|
|
2367 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2368 | |
|
|
2369 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2370 | or die "pipe2: $!\n"; |
|
|
2371 | |
|
|
2372 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2373 | |
|
|
2374 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2375 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2376 | |
|
|
2377 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2378 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2379 | |
|
|
2380 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2381 | |
|
|
2382 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2383 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2384 | |
|
|
2385 | Example: create a new eventfd filehandle: |
|
|
2386 | |
|
|
2387 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2388 | or die "eventfd: $!\n"; |
|
|
2389 | |
|
|
2390 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2391 | |
|
|
2392 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2393 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2394 | |
|
|
2395 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2396 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2397 | |
|
|
2398 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2399 | |
|
|
2400 | The following C<$clockid> values are |
|
|
2401 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2402 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2403 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2404 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2405 | |
|
|
2406 | The following C<$flags> values are available (Linux |
|
|
2407 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2408 | |
|
|
2409 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2410 | then wait for two alarms: |
|
|
2411 | |
|
|
2412 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2413 | or die "timerfd_create: $!\n"; |
|
|
2414 | |
|
|
2415 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2416 | or die "timerfd_settime: $!\n"; |
|
|
2417 | |
|
|
2418 | for (1..2) { |
|
|
2419 | 8 == sysread $fh, my $buf, 8 |
|
|
2420 | or die "timerfd read failure\n"; |
|
|
2421 | |
|
|
2422 | printf "number of expirations (likely 1): %d\n", |
|
|
2423 | unpack "Q", $buf; |
|
|
2424 | } |
|
|
2425 | |
|
|
2426 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2427 | |
|
|
2428 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2429 | call. Please refer to its manpage for more info on this call. |
|
|
2430 | |
|
|
2431 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2432 | values, C<$new_interval> and C<$new_value>). |
|
|
2433 | |
|
|
2434 | On success, the current interval and value are returned (as per |
|
|
2435 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2436 | |
|
|
2437 | The following C<$flags> values are |
|
|
2438 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2439 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2440 | |
|
|
2441 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2442 | |
|
|
2443 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2444 | |
|
|
2445 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2446 | call. Please refer to its manpage for more info on this call. |
|
|
2447 | |
|
|
2448 | On success, returns the current values of interval and value for the given |
|
|
2449 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2450 | list is returned. |
2240 | |
2451 | |
2241 | =back |
2452 | =back |
2242 | |
2453 | |
2243 | =cut |
2454 | =cut |
2244 | |
2455 | |
… | |
… | |
2310 | the process will result in undefined behaviour. Calling it at any time |
2521 | the process will result in undefined behaviour. Calling it at any time |
2311 | will also result in any undefined (by POSIX) behaviour. |
2522 | will also result in any undefined (by POSIX) behaviour. |
2312 | |
2523 | |
2313 | =back |
2524 | =back |
2314 | |
2525 | |
|
|
2526 | =head2 LINUX-SPECIFIC CALLS |
|
|
2527 | |
|
|
2528 | When a call is documented as "linux-specific" then this means it |
|
|
2529 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2530 | availability and compatibility of such calls regardless of the platform |
|
|
2531 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2532 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2533 | C<ENOSYS>. |
|
|
2534 | |
2315 | =head2 MEMORY USAGE |
2535 | =head2 MEMORY USAGE |
2316 | |
2536 | |
2317 | Per-request usage: |
2537 | Per-request usage: |
2318 | |
2538 | |
2319 | Each aio request uses - depending on your architecture - around 100-200 |
2539 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2331 | temporary buffers, and each thread requires a stack and other data |
2551 | temporary buffers, and each thread requires a stack and other data |
2332 | structures (usually around 16k-128k, depending on the OS). |
2552 | structures (usually around 16k-128k, depending on the OS). |
2333 | |
2553 | |
2334 | =head1 KNOWN BUGS |
2554 | =head1 KNOWN BUGS |
2335 | |
2555 | |
2336 | Known bugs will be fixed in the next release. |
2556 | Known bugs will be fixed in the next release :) |
|
|
2557 | |
|
|
2558 | =head1 KNOWN ISSUES |
|
|
2559 | |
|
|
2560 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2561 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2562 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2563 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2564 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2565 | |
|
|
2566 | I am not sure anything can be done about this, so this is considered a |
|
|
2567 | known issue, rather than a bug. |
2337 | |
2568 | |
2338 | =head1 SEE ALSO |
2569 | =head1 SEE ALSO |
2339 | |
2570 | |
2340 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2571 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2341 | more natural syntax. |
2572 | more natural syntax. |