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.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.234 by root, Mon Aug 13 01:02: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)
… …
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_allocate $fh, $mode, $offset, $len, $callback->($status)
227 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
227 aio_unlink $pathname, $callback->($status) 228 aio_unlink $pathname, $callback->($status)
228 aio_mknod $pathname, $mode, $dev, $callback->($status) 229 aio_mknod $pathname, $mode, $dev, $callback->($status)
229 aio_link $srcpath, $dstpath, $callback->($status) 230 aio_link $srcpath, $dstpath, $callback->($status)
230 aio_symlink $srcpath, $dstpath, $callback->($status) 231 aio_symlink $srcpath, $dstpath, $callback->($status)
231 aio_readlink $pathname, $callback->($link) 232 aio_readlink $pathname, $callback->($link)
… …
361 362
362 363
363=item aio_open $pathname, $flags, $mode, $callback->($fh) 364=item aio_open $pathname, $flags, $mode, $callback->($fh)
364 365
365Asynchronously 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
366created filehandle for the file. 367created filehandle for the file (or C<undef> in case of an error).
367 368
368The 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,
369for an explanation. 370for an explanation.
370 371
371The 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
… …
1276 1277
1277 aio_mlockall IO::AIO::MCL_FUTURE; 1278 aio_mlockall IO::AIO::MCL_FUTURE;
1278 1279
1279=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1280=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1280 1281
1281Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1282Queries the extents of the given file (by calling the Linux C<FIEMAP>
1282see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1283ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1283C<ioctl> is not available on your OS, then this rquiest will fail with 1284the ioctl is not available on your OS, then this request will fail with
1284C<ENOSYS>. 1285C<ENOSYS>.
1285 1286
1286C<$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
1287size 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
1288be queried. 1289be queried.
… …
1291C<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
1292exported), 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
1293the data portion. 1294the data portion.
1294 1295
1295C<$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
1296C<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
1297case, 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
1298instead of the extents themselves. 1299instead of the extents themselves (which is unreliable, see below).
1299 1300
1300If an error occurs, the callback receives no arguments. The special 1301If an error occurs, the callback receives no arguments. The special
1301C<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.
1302 1303
1303Otherwise, the callback receives an array reference with extent 1304Otherwise, the callback receives an array reference with extent
… …
1305following members: 1306following members:
1306 1307
1307 [$logical, $physical, $length, $flags] 1308 [$logical, $physical, $length, $flags]
1308 1309
1309Flags 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>
1310or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1311or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1311 1312
1312C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1313C<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_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_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_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_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1317C<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.
1318 1324
1319=item aio_group $callback->(...) 1325=item aio_group $callback->(...)
1320 1326
1321This 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
1322container 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

Diff Legend

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