… | |
… | |
171 | use common::sense; |
171 | use common::sense; |
172 | |
172 | |
173 | use base 'Exporter'; |
173 | use base 'Exporter'; |
174 | |
174 | |
175 | BEGIN { |
175 | BEGIN { |
176 | our $VERSION = 4.4; |
176 | our $VERSION = 4.72; |
177 | |
177 | |
178 | 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 |
179 | 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 |
180 | 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 |
181 | 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 |
… | |
… | |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
193 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
194 | nreqs nready npending nthreads |
194 | nreqs nready npending nthreads |
195 | max_poll_time max_poll_reqs |
195 | max_poll_time max_poll_reqs |
196 | sendfile fadvise madvise |
196 | sendfile fadvise madvise |
197 | mmap munmap munlock munlockall); |
197 | mmap munmap mremap munlock munlockall); |
198 | |
198 | |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
200 | |
200 | |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
202 | |
202 | |
… | |
… | |
278 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
279 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
280 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
281 | IO::AIO::nready |
281 | IO::AIO::nready |
282 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | IO::AIO::reinit |
|
|
284 | |
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
285 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
286 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
285 | |
287 | |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
288 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
289 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
290 | |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
291 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
289 | IO::AIO::munmap $scalar |
292 | IO::AIO::munmap $scalar |
|
|
293 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
290 | IO::AIO::madvise $scalar, $offset, $length, $advice |
294 | IO::AIO::madvise $scalar, $offset, $length, $advice |
291 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
295 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
292 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
296 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
293 | IO::AIO::munlockall |
297 | IO::AIO::munlockall |
|
|
298 | |
|
|
299 | # stat extensions |
|
|
300 | $counter = IO::AIO::st_gen |
|
|
301 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
302 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
303 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
304 | $seconds = IO::AIO::st_btimesec |
|
|
305 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
306 | |
|
|
307 | # very much unportable syscalls |
|
|
308 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
309 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
310 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
311 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
312 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
313 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
314 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
315 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
316 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
294 | |
317 | |
295 | =head2 API NOTES |
318 | =head2 API NOTES |
296 | |
319 | |
297 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
320 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
298 | with the same name (sans C<aio_>). The arguments are similar or identical, |
321 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
404 | following POSIX and non-POSIX constants are available (missing ones on |
427 | following POSIX and non-POSIX constants are available (missing ones on |
405 | your system are, as usual, C<0>): |
428 | your system are, as usual, C<0>): |
406 | |
429 | |
407 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
430 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
408 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
431 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
409 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. |
432 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>. |
410 | |
433 | |
411 | |
434 | |
412 | =item aio_close $fh, $callback->($status) |
435 | =item aio_close $fh, $callback->($status) |
413 | |
436 | |
414 | Asynchronously close a file and call the callback with the result |
437 | Asynchronously close a file and call the callback with the result |
… | |
… | |
540 | |
563 | |
541 | =item aio_stat $fh_or_path, $callback->($status) |
564 | =item aio_stat $fh_or_path, $callback->($status) |
542 | |
565 | |
543 | =item aio_lstat $fh, $callback->($status) |
566 | =item aio_lstat $fh, $callback->($status) |
544 | |
567 | |
545 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
568 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
546 | be called after the stat and the results will be available using C<stat _> |
569 | callback will be called after the stat and the results will be available |
547 | or C<-s _> etc... |
570 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
|
|
571 | and C<-T>). |
548 | |
572 | |
549 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
573 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
550 | for an explanation. |
574 | for an explanation. |
551 | |
575 | |
552 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
576 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
… | |
… | |
559 | behaviour). |
583 | behaviour). |
560 | |
584 | |
561 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
585 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
562 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
586 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
563 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
587 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
588 | |
|
|
589 | To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME |
|
|
590 | ACCESS>. |
564 | |
591 | |
565 | Example: Print the length of F</etc/passwd>: |
592 | Example: Print the length of F</etc/passwd>: |
566 | |
593 | |
567 | aio_stat "/etc/passwd", sub { |
594 | aio_stat "/etc/passwd", sub { |
568 | $_[0] and die "stat failed: $!"; |
595 | $_[0] and die "stat failed: $!"; |
… | |
… | |
618 | |
645 | |
619 | Works like perl's C<utime> function (including the special case of $atime |
646 | Works like perl's C<utime> function (including the special case of $atime |
620 | and $mtime being undef). Fractional times are supported if the underlying |
647 | and $mtime being undef). Fractional times are supported if the underlying |
621 | syscalls support them. |
648 | syscalls support them. |
622 | |
649 | |
623 | When called with a pathname, uses utimes(2) if available, otherwise |
650 | When called with a pathname, uses utimensat(2) or utimes(2) if available, |
624 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
651 | otherwise utime(2). If called on a file descriptor, uses futimens(2) |
625 | otherwise returns ENOSYS, so this is not portable. |
652 | or futimes(2) if available, otherwise returns ENOSYS, so this is not |
|
|
653 | portable. |
626 | |
654 | |
627 | Examples: |
655 | Examples: |
628 | |
656 | |
629 | # set atime and mtime to current time (basically touch(1)): |
657 | # set atime and mtime to current time (basically touch(1)): |
630 | aio_utime "path", undef, undef; |
658 | aio_utime "path", undef, undef; |
… | |
… | |
789 | |
817 | |
790 | =over 4 |
818 | =over 4 |
791 | |
819 | |
792 | =item IO::AIO::READDIR_DENTS |
820 | =item IO::AIO::READDIR_DENTS |
793 | |
821 | |
794 | When this flag is off, then the callback gets an arrayref consisting of |
822 | Normally the callback gets an arrayref consisting of names only (as |
795 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
823 | with C<aio_readdir>). If this flag is set, then the callback gets an |
796 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
824 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
797 | entry in more detail. |
825 | single directory entry in more detail: |
798 | |
826 | |
799 | C<$name> is the name of the entry. |
827 | C<$name> is the name of the entry. |
800 | |
828 | |
801 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
829 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
802 | |
830 | |
803 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
831 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
804 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
832 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
805 | C<IO::AIO::DT_WHT>. |
833 | C<IO::AIO::DT_WHT>. |
806 | |
834 | |
807 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
835 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
808 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
836 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
809 | scalars are read-only: you can not modify them. |
837 | the C<$type> scalars are read-only: you must not modify them. |
810 | |
838 | |
811 | C<$inode> is the inode number (which might not be exact on systems with 64 |
839 | C<$inode> is the inode number (which might not be exact on systems with 64 |
812 | bit inode numbers and 32 bit perls). This field has unspecified content on |
840 | bit inode numbers and 32 bit perls). This field has unspecified content on |
813 | systems that do not deliver the inode information. |
841 | systems that do not deliver the inode information. |
814 | |
842 | |
… | |
… | |
825 | short names are tried first. |
853 | short names are tried first. |
826 | |
854 | |
827 | =item IO::AIO::READDIR_STAT_ORDER |
855 | =item IO::AIO::READDIR_STAT_ORDER |
828 | |
856 | |
829 | When this flag is set, then the names will be returned in an order |
857 | When this flag is set, then the names will be returned in an order |
830 | suitable for stat()'ing each one. That is, when you plan to stat() |
858 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
831 | all files in the given directory, then the returned order will likely |
859 | all files in the given directory, then the returned order will likely be |
832 | be fastest. |
860 | faster. |
833 | |
861 | |
834 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
862 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
835 | the likely dirs come first, resulting in a less optimal stat order. |
863 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
864 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
865 | subdirectories. |
836 | |
866 | |
837 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
867 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
838 | |
868 | |
839 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
869 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
840 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
870 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
1101 | aioreq_pri $pri; |
1131 | aioreq_pri $pri; |
1102 | add $grp aio_stat $wd, sub { |
1132 | add $grp aio_stat $wd, sub { |
1103 | return $grp->result () if $_[0]; |
1133 | return $grp->result () if $_[0]; |
1104 | my $now = time; |
1134 | my $now = time; |
1105 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
1135 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
1136 | my $rdxflags = READDIR_DIRS_FIRST; |
|
|
1137 | |
|
|
1138 | if ((stat _)[3] < 2) { |
|
|
1139 | # at least one non-POSIX filesystem exists |
|
|
1140 | # that returns useful DT_type values: btrfs, |
|
|
1141 | # so optimise for this here by requesting dents |
|
|
1142 | $rdxflags |= READDIR_DENTS; |
|
|
1143 | } |
1106 | |
1144 | |
1107 | # read the directory entries |
1145 | # read the directory entries |
1108 | aioreq_pri $pri; |
1146 | aioreq_pri $pri; |
1109 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1147 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1110 | my $entries = shift |
1148 | my ($entries, $flags) = @_ |
1111 | or return $grp->result (); |
1149 | or return $grp->result (); |
|
|
1150 | |
|
|
1151 | if ($rdxflags & READDIR_DENTS) { |
|
|
1152 | # if we requested type values, see if we can use them directly. |
|
|
1153 | |
|
|
1154 | # if there were any DT_UNKNOWN entries then we assume we |
|
|
1155 | # don't know. alternatively, we could assume that if we get |
|
|
1156 | # one DT_DIR, then all directories are indeed marked with |
|
|
1157 | # DT_DIR, but this seems not required for btrfs, and this |
|
|
1158 | # is basically the "btrfs can't get it's act together" code |
|
|
1159 | # branch. |
|
|
1160 | unless ($flags & READDIR_FOUND_UNKNOWN) { |
|
|
1161 | # now we have valid DT_ information for all entries, |
|
|
1162 | # so use it as an optimisation without further stat's. |
|
|
1163 | # they must also all be at the beginning of @$entries |
|
|
1164 | # by now. |
|
|
1165 | |
|
|
1166 | my $dirs; |
|
|
1167 | |
|
|
1168 | if (@$entries) { |
|
|
1169 | for (0 .. $#$entries) { |
|
|
1170 | if ($entries->[$_][1] != DT_DIR) { |
|
|
1171 | # splice out directories |
|
|
1172 | $dirs = [splice @$entries, 0, $_]; |
|
|
1173 | last; |
|
|
1174 | } |
|
|
1175 | } |
|
|
1176 | |
|
|
1177 | # if we didn't find any non-dir, then all entries are dirs |
|
|
1178 | unless ($dirs) { |
|
|
1179 | ($dirs, $entries) = ($entries, []); |
|
|
1180 | } |
|
|
1181 | } else { |
|
|
1182 | # directory is empty, so there are no sbdirs |
|
|
1183 | $dirs = []; |
|
|
1184 | } |
|
|
1185 | |
|
|
1186 | # either splice'd the directories out or the dir was empty. |
|
|
1187 | # convert dents to filenames |
|
|
1188 | $_ = $_->[0] for @$dirs; |
|
|
1189 | $_ = $_->[0] for @$entries; |
|
|
1190 | |
|
|
1191 | return $grp->result ($dirs, $entries); |
|
|
1192 | } |
|
|
1193 | |
|
|
1194 | # cannot use, so return to our old ways |
|
|
1195 | # by pretending we only scanned for names. |
|
|
1196 | $_ = $_->[0] for @$entries; |
|
|
1197 | } |
1112 | |
1198 | |
1113 | # stat the dir another time |
1199 | # stat the dir another time |
1114 | aioreq_pri $pri; |
1200 | aioreq_pri $pri; |
1115 | add $grp aio_stat $wd, sub { |
1201 | add $grp aio_stat $wd, sub { |
1116 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1202 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1222 | So in general, you should only use these calls for things that do |
1308 | So in general, you should only use these calls for things that do |
1223 | (filesystem) I/O, not for things that wait for other events (network, |
1309 | (filesystem) I/O, not for things that wait for other events (network, |
1224 | other processes), although if you are careful and know what you are doing, |
1310 | other processes), although if you are careful and know what you are doing, |
1225 | you still can. |
1311 | you still can. |
1226 | |
1312 | |
1227 | The following constants are available (missing ones are, as usual C<0>): |
1313 | The following constants are available and can be used for normal C<ioctl> |
|
|
1314 | and C<fcntl> as well (missing ones are, as usual C<0>): |
1228 | |
1315 | |
1229 | C<F_DUPFD_CLOEXEC>, |
1316 | C<F_DUPFD_CLOEXEC>, |
1230 | |
1317 | |
1231 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1318 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1232 | |
1319 | |
1233 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1320 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1321 | |
|
|
1322 | C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and |
|
|
1323 | C<F_SEAL_WRITE>. |
1234 | |
1324 | |
1235 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1325 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1236 | C<FS_IOC_FIEMAP>. |
1326 | C<FS_IOC_FIEMAP>. |
1237 | |
1327 | |
1238 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
1328 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
… | |
… | |
1377 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1467 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1378 | aio_mlock $data; # mlock in background |
1468 | aio_mlock $data; # mlock in background |
1379 | |
1469 | |
1380 | =item aio_mlockall $flags, $callback->($status) |
1470 | =item aio_mlockall $flags, $callback->($status) |
1381 | |
1471 | |
1382 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1472 | Calls the C<mlockall> function with the given C<$flags> (a |
1383 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1473 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1474 | C<IO::AIO::MCL_ONFAULT>). |
1384 | |
1475 | |
1385 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1476 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1386 | and sets errno to C<ENOSYS>. |
1477 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1478 | by the system result in a return value of C<-1> with errno being set to |
|
|
1479 | C<EINVAL>. |
1387 | |
1480 | |
1388 | Note that the corresponding C<munlockall> is synchronous and is |
1481 | Note that the corresponding C<munlockall> is synchronous and is |
1389 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1482 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1390 | |
1483 | |
1391 | Example: asynchronously lock all current and future pages into memory. |
1484 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1776 | The default value for the limit is C<0>, but note that setting a feeder |
1869 | The default value for the limit is C<0>, but note that setting a feeder |
1777 | automatically bumps it up to C<2>. |
1870 | automatically bumps it up to C<2>. |
1778 | |
1871 | |
1779 | =back |
1872 | =back |
1780 | |
1873 | |
|
|
1874 | |
1781 | =head2 SUPPORT FUNCTIONS |
1875 | =head2 SUPPORT FUNCTIONS |
1782 | |
1876 | |
1783 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1877 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1784 | |
1878 | |
1785 | =over 4 |
1879 | =over 4 |
… | |
… | |
1850 | Strictly equivalent to: |
1944 | Strictly equivalent to: |
1851 | |
1945 | |
1852 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1946 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1853 | while IO::AIO::nreqs; |
1947 | while IO::AIO::nreqs; |
1854 | |
1948 | |
|
|
1949 | This function can be useful at program aborts, to make sure outstanding |
|
|
1950 | I/O has been done (C<IO::AIO> uses an C<END> block which already calls |
|
|
1951 | this function on normal exits), or when you are merely using C<IO::AIO> |
|
|
1952 | for its more advanced functions, rather than for async I/O, e.g.: |
|
|
1953 | |
|
|
1954 | my ($dirs, $nondirs); |
|
|
1955 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1956 | IO::AIO::flush; |
|
|
1957 | # $dirs, $nondirs are now set |
|
|
1958 | |
1855 | =item IO::AIO::max_poll_reqs $nreqs |
1959 | =item IO::AIO::max_poll_reqs $nreqs |
1856 | |
1960 | |
1857 | =item IO::AIO::max_poll_time $seconds |
1961 | =item IO::AIO::max_poll_time $seconds |
1858 | |
1962 | |
1859 | These set the maximum number of requests (default C<0>, meaning infinity) |
1963 | These set the maximum number of requests (default C<0>, meaning infinity) |
… | |
… | |
1885 | poll => 'r', nice => 1, |
1989 | poll => 'r', nice => 1, |
1886 | cb => &IO::AIO::poll_cb); |
1990 | cb => &IO::AIO::poll_cb); |
1887 | |
1991 | |
1888 | =back |
1992 | =back |
1889 | |
1993 | |
|
|
1994 | |
1890 | =head3 CONTROLLING THE NUMBER OF THREADS |
1995 | =head3 CONTROLLING THE NUMBER OF THREADS |
1891 | |
1996 | |
1892 | =over |
1997 | =over |
1893 | |
1998 | |
1894 | =item IO::AIO::min_parallel $nthreads |
1999 | =item IO::AIO::min_parallel $nthreads |
… | |
… | |
1981 | The default value for C<max_outstanding> is very large, so there is no |
2086 | The default value for C<max_outstanding> is very large, so there is no |
1982 | practical limit on the number of outstanding requests. |
2087 | practical limit on the number of outstanding requests. |
1983 | |
2088 | |
1984 | =back |
2089 | =back |
1985 | |
2090 | |
|
|
2091 | |
1986 | =head3 STATISTICAL INFORMATION |
2092 | =head3 STATISTICAL INFORMATION |
1987 | |
2093 | |
1988 | =over |
2094 | =over |
1989 | |
2095 | |
1990 | =item IO::AIO::nreqs |
2096 | =item IO::AIO::nreqs |
… | |
… | |
2006 | |
2112 | |
2007 | Returns the number of requests currently in the pending state (executed, |
2113 | Returns the number of requests currently in the pending state (executed, |
2008 | but not yet processed by poll_cb). |
2114 | but not yet processed by poll_cb). |
2009 | |
2115 | |
2010 | =back |
2116 | =back |
|
|
2117 | |
|
|
2118 | |
|
|
2119 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2120 | |
|
|
2121 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
|
|
2122 | generally find access/modification and change times with subsecond time |
|
|
2123 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2124 | return the integer part. |
|
|
2125 | |
|
|
2126 | The following functions return the timestamps of the most recent |
|
|
2127 | stat with subsecond precision on most systems and work both after |
|
|
2128 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2129 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2130 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2131 | |
|
|
2132 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2133 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2134 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2135 | do not act like their perl counterparts. |
|
|
2136 | |
|
|
2137 | On operating systems or file systems where subsecond time resolution is |
|
|
2138 | not supported or could not be detected, a fractional part of C<0> is |
|
|
2139 | returned, so it is always safe to call these functions. |
|
|
2140 | |
|
|
2141 | =over 4 |
|
|
2142 | |
|
|
2143 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
2144 | |
|
|
2145 | Return the access, modication, change or birth time, respectively, |
|
|
2146 | including fractional part. Due to the limited precision of floating point, |
|
|
2147 | the accuracy on most platforms is only a bit better than milliseconds |
|
|
2148 | for times around now - see the I<nsec> function family, below, for full |
|
|
2149 | accuracy. |
|
|
2150 | |
|
|
2151 | File birth time is only available when the OS and perl support it (on |
|
|
2152 | FreeBSD and NetBSD at the time of this writing, although support is |
|
|
2153 | adaptive, so if your OS/perl gains support, IO::AIO can take advantage of |
|
|
2154 | it). On systems where it isn't available, C<0> is currently returned, but |
|
|
2155 | this might change to C<undef> in a future version. |
|
|
2156 | |
|
|
2157 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
2158 | |
|
|
2159 | Returns access, modification, change and birth time all in one go, and |
|
|
2160 | maybe more times in the future version. |
|
|
2161 | |
|
|
2162 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
2163 | |
|
|
2164 | Return the fractional access, modifcation, change or birth time, in nanoseconds, |
|
|
2165 | as an integer in the range C<0> to C<999999999>. |
|
|
2166 | |
|
|
2167 | Note that no accessors are provided for access, modification and |
|
|
2168 | change times - you need to get those from C<stat _> if required (C<int |
|
|
2169 | IO::AIO::st_atime> and so on will I<not> generally give you the correct |
|
|
2170 | value). |
|
|
2171 | |
|
|
2172 | =item $seconds = IO::AIO::st_btimesec |
|
|
2173 | |
|
|
2174 | The (integral) seconds part of the file birth time, if available. |
|
|
2175 | |
|
|
2176 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
2177 | |
|
|
2178 | Like the functions above, but returns all four times in one go (and maybe |
|
|
2179 | more in future versions). |
|
|
2180 | |
|
|
2181 | =item $counter = IO::AIO::st_gen |
|
|
2182 | |
|
|
2183 | Returns the generation counter (in practice this is just a random number) |
|
|
2184 | of the file. This is only available on platforms which have this member in |
|
|
2185 | their C<struct stat> (most BSDs at the time of this writing) and generally |
|
|
2186 | only to the root usert. If unsupported, C<0> is returned, but this might |
|
|
2187 | change to C<undef> in a future version. |
|
|
2188 | |
|
|
2189 | =back |
|
|
2190 | |
|
|
2191 | Example: print the high resolution modification time of F</etc>, using |
|
|
2192 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2193 | |
|
|
2194 | if (stat "/etc") { |
|
|
2195 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2196 | } |
|
|
2197 | |
|
|
2198 | IO::AIO::aio_stat "/etc", sub { |
|
|
2199 | $_[0] |
|
|
2200 | and return; |
|
|
2201 | |
|
|
2202 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2203 | }; |
|
|
2204 | |
|
|
2205 | IO::AIO::flush; |
|
|
2206 | |
|
|
2207 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2208 | |
|
|
2209 | stat(/etc) mtime: 1534043702.020808 |
|
|
2210 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2211 | |
2011 | |
2212 | |
2012 | =head3 MISCELLANEOUS FUNCTIONS |
2213 | =head3 MISCELLANEOUS FUNCTIONS |
2013 | |
2214 | |
2014 | IO::AIO implements some functions that are useful when you want to use |
2215 | IO::AIO implements some functions that are useful when you want to use |
2015 | some "Advanced I/O" function not available to in Perl, without going the |
2216 | some "Advanced I/O" function not available to in Perl, without going the |
… | |
… | |
2156 | |
2357 | |
2157 | =item IO::AIO::munmap $scalar |
2358 | =item IO::AIO::munmap $scalar |
2158 | |
2359 | |
2159 | Removes a previous mmap and undefines the C<$scalar>. |
2360 | Removes a previous mmap and undefines the C<$scalar>. |
2160 | |
2361 | |
|
|
2362 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2363 | |
|
|
2364 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2365 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2366 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2367 | |
|
|
2368 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2369 | region has changed address, then the true value has the numerical value |
|
|
2370 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2371 | |
|
|
2372 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2373 | or die "mremap: $!"; |
|
|
2374 | |
|
|
2375 | if ($success*1) { |
|
|
2376 | warn "scalar has chanegd address in memory\n"; |
|
|
2377 | } |
|
|
2378 | |
|
|
2379 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2380 | implemented, but not supported and might go away in a future version. |
|
|
2381 | |
|
|
2382 | On systems where this call is not supported or is not emulated, this call |
|
|
2383 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2384 | |
|
|
2385 | =item IO::AIO::mlockall $flags |
|
|
2386 | |
|
|
2387 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2388 | but is blocking. |
|
|
2389 | |
2161 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2390 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2162 | |
2391 | |
2163 | Calls the C<munlock> function, undoing the effects of a previous |
2392 | Calls the C<munlock> function, undoing the effects of a previous |
2164 | C<aio_mlock> call (see its description for details). |
2393 | C<aio_mlock> call (see its description for details). |
2165 | |
2394 | |
… | |
… | |
2220 | Example: create a pipe race-free w.r.t. threads and fork: |
2449 | Example: create a pipe race-free w.r.t. threads and fork: |
2221 | |
2450 | |
2222 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2451 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2223 | or die "pipe2: $!\n"; |
2452 | or die "pipe2: $!\n"; |
2224 | |
2453 | |
|
|
2454 | =item $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2455 | |
|
|
2456 | This is a direct interface to the Linux L<memfd_create(2)> system |
|
|
2457 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2458 | should be C<IO::AIO::MFD_CLOEXEC>. |
|
|
2459 | |
|
|
2460 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2461 | C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>. |
|
|
2462 | |
|
|
2463 | Please refer to L<memfd_create(2)> for more info on this call. |
|
|
2464 | |
|
|
2465 | The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>, |
|
|
2466 | C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>. |
|
|
2467 | |
|
|
2468 | Example: create a new memfd. |
|
|
2469 | |
|
|
2470 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2471 | or die "m,emfd_create: $!\n"; |
2225 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2472 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2226 | |
2473 | |
2227 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2474 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2228 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2475 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2229 | |
2476 | |
… | |
… | |
2235 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2482 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2236 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2483 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2237 | |
2484 | |
2238 | Example: create a new eventfd filehandle: |
2485 | Example: create a new eventfd filehandle: |
2239 | |
2486 | |
2240 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
2487 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
2241 | or die "eventfd: $!\n"; |
2488 | or die "eventfd: $!\n"; |
2242 | |
2489 | |
2243 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2490 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2244 | |
2491 | |
2245 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
2492 | This is a direct interface to the Linux L<timerfd_create(2)> system |
2246 | (unhelpful) default for C<$flags> is C<0>. |
2493 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2494 | should be C<IO::AIO::TFD_CLOEXEC>. |
2247 | |
2495 | |
2248 | On success, the new timerfd filehandle is returned, otherwise returns |
2496 | On success, the new timerfd filehandle is returned, otherwise returns |
2249 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
2497 | C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>. |
2250 | |
2498 | |
2251 | Please refer to L<timerfd_create(2)> for more info on this call. |
2499 | Please refer to L<timerfd_create(2)> for more info on this call. |
2252 | |
2500 | |
2253 | The following C<$clockid> values are |
2501 | The following C<$clockid> values are |
2254 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
2502 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |