ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.145 by root, Sun Apr 19 19:20:10 2009 UTC vs.
Revision 1.241 by root, Fri Dec 28 07:33:41 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, POE, urxvt, pureperl...)
32	use AnyEvent::AIO;
33
34	# EV integration
35	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37	# Event integration
38	Event->io (fd => IO::AIO::poll_fileno,
39	poll => 'r',
40	cb => \&IO::AIO::poll_cb);
41
42	# Glib/Gtk2 integration
43	add_watch Glib::IO IO::AIO::poll_fileno,
44	in => sub { IO::AIO::poll_cb; 1 };
45
46	# Tk integration
47	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48	readable => \&IO::AIO::poll_cb);
49
50	# Danga::Socket integration
51	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52	\&IO::AIO::poll_cb);
53
54	=head1 DESCRIPTION	31	=head1 DESCRIPTION
55		32
56	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
57	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>).
58		36
59	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
60	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
61	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
62	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
66	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
67	concurrently.	45	concurrently.
68		46
69	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
70	example sockets), using these functions on file descriptors that	48	example sockets), using these functions on file descriptors that
71	support nonblocking operation (again, sockets, pipes etc.) is very	49	support nonblocking operation (again, sockets, pipes etc.) is
72	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>
73	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.
74		52
75	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
76	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
77	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
…		…
87	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
88	call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
89		67
90	=head2 EXAMPLE	68	=head2 EXAMPLE
91		69
92	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
93	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
94		72
95	use Fcntl;	73	use Fcntl;
96	use Event;	74	use EV;
97	use IO::AIO;	75	use IO::AIO;
98		76
99	# register the IO::AIO callback with Event	77	# register the IO::AIO callback with EV
100	Event->io (fd => IO::AIO::poll_fileno,	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
101	poll => 'r',
102	cb => \&IO::AIO::poll_cb);
103		79
104	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
105	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
106	my $fh = shift	82	my $fh = shift
107	or die "error while opening: $!";	83	or die "error while opening: $!";
108		84
109	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
110	my $size = -s $fh;	86	my $size = -s $fh;
…		…
119		95
120	# file contents now in $contents	96	# file contents now in $contents
121	print $contents;	97	print $contents;
122		98
123	# exit event loop and program	99	# exit event loop and program
124	Event::unloop;	100	EV::unloop;
125	};	101	};
126	};	102	};
127		103
128	# possibly queue up other requests, or open GUI windows,	104	# possibly queue up other requests, or open GUI windows,
129	# check for sockets etc. etc.	105	# check for sockets etc. etc.
130		106
131	# process events as long as there are some:	107	# process events as long as there are some:
132	Event::loop;	108	EV::loop;
133		109
134	=head1 REQUEST ANATOMY AND LIFETIME	110	=head1 REQUEST ANATOMY AND LIFETIME
135		111
136	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
137	directly visible to Perl.	113	directly visible to Perl.
…		…
187		163
188	package IO::AIO;	164	package IO::AIO;
189		165
190	use Carp ();	166	use Carp ();
191		167
192	no warnings;	168	use common::sense;
193	use strict 'vars';
194		169
195	use base 'Exporter';	170	use base 'Exporter';
196		171
197	BEGIN {	172	BEGIN {
198	our $VERSION = '3.18';	173	our $VERSION = '4.18';
199		174
200	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
201	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
202	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
203	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
		179	aio_pathsync aio_readahead aio_fiemap
204	aio_rename aio_link aio_move aio_copy aio_group	180	aio_rename aio_link aio_move aio_copy aio_group
205	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
206	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);
207		186
208	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	187	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
209	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	188	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
210	min_parallel max_parallel max_idle	189	min_parallel max_parallel max_idle idle_timeout
211	nreqs nready npending nthreads	190	nreqs nready npending nthreads
212	max_poll_time max_poll_reqs);	191	max_poll_time max_poll_reqs
		192	sendfile fadvise madvise
		193	mmap munmap munlock munlockall);
213		194
214	push @AIO_REQ, qw(aio_busy); # not exported	195	push @AIO_REQ, qw(aio_busy); # not exported
215		196
216	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
217		198
…		…
219	XSLoader::load ("IO::AIO", $VERSION);	200	XSLoader::load ("IO::AIO", $VERSION);
220	}	201	}
221		202
222	=head1 FUNCTIONS	203	=head1 FUNCTIONS
223		204
224	=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
225		287
226	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
227	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,
228	and they all accept an additional (and optional) C<$callback> argument	290	and they all accept an additional (and optional) C<$callback> argument
229	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
230	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
231	perl, which usually delivers "false") as its sole argument after the given	293	of the request will be passed as arguments to the callback (and, if an
232	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>.
233		300
234	All functions expecting a filehandle keep a copy of the filehandle	301	All functions expecting a filehandle keep a copy of the filehandle
235	internally until the request has finished.	302	internally until the request has finished.
236		303
237	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
238	further manipulation of those requests while they are in-flight.	305	further manipulation of those requests while they are in-flight.
239		306
240	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
241	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
242	request is being executed, the current working directory could have	309	current working directory could have changed. Alternatively, you can
243	changed. Alternatively, you can make sure that you never change the	310	make sure that you never change the current working directory anywhere
244	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
245	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.
246		315
247	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
248	in filenames you got from outside (command line, readdir etc.) without	317	in filenames you got from outside (command line, readdir etc.) without
249	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
250	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
251	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
252	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.
253		323
254	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
255	handles correctly whether it is set or not.	325	handles correctly whether it is set or not.
		326
		327	=head2 AIO REQUEST FUNCTIONS
256		328
257	=over 4	329	=over 4
258		330
259	=item $prev_pri = aioreq_pri [$pri]	331	=item $prev_pri = aioreq_pri [$pri]
260		332
…		…
290		362
291		363
292	=item aio_open $pathname, $flags, $mode, $callback->($fh)	364	=item aio_open $pathname, $flags, $mode, $callback->($fh)
293		365
294	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
295	created filehandle for the file.	367	created filehandle for the file (or C<undef> in case of an error).
296		368
297	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,
298	for an explanation.	370	for an explanation.
299		371
300	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
…		…
307	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
308	change the umask.	380	change the umask.
309		381
310	Example:	382	Example:
311		383
312	aio_open "/etc/passwd", O_RDONLY, 0, sub {	384	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
313	if ($_[0]) {	385	if ($_[0]) {
314	print "open successful, fh is $_[0]\n";	386	print "open successful, fh is $_[0]\n";
315	...	387	...
316	} else {	388	} else {
317	die "open failed: $!\n";	389	die "open failed: $!\n";
318	}	390	}
319	};	391	};
320		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
321		402
322	=item aio_close $fh, $callback->($status)	403	=item aio_close $fh, $callback->($status)
323		404
324	Asynchronously close a file and call the callback with the result	405	Asynchronously close a file and call the callback with the result
325	code.	406	code.
…		…
333		414
334	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
335	free for reuse until the perl filehandle is closed.	416	free for reuse until the perl filehandle is closed.
336		417
337	=cut	418	=cut
		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".
338		439
339	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
340		441
341	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
342		443
343	Reads or writes C<$length> bytes from or to the specified C<$fh> and	444	Reads or writes C<$length> bytes from or to the specified C<$fh> and
344	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	445	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
345	and calls the callback without the actual number of bytes read (or -1 on	446	and calls the callback without the actual number of bytes read (or -1 on
346	error, just like the syscall).	447	error, just like the syscall).
347		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.
		451
348	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
349	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
350	changed by these calls.	454	changed by these calls.
351		455
352	If C<$length> is undefined in C<aio_write>, use the remaining length of	456	If C<$length> is undefined in C<aio_write>, use the remaining length of
…		…
372		476
373	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
374	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
375	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
376	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
377	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>.
378		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
379	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
380	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
381	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.
382		503
383	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>,
384	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
385	regardless of the limitations of the operating system.	507	type of filehandle regardless of the limitations of the operating system.
386		508
387	Please note, however, that C<aio_sendfile> can read more bytes from	509	As native sendfile syscalls (as practically any non-POSIX interface hacked
388	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
389	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
390	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,
391	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> -
392	read.	514	fewre bytes than expected might have been transferred.
393		515
394		516
395	=item aio_readahead $fh,$offset,$length, $callback->($retval)	517	=item aio_readahead $fh,$offset,$length, $callback->($retval)
396		518
397	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
…		…
420		542
421	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
422	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
423	unless perl itself is compiled with large file support.	545	unless perl itself is compiled with large file support.
424		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
425	Example: Print the length of F</etc/passwd>:	556	Example: Print the length of F</etc/passwd>:
426		557
427	aio_stat "/etc/passwd", sub {	558	aio_stat "/etc/passwd", sub {
428	$_[0] and die "stat failed: $!";	559	$_[0] and die "stat failed: $!";
429	print "size is ", -s _, "\n";	560	print "size is ", -s _, "\n";
430	};	561	};
431		562
432		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
433	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	690	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
434		691
435	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
436	and $mtime being undef). Fractional times are supported if the underlying	693	and $mtime being undef). Fractional times are supported if the underlying
437	syscalls support them.	694	syscalls support them.
…		…
464	=item aio_truncate $fh_or_path, $offset, $callback->($status)	721	=item aio_truncate $fh_or_path, $offset, $callback->($status)
465		722
466	Works like truncate(2) or ftruncate(2).	723	Works like truncate(2) or ftruncate(2).
467		724
468		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
469	=item aio_chmod $fh_or_path, $mode, $callback->($status)	742	=item aio_chmod $fh_or_path, $mode, $callback->($status)
470		743
471	Works like perl's C<chmod> function.	744	Works like perl's C<chmod> function.
472		745
473		746
…		…
475		748
476	Asynchronously unlink (delete) a file and call the callback with the	749	Asynchronously unlink (delete) a file and call the callback with the
477	result code.	750	result code.
478		751
479		752
480	=item aio_mknod $path, $mode, $dev, $callback->($status)	753	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
481		754
482	[EXPERIMENTAL]	755	[EXPERIMENTAL]
483		756
484	Asynchronously create a device node (or fifo). See mknod(2).	757	Asynchronously create a device node (or fifo). See mknod(2).
485		758
486	The only (POSIX-) portable way of calling this function is:	759	The only (POSIX-) portable way of calling this function is:
487		760
488	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	761	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
489		762
		763	See C<aio_stat> for info about some potentially helpful extra constants
		764	and functions.
490		765
491	=item aio_link $srcpath, $dstpath, $callback->($status)	766	=item aio_link $srcpath, $dstpath, $callback->($status)
492		767
493	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
494	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.
…		…
498		773
499	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
500	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.
501		776
502		777
503	=item aio_readlink $path, $callback->($link)	778	=item aio_readlink $pathname, $callback->($link)
504		779
505	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
506	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
507	callback.	782	callback.
508		783
509		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
510	=item aio_rename $srcpath, $dstpath, $callback->($status)	795	=item aio_rename $srcpath, $dstpath, $callback->($status)
511		796
512	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
513	rename(2) and call the callback with the result code.	798	rename(2) and call the callback with the result code.
		799
		800	On systems that support the AIO::WD working directory abstraction
		801	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		802	of failing, C<rename> is called on the absolute path of C<$wd>.
514		803
515		804
516	=item aio_mkdir $pathname, $mode, $callback->($status)	805	=item aio_mkdir $pathname, $mode, $callback->($status)
517		806
518	Asynchronously mkdir (create) a directory and call the callback with	807	Asynchronously mkdir (create) a directory and call the callback with
…		…
523	=item aio_rmdir $pathname, $callback->($status)	812	=item aio_rmdir $pathname, $callback->($status)
524		813
525	Asynchronously rmdir (delete) a directory and call the callback with the	814	Asynchronously rmdir (delete) a directory and call the callback with the
526	result code.	815	result code.
527		816
		817	On systems that support the AIO::WD working directory abstraction
		818	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		819	C<rmdir> is called on the absolute path of C<$wd>.
		820
528		821
529	=item aio_readdir $pathname, $callback->($entries)	822	=item aio_readdir $pathname, $callback->($entries)
530		823
531	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	824	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
532	directory (i.e. opendir + readdir + closedir). The entries will not be	825	directory (i.e. opendir + readdir + closedir). The entries will not be
533	sorted, and will B<NOT> include the C<.> and C<..> entries.	826	sorted, and will B<NOT> include the C<.> and C<..> entries.
534		827
535	The callback a single argument which is either C<undef> or an array-ref	828	The callback is passed a single argument which is either C<undef> or an
536	with the filenames.	829	array-ref with the filenames.
537		830
538		831
		832	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		833
		834	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
		835	tune behaviour and output format. In case of an error, C<$entries> will be
		836	C<undef>.
		837
		838	The flags are a combination of the following constants, ORed together (the
		839	flags will also be passed to the callback, possibly modified):
		840
		841	=over 4
		842
		843	=item IO::AIO::READDIR_DENTS
		844
		845	When this flag is off, then the callback gets an arrayref consisting of
		846	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		847	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		848	entry in more detail.
		849
		850	C<$name> is the name of the entry.
		851
		852	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		853
		854	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		855	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		856	C<IO::AIO::DT_WHT>.
		857
		858	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		859	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		860	scalars are read-only: you can not modify them.
		861
		862	C<$inode> is the inode number (which might not be exact on systems with 64
		863	bit inode numbers and 32 bit perls). This field has unspecified content on
		864	systems that do not deliver the inode information.
		865
		866	=item IO::AIO::READDIR_DIRS_FIRST
		867
		868	When this flag is set, then the names will be returned in an order where
		869	likely directories come first, in optimal stat order. This is useful when
		870	you need to quickly find directories, or you want to find all directories
		871	while avoiding to stat() each entry.
		872
		873	If the system returns type information in readdir, then this is used
		874	to find directories directly. Otherwise, likely directories are names
		875	beginning with ".", or otherwise names with no dots, of which names with
		876	short names are tried first.
		877
		878	=item IO::AIO::READDIR_STAT_ORDER
		879
		880	When this flag is set, then the names will be returned in an order
		881	suitable for stat()'ing each one. That is, when you plan to stat()
		882	all files in the given directory, then the returned order will likely
		883	be fastest.
		884
		885	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		886	the likely dirs come first, resulting in a less optimal stat order.
		887
		888	=item IO::AIO::READDIR_FOUND_UNKNOWN
		889
		890	This flag should not be set when calling C<aio_readdirx>. Instead, it
		891	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		892	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
		893	C<$type>'s are known, which can be used to speed up some algorithms.
		894
		895	=back
		896
		897
539	=item aio_load $path, $data, $callback->($status)	898	=item aio_load $pathname, $data, $callback->($status)
540		899
541	This is a composite request that tries to fully load the given file into	900	This is a composite request that tries to fully load the given file into
542	memory. Status is the same as with aio_read.	901	memory. Status is the same as with aio_read.
543		902
544	=cut	903	=cut
…		…
566		925
567	=item aio_copy $srcpath, $dstpath, $callback->($status)	926	=item aio_copy $srcpath, $dstpath, $callback->($status)
568		927
569	Try to copy the I<file> (directories not supported as either source or	928	Try to copy the I<file> (directories not supported as either source or
570	destination) from C<$srcpath> to C<$dstpath> and call the callback with	929	destination) from C<$srcpath> to C<$dstpath> and call the callback with
571	the C<0> (error) or C<-1> ok.	930	a status of C<0> (ok) or C<-1> (error, see C<$!>).
572		931
573	This is a composite request that creates the destination file with	932	This is a composite request that creates the destination file with
574	mode 0200 and copies the contents of the source file into it using	933	mode 0200 and copies the contents of the source file into it using
575	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	934	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
576	uid/gid, in that order.	935	uid/gid, in that order.
…		…
588	my $grp = aio_group $cb;	947	my $grp = aio_group $cb;
589		948
590	aioreq_pri $pri;	949	aioreq_pri $pri;
591	add $grp aio_open $src, O_RDONLY, 0, sub {	950	add $grp aio_open $src, O_RDONLY, 0, sub {
592	if (my $src_fh = $_[0]) {	951	if (my $src_fh = $_[0]) {
593	my @stat = stat $src_fh;	952	my @stat = stat $src_fh; # hmm, might block over nfs?
594		953
595	aioreq_pri $pri;	954	aioreq_pri $pri;
596	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {	955	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
597	if (my $dst_fh = $_[0]) {	956	if (my $dst_fh = $_[0]) {
598	aioreq_pri $pri;	957	aioreq_pri $pri;
599	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	958	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
600	if ($_[0] == $stat[7]) {	959	if ($_[0] == $stat[7]) {
601	$grp->result (0);	960	$grp->result (0);
602	close $src_fh;	961	close $src_fh;
603		962
604	# those should not normally block. should. should.	963	my $ch = sub {
605	utime $stat[8], $stat[9], $dst;	964	aioreq_pri $pri;
606	chmod $stat[2] & 07777, $dst_fh;	965	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
607	chown $stat[4], $stat[5], $dst_fh;	966	aioreq_pri $pri;
		967	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		968	aioreq_pri $pri;
		969	add $grp aio_close $dst_fh;
		970	}
		971	};
		972	};
608		973
609	aioreq_pri $pri;	974	aioreq_pri $pri;
610	add $grp aio_close $dst_fh;	975	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		976	if ($_[0] < 0 && $! == ENOSYS) {
		977	aioreq_pri $pri;
		978	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		979	} else {
		980	$ch->();
		981	}
		982	};
611	} else {	983	} else {
612	$grp->result (-1);	984	$grp->result (-1);
613	close $src_fh;	985	close $src_fh;
614	close $dst_fh;	986	close $dst_fh;
615		987
…		…
632		1004
633	=item aio_move $srcpath, $dstpath, $callback->($status)	1005	=item aio_move $srcpath, $dstpath, $callback->($status)
634		1006
635	Try to move the I<file> (directories not supported as either source or	1007	Try to move the I<file> (directories not supported as either source or
636	destination) from C<$srcpath> to C<$dstpath> and call the callback with	1008	destination) from C<$srcpath> to C<$dstpath> and call the callback with
637	the C<0> (error) or C<-1> ok.	1009	a status of C<0> (ok) or C<-1> (error, see C<$!>).
638		1010
639	This is a composite request that tries to rename(2) the file first; if	1011	This is a composite request that tries to rename(2) the file first; if
640	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if	1012	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
641	that is successful, unlinks the C<$srcpath>.	1013	that is successful, unlinks the C<$srcpath>.
642		1014
…		…
653	if ($_[0] && $! == EXDEV) {	1025	if ($_[0] && $! == EXDEV) {
654	aioreq_pri $pri;	1026	aioreq_pri $pri;
655	add $grp aio_copy $src, $dst, sub {	1027	add $grp aio_copy $src, $dst, sub {
656	$grp->result ($_[0]);	1028	$grp->result ($_[0]);
657		1029
658	if (!$_[0]) {	1030	unless ($_[0]) {
659	aioreq_pri $pri;	1031	aioreq_pri $pri;
660	add $grp aio_unlink $src;	1032	add $grp aio_unlink $src;
661	}	1033	}
662	};	1034	};
663	} else {	1035	} else {
…		…
666	};	1038	};
667		1039
668	$grp	1040	$grp
669	}	1041	}
670		1042
671	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1043	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
672		1044
673	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1045	Scans a directory (similar to C<aio_readdir>) but additionally tries to
674	efficiently separate the entries of directory C<$path> into two sets of	1046	efficiently separate the entries of directory C<$path> into two sets of
675	names, directories you can recurse into (directories), and ones you cannot	1047	names, directories you can recurse into (directories), and ones you cannot
676	recurse into (everything else, including symlinks to directories).	1048	recurse into (everything else, including symlinks to directories).
…		…
693		1065
694	Implementation notes.	1066	Implementation notes.
695		1067
696	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	1068	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
697		1069
		1070	If readdir returns file type information, then this is used directly to
		1071	find directories.
		1072
698	After reading the directory, the modification time, size etc. of the	1073	Otherwise, after reading the directory, the modification time, size etc.
699	directory before and after the readdir is checked, and if they match (and	1074	of the directory before and after the readdir is checked, and if they
700	isn't the current time), the link count will be used to decide how many	1075	match (and isn't the current time), the link count will be used to decide
701	entries are directories (if >= 2). Otherwise, no knowledge of the number	1076	how many entries are directories (if >= 2). Otherwise, no knowledge of the
702	of subdirectories will be assumed.	1077	number of subdirectories will be assumed.
703		1078
704	Then entries will be sorted into likely directories (everything without	1079	Then entries will be sorted into likely directories a non-initial dot
705	a non-initial dot currently) and likely non-directories (everything	1080	currently) and likely non-directories (see C<aio_readdirx>). Then every
706	else). Then every entry plus an appended C</.> will be C<stat>'ed,	1081	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
707	likely directories first. If that succeeds, it assumes that the entry	1082	in order of their inode numbers. If that succeeds, it assumes that the
708	is a directory or a symlink to directory (which will be checked	1083	entry is a directory or a symlink to directory (which will be checked
709	seperately). This is often faster than stat'ing the entry itself because	1084	separately). This is often faster than stat'ing the entry itself because
710	filesystems might detect the type of the entry without reading the inode	1085	filesystems might detect the type of the entry without reading the inode
711	data (e.g. ext2fs filetype feature).	1086	data (e.g. ext2fs filetype feature), even on systems that cannot return
		1087	the filetype information on readdir.
712		1088
713	If the known number of directories (link count - 2) has been reached, the	1089	If the known number of directories (link count - 2) has been reached, the
714	rest of the entries is assumed to be non-directories.	1090	rest of the entries is assumed to be non-directories.
715		1091
716	This only works with certainty on POSIX (= UNIX) filesystems, which	1092	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
729		1105
730	my $grp = aio_group $cb;	1106	my $grp = aio_group $cb;
731		1107
732	$maxreq = 4 if $maxreq <= 0;	1108	$maxreq = 4 if $maxreq <= 0;
733		1109
734	# stat once	1110	# get a wd object
735	aioreq_pri $pri;	1111	aioreq_pri $pri;
736	add $grp aio_stat $path, sub {	1112	add $grp aio_wd $path, sub {
		1113	$_[0]
737	return $grp->result () if $_[0];	1114	or return $grp->result ();
738	my $now = time;
739	my $hash1 = join ":", (stat _)[0,1,3,7,9];
740		1115
741	# read the directory entries	1116	my $wd = [shift, "."];
		1117
		1118	# stat once
742	aioreq_pri $pri;	1119	aioreq_pri $pri;
743	add $grp aio_readdir $path, sub {	1120	add $grp aio_stat $wd, sub {
744	my $entries = shift
745	or return $grp->result ();	1121	return $grp->result () if $_[0];
		1122	my $now = time;
		1123	my $hash1 = join ":", (stat _)[0,1,3,7,9];
746		1124
747	# stat the dir another time	1125	# read the directory entries
748	aioreq_pri $pri;	1126	aioreq_pri $pri;
		1127	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1128	my $entries = shift
		1129	or return $grp->result ();
		1130
		1131	# stat the dir another time
		1132	aioreq_pri $pri;
749	add $grp aio_stat $path, sub {	1133	add $grp aio_stat $wd, sub {
750	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1134	my $hash2 = join ":", (stat _)[0,1,3,7,9];
751		1135
752	my $ndirs;	1136	my $ndirs;
753		1137
754	# take the slow route if anything looks fishy	1138	# take the slow route if anything looks fishy
755	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1139	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
756	$ndirs = -1;	1140	$ndirs = -1;
757	} else {	1141	} else {
758	# if nlink == 2, we are finished	1142	# if nlink == 2, we are finished
759	# on non-posix-fs's, we rely on nlink < 2	1143	# for non-posix-fs's, we rely on nlink < 2
760	$ndirs = (stat _)[3] - 2	1144	$ndirs = (stat _)[3] - 2
761	or return $grp->result ([], $entries);	1145	or return $grp->result ([], $entries);
762	}	1146	}
763		1147
764	# sort into likely dirs and likely nondirs
765	# dirs == files without ".", short entries first
766	$entries = [map $_->[0],
767	sort { $b->[1] cmp $a->[1] }
768	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
769	@$entries];
770
771	my (@dirs, @nondirs);	1148	my (@dirs, @nondirs);
772		1149
773	my $statgrp = add $grp aio_group sub {	1150	my $statgrp = add $grp aio_group sub {
774	$grp->result (\@dirs, \@nondirs);	1151	$grp->result (\@dirs, \@nondirs);
775	};	1152	};
776		1153
777	limit $statgrp $maxreq;	1154	limit $statgrp $maxreq;
778	feed $statgrp sub {	1155	feed $statgrp sub {
779	return unless @$entries;	1156	return unless @$entries;
780	my $entry = pop @$entries;	1157	my $entry = shift @$entries;
781		1158
782	aioreq_pri $pri;	1159	aioreq_pri $pri;
		1160	$wd->[1] = "$entry/.";
783	add $statgrp aio_stat "$path/$entry/.", sub {	1161	add $statgrp aio_stat $wd, sub {
784	if ($_[0] < 0) {	1162	if ($_[0] < 0) {
785	push @nondirs, $entry;	1163	push @nondirs, $entry;
786	} else {	1164	} else {
787	# need to check for real directory	1165	# need to check for real directory
788	aioreq_pri $pri;	1166	aioreq_pri $pri;
		1167	$wd->[1] = $entry;
789	add $statgrp aio_lstat "$path/$entry", sub {	1168	add $statgrp aio_lstat $wd, sub {
790	if (-d _) {	1169	if (-d _) {
791	push @dirs, $entry;	1170	push @dirs, $entry;
792		1171
793	unless (--$ndirs) {	1172	unless (--$ndirs) {
794	push @nondirs, @$entries;	1173	push @nondirs, @$entries;
795	feed $statgrp;	1174	feed $statgrp;
		1175	}
		1176	} else {
		1177	push @nondirs, $entry;
796	}	1178	}
797	} else {
798	push @nondirs, $entry;
799	}	1179	}
800	}	1180	}
801	}	1181	};
802	};	1182	};
803	};	1183	};
804	};	1184	};
805	};	1185	};
806	};	1186	};
807		1187
808	$grp	1188	$grp
809	}	1189	}
810		1190
811	=item aio_rmtree $path, $callback->($status)	1191	=item aio_rmtree $pathname, $callback->($status)
812		1192
813	Delete a directory tree starting (and including) C<$path>, return the	1193	Delete a directory tree starting (and including) C<$path>, return the
814	status of the final C<rmdir> only. This is a composite request that	1194	status of the final C<rmdir> only. This is a composite request that
815	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1195	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
816	everything else.	1196	everything else.
817		1197
818	=cut	1198	=cut
819		1199
…		…
858	callback with the fdatasync result code.	1238	callback with the fdatasync result code.
859		1239
860	If this call isn't available because your OS lacks it or it couldn't be	1240	If this call isn't available because your OS lacks it or it couldn't be
861	detected, it will be emulated by calling C<fsync> instead.	1241	detected, it will be emulated by calling C<fsync> instead.
862		1242
		1243	=item aio_syncfs $fh, $callback->($status)
		1244
		1245	Asynchronously call the syncfs syscall to sync the filesystem associated
		1246	to the given filehandle and call the callback with the syncfs result
		1247	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1248	errno to C<ENOSYS> nevertheless.
		1249
863	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	1250	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
864		1251
865	Sync the data portion of the file specified by C<$offset> and C<$length>	1252	Sync the data portion of the file specified by C<$offset> and C<$length>
866	to disk (but NOT the metadata), by calling the Linux-specific	1253	to disk (but NOT the metadata), by calling the Linux-specific
867	sync_file_range call. If sync_file_range is not available or it returns	1254	sync_file_range call. If sync_file_range is not available or it returns
…		…
870	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,	1257	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
871	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and	1258	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
872	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range	1259	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
873	manpage for details.	1260	manpage for details.
874		1261
875	=item aio_pathsync $path, $callback->($status)	1262	=item aio_pathsync $pathname, $callback->($status)
876		1263
877	This request tries to open, fsync and close the given path. This is a	1264	This request tries to open, fsync and close the given path. This is a
878	composite request intended to sync directories after directory operations	1265	composite request intended to sync directories after directory operations
879	(E.g. rename). This might not work on all operating systems or have any	1266	(E.g. rename). This might not work on all operating systems or have any
880	specific effect, but usually it makes sure that directory changes get	1267	specific effect, but usually it makes sure that directory changes get
881	written to disc. It works for anything that can be opened for read-only,	1268	written to disc. It works for anything that can be opened for read-only,
882	not just directories.	1269	not just directories.
		1270
		1271	Future versions of this function might fall back to other methods when
		1272	C<fsync> on the directory fails (such as calling C<sync>).
