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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs.
Revision 1.284 by root, Fri Mar 23 01:14:08 2018 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.4;
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_rename2 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
		188	aio_slurp
185	aio_wd);	189	aio_wd);
186		190
187	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	191	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
188	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	192	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
189	min_parallel max_parallel max_idle idle_timeout	193	min_parallel max_parallel max_idle idle_timeout
…		…
228	aio_unlink $pathname, $callback->($status)	232	aio_unlink $pathname, $callback->($status)
229	aio_mknod $pathname, $mode, $dev, $callback->($status)	233	aio_mknod $pathname, $mode, $dev, $callback->($status)
230	aio_link $srcpath, $dstpath, $callback->($status)	234	aio_link $srcpath, $dstpath, $callback->($status)
231	aio_symlink $srcpath, $dstpath, $callback->($status)	235	aio_symlink $srcpath, $dstpath, $callback->($status)
232	aio_readlink $pathname, $callback->($link)	236	aio_readlink $pathname, $callback->($link)
233	aio_realpath $pathname, $callback->($link)	237	aio_realpath $pathname, $callback->($path)
234	aio_rename $srcpath, $dstpath, $callback->($status)	238	aio_rename $srcpath, $dstpath, $callback->($status)
		239	aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
235	aio_mkdir $pathname, $mode, $callback->($status)	240	aio_mkdir $pathname, $mode, $callback->($status)
236	aio_rmdir $pathname, $callback->($status)	241	aio_rmdir $pathname, $callback->($status)
237	aio_readdir $pathname, $callback->($entries)	242	aio_readdir $pathname, $callback->($entries)
238	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	243	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
239	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	244	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
…		…
241	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)	246	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242	aio_load $pathname, $data, $callback->($status)	247	aio_load $pathname, $data, $callback->($status)
243	aio_copy $srcpath, $dstpath, $callback->($status)	248	aio_copy $srcpath, $dstpath, $callback->($status)
244	aio_move $srcpath, $dstpath, $callback->($status)	249	aio_move $srcpath, $dstpath, $callback->($status)
245	aio_rmtree $pathname, $callback->($status)	250	aio_rmtree $pathname, $callback->($status)
		251	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		252	aio_ioctl $fh, $request, $buf, $callback->($status)
246	aio_sync $callback->($status)	253	aio_sync $callback->($status)
247	aio_syncfs $fh, $callback->($status)	254	aio_syncfs $fh, $callback->($status)
248	aio_fsync $fh, $callback->($status)	255	aio_fsync $fh, $callback->($status)
249	aio_fdatasync $fh, $callback->($status)	256	aio_fdatasync $fh, $callback->($status)
250	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	257	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
251	aio_pathsync $pathname, $callback->($status)	258	aio_pathsync $pathname, $callback->($status)
252	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	259	aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
253	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	260	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
254	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	261	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
255	aio_mlockall $flags, $callback->($status)	262	aio_mlockall $flags, $callback->($status)
256	aio_group $callback->(...)	263	aio_group $callback->(...)
257	aio_nop $callback->()	264	aio_nop $callback->()
…		…
271	IO::AIO::idle_timeout $seconds	278	IO::AIO::idle_timeout $seconds
272	IO::AIO::max_outstanding $maxreqs	279	IO::AIO::max_outstanding $maxreqs
273	IO::AIO::nreqs	280	IO::AIO::nreqs
274	IO::AIO::nready	281	IO::AIO::nready
275	IO::AIO::npending	282	IO::AIO::npending
		283	$nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
		284	IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
276		285
277	IO::AIO::sendfile $ofh, $ifh, $offset, $count	286	IO::AIO::sendfile $ofh, $ifh, $offset, $count
278	IO::AIO::fadvise $fh, $offset, $len, $advice	287	IO::AIO::fadvise $fh, $offset, $len, $advice
279	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	288	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
280	IO::AIO::munmap $scalar	289	IO::AIO::munmap $scalar
…		…
395	following POSIX and non-POSIX constants are available (missing ones on	404	following POSIX and non-POSIX constants are available (missing ones on
396	your system are, as usual, C<0>):	405	your system are, as usual, C<0>):
397		406
398	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	407	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
399	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	408	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
400	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.	409	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
401		410
402		411
403	=item aio_close $fh, $callback->($status)	412	=item aio_close $fh, $callback->($status)
404		413
405	Asynchronously close a file and call the callback with the result	414	Asynchronously close a file and call the callback with the result
…		…
440	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	449	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
441		450
442	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	451	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
443		452
444	Reads or writes C<$length> bytes from or to the specified C<$fh> and	453	Reads or writes C<$length> bytes from or to the specified C<$fh> and
445	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	454	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
446	and calls the callback without the actual number of bytes read (or -1 on	455	calls the callback with the actual number of bytes transferred (or -1 on
447	error, just like the syscall).	456	error, just like the syscall).
448		457
449	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	458	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
450	offset plus the actual number of bytes read.	459	offset plus the actual number of bytes read.
451		460
…		…
509	As native sendfile syscalls (as practically any non-POSIX interface hacked	518	As native sendfile syscalls (as practically any non-POSIX interface hacked
510	together in a hurry to improve benchmark numbers) tend to be rather buggy	519	together in a hurry to improve benchmark numbers) tend to be rather buggy
511	on many systems, this implementation tries to work around some known bugs	520	on many systems, this implementation tries to work around some known bugs
512	in Linux and FreeBSD kernels (probably others, too), but that might fail,	521	in Linux and FreeBSD kernels (probably others, too), but that might fail,
513	so you really really should check the return value of C<aio_sendfile> -	522	so you really really should check the return value of C<aio_sendfile> -
514	fewre bytes than expected might have been transferred.	523	fewer bytes than expected might have been transferred.
515		524
516		525
517	=item aio_readahead $fh,$offset,$length, $callback->($retval)	526	=item aio_readahead $fh,$offset,$length, $callback->($retval)
518		527
519	C<aio_readahead> populates the page cache with data from a file so that	528	C<aio_readahead> populates the page cache with data from a file so that
…		…
523	whole pages, so that offset is effectively rounded down to a page boundary	532	whole pages, so that offset is effectively rounded down to a page boundary
524	and bytes are read up to the next page boundary greater than or equal to	533	and bytes are read up to the next page boundary greater than or equal to
525	(off-set+length). C<aio_readahead> does not read beyond the end of the	534	(off-set+length). C<aio_readahead> does not read beyond the end of the
526	file. The current file offset of the file is left unchanged.	535	file. The current file offset of the file is left unchanged.
527		536
528	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	537	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
529	emulated by simply reading the data, which would have a similar effect.	538	be emulated by simply reading the data, which would have a similar effect.
530		539
531		540
532	=item aio_stat $fh_or_path, $callback->($status)	541	=item aio_stat $fh_or_path, $callback->($status)
533		542
534	=item aio_lstat $fh, $callback->($status)	543	=item aio_lstat $fh, $callback->($status)
…		…
603	namemax => 255,	612	namemax => 255,
604	frsize => 1024,	613	frsize => 1024,
605	fsid => 1810	614	fsid => 1810
606	}	615	}
607		616
608
609	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	617	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
610		618
611	Works like perl's C<utime> function (including the special case of $atime	619	Works like perl's C<utime> function (including the special case of $atime
612	and $mtime being undef). Fractional times are supported if the underlying	620	and $mtime being undef). Fractional times are supported if the underlying
613	syscalls support them.	621	syscalls support them.
…		…
642	Works like truncate(2) or ftruncate(2).	650	Works like truncate(2) or ftruncate(2).
643		651
644		652
645	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)	653	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
646		654
647	Allocates or freed disk space according to the C<$mode> argument. See the	655	Allocates or frees disk space according to the C<$mode> argument. See the
648	linux C<fallocate> docuemntation for details.	656	linux C<fallocate> documentation for details.
649		657
650	C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>	658	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
651	to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \|	659	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
652	IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.	660	to deallocate a file range.
		661
		662	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		663	(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
		664	C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
		665	to unshare shared blocks (see your L<fallocate(2)> manpage).
653		666
654	The file system block size used by C<fallocate> is presumably the	667	The file system block size used by C<fallocate> is presumably the
655	C<f_bsize> returned by C<statvfs>.	668	C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
		669	can dictate other limitations.
656		670
657	If C<fallocate> isn't available or cannot be emulated (currently no	671	If C<fallocate> isn't available or cannot be emulated (currently no
658	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.	672	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
659		673
660		674
…		…
702		716
703		717
704	=item aio_realpath $pathname, $callback->($path)	718	=item aio_realpath $pathname, $callback->($path)
705		719
706	Asynchronously make the path absolute and resolve any symlinks in	720	Asynchronously make the path absolute and resolve any symlinks in
707	C<$path>. The resulting path only consists of directories (Same as	721	C<$path>. The resulting path only consists of directories (same as
708	L<Cwd::realpath>).	722	L<Cwd::realpath>).
709		723
710	This request can be used to get the absolute path of the current working	724	This request can be used to get the absolute path of the current working
711	directory by passing it a path of F<.> (a single dot).	725	directory by passing it a path of F<.> (a single dot).
712		726
713		727
714	=item aio_rename $srcpath, $dstpath, $callback->($status)	728	=item aio_rename $srcpath, $dstpath, $callback->($status)
715		729
716	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	730	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
717	rename(2) and call the callback with the result code.	731	rename(2) and call the callback with the result code.
		732
		733	On systems that support the AIO::WD working directory abstraction
		734	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		735	of failing, C<rename> is called on the absolute path of C<$wd>.
		736
		737
		738	=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
		739
		740	Basically a version of C<aio_rename> with an additional C<$flags>
		741	argument. Calling this with C<$flags=0> is the same as calling
		742	C<aio_rename>.
		743
		744	Non-zero flags are currently only supported on GNU/Linux systems that
		745	support renameat2. Other systems fail with C<ENOSYS> in this case.
		746
		747	The following constants are available (missing ones are, as usual C<0>),
		748	see renameat2(2) for details:
		749
		750	C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
		751	and C<IO::AIO::RENAME_WHITEOUT>.
718		752
719		753
720	=item aio_mkdir $pathname, $mode, $callback->($status)	754	=item aio_mkdir $pathname, $mode, $callback->($status)
721		755
722	Asynchronously mkdir (create) a directory and call the callback with	756	Asynchronously mkdir (create) a directory and call the callback with
…		…
727	=item aio_rmdir $pathname, $callback->($status)	761	=item aio_rmdir $pathname, $callback->($status)
728		762
729	Asynchronously rmdir (delete) a directory and call the callback with the	763	Asynchronously rmdir (delete) a directory and call the callback with the
730	result code.	764	result code.
731		765
		766	On systems that support the AIO::WD working directory abstraction
		767	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		768	C<rmdir> is called on the absolute path of C<$wd>.
		769
732		770
733	=item aio_readdir $pathname, $callback->($entries)	771	=item aio_readdir $pathname, $callback->($entries)
734		772
735	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	773	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
736	directory (i.e. opendir + readdir + closedir). The entries will not be	774	directory (i.e. opendir + readdir + closedir). The entries will not be
…		…
751		789
752	=over 4	790	=over 4
753		791
754	=item IO::AIO::READDIR_DENTS	792	=item IO::AIO::READDIR_DENTS
755		793
756	When this flag is off, then the callback gets an arrayref consisting of	794	Normally the callback gets an arrayref consisting of names only (as
757	names only (as with C<aio_readdir>), otherwise it gets an arrayref with	795	with C<aio_readdir>). If this flag is set, then the callback gets an
758	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	796	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
759	entry in more detail.	797	single directory entry in more detail:
760		798
761	C<$name> is the name of the entry.	799	C<$name> is the name of the entry.
762		800
763	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	801	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
764		802
765	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	803	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
766	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,	804	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
767	C<IO::AIO::DT_WHT>.	805	C<IO::AIO::DT_WHT>.
768		806
769	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	807	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
770	know, you have to run stat yourself. Also, for speed reasons, the C<$type>	808	to know, you have to run stat yourself. Also, for speed/memory reasons,
771	scalars are read-only: you can not modify them.	809	the C<$type> scalars are read-only: you must not modify them.
772		810
773	C<$inode> is the inode number (which might not be exact on systems with 64	811	C<$inode> is the inode number (which might not be exact on systems with 64
774	bit inode numbers and 32 bit perls). This field has unspecified content on	812	bit inode numbers and 32 bit perls). This field has unspecified content on
775	systems that do not deliver the inode information.	813	systems that do not deliver the inode information.
776		814
…		…
787	short names are tried first.	825	short names are tried first.
788		826
789	=item IO::AIO::READDIR_STAT_ORDER	827	=item IO::AIO::READDIR_STAT_ORDER
790		828
791	When this flag is set, then the names will be returned in an order	829	When this flag is set, then the names will be returned in an order
792	suitable for stat()'ing each one. That is, when you plan to stat()	830	suitable for stat()'ing each one. That is, when you plan to stat() most or
793	all files in the given directory, then the returned order will likely	831	all files in the given directory, then the returned order will likely be
794	be fastest.	832	faster.
795		833
796	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	834	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
797	the likely dirs come first, resulting in a less optimal stat order.	835	then the likely dirs come first, resulting in a less optimal stat order
		836	for stat'ing all entries, but likely a more optimal order for finding
		837	subdirectories.
798		838
799	=item IO::AIO::READDIR_FOUND_UNKNOWN	839	=item IO::AIO::READDIR_FOUND_UNKNOWN
800		840
801	This flag should not be set when calling C<aio_readdirx>. Instead, it	841	This flag should not be set when calling C<aio_readdirx>. Instead, it
802	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	842	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
804	C<$type>'s are known, which can be used to speed up some algorithms.	844	C<$type>'s are known, which can be used to speed up some algorithms.
805		845
806	=back	846	=back
807		847
808		848
		849	=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
		850
		851	Opens, reads and closes the given file. The data is put into C<$data>,
		852	which is resized as required.
		853
		854	If C<$offset> is negative, then it is counted from the end of the file.
		855
		856	If C<$length> is zero, then the remaining length of the file is
		857	used. Also, in this case, the same limitations to modifying C<$data> apply
		858	as when IO::AIO::mmap is used, i.e. it must only be modified in-place
		859	with C<substr>. If the size of the file is known, specifying a non-zero
		860	C<$length> results in a performance advantage.
		861
		862	This request is similar to the older C<aio_load> request, but since it is
		863	a single request, it might be more efficient to use.
		864
		865	Example: load F</etc/passwd> into C<$passwd>.
		866
		867	my $passwd;
		868	aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
		869	$_[0] >= 0
		870	or die "/etc/passwd: $!\n";
		871
		872	printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
		873	print $passwd;
		874	};
		875	IO::AIO::flush;
		876
		877
809	=item aio_load $pathname, $data, $callback->($status)	878	=item aio_load $pathname, $data, $callback->($status)
810		879
811	This is a composite request that tries to fully load the given file into	880	This is a composite request that tries to fully load the given file into
812	memory. Status is the same as with aio_read.	881	memory. Status is the same as with aio_read.
		882
		883	Using C<aio_slurp> might be more efficient, as it is a single request.
813		884
814	=cut	885	=cut
815		886
816	sub aio_load($$;$) {	887	sub aio_load($$;$) {
817	my ($path, undef, $cb) = @_;	888	my ($path, undef, $cb) = @_;
…		…
837	=item aio_copy $srcpath, $dstpath, $callback->($status)	908	=item aio_copy $srcpath, $dstpath, $callback->($status)
838		909
839	Try to copy the I<file> (directories not supported as either source or	910	Try to copy the I<file> (directories not supported as either source or
840	destination) from C<$srcpath> to C<$dstpath> and call the callback with	911	destination) from C<$srcpath> to C<$dstpath> and call the callback with
841	a status of C<0> (ok) or C<-1> (error, see C<$!>).	912	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		913
		914	Existing destination files will be truncated.
842		915
843	This is a composite request that creates the destination file with	916	This is a composite request that creates the destination file with
844	mode 0200 and copies the contents of the source file into it using	917	mode 0200 and copies the contents of the source file into it using
845	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	918	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
846	uid/gid, in that order.	919	uid/gid, in that order.
…		…
956	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1029	Scans a directory (similar to C<aio_readdir>) but additionally tries to
957	efficiently separate the entries of directory C<$path> into two sets of	1030	efficiently separate the entries of directory C<$path> into two sets of
958	names, directories you can recurse into (directories), and ones you cannot	1031	names, directories you can recurse into (directories), and ones you cannot
959	recurse into (everything else, including symlinks to directories).	1032	recurse into (everything else, including symlinks to directories).
960		1033
961	C<aio_scandir> is a composite request that creates of many sub requests_	1034	C<aio_scandir> is a composite request that generates many sub requests.
962	C<$maxreq> specifies the maximum number of outstanding aio requests that	1035	C<$maxreq> specifies the maximum number of outstanding aio requests that
963	this function generates. If it is C<< <= 0 >>, then a suitable default	1036	this function generates. If it is C<< <= 0 >>, then a suitable default
964	will be chosen (currently 4).	1037	will be chosen (currently 4).
965		1038
966	On error, the callback is called without arguments, otherwise it receives	1039	On error, the callback is called without arguments, otherwise it receives
…		…
1100	}	1173	}
1101		1174
1102	=item aio_rmtree $pathname, $callback->($status)	1175	=item aio_rmtree $pathname, $callback->($status)
1103		1176
1104	Delete a directory tree starting (and including) C<$path>, return the	1177	Delete a directory tree starting (and including) C<$path>, return the
1105	status of the final C<rmdir> only. This is a composite request that	1178	status of the final C<rmdir> only. This is a composite request that
1106	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1179	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1107	everything else.	1180	everything else.
1108		1181
1109	=cut	1182	=cut
1110		1183
…		…
1131	add $grp $dirgrp;	1204	add $grp $dirgrp;
1132	};	1205	};
1133		1206
1134	$grp	1207	$grp
1135	}	1208	}
		1209
		1210	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1211
		1212	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1213
		1214	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1215	they execute asynchronously and pass the return value to the callback.
		1216
		1217	Both calls can be used for a lot of things, some of which make more sense
		1218	to run asynchronously in their own thread, while some others make less
		1219	sense. For example, calls that block waiting for external events, such
		1220	as locking, will also lock down an I/O thread while it is waiting, which
		1221	can deadlock the whole I/O system. At the same time, there might be no
		1222	alternative to using a thread to wait.
		1223
		1224	So in general, you should only use these calls for things that do
		1225	(filesystem) I/O, not for things that wait for other events (network,
		1226	other processes), although if you are careful and know what you are doing,
		1227	you still can.
		1228
		1229	The following constants are available (missing ones are, as usual C<0>):
		1230
		1231	C<F_DUPFD_CLOEXEC>,
		1232
		1233	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
		1234
		1235	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1236
		1237	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1238	C<FS_IOC_FIEMAP>.
		1239
		1240	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1241	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1242
		1243	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1244	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1245	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1246	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1247	C<FS_FL_USER_MODIFIABLE>.
		1248
		1249	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1250	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1251	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1252	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1136		1253
1137	=item aio_sync $callback->($status)	1254	=item aio_sync $callback->($status)
1138		1255
1139	Asynchronously call sync and call the callback when finished.	1256	Asynchronously call sync and call the callback when finished.
1140		1257
…		…
1209	};	1326	};
1210		1327
1211	$grp	1328	$grp
1212	}	1329	}
1213		1330
1214	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1331	=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1215		1332
1216	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1333	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1217	scalars (see the C<IO::AIO::mmap> function, although it also works on data	1334	scalars (see the C<IO::AIO::mmap> function, although it also works on data
1218	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the	1335	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1219	scalar must only be modified in-place while an aio operation is pending on	1336	scalar must only be modified in-place while an aio operation is pending on
…		…
1221		1338
1222	It calls the C<msync> function of your OS, if available, with the memory	1339	It calls the C<msync> function of your OS, if available, with the memory
1223	area starting at C<$offset> in the string and ending C<$length> bytes	1340	area starting at C<$offset> in the string and ending C<$length> bytes
1224	later. If C<$length> is negative, counts from the end, and if C<$length>	1341	later. If C<$length> is negative, counts from the end, and if C<$length>
1225	is C<undef>, then it goes till the end of the string. The flags can be	1342	is C<undef>, then it goes till the end of the string. The flags can be
1226	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and	1343	either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1227	C<IO::AIO::MS_SYNC>.	1344	C<IO::AIO::MS_INVALIDATE>.
1228		1345
1229	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1346	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1230		1347
1231	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1348	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1232	scalars.	1349	scalars.
1233		1350
1234	It touches (reads or writes) all memory pages in the specified	1351	It touches (reads or writes) all memory pages in the specified
1235	range inside the scalar. All caveats and parameters are the same	1352	range inside the scalar. All caveats and parameters are the same
1236	as for C<aio_msync>, above, except for flags, which must be either	1353	as for C<aio_msync>, above, except for flags, which must be either
1237	C<0> (which reads all pages and ensures they are instantiated) or	1354	C<0> (which reads all pages and ensures they are instantiated) or
1238	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1355	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1239	writing an octet from it, which dirties the page).	1356	writing an octet from it, which dirties the page).
1240		1357
1241	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1358	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1242		1359
1243	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1360	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1277		1394
1278	aio_mlockall IO::AIO::MCL_FUTURE;	1395	aio_mlockall IO::AIO::MCL_FUTURE;
1279		1396
1280	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)	1397	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1281		1398
1282	Queries the extents of the given file (by calling the Linux FIEMAP ioctl,	1399	Queries the extents of the given file (by calling the Linux C<FIEMAP>
1283	see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the	1400	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1284	C<ioctl> is not available on your OS, then this request will fail with	1401	the ioctl is not available on your OS, then this request will fail with
1285	C<ENOSYS>.	1402	C<ENOSYS>.
1286		1403
1287	C<$start> is the starting offset to query extents for, C<$length> is the	1404	C<$start> is the starting offset to query extents for, C<$length> is the
1288	size of the range to query - if it is C<undef>, then the whole file will	1405	size of the range to query - if it is C<undef>, then the whole file will
1289	be queried.	1406	be queried.
…		…
1315	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1432	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1316	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1433	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1317	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1434	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1318	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1435	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1319		1436
1320	At the time of this writing (Linux 3.2), this requets is unreliable unless	1437	At the time of this writing (Linux 3.2), this request is unreliable unless
1321	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing	1438	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1322	it to return all extents of a range for files with large number of	1439	it to return all extents of a range for files with a large number of
1323	extents. The code works around all these issues if C<$count> is undef.	1440	extents. The code (only) works around all these issues if C<$count> is
		1441	C<undef>.
1324		1442
1325	=item aio_group $callback->(...)	1443	=item aio_group $callback->(...)
1326		1444
1327	This is a very special aio request: Instead of doing something, it is a	1445	This is a very special aio request: Instead of doing something, it is a
1328	container for other aio requests, which is useful if you want to bundle	1446	container for other aio requests, which is useful if you want to bundle
…		…
1412	aio_stat [$etcdir, "passwd"], sub {	1530	aio_stat [$etcdir, "passwd"], sub {
1413	# yay	1531	# yay
1414	};	1532	};
1415	};	1533	};
1416		1534
1417	That C<aio_wd> is a request and not a normal function shows that creating	1535	The fact that C<aio_wd> is a request and not a normal function shows that
1418	an IO::AIO::WD object is itself a potentially blocking operation, which is	1536	creating an IO::AIO::WD object is itself a potentially blocking operation,
1419	why it is done asynchronously.	1537	which is why it is done asynchronously.
1420		1538
1421	To stat the directory obtained with C<aio_wd> above, one could write	1539	To stat the directory obtained with C<aio_wd> above, one could write
1422	either of the following three request calls:	1540	either of the following three request calls:
1423		1541
1424	aio_lstat "/etc" , sub { ... # pathname as normal string	1542	aio_lstat "/etc" , sub { ... # pathname as normal string
…		…
1441	There are some caveats: when directories get renamed (or deleted), the	1559	There are some caveats: when directories get renamed (or deleted), the
1442	pathname string doesn't change, so will point to the new directory (or	1560	pathname string doesn't change, so will point to the new directory (or
1443	nowhere at all), while the directory fd, if available on the system,	1561	nowhere at all), while the directory fd, if available on the system,
1444	will still point to the original directory. Most functions accepting a	1562	will still point to the original directory. Most functions accepting a
1445	pathname will use the directory fd on newer systems, and the string on	1563	pathname will use the directory fd on newer systems, and the string on
1446	older systems. Some functions (such as realpath) will always rely on the	1564	older systems. Some functions (such as C<aio_realpath>) will always rely on
1447	string form of the pathname.	1565	the string form of the pathname.
1448		1566
1449	So this fucntionality is mainly useful to get some protection against	1567	So this functionality is mainly useful to get some protection against
1450	C<chdir>, to easily get an absolute path out of a relative path for future	1568	C<chdir>, to easily get an absolute path out of a relative path for future
1451	reference, and to speed up doing many operations in the same directory	1569	reference, and to speed up doing many operations in the same directory
1452	(e.g. when stat'ing all files in a directory).	1570	(e.g. when stat'ing all files in a directory).
1453		1571
1454	The following functions implement this working directory abstraction:	1572	The following functions implement this working directory abstraction:
…		…
1467	passing C<undef> as working directory component of a pathname fails the	1585	passing C<undef> as working directory component of a pathname fails the
1468	request with C<ENOENT>, there is often no need for error checking in the	1586	request with C<ENOENT>, there is often no need for error checking in the
1469	C<aio_wd> callback, as future requests using the value will fail in the	1587	C<aio_wd> callback, as future requests using the value will fail in the
1470	expected way.	1588	expected way.
1471		1589
1472	If this call isn't available because your OS lacks it or it couldn't be
1473	detected, it will be emulated by calling C<fsync> instead.
1474
1475	=item IO::AIO::CWD	1590	=item IO::AIO::CWD
1476		1591
1477	This is a compiletime constant (object) that represents the process	1592	This is a compiletime constant (object) that represents the process
1478	current working directory.	1593	current working directory.
1479		1594
1480	Specifying this object as working directory object for a pathname is as	1595	Specifying this object as working directory object for a pathname is as if
1481	if the pathname would be specified directly, without a directory object,	1596	the pathname would be specified directly, without a directory object. For
1482	e.g., these calls are functionally identical:	1597	example, these calls are functionally identical:
1483		1598
1484	aio_stat "somefile", sub { ... };	1599	aio_stat "somefile", sub { ... };
1485	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };	1600	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1486		1601
1487	=back	1602	=back
1488		1603
		1604	To recover the path associated with an IO::AIO::WD object, you can use
		1605	C<aio_realpath>:
		1606
		1607	aio_realpath $wd, sub {
		1608	warn "path is $_[0]\n";
		1609	};
		1610
		1611	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1612	sometimes, fall back to using an absolue path.
1489		1613
1490	=head2 IO::AIO::REQ CLASS	1614	=head2 IO::AIO::REQ CLASS
1491		1615
1492	All non-aggregate C<aio_*> functions return an object of this class when	1616	All non-aggregate C<aio_*> functions return an object of this class when
1493	called in non-void context.	1617	called in non-void context.
…		…
1671		1795
1672	See C<poll_cb> for an example.	1796	See C<poll_cb> for an example.
1673		1797
1674	=item IO::AIO::poll_cb	1798	=item IO::AIO::poll_cb
1675		1799
1676	Process some outstanding events on the result pipe. You have to call	1800	Process some requests that have reached the result phase (i.e. they have
		1801	been executed but the results are not yet reported). You have to call
		1802	this "regularly" to finish outstanding requests.
		1803
1677	this regularly. Returns C<0> if all events could be processed (or there	1804	Returns C<0> if all events could be processed (or there were no
1678	were no events to process), or C<-1> if it returned earlier for whatever	1805	events to process), or C<-1> if it returned earlier for whatever
1679	reason. Returns immediately when no events are outstanding. The amount of	1806	reason. Returns immediately when no events are outstanding. The amount
1680	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1807	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1681	C<IO::AIO::max_poll_time>.	1808	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1682		1809
1683	If not all requests were processed for whatever reason, the filehandle	1810	If not all requests were processed for whatever reason, the poll file
1684	will still be ready when C<poll_cb> returns, so normally you don't have to	1811	descriptor will still be ready when C<poll_cb> returns, so normally you
1685	do anything special to have it called later.	1812	don't have to do anything special to have it called later.
1686		1813
1687	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1814	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1688	ready, it can be beneficial to call this function from loops which submit	1815	ready, it can be beneficial to call this function from loops which submit
1689	a lot of requests, to make sure the results get processed when they become	1816	a lot of requests, to make sure the results get processed when they become
1690	available and not just when the loop is finished and the event loop takes	1817	available and not just when the loop is finished and the event loop takes
…		…
1699	poll => 'r', async => 1,	1826	poll => 'r', async => 1,
1700	cb => \&IO::AIO::poll_cb);	1827	cb => \&IO::AIO::poll_cb);
1701		1828
1702	=item IO::AIO::poll_wait	1829	=item IO::AIO::poll_wait
1703		1830
1704	If there are any outstanding requests and none of them in the result	1831	Wait until either at least one request is in the result phase or no
1705	phase, wait till the result filehandle becomes ready for reading (simply	1832	requests are outstanding anymore.
1706	does a C<select> on the filehandle. This is useful if you want to	1833
1707	synchronously wait for some requests to finish).	1834	This is useful if you want to synchronously wait for some requests to
		1835	become ready, without actually handling them.
