ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.318 by root, Sat Apr 1 02:14:05 2023 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.0';	176	our $VERSION = 4.80;
174		177
175	our @AIO_REQ = qw(aio_sendfile 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
		198
		199	accept4 tee splice pipe2 pipesize
		200	fexecve mount umount memfd_create eventfd
		201	timerfd_create timerfd_settime timerfd_gettime
		202	pidfd_open pidfd_send_signal pidfd_getfd);
194		203
195	push @AIO_REQ, qw(aio_busy); # not exported	204	push @AIO_REQ, qw(aio_busy); # not exported
196		205
197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	206	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
198		207
…		…
202		211
203	=head1 FUNCTIONS	212	=head1 FUNCTIONS
204		213
205	=head2 QUICK OVERVIEW	214	=head2 QUICK OVERVIEW
206		215
207	This section simply lists the prototypes of the most important functions	216	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	217	quick reference. See the following sections for function-by-function
209	documentation.	218	documentation.
210		219
211	aio_wd $pathname, $callback->($wd)	220	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	221	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	222	aio_close $fh, $callback->($status)
		223	aio_seek $fh,$offset,$whence, $callback->($offs)
214	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	224	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	225	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	226	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217	aio_readahead $fh,$offset,$length, $callback->($retval)	227	aio_readahead $fh,$offset,$length, $callback->($retval)
218	aio_stat $fh_or_path, $callback->($status)	228	aio_stat $fh_or_path, $callback->($status)
219	aio_lstat $fh, $callback->($status)	229	aio_lstat $fh, $callback->($status)
220	aio_statvfs $fh_or_path, $callback->($statvfs)	230	aio_statvfs $fh_or_path, $callback->($statvfs)
221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	231	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	232	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		233	aio_chmod $fh_or_path, $mode, $callback->($status)
223	aio_truncate $fh_or_path, $offset, $callback->($status)	234	aio_truncate $fh_or_path, $offset, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	235	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		236	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225	aio_unlink $pathname, $callback->($status)	237	aio_unlink $pathname, $callback->($status)
226	aio_mknod $path, $mode, $dev, $callback->($status)	238	aio_mknod $pathname, $mode, $dev, $callback->($status)
227	aio_link $srcpath, $dstpath, $callback->($status)	239	aio_link $srcpath, $dstpath, $callback->($status)
228	aio_symlink $srcpath, $dstpath, $callback->($status)	240	aio_symlink $srcpath, $dstpath, $callback->($status)
229	aio_readlink $path, $callback->($link)	241	aio_readlink $pathname, $callback->($link)
230	aio_realpath $path, $callback->($link)	242	aio_realpath $pathname, $callback->($path)
231	aio_rename $srcpath, $dstpath, $callback->($status)	243	aio_rename $srcpath, $dstpath, $callback->($status)
		244	aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
232	aio_mkdir $pathname, $mode, $callback->($status)	245	aio_mkdir $pathname, $mode, $callback->($status)
233	aio_rmdir $pathname, $callback->($status)	246	aio_rmdir $pathname, $callback->($status)
234	aio_readdir $pathname, $callback->($entries)	247	aio_readdir $pathname, $callback->($entries)
235	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	248	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	249	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN	250	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		251	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238	aio_load $path, $data, $callback->($status)	252	aio_load $pathname, $data, $callback->($status)
239	aio_copy $srcpath, $dstpath, $callback->($status)	253	aio_copy $srcpath, $dstpath, $callback->($status)
240	aio_move $srcpath, $dstpath, $callback->($status)	254	aio_move $srcpath, $dstpath, $callback->($status)
241	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
242	aio_rmtree $path, $callback->($status)	255	aio_rmtree $pathname, $callback->($status)
		256	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		257	aio_ioctl $fh, $request, $buf, $callback->($status)
243	aio_sync $callback->($status)	258	aio_sync $callback->($status)
244	aio_syncfs $fh, $callback->($status)	259	aio_syncfs $fh, $callback->($status)
245	aio_fsync $fh, $callback->($status)	260	aio_fsync $fh, $callback->($status)
246	aio_fdatasync $fh, $callback->($status)	261	aio_fdatasync $fh, $callback->($status)
247	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	262	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248	aio_pathsync $path, $callback->($status)	263	aio_pathsync $pathname, $callback->($status)
249	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	264	aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
250	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	265	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	266	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252	aio_mlockall $flags, $callback->($status)	267	aio_mlockall $flags, $callback->($status)
253	aio_group $callback->(...)	268	aio_group $callback->(...)
254	aio_nop $callback->()	269	aio_nop $callback->()
…		…
268	IO::AIO::idle_timeout $seconds	283	IO::AIO::idle_timeout $seconds
269	IO::AIO::max_outstanding $maxreqs	284	IO::AIO::max_outstanding $maxreqs
270	IO::AIO::nreqs	285	IO::AIO::nreqs
271	IO::AIO::nready	286	IO::AIO::nready
272	IO::AIO::npending	287	IO::AIO::npending
		288	IO::AIO::reinit
		289
		290	$nfd = IO::AIO::get_fdlimit
		291	IO::AIO::min_fdlimit $nfd
273		292
274	IO::AIO::sendfile $ofh, $ifh, $offset, $count	293	IO::AIO::sendfile $ofh, $ifh, $offset, $count
275	IO::AIO::fadvise $fh, $offset, $len, $advice	294	IO::AIO::fadvise $fh, $offset, $len, $advice
		295	IO::AIO::fexecve $fh, $argv, $envp
		296
		297	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		298	IO::AIO::munmap $scalar
		299	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
276	IO::AIO::madvise $scalar, $offset, $length, $advice	300	IO::AIO::madvise $scalar, $offset, $length, $advice
277	IO::AIO::mprotect $scalar, $offset, $length, $protect	301	IO::AIO::mprotect $scalar, $offset, $length, $protect
278	IO::AIO::munlock $scalar, $offset = 0, $length = undef	302	IO::AIO::munlock $scalar, $offset = 0, $length = undef
279	IO::AIO::munlockall	303	IO::AIO::munlockall
280		304
281	=head2 AIO REQUEST FUNCTIONS	305	# stat extensions
		306	$counter = IO::AIO::st_gen
		307	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		308	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		309	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		310	$seconds = IO::AIO::st_btimesec
		311	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		312
		313	# very much unportable syscalls
		314	IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
		315	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		316	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		317
		318	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		319	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		320
		321	$fh = IO::AIO::eventfd [$initval, [$flags]]
		322	$fh = IO::AIO::memfd_create $pathname[, $flags]
		323
		324	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		325	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		326	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		327
		328	$fh = IO::AIO::pidfd_open $pid[, $flags]
		329	$status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		330	$fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		331
		332	$retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		333	$retval = IO::AIO::umount $path, $flags = 0
		334
		335	=head2 API NOTES
282		336
283	All the C<aio_*> calls are more or less thin wrappers around the syscall	337	All the C<aio_*> calls are more or less thin wrappers around the syscall
284	with the same name (sans C<aio_>). The arguments are similar or identical,	338	with the same name (sans C<aio_>). The arguments are similar or identical,
285	and they all accept an additional (and optional) C<$callback> argument	339	and they all accept an additional (and optional) C<$callback> argument
286	which must be a code reference. This code reference will get called with	340	which must be a code reference. This code reference will be called after
287	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	341	the syscall has been executed in an asynchronous fashion. The results
288	perl, which usually delivers "false") as its sole argument after the given	342	of the request will be passed as arguments to the callback (and, if an
289	syscall has been executed asynchronously.	343	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		344	most syscalls return C<-1> on error, unlike perl, which usually delivers
		345	"false").
		346
		347	Some requests (such as C<aio_readdir>) pass the actual results and
		348	communicate failures by passing C<undef>.
290		349
291	All functions expecting a filehandle keep a copy of the filehandle	350	All functions expecting a filehandle keep a copy of the filehandle
292	internally until the request has finished.	351	internally until the request has finished.
293		352
294	All functions return request objects of type L<IO::AIO::REQ> that allow	353	All functions return request objects of type L<IO::AIO::REQ> that allow
295	further manipulation of those requests while they are in-flight.	354	further manipulation of those requests while they are in-flight.
296		355
297	The pathnames you pass to these routines I<must> be absolute and	356	The pathnames you pass to these routines I<should> be absolute. The
298	encoded as octets. The reason for the former is that at the time the	357	reason for this is that at the time the request is being executed, the
299	request is being executed, the current working directory could have	358	current working directory could have changed. Alternatively, you can
300	changed. Alternatively, you can make sure that you never change the	359	make sure that you never change the current working directory anywhere
301	current working directory anywhere in the program and then use relative	360	in the program and then use relative paths. You can also take advantage
302	paths.	361	of IO::AIOs working directory abstraction, that lets you specify paths
		362	relative to some previously-opened "working directory object" - see the
		363	description of the C<IO::AIO::WD> class later in this document.
303		364
304	To encode pathnames as octets, either make sure you either: a) always pass	365	To encode pathnames as octets, either make sure you either: a) always pass
305	in filenames you got from outside (command line, readdir etc.) without	366	in filenames you got from outside (command line, readdir etc.) without
306	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	367	tinkering, b) are in your native filesystem encoding, c) use the Encode
307	your pathnames to the locale (or other) encoding in effect in the user	368	module and encode your pathnames to the locale (or other) encoding in
308	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	369	effect in the user environment, d) use Glib::filename_from_unicode on
309	use something else to ensure your scalar has the correct contents.	370	unicode filenames or e) use something else to ensure your scalar has the
		371	correct contents.
310		372
311	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	373	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
312	handles correctly whether it is set or not.	374	handles correctly whether it is set or not.
		375
		376	=head2 AIO REQUEST FUNCTIONS
313		377
314	=over 4	378	=over 4
315		379
316	=item $prev_pri = aioreq_pri [$pri]	380	=item $prev_pri = aioreq_pri [$pri]
317		381
…		…
347		411
348		412
349	=item aio_open $pathname, $flags, $mode, $callback->($fh)	413	=item aio_open $pathname, $flags, $mode, $callback->($fh)
350		414
351	Asynchronously open or create a file and call the callback with a newly	415	Asynchronously open or create a file and call the callback with a newly
352	created filehandle for the file.	416	created filehandle for the file (or C<undef> in case of an error).
353
354	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
355	for an explanation.
356		417
357	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	418	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
358	list. They are the same as used by C<sysopen>.	419	list. They are the same as used by C<sysopen>.
359		420
360	Likewise, C<$mode> specifies the mode of the newly created file, if it	421	Likewise, C<$mode> specifies the mode of the newly created file, if it
…		…
380	following POSIX and non-POSIX constants are available (missing ones on	441	following POSIX and non-POSIX constants are available (missing ones on
381	your system are, as usual, C<0>):	442	your system are, as usual, C<0>):
382		443
383	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	444	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
384	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	445	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
385	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.	446	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
386		447
387		448
388	=item aio_close $fh, $callback->($status)	449	=item aio_close $fh, $callback->($status)
389		450
390	Asynchronously close a file and call the callback with the result	451	Asynchronously close a file and call the callback with the result
…		…
400	Or in other words: the file descriptor will be closed, but it will not be	461	Or in other words: the file descriptor will be closed, but it will not be
401	free for reuse until the perl filehandle is closed.	462	free for reuse until the perl filehandle is closed.
402		463
403	=cut	464	=cut
404		465
		466	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		467
		468	Seeks the filehandle to the new C<$offset>, similarly to perl's
		469	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		470	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		471	C<IO::AIO::SEEK_END>).
		472
		473	The resulting absolute offset will be passed to the callback, or C<-1> in
		474	case of an error.
		475
		476	In theory, the C<$whence> constants could be different than the
		477	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		478	so don't panic.
		479
		480	As a GNU/Linux (and maybe Solaris) extension, also the constants
		481	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		482	could be found. No guarantees about suitability for use in C<aio_seek> or
		483	Perl's C<sysseek> can be made though, although I would naively assume they
		484	"just work".
		485
405	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	486	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
406		487
407	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	488	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
408		489
409	Reads or writes C<$length> bytes from or to the specified C<$fh> and	490	Reads or writes C<$length> bytes from or to the specified C<$fh> and
410	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	491	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
411	and calls the callback without the actual number of bytes read (or -1 on	492	calls the callback with the actual number of bytes transferred (or -1 on
412	error, just like the syscall).	493	error, just like the syscall).
413		494
414	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	495	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
415	offset plus the actual number of bytes read.	496	offset plus the actual number of bytes read.
416		497
…		…
474	As native sendfile syscalls (as practically any non-POSIX interface hacked	555	As native sendfile syscalls (as practically any non-POSIX interface hacked
475	together in a hurry to improve benchmark numbers) tend to be rather buggy	556	together in a hurry to improve benchmark numbers) tend to be rather buggy
476	on many systems, this implementation tries to work around some known bugs	557	on many systems, this implementation tries to work around some known bugs
477	in Linux and FreeBSD kernels (probably others, too), but that might fail,	558	in Linux and FreeBSD kernels (probably others, too), but that might fail,
478	so you really really should check the return value of C<aio_sendfile> -	559	so you really really should check the return value of C<aio_sendfile> -
479	fewre bytes than expected might have been transferred.	560	fewer bytes than expected might have been transferred.
480		561
481		562
482	=item aio_readahead $fh,$offset,$length, $callback->($retval)	563	=item aio_readahead $fh,$offset,$length, $callback->($retval)
483		564
484	C<aio_readahead> populates the page cache with data from a file so that	565	C<aio_readahead> populates the page cache with data from a file so that
…		…
488	whole pages, so that offset is effectively rounded down to a page boundary	569	whole pages, so that offset is effectively rounded down to a page boundary
489	and bytes are read up to the next page boundary greater than or equal to	570	and bytes are read up to the next page boundary greater than or equal to
490	(off-set+length). C<aio_readahead> does not read beyond the end of the	571	(off-set+length). C<aio_readahead> does not read beyond the end of the
491	file. The current file offset of the file is left unchanged.	572	file. The current file offset of the file is left unchanged.
492		573
493	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	574	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
494	emulated by simply reading the data, which would have a similar effect.	575	be emulated by simply reading the data, which would have a similar effect.
495		576
496		577
497	=item aio_stat $fh_or_path, $callback->($status)	578	=item aio_stat $fh_or_path, $callback->($status)
498		579
499	=item aio_lstat $fh, $callback->($status)	580	=item aio_lstat $fh, $callback->($status)
500		581
501	Works like perl's C<stat> or C<lstat> in void context. The callback will	582	Works almost exactly like perl's C<stat> or C<lstat> in void context. The
502	be called after the stat and the results will be available using C<stat _>	583	callback will be called after the stat and the results will be available
503	or C<-s _> etc...	584	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
504		585	and C<-T>).
505	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
506	for an explanation.
507		586
508	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	587	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
509	error when stat'ing a large file, the results will be silently truncated	588	error when stat'ing a large file, the results will be silently truncated
510	unless perl itself is compiled with large file support.	589	unless perl itself is compiled with large file support.
511		590
…		…
515	behaviour).	594	behaviour).
516		595
517	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	596	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
518	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,	597	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
519	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.	598	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		599
		600	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		601	ACCESS>.
