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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.221 by root, Mon Apr 2 03:54:46 2012 UTC vs.
Revision 1.296 by root, Sun Aug 26 03:17:35 2018 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	IO::AIO - Asynchronous Input/Output	3	IO::AIO - Asynchronous/Advanced Input/Output
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
58	not well-supported or restricted (GNU/Linux doesn't allow them on normal	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
59	files currently, for example), and they would only support aio_read and	59	files currently, for example), and they would only support aio_read and
60	aio_write, so the remaining functionality would have to be implemented	60	aio_write, so the remaining functionality would have to be implemented
61	using threads anyway.	61	using threads anyway.
62		62
		63	In addition to asynchronous I/O, this module also exports some rather
		64	arcane interfaces, such as C<madvise> or linux's C<splice> system call,
		65	which is why the C<A> in C<AIO> can also mean I<advanced>.
		66
63	Although the module will work in the presence of other (Perl-) threads,	67	Although the module will work in the presence of other (Perl-) threads,
64	it is currently not reentrant in any way, so use appropriate locking	68	it is currently not reentrant in any way, so use appropriate locking
65	yourself, always call C<poll_cb> from within the same thread, or never	69	yourself, always call C<poll_cb> from within the same thread, or never
66	call C<poll_cb> (or other C<aio_> functions) recursively.	70	call C<poll_cb> (or other C<aio_> functions) recursively.
67		71
68	=head2 EXAMPLE	72	=head2 EXAMPLE
69		73
70	This is a simple example that uses the EV module and loads	74	This is a simple example that uses the EV module and loads
71	F</etc/passwd> asynchronously:	75	F</etc/passwd> asynchronously:
72		76
73	use Fcntl;
74	use EV;	77	use EV;
75	use IO::AIO;	78	use IO::AIO;
76		79
77	# register the IO::AIO callback with EV	80	# register the IO::AIO callback with EV
78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	81	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
95		98
96	# file contents now in $contents	99	# file contents now in $contents
97	print $contents;	100	print $contents;
98		101
99	# exit event loop and program	102	# exit event loop and program
100	EV::unloop;	103	EV::break;
101	};	104	};
102	};	105	};
103		106
104	# possibly queue up other requests, or open GUI windows,	107	# possibly queue up other requests, or open GUI windows,
105	# check for sockets etc. etc.	108	# check for sockets etc. etc.
106		109
107	# process events as long as there are some:	110	# process events as long as there are some:
108	EV::loop;	111	EV::run;
109		112
110	=head1 REQUEST ANATOMY AND LIFETIME	113	=head1 REQUEST ANATOMY AND LIFETIME
111		114
112	Every C<aio_*> function creates a request. which is a C data structure not	115	Every C<aio_*> function creates a request. which is a C data structure not
113	directly visible to Perl.	116	directly visible to Perl.
…		…
168	use common::sense;	171	use common::sense;
169		172
170	use base 'Exporter';	173	use base 'Exporter';
171		174
172	BEGIN {	175	BEGIN {
173	our $VERSION = '4.13';	176	our $VERSION = 4.6;
174		177
175	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
176	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
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate	181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179	aio_pathsync aio_readahead	182	aio_pathsync aio_readahead aio_fiemap aio_allocate
180	aio_rename aio_link aio_move aio_copy aio_group	183	aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	184	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182	aio_chmod aio_utime aio_truncate	185	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	186	aio_msync aio_mtouch aio_mlock aio_mlockall
184	aio_statvfs	187	aio_statvfs
		188	aio_slurp
185	aio_wd);	189	aio_wd);
186		190
187	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	191	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
188	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	192	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
189	min_parallel max_parallel max_idle idle_timeout	193	min_parallel max_parallel max_idle idle_timeout
190	nreqs nready npending nthreads	194	nreqs nready npending nthreads
191	max_poll_time max_poll_reqs	195	max_poll_time max_poll_reqs
192	sendfile fadvise madvise	196	sendfile fadvise madvise
193	mmap munmap munlock munlockall);	197	mmap munmap mremap munlock munlockall);
194		198
195	push @AIO_REQ, qw(aio_busy); # not exported	199	push @AIO_REQ, qw(aio_busy); # not exported
196		200
197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	201	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
198		202
…		…
202		206
203	=head1 FUNCTIONS	207	=head1 FUNCTIONS
204		208
205	=head2 QUICK OVERVIEW	209	=head2 QUICK OVERVIEW
206		210
207	This section simply lists the prototypes of the most important functions	211	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	212	quick reference. See the following sections for function-by-function
209	documentation.	213	documentation.
210		214
211	aio_wd $pathname, $callback->($wd)	215	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	216	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	217	aio_close $fh, $callback->($status)
…		…
221	aio_statvfs $fh_or_path, $callback->($statvfs)	225	aio_statvfs $fh_or_path, $callback->($statvfs)
222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	226	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	227	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	228	aio_chmod $fh_or_path, $mode, $callback->($status)
225	aio_truncate $fh_or_path, $offset, $callback->($status)	229	aio_truncate $fh_or_path, $offset, $callback->($status)
		230	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		231	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226	aio_unlink $pathname, $callback->($status)	232	aio_unlink $pathname, $callback->($status)
227	aio_mknod $pathname, $mode, $dev, $callback->($status)	233	aio_mknod $pathname, $mode, $dev, $callback->($status)
228	aio_link $srcpath, $dstpath, $callback->($status)	234	aio_link $srcpath, $dstpath, $callback->($status)
229	aio_symlink $srcpath, $dstpath, $callback->($status)	235	aio_symlink $srcpath, $dstpath, $callback->($status)
230	aio_readlink $pathname, $callback->($link)	236	aio_readlink $pathname, $callback->($link)
231	aio_realpath $pathname, $callback->($link)	237	aio_realpath $pathname, $callback->($path)
232	aio_rename $srcpath, $dstpath, $callback->($status)	238	aio_rename $srcpath, $dstpath, $callback->($status)
		239	aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
233	aio_mkdir $pathname, $mode, $callback->($status)	240	aio_mkdir $pathname, $mode, $callback->($status)
234	aio_rmdir $pathname, $callback->($status)	241	aio_rmdir $pathname, $callback->($status)
235	aio_readdir $pathname, $callback->($entries)	242	aio_readdir $pathname, $callback->($entries)
236	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	243	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
237	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	244	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
…		…
239	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)	246	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
240	aio_load $pathname, $data, $callback->($status)	247	aio_load $pathname, $data, $callback->($status)
241	aio_copy $srcpath, $dstpath, $callback->($status)	248	aio_copy $srcpath, $dstpath, $callback->($status)
242	aio_move $srcpath, $dstpath, $callback->($status)	249	aio_move $srcpath, $dstpath, $callback->($status)
243	aio_rmtree $pathname, $callback->($status)	250	aio_rmtree $pathname, $callback->($status)
		251	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		252	aio_ioctl $fh, $request, $buf, $callback->($status)
244	aio_sync $callback->($status)	253	aio_sync $callback->($status)
245	aio_syncfs $fh, $callback->($status)	254	aio_syncfs $fh, $callback->($status)
246	aio_fsync $fh, $callback->($status)	255	aio_fsync $fh, $callback->($status)
247	aio_fdatasync $fh, $callback->($status)	256	aio_fdatasync $fh, $callback->($status)
248	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	257	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
249	aio_pathsync $pathname, $callback->($status)	258	aio_pathsync $pathname, $callback->($status)
250	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	259	aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
251	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	260	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
252	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	261	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
253	aio_mlockall $flags, $callback->($status)	262	aio_mlockall $flags, $callback->($status)
254	aio_group $callback->(...)	263	aio_group $callback->(...)
255	aio_nop $callback->()	264	aio_nop $callback->()
…		…
269	IO::AIO::idle_timeout $seconds	278	IO::AIO::idle_timeout $seconds
270	IO::AIO::max_outstanding $maxreqs	279	IO::AIO::max_outstanding $maxreqs
271	IO::AIO::nreqs	280	IO::AIO::nreqs
272	IO::AIO::nready	281	IO::AIO::nready
273	IO::AIO::npending	282	IO::AIO::npending
		283	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
		284	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
274		285
275	IO::AIO::sendfile $ofh, $ifh, $offset, $count	286	IO::AIO::sendfile $ofh, $ifh, $offset, $count
276	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]]
		289	IO::AIO::munmap $scalar
		290	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
277	IO::AIO::madvise $scalar, $offset, $length, $advice	291	IO::AIO::madvise $scalar, $offset, $length, $advice
278	IO::AIO::mprotect $scalar, $offset, $length, $protect	292	IO::AIO::mprotect $scalar, $offset, $length, $protect
279	IO::AIO::munlock $scalar, $offset = 0, $length = undef	293	IO::AIO::munlock $scalar, $offset = 0, $length = undef
280	IO::AIO::munlockall	294	IO::AIO::munlockall
281		295
…		…
358		372
359		373
360	=item aio_open $pathname, $flags, $mode, $callback->($fh)	374	=item aio_open $pathname, $flags, $mode, $callback->($fh)
361		375
362	Asynchronously open or create a file and call the callback with a newly	376	Asynchronously open or create a file and call the callback with a newly
363	created filehandle for the file.	377	created filehandle for the file (or C<undef> in case of an error).
364		378
365	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	379	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
366	for an explanation.	380	for an explanation.
367		381
368	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	382	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
391	following POSIX and non-POSIX constants are available (missing ones on	405	following POSIX and non-POSIX constants are available (missing ones on
392	your system are, as usual, C<0>):	406	your system are, as usual, C<0>):
393		407
394	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>,
395	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>,
396	C<O_RSYNC>, C<O_SYNC> 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>.
397		411
398		412
399	=item aio_close $fh, $callback->($status)	413	=item aio_close $fh, $callback->($status)
400		414
401	Asynchronously close a file and call the callback with the result	415	Asynchronously close a file and call the callback with the result
…		…
425		439
426	In theory, the C<$whence> constants could be different than the	440	In theory, the C<$whence> constants could be different than the
427	corresponding values from L<Fcntl>, but perl guarantees they are the same,	441	corresponding values from L<Fcntl>, but perl guarantees they are the same,
428	so don't panic.	442	so don't panic.
429		443
		444	As a GNU/Linux (and maybe Solaris) extension, also the constants
		445	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		446	could be found. No guarantees about suitability for use in C<aio_seek> or
		447	Perl's C<sysseek> can be made though, although I would naively assume they
		448	"just work".
		449
430	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	450	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
431		451
432	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	452	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
433		453
434	Reads or writes C<$length> bytes from or to the specified C<$fh> and	454	Reads or writes C<$length> bytes from or to the specified C<$fh> and
435	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	455	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
436	and calls the callback without the actual number of bytes read (or -1 on	456	calls the callback with the actual number of bytes transferred (or -1 on
437	error, just like the syscall).	457	error, just like the syscall).
438		458
439	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	459	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
440	offset plus the actual number of bytes read.	460	offset plus the actual number of bytes read.
441		461
…		…
499	As native sendfile syscalls (as practically any non-POSIX interface hacked	519	As native sendfile syscalls (as practically any non-POSIX interface hacked
500	together in a hurry to improve benchmark numbers) tend to be rather buggy	520	together in a hurry to improve benchmark numbers) tend to be rather buggy
501	on many systems, this implementation tries to work around some known bugs	521	on many systems, this implementation tries to work around some known bugs
502	in Linux and FreeBSD kernels (probably others, too), but that might fail,	522	in Linux and FreeBSD kernels (probably others, too), but that might fail,
503	so you really really should check the return value of C<aio_sendfile> -	523	so you really really should check the return value of C<aio_sendfile> -
504	fewre bytes than expected might have been transferred.	524	fewer bytes than expected might have been transferred.
505		525
506		526
507	=item aio_readahead $fh,$offset,$length, $callback->($retval)	527	=item aio_readahead $fh,$offset,$length, $callback->($retval)
508		528
509	C<aio_readahead> populates the page cache with data from a file so that	529	C<aio_readahead> populates the page cache with data from a file so that
…		…
513	whole pages, so that offset is effectively rounded down to a page boundary	533	whole pages, so that offset is effectively rounded down to a page boundary
514	and bytes are read up to the next page boundary greater than or equal to	534	and bytes are read up to the next page boundary greater than or equal to
515	(off-set+length). C<aio_readahead> does not read beyond the end of the	535	(off-set+length). C<aio_readahead> does not read beyond the end of the
516	file. The current file offset of the file is left unchanged.	536	file. The current file offset of the file is left unchanged.
517		537
518	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	538	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
519	emulated by simply reading the data, which would have a similar effect.	539	be emulated by simply reading the data, which would have a similar effect.
520		540
521		541
522	=item aio_stat $fh_or_path, $callback->($status)	542	=item aio_stat $fh_or_path, $callback->($status)
523		543
524	=item aio_lstat $fh, $callback->($status)	544	=item aio_lstat $fh, $callback->($status)
525		545
526	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
527	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
528	or C<-s _> etc...	548	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
		549	and C<-T>).
529		550
530	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,
531	for an explanation.	552	for an explanation.
532		553
533	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
…		…
540	behaviour).	561	behaviour).
541		562
542	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>,
543	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>,
544	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>.
545		569
546	Example: Print the length of F</etc/passwd>:	570	Example: Print the length of F</etc/passwd>:
547		571
548	aio_stat "/etc/passwd", sub {	572	aio_stat "/etc/passwd", sub {
549	$_[0] and die "stat failed: $!";	573	$_[0] and die "stat failed: $!";
…		…
593	namemax => 255,	617	namemax => 255,
594	frsize => 1024,	618	frsize => 1024,
595	fsid => 1810	619	fsid => 1810
596	}	620	}
597		621
598
599	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	622	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
600		623
601	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
602	and $mtime being undef). Fractional times are supported if the underlying	625	and $mtime being undef). Fractional times are supported if the underlying
603	syscalls support them.	626	syscalls support them.
604		627
605	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,
606	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)
607	otherwise returns ENOSYS, so this is not portable.	630	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		631	portable.
608		632
609	Examples:	633	Examples:
610		634
611	# set atime and mtime to current time (basically touch(1)):	635	# set atime and mtime to current time (basically touch(1)):
612	aio_utime "path", undef, undef;	636	aio_utime "path", undef, undef;
…		…
630	=item aio_truncate $fh_or_path, $offset, $callback->($status)	654	=item aio_truncate $fh_or_path, $offset, $callback->($status)
631		655
632	Works like truncate(2) or ftruncate(2).	656	Works like truncate(2) or ftruncate(2).
633		657
634		658
		659	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		660
		661	Allocates or frees disk space according to the C<$mode> argument. See the
		662	linux C<fallocate> documentation for details.
		663
		664	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		665	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
		666	to deallocate a file range.
		667
		668	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		669	(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
		670	C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
		671	to unshare shared blocks (see your L<fallocate(2)> manpage).
		672
		673	The file system block size used by C<fallocate> is presumably the
		674	C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
		675	can dictate other limitations.
		676
		677	If C<fallocate> isn't available or cannot be emulated (currently no
		678	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		679
		680
635	=item aio_chmod $fh_or_path, $mode, $callback->($status)	681	=item aio_chmod $fh_or_path, $mode, $callback->($status)
636		682
637	Works like perl's C<chmod> function.	683	Works like perl's C<chmod> function.
638		684
639		685
…		…
676		722
677		723
678	=item aio_realpath $pathname, $callback->($path)	724	=item aio_realpath $pathname, $callback->($path)
679		725
680	Asynchronously make the path absolute and resolve any symlinks in	726	Asynchronously make the path absolute and resolve any symlinks in
681	C<$path>. The resulting path only consists of directories (Same as	727	C<$path>. The resulting path only consists of directories (same as
682	L<Cwd::realpath>).	728	L<Cwd::realpath>).
683		729
684	This request can be used to get the absolute path of the current working	730	This request can be used to get the absolute path of the current working
685	directory by passing it a path of F<.> (a single dot).	731	directory by passing it a path of F<.> (a single dot).
686		732
687		733
688	=item aio_rename $srcpath, $dstpath, $callback->($status)	734	=item aio_rename $srcpath, $dstpath, $callback->($status)
689		735
690	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	736	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
691	rename(2) and call the callback with the result code.	737	rename(2) and call the callback with the result code.
		738
		739	On systems that support the AIO::WD working directory abstraction
		740	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		741	of failing, C<rename> is called on the absolute path of C<$wd>.
		742
		743
		744	=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
		745
		746	Basically a version of C<aio_rename> with an additional C<$flags>
		747	argument. Calling this with C<$flags=0> is the same as calling
		748	C<aio_rename>.
		749
		750	Non-zero flags are currently only supported on GNU/Linux systems that
		751	support renameat2. Other systems fail with C<ENOSYS> in this case.
		752
		753	The following constants are available (missing ones are, as usual C<0>),
		754	see renameat2(2) for details:
		755
		756	C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
		757	and C<IO::AIO::RENAME_WHITEOUT>.
692		758
693		759
694	=item aio_mkdir $pathname, $mode, $callback->($status)	760	=item aio_mkdir $pathname, $mode, $callback->($status)
695		761
696	Asynchronously mkdir (create) a directory and call the callback with	762	Asynchronously mkdir (create) a directory and call the callback with
…		…
701	=item aio_rmdir $pathname, $callback->($status)	767	=item aio_rmdir $pathname, $callback->($status)
702		768
703	Asynchronously rmdir (delete) a directory and call the callback with the	769	Asynchronously rmdir (delete) a directory and call the callback with the
704	result code.	770	result code.
705		771
		772	On systems that support the AIO::WD working directory abstraction
		773	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		774	C<rmdir> is called on the absolute path of C<$wd>.
		775
706		776
707	=item aio_readdir $pathname, $callback->($entries)	777	=item aio_readdir $pathname, $callback->($entries)
708		778
709	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	779	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
710	directory (i.e. opendir + readdir + closedir). The entries will not be	780	directory (i.e. opendir + readdir + closedir). The entries will not be
…		…
725		795
726	=over 4	796	=over 4
727		797
728	=item IO::AIO::READDIR_DENTS	798	=item IO::AIO::READDIR_DENTS
729		799
730	When this flag is off, then the callback gets an arrayref consisting of	800	Normally the callback gets an arrayref consisting of names only (as
731	names only (as with C<aio_readdir>), otherwise it gets an arrayref with	801	with C<aio_readdir>). If this flag is set, then the callback gets an
732	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	802	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
733	entry in more detail.	803	single directory entry in more detail:
734		804
735	C<$name> is the name of the entry.	805	C<$name> is the name of the entry.
736		806
737	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	807	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
738		808
739	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	809	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
740	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,	810	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
741	C<IO::AIO::DT_WHT>.	811	C<IO::AIO::DT_WHT>.
742		812
743	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	813	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
744	know, you have to run stat yourself. Also, for speed reasons, the C<$type>	814	to know, you have to run stat yourself. Also, for speed/memory reasons,
745	scalars are read-only: you can not modify them.	815	the C<$type> scalars are read-only: you must not modify them.
746		816
747	C<$inode> is the inode number (which might not be exact on systems with 64	817	C<$inode> is the inode number (which might not be exact on systems with 64
748	bit inode numbers and 32 bit perls). This field has unspecified content on	818	bit inode numbers and 32 bit perls). This field has unspecified content on
749	systems that do not deliver the inode information.	819	systems that do not deliver the inode information.
750		820
…		…
761	short names are tried first.	831	short names are tried first.
762		832
763	=item IO::AIO::READDIR_STAT_ORDER	833	=item IO::AIO::READDIR_STAT_ORDER
764		834
765	When this flag is set, then the names will be returned in an order	835	When this flag is set, then the names will be returned in an order
766	suitable for stat()'ing each one. That is, when you plan to stat()	836	suitable for stat()'ing each one. That is, when you plan to stat() most or
767	all files in the given directory, then the returned order will likely	837	all files in the given directory, then the returned order will likely be
768	be fastest.	838	faster.
769		839
770	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	840	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
771	the likely dirs come first, resulting in a less optimal stat order.	841	then the likely dirs come first, resulting in a less optimal stat order
		842	for stat'ing all entries, but likely a more optimal order for finding
		843	subdirectories.
772		844
773	=item IO::AIO::READDIR_FOUND_UNKNOWN	845	=item IO::AIO::READDIR_FOUND_UNKNOWN
774		846
775	This flag should not be set when calling C<aio_readdirx>. Instead, it	847	This flag should not be set when calling C<aio_readdirx>. Instead, it
776	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	848	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
778	C<$type>'s are known, which can be used to speed up some algorithms.	850	C<$type>'s are known, which can be used to speed up some algorithms.
779		851
780	=back	852	=back
781		853
782		854
		855	=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
		856
		857	Opens, reads and closes the given file. The data is put into C<$data>,
		858	which is resized as required.
		859
		860	If C<$offset> is negative, then it is counted from the end of the file.
		861
		862	If C<$length> is zero, then the remaining length of the file is
		863	used. Also, in this case, the same limitations to modifying C<$data> apply
		864	as when IO::AIO::mmap is used, i.e. it must only be modified in-place
		865	with C<substr>. If the size of the file is known, specifying a non-zero
		866	C<$length> results in a performance advantage.
		867
		868	This request is similar to the older C<aio_load> request, but since it is
		869	a single request, it might be more efficient to use.
		870
		871	Example: load F</etc/passwd> into C<$passwd>.
		872
		873	my $passwd;
		874	aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
		875	$_[0] >= 0
		876	or die "/etc/passwd: $!\n";
		877
		878	printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
		879	print $passwd;
		880	};
		881	IO::AIO::flush;
		882
		883
783	=item aio_load $pathname, $data, $callback->($status)	884	=item aio_load $pathname, $data, $callback->($status)
784		885
785	This is a composite request that tries to fully load the given file into	886	This is a composite request that tries to fully load the given file into
786	memory. Status is the same as with aio_read.	887	memory. Status is the same as with aio_read.
		888
		889	Using C<aio_slurp> might be more efficient, as it is a single request.
787		890
788	=cut	891	=cut
789		892
790	sub aio_load($$;$) {	893	sub aio_load($$;$) {
791	my ($path, undef, $cb) = @_;	894	my ($path, undef, $cb) = @_;
…		…
811	=item aio_copy $srcpath, $dstpath, $callback->($status)	914	=item aio_copy $srcpath, $dstpath, $callback->($status)
812		915
813	Try to copy the I<file> (directories not supported as either source or	916	Try to copy the I<file> (directories not supported as either source or
814	destination) from C<$srcpath> to C<$dstpath> and call the callback with	917	destination) from C<$srcpath> to C<$dstpath> and call the callback with
815	a status of C<0> (ok) or C<-1> (error, see C<$!>).	918	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		919
		920	Existing destination files will be truncated.
816		921
817	This is a composite request that creates the destination file with	922	This is a composite request that creates the destination file with
818	mode 0200 and copies the contents of the source file into it using	923	mode 0200 and copies the contents of the source file into it using
819	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	924	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
820	uid/gid, in that order.	925	uid/gid, in that order.
…		…
930	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1035	Scans a directory (similar to C<aio_readdir>) but additionally tries to
931	efficiently separate the entries of directory C<$path> into two sets of	1036	efficiently separate the entries of directory C<$path> into two sets of
932	names, directories you can recurse into (directories), and ones you cannot	1037	names, directories you can recurse into (directories), and ones you cannot
933	recurse into (everything else, including symlinks to directories).	1038	recurse into (everything else, including symlinks to directories).
934		1039
935	C<aio_scandir> is a composite request that creates of many sub requests_	1040	C<aio_scandir> is a composite request that generates many sub requests.
936	C<$maxreq> specifies the maximum number of outstanding aio requests that	1041	C<$maxreq> specifies the maximum number of outstanding aio requests that
937	this function generates. If it is C<< <= 0 >>, then a suitable default	1042	this function generates. If it is C<< <= 0 >>, then a suitable default
938	will be chosen (currently 4).	1043	will be chosen (currently 4).
939		1044
940	On error, the callback is called without arguments, otherwise it receives	1045	On error, the callback is called without arguments, otherwise it receives
…		…
1074	}	1179	}
1075		1180
1076	=item aio_rmtree $pathname, $callback->($status)	1181	=item aio_rmtree $pathname, $callback->($status)
1077		1182
1078	Delete a directory tree starting (and including) C<$path>, return the	1183	Delete a directory tree starting (and including) C<$path>, return the
1079	status of the final C<rmdir> only. This is a composite request that	1184	status of the final C<rmdir> only. This is a composite request that
1080	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1185	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1081	everything else.	1186	everything else.
1082		1187
1083	=cut	1188	=cut
1084		1189
…		…
1105	add $grp $dirgrp;	1210	add $grp $dirgrp;
1106	};	1211	};
1107		1212
1108	$grp	1213	$grp
1109	}	1214	}
		1215
		1216	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1217
		1218	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1219
		1220	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1221	they execute asynchronously and pass the return value to the callback.
		1222
		1223	Both calls can be used for a lot of things, some of which make more sense
		1224	to run asynchronously in their own thread, while some others make less
		1225	sense. For example, calls that block waiting for external events, such
		1226	as locking, will also lock down an I/O thread while it is waiting, which
		1227	can deadlock the whole I/O system. At the same time, there might be no
		1228	alternative to using a thread to wait.
		1229
		1230	So in general, you should only use these calls for things that do
		1231	(filesystem) I/O, not for things that wait for other events (network,
		1232	other processes), although if you are careful and know what you are doing,
		1233	you still can.
		1234
		1235	The following constants are available (missing ones are, as usual C<0>):
		1236
		1237	C<F_DUPFD_CLOEXEC>,
		1238
		1239	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
		1240
		1241	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1242
		1243	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1244	C<FS_IOC_FIEMAP>.
		1245
		1246	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1247	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1248
		1249	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1250	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1251	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1252	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1253	C<FS_FL_USER_MODIFIABLE>.
		1254
		1255	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1256	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1257	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1258	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1110		1259
1111	=item aio_sync $callback->($status)	1260	=item aio_sync $callback->($status)
1112		1261
1113	Asynchronously call sync and call the callback when finished.	1262	Asynchronously call sync and call the callback when finished.
1114		1263
…		…
1183	};	1332	};
1184		1333
1185	$grp	1334	$grp
1186	}	1335	}
1187		1336
1188	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1337	=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1189		1338
1190	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1339	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1191	scalars (see the C<IO::AIO::mmap> function, although it also works on data	1340	scalars (see the C<IO::AIO::mmap> function, although it also works on data
1192	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the	1341	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1193	scalar must only be modified in-place while an aio operation is pending on	1342	scalar must only be modified in-place while an aio operation is pending on
…		…
1195		1344
1196	It calls the C<msync> function of your OS, if available, with the memory	1345	It calls the C<msync> function of your OS, if available, with the memory
1197	area starting at C<$offset> in the string and ending C<$length> bytes	1346	area starting at C<$offset> in the string and ending C<$length> bytes
1198	later. If C<$length> is negative, counts from the end, and if C<$length>	1347	later. If C<$length> is negative, counts from the end, and if C<$length>
1199	is C<undef>, then it goes till the end of the string. The flags can be	1348	is C<undef>, then it goes till the end of the string. The flags can be
1200	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and	1349	either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1201	C<IO::AIO::MS_SYNC>.	1350	C<IO::AIO::MS_INVALIDATE>.
1202		1351
1203	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1352	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1204		1353
1205	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1354	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1206	scalars.	1355	scalars.
1207		1356
1208	It touches (reads or writes) all memory pages in the specified	1357	It touches (reads or writes) all memory pages in the specified
1209	range inside the scalar. All caveats and parameters are the same	1358	range inside the scalar. All caveats and parameters are the same
1210	as for C<aio_msync>, above, except for flags, which must be either	1359	as for C<aio_msync>, above, except for flags, which must be either
1211	C<0> (which reads all pages and ensures they are instantiated) or	1360	C<0> (which reads all pages and ensures they are instantiated) or
1212	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1361	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1213	writing an octet from it, which dirties the page).	1362	writing an octet from it, which dirties the page).
1214		1363
1215	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1364	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1216		1365
1217	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1366	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1248	documented under L<MISCELLANEOUS FUNCTIONS>.	1397	documented under L<MISCELLANEOUS FUNCTIONS>.
1249		1398
1250	Example: asynchronously lock all current and future pages into memory.	1399	Example: asynchronously lock all current and future pages into memory.
1251		1400
1252	aio_mlockall IO::AIO::MCL_FUTURE;	1401	aio_mlockall IO::AIO::MCL_FUTURE;
		1402
		1403	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1404
		1405	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1406	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1407	the ioctl is not available on your OS, then this request will fail with
		1408	C<ENOSYS>.
		1409
		1410	C<$start> is the starting offset to query extents for, C<$length> is the
		1411	size of the range to query - if it is C<undef>, then the whole file will
		1412	be queried.
		1413
		1414	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1415	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1416	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1417	the data portion.
		1418
		1419	C<$count> is the maximum number of extent records to return. If it is
		1420	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1421	case, if it is C<0>, then the callback receives the number of extents
		1422	instead of the extents themselves (which is unreliable, see below).
		1423
		1424	If an error occurs, the callback receives no arguments. The special
		1425	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1426
		1427	Otherwise, the callback receives an array reference with extent
		1428	structures. Each extent structure is an array reference itself, with the
		1429	following members:
		1430
		1431	[$logical, $physical, $length, $flags]
		1432
		1433	Flags is any combination of the following flag values (typically either C<0>
		1434	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1435
		1436	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1437	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1438	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1439	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1440	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1441	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1442
		1443	At the time of this writing (Linux 3.2), this request is unreliable unless
		1444	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1445	it to return all extents of a range for files with a large number of
		1446	extents. The code (only) works around all these issues if C<$count> is
		1447	C<undef>.
1253		1448
1254	=item aio_group $callback->(...)	1449	=item aio_group $callback->(...)
1255		1450
1256	This is a very special aio request: Instead of doing something, it is a	1451	This is a very special aio request: Instead of doing something, it is a
1257	container for other aio requests, which is useful if you want to bundle	1452	container for other aio requests, which is useful if you want to bundle
…		…
1341	aio_stat [$etcdir, "passwd"], sub {	1536	aio_stat [$etcdir, "passwd"], sub {
1342	# yay	1537	# yay
1343	};	1538	};
1344	};	1539	};
1345		1540
1346	That C<aio_wd> is a request and not a normal function shows that creating	1541	The fact that C<aio_wd> is a request and not a normal function shows that
1347	an IO::AIO::WD object is itself a potentially blocking operation, which is	1542	creating an IO::AIO::WD object is itself a potentially blocking operation,
1348	why it is done asynchronously.	1543	which is why it is done asynchronously.
1349		1544
1350	To stat the directory obtained with C<aio_wd> above, one could write	1545	To stat the directory obtained with C<aio_wd> above, one could write
1351	either of the following three request calls:	1546	either of the following three request calls:
1352		1547
1353	aio_lstat "/etc" , sub { ... # pathname as normal string	1548	aio_lstat "/etc" , sub { ... # pathname as normal string
…		…
1370	There are some caveats: when directories get renamed (or deleted), the	1565	There are some caveats: when directories get renamed (or deleted), the
1371	pathname string doesn't change, so will point to the new directory (or	1566	pathname string doesn't change, so will point to the new directory (or
1372	nowhere at all), while the directory fd, if available on the system,	1567	nowhere at all), while the directory fd, if available on the system,
1373	will still point to the original directory. Most functions accepting a	1568	will still point to the original directory. Most functions accepting a
1374	pathname will use the directory fd on newer systems, and the string on	1569	pathname will use the directory fd on newer systems, and the string on
1375	older systems. Some functions (such as realpath) will always rely on the	1570	older systems. Some functions (such as C<aio_realpath>) will always rely on
1376	string form of the pathname.	1571	the string form of the pathname.
1377		1572
1378	So this fucntionality is mainly useful to get some protection against	1573	So this functionality is mainly useful to get some protection against
1379	C<chdir>, to easily get an absolute path out of a relative path for future	1574	C<chdir>, to easily get an absolute path out of a relative path for future
1380	reference, and to speed up doing many operations in the same directory	1575	reference, and to speed up doing many operations in the same directory
1381	(e.g. when stat'ing all files in a directory).	1576	(e.g. when stat'ing all files in a directory).
1382		1577
1383	The following functions implement this working directory abstraction:	1578	The following functions implement this working directory abstraction:
…		…
1396	passing C<undef> as working directory component of a pathname fails the	1591	passing C<undef> as working directory component of a pathname fails the
1397	request with C<ENOENT>, there is often no need for error checking in the	1592	request with C<ENOENT>, there is often no need for error checking in the
1398	C<aio_wd> callback, as future requests using the value will fail in the	1593	C<aio_wd> callback, as future requests using the value will fail in the
1399	expected way.	1594	expected way.
1400		1595
1401	If this call isn't available because your OS lacks it or it couldn't be
1402	detected, it will be emulated by calling C<fsync> instead.
1403
1404	=item IO::AIO::CWD	1596	=item IO::AIO::CWD
1405		1597
1406	This is a compiletime constant (object) that represents the process	1598	This is a compiletime constant (object) that represents the process
1407	current working directory.	1599	current working directory.
1408		1600
1409	Specifying this object as working directory object for a pathname is as	1601	Specifying this object as working directory object for a pathname is as if
1410	if the pathname would be specified directly, without a directory object,	1602	the pathname would be specified directly, without a directory object. For
1411	e.g., these calls are functionally identical:	1603	example, these calls are functionally identical:
1412		1604
1413	aio_stat "somefile", sub { ... };	1605	aio_stat "somefile", sub { ... };
1414	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1606	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1415		1607
1416	=back	1608	=back
1417		1609
		1610	To recover the path associated with an IO::AIO::WD object, you can use
		1611	C<aio_realpath>:
		1612
		1613	aio_realpath $wd, sub {
		1614	warn "path is $_[0]\n";
		1615	};
		1616
		1617	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1618	sometimes, fall back to using an absolue path.
1418		1619
1419	=head2 IO::AIO::REQ CLASS	1620	=head2 IO::AIO::REQ CLASS
1420		1621
1421	All non-aggregate C<aio_*> functions return an object of this class when	1622	All non-aggregate C<aio_*> functions return an object of this class when
1422	called in non-void context.	1623	called in non-void context.
…		…
1583	The default value for the limit is C<0>, but note that setting a feeder	1784	The default value for the limit is C<0>, but note that setting a feeder
1584	automatically bumps it up to C<2>.	1785	automatically bumps it up to C<2>.
1585		1786
1586	=back	1787	=back
1587		1788
		1789
1588	=head2 SUPPORT FUNCTIONS	1790	=head2 SUPPORT FUNCTIONS
1589		1791
1590	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1792	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1591		1793
1592	=over 4	1794	=over 4
…		…
1600		1802
1601	See C<poll_cb> for an example.	1803	See C<poll_cb> for an example.
1602		1804
1603	=item IO::AIO::poll_cb	1805	=item IO::AIO::poll_cb
1604		1806
1605	Process some outstanding events on the result pipe. You have to call	1807	Process some requests that have reached the result phase (i.e. they have
		1808	been executed but the results are not yet reported). You have to call
		1809	this "regularly" to finish outstanding requests.
		1810
1606	this regularly. Returns C<0> if all events could be processed (or there	1811	Returns C<0> if all events could be processed (or there were no
1607	were no events to process), or C<-1> if it returned earlier for whatever	1812	events to process), or C<-1> if it returned earlier for whatever
1608	reason. Returns immediately when no events are outstanding. The amount of	1813	reason. Returns immediately when no events are outstanding. The amount
1609	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1814	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1610	C<IO::AIO::max_poll_time>.	1815	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1611		1816
1612	If not all requests were processed for whatever reason, the filehandle	1817	If not all requests were processed for whatever reason, the poll file
1613	will still be ready when C<poll_cb> returns, so normally you don't have to	1818	descriptor will still be ready when C<poll_cb> returns, so normally you
1614	do anything special to have it called later.	1819	don't have to do anything special to have it called later.
1615		1820
1616	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1821	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1617	ready, it can be beneficial to call this function from loops which submit	1822	ready, it can be beneficial to call this function from loops which submit
1618	a lot of requests, to make sure the results get processed when they become	1823	a lot of requests, to make sure the results get processed when they become
1619	available and not just when the loop is finished and the event loop takes	1824	available and not just when the loop is finished and the event loop takes
…		…
1628	poll => 'r', async => 1,	1833	poll => 'r', async => 1,
1629	cb => \&IO::AIO::poll_cb);	1834	cb => \&IO::AIO::poll_cb);
1630		1835
1631	=item IO::AIO::poll_wait	1836	=item IO::AIO::poll_wait
1632		1837
1633	If there are any outstanding requests and none of them in the result	1838	Wait until either at least one request is in the result phase or no
1634	phase, wait till the result filehandle becomes ready for reading (simply	1839	requests are outstanding anymore.
1635	does a C<select> on the filehandle. This is useful if you want to	1840
1636	synchronously wait for some requests to finish).	1841	This is useful if you want to synchronously wait for some requests to
		1842	become ready, without actually handling them.
1637		1843
1638	See C<nreqs> for an example.	1844	See C<nreqs> for an example.
1639		1845
1640	=item IO::AIO::poll	1846	=item IO::AIO::poll
1641		1847
…		…
1652		1858
1653	Strictly equivalent to:	1859	Strictly equivalent to:
1654		1860
1655	IO::AIO::poll_wait, IO::AIO::poll_cb	1861	IO::AIO::poll_wait, IO::AIO::poll_cb
1656	while IO::AIO::nreqs;	1862	while IO::AIO::nreqs;
		1863
		1864	This function can be useful at program aborts, to make sure outstanding
		1865	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1866	this function on normal exits), or when you are merely using C<IO::AIO>
		1867	for its more advanced functions, rather than for async I/O, e.g.:
		1868
		1869	my ($dirs, $nondirs);
		1870	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1871	IO::AIO::flush;
		1872	# $dirs, $nondirs are now set
1657		1873
1658	=item IO::AIO::max_poll_reqs $nreqs	1874	=item IO::AIO::max_poll_reqs $nreqs
1659		1875
1660	=item IO::AIO::max_poll_time $seconds	1876	=item IO::AIO::max_poll_time $seconds
1661		1877
…		…
1688	poll => 'r', nice => 1,	1904	poll => 'r', nice => 1,
1689	cb => &IO::AIO::poll_cb);	1905	cb => &IO::AIO::poll_cb);
1690		1906
1691	=back	1907	=back
1692		1908
		1909
