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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.158 by root, Wed Jun 17 06:33:07 2009 UTC vs.
Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
9	aio_open "/etc/passwd", O_RDONLY, 0, sub {	9	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10	my $fh = shift	10	my $fh = shift
11	or die "/etc/passwd: $!";	11	or die "/etc/passwd: $!";
12	...	12	...
13	};	13	};
14		14
…		…
25	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
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
31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32	use AnyEvent::AIO;
33
34	# EV integration
35	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37	# Event integration
38	Event->io (fd => IO::AIO::poll_fileno,
39	poll => 'r',
40	cb => \&IO::AIO::poll_cb);
41
42	# Glib/Gtk2 integration
43	add_watch Glib::IO IO::AIO::poll_fileno,
44	in => sub { IO::AIO::poll_cb; 1 };
45
46	# Tk integration
47	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48	readable => \&IO::AIO::poll_cb);
49
50	# Danga::Socket integration
51	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52	\&IO::AIO::poll_cb);
53		30
54	=head1 DESCRIPTION	31	=head1 DESCRIPTION
55		32
56	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
57	operating system supports. It is implemented as an interface to C<libeio>	34	operating system supports. It is implemented as an interface to C<libeio>
…		…
99		76
100	# register the IO::AIO callback with EV	77	# register the IO::AIO callback with EV
101	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102		79
103	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
104	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
105	my $fh = shift	82	my $fh = shift
106	or die "error while opening: $!";	83	or die "error while opening: $!";
107		84
108	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
109	my $size = -s $fh;	86	my $size = -s $fh;
…		…
186		163
187	package IO::AIO;	164	package IO::AIO;
188		165
189	use Carp ();	166	use Carp ();
190		167
191	no warnings;	168	use common::sense;
192	use strict 'vars';
193		169
194	use base 'Exporter';	170	use base 'Exporter';
195		171
196	BEGIN {	172	BEGIN {
197	our $VERSION = '3.25';	173	our $VERSION = '3.7';
198		174
199	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close	175	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
200	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
201	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
202	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
203	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
204	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
205	aio_chmod aio_utime aio_truncate);	181	aio_chmod aio_utime aio_truncate
		182	aio_msync aio_mtouch aio_mlock aio_mlockall
		183	aio_statvfs);
206		184
207	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
208	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
209	min_parallel max_parallel max_idle	187	min_parallel max_parallel max_idle
210	nreqs nready npending nthreads	188	nreqs nready npending nthreads
211	max_poll_time max_poll_reqs	189	max_poll_time max_poll_reqs
212	sendfile fadvise);	190	sendfile fadvise madvise
		191	mmap munmap munlock munlockall);
213		192
214	push @AIO_REQ, qw(aio_busy); # not exported	193	push @AIO_REQ, qw(aio_busy); # not exported
215		194
216	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	195	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
217		196
218	require XSLoader;	197	require XSLoader;
219	XSLoader::load ("IO::AIO", $VERSION);	198	XSLoader::load ("IO::AIO", $VERSION);
220	}	199	}
221		200
222	=head1 FUNCTIONS	201	=head1 FUNCTIONS
		202
		203	=head2 QUICK OVERVIEW
		204
		205	This section simply lists the prototypes of the most important functions
		206	for quick reference. See the following sections for function-by-function
		207	documentation.
		208
		209	aio_open $pathname, $flags, $mode, $callback->($fh)
		210	aio_close $fh, $callback->($status)
		211	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		212	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		213	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		214	aio_readahead $fh,$offset,$length, $callback->($retval)
		215	aio_stat $fh_or_path, $callback->($status)
		216	aio_lstat $fh, $callback->($status)
		217	aio_statvfs $fh_or_path, $callback->($statvfs)
		218	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		219	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		220	aio_truncate $fh_or_path, $offset, $callback->($status)
		221	aio_chmod $fh_or_path, $mode, $callback->($status)
		222	aio_unlink $pathname, $callback->($status)
		223	aio_mknod $path, $mode, $dev, $callback->($status)
		224	aio_link $srcpath, $dstpath, $callback->($status)
		225	aio_symlink $srcpath, $dstpath, $callback->($status)
		226	aio_readlink $path, $callback->($link)
		227	aio_rename $srcpath, $dstpath, $callback->($status)
		228	aio_mkdir $pathname, $mode, $callback->($status)
		229	aio_rmdir $pathname, $callback->($status)
		230	aio_readdir $pathname, $callback->($entries)
		231	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		232	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		233	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		234	aio_load $path, $data, $callback->($status)
		235	aio_copy $srcpath, $dstpath, $callback->($status)
		236	aio_move $srcpath, $dstpath, $callback->($status)
		237	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		238	aio_rmtree $path, $callback->($status)
		239	aio_sync $callback->($status)
		240	aio_fsync $fh, $callback->($status)
		241	aio_fdatasync $fh, $callback->($status)
		242	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		243	aio_pathsync $path, $callback->($status)
		244	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		245	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		246	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		247	aio_mlockall $flags, $callback->($status)
		248	aio_group $callback->(...)
		249	aio_nop $callback->()
		250
		251	$prev_pri = aioreq_pri [$pri]
		252	aioreq_nice $pri_adjust
		253
		254	IO::AIO::poll_wait
		255	IO::AIO::poll_cb
		256	IO::AIO::poll
		257	IO::AIO::flush
		258	IO::AIO::max_poll_reqs $nreqs
		259	IO::AIO::max_poll_time $seconds
		260	IO::AIO::min_parallel $nthreads
		261	IO::AIO::max_parallel $nthreads
		262	IO::AIO::max_idle $nthreads
		263	IO::AIO::max_outstanding $maxreqs
		264	IO::AIO::nreqs
		265	IO::AIO::nready
		266	IO::AIO::npending
		267
		268	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		269	IO::AIO::fadvise $fh, $offset, $len, $advice
		270	IO::AIO::madvise $scalar, $offset, $length, $advice
		271	IO::AIO::mprotect $scalar, $offset, $length, $protect
		272	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		273	IO::AIO::munlockall
223		274
224	=head2 AIO REQUEST FUNCTIONS	275	=head2 AIO REQUEST FUNCTIONS
225		276
226	All the C<aio_*> calls are more or less thin wrappers around the syscall	277	All the C<aio_*> calls are more or less thin wrappers around the syscall
227	with the same name (sans C<aio_>). The arguments are similar or identical,	278	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
307	by the umask in effect then the request is being executed, so better never	358	by the umask in effect then the request is being executed, so better never
308	change the umask.	359	change the umask.
309		360
310	Example:	361	Example:
311		362
312	aio_open "/etc/passwd", O_RDONLY, 0, sub {	363	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
313	if ($_[0]) {	364	if ($_[0]) {
314	print "open successful, fh is $_[0]\n";	365	print "open successful, fh is $_[0]\n";
315	...	366	...
316	} else {	367	} else {
317	die "open failed: $!\n";	368	die "open failed: $!\n";
…		…
379	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	430	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
380	other.	431	other.
381		432
382	This call tries to make use of a native C<sendfile> syscall to provide	433	This call tries to make use of a native C<sendfile> syscall to provide
383	zero-copy operation. For this to work, C<$out_fh> should refer to a	434	zero-copy operation. For this to work, C<$out_fh> should refer to a
384	socket, and C<$in_fh> should refer to mmap'able file.	435	socket, and C<$in_fh> should refer to an mmap'able file.
385		436
386	If the native sendfile call fails or is not implemented, it will be	437	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		438	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
387	emulated, so you can call C<aio_sendfile> on any type of filehandle	439	it will be emulated, so you can call C<aio_sendfile> on any type of
388	regardless of the limitations of the operating system.	440	filehandle regardless of the limitations of the operating system.
389		441
390	Please note, however, that C<aio_sendfile> can read more bytes from	442	Please note, however, that C<aio_sendfile> can read more bytes from
391	C<$in_fh> than are written, and there is no way to find out how many	443	C<$in_fh> than are written, and there is no way to find out how many
392	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	444	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
393	provides the number of bytes written to C<$out_fh>. Only if the result	445	provides the number of bytes written to C<$out_fh>. Only if the result
…		…
431	$_[0] and die "stat failed: $!";	483	$_[0] and die "stat failed: $!";
432	print "size is ", -s _, "\n";	484	print "size is ", -s _, "\n";
433	};	485	};
434		486
435		487
		488	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		489
		490	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		491	whether a file handle or path was passed.
		492
		493	On success, the callback is passed a hash reference with the following
		494	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		495	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		496	is passed.
		497
		498	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		499	C<ST_NOSUID>.
		500
		501	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		502	their correct value when available, or to C<0> on systems that do
		503	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		504	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		505	C<ST_NODIRATIME> and C<ST_RELATIME>.
		506
		507	Example: stat C</wd> and dump out the data if successful.
		508
		509	aio_statvfs "/wd", sub {
		510	my $f = $_[0]
		511	or die "statvfs: $!";
		512
		513	use Data::Dumper;
		514	say Dumper $f;
		515	};
		516
		517	# result:
		518	{
		519	bsize => 1024,
		520	bfree => 4333064312,
		521	blocks => 10253828096,
		522	files => 2050765568,
		523	flag => 4096,
		524	favail => 2042092649,
		525	bavail => 4333064312,
		526	ffree => 2042092649,
		527	namemax => 255,
		528	frsize => 1024,
		529	fsid => 1810
		530	}
		531
		532
436	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	533	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437		534
438	Works like perl's C<utime> function (including the special case of $atime	535	Works like perl's C<utime> function (including the special case of $atime
439	and $mtime being undef). Fractional times are supported if the underlying	536	and $mtime being undef). Fractional times are supported if the underlying
440	syscalls support them.	537	syscalls support them.
…		…
635		732
636	=item aio_copy $srcpath, $dstpath, $callback->($status)	733	=item aio_copy $srcpath, $dstpath, $callback->($status)
637		734
638	Try to copy the I<file> (directories not supported as either source or	735	Try to copy the I<file> (directories not supported as either source or
639	destination) from C<$srcpath> to C<$dstpath> and call the callback with	736	destination) from C<$srcpath> to C<$dstpath> and call the callback with
640	the C<0> (error) or C<-1> ok.	737	a status of C<0> (ok) or C<-1> (error, see C<$!>).
641		738
642	This is a composite request that creates the destination file with	739	This is a composite request that creates the destination file with
643	mode 0200 and copies the contents of the source file into it using	740	mode 0200 and copies the contents of the source file into it using
644	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	741	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
645	uid/gid, in that order.	742	uid/gid, in that order.
…		…
657	my $grp = aio_group $cb;	754	my $grp = aio_group $cb;
658		755
659	aioreq_pri $pri;	756	aioreq_pri $pri;
660	add $grp aio_open $src, O_RDONLY, 0, sub {	757	add $grp aio_open $src, O_RDONLY, 0, sub {
661	if (my $src_fh = $_[0]) {	758	if (my $src_fh = $_[0]) {
662	my @stat = stat $src_fh; # hmm, might bock over nfs?	759	my @stat = stat $src_fh; # hmm, might block over nfs?
663		760
664	aioreq_pri $pri;	761	aioreq_pri $pri;
665	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {	762	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
666	if (my $dst_fh = $_[0]) {	763	if (my $dst_fh = $_[0]) {
667	aioreq_pri $pri;	764	aioreq_pri $pri;
…		…
714		811
715	=item aio_move $srcpath, $dstpath, $callback->($status)	812	=item aio_move $srcpath, $dstpath, $callback->($status)
716		813
717	Try to move the I<file> (directories not supported as either source or	814	Try to move the I<file> (directories not supported as either source or
718	destination) from C<$srcpath> to C<$dstpath> and call the callback with	815	destination) from C<$srcpath> to C<$dstpath> and call the callback with
719	the C<0> (error) or C<-1> ok.	816	a status of C<0> (ok) or C<-1> (error, see C<$!>).
720		817
721	This is a composite request that tries to rename(2) the file first; if	818	This is a composite request that tries to rename(2) the file first; if
722	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if	819	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
723	that is successful, unlinks the C<$srcpath>.	820	that is successful, unlinks the C<$srcpath>.
724		821
…		…
958	(E.g. rename). This might not work on all operating systems or have any	1055	(E.g. rename). This might not work on all operating systems or have any
959	specific effect, but usually it makes sure that directory changes get	1056	specific effect, but usually it makes sure that directory changes get
960	written to disc. It works for anything that can be opened for read-only,	1057	written to disc. It works for anything that can be opened for read-only,
961	not just directories.	1058	not just directories.
962		1059
		1060	Future versions of this function might fall back to other methods when
		1061	C<fsync> on the directory fails (such as calling C<sync>).
		1062
963	Passes C<0> when everything went ok, and C<-1> on error.	1063	Passes C<0> when everything went ok, and C<-1> on error.
964		1064
965	=cut	1065	=cut
966		1066
967	sub aio_pathsync($;$) {	1067	sub aio_pathsync($;$) {
…		…
987	};	1087	};
988		1088
989	$grp	1089	$grp
990	}	1090	}
991		1091
		1092	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1093
		1094	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1095	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1096	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1097	scalar must only be modified in-place while an aio operation is pending on
		1098	it).
		1099
		1100	It calls the C<msync> function of your OS, if available, with the memory
		1101	area starting at C<$offset> in the string and ending C<$length> bytes
		1102	later. If C<$length> is negative, counts from the end, and if C<$length>
		1103	is C<undef>, then it goes till the end of the string. The flags can be
		1104	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1105	C<IO::AIO::MS_SYNC>.
		1106
		1107	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1108
		1109	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1110	scalars.
		1111
		1112	It touches (reads or writes) all memory pages in the specified
		1113	range inside the scalar. All caveats and parameters are the same
		1114	as for C<aio_msync>, above, except for flags, which must be either
		1115	C<0> (which reads all pages and ensures they are instantiated) or
		1116	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1117	writing an octet from it, which dirties the page).
		1118
		1119	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1120
		1121	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1122	scalars.
		1123
		1124	It reads in all the pages of the underlying storage into memory (if any)
		1125	and locks them, so they are not getting swapped/paged out or removed.
		1126
		1127	If C<$length> is undefined, then the scalar will be locked till the end.
		1128
		1129	On systems that do not implement C<mlock>, this function returns C<-1>
		1130	and sets errno to C<ENOSYS>.
		1131
		1132	Note that the corresponding C<munlock> is synchronous and is
		1133	documented under L<MISCELLANEOUS FUNCTIONS>.
		1134
		1135	Example: open a file, mmap and mlock it - both will be undone when
		1136	C<$data> gets destroyed.
		1137
		1138	open my $fh, "<", $path or die "$path: $!";
		1139	my $data;
		1140	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1141	aio_mlock $data; # mlock in background
		1142
		1143	=item aio_mlockall $flags, $callback->($status)
		1144
		1145	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1146	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1147
		1148	On systems that do not implement C<mlockall>, this function returns C<-1>
		1149	and sets errno to C<ENOSYS>.
		1150
		1151	Note that the corresponding C<munlockall> is synchronous and is
		1152	documented under L<MISCELLANEOUS FUNCTIONS>.
		1153
		1154	Example: asynchronously lock all current and future pages into memory.
		1155
		1156	aio_mlockall IO::AIO::MCL_FUTURE;
		1157
992	=item aio_group $callback->(...)	1158	=item aio_group $callback->(...)
993		1159
994	This is a very special aio request: Instead of doing something, it is a	1160	This is a very special aio request: Instead of doing something, it is a
995	container for other aio requests, which is useful if you want to bundle	1161	container for other aio requests, which is useful if you want to bundle
996	many requests into a single, composite, request with a definite callback	1162	many requests into a single, composite, request with a definite callback
…		…
1131	=item $grp->cancel_subs	1297	=item $grp->cancel_subs
1132		1298
1133	Cancel all subrequests and clears any feeder, but not the group request	1299	Cancel all subrequests and clears any feeder, but not the group request
1134	itself. Useful when you queued a lot of events but got a result early.	1300	itself. Useful when you queued a lot of events but got a result early.
1135		1301
		1302	The group request will finish normally (you cannot add requests to the
		1303	group).
		1304
1136	=item $grp->result (...)	1305	=item $grp->result (...)
1137		1306
1138	Set the result value(s) that will be passed to the group callback when all	1307	Set the result value(s) that will be passed to the group callback when all
1139	subrequests have finished and set the groups errno to the current value	1308	subrequests have finished and set the groups errno to the current value
1140	of errno (just like calling C<errno> without an error number). By default,	1309	of errno (just like calling C<errno> without an error number). By default,
…		…
1234		1403
1235	Event->io (fd => IO::AIO::poll_fileno,	1404	Event->io (fd => IO::AIO::poll_fileno,
1236	poll => 'r', async => 1,	1405	poll => 'r', async => 1,
1237	cb => \&IO::AIO::poll_cb);	1406	cb => \&IO::AIO::poll_cb);
1238		1407
		1408	=item IO::AIO::poll_wait
		1409
		1410	If there are any outstanding requests and none of them in the result
		1411	phase, wait till the result filehandle becomes ready for reading (simply
		1412	does a C<select> on the filehandle. This is useful if you want to
		1413	synchronously wait for some requests to finish).
		1414
		1415	See C<nreqs> for an example.
		1416
		1417	=item IO::AIO::poll
		1418
		1419	Waits until some requests have been handled.
		1420
		1421	Returns the number of requests processed, but is otherwise strictly
		1422	equivalent to:
		1423
		1424	IO::AIO::poll_wait, IO::AIO::poll_cb
		1425
		1426	=item IO::AIO::flush
		1427
		1428	Wait till all outstanding AIO requests have been handled.
		1429
		1430	Strictly equivalent to:
		1431
		1432	IO::AIO::poll_wait, IO::AIO::poll_cb
		1433	while IO::AIO::nreqs;
		1434
1239	=item IO::AIO::max_poll_reqs $nreqs	1435	=item IO::AIO::max_poll_reqs $nreqs
1240		1436
1241	=item IO::AIO::max_poll_time $seconds	1437	=item IO::AIO::max_poll_time $seconds
1242		1438
1243	These set the maximum number of requests (default C<0>, meaning infinity)	1439	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1267	# use a low priority so other tasks have priority	1463	# use a low priority so other tasks have priority
1268	Event->io (fd => IO::AIO::poll_fileno,	1464	Event->io (fd => IO::AIO::poll_fileno,
1269	poll => 'r', nice => 1,	1465	poll => 'r', nice => 1,
1270	cb => &IO::AIO::poll_cb);	1466	cb => &IO::AIO::poll_cb);
1271		1467
1272	=item IO::AIO::poll_wait
1273
1274	If there are any outstanding requests and none of them in the result
1275	phase, wait till the result filehandle becomes ready for reading (simply
1276	does a C<select> on the filehandle. This is useful if you want to
1277	synchronously wait for some requests to finish).
1278
1279	See C<nreqs> for an example.
1280
1281	=item IO::AIO::poll
1282
1283	Waits until some requests have been handled.
1284
1285	Returns the number of requests processed, but is otherwise strictly
1286	equivalent to:
1287
1288	IO::AIO::poll_wait, IO::AIO::poll_cb
1289
1290	=item IO::AIO::flush
1291
1292	Wait till all outstanding AIO requests have been handled.
1293
1294	Strictly equivalent to:
1295
1296	IO::AIO::poll_wait, IO::AIO::poll_cb
1297	while IO::AIO::nreqs;
1298
1299	=back	1468	=back
1300		1469
1301	=head3 CONTROLLING THE NUMBER OF THREADS	1470	=head3 CONTROLLING THE NUMBER OF THREADS
1302		1471
1303	=over	1472	=over
…		…
1413		1582
1414	Returns the number of bytes copied, or C<-1> on error.	1583	Returns the number of bytes copied, or C<-1> on error.
1415		1584
1416	=item IO::AIO::fadvise $fh, $offset, $len, $advice	1585	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1417		1586
1418	Simply calls the C<posix_fadvise> function (see it's	1587	Simply calls the C<posix_fadvise> function (see its
1419	manpage for details). The following advice constants are	1588	manpage for details). The following advice constants are
1420	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	1589	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1421	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	1590	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1422	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1591	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1423		1592
1424	On systems that do not implement C<posix_fadvise>, this function returns	1593	On systems that do not implement C<posix_fadvise>, this function returns
1425	ENOSYS, otherwise the return value of C<posix_fadvise>.	1594	ENOSYS, otherwise the return value of C<posix_fadvise>.
1426		1595
		1596	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1597
		1598	Simply calls the C<posix_madvise> function (see its
		1599	manpage for details). The following advice constants are
		1600	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1601	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1602
		1603	On systems that do not implement C<posix_madvise>, this function returns
		1604	ENOSYS, otherwise the return value of C<posix_madvise>.
		1605
		1606	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1607
		1608	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1609	$scalar (see its manpage for details). The following protect
		1610	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1611	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1612
		1613	On systems that do not implement C<mprotect>, this function returns
		1614	ENOSYS, otherwise the return value of C<mprotect>.
		1615
		1616	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1617
		1618	Memory-maps a file (or anonymous memory range) and attaches it to the
		1619	given C<$scalar>, which will act like a string scalar.
		1620
		1621	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1622	change the string length, and most read-only operations such as copying it
		1623	or searching it with regexes and so on.
		1624
		1625	Anything else is unsafe and will, at best, result in memory leaks.
		1626
		1627	The memory map associated with the C<$scalar> is automatically removed
		1628	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1629	C<IO::AIO::munmap> functions are called.
		1630
		1631	This calls the C<mmap>(2) function internally. See your system's manual
		1632	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1633
		1634	The C<$length> must be larger than zero and smaller than the actual
		1635	filesize.
		1636
		1637	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1638	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1639
		1640	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1641	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1642	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1643	(which is set to C<MAP_ANON> if your system only provides this
		1644	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1645	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1646	C<IO::AIO::MAP_NONBLOCK>
		1647
		1648	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1649
		1650	C<$offset> is the offset from the start of the file - it generally must be
		1651	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1652
		1653	Example:
		1654
		1655	use Digest::MD5;
		1656	use IO::AIO;
		1657
		1658	open my $fh, "<verybigfile"
		1659	or die "$!";
		1660
		1661	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1662	or die "verybigfile: $!";
		1663
		1664	my $fast_md5 = md5 $data;
		1665
		1666	=item IO::AIO::munmap $scalar
		1667
		1668	Removes a previous mmap and undefines the C<$scalar>.
		1669
		1670	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1671
		1672	Calls the C<munlock> function, undoing the effects of a previous
		1673	C<aio_mlock> call (see its description for details).
		1674
		1675	=item IO::AIO::munlockall
		1676
		1677	Calls the C<munlockall> function.
		1678
		1679	On systems that do not implement C<munlockall>, this function returns
		1680	ENOSYS, otherwise the return value of C<munlockall>.
		1681
1427	=back	1682	=back
1428		1683
1429	=cut	1684	=cut
1430		1685
1431	min_parallel 8;	1686	min_parallel 8;
1432		1687
1433	END { flush }	1688	END { flush }
1434		1689
1435	1;	1690	1;
		1691
		1692	=head1 EVENT LOOP INTEGRATION
		1693
		1694	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1695	automatically into many event loops:
		1696
		1697	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1698	use AnyEvent::AIO;
		1699
		1700	You can also integrate IO::AIO manually into many event loops, here are
		1701	some examples of how to do this:
		1702
		1703	# EV integration
		1704	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1705
		1706	# Event integration
		1707	Event->io (fd => IO::AIO::poll_fileno,
		1708	poll => 'r',
		1709	cb => \&IO::AIO::poll_cb);
		1710
		1711	# Glib/Gtk2 integration
		1712	add_watch Glib::IO IO::AIO::poll_fileno,
		1713	in => sub { IO::AIO::poll_cb; 1 };
		1714
		1715	# Tk integration
		1716	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1717	readable => \&IO::AIO::poll_cb);
		1718
		1719	# Danga::Socket integration
		1720	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1721	\&IO::AIO::poll_cb);
1436		1722
1437	=head2 FORK BEHAVIOUR	1723	=head2 FORK BEHAVIOUR
1438		1724
1439	This module should do "the right thing" when the process using it forks:	1725	This module should do "the right thing" when the process using it forks:
1440		1726

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.158 by root, Wed Jun 17 06:33:07 2009 UTC vs. Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.158 by root, Wed Jun 17 06:33:07 2009 UTC vs.
Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC