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.212 by root, Thu Sep 29 22:42:15 2011 UTC vs.
Revision 1.227 by root, Tue May 29 03:58:02 2012 UTC

… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.0'; 173 our $VERSION = '4.15';
174 174
175 our @AIO_REQ = qw(aio_sendfile 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
… …
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)
214 aio_seek $fh,$offset,$whence, $callback->($offs)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 216 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 217 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval) 218 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status) 219 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status) 220 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs) 221 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 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)
223 aio_truncate $fh_or_path, $offset, $callback->($status) 225 aio_truncate $fh_or_path, $offset, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_unlink $pathname, $callback->($status) 226 aio_unlink $pathname, $callback->($status)
226 aio_mknod $pathname, $mode, $dev, $callback->($status) 227 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 228 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 229 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $pathname, $callback->($link) 230 aio_readlink $pathname, $callback->($link)
… …
233 aio_rmdir $pathname, $callback->($status) 234 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 235 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 236 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 237 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 238 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
239 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238 aio_load $pathname, $data, $callback->($status) 240 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status) 241 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status) 242 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $pathname, $callback->($status) 243 aio_rmtree $pathname, $callback->($status)
243 aio_sync $callback->($status) 244 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 245 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 246 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 247 aio_fdatasync $fh, $callback->($status)
… …
271 IO::AIO::nready 272 IO::AIO::nready
272 IO::AIO::npending 273 IO::AIO::npending
273 274
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count 275 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice 276 IO::AIO::fadvise $fh, $offset, $len, $advice
277 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
278 IO::AIO::munmap $scalar
276 IO::AIO::madvise $scalar, $offset, $length, $advice 279 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 280 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 281 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 282 IO::AIO::munlockall
280 283
281=head2 AIO REQUEST FUNCTIONS 284=head2 API NOTES
282 285
283All the C<aio_*> calls are more or less thin wrappers around the syscall 286All the C<aio_*> calls are more or less thin wrappers around the syscall
284with the same name (sans C<aio_>). The arguments are similar or identical, 287with the same name (sans C<aio_>). The arguments are similar or identical,
285and they all accept an additional (and optional) C<$callback> argument 288and they all accept an additional (and optional) C<$callback> argument
286which must be a code reference. This code reference will be called after 289which must be a code reference. This code reference will be called after
… …
317correct contents. 320correct contents.
318 321
319This works, btw. independent of the internal UTF-8 bit, which IO::AIO 322This works, btw. independent of the internal UTF-8 bit, which IO::AIO
320handles correctly whether it is set or not. 323handles correctly whether it is set or not.
321 324
325=head2 AIO REQUEST FUNCTIONS
326
322=over 4 327=over 4
323 328
324=item $prev_pri = aioreq_pri [$pri] 329=item $prev_pri = aioreq_pri [$pri]
325 330
326Returns the priority value that would be used for the next request and, if 331Returns the priority value that would be used for the next request and, if
… …
407 412
408Or in other words: the file descriptor will be closed, but it will not be 413Or in other words: the file descriptor will be closed, but it will not be
409free for reuse until the perl filehandle is closed. 414free for reuse until the perl filehandle is closed.
410 415
411=cut 416=cut
417
418=item aio_seek $fh, $offset, $whence, $callback->($offs)
419
420Seeks the filehandle to the new C<$offset>, similarly to perl's
421C<sysseek>. The C<$whence> can use the traditional values (C<0> for
422C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
423C<IO::AIO::SEEK_END>).
424
425The resulting absolute offset will be passed to the callback, or C<-1> in
426case of an error.
427
428In theory, the C<$whence> constants could be different than the
429corresponding values from L<Fcntl>, but perl guarantees they are the same,
430so don't panic.
431
432As a GNU/Linux (and maybe Solaris) extension, also the constants
433C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
434could be found. No guarantees about suitability for use in C<aio_seek> or
435Perl's C<sysseek> can be made though, although I would naively assume they
436"just work".
412 437
413=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 438=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
414 439
415=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
416 441
… …
1232 1257
1233Example: asynchronously lock all current and future pages into memory. 1258Example: asynchronously lock all current and future pages into memory.
1234 1259
1235 aio_mlockall IO::AIO::MCL_FUTURE; 1260 aio_mlockall IO::AIO::MCL_FUTURE;
1236 1261
1262=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1263
1264Queries 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
1266C<ioctl> is not available on your OS, then this rquiest will fail with
1267C<ENOSYS>.
1268
1269C<$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
1271be queried.
1272
1273C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1274C<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
1276the data portion.
1277
1278C<$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
1280case, if it is C<0>, then the callback receives the number of extents
1281instead of the extents themselves.
1282
1283If an error occurs, the callback receives no arguments. The special
1284C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1285
1286Otherwise, the callback receives an array reference with extent
1287structures. Each extent structure is an array reference itself, with the
1288following members:
1289
1290 [$logical, $physical, $length, $flags]
1291
1292Flags is any combination of the following flag values (typically either C<0>
1293or C<IO::AIO::FIEMAP_EXTENT_LAST>):
1294
1295C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1296C<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>,
1298C<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
1300C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1301
1237=item aio_group $callback->(...) 1302=item aio_group $callback->(...)
1238 1303
1239This is a very special aio request: Instead of doing something, it is a 1304This is a very special aio request: Instead of doing something, it is a
1240container for other aio requests, which is useful if you want to bundle 1305container for other aio requests, which is useful if you want to bundle
1241many requests into a single, composite, request with a definite callback 1306many requests into a single, composite, request with a definite callback
… …
1304object. This object stores the canonicalised, absolute version of the 1369object. This object stores the canonicalised, absolute version of the
1305path, and on systems that allow it, also a directory file descriptor. 1370path, and on systems that allow it, also a directory file descriptor.
1306 1371
1307Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> 1372Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1308or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD 1373or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1309object and a pathname instead. If the pathname is absolute, the 1374object and a pathname instead (or the IO::AIO::WD object alone, which
1375gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1310IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative 1376IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1311to that IO::AIO::WD object. 1377to that IO::AIO::WD object.
1312 1378
1313For example, to get a wd object for F</etc> and then stat F<passwd> 1379For example, to get a wd object for F</etc> and then stat F<passwd>
1314inside, you would write: 1380inside, you would write:
1315 1381
… …
1323 aio_stat [$etcdir, "passwd"], sub { 1389 aio_stat [$etcdir, "passwd"], sub {
1324 # yay 1390 # yay
1325 }; 1391 };
1326 }; 1392 };
1327 1393
1328This shows that creating an IO::AIO::WD object is itself a potentially 1394That C<aio_wd> is a request and not a normal function shows that creating
1329blocking operation, which is why it is done asynchronously. 1395an IO::AIO::WD object is itself a potentially blocking operation, which is
1396why it is done asynchronously.
1397
1398To stat the directory obtained with C<aio_wd> above, one could write
1399either of the following three request calls:
1400
1401 aio_lstat "/etc" , sub { ... # pathname as normal string
1402 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1403 aio_lstat $wd , sub { ... # shorthand for the previous
1330 1404
1331As with normal pathnames, IO::AIO keeps a copy of the working directory 1405As with normal pathnames, IO::AIO keeps a copy of the working directory
1332object and the pathname string, so you could write the following without 1406object and the pathname string, so you could write the following without
1333causing any issues due to C<$path> getting reused: 1407causing any issues due to C<$path> getting reused:
1334 1408
… …
1897Calls the C<munlockall> function. 1971Calls the C<munlockall> function.
1898 1972
1899On systems that do not implement C<munlockall>, this function returns 1973On systems that do not implement C<munlockall>, this function returns
1900ENOSYS, otherwise the return value of C<munlockall>. 1974ENOSYS, otherwise the return value of C<munlockall>.
1901 1975
1976=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1977
1978Calls 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
1980should be the file offset.
1981
1982C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
1983silently corrupt the data in this case.
1984
1985The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
1986C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1987C<IO::AIO::SPLICE_F_GIFT>.
1988
1989See the C<splice(2)> manpage for details.
1990
1991=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
1992
1993Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
1994description for C<IO::AIO::splice> above for details.
1995
1902=back 1996=back
1903 1997
1904=cut 1998=cut
1905 1999
1906min_parallel 8; 2000min_parallel 8;

Diff Legend

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