[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.302 by root, Wed Apr 3 03:03:53 2019 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.72;
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
…		…
278	IO::AIO::idle_timeout $seconds	278	IO::AIO::idle_timeout $seconds
279	IO::AIO::max_outstanding $maxreqs	279	IO::AIO::max_outstanding $maxreqs
280	IO::AIO::nreqs	280	IO::AIO::nreqs
281	IO::AIO::nready	281	IO::AIO::nready
282	IO::AIO::npending	282	IO::AIO::npending
		283	IO::AIO::reinit
		284
283	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]	285	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
284	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]	286	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
285		287
286	IO::AIO::sendfile $ofh, $ifh, $offset, $count	288	IO::AIO::sendfile $ofh, $ifh, $offset, $count
287	IO::AIO::fadvise $fh, $offset, $len, $advice	289	IO::AIO::fadvise $fh, $offset, $len, $advice
		290
288	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	291	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289	IO::AIO::munmap $scalar	292	IO::AIO::munmap $scalar
		293	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
290	IO::AIO::madvise $scalar, $offset, $length, $advice	294	IO::AIO::madvise $scalar, $offset, $length, $advice
291	IO::AIO::mprotect $scalar, $offset, $length, $protect	295	IO::AIO::mprotect $scalar, $offset, $length, $protect
292	IO::AIO::munlock $scalar, $offset = 0, $length = undef	296	IO::AIO::munlock $scalar, $offset = 0, $length = undef
293	IO::AIO::munlockall	297	IO::AIO::munlockall
		298
		299	# stat extensions
		300	$counter = IO::AIO::st_gen
		301	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		302	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		303	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		304	$seconds = IO::AIO::st_btimesec
		305	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		306
		307	# very much unportable syscalls
		308	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		309	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		310	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		311	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		312	$fh = IO::AIO::memfd_create $pathname[, $flags]
		313	$fh = IO::AIO::eventfd [$initval, [$flags]]
		314	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		315	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		316	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
294		317
295	=head2 API NOTES	318	=head2 API NOTES
296		319
297	All the C<aio_*> calls are more or less thin wrappers around the syscall	320	All the C<aio_*> calls are more or less thin wrappers around the syscall
298	with the same name (sans C<aio_>). The arguments are similar or identical,	321	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
404	following POSIX and non-POSIX constants are available (missing ones on	427	following POSIX and non-POSIX constants are available (missing ones on
405	your system are, as usual, C<0>):	428	your system are, as usual, C<0>):
406		429
407	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	430	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>,	431	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>.	432	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
410		433
411		434
412	=item aio_close $fh, $callback->($status)	435	=item aio_close $fh, $callback->($status)
413		436
414	Asynchronously close a file and call the callback with the result	437	Asynchronously close a file and call the callback with the result
…		…
540		563
541	=item aio_stat $fh_or_path, $callback->($status)	564	=item aio_stat $fh_or_path, $callback->($status)
542		565
543	=item aio_lstat $fh, $callback->($status)	566	=item aio_lstat $fh, $callback->($status)
544		567
545	Works like perl's C<stat> or C<lstat> in void context. The callback will	568	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 _>	569	callback will be called after the stat and the results will be available
547	or C<-s _> etc...	570	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
		571	and C<-T>).
548		572
549	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,	573	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
550	for an explanation.	574	for an explanation.
551		575
552	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	576	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
…		…
559	behaviour).	583	behaviour).
560		584
561	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	585	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>,	586	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>.	587	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		588
		589	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		590	ACCESS>.
564		591
565	Example: Print the length of F</etc/passwd>:	592	Example: Print the length of F</etc/passwd>:
566		593
567	aio_stat "/etc/passwd", sub {	594	aio_stat "/etc/passwd", sub {
568	$_[0] and die "stat failed: $!";	595	$_[0] and die "stat failed: $!";
…		…
618		645
619	Works like perl's C<utime> function (including the special case of $atime	646	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	647	and $mtime being undef). Fractional times are supported if the underlying
621	syscalls support them.	648	syscalls support them.
622		649
623	When called with a pathname, uses utimes(2) if available, otherwise	650	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,	651	otherwise utime(2). If called on a file descriptor, uses futimens(2)
625	otherwise returns ENOSYS, so this is not portable.	652	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		653	portable.
626		654
627	Examples:	655	Examples:
628		656
629	# set atime and mtime to current time (basically touch(1)):	657	# set atime and mtime to current time (basically touch(1)):
630	aio_utime "path", undef, undef;	658	aio_utime "path", undef, undef;
…		…
789		817
790	=over 4	818	=over 4
791		819
792	=item IO::AIO::READDIR_DENTS	820	=item IO::AIO::READDIR_DENTS
793		821
794	When this flag is off, then the callback gets an arrayref consisting of	822	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	823	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	824	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
797	entry in more detail.	825	single directory entry in more detail:
798		826
799	C<$name> is the name of the entry.	827	C<$name> is the name of the entry.
800		828
801	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	829	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
802		830
803	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	831	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>,	832	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>.	833	C<IO::AIO::DT_WHT>.
806		834
807	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	835	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>	836	to know, you have to run stat yourself. Also, for speed/memory reasons,
809	scalars are read-only: you can not modify them.	837	the C<$type> scalars are read-only: you must not modify them.
810		838
811	C<$inode> is the inode number (which might not be exact on systems with 64	839	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	840	bit inode numbers and 32 bit perls). This field has unspecified content on
813	systems that do not deliver the inode information.	841	systems that do not deliver the inode information.
814		842
…		…
825	short names are tried first.	853	short names are tried first.
826		854
827	=item IO::AIO::READDIR_STAT_ORDER	855	=item IO::AIO::READDIR_STAT_ORDER
828		856
829	When this flag is set, then the names will be returned in an order	857	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()	858	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	859	all files in the given directory, then the returned order will likely be
832	be fastest.	860	faster.
833		861
834	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	862	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.	863	then the likely dirs come first, resulting in a less optimal stat order
		864	for stat'ing all entries, but likely a more optimal order for finding
		865	subdirectories.
836		866
837	=item IO::AIO::READDIR_FOUND_UNKNOWN	867	=item IO::AIO::READDIR_FOUND_UNKNOWN
838		868
839	This flag should not be set when calling C<aio_readdirx>. Instead, it	869	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	870	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
1101	aioreq_pri $pri;	1131	aioreq_pri $pri;
1102	add $grp aio_stat $wd, sub {	1132	add $grp aio_stat $wd, sub {
1103	return $grp->result () if $_[0];	1133	return $grp->result () if $_[0];
1104	my $now = time;	1134	my $now = time;
1105	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1135	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1136	my $rdxflags = READDIR_DIRS_FIRST;
		1137
		1138	if ((stat _)[3] < 2) {
		1139	# at least one non-POSIX filesystem exists
		1140	# that returns useful DT_type values: btrfs,
		1141	# so optimise for this here by requesting dents
		1142	$rdxflags \|= READDIR_DENTS;
		1143	}
1106		1144
1107	# read the directory entries	1145	# read the directory entries
1108	aioreq_pri $pri;	1146	aioreq_pri $pri;
1109	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {	1147	add $grp aio_readdirx $wd, $rdxflags, sub {
1110	my $entries = shift	1148	my ($entries, $flags) = @_
1111	or return $grp->result ();	1149	or return $grp->result ();
		1150
		1151	if ($rdxflags & READDIR_DENTS) {
		1152	# if we requested type values, see if we can use them directly.
		1153
		1154	# if there were any DT_UNKNOWN entries then we assume we
		1155	# don't know. alternatively, we could assume that if we get
		1156	# one DT_DIR, then all directories are indeed marked with
		1157	# DT_DIR, but this seems not required for btrfs, and this
		1158	# is basically the "btrfs can't get it's act together" code
		1159	# branch.
		1160	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1161	# now we have valid DT_ information for all entries,
		1162	# so use it as an optimisation without further stat's.
		1163	# they must also all be at the beginning of @$entries
		1164	# by now.
		1165
		1166	my $dirs;
		1167
		1168	if (@$entries) {
		1169	for (0 .. $#$entries) {
		1170	if ($entries->[$_][1] != DT_DIR) {
		1171	# splice out directories
		1172	$dirs = [splice @$entries, 0, $_];
		1173	last;
		1174	}
		1175	}
		1176
		1177	# if we didn't find any non-dir, then all entries are dirs
		1178	unless ($dirs) {
		1179	($dirs, $entries) = ($entries, []);
		1180	}
		1181	} else {
		1182	# directory is empty, so there are no sbdirs
		1183	$dirs = [];
		1184	}
		1185
		1186	# either splice'd the directories out or the dir was empty.
		1187	# convert dents to filenames
		1188	$_ = $_->[0] for @$dirs;
		1189	$_ = $_->[0] for @$entries;
		1190
		1191	return $grp->result ($dirs, $entries);
		1192	}
		1193
		1194	# cannot use, so return to our old ways
		1195	# by pretending we only scanned for names.
		1196	$_ = $_->[0] for @$entries;
		1197	}
1112		1198
1113	# stat the dir another time	1199	# stat the dir another time
1114	aioreq_pri $pri;	1200	aioreq_pri $pri;
1115	add $grp aio_stat $wd, sub {	1201	add $grp aio_stat $wd, sub {
1116	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1202	my $hash2 = join ":", (stat _)[0,1,3,7,9];
…		…
1377	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1463	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1378	aio_mlock $data; # mlock in background	1464	aio_mlock $data; # mlock in background
1379		1465
1380	=item aio_mlockall $flags, $callback->($status)	1466	=item aio_mlockall $flags, $callback->($status)
1381		1467
1382	Calls the C<mlockall> function with the given C<$flags> (a combination of	1468	Calls the C<mlockall> function with the given C<$flags> (a
1383	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1469	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1470	C<IO::AIO::MCL_ONFAULT>).
1384		1471
1385	On systems that do not implement C<mlockall>, this function returns C<-1>	1472	On systems that do not implement C<mlockall>, this function returns C<-1>
1386	and sets errno to C<ENOSYS>.	1473	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1474	by the system result in a return value of C<-1> with errno being set to
		1475	C<EINVAL>.
1387		1476
1388	Note that the corresponding C<munlockall> is synchronous and is	1477	Note that the corresponding C<munlockall> is synchronous and is
1389	documented under L<MISCELLANEOUS FUNCTIONS>.	1478	documented under L<MISCELLANEOUS FUNCTIONS>.
1390		1479
1391	Example: asynchronously lock all current and future pages into memory.	1480	Example: asynchronously lock all current and future pages into memory.
…		…
1776	The default value for the limit is C<0>, but note that setting a feeder	1865	The default value for the limit is C<0>, but note that setting a feeder
1777	automatically bumps it up to C<2>.	1866	automatically bumps it up to C<2>.
1778		1867
1779	=back	1868	=back
1780		1869
		1870
1781	=head2 SUPPORT FUNCTIONS	1871	=head2 SUPPORT FUNCTIONS
1782		1872
1783	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1873	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1784		1874
1785	=over 4	1875	=over 4
…		…
1850	Strictly equivalent to:	1940	Strictly equivalent to:
1851		1941
1852	IO::AIO::poll_wait, IO::AIO::poll_cb	1942	IO::AIO::poll_wait, IO::AIO::poll_cb
1853	while IO::AIO::nreqs;	1943	while IO::AIO::nreqs;
1854		1944
		1945	This function can be useful at program aborts, to make sure outstanding
		1946	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1947	this function on normal exits), or when you are merely using C<IO::AIO>
		1948	for its more advanced functions, rather than for async I/O, e.g.:
		1949
		1950	my ($dirs, $nondirs);
		1951	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1952	IO::AIO::flush;
		1953	# $dirs, $nondirs are now set
		1954
1855	=item IO::AIO::max_poll_reqs $nreqs	1955	=item IO::AIO::max_poll_reqs $nreqs
1856		1956
1857	=item IO::AIO::max_poll_time $seconds	1957	=item IO::AIO::max_poll_time $seconds
1858		1958
1859	These set the maximum number of requests (default C<0>, meaning infinity)	1959	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1885	poll => 'r', nice => 1,	1985	poll => 'r', nice => 1,
1886	cb => &IO::AIO::poll_cb);	1986	cb => &IO::AIO::poll_cb);
1887		1987
1888	=back	1988	=back
1889		1989
		1990
1890	=head3 CONTROLLING THE NUMBER OF THREADS	1991	=head3 CONTROLLING THE NUMBER OF THREADS
1891		1992
1892	=over	1993	=over
1893		1994
1894	=item IO::AIO::min_parallel $nthreads	1995	=item IO::AIO::min_parallel $nthreads
…		…
1981	The default value for C<max_outstanding> is very large, so there is no	2082	The default value for C<max_outstanding> is very large, so there is no
1982	practical limit on the number of outstanding requests.	2083	practical limit on the number of outstanding requests.
1983		2084
1984	=back	2085	=back
1985		2086
		2087
1986	=head3 STATISTICAL INFORMATION	2088	=head3 STATISTICAL INFORMATION
1987		2089
1988	=over	2090	=over
1989		2091
1990	=item IO::AIO::nreqs	2092	=item IO::AIO::nreqs
…		…
2006		2108
2007	Returns the number of requests currently in the pending state (executed,	2109	Returns the number of requests currently in the pending state (executed,
2008	but not yet processed by poll_cb).	2110	but not yet processed by poll_cb).
2009		2111
2010	=back	2112	=back
		2113
		2114
		2115	=head3 SUBSECOND STAT TIME ACCESS
		2116
		2117	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2118	generally find access/modification and change times with subsecond time
		2119	accuracy of the system supports it, but perl's built-in functions only
		2120	return the integer part.
		2121
		2122	The following functions return the timestamps of the most recent
		2123	stat with subsecond precision on most systems and work both after
		2124	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2125	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2126	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2127
		2128	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2129	full resolution without rounding and work with standard perl C<stat>,
		2130	alleviating the need to call the special C<Time::HiRes> functions, which
		2131	do not act like their perl counterparts.
		2132
		2133	On operating systems or file systems where subsecond time resolution is
		2134	not supported or could not be detected, a fractional part of C<0> is
		2135	returned, so it is always safe to call these functions.
		2136
		2137	=over 4
		2138
		2139	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2140
		2141	Return the access, modication, change or birth time, respectively,
		2142	including fractional part. Due to the limited precision of floating point,
		2143	the accuracy on most platforms is only a bit better than milliseconds
		2144	for times around now - see the I<nsec> function family, below, for full
		2145	accuracy.
		2146
		2147	File birth time is only available when the OS and perl support it (on
		2148	FreeBSD and NetBSD at the time of this writing, although support is
		2149	adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
		2150	it). On systems where it isn't available, C<0> is currently returned, but
		2151	this might change to C<undef> in a future version.
		2152
		2153	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2154
		2155	Returns access, modification, change and birth time all in one go, and
		2156	maybe more times in the future version.
		2157
		2158	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2159
		2160	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2161	as an integer in the range C<0> to C<999999999>.
		2162
		2163	Note that no accessors are provided for access, modification and
		2164	change times - you need to get those from C<stat _> if required (C<int
		2165	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2166	value).
		2167
		2168	=item $seconds = IO::AIO::st_btimesec
		2169
		2170	The (integral) seconds part of the file birth time, if available.
		2171
		2172	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2173
		2174	Like the functions above, but returns all four times in one go (and maybe
		2175	more in future versions).
		2176
		2177	=item $counter = IO::AIO::st_gen
		2178
		2179	Returns the generation counter (in practice this is just a random number)
		2180	of the file. This is only available on platforms which have this member in
		2181	their C<struct stat> (most BSDs at the time of this writing) and generally
		2182	only to the root usert. If unsupported, C<0> is returned, but this might
		2183	change to C<undef> in a future version.
		2184
		2185	=back
		2186
		2187	Example: print the high resolution modification time of F</etc>, using
		2188	C<stat>, and C<IO::AIO::aio_stat>.
		2189
		2190	if (stat "/etc") {
		2191	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2192	}
		2193
		2194	IO::AIO::aio_stat "/etc", sub {
		2195	$_[0]
		2196	and return;
		2197
		2198	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2199	};
		2200
		2201	IO::AIO::flush;
		2202
		2203	Output of the awbove on my system, showing reduced and full accuracy:
		2204
		2205	stat(/etc) mtime: 1534043702.020808
		2206	aio_stat(/etc) mtime: 1534043702.020807792
		2207
2011		2208
2012	=head3 MISCELLANEOUS FUNCTIONS	2209	=head3 MISCELLANEOUS FUNCTIONS
2013		2210
2014	IO::AIO implements some functions that are useful when you want to use	2211	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	2212	some "Advanced I/O" function not available to in Perl, without going the
…		…
2156		2353
2157	=item IO::AIO::munmap $scalar	2354	=item IO::AIO::munmap $scalar
2158		2355
2159	Removes a previous mmap and undefines the C<$scalar>.	2356	Removes a previous mmap and undefines the C<$scalar>.
2160		2357
		2358	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2359
		2360	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2361	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2362	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2363
		2364	Returns true if successful, and false otherwise. If the underlying mmapped
		2365	region has changed address, then the true value has the numerical value
		2366	C<1>, otherwise it has the numerical value C<0>:
		2367
		2368	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2369	or die "mremap: $!";
		2370
		2371	if ($success*1) {
		2372	warn "scalar has chanegd address in memory\n";
		2373	}
		2374
		2375	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2376	implemented, but not supported and might go away in a future version.
		2377
		2378	On systems where this call is not supported or is not emulated, this call
		2379	returns falls and sets C<$!> to C<ENOSYS>.
		2380
		2381	=item IO::AIO::mlockall $flags
		2382
		2383	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2384	but is blocking.
		2385
2161	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2386	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2162		2387
2163	Calls the C<munlock> function, undoing the effects of a previous	2388	Calls the C<munlock> function, undoing the effects of a previous
2164	C<aio_mlock> call (see its description for details).	2389	C<aio_mlock> call (see its description for details).
2165		2390
…		…
2220	Example: create a pipe race-free w.r.t. threads and fork:	2445	Example: create a pipe race-free w.r.t. threads and fork:
2221		2446
2222	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC	2447	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2223	or die "pipe2: $!\n";	2448	or die "pipe2: $!\n";
2224		2449
		2450	=item $fh = IO::AIO::memfd_create $pathname[, $flags]
		2451
		2452	This is a direct interface to the Linux L<memfd_create(2)> system
		2453	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2454	should be C<IO::AIO::MFD_CLOEXEC>.
		2455
		2456	On success, the new memfd filehandle is returned, otherwise returns
		2457	C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
		2458
		2459	Please refer to L<memfd_create(2)> for more info on this call.
		2460
		2461	The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
		2462	C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
		2463
		2464	Example: create a new memfd.
		2465
		2466	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		2467	or die "m,emfd_create: $!\n";
2225	=item $fh = IO::AIO::eventfd ([$initval, [$flags]])	2468	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2226		2469
2227	This is a direct interface to the Linux L<eventfd(2)> system call. The	2470	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.	2471	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2229		2472
2230	On success, the new eventfd filehandle is returned, otherwise returns	2473	On success, the new eventfd filehandle is returned, otherwise returns
…		…
2232		2475
2233	Please refer to L<eventfd(2)> for more info on this call.	2476	Please refer to L<eventfd(2)> for more info on this call.
2234		2477
2235	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,	2478	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).	2479	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2480
		2481	Example: create a new eventfd filehandle:
		2482
		2483	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
		2484	or die "eventfd: $!\n";
		2485
		2486	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2487
		2488	This is a direct interface to the Linux L<timerfd_create(2)> system
		2489	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2490	should be C<IO::AIO::TFD_CLOEXEC>.
		2491
		2492	On success, the new timerfd filehandle is returned, otherwise returns
		2493	C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
		2494
		2495	Please refer to L<timerfd_create(2)> for more info on this call.
		2496
		2497	The following C<$clockid> values are
		2498	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2499	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2500	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2501	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2502
		2503	The following C<$flags> values are available (Linux
		2504	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2505
		2506	Example: create a new timerfd and set it to one-second repeated alarms,
		2507	then wait for two alarms:
		2508
		2509	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2510	or die "timerfd_create: $!\n";
		2511
		2512	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2513	or die "timerfd_settime: $!\n";
		2514
		2515	for (1..2) {
		2516	8 == sysread $fh, my $buf, 8
		2517	or die "timerfd read failure\n";
		2518
		2519	printf "number of expirations (likely 1): %d\n",
		2520	unpack "Q", $buf;
		2521	}
		2522
		2523	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2524
		2525	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2526	call. Please refer to its manpage for more info on this call.
		2527
		2528	The new itimerspec is specified using two (possibly fractional) second
		2529	values, C<$new_interval> and C<$new_value>).
		2530
		2531	On success, the current interval and value are returned (as per
		2532	C<timerfd_gettime>). On failure, the empty list is returned.
		2533
		2534	The following C<$flags> values are
		2535	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2536	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2537
		2538	See C<IO::AIO::timerfd_create> for a full example.
		2539
		2540	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2541
		2542	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2543	call. Please refer to its manpage for more info on this call.
		2544
		2545	On success, returns the current values of interval and value for the given
		2546	timerfd (as potentially fractional second values). On failure, the empty
		2547	list is returned.
2237		2548
2238	=back	2549	=back
2239		2550
2240	=cut	2551	=cut
2241		2552
…		…
2307	the process will result in undefined behaviour. Calling it at any time	2618	the process will result in undefined behaviour. Calling it at any time
2308	will also result in any undefined (by POSIX) behaviour.	2619	will also result in any undefined (by POSIX) behaviour.
2309		2620
2310	=back	2621	=back
2311		2622
		2623	=head2 LINUX-SPECIFIC CALLS
		2624
		2625	When a call is documented as "linux-specific" then this means it
		2626	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2627	availability and compatibility of such calls regardless of the platform
		2628	it is compiled on, so platforms such as FreeBSD which often implement
		2629	these calls will work. When in doubt, call them and see if they fail wth
		2630	C<ENOSYS>.
		2631
2312	=head2 MEMORY USAGE	2632	=head2 MEMORY USAGE
2313		2633
2314	Per-request usage:	2634	Per-request usage:
2315		2635
2316	Each aio request uses - depending on your architecture - around 100-200	2636	Each aio request uses - depending on your architecture - around 100-200
…		…
2328	temporary buffers, and each thread requires a stack and other data	2648	temporary buffers, and each thread requires a stack and other data
2329	structures (usually around 16k-128k, depending on the OS).	2649	structures (usually around 16k-128k, depending on the OS).
2330		2650
2331	=head1 KNOWN BUGS	2651	=head1 KNOWN BUGS
2332		2652
2333	Known bugs will be fixed in the next release.	2653	Known bugs will be fixed in the next release :)
		2654
		2655	=head1 KNOWN ISSUES
		2656
		2657	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2658	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2659	non-created hash slots or other scalars I didn't think of. It's best to
		2660	avoid such and either use scalar variables or making sure that the scalar
		2661	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2662
		2663	I am not sure anything can be done about this, so this is considered a
		2664	known issue, rather than a bug.
2334		2665
2335	=head1 SEE ALSO	2666	=head1 SEE ALSO
2336		2667
2337	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2668	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2338	more natural syntax.	2669	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.302 by root, Wed Apr 3 03:03:53 2019 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.302 by root, Wed Apr 3 03:03:53 2019 UTC