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.225 by root, Tue Apr 10 05:01:33 2012 UTC vs.
Revision 1.230 by root, Fri Jul 27 17:24:06 2012 UTC

… …
202 202
203=head1 FUNCTIONS 203=head1 FUNCTIONS
204 204
205=head2 QUICK OVERVIEW 205=head2 QUICK OVERVIEW
206 206
207This section simply lists the prototypes of the most important functions 207This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 208quick reference. See the following sections for function-by-function
209documentation. 209documentation.
210 210
211 aio_wd $pathname, $callback->($wd) 211 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 212 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 213 aio_close $fh, $callback->($status)
… …
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)
227 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226 aio_unlink $pathname, $callback->($status) 228 aio_unlink $pathname, $callback->($status)
227 aio_mknod $pathname, $mode, $dev, $callback->($status) 229 aio_mknod $pathname, $mode, $dev, $callback->($status)
228 aio_link $srcpath, $dstpath, $callback->($status) 230 aio_link $srcpath, $dstpath, $callback->($status)
229 aio_symlink $srcpath, $dstpath, $callback->($status) 231 aio_symlink $srcpath, $dstpath, $callback->($status)
230 aio_readlink $pathname, $callback->($link) 232 aio_readlink $pathname, $callback->($link)
… …
272 IO::AIO::nready 274 IO::AIO::nready
273 IO::AIO::npending 275 IO::AIO::npending
274 276
275 IO::AIO::sendfile $ofh, $ifh, $offset, $count 277 IO::AIO::sendfile $ofh, $ifh, $offset, $count
276 IO::AIO::fadvise $fh, $offset, $len, $advice 278 IO::AIO::fadvise $fh, $offset, $len, $advice
279 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
280 IO::AIO::munmap $scalar
277 IO::AIO::madvise $scalar, $offset, $length, $advice 281 IO::AIO::madvise $scalar, $offset, $length, $advice
278 IO::AIO::mprotect $scalar, $offset, $length, $protect 282 IO::AIO::mprotect $scalar, $offset, $length, $protect
279 IO::AIO::munlock $scalar, $offset = 0, $length = undef 283 IO::AIO::munlock $scalar, $offset = 0, $length = undef
280 IO::AIO::munlockall 284 IO::AIO::munlockall
281 285
… …
634 638
635 639
636=item aio_truncate $fh_or_path, $offset, $callback->($status) 640=item aio_truncate $fh_or_path, $offset, $callback->($status)
637 641
638Works like truncate(2) or ftruncate(2). 642Works like truncate(2) or ftruncate(2).
643
644
645=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
646
647Allocates or freed disk space according to the C<$mode> argument. See the
648linux C<fallocate> docuemntation for details.
649
650C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
651to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
652IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
653
654The file system block size used by C<fallocate> is presumably the
655C<f_bsize> returned by C<statvfs>.
656
657If C<fallocate> isn't available or cannot be emulated (currently no
658emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
639 659
640 660
641=item aio_chmod $fh_or_path, $mode, $callback->($status) 661=item aio_chmod $fh_or_path, $mode, $callback->($status)
642 662
643Works like perl's C<chmod> function. 663Works like perl's C<chmod> function.
… …
1259 1279
1260=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1280=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1261 1281
1262Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1282Queries the extents of the given file (by calling the Linux FIEMAP ioctl,
1263see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1283see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the
1264C<ioctl> is not available on your OS, then this rquiest will fail with 1284C<ioctl> is not available on your OS, then this request will fail with
1265C<ENOSYS>. 1285C<ENOSYS>.
1266 1286
1267C<$start> is the starting offset to query extents for, C<$length> is the 1287C<$start> is the starting offset to query extents for, C<$length> is the
1268size of the range to query - if it is C<undef>, then the whole file will 1288size of the range to query - if it is C<undef>, then the whole file will
1269be queried. 1289be queried.
… …
1906ENOSYS, otherwise the return value of C<mprotect>. 1926ENOSYS, otherwise the return value of C<mprotect>.
1907 1927
1908=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1928=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1909 1929
1910Memory-maps a file (or anonymous memory range) and attaches it to the 1930Memory-maps a file (or anonymous memory range) and attaches it to the
1911given C<$scalar>, which will act like a string scalar. 1931given C<$scalar>, which will act like a string scalar. Returns true on
1932success, and false otherwise.
1912 1933
1913The only operations allowed on the scalar are C<substr>/C<vec> that don't 1934The only operations allowed on the scalar are C<substr>/C<vec> that don't
1914change the string length, and most read-only operations such as copying it 1935change the string length, and most read-only operations such as copying it
1915or searching it with regexes and so on. 1936or searching it with regexes and so on.
1916 1937
… …
1975 1996
1976Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 1997Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1977C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they 1998C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1978should be the file offset. 1999should be the file offset.
1979 2000
2001C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2002silently corrupt the data in this case.
2003
1980The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, 2004The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
1981C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and 2005C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1982C<IO::AIO::SPLICE_F_GIFT>. 2006C<IO::AIO::SPLICE_F_GIFT>.
1983 2007
1984See the C<splice(2)> manpage for details. 2008See the C<splice(2)> manpage for details.

Diff Legend

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