… | |
… | |
228 | |
228 | |
229 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
229 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
230 | IO::AIO::fadvise $fh, $offset, $len, $advice |
230 | IO::AIO::fadvise $fh, $offset, $len, $advice |
231 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
231 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
232 | IO::AIO::munmap $scalar |
232 | IO::AIO::munmap $scalar |
|
|
233 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
233 | IO::AIO::madvise $scalar, $offset, $length, $advice |
234 | IO::AIO::madvise $scalar, $offset, $length, $advice |
234 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
235 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
235 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
236 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
236 | IO::AIO::munlockall |
237 | IO::AIO::munlockall |
237 | |
238 | |
… | |
… | |
339 | "O_APPEND"), the following POSIX and non-POSIX constants are |
340 | "O_APPEND"), the following POSIX and non-POSIX constants are |
340 | available (missing ones on your system are, as usual, 0): |
341 | available (missing ones on your system are, as usual, 0): |
341 | |
342 | |
342 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
343 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
343 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
344 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
344 | "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", and |
345 | "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", "O_TTY_INIT" |
345 | "O_TTY_INIT". |
346 | and "O_ACCMODE". |
346 | |
347 | |
347 | aio_close $fh, $callback->($status) |
348 | aio_close $fh, $callback->($status) |
348 | Asynchronously close a file and call the callback with the result |
349 | Asynchronously close a file and call the callback with the result |
349 | code. |
350 | code. |
350 | |
351 | |
… | |
… | |
468 | will be emulated by simply reading the data, which would have a |
469 | will be emulated by simply reading the data, which would have a |
469 | similar effect. |
470 | similar effect. |
470 | |
471 | |
471 | aio_stat $fh_or_path, $callback->($status) |
472 | aio_stat $fh_or_path, $callback->($status) |
472 | aio_lstat $fh, $callback->($status) |
473 | aio_lstat $fh, $callback->($status) |
473 | Works like perl's "stat" or "lstat" in void context. The callback |
474 | Works almost exactly like perl's "stat" or "lstat" in void context. |
474 | will be called after the stat and the results will be available |
475 | The callback will be called after the stat and the results will be |
475 | using "stat _" or "-s _" etc... |
476 | available using "stat _" or "-s _" and other tests (with the |
|
|
477 | exception of "-B" and "-T"). |
476 | |
478 | |
477 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
479 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
478 | above, for an explanation. |
480 | above, for an explanation. |
479 | |
481 | |
480 | Currently, the stats are always 64-bit-stats, i.e. instead of |
482 | Currently, the stats are always 64-bit-stats, i.e. instead of |
… | |
… | |
488 | back on traditional behaviour). |
490 | back on traditional behaviour). |
489 | |
491 | |
490 | "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG", |
492 | "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG", |
491 | "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t", |
493 | "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t", |
492 | "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor". |
494 | "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor". |
|
|
495 | |
|
|
496 | To access higher resolution stat timestamps, see "SUBSECOND STAT |
|
|
497 | TIME ACCESS". |
493 | |
498 | |
494 | Example: Print the length of /etc/passwd: |
499 | Example: Print the length of /etc/passwd: |
495 | |
500 | |
496 | aio_stat "/etc/passwd", sub { |
501 | aio_stat "/etc/passwd", sub { |
497 | $_[0] and die "stat failed: $!"; |
502 | $_[0] and die "stat failed: $!"; |
… | |
… | |
544 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
549 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
545 | Works like perl's "utime" function (including the special case of |
550 | Works like perl's "utime" function (including the special case of |
546 | $atime and $mtime being undef). Fractional times are supported if |
551 | $atime and $mtime being undef). Fractional times are supported if |
547 | the underlying syscalls support them. |
552 | the underlying syscalls support them. |
548 | |
553 | |
549 | When called with a pathname, uses utimes(2) if available, otherwise |
554 | When called with a pathname, uses utimensat(2) or utimes(2) if |
550 | utime(2). If called on a file descriptor, uses futimes(2) if |
555 | available, otherwise utime(2). If called on a file descriptor, uses |
551 | available, otherwise returns ENOSYS, so this is not portable. |
556 | futimens(2) or futimes(2) if available, otherwise returns ENOSYS, so |
|
|
557 | this is not portable. |
552 | |
558 | |
553 | Examples: |
559 | Examples: |
554 | |
560 | |
555 | # set atime and mtime to current time (basically touch(1)): |
561 | # set atime and mtime to current time (basically touch(1)): |
556 | aio_utime "path", undef, undef; |
562 | aio_utime "path", undef, undef; |
… | |
… | |
686 | The flags are a combination of the following constants, ORed |
692 | The flags are a combination of the following constants, ORed |
687 | together (the flags will also be passed to the callback, possibly |
693 | together (the flags will also be passed to the callback, possibly |
688 | modified): |
694 | modified): |
689 | |
695 | |
690 | IO::AIO::READDIR_DENTS |
696 | IO::AIO::READDIR_DENTS |
691 | When this flag is off, then the callback gets an arrayref |
697 | Normally the callback gets an arrayref consisting of names only |
692 | consisting of names only (as with "aio_readdir"), otherwise it |
698 | (as with "aio_readdir"). If this flag is set, then the callback |
693 | gets an arrayref with "[$name, $type, $inode]" arrayrefs, each |
699 | gets an arrayref with "[$name, $type, $inode]" arrayrefs, each |
694 | describing a single directory entry in more detail. |
700 | describing a single directory entry in more detail: |
695 | |
701 | |
696 | $name is the name of the entry. |
702 | $name is the name of the entry. |
697 | |
703 | |
698 | $type is one of the "IO::AIO::DT_xxx" constants: |
704 | $type is one of the "IO::AIO::DT_xxx" constants: |
699 | |
705 | |
700 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
706 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
701 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
707 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
702 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
708 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
703 | |
709 | |
704 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
710 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
705 | you need to know, you have to run stat yourself. Also, for speed |
711 | you need to know, you have to run stat yourself. Also, for |
706 | reasons, the $type scalars are read-only: you can not modify |
712 | speed/memory reasons, the $type scalars are read-only: you must |
707 | them. |
713 | not modify them. |
708 | |
714 | |
709 | $inode is the inode number (which might not be exact on systems |
715 | $inode is the inode number (which might not be exact on systems |
710 | with 64 bit inode numbers and 32 bit perls). This field has |
716 | with 64 bit inode numbers and 32 bit perls). This field has |
711 | unspecified content on systems that do not deliver the inode |
717 | unspecified content on systems that do not deliver the inode |
712 | information. |
718 | information. |
… | |
… | |
724 | of which names with short names are tried first. |
730 | of which names with short names are tried first. |
725 | |
731 | |
726 | IO::AIO::READDIR_STAT_ORDER |
732 | IO::AIO::READDIR_STAT_ORDER |
727 | When this flag is set, then the names will be returned in an |
733 | When this flag is set, then the names will be returned in an |
728 | order suitable for stat()'ing each one. That is, when you plan |
734 | order suitable for stat()'ing each one. That is, when you plan |
729 | to stat() all files in the given directory, then the returned |
735 | to stat() most or all files in the given directory, then the |
730 | order will likely be fastest. |
736 | returned order will likely be faster. |
731 | |
737 | |
732 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
738 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
733 | specified, then the likely dirs come first, resulting in a less |
739 | specified, then the likely dirs come first, resulting in a less |
734 | optimal stat order. |
740 | optimal stat order for stat'ing all entries, but likely a more |
|
|
741 | optimal order for finding subdirectories. |
735 | |
742 | |
736 | IO::AIO::READDIR_FOUND_UNKNOWN |
743 | IO::AIO::READDIR_FOUND_UNKNOWN |
737 | This flag should not be set when calling "aio_readdirx". |
744 | This flag should not be set when calling "aio_readdirx". |
738 | Instead, it is being set by "aio_readdirx", when any of the |
745 | Instead, it is being set by "aio_readdirx", when any of the |
739 | $type's found were "IO::AIO::DT_UNKNOWN". The absence of this |
746 | $type's found were "IO::AIO::DT_UNKNOWN". The absence of this |
… | |
… | |
1009 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1016 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1010 | aio_mlock $data; # mlock in background |
1017 | aio_mlock $data; # mlock in background |
1011 | |
1018 | |
1012 | aio_mlockall $flags, $callback->($status) |
1019 | aio_mlockall $flags, $callback->($status) |
1013 | Calls the "mlockall" function with the given $flags (a combination |
1020 | Calls the "mlockall" function with the given $flags (a combination |
1014 | of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE"). |
1021 | of "IO::AIO::MCL_CURRENT", "IO::AIO::MCL_FUTURE" and |
|
|
1022 | "IO::AIO::MCL_ONFAULT"). |
1015 | |
1023 | |
1016 | On systems that do not implement "mlockall", this function returns |
1024 | On systems that do not implement "mlockall", this function returns |
1017 | -1 and sets errno to "ENOSYS". |
1025 | -1 and sets errno to "ENOSYS". Similarly, flag combinations not |
|
|
1026 | supported by the system result in a return value of -1 with errno |
|
|
1027 | being set to "EINVAL". |
1018 | |
1028 | |
1019 | Note that the corresponding "munlockall" is synchronous and is |
1029 | Note that the corresponding "munlockall" is synchronous and is |
1020 | documented under "MISCELLANEOUS FUNCTIONS". |
1030 | documented under "MISCELLANEOUS FUNCTIONS". |
1021 | |
1031 | |
1022 | Example: asynchronously lock all current and future pages into |
1032 | Example: asynchronously lock all current and future pages into |
… | |
… | |
1446 | Strictly equivalent to: |
1456 | Strictly equivalent to: |
1447 | |
1457 | |
1448 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1458 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1449 | while IO::AIO::nreqs; |
1459 | while IO::AIO::nreqs; |
1450 | |
1460 | |
|
|
1461 | This function can be useful at program aborts, to make sure |
|
|
1462 | outstanding I/O has been done ("IO::AIO" uses an "END" block which |
|
|
1463 | already calls this function on normal exits), or when you are merely |
|
|
1464 | using "IO::AIO" for its more advanced functions, rather than for |
|
|
1465 | async I/O, e.g.: |
|
|
1466 | |
|
|
1467 | my ($dirs, $nondirs); |
|
|
1468 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1469 | IO::AIO::flush; |
|
|
1470 | # $dirs, $nondirs are now set |
|
|
1471 | |
1451 | IO::AIO::max_poll_reqs $nreqs |
1472 | IO::AIO::max_poll_reqs $nreqs |
1452 | IO::AIO::max_poll_time $seconds |
1473 | IO::AIO::max_poll_time $seconds |
1453 | These set the maximum number of requests (default 0, meaning |
1474 | These set the maximum number of requests (default 0, meaning |
1454 | infinity) that are being processed by "IO::AIO::poll_cb" in one |
1475 | infinity) that are being processed by "IO::AIO::poll_cb" in one |
1455 | call, respectively the maximum amount of time (default 0, meaning |
1476 | call, respectively the maximum amount of time (default 0, meaning |
… | |
… | |
1587 | executed). |
1608 | executed). |
1588 | |
1609 | |
1589 | IO::AIO::npending |
1610 | IO::AIO::npending |
1590 | Returns the number of requests currently in the pending state |
1611 | Returns the number of requests currently in the pending state |
1591 | (executed, but not yet processed by poll_cb). |
1612 | (executed, but not yet processed by poll_cb). |
|
|
1613 | |
|
|
1614 | SUBSECOND STAT TIME ACCESS |
|
|
1615 | Both "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" functions can |
|
|
1616 | generally find access/modification and change times with subsecond time |
|
|
1617 | accuracy of the system supports it, but perl's built-in functions only |
|
|
1618 | return the integer part. |
|
|
1619 | |
|
|
1620 | The following functions return the timestamps of the most recent stat |
|
|
1621 | with subsecond precision on most systems and work both after |
|
|
1622 | "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" calls. Their return |
|
|
1623 | value is only meaningful after a successful "stat"/"lstat" call, or |
|
|
1624 | during/after a successful "aio_stat"/"aio_lstat" callback. |
|
|
1625 | |
|
|
1626 | This is similar to the Time::HiRes "stat" functions, but can return full |
|
|
1627 | resolution without rounding and work with standard perl "stat", |
|
|
1628 | alleviating the need to call the special "Time::HiRes" functions, which |
|
|
1629 | do not act like their perl counterparts. |
|
|
1630 | |
|
|
1631 | On operating systems or file systems where subsecond time resolution is |
|
|
1632 | not supported or could not be detected, a fractional part of 0 is |
|
|
1633 | returned, so it is always safe to call these functions. |
|
|
1634 | |
|
|
1635 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, |
|
|
1636 | IO::AIO::st_btime |
|
|
1637 | Return the access, modication, change or birth time, respectively, |
|
|
1638 | including fractional part. Due to the limited precision of floating |
|
|
1639 | point, the accuracy on most platforms is only a bit better than |
|
|
1640 | milliseconds for times around now - see the *nsec* function family, |
|
|
1641 | below, for full accuracy. |
|
|
1642 | |
|
|
1643 | File birth time is only available when the OS and perl support it |
|
|
1644 | (on FreeBSD and NetBSD at the time of this writing, although support |
|
|
1645 | is adaptive, so if your OS/perl gains support, IO::AIO can take |
|
|
1646 | avdantage of it). On systems where it isn't available, 0 is |
|
|
1647 | currently returned, but this might change to "undef" in a future |
|
|
1648 | version. |
|
|
1649 | |
|
|
1650 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
1651 | Returns access, modification, change and birth time all in one go, |
|
|
1652 | and maybe more times in the future version. |
|
|
1653 | |
|
|
1654 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, |
|
|
1655 | IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
1656 | Return the fractional access, modifcation, change or birth time, in |
|
|
1657 | nanoseconds, as an integer in the range 0 to 999999999. |
|
|
1658 | |
|
|
1659 | Note that no accessors are provided for access, modification and |
|
|
1660 | change times - you need to get those from "stat _" if required ("int |
|
|
1661 | IO::AIO::st_atime" and so on will *not* generally give you the |
|
|
1662 | correct value). |
|
|
1663 | |
|
|
1664 | $seconds = IO::AIO::st_btimesec |
|
|
1665 | The (integral) seconds part of the file birth time, if available. |
|
|
1666 | |
|
|
1667 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
1668 | Like the functions above, but returns all four times in one go (and |
|
|
1669 | maybe more in future versions). |
|
|
1670 | |
|
|
1671 | $counter = IO::AIO::st_gen |
|
|
1672 | Returns the generation counter (in practice this is just a random |
|
|
1673 | number) of the file. This is only available on platforms which have |
|
|
1674 | this member in their "struct stat" (most BSDs at the time of this |
|
|
1675 | writing) and generally only to the root usert. If unsupported, 0 is |
|
|
1676 | returned, but this might change to "undef" in a future version. |
|
|
1677 | |
|
|
1678 | Example: print the high resolution modification time of /etc, using |
|
|
1679 | "stat", and "IO::AIO::aio_stat". |
|
|
1680 | |
|
|
1681 | if (stat "/etc") { |
|
|
1682 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
1683 | } |
|
|
1684 | |
|
|
1685 | IO::AIO::aio_stat "/etc", sub { |
|
|
1686 | $_[0] |
|
|
1687 | and return; |
|
|
1688 | |
|
|
1689 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
1690 | }; |
|
|
1691 | |
|
|
1692 | IO::AIO::flush; |
|
|
1693 | |
|
|
1694 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
1695 | |
|
|
1696 | stat(/etc) mtime: 1534043702.020808 |
|
|
1697 | aio_stat(/etc) mtime: 1534043702.020807792 |
1592 | |
1698 | |
1593 | MISCELLANEOUS FUNCTIONS |
1699 | MISCELLANEOUS FUNCTIONS |
1594 | IO::AIO implements some functions that are useful when you want to use |
1700 | IO::AIO implements some functions that are useful when you want to use |
1595 | some "Advanced I/O" function not available to in Perl, without going the |
1701 | some "Advanced I/O" function not available to in Perl, without going the |
1596 | "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" |
1702 | "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" |
… | |
… | |
1724 | my $fast_md5 = md5 $data; |
1830 | my $fast_md5 = md5 $data; |
1725 | |
1831 | |
1726 | IO::AIO::munmap $scalar |
1832 | IO::AIO::munmap $scalar |
1727 | Removes a previous mmap and undefines the $scalar. |
1833 | Removes a previous mmap and undefines the $scalar. |
1728 | |
1834 | |
|
|
1835 | IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, |
|
|
1836 | $new_address = 0] |
|
|
1837 | Calls the Linux-specific mremap(2) system call. The $scalar must |
|
|
1838 | have been mapped by "IO::AIO::mmap", and $flags must currently |
|
|
1839 | either be 0 or "IO::AIO::MREMAP_MAYMOVE". |
|
|
1840 | |
|
|
1841 | Returns true if successful, and false otherwise. If the underlying |
|
|
1842 | mmapped region has changed address, then the true value has the |
|
|
1843 | numerical value 1, otherwise it has the numerical value 0: |
|
|
1844 | |
|
|
1845 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
1846 | or die "mremap: $!"; |
|
|
1847 | |
|
|
1848 | if ($success*1) { |
|
|
1849 | warn "scalar has chanegd address in memory\n"; |
|
|
1850 | } |
|
|
1851 | |
|
|
1852 | "IO::AIO::MREMAP_FIXED" and the $new_address argument are currently |
|
|
1853 | implemented, but not supported and might go away in a future |
|
|
1854 | version. |
|
|
1855 | |
|
|
1856 | On systems where this call is not supported or is not emulated, this |
|
|
1857 | call returns falls and sets $! to "ENOSYS". |
|
|
1858 | |
|
|
1859 | IO::AIO::mlockall $flags |
|
|
1860 | Calls the "eio_mlockall_sync" function, which is like |
|
|
1861 | "aio_mlockall", but is blocking. |
|
|
1862 | |
1729 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
1863 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
1730 | Calls the "munlock" function, undoing the effects of a previous |
1864 | Calls the "munlock" function, undoing the effects of a previous |
1731 | "aio_mlock" call (see its description for details). |
1865 | "aio_mlock" call (see its description for details). |
1732 | |
1866 | |
1733 | IO::AIO::munlockall |
1867 | IO::AIO::munlockall |