1693	=head3 CONTROLLING THE NUMBER OF THREADS	1910	=head3 CONTROLLING THE NUMBER OF THREADS
1694		1911
1695	=over	1912	=over
1696		1913
1697	=item IO::AIO::min_parallel $nthreads	1914	=item IO::AIO::min_parallel $nthreads
…		…
1762		1979
1763	This is a very bad function to use in interactive programs because it	1980	This is a very bad function to use in interactive programs because it
1764	blocks, and a bad way to reduce concurrency because it is inexact: Better	1981	blocks, and a bad way to reduce concurrency because it is inexact: Better
1765	use an C<aio_group> together with a feed callback.	1982	use an C<aio_group> together with a feed callback.
1766		1983
1767	It's main use is in scripts without an event loop - when you want to stat	1984	Its main use is in scripts without an event loop - when you want to stat
1768	a lot of files, you can write somehting like this:	1985	a lot of files, you can write something like this:
1769		1986
1770	IO::AIO::max_outstanding 32;	1987	IO::AIO::max_outstanding 32;
1771		1988
1772	for my $path (...) {	1989	for my $path (...) {
1773	aio_stat $path , ...;	1990	aio_stat $path , ...;
…		…
1784	The default value for C<max_outstanding> is very large, so there is no	2001	The default value for C<max_outstanding> is very large, so there is no
1785	practical limit on the number of outstanding requests.	2002	practical limit on the number of outstanding requests.
1786		2003
1787	=back	2004	=back
1788		2005
		2006
1789	=head3 STATISTICAL INFORMATION	2007	=head3 STATISTICAL INFORMATION
1790		2008
1791	=over	2009	=over
1792		2010
1793	=item IO::AIO::nreqs	2011	=item IO::AIO::nreqs
…		…
1810	Returns the number of requests currently in the pending state (executed,	2028	Returns the number of requests currently in the pending state (executed,
1811	but not yet processed by poll_cb).	2029	but not yet processed by poll_cb).
1812		2030
1813	=back	2031	=back
1814		2032
		2033
		2034	=head3 SUBSECOND STAT TIME ACCESS
		2035
		2036	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2037	generally find access/modification and change times with subsecond time
		2038	accuracy of the system supports it, but perl's built-in functions only
		2039	return the integer part.
		2040
		2041	The following functions return the timestamps of the most recent
		2042	stat with subsecond precision on most systems and work both after
		2043	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2044	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2045	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2046
		2047	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2048	full resolution without rounding and work with standard perl C<stat>,
		2049	alleviating the need to call the special C<Time::HiRes> functions, which
		2050	do not act like their perl counterparts.
		2051
		2052	On operating systems or file systems where subsecond time resolution is
		2053	not supported or could not be detected, a fractional part of C<0> is
		2054	returned, so it is always safe to call these functions.
		2055
		2056	=over 4
		2057
		2058	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2059
		2060	Return the access, modication, change or birth time, respectively,
		2061	including fractional part. Due to the limited precision of floating point,
		2062	the accuracy on most platforms is only a bit better than milliseconds
		2063	for times around now - see the I<nsec> function family, below, for full
		2064	accuracy.
		2065
		2066	File birth time is only available when the OS and perl support it (on
		2067	FreeBSD and NetBSD at the time of this writing, although support is
		2068	adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of
		2069	it). On systems where it isn't available, C<0> is currently returned, but
		2070	this might change to C<undef> in a future version.
		2071
		2072	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2073
		2074	Returns access, modification, change and birth time all in one go, and
		2075	maybe more times in the future version.
		2076
		2077	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2078
		2079	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2080	as an integer in the range C<0> to C<999999999>.
		2081
		2082	Note that no accessors are provided for access, modification and
		2083	change times - you need to get those from C<stat _> if required (C<int
		2084	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2085	value).
		2086
		2087	=item $seconds = IO::AIO::st_btimesec
		2088
		2089	The (integral) seconds part of the file birth time, if available.
		2090
		2091	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2092
		2093	Like the functions above, but returns all four times in one go (and maybe
		2094	more in future versions).
		2095
		2096	=item $counter = IO::AIO::st_gen
		2097
		2098	Returns the generation counter (in practice this is just a random number)
		2099	of the file. This is only available on platforms which have this member in
		2100	their C<struct stat> (most BSDs at the time of this writing) and generally
		2101	only to the root usert. If unsupported, C<0> is returned, but this might
		2102	change to C<undef> in a future version.
		2103
		2104	=back
		2105
		2106	Example: print the high resolution modification time of F</etc>, using
		2107	C<stat>, and C<IO::AIO::aio_stat>.
		2108
		2109	if (stat "/etc") {
		2110	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2111	}
		2112
		2113	IO::AIO::aio_stat "/etc", sub {
		2114	$_[0]
		2115	and return;
		2116
		2117	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2118	};
		2119
		2120	IO::AIO::flush;
		2121
		2122	Output of the awbove on my system, showing reduced and full accuracy:
		2123
		2124	stat(/etc) mtime: 1534043702.020808
		2125	aio_stat(/etc) mtime: 1534043702.020807792
		2126
		2127
1815	=head3 MISCELLANEOUS FUNCTIONS	2128	=head3 MISCELLANEOUS FUNCTIONS
1816		2129
1817	IO::AIO implements some functions that might be useful, but are not	2130	IO::AIO implements some functions that are useful when you want to use
1818	asynchronous.	2131	some "Advanced I/O" function not available to in Perl, without going the
		2132	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2133	counterpart.
1819		2134
1820	=over 4	2135	=over 4
		2136
		2137	=item $numfd = IO::AIO::get_fdlimit
		2138
		2139	This function is I<EXPERIMENTAL> and subject to change.
		2140
		2141	Tries to find the current file descriptor limit and returns it, or
		2142	C<undef> and sets C<$!> in case of an error. The limit is one larger than
		2143	the highest valid file descriptor number.
		2144
		2145	=item IO::AIO::min_fdlimit [$numfd]
		2146
		2147	This function is I<EXPERIMENTAL> and subject to change.
		2148
		2149	Try to increase the current file descriptor limit(s) to at least C<$numfd>
		2150	by changing the soft or hard file descriptor resource limit. If C<$numfd>
		2151	is missing, it will try to set a very high limit, although this is not
		2152	recommended when you know the actual minimum that you require.
		2153
		2154	If the limit cannot be raised enough, the function makes a best-effort
		2155	attempt to increase the limit as much as possible, using various
		2156	tricks, while still failing. You can query the resulting limit using
		2157	C<IO::AIO::get_fdlimit>.
		2158
		2159	If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
		2160	true.
1821		2161
1822	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2162	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1823		2163
1824	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,	2164	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1825	but is blocking (this makes most sense if you know the input data is	2165	but is blocking (this makes most sense if you know the input data is
…		…
1842	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2182	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1843		2183
1844	Simply calls the C<posix_madvise> function (see its	2184	Simply calls the C<posix_madvise> function (see its
1845	manpage for details). The following advice constants are	2185	manpage for details). The following advice constants are
1846	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2186	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1847	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2187	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
		2188	C<IO::AIO::MADV_DONTNEED>.
		2189
		2190	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2191	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2192	will be reduced to fit into the C<$scalar>.
1848		2193
1849	On systems that do not implement C<posix_madvise>, this function returns	2194	On systems that do not implement C<posix_madvise>, this function returns
1850	ENOSYS, otherwise the return value of C<posix_madvise>.	2195	ENOSYS, otherwise the return value of C<posix_madvise>.
1851		2196
1852	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2197	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
1854	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2199	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1855	$scalar (see its manpage for details). The following protect	2200	$scalar (see its manpage for details). The following protect
1856	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2201	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1857	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2202	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1858		2203
		2204	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2205	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2206	will be reduced to fit into the C<$scalar>.
		2207
1859	On systems that do not implement C<mprotect>, this function returns	2208	On systems that do not implement C<mprotect>, this function returns
1860	ENOSYS, otherwise the return value of C<mprotect>.	2209	ENOSYS, otherwise the return value of C<mprotect>.
1861		2210
1862	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2211	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1863		2212
1864	Memory-maps a file (or anonymous memory range) and attaches it to the	2213	Memory-maps a file (or anonymous memory range) and attaches it to the
1865	given C<$scalar>, which will act like a string scalar.	2214	given C<$scalar>, which will act like a string scalar. Returns true on
		2215	success, and false otherwise.
1866		2216
		2217	The scalar must exist, but its contents do not matter - this means you
		2218	cannot use a nonexistant array or hash element. When in doubt, C<undef>
		2219	the scalar first.
		2220
1867	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2221	The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1868	change the string length, and most read-only operations such as copying it	2222	which don't change the string length, and most read-only operations such
1869	or searching it with regexes and so on.	2223	as copying it or searching it with regexes and so on.
1870		2224
1871	Anything else is unsafe and will, at best, result in memory leaks.	2225	Anything else is unsafe and will, at best, result in memory leaks.
1872		2226
1873	The memory map associated with the C<$scalar> is automatically removed	2227	The memory map associated with the C<$scalar> is automatically removed
1874	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or	2228	when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1875	C<IO::AIO::munmap> functions are called.	2229	or C<IO::AIO::munmap> functions are called on it.
1876		2230
1877	This calls the C<mmap>(2) function internally. See your system's manual	2231	This calls the C<mmap>(2) function internally. See your system's manual
1878	page for details on the C<$length>, C<$prot> and C<$flags> parameters.	2232	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1879		2233
1880	The C<$length> must be larger than zero and smaller than the actual	2234	The C<$length> must be larger than zero and smaller than the actual
1881	filesize.	2235	filesize.
1882		2236
1883	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2237	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1884	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2238	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1885		2239
1886	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2240	C<$flags> can be a combination of
1887	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2241	C<IO::AIO::MAP_SHARED> or
1888	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2242	C<IO::AIO::MAP_PRIVATE>,
		2243	or a number of system-specific flags (when not available, the are C<0>):
1889	(which is set to C<MAP_ANON> if your system only provides this	2244	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1890	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2245	C<IO::AIO::MAP_LOCKED>,
1891	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2246	C<IO::AIO::MAP_NORESERVE>,
		2247	C<IO::AIO::MAP_POPULATE>,
1892	C<IO::AIO::MAP_NONBLOCK>	2248	C<IO::AIO::MAP_NONBLOCK>,
		2249	C<IO::AIO::MAP_FIXED>,
		2250	C<IO::AIO::MAP_GROWSDOWN>,
		2251	C<IO::AIO::MAP_32BIT>,
		2252	C<IO::AIO::MAP_HUGETLB> or
		2253	C<IO::AIO::MAP_STACK>.
1893		2254
1894	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2255	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1895		2256
1896	C<$offset> is the offset from the start of the file - it generally must be	2257	C<$offset> is the offset from the start of the file - it generally must be
1897	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2258	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
1911		2272
1912	=item IO::AIO::munmap $scalar	2273	=item IO::AIO::munmap $scalar
1913		2274
1914	Removes a previous mmap and undefines the C<$scalar>.	2275	Removes a previous mmap and undefines the C<$scalar>.
1915		2276
		2277	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2278
		2279	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2280	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2281	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2282
		2283	Returns true if successful, and false otherwise. If the underlying mmapped
		2284	region has changed address, then the true value has the numerical value
		2285	C<1>, otherwise it has the numerical value C<0>:
		2286
		2287	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2288	or die "mremap: $!";
		2289
		2290	if ($success*1) {
		2291	warn "scalar has chanegd address in memory\n";
		2292	}
		2293
		2294	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2295	implemented, but not supported and might go away in a future version.
		2296
		2297	On systems where this call is not supported or is not emulated, this call
		2298	returns falls and sets C<$!> to C<ENOSYS>.
		2299
1916	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2300	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1917		2301
1918	Calls the C<munlock> function, undoing the effects of a previous	2302	Calls the C<munlock> function, undoing the effects of a previous
1919	C<aio_mlock> call (see its description for details).	2303	C<aio_mlock> call (see its description for details).
1920		2304
…		…
1922		2306
1923	Calls the C<munlockall> function.	2307	Calls the C<munlockall> function.
1924		2308
1925	On systems that do not implement C<munlockall>, this function returns	2309	On systems that do not implement C<munlockall>, this function returns
1926	ENOSYS, otherwise the return value of C<munlockall>.	2310	ENOSYS, otherwise the return value of C<munlockall>.
		2311
		2312	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2313
		2314	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2315	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2316	should be the file offset.
		2317
		2318	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2319	silently corrupt the data in this case.
		2320
		2321	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2322	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2323	C<IO::AIO::SPLICE_F_GIFT>.
		2324
		2325	See the C<splice(2)> manpage for details.
		2326
		2327	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2328
		2329	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2330	description for C<IO::AIO::splice> above for details.
		2331
		2332	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2333
		2334	Attempts to query or change the pipe buffer size. Obviously works only
		2335	on pipes, and currently works only on GNU/Linux systems, and fails with
		2336	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2337	size on other systems, drop me a note.
		2338
		2339	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2340
		2341	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2342	C<$flags> is missing or C<0>, then this should be the same as a call to
		2343	perl's built-in C<pipe> function and create a new pipe, and works on
		2344	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2345	(..., 4096, O_BINARY)>.
		2346
		2347	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2348	the given flags (Linux 2.6.27, glibc 2.9).
		2349
		2350	On success, the read and write file handles are returned.
		2351
		2352	On error, nothing will be returned. If the pipe2 syscall is missing and
		2353	C<$flags> is non-zero, fails with C<ENOSYS>.
		2354
		2355	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2356	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2357	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2358
		2359	Example: create a pipe race-free w.r.t. threads and fork:
		2360
		2361	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
		2362	or die "pipe2: $!\n";
		2363
		2364	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
		2365
		2366	This is a direct interface to the Linux L<eventfd(2)> system call. The
		2367	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
		2368
		2369	On success, the new eventfd filehandle is returned, otherwise returns
		2370	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2371
		2372	Please refer to L<eventfd(2)> for more info on this call.
		2373
		2374	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
		2375	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2376
		2377	Example: create a new eventfd filehandle:
		2378
		2379	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
		2380	or die "eventfd: $!\n";
		2381
		2382	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2383
		2384	This is a direct interface to the Linux L<timerfd_create(2)> system call. The
		2385	(unhelpful) default for C<$flags> is C<0>.
		2386
		2387	On success, the new timerfd filehandle is returned, otherwise returns
		2388	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2389
		2390	Please refer to L<timerfd_create(2)> for more info on this call.
		2391
		2392	The following C<$clockid> values are
		2393	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2394	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2395	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2396	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2397
		2398	The following C<$flags> values are available (Linux
		2399	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2400
		2401	Example: create a new timerfd and set it to one-second repeated alarms,
		2402	then wait for two alarms:
		2403
		2404	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2405	or die "timerfd_create: $!\n";
		2406
		2407	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2408	or die "timerfd_settime: $!\n";
		2409
		2410	for (1..2) {
		2411	8 == sysread $fh, my $buf, 8
		2412	or die "timerfd read failure\n";
		2413
		2414	printf "number of expirations (likely 1): %d\n",
		2415	unpack "Q", $buf;
		2416	}
		2417
		2418	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2419
		2420	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2421	call. Please refer to its manpage for more info on this call.
		2422
		2423	The new itimerspec is specified using two (possibly fractional) second
		2424	values, C<$new_interval> and C<$new_value>).
		2425
		2426	On success, the current interval and value are returned (as per
		2427	C<timerfd_gettime>). On failure, the empty list is returned.
		2428
		2429	The following C<$flags> values are
		2430	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2431	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2432
		2433	See C<IO::AIO::timerfd_create> for a full example.
		2434
		2435	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2436
		2437	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2438	call. Please refer to its manpage for more info on this call.
		2439
		2440	On success, returns the current values of interval and value for the given
		2441	timerfd (as potentially fractional second values). On failure, the empty
		2442	list is returned.
1927		2443
1928	=back	2444	=back
1929		2445
1930	=cut	2446	=cut
1931		2447
…		…
1997	the process will result in undefined behaviour. Calling it at any time	2513	the process will result in undefined behaviour. Calling it at any time
1998	will also result in any undefined (by POSIX) behaviour.	2514	will also result in any undefined (by POSIX) behaviour.
1999		2515
2000	=back	2516	=back
2001		2517
		2518	=head2 LINUX-SPECIFIC CALLS
		2519
		2520	When a call is documented as "linux-specific" then this means it
		2521	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2522	availability and compatibility of such calls regardless of the platform
		2523	it is compiled on, so platforms such as FreeBSD which often implement
		2524	these calls will work. When in doubt, call them and see if they fail wth
		2525	C<ENOSYS>.
		2526
2002	=head2 MEMORY USAGE	2527	=head2 MEMORY USAGE
2003		2528
2004	Per-request usage:	2529	Per-request usage:
2005		2530
2006	Each aio request uses - depending on your architecture - around 100-200	2531	Each aio request uses - depending on your architecture - around 100-200
…		…
2018	temporary buffers, and each thread requires a stack and other data	2543	temporary buffers, and each thread requires a stack and other data
2019	structures (usually around 16k-128k, depending on the OS).	2544	structures (usually around 16k-128k, depending on the OS).
2020		2545
2021	=head1 KNOWN BUGS	2546	=head1 KNOWN BUGS
2022		2547
2023	Known bugs will be fixed in the next release.	2548	Known bugs will be fixed in the next release :)
		2549
		2550	=head1 KNOWN ISSUES
		2551
		2552	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2553	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2554	non-created hash slots or other scalars I didn't think of. It's best to
		2555	avoid such and either use scalar variables or making sure that the scalar
		2556	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2557
		2558	I am not sure anything can be done about this, so this is considered a
		2559	known issue, rather than a bug.
2024		2560
2025	=head1 SEE ALSO	2561	=head1 SEE ALSO
2026		2562
2027	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2563	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2028	more natural syntax.	2564	more natural syntax.

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.221 by root, Mon Apr 2 03:54:46 2012 UTC vs. Revision 1.296 by root, Sun Aug 26 03:17:35 2018 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.221 by root, Mon Apr 2 03:54:46 2012 UTC vs.
Revision 1.296 by root, Sun Aug 26 03:17:35 2018 UTC