… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '3.93'; |
173 | our $VERSION = '4.0'; |
174 | |
174 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync aio_fsync |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fdatasync aio_sync_file_range aio_fallocate |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
179 | aio_pathsync aio_readahead |
179 | aio_pathsync aio_readahead |
180 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
182 | aio_chmod aio_utime aio_truncate |
182 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
… | |
… | |
237 | aio_copy $srcpath, $dstpath, $callback->($status) |
237 | aio_copy $srcpath, $dstpath, $callback->($status) |
238 | aio_move $srcpath, $dstpath, $callback->($status) |
238 | aio_move $srcpath, $dstpath, $callback->($status) |
239 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
239 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
240 | aio_rmtree $path, $callback->($status) |
240 | aio_rmtree $path, $callback->($status) |
241 | aio_sync $callback->($status) |
241 | aio_sync $callback->($status) |
|
|
242 | aio_syncfs $fh, $callback->($status) |
242 | aio_fsync $fh, $callback->($status) |
243 | aio_fsync $fh, $callback->($status) |
243 | aio_fdatasync $fh, $callback->($status) |
244 | aio_fdatasync $fh, $callback->($status) |
244 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
245 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
245 | aio_pathsync $path, $callback->($status) |
246 | aio_pathsync $path, $callback->($status) |
246 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
247 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
… | |
… | |
686 | array-ref with the filenames. |
687 | array-ref with the filenames. |
687 | |
688 | |
688 | |
689 | |
689 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
690 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
690 | |
691 | |
691 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
692 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to |
692 | behaviour and output format. In case of an error, C<$entries> will be |
693 | tune behaviour and output format. In case of an error, C<$entries> will be |
693 | C<undef>. |
694 | C<undef>. |
694 | |
695 | |
695 | The flags are a combination of the following constants, ORed together (the |
696 | The flags are a combination of the following constants, ORed together (the |
696 | flags will also be passed to the callback, possibly modified): |
697 | flags will also be passed to the callback, possibly modified): |
697 | |
698 | |
… | |
… | |
744 | |
745 | |
745 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
746 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
746 | |
747 | |
747 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
748 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
748 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
749 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
749 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
750 | C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all |
750 | C<$type>'s are known, which can be used to speed up some algorithms. |
751 | C<$type>'s are known, which can be used to speed up some algorithms. |
751 | |
752 | |
752 | =back |
753 | =back |
753 | |
754 | |
754 | |
755 | |
… | |
… | |
936 | Then entries will be sorted into likely directories a non-initial dot |
937 | Then entries will be sorted into likely directories a non-initial dot |
937 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
938 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
938 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
939 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
939 | in order of their inode numbers. If that succeeds, it assumes that the |
940 | in order of their inode numbers. If that succeeds, it assumes that the |
940 | entry is a directory or a symlink to directory (which will be checked |
941 | entry is a directory or a symlink to directory (which will be checked |
941 | seperately). This is often faster than stat'ing the entry itself because |
942 | separately). This is often faster than stat'ing the entry itself because |
942 | filesystems might detect the type of the entry without reading the inode |
943 | filesystems might detect the type of the entry without reading the inode |
943 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
944 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
944 | the filetype information on readdir. |
945 | the filetype information on readdir. |
945 | |
946 | |
946 | If the known number of directories (link count - 2) has been reached, the |
947 | If the known number of directories (link count - 2) has been reached, the |
… | |
… | |
1084 | callback with the fdatasync result code. |
1085 | callback with the fdatasync result code. |
1085 | |
1086 | |
1086 | If this call isn't available because your OS lacks it or it couldn't be |
1087 | If this call isn't available because your OS lacks it or it couldn't be |
1087 | detected, it will be emulated by calling C<fsync> instead. |
1088 | detected, it will be emulated by calling C<fsync> instead. |
1088 | |
1089 | |
|
|
1090 | =item aio_syncfs $fh, $callback->($status) |
|
|
1091 | |
|
|
1092 | Asynchronously call the syncfs syscall to sync the filesystem associated |
|
|
1093 | to the given filehandle and call the callback with the syncfs result |
|
|
1094 | code. If syncfs is not available, calls sync(), but returns C<-1> and sets |
|
|
1095 | errno to C<ENOSYS> nevertheless. |
|
|
1096 | |
1089 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1097 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1090 | |
1098 | |
1091 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1099 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1092 | to disk (but NOT the metadata), by calling the Linux-specific |
1100 | to disk (but NOT the metadata), by calling the Linux-specific |
1093 | sync_file_range call. If sync_file_range is not available or it returns |
1101 | sync_file_range call. If sync_file_range is not available or it returns |
… | |
… | |
1665 | |
1673 | |
1666 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1674 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1667 | |
1675 | |
1668 | Simply calls the C<posix_fadvise> function (see its |
1676 | Simply calls the C<posix_fadvise> function (see its |
1669 | manpage for details). The following advice constants are |
1677 | manpage for details). The following advice constants are |
1670 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1678 | available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1671 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1679 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1672 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1680 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1673 | |
1681 | |
1674 | On systems that do not implement C<posix_fadvise>, this function returns |
1682 | On systems that do not implement C<posix_fadvise>, this function returns |
1675 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1683 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1676 | |
1684 | |
1677 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1685 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1678 | |
1686 | |
1679 | Simply calls the C<posix_madvise> function (see its |
1687 | Simply calls the C<posix_madvise> function (see its |
1680 | manpage for details). The following advice constants are |
1688 | manpage for details). The following advice constants are |
1681 | avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1689 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1682 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
1690 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
1683 | |
1691 | |
1684 | On systems that do not implement C<posix_madvise>, this function returns |
1692 | On systems that do not implement C<posix_madvise>, this function returns |
1685 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1693 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1686 | |
1694 | |
1687 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
1695 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
1688 | |
1696 | |
1689 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
1697 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
1690 | $scalar (see its manpage for details). The following protect |
1698 | $scalar (see its manpage for details). The following protect |
1691 | constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
1699 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
1692 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1700 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1693 | |
1701 | |
1694 | On systems that do not implement C<mprotect>, this function returns |
1702 | On systems that do not implement C<mprotect>, this function returns |
1695 | ENOSYS, otherwise the return value of C<mprotect>. |
1703 | ENOSYS, otherwise the return value of C<mprotect>. |
1696 | |
1704 | |
… | |
… | |
1804 | =head2 FORK BEHAVIOUR |
1812 | =head2 FORK BEHAVIOUR |
1805 | |
1813 | |
1806 | Usage of pthreads in a program changes the semantics of fork |
1814 | Usage of pthreads in a program changes the semantics of fork |
1807 | considerably. Specifically, only async-safe functions can be called after |
1815 | considerably. Specifically, only async-safe functions can be called after |
1808 | fork. Perl doesn't know about this, so in general, you cannot call fork |
1816 | fork. Perl doesn't know about this, so in general, you cannot call fork |
1809 | with defined behaviour in perl. IO::AIO uses pthreads, so this applies, |
1817 | with defined behaviour in perl if pthreads are involved. IO::AIO uses |
1810 | but many other extensions and (for inexplicable reasons) perl itself often |
1818 | pthreads, so this applies, but many other extensions and (for inexplicable |
1811 | is linked against pthreads, so this limitation applies. |
1819 | reasons) perl itself often is linked against pthreads, so this limitation |
|
|
1820 | applies to quite a lot of perls. |
1812 | |
1821 | |
1813 | Some operating systems have extensions that allow safe use of fork, and |
1822 | This module no longer tries to fight your OS, or POSIX. That means IO::AIO |
1814 | this module should do "the right thing" on those, and tries on others. At |
1823 | only works in the process that loaded it. Forking is fully supported, but |
1815 | the time of this writing (2011) only GNU/Linux supports these extensions |
1824 | using IO::AIO in the child is not. |
1816 | to POSIX. |
1825 | |
|
|
1826 | You might get around by not I<using> IO::AIO before (or after) |
|
|
1827 | forking. You could also try to call the L<IO::AIO::reinit> function in the |
|
|
1828 | child: |
|
|
1829 | |
|
|
1830 | =over 4 |
|
|
1831 | |
|
|
1832 | =item IO::AIO::reinit |
|
|
1833 | |
|
|
1834 | Abandons all current requests and I/O threads and simply reinitialises all |
|
|
1835 | data structures. This is not an operation supported by any standards, but |
|
|
1836 | happens to work on GNU/Linux and some newer BSD systems. |
|
|
1837 | |
|
|
1838 | The only reasonable use for this function is to call it after forking, if |
|
|
1839 | C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in |
|
|
1840 | the process will result in undefined behaviour. Calling it at any time |
|
|
1841 | will also result in any undefined (by POSIX) behaviour. |
|
|
1842 | |
|
|
1843 | =back |
1817 | |
1844 | |
1818 | =head2 MEMORY USAGE |
1845 | =head2 MEMORY USAGE |
1819 | |
1846 | |
1820 | Per-request usage: |
1847 | Per-request usage: |
1821 | |
1848 | |