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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.199 by root, Wed Jun 29 12:46:36 2011 UTC vs.
Revision 1.258 by root, Thu Jan 21 23:04:46 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 = '3.92';	172	our $VERSION = 4.33;
174		173
175	our @AIO_REQ = qw(aio_sendfile 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_sync aio_fsync	176	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	177	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
		178	aio_pathsync aio_readahead aio_fiemap
179	aio_rename aio_link aio_move aio_copy aio_group	179	aio_rename aio_link aio_move aio_copy aio_group
180	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
181	aio_chmod aio_utime aio_truncate	181	aio_chmod aio_utime aio_truncate
182	aio_msync aio_mtouch aio_mlock aio_mlockall	182	aio_msync aio_mtouch aio_mlock aio_mlockall
183	aio_statvfs);	183	aio_statvfs
		184	aio_wd);
184		185
185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	186	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	187	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
187	min_parallel max_parallel max_idle idle_timeout	188	min_parallel max_parallel max_idle idle_timeout
188	nreqs nready npending nthreads	189	nreqs nready npending nthreads
…		…
200		201
201	=head1 FUNCTIONS	202	=head1 FUNCTIONS
202		203
203	=head2 QUICK OVERVIEW	204	=head2 QUICK OVERVIEW
204		205
205	This section simply lists the prototypes of the most important functions	206	This section simply lists the prototypes most of the functions for
206	for quick reference. See the following sections for function-by-function	207	quick reference. See the following sections for function-by-function
207	documentation.	208	documentation.
208		209
		210	aio_wd $pathname, $callback->($wd)
209	aio_open $pathname, $flags, $mode, $callback->($fh)	211	aio_open $pathname, $flags, $mode, $callback->($fh)
210	aio_close $fh, $callback->($status)	212	aio_close $fh, $callback->($status)
		213	aio_seek $fh,$offset,$whence, $callback->($offs)
211	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	214	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
212	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	215	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	216	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
214	aio_readahead $fh,$offset,$length, $callback->($retval)	217	aio_readahead $fh,$offset,$length, $callback->($retval)
215	aio_stat $fh_or_path, $callback->($status)	218	aio_stat $fh_or_path, $callback->($status)
216	aio_lstat $fh, $callback->($status)	219	aio_lstat $fh, $callback->($status)
217	aio_statvfs $fh_or_path, $callback->($statvfs)	220	aio_statvfs $fh_or_path, $callback->($statvfs)
218	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
219	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		223	aio_chmod $fh_or_path, $mode, $callback->($status)
220	aio_truncate $fh_or_path, $offset, $callback->($status)	224	aio_truncate $fh_or_path, $offset, $callback->($status)
221	aio_chmod $fh_or_path, $mode, $callback->($status)	225	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		226	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
222	aio_unlink $pathname, $callback->($status)	227	aio_unlink $pathname, $callback->($status)
223	aio_mknod $path, $mode, $dev, $callback->($status)	228	aio_mknod $pathname, $mode, $dev, $callback->($status)
224	aio_link $srcpath, $dstpath, $callback->($status)	229	aio_link $srcpath, $dstpath, $callback->($status)
225	aio_symlink $srcpath, $dstpath, $callback->($status)	230	aio_symlink $srcpath, $dstpath, $callback->($status)
226	aio_readlink $path, $callback->($link)	231	aio_readlink $pathname, $callback->($link)
		232	aio_realpath $pathname, $callback->($path)
227	aio_rename $srcpath, $dstpath, $callback->($status)	233	aio_rename $srcpath, $dstpath, $callback->($status)
228	aio_mkdir $pathname, $mode, $callback->($status)	234	aio_mkdir $pathname, $mode, $callback->($status)
229	aio_rmdir $pathname, $callback->($status)	235	aio_rmdir $pathname, $callback->($status)
230	aio_readdir $pathname, $callback->($entries)	236	aio_readdir $pathname, $callback->($entries)
231	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
232	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	238	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
233	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN	239	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		240	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
234	aio_load $path, $data, $callback->($status)	241	aio_load $pathname, $data, $callback->($status)
235	aio_copy $srcpath, $dstpath, $callback->($status)	242	aio_copy $srcpath, $dstpath, $callback->($status)
236	aio_move $srcpath, $dstpath, $callback->($status)	243	aio_move $srcpath, $dstpath, $callback->($status)
237	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
238	aio_rmtree $path, $callback->($status)	244	aio_rmtree $pathname, $callback->($status)
239	aio_sync $callback->($status)	245	aio_sync $callback->($status)
		246	aio_syncfs $fh, $callback->($status)
240	aio_fsync $fh, $callback->($status)	247	aio_fsync $fh, $callback->($status)
241	aio_fdatasync $fh, $callback->($status)	248	aio_fdatasync $fh, $callback->($status)
242	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	249	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
243	aio_pathsync $path, $callback->($status)	250	aio_pathsync $pathname, $callback->($status)
244	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	251	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
245	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	252	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	253	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247	aio_mlockall $flags, $callback->($status)	254	aio_mlockall $flags, $callback->($status)
248	aio_group $callback->(...)	255	aio_group $callback->(...)
…		…
266	IO::AIO::nready	273	IO::AIO::nready
267	IO::AIO::npending	274	IO::AIO::npending
268		275
269	IO::AIO::sendfile $ofh, $ifh, $offset, $count	276	IO::AIO::sendfile $ofh, $ifh, $offset, $count
270	IO::AIO::fadvise $fh, $offset, $len, $advice	277	IO::AIO::fadvise $fh, $offset, $len, $advice
		278	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		279	IO::AIO::munmap $scalar
271	IO::AIO::madvise $scalar, $offset, $length, $advice	280	IO::AIO::madvise $scalar, $offset, $length, $advice
272	IO::AIO::mprotect $scalar, $offset, $length, $protect	281	IO::AIO::mprotect $scalar, $offset, $length, $protect
273	IO::AIO::munlock $scalar, $offset = 0, $length = undef	282	IO::AIO::munlock $scalar, $offset = 0, $length = undef
274	IO::AIO::munlockall	283	IO::AIO::munlockall
275		284
276	=head2 AIO REQUEST FUNCTIONS	285	=head2 API NOTES
277		286
278	All the C<aio_*> calls are more or less thin wrappers around the syscall	287	All the C<aio_*> calls are more or less thin wrappers around the syscall
279	with the same name (sans C<aio_>). The arguments are similar or identical,	288	with the same name (sans C<aio_>). The arguments are similar or identical,
280	and they all accept an additional (and optional) C<$callback> argument	289	and they all accept an additional (and optional) C<$callback> argument
281	which must be a code reference. This code reference will get called with	290	which must be a code reference. This code reference will be called after
282	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	291	the syscall has been executed in an asynchronous fashion. The results
283	perl, which usually delivers "false") as its sole argument after the given	292	of the request will be passed as arguments to the callback (and, if an
284	syscall has been executed asynchronously.	293	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		294	most syscalls return C<-1> on error, unlike perl, which usually delivers
		295	"false").
		296
		297	Some requests (such as C<aio_readdir>) pass the actual results and
		298	communicate failures by passing C<undef>.
285		299
286	All functions expecting a filehandle keep a copy of the filehandle	300	All functions expecting a filehandle keep a copy of the filehandle
287	internally until the request has finished.	301	internally until the request has finished.
288		302
289	All functions return request objects of type L<IO::AIO::REQ> that allow	303	All functions return request objects of type L<IO::AIO::REQ> that allow
290	further manipulation of those requests while they are in-flight.	304	further manipulation of those requests while they are in-flight.
291		305
292	The pathnames you pass to these routines I<must> be absolute and	306	The pathnames you pass to these routines I<should> be absolute. The
293	encoded as octets. The reason for the former is that at the time the	307	reason for this is that at the time the request is being executed, the
294	request is being executed, the current working directory could have	308	current working directory could have changed. Alternatively, you can
295	changed. Alternatively, you can make sure that you never change the	309	make sure that you never change the current working directory anywhere
296	current working directory anywhere in the program and then use relative	310	in the program and then use relative paths. You can also take advantage
297	paths.	311	of IO::AIOs working directory abstraction, that lets you specify paths
		312	relative to some previously-opened "working directory object" - see the
		313	description of the C<IO::AIO::WD> class later in this document.
298		314
299	To encode pathnames as octets, either make sure you either: a) always pass	315	To encode pathnames as octets, either make sure you either: a) always pass
300	in filenames you got from outside (command line, readdir etc.) without	316	in filenames you got from outside (command line, readdir etc.) without
301	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	317	tinkering, b) are in your native filesystem encoding, c) use the Encode
302	your pathnames to the locale (or other) encoding in effect in the user	318	module and encode your pathnames to the locale (or other) encoding in
303	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	319	effect in the user environment, d) use Glib::filename_from_unicode on
304	use something else to ensure your scalar has the correct contents.	320	unicode filenames or e) use something else to ensure your scalar has the
		321	correct contents.
305		322
306	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	323	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
307	handles correctly whether it is set or not.	324	handles correctly whether it is set or not.
		325
		326	=head2 AIO REQUEST FUNCTIONS
308		327
309	=over 4	328	=over 4
310		329
311	=item $prev_pri = aioreq_pri [$pri]	330	=item $prev_pri = aioreq_pri [$pri]
312		331
…		…
342		361
343		362
344	=item aio_open $pathname, $flags, $mode, $callback->($fh)	363	=item aio_open $pathname, $flags, $mode, $callback->($fh)
345		364
346	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
347	created filehandle for the file.	366	created filehandle for the file (or C<undef> in case of an error).
348		367
349	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,
350	for an explanation.	369	for an explanation.
351		370
352	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
…		…
375	following POSIX and non-POSIX constants are available (missing ones on	394	following POSIX and non-POSIX constants are available (missing ones on
376	your system are, as usual, C<0>):	395	your system are, as usual, C<0>):
377		396
378	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>,
379	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>,
380	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>.
381		400
382		401
383	=item aio_close $fh, $callback->($status)	402	=item aio_close $fh, $callback->($status)
384		403
385	Asynchronously close a file and call the callback with the result	404	Asynchronously close a file and call the callback with the result
…		…
394		413
395	Or in other words: the file descriptor will be closed, but it will not be	414	Or in other words: the file descriptor will be closed, but it will not be
396	free for reuse until the perl filehandle is closed.	415	free for reuse until the perl filehandle is closed.
397		416
398	=cut	417	=cut
		418
		419	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		420
		421	Seeks the filehandle to the new C<$offset>, similarly to perl's
		422	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		423	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		424	C<IO::AIO::SEEK_END>).
		425
		426	The resulting absolute offset will be passed to the callback, or C<-1> in
		427	case of an error.
		428
		429	In theory, the C<$whence> constants could be different than the
		430	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		431	so don't panic.
		432
		433	As a GNU/Linux (and maybe Solaris) extension, also the constants
		434	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		435	could be found. No guarantees about suitability for use in C<aio_seek> or
		436	Perl's C<sysseek> can be made though, although I would naively assume they
		437	"just work".
399		438
400	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	439	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
401		440
402	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	441	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
403		442
…		…
563	namemax => 255,	602	namemax => 255,
564	frsize => 1024,	603	frsize => 1024,
565	fsid => 1810	604	fsid => 1810
566	}	605	}
567		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
568		691
569	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	692	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
570		693
571	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
572	and $mtime being undef). Fractional times are supported if the underlying	695	and $mtime being undef). Fractional times are supported if the underlying
…		…
600	=item aio_truncate $fh_or_path, $offset, $callback->($status)	723	=item aio_truncate $fh_or_path, $offset, $callback->($status)
601		724
602	Works like truncate(2) or ftruncate(2).	725	Works like truncate(2) or ftruncate(2).
603		726
604		727
		728	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		729
		730	Allocates or frees disk space according to the C<$mode> argument. See the
		731	linux C<fallocate> documentation for details.
		732
		733	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		734	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
		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).
		740
		741	The file system block size used by C<fallocate> is presumably the
		742	C<f_bsize> returned by C<statvfs>.
		743
		744	If C<fallocate> isn't available or cannot be emulated (currently no
		745	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		746
		747
605	=item aio_chmod $fh_or_path, $mode, $callback->($status)	748	=item aio_chmod $fh_or_path, $mode, $callback->($status)
606		749
607	Works like perl's C<chmod> function.	750	Works like perl's C<chmod> function.
608		751
609		752
…		…
611		754
612	Asynchronously unlink (delete) a file and call the callback with the	755	Asynchronously unlink (delete) a file and call the callback with the
613	result code.	756	result code.
614		757
615		758
616	=item aio_mknod $path, $mode, $dev, $callback->($status)	759	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
617		760
618	[EXPERIMENTAL]	761	[EXPERIMENTAL]
619		762
620	Asynchronously create a device node (or fifo). See mknod(2).	763	Asynchronously create a device node (or fifo). See mknod(2).
621		764
622	The only (POSIX-) portable way of calling this function is:	765	The only (POSIX-) portable way of calling this function is:
623		766
624	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	767	aio_mknod $pathname, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
625		768
626	See C<aio_stat> for info about some potentially helpful extra constants	769	See C<aio_stat> for info about some potentially helpful extra constants
627	and functions.	770	and functions.
628		771
629	=item aio_link $srcpath, $dstpath, $callback->($status)	772	=item aio_link $srcpath, $dstpath, $callback->($status)
…		…
636		779
637	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	780	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
638	the path C<$dstpath> and call the callback with the result code.	781	the path C<$dstpath> and call the callback with the result code.
639		782
640		783
641	=item aio_readlink $path, $callback->($link)	784	=item aio_readlink $pathname, $callback->($link)
642		785
643	Asynchronously read the symlink specified by C<$path> and pass it to	786	Asynchronously read the symlink specified by C<$path> and pass it to
644	the callback. If an error occurs, nothing or undef gets passed to the	787	the callback. If an error occurs, nothing or undef gets passed to the
645	callback.	788	callback.
646		789
647		790
		791	=item aio_realpath $pathname, $callback->($path)
		792
		793	Asynchronously make the path absolute and resolve any symlinks in
		794	C<$path>. The resulting path only consists of directories (same as
		795	L<Cwd::realpath>).
		796
		797	This request can be used to get the absolute path of the current working
		798	directory by passing it a path of F<.> (a single dot).
		799
		800
648	=item aio_rename $srcpath, $dstpath, $callback->($status)	801	=item aio_rename $srcpath, $dstpath, $callback->($status)
649		802
650	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
651	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>.
652		809
653		810
654	=item aio_mkdir $pathname, $mode, $callback->($status)	811	=item aio_mkdir $pathname, $mode, $callback->($status)
655		812
656	Asynchronously mkdir (create) a directory and call the callback with	813	Asynchronously mkdir (create) a directory and call the callback with
…		…
661	=item aio_rmdir $pathname, $callback->($status)	818	=item aio_rmdir $pathname, $callback->($status)
662		819
663	Asynchronously rmdir (delete) a directory and call the callback with the	820	Asynchronously rmdir (delete) a directory and call the callback with the
664	result code.	821	result code.
665		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>.
		826
666		827
667	=item aio_readdir $pathname, $callback->($entries)	828	=item aio_readdir $pathname, $callback->($entries)
668		829
669	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
670	directory (i.e. opendir + readdir + closedir). The entries will not be	831	directory (i.e. opendir + readdir + closedir). The entries will not be
…		…
674	array-ref with the filenames.	835	array-ref with the filenames.
675		836
676		837
677	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)	838	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
678		839
679	Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune	840	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
680	behaviour and output format. In case of an error, C<$entries> will be	841	tune behaviour and output format. In case of an error, C<$entries> will be
681	C<undef>.	842	C<undef>.
682		843
683	The flags are a combination of the following constants, ORed together (the	844	The flags are a combination of the following constants, ORed together (the
684	flags will also be passed to the callback, possibly modified):	845	flags will also be passed to the callback, possibly modified):
685		846
…		…
732		893
733	=item IO::AIO::READDIR_FOUND_UNKNOWN	894	=item IO::AIO::READDIR_FOUND_UNKNOWN
734		895
735	This flag should not be set when calling C<aio_readdirx>. Instead, it	896	This flag should not be set when calling C<aio_readdirx>. Instead, it
736	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	897	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
737	C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all	898	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
738	C<$type>'s are known, which can be used to speed up some algorithms.	899	C<$type>'s are known, which can be used to speed up some algorithms.
739		900
740	=back	901	=back
741		902
742		903
743	=item aio_load $path, $data, $callback->($status)	904	=item aio_load $pathname, $data, $callback->($status)
744		905
745	This is a composite request that tries to fully load the given file into	906	This is a composite request that tries to fully load the given file into
746	memory. Status is the same as with aio_read.	907	memory. Status is the same as with aio_read.
747		908
748	=cut	909	=cut
…		…
883	};	1044	};
884		1045
885	$grp	1046	$grp
886	}	1047	}
887		1048
888	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1049	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
889		1050
890	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1051	Scans a directory (similar to C<aio_readdir>) but additionally tries to
891	efficiently separate the entries of directory C<$path> into two sets of	1052	efficiently separate the entries of directory C<$path> into two sets of
892	names, directories you can recurse into (directories), and ones you cannot	1053	names, directories you can recurse into (directories), and ones you cannot
893	recurse into (everything else, including symlinks to directories).	1054	recurse into (everything else, including symlinks to directories).
…		…
924	Then entries will be sorted into likely directories a non-initial dot	1085	Then entries will be sorted into likely directories a non-initial dot
925	currently) and likely non-directories (see C<aio_readdirx>). Then every	1086	currently) and likely non-directories (see C<aio_readdirx>). Then every
926	entry plus an appended C</.> will be C<stat>'ed, likely directories first,	1087	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
927	in order of their inode numbers. If that succeeds, it assumes that the	1088	in order of their inode numbers. If that succeeds, it assumes that the
928	entry is a directory or a symlink to directory (which will be checked	1089	entry is a directory or a symlink to directory (which will be checked
929	seperately). This is often faster than stat'ing the entry itself because	1090	separately). This is often faster than stat'ing the entry itself because
930	filesystems might detect the type of the entry without reading the inode	1091	filesystems might detect the type of the entry without reading the inode
931	data (e.g. ext2fs filetype feature), even on systems that cannot return	1092	data (e.g. ext2fs filetype feature), even on systems that cannot return
932	the filetype information on readdir.	1093	the filetype information on readdir.
933		1094
934	If the known number of directories (link count - 2) has been reached, the	1095	If the known number of directories (link count - 2) has been reached, the
…		…
950		1111
951	my $grp = aio_group $cb;	1112	my $grp = aio_group $cb;
952		1113
953	$maxreq = 4 if $maxreq <= 0;	1114	$maxreq = 4 if $maxreq <= 0;
954		1115
955	# stat once	1116	# get a wd object
956	aioreq_pri $pri;	1117	aioreq_pri $pri;
957	add $grp aio_stat $path, sub {	1118	add $grp aio_wd $path, sub {
		1119	$_[0]
958	return $grp->result () if $_[0];	1120	or return $grp->result ();
959	my $now = time;
960	my $hash1 = join ":", (stat _)[0,1,3,7,9];
961		1121
962	# read the directory entries	1122	my $wd = [shift, "."];
		1123
		1124	# stat once
963	aioreq_pri $pri;	1125	aioreq_pri $pri;
964	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {	1126	add $grp aio_stat $wd, sub {
965	my $entries = shift
966	or return $grp->result ();	1127	return $grp->result () if $_[0];
		1128	my $now = time;
		1129	my $hash1 = join ":", (stat _)[0,1,3,7,9];
967		1130
968	# stat the dir another time	1131	# read the directory entries
969	aioreq_pri $pri;	1132	aioreq_pri $pri;
		1133	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1134	my $entries = shift
		1135	or return $grp->result ();
		1136
		1137	# stat the dir another time
		1138	aioreq_pri $pri;
970	add $grp aio_stat $path, sub {	1139	add $grp aio_stat $wd, sub {
971	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1140	my $hash2 = join ":", (stat _)[0,1,3,7,9];
972		1141
973	my $ndirs;	1142	my $ndirs;
974		1143
975	# take the slow route if anything looks fishy	1144	# take the slow route if anything looks fishy
976	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1145	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
977	$ndirs = -1;	1146	$ndirs = -1;
978	} else {	1147	} else {
979	# if nlink == 2, we are finished	1148	# if nlink == 2, we are finished
980	# for non-posix-fs's, we rely on nlink < 2	1149	# for non-posix-fs's, we rely on nlink < 2
981	$ndirs = (stat _)[3] - 2	1150	$ndirs = (stat _)[3] - 2
982	or return $grp->result ([], $entries);	1151	or return $grp->result ([], $entries);
983	}	1152	}
984		1153
985	my (@dirs, @nondirs);	1154	my (@dirs, @nondirs);
986		1155
987	my $statgrp = add $grp aio_group sub {	1156	my $statgrp = add $grp aio_group sub {
988	$grp->result (\@dirs, \@nondirs);	1157	$grp->result (\@dirs, \@nondirs);
989	};	1158	};
990		1159
991	limit $statgrp $maxreq;	1160	limit $statgrp $maxreq;
992	feed $statgrp sub {	1161	feed $statgrp sub {
993	return unless @$entries;	1162	return unless @$entries;
994	my $entry = shift @$entries;	1163	my $entry = shift @$entries;
995		1164
996	aioreq_pri $pri;	1165	aioreq_pri $pri;
		1166	$wd->[1] = "$entry/.";
997	add $statgrp aio_stat "$path/$entry/.", sub {	1167	add $statgrp aio_stat $wd, sub {
998	if ($_[0] < 0) {	1168	if ($_[0] < 0) {
999	push @nondirs, $entry;	1169	push @nondirs, $entry;
1000	} else {	1170	} else {
1001	# need to check for real directory	1171	# need to check for real directory
1002	aioreq_pri $pri;	1172	aioreq_pri $pri;
		1173	$wd->[1] = $entry;
1003	add $statgrp aio_lstat "$path/$entry", sub {	1174	add $statgrp aio_lstat $wd, sub {
1004	if (-d _) {	1175	if (-d _) {
1005	push @dirs, $entry;	1176	push @dirs, $entry;
1006		1177
1007	unless (--$ndirs) {	1178	unless (--$ndirs) {
1008	push @nondirs, @$entries;	1179	push @nondirs, @$entries;
1009	feed $statgrp;	1180	feed $statgrp;
		1181	}
		1182	} else {
		1183	push @nondirs, $entry;
1010	}	1184	}
1011	} else {
1012	push @nondirs, $entry;
1013	}	1185	}
1014	}	1186	}
1015	}	1187	};
1016	};	1188	};
1017	};	1189	};
1018	};	1190	};
1019	};	1191	};
1020	};	1192	};
1021		1193
1022	$grp	1194	$grp
1023	}	1195	}
1024		1196
1025	=item aio_rmtree $path, $callback->($status)	1197	=item aio_rmtree $pathname, $callback->($status)
1026		1198
1027	Delete a directory tree starting (and including) C<$path>, return the	1199	Delete a directory tree starting (and including) C<$path>, return the
1028	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
1029	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
1030	everything else.	1202	everything else.
1031		1203
1032	=cut	1204	=cut
1033		1205
…		…
1072	callback with the fdatasync result code.	1244	callback with the fdatasync result code.
1073		1245
1074	If this call isn't available because your OS lacks it or it couldn't be	1246	If this call isn't available because your OS lacks it or it couldn't be
1075	detected, it will be emulated by calling C<fsync> instead.	1247	detected, it will be emulated by calling C<fsync> instead.
1076		1248
		1249	=item aio_syncfs $fh, $callback->($status)
		1250
		1251	Asynchronously call the syncfs syscall to sync the filesystem associated
		1252	to the given filehandle and call the callback with the syncfs result
		1253	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1254	errno to C<ENOSYS> nevertheless.
		1255
1077	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	1256	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1078		1257
1079	Sync the data portion of the file specified by C<$offset> and C<$length>	1258	Sync the data portion of the file specified by C<$offset> and C<$length>
1080	to disk (but NOT the metadata), by calling the Linux-specific	1259	to disk (but NOT the metadata), by calling the Linux-specific
1081	sync_file_range call. If sync_file_range is not available or it returns	1260	sync_file_range call. If sync_file_range is not available or it returns
…		…
1084	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,	1263	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1085	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and	1264	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1086	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range	1265	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1087	manpage for details.	1266	manpage for details.
1088		1267
1089	=item aio_pathsync $path, $callback->($status)	1268	=item aio_pathsync $pathname, $callback->($status)
1090		1269
1091	This request tries to open, fsync and close the given path. This is a	1270	This request tries to open, fsync and close the given path. This is a
1092	composite request intended to sync directories after directory operations	1271	composite request intended to sync directories after directory operations
1093	(E.g. rename). This might not work on all operating systems or have any	1272	(E.g. rename). This might not work on all operating systems or have any
1094	specific effect, but usually it makes sure that directory changes get	1273	specific effect, but usually it makes sure that directory changes get
…		…
1146		1325
1147	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
1148	scalars.	1327	scalars.
1149		1328
1150	It touches (reads or writes) all memory pages in the specified	1329	It touches (reads or writes) all memory pages in the specified
1151	range inside the scalar. All caveats and parameters are the same	1330	range inside the scalar. All caveats and parameters are the same
1152	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
1153	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
1154	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
1155	writing an octet from it, which dirties the page).	1334	writing an octet from it, which dirties the page).
1156		1335
1157	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1336	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1158		1337
1159	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
…		…
1190	documented under L<MISCELLANEOUS FUNCTIONS>.	1369	documented under L<MISCELLANEOUS FUNCTIONS>.
1191		1370
1192	Example: asynchronously lock all current and future pages into memory.	1371	Example: asynchronously lock all current and future pages into memory.
1193		1372
1194	aio_mlockall IO::AIO::MCL_FUTURE;	1373	aio_mlockall IO::AIO::MCL_FUTURE;
		1374
		1375	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1376
		1377	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1378	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1379	the ioctl is not available on your OS, then this request will fail with
		1380	C<ENOSYS>.
		1381
		1382	C<$start> is the starting offset to query extents for, C<$length> is the
		1383	size of the range to query - if it is C<undef>, then the whole file will
		1384	be queried.
		1385
		1386	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1387	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1388	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1389	the data portion.
		1390
		1391	C<$count> is the maximum number of extent records to return. If it is
		1392	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1393	case, if it is C<0>, then the callback receives the number of extents
		1394	instead of the extents themselves (which is unreliable, see below).
		1395
		1396	If an error occurs, the callback receives no arguments. The special
		1397	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1398
		1399	Otherwise, the callback receives an array reference with extent
		1400	structures. Each extent structure is an array reference itself, with the
		1401	following members:
		1402
		1403	[$logical, $physical, $length, $flags]
		1404
		1405	Flags is any combination of the following flag values (typically either C<0>
		1406	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1407
		1408	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1409	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1410	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1411	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1412	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1413	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		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.
1195		1419
1196	=item aio_group $callback->(...)	1420	=item aio_group $callback->(...)
1197		1421
1198	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
1199	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
…		…
1236	like sleep and file handle readable/writable, the overhead this creates is	1460	like sleep and file handle readable/writable, the overhead this creates is
1237	immense (it blocks a thread for a long time) so do not use this function	1461	immense (it blocks a thread for a long time) so do not use this function
1238	except to put your application under artificial I/O pressure.	1462	except to put your application under artificial I/O pressure.
1239		1463
1240	=back	1464	=back
		1465
		1466
		1467	=head2 IO::AIO::WD - multiple working directories
		1468
		1469	Your process only has one current working directory, which is used by all
		1470	threads. This makes it hard to use relative paths (some other component
		1471	could call C<chdir> at any time, and it is hard to control when the path
		1472	will be used by IO::AIO).
		1473
		1474	One solution for this is to always use absolute paths. This usually works,
		1475	but can be quite slow (the kernel has to walk the whole path on every
		1476	access), and can also be a hassle to implement.
		1477
		1478	Newer POSIX systems have a number of functions (openat, fdopendir,
		1479	futimensat and so on) that make it possible to specify working directories
		1480	per operation.
		1481
		1482	For portability, and because the clowns who "designed", or shall I write,
		1483	perpetrated this new interface were obviously half-drunk, this abstraction
		1484	cannot be perfect, though.
		1485
		1486	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1487	object. This object stores the canonicalised, absolute version of the
		1488	path, and on systems that allow it, also a directory file descriptor.
		1489
		1490	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1491	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1492	object and a pathname instead (or the IO::AIO::WD object alone, which
		1493	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1494	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1495	to that IO::AIO::WD object.
		1496
		1497	For example, to get a wd object for F</etc> and then stat F<passwd>
		1498	inside, you would write:
		1499
		1500	aio_wd "/etc", sub {
		1501	my $etcdir = shift;
		1502
		1503	# although $etcdir can be undef on error, there is generally no reason
		1504	# to check for errors here, as aio_stat will fail with ENOENT
		1505	# when $etcdir is undef.
		1506
		1507	aio_stat [$etcdir, "passwd"], sub {
		1508	# yay
		1509	};
		1510	};
		1511
		1512	The fact that C<aio_wd> is a request and not a normal function shows that
		1513	creating an IO::AIO::WD object is itself a potentially blocking operation,
		1514	which is why it is done asynchronously.
		1515
		1516	To stat the directory obtained with C<aio_wd> above, one could write
		1517	either of the following three request calls:
		1518
		1519	aio_lstat "/etc" , sub { ... # pathname as normal string
		1520	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1521	aio_lstat $wd , sub { ... # shorthand for the previous
		1522
		1523	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1524	object and the pathname string, so you could write the following without
		1525	causing any issues due to C<$path> getting reused:
		1526
		1527	my $path = [$wd, undef];
		1528
		1529	for my $name (qw(abc def ghi)) {
		1530	$path->[1] = $name;
		1531	aio_stat $path, sub {
		1532	# ...
		1533	};
		1534	}
		1535
		1536	There are some caveats: when directories get renamed (or deleted), the
		1537	pathname string doesn't change, so will point to the new directory (or
		1538	nowhere at all), while the directory fd, if available on the system,
		1539	will still point to the original directory. Most functions accepting a
		1540	pathname will use the directory fd on newer systems, and the string on
		1541	older systems. Some functions (such as realpath) will always rely on the
		1542	string form of the pathname.
		1543
		1544	So this functionality is mainly useful to get some protection against
		1545	C<chdir>, to easily get an absolute path out of a relative path for future
		1546	reference, and to speed up doing many operations in the same directory
		1547	(e.g. when stat'ing all files in a directory).
		1548
		1549	The following functions implement this working directory abstraction:
		1550
		1551	=over 4
		1552
		1553	=item aio_wd $pathname, $callback->($wd)
		1554
		1555	Asynchonously canonicalise the given pathname and convert it to an
		1556	IO::AIO::WD object representing it. If possible and supported on the
		1557	system, also open a directory fd to speed up pathname resolution relative
		1558	to this working directory.
		1559
		1560	If something goes wrong, then C<undef> is passwd to the callback instead
		1561	of a working directory object and C<$!> is set appropriately. Since
		1562	passing C<undef> as working directory component of a pathname fails the
		1563	request with C<ENOENT>, there is often no need for error checking in the
		1564	C<aio_wd> callback, as future requests using the value will fail in the
		1565	expected way.
		1566
		1567	=item IO::AIO::CWD
		1568
		1569	This is a compiletime constant (object) that represents the process
		1570	current working directory.
		1571
		1572	Specifying this object as working directory object for a pathname is as if
		1573	the pathname would be specified directly, without a directory object. For
		1574	example, these calls are functionally identical:
		1575
		1576	aio_stat "somefile", sub { ... };
		1577	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1578
		1579	=back
		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.
1241		1590
1242	=head2 IO::AIO::REQ CLASS	1591	=head2 IO::AIO::REQ CLASS
1243		1592
1244	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
1245	called in non-void context.	1594	called in non-void context.
…		…
1363		1712
1364	Sets a feeder/generator on this group: every group can have an attached	1713	Sets a feeder/generator on this group: every group can have an attached
1365	generator that generates requests if idle. The idea behind this is that,	1714	generator that generates requests if idle. The idea behind this is that,
1366	although you could just queue as many requests as you want in a group,	1715	although you could just queue as many requests as you want in a group,
1367	this might starve other requests for a potentially long time. For example,	1716	this might starve other requests for a potentially long time. For example,
1368	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1717	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1369	delaying any later requests for a long time.	1718	requests, delaying any later requests for a long time.
1370		1719
1371	To avoid this, and allow incremental generation of requests, you can	1720	To avoid this, and allow incremental generation of requests, you can
1372	instead a group and set a feeder on it that generates those requests. The	1721	instead a group and set a feeder on it that generates those requests. The
1373	feed callback will be called whenever there are few enough (see C<limit>,	1722	feed callback will be called whenever there are few enough (see C<limit>,
1374	below) requests active in the group itself and is expected to queue more	1723	below) requests active in the group itself and is expected to queue more
…		…
1423		1772
1424	See C<poll_cb> for an example.	1773	See C<poll_cb> for an example.
1425		1774
1426	=item IO::AIO::poll_cb	1775	=item IO::AIO::poll_cb
1427		1776
1428	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
1429	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
1430	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
1431	reason. Returns immediately when no events are outstanding. The amount of	1783	reason. Returns immediately when no events are outstanding. The amount
1432	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>,
1433	C<IO::AIO::max_poll_time>.	1785	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1434		1786
1435	If not all requests were processed for whatever reason, the filehandle	1787	If not all requests were processed for whatever reason, the poll file
1436	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
1437	do anything special to have it called later.	1789	don't have to do anything special to have it called later.
1438		1790
1439	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
1440	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
1441	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
1442	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
…		…
1451	poll => 'r', async => 1,	1803	poll => 'r', async => 1,
1452	cb => \&IO::AIO::poll_cb);	1804	cb => \&IO::AIO::poll_cb);
1453		1805
1454	=item IO::AIO::poll_wait	1806	=item IO::AIO::poll_wait
1455		1807
1456	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
1457	phase, wait till the result filehandle becomes ready for reading (simply	1809	requests are outstanding anymore.
1458	does a C<select> on the filehandle. This is useful if you want to	1810
1459	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.
1460		1813
1461	See C<nreqs> for an example.	1814	See C<nreqs> for an example.
1462		1815
1463	=item IO::AIO::poll	1816	=item IO::AIO::poll
1464		1817
…		…
1585		1938
1586	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
1587	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
1588	use an C<aio_group> together with a feed callback.	1941	use an C<aio_group> together with a feed callback.
1589		1942
1590	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
1591	a lot of files, you can write somehting like this:	1944	a lot of files, you can write somehting like this:
1592		1945
1593	IO::AIO::max_outstanding 32;	1946	IO::AIO::max_outstanding 32;
1594		1947
1595	for my $path (...) {	1948	for my $path (...) {
…		…
1635		1988
1636	=back	1989	=back
1637		1990
1638	=head3 MISCELLANEOUS FUNCTIONS	1991	=head3 MISCELLANEOUS FUNCTIONS
1639		1992
1640	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
1641	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.
1642		1997
1643	=over 4	1998	=over 4
1644		1999
1645	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2000	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1646		2001
…		…
1653		2008
1654	=item IO::AIO::fadvise $fh, $offset, $len, $advice	2009	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1655		2010
1656	Simply calls the C<posix_fadvise> function (see its	2011	Simply calls the C<posix_fadvise> function (see its
1657	manpage for details). The following advice constants are	2012	manpage for details). The following advice constants are
1658	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	2013	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1659	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	2014	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1660	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	2015	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1661		2016
1662	On systems that do not implement C<posix_fadvise>, this function returns	2017	On systems that do not implement C<posix_fadvise>, this function returns
1663	ENOSYS, otherwise the return value of C<posix_fadvise>.	2018	ENOSYS, otherwise the return value of C<posix_fadvise>.
1664		2019
1665	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2020	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1666		2021
1667	Simply calls the C<posix_madvise> function (see its	2022	Simply calls the C<posix_madvise> function (see its
1668	manpage for details). The following advice constants are	2023	manpage for details). The following advice constants are
1669	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2024	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1670	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2025	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1671		2026
1672	On systems that do not implement C<posix_madvise>, this function returns	2027	On systems that do not implement C<posix_madvise>, this function returns
1673	ENOSYS, otherwise the return value of C<posix_madvise>.	2028	ENOSYS, otherwise the return value of C<posix_madvise>.
1674		2029
1675	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2030	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1676		2031
1677	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2032	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1678	$scalar (see its manpage for details). The following protect	2033	$scalar (see its manpage for details). The following protect
1679	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2034	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1680	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2035	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1681		2036
1682	On systems that do not implement C<mprotect>, this function returns	2037	On systems that do not implement C<mprotect>, this function returns
1683	ENOSYS, otherwise the return value of C<mprotect>.	2038	ENOSYS, otherwise the return value of C<mprotect>.
1684		2039
1685	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2040	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1686		2041
1687	Memory-maps a file (or anonymous memory range) and attaches it to the	2042	Memory-maps a file (or anonymous memory range) and attaches it to the
1688	given C<$scalar>, which will act like a string scalar.	2043	given C<$scalar>, which will act like a string scalar. Returns true on
		2044	success, and false otherwise.
1689		2045
1690	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2046	The only operations allowed on the scalar are C<substr>/C<vec> that don't
1691	change the string length, and most read-only operations such as copying it	2047	change the string length, and most read-only operations such as copying it
1692	or searching it with regexes and so on.	2048	or searching it with regexes and so on.
1693		2049
…		…
1704	filesize.	2060	filesize.
1705		2061
1706	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>,
1707	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>,
1708		2064
1709	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2065	C<$flags> can be a combination of
1710	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2066	C<IO::AIO::MAP_SHARED> or
1711	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>):
1712	(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),
1713	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2070	C<IO::AIO::MAP_LOCKED>,
1714	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2071	C<IO::AIO::MAP_NORESERVE>,
		2072	C<IO::AIO::MAP_POPULATE>,
1715	C<IO::AIO::MAP_NONBLOCK>	2073	C<IO::AIO::MAP_NONBLOCK>,
		2074	C<IO::AIO::MAP_FIXED>,
		2075	C<IO::AIO::MAP_GROWSDOWN>,
		2076	C<IO::AIO::MAP_32BIT>,
		2077	C<IO::AIO::MAP_HUGETLB> or
		2078	C<IO::AIO::MAP_STACK>.
1716		2079
1717	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2080	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1718		2081
1719	C<$offset> is the offset from the start of the file - it generally must be	2082	C<$offset> is the offset from the start of the file - it generally must be
1720	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2083	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
1745		2108
1746	Calls the C<munlockall> function.	2109	Calls the C<munlockall> function.
1747		2110
1748	On systems that do not implement C<munlockall>, this function returns	2111	On systems that do not implement C<munlockall>, this function returns
1749	ENOSYS, otherwise the return value of C<munlockall>.	2112	ENOSYS, otherwise the return value of C<munlockall>.
		2113
		2114	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2115
		2116	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2117	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2118	should be the file offset.
		2119
		2120	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2121	silently corrupt the data in this case.
		2122
		2123	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2124	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2125	C<IO::AIO::SPLICE_F_GIFT>.
		2126
		2127	See the C<splice(2)> manpage for details.
		2128
		2129	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2130
		2131	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2132	description for C<IO::AIO::splice> above for details.
		2133
		2134	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2135
		2136	Attempts to query or change the pipe buffer size. Obviously works only
		2137	on pipes, and currently works only on GNU/Linux systems, and fails with
		2138	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2139	size on other systems, drop me a note.
		2140
		2141	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2142
		2143	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2144	C<$flags> is missing or C<0>, then this should be the same as a call to
		2145	perl's built-in C<pipe> function and create a new pipe, and works on
		2146	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2147	(..., 4096, O_BINARY)>.
		2148
		2149	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2150	the given flags (Linux 2.6.27, glibc 2.9).
		2151
		2152	On success, the read and write file handles are returned.
		2153
		2154	On error, nothing will be returned. If the pipe2 syscall is missing and
		2155	C<$flags> is non-zero, fails with C<ENOSYS>.
		2156
		2157	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2158	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2159	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1750		2160
1751	=back	2161	=back
1752		2162
1753	=cut	2163	=cut
1754		2164
…		…
1792	=head2 FORK BEHAVIOUR	2202	=head2 FORK BEHAVIOUR
1793		2203
1794	Usage of pthreads in a program changes the semantics of fork	2204	Usage of pthreads in a program changes the semantics of fork
1795	considerably. Specifically, only async-safe functions can be called after	2205	considerably. Specifically, only async-safe functions can be called after
1796	fork. Perl doesn't know about this, so in general, you cannot call fork	2206	fork. Perl doesn't know about this, so in general, you cannot call fork
1797	with defined behaviour in perl. IO::AIO uses pthreads, so this applies,	2207	with defined behaviour in perl if pthreads are involved. IO::AIO uses
1798	but many other extensions and (for inexplicable reasons) perl itself often	2208	pthreads, so this applies, but many other extensions and (for inexplicable
1799	is linked against pthreads, so this limitation applies.	2209	reasons) perl itself often is linked against pthreads, so this limitation
		2210	applies to quite a lot of perls.
1800		2211
1801	Some operating systems have extensions that allow safe use of fork, and	2212	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1802	this module should do "the right thing" on those, and tries on others. At	2213	only works in the process that loaded it. Forking is fully supported, but
1803	the time of this writing (2011) only GNU/Linux supports these extensions	2214	using IO::AIO in the child is not.
1804	to POSIX.	2215
		2216	You might get around by not I<using> IO::AIO before (or after)
		2217	forking. You could also try to call the L<IO::AIO::reinit> function in the
		2218	child:
		2219
		2220	=over 4
		2221
		2222	=item IO::AIO::reinit
		2223
		2224	Abandons all current requests and I/O threads and simply reinitialises all
		2225	data structures. This is not an operation supported by any standards, but
		2226	happens to work on GNU/Linux and some newer BSD systems.
		2227
		2228	The only reasonable use for this function is to call it after forking, if
		2229	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2230	the process will result in undefined behaviour. Calling it at any time
		2231	will also result in any undefined (by POSIX) behaviour.
		2232
		2233	=back
1805		2234
1806	=head2 MEMORY USAGE	2235	=head2 MEMORY USAGE
1807		2236
1808	Per-request usage:	2237	Per-request usage:
1809		2238

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.199 by root, Wed Jun 29 12:46:36 2011 UTC vs. Revision 1.258 by root, Thu Jan 21 23:04:46 2016 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.199 by root, Wed Jun 29 12:46:36 2011 UTC vs.
Revision 1.258 by root, Thu Jan 21 23:04:46 2016 UTC