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