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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.42 by root, Mon Dec 26 18:15:23 2005 UTC vs.
Revision 1.71 by root, Tue Oct 24 11:57:30 2006 UTC

…		…
15		15
16	aio_read $fh, 30000, 1024, $buffer, 0, sub {	16	aio_read $fh, 30000, 1024, $buffer, 0, sub {
17	$_[0] > 0 or die "read error: $!";	17	$_[0] > 0 or die "read error: $!";
18	};	18	};
19		19
20	# AnyEvent	20	# version 2+ has request and group objects
		21	use IO::AIO 2;
		22
		23	aioreq_pri 4; # give next request a very high priority
		24	my $req = aio_unlink "/tmp/file", sub { };
		25	$req->cancel; # cancel request if still in queue
		26
		27	my $grp = aio_group sub { print "all stats done\n" };
		28	add $grp aio_stat "..." for ...;
		29
		30	# AnyEvent integration
21	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	31	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
22	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });	32	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
23		33
24	# Event	34	# Event integration
25	Event->io (fd => IO::AIO::poll_fileno,	35	Event->io (fd => IO::AIO::poll_fileno,
26	poll => 'r',	36	poll => 'r',
27	cb => \&IO::AIO::poll_cb);	37	cb => \&IO::AIO::poll_cb);
28		38
29	# Glib/Gtk2	39	# Glib/Gtk2 integration
30	add_watch Glib::IO IO::AIO::poll_fileno,	40	add_watch Glib::IO IO::AIO::poll_fileno,
31	in => sub { IO::AIO::poll_cb; 1 };	41	in => sub { IO::AIO::poll_cb; 1 };
32		42
33	# Tk	43	# Tk integration
34	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",	44	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
35	readable => \&IO::AIO::poll_cb);	45	readable => \&IO::AIO::poll_cb);
36		46
37	# Danga::Socket	47	# Danga::Socket integration
38	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>	48	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
39	\&IO::AIO::poll_cb);	49	\&IO::AIO::poll_cb);
40		50
41
42	=head1 DESCRIPTION	51	=head1 DESCRIPTION
43		52
44	This module implements asynchronous I/O using whatever means your	53	This module implements asynchronous I/O using whatever means your
45	operating system supports.	54	operating system supports.
46		55
47	Currently, a number of threads are started that execute your read/writes	56	Currently, a number of threads are started that execute your read/writes
48	and signal their completion. You don't need thread support in your libc or	57	and signal their completion. You don't need thread support in perl, and
49	perl, and the threads created by this module will not be visible to the	58	the threads created by this module will not be visible to perl. In the
50	pthreads library. In the future, this module might make use of the native	59	future, this module might make use of the native aio functions available
51	aio functions available on many operating systems. However, they are often	60	on many operating systems. However, they are often not well-supported
52	not well-supported (Linux doesn't allow them on normal files currently,	61	(Linux doesn't allow them on normal files currently, for example),
53	for example), and they would only support aio_read and aio_write, so the	62	and they would only support aio_read and aio_write, so the remaining
54	remaining functionality would have to be implemented using threads anyway.	63	functionality would have to be implemented using threads anyway.
55		64
56	Although the module will work with in the presence of other threads, it is	65	Although the module will work with in the presence of other threads,
57	currently not reentrant, so use appropriate locking yourself, always call	66	it is currently not reentrant in any way, so use appropriate locking
58	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other	67	yourself, always call C<poll_cb> from within the same thread, or never
59	C<aio_> functions) recursively.	68	call C<poll_cb> (or other C<aio_> functions) recursively.
60		69
61	=cut	70	=cut
62		71
63	package IO::AIO;	72	package IO::AIO;
64		73
65	no warnings;	74	no warnings;
		75	use strict 'vars';
66		76
67	use base 'Exporter';	77	use base 'Exporter';
68		78
69	use Fcntl ();
70
71	BEGIN {	79	BEGIN {
72	$VERSION = '1.61';	80	our $VERSION = '2.0';
73		81
74	@EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	82	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
75	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	83	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
76	aio_fsync aio_fdatasync aio_readahead);	84	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
77	@EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel	85	aio_group aio_nop);
78	max_outstanding nreqs);	86	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
		87	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
		88	min_parallel max_parallel max_outstanding nreqs);
		89
		90	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
79		91
80	require XSLoader;	92	require XSLoader;
81	XSLoader::load IO::AIO, $VERSION;	93	XSLoader::load ("IO::AIO", $VERSION);
82	}	94	}
83		95
84	=head1 FUNCTIONS	96	=head1 FUNCTIONS
85		97
86	=head2 AIO FUNCTIONS	98	=head2 AIO FUNCTIONS
…		…
94	syscall has been executed asynchronously.	106	syscall has been executed asynchronously.
95		107
96	All functions expecting a filehandle keep a copy of the filehandle	108	All functions expecting a filehandle keep a copy of the filehandle
97	internally until the request has finished.	109	internally until the request has finished.
98		110
		111	All requests return objects of type L<IO::AIO::REQ> that allow further
		112	manipulation of those requests while they are in-flight.
		113
99	The pathnames you pass to these routines I<must> be absolute and	114	The pathnames you pass to these routines I<must> be absolute and
100	encoded in byte form. The reason for the former is that at the time the	115	encoded in byte form. The reason for the former is that at the time the
101	request is being executed, the current working directory could have	116	request is being executed, the current working directory could have
102	changed. Alternatively, you can make sure that you never change the	117	changed. Alternatively, you can make sure that you never change the
103	current working directory.	118	current working directory.
…		…
108	your pathnames to the locale (or other) encoding in effect in the user	123	your pathnames to the locale (or other) encoding in effect in the user
109	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	124	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
110	use something else.	125	use something else.
111		126
112	=over 4	127	=over 4
		128
		129	=item aioreq_pri $pri
		130
		131	Sets the priority for the next aio request. The default priority
		132	is C<0>, the minimum and maximum priorities are C<-4> and C<4>,
		133	respectively. Requests with higher priority will be serviced first.
		134
		135	The priority will be reset to C<0> after each call to one of the C<aio_>
		136	functions.
		137
		138	Example: open a file with low priority, then read something from it with
		139	higher priority so the read request is serviced before other low priority
		140	open requests (potentially spamming the cache):
		141
		142	aioreq_pri -3;
		143	aio_open ..., sub {
		144	return unless $_[0];
		145
		146	aioreq_pri -2;
		147	aio_read $_[0], ..., sub {
		148	...
		149	};
		150	};
		151
		152	=item aioreq_nice $pri_adjust
		153
		154	Similar to C<aioreq_pri>, but subtracts the given value from the current
		155	priority, so effects are cumulative.
113		156
114	=item aio_open $pathname, $flags, $mode, $callback->($fh)	157	=item aio_open $pathname, $flags, $mode, $callback->($fh)
115		158
116	Asynchronously open or create a file and call the callback with a newly	159	Asynchronously open or create a file and call the callback with a newly
117	created filehandle for the file.	160	created filehandle for the file.
…		…
167		210
168	aio_read $fh, 7, 15, $buffer, 0, sub {	211	aio_read $fh, 7, 15, $buffer, 0, sub {
169	$_[0] > 0 or die "read error: $!";	212	$_[0] > 0 or die "read error: $!";
170	print "read $_[0] bytes: <$buffer>\n";	213	print "read $_[0] bytes: <$buffer>\n";
171	};	214	};
		215
		216	=item aio_move $srcpath, $dstpath, $callback->($status)
		217
		218	Try to move the I<file> (directories not supported as either source or
		219	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		220	the C<0> (error) or C<-1> ok.
		221
		222	This is a composite request that tries to rename(2) the file first. If
		223	rename files with C<EXDEV>, it creates the destination file with mode 0200
		224	and copies the contents of the source file into it using C<aio_sendfile>,
		225	followed by restoring atime, mtime, access mode and uid/gid, in that
		226	order, and unlinking the C<$srcpath>.
		227
		228	If an error occurs, the partial destination file will be unlinked, if
		229	possible, except when setting atime, mtime, access mode and uid/gid, where
		230	errors are being ignored.
		231
		232	=cut
		233
		234	sub aio_move($$$) {
		235	my ($src, $dst, $cb) = @_;
		236
		237	my $grp = aio_group $cb;
		238
		239	add $grp aio_rename $src, $dst, sub {
		240	if ($_[0] && $! == EXDEV) {
		241	add $grp aio_open $src, O_RDONLY, 0, sub {
		242	if (my $src_fh = $_[0]) {
		243	my @stat = stat $src_fh;
		244
		245	add $grp aio_open $dst, O_WRONLY, 0200, sub {
		246	if (my $dst_fh = $_[0]) {
		247	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		248	close $src_fh;
		249
		250	if ($_[0] == $stat[7]) {
		251	utime $stat[8], $stat[9], $dst;
		252	chmod $stat[2] & 07777, $dst_fh;
		253	chown $stat[4], $stat[5], $dst_fh;
		254	close $dst_fh;
		255
		256	add $grp aio_unlink $src, sub {
		257	$grp->result ($_[0]);
		258	};
		259	} else {
		260	my $errno = $!;
		261	add $grp aio_unlink $dst, sub {
		262	$! = $errno;
		263	$grp->result (-1);
		264	};
		265	}
		266	};
		267	} else {
		268	$grp->result (-1);
		269	}
		270	},
		271
		272	} else {
		273	$grp->result (-1);
		274	}
		275	};
		276	} else {
		277	$grp->result ($_[0]);
		278	}
		279	};
		280
		281	$grp
		282	}
172		283
173	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	284	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
174		285
175	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	286	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
176	reading at byte offset C<$in_offset>, and starts writing at the current	287	reading at byte offset C<$in_offset>, and starts writing at the current
…		…
232	=item aio_unlink $pathname, $callback->($status)	343	=item aio_unlink $pathname, $callback->($status)
233		344
234	Asynchronously unlink (delete) a file and call the callback with the	345	Asynchronously unlink (delete) a file and call the callback with the
235	result code.	346	result code.
236		347
		348	=item aio_link $srcpath, $dstpath, $callback->($status)
		349
		350	Asynchronously create a new link to the existing object at C<$srcpath> at
		351	the path C<$dstpath> and call the callback with the result code.
		352
		353	=item aio_symlink $srcpath, $dstpath, $callback->($status)
		354
		355	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
		356	the path C<$dstpath> and call the callback with the result code.
		357
		358	=item aio_rename $srcpath, $dstpath, $callback->($status)
		359
		360	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
		361	rename(2) and call the callback with the result code.
		362
237	=item aio_rmdir $pathname, $callback->($status)	363	=item aio_rmdir $pathname, $callback->($status)
238		364
239	Asynchronously rmdir (delete) a directory and call the callback with the	365	Asynchronously rmdir (delete) a directory and call the callback with the
240	result code.	366	result code.
241		367
242	=item aio_readdir $pathname $callback->($entries)	368	=item aio_readdir $pathname, $callback->($entries)
243		369
244	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	370	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
245	directory (i.e. opendir + readdir + closedir). The entries will not be	371	directory (i.e. opendir + readdir + closedir). The entries will not be
246	sorted, and will B<NOT> include the C<.> and C<..> entries.	372	sorted, and will B<NOT> include the C<.> and C<..> entries.
247		373
248	The callback a single argument which is either C<undef> or an array-ref	374	The callback a single argument which is either C<undef> or an array-ref
249	with the filenames.	375	with the filenames.
250		376
251	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	377	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
252		378
253	Scans a directory (similar to C<aio_readdir>) and tries to separate the	379	Scans a directory (similar to C<aio_readdir>) but additionally tries to
254	entries of directory C<$path> into two sets of names, ones you can recurse	380	separate the entries of directory C<$path> into two sets of names, ones
255	into (directories), and ones you cannot recurse into (everything else).	381	you can recurse into (directories or links to them), and ones you cannot
		382	recurse into (everything else).
256		383
257	C<aio_scandir> is a composite request that consists of many	384	C<aio_scandir> is a composite request that creates of many sub requests_
258	aio-primitives. C<$maxreq> specifies the maximum number of outstanding	385	C<$maxreq> specifies the maximum number of outstanding aio requests that
259	aio requests that this function generates. If it is C<< <= 0 >>, then a	386	this function generates. If it is C<< <= 0 >>, then a suitable default
260	suitable default will be chosen (currently 8).	387	will be chosen (currently 6).
261		388
262	On error, the callback is called without arguments, otherwise it receives	389	On error, the callback is called without arguments, otherwise it receives
263	two array-refs with path-relative entry names.	390	two array-refs with path-relative entry names.
264		391
265	Example:	392	Example:
…		…
273	Implementation notes.	400	Implementation notes.
274		401
275	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	402	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
276		403
277	After reading the directory, the modification time, size etc. of the	404	After reading the directory, the modification time, size etc. of the
278	directory before and after the readdir is checked, and if they match, the	405	directory before and after the readdir is checked, and if they match (and
279	link count will be used to decide how many entries are directories (if	406	isn't the current time), the link count will be used to decide how many
280	>= 2). Otherwise, no knowledge of the number of subdirectories will be	407	entries are directories (if >= 2). Otherwise, no knowledge of the number
281	assumed.	408	of subdirectories will be assumed.
282		409
283	Then entires will be sorted into likely directories (everything without a	410	Then entries will be sorted into likely directories (everything without
284	non-initial dot) and likely non-directories (everything else). Then every	411	a non-initial dot currently) and likely non-directories (everything
285	entry + C</.> will be C<stat>'ed, likely directories first. This is often	412	else). Then every entry plus an appended C</.> will be C<stat>'ed,
		413	likely directories first. If that succeeds, it assumes that the entry
		414	is a directory or a symlink to directory (which will be checked
		415	seperately). This is often faster than stat'ing the entry itself because
286	faster because filesystems might detect the type of the entry without	416	filesystems might detect the type of the entry without reading the inode
287	reading the inode data (e.g. ext2s filetype feature). If that succeeds,	417	data (e.g. ext2fs filetype feature).
288	it assumes that the entry is a directory or a symlink to directory (which
289	will be checked seperately).
290		418
291	If the known number of directories has been reached, the rest of the	419	If the known number of directories (link count - 2) has been reached, the
292	entries is assumed to be non-directories.	420	rest of the entries is assumed to be non-directories.
		421
		422	This only works with certainty on POSIX (= UNIX) filesystems, which
		423	fortunately are the vast majority of filesystems around.
		424
		425	It will also likely work on non-POSIX filesystems with reduced efficiency
		426	as those tend to return 0 or 1 as link counts, which disables the
		427	directory counting heuristic.
293		428
294	=cut	429	=cut
295		430
296	sub aio_scandir($$$) {	431	sub aio_scandir($$$) {
297	my ($path, $maxreq, $cb) = @_;	432	my ($path, $maxreq, $cb) = @_;
298		433
		434	my $grp = aio_group $cb;
		435
299	$maxreq = 8 if $maxreq <= 0;	436	$maxreq = 6 if $maxreq <= 0;
300		437
301	# stat once	438	# stat once
302	aio_stat $path, sub {	439	add $grp aio_stat $path, sub {
303	$cb->() if $_[0];	440	return $grp->result () if $_[0];
		441	my $now = time;
304	my $hash1 = join ":", (stat _)[0,1,3,7,9];	442	my $hash1 = join ":", (stat _)[0,1,3,7,9];
305		443
306	# read the directory entries	444	# read the directory entries
307	aio_readdir $path, sub {	445	add $grp aio_readdir $path, sub {
308	my $entries = shift	446	my $entries = shift
309	or return $cb->();	447	or return $grp->result ();
310		448
311	# stat the dir another time	449	# stat the dir another time
312	aio_stat $path, sub {	450	add $grp aio_stat $path, sub {
313	my $hash2 = join ":", (stat _)[0,1,3,7,9];	451	my $hash2 = join ":", (stat _)[0,1,3,7,9];
314		452
315	my $ndirs;	453	my $ndirs;
316		454
317	# take the slow route if anything looks fishy	455	# take the slow route if anything looks fishy
318	if ($hash1 ne $hash2) {	456	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
319	$ndirs = -1;	457	$ndirs = -1;
320	} else {	458	} else {
321	# if nlink == 2, we are finished	459	# if nlink == 2, we are finished
322	# on non-posix-fs's, we rely on nlink < 2	460	# on non-posix-fs's, we rely on nlink < 2
323	$ndirs = (stat _)[3] - 2	461	$ndirs = (stat _)[3] - 2
324	or $cb->([], $entries);	462	or return $grp->result ([], $entries);
325	}	463	}
326		464
327	# sort into likely dirs and likely nondirs	465	# sort into likely dirs and likely nondirs
328	# dirs == files without ".", short entries first	466	# dirs == files without ".", short entries first
329	$entries = [map $_->[0],	467	$entries = [map $_->[0],
…		…
334	my (@dirs, @nondirs);	472	my (@dirs, @nondirs);
335		473
336	my ($statcb, $schedcb);	474	my ($statcb, $schedcb);
337	my $nreq = 0;	475	my $nreq = 0;
338		476
		477	my $statgrp = add $grp aio_group;
		478
339	$schedcb = sub {	479	$schedcb = sub {
340	if (@$entries) {	480	if (@$entries) {
341	if ($nreq < $maxreq) {	481	if ($nreq < $maxreq) {
342	my $ent = pop @$entries;	482	my $ent = pop @$entries;
343	$nreq++;	483	$nreq++;
344	aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };	484	add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
345	}	485	}
346	} elsif (!$nreq) {	486	} elsif (!$nreq) {
347	# finished	487	# finished
		488	$statgrp->cancel;
348	undef $statcb;	489	undef $statcb;
349	undef $schedcb;	490	undef $schedcb;
350	$cb->(\@dirs, \@nondirs);	491	$grp->result (\@dirs, \@nondirs);
351	undef $cb;
352	}	492	}
353	};	493	};
354	$statcb = sub {	494	$statcb = sub {
355	my ($status, $entry) = @_;	495	my ($status, $entry) = @_;
356		496
…		…
358	$nreq--;	498	$nreq--;
359	push @nondirs, $entry;	499	push @nondirs, $entry;
360	&$schedcb;	500	&$schedcb;
361	} else {	501	} else {
362	# need to check for real directory	502	# need to check for real directory
363	aio_lstat "$path/$entry", sub {	503	add $grp aio_lstat "$path/$entry", sub {
364	$nreq--;	504	$nreq--;
365		505
366	if (-d _) {	506	if (-d _) {
367	push @dirs, $entry;	507	push @dirs, $entry;
368		508
…		…
381		521
382	&$schedcb while @$entries && $nreq < $maxreq;	522	&$schedcb while @$entries && $nreq < $maxreq;
383	};	523	};
384	};	524	};
385	};	525	};
		526
		527	$grp
386	}	528	}
387		529
388	=item aio_fsync $fh, $callback->($status)	530	=item aio_fsync $fh, $callback->($status)
389		531
390	Asynchronously call fsync on the given filehandle and call the callback	532	Asynchronously call fsync on the given filehandle and call the callback
…		…
395	Asynchronously call fdatasync on the given filehandle and call the	537	Asynchronously call fdatasync on the given filehandle and call the
396	callback with the fdatasync result code.	538	callback with the fdatasync result code.
397		539
398	If this call isn't available because your OS lacks it or it couldn't be	540	If this call isn't available because your OS lacks it or it couldn't be
399	detected, it will be emulated by calling C<fsync> instead.	541	detected, it will be emulated by calling C<fsync> instead.
		542
		543	=item aio_group $callback->(...)
		544
		545	[EXPERIMENTAL]
		546
		547	This is a very special aio request: Instead of doing something, it is a
		548	container for other aio requests, which is useful if you want to bundle
		549	many requests into a single, composite, request with a definite callback
		550	and the ability to cancel the whole request with its subrequests.
		551
		552	Returns an object of class L<IO::AIO::GRP>. See its documentation below
		553	for more info.
		554
		555	Example:
		556
		557	my $grp = aio_group sub {
		558	print "all stats done\n";
		559	};
		560
		561	add $grp
		562	(aio_stat ...),
		563	(aio_stat ...),
		564	...;
		565
		566	=item aio_nop $callback->()
		567
		568	This is a special request - it does nothing in itself and is only used for
		569	side effects, such as when you want to add a dummy request to a group so
		570	that finishing the requests in the group depends on executing the given
		571	code.
		572
		573	While this request does nothing, it still goes through the execution
		574	phase and still requires a worker thread. Thus, the callback will not
		575	be executed immediately but only after other requests in the queue have
		576	entered their execution phase. This can be used to measure request
		577	latency.
		578
		579	=item IO::AIO::aio_busy $fractional_seconds, $callback->() NOT EXPORTED
		580
		581	Mainly used for debugging and benchmarking, this aio request puts one of
		582	the request workers to sleep for the given time.
		583
		584	While it is theoretically handy to have simple I/O scheduling requests
		585	like sleep and file handle readable/writable, the overhead this creates is
		586	immense (it blocks a thread for a long time) so do not use this function
		587	except to put your application under artificial I/O pressure.
		588
		589	=back
		590
		591	=head2 IO::AIO::REQ CLASS
		592
		593	All non-aggregate C<aio_*> functions return an object of this class when
		594	called in non-void context.
		595
		596	A request always moves through the following five states in its lifetime,
		597	in order: B<ready> (request has been created, but has not been executed
		598	yet), B<execute> (request is currently being executed), B<pending>
		599	(request has been executed but callback has not been called yet),
		600	B<result> (results are being processed synchronously, includes calling the
		601	callback) and B<done> (request has reached the end of its lifetime and
		602	holds no resources anymore).
		603
		604	=over 4
		605
		606	=item cancel $req
		607
		608	Cancels the request, if possible. Has the effect of skipping execution
		609	when entering the B<execute> state and skipping calling the callback when
		610	entering the the B<result> state, but will leave the request otherwise
		611	untouched. That means that requests that currently execute will not be
		612	stopped and resources held by the request will not be freed prematurely.
		613
		614	=item cb $req $callback->(...)
		615
		616	Replace (or simply set) the callback registered to the request.
		617
		618	=back
		619
		620	=head2 IO::AIO::GRP CLASS
		621
		622	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
		623	objects of this class, too.
		624
		625	A IO::AIO::GRP object is a special request that can contain multiple other
		626	aio requests.
		627
		628	You create one by calling the C<aio_group> constructing function with a
		629	callback that will be called when all contained requests have entered the
		630	C<done> state:
		631
		632	my $grp = aio_group sub {
		633	print "all requests are done\n";
		634	};
		635
		636	You add requests by calling the C<add> method with one or more
		637	C<IO::AIO::REQ> objects:
		638
		639	$grp->add (aio_unlink "...");
		640
		641	add $grp aio_stat "...", sub {
		642	$_[0] or return $grp->result ("error");
		643
		644	# add another request dynamically, if first succeeded
		645	add $grp aio_open "...", sub {
		646	$grp->result ("ok");
		647	};
		648	};
		649
		650	This makes it very easy to create composite requests (see the source of
		651	C<aio_move> for an application) that work and feel like simple requests.
		652
		653	=over 4
		654
		655	=item * The IO::AIO::GRP objects will be cleaned up during calls to
		656	C<IO::AIO::poll_cb>, just like any other request.
		657
		658	=item * They can be canceled like any other request. Canceling will cancel not
		659	only the request itself, but also all requests it contains.
		660
		661	=item * They can also can also be added to other IO::AIO::GRP objects.
		662
		663	=item * You must not add requests to a group from within the group callback (or
		664	any later time).
		665
		666	=item * This does not harmonise well with C<max_outstanding>, so best do
		667	not combine C<aio_group> with it. Groups and feeders are recommended for
		668	this kind of concurrency-limiting.
		669
		670	=back
		671
		672	Their lifetime, simplified, looks like this: when they are empty, they
		673	will finish very quickly. If they contain only requests that are in the
		674	C<done> state, they will also finish. Otherwise they will continue to
		675	exist.
		676
		677	That means after creating a group you have some time to add requests. And
		678	in the callbacks of those requests, you can add further requests to the
		679	group. And only when all those requests have finished will the the group
		680	itself finish.
		681
		682	=over 4
		683
		684	=item add $grp ...
		685
		686	=item $grp->add (...)
		687
		688	Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
		689	be added, including other groups, as long as you do not create circular
		690	dependencies.
		691
		692	Returns all its arguments.
		693
		694	=item $grp->result (...)
		695
		696	Set the result value(s) that will be passed to the group callback when all
		697	subrequests have finished. By default, no argument will be passed.
		698
		699	=item feed $grp $callback->($grp)
		700
		701	[VERY EXPERIMENTAL]
		702
		703	Sets a feeder/generator on this group: every group can have an attached
		704	generator that generates requests if idle. The idea behind this is that,
		705	although you could just queue as many requests as you want in a group,
		706	this might starve other requests for a potentially long time. For
		707	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
		708	requests, delaying any later requests for a long time.
		709
		710	To avoid this, and allow incremental generation of requests, you can
		711	instead a group and set a feeder on it that generates those requests. The
		712	feed callback will be called whenever there are few enough (see C<limit>,
		713	below) requests active in the group itself and is expected to queue more
		714	requests.
		715
		716	The feed callback can queue as many requests as it likes (i.e. C<add> does
		717	not impose any limits).
		718
		719	If the feed does not queue more requests when called, it will be
		720	automatically removed from the group.
		721
		722	If the feed limit is C<0>, it will be set to C<2> automatically.
		723
		724	Example:
		725
		726	# stat all files in @files, but only ever use four aio requests concurrently:
		727
		728	my $grp = aio_group sub { print "finished\n" };
		729	limit $grp 4;
		730	feed $grp sub {
		731	my $file = pop @files
		732	or return;
		733
		734	add $grp aio_stat $file, sub { ... };
		735	};
		736
		737	=item limit $grp $num
		738
		739	Sets the feeder limit for the group: The feeder will be called whenever
		740	the group contains less than this many requests.
		741
		742	Setting the limit to C<0> will pause the feeding process.
400		743
401	=back	744	=back
402		745
403	=head2 SUPPORT FUNCTIONS	746	=head2 SUPPORT FUNCTIONS
404		747
…		…
462	IO::AIO::poll_wait, IO::AIO::poll_cb	805	IO::AIO::poll_wait, IO::AIO::poll_cb
463	if IO::AIO::nreqs;	806	if IO::AIO::nreqs;
464		807
465	=item IO::AIO::min_parallel $nthreads	808	=item IO::AIO::min_parallel $nthreads
466		809
467	Set the minimum number of AIO threads to C<$nthreads>. The current default	810	Set the minimum number of AIO threads to C<$nthreads>. The current
468	is C<4>, which means four asynchronous operations can be done at one time	811	default is C<8>, which means eight asynchronous operations can execute
469	(the number of outstanding operations, however, is unlimited).	812	concurrently at any one time (the number of outstanding requests,
		813	however, is unlimited).
470		814
471	IO::AIO starts threads only on demand, when an AIO request is queued and	815	IO::AIO starts threads only on demand, when an AIO request is queued and
472	no free thread exists.	816	no free thread exists.
473		817
474	It is recommended to keep the number of threads low, as some Linux	818	It is recommended to keep the number of threads relatively low, as some
475	kernel versions will scale negatively with the number of threads (higher	819	Linux kernel versions will scale negatively with the number of threads
476	parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32	820	(higher parallelity => MUCH higher latency). With current Linux 2.6
477	threads should be fine.	821	versions, 4-32 threads should be fine.
478		822
479	Under most circumstances you don't need to call this function, as the	823	Under most circumstances you don't need to call this function, as the
480	module selects a default that is suitable for low to moderate load.	824	module selects a default that is suitable for low to moderate load.
481		825
482	=item IO::AIO::max_parallel $nthreads	826	=item IO::AIO::max_parallel $nthreads
…		…
493		837
494	Under normal circumstances you don't need to call this function.	838	Under normal circumstances you don't need to call this function.
495		839
496	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	840	=item $oldnreqs = IO::AIO::max_outstanding $nreqs
497		841
		842	[DEPRECATED]
		843
498	Sets the maximum number of outstanding requests to C<$nreqs>. If you	844	Sets the maximum number of outstanding requests to C<$nreqs>. If you
499	try to queue up more than this number of requests, the caller will block until	845	try to queue up more than this number of requests, the caller will block until
500	some requests have been handled.	846	some requests have been handled.
501		847
502	The default is very large, so normally there is no practical limit. If you	848	The default is very large, so normally there is no practical limit. If you
503	queue up many requests in a loop it often improves speed if you set	849	queue up many requests in a loop it often improves speed if you set
504	this to a relatively low number, such as C<100>.	850	this to a relatively low number, such as C<100>.
		851
		852	This function does not work well together with C<aio_group>'s, and their
		853	feeder interface is better suited to limiting concurrency, so do not use
		854	this function.
505		855
506	Under normal circumstances you don't need to call this function.	856	Under normal circumstances you don't need to call this function.
507		857
508	=back	858	=back
509		859
…		…
523	or return undef;	873	or return undef;
524		874
525	*$sym	875	*$sym
526	}	876	}
527		877
528	min_parallel 4;	878	min_parallel 8;
529		879
530	END {	880	END {
531	max_parallel 0;	881	max_parallel 0;
532	}	882	}
533		883
534	1;	884	1;
535		885
536	=head2 FORK BEHAVIOUR	886	=head2 FORK BEHAVIOUR
		887
		888	This module should do "the right thing" when the process using it forks:
537		889
538	Before the fork, IO::AIO enters a quiescent state where no requests	890	Before the fork, IO::AIO enters a quiescent state where no requests
539	can be added in other threads and no results will be processed. After	891	can be added in other threads and no results will be processed. After
540	the fork the parent simply leaves the quiescent state and continues	892	the fork the parent simply leaves the quiescent state and continues
541	request/result processing, while the child clears the request/result	893	request/result processing, while the child clears the request/result
542	queue (so the requests started before the fork will only be handled in	894	queue (so the requests started before the fork will only be handled in
543	the parent). Threats will be started on demand until the limit ste in the	895	the parent). Threads will be started on demand until the limit ste in the
544	parent process has been reached again.	896	parent process has been reached again.
545		897
		898	In short: the parent will, after a short pause, continue as if fork had
		899	not been called, while the child will act as if IO::AIO has not been used
		900	yet.
		901
		902	=head2 MEMORY USAGE
		903
		904	Each aio request uses - depending on your architecture - around 128 bytes
		905	of memory. In addition, stat requests need a stat buffer (possibly a few
		906	hundred bytes). Perl scalars and other data passed into aio requests will
		907	also be locked.
		908
		909	This is now awfully much, so queuing lots of requests is not usually a
		910	problem.
		911
		912	Each thread needs a stack area which is usually around 16k, sometimes much
		913	larger, depending on the OS.
		914
546	=head1 SEE ALSO	915	=head1 SEE ALSO
547		916
548	L<Coro>, L<Linux::AIO>.	917	L<Coro::AIO>.
549		918
550	=head1 AUTHOR	919	=head1 AUTHOR
551		920
552	Marc Lehmann <schmorp@schmorp.de>	921	Marc Lehmann <schmorp@schmorp.de>
553	http://home.schmorp.de/	922	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.42 by root, Mon Dec 26 18:15:23 2005 UTC vs. Revision 1.71 by root, Tue Oct 24 11:57:30 2006 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.42 by root, Mon Dec 26 18:15:23 2005 UTC vs.
Revision 1.71 by root, Tue Oct 24 11:57:30 2006 UTC