… | |
… | |
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.54; |
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 |
… | |
… | |
541 | |
541 | |
542 | =item aio_stat $fh_or_path, $callback->($status) |
542 | =item aio_stat $fh_or_path, $callback->($status) |
543 | |
543 | |
544 | =item aio_lstat $fh, $callback->($status) |
544 | =item aio_lstat $fh, $callback->($status) |
545 | |
545 | |
546 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
546 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
547 | be called after the stat and the results will be available using C<stat _> |
547 | callback will be called after the stat and the results will be available |
548 | or C<-s _> etc... |
548 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
|
|
549 | and C<-T>). |
549 | |
550 | |
550 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
551 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
551 | for an explanation. |
552 | for an explanation. |
552 | |
553 | |
553 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
554 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
… | |
… | |
622 | |
623 | |
623 | Works like perl's C<utime> function (including the special case of $atime |
624 | Works like perl's C<utime> function (including the special case of $atime |
624 | and $mtime being undef). Fractional times are supported if the underlying |
625 | and $mtime being undef). Fractional times are supported if the underlying |
625 | syscalls support them. |
626 | syscalls support them. |
626 | |
627 | |
627 | When called with a pathname, uses utimes(2) if available, otherwise |
628 | When called with a pathname, uses utimensat(2) or utimes(2) if available, |
628 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
629 | otherwise utime(2). If called on a file descriptor, uses futimens(2) |
629 | otherwise returns ENOSYS, so this is not portable. |
630 | or futimes(2) if available, otherwise returns ENOSYS, so this is not |
|
|
631 | portable. |
630 | |
632 | |
631 | Examples: |
633 | Examples: |
632 | |
634 | |
633 | # set atime and mtime to current time (basically touch(1)): |
635 | # set atime and mtime to current time (basically touch(1)): |
634 | aio_utime "path", undef, undef; |
636 | aio_utime "path", undef, undef; |
… | |
… | |
1107 | aioreq_pri $pri; |
1109 | aioreq_pri $pri; |
1108 | add $grp aio_stat $wd, sub { |
1110 | add $grp aio_stat $wd, sub { |
1109 | return $grp->result () if $_[0]; |
1111 | return $grp->result () if $_[0]; |
1110 | my $now = time; |
1112 | my $now = time; |
1111 | 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 | } |
1112 | |
1122 | |
1113 | # read the directory entries |
1123 | # read the directory entries |
1114 | aioreq_pri $pri; |
1124 | aioreq_pri $pri; |
1115 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1125 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1116 | my $entries = shift |
1126 | my ($entries, $flags) = @_ |
1117 | 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 | } |
1118 | |
1176 | |
1119 | # stat the dir another time |
1177 | # stat the dir another time |
1120 | aioreq_pri $pri; |
1178 | aioreq_pri $pri; |
1121 | add $grp aio_stat $wd, sub { |
1179 | add $grp aio_stat $wd, sub { |
1122 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1180 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1383 | 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; |
1384 | aio_mlock $data; # mlock in background |
1442 | aio_mlock $data; # mlock in background |
1385 | |
1443 | |
1386 | =item aio_mlockall $flags, $callback->($status) |
1444 | =item aio_mlockall $flags, $callback->($status) |
1387 | |
1445 | |
1388 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1446 | Calls the C<mlockall> function with the given C<$flags> (a |
1389 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1447 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1448 | C<IO::AIO::MCL_ONFAULT>). |
1390 | |
1449 | |
1391 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1450 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1392 | and sets errno to C<ENOSYS>. |
1451 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1452 | by the system result in a return value of C<-1> with errno being set to |
|
|
1453 | C<EINVAL>. |
1393 | |
1454 | |
1394 | Note that the corresponding C<munlockall> is synchronous and is |
1455 | Note that the corresponding C<munlockall> is synchronous and is |
1395 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1456 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1396 | |
1457 | |
1397 | Example: asynchronously lock all current and future pages into memory. |
1458 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1782 | The default value for the limit is C<0>, but note that setting a feeder |
1843 | The default value for the limit is C<0>, but note that setting a feeder |
1783 | automatically bumps it up to C<2>. |
1844 | automatically bumps it up to C<2>. |
1784 | |
1845 | |
1785 | =back |
1846 | =back |
1786 | |
1847 | |
|
|
1848 | |
1787 | =head2 SUPPORT FUNCTIONS |
1849 | =head2 SUPPORT FUNCTIONS |
1788 | |
1850 | |
1789 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1851 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1790 | |
1852 | |
1791 | =over 4 |
1853 | =over 4 |
… | |
… | |
1856 | Strictly equivalent to: |
1918 | Strictly equivalent to: |
1857 | |
1919 | |
1858 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1920 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1859 | while IO::AIO::nreqs; |
1921 | while IO::AIO::nreqs; |
1860 | |
1922 | |
|
|
1923 | This function can be useful at program aborts, to make sure outstanding |
|
|
1924 | I/O has been done (C<IO::AIO> uses an C<END> block which already calls |
|
|
1925 | this function on normal exits), or when you are merely using C<IO::AIO> |
|
|
1926 | for 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 | |
1861 | =item IO::AIO::max_poll_reqs $nreqs |
1933 | =item IO::AIO::max_poll_reqs $nreqs |
1862 | |
1934 | |
1863 | =item IO::AIO::max_poll_time $seconds |
1935 | =item IO::AIO::max_poll_time $seconds |
1864 | |
1936 | |
1865 | These set the maximum number of requests (default C<0>, meaning infinity) |
1937 | These set the maximum number of requests (default C<0>, meaning infinity) |
… | |
… | |
1891 | poll => 'r', nice => 1, |
1963 | poll => 'r', nice => 1, |
1892 | cb => &IO::AIO::poll_cb); |
1964 | cb => &IO::AIO::poll_cb); |
1893 | |
1965 | |
1894 | =back |
1966 | =back |
1895 | |
1967 | |
|
|
1968 | |
1896 | =head3 CONTROLLING THE NUMBER OF THREADS |
1969 | =head3 CONTROLLING THE NUMBER OF THREADS |
1897 | |
1970 | |
1898 | =over |
1971 | =over |
1899 | |
1972 | |
1900 | =item IO::AIO::min_parallel $nthreads |
1973 | =item IO::AIO::min_parallel $nthreads |
… | |
… | |
1987 | The default value for C<max_outstanding> is very large, so there is no |
2060 | The default value for C<max_outstanding> is very large, so there is no |
1988 | practical limit on the number of outstanding requests. |
2061 | practical limit on the number of outstanding requests. |
1989 | |
2062 | |
1990 | =back |
2063 | =back |
1991 | |
2064 | |
|
|
2065 | |
1992 | =head3 STATISTICAL INFORMATION |
2066 | =head3 STATISTICAL INFORMATION |
1993 | |
2067 | |
1994 | =over |
2068 | =over |
1995 | |
2069 | |
1996 | =item IO::AIO::nreqs |
2070 | =item IO::AIO::nreqs |
… | |
… | |
2012 | |
2086 | |
2013 | Returns the number of requests currently in the pending state (executed, |
2087 | Returns the number of requests currently in the pending state (executed, |
2014 | but not yet processed by poll_cb). |
2088 | but not yet processed by poll_cb). |
2015 | |
2089 | |
2016 | =back |
2090 | =back |
|
|
2091 | |
2017 | |
2092 | |
2018 | =head3 SUBSECOND STAT TIME ACCESS |
2093 | =head3 SUBSECOND STAT TIME ACCESS |
2019 | |
2094 | |
2020 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
2095 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
2021 | generally find access/modification and change times with subsecond time |
2096 | generally find access/modification and change times with subsecond time |
… | |
… | |
2037 | not supported or could not be detected, a fractional part of C<0> is |
2112 | not supported or could not be detected, a fractional part of C<0> is |
2038 | returned, so it is always safe to call these functions. |
2113 | returned, so it is always safe to call these functions. |
2039 | |
2114 | |
2040 | =over 4 |
2115 | =over 4 |
2041 | |
2116 | |
2042 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime |
2117 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
2043 | |
2118 | |
2044 | Return the access, modication or change time, respectively, including |
2119 | Return the access, modication, change or birth time, respectively, |
2045 | fractional part. Due to the limited precision of floating point, the |
2120 | including fractional part. Due to the limited precision of floating point, |
2046 | accuracy on most platforms is only a bit better than milliseconds for |
2121 | the accuracy on most platforms is only a bit better than milliseconds |
2047 | times around now - see the I<nsec> function family, below, for full |
2122 | for times around now - see the I<nsec> function family, below, for full |
2048 | accuracy. |
2123 | accuracy. |
2049 | |
2124 | |
|
|
2125 | File birth time is only available when the OS and perl support it (on |
|
|
2126 | FreeBSD and NetBSD at the time of this writing, although support is |
|
|
2127 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
|
|
2128 | it). On systems where it isn't available, C<0> is currently returned, but |
|
|
2129 | this might change to C<undef> in a future version. |
|
|
2130 | |
2050 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime |
2131 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2051 | |
2132 | |
2052 | Returns access, modification and change time all in one go, and maybe more |
2133 | Returns access, modification, change and birth time all in one go, and |
2053 | times in the future version. |
2134 | maybe more times in the future version. |
2054 | |
2135 | |
2055 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec |
2136 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
2056 | |
2137 | |
2057 | Return the fractional access, modifcation or change time, in nanoseconds, |
2138 | Return the fractional access, modifcation, change or birth time, in nanoseconds, |
2058 | as an integer in the range C<0> to C<999999999>. |
2139 | as an integer in the range C<0> to C<999999999>. |
2059 | |
2140 | |
|
|
2141 | Note that no accessors are provided for access, modification and |
|
|
2142 | change times - you need to get those from C<stat _> if required (C<int |
|
|
2143 | IO::AIO::st_atime> and so on will I<not> generally give you the correct |
|
|
2144 | value). |
|
|
2145 | |
|
|
2146 | =item $seconds = IO::AIO::st_btimesec |
|
|
2147 | |
|
|
2148 | The (integral) seconds part of the file birth time, if available. |
|
|
2149 | |
2060 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec |
2150 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
2061 | |
2151 | |
2062 | Like the functions above, but returns all three times in one go (and maybe |
2152 | Like the functions above, but returns all four times in one go (and maybe |
2063 | more in future versions). |
2153 | more in future versions). |
|
|
2154 | |
|
|
2155 | =item $counter = IO::AIO::st_gen |
|
|
2156 | |
|
|
2157 | Returns the generation counter (in practice this is just a random number) |
|
|
2158 | of the file. This is only available on platforms which have this member in |
|
|
2159 | their C<struct stat> (most BSDs at the time of this writing) and generally |
|
|
2160 | only to the root usert. If unsupported, C<0> is returned, but this might |
|
|
2161 | change to C<undef> in a future version. |
2064 | |
2162 | |
2065 | =back |
2163 | =back |
2066 | |
2164 | |
2067 | Example: print the high resolution modification time of F</etc>, using |
2165 | Example: print the high resolution modification time of F</etc>, using |
2068 | C<stat>, and C<IO::AIO::aio_stat>. |
2166 | C<stat>, and C<IO::AIO::aio_stat>. |
… | |
… | |
2082 | |
2180 | |
2083 | Output of the awbove on my system, showing reduced and full accuracy: |
2181 | Output of the awbove on my system, showing reduced and full accuracy: |
2084 | |
2182 | |
2085 | stat(/etc) mtime: 1534043702.020808 |
2183 | stat(/etc) mtime: 1534043702.020808 |
2086 | aio_stat(/etc) mtime: 1534043702.020807792 |
2184 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2185 | |
2087 | |
2186 | |
2088 | =head3 MISCELLANEOUS FUNCTIONS |
2187 | =head3 MISCELLANEOUS FUNCTIONS |
2089 | |
2188 | |
2090 | IO::AIO implements some functions that are useful when you want to use |
2189 | IO::AIO implements some functions that are useful when you want to use |
2091 | some "Advanced I/O" function not available to in Perl, without going the |
2190 | some "Advanced I/O" function not available to in Perl, without going the |
… | |
… | |
2255 | implemented, but not supported and might go away in a future version. |
2354 | implemented, but not supported and might go away in a future version. |
2256 | |
2355 | |
2257 | On systems where this call is not supported or is not emulated, this call |
2356 | On systems where this call is not supported or is not emulated, this call |
2258 | returns falls and sets C<$!> to C<ENOSYS>. |
2357 | returns falls and sets C<$!> to C<ENOSYS>. |
2259 | |
2358 | |
|
|
2359 | =item IO::AIO::mlockall $flags |
|
|
2360 | |
|
|
2361 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2362 | but is blocking. |
|
|
2363 | |
2260 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2364 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2261 | |
2365 | |
2262 | Calls the C<munlock> function, undoing the effects of a previous |
2366 | Calls the C<munlock> function, undoing the effects of a previous |
2263 | C<aio_mlock> call (see its description for details). |
2367 | C<aio_mlock> call (see its description for details). |
2264 | |
2368 | |