[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.52 by root, Sat Oct 21 23:06:04 2006 UTC vs.
Revision 1.131 by root, Tue Jul 15 10:42:26 2008 UTC

…		…
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", 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
16	aio_read $fh, 30000, 1024, $buffer, 0, sub {	17	aio_read $fh, 30000, 1024, $buffer, 0, sub {
17	$_[0] > 0 or die "read error: $!";	18	$_[0] > 0 or die "read error: $!";
18	};	19	};
19		20
20	use IO::AIO 2; # version has aio objects	21	# version 2+ has request and group objects
		22	use IO::AIO 2;
21		23
		24	aioreq_pri 4; # give next request a very high priority
22	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
23	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
24		27
25	# AnyEvent	28	my $grp = aio_group sub { print "all stats done\n" };
26	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	29	add $grp aio_stat "..." for ...;
27	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
28		30
29	# Event	31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		32	use AnyEvent::AIO;
		33
		34	# EV integration
		35	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		36
		37	# Event integration
30	Event->io (fd => IO::AIO::poll_fileno,	38	Event->io (fd => IO::AIO::poll_fileno,
31	poll => 'r',	39	poll => 'r',
32	cb => \&IO::AIO::poll_cb);	40	cb => \&IO::AIO::poll_cb);
33		41
34	# Glib/Gtk2	42	# Glib/Gtk2 integration
35	add_watch Glib::IO IO::AIO::poll_fileno,	43	add_watch Glib::IO IO::AIO::poll_fileno,
36	in => sub { IO::AIO::poll_cb; 1 };	44	in => sub { IO::AIO::poll_cb; 1 };
37		45
38	# Tk	46	# Tk integration
39	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",	47	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
40	readable => \&IO::AIO::poll_cb);	48	readable => \&IO::AIO::poll_cb);
41		49
42	# Danga::Socket	50	# Danga::Socket integration
43	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>	51	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
44	\&IO::AIO::poll_cb);	52	\&IO::AIO::poll_cb);
45		53
46
47	=head1 DESCRIPTION	54	=head1 DESCRIPTION
48		55
49	This module implements asynchronous I/O using whatever means your	56	This module implements asynchronous I/O using whatever means your
50	operating system supports.	57	operating system supports.
51		58
		59	Asynchronous means that operations that can normally block your program
		60	(e.g. reading from disk) will be done asynchronously: the operation
		61	will still block, but you can do something else in the meantime. This
		62	is extremely useful for programs that need to stay interactive even
		63	when doing heavy I/O (GUI programs, high performance network servers
		64	etc.), but can also be used to easily do operations in parallel that are
		65	normally done sequentially, e.g. stat'ing many files, which is much faster
		66	on a RAID volume or over NFS when you do a number of stat operations
		67	concurrently.
		68
		69	While most of this works on all types of file descriptors (for
		70	example sockets), using these functions on file descriptors that
		71	support nonblocking operation (again, sockets, pipes etc.) is very
		72	inefficient. Use an event loop for that (such as the L<Event\|Event>
		73	module): IO::AIO will naturally fit into such an event loop itself.
		74
52	Currently, a number of threads are started that execute your read/writes	75	In this version, a number of threads are started that execute your
53	and signal their completion. You don't need thread support in your libc or	76	requests and signal their completion. You don't need thread support
54	perl, and the threads created by this module will not be visible to the	77	in perl, and the threads created by this module will not be visible
55	pthreads library. In the future, this module might make use of the native	78	to perl. In the future, this module might make use of the native aio
56	aio functions available on many operating systems. However, they are often	79	functions available on many operating systems. However, they are often
57	not well-supported (Linux doesn't allow them on normal files currently,	80	not well-supported or restricted (GNU/Linux doesn't allow them on normal
58	for example), and they would only support aio_read and aio_write, so the	81	files currently, for example), and they would only support aio_read and
59	remaining functionality would have to be implemented using threads anyway.	82	aio_write, so the remaining functionality would have to be implemented
		83	using threads anyway.
60		84
61	Although the module will work with in the presence of other threads, it is	85	Although the module will work in the presence of other (Perl-) threads,
62	currently not reentrant, so use appropriate locking yourself, always call	86	it is currently not reentrant in any way, so use appropriate locking
63	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other	87	yourself, always call C<poll_cb> from within the same thread, or never
64	C<aio_> functions) recursively.	88	call C<poll_cb> (or other C<aio_> functions) recursively.
		89
		90	=head2 EXAMPLE
		91
		92	This is a simple example that uses the Event module and loads
		93	F</etc/passwd> asynchronously:
		94
		95	use Fcntl;
		96	use Event;
		97	use IO::AIO;
		98
		99	# register the IO::AIO callback with Event
		100	Event->io (fd => IO::AIO::poll_fileno,
		101	poll => 'r',
		102	cb => \&IO::AIO::poll_cb);
		103
		104	# queue the request to open /etc/passwd
		105	aio_open "/etc/passwd", O_RDONLY, 0, sub {
		106	my $fh = shift
		107	or die "error while opening: $!";
		108
		109	# stat'ing filehandles is generally non-blocking
		110	my $size = -s $fh;
		111
		112	# queue a request to read the file
		113	my $contents;
		114	aio_read $fh, 0, $size, $contents, 0, sub {
		115	$_[0] == $size
		116	or die "short read: $!";
		117
		118	close $fh;
		119
		120	# file contents now in $contents
		121	print $contents;
		122
		123	# exit event loop and program
		124	Event::unloop;
		125	};
		126	};
		127
		128	# possibly queue up other requests, or open GUI windows,
		129	# check for sockets etc. etc.
		130
		131	# process events as long as there are some:
		132	Event::loop;
		133
		134	=head1 REQUEST ANATOMY AND LIFETIME
		135
		136	Every C<aio_*> function creates a request. which is a C data structure not
		137	directly visible to Perl.
		138
		139	If called in non-void context, every request function returns a Perl
		140	object representing the request. In void context, nothing is returned,
		141	which saves a bit of memory.
		142
		143	The perl object is a fairly standard ref-to-hash object. The hash contents
		144	are not used by IO::AIO so you are free to store anything you like in it.
		145
		146	During their existance, aio requests travel through the following states,
		147	in order:
		148
		149	=over 4
		150
		151	=item ready
		152
		153	Immediately after a request is created it is put into the ready state,
		154	waiting for a thread to execute it.
		155
		156	=item execute
		157
		158	A thread has accepted the request for processing and is currently
		159	executing it (e.g. blocking in read).
		160
		161	=item pending
		162
		163	The request has been executed and is waiting for result processing.
		164
		165	While request submission and execution is fully asynchronous, result
		166	processing is not and relies on the perl interpreter calling C<poll_cb>
		167	(or another function with the same effect).
		168
		169	=item result
		170
		171	The request results are processed synchronously by C<poll_cb>.
		172
		173	The C<poll_cb> function will process all outstanding aio requests by
		174	calling their callbacks, freeing memory associated with them and managing
		175	any groups they are contained in.
		176
		177	=item done
		178
		179	Request has reached the end of its lifetime and holds no resources anymore
		180	(except possibly for the Perl object, but its connection to the actual
		181	aio request is severed and calling its methods will either do nothing or
		182	result in a runtime error).
		183
		184	=back
65		185
66	=cut	186	=cut
67		187
68	package IO::AIO;	188	package IO::AIO;
		189
		190	use Carp ();
69		191
70	no warnings;	192	no warnings;
71	use strict 'vars';	193	use strict 'vars';
72		194
73	use base 'Exporter';	195	use base 'Exporter';
74		196
75	BEGIN {	197	BEGIN {
76	our $VERSION = '1.8';	198	our $VERSION = '3.06';
77		199
78	our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	200	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
79	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	201	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
80	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move);	202	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
81	our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);	203	aio_fdatasync aio_pathsync aio_readahead
		204	aio_rename aio_link aio_move aio_copy aio_group
		205	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
		206	aio_chmod aio_utime aio_truncate);
		207
		208	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
		209	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
		210	min_parallel max_parallel max_idle
		211	nreqs nready npending nthreads
		212	max_poll_time max_poll_reqs);
		213
		214	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
82		215
83	require XSLoader;	216	require XSLoader;
84	XSLoader::load ("IO::AIO", $VERSION);	217	XSLoader::load ("IO::AIO", $VERSION);
85	}	218	}
86		219
87	=head1 FUNCTIONS	220	=head1 FUNCTIONS
88		221
89	=head2 AIO FUNCTIONS	222	=head2 AIO REQUEST FUNCTIONS
90		223
91	All the C<aio_*> calls are more or less thin wrappers around the syscall	224	All the C<aio_*> calls are more or less thin wrappers around the syscall
92	with the same name (sans C<aio_>). The arguments are similar or identical,	225	with the same name (sans C<aio_>). The arguments are similar or identical,
93	and they all accept an additional (and optional) C<$callback> argument	226	and they all accept an additional (and optional) C<$callback> argument
94	which must be a code reference. This code reference will get called with	227	which must be a code reference. This code reference will get called with
…		…
97	syscall has been executed asynchronously.	230	syscall has been executed asynchronously.
98		231
99	All functions expecting a filehandle keep a copy of the filehandle	232	All functions expecting a filehandle keep a copy of the filehandle
100	internally until the request has finished.	233	internally until the request has finished.
101		234
102	All non-composite requests (requests that are not broken down into
103	multiple requests) return objects of type L<IO::AIO::REQ> that allow	235	All functions return request objects of type L<IO::AIO::REQ> that allow
104	further manipulation of running requests.	236	further manipulation of those requests while they are in-flight.
105		237
106	The pathnames you pass to these routines I<must> be absolute and	238	The pathnames you pass to these routines I<must> be absolute and
107	encoded in byte form. The reason for the former is that at the time the	239	encoded as octets. The reason for the former is that at the time the
108	request is being executed, the current working directory could have	240	request is being executed, the current working directory could have
109	changed. Alternatively, you can make sure that you never change the	241	changed. Alternatively, you can make sure that you never change the
110	current working directory.	242	current working directory anywhere in the program and then use relative
		243	paths.
111		244
112	To encode pathnames to byte form, either make sure you either: a)	245	To encode pathnames as octets, either make sure you either: a) always pass
113	always pass in filenames you got from outside (command line, readdir	246	in filenames you got from outside (command line, readdir etc.) without
114	etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode	247	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
115	your pathnames to the locale (or other) encoding in effect in the user	248	your pathnames to the locale (or other) encoding in effect in the user
116	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	249	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
117	use something else.	250	use something else to ensure your scalar has the correct contents.
		251
		252	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
		253	handles correctly wether it is set or not.
118		254
119	=over 4	255	=over 4
		256
		257	=item $prev_pri = aioreq_pri [$pri]
		258
		259	Returns the priority value that would be used for the next request and, if
		260	C<$pri> is given, sets the priority for the next aio request.
		261
		262	The default priority is C<0>, the minimum and maximum priorities are C<-4>
		263	and C<4>, respectively. Requests with higher priority will be serviced
		264	first.
		265
		266	The priority will be reset to C<0> after each call to one of the C<aio_*>
		267	functions.
		268
		269	Example: open a file with low priority, then read something from it with
		270	higher priority so the read request is serviced before other low priority
		271	open requests (potentially spamming the cache):
		272
		273	aioreq_pri -3;
		274	aio_open ..., sub {
		275	return unless $_[0];
		276
		277	aioreq_pri -2;
		278	aio_read $_[0], ..., sub {
		279	...
		280	};
		281	};
		282
		283
		284	=item aioreq_nice $pri_adjust
		285
		286	Similar to C<aioreq_pri>, but subtracts the given value from the current
		287	priority, so the effect is cumulative.
		288
120		289
121	=item aio_open $pathname, $flags, $mode, $callback->($fh)	290	=item aio_open $pathname, $flags, $mode, $callback->($fh)
122		291
123	Asynchronously open or create a file and call the callback with a newly	292	Asynchronously open or create a file and call the callback with a newly
124	created filehandle for the file.	293	created filehandle for the file.
…		…
130	list. They are the same as used by C<sysopen>.	299	list. They are the same as used by C<sysopen>.
131		300
132	Likewise, C<$mode> specifies the mode of the newly created file, if it	301	Likewise, C<$mode> specifies the mode of the newly created file, if it
133	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	302	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
134	except that it is mandatory (i.e. use C<0> if you don't create new files,	303	except that it is mandatory (i.e. use C<0> if you don't create new files,
135	and C<0666> or C<0777> if you do).	304	and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
		305	by the umask in effect then the request is being executed, so better never
		306	change the umask.
136		307
137	Example:	308	Example:
138		309
139	aio_open "/etc/passwd", O_RDONLY, 0, sub {	310	aio_open "/etc/passwd", O_RDONLY, 0, sub {
140	if ($_[0]) {	311	if ($_[0]) {
…		…
143	} else {	314	} else {
144	die "open failed: $!\n";	315	die "open failed: $!\n";
145	}	316	}
146	};	317	};
147		318
		319
148	=item aio_close $fh, $callback->($status)	320	=item aio_close $fh, $callback->($status)
149		321
150	Asynchronously close a file and call the callback with the result	322	Asynchronously close a file and call the callback with the result
151	code. I<WARNING:> although accepted, you should not pass in a perl	323	code.
152	filehandle here, as perl will likely close the file descriptor another
153	time when the filehandle is destroyed. Normally, you can safely call perls
154	C<close> or just let filehandles go out of scope.
155		324
156	This is supposed to be a bug in the API, so that might change. It's	325	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
157	therefore best to avoid this function.	326	closing the file descriptor associated with the filehandle itself.
		327
		328	Therefore, C<aio_close> will not close the filehandle - instead it will
		329	use dup2 to overwrite the file descriptor with the write-end of a pipe
		330	(the pipe fd will be created on demand and will be cached).
		331
		332	Or in other words: the file descriptor will be closed, but it will not be
		333	free for reuse until the perl filehandle is closed.
		334
		335	=cut
158		336
159	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	337	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
160		338
161	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	339	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
162		340
163	Reads or writes C<length> bytes from the specified C<fh> and C<offset>	341	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
164	into the scalar given by C<data> and offset C<dataoffset> and calls the	342	into the scalar given by C<$data> and offset C<$dataoffset> and calls the
165	callback without the actual number of bytes read (or -1 on error, just	343	callback without the actual number of bytes read (or -1 on error, just
166	like the syscall).	344	like the syscall).
167		345
		346	If C<$offset> is undefined, then the current file descriptor offset will
		347	be used (and updated), otherwise the file descriptor offset will not be
		348	changed by these calls.
		349
		350	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
		351
		352	If C<$dataoffset> is less than zero, it will be counted from the end of
		353	C<$data>.
		354
168	The C<$data> scalar I<MUST NOT> be modified in any way while the request	355	The C<$data> scalar I<MUST NOT> be modified in any way while the request
169	is outstanding. Modifying it can result in segfaults or WW3 (if the	356	is outstanding. Modifying it can result in segfaults or World War III (if
170	necessary/optional hardware is installed).	357	the necessary/optional hardware is installed).
171		358
172	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	359	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
173	offset C<0> within the scalar:	360	offset C<0> within the scalar:
174		361
175	aio_read $fh, 7, 15, $buffer, 0, sub {	362	aio_read $fh, 7, 15, $buffer, 0, sub {
176	$_[0] > 0 or die "read error: $!";	363	$_[0] > 0 or die "read error: $!";
177	print "read $_[0] bytes: <$buffer>\n";	364	print "read $_[0] bytes: <$buffer>\n";
178	};	365	};
179		366
180	=item aio_move $srcpath, $dstpath, $callback->($status)
181
182	Try to move the I<file> (directories not supported as either source or
183	destination) from C<$srcpath> to C<$dstpath> and call the callback with
184	the C<0> (error) or C<-1> ok.
185
186	This is a composite request that tries to rename(2) the file first. If
187	rename files with C<EXDEV>, it creates the destination file with mode 0200
188	and copies the contents of the source file into it using C<aio_sendfile>,
189	followed by restoring atime, mtime, access mode and uid/gid, in that
190	order, and unlinking the C<$srcpath>.
191
192	If an error occurs, the partial destination file will be unlinked, if
193	possible, except when setting atime, mtime, access mode and uid/gid, where
194	errors are being ignored.
195
196	=cut
197
198	sub aio_move($$$) {
199	my ($src, $dst, $cb) = @_;
200
201	aio_rename $src, $dst, sub {
202	if ($_[0] && $! == EXDEV) {
203	aio_open $src, O_RDONLY, 0, sub {
204	if (my $src_fh = $_[0]) {
205	my @stat = stat $src_fh;
206
207	aio_open $dst, O_WRONLY, 0200, sub {
208	if (my $dst_fh = $_[0]) {
209	aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
210	close $src_fh;
211
212	if ($_[0] == $stat[7]) {
213	utime $stat[8], $stat[9], $dst;
214	chmod $stat[2] & 07777, $dst_fh;
215	chown $stat[4], $stat[5], $dst_fh;
216	close $dst_fh;
217
218	aio_unlink $src, sub {
219	$cb->($_[0]);
220	};
221	} else {
222	my $errno = $!;
223	aio_unlink $dst, sub {
224	$! = $errno;
225	$cb->(-1);
226	};
227	}
228	};
229	} else {
230	$cb->(-1);
231	}
232	},
233
234	} else {
235	$cb->(-1);
236	}
237	};
238	} else {
239	$cb->($_[0]);
240	}
241	};
242	}
243		367
244	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	368	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
245		369
246	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	370	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
247	reading at byte offset C<$in_offset>, and starts writing at the current	371	reading at byte offset C<$in_offset>, and starts writing at the current
…		…
261	C<$in_fh> than are written, and there is no way to find out how many	385	C<$in_fh> than are written, and there is no way to find out how many
262	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	386	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
263	provides the number of bytes written to C<$out_fh>. Only if the result	387	provides the number of bytes written to C<$out_fh>. Only if the result
264	value equals C<$length> one can assume that C<$length> bytes have been	388	value equals C<$length> one can assume that C<$length> bytes have been
265	read.	389	read.
		390
