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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.230 by root, Fri Jul 27 17:24:06 2012 UTC vs.
Revision 1.257 by root, Mon Jan 18 11:53:09 2016 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;
…		…
95		94
96	# file contents now in $contents	95	# file contents now in $contents
97	print $contents;	96	print $contents;
98		97
99	# exit event loop and program	98	# exit event loop and program
100	EV::unloop;	99	EV::break;
101	};	100	};
102	};	101	};
103		102
104	# possibly queue up other requests, or open GUI windows,	103	# possibly queue up other requests, or open GUI windows,
105	# check for sockets etc. etc.	104	# check for sockets etc. etc.
106		105
107	# process events as long as there are some:	106	# process events as long as there are some:
108	EV::loop;	107	EV::run;
109		108
110	=head1 REQUEST ANATOMY AND LIFETIME	109	=head1 REQUEST ANATOMY AND LIFETIME
111		110
112	Every C<aio_*> function creates a request. which is a C data structure not	111	Every C<aio_*> function creates a request. which is a C data structure not
113	directly visible to Perl.	112	directly visible to Perl.
…		…
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.33;
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
…		…
228	aio_unlink $pathname, $callback->($status)	227	aio_unlink $pathname, $callback->($status)
229	aio_mknod $pathname, $mode, $dev, $callback->($status)	228	aio_mknod $pathname, $mode, $dev, $callback->($status)
230	aio_link $srcpath, $dstpath, $callback->($status)	229	aio_link $srcpath, $dstpath, $callback->($status)
231	aio_symlink $srcpath, $dstpath, $callback->($status)	230	aio_symlink $srcpath, $dstpath, $callback->($status)
232	aio_readlink $pathname, $callback->($link)	231	aio_readlink $pathname, $callback->($link)
233	aio_realpath $pathname, $callback->($link)	232	aio_realpath $pathname, $callback->($path)
234	aio_rename $srcpath, $dstpath, $callback->($status)	233	aio_rename $srcpath, $dstpath, $callback->($status)
235	aio_mkdir $pathname, $mode, $callback->($status)	234	aio_mkdir $pathname, $mode, $callback->($status)
236	aio_rmdir $pathname, $callback->($status)	235	aio_rmdir $pathname, $callback->($status)
237	aio_readdir $pathname, $callback->($entries)	236	aio_readdir $pathname, $callback->($entries)
238	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
…		…
362		361
363		362
364	=item aio_open $pathname, $flags, $mode, $callback->($fh)	363	=item aio_open $pathname, $flags, $mode, $callback->($fh)
365		364
366	Asynchronously open or create a file and call the callback with a newly	365	Asynchronously open or create a file and call the callback with a newly
367	created filehandle for the file.	366	created filehandle for the file (or C<undef> in case of an error).
368		367
369	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	368	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
370	for an explanation.	369	for an explanation.
371		370
372	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	371	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
395	following POSIX and non-POSIX constants are available (missing ones on	394	following POSIX and non-POSIX constants are available (missing ones on
396	your system are, as usual, C<0>):	395	your system are, as usual, C<0>):
397		396
398	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	397	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
399	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	398	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
400	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.	399	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
401		400
402		401
403	=item aio_close $fh, $callback->($status)	402	=item aio_close $fh, $callback->($status)
404		403
405	Asynchronously close a file and call the callback with the result	404	Asynchronously close a file and call the callback with the result
…		…
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/ext4
		632	0x0000ef51 ext2
		633	0xf2f52010 f2fs
		634	0x00004006 fat
		635	0x65735546 fuseblk
		636	0x65735543 fusectl
		637	0x0bad1dea futexfs
		638	0x01161970 gfs2
		639	0x47504653 gpfs
		640	0x00004244 hfs
		641	0xf995e849 hpfs
		642	0x00c0ffee hostfs
		643	0x958458f6 hugetlbfs
		644	0x2bad1dea inotifyfs
		645	0x00009660 isofs
		646	0x000072b6 jffs2
		647	0x3153464a jfs
		648	0x6b414653 k-afs
		649	0x0bd00bd0 lustre
		650	0x0000137f minix
		651	0x0000138f minix 30 char names
		652	0x00002468 minix v2
		653	0x00002478 minix v2 30 char names
		654	0x00004d5a minix v3
		655	0x19800202 mqueue
		656	0x00004d44 msdos
		657	0x0000564c novell
		658	0x00006969 nfs
		659	0x6e667364 nfsd
		660	0x00003434 nilfs
		661	0x5346544e ntfs
		662	0x00009fa1 openprom
		663	0x7461636F ocfs2
		664	0x00009fa0 proc
		665	0x6165676c pstorefs
		666	0x0000002f qnx4
		667	0x68191122 qnx6
		668	0x858458f6 ramfs
		669	0x52654973 reiserfs
		670	0x00007275 romfs
		671	0x67596969 rpc_pipefs
		672	0x73636673 securityfs
		673	0xf97cff8c selinux
		674	0x0000517b smb
		675	0x534f434b sockfs
		676	0x73717368 squashfs
		677	0x62656572 sysfs
		678	0x012ff7b6 sysv2
		679	0x012ff7b5 sysv4
		680	0x01021994 tmpfs
		681	0x15013346 udf
		682	0x00011954 ufs
		683	0x54190100 ufs byteswapped
		684	0x00009fa2 usbdevfs
		685	0x01021997 v9fs
		686	0xa501fcf5 vxfs
		687	0xabba1974 xenfs
		688	0x012ff7b4 xenix
		689	0x58465342 xfs
		690	0x012fd16d xia
608		691
609	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	692	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
610		693
611	Works like perl's C<utime> function (including the special case of $atime	694	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	695	and $mtime being undef). Fractional times are supported if the underlying
…		…
642	Works like truncate(2) or ftruncate(2).	725	Works like truncate(2) or ftruncate(2).
643		726
644		727
645	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)	728	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
646		729
647	Allocates or freed disk space according to the C<$mode> argument. See the	730	Allocates or frees disk space according to the C<$mode> argument. See the
648	linux C<fallocate> docuemntation for details.	731	linux C<fallocate> documentation for details.
649		732
650	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>	733	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
651	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|	734	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
652	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.	735	to deallocate a file range.
		736
		737	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		738	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
		739	your L<fallocate(2)> manpage).
653		740
654	The file system block size used by C<fallocate> is presumably the	741	The file system block size used by C<fallocate> is presumably the
655	C<f_bsize> returned by C<statvfs>.	742	C<f_bsize> returned by C<statvfs>.
656		743
657	If C<fallocate> isn't available or cannot be emulated (currently no	744	If C<fallocate> isn't available or cannot be emulated (currently no
…		…
702		789
703		790
704	=item aio_realpath $pathname, $callback->($path)	791	=item aio_realpath $pathname, $callback->($path)
705		792
706	Asynchronously make the path absolute and resolve any symlinks in	793	Asynchronously make the path absolute and resolve any symlinks in
707	C<$path>. The resulting path only consists of directories (Same as	794	C<$path>. The resulting path only consists of directories (same as
708	L<Cwd::realpath>).	795	L<Cwd::realpath>).
709		796
710	This request can be used to get the absolute path of the current working	797	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).	798	directory by passing it a path of F<.> (a single dot).
712		799
713		800
714	=item aio_rename $srcpath, $dstpath, $callback->($status)	801	=item aio_rename $srcpath, $dstpath, $callback->($status)
715		802
716	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	803	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
717	rename(2) and call the callback with the result code.	804	rename(2) and call the callback with the result code.
		805
		806	On systems that support the AIO::WD working directory abstraction
		807	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		808	of failing, C<rename> is called on the absolute path of C<$wd>.
718		809
719		810
720	=item aio_mkdir $pathname, $mode, $callback->($status)	811	=item aio_mkdir $pathname, $mode, $callback->($status)
721		812
722	Asynchronously mkdir (create) a directory and call the callback with	813	Asynchronously mkdir (create) a directory and call the callback with
…		…
726		817
727	=item aio_rmdir $pathname, $callback->($status)	818	=item aio_rmdir $pathname, $callback->($status)
728		819
729	Asynchronously rmdir (delete) a directory and call the callback with the	820	Asynchronously rmdir (delete) a directory and call the callback with the
730	result code.	821	result code.
		822
		823	On systems that support the AIO::WD working directory abstraction
		824	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		825	C<rmdir> is called on the absolute path of C<$wd>.
731		826
732		827
733	=item aio_readdir $pathname, $callback->($entries)	828	=item aio_readdir $pathname, $callback->($entries)
734		829
735	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	830	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
1100	}	1195	}
1101		1196
1102	=item aio_rmtree $pathname, $callback->($status)	1197	=item aio_rmtree $pathname, $callback->($status)
1103		1198
1104	Delete a directory tree starting (and including) C<$path>, return the	1199	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	1200	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	1201	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1107	everything else.	1202	everything else.
1108		1203
1109	=cut	1204	=cut
1110		1205
…		…
1230		1325
1231	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1326	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1232	scalars.	1327	scalars.
1233		1328
1234	It touches (reads or writes) all memory pages in the specified	1329	It touches (reads or writes) all memory pages in the specified
1235	range inside the scalar. All caveats and parameters are the same	1330	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	1331	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	1332	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	1333	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1239	writing an octet from it, which dirties the page).	1334	writing an octet from it, which dirties the page).
1240		1335
1241	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1336	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1242		1337
1243	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1338	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1277		1372
1278	aio_mlockall IO::AIO::MCL_FUTURE;	1373	aio_mlockall IO::AIO::MCL_FUTURE;
1279		1374
1280	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1375	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1281		1376
1282	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1377	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	1378	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	1379	the ioctl is not available on your OS, then this request will fail with
1285	C<ENOSYS>.	1380	C<ENOSYS>.
1286		1381
1287	C<$start> is the starting offset to query extents for, C<$length> is the	1382	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	1383	size of the range to query - if it is C<undef>, then the whole file will
1289	be queried.	1384	be queried.
…		…
1292	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also	1387	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1293	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query	1388	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1294	the data portion.	1389	the data portion.
1295		1390
1296	C<$count> is the maximum number of extent records to return. If it is	1391	C<$count> is the maximum number of extent records to return. If it is
1297	C<undef>, then IO::AIO queries all extents of the file. As a very special	1392	C<undef>, then IO::AIO queries all extents of the range. As a very special
1298	case, if it is C<0>, then the callback receives the number of extents	1393	case, if it is C<0>, then the callback receives the number of extents
1299	instead of the extents themselves.	1394	instead of the extents themselves (which is unreliable, see below).
1300		1395
1301	If an error occurs, the callback receives no arguments. The special	1396	If an error occurs, the callback receives no arguments. The special
1302	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.	1397	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1303		1398
1304	Otherwise, the callback receives an array reference with extent	1399	Otherwise, the callback receives an array reference with extent
…		…
1306	following members:	1401	following members:
1307		1402
1308	[$logical, $physical, $length, $flags]	1403	[$logical, $physical, $length, $flags]
1309		1404
1310	Flags is any combination of the following flag values (typically either C<0>	1405	Flags is any combination of the following flag values (typically either C<0>
1311	or C<IO::AIO::FIEMAP_EXTENT_LAST>):	1406	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1312		1407
1313	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,	1408	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1314	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,	1409	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1315	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1410	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1316	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1411	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1317	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1412	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1318	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1413	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1319		1414
		1415	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1416	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1417	it to return all extents of a range for files with large number of
		1418	extents. The code works around all these issues if C<$count> is undef.
		1419
1320	=item aio_group $callback->(...)	1420	=item aio_group $callback->(...)
1321		1421
1322	This is a very special aio request: Instead of doing something, it is a	1422	This is a very special aio request: Instead of doing something, it is a
1323	container for other aio requests, which is useful if you want to bundle	1423	container for other aio requests, which is useful if you want to bundle
1324	many requests into a single, composite, request with a definite callback	1424	many requests into a single, composite, request with a definite callback
…		…
1407	aio_stat [$etcdir, "passwd"], sub {	1507	aio_stat [$etcdir, "passwd"], sub {
1408	# yay	1508	# yay
1409	};	1509	};
1410	};	1510	};
1411		1511
1412	That C<aio_wd> is a request and not a normal function shows that creating	1512	The fact that C<aio_wd> is a request and not a normal function shows that
1413	an IO::AIO::WD object is itself a potentially blocking operation, which is	1513	creating an IO::AIO::WD object is itself a potentially blocking operation,
1414	why it is done asynchronously.	1514	which is why it is done asynchronously.
1415		1515
1416	To stat the directory obtained with C<aio_wd> above, one could write	1516	To stat the directory obtained with C<aio_wd> above, one could write
1417	either of the following three request calls:	1517	either of the following three request calls:
1418		1518
1419	aio_lstat "/etc" , sub { ... # pathname as normal string	1519	aio_lstat "/etc" , sub { ... # pathname as normal string
…		…
1439	will still point to the original directory. Most functions accepting a	1539	will still point to the original directory. Most functions accepting a
1440	pathname will use the directory fd on newer systems, and the string on	1540	pathname will use the directory fd on newer systems, and the string on
1441	older systems. Some functions (such as realpath) will always rely on the	1541	older systems. Some functions (such as realpath) will always rely on the
1442	string form of the pathname.	1542	string form of the pathname.
1443		1543
1444	So this fucntionality is mainly useful to get some protection against	1544	So this functionality is mainly useful to get some protection against
1445	C<chdir>, to easily get an absolute path out of a relative path for future	1545	C<chdir>, to easily get an absolute path out of a relative path for future
1446	reference, and to speed up doing many operations in the same directory	1546	reference, and to speed up doing many operations in the same directory
1447	(e.g. when stat'ing all files in a directory).	1547	(e.g. when stat'ing all files in a directory).
1448		1548
1449	The following functions implement this working directory abstraction:	1549	The following functions implement this working directory abstraction:
…		…
1462	passing C<undef> as working directory component of a pathname fails the	1562	passing C<undef> as working directory component of a pathname fails the
1463	request with C<ENOENT>, there is often no need for error checking in the	1563	request with C<ENOENT>, there is often no need for error checking in the
1464	C<aio_wd> callback, as future requests using the value will fail in the	1564	C<aio_wd> callback, as future requests using the value will fail in the
1465	expected way.	1565	expected way.
1466		1566
1467	If this call isn't available because your OS lacks it or it couldn't be
1468	detected, it will be emulated by calling C<fsync> instead.
1469
1470	=item IO::AIO::CWD	1567	=item IO::AIO::CWD
1471		1568
1472	This is a compiletime constant (object) that represents the process	1569	This is a compiletime constant (object) that represents the process
1473	current working directory.	1570	current working directory.
1474		1571
1475	Specifying this object as working directory object for a pathname is as	1572	Specifying this object as working directory object for a pathname is as if
1476	if the pathname would be specified directly, without a directory object,	1573	the pathname would be specified directly, without a directory object. For
1477	e.g., these calls are functionally identical:	1574	example, these calls are functionally identical:
1478		1575
1479	aio_stat "somefile", sub { ... };	1576	aio_stat "somefile", sub { ... };
1480	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1577	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1481		1578
1482	=back	1579	=back
1483		1580
		1581	To recover the path associated with an IO::AIO::WD object, you can use
		1582	C<aio_realpath>:
		1583
		1584	aio_realpath $wd, sub {
		1585	warn "path is $_[0]\n";
		1586	};
		1587
		1588	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1589	sometimes, fall back to using an absolue path.
1484		1590
1485	=head2 IO::AIO::REQ CLASS	1591	=head2 IO::AIO::REQ CLASS
1486		1592
1487	All non-aggregate C<aio_*> functions return an object of this class when	1593	All non-aggregate C<aio_*> functions return an object of this class when
1488	called in non-void context.	1594	called in non-void context.
…		…
1666		1772
1667	See C<poll_cb> for an example.	1773	See C<poll_cb> for an example.
1668		1774
1669	=item IO::AIO::poll_cb	1775	=item IO::AIO::poll_cb
1670		1776
1671	Process some outstanding events on the result pipe. You have to call	1777	Process some requests that have reached the result phase (i.e. they have
		1778	been executed but the results are not yet reported). You have to call
		1779	this "regularly" to finish outstanding requests.
		1780
1672	this regularly. Returns C<0> if all events could be processed (or there	1781	Returns C<0> if all events could be processed (or there were no
1673	were no events to process), or C<-1> if it returned earlier for whatever	1782	events to process), or C<-1> if it returned earlier for whatever
1674	reason. Returns immediately when no events are outstanding. The amount of	1783	reason. Returns immediately when no events are outstanding. The amount
1675	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1784	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1676	C<IO::AIO::max_poll_time>.	1785	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1677		1786
1678	If not all requests were processed for whatever reason, the filehandle	1787	If not all requests were processed for whatever reason, the poll file
1679	will still be ready when C<poll_cb> returns, so normally you don't have to	1788	descriptor will still be ready when C<poll_cb> returns, so normally you
1680	do anything special to have it called later.	1789	don't have to do anything special to have it called later.
1681		1790
1682	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1791	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1683	ready, it can be beneficial to call this function from loops which submit	1792	ready, it can be beneficial to call this function from loops which submit
1684	a lot of requests, to make sure the results get processed when they become	1793	a lot of requests, to make sure the results get processed when they become
1685	available and not just when the loop is finished and the event loop takes	1794	available and not just when the loop is finished and the event loop takes
…		…
1694	poll => 'r', async => 1,	1803	poll => 'r', async => 1,
1695	cb => \&IO::AIO::poll_cb);	1804	cb => \&IO::AIO::poll_cb);
1696		1805
1697	=item IO::AIO::poll_wait	1806	=item IO::AIO::poll_wait
1698		1807
1699	If there are any outstanding requests and none of them in the result	1808	Wait until either at least one request is in the result phase or no
1700	phase, wait till the result filehandle becomes ready for reading (simply	1809	requests are outstanding anymore.
1701	does a C<select> on the filehandle. This is useful if you want to	1810
1702	synchronously wait for some requests to finish).	1811	This is useful if you want to synchronously wait for some requests to
		1812	become ready, without actually handling them.
