ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

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

Diff Legend

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