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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.111 by root, Mon Aug 13 12:08:13 2007 UTC vs.
Revision 1.174 by root, Sun Jan 10 20:28:43 2010 UTC

…		…
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30		30
		31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		32	use AnyEvent::AIO;
		33
31	# AnyEvent integration	34	# EV integration
32	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";	35	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34		36
35	# Event integration	37	# Event integration
36	Event->io (fd => IO::AIO::poll_fileno,	38	Event->io (fd => IO::AIO::poll_fileno,
37	poll => 'r',	39	poll => 'r',
38	cb => \&IO::AIO::poll_cb);	40	cb => \&IO::AIO::poll_cb);
…		…
50	\&IO::AIO::poll_cb);	52	\&IO::AIO::poll_cb);
51		53
52	=head1 DESCRIPTION	54	=head1 DESCRIPTION
53		55
54	This module implements asynchronous I/O using whatever means your	56	This module implements asynchronous I/O using whatever means your
55	operating system supports.	57	operating system supports. It is implemented as an interface to C<libeio>
		58	(L<http://software.schmorp.de/pkg/libeio.html>).
56		59
57	Asynchronous means that operations that can normally block your program	60	Asynchronous means that operations that can normally block your program
58	(e.g. reading from disk) will be done asynchronously: the operation	61	(e.g. reading from disk) will be done asynchronously: the operation
59	will still block, but you can do something else in the meantime. This	62	will still block, but you can do something else in the meantime. This
60	is extremely useful for programs that need to stay interactive even	63	is extremely useful for programs that need to stay interactive even
…		…
64	on a RAID volume or over NFS when you do a number of stat operations	67	on a RAID volume or over NFS when you do a number of stat operations
65	concurrently.	68	concurrently.
66		69
67	While most of this works on all types of file descriptors (for	70	While most of this works on all types of file descriptors (for
68	example sockets), using these functions on file descriptors that	71	example sockets), using these functions on file descriptors that
69	support nonblocking operation (again, sockets, pipes etc.) is very	72	support nonblocking operation (again, sockets, pipes etc.) is
70	inefficient. Use an event loop for that (such as the L<Event\|Event>	73	very inefficient. Use an event loop for that (such as the L<EV>
71	module): IO::AIO will naturally fit into such an event loop itself.	74	module): IO::AIO will naturally fit into such an event loop itself.
72		75
73	In this version, a number of threads are started that execute your	76	In this version, a number of threads are started that execute your
74	requests and signal their completion. You don't need thread support	77	requests and signal their completion. You don't need thread support
75	in perl, and the threads created by this module will not be visible	78	in perl, and the threads created by this module will not be visible
…		…
85	yourself, always call C<poll_cb> from within the same thread, or never	88	yourself, always call C<poll_cb> from within the same thread, or never
86	call C<poll_cb> (or other C<aio_> functions) recursively.	89	call C<poll_cb> (or other C<aio_> functions) recursively.
87		90
88	=head2 EXAMPLE	91	=head2 EXAMPLE
89		92
90	This is a simple example that uses the Event module and loads	93	This is a simple example that uses the EV module and loads
91	F</etc/passwd> asynchronously:	94	F</etc/passwd> asynchronously:
92		95
93	use Fcntl;	96	use Fcntl;
94	use Event;	97	use EV;
95	use IO::AIO;	98	use IO::AIO;
96		99
97	# register the IO::AIO callback with Event	100	# register the IO::AIO callback with EV
98	Event->io (fd => IO::AIO::poll_fileno,	101	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
99	poll => 'r',
100	cb => \&IO::AIO::poll_cb);
101		102
102	# queue the request to open /etc/passwd	103	# queue the request to open /etc/passwd
103	aio_open "/etc/passwd", O_RDONLY, 0, sub {	104	aio_open "/etc/passwd", O_RDONLY, 0, sub {
104	my $fh = shift	105	my $fh = shift
105	or die "error while opening: $!";	106	or die "error while opening: $!";
…		…
117		118
118	# file contents now in $contents	119	# file contents now in $contents
119	print $contents;	120	print $contents;
120		121
121	# exit event loop and program	122	# exit event loop and program
122	Event::unloop;	123	EV::unloop;
123	};	124	};
124	};	125	};
125		126
126	# possibly queue up other requests, or open GUI windows,	127	# possibly queue up other requests, or open GUI windows,
127	# check for sockets etc. etc.	128	# check for sockets etc. etc.
128		129
129	# process events as long as there are some:	130	# process events as long as there are some:
130	Event::loop;	131	EV::loop;
131		132
132	=head1 REQUEST ANATOMY AND LIFETIME	133	=head1 REQUEST ANATOMY AND LIFETIME
133		134
134	Every C<aio_*> function creates a request. which is a C data structure not	135	Every C<aio_*> function creates a request. which is a C data structure not
135	directly visible to Perl.	136	directly visible to Perl.
…		…
183		184
184	=cut	185	=cut
185		186
186	package IO::AIO;	187	package IO::AIO;
187		188
188	no warnings;	189	use Carp ();
189	use strict 'vars';	190
		191	use common::sense;
190		192
191	use base 'Exporter';	193	use base 'Exporter';
192		194
193	BEGIN {	195	BEGIN {
194	our $VERSION = '2.4';	196	our $VERSION = '3.5';
195		197
196	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	198	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
197	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	199	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
198	aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link	200	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
		201	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
		202	aio_rename aio_link aio_move aio_copy aio_group
199	aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir	203	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200	aio_chown aio_chmod aio_utime aio_truncate);	204	aio_chmod aio_utime aio_truncate
		205	aio_msync aio_mtouch aio_statvfs);
		206
201	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));	207	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	208	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203	min_parallel max_parallel max_idle	209	min_parallel max_parallel max_idle
204	nreqs nready npending nthreads	210	nreqs nready npending nthreads
205	max_poll_time max_poll_reqs);	211	max_poll_time max_poll_reqs
		212	sendfile fadvise);
		213
		214	push @AIO_REQ, qw(aio_busy); # not exported
206		215
207	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	216	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208		217
209	require XSLoader;	218	require XSLoader;
210	XSLoader::load ("IO::AIO", $VERSION);	219	XSLoader::load ("IO::AIO", $VERSION);
…		…
217	All the C<aio_*> calls are more or less thin wrappers around the syscall	226	All the C<aio_*> calls are more or less thin wrappers around the syscall
218	with the same name (sans C<aio_>). The arguments are similar or identical,	227	with the same name (sans C<aio_>). The arguments are similar or identical,
219	and they all accept an additional (and optional) C<$callback> argument	228	and they all accept an additional (and optional) C<$callback> argument
220	which must be a code reference. This code reference will get called with	229	which must be a code reference. This code reference will get called with
221	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	230	the syscall return code (e.g. most syscalls return C<-1> on error, unlike
222	perl, which usually delivers "false") as it's sole argument when the given	231	perl, which usually delivers "false") as its sole argument after the given
223	syscall has been executed asynchronously.	232	syscall has been executed asynchronously.
224		233
225	All functions expecting a filehandle keep a copy of the filehandle	234	All functions expecting a filehandle keep a copy of the filehandle
226	internally until the request has finished.	235	internally until the request has finished.
227		236
…		…
241	your pathnames to the locale (or other) encoding in effect in the user	250	your pathnames to the locale (or other) encoding in effect in the user
242	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	251	environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243	use something else to ensure your scalar has the correct contents.	252	use something else to ensure your scalar has the correct contents.
244		253
245	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	254	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246	handles correctly wether it is set or not.	255	handles correctly whether it is set or not.
247		256
248	=over 4	257	=over 4
249		258
250	=item $prev_pri = aioreq_pri [$pri]	259	=item $prev_pri = aioreq_pri [$pri]
251		260
…		…
311		320
312		321
313	=item aio_close $fh, $callback->($status)	322	=item aio_close $fh, $callback->($status)
314		323
315	Asynchronously close a file and call the callback with the result	324	Asynchronously close a file and call the callback with the result
316	code. I<WARNING:> although accepted, you should not pass in a perl	325	code.
317	filehandle here, as perl will likely close the file descriptor another
318	time when the filehandle is destroyed. Normally, you can safely call perls
319	C<close> or just let filehandles go out of scope.
320		326
321	This is supposed to be a bug in the API, so that might change. It's	327	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322	therefore best to avoid this function.	328	closing the file descriptor associated with the filehandle itself.
323		329
		330	Therefore, C<aio_close> will not close the filehandle - instead it will
		331	use dup2 to overwrite the file descriptor with the write-end of a pipe
		332	(the pipe fd will be created on demand and will be cached).
		333
		334	Or in other words: the file descriptor will be closed, but it will not be
		335	free for reuse until the perl filehandle is closed.
		336
		337	=cut
324		338
325	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	339	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326		340
327	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	341	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328		342
329	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>	343	Reads or writes C<$length> bytes from or to the specified C<$fh> and
330	into the scalar given by C<$data> and offset C<$dataoffset> and calls the	344	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
331	callback without the actual number of bytes read (or -1 on error, just	345	and calls the callback without the actual number of bytes read (or -1 on
332	like the syscall).	346	error, just like the syscall).
333		347
		348	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		349	offset plus the actual number of bytes read.
		350
334	If C<$offset> is undefined, then the current file offset will be used (and	351	If C<$offset> is undefined, then the current file descriptor offset will
335	updated), otherwise the file offset will not be changed by these calls.	352	be used (and updated), otherwise the file descriptor offset will not be
		353	changed by these calls.
336		354
337	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.	355	If C<$length> is undefined in C<aio_write>, use the remaining length of
		356	C<$data>.
338		357
339	If C<$dataoffset> is less than zero, it will be counted from the end of	358	If C<$dataoffset> is less than zero, it will be counted from the end of
340	C<$data>.	359	C<$data>.
341		360
342	The C<$data> scalar I<MUST NOT> be modified in any way while the request	361	The C<$data> scalar I<MUST NOT> be modified in any way while the request
…		…
362		381
363	This call tries to make use of a native C<sendfile> syscall to provide	382	This call tries to make use of a native C<sendfile> syscall to provide
364	zero-copy operation. For this to work, C<$out_fh> should refer to a	383	zero-copy operation. For this to work, C<$out_fh> should refer to a
365	socket, and C<$in_fh> should refer to mmap'able file.	384	socket, and C<$in_fh> should refer to mmap'able file.
366		385
367	If the native sendfile call fails or is not implemented, it will be	386	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		387	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
368	emulated, so you can call C<aio_sendfile> on any type of filehandle	388	it will be emulated, so you can call C<aio_sendfile> on any type of
369	regardless of the limitations of the operating system.	389	filehandle regardless of the limitations of the operating system.
370		390
371	Please note, however, that C<aio_sendfile> can read more bytes from	391	Please note, however, that C<aio_sendfile> can read more bytes from
372	C<$in_fh> than are written, and there is no way to find out how many	392	C<$in_fh> than are written, and there is no way to find out how many
373	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	393	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
374	provides the number of bytes written to C<$out_fh>. Only if the result	394	provides the number of bytes written to C<$out_fh>. Only if the result
…		…
412	$_[0] and die "stat failed: $!";	432	$_[0] and die "stat failed: $!";
413	print "size is ", -s _, "\n";	433	print "size is ", -s _, "\n";
414	};	434	};
415		435
416		436
		437	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		438
		439	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		440	whether a file handle or path was passed.
		441
		442	On success, the callback is passed a hash reference with the following
		443	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		444	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		445	is passed.
		446
		447	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		448	C<ST_NOSUID>.
		449
		450	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		451	their correct value when available, or to C<0> on systems that do
		452	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		453	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		454	C<ST_NODIRATIME> and C<ST_RELATIME>.
		455
		456	Example: stat C</wd> and dump out the data if successful.
		457
		458	aio_statvfs "/wd", sub {
		459	my $f = $_[0]
		460	or die "statvfs: $!";
		461
		462	use Data::Dumper;
		463	say Dumper $f;
		464	};
		465
		466	# result:
		467	{
		468	bsize => 1024,
		469	bfree => 4333064312,
		470	blocks => 10253828096,
		471	files => 2050765568,
		472	flag => 4096,
		473	favail => 2042092649,
		474	bavail => 4333064312,
		475	ffree => 2042092649,
		476	namemax => 255,
		477	frsize => 1024,
		478	fsid => 1810
		479	}
		480
		481
417	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	482	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
418		483
419	Works like perl's C<utime> function (including the special case of $atime	484	Works like perl's C<utime> function (including the special case of $atime
420	and $mtime being undef). Fractional times are supported if the underlying	485	and $mtime being undef). Fractional times are supported if the underlying
421	syscalls support them.	486	syscalls support them.
…		…
514		579
515	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	580	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
516	directory (i.e. opendir + readdir + closedir). The entries will not be	581	directory (i.e. opendir + readdir + closedir). The entries will not be
517	sorted, and will B<NOT> include the C<.> and C<..> entries.	582	sorted, and will B<NOT> include the C<.> and C<..> entries.
518		583
519	The callback a single argument which is either C<undef> or an array-ref	584	The callback is passed a single argument which is either C<undef> or an
520	with the filenames.	585	array-ref with the filenames.
		586
		587
		588	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		589
		590	Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
		591	behaviour and output format. In case of an error, C<$entries> will be
		592	C<undef>.
		593
		594	The flags are a combination of the following constants, ORed together (the
		595	flags will also be passed to the callback, possibly modified):
		596
		597	=over 4
		598
		599	=item IO::AIO::READDIR_DENTS
		600
		601	When this flag is off, then the callback gets an arrayref with of names
		602	only (as with C<aio_readdir>), otherwise it gets an arrayref with
		603	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		604	entry in more detail.
		605
		606	C<$name> is the name of the entry.
		607
		608	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		609
		610	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		611	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		612	C<IO::AIO::DT_WHT>.
		613
		614	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		615	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		616	scalars are read-only: you can not modify them.
		617
		618	C<$inode> is the inode number (which might not be exact on systems with 64
		619	bit inode numbers and 32 bit perls). This field has unspecified content on
		620	systems that do not deliver the inode information.
		621
		622	=item IO::AIO::READDIR_DIRS_FIRST
		623
		624	When this flag is set, then the names will be returned in an order where
		625	likely directories come first. This is useful when you need to quickly
		626	find directories, or you want to find all directories while avoiding to
		627	stat() each entry.
		628
		629	If the system returns type information in readdir, then this is used
		630	to find directories directly. Otherwise, likely directories are files
		631	beginning with ".", or otherwise files with no dots, of which files with
		632	short names are tried first.
		633
		634	=item IO::AIO::READDIR_STAT_ORDER
		635
		636	When this flag is set, then the names will be returned in an order
		637	suitable for stat()'ing each one. That is, when you plan to stat()
		638	all files in the given directory, then the returned order will likely
		639	be fastest.
		640
		641	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		642	the likely dirs come first, resulting in a less optimal stat order.
		643
		644	=item IO::AIO::READDIR_FOUND_UNKNOWN
		645
		646	This flag should not be set when calling C<aio_readdirx>. Instead, it
		647	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		648	C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
		649	C<$type>'s are known, which can be used to speed up some algorithms.
		650
		651	=back
521		652
522		653
523	=item aio_load $path, $data, $callback->($status)	654	=item aio_load $path, $data, $callback->($status)
524		655
525	This is a composite request that tries to fully load the given file into	656	This is a composite request that tries to fully load the given file into
526	memory. Status is the same as with aio_read.	657	memory. Status is the same as with aio_read.
527		658
528	=cut	659	=cut
529		660
530	sub aio_load($$;$) {	661	sub aio_load($$;$) {
531	aio_block {
532	my ($path, undef, $cb) = @_;	662	my ($path, undef, $cb) = @_;
533	my $data = \$_[1];	663	my $data = \$_[1];
534		664
535	my $pri = aioreq_pri;	665	my $pri = aioreq_pri;
536	my $grp = aio_group $cb;	666	my $grp = aio_group $cb;
		667
		668	aioreq_pri $pri;
		669	add $grp aio_open $path, O_RDONLY, 0, sub {
		670	my $fh = shift
		671	or return $grp->result (-1);
537		672
538	aioreq_pri $pri;	673	aioreq_pri $pri;
539	add $grp aio_open $path, O_RDONLY, 0, sub {
540	my $fh = shift
541	or return $grp->result (-1);
542
543	aioreq_pri $pri;
544	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {	674	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
545	$grp->result ($_[0]);	675	$grp->result ($_[0]);
546	};
547	};	676	};
548
549	$grp
550	}	677	};
		678
		679	$grp
551	}	680	}
552		681
553	=item aio_copy $srcpath, $dstpath, $callback->($status)	682	=item aio_copy $srcpath, $dstpath, $callback->($status)
554		683
555	Try to copy the I<file> (directories not supported as either source or	684	Try to copy the I<file> (directories not supported as either source or
556	destination) from C<$srcpath> to C<$dstpath> and call the callback with	685	destination) from C<$srcpath> to C<$dstpath> and call the callback with
557	the C<0> (error) or C<-1> ok.	686	a status of C<0> (ok) or C<-1> (error, see C<$!>).
558		687
559	This is a composite request that it creates the destination file with	688	This is a composite request that creates the destination file with
560	mode 0200 and copies the contents of the source file into it using	689	mode 0200 and copies the contents of the source file into it using
561	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	690	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
562	uid/gid, in that order.	691	uid/gid, in that order.
563		692
564	If an error occurs, the partial destination file will be unlinked, if	693	If an error occurs, the partial destination file will be unlinked, if
…		…
566	errors are being ignored.	695	errors are being ignored.
567		696
568	=cut	697	=cut
569		698
570	sub aio_copy($$;$) {	699	sub aio_copy($$;$) {
571	aio_block {
572	my ($src, $dst, $cb) = @_;	700	my ($src, $dst, $cb) = @_;
573		701
574	my $pri = aioreq_pri;	702	my $pri = aioreq_pri;
575	my $grp = aio_group $cb;	703	my $grp = aio_group $cb;
576		704
577	aioreq_pri $pri;	705	aioreq_pri $pri;
578	add $grp aio_open $src, O_RDONLY, 0, sub {	706	add $grp aio_open $src, O_RDONLY, 0, sub {
579	if (my $src_fh = $_[0]) {	707	if (my $src_fh = $_[0]) {
580	my @stat = stat $src_fh;	708	my @stat = stat $src_fh; # hmm, might block over nfs?
581		709
582	aioreq_pri $pri;	710	aioreq_pri $pri;
583	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {	711	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
584	if (my $dst_fh = $_[0]) {	712	if (my $dst_fh = $_[0]) {
585	aioreq_pri $pri;	713	aioreq_pri $pri;
586	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	714	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
587	if ($_[0] == $stat[7]) {	715	if ($_[0] == $stat[7]) {
588	$grp->result (0);	716	$grp->result (0);
589	close $src_fh;	717	close $src_fh;
590		718
591	# those should not normally block. should. should.
592	utime $stat[8], $stat[9], $dst;
593	chmod $stat[2] & 07777, $dst_fh;
594	chown $stat[4], $stat[5], $dst_fh;
595	close $dst_fh;
596	} else {	719	my $ch = sub {
597	$grp->result (-1);
598	close $src_fh;
599	close $dst_fh;
600
601	aioreq $pri;	720	aioreq_pri $pri;
		721	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
		722	aioreq_pri $pri;
		723	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		724	aioreq_pri $pri;
602	add $grp aio_unlink $dst;	725	add $grp aio_close $dst_fh;
		726	}
		727	};
603	}	728	};
		729
		730	aioreq_pri $pri;
		731	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		732	if ($_[0] < 0 && $! == ENOSYS) {
		733	aioreq_pri $pri;
		734	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		735	} else {
		736	$ch->();
		737	}
		738	};
		739	} else {
		740	$grp->result (-1);
		741	close $src_fh;
		742	close $dst_fh;
		743
		744	aioreq $pri;
		745	add $grp aio_unlink $dst;
604	};	746	}
605	} else {
606	$grp->result (-1);
607	}	747	};
		748	} else {
		749	$grp->result (-1);
608	},	750	}
609
610	} else {
611	$grp->result (-1);
612	}	751	},
		752
		753	} else {
		754	$grp->result (-1);
613	};	755	}
614
615	$grp
616	}	756	};
		757
		758	$grp
617	}	759	}
618		760
619	=item aio_move $srcpath, $dstpath, $callback->($status)	761	=item aio_move $srcpath, $dstpath, $callback->($status)
620		762
621	Try to move the I<file> (directories not supported as either source or	763	Try to move the I<file> (directories not supported as either source or
622	destination) from C<$srcpath> to C<$dstpath> and call the callback with	764	destination) from C<$srcpath> to C<$dstpath> and call the callback with
623	the C<0> (error) or C<-1> ok.	765	a status of C<0> (ok) or C<-1> (error, see C<$!>).
624		766
625	This is a composite request that tries to rename(2) the file first. If	767	This is a composite request that tries to rename(2) the file first; if
626	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if	768	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
627	that is successful, unlinking the C<$srcpath>.	769	that is successful, unlinks the C<$srcpath>.
628		770
629	=cut	771	=cut
630		772
631	sub aio_move($$;$) {	773	sub aio_move($$;$) {
632	aio_block {
633	my ($src, $dst, $cb) = @_;	774	my ($src, $dst, $cb) = @_;
634		775
635	my $pri = aioreq_pri;	776	my $pri = aioreq_pri;
636	my $grp = aio_group $cb;	777	my $grp = aio_group $cb;
637		778
638	aioreq_pri $pri;	779	aioreq_pri $pri;
639	add $grp aio_rename $src, $dst, sub {	780	add $grp aio_rename $src, $dst, sub {
640	if ($_[0] && $! == EXDEV) {	781	if ($_[0] && $! == EXDEV) {
641	aioreq_pri $pri;	782	aioreq_pri $pri;
642	add $grp aio_copy $src, $dst, sub {	783	add $grp aio_copy $src, $dst, sub {
643	$grp->result ($_[0]);
644
645	if (!$_[0]) {
646	aioreq_pri $pri;
647	add $grp aio_unlink $src;
648	}
649	};
650	} else {
651	$grp->result ($_[0]);	784	$grp->result ($_[0]);
		785
		786	if (!$_[0]) {
		787	aioreq_pri $pri;
		788	add $grp aio_unlink $src;
		789	}
652	}	790	};
		791	} else {
		792	$grp->result ($_[0]);
653	};	793	}
654
655	$grp
656	}	794	};
		795
		796	$grp
657	}	797	}
658		798
659	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	799	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
660		800
661	Scans a directory (similar to C<aio_readdir>) but additionally tries to	801	Scans a directory (similar to C<aio_readdir>) but additionally tries to
…		…
681		821
682	Implementation notes.	822	Implementation notes.
683		823
684	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	824	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
685		825
		826	If readdir returns file type information, then this is used directly to
		827	find directories.
		828
686	After reading the directory, the modification time, size etc. of the	829	Otherwise, after reading the directory, the modification time, size etc.
687	directory before and after the readdir is checked, and if they match (and	830	of the directory before and after the readdir is checked, and if they
688	isn't the current time), the link count will be used to decide how many	831	match (and isn't the current time), the link count will be used to decide
689	entries are directories (if >= 2). Otherwise, no knowledge of the number	832	how many entries are directories (if >= 2). Otherwise, no knowledge of the
690	of subdirectories will be assumed.	833	number of subdirectories will be assumed.
691		834
692	Then entries will be sorted into likely directories (everything without	835	Then entries will be sorted into likely directories a non-initial dot
693	a non-initial dot currently) and likely non-directories (everything	836	currently) and likely non-directories (see C<aio_readdirx>). Then every
694	else). Then every entry plus an appended C</.> will be C<stat>'ed,	837	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
695	likely directories first. If that succeeds, it assumes that the entry	838	in order of their inode numbers. If that succeeds, it assumes that the
696	is a directory or a symlink to directory (which will be checked	839	entry is a directory or a symlink to directory (which will be checked
697	seperately). This is often faster than stat'ing the entry itself because	840	seperately). This is often faster than stat'ing the entry itself because
698	filesystems might detect the type of the entry without reading the inode	841	filesystems might detect the type of the entry without reading the inode
699	data (e.g. ext2fs filetype feature).	842	data (e.g. ext2fs filetype feature), even on systems that cannot return
		843	the filetype information on readdir.
700		844
701	If the known number of directories (link count - 2) has been reached, the	845	If the known number of directories (link count - 2) has been reached, the
702	rest of the entries is assumed to be non-directories.	846	rest of the entries is assumed to be non-directories.
703		847
704	This only works with certainty on POSIX (= UNIX) filesystems, which	848	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
709	directory counting heuristic.	853	directory counting heuristic.
710		854
711	=cut	855	=cut
712		856
713	sub aio_scandir($$;$) {	857	sub aio_scandir($$;$) {
714	aio_block {
715	my ($path, $maxreq, $cb) = @_;	858	my ($path, $maxreq, $cb) = @_;
716		859
717	my $pri = aioreq_pri;	860	my $pri = aioreq_pri;
718		861
719	my $grp = aio_group $cb;	862	my $grp = aio_group $cb;
720		863
721	$maxreq = 4 if $maxreq <= 0;	864	$maxreq = 4 if $maxreq <= 0;
722		865
723	# stat once	866	# stat once
		867	aioreq_pri $pri;
		868	add $grp aio_stat $path, sub {
		869	return $grp->result () if $_[0];
		870	my $now = time;
		871	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		872
		873	# read the directory entries
724	aioreq_pri $pri;	874	aioreq_pri $pri;
725	add $grp aio_stat $path, sub {	875	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
		876	my $entries = shift
726	return $grp->result () if $_[0];	877	or return $grp->result ();
727	my $now = time;
728	my $hash1 = join ":", (stat _)[0,1,3,7,9];
729		878
730	# read the directory entries	879	# stat the dir another time
731	aioreq_pri $pri;	880	aioreq_pri $pri;
732	add $grp aio_readdir $path, sub {
733	my $entries = shift
734	or return $grp->result ();
735
736	# stat the dir another time
737	aioreq_pri $pri;
738	add $grp aio_stat $path, sub {	881	add $grp aio_stat $path, sub {
739	my $hash2 = join ":", (stat _)[0,1,3,7,9];	882	my $hash2 = join ":", (stat _)[0,1,3,7,9];
740		883
741	my $ndirs;	884	my $ndirs;
742		885
743	# take the slow route if anything looks fishy	886	# take the slow route if anything looks fishy
744	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	887	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
745	$ndirs = -1;	888	$ndirs = -1;
746	} else {	889	} else {
747	# if nlink == 2, we are finished	890	# if nlink == 2, we are finished
748	# on non-posix-fs's, we rely on nlink < 2	891	# for non-posix-fs's, we rely on nlink < 2
749	$ndirs = (stat _)[3] - 2	892	$ndirs = (stat _)[3] - 2
750	or return $grp->result ([], $entries);	893	or return $grp->result ([], $entries);
751	}	894	}
752		895
753	# sort into likely dirs and likely nondirs
754	# dirs == files without ".", short entries first
755	$entries = [map $_->[0],
756	sort { $b->[1] cmp $a->[1] }
757	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
758	@$entries];
759
760	my (@dirs, @nondirs);	896	my (@dirs, @nondirs);
761		897
762	my $statgrp = add $grp aio_group sub {	898	my $statgrp = add $grp aio_group sub {
763	$grp->result (\@dirs, \@nondirs);	899	$grp->result (\@dirs, \@nondirs);
764	};	900	};
765		901
766	limit $statgrp $maxreq;	902	limit $statgrp $maxreq;
767	feed $statgrp sub {	903	feed $statgrp sub {
768	return unless @$entries;	904	return unless @$entries;
769	my $entry = pop @$entries;	905	my $entry = shift @$entries;
770		906
771	aioreq_pri $pri;	907	aioreq_pri $pri;
772	add $statgrp aio_stat "$path/$entry/.", sub {	908	add $statgrp aio_stat "$path/$entry/.", sub {
773	if ($_[0] < 0) {	909	if ($_[0] < 0) {
774	push @nondirs, $entry;	910	push @nondirs, $entry;
775	} else {	911	} else {
776	# need to check for real directory	912	# need to check for real directory
777	aioreq_pri $pri;	913	aioreq_pri $pri;
778	add $statgrp aio_lstat "$path/$entry", sub {	914	add $statgrp aio_lstat "$path/$entry", sub {
779	if (-d _) {	915	if (-d _) {
780	push @dirs, $entry;	916	push @dirs, $entry;
781		917
782	unless (--$ndirs) {	918	unless (--$ndirs) {
783	push @nondirs, @$entries;	919	push @nondirs, @$entries;
784	feed $statgrp;	920	feed $statgrp;
785	}
786	} else {
787	push @nondirs, $entry;
788	}	921	}
		922	} else {
		923	push @nondirs, $entry;
789	}	924	}
790	}	925	}
791	};	926	}
792	};	927	};
793	};	928	};
794	};	929	};
795	};	930	};
796
797	$grp
798	}	931	};
		932
		933	$grp
799	}	934	}
800		935
801	=item aio_rmtree $path, $callback->($status)	936	=item aio_rmtree $path, $callback->($status)
802		937
803	Delete a directory tree starting (and including) C<$path>, return the	938	Delete a directory tree starting (and including) C<$path>, return the
…		…
807		942
808	=cut	943	=cut
809		944
810	sub aio_rmtree;	945	sub aio_rmtree;
811	sub aio_rmtree($;$) {	946	sub aio_rmtree($;$) {
812	aio_block {
813	my ($path, $cb) = @_;	947	my ($path, $cb) = @_;
814		948
815	my $pri = aioreq_pri;	949	my $pri = aioreq_pri;
816	my $grp = aio_group $cb;	950	my $grp = aio_group $cb;
817		951
818	aioreq_pri $pri;	952	aioreq_pri $pri;
819	add $grp aio_scandir $path, 0, sub {	953	add $grp aio_scandir $path, 0, sub {
820	my ($dirs, $nondirs) = @_;	954	my ($dirs, $nondirs) = @_;
821		955
822	my $dirgrp = aio_group sub {	956	my $dirgrp = aio_group sub {
823	add $grp aio_rmdir $path, sub {	957	add $grp aio_rmdir $path, sub {
824	$grp->result ($_[0]);	958	$grp->result ($_[0]);
825	};
826	};	959	};
827
828	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
829	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
830
831	add $grp $dirgrp;
832	};	960	};
833		961
834	$grp	962	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		963	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		964
		965	add $grp $dirgrp;
835	}	966	};
		967
		968	$grp
836	}	969	}
		970
		971	=item aio_sync $callback->($status)
		972
		973	Asynchronously call sync and call the callback when finished.
837		974
838	=item aio_fsync $fh, $callback->($status)	975	=item aio_fsync $fh, $callback->($status)
839		976
840	Asynchronously call fsync on the given filehandle and call the callback	977	Asynchronously call fsync on the given filehandle and call the callback
841	with the fsync result code.	978	with the fsync result code.
…		…
845	Asynchronously call fdatasync on the given filehandle and call the	982	Asynchronously call fdatasync on the given filehandle and call the
846	callback with the fdatasync result code.	983	callback with the fdatasync result code.
847		984
848	If this call isn't available because your OS lacks it or it couldn't be	985	If this call isn't available because your OS lacks it or it couldn't be
849	detected, it will be emulated by calling C<fsync> instead.	986	detected, it will be emulated by calling C<fsync> instead.
		987
		988	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		989
		990	Sync the data portion of the file specified by C<$offset> and C<$length>
		991	to disk (but NOT the metadata), by calling the Linux-specific
		992	sync_file_range call. If sync_file_range is not available or it returns
		993	ENOSYS, then fdatasync or fsync is being substituted.
		994
		995	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		996	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		997	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		998	manpage for details.
		999
		1000	=item aio_pathsync $path, $callback->($status)
		1001
		1002	This request tries to open, fsync and close the given path. This is a
		1003	composite request intended to sync directories after directory operations
		1004	(E.g. rename). This might not work on all operating systems or have any
		1005	specific effect, but usually it makes sure that directory changes get
		1006	written to disc. It works for anything that can be opened for read-only,
		1007	not just directories.
		1008
		1009	Future versions of this function might fall back to other methods when
		1010	C<fsync> on the directory fails (such as calling C<sync>).
		1011
		1012	Passes C<0> when everything went ok, and C<-1> on error.
		1013
		1014	=cut
		1015
		1016	sub aio_pathsync($;$) {
		1017	my ($path, $cb) = @_;
		1018
		1019	my $pri = aioreq_pri;
		1020	my $grp = aio_group $cb;
		1021
		1022	aioreq_pri $pri;
		1023	add $grp aio_open $path, O_RDONLY, 0, sub {
		1024	my ($fh) = @_;
		1025	if ($fh) {
		1026	aioreq_pri $pri;
		1027	add $grp aio_fsync $fh, sub {
		1028	$grp->result ($_[0]);
		1029
		1030	aioreq_pri $pri;
		1031	add $grp aio_close $fh;
		1032	};
		1033	} else {
		1034	$grp->result (-1);
		1035	}
		1036	};
		1037
		1038	$grp
		1039	}
		1040
		1041	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1042
		1043	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1044	scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note
		1045	that the scalar must only be modified in-place while an aio operation is
		1046	pending on it).
		1047
		1048	It calls the C<msync> function of your OS, if available, with the memory
		1049	area starting at C<$offset> in the string and ending C<$length> bytes
		1050	later. If C<$length> is negative, counts from the end, and if C<$length>
		1051	is C<undef>, then it goes till the end of the string. The flags can be
		1052	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1053	C<IO::AIO::MS_SYNC>.
		1054
		1055	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1056
		1057	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1058	scalars.
		1059
		1060	It touches (reads or writes) all memory pages in the specified
		1061	range inside the scalar. All caveats and parameters are the same
		1062	as for C<aio_msync>, above, except for flags, which must be either
		1063	C<0> (which reads all pages and ensures they are instantiated) or
		1064	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1065	writing an octet from it, which dirties the page).
850		1066
851	=item aio_group $callback->(...)	1067	=item aio_group $callback->(...)
852		1068
853	This is a very special aio request: Instead of doing something, it is a	1069	This is a very special aio request: Instead of doing something, it is a
854	container for other aio requests, which is useful if you want to bundle	1070	container for other aio requests, which is useful if you want to bundle
…		…
904	=item cancel $req	1120	=item cancel $req
905		1121
906	Cancels the request, if possible. Has the effect of skipping execution	1122	Cancels the request, if possible. Has the effect of skipping execution
907	when entering the B<execute> state and skipping calling the callback when	1123	when entering the B<execute> state and skipping calling the callback when
908	entering the the B<result> state, but will leave the request otherwise	1124	entering the the B<result> state, but will leave the request otherwise
909	untouched. That means that requests that currently execute will not be	1125	untouched (with the exception of readdir). That means that requests that
910	stopped and resources held by the request will not be freed prematurely.	1126	currently execute will not be stopped and resources held by the request
		1127	will not be freed prematurely.
911		1128
912	=item cb $req $callback->(...)	1129	=item cb $req $callback->(...)
913		1130
914	Replace (or simply set) the callback registered to the request.	1131	Replace (or simply set) the callback registered to the request.
915		1132
…		…
966	Their lifetime, simplified, looks like this: when they are empty, they	1183	Their lifetime, simplified, looks like this: when they are empty, they
967	will finish very quickly. If they contain only requests that are in the	1184	will finish very quickly. If they contain only requests that are in the
968	C<done> state, they will also finish. Otherwise they will continue to	1185	C<done> state, they will also finish. Otherwise they will continue to
969	exist.	1186	exist.
970		1187
971	That means after creating a group you have some time to add requests. And	1188	That means after creating a group you have some time to add requests
972	in the callbacks of those requests, you can add further requests to the	1189	(precisely before the callback has been invoked, which is only done within
973	group. And only when all those requests have finished will the the group	1190	the C<poll_cb>). And in the callbacks of those requests, you can add
974	itself finish.	1191	further requests to the group. And only when all those requests have
		1192	finished will the the group itself finish.
975		1193
976	=over 4	1194	=over 4
977		1195
978	=item add $grp ...	1196	=item add $grp ...
979		1197
…		…
988	=item $grp->cancel_subs	1206	=item $grp->cancel_subs
989		1207
990	Cancel all subrequests and clears any feeder, but not the group request	1208	Cancel all subrequests and clears any feeder, but not the group request
991	itself. Useful when you queued a lot of events but got a result early.	1209	itself. Useful when you queued a lot of events but got a result early.
992		1210
		1211	The group request will finish normally (you cannot add requests to the
		1212	group).
		1213
993	=item $grp->result (...)	1214	=item $grp->result (...)
994		1215
995	Set the result value(s) that will be passed to the group callback when all	1216	Set the result value(s) that will be passed to the group callback when all
996	subrequests have finished and set thre groups errno to the current value	1217	subrequests have finished and set the groups errno to the current value
997	of errno (just like calling C<errno> without an error number). By default,	1218	of errno (just like calling C<errno> without an error number). By default,
998	no argument will be passed and errno is zero.	1219	no argument will be passed and errno is zero.
999		1220
1000	=item $grp->errno ([$errno])	1221	=item $grp->errno ([$errno])
1001		1222
…		…
1012	=item feed $grp $callback->($grp)	1233	=item feed $grp $callback->($grp)
1013		1234
1014	Sets a feeder/generator on this group: every group can have an attached	1235	Sets a feeder/generator on this group: every group can have an attached
1015	generator that generates requests if idle. The idea behind this is that,	1236	generator that generates requests if idle. The idea behind this is that,
1016	although you could just queue as many requests as you want in a group,	1237	although you could just queue as many requests as you want in a group,
1017	this might starve other requests for a potentially long time. For	1238	this might starve other requests for a potentially long time. For example,
1018	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1239	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1019	requests, delaying any later requests for a long time.	1240	delaying any later requests for a long time.
1020		1241
1021	To avoid this, and allow incremental generation of requests, you can	1242	To avoid this, and allow incremental generation of requests, you can
1022	instead a group and set a feeder on it that generates those requests. The	1243	instead a group and set a feeder on it that generates those requests. The
1023	feed callback will be called whenever there are few enough (see C<limit>,	1244	feed callback will be called whenever there are few enough (see C<limit>,
1024	below) requests active in the group itself and is expected to queue more	1245	below) requests active in the group itself and is expected to queue more
…		…
1028	not impose any limits).	1249	not impose any limits).
1029		1250
1030	If the feed does not queue more requests when called, it will be	1251	If the feed does not queue more requests when called, it will be
1031	automatically removed from the group.	1252	automatically removed from the group.
1032		1253
1033	If the feed limit is C<0>, it will be set to C<2> automatically.	1254	If the feed limit is C<0> when this method is called, it will be set to
		1255	C<2> automatically.
1034		1256
1035	Example:	1257	Example:
1036		1258
1037	# stat all files in @files, but only ever use four aio requests concurrently:	1259	# stat all files in @files, but only ever use four aio requests concurrently:
1038		1260
…		…
1050	Sets the feeder limit for the group: The feeder will be called whenever	1272	Sets the feeder limit for the group: The feeder will be called whenever
1051	the group contains less than this many requests.	1273	the group contains less than this many requests.
1052		1274
1053	Setting the limit to C<0> will pause the feeding process.	1275	Setting the limit to C<0> will pause the feeding process.
1054		1276
		1277	The default value for the limit is C<0>, but note that setting a feeder
		1278	automatically bumps it up to C<2>.
		1279
1055	=back	1280	=back
1056		1281
1057	=head2 SUPPORT FUNCTIONS	1282	=head2 SUPPORT FUNCTIONS
1058		1283
1059	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1284	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
…		…
1061	=over 4	1286	=over 4
1062		1287
1063	=item $fileno = IO::AIO::poll_fileno	1288	=item $fileno = IO::AIO::poll_fileno
1064		1289
1065	Return the I<request result pipe file descriptor>. This filehandle must be	1290	Return the I<request result pipe file descriptor>. This filehandle must be
1066	polled for reading by some mechanism outside this module (e.g. Event or	1291	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1067	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1292	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1068	to call C<poll_cb> to check the results.	1293	you have to call C<poll_cb> to check the results.
1069		1294
1070	See C<poll_cb> for an example.	1295	See C<poll_cb> for an example.
1071		1296
1072	=item IO::AIO::poll_cb	1297	=item IO::AIO::poll_cb
1073		1298
1074	Process some outstanding events on the result pipe. You have to call this	1299	Process some outstanding events on the result pipe. You have to call this
1075	regularly. Returns the number of events processed. Returns immediately	1300	regularly. Returns C<0> if all events could be processed, or C<-1> if it
		1301	returned earlier for whatever reason. Returns immediately when no events
1076	when no events are outstanding. The amount of events processed depends on	1302	are outstanding. The amount of events processed depends on the settings of
1077	the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1303	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1078		1304
1079	If not all requests were processed for whatever reason, the filehandle	1305	If not all requests were processed for whatever reason, the filehandle
1080	will still be ready when C<poll_cb> returns.	1306	will still be ready when C<poll_cb> returns, so normally you don't have to
		1307	do anything special to have it called later.
1081		1308
1082	Example: Install an Event watcher that automatically calls	1309	Example: Install an Event watcher that automatically calls
1083	IO::AIO::poll_cb with high priority:	1310	IO::AIO::poll_cb with high priority (more examples can be found in the
		1311	SYNOPSIS section, at the top of this document):
1084		1312
1085	Event->io (fd => IO::AIO::poll_fileno,	1313	Event->io (fd => IO::AIO::poll_fileno,
1086	poll => 'r', async => 1,	1314	poll => 'r', async => 1,
1087	cb => \&IO::AIO::poll_cb);	1315	cb => \&IO::AIO::poll_cb);
1088		1316
…		…
1199		1427
1200	The default is probably ok in most situations, especially if thread	1428	The default is probably ok in most situations, especially if thread
1201	creation is fast. If thread creation is very slow on your system you might	1429	creation is fast. If thread creation is very slow on your system you might
1202	want to use larger values.	1430	want to use larger values.
1203		1431
1204	=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs	1432	=item IO::AIO::max_outstanding $maxreqs
1205		1433
1206	This is a very bad function to use in interactive programs because it	1434	This is a very bad function to use in interactive programs because it
1207	blocks, and a bad way to reduce concurrency because it is inexact: Better	1435	blocks, and a bad way to reduce concurrency because it is inexact: Better
1208	use an C<aio_group> together with a feed callback.	1436	use an C<aio_group> together with a feed callback.
1209		1437
1210	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1438	Sets the maximum number of outstanding requests to C<$nreqs>. If you
1211	to queue up more than this number of requests, the next call to the	1439	do queue up more than this number of requests, the next call to the
1212	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)	1440	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213	function will block until the limit is no longer exceeded.	1441	function will block until the limit is no longer exceeded.
1214		1442
1215	The default value is very large, so there is no practical limit on the	1443	The default value is very large, so there is no practical limit on the
1216	number of outstanding requests.	1444	number of outstanding requests.
1217		1445
1218	You can still queue as many requests as you want. Therefore,	1446	You can still queue as many requests as you want. Therefore,
1219	C<max_oustsanding> is mainly useful in simple scripts (with low values) or	1447	C<max_outstanding> is mainly useful in simple scripts (with low values) or
1220	as a stop gap to shield against fatal memory overflow (with large values).	1448	as a stop gap to shield against fatal memory overflow (with large values).
1221		1449
1222	=back	1450	=back
1223		1451
1224	=head3 STATISTICAL INFORMATION	1452	=head3 STATISTICAL INFORMATION
…		…
1245	Returns the number of requests currently in the pending state (executed,	1473	Returns the number of requests currently in the pending state (executed,
1246	but not yet processed by poll_cb).	1474	but not yet processed by poll_cb).
1247		1475
1248	=back	1476	=back
1249		1477
		1478	=head3 MISCELLANEOUS FUNCTIONS
		1479
		1480	IO::AIO implements some functions that might be useful, but are not
		1481	asynchronous.
		1482
		1483	=over 4
		1484
		1485	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1486
		1487	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1488	but is blocking (this makes most sense if you know the input data is
		1489	likely cached already and the output filehandle is set to non-blocking
		1490	operations).
		1491
		1492	Returns the number of bytes copied, or C<-1> on error.
		1493
		1494	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1495
		1496	Simply calls the C<posix_fadvise> function (see it's
		1497	manpage for details). The following advice constants are
		1498	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1499	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1500	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1501
		1502	On systems that do not implement C<posix_fadvise>, this function returns
		1503	ENOSYS, otherwise the return value of C<posix_fadvise>.
		1504
		1505	=item IO::AIO::mlockall $flags
		1506
		1507	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1508	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>).
		1509
		1510	On systems that do not implement C<mlockall>, this function returns
		1511	ENOSYS, otherwise the return value of C<mlockall>.
		1512
		1513	=item IO::AIO::munlockall
		1514
		1515	Calls the C<munlockall> function.
		1516
		1517	On systems that do not implement C<munlockall>, this function returns
		1518	ENOSYS, otherwise the return value of C<munlockall>.
		1519
		1520	=back
		1521
1250	=cut	1522	=cut
1251
1252	# support function to convert a fd into a perl filehandle
1253	sub _fd2fh {
1254	return undef if $_[0] < 0;
1255
1256	# try to generate nice filehandles
1257	my $sym = "IO::AIO::fd#$_[0]";
1258	local *$sym;
1259
1260	open *$sym, "+<&=$_[0]" # usually works under any unix
1261	or open *$sym, "<&=$_[0]" # cygwin needs this
1262	or open *$sym, ">&=$_[0]" # or this
1263	or return undef;
1264
1265	*$sym
1266	}
1267		1523
1268	min_parallel 8;	1524	min_parallel 8;
1269		1525
1270	END { flush }	1526	END { flush }
1271		1527
…		…
1310		1566
1311	Known bugs will be fixed in the next release.	1567	Known bugs will be fixed in the next release.
1312		1568
1313	=head1 SEE ALSO	1569	=head1 SEE ALSO
1314		1570
1315	L<Coro::AIO>.	1571	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		1572	more natural syntax.
1316		1573
1317	=head1 AUTHOR	1574	=head1 AUTHOR
1318		1575
1319	Marc Lehmann <schmorp@schmorp.de>	1576	Marc Lehmann <schmorp@schmorp.de>
1320	http://home.schmorp.de/	1577	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.111 by root, Mon Aug 13 12:08:13 2007 UTC vs. Revision 1.174 by root, Sun Jan 10 20:28:43 2010 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.111 by root, Mon Aug 13 12:08:13 2007 UTC vs.
Revision 1.174 by root, Sun Jan 10 20:28:43 2010 UTC