520		602
521	Example: Print the length of F</etc/passwd>:	603	Example: Print the length of F</etc/passwd>:
522		604
523	aio_stat "/etc/passwd", sub {	605	aio_stat "/etc/passwd", sub {
524	$_[0] and die "stat failed: $!";	606	$_[0] and die "stat failed: $!";
…		…
568	namemax => 255,	650	namemax => 255,
569	frsize => 1024,	651	frsize => 1024,
570	fsid => 1810	652	fsid => 1810
571	}	653	}
572		654
573
574	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	655	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
575		656
576	Works like perl's C<utime> function (including the special case of $atime	657	Works like perl's C<utime> function (including the special case of $atime
577	and $mtime being undef). Fractional times are supported if the underlying	658	and $mtime being undef). Fractional times are supported if the underlying
578	syscalls support them.	659	syscalls support them.
579		660
580	When called with a pathname, uses utimes(2) if available, otherwise	661	When called with a pathname, uses utimensat(2) or utimes(2) if available,
581	utime(2). If called on a file descriptor, uses futimes(2) if available,	662	otherwise utime(2). If called on a file descriptor, uses futimens(2)
582	otherwise returns ENOSYS, so this is not portable.	663	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		664	portable.
583		665
584	Examples:	666	Examples:
585		667
586	# set atime and mtime to current time (basically touch(1)):	668	# set atime and mtime to current time (basically touch(1)):
587	aio_utime "path", undef, undef;	669	aio_utime "path", undef, undef;
…		…
605	=item aio_truncate $fh_or_path, $offset, $callback->($status)	687	=item aio_truncate $fh_or_path, $offset, $callback->($status)
606		688
607	Works like truncate(2) or ftruncate(2).	689	Works like truncate(2) or ftruncate(2).
608		690
609		691
		692	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		693
		694	Allocates or frees disk space according to the C<$mode> argument. See the
		695	linux C<fallocate> documentation for details.
		696
		697	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		698	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
		699	to deallocate a file range.
		700
		701	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		702	(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
		703	C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
		704	to unshare shared blocks (see your L<fallocate(2)> manpage).
		705
		706	The file system block size used by C<fallocate> is presumably the
		707	C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
		708	can dictate other limitations.
		709
		710	If C<fallocate> isn't available or cannot be emulated (currently no
		711	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		712
		713
610	=item aio_chmod $fh_or_path, $mode, $callback->($status)	714	=item aio_chmod $fh_or_path, $mode, $callback->($status)
611		715
612	Works like perl's C<chmod> function.	716	Works like perl's C<chmod> function.
613		717
614		718
…		…
616		720
617	Asynchronously unlink (delete) a file and call the callback with the	721	Asynchronously unlink (delete) a file and call the callback with the
618	result code.	722	result code.
619		723
620		724
621	=item aio_mknod $path, $mode, $dev, $callback->($status)	725	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
622		726
623	[EXPERIMENTAL]	727	[EXPERIMENTAL]
624		728
625	Asynchronously create a device node (or fifo). See mknod(2).	729	Asynchronously create a device node (or fifo). See mknod(2).
626		730
627	The only (POSIX-) portable way of calling this function is:	731	The only (POSIX-) portable way of calling this function is:
628		732
629	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	733	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
630		734
631	See C<aio_stat> for info about some potentially helpful extra constants	735	See C<aio_stat> for info about some potentially helpful extra constants
632	and functions.	736	and functions.
633		737
634	=item aio_link $srcpath, $dstpath, $callback->($status)	738	=item aio_link $srcpath, $dstpath, $callback->($status)
…		…
641		745
642	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	746	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
643	the path C<$dstpath> and call the callback with the result code.	747	the path C<$dstpath> and call the callback with the result code.
644		748
645		749
646	=item aio_readlink $path, $callback->($link)	750	=item aio_readlink $pathname, $callback->($link)
647		751
648	Asynchronously read the symlink specified by C<$path> and pass it to	752	Asynchronously read the symlink specified by C<$path> and pass it to
649	the callback. If an error occurs, nothing or undef gets passed to the	753	the callback. If an error occurs, nothing or undef gets passed to the
650	callback.	754	callback.
651		755
652		756
653	=item aio_realpath $path, $callback->($path)	757	=item aio_realpath $pathname, $callback->($path)
654		758
655	Asynchronously make the path absolute and resolve any symlinks in	759	Asynchronously make the path absolute and resolve any symlinks in
656	C<$path>. The resulting path only consists of directories (Same as	760	C<$path>. The resulting path only consists of directories (same as
657	L<Cwd::realpath>).	761	L<Cwd::realpath>).
658		762
659	This request can be used to get the absolute path of the current working	763	This request can be used to get the absolute path of the current working
660	directory by passing it a path of F<.> (a single dot).	764	directory by passing it a path of F<.> (a single dot).
661		765
662		766
663	=item aio_rename $srcpath, $dstpath, $callback->($status)	767	=item aio_rename $srcpath, $dstpath, $callback->($status)
664		768
665	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	769	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
666	rename(2) and call the callback with the result code.	770	rename(2) and call the callback with the result code.
		771
		772	On systems that support the AIO::WD working directory abstraction
		773	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		774	of failing, C<rename> is called on the absolute path of C<$wd>.
		775
		776
		777	=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
		778
		779	Basically a version of C<aio_rename> with an additional C<$flags>
		780	argument. Calling this with C<$flags=0> is the same as calling
		781	C<aio_rename>.
		782
		783	Non-zero flags are currently only supported on GNU/Linux systems that
		784	support renameat2. Other systems fail with C<ENOSYS> in this case.
		785
		786	The following constants are available (missing ones are, as usual C<0>),
		787	see renameat2(2) for details:
		788
		789	C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
		790	and C<IO::AIO::RENAME_WHITEOUT>.
667		791
668		792
669	=item aio_mkdir $pathname, $mode, $callback->($status)	793	=item aio_mkdir $pathname, $mode, $callback->($status)
670		794
671	Asynchronously mkdir (create) a directory and call the callback with	795	Asynchronously mkdir (create) a directory and call the callback with
…		…
676	=item aio_rmdir $pathname, $callback->($status)	800	=item aio_rmdir $pathname, $callback->($status)
677		801
678	Asynchronously rmdir (delete) a directory and call the callback with the	802	Asynchronously rmdir (delete) a directory and call the callback with the
679	result code.	803	result code.
680		804
		805	On systems that support the AIO::WD working directory abstraction
		806	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		807	C<rmdir> is called on the absolute path of C<$wd>.
		808
681		809
682	=item aio_readdir $pathname, $callback->($entries)	810	=item aio_readdir $pathname, $callback->($entries)
683		811
684	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	812	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
685	directory (i.e. opendir + readdir + closedir). The entries will not be	813	directory (i.e. opendir + readdir + closedir). The entries will not be
…		…
700		828
701	=over 4	829	=over 4
702		830
703	=item IO::AIO::READDIR_DENTS	831	=item IO::AIO::READDIR_DENTS
704		832
705	When this flag is off, then the callback gets an arrayref consisting of	833	Normally the callback gets an arrayref consisting of names only (as
706	names only (as with C<aio_readdir>), otherwise it gets an arrayref with	834	with C<aio_readdir>). If this flag is set, then the callback gets an
707	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	835	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
708	entry in more detail.	836	single directory entry in more detail:
709		837
710	C<$name> is the name of the entry.	838	C<$name> is the name of the entry.
711		839
712	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	840	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
713		841
714	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	842	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
715	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,	843	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
716	C<IO::AIO::DT_WHT>.	844	C<IO::AIO::DT_WHT>.
717		845
718	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	846	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
719	know, you have to run stat yourself. Also, for speed reasons, the C<$type>	847	to know, you have to run stat yourself. Also, for speed/memory reasons,
720	scalars are read-only: you can not modify them.	848	the C<$type> scalars are read-only: you must not modify them.
721		849
722	C<$inode> is the inode number (which might not be exact on systems with 64	850	C<$inode> is the inode number (which might not be exact on systems with 64
723	bit inode numbers and 32 bit perls). This field has unspecified content on	851	bit inode numbers and 32 bit perls). This field has unspecified content on
724	systems that do not deliver the inode information.	852	systems that do not deliver the inode information.
725		853
…		…
736	short names are tried first.	864	short names are tried first.
737		865
738	=item IO::AIO::READDIR_STAT_ORDER	866	=item IO::AIO::READDIR_STAT_ORDER
739		867
740	When this flag is set, then the names will be returned in an order	868	When this flag is set, then the names will be returned in an order
741	suitable for stat()'ing each one. That is, when you plan to stat()	869	suitable for stat()'ing each one. That is, when you plan to stat() most or
742	all files in the given directory, then the returned order will likely	870	all files in the given directory, then the returned order will likely be
743	be fastest.	871	faster.
744		872
745	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	873	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
746	the likely dirs come first, resulting in a less optimal stat order.	874	then the likely dirs come first, resulting in a less optimal stat order
		875	for stat'ing all entries, but likely a more optimal order for finding
		876	subdirectories.
747		877
748	=item IO::AIO::READDIR_FOUND_UNKNOWN	878	=item IO::AIO::READDIR_FOUND_UNKNOWN
749		879
750	This flag should not be set when calling C<aio_readdirx>. Instead, it	880	This flag should not be set when calling C<aio_readdirx>. Instead, it
751	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	881	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
753	C<$type>'s are known, which can be used to speed up some algorithms.	883	C<$type>'s are known, which can be used to speed up some algorithms.
754		884
755	=back	885	=back
756		886
757		887
		888	=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
		889
		890	Opens, reads and closes the given file. The data is put into C<$data>,
		891	which is resized as required.
		892
		893	If C<$offset> is negative, then it is counted from the end of the file.
		894
		895	If C<$length> is zero, then the remaining length of the file is
		896	used. Also, in this case, the same limitations to modifying C<$data> apply
		897	as when IO::AIO::mmap is used, i.e. it must only be modified in-place
		898	with C<substr>. If the size of the file is known, specifying a non-zero
		899	C<$length> results in a performance advantage.
		900
		901	This request is similar to the older C<aio_load> request, but since it is
		902	a single request, it might be more efficient to use.
		903
		904	Example: load F</etc/passwd> into C<$passwd>.
		905
		906	my $passwd;
		907	aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
		908	$_[0] >= 0
		909	or die "/etc/passwd: $!\n";
		910
		911	printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
		912	print $passwd;
		913	};
		914	IO::AIO::flush;
		915
		916
758	=item aio_load $path, $data, $callback->($status)	917	=item aio_load $pathname, $data, $callback->($status)
759		918
760	This is a composite request that tries to fully load the given file into	919	This is a composite request that tries to fully load the given file into
761	memory. Status is the same as with aio_read.	920	memory. Status is the same as with aio_read.
		921
		922	Using C<aio_slurp> might be more efficient, as it is a single request.
762		923
763	=cut	924	=cut
764		925
765	sub aio_load($$;$) {	926	sub aio_load($$;$) {
766	my ($path, undef, $cb) = @_;	927	my ($path, undef, $cb) = @_;
…		…
786	=item aio_copy $srcpath, $dstpath, $callback->($status)	947	=item aio_copy $srcpath, $dstpath, $callback->($status)
787		948
788	Try to copy the I<file> (directories not supported as either source or	949	Try to copy the I<file> (directories not supported as either source or
789	destination) from C<$srcpath> to C<$dstpath> and call the callback with	950	destination) from C<$srcpath> to C<$dstpath> and call the callback with
790	a status of C<0> (ok) or C<-1> (error, see C<$!>).	951	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		952
		953	Existing destination files will be truncated.
791		954
792	This is a composite request that creates the destination file with	955	This is a composite request that creates the destination file with
793	mode 0200 and copies the contents of the source file into it using	956	mode 0200 and copies the contents of the source file into it using
794	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	957	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
795	uid/gid, in that order.	958	uid/gid, in that order.
…		…
898	};	1061	};
899		1062
900	$grp	1063	$grp
901	}	1064	}
902		1065
903	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1066	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
904		1067
905	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1068	Scans a directory (similar to C<aio_readdir>) but additionally tries to
906	efficiently separate the entries of directory C<$path> into two sets of	1069	efficiently separate the entries of directory C<$path> into two sets of
907	names, directories you can recurse into (directories), and ones you cannot	1070	names, directories you can recurse into (directories), and ones you cannot
908	recurse into (everything else, including symlinks to directories).	1071	recurse into (everything else, including symlinks to directories).
909		1072
910	C<aio_scandir> is a composite request that creates of many sub requests_	1073	C<aio_scandir> is a composite request that generates many sub requests.
911	C<$maxreq> specifies the maximum number of outstanding aio requests that	1074	C<$maxreq> specifies the maximum number of outstanding aio requests that
912	this function generates. If it is C<< <= 0 >>, then a suitable default	1075	this function generates. If it is C<< <= 0 >>, then a suitable default
913	will be chosen (currently 4).	1076	will be chosen (currently 4).
914		1077
915	On error, the callback is called without arguments, otherwise it receives	1078	On error, the callback is called without arguments, otherwise it receives
…		…
965		1128
966	my $grp = aio_group $cb;	1129	my $grp = aio_group $cb;
967		1130
968	$maxreq = 4 if $maxreq <= 0;	1131	$maxreq = 4 if $maxreq <= 0;
969		1132
970	# stat once	1133	# get a wd object
971	aioreq_pri $pri;	1134	aioreq_pri $pri;
972	add $grp aio_stat $path, sub {	1135	add $grp aio_wd $path, sub {
		1136	$_[0]
973	return $grp->result () if $_[0];	1137	or return $grp->result ();
974	my $now = time;
975	my $hash1 = join ":", (stat _)[0,1,3,7,9];
976		1138
977	# read the directory entries	1139	my $wd = [shift, "."];
		1140
		1141	# stat once
978	aioreq_pri $pri;	1142	aioreq_pri $pri;
979	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {	1143	add $grp aio_stat $wd, sub {
980	my $entries = shift
981	or return $grp->result ();	1144	return $grp->result () if $_[0];
		1145	my $now = time;
		1146	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1147	my $rdxflags = READDIR_DIRS_FIRST;
982		1148
983	# stat the dir another time	1149	if ((stat _)[3] < 2) {
		1150	# at least one non-POSIX filesystem exists
		1151	# that returns useful DT_type values: btrfs,
		1152	# so optimise for this here by requesting dents
		1153	$rdxflags |= READDIR_DENTS;
		1154	}
		1155
		1156	# read the directory entries
984	aioreq_pri $pri;	1157	aioreq_pri $pri;
985	add $grp aio_stat $path, sub {	1158	add $grp aio_readdirx $wd, $rdxflags, sub {
986	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1159	my ($entries, $flags) = @_
		1160	or return $grp->result ();
987		1161
		1162	if ($rdxflags & READDIR_DENTS) {
		1163	# if we requested type values, see if we can use them directly.
		1164
		1165	# if there were any DT_UNKNOWN entries then we assume we
		1166	# don't know. alternatively, we could assume that if we get
		1167	# one DT_DIR, then all directories are indeed marked with
		1168	# DT_DIR, but this seems not required for btrfs, and this
		1169	# is basically the "btrfs can't get it's act together" code
		1170	# branch.
		1171	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1172	# now we have valid DT_ information for all entries,
		1173	# so use it as an optimisation without further stat's.
		1174	# they must also all be at the beginning of @$entries
		1175	# by now.
		1176
988	my $ndirs;	1177	my $dirs;
989		1178
990	# take the slow route if anything looks fishy
991	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
992	$ndirs = -1;
993	} else {
994	# if nlink == 2, we are finished
995	# for non-posix-fs's, we rely on nlink < 2
996	$ndirs = (stat _)[3] - 2
997	or return $grp->result ([], $entries);
998	}
999
1000	my (@dirs, @nondirs);
1001
1002	my $statgrp = add $grp aio_group sub {
1003	$grp->result (\@dirs, \@nondirs);
1004	};
1005
1006	limit $statgrp $maxreq;
1007	feed $statgrp sub {
1008	return unless @$entries;
1009	my $entry = shift @$entries;
1010
1011	aioreq_pri $pri;
1012	add $statgrp aio_stat "$path/$entry/.", sub {
1013	if ($_[0] < 0) {	1179	if (@$entries) {
1014	push @nondirs, $entry;	1180	for (0 .. $#$entries) {
1015	} else {	1181	if ($entries->[$_][1] != DT_DIR) {
1016	# need to check for real directory	1182	# splice out directories
1017	aioreq_pri $pri;	1183	$dirs = [splice @$entries, 0, $_];
1018	add $statgrp aio_lstat "$path/$entry", sub {
1019	if (-d _) {
1020	push @dirs, $entry;
1021
1022	unless (--$ndirs) {
1023	push @nondirs, @$entries;
1024	feed $statgrp;
1025	}	1184	last;
1026	} else {
1027	push @nondirs, $entry;
1028	}	1185	}
1029	}	1186	}
		1187
		1188	# if we didn't find any non-dir, then all entries are dirs
		1189	unless ($dirs) {
		1190	($dirs, $entries) = ($entries, []);
		1191	}
		1192	} else {
		1193	# directory is empty, so there are no sbdirs
		1194	$dirs = [];
1030	}	1195	}
		1196
		1197	# either splice'd the directories out or the dir was empty.
		1198	# convert dents to filenames
		1199	$_ = $_->[0] for @$dirs;
		1200	$_ = $_->[0] for @$entries;
		1201
		1202	return $grp->result ($dirs, $entries);
		1203	}
		1204
		1205	# cannot use, so return to our old ways
		1206	# by pretending we only scanned for names.
		1207	$_ = $_->[0] for @$entries;
		1208	}
		1209
		1210	# stat the dir another time
		1211	aioreq_pri $pri;
		1212	add $grp aio_stat $wd, sub {
		1213	my $hash2 = join ":", (stat _)[0,1,3,7,9];
		1214
		1215	my $ndirs;
		1216
		1217	# take the slow route if anything looks fishy
		1218	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
		1219	$ndirs = -1;
		1220	} else {
		1221	# if nlink == 2, we are finished
		1222	# for non-posix-fs's, we rely on nlink < 2
		1223	$ndirs = (stat _)[3] - 2
		1224	or return $grp->result ([], $entries);
		1225	}
		1226
		1227	my (@dirs, @nondirs);
		1228
		1229	my $statgrp = add $grp aio_group sub {
		1230	$grp->result (\@dirs, \@nondirs);
		1231	};
		1232
		1233	limit $statgrp $maxreq;
		1234	feed $statgrp sub {
		1235	return unless @$entries;
		1236	my $entry = shift @$entries;
		1237
		1238	aioreq_pri $pri;
		1239	$wd->[1] = "$entry/.";
		1240	add $statgrp aio_stat $wd, sub {
		1241	if ($_[0] < 0) {
		1242	push @nondirs, $entry;
		1243	} else {
		1244	# need to check for real directory
		1245	aioreq_pri $pri;
		1246	$wd->[1] = $entry;
		1247	add $statgrp aio_lstat $wd, sub {
		1248	if (-d _) {
		1249	push @dirs, $entry;
		1250
		1251	unless (--$ndirs) {
		1252	push @nondirs, @$entries;
		1253	feed $statgrp;
		1254	}
		1255	} else {
		1256	push @nondirs, $entry;
		1257	}
		1258	}
		1259	}
		1260	};
1031	};	1261	};
1032	};	1262	};
1033	};	1263	};
1034	};	1264	};
1035	};	1265	};
1036		1266
1037	$grp	1267	$grp
1038	}	1268	}
1039		1269
1040	=item aio_rmtree $path, $callback->($status)	1270	=item aio_rmtree $pathname, $callback->($status)
1041		1271
1042	Delete a directory tree starting (and including) C<$path>, return the	1272	Delete a directory tree starting (and including) C<$path>, return the
1043	status of the final C<rmdir> only. This is a composite request that	1273	status of the final C<rmdir> only. This is a composite request that
1044	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1274	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1045	everything else.	1275	everything else.
1046		1276
1047	=cut	1277	=cut
1048		1278
…		…
1070	};	1300	};
1071		1301
1072	$grp	1302	$grp
1073	}	1303	}
1074		1304
		1305	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1306
		1307	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1308
		1309	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1310	they execute asynchronously and pass the return value to the callback.
		1311
		1312	Both calls can be used for a lot of things, some of which make more sense
		1313	to run asynchronously in their own thread, while some others make less
		1314	sense. For example, calls that block waiting for external events, such
		1315	as locking, will also lock down an I/O thread while it is waiting, which
		1316	can deadlock the whole I/O system. At the same time, there might be no
		1317	alternative to using a thread to wait.
		1318
		1319	So in general, you should only use these calls for things that do
		1320	(filesystem) I/O, not for things that wait for other events (network,
		1321	other processes), although if you are careful and know what you are doing,
		1322	you still can.
		1323
		1324	The following constants are available and can be used for normal C<ioctl>
		1325	and C<fcntl> as well (missing ones are, as usual C<0>):
		1326
		1327	C<F_DUPFD_CLOEXEC>,
		1328
		1329	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
		1330
		1331	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1332
		1333	C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
		1334	C<F_SEAL_WRITE>.
		1335
		1336	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1337	C<FS_IOC_FIEMAP>.
		1338
		1339	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1340	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1341
		1342	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1343	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1344	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1345	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1346	C<FS_FL_USER_MODIFIABLE>.
		1347
		1348	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1349	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1350	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1351	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
		1352
		1353	C<BLKROSET>, C<BLKROGET>, C<BLKRRPART>, C<BLKGETSIZE>, C<BLKFLSBUF>, C<BLKRASET>,
		1354	C<BLKRAGET>, C<BLKFRASET>, C<BLKFRAGET>, C<BLKSECTSET>, C<BLKSECTGET>, C<BLKSSZGET>,
		1355	C<BLKBSZGET>, C<BLKBSZSET>, C<BLKGETSIZE64>,
		1356
		1357
