[ViewVC] Diff of: cvs/IO-AIO/README

Comparing IO-AIO/README (file contents):
Revision 1.60 by root, Tue Jul 31 22:27:49 2018 UTC vs.
Revision 1.67 by root, Tue Jul 27 07:58:38 2021 UTC

…		…
221	IO::AIO::idle_timeout $seconds	221	IO::AIO::idle_timeout $seconds
222	IO::AIO::max_outstanding $maxreqs	222	IO::AIO::max_outstanding $maxreqs
223	IO::AIO::nreqs	223	IO::AIO::nreqs
224	IO::AIO::nready	224	IO::AIO::nready
225	IO::AIO::npending	225	IO::AIO::npending
		226	IO::AIO::reinit
		227
226	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]	228	$nfd = IO::AIO::get_fdlimit
227	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]	229	IO::AIO::min_fdlimit $nfd
228		230
229	IO::AIO::sendfile $ofh, $ifh, $offset, $count	231	IO::AIO::sendfile $ofh, $ifh, $offset, $count
230	IO::AIO::fadvise $fh, $offset, $len, $advice	232	IO::AIO::fadvise $fh, $offset, $len, $advice
		233
231	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	234	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
232	IO::AIO::munmap $scalar	235	IO::AIO::munmap $scalar
233	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]	236	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
234	IO::AIO::madvise $scalar, $offset, $length, $advice	237	IO::AIO::madvise $scalar, $offset, $length, $advice
235	IO::AIO::mprotect $scalar, $offset, $length, $protect	238	IO::AIO::mprotect $scalar, $offset, $length, $protect
236	IO::AIO::munlock $scalar, $offset = 0, $length = undef	239	IO::AIO::munlock $scalar, $offset = 0, $length = undef
237	IO::AIO::munlockall	240	IO::AIO::munlockall
		241
		242	# stat extensions
		243	$counter = IO::AIO::st_gen
		244	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		245	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		246	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		247	$seconds = IO::AIO::st_btimesec
		248	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		249
		250	# very much unportable syscalls
		251	IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
		252	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		253	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		254	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		255	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		256	$fh = IO::AIO::memfd_create $pathname[, $flags]
		257	$fh = IO::AIO::eventfd [$initval, [$flags]]
		258	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		259	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		260	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
238		261
239	API NOTES	262	API NOTES
240	All the "aio_*" calls are more or less thin wrappers around the syscall	263	All the "aio_*" calls are more or less thin wrappers around the syscall
241	with the same name (sans "aio_"). The arguments are similar or	264	with the same name (sans "aio_"). The arguments are similar or
242	identical, and they all accept an additional (and optional) $callback	265	identical, and they all accept an additional (and optional) $callback
…		…
469	will be emulated by simply reading the data, which would have a	492	will be emulated by simply reading the data, which would have a
470	similar effect.	493	similar effect.
471		494
472	aio_stat $fh_or_path, $callback->($status)	495	aio_stat $fh_or_path, $callback->($status)
473	aio_lstat $fh, $callback->($status)	496	aio_lstat $fh, $callback->($status)
474	Works like perl's "stat" or "lstat" in void context. The callback	497	Works almost exactly like perl's "stat" or "lstat" in void context.
475	will be called after the stat and the results will be available	498	The callback will be called after the stat and the results will be
476	using "stat _" or "-s _" etc...	499	available using "stat _" or "-s _" and other tests (with the
		500	exception of "-B" and "-T").
477		501
478	The pathname passed to "aio_stat" must be absolute. See API NOTES,	502	The pathname passed to "aio_stat" must be absolute. See API NOTES,
479	above, for an explanation.	503	above, for an explanation.
480		504
481	Currently, the stats are always 64-bit-stats, i.e. instead of	505	Currently, the stats are always 64-bit-stats, i.e. instead of
…		…
489	back on traditional behaviour).	513	back on traditional behaviour).
490		514
491	"S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG",	515	"S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG",
492	"S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t",	516	"S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t",
493	"IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor".	517	"IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor".
		518
		519	To access higher resolution stat timestamps, see "SUBSECOND STAT
		520	TIME ACCESS".
494		521
495	Example: Print the length of /etc/passwd:	522	Example: Print the length of /etc/passwd:
496		523
497	aio_stat "/etc/passwd", sub {	524	aio_stat "/etc/passwd", sub {
498	$_[0] and die "stat failed: $!";	525	$_[0] and die "stat failed: $!";
…		…
545	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	572	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
546	Works like perl's "utime" function (including the special case of	573	Works like perl's "utime" function (including the special case of
547	$atime and $mtime being undef). Fractional times are supported if	574	$atime and $mtime being undef). Fractional times are supported if
548	the underlying syscalls support them.	575	the underlying syscalls support them.
549		576
550	When called with a pathname, uses utimes(2) if available, otherwise	577	When called with a pathname, uses utimensat(2) or utimes(2) if
551	utime(2). If called on a file descriptor, uses futimes(2) if	578	available, otherwise utime(2). If called on a file descriptor, uses
552	available, otherwise returns ENOSYS, so this is not portable.	579	futimens(2) or futimes(2) if available, otherwise returns ENOSYS, so
		580	this is not portable.
553		581
554	Examples:	582	Examples:
555		583
556	# set atime and mtime to current time (basically touch(1)):	584	# set atime and mtime to current time (basically touch(1)):
557	aio_utime "path", undef, undef;	585	aio_utime "path", undef, undef;
…		…
882	So in general, you should only use these calls for things that do	910	So in general, you should only use these calls for things that do
883	(filesystem) I/O, not for things that wait for other events	911	(filesystem) I/O, not for things that wait for other events
884	(network, other processes), although if you are careful and know	912	(network, other processes), although if you are careful and know
885	what you are doing, you still can.	913	what you are doing, you still can.
886		914
887	The following constants are available (missing ones are, as usual	915	The following constants are available and can be used for normal
888	0):	916	"ioctl" and "fcntl" as well (missing ones are, as usual 0):
889		917
890	"F_DUPFD_CLOEXEC",	918	"F_DUPFD_CLOEXEC",
891		919
892	"F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW",	920	"F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW",
893		921
894	"FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE",	922	"FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE",
895	"FIDEDUPERANGE".	923	"FIDEDUPERANGE".
		924
		925	"F_ADD_SEALS", "F_GET_SEALS", "F_SEAL_SEAL", "F_SEAL_SHRINK",
		926	"F_SEAL_GROW" and "F_SEAL_WRITE".
896		927
897	"FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION",	928	"FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION",
898	"FS_IOC_SETVERSION", "FS_IOC_FIEMAP".	929	"FS_IOC_SETVERSION", "FS_IOC_FIEMAP".
899		930
900	"FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR",	931	"FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR",
…		…
1011	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1042	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1012	aio_mlock $data; # mlock in background	1043	aio_mlock $data; # mlock in background
1013		1044
1014	aio_mlockall $flags, $callback->($status)	1045	aio_mlockall $flags, $callback->($status)
1015	Calls the "mlockall" function with the given $flags (a combination	1046	Calls the "mlockall" function with the given $flags (a combination
1016	of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE").	1047	of "IO::AIO::MCL_CURRENT", "IO::AIO::MCL_FUTURE" and
		1048	"IO::AIO::MCL_ONFAULT").
1017		1049
1018	On systems that do not implement "mlockall", this function returns	1050	On systems that do not implement "mlockall", this function returns
1019	-1 and sets errno to "ENOSYS".	1051	-1 and sets errno to "ENOSYS". Similarly, flag combinations not
		1052	supported by the system result in a return value of -1 with errno
		1053	being set to "EINVAL".
1020		1054
1021	Note that the corresponding "munlockall" is synchronous and is	1055	Note that the corresponding "munlockall" is synchronous and is
1022	documented under "MISCELLANEOUS FUNCTIONS".	1056	documented under "MISCELLANEOUS FUNCTIONS".
1023		1057
1024	Example: asynchronously lock all current and future pages into	1058	Example: asynchronously lock all current and future pages into
…		…
1213	fails the request with "ENOENT", there is often no need for error	1247	fails the request with "ENOENT", there is often no need for error
1214	checking in the "aio_wd" callback, as future requests using the	1248	checking in the "aio_wd" callback, as future requests using the
1215	value will fail in the expected way.	1249	value will fail in the expected way.
1216		1250
1217	IO::AIO::CWD	1251	IO::AIO::CWD
1218	This is a compiletime constant (object) that represents the process	1252	This is a compile time constant (object) that represents the process
1219	current working directory.	1253	current working directory.
1220		1254
1221	Specifying this object as working directory object for a pathname is	1255	Specifying this object as working directory object for a pathname is
1222	as if the pathname would be specified directly, without a directory	1256	as if the pathname would be specified directly, without a directory
1223	object. For example, these calls are functionally identical:	1257	object. For example, these calls are functionally identical:
…		…
1448	Strictly equivalent to:	1482	Strictly equivalent to:
1449		1483
1450	IO::AIO::poll_wait, IO::AIO::poll_cb	1484	IO::AIO::poll_wait, IO::AIO::poll_cb
1451	while IO::AIO::nreqs;	1485	while IO::AIO::nreqs;
1452		1486
		1487	This function can be useful at program aborts, to make sure
		1488	outstanding I/O has been done ("IO::AIO" uses an "END" block which
		1489	already calls this function on normal exits), or when you are merely
		1490	using "IO::AIO" for its more advanced functions, rather than for
		1491	async I/O, e.g.:
		1492
		1493	my ($dirs, $nondirs);
		1494	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1495	IO::AIO::flush;
		1496	# $dirs, $nondirs are now set
		1497
1453	IO::AIO::max_poll_reqs $nreqs	1498	IO::AIO::max_poll_reqs $nreqs
1454	IO::AIO::max_poll_time $seconds	1499	IO::AIO::max_poll_time $seconds
1455	These set the maximum number of requests (default 0, meaning	1500	These set the maximum number of requests (default 0, meaning
1456	infinity) that are being processed by "IO::AIO::poll_cb" in one	1501	infinity) that are being processed by "IO::AIO::poll_cb" in one
1457	call, respectively the maximum amount of time (default 0, meaning	1502	call, respectively the maximum amount of time (default 0, meaning
…		…
1590		1635
1591	IO::AIO::npending	1636	IO::AIO::npending
1592	Returns the number of requests currently in the pending state	1637	Returns the number of requests currently in the pending state
1593	(executed, but not yet processed by poll_cb).	1638	(executed, but not yet processed by poll_cb).
1594		1639
		1640	SUBSECOND STAT TIME ACCESS
		1641	Both "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" functions can
		1642	generally find access/modification and change times with subsecond time
		1643	accuracy of the system supports it, but perl's built-in functions only
		1644	return the integer part.
		1645
		1646	The following functions return the timestamps of the most recent stat
		1647	with subsecond precision on most systems and work both after
		1648	"aio_stat"/"aio_lstat" and perl's "stat"/"lstat" calls. Their return
		1649	value is only meaningful after a successful "stat"/"lstat" call, or
		1650	during/after a successful "aio_stat"/"aio_lstat" callback.
		1651
		1652	This is similar to the Time::HiRes "stat" functions, but can return full
		1653	resolution without rounding and work with standard perl "stat",
		1654	alleviating the need to call the special "Time::HiRes" functions, which
		1655	do not act like their perl counterparts.
		1656
		1657	On operating systems or file systems where subsecond time resolution is
		1658	not supported or could not be detected, a fractional part of 0 is
		1659	returned, so it is always safe to call these functions.
		1660
		1661	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime,
		1662	IO::AIO::st_btime
		1663	Return the access, modication, change or birth time, respectively,
		1664	including fractional part. Due to the limited precision of floating
		1665	point, the accuracy on most platforms is only a bit better than
		1666	milliseconds for times around now - see the nsec function family,
		1667	below, for full accuracy.
		1668
		1669	File birth time is only available when the OS and perl support it
		1670	(on FreeBSD and NetBSD at the time of this writing, although support
		1671	is adaptive, so if your OS/perl gains support, IO::AIO can take
		1672	advantage of it). On systems where it isn't available, 0 is
		1673	currently returned, but this might change to "undef" in a future
		1674	version.
		1675
		1676	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		1677	Returns access, modification, change and birth time all in one go,
		1678	and maybe more times in the future version.
		1679
		1680	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec,
		1681	IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		1682	Return the fractional access, modifcation, change or birth time, in
		1683	nanoseconds, as an integer in the range 0 to 999999999.
		1684
		1685	Note that no accessors are provided for access, modification and
		1686	change times - you need to get those from "stat _" if required ("int
		1687	IO::AIO::st_atime" and so on will not generally give you the
		1688	correct value).
		1689
		1690	$seconds = IO::AIO::st_btimesec
		1691	The (integral) seconds part of the file birth time, if available.
		1692
		1693	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		1694	Like the functions above, but returns all four times in one go (and
		1695	maybe more in future versions).
		1696
		1697	$counter = IO::AIO::st_gen
		1698	Returns the generation counter (in practice this is just a random
		1699	number) of the file. This is only available on platforms which have
		1700	this member in their "struct stat" (most BSDs at the time of this
		1701	writing) and generally only to the root usert. If unsupported, 0 is
		1702	returned, but this might change to "undef" in a future version.
		1703
		1704	Example: print the high resolution modification time of /etc, using
		1705	"stat", and "IO::AIO::aio_stat".
		1706
		1707	if (stat "/etc") {
		1708	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		1709	}
		1710
		1711	IO::AIO::aio_stat "/etc", sub {
		1712	$_[0]
		1713	and return;
		1714
		1715	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		1716	};
		1717
		1718	IO::AIO::flush;
		1719
		1720	Output of the awbove on my system, showing reduced and full accuracy:
		1721
		1722	stat(/etc) mtime: 1534043702.020808
		1723	aio_stat(/etc) mtime: 1534043702.020807792
		1724
1595	MISCELLANEOUS FUNCTIONS	1725	MISCELLANEOUS FUNCTIONS
1596	IO::AIO implements some functions that are useful when you want to use	1726	IO::AIO implements some functions that are useful when you want to use
1597	some "Advanced I/O" function not available to in Perl, without going the	1727	some "Advanced I/O" function not available to in Perl, without going the
1598	"Asynchronous I/O" route. Many of these have an asynchronous "aio_*"	1728	"Asynchronous I/O" route. Many of these have an asynchronous "aio_*"
1599	counterpart.	1729	counterpart.
1600		1730
1601	$numfd = IO::AIO::get_fdlimit	1731	$numfd = IO::AIO::get_fdlimit
1602	This function is EXPERIMENTAL and subject to change.
1603
1604	Tries to find the current file descriptor limit and returns it, or	1732	Tries to find the current file descriptor limit and returns it, or
1605	"undef" and sets $! in case of an error. The limit is one larger	1733	"undef" and sets $! in case of an error. The limit is one larger
1606	than the highest valid file descriptor number.	1734	than the highest valid file descriptor number.
1607		1735
1608	IO::AIO::min_fdlimit [$numfd]	1736	IO::AIO::min_fdlimit [$numfd]
1609	This function is EXPERIMENTAL and subject to change.
1610
1611	Try to increase the current file descriptor limit(s) to at least	1737	Try to increase the current file descriptor limit(s) to at least
1612	$numfd by changing the soft or hard file descriptor resource limit.	1738	$numfd by changing the soft or hard file descriptor resource limit.
1613	If $numfd is missing, it will try to set a very high limit, although	1739	If $numfd is missing, it will try to set a very high limit, although
1614	this is not recommended when you know the actual minimum that you	1740	this is not recommended when you know the actual minimum that you
1615	require.	1741	require.
…		…
1702	not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to	1828	not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to
1703	"MAP_ANON" if your system only provides this constant),	1829	"MAP_ANON" if your system only provides this constant),
1704	"IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE",	1830	"IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE",
1705	"IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK",	1831	"IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK",
1706	"IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN",	1832	"IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN",
1707	"IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB" or	1833	"IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_STACK",
1708	"IO::AIO::MAP_STACK".	1834	"IO::AIO::MAP_FIXED_NOREPLACE", "IO::AIO::MAP_SHARED_VALIDATE",
		1835	"IO::AIO::MAP_SYNC" or "IO::AIO::MAP_UNINITIALIZED".
1709		1836
1710	If $fh is "undef", then a file descriptor of -1 is passed.	1837	If $fh is "undef", then a file descriptor of -1 is passed.
1711		1838
1712	$offset is the offset from the start of the file - it generally must	1839	$offset is the offset from the start of the file - it generally must
1713	be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.	1840	be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
…		…
1750	version.	1877	version.
1751		1878
1752	On systems where this call is not supported or is not emulated, this	1879	On systems where this call is not supported or is not emulated, this
1753	call returns falls and sets $! to "ENOSYS".	1880	call returns falls and sets $! to "ENOSYS".
1754		1881
		1882	IO::AIO::mlockall $flags
		1883	Calls the "eio_mlockall_sync" function, which is like
		1884	"aio_mlockall", but is blocking.
		1885
1755	IO::AIO::munlock $scalar, $offset = 0, $length = undef	1886	IO::AIO::munlock $scalar, $offset = 0, $length = undef
1756	Calls the "munlock" function, undoing the effects of a previous	1887	Calls the "munlock" function, undoing the effects of a previous
1757	"aio_mlock" call (see its description for details).	1888	"aio_mlock" call (see its description for details).
1758		1889
1759	IO::AIO::munlockall	1890	IO::AIO::munlockall
1760	Calls the "munlockall" function.	1891	Calls the "munlockall" function.
1761		1892
1762	On systems that do not implement "munlockall", this function returns	1893	On systems that do not implement "munlockall", this function returns
1763	ENOSYS, otherwise the return value of "munlockall".	1894	ENOSYS, otherwise the return value of "munlockall".
		1895
		1896	$fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
		1897	Uses the GNU/Linux accept4(2) syscall, if available, to accept a
		1898	socket and return the new file handle on success, or sets $! and
		1899	returns "undef" on error.
		1900
		1901	The remote name of the new socket will be stored in $sockaddr, which
		1902	will be extended to allow for at least $sockaddr_maxlen octets. If
		1903	the socket name does not fit into $sockaddr_maxlen octets, this is
		1904	signaled by returning a longer string in $sockaddr, which might or
		1905	might not be truncated.
		1906
		1907	To accept name-less sockets, use "undef" for $sockaddr and 0 for
		1908	$sockaddr_maxlen.
		1909
		1910	The main reasons to use this syscall rather than portable accept(2)
		1911	are that you can specify "SOCK_NONBLOCK" and/or "SOCK_CLOEXEC" flags
		1912	and you can accept name-less sockets by specifying 0 for
		1913	$sockaddr_maxlen, which is sadly not possible with perl's interface
		1914	to "accept".
1764		1915
1765	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags	1916	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1766	Calls the GNU/Linux splice(2) syscall, if available. If $r_off or	1917	Calls the GNU/Linux splice(2) syscall, if available. If $r_off or
1767	$w_off are "undef", then "NULL" is passed for these, otherwise they	1918	$w_off are "undef", then "NULL" is passed for these, otherwise they
1768	should be the file offset.	1919	should be the file offset.
…		…
1809	Example: create a pipe race-free w.r.t. threads and fork:	1960	Example: create a pipe race-free w.r.t. threads and fork:
1810		1961
1811	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC	1962	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
1812	or die "pipe2: $!\n";	1963	or die "pipe2: $!\n";
1813		1964
		1965	$fh = IO::AIO::memfd_create $pathname[, $flags]
		1966	This is a direct interface to the Linux memfd_create(2) system call.
		1967	The (unhelpful) default for $flags is 0, but your default should be
		1968	"IO::AIO::MFD_CLOEXEC".
		1969
		1970	On success, the new memfd filehandle is returned, otherwise returns
		1971	"undef". If the memfd_create syscall is missing, fails with
		1972	"ENOSYS".
		1973
		1974	Please refer to memfd_create(2) for more info on this call.
		1975
		1976	The following $flags values are available: "IO::AIO::MFD_CLOEXEC",
		1977	"IO::AIO::MFD_ALLOW_SEALING" and "IO::AIO::MFD_HUGETLB".
		1978
		1979	Example: create a new memfd.
		1980
		1981	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		1982	or die "memfd_create: $!\n";
		1983
		1984	$fh = IO::AIO::pidfd_open $pid[, $flags]
		1985	This is an interface to the Linux pidfd_open(2) system call. The
		1986	default for $flags is 0.
		1987
		1988	On success, a new pidfd filehandle is returned (that is already set
		1989	to close-on-exec), otherwise returns "undef". If the syscall is
		1990	missing, fails with "ENOSYS".
		1991
		1992	Example: open pid 6341 as pidfd.
		1993
		1994	my $fh = IO::AIO::pidfd_open 6341
		1995	or die "pidfd_open: $!\n";
		1996
		1997	$status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[,
		1998	$flags]]
		1999	This is an interface to the Linux pidfd_send_signal system call. The
		2000	default for $siginfo is "undef" and the default for $flags is 0.
		2001
		2002	Returns the system call status. If the syscall is missing, fails
		2003	with "ENOSYS".
		2004
		2005	When specified, $siginfo must be a reference to a hash with one or
		2006	more of the following members:
		2007
		2008	code - the "si_code" member
		2009	pid - the "si_pid" member
		2010	uid - the "si_uid" member
		2011	value_int - the "si_value.sival_int" member
		2012	value_ptr - the "si_value.sival_ptr" member, specified as an integer
		2013
		2014	Example: send a SIGKILL to the specified process.
		2015
		2016	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
		2017	and die "pidfd_send_signal: $!\n";
		2018
		2019	Example: send a SIGKILL to the specified process with extra data.
		2020
		2021	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
		2022	and die "pidfd_send_signal: $!\n";
		2023
		2024	$fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		2025	This is an interface to the Linux pidfd_getfd system call. The
		2026	default for $flags is 0.
		2027
		2028	On success, returns a dup'ed copy of the target file descriptor
		2029	(specified as an integer) returned (that is already set to
		2030	close-on-exec), otherwise returns "undef". If the syscall is
		2031	missing, fails with "ENOSYS".
		2032
		2033	Example: get a copy of standard error of another process and print
		2034	soemthing to it.
		2035
		2036	my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
		2037	or die "pidfd_getfd: $!\n";
		2038	print $errfh "stderr\n";
		2039
1814	$fh = IO::AIO::eventfd [$initval, [$flags]]	2040	$fh = IO::AIO::eventfd [$initval, [$flags]]
1815	This is a direct interface to the Linux eventfd(2) system call. The	2041	This is a direct interface to the Linux eventfd(2) system call. The
1816	(unhelpful) defaults for $initval and $flags are 0 for both.	2042	(unhelpful) defaults for $initval and $flags are 0 for both.
1817		2043
1818	On success, the new eventfd filehandle is returned, otherwise	2044	On success, the new eventfd filehandle is returned, otherwise
…		…
1825	"IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and	2051	"IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and
1826	"IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30).	2052	"IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30).
1827		2053
1828	Example: create a new eventfd filehandle:	2054	Example: create a new eventfd filehandle:
1829		2055
1830	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC	2056	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
1831	or die "eventfd: $!\n";	2057	or die "eventfd: $!\n";
1832		2058
1833	$fh = IO::AIO::timerfd_create $clockid[, $flags]	2059	$fh = IO::AIO::timerfd_create $clockid[, $flags]
1834	This is a direct interface to the Linux timerfd_create(2) system	2060	This is a direct interface to the Linux timerfd_create(2) system
1835	call. The (unhelpful) default for $flags is 0.	2061	call. The (unhelpful) default for $flags is 0, but your default
		2062	should be "IO::AIO::TFD_CLOEXEC".
1836		2063
1837	On success, the new timerfd filehandle is returned, otherwise	2064	On success, the new timerfd filehandle is returned, otherwise
1838	returns "undef". If the eventfd syscall is missing, fails with	2065	returns "undef". If the timerfd_create syscall is missing, fails
1839	"ENOSYS".	2066	with "ENOSYS".
1840		2067
1841	Please refer to timerfd_create(2) for more info on this call.	2068	Please refer to timerfd_create(2) for more info on this call.
1842		2069
1843	The following $clockid values are available:	2070	The following $clockid values are available:
1844	"IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC"	2071	"IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC"
…		…
1987	I am not sure anything can be done about this, so this is considered a	2214	I am not sure anything can be done about this, so this is considered a
1988	known issue, rather than a bug.	2215	known issue, rather than a bug.
1989		2216
1990	SEE ALSO	2217	SEE ALSO
1991	AnyEvent::AIO for easy integration into event loops, Coro::AIO for a	2218	AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
1992	more natural syntax.	2219	more natural syntax and IO::FDPass for file descriptor passing.
1993		2220
1994	AUTHOR	2221	AUTHOR
1995	Marc Lehmann <schmorp@schmorp.de>	2222	Marc Lehmann <schmorp@schmorp.de>
1996	http://home.schmorp.de/	2223	http://home.schmorp.de/
1997		2224

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing IO-AIO/README (file contents): Revision 1.60 by root, Tue Jul 31 22:27:49 2018 UTC vs. Revision 1.67 by root, Tue Jul 27 07:58:38 2021 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.60 by root, Tue Jul 31 22:27:49 2018 UTC vs.
Revision 1.67 by root, Tue Jul 27 07:58:38 2021 UTC