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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.67 by root, Tue Oct 24 02:25:16 2006 UTC vs.
Revision 1.141 by root, Wed Oct 22 16:30:49 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
…		…
18	};	19	};
19		20
20	# version 2+ has request and group objects	21	# version 2+ has request and group objects
21	use IO::AIO 2;	22	use IO::AIO 2;
22		23
		24	aioreq_pri 4; # give next request a very high priority
23	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
24	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
25		27
26	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
27	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
28		30
		31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		32	use AnyEvent::AIO;
		33
29	# AnyEvent integration	34	# EV integration
30	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	35	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
31	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
32		36
33	# Event integration	37	# Event integration
34	Event->io (fd => IO::AIO::poll_fileno,	38	Event->io (fd => IO::AIO::poll_fileno,
35	poll => 'r',	39	poll => 'r',
36	cb => \&IO::AIO::poll_cb);	40	cb => \&IO::AIO::poll_cb);
…		…
50	=head1 DESCRIPTION	54	=head1 DESCRIPTION
51		55
52	This module implements asynchronous I/O using whatever means your	56	This module implements asynchronous I/O using whatever means your
53	operating system supports.	57	operating system supports.
54		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
55	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
56	and signal their completion. You don't need thread support in perl, and	76	requests and signal their completion. You don't need thread support
57	the threads created by this module will not be visible to perl. In the	77	in perl, and the threads created by this module will not be visible
58	future, this module might make use of the native aio functions available	78	to perl. In the future, this module might make use of the native aio
59	on many operating systems. However, they are often not well-supported	79	functions available on many operating systems. However, they are often
60	(Linux doesn't allow them on normal files currently, for example),	80	not well-supported or restricted (GNU/Linux doesn't allow them on normal
61	and they would only support aio_read and aio_write, so the remaining	81	files currently, for example), and they would only support aio_read and
62	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.
63		84
64	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,
65	currently not reentrant, so use appropriate locking yourself, always call	86	it is currently not reentrant in any way, so use appropriate locking
66	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
67	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
68		185
69	=cut	186	=cut
70		187
71	package IO::AIO;	188	package IO::AIO;
		189
		190	use Carp ();
72		191
73	no warnings;	192	no warnings;
74	use strict 'vars';	193	use strict 'vars';
75		194
76	use base 'Exporter';	195	use base 'Exporter';
77		196
78	BEGIN {	197	BEGIN {
79	our $VERSION = '2.0';	198	our $VERSION = '3.16';
80		199
81	our @AIO_REQ = 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
82	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	201	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
83	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	202	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
84	aio_group aio_nop);	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
85	our @EXPORT = (@AIO_REQ, qw(aioreq_pri));	208	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
86	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	209	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
87	min_parallel max_parallel max_outstanding nreqs);	210	min_parallel max_parallel max_idle
		211	nreqs nready npending nthreads
		212	max_poll_time max_poll_reqs);
88		213
89	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	214	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
90		215
91	require XSLoader;	216	require XSLoader;
92	XSLoader::load ("IO::AIO", $VERSION);	217	XSLoader::load ("IO::AIO", $VERSION);
93	}	218	}
94		219
95	=head1 FUNCTIONS	220	=head1 FUNCTIONS
96		221
97	=head2 AIO FUNCTIONS	222	=head2 AIO REQUEST FUNCTIONS
98		223
99	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
100	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,
101	and they all accept an additional (and optional) C<$callback> argument	226	and they all accept an additional (and optional) C<$callback> argument
102	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
103	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	228	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
104	perl, which usually delivers "false") as it's sole argument when the given	229	perl, which usually delivers "false") as its sole argument after the given
105	syscall has been executed asynchronously.	230	syscall has been executed asynchronously.
106		231
107	All functions expecting a filehandle keep a copy of the filehandle	232	All functions expecting a filehandle keep a copy of the filehandle
108	internally until the request has finished.	233	internally until the request has finished.
109		234
110	All requests return objects of type L<IO::AIO::REQ> that allow further	235	All functions return request objects of type L<IO::AIO::REQ> that allow
111	manipulation of those requests while they are in-flight.	236	further manipulation of those requests while they are in-flight.
112		237
113	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
114	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
115	request is being executed, the current working directory could have	240	request is being executed, the current working directory could have
116	changed. Alternatively, you can make sure that you never change the	241	changed. Alternatively, you can make sure that you never change the
117	current working directory.	242	current working directory anywhere in the program and then use relative
		243	paths.
118		244
119	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
120	always pass in filenames you got from outside (command line, readdir	246	in filenames you got from outside (command line, readdir etc.) without
121	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
122	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
123	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)
124	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 whether it is set or not.
125		254
126	=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
127		289
128	=item aio_open $pathname, $flags, $mode, $callback->($fh)	290	=item aio_open $pathname, $flags, $mode, $callback->($fh)
129		291
130	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
131	created filehandle for the file.	293	created filehandle for the file.
…		…
137	list. They are the same as used by C<sysopen>.	299	list. They are the same as used by C<sysopen>.
138		300
139	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
140	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>,
141	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,
142	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.
143		307
144	Example:	308	Example:
145		309
146	aio_open "/etc/passwd", O_RDONLY, 0, sub {	310	aio_open "/etc/passwd", O_RDONLY, 0, sub {
147	if ($_[0]) {	311	if ($_[0]) {
…		…
150	} else {	314	} else {
151	die "open failed: $!\n";	315	die "open failed: $!\n";
152	}	316	}
153	};	317	};
154		318
		319
155	=item aio_close $fh, $callback->($status)	320	=item aio_close $fh, $callback->($status)
156		321
157	Asynchronously close a file and call the callback with the result	322	Asynchronously close a file and call the callback with the result
158	code. I<WARNING:> although accepted, you should not pass in a perl	323	code.
159	filehandle here, as perl will likely close the file descriptor another
160	time when the filehandle is destroyed. Normally, you can safely call perls
161	C<close> or just let filehandles go out of scope.
162		324
163	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
164	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
165		336
166	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	337	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
167		338
168	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	339	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
169		340
170	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>
171	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
172	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
173	like the syscall).	344	like the syscall).
174		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
175	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
176	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
177	necessary/optional hardware is installed).	357	the necessary/optional hardware is installed).
178		358
179	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
180	offset C<0> within the scalar:	360	offset C<0> within the scalar:
181		361
182	aio_read $fh, 7, 15, $buffer, 0, sub {	362	aio_read $fh, 7, 15, $buffer, 0, sub {
183	$_[0] > 0 or die "read error: $!";	363	$_[0] > 0 or die "read error: $!";
184	print "read $_[0] bytes: <$buffer>\n";	364	print "read $_[0] bytes: <$buffer>\n";
185	};	365	};
186		366
187	=item aio_move $srcpath, $dstpath, $callback->($status)
188
189	[EXPERIMENTAL due to internal aio_group use]
190
191	Try to move the I<file> (directories not supported as either source or
192	destination) from C<$srcpath> to C<$dstpath> and call the callback with
193	the C<0> (error) or C<-1> ok.
194
195	This is a composite request that tries to rename(2) the file first. If
196	rename files with C<EXDEV>, it creates the destination file with mode 0200
197	and copies the contents of the source file into it using C<aio_sendfile>,
198	followed by restoring atime, mtime, access mode and uid/gid, in that
199	order, and unlinking the C<$srcpath>.
200
201	If an error occurs, the partial destination file will be unlinked, if
202	possible, except when setting atime, mtime, access mode and uid/gid, where
203	errors are being ignored.
204
205	=cut
206
207	sub aio_move($$$) {
208	my ($src, $dst, $cb) = @_;
209
210	my $grp = aio_group $cb;
211
212	add $grp aio_rename $src, $dst, sub {
213	if ($_[0] && $! == EXDEV) {
214	add $grp aio_open $src, O_RDONLY, 0, sub {
215	if (my $src_fh = $_[0]) {
216	my @stat = stat $src_fh;
217
218	add $grp aio_open $dst, O_WRONLY, 0200, sub {
219	if (my $dst_fh = $_[0]) {
220	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
221	close $src_fh;
222
223	if ($_[0] == $stat[7]) {
224	utime $stat[8], $stat[9], $dst;
225	chmod $stat[2] & 07777, $dst_fh;
226	chown $stat[4], $stat[5], $dst_fh;
227	close $dst_fh;
228
229	add $grp aio_unlink $src, sub {
230	$grp->result ($_[0]);
231	};
232	} else {
233	my $errno = $!;
234	add $grp aio_unlink $dst, sub {
235	$! = $errno;
236	$grp->result (-1);
237	};
238	}
239	};
240	} else {
241	$grp->result (-1);
242	}
243	},
244
245	} else {
246	$grp->result (-1);
247	}
248	};
249	} else {
250	$grp->result ($_[0]);
251	}
252	};
253
254	$grp
255	}
256		367
257	=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)
258		369
259	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
260	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
…		…
274	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
275	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
276	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
277	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
278	read.	389	read.
		390
279		391
280	=item aio_readahead $fh,$offset,$length, $callback->($retval)	392	=item aio_readahead $fh,$offset,$length, $callback->($retval)
281		393
282	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
283	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>
…		…
289	file. The current file offset of the file is left unchanged.	401	file. The current file offset of the file is left unchanged.
290		402
291	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
292	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.
293		405
		406
294	=item aio_stat $fh_or_path, $callback->($status)	407	=item aio_stat $fh_or_path, $callback->($status)
295		408
296	=item aio_lstat $fh, $callback->($status)	409	=item aio_lstat $fh, $callback->($status)
297		410
298	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
…		…
311	aio_stat "/etc/passwd", sub {	424	aio_stat "/etc/passwd", sub {
312	$_[0] and die "stat failed: $!";	425	$_[0] and die "stat failed: $!";
313	print "size is ", -s _, "\n";	426	print "size is ", -s _, "\n";
314	};	427	};
315		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
316	=item aio_unlink $pathname, $callback->($status)	471	=item aio_unlink $pathname, $callback->($status)
317		472
318	Asynchronously unlink (delete) a file and call the callback with the	473	Asynchronously unlink (delete) a file and call the callback with the
319	result code.	474	result code.
320		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
321	=item aio_link $srcpath, $dstpath, $callback->($status)	488	=item aio_link $srcpath, $dstpath, $callback->($status)
322		489
323	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
324	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.
325		492
		493
326	=item aio_symlink $srcpath, $dstpath, $callback->($status)	494	=item aio_symlink $srcpath, $dstpath, $callback->($status)
327		495
328	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
329	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.
330		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
331	=item aio_rename $srcpath, $dstpath, $callback->($status)	507	=item aio_rename $srcpath, $dstpath, $callback->($status)
332		508
333	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
334	rename(2) and call the callback with the result code.	510	rename(2) and call the callback with the result code.
335		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
336	=item aio_rmdir $pathname, $callback->($status)	520	=item aio_rmdir $pathname, $callback->($status)
337		521
338	Asynchronously rmdir (delete) a directory and call the callback with the	522	Asynchronously rmdir (delete) a directory and call the callback with the
339	result code.	523	result code.
		524
340		525
341	=item aio_readdir $pathname, $callback->($entries)	526	=item aio_readdir $pathname, $callback->($entries)
342		527
343	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
344	directory (i.e. opendir + readdir + closedir). The entries will not be	529	directory (i.e. opendir + readdir + closedir). The entries will not be
345	sorted, and will B<NOT> include the C<.> and C<..> entries.	530	sorted, and will B<NOT> include the C<.> and C<..> entries.
346		531
347	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
348	with the filenames.	533	with the filenames.
349		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 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 fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
		638	that is successful, unlinks 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
350	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	668	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
351		669
352	[EXPERIMENTAL due to internal aio_group use]
353
354	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
355	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
356	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
357	recurse into (everything else).	673	recurse into (everything else, including symlinks to directories).
358		674
359	C<aio_scandir> is a composite request that creates of many sub requests_	675	C<aio_scandir> is a composite request that creates of many sub requests_
360	C<$maxreq> specifies the maximum number of outstanding aio requests that	676	C<$maxreq> specifies the maximum number of outstanding aio requests that
361	this function generates. If it is C<< <= 0 >>, then a suitable default	677	this function generates. If it is C<< <= 0 >>, then a suitable default
362	will be chosen (currently 6).	678	will be chosen (currently 4).
363		679
364	On error, the callback is called without arguments, otherwise it receives	680	On error, the callback is called without arguments, otherwise it receives
365	two array-refs with path-relative entry names.	681	two array-refs with path-relative entry names.
366		682
367	Example:	683	Example:
…		…
401	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
402	directory counting heuristic.	718	directory counting heuristic.
403		719
404	=cut	720	=cut
405		721
406	sub aio_scandir($$$) {	722	sub aio_scandir($$;$) {
407	my ($path, $maxreq, $cb) = @_;	723	my ($path, $maxreq, $cb) = @_;
408		724
		725	my $pri = aioreq_pri;
		726
409	my $grp = aio_group $cb;	727	my $grp = aio_group $cb;
410		728
411	$maxreq = 6 if $maxreq <= 0;	729	$maxreq = 4 if $maxreq <= 0;
412		730
413	# stat once	731	# stat once
		732	aioreq_pri $pri;
414	add $grp aio_stat $path, sub {	733	add $grp aio_stat $path, sub {
415	return $grp->result () if $_[0];	734	return $grp->result () if $_[0];
416	my $now = time;	735	my $now = time;
417	my $hash1 = join ":", (stat _)[0,1,3,7,9];	736	my $hash1 = join ":", (stat _)[0,1,3,7,9];
418		737
419	# read the directory entries	738	# read the directory entries
		739	aioreq_pri $pri;
420	add $grp aio_readdir $path, sub {	740	add $grp aio_readdir $path, sub {
421	my $entries = shift	741	my $entries = shift
422	or return $grp->result ();	742	or return $grp->result ();
423		743
424	# stat the dir another time	744	# stat the dir another time
		745	aioreq_pri $pri;
425	add $grp aio_stat $path, sub {	746	add $grp aio_stat $path, sub {
426	my $hash2 = join ":", (stat _)[0,1,3,7,9];	747	my $hash2 = join ":", (stat _)[0,1,3,7,9];
427		748
428	my $ndirs;	749	my $ndirs;
429		750
…		…
444	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],	765	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
445	@$entries];	766	@$entries];
446		767
447	my (@dirs, @nondirs);	768	my (@dirs, @nondirs);
448		769
449	my ($statcb, $schedcb);
450	my $nreq = 0;
451
452	my $statgrp = add $grp aio_group;	770	my $statgrp = add $grp aio_group sub {
		771	$grp->result (\@dirs, \@nondirs);
		772	};
453		773
454	$schedcb = sub {	774	limit $statgrp $maxreq;
455	if (@$entries) {	775	feed $statgrp sub {
456	if ($nreq < $maxreq) {	776	return unless @$entries;
457	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	}
458	$nreq++;	797	}
459	add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
460	}	798	}
461	} elsif (!$nreq) {
462	# finished
463	$statgrp->cancel;
464	undef $statcb;
465	undef $schedcb;
466	$grp->result (\@dirs, \@nondirs);
467	}	799	};
468	};	800	};
469	$statcb = sub {
470	my ($status, $entry) = @_;
471
472	if ($status < 0) {
473	$nreq--;
474	push @nondirs, $entry;
475	&$schedcb;
476	} else {
477	# need to check for real directory
478	add $grp aio_lstat "$path/$entry", sub {
479	$nreq--;
480
481	if (-d _) {
482	push @dirs, $entry;
483
484	if (!--$ndirs) {
485	push @nondirs, @$entries;
486	$entries = [];
487	}
488	} else {
489	push @nondirs, $entry;
490	}
491
492	&$schedcb;
493	}
494	}
495	};
496
497	&$schedcb while @$entries && $nreq < $maxreq;
498	};	801	};
499	};	802	};
500	};	803	};
501		804
502	$grp	805	$grp
503	}	806	}
504		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.
		846
505	=item aio_fsync $fh, $callback->($status)	847	=item aio_fsync $fh, $callback->($status)
506		848
507	Asynchronously call fsync on the given filehandle and call the callback	849	Asynchronously call fsync on the given filehandle and call the callback
508	with the fsync result code.	850	with the fsync result code.
509		851
…		…
513	callback with the fdatasync result code.	855	callback with the fdatasync result code.
514		856
515	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
516	detected, it will be emulated by calling C<fsync> instead.	858	detected, it will be emulated by calling C<fsync> instead.
517		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 to sync 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
518	=item aio_group $callback->(...)	898	=item aio_group $callback->(...)
519
520	[EXPERIMENTAL]
521		899
522	This is a very special aio request: Instead of doing something, it is a	900	This is a very special aio request: Instead of doing something, it is a
523	container for other aio requests, which is useful if you want to bundle	901	container for other aio requests, which is useful if you want to bundle
524	many requests into a single, composite, request.	902	many requests into a single, composite, request with a definite callback
		903	and the ability to cancel the whole request with its subrequests.
525		904
526	Returns an object of class L<IO::AIO::GRP>. See its documentation below	905	Returns an object of class L<IO::AIO::GRP>. See its documentation below
527	for more info.	906	for more info.
528		907
529	Example:	908	Example:
…		…
548	phase and still requires a worker thread. Thus, the callback will not	927	phase and still requires a worker thread. Thus, the callback will not
549	be executed immediately but only after other requests in the queue have	928	be executed immediately but only after other requests in the queue have
550	entered their execution phase. This can be used to measure request	929	entered their execution phase. This can be used to measure request
551	latency.	930	latency.
552		931
553	=item IO::AIO::aio_sleep $fractional_seconds, $callback->() NOT EXPORTED	932	=item IO::AIO::aio_busy $fractional_seconds, $callback->() NOT EXPORTED
554		933
555	Mainly used for debugging and benchmarking, this aio request puts one of	934	Mainly used for debugging and benchmarking, this aio request puts one of
556	the request workers to sleep for the given time.	935	the request workers to sleep for the given time.
557		936
558	While it is theoretically handy to have simple I/O scheduling requests	937	While it is theoretically handy to have simple I/O scheduling requests
559	like sleep and file handle readable/writable, the overhead this creates	938	like sleep and file handle readable/writable, the overhead this creates is
560	is immense, so do not use this function except to put your application	939	immense (it blocks a thread for a long time) so do not use this function
561	under artificial I/O pressure.	940	except to put your application under artificial I/O pressure.
562		941
563	=back	942	=back
564		943
565	=head2 IO::AIO::REQ CLASS	944	=head2 IO::AIO::REQ CLASS
566		945
567	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
568	called in non-void context.	947	called in non-void context.
569
570	A request always moves through the following five states in its lifetime,
571	in order: B<ready> (request has been created, but has not been executed
572	yet), B<execute> (request is currently being executed), B<pending>
573	(request has been executed but callback has not been called yet),
574	B<result> (results are being processed synchronously, includes calling the
575	callback) and B<done> (request has reached the end of its lifetime and
576	holds no resources anymore).
577		948
578	=over 4	949	=over 4
579		950
580	=item cancel $req	951	=item cancel $req
581		952
…		…
635	=item * They can also can also be added to other IO::AIO::GRP objects.	1006	=item * They can also can also be added to other IO::AIO::GRP objects.
636		1007
637	=item * You must not add requests to a group from within the group callback (or	1008	=item * You must not add requests to a group from within the group callback (or
638	any later time).	1009	any later time).
639		1010
640	=item * This does not harmonise well with C<max_outstanding>, so best do
641	not combine C<aio_group> with it. Groups and feeders are recommended for
642	this kind of concurrency-limiting.
643
644	=back	1011	=back
645		1012
646	Their lifetime, simplified, looks like this: when they are empty, they	1013	Their lifetime, simplified, looks like this: when they are empty, they
647	will finish very quickly. If they contain only requests that are in the	1014	will finish very quickly. If they contain only requests that are in the
648	C<done> state, they will also finish. Otherwise they will continue to	1015	C<done> state, they will also finish. Otherwise they will continue to
649	exist.	1016	exist.
650		1017
651	That means after creating a group you have some time to add requests. And	1018	That means after creating a group you have some time to add requests
652	in the callbacks of those requests, you can add further requests to the	1019	(precisely before the callback has been invoked, which is only done within
653	group. And only when all those requests have finished will the the group	1020	the C<poll_cb>). And in the callbacks of those requests, you can add
654	itself finish.	1021	further requests to the group. And only when all those requests have
		1022	finished will the the group itself finish.
655		1023
656	=over 4	1024	=over 4
657		1025
658	=item add $grp ...	1026	=item add $grp ...
659		1027
…		…
663	be added, including other groups, as long as you do not create circular	1031	be added, including other groups, as long as you do not create circular
664	dependencies.	1032	dependencies.
665		1033
666	Returns all its arguments.	1034	Returns all its arguments.
667		1035
		1036	=item $grp->cancel_subs
		1037
		1038	Cancel all subrequests and clears any feeder, but not the group request
		1039	itself. Useful when you queued a lot of events but got a result early.
		1040
668	=item $grp->result (...)	1041	=item $grp->result (...)
669		1042
670	Set the result value(s) that will be passed to the group callback when all	1043	Set the result value(s) that will be passed to the group callback when all
671	subrequests have finished. By default, no argument will be passed.	1044	subrequests have finished and set the groups errno to the current value
		1045	of errno (just like calling C<errno> without an error number). By default,
		1046	no argument will be passed and errno is zero.
		1047
		1048	=item $grp->errno ([$errno])
		1049
		1050	Sets the group errno value to C<$errno>, or the current value of errno
		1051	when the argument is missing.
		1052
		1053	Every aio request has an associated errno value that is restored when
		1054	the callback is invoked. This method lets you change this value from its
		1055	default (0).
		1056
		1057	Calling C<result> will also set errno, so make sure you either set C<$!>
		1058	before the call to C<result>, or call c<errno> after it.
672		1059
673	=item feed $grp $callback->($grp)	1060	=item feed $grp $callback->($grp)
674
675	[VERY EXPERIMENTAL]
676		1061
677	Sets a feeder/generator on this group: every group can have an attached	1062	Sets a feeder/generator on this group: every group can have an attached
678	generator that generates requests if idle. The idea behind this is that,	1063	generator that generates requests if idle. The idea behind this is that,
679	although you could just queue as many requests as you want in a group,	1064	although you could just queue as many requests as you want in a group,
680	this might starve other requests for a potentially long time. For	1065	this might starve other requests for a potentially long time. For example,
681	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1066	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
682	requests, delaying any later requests for a long time.	1067	delaying any later requests for a long time.
683		1068
684	To avoid this, and allow incremental generation of requests, you can	1069	To avoid this, and allow incremental generation of requests, you can
685	instead a group and set a feeder on it that generates those requests. The	1070	instead a group and set a feeder on it that generates those requests. The
686	feed callback will be called whenever there are few enough (see C<feed_limit>,	1071	feed callback will be called whenever there are few enough (see C<limit>,
687	below) requests active in the group itself and is expected to queue more	1072	below) requests active in the group itself and is expected to queue more
688	requests.	1073	requests.
689		1074
690	The feed can queue as many requests as it likes (i.e. C<add> does not	1075	The feed callback can queue as many requests as it likes (i.e. C<add> does
691	impose any limits).	1076	not impose any limits).
692		1077
693	If the feed does not queue more requests when called, it will be	1078	If the feed does not queue more requests when called, it will be
694	automatically removed from the group.	1079	automatically removed from the group.
695		1080
696	If the feed limit is C<0>, it will be set to C<2> automatically.	1081	If the feed limit is C<0> when this method is called, it will be set to
		1082	C<2> automatically.
697		1083
698	Example:	1084	Example:
699		1085
700	# stat all files in @files, but only ever use four aio requests concurrently:	1086	# stat all files in @files, but only ever use four aio requests concurrently:
701		1087
702	my $grp = aio_group sub { print "finished\n" };	1088	my $grp = aio_group sub { print "finished\n" };
703	feed_limit $grp 4;	1089	limit $grp 4;
704	feed $grp sub {	1090	feed $grp sub {
705	my $file = pop @files	1091	my $file = pop @files
706	or return;	1092	or return;
707		1093
708	add $grp aio_stat $file, sub { ... };	1094	add $grp aio_stat $file, sub { ... };
709	};	1095	};
710		1096
711	=item feed_limit $grp $num	1097	=item limit $grp $num
712		1098
713	Sets the feeder limit for the group: The feeder will be called whenever	1099	Sets the feeder limit for the group: The feeder will be called whenever
714	the group contains less than this many requests.	1100	the group contains less than this many requests.
715		1101
716	Setting the limit to C<0> will pause the feeding process.	1102	Setting the limit to C<0> will pause the feeding process.
717		1103
		1104	The default value for the limit is C<0>, but note that setting a feeder
		1105	automatically bumps it up to C<2>.
		1106
718	=back	1107	=back
719		1108
720	=head2 SUPPORT FUNCTIONS	1109	=head2 SUPPORT FUNCTIONS
		1110
		1111	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
721		1112
722	=over 4	1113	=over 4
723		1114
724	=item $fileno = IO::AIO::poll_fileno	1115	=item $fileno = IO::AIO::poll_fileno
725		1116
…		…
730		1121
731	See C<poll_cb> for an example.	1122	See C<poll_cb> for an example.
732		1123
733	=item IO::AIO::poll_cb	1124	=item IO::AIO::poll_cb
734		1125
735	Process all outstanding events on the result pipe. You have to call this	1126	Process some outstanding events on the result pipe. You have to call this
736	regularly. Returns the number of events processed. Returns immediately	1127	regularly. Returns C<0> if all events could be processed, or C<-1> if it
737	when no events are outstanding.	1128	returned earlier for whatever reason. Returns immediately when no events
		1129	are outstanding. The amount of events processed depends on the settings of
		1130	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
		1131
		1132	If not all requests were processed for whatever reason, the filehandle
		1133	will still be ready when C<poll_cb> returns, so normally you don't have to
		1134	do anything special to have it called later.
738		1135
739	Example: Install an Event watcher that automatically calls	1136	Example: Install an Event watcher that automatically calls
740	IO::AIO::poll_cb with high priority:	1137	IO::AIO::poll_cb with high priority:
741		1138
742	Event->io (fd => IO::AIO::poll_fileno,	1139	Event->io (fd => IO::AIO::poll_fileno,
743	poll => 'r', async => 1,	1140	poll => 'r', async => 1,
744	cb => \&IO::AIO::poll_cb);	1141	cb => \&IO::AIO::poll_cb);
745		1142
		1143	=item IO::AIO::max_poll_reqs $nreqs
		1144
		1145	=item IO::AIO::max_poll_time $seconds
		1146
		1147	These set the maximum number of requests (default C<0>, meaning infinity)
		1148	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		1149	the maximum amount of time (default C<0>, meaning infinity) spent in
		1150	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		1151	of time C<poll_cb> is allowed to use).
		1152
		1153	Setting C<max_poll_time> to a non-zero value creates an overhead of one
		1154	syscall per request processed, which is not normally a problem unless your
		1155	callbacks are really really fast or your OS is really really slow (I am
		1156	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
		1157
		1158	Setting these is useful if you want to ensure some level of
		1159	interactiveness when perl is not fast enough to process all requests in
		1160	time.
		1161
		1162	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
		1163
		1164	Example: Install an Event watcher that automatically calls
		1165	IO::AIO::poll_cb with low priority, to ensure that other parts of the
		1166	program get the CPU sometimes even under high AIO load.
		1167
		1168	# try not to spend much more than 0.1s in poll_cb
		1169	IO::AIO::max_poll_time 0.1;
		1170
		1171	# use a low priority so other tasks have priority
		1172	Event->io (fd => IO::AIO::poll_fileno,
		1173	poll => 'r', nice => 1,
		1174	cb => &IO::AIO::poll_cb);
		1175
746	=item IO::AIO::poll_wait	1176	=item IO::AIO::poll_wait
747		1177
		1178	If there are any outstanding requests and none of them in the result
748	Wait till the result filehandle becomes ready for reading (simply does a	1179	phase, wait till the result filehandle becomes ready for reading (simply
749	C<select> on the filehandle. This is useful if you want to synchronously wait	1180	does a C<select> on the filehandle. This is useful if you want to
750	for some requests to finish).	1181	synchronously wait for some requests to finish).
751		1182
752	See C<nreqs> for an example.	1183	See C<nreqs> for an example.
753		1184
		1185	=item IO::AIO::poll
		1186
		1187	Waits until some requests have been handled.
		1188
		1189	Returns the number of requests processed, but is otherwise strictly
		1190	equivalent to:
		1191
		1192	IO::AIO::poll_wait, IO::AIO::poll_cb
		1193
754	=item IO::AIO::nreqs	1194	=item IO::AIO::flush
755		1195
756	Returns the number of requests currently outstanding (i.e. for which their	1196	Wait till all outstanding AIO requests have been handled.
757	callback has not been invoked yet).
758		1197
759	Example: wait till there are no outstanding requests anymore:	1198	Strictly equivalent to:
760		1199
761	IO::AIO::poll_wait, IO::AIO::poll_cb	1200	IO::AIO::poll_wait, IO::AIO::poll_cb
762	while IO::AIO::nreqs;	1201	while IO::AIO::nreqs;
763		1202
764	=item IO::AIO::flush	1203	=back
765		1204
766	Wait till all outstanding AIO requests have been handled.	1205	=head3 CONTROLLING THE NUMBER OF THREADS
767		1206
768	Strictly equivalent to:	1207	=over
769
770	IO::AIO::poll_wait, IO::AIO::poll_cb
771	while IO::AIO::nreqs;
772
773	=item IO::AIO::poll
774
775	Waits until some requests have been handled.
776
777	Strictly equivalent to:
778
779	IO::AIO::poll_wait, IO::AIO::poll_cb
780	if IO::AIO::nreqs;
781		1208
782	=item IO::AIO::min_parallel $nthreads	1209	=item IO::AIO::min_parallel $nthreads
783		1210
784	Set the minimum number of AIO threads to C<$nthreads>. The current	1211	Set the minimum number of AIO threads to C<$nthreads>. The current
785	default is C<8>, which means eight asynchronous operations can execute	1212	default is C<8>, which means eight asynchronous operations can execute
786	concurrently at any one time (the number of outstanding requests,	1213	concurrently at any one time (the number of outstanding requests,
787	however, is unlimited).	1214	however, is unlimited).
788		1215
789	IO::AIO starts threads only on demand, when an AIO request is queued and	1216	IO::AIO starts threads only on demand, when an AIO request is queued and
790	no free thread exists.	1217	no free thread exists. Please note that queueing up a hundred requests can
		1218	create demand for a hundred threads, even if it turns out that everything
		1219	is in the cache and could have been processed faster by a single thread.
791		1220
792	It is recommended to keep the number of threads relatively low, as some	1221	It is recommended to keep the number of threads relatively low, as some
793	Linux kernel versions will scale negatively with the number of threads	1222	Linux kernel versions will scale negatively with the number of threads
794	(higher parallelity => MUCH higher latency). With current Linux 2.6	1223	(higher parallelity => MUCH higher latency). With current Linux 2.6
795	versions, 4-32 threads should be fine.	1224	versions, 4-32 threads should be fine.
…		…
809	This module automatically runs C<max_parallel 0> at program end, to ensure	1238	This module automatically runs C<max_parallel 0> at program end, to ensure
810	that all threads are killed and that there are no outstanding requests.	1239	that all threads are killed and that there are no outstanding requests.
811		1240
812	Under normal circumstances you don't need to call this function.	1241	Under normal circumstances you don't need to call this function.
813		1242
		1243	=item IO::AIO::max_idle $nthreads
		1244
		1245	Limit the number of threads (default: 4) that are allowed to idle (i.e.,
		1246	threads that did not get a request to process within 10 seconds). That
		1247	means if a thread becomes idle while C<$nthreads> other threads are also
		1248	idle, it will free its resources and exit.
		1249
		1250	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1251	to allow for extremely high load situations, but want to free resources
		1252	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1253
		1254	The default is probably ok in most situations, especially if thread
		1255	creation is fast. If thread creation is very slow on your system you might
		1256	want to use larger values.
		1257
814	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	1258	=item IO::AIO::max_outstanding $maxreqs
815		1259
816	[DEPRECATED]	1260	This is a very bad function to use in interactive programs because it
		1261	blocks, and a bad way to reduce concurrency because it is inexact: Better
		1262	use an C<aio_group> together with a feed callback.
817		1263
818	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1264	Sets the maximum number of outstanding requests to C<$nreqs>. If you
819	try to queue up more than this number of requests, the caller will block until	1265	do queue up more than this number of requests, the next call to the
820	some requests have been handled.	1266	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
		1267	function will block until the limit is no longer exceeded.
821		1268
822	The default is very large, so normally there is no practical limit. If you	1269	The default value is very large, so there is no practical limit on the
823	queue up many requests in a loop it often improves speed if you set	1270	number of outstanding requests.
824	this to a relatively low number, such as C<100>.
825		1271
826	This function does not work well together with C<aio_group>'s, and their	1272	You can still queue as many requests as you want. Therefore,
827	feeder interface is better suited to limiting concurrency, so do not use	1273	C<max_outstanding> is mainly useful in simple scripts (with low values) or
828	this function.	1274	as a stop gap to shield against fatal memory overflow (with large values).
829
830	Under normal circumstances you don't need to call this function.
831		1275
832	=back	1276	=back
833		1277
		1278	=head3 STATISTICAL INFORMATION
		1279
		1280	=over
		1281
		1282	=item IO::AIO::nreqs
		1283
		1284	Returns the number of requests currently in the ready, execute or pending
		1285	states (i.e. for which their callback has not been invoked yet).
		1286
		1287	Example: wait till there are no outstanding requests anymore:
		1288
		1289	IO::AIO::poll_wait, IO::AIO::poll_cb
		1290	while IO::AIO::nreqs;
		1291
		1292	=item IO::AIO::nready
		1293
		1294	Returns the number of requests currently in the ready state (not yet
		1295	executed).
		1296
		1297	=item IO::AIO::npending
		1298
		1299	Returns the number of requests currently in the pending state (executed,
		1300	but not yet processed by poll_cb).
		1301
		1302	=back
		1303
834	=cut	1304	=cut
835		1305
836	# support function to convert a fd into a perl filehandle
837	sub _fd2fh {
838	return undef if $_[0] < 0;
839
840	# try to generate nice filehandles
841	my $sym = "IO::AIO::fd#$_[0]";
842	local *$sym;
843
844	open *$sym, "+<&=$_[0]" # usually works under any unix
845	or open *$sym, "<&=$_[0]" # cygwin needs this
846	or open *$sym, ">&=$_[0]" # or this
847	or return undef;
848
849	*$sym
850	}
851
852	min_parallel 8;	1306	min_parallel 8;
853		1307
854	END {	1308	END { flush }
855	max_parallel 0;
856	}
857		1309
858	1;	1310	1;
859		1311
860	=head2 FORK BEHAVIOUR	1312	=head2 FORK BEHAVIOUR
861		1313
862	This module should do "the right thing" when the process using it forks:	1314	This module should do "the right thing" when the process using it forks:
863		1315
864	Before the fork, IO::AIO enters a quiescent state where no requests	1316	Before the fork, IO::AIO enters a quiescent state where no requests
865	can be added in other threads and no results will be processed. After	1317	can be added in other threads and no results will be processed. After
866	the fork the parent simply leaves the quiescent state and continues	1318	the fork the parent simply leaves the quiescent state and continues
867	request/result processing, while the child clears the request/result	1319	request/result processing, while the child frees the request/result queue
868	queue (so the requests started before the fork will only be handled in	1320	(so that the requests started before the fork will only be handled in the
869	the parent). Threads will be started on demand until the limit ste in the	1321	parent). Threads will be started on demand until the limit set in the
870	parent process has been reached again.	1322	parent process has been reached again.
871		1323
872	In short: the parent will, after a short pause, continue as if fork had	1324	In short: the parent will, after a short pause, continue as if fork had
873	not been called, while the child will act as if IO::AIO has not been used	1325	not been called, while the child will act as if IO::AIO has not been used
874	yet.	1326	yet.
875		1327
876	=head2 MEMORY USAGE	1328	=head2 MEMORY USAGE
877		1329
		1330	Per-request usage:
		1331
878	Each aio request uses - depending on your architecture - around 128 bytes	1332	Each aio request uses - depending on your architecture - around 100-200
879	of memory. In addition, stat requests need a stat buffer (possibly a few	1333	bytes of memory. In addition, stat requests need a stat buffer (possibly
880	hundred bytes). Perl scalars and other data passed into aio requests will	1334	a few hundred bytes), readdir requires a result buffer and so on. Perl
881	also be locked.	1335	scalars and other data passed into aio requests will also be locked and
		1336	will consume memory till the request has entered the done state.
882		1337
883	This is now awfully much, so queuing lots of requests is not usually a	1338	This is not awfully much, so queuing lots of requests is not usually a
884	problem.	1339	problem.
885		1340
886	Each thread needs a stack area which is usually around 16k, sometimes much	1341	Per-thread usage:
887	larger, depending on the OS.	1342
		1343	In the execution phase, some aio requests require more memory for
		1344	temporary buffers, and each thread requires a stack and other data
		1345	structures (usually around 16k-128k, depending on the OS).
		1346
		1347	=head1 KNOWN BUGS
		1348
		1349	Known bugs will be fixed in the next release.
888		1350
889	=head1 SEE ALSO	1351	=head1 SEE ALSO
890		1352
891	L<Coro>, L<Linux::AIO> (obsolete).	1353	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		1354	more natural syntax.
892		1355
893	=head1 AUTHOR	1356	=head1 AUTHOR
894		1357
895	Marc Lehmann <schmorp@schmorp.de>	1358	Marc Lehmann <schmorp@schmorp.de>
896	http://home.schmorp.de/	1359	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.67 by root, Tue Oct 24 02:25:16 2006 UTC vs. Revision 1.141 by root, Wed Oct 22 16:30:49 2008 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.67 by root, Tue Oct 24 02:25:16 2006 UTC vs.
Revision 1.141 by root, Wed Oct 22 16:30:49 2008 UTC