1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | IO::AIO - Asynchronous Input/Output |
3 | IO::AIO - Asynchronous/Advanced Input/Output |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use IO::AIO; |
7 | use IO::AIO; |
8 | |
8 | |
… | |
… | |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
59 | files currently, for example), and they would only support aio_read and |
59 | files currently, for example), and they would only support aio_read and |
60 | aio_write, so the remaining functionality would have to be implemented |
60 | aio_write, so the remaining functionality would have to be implemented |
61 | using threads anyway. |
61 | using threads anyway. |
62 | |
62 | |
|
|
63 | In addition to asynchronous I/O, this module also exports some rather |
|
|
64 | arcane interfaces, such as C<madvise> or linux's C<splice> system call, |
|
|
65 | which is why the C<A> in C<AIO> can also mean I<advanced>. |
|
|
66 | |
63 | Although the module will work in the presence of other (Perl-) threads, |
67 | Although the module will work in the presence of other (Perl-) threads, |
64 | it is currently not reentrant in any way, so use appropriate locking |
68 | it is currently not reentrant in any way, so use appropriate locking |
65 | yourself, always call C<poll_cb> from within the same thread, or never |
69 | yourself, always call C<poll_cb> from within the same thread, or never |
66 | call C<poll_cb> (or other C<aio_> functions) recursively. |
70 | call C<poll_cb> (or other C<aio_> functions) recursively. |
67 | |
71 | |
… | |
… | |
167 | use common::sense; |
171 | use common::sense; |
168 | |
172 | |
169 | use base 'Exporter'; |
173 | use base 'Exporter'; |
170 | |
174 | |
171 | BEGIN { |
175 | BEGIN { |
172 | our $VERSION = 4.34; |
176 | our $VERSION = 4.4; |
173 | |
177 | |
174 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | 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 |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
176 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
177 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
178 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
179 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
180 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs |
187 | aio_statvfs |
|
|
188 | aio_slurp |
184 | aio_wd); |
189 | aio_wd); |
185 | |
190 | |
186 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
… | |
… | |
229 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_readlink $pathname, $callback->($link) |
236 | aio_readlink $pathname, $callback->($link) |
232 | aio_realpath $pathname, $callback->($path) |
237 | aio_realpath $pathname, $callback->($path) |
233 | aio_rename $srcpath, $dstpath, $callback->($status) |
238 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
239 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
234 | aio_mkdir $pathname, $mode, $callback->($status) |
240 | aio_mkdir $pathname, $mode, $callback->($status) |
235 | aio_rmdir $pathname, $callback->($status) |
241 | aio_rmdir $pathname, $callback->($status) |
236 | aio_readdir $pathname, $callback->($entries) |
242 | aio_readdir $pathname, $callback->($entries) |
237 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
243 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
238 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
244 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
248 | aio_syncfs $fh, $callback->($status) |
254 | aio_syncfs $fh, $callback->($status) |
249 | aio_fsync $fh, $callback->($status) |
255 | aio_fsync $fh, $callback->($status) |
250 | aio_fdatasync $fh, $callback->($status) |
256 | aio_fdatasync $fh, $callback->($status) |
251 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
257 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
252 | aio_pathsync $pathname, $callback->($status) |
258 | aio_pathsync $pathname, $callback->($status) |
253 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
254 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
260 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
255 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
261 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
256 | aio_mlockall $flags, $callback->($status) |
262 | aio_mlockall $flags, $callback->($status) |
257 | aio_group $callback->(...) |
263 | aio_group $callback->(...) |
258 | aio_nop $callback->() |
264 | aio_nop $callback->() |
… | |
… | |
272 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
273 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
274 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
275 | IO::AIO::nready |
281 | IO::AIO::nready |
276 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
|
|
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
277 | |
285 | |
278 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
279 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
280 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
281 | IO::AIO::munmap $scalar |
289 | IO::AIO::munmap $scalar |
… | |
… | |
441 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
449 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | |
450 | |
443 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
451 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
444 | |
452 | |
445 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
453 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
446 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
454 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
447 | and calls the callback without the actual number of bytes read (or -1 on |
455 | calls the callback with the actual number of bytes transferred (or -1 on |
448 | error, just like the syscall). |
456 | error, just like the syscall). |
449 | |
457 | |
450 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
458 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
451 | offset plus the actual number of bytes read. |
459 | offset plus the actual number of bytes read. |
452 | |
460 | |
… | |
… | |
735 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
743 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
736 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
744 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
737 | to deallocate a file range. |
745 | to deallocate a file range. |
738 | |
746 | |
739 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
747 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
740 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
748 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
741 | your L<fallocate(2)> manpage). |
749 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
750 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
742 | |
751 | |
743 | The file system block size used by C<fallocate> is presumably the |
752 | The file system block size used by C<fallocate> is presumably the |
744 | C<f_bsize> returned by C<statvfs>. |
753 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
754 | can dictate other limitations. |
745 | |
755 | |
746 | If C<fallocate> isn't available or cannot be emulated (currently no |
756 | If C<fallocate> isn't available or cannot be emulated (currently no |
747 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
757 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
748 | |
758 | |
749 | |
759 | |
… | |
… | |
806 | rename(2) and call the callback with the result code. |
816 | rename(2) and call the callback with the result code. |
807 | |
817 | |
808 | On systems that support the AIO::WD working directory abstraction |
818 | On systems that support the AIO::WD working directory abstraction |
809 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
819 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
810 | of failing, C<rename> is called on the absolute path of C<$wd>. |
820 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
821 | |
|
|
822 | |
|
|
823 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
824 | |
|
|
825 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
826 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
827 | C<aio_rename>. |
|
|
828 | |
|
|
829 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
830 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
831 | |
|
|
832 | The following constants are available (missing ones are, as usual C<0>), |
|
|
833 | see renameat2(2) for details: |
|
|
834 | |
|
|
835 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
836 | and C<IO::AIO::RENAME_WHITEOUT>. |
811 | |
837 | |
812 | |
838 | |
813 | =item aio_mkdir $pathname, $mode, $callback->($status) |
839 | =item aio_mkdir $pathname, $mode, $callback->($status) |
814 | |
840 | |
815 | Asynchronously mkdir (create) a directory and call the callback with |
841 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
901 | C<$type>'s are known, which can be used to speed up some algorithms. |
927 | C<$type>'s are known, which can be used to speed up some algorithms. |
902 | |
928 | |
903 | =back |
929 | =back |
904 | |
930 | |
905 | |
931 | |
|
|
932 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
933 | |
|
|
934 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
935 | which is resized as required. |
|
|
936 | |
|
|
937 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
938 | |
|
|
939 | If C<$length> is zero, then the remaining length of the file is |
|
|
940 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
941 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
942 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
943 | C<$length> results in a performance advantage. |
|
|
944 | |
|
|
945 | This request is similar to the older C<aio_load> request, but since it is |
|
|
946 | a single request, it might be more efficient to use. |
|
|
947 | |
|
|
948 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
949 | |
|
|
950 | my $passwd; |
|
|
951 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
952 | $_[0] >= 0 |
|
|
953 | or die "/etc/passwd: $!\n"; |
|
|
954 | |
|
|
955 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
956 | print $passwd; |
|
|
957 | }; |
|
|
958 | IO::AIO::flush; |
|
|
959 | |
|
|
960 | |
906 | =item aio_load $pathname, $data, $callback->($status) |
961 | =item aio_load $pathname, $data, $callback->($status) |
907 | |
962 | |
908 | This is a composite request that tries to fully load the given file into |
963 | This is a composite request that tries to fully load the given file into |
909 | memory. Status is the same as with aio_read. |
964 | memory. Status is the same as with aio_read. |
|
|
965 | |
|
|
966 | Using C<aio_slurp> might be more efficient, as it is a single request. |
910 | |
967 | |
911 | =cut |
968 | =cut |
912 | |
969 | |
913 | sub aio_load($$;$) { |
970 | sub aio_load($$;$) { |
914 | my ($path, undef, $cb) = @_; |
971 | my ($path, undef, $cb) = @_; |
… | |
… | |
934 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
991 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
935 | |
992 | |
936 | Try to copy the I<file> (directories not supported as either source or |
993 | Try to copy the I<file> (directories not supported as either source or |
937 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
994 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
938 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
995 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
996 | |
|
|
997 | Existing destination files will be truncated. |
939 | |
998 | |
940 | This is a composite request that creates the destination file with |
999 | This is a composite request that creates the destination file with |
941 | mode 0200 and copies the contents of the source file into it using |
1000 | mode 0200 and copies the contents of the source file into it using |
942 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
1001 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
943 | uid/gid, in that order. |
1002 | uid/gid, in that order. |
… | |
… | |
1053 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1112 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1054 | efficiently separate the entries of directory C<$path> into two sets of |
1113 | efficiently separate the entries of directory C<$path> into two sets of |
1055 | names, directories you can recurse into (directories), and ones you cannot |
1114 | names, directories you can recurse into (directories), and ones you cannot |
1056 | recurse into (everything else, including symlinks to directories). |
1115 | recurse into (everything else, including symlinks to directories). |
1057 | |
1116 | |
1058 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1117 | C<aio_scandir> is a composite request that generates many sub requests. |
1059 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1118 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1060 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1119 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1061 | will be chosen (currently 4). |
1120 | will be chosen (currently 4). |
1062 | |
1121 | |
1063 | On error, the callback is called without arguments, otherwise it receives |
1122 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1248 | So in general, you should only use these calls for things that do |
1307 | So 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, |
1308 | (filesystem) I/O, not for things that wait for other events (network, |
1250 | other processes), although if you are careful and know what you are doing, |
1309 | other processes), although if you are careful and know what you are doing, |
1251 | you still can. |
1310 | you still can. |
1252 | |
1311 | |
|
|
1312 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1313 | |
|
|
1314 | C<F_DUPFD_CLOEXEC>, |
|
|
1315 | |
|
|
1316 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1317 | |
|
|
1318 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1319 | |
|
|
1320 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1321 | C<FS_IOC_FIEMAP>. |
|
|
1322 | |
|
|
1323 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1324 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1325 | |
|
|
1326 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1327 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1328 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1329 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1330 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1331 | |
|
|
1332 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1333 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1334 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1335 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1336 | |
1253 | =item aio_sync $callback->($status) |
1337 | =item aio_sync $callback->($status) |
1254 | |
1338 | |
1255 | Asynchronously call sync and call the callback when finished. |
1339 | Asynchronously call sync and call the callback when finished. |
1256 | |
1340 | |
1257 | =item aio_fsync $fh, $callback->($status) |
1341 | =item aio_fsync $fh, $callback->($status) |
… | |
… | |
1325 | }; |
1409 | }; |
1326 | |
1410 | |
1327 | $grp |
1411 | $grp |
1328 | } |
1412 | } |
1329 | |
1413 | |
1330 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1414 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1331 | |
1415 | |
1332 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1416 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1333 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1417 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1334 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1418 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1335 | scalar must only be modified in-place while an aio operation is pending on |
1419 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1337 | |
1421 | |
1338 | It calls the C<msync> function of your OS, if available, with the memory |
1422 | It calls the C<msync> function of your OS, if available, with the memory |
1339 | area starting at C<$offset> in the string and ending C<$length> bytes |
1423 | area starting at C<$offset> in the string and ending C<$length> bytes |
1340 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1424 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1341 | is C<undef>, then it goes till the end of the string. The flags can be |
1425 | is C<undef>, then it goes till the end of the string. The flags can be |
1342 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1426 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1343 | C<IO::AIO::MS_SYNC>. |
1427 | C<IO::AIO::MS_INVALIDATE>. |
1344 | |
1428 | |
1345 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1429 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1346 | |
1430 | |
1347 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1431 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1348 | scalars. |
1432 | scalars. |
… | |
… | |
1431 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1515 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1432 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1516 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1433 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1517 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1434 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1518 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1435 | |
1519 | |
1436 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1520 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1437 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1521 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1438 | it to return all extents of a range for files with large number of |
1522 | it to return all extents of a range for files with a large number of |
1439 | extents. The code works around all these issues if C<$count> is undef. |
1523 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1524 | C<undef>. |
1440 | |
1525 | |
1441 | =item aio_group $callback->(...) |
1526 | =item aio_group $callback->(...) |
1442 | |
1527 | |
1443 | This is a very special aio request: Instead of doing something, it is a |
1528 | This is a very special aio request: Instead of doing something, it is a |
1444 | container for other aio requests, which is useful if you want to bundle |
1529 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1557 | There are some caveats: when directories get renamed (or deleted), the |
1642 | There are some caveats: when directories get renamed (or deleted), the |
1558 | pathname string doesn't change, so will point to the new directory (or |
1643 | pathname string doesn't change, so will point to the new directory (or |
1559 | nowhere at all), while the directory fd, if available on the system, |
1644 | nowhere at all), while the directory fd, if available on the system, |
1560 | will still point to the original directory. Most functions accepting a |
1645 | will still point to the original directory. Most functions accepting a |
1561 | pathname will use the directory fd on newer systems, and the string on |
1646 | pathname will use the directory fd on newer systems, and the string on |
1562 | older systems. Some functions (such as realpath) will always rely on the |
1647 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1563 | string form of the pathname. |
1648 | the string form of the pathname. |
1564 | |
1649 | |
1565 | So this functionality is mainly useful to get some protection against |
1650 | So this functionality is mainly useful to get some protection against |
1566 | C<chdir>, to easily get an absolute path out of a relative path for future |
1651 | C<chdir>, to easily get an absolute path out of a relative path for future |
1567 | reference, and to speed up doing many operations in the same directory |
1652 | reference, and to speed up doing many operations in the same directory |
1568 | (e.g. when stat'ing all files in a directory). |
1653 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1960 | This is a very bad function to use in interactive programs because it |
2045 | This is a very bad function to use in interactive programs because it |
1961 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2046 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1962 | use an C<aio_group> together with a feed callback. |
2047 | use an C<aio_group> together with a feed callback. |
1963 | |
2048 | |
1964 | Its main use is in scripts without an event loop - when you want to stat |
2049 | Its main use is in scripts without an event loop - when you want to stat |
1965 | a lot of files, you can write somehting like this: |
2050 | a lot of files, you can write something like this: |
1966 | |
2051 | |
1967 | IO::AIO::max_outstanding 32; |
2052 | IO::AIO::max_outstanding 32; |
1968 | |
2053 | |
1969 | for my $path (...) { |
2054 | for my $path (...) { |
1970 | aio_stat $path , ...; |
2055 | aio_stat $path , ...; |
… | |
… | |
2015 | some "Advanced I/O" function not available to in Perl, without going the |
2100 | some "Advanced I/O" function not available to in Perl, without going the |
2016 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2101 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2017 | counterpart. |
2102 | counterpart. |
2018 | |
2103 | |
2019 | =over 4 |
2104 | =over 4 |
|
|
2105 | |
|
|
2106 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2107 | |
|
|
2108 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2109 | |
|
|
2110 | Tries to find the current file descriptor limit and returns it, or |
|
|
2111 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2112 | the highest valid file descriptor number. |
|
|
2113 | |
|
|
2114 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2115 | |
|
|
2116 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2117 | |
|
|
2118 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2119 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2120 | is missing, it will try to set a very high limit, although this is not |
|
|
2121 | recommended when you know the actual minimum that you require. |
|
|
2122 | |
|
|
2123 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2124 | attempt to increase the limit as much as possible, using various |
|
|
2125 | tricks, while still failing. You can query the resulting limit using |
|
|
2126 | C<IO::AIO::get_fdlimit>. |
|
|
2127 | |
|
|
2128 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2129 | true. |
2020 | |
2130 | |
2021 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2131 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2022 | |
2132 | |
2023 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2133 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2024 | but is blocking (this makes most sense if you know the input data is |
2134 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2041 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2151 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2042 | |
2152 | |
2043 | Simply calls the C<posix_madvise> function (see its |
2153 | Simply calls the C<posix_madvise> function (see its |
2044 | manpage for details). The following advice constants are |
2154 | manpage for details). The following advice constants are |
2045 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2155 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2046 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2156 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
|
|
2157 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2158 | |
|
|
2159 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2160 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2161 | will be reduced to fit into the C<$scalar>. |
2047 | |
2162 | |
2048 | On systems that do not implement C<posix_madvise>, this function returns |
2163 | On systems that do not implement C<posix_madvise>, this function returns |
2049 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2164 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2050 | |
2165 | |
2051 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2166 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2053 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2168 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2054 | $scalar (see its manpage for details). The following protect |
2169 | $scalar (see its manpage for details). The following protect |
2055 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2170 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2056 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2171 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2057 | |
2172 | |
|
|
2173 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2174 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2175 | will be reduced to fit into the C<$scalar>. |
|
|
2176 | |
2058 | On systems that do not implement C<mprotect>, this function returns |
2177 | On systems that do not implement C<mprotect>, this function returns |
2059 | ENOSYS, otherwise the return value of C<mprotect>. |
2178 | ENOSYS, otherwise the return value of C<mprotect>. |
2060 | |
2179 | |
2061 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2180 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2062 | |
2181 | |
2063 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2182 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2064 | given C<$scalar>, which will act like a string scalar. Returns true on |
2183 | given C<$scalar>, which will act like a string scalar. Returns true on |
2065 | success, and false otherwise. |
2184 | success, and false otherwise. |
2066 | |
2185 | |
|
|
2186 | The scalar must exist, but its contents do not matter - this means you |
|
|
2187 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2188 | the scalar first. |
|
|
2189 | |
2067 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2190 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2068 | change the string length, and most read-only operations such as copying it |
2191 | which don't change the string length, and most read-only operations such |
2069 | or searching it with regexes and so on. |
2192 | as copying it or searching it with regexes and so on. |
2070 | |
2193 | |
2071 | Anything else is unsafe and will, at best, result in memory leaks. |
2194 | Anything else is unsafe and will, at best, result in memory leaks. |
2072 | |
2195 | |
2073 | The memory map associated with the C<$scalar> is automatically removed |
2196 | The memory map associated with the C<$scalar> is automatically removed |
2074 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2197 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2075 | C<IO::AIO::munmap> functions are called. |
2198 | or C<IO::AIO::munmap> functions are called on it. |
2076 | |
2199 | |
2077 | This calls the C<mmap>(2) function internally. See your system's manual |
2200 | This calls the C<mmap>(2) function internally. See your system's manual |
2078 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2201 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2079 | |
2202 | |
2080 | The C<$length> must be larger than zero and smaller than the actual |
2203 | The C<$length> must be larger than zero and smaller than the actual |