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.269 by root, Tue Jun 6 04:29:35 2017 UTC vs.
Revision 1.276 by root, Fri Sep 22 05:24:41 2017 UTC

178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close 178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
182 aio_pathsync aio_readahead aio_fiemap aio_allocate 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
183 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
185 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
186 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
187 aio_statvfs 187 aio_statvfs
188 aio_wd); 188 aio_wd);
233 aio_link $srcpath, $dstpath, $callback->($status) 233 aio_link $srcpath, $dstpath, $callback->($status)
234 aio_symlink $srcpath, $dstpath, $callback->($status) 234 aio_symlink $srcpath, $dstpath, $callback->($status)
235 aio_readlink $pathname, $callback->($link) 235 aio_readlink $pathname, $callback->($link)
236 aio_realpath $pathname, $callback->($path) 236 aio_realpath $pathname, $callback->($path)
237 aio_rename $srcpath, $dstpath, $callback->($status) 237 aio_rename $srcpath, $dstpath, $callback->($status)
238 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
238 aio_mkdir $pathname, $mode, $callback->($status) 239 aio_mkdir $pathname, $mode, $callback->($status)
239 aio_rmdir $pathname, $callback->($status) 240 aio_rmdir $pathname, $callback->($status)
240 aio_readdir $pathname, $callback->($entries) 241 aio_readdir $pathname, $callback->($entries)
241 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 242 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
242 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 243 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
276 IO::AIO::idle_timeout $seconds 277 IO::AIO::idle_timeout $seconds
277 IO::AIO::max_outstanding $maxreqs 278 IO::AIO::max_outstanding $maxreqs
278 IO::AIO::nreqs 279 IO::AIO::nreqs
279 IO::AIO::nready 280 IO::AIO::nready
280 IO::AIO::npending 281 IO::AIO::npending
282 IO::AIO::min_fdlimit $nfd;
281 283
282 IO::AIO::sendfile $ofh, $ifh, $offset, $count 284 IO::AIO::sendfile $ofh, $ifh, $offset, $count
283 IO::AIO::fadvise $fh, $offset, $len, $advice 285 IO::AIO::fadvise $fh, $offset, $len, $advice
284 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] 286 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
285 IO::AIO::munmap $scalar 287 IO::AIO::munmap $scalar
739C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate 741C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
740space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, 742space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
741to deallocate a file range. 743to deallocate a file range.
742 744
743IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range 745IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
744(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see 746(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
745your L<fallocate(2)> manpage). 747C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
748to unshare shared blocks (see your L<fallocate(2)> manpage).
746 749
747The file system block size used by C<fallocate> is presumably the 750The file system block size used by C<fallocate> is presumably the
748C<f_bsize> returned by C<statvfs>. 751C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
752can dictate other limitations.
749 753
750If C<fallocate> isn't available or cannot be emulated (currently no 754If C<fallocate> isn't available or cannot be emulated (currently no
751emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. 755emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
752 756
753 757
810rename(2) and call the callback with the result code. 814rename(2) and call the callback with the result code.
811 815
812On systems that support the AIO::WD working directory abstraction 816On systems that support the AIO::WD working directory abstraction
813natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead 817natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
814of failing, C<rename> is called on the absolute path of C<$wd>. 818of failing, C<rename> is called on the absolute path of C<$wd>.
819
820
821=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
822
823Basically a version of C<aio_rename> with an additional C<$flags>
824argument. Calling this with C<$flags=0> is the same as calling
825C<aio_rename>.
826
827Non-zero flags are currently only supported on GNU/Linux systems that
828support renameat2. Other systems fail with C<ENOSYS> in this case.
829
830The following constants are available (missing ones are, as usual C<0>),
831see renameat2(2) for details:
832
833C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
834and C<IO::AIO::RENAME_WHITEOUT>.
815 835
816 836
817=item aio_mkdir $pathname, $mode, $callback->($status) 837=item aio_mkdir $pathname, $mode, $callback->($status)
818 838
819Asynchronously mkdir (create) a directory and call the callback with 839Asynchronously mkdir (create) a directory and call the callback with
938=item aio_copy $srcpath, $dstpath, $callback->($status) 958=item aio_copy $srcpath, $dstpath, $callback->($status)
939 959
940Try to copy the I<file> (directories not supported as either source or 960Try to copy the I<file> (directories not supported as either source or
941destination) from C<$srcpath> to C<$dstpath> and call the callback with 961destination) from C<$srcpath> to C<$dstpath> and call the callback with
942a status of C<0> (ok) or C<-1> (error, see C<$!>). 962a status of C<0> (ok) or C<-1> (error, see C<$!>).
963
964Existing destination files will be truncated.
943 965
944This is a composite request that creates the destination file with 966This is a composite request that creates the destination file with
945mode 0200 and copies the contents of the source file into it using 967mode 0200 and copies the contents of the source file into it using
946C<aio_sendfile>, followed by restoring atime, mtime, access mode and 968C<aio_sendfile>, followed by restoring atime, mtime, access mode and
947uid/gid, in that order. 969uid/gid, in that order.
1254other processes), although if you are careful and know what you are doing, 1276other processes), although if you are careful and know what you are doing,
1255you still can. 1277you still can.
1256 1278
1257The following constants are available (missing ones are, as usual C<0>): 1279The following constants are available (missing ones are, as usual C<0>):
1258 1280
1281C<F_DUPFD_CLOEXEC>,
1282
1283C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1284
1259C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. 1285C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1260 1286
1261C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, 1287C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1262C<FS_IOC_FIEMAP>. 1288C<FS_IOC_FIEMAP>.
1263 1289
1985This is a very bad function to use in interactive programs because it 2011This is a very bad function to use in interactive programs because it
1986blocks, and a bad way to reduce concurrency because it is inexact: Better 2012blocks, and a bad way to reduce concurrency because it is inexact: Better
1987use an C<aio_group> together with a feed callback. 2013use an C<aio_group> together with a feed callback.
1988 2014
1989Its main use is in scripts without an event loop - when you want to stat 2015Its main use is in scripts without an event loop - when you want to stat
1990a lot of files, you can write somehting like this: 2016a lot of files, you can write something like this:
1991 2017
1992 IO::AIO::max_outstanding 32; 2018 IO::AIO::max_outstanding 32;
1993 2019
1994 for my $path (...) { 2020 for my $path (...) {
1995 aio_stat $path , ...; 2021 aio_stat $path , ...;
2040some "Advanced I/O" function not available to in Perl, without going the 2066some "Advanced I/O" function not available to in Perl, without going the
2041"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> 2067"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2042counterpart. 2068counterpart.
2043 2069
2044=over 4 2070=over 4
2071
2072=item $numfd = IO::AIO::get_fdlimit
2073
2074Tries to find the current file descriptor limit and returns it, or
2075C<undef> and sets C<$!> in case of an error. The limit is one larger than
2076the highest valid file descriptor number.
2077
2078=item IO::AIO::min_fdlimit [$numfd]
2079
2080Try to increase the current file descriptor limit(s) to at least C<$numfd>
2081by changing the soft or hard file descriptor resource limit. If C<$numfd>
2082is missing, it will try to set a very high limit, although this is not
2083recommended when you know the actual minimum that you require.
2084
2085If the limit cannot be raised enough, the function makes a best-effort
2086attempt to increase the limit as much as possible, using various
2087tricks, while still failing. You can query the resulting limit using
2088C<IO::AIO::get_fdlimit>.
2089
2090If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2091true.
2045 2092
2046=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2093=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
2047 2094
2048Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2095Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
2049but is blocking (this makes most sense if you know the input data is 2096but is blocking (this makes most sense if you know the input data is
2066=item IO::AIO::madvise $scalar, $offset, $len, $advice 2113=item IO::AIO::madvise $scalar, $offset, $len, $advice
2067 2114
2068Simply calls the C<posix_madvise> function (see its 2115Simply calls the C<posix_madvise> function (see its
2069manpage for details). The following advice constants are 2116manpage for details). The following advice constants are
2070available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2117available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2071C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, 2118C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2072C<IO::AIO::MADV_FREE>. 2119C<IO::AIO::MADV_DONTNEED>.
2073 2120
2074If C<$offset> is negative, counts from the end. If C<$length> is negative, 2121If C<$offset> is negative, counts from the end. If C<$length> is negative,
2075the remaining length of the C<$scalar> is used. If possible, C<$length> 2122the remaining length of the C<$scalar> is used. If possible, C<$length>
2076will be reduced to fit into the C<$scalar>. 2123will be reduced to fit into the C<$scalar>.
2077 2124

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines