… | |
… | |
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.9'; |
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_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) |
… | |
… | |
222 | aio_unlink $pathname, $callback->($status) |
225 | aio_unlink $pathname, $callback->($status) |
223 | aio_mknod $path, $mode, $dev, $callback->($status) |
226 | aio_mknod $path, $mode, $dev, $callback->($status) |
224 | aio_link $srcpath, $dstpath, $callback->($status) |
227 | aio_link $srcpath, $dstpath, $callback->($status) |
225 | aio_symlink $srcpath, $dstpath, $callback->($status) |
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
226 | aio_readlink $path, $callback->($link) |
229 | aio_readlink $path, $callback->($link) |
|
|
230 | aio_realpath $path, $callback->($link) |
227 | aio_rename $srcpath, $dstpath, $callback->($status) |
231 | aio_rename $srcpath, $dstpath, $callback->($status) |
228 | aio_mkdir $pathname, $mode, $callback->($status) |
232 | aio_mkdir $pathname, $mode, $callback->($status) |
229 | aio_rmdir $pathname, $callback->($status) |
233 | aio_rmdir $pathname, $callback->($status) |
230 | aio_readdir $pathname, $callback->($entries) |
234 | aio_readdir $pathname, $callback->($entries) |
231 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
235 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
… | |
… | |
235 | aio_copy $srcpath, $dstpath, $callback->($status) |
239 | aio_copy $srcpath, $dstpath, $callback->($status) |
236 | aio_move $srcpath, $dstpath, $callback->($status) |
240 | aio_move $srcpath, $dstpath, $callback->($status) |
237 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
241 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
238 | aio_rmtree $path, $callback->($status) |
242 | aio_rmtree $path, $callback->($status) |
239 | aio_sync $callback->($status) |
243 | aio_sync $callback->($status) |
|
|
244 | aio_syncfs $fh, $callback->($status) |
240 | aio_fsync $fh, $callback->($status) |
245 | aio_fsync $fh, $callback->($status) |
241 | aio_fdatasync $fh, $callback->($status) |
246 | aio_fdatasync $fh, $callback->($status) |
242 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
247 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
243 | aio_pathsync $path, $callback->($status) |
248 | aio_pathsync $path, $callback->($status) |
244 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
249 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
… | |
… | |
643 | Asynchronously read the symlink specified by C<$path> and pass it to |
648 | Asynchronously read the symlink specified by C<$path> and pass it to |
644 | the callback. If an error occurs, nothing or undef gets passed to the |
649 | the callback. If an error occurs, nothing or undef gets passed to the |
645 | callback. |
650 | callback. |
646 | |
651 | |
647 | |
652 | |
|
|
653 | =item aio_realpath $path, $callback->($path) |
|
|
654 | |
|
|
655 | Asynchronously make the path absolute and resolve any symlinks in |
|
|
656 | C<$path>. The resulting path only consists of directories (Same as |
|
|
657 | L<Cwd::realpath>). |
|
|
658 | |
|
|
659 | This request can be used to get the absolute path of the current working |
|
|
660 | directory by passing it a path of F<.> (a single dot). |
|
|
661 | |
|
|
662 | |
648 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
663 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
649 | |
664 | |
650 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
665 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
651 | rename(2) and call the callback with the result code. |
666 | rename(2) and call the callback with the result code. |
652 | |
667 | |
… | |
… | |
674 | array-ref with the filenames. |
689 | array-ref with the filenames. |
675 | |
690 | |
676 | |
691 | |
677 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
692 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
678 | |
693 | |
679 | 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 |
680 | 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 |
681 | C<undef>. |
696 | C<undef>. |
682 | |
697 | |
683 | 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 |
684 | flags will also be passed to the callback, possibly modified): |
699 | flags will also be passed to the callback, possibly modified): |
685 | |
700 | |
… | |
… | |
732 | |
747 | |
733 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
748 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
734 | |
749 | |
735 | 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 |
736 | 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 |
737 | 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 |
738 | 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. |
739 | |
754 | |
740 | =back |
755 | =back |
741 | |
756 | |
742 | |
757 | |
… | |
… | |
924 | 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 |
925 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
940 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
926 | 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, |
927 | 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 |
928 | 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 |
929 | 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 |
930 | 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 |
931 | 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 |
932 | the filetype information on readdir. |
947 | the filetype information on readdir. |
933 | |
948 | |
934 | 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 |
… | |
… | |
1072 | callback with the fdatasync result code. |
1087 | callback with the fdatasync result code. |
1073 | |
1088 | |
1074 | 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 |
1075 | detected, it will be emulated by calling C<fsync> instead. |
1090 | detected, it will be emulated by calling C<fsync> instead. |
1076 | |
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 | |
1077 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1099 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1078 | |
1100 | |
1079 | 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> |
1080 | to disk (but NOT the metadata), by calling the Linux-specific |
1102 | to disk (but NOT the metadata), by calling the Linux-specific |
1081 | 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 |
… | |
… | |
1653 | |
1675 | |
1654 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1676 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1655 | |
1677 | |
1656 | Simply calls the C<posix_fadvise> function (see its |
1678 | Simply calls the C<posix_fadvise> function (see its |
1657 | manpage for details). The following advice constants are |
1679 | manpage for details). The following advice constants are |
1658 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1680 | available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1659 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1681 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1660 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1682 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1661 | |
1683 | |
1662 | 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 |
1663 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1685 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1664 | |
1686 | |
1665 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1687 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1666 | |
1688 | |
1667 | Simply calls the C<posix_madvise> function (see its |
1689 | Simply calls the C<posix_madvise> function (see its |
1668 | manpage for details). The following advice constants are |
1690 | manpage for details). The following advice constants are |
1669 | avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1691 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1670 | 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>. |
1671 | |
1693 | |
1672 | 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 |
1673 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1695 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1674 | |
1696 | |
1675 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
1697 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
1676 | |
1698 | |
1677 | 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 |
1678 | $scalar (see its manpage for details). The following protect |
1700 | $scalar (see its manpage for details). The following protect |
1679 | 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>, |
1680 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1702 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1681 | |
1703 | |
1682 | On systems that do not implement C<mprotect>, this function returns |
1704 | On systems that do not implement C<mprotect>, this function returns |
1683 | ENOSYS, otherwise the return value of C<mprotect>. |
1705 | ENOSYS, otherwise the return value of C<mprotect>. |
1684 | |
1706 | |
… | |
… | |
1789 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
1811 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
1790 | \&IO::AIO::poll_cb); |
1812 | \&IO::AIO::poll_cb); |
1791 | |
1813 | |
1792 | =head2 FORK BEHAVIOUR |
1814 | =head2 FORK BEHAVIOUR |
1793 | |
1815 | |
1794 | This module should do "the right thing" when the process using it forks: |
1816 | Usage of pthreads in a program changes the semantics of fork |
|
|
1817 | considerably. Specifically, only async-safe functions can be called after |
|
|
1818 | fork. Perl doesn't know about this, so in general, you cannot call fork |
|
|
1819 | with defined behaviour in perl if pthreads are involved. IO::AIO uses |
|
|
1820 | pthreads, so this applies, but many other extensions and (for inexplicable |
|
|
1821 | reasons) perl itself often is linked against pthreads, so this limitation |
|
|
1822 | applies to quite a lot of perls. |
1795 | |
1823 | |
1796 | Before the fork, IO::AIO enters a quiescent state where no requests |
1824 | This module no longer tries to fight your OS, or POSIX. That means IO::AIO |
1797 | can be added in other threads and no results will be processed. After |
1825 | only works in the process that loaded it. Forking is fully supported, but |
1798 | the fork the parent simply leaves the quiescent state and continues |
1826 | using IO::AIO in the child is not. |
1799 | request/result processing, while the child frees the request/result queue |
|
|
1800 | (so that the requests started before the fork will only be handled in the |
|
|
1801 | parent). Threads will be started on demand until the limit set in the |
|
|
1802 | parent process has been reached again. |
|
|
1803 | |
1827 | |
1804 | In short: the parent will, after a short pause, continue as if fork had |
1828 | You might get around by not I<using> IO::AIO before (or after) |
1805 | not been called, while the child will act as if IO::AIO has not been used |
1829 | forking. You could also try to call the L<IO::AIO::reinit> function in the |
1806 | yet. |
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 |
1807 | |
1846 | |
1808 | =head2 MEMORY USAGE |
1847 | =head2 MEMORY USAGE |
1809 | |
1848 | |
1810 | Per-request usage: |
1849 | Per-request usage: |
1811 | |
1850 | |