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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs.
Revision 1.244 by root, Fri Jan 24 23:46:16 2014 UTC

…		…
68	=head2 EXAMPLE	68	=head2 EXAMPLE
69		69
70	This is a simple example that uses the EV module and loads	70	This is a simple example that uses the EV module and loads
71	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
72		72
73	use Fcntl;
74	use EV;	73	use EV;
75	use IO::AIO;	74	use IO::AIO;
76		75
77	# register the IO::AIO callback with EV	76	# register the IO::AIO callback with EV
78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	77	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
168	use common::sense;	167	use common::sense;
169		168
170	use base 'Exporter';	169	use base 'Exporter';
171		170
172	BEGIN {	171	BEGIN {
173	our $VERSION = '4.15';	172	our $VERSION = '4.19';
174		173
175	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close	174	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx	175	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	176	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate	177	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
179	aio_pathsync aio_readahead aio_fiemap	178	aio_pathsync aio_readahead aio_fiemap
180	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
181	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
182	aio_chmod aio_utime aio_truncate	181	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	182	aio_msync aio_mtouch aio_mlock aio_mlockall
…		…
603	namemax => 255,	602	namemax => 255,
604	frsize => 1024,	603	frsize => 1024,
605	fsid => 1810	604	fsid => 1810
606	}	605	}
607		606
		607	Here is a (likely partial - send me updates!) list of fsid values used by
		608	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		609
		610	0x0000adf5 adfs
		611	0x0000adff affs
		612	0x5346414f afs
		613	0x09041934 anon-inode filesystem
		614	0x00000187 autofs
		615	0x42465331 befs
		616	0x1badface bfs
		617	0x42494e4d binfmt_misc
		618	0x9123683e btrfs
		619	0x0027e0eb cgroupfs
		620	0xff534d42 cifs
		621	0x73757245 coda
		622	0x012ff7b7 coh
		623	0x28cd3d45 cramfs
		624	0x453dcd28 cramfs-wend (wrong endianness)
		625	0x64626720 debugfs
		626	0x00001373 devfs
		627	0x00001cd1 devpts
		628	0x0000f15f ecryptfs
		629	0x00414a53 efs
		630	0x0000137d ext
		631	0x0000ef53 ext2/ext3
		632	0x0000ef51 ext2
		633	0x00004006 fat
		634	0x65735546 fuseblk
		635	0x65735543 fusectl
		636	0x0bad1dea futexfs
		637	0x01161970 gfs2
		638	0x47504653 gpfs
		639	0x00004244 hfs
		640	0xf995e849 hpfs
		641	0x958458f6 hugetlbfs
		642	0x2bad1dea inotifyfs
		643	0x00009660 isofs
		644	0x000072b6 jffs2
		645	0x3153464a jfs
		646	0x6b414653 k-afs
		647	0x0bd00bd0 lustre
		648	0x0000137f minix
		649	0x0000138f minix 30 char names
		650	0x00002468 minix v2
		651	0x00002478 minix v2 30 char names
		652	0x00004d5a minix v3
		653	0x19800202 mqueue
		654	0x00004d44 msdos
		655	0x0000564c novell
		656	0x00006969 nfs
		657	0x6e667364 nfsd
		658	0x00003434 nilfs
		659	0x5346544e ntfs
		660	0x00009fa1 openprom
		661	0x7461636F ocfs2
		662	0x00009fa0 proc
		663	0x6165676c pstorefs
		664	0x0000002f qnx4
		665	0x858458f6 ramfs
		666	0x52654973 reiserfs
		667	0x00007275 romfs
		668	0x67596969 rpc_pipefs
		669	0x73636673 securityfs
		670	0xf97cff8c selinux
		671	0x0000517b smb
		672	0x534f434b sockfs
		673	0x73717368 squashfs
		674	0x62656572 sysfs
		675	0x012ff7b6 sysv2
		676	0x012ff7b5 sysv4
		677	0x01021994 tmpfs
		678	0x15013346 udf
		679	0x00011954 ufs
		680	0x54190100 ufs byteswapped
		681	0x00009fa2 usbdevfs
		682	0x01021997 v9fs
		683	0xa501fcf5 vxfs
		684	0xabba1974 xenfs
		685	0x012ff7b4 xenix
		686	0x58465342 xfs
		687	0x012fd16d xia
608		688
609	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	689	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
610		690
611	Works like perl's C<utime> function (including the special case of $atime	691	Works like perl's C<utime> function (including the special case of $atime
612	and $mtime being undef). Fractional times are supported if the underlying	692	and $mtime being undef). Fractional times are supported if the underlying
…		…
702		782
703		783
704	=item aio_realpath $pathname, $callback->($path)	784	=item aio_realpath $pathname, $callback->($path)
705		785
706	Asynchronously make the path absolute and resolve any symlinks in	786	Asynchronously make the path absolute and resolve any symlinks in
707	C<$path>. The resulting path only consists of directories (Same as	787	C<$path>. The resulting path only consists of directories (same as
708	L<Cwd::realpath>).	788	L<Cwd::realpath>).
709		789
710	This request can be used to get the absolute path of the current working	790	This request can be used to get the absolute path of the current working
711	directory by passing it a path of F<.> (a single dot).	791	directory by passing it a path of F<.> (a single dot).
712		792
713		793
714	=item aio_rename $srcpath, $dstpath, $callback->($status)	794	=item aio_rename $srcpath, $dstpath, $callback->($status)
715		795
716	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	796	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
717	rename(2) and call the callback with the result code.	797	rename(2) and call the callback with the result code.
		798
		799	On systems that support the AIO::WD working directory abstraction
		800	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		801	of failing, C<rename> is called on the absolute path of C<$wd>.
718		802
719		803
720	=item aio_mkdir $pathname, $mode, $callback->($status)	804	=item aio_mkdir $pathname, $mode, $callback->($status)
721		805
722	Asynchronously mkdir (create) a directory and call the callback with	806	Asynchronously mkdir (create) a directory and call the callback with
…		…
726		810
727	=item aio_rmdir $pathname, $callback->($status)	811	=item aio_rmdir $pathname, $callback->($status)
728		812
729	Asynchronously rmdir (delete) a directory and call the callback with the	813	Asynchronously rmdir (delete) a directory and call the callback with the
730	result code.	814	result code.
		815
		816	On systems that support the AIO::WD working directory abstraction
		817	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		818	C<rmdir> is called on the absolute path of C<$wd>.
731		819
732		820
733	=item aio_readdir $pathname, $callback->($entries)	821	=item aio_readdir $pathname, $callback->($entries)
734		822
735	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	823	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
1100	}	1188	}
1101		1189
1102	=item aio_rmtree $pathname, $callback->($status)	1190	=item aio_rmtree $pathname, $callback->($status)
1103		1191
1104	Delete a directory tree starting (and including) C<$path>, return the	1192	Delete a directory tree starting (and including) C<$path>, return the
1105	status of the final C<rmdir> only. This is a composite request that	1193	status of the final C<rmdir> only. This is a composite request that
1106	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1194	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1107	everything else.	1195	everything else.
1108		1196
1109	=cut	1197	=cut
1110		1198
…		…
1230		1318
1231	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1319	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1232	scalars.	1320	scalars.
1233		1321
1234	It touches (reads or writes) all memory pages in the specified	1322	It touches (reads or writes) all memory pages in the specified
1235	range inside the scalar. All caveats and parameters are the same	1323	range inside the scalar. All caveats and parameters are the same
1236	as for C<aio_msync>, above, except for flags, which must be either	1324	as for C<aio_msync>, above, except for flags, which must be either
1237	C<0> (which reads all pages and ensures they are instantiated) or	1325	C<0> (which reads all pages and ensures they are instantiated) or
1238	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1326	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1239	writing an octet from it, which dirties the page).	1327	writing an octet from it, which dirties the page).
1240		1328
1241	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1329	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1242		1330
1243	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1331	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1277		1365
1278	aio_mlockall IO::AIO::MCL_FUTURE;	1366	aio_mlockall IO::AIO::MCL_FUTURE;
1279		1367
1280	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1368	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1281		1369
1282	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1370	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1283	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1371	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1284	C<ioctl> is not available on your OS, then this request will fail with	1372	the ioctl is not available on your OS, then this request will fail with
1285	C<ENOSYS>.	1373	C<ENOSYS>.
1286		1374
1287	C<$start> is the starting offset to query extents for, C<$length> is the	1375	C<$start> is the starting offset to query extents for, C<$length> is the
1288	size of the range to query - if it is C<undef>, then the whole file will	1376	size of the range to query - if it is C<undef>, then the whole file will
1289	be queried.	1377	be queried.
…		…
1444	will still point to the original directory. Most functions accepting a	1532	will still point to the original directory. Most functions accepting a
1445	pathname will use the directory fd on newer systems, and the string on	1533	pathname will use the directory fd on newer systems, and the string on
1446	older systems. Some functions (such as realpath) will always rely on the	1534	older systems. Some functions (such as realpath) will always rely on the
1447	string form of the pathname.	1535	string form of the pathname.
1448		1536
1449	So this fucntionality is mainly useful to get some protection against	1537	So this functionality is mainly useful to get some protection against
1450	C<chdir>, to easily get an absolute path out of a relative path for future	1538	C<chdir>, to easily get an absolute path out of a relative path for future
1451	reference, and to speed up doing many operations in the same directory	1539	reference, and to speed up doing many operations in the same directory
1452	(e.g. when stat'ing all files in a directory).	1540	(e.g. when stat'ing all files in a directory).
1453		1541
1454	The following functions implement this working directory abstraction:	1542	The following functions implement this working directory abstraction:
…		…
1475	=item IO::AIO::CWD	1563	=item IO::AIO::CWD
1476		1564
1477	This is a compiletime constant (object) that represents the process	1565	This is a compiletime constant (object) that represents the process
1478	current working directory.	1566	current working directory.
1479		1567
1480	Specifying this object as working directory object for a pathname is as	1568	Specifying this object as working directory object for a pathname is as if
1481	if the pathname would be specified directly, without a directory object,	1569	the pathname would be specified directly, without a directory object. For
1482	e.g., these calls are functionally identical:	1570	example, these calls are functionally identical:
1483		1571
1484	aio_stat "somefile", sub { ... };	1572	aio_stat "somefile", sub { ... };
1485	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1573	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1486		1574
1487	=back	1575	=back
1488		1576
		1577	To recover the path associated with an IO::AIO::WD object, you can use
		1578	C<aio_realpath>:
		1579
		1580	aio_realpath $wd, sub {
		1581	warn "path is $_[0]\n";
		1582	};
		1583
		1584	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1585	sometimes, fall back to using an absolue path.
1489		1586
1490	=head2 IO::AIO::REQ CLASS	1587	=head2 IO::AIO::REQ CLASS
1491		1588
1492	All non-aggregate C<aio_*> functions return an object of this class when	1589	All non-aggregate C<aio_*> functions return an object of this class when
1493	called in non-void context.	1590	called in non-void context.
…		…
1671		1768
1672	See C<poll_cb> for an example.	1769	See C<poll_cb> for an example.
1673		1770
1674	=item IO::AIO::poll_cb	1771	=item IO::AIO::poll_cb
1675		1772
1676	Process some outstanding events on the result pipe. You have to call	1773	Process some requests that have reached the result phase (i.e. they have
		1774	been executed but the results are not yet reported). You have to call
		1775	this "regularly" to finish outstanding requests.
		1776
1677	this regularly. Returns C<0> if all events could be processed (or there	1777	Returns C<0> if all events could be processed (or there were no
1678	were no events to process), or C<-1> if it returned earlier for whatever	1778	events to process), or C<-1> if it returned earlier for whatever
1679	reason. Returns immediately when no events are outstanding. The amount of	1779	reason. Returns immediately when no events are outstanding. The amount
1680	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1780	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1681	C<IO::AIO::max_poll_time>.	1781	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1682		1782
1683	If not all requests were processed for whatever reason, the filehandle	1783	If not all requests were processed for whatever reason, the poll file
1684	will still be ready when C<poll_cb> returns, so normally you don't have to	1784	descriptor will still be ready when C<poll_cb> returns, so normally you
1685	do anything special to have it called later.	1785	don't have to do anything special to have it called later.
1686		1786
1687	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1787	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1688	ready, it can be beneficial to call this function from loops which submit	1788	ready, it can be beneficial to call this function from loops which submit
1689	a lot of requests, to make sure the results get processed when they become	1789	a lot of requests, to make sure the results get processed when they become
1690	available and not just when the loop is finished and the event loop takes	1790	available and not just when the loop is finished and the event loop takes
…		…
1699	poll => 'r', async => 1,	1799	poll => 'r', async => 1,
1700	cb => \&IO::AIO::poll_cb);	1800	cb => \&IO::AIO::poll_cb);
1701		1801
1702	=item IO::AIO::poll_wait	1802	=item IO::AIO::poll_wait
1703		1803
1704	If there are any outstanding requests and none of them in the result	1804	Wait until either at least one request is in the result phase or no
1705	phase, wait till the result filehandle becomes ready for reading (simply	1805	requests are outstanding anymore.
1706	does a C<select> on the filehandle. This is useful if you want to	1806
1707	synchronously wait for some requests to finish).	1807	This is useful if you want to synchronously wait for some requests to
		1808	become ready, without actually handling them.
1708		1809
1709	See C<nreqs> for an example.	1810	See C<nreqs> for an example.
1710		1811
1711	=item IO::AIO::poll	1812	=item IO::AIO::poll
1712		1813
…		…
2015	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2116	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2016		2117
2017	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the	2118	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2018	description for C<IO::AIO::splice> above for details.	2119	description for C<IO::AIO::splice> above for details.
2019		2120
		2121	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2122
		2123	Attempts to query or change the pipe buffer size. Obviously works only
		2124	on pipes, and currently works only on GNU/Linux systems, and fails with
		2125	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2126	size on other systems, drop me a note.
		2127
2020	=back	2128	=back
2021		2129
2022	=cut	2130	=cut
2023		2131
2024	min_parallel 8;	2132	min_parallel 8;

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs. Revision 1.244 by root, Fri Jan 24 23:46:16 2014 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs.
Revision 1.244 by root, Fri Jan 24 23:46:16 2014 UTC