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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.289 by root, Sun Aug 12 05:21:35 2018 UTC vs.
Revision 1.318 by root, Sat Apr 1 02:14:05 2023 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.5;	176	our $VERSION = 4.80;
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 mremap munlock munlockall);	197	mmap munmap mremap munlock munlockall
		198
		199	accept4 tee splice pipe2 pipesize
		200	fexecve mount umount memfd_create eventfd
		201	timerfd_create timerfd_settime timerfd_gettime
		202	pidfd_open pidfd_send_signal pidfd_getfd);
198		203
199	push @AIO_REQ, qw(aio_busy); # not exported	204	push @AIO_REQ, qw(aio_busy); # not exported
200		205
201	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	206	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
202		207
…		…
278	IO::AIO::idle_timeout $seconds	283	IO::AIO::idle_timeout $seconds
279	IO::AIO::max_outstanding $maxreqs	284	IO::AIO::max_outstanding $maxreqs
280	IO::AIO::nreqs	285	IO::AIO::nreqs
281	IO::AIO::nready	286	IO::AIO::nready
282	IO::AIO::npending	287	IO::AIO::npending
		288	IO::AIO::reinit
		289
283	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]	290	$nfd = IO::AIO::get_fdlimit
284	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]	291	IO::AIO::min_fdlimit $nfd
285		292
286	IO::AIO::sendfile $ofh, $ifh, $offset, $count	293	IO::AIO::sendfile $ofh, $ifh, $offset, $count
287	IO::AIO::fadvise $fh, $offset, $len, $advice	294	IO::AIO::fadvise $fh, $offset, $len, $advice
		295	IO::AIO::fexecve $fh, $argv, $envp
		296
288	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	297	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289	IO::AIO::munmap $scalar	298	IO::AIO::munmap $scalar
290	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]	299	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
291	IO::AIO::madvise $scalar, $offset, $length, $advice	300	IO::AIO::madvise $scalar, $offset, $length, $advice
292	IO::AIO::mprotect $scalar, $offset, $length, $protect	301	IO::AIO::mprotect $scalar, $offset, $length, $protect
293	IO::AIO::munlock $scalar, $offset = 0, $length = undef	302	IO::AIO::munlock $scalar, $offset = 0, $length = undef
294	IO::AIO::munlockall	303	IO::AIO::munlockall
		304
		305	# stat extensions
		306	$counter = IO::AIO::st_gen
		307	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		308	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		309	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		310	$seconds = IO::AIO::st_btimesec
		311	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		312
		313	# very much unportable syscalls
		314	IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
		315	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		316	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		317
		318	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		319	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		320
		321	$fh = IO::AIO::eventfd [$initval, [$flags]]
		322	$fh = IO::AIO::memfd_create $pathname[, $flags]
		323
		324	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		325	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		326	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		327
		328	$fh = IO::AIO::pidfd_open $pid[, $flags]
		329	$status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		330	$fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		331
		332	$retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		333	$retval = IO::AIO::umount $path, $flags = 0