1708		1836
1709	See C<nreqs> for an example.	1837	See C<nreqs> for an example.
1710		1838
1711	=item IO::AIO::poll	1839	=item IO::AIO::poll
1712		1840
…		…
1833		1961
1834	This is a very bad function to use in interactive programs because it	1962	This is a very bad function to use in interactive programs because it
1835	blocks, and a bad way to reduce concurrency because it is inexact: Better	1963	blocks, and a bad way to reduce concurrency because it is inexact: Better
1836	use an C<aio_group> together with a feed callback.	1964	use an C<aio_group> together with a feed callback.
1837		1965
1838	It's main use is in scripts without an event loop - when you want to stat	1966	Its main use is in scripts without an event loop - when you want to stat
1839	a lot of files, you can write somehting like this:	1967	a lot of files, you can write something like this:
1840		1968
1841	IO::AIO::max_outstanding 32;	1969	IO::AIO::max_outstanding 32;
1842		1970
1843	for my $path (...) {	1971	for my $path (...) {
1844	aio_stat $path , ...;	1972	aio_stat $path , ...;
…		…
1883		2011
1884	=back	2012	=back
1885		2013
1886	=head3 MISCELLANEOUS FUNCTIONS	2014	=head3 MISCELLANEOUS FUNCTIONS
1887		2015
1888	IO::AIO implements some functions that might be useful, but are not	2016	IO::AIO implements some functions that are useful when you want to use
1889	asynchronous.	2017	some "Advanced I/O" function not available to in Perl, without going the
		2018	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2019	counterpart.
1890		2020
1891	=over 4	2021	=over 4
		2022
		2023	=item $numfd = IO::AIO::get_fdlimit
		2024
		2025	This function is I<EXPERIMENTAL> and subject to change.
		2026
		2027	Tries to find the current file descriptor limit and returns it, or
		2028	C<undef> and sets C<$!> in case of an error. The limit is one larger than
		2029	the highest valid file descriptor number.
		2030
		2031	=item IO::AIO::min_fdlimit [$numfd]
		2032
		2033	This function is I<EXPERIMENTAL> and subject to change.
		2034
		2035	Try to increase the current file descriptor limit(s) to at least C<$numfd>
		2036	by changing the soft or hard file descriptor resource limit. If C<$numfd>
		2037	is missing, it will try to set a very high limit, although this is not
		2038	recommended when you know the actual minimum that you require.
		2039
		2040	If the limit cannot be raised enough, the function makes a best-effort
		2041	attempt to increase the limit as much as possible, using various
		2042	tricks, while still failing. You can query the resulting limit using
		2043	C<IO::AIO::get_fdlimit>.
		2044
		2045	If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
		2046	true.
1892		2047
1893	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2048	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1894		2049
1895	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,	2050	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1896	but is blocking (this makes most sense if you know the input data is	2051	but is blocking (this makes most sense if you know the input data is
…		…
1913	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2068	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1914		2069
1915	Simply calls the C<posix_madvise> function (see its	2070	Simply calls the C<posix_madvise> function (see its
1916	manpage for details). The following advice constants are	2071	manpage for details). The following advice constants are
1917	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2072	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1918	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2073	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
		2074	C<IO::AIO::MADV_DONTNEED>.
		2075
		2076	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2077	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2078	will be reduced to fit into the C<$scalar>.
1919		2079
1920	On systems that do not implement C<posix_madvise>, this function returns	2080	On systems that do not implement C<posix_madvise>, this function returns
1921	ENOSYS, otherwise the return value of C<posix_madvise>.	2081	ENOSYS, otherwise the return value of C<posix_madvise>.
1922		2082
1923	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2083	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
1925	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2085	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1926	$scalar (see its manpage for details). The following protect	2086	$scalar (see its manpage for details). The following protect
1927	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2087	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1928	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2088	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1929		2089
		2090	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2091	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2092	will be reduced to fit into the C<$scalar>.
		2093
1930	On systems that do not implement C<mprotect>, this function returns	2094	On systems that do not implement C<mprotect>, this function returns
1931	ENOSYS, otherwise the return value of C<mprotect>.	2095	ENOSYS, otherwise the return value of C<mprotect>.
1932		2096
1933	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2097	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1934		2098
1935	Memory-maps a file (or anonymous memory range) and attaches it to the	2099	Memory-maps a file (or anonymous memory range) and attaches it to the
1936	given C<$scalar>, which will act like a string scalar. Returns true on	2100	given C<$scalar>, which will act like a string scalar. Returns true on
1937	success, and false otherwise.	2101	success, and false otherwise.
1938		2102
		2103	The scalar must exist, but its contents do not matter - this means you
		2104	cannot use a nonexistant array or hash element. When in doubt, C<undef>
		2105	the scalar first.
		2106
1939	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2107	The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1940	change the string length, and most read-only operations such as copying it	2108	which don't change the string length, and most read-only operations such
1941	or searching it with regexes and so on.	2109	as copying it or searching it with regexes and so on.
1942		2110
1943	Anything else is unsafe and will, at best, result in memory leaks.	2111	Anything else is unsafe and will, at best, result in memory leaks.
1944		2112
1945	The memory map associated with the C<$scalar> is automatically removed	2113	The memory map associated with the C<$scalar> is automatically removed
1946	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or	2114	when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1947	C<IO::AIO::munmap> functions are called.	2115	or C<IO::AIO::munmap> functions are called on it.
1948		2116
1949	This calls the C<mmap>(2) function internally. See your system's manual	2117	This calls the C<mmap>(2) function internally. See your system's manual
1950	page for details on the C<$length>, C<$prot> and C<$flags> parameters.	2118	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1951		2119
1952	The C<$length> must be larger than zero and smaller than the actual	2120	The C<$length> must be larger than zero and smaller than the actual
1953	filesize.	2121	filesize.
1954		2122
1955	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2123	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1956	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2124	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1957		2125
1958	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2126	C<$flags> can be a combination of
1959	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2127	C<IO::AIO::MAP_SHARED> or
1960	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2128	C<IO::AIO::MAP_PRIVATE>,
		2129	or a number of system-specific flags (when not available, the are C<0>):
1961	(which is set to C<MAP_ANON> if your system only provides this	2130	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1962	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2131	C<IO::AIO::MAP_LOCKED>,
1963	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2132	C<IO::AIO::MAP_NORESERVE>,
		2133	C<IO::AIO::MAP_POPULATE>,
1964	C<IO::AIO::MAP_NONBLOCK>	2134	C<IO::AIO::MAP_NONBLOCK>,
		2135	C<IO::AIO::MAP_FIXED>,
		2136	C<IO::AIO::MAP_GROWSDOWN>,
		2137	C<IO::AIO::MAP_32BIT>,
		2138	C<IO::AIO::MAP_HUGETLB> or
		2139	C<IO::AIO::MAP_STACK>.
1965		2140
1966	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2141	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1967		2142
1968	C<$offset> is the offset from the start of the file - it generally must be	2143	C<$offset> is the offset from the start of the file - it generally must be
1969	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2144	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
2012		2187
2013	See the C<splice(2)> manpage for details.	2188	See the C<splice(2)> manpage for details.
2014		2189
2015	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags	2190	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2016		2191
2017	Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the	2192	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2018	description for C<IO::AIO::splice> above for details.	2193	description for C<IO::AIO::splice> above for details.
		2194
		2195	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2196
		2197	Attempts to query or change the pipe buffer size. Obviously works only
		2198	on pipes, and currently works only on GNU/Linux systems, and fails with
		2199	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2200	size on other systems, drop me a note.
		2201
		2202	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2203
		2204	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2205	C<$flags> is missing or C<0>, then this should be the same as a call to
		2206	perl's built-in C<pipe> function and create a new pipe, and works on
		2207	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2208	(..., 4096, O_BINARY)>.
		2209
		2210	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2211	the given flags (Linux 2.6.27, glibc 2.9).
		2212
		2213	On success, the read and write file handles are returned.
		2214
		2215	On error, nothing will be returned. If the pipe2 syscall is missing and
		2216	C<$flags> is non-zero, fails with C<ENOSYS>.
		2217
		2218	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2219	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2220	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2221
		2222	Example: create a pipe race-free w.r.t. threads and fork:
		2223
		2224	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
		2225	or die "pipe2: $!\n";
		2226
		2227	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
		2228
		2229	This is a direct interface to the Linux L<eventfd(2)> system call. The
		2230	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
		2231
		2232	On success, the new eventfd filehandle is returned, otherwise returns
		2233	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2234
		2235	Please refer to L<eventfd(2)> for more info on this call.
		2236
		2237	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
		2238	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2239
		2240	Example: create a new eventfd filehandle:
		2241
		2242	$fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
		2243	or die "eventfd: $!\n";
		2244
		2245	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2246
		2247	This is a direct interface to the Linux L<timerfd_create(2)> system call. The
		2248	(unhelpful) default for C<$flags> is C<0>.
		2249
		2250	On success, the new timerfd filehandle is returned, otherwise returns
		2251	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2252
		2253	Please refer to L<timerfd_create(2)> for more info on this call.
		2254
		2255	The following C<$clockid> values are
		2256	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2257	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2258	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2259	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2260
		2261	The following C<$flags> values are available (Linux
		2262	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2263
		2264	Example: create a new timerfd and set it to one-second repeated alarms,
		2265	then wait for two alarms:
		2266
		2267	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2268	or die "timerfd_create: $!\n";
		2269
		2270	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2271	or die "timerfd_settime: $!\n";
		2272
		2273	for (1..2) {
		2274	8 == sysread $fh, my $buf, 8
		2275	or die "timerfd read failure\n";
		2276
		2277	printf "number of expirations (likely 1): %d\n",
		2278	unpack "Q", $buf;
		2279	}
		2280
		2281	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2282
		2283	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2284	call. Please refer to its manpage for more info on this call.
		2285
		2286	The new itimerspec is specified using two (possibly fractional) second
		2287	values, C<$new_interval> and C<$new_value>).
		2288
		2289	On success, the current interval and value are returned (as per
		2290	C<timerfd_gettime>). On failure, the empty list is returned.
		2291
		2292	The following C<$flags> values are
		2293	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2294	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2295
		2296	See C<IO::AIO::timerfd_create> for a full example.
		2297
		2298	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2299
		2300	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2301	call. Please refer to its manpage for more info on this call.
		2302
		2303	On success, returns the current values of interval and value for the given
		2304	timerfd (as potentially fractional second values). On failure, the empty
		2305	list is returned.
2019		2306
2020	=back	2307	=back
2021		2308
2022	=cut	2309	=cut
2023		2310
…		…
2089	the process will result in undefined behaviour. Calling it at any time	2376	the process will result in undefined behaviour. Calling it at any time
2090	will also result in any undefined (by POSIX) behaviour.	2377	will also result in any undefined (by POSIX) behaviour.
2091		2378
2092	=back	2379	=back
2093		2380
		2381	=head2 LINUX-SPECIFIC CALLS
		2382
		2383	When a call is documented as "linux-specific" then this means it
		2384	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2385	availability and compatibility of such calls regardless of the platform
		2386	it is compiled on, so platforms such as FreeBSD which often implement
		2387	these calls will work. When in doubt, call them and see if they fail wth
		2388	C<ENOSYS>.
		2389
2094	=head2 MEMORY USAGE	2390	=head2 MEMORY USAGE
2095		2391
2096	Per-request usage:	2392	Per-request usage:
2097		2393
2098	Each aio request uses - depending on your architecture - around 100-200	2394	Each aio request uses - depending on your architecture - around 100-200
…		…
2110	temporary buffers, and each thread requires a stack and other data	2406	temporary buffers, and each thread requires a stack and other data
2111	structures (usually around 16k-128k, depending on the OS).	2407	structures (usually around 16k-128k, depending on the OS).
2112		2408
2113	=head1 KNOWN BUGS	2409	=head1 KNOWN BUGS
2114		2410
2115	Known bugs will be fixed in the next release.	2411	Known bugs will be fixed in the next release :)
		2412
		2413	=head1 KNOWN ISSUES
		2414
		2415	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2416	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2417	non-created hash slots or other scalars I didn't think of. It's best to
		2418	avoid such and either use scalar variables or making sure that the scalar
		2419	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2420
		2421	I am not sure anything can be done about this, so this is considered a
		2422	known issue, rather than a bug.
2116		2423
2117	=head1 SEE ALSO	2424	=head1 SEE ALSO
2118		2425
2119	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2426	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2120	more natural syntax.	2427	more natural syntax.

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs. Revision 1.284 by root, Fri Mar 23 01:14:08 2018 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.233 by root, Mon Aug 13 01:01:04 2012 UTC vs.
Revision 1.284 by root, Fri Mar 23 01:14:08 2018 UTC