[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.187 by root, Fri Feb 11 00:05:17 2011 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.72';
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";
…		…
377	reading at byte offset C<$in_offset>, and starts writing at the current	428	reading at byte offset C<$in_offset>, and starts writing at the current
378	file offset of C<$out_fh>. Because of that, it is not safe to issue more	429	file offset of C<$out_fh>. Because of that, it is not safe to issue more
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
		433	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		434	are written, and there is no way to find out how many bytes have been read
		435	from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of
		436	bytes written to C<$out_fh>. Only if the result value equals C<$length>
		437	one can assume that C<$length> bytes have been read.
		438
		439	Unlike with other C<aio_> functions, it makes a lot of sense to use
		440	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		441	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		442	the socket I/O will be non-blocking. Note, however, that you can run into
		443	a trap where C<aio_sendfile> reads some data with readahead, then fails
		444	to write all data, and when the socket is ready the next time, the data
		445	in the cache is already lost, forcing C<aio_sendfile> to again hit the
		446	disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage
		447	much better.
		448
382	This call tries to make use of a native C<sendfile> syscall to provide	449	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	450	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.	451	socket, and C<$in_fh> should refer to an mmap'able file.
385		452
386	If the native sendfile call fails or is not implemented, it will be	453	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		454	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	455	it will be emulated, so you can call C<aio_sendfile> on any type of
388	regardless of the limitations of the operating system.	456	filehandle regardless of the limitations of the operating system.
389
390	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
392	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
394	value equals C<$length> one can assume that C<$length> bytes have been
395	read.
396		457
397		458
398	=item aio_readahead $fh,$offset,$length, $callback->($retval)	459	=item aio_readahead $fh,$offset,$length, $callback->($retval)
399		460
400	C<aio_readahead> populates the page cache with data from a file so that	461	C<aio_readahead> populates the page cache with data from a file so that
…		…
423		484
424	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	485	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
425	error when stat'ing a large file, the results will be silently truncated	486	error when stat'ing a large file, the results will be silently truncated
426	unless perl itself is compiled with large file support.	487	unless perl itself is compiled with large file support.
427		488
		489	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		490	following constants and functions (if not implemented, the constants will
		491	be C<0> and the functions will either C<croak> or fall back on traditional
		492	behaviour).
		493
		494	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		495	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		496	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		497
428	Example: Print the length of F</etc/passwd>:	498	Example: Print the length of F</etc/passwd>:
429		499
430	aio_stat "/etc/passwd", sub {	500	aio_stat "/etc/passwd", sub {
431	$_[0] and die "stat failed: $!";	501	$_[0] and die "stat failed: $!";
432	print "size is ", -s _, "\n";	502	print "size is ", -s _, "\n";
433	};	503	};
434		504
435		505
		506	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		507
		508	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		509	whether a file handle or path was passed.
		510
		511	On success, the callback is passed a hash reference with the following
		512	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		513	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		514	is passed.
		515
		516	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		517	C<ST_NOSUID>.
		518
		519	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		520	their correct value when available, or to C<0> on systems that do
		521	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		522	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		523	C<ST_NODIRATIME> and C<ST_RELATIME>.
		524
		525	Example: stat C</wd> and dump out the data if successful.
		526
		527	aio_statvfs "/wd", sub {
		528	my $f = $_[0]
		529	or die "statvfs: $!";
		530
		531	use Data::Dumper;
		532	say Dumper $f;
		533	};
		534
		535	# result:
		536	{
		537	bsize => 1024,
		538	bfree => 4333064312,
		539	blocks => 10253828096,
		540	files => 2050765568,
		541	flag => 4096,
		542	favail => 2042092649,
		543	bavail => 4333064312,
		544	ffree => 2042092649,
		545	namemax => 255,
		546	frsize => 1024,
		547	fsid => 1810
		548	}
		549
		550
436	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	551	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437		552
438	Works like perl's C<utime> function (including the special case of $atime	553	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	554	and $mtime being undef). Fractional times are supported if the underlying
440	syscalls support them.	555	syscalls support them.
…		…
488		603
489	The only (POSIX-) portable way of calling this function is:	604	The only (POSIX-) portable way of calling this function is:
490		605
491	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	606	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
492		607
		608	See C<aio_stat> for info about some potentially helpful extra constants
		609	and functions.
493		610
494	=item aio_link $srcpath, $dstpath, $callback->($status)	611	=item aio_link $srcpath, $dstpath, $callback->($status)
495		612
496	Asynchronously create a new link to the existing object at C<$srcpath> at	613	Asynchronously create a new link to the existing object at C<$srcpath> at
497	the path C<$dstpath> and call the callback with the result code.	614	the path C<$dstpath> and call the callback with the result code.
…		…
635		752
636	=item aio_copy $srcpath, $dstpath, $callback->($status)	753	=item aio_copy $srcpath, $dstpath, $callback->($status)
637		754
638	Try to copy the I<file> (directories not supported as either source or	755	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	756	destination) from C<$srcpath> to C<$dstpath> and call the callback with
640	the C<0> (error) or C<-1> ok.	757	a status of C<0> (ok) or C<-1> (error, see C<$!>).
641		758
642	This is a composite request that creates the destination file with	759	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	760	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	761	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
645	uid/gid, in that order.	762	uid/gid, in that order.
…		…
657	my $grp = aio_group $cb;	774	my $grp = aio_group $cb;
658		775
659	aioreq_pri $pri;	776	aioreq_pri $pri;
660	add $grp aio_open $src, O_RDONLY, 0, sub {	777	add $grp aio_open $src, O_RDONLY, 0, sub {
661	if (my $src_fh = $_[0]) {	778	if (my $src_fh = $_[0]) {
662	my @stat = stat $src_fh; # hmm, might bock over nfs?	779	my @stat = stat $src_fh; # hmm, might block over nfs?
663		780
664	aioreq_pri $pri;	781	aioreq_pri $pri;
665	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {	782	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
666	if (my $dst_fh = $_[0]) {	783	if (my $dst_fh = $_[0]) {
667	aioreq_pri $pri;	784	aioreq_pri $pri;
…		…
714		831
715	=item aio_move $srcpath, $dstpath, $callback->($status)	832	=item aio_move $srcpath, $dstpath, $callback->($status)
716		833
717	Try to move the I<file> (directories not supported as either source or	834	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	835	destination) from C<$srcpath> to C<$dstpath> and call the callback with
719	the C<0> (error) or C<-1> ok.	836	a status of C<0> (ok) or C<-1> (error, see C<$!>).
720		837
721	This is a composite request that tries to rename(2) the file first; if	838	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	839	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
723	that is successful, unlinks the C<$srcpath>.	840	that is successful, unlinks the C<$srcpath>.
724		841
…		…
958	(E.g. rename). This might not work on all operating systems or have any	1075	(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	1076	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,	1077	written to disc. It works for anything that can be opened for read-only,
961	not just directories.	1078	not just directories.
962		1079
		1080	Future versions of this function might fall back to other methods when
		1081	C<fsync> on the directory fails (such as calling C<sync>).
		1082
963	Passes C<0> when everything went ok, and C<-1> on error.	1083	Passes C<0> when everything went ok, and C<-1> on error.
964		1084
965	=cut	1085	=cut
966		1086
967	sub aio_pathsync($;$) {	1087	sub aio_pathsync($;$) {
…		…
987	};	1107	};
988		1108
989	$grp	1109	$grp
990	}	1110	}
991		1111
		1112	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1113
		1114	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1115	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1116	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1117	scalar must only be modified in-place while an aio operation is pending on
		1118	it).
		1119
		1120	It calls the C<msync> function of your OS, if available, with the memory
		1121	area starting at C<$offset> in the string and ending C<$length> bytes
		1122	later. If C<$length> is negative, counts from the end, and if C<$length>
		1123	is C<undef>, then it goes till the end of the string. The flags can be
		1124	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1125	C<IO::AIO::MS_SYNC>.
		1126
		1127	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1128
		1129	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1130	scalars.
		1131
		1132	It touches (reads or writes) all memory pages in the specified
		1133	range inside the scalar. All caveats and parameters are the same
		1134	as for C<aio_msync>, above, except for flags, which must be either
		1135	C<0> (which reads all pages and ensures they are instantiated) or
		1136	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1137	writing an octet from it, which dirties the page).
		1138
		1139	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1140
		1141	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1142	scalars.
		1143
		1144	It reads in all the pages of the underlying storage into memory (if any)
		1145	and locks them, so they are not getting swapped/paged out or removed.
		1146
		1147	If C<$length> is undefined, then the scalar will be locked till the end.
		1148
		1149	On systems that do not implement C<mlock>, this function returns C<-1>
		1150	and sets errno to C<ENOSYS>.
		1151
		1152	Note that the corresponding C<munlock> is synchronous and is
		1153	documented under L<MISCELLANEOUS FUNCTIONS>.
		1154
		1155	Example: open a file, mmap and mlock it - both will be undone when
		1156	C<$data> gets destroyed.
		1157
		1158	open my $fh, "<", $path or die "$path: $!";
		1159	my $data;
		1160	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1161	aio_mlock $data; # mlock in background
		1162
		1163	=item aio_mlockall $flags, $callback->($status)
		1164
		1165	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1166	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1167
		1168	On systems that do not implement C<mlockall>, this function returns C<-1>
		1169	and sets errno to C<ENOSYS>.
		1170
		1171	Note that the corresponding C<munlockall> is synchronous and is
		1172	documented under L<MISCELLANEOUS FUNCTIONS>.
		1173
		1174	Example: asynchronously lock all current and future pages into memory.
		1175
		1176	aio_mlockall IO::AIO::MCL_FUTURE;
		1177
992	=item aio_group $callback->(...)	1178	=item aio_group $callback->(...)
993		1179
994	This is a very special aio request: Instead of doing something, it is a	1180	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	1181	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	1182	many requests into a single, composite, request with a definite callback
…		…
1131	=item $grp->cancel_subs	1317	=item $grp->cancel_subs
1132		1318
1133	Cancel all subrequests and clears any feeder, but not the group request	1319	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.	1320	itself. Useful when you queued a lot of events but got a result early.
1135		1321
		1322	The group request will finish normally (you cannot add requests to the
		1323	group).
		1324
1136	=item $grp->result (...)	1325	=item $grp->result (...)
1137		1326
1138	Set the result value(s) that will be passed to the group callback when all	1327	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	1328	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,	1329	of errno (just like calling C<errno> without an error number). By default,
…		…
1234		1423
1235	Event->io (fd => IO::AIO::poll_fileno,	1424	Event->io (fd => IO::AIO::poll_fileno,
1236	poll => 'r', async => 1,	1425	poll => 'r', async => 1,
1237	cb => \&IO::AIO::poll_cb);	1426	cb => \&IO::AIO::poll_cb);
1238		1427
		1428	=item IO::AIO::poll_wait
		1429
		1430	If there are any outstanding requests and none of them in the result
		1431	phase, wait till the result filehandle becomes ready for reading (simply
		1432	does a C<select> on the filehandle. This is useful if you want to
		1433	synchronously wait for some requests to finish).
		1434
		1435	See C<nreqs> for an example.
		1436
		1437	=item IO::AIO::poll
		1438
		1439	Waits until some requests have been handled.
		1440
		1441	Returns the number of requests processed, but is otherwise strictly
		1442	equivalent to:
		1443
		1444	IO::AIO::poll_wait, IO::AIO::poll_cb
		1445
		1446	=item IO::AIO::flush
		1447
		1448	Wait till all outstanding AIO requests have been handled.
		1449
		1450	Strictly equivalent to:
		1451
		1452	IO::AIO::poll_wait, IO::AIO::poll_cb
		1453	while IO::AIO::nreqs;
		1454
1239	=item IO::AIO::max_poll_reqs $nreqs	1455	=item IO::AIO::max_poll_reqs $nreqs
1240		1456
1241	=item IO::AIO::max_poll_time $seconds	1457	=item IO::AIO::max_poll_time $seconds
1242		1458
1243	These set the maximum number of requests (default C<0>, meaning infinity)	1459	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1267	# use a low priority so other tasks have priority	1483	# use a low priority so other tasks have priority
1268	Event->io (fd => IO::AIO::poll_fileno,	1484	Event->io (fd => IO::AIO::poll_fileno,
1269	poll => 'r', nice => 1,	1485	poll => 'r', nice => 1,
1270	cb => &IO::AIO::poll_cb);	1486	cb => &IO::AIO::poll_cb);
1271		1487
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	1488	=back
1300		1489
1301	=head3 CONTROLLING THE NUMBER OF THREADS	1490	=head3 CONTROLLING THE NUMBER OF THREADS
1302		1491
1303	=over	1492	=over
…		…
1413		1602
1414	Returns the number of bytes copied, or C<-1> on error.	1603	Returns the number of bytes copied, or C<-1> on error.
1415		1604
1416	=item IO::AIO::fadvise $fh, $offset, $len, $advice	1605	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1417		1606
1418	Simply calls the C<posix_fadvise> function (see it's	1607	Simply calls the C<posix_fadvise> function (see its
1419	manpage for details). The following advice constants are	1608	manpage for details). The following advice constants are
1420	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	1609	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1421	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	1610	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1422	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1611	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1423		1612
1424	On systems that do not implement C<posix_fadvise>, this function returns	1613	On systems that do not implement C<posix_fadvise>, this function returns
1425	ENOSYS, otherwise the return value of C<posix_fadvise>.	1614	ENOSYS, otherwise the return value of C<posix_fadvise>.
1426		1615
		1616	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1617
		1618	Simply calls the C<posix_madvise> function (see its
		1619	manpage for details). The following advice constants are
		1620	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1621	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1622
		1623	On systems that do not implement C<posix_madvise>, this function returns
		1624	ENOSYS, otherwise the return value of C<posix_madvise>.
		1625
		1626	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1627
		1628	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1629	$scalar (see its manpage for details). The following protect
		1630	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1631	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1632
		1633	On systems that do not implement C<mprotect>, this function returns
		1634	ENOSYS, otherwise the return value of C<mprotect>.
		1635
		1636	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1637
		1638	Memory-maps a file (or anonymous memory range) and attaches it to the
		1639	given C<$scalar>, which will act like a string scalar.
		1640
		1641	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1642	change the string length, and most read-only operations such as copying it
		1643	or searching it with regexes and so on.
		1644
		1645	Anything else is unsafe and will, at best, result in memory leaks.
		1646
		1647	The memory map associated with the C<$scalar> is automatically removed
		1648	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1649	C<IO::AIO::munmap> functions are called.
		1650
		1651	This calls the C<mmap>(2) function internally. See your system's manual
		1652	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1653
		1654	The C<$length> must be larger than zero and smaller than the actual
		1655	filesize.
		1656
		1657	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1658	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1659
		1660	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1661	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1662	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1663	(which is set to C<MAP_ANON> if your system only provides this
		1664	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1665	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1666	C<IO::AIO::MAP_NONBLOCK>
		1667
		1668	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1669
		1670	C<$offset> is the offset from the start of the file - it generally must be
		1671	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1672
		1673	Example:
		1674
		1675	use Digest::MD5;
		1676	use IO::AIO;
		1677
		1678	open my $fh, "<verybigfile"
		1679	or die "$!";
		1680
		1681	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1682	or die "verybigfile: $!";
		1683
		1684	my $fast_md5 = md5 $data;
		1685
		1686	=item IO::AIO::munmap $scalar
		1687
		1688	Removes a previous mmap and undefines the C<$scalar>.
		1689
		1690	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1691
		1692	Calls the C<munlock> function, undoing the effects of a previous
		1693	C<aio_mlock> call (see its description for details).
		1694
		1695	=item IO::AIO::munlockall
		1696
		1697	Calls the C<munlockall> function.
		1698
		1699	On systems that do not implement C<munlockall>, this function returns
		1700	ENOSYS, otherwise the return value of C<munlockall>.
		1701
1427	=back	1702	=back
1428		1703
1429	=cut	1704	=cut
1430		1705
1431	min_parallel 8;	1706	min_parallel 8;
1432		1707
1433	END { flush }	1708	END { flush }
1434		1709
1435	1;	1710	1;
		1711
		1712	=head1 EVENT LOOP INTEGRATION
		1713
		1714	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1715	automatically into many event loops:
		1716
		1717	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1718	use AnyEvent::AIO;
		1719
		1720	You can also integrate IO::AIO manually into many event loops, here are
		1721	some examples of how to do this:
		1722
		1723	# EV integration
		1724	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1725
		1726	# Event integration
		1727	Event->io (fd => IO::AIO::poll_fileno,
		1728	poll => 'r',
		1729	cb => \&IO::AIO::poll_cb);
		1730
		1731	# Glib/Gtk2 integration
		1732	add_watch Glib::IO IO::AIO::poll_fileno,
		1733	in => sub { IO::AIO::poll_cb; 1 };
		1734
		1735	# Tk integration
		1736	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1737	readable => \&IO::AIO::poll_cb);
		1738
		1739	# Danga::Socket integration
		1740	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1741	\&IO::AIO::poll_cb);
1436		1742
1437	=head2 FORK BEHAVIOUR	1743	=head2 FORK BEHAVIOUR
1438		1744
1439	This module should do "the right thing" when the process using it forks:	1745	This module should do "the right thing" when the process using it forks:
1440		1746

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.187 by root, Fri Feb 11 00:05:17 2011 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.187 by root, Fri Feb 11 00:05:17 2011 UTC