1075	=item aio_sync $callback->($status)	1358	=item aio_sync $callback->($status)
1076		1359
1077	Asynchronously call sync and call the callback when finished.	1360	Asynchronously call sync and call the callback when finished.
1078		1361
1079	=item aio_fsync $fh, $callback->($status)	1362	=item aio_fsync $fh, $callback->($status)
…		…
1106	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,	1389	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1107	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and	1390	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1108	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range	1391	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1109	manpage for details.	1392	manpage for details.
1110		1393
1111	=item aio_pathsync $path, $callback->($status)	1394	=item aio_pathsync $pathname, $callback->($status)
1112		1395
1113	This request tries to open, fsync and close the given path. This is a	1396	This request tries to open, fsync and close the given path. This is a
1114	composite request intended to sync directories after directory operations	1397	composite request intended to sync directories after directory operations
1115	(E.g. rename). This might not work on all operating systems or have any	1398	(E.g. rename). This might not work on all operating systems or have any
1116	specific effect, but usually it makes sure that directory changes get	1399	specific effect, but usually it makes sure that directory changes get
…		…
1147	};	1430	};
1148		1431
1149	$grp	1432	$grp
1150	}	1433	}
1151		1434
1152	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1435	=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1153		1436
1154	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1437	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1155	scalars (see the C<IO::AIO::mmap> function, although it also works on data	1438	scalars (see the C<IO::AIO::mmap> function, although it also works on data
1156	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the	1439	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1157	scalar must only be modified in-place while an aio operation is pending on	1440	scalar must only be modified in-place while an aio operation is pending on
…		…
1159		1442
1160	It calls the C<msync> function of your OS, if available, with the memory	1443	It calls the C<msync> function of your OS, if available, with the memory
1161	area starting at C<$offset> in the string and ending C<$length> bytes	1444	area starting at C<$offset> in the string and ending C<$length> bytes
1162	later. If C<$length> is negative, counts from the end, and if C<$length>	1445	later. If C<$length> is negative, counts from the end, and if C<$length>
1163	is C<undef>, then it goes till the end of the string. The flags can be	1446	is C<undef>, then it goes till the end of the string. The flags can be
1164	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and	1447	either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1165	C<IO::AIO::MS_SYNC>.	1448	C<IO::AIO::MS_INVALIDATE>.
1166		1449
1167	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1450	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1168		1451
1169	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1452	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1170	scalars.	1453	scalars.
1171		1454
1172	It touches (reads or writes) all memory pages in the specified	1455	It touches (reads or writes) all memory pages in the specified
1173	range inside the scalar. All caveats and parameters are the same	1456	range inside the scalar. All caveats and parameters are the same
1174	as for C<aio_msync>, above, except for flags, which must be either	1457	as for C<aio_msync>, above, except for flags, which must be either
1175	C<0> (which reads all pages and ensures they are instantiated) or	1458	C<0> (which reads all pages and ensures they are instantiated) or
1176	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1459	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1177	writing an octet from it, which dirties the page).	1460	writing an octet from it, which dirties the page).
1178		1461
1179	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1462	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1180		1463
1181	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1464	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1200	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1483	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1201	aio_mlock $data; # mlock in background	1484	aio_mlock $data; # mlock in background
1202		1485
1203	=item aio_mlockall $flags, $callback->($status)	1486	=item aio_mlockall $flags, $callback->($status)
1204		1487
1205	Calls the C<mlockall> function with the given C<$flags> (a combination of	1488	Calls the C<mlockall> function with the given C<$flags> (a
1206	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1489	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1490	C<IO::AIO::MCL_ONFAULT>).
1207		1491
1208	On systems that do not implement C<mlockall>, this function returns C<-1>	1492	On systems that do not implement C<mlockall>, this function returns C<-1>
1209	and sets errno to C<ENOSYS>.	1493	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1494	by the system result in a return value of C<-1> with errno being set to
		1495	C<EINVAL>.
1210		1496
1211	Note that the corresponding C<munlockall> is synchronous and is	1497	Note that the corresponding C<munlockall> is synchronous and is
1212	documented under L<MISCELLANEOUS FUNCTIONS>.	1498	documented under L<MISCELLANEOUS FUNCTIONS>.
1213		1499
1214	Example: asynchronously lock all current and future pages into memory.	1500	Example: asynchronously lock all current and future pages into memory.
1215		1501
1216	aio_mlockall IO::AIO::MCL_FUTURE;	1502	aio_mlockall IO::AIO::MCL_FUTURE;
		1503
		1504	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1505
		1506	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1507	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1508	the ioctl is not available on your OS, then this request will fail with
		1509	C<ENOSYS>.
		1510
		1511	C<$start> is the starting offset to query extents for, C<$length> is the
		1512	size of the range to query - if it is C<undef>, then the whole file will
		1513	be queried.
		1514
		1515	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1516	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1517	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1518	the data portion.
		1519
		1520	C<$count> is the maximum number of extent records to return. If it is
		1521	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1522	case, if it is C<0>, then the callback receives the number of extents
		1523	instead of the extents themselves (which is unreliable, see below).
		1524
		1525	If an error occurs, the callback receives no arguments. The special
		1526	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1527
		1528	Otherwise, the callback receives an array reference with extent
		1529	structures. Each extent structure is an array reference itself, with the
		1530	following members:
		1531
		1532	[$logical, $physical, $length, $flags]
		1533
		1534	Flags is any combination of the following flag values (typically either C<0>
		1535	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1536
		1537	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1538	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1539	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1540	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1541	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1542	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1543
		1544	At the time of this writing (Linux 3.2), this request is unreliable unless
		1545	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1546	it to return all extents of a range for files with a large number of
		1547	extents. The code (only) works around all these issues if C<$count> is
		1548	C<undef>.
1217		1549
1218	=item aio_group $callback->(...)	1550	=item aio_group $callback->(...)
1219		1551
1220	This is a very special aio request: Instead of doing something, it is a	1552	This is a very special aio request: Instead of doing something, it is a
1221	container for other aio requests, which is useful if you want to bundle	1553	container for other aio requests, which is useful if you want to bundle
…		…
1258	like sleep and file handle readable/writable, the overhead this creates is	1590	like sleep and file handle readable/writable, the overhead this creates is
1259	immense (it blocks a thread for a long time) so do not use this function	1591	immense (it blocks a thread for a long time) so do not use this function
1260	except to put your application under artificial I/O pressure.	1592	except to put your application under artificial I/O pressure.
1261		1593
1262	=back	1594	=back
		1595
		1596
		1597	=head2 IO::AIO::WD - multiple working directories
		1598
		1599	Your process only has one current working directory, which is used by all
		1600	threads. This makes it hard to use relative paths (some other component
		1601	could call C<chdir> at any time, and it is hard to control when the path
		1602	will be used by IO::AIO).
		1603
		1604	One solution for this is to always use absolute paths. This usually works,
		1605	but can be quite slow (the kernel has to walk the whole path on every
		1606	access), and can also be a hassle to implement.
		1607
		1608	Newer POSIX systems have a number of functions (openat, fdopendir,
		1609	futimensat and so on) that make it possible to specify working directories
		1610	per operation.
		1611
		1612	For portability, and because the clowns who "designed", or shall I write,
		1613	perpetrated this new interface were obviously half-drunk, this abstraction
		1614	cannot be perfect, though.
		1615
		1616	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1617	object. This object stores the canonicalised, absolute version of the
		1618	path, and on systems that allow it, also a directory file descriptor.
		1619
		1620	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1621	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1622	object and a pathname instead (or the IO::AIO::WD object alone, which
		1623	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1624	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1625	to that IO::AIO::WD object.
		1626
		1627	For example, to get a wd object for F</etc> and then stat F<passwd>
		1628	inside, you would write:
		1629
		1630	aio_wd "/etc", sub {
		1631	my $etcdir = shift;
		1632
		1633	# although $etcdir can be undef on error, there is generally no reason
		1634	# to check for errors here, as aio_stat will fail with ENOENT
		1635	# when $etcdir is undef.
		1636
		1637	aio_stat [$etcdir, "passwd"], sub {
		1638	# yay
		1639	};
		1640	};
		1641
		1642	The fact that C<aio_wd> is a request and not a normal function shows that
		1643	creating an IO::AIO::WD object is itself a potentially blocking operation,
		1644	which is why it is done asynchronously.
		1645
		1646	To stat the directory obtained with C<aio_wd> above, one could write
		1647	either of the following three request calls:
		1648
		1649	aio_lstat "/etc" , sub { ... # pathname as normal string
		1650	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1651	aio_lstat $wd , sub { ... # shorthand for the previous
		1652
		1653	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1654	object and the pathname string, so you could write the following without
		1655	causing any issues due to C<$path> getting reused:
		1656
		1657	my $path = [$wd, undef];
		1658
		1659	for my $name (qw(abc def ghi)) {
		1660	$path->[1] = $name;
		1661	aio_stat $path, sub {
		1662	# ...
		1663	};
		1664	}
		1665
		1666	There are some caveats: when directories get renamed (or deleted), the
		1667	pathname string doesn't change, so will point to the new directory (or
		1668	nowhere at all), while the directory fd, if available on the system,
		1669	will still point to the original directory. Most functions accepting a
		1670	pathname will use the directory fd on newer systems, and the string on
		1671	older systems. Some functions (such as C<aio_realpath>) will always rely on
		1672	the string form of the pathname.
		1673
		1674	So this functionality is mainly useful to get some protection against
		1675	C<chdir>, to easily get an absolute path out of a relative path for future
		1676	reference, and to speed up doing many operations in the same directory
		1677	(e.g. when stat'ing all files in a directory).
		1678
		1679	The following functions implement this working directory abstraction:
		1680
		1681	=over 4
		1682
		1683	=item aio_wd $pathname, $callback->($wd)
		1684
		1685	Asynchonously canonicalise the given pathname and convert it to an
		1686	IO::AIO::WD object representing it. If possible and supported on the
		1687	system, also open a directory fd to speed up pathname resolution relative
		1688	to this working directory.
		1689
		1690	If something goes wrong, then C<undef> is passwd to the callback instead
		1691	of a working directory object and C<$!> is set appropriately. Since
		1692	passing C<undef> as working directory component of a pathname fails the
		1693	request with C<ENOENT>, there is often no need for error checking in the
		1694	C<aio_wd> callback, as future requests using the value will fail in the
		1695	expected way.
		1696
		1697	=item IO::AIO::CWD
		1698
		1699	This is a compile time constant (object) that represents the process
		1700	current working directory.
		1701
		1702	Specifying this object as working directory object for a pathname is as if
		1703	the pathname would be specified directly, without a directory object. For
		1704	example, these calls are functionally identical:
		1705
		1706	aio_stat "somefile", sub { ... };
		1707	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1708
		1709	=back
		1710
		1711	To recover the path associated with an IO::AIO::WD object, you can use
		1712	C<aio_realpath>:
		1713
		1714	aio_realpath $wd, sub {
		1715	warn "path is $_[0]\n";
		1716	};
		1717
		1718	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1719	sometimes, fall back to using an absolue path.
1263		1720
1264	=head2 IO::AIO::REQ CLASS	1721	=head2 IO::AIO::REQ CLASS
1265		1722
1266	All non-aggregate C<aio_*> functions return an object of this class when	1723	All non-aggregate C<aio_*> functions return an object of this class when
1267	called in non-void context.	1724	called in non-void context.
…		…
1385		1842
1386	Sets a feeder/generator on this group: every group can have an attached	1843	Sets a feeder/generator on this group: every group can have an attached
1387	generator that generates requests if idle. The idea behind this is that,	1844	generator that generates requests if idle. The idea behind this is that,
1388	although you could just queue as many requests as you want in a group,	1845	although you could just queue as many requests as you want in a group,
1389	this might starve other requests for a potentially long time. For example,	1846	this might starve other requests for a potentially long time. For example,
1390	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1847	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1391	delaying any later requests for a long time.	1848	requests, delaying any later requests for a long time.
1392		1849
1393	To avoid this, and allow incremental generation of requests, you can	1850	To avoid this, and allow incremental generation of requests, you can
1394	instead a group and set a feeder on it that generates those requests. The	1851	instead a group and set a feeder on it that generates those requests. The
1395	feed callback will be called whenever there are few enough (see C<limit>,	1852	feed callback will be called whenever there are few enough (see C<limit>,
1396	below) requests active in the group itself and is expected to queue more	1853	below) requests active in the group itself and is expected to queue more
…		…
1428	The default value for the limit is C<0>, but note that setting a feeder	1885	The default value for the limit is C<0>, but note that setting a feeder
1429	automatically bumps it up to C<2>.	1886	automatically bumps it up to C<2>.
1430		1887
1431	=back	1888	=back
1432		1889
		1890
1433	=head2 SUPPORT FUNCTIONS	1891	=head2 SUPPORT FUNCTIONS
1434		1892
1435	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1893	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1436		1894
1437	=over 4	1895	=over 4
…		…
1445		1903
1446	See C<poll_cb> for an example.	1904	See C<poll_cb> for an example.
1447		1905
1448	=item IO::AIO::poll_cb	1906	=item IO::AIO::poll_cb
1449		1907
1450	Process some outstanding events on the result pipe. You have to call	1908	Process some requests that have reached the result phase (i.e. they have
		1909	been executed but the results are not yet reported). You have to call
		1910	this "regularly" to finish outstanding requests.
		1911
1451	this regularly. Returns C<0> if all events could be processed (or there	1912	Returns C<0> if all events could be processed (or there were no
1452	were no events to process), or C<-1> if it returned earlier for whatever	1913	events to process), or C<-1> if it returned earlier for whatever
1453	reason. Returns immediately when no events are outstanding. The amount of	1914	reason. Returns immediately when no events are outstanding. The amount
1454	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1915	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1455	C<IO::AIO::max_poll_time>.	1916	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1456		1917
1457	If not all requests were processed for whatever reason, the filehandle	1918	If not all requests were processed for whatever reason, the poll file
1458	will still be ready when C<poll_cb> returns, so normally you don't have to	1919	descriptor will still be ready when C<poll_cb> returns, so normally you
1459	do anything special to have it called later.	1920	don't have to do anything special to have it called later.
1460		1921
1461	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1922	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1462	ready, it can be beneficial to call this function from loops which submit	1923	ready, it can be beneficial to call this function from loops which submit
1463	a lot of requests, to make sure the results get processed when they become	1924	a lot of requests, to make sure the results get processed when they become
1464	available and not just when the loop is finished and the event loop takes	1925	available and not just when the loop is finished and the event loop takes
…		…
1473	poll => 'r', async => 1,	1934	poll => 'r', async => 1,
1474	cb => \&IO::AIO::poll_cb);	1935	cb => \&IO::AIO::poll_cb);
1475		1936
1476	=item IO::AIO::poll_wait	1937	=item IO::AIO::poll_wait
1477		1938
1478	If there are any outstanding requests and none of them in the result	1939	Wait until either at least one request is in the result phase or no
1479	phase, wait till the result filehandle becomes ready for reading (simply	1940	requests are outstanding anymore.
1480	does a C<select> on the filehandle. This is useful if you want to	1941
1481	synchronously wait for some requests to finish).	1942	This is useful if you want to synchronously wait for some requests to
		1943	become ready, without actually handling them.
1482		1944
1483	See C<nreqs> for an example.	1945	See C<nreqs> for an example.
1484		1946
1485	=item IO::AIO::poll	1947	=item IO::AIO::poll
1486		1948
…		…
1497		1959
1498	Strictly equivalent to:	1960	Strictly equivalent to:
1499		1961
1500	IO::AIO::poll_wait, IO::AIO::poll_cb	1962	IO::AIO::poll_wait, IO::AIO::poll_cb
1501	while IO::AIO::nreqs;	1963	while IO::AIO::nreqs;
		1964
		1965	This function can be useful at program aborts, to make sure outstanding
		1966	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1967	this function on normal exits), or when you are merely using C<IO::AIO>
		1968	for its more advanced functions, rather than for async I/O, e.g.:
		1969
		1970	my ($dirs, $nondirs);
		1971	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1972	IO::AIO::flush;
		1973	# $dirs, $nondirs are now set
1502		1974
1503	=item IO::AIO::max_poll_reqs $nreqs	1975	=item IO::AIO::max_poll_reqs $nreqs
1504		1976
1505	=item IO::AIO::max_poll_time $seconds	1977	=item IO::AIO::max_poll_time $seconds
1506		1978
…		…
1533	poll => 'r', nice => 1,	2005	poll => 'r', nice => 1,
1534	cb => &IO::AIO::poll_cb);	2006	cb => &IO::AIO::poll_cb);
1535		2007
1536	=back	2008	=back
1537		2009
		2010
1538	=head3 CONTROLLING THE NUMBER OF THREADS	2011	=head3 CONTROLLING THE NUMBER OF THREADS
1539		2012
1540	=over	2013	=over
1541		2014
1542	=item IO::AIO::min_parallel $nthreads	2015	=item IO::AIO::min_parallel $nthreads
…		…
1603	longer exceeded.	2076	longer exceeded.
1604		2077
1605	In other words, this setting does not enforce a queue limit, but can be	2078	In other words, this setting does not enforce a queue limit, but can be
1606	used to make poll functions block if the limit is exceeded.	2079	used to make poll functions block if the limit is exceeded.
1607		2080
1608	This is a very bad function to use in interactive programs because it	2081	This is a bad function to use in interactive programs because it blocks,
1609	blocks, and a bad way to reduce concurrency because it is inexact: Better	2082	and a bad way to reduce concurrency because it is inexact. If you need to
		2083	issue many requests without being able to call a poll function on demand,
1610	use an C<aio_group> together with a feed callback.	2084	it is better to use an C<aio_group> together with a feed callback.
1611		2085
1612	It's main use is in scripts without an event loop - when you want to stat	2086	Its main use is in scripts without an event loop - when you want to stat a
1613	a lot of files, you can write somehting like this:	2087	lot of files, you can write something like this:
1614		2088
1615	IO::AIO::max_outstanding 32;	2089	IO::AIO::max_outstanding 32;
1616		2090
1617	for my $path (...) {	2091	for my $path (...) {
1618	aio_stat $path , ...;	2092	aio_stat $path , ...;
1619	IO::AIO::poll_cb;	2093	IO::AIO::poll_cb;
1620	}	2094	}
1621		2095
1622	IO::AIO::flush;	2096	IO::AIO::flush;
1623		2097
1624	The call to C<poll_cb> inside the loop will normally return instantly, but	2098	The call to C<poll_cb> inside the loop will normally return instantly,
1625	as soon as more thna C<32> reqeusts are in-flight, it will block until	2099	allowing the loop to progress, but as soon as more than C<32> requests
1626	some requests have been handled. This keeps the loop from pushing a large	2100	are in-flight, it will block until some requests have been handled. This
1627	number of C<aio_stat> requests onto the queue.	2101	keeps the loop from pushing a large number of C<aio_stat> requests onto
		2102	the queue (which, with many paths to stat, can use up a lot of memory).
1628		2103
1629	The default value for C<max_outstanding> is very large, so there is no	2104	The default value for C<max_outstanding> is very large, so there is no
1630	practical limit on the number of outstanding requests.	2105	practical limit on the number of outstanding requests.
1631		2106
1632	=back	2107	=back
1633		2108
		2109
1634	=head3 STATISTICAL INFORMATION	2110	=head3 STATISTICAL INFORMATION
1635		2111
1636	=over	2112	=over
1637		2113
1638	=item IO::AIO::nreqs	2114	=item IO::AIO::nreqs
…		…
1655	Returns the number of requests currently in the pending state (executed,	2131	Returns the number of requests currently in the pending state (executed,
1656	but not yet processed by poll_cb).	2132	but not yet processed by poll_cb).
1657		2133
1658	=back	2134	=back
1659		2135
		2136
		2137	=head3 SUBSECOND STAT TIME ACCESS
		2138
		2139	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2140	generally find access/modification and change times with subsecond time
		2141	accuracy of the system supports it, but perl's built-in functions only
		2142	return the integer part.
		2143
		2144	The following functions return the timestamps of the most recent
		2145	stat with subsecond precision on most systems and work both after
		2146	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2147	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2148	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2149
		2150	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2151	full resolution without rounding and work with standard perl C<stat>,
		2152	alleviating the need to call the special C<Time::HiRes> functions, which
		2153	do not act like their perl counterparts.
		2154
		2155	On operating systems or file systems where subsecond time resolution is
		2156	not supported or could not be detected, a fractional part of C<0> is
		2157	returned, so it is always safe to call these functions.
		2158
		2159	=over 4
		2160
		2161	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2162
		2163	Return the access, modication, change or birth time, respectively,
		2164	including fractional part. Due to the limited precision of floating point,
		2165	the accuracy on most platforms is only a bit better than milliseconds
		2166	for times around now - see the I<nsec> function family, below, for full
		2167	accuracy.
		2168
		2169	File birth time is only available when the OS and perl support it (on
		2170	FreeBSD and NetBSD at the time of this writing, although support is
		2171	adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
		2172	it). On systems where it isn't available, C<0> is currently returned, but
		2173	this might change to C<undef> in a future version.
		2174
		2175	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2176
		2177	Returns access, modification, change and birth time all in one go, and
		2178	maybe more times in the future version.
		2179
		2180	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2181
		2182	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2183	as an integer in the range C<0> to C<999999999>.
		2184
		2185	Note that no accessors are provided for access, modification and
		2186	change times - you need to get those from C<stat _> if required (C<int
		2187	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2188	value).
		2189
		2190	=item $seconds = IO::AIO::st_btimesec
		2191
		2192	The (integral) seconds part of the file birth time, if available.
		2193
		2194	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2195
		2196	Like the functions above, but returns all four times in one go (and maybe
		2197	more in future versions).
		2198
		2199	=item $counter = IO::AIO::st_gen
		2200
		2201	Returns the generation counter (in practice this is just a random number)
		2202	of the file. This is only available on platforms which have this member in
		2203	their C<struct stat> (most BSDs at the time of this writing) and generally
		2204	only to the root usert. If unsupported, C<0> is returned, but this might
		2205	change to C<undef> in a future version.
		2206
		2207	=back
		2208
		2209	Example: print the high resolution modification time of F</etc>, using
		2210	C<stat>, and C<IO::AIO::aio_stat>.
		2211
		2212	if (stat "/etc") {
		2213	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2214	}
		2215
		2216	IO::AIO::aio_stat "/etc", sub {
		2217	$_[0]
		2218	and return;
		2219
		2220	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2221	};
		2222
		2223	IO::AIO::flush;
		2224
		2225	Output of the awbove on my system, showing reduced and full accuracy:
		2226
		2227	stat(/etc) mtime: 1534043702.020808
		2228	aio_stat(/etc) mtime: 1534043702.020807792
		2229
		2230
1660	=head3 MISCELLANEOUS FUNCTIONS	2231	=head3 MISCELLANEOUS FUNCTIONS
1661		2232
1662	IO::AIO implements some functions that might be useful, but are not	2233	IO::AIO implements some functions that are useful when you want to use
1663	asynchronous.	2234	some "Advanced I/O" function not available to in Perl, without going the
		2235	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2236	counterpart.
1664		2237
1665	=over 4	2238	=over 4
		2239
		2240	=item $retval = IO::AIO::fexecve $fh, $argv, $envp
		2241
		2242	A more-or-less direct equivalent to the POSIX C<fexecve> functions, which
		2243	allows you to specify the program to be executed via a file descriptor (or
		2244	handle). Returns C<-1> and sets errno to C<ENOSYS> if not available.
		2245
		2246	=item $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		2247
		2248	Calls the GNU/Linux mount syscall with the given arguments. All except
		2249	C<$flags> are strings, and if C<$data> is C<undef>, a C<NULL> will be
		2250	passed.
		2251
		2252	The following values for C<$flags> are available:
		2253
		2254	C<IO::AIO::MS_RDONLY>, C<IO::AIO::MS_NOSUID>, C<IO::AIO::MS_NODEV>, C<IO::AIO::MS_NOEXEC>, C<IO::AIO::MS_SYNCHRONOUS>,
		2255	C<IO::AIO::MS_REMOUNT>, C<IO::AIO::MS_MANDLOCK>, C<IO::AIO::MS_DIRSYNC>, C<IO::AIO::MS_NOATIME>,
		2256	C<IO::AIO::MS_NODIRATIME>, C<IO::AIO::MS_BIND>, C<IO::AIO::MS_MOVE>, C<IO::AIO::MS_REC>, C<IO::AIO::MS_SILENT>,
		2257	C<IO::AIO::MS_POSIXACL>, C<IO::AIO::MS_UNBINDABLE>, C<IO::AIO::MS_PRIVATE>, C<IO::AIO::MS_SLAVE>, C<IO::AIO::MS_SHARED>,
		2258	C<IO::AIO::MS_RELATIME>, C<IO::AIO::MS_KERNMOUNT>, C<IO::AIO::MS_I_VERSION>, C<IO::AIO::MS_STRICTATIME>,
		2259	C<IO::AIO::MS_LAZYTIME>, C<IO::AIO::MS_ACTIVE>, C<IO::AIO::MS_NOUSER>, C<IO::AIO::MS_RMT_MASK>, C<IO::AIO::MS_MGC_VAL> and
		2260	C<IO::AIO::MS_MGC_MSK>.
		2261
		2262	=item $retval = IO::AIO::umount $path, $flags = 0
		2263
		2264	Invokes the GNU/Linux C<umount> or C<umount2> syscalls. Always calls
		2265	C<umount> if C<$flags> is C<0>, otherwqise always tries to call
		2266	C<umount2>.
		2267
		2268	The following C<$flags> are available:
		2269
		2270	C<IO::AIO::MNT_FORCE>, C<IO::AIO::MNT_DETACH>, C<IO::AIO::MNT_EXPIRE> and C<IO::AIO::UMOUNT_NOFOLLOW>.
		2271
		2272	=item $numfd = IO::AIO::get_fdlimit
		2273
		2274	Tries to find the current file descriptor limit and returns it, or
		2275	C<undef> and sets C<$!> in case of an error. The limit is one larger than
		2276	the highest valid file descriptor number.
		2277
		2278	=item IO::AIO::min_fdlimit [$numfd]
		2279
		2280	Try to increase the current file descriptor limit(s) to at least C<$numfd>
		2281	by changing the soft or hard file descriptor resource limit. If C<$numfd>
		2282	is missing, it will try to set a very high limit, although this is not
		2283	recommended when you know the actual minimum that you require.
		2284
		2285	If the limit cannot be raised enough, the function makes a best-effort
		2286	attempt to increase the limit as much as possible, using various
		2287	tricks, while still failing. You can query the resulting limit using
		2288	C<IO::AIO::get_fdlimit>.
		2289
		2290	If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
		2291	true.
