ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.141 by root, Wed Oct 22 16:30:49 2008 UTC vs.
Revision 1.225 by root, Tue Apr 10 05:01:33 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.16';	173	our $VERSION = '4.15';
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
		178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
203	aio_fdatasync aio_pathsync aio_readahead	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);
		194
		195	push @AIO_REQ, qw(aio_busy); # not exported
213		196
214	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	197	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
215		198
216	require XSLoader;	199	require XSLoader;
217	XSLoader::load ("IO::AIO", $VERSION);	200	XSLoader::load ("IO::AIO", $VERSION);
218	}	201	}
219		202
220	=head1 FUNCTIONS	203	=head1 FUNCTIONS
221		204
222	=head2 AIO REQUEST FUNCTIONS	205	=head2 QUICK OVERVIEW
		206
		207	This section simply lists the prototypes of the most important functions
		208	for 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_unlink $pathname, $callback->($status)
		227	aio_mknod $pathname, $mode, $dev, $callback->($status)
		228	aio_link $srcpath, $dstpath, $callback->($status)
		229	aio_symlink $srcpath, $dstpath, $callback->($status)
		230	aio_readlink $pathname, $callback->($link)
		231	aio_realpath $pathname, $callback->($link)
		232	aio_rename $srcpath, $dstpath, $callback->($status)
		233	aio_mkdir $pathname, $mode, $callback->($status)
		234	aio_rmdir $pathname, $callback->($status)
		235	aio_readdir $pathname, $callback->($entries)
		236	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		237	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		238	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		239	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
		240	aio_load $pathname, $data, $callback->($status)
		241	aio_copy $srcpath, $dstpath, $callback->($status)
		242	aio_move $srcpath, $dstpath, $callback->($status)
		243	aio_rmtree $pathname, $callback->($status)
		244	aio_sync $callback->($status)
		245	aio_syncfs $fh, $callback->($status)
		246	aio_fsync $fh, $callback->($status)
		247	aio_fdatasync $fh, $callback->($status)
		248	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		249	aio_pathsync $pathname, $callback->($status)
		250	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		251	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		252	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		253	aio_mlockall $flags, $callback->($status)
		254	aio_group $callback->(...)
		255	aio_nop $callback->()
		256
		257	$prev_pri = aioreq_pri [$pri]
		258	aioreq_nice $pri_adjust
		259
		260	IO::AIO::poll_wait
		261	IO::AIO::poll_cb
		262	IO::AIO::poll
		263	IO::AIO::flush
		264	IO::AIO::max_poll_reqs $nreqs
		265	IO::AIO::max_poll_time $seconds
		266	IO::AIO::min_parallel $nthreads
		267	IO::AIO::max_parallel $nthreads
		268	IO::AIO::max_idle $nthreads
		269	IO::AIO::idle_timeout $seconds
		270	IO::AIO::max_outstanding $maxreqs
		271	IO::AIO::nreqs
		272	IO::AIO::nready
		273	IO::AIO::npending
		274
		275	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		276	IO::AIO::fadvise $fh, $offset, $len, $advice
		277	IO::AIO::madvise $scalar, $offset, $length, $advice
		278	IO::AIO::mprotect $scalar, $offset, $length, $protect
		279	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		280	IO::AIO::munlockall
		281
		282	=head2 API NOTES
223		283
224	All the C<aio_*> calls are more or less thin wrappers around the syscall	284	All the C<aio_*> calls are more or less thin wrappers around the syscall
225	with the same name (sans C<aio_>). The arguments are similar or identical,	285	with the same name (sans C<aio_>). The arguments are similar or identical,
226	and they all accept an additional (and optional) C<$callback> argument	286	and they all accept an additional (and optional) C<$callback> argument
227	which must be a code reference. This code reference will get called with	287	which must be a code reference. This code reference will be called after
228	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	288	the syscall has been executed in an asynchronous fashion. The results
229	perl, which usually delivers "false") as its sole argument after the given	289	of the request will be passed as arguments to the callback (and, if an
230	syscall has been executed asynchronously.	290	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		291	most syscalls return C<-1> on error, unlike perl, which usually delivers
		292	"false").
		293
		294	Some requests (such as C<aio_readdir>) pass the actual results and
		295	communicate failures by passing C<undef>.
231		296
232	All functions expecting a filehandle keep a copy of the filehandle	297	All functions expecting a filehandle keep a copy of the filehandle
233	internally until the request has finished.	298	internally until the request has finished.
234		299
235	All functions return request objects of type L<IO::AIO::REQ> that allow	300	All functions return request objects of type L<IO::AIO::REQ> that allow
236	further manipulation of those requests while they are in-flight.	301	further manipulation of those requests while they are in-flight.
237		302
238	The pathnames you pass to these routines I<must> be absolute and	303	The pathnames you pass to these routines I<should> be absolute. The
239	encoded as octets. The reason for the former is that at the time the	304	reason for this is that at the time the request is being executed, the
240	request is being executed, the current working directory could have	305	current working directory could have changed. Alternatively, you can
241	changed. Alternatively, you can make sure that you never change the	306	make sure that you never change the current working directory anywhere
242	current working directory anywhere in the program and then use relative	307	in the program and then use relative paths. You can also take advantage
243	paths.	308	of IO::AIOs working directory abstraction, that lets you specify paths
		309	relative to some previously-opened "working directory object" - see the
		310	description of the C<IO::AIO::WD> class later in this document.
244		311
245	To encode pathnames as octets, either make sure you either: a) always pass	312	To encode pathnames as octets, either make sure you either: a) always pass
246	in filenames you got from outside (command line, readdir etc.) without	313	in filenames you got from outside (command line, readdir etc.) without
247	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	314	tinkering, b) are in your native filesystem encoding, c) use the Encode
248	your pathnames to the locale (or other) encoding in effect in the user	315	module and encode your pathnames to the locale (or other) encoding in
249	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	316	effect in the user environment, d) use Glib::filename_from_unicode on
250	use something else to ensure your scalar has the correct contents.	317	unicode filenames or e) use something else to ensure your scalar has the
		318	correct contents.
251		319
252	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	320	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
253	handles correctly whether it is set or not.	321	handles correctly whether it is set or not.
		322
		323	=head2 AIO REQUEST FUNCTIONS
254		324
255	=over 4	325	=over 4
256		326
257	=item $prev_pri = aioreq_pri [$pri]	327	=item $prev_pri = aioreq_pri [$pri]
258		328
…		…
305	by the umask in effect then the request is being executed, so better never	375	by the umask in effect then the request is being executed, so better never
306	change the umask.	376	change the umask.
307		377
308	Example:	378	Example:
309		379
310	aio_open "/etc/passwd", O_RDONLY, 0, sub {	380	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
311	if ($_[0]) {	381	if ($_[0]) {
312	print "open successful, fh is $_[0]\n";	382	print "open successful, fh is $_[0]\n";
313	...	383	...
314	} else {	384	} else {
315	die "open failed: $!\n";	385	die "open failed: $!\n";
316	}	386	}
317	};	387	};
318		388
		389	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		390	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		391	following POSIX and non-POSIX constants are available (missing ones on
		392	your system are, as usual, C<0>):
		393
		394	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		395	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		396	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
		397
319		398
320	=item aio_close $fh, $callback->($status)	399	=item aio_close $fh, $callback->($status)
321		400
322	Asynchronously close a file and call the callback with the result	401	Asynchronously close a file and call the callback with the result
323	code.	402	code.
…		…
332	Or in other words: the file descriptor will be closed, but it will not be	411	Or in other words: the file descriptor will be closed, but it will not be
333	free for reuse until the perl filehandle is closed.	412	free for reuse until the perl filehandle is closed.
334		413
335	=cut	414	=cut
336		415
		416	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		417
		418	Seeks the filehandle to the new C<$offset>, similarly to perl's
		419	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		420	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		421	C<IO::AIO::SEEK_END>).
		422
		423	The resulting absolute offset will be passed to the callback, or C<-1> in
		424	case of an error.
		425
		426	In theory, the C<$whence> constants could be different than the
		427	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		428	so don't panic.
		429
		430	As a GNU/Linux (and maybe Solaris) extension, also the constants
		431	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		432	could be found. No guarantees about suitability for use in C<aio_seek> or
		433	Perl's C<sysseek> can be made though, although I would naively assume they
		434	"just work".
		435
337	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	436	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
338		437
339	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	438	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
340		439
341	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>	440	Reads or writes C<$length> bytes from or to the specified C<$fh> and
342	into the scalar given by C<$data> and offset C<$dataoffset> and calls the	441	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
343	callback without the actual number of bytes read (or -1 on error, just	442	and calls the callback without the actual number of bytes read (or -1 on
344	like the syscall).	443	error, just like the syscall).
		444
		445	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		446	offset plus the actual number of bytes read.
345		447
346	If C<$offset> is undefined, then the current file descriptor offset will	448	If C<$offset> is undefined, then the current file descriptor offset will
347	be used (and updated), otherwise the file descriptor offset will not be	449	be used (and updated), otherwise the file descriptor offset will not be
348	changed by these calls.	450	changed by these calls.
349		451
350	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.	452	If C<$length> is undefined in C<aio_write>, use the remaining length of
		453	C<$data>.
351		454
352	If C<$dataoffset> is less than zero, it will be counted from the end of	455	If C<$dataoffset> is less than zero, it will be counted from the end of
353	C<$data>.	456	C<$data>.
354		457
355	The C<$data> scalar I<MUST NOT> be modified in any way while the request	458	The C<$data> scalar I<MUST NOT> be modified in any way while the request
…		…
369		472
370	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	473	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
371	reading at byte offset C<$in_offset>, and starts writing at the current	474	reading at byte offset C<$in_offset>, and starts writing at the current
372	file offset of C<$out_fh>. Because of that, it is not safe to issue more	475	file offset of C<$out_fh>. Because of that, it is not safe to issue more
373	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	476	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
374	other.	477	other. The same C<$in_fh> works fine though, as this function does not
		478	move or use the file offset of C<$in_fh>.
375		479
		480	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		481	are written, and there is no way to find out how many more bytes have been
		482	read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
		483	number of bytes written to C<$out_fh>. Only if the result value equals
		484	C<$length> one can assume that C<$length> bytes have been read.
		485
		486	Unlike with other C<aio_> functions, it makes a lot of sense to use
		487	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		488	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		489	the socket I/O will be non-blocking. Note, however, that you can run
		490	into a trap where C<aio_sendfile> reads some data with readahead, then
		491	fails to write all data, and when the socket is ready the next time, the
		492	data in the cache is already lost, forcing C<aio_sendfile> to again hit
		493	the disk. Explicit C<aio_read> + C<aio_write> let's you better control
		494	resource usage.
		495
376	This call tries to make use of a native C<sendfile> syscall to provide	496	This call tries to make use of a native C<sendfile>-like syscall to
377	zero-copy operation. For this to work, C<$out_fh> should refer to a	497	provide zero-copy operation. For this to work, C<$out_fh> should refer to
378	socket, and C<$in_fh> should refer to mmap'able file.	498	a socket, and C<$in_fh> should refer to an mmap'able file.
379		499
380	If the native sendfile call fails or is not implemented, it will be	500	If a native sendfile cannot be found or it fails with C<ENOSYS>,
381	emulated, so you can call C<aio_sendfile> on any type of filehandle	501	C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
		502	C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
382	regardless of the limitations of the operating system.	503	type of filehandle regardless of the limitations of the operating system.
383		504
384	Please note, however, that C<aio_sendfile> can read more bytes from	505	As native sendfile syscalls (as practically any non-POSIX interface hacked
385	C<$in_fh> than are written, and there is no way to find out how many	506	together in a hurry to improve benchmark numbers) tend to be rather buggy
386	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	507	on many systems, this implementation tries to work around some known bugs
387	provides the number of bytes written to C<$out_fh>. Only if the result	508	in Linux and FreeBSD kernels (probably others, too), but that might fail,
388	value equals C<$length> one can assume that C<$length> bytes have been	509	so you really really should check the return value of C<aio_sendfile> -
389	read.	510	fewre bytes than expected might have been transferred.
390		511
391		512
392	=item aio_readahead $fh,$offset,$length, $callback->($retval)	513	=item aio_readahead $fh,$offset,$length, $callback->($retval)
393		514
394	C<aio_readahead> populates the page cache with data from a file so that	515	C<aio_readahead> populates the page cache with data from a file so that
…		…
417		538
418	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	539	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
419	error when stat'ing a large file, the results will be silently truncated	540	error when stat'ing a large file, the results will be silently truncated
420	unless perl itself is compiled with large file support.	541	unless perl itself is compiled with large file support.
421		542
		543	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		544	following constants and functions (if not implemented, the constants will
		545	be C<0> and the functions will either C<croak> or fall back on traditional
		546	behaviour).
		547
		548	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		549	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		550	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		551
422	Example: Print the length of F</etc/passwd>:	552	Example: Print the length of F</etc/passwd>:
423		553
424	aio_stat "/etc/passwd", sub {	554	aio_stat "/etc/passwd", sub {
425	$_[0] and die "stat failed: $!";	555	$_[0] and die "stat failed: $!";
426	print "size is ", -s _, "\n";	556	print "size is ", -s _, "\n";
427	};	557	};
428		558
429		559
		560	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		561
		562	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		563	whether a file handle or path was passed.
		564
		565	On success, the callback is passed a hash reference with the following
		566	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		567	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		568	is passed.
		569
		570	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		571	C<ST_NOSUID>.
		572
		573	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		574	their correct value when available, or to C<0> on systems that do
		575	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		576	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		577	C<ST_NODIRATIME> and C<ST_RELATIME>.
		578
		579	Example: stat C</wd> and dump out the data if successful.
		580
		581	aio_statvfs "/wd", sub {
		582	my $f = $_[0]
		583	or die "statvfs: $!";
		584
		585	use Data::Dumper;
		586	say Dumper $f;
		587	};
		588
		589	# result:
		590	{
		591	bsize => 1024,
		592	bfree => 4333064312,
		593	blocks => 10253828096,
		594	files => 2050765568,
		595	flag => 4096,
		596	favail => 2042092649,
		597	bavail => 4333064312,
		598	ffree => 2042092649,
		599	namemax => 255,
		600	frsize => 1024,
		601	fsid => 1810
		602	}
		603
		604
430	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	605	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
431		606
432	Works like perl's C<utime> function (including the special case of $atime	607	Works like perl's C<utime> function (including the special case of $atime
433	and $mtime being undef). Fractional times are supported if the underlying	608	and $mtime being undef). Fractional times are supported if the underlying
434	syscalls support them.	609	syscalls support them.
…		…
472		647
473	Asynchronously unlink (delete) a file and call the callback with the	648	Asynchronously unlink (delete) a file and call the callback with the
474	result code.	649	result code.
475		650
476		651
477	=item aio_mknod $path, $mode, $dev, $callback->($status)	652	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
478		653
479	[EXPERIMENTAL]	654	[EXPERIMENTAL]
480		655
481	Asynchronously create a device node (or fifo). See mknod(2).	656	Asynchronously create a device node (or fifo). See mknod(2).
482		657
483	The only (POSIX-) portable way of calling this function is:	658	The only (POSIX-) portable way of calling this function is:
484		659
485	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	660	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
486		661
		662	See C<aio_stat> for info about some potentially helpful extra constants
		663	and functions.
487		664
488	=item aio_link $srcpath, $dstpath, $callback->($status)	665	=item aio_link $srcpath, $dstpath, $callback->($status)
489		666
490	Asynchronously create a new link to the existing object at C<$srcpath> at	667	Asynchronously create a new link to the existing object at C<$srcpath> at
491	the path C<$dstpath> and call the callback with the result code.	668	the path C<$dstpath> and call the callback with the result code.
…		…
495		672
496	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	673	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
497	the path C<$dstpath> and call the callback with the result code.	674	the path C<$dstpath> and call the callback with the result code.
498		675
499		676
500	=item aio_readlink $path, $callback->($link)	677	=item aio_readlink $pathname, $callback->($link)
501		678
502	Asynchronously read the symlink specified by C<$path> and pass it to	679	Asynchronously read the symlink specified by C<$path> and pass it to
503	the callback. If an error occurs, nothing or undef gets passed to the	680	the callback. If an error occurs, nothing or undef gets passed to the
504	callback.	681	callback.
505		682
506		683
		684	=item aio_realpath $pathname, $callback->($path)
		685
		686	Asynchronously make the path absolute and resolve any symlinks in
		687	C<$path>. The resulting path only consists of directories (Same as
		688	L<Cwd::realpath>).
		689
		690	This request can be used to get the absolute path of the current working
		691	directory by passing it a path of F<.> (a single dot).
		692
		693
507	=item aio_rename $srcpath, $dstpath, $callback->($status)	694	=item aio_rename $srcpath, $dstpath, $callback->($status)
508		695
509	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	696	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
510	rename(2) and call the callback with the result code.	697	rename(2) and call the callback with the result code.
511		698
…		…
527		714
528	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	715	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
529	directory (i.e. opendir + readdir + closedir). The entries will not be	716	directory (i.e. opendir + readdir + closedir). The entries will not be
530	sorted, and will B<NOT> include the C<.> and C<..> entries.	717	sorted, and will B<NOT> include the C<.> and C<..> entries.
531		718
532	The callback a single argument which is either C<undef> or an array-ref	719	The callback is passed a single argument which is either C<undef> or an
533	with the filenames.	720	array-ref with the filenames.
534		721
535		722
		723	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		724
		725	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
		726	tune behaviour and output format. In case of an error, C<$entries> will be
		727	C<undef>.
		728
		729	The flags are a combination of the following constants, ORed together (the
		730	flags will also be passed to the callback, possibly modified):
		731
		732	=over 4
		733
		734	=item IO::AIO::READDIR_DENTS
		735
		736	When this flag is off, then the callback gets an arrayref consisting of
		737	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		738	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		739	entry in more detail.
		740
		741	C<$name> is the name of the entry.
		742
		743	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		744
		745	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		746	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		747	C<IO::AIO::DT_WHT>.
		748
		749	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		750	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		751	scalars are read-only: you can not modify them.
		752
		753	C<$inode> is the inode number (which might not be exact on systems with 64
		754	bit inode numbers and 32 bit perls). This field has unspecified content on
		755	systems that do not deliver the inode information.
		756
		757	=item IO::AIO::READDIR_DIRS_FIRST
		758
		759	When this flag is set, then the names will be returned in an order where
		760	likely directories come first, in optimal stat order. This is useful when
		761	you need to quickly find directories, or you want to find all directories
		762	while avoiding to stat() each entry.
		763
		764	If the system returns type information in readdir, then this is used
		765	to find directories directly. Otherwise, likely directories are names
		766	beginning with ".", or otherwise names with no dots, of which names with
		767	short names are tried first.
		768
		769	=item IO::AIO::READDIR_STAT_ORDER
		770
		771	When this flag is set, then the names will be returned in an order
		772	suitable for stat()'ing each one. That is, when you plan to stat()
		773	all files in the given directory, then the returned order will likely
		774	be fastest.
		775
		776	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		777	the likely dirs come first, resulting in a less optimal stat order.
		778
		779	=item IO::AIO::READDIR_FOUND_UNKNOWN
		780
		781	This flag should not be set when calling C<aio_readdirx>. Instead, it
		782	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		783	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
		784	C<$type>'s are known, which can be used to speed up some algorithms.
		785
		786	=back
		787
		788
536	=item aio_load $path, $data, $callback->($status)	789	=item aio_load $pathname, $data, $callback->($status)
537		790
538	This is a composite request that tries to fully load the given file into	791	This is a composite request that tries to fully load the given file into
539	memory. Status is the same as with aio_read.	792	memory. Status is the same as with aio_read.
540		793
541	=cut	794	=cut
…		…
563		816
564	=item aio_copy $srcpath, $dstpath, $callback->($status)	817	=item aio_copy $srcpath, $dstpath, $callback->($status)
565		818
566	Try to copy the I<file> (directories not supported as either source or	819	Try to copy the I<file> (directories not supported as either source or
567	destination) from C<$srcpath> to C<$dstpath> and call the callback with	820	destination) from C<$srcpath> to C<$dstpath> and call the callback with
568	the C<0> (error) or C<-1> ok.	821	a status of C<0> (ok) or C<-1> (error, see C<$!>).
569		822
570	This is a composite request that creates the destination file with	823	This is a composite request that creates the destination file with
571	mode 0200 and copies the contents of the source file into it using	824	mode 0200 and copies the contents of the source file into it using
572	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	825	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
573	uid/gid, in that order.	826	uid/gid, in that order.
…		…
585	my $grp = aio_group $cb;	838	my $grp = aio_group $cb;
586		839
587	aioreq_pri $pri;	840	aioreq_pri $pri;
588	add $grp aio_open $src, O_RDONLY, 0, sub {	841	add $grp aio_open $src, O_RDONLY, 0, sub {
589	if (my $src_fh = $_[0]) {	842	if (my $src_fh = $_[0]) {
590	my @stat = stat $src_fh;	843	my @stat = stat $src_fh; # hmm, might block over nfs?
591		844
592	aioreq_pri $pri;	845	aioreq_pri $pri;
593	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {	846	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
594	if (my $dst_fh = $_[0]) {	847	if (my $dst_fh = $_[0]) {
595	aioreq_pri $pri;	848	aioreq_pri $pri;
596	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	849	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
597	if ($_[0] == $stat[7]) {	850	if ($_[0] == $stat[7]) {
598	$grp->result (0);	851	$grp->result (0);
599	close $src_fh;	852	close $src_fh;
600		853
601	# those should not normally block. should. should.	854	my $ch = sub {
602	utime $stat[8], $stat[9], $dst;	855	aioreq_pri $pri;
603	chmod $stat[2] & 07777, $dst_fh;	856	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
604	chown $stat[4], $stat[5], $dst_fh;	857	aioreq_pri $pri;
		858	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		859	aioreq_pri $pri;
		860	add $grp aio_close $dst_fh;
		861	}
		862	};
		863	};
605		864
606	aioreq_pri $pri;	865	aioreq_pri $pri;
607	add $grp aio_close $dst_fh;	866	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		867	if ($_[0] < 0 && $! == ENOSYS) {
		868	aioreq_pri $pri;
		869	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		870	} else {
		871	$ch->();
		872	}
		873	};
608	} else {	874	} else {
609	$grp->result (-1);	875	$grp->result (-1);
610	close $src_fh;	876	close $src_fh;
611	close $dst_fh;	877	close $dst_fh;
612		878
…		…
629		895
630	=item aio_move $srcpath, $dstpath, $callback->($status)	896	=item aio_move $srcpath, $dstpath, $callback->($status)
631		897
632	Try to move the I<file> (directories not supported as either source or	898	Try to move the I<file> (directories not supported as either source or
633	destination) from C<$srcpath> to C<$dstpath> and call the callback with	899	destination) from C<$srcpath> to C<$dstpath> and call the callback with
634	the C<0> (error) or C<-1> ok.	900	a status of C<0> (ok) or C<-1> (error, see C<$!>).
635		901
636	This is a composite request that tries to rename(2) the file first; if	902	This is a composite request that tries to rename(2) the file first; if
637	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if	903	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
638	that is successful, unlinks the C<$srcpath>.	904	that is successful, unlinks the C<$srcpath>.
639		905
…		…
650	if ($_[0] && $! == EXDEV) {	916	if ($_[0] && $! == EXDEV) {
651	aioreq_pri $pri;	917	aioreq_pri $pri;
652	add $grp aio_copy $src, $dst, sub {	918	add $grp aio_copy $src, $dst, sub {
653	$grp->result ($_[0]);	919	$grp->result ($_[0]);
654		920
655	if (!$_[0]) {	921	unless ($_[0]) {
656	aioreq_pri $pri;	922	aioreq_pri $pri;
657	add $grp aio_unlink $src;	923	add $grp aio_unlink $src;
658	}	924	}
659	};	925	};
660	} else {	926	} else {
…		…
663	};	929	};
664		930
665	$grp	931	$grp
666	}	932	}
667		933
668	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	934	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
669		935
670	Scans a directory (similar to C<aio_readdir>) but additionally tries to	936	Scans a directory (similar to C<aio_readdir>) but additionally tries to
671	efficiently separate the entries of directory C<$path> into two sets of	937	efficiently separate the entries of directory C<$path> into two sets of
672	names, directories you can recurse into (directories), and ones you cannot	938	names, directories you can recurse into (directories), and ones you cannot
673	recurse into (everything else, including symlinks to directories).	939	recurse into (everything else, including symlinks to directories).
…		…
690		956
691	Implementation notes.	957	Implementation notes.
692		958
693	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	959	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
694		960
		961	If readdir returns file type information, then this is used directly to
		962	find directories.
		963
695	After reading the directory, the modification time, size etc. of the	964	Otherwise, after reading the directory, the modification time, size etc.
696	directory before and after the readdir is checked, and if they match (and	965	of the directory before and after the readdir is checked, and if they
697	isn't the current time), the link count will be used to decide how many	966	match (and isn't the current time), the link count will be used to decide
698	entries are directories (if >= 2). Otherwise, no knowledge of the number	967	how many entries are directories (if >= 2). Otherwise, no knowledge of the
699	of subdirectories will be assumed.	968	number of subdirectories will be assumed.
700		969
701	Then entries will be sorted into likely directories (everything without	970	Then entries will be sorted into likely directories a non-initial dot
702	a non-initial dot currently) and likely non-directories (everything	971	currently) and likely non-directories (see C<aio_readdirx>). Then every
703	else). Then every entry plus an appended C</.> will be C<stat>'ed,	972	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
704	likely directories first. If that succeeds, it assumes that the entry	973	in order of their inode numbers. If that succeeds, it assumes that the
705	is a directory or a symlink to directory (which will be checked	974	entry is a directory or a symlink to directory (which will be checked
706	seperately). This is often faster than stat'ing the entry itself because	975	separately). This is often faster than stat'ing the entry itself because
707	filesystems might detect the type of the entry without reading the inode	976	filesystems might detect the type of the entry without reading the inode
708	data (e.g. ext2fs filetype feature).	977	data (e.g. ext2fs filetype feature), even on systems that cannot return
		978	the filetype information on readdir.
709		979
710	If the known number of directories (link count - 2) has been reached, the	980	If the known number of directories (link count - 2) has been reached, the
711	rest of the entries is assumed to be non-directories.	981	rest of the entries is assumed to be non-directories.
712		982
713	This only works with certainty on POSIX (= UNIX) filesystems, which	983	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
726		996
727	my $grp = aio_group $cb;	997	my $grp = aio_group $cb;
728		998
729	$maxreq = 4 if $maxreq <= 0;	999	$maxreq = 4 if $maxreq <= 0;
730		1000
731	# stat once	1001	# get a wd object
732	aioreq_pri $pri;	1002	aioreq_pri $pri;
733	add $grp aio_stat $path, sub {	1003	add $grp aio_wd $path, sub {
		1004	$_[0]
734	return $grp->result () if $_[0];	1005	or return $grp->result ();
735	my $now = time;
736	my $hash1 = join ":", (stat _)[0,1,3,7,9];
737		1006
738	# read the directory entries	1007	my $wd = [shift, "."];
		1008
		1009	# stat once
739	aioreq_pri $pri;	1010	aioreq_pri $pri;
740	add $grp aio_readdir $path, sub {	1011	add $grp aio_stat $wd, sub {
741	my $entries = shift
742	or return $grp->result ();	1012	return $grp->result () if $_[0];
		1013	my $now = time;
		1014	my $hash1 = join ":", (stat _)[0,1,3,7,9];
743		1015
744	# stat the dir another time	1016	# read the directory entries
745	aioreq_pri $pri;	1017	aioreq_pri $pri;
		1018	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1019	my $entries = shift
		1020	or return $grp->result ();
		1021
		1022	# stat the dir another time
		1023	aioreq_pri $pri;
746	add $grp aio_stat $path, sub {	1024	add $grp aio_stat $wd, sub {
747	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1025	my $hash2 = join ":", (stat _)[0,1,3,7,9];
748		1026
749	my $ndirs;	1027	my $ndirs;
750		1028
751	# take the slow route if anything looks fishy	1029	# take the slow route if anything looks fishy
752	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1030	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
753	$ndirs = -1;	1031	$ndirs = -1;
754	} else {	1032	} else {
755	# if nlink == 2, we are finished	1033	# if nlink == 2, we are finished
756	# on non-posix-fs's, we rely on nlink < 2	1034	# for non-posix-fs's, we rely on nlink < 2
757	$ndirs = (stat _)[3] - 2	1035	$ndirs = (stat _)[3] - 2
758	or return $grp->result ([], $entries);	1036	or return $grp->result ([], $entries);
759	}	1037	}
760		1038
761	# sort into likely dirs and likely nondirs
762	# dirs == files without ".", short entries first
763	$entries = [map $_->[0],
764	sort { $b->[1] cmp $a->[1] }
765	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
766	@$entries];
767
768	my (@dirs, @nondirs);	1039	my (@dirs, @nondirs);
769		1040
770	my $statgrp = add $grp aio_group sub {	1041	my $statgrp = add $grp aio_group sub {
771	$grp->result (\@dirs, \@nondirs);	1042	$grp->result (\@dirs, \@nondirs);
772	};	1043	};
773		1044
774	limit $statgrp $maxreq;	1045	limit $statgrp $maxreq;
775	feed $statgrp sub {	1046	feed $statgrp sub {
776	return unless @$entries;	1047	return unless @$entries;
777	my $entry = pop @$entries;	1048	my $entry = shift @$entries;
778		1049
779	aioreq_pri $pri;	1050	aioreq_pri $pri;
		1051	$wd->[1] = "$entry/.";
780	add $statgrp aio_stat "$path/$entry/.", sub {	1052	add $statgrp aio_stat $wd, sub {
781	if ($_[0] < 0) {	1053	if ($_[0] < 0) {
782	push @nondirs, $entry;	1054	push @nondirs, $entry;
783	} else {	1055	} else {
784	# need to check for real directory	1056	# need to check for real directory
785	aioreq_pri $pri;	1057	aioreq_pri $pri;
		1058	$wd->[1] = $entry;
786	add $statgrp aio_lstat "$path/$entry", sub {	1059	add $statgrp aio_lstat $wd, sub {
787	if (-d _) {	1060	if (-d _) {
788	push @dirs, $entry;	1061	push @dirs, $entry;
789		1062
790	unless (--$ndirs) {	1063	unless (--$ndirs) {
791	push @nondirs, @$entries;	1064	push @nondirs, @$entries;
792	feed $statgrp;	1065	feed $statgrp;
		1066	}
		1067	} else {
		1068	push @nondirs, $entry;
793	}	1069	}
794	} else {
795	push @nondirs, $entry;
796	}	1070	}
797	}	1071	}
798	}	1072	};
799	};	1073	};
800	};	1074	};
801	};	1075	};
802	};	1076	};
803	};	1077	};
804		1078
805	$grp	1079	$grp
806	}	1080	}
807		1081
808	=item aio_rmtree $path, $callback->($status)	1082	=item aio_rmtree $pathname, $callback->($status)
809		1083
810	Delete a directory tree starting (and including) C<$path>, return the	1084	Delete a directory tree starting (and including) C<$path>, return the
811	status of the final C<rmdir> only. This is a composite request that	1085	status of the final C<rmdir> only. This is a composite request that
812	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1086	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
813	everything else.	1087	everything else.
…		…
855	callback with the fdatasync result code.	1129	callback with the fdatasync result code.
856		1130
857	If this call isn't available because your OS lacks it or it couldn't be	1131	If this call isn't available because your OS lacks it or it couldn't be
858	detected, it will be emulated by calling C<fsync> instead.	1132	detected, it will be emulated by calling C<fsync> instead.
859		1133
		1134	=item aio_syncfs $fh, $callback->($status)
		1135
		1136	Asynchronously call the syncfs syscall to sync the filesystem associated
		1137	to the given filehandle and call the callback with the syncfs result
		1138	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1139	errno to C<ENOSYS> nevertheless.
		1140
		1141	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		1142
		1143	Sync the data portion of the file specified by C<$offset> and C<$length>
		1144	to disk (but NOT the metadata), by calling the Linux-specific
		1145	sync_file_range call. If sync_file_range is not available or it returns
		1146	ENOSYS, then fdatasync or fsync is being substituted.
		1147
		1148	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		1149	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		1150	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		1151	manpage for details.
		1152
860	=item aio_pathsync $path, $callback->($status)	1153	=item aio_pathsync $pathname, $callback->($status)
861		1154
862	This request tries to open, fsync and close the given path. This is a	1155	This request tries to open, fsync and close the given path. This is a
863	composite request intended to sync directories after directory operations	1156	composite request intended to sync directories after directory operations
864	(E.g. rename). This might not work on all operating systems or have any	1157	(E.g. rename). This might not work on all operating systems or have any
865	specific effect, but usually it makes sure that directory changes get	1158	specific effect, but usually it makes sure that directory changes get
866	written to disc. It works for anything that can be opened for read-only,	1159	written to disc. It works for anything that can be opened for read-only,
867	not just directories.	1160	not just directories.
		1161
		1162	Future versions of this function might fall back to other methods when
		1163	C<fsync> on the directory fails (such as calling C<sync>).
868		1164
869	Passes C<0> when everything went ok, and C<-1> on error.	1165	Passes C<0> when everything went ok, and C<-1> on error.
870		1166
871	=cut	1167	=cut
872		1168
…		…
893	};	1189	};
894		1190
895	$grp	1191	$grp
896	}	1192	}
897		1193
		1194	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1195
		1196	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1197	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1198	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1199	scalar must only be modified in-place while an aio operation is pending on
		1200	it).
		1201
		1202	It calls the C<msync> function of your OS, if available, with the memory
		1203	area starting at C<$offset> in the string and ending C<$length> bytes
		1204	later. If C<$length> is negative, counts from the end, and if C<$length>
		1205	is C<undef>, then it goes till the end of the string. The flags can be
		1206	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1207	C<IO::AIO::MS_SYNC>.
		1208
		1209	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1210
		1211	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1212	scalars.
		1213
		1214	It touches (reads or writes) all memory pages in the specified
		1215	range inside the scalar. All caveats and parameters are the same
		1216	as for C<aio_msync>, above, except for flags, which must be either
		1217	C<0> (which reads all pages and ensures they are instantiated) or
		1218	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1219	writing an octet from it, which dirties the page).
		1220
		1221	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1222
		1223	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1224	scalars.
		1225
		1226	It reads in all the pages of the underlying storage into memory (if any)
		1227	and locks them, so they are not getting swapped/paged out or removed.
		1228
		1229	If C<$length> is undefined, then the scalar will be locked till the end.
		1230
		1231	On systems that do not implement C<mlock>, this function returns C<-1>
		1232	and sets errno to C<ENOSYS>.
		1233
		1234	Note that the corresponding C<munlock> is synchronous and is
		1235	documented under L<MISCELLANEOUS FUNCTIONS>.
		1236
		1237	Example: open a file, mmap and mlock it - both will be undone when
		1238	C<$data> gets destroyed.
		1239
		1240	open my $fh, "<", $path or die "$path: $!";
		1241	my $data;
		1242	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1243	aio_mlock $data; # mlock in background
		1244
		1245	=item aio_mlockall $flags, $callback->($status)
		1246
		1247	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1248	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1249
		1250	On systems that do not implement C<mlockall>, this function returns C<-1>
		1251	and sets errno to C<ENOSYS>.
		1252
		1253	Note that the corresponding C<munlockall> is synchronous and is
		1254	documented under L<MISCELLANEOUS FUNCTIONS>.
		1255
		1256	Example: asynchronously lock all current and future pages into memory.
		1257
		1258	aio_mlockall IO::AIO::MCL_FUTURE;
		1259
		1260	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1261
		1262	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,
		1263	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the
		1264	C<ioctl> is not available on your OS, then this rquiest will fail with
		1265	C<ENOSYS>.
		1266
		1267	C<$start> is the starting offset to query extents for, C<$length> is the
		1268	size of the range to query - if it is C<undef>, then the whole file will
		1269	be queried.
		1270
		1271	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1272	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1273	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1274	the data portion.
		1275
		1276	C<$count> is the maximum number of extent records to return. If it is
		1277	C<undef>, then IO::AIO queries all extents of the file. As a very special
		1278	case, if it is C<0>, then the callback receives the number of extents
		1279	instead of the extents themselves.
		1280
		1281	If an error occurs, the callback receives no arguments. The special
		1282	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1283
		1284	Otherwise, the callback receives an array reference with extent
		1285	structures. Each extent structure is an array reference itself, with the
		1286	following members:
		1287
		1288	[$logical, $physical, $length, $flags]
		1289
		1290	Flags is any combination of the following flag values (typically either C<0>
		1291	or C<IO::AIO::FIEMAP_EXTENT_LAST>):
		1292
		1293	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1294	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1295	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1296	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1297	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1298	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1299
898	=item aio_group $callback->(...)	1300	=item aio_group $callback->(...)
899		1301
900	This is a very special aio request: Instead of doing something, it is a	1302	This is a very special aio request: Instead of doing something, it is a
901	container for other aio requests, which is useful if you want to bundle	1303	container for other aio requests, which is useful if you want to bundle
902	many requests into a single, composite, request with a definite callback	1304	many requests into a single, composite, request with a definite callback
…		…
939	immense (it blocks a thread for a long time) so do not use this function	1341	immense (it blocks a thread for a long time) so do not use this function
940	except to put your application under artificial I/O pressure.	1342	except to put your application under artificial I/O pressure.
941		1343
942	=back	1344	=back
943		1345
		1346
		1347	=head2 IO::AIO::WD - multiple working directories
		1348
		1349	Your process only has one current working directory, which is used by all
		1350	threads. This makes it hard to use relative paths (some other component
		1351	could call C<chdir> at any time, and it is hard to control when the path
		1352	will be used by IO::AIO).
		1353
		1354	One solution for this is to always use absolute paths. This usually works,
		1355	but can be quite slow (the kernel has to walk the whole path on every
		1356	access), and can also be a hassle to implement.
		1357
		1358	Newer POSIX systems have a number of functions (openat, fdopendir,
		1359	futimensat and so on) that make it possible to specify working directories
		1360	per operation.
		1361
		1362	For portability, and because the clowns who "designed", or shall I write,
		1363	perpetrated this new interface were obviously half-drunk, this abstraction
		1364	cannot be perfect, though.
		1365
		1366	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1367	object. This object stores the canonicalised, absolute version of the
		1368	path, and on systems that allow it, also a directory file descriptor.
		1369
		1370	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1371	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1372	object and a pathname instead (or the IO::AIO::WD object alone, which
		1373	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1374	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1375	to that IO::AIO::WD object.
		1376
		1377	For example, to get a wd object for F</etc> and then stat F<passwd>
		1378	inside, you would write:
		1379
		1380	aio_wd "/etc", sub {
		1381	my $etcdir = shift;
		1382
		1383	# although $etcdir can be undef on error, there is generally no reason
		1384	# to check for errors here, as aio_stat will fail with ENOENT
		1385	# when $etcdir is undef.
		1386
		1387	aio_stat [$etcdir, "passwd"], sub {
		1388	# yay
		1389	};
		1390	};
		1391
		1392	That C<aio_wd> is a request and not a normal function shows that creating
		1393	an IO::AIO::WD object is itself a potentially blocking operation, which is
		1394	why it is done asynchronously.
		1395
		1396	To stat the directory obtained with C<aio_wd> above, one could write
		1397	either of the following three request calls:
		1398
		1399	aio_lstat "/etc" , sub { ... # pathname as normal string
		1400	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1401	aio_lstat $wd , sub { ... # shorthand for the previous
		1402
		1403	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1404	object and the pathname string, so you could write the following without
		1405	causing any issues due to C<$path> getting reused:
		1406
		1407	my $path = [$wd, undef];
		1408
		1409	for my $name (qw(abc def ghi)) {
		1410	$path->[1] = $name;
		1411	aio_stat $path, sub {
		1412	# ...
		1413	};
		1414	}
		1415
		1416	There are some caveats: when directories get renamed (or deleted), the
		1417	pathname string doesn't change, so will point to the new directory (or
		1418	nowhere at all), while the directory fd, if available on the system,
		1419	will still point to the original directory. Most functions accepting a
		1420	pathname will use the directory fd on newer systems, and the string on
		1421	older systems. Some functions (such as realpath) will always rely on the
		1422	string form of the pathname.
		1423
		1424	So this fucntionality is mainly useful to get some protection against
		1425	C<chdir>, to easily get an absolute path out of a relative path for future
		1426	reference, and to speed up doing many operations in the same directory
		1427	(e.g. when stat'ing all files in a directory).
		1428
		1429	The following functions implement this working directory abstraction:
		1430
		1431	=over 4
		1432
		1433	=item aio_wd $pathname, $callback->($wd)
		1434
		1435	Asynchonously canonicalise the given pathname and convert it to an
		1436	IO::AIO::WD object representing it. If possible and supported on the
		1437	system, also open a directory fd to speed up pathname resolution relative
		1438	to this working directory.
		1439
		1440	If something goes wrong, then C<undef> is passwd to the callback instead
		1441	of a working directory object and C<$!> is set appropriately. Since
		1442	passing C<undef> as working directory component of a pathname fails the
		1443	request with C<ENOENT>, there is often no need for error checking in the
		1444	C<aio_wd> callback, as future requests using the value will fail in the
		1445	expected way.
		1446
		1447	If this call isn't available because your OS lacks it or it couldn't be
		1448	detected, it will be emulated by calling C<fsync> instead.
		1449
		1450	=item IO::AIO::CWD
		1451
		1452	This is a compiletime constant (object) that represents the process
		1453	current working directory.
		1454
		1455	Specifying this object as working directory object for a pathname is as
		1456	if the pathname would be specified directly, without a directory object,
		1457	e.g., these calls are functionally identical:
		1458
		1459	aio_stat "somefile", sub { ... };
		1460	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1461
		1462	=back
		1463
		1464
944	=head2 IO::AIO::REQ CLASS	1465	=head2 IO::AIO::REQ CLASS
945		1466
946	All non-aggregate C<aio_*> functions return an object of this class when	1467	All non-aggregate C<aio_*> functions return an object of this class when
947	called in non-void context.	1468	called in non-void context.
948		1469
…		…
951	=item cancel $req	1472	=item cancel $req
952		1473
953	Cancels the request, if possible. Has the effect of skipping execution	1474	Cancels the request, if possible. Has the effect of skipping execution
954	when entering the B<execute> state and skipping calling the callback when	1475	when entering the B<execute> state and skipping calling the callback when
955	entering the the B<result> state, but will leave the request otherwise	1476	entering the the B<result> state, but will leave the request otherwise
956	untouched. That means that requests that currently execute will not be	1477	untouched (with the exception of readdir). That means that requests that
957	stopped and resources held by the request will not be freed prematurely.	1478	currently execute will not be stopped and resources held by the request
		1479	will not be freed prematurely.
958		1480
959	=item cb $req $callback->(...)	1481	=item cb $req $callback->(...)
960		1482
961	Replace (or simply set) the callback registered to the request.	1483	Replace (or simply set) the callback registered to the request.
962		1484
…		…
1036	=item $grp->cancel_subs	1558	=item $grp->cancel_subs
1037		1559
1038	Cancel all subrequests and clears any feeder, but not the group request	1560	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.	1561	itself. Useful when you queued a lot of events but got a result early.
1040		1562
		1563	The group request will finish normally (you cannot add requests to the
		1564	group).
		1565
1041	=item $grp->result (...)	1566	=item $grp->result (...)
1042		1567
1043	Set the result value(s) that will be passed to the group callback when all	1568	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	1569	subrequests have finished and set the groups errno to the current value
1045	of errno (just like calling C<errno> without an error number). By default,	1570	of errno (just like calling C<errno> without an error number). By default,
…		…
1061		1586
1062	Sets a feeder/generator on this group: every group can have an attached	1587	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,	1588	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,	1589	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 example,	1590	this might starve other requests for a potentially long time. For example,
1066	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1591	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1067	delaying any later requests for a long time.	1592	requests, delaying any later requests for a long time.
1068		1593
1069	To avoid this, and allow incremental generation of requests, you can	1594	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	1595	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>,	1596	feed callback will be called whenever there are few enough (see C<limit>,
1072	below) requests active in the group itself and is expected to queue more	1597	below) requests active in the group itself and is expected to queue more
…		…
1113	=over 4	1638	=over 4
1114		1639
1115	=item $fileno = IO::AIO::poll_fileno	1640	=item $fileno = IO::AIO::poll_fileno
1116		1641
1117	Return the I<request result pipe file descriptor>. This filehandle must be	1642	Return the I<request result pipe file descriptor>. This filehandle must be
1118	polled for reading by some mechanism outside this module (e.g. Event or	1643	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1119	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1644	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1120	to call C<poll_cb> to check the results.	1645	you have to call C<poll_cb> to check the results.
1121		1646
1122	See C<poll_cb> for an example.	1647	See C<poll_cb> for an example.
1123		1648
1124	=item IO::AIO::poll_cb	1649	=item IO::AIO::poll_cb
1125		1650
1126	Process some outstanding events on the result pipe. You have to call this	1651	Process some outstanding events on the result pipe. You have to call
1127	regularly. Returns C<0> if all events could be processed, or C<-1> if it	1652	this regularly. Returns C<0> if all events could be processed (or there
1128	returned earlier for whatever reason. Returns immediately when no events	1653	were no events to process), or C<-1> if it returned earlier for whatever
1129	are outstanding. The amount of events processed depends on the settings of	1654	reason. Returns immediately when no events are outstanding. The amount of
1130	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1655	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1656	C<IO::AIO::max_poll_time>.
1131		1657
1132	If not all requests were processed for whatever reason, the filehandle	1658	If not all requests were processed for whatever reason, the filehandle
1133	will still be ready when C<poll_cb> returns, so normally you don't have to	1659	will still be ready when C<poll_cb> returns, so normally you don't have to
1134	do anything special to have it called later.	1660	do anything special to have it called later.
1135		1661
		1662	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1663	ready, it can be beneficial to call this function from loops which submit
		1664	a lot of requests, to make sure the results get processed when they become
		1665	available and not just when the loop is finished and the event loop takes
		1666	over again. This function returns very fast when there are no outstanding
		1667	requests.
		1668
1136	Example: Install an Event watcher that automatically calls	1669	Example: Install an Event watcher that automatically calls
1137	IO::AIO::poll_cb with high priority:	1670	IO::AIO::poll_cb with high priority (more examples can be found in the
		1671	SYNOPSIS section, at the top of this document):
1138		1672
1139	Event->io (fd => IO::AIO::poll_fileno,	1673	Event->io (fd => IO::AIO::poll_fileno,
1140	poll => 'r', async => 1,	1674	poll => 'r', async => 1,
1141	cb => \&IO::AIO::poll_cb);	1675	cb => \&IO::AIO::poll_cb);
		1676
		1677	=item IO::AIO::poll_wait
		1678
		1679	If there are any outstanding requests and none of them in the result
		1680	phase, wait till the result filehandle becomes ready for reading (simply
		1681	does a C<select> on the filehandle. This is useful if you want to
		1682	synchronously wait for some requests to finish).
		1683
		1684	See C<nreqs> for an example.
		1685
		1686	=item IO::AIO::poll
		1687
		1688	Waits until some requests have been handled.
		1689
		1690	Returns the number of requests processed, but is otherwise strictly
		1691	equivalent to:
		1692
		1693	IO::AIO::poll_wait, IO::AIO::poll_cb
		1694
		1695	=item IO::AIO::flush
		1696
		1697	Wait till all outstanding AIO requests have been handled.
		1698
		1699	Strictly equivalent to:
		1700
		1701	IO::AIO::poll_wait, IO::AIO::poll_cb
		1702	while IO::AIO::nreqs;
1142		1703
1143	=item IO::AIO::max_poll_reqs $nreqs	1704	=item IO::AIO::max_poll_reqs $nreqs
1144		1705
1145	=item IO::AIO::max_poll_time $seconds	1706	=item IO::AIO::max_poll_time $seconds
1146		1707
…		…
1171	# use a low priority so other tasks have priority	1732	# use a low priority so other tasks have priority
1172	Event->io (fd => IO::AIO::poll_fileno,	1733	Event->io (fd => IO::AIO::poll_fileno,
1173	poll => 'r', nice => 1,	1734	poll => 'r', nice => 1,
1174	cb => &IO::AIO::poll_cb);	1735	cb => &IO::AIO::poll_cb);
1175		1736
1176	=item IO::AIO::poll_wait
1177
1178	If there are any outstanding requests and none of them in the result
1179	phase, wait till the result filehandle becomes ready for reading (simply
1180	does a C<select> on the filehandle. This is useful if you want to
1181	synchronously wait for some requests to finish).
1182
1183	See C<nreqs> for an example.
1184
1185	=item IO::AIO::poll
1186
1187	Waits until some requests have been handled.
1188
1189	Returns the number of requests processed, but is otherwise strictly
1190	equivalent to:
1191
1192	IO::AIO::poll_wait, IO::AIO::poll_cb
1193
1194	=item IO::AIO::flush
1195
1196	Wait till all outstanding AIO requests have been handled.
1197
1198	Strictly equivalent to:
1199
1200	IO::AIO::poll_wait, IO::AIO::poll_cb
1201	while IO::AIO::nreqs;
1202
1203	=back	1737	=back
1204		1738
1205	=head3 CONTROLLING THE NUMBER OF THREADS	1739	=head3 CONTROLLING THE NUMBER OF THREADS
1206		1740
1207	=over	1741	=over
…		…
1240		1774
1241	Under normal circumstances you don't need to call this function.	1775	Under normal circumstances you don't need to call this function.
1242		1776
1243	=item IO::AIO::max_idle $nthreads	1777	=item IO::AIO::max_idle $nthreads
1244		1778
1245	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1779	Limit the number of threads (default: 4) that are allowed to idle
1246	threads that did not get a request to process within 10 seconds). That	1780	(i.e., threads that did not get a request to process within the idle
1247	means if a thread becomes idle while C<$nthreads> other threads are also	1781	timeout (default: 10 seconds). That means if a thread becomes idle while
1248	idle, it will free its resources and exit.	1782	C<$nthreads> other threads are also idle, it will free its resources and
		1783	exit.
1249		1784
1250	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1785	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1251	to allow for extremely high load situations, but want to free resources	1786	to allow for extremely high load situations, but want to free resources
1252	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1787	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1253		1788
1254	The default is probably ok in most situations, especially if thread	1789	The default is probably ok in most situations, especially if thread
1255	creation is fast. If thread creation is very slow on your system you might	1790	creation is fast. If thread creation is very slow on your system you might
1256	want to use larger values.	1791	want to use larger values.
1257		1792
		1793	=item IO::AIO::idle_timeout $seconds
		1794
		1795	Sets the minimum idle timeout (default 10) after which worker threads are
		1796	allowed to exit. SEe C<IO::AIO::max_idle>.
		1797
1258	=item IO::AIO::max_outstanding $maxreqs	1798	=item IO::AIO::max_outstanding $maxreqs
		1799
		1800	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1801	you do queue up more than this number of requests, the next call to
		1802	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1803	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1804	longer exceeded.
		1805
		1806	In other words, this setting does not enforce a queue limit, but can be
		1807	used to make poll functions block if the limit is exceeded.
1259		1808
1260	This is a very bad function to use in interactive programs because it	1809	This is a very bad function to use in interactive programs because it
1261	blocks, and a bad way to reduce concurrency because it is inexact: Better	1810	blocks, and a bad way to reduce concurrency because it is inexact: Better
1262	use an C<aio_group> together with a feed callback.	1811	use an C<aio_group> together with a feed callback.
1263		1812
1264	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1813	It's main use is in scripts without an event loop - when you want to stat
1265	do queue up more than this number of requests, the next call to the	1814	a lot of files, you can write somehting like this:
1266	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1267	function will block until the limit is no longer exceeded.
1268		1815
1269	The default value is very large, so there is no practical limit on the	1816	IO::AIO::max_outstanding 32;
1270	number of outstanding requests.
1271		1817
1272	You can still queue as many requests as you want. Therefore,	1818	for my $path (...) {
1273	C<max_outstanding> is mainly useful in simple scripts (with low values) or	1819	aio_stat $path , ...;
1274	as a stop gap to shield against fatal memory overflow (with large values).	1820	IO::AIO::poll_cb;
		1821	}
		1822
		1823	IO::AIO::flush;
		1824
		1825	The call to C<poll_cb> inside the loop will normally return instantly, but
		1826	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1827	some requests have been handled. This keeps the loop from pushing a large
		1828	number of C<aio_stat> requests onto the queue.
		1829
		1830	The default value for C<max_outstanding> is very large, so there is no
		1831	practical limit on the number of outstanding requests.
1275		1832
1276	=back	1833	=back
1277		1834
1278	=head3 STATISTICAL INFORMATION	1835	=head3 STATISTICAL INFORMATION
1279		1836
…		…
1299	Returns the number of requests currently in the pending state (executed,	1856	Returns the number of requests currently in the pending state (executed,
1300	but not yet processed by poll_cb).	1857	but not yet processed by poll_cb).
1301		1858
1302	=back	1859	=back
1303		1860
		1861	=head3 MISCELLANEOUS FUNCTIONS
		1862
		1863	IO::AIO implements some functions that might be useful, but are not
		1864	asynchronous.
		1865
		1866	=over 4
		1867
		1868	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1869
		1870	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1871	but is blocking (this makes most sense if you know the input data is
		1872	likely cached already and the output filehandle is set to non-blocking
		1873	operations).
		1874
		1875	Returns the number of bytes copied, or C<-1> on error.
		1876
		1877	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1878
		1879	Simply calls the C<posix_fadvise> function (see its
		1880	manpage for details). The following advice constants are
		1881	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1882	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1883	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1884
		1885	On systems that do not implement C<posix_fadvise>, this function returns
		1886	ENOSYS, otherwise the return value of C<posix_fadvise>.
		1887
		1888	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1889
		1890	Simply calls the C<posix_madvise> function (see its
		1891	manpage for details). The following advice constants are
		1892	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1893	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1894
		1895	On systems that do not implement C<posix_madvise>, this function returns
		1896	ENOSYS, otherwise the return value of C<posix_madvise>.
		1897
		1898	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1899
		1900	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1901	$scalar (see its manpage for details). The following protect
		1902	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1903	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1904
		1905	On systems that do not implement C<mprotect>, this function returns
		1906	ENOSYS, otherwise the return value of C<mprotect>.
		1907
		1908	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1909
		1910	Memory-maps a file (or anonymous memory range) and attaches it to the
		1911	given C<$scalar>, which will act like a string scalar.
		1912
		1913	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1914	change the string length, and most read-only operations such as copying it
		1915	or searching it with regexes and so on.
		1916
		1917	Anything else is unsafe and will, at best, result in memory leaks.
		1918
		1919	The memory map associated with the C<$scalar> is automatically removed
		1920	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1921	C<IO::AIO::munmap> functions are called.
		1922
		1923	This calls the C<mmap>(2) function internally. See your system's manual
		1924	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1925
		1926	The C<$length> must be larger than zero and smaller than the actual
		1927	filesize.
		1928
		1929	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1930	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1931
		1932	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1933	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1934	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1935	(which is set to C<MAP_ANON> if your system only provides this
		1936	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1937	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1938	C<IO::AIO::MAP_NONBLOCK>
		1939
		1940	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1941
		1942	C<$offset> is the offset from the start of the file - it generally must be
		1943	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1944
		1945	Example:
		1946
		1947	use Digest::MD5;
		1948	use IO::AIO;
		1949
		1950	open my $fh, "<verybigfile"
		1951	or die "$!";
		1952
		1953	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1954	or die "verybigfile: $!";
		1955
		1956	my $fast_md5 = md5 $data;
		1957
		1958	=item IO::AIO::munmap $scalar
		1959
		1960	Removes a previous mmap and undefines the C<$scalar>.
		1961
		1962	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1963
		1964	Calls the C<munlock> function, undoing the effects of a previous
		1965	C<aio_mlock> call (see its description for details).
		1966
		1967	=item IO::AIO::munlockall
		1968
		1969	Calls the C<munlockall> function.
		1970
		1971	On systems that do not implement C<munlockall>, this function returns
		1972	ENOSYS, otherwise the return value of C<munlockall>.
		1973
		1974	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		1975
		1976	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		1977	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		1978	should be the file offset.
		1979
		1980	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		1981	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		1982	C<IO::AIO::SPLICE_F_GIFT>.
		1983
		1984	See the C<splice(2)> manpage for details.
		1985
		1986	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		1987
		1988	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		1989	description for C<IO::AIO::splice> above for details.
		1990
		1991	=back
		1992
1304	=cut	1993	=cut
1305		1994
1306	min_parallel 8;	1995	min_parallel 8;
1307		1996
1308	END { flush }	1997	END { flush }
1309		1998
1310	1;	1999	1;
1311		2000
		2001	=head1 EVENT LOOP INTEGRATION
		2002
		2003	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		2004	automatically into many event loops:
		2005
		2006	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		2007	use AnyEvent::AIO;
		2008
		2009	You can also integrate IO::AIO manually into many event loops, here are
		2010	some examples of how to do this:
		2011
		2012	# EV integration
		2013	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		2014
		2015	# Event integration
		2016	Event->io (fd => IO::AIO::poll_fileno,
		2017	poll => 'r',
		2018	cb => \&IO::AIO::poll_cb);
		2019
		2020	# Glib/Gtk2 integration
		2021	add_watch Glib::IO IO::AIO::poll_fileno,
		2022	in => sub { IO::AIO::poll_cb; 1 };
		2023
		2024	# Tk integration
		2025	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		2026	readable => \&IO::AIO::poll_cb);
		2027
		2028	# Danga::Socket integration
		2029	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		2030	\&IO::AIO::poll_cb);
		2031
1312	=head2 FORK BEHAVIOUR	2032	=head2 FORK BEHAVIOUR
1313		2033
1314	This module should do "the right thing" when the process using it forks:	2034	Usage of pthreads in a program changes the semantics of fork
		2035	considerably. Specifically, only async-safe functions can be called after
		2036	fork. Perl doesn't know about this, so in general, you cannot call fork
		2037	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2038	pthreads, so this applies, but many other extensions and (for inexplicable
		2039	reasons) perl itself often is linked against pthreads, so this limitation
		2040	applies to quite a lot of perls.
1315		2041
1316	Before the fork, IO::AIO enters a quiescent state where no requests	2042	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1317	can be added in other threads and no results will be processed. After	2043	only works in the process that loaded it. Forking is fully supported, but
1318	the fork the parent simply leaves the quiescent state and continues	2044	using IO::AIO in the child is not.
1319	request/result processing, while the child frees the request/result queue
1320	(so that the requests started before the fork will only be handled in the
1321	parent). Threads will be started on demand until the limit set in the
1322	parent process has been reached again.
1323		2045
1324	In short: the parent will, after a short pause, continue as if fork had	2046	You might get around by not I<using> IO::AIO before (or after)
1325	not been called, while the child will act as if IO::AIO has not been used	2047	forking. You could also try to call the L<IO::AIO::reinit> function in the
1326	yet.	2048	child:
		2049
		2050	=over 4
		2051
		2052	=item IO::AIO::reinit
		2053
		2054	Abandons all current requests and I/O threads and simply reinitialises all
		2055	data structures. This is not an operation supported by any standards, but
		2056	happens to work on GNU/Linux and some newer BSD systems.
		2057
		2058	The only reasonable use for this function is to call it after forking, if
		2059	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2060	the process will result in undefined behaviour. Calling it at any time
		2061	will also result in any undefined (by POSIX) behaviour.
		2062
		2063	=back
1327		2064
1328	=head2 MEMORY USAGE	2065	=head2 MEMORY USAGE
1329		2066
1330	Per-request usage:	2067	Per-request usage:
1331		2068

Diff Legend

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