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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.284 by root, Fri Mar 23 01:14:08 2018 UTC vs.
Revision 1.306 by root, Wed Oct 16 09:11:35 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.73;
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::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
		309	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		310	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		311	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		312	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		313	$fh = IO::AIO::memfd_create $pathname[, $flags]
		314	$fh = IO::AIO::eventfd [$initval, [$flags]]
		315	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		316	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		317	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
294		318
295	=head2 API NOTES	319	=head2 API NOTES
296		320
297	All the C<aio_*> calls are more or less thin wrappers around the syscall	321	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,	322	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	428	following POSIX and non-POSIX constants are available (missing ones on
405	your system are, as usual, C<0>):	429	your system are, as usual, C<0>):
406		430
407	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	431	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>,	432	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>.	433	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
410		434
411		435
412	=item aio_close $fh, $callback->($status)	436	=item aio_close $fh, $callback->($status)
413		437
414	Asynchronously close a file and call the callback with the result	438	Asynchronously close a file and call the callback with the result
…		…
540		564
541	=item aio_stat $fh_or_path, $callback->($status)	565	=item aio_stat $fh_or_path, $callback->($status)
542		566
543	=item aio_lstat $fh, $callback->($status)	567	=item aio_lstat $fh, $callback->($status)
544		568
545	Works like perl's C<stat> or C<lstat> in void context. The callback will	569	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 _>	570	callback will be called after the stat and the results will be available
547	or C<-s _> etc...	571	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
		572	and C<-T>).
548		573
549	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,	574	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
550	for an explanation.	575	for an explanation.
551		576
552	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	577	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
…		…
559	behaviour).	584	behaviour).
560		585
561	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	586	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>,	587	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>.	588	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		589
		590	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		591	ACCESS>.
