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.204 by root, Mon Jul 18 02:02:26 2011 UTC vs.
Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC

168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
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
184 aio_statvfs); 184 aio_statvfs
185 aio_wd);
185 186
186 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
187 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
188 min_parallel max_parallel max_idle idle_timeout 189 min_parallel max_parallel max_idle idle_timeout
189 nreqs nready npending nthreads 190 nreqs nready npending nthreads
205 206
206This section simply lists the prototypes of the most important functions 207This section simply lists the prototypes of the most important functions
207for quick reference. See the following sections for function-by-function 208for quick reference. See the following sections for function-by-function
208documentation. 209documentation.
209 210
211 aio_wd $pathname, $callback->($wd)
210 aio_open $pathname, $flags, $mode, $callback->($fh) 212 aio_open $pathname, $flags, $mode, $callback->($fh)
211 aio_close $fh, $callback->($status) 213 aio_close $fh, $callback->($status)
212 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
214 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
237 aio_copy $srcpath, $dstpath, $callback->($status) 239 aio_copy $srcpath, $dstpath, $callback->($status)
238 aio_move $srcpath, $dstpath, $callback->($status) 240 aio_move $srcpath, $dstpath, $callback->($status)
239 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 241 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
240 aio_rmtree $path, $callback->($status) 242 aio_rmtree $path, $callback->($status)
241 aio_sync $callback->($status) 243 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status)
242 aio_fsync $fh, $callback->($status) 245 aio_fsync $fh, $callback->($status)
243 aio_fdatasync $fh, $callback->($status) 246 aio_fdatasync $fh, $callback->($status)
244 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
245 aio_pathsync $path, $callback->($status) 248 aio_pathsync $path, $callback->($status)
246 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
686array-ref with the filenames. 689array-ref with the filenames.
687 690
688 691
689=item aio_readdirx $pathname, $flags, $callback->($entries, $flags) 692=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
690 693
691Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 694Quite 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 695tune behaviour and output format. In case of an error, C<$entries> will be
693C<undef>. 696C<undef>.
694 697
695The flags are a combination of the following constants, ORed together (the 698The flags are a combination of the following constants, ORed together (the
696flags will also be passed to the callback, possibly modified): 699flags will also be passed to the callback, possibly modified):
697 700
744 747
745=item IO::AIO::READDIR_FOUND_UNKNOWN 748=item IO::AIO::READDIR_FOUND_UNKNOWN
746 749
747This flag should not be set when calling C<aio_readdirx>. Instead, it 750This 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 751is 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 752C<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. 753C<$type>'s are known, which can be used to speed up some algorithms.
751 754
752=back 755=back
753 756
754 757
936Then entries will be sorted into likely directories a non-initial dot 939Then entries will be sorted into likely directories a non-initial dot
937currently) and likely non-directories (see C<aio_readdirx>). Then every 940currently) and likely non-directories (see C<aio_readdirx>). Then every
938entry plus an appended C</.> will be C<stat>'ed, likely directories first, 941entry 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 942in 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 943entry is a directory or a symlink to directory (which will be checked
941seperately). This is often faster than stat'ing the entry itself because 944separately). This is often faster than stat'ing the entry itself because
942filesystems might detect the type of the entry without reading the inode 945filesystems might detect the type of the entry without reading the inode
943data (e.g. ext2fs filetype feature), even on systems that cannot return 946data (e.g. ext2fs filetype feature), even on systems that cannot return
944the filetype information on readdir. 947the filetype information on readdir.
945 948
946If the known number of directories (link count - 2) has been reached, the 949If the known number of directories (link count - 2) has been reached, the
1084callback with the fdatasync result code. 1087callback with the fdatasync result code.
1085 1088
1086If this call isn't available because your OS lacks it or it couldn't be 1089If 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. 1090detected, it will be emulated by calling C<fsync> instead.
1088 1091
1092=item aio_syncfs $fh, $callback->($status)
1093
1094Asynchronously call the syncfs syscall to sync the filesystem associated
1095to the given filehandle and call the callback with the syncfs result
1096code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1097errno to C<ENOSYS> nevertheless.
1098
1089=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 1099=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1090 1100
1091Sync the data portion of the file specified by C<$offset> and C<$length> 1101Sync the data portion of the file specified by C<$offset> and C<$length>
1092to disk (but NOT the metadata), by calling the Linux-specific 1102to disk (but NOT the metadata), by calling the Linux-specific
1093sync_file_range call. If sync_file_range is not available or it returns 1103sync_file_range call. If sync_file_range is not available or it returns
1665 1675
1666=item IO::AIO::fadvise $fh, $offset, $len, $advice 1676=item IO::AIO::fadvise $fh, $offset, $len, $advice
1667 1677
1668Simply calls the C<posix_fadvise> function (see its 1678Simply calls the C<posix_fadvise> function (see its
1669manpage for details). The following advice constants are 1679manpage for details). The following advice constants are
1670avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 1680available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1671C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 1681C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1672C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 1682C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1673 1683
1674On systems that do not implement C<posix_fadvise>, this function returns 1684On systems that do not implement C<posix_fadvise>, this function returns
1675ENOSYS, otherwise the return value of C<posix_fadvise>. 1685ENOSYS, otherwise the return value of C<posix_fadvise>.
1676 1686
1677=item IO::AIO::madvise $scalar, $offset, $len, $advice 1687=item IO::AIO::madvise $scalar, $offset, $len, $advice
1678 1688
1679Simply calls the C<posix_madvise> function (see its 1689Simply calls the C<posix_madvise> function (see its
1680manpage for details). The following advice constants are 1690manpage for details). The following advice constants are
1681avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 1691available: 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>. 1692C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1683 1693
1684On systems that do not implement C<posix_madvise>, this function returns 1694On systems that do not implement C<posix_madvise>, this function returns
1685ENOSYS, otherwise the return value of C<posix_madvise>. 1695ENOSYS, otherwise the return value of C<posix_madvise>.
1686 1696
1687=item IO::AIO::mprotect $scalar, $offset, $len, $protect 1697=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1688 1698
1689Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 1699Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1690$scalar (see its manpage for details). The following protect 1700$scalar (see its manpage for details). The following protect
1691constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 1701constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1692C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 1702C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1693 1703
1694On systems that do not implement C<mprotect>, this function returns 1704On systems that do not implement C<mprotect>, this function returns
1695ENOSYS, otherwise the return value of C<mprotect>. 1705ENOSYS, otherwise the return value of C<mprotect>.
1696 1706
1821 1831
1822=over 4 1832=over 4
1823 1833
1824=item IO::AIO::reinit 1834=item IO::AIO::reinit
1825 1835
1826Abondons all current requests and I/O threads and simply reinitialises all 1836Abandons all current requests and I/O threads and simply reinitialises all
1827data structures. This is not an operation suppported by any standards, but 1837data structures. This is not an operation supported by any standards, but
1828happens to work on GNU/Linux and some newer BSD systems. 1838happens to work on GNU/Linux and some newer BSD systems.
1829 1839
1830The only reasonable use for this function is to call it after forking, if 1840The 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 1841C<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 1842the process will result in undefined behaviour. Calling it at any time

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines