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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.219 by root, Tue Mar 27 18:54:45 2012 UTC vs.
Revision 1.235 by root, Wed Aug 22 22:28:03 2012 UTC

…		…
168	use common::sense;	168	use common::sense;
169		169
170	use base 'Exporter';	170	use base 'Exporter';
171		171
172	BEGIN {	172	BEGIN {
173	our $VERSION = '4.12';	173	our $VERSION = '4.16';
174		174
175	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close	175	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	176	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate	178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
179	aio_pathsync aio_readahead	179	aio_pathsync aio_readahead aio_fiemap
180	aio_rename aio_link aio_move aio_copy aio_group	180	aio_rename aio_link aio_move aio_copy aio_group
181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182	aio_chmod aio_utime aio_truncate	182	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	183	aio_msync aio_mtouch aio_mlock aio_mlockall
184	aio_statvfs	184	aio_statvfs
…		…
202		202
203	=head1 FUNCTIONS	203	=head1 FUNCTIONS
204		204
205	=head2 QUICK OVERVIEW	205	=head2 QUICK OVERVIEW
206		206
207	This section simply lists the prototypes of the most important functions	207	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	208	quick reference. See the following sections for function-by-function
209	documentation.	209	documentation.
210		210
211	aio_wd $pathname, $callback->($wd)	211	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	212	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	213	aio_close $fh, $callback->($status)
		214	aio_seek $fh,$offset,$whence, $callback->($offs)
214	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	215	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	216	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	217	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217	aio_readahead $fh,$offset,$length, $callback->($retval)	218	aio_readahead $fh,$offset,$length, $callback->($retval)
218	aio_stat $fh_or_path, $callback->($status)	219	aio_stat $fh_or_path, $callback->($status)
219	aio_lstat $fh, $callback->($status)	220	aio_lstat $fh, $callback->($status)
220	aio_statvfs $fh_or_path, $callback->($statvfs)	221	aio_statvfs $fh_or_path, $callback->($statvfs)
221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		224	aio_chmod $fh_or_path, $mode, $callback->($status)
223	aio_truncate $fh_or_path, $offset, $callback->($status)	225	aio_truncate $fh_or_path, $offset, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		227	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225	aio_unlink $pathname, $callback->($status)	228	aio_unlink $pathname, $callback->($status)
226	aio_mknod $pathname, $mode, $dev, $callback->($status)	229	aio_mknod $pathname, $mode, $dev, $callback->($status)
227	aio_link $srcpath, $dstpath, $callback->($status)	230	aio_link $srcpath, $dstpath, $callback->($status)
228	aio_symlink $srcpath, $dstpath, $callback->($status)	231	aio_symlink $srcpath, $dstpath, $callback->($status)
229	aio_readlink $pathname, $callback->($link)	232	aio_readlink $pathname, $callback->($link)
…		…
271	IO::AIO::nready	274	IO::AIO::nready
272	IO::AIO::npending	275	IO::AIO::npending
273		276
274	IO::AIO::sendfile $ofh, $ifh, $offset, $count	277	IO::AIO::sendfile $ofh, $ifh, $offset, $count
275	IO::AIO::fadvise $fh, $offset, $len, $advice	278	IO::AIO::fadvise $fh, $offset, $len, $advice
		279	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		280	IO::AIO::munmap $scalar
276	IO::AIO::madvise $scalar, $offset, $length, $advice	281	IO::AIO::madvise $scalar, $offset, $length, $advice
277	IO::AIO::mprotect $scalar, $offset, $length, $protect	282	IO::AIO::mprotect $scalar, $offset, $length, $protect
278	IO::AIO::munlock $scalar, $offset = 0, $length = undef	283	IO::AIO::munlock $scalar, $offset = 0, $length = undef
279	IO::AIO::munlockall	284	IO::AIO::munlockall
280		285
…		…
357		362
358		363
359	=item aio_open $pathname, $flags, $mode, $callback->($fh)	364	=item aio_open $pathname, $flags, $mode, $callback->($fh)
360		365
361	Asynchronously open or create a file and call the callback with a newly	366	Asynchronously open or create a file and call the callback with a newly
362	created filehandle for the file.	367	created filehandle for the file (or C<undef> in case of an error).
363		368
364	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	369	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
365	for an explanation.	370	for an explanation.
366		371
367	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	372	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
409		414
410	Or in other words: the file descriptor will be closed, but it will not be	415	Or in other words: the file descriptor will be closed, but it will not be
411	free for reuse until the perl filehandle is closed.	416	free for reuse until the perl filehandle is closed.
412		417
413	=cut	418	=cut
		419
		420	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		421
		422	Seeks the filehandle to the new C<$offset>, similarly to perl's
		423	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		424	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		425	C<IO::AIO::SEEK_END>).
		426
		427	The resulting absolute offset will be passed to the callback, or C<-1> in
		428	case of an error.
		429
		430	In theory, the C<$whence> constants could be different than the
		431	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		432	so don't panic.
		433
		434	As a GNU/Linux (and maybe Solaris) extension, also the constants
		435	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		436	could be found. No guarantees about suitability for use in C<aio_seek> or
		437	Perl's C<sysseek> can be made though, although I would naively assume they
		438	"just work".
414		439
415	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
416		441
417	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
418		443
…		…
578	namemax => 255,	603	namemax => 255,
579	frsize => 1024,	604	frsize => 1024,
580	fsid => 1810	605	fsid => 1810
581	}	606	}
582		607
		608	Here is a (likely partial) list of fsid values used by Linux - it is safe
		609	to hardcode these when the $^O is C<linux>:
		610
		611	0x0000adf5 adfs
		612	0x0000adff affs
		613	0x5346414f afs
		614	0x09041934 anon-inode filesystem
		615	0x00000187 autofs
		616	0x42465331 befs
		617	0x1badface bfs
		618	0x42494e4d binfmt_misc
		619	0x9123683e btrfs
		620	0x0027e0eb cgroupfs
		621	0xff534d42 cifs
		622	0x73757245 coda
		623	0x012ff7b7 coh
		624	0x28cd3d45 cramfs
		625	0x453dcd28 cramfs-wend (wrong endianness)
		626	0x64626720 debugfs
		627	0x00001373 devfs
		628	0x00001cd1 devpts
		629	0x0000f15f ecryptfs
		630	0x00414a53 efs
		631	0x0000137d ext
		632	0x0000ef53 ext2/ext3
		633	0x0000ef51 ext2
		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	0x958458f6 hugetlbfs
		643	0x2bad1dea inotifyfs
		644	0x00009660 isofs
		645	0x000072b6 jffs2
		646	0x3153464a jfs
		647	0x6b414653 k-afs
		648	0x0bd00bd0 lustre
		649	0x0000137f minix
		650	0x0000138f minix 30 char names
		651	0x00002468 minix v2
		652	0x00002478 minix v2 30 char names
		653	0x00004d5a minix v3
		654	0x19800202 mqueue
		655	0x00004d44 msdos
		656	0x0000564c novell
		657	0x00006969 nfs
		658	0x6e667364 nfsd
		659	0x00003434 nilfs
		660	0x5346544e ntfs
		661	0x00009fa1 openprom
		662	0x7461636F ocfs2
		663	0x00009fa0 proc
		664	0x6165676c pstorefs
		665	0x0000002f qnx4
		666	0x858458f6 ramfs
		667	0x52654973 reiserfs
		668	0x00007275 romfs
		669	0x67596969 rpc_pipefs
		670	0x73636673 securityfs
		671	0xf97cff8c selinux
		672	0x0000517b smb
		673	0x534f434b sockfs
		674	0x73717368 squashfs
		675	0x62656572 sysfs
		676	0x012ff7b6 sysv2
		677	0x012ff7b5 sysv4
		678	0x01021994 tmpfs
		679	0x15013346 udf
		680	0x00011954 ufs
		681	0x54190100 ufs byteswapped
		682	0x00009fa2 usbdevfs
		683	0x01021997 v9fs
		684	0xa501fcf5 vxfs
		685	0xabba1974 xenfs
		686	0x012ff7b4 xenix
		687	0x58465342 xfs
		688	0x012fd16d xia
583		689
584	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	690	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
585		691
586	Works like perl's C<utime> function (including the special case of $atime	692	Works like perl's C<utime> function (including the special case of $atime
587	and $mtime being undef). Fractional times are supported if the underlying	693	and $mtime being undef). Fractional times are supported if the underlying
…		…
613		719
614		720
615	=item aio_truncate $fh_or_path, $offset, $callback->($status)	721	=item aio_truncate $fh_or_path, $offset, $callback->($status)
616		722
617	Works like truncate(2) or ftruncate(2).	723	Works like truncate(2) or ftruncate(2).
		724
		725
		726	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		727
		728	Allocates or freed disk space according to the C<$mode> argument. See the
		729	linux C<fallocate> docuemntation for details.
		730
		731	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
		732	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|
		733	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
		734
		735	The file system block size used by C<fallocate> is presumably the
		736	C<f_bsize> returned by C<statvfs>.
		737
		738	If C<fallocate> isn't available or cannot be emulated (currently no
		739	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
618		740
619		741
620	=item aio_chmod $fh_or_path, $mode, $callback->($status)	742	=item aio_chmod $fh_or_path, $mode, $callback->($status)
621		743
622	Works like perl's C<chmod> function.	744	Works like perl's C<chmod> function.
…		…
1234		1356
1235	Example: asynchronously lock all current and future pages into memory.	1357	Example: asynchronously lock all current and future pages into memory.
1236		1358
1237	aio_mlockall IO::AIO::MCL_FUTURE;	1359	aio_mlockall IO::AIO::MCL_FUTURE;
1238		1360
		1361	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1362
		1363	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1364	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1365	the ioctl is not available on your OS, then this request will fail with
		1366	C<ENOSYS>.
		1367
		1368	C<$start> is the starting offset to query extents for, C<$length> is the
		1369	size of the range to query - if it is C<undef>, then the whole file will
		1370	be queried.
		1371
		1372	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1373	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1374	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1375	the data portion.
		1376
		1377	C<$count> is the maximum number of extent records to return. If it is
		1378	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1379	case, if it is C<0>, then the callback receives the number of extents
		1380	instead of the extents themselves (which is unreliable, see below).
		1381
		1382	If an error occurs, the callback receives no arguments. The special
		1383	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1384
		1385	Otherwise, the callback receives an array reference with extent
		1386	structures. Each extent structure is an array reference itself, with the
		1387	following members:
		1388
		1389	[$logical, $physical, $length, $flags]
		1390
		1391	Flags is any combination of the following flag values (typically either C<0>
		1392	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1393
		1394	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1395	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1396	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1397	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1398	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1399	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1400
		1401	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1402	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1403	it to return all extents of a range for files with large number of
		1404	extents. The code works around all these issues if C<$count> is undef.
		1405
1239	=item aio_group $callback->(...)	1406	=item aio_group $callback->(...)
1240		1407
1241	This is a very special aio request: Instead of doing something, it is a	1408	This is a very special aio request: Instead of doing something, it is a
1242	container for other aio requests, which is useful if you want to bundle	1409	container for other aio requests, which is useful if you want to bundle
1243	many requests into a single, composite, request with a definite callback	1410	many requests into a single, composite, request with a definite callback
…		…
1845	ENOSYS, otherwise the return value of C<mprotect>.	2012	ENOSYS, otherwise the return value of C<mprotect>.
1846		2013
1847	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2014	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1848		2015
1849	Memory-maps a file (or anonymous memory range) and attaches it to the	2016	Memory-maps a file (or anonymous memory range) and attaches it to the
1850	given C<$scalar>, which will act like a string scalar.	2017	given C<$scalar>, which will act like a string scalar. Returns true on
		2018	success, and false otherwise.
1851		2019
1852	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2020	The only operations allowed on the scalar are C<substr>/C<vec> that don't
1853	change the string length, and most read-only operations such as copying it	2021	change the string length, and most read-only operations such as copying it
1854	or searching it with regexes and so on.	2022	or searching it with regexes and so on.
1855		2023
…		…
1908	Calls the C<munlockall> function.	2076	Calls the C<munlockall> function.
1909		2077
1910	On systems that do not implement C<munlockall>, this function returns	2078	On systems that do not implement C<munlockall>, this function returns
1911	ENOSYS, otherwise the return value of C<munlockall>.	2079	ENOSYS, otherwise the return value of C<munlockall>.
1912		2080
		2081	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2082
		2083	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2084	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2085	should be the file offset.
		2086
		2087	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2088	silently corrupt the data in this case.
		2089
		2090	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2091	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2092	C<IO::AIO::SPLICE_F_GIFT>.
		2093
		2094	See the C<splice(2)> manpage for details.
		2095
		2096	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2097
		2098	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
		2099	description for C<IO::AIO::splice> above for details.
		2100
1913	=back	2101	=back
1914		2102
1915	=cut	2103	=cut
1916		2104
1917	min_parallel 8;	2105	min_parallel 8;

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.219 by root, Tue Mar 27 18:54:45 2012 UTC vs. Revision 1.235 by root, Wed Aug 22 22:28:03 2012 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.219 by root, Tue Mar 27 18:54:45 2012 UTC vs.
Revision 1.235 by root, Wed Aug 22 22:28:03 2012 UTC