ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.86 by root, Sat Oct 28 23:32:29 2006 UTC vs.
Revision 1.192 by root, Fri May 20 00:00:03 2011 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) = @_;	10	my $fh = shift
		11	or die "/etc/passwd: $!";
11	...	12	...
12	};	13	};
13		14
14	aio_unlink "/tmp/file", sub { };	15	aio_unlink "/tmp/file", sub { };
15		16
…		…
25	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
26		27
27	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
28	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
29		30
30	# AnyEvent integration
31	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
32	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
33
34	# Event integration
35	Event->io (fd => IO::AIO::poll_fileno,
36	poll => 'r',
37	cb => \&IO::AIO::poll_cb);
38
39	# Glib/Gtk2 integration
40	add_watch Glib::IO IO::AIO::poll_fileno,
41	in => sub { IO::AIO::poll_cb; 1 };
42
43	# Tk integration
44	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
45	readable => \&IO::AIO::poll_cb);
46
47	# Danga::Socket integration
48	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
49	\&IO::AIO::poll_cb);
50
51	=head1 DESCRIPTION	31	=head1 DESCRIPTION
52		32
53	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
54	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>).
55		36
56	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
57	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
58	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
59	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
61	etc.), but can also be used to easily do operations in parallel that are	42	etc.), but can also be used to easily do operations in parallel that are
62	normally done sequentially, e.g. stat'ing many files, which is much faster	43	normally done sequentially, e.g. stat'ing many files, which is much faster
63	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
64	concurrently.	45	concurrently.
65		46
66	While this works on all types of file descriptors (for example sockets),	47	While most of this works on all types of file descriptors (for
67	using these functions on file descriptors that support nonblocking	48	example sockets), using these functions on file descriptors that
68	operation (again, sockets, pipes etc.) is very inefficient. Use an event	49	support nonblocking operation (again, sockets, pipes etc.) is
69	loop for that (such as the L<Event|Event> module): IO::AIO will naturally	50	very inefficient. Use an event loop for that (such as the L<EV>
70	fit into such an event loop itself.	51	module): IO::AIO will naturally fit into such an event loop itself.
71		52
72	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
73	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
74	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
75	to perl. In the future, this module might make use of the native aio	56	to perl. In the future, this module might make use of the native aio
…		…
77	not well-supported or restricted (GNU/Linux doesn't allow them on normal	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
78	files currently, for example), and they would only support aio_read and	59	files currently, for example), and they would only support aio_read and
79	aio_write, so the remaining functionality would have to be implemented	60	aio_write, so the remaining functionality would have to be implemented
80	using threads anyway.	61	using threads anyway.
81		62
82	Although the module will work with in the presence of other (Perl-)	63	Although the module will work in the presence of other (Perl-) threads,
83	threads, it is currently not reentrant in any way, so use appropriate	64	it is currently not reentrant in any way, so use appropriate locking
84	locking yourself, always call C<poll_cb> from within the same thread, or	65	yourself, always call C<poll_cb> from within the same thread, or never
85	never call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
86		67
87	=head2 EXAMPLE	68	=head2 EXAMPLE
88		69
89	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
90	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
91		72
92	use Fcntl;	73	use Fcntl;
93	use Event;	74	use EV;
94	use IO::AIO;	75	use IO::AIO;
95		76
96	# register the IO::AIO callback with Event	77	# register the IO::AIO callback with EV
97	Event->io (fd => IO::AIO::poll_fileno,	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
98	poll => 'r',
99	cb => \&IO::AIO::poll_cb);
100		79
101	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
102	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
103	my $fh = $_[0]	82	my $fh = shift
104	or die "error while opening: $!";	83	or die "error while opening: $!";
105		84
106	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
107	my $size = -s $fh;	86	my $size = -s $fh;
108		87
…		…
116		95
117	# file contents now in $contents	96	# file contents now in $contents
118	print $contents;	97	print $contents;
119		98
120	# exit event loop and program	99	# exit event loop and program
121	Event::unloop;	100	EV::unloop;
122	};	101	};
123	};	102	};
124		103
125	# possibly queue up other requests, or open GUI windows,	104	# possibly queue up other requests, or open GUI windows,
126	# check for sockets etc. etc.	105	# check for sockets etc. etc.
127		106
128	# process events as long as there are some:	107	# process events as long as there are some:
129	Event::loop;	108	EV::loop;
130		109
131	=head1 REQUEST ANATOMY AND LIFETIME	110	=head1 REQUEST ANATOMY AND LIFETIME
132		111
133	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
134	directly visible to Perl.	113	directly visible to Perl.
…		…
176	Request has reached the end of its lifetime and holds no resources anymore	155	Request has reached the end of its lifetime and holds no resources anymore
177	(except possibly for the Perl object, but its connection to the actual	156	(except possibly for the Perl object, but its connection to the actual
178	aio request is severed and calling its methods will either do nothing or	157	aio request is severed and calling its methods will either do nothing or
179	result in a runtime error).	158	result in a runtime error).
180		159
		160	=back
		161
181	=cut	162	=cut
182		163
183	package IO::AIO;	164	package IO::AIO;
184		165
185	no warnings;	166	use Carp ();
186	use strict 'vars';	167
		168	use common::sense;
187		169
188	use base 'Exporter';	170	use base 'Exporter';
189		171
190	BEGIN {	172	BEGIN {
191	our $VERSION = '2.1';	173	our $VERSION = '3.8';
192		174
193	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	175	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
194	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
195	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	177	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
196	aio_copy aio_group aio_nop aio_mknod);	178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
		179	aio_rename aio_link aio_move aio_copy aio_group
		180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
		181	aio_chmod aio_utime aio_truncate
		182	aio_msync aio_mtouch aio_mlock aio_mlockall
		183	aio_statvfs);
		184
197	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
198	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
199	min_parallel max_parallel max_idle	187	min_parallel max_parallel max_idle idle_timeout
200	nreqs nready npending nthreads	188	nreqs nready npending nthreads
201	max_poll_time max_poll_reqs);	189	max_poll_time max_poll_reqs
		190	sendfile fadvise madvise
		191	mmap munmap munlock munlockall);
		192
		193	push @AIO_REQ, qw(aio_busy); # not exported
202		194
203	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	195	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
204		196
205	require XSLoader;	197	require XSLoader;
206	XSLoader::load ("IO::AIO", $VERSION);	198	XSLoader::load ("IO::AIO", $VERSION);
207	}	199	}
208		200
209	=head1 FUNCTIONS	201	=head1 FUNCTIONS
210		202
		203	=head2 QUICK OVERVIEW
		204
		205	This section simply lists the prototypes of the most important functions
		206	for quick reference. See the following sections for function-by-function
		207	documentation.
		208
		209	aio_open $pathname, $flags, $mode, $callback->($fh)
		210	aio_close $fh, $callback->($status)
		211	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		212	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		213	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		214	aio_readahead $fh,$offset,$length, $callback->($retval)
		215	aio_stat $fh_or_path, $callback->($status)
		216	aio_lstat $fh, $callback->($status)
		217	aio_statvfs $fh_or_path, $callback->($statvfs)
		218	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		219	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		220	aio_truncate $fh_or_path, $offset, $callback->($status)
		221	aio_chmod $fh_or_path, $mode, $callback->($status)
		222	aio_unlink $pathname, $callback->($status)
		223	aio_mknod $path, $mode, $dev, $callback->($status)
		224	aio_link $srcpath, $dstpath, $callback->($status)
		225	aio_symlink $srcpath, $dstpath, $callback->($status)
		226	aio_readlink $path, $callback->($link)
		227	aio_rename $srcpath, $dstpath, $callback->($status)
		228	aio_mkdir $pathname, $mode, $callback->($status)
		229	aio_rmdir $pathname, $callback->($status)
		230	aio_readdir $pathname, $callback->($entries)
		231	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		232	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		233	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		234	aio_load $path, $data, $callback->($status)
		235	aio_copy $srcpath, $dstpath, $callback->($status)
		236	aio_move $srcpath, $dstpath, $callback->($status)
		237	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		238	aio_rmtree $path, $callback->($status)
		239	aio_sync $callback->($status)
		240	aio_fsync $fh, $callback->($status)
		241	aio_fdatasync $fh, $callback->($status)
		242	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		243	aio_pathsync $path, $callback->($status)
		244	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		245	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		246	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		247	aio_mlockall $flags, $callback->($status)
		248	aio_group $callback->(...)
		249	aio_nop $callback->()
		250
		251	$prev_pri = aioreq_pri [$pri]
		252	aioreq_nice $pri_adjust
		253
		254	IO::AIO::poll_wait
		255	IO::AIO::poll_cb
		256	IO::AIO::poll
		257	IO::AIO::flush
		258	IO::AIO::max_poll_reqs $nreqs
		259	IO::AIO::max_poll_time $seconds
		260	IO::AIO::min_parallel $nthreads
		261	IO::AIO::max_parallel $nthreads
		262	IO::AIO::max_idle $nthreads
		263	IO::AIO::idle_timeout $seconds
		264	IO::AIO::max_outstanding $maxreqs
		265	IO::AIO::nreqs
		266	IO::AIO::nready
		267	IO::AIO::npending
		268
		269	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		270	IO::AIO::fadvise $fh, $offset, $len, $advice
		271	IO::AIO::madvise $scalar, $offset, $length, $advice
		272	IO::AIO::mprotect $scalar, $offset, $length, $protect
		273	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		274	IO::AIO::munlockall
		275
211	=head2 AIO FUNCTIONS	276	=head2 AIO REQUEST FUNCTIONS
212		277
213	All the C<aio_*> calls are more or less thin wrappers around the syscall	278	All the C<aio_*> calls are more or less thin wrappers around the syscall
214	with the same name (sans C<aio_>). The arguments are similar or identical,	279	with the same name (sans C<aio_>). The arguments are similar or identical,
215	and they all accept an additional (and optional) C<$callback> argument	280	and they all accept an additional (and optional) C<$callback> argument
216	which must be a code reference. This code reference will get called with	281	which must be a code reference. This code reference will get called with
217	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	282	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
218	perl, which usually delivers "false") as it's sole argument when the given	283	perl, which usually delivers "false") as its sole argument after the given
219	syscall has been executed asynchronously.	284	syscall has been executed asynchronously.
220		285
221	All functions expecting a filehandle keep a copy of the filehandle	286	All functions expecting a filehandle keep a copy of the filehandle
222	internally until the request has finished.	287	internally until the request has finished.
223		288
224	All requests return objects of type L<IO::AIO::REQ> that allow further	289	All functions return request objects of type L<IO::AIO::REQ> that allow
225	manipulation of those requests while they are in-flight.	290	further manipulation of those requests while they are in-flight.
226		291
227	The pathnames you pass to these routines I<must> be absolute and	292	The pathnames you pass to these routines I<must> be absolute and
228	encoded in byte form. The reason for the former is that at the time the	293	encoded as octets. The reason for the former is that at the time the
229	request is being executed, the current working directory could have	294	request is being executed, the current working directory could have
230	changed. Alternatively, you can make sure that you never change the	295	changed. Alternatively, you can make sure that you never change the
231	current working directory.	296	current working directory anywhere in the program and then use relative
		297	paths.
232		298
233	To encode pathnames to byte form, either make sure you either: a)	299	To encode pathnames as octets, either make sure you either: a) always pass
234	always pass in filenames you got from outside (command line, readdir	300	in filenames you got from outside (command line, readdir etc.) without
235	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode	301	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
236	your pathnames to the locale (or other) encoding in effect in the user	302	your pathnames to the locale (or other) encoding in effect in the user
237	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	303	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
238	use something else.	304	use something else to ensure your scalar has the correct contents.
		305
		306	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
		307	handles correctly whether it is set or not.
239		308
240	=over 4	309	=over 4
241		310
242	=item $prev_pri = aioreq_pri [$pri]	311	=item $prev_pri = aioreq_pri [$pri]
243		312
…		…
263	aio_read $_[0], ..., sub {	332	aio_read $_[0], ..., sub {
264	...	333	...
265	};	334	};
266	};	335	};
267		336
		337
268	=item aioreq_nice $pri_adjust	338	=item aioreq_nice $pri_adjust
269		339
270	Similar to C<aioreq_pri>, but subtracts the given value from the current	340	Similar to C<aioreq_pri>, but subtracts the given value from the current
271	priority, so effects are cumulative.	341	priority, so the effect is cumulative.
		342
272		343
273	=item aio_open $pathname, $flags, $mode, $callback->($fh)	344	=item aio_open $pathname, $flags, $mode, $callback->($fh)
274		345
275	Asynchronously open or create a file and call the callback with a newly	346	Asynchronously open or create a file and call the callback with a newly
276	created filehandle for the file.	347	created filehandle for the file.
…		…
282	list. They are the same as used by C<sysopen>.	353	list. They are the same as used by C<sysopen>.
283		354
284	Likewise, C<$mode> specifies the mode of the newly created file, if it	355	Likewise, C<$mode> specifies the mode of the newly created file, if it
285	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	356	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
286	except that it is mandatory (i.e. use C<0> if you don't create new files,	357	except that it is mandatory (i.e. use C<0> if you don't create new files,
287	and C<0666> or C<0777> if you do).	358	and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
		359	by the umask in effect then the request is being executed, so better never
		360	change the umask.
288		361
289	Example:	362	Example:
290		363
291	aio_open "/etc/passwd", O_RDONLY, 0, sub {	364	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
292	if ($_[0]) {	365	if ($_[0]) {
293	print "open successful, fh is $_[0]\n";	366	print "open successful, fh is $_[0]\n";
294	...	367	...
295	} else {	368	} else {
296	die "open failed: $!\n";	369	die "open failed: $!\n";
297	}	370	}
298	};	371	};
299		372
		373
300	=item aio_close $fh, $callback->($status)	374	=item aio_close $fh, $callback->($status)
301		375
302	Asynchronously close a file and call the callback with the result	376	Asynchronously close a file and call the callback with the result
303	code. I<WARNING:> although accepted, you should not pass in a perl	377	code.
304	filehandle here, as perl will likely close the file descriptor another
305	time when the filehandle is destroyed. Normally, you can safely call perls
306	C<close> or just let filehandles go out of scope.
307		378
308	This is supposed to be a bug in the API, so that might change. It's	379	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
309	therefore best to avoid this function.	380	closing the file descriptor associated with the filehandle itself.
		381
		382	Therefore, C<aio_close> will not close the filehandle - instead it will
		383	use dup2 to overwrite the file descriptor with the write-end of a pipe
		384	(the pipe fd will be created on demand and will be cached).
		385
		386	Or in other words: the file descriptor will be closed, but it will not be
		387	free for reuse until the perl filehandle is closed.
		388
		389	=cut
310		390
311	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	391	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
312		392
313	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	393	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
314		394
315	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	395	Reads or writes C<$length> bytes from or to the specified C<$fh> and
316	into the scalar given by C<data> and offset C<dataoffset> and calls the	396	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
317	callback without the actual number of bytes read (or -1 on error, just	397	and calls the callback without the actual number of bytes read (or -1 on
318	like the syscall).	398	error, just like the syscall).
		399
		400	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		401	offset plus the actual number of bytes read.
		402
		403	If C<$offset> is undefined, then the current file descriptor offset will
		404	be used (and updated), otherwise the file descriptor offset will not be
		405	changed by these calls.
		406
		407	If C<$length> is undefined in C<aio_write>, use the remaining length of
		408	C<$data>.
		409
		410	If C<$dataoffset> is less than zero, it will be counted from the end of
		411	C<$data>.
319		412
320	The C<$data> scalar I<MUST NOT> be modified in any way while the request	413	The C<$data> scalar I<MUST NOT> be modified in any way while the request
321	is outstanding. Modifying it can result in segfaults or WW3 (if the	414	is outstanding. Modifying it can result in segfaults or World War III (if
322	necessary/optional hardware is installed).	415	the necessary/optional hardware is installed).
323		416
324	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	417	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
325	offset C<0> within the scalar:	418	offset C<0> within the scalar:
326		419
327	aio_read $fh, 7, 15, $buffer, 0, sub {	420	aio_read $fh, 7, 15, $buffer, 0, sub {
328	$_[0] > 0 or die "read error: $!";	421	$_[0] > 0 or die "read error: $!";
329	print "read $_[0] bytes: <$buffer>\n";	422	print "read $_[0] bytes: <$buffer>\n";
330	};	423	};
		424
331		425
332	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	426	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
333		427
334	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	428	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
335	reading at byte offset C<$in_offset>, and starts writing at the current	429	reading at byte offset C<$in_offset>, and starts writing at the current
336	file offset of C<$out_fh>. Because of that, it is not safe to issue more	430	file offset of C<$out_fh>. Because of that, it is not safe to issue more
337	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	431	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
338	other.	432	other.
339		433
		434	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		435	are written, and there is no way to find out how many bytes have been read
		436	from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of
		437	bytes written to C<$out_fh>. Only if the result value equals C<$length>
		438	one can assume that C<$length> bytes have been read.
		439
		440	Unlike with other C<aio_> functions, it makes a lot of sense to use
		441	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		442	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		443	the socket I/O will be non-blocking. Note, however, that you can run into
		444	a trap where C<aio_sendfile> reads some data with readahead, then fails
		445	to write all data, and when the socket is ready the next time, the data
		446	in the cache is already lost, forcing C<aio_sendfile> to again hit the
		447	disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage
		448	much better.
		449
340	This call tries to make use of a native C<sendfile> syscall to provide	450	This call tries to make use of a native C<sendfile> syscall to provide
341	zero-copy operation. For this to work, C<$out_fh> should refer to a	451	zero-copy operation. For this to work, C<$out_fh> should refer to a
342	socket, and C<$in_fh> should refer to mmap'able file.	452	socket, and C<$in_fh> should refer to an mmap'able file.
343		453
344	If the native sendfile call fails or is not implemented, it will be	454	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		455	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
345	emulated, so you can call C<aio_sendfile> on any type of filehandle	456	it will be emulated, so you can call C<aio_sendfile> on any type of
346	regardless of the limitations of the operating system.	457	filehandle regardless of the limitations of the operating system.
347		458
348	Please note, however, that C<aio_sendfile> can read more bytes from
349	C<$in_fh> than are written, and there is no way to find out how many
350	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
351	provides the number of bytes written to C<$out_fh>. Only if the result
352	value equals C<$length> one can assume that C<$length> bytes have been
353	read.
354		459
355	=item aio_readahead $fh,$offset,$length, $callback->($retval)	460	=item aio_readahead $fh,$offset,$length, $callback->($retval)
356		461
357	C<aio_readahead> populates the page cache with data from a file so that	462	C<aio_readahead> populates the page cache with data from a file so that
358	subsequent reads from that file will not block on disk I/O. The C<$offset>	463	subsequent reads from that file will not block on disk I/O. The C<$offset>
…		…
364	file. The current file offset of the file is left unchanged.	469	file. The current file offset of the file is left unchanged.
365		470
366	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	471	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
367	emulated by simply reading the data, which would have a similar effect.	472	emulated by simply reading the data, which would have a similar effect.
368		473
		474
369	=item aio_stat $fh_or_path, $callback->($status)	475	=item aio_stat $fh_or_path, $callback->($status)
370		476
371	=item aio_lstat $fh, $callback->($status)	477	=item aio_lstat $fh, $callback->($status)
372		478
373	Works like perl's C<stat> or C<lstat> in void context. The callback will	479	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
378	for an explanation.	484	for an explanation.
379		485
380	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	486	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
381	error when stat'ing a large file, the results will be silently truncated	487	error when stat'ing a large file, the results will be silently truncated
382	unless perl itself is compiled with large file support.	488	unless perl itself is compiled with large file support.
		489
		490	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		491	following constants and functions (if not implemented, the constants will
		492	be C<0> and the functions will either C<croak> or fall back on traditional
		493	behaviour).
		494
		495	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		496	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		497	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
383		498
384	Example: Print the length of F</etc/passwd>:	499	Example: Print the length of F</etc/passwd>:
385		500
386	aio_stat "/etc/passwd", sub {	501	aio_stat "/etc/passwd", sub {
387	$_[0] and die "stat failed: $!";	502	$_[0] and die "stat failed: $!";
388	print "size is ", -s _, "\n";	503	print "size is ", -s _, "\n";
389	};	504	};
390		505
		506
		507	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		508
		509	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		510	whether a file handle or path was passed.
		511
		512	On success, the callback is passed a hash reference with the following
		513	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		514	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		515	is passed.
		516
		517	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		518	C<ST_NOSUID>.
		519
		520	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		521	their correct value when available, or to C<0> on systems that do
		522	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		523	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		524	C<ST_NODIRATIME> and C<ST_RELATIME>.
		525
		526	Example: stat C</wd> and dump out the data if successful.
		527
		528	aio_statvfs "/wd", sub {
		529	my $f = $_[0]
		530	or die "statvfs: $!";
		531
		532	use Data::Dumper;
		533	say Dumper $f;
		534	};
		535
		536	# result:
		537	{
		538	bsize => 1024,
		539	bfree => 4333064312,
		540	blocks => 10253828096,
		541	files => 2050765568,
		542	flag => 4096,
		543	favail => 2042092649,
		544	bavail => 4333064312,
		545	ffree => 2042092649,
		546	namemax => 255,
		547	frsize => 1024,
		548	fsid => 1810
		549	}
		550
		551
		552	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		553
		554	Works like perl's C<utime> function (including the special case of $atime
		555	and $mtime being undef). Fractional times are supported if the underlying
		556	syscalls support them.
		557
		558	When called with a pathname, uses utimes(2) if available, otherwise
		559	utime(2). If called on a file descriptor, uses futimes(2) if available,
		560	otherwise returns ENOSYS, so this is not portable.
		561
		562	Examples:
		563
		564	# set atime and mtime to current time (basically touch(1)):
		565	aio_utime "path", undef, undef;
		566	# set atime to current time and mtime to beginning of the epoch:
		567	aio_utime "path", time, undef; # undef==0
		568
		569
		570	=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		571
		572	Works like perl's C<chown> function, except that C<undef> for either $uid
		573	or $gid is being interpreted as "do not change" (but -1 can also be used).
		574
		575	Examples:
		576
		577	# same as "chown root path" in the shell:
		578	aio_chown "path", 0, -1;
		579	# same as above:
		580	aio_chown "path", 0, undef;
		581
		582
		583	=item aio_truncate $fh_or_path, $offset, $callback->($status)
		584
		585	Works like truncate(2) or ftruncate(2).
		586
		587
		588	=item aio_chmod $fh_or_path, $mode, $callback->($status)
		589
		590	Works like perl's C<chmod> function.
		591
		592
391	=item aio_unlink $pathname, $callback->($status)	593	=item aio_unlink $pathname, $callback->($status)
392		594
393	Asynchronously unlink (delete) a file and call the callback with the	595	Asynchronously unlink (delete) a file and call the callback with the
394	result code.	596	result code.
395		597
		598
396	=item aio_mknod $path, $mode, $dev, $callback->($status)	599	=item aio_mknod $path, $mode, $dev, $callback->($status)
397		600
398	[EXPERIMENTAL]	601	[EXPERIMENTAL]
399		602
400	Asynchronously create a device node (or fifo). See mknod(2).	603	Asynchronously create a device node (or fifo). See mknod(2).
401		604
402	The only (POSIX-) portable way of calling this function is:	605	The only (POSIX-) portable way of calling this function is:
403		606
404	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	607	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
		608
		609	See C<aio_stat> for info about some potentially helpful extra constants
		610	and functions.
405		611
406	=item aio_link $srcpath, $dstpath, $callback->($status)	612	=item aio_link $srcpath, $dstpath, $callback->($status)
407		613
408	Asynchronously create a new link to the existing object at C<$srcpath> at	614	Asynchronously create a new link to the existing object at C<$srcpath> at
409	the path C<$dstpath> and call the callback with the result code.	615	the path C<$dstpath> and call the callback with the result code.
410		616
		617
411	=item aio_symlink $srcpath, $dstpath, $callback->($status)	618	=item aio_symlink $srcpath, $dstpath, $callback->($status)
412		619
413	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	620	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
414	the path C<$dstpath> and call the callback with the result code.	621	the path C<$dstpath> and call the callback with the result code.
415		622
		623
		624	=item aio_readlink $path, $callback->($link)
		625
		626	Asynchronously read the symlink specified by C<$path> and pass it to
		627	the callback. If an error occurs, nothing or undef gets passed to the
		628	callback.
		629
		630
416	=item aio_rename $srcpath, $dstpath, $callback->($status)	631	=item aio_rename $srcpath, $dstpath, $callback->($status)
417		632
418	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	633	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
419	rename(2) and call the callback with the result code.	634	rename(2) and call the callback with the result code.
420		635
		636
		637	=item aio_mkdir $pathname, $mode, $callback->($status)
		638
		639	Asynchronously mkdir (create) a directory and call the callback with
		640	the result code. C<$mode> will be modified by the umask at the time the
		641	request is executed, so do not change your umask.
		642
		643
421	=item aio_rmdir $pathname, $callback->($status)	644	=item aio_rmdir $pathname, $callback->($status)
422		645
423	Asynchronously rmdir (delete) a directory and call the callback with the	646	Asynchronously rmdir (delete) a directory and call the callback with the
424	result code.	647	result code.
		648
425		649
426	=item aio_readdir $pathname, $callback->($entries)	650	=item aio_readdir $pathname, $callback->($entries)
427		651
428	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	652	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
429	directory (i.e. opendir + readdir + closedir). The entries will not be	653	directory (i.e. opendir + readdir + closedir). The entries will not be
430	sorted, and will B<NOT> include the C<.> and C<..> entries.	654	sorted, and will B<NOT> include the C<.> and C<..> entries.
431		655
432	The callback a single argument which is either C<undef> or an array-ref	656	The callback is passed a single argument which is either C<undef> or an
433	with the filenames.	657	array-ref with the filenames.
		658
		659
		660	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		661
		662	Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
		663	behaviour and output format. In case of an error, C<$entries> will be
		664	C<undef>.
		665
		666	The flags are a combination of the following constants, ORed together (the
		667	flags will also be passed to the callback, possibly modified):
		668
		669	=over 4
		670
		671	=item IO::AIO::READDIR_DENTS
		672
		673	When this flag is off, then the callback gets an arrayref consisting of
		674	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		675	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		676	entry in more detail.
		677
		678	C<$name> is the name of the entry.
		679
		680	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		681
		682	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		683	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		684	C<IO::AIO::DT_WHT>.
		685
		686	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		687	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		688	scalars are read-only: you can not modify them.
		689
		690	C<$inode> is the inode number (which might not be exact on systems with 64
		691	bit inode numbers and 32 bit perls). This field has unspecified content on
		692	systems that do not deliver the inode information.
		693
		694	=item IO::AIO::READDIR_DIRS_FIRST
		695
		696	When this flag is set, then the names will be returned in an order where
		697	likely directories come first. This is useful when you need to quickly
		698	find directories, or you want to find all directories while avoiding to
		699	stat() each entry.
		700
		701	If the system returns type information in readdir, then this is used
		702	to find directories directly. Otherwise, likely directories are files
		703	beginning with ".", or otherwise files with no dots, of which files with
		704	short names are tried first.
		705
		706	=item IO::AIO::READDIR_STAT_ORDER
		707
		708	When this flag is set, then the names will be returned in an order
		709	suitable for stat()'ing each one. That is, when you plan to stat()
		710	all files in the given directory, then the returned order will likely
		711	be fastest.
		712
		713	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		714	the likely dirs come first, resulting in a less optimal stat order.
		715
		716	=item IO::AIO::READDIR_FOUND_UNKNOWN
		717
		718	This flag should not be set when calling C<aio_readdirx>. Instead, it
		719	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		720	C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
		721	C<$type>'s are known, which can be used to speed up some algorithms.
		722
		723	=back
		724
		725
		726	=item aio_load $path, $data, $callback->($status)
		727
		728	This is a composite request that tries to fully load the given file into
		729	memory. Status is the same as with aio_read.
		730
		731	=cut
		732
		733	sub aio_load($$;$) {
		734	my ($path, undef, $cb) = @_;
		735	my $data = \$_[1];
		736
		737	my $pri = aioreq_pri;
		738	my $grp = aio_group $cb;
		739
		740	aioreq_pri $pri;
		741	add $grp aio_open $path, O_RDONLY, 0, sub {
		742	my $fh = shift
		743	or return $grp->result (-1);
		744
		745	aioreq_pri $pri;
		746	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
		747	$grp->result ($_[0]);
		748	};
		749	};
		750
		751	$grp
		752	}
434		753
435	=item aio_copy $srcpath, $dstpath, $callback->($status)	754	=item aio_copy $srcpath, $dstpath, $callback->($status)
436		755
437	Try to copy the I<file> (directories not supported as either source or	756	Try to copy the I<file> (directories not supported as either source or
438	destination) from C<$srcpath> to C<$dstpath> and call the callback with	757	destination) from C<$srcpath> to C<$dstpath> and call the callback with
439	the C<0> (error) or C<-1> ok.	758	a status of C<0> (ok) or C<-1> (error, see C<$!>).
440		759
441	This is a composite request that it creates the destination file with	760	This is a composite request that creates the destination file with
442	mode 0200 and copies the contents of the source file into it using	761	mode 0200 and copies the contents of the source file into it using
443	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	762	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
444	uid/gid, in that order.	763	uid/gid, in that order.
445		764
446	If an error occurs, the partial destination file will be unlinked, if	765	If an error occurs, the partial destination file will be unlinked, if
…		…
456	my $grp = aio_group $cb;	775	my $grp = aio_group $cb;
457		776
458	aioreq_pri $pri;	777	aioreq_pri $pri;
459	add $grp aio_open $src, O_RDONLY, 0, sub {	778	add $grp aio_open $src, O_RDONLY, 0, sub {
460	if (my $src_fh = $_[0]) {	779	if (my $src_fh = $_[0]) {
461	my @stat = stat $src_fh;	780	my @stat = stat $src_fh; # hmm, might block over nfs?
462		781
463	aioreq_pri $pri;	782	aioreq_pri $pri;
464	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {	783	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
465	if (my $dst_fh = $_[0]) {	784	if (my $dst_fh = $_[0]) {
466	aioreq_pri $pri;	785	aioreq_pri $pri;
467	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	786	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
468	if ($_[0] == $stat[7]) {	787	if ($_[0] == $stat[7]) {
469	$grp->result (0);	788	$grp->result (0);
470	close $src_fh;	789	close $src_fh;
471		790
472	# those should not normally block. should. should.	791	my $ch = sub {
		792	aioreq_pri $pri;
		793	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
		794	aioreq_pri $pri;
		795	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		796	aioreq_pri $pri;
		797	add $grp aio_close $dst_fh;
		798	}
		799	};
		800	};
		801
		802	aioreq_pri $pri;
		803	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		804	if ($_[0] < 0 && $! == ENOSYS) {
		805	aioreq_pri $pri;
473	utime $stat[8], $stat[9], $dst;	806	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
474	chmod $stat[2] & 07777, $dst_fh;	807	} else {
475	chown $stat[4], $stat[5], $dst_fh;	808	$ch->();
		809	}
476	close $dst_fh;	810	};
477	} else {	811	} else {
478	$grp->result (-1);	812	$grp->result (-1);
479	close $src_fh;	813	close $src_fh;
480	close $dst_fh;	814	close $dst_fh;
481		815
…		…
498		832
499	=item aio_move $srcpath, $dstpath, $callback->($status)	833	=item aio_move $srcpath, $dstpath, $callback->($status)
500		834
501	Try to move the I<file> (directories not supported as either source or	835	Try to move the I<file> (directories not supported as either source or
502	destination) from C<$srcpath> to C<$dstpath> and call the callback with	836	destination) from C<$srcpath> to C<$dstpath> and call the callback with
503	the C<0> (error) or C<-1> ok.	837	a status of C<0> (ok) or C<-1> (error, see C<$!>).
504		838
505	This is a composite request that tries to rename(2) the file first. If	839	This is a composite request that tries to rename(2) the file first; if
506	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if	840	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
507	that is successful, unlinking the C<$srcpath>.	841	that is successful, unlinks the C<$srcpath>.
508		842
509	=cut	843	=cut
510		844
511	sub aio_move($$;$) {	845	sub aio_move($$;$) {
512	my ($src, $dst, $cb) = @_;	846	my ($src, $dst, $cb) = @_;
…		…
559		893
560	Implementation notes.	894	Implementation notes.
561		895
562	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	896	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
563		897
		898	If readdir returns file type information, then this is used directly to
		899	find directories.
		900
564	After reading the directory, the modification time, size etc. of the	901	Otherwise, after reading the directory, the modification time, size etc.
565	directory before and after the readdir is checked, and if they match (and	902	of the directory before and after the readdir is checked, and if they
566	isn't the current time), the link count will be used to decide how many	903	match (and isn't the current time), the link count will be used to decide
567	entries are directories (if >= 2). Otherwise, no knowledge of the number	904	how many entries are directories (if >= 2). Otherwise, no knowledge of the
568	of subdirectories will be assumed.	905	number of subdirectories will be assumed.
569		906
570	Then entries will be sorted into likely directories (everything without	907	Then entries will be sorted into likely directories a non-initial dot
571	a non-initial dot currently) and likely non-directories (everything	908	currently) and likely non-directories (see C<aio_readdirx>). Then every
572	else). Then every entry plus an appended C</.> will be C<stat>'ed,	909	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
573	likely directories first. If that succeeds, it assumes that the entry	910	in order of their inode numbers. If that succeeds, it assumes that the
574	is a directory or a symlink to directory (which will be checked	911	entry is a directory or a symlink to directory (which will be checked
575	seperately). This is often faster than stat'ing the entry itself because	912	seperately). This is often faster than stat'ing the entry itself because
576	filesystems might detect the type of the entry without reading the inode	913	filesystems might detect the type of the entry without reading the inode
577	data (e.g. ext2fs filetype feature).	914	data (e.g. ext2fs filetype feature), even on systems that cannot return
		915	the filetype information on readdir.
578		916
579	If the known number of directories (link count - 2) has been reached, the	917	If the known number of directories (link count - 2) has been reached, the
580	rest of the entries is assumed to be non-directories.	918	rest of the entries is assumed to be non-directories.
581		919
582	This only works with certainty on POSIX (= UNIX) filesystems, which	920	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
586	as those tend to return 0 or 1 as link counts, which disables the	924	as those tend to return 0 or 1 as link counts, which disables the
587	directory counting heuristic.	925	directory counting heuristic.
588		926
589	=cut	927	=cut
590		928
591	sub aio_scandir($$$) {	929	sub aio_scandir($$;$) {
592	my ($path, $maxreq, $cb) = @_;	930	my ($path, $maxreq, $cb) = @_;
593		931
594	my $pri = aioreq_pri;	932	my $pri = aioreq_pri;
595		933
596	my $grp = aio_group $cb;	934	my $grp = aio_group $cb;
…		…
604	my $now = time;	942	my $now = time;
605	my $hash1 = join ":", (stat _)[0,1,3,7,9];	943	my $hash1 = join ":", (stat _)[0,1,3,7,9];
606		944
607	# read the directory entries	945	# read the directory entries
608	aioreq_pri $pri;	946	aioreq_pri $pri;
609	add $grp aio_readdir $path, sub {	947	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
610	my $entries = shift	948	my $entries = shift
611	or return $grp->result ();	949	or return $grp->result ();
612		950
613	# stat the dir another time	951	# stat the dir another time
614	aioreq_pri $pri;	952	aioreq_pri $pri;
…		…
620	# take the slow route if anything looks fishy	958	# take the slow route if anything looks fishy
621	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	959	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
622	$ndirs = -1;	960	$ndirs = -1;
623	} else {	961	} else {
624	# if nlink == 2, we are finished	962	# if nlink == 2, we are finished
625	# on non-posix-fs's, we rely on nlink < 2	963	# for non-posix-fs's, we rely on nlink < 2
626	$ndirs = (stat _)[3] - 2	964	$ndirs = (stat _)[3] - 2
627	or return $grp->result ([], $entries);	965	or return $grp->result ([], $entries);
628	}	966	}
629		967
630	# sort into likely dirs and likely nondirs
631	# dirs == files without ".", short entries first
632	$entries = [map $_->[0],
633	sort { $b->[1] cmp $a->[1] }
634	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
635	@$entries];
636
637	my (@dirs, @nondirs);	968	my (@dirs, @nondirs);
638		969
639	my $statgrp = add $grp aio_group sub {	970	my $statgrp = add $grp aio_group sub {
640	$grp->result (\@dirs, \@nondirs);	971	$grp->result (\@dirs, \@nondirs);
641	};	972	};
642		973
643	limit $statgrp $maxreq;	974	limit $statgrp $maxreq;
644	feed $statgrp sub {	975	feed $statgrp sub {
645	return unless @$entries;	976	return unless @$entries;
646	my $entry = pop @$entries;	977	my $entry = shift @$entries;
647		978
648	aioreq_pri $pri;	979	aioreq_pri $pri;
649	add $statgrp aio_stat "$path/$entry/.", sub {	980	add $statgrp aio_stat "$path/$entry/.", sub {
650	if ($_[0] < 0) {	981	if ($_[0] < 0) {
651	push @nondirs, $entry;	982	push @nondirs, $entry;
…		…
672	};	1003	};
673		1004
674	$grp	1005	$grp
675	}	1006	}
676		1007
		1008	=item aio_rmtree $path, $callback->($status)
		1009
		1010	Delete a directory tree starting (and including) C<$path>, return the
		1011	status of the final C<rmdir> only. This is a composite request that
		1012	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
		1013	everything else.
		1014
		1015	=cut
		1016
		1017	sub aio_rmtree;
		1018	sub aio_rmtree($;$) {
		1019	my ($path, $cb) = @_;
		1020
		1021	my $pri = aioreq_pri;
		1022	my $grp = aio_group $cb;
		1023
		1024	aioreq_pri $pri;
		1025	add $grp aio_scandir $path, 0, sub {
		1026	my ($dirs, $nondirs) = @_;
		1027
		1028	my $dirgrp = aio_group sub {
		1029	add $grp aio_rmdir $path, sub {
		1030	$grp->result ($_[0]);
		1031	};
		1032	};
		1033
		1034	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		1035	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		1036
		1037	add $grp $dirgrp;
		1038	};
		1039
		1040	$grp
		1041	}
		1042
		1043	=item aio_sync $callback->($status)
		1044
		1045	Asynchronously call sync and call the callback when finished.
		1046
677	=item aio_fsync $fh, $callback->($status)	1047	=item aio_fsync $fh, $callback->($status)
678		1048
679	Asynchronously call fsync on the given filehandle and call the callback	1049	Asynchronously call fsync on the given filehandle and call the callback
680	with the fsync result code.	1050	with the fsync result code.
681		1051
…		…
684	Asynchronously call fdatasync on the given filehandle and call the	1054	Asynchronously call fdatasync on the given filehandle and call the
685	callback with the fdatasync result code.	1055	callback with the fdatasync result code.
686		1056
687	If this call isn't available because your OS lacks it or it couldn't be	1057	If this call isn't available because your OS lacks it or it couldn't be
688	detected, it will be emulated by calling C<fsync> instead.	1058	detected, it will be emulated by calling C<fsync> instead.
		1059
		1060	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		1061
		1062	Sync the data portion of the file specified by C<$offset> and C<$length>
		1063	to disk (but NOT the metadata), by calling the Linux-specific
		1064	sync_file_range call. If sync_file_range is not available or it returns
		1065	ENOSYS, then fdatasync or fsync is being substituted.
		1066
		1067	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		1068	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		1069	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		1070	manpage for details.
		1071
		1072	=item aio_pathsync $path, $callback->($status)
		1073
		1074	This request tries to open, fsync and close the given path. This is a
		1075	composite request intended to sync directories after directory operations
		1076	(E.g. rename). This might not work on all operating systems or have any
		1077	specific effect, but usually it makes sure that directory changes get
		1078	written to disc. It works for anything that can be opened for read-only,
		1079	not just directories.
		1080
		1081	Future versions of this function might fall back to other methods when
		1082	C<fsync> on the directory fails (such as calling C<sync>).
		1083
		1084	Passes C<0> when everything went ok, and C<-1> on error.
		1085
		1086	=cut
		1087
		1088	sub aio_pathsync($;$) {
		1089	my ($path, $cb) = @_;
		1090
		1091	my $pri = aioreq_pri;
		1092	my $grp = aio_group $cb;
		1093
		1094	aioreq_pri $pri;
		1095	add $grp aio_open $path, O_RDONLY, 0, sub {
		1096	my ($fh) = @_;
		1097	if ($fh) {
		1098	aioreq_pri $pri;
		1099	add $grp aio_fsync $fh, sub {
		1100	$grp->result ($_[0]);
		1101
		1102	aioreq_pri $pri;
		1103	add $grp aio_close $fh;
		1104	};
		1105	} else {
		1106	$grp->result (-1);
		1107	}
		1108	};
		1109
		1110	$grp
		1111	}
		1112
		1113	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1114
		1115	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1116	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1117	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1118	scalar must only be modified in-place while an aio operation is pending on
		1119	it).
		1120
		1121	It calls the C<msync> function of your OS, if available, with the memory
		1122	area starting at C<$offset> in the string and ending C<$length> bytes
		1123	later. If C<$length> is negative, counts from the end, and if C<$length>
		1124	is C<undef>, then it goes till the end of the string. The flags can be
		1125	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1126	C<IO::AIO::MS_SYNC>.
		1127
		1128	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1129
		1130	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1131	scalars.
		1132
		1133	It touches (reads or writes) all memory pages in the specified
		1134	range inside the scalar. All caveats and parameters are the same
		1135	as for C<aio_msync>, above, except for flags, which must be either
		1136	C<0> (which reads all pages and ensures they are instantiated) or
		1137	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1138	writing an octet from it, which dirties the page).
		1139
		1140	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1141
		1142	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1143	scalars.
		1144
		1145	It reads in all the pages of the underlying storage into memory (if any)
		1146	and locks them, so they are not getting swapped/paged out or removed.
		1147
		1148	If C<$length> is undefined, then the scalar will be locked till the end.
		1149
		1150	On systems that do not implement C<mlock>, this function returns C<-1>
		1151	and sets errno to C<ENOSYS>.
		1152
		1153	Note that the corresponding C<munlock> is synchronous and is
		1154	documented under L<MISCELLANEOUS FUNCTIONS>.
		1155
		1156	Example: open a file, mmap and mlock it - both will be undone when
		1157	C<$data> gets destroyed.
		1158
		1159	open my $fh, "<", $path or die "$path: $!";
		1160	my $data;
		1161	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1162	aio_mlock $data; # mlock in background
		1163
		1164	=item aio_mlockall $flags, $callback->($status)
		1165
		1166	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1167	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1168
		1169	On systems that do not implement C<mlockall>, this function returns C<-1>
		1170	and sets errno to C<ENOSYS>.
		1171
		1172	Note that the corresponding C<munlockall> is synchronous and is
		1173	documented under L<MISCELLANEOUS FUNCTIONS>.
		1174
		1175	Example: asynchronously lock all current and future pages into memory.
		1176
		1177	aio_mlockall IO::AIO::MCL_FUTURE;
689		1178
690	=item aio_group $callback->(...)	1179	=item aio_group $callback->(...)
691		1180
692	This is a very special aio request: Instead of doing something, it is a	1181	This is a very special aio request: Instead of doing something, it is a
693	container for other aio requests, which is useful if you want to bundle	1182	container for other aio requests, which is useful if you want to bundle
…		…
743	=item cancel $req	1232	=item cancel $req
744		1233
745	Cancels the request, if possible. Has the effect of skipping execution	1234	Cancels the request, if possible. Has the effect of skipping execution
746	when entering the B<execute> state and skipping calling the callback when	1235	when entering the B<execute> state and skipping calling the callback when
747	entering the the B<result> state, but will leave the request otherwise	1236	entering the the B<result> state, but will leave the request otherwise
748	untouched. That means that requests that currently execute will not be	1237	untouched (with the exception of readdir). That means that requests that
749	stopped and resources held by the request will not be freed prematurely.	1238	currently execute will not be stopped and resources held by the request
		1239	will not be freed prematurely.
750		1240
751	=item cb $req $callback->(...)	1241	=item cb $req $callback->(...)
752		1242
753	Replace (or simply set) the callback registered to the request.	1243	Replace (or simply set) the callback registered to the request.
754		1244
…		…
805	Their lifetime, simplified, looks like this: when they are empty, they	1295	Their lifetime, simplified, looks like this: when they are empty, they
806	will finish very quickly. If they contain only requests that are in the	1296	will finish very quickly. If they contain only requests that are in the
807	C<done> state, they will also finish. Otherwise they will continue to	1297	C<done> state, they will also finish. Otherwise they will continue to
808	exist.	1298	exist.
809		1299
810	That means after creating a group you have some time to add requests. And	1300	That means after creating a group you have some time to add requests
811	in the callbacks of those requests, you can add further requests to the	1301	(precisely before the callback has been invoked, which is only done within
812	group. And only when all those requests have finished will the the group	1302	the C<poll_cb>). And in the callbacks of those requests, you can add
813	itself finish.	1303	further requests to the group. And only when all those requests have
		1304	finished will the the group itself finish.
814		1305
815	=over 4	1306	=over 4
816		1307
817	=item add $grp ...	1308	=item add $grp ...
818		1309
…		…
827	=item $grp->cancel_subs	1318	=item $grp->cancel_subs
828		1319
829	Cancel all subrequests and clears any feeder, but not the group request	1320	Cancel all subrequests and clears any feeder, but not the group request
830	itself. Useful when you queued a lot of events but got a result early.	1321	itself. Useful when you queued a lot of events but got a result early.
831		1322
		1323	The group request will finish normally (you cannot add requests to the
		1324	group).
		1325
832	=item $grp->result (...)	1326	=item $grp->result (...)
833		1327
834	Set the result value(s) that will be passed to the group callback when all	1328	Set the result value(s) that will be passed to the group callback when all
835	subrequests have finished and set thre groups errno to the current value	1329	subrequests have finished and set the groups errno to the current value
836	of errno (just like calling C<errno> without an error number). By default,	1330	of errno (just like calling C<errno> without an error number). By default,
837	no argument will be passed and errno is zero.	1331	no argument will be passed and errno is zero.
838		1332
839	=item $grp->errno ([$errno])	1333	=item $grp->errno ([$errno])
840		1334
…		…
851	=item feed $grp $callback->($grp)	1345	=item feed $grp $callback->($grp)
852		1346
853	Sets a feeder/generator on this group: every group can have an attached	1347	Sets a feeder/generator on this group: every group can have an attached
854	generator that generates requests if idle. The idea behind this is that,	1348	generator that generates requests if idle. The idea behind this is that,
855	although you could just queue as many requests as you want in a group,	1349	although you could just queue as many requests as you want in a group,
856	this might starve other requests for a potentially long time. For	1350	this might starve other requests for a potentially long time. For example,
857	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1351	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
858	requests, delaying any later requests for a long time.	1352	delaying any later requests for a long time.
859		1353
860	To avoid this, and allow incremental generation of requests, you can	1354	To avoid this, and allow incremental generation of requests, you can
861	instead a group and set a feeder on it that generates those requests. The	1355	instead a group and set a feeder on it that generates those requests. The
862	feed callback will be called whenever there are few enough (see C<limit>,	1356	feed callback will be called whenever there are few enough (see C<limit>,
863	below) requests active in the group itself and is expected to queue more	1357	below) requests active in the group itself and is expected to queue more
…		…
867	not impose any limits).	1361	not impose any limits).
868		1362
869	If the feed does not queue more requests when called, it will be	1363	If the feed does not queue more requests when called, it will be
870	automatically removed from the group.	1364	automatically removed from the group.
871		1365
872	If the feed limit is C<0>, it will be set to C<2> automatically.	1366	If the feed limit is C<0> when this method is called, it will be set to
		1367	C<2> automatically.
873		1368
874	Example:	1369	Example:
875		1370
876	# stat all files in @files, but only ever use four aio requests concurrently:	1371	# stat all files in @files, but only ever use four aio requests concurrently:
877		1372
…		…
889	Sets the feeder limit for the group: The feeder will be called whenever	1384	Sets the feeder limit for the group: The feeder will be called whenever
890	the group contains less than this many requests.	1385	the group contains less than this many requests.
891		1386
892	Setting the limit to C<0> will pause the feeding process.	1387	Setting the limit to C<0> will pause the feeding process.
893		1388
		1389	The default value for the limit is C<0>, but note that setting a feeder
		1390	automatically bumps it up to C<2>.
		1391
894	=back	1392	=back
895		1393
896	=head2 SUPPORT FUNCTIONS	1394	=head2 SUPPORT FUNCTIONS
897		1395
898	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1396	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
…		…
900	=over 4	1398	=over 4
901		1399
902	=item $fileno = IO::AIO::poll_fileno	1400	=item $fileno = IO::AIO::poll_fileno
903		1401
904	Return the I<request result pipe file descriptor>. This filehandle must be	1402	Return the I<request result pipe file descriptor>. This filehandle must be
905	polled for reading by some mechanism outside this module (e.g. Event or	1403	polled for reading by some mechanism outside this module (e.g. EV, Glib,
906	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1404	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
907	to call C<poll_cb> to check the results.	1405	you have to call C<poll_cb> to check the results.
908		1406
909	See C<poll_cb> for an example.	1407	See C<poll_cb> for an example.
910		1408
911	=item IO::AIO::poll_cb	1409	=item IO::AIO::poll_cb
912		1410
913	Process some outstanding events on the result pipe. You have to call this	1411	Process some outstanding events on the result pipe. You have to call
914	regularly. Returns the number of events processed. Returns immediately	1412	this regularly. Returns C<0> if all events could be processed (or there
915	when no events are outstanding. The amount of events processed depends on	1413	were no events to process), or C<-1> if it returned earlier for whatever
916	the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1414	reason. Returns immediately when no events are outstanding. The amount of
		1415	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1416	C<IO::AIO::max_poll_time>.
917		1417
918	If not all requests were processed for whatever reason, the filehandle	1418	If not all requests were processed for whatever reason, the filehandle
919	will still be ready when C<poll_cb> returns.	1419	will still be ready when C<poll_cb> returns, so normally you don't have to
		1420	do anything special to have it called later.
		1421
		1422	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1423	ready, it can be beneficial to call this function from loops which submit
		1424	a lot of requests, to make sure the results get processed when they become
		1425	available and not just when the loop is finished and the event loop takes
		1426	over again. This function returns very fast when there are no outstanding
		1427	requests.
920		1428
921	Example: Install an Event watcher that automatically calls	1429	Example: Install an Event watcher that automatically calls
922	IO::AIO::poll_cb with high priority:	1430	IO::AIO::poll_cb with high priority (more examples can be found in the
		1431	SYNOPSIS section, at the top of this document):
923		1432
924	Event->io (fd => IO::AIO::poll_fileno,	1433	Event->io (fd => IO::AIO::poll_fileno,
925	poll => 'r', async => 1,	1434	poll => 'r', async => 1,
926	cb => \&IO::AIO::poll_cb);	1435	cb => \&IO::AIO::poll_cb);
		1436
		1437	=item IO::AIO::poll_wait
		1438
		1439	If there are any outstanding requests and none of them in the result
		1440	phase, wait till the result filehandle becomes ready for reading (simply
		1441	does a C<select> on the filehandle. This is useful if you want to
		1442	synchronously wait for some requests to finish).
		1443
		1444	See C<nreqs> for an example.
		1445
		1446	=item IO::AIO::poll
		1447
		1448	Waits until some requests have been handled.
		1449
		1450	Returns the number of requests processed, but is otherwise strictly
		1451	equivalent to:
		1452
		1453	IO::AIO::poll_wait, IO::AIO::poll_cb
		1454
		1455	=item IO::AIO::flush
		1456
		1457	Wait till all outstanding AIO requests have been handled.
		1458
		1459	Strictly equivalent to:
		1460
		1461	IO::AIO::poll_wait, IO::AIO::poll_cb
		1462	while IO::AIO::nreqs;
927		1463
928	=item IO::AIO::max_poll_reqs $nreqs	1464	=item IO::AIO::max_poll_reqs $nreqs
929		1465
930	=item IO::AIO::max_poll_time $seconds	1466	=item IO::AIO::max_poll_time $seconds
931		1467
…		…
933	that are being processed by C<IO::AIO::poll_cb> in one call, respectively	1469	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
934	the maximum amount of time (default C<0>, meaning infinity) spent in	1470	the maximum amount of time (default C<0>, meaning infinity) spent in
935	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount	1471	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
936	of time C<poll_cb> is allowed to use).	1472	of time C<poll_cb> is allowed to use).
937		1473
		1474	Setting C<max_poll_time> to a non-zero value creates an overhead of one
		1475	syscall per request processed, which is not normally a problem unless your
		1476	callbacks are really really fast or your OS is really really slow (I am
		1477	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
		1478
938	Setting these is useful if you want to ensure some level of	1479	Setting these is useful if you want to ensure some level of
939	interactiveness when perl is not fast enough to process all requests in	1480	interactiveness when perl is not fast enough to process all requests in
940	time.	1481	time.
941		1482
942	For interactive programs, values such as C<0.01> to C<0.1> should be fine.	1483	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
943		1484
944	Example: Install an Event watcher that automatically calls	1485	Example: Install an Event watcher that automatically calls
945	IO::AIO::poll_some with low priority, to ensure that other parts of the	1486	IO::AIO::poll_cb with low priority, to ensure that other parts of the
946	program get the CPU sometimes even under high AIO load.	1487	program get the CPU sometimes even under high AIO load.
947		1488
948	# try not to spend much more than 0.1s in poll_cb	1489	# try not to spend much more than 0.1s in poll_cb
949	IO::AIO::max_poll_time 0.1;	1490	IO::AIO::max_poll_time 0.1;
950		1491
951	# use a low priority so other tasks have priority	1492	# use a low priority so other tasks have priority
952	Event->io (fd => IO::AIO::poll_fileno,	1493	Event->io (fd => IO::AIO::poll_fileno,
953	poll => 'r', nice => 1,	1494	poll => 'r', nice => 1,
954	cb => &IO::AIO::poll_cb);	1495	cb => &IO::AIO::poll_cb);
955		1496
956	=item IO::AIO::poll_wait	1497	=back
957
958	Wait till the result filehandle becomes ready for reading (simply does a
959	C<select> on the filehandle. This is useful if you want to synchronously
960	wait for some requests to finish).
961
962	See C<nreqs> for an example.
963
964	=item IO::AIO::poll
965
966	Waits until some requests have been handled.
967
968	Strictly equivalent to:
969
970	IO::AIO::poll_wait, IO::AIO::poll_cb
971	if IO::AIO::nreqs;
972
973	=item IO::AIO::flush
974
975	Wait till all outstanding AIO requests have been handled.
976
977	Strictly equivalent to:
978
979	IO::AIO::poll_wait, IO::AIO::poll_cb
980	while IO::AIO::nreqs;
981		1498
982	=head3 CONTROLLING THE NUMBER OF THREADS	1499	=head3 CONTROLLING THE NUMBER OF THREADS
		1500
		1501	=over
983		1502
984	=item IO::AIO::min_parallel $nthreads	1503	=item IO::AIO::min_parallel $nthreads
985		1504
986	Set the minimum number of AIO threads to C<$nthreads>. The current	1505	Set the minimum number of AIO threads to C<$nthreads>. The current
987	default is C<8>, which means eight asynchronous operations can execute	1506	default is C<8>, which means eight asynchronous operations can execute
…		…
1015		1534
1016	Under normal circumstances you don't need to call this function.	1535	Under normal circumstances you don't need to call this function.
1017		1536
1018	=item IO::AIO::max_idle $nthreads	1537	=item IO::AIO::max_idle $nthreads
1019		1538
1020	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1539	Limit the number of threads (default: 4) that are allowed to idle
1021	threads that did not get a request to process within 10 seconds). That	1540	(i.e., threads that did not get a request to process within the idle
1022	means if a thread becomes idle while C<$nthreads> other threads are also	1541	timeout (default: 10 seconds). That means if a thread becomes idle while
1023	idle, it will free its resources and exit.	1542	C<$nthreads> other threads are also idle, it will free its resources and
		1543	exit.
1024		1544
1025	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1545	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1026	to allow for extremely high load situations, but want to free resources	1546	to allow for extremely high load situations, but want to free resources
1027	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1547	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1028		1548
1029	The default is probably ok in most situations, especially if thread	1549	The default is probably ok in most situations, especially if thread
1030	creation is fast. If thread creation is very slow on your system you might	1550	creation is fast. If thread creation is very slow on your system you might
1031	want to use larger values.	1551	want to use larger values.
1032		1552
		1553	=item IO::AIO::idle_timeout $seconds
		1554
		1555	Sets the minimum idle timeout (default 10) after which worker threads are
		1556	allowed to exit. SEe C<IO::AIO::max_idle>.
		1557
1033	=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs	1558	=item IO::AIO::max_outstanding $maxreqs
1034		1559
1035	This is a very bad function to use in interactive programs because it	1560	This is a very bad function to use in interactive programs because it
1036	blocks, and a bad way to reduce concurrency because it is inexact: Better	1561	blocks, and a bad way to reduce concurrency because it is inexact: Better
1037	use an C<aio_group> together with a feed callback.	1562	use an C<aio_group> together with a feed callback.
1038		1563
1039	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1564	Sets the maximum number of outstanding requests to C<$nreqs>. If you
1040	to queue up more than this number of requests, the next call to the	1565	do queue up more than this number of requests, the next call to the
1041	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)	1566	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1042	function will block until the limit is no longer exceeded.	1567	function will block until the limit is no longer exceeded.
1043		1568
1044	The default value is very large, so there is no practical limit on the	1569	The default value is very large, so there is no practical limit on the
1045	number of outstanding requests.	1570	number of outstanding requests.
1046		1571
1047	You can still queue as many requests as you want. Therefore,	1572	You can still queue as many requests as you want. Therefore,
1048	C<max_oustsanding> is mainly useful in simple scripts (with low values) or	1573	C<max_outstanding> is mainly useful in simple scripts (with low values) or
1049	as a stop gap to shield against fatal memory overflow (with large values).	1574	as a stop gap to shield against fatal memory overflow (with large values).
1050		1575
		1576	=back
		1577
1051	=head3 STATISTICAL INFORMATION	1578	=head3 STATISTICAL INFORMATION
		1579
		1580	=over
1052		1581
1053	=item IO::AIO::nreqs	1582	=item IO::AIO::nreqs
1054		1583
1055	Returns the number of requests currently in the ready, execute or pending	1584	Returns the number of requests currently in the ready, execute or pending
1056	states (i.e. for which their callback has not been invoked yet).	1585	states (i.e. for which their callback has not been invoked yet).
…		…
1070	Returns the number of requests currently in the pending state (executed,	1599	Returns the number of requests currently in the pending state (executed,
1071	but not yet processed by poll_cb).	1600	but not yet processed by poll_cb).
1072		1601
1073	=back	1602	=back
1074		1603
		1604	=head3 MISCELLANEOUS FUNCTIONS
		1605
		1606	IO::AIO implements some functions that might be useful, but are not
		1607	asynchronous.
		1608
		1609	=over 4
		1610
		1611	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1612
		1613	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1614	but is blocking (this makes most sense if you know the input data is
		1615	likely cached already and the output filehandle is set to non-blocking
		1616	operations).
		1617
		1618	Returns the number of bytes copied, or C<-1> on error.
		1619
		1620	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1621
		1622	Simply calls the C<posix_fadvise> function (see its
		1623	manpage for details). The following advice constants are
		1624	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1625	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1626	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1627
		1628	On systems that do not implement C<posix_fadvise>, this function returns
		1629	ENOSYS, otherwise the return value of C<posix_fadvise>.
		1630
		1631	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1632
		1633	Simply calls the C<posix_madvise> function (see its
		1634	manpage for details). The following advice constants are
		1635	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1636	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1637
		1638	On systems that do not implement C<posix_madvise>, this function returns
		1639	ENOSYS, otherwise the return value of C<posix_madvise>.
		1640
		1641	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1642
		1643	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1644	$scalar (see its manpage for details). The following protect
		1645	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1646	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1647
		1648	On systems that do not implement C<mprotect>, this function returns
		1649	ENOSYS, otherwise the return value of C<mprotect>.
		1650
		1651	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1652
		1653	Memory-maps a file (or anonymous memory range) and attaches it to the
		1654	given C<$scalar>, which will act like a string scalar.
		1655
		1656	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1657	change the string length, and most read-only operations such as copying it
		1658	or searching it with regexes and so on.
		1659
		1660	Anything else is unsafe and will, at best, result in memory leaks.
		1661
		1662	The memory map associated with the C<$scalar> is automatically removed
		1663	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1664	C<IO::AIO::munmap> functions are called.
		1665
		1666	This calls the C<mmap>(2) function internally. See your system's manual
		1667	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1668
		1669	The C<$length> must be larger than zero and smaller than the actual
		1670	filesize.
		1671
		1672	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1673	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1674
		1675	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1676	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1677	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1678	(which is set to C<MAP_ANON> if your system only provides this
		1679	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1680	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1681	C<IO::AIO::MAP_NONBLOCK>
		1682
		1683	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1684
		1685	C<$offset> is the offset from the start of the file - it generally must be
		1686	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1687
		1688	Example:
		1689
		1690	use Digest::MD5;
		1691	use IO::AIO;
		1692
		1693	open my $fh, "<verybigfile"
		1694	or die "$!";
		1695
		1696	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1697	or die "verybigfile: $!";
		1698
		1699	my $fast_md5 = md5 $data;
		1700
		1701	=item IO::AIO::munmap $scalar
		1702
		1703	Removes a previous mmap and undefines the C<$scalar>.
		1704
		1705	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1706
		1707	Calls the C<munlock> function, undoing the effects of a previous
		1708	C<aio_mlock> call (see its description for details).
		1709
		1710	=item IO::AIO::munlockall
		1711
		1712	Calls the C<munlockall> function.
		1713
		1714	On systems that do not implement C<munlockall>, this function returns
		1715	ENOSYS, otherwise the return value of C<munlockall>.
		1716
		1717	=back
		1718
1075	=cut	1719	=cut
1076		1720
1077	# support function to convert a fd into a perl filehandle
1078	sub _fd2fh {
1079	return undef if $_[0] < 0;
1080
1081	# try to generate nice filehandles
1082	my $sym = "IO::AIO::fd#$_[0]";
1083	local *$sym;
1084
1085	open *$sym, "+<&=$_[0]" # usually works under any unix
1086	or open *$sym, "<&=$_[0]" # cygwin needs this
1087	or open *$sym, ">&=$_[0]" # or this
1088	or return undef;
1089
1090	*$sym
1091	}
1092
1093	min_parallel 8;	1721	min_parallel 8;
1094		1722
1095	END {	1723	END { flush }
1096	min_parallel 1;
1097	flush;
1098	};
1099		1724
1100	1;	1725	1;
		1726
		1727	=head1 EVENT LOOP INTEGRATION
		1728
		1729	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1730	automatically into many event loops:
		1731
		1732	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1733	use AnyEvent::AIO;
		1734
		1735	You can also integrate IO::AIO manually into many event loops, here are
		1736	some examples of how to do this:
		1737
		1738	# EV integration
		1739	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1740
		1741	# Event integration
		1742	Event->io (fd => IO::AIO::poll_fileno,
		1743	poll => 'r',
		1744	cb => \&IO::AIO::poll_cb);
		1745
		1746	# Glib/Gtk2 integration
		1747	add_watch Glib::IO IO::AIO::poll_fileno,
		1748	in => sub { IO::AIO::poll_cb; 1 };
		1749
		1750	# Tk integration
		1751	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1752	readable => \&IO::AIO::poll_cb);
		1753
		1754	# Danga::Socket integration
		1755	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1756	\&IO::AIO::poll_cb);
1101		1757
1102	=head2 FORK BEHAVIOUR	1758	=head2 FORK BEHAVIOUR
1103		1759
1104	This module should do "the right thing" when the process using it forks:	1760	This module should do "the right thing" when the process using it forks:
1105		1761
…		…
1123	bytes of memory. In addition, stat requests need a stat buffer (possibly	1779	bytes of memory. In addition, stat requests need a stat buffer (possibly
1124	a few hundred bytes), readdir requires a result buffer and so on. Perl	1780	a few hundred bytes), readdir requires a result buffer and so on. Perl
1125	scalars and other data passed into aio requests will also be locked and	1781	scalars and other data passed into aio requests will also be locked and
1126	will consume memory till the request has entered the done state.	1782	will consume memory till the request has entered the done state.
1127		1783
1128	This is now awfully much, so queuing lots of requests is not usually a	1784	This is not awfully much, so queuing lots of requests is not usually a
1129	problem.	1785	problem.
1130		1786
1131	Per-thread usage:	1787	Per-thread usage:
1132		1788
1133	In the execution phase, some aio requests require more memory for	1789	In the execution phase, some aio requests require more memory for
…		…
1138		1794
1139	Known bugs will be fixed in the next release.	1795	Known bugs will be fixed in the next release.
1140		1796
1141	=head1 SEE ALSO	1797	=head1 SEE ALSO
1142		1798
1143	L<Coro::AIO>.	1799	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		1800	more natural syntax.
1144		1801
1145	=head1 AUTHOR	1802	=head1 AUTHOR
1146		1803
1147	Marc Lehmann <schmorp@schmorp.de>	1804	Marc Lehmann <schmorp@schmorp.de>
1148	http://home.schmorp.de/	1805	http://home.schmorp.de/

Diff Legend

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