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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.169 by root, Sat Jan 2 13:02:20 2010 UTC vs.
Revision 1.193 by root, Thu May 26 04:15:37 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;
…		…
191	use common::sense;	168	use common::sense;
192		169
193	use base 'Exporter';	170	use base 'Exporter';
194		171
195	BEGIN {	172	BEGIN {
196	our $VERSION = '3.31';	173	our $VERSION = '3.8';
197		174
198	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
199	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
200	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
201	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
203	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
204	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);
205		184
206	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208	min_parallel max_parallel max_idle	187	min_parallel max_parallel max_idle idle_timeout
209	nreqs nready npending nthreads	188	nreqs nready npending nthreads
210	max_poll_time max_poll_reqs	189	max_poll_time max_poll_reqs
211	sendfile fadvise);	190	sendfile fadvise madvise
		191	mmap munmap munlock munlockall);
212		192
213	push @AIO_REQ, qw(aio_busy); # not exported	193	push @AIO_REQ, qw(aio_busy); # not exported
214		194
215	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	195	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216		196
217	require XSLoader;	197	require XSLoader;
218	XSLoader::load ("IO::AIO", $VERSION);	198	XSLoader::load ("IO::AIO", $VERSION);
219	}	199	}
220		200
221	=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::idle_timeout $seconds
		264	IO::AIO::max_outstanding $maxreqs
		265	IO::AIO::nreqs
		266	IO::AIO::nready
		267	IO::AIO::npending
		268
		269	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		270	IO::AIO::fadvise $fh, $offset, $len, $advice
		271	IO::AIO::madvise $scalar, $offset, $length, $advice
		272	IO::AIO::mprotect $scalar, $offset, $length, $protect
		273	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		274	IO::AIO::munlockall
222		275
223	=head2 AIO REQUEST FUNCTIONS	276	=head2 AIO REQUEST FUNCTIONS
224		277
225	All the C<aio_*> calls are more or less thin wrappers around the syscall	278	All the C<aio_*> calls are more or less thin wrappers around the syscall
226	with the same name (sans C<aio_>). The arguments are similar or identical,	279	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
306	by the umask in effect then the request is being executed, so better never	359	by the umask in effect then the request is being executed, so better never
307	change the umask.	360	change the umask.
308		361
309	Example:	362	Example:
310		363
311	aio_open "/etc/passwd", O_RDONLY, 0, sub {	364	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312	if ($_[0]) {	365	if ($_[0]) {
313	print "open successful, fh is $_[0]\n";	366	print "open successful, fh is $_[0]\n";
314	...	367	...
315	} else {	368	} else {
316	die "open failed: $!\n";	369	die "open failed: $!\n";
…		…
376	reading at byte offset C<$in_offset>, and starts writing at the current	429	reading at byte offset C<$in_offset>, and starts writing at the current
377	file offset of C<$out_fh>. Because of that, it is not safe to issue more	430	file offset of C<$out_fh>. Because of that, it is not safe to issue more
378	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	431	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
379	other.	432	other.
380		433
		434	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		435	are written, and there is no way to find out how many bytes have been read
		436	from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of
		437	bytes written to C<$out_fh>. Only if the result value equals C<$length>
		438	one can assume that C<$length> bytes have been read.
		439
		440	Unlike with other C<aio_> functions, it makes a lot of sense to use
		441	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		442	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		443	the socket I/O will be non-blocking. Note, however, that you can run into
		444	a trap where C<aio_sendfile> reads some data with readahead, then fails
		445	to write all data, and when the socket is ready the next time, the data
		446	in the cache is already lost, forcing C<aio_sendfile> to again hit the
		447	disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage
		448	much better.
		449
381	This call tries to make use of a native C<sendfile> syscall to provide	450	This call tries to make use of a native C<sendfile> syscall to provide
382	zero-copy operation. For this to work, C<$out_fh> should refer to a	451	zero-copy operation. For this to work, C<$out_fh> should refer to a
383	socket, and C<$in_fh> should refer to mmap'able file.	452	socket, and C<$in_fh> should refer to an mmap'able file.
384		453
385	If the native sendfile call fails with C<ENOSYS>, C<ENOTSUP>,	454	If a native sendfile cannot be found or it fails with C<ENOSYS>,
386	C<EOPNOTSUPP> or C<ENOTSOCK>, or is not implemented, it will be emulated,	455	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
387	so you can call C<aio_sendfile> on any type of filehandle regardless of	456	it will be emulated, so you can call C<aio_sendfile> on any type of
388	the limitations of the operating system.	457	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		458
397		459
398	=item aio_readahead $fh,$offset,$length, $callback->($retval)	460	=item aio_readahead $fh,$offset,$length, $callback->($retval)
399		461
400	C<aio_readahead> populates the page cache with data from a file so that	462	C<aio_readahead> populates the page cache with data from a file so that
…		…
423		485
424	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	486	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	487	error when stat'ing a large file, the results will be silently truncated
426	unless perl itself is compiled with large file support.	488	unless perl itself is compiled with large file support.
427		489
		490	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		491	following constants and functions (if not implemented, the constants will
		492	be C<0> and the functions will either C<croak> or fall back on traditional
		493	behaviour).
		494
		495	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		496	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		497	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		498
428	Example: Print the length of F</etc/passwd>:	499	Example: Print the length of F</etc/passwd>:
429		500
430	aio_stat "/etc/passwd", sub {	501	aio_stat "/etc/passwd", sub {
431	$_[0] and die "stat failed: $!";	502	$_[0] and die "stat failed: $!";
432	print "size is ", -s _, "\n";	503	print "size is ", -s _, "\n";
433	};	504	};
434		505
435		506
		507	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		508
		509	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		510	whether a file handle or path was passed.
		511
		512	On success, the callback is passed a hash reference with the following
		513	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		514	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		515	is passed.
		516
		517	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		518	C<ST_NOSUID>.
		519
		520	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		521	their correct value when available, or to C<0> on systems that do
		522	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		523	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		524	C<ST_NODIRATIME> and C<ST_RELATIME>.
		525
		526	Example: stat C</wd> and dump out the data if successful.
		527
		528	aio_statvfs "/wd", sub {
		529	my $f = $_[0]
		530	or die "statvfs: $!";
		531
		532	use Data::Dumper;
		533	say Dumper $f;
		534	};
		535
		536	# result:
		537	{
		538	bsize => 1024,
		539	bfree => 4333064312,
		540	blocks => 10253828096,
		541	files => 2050765568,
		542	flag => 4096,
		543	favail => 2042092649,
		544	bavail => 4333064312,
		545	ffree => 2042092649,
		546	namemax => 255,
		547	frsize => 1024,
		548	fsid => 1810
		549	}
		550
		551
436	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	552	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437		553
438	Works like perl's C<utime> function (including the special case of $atime	554	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	555	and $mtime being undef). Fractional times are supported if the underlying
440	syscalls support them.	556	syscalls support them.
…		…
488		604
489	The only (POSIX-) portable way of calling this function is:	605	The only (POSIX-) portable way of calling this function is:
490		606
491	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	607	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
492		608
		609	See C<aio_stat> for info about some potentially helpful extra constants
		610	and functions.
493		611
494	=item aio_link $srcpath, $dstpath, $callback->($status)	612	=item aio_link $srcpath, $dstpath, $callback->($status)
495		613
496	Asynchronously create a new link to the existing object at C<$srcpath> at	614	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.	615	the path C<$dstpath> and call the callback with the result code.
…		…
550		668
551	=over 4	669	=over 4
552		670
553	=item IO::AIO::READDIR_DENTS	671	=item IO::AIO::READDIR_DENTS
554		672
555	When this flag is off, then the callback gets an arrayref with of names	673	When this flag is off, then the callback gets an arrayref consisting of
556	only (as with C<aio_readdir>), otherwise it gets an arrayref with	674	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
557	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	675	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
558	entry in more detail.	676	entry in more detail.
559		677
560	C<$name> is the name of the entry.	678	C<$name> is the name of the entry.
561		679
…		…
574	systems that do not deliver the inode information.	692	systems that do not deliver the inode information.
575		693
576	=item IO::AIO::READDIR_DIRS_FIRST	694	=item IO::AIO::READDIR_DIRS_FIRST
577		695
578	When this flag is set, then the names will be returned in an order where	696	When this flag is set, then the names will be returned in an order where
579	likely directories come first. This is useful when you need to quickly	697	likely directories come first, in optimal stat order. This is useful when
580	find directories, or you want to find all directories while avoiding to	698	you need to quickly find directories, or you want to find all directories
581	stat() each entry.	699	while avoiding to stat() each entry.
582		700
583	If the system returns type information in readdir, then this is used	701	If the system returns type information in readdir, then this is used
584	to find directories directly. Otherwise, likely directories are files	702	to find directories directly. Otherwise, likely directories are names
585	beginning with ".", or otherwise files with no dots, of which files with	703	beginning with ".", or otherwise names with no dots, of which names with
586	short names are tried first.	704	short names are tried first.
587		705
588	=item IO::AIO::READDIR_STAT_ORDER	706	=item IO::AIO::READDIR_STAT_ORDER
589		707
590	When this flag is set, then the names will be returned in an order	708	When this flag is set, then the names will be returned in an order
…		…
990	};	1108	};
991		1109
992	$grp	1110	$grp
993	}	1111	}
994		1112
		1113	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1114
		1115	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1116	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1117	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1118	scalar must only be modified in-place while an aio operation is pending on
		1119	it).
		1120
		1121	It calls the C<msync> function of your OS, if available, with the memory
		1122	area starting at C<$offset> in the string and ending C<$length> bytes
		1123	later. If C<$length> is negative, counts from the end, and if C<$length>
		1124	is C<undef>, then it goes till the end of the string. The flags can be
		1125	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1126	C<IO::AIO::MS_SYNC>.
		1127
		1128	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1129
		1130	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1131	scalars.
		1132
		1133	It touches (reads or writes) all memory pages in the specified
		1134	range inside the scalar. All caveats and parameters are the same
		1135	as for C<aio_msync>, above, except for flags, which must be either
		1136	C<0> (which reads all pages and ensures they are instantiated) or
		1137	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1138	writing an octet from it, which dirties the page).
		1139
		1140	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1141
		1142	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1143	scalars.
		1144
		1145	It reads in all the pages of the underlying storage into memory (if any)
		1146	and locks them, so they are not getting swapped/paged out or removed.
		1147
		1148	If C<$length> is undefined, then the scalar will be locked till the end.
		1149
		1150	On systems that do not implement C<mlock>, this function returns C<-1>
		1151	and sets errno to C<ENOSYS>.
		1152
		1153	Note that the corresponding C<munlock> is synchronous and is
		1154	documented under L<MISCELLANEOUS FUNCTIONS>.
		1155
		1156	Example: open a file, mmap and mlock it - both will be undone when
		1157	C<$data> gets destroyed.
		1158
		1159	open my $fh, "<", $path or die "$path: $!";
		1160	my $data;
		1161	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1162	aio_mlock $data; # mlock in background
		1163
		1164	=item aio_mlockall $flags, $callback->($status)
		1165
		1166	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1167	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1168
		1169	On systems that do not implement C<mlockall>, this function returns C<-1>
		1170	and sets errno to C<ENOSYS>.
		1171
		1172	Note that the corresponding C<munlockall> is synchronous and is
		1173	documented under L<MISCELLANEOUS FUNCTIONS>.
		1174
		1175	Example: asynchronously lock all current and future pages into memory.
		1176
		1177	aio_mlockall IO::AIO::MCL_FUTURE;
		1178
995	=item aio_group $callback->(...)	1179	=item aio_group $callback->(...)
996		1180
997	This is a very special aio request: Instead of doing something, it is a	1181	This is a very special aio request: Instead of doing something, it is a
998	container for other aio requests, which is useful if you want to bundle	1182	container for other aio requests, which is useful if you want to bundle
999	many requests into a single, composite, request with a definite callback	1183	many requests into a single, composite, request with a definite callback
…		…
1222		1406
1223	See C<poll_cb> for an example.	1407	See C<poll_cb> for an example.
1224		1408
1225	=item IO::AIO::poll_cb	1409	=item IO::AIO::poll_cb
1226		1410
1227	Process some outstanding events on the result pipe. You have to call this	1411	Process some outstanding events on the result pipe. You have to call
1228	regularly. Returns C<0> if all events could be processed, or C<-1> if it	1412	this regularly. Returns C<0> if all events could be processed (or there
1229	returned earlier for whatever reason. Returns immediately when no events	1413	were no events to process), or C<-1> if it returned earlier for whatever
1230	are outstanding. The amount of events processed depends on the settings of	1414	reason. Returns immediately when no events are outstanding. The amount of
1231	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1415	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1416	C<IO::AIO::max_poll_time>.
1232		1417
1233	If not all requests were processed for whatever reason, the filehandle	1418	If not all requests were processed for whatever reason, the filehandle
1234	will still be ready when C<poll_cb> returns, so normally you don't have to	1419	will still be ready when C<poll_cb> returns, so normally you don't have to
1235	do anything special to have it called later.	1420	do anything special to have it called later.
1236		1421
		1422	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1423	ready, it can be beneficial to call this function from loops which submit
		1424	a lot of requests, to make sure the results get processed when they become
		1425	available and not just when the loop is finished and the event loop takes
		1426	over again. This function returns very fast when there are no outstanding
		1427	requests.
		1428
1237	Example: Install an Event watcher that automatically calls	1429	Example: Install an Event watcher that automatically calls
1238	IO::AIO::poll_cb with high priority (more examples can be found in the	1430	IO::AIO::poll_cb with high priority (more examples can be found in the
1239	SYNOPSIS section, at the top of this document):	1431	SYNOPSIS section, at the top of this document):
1240		1432
1241	Event->io (fd => IO::AIO::poll_fileno,	1433	Event->io (fd => IO::AIO::poll_fileno,
1242	poll => 'r', async => 1,	1434	poll => 'r', async => 1,
1243	cb => \&IO::AIO::poll_cb);	1435	cb => \&IO::AIO::poll_cb);
		1436
		1437	=item IO::AIO::poll_wait
		1438
		1439	If there are any outstanding requests and none of them in the result
		1440	phase, wait till the result filehandle becomes ready for reading (simply
		1441	does a C<select> on the filehandle. This is useful if you want to
		1442	synchronously wait for some requests to finish).
		1443
		1444	See C<nreqs> for an example.
		1445
		1446	=item IO::AIO::poll
		1447
		1448	Waits until some requests have been handled.
		1449
		1450	Returns the number of requests processed, but is otherwise strictly
		1451	equivalent to:
		1452
		1453	IO::AIO::poll_wait, IO::AIO::poll_cb
		1454
		1455	=item IO::AIO::flush
		1456
		1457	Wait till all outstanding AIO requests have been handled.
		1458
		1459	Strictly equivalent to:
		1460
		1461	IO::AIO::poll_wait, IO::AIO::poll_cb
		1462	while IO::AIO::nreqs;
1244		1463
1245	=item IO::AIO::max_poll_reqs $nreqs	1464	=item IO::AIO::max_poll_reqs $nreqs
1246		1465
1247	=item IO::AIO::max_poll_time $seconds	1466	=item IO::AIO::max_poll_time $seconds
1248		1467
…		…
1273	# use a low priority so other tasks have priority	1492	# use a low priority so other tasks have priority
1274	Event->io (fd => IO::AIO::poll_fileno,	1493	Event->io (fd => IO::AIO::poll_fileno,
1275	poll => 'r', nice => 1,	1494	poll => 'r', nice => 1,
1276	cb => &IO::AIO::poll_cb);	1495	cb => &IO::AIO::poll_cb);
1277		1496
1278	=item IO::AIO::poll_wait
1279
1280	If there are any outstanding requests and none of them in the result
1281	phase, wait till the result filehandle becomes ready for reading (simply
1282	does a C<select> on the filehandle. This is useful if you want to
1283	synchronously wait for some requests to finish).
1284
1285	See C<nreqs> for an example.
1286
1287	=item IO::AIO::poll
1288
1289	Waits until some requests have been handled.
1290
1291	Returns the number of requests processed, but is otherwise strictly
1292	equivalent to:
1293
1294	IO::AIO::poll_wait, IO::AIO::poll_cb
1295
1296	=item IO::AIO::flush
1297
1298	Wait till all outstanding AIO requests have been handled.
1299
1300	Strictly equivalent to:
1301
1302	IO::AIO::poll_wait, IO::AIO::poll_cb
1303	while IO::AIO::nreqs;
1304
1305	=back	1497	=back
1306		1498
1307	=head3 CONTROLLING THE NUMBER OF THREADS	1499	=head3 CONTROLLING THE NUMBER OF THREADS
1308		1500
1309	=over	1501	=over
…		…
1342		1534
1343	Under normal circumstances you don't need to call this function.	1535	Under normal circumstances you don't need to call this function.
1344		1536
1345	=item IO::AIO::max_idle $nthreads	1537	=item IO::AIO::max_idle $nthreads
1346		1538
1347	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1539	Limit the number of threads (default: 4) that are allowed to idle
1348	threads that did not get a request to process within 10 seconds). That	1540	(i.e., threads that did not get a request to process within the idle
1349	means if a thread becomes idle while C<$nthreads> other threads are also	1541	timeout (default: 10 seconds). That means if a thread becomes idle while
1350	idle, it will free its resources and exit.	1542	C<$nthreads> other threads are also idle, it will free its resources and
		1543	exit.
1351		1544
1352	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1545	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1353	to allow for extremely high load situations, but want to free resources	1546	to allow for extremely high load situations, but want to free resources
1354	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1547	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1355		1548
1356	The default is probably ok in most situations, especially if thread	1549	The default is probably ok in most situations, especially if thread
1357	creation is fast. If thread creation is very slow on your system you might	1550	creation is fast. If thread creation is very slow on your system you might
1358	want to use larger values.	1551	want to use larger values.
		1552
		1553	=item IO::AIO::idle_timeout $seconds
		1554
		1555	Sets the minimum idle timeout (default 10) after which worker threads are
		1556	allowed to exit. SEe C<IO::AIO::max_idle>.
1359		1557
1360	=item IO::AIO::max_outstanding $maxreqs	1558	=item IO::AIO::max_outstanding $maxreqs
1361		1559
1362	This is a very bad function to use in interactive programs because it	1560	This is a very bad function to use in interactive programs because it
1363	blocks, and a bad way to reduce concurrency because it is inexact: Better	1561	blocks, and a bad way to reduce concurrency because it is inexact: Better
…		…
1419		1617
1420	Returns the number of bytes copied, or C<-1> on error.	1618	Returns the number of bytes copied, or C<-1> on error.
1421		1619
1422	=item IO::AIO::fadvise $fh, $offset, $len, $advice	1620	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1423		1621
1424	Simply calls the C<posix_fadvise> function (see it's	1622	Simply calls the C<posix_fadvise> function (see its
1425	manpage for details). The following advice constants are	1623	manpage for details). The following advice constants are
1426	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	1624	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1427	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	1625	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1428	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1626	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1429		1627
1430	On systems that do not implement C<posix_fadvise>, this function returns	1628	On systems that do not implement C<posix_fadvise>, this function returns
1431	ENOSYS, otherwise the return value of C<posix_fadvise>.	1629	ENOSYS, otherwise the return value of C<posix_fadvise>.
1432		1630
		1631	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1632
		1633	Simply calls the C<posix_madvise> function (see its
		1634	manpage for details). The following advice constants are
		1635	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1636	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1637
		1638	On systems that do not implement C<posix_madvise>, this function returns
		1639	ENOSYS, otherwise the return value of C<posix_madvise>.
		1640
		1641	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1642
		1643	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1644	$scalar (see its manpage for details). The following protect
		1645	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1646	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1647
		1648	On systems that do not implement C<mprotect>, this function returns
		1649	ENOSYS, otherwise the return value of C<mprotect>.
		1650
		1651	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1652
		1653	Memory-maps a file (or anonymous memory range) and attaches it to the
		1654	given C<$scalar>, which will act like a string scalar.
		1655
		1656	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1657	change the string length, and most read-only operations such as copying it
		1658	or searching it with regexes and so on.
		1659
		1660	Anything else is unsafe and will, at best, result in memory leaks.
		1661
		1662	The memory map associated with the C<$scalar> is automatically removed
		1663	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1664	C<IO::AIO::munmap> functions are called.
		1665
		1666	This calls the C<mmap>(2) function internally. See your system's manual
		1667	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1668
		1669	The C<$length> must be larger than zero and smaller than the actual
		1670	filesize.
		1671
		1672	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1673	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1674
		1675	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1676	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1677	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1678	(which is set to C<MAP_ANON> if your system only provides this
		1679	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1680	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1681	C<IO::AIO::MAP_NONBLOCK>
		1682
		1683	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1684
		1685	C<$offset> is the offset from the start of the file - it generally must be
		1686	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1687
		1688	Example:
		1689
		1690	use Digest::MD5;
		1691	use IO::AIO;
		1692
		1693	open my $fh, "<verybigfile"
		1694	or die "$!";
		1695
		1696	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1697	or die "verybigfile: $!";
		1698
		1699	my $fast_md5 = md5 $data;
		1700
		1701	=item IO::AIO::munmap $scalar
		1702
		1703	Removes a previous mmap and undefines the C<$scalar>.
		1704
		1705	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1706
		1707	Calls the C<munlock> function, undoing the effects of a previous
		1708	C<aio_mlock> call (see its description for details).
		1709
		1710	=item IO::AIO::munlockall
		1711
		1712	Calls the C<munlockall> function.
		1713
		1714	On systems that do not implement C<munlockall>, this function returns
		1715	ENOSYS, otherwise the return value of C<munlockall>.
		1716
1433	=back	1717	=back
1434		1718
1435	=cut	1719	=cut
1436		1720
1437	min_parallel 8;	1721	min_parallel 8;
1438		1722
1439	END { flush }	1723	END { flush }
1440		1724
1441	1;	1725	1;
		1726
		1727	=head1 EVENT LOOP INTEGRATION
		1728
		1729	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1730	automatically into many event loops:
		1731
		1732	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1733	use AnyEvent::AIO;
		1734
		1735	You can also integrate IO::AIO manually into many event loops, here are
		1736	some examples of how to do this:
		1737
		1738	# EV integration
		1739	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1740
		1741	# Event integration
		1742	Event->io (fd => IO::AIO::poll_fileno,
		1743	poll => 'r',
		1744	cb => \&IO::AIO::poll_cb);
		1745
		1746	# Glib/Gtk2 integration
		1747	add_watch Glib::IO IO::AIO::poll_fileno,
		1748	in => sub { IO::AIO::poll_cb; 1 };
		1749
		1750	# Tk integration
		1751	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1752	readable => \&IO::AIO::poll_cb);
		1753
		1754	# Danga::Socket integration
		1755	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1756	\&IO::AIO::poll_cb);
1442		1757
1443	=head2 FORK BEHAVIOUR	1758	=head2 FORK BEHAVIOUR
1444		1759
1445	This module should do "the right thing" when the process using it forks:	1760	This module should do "the right thing" when the process using it forks:
1446		1761

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.169 by root, Sat Jan 2 13:02:20 2010 UTC vs. Revision 1.193 by root, Thu May 26 04:15:37 2011 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.169 by root, Sat Jan 2 13:02:20 2010 UTC vs.
Revision 1.193 by root, Thu May 26 04:15:37 2011 UTC