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.258 by root, Thu Jan 21 23:04:46 2016 UTC vs.
Revision 1.264 by root, Mon Jul 18 07:48:01 2016 UTC

167use common::sense; 167use common::sense;
168 168
169use base 'Exporter'; 169use base 'Exporter';
170 170
171BEGIN { 171BEGIN {
172 our $VERSION = 4.33; 172 our $VERSION = 4.34;
173 173
174 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close 174 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
175 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 175 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
176 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 176 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
177 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate 177 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
178 aio_pathsync aio_readahead aio_fiemap 178 aio_pathsync aio_readahead aio_fiemap aio_allocate
179 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
181 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_mlock aio_mlockall 182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs 183 aio_statvfs
240 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) 240 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
241 aio_load $pathname, $data, $callback->($status) 241 aio_load $pathname, $data, $callback->($status)
242 aio_copy $srcpath, $dstpath, $callback->($status) 242 aio_copy $srcpath, $dstpath, $callback->($status)
243 aio_move $srcpath, $dstpath, $callback->($status) 243 aio_move $srcpath, $dstpath, $callback->($status)
244 aio_rmtree $pathname, $callback->($status) 244 aio_rmtree $pathname, $callback->($status)
245 aio_fcntl $fh, $cmd, $arg, $callback->($status)
246 aio_ioctl $fh, $request, $buf, $callback->($status)
245 aio_sync $callback->($status) 247 aio_sync $callback->($status)
246 aio_syncfs $fh, $callback->($status) 248 aio_syncfs $fh, $callback->($status)
247 aio_fsync $fh, $callback->($status) 249 aio_fsync $fh, $callback->($status)
248 aio_fdatasync $fh, $callback->($status) 250 aio_fdatasync $fh, $callback->($status)
249 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 251 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
508As native sendfile syscalls (as practically any non-POSIX interface hacked 510As native sendfile syscalls (as practically any non-POSIX interface hacked
509together in a hurry to improve benchmark numbers) tend to be rather buggy 511together in a hurry to improve benchmark numbers) tend to be rather buggy
510on many systems, this implementation tries to work around some known bugs 512on many systems, this implementation tries to work around some known bugs
511in Linux and FreeBSD kernels (probably others, too), but that might fail, 513in Linux and FreeBSD kernels (probably others, too), but that might fail,
512so you really really should check the return value of C<aio_sendfile> - 514so you really really should check the return value of C<aio_sendfile> -
513fewre bytes than expected might have been transferred. 515fewer bytes than expected might have been transferred.
514 516
515 517
516=item aio_readahead $fh,$offset,$length, $callback->($retval) 518=item aio_readahead $fh,$offset,$length, $callback->($retval)
517 519
518C<aio_readahead> populates the page cache with data from a file so that 520C<aio_readahead> populates the page cache with data from a file so that
522whole pages, so that offset is effectively rounded down to a page boundary 524whole pages, so that offset is effectively rounded down to a page boundary
523and bytes are read up to the next page boundary greater than or equal to 525and bytes are read up to the next page boundary greater than or equal to
524(off-set+length). C<aio_readahead> does not read beyond the end of the 526(off-set+length). C<aio_readahead> does not read beyond the end of the
525file. The current file offset of the file is left unchanged. 527file. The current file offset of the file is left unchanged.
526 528
527If that syscall doesn't exist (likely if your OS isn't Linux) it will be 529If that syscall doesn't exist (likely if your kernel isn't Linux) it will
528emulated by simply reading the data, which would have a similar effect. 530be emulated by simply reading the data, which would have a similar effect.
529 531
530 532
531=item aio_stat $fh_or_path, $callback->($status) 533=item aio_stat $fh_or_path, $callback->($status)
532 534
533=item aio_lstat $fh, $callback->($status) 535=item aio_lstat $fh, $callback->($status)
1227 }; 1229 };
1228 1230
1229 $grp 1231 $grp
1230} 1232}
1231 1233
1234=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1235
1236=item aio_ioctl $fh, $request, $buf, $callback->($status)
1237
1238These work just like the C<fcntl> and C<ioctl> built-in functions, except
1239they execute asynchronously and pass the return value to the callback.
1240
1241Both calls can be used for a lot of things, some of which make more sense
1242to run asynchronously in their own thread, while some others make less
1243sense. For example, calls that block waiting for external events, such
1244as locking, will also lock down an I/O thread while it is waiting, which
1245can deadlock the whole I/O system. At the same time, there might be no
1246alternative to using a thread to wait.
1247
1248So in general, you should only use these calls for things that do
1249(filesystem) I/O, not for things that wait for other events (network,
1250other processes), although if you are careful and know what you are doing,
1251you still can.
1252
1253The following constants are available (missing ones are, as usual C<0>):
1254
1255C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1256
1257C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1258C<FS_IOC_FIEMAP>.
1259
1260C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1261C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1262
1263C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1264C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1265C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1266C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1267C<FS_FL_USER_MODIFIABLE>.
1268
1269C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1270C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1271C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1272C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1273
1232=item aio_sync $callback->($status) 1274=item aio_sync $callback->($status)
1233 1275
1234Asynchronously call sync and call the callback when finished. 1276Asynchronously call sync and call the callback when finished.
1235 1277
1236=item aio_fsync $fh, $callback->($status) 1278=item aio_fsync $fh, $callback->($status)
2020=item IO::AIO::madvise $scalar, $offset, $len, $advice 2062=item IO::AIO::madvise $scalar, $offset, $len, $advice
2021 2063
2022Simply calls the C<posix_madvise> function (see its 2064Simply calls the C<posix_madvise> function (see its
2023manpage for details). The following advice constants are 2065manpage for details). The following advice constants are
2024available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2066available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2025C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2067C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
2068C<IO::AIO::MADV_FREE>.
2026 2069
2027On systems that do not implement C<posix_madvise>, this function returns 2070On systems that do not implement C<posix_madvise>, this function returns
2028ENOSYS, otherwise the return value of C<posix_madvise>. 2071ENOSYS, otherwise the return value of C<posix_madvise>.
2029 2072
2030=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2073=item IO::AIO::mprotect $scalar, $offset, $len, $protect

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines