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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.167 by root, Thu Nov 12 01:15:36 2009 UTC vs.
Revision 1.195 by root, Fri May 27 19:56:31 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.9';
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";
317	}	370	}
318	};	371	};
319		372
		373	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		374	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		375	following POSIX and non-POSIX constants are available (missing ones on
		376	your system are, as usual, C<0>):
		377
		378	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		379	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		380	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
		381
320		382
321	=item aio_close $fh, $callback->($status)	383	=item aio_close $fh, $callback->($status)
322		384
323	Asynchronously close a file and call the callback with the result	385	Asynchronously close a file and call the callback with the result
324	code.	386	code.
…		…
376	reading at byte offset C<$in_offset>, and starts writing at the current	438	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	439	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	440	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
379	other.	441	other.
380		442
		443	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		444	are written, and there is no way to find out how many bytes have been read
		445	from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of
		446	bytes written to C<$out_fh>. Only if the result value equals C<$length>
		447	one can assume that C<$length> bytes have been read.
		448
		449	Unlike with other C<aio_> functions, it makes a lot of sense to use
		450	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		451	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		452	the socket I/O will be non-blocking. Note, however, that you can run into
		453	a trap where C<aio_sendfile> reads some data with readahead, then fails
		454	to write all data, and when the socket is ready the next time, the data
		455	in the cache is already lost, forcing C<aio_sendfile> to again hit the
		456	disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage
		457	much better.
		458
381	This call tries to make use of a native C<sendfile> syscall to provide	459	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	460	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.	461	socket, and C<$in_fh> should refer to an mmap'able file.
384		462
385	If the native sendfile call fails or is not implemented, it will be	463	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		464	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
386	emulated, so you can call C<aio_sendfile> on any type of filehandle	465	it will be emulated, so you can call C<aio_sendfile> on any type of
387	regardless of the limitations of the operating system.	466	filehandle regardless of the limitations of the operating system.
388
389	Please note, however, that C<aio_sendfile> can read more bytes from
390	C<$in_fh> than are written, and there is no way to find out how many
391	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
392	provides the number of bytes written to C<$out_fh>. Only if the result
393	value equals C<$length> one can assume that C<$length> bytes have been
394	read.
395		467
396		468
397	=item aio_readahead $fh,$offset,$length, $callback->($retval)	469	=item aio_readahead $fh,$offset,$length, $callback->($retval)
398		470
399	C<aio_readahead> populates the page cache with data from a file so that	471	C<aio_readahead> populates the page cache with data from a file so that
…		…
422		494
423	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	495	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
424	error when stat'ing a large file, the results will be silently truncated	496	error when stat'ing a large file, the results will be silently truncated
425	unless perl itself is compiled with large file support.	497	unless perl itself is compiled with large file support.
426		498
		499	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		500	following constants and functions (if not implemented, the constants will
		501	be C<0> and the functions will either C<croak> or fall back on traditional
		502	behaviour).
		503
		504	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		505	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		506	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		507
427	Example: Print the length of F</etc/passwd>:	508	Example: Print the length of F</etc/passwd>:
428		509
429	aio_stat "/etc/passwd", sub {	510	aio_stat "/etc/passwd", sub {
430	$_[0] and die "stat failed: $!";	511	$_[0] and die "stat failed: $!";
431	print "size is ", -s _, "\n";	512	print "size is ", -s _, "\n";
432	};	513	};
433		514
434		515
		516	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		517
		518	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		519	whether a file handle or path was passed.
		520
		521	On success, the callback is passed a hash reference with the following
		522	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		523	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		524	is passed.
		525
		526	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		527	C<ST_NOSUID>.
		528
		529	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		530	their correct value when available, or to C<0> on systems that do
		531	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		532	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		533	C<ST_NODIRATIME> and C<ST_RELATIME>.
		534
		535	Example: stat C</wd> and dump out the data if successful.
		536
		537	aio_statvfs "/wd", sub {
		538	my $f = $_[0]
		539	or die "statvfs: $!";
		540
		541	use Data::Dumper;
		542	say Dumper $f;
		543	};
		544
		545	# result:
		546	{
		547	bsize => 1024,
		548	bfree => 4333064312,
		549	blocks => 10253828096,
		550	files => 2050765568,
		551	flag => 4096,
		552	favail => 2042092649,
		553	bavail => 4333064312,
		554	ffree => 2042092649,
		555	namemax => 255,
		556	frsize => 1024,
		557	fsid => 1810
		558	}
		559
		560
435	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	561	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
436		562
437	Works like perl's C<utime> function (including the special case of $atime	563	Works like perl's C<utime> function (including the special case of $atime
438	and $mtime being undef). Fractional times are supported if the underlying	564	and $mtime being undef). Fractional times are supported if the underlying
439	syscalls support them.	565	syscalls support them.
…		…
487		613
488	The only (POSIX-) portable way of calling this function is:	614	The only (POSIX-) portable way of calling this function is:
489		615
490	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	616	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
491		617
		618	See C<aio_stat> for info about some potentially helpful extra constants
		619	and functions.
492		620
493	=item aio_link $srcpath, $dstpath, $callback->($status)	621	=item aio_link $srcpath, $dstpath, $callback->($status)
494		622
495	Asynchronously create a new link to the existing object at C<$srcpath> at	623	Asynchronously create a new link to the existing object at C<$srcpath> at
496	the path C<$dstpath> and call the callback with the result code.	624	the path C<$dstpath> and call the callback with the result code.
…		…
549		677
550	=over 4	678	=over 4
551		679
552	=item IO::AIO::READDIR_DENTS	680	=item IO::AIO::READDIR_DENTS
553		681
554	When this flag is off, then the callback gets an arrayref with of names	682	When this flag is off, then the callback gets an arrayref consisting of
555	only (as with C<aio_readdir>), otherwise it gets an arrayref with	683	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
556	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	684	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
557	entry in more detail.	685	entry in more detail.
558		686
559	C<$name> is the name of the entry.	687	C<$name> is the name of the entry.
560		688
…		…
573	systems that do not deliver the inode information.	701	systems that do not deliver the inode information.
574		702
575	=item IO::AIO::READDIR_DIRS_FIRST	703	=item IO::AIO::READDIR_DIRS_FIRST
576		704
577	When this flag is set, then the names will be returned in an order where	705	When this flag is set, then the names will be returned in an order where
578	likely directories come first. This is useful when you need to quickly	706	likely directories come first, in optimal stat order. This is useful when
579	find directories, or you want to find all directories while avoiding to	707	you need to quickly find directories, or you want to find all directories
580	stat() each entry.	708	while avoiding to stat() each entry.
581		709
582	If the system returns type information in readdir, then this is used	710	If the system returns type information in readdir, then this is used
583	to find directories directly. Otherwise, likely directories are files	711	to find directories directly. Otherwise, likely directories are names
584	beginning with ".", or otherwise files with no dots, of which files with	712	beginning with ".", or otherwise names with no dots, of which names with
585	short names are tried first.	713	short names are tried first.
586		714
587	=item IO::AIO::READDIR_STAT_ORDER	715	=item IO::AIO::READDIR_STAT_ORDER
588		716
589	When this flag is set, then the names will be returned in an order	717	When this flag is set, then the names will be returned in an order
…		…
989	};	1117	};
990		1118
991	$grp	1119	$grp
992	}	1120	}
993		1121
		1122	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1123
		1124	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1125	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1126	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1127	scalar must only be modified in-place while an aio operation is pending on
		1128	it).
		1129
		1130	It calls the C<msync> function of your OS, if available, with the memory
		1131	area starting at C<$offset> in the string and ending C<$length> bytes
		1132	later. If C<$length> is negative, counts from the end, and if C<$length>
		1133	is C<undef>, then it goes till the end of the string. The flags can be
		1134	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1135	C<IO::AIO::MS_SYNC>.
		1136
		1137	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1138
		1139	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1140	scalars.
		1141
		1142	It touches (reads or writes) all memory pages in the specified
		1143	range inside the scalar. All caveats and parameters are the same
		1144	as for C<aio_msync>, above, except for flags, which must be either
		1145	C<0> (which reads all pages and ensures they are instantiated) or
		1146	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1147	writing an octet from it, which dirties the page).
		1148
		1149	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1150
		1151	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1152	scalars.
		1153
		1154	It reads in all the pages of the underlying storage into memory (if any)
		1155	and locks them, so they are not getting swapped/paged out or removed.
		1156
		1157	If C<$length> is undefined, then the scalar will be locked till the end.
		1158
		1159	On systems that do not implement C<mlock>, this function returns C<-1>
		1160	and sets errno to C<ENOSYS>.
		1161
		1162	Note that the corresponding C<munlock> is synchronous and is
		1163	documented under L<MISCELLANEOUS FUNCTIONS>.
		1164
		1165	Example: open a file, mmap and mlock it - both will be undone when
		1166	C<$data> gets destroyed.
		1167
		1168	open my $fh, "<", $path or die "$path: $!";
		1169	my $data;
		1170	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1171	aio_mlock $data; # mlock in background
		1172
		1173	=item aio_mlockall $flags, $callback->($status)
		1174
		1175	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1176	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1177
		1178	On systems that do not implement C<mlockall>, this function returns C<-1>
		1179	and sets errno to C<ENOSYS>.
		1180
		1181	Note that the corresponding C<munlockall> is synchronous and is
		1182	documented under L<MISCELLANEOUS FUNCTIONS>.
		1183
		1184	Example: asynchronously lock all current and future pages into memory.
		1185
		1186	aio_mlockall IO::AIO::MCL_FUTURE;
		1187
994	=item aio_group $callback->(...)	1188	=item aio_group $callback->(...)
995		1189
996	This is a very special aio request: Instead of doing something, it is a	1190	This is a very special aio request: Instead of doing something, it is a
997	container for other aio requests, which is useful if you want to bundle	1191	container for other aio requests, which is useful if you want to bundle
998	many requests into a single, composite, request with a definite callback	1192	many requests into a single, composite, request with a definite callback
…		…
1133	=item $grp->cancel_subs	1327	=item $grp->cancel_subs
1134		1328
1135	Cancel all subrequests and clears any feeder, but not the group request	1329	Cancel all subrequests and clears any feeder, but not the group request
1136	itself. Useful when you queued a lot of events but got a result early.	1330	itself. Useful when you queued a lot of events but got a result early.
1137		1331
		1332	The group request will finish normally (you cannot add requests to the
		1333	group).
		1334
1138	=item $grp->result (...)	1335	=item $grp->result (...)
1139		1336
1140	Set the result value(s) that will be passed to the group callback when all	1337	Set the result value(s) that will be passed to the group callback when all
1141	subrequests have finished and set the groups errno to the current value	1338	subrequests have finished and set the groups errno to the current value
1142	of errno (just like calling C<errno> without an error number). By default,	1339	of errno (just like calling C<errno> without an error number). By default,
…		…
1218		1415
1219	See C<poll_cb> for an example.	1416	See C<poll_cb> for an example.
1220		1417
1221	=item IO::AIO::poll_cb	1418	=item IO::AIO::poll_cb
1222		1419
1223	Process some outstanding events on the result pipe. You have to call this	1420	Process some outstanding events on the result pipe. You have to call
1224	regularly. Returns C<0> if all events could be processed, or C<-1> if it	1421	this regularly. Returns C<0> if all events could be processed (or there
1225	returned earlier for whatever reason. Returns immediately when no events	1422	were no events to process), or C<-1> if it returned earlier for whatever
1226	are outstanding. The amount of events processed depends on the settings of	1423	reason. Returns immediately when no events are outstanding. The amount of
1227	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.	1424	events processed depends on the settings of C<IO::AIO::max_poll_req> and
		1425	C<IO::AIO::max_poll_time>.
1228		1426
1229	If not all requests were processed for whatever reason, the filehandle	1427	If not all requests were processed for whatever reason, the filehandle
1230	will still be ready when C<poll_cb> returns, so normally you don't have to	1428	will still be ready when C<poll_cb> returns, so normally you don't have to
1231	do anything special to have it called later.	1429	do anything special to have it called later.
1232		1430
		1431	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1432	ready, it can be beneficial to call this function from loops which submit
		1433	a lot of requests, to make sure the results get processed when they become
		1434	available and not just when the loop is finished and the event loop takes
		1435	over again. This function returns very fast when there are no outstanding
		1436	requests.
		1437
1233	Example: Install an Event watcher that automatically calls	1438	Example: Install an Event watcher that automatically calls
1234	IO::AIO::poll_cb with high priority (more examples can be found in the	1439	IO::AIO::poll_cb with high priority (more examples can be found in the
1235	SYNOPSIS section, at the top of this document):	1440	SYNOPSIS section, at the top of this document):
1236		1441
1237	Event->io (fd => IO::AIO::poll_fileno,	1442	Event->io (fd => IO::AIO::poll_fileno,
1238	poll => 'r', async => 1,	1443	poll => 'r', async => 1,
1239	cb => \&IO::AIO::poll_cb);	1444	cb => \&IO::AIO::poll_cb);
		1445
		1446	=item IO::AIO::poll_wait
		1447
		1448	If there are any outstanding requests and none of them in the result
		1449	phase, wait till the result filehandle becomes ready for reading (simply
		1450	does a C<select> on the filehandle. This is useful if you want to
		1451	synchronously wait for some requests to finish).
		1452
		1453	See C<nreqs> for an example.
		1454
		1455	=item IO::AIO::poll
		1456
		1457	Waits until some requests have been handled.
		1458
		1459	Returns the number of requests processed, but is otherwise strictly
		1460	equivalent to:
		1461
		1462	IO::AIO::poll_wait, IO::AIO::poll_cb
		1463
		1464	=item IO::AIO::flush
		1465
		1466	Wait till all outstanding AIO requests have been handled.
		1467
		1468	Strictly equivalent to:
		1469
		1470	IO::AIO::poll_wait, IO::AIO::poll_cb
		1471	while IO::AIO::nreqs;
1240		1472
1241	=item IO::AIO::max_poll_reqs $nreqs	1473	=item IO::AIO::max_poll_reqs $nreqs
1242		1474
1243	=item IO::AIO::max_poll_time $seconds	1475	=item IO::AIO::max_poll_time $seconds
1244		1476
…		…
1269	# use a low priority so other tasks have priority	1501	# use a low priority so other tasks have priority
1270	Event->io (fd => IO::AIO::poll_fileno,	1502	Event->io (fd => IO::AIO::poll_fileno,
1271	poll => 'r', nice => 1,	1503	poll => 'r', nice => 1,
1272	cb => &IO::AIO::poll_cb);	1504	cb => &IO::AIO::poll_cb);
1273		1505
1274	=item IO::AIO::poll_wait
1275
1276	If there are any outstanding requests and none of them in the result
1277	phase, wait till the result filehandle becomes ready for reading (simply
1278	does a C<select> on the filehandle. This is useful if you want to
1279	synchronously wait for some requests to finish).
1280
1281	See C<nreqs> for an example.
1282
1283	=item IO::AIO::poll
1284
1285	Waits until some requests have been handled.
1286
1287	Returns the number of requests processed, but is otherwise strictly
1288	equivalent to:
1289
1290	IO::AIO::poll_wait, IO::AIO::poll_cb
1291
1292	=item IO::AIO::flush
1293
1294	Wait till all outstanding AIO requests have been handled.
1295
1296	Strictly equivalent to:
1297
1298	IO::AIO::poll_wait, IO::AIO::poll_cb
1299	while IO::AIO::nreqs;
1300
1301	=back	1506	=back
1302		1507
1303	=head3 CONTROLLING THE NUMBER OF THREADS	1508	=head3 CONTROLLING THE NUMBER OF THREADS
1304		1509
1305	=over	1510	=over
…		…
1338		1543
1339	Under normal circumstances you don't need to call this function.	1544	Under normal circumstances you don't need to call this function.
1340		1545
1341	=item IO::AIO::max_idle $nthreads	1546	=item IO::AIO::max_idle $nthreads
1342		1547
1343	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1548	Limit the number of threads (default: 4) that are allowed to idle
1344	threads that did not get a request to process within 10 seconds). That	1549	(i.e., threads that did not get a request to process within the idle
1345	means if a thread becomes idle while C<$nthreads> other threads are also	1550	timeout (default: 10 seconds). That means if a thread becomes idle while
1346	idle, it will free its resources and exit.	1551	C<$nthreads> other threads are also idle, it will free its resources and
		1552	exit.
1347		1553
1348	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1554	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1349	to allow for extremely high load situations, but want to free resources	1555	to allow for extremely high load situations, but want to free resources
1350	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1556	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1351		1557
1352	The default is probably ok in most situations, especially if thread	1558	The default is probably ok in most situations, especially if thread
1353	creation is fast. If thread creation is very slow on your system you might	1559	creation is fast. If thread creation is very slow on your system you might
1354	want to use larger values.	1560	want to use larger values.
1355		1561
		1562	=item IO::AIO::idle_timeout $seconds
		1563
		1564	Sets the minimum idle timeout (default 10) after which worker threads are
		1565	allowed to exit. SEe C<IO::AIO::max_idle>.
		1566
1356	=item IO::AIO::max_outstanding $maxreqs	1567	=item IO::AIO::max_outstanding $maxreqs
		1568
		1569	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1570	you do queue up more than this number of requests, the next call to
		1571	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1572	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1573	longer exceeded.
		1574
		1575	In other words, this setting does not enforce a queue limit, but can be
		1576	used to make poll functions block if the limit is exceeded.
1357		1577
1358	This is a very bad function to use in interactive programs because it	1578	This is a very bad function to use in interactive programs because it
1359	blocks, and a bad way to reduce concurrency because it is inexact: Better	1579	blocks, and a bad way to reduce concurrency because it is inexact: Better
1360	use an C<aio_group> together with a feed callback.	1580	use an C<aio_group> together with a feed callback.
1361		1581
1362	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1582	It's main use is in scripts without an event loop - when you want to stat
1363	do queue up more than this number of requests, the next call to the	1583	a lot of files, you can write somehting like this:
1364	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1365	function will block until the limit is no longer exceeded.
1366		1584
1367	The default value is very large, so there is no practical limit on the	1585	IO::AIO::max_outstanding 32;
1368	number of outstanding requests.
1369		1586
1370	You can still queue as many requests as you want. Therefore,	1587	for my $path (...) {
1371	C<max_outstanding> is mainly useful in simple scripts (with low values) or	1588	aio_stat $path , ...;
1372	as a stop gap to shield against fatal memory overflow (with large values).	1589	IO::AIO::poll_cb;
		1590	}
		1591
		1592	IO::AIO::flush;
		1593
		1594	The call to C<poll_cb> inside the loop will normally return instantly, but
		1595	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1596	some requests have been handled. This keeps the loop from pushing a large
		1597	number of C<aio_stat> requests onto the queue.
		1598
		1599	The default value for C<max_outstanding> is very large, so there is no
		1600	practical limit on the number of outstanding requests.
1373		1601
1374	=back	1602	=back
1375		1603
1376	=head3 STATISTICAL INFORMATION	1604	=head3 STATISTICAL INFORMATION
1377		1605
…		…
1415		1643
1416	Returns the number of bytes copied, or C<-1> on error.	1644	Returns the number of bytes copied, or C<-1> on error.
1417		1645
1418	=item IO::AIO::fadvise $fh, $offset, $len, $advice	1646	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1419		1647
1420	Simply calls the C<posix_fadvise> function (see it's	1648	Simply calls the C<posix_fadvise> function (see its
1421	manpage for details). The following advice constants are	1649	manpage for details). The following advice constants are
1422	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	1650	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1423	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	1651	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1424	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1652	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1425		1653
1426	On systems that do not implement C<posix_fadvise>, this function returns	1654	On systems that do not implement C<posix_fadvise>, this function returns
1427	ENOSYS, otherwise the return value of C<posix_fadvise>.	1655	ENOSYS, otherwise the return value of C<posix_fadvise>.
1428		1656
		1657	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		1658
		1659	Simply calls the C<posix_madvise> function (see its
		1660	manpage for details). The following advice constants are
		1661	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		1662	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
		1663
		1664	On systems that do not implement C<posix_madvise>, this function returns
		1665	ENOSYS, otherwise the return value of C<posix_madvise>.
		1666
		1667	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		1668
		1669	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		1670	$scalar (see its manpage for details). The following protect
		1671	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		1672	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		1673
		1674	On systems that do not implement C<mprotect>, this function returns
		1675	ENOSYS, otherwise the return value of C<mprotect>.
		1676
		1677	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1678
		1679	Memory-maps a file (or anonymous memory range) and attaches it to the
		1680	given C<$scalar>, which will act like a string scalar.
		1681
		1682	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1683	change the string length, and most read-only operations such as copying it
		1684	or searching it with regexes and so on.
		1685
		1686	Anything else is unsafe and will, at best, result in memory leaks.
		1687
		1688	The memory map associated with the C<$scalar> is automatically removed
		1689	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1690	C<IO::AIO::munmap> functions are called.
		1691
		1692	This calls the C<mmap>(2) function internally. See your system's manual
		1693	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1694
		1695	The C<$length> must be larger than zero and smaller than the actual
		1696	filesize.
		1697
		1698	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1699	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1700
		1701	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1702	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1703	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1704	(which is set to C<MAP_ANON> if your system only provides this
		1705	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1706	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1707	C<IO::AIO::MAP_NONBLOCK>
		1708
		1709	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1710
		1711	C<$offset> is the offset from the start of the file - it generally must be
		1712	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1713
		1714	Example:
		1715
		1716	use Digest::MD5;
		1717	use IO::AIO;
		1718
		1719	open my $fh, "<verybigfile"
		1720	or die "$!";
		1721
		1722	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1723	or die "verybigfile: $!";
		1724
		1725	my $fast_md5 = md5 $data;
		1726
		1727	=item IO::AIO::munmap $scalar
		1728
		1729	Removes a previous mmap and undefines the C<$scalar>.
		1730
		1731	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1732
		1733	Calls the C<munlock> function, undoing the effects of a previous
		1734	C<aio_mlock> call (see its description for details).
		1735
		1736	=item IO::AIO::munlockall
		1737
		1738	Calls the C<munlockall> function.
		1739
		1740	On systems that do not implement C<munlockall>, this function returns
		1741	ENOSYS, otherwise the return value of C<munlockall>.
		1742
1429	=back	1743	=back
1430		1744
1431	=cut	1745	=cut
1432		1746
1433	min_parallel 8;	1747	min_parallel 8;
1434		1748
1435	END { flush }	1749	END { flush }
1436		1750
1437	1;	1751	1;
		1752
		1753	=head1 EVENT LOOP INTEGRATION
		1754
		1755	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1756	automatically into many event loops:
		1757
		1758	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1759	use AnyEvent::AIO;
		1760
		1761	You can also integrate IO::AIO manually into many event loops, here are
		1762	some examples of how to do this:
		1763
		1764	# EV integration
		1765	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1766
		1767	# Event integration
		1768	Event->io (fd => IO::AIO::poll_fileno,
		1769	poll => 'r',
		1770	cb => \&IO::AIO::poll_cb);
		1771
		1772	# Glib/Gtk2 integration
		1773	add_watch Glib::IO IO::AIO::poll_fileno,
		1774	in => sub { IO::AIO::poll_cb; 1 };
		1775
		1776	# Tk integration
		1777	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1778	readable => \&IO::AIO::poll_cb);
		1779
		1780	# Danga::Socket integration
		1781	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1782	\&IO::AIO::poll_cb);
1438		1783
1439	=head2 FORK BEHAVIOUR	1784	=head2 FORK BEHAVIOUR
1440		1785
1441	This module should do "the right thing" when the process using it forks:	1786	This module should do "the right thing" when the process using it forks:
1442		1787

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.167 by root, Thu Nov 12 01:15:36 2009 UTC vs. Revision 1.195 by root, Fri May 27 19:56:31 2011 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.167 by root, Thu Nov 12 01:15:36 2009 UTC vs.
Revision 1.195 by root, Fri May 27 19:56:31 2011 UTC