[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.300 by root, Sun Mar 10 12:11:46 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.71;
177		177
178	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close	178	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
179	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx	179	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl	180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range	181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
…		…
192	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	192	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
193	min_parallel max_parallel max_idle idle_timeout	193	min_parallel max_parallel max_idle idle_timeout
194	nreqs nready npending nthreads	194	nreqs nready npending nthreads
195	max_poll_time max_poll_reqs	195	max_poll_time max_poll_reqs
196	sendfile fadvise madvise	196	sendfile fadvise madvise
197	mmap munmap munlock munlockall);	197	mmap munmap mremap munlock munlockall);
198		198
199	push @AIO_REQ, qw(aio_busy); # not exported	199	push @AIO_REQ, qw(aio_busy); # not exported
200		200
201	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	201	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
202		202
…		…
285		285
286	IO::AIO::sendfile $ofh, $ifh, $offset, $count	286	IO::AIO::sendfile $ofh, $ifh, $offset, $count
287	IO::AIO::fadvise $fh, $offset, $len, $advice	287	IO::AIO::fadvise $fh, $offset, $len, $advice
288	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	288	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289	IO::AIO::munmap $scalar	289	IO::AIO::munmap $scalar
		290	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
290	IO::AIO::madvise $scalar, $offset, $length, $advice	291	IO::AIO::madvise $scalar, $offset, $length, $advice
291	IO::AIO::mprotect $scalar, $offset, $length, $protect	292	IO::AIO::mprotect $scalar, $offset, $length, $protect
292	IO::AIO::munlock $scalar, $offset = 0, $length = undef	293	IO::AIO::munlock $scalar, $offset = 0, $length = undef
293	IO::AIO::munlockall	294	IO::AIO::munlockall
294		295
…		…
404	following POSIX and non-POSIX constants are available (missing ones on	405	following POSIX and non-POSIX constants are available (missing ones on
405	your system are, as usual, C<0>):	406	your system are, as usual, C<0>):
406		407
407	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	408	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
408	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	409	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
409	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.	410	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
410		411
411		412
412	=item aio_close $fh, $callback->($status)	413	=item aio_close $fh, $callback->($status)
413		414
414	Asynchronously close a file and call the callback with the result	415	Asynchronously close a file and call the callback with the result
…		…
540		541
541	=item aio_stat $fh_or_path, $callback->($status)	542	=item aio_stat $fh_or_path, $callback->($status)
542		543
543	=item aio_lstat $fh, $callback->($status)	544	=item aio_lstat $fh, $callback->($status)
544		545
545	Works like perl's C<stat> or C<lstat> in void context. The callback will	546	Works almost exactly like perl's C<stat> or C<lstat> in void context. The
546	be called after the stat and the results will be available using C<stat _>	547	callback will be called after the stat and the results will be available
547	or C<-s _> etc...	548	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
		549	and C<-T>).
548		550
549	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,	551	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
550	for an explanation.	552	for an explanation.
551		553
552	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	554	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
…		…
559	behaviour).	561	behaviour).
560		562
561	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	563	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
562	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,	564	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
563	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.	565	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		566
		567	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		568	ACCESS>.
564		569
565	Example: Print the length of F</etc/passwd>:	570	Example: Print the length of F</etc/passwd>:
566		571
567	aio_stat "/etc/passwd", sub {	572	aio_stat "/etc/passwd", sub {
568	$_[0] and die "stat failed: $!";	573	$_[0] and die "stat failed: $!";
…		…
618		623
619	Works like perl's C<utime> function (including the special case of $atime	624	Works like perl's C<utime> function (including the special case of $atime
620	and $mtime being undef). Fractional times are supported if the underlying	625	and $mtime being undef). Fractional times are supported if the underlying
621	syscalls support them.	626	syscalls support them.
622		627
623	When called with a pathname, uses utimes(2) if available, otherwise	628	When called with a pathname, uses utimensat(2) or utimes(2) if available,
624	utime(2). If called on a file descriptor, uses futimes(2) if available,	629	otherwise utime(2). If called on a file descriptor, uses futimens(2)
625	otherwise returns ENOSYS, so this is not portable.	630	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		631	portable.
626		632
627	Examples:	633	Examples:
628		634
629	# set atime and mtime to current time (basically touch(1)):	635	# set atime and mtime to current time (basically touch(1)):
630	aio_utime "path", undef, undef;	636	aio_utime "path", undef, undef;
…		…
1103	aioreq_pri $pri;	1109	aioreq_pri $pri;
1104	add $grp aio_stat $wd, sub {	1110	add $grp aio_stat $wd, sub {
1105	return $grp->result () if $_[0];	1111	return $grp->result () if $_[0];
1106	my $now = time;	1112	my $now = time;
1107	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1113	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1114	my $rdxflags = READDIR_DIRS_FIRST;
		1115
		1116	if ((stat _)[3] < 2) {
		1117	# at least one non-POSIX filesystem exists
		1118	# that returns useful DT_type values: btrfs,
		1119	# so optimise for this here by requesting dents
		1120	$rdxflags \|= READDIR_DENTS;
		1121	}
1108		1122
1109	# read the directory entries	1123	# read the directory entries
1110	aioreq_pri $pri;	1124	aioreq_pri $pri;
1111	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {	1125	add $grp aio_readdirx $wd, $rdxflags, sub {
1112	my $entries = shift	1126	my ($entries, $flags) = @_
1113	or return $grp->result ();	1127	or return $grp->result ();
		1128
		1129	if ($rdxflags & READDIR_DENTS) {
		1130	# if we requested type values, see if we can use them directly.
		1131
		1132	# if there were any DT_UNKNOWN entries then we assume we
		1133	# don't know. alternatively, we could assume that if we get
		1134	# one DT_DIR, then all directories are indeed marked with
		1135	# DT_DIR, but this seems not required for btrfs, and this
		1136	# is basically the "btrfs can't get it's act together" code
		1137	# branch.
		1138	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1139	# now we have valid DT_ information for all entries,
		1140	# so use it as an optimisation without further stat's.
		1141	# they must also all be at the beginning of @$entries
		1142	# by now.
		1143
		1144	my $dirs;
		1145
		1146	if (@$entries) {
		1147	for (0 .. $#$entries) {
		1148	if ($entries->[$_][1] != DT_DIR) {
		1149	# splice out directories
		1150	$dirs = [splice @$entries, 0, $_];
		1151	last;
		1152	}
		1153	}
		1154
		1155	# if we didn't find any non-dir, then all entries are dirs
		1156	unless ($dirs) {
		1157	($dirs, $entries) = ($entries, []);
		1158	}
		1159	} else {
		1160	# directory is empty, so there are no sbdirs
		1161	$dirs = [];
		1162	}
		1163
		1164	# either splice'd the directories out or the dir was empty.
		1165	# convert dents to filenames
		1166	$_ = $_->[0] for @$dirs;
		1167	$_ = $_->[0] for @$entries;
		1168
		1169	return $grp->result ($dirs, $entries);
		1170	}
		1171
		1172	# cannot use, so return to our old ways
		1173	# by pretending we only scanned for names.
		1174	$_ = $_->[0] for @$entries;
		1175	}
1114		1176
1115	# stat the dir another time	1177	# stat the dir another time
1116	aioreq_pri $pri;	1178	aioreq_pri $pri;
1117	add $grp aio_stat $wd, sub {	1179	add $grp aio_stat $wd, sub {
1118	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1180	my $hash2 = join ":", (stat _)[0,1,3,7,9];
…		…
1379	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1441	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1380	aio_mlock $data; # mlock in background	1442	aio_mlock $data; # mlock in background
1381		1443
1382	=item aio_mlockall $flags, $callback->($status)	1444	=item aio_mlockall $flags, $callback->($status)
1383		1445
1384	Calls the C<mlockall> function with the given C<$flags> (a combination of	1446	Calls the C<mlockall> function with the given C<$flags> (a
1385	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1447	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1448	C<IO::AIO::MCL_ONFAULT>).
1386		1449
1387	On systems that do not implement C<mlockall>, this function returns C<-1>	1450	On systems that do not implement C<mlockall>, this function returns C<-1>
1388	and sets errno to C<ENOSYS>.	1451	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1452	by the system result in a return value of C<-1> with errno being set to
		1453	C<EINVAL>.
1389		1454
1390	Note that the corresponding C<munlockall> is synchronous and is	1455	Note that the corresponding C<munlockall> is synchronous and is
1391	documented under L<MISCELLANEOUS FUNCTIONS>.	1456	documented under L<MISCELLANEOUS FUNCTIONS>.
1392		1457
1393	Example: asynchronously lock all current and future pages into memory.	1458	Example: asynchronously lock all current and future pages into memory.
…		…
1778	The default value for the limit is C<0>, but note that setting a feeder	1843	The default value for the limit is C<0>, but note that setting a feeder
1779	automatically bumps it up to C<2>.	1844	automatically bumps it up to C<2>.
1780		1845
1781	=back	1846	=back
1782		1847
		1848
1783	=head2 SUPPORT FUNCTIONS	1849	=head2 SUPPORT FUNCTIONS
1784		1850
1785	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1851	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1786		1852
1787	=over 4	1853	=over 4
…		…
1852	Strictly equivalent to:	1918	Strictly equivalent to:
1853		1919
1854	IO::AIO::poll_wait, IO::AIO::poll_cb	1920	IO::AIO::poll_wait, IO::AIO::poll_cb
1855	while IO::AIO::nreqs;	1921	while IO::AIO::nreqs;
1856		1922
		1923	This function can be useful at program aborts, to make sure outstanding
		1924	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1925	this function on normal exits), or when you are merely using C<IO::AIO>
		1926	for its more advanced functions, rather than for async I/O, e.g.:
		1927
		1928	my ($dirs, $nondirs);
		1929	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1930	IO::AIO::flush;
		1931	# $dirs, $nondirs are now set
		1932
1857	=item IO::AIO::max_poll_reqs $nreqs	1933	=item IO::AIO::max_poll_reqs $nreqs
1858		1934
1859	=item IO::AIO::max_poll_time $seconds	1935	=item IO::AIO::max_poll_time $seconds
1860		1936
1861	These set the maximum number of requests (default C<0>, meaning infinity)	1937	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1887	poll => 'r', nice => 1,	1963	poll => 'r', nice => 1,
1888	cb => &IO::AIO::poll_cb);	1964	cb => &IO::AIO::poll_cb);
1889		1965
1890	=back	1966	=back
1891		1967
		1968
1892	=head3 CONTROLLING THE NUMBER OF THREADS	1969	=head3 CONTROLLING THE NUMBER OF THREADS
1893		1970
1894	=over	1971	=over
1895		1972
1896	=item IO::AIO::min_parallel $nthreads	1973	=item IO::AIO::min_parallel $nthreads
…		…
1983	The default value for C<max_outstanding> is very large, so there is no	2060	The default value for C<max_outstanding> is very large, so there is no
1984	practical limit on the number of outstanding requests.	2061	practical limit on the number of outstanding requests.
1985		2062
1986	=back	2063	=back
1987		2064
		2065
1988	=head3 STATISTICAL INFORMATION	2066	=head3 STATISTICAL INFORMATION
1989		2067
1990	=over	2068	=over
1991		2069
1992	=item IO::AIO::nreqs	2070	=item IO::AIO::nreqs
…		…
2008		2086
2009	Returns the number of requests currently in the pending state (executed,	2087	Returns the number of requests currently in the pending state (executed,
2010	but not yet processed by poll_cb).	2088	but not yet processed by poll_cb).
2011		2089
2012	=back	2090	=back
		2091
		2092
		2093	=head3 SUBSECOND STAT TIME ACCESS
		2094
		2095	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2096	generally find access/modification and change times with subsecond time
		2097	accuracy of the system supports it, but perl's built-in functions only
		2098	return the integer part.
		2099
		2100	The following functions return the timestamps of the most recent
		2101	stat with subsecond precision on most systems and work both after
		2102	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2103	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2104	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2105
		2106	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2107	full resolution without rounding and work with standard perl C<stat>,
		2108	alleviating the need to call the special C<Time::HiRes> functions, which
		2109	do not act like their perl counterparts.
		2110
		2111	On operating systems or file systems where subsecond time resolution is
		2112	not supported or could not be detected, a fractional part of C<0> is
		2113	returned, so it is always safe to call these functions.
		2114
		2115	=over 4
		2116
		2117	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2118
		2119	Return the access, modication, change or birth time, respectively,
		2120	including fractional part. Due to the limited precision of floating point,
		2121	the accuracy on most platforms is only a bit better than milliseconds
		2122	for times around now - see the I<nsec> function family, below, for full
		2123	accuracy.
		2124
		2125	File birth time is only available when the OS and perl support it (on
		2126	FreeBSD and NetBSD at the time of this writing, although support is
		2127	adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of
		2128	it). On systems where it isn't available, C<0> is currently returned, but
		2129	this might change to C<undef> in a future version.
		2130
		2131	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2132
		2133	Returns access, modification, change and birth time all in one go, and
		2134	maybe more times in the future version.
		2135
		2136	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2137
		2138	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2139	as an integer in the range C<0> to C<999999999>.
		2140
		2141	Note that no accessors are provided for access, modification and
		2142	change times - you need to get those from C<stat _> if required (C<int
		2143	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2144	value).
		2145
		2146	=item $seconds = IO::AIO::st_btimesec
		2147
		2148	The (integral) seconds part of the file birth time, if available.
		2149
		2150	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2151
		2152	Like the functions above, but returns all four times in one go (and maybe
		2153	more in future versions).
		2154
		2155	=item $counter = IO::AIO::st_gen
		2156
		2157	Returns the generation counter (in practice this is just a random number)
		2158	of the file. This is only available on platforms which have this member in
		2159	their C<struct stat> (most BSDs at the time of this writing) and generally
		2160	only to the root usert. If unsupported, C<0> is returned, but this might
		2161	change to C<undef> in a future version.
		2162
		2163	=back
		2164
		2165	Example: print the high resolution modification time of F</etc>, using
		2166	C<stat>, and C<IO::AIO::aio_stat>.
		2167
		2168	if (stat "/etc") {
		2169	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2170	}
		2171
		2172	IO::AIO::aio_stat "/etc", sub {
		2173	$_[0]
		2174	and return;
		2175
		2176	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2177	};
		2178
		2179	IO::AIO::flush;
		2180
		2181	Output of the awbove on my system, showing reduced and full accuracy:
		2182
		2183	stat(/etc) mtime: 1534043702.020808
		2184	aio_stat(/etc) mtime: 1534043702.020807792
		2185
2013		2186
2014	=head3 MISCELLANEOUS FUNCTIONS	2187	=head3 MISCELLANEOUS FUNCTIONS
2015		2188
2016	IO::AIO implements some functions that are useful when you want to use	2189	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	2190	some "Advanced I/O" function not available to in Perl, without going the
…		…
2158		2331
2159	=item IO::AIO::munmap $scalar	2332	=item IO::AIO::munmap $scalar
2160		2333
2161	Removes a previous mmap and undefines the C<$scalar>.	2334	Removes a previous mmap and undefines the C<$scalar>.
2162		2335
		2336	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2337
		2338	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2339	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2340	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2341
		2342	Returns true if successful, and false otherwise. If the underlying mmapped
		2343	region has changed address, then the true value has the numerical value
		2344	C<1>, otherwise it has the numerical value C<0>:
		2345
		2346	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2347	or die "mremap: $!";
		2348
		2349	if ($success*1) {
		2350	warn "scalar has chanegd address in memory\n";
		2351	}
		2352
		2353	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2354	implemented, but not supported and might go away in a future version.
		2355
		2356	On systems where this call is not supported or is not emulated, this call
		2357	returns falls and sets C<$!> to C<ENOSYS>.
		2358
		2359	=item IO::AIO::mlockall $flags
		2360
		2361	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2362	but is blocking.
		2363
2163	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2364	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2164		2365
2165	Calls the C<munlock> function, undoing the effects of a previous	2366	Calls the C<munlock> function, undoing the effects of a previous
2166	C<aio_mlock> call (see its description for details).	2367	C<aio_mlock> call (see its description for details).
2167		2368

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.300 by root, Sun Mar 10 12:11:46 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.300 by root, Sun Mar 10 12:11:46 2019 UTC