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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.63 by root, Mon Oct 23 00:34:36 2006 UTC vs.
Revision 1.86 by root, Sat Oct 28 23:32:29 2006 UTC

…		…
18	};	18	};
19		19
20	# version 2+ has request and group objects	20	# version 2+ has request and group objects
21	use IO::AIO 2;	21	use IO::AIO 2;
22		22
		23	aioreq_pri 4; # give next request a very high priority
23	my $req = aio_unlink "/tmp/file", sub { };	24	my $req = aio_unlink "/tmp/file", sub { };
24	$req->cancel; # cancel request if still in queue	25	$req->cancel; # cancel request if still in queue
25		26
26	my $grp = aio_group sub { print "all stats done\n" };	27	my $grp = aio_group sub { print "all stats done\n" };
27	add $grp aio_stat "..." for ...;	28	add $grp aio_stat "..." for ...;
…		…
50	=head1 DESCRIPTION	51	=head1 DESCRIPTION
51		52
52	This module implements asynchronous I/O using whatever means your	53	This module implements asynchronous I/O using whatever means your
53	operating system supports.	54	operating system supports.
54		55
		56	Asynchronous means that operations that can normally block your program
		57	(e.g. reading from disk) will be done asynchronously: the operation
		58	will still block, but you can do something else in the meantime. This
		59	is extremely useful for programs that need to stay interactive even
		60	when doing heavy I/O (GUI programs, high performance network servers
		61	etc.), but can also be used to easily do operations in parallel that are
		62	normally done sequentially, e.g. stat'ing many files, which is much faster
		63	on a RAID volume or over NFS when you do a number of stat operations
		64	concurrently.
		65
		66	While this works on all types of file descriptors (for example sockets),
		67	using these functions on file descriptors that support nonblocking
		68	operation (again, sockets, pipes etc.) is very inefficient. Use an event
		69	loop for that (such as the L<Event\|Event> module): IO::AIO will naturally
		70	fit into such an event loop itself.
		71
55	Currently, a number of threads are started that execute your read/writes	72	In this version, a number of threads are started that execute your
56	and signal their completion. You don't need thread support in your libc or	73	requests and signal their completion. You don't need thread support
57	perl, and the threads created by this module will not be visible to the	74	in perl, and the threads created by this module will not be visible
58	pthreads library. In the future, this module might make use of the native	75	to perl. In the future, this module might make use of the native aio
59	aio functions available on many operating systems. However, they are often	76	functions available on many operating systems. However, they are often
60	not well-supported (Linux doesn't allow them on normal files currently,	77	not well-supported or restricted (GNU/Linux doesn't allow them on normal
61	for example), and they would only support aio_read and aio_write, so the	78	files currently, for example), and they would only support aio_read and
62	remaining functionality would have to be implemented using threads anyway.	79	aio_write, so the remaining functionality would have to be implemented
		80	using threads anyway.
63		81
64	Although the module will work with in the presence of other threads, it is	82	Although the module will work with in the presence of other (Perl-)
65	currently not reentrant, so use appropriate locking yourself, always call	83	threads, it is currently not reentrant in any way, so use appropriate
66	C<poll_cb> from within the same thread, or never call C<poll_cb> (or other	84	locking yourself, always call C<poll_cb> from within the same thread, or
67	C<aio_> functions) recursively.	85	never call C<poll_cb> (or other C<aio_> functions) recursively.
		86
		87	=head2 EXAMPLE
		88
		89	This is a simple example that uses the Event module and loads
		90	F</etc/passwd> asynchronously:
		91
		92	use Fcntl;
		93	use Event;
		94	use IO::AIO;
		95
		96	# register the IO::AIO callback with Event
		97	Event->io (fd => IO::AIO::poll_fileno,
		98	poll => 'r',
		99	cb => \&IO::AIO::poll_cb);
		100
		101	# queue the request to open /etc/passwd
		102	aio_open "/etc/passwd", O_RDONLY, 0, sub {
		103	my $fh = $_[0]
		104	or die "error while opening: $!";
		105
		106	# stat'ing filehandles is generally non-blocking
		107	my $size = -s $fh;
		108
		109	# queue a request to read the file
		110	my $contents;
		111	aio_read $fh, 0, $size, $contents, 0, sub {
		112	$_[0] == $size
		113	or die "short read: $!";
		114
		115	close $fh;
		116
		117	# file contents now in $contents
		118	print $contents;
		119
		120	# exit event loop and program
		121	Event::unloop;
		122	};
		123	};
		124
		125	# possibly queue up other requests, or open GUI windows,
		126	# check for sockets etc. etc.
		127
		128	# process events as long as there are some:
		129	Event::loop;
		130
		131	=head1 REQUEST ANATOMY AND LIFETIME
		132
		133	Every C<aio_*> function creates a request. which is a C data structure not
		134	directly visible to Perl.
		135
		136	If called in non-void context, every request function returns a Perl
		137	object representing the request. In void context, nothing is returned,
		138	which saves a bit of memory.
		139
		140	The perl object is a fairly standard ref-to-hash object. The hash contents
		141	are not used by IO::AIO so you are free to store anything you like in it.
		142
		143	During their existance, aio requests travel through the following states,
		144	in order:
		145
		146	=over 4
		147
		148	=item ready
		149
		150	Immediately after a request is created it is put into the ready state,
		151	waiting for a thread to execute it.
		152
		153	=item execute
		154
		155	A thread has accepted the request for processing and is currently
		156	executing it (e.g. blocking in read).
		157
		158	=item pending
		159
		160	The request has been executed and is waiting for result processing.
		161
		162	While request submission and execution is fully asynchronous, result
		163	processing is not and relies on the perl interpreter calling C<poll_cb>
		164	(or another function with the same effect).
		165
		166	=item result
		167
		168	The request results are processed synchronously by C<poll_cb>.
		169
		170	The C<poll_cb> function will process all outstanding aio requests by
		171	calling their callbacks, freeing memory associated with them and managing
		172	any groups they are contained in.
		173
		174	=item done
		175
		176	Request has reached the end of its lifetime and holds no resources anymore
		177	(except possibly for the Perl object, but its connection to the actual
		178	aio request is severed and calling its methods will either do nothing or
		179	result in a runtime error).
68		180
69	=cut	181	=cut
70		182
71	package IO::AIO;	183	package IO::AIO;
72		184
…		…
74	use strict 'vars';	186	use strict 'vars';
75		187
76	use base 'Exporter';	188	use base 'Exporter';
77		189
78	BEGIN {	190	BEGIN {
79	our $VERSION = '2.0';	191	our $VERSION = '2.1';
80		192
81	our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	193	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
82	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	194	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
83	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	195	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move
84	aio_group aio_nop);	196	aio_copy aio_group aio_nop aio_mknod);
85	our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs);	197	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
		198	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
		199	min_parallel max_parallel max_idle
		200	nreqs nready npending nthreads
		201	max_poll_time max_poll_reqs);
86		202
87	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	203	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
88		204
89	require XSLoader;	205	require XSLoader;
90	XSLoader::load ("IO::AIO", $VERSION);	206	XSLoader::load ("IO::AIO", $VERSION);
…		…
121	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	237	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
122	use something else.	238	use something else.
123		239
124	=over 4	240	=over 4
125		241
		242	=item $prev_pri = aioreq_pri [$pri]
		243
		244	Returns the priority value that would be used for the next request and, if
		245	C<$pri> is given, sets the priority for the next aio request.
		246
		247	The default priority is C<0>, the minimum and maximum priorities are C<-4>
		248	and C<4>, respectively. Requests with higher priority will be serviced
		249	first.
		250
		251	The priority will be reset to C<0> after each call to one of the C<aio_*>
		252	functions.
		253
		254	Example: open a file with low priority, then read something from it with
		255	higher priority so the read request is serviced before other low priority
		256	open requests (potentially spamming the cache):
		257
		258	aioreq_pri -3;
		259	aio_open ..., sub {
		260	return unless $_[0];
		261
		262	aioreq_pri -2;
		263	aio_read $_[0], ..., sub {
		264	...
		265	};
		266	};
		267
		268	=item aioreq_nice $pri_adjust
		269
		270	Similar to C<aioreq_pri>, but subtracts the given value from the current
		271	priority, so effects are cumulative.
		272
126	=item aio_open $pathname, $flags, $mode, $callback->($fh)	273	=item aio_open $pathname, $flags, $mode, $callback->($fh)
127		274
128	Asynchronously open or create a file and call the callback with a newly	275	Asynchronously open or create a file and call the callback with a newly
129	created filehandle for the file.	276	created filehandle for the file.
130		277
…		…
179		326
180	aio_read $fh, 7, 15, $buffer, 0, sub {	327	aio_read $fh, 7, 15, $buffer, 0, sub {
181	$_[0] > 0 or die "read error: $!";	328	$_[0] > 0 or die "read error: $!";
182	print "read $_[0] bytes: <$buffer>\n";	329	print "read $_[0] bytes: <$buffer>\n";
183	};	330	};
184
185	=item aio_move $srcpath, $dstpath, $callback->($status)
186
187	[EXPERIMENTAL due to internal aio_group use]
188
189	Try to move the I<file> (directories not supported as either source or
190	destination) from C<$srcpath> to C<$dstpath> and call the callback with
191	the C<0> (error) or C<-1> ok.
192
193	This is a composite request that tries to rename(2) the file first. If
194	rename files with C<EXDEV>, it creates the destination file with mode 0200
195	and copies the contents of the source file into it using C<aio_sendfile>,
196	followed by restoring atime, mtime, access mode and uid/gid, in that
197	order, and unlinking the C<$srcpath>.
198
199	If an error occurs, the partial destination file will be unlinked, if
200	possible, except when setting atime, mtime, access mode and uid/gid, where
201	errors are being ignored.
202
203	=cut
204
205	sub aio_move($$$) {
206	my ($src, $dst, $cb) = @_;
207
208	my $grp = aio_group $cb;
209
210	add $grp aio_rename $src, $dst, sub {
211	if ($_[0] && $! == EXDEV) {
212	add $grp aio_open $src, O_RDONLY, 0, sub {
213	if (my $src_fh = $_[0]) {
214	my @stat = stat $src_fh;
215
216	add $grp aio_open $dst, O_WRONLY, 0200, sub {
217	if (my $dst_fh = $_[0]) {
218	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
219	close $src_fh;
220
221	if ($_[0] == $stat[7]) {
222	utime $stat[8], $stat[9], $dst;
223	chmod $stat[2] & 07777, $dst_fh;
224	chown $stat[4], $stat[5], $dst_fh;
225	close $dst_fh;
226
227	add $grp aio_unlink $src, sub {
228	$grp->result ($_[0]);
229	};
230	} else {
231	my $errno = $!;
232	add $grp aio_unlink $dst, sub {
233	$! = $errno;
234	$grp->result (-1);
235	};
236	}
237	};
238	} else {
239	$grp->result (-1);
240	}
241	},
242
243	} else {
244	$grp->result (-1);
245	}
246	};
247	} else {
248	$grp->result ($_[0]);
249	}
250	};
251
252	$grp
253	}
254		331
255	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	332	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
256		333
257	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	334	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
258	reading at byte offset C<$in_offset>, and starts writing at the current	335	reading at byte offset C<$in_offset>, and starts writing at the current
…		…
314	=item aio_unlink $pathname, $callback->($status)	391	=item aio_unlink $pathname, $callback->($status)
315		392
316	Asynchronously unlink (delete) a file and call the callback with the	393	Asynchronously unlink (delete) a file and call the callback with the
317	result code.	394	result code.
318		395
		396	=item aio_mknod $path, $mode, $dev, $callback->($status)
		397
		398	[EXPERIMENTAL]
		399
		400	Asynchronously create a device node (or fifo). See mknod(2).
		401
		402	The only (POSIX-) portable way of calling this function is:
		403
		404	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
		405
319	=item aio_link $srcpath, $dstpath, $callback->($status)	406	=item aio_link $srcpath, $dstpath, $callback->($status)
320		407
321	Asynchronously create a new link to the existing object at C<$srcpath> at	408	Asynchronously create a new link to the existing object at C<$srcpath> at
322	the path C<$dstpath> and call the callback with the result code.	409	the path C<$dstpath> and call the callback with the result code.
323		410
…		…
343	sorted, and will B<NOT> include the C<.> and C<..> entries.	430	sorted, and will B<NOT> include the C<.> and C<..> entries.
344		431
345	The callback a single argument which is either C<undef> or an array-ref	432	The callback a single argument which is either C<undef> or an array-ref
346	with the filenames.	433	with the filenames.
347		434
		435	=item aio_copy $srcpath, $dstpath, $callback->($status)
		436
		437	Try to copy the I<file> (directories not supported as either source or
		438	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		439	the C<0> (error) or C<-1> ok.
		440
		441	This is a composite request that it creates the destination file with
		442	mode 0200 and copies the contents of the source file into it using
		443	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
		444	uid/gid, in that order.
		445
		446	If an error occurs, the partial destination file will be unlinked, if
		447	possible, except when setting atime, mtime, access mode and uid/gid, where
		448	errors are being ignored.
		449
		450	=cut
		451
		452	sub aio_copy($$;$) {
		453	my ($src, $dst, $cb) = @_;
		454
		455	my $pri = aioreq_pri;
		456	my $grp = aio_group $cb;
		457
		458	aioreq_pri $pri;
		459	add $grp aio_open $src, O_RDONLY, 0, sub {
		460	if (my $src_fh = $_[0]) {
		461	my @stat = stat $src_fh;
		462
		463	aioreq_pri $pri;
		464	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
		465	if (my $dst_fh = $_[0]) {
		466	aioreq_pri $pri;
		467	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
		468	if ($_[0] == $stat[7]) {
		469	$grp->result (0);
		470	close $src_fh;
		471
		472	# those should not normally block. should. should.
		473	utime $stat[8], $stat[9], $dst;
		474	chmod $stat[2] & 07777, $dst_fh;
		475	chown $stat[4], $stat[5], $dst_fh;
		476	close $dst_fh;
		477	} else {
		478	$grp->result (-1);
		479	close $src_fh;
		480	close $dst_fh;
		481
		482	aioreq $pri;
		483	add $grp aio_unlink $dst;
		484	}
		485	};
		486	} else {
		487	$grp->result (-1);
		488	}
		489	},
		490
		491	} else {
		492	$grp->result (-1);
		493	}
		494	};
		495
		496	$grp
		497	}
		498
		499	=item aio_move $srcpath, $dstpath, $callback->($status)
		500
		501	Try to move the I<file> (directories not supported as either source or
		502	destination) from C<$srcpath> to C<$dstpath> and call the callback with
		503	the C<0> (error) or C<-1> ok.
		504
		505	This is a composite request that tries to rename(2) the file first. If
		506	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
		507	that is successful, unlinking the C<$srcpath>.
		508
		509	=cut
		510
		511	sub aio_move($$;$) {
		512	my ($src, $dst, $cb) = @_;
		513
		514	my $pri = aioreq_pri;
		515	my $grp = aio_group $cb;
		516
		517	aioreq_pri $pri;
		518	add $grp aio_rename $src, $dst, sub {
		519	if ($_[0] && $! == EXDEV) {
		520	aioreq_pri $pri;
		521	add $grp aio_copy $src, $dst, sub {
		522	$grp->result ($_[0]);
		523
		524	if (!$_[0]) {
		525	aioreq_pri $pri;
		526	add $grp aio_unlink $src;
		527	}
		528	};
		529	} else {
		530	$grp->result ($_[0]);
		531	}
		532	};
		533
		534	$grp
		535	}
		536
348	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	537	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
349		538
350	[EXPERIMENTAL due to internal aio_group use]
351
352	Scans a directory (similar to C<aio_readdir>) but additionally tries to	539	Scans a directory (similar to C<aio_readdir>) but additionally tries to
353	separate the entries of directory C<$path> into two sets of names, ones	540	efficiently separate the entries of directory C<$path> into two sets of
354	you can recurse into (directories or links to them), and ones you cannot	541	names, directories you can recurse into (directories), and ones you cannot
355	recurse into (everything else).	542	recurse into (everything else, including symlinks to directories).
356		543
357	C<aio_scandir> is a composite request that creates of many sub requests_	544	C<aio_scandir> is a composite request that creates of many sub requests_
358	C<$maxreq> specifies the maximum number of outstanding aio requests that	545	C<$maxreq> specifies the maximum number of outstanding aio requests that
359	this function generates. If it is C<< <= 0 >>, then a suitable default	546	this function generates. If it is C<< <= 0 >>, then a suitable default
360	will be chosen (currently 6).	547	will be chosen (currently 4).
361		548
362	On error, the callback is called without arguments, otherwise it receives	549	On error, the callback is called without arguments, otherwise it receives
363	two array-refs with path-relative entry names.	550	two array-refs with path-relative entry names.
364		551
365	Example:	552	Example:
…		…
402	=cut	589	=cut
403		590
404	sub aio_scandir($$$) {	591	sub aio_scandir($$$) {
405	my ($path, $maxreq, $cb) = @_;	592	my ($path, $maxreq, $cb) = @_;
406		593
		594	my $pri = aioreq_pri;
		595
407	my $grp = aio_group $cb;	596	my $grp = aio_group $cb;
408		597
409	$maxreq = 6 if $maxreq <= 0;	598	$maxreq = 4 if $maxreq <= 0;
410		599
411	# stat once	600	# stat once
		601	aioreq_pri $pri;
412	add $grp aio_stat $path, sub {	602	add $grp aio_stat $path, sub {
413	return $grp->result () if $_[0];	603	return $grp->result () if $_[0];
414	my $now = time;	604	my $now = time;
415	my $hash1 = join ":", (stat _)[0,1,3,7,9];	605	my $hash1 = join ":", (stat _)[0,1,3,7,9];
416		606
417	# read the directory entries	607	# read the directory entries
		608	aioreq_pri $pri;
418	add $grp aio_readdir $path, sub {	609	add $grp aio_readdir $path, sub {
419	my $entries = shift	610	my $entries = shift
420	or return $grp->result ();	611	or return $grp->result ();
421		612
422	# stat the dir another time	613	# stat the dir another time
		614	aioreq_pri $pri;
423	add $grp aio_stat $path, sub {	615	add $grp aio_stat $path, sub {
424	my $hash2 = join ":", (stat _)[0,1,3,7,9];	616	my $hash2 = join ":", (stat _)[0,1,3,7,9];
425		617
426	my $ndirs;	618	my $ndirs;
427		619
…		…
442	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],	634	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
443	@$entries];	635	@$entries];
444		636
445	my (@dirs, @nondirs);	637	my (@dirs, @nondirs);
446		638
447	my ($statcb, $schedcb);
448	my $nreq = 0;
449
450	my $statgrp = add $grp aio_group;	639	my $statgrp = add $grp aio_group sub {
		640	$grp->result (\@dirs, \@nondirs);
		641	};
451		642
452	$schedcb = sub {	643	limit $statgrp $maxreq;
453	if (@$entries) {	644	feed $statgrp sub {
454	if ($nreq < $maxreq) {	645	return unless @$entries;
455	my $ent = pop @$entries;	646	my $entry = pop @$entries;
		647
		648	aioreq_pri $pri;
		649	add $statgrp aio_stat "$path/$entry/.", sub {
		650	if ($_[0] < 0) {
		651	push @nondirs, $entry;
		652	} else {
		653	# need to check for real directory
		654	aioreq_pri $pri;
		655	add $statgrp aio_lstat "$path/$entry", sub {
		656	if (-d _) {
		657	push @dirs, $entry;
		658
		659	unless (--$ndirs) {
		660	push @nondirs, @$entries;
		661	feed $statgrp;
		662	}
		663	} else {
		664	push @nondirs, $entry;
		665	}
456	$nreq++;	666	}
457	add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
458	}	667	}
459	} elsif (!$nreq) {
460	# finished
461	$statgrp->cancel;
462	undef $statcb;
463	undef $schedcb;
464	$grp->result (\@dirs, \@nondirs);
465	}	668	};
466	};	669	};
467	$statcb = sub {
468	my ($status, $entry) = @_;
469
470	if ($status < 0) {
471	$nreq--;
472	push @nondirs, $entry;
473	&$schedcb;
474	} else {
475	# need to check for real directory
476	add $grp aio_lstat "$path/$entry", sub {
477	$nreq--;
478
479	if (-d _) {
480	push @dirs, $entry;
481
482	if (!--$ndirs) {
483	push @nondirs, @$entries;
484	$entries = [];
485	}
486	} else {
487	push @nondirs, $entry;
488	}
489
490	&$schedcb;
491	}
492	}
493	};
494
495	&$schedcb while @$entries && $nreq < $maxreq;
496	};	670	};
497	};	671	};
498	};	672	};
499		673
500	$grp	674	$grp
…		…
513	If this call isn't available because your OS lacks it or it couldn't be	687	If this call isn't available because your OS lacks it or it couldn't be
514	detected, it will be emulated by calling C<fsync> instead.	688	detected, it will be emulated by calling C<fsync> instead.
515		689
516	=item aio_group $callback->(...)	690	=item aio_group $callback->(...)
517		691
518	[EXPERIMENTAL]
519
520	This is a very special aio request: Instead of doing something, it is a	692	This is a very special aio request: Instead of doing something, it is a
521	container for other aio requests, which is useful if you want to bundle	693	container for other aio requests, which is useful if you want to bundle
522	many requests into a single, composite, request.	694	many requests into a single, composite, request with a definite callback
		695	and the ability to cancel the whole request with its subrequests.
523		696
524	Returns an object of class L<IO::AIO::GRP>. See its documentation below	697	Returns an object of class L<IO::AIO::GRP>. See its documentation below
525	for more info.	698	for more info.
526		699
527	Example:	700	Example:
…		…
540	This is a special request - it does nothing in itself and is only used for	713	This is a special request - it does nothing in itself and is only used for
541	side effects, such as when you want to add a dummy request to a group so	714	side effects, such as when you want to add a dummy request to a group so
542	that finishing the requests in the group depends on executing the given	715	that finishing the requests in the group depends on executing the given
543	code.	716	code.
544		717
		718	While this request does nothing, it still goes through the execution
		719	phase and still requires a worker thread. Thus, the callback will not
		720	be executed immediately but only after other requests in the queue have
		721	entered their execution phase. This can be used to measure request
		722	latency.
		723
545	=item IO::AIO::aio_sleep $fractional_seconds, $callback->() NOT EXPORTED	724	=item IO::AIO::aio_busy $fractional_seconds, $callback->() NOT EXPORTED
546		725
547	Mainly used for debugging and benchmarking, this aio request puts one of	726	Mainly used for debugging and benchmarking, this aio request puts one of
548	the request workers to sleep for the given time.	727	the request workers to sleep for the given time.
549		728
550	While it is theoretically handy to have simple I/O scheduling requests	729	While it is theoretically handy to have simple I/O scheduling requests
551	like sleep and file handle readable/writable, the overhead this creates	730	like sleep and file handle readable/writable, the overhead this creates is
552	is immense, so do not use this function except to put your application	731	immense (it blocks a thread for a long time) so do not use this function
553	under artificial I/O pressure.	732	except to put your application under artificial I/O pressure.
554		733
555	=back	734	=back
556		735
557	=head2 IO::AIO::REQ CLASS	736	=head2 IO::AIO::REQ CLASS
558		737
559	All non-aggregate C<aio_*> functions return an object of this class when	738	All non-aggregate C<aio_*> functions return an object of this class when
560	called in non-void context.	739	called in non-void context.
561		740
562	A request always moves through the following five states in its lifetime,
563	in order: B<ready> (request has been created, but has not been executed
564	yet), B<execute> (request is currently being executed), B<pending>
565	(request has been executed but callback has not been called yet),
566	B<result> (results are being processed synchronously, includes calling the
567	callback) and B<done> (request has reached the end of its lifetime and
568	holds no resources anymore).
569
570	=over 4	741	=over 4
571		742
572	=item $req->cancel	743	=item cancel $req
573		744
574	Cancels the request, if possible. Has the effect of skipping execution	745	Cancels the request, if possible. Has the effect of skipping execution
575	when entering the B<execute> state and skipping calling the callback when	746	when entering the B<execute> state and skipping calling the callback when
576	entering the the B<result> state, but will leave the request otherwise	747	entering the the B<result> state, but will leave the request otherwise
577	untouched. That means that requests that currently execute will not be	748	untouched. That means that requests that currently execute will not be
578	stopped and resources held by the request will not be freed prematurely.	749	stopped and resources held by the request will not be freed prematurely.
579		750
		751	=item cb $req $callback->(...)
		752
		753	Replace (or simply set) the callback registered to the request.
		754
580	=back	755	=back
581		756
582	=head2 IO::AIO::GRP CLASS	757	=head2 IO::AIO::GRP CLASS
583		758
584	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to	759	This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
…		…
623	=item * They can also can also be added to other IO::AIO::GRP objects.	798	=item * They can also can also be added to other IO::AIO::GRP objects.
624		799
625	=item * You must not add requests to a group from within the group callback (or	800	=item * You must not add requests to a group from within the group callback (or
626	any later time).	801	any later time).
627		802
628	=item * This does not harmonise well with C<max_outstanding>, so best do
629	not combine C<aio_group> with it. Groups and feeders are recommended for
630	this kind of concurrency-limiting.
631
632	=back	803	=back
633		804
634	Their lifetime, simplified, looks like this: when they are empty, they	805	Their lifetime, simplified, looks like this: when they are empty, they
635	will finish very quickly. If they contain only requests that are in the	806	will finish very quickly. If they contain only requests that are in the
636	C<done> state, they will also finish. Otherwise they will continue to	807	C<done> state, they will also finish. Otherwise they will continue to
…		…
641	group. And only when all those requests have finished will the the group	812	group. And only when all those requests have finished will the the group
642	itself finish.	813	itself finish.
643		814
644	=over 4	815	=over 4
645		816
		817	=item add $grp ...
		818
646	=item $grp->add (...)	819	=item $grp->add (...)
647
648	=item add $grp ...
649		820
650	Add one or more requests to the group. Any type of L<IO::AIO::REQ> can	821	Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
651	be added, including other groups, as long as you do not create circular	822	be added, including other groups, as long as you do not create circular
652	dependencies.	823	dependencies.
653		824
654	Returns all its arguments.	825	Returns all its arguments.
655		826
		827	=item $grp->cancel_subs
		828
		829	Cancel all subrequests and clears any feeder, but not the group request
		830	itself. Useful when you queued a lot of events but got a result early.
		831
656	=item $grp->result (...)	832	=item $grp->result (...)
657		833
658	Set the result value(s) that will be passed to the group callback when all	834	Set the result value(s) that will be passed to the group callback when all
659	subrequests have finished. By default, no argument will be passed.	835	subrequests have finished and set thre groups errno to the current value
		836	of errno (just like calling C<errno> without an error number). By default,
		837	no argument will be passed and errno is zero.
660		838
661	=item $grp->set_feeder ($callback->($grp))	839	=item $grp->errno ([$errno])
662		840
663	[VERY EXPERIMENTAL]	841	Sets the group errno value to C<$errno>, or the current value of errno
		842	when the argument is missing.
		843
		844	Every aio request has an associated errno value that is restored when
		845	the callback is invoked. This method lets you change this value from its
		846	default (0).
		847
		848	Calling C<result> will also set errno, so make sure you either set C<$!>
		849	before the call to C<result>, or call c<errno> after it.
		850
		851	=item feed $grp $callback->($grp)
664		852
665	Sets a feeder/generator on this group: every group can have an attached	853	Sets a feeder/generator on this group: every group can have an attached
666	generator that generates requests if idle. The idea behind this is that,	854	generator that generates requests if idle. The idea behind this is that,
667	although you could just queue as many requests as you want in a group,	855	although you could just queue as many requests as you want in a group,
668	this might starve other requests for a potentially long time. For	856	this might starve other requests for a potentially long time. For
669	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	857	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
670	requests, delaying any later requests for a long time.	858	requests, delaying any later requests for a long time.
671		859
672	To avoid this, and allow incremental generation of requests, you can	860	To avoid this, and allow incremental generation of requests, you can
673	instead a group and set a feeder on it that generates those requests. The	861	instead a group and set a feeder on it that generates those requests. The
674	feeder will be called whenever there are few enough (see C<feeder_limit>,	862	feed callback will be called whenever there are few enough (see C<limit>,
675	below) requests active in the group itself and is expected to queue more	863	below) requests active in the group itself and is expected to queue more
676	requests.	864	requests.
677		865
678	The feeder can queue as many requests as it likes (i.e. C<add> does not	866	The feed callback can queue as many requests as it likes (i.e. C<add> does
679	impose any limits).	867	not impose any limits).
680		868
681	If the feeder does not queue more requests when called, it will be	869	If the feed does not queue more requests when called, it will be
682	automatically removed from the group.	870	automatically removed from the group.
683		871
684	If the feeder limit is C<0>, it will be set to C<2> automatically.	872	If the feed limit is C<0>, it will be set to C<2> automatically.
685		873
686	Example:	874	Example:
687		875
688	# stat all files in @files, but only ever use four aio requests concurrently:	876	# stat all files in @files, but only ever use four aio requests concurrently:
689		877
690	my $grp = aio_group sub { print "finished\n" };	878	my $grp = aio_group sub { print "finished\n" };
691	$grp->feeder_limit (4);	879	limit $grp 4;
692	$grp->set_feeder (sub {	880	feed $grp sub {
693	my $file = pop @files	881	my $file = pop @files
694	or return;	882	or return;
695		883
696	add $grp aio_stat $file, sub { ... };	884	add $grp aio_stat $file, sub { ... };
697	});	885	};
698		886
699	=item $grp->feeder_limit ($num)	887	=item limit $grp $num
700		888
701	Sets the feeder limit for the group: The feeder will be called whenever	889	Sets the feeder limit for the group: The feeder will be called whenever
702	the group contains less than this many requests.	890	the group contains less than this many requests.
703		891
704	Setting the limit to C<0> will pause the feeding process.	892	Setting the limit to C<0> will pause the feeding process.
705		893
706	=back	894	=back
707		895
708	=head2 SUPPORT FUNCTIONS	896	=head2 SUPPORT FUNCTIONS
		897
		898	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
709		899
710	=over 4	900	=over 4
711		901
712	=item $fileno = IO::AIO::poll_fileno	902	=item $fileno = IO::AIO::poll_fileno
713		903
…		…
718		908
719	See C<poll_cb> for an example.	909	See C<poll_cb> for an example.
720		910
721	=item IO::AIO::poll_cb	911	=item IO::AIO::poll_cb
722		912
723	Process all outstanding events on the result pipe. You have to call this	913	Process some outstanding events on the result pipe. You have to call this
724	regularly. Returns the number of events processed. Returns immediately	914	regularly. Returns the number of events processed. Returns immediately
725	when no events are outstanding.	915	when no events are outstanding. The amount of events processed depends on
		916	the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
		917
		918	If not all requests were processed for whatever reason, the filehandle
		919	will still be ready when C<poll_cb> returns.
726		920
727	Example: Install an Event watcher that automatically calls	921	Example: Install an Event watcher that automatically calls
728	IO::AIO::poll_cb with high priority:	922	IO::AIO::poll_cb with high priority:
729		923
730	Event->io (fd => IO::AIO::poll_fileno,	924	Event->io (fd => IO::AIO::poll_fileno,
731	poll => 'r', async => 1,	925	poll => 'r', async => 1,
732	cb => \&IO::AIO::poll_cb);	926	cb => \&IO::AIO::poll_cb);
733		927
		928	=item IO::AIO::max_poll_reqs $nreqs
		929
		930	=item IO::AIO::max_poll_time $seconds
		931
		932	These set the maximum number of requests (default C<0>, meaning infinity)
		933	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		934	the maximum amount of time (default C<0>, meaning infinity) spent in
		935	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		936	of time C<poll_cb> is allowed to use).
		937
		938	Setting these is useful if you want to ensure some level of
		939	interactiveness when perl is not fast enough to process all requests in
		940	time.
		941
		942	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
		943
		944	Example: Install an Event watcher that automatically calls
		945	IO::AIO::poll_some with low priority, to ensure that other parts of the
		946	program get the CPU sometimes even under high AIO load.
		947
		948	# try not to spend much more than 0.1s in poll_cb
		949	IO::AIO::max_poll_time 0.1;
		950
		951	# use a low priority so other tasks have priority
		952	Event->io (fd => IO::AIO::poll_fileno,
		953	poll => 'r', nice => 1,
		954	cb => &IO::AIO::poll_cb);
		955
734	=item IO::AIO::poll_wait	956	=item IO::AIO::poll_wait
735		957
736	Wait till the result filehandle becomes ready for reading (simply does a	958	Wait till the result filehandle becomes ready for reading (simply does a
737	C<select> on the filehandle. This is useful if you want to synchronously wait	959	C<select> on the filehandle. This is useful if you want to synchronously
738	for some requests to finish).	960	wait for some requests to finish).
739		961
740	See C<nreqs> for an example.	962	See C<nreqs> for an example.
741		963
		964	=item IO::AIO::poll
		965
		966	Waits until some requests have been handled.
		967
		968	Strictly equivalent to:
		969
		970	IO::AIO::poll_wait, IO::AIO::poll_cb
		971	if IO::AIO::nreqs;
		972
742	=item IO::AIO::nreqs	973	=item IO::AIO::flush
743		974
744	Returns the number of requests currently outstanding (i.e. for which their	975	Wait till all outstanding AIO requests have been handled.
745	callback has not been invoked yet).
746		976
747	Example: wait till there are no outstanding requests anymore:	977	Strictly equivalent to:
748		978
749	IO::AIO::poll_wait, IO::AIO::poll_cb	979	IO::AIO::poll_wait, IO::AIO::poll_cb
750	while IO::AIO::nreqs;	980	while IO::AIO::nreqs;
751		981
752	=item IO::AIO::flush	982	=head3 CONTROLLING THE NUMBER OF THREADS
753
754	Wait till all outstanding AIO requests have been handled.
755
756	Strictly equivalent to:
757
758	IO::AIO::poll_wait, IO::AIO::poll_cb
759	while IO::AIO::nreqs;
760
761	=item IO::AIO::poll
762
763	Waits until some requests have been handled.
764
765	Strictly equivalent to:
766
767	IO::AIO::poll_wait, IO::AIO::poll_cb
768	if IO::AIO::nreqs;
769		983
770	=item IO::AIO::min_parallel $nthreads	984	=item IO::AIO::min_parallel $nthreads
771		985
772	Set the minimum number of AIO threads to C<$nthreads>. The current	986	Set the minimum number of AIO threads to C<$nthreads>. The current
773	default is C<8>, which means eight asynchronous operations can execute	987	default is C<8>, which means eight asynchronous operations can execute
774	concurrently at any one time (the number of outstanding requests,	988	concurrently at any one time (the number of outstanding requests,
775	however, is unlimited).	989	however, is unlimited).
776		990
777	IO::AIO starts threads only on demand, when an AIO request is queued and	991	IO::AIO starts threads only on demand, when an AIO request is queued and
778	no free thread exists.	992	no free thread exists. Please note that queueing up a hundred requests can
		993	create demand for a hundred threads, even if it turns out that everything
		994	is in the cache and could have been processed faster by a single thread.
779		995
780	It is recommended to keep the number of threads relatively low, as some	996	It is recommended to keep the number of threads relatively low, as some
781	Linux kernel versions will scale negatively with the number of threads	997	Linux kernel versions will scale negatively with the number of threads
782	(higher parallelity => MUCH higher latency). With current Linux 2.6	998	(higher parallelity => MUCH higher latency). With current Linux 2.6
783	versions, 4-32 threads should be fine.	999	versions, 4-32 threads should be fine.
…		…
797	This module automatically runs C<max_parallel 0> at program end, to ensure	1013	This module automatically runs C<max_parallel 0> at program end, to ensure
798	that all threads are killed and that there are no outstanding requests.	1014	that all threads are killed and that there are no outstanding requests.
799		1015
800	Under normal circumstances you don't need to call this function.	1016	Under normal circumstances you don't need to call this function.
801		1017
		1018	=item IO::AIO::max_idle $nthreads
		1019
		1020	Limit the number of threads (default: 4) that are allowed to idle (i.e.,
		1021	threads that did not get a request to process within 10 seconds). That
		1022	means if a thread becomes idle while C<$nthreads> other threads are also
		1023	idle, it will free its resources and exit.
		1024
		1025	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1026	to allow for extremely high load situations, but want to free resources
		1027	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1028
		1029	The default is probably ok in most situations, especially if thread
		1030	creation is fast. If thread creation is very slow on your system you might
		1031	want to use larger values.
		1032
802	=item $oldnreqs = IO::AIO::max_outstanding $nreqs	1033	=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
803		1034
804	[DEPRECATED]	1035	This is a very bad function to use in interactive programs because it
		1036	blocks, and a bad way to reduce concurrency because it is inexact: Better
		1037	use an C<aio_group> together with a feed callback.
805		1038
806	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1039	Sets the maximum number of outstanding requests to C<$nreqs>. If you
807	try to queue up more than this number of requests, the caller will block until	1040	to queue up more than this number of requests, the next call to the
808	some requests have been handled.	1041	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
		1042	function will block until the limit is no longer exceeded.
809		1043
810	The default is very large, so normally there is no practical limit. If you	1044	The default value is very large, so there is no practical limit on the
811	queue up many requests in a loop it often improves speed if you set	1045	number of outstanding requests.
812	this to a relatively low number, such as C<100>.
813		1046
814	This function does not work well together with C<aio_group>'s, and their	1047	You can still queue as many requests as you want. Therefore,
815	feeder interface is better suited to limiting concurrency, so do not use	1048	C<max_oustsanding> is mainly useful in simple scripts (with low values) or
816	this function.	1049	as a stop gap to shield against fatal memory overflow (with large values).
817		1050
818	Under normal circumstances you don't need to call this function.	1051	=head3 STATISTICAL INFORMATION
		1052
		1053	=item IO::AIO::nreqs
		1054
		1055	Returns the number of requests currently in the ready, execute or pending
		1056	states (i.e. for which their callback has not been invoked yet).
		1057
		1058	Example: wait till there are no outstanding requests anymore:
		1059
		1060	IO::AIO::poll_wait, IO::AIO::poll_cb
		1061	while IO::AIO::nreqs;
		1062
		1063	=item IO::AIO::nready
		1064
		1065	Returns the number of requests currently in the ready state (not yet
		1066	executed).
		1067
		1068	=item IO::AIO::npending
		1069
		1070	Returns the number of requests currently in the pending state (executed,
		1071	but not yet processed by poll_cb).
819		1072
820	=back	1073	=back
821		1074
822	=cut	1075	=cut
823		1076
…		…
838	}	1091	}
839		1092
840	min_parallel 8;	1093	min_parallel 8;
841		1094
842	END {	1095	END {
843	max_parallel 0;	1096	min_parallel 1;
844	}	1097	flush;
		1098	};
845		1099
846	1;	1100	1;
847		1101
848	=head2 FORK BEHAVIOUR	1102	=head2 FORK BEHAVIOUR
849		1103
850	This module should do "the right thing" when the process using it forks:	1104	This module should do "the right thing" when the process using it forks:
851		1105
852	Before the fork, IO::AIO enters a quiescent state where no requests	1106	Before the fork, IO::AIO enters a quiescent state where no requests
853	can be added in other threads and no results will be processed. After	1107	can be added in other threads and no results will be processed. After
854	the fork the parent simply leaves the quiescent state and continues	1108	the fork the parent simply leaves the quiescent state and continues
855	request/result processing, while the child clears the request/result	1109	request/result processing, while the child frees the request/result queue
856	queue (so the requests started before the fork will only be handled in	1110	(so that the requests started before the fork will only be handled in the
857	the parent). Threads will be started on demand until the limit ste in the	1111	parent). Threads will be started on demand until the limit set in the
858	parent process has been reached again.	1112	parent process has been reached again.
859		1113
860	In short: the parent will, after a short pause, continue as if fork had	1114	In short: the parent will, after a short pause, continue as if fork had
861	not been called, while the child will act as if IO::AIO has not been used	1115	not been called, while the child will act as if IO::AIO has not been used
862	yet.	1116	yet.
863		1117
864	=head2 MEMORY USAGE	1118	=head2 MEMORY USAGE
865		1119
		1120	Per-request usage:
		1121
866	Each aio request uses - depending on your architecture - around 128 bytes	1122	Each aio request uses - depending on your architecture - around 100-200
867	of memory. In addition, stat requests need a stat buffer (possibly a few	1123	bytes of memory. In addition, stat requests need a stat buffer (possibly
868	hundred bytes). Perl scalars and other data passed into aio requests will	1124	a few hundred bytes), readdir requires a result buffer and so on. Perl
869	also be locked.	1125	scalars and other data passed into aio requests will also be locked and
		1126	will consume memory till the request has entered the done state.
870		1127
871	This is now awfully much, so queuing lots of requests is not usually a	1128	This is now awfully much, so queuing lots of requests is not usually a
872	problem.	1129	problem.
873		1130
874	Each thread needs a stack area which is usually around 16k, sometimes much	1131	Per-thread usage:
875	larger, depending on the OS.	1132
		1133	In the execution phase, some aio requests require more memory for
		1134	temporary buffers, and each thread requires a stack and other data
		1135	structures (usually around 16k-128k, depending on the OS).
		1136
		1137	=head1 KNOWN BUGS
		1138
		1139	Known bugs will be fixed in the next release.
876		1140
877	=head1 SEE ALSO	1141	=head1 SEE ALSO
878		1142
879	L<Coro>, L<Linux::AIO> (obsolete).	1143	L<Coro::AIO>.
880		1144
881	=head1 AUTHOR	1145	=head1 AUTHOR
882		1146
883	Marc Lehmann <schmorp@schmorp.de>	1147	Marc Lehmann <schmorp@schmorp.de>
884	http://home.schmorp.de/	1148	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.63 by root, Mon Oct 23 00:34:36 2006 UTC vs. Revision 1.86 by root, Sat Oct 28 23:32:29 2006 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.63 by root, Mon Oct 23 00:34:36 2006 UTC vs.
Revision 1.86 by root, Sat Oct 28 23:32:29 2006 UTC