ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.205 by root, Mon Jul 18 03:09:06 2011 UTC vs.
Revision 1.207 by root, Mon Jul 25 16:50:33 2011 UTC

… …
172BEGIN { 172BEGIN {
173 our $VERSION = '4.0'; 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)
… …
686array-ref with the filenames. 687array-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
691Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 692Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
692behaviour and output format. In case of an error, C<$entries> will be 693tune behaviour and output format. In case of an error, C<$entries> will be
693C<undef>. 694C<undef>.
694 695
695The flags are a combination of the following constants, ORed together (the 696The flags are a combination of the following constants, ORed together (the
696flags will also be passed to the callback, possibly modified): 697flags 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
747This flag should not be set when calling C<aio_readdirx>. Instead, it 748This flag should not be set when calling C<aio_readdirx>. Instead, it
748is being set by C<aio_readdirx>, when any of the C<$type>'s found were 749is being set by C<aio_readdirx>, when any of the C<$type>'s found were
749C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 750C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
750C<$type>'s are known, which can be used to speed up some algorithms. 751C<$type>'s are known, which can be used to speed up some algorithms.
751 752
752=back 753=back
753 754
754 755
… …
936Then entries will be sorted into likely directories a non-initial dot 937Then entries will be sorted into likely directories a non-initial dot
937currently) and likely non-directories (see C<aio_readdirx>). Then every 938currently) and likely non-directories (see C<aio_readdirx>). Then every
938entry plus an appended C</.> will be C<stat>'ed, likely directories first, 939entry plus an appended C</.> will be C<stat>'ed, likely directories first,
939in order of their inode numbers. If that succeeds, it assumes that the 940in order of their inode numbers. If that succeeds, it assumes that the
940entry is a directory or a symlink to directory (which will be checked 941entry is a directory or a symlink to directory (which will be checked
941seperately). This is often faster than stat'ing the entry itself because 942separately). This is often faster than stat'ing the entry itself because
942filesystems might detect the type of the entry without reading the inode 943filesystems might detect the type of the entry without reading the inode
943data (e.g. ext2fs filetype feature), even on systems that cannot return 944data (e.g. ext2fs filetype feature), even on systems that cannot return
944the filetype information on readdir. 945the filetype information on readdir.
945 946
946If the known number of directories (link count - 2) has been reached, the 947If the known number of directories (link count - 2) has been reached, the
… …
1084callback with the fdatasync result code. 1085callback with the fdatasync result code.
1085 1086
1086If this call isn't available because your OS lacks it or it couldn't be 1087If this call isn't available because your OS lacks it or it couldn't be
1087detected, it will be emulated by calling C<fsync> instead. 1088detected, it will be emulated by calling C<fsync> instead.
1088 1089
1090=item aio_syncfs $fh, $callback->($status)
1091
1092Asynchronously call the syncfs syscall to sync the filesystem associated
1093to the given filehandle and call the callback with the syncfs result
1094code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1095errno 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
1091Sync the data portion of the file specified by C<$offset> and C<$length> 1099Sync the data portion of the file specified by C<$offset> and C<$length>
1092to disk (but NOT the metadata), by calling the Linux-specific 1100to disk (but NOT the metadata), by calling the Linux-specific
1093sync_file_range call. If sync_file_range is not available or it returns 1101sync_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
1668Simply calls the C<posix_fadvise> function (see its 1676Simply calls the C<posix_fadvise> function (see its
1669manpage for details). The following advice constants are 1677manpage for details). The following advice constants are
1670avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 1678available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1671C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 1679C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1672C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 1680C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1673 1681
1674On systems that do not implement C<posix_fadvise>, this function returns 1682On systems that do not implement C<posix_fadvise>, this function returns
1675ENOSYS, otherwise the return value of C<posix_fadvise>. 1683ENOSYS, 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
1679Simply calls the C<posix_madvise> function (see its 1687Simply calls the C<posix_madvise> function (see its
1680manpage for details). The following advice constants are 1688manpage for details). The following advice constants are
1681avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 1689available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1682C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 1690C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1683 1691
1684On systems that do not implement C<posix_madvise>, this function returns 1692On systems that do not implement C<posix_madvise>, this function returns
1685ENOSYS, otherwise the return value of C<posix_madvise>. 1693ENOSYS, 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
1689Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 1697Simply 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
1691constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 1699constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1692C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 1700C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1693 1701
1694On systems that do not implement C<mprotect>, this function returns 1702On systems that do not implement C<mprotect>, this function returns
1695ENOSYS, otherwise the return value of C<mprotect>. 1703ENOSYS, otherwise the return value of C<mprotect>.
1696 1704
… …
1821 1829
1822=over 4 1830=over 4
1823 1831
1824=item IO::AIO::reinit 1832=item IO::AIO::reinit
1825 1833
1826Abondons all current requests and I/O threads and simply reinitialises all 1834Abandons all current requests and I/O threads and simply reinitialises all
1827data structures. This is not an operation suppported by any standards, but 1835data structures. This is not an operation supported by any standards, but
1828happens to work on GNU/Linux and some newer BSD systems. 1836happens to work on GNU/Linux and some newer BSD systems.
1829 1837
1830The only reasonable use for this function is to call it after forking, if 1838The only reasonable use for this function is to call it after forking, if
1831C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in 1839C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
1832the process will result in undefined behaviour. Calling it at any time 1840the process will result in undefined behaviour. Calling it at any time

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines