[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.281 by root, Tue Feb 20 04:32:59 2018 UTC vs.
Revision 1.295 by root, Sat Aug 25 19:59:18 2018 UTC

…		…
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.6;
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
…		…
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
545	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
546	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
547	or C<-s _> etc...	548	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
		549	and C<-T>).
548		550
549	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,
550	for an explanation.	552	for an explanation.
551		553
552	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
…		…
559	behaviour).	561	behaviour).
560		562
561	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	563	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>,	564	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>.	565	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		566
		567	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		568	ACCESS>.
564		569
565	Example: Print the length of F</etc/passwd>:	570	Example: 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: $!";
…		…
618		623
619	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
620	and $mtime being undef). Fractional times are supported if the underlying	625	and $mtime being undef). Fractional times are supported if the underlying
621	syscalls support them.	626	syscalls support them.
622		627
623	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,
624	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)
625	otherwise returns ENOSYS, so this is not portable.	630	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		631	portable.
626		632
627	Examples:	633	Examples:
628		634
629	# set atime and mtime to current time (basically touch(1)):	635	# set atime and mtime to current time (basically touch(1)):
630	aio_utime "path", undef, undef;	636	aio_utime "path", undef, undef;
…		…
789		795
790	=over 4	796	=over 4
791		797
792	=item IO::AIO::READDIR_DENTS	798	=item IO::AIO::READDIR_DENTS
793		799
794	When this flag is off, then the callback gets an arrayref consisting of	800	Normally the callback gets an arrayref consisting of names only (as
795	names only (as with C<aio_readdir>), otherwise it gets an arrayref with	801	with C<aio_readdir>). If this flag is set, then the callback gets an
796	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	802	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
797	entry in more detail.	803	single directory entry in more detail:
798		804
799	C<$name> is the name of the entry.	805	C<$name> is the name of the entry.
800		806
801	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	807	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
802		808
803	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	809	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
804	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,	810	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
805	C<IO::AIO::DT_WHT>.	811	C<IO::AIO::DT_WHT>.
806		812
807	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	813	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
808	know, you have to run stat yourself. Also, for speed reasons, the C<$type>	814	to know, you have to run stat yourself. Also, for speed/memory reasons,
809	scalars are read-only: you can not modify them.	815	the C<$type> scalars are read-only: you must not modify them.
810		816
811	C<$inode> is the inode number (which might not be exact on systems with 64	817	C<$inode> is the inode number (which might not be exact on systems with 64
812	bit inode numbers and 32 bit perls). This field has unspecified content on	818	bit inode numbers and 32 bit perls). This field has unspecified content on
813	systems that do not deliver the inode information.	819	systems that do not deliver the inode information.
814		820
…		…
825	short names are tried first.	831	short names are tried first.
826		832
827	=item IO::AIO::READDIR_STAT_ORDER	833	=item IO::AIO::READDIR_STAT_ORDER
828		834
829	When this flag is set, then the names will be returned in an order	835	When this flag is set, then the names will be returned in an order
830	suitable for stat()'ing each one. That is, when you plan to stat()	836	suitable for stat()'ing each one. That is, when you plan to stat() most or
831	all files in the given directory, then the returned order will likely	837	all files in the given directory, then the returned order will likely be
832	be fastest.	838	faster.
833		839
834	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	840	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
835	the likely dirs come first, resulting in a less optimal stat order.	841	then the likely dirs come first, resulting in a less optimal stat order
		842	for stat'ing all entries, but likely a more optimal order for finding
		843	subdirectories.
836		844
837	=item IO::AIO::READDIR_FOUND_UNKNOWN	845	=item IO::AIO::READDIR_FOUND_UNKNOWN
838		846
839	This flag should not be set when calling C<aio_readdirx>. Instead, it	847	This flag should not be set when calling C<aio_readdirx>. Instead, it
840	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	848	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
1776	The default value for the limit is C<0>, but note that setting a feeder	1784	The default value for the limit is C<0>, but note that setting a feeder
1777	automatically bumps it up to C<2>.	1785	automatically bumps it up to C<2>.
1778		1786
1779	=back	1787	=back
1780		1788
		1789
1781	=head2 SUPPORT FUNCTIONS	1790	=head2 SUPPORT FUNCTIONS
1782		1791
1783	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1792	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1784		1793
1785	=over 4	1794	=over 4
…		…
1850	Strictly equivalent to:	1859	Strictly equivalent to:
1851		1860
1852	IO::AIO::poll_wait, IO::AIO::poll_cb	1861	IO::AIO::poll_wait, IO::AIO::poll_cb
1853	while IO::AIO::nreqs;	1862	while IO::AIO::nreqs;
1854		1863
		1864	This function can be useful at program aborts, to make sure outstanding
		1865	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1866	this function on normal exits), or when you are merely using C<IO::AIO>
		1867	for its more advanced functions, rather than for async I/O, e.g.:
		1868
		1869	my ($dirs, $nondirs);
		1870	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1871	IO::AIO::flush;
		1872	# $dirs, $nondirs are now set
		1873
1855	=item IO::AIO::max_poll_reqs $nreqs	1874	=item IO::AIO::max_poll_reqs $nreqs
1856		1875
1857	=item IO::AIO::max_poll_time $seconds	1876	=item IO::AIO::max_poll_time $seconds
1858		1877
1859	These set the maximum number of requests (default C<0>, meaning infinity)	1878	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1885	poll => 'r', nice => 1,	1904	poll => 'r', nice => 1,
1886	cb => &IO::AIO::poll_cb);	1905	cb => &IO::AIO::poll_cb);
1887		1906
1888	=back	1907	=back
1889		1908
		1909
1890	=head3 CONTROLLING THE NUMBER OF THREADS	1910	=head3 CONTROLLING THE NUMBER OF THREADS
1891		1911
1892	=over	1912	=over
1893		1913
1894	=item IO::AIO::min_parallel $nthreads	1914	=item IO::AIO::min_parallel $nthreads
…		…
1981	The default value for C<max_outstanding> is very large, so there is no	2001	The default value for C<max_outstanding> is very large, so there is no
1982	practical limit on the number of outstanding requests.	2002	practical limit on the number of outstanding requests.
1983		2003
1984	=back	2004	=back
1985		2005
		2006
1986	=head3 STATISTICAL INFORMATION	2007	=head3 STATISTICAL INFORMATION
1987		2008
1988	=over	2009	=over
1989		2010
1990	=item IO::AIO::nreqs	2011	=item IO::AIO::nreqs
…		…
2006		2027
2007	Returns the number of requests currently in the pending state (executed,	2028	Returns the number of requests currently in the pending state (executed,
2008	but not yet processed by poll_cb).	2029	but not yet processed by poll_cb).
2009		2030
2010	=back	2031	=back
		2032
		2033
		2034	=head3 SUBSECOND STAT TIME ACCESS
		2035
		2036	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2037	generally find access/modification and change times with subsecond time
		2038	accuracy of the system supports it, but perl's built-in functions only
		2039	return the integer part.
		2040
		2041	The following functions return the timestamps of the most recent
		2042	stat with subsecond precision on most systems and work both after
		2043	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2044	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2045	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2046
		2047	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2048	full resolution without rounding and work with standard perl C<stat>,
		2049	alleviating the need to call the special C<Time::HiRes> functions, which
		2050	do not act like their perl counterparts.
		2051
		2052	On operating systems or file systems where subsecond time resolution is
		2053	not supported or could not be detected, a fractional part of C<0> is
		2054	returned, so it is always safe to call these functions.
		2055
		2056	=over 4
		2057
		2058	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2059
		2060	Return the access, modication, change or birth time, respectively,
		2061	including fractional part. Due to the limited precision of floating point,
		2062	the accuracy on most platforms is only a bit better than milliseconds
		2063	for times around now - see the I<nsec> function family, below, for full
		2064	accuracy.
		2065
		2066	File birth time is only available when the OS and perl support it (on
		2067	FreeBSD and NetBSD at the time of this writing, although support is
		2068	adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of
		2069	it). On systems where it isn't available, C<0> is currently returned, but
		2070	this might change to C<undef> in a future version.
		2071
		2072	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2073
		2074	Returns access, modification, change and birth time all in one go, and
		2075	maybe more times in the future version.
		2076
		2077	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2078
		2079	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2080	as an integer in the range C<0> to C<999999999>.
		2081
		2082	Note that no accessors are provided for access, modification and
		2083	change times - you need to get those from C<stat _> if required (C<int
		2084	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2085	value).
		2086
		2087	=item $seconds = IO::AIO::st_btimesec
		2088
		2089	The (integral) seconds part of the file birth time, if available.
		2090
		2091	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2092
		2093	Like the functions above, but returns all four times in one go (and maybe
		2094	more in future versions).
		2095
		2096	=item $counter = IO::AIO::st_gen
		2097
		2098	Returns the generation counter of the file. This is only available on
		2099	platforms which have this member in their C<struct stat> (most BSDs
		2100	at the time of this writing) and generally only to the root usert. If
		2101	unsupported, C<0> is returned, but this might change to C<undef> in a
		2102	future version.
		2103
		2104	=back
		2105
		2106	Example: print the high resolution modification time of F</etc>, using
		2107	C<stat>, and C<IO::AIO::aio_stat>.
		2108
		2109	if (stat "/etc") {
		2110	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2111	}
		2112
		2113	IO::AIO::aio_stat "/etc", sub {
		2114	$_[0]
		2115	and return;
		2116
		2117	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2118	};
		2119
		2120	IO::AIO::flush;
		2121
		2122	Output of the awbove on my system, showing reduced and full accuracy:
		2123
		2124	stat(/etc) mtime: 1534043702.020808
		2125	aio_stat(/etc) mtime: 1534043702.020807792
		2126
2011		2127
2012	=head3 MISCELLANEOUS FUNCTIONS	2128	=head3 MISCELLANEOUS FUNCTIONS
2013		2129
2014	IO::AIO implements some functions that are useful when you want to use	2130	IO::AIO implements some functions that are useful when you want to use
2015	some "Advanced I/O" function not available to in Perl, without going the	2131	some "Advanced I/O" function not available to in Perl, without going the
…		…
2156		2272
2157	=item IO::AIO::munmap $scalar	2273	=item IO::AIO::munmap $scalar
2158		2274
2159	Removes a previous mmap and undefines the C<$scalar>.	2275	Removes a previous mmap and undefines the C<$scalar>.
2160		2276
		2277	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2278
		2279	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2280	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2281	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2282
		2283	Returns true if successful, and false otherwise. If the underlying mmapped
		2284	region has changed address, then the true value has the numerical value
		2285	C<1>, otherwise it has the numerical value C<0>:
		2286
		2287	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2288	or die "mremap: $!";
		2289
		2290	if ($success*1) {
		2291	warn "scalar has chanegd address in memory\n";
		2292	}
		2293
		2294	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2295	implemented, but not supported and might go away in a future version.
		2296
		2297	On systems where this call is not supported or is not emulated, this call
		2298	returns falls and sets C<$!> to C<ENOSYS>.
		2299
2161	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2300	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2162		2301
2163	Calls the C<munlock> function, undoing the effects of a previous	2302	Calls the C<munlock> function, undoing the effects of a previous
2164	C<aio_mlock> call (see its description for details).	2303	C<aio_mlock> call (see its description for details).
2165		2304
…		…
2220	Example: create a pipe race-free w.r.t. threads and fork:	2359	Example: create a pipe race-free w.r.t. threads and fork:
2221		2360
2222	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC	2361	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2223	or die "pipe2: $!\n";	2362	or die "pipe2: $!\n";
2224		2363
2225	=item $fh = IO::AIO::eventfd ([$initval, [$flags]])	2364	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2226		2365
2227	This is a direct interface to the Linux L<eventfd(2)> system call. The	2366	This is a direct interface to the Linux L<eventfd(2)> system call. The
2228	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.	2367	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2229		2368
2230	On success, the new eventfd filehandle is returned, otherwise returns	2369	On success, the new eventfd filehandle is returned, otherwise returns
…		…
2232		2371
2233	Please refer to L<eventfd(2)> for more info on this call.	2372	Please refer to L<eventfd(2)> for more info on this call.
2234		2373
2235	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,	2374	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2236	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).	2375	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2376
		2377	Example: create a new eventfd filehandle:
		2378
		2379	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
		2380	or die "eventfd: $!\n";
		2381
		2382	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2383
		2384	This is a direct interface to the Linux L<timerfd_create(2)> system call. The
		2385	(unhelpful) default for C<$flags> is C<0>.
		2386
		2387	On success, the new timerfd filehandle is returned, otherwise returns
		2388	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2389
		2390	Please refer to L<timerfd_create(2)> for more info on this call.
		2391
		2392	The following C<$clockid> values are
		2393	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2394	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2395	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2396	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2397
		2398	The following C<$flags> values are available (Linux
		2399	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2400
		2401	Example: create a new timerfd and set it to one-second repeated alarms,
		2402	then wait for two alarms:
		2403
		2404	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2405	or die "timerfd_create: $!\n";
		2406
		2407	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2408	or die "timerfd_settime: $!\n";
		2409
		2410	for (1..2) {
		2411	8 == sysread $fh, my $buf, 8
		2412	or die "timerfd read failure\n";
		2413
		2414	printf "number of expirations (likely 1): %d\n",
		2415	unpack "Q", $buf;
		2416	}
		2417
		2418	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2419
		2420	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2421	call. Please refer to its manpage for more info on this call.
		2422
		2423	The new itimerspec is specified using two (possibly fractional) second
		2424	values, C<$new_interval> and C<$new_value>).
		2425
		2426	On success, the current interval and value are returned (as per
		2427	C<timerfd_gettime>). On failure, the empty list is returned.
		2428
		2429	The following C<$flags> values are
		2430	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2431	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2432
		2433	See C<IO::AIO::timerfd_create> for a full example.
		2434
		2435	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2436
		2437	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2438	call. Please refer to its manpage for more info on this call.
		2439
		2440	On success, returns the current values of interval and value for the given
		2441	timerfd (as potentially fractional second values). On failure, the empty
		2442	list is returned.
2237		2443
2238	=back	2444	=back
2239		2445
2240	=cut	2446	=cut
2241		2447
…		…
2307	the process will result in undefined behaviour. Calling it at any time	2513	the process will result in undefined behaviour. Calling it at any time
2308	will also result in any undefined (by POSIX) behaviour.	2514	will also result in any undefined (by POSIX) behaviour.
2309		2515
2310	=back	2516	=back
2311		2517
		2518	=head2 LINUX-SPECIFIC CALLS
		2519
		2520	When a call is documented as "linux-specific" then this means it
		2521	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2522	availability and compatibility of such calls regardless of the platform
		2523	it is compiled on, so platforms such as FreeBSD which often implement
		2524	these calls will work. When in doubt, call them and see if they fail wth
		2525	C<ENOSYS>.
		2526
2312	=head2 MEMORY USAGE	2527	=head2 MEMORY USAGE
2313		2528
2314	Per-request usage:	2529	Per-request usage:
2315		2530
2316	Each aio request uses - depending on your architecture - around 100-200	2531	Each aio request uses - depending on your architecture - around 100-200
…		…
2328	temporary buffers, and each thread requires a stack and other data	2543	temporary buffers, and each thread requires a stack and other data
2329	structures (usually around 16k-128k, depending on the OS).	2544	structures (usually around 16k-128k, depending on the OS).
2330		2545
2331	=head1 KNOWN BUGS	2546	=head1 KNOWN BUGS
2332		2547
2333	Known bugs will be fixed in the next release.	2548	Known bugs will be fixed in the next release :)
		2549
		2550	=head1 KNOWN ISSUES
		2551
		2552	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2553	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2554	non-created hash slots or other scalars I didn't think of. It's best to
		2555	avoid such and either use scalar variables or making sure that the scalar
		2556	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2557
		2558	I am not sure anything can be done about this, so this is considered a
		2559	known issue, rather than a bug.
2334		2560
2335	=head1 SEE ALSO	2561	=head1 SEE ALSO
2336		2562
2337	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2563	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2338	more natural syntax.	2564	more natural syntax.

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.281 by root, Tue Feb 20 04:32:59 2018 UTC vs. Revision 1.295 by root, Sat Aug 25 19:59:18 2018 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.281 by root, Tue Feb 20 04:32:59 2018 UTC vs.
Revision 1.295 by root, Sat Aug 25 19:59:18 2018 UTC