[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.175 by root, Sun Jan 10 20:37:33 2010 UTC

…		…
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>
…		…
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.5';
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_statvfs);
205		183
206	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	184	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	185	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208	min_parallel max_parallel max_idle	186	min_parallel max_parallel max_idle
209	nreqs nready npending nthreads	187	nreqs nready npending nthreads
…		…
217	require XSLoader;	195	require XSLoader;
218	XSLoader::load ("IO::AIO", $VERSION);	196	XSLoader::load ("IO::AIO", $VERSION);
219	}	197	}
220		198
221	=head1 FUNCTIONS	199	=head1 FUNCTIONS
		200
		201	=head2 QUICK OVERVIEW
		202
		203	This section simply lists the prototypes of the most important functions
		204	for quick reference. See the following sections for function-by-function
		205	documentation.
		206
		207	aio_open $pathname, $flags, $mode, $callback->($fh)
		208	aio_close $fh, $callback->($status)
		209	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		210	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		211	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		212	aio_readahead $fh,$offset,$length, $callback->($retval)
		213	aio_stat $fh_or_path, $callback->($status)
		214	aio_lstat $fh, $callback->($status)
		215	aio_statvfs $fh_or_path, $callback->($statvfs)
		216	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		217	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		218	aio_truncate $fh_or_path, $offset, $callback->($status)
		219	aio_chmod $fh_or_path, $mode, $callback->($status)
		220	aio_unlink $pathname, $callback->($status)
		221	aio_mknod $path, $mode, $dev, $callback->($status)
		222	aio_link $srcpath, $dstpath, $callback->($status)
		223	aio_symlink $srcpath, $dstpath, $callback->($status)
		224	aio_readlink $path, $callback->($link)
		225	aio_rename $srcpath, $dstpath, $callback->($status)
		226	aio_mkdir $pathname, $mode, $callback->($status)
		227	aio_rmdir $pathname, $callback->($status)
		228	aio_readdir $pathname, $callback->($entries)
		229	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		230	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		231	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		232	aio_load $path, $data, $callback->($status)
		233	aio_copy $srcpath, $dstpath, $callback->($status)
		234	aio_move $srcpath, $dstpath, $callback->($status)
		235	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		236	aio_rmtree $path, $callback->($status)
		237	aio_sync $callback->($status)
		238	aio_fsync $fh, $callback->($status)
		239	aio_fdatasync $fh, $callback->($status)
		240	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		241	aio_pathsync $path, $callback->($status)
		242	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		243	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		244	aio_group $callback->(...)
		245	aio_nop $callback->()
		246
		247	$prev_pri = aioreq_pri [$pri]
		248	aioreq_nice $pri_adjust
		249
		250	IO::AIO::poll_wait
		251	IO::AIO::poll_cb
		252	IO::AIO::poll
		253	IO::AIO::flush
		254	IO::AIO::max_poll_reqs $nreqs
		255	IO::AIO::max_poll_time $seconds
		256	IO::AIO::min_parallel $nthreads
		257	IO::AIO::max_parallel $nthreads
		258	IO::AIO::max_idle $nthreads
		259	IO::AIO::max_outstanding $maxreqs
		260	IO::AIO::nreqs
		261	IO::AIO::nready
		262	IO::AIO::npending
		263
		264	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		265	IO::AIO::fadvise $fh, $offset, $len, $advice
		266	IO::AIO::mlockall $flags
		267	IO::AIO::munlockall
222		268
223	=head2 AIO REQUEST FUNCTIONS	269	=head2 AIO REQUEST FUNCTIONS
224		270
225	All the C<aio_*> calls are more or less thin wrappers around the syscall	271	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,	272	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
380		426
381	This call tries to make use of a native C<sendfile> syscall to provide	427	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	428	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.	429	socket, and C<$in_fh> should refer to mmap'able file.
384		430
385	If the native sendfile call fails or is not implemented, it will be	431	If a native sendfile cannot be found or it fails with C<ENOSYS>,
		432	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	433	it will be emulated, so you can call C<aio_sendfile> on any type of
387	regardless of the limitations of the operating system.	434	filehandle regardless of the limitations of the operating system.
388		435
389	Please note, however, that C<aio_sendfile> can read more bytes from	436	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	437	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	438	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	439	provides the number of bytes written to C<$out_fh>. Only if the result
…		…
428		475
429	aio_stat "/etc/passwd", sub {	476	aio_stat "/etc/passwd", sub {
430	$_[0] and die "stat failed: $!";	477	$_[0] and die "stat failed: $!";
431	print "size is ", -s _, "\n";	478	print "size is ", -s _, "\n";
432	};	479	};
		480
		481
		482	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		483
		484	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		485	whether a file handle or path was passed.
		486
		487	On success, the callback is passed a hash reference with the following
		488	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		489	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		490	is passed.
		491
		492	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		493	C<ST_NOSUID>.
		494
		495	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		496	their correct value when available, or to C<0> on systems that do
		497	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		498	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		499	C<ST_NODIRATIME> and C<ST_RELATIME>.
		500
		501	Example: stat C</wd> and dump out the data if successful.
		502
		503	aio_statvfs "/wd", sub {
		504	my $f = $_[0]
		505	or die "statvfs: $!";
		506
		507	use Data::Dumper;
		508	say Dumper $f;
		509	};
		510
		511	# result:
		512	{
		513	bsize => 1024,
		514	bfree => 4333064312,
		515	blocks => 10253828096,
		516	files => 2050765568,
		517	flag => 4096,
		518	favail => 2042092649,
		519	bavail => 4333064312,
		520	ffree => 2042092649,
		521	namemax => 255,
		522	frsize => 1024,
		523	fsid => 1810
		524	}
433		525
434		526
435	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	527	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
436		528
437	Works like perl's C<utime> function (including the special case of $atime	529	Works like perl's C<utime> function (including the special case of $atime
…		…
989	};	1081	};
990		1082
991	$grp	1083	$grp
992	}	1084	}
993		1085
		1086	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1087
		1088	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1089	scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note
		1090	that the scalar must only be modified in-place while an aio operation is
		1091	pending on it).
		1092
		1093	It calls the C<msync> function of your OS, if available, with the memory
		1094	area starting at C<$offset> in the string and ending C<$length> bytes
		1095	later. If C<$length> is negative, counts from the end, and if C<$length>
		1096	is C<undef>, then it goes till the end of the string. The flags can be
		1097	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1098	C<IO::AIO::MS_SYNC>.
		1099
		1100	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1101
		1102	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1103	scalars.
		1104
		1105	It touches (reads or writes) all memory pages in the specified
		1106	range inside the scalar. All caveats and parameters are the same
		1107	as for C<aio_msync>, above, except for flags, which must be either
		1108	C<0> (which reads all pages and ensures they are instantiated) or
		1109	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
		1110	writing an octet from it, which dirties the page).
		1111
994	=item aio_group $callback->(...)	1112	=item aio_group $callback->(...)
995		1113
996	This is a very special aio request: Instead of doing something, it is a	1114	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	1115	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	1116	many requests into a single, composite, request with a definite callback
…		…
1133	=item $grp->cancel_subs	1251	=item $grp->cancel_subs
1134		1252
1135	Cancel all subrequests and clears any feeder, but not the group request	1253	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.	1254	itself. Useful when you queued a lot of events but got a result early.
1137		1255
		1256	The group request will finish normally (you cannot add requests to the
		1257	group).
		1258
1138	=item $grp->result (...)	1259	=item $grp->result (...)
1139		1260
1140	Set the result value(s) that will be passed to the group callback when all	1261	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	1262	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,	1263	of errno (just like calling C<errno> without an error number). By default,
…		…
1236		1357
1237	Event->io (fd => IO::AIO::poll_fileno,	1358	Event->io (fd => IO::AIO::poll_fileno,
1238	poll => 'r', async => 1,	1359	poll => 'r', async => 1,
1239	cb => \&IO::AIO::poll_cb);	1360	cb => \&IO::AIO::poll_cb);
1240		1361
		1362	=item IO::AIO::poll_wait
		1363
		1364	If there are any outstanding requests and none of them in the result
		1365	phase, wait till the result filehandle becomes ready for reading (simply
		1366	does a C<select> on the filehandle. This is useful if you want to
		1367	synchronously wait for some requests to finish).
		1368
		1369	See C<nreqs> for an example.
		1370
		1371	=item IO::AIO::poll
		1372
		1373	Waits until some requests have been handled.
		1374
		1375	Returns the number of requests processed, but is otherwise strictly
		1376	equivalent to:
		1377
		1378	IO::AIO::poll_wait, IO::AIO::poll_cb
		1379
		1380	=item IO::AIO::flush
		1381
		1382	Wait till all outstanding AIO requests have been handled.
		1383
		1384	Strictly equivalent to:
		1385
		1386	IO::AIO::poll_wait, IO::AIO::poll_cb
		1387	while IO::AIO::nreqs;
		1388
1241	=item IO::AIO::max_poll_reqs $nreqs	1389	=item IO::AIO::max_poll_reqs $nreqs
1242		1390
1243	=item IO::AIO::max_poll_time $seconds	1391	=item IO::AIO::max_poll_time $seconds
1244		1392
1245	These set the maximum number of requests (default C<0>, meaning infinity)	1393	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1269	# use a low priority so other tasks have priority	1417	# use a low priority so other tasks have priority
1270	Event->io (fd => IO::AIO::poll_fileno,	1418	Event->io (fd => IO::AIO::poll_fileno,
1271	poll => 'r', nice => 1,	1419	poll => 'r', nice => 1,
1272	cb => &IO::AIO::poll_cb);	1420	cb => &IO::AIO::poll_cb);
1273		1421
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	1422	=back
1302		1423
1303	=head3 CONTROLLING THE NUMBER OF THREADS	1424	=head3 CONTROLLING THE NUMBER OF THREADS
1304		1425
1305	=over	1426	=over
…		…
1424	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	1545	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1425		1546
1426	On systems that do not implement C<posix_fadvise>, this function returns	1547	On systems that do not implement C<posix_fadvise>, this function returns
1427	ENOSYS, otherwise the return value of C<posix_fadvise>.	1548	ENOSYS, otherwise the return value of C<posix_fadvise>.
1428		1549
		1550	=item IO::AIO::mlockall $flags
		1551
		1552	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1553	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>).
		1554
		1555	On systems that do not implement C<mlockall>, this function returns
		1556	ENOSYS, otherwise the return value of C<mlockall>.
		1557
		1558	=item IO::AIO::munlockall
		1559
		1560	Calls the C<munlockall> function.
		1561
		1562	On systems that do not implement C<munlockall>, this function returns
		1563	ENOSYS, otherwise the return value of C<munlockall>.
		1564
1429	=back	1565	=back
1430		1566
1431	=cut	1567	=cut
1432		1568
1433	min_parallel 8;	1569	min_parallel 8;
1434		1570
1435	END { flush }	1571	END { flush }
1436		1572
1437	1;	1573	1;
		1574
		1575	=head1 EVENT LOOP INTEGRATION
		1576
		1577	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		1578	automatically into many event loops:
		1579
		1580	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1581	use AnyEvent::AIO;
		1582
		1583	You can also integrate IO::AIO manually into many event loops, here are
		1584	some examples of how to do this:
		1585
		1586	# EV integration
		1587	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1588
		1589	# Event integration
		1590	Event->io (fd => IO::AIO::poll_fileno,
		1591	poll => 'r',
		1592	cb => \&IO::AIO::poll_cb);
		1593
		1594	# Glib/Gtk2 integration
		1595	add_watch Glib::IO IO::AIO::poll_fileno,
		1596	in => sub { IO::AIO::poll_cb; 1 };
		1597
		1598	# Tk integration
		1599	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1600	readable => \&IO::AIO::poll_cb);
		1601
		1602	# Danga::Socket integration
		1603	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1604	\&IO::AIO::poll_cb);
1438		1605
1439	=head2 FORK BEHAVIOUR	1606	=head2 FORK BEHAVIOUR
1440		1607
1441	This module should do "the right thing" when the process using it forks:	1608	This module should do "the right thing" when the process using it forks:
1442		1609

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.175 by root, Sun Jan 10 20:37:33 2010 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.175 by root, Sun Jan 10 20:37:33 2010 UTC