1666		2292
1667	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2293	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1668		2294
1669	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,	2295	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1670	but is blocking (this makes most sense if you know the input data is	2296	but is blocking (this makes most sense if you know the input data is
…		…
1687	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2313	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1688		2314
1689	Simply calls the C<posix_madvise> function (see its	2315	Simply calls the C<posix_madvise> function (see its
1690	manpage for details). The following advice constants are	2316	manpage for details). The following advice constants are
1691	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2317	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1692	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2318	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
		2319	C<IO::AIO::MADV_DONTNEED>.
		2320
		2321	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2322	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2323	will be reduced to fit into the C<$scalar>.
1693		2324
1694	On systems that do not implement C<posix_madvise>, this function returns	2325	On systems that do not implement C<posix_madvise>, this function returns
1695	ENOSYS, otherwise the return value of C<posix_madvise>.	2326	ENOSYS, otherwise the return value of C<posix_madvise>.
1696		2327
1697	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2328	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
1699	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2330	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1700	$scalar (see its manpage for details). The following protect	2331	$scalar (see its manpage for details). The following protect
1701	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2332	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1702	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2333	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1703		2334
		2335	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2336	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2337	will be reduced to fit into the C<$scalar>.
		2338
1704	On systems that do not implement C<mprotect>, this function returns	2339	On systems that do not implement C<mprotect>, this function returns
1705	ENOSYS, otherwise the return value of C<mprotect>.	2340	ENOSYS, otherwise the return value of C<mprotect>.
1706		2341
1707	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2342	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1708		2343
1709	Memory-maps a file (or anonymous memory range) and attaches it to the	2344	Memory-maps a file (or anonymous memory range) and attaches it to the
1710	given C<$scalar>, which will act like a string scalar.	2345	given C<$scalar>, which will act like a string scalar. Returns true on
		2346	success, and false otherwise.
1711		2347
		2348	The scalar must exist, but its contents do not matter - this means you
		2349	cannot use a nonexistant array or hash element. When in doubt, C<undef>
		2350	the scalar first.
		2351
1712	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2352	The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1713	change the string length, and most read-only operations such as copying it	2353	which don't change the string length, and most read-only operations such
1714	or searching it with regexes and so on.	2354	as copying it or searching it with regexes and so on.
1715		2355
1716	Anything else is unsafe and will, at best, result in memory leaks.	2356	Anything else is unsafe and will, at best, result in memory leaks.
1717		2357
1718	The memory map associated with the C<$scalar> is automatically removed	2358	The memory map associated with the C<$scalar> is automatically removed
1719	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or	2359	when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1720	C<IO::AIO::munmap> functions are called.	2360	or C<IO::AIO::munmap> functions are called on it.
1721		2361
1722	This calls the C<mmap>(2) function internally. See your system's manual	2362	This calls the C<mmap>(2) function internally. See your system's manual
1723	page for details on the C<$length>, C<$prot> and C<$flags> parameters.	2363	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1724		2364
1725	The C<$length> must be larger than zero and smaller than the actual	2365	The C<$length> must be larger than zero and smaller than the actual
1726	filesize.	2366	filesize.
1727		2367
1728	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2368	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1729	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2369	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1730		2370
1731	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2371	C<$flags> can be a combination of
1732	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2372	C<IO::AIO::MAP_SHARED> or
1733	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2373	C<IO::AIO::MAP_PRIVATE>,
		2374	or a number of system-specific flags (when not available, the are C<0>):
1734	(which is set to C<MAP_ANON> if your system only provides this	2375	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1735	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2376	C<IO::AIO::MAP_LOCKED>,
1736	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2377	C<IO::AIO::MAP_NORESERVE>,
		2378	C<IO::AIO::MAP_POPULATE>,
1737	C<IO::AIO::MAP_NONBLOCK>	2379	C<IO::AIO::MAP_NONBLOCK>,
		2380	C<IO::AIO::MAP_FIXED>,
		2381	C<IO::AIO::MAP_GROWSDOWN>,
		2382	C<IO::AIO::MAP_32BIT>,
		2383	C<IO::AIO::MAP_HUGETLB>,
		2384	C<IO::AIO::MAP_STACK>,
		2385	C<IO::AIO::MAP_FIXED_NOREPLACE>,
		2386	C<IO::AIO::MAP_SHARED_VALIDATE>,
		2387	C<IO::AIO::MAP_SYNC> or
		2388	C<IO::AIO::MAP_UNINITIALIZED>.
1738		2389
1739	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2390	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1740		2391
1741	C<$offset> is the offset from the start of the file - it generally must be	2392	C<$offset> is the offset from the start of the file - it generally must be
1742	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2393	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
1756		2407
1757	=item IO::AIO::munmap $scalar	2408	=item IO::AIO::munmap $scalar
1758		2409
1759	Removes a previous mmap and undefines the C<$scalar>.	2410	Removes a previous mmap and undefines the C<$scalar>.
1760		2411
		2412	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2413
		2414	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2415	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2416	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2417
		2418	Returns true if successful, and false otherwise. If the underlying mmapped
		2419	region has changed address, then the true value has the numerical value
		2420	C<1>, otherwise it has the numerical value C<0>:
		2421
		2422	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2423	or die "mremap: $!";
		2424
		2425	if ($success*1) {
		2426	warn "scalar has chanegd address in memory\n";
		2427	}
		2428
		2429	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2430	implemented, but not supported and might go away in a future version.
		2431
		2432	On systems where this call is not supported or is not emulated, this call
		2433	returns falls and sets C<$!> to C<ENOSYS>.
		2434
		2435	=item IO::AIO::mlockall $flags
		2436
		2437	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2438	but is blocking.
		2439
1761	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2440	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1762		2441
1763	Calls the C<munlock> function, undoing the effects of a previous	2442	Calls the C<munlock> function, undoing the effects of a previous
1764	C<aio_mlock> call (see its description for details).	2443	C<aio_mlock> call (see its description for details).
1765		2444
…		…
1767		2446
1768	Calls the C<munlockall> function.	2447	Calls the C<munlockall> function.
1769		2448
1770	On systems that do not implement C<munlockall>, this function returns	2449	On systems that do not implement C<munlockall>, this function returns
1771	ENOSYS, otherwise the return value of C<munlockall>.	2450	ENOSYS, otherwise the return value of C<munlockall>.
		2451
		2452	=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
		2453
		2454	Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
		2455	and return the new file handle on success, or sets C<$!> and returns
		2456	C<undef> on error.
		2457
		2458	The remote name of the new socket will be stored in C<$sockaddr>, which
		2459	will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
		2460	socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
		2461	by returning a longer string in C<$sockaddr>, which might or might not be
		2462	truncated.
		2463
		2464	To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
		2465	C<$sockaddr_maxlen>.
		2466
		2467	The main reasons to use this syscall rather than portable C<accept(2)>
		2468	are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
		2469	flags and you can accept name-less sockets by specifying C<0> for
		2470	C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
		2471	C<accept>.
		2472
		2473	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2474
		2475	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2476	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2477	should be the file offset.
		2478
		2479	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2480	silently corrupt the data in this case.
		2481
		2482	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2483	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2484	C<IO::AIO::SPLICE_F_GIFT>.
		2485
		2486	See the C<splice(2)> manpage for details.
		2487
		2488	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2489
		2490	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2491	description for C<IO::AIO::splice> above for details.
		2492
		2493	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2494
		2495	Attempts to query or change the pipe buffer size. Obviously works only
		2496	on pipes, and currently works only on GNU/Linux systems, and fails with
		2497	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2498	size on other systems, drop me a note.
		2499
		2500	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2501
		2502	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2503	C<$flags> is missing or C<0>, then this should be the same as a call to
		2504	perl's built-in C<pipe> function and create a new pipe, and works on
		2505	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2506	(..., 4096, O_BINARY)>.
		2507
		2508	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2509	the given flags (Linux 2.6.27, glibc 2.9).
		2510
		2511	On success, the read and write file handles are returned.
		2512
		2513	On error, nothing will be returned. If the pipe2 syscall is missing and
		2514	C<$flags> is non-zero, fails with C<ENOSYS>.
		2515
		2516	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2517	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2518	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2519
		2520	Example: create a pipe race-free w.r.t. threads and fork:
		2521
		2522	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
		2523	or die "pipe2: $!\n";
		2524
		2525	=item $fh = IO::AIO::memfd_create $pathname[, $flags]
		2526
		2527	This is a direct interface to the Linux L<memfd_create(2)> system
		2528	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2529	should be C<IO::AIO::MFD_CLOEXEC>.
		2530
		2531	On success, the new memfd filehandle is returned, otherwise returns
		2532	C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
		2533
		2534	Please refer to L<memfd_create(2)> for more info on this call.
		2535
		2536	The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
		2537	C<IO::AIO::MFD_ALLOW_SEALING>, C<IO::AIO::MFD_HUGETLB>,
		2538	C<IO::AIO::MFD_HUGETLB_2MB> and C<IO::AIO::MFD_HUGETLB_1GB>.
		2539
		2540	Example: create a new memfd.
		2541
		2542	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		2543	or die "memfd_create: $!\n";
		2544
		2545	=item $fh = IO::AIO::pidfd_open $pid[, $flags]
		2546
		2547	This is an interface to the Linux L<pidfd_open(2)> system call. The
		2548	default for C<$flags> is C<0>.
		2549
		2550	On success, a new pidfd filehandle is returned (that is already set to
		2551	close-on-exec), otherwise returns C<undef>. If the syscall is missing,
		2552	fails with C<ENOSYS>.
		2553
		2554	Example: open pid 6341 as pidfd.
		2555
		2556	my $fh = IO::AIO::pidfd_open 6341
		2557	or die "pidfd_open: $!\n";
		2558
		2559	=item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		2560
		2561	This is an interface to the Linux L<pidfd_send_signal> system call. The
		2562	default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>.
		2563
		2564	Returns the system call status. If the syscall is missing, fails with
		2565	C<ENOSYS>.
		2566
		2567	When specified, C<$siginfo> must be a reference to a hash with one or more
		2568	of the following members:
		2569
		2570	=over
		2571
		2572	=item code - the C<si_code> member
		2573
		2574	=item pid - the C<si_pid> member
		2575
		2576	=item uid - the C<si_uid> member
		2577
		2578	=item value_int - the C<si_value.sival_int> member
		2579
		2580	=item value_ptr - the C<si_value.sival_ptr> member, specified as an integer
		2581
		2582	=back
		2583
		2584	Example: send a SIGKILL to the specified process.
		2585
		2586	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
		2587	and die "pidfd_send_signal: $!\n";
		2588
		2589	Example: send a SIGKILL to the specified process with extra data.
		2590
		2591	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
		2592	and die "pidfd_send_signal: $!\n";
		2593
		2594	=item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		2595
		2596	This is an interface to the Linux L<pidfd_getfd> system call. The default
		2597	for C<$flags> is C<0>.
		2598
		2599	On success, returns a dup'ed copy of the target file descriptor (specified
		2600	as an integer) returned (that is already set to close-on-exec), otherwise
		2601	returns C<undef>. If the syscall is missing, fails with C<ENOSYS>.
		2602
		2603	Example: get a copy of standard error of another process and print soemthing to it.
		2604
		2605	my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
		2606	or die "pidfd_getfd: $!\n";
		2607	print $errfh "stderr\n";
		2608
		2609	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
		2610
		2611	This is a direct interface to the Linux L<eventfd(2)> system call. The
		2612	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
		2613
		2614	On success, the new eventfd filehandle is returned, otherwise returns
		2615	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2616
		2617	Please refer to L<eventfd(2)> for more info on this call.
		2618
		2619	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
		2620	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2621
		2622	Example: create a new eventfd filehandle:
		2623
		2624	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
		2625	or die "eventfd: $!\n";
		2626
		2627	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2628
		2629	This is a direct interface to the Linux L<timerfd_create(2)> system
		2630	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2631	should be C<IO::AIO::TFD_CLOEXEC>.
		2632
		2633	On success, the new timerfd filehandle is returned, otherwise returns
		2634	C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
		2635
		2636	Please refer to L<timerfd_create(2)> for more info on this call.
		2637
		2638	The following C<$clockid> values are
		2639	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2640	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2641	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2642	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2643
		2644	The following C<$flags> values are available (Linux
		2645	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2646
		2647	Example: create a new timerfd and set it to one-second repeated alarms,
		2648	then wait for two alarms:
		2649
		2650	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2651	or die "timerfd_create: $!\n";
		2652
		2653	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2654	or die "timerfd_settime: $!\n";
		2655
		2656	for (1..2) {
		2657	8 == sysread $fh, my $buf, 8
		2658	or die "timerfd read failure\n";
		2659
		2660	printf "number of expirations (likely 1): %d\n",
		2661	unpack "Q", $buf;
		2662	}
		2663
		2664	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2665
		2666	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2667	call. Please refer to its manpage for more info on this call.
		2668
		2669	The new itimerspec is specified using two (possibly fractional) second
		2670	values, C<$new_interval> and C<$new_value>).
		2671
		2672	On success, the current interval and value are returned (as per
		2673	C<timerfd_gettime>). On failure, the empty list is returned.
		2674
		2675	The following C<$flags> values are
		2676	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2677	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2678
		2679	See C<IO::AIO::timerfd_create> for a full example.
		2680
		2681	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2682
		2683	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2684	call. Please refer to its manpage for more info on this call.
		2685
		2686	On success, returns the current values of interval and value for the given
		2687	timerfd (as potentially fractional second values). On failure, the empty
		2688	list is returned.
1772		2689
1773	=back	2690	=back
1774		2691
1775	=cut	2692	=cut
1776		2693
…		…
1842	the process will result in undefined behaviour. Calling it at any time	2759	the process will result in undefined behaviour. Calling it at any time
1843	will also result in any undefined (by POSIX) behaviour.	2760	will also result in any undefined (by POSIX) behaviour.
1844		2761
1845	=back	2762	=back
1846		2763
		2764	=head2 LINUX-SPECIFIC CALLS
		2765
		2766	When a call is documented as "linux-specific" then this means it
		2767	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2768	availability and compatibility of such calls regardless of the platform
		2769	it is compiled on, so platforms such as FreeBSD which often implement
		2770	these calls will work. When in doubt, call them and see if they fail wth
		2771	C<ENOSYS>.
		2772
1847	=head2 MEMORY USAGE	2773	=head2 MEMORY USAGE
1848		2774
1849	Per-request usage:	2775	Per-request usage:
1850		2776
1851	Each aio request uses - depending on your architecture - around 100-200	2777	Each aio request uses - depending on your architecture - around 100-200
…		…
1863	temporary buffers, and each thread requires a stack and other data	2789	temporary buffers, and each thread requires a stack and other data
1864	structures (usually around 16k-128k, depending on the OS).	2790	structures (usually around 16k-128k, depending on the OS).
1865		2791
1866	=head1 KNOWN BUGS	2792	=head1 KNOWN BUGS
1867		2793
1868	Known bugs will be fixed in the next release.	2794	Known bugs will be fixed in the next release :)
		2795
		2796	=head1 KNOWN ISSUES
		2797
		2798	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2799	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2800	non-created hash slots or other scalars I didn't think of. It's best to
		2801	avoid such and either use scalar variables or making sure that the scalar
		2802	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2803
		2804	I am not sure anything can be done about this, so this is considered a
		2805	known issue, rather than a bug.
1869		2806
1870	=head1 SEE ALSO	2807	=head1 SEE ALSO
1871		2808
1872	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2809	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1873	more natural syntax.	2810	more natural syntax and L<IO::FDPass> for file descriptor passing.
1874		2811
1875	=head1 AUTHOR	2812	=head1 AUTHOR
1876		2813
1877	Marc Lehmann <schmorp@schmorp.de>	2814	Marc Lehmann <schmorp@schmorp.de>
1878	http://home.schmorp.de/	2815	http://home.schmorp.de/

Diff Legend

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