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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.147 by root, Wed Jun 3 12:24:49 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
…		…
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30		30
31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32	use AnyEvent::AIO;
33
34	# EV integration
35	my $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
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.	34	operating system supports. It is implemented as an interface to C<libeio>
		35	(L<http://software.schmorp.de/pkg/libeio.html>).
58		36
59	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
60	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
61	will still block, but you can do something else in the meantime. This	39	will still block, but you can do something else in the meantime. This
62	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
66	on a RAID volume or over NFS when you do a number of stat operations	44	on a RAID volume or over NFS when you do a number of stat operations
67	concurrently.	45	concurrently.
68		46
69	While most of this works on all types of file descriptors (for	47	While most of this works on all types of file descriptors (for
70	example sockets), using these functions on file descriptors that	48	example sockets), using these functions on file descriptors that
71	support nonblocking operation (again, sockets, pipes etc.) is very	49	support nonblocking operation (again, sockets, pipes etc.) is
72	inefficient. Use an event loop for that (such as the L<Event\|Event>	50	very inefficient. Use an event loop for that (such as the L<EV>
73	module): IO::AIO will naturally fit into such an event loop itself.	51	module): IO::AIO will naturally fit into such an event loop itself.
74		52
75	In this version, a number of threads are started that execute your	53	In this version, a number of threads are started that execute your
76	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
77	in perl, and the threads created by this module will not be visible	55	in perl, and the threads created by this module will not be visible
…		…
87	yourself, always call C<poll_cb> from within the same thread, or never	65	yourself, always call C<poll_cb> from within the same thread, or never
88	call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
89		67
90	=head2 EXAMPLE	68	=head2 EXAMPLE
91		69
92	This is a simple example that uses the Event module and loads	70	This is a simple example that uses the EV module and loads
93	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
94		72
95	use Fcntl;	73	use Fcntl;
96	use Event;	74	use EV;
97	use IO::AIO;	75	use IO::AIO;
98		76
99	# register the IO::AIO callback with Event	77	# register the IO::AIO callback with EV
100	Event->io (fd => IO::AIO::poll_fileno,	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
101	poll => 'r',
102	cb => \&IO::AIO::poll_cb);
103		79
104	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
105	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
106	my $fh = shift	82	my $fh = shift
107	or die "error while opening: $!";	83	or die "error while opening: $!";
108		84
109	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
110	my $size = -s $fh;	86	my $size = -s $fh;
…		…
119		95
120	# file contents now in $contents	96	# file contents now in $contents
121	print $contents;	97	print $contents;
122		98
123	# exit event loop and program	99	# exit event loop and program
124	Event::unloop;	100	EV::unloop;
125	};	101	};
126	};	102	};
127		103
128	# possibly queue up other requests, or open GUI windows,	104	# possibly queue up other requests, or open GUI windows,
129	# check for sockets etc. etc.	105	# check for sockets etc. etc.
130		106
131	# process events as long as there are some:	107	# process events as long as there are some:
132	Event::loop;	108	EV::loop;
133		109
134	=head1 REQUEST ANATOMY AND LIFETIME	110	=head1 REQUEST ANATOMY AND LIFETIME
135		111
136	Every C<aio_*> function creates a request. which is a C data structure not	112	Every C<aio_*> function creates a request. which is a C data structure not
137	directly visible to Perl.	113	directly visible to Perl.
…		…
187		163
188	package IO::AIO;	164	package IO::AIO;
189		165
190	use Carp ();	166	use Carp ();
191		167
192	no warnings;	168	use common::sense;
193	use strict 'vars';
194		169
195	use base 'Exporter';	170	use base 'Exporter';
196		171
197	BEGIN {	172	BEGIN {
198	our $VERSION = '3.19';	173	our $VERSION = '3.72';
199		174
200	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
201	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
202	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync	177	aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
205	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
206	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);
207		184
208	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
209	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
210	min_parallel max_parallel max_idle	187	min_parallel max_parallel max_idle
211	nreqs nready npending nthreads	188	nreqs nready npending nthreads
212	max_poll_time max_poll_reqs);	189	max_poll_time max_poll_reqs
		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.
…		…
533		650
534	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	651	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
535	directory (i.e. opendir + readdir + closedir). The entries will not be	652	directory (i.e. opendir + readdir + closedir). The entries will not be
536	sorted, and will B<NOT> include the C<.> and C<..> entries.	653	sorted, and will B<NOT> include the C<.> and C<..> entries.
537		654
538	The callback a single argument which is either C<undef> or an array-ref	655	The callback is passed a single argument which is either C<undef> or an
539	with the filenames.	656	array-ref with the filenames.
		657
		658
		659	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		660
		661	Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
		662	behaviour and output format. In case of an error, C<$entries> will be
		663	C<undef>.
		664
		665	The flags are a combination of the following constants, ORed together (the
		666	flags will also be passed to the callback, possibly modified):
		667
		668	=over 4
		669
		670	=item IO::AIO::READDIR_DENTS
		671
		672	When this flag is off, then the callback gets an arrayref with of names
		673	only (as with C<aio_readdir>), otherwise it gets an arrayref with
		674	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		675	entry in more detail.
		676
		677	C<$name> is the name of the entry.
		678
		679	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		680
		681	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		682	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		683	C<IO::AIO::DT_WHT>.
		684
		685	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		686	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		687	scalars are read-only: you can not modify them.
		688
		689	C<$inode> is the inode number (which might not be exact on systems with 64
		690	bit inode numbers and 32 bit perls). This field has unspecified content on
		691	systems that do not deliver the inode information.
		692
		693	=item IO::AIO::READDIR_DIRS_FIRST
		694
		695	When this flag is set, then the names will be returned in an order where
		696	likely directories come first. This is useful when you need to quickly
		697	find directories, or you want to find all directories while avoiding to
		698	stat() each entry.
		699
		700	If the system returns type information in readdir, then this is used
		701	to find directories directly. Otherwise, likely directories are files
		702	beginning with ".", or otherwise files with no dots, of which files with
		703	short names are tried first.
		704
		705	=item IO::AIO::READDIR_STAT_ORDER
		706
		707	When this flag is set, then the names will be returned in an order
		708	suitable for stat()'ing each one. That is, when you plan to stat()
		709	all files in the given directory, then the returned order will likely
		710	be fastest.
		711
		712	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		713	the likely dirs come first, resulting in a less optimal stat order.
		714
		715	=item IO::AIO::READDIR_FOUND_UNKNOWN
		716
		717	This flag should not be set when calling C<aio_readdirx>. Instead, it
		718	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		719	C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
		720	C<$type>'s are known, which can be used to speed up some algorithms.
		721
		722	=back
540		723
541		724
542	=item aio_load $path, $data, $callback->($status)	725	=item aio_load $path, $data, $callback->($status)
543		726
544	This is a composite request that tries to fully load the given file into	727	This is a composite request that tries to fully load the given file into
…		…
569		752
570	=item aio_copy $srcpath, $dstpath, $callback->($status)	753	=item aio_copy $srcpath, $dstpath, $callback->($status)
571		754
572	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
573	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
574	the C<0> (error) or C<-1> ok.	757	a status of C<0> (ok) or C<-1> (error, see C<$!>).
575		758
576	This is a composite request that creates the destination file with	759	This is a composite request that creates the destination file with
577	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
578	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	761	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
579	uid/gid, in that order.	762	uid/gid, in that order.
…		…
591	my $grp = aio_group $cb;	774	my $grp = aio_group $cb;
592		775
593	aioreq_pri $pri;	776	aioreq_pri $pri;
594	add $grp aio_open $src, O_RDONLY, 0, sub {	777	add $grp aio_open $src, O_RDONLY, 0, sub {
595	if (my $src_fh = $_[0]) {	778	if (my $src_fh = $_[0]) {
596	my @stat = stat $src_fh; # hmm, might bock over nfs?	779	my @stat = stat $src_fh; # hmm, might block over nfs?
597		780
598	aioreq_pri $pri;	781	aioreq_pri $pri;
599	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 {
600	if (my $dst_fh = $_[0]) {	783	if (my $dst_fh = $_[0]) {
601	aioreq_pri $pri;	784	aioreq_pri $pri;
…		…
648		831
649	=item aio_move $srcpath, $dstpath, $callback->($status)	832	=item aio_move $srcpath, $dstpath, $callback->($status)
650		833
651	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
652	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
653	the C<0> (error) or C<-1> ok.	836	a status of C<0> (ok) or C<-1> (error, see C<$!>).
654		837
655	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
656	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
657	that is successful, unlinks the C<$srcpath>.	840	that is successful, unlinks the C<$srcpath>.
658		841
…		…
709		892
710	Implementation notes.	893	Implementation notes.
711		894
712	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	895	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
713		896
		897	If readdir returns file type information, then this is used directly to
		898	find directories.
		899
714	After reading the directory, the modification time, size etc. of the	900	Otherwise, after reading the directory, the modification time, size etc.
715	directory before and after the readdir is checked, and if they match (and	901	of the directory before and after the readdir is checked, and if they
716	isn't the current time), the link count will be used to decide how many	902	match (and isn't the current time), the link count will be used to decide
717	entries are directories (if >= 2). Otherwise, no knowledge of the number	903	how many entries are directories (if >= 2). Otherwise, no knowledge of the
718	of subdirectories will be assumed.	904	number of subdirectories will be assumed.
719		905
720	Then entries will be sorted into likely directories (everything without	906	Then entries will be sorted into likely directories a non-initial dot
721	a non-initial dot currently) and likely non-directories (everything	907	currently) and likely non-directories (see C<aio_readdirx>). Then every
722	else). Then every entry plus an appended C</.> will be C<stat>'ed,	908	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
723	likely directories first. If that succeeds, it assumes that the entry	909	in order of their inode numbers. If that succeeds, it assumes that the
724	is a directory or a symlink to directory (which will be checked	910	entry is a directory or a symlink to directory (which will be checked
725	seperately). This is often faster than stat'ing the entry itself because	911	seperately). This is often faster than stat'ing the entry itself because
726	filesystems might detect the type of the entry without reading the inode	912	filesystems might detect the type of the entry without reading the inode
727	data (e.g. ext2fs filetype feature).	913	data (e.g. ext2fs filetype feature), even on systems that cannot return
		914	the filetype information on readdir.
728		915
729	If the known number of directories (link count - 2) has been reached, the	916	If the known number of directories (link count - 2) has been reached, the
730	rest of the entries is assumed to be non-directories.	917	rest of the entries is assumed to be non-directories.
731		918
732	This only works with certainty on POSIX (= UNIX) filesystems, which	919	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
754	my $now = time;	941	my $now = time;
755	my $hash1 = join ":", (stat _)[0,1,3,7,9];	942	my $hash1 = join ":", (stat _)[0,1,3,7,9];
756		943
757	# read the directory entries	944	# read the directory entries
758	aioreq_pri $pri;	945	aioreq_pri $pri;
759	add $grp aio_readdir $path, sub {	946	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
760	my $entries = shift	947	my $entries = shift
761	or return $grp->result ();	948	or return $grp->result ();
762		949
763	# stat the dir another time	950	# stat the dir another time
764	aioreq_pri $pri;	951	aioreq_pri $pri;
…		…
770	# take the slow route if anything looks fishy	957	# take the slow route if anything looks fishy
771	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	958	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
772	$ndirs = -1;	959	$ndirs = -1;
773	} else {	960	} else {
774	# if nlink == 2, we are finished	961	# if nlink == 2, we are finished
775	# on non-posix-fs's, we rely on nlink < 2	962	# for non-posix-fs's, we rely on nlink < 2
776	$ndirs = (stat _)[3] - 2	963	$ndirs = (stat _)[3] - 2
777	or return $grp->result ([], $entries);	964	or return $grp->result ([], $entries);
778	}	965	}
779		966
780	# sort into likely dirs and likely nondirs
781	# dirs == files without ".", short entries first
782	$entries = [map $_->[0],
783	sort { $b->[1] cmp $a->[1] }
784	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
785	@$entries];
786
787	my (@dirs, @nondirs);	967	my (@dirs, @nondirs);
788		968
789	my $statgrp = add $grp aio_group sub {	969	my $statgrp = add $grp aio_group sub {
790	$grp->result (\@dirs, \@nondirs);	970	$grp->result (\@dirs, \@nondirs);
791	};	971	};
792		972
793	limit $statgrp $maxreq;	973	limit $statgrp $maxreq;
794	feed $statgrp sub {	974	feed $statgrp sub {
795	return unless @$entries;	975	return unless @$entries;
796	my $entry = pop @$entries;	976	my $entry = shift @$entries;
797		977
798	aioreq_pri $pri;	978	aioreq_pri $pri;
799	add $statgrp aio_stat "$path/$entry/.", sub {	979	add $statgrp aio_stat "$path/$entry/.", sub {
800	if ($_[0] < 0) {	980	if ($_[0] < 0) {
801	push @nondirs, $entry;	981	push @nondirs, $entry;
…		…
895	(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
896	specific effect, but usually it makes sure that directory changes get	1076	specific effect, but usually it makes sure that directory changes get
897	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,
898	not just directories.	1078	not just directories.
899		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
900	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.
901		1084
902	=cut	1085	=cut
903		1086
904	sub aio_pathsync($;$) {	1087	sub aio_pathsync($;$) {
…		…
924	};	1107	};
925		1108
926	$grp	1109	$grp
927	}	1110	}
928		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
929	=item aio_group $callback->(...)	1178	=item aio_group $callback->(...)
930		1179
931	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
932	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
933	many requests into a single, composite, request with a definite callback	1182	many requests into a single, composite, request with a definite callback
…		…
982	=item cancel $req	1231	=item cancel $req
983		1232
984	Cancels the request, if possible. Has the effect of skipping execution	1233	Cancels the request, if possible. Has the effect of skipping execution
985	when entering the B<execute> state and skipping calling the callback when	1234	when entering the B<execute> state and skipping calling the callback when
986	entering the the B<result> state, but will leave the request otherwise	1235	entering the the B<result> state, but will leave the request otherwise
987	untouched. That means that requests that currently execute will not be	1236	untouched (with the exception of readdir). That means that requests that
988	stopped and resources held by the request will not be freed prematurely.	1237	currently execute will not be stopped and resources held by the request
		1238	will not be freed prematurely.
989		1239
990	=item cb $req $callback->(...)	1240	=item cb $req $callback->(...)
991		1241
992	Replace (or simply set) the callback registered to the request.	1242	Replace (or simply set) the callback registered to the request.
993		1243
…		…
1066		1316
1067	=item $grp->cancel_subs	1317	=item $grp->cancel_subs
1068		1318
1069	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
1070	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.
		1321
		1322	The group request will finish normally (you cannot add requests to the
		1323	group).
1071		1324
1072	=item $grp->result (...)	1325	=item $grp->result (...)
1073		1326
1074	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
1075	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
…		…
1144	=over 4	1397	=over 4
1145		1398
1146	=item $fileno = IO::AIO::poll_fileno	1399	=item $fileno = IO::AIO::poll_fileno
1147		1400
1148	Return the I<request result pipe file descriptor>. This filehandle must be	1401	Return the I<request result pipe file descriptor>. This filehandle must be
1149	polled for reading by some mechanism outside this module (e.g. Event or	1402	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1150	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1403	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1151	to call C<poll_cb> to check the results.	1404	you have to call C<poll_cb> to check the results.
1152		1405
1153	See C<poll_cb> for an example.	1406	See C<poll_cb> for an example.
1154		1407
1155	=item IO::AIO::poll_cb	1408	=item IO::AIO::poll_cb
1156		1409
…		…
1163	If not all requests were processed for whatever reason, the filehandle	1416	If not all requests were processed for whatever reason, the filehandle
1164	will still be ready when C<poll_cb> returns, so normally you don't have to	1417	will still be ready when C<poll_cb> returns, so normally you don't have to
1165	do anything special to have it called later.	1418	do anything special to have it called later.
1166		1419
1167	Example: Install an Event watcher that automatically calls	1420	Example: Install an Event watcher that automatically calls
1168	IO::AIO::poll_cb with high priority:	1421	IO::AIO::poll_cb with high priority (more examples can be found in the
		1422	SYNOPSIS section, at the top of this document):
1169		1423
1170	Event->io (fd => IO::AIO::poll_fileno,	1424	Event->io (fd => IO::AIO::poll_fileno,
1171	poll => 'r', async => 1,	1425	poll => 'r', async => 1,
1172	cb => \&IO::AIO::poll_cb);	1426	cb => \&IO::AIO::poll_cb);
		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;
1173		1454
1174	=item IO::AIO::max_poll_reqs $nreqs	1455	=item IO::AIO::max_poll_reqs $nreqs
1175		1456
1176	=item IO::AIO::max_poll_time $seconds	1457	=item IO::AIO::max_poll_time $seconds
1177		1458
…		…
1202	# use a low priority so other tasks have priority	1483	# use a low priority so other tasks have priority
1203	Event->io (fd => IO::AIO::poll_fileno,	1484	Event->io (fd => IO::AIO::poll_fileno,
1204	poll => 'r', nice => 1,	1485	poll => 'r', nice => 1,
1205	cb => &IO::AIO::poll_cb);	1486	cb => &IO::AIO::poll_cb);
1206		1487
1207	=item IO::AIO::poll_wait
1208
1209	If there are any outstanding requests and none of them in the result
1210	phase, wait till the result filehandle becomes ready for reading (simply
1211	does a C<select> on the filehandle. This is useful if you want to
1212	synchronously wait for some requests to finish).
1213
1214	See C<nreqs> for an example.
1215
1216	=item IO::AIO::poll
1217
1218	Waits until some requests have been handled.
1219
1220	Returns the number of requests processed, but is otherwise strictly
1221	equivalent to:
1222
1223	IO::AIO::poll_wait, IO::AIO::poll_cb
1224
1225	=item IO::AIO::flush
1226
1227	Wait till all outstanding AIO requests have been handled.
1228
1229	Strictly equivalent to:
1230
1231	IO::AIO::poll_wait, IO::AIO::poll_cb
1232	while IO::AIO::nreqs;
1233
1234	=back	1488	=back
1235		1489
1236	=head3 CONTROLLING THE NUMBER OF THREADS	1490	=head3 CONTROLLING THE NUMBER OF THREADS
1237		1491
1238	=over	1492	=over
…		…
1330	Returns the number of requests currently in the pending state (executed,	1584	Returns the number of requests currently in the pending state (executed,
1331	but not yet processed by poll_cb).	1585	but not yet processed by poll_cb).
1332		1586
1333	=back	1587	=back
1334		1588
		1589	=head3 MISCELLANEOUS FUNCTIONS
		1590
		1591	IO::AIO implements some functions that might be useful, but are not
		1592	asynchronous.
		1593
		1594	=over 4
		1595
		1596	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1597
		1598	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		1599	but is blocking (this makes most sense if you know the input data is
		1600	likely cached already and the output filehandle is set to non-blocking
		1601	operations).
		1602
		1603	Returns the number of bytes copied, or C<-1> on error.
		1604
		1605	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		1606
		1607	Simply calls the C<posix_fadvise> function (see its
		1608	manpage for details). The following advice constants are
		1609	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		1610	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		1611	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		1612
		1613	On systems that do not implement C<posix_fadvise>, this function returns
		1614	ENOSYS, otherwise the return value of C<posix_fadvise>.
		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
		1702	=back
		1703
1335	=cut	1704	=cut
1336		1705
1337	min_parallel 8;	1706	min_parallel 8;
1338		1707
1339	END { flush }	1708	END { flush }
1340		1709
1341	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);
1342		1742
1343	=head2 FORK BEHAVIOUR	1743	=head2 FORK BEHAVIOUR
1344		1744
1345	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:
1346		1746

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.147 by root, Wed Jun 3 12:24:49 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.147 by root, Wed Jun 3 12:24:49 2009 UTC vs.
Revision 1.187 by root, Fri Feb 11 00:05:17 2011 UTC