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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.165 by root, Tue Aug 18 04:05:00 2009 UTC vs.
Revision 1.183 by root, Sun Sep 12 03:40:05 2010 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
9	aio_open "/etc/passwd", O_RDONLY, 0, sub {	9	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10	my $fh = shift	10	my $fh = shift
11	or die "/etc/passwd: $!";	11	or die "/etc/passwd: $!";
12	...	12	...
13	};	13	};
14		14
…		…
25	my $req = aio_unlink "/tmp/file", sub { };	25	my $req = aio_unlink "/tmp/file", sub { };
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30
31	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32	use AnyEvent::AIO;
33
34	# EV integration
35	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37	# Event integration
38	Event->io (fd => IO::AIO::poll_fileno,
39	poll => 'r',
40	cb => \&IO::AIO::poll_cb);
41
42	# Glib/Gtk2 integration
43	add_watch Glib::IO IO::AIO::poll_fileno,
44	in => sub { IO::AIO::poll_cb; 1 };
45
46	# Tk integration
47	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48	readable => \&IO::AIO::poll_cb);
49
50	# Danga::Socket integration
51	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52	\&IO::AIO::poll_cb);
53		30
54	=head1 DESCRIPTION	31	=head1 DESCRIPTION
55		32
56	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
57	operating system supports. It is implemented as an interface to C<libeio>	34	operating system supports. It is implemented as an interface to C<libeio>
…		…
99		76
100	# register the IO::AIO callback with EV	77	# register the IO::AIO callback with EV
101	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102		79
103	# queue the request to open /etc/passwd	80	# queue the request to open /etc/passwd
104	aio_open "/etc/passwd", O_RDONLY, 0, sub {	81	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
105	my $fh = shift	82	my $fh = shift
106	or die "error while opening: $!";	83	or die "error while opening: $!";
107		84
108	# stat'ing filehandles is generally non-blocking	85	# stat'ing filehandles is generally non-blocking
109	my $size = -s $fh;	86	my $size = -s $fh;
…		…
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.3';	173	our $VERSION = '3.65';
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
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::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::munlock $scalar, $offset = 0, $length = undef
		271	IO::AIO::munlockall
222		272
223	=head2 AIO REQUEST FUNCTIONS	273	=head2 AIO REQUEST FUNCTIONS
224		274
225	All the C<aio_*> calls are more or less thin wrappers around the syscall	275	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,	276	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	356	by the umask in effect then the request is being executed, so better never
307	change the umask.	357	change the umask.
308		358
309	Example:	359	Example:
310		360
311	aio_open "/etc/passwd", O_RDONLY, 0, sub {	361	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312	if ($_[0]) {	362	if ($_[0]) {
313	print "open successful, fh is $_[0]\n";	363	print "open successful, fh is $_[0]\n";
314	...	364	...
315	} else {	365	} else {
316	die "open failed: $!\n";	366	die "open failed: $!\n";
…		…
378	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	428	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
379	other.	429	other.
380		430
381	This call tries to make use of a native C<sendfile> syscall to provide	431	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	432	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.	433	socket, and C<$in_fh> should refer to an mmap'able file.
384		434
385	If the native sendfile call fails or is not implemented, it will be	435	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		436	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	437	it will be emulated, so you can call C<aio_sendfile> on any type of
387	regardless of the limitations of the operating system.	438	filehandle regardless of the limitations of the operating system.
388		439
389	Please note, however, that C<aio_sendfile> can read more bytes from	440	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	441	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	442	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	443	provides the number of bytes written to C<$out_fh>. Only if the result
…		…
430	$_[0] and die "stat failed: $!";	481	$_[0] and die "stat failed: $!";
431	print "size is ", -s _, "\n";	482	print "size is ", -s _, "\n";
432	};	483	};
433		484
434		485
		486	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		487
		488	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		489	whether a file handle or path was passed.
		490
		491	On success, the callback is passed a hash reference with the following
		492	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		493	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		494	is passed.
		495
		496	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		497	C<ST_NOSUID>.
		498
		499	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		500	their correct value when available, or to C<0> on systems that do
		501	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		502	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		503	C<ST_NODIRATIME> and C<ST_RELATIME>.
		504
		505	Example: stat C</wd> and dump out the data if successful.
		506
		507	aio_statvfs "/wd", sub {
		508	my $f = $_[0]
		509	or die "statvfs: $!";
		510
		511	use Data::Dumper;
		512	say Dumper $f;
		513	};
		514
		515	# result:
		516	{
		517	bsize => 1024,
		518	bfree => 4333064312,
		519	blocks => 10253828096,
		520	files => 2050765568,
		521	flag => 4096,
		522	favail => 2042092649,
		523	bavail => 4333064312,
		524	ffree => 2042092649,
		525	namemax => 255,
		526	frsize => 1024,
		527	fsid => 1810
		528	}
		529
		530
435	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	531	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
436		532
437	Works like perl's C<utime> function (including the special case of $atime	533	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	534	and $mtime being undef). Fractional times are supported if the underlying
439	syscalls support them.	535	syscalls support them.
…		…
656	my $grp = aio_group $cb;	752	my $grp = aio_group $cb;
657		753
658	aioreq_pri $pri;	754	aioreq_pri $pri;
659	add $grp aio_open $src, O_RDONLY, 0, sub {	755	add $grp aio_open $src, O_RDONLY, 0, sub {
660	if (my $src_fh = $_[0]) {	756	if (my $src_fh = $_[0]) {
661	my @stat = stat $src_fh; # hmm, might bock over nfs?	757	my @stat = stat $src_fh; # hmm, might block over nfs?
662		758
663	aioreq_pri $pri;	759	aioreq_pri $pri;
664	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {	760	add $grp aio_open $dst, O_CREAT \| O_WRONLY \| O_TRUNC, 0200, sub {
665	if (my $dst_fh = $_[0]) {	761	if (my $dst_fh = $_[0]) {
666	aioreq_pri $pri;	762	aioreq_pri $pri;
…		…
989	};	1085	};
990		1086
991	$grp	1087	$grp
992	}	1088	}
993		1089
		1090	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1091
		1092	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1093	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1094	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1095	scalar must only be modified in-place while an aio operation is pending on
		1096	it).
		1097
		1098	It calls the C<msync> function of your OS, if available, with the memory
		1099	area starting at C<$offset> in the string and ending C<$length> bytes
		1100	later. If C<$length> is negative, counts from the end, and if C<$length>
		1101	is C<undef>, then it goes till the end of the string. The flags can be
		1102	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1103	C<IO::AIO::MS_SYNC>.
		1104
		1105	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1106
		1107	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1108	scalars.
		1109
		1110	It touches (reads or writes) all memory pages in the specified
		1111	range inside the scalar. All caveats and parameters are the same
		1112	as for C<aio_msync>, above, except for flags, which must be either
		1113	C<0> (which reads all pages and ensures they are instantiated) or
		1114	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1115	writing an octet from it, which dirties the page).
		1116
		1117	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1118
		1119	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1120	scalars.
		1121
		1122	It reads in all the pages of the underlying storage into memory (if any)
		1123	and locks them, so they are not getting swapped/paged out or removed.
		1124
		1125	If C<$length> is undefined, then the scalar will be locked till the end.
		1126
		1127	On systems that do not implement C<mlock>, this function returns C<-1>
		1128	and sets errno to C<ENOSYS>.
		1129
		1130	Note that the corresponding C<munlock> is synchronous and is
		1131	documented under L<MISCELLANEOUS FUNCTIONS>.
		1132
		1133	Example: open a file, mmap and mlock it - both will be undone when
		1134	C<$data> gets destroyed.
		1135
		1136	open my $fh, "<", $path or die "$path: $!";
		1137	my $data;
		1138	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1139	aio_mlock $data; # mlock in background
		1140
		1141	=item aio_mlockall $flags, $callback->($status)
		1142
		1143	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1144	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1145
		1146	On systems that do not implement C<mlockall>, this function returns C<-1>
		1147	and sets errno to C<ENOSYS>.
		1148
		1149	Note that the corresponding C<munlockall> is synchronous and is
		1150	documented under L<MISCELLANEOUS FUNCTIONS>.
		1151
		1152	Example: asynchronously lock all current and future pages into memory.
		1153
		1154	aio_mlockall IO::AIO::MCL_FUTURE;
		1155
994	=item aio_group $callback->(...)	1156	=item aio_group $callback->(...)
995		1157
996	This is a very special aio request: Instead of doing something, it is a	1158	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	1159	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	1160	many requests into a single, composite, request with a definite callback
…		…
1133	=item $grp->cancel_subs	1295	=item $grp->cancel_subs
1134		1296
1135	Cancel all subrequests and clears any feeder, but not the group request	1297	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.	1298	itself. Useful when you queued a lot of events but got a result early.
1137		1299
		1300	The group request will finish normally (you cannot add requests to the
		1301	group).
		1302
1138	=item $grp->result (...)	1303	=item $grp->result (...)
1139		1304
1140	Set the result value(s) that will be passed to the group callback when all	1305	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	1306	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,	1307	of errno (just like calling C<errno> without an error number). By default,
…		…
1236		1401
1237	Event->io (fd => IO::AIO::poll_fileno,	1402	Event->io (fd => IO::AIO::poll_fileno,
1238	poll => 'r', async => 1,	1403	poll => 'r', async => 1,
1239	cb => \&IO::AIO::poll_cb);	1404	cb => \&IO::AIO::poll_cb);
1240		1405
		1406	=item IO::AIO::poll_wait
		1407
		1408	If there are any outstanding requests and none of them in the result
		1409	phase, wait till the result filehandle becomes ready for reading (simply
		1410	does a C<select> on the filehandle. This is useful if you want to
		1411	synchronously wait for some requests to finish).
		1412
		1413	See C<nreqs> for an example.
		1414
		1415	=item IO::AIO::poll
		1416
		1417	Waits until some requests have been handled.
		1418
		1419	Returns the number of requests processed, but is otherwise strictly
		1420	equivalent to:
		1421
		1422	IO::AIO::poll_wait, IO::AIO::poll_cb
		1423
		1424	=item IO::AIO::flush
		1425
		1426	Wait till all outstanding AIO requests have been handled.
		1427
		1428	Strictly equivalent to:
		1429
		1430	IO::AIO::poll_wait, IO::AIO::poll_cb
		1431	while IO::AIO::nreqs;
		1432
1241	=item IO::AIO::max_poll_reqs $nreqs	1433	=item IO::AIO::max_poll_reqs $nreqs
1242		1434
1243	=item IO::AIO::max_poll_time $seconds	1435	=item IO::AIO::max_poll_time $seconds
1244		1436
1245	These set the maximum number of requests (default C<0>, meaning infinity)	1437	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1269	# use a low priority so other tasks have priority	1461	# use a low priority so other tasks have priority
1270	Event->io (fd => IO::AIO::poll_fileno,	1462	Event->io (fd => IO::AIO::poll_fileno,
1271	poll => 'r', nice => 1,	1463	poll => 'r', nice => 1,
1272	cb => &IO::AIO::poll_cb);	1464	cb => &IO::AIO::poll_cb);
1273		1465
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	1466	=back
1302		1467
1303	=head3 CONTROLLING THE NUMBER OF THREADS	1468	=head3 CONTROLLING THE NUMBER OF THREADS
1304		1469
1305	=over	1470	=over
…		…
1424	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1589	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1425		1590
1426	On systems that do not implement C<posix_fadvise>, this function returns	1591	On systems that do not implement C<posix_fadvise>, this function returns
1427	ENOSYS, otherwise the return value of C<posix_fadvise>.	1592	ENOSYS, otherwise the return value of C<posix_fadvise>.
1428		1593
		1594	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1595
		1596	Memory-maps a file (or anonymous memory range) and attaches it to the
		1597	given C<$scalar>, which will act like a string scalar.
		1598
		1599	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		1600	change the string length, and most read-only operations such as copying it
		1601	or searching it with regexes and so on.
		1602
		1603	Anything else is unsafe and will, at best, result in memory leaks.
		1604
		1605	The memory map associated with the C<$scalar> is automatically removed
		1606	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		1607	C<IO::AIO::munmap> functions are called.
		1608
		1609	This calls the C<mmap>(2) function internally. See your system's manual
		1610	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		1611
		1612	The C<$length> must be larger than zero and smaller than the actual
		1613	filesize.
		1614
		1615	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		1616	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		1617
		1618	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
		1619	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
		1620	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
		1621	(which is set to C<MAP_ANON> if your system only provides this
		1622	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
		1623	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
		1624	C<IO::AIO::MAP_NONBLOCK>
		1625
		1626	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		1627
		1628	C<$offset> is the offset from the start of the file - it generally must be
		1629	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		1630
		1631	Example:
		1632
		1633	use Digest::MD5;
		1634	use IO::AIO;
		1635
		1636	open my $fh, "<verybigfile"
		1637	or die "$!";
		1638
		1639	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1640	or die "verybigfile: $!";
		1641
		1642	my $fast_md5 = md5 $data;
		1643
		1644	=item IO::AIO::munmap $scalar
		1645
		1646	Removes a previous mmap and undefines the C<$scalar>.
		1647
		1648	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1649
		1650	Calls the C<munlock> function, undoing the effects of a previous
		1651	C<aio_mlock> call (see its description for details).
		1652
		1653	=item IO::AIO::munlockall
		1654
		1655	Calls the C<munlockall> function.
		1656
		1657	On systems that do not implement C<munlockall>, this function returns
		1658	ENOSYS, otherwise the return value of C<munlockall>.
		1659
1429	=back	1660	=back
1430		1661
1431	=cut	1662	=cut
1432		1663
1433	min_parallel 8;	1664	min_parallel 8;
1434		1665
1435	END { flush }	1666	END { flush }
1436		1667
1437	1;	1668	1;
		1669
		1670	=head1 EVENT LOOP INTEGRATION
		1671
		1672	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1673	automatically into many event loops:
		1674
		1675	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1676	use AnyEvent::AIO;
		1677
		1678	You can also integrate IO::AIO manually into many event loops, here are
		1679	some examples of how to do this:
		1680
		1681	# EV integration
		1682	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1683
		1684	# Event integration
		1685	Event->io (fd => IO::AIO::poll_fileno,
		1686	poll => 'r',
		1687	cb => \&IO::AIO::poll_cb);
		1688
		1689	# Glib/Gtk2 integration
		1690	add_watch Glib::IO IO::AIO::poll_fileno,
		1691	in => sub { IO::AIO::poll_cb; 1 };
		1692
		1693	# Tk integration
		1694	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1695	readable => \&IO::AIO::poll_cb);
		1696
		1697	# Danga::Socket integration
		1698	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1699	\&IO::AIO::poll_cb);
1438		1700
1439	=head2 FORK BEHAVIOUR	1701	=head2 FORK BEHAVIOUR
1440		1702
1441	This module should do "the right thing" when the process using it forks:	1703	This module should do "the right thing" when the process using it forks:
1442		1704

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.165 by root, Tue Aug 18 04:05:00 2009 UTC vs. Revision 1.183 by root, Sun Sep 12 03:40:05 2010 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.165 by root, Tue Aug 18 04:05:00 2009 UTC vs.
Revision 1.183 by root, Sun Sep 12 03:40:05 2010 UTC