… | |
… | |
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.52; |
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 | |
… | |
… | |
404 | following POSIX and non-POSIX constants are available (missing ones on |
405 | following POSIX and non-POSIX constants are available (missing ones on |
405 | your system are, as usual, C<0>): |
406 | your system are, as usual, C<0>): |
406 | |
407 | |
407 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
408 | 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>, |
409 | 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>. |
410 | C<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 | |
414 | Asynchronously close a file and call the callback with the result |
415 | Asynchronously close a file and call the callback with the result |
… | |
… | |
559 | behaviour). |
560 | behaviour). |
560 | |
561 | |
561 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
562 | 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>, |
563 | 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>. |
564 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
565 | |
|
|
566 | To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME |
|
|
567 | ACCESS>. |
564 | |
568 | |
565 | Example: Print the length of F</etc/passwd>: |
569 | Example: Print the length of F</etc/passwd>: |
566 | |
570 | |
567 | aio_stat "/etc/passwd", sub { |
571 | aio_stat "/etc/passwd", sub { |
568 | $_[0] and die "stat failed: $!"; |
572 | $_[0] and die "stat failed: $!"; |
… | |
… | |
2009 | Returns the number of requests currently in the pending state (executed, |
2013 | Returns the number of requests currently in the pending state (executed, |
2010 | but not yet processed by poll_cb). |
2014 | but not yet processed by poll_cb). |
2011 | |
2015 | |
2012 | =back |
2016 | =back |
2013 | |
2017 | |
|
|
2018 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2019 | |
|
|
2020 | 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 |
|
|
2022 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2023 | return the integer part. |
|
|
2024 | |
|
|
2025 | The following functions return the timestamps of the most recent |
|
|
2026 | stat with subsecond precision on most systems and work both after |
|
|
2027 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2028 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2029 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2030 | |
|
|
2031 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2032 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2033 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2034 | do not act like their perl counterparts. |
|
|
2035 | |
|
|
2036 | On operating systems or file systems where subsecond time resolution is |
|
|
2037 | 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. |
|
|
2039 | |
|
|
2040 | =over 4 |
|
|
2041 | |
|
|
2042 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime |
|
|
2043 | |
|
|
2044 | Return the access, modication or change time, respectively, including |
|
|
2045 | fractional part. Due to the limited precision of floating point, the |
|
|
2046 | accuracy on most platforms is only a bit better than milliseconds for |
|
|
2047 | times around now - see the I<nsec> function family, below, for full |
|
|
2048 | accuracy. |
|
|
2049 | |
|
|
2050 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime |
|
|
2051 | |
|
|
2052 | Returns access, modification and change time all in one go, and maybe more |
|
|
2053 | times in the future version. |
|
|
2054 | |
|
|
2055 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec |
|
|
2056 | |
|
|
2057 | Return the fractional access, modifcation or change time, in nanoseconds, |
|
|
2058 | as an integer in the range C<0> to C<999999999>. |
|
|
2059 | |
|
|
2060 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec |
|
|
2061 | |
|
|
2062 | Like the functions above, but returns all three times in one go (and maybe |
|
|
2063 | more in future versions). |
|
|
2064 | |
|
|
2065 | =back |
|
|
2066 | |
|
|
2067 | Example: print the high resolution modification time of F</etc>, using |
|
|
2068 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2069 | |
|
|
2070 | if (stat "/etc") { |
|
|
2071 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2072 | } |
|
|
2073 | |
|
|
2074 | IO::AIO::aio_stat "/etc", sub { |
|
|
2075 | $_[0] |
|
|
2076 | and return; |
|
|
2077 | |
|
|
2078 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2079 | }; |
|
|
2080 | |
|
|
2081 | IO::AIO::flush; |
|
|
2082 | |
|
|
2083 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2084 | |
|
|
2085 | stat(/etc) mtime: 1534043702.020808 |
|
|
2086 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2087 | |
2014 | =head3 MISCELLANEOUS FUNCTIONS |
2088 | =head3 MISCELLANEOUS FUNCTIONS |
2015 | |
2089 | |
2016 | IO::AIO implements some functions that are useful when you want to use |
2090 | IO::AIO implements some functions that are useful when you want to use |
2017 | some "Advanced I/O" function not available to in Perl, without going the |
2091 | some "Advanced I/O" function not available to in Perl, without going the |
2018 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2092 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
… | |
… | |
2158 | |
2232 | |
2159 | =item IO::AIO::munmap $scalar |
2233 | =item IO::AIO::munmap $scalar |
2160 | |
2234 | |
2161 | Removes a previous mmap and undefines the C<$scalar>. |
2235 | Removes a previous mmap and undefines the C<$scalar>. |
2162 | |
2236 | |
|
|
2237 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2238 | |
|
|
2239 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2240 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2241 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2242 | |
|
|
2243 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2244 | region has changed address, then the true value has the numerical value |
|
|
2245 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2246 | |
|
|
2247 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2248 | or die "mremap: $!"; |
|
|
2249 | |
|
|
2250 | if ($success*1) { |
|
|
2251 | warn "scalar has chanegd address in memory\n"; |
|
|
2252 | } |
|
|
2253 | |
|
|
2254 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2255 | implemented, but not supported and might go away in a future version. |
|
|
2256 | |
|
|
2257 | On systems where this call is not supported or is not emulated, this call |
|
|
2258 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2259 | |
2163 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2260 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2164 | |
2261 | |
2165 | Calls the C<munlock> function, undoing the effects of a previous |
2262 | Calls the C<munlock> function, undoing the effects of a previous |
2166 | C<aio_mlock> call (see its description for details). |
2263 | C<aio_mlock> call (see its description for details). |
2167 | |
2264 | |