1703		1813
1704	See C<nreqs> for an example.	1814	See C<nreqs> for an example.
1705		1815
1706	=item IO::AIO::poll	1816	=item IO::AIO::poll
1707		1817
…		…
1828		1938
1829	This is a very bad function to use in interactive programs because it	1939	This is a very bad function to use in interactive programs because it
1830	blocks, and a bad way to reduce concurrency because it is inexact: Better	1940	blocks, and a bad way to reduce concurrency because it is inexact: Better
1831	use an C<aio_group> together with a feed callback.	1941	use an C<aio_group> together with a feed callback.
1832		1942
1833	It's main use is in scripts without an event loop - when you want to stat	1943	Its main use is in scripts without an event loop - when you want to stat
1834	a lot of files, you can write somehting like this:	1944	a lot of files, you can write somehting like this:
1835		1945
1836	IO::AIO::max_outstanding 32;	1946	IO::AIO::max_outstanding 32;
1837		1947
1838	for my $path (...) {	1948	for my $path (...) {
…		…
1878		1988
1879	=back	1989	=back
1880		1990
1881	=head3 MISCELLANEOUS FUNCTIONS	1991	=head3 MISCELLANEOUS FUNCTIONS
1882		1992
1883	IO::AIO implements some functions that might be useful, but are not	1993	IO::AIO implements some functions that are useful when you want to use
1884	asynchronous.	1994	some "Advanced I/O" function not available to in Perl, without going the
		1995	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		1996	counterpart.
1885		1997
1886	=over 4	1998	=over 4
1887		1999
1888	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2000	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1889		2001
…		…
1948	filesize.	2060	filesize.
1949		2061
1950	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2062	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1951	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2063	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1952		2064
1953	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2065	C<$flags> can be a combination of
1954	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2066	C<IO::AIO::MAP_SHARED> or
1955	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2067	C<IO::AIO::MAP_PRIVATE>,
		2068	or a number of system-specific flags (when not available, the are C<0>):
1956	(which is set to C<MAP_ANON> if your system only provides this	2069	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1957	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2070	C<IO::AIO::MAP_HUGETLB>,
1958	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2071	C<IO::AIO::MAP_LOCKED>,
		2072	C<IO::AIO::MAP_NORESERVE>,
		2073	C<IO::AIO::MAP_POPULATE>,
1959	C<IO::AIO::MAP_NONBLOCK>	2074	C<IO::AIO::MAP_NONBLOCK>,
		2075	C<IO::AIO::MAP_FIXED>,
		2076	C<IO::AIO::MAP_GROWSDOWN>,
		2077	C<IO::AIO::MAP_32BIT>,
		2078	C<IO::AIO::MAP_HUGETLB> or
		2079	C<IO::AIO::MAP_STACK>.
1960		2080
1961	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2081	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1962		2082
1963	C<$offset> is the offset from the start of the file - it generally must be	2083	C<$offset> is the offset from the start of the file - it generally must be
1964	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2084	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
2007		2127
2008	See the C<splice(2)> manpage for details.	2128	See the C<splice(2)> manpage for details.
2009		2129
2010	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2130	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2011		2131
2012	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the	2132	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2013	description for C<IO::AIO::splice> above for details.	2133	description for C<IO::AIO::splice> above for details.
		2134
		2135	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2136
		2137	Attempts to query or change the pipe buffer size. Obviously works only
		2138	on pipes, and currently works only on GNU/Linux systems, and fails with
		2139	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2140	size on other systems, drop me a note.
		2141
		2142	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2143
		2144	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2145	C<$flags> is missing or C<0>, then this should be the same as a call to
		2146	perl's built-in C<pipe> function and create a new pipe, and works on
		2147	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2148	(..., 4096, O_BINARY)>.
		2149
		2150	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2151	the given flags (Linux 2.6.27, glibc 2.9).
		2152
		2153	On success, the read and write file handles are returned.
		2154
		2155	On error, nothing will be returned. If the pipe2 syscall is missing and
		2156	C<$flags> is non-zero, fails with C<ENOSYS>.
		2157
		2158	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2159	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2160	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2014		2161
2015	=back	2162	=back
2016		2163
2017	=cut	2164	=cut
2018		2165

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.230 by root, Fri Jul 27 17:24:06 2012 UTC vs. Revision 1.257 by root, Mon Jan 18 11:53:09 2016 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.230 by root, Fri Jul 27 17:24:06 2012 UTC vs.
Revision 1.257 by root, Mon Jan 18 11:53:09 2016 UTC