ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

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

Diff Legend

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