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.226 by root, Mon May 28 17:00:19 2012 UTC vs.
Revision 1.233 by root, Mon Aug 13 01:01:04 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)
… …
360 362
361 363
362=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
363 365
364Asynchronously open or create a file and call the callback with a newly 366Asynchronously open or create a file and call the callback with a newly
365created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
366 368
367The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 369The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
368for an explanation. 370for an explanation.
369 371
370The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 372The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
… …
636 638
637 639
638=item aio_truncate $fh_or_path, $offset, $callback->($status) 640=item aio_truncate $fh_or_path, $offset, $callback->($status)
639 641
640Works 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>.
641 659
642 660
643=item aio_chmod $fh_or_path, $mode, $callback->($status) 661=item aio_chmod $fh_or_path, $mode, $callback->($status)
644 662
645Works like perl's C<chmod> function. 663Works like perl's C<chmod> function.
… …
1261 1279
1262=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1280=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1263 1281
1264Queries 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,
1265see 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
1266C<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
1267C<ENOSYS>. 1285C<ENOSYS>.
1268 1286
1269C<$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
1270size 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
1271be queried. 1289be queried.
… …
1274C<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
1275exported), 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
1276the data portion. 1294the data portion.
1277 1295
1278C<$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
1279C<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
1280case, 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
1281instead of the extents themselves. 1299instead of the extents themselves (which is unreliable, see below).
1282 1300
1283If an error occurs, the callback receives no arguments. The special 1301If an error occurs, the callback receives no arguments. The special
1284C<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.
1285 1303
1286Otherwise, the callback receives an array reference with extent 1304Otherwise, the callback receives an array reference with extent
… …
1288following members: 1306following members:
1289 1307
1290 [$logical, $physical, $length, $flags] 1308 [$logical, $physical, $length, $flags]
1291 1309
1292Flags 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>
1293or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1311or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1294 1312
1295C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1313C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1296C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1314C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1297C<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>,
1298C<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>,
1299C<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
1300C<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.
1301 1324
1302=item aio_group $callback->(...) 1325=item aio_group $callback->(...)
1303 1326
1304This 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
1305container 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
… …
1908ENOSYS, otherwise the return value of C<mprotect>. 1931ENOSYS, otherwise the return value of C<mprotect>.
1909 1932
1910=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1933=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1911 1934
1912Memory-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
1913given 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.
1914 1938
1915The 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
1916change 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
1917or searching it with regexes and so on. 1941or searching it with regexes and so on.
1918 1942
… …
1977 2001
1978Calls 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
1979C<$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
1980should be the file offset. 2004should be the file offset.
1981 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
1982The 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>,
1983C<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
1984C<IO::AIO::SPLICE_F_GIFT>. 2011C<IO::AIO::SPLICE_F_GIFT>.
1985 2012
1986See 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