295		334
296	=head2 API NOTES	335	=head2 API NOTES
297		336
298	All the C<aio_*> calls are more or less thin wrappers around the syscall	337	All the C<aio_*> calls are more or less thin wrappers around the syscall
299	with the same name (sans C<aio_>). The arguments are similar or identical,	338	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
374	=item aio_open $pathname, $flags, $mode, $callback->($fh)	413	=item aio_open $pathname, $flags, $mode, $callback->($fh)
375		414
376	Asynchronously open or create a file and call the callback with a newly	415	Asynchronously open or create a file and call the callback with a newly
377	created filehandle for the file (or C<undef> in case of an error).	416	created filehandle for the file (or C<undef> in case of an error).
378		417
379	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
380	for an explanation.
381
382	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	418	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
383	list. They are the same as used by C<sysopen>.	419	list. They are the same as used by C<sysopen>.
384		420
385	Likewise, C<$mode> specifies the mode of the newly created file, if it	421	Likewise, C<$mode> specifies the mode of the newly created file, if it
386	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	422	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
…		…
541		577
542	=item aio_stat $fh_or_path, $callback->($status)	578	=item aio_stat $fh_or_path, $callback->($status)
543		579
544	=item aio_lstat $fh, $callback->($status)	580	=item aio_lstat $fh, $callback->($status)
545		581
546	Works like perl's C<stat> or C<lstat> in void context. The callback will	582	Works almost exactly like perl's C<stat> or C<lstat> in void context. The
547	be called after the stat and the results will be available using C<stat _>	583	callback will be called after the stat and the results will be available
548	or C<-s _> etc...	584	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
549		585	and C<-T>).
550	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
551	for an explanation.
552		586
553	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	587	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
554	error when stat'ing a large file, the results will be silently truncated	588	error when stat'ing a large file, the results will be silently truncated
555	unless perl itself is compiled with large file support.	589	unless perl itself is compiled with large file support.
556		590
…		…
622		656
623	Works like perl's C<utime> function (including the special case of $atime	657	Works like perl's C<utime> function (including the special case of $atime
624	and $mtime being undef). Fractional times are supported if the underlying	658	and $mtime being undef). Fractional times are supported if the underlying
625	syscalls support them.	659	syscalls support them.
626		660
627	When called with a pathname, uses utimes(2) if available, otherwise	661	When called with a pathname, uses utimensat(2) or utimes(2) if available,
628	utime(2). If called on a file descriptor, uses futimes(2) if available,	662	otherwise utime(2). If called on a file descriptor, uses futimens(2)
629	otherwise returns ENOSYS, so this is not portable.	663	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		664	portable.
630		665
631	Examples:	666	Examples:
632		667
633	# set atime and mtime to current time (basically touch(1)):	668	# set atime and mtime to current time (basically touch(1)):
634	aio_utime "path", undef, undef;	669	aio_utime "path", undef, undef;
…		…
1107	aioreq_pri $pri;	1142	aioreq_pri $pri;
1108	add $grp aio_stat $wd, sub {	1143	add $grp aio_stat $wd, sub {
1109	return $grp->result () if $_[0];	1144	return $grp->result () if $_[0];
1110	my $now = time;	1145	my $now = time;
1111	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1146	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1147	my $rdxflags = READDIR_DIRS_FIRST;
		1148
		1149	if ((stat _)[3] < 2) {
		1150	# at least one non-POSIX filesystem exists
		1151	# that returns useful DT_type values: btrfs,
		1152	# so optimise for this here by requesting dents
		1153	$rdxflags \|= READDIR_DENTS;
		1154	}
1112		1155
1113	# read the directory entries	1156	# read the directory entries
1114	aioreq_pri $pri;	1157	aioreq_pri $pri;
1115	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {	1158	add $grp aio_readdirx $wd, $rdxflags, sub {
1116	my $entries = shift	1159	my ($entries, $flags) = @_
1117	or return $grp->result ();	1160	or return $grp->result ();
		1161
		1162	if ($rdxflags & READDIR_DENTS) {
		1163	# if we requested type values, see if we can use them directly.
		1164
		1165	# if there were any DT_UNKNOWN entries then we assume we
		1166	# don't know. alternatively, we could assume that if we get
		1167	# one DT_DIR, then all directories are indeed marked with
		1168	# DT_DIR, but this seems not required for btrfs, and this
		1169	# is basically the "btrfs can't get it's act together" code
		1170	# branch.
		1171	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1172	# now we have valid DT_ information for all entries,
		1173	# so use it as an optimisation without further stat's.
		1174	# they must also all be at the beginning of @$entries
		1175	# by now.
		1176
		1177	my $dirs;
		1178
		1179	if (@$entries) {
		1180	for (0 .. $#$entries) {
		1181	if ($entries->[$_][1] != DT_DIR) {
		1182	# splice out directories
		1183	$dirs = [splice @$entries, 0, $_];
		1184	last;
		1185	}
		1186	}
		1187
		1188	# if we didn't find any non-dir, then all entries are dirs
		1189	unless ($dirs) {
		1190	($dirs, $entries) = ($entries, []);
		1191	}
		1192	} else {
		1193	# directory is empty, so there are no sbdirs
		1194	$dirs = [];
		1195	}
		1196
		1197	# either splice'd the directories out or the dir was empty.
		1198	# convert dents to filenames
		1199	$_ = $_->[0] for @$dirs;
		1200	$_ = $_->[0] for @$entries;
		1201
		1202	return $grp->result ($dirs, $entries);
		1203	}
		1204
		1205	# cannot use, so return to our old ways
		1206	# by pretending we only scanned for names.
		1207	$_ = $_->[0] for @$entries;
		1208	}
1118		1209
1119	# stat the dir another time	1210	# stat the dir another time
1120	aioreq_pri $pri;	1211	aioreq_pri $pri;
1121	add $grp aio_stat $wd, sub {	1212	add $grp aio_stat $wd, sub {
1122	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1213	my $hash2 = join ":", (stat _)[0,1,3,7,9];
…		…
1228	So in general, you should only use these calls for things that do	1319	So in general, you should only use these calls for things that do
1229	(filesystem) I/O, not for things that wait for other events (network,	1320	(filesystem) I/O, not for things that wait for other events (network,
1230	other processes), although if you are careful and know what you are doing,	1321	other processes), although if you are careful and know what you are doing,
1231	you still can.	1322	you still can.
1232		1323
1233	The following constants are available (missing ones are, as usual C<0>):	1324	The following constants are available and can be used for normal C<ioctl>
		1325	and C<fcntl> as well (missing ones are, as usual C<0>):
1234		1326
1235	C<F_DUPFD_CLOEXEC>,	1327	C<F_DUPFD_CLOEXEC>,
1236		1328
1237	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,	1329	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1238		1330
1239	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.	1331	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1332
		1333	C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
		1334	C<F_SEAL_WRITE>.
1240		1335
1241	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,	1336	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1242	C<FS_IOC_FIEMAP>.	1337	C<FS_IOC_FIEMAP>.
1243		1338
1244	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,	1339	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
…		…
1252		1347
1253	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,	1348	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1254	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,	1349	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1255	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,	1350	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1256	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,	1351	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
		1352
		1353	C<BLKROSET>, C<BLKROGET>, C<BLKRRPART>, C<BLKGETSIZE>, C<BLKFLSBUF>, C<BLKRASET>,
		1354	C<BLKRAGET>, C<BLKFRASET>, C<BLKFRAGET>, C<BLKSECTSET>, C<BLKSECTGET>, C<BLKSSZGET>,
		1355	C<BLKBSZGET>, C<BLKBSZSET>, C<BLKGETSIZE64>,
		1356
1257		1357
1258	=item aio_sync $callback->($status)	1358	=item aio_sync $callback->($status)
1259		1359
1260	Asynchronously call sync and call the callback when finished.	1360	Asynchronously call sync and call the callback when finished.
1261		1361
…		…
1383	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1483	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1384	aio_mlock $data; # mlock in background	1484	aio_mlock $data; # mlock in background
1385		1485
1386	=item aio_mlockall $flags, $callback->($status)	1486	=item aio_mlockall $flags, $callback->($status)
1387		1487
1388	Calls the C<mlockall> function with the given C<$flags> (a combination of	1488	Calls the C<mlockall> function with the given C<$flags> (a
1389	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1489	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1490	C<IO::AIO::MCL_ONFAULT>).
1390		1491
1391	On systems that do not implement C<mlockall>, this function returns C<-1>	1492	On systems that do not implement C<mlockall>, this function returns C<-1>
1392	and sets errno to C<ENOSYS>.	1493	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1494	by the system result in a return value of C<-1> with errno being set to
		1495	C<EINVAL>.
1393		1496
1394	Note that the corresponding C<munlockall> is synchronous and is	1497	Note that the corresponding C<munlockall> is synchronous and is
1395	documented under L<MISCELLANEOUS FUNCTIONS>.	1498	documented under L<MISCELLANEOUS FUNCTIONS>.
1396		1499
1397	Example: asynchronously lock all current and future pages into memory.	1500	Example: asynchronously lock all current and future pages into memory.
…		…
1591	C<aio_wd> callback, as future requests using the value will fail in the	1694	C<aio_wd> callback, as future requests using the value will fail in the
1592	expected way.	1695	expected way.
1593		1696
1594	=item IO::AIO::CWD	1697	=item IO::AIO::CWD
1595		1698
1596	This is a compiletime constant (object) that represents the process	1699	This is a compile time constant (object) that represents the process
1597	current working directory.	1700	current working directory.
1598		1701
1599	Specifying this object as working directory object for a pathname is as if	1702	Specifying this object as working directory object for a pathname is as if
1600	the pathname would be specified directly, without a directory object. For	1703	the pathname would be specified directly, without a directory object. For
1601	example, these calls are functionally identical:	1704	example, these calls are functionally identical:
…		…
1782	The default value for the limit is C<0>, but note that setting a feeder	1885	The default value for the limit is C<0>, but note that setting a feeder
1783	automatically bumps it up to C<2>.	1886	automatically bumps it up to C<2>.
1784		1887
1785	=back	1888	=back
1786		1889
		1890
1787	=head2 SUPPORT FUNCTIONS	1891	=head2 SUPPORT FUNCTIONS
1788		1892
1789	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1893	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1790		1894
1791	=over 4	1895	=over 4
…		…
1856	Strictly equivalent to:	1960	Strictly equivalent to:
1857		1961
1858	IO::AIO::poll_wait, IO::AIO::poll_cb	1962	IO::AIO::poll_wait, IO::AIO::poll_cb
1859	while IO::AIO::nreqs;	1963	while IO::AIO::nreqs;
1860		1964
		1965	This function can be useful at program aborts, to make sure outstanding
		1966	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1967	this function on normal exits), or when you are merely using C<IO::AIO>
		1968	for its more advanced functions, rather than for async I/O, e.g.:
		1969
		1970	my ($dirs, $nondirs);
		1971	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1972	IO::AIO::flush;
		1973	# $dirs, $nondirs are now set
		1974
1861	=item IO::AIO::max_poll_reqs $nreqs	1975	=item IO::AIO::max_poll_reqs $nreqs
1862		1976
1863	=item IO::AIO::max_poll_time $seconds	1977	=item IO::AIO::max_poll_time $seconds
1864		1978
1865	These set the maximum number of requests (default C<0>, meaning infinity)	1979	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1891	poll => 'r', nice => 1,	2005	poll => 'r', nice => 1,
1892	cb => &IO::AIO::poll_cb);	2006	cb => &IO::AIO::poll_cb);
1893		2007
1894	=back	2008	=back
1895		2009
		2010
1896	=head3 CONTROLLING THE NUMBER OF THREADS	2011	=head3 CONTROLLING THE NUMBER OF THREADS
1897		2012
1898	=over	2013	=over
1899		2014
1900	=item IO::AIO::min_parallel $nthreads	2015	=item IO::AIO::min_parallel $nthreads
…		…
1961	longer exceeded.	2076	longer exceeded.
1962		2077
1963	In other words, this setting does not enforce a queue limit, but can be	2078	In other words, this setting does not enforce a queue limit, but can be
1964	used to make poll functions block if the limit is exceeded.	2079	used to make poll functions block if the limit is exceeded.
1965		2080
1966	This is a very bad function to use in interactive programs because it	2081	This is a bad function to use in interactive programs because it blocks,
1967	blocks, and a bad way to reduce concurrency because it is inexact: Better	2082	and a bad way to reduce concurrency because it is inexact. If you need to
		2083	issue many requests without being able to call a poll function on demand,
1968	use an C<aio_group> together with a feed callback.	2084	it is better to use an C<aio_group> together with a feed callback.
1969		2085
1970	Its main use is in scripts without an event loop - when you want to stat	2086	Its main use is in scripts without an event loop - when you want to stat a
1971	a lot of files, you can write something like this:	2087	lot of files, you can write something like this:
1972		2088
1973	IO::AIO::max_outstanding 32;	2089	IO::AIO::max_outstanding 32;
1974		2090
1975	for my $path (...) {	2091	for my $path (...) {
1976	aio_stat $path , ...;	2092	aio_stat $path , ...;
1977	IO::AIO::poll_cb;	2093	IO::AIO::poll_cb;
1978	}	2094	}
1979		2095
1980	IO::AIO::flush;	2096	IO::AIO::flush;
1981		2097
1982	The call to C<poll_cb> inside the loop will normally return instantly, but	2098	The call to C<poll_cb> inside the loop will normally return instantly,
1983	as soon as more thna C<32> reqeusts are in-flight, it will block until	2099	allowing the loop to progress, but as soon as more than C<32> requests
1984	some requests have been handled. This keeps the loop from pushing a large	2100	are in-flight, it will block until some requests have been handled. This
1985	number of C<aio_stat> requests onto the queue.	2101	keeps the loop from pushing a large number of C<aio_stat> requests onto
		2102	the queue (which, with many paths to stat, can use up a lot of memory).
1986		2103
1987	The default value for C<max_outstanding> is very large, so there is no	2104	The default value for C<max_outstanding> is very large, so there is no
1988	practical limit on the number of outstanding requests.	2105	practical limit on the number of outstanding requests.
1989		2106
1990	=back	2107	=back
1991		2108
		2109
1992	=head3 STATISTICAL INFORMATION	2110	=head3 STATISTICAL INFORMATION
1993		2111
1994	=over	2112	=over
1995		2113
1996	=item IO::AIO::nreqs	2114	=item IO::AIO::nreqs
…		…
2012		2130
2013	Returns the number of requests currently in the pending state (executed,	2131	Returns the number of requests currently in the pending state (executed,
2014	but not yet processed by poll_cb).	2132	but not yet processed by poll_cb).
2015		2133
2016	=back	2134	=back
		2135
2017		2136
2018	=head3 SUBSECOND STAT TIME ACCESS	2137	=head3 SUBSECOND STAT TIME ACCESS
2019		2138
2020	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can	2139	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2021	generally find access/modification and change times with subsecond time	2140	generally find access/modification and change times with subsecond time
…		…
2037	not supported or could not be detected, a fractional part of C<0> is	2156	not supported or could not be detected, a fractional part of C<0> is
2038	returned, so it is always safe to call these functions.	2157	returned, so it is always safe to call these functions.
2039		2158
2040	=over 4	2159	=over 4
2041		2160
2042	=item IO::AIO::stat_atime, IO::AIO::stat_mtime, IO::AIO::stat_ctime	2161	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2043		2162
2044	Return the access, modication or change time, respectively, including	2163	Return the access, modication, change or birth time, respectively,
2045	fractional part. Due to the limited precision of floating point, the	2164	including fractional part. Due to the limited precision of floating point,
2046	accuracy on most platforms is only a bit better than milliseconds for	2165	the accuracy on most platforms is only a bit better than milliseconds
2047	times around now - see the I<nsec> function family, below, for full	2166	for times around now - see the I<nsec> function family, below, for full
2048	accuracy.	2167	accuracy.
2049		2168
		2169	File birth time is only available when the OS and perl support it (on
		2170	FreeBSD and NetBSD at the time of this writing, although support is
		2171	adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
		2172	it). On systems where it isn't available, C<0> is currently returned, but
		2173	this might change to C<undef> in a future version.
		2174
2050	=item ($atime, $mtime, $ctime, ...) = IO::AIO::stat_xtime	2175	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2051		2176
2052	Returns access, modification and change time all in one go, and maybe more	2177	Returns access, modification, change and birth time all in one go, and
2053	times in the future version.	2178	maybe more times in the future version.
2054		2179
2055	=item IO::AIO::stat_atimensec, IO::AIO::stat_mtimensec, IO::AIO::stat_ctimensec	2180	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2056		2181
2057	Return the fractional access, modifcation or change time, in nanoseconds,	2182	Return the fractional access, modifcation, change or birth time, in nanoseconds,
2058	as an integer in the range C<0> to C<999999999>.	2183	as an integer in the range C<0> to C<999999999>.
		2184
		2185	Note that no accessors are provided for access, modification and
		2186	change times - you need to get those from C<stat _> if required (C<int
		2187	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2188	value).
		2189
		2190	=item $seconds = IO::AIO::st_btimesec
		2191
		2192	The (integral) seconds part of the file birth time, if available.
		2193
		2194	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2195
		2196	Like the functions above, but returns all four times in one go (and maybe
		2197	more in future versions).
		2198
		2199	=item $counter = IO::AIO::st_gen
		2200
		2201	Returns the generation counter (in practice this is just a random number)
		2202	of the file. This is only available on platforms which have this member in
		2203	their C<struct stat> (most BSDs at the time of this writing) and generally
		2204	only to the root usert. If unsupported, C<0> is returned, but this might
		2205	change to C<undef> in a future version.
2059		2206
2060	=back	2207	=back
2061		2208
2062	Example: print the high resolution modification time of F</etc>, using	2209	Example: print the high resolution modification time of F</etc>, using
2063	C<stat>, and C<IO::AIO::aio_stat>.	2210	C<stat>, and C<IO::AIO::aio_stat>.
2064		2211
2065	if (stat "/etc") {	2212	if (stat "/etc") {
2066	printf "stat(/etc) mtime: %f\n", IO::AIO::stat_mtime;	2213	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2067	}	2214	}
2068		2215
2069	IO::AIO::aio_stat "/etc", sub {	2216	IO::AIO::aio_stat "/etc", sub {
2070	$_[0]	2217	$_[0]
2071	and return;	2218	and return;
2072		2219
2073	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::stat_mtimensec;	2220	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2074	};	2221	};
2075		2222
2076	IO::AIO::flush;	2223	IO::AIO::flush;
2077		2224
2078	Output of the awbove on my system, showing reduced and full accuracy:	2225	Output of the awbove on my system, showing reduced and full accuracy:
2079		2226
2080	stat(/etc) mtime: 1534043702.020808	2227	stat(/etc) mtime: 1534043702.020808
2081	aio_stat(/etc) mtime: 1534043702.020807792	2228	aio_stat(/etc) mtime: 1534043702.020807792
		2229
2082		2230
2083	=head3 MISCELLANEOUS FUNCTIONS	2231	=head3 MISCELLANEOUS FUNCTIONS
2084		2232
2085	IO::AIO implements some functions that are useful when you want to use	2233	IO::AIO implements some functions that are useful when you want to use
2086	some "Advanced I/O" function not available to in Perl, without going the	2234	some "Advanced I/O" function not available to in Perl, without going the
2087	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>	2235	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2088	counterpart.	2236	counterpart.
2089		2237
2090	=over 4	2238	=over 4
2091		2239
		2240	=item $retval = IO::AIO::fexecve $fh, $argv, $envp
		2241
		2242	A more-or-less direct equivalent to the POSIX C<fexecve> functions, which
		2243	allows you to specify the program to be executed via a file descriptor (or
		2244	handle). Returns C<-1> and sets errno to C<ENOSYS> if not available.
		2245
		2246	=item $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		2247
		2248	Calls the GNU/Linux mount syscall with the given arguments. All except
		2249	C<$flags> are strings, and if C<$data> is C<undef>, a C<NULL> will be
		2250	passed.
		2251
		2252	The following values for C<$flags> are available:
		2253
		2254	C<IO::AIO::MS_RDONLY>, C<IO::AIO::MS_NOSUID>, C<IO::AIO::MS_NODEV>, C<IO::AIO::MS_NOEXEC>, C<IO::AIO::MS_SYNCHRONOUS>,
		2255	C<IO::AIO::MS_REMOUNT>, C<IO::AIO::MS_MANDLOCK>, C<IO::AIO::MS_DIRSYNC>, C<IO::AIO::MS_NOATIME>,
		2256	C<IO::AIO::MS_NODIRATIME>, C<IO::AIO::MS_BIND>, C<IO::AIO::MS_MOVE>, C<IO::AIO::MS_REC>, C<IO::AIO::MS_SILENT>,
		2257	C<IO::AIO::MS_POSIXACL>, C<IO::AIO::MS_UNBINDABLE>, C<IO::AIO::MS_PRIVATE>, C<IO::AIO::MS_SLAVE>, C<IO::AIO::MS_SHARED>,
		2258	C<IO::AIO::MS_RELATIME>, C<IO::AIO::MS_KERNMOUNT>, C<IO::AIO::MS_I_VERSION>, C<IO::AIO::MS_STRICTATIME>,
		2259	C<IO::AIO::MS_LAZYTIME>, C<IO::AIO::MS_ACTIVE>, C<IO::AIO::MS_NOUSER>, C<IO::AIO::MS_RMT_MASK>, C<IO::AIO::MS_MGC_VAL> and
		2260	C<IO::AIO::MS_MGC_MSK>.
		2261
		2262	=item $retval = IO::AIO::umount $path, $flags = 0
		2263
		2264	Invokes the GNU/Linux C<umount> or C<umount2> syscalls. Always calls
		2265	C<umount> if C<$flags> is C<0>, otherwqise always tries to call
		2266	C<umount2>.
		2267
		2268	The following C<$flags> are available:
		2269
		2270	C<IO::AIO::MNT_FORCE>, C<IO::AIO::MNT_DETACH>, C<IO::AIO::MNT_EXPIRE> and C<IO::AIO::UMOUNT_NOFOLLOW>.
		2271
2092	=item $numfd = IO::AIO::get_fdlimit	2272	=item $numfd = IO::AIO::get_fdlimit
2093
2094	This function is I<EXPERIMENTAL> and subject to change.
2095		2273
2096	Tries to find the current file descriptor limit and returns it, or	2274	Tries to find the current file descriptor limit and returns it, or
2097	C<undef> and sets C<$!> in case of an error. The limit is one larger than	2275	C<undef> and sets C<$!> in case of an error. The limit is one larger than
2098	the highest valid file descriptor number.	2276	the highest valid file descriptor number.
2099		2277
2100	=item IO::AIO::min_fdlimit [$numfd]	2278	=item IO::AIO::min_fdlimit [$numfd]
2101
2102	This function is I<EXPERIMENTAL> and subject to change.
2103		2279
2104	Try to increase the current file descriptor limit(s) to at least C<$numfd>	2280	Try to increase the current file descriptor limit(s) to at least C<$numfd>
2105	by changing the soft or hard file descriptor resource limit. If C<$numfd>	2281	by changing the soft or hard file descriptor resource limit. If C<$numfd>
2106	is missing, it will try to set a very high limit, although this is not	2282	is missing, it will try to set a very high limit, although this is not
2107	recommended when you know the actual minimum that you require.	2283	recommended when you know the actual minimum that you require.
…		…
2202	C<IO::AIO::MAP_POPULATE>,	2378	C<IO::AIO::MAP_POPULATE>,
2203	C<IO::AIO::MAP_NONBLOCK>,	2379	C<IO::AIO::MAP_NONBLOCK>,
2204	C<IO::AIO::MAP_FIXED>,	2380	C<IO::AIO::MAP_FIXED>,
2205	C<IO::AIO::MAP_GROWSDOWN>,	2381	C<IO::AIO::MAP_GROWSDOWN>,
2206	C<IO::AIO::MAP_32BIT>,	2382	C<IO::AIO::MAP_32BIT>,
2207	C<IO::AIO::MAP_HUGETLB> or	2383	C<IO::AIO::MAP_HUGETLB>,
2208	C<IO::AIO::MAP_STACK>.	2384	C<IO::AIO::MAP_STACK>,
		2385	C<IO::AIO::MAP_FIXED_NOREPLACE>,
		2386	C<IO::AIO::MAP_SHARED_VALIDATE>,
		2387	C<IO::AIO::MAP_SYNC> or
		2388	C<IO::AIO::MAP_UNINITIALIZED>.
2209		2389
2210	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2390	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
2211		2391
2212	C<$offset> is the offset from the start of the file - it generally must be	2392	C<$offset> is the offset from the start of the file - it generally must be
2213	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2393	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
2250	implemented, but not supported and might go away in a future version.	2430	implemented, but not supported and might go away in a future version.
2251		2431
2252	On systems where this call is not supported or is not emulated, this call	2432	On systems where this call is not supported or is not emulated, this call
2253	returns falls and sets C<$!> to C<ENOSYS>.	2433	returns falls and sets C<$!> to C<ENOSYS>.
2254		2434
		2435	=item IO::AIO::mlockall $flags
		2436
		2437	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2438	but is blocking.
		2439
2255	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2440	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2256		2441
2257	Calls the C<munlock> function, undoing the effects of a previous	2442	Calls the C<munlock> function, undoing the effects of a previous
2258	C<aio_mlock> call (see its description for details).	2443	C<aio_mlock> call (see its description for details).
2259		2444
…		…
2261		2446
2262	Calls the C<munlockall> function.	2447	Calls the C<munlockall> function.
2263		2448
2264	On systems that do not implement C<munlockall>, this function returns	2449	On systems that do not implement C<munlockall>, this function returns
2265	ENOSYS, otherwise the return value of C<munlockall>.	2450	ENOSYS, otherwise the return value of C<munlockall>.
		2451
		2452	=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
		2453
		2454	Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
		2455	and return the new file handle on success, or sets C<$!> and returns
		2456	C<undef> on error.
		2457
		2458	The remote name of the new socket will be stored in C<$sockaddr>, which
		2459	will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
		2460	socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
		2461	by returning a longer string in C<$sockaddr>, which might or might not be
		2462	truncated.
		2463
		2464	To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
		2465	C<$sockaddr_maxlen>.
		2466
		2467	The main reasons to use this syscall rather than portable C<accept(2)>
		2468	are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
		2469	flags and you can accept name-less sockets by specifying C<0> for
		2470	C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
		2471	C<accept>.
2266		2472
2267	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags	2473	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2268		2474
2269	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or	2475	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2270	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they	2476	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
…		…
2314	Example: create a pipe race-free w.r.t. threads and fork:	2520	Example: create a pipe race-free w.r.t. threads and fork:
2315		2521
2316	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC	2522	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2317	or die "pipe2: $!\n";	2523	or die "pipe2: $!\n";
2318		2524
		2525	=item $fh = IO::AIO::memfd_create $pathname[, $flags]
		2526
		2527	This is a direct interface to the Linux L<memfd_create(2)> system
		2528	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2529	should be C<IO::AIO::MFD_CLOEXEC>.
		2530
		2531	On success, the new memfd filehandle is returned, otherwise returns
		2532	C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
		2533
		2534	Please refer to L<memfd_create(2)> for more info on this call.
		2535
		2536	The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
		2537	C<IO::AIO::MFD_ALLOW_SEALING>, C<IO::AIO::MFD_HUGETLB>,
		2538	C<IO::AIO::MFD_HUGETLB_2MB> and C<IO::AIO::MFD_HUGETLB_1GB>.
		2539
		2540	Example: create a new memfd.
		2541
		2542	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		2543	or die "memfd_create: $!\n";
		2544
		2545	=item $fh = IO::AIO::pidfd_open $pid[, $flags]
		2546
		2547	This is an interface to the Linux L<pidfd_open(2)> system call. The
		2548	default for C<$flags> is C<0>.
		2549
		2550	On success, a new pidfd filehandle is returned (that is already set to
		2551	close-on-exec), otherwise returns C<undef>. If the syscall is missing,
		2552	fails with C<ENOSYS>.
		2553
		2554	Example: open pid 6341 as pidfd.
		2555
		2556	my $fh = IO::AIO::pidfd_open 6341
		2557	or die "pidfd_open: $!\n";
		2558
		2559	=item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		2560
		2561	This is an interface to the Linux L<pidfd_send_signal> system call. The
		2562	default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>.
		2563
		2564	Returns the system call status. If the syscall is missing, fails with
		2565	C<ENOSYS>.
		2566
		2567	When specified, C<$siginfo> must be a reference to a hash with one or more
		2568	of the following members:
		2569
		2570	=over
		2571
		2572	=item code - the C<si_code> member
		2573
		2574	=item pid - the C<si_pid> member
		2575
		2576	=item uid - the C<si_uid> member
		2577
		2578	=item value_int - the C<si_value.sival_int> member
		2579
		2580	=item value_ptr - the C<si_value.sival_ptr> member, specified as an integer
		2581
		2582	=back
		2583
		2584	Example: send a SIGKILL to the specified process.
		2585
		2586	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
		2587	and die "pidfd_send_signal: $!\n";
		2588
		2589	Example: send a SIGKILL to the specified process with extra data.
		2590
		2591	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
		2592	and die "pidfd_send_signal: $!\n";
		2593
		2594	=item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		2595
		2596	This is an interface to the Linux L<pidfd_getfd> system call. The default
		2597	for C<$flags> is C<0>.
		2598
		2599	On success, returns a dup'ed copy of the target file descriptor (specified
		2600	as an integer) returned (that is already set to close-on-exec), otherwise
		2601	returns C<undef>. If the syscall is missing, fails with C<ENOSYS>.
		2602
		2603	Example: get a copy of standard error of another process and print soemthing to it.
		2604
		2605	my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
		2606	or die "pidfd_getfd: $!\n";
		2607	print $errfh "stderr\n";
		2608
2319	=item $fh = IO::AIO::eventfd [$initval, [$flags]]	2609	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2320		2610
2321	This is a direct interface to the Linux L<eventfd(2)> system call. The	2611	This is a direct interface to the Linux L<eventfd(2)> system call. The
2322	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.	2612	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2323		2613
…		…
2329	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,	2619	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2330	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).	2620	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2331		2621
2332	Example: create a new eventfd filehandle:	2622	Example: create a new eventfd filehandle:
2333		2623
2334	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC	2624	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2335	or die "eventfd: $!\n";	2625	or die "eventfd: $!\n";
2336		2626
2337	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]	2627	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2338		2628
2339	This is a direct interface to the Linux L<timerfd_create(2)> system call. The	2629	This is a direct interface to the Linux L<timerfd_create(2)> system
2340	(unhelpful) default for C<$flags> is C<0>.	2630	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2631	should be C<IO::AIO::TFD_CLOEXEC>.
2341		2632
2342	On success, the new timerfd filehandle is returned, otherwise returns	2633	On success, the new timerfd filehandle is returned, otherwise returns
2343	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.	2634	C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2344		2635
2345	Please refer to L<timerfd_create(2)> for more info on this call.	2636	Please refer to L<timerfd_create(2)> for more info on this call.
2346		2637
2347	The following C<$clockid> values are	2638	The following C<$clockid> values are
2348	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>	2639	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
…		…
2514	known issue, rather than a bug.	2805	known issue, rather than a bug.
2515		2806
2516	=head1 SEE ALSO	2807	=head1 SEE ALSO
2517		2808
2518	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2809	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2519	more natural syntax.	2810	more natural syntax and L<IO::FDPass> for file descriptor passing.
2520		2811
2521	=head1 AUTHOR	2812	=head1 AUTHOR
2522		2813
2523	Marc Lehmann <schmorp@schmorp.de>	2814	Marc Lehmann <schmorp@schmorp.de>
2524	http://home.schmorp.de/	2815	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.289 by root, Sun Aug 12 05:21:35 2018 UTC vs. Revision 1.318 by root, Sat Apr 1 02:14:05 2023 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.289 by root, Sun Aug 12 05:21:35 2018 UTC vs.
Revision 1.318 by root, Sat Apr 1 02:14:05 2023 UTC