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.279 by root, Sat Jan 6 01:04:42 2018 UTC vs.
Revision 1.300 by root, Sun Mar 10 12:11:46 2019 UTC

171use common::sense; 171use common::sense;
172 172
173use base 'Exporter'; 173use base 'Exporter';
174 174
175BEGIN { 175BEGIN {
176 our $VERSION = 4.4; 176 our $VERSION = 4.71;
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
285 285
286 IO::AIO::sendfile $ofh, $ifh, $offset, $count 286 IO::AIO::sendfile $ofh, $ifh, $offset, $count
287 IO::AIO::fadvise $fh, $offset, $len, $advice 287 IO::AIO::fadvise $fh, $offset, $len, $advice
288 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] 288 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289 IO::AIO::munmap $scalar 289 IO::AIO::munmap $scalar
290 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
290 IO::AIO::madvise $scalar, $offset, $length, $advice 291 IO::AIO::madvise $scalar, $offset, $length, $advice
291 IO::AIO::mprotect $scalar, $offset, $length, $protect 292 IO::AIO::mprotect $scalar, $offset, $length, $protect
292 IO::AIO::munlock $scalar, $offset = 0, $length = undef 293 IO::AIO::munlock $scalar, $offset = 0, $length = undef
293 IO::AIO::munlockall 294 IO::AIO::munlockall
294 295
404following POSIX and non-POSIX constants are available (missing ones on 405following POSIX and non-POSIX constants are available (missing ones on
405your system are, as usual, C<0>): 406your system are, as usual, C<0>):
406 407
407C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 408C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
408C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 409C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
409C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. 410C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
410 411
411 412
412=item aio_close $fh, $callback->($status) 413=item aio_close $fh, $callback->($status)
413 414
414Asynchronously close a file and call the callback with the result 415Asynchronously close a file and call the callback with the result
540 541
541=item aio_stat $fh_or_path, $callback->($status) 542=item aio_stat $fh_or_path, $callback->($status)
542 543
543=item aio_lstat $fh, $callback->($status) 544=item aio_lstat $fh, $callback->($status)
544 545
545Works like perl's C<stat> or C<lstat> in void context. The callback will 546Works almost exactly like perl's C<stat> or C<lstat> in void context. The
546be called after the stat and the results will be available using C<stat _> 547callback will be called after the stat and the results will be available
547or C<-s _> etc... 548using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
549and C<-T>).
548 550
549The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 551The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
550for an explanation. 552for an explanation.
551 553
552Currently, the stats are always 64-bit-stats, i.e. instead of returning an 554Currently, the stats are always 64-bit-stats, i.e. instead of returning an
559behaviour). 561behaviour).
560 562
561C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, 563C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
562C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, 564C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
563C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. 565C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
566
567To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
568ACCESS>.
564 569
565Example: Print the length of F</etc/passwd>: 570Example: Print the length of F</etc/passwd>:
566 571
567 aio_stat "/etc/passwd", sub { 572 aio_stat "/etc/passwd", sub {
568 $_[0] and die "stat failed: $!"; 573 $_[0] and die "stat failed: $!";
612 namemax => 255, 617 namemax => 255,
613 frsize => 1024, 618 frsize => 1024,
614 fsid => 1810 619 fsid => 1810
615 } 620 }
616 621
617Here is a (likely partial - send me updates!) list of fsid values used by
618Linux - it is safe to hardcode these when C<$^O> is C<linux>:
619
620 0x0000adf5 adfs
621 0x0000adff affs
622 0x5346414f afs
623 0x09041934 anon-inode filesystem
624 0x00000187 autofs
625 0x42465331 befs
626 0x1badface bfs
627 0x42494e4d binfmt_misc
628 0x9123683e btrfs
629 0x0027e0eb cgroupfs
630 0xff534d42 cifs
631 0x73757245 coda
632 0x012ff7b7 coh
633 0x28cd3d45 cramfs
634 0x453dcd28 cramfs-wend (wrong endianness)
635 0x64626720 debugfs
636 0x00001373 devfs
637 0x00001cd1 devpts
638 0x0000f15f ecryptfs
639 0x00414a53 efs
640 0x0000137d ext
641 0x0000ef53 ext2/ext3/ext4
642 0x0000ef51 ext2
643 0xf2f52010 f2fs
644 0x00004006 fat
645 0x65735546 fuseblk
646 0x65735543 fusectl
647 0x0bad1dea futexfs
648 0x01161970 gfs2
649 0x47504653 gpfs
650 0x00004244 hfs
651 0xf995e849 hpfs
652 0x00c0ffee hostfs
653 0x958458f6 hugetlbfs
654 0x2bad1dea inotifyfs
655 0x00009660 isofs
656 0x000072b6 jffs2
657 0x3153464a jfs
658 0x6b414653 k-afs
659 0x0bd00bd0 lustre
660 0x0000137f minix
661 0x0000138f minix 30 char names
662 0x00002468 minix v2
663 0x00002478 minix v2 30 char names
664 0x00004d5a minix v3
665 0x19800202 mqueue
666 0x00004d44 msdos
667 0x0000564c novell
668 0x00006969 nfs
669 0x6e667364 nfsd
670 0x00003434 nilfs
671 0x5346544e ntfs
672 0x00009fa1 openprom
673 0x7461636F ocfs2
674 0x00009fa0 proc
675 0x6165676c pstorefs
676 0x0000002f qnx4
677 0x68191122 qnx6
678 0x858458f6 ramfs
679 0x52654973 reiserfs
680 0x00007275 romfs
681 0x67596969 rpc_pipefs
682 0x73636673 securityfs
683 0xf97cff8c selinux
684 0x0000517b smb
685 0x534f434b sockfs
686 0x73717368 squashfs
687 0x62656572 sysfs
688 0x012ff7b6 sysv2
689 0x012ff7b5 sysv4
690 0x01021994 tmpfs
691 0x15013346 udf
692 0x00011954 ufs
693 0x54190100 ufs byteswapped
694 0x00009fa2 usbdevfs
695 0x01021997 v9fs
696 0xa501fcf5 vxfs
697 0xabba1974 xenfs
698 0x012ff7b4 xenix
699 0x58465342 xfs
700 0x012fd16d xia
701
702=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 622=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
703 623
704Works like perl's C<utime> function (including the special case of $atime 624Works like perl's C<utime> function (including the special case of $atime
705and $mtime being undef). Fractional times are supported if the underlying 625and $mtime being undef). Fractional times are supported if the underlying
706syscalls support them. 626syscalls support them.
707 627
708When called with a pathname, uses utimes(2) if available, otherwise 628When called with a pathname, uses utimensat(2) or utimes(2) if available,
709utime(2). If called on a file descriptor, uses futimes(2) if available, 629otherwise utime(2). If called on a file descriptor, uses futimens(2)
710otherwise returns ENOSYS, so this is not portable. 630or futimes(2) if available, otherwise returns ENOSYS, so this is not
631portable.
711 632
712Examples: 633Examples:
713 634
714 # set atime and mtime to current time (basically touch(1)): 635 # set atime and mtime to current time (basically touch(1)):
715 aio_utime "path", undef, undef; 636 aio_utime "path", undef, undef;
874 795
875=over 4 796=over 4
876 797
877=item IO::AIO::READDIR_DENTS 798=item IO::AIO::READDIR_DENTS
878 799
879When this flag is off, then the callback gets an arrayref consisting of 800Normally the callback gets an arrayref consisting of names only (as
880names only (as with C<aio_readdir>), otherwise it gets an arrayref with 801with C<aio_readdir>). If this flag is set, then the callback gets an
881C<[$name, $type, $inode]> arrayrefs, each describing a single directory 802arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
882entry in more detail. 803single directory entry in more detail:
883 804
884C<$name> is the name of the entry. 805C<$name> is the name of the entry.
885 806
886C<$type> is one of the C<IO::AIO::DT_xxx> constants: 807C<$type> is one of the C<IO::AIO::DT_xxx> constants:
887 808
888C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 809C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
889C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 810C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
890C<IO::AIO::DT_WHT>. 811C<IO::AIO::DT_WHT>.
891 812
892C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 813C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
893know, you have to run stat yourself. Also, for speed reasons, the C<$type> 814to know, you have to run stat yourself. Also, for speed/memory reasons,
894scalars are read-only: you can not modify them. 815the C<$type> scalars are read-only: you must not modify them.
895 816
896C<$inode> is the inode number (which might not be exact on systems with 64 817C<$inode> is the inode number (which might not be exact on systems with 64
897bit inode numbers and 32 bit perls). This field has unspecified content on 818bit inode numbers and 32 bit perls). This field has unspecified content on
898systems that do not deliver the inode information. 819systems that do not deliver the inode information.
899 820
910short names are tried first. 831short names are tried first.
911 832
912=item IO::AIO::READDIR_STAT_ORDER 833=item IO::AIO::READDIR_STAT_ORDER
913 834
914When this flag is set, then the names will be returned in an order 835When this flag is set, then the names will be returned in an order
915suitable for stat()'ing each one. That is, when you plan to stat() 836suitable for stat()'ing each one. That is, when you plan to stat() most or
916all files in the given directory, then the returned order will likely 837all files in the given directory, then the returned order will likely be
917be fastest. 838faster.
918 839
919If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 840If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
920the likely dirs come first, resulting in a less optimal stat order. 841then the likely dirs come first, resulting in a less optimal stat order
842for stat'ing all entries, but likely a more optimal order for finding
843subdirectories.
921 844
922=item IO::AIO::READDIR_FOUND_UNKNOWN 845=item IO::AIO::READDIR_FOUND_UNKNOWN
923 846
924This flag should not be set when calling C<aio_readdirx>. Instead, it 847This flag should not be set when calling C<aio_readdirx>. Instead, it
925is being set by C<aio_readdirx>, when any of the C<$type>'s found were 848is being set by C<aio_readdirx>, when any of the C<$type>'s found were
1186 aioreq_pri $pri; 1109 aioreq_pri $pri;
1187 add $grp aio_stat $wd, sub { 1110 add $grp aio_stat $wd, sub {
1188 return $grp->result () if $_[0]; 1111 return $grp->result () if $_[0];
1189 my $now = time; 1112 my $now = time;
1190 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1113 my $hash1 = join ":", (stat _)[0,1,3,7,9];
1114 my $rdxflags = READDIR_DIRS_FIRST;
1115
1116 if ((stat _)[3] < 2) {
1117 # at least one non-POSIX filesystem exists
1118 # that returns useful DT_type values: btrfs,
1119 # so optimise for this here by requesting dents
1120 $rdxflags |= READDIR_DENTS;
1121 }
1191 1122
1192 # read the directory entries 1123 # read the directory entries
1193 aioreq_pri $pri; 1124 aioreq_pri $pri;
1194 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { 1125 add $grp aio_readdirx $wd, $rdxflags, sub {
1195 my $entries = shift 1126 my ($entries, $flags) = @_
1196 or return $grp->result (); 1127 or return $grp->result ();
1128
1129 if ($rdxflags & READDIR_DENTS) {
1130 # if we requested type values, see if we can use them directly.
1131
1132 # if there were any DT_UNKNOWN entries then we assume we
1133 # don't know. alternatively, we could assume that if we get
1134 # one DT_DIR, then all directories are indeed marked with
1135 # DT_DIR, but this seems not required for btrfs, and this
1136 # is basically the "btrfs can't get it's act together" code
1137 # branch.
1138 unless ($flags & READDIR_FOUND_UNKNOWN) {
1139 # now we have valid DT_ information for all entries,
1140 # so use it as an optimisation without further stat's.
1141 # they must also all be at the beginning of @$entries
1142 # by now.
1143
1144 my $dirs;
1145
1146 if (@$entries) {
1147 for (0 .. $#$entries) {
1148 if ($entries->[$_][1] != DT_DIR) {
1149 # splice out directories
1150 $dirs = [splice @$entries, 0, $_];
1151 last;
1152 }
1153 }
1154
1155 # if we didn't find any non-dir, then all entries are dirs
1156 unless ($dirs) {
1157 ($dirs, $entries) = ($entries, []);
1158 }
1159 } else {
1160 # directory is empty, so there are no sbdirs
1161 $dirs = [];
1162 }
1163
1164 # either splice'd the directories out or the dir was empty.
1165 # convert dents to filenames
1166 $_ = $_->[0] for @$dirs;
1167 $_ = $_->[0] for @$entries;
1168
1169 return $grp->result ($dirs, $entries);
1170 }
1171
1172 # cannot use, so return to our old ways
1173 # by pretending we only scanned for names.
1174 $_ = $_->[0] for @$entries;
1175 }
1197 1176
1198 # stat the dir another time 1177 # stat the dir another time
1199 aioreq_pri $pri; 1178 aioreq_pri $pri;
1200 add $grp aio_stat $wd, sub { 1179 add $grp aio_stat $wd, sub {
1201 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1180 my $hash2 = join ":", (stat _)[0,1,3,7,9];
1462 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; 1441 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1463 aio_mlock $data; # mlock in background 1442 aio_mlock $data; # mlock in background
1464 1443
1465=item aio_mlockall $flags, $callback->($status) 1444=item aio_mlockall $flags, $callback->($status)
1466 1445
1467Calls the C<mlockall> function with the given C<$flags> (a combination of 1446Calls the C<mlockall> function with the given C<$flags> (a
1468C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). 1447combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
1448C<IO::AIO::MCL_ONFAULT>).
1469 1449
1470On systems that do not implement C<mlockall>, this function returns C<-1> 1450On systems that do not implement C<mlockall>, this function returns C<-1>
1471and sets errno to C<ENOSYS>. 1451and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
1452by the system result in a return value of C<-1> with errno being set to
1453C<EINVAL>.
1472 1454
1473Note that the corresponding C<munlockall> is synchronous and is 1455Note that the corresponding C<munlockall> is synchronous and is
1474documented under L<MISCELLANEOUS FUNCTIONS>. 1456documented under L<MISCELLANEOUS FUNCTIONS>.
1475 1457
1476Example: asynchronously lock all current and future pages into memory. 1458Example: asynchronously lock all current and future pages into memory.
1861The default value for the limit is C<0>, but note that setting a feeder 1843The default value for the limit is C<0>, but note that setting a feeder
1862automatically bumps it up to C<2>. 1844automatically bumps it up to C<2>.
1863 1845
1864=back 1846=back
1865 1847
1848
1866=head2 SUPPORT FUNCTIONS 1849=head2 SUPPORT FUNCTIONS
1867 1850
1868=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1851=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1869 1852
1870=over 4 1853=over 4
1935Strictly equivalent to: 1918Strictly equivalent to:
1936 1919
1937 IO::AIO::poll_wait, IO::AIO::poll_cb 1920 IO::AIO::poll_wait, IO::AIO::poll_cb
1938 while IO::AIO::nreqs; 1921 while IO::AIO::nreqs;
1939 1922
1923This function can be useful at program aborts, to make sure outstanding
1924I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1925this function on normal exits), or when you are merely using C<IO::AIO>
1926for its more advanced functions, rather than for async I/O, e.g.:
1927
1928 my ($dirs, $nondirs);
1929 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1930 IO::AIO::flush;
1931 # $dirs, $nondirs are now set
1932
1940=item IO::AIO::max_poll_reqs $nreqs 1933=item IO::AIO::max_poll_reqs $nreqs
1941 1934
1942=item IO::AIO::max_poll_time $seconds 1935=item IO::AIO::max_poll_time $seconds
1943 1936
1944These set the maximum number of requests (default C<0>, meaning infinity) 1937These set the maximum number of requests (default C<0>, meaning infinity)
1970 poll => 'r', nice => 1, 1963 poll => 'r', nice => 1,
1971 cb => &IO::AIO::poll_cb); 1964 cb => &IO::AIO::poll_cb);
1972 1965
1973=back 1966=back
1974 1967
1968
1975=head3 CONTROLLING THE NUMBER OF THREADS 1969=head3 CONTROLLING THE NUMBER OF THREADS
1976 1970
1977=over 1971=over
1978 1972
1979=item IO::AIO::min_parallel $nthreads 1973=item IO::AIO::min_parallel $nthreads
2066The default value for C<max_outstanding> is very large, so there is no 2060The default value for C<max_outstanding> is very large, so there is no
2067practical limit on the number of outstanding requests. 2061practical limit on the number of outstanding requests.
2068 2062
2069=back 2063=back
2070 2064
2065
2071=head3 STATISTICAL INFORMATION 2066=head3 STATISTICAL INFORMATION
2072 2067
2073=over 2068=over
2074 2069
2075=item IO::AIO::nreqs 2070=item IO::AIO::nreqs
2091 2086
2092Returns the number of requests currently in the pending state (executed, 2087Returns the number of requests currently in the pending state (executed,
2093but not yet processed by poll_cb). 2088but not yet processed by poll_cb).
2094 2089
2095=back 2090=back
2091
2092
2093=head3 SUBSECOND STAT TIME ACCESS
2094
2095Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2096generally find access/modification and change times with subsecond time
2097accuracy of the system supports it, but perl's built-in functions only
2098return the integer part.
2099
2100The following functions return the timestamps of the most recent
2101stat with subsecond precision on most systems and work both after
2102C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2103value is only meaningful after a successful C<stat>/C<lstat> call, or
2104during/after a successful C<aio_stat>/C<aio_lstat> callback.
2105
2106This is similar to the L<Time::HiRes> C<stat> functions, but can return
2107full resolution without rounding and work with standard perl C<stat>,
2108alleviating the need to call the special C<Time::HiRes> functions, which
2109do not act like their perl counterparts.
2110
2111On operating systems or file systems where subsecond time resolution is
2112not supported or could not be detected, a fractional part of C<0> is
2113returned, so it is always safe to call these functions.
2114
2115=over 4
2116
2117=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2118
2119Return the access, modication, change or birth time, respectively,
2120including fractional part. Due to the limited precision of floating point,
2121the accuracy on most platforms is only a bit better than milliseconds
2122for times around now - see the I<nsec> function family, below, for full
2123accuracy.
2124
2125File birth time is only available when the OS and perl support it (on
2126FreeBSD and NetBSD at the time of this writing, although support is
2127adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of
2128it). On systems where it isn't available, C<0> is currently returned, but
2129this might change to C<undef> in a future version.
2130
2131=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2132
2133Returns access, modification, change and birth time all in one go, and
2134maybe more times in the future version.
2135
2136=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2137
2138Return the fractional access, modifcation, change or birth time, in nanoseconds,
2139as an integer in the range C<0> to C<999999999>.
2140
2141Note that no accessors are provided for access, modification and
2142change times - you need to get those from C<stat _> if required (C<int
2143IO::AIO::st_atime> and so on will I<not> generally give you the correct
2144value).
2145
2146=item $seconds = IO::AIO::st_btimesec
2147
2148The (integral) seconds part of the file birth time, if available.
2149
2150=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2151
2152Like the functions above, but returns all four times in one go (and maybe
2153more in future versions).
2154
2155=item $counter = IO::AIO::st_gen
2156
2157Returns the generation counter (in practice this is just a random number)
2158of the file. This is only available on platforms which have this member in
2159their C<struct stat> (most BSDs at the time of this writing) and generally
2160only to the root usert. If unsupported, C<0> is returned, but this might
2161change to C<undef> in a future version.
2162
2163=back
2164
2165Example: print the high resolution modification time of F</etc>, using
2166C<stat>, and C<IO::AIO::aio_stat>.
2167
2168 if (stat "/etc") {
2169 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2170 }
2171
2172 IO::AIO::aio_stat "/etc", sub {
2173 $_[0]
2174 and return;
2175
2176 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2177 };
2178
2179 IO::AIO::flush;
2180
2181Output of the awbove on my system, showing reduced and full accuracy:
2182
2183 stat(/etc) mtime: 1534043702.020808
2184 aio_stat(/etc) mtime: 1534043702.020807792
2185
2096 2186
2097=head3 MISCELLANEOUS FUNCTIONS 2187=head3 MISCELLANEOUS FUNCTIONS
2098 2188
2099IO::AIO implements some functions that are useful when you want to use 2189IO::AIO implements some functions that are useful when you want to use
2100some "Advanced I/O" function not available to in Perl, without going the 2190some "Advanced I/O" function not available to in Perl, without going the
2241 2331
2242=item IO::AIO::munmap $scalar 2332=item IO::AIO::munmap $scalar
2243 2333
2244Removes a previous mmap and undefines the C<$scalar>. 2334Removes a previous mmap and undefines the C<$scalar>.
2245 2335
2336=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2337
2338Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2339been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2340C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2341
2342Returns true if successful, and false otherwise. If the underlying mmapped
2343region has changed address, then the true value has the numerical value
2344C<1>, otherwise it has the numerical value C<0>:
2345
2346 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2347 or die "mremap: $!";
2348
2349 if ($success*1) {
2350 warn "scalar has chanegd address in memory\n";
2351 }
2352
2353C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2354implemented, but not supported and might go away in a future version.
2355
2356On systems where this call is not supported or is not emulated, this call
2357returns falls and sets C<$!> to C<ENOSYS>.
2358
2359=item IO::AIO::mlockall $flags
2360
2361Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
2362but is blocking.
2363
2246=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2364=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2247 2365
2248Calls the C<munlock> function, undoing the effects of a previous 2366Calls the C<munlock> function, undoing the effects of a previous
2249C<aio_mlock> call (see its description for details). 2367C<aio_mlock> call (see its description for details).
2250 2368
2299C<$flags> is non-zero, fails with C<ENOSYS>. 2417C<$flags> is non-zero, fails with C<ENOSYS>.
2300 2418
2301Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the 2419Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2302time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and 2420time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2303C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. 2421C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2422
2423Example: create a pipe race-free w.r.t. threads and fork:
2424
2425 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2426 or die "pipe2: $!\n";
2427
2428=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2429
2430This is a direct interface to the Linux L<eventfd(2)> system call. The
2431(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2432
2433On success, the new eventfd filehandle is returned, otherwise returns
2434C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2435
2436Please refer to L<eventfd(2)> for more info on this call.
2437
2438The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2439C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2440
2441Example: create a new eventfd filehandle:
2442
2443 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
2444 or die "eventfd: $!\n";
2445
2446=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2447
2448This is a direct interface to the Linux L<timerfd_create(2)> system call. The
2449(unhelpful) default for C<$flags> is C<0>.
2450
2451On success, the new timerfd filehandle is returned, otherwise returns
2452C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2453
2454Please refer to L<timerfd_create(2)> for more info on this call.
2455
2456The following C<$clockid> values are
2457available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2458C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2459C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2460C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2461
2462The following C<$flags> values are available (Linux
24632.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2464
2465Example: create a new timerfd and set it to one-second repeated alarms,
2466then wait for two alarms:
2467
2468 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2469 or die "timerfd_create: $!\n";
2470
2471 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2472 or die "timerfd_settime: $!\n";
2473
2474 for (1..2) {
2475 8 == sysread $fh, my $buf, 8
2476 or die "timerfd read failure\n";
2477
2478 printf "number of expirations (likely 1): %d\n",
2479 unpack "Q", $buf;
2480 }
2481
2482=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2483
2484This is a direct interface to the Linux L<timerfd_settime(2)> system
2485call. Please refer to its manpage for more info on this call.
2486
2487The new itimerspec is specified using two (possibly fractional) second
2488values, C<$new_interval> and C<$new_value>).
2489
2490On success, the current interval and value are returned (as per
2491C<timerfd_gettime>). On failure, the empty list is returned.
2492
2493The following C<$flags> values are
2494available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2495C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2496
2497See C<IO::AIO::timerfd_create> for a full example.
2498
2499=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2500
2501This is a direct interface to the Linux L<timerfd_gettime(2)> system
2502call. Please refer to its manpage for more info on this call.
2503
2504On success, returns the current values of interval and value for the given
2505timerfd (as potentially fractional second values). On failure, the empty
2506list is returned.
2304 2507
2305=back 2508=back
2306 2509
2307=cut 2510=cut
2308 2511
2374the process will result in undefined behaviour. Calling it at any time 2577the process will result in undefined behaviour. Calling it at any time
2375will also result in any undefined (by POSIX) behaviour. 2578will also result in any undefined (by POSIX) behaviour.
2376 2579
2377=back 2580=back
2378 2581
2582=head2 LINUX-SPECIFIC CALLS
2583
2584When a call is documented as "linux-specific" then this means it
2585originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2586availability and compatibility of such calls regardless of the platform
2587it is compiled on, so platforms such as FreeBSD which often implement
2588these calls will work. When in doubt, call them and see if they fail wth
2589C<ENOSYS>.
2590
2379=head2 MEMORY USAGE 2591=head2 MEMORY USAGE
2380 2592
2381Per-request usage: 2593Per-request usage:
2382 2594
2383Each aio request uses - depending on your architecture - around 100-200 2595Each aio request uses - depending on your architecture - around 100-200
2395temporary buffers, and each thread requires a stack and other data 2607temporary buffers, and each thread requires a stack and other data
2396structures (usually around 16k-128k, depending on the OS). 2608structures (usually around 16k-128k, depending on the OS).
2397 2609
2398=head1 KNOWN BUGS 2610=head1 KNOWN BUGS
2399 2611
2400Known bugs will be fixed in the next release. 2612Known bugs will be fixed in the next release :)
2613
2614=head1 KNOWN ISSUES
2615
2616Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2617or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2618non-created hash slots or other scalars I didn't think of. It's best to
2619avoid such and either use scalar variables or making sure that the scalar
2620exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2621
2622I am not sure anything can be done about this, so this is considered a
2623known issue, rather than a bug.
2401 2624
2402=head1 SEE ALSO 2625=head1 SEE ALSO
2403 2626
2404L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2627L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2405more natural syntax. 2628more natural syntax.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines