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.232 by root, Mon Jul 30 16:46:30 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.
… …
1272C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also 1292C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1273exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query 1293exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1274the data portion. 1294the data portion.
1275 1295
1276C<$count> is the maximum number of extent records to return. If it is 1296C<$count> is the maximum number of extent records to return. If it is
1277C<undef>, then IO::AIO queries all extents of the file. As a very special 1297C<undef>, then IO::AIO queries all extents of the range. As a very special
1278case, if it is C<0>, then the callback receives the number of extents 1298case, if it is C<0>, then the callback receives the number of extents
1279instead of the extents themselves. 1299instead of the extents themselves (which is unreliable, see below).
1280 1300
1281If an error occurs, the callback receives no arguments. The special 1301If an error occurs, the callback receives no arguments. The special
1282C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. 1302C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1283 1303
1284Otherwise, the callback receives an array reference with extent 1304Otherwise, the callback receives an array reference with extent
… …
1286following members: 1306following members:
1287 1307
1288 [$logical, $physical, $length, $flags] 1308 [$logical, $physical, $length, $flags]
1289 1309
1290Flags is any combination of the following flag values (typically either C<0> 1310Flags is any combination of the following flag values (typically either C<0>
1291or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1311or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1292 1312
1293C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1313C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1294C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1314C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1295C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1315C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1296C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1316C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1297C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1317C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1298C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1318C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1319
1320At the time of this writing (Linux 3.2), this requets is unreliable unless
1321C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1322it to return all extents of a range for files with large number of
1323extents. The code works around all these issues if C<$count> is undef.
1299 1324
1300=item aio_group $callback->(...) 1325=item aio_group $callback->(...)
1301 1326
1302This is a very special aio request: Instead of doing something, it is a 1327This is a very special aio request: Instead of doing something, it is a
1303container for other aio requests, which is useful if you want to bundle 1328container for other aio requests, which is useful if you want to bundle
… …
1906ENOSYS, otherwise the return value of C<mprotect>. 1931ENOSYS, otherwise the return value of C<mprotect>.
1907 1932
1908=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1933=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1909 1934
1910Memory-maps a file (or anonymous memory range) and attaches it to the 1935Memory-maps a file (or anonymous memory range) and attaches it to the
1911given C<$scalar>, which will act like a string scalar. 1936given C<$scalar>, which will act like a string scalar. Returns true on
1937success, and false otherwise.
1912 1938
1913The only operations allowed on the scalar are C<substr>/C<vec> that don't 1939The 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 1940change the string length, and most read-only operations such as copying it
1915or searching it with regexes and so on. 1941or searching it with regexes and so on.
1916 1942
… …
1975 2001
1976Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 2002Calls 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 2003C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1978should be the file offset. 2004should be the file offset.
1979 2005
2006C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2007silently corrupt the data in this case.
2008
1980The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, 2009The 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 2010C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1982C<IO::AIO::SPLICE_F_GIFT>. 2011C<IO::AIO::SPLICE_F_GIFT>.
1983 2012
1984See the C<splice(2)> manpage for details. 2013See the C<splice(2)> manpage for details.

Diff Legend

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