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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.266 by root, Tue Aug 9 11:37:53 2016 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	IO::AIO - Asynchronous Input/Output	3	IO::AIO - Asynchronous/Advanced Input/Output
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
58	not well-supported or restricted (GNU/Linux doesn't allow them on normal	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
59	files currently, for example), and they would only support aio_read and	59	files currently, for example), and they would only support aio_read and
60	aio_write, so the remaining functionality would have to be implemented	60	aio_write, so the remaining functionality would have to be implemented
61	using threads anyway.	61	using threads anyway.
62		62
		63	In addition to asynchronous I/O, this module also exports some rather
		64	arcane interfaces, such as C<madvise> or linux's C<splice> system call,
		65	which is why the C<A> in C<AIO> can also mean I<advanced>.
		66
63	Although the module will work in the presence of other (Perl-) threads,	67	Although the module will work in the presence of other (Perl-) threads,
64	it is currently not reentrant in any way, so use appropriate locking	68	it is currently not reentrant in any way, so use appropriate locking
65	yourself, always call C<poll_cb> from within the same thread, or never	69	yourself, always call C<poll_cb> from within the same thread, or never
66	call C<poll_cb> (or other C<aio_> functions) recursively.	70	call C<poll_cb> (or other C<aio_> functions) recursively.
67		71
68	=head2 EXAMPLE	72	=head2 EXAMPLE
69		73
70	This is a simple example that uses the EV module and loads	74	This is a simple example that uses the EV module and loads
71	F</etc/passwd> asynchronously:	75	F</etc/passwd> asynchronously:
72		76
73	use Fcntl;
74	use EV;	77	use EV;
75	use IO::AIO;	78	use IO::AIO;
76		79
77	# register the IO::AIO callback with EV	80	# register the IO::AIO callback with EV
78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	81	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
95		98
96	# file contents now in $contents	99	# file contents now in $contents
97	print $contents;	100	print $contents;
98		101
99	# exit event loop and program	102	# exit event loop and program
100	EV::unloop;	103	EV::break;
101	};	104	};
102	};	105	};
103		106
104	# possibly queue up other requests, or open GUI windows,	107	# possibly queue up other requests, or open GUI windows,
105	# check for sockets etc. etc.	108	# check for sockets etc. etc.
106		109
107	# process events as long as there are some:	110	# process events as long as there are some:
108	EV::loop;	111	EV::run;
109		112
110	=head1 REQUEST ANATOMY AND LIFETIME	113	=head1 REQUEST ANATOMY AND LIFETIME
111		114
112	Every C<aio_*> function creates a request. which is a C data structure not	115	Every C<aio_*> function creates a request. which is a C data structure not
113	directly visible to Perl.	116	directly visible to Perl.
…		…
168	use common::sense;	171	use common::sense;
169		172
170	use base 'Exporter';	173	use base 'Exporter';
171		174
172	BEGIN {	175	BEGIN {
173	our $VERSION = '4.15';	176	our $VERSION = 4.34;
174		177
175	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close	178	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	179	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate	181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179	aio_pathsync aio_readahead aio_fiemap	182	aio_pathsync aio_readahead aio_fiemap aio_allocate
180	aio_rename aio_link aio_move aio_copy aio_group	183	aio_rename aio_link aio_move aio_copy aio_group
181	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	184	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182	aio_chmod aio_utime aio_truncate	185	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	186	aio_msync aio_mtouch aio_mlock aio_mlockall
184	aio_statvfs	187	aio_statvfs
…		…
202		205
203	=head1 FUNCTIONS	206	=head1 FUNCTIONS
204		207
205	=head2 QUICK OVERVIEW	208	=head2 QUICK OVERVIEW
206		209
207	This section simply lists the prototypes of the most important functions	210	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	211	quick reference. See the following sections for function-by-function
209	documentation.	212	documentation.
210		213
211	aio_wd $pathname, $callback->($wd)	214	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	215	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	216	aio_close $fh, $callback->($status)
…		…
222	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	225	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	226	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	227	aio_chmod $fh_or_path, $mode, $callback->($status)
225	aio_truncate $fh_or_path, $offset, $callback->($status)	228	aio_truncate $fh_or_path, $offset, $callback->($status)
226	aio_allocate $fh, $mode, $offset, $len, $callback->($status)	229	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		230	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
227	aio_unlink $pathname, $callback->($status)	231	aio_unlink $pathname, $callback->($status)
228	aio_mknod $pathname, $mode, $dev, $callback->($status)	232	aio_mknod $pathname, $mode, $dev, $callback->($status)
229	aio_link $srcpath, $dstpath, $callback->($status)	233	aio_link $srcpath, $dstpath, $callback->($status)
230	aio_symlink $srcpath, $dstpath, $callback->($status)	234	aio_symlink $srcpath, $dstpath, $callback->($status)
231	aio_readlink $pathname, $callback->($link)	235	aio_readlink $pathname, $callback->($link)
232	aio_realpath $pathname, $callback->($link)	236	aio_realpath $pathname, $callback->($path)
233	aio_rename $srcpath, $dstpath, $callback->($status)	237	aio_rename $srcpath, $dstpath, $callback->($status)
234	aio_mkdir $pathname, $mode, $callback->($status)	238	aio_mkdir $pathname, $mode, $callback->($status)
235	aio_rmdir $pathname, $callback->($status)	239	aio_rmdir $pathname, $callback->($status)
236	aio_readdir $pathname, $callback->($entries)	240	aio_readdir $pathname, $callback->($entries)
237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	241	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
…		…
240	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)	244	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
241	aio_load $pathname, $data, $callback->($status)	245	aio_load $pathname, $data, $callback->($status)
242	aio_copy $srcpath, $dstpath, $callback->($status)	246	aio_copy $srcpath, $dstpath, $callback->($status)
243	aio_move $srcpath, $dstpath, $callback->($status)	247	aio_move $srcpath, $dstpath, $callback->($status)
244	aio_rmtree $pathname, $callback->($status)	248	aio_rmtree $pathname, $callback->($status)
		249	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		250	aio_ioctl $fh, $request, $buf, $callback->($status)
245	aio_sync $callback->($status)	251	aio_sync $callback->($status)
246	aio_syncfs $fh, $callback->($status)	252	aio_syncfs $fh, $callback->($status)
247	aio_fsync $fh, $callback->($status)	253	aio_fsync $fh, $callback->($status)
248	aio_fdatasync $fh, $callback->($status)	254	aio_fdatasync $fh, $callback->($status)
249	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	255	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
…		…
361		367
362		368
363	=item aio_open $pathname, $flags, $mode, $callback->($fh)	369	=item aio_open $pathname, $flags, $mode, $callback->($fh)
364		370
365	Asynchronously open or create a file and call the callback with a newly	371	Asynchronously open or create a file and call the callback with a newly
366	created filehandle for the file.	372	created filehandle for the file (or C<undef> in case of an error).
367		373
368	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	374	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
369	for an explanation.	375	for an explanation.
370		376
371	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	377	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
394	following POSIX and non-POSIX constants are available (missing ones on	400	following POSIX and non-POSIX constants are available (missing ones on
395	your system are, as usual, C<0>):	401	your system are, as usual, C<0>):
396		402
397	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	403	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
398	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	404	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
399	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.	405	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
400		406
401		407
402	=item aio_close $fh, $callback->($status)	408	=item aio_close $fh, $callback->($status)
403		409
404	Asynchronously close a file and call the callback with the result	410	Asynchronously close a file and call the callback with the result
…		…
440		446
441	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	447	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
442		448
443	Reads or writes C<$length> bytes from or to the specified C<$fh> and	449	Reads or writes C<$length> bytes from or to the specified C<$fh> and
444	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	450	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
445	and calls the callback without the actual number of bytes read (or -1 on	451	and calls the callback with the actual number of bytes read (or -1 on
446	error, just like the syscall).	452	error, just like the syscall).
447		453
448	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	454	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
449	offset plus the actual number of bytes read.	455	offset plus the actual number of bytes read.
450		456
…		…
508	As native sendfile syscalls (as practically any non-POSIX interface hacked	514	As native sendfile syscalls (as practically any non-POSIX interface hacked
509	together in a hurry to improve benchmark numbers) tend to be rather buggy	515	together in a hurry to improve benchmark numbers) tend to be rather buggy
510	on many systems, this implementation tries to work around some known bugs	516	on many systems, this implementation tries to work around some known bugs
511	in Linux and FreeBSD kernels (probably others, too), but that might fail,	517	in Linux and FreeBSD kernels (probably others, too), but that might fail,
512	so you really really should check the return value of C<aio_sendfile> -	518	so you really really should check the return value of C<aio_sendfile> -
513	fewre bytes than expected might have been transferred.	519	fewer bytes than expected might have been transferred.
514		520
515		521
516	=item aio_readahead $fh,$offset,$length, $callback->($retval)	522	=item aio_readahead $fh,$offset,$length, $callback->($retval)
517		523
518	C<aio_readahead> populates the page cache with data from a file so that	524	C<aio_readahead> populates the page cache with data from a file so that
…		…
522	whole pages, so that offset is effectively rounded down to a page boundary	528	whole pages, so that offset is effectively rounded down to a page boundary
523	and bytes are read up to the next page boundary greater than or equal to	529	and bytes are read up to the next page boundary greater than or equal to
524	(off-set+length). C<aio_readahead> does not read beyond the end of the	530	(off-set+length). C<aio_readahead> does not read beyond the end of the
525	file. The current file offset of the file is left unchanged.	531	file. The current file offset of the file is left unchanged.
526		532
527	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	533	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
528	emulated by simply reading the data, which would have a similar effect.	534	be emulated by simply reading the data, which would have a similar effect.
529		535
530		536
531	=item aio_stat $fh_or_path, $callback->($status)	537	=item aio_stat $fh_or_path, $callback->($status)
532		538
533	=item aio_lstat $fh, $callback->($status)	539	=item aio_lstat $fh, $callback->($status)
…		…
602	namemax => 255,	608	namemax => 255,
603	frsize => 1024,	609	frsize => 1024,
604	fsid => 1810	610	fsid => 1810
605	}	611	}
606		612
		613	Here is a (likely partial - send me updates!) list of fsid values used by
		614	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		615
		616	0x0000adf5 adfs
		617	0x0000adff affs
		618	0x5346414f afs
		619	0x09041934 anon-inode filesystem
		620	0x00000187 autofs
		621	0x42465331 befs
		622	0x1badface bfs
		623	0x42494e4d binfmt_misc
		624	0x9123683e btrfs
		625	0x0027e0eb cgroupfs
		626	0xff534d42 cifs
		627	0x73757245 coda
		628	0x012ff7b7 coh
		629	0x28cd3d45 cramfs
		630	0x453dcd28 cramfs-wend (wrong endianness)
		631	0x64626720 debugfs
		632	0x00001373 devfs
		633	0x00001cd1 devpts
		634	0x0000f15f ecryptfs
		635	0x00414a53 efs
		636	0x0000137d ext
		637	0x0000ef53 ext2/ext3/ext4
		638	0x0000ef51 ext2
		639	0xf2f52010 f2fs
		640	0x00004006 fat
		641	0x65735546 fuseblk
		642	0x65735543 fusectl
		643	0x0bad1dea futexfs
		644	0x01161970 gfs2
		645	0x47504653 gpfs
		646	0x00004244 hfs
		647	0xf995e849 hpfs
		648	0x00c0ffee hostfs
		649	0x958458f6 hugetlbfs
		650	0x2bad1dea inotifyfs
		651	0x00009660 isofs
		652	0x000072b6 jffs2
		653	0x3153464a jfs
		654	0x6b414653 k-afs
		655	0x0bd00bd0 lustre
		656	0x0000137f minix
		657	0x0000138f minix 30 char names
		658	0x00002468 minix v2
		659	0x00002478 minix v2 30 char names
		660	0x00004d5a minix v3
		661	0x19800202 mqueue
		662	0x00004d44 msdos
		663	0x0000564c novell
		664	0x00006969 nfs
		665	0x6e667364 nfsd
		666	0x00003434 nilfs
		667	0x5346544e ntfs
		668	0x00009fa1 openprom
		669	0x7461636F ocfs2
		670	0x00009fa0 proc
		671	0x6165676c pstorefs
		672	0x0000002f qnx4
		673	0x68191122 qnx6
		674	0x858458f6 ramfs
		675	0x52654973 reiserfs
		676	0x00007275 romfs
		677	0x67596969 rpc_pipefs
		678	0x73636673 securityfs
		679	0xf97cff8c selinux
		680	0x0000517b smb
		681	0x534f434b sockfs
		682	0x73717368 squashfs
		683	0x62656572 sysfs
		684	0x012ff7b6 sysv2
		685	0x012ff7b5 sysv4
		686	0x01021994 tmpfs
		687	0x15013346 udf
		688	0x00011954 ufs
		689	0x54190100 ufs byteswapped
		690	0x00009fa2 usbdevfs
		691	0x01021997 v9fs
		692	0xa501fcf5 vxfs
		693	0xabba1974 xenfs
		694	0x012ff7b4 xenix
		695	0x58465342 xfs
		696	0x012fd16d xia
607		697
608	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	698	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
609		699
610	Works like perl's C<utime> function (including the special case of $atime	700	Works like perl's C<utime> function (including the special case of $atime
611	and $mtime being undef). Fractional times are supported if the underlying	701	and $mtime being undef). Fractional times are supported if the underlying
…		…
641	Works like truncate(2) or ftruncate(2).	731	Works like truncate(2) or ftruncate(2).
642		732
643		733
644	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)	734	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
645		735
646	Allocates or freed disk space according to the C<$mode> argument. See the	736	Allocates or frees disk space according to the C<$mode> argument. See the
647	linux C<fallocate> docuemntation for details.	737	linux C<fallocate> documentation for details.
648		738
649	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>	739	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
650	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|	740	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
651	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.	741	to deallocate a file range.
		742
		743	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		744	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
		745	your L<fallocate(2)> manpage).
652		746
653	The file system block size used by C<fallocate> is presumably the	747	The file system block size used by C<fallocate> is presumably the
654	C<f_bsize> returned by C<statvfs>.	748	C<f_bsize> returned by C<statvfs>.
655		749
656	If C<fallocate> isn't available or cannot be emulated (currently no	750	If C<fallocate> isn't available or cannot be emulated (currently no
…		…
701		795
702		796
703	=item aio_realpath $pathname, $callback->($path)	797	=item aio_realpath $pathname, $callback->($path)
704		798
705	Asynchronously make the path absolute and resolve any symlinks in	799	Asynchronously make the path absolute and resolve any symlinks in
706	C<$path>. The resulting path only consists of directories (Same as	800	C<$path>. The resulting path only consists of directories (same as
707	L<Cwd::realpath>).	801	L<Cwd::realpath>).
708		802
709	This request can be used to get the absolute path of the current working	803	This request can be used to get the absolute path of the current working
710	directory by passing it a path of F<.> (a single dot).	804	directory by passing it a path of F<.> (a single dot).
711		805
712		806
713	=item aio_rename $srcpath, $dstpath, $callback->($status)	807	=item aio_rename $srcpath, $dstpath, $callback->($status)
714		808
715	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	809	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
716	rename(2) and call the callback with the result code.	810	rename(2) and call the callback with the result code.
		811
		812	On systems that support the AIO::WD working directory abstraction
		813	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		814	of failing, C<rename> is called on the absolute path of C<$wd>.
717		815
718		816
719	=item aio_mkdir $pathname, $mode, $callback->($status)	817	=item aio_mkdir $pathname, $mode, $callback->($status)
720		818
721	Asynchronously mkdir (create) a directory and call the callback with	819	Asynchronously mkdir (create) a directory and call the callback with
…		…
725		823
726	=item aio_rmdir $pathname, $callback->($status)	824	=item aio_rmdir $pathname, $callback->($status)
727		825
728	Asynchronously rmdir (delete) a directory and call the callback with the	826	Asynchronously rmdir (delete) a directory and call the callback with the
729	result code.	827	result code.
		828
		829	On systems that support the AIO::WD working directory abstraction
		830	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		831	C<rmdir> is called on the absolute path of C<$wd>.
730		832
731		833
732	=item aio_readdir $pathname, $callback->($entries)	834	=item aio_readdir $pathname, $callback->($entries)
733		835
734	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	836	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
1099	}	1201	}
1100		1202
1101	=item aio_rmtree $pathname, $callback->($status)	1203	=item aio_rmtree $pathname, $callback->($status)
1102		1204
1103	Delete a directory tree starting (and including) C<$path>, return the	1205	Delete a directory tree starting (and including) C<$path>, return the
1104	status of the final C<rmdir> only. This is a composite request that	1206	status of the final C<rmdir> only. This is a composite request that
1105	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1207	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1106	everything else.	1208	everything else.
1107		1209
1108	=cut	1210	=cut
1109		1211
…		…
1130	add $grp $dirgrp;	1232	add $grp $dirgrp;
1131	};	1233	};
1132		1234
1133	$grp	1235	$grp
1134	}	1236	}
		1237
		1238	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1239
		1240	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1241
		1242	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1243	they execute asynchronously and pass the return value to the callback.
		1244
		1245	Both calls can be used for a lot of things, some of which make more sense
		1246	to run asynchronously in their own thread, while some others make less
		1247	sense. For example, calls that block waiting for external events, such
		1248	as locking, will also lock down an I/O thread while it is waiting, which
		1249	can deadlock the whole I/O system. At the same time, there might be no
		1250	alternative to using a thread to wait.
		1251
		1252	So in general, you should only use these calls for things that do
		1253	(filesystem) I/O, not for things that wait for other events (network,
		1254	other processes), although if you are careful and know what you are doing,
		1255	you still can.
		1256
		1257	The following constants are available (missing ones are, as usual C<0>):
		1258
		1259	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1260
		1261	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1262	C<FS_IOC_FIEMAP>.
		1263
		1264	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1265	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1266
		1267	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1268	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1269	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1270	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1271	C<FS_FL_USER_MODIFIABLE>.
		1272
		1273	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1274	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1275	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1276	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1135		1277
1136	=item aio_sync $callback->($status)	1278	=item aio_sync $callback->($status)
1137		1279
1138	Asynchronously call sync and call the callback when finished.	1280	Asynchronously call sync and call the callback when finished.
1139		1281
…		…
1229		1371
1230	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1372	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1231	scalars.	1373	scalars.
1232		1374
1233	It touches (reads or writes) all memory pages in the specified	1375	It touches (reads or writes) all memory pages in the specified
1234	range inside the scalar. All caveats and parameters are the same	1376	range inside the scalar. All caveats and parameters are the same
1235	as for C<aio_msync>, above, except for flags, which must be either	1377	as for C<aio_msync>, above, except for flags, which must be either
1236	C<0> (which reads all pages and ensures they are instantiated) or	1378	C<0> (which reads all pages and ensures they are instantiated) or
1237	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1379	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1238	writing an octet from it, which dirties the page).	1380	writing an octet from it, which dirties the page).
1239		1381
1240	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1382	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1241		1383
1242	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1384	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1276		1418
1277	aio_mlockall IO::AIO::MCL_FUTURE;	1419	aio_mlockall IO::AIO::MCL_FUTURE;
1278		1420
1279	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1421	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1280		1422
1281	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1423	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1282	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1424	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1283	C<ioctl> is not available on your OS, then this rquiest will fail with	1425	the ioctl is not available on your OS, then this request will fail with
1284	C<ENOSYS>.	1426	C<ENOSYS>.
1285		1427
1286	C<$start> is the starting offset to query extents for, C<$length> is the	1428	C<$start> is the starting offset to query extents for, C<$length> is the
1287	size of the range to query - if it is C<undef>, then the whole file will	1429	size of the range to query - if it is C<undef>, then the whole file will
1288	be queried.	1430	be queried.
…		…
1291	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also	1433	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1292	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query	1434	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1293	the data portion.	1435	the data portion.
1294		1436
1295	C<$count> is the maximum number of extent records to return. If it is	1437	C<$count> is the maximum number of extent records to return. If it is
1296	C<undef>, then IO::AIO queries all extents of the file. As a very special	1438	C<undef>, then IO::AIO queries all extents of the range. As a very special
1297	case, if it is C<0>, then the callback receives the number of extents	1439	case, if it is C<0>, then the callback receives the number of extents
1298	instead of the extents themselves.	1440	instead of the extents themselves (which is unreliable, see below).
1299		1441
1300	If an error occurs, the callback receives no arguments. The special	1442	If an error occurs, the callback receives no arguments. The special
1301	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.	1443	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1302		1444
1303	Otherwise, the callback receives an array reference with extent	1445	Otherwise, the callback receives an array reference with extent
…		…
1305	following members:	1447	following members:
1306		1448
1307	[$logical, $physical, $length, $flags]	1449	[$logical, $physical, $length, $flags]
1308		1450
1309	Flags is any combination of the following flag values (typically either C<0>	1451	Flags is any combination of the following flag values (typically either C<0>
1310	or C<IO::AIO::FIEMAP_EXTENT_LAST>):	1452	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1311		1453
1312	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,	1454	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1313	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,	1455	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1314	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1456	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1315	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1457	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1316	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1458	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1317	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1459	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1318		1460
		1461	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1462	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1463	it to return all extents of a range for files with large number of
		1464	extents. The code works around all these issues if C<$count> is undef.
		1465
1319	=item aio_group $callback->(...)	1466	=item aio_group $callback->(...)
1320		1467
1321	This is a very special aio request: Instead of doing something, it is a	1468	This is a very special aio request: Instead of doing something, it is a
1322	container for other aio requests, which is useful if you want to bundle	1469	container for other aio requests, which is useful if you want to bundle
1323	many requests into a single, composite, request with a definite callback	1470	many requests into a single, composite, request with a definite callback
…		…
1406	aio_stat [$etcdir, "passwd"], sub {	1553	aio_stat [$etcdir, "passwd"], sub {
1407	# yay	1554	# yay
1408	};	1555	};
1409	};	1556	};
1410		1557
1411	That C<aio_wd> is a request and not a normal function shows that creating	1558	The fact that C<aio_wd> is a request and not a normal function shows that
1412	an IO::AIO::WD object is itself a potentially blocking operation, which is	1559	creating an IO::AIO::WD object is itself a potentially blocking operation,
1413	why it is done asynchronously.	1560	which is why it is done asynchronously.
1414		1561
1415	To stat the directory obtained with C<aio_wd> above, one could write	1562	To stat the directory obtained with C<aio_wd> above, one could write
1416	either of the following three request calls:	1563	either of the following three request calls:
1417		1564
1418	aio_lstat "/etc" , sub { ... # pathname as normal string	1565	aio_lstat "/etc" , sub { ... # pathname as normal string
…		…
1438	will still point to the original directory. Most functions accepting a	1585	will still point to the original directory. Most functions accepting a
1439	pathname will use the directory fd on newer systems, and the string on	1586	pathname will use the directory fd on newer systems, and the string on
1440	older systems. Some functions (such as realpath) will always rely on the	1587	older systems. Some functions (such as realpath) will always rely on the
1441	string form of the pathname.	1588	string form of the pathname.
1442		1589
1443	So this fucntionality is mainly useful to get some protection against	1590	So this functionality is mainly useful to get some protection against
1444	C<chdir>, to easily get an absolute path out of a relative path for future	1591	C<chdir>, to easily get an absolute path out of a relative path for future
1445	reference, and to speed up doing many operations in the same directory	1592	reference, and to speed up doing many operations in the same directory
1446	(e.g. when stat'ing all files in a directory).	1593	(e.g. when stat'ing all files in a directory).
1447		1594
1448	The following functions implement this working directory abstraction:	1595	The following functions implement this working directory abstraction:
…		…
1461	passing C<undef> as working directory component of a pathname fails the	1608	passing C<undef> as working directory component of a pathname fails the
1462	request with C<ENOENT>, there is often no need for error checking in the	1609	request with C<ENOENT>, there is often no need for error checking in the
1463	C<aio_wd> callback, as future requests using the value will fail in the	1610	C<aio_wd> callback, as future requests using the value will fail in the
1464	expected way.	1611	expected way.
1465		1612
1466	If this call isn't available because your OS lacks it or it couldn't be
1467	detected, it will be emulated by calling C<fsync> instead.
1468
1469	=item IO::AIO::CWD	1613	=item IO::AIO::CWD
1470		1614
1471	This is a compiletime constant (object) that represents the process	1615	This is a compiletime constant (object) that represents the process
1472	current working directory.	1616	current working directory.
1473		1617
1474	Specifying this object as working directory object for a pathname is as	1618	Specifying this object as working directory object for a pathname is as if
1475	if the pathname would be specified directly, without a directory object,	1619	the pathname would be specified directly, without a directory object. For
1476	e.g., these calls are functionally identical:	1620	example, these calls are functionally identical:
1477		1621
1478	aio_stat "somefile", sub { ... };	1622	aio_stat "somefile", sub { ... };
1479	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1623	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1480		1624
1481	=back	1625	=back
1482		1626
		1627	To recover the path associated with an IO::AIO::WD object, you can use
		1628	C<aio_realpath>:
		1629
		1630	aio_realpath $wd, sub {
		1631	warn "path is $_[0]\n";
		1632	};
		1633
		1634	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1635	sometimes, fall back to using an absolue path.
1483		1636
1484	=head2 IO::AIO::REQ CLASS	1637	=head2 IO::AIO::REQ CLASS
1485		1638
1486	All non-aggregate C<aio_*> functions return an object of this class when	1639	All non-aggregate C<aio_*> functions return an object of this class when
1487	called in non-void context.	1640	called in non-void context.
…		…
1665		1818
1666	See C<poll_cb> for an example.	1819	See C<poll_cb> for an example.
1667		1820
1668	=item IO::AIO::poll_cb	1821	=item IO::AIO::poll_cb
1669		1822
1670	Process some outstanding events on the result pipe. You have to call	1823	Process some requests that have reached the result phase (i.e. they have
		1824	been executed but the results are not yet reported). You have to call
		1825	this "regularly" to finish outstanding requests.
		1826
1671	this regularly. Returns C<0> if all events could be processed (or there	1827	Returns C<0> if all events could be processed (or there were no
1672	were no events to process), or C<-1> if it returned earlier for whatever	1828	events to process), or C<-1> if it returned earlier for whatever
1673	reason. Returns immediately when no events are outstanding. The amount of	1829	reason. Returns immediately when no events are outstanding. The amount
1674	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1830	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1675	C<IO::AIO::max_poll_time>.	1831	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1676		1832
1677	If not all requests were processed for whatever reason, the filehandle	1833	If not all requests were processed for whatever reason, the poll file
1678	will still be ready when C<poll_cb> returns, so normally you don't have to	1834	descriptor will still be ready when C<poll_cb> returns, so normally you
1679	do anything special to have it called later.	1835	don't have to do anything special to have it called later.
1680		1836
1681	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1837	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1682	ready, it can be beneficial to call this function from loops which submit	1838	ready, it can be beneficial to call this function from loops which submit
1683	a lot of requests, to make sure the results get processed when they become	1839	a lot of requests, to make sure the results get processed when they become
1684	available and not just when the loop is finished and the event loop takes	1840	available and not just when the loop is finished and the event loop takes
…		…
1693	poll => 'r', async => 1,	1849	poll => 'r', async => 1,
1694	cb => \&IO::AIO::poll_cb);	1850	cb => \&IO::AIO::poll_cb);
1695		1851
1696	=item IO::AIO::poll_wait	1852	=item IO::AIO::poll_wait
1697		1853
1698	If there are any outstanding requests and none of them in the result	1854	Wait until either at least one request is in the result phase or no
1699	phase, wait till the result filehandle becomes ready for reading (simply	1855	requests are outstanding anymore.
1700	does a C<select> on the filehandle. This is useful if you want to	1856
1701	synchronously wait for some requests to finish).	1857	This is useful if you want to synchronously wait for some requests to
		1858	become ready, without actually handling them.
1702		1859
1703	See C<nreqs> for an example.	1860	See C<nreqs> for an example.
1704		1861
1705	=item IO::AIO::poll	1862	=item IO::AIO::poll
1706		1863
…		…
1827		1984
1828	This is a very bad function to use in interactive programs because it	1985	This is a very bad function to use in interactive programs because it
1829	blocks, and a bad way to reduce concurrency because it is inexact: Better	1986	blocks, and a bad way to reduce concurrency because it is inexact: Better
1830	use an C<aio_group> together with a feed callback.	1987	use an C<aio_group> together with a feed callback.
1831		1988
1832	It's main use is in scripts without an event loop - when you want to stat	1989	Its main use is in scripts without an event loop - when you want to stat
1833	a lot of files, you can write somehting like this:	1990	a lot of files, you can write somehting like this:
1834		1991
1835	IO::AIO::max_outstanding 32;	1992	IO::AIO::max_outstanding 32;
1836		1993
1837	for my $path (...) {	1994	for my $path (...) {
…		…
1877		2034
1878	=back	2035	=back
1879		2036
1880	=head3 MISCELLANEOUS FUNCTIONS	2037	=head3 MISCELLANEOUS FUNCTIONS
1881		2038
1882	IO::AIO implements some functions that might be useful, but are not	2039	IO::AIO implements some functions that are useful when you want to use
1883	asynchronous.	2040	some "Advanced I/O" function not available to in Perl, without going the
		2041	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2042	counterpart.
1884		2043
1885	=over 4	2044	=over 4
1886		2045
1887	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2046	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1888		2047
…		…
1907	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2066	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1908		2067
1909	Simply calls the C<posix_madvise> function (see its	2068	Simply calls the C<posix_madvise> function (see its
1910	manpage for details). The following advice constants are	2069	manpage for details). The following advice constants are
1911	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2070	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1912	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2071	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
		2072	C<IO::AIO::MADV_FREE>.
1913		2073
1914	On systems that do not implement C<posix_madvise>, this function returns	2074	On systems that do not implement C<posix_madvise>, this function returns
1915	ENOSYS, otherwise the return value of C<posix_madvise>.	2075	ENOSYS, otherwise the return value of C<posix_madvise>.
1916		2076
1917	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2077	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
1947	filesize.	2107	filesize.
1948		2108
1949	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2109	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1950	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2110	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1951		2111
1952	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2112	C<$flags> can be a combination of
1953	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2113	C<IO::AIO::MAP_SHARED> or
1954	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2114	C<IO::AIO::MAP_PRIVATE>,
		2115	or a number of system-specific flags (when not available, the are C<0>):
1955	(which is set to C<MAP_ANON> if your system only provides this	2116	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1956	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2117	C<IO::AIO::MAP_LOCKED>,
1957	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2118	C<IO::AIO::MAP_NORESERVE>,
		2119	C<IO::AIO::MAP_POPULATE>,
1958	C<IO::AIO::MAP_NONBLOCK>	2120	C<IO::AIO::MAP_NONBLOCK>,
		2121	C<IO::AIO::MAP_FIXED>,
		2122	C<IO::AIO::MAP_GROWSDOWN>,
		2123	C<IO::AIO::MAP_32BIT>,
		2124	C<IO::AIO::MAP_HUGETLB> or
		2125	C<IO::AIO::MAP_STACK>.
1959		2126
1960	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2127	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1961		2128
1962	C<$offset> is the offset from the start of the file - it generally must be	2129	C<$offset> is the offset from the start of the file - it generally must be
1963	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2130	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
2006		2173
2007	See the C<splice(2)> manpage for details.	2174	See the C<splice(2)> manpage for details.
2008		2175
2009	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2176	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2010		2177
2011	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the	2178	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2012	description for C<IO::AIO::splice> above for details.	2179	description for C<IO::AIO::splice> above for details.
		2180
		2181	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2182
		2183	Attempts to query or change the pipe buffer size. Obviously works only
		2184	on pipes, and currently works only on GNU/Linux systems, and fails with
		2185	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2186	size on other systems, drop me a note.
		2187
		2188	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2189
		2190	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2191	C<$flags> is missing or C<0>, then this should be the same as a call to
		2192	perl's built-in C<pipe> function and create a new pipe, and works on
		2193	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2194	(..., 4096, O_BINARY)>.
		2195
		2196	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2197	the given flags (Linux 2.6.27, glibc 2.9).
		2198
		2199	On success, the read and write file handles are returned.
		2200
		2201	On error, nothing will be returned. If the pipe2 syscall is missing and
		2202	C<$flags> is non-zero, fails with C<ENOSYS>.
		2203
		2204	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2205	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2206	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2013		2207
2014	=back	2208	=back
2015		2209
2016	=cut	2210	=cut
2017		2211

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs. Revision 1.266 by root, Tue Aug 9 11:37:53 2016 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.229 by root, Wed Jul 25 16:32:30 2012 UTC vs.
Revision 1.266 by root, Tue Aug 9 11:37:53 2016 UTC