ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.124 by root, Sat May 10 19:25:33 2008 UTC vs.
Revision 1.235 by root, Wed Aug 22 22:28:03 2012 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
9	aio_open "/etc/passwd", O_RDONLY, 0, sub {	9	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10	my $fh = shift	10	my $fh = shift
11	or die "/etc/passwd: $!";	11	or die "/etc/passwd: $!";
12	...	12	...
13	};	13	};
14		14
…		…
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30		30
31	# AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...)
32	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35	# EV integration
36	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37
38	# Event integration
39	Event->io (fd => IO::AIO::poll_fileno,
40	poll => 'r',
41	cb => \&IO::AIO::poll_cb);
42
43	# Glib/Gtk2 integration
44	add_watch Glib::IO IO::AIO::poll_fileno,
45	in => sub { IO::AIO::poll_cb; 1 };
46
47	# Tk integration
48	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
49	readable => \&IO::AIO::poll_cb);
50
51	# Danga::Socket integration
52	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
53	\&IO::AIO::poll_cb);
54
55	=head1 DESCRIPTION	31	=head1 DESCRIPTION
56		32
57	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
58	operating system supports.	34	operating system supports. It is implemented as an interface to C<libeio>
		35	(L<http://software.schmorp.de/pkg/libeio.html>).
59		36
60	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
61	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
62	will still block, but you can do something else in the meantime. This	39	will still block, but you can do something else in the meantime. This
63	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
67	on a RAID volume or over NFS when you do a number of stat operations	44	on a RAID volume or over NFS when you do a number of stat operations
68	concurrently.	45	concurrently.
69		46
70	While most of this works on all types of file descriptors (for	47	While most of this works on all types of file descriptors (for
71	example sockets), using these functions on file descriptors that	48	example sockets), using these functions on file descriptors that
72	support nonblocking operation (again, sockets, pipes etc.) is very	49	support nonblocking operation (again, sockets, pipes etc.) is
73	inefficient. Use an event loop for that (such as the L<Event|Event>	50	very inefficient. Use an event loop for that (such as the L<EV>
74	module): IO::AIO will naturally fit into such an event loop itself.	51	module): IO::AIO will naturally fit into such an event loop itself.
75		52
76	In this version, a number of threads are started that execute your	53	In this version, a number of threads are started that execute your
77	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
78	in perl, and the threads created by this module will not be visible	55	in perl, and the threads created by this module will not be visible
…		…
88	yourself, always call C<poll_cb> from within the same thread, or never	65	yourself, always call C<poll_cb> from within the same thread, or never
89	call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
90		67
91	=head2 EXAMPLE	68	=head2 EXAMPLE
92		69
93	This is a simple example that uses the Event module and loads	70	This is a simple example that uses the EV module and loads
94	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
95		72
96	use Fcntl;	73	use Fcntl;
97	use Event;	74	use EV;
98	use IO::AIO;	75	use IO::AIO;
99		76
100	# register the IO::AIO callback with Event	77	# register the IO::AIO callback with EV
101	Event->io (fd => IO::AIO::poll_fileno,	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102	poll => 'r',
103	cb => \&IO::AIO::poll_cb);
104		79
105	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
106	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
107	my $fh = shift	82	my $fh = shift
108	or die "error while opening: $!";	83	or die "error while opening: $!";
109		84
110	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
111	my $size = -s $fh;	86	my $size = -s $fh;
…		…
120		95
121	# file contents now in $contents	96	# file contents now in $contents
122	print $contents;	97	print $contents;
123		98
124	# exit event loop and program	99	# exit event loop and program
125	Event::unloop;	100	EV::unloop;
126	};	101	};
127	};	102	};
128		103
129	# possibly queue up other requests, or open GUI windows,	104	# possibly queue up other requests, or open GUI windows,
130	# check for sockets etc. etc.	105	# check for sockets etc. etc.
131		106
132	# process events as long as there are some:	107	# process events as long as there are some:
133	Event::loop;	108	EV::loop;
134		109
135	=head1 REQUEST ANATOMY AND LIFETIME	110	=head1 REQUEST ANATOMY AND LIFETIME
136		111
137	Every C<aio_*> function creates a request. which is a C data structure not	112	Every C<aio_*> function creates a request. which is a C data structure not
138	directly visible to Perl.	113	directly visible to Perl.
…		…
188		163
189	package IO::AIO;	164	package IO::AIO;
190		165
191	use Carp ();	166	use Carp ();
192		167
193	no warnings;	168	use common::sense;
194	use strict 'vars';
195		169
196	use base 'Exporter';	170	use base 'Exporter';
197		171
198	BEGIN {	172	BEGIN {
199	our $VERSION = '3.0';	173	our $VERSION = '4.16';
200		174
201	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close	175	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
202	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
203	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
		178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
204	aio_fdatasync aio_pathsync aio_readahead	179	aio_pathsync aio_readahead aio_fiemap
205	aio_rename aio_link aio_move aio_copy aio_group	180	aio_rename aio_link aio_move aio_copy aio_group
206	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
207	aio_chmod aio_utime aio_truncate);	182	aio_chmod aio_utime aio_truncate
		183	aio_msync aio_mtouch aio_mlock aio_mlockall
		184	aio_statvfs
		185	aio_wd);
208		186
209	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	187	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
210	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	188	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
211	min_parallel max_parallel max_idle	189	min_parallel max_parallel max_idle idle_timeout
212	nreqs nready npending nthreads	190	nreqs nready npending nthreads
213	max_poll_time max_poll_reqs);	191	max_poll_time max_poll_reqs
		192	sendfile fadvise madvise
		193	mmap munmap munlock munlockall);
		194
		195	push @AIO_REQ, qw(aio_busy); # not exported
214		196
215	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216		198
217	require XSLoader;	199	require XSLoader;
218	XSLoader::load ("IO::AIO", $VERSION);	200	XSLoader::load ("IO::AIO", $VERSION);
219	}	201	}
220		202
221	=head1 FUNCTIONS	203	=head1 FUNCTIONS
222		204
223	=head2 AIO REQUEST FUNCTIONS	205	=head2 QUICK OVERVIEW
		206
		207	This section simply lists the prototypes most of the functions for
		208	quick reference. See the following sections for function-by-function
		209	documentation.
		210
		211	aio_wd $pathname, $callback->($wd)
		212	aio_open $pathname, $flags, $mode, $callback->($fh)
		213	aio_close $fh, $callback->($status)
		214	aio_seek $fh,$offset,$whence, $callback->($offs)
		215	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		216	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		217	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		218	aio_readahead $fh,$offset,$length, $callback->($retval)
		219	aio_stat $fh_or_path, $callback->($status)
		220	aio_lstat $fh, $callback->($status)
		221	aio_statvfs $fh_or_path, $callback->($statvfs)
		222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		224	aio_chmod $fh_or_path, $mode, $callback->($status)
		225	aio_truncate $fh_or_path, $offset, $callback->($status)
		226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		227	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		228	aio_unlink $pathname, $callback->($status)
		229	aio_mknod $pathname, $mode, $dev, $callback->($status)
		230	aio_link $srcpath, $dstpath, $callback->($status)
		231	aio_symlink $srcpath, $dstpath, $callback->($status)
		232	aio_readlink $pathname, $callback->($link)
		233	aio_realpath $pathname, $callback->($link)
		234	aio_rename $srcpath, $dstpath, $callback->($status)
		235	aio_mkdir $pathname, $mode, $callback->($status)
		236	aio_rmdir $pathname, $callback->($status)
		237	aio_readdir $pathname, $callback->($entries)
		238	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		239	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		240	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		241	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
		242	aio_load $pathname, $data, $callback->($status)
		243	aio_copy $srcpath, $dstpath, $callback->($status)
		244	aio_move $srcpath, $dstpath, $callback->($status)
		245	aio_rmtree $pathname, $callback->($status)
		246	aio_sync $callback->($status)
		247	aio_syncfs $fh, $callback->($status)
		248	aio_fsync $fh, $callback->($status)
		249	aio_fdatasync $fh, $callback->($status)
		250	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		251	aio_pathsync $pathname, $callback->($status)
		252	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		253	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		254	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		255	aio_mlockall $flags, $callback->($status)
		256	aio_group $callback->(...)
		257	aio_nop $callback->()
		258
		259	$prev_pri = aioreq_pri [$pri]
		260	aioreq_nice $pri_adjust
		261
		262	IO::AIO::poll_wait
		263	IO::AIO::poll_cb
		264	IO::AIO::poll
		265	IO::AIO::flush
		266	IO::AIO::max_poll_reqs $nreqs
		267	IO::AIO::max_poll_time $seconds
		268	IO::AIO::min_parallel $nthreads
		269	IO::AIO::max_parallel $nthreads
		270	IO::AIO::max_idle $nthreads
		271	IO::AIO::idle_timeout $seconds
		272	IO::AIO::max_outstanding $maxreqs
		273	IO::AIO::nreqs
		274	IO::AIO::nready
		275	IO::AIO::npending
		276
		277	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		278	IO::AIO::fadvise $fh, $offset, $len, $advice
		279	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		280	IO::AIO::munmap $scalar
		281	IO::AIO::madvise $scalar, $offset, $length, $advice
		282	IO::AIO::mprotect $scalar, $offset, $length, $protect
		283	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		284	IO::AIO::munlockall
		285
		286	=head2 API NOTES
224		287
225	All the C<aio_*> calls are more or less thin wrappers around the syscall	288	All the C<aio_*> calls are more or less thin wrappers around the syscall
226	with the same name (sans C<aio_>). The arguments are similar or identical,	289	with the same name (sans C<aio_>). The arguments are similar or identical,
227	and they all accept an additional (and optional) C<$callback> argument	290	and they all accept an additional (and optional) C<$callback> argument
228	which must be a code reference. This code reference will get called with	291	which must be a code reference. This code reference will be called after
229	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	292	the syscall has been executed in an asynchronous fashion. The results
230	perl, which usually delivers "false") as it's sole argument when the given	293	of the request will be passed as arguments to the callback (and, if an
231	syscall has been executed asynchronously.	294	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		295	most syscalls return C<-1> on error, unlike perl, which usually delivers
		296	"false").
		297
		298	Some requests (such as C<aio_readdir>) pass the actual results and
		299	communicate failures by passing C<undef>.
232		300
233	All functions expecting a filehandle keep a copy of the filehandle	301	All functions expecting a filehandle keep a copy of the filehandle
234	internally until the request has finished.	302	internally until the request has finished.
235		303
236	All functions return request objects of type L<IO::AIO::REQ> that allow	304	All functions return request objects of type L<IO::AIO::REQ> that allow
237	further manipulation of those requests while they are in-flight.	305	further manipulation of those requests while they are in-flight.
238		306
239	The pathnames you pass to these routines I<must> be absolute and	307	The pathnames you pass to these routines I<should> be absolute. The
240	encoded as octets. The reason for the former is that at the time the	308	reason for this is that at the time the request is being executed, the
241	request is being executed, the current working directory could have	309	current working directory could have changed. Alternatively, you can
242	changed. Alternatively, you can make sure that you never change the	310	make sure that you never change the current working directory anywhere
243	current working directory anywhere in the program and then use relative	311	in the program and then use relative paths. You can also take advantage
244	paths.	312	of IO::AIOs working directory abstraction, that lets you specify paths
		313	relative to some previously-opened "working directory object" - see the
		314	description of the C<IO::AIO::WD> class later in this document.
245		315
246	To encode pathnames as octets, either make sure you either: a) always pass	316	To encode pathnames as octets, either make sure you either: a) always pass
247	in filenames you got from outside (command line, readdir etc.) without	317	in filenames you got from outside (command line, readdir etc.) without
248	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	318	tinkering, b) are in your native filesystem encoding, c) use the Encode
249	your pathnames to the locale (or other) encoding in effect in the user	319	module and encode your pathnames to the locale (or other) encoding in
250	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	320	effect in the user environment, d) use Glib::filename_from_unicode on
251	use something else to ensure your scalar has the correct contents.	321	unicode filenames or e) use something else to ensure your scalar has the
		322	correct contents.
252		323
253	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	324	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
254	handles correctly wether it is set or not.	325	handles correctly whether it is set or not.
		326
		327	=head2 AIO REQUEST FUNCTIONS
255		328
256	=over 4	329	=over 4
257		330
258	=item $prev_pri = aioreq_pri [$pri]	331	=item $prev_pri = aioreq_pri [$pri]
259		332
…		…
289		362
290		363
291	=item aio_open $pathname, $flags, $mode, $callback->($fh)	364	=item aio_open $pathname, $flags, $mode, $callback->($fh)
292		365
293	Asynchronously open or create a file and call the callback with a newly	366	Asynchronously open or create a file and call the callback with a newly
294	created filehandle for the file.	367	created filehandle for the file (or C<undef> in case of an error).
295		368
296	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	369	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
297	for an explanation.	370	for an explanation.
298		371
299	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	372	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
306	by the umask in effect then the request is being executed, so better never	379	by the umask in effect then the request is being executed, so better never
307	change the umask.	380	change the umask.
308		381
309	Example:	382	Example:
310		383
311	aio_open "/etc/passwd", O_RDONLY, 0, sub {	384	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312	if ($_[0]) {	385	if ($_[0]) {
313	print "open successful, fh is $_[0]\n";	386	print "open successful, fh is $_[0]\n";
314	...	387	...
315	} else {	388	} else {
316	die "open failed: $!\n";	389	die "open failed: $!\n";
317	}	390	}
318	};	391	};
319		392
		393	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		394	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		395	following POSIX and non-POSIX constants are available (missing ones on
		396	your system are, as usual, C<0>):
		397
		398	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		399	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		400	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
		401
320		402
321	=item aio_close $fh, $callback->($status)	403	=item aio_close $fh, $callback->($status)
322		404
323	Asynchronously close a file and call the callback with the result	405	Asynchronously close a file and call the callback with the result
324	code.	406	code.
…		…
333	Or in other words: the file descriptor will be closed, but it will not be	415	Or in other words: the file descriptor will be closed, but it will not be
334	free for reuse until the perl filehandle is closed.	416	free for reuse until the perl filehandle is closed.
335		417
336	=cut	418	=cut
337		419
		420	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		421
		422	Seeks the filehandle to the new C<$offset>, similarly to perl's
		423	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		424	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		425	C<IO::AIO::SEEK_END>).
		426
		427	The resulting absolute offset will be passed to the callback, or C<-1> in
		428	case of an error.
		429
		430	In theory, the C<$whence> constants could be different than the
		431	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		432	so don't panic.
		433
		434	As a GNU/Linux (and maybe Solaris) extension, also the constants
		435	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		436	could be found. No guarantees about suitability for use in C<aio_seek> or
		437	Perl's C<sysseek> can be made though, although I would naively assume they
		438	"just work".
		439
338	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
339		441
340	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
341		443
342	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>	444	Reads or writes C<$length> bytes from or to the specified C<$fh> and
343	into the scalar given by C<$data> and offset C<$dataoffset> and calls the	445	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
344	callback without the actual number of bytes read (or -1 on error, just	446	and calls the callback without the actual number of bytes read (or -1 on
345	like the syscall).	447	error, just like the syscall).
		448
		449	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		450	offset plus the actual number of bytes read.
346		451
347	If C<$offset> is undefined, then the current file descriptor offset will	452	If C<$offset> is undefined, then the current file descriptor offset will
348	be used (and updated), otherwise the file descriptor offset will not be	453	be used (and updated), otherwise the file descriptor offset will not be
349	changed by these calls.	454	changed by these calls.
350		455
351	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.	456	If C<$length> is undefined in C<aio_write>, use the remaining length of
		457	C<$data>.
352		458
353	If C<$dataoffset> is less than zero, it will be counted from the end of	459	If C<$dataoffset> is less than zero, it will be counted from the end of
354	C<$data>.	460	C<$data>.
355		461
356	The C<$data> scalar I<MUST NOT> be modified in any way while the request	462	The C<$data> scalar I<MUST NOT> be modified in any way while the request
…		…
370		476
371	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	477	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
372	reading at byte offset C<$in_offset>, and starts writing at the current	478	reading at byte offset C<$in_offset>, and starts writing at the current
373	file offset of C<$out_fh>. Because of that, it is not safe to issue more	479	file offset of C<$out_fh>. Because of that, it is not safe to issue more
374	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	480	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
375	other.	481	other. The same C<$in_fh> works fine though, as this function does not
		482	move or use the file offset of C<$in_fh>.
376		483
		484	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		485	are written, and there is no way to find out how many more bytes have been
		486	read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
		487	number of bytes written to C<$out_fh>. Only if the result value equals
		488	C<$length> one can assume that C<$length> bytes have been read.
		489
		490	Unlike with other C<aio_> functions, it makes a lot of sense to use
		491	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		492	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		493	the socket I/O will be non-blocking. Note, however, that you can run
		494	into a trap where C<aio_sendfile> reads some data with readahead, then
		495	fails to write all data, and when the socket is ready the next time, the
		496	data in the cache is already lost, forcing C<aio_sendfile> to again hit
		497	the disk. Explicit C<aio_read> + C<aio_write> let's you better control
		498	resource usage.
		499
377	This call tries to make use of a native C<sendfile> syscall to provide	500	This call tries to make use of a native C<sendfile>-like syscall to
378	zero-copy operation. For this to work, C<$out_fh> should refer to a	501	provide zero-copy operation. For this to work, C<$out_fh> should refer to
379	socket, and C<$in_fh> should refer to mmap'able file.	502	a socket, and C<$in_fh> should refer to an mmap'able file.
380		503
381	If the native sendfile call fails or is not implemented, it will be	504	If a native sendfile cannot be found or it fails with C<ENOSYS>,
382	emulated, so you can call C<aio_sendfile> on any type of filehandle	505	C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
		506	C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
383	regardless of the limitations of the operating system.	507	type of filehandle regardless of the limitations of the operating system.
384		508
385	Please note, however, that C<aio_sendfile> can read more bytes from	509	As native sendfile syscalls (as practically any non-POSIX interface hacked
386	C<$in_fh> than are written, and there is no way to find out how many	510	together in a hurry to improve benchmark numbers) tend to be rather buggy
387	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	511	on many systems, this implementation tries to work around some known bugs
388	provides the number of bytes written to C<$out_fh>. Only if the result	512	in Linux and FreeBSD kernels (probably others, too), but that might fail,
389	value equals C<$length> one can assume that C<$length> bytes have been	513	so you really really should check the return value of C<aio_sendfile> -
390	read.	514	fewre bytes than expected might have been transferred.
391		515
392		516
393	=item aio_readahead $fh,$offset,$length, $callback->($retval)	517	=item aio_readahead $fh,$offset,$length, $callback->($retval)
394		518
395	C<aio_readahead> populates the page cache with data from a file so that	519	C<aio_readahead> populates the page cache with data from a file so that
…		…
418		542
419	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	543	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
420	error when stat'ing a large file, the results will be silently truncated	544	error when stat'ing a large file, the results will be silently truncated
421	unless perl itself is compiled with large file support.	545	unless perl itself is compiled with large file support.
422		546
		547	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		548	following constants and functions (if not implemented, the constants will
		549	be C<0> and the functions will either C<croak> or fall back on traditional
		550	behaviour).
		551
		552	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		553	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		554	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		555
423	Example: Print the length of F</etc/passwd>:	556	Example: Print the length of F</etc/passwd>:
424		557
425	aio_stat "/etc/passwd", sub {	558	aio_stat "/etc/passwd", sub {
426	$_[0] and die "stat failed: $!";	559	$_[0] and die "stat failed: $!";
427	print "size is ", -s _, "\n";	560	print "size is ", -s _, "\n";
428	};	561	};
429		562
430		563
		564	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		565
		566	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		567	whether a file handle or path was passed.
		568
		569	On success, the callback is passed a hash reference with the following
		570	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		571	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		572	is passed.
		573
		574	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		575	C<ST_NOSUID>.
		576
		577	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		578	their correct value when available, or to C<0> on systems that do
		579	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		580	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		581	C<ST_NODIRATIME> and C<ST_RELATIME>.
		582
		583	Example: stat C</wd> and dump out the data if successful.
		584
		585	aio_statvfs "/wd", sub {
		586	my $f = $_[0]
		587	or die "statvfs: $!";
		588
		589	use Data::Dumper;
		590	say Dumper $f;
		591	};
		592
		593	# result:
		594	{
		595	bsize => 1024,
		596	bfree => 4333064312,
		597	blocks => 10253828096,
		598	files => 2050765568,
		599	flag => 4096,
		600	favail => 2042092649,
		601	bavail => 4333064312,
		602	ffree => 2042092649,
		603	namemax => 255,
		604	frsize => 1024,
		605	fsid => 1810
		606	}
		607
		608	Here is a (likely partial) list of fsid values used by Linux - it is safe
		609	to hardcode these when the $^O is C<linux>:
		610
		611	0x0000adf5 adfs
		612	0x0000adff affs
		613	0x5346414f afs
		614	0x09041934 anon-inode filesystem
		615	0x00000187 autofs
		616	0x42465331 befs
		617	0x1badface bfs
		618	0x42494e4d binfmt_misc
		619	0x9123683e btrfs
		620	0x0027e0eb cgroupfs
		621	0xff534d42 cifs
		622	0x73757245 coda
		623	0x012ff7b7 coh
		624	0x28cd3d45 cramfs
		625	0x453dcd28 cramfs-wend (wrong endianness)
		626	0x64626720 debugfs
		627	0x00001373 devfs
		628	0x00001cd1 devpts
		629	0x0000f15f ecryptfs
		630	0x00414a53 efs
		631	0x0000137d ext
		632	0x0000ef53 ext2/ext3
		633	0x0000ef51 ext2
		634	0x00004006 fat
		635	0x65735546 fuseblk
		636	0x65735543 fusectl
		637	0x0bad1dea futexfs
		638	0x01161970 gfs2
		639	0x47504653 gpfs
		640	0x00004244 hfs
		641	0xf995e849 hpfs
		642	0x958458f6 hugetlbfs
		643	0x2bad1dea inotifyfs
		644	0x00009660 isofs
		645	0x000072b6 jffs2
		646	0x3153464a jfs
		647	0x6b414653 k-afs
		648	0x0bd00bd0 lustre
		649	0x0000137f minix
		650	0x0000138f minix 30 char names
		651	0x00002468 minix v2
		652	0x00002478 minix v2 30 char names
		653	0x00004d5a minix v3
		654	0x19800202 mqueue
		655	0x00004d44 msdos
		656	0x0000564c novell
		657	0x00006969 nfs
		658	0x6e667364 nfsd
		659	0x00003434 nilfs
		660	0x5346544e ntfs
		661	0x00009fa1 openprom
		662	0x7461636F ocfs2
		663	0x00009fa0 proc
		664	0x6165676c pstorefs
		665	0x0000002f qnx4
		666	0x858458f6 ramfs
		667	0x52654973 reiserfs
		668	0x00007275 romfs
		669	0x67596969 rpc_pipefs
		670	0x73636673 securityfs
		671	0xf97cff8c selinux
		672	0x0000517b smb
		673	0x534f434b sockfs
		674	0x73717368 squashfs
		675	0x62656572 sysfs
		676	0x012ff7b6 sysv2
		677	0x012ff7b5 sysv4
		678	0x01021994 tmpfs
		679	0x15013346 udf
		680	0x00011954 ufs
		681	0x54190100 ufs byteswapped
		682	0x00009fa2 usbdevfs
		683	0x01021997 v9fs
		684	0xa501fcf5 vxfs
		685	0xabba1974 xenfs
		686	0x012ff7b4 xenix
		687	0x58465342 xfs
		688	0x012fd16d xia
		689
431	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	690	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
432		691
433	Works like perl's C<utime> function (including the special case of $atime	692	Works like perl's C<utime> function (including the special case of $atime
434	and $mtime being undef). Fractional times are supported if the underlying	693	and $mtime being undef). Fractional times are supported if the underlying
435	syscalls support them.	694	syscalls support them.
…		…
462	=item aio_truncate $fh_or_path, $offset, $callback->($status)	721	=item aio_truncate $fh_or_path, $offset, $callback->($status)
463		722
464	Works like truncate(2) or ftruncate(2).	723	Works like truncate(2) or ftruncate(2).
465		724
466		725
		726	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		727
		728	Allocates or freed disk space according to the C<$mode> argument. See the
		729	linux C<fallocate> docuemntation for details.
		730
		731	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
		732	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
		733	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
		734
		735	The file system block size used by C<fallocate> is presumably the
		736	C<f_bsize> returned by C<statvfs>.
		737
		738	If C<fallocate> isn't available or cannot be emulated (currently no
		739	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		740
		741
467	=item aio_chmod $fh_or_path, $mode, $callback->($status)	742	=item aio_chmod $fh_or_path, $mode, $callback->($status)
468		743
469	Works like perl's C<chmod> function.	744	Works like perl's C<chmod> function.
470		745
471		746
…		…
473		748
474	Asynchronously unlink (delete) a file and call the callback with the	749	Asynchronously unlink (delete) a file and call the callback with the
475	result code.	750	result code.
476		751
477		752
478	=item aio_mknod $path, $mode, $dev, $callback->($status)	753	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
479		754
480	[EXPERIMENTAL]	755	[EXPERIMENTAL]
481		756
482	Asynchronously create a device node (or fifo). See mknod(2).	757	Asynchronously create a device node (or fifo). See mknod(2).
483		758
484	The only (POSIX-) portable way of calling this function is:	759	The only (POSIX-) portable way of calling this function is:
485		760
486	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	761	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
487		762
		763	See C<aio_stat> for info about some potentially helpful extra constants
		764	and functions.
488		765
489	=item aio_link $srcpath, $dstpath, $callback->($status)	766	=item aio_link $srcpath, $dstpath, $callback->($status)
490		767
491	Asynchronously create a new link to the existing object at C<$srcpath> at	768	Asynchronously create a new link to the existing object at C<$srcpath> at
492	the path C<$dstpath> and call the callback with the result code.	769	the path C<$dstpath> and call the callback with the result code.
…		…
496		773
497	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	774	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
498	the path C<$dstpath> and call the callback with the result code.	775	the path C<$dstpath> and call the callback with the result code.
499		776
500		777
501	=item aio_readlink $path, $callback->($link)	778	=item aio_readlink $pathname, $callback->($link)
502		779
503	Asynchronously read the symlink specified by C<$path> and pass it to	780	Asynchronously read the symlink specified by C<$path> and pass it to
504	the callback. If an error occurs, nothing or undef gets passed to the	781	the callback. If an error occurs, nothing or undef gets passed to the
505	callback.	782	callback.
506		783
507		784
		785	=item aio_realpath $pathname, $callback->($path)
		786
		787	Asynchronously make the path absolute and resolve any symlinks in
		788	C<$path>. The resulting path only consists of directories (Same as
		789	L<Cwd::realpath>).
		790
		791	This request can be used to get the absolute path of the current working
		792	directory by passing it a path of F<.> (a single dot).
		793
		794
508	=item aio_rename $srcpath, $dstpath, $callback->($status)	795	=item aio_rename $srcpath, $dstpath, $callback->($status)
509		796
510	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	797	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
511	rename(2) and call the callback with the result code.	798	rename(2) and call the callback with the result code.
512		799
…		…
528		815
529	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	816	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
530	directory (i.e. opendir + readdir + closedir). The entries will not be	817	directory (i.e. opendir + readdir + closedir). The entries will not be
531	sorted, and will B<NOT> include the C<.> and C<..> entries.	818	sorted, and will B<NOT> include the C<.> and C<..> entries.
532		819
533	The callback a single argument which is either C<undef> or an array-ref	820	The callback is passed a single argument which is either C<undef> or an
534	with the filenames.	821	array-ref with the filenames.
535		822
536		823
		824	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		825
		826	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
		827	tune behaviour and output format. In case of an error, C<$entries> will be
		828	C<undef>.
		829
		830	The flags are a combination of the following constants, ORed together (the
		831	flags will also be passed to the callback, possibly modified):
		832
		833	=over 4
		834
		835	=item IO::AIO::READDIR_DENTS
		836
		837	When this flag is off, then the callback gets an arrayref consisting of
		838	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		839	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		840	entry in more detail.
		841
		842	C<$name> is the name of the entry.
		843
		844	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		845
		846	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		847	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		848	C<IO::AIO::DT_WHT>.
		849
		850	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		851	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		852	scalars are read-only: you can not modify them.
		853
		854	C<$inode> is the inode number (which might not be exact on systems with 64
		855	bit inode numbers and 32 bit perls). This field has unspecified content on
		856	systems that do not deliver the inode information.
		857
		858	=item IO::AIO::READDIR_DIRS_FIRST
		859
		860	When this flag is set, then the names will be returned in an order where
		861	likely directories come first, in optimal stat order. This is useful when
		862	you need to quickly find directories, or you want to find all directories
		863	while avoiding to stat() each entry.
		864
		865	If the system returns type information in readdir, then this is used
		866	to find directories directly. Otherwise, likely directories are names
		867	beginning with ".", or otherwise names with no dots, of which names with
		868	short names are tried first.
		869
		870	=item IO::AIO::READDIR_STAT_ORDER
		871
		872	When this flag is set, then the names will be returned in an order
		873	suitable for stat()'ing each one. That is, when you plan to stat()
		874	all files in the given directory, then the returned order will likely
		875	be fastest.
		876
		877	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		878	the likely dirs come first, resulting in a less optimal stat order.
		879
		880	=item IO::AIO::READDIR_FOUND_UNKNOWN
		881
		882	This flag should not be set when calling C<aio_readdirx>. Instead, it
		883	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		884	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
		885	C<$type>'s are known, which can be used to speed up some algorithms.
		886
		887	=back
		888
		889
537	=item aio_load $path, $data, $callback->($status)	890	=item aio_load $pathname, $data, $callback->($status)
538		891
539	This is a composite request that tries to fully load the given file into	892	This is a composite request that tries to fully load the given file into
540	memory. Status is the same as with aio_read.	893	memory. Status is the same as with aio_read.
541		894
542	=cut	895	=cut
…		…
564		917
565	=item aio_copy $srcpath, $dstpath, $callback->($status)	918	=item aio_copy $srcpath, $dstpath, $callback->($status)
566		919
567	Try to copy the I<file> (directories not supported as either source or	920	Try to copy the I<file> (directories not supported as either source or
568	destination) from C<$srcpath> to C<$dstpath> and call the callback with	921	destination) from C<$srcpath> to C<$dstpath> and call the callback with
569	the C<0> (error) or C<-1> ok.	922	a status of C<0> (ok) or C<-1> (error, see C<$!>).
570		923
571	This is a composite request that it creates the destination file with	924	This is a composite request that creates the destination file with
572	mode 0200 and copies the contents of the source file into it using	925	mode 0200 and copies the contents of the source file into it using
573	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	926	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
574	uid/gid, in that order.	927	uid/gid, in that order.
575		928
576	If an error occurs, the partial destination file will be unlinked, if	929	If an error occurs, the partial destination file will be unlinked, if
…		…
586	my $grp = aio_group $cb;	939	my $grp = aio_group $cb;
587		940
588	aioreq_pri $pri;	941	aioreq_pri $pri;
589	add $grp aio_open $src, O_RDONLY, 0, sub {	942	add $grp aio_open $src, O_RDONLY, 0, sub {
590	if (my $src_fh = $_[0]) {	943	if (my $src_fh = $_[0]) {
591	my @stat = stat $src_fh;	944	my @stat = stat $src_fh; # hmm, might block over nfs?
592		945
593	aioreq_pri $pri;	946	aioreq_pri $pri;
594	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {	947	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
595	if (my $dst_fh = $_[0]) {	948	if (my $dst_fh = $_[0]) {
596	aioreq_pri $pri;	949	aioreq_pri $pri;
597	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	950	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
598	if ($_[0] == $stat[7]) {	951	if ($_[0] == $stat[7]) {
599	$grp->result (0);	952	$grp->result (0);
600	close $src_fh;	953	close $src_fh;
601		954
602	# those should not normally block. should. should.	955	my $ch = sub {
603	utime $stat[8], $stat[9], $dst;	956	aioreq_pri $pri;
604	chmod $stat[2] & 07777, $dst_fh;	957	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
605	chown $stat[4], $stat[5], $dst_fh;	958	aioreq_pri $pri;
		959	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		960	aioreq_pri $pri;
		961	add $grp aio_close $dst_fh;
		962	}
		963	};
		964	};
606		965
607	aioreq_pri $pri;	966	aioreq_pri $pri;
608	add $grp aio_close $dst_fh;	967	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		968	if ($_[0] < 0 && $! == ENOSYS) {
		969	aioreq_pri $pri;
		970	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		971	} else {
		972	$ch->();
		973	}
		974	};
609	} else {	975	} else {
610	$grp->result (-1);	976	$grp->result (-1);
611	close $src_fh;	977	close $src_fh;
612	close $dst_fh;	978	close $dst_fh;
613		979
…		…
630		996
631	=item aio_move $srcpath, $dstpath, $callback->($status)	997	=item aio_move $srcpath, $dstpath, $callback->($status)
632		998
633	Try to move the I<file> (directories not supported as either source or	999	Try to move the I<file> (directories not supported as either source or
634	destination) from C<$srcpath> to C<$dstpath> and call the callback with	1000	destination) from C<$srcpath> to C<$dstpath> and call the callback with
635	the C<0> (error) or C<-1> ok.	1001	a status of C<0> (ok) or C<-1> (error, see C<$!>).
636		1002
637	This is a composite request that tries to rename(2) the file first. If	1003	This is a composite request that tries to rename(2) the file first; if
638	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if	1004	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
639	that is successful, unlinking the C<$srcpath>.	1005	that is successful, unlinks the C<$srcpath>.
640		1006
641	=cut	1007	=cut
642		1008
643	sub aio_move($$;$) {	1009	sub aio_move($$;$) {
644	my ($src, $dst, $cb) = @_;	1010	my ($src, $dst, $cb) = @_;
…		…
651	if ($_[0] && $! == EXDEV) {	1017	if ($_[0] && $! == EXDEV) {
652	aioreq_pri $pri;	1018	aioreq_pri $pri;
653	add $grp aio_copy $src, $dst, sub {	1019	add $grp aio_copy $src, $dst, sub {
654	$grp->result ($_[0]);	1020	$grp->result ($_[0]);
655		1021
656	if (!$_[0]) {	1022	unless ($_[0]) {
657	aioreq_pri $pri;	1023	aioreq_pri $pri;
658	add $grp aio_unlink $src;	1024	add $grp aio_unlink $src;
659	}	1025	}
660	};	1026	};
661	} else {	1027	} else {
…		…
664	};	1030	};
665		1031
666	$grp	1032	$grp
667	}	1033	}
668		1034
669	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1035	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
670		1036
671	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1037	Scans a directory (similar to C<aio_readdir>) but additionally tries to
672	efficiently separate the entries of directory C<$path> into two sets of	1038	efficiently separate the entries of directory C<$path> into two sets of
673	names, directories you can recurse into (directories), and ones you cannot	1039	names, directories you can recurse into (directories), and ones you cannot
674	recurse into (everything else, including symlinks to directories).	1040	recurse into (everything else, including symlinks to directories).
…		…
691		1057
692	Implementation notes.	1058	Implementation notes.
693		1059
694	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	1060	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
695		1061
		1062	If readdir returns file type information, then this is used directly to
		1063	find directories.
		1064
696	After reading the directory, the modification time, size etc. of the	1065	Otherwise, after reading the directory, the modification time, size etc.
697	directory before and after the readdir is checked, and if they match (and	1066	of the directory before and after the readdir is checked, and if they
698	isn't the current time), the link count will be used to decide how many	1067	match (and isn't the current time), the link count will be used to decide
699	entries are directories (if >= 2). Otherwise, no knowledge of the number	1068	how many entries are directories (if >= 2). Otherwise, no knowledge of the
700	of subdirectories will be assumed.	1069	number of subdirectories will be assumed.
701		1070
702	Then entries will be sorted into likely directories (everything without	1071	Then entries will be sorted into likely directories a non-initial dot
703	a non-initial dot currently) and likely non-directories (everything	1072	currently) and likely non-directories (see C<aio_readdirx>). Then every
704	else). Then every entry plus an appended C</.> will be C<stat>'ed,	1073	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
705	likely directories first. If that succeeds, it assumes that the entry	1074	in order of their inode numbers. If that succeeds, it assumes that the
706	is a directory or a symlink to directory (which will be checked	1075	entry is a directory or a symlink to directory (which will be checked
707	seperately). This is often faster than stat'ing the entry itself because	1076	separately). This is often faster than stat'ing the entry itself because
708	filesystems might detect the type of the entry without reading the inode	1077	filesystems might detect the type of the entry without reading the inode
709	data (e.g. ext2fs filetype feature).	1078	data (e.g. ext2fs filetype feature), even on systems that cannot return
		1079	the filetype information on readdir.
710		1080
711	If the known number of directories (link count - 2) has been reached, the	1081	If the known number of directories (link count - 2) has been reached, the
712	rest of the entries is assumed to be non-directories.	1082	rest of the entries is assumed to be non-directories.
713		1083
714	This only works with certainty on POSIX (= UNIX) filesystems, which	1084	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
727		1097
728	my $grp = aio_group $cb;	1098	my $grp = aio_group $cb;
729		1099
730	$maxreq = 4 if $maxreq <= 0;	1100	$maxreq = 4 if $maxreq <= 0;
731		1101
732	# stat once	1102	# get a wd object
733	aioreq_pri $pri;	1103	aioreq_pri $pri;
734	add $grp aio_stat $path, sub {	1104	add $grp aio_wd $path, sub {
		1105	$_[0]
735	return $grp->result () if $_[0];	1106	or return $grp->result ();
736	my $now = time;
737	my $hash1 = join ":", (stat _)[0,1,3,7,9];
738		1107
739	# read the directory entries	1108	my $wd = [shift, "."];
		1109
		1110	# stat once
740	aioreq_pri $pri;	1111	aioreq_pri $pri;
741	add $grp aio_readdir $path, sub {	1112	add $grp aio_stat $wd, sub {
742	my $entries = shift
743	or return $grp->result ();	1113	return $grp->result () if $_[0];
		1114	my $now = time;
		1115	my $hash1 = join ":", (stat _)[0,1,3,7,9];
744		1116
745	# stat the dir another time	1117	# read the directory entries
746	aioreq_pri $pri;	1118	aioreq_pri $pri;
		1119	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1120	my $entries = shift
		1121	or return $grp->result ();
		1122
		1123	# stat the dir another time
		1124	aioreq_pri $pri;
747	add $grp aio_stat $path, sub {	1125	add $grp aio_stat $wd, sub {
748	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1126	my $hash2 = join ":", (stat _)[0,1,3,7,9];
749		1127
750	my $ndirs;	1128	my $ndirs;
751		1129
752	# take the slow route if anything looks fishy	1130	# take the slow route if anything looks fishy
753	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1131	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
754	$ndirs = -1;	1132	$ndirs = -1;
755	} else {	1133	} else {
756	# if nlink == 2, we are finished	1134	# if nlink == 2, we are finished
757	# on non-posix-fs's, we rely on nlink < 2	1135	# for non-posix-fs's, we rely on nlink < 2
758	$ndirs = (stat _)[3] - 2	1136	$ndirs = (stat _)[3] - 2
759	or return $grp->result ([], $entries);	1137	or return $grp->result ([], $entries);
760	}	1138	}
761		1139
762	# sort into likely dirs and likely nondirs
763	# dirs == files without ".", short entries first
764	$entries = [map $_->[0],
765	sort { $b->[1] cmp $a->[1] }
766	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
767	@$entries];
768
769	my (@dirs, @nondirs);	1140	my (@dirs, @nondirs);
770		1141
771	my $statgrp = add $grp aio_group sub {	1142	my $statgrp = add $grp aio_group sub {
772	$grp->result (\@dirs, \@nondirs);	1143	$grp->result (\@dirs, \@nondirs);
773	};	1144	};
774		1145
775	limit $statgrp $maxreq;	1146	limit $statgrp $maxreq;
776	feed $statgrp sub {	1147	feed $statgrp sub {
777	return unless @$entries;	1148	return unless @$entries;
778	my $entry = pop @$entries;	1149	my $entry = shift @$entries;
779		1150
780	aioreq_pri $pri;	1151	aioreq_pri $pri;
		1152	$wd->[1] = "$entry/.";
781	add $statgrp aio_stat "$path/$entry/.", sub {	1153	add $statgrp aio_stat $wd, sub {
782	if ($_[0] < 0) {	1154	if ($_[0] < 0) {
783	push @nondirs, $entry;	1155	push @nondirs, $entry;
784	} else {	1156	} else {
785	# need to check for real directory	1157	# need to check for real directory
786	aioreq_pri $pri;	1158	aioreq_pri $pri;
		1159	$wd->[1] = $entry;
787	add $statgrp aio_lstat "$path/$entry", sub {	1160	add $statgrp aio_lstat $wd, sub {
788	if (-d _) {	1161	if (-d _) {
789	push @dirs, $entry;	1162	push @dirs, $entry;
790		1163
791	unless (--$ndirs) {	1164	unless (--$ndirs) {
792	push @nondirs, @$entries;	1165	push @nondirs, @$entries;
793	feed $statgrp;	1166	feed $statgrp;
		1167	}
		1168	} else {
		1169	push @nondirs, $entry;
794	}	1170	}
795	} else {
796	push @nondirs, $entry;
797	}	1171	}
798	}	1172	}
799	}	1173	};
800	};	1174	};
801	};	1175	};
802	};	1176	};
803	};	1177	};
804	};	1178	};
805		1179
806	$grp	1180	$grp
807	}	1181	}
808		1182
809	=item aio_rmtree $path, $callback->($status)	1183	=item aio_rmtree $pathname, $callback->($status)
810		1184
811	Delete a directory tree starting (and including) C<$path>, return the	1185	Delete a directory tree starting (and including) C<$path>, return the
812	status of the final C<rmdir> only. This is a composite request that	1186	status of the final C<rmdir> only. This is a composite request that
813	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1187	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
814	everything else.	1188	everything else.
…		…
856	callback with the fdatasync result code.	1230	callback with the fdatasync result code.
857		1231
858	If this call isn't available because your OS lacks it or it couldn't be	1232	If this call isn't available because your OS lacks it or it couldn't be
859	detected, it will be emulated by calling C<fsync> instead.	1233	detected, it will be emulated by calling C<fsync> instead.
860		1234
		1235	=item aio_syncfs $fh, $callback->($status)
		1236
		1237	Asynchronously call the syncfs syscall to sync the filesystem associated
		1238	to the given filehandle and call the callback with the syncfs result
		1239	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1240	errno to C<ENOSYS> nevertheless.
		1241
		1242	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		1243
		1244	Sync the data portion of the file specified by C<$offset> and C<$length>
		1245	to disk (but NOT the metadata), by calling the Linux-specific
		1246	sync_file_range call. If sync_file_range is not available or it returns
		1247	ENOSYS, then fdatasync or fsync is being substituted.
		1248
		1249	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		1250	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		1251	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		1252	manpage for details.
		1253
861	=item aio_pathsync $path, $callback->($status)	1254	=item aio_pathsync $pathname, $callback->($status)
862		1255
863	This request tries to open, fsync and close the given path. This is a	1256	This request tries to open, fsync and close the given path. This is a
864	composite request intended tosync directories after directory operations	1257	composite request intended to sync directories after directory operations
865	(E.g. rename). This might not work on all operating systems or have any	1258	(E.g. rename). This might not work on all operating systems or have any
866	specific effect, but usually it makes sure that directory changes get	1259	specific effect, but usually it makes sure that directory changes get
867	written to disc. It works for anything that can be opened for read-only,	1260	written to disc. It works for anything that can be opened for read-only,
868	not just directories.	1261	not just directories.
		1262
		1263	Future versions of this function might fall back to other methods when
		1264	C<fsync> on the directory fails (such as calling C<sync>).
869		1265
870	Passes C<0> when everything went ok, and C<-1> on error.	1266	Passes C<0> when everything went ok, and C<-1> on error.
871		1267
872	=cut	1268	=cut
873		1269
…		…
894	};	1290	};
895		1291
896	$grp	1292	$grp
897	}	1293	}
898		1294
		1295	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1296
		1297	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1298	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1299	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1300	scalar must only be modified in-place while an aio operation is pending on
		1301	it).
		1302
		1303	It calls the C<msync> function of your OS, if available, with the memory
		1304	area starting at C<$offset> in the string and ending C<$length> bytes
		1305	later. If C<$length> is negative, counts from the end, and if C<$length>
		1306	is C<undef>, then it goes till the end of the string. The flags can be
		1307	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1308	C<IO::AIO::MS_SYNC>.
		1309
		1310	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1311
		1312	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1313	scalars.
		1314
		1315	It touches (reads or writes) all memory pages in the specified
		1316	range inside the scalar. All caveats and parameters are the same
		1317	as for C<aio_msync>, above, except for flags, which must be either
		1318	C<0> (which reads all pages and ensures they are instantiated) or
		1319	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1320	writing an octet from it, which dirties the page).
		1321
		1322	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1323
		1324	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1325	scalars.
		1326
		1327	It reads in all the pages of the underlying storage into memory (if any)
		1328	and locks them, so they are not getting swapped/paged out or removed.
		1329
		1330	If C<$length> is undefined, then the scalar will be locked till the end.
		1331
		1332	On systems that do not implement C<mlock>, this function returns C<-1>
		1333	and sets errno to C<ENOSYS>.
		1334
		1335	Note that the corresponding C<munlock> is synchronous and is
		1336	documented under L<MISCELLANEOUS FUNCTIONS>.
		1337
		1338	Example: open a file, mmap and mlock it - both will be undone when
		1339	C<$data> gets destroyed.
		1340
		1341	open my $fh, "<", $path or die "$path: $!";
		1342	my $data;
		1343	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1344	aio_mlock $data; # mlock in background
		1345
		1346	=item aio_mlockall $flags, $callback->($status)
		1347
		1348	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1349	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1350
		1351	On systems that do not implement C<mlockall>, this function returns C<-1>
		1352	and sets errno to C<ENOSYS>.
		1353
		1354	Note that the corresponding C<munlockall> is synchronous and is
		1355	documented under L<MISCELLANEOUS FUNCTIONS>.
		1356
		1357	Example: asynchronously lock all current and future pages into memory.
		1358
		1359	aio_mlockall IO::AIO::MCL_FUTURE;
		1360
		1361	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1362
		1363	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1364	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1365	the ioctl is not available on your OS, then this request will fail with
		1366	C<ENOSYS>.
		1367
		1368	C<$start> is the starting offset to query extents for, C<$length> is the
		1369	size of the range to query - if it is C<undef>, then the whole file will
		1370	be queried.
		1371
		1372	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1373	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1374	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1375	the data portion.
		1376
		1377	C<$count> is the maximum number of extent records to return. If it is
		1378	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1379	case, if it is C<0>, then the callback receives the number of extents
		1380	instead of the extents themselves (which is unreliable, see below).
		1381
		1382	If an error occurs, the callback receives no arguments. The special
		1383	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1384
		1385	Otherwise, the callback receives an array reference with extent
		1386	structures. Each extent structure is an array reference itself, with the
		1387	following members:
		1388
		1389	[$logical, $physical, $length, $flags]
		1390
		1391	Flags is any combination of the following flag values (typically either C<0>
		1392	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1393
		1394	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1395	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1396	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1397	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1398	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1399	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1400
		1401	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1402	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1403	it to return all extents of a range for files with large number of
		1404	extents. The code works around all these issues if C<$count> is undef.
		1405
899	=item aio_group $callback->(...)	1406	=item aio_group $callback->(...)
900		1407
901	This is a very special aio request: Instead of doing something, it is a	1408	This is a very special aio request: Instead of doing something, it is a
902	container for other aio requests, which is useful if you want to bundle	1409	container for other aio requests, which is useful if you want to bundle
903	many requests into a single, composite, request with a definite callback	1410	many requests into a single, composite, request with a definite callback
…		…
940	immense (it blocks a thread for a long time) so do not use this function	1447	immense (it blocks a thread for a long time) so do not use this function
941	except to put your application under artificial I/O pressure.	1448	except to put your application under artificial I/O pressure.
942		1449
943	=back	1450	=back
944		1451
		1452
		1453	=head2 IO::AIO::WD - multiple working directories
		1454
		1455	Your process only has one current working directory, which is used by all
		1456	threads. This makes it hard to use relative paths (some other component
		1457	could call C<chdir> at any time, and it is hard to control when the path
		1458	will be used by IO::AIO).
		1459
		1460	One solution for this is to always use absolute paths. This usually works,
		1461	but can be quite slow (the kernel has to walk the whole path on every
		1462	access), and can also be a hassle to implement.
		1463
		1464	Newer POSIX systems have a number of functions (openat, fdopendir,
		1465	futimensat and so on) that make it possible to specify working directories
		1466	per operation.
		1467
		1468	For portability, and because the clowns who "designed", or shall I write,
		1469	perpetrated this new interface were obviously half-drunk, this abstraction
		1470	cannot be perfect, though.
		1471
		1472	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1473	object. This object stores the canonicalised, absolute version of the
		1474	path, and on systems that allow it, also a directory file descriptor.
		1475
		1476	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1477	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1478	object and a pathname instead (or the IO::AIO::WD object alone, which
		1479	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1480	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1481	to that IO::AIO::WD object.
		1482
		1483	For example, to get a wd object for F</etc> and then stat F<passwd>
		1484	inside, you would write:
		1485
		1486	aio_wd "/etc", sub {
		1487	my $etcdir = shift;
		1488
		1489	# although $etcdir can be undef on error, there is generally no reason
		1490	# to check for errors here, as aio_stat will fail with ENOENT
		1491	# when $etcdir is undef.
		1492
		1493	aio_stat [$etcdir, "passwd"], sub {
		1494	# yay
		1495	};
		1496	};
		1497
		1498	That C<aio_wd> is a request and not a normal function shows that creating
		1499	an IO::AIO::WD object is itself a potentially blocking operation, which is
		1500	why it is done asynchronously.
		1501
		1502	To stat the directory obtained with C<aio_wd> above, one could write
		1503	either of the following three request calls:
		1504
		1505	aio_lstat "/etc" , sub { ... # pathname as normal string
		1506	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1507	aio_lstat $wd , sub { ... # shorthand for the previous
		1508
		1509	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1510	object and the pathname string, so you could write the following without
		1511	causing any issues due to C<$path> getting reused:
		1512
		1513	my $path = [$wd, undef];
		1514
		1515	for my $name (qw(abc def ghi)) {
		1516	$path->[1] = $name;
		1517	aio_stat $path, sub {
		1518	# ...
		1519	};
		1520	}
		1521
		1522	There are some caveats: when directories get renamed (or deleted), the
		1523	pathname string doesn't change, so will point to the new directory (or
		1524	nowhere at all), while the directory fd, if available on the system,
		1525	will still point to the original directory. Most functions accepting a
		1526	pathname will use the directory fd on newer systems, and the string on
		1527	older systems. Some functions (such as realpath) will always rely on the
		1528	string form of the pathname.
		1529
		1530	So this fucntionality is mainly useful to get some protection against
		1531	C<chdir>, to easily get an absolute path out of a relative path for future
		1532	reference, and to speed up doing many operations in the same directory
		1533	(e.g. when stat'ing all files in a directory).
		1534
		1535	The following functions implement this working directory abstraction:
		1536
		1537	=over 4
		1538
		1539	=item aio_wd $pathname, $callback->($wd)
		1540
		1541	Asynchonously canonicalise the given pathname and convert it to an
		1542	IO::AIO::WD object representing it. If possible and supported on the
		1543	system, also open a directory fd to speed up pathname resolution relative
		1544	to this working directory.
		1545
		1546	If something goes wrong, then C<undef> is passwd to the callback instead
		1547	of a working directory object and C<$!> is set appropriately. Since
		1548	passing C<undef> as working directory component of a pathname fails the
		1549	request with C<ENOENT>, there is often no need for error checking in the
		1550	C<aio_wd> callback, as future requests using the value will fail in the
		1551	expected way.
		1552
		1553	If this call isn't available because your OS lacks it or it couldn't be
		1554	detected, it will be emulated by calling C<fsync> instead.
		1555
		1556	=item IO::AIO::CWD
		1557
		1558	This is a compiletime constant (object) that represents the process
		1559	current working directory.
		1560
		1561	Specifying this object as working directory object for a pathname is as
		1562	if the pathname would be specified directly, without a directory object,
		1563	e.g., these calls are functionally identical:
		1564
		1565	aio_stat "somefile", sub { ... };
		1566	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1567
		1568	=back
		1569
		1570
945	=head2 IO::AIO::REQ CLASS	1571	=head2 IO::AIO::REQ CLASS
946		1572
947	All non-aggregate C<aio_*> functions return an object of this class when	1573	All non-aggregate C<aio_*> functions return an object of this class when
948	called in non-void context.	1574	called in non-void context.
949		1575
…		…
952	=item cancel $req	1578	=item cancel $req
953		1579
954	Cancels the request, if possible. Has the effect of skipping execution	1580	Cancels the request, if possible. Has the effect of skipping execution
955	when entering the B<execute> state and skipping calling the callback when	1581	when entering the B<execute> state and skipping calling the callback when
956	entering the the B<result> state, but will leave the request otherwise	1582	entering the the B<result> state, but will leave the request otherwise
957	untouched. That means that requests that currently execute will not be	1583	untouched (with the exception of readdir). That means that requests that
958	stopped and resources held by the request will not be freed prematurely.	1584	currently execute will not be stopped and resources held by the request
		1585	will not be freed prematurely.
959		1586
960	=item cb $req $callback->(...)	1587	=item cb $req $callback->(...)
961		1588
962	Replace (or simply set) the callback registered to the request.	1589	Replace (or simply set) the callback registered to the request.
963		1590
…		…
1014	Their lifetime, simplified, looks like this: when they are empty, they	1641	Their lifetime, simplified, looks like this: when they are empty, they
1015	will finish very quickly. If they contain only requests that are in the	1642	will finish very quickly. If they contain only requests that are in the
1016	C<done> state, they will also finish. Otherwise they will continue to	1643	C<done> state, they will also finish. Otherwise they will continue to
1017	exist.	1644	exist.
1018		1645
1019	That means after creating a group you have some time to add requests. And	1646	That means after creating a group you have some time to add requests
1020	in the callbacks of those requests, you can add further requests to the	1647	(precisely before the callback has been invoked, which is only done within
1021	group. And only when all those requests have finished will the the group	1648	the C<poll_cb>). And in the callbacks of those requests, you can add
1022	itself finish.	1649	further requests to the group. And only when all those requests have
		1650	finished will the the group itself finish.
1023		1651
1024	=over 4	1652	=over 4
1025		1653
1026	=item add $grp ...	1654	=item add $grp ...
1027		1655
…		…
1035		1663
1036	=item $grp->cancel_subs	1664	=item $grp->cancel_subs
1037		1665
1038	Cancel all subrequests and clears any feeder, but not the group request	1666	Cancel all subrequests and clears any feeder, but not the group request
1039	itself. Useful when you queued a lot of events but got a result early.	1667	itself. Useful when you queued a lot of events but got a result early.
		1668
		1669	The group request will finish normally (you cannot add requests to the
		1670	group).
1040		1671
1041	=item $grp->result (...)	1672	=item $grp->result (...)
1042		1673
1043	Set the result value(s) that will be passed to the group callback when all	1674	Set the result value(s) that will be passed to the group callback when all
1044	subrequests have finished and set the groups errno to the current value	1675	subrequests have finished and set the groups errno to the current value
…		…
1060	=item feed $grp $callback->($grp)	1691	=item feed $grp $callback->($grp)
1061		1692
1062	Sets a feeder/generator on this group: every group can have an attached	1693	Sets a feeder/generator on this group: every group can have an attached
1063	generator that generates requests if idle. The idea behind this is that,	1694	generator that generates requests if idle. The idea behind this is that,
1064	although you could just queue as many requests as you want in a group,	1695	although you could just queue as many requests as you want in a group,
1065	this might starve other requests for a potentially long time. For	1696	this might starve other requests for a potentially long time. For example,
1066	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1697	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1067	requests, delaying any later requests for a long time.	1698	requests, delaying any later requests for a long time.
1068		1699
1069	To avoid this, and allow incremental generation of requests, you can	1700	To avoid this, and allow incremental generation of requests, you can
1070	instead a group and set a feeder on it that generates those requests. The	1701	instead a group and set a feeder on it that generates those requests. The
1071	feed callback will be called whenever there are few enough (see C<limit>,	1702	feed callback will be called whenever there are few enough (see C<limit>,
…		…
1076	not impose any limits).	1707	not impose any limits).
1077		1708
1078	If the feed does not queue more requests when called, it will be	1709	If the feed does not queue more requests when called, it will be
1079	automatically removed from the group.	1710	automatically removed from the group.
1080		1711
1081	If the feed limit is C<0>, it will be set to C<2> automatically.	1712	If the feed limit is C<0> when this method is called, it will be set to
		1713	C<2> automatically.
1082		1714
1083	Example:	1715	Example:
1084		1716
1085	# stat all files in @files, but only ever use four aio requests concurrently:	1717	# stat all files in @files, but only ever use four aio requests concurrently:
1086		1718
…		…
1098	Sets the feeder limit for the group: The feeder will be called whenever	1730	Sets the feeder limit for the group: The feeder will be called whenever
1099	the group contains less than this many requests.	1731	the group contains less than this many requests.
1100		1732
1101	Setting the limit to C<0> will pause the feeding process.	1733	Setting the limit to C<0> will pause the feeding process.
1102		1734
		1735	The default value for the limit is C<0>, but note that setting a feeder
		1736	automatically bumps it up to C<2>.
		1737
1103	=back	1738	=back
1104		1739
1105	=head2 SUPPORT FUNCTIONS	1740	=head2 SUPPORT FUNCTIONS
1106		1741
1107	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1742	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
…		…
1109	=over 4	1744	=over 4
1110		1745
1111	=item $fileno = IO::AIO::poll_fileno	1746	=item $fileno = IO::AIO::poll_fileno
1112		1747
1113	Return the I<request result pipe file descriptor>. This filehandle must be	1748	Return the I<request result pipe file descriptor>. This filehandle must be
1114	polled for reading by some mechanism outside this module (e.g. Event or	1749	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1115	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1750	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1116	to call C<poll_cb> to check the results.	1751	you have to call C<poll_cb> to check the results.
1117		1752
1118	See C<poll_cb> for an example.	1753	See C<poll_cb> for an example.
1119		1754
1120	=item IO::AIO::poll_cb	1755	=item IO::AIO::poll_cb
1121		1756
1122	Process some outstanding events on the result pipe. You have to call this	1757	Process some outstanding events on the result pipe. You have to call
1123	regularly. Returns the number of events processed. Returns immediately	1758	this regularly. Returns C<0> if all events could be processed (or there
1124	when no events are outstanding. The amount of events processed depends on	1759	were no events to process), or C<-1> if it returned earlier for whatever
1125	the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1760	reason. Returns immediately when no events are outstanding. The amount of
		1761	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1762	C<IO::AIO::max_poll_time>.
1126		1763
1127	If not all requests were processed for whatever reason, the filehandle	1764	If not all requests were processed for whatever reason, the filehandle
1128	will still be ready when C<poll_cb> returns.	1765	will still be ready when C<poll_cb> returns, so normally you don't have to
		1766	do anything special to have it called later.
		1767
		1768	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1769	ready, it can be beneficial to call this function from loops which submit
		1770	a lot of requests, to make sure the results get processed when they become
		1771	available and not just when the loop is finished and the event loop takes
		1772	over again. This function returns very fast when there are no outstanding
		1773	requests.
1129		1774
1130	Example: Install an Event watcher that automatically calls	1775	Example: Install an Event watcher that automatically calls
1131	IO::AIO::poll_cb with high priority:	1776	IO::AIO::poll_cb with high priority (more examples can be found in the
		1777	SYNOPSIS section, at the top of this document):
1132		1778
1133	Event->io (fd => IO::AIO::poll_fileno,	1779	Event->io (fd => IO::AIO::poll_fileno,
1134	poll => 'r', async => 1,	1780	poll => 'r', async => 1,
1135	cb => \&IO::AIO::poll_cb);	1781	cb => \&IO::AIO::poll_cb);
		1782
		1783	=item IO::AIO::poll_wait
		1784
		1785	If there are any outstanding requests and none of them in the result
		1786	phase, wait till the result filehandle becomes ready for reading (simply
		1787	does a C<select> on the filehandle. This is useful if you want to
		1788	synchronously wait for some requests to finish).
		1789
		1790	See C<nreqs> for an example.
		1791
		1792	=item IO::AIO::poll
		1793
		1794	Waits until some requests have been handled.
		1795
		1796	Returns the number of requests processed, but is otherwise strictly
		1797	equivalent to:
		1798
		1799	IO::AIO::poll_wait, IO::AIO::poll_cb
		1800
		1801	=item IO::AIO::flush
		1802
		1803	Wait till all outstanding AIO requests have been handled.
		1804
		1805	Strictly equivalent to:
		1806
		1807	IO::AIO::poll_wait, IO::AIO::poll_cb
		1808	while IO::AIO::nreqs;
1136		1809
1137	=item IO::AIO::max_poll_reqs $nreqs	1810	=item IO::AIO::max_poll_reqs $nreqs
1138		1811
1139	=item IO::AIO::max_poll_time $seconds	1812	=item IO::AIO::max_poll_time $seconds
1140		1813
…		…
1165	# use a low priority so other tasks have priority	1838	# use a low priority so other tasks have priority
1166	Event->io (fd => IO::AIO::poll_fileno,	1839	Event->io (fd => IO::AIO::poll_fileno,
1167	poll => 'r', nice => 1,	1840	poll => 'r', nice => 1,
1168	cb => &IO::AIO::poll_cb);	1841	cb => &IO::AIO::poll_cb);
1169		1842
1170	=item IO::AIO::poll_wait
1171
1172	If there are any outstanding requests and none of them in the result
1173	phase, wait till the result filehandle becomes ready for reading (simply
1174	does a C<select> on the filehandle. This is useful if you want to
1175	synchronously wait for some requests to finish).
1176
1177	See C<nreqs> for an example.
1178
1179	=item IO::AIO::poll
1180
1181	Waits until some requests have been handled.
1182
1183	Returns the number of requests processed, but is otherwise strictly
1184	equivalent to:
1185
1186	IO::AIO::poll_wait, IO::AIO::poll_cb
1187
1188	=item IO::AIO::flush
1189
1190	Wait till all outstanding AIO requests have been handled.
1191
1192	Strictly equivalent to:
1193
1194	IO::AIO::poll_wait, IO::AIO::poll_cb
1195	while IO::AIO::nreqs;
1196
1197	=back	1843	=back
1198		1844
1199	=head3 CONTROLLING THE NUMBER OF THREADS	1845	=head3 CONTROLLING THE NUMBER OF THREADS
1200		1846
1201	=over	1847	=over
…		…
1234		1880
1235	Under normal circumstances you don't need to call this function.	1881	Under normal circumstances you don't need to call this function.
1236		1882
1237	=item IO::AIO::max_idle $nthreads	1883	=item IO::AIO::max_idle $nthreads
1238		1884
1239	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1885	Limit the number of threads (default: 4) that are allowed to idle
1240	threads that did not get a request to process within 10 seconds). That	1886	(i.e., threads that did not get a request to process within the idle
1241	means if a thread becomes idle while C<$nthreads> other threads are also	1887	timeout (default: 10 seconds). That means if a thread becomes idle while
1242	idle, it will free its resources and exit.	1888	C<$nthreads> other threads are also idle, it will free its resources and
		1889	exit.
1243		1890
1244	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1891	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1245	to allow for extremely high load situations, but want to free resources	1892	to allow for extremely high load situations, but want to free resources
1246	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1893	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1247		1894
1248	The default is probably ok in most situations, especially if thread	1895	The default is probably ok in most situations, especially if thread
1249	creation is fast. If thread creation is very slow on your system you might	1896	creation is fast. If thread creation is very slow on your system you might
1250	want to use larger values.	1897	want to use larger values.
1251		1898
		1899	=item IO::AIO::idle_timeout $seconds
		1900
		1901	Sets the minimum idle timeout (default 10) after which worker threads are
		1902	allowed to exit. SEe C<IO::AIO::max_idle>.
		1903
1252	=item IO::AIO::max_outstanding $maxreqs	1904	=item IO::AIO::max_outstanding $maxreqs
		1905
		1906	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1907	you do queue up more than this number of requests, the next call to
		1908	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1909	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1910	longer exceeded.
		1911
		1912	In other words, this setting does not enforce a queue limit, but can be
		1913	used to make poll functions block if the limit is exceeded.
1253		1914
1254	This is a very bad function to use in interactive programs because it	1915	This is a very bad function to use in interactive programs because it
1255	blocks, and a bad way to reduce concurrency because it is inexact: Better	1916	blocks, and a bad way to reduce concurrency because it is inexact: Better
1256	use an C<aio_group> together with a feed callback.	1917	use an C<aio_group> together with a feed callback.
1257		1918
1258	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1919	It's main use is in scripts without an event loop - when you want to stat
1259	do queue up more than this number of requests, the next call to the	1920	a lot of files, you can write somehting like this:
1260	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1261	function will block until the limit is no longer exceeded.
1262		1921
1263	The default value is very large, so there is no practical limit on the	1922	IO::AIO::max_outstanding 32;
1264	number of outstanding requests.
1265		1923
1266	You can still queue as many requests as you want. Therefore,	1924	for my $path (...) {
1267	C<max_outstanding> is mainly useful in simple scripts (with low values) or	1925	aio_stat $path , ...;
1268	as a stop gap to shield against fatal memory overflow (with large values).	1926	IO::AIO::poll_cb;
		1927	}
		1928
		1929	IO::AIO::flush;
		1930
		1931	The call to C<poll_cb> inside the loop will normally return instantly, but
		1932	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1933	some requests have been handled. This keeps the loop from pushing a large
		1934	number of C<aio_stat> requests onto the queue.
		1935
		1936	The default value for C<max_outstanding> is very large, so there is no
		1937	practical limit on the number of outstanding requests.
1269		1938
1270	=back	1939	=back
1271		1940
1272	=head3 STATISTICAL INFORMATION	1941	=head3 STATISTICAL INFORMATION
1273		1942
…		…
1293	Returns the number of requests currently in the pending state (executed,	1962	Returns the number of requests currently in the pending state (executed,
1294	but not yet processed by poll_cb).	1963	but not yet processed by poll_cb).
1295		1964
1296	=back	1965	=back
1297		1966
		1967	=head3 MISCELLANEOUS FUNCTIONS
		1968
		1969	IO::AIO implements some functions that might be useful, but are not
		1970	asynchronous.
		1971
		1972	=over 4
		1973
		1974	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1975
		1976	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1977	but is blocking (this makes most sense if you know the input data is
		1978	likely cached already and the output filehandle is set to non-blocking
		1979	operations).
		1980
		1981	Returns the number of bytes copied, or C<-1> on error.
		1982
		1983	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1984
		1985	Simply calls the C<posix_fadvise> function (see its
		1986	manpage for details). The following advice constants are
		1987	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1988	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1989	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1990
		1991	On systems that do not implement C<posix_fadvise>, this function returns
		1992	ENOSYS, otherwise the return value of C<posix_fadvise>.
		1993
		1994	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1995
		1996	Simply calls the C<posix_madvise> function (see its
		1997	manpage for details). The following advice constants are
		1998	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1999	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		2000
		2001	On systems that do not implement C<posix_madvise>, this function returns
		2002	ENOSYS, otherwise the return value of C<posix_madvise>.
		2003
		2004	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		2005
		2006	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		2007	$scalar (see its manpage for details). The following protect
		2008	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		2009	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		2010
		2011	On systems that do not implement C<mprotect>, this function returns
		2012	ENOSYS, otherwise the return value of C<mprotect>.
		2013
		2014	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		2015
		2016	Memory-maps a file (or anonymous memory range) and attaches it to the
		2017	given C<$scalar>, which will act like a string scalar. Returns true on
		2018	success, and false otherwise.
		2019
		2020	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		2021	change the string length, and most read-only operations such as copying it
		2022	or searching it with regexes and so on.
		2023
		2024	Anything else is unsafe and will, at best, result in memory leaks.
		2025
		2026	The memory map associated with the C<$scalar> is automatically removed
		2027	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		2028	C<IO::AIO::munmap> functions are called.
		2029
		2030	This calls the C<mmap>(2) function internally. See your system's manual
		2031	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		2032
		2033	The C<$length> must be larger than zero and smaller than the actual
		2034	filesize.
		2035
		2036	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		2037	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		2038
		2039	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		2040	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		2041	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		2042	(which is set to C<MAP_ANON> if your system only provides this
		2043	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		2044	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		2045	C<IO::AIO::MAP_NONBLOCK>
		2046
		2047	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		2048
		2049	C<$offset> is the offset from the start of the file - it generally must be
		2050	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		2051
		2052	Example:
		2053
		2054	use Digest::MD5;
		2055	use IO::AIO;
		2056
		2057	open my $fh, "<verybigfile"
		2058	or die "$!";
		2059
		2060	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		2061	or die "verybigfile: $!";
		2062
		2063	my $fast_md5 = md5 $data;
		2064
		2065	=item IO::AIO::munmap $scalar
		2066
		2067	Removes a previous mmap and undefines the C<$scalar>.
		2068
		2069	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		2070
		2071	Calls the C<munlock> function, undoing the effects of a previous
		2072	C<aio_mlock> call (see its description for details).
		2073
		2074	=item IO::AIO::munlockall
		2075
		2076	Calls the C<munlockall> function.
		2077
		2078	On systems that do not implement C<munlockall>, this function returns
		2079	ENOSYS, otherwise the return value of C<munlockall>.
		2080
		2081	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2082
		2083	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2084	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2085	should be the file offset.
		2086
		2087	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2088	silently corrupt the data in this case.
		2089
		2090	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2091	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2092	C<IO::AIO::SPLICE_F_GIFT>.
		2093
		2094	See the C<splice(2)> manpage for details.
		2095
		2096	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2097
		2098	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		2099	description for C<IO::AIO::splice> above for details.
		2100
		2101	=back
		2102
1298	=cut	2103	=cut
1299		2104
1300	min_parallel 8;	2105	min_parallel 8;
1301		2106
1302	END { flush }	2107	END { flush }
1303		2108
1304	1;	2109	1;
1305		2110
		2111	=head1 EVENT LOOP INTEGRATION
		2112
		2113	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		2114	automatically into many event loops:
		2115
		2116	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		2117	use AnyEvent::AIO;
		2118
		2119	You can also integrate IO::AIO manually into many event loops, here are
		2120	some examples of how to do this:
		2121
		2122	# EV integration
		2123	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		2124
		2125	# Event integration
		2126	Event->io (fd => IO::AIO::poll_fileno,
		2127	poll => 'r',
		2128	cb => \&IO::AIO::poll_cb);
		2129
		2130	# Glib/Gtk2 integration
		2131	add_watch Glib::IO IO::AIO::poll_fileno,
		2132	in => sub { IO::AIO::poll_cb; 1 };
		2133
		2134	# Tk integration
		2135	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		2136	readable => \&IO::AIO::poll_cb);
		2137
		2138	# Danga::Socket integration
		2139	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		2140	\&IO::AIO::poll_cb);
		2141
1306	=head2 FORK BEHAVIOUR	2142	=head2 FORK BEHAVIOUR
1307		2143
1308	This module should do "the right thing" when the process using it forks:	2144	Usage of pthreads in a program changes the semantics of fork
		2145	considerably. Specifically, only async-safe functions can be called after
		2146	fork. Perl doesn't know about this, so in general, you cannot call fork
		2147	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2148	pthreads, so this applies, but many other extensions and (for inexplicable
		2149	reasons) perl itself often is linked against pthreads, so this limitation
		2150	applies to quite a lot of perls.
1309		2151
1310	Before the fork, IO::AIO enters a quiescent state where no requests	2152	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1311	can be added in other threads and no results will be processed. After	2153	only works in the process that loaded it. Forking is fully supported, but
1312	the fork the parent simply leaves the quiescent state and continues	2154	using IO::AIO in the child is not.
1313	request/result processing, while the child frees the request/result queue
1314	(so that the requests started before the fork will only be handled in the
1315	parent). Threads will be started on demand until the limit set in the
1316	parent process has been reached again.
1317		2155
1318	In short: the parent will, after a short pause, continue as if fork had	2156	You might get around by not I<using> IO::AIO before (or after)
1319	not been called, while the child will act as if IO::AIO has not been used	2157	forking. You could also try to call the L<IO::AIO::reinit> function in the
1320	yet.	2158	child:
		2159
		2160	=over 4
		2161
		2162	=item IO::AIO::reinit
		2163
		2164	Abandons all current requests and I/O threads and simply reinitialises all
		2165	data structures. This is not an operation supported by any standards, but
		2166	happens to work on GNU/Linux and some newer BSD systems.
		2167
		2168	The only reasonable use for this function is to call it after forking, if
		2169	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2170	the process will result in undefined behaviour. Calling it at any time
		2171	will also result in any undefined (by POSIX) behaviour.
		2172
		2173	=back
1321		2174
1322	=head2 MEMORY USAGE	2175	=head2 MEMORY USAGE
1323		2176
1324	Per-request usage:	2177	Per-request usage:
1325		2178
…		…
1342		2195
1343	Known bugs will be fixed in the next release.	2196	Known bugs will be fixed in the next release.
1344		2197
1345	=head1 SEE ALSO	2198	=head1 SEE ALSO
1346		2199
1347	L<Coro::AIO>.	2200	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		2201	more natural syntax.
1348		2202
1349	=head1 AUTHOR	2203	=head1 AUTHOR
1350		2204
1351	Marc Lehmann <schmorp@schmorp.de>	2205	Marc Lehmann <schmorp@schmorp.de>
1352	http://home.schmorp.de/	2206	http://home.schmorp.de/

Diff Legend

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