564		592
565	Example: Print the length of F</etc/passwd>:	593	Example: Print the length of F</etc/passwd>:
566		594
567	aio_stat "/etc/passwd", sub {	595	aio_stat "/etc/passwd", sub {
568	$_[0] and die "stat failed: $!";	596	$_[0] and die "stat failed: $!";
…		…
618		646
619	Works like perl's C<utime> function (including the special case of $atime	647	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	648	and $mtime being undef). Fractional times are supported if the underlying
621	syscalls support them.	649	syscalls support them.
622		650
623	When called with a pathname, uses utimes(2) if available, otherwise	651	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,	652	otherwise utime(2). If called on a file descriptor, uses futimens(2)
625	otherwise returns ENOSYS, so this is not portable.	653	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		654	portable.
626		655
627	Examples:	656	Examples:
628		657
629	# set atime and mtime to current time (basically touch(1)):	658	# set atime and mtime to current time (basically touch(1)):
630	aio_utime "path", undef, undef;	659	aio_utime "path", undef, undef;
…		…
1103	aioreq_pri $pri;	1132	aioreq_pri $pri;
1104	add $grp aio_stat $wd, sub {	1133	add $grp aio_stat $wd, sub {
1105	return $grp->result () if $_[0];	1134	return $grp->result () if $_[0];
1106	my $now = time;	1135	my $now = time;
1107	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1136	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1137	my $rdxflags = READDIR_DIRS_FIRST;
		1138
		1139	if ((stat _)[3] < 2) {
		1140	# at least one non-POSIX filesystem exists
		1141	# that returns useful DT_type values: btrfs,
		1142	# so optimise for this here by requesting dents
		1143	$rdxflags \|= READDIR_DENTS;
		1144	}
1108		1145
1109	# read the directory entries	1146	# read the directory entries
1110	aioreq_pri $pri;	1147	aioreq_pri $pri;
1111	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {	1148	add $grp aio_readdirx $wd, $rdxflags, sub {
1112	my $entries = shift	1149	my ($entries, $flags) = @_
1113	or return $grp->result ();	1150	or return $grp->result ();
		1151
		1152	if ($rdxflags & READDIR_DENTS) {
		1153	# if we requested type values, see if we can use them directly.
		1154
		1155	# if there were any DT_UNKNOWN entries then we assume we
		1156	# don't know. alternatively, we could assume that if we get
		1157	# one DT_DIR, then all directories are indeed marked with
		1158	# DT_DIR, but this seems not required for btrfs, and this
		1159	# is basically the "btrfs can't get it's act together" code
		1160	# branch.
		1161	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1162	# now we have valid DT_ information for all entries,
		1163	# so use it as an optimisation without further stat's.
		1164	# they must also all be at the beginning of @$entries
		1165	# by now.
		1166
		1167	my $dirs;
		1168
		1169	if (@$entries) {
		1170	for (0 .. $#$entries) {
		1171	if ($entries->[$_][1] != DT_DIR) {
		1172	# splice out directories
		1173	$dirs = [splice @$entries, 0, $_];
		1174	last;
		1175	}
		1176	}
		1177
		1178	# if we didn't find any non-dir, then all entries are dirs
		1179	unless ($dirs) {
		1180	($dirs, $entries) = ($entries, []);
		1181	}
		1182	} else {
		1183	# directory is empty, so there are no sbdirs
		1184	$dirs = [];
		1185	}
		1186
		1187	# either splice'd the directories out or the dir was empty.
		1188	# convert dents to filenames
		1189	$_ = $_->[0] for @$dirs;
		1190	$_ = $_->[0] for @$entries;
		1191
		1192	return $grp->result ($dirs, $entries);
		1193	}
		1194
		1195	# cannot use, so return to our old ways
		1196	# by pretending we only scanned for names.
		1197	$_ = $_->[0] for @$entries;
		1198	}
1114		1199
1115	# stat the dir another time	1200	# stat the dir another time
1116	aioreq_pri $pri;	1201	aioreq_pri $pri;
1117	add $grp aio_stat $wd, sub {	1202	add $grp aio_stat $wd, sub {
1118	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1203	my $hash2 = join ":", (stat _)[0,1,3,7,9];
…		…
1224	So in general, you should only use these calls for things that do	1309	So in general, you should only use these calls for things that do
1225	(filesystem) I/O, not for things that wait for other events (network,	1310	(filesystem) I/O, not for things that wait for other events (network,
1226	other processes), although if you are careful and know what you are doing,	1311	other processes), although if you are careful and know what you are doing,
1227	you still can.	1312	you still can.
1228		1313
1229	The following constants are available (missing ones are, as usual C<0>):	1314	The following constants are available and can be used for normal C<ioctl>
		1315	and C<fcntl> as well (missing ones are, as usual C<0>):
1230		1316
1231	C<F_DUPFD_CLOEXEC>,	1317	C<F_DUPFD_CLOEXEC>,
1232		1318
1233	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,	1319	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1234		1320
1235	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.	1321	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1322
		1323	C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
		1324	C<F_SEAL_WRITE>.
1236		1325
1237	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,	1326	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1238	C<FS_IOC_FIEMAP>.	1327	C<FS_IOC_FIEMAP>.
1239		1328
1240	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,	1329	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
…		…
1379	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1468	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1380	aio_mlock $data; # mlock in background	1469	aio_mlock $data; # mlock in background
1381		1470
1382	=item aio_mlockall $flags, $callback->($status)	1471	=item aio_mlockall $flags, $callback->($status)
1383		1472
1384	Calls the C<mlockall> function with the given C<$flags> (a combination of	1473	Calls the C<mlockall> function with the given C<$flags> (a
1385	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1474	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1475	C<IO::AIO::MCL_ONFAULT>).
1386		1476
1387	On systems that do not implement C<mlockall>, this function returns C<-1>	1477	On systems that do not implement C<mlockall>, this function returns C<-1>
1388	and sets errno to C<ENOSYS>.	1478	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1479	by the system result in a return value of C<-1> with errno being set to
		1480	C<EINVAL>.
1389		1481
1390	Note that the corresponding C<munlockall> is synchronous and is	1482	Note that the corresponding C<munlockall> is synchronous and is
1391	documented under L<MISCELLANEOUS FUNCTIONS>.	1483	documented under L<MISCELLANEOUS FUNCTIONS>.
1392		1484
1393	Example: asynchronously lock all current and future pages into memory.	1485	Example: asynchronously lock all current and future pages into memory.
…		…
1587	C<aio_wd> callback, as future requests using the value will fail in the	1679	C<aio_wd> callback, as future requests using the value will fail in the
1588	expected way.	1680	expected way.
1589		1681
1590	=item IO::AIO::CWD	1682	=item IO::AIO::CWD
1591		1683
1592	This is a compiletime constant (object) that represents the process	1684	This is a compile time constant (object) that represents the process
1593	current working directory.	1685	current working directory.
1594		1686
1595	Specifying this object as working directory object for a pathname is as if	1687	Specifying this object as working directory object for a pathname is as if
1596	the pathname would be specified directly, without a directory object. For	1688	the pathname would be specified directly, without a directory object. For
1597	example, these calls are functionally identical:	1689	example, these calls are functionally identical:
…		…
1778	The default value for the limit is C<0>, but note that setting a feeder	1870	The default value for the limit is C<0>, but note that setting a feeder
1779	automatically bumps it up to C<2>.	1871	automatically bumps it up to C<2>.
1780		1872
1781	=back	1873	=back
1782		1874
		1875
1783	=head2 SUPPORT FUNCTIONS	1876	=head2 SUPPORT FUNCTIONS
1784		1877
1785	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1878	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1786		1879
1787	=over 4	1880	=over 4
…		…
1852	Strictly equivalent to:	1945	Strictly equivalent to:
1853		1946
1854	IO::AIO::poll_wait, IO::AIO::poll_cb	1947	IO::AIO::poll_wait, IO::AIO::poll_cb
1855	while IO::AIO::nreqs;	1948	while IO::AIO::nreqs;
1856		1949
		1950	This function can be useful at program aborts, to make sure outstanding
		1951	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1952	this function on normal exits), or when you are merely using C<IO::AIO>
		1953	for its more advanced functions, rather than for async I/O, e.g.:
		1954
		1955	my ($dirs, $nondirs);
		1956	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1957	IO::AIO::flush;
		1958	# $dirs, $nondirs are now set
		1959
1857	=item IO::AIO::max_poll_reqs $nreqs	1960	=item IO::AIO::max_poll_reqs $nreqs
1858		1961
1859	=item IO::AIO::max_poll_time $seconds	1962	=item IO::AIO::max_poll_time $seconds
1860		1963
1861	These set the maximum number of requests (default C<0>, meaning infinity)	1964	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1887	poll => 'r', nice => 1,	1990	poll => 'r', nice => 1,
1888	cb => &IO::AIO::poll_cb);	1991	cb => &IO::AIO::poll_cb);
1889		1992
1890	=back	1993	=back
1891		1994
		1995
1892	=head3 CONTROLLING THE NUMBER OF THREADS	1996	=head3 CONTROLLING THE NUMBER OF THREADS
1893		1997
1894	=over	1998	=over
1895		1999
1896	=item IO::AIO::min_parallel $nthreads	2000	=item IO::AIO::min_parallel $nthreads
…		…
1983	The default value for C<max_outstanding> is very large, so there is no	2087	The default value for C<max_outstanding> is very large, so there is no
1984	practical limit on the number of outstanding requests.	2088	practical limit on the number of outstanding requests.
1985		2089
1986	=back	2090	=back
1987		2091
		2092
1988	=head3 STATISTICAL INFORMATION	2093	=head3 STATISTICAL INFORMATION
1989		2094
1990	=over	2095	=over
1991		2096
1992	=item IO::AIO::nreqs	2097	=item IO::AIO::nreqs
…		…
2008		2113
2009	Returns the number of requests currently in the pending state (executed,	2114	Returns the number of requests currently in the pending state (executed,
2010	but not yet processed by poll_cb).	2115	but not yet processed by poll_cb).
2011		2116
2012	=back	2117	=back
		2118
		2119
		2120	=head3 SUBSECOND STAT TIME ACCESS
		2121
		2122	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2123	generally find access/modification and change times with subsecond time
		2124	accuracy of the system supports it, but perl's built-in functions only
		2125	return the integer part.
		2126
		2127	The following functions return the timestamps of the most recent
		2128	stat with subsecond precision on most systems and work both after
		2129	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2130	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2131	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2132
		2133	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2134	full resolution without rounding and work with standard perl C<stat>,
		2135	alleviating the need to call the special C<Time::HiRes> functions, which
		2136	do not act like their perl counterparts.
		2137
		2138	On operating systems or file systems where subsecond time resolution is
		2139	not supported or could not be detected, a fractional part of C<0> is
		2140	returned, so it is always safe to call these functions.
		2141
		2142	=over 4
		2143
		2144	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2145
		2146	Return the access, modication, change or birth time, respectively,
		2147	including fractional part. Due to the limited precision of floating point,
		2148	the accuracy on most platforms is only a bit better than milliseconds
		2149	for times around now - see the I<nsec> function family, below, for full
		2150	accuracy.
		2151
		2152	File birth time is only available when the OS and perl support it (on
		2153	FreeBSD and NetBSD at the time of this writing, although support is
		2154	adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
		2155	it). On systems where it isn't available, C<0> is currently returned, but
		2156	this might change to C<undef> in a future version.
		2157
		2158	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2159
		2160	Returns access, modification, change and birth time all in one go, and
		2161	maybe more times in the future version.
		2162
		2163	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2164
		2165	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2166	as an integer in the range C<0> to C<999999999>.
		2167
		2168	Note that no accessors are provided for access, modification and
		2169	change times - you need to get those from C<stat _> if required (C<int
		2170	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2171	value).
		2172
		2173	=item $seconds = IO::AIO::st_btimesec
		2174
		2175	The (integral) seconds part of the file birth time, if available.
		2176
		2177	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2178
		2179	Like the functions above, but returns all four times in one go (and maybe
		2180	more in future versions).
		2181
		2182	=item $counter = IO::AIO::st_gen
		2183
		2184	Returns the generation counter (in practice this is just a random number)
		2185	of the file. This is only available on platforms which have this member in
		2186	their C<struct stat> (most BSDs at the time of this writing) and generally
		2187	only to the root usert. If unsupported, C<0> is returned, but this might
		2188	change to C<undef> in a future version.
		2189
		2190	=back
		2191
		2192	Example: print the high resolution modification time of F</etc>, using
		2193	C<stat>, and C<IO::AIO::aio_stat>.
		2194
		2195	if (stat "/etc") {
		2196	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2197	}
		2198
		2199	IO::AIO::aio_stat "/etc", sub {
		2200	$_[0]
		2201	and return;
		2202
		2203	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2204	};
		2205
		2206	IO::AIO::flush;
		2207
		2208	Output of the awbove on my system, showing reduced and full accuracy:
		2209
		2210	stat(/etc) mtime: 1534043702.020808
		2211	aio_stat(/etc) mtime: 1534043702.020807792
		2212
2013		2213
2014	=head3 MISCELLANEOUS FUNCTIONS	2214	=head3 MISCELLANEOUS FUNCTIONS
2015		2215
2016	IO::AIO implements some functions that are useful when you want to use	2216	IO::AIO implements some functions that are useful when you want to use
2017	some "Advanced I/O" function not available to in Perl, without going the	2217	some "Advanced I/O" function not available to in Perl, without going the
…		…
2158		2358
2159	=item IO::AIO::munmap $scalar	2359	=item IO::AIO::munmap $scalar
2160		2360
2161	Removes a previous mmap and undefines the C<$scalar>.	2361	Removes a previous mmap and undefines the C<$scalar>.
2162		2362
		2363	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2364
		2365	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2366	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2367	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2368
		2369	Returns true if successful, and false otherwise. If the underlying mmapped
		2370	region has changed address, then the true value has the numerical value
		2371	C<1>, otherwise it has the numerical value C<0>:
		2372
		2373	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2374	or die "mremap: $!";
		2375
		2376	if ($success*1) {
		2377	warn "scalar has chanegd address in memory\n";
		2378	}
		2379
		2380	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2381	implemented, but not supported and might go away in a future version.
		2382
		2383	On systems where this call is not supported or is not emulated, this call
		2384	returns falls and sets C<$!> to C<ENOSYS>.
		2385
		2386	=item IO::AIO::mlockall $flags
		2387
		2388	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2389	but is blocking.
		2390
2163	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2391	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2164		2392
2165	Calls the C<munlock> function, undoing the effects of a previous	2393	Calls the C<munlock> function, undoing the effects of a previous
2166	C<aio_mlock> call (see its description for details).	2394	C<aio_mlock> call (see its description for details).
2167		2395
…		…
2169		2397
2170	Calls the C<munlockall> function.	2398	Calls the C<munlockall> function.
2171		2399
2172	On systems that do not implement C<munlockall>, this function returns	2400	On systems that do not implement C<munlockall>, this function returns
2173	ENOSYS, otherwise the return value of C<munlockall>.	2401	ENOSYS, otherwise the return value of C<munlockall>.
		2402
		2403	=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
		2404
		2405	Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
		2406	and return the new file handle on success, or sets C<$!> and returns
		2407	C<undef> on error.
		2408
		2409	The remote name of the new socket will be stored in C<$sockaddr>, which
		2410	will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
		2411	socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
		2412	by returning a longer string in C<$sockaddr>, which might or might not be
		2413	truncated.
		2414
		2415	To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
		2416	C<$sockaddr_maxlen>.
		2417
		2418	The main reasons to use this syscall rather than portable C«accept(2)>
		2419	are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
		2420	flags and you can accept name-less sockets by specifying C<0> for
		2421	C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
		2422	C<accept>.
2174		2423
2175	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags	2424	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2176		2425
2177	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or	2426	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2178	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they	2427	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
…		…
2222	Example: create a pipe race-free w.r.t. threads and fork:	2471	Example: create a pipe race-free w.r.t. threads and fork:
2223		2472
2224	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC	2473	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2225	or die "pipe2: $!\n";	2474	or die "pipe2: $!\n";
2226		2475
		2476	=item $fh = IO::AIO::memfd_create $pathname[, $flags]
		2477
		2478	This is a direct interface to the Linux L<memfd_create(2)> system
		2479	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2480	should be C<IO::AIO::MFD_CLOEXEC>.
		2481
		2482	On success, the new memfd filehandle is returned, otherwise returns
		2483	C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
		2484
		2485	Please refer to L<memfd_create(2)> for more info on this call.
		2486
		2487	The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
		2488	C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
		2489
		2490	Example: create a new memfd.
		2491
		2492	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		2493	or die "m,emfd_create: $!\n";
2227	=item $fh = IO::AIO::eventfd [$initval, [$flags]]	2494	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2228		2495
2229	This is a direct interface to the Linux L<eventfd(2)> system call. The	2496	This is a direct interface to the Linux L<eventfd(2)> system call. The
2230	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.	2497	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2231		2498
…		…
2237	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,	2504	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2238	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).	2505	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2239		2506
2240	Example: create a new eventfd filehandle:	2507	Example: create a new eventfd filehandle:
2241		2508
2242	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC	2509	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2243	or die "eventfd: $!\n";	2510	or die "eventfd: $!\n";
2244		2511
2245	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]	2512	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2246		2513
2247	This is a direct interface to the Linux L<timerfd_create(2)> system call. The	2514	This is a direct interface to the Linux L<timerfd_create(2)> system
2248	(unhelpful) default for C<$flags> is C<0>.	2515	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2516	should be C<IO::AIO::TFD_CLOEXEC>.
2249		2517
2250	On success, the new timerfd filehandle is returned, otherwise returns	2518	On success, the new timerfd filehandle is returned, otherwise returns
2251	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.	2519	C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2252		2520
2253	Please refer to L<timerfd_create(2)> for more info on this call.	2521	Please refer to L<timerfd_create(2)> for more info on this call.
2254		2522
2255	The following C<$clockid> values are	2523	The following C<$clockid> values are
2256	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>	2524	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
…		…
2422	known issue, rather than a bug.	2690	known issue, rather than a bug.
2423		2691
2424	=head1 SEE ALSO	2692	=head1 SEE ALSO
2425		2693
2426	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2694	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2427	more natural syntax.	2695	more natural syntax and L<IO::FDPass> for file descriptor passing.
2428		2696
2429	=head1 AUTHOR	2697	=head1 AUTHOR
2430		2698
2431	Marc Lehmann <schmorp@schmorp.de>	2699	Marc Lehmann <schmorp@schmorp.de>
2432	http://home.schmorp.de/	2700	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.284 by root, Fri Mar 23 01:14:08 2018 UTC vs. Revision 1.306 by root, Wed Oct 16 09:11:35 2019 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.284 by root, Fri Mar 23 01:14:08 2018 UTC vs.
Revision 1.306 by root, Wed Oct 16 09:11:35 2019 UTC