883		1273
884	Passes C<0> when everything went ok, and C<-1> on error.	1274	Passes C<0> when everything went ok, and C<-1> on error.
885		1275
886	=cut	1276	=cut
887		1277
…		…
908	};	1298	};
909		1299
910	$grp	1300	$grp
911	}	1301	}
912		1302
		1303	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1304
		1305	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1306	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1307	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1308	scalar must only be modified in-place while an aio operation is pending on
		1309	it).
		1310
		1311	It calls the C<msync> function of your OS, if available, with the memory
		1312	area starting at C<$offset> in the string and ending C<$length> bytes
		1313	later. If C<$length> is negative, counts from the end, and if C<$length>
		1314	is C<undef>, then it goes till the end of the string. The flags can be
		1315	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1316	C<IO::AIO::MS_SYNC>.
		1317
		1318	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1319
		1320	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1321	scalars.
		1322
		1323	It touches (reads or writes) all memory pages in the specified
		1324	range inside the scalar. All caveats and parameters are the same
		1325	as for C<aio_msync>, above, except for flags, which must be either
		1326	C<0> (which reads all pages and ensures they are instantiated) or
		1327	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
		1328	writing an octet from it, which dirties the page).
		1329
		1330	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1331
		1332	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1333	scalars.
		1334
		1335	It reads in all the pages of the underlying storage into memory (if any)
		1336	and locks them, so they are not getting swapped/paged out or removed.
		1337
		1338	If C<$length> is undefined, then the scalar will be locked till the end.
		1339
		1340	On systems that do not implement C<mlock>, this function returns C<-1>
		1341	and sets errno to C<ENOSYS>.
		1342
		1343	Note that the corresponding C<munlock> is synchronous and is
		1344	documented under L<MISCELLANEOUS FUNCTIONS>.
		1345
		1346	Example: open a file, mmap and mlock it - both will be undone when
		1347	C<$data> gets destroyed.
		1348
		1349	open my $fh, "<", $path or die "$path: $!";
		1350	my $data;
		1351	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1352	aio_mlock $data; # mlock in background
		1353
		1354	=item aio_mlockall $flags, $callback->($status)
		1355
		1356	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1357	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1358
		1359	On systems that do not implement C<mlockall>, this function returns C<-1>
		1360	and sets errno to C<ENOSYS>.
		1361
		1362	Note that the corresponding C<munlockall> is synchronous and is
		1363	documented under L<MISCELLANEOUS FUNCTIONS>.
		1364
		1365	Example: asynchronously lock all current and future pages into memory.
		1366
		1367	aio_mlockall IO::AIO::MCL_FUTURE;
		1368
		1369	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1370
		1371	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1372	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1373	the ioctl is not available on your OS, then this request will fail with
		1374	C<ENOSYS>.
		1375
		1376	C<$start> is the starting offset to query extents for, C<$length> is the
		1377	size of the range to query - if it is C<undef>, then the whole file will
		1378	be queried.
		1379
		1380	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1381	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1382	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1383	the data portion.
		1384
		1385	C<$count> is the maximum number of extent records to return. If it is
		1386	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1387	case, if it is C<0>, then the callback receives the number of extents
		1388	instead of the extents themselves (which is unreliable, see below).
		1389
		1390	If an error occurs, the callback receives no arguments. The special
		1391	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1392
		1393	Otherwise, the callback receives an array reference with extent
		1394	structures. Each extent structure is an array reference itself, with the
		1395	following members:
		1396
		1397	[$logical, $physical, $length, $flags]
		1398
		1399	Flags is any combination of the following flag values (typically either C<0>
		1400	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1401
		1402	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1403	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1404	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1405	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1406	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1407	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1408
		1409	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1410	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1411	it to return all extents of a range for files with large number of
		1412	extents. The code works around all these issues if C<$count> is undef.
		1413
913	=item aio_group $callback->(...)	1414	=item aio_group $callback->(...)
914		1415
915	This is a very special aio request: Instead of doing something, it is a	1416	This is a very special aio request: Instead of doing something, it is a
916	container for other aio requests, which is useful if you want to bundle	1417	container for other aio requests, which is useful if you want to bundle
917	many requests into a single, composite, request with a definite callback	1418	many requests into a single, composite, request with a definite callback
…		…
954	immense (it blocks a thread for a long time) so do not use this function	1455	immense (it blocks a thread for a long time) so do not use this function
955	except to put your application under artificial I/O pressure.	1456	except to put your application under artificial I/O pressure.
956		1457
957	=back	1458	=back
958		1459
		1460
		1461	=head2 IO::AIO::WD - multiple working directories
		1462
		1463	Your process only has one current working directory, which is used by all
		1464	threads. This makes it hard to use relative paths (some other component
		1465	could call C<chdir> at any time, and it is hard to control when the path
		1466	will be used by IO::AIO).
		1467
		1468	One solution for this is to always use absolute paths. This usually works,
		1469	but can be quite slow (the kernel has to walk the whole path on every
		1470	access), and can also be a hassle to implement.
		1471
		1472	Newer POSIX systems have a number of functions (openat, fdopendir,
		1473	futimensat and so on) that make it possible to specify working directories
		1474	per operation.
		1475
		1476	For portability, and because the clowns who "designed", or shall I write,
		1477	perpetrated this new interface were obviously half-drunk, this abstraction
		1478	cannot be perfect, though.
		1479
		1480	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1481	object. This object stores the canonicalised, absolute version of the
		1482	path, and on systems that allow it, also a directory file descriptor.
		1483
		1484	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1485	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1486	object and a pathname instead (or the IO::AIO::WD object alone, which
		1487	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1488	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1489	to that IO::AIO::WD object.
		1490
		1491	For example, to get a wd object for F</etc> and then stat F<passwd>
		1492	inside, you would write:
		1493
		1494	aio_wd "/etc", sub {
		1495	my $etcdir = shift;
		1496
		1497	# although $etcdir can be undef on error, there is generally no reason
		1498	# to check for errors here, as aio_stat will fail with ENOENT
		1499	# when $etcdir is undef.
		1500
		1501	aio_stat [$etcdir, "passwd"], sub {
		1502	# yay
		1503	};
		1504	};
		1505
		1506	That C<aio_wd> is a request and not a normal function shows that creating
		1507	an IO::AIO::WD object is itself a potentially blocking operation, which is
		1508	why it is done asynchronously.
		1509
		1510	To stat the directory obtained with C<aio_wd> above, one could write
		1511	either of the following three request calls:
		1512
		1513	aio_lstat "/etc" , sub { ... # pathname as normal string
		1514	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1515	aio_lstat $wd , sub { ... # shorthand for the previous
		1516
		1517	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1518	object and the pathname string, so you could write the following without
		1519	causing any issues due to C<$path> getting reused:
		1520
		1521	my $path = [$wd, undef];
		1522
		1523	for my $name (qw(abc def ghi)) {
		1524	$path->[1] = $name;
		1525	aio_stat $path, sub {
		1526	# ...
		1527	};
		1528	}
		1529
		1530	There are some caveats: when directories get renamed (or deleted), the
		1531	pathname string doesn't change, so will point to the new directory (or
		1532	nowhere at all), while the directory fd, if available on the system,
		1533	will still point to the original directory. Most functions accepting a
		1534	pathname will use the directory fd on newer systems, and the string on
		1535	older systems. Some functions (such as realpath) will always rely on the
		1536	string form of the pathname.
		1537
		1538	So this functionality is mainly useful to get some protection against
		1539	C<chdir>, to easily get an absolute path out of a relative path for future
		1540	reference, and to speed up doing many operations in the same directory
		1541	(e.g. when stat'ing all files in a directory).
		1542
		1543	The following functions implement this working directory abstraction:
		1544
		1545	=over 4
		1546
		1547	=item aio_wd $pathname, $callback->($wd)
		1548
		1549	Asynchonously canonicalise the given pathname and convert it to an
		1550	IO::AIO::WD object representing it. If possible and supported on the
		1551	system, also open a directory fd to speed up pathname resolution relative
		1552	to this working directory.
		1553
		1554	If something goes wrong, then C<undef> is passwd to the callback instead
		1555	of a working directory object and C<$!> is set appropriately. Since
		1556	passing C<undef> as working directory component of a pathname fails the
		1557	request with C<ENOENT>, there is often no need for error checking in the
		1558	C<aio_wd> callback, as future requests using the value will fail in the
		1559	expected way.
		1560
		1561	If this call isn't available because your OS lacks it or it couldn't be
		1562	detected, it will be emulated by calling C<fsync> instead.
		1563
		1564	=item IO::AIO::CWD
		1565
		1566	This is a compiletime constant (object) that represents the process
		1567	current working directory.
		1568
		1569	Specifying this object as working directory object for a pathname is as if
		1570	the pathname would be specified directly, without a directory object. For
		1571	example, these calls are functionally identical:
		1572
		1573	aio_stat "somefile", sub { ... };
		1574	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1575
		1576	=back
		1577
		1578	To recover the path associated with an IO::AIO::WD object, you can use
		1579	C<aio_realpath>:
		1580
		1581	aio_realpath $wd, sub {
		1582	warn "path is $_[0]\n";
		1583	};
		1584
		1585	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1586	sometimes, fall back to using an absolue path.
		1587
959	=head2 IO::AIO::REQ CLASS	1588	=head2 IO::AIO::REQ CLASS
960		1589
961	All non-aggregate C<aio_*> functions return an object of this class when	1590	All non-aggregate C<aio_*> functions return an object of this class when
962	called in non-void context.	1591	called in non-void context.
963		1592
…		…
966	=item cancel $req	1595	=item cancel $req
967		1596
968	Cancels the request, if possible. Has the effect of skipping execution	1597	Cancels the request, if possible. Has the effect of skipping execution
969	when entering the B<execute> state and skipping calling the callback when	1598	when entering the B<execute> state and skipping calling the callback when
970	entering the the B<result> state, but will leave the request otherwise	1599	entering the the B<result> state, but will leave the request otherwise
971	untouched. That means that requests that currently execute will not be	1600	untouched (with the exception of readdir). That means that requests that
972	stopped and resources held by the request will not be freed prematurely.	1601	currently execute will not be stopped and resources held by the request
		1602	will not be freed prematurely.
973		1603
974	=item cb $req $callback->(...)	1604	=item cb $req $callback->(...)
975		1605
976	Replace (or simply set) the callback registered to the request.	1606	Replace (or simply set) the callback registered to the request.
977		1607
…		…
1051	=item $grp->cancel_subs	1681	=item $grp->cancel_subs
1052		1682
1053	Cancel all subrequests and clears any feeder, but not the group request	1683	Cancel all subrequests and clears any feeder, but not the group request
1054	itself. Useful when you queued a lot of events but got a result early.	1684	itself. Useful when you queued a lot of events but got a result early.
1055		1685
		1686	The group request will finish normally (you cannot add requests to the
		1687	group).
		1688
1056	=item $grp->result (...)	1689	=item $grp->result (...)
1057		1690
1058	Set the result value(s) that will be passed to the group callback when all	1691	Set the result value(s) that will be passed to the group callback when all
1059	subrequests have finished and set the groups errno to the current value	1692	subrequests have finished and set the groups errno to the current value
1060	of errno (just like calling C<errno> without an error number). By default,	1693	of errno (just like calling C<errno> without an error number). By default,
…		…
1076		1709
1077	Sets a feeder/generator on this group: every group can have an attached	1710	Sets a feeder/generator on this group: every group can have an attached
1078	generator that generates requests if idle. The idea behind this is that,	1711	generator that generates requests if idle. The idea behind this is that,
1079	although you could just queue as many requests as you want in a group,	1712	although you could just queue as many requests as you want in a group,
1080	this might starve other requests for a potentially long time. For example,	1713	this might starve other requests for a potentially long time. For example,
1081	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1714	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1082	delaying any later requests for a long time.	1715	requests, delaying any later requests for a long time.
1083		1716
1084	To avoid this, and allow incremental generation of requests, you can	1717	To avoid this, and allow incremental generation of requests, you can
1085	instead a group and set a feeder on it that generates those requests. The	1718	instead a group and set a feeder on it that generates those requests. The
1086	feed callback will be called whenever there are few enough (see C<limit>,	1719	feed callback will be called whenever there are few enough (see C<limit>,
1087	below) requests active in the group itself and is expected to queue more	1720	below) requests active in the group itself and is expected to queue more
…		…
1128	=over 4	1761	=over 4
1129		1762
1130	=item $fileno = IO::AIO::poll_fileno	1763	=item $fileno = IO::AIO::poll_fileno
1131		1764
1132	Return the I<request result pipe file descriptor>. This filehandle must be	1765	Return the I<request result pipe file descriptor>. This filehandle must be
1133	polled for reading by some mechanism outside this module (e.g. Event or	1766	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1134	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1767	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1135	to call C<poll_cb> to check the results.	1768	you have to call C<poll_cb> to check the results.
1136		1769
1137	See C<poll_cb> for an example.	1770	See C<poll_cb> for an example.
1138		1771
1139	=item IO::AIO::poll_cb	1772	=item IO::AIO::poll_cb
1140		1773
1141	Process some outstanding events on the result pipe. You have to call this	1774	Process some requests that have reached the result phase (i.e. they have
1142	regularly. Returns C<0> if all events could be processed, or C<-1> if it	1775	been executed but the results are not yet reported). You have to call
1143	returned earlier for whatever reason. Returns immediately when no events	1776	this "regularly" to finish outstanding requests.
1144	are outstanding. The amount of events processed depends on the settings of
1145	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1146		1777
		1778	Returns C<0> if all events could be processed (or there were no
		1779	events to process), or C<-1> if it returned earlier for whatever
		1780	reason. Returns immediately when no events are outstanding. The amount
		1781	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
		1782	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
		1783
1147	If not all requests were processed for whatever reason, the filehandle	1784	If not all requests were processed for whatever reason, the poll file
1148	will still be ready when C<poll_cb> returns, so normally you don't have to	1785	descriptor will still be ready when C<poll_cb> returns, so normally you
1149	do anything special to have it called later.	1786	don't have to do anything special to have it called later.
		1787
		1788	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1789	ready, it can be beneficial to call this function from loops which submit
		1790	a lot of requests, to make sure the results get processed when they become
		1791	available and not just when the loop is finished and the event loop takes
		1792	over again. This function returns very fast when there are no outstanding
		1793	requests.
1150		1794
1151	Example: Install an Event watcher that automatically calls	1795	Example: Install an Event watcher that automatically calls
1152	IO::AIO::poll_cb with high priority:	1796	IO::AIO::poll_cb with high priority (more examples can be found in the
		1797	SYNOPSIS section, at the top of this document):
1153		1798
1154	Event->io (fd => IO::AIO::poll_fileno,	1799	Event->io (fd => IO::AIO::poll_fileno,
1155	poll => 'r', async => 1,	1800	poll => 'r', async => 1,
1156	cb => \&IO::AIO::poll_cb);	1801	cb => \&IO::AIO::poll_cb);
		1802
		1803	=item IO::AIO::poll_wait
		1804
		1805	Wait until either at least one request is in the result phase or no
		1806	requests are outstanding anymore.
		1807
		1808	This is useful if you want to synchronously wait for some requests to
		1809	become ready, without actually handling them.
		1810
		1811	See C<nreqs> for an example.
		1812
		1813	=item IO::AIO::poll
		1814
		1815	Waits until some requests have been handled.
		1816
		1817	Returns the number of requests processed, but is otherwise strictly
		1818	equivalent to:
		1819
		1820	IO::AIO::poll_wait, IO::AIO::poll_cb
		1821
		1822	=item IO::AIO::flush
		1823
		1824	Wait till all outstanding AIO requests have been handled.
		1825
		1826	Strictly equivalent to:
		1827
		1828	IO::AIO::poll_wait, IO::AIO::poll_cb
		1829	while IO::AIO::nreqs;
1157		1830
1158	=item IO::AIO::max_poll_reqs $nreqs	1831	=item IO::AIO::max_poll_reqs $nreqs
1159		1832
1160	=item IO::AIO::max_poll_time $seconds	1833	=item IO::AIO::max_poll_time $seconds
1161		1834
…		…
1186	# use a low priority so other tasks have priority	1859	# use a low priority so other tasks have priority
1187	Event->io (fd => IO::AIO::poll_fileno,	1860	Event->io (fd => IO::AIO::poll_fileno,
1188	poll => 'r', nice => 1,	1861	poll => 'r', nice => 1,
1189	cb => &IO::AIO::poll_cb);	1862	cb => &IO::AIO::poll_cb);
1190		1863
1191	=item IO::AIO::poll_wait
1192
1193	If there are any outstanding requests and none of them in the result
1194	phase, wait till the result filehandle becomes ready for reading (simply
1195	does a C<select> on the filehandle. This is useful if you want to
1196	synchronously wait for some requests to finish).
1197
1198	See C<nreqs> for an example.
1199
1200	=item IO::AIO::poll
1201
1202	Waits until some requests have been handled.
1203
1204	Returns the number of requests processed, but is otherwise strictly
1205	equivalent to:
1206
1207	IO::AIO::poll_wait, IO::AIO::poll_cb
1208
1209	=item IO::AIO::flush
1210
1211	Wait till all outstanding AIO requests have been handled.
1212
1213	Strictly equivalent to:
1214
1215	IO::AIO::poll_wait, IO::AIO::poll_cb
1216	while IO::AIO::nreqs;
1217
1218	=back	1864	=back
1219		1865
1220	=head3 CONTROLLING THE NUMBER OF THREADS	1866	=head3 CONTROLLING THE NUMBER OF THREADS
1221		1867
1222	=over	1868	=over
…		…
1255		1901
1256	Under normal circumstances you don't need to call this function.	1902	Under normal circumstances you don't need to call this function.
1257		1903
1258	=item IO::AIO::max_idle $nthreads	1904	=item IO::AIO::max_idle $nthreads
1259		1905
1260	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1906	Limit the number of threads (default: 4) that are allowed to idle
1261	threads that did not get a request to process within 10 seconds). That	1907	(i.e., threads that did not get a request to process within the idle
1262	means if a thread becomes idle while C<$nthreads> other threads are also	1908	timeout (default: 10 seconds). That means if a thread becomes idle while
1263	idle, it will free its resources and exit.	1909	C<$nthreads> other threads are also idle, it will free its resources and
		1910	exit.
1264		1911
1265	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1912	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1266	to allow for extremely high load situations, but want to free resources	1913	to allow for extremely high load situations, but want to free resources
1267	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1914	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1268		1915
1269	The default is probably ok in most situations, especially if thread	1916	The default is probably ok in most situations, especially if thread
1270	creation is fast. If thread creation is very slow on your system you might	1917	creation is fast. If thread creation is very slow on your system you might
1271	want to use larger values.	1918	want to use larger values.
1272		1919
		1920	=item IO::AIO::idle_timeout $seconds
		1921
		1922	Sets the minimum idle timeout (default 10) after which worker threads are
		1923	allowed to exit. SEe C<IO::AIO::max_idle>.
		1924
1273	=item IO::AIO::max_outstanding $maxreqs	1925	=item IO::AIO::max_outstanding $maxreqs
		1926
		1927	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1928	you do queue up more than this number of requests, the next call to
		1929	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1930	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1931	longer exceeded.
		1932
		1933	In other words, this setting does not enforce a queue limit, but can be
		1934	used to make poll functions block if the limit is exceeded.
1274		1935
1275	This is a very bad function to use in interactive programs because it	1936	This is a very bad function to use in interactive programs because it
1276	blocks, and a bad way to reduce concurrency because it is inexact: Better	1937	blocks, and a bad way to reduce concurrency because it is inexact: Better
1277	use an C<aio_group> together with a feed callback.	1938	use an C<aio_group> together with a feed callback.
1278		1939
1279	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1940	It's main use is in scripts without an event loop - when you want to stat
1280	do queue up more than this number of requests, the next call to the	1941	a lot of files, you can write somehting like this:
1281	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1282	function will block until the limit is no longer exceeded.
1283		1942
1284	The default value is very large, so there is no practical limit on the	1943	IO::AIO::max_outstanding 32;
1285	number of outstanding requests.
1286		1944
1287	You can still queue as many requests as you want. Therefore,	1945	for my $path (...) {
1288	C<max_outstanding> is mainly useful in simple scripts (with low values) or	1946	aio_stat $path , ...;
1289	as a stop gap to shield against fatal memory overflow (with large values).	1947	IO::AIO::poll_cb;
		1948	}
		1949
		1950	IO::AIO::flush;
		1951
		1952	The call to C<poll_cb> inside the loop will normally return instantly, but
		1953	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1954	some requests have been handled. This keeps the loop from pushing a large
		1955	number of C<aio_stat> requests onto the queue.
		1956
		1957	The default value for C<max_outstanding> is very large, so there is no
		1958	practical limit on the number of outstanding requests.
1290		1959
1291	=back	1960	=back
1292		1961
1293	=head3 STATISTICAL INFORMATION	1962	=head3 STATISTICAL INFORMATION
1294		1963
…		…
1314	Returns the number of requests currently in the pending state (executed,	1983	Returns the number of requests currently in the pending state (executed,
1315	but not yet processed by poll_cb).	1984	but not yet processed by poll_cb).
1316		1985
1317	=back	1986	=back
1318		1987
		1988	=head3 MISCELLANEOUS FUNCTIONS
		1989
		1990	IO::AIO implements some functions that might be useful, but are not
		1991	asynchronous.
		1992
		1993	=over 4
		1994
		1995	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1996
		1997	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1998	but is blocking (this makes most sense if you know the input data is
		1999	likely cached already and the output filehandle is set to non-blocking
		2000	operations).
		2001
		2002	Returns the number of bytes copied, or C<-1> on error.
		2003
		2004	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		2005
		2006	Simply calls the C<posix_fadvise> function (see its
		2007	manpage for details). The following advice constants are
		2008	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		2009	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		2010	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		2011
		2012	On systems that do not implement C<posix_fadvise>, this function returns
		2013	ENOSYS, otherwise the return value of C<posix_fadvise>.
		2014
		2015	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		2016
		2017	Simply calls the C<posix_madvise> function (see its
		2018	manpage for details). The following advice constants are
		2019	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		2020	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		2021
		2022	On systems that do not implement C<posix_madvise>, this function returns
		2023	ENOSYS, otherwise the return value of C<posix_madvise>.
		2024
		2025	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		2026
		2027	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		2028	$scalar (see its manpage for details). The following protect
		2029	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		2030	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		2031
		2032	On systems that do not implement C<mprotect>, this function returns
		2033	ENOSYS, otherwise the return value of C<mprotect>.
		2034
		2035	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		2036
		2037	Memory-maps a file (or anonymous memory range) and attaches it to the
		2038	given C<$scalar>, which will act like a string scalar. Returns true on
		2039	success, and false otherwise.
		2040
		2041	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		2042	change the string length, and most read-only operations such as copying it
		2043	or searching it with regexes and so on.
		2044
		2045	Anything else is unsafe and will, at best, result in memory leaks.
		2046
		2047	The memory map associated with the C<$scalar> is automatically removed
		2048	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		2049	C<IO::AIO::munmap> functions are called.
		2050
		2051	This calls the C<mmap>(2) function internally. See your system's manual
		2052	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		2053
		2054	The C<$length> must be larger than zero and smaller than the actual
		2055	filesize.
		2056
		2057	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		2058	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		2059
		2060	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		2061	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		2062	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		2063	(which is set to C<MAP_ANON> if your system only provides this
		2064	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		2065	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		2066	C<IO::AIO::MAP_NONBLOCK>
		2067
		2068	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		2069
		2070	C<$offset> is the offset from the start of the file - it generally must be
		2071	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		2072
		2073	Example:
		2074
		2075	use Digest::MD5;
		2076	use IO::AIO;
		2077
		2078	open my $fh, "<verybigfile"
		2079	or die "$!";
		2080
		2081	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		2082	or die "verybigfile: $!";
		2083
		2084	my $fast_md5 = md5 $data;
		2085
		2086	=item IO::AIO::munmap $scalar
		2087
		2088	Removes a previous mmap and undefines the C<$scalar>.
		2089
		2090	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		2091
		2092	Calls the C<munlock> function, undoing the effects of a previous
		2093	C<aio_mlock> call (see its description for details).
		2094
		2095	=item IO::AIO::munlockall
		2096
		2097	Calls the C<munlockall> function.
		2098
		2099	On systems that do not implement C<munlockall>, this function returns
		2100	ENOSYS, otherwise the return value of C<munlockall>.
		2101
		2102	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2103
		2104	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2105	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2106	should be the file offset.
		2107
		2108	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2109	silently corrupt the data in this case.
		2110
		2111	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2112	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2113	C<IO::AIO::SPLICE_F_GIFT>.
		2114
		2115	See the C<splice(2)> manpage for details.
		2116
		2117	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2118
		2119	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		2120	description for C<IO::AIO::splice> above for details.
		2121
		2122	=back
		2123
1319	=cut	2124	=cut
1320		2125
1321	min_parallel 8;	2126	min_parallel 8;
1322		2127
1323	END { flush }	2128	END { flush }
1324		2129
1325	1;	2130	1;
1326		2131
		2132	=head1 EVENT LOOP INTEGRATION
		2133
		2134	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		2135	automatically into many event loops:
		2136
		2137	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		2138	use AnyEvent::AIO;
		2139
		2140	You can also integrate IO::AIO manually into many event loops, here are
		2141	some examples of how to do this:
		2142
		2143	# EV integration
		2144	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		2145
		2146	# Event integration
		2147	Event->io (fd => IO::AIO::poll_fileno,
		2148	poll => 'r',
		2149	cb => \&IO::AIO::poll_cb);
		2150
		2151	# Glib/Gtk2 integration
		2152	add_watch Glib::IO IO::AIO::poll_fileno,
		2153	in => sub { IO::AIO::poll_cb; 1 };
		2154
		2155	# Tk integration
		2156	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		2157	readable => \&IO::AIO::poll_cb);
		2158
		2159	# Danga::Socket integration
		2160	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		2161	\&IO::AIO::poll_cb);
		2162
1327	=head2 FORK BEHAVIOUR	2163	=head2 FORK BEHAVIOUR
1328		2164
1329	This module should do "the right thing" when the process using it forks:	2165	Usage of pthreads in a program changes the semantics of fork
		2166	considerably. Specifically, only async-safe functions can be called after
		2167	fork. Perl doesn't know about this, so in general, you cannot call fork
		2168	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2169	pthreads, so this applies, but many other extensions and (for inexplicable
		2170	reasons) perl itself often is linked against pthreads, so this limitation
		2171	applies to quite a lot of perls.
1330		2172
1331	Before the fork, IO::AIO enters a quiescent state where no requests	2173	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1332	can be added in other threads and no results will be processed. After	2174	only works in the process that loaded it. Forking is fully supported, but
1333	the fork the parent simply leaves the quiescent state and continues	2175	using IO::AIO in the child is not.
1334	request/result processing, while the child frees the request/result queue
1335	(so that the requests started before the fork will only be handled in the
1336	parent). Threads will be started on demand until the limit set in the
1337	parent process has been reached again.
1338		2176
1339	In short: the parent will, after a short pause, continue as if fork had	2177	You might get around by not I<using> IO::AIO before (or after)
1340	not been called, while the child will act as if IO::AIO has not been used	2178	forking. You could also try to call the L<IO::AIO::reinit> function in the
1341	yet.	2179	child:
		2180
		2181	=over 4
		2182
		2183	=item IO::AIO::reinit
		2184
		2185	Abandons all current requests and I/O threads and simply reinitialises all
		2186	data structures. This is not an operation supported by any standards, but
		2187	happens to work on GNU/Linux and some newer BSD systems.
		2188
		2189	The only reasonable use for this function is to call it after forking, if
		2190	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2191	the process will result in undefined behaviour. Calling it at any time
		2192	will also result in any undefined (by POSIX) behaviour.
		2193
		2194	=back
1342		2195
1343	=head2 MEMORY USAGE	2196	=head2 MEMORY USAGE
1344		2197
1345	Per-request usage:	2198	Per-request usage:
1346		2199

Diff Legend

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