266		391
267	=item aio_readahead $fh,$offset,$length, $callback->($retval)	392	=item aio_readahead $fh,$offset,$length, $callback->($retval)
268		393
269	C<aio_readahead> populates the page cache with data from a file so that	394	C<aio_readahead> populates the page cache with data from a file so that
270	subsequent reads from that file will not block on disk I/O. The C<$offset>	395	subsequent reads from that file will not block on disk I/O. The C<$offset>
…		…
276	file. The current file offset of the file is left unchanged.	401	file. The current file offset of the file is left unchanged.
277		402
278	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	403	If that syscall doesn't exist (likely if your OS isn't Linux) it will be
279	emulated by simply reading the data, which would have a similar effect.	404	emulated by simply reading the data, which would have a similar effect.
280		405
		406
281	=item aio_stat $fh_or_path, $callback->($status)	407	=item aio_stat $fh_or_path, $callback->($status)
282		408
283	=item aio_lstat $fh, $callback->($status)	409	=item aio_lstat $fh, $callback->($status)
284		410
285	Works like perl's C<stat> or C<lstat> in void context. The callback will	411	Works like perl's C<stat> or C<lstat> in void context. The callback will
…		…
298	aio_stat "/etc/passwd", sub {	424	aio_stat "/etc/passwd", sub {
299	$_[0] and die "stat failed: $!";	425	$_[0] and die "stat failed: $!";
300	print "size is ", -s _, "\n";	426	print "size is ", -s _, "\n";
301	};	427	};
302		428
		429
		430	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		431
		432	Works like perl's C<utime> function (including the special case of $atime
		433	and $mtime being undef). Fractional times are supported if the underlying
		434	syscalls support them.
		435
		436	When called with a pathname, uses utimes(2) if available, otherwise
		437	utime(2). If called on a file descriptor, uses futimes(2) if available,
		438	otherwise returns ENOSYS, so this is not portable.
		439
		440	Examples:
		441
		442	# set atime and mtime to current time (basically touch(1)):
		443	aio_utime "path", undef, undef;
		444	# set atime to current time and mtime to beginning of the epoch:
		445	aio_utime "path", time, undef; # undef==0
		446
		447
		448	=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		449
		450	Works like perl's C<chown> function, except that C<undef> for either $uid
		451	or $gid is being interpreted as "do not change" (but -1 can also be used).
		452
		453	Examples:
		454
		455	# same as "chown root path" in the shell:
		456	aio_chown "path", 0, -1;
		457	# same as above:
		458	aio_chown "path", 0, undef;
		459
		460
		461	=item aio_truncate $fh_or_path, $offset, $callback->($status)
		462
		463	Works like truncate(2) or ftruncate(2).
		464
		465
		466	=item aio_chmod $fh_or_path, $mode, $callback->($status)
		467
		468	Works like perl's C<chmod> function.
		469
		470
303	=item aio_unlink $pathname, $callback->($status)	471	=item aio_unlink $pathname, $callback->($status)
304		472
305	Asynchronously unlink (delete) a file and call the callback with the	473	Asynchronously unlink (delete) a file and call the callback with the
306	result code.	474	result code.
307		475
		476
		477	=item aio_mknod $path, $mode, $dev, $callback->($status)
		478
		479	[EXPERIMENTAL]
		480
		481	Asynchronously create a device node (or fifo). See mknod(2).
		482
		483	The only (POSIX-) portable way of calling this function is:
		484
		485	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
		486
		487
308	=item aio_link $srcpath, $dstpath, $callback->($status)	488	=item aio_link $srcpath, $dstpath, $callback->($status)
309		489
310	Asynchronously create a new link to the existing object at C<$srcpath> at	490	Asynchronously create a new link to the existing object at C<$srcpath> at
311	the path C<$dstpath> and call the callback with the result code.	491	the path C<$dstpath> and call the callback with the result code.
312		492
		493
313	=item aio_symlink $srcpath, $dstpath, $callback->($status)	494	=item aio_symlink $srcpath, $dstpath, $callback->($status)
314		495
315	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	496	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
316	the path C<$dstpath> and call the callback with the result code.	497	the path C<$dstpath> and call the callback with the result code.
317		498
		499
		500	=item aio_readlink $path, $callback->($link)
		501
		502	Asynchronously read the symlink specified by C<$path> and pass it to
		503	the callback. If an error occurs, nothing or undef gets passed to the
		504	callback.
		505
		506
318	=item aio_rename $srcpath, $dstpath, $callback->($status)	507	=item aio_rename $srcpath, $dstpath, $callback->($status)
319		508
320	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	509	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
321	rename(2) and call the callback with the result code.	510	rename(2) and call the callback with the result code.
322		511
		512
		513	=item aio_mkdir $pathname, $mode, $callback->($status)
		514
		515	Asynchronously mkdir (create) a directory and call the callback with
		516	the result code. C<$mode> will be modified by the umask at the time the
		517	request is executed, so do not change your umask.
		518
		519
323	=item aio_rmdir $pathname, $callback->($status)	520	=item aio_rmdir $pathname, $callback->($status)
324		521
325	Asynchronously rmdir (delete) a directory and call the callback with the	522	Asynchronously rmdir (delete) a directory and call the callback with the
326	result code.	523	result code.
		524
327		525
328	=item aio_readdir $pathname, $callback->($entries)	526	=item aio_readdir $pathname, $callback->($entries)
329		527
330	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	528	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
331	directory (i.e. opendir + readdir + closedir). The entries will not be	529	directory (i.e. opendir + readdir + closedir). The entries will not be
332	sorted, and will B<NOT> include the C<.> and C<..> entries.	530	sorted, and will B<NOT> include the C<.> and C<..> entries.
333		531
334	The callback a single argument which is either C<undef> or an array-ref	532	The callback a single argument which is either C<undef> or an array-ref
335	with the filenames.	533	with the filenames.
336		534
		535
		536	=item aio_load $path, $data, $callback->($status)
		537
		538	This is a composite request that tries to fully load the given file into
		539	memory. Status is the same as with aio_read.
		540
		541	=cut
		542
		543	sub aio_load($$;$) {
		544	my ($path, undef, $cb) = @_;
		545	my $data = \$_[1];
		546
		547	my $pri = aioreq_pri;
		548	my $grp = aio_group $cb;
		549
		550	aioreq_pri $pri;
		551	add $grp aio_open $path, O_RDONLY, 0, sub {
		552	my $fh = shift
		553	or return $grp->result (-1);
		554
		555	aioreq_pri $pri;
		556	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
		557	$grp->result ($_[0]);
		558	};
		559	};
		560
		561	$grp
		562	}
		563
		564	=item aio_copy $srcpath, $dstpath, $callback->($status)
		565
		566	Try to copy the I<file> (directories not supported as either source or
		567	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		568	the C<0> (error) or C<-1> ok.
		569
		570	This is a composite request that it creates the destination file with
		571	mode 0200 and copies the contents of the source file into it using
		572	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
		573	uid/gid, in that order.
		574
		575	If an error occurs, the partial destination file will be unlinked, if
		576	possible, except when setting atime, mtime, access mode and uid/gid, where
		577	errors are being ignored.
		578
		579	=cut
		580
		581	sub aio_copy($$;$) {
		582	my ($src, $dst, $cb) = @_;
		583
		584	my $pri = aioreq_pri;
		585	my $grp = aio_group $cb;
		586
		587	aioreq_pri $pri;
		588	add $grp aio_open $src, O_RDONLY, 0, sub {
		589	if (my $src_fh = $_[0]) {
		590	my @stat = stat $src_fh;
		591
		592	aioreq_pri $pri;
		593	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
		594	if (my $dst_fh = $_[0]) {
		595	aioreq_pri $pri;
		596	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		597	if ($_[0] == $stat[7]) {
		598	$grp->result (0);
		599	close $src_fh;
		600
		601	# those should not normally block. should. should.
		602	utime $stat[8], $stat[9], $dst;
		603	chmod $stat[2] & 07777, $dst_fh;
		604	chown $stat[4], $stat[5], $dst_fh;
		605
		606	aioreq_pri $pri;
		607	add $grp aio_close $dst_fh;
		608	} else {
		609	$grp->result (-1);
		610	close $src_fh;
		611	close $dst_fh;
		612
		613	aioreq $pri;
		614	add $grp aio_unlink $dst;
		615	}
		616	};
		617	} else {
		618	$grp->result (-1);
		619	}
		620	},
		621
		622	} else {
		623	$grp->result (-1);
		624	}
		625	};
		626
		627	$grp
		628	}
		629
		630	=item aio_move $srcpath, $dstpath, $callback->($status)
		631
		632	Try to move the I<file> (directories not supported as either source or
		633	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		634	the C<0> (error) or C<-1> ok.
		635
		636	This is a composite request that tries to rename(2) the file first. If
		637	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
		638	that is successful, unlinking the C<$srcpath>.
		639
		640	=cut
		641
		642	sub aio_move($$;$) {
		643	my ($src, $dst, $cb) = @_;
		644
		645	my $pri = aioreq_pri;
		646	my $grp = aio_group $cb;
		647
		648	aioreq_pri $pri;
		649	add $grp aio_rename $src, $dst, sub {
		650	if ($_[0] && $! == EXDEV) {
		651	aioreq_pri $pri;
		652	add $grp aio_copy $src, $dst, sub {
		653	$grp->result ($_[0]);
		654
		655	if (!$_[0]) {
		656	aioreq_pri $pri;
		657	add $grp aio_unlink $src;
		658	}
		659	};
		660	} else {
		661	$grp->result ($_[0]);
		662	}
		663	};
		664
		665	$grp
		666	}
		667
337	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	668	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
338		669
339	Scans a directory (similar to C<aio_readdir>) but additionally tries to	670	Scans a directory (similar to C<aio_readdir>) but additionally tries to
340	separate the entries of directory C<$path> into two sets of names, ones	671	efficiently separate the entries of directory C<$path> into two sets of
341	you can recurse into (directories or links to them), and ones you cannot	672	names, directories you can recurse into (directories), and ones you cannot
342	recurse into (everything else).	673	recurse into (everything else, including symlinks to directories).
343		674
344	C<aio_scandir> is a composite request that consists of many sub	675	C<aio_scandir> is a composite request that creates of many sub requests_
345	requests. C<$maxreq> specifies the maximum number of outstanding aio	676	C<$maxreq> specifies the maximum number of outstanding aio requests that
346	requests that this function generates. If it is C<< <= 0 >>, then a	677	this function generates. If it is C<< <= 0 >>, then a suitable default
347	suitable default will be chosen (currently 8).	678	will be chosen (currently 4).
348		679
349	On error, the callback is called without arguments, otherwise it receives	680	On error, the callback is called without arguments, otherwise it receives
350	two array-refs with path-relative entry names.	681	two array-refs with path-relative entry names.
351		682
352	Example:	683	Example:
…		…
386	as those tend to return 0 or 1 as link counts, which disables the	717	as those tend to return 0 or 1 as link counts, which disables the
387	directory counting heuristic.	718	directory counting heuristic.
388		719
389	=cut	720	=cut
390		721
391	sub aio_scandir($$$) {	722	sub aio_scandir($$;$) {
392	my ($path, $maxreq, $cb) = @_;	723	my ($path, $maxreq, $cb) = @_;
393		724
		725	my $pri = aioreq_pri;
		726
		727	my $grp = aio_group $cb;
		728
394	$maxreq = 8 if $maxreq <= 0;	729	$maxreq = 4 if $maxreq <= 0;
395		730
396	# stat once	731	# stat once
		732	aioreq_pri $pri;
397	aio_stat $path, sub {	733	add $grp aio_stat $path, sub {
398	return $cb->() if $_[0];	734	return $grp->result () if $_[0];
399	my $now = time;	735	my $now = time;
400	my $hash1 = join ":", (stat _)[0,1,3,7,9];	736	my $hash1 = join ":", (stat _)[0,1,3,7,9];
401		737
402	# read the directory entries	738	# read the directory entries
		739	aioreq_pri $pri;
403	aio_readdir $path, sub {	740	add $grp aio_readdir $path, sub {
404	my $entries = shift	741	my $entries = shift
405	or return $cb->();	742	or return $grp->result ();
406		743
407	# stat the dir another time	744	# stat the dir another time
		745	aioreq_pri $pri;
408	aio_stat $path, sub {	746	add $grp aio_stat $path, sub {
409	my $hash2 = join ":", (stat _)[0,1,3,7,9];	747	my $hash2 = join ":", (stat _)[0,1,3,7,9];
410		748
411	my $ndirs;	749	my $ndirs;
412		750
413	# take the slow route if anything looks fishy	751	# take the slow route if anything looks fishy
…		…
415	$ndirs = -1;	753	$ndirs = -1;
416	} else {	754	} else {
417	# if nlink == 2, we are finished	755	# if nlink == 2, we are finished
418	# on non-posix-fs's, we rely on nlink < 2	756	# on non-posix-fs's, we rely on nlink < 2
419	$ndirs = (stat _)[3] - 2	757	$ndirs = (stat _)[3] - 2
420	or return $cb->([], $entries);	758	or return $grp->result ([], $entries);
421	}	759	}
422		760
423	# sort into likely dirs and likely nondirs	761	# sort into likely dirs and likely nondirs
424	# dirs == files without ".", short entries first	762	# dirs == files without ".", short entries first
425	$entries = [map $_->[0],	763	$entries = [map $_->[0],
…		…
427	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],	765	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
428	@$entries];	766	@$entries];
429		767
430	my (@dirs, @nondirs);	768	my (@dirs, @nondirs);
431		769
432	my ($statcb, $schedcb);	770	my $statgrp = add $grp aio_group sub {
433	my $nreq = 0;	771	$grp->result (\@dirs, \@nondirs);
		772	};
434		773
435	$schedcb = sub {	774	limit $statgrp $maxreq;
436	if (@$entries) {	775	feed $statgrp sub {
437	if ($nreq < $maxreq) {	776	return unless @$entries;
438	my $ent = pop @$entries;	777	my $entry = pop @$entries;
		778
		779	aioreq_pri $pri;
		780	add $statgrp aio_stat "$path/$entry/.", sub {
		781	if ($_[0] < 0) {
		782	push @nondirs, $entry;
		783	} else {
		784	# need to check for real directory
		785	aioreq_pri $pri;
		786	add $statgrp aio_lstat "$path/$entry", sub {
		787	if (-d _) {
		788	push @dirs, $entry;
		789
		790	unless (--$ndirs) {
		791	push @nondirs, @$entries;
		792	feed $statgrp;
		793	}
		794	} else {
		795	push @nondirs, $entry;
		796	}
439	$nreq++;	797	}
440	aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
441	}	798	}
442	} elsif (!$nreq) {
443	# finished
444	undef $statcb;
445	undef $schedcb;
446	$cb->(\@dirs, \@nondirs) if $cb;
447	undef $cb;
448	}	799	};
449	};	800	};
450	$statcb = sub {
451	my ($status, $entry) = @_;
452
453	if ($status < 0) {
454	$nreq--;
455	push @nondirs, $entry;
456	&$schedcb;
457	} else {
458	# need to check for real directory
459	aio_lstat "$path/$entry", sub {
460	$nreq--;
461
462	if (-d _) {
463	push @dirs, $entry;
464
465	if (!--$ndirs) {
466	push @nondirs, @$entries;
467	$entries = [];
468	}
469	} else {
470	push @nondirs, $entry;
471	}
472
473	&$schedcb;
474	}
475	}
476	};
477
478	&$schedcb while @$entries && $nreq < $maxreq;
479	};	801	};
480	};	802	};
481	};	803	};
		804
		805	$grp
482	}	806	}
		807
		808	=item aio_rmtree $path, $callback->($status)
		809
		810	Delete a directory tree starting (and including) C<$path>, return the
		811	status of the final C<rmdir> only. This is a composite request that
		812	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
		813	everything else.
		814
		815	=cut
		816
		817	sub aio_rmtree;
		818	sub aio_rmtree($;$) {
		819	my ($path, $cb) = @_;
		820
		821	my $pri = aioreq_pri;
		822	my $grp = aio_group $cb;
		823
		824	aioreq_pri $pri;
		825	add $grp aio_scandir $path, 0, sub {
		826	my ($dirs, $nondirs) = @_;
		827
		828	my $dirgrp = aio_group sub {
		829	add $grp aio_rmdir $path, sub {
		830	$grp->result ($_[0]);
		831	};
		832	};
		833
		834	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		835	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		836
		837	add $grp $dirgrp;
		838	};
		839
		840	$grp
		841	}
		842
		843	=item aio_sync $callback->($status)
		844
		845	Asynchronously call sync and call the callback when finished.
483		846
484	=item aio_fsync $fh, $callback->($status)	847	=item aio_fsync $fh, $callback->($status)
485		848
486	Asynchronously call fsync on the given filehandle and call the callback	849	Asynchronously call fsync on the given filehandle and call the callback
487	with the fsync result code.	850	with the fsync result code.
…		…
492	callback with the fdatasync result code.	855	callback with the fdatasync result code.
493		856
494	If this call isn't available because your OS lacks it or it couldn't be	857	If this call isn't available because your OS lacks it or it couldn't be
495	detected, it will be emulated by calling C<fsync> instead.	858	detected, it will be emulated by calling C<fsync> instead.
496		859
		860	=item aio_pathsync $path, $callback->($status)
		861
		862	This request tries to open, fsync and close the given path. This is a
		863	composite request intended tosync directories after directory operations
		864	(E.g. rename). This might not work on all operating systems or have any
		865	specific effect, but usually it makes sure that directory changes get
		866	written to disc. It works for anything that can be opened for read-only,
		867	not just directories.
		868
		869	Passes C<0> when everything went ok, and C<-1> on error.
		870
		871	=cut
		872
		873	sub aio_pathsync($;$) {
		874	my ($path, $cb) = @_;
		875
		876	my $pri = aioreq_pri;
		877	my $grp = aio_group $cb;
		878
		879	aioreq_pri $pri;
		880	add $grp aio_open $path, O_RDONLY, 0, sub {
		881	my ($fh) = @_;
		882	if ($fh) {
		883	aioreq_pri $pri;
		884	add $grp aio_fsync $fh, sub {
		885	$grp->result ($_[0]);
		886
		887	aioreq_pri $pri;
		888	add $grp aio_close $fh;
		889	};
		890	} else {
		891	$grp->result (-1);
		892	}
		893	};
		894
		895	$grp
		896	}
		897
		898	=item aio_group $callback->(...)
		899
		900	This is a very special aio request: Instead of doing something, it is a
		901	container for other aio requests, which is useful if you want to bundle
		902	many requests into a single, composite, request with a definite callback
		903	and the ability to cancel the whole request with its subrequests.
		904
		905	Returns an object of class L<IO::AIO::GRP>. See its documentation below
		906	for more info.
		907
		908	Example:
		909
		910	my $grp = aio_group sub {
		911	print "all stats done\n";
		912	};
		913
		914	add $grp
		915	(aio_stat ...),
		916	(aio_stat ...),
		917	...;
		918
		919	=item aio_nop $callback->()
		920
		921	This is a special request - it does nothing in itself and is only used for
		922	side effects, such as when you want to add a dummy request to a group so
		923	that finishing the requests in the group depends on executing the given
		924	code.
		925
		926	While this request does nothing, it still goes through the execution
		927	phase and still requires a worker thread. Thus, the callback will not
		928	be executed immediately but only after other requests in the queue have
		929	entered their execution phase. This can be used to measure request
		930	latency.
		931
		932	=item IO::AIO::aio_busy $fractional_seconds, $callback->() NOT EXPORTED
		933
		934	Mainly used for debugging and benchmarking, this aio request puts one of
		935	the request workers to sleep for the given time.
		936
		937	While it is theoretically handy to have simple I/O scheduling requests
		938	like sleep and file handle readable/writable, the overhead this creates is
		939	immense (it blocks a thread for a long time) so do not use this function
		940	except to put your application under artificial I/O pressure.
		941
497	=back	942	=back
498		943
499	=head2 IO::AIO::CB CLASS	944	=head2 IO::AIO::REQ CLASS
500		945
501	All non-aggregate C<aio_*> functions return an object of this class when	946	All non-aggregate C<aio_*> functions return an object of this class when
502	called in non-void context.	947	called in non-void context.
503		948
504	A request always moves through the following five states in its lifetime,
505	in order: B<ready> (request has been created, but has not been executed
506	yet), B<execute> (request is currently being executed), B<pending>
507	(request has been executed but callback has not been called yet),
508	B<result> (results are being processed synchronously, includes calling the
509	callback) and B<done> (request has reached the end of its lifetime and
510	holds no resources anymore).
511
512	=over 4	949	=over 4
513		950
514	=item $req->cancel	951	=item cancel $req
515		952
516	Cancels the request, if possible. Has the effect of skipping execution	953	Cancels the request, if possible. Has the effect of skipping execution
517	when entering the B<execute> state and skipping calling the callback when	954	when entering the B<execute> state and skipping calling the callback when
518	entering the the B<result> state, but will leave the request otherwise	955	entering the the B<result> state, but will leave the request otherwise
519	untouched. That means that requests that currently execute will not be	956	untouched. That means that requests that currently execute will not be
520	stopped and resources held by the request will not be freed prematurely.	957	stopped and resources held by the request will not be freed prematurely.
521		958
		959	=item cb $req $callback->(...)
		960
		961	Replace (or simply set) the callback registered to the request.
		962
522	=back	963	=back
523		964
		965	=head2 IO::AIO::GRP CLASS
		966
		967	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
		968	objects of this class, too.
		969
		970	A IO::AIO::GRP object is a special request that can contain multiple other
		971	aio requests.
		972
		973	You create one by calling the C<aio_group> constructing function with a
		974	callback that will be called when all contained requests have entered the
		975	C<done> state:
		976
		977	my $grp = aio_group sub {
		978	print "all requests are done\n";
		979	};
		980
		981	You add requests by calling the C<add> method with one or more
		982	C<IO::AIO::REQ> objects:
		983
		984	$grp->add (aio_unlink "...");
		985
		986	add $grp aio_stat "...", sub {
		987	$_[0] or return $grp->result ("error");
		988
		989	# add another request dynamically, if first succeeded
		990	add $grp aio_open "...", sub {
		991	$grp->result ("ok");
		992	};
		993	};
		994
		995	This makes it very easy to create composite requests (see the source of
		996	C<aio_move> for an application) that work and feel like simple requests.
		997
		998	=over 4
		999
		1000	=item * The IO::AIO::GRP objects will be cleaned up during calls to
		1001	C<IO::AIO::poll_cb>, just like any other request.
		1002
		1003	=item * They can be canceled like any other request. Canceling will cancel not
		1004	only the request itself, but also all requests it contains.
		1005
		1006	=item * They can also can also be added to other IO::AIO::GRP objects.
		1007
		1008	=item * You must not add requests to a group from within the group callback (or
		1009	any later time).
		1010
		1011	=back
		1012
		1013	Their lifetime, simplified, looks like this: when they are empty, they
		1014	will finish very quickly. If they contain only requests that are in the
		1015	C<done> state, they will also finish. Otherwise they will continue to
		1016	exist.
		1017
		1018	That means after creating a group you have some time to add requests. And
		1019	in the callbacks of those requests, you can add further requests to the
		1020	group. And only when all those requests have finished will the the group
		1021	itself finish.
		1022
		1023	=over 4
		1024
		1025	=item add $grp ...
		1026
		1027	=item $grp->add (...)
		1028
		1029	Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
		1030	be added, including other groups, as long as you do not create circular
		1031	dependencies.
		1032
		1033	Returns all its arguments.
		1034
		1035	=item $grp->cancel_subs
		1036
		1037	Cancel all subrequests and clears any feeder, but not the group request
		1038	itself. Useful when you queued a lot of events but got a result early.
		1039
		1040	=item $grp->result (...)
		1041
		1042	Set the result value(s) that will be passed to the group callback when all
		1043	subrequests have finished and set the groups errno to the current value
		1044	of errno (just like calling C<errno> without an error number). By default,
		1045	no argument will be passed and errno is zero.
		1046
		1047	=item $grp->errno ([$errno])
		1048
		1049	Sets the group errno value to C<$errno>, or the current value of errno
		1050	when the argument is missing.
		1051
		1052	Every aio request has an associated errno value that is restored when
		1053	the callback is invoked. This method lets you change this value from its
		1054	default (0).
		1055
		1056	Calling C<result> will also set errno, so make sure you either set C<$!>
		1057	before the call to C<result>, or call c<errno> after it.
		1058
		1059	=item feed $grp $callback->($grp)
		1060
		1061	Sets a feeder/generator on this group: every group can have an attached
		1062	generator that generates requests if idle. The idea behind this is that,
		1063	although you could just queue as many requests as you want in a group,
		1064	this might starve other requests for a potentially long time. For
		1065	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
		1066	requests, delaying any later requests for a long time.
		1067
		1068	To avoid this, and allow incremental generation of requests, you can
		1069	instead a group and set a feeder on it that generates those requests. The
		1070	feed callback will be called whenever there are few enough (see C<limit>,
		1071	below) requests active in the group itself and is expected to queue more
		1072	requests.
		1073
		1074	The feed callback can queue as many requests as it likes (i.e. C<add> does
		1075	not impose any limits).
		1076
		1077	If the feed does not queue more requests when called, it will be
		1078	automatically removed from the group.
		1079
		1080	If the feed limit is C<0>, it will be set to C<2> automatically.
		1081
		1082	Example:
		1083
		1084	# stat all files in @files, but only ever use four aio requests concurrently:
		1085
		1086	my $grp = aio_group sub { print "finished\n" };
		1087	limit $grp 4;
		1088	feed $grp sub {
		1089	my $file = pop @files
		1090	or return;
		1091
		1092	add $grp aio_stat $file, sub { ... };
		1093	};
		1094
		1095	=item limit $grp $num
		1096
		1097	Sets the feeder limit for the group: The feeder will be called whenever
		1098	the group contains less than this many requests.
		1099
		1100	Setting the limit to C<0> will pause the feeding process.
		1101
		1102	=back
		1103
524	=head2 SUPPORT FUNCTIONS	1104	=head2 SUPPORT FUNCTIONS
		1105
		1106	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
525		1107
526	=over 4	1108	=over 4
527		1109
528	=item $fileno = IO::AIO::poll_fileno	1110	=item $fileno = IO::AIO::poll_fileno
529		1111
…		…
534		1116
535	See C<poll_cb> for an example.	1117	See C<poll_cb> for an example.
536		1118
537	=item IO::AIO::poll_cb	1119	=item IO::AIO::poll_cb
538		1120
539	Process all outstanding events on the result pipe. You have to call this	1121	Process some outstanding events on the result pipe. You have to call this
540	regularly. Returns the number of events processed. Returns immediately	1122	regularly. Returns C<0> if all events could be processed, or C<-1> if it
541	when no events are outstanding.	1123	returned earlier for whatever reason. Returns immediately when no events
		1124	are outstanding. The amount of events processed depends on the settings of
		1125	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
		1126
		1127	If not all requests were processed for whatever reason, the filehandle
		1128	will still be ready when C<poll_cb> returns, so normally you don't have to
		1129	do anything special to have it called later.
542		1130
543	Example: Install an Event watcher that automatically calls	1131	Example: Install an Event watcher that automatically calls
544	IO::AIO::poll_cb with high priority:	1132	IO::AIO::poll_cb with high priority:
545		1133
546	Event->io (fd => IO::AIO::poll_fileno,	1134	Event->io (fd => IO::AIO::poll_fileno,
547	poll => 'r', async => 1,	1135	poll => 'r', async => 1,
548	cb => \&IO::AIO::poll_cb);	1136	cb => \&IO::AIO::poll_cb);
549		1137
		1138	=item IO::AIO::max_poll_reqs $nreqs
		1139
		1140	=item IO::AIO::max_poll_time $seconds
		1141
		1142	These set the maximum number of requests (default C<0>, meaning infinity)
		1143	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		1144	the maximum amount of time (default C<0>, meaning infinity) spent in
		1145	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		1146	of time C<poll_cb> is allowed to use).
		1147
		1148	Setting C<max_poll_time> to a non-zero value creates an overhead of one
		1149	syscall per request processed, which is not normally a problem unless your
		1150	callbacks are really really fast or your OS is really really slow (I am
		1151	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
		1152
		1153	Setting these is useful if you want to ensure some level of
		1154	interactiveness when perl is not fast enough to process all requests in
		1155	time.
		1156
		1157	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
		1158
		1159	Example: Install an Event watcher that automatically calls
		1160	IO::AIO::poll_cb with low priority, to ensure that other parts of the
		1161	program get the CPU sometimes even under high AIO load.
		1162
		1163	# try not to spend much more than 0.1s in poll_cb
		1164	IO::AIO::max_poll_time 0.1;
		1165
		1166	# use a low priority so other tasks have priority
		1167	Event->io (fd => IO::AIO::poll_fileno,
		1168	poll => 'r', nice => 1,
		1169	cb => &IO::AIO::poll_cb);
		1170
550	=item IO::AIO::poll_wait	1171	=item IO::AIO::poll_wait
551		1172
		1173	If there are any outstanding requests and none of them in the result
552	Wait till the result filehandle becomes ready for reading (simply does a	1174	phase, wait till the result filehandle becomes ready for reading (simply
553	C<select> on the filehandle. This is useful if you want to synchronously wait	1175	does a C<select> on the filehandle. This is useful if you want to
554	for some requests to finish).	1176	synchronously wait for some requests to finish).
555		1177
556	See C<nreqs> for an example.	1178	See C<nreqs> for an example.
557		1179
		1180	=item IO::AIO::poll
		1181
		1182	Waits until some requests have been handled.
		1183
		1184	Returns the number of requests processed, but is otherwise strictly
		1185	equivalent to:
		1186
		1187	IO::AIO::poll_wait, IO::AIO::poll_cb
		1188
558	=item IO::AIO::nreqs	1189	=item IO::AIO::flush
559		1190
560	Returns the number of requests currently outstanding (i.e. for which their	1191	Wait till all outstanding AIO requests have been handled.
561	callback has not been invoked yet).
562		1192
563	Example: wait till there are no outstanding requests anymore:	1193	Strictly equivalent to:
564		1194
565	IO::AIO::poll_wait, IO::AIO::poll_cb	1195	IO::AIO::poll_wait, IO::AIO::poll_cb
566	while IO::AIO::nreqs;	1196	while IO::AIO::nreqs;
567		1197
568	=item IO::AIO::flush	1198	=back
569		1199
570	Wait till all outstanding AIO requests have been handled.	1200	=head3 CONTROLLING THE NUMBER OF THREADS
571		1201
572	Strictly equivalent to:	1202	=over
573
574	IO::AIO::poll_wait, IO::AIO::poll_cb
575	while IO::AIO::nreqs;
576
577	=item IO::AIO::poll
578
579	Waits until some requests have been handled.
580
581	Strictly equivalent to:
582
583	IO::AIO::poll_wait, IO::AIO::poll_cb
584	if IO::AIO::nreqs;
585		1203
586	=item IO::AIO::min_parallel $nthreads	1204	=item IO::AIO::min_parallel $nthreads
587		1205
588	Set the minimum number of AIO threads to C<$nthreads>. The current default	1206	Set the minimum number of AIO threads to C<$nthreads>. The current
589	is C<4>, which means four asynchronous operations can be done at one time	1207	default is C<8>, which means eight asynchronous operations can execute
590	(the number of outstanding operations, however, is unlimited).	1208	concurrently at any one time (the number of outstanding requests,
		1209	however, is unlimited).
591		1210
592	IO::AIO starts threads only on demand, when an AIO request is queued and	1211	IO::AIO starts threads only on demand, when an AIO request is queued and
593	no free thread exists.	1212	no free thread exists. Please note that queueing up a hundred requests can
		1213	create demand for a hundred threads, even if it turns out that everything
		1214	is in the cache and could have been processed faster by a single thread.
594		1215
595	It is recommended to keep the number of threads low, as some Linux	1216	It is recommended to keep the number of threads relatively low, as some
596	kernel versions will scale negatively with the number of threads (higher	1217	Linux kernel versions will scale negatively with the number of threads
597	parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32	1218	(higher parallelity => MUCH higher latency). With current Linux 2.6
598	threads should be fine.	1219	versions, 4-32 threads should be fine.
599		1220
600	Under most circumstances you don't need to call this function, as the	1221	Under most circumstances you don't need to call this function, as the
601	module selects a default that is suitable for low to moderate load.	1222	module selects a default that is suitable for low to moderate load.
602		1223
603	=item IO::AIO::max_parallel $nthreads	1224	=item IO::AIO::max_parallel $nthreads
…		…
612	This module automatically runs C<max_parallel 0> at program end, to ensure	1233	This module automatically runs C<max_parallel 0> at program end, to ensure
613	that all threads are killed and that there are no outstanding requests.	1234	that all threads are killed and that there are no outstanding requests.
614		1235
615	Under normal circumstances you don't need to call this function.	1236	Under normal circumstances you don't need to call this function.
616		1237
		1238	=item IO::AIO::max_idle $nthreads
		1239
		1240	Limit the number of threads (default: 4) that are allowed to idle (i.e.,
		1241	threads that did not get a request to process within 10 seconds). That
		1242	means if a thread becomes idle while C<$nthreads> other threads are also
		1243	idle, it will free its resources and exit.
		1244
		1245	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1246	to allow for extremely high load situations, but want to free resources
		1247	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1248
		1249	The default is probably ok in most situations, especially if thread
		1250	creation is fast. If thread creation is very slow on your system you might
		1251	want to use larger values.
		1252
617	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	1253	=item IO::AIO::max_outstanding $maxreqs
		1254
		1255	This is a very bad function to use in interactive programs because it
		1256	blocks, and a bad way to reduce concurrency because it is inexact: Better
		1257	use an C<aio_group> together with a feed callback.
618		1258
619	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1259	Sets the maximum number of outstanding requests to C<$nreqs>. If you
620	try to queue up more than this number of requests, the caller will block until	1260	do queue up more than this number of requests, the next call to the
621	some requests have been handled.	1261	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
		1262	function will block until the limit is no longer exceeded.
622		1263
623	The default is very large, so normally there is no practical limit. If you	1264	The default value is very large, so there is no practical limit on the
624	queue up many requests in a loop it often improves speed if you set	1265	number of outstanding requests.
625	this to a relatively low number, such as C<100>.
626		1266
627	Under normal circumstances you don't need to call this function.	1267	You can still queue as many requests as you want. Therefore,
		1268	C<max_outstanding> is mainly useful in simple scripts (with low values) or
		1269	as a stop gap to shield against fatal memory overflow (with large values).
628		1270
629	=back	1271	=back
630		1272
		1273	=head3 STATISTICAL INFORMATION
		1274
		1275	=over
		1276
		1277	=item IO::AIO::nreqs
		1278
		1279	Returns the number of requests currently in the ready, execute or pending
		1280	states (i.e. for which their callback has not been invoked yet).
		1281
		1282	Example: wait till there are no outstanding requests anymore:
		1283
		1284	IO::AIO::poll_wait, IO::AIO::poll_cb
		1285	while IO::AIO::nreqs;
		1286
		1287	=item IO::AIO::nready
		1288
		1289	Returns the number of requests currently in the ready state (not yet
		1290	executed).
		1291
		1292	=item IO::AIO::npending
		1293
		1294	Returns the number of requests currently in the pending state (executed,
		1295	but not yet processed by poll_cb).
		1296
		1297	=back
		1298
631	=cut	1299	=cut
632		1300
633	# support function to convert a fd into a perl filehandle
634	sub _fd2fh {
635	return undef if $_[0] < 0;
636
637	# try to generate nice filehandles
638	my $sym = "IO::AIO::fd#$_[0]";
639	local *$sym;
640
641	open *$sym, "+<&=$_[0]" # usually works under any unix
642	or open *$sym, "<&=$_[0]" # cygwin needs this
643	or open *$sym, ">&=$_[0]" # or this
644	or return undef;
645
646	*$sym
647	}
648
649	min_parallel 4;	1301	min_parallel 8;
650		1302
651	END {	1303	END { flush }
652	max_parallel 0;
653	}
654		1304
655	1;	1305	1;
656		1306
657	=head2 FORK BEHAVIOUR	1307	=head2 FORK BEHAVIOUR
658		1308
659	This module should do "the right thing" when the process using it forks:	1309	This module should do "the right thing" when the process using it forks:
660		1310
661	Before the fork, IO::AIO enters a quiescent state where no requests	1311	Before the fork, IO::AIO enters a quiescent state where no requests
662	can be added in other threads and no results will be processed. After	1312	can be added in other threads and no results will be processed. After
663	the fork the parent simply leaves the quiescent state and continues	1313	the fork the parent simply leaves the quiescent state and continues
664	request/result processing, while the child clears the request/result	1314	request/result processing, while the child frees the request/result queue
665	queue (so the requests started before the fork will only be handled in	1315	(so that the requests started before the fork will only be handled in the
666	the parent). Threads will be started on demand until the limit ste in the	1316	parent). Threads will be started on demand until the limit set in the
667	parent process has been reached again.	1317	parent process has been reached again.
668		1318
669	In short: the parent will, after a short pause, continue as if fork had	1319	In short: the parent will, after a short pause, continue as if fork had
670	not been called, while the child will act as if IO::AIO has not been used	1320	not been called, while the child will act as if IO::AIO has not been used
671	yet.	1321	yet.
672		1322
		1323	=head2 MEMORY USAGE
		1324
		1325	Per-request usage:
		1326
		1327	Each aio request uses - depending on your architecture - around 100-200
		1328	bytes of memory. In addition, stat requests need a stat buffer (possibly
		1329	a few hundred bytes), readdir requires a result buffer and so on. Perl
		1330	scalars and other data passed into aio requests will also be locked and
		1331	will consume memory till the request has entered the done state.
		1332
		1333	This is not awfully much, so queuing lots of requests is not usually a
		1334	problem.
		1335
		1336	Per-thread usage:
		1337
		1338	In the execution phase, some aio requests require more memory for
		1339	temporary buffers, and each thread requires a stack and other data
		1340	structures (usually around 16k-128k, depending on the OS).
		1341
		1342	=head1 KNOWN BUGS
		1343
		1344	Known bugs will be fixed in the next release.
		1345
673	=head1 SEE ALSO	1346	=head1 SEE ALSO
674		1347
675	L<Coro>, L<Linux::AIO> (obsolete).	1348	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		1349	more natural syntax.
676		1350
677	=head1 AUTHOR	1351	=head1 AUTHOR
678		1352
679	Marc Lehmann <schmorp@schmorp.de>	1353	Marc Lehmann <schmorp@schmorp.de>
680	http://home.schmorp.de/	1354	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.52 by root, Sat Oct 21 23:06:04 2006 UTC vs. Revision 1.131 by root, Tue Jul 15 10:42:26 2008 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.52 by root, Sat Oct 21 23:06:04 2006 UTC vs.
Revision 1.131 by root, Tue Jul 15 10:42:26 2008 UTC