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.220 by root, Sun Apr 1 17:46:02 2012 UTC vs.
Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC

… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.13'; 173 our $VERSION = '4.15';
174 174
175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_seek 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 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fsync aio_syncfs 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 aio_fiemap
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
… …
221 aio_statvfs $fh_or_path, $callback->($statvfs) 221 aio_statvfs $fh_or_path, $callback->($statvfs)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 223 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 224 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status) 225 aio_truncate $fh_or_path, $offset, $callback->($status)
226 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
226 aio_unlink $pathname, $callback->($status) 227 aio_unlink $pathname, $callback->($status)
227 aio_mknod $pathname, $mode, $dev, $callback->($status) 228 aio_mknod $pathname, $mode, $dev, $callback->($status)
228 aio_link $srcpath, $dstpath, $callback->($status) 229 aio_link $srcpath, $dstpath, $callback->($status)
229 aio_symlink $srcpath, $dstpath, $callback->($status) 230 aio_symlink $srcpath, $dstpath, $callback->($status)
230 aio_readlink $pathname, $callback->($link) 231 aio_readlink $pathname, $callback->($link)
… …
272 IO::AIO::nready 273 IO::AIO::nready
273 IO::AIO::npending 274 IO::AIO::npending
274 275
275 IO::AIO::sendfile $ofh, $ifh, $offset, $count 276 IO::AIO::sendfile $ofh, $ifh, $offset, $count
276 IO::AIO::fadvise $fh, $offset, $len, $advice 277 IO::AIO::fadvise $fh, $offset, $len, $advice
278 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
279 IO::AIO::munmap $scalar
277 IO::AIO::madvise $scalar, $offset, $length, $advice 280 IO::AIO::madvise $scalar, $offset, $length, $advice
278 IO::AIO::mprotect $scalar, $offset, $length, $protect 281 IO::AIO::mprotect $scalar, $offset, $length, $protect
279 IO::AIO::munlock $scalar, $offset = 0, $length = undef 282 IO::AIO::munlock $scalar, $offset = 0, $length = undef
280 IO::AIO::munlockall 283 IO::AIO::munlockall
281 284
… …
413 416
414=cut 417=cut
415 418
416=item aio_seek $fh, $offset, $whence, $callback->($offs) 419=item aio_seek $fh, $offset, $whence, $callback->($offs)
417 420
418Seeks the filehandle to the new C<$offset>, similarly to perl'S 421Seeks the filehandle to the new C<$offset>, similarly to perl's
419C<sysseek>. The C<$whence> can use the traditional values (C<0> for 422C<sysseek>. The C<$whence> can use the traditional values (C<0> for
420C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for 423C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
421C<IO::AIO::SEEK_END>). 424C<IO::AIO::SEEK_END>).
422 425
423The resulting absolute offset will be passed to the callback, or C<-1> in 426The resulting absolute offset will be passed to the callback, or C<-1> in
424case of an error. 427case of an error.
425 428
426In theory, the C<$whence> constants could be different than the 429In theory, the C<$whence> constants could be different than the
427corresponding values from L<Fcntl>, but perl guarantees they are the same, 430corresponding values from L<Fcntl>, but perl guarantees they are the same,
428so don't panic. 431so don't panic.
432
433As a GNU/Linux (and maybe Solaris) extension, also the constants
434C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
435could be found. No guarantees about suitability for use in C<aio_seek> or
436Perl's C<sysseek> can be made though, although I would naively assume they
437"just work".
429 438
430=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 439=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
431 440
432=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 441=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
433 442
… …
628 637
629 638
630=item aio_truncate $fh_or_path, $offset, $callback->($status) 639=item aio_truncate $fh_or_path, $offset, $callback->($status)
631 640
632Works like truncate(2) or ftruncate(2). 641Works like truncate(2) or ftruncate(2).
642
643
644=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
645
646Allocates or freed disk space according to the C<$mode> argument. See the
647linux C<fallocate> docuemntation for details.
648
649C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
650to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
651IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
652
653The file system block size used by C<fallocate> is presumably the
654C<f_bsize> returned by C<statvfs>.
655
656If C<fallocate> isn't available or cannot be emulated (currently no
657emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
633 658
634 659
635=item aio_chmod $fh_or_path, $mode, $callback->($status) 660=item aio_chmod $fh_or_path, $mode, $callback->($status)
636 661
637Works like perl's C<chmod> function. 662Works like perl's C<chmod> function.
… …
1249 1274
1250Example: asynchronously lock all current and future pages into memory. 1275Example: asynchronously lock all current and future pages into memory.
1251 1276
1252 aio_mlockall IO::AIO::MCL_FUTURE; 1277 aio_mlockall IO::AIO::MCL_FUTURE;
1253 1278
1279=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1280
1281Queries the extents of the given file (by calling the Linux FIEMAP ioctl,
1282see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the
1283C<ioctl> is not available on your OS, then this rquiest will fail with
1284C<ENOSYS>.
1285
1286C<$start> is the starting offset to query extents for, C<$length> is the
1287size of the range to query - if it is C<undef>, then the whole file will
1288be queried.
1289
1290C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1291C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1292exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1293the data portion.
1294
1295C<$count> is the maximum number of extent records to return. If it is
1296C<undef>, then IO::AIO queries all extents of the file. As a very special
1297case, if it is C<0>, then the callback receives the number of extents
1298instead of the extents themselves.
1299
1300If an error occurs, the callback receives no arguments. The special
1301C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1302
1303Otherwise, the callback receives an array reference with extent
1304structures. Each extent structure is an array reference itself, with the
1305following members:
1306
1307 [$logical, $physical, $length, $flags]
1308
1309Flags is any combination of the following flag values (typically either C<0>
1310or C<IO::AIO::FIEMAP_EXTENT_LAST>):
1311
1312C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1313C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1314C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1315C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1316C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1317C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1318
1254=item aio_group $callback->(...) 1319=item aio_group $callback->(...)
1255 1320
1256This is a very special aio request: Instead of doing something, it is a 1321This is a very special aio request: Instead of doing something, it is a
1257container for other aio requests, which is useful if you want to bundle 1322container for other aio requests, which is useful if you want to bundle
1258many requests into a single, composite, request with a definite callback 1323many requests into a single, composite, request with a definite callback
… …
1860ENOSYS, otherwise the return value of C<mprotect>. 1925ENOSYS, otherwise the return value of C<mprotect>.
1861 1926
1862=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1927=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1863 1928
1864Memory-maps a file (or anonymous memory range) and attaches it to the 1929Memory-maps a file (or anonymous memory range) and attaches it to the
1865given C<$scalar>, which will act like a string scalar. 1930given C<$scalar>, which will act like a string scalar. Returns true on
1931success, and false otherwise.
1866 1932
1867The only operations allowed on the scalar are C<substr>/C<vec> that don't 1933The only operations allowed on the scalar are C<substr>/C<vec> that don't
1868change the string length, and most read-only operations such as copying it 1934change the string length, and most read-only operations such as copying it
1869or searching it with regexes and so on. 1935or searching it with regexes and so on.
1870 1936
… …
1923Calls the C<munlockall> function. 1989Calls the C<munlockall> function.
1924 1990
1925On systems that do not implement C<munlockall>, this function returns 1991On systems that do not implement C<munlockall>, this function returns
1926ENOSYS, otherwise the return value of C<munlockall>. 1992ENOSYS, otherwise the return value of C<munlockall>.
1927 1993
1994=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1995
1996Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1997C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1998should be the file offset.
1999
2000C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2001silently corrupt the data in this case.
2002
2003The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2004C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2005C<IO::AIO::SPLICE_F_GIFT>.
2006
2007See the C<splice(2)> manpage for details.
2008
2009=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2010
2011Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2012description for C<IO::AIO::splice> above for details.
2013
1928=back 2014=back
1929 2015
1930=cut 2016=cut
1931 2017
1932min_parallel 8; 2018min_parallel 8;

Diff Legend

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