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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.280 by root, Mon Feb 19 13:37:13 2018 UTC vs.
Revision 1.293 by root, Tue Aug 14 14:03:14 2018 UTC

…		…
171	use common::sense;	171	use common::sense;
172		172
173	use base 'Exporter';	173	use base 'Exporter';
174		174
175	BEGIN {	175	BEGIN {
176	our $VERSION = 4.4;	176	our $VERSION = 4.54;
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
…		…
559	behaviour).	560	behaviour).
560		561
561	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	562	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>,	563	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>.	564	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		565
		566	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		567	ACCESS>.
564		568
565	Example: Print the length of F</etc/passwd>:	569	Example: Print the length of F</etc/passwd>:
566		570
567	aio_stat "/etc/passwd", sub {	571	aio_stat "/etc/passwd", sub {
568	$_[0] and die "stat failed: $!";	572	$_[0] and die "stat failed: $!";
…		…
789		793
790	=over 4	794	=over 4
791		795
792	=item IO::AIO::READDIR_DENTS	796	=item IO::AIO::READDIR_DENTS
793		797
794	When this flag is off, then the callback gets an arrayref consisting of	798	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	799	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	800	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
797	entry in more detail.	801	single directory entry in more detail:
798		802
799	C<$name> is the name of the entry.	803	C<$name> is the name of the entry.
800		804
801	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	805	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
802		806
803	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	807	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>,	808	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>.	809	C<IO::AIO::DT_WHT>.
806		810
807	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	811	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>	812	to know, you have to run stat yourself. Also, for speed/memory reasons,
809	scalars are read-only: you can not modify them.	813	the C<$type> scalars are read-only: you must not modify them.
810		814
811	C<$inode> is the inode number (which might not be exact on systems with 64	815	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	816	bit inode numbers and 32 bit perls). This field has unspecified content on
813	systems that do not deliver the inode information.	817	systems that do not deliver the inode information.
814		818
…		…
825	short names are tried first.	829	short names are tried first.
826		830
827	=item IO::AIO::READDIR_STAT_ORDER	831	=item IO::AIO::READDIR_STAT_ORDER
828		832
829	When this flag is set, then the names will be returned in an order	833	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()	834	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	835	all files in the given directory, then the returned order will likely be
832	be fastest.	836	faster.
833		837
834	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	838	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.	839	then the likely dirs come first, resulting in a less optimal stat order
		840	for stat'ing all entries, but likely a more optimal order for finding
		841	subdirectories.
836		842
837	=item IO::AIO::READDIR_FOUND_UNKNOWN	843	=item IO::AIO::READDIR_FOUND_UNKNOWN
838		844
839	This flag should not be set when calling C<aio_readdirx>. Instead, it	845	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	846	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
2007	Returns the number of requests currently in the pending state (executed,	2013	Returns the number of requests currently in the pending state (executed,
2008	but not yet processed by poll_cb).	2014	but not yet processed by poll_cb).
2009		2015
2010	=back	2016	=back
2011		2017
		2018	=head3 SUBSECOND STAT TIME ACCESS
		2019
		2020	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
		2022	accuracy of the system supports it, but perl's built-in functions only
		2023	return the integer part.
		2024
		2025	The following functions return the timestamps of the most recent
		2026	stat with subsecond precision on most systems and work both after
		2027	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2028	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2029	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2030
		2031	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2032	full resolution without rounding and work with standard perl C<stat>,
		2033	alleviating the need to call the special C<Time::HiRes> functions, which
		2034	do not act like their perl counterparts.
		2035
		2036	On operating systems or file systems where subsecond time resolution is
		2037	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.
		2039
		2040	=over 4
		2041
		2042	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime
		2043
		2044	Return the access, modication or change time, respectively, including
		2045	fractional part. Due to the limited precision of floating point, the
		2046	accuracy on most platforms is only a bit better than milliseconds for
		2047	times around now - see the I<nsec> function family, below, for full
		2048	accuracy.
		2049
		2050	=item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime
		2051
		2052	Returns access, modification and change time all in one go, and maybe more
		2053	times in the future version.
		2054
		2055	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec
		2056
		2057	Return the fractional access, modifcation or change time, in nanoseconds,
		2058	as an integer in the range C<0> to C<999999999>.
		2059
		2060	=item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec
		2061
		2062	Like the functions above, but returns all three times in one go (and maybe
		2063	more in future versions).
		2064
		2065	=back
		2066
		2067	Example: print the high resolution modification time of F</etc>, using
		2068	C<stat>, and C<IO::AIO::aio_stat>.
		2069
		2070	if (stat "/etc") {
		2071	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2072	}
		2073
		2074	IO::AIO::aio_stat "/etc", sub {
		2075	$_[0]
		2076	and return;
		2077
		2078	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2079	};
		2080
		2081	IO::AIO::flush;
		2082
		2083	Output of the awbove on my system, showing reduced and full accuracy:
		2084
		2085	stat(/etc) mtime: 1534043702.020808
		2086	aio_stat(/etc) mtime: 1534043702.020807792
		2087
2012	=head3 MISCELLANEOUS FUNCTIONS	2088	=head3 MISCELLANEOUS FUNCTIONS
2013		2089
2014	IO::AIO implements some functions that are useful when you want to use	2090	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	2091	some "Advanced I/O" function not available to in Perl, without going the
2016	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>	2092	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
…		…
2156		2232
2157	=item IO::AIO::munmap $scalar	2233	=item IO::AIO::munmap $scalar
2158		2234
2159	Removes a previous mmap and undefines the C<$scalar>.	2235	Removes a previous mmap and undefines the C<$scalar>.
2160		2236
		2237	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2238
		2239	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2240	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2241	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2242
		2243	Returns true if successful, and false otherwise. If the underlying mmapped
		2244	region has changed address, then the true value has the numerical value
		2245	C<1>, otherwise it has the numerical value C<0>:
		2246
		2247	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2248	or die "mremap: $!";
		2249
		2250	if ($success*1) {
		2251	warn "scalar has chanegd address in memory\n";
		2252	}
		2253
		2254	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2255	implemented, but not supported and might go away in a future version.
		2256
		2257	On systems where this call is not supported or is not emulated, this call
		2258	returns falls and sets C<$!> to C<ENOSYS>.
		2259
2161	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2260	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2162		2261
2163	Calls the C<munlock> function, undoing the effects of a previous	2262	Calls the C<munlock> function, undoing the effects of a previous
2164	C<aio_mlock> call (see its description for details).	2263	C<aio_mlock> call (see its description for details).
2165		2264
…		…
2214	C<$flags> is non-zero, fails with C<ENOSYS>.	2313	C<$flags> is non-zero, fails with C<ENOSYS>.
2215		2314
2216	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the	2315	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2217	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and	2316	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2218	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.	2317	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2318
		2319	Example: create a pipe race-free w.r.t. threads and fork:
		2320
		2321	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
		2322	or die "pipe2: $!\n";
		2323
		2324	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
		2325
		2326	This is a direct interface to the Linux L<eventfd(2)> system call. The
		2327	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
		2328
		2329	On success, the new eventfd filehandle is returned, otherwise returns
		2330	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2331
		2332	Please refer to L<eventfd(2)> for more info on this call.
		2333
		2334	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
		2335	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2336
		2337	Example: create a new eventfd filehandle:
		2338
		2339	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
		2340	or die "eventfd: $!\n";
		2341
		2342	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2343
		2344	This is a direct interface to the Linux L<timerfd_create(2)> system call. The
		2345	(unhelpful) default for C<$flags> is C<0>.
		2346
		2347	On success, the new timerfd filehandle is returned, otherwise returns
		2348	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2349
		2350	Please refer to L<timerfd_create(2)> for more info on this call.
		2351
		2352	The following C<$clockid> values are
		2353	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2354	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2355	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2356	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2357
		2358	The following C<$flags> values are available (Linux
		2359	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2360
		2361	Example: create a new timerfd and set it to one-second repeated alarms,
		2362	then wait for two alarms:
		2363
		2364	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2365	or die "timerfd_create: $!\n";
		2366
		2367	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2368	or die "timerfd_settime: $!\n";
		2369
		2370	for (1..2) {
		2371	8 == sysread $fh, my $buf, 8
		2372	or die "timerfd read failure\n";
		2373
		2374	printf "number of expirations (likely 1): %d\n",
		2375	unpack "Q", $buf;
		2376	}
		2377
		2378	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2379
		2380	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2381	call. Please refer to its manpage for more info on this call.
		2382
		2383	The new itimerspec is specified using two (possibly fractional) second
		2384	values, C<$new_interval> and C<$new_value>).
		2385
		2386	On success, the current interval and value are returned (as per
		2387	C<timerfd_gettime>). On failure, the empty list is returned.
		2388
		2389	The following C<$flags> values are
		2390	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2391	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2392
		2393	See C<IO::AIO::timerfd_create> for a full example.
		2394
		2395	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2396
		2397	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2398	call. Please refer to its manpage for more info on this call.
		2399
		2400	On success, returns the current values of interval and value for the given
		2401	timerfd (as potentially fractional second values). On failure, the empty
		2402	list is returned.
2219		2403
2220	=back	2404	=back
2221		2405
2222	=cut	2406	=cut
2223		2407
…		…
2289	the process will result in undefined behaviour. Calling it at any time	2473	the process will result in undefined behaviour. Calling it at any time
2290	will also result in any undefined (by POSIX) behaviour.	2474	will also result in any undefined (by POSIX) behaviour.
2291		2475
2292	=back	2476	=back
2293		2477
		2478	=head2 LINUX-SPECIFIC CALLS
		2479
		2480	When a call is documented as "linux-specific" then this means it
		2481	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2482	availability and compatibility of such calls regardless of the platform
		2483	it is compiled on, so platforms such as FreeBSD which often implement
		2484	these calls will work. When in doubt, call them and see if they fail wth
		2485	C<ENOSYS>.
		2486
2294	=head2 MEMORY USAGE	2487	=head2 MEMORY USAGE
2295		2488
2296	Per-request usage:	2489	Per-request usage:
2297		2490
2298	Each aio request uses - depending on your architecture - around 100-200	2491	Each aio request uses - depending on your architecture - around 100-200
…		…
2310	temporary buffers, and each thread requires a stack and other data	2503	temporary buffers, and each thread requires a stack and other data
2311	structures (usually around 16k-128k, depending on the OS).	2504	structures (usually around 16k-128k, depending on the OS).
2312		2505
2313	=head1 KNOWN BUGS	2506	=head1 KNOWN BUGS
2314		2507
2315	Known bugs will be fixed in the next release.	2508	Known bugs will be fixed in the next release :)
		2509
		2510	=head1 KNOWN ISSUES
		2511
		2512	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2513	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2514	non-created hash slots or other scalars I didn't think of. It's best to
		2515	avoid such and either use scalar variables or making sure that the scalar
		2516	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2517
		2518	I am not sure anything can be done about this, so this is considered a
		2519	known issue, rather than a bug.
2316		2520
2317	=head1 SEE ALSO	2521	=head1 SEE ALSO
2318		2522
2319	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2523	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2320	more natural syntax.	2524	more natural syntax.

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.280 by root, Mon Feb 19 13:37:13 2018 UTC vs. Revision 1.293 by root, Tue Aug 14 14:03:14 2018 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.280 by root, Mon Feb 19 13:37:13 2018 UTC vs.
Revision 1.293 by root, Tue Aug 14 14:03:14 2018 UTC