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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.185 by root, Sat Dec 11 19:06:07 2010 UTC vs.
Revision 1.269 by root, Tue Jun 6 04:29:35 2017 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 = '3.7';	176	our $VERSION = 4.35;
174		177
175	our @AIO_REQ = qw(aio_sendfile 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_sync aio_fsync	180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178	aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead	181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
		182	aio_pathsync aio_readahead aio_fiemap aio_allocate
179	aio_rename aio_link aio_move aio_copy aio_group	183	aio_rename aio_link aio_move aio_copy aio_group
180	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
181	aio_chmod aio_utime aio_truncate	185	aio_chmod aio_utime aio_truncate
182	aio_msync aio_mtouch aio_mlock aio_mlockall	186	aio_msync aio_mtouch aio_mlock aio_mlockall
183	aio_statvfs);	187	aio_statvfs
		188	aio_wd);
184		189
185	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	190	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
186	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	191	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
187	min_parallel max_parallel max_idle	192	min_parallel max_parallel max_idle idle_timeout
188	nreqs nready npending nthreads	193	nreqs nready npending nthreads
189	max_poll_time max_poll_reqs	194	max_poll_time max_poll_reqs
190	sendfile fadvise madvise	195	sendfile fadvise madvise
191	mmap munmap munlock munlockall);	196	mmap munmap munlock munlockall);
192		197
…		…
200		205
201	=head1 FUNCTIONS	206	=head1 FUNCTIONS
202		207
203	=head2 QUICK OVERVIEW	208	=head2 QUICK OVERVIEW
204		209
205	This section simply lists the prototypes of the most important functions	210	This section simply lists the prototypes most of the functions for
206	for quick reference. See the following sections for function-by-function	211	quick reference. See the following sections for function-by-function
207	documentation.	212	documentation.
208		213
		214	aio_wd $pathname, $callback->($wd)
209	aio_open $pathname, $flags, $mode, $callback->($fh)	215	aio_open $pathname, $flags, $mode, $callback->($fh)
210	aio_close $fh, $callback->($status)	216	aio_close $fh, $callback->($status)
		217	aio_seek $fh,$offset,$whence, $callback->($offs)
211	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	218	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
212	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	219	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	220	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
214	aio_readahead $fh,$offset,$length, $callback->($retval)	221	aio_readahead $fh,$offset,$length, $callback->($retval)
215	aio_stat $fh_or_path, $callback->($status)	222	aio_stat $fh_or_path, $callback->($status)
216	aio_lstat $fh, $callback->($status)	223	aio_lstat $fh, $callback->($status)
217	aio_statvfs $fh_or_path, $callback->($statvfs)	224	aio_statvfs $fh_or_path, $callback->($statvfs)
218	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	225	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
219	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	226	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		227	aio_chmod $fh_or_path, $mode, $callback->($status)
220	aio_truncate $fh_or_path, $offset, $callback->($status)	228	aio_truncate $fh_or_path, $offset, $callback->($status)
221	aio_chmod $fh_or_path, $mode, $callback->($status)	229	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		230	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
222	aio_unlink $pathname, $callback->($status)	231	aio_unlink $pathname, $callback->($status)
223	aio_mknod $path, $mode, $dev, $callback->($status)	232	aio_mknod $pathname, $mode, $dev, $callback->($status)
224	aio_link $srcpath, $dstpath, $callback->($status)	233	aio_link $srcpath, $dstpath, $callback->($status)
225	aio_symlink $srcpath, $dstpath, $callback->($status)	234	aio_symlink $srcpath, $dstpath, $callback->($status)
226	aio_readlink $path, $callback->($link)	235	aio_readlink $pathname, $callback->($link)
		236	aio_realpath $pathname, $callback->($path)
227	aio_rename $srcpath, $dstpath, $callback->($status)	237	aio_rename $srcpath, $dstpath, $callback->($status)
228	aio_mkdir $pathname, $mode, $callback->($status)	238	aio_mkdir $pathname, $mode, $callback->($status)
229	aio_rmdir $pathname, $callback->($status)	239	aio_rmdir $pathname, $callback->($status)
230	aio_readdir $pathname, $callback->($entries)	240	aio_readdir $pathname, $callback->($entries)
231	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	241	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
232	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	242	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
233	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN	243	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		244	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
234	aio_load $path, $data, $callback->($status)	245	aio_load $pathname, $data, $callback->($status)
235	aio_copy $srcpath, $dstpath, $callback->($status)	246	aio_copy $srcpath, $dstpath, $callback->($status)
236	aio_move $srcpath, $dstpath, $callback->($status)	247	aio_move $srcpath, $dstpath, $callback->($status)
237	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
238	aio_rmtree $path, $callback->($status)	248	aio_rmtree $pathname, $callback->($status)
		249	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		250	aio_ioctl $fh, $request, $buf, $callback->($status)
239	aio_sync $callback->($status)	251	aio_sync $callback->($status)
		252	aio_syncfs $fh, $callback->($status)
240	aio_fsync $fh, $callback->($status)	253	aio_fsync $fh, $callback->($status)
241	aio_fdatasync $fh, $callback->($status)	254	aio_fdatasync $fh, $callback->($status)
242	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	255	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
243	aio_pathsync $path, $callback->($status)	256	aio_pathsync $pathname, $callback->($status)
244	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	257	aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
245	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	258	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	259	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247	aio_mlockall $flags, $callback->($status)	260	aio_mlockall $flags, $callback->($status)
248	aio_group $callback->(...)	261	aio_group $callback->(...)
249	aio_nop $callback->()	262	aio_nop $callback->()
…		…
258	IO::AIO::max_poll_reqs $nreqs	271	IO::AIO::max_poll_reqs $nreqs
259	IO::AIO::max_poll_time $seconds	272	IO::AIO::max_poll_time $seconds
260	IO::AIO::min_parallel $nthreads	273	IO::AIO::min_parallel $nthreads
261	IO::AIO::max_parallel $nthreads	274	IO::AIO::max_parallel $nthreads
262	IO::AIO::max_idle $nthreads	275	IO::AIO::max_idle $nthreads
		276	IO::AIO::idle_timeout $seconds
263	IO::AIO::max_outstanding $maxreqs	277	IO::AIO::max_outstanding $maxreqs
264	IO::AIO::nreqs	278	IO::AIO::nreqs
265	IO::AIO::nready	279	IO::AIO::nready
266	IO::AIO::npending	280	IO::AIO::npending
267		281
268	IO::AIO::sendfile $ofh, $ifh, $offset, $count	282	IO::AIO::sendfile $ofh, $ifh, $offset, $count
269	IO::AIO::fadvise $fh, $offset, $len, $advice	283	IO::AIO::fadvise $fh, $offset, $len, $advice
		284	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		285	IO::AIO::munmap $scalar
270	IO::AIO::madvise $scalar, $offset, $length, $advice	286	IO::AIO::madvise $scalar, $offset, $length, $advice
271	IO::AIO::mprotect $scalar, $offset, $length, $protect	287	IO::AIO::mprotect $scalar, $offset, $length, $protect
272	IO::AIO::munlock $scalar, $offset = 0, $length = undef	288	IO::AIO::munlock $scalar, $offset = 0, $length = undef
273	IO::AIO::munlockall	289	IO::AIO::munlockall
274		290
275	=head2 AIO REQUEST FUNCTIONS	291	=head2 API NOTES
276		292
277	All the C<aio_*> calls are more or less thin wrappers around the syscall	293	All the C<aio_*> calls are more or less thin wrappers around the syscall
278	with the same name (sans C<aio_>). The arguments are similar or identical,	294	with the same name (sans C<aio_>). The arguments are similar or identical,
279	and they all accept an additional (and optional) C<$callback> argument	295	and they all accept an additional (and optional) C<$callback> argument
280	which must be a code reference. This code reference will get called with	296	which must be a code reference. This code reference will be called after
281	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	297	the syscall has been executed in an asynchronous fashion. The results
282	perl, which usually delivers "false") as its sole argument after the given	298	of the request will be passed as arguments to the callback (and, if an
283	syscall has been executed asynchronously.	299	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		300	most syscalls return C<-1> on error, unlike perl, which usually delivers
		301	"false").
		302
		303	Some requests (such as C<aio_readdir>) pass the actual results and
		304	communicate failures by passing C<undef>.
284		305
285	All functions expecting a filehandle keep a copy of the filehandle	306	All functions expecting a filehandle keep a copy of the filehandle
286	internally until the request has finished.	307	internally until the request has finished.
287		308
288	All functions return request objects of type L<IO::AIO::REQ> that allow	309	All functions return request objects of type L<IO::AIO::REQ> that allow
289	further manipulation of those requests while they are in-flight.	310	further manipulation of those requests while they are in-flight.
290		311
291	The pathnames you pass to these routines I<must> be absolute and	312	The pathnames you pass to these routines I<should> be absolute. The
292	encoded as octets. The reason for the former is that at the time the	313	reason for this is that at the time the request is being executed, the
293	request is being executed, the current working directory could have	314	current working directory could have changed. Alternatively, you can
294	changed. Alternatively, you can make sure that you never change the	315	make sure that you never change the current working directory anywhere
295	current working directory anywhere in the program and then use relative	316	in the program and then use relative paths. You can also take advantage
296	paths.	317	of IO::AIOs working directory abstraction, that lets you specify paths
		318	relative to some previously-opened "working directory object" - see the
		319	description of the C<IO::AIO::WD> class later in this document.
297		320
298	To encode pathnames as octets, either make sure you either: a) always pass	321	To encode pathnames as octets, either make sure you either: a) always pass
299	in filenames you got from outside (command line, readdir etc.) without	322	in filenames you got from outside (command line, readdir etc.) without
300	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	323	tinkering, b) are in your native filesystem encoding, c) use the Encode
301	your pathnames to the locale (or other) encoding in effect in the user	324	module and encode your pathnames to the locale (or other) encoding in
302	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	325	effect in the user environment, d) use Glib::filename_from_unicode on
303	use something else to ensure your scalar has the correct contents.	326	unicode filenames or e) use something else to ensure your scalar has the
		327	correct contents.
304		328
305	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	329	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
306	handles correctly whether it is set or not.	330	handles correctly whether it is set or not.
		331
		332	=head2 AIO REQUEST FUNCTIONS
307		333
308	=over 4	334	=over 4
309		335
310	=item $prev_pri = aioreq_pri [$pri]	336	=item $prev_pri = aioreq_pri [$pri]
311		337
…		…
341		367
342		368
343	=item aio_open $pathname, $flags, $mode, $callback->($fh)	369	=item aio_open $pathname, $flags, $mode, $callback->($fh)
344		370
345	Asynchronously open or create a file and call the callback with a newly	371	Asynchronously open or create a file and call the callback with a newly
346	created filehandle for the file.	372	created filehandle for the file (or C<undef> in case of an error).
347		373
348	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	374	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
349	for an explanation.	375	for an explanation.
350		376
351	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	377	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
367	} else {	393	} else {
368	die "open failed: $!\n";	394	die "open failed: $!\n";
369	}	395	}
370	};	396	};
371		397
		398	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		399	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		400	following POSIX and non-POSIX constants are available (missing ones on
		401	your system are, as usual, C<0>):
		402
		403	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		404	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		405	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
		406
372		407
373	=item aio_close $fh, $callback->($status)	408	=item aio_close $fh, $callback->($status)
374		409
375	Asynchronously close a file and call the callback with the result	410	Asynchronously close a file and call the callback with the result
376	code.	411	code.
…		…
385	Or in other words: the file descriptor will be closed, but it will not be	420	Or in other words: the file descriptor will be closed, but it will not be
386	free for reuse until the perl filehandle is closed.	421	free for reuse until the perl filehandle is closed.
387		422
388	=cut	423	=cut
389		424
		425	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		426
		427	Seeks the filehandle to the new C<$offset>, similarly to perl's
		428	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		429	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		430	C<IO::AIO::SEEK_END>).
		431
		432	The resulting absolute offset will be passed to the callback, or C<-1> in
		433	case of an error.
		434
		435	In theory, the C<$whence> constants could be different than the
		436	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		437	so don't panic.
		438
		439	As a GNU/Linux (and maybe Solaris) extension, also the constants
		440	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		441	could be found. No guarantees about suitability for use in C<aio_seek> or
		442	Perl's C<sysseek> can be made though, although I would naively assume they
		443	"just work".
		444
390	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	445	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
391		446
392	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	447	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
393		448
394	Reads or writes C<$length> bytes from or to the specified C<$fh> and	449	Reads or writes C<$length> bytes from or to the specified C<$fh> and
395	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	450	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
396	and calls the callback without the actual number of bytes read (or -1 on	451	calls the callback with the actual number of bytes transferred (or -1 on
397	error, just like the syscall).	452	error, just like the syscall).
398		453
399	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	454	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
400	offset plus the actual number of bytes read.	455	offset plus the actual number of bytes read.
401		456
…		…
426		481
427	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	482	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
428	reading at byte offset C<$in_offset>, and starts writing at the current	483	reading at byte offset C<$in_offset>, and starts writing at the current
429	file offset of C<$out_fh>. Because of that, it is not safe to issue more	484	file offset of C<$out_fh>. Because of that, it is not safe to issue more
430	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	485	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
431	other.	486	other. The same C<$in_fh> works fine though, as this function does not
		487	move or use the file offset of C<$in_fh>.
432		488
433	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than	489	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
434	are written, and there is no way to find out how many bytes have been read	490	are written, and there is no way to find out how many more bytes have been
435	from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of	491	read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
436	bytes written to C<$out_fh>. Only if the result value equals C<$length>	492	number of bytes written to C<$out_fh>. Only if the result value equals
437	one can assume that C<$length> bytes have been read.	493	C<$length> one can assume that C<$length> bytes have been read.
438		494
439	Unlike with other C<aio_> functions, it makes a lot of sense to use	495	Unlike with other C<aio_> functions, it makes a lot of sense to use
440	C<aio_sendfile> on non-blocking sockets, as long as one end (typically	496	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
441	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while	497	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
442	the socket I/O will be non-blocking. Note, however, that you can run into	498	the socket I/O will be non-blocking. Note, however, that you can run
443	a trap where C<aio_sendfile> reads some data with readahead, then fails	499	into a trap where C<aio_sendfile> reads some data with readahead, then
444	to write all data, and when the socket is ready the next time, the data	500	fails to write all data, and when the socket is ready the next time, the
445	in the cache is already lost, forcing C<aio_sendfile> to again hit the	501	data in the cache is already lost, forcing C<aio_sendfile> to again hit
446	disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage	502	the disk. Explicit C<aio_read> + C<aio_write> let's you better control
447	much better.	503	resource usage.
448		504
449	This call tries to make use of a native C<sendfile> syscall to provide	505	This call tries to make use of a native C<sendfile>-like syscall to
450	zero-copy operation. For this to work, C<$out_fh> should refer to a	506	provide zero-copy operation. For this to work, C<$out_fh> should refer to
451	socket, and C<$in_fh> should refer to an mmap'able file.	507	a socket, and C<$in_fh> should refer to an mmap'able file.
452		508
453	If a native sendfile cannot be found or it fails with C<ENOSYS>,	509	If a native sendfile cannot be found or it fails with C<ENOSYS>,
454	C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,	510	C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
455	it will be emulated, so you can call C<aio_sendfile> on any type of	511	C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
456	filehandle regardless of the limitations of the operating system.	512	type of filehandle regardless of the limitations of the operating system.
		513
		514	As native sendfile syscalls (as practically any non-POSIX interface hacked
		515	together in a hurry to improve benchmark numbers) tend to be rather buggy
		516	on many systems, this implementation tries to work around some known bugs
		517	in Linux and FreeBSD kernels (probably others, too), but that might fail,
		518	so you really really should check the return value of C<aio_sendfile> -
		519	fewer bytes than expected might have been transferred.
457		520
458		521
459	=item aio_readahead $fh,$offset,$length, $callback->($retval)	522	=item aio_readahead $fh,$offset,$length, $callback->($retval)
460		523
461	C<aio_readahead> populates the page cache with data from a file so that	524	C<aio_readahead> populates the page cache with data from a file so that
…		…
465	whole pages, so that offset is effectively rounded down to a page boundary	528	whole pages, so that offset is effectively rounded down to a page boundary
466	and bytes are read up to the next page boundary greater than or equal to	529	and bytes are read up to the next page boundary greater than or equal to
467	(off-set+length). C<aio_readahead> does not read beyond the end of the	530	(off-set+length). C<aio_readahead> does not read beyond the end of the
468	file. The current file offset of the file is left unchanged.	531	file. The current file offset of the file is left unchanged.
469		532
470	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	533	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
471	emulated by simply reading the data, which would have a similar effect.	534	be emulated by simply reading the data, which would have a similar effect.
472		535
473		536
474	=item aio_stat $fh_or_path, $callback->($status)	537	=item aio_stat $fh_or_path, $callback->($status)
475		538
476	=item aio_lstat $fh, $callback->($status)	539	=item aio_lstat $fh, $callback->($status)
…		…
483	for an explanation.	546	for an explanation.
484		547
485	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	548	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
486	error when stat'ing a large file, the results will be silently truncated	549	error when stat'ing a large file, the results will be silently truncated
487	unless perl itself is compiled with large file support.	550	unless perl itself is compiled with large file support.
		551
		552	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		553	following constants and functions (if not implemented, the constants will
		554	be C<0> and the functions will either C<croak> or fall back on traditional
		555	behaviour).
		556
		557	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		558	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		559	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
488		560
489	Example: Print the length of F</etc/passwd>:	561	Example: Print the length of F</etc/passwd>:
490		562
491	aio_stat "/etc/passwd", sub {	563	aio_stat "/etc/passwd", sub {
492	$_[0] and die "stat failed: $!";	564	$_[0] and die "stat failed: $!";
…		…
536	namemax => 255,	608	namemax => 255,
537	frsize => 1024,	609	frsize => 1024,
538	fsid => 1810	610	fsid => 1810
539	}	611	}
540		612
		613	Here is a (likely partial - send me updates!) list of fsid values used by
		614	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		615
		616	0x0000adf5 adfs
		617	0x0000adff affs
		618	0x5346414f afs
		619	0x09041934 anon-inode filesystem
		620	0x00000187 autofs
		621	0x42465331 befs
		622	0x1badface bfs
		623	0x42494e4d binfmt_misc
		624	0x9123683e btrfs
		625	0x0027e0eb cgroupfs
		626	0xff534d42 cifs
		627	0x73757245 coda
		628	0x012ff7b7 coh
		629	0x28cd3d45 cramfs
		630	0x453dcd28 cramfs-wend (wrong endianness)
		631	0x64626720 debugfs
		632	0x00001373 devfs
		633	0x00001cd1 devpts
		634	0x0000f15f ecryptfs
		635	0x00414a53 efs
		636	0x0000137d ext
		637	0x0000ef53 ext2/ext3/ext4
		638	0x0000ef51 ext2
		639	0xf2f52010 f2fs
		640	0x00004006 fat
		641	0x65735546 fuseblk
		642	0x65735543 fusectl
		643	0x0bad1dea futexfs
		644	0x01161970 gfs2
		645	0x47504653 gpfs
		646	0x00004244 hfs
		647	0xf995e849 hpfs
		648	0x00c0ffee hostfs
		649	0x958458f6 hugetlbfs
		650	0x2bad1dea inotifyfs
		651	0x00009660 isofs
		652	0x000072b6 jffs2
		653	0x3153464a jfs
		654	0x6b414653 k-afs
		655	0x0bd00bd0 lustre
		656	0x0000137f minix
		657	0x0000138f minix 30 char names
		658	0x00002468 minix v2
		659	0x00002478 minix v2 30 char names
		660	0x00004d5a minix v3
		661	0x19800202 mqueue
		662	0x00004d44 msdos
		663	0x0000564c novell
		664	0x00006969 nfs
		665	0x6e667364 nfsd
		666	0x00003434 nilfs
		667	0x5346544e ntfs
		668	0x00009fa1 openprom
		669	0x7461636F ocfs2
		670	0x00009fa0 proc
		671	0x6165676c pstorefs
		672	0x0000002f qnx4
		673	0x68191122 qnx6
		674	0x858458f6 ramfs
		675	0x52654973 reiserfs
		676	0x00007275 romfs
		677	0x67596969 rpc_pipefs
		678	0x73636673 securityfs
		679	0xf97cff8c selinux
		680	0x0000517b smb
		681	0x534f434b sockfs
		682	0x73717368 squashfs
		683	0x62656572 sysfs
		684	0x012ff7b6 sysv2
		685	0x012ff7b5 sysv4
		686	0x01021994 tmpfs
		687	0x15013346 udf
		688	0x00011954 ufs
		689	0x54190100 ufs byteswapped
		690	0x00009fa2 usbdevfs
		691	0x01021997 v9fs
		692	0xa501fcf5 vxfs
		693	0xabba1974 xenfs
		694	0x012ff7b4 xenix
		695	0x58465342 xfs
		696	0x012fd16d xia
541		697
542	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	698	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
543		699
544	Works like perl's C<utime> function (including the special case of $atime	700	Works like perl's C<utime> function (including the special case of $atime
545	and $mtime being undef). Fractional times are supported if the underlying	701	and $mtime being undef). Fractional times are supported if the underlying
…		…
573	=item aio_truncate $fh_or_path, $offset, $callback->($status)	729	=item aio_truncate $fh_or_path, $offset, $callback->($status)
574		730
575	Works like truncate(2) or ftruncate(2).	731	Works like truncate(2) or ftruncate(2).
576		732
577		733
		734	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		735
		736	Allocates or frees disk space according to the C<$mode> argument. See the
		737	linux C<fallocate> documentation for details.
		738
		739	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		740	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
		741	to deallocate a file range.
		742
		743	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		744	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
		745	your L<fallocate(2)> manpage).
		746
		747	The file system block size used by C<fallocate> is presumably the
		748	C<f_bsize> returned by C<statvfs>.
		749
		750	If C<fallocate> isn't available or cannot be emulated (currently no
		751	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		752
		753
578	=item aio_chmod $fh_or_path, $mode, $callback->($status)	754	=item aio_chmod $fh_or_path, $mode, $callback->($status)
579		755
580	Works like perl's C<chmod> function.	756	Works like perl's C<chmod> function.
581		757
582		758
…		…
584		760
585	Asynchronously unlink (delete) a file and call the callback with the	761	Asynchronously unlink (delete) a file and call the callback with the
586	result code.	762	result code.
587		763
588		764
589	=item aio_mknod $path, $mode, $dev, $callback->($status)	765	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
590		766
591	[EXPERIMENTAL]	767	[EXPERIMENTAL]
592		768
593	Asynchronously create a device node (or fifo). See mknod(2).	769	Asynchronously create a device node (or fifo). See mknod(2).
594		770
595	The only (POSIX-) portable way of calling this function is:	771	The only (POSIX-) portable way of calling this function is:
596		772
597	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	773	aio_mknod $pathname, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
598		774
		775	See C<aio_stat> for info about some potentially helpful extra constants
		776	and functions.
599		777
600	=item aio_link $srcpath, $dstpath, $callback->($status)	778	=item aio_link $srcpath, $dstpath, $callback->($status)
601		779
602	Asynchronously create a new link to the existing object at C<$srcpath> at	780	Asynchronously create a new link to the existing object at C<$srcpath> at
603	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.
…		…
607		785
608	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	786	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
609	the path C<$dstpath> and call the callback with the result code.	787	the path C<$dstpath> and call the callback with the result code.
610		788
611		789
612	=item aio_readlink $path, $callback->($link)	790	=item aio_readlink $pathname, $callback->($link)
613		791
614	Asynchronously read the symlink specified by C<$path> and pass it to	792	Asynchronously read the symlink specified by C<$path> and pass it to
615	the callback. If an error occurs, nothing or undef gets passed to the	793	the callback. If an error occurs, nothing or undef gets passed to the
616	callback.	794	callback.
617		795
618		796
		797	=item aio_realpath $pathname, $callback->($path)
		798
		799	Asynchronously make the path absolute and resolve any symlinks in
		800	C<$path>. The resulting path only consists of directories (same as
		801	L<Cwd::realpath>).
		802
		803	This request can be used to get the absolute path of the current working
		804	directory by passing it a path of F<.> (a single dot).
		805
		806
619	=item aio_rename $srcpath, $dstpath, $callback->($status)	807	=item aio_rename $srcpath, $dstpath, $callback->($status)
620		808
621	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	809	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
622	rename(2) and call the callback with the result code.	810	rename(2) and call the callback with the result code.
		811
		812	On systems that support the AIO::WD working directory abstraction
		813	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		814	of failing, C<rename> is called on the absolute path of C<$wd>.
623		815
624		816
625	=item aio_mkdir $pathname, $mode, $callback->($status)	817	=item aio_mkdir $pathname, $mode, $callback->($status)
626		818
627	Asynchronously mkdir (create) a directory and call the callback with	819	Asynchronously mkdir (create) a directory and call the callback with
…		…
632	=item aio_rmdir $pathname, $callback->($status)	824	=item aio_rmdir $pathname, $callback->($status)
633		825
634	Asynchronously rmdir (delete) a directory and call the callback with the	826	Asynchronously rmdir (delete) a directory and call the callback with the
635	result code.	827	result code.
636		828
		829	On systems that support the AIO::WD working directory abstraction
		830	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		831	C<rmdir> is called on the absolute path of C<$wd>.
		832
637		833
638	=item aio_readdir $pathname, $callback->($entries)	834	=item aio_readdir $pathname, $callback->($entries)
639		835
640	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	836	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
641	directory (i.e. opendir + readdir + closedir). The entries will not be	837	directory (i.e. opendir + readdir + closedir). The entries will not be
…		…
645	array-ref with the filenames.	841	array-ref with the filenames.
646		842
647		843
648	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)	844	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
649		845
650	Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune	846	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
651	behaviour and output format. In case of an error, C<$entries> will be	847	tune behaviour and output format. In case of an error, C<$entries> will be
652	C<undef>.	848	C<undef>.
653		849
654	The flags are a combination of the following constants, ORed together (the	850	The flags are a combination of the following constants, ORed together (the
655	flags will also be passed to the callback, possibly modified):	851	flags will also be passed to the callback, possibly modified):
656		852
657	=over 4	853	=over 4
658		854
659	=item IO::AIO::READDIR_DENTS	855	=item IO::AIO::READDIR_DENTS
660		856
661	When this flag is off, then the callback gets an arrayref with of names	857	When this flag is off, then the callback gets an arrayref consisting of
662	only (as with C<aio_readdir>), otherwise it gets an arrayref with	858	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
663	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	859	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
664	entry in more detail.	860	entry in more detail.
665		861
666	C<$name> is the name of the entry.	862	C<$name> is the name of the entry.
667		863
…		…
680	systems that do not deliver the inode information.	876	systems that do not deliver the inode information.
681		877
682	=item IO::AIO::READDIR_DIRS_FIRST	878	=item IO::AIO::READDIR_DIRS_FIRST
683		879
684	When this flag is set, then the names will be returned in an order where	880	When this flag is set, then the names will be returned in an order where
685	likely directories come first. This is useful when you need to quickly	881	likely directories come first, in optimal stat order. This is useful when
686	find directories, or you want to find all directories while avoiding to	882	you need to quickly find directories, or you want to find all directories
687	stat() each entry.	883	while avoiding to stat() each entry.
688		884
689	If the system returns type information in readdir, then this is used	885	If the system returns type information in readdir, then this is used
690	to find directories directly. Otherwise, likely directories are files	886	to find directories directly. Otherwise, likely directories are names
691	beginning with ".", or otherwise files with no dots, of which files with	887	beginning with ".", or otherwise names with no dots, of which names with
692	short names are tried first.	888	short names are tried first.
693		889
694	=item IO::AIO::READDIR_STAT_ORDER	890	=item IO::AIO::READDIR_STAT_ORDER
695		891
696	When this flag is set, then the names will be returned in an order	892	When this flag is set, then the names will be returned in an order
…		…
703		899
704	=item IO::AIO::READDIR_FOUND_UNKNOWN	900	=item IO::AIO::READDIR_FOUND_UNKNOWN
705		901
706	This flag should not be set when calling C<aio_readdirx>. Instead, it	902	This flag should not be set when calling C<aio_readdirx>. Instead, it
707	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	903	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
708	C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all	904	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
709	C<$type>'s are known, which can be used to speed up some algorithms.	905	C<$type>'s are known, which can be used to speed up some algorithms.
710		906
711	=back	907	=back
712		908
713		909
714	=item aio_load $path, $data, $callback->($status)	910	=item aio_load $pathname, $data, $callback->($status)
715		911
716	This is a composite request that tries to fully load the given file into	912	This is a composite request that tries to fully load the given file into
717	memory. Status is the same as with aio_read.	913	memory. Status is the same as with aio_read.
718		914
719	=cut	915	=cut
…		…
841	if ($_[0] && $! == EXDEV) {	1037	if ($_[0] && $! == EXDEV) {
842	aioreq_pri $pri;	1038	aioreq_pri $pri;
843	add $grp aio_copy $src, $dst, sub {	1039	add $grp aio_copy $src, $dst, sub {
844	$grp->result ($_[0]);	1040	$grp->result ($_[0]);
845		1041
846	if (!$_[0]) {	1042	unless ($_[0]) {
847	aioreq_pri $pri;	1043	aioreq_pri $pri;
848	add $grp aio_unlink $src;	1044	add $grp aio_unlink $src;
849	}	1045	}
850	};	1046	};
851	} else {	1047	} else {
…		…
854	};	1050	};
855		1051
856	$grp	1052	$grp
857	}	1053	}
858		1054
859	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1055	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
860		1056
861	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1057	Scans a directory (similar to C<aio_readdir>) but additionally tries to
862	efficiently separate the entries of directory C<$path> into two sets of	1058	efficiently separate the entries of directory C<$path> into two sets of
863	names, directories you can recurse into (directories), and ones you cannot	1059	names, directories you can recurse into (directories), and ones you cannot
864	recurse into (everything else, including symlinks to directories).	1060	recurse into (everything else, including symlinks to directories).
…		…
895	Then entries will be sorted into likely directories a non-initial dot	1091	Then entries will be sorted into likely directories a non-initial dot
896	currently) and likely non-directories (see C<aio_readdirx>). Then every	1092	currently) and likely non-directories (see C<aio_readdirx>). Then every
897	entry plus an appended C</.> will be C<stat>'ed, likely directories first,	1093	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
898	in order of their inode numbers. If that succeeds, it assumes that the	1094	in order of their inode numbers. If that succeeds, it assumes that the
899	entry is a directory or a symlink to directory (which will be checked	1095	entry is a directory or a symlink to directory (which will be checked
900	seperately). This is often faster than stat'ing the entry itself because	1096	separately). This is often faster than stat'ing the entry itself because
901	filesystems might detect the type of the entry without reading the inode	1097	filesystems might detect the type of the entry without reading the inode
902	data (e.g. ext2fs filetype feature), even on systems that cannot return	1098	data (e.g. ext2fs filetype feature), even on systems that cannot return
903	the filetype information on readdir.	1099	the filetype information on readdir.
904		1100
905	If the known number of directories (link count - 2) has been reached, the	1101	If the known number of directories (link count - 2) has been reached, the
…		…
921		1117
922	my $grp = aio_group $cb;	1118	my $grp = aio_group $cb;
923		1119
924	$maxreq = 4 if $maxreq <= 0;	1120	$maxreq = 4 if $maxreq <= 0;
925		1121
926	# stat once	1122	# get a wd object
927	aioreq_pri $pri;	1123	aioreq_pri $pri;
928	add $grp aio_stat $path, sub {	1124	add $grp aio_wd $path, sub {
		1125	$_[0]
929	return $grp->result () if $_[0];	1126	or return $grp->result ();
930	my $now = time;
931	my $hash1 = join ":", (stat _)[0,1,3,7,9];
932		1127
933	# read the directory entries	1128	my $wd = [shift, "."];
		1129
		1130	# stat once
934	aioreq_pri $pri;	1131	aioreq_pri $pri;
935	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {	1132	add $grp aio_stat $wd, sub {
936	my $entries = shift
937	or return $grp->result ();	1133	return $grp->result () if $_[0];
		1134	my $now = time;
		1135	my $hash1 = join ":", (stat _)[0,1,3,7,9];
938		1136
939	# stat the dir another time	1137	# read the directory entries
940	aioreq_pri $pri;	1138	aioreq_pri $pri;
		1139	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1140	my $entries = shift
		1141	or return $grp->result ();
		1142
		1143	# stat the dir another time
		1144	aioreq_pri $pri;
941	add $grp aio_stat $path, sub {	1145	add $grp aio_stat $wd, sub {
942	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1146	my $hash2 = join ":", (stat _)[0,1,3,7,9];
943		1147
944	my $ndirs;	1148	my $ndirs;
945		1149
946	# take the slow route if anything looks fishy	1150	# take the slow route if anything looks fishy
947	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1151	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
948	$ndirs = -1;	1152	$ndirs = -1;
949	} else {	1153	} else {
950	# if nlink == 2, we are finished	1154	# if nlink == 2, we are finished
951	# for non-posix-fs's, we rely on nlink < 2	1155	# for non-posix-fs's, we rely on nlink < 2
952	$ndirs = (stat _)[3] - 2	1156	$ndirs = (stat _)[3] - 2
953	or return $grp->result ([], $entries);	1157	or return $grp->result ([], $entries);
954	}	1158	}
955		1159
956	my (@dirs, @nondirs);	1160	my (@dirs, @nondirs);
957		1161
958	my $statgrp = add $grp aio_group sub {	1162	my $statgrp = add $grp aio_group sub {
959	$grp->result (\@dirs, \@nondirs);	1163	$grp->result (\@dirs, \@nondirs);
960	};	1164	};
961		1165
962	limit $statgrp $maxreq;	1166	limit $statgrp $maxreq;
963	feed $statgrp sub {	1167	feed $statgrp sub {
964	return unless @$entries;	1168	return unless @$entries;
965	my $entry = shift @$entries;	1169	my $entry = shift @$entries;
966		1170
967	aioreq_pri $pri;	1171	aioreq_pri $pri;
		1172	$wd->[1] = "$entry/.";
968	add $statgrp aio_stat "$path/$entry/.", sub {	1173	add $statgrp aio_stat $wd, sub {
969	if ($_[0] < 0) {	1174	if ($_[0] < 0) {
970	push @nondirs, $entry;	1175	push @nondirs, $entry;
971	} else {	1176	} else {
972	# need to check for real directory	1177	# need to check for real directory
973	aioreq_pri $pri;	1178	aioreq_pri $pri;
		1179	$wd->[1] = $entry;
974	add $statgrp aio_lstat "$path/$entry", sub {	1180	add $statgrp aio_lstat $wd, sub {
975	if (-d _) {	1181	if (-d _) {
976	push @dirs, $entry;	1182	push @dirs, $entry;
977		1183
978	unless (--$ndirs) {	1184	unless (--$ndirs) {
979	push @nondirs, @$entries;	1185	push @nondirs, @$entries;
980	feed $statgrp;	1186	feed $statgrp;
		1187	}
		1188	} else {
		1189	push @nondirs, $entry;
981	}	1190	}
982	} else {
983	push @nondirs, $entry;
984	}	1191	}
985	}	1192	}
986	}	1193	};
987	};	1194	};
988	};	1195	};
989	};	1196	};
990	};	1197	};
991	};	1198	};
992		1199
993	$grp	1200	$grp
994	}	1201	}
995		1202
996	=item aio_rmtree $path, $callback->($status)	1203	=item aio_rmtree $pathname, $callback->($status)
997		1204
998	Delete a directory tree starting (and including) C<$path>, return the	1205	Delete a directory tree starting (and including) C<$path>, return the
999	status of the final C<rmdir> only. This is a composite request that	1206	status of the final C<rmdir> only. This is a composite request that
1000	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1207	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1001	everything else.	1208	everything else.
1002		1209
1003	=cut	1210	=cut
1004		1211
…		…
1026	};	1233	};
1027		1234
1028	$grp	1235	$grp
1029	}	1236	}
1030		1237
		1238	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1239
		1240	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1241
		1242	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1243	they execute asynchronously and pass the return value to the callback.
		1244
		1245	Both calls can be used for a lot of things, some of which make more sense
		1246	to run asynchronously in their own thread, while some others make less
		1247	sense. For example, calls that block waiting for external events, such
		1248	as locking, will also lock down an I/O thread while it is waiting, which
		1249	can deadlock the whole I/O system. At the same time, there might be no
		1250	alternative to using a thread to wait.
		1251
		1252	So in general, you should only use these calls for things that do
		1253	(filesystem) I/O, not for things that wait for other events (network,
		1254	other processes), although if you are careful and know what you are doing,
		1255	you still can.
		1256
		1257	The following constants are available (missing ones are, as usual C<0>):
		1258
		1259	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1260
		1261	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1262	C<FS_IOC_FIEMAP>.
		1263
		1264	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1265	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1266
		1267	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1268	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1269	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1270	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1271	C<FS_FL_USER_MODIFIABLE>.
		1272
		1273	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1274	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1275	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1276	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
		1277
1031	=item aio_sync $callback->($status)	1278	=item aio_sync $callback->($status)
1032		1279
1033	Asynchronously call sync and call the callback when finished.	1280	Asynchronously call sync and call the callback when finished.
1034		1281
1035	=item aio_fsync $fh, $callback->($status)	1282	=item aio_fsync $fh, $callback->($status)
…		…
1042	Asynchronously call fdatasync on the given filehandle and call the	1289	Asynchronously call fdatasync on the given filehandle and call the
1043	callback with the fdatasync result code.	1290	callback with the fdatasync result code.
1044		1291
1045	If this call isn't available because your OS lacks it or it couldn't be	1292	If this call isn't available because your OS lacks it or it couldn't be
1046	detected, it will be emulated by calling C<fsync> instead.	1293	detected, it will be emulated by calling C<fsync> instead.
		1294
		1295	=item aio_syncfs $fh, $callback->($status)
		1296
		1297	Asynchronously call the syncfs syscall to sync the filesystem associated
		1298	to the given filehandle and call the callback with the syncfs result
		1299	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1300	errno to C<ENOSYS> nevertheless.
1047		1301
1048	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	1302	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1049		1303
1050	Sync the data portion of the file specified by C<$offset> and C<$length>	1304	Sync the data portion of the file specified by C<$offset> and C<$length>
1051	to disk (but NOT the metadata), by calling the Linux-specific	1305	to disk (but NOT the metadata), by calling the Linux-specific
…		…
1055	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,	1309	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1056	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and	1310	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1057	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range	1311	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1058	manpage for details.	1312	manpage for details.
1059		1313
1060	=item aio_pathsync $path, $callback->($status)	1314	=item aio_pathsync $pathname, $callback->($status)
1061		1315
1062	This request tries to open, fsync and close the given path. This is a	1316	This request tries to open, fsync and close the given path. This is a
1063	composite request intended to sync directories after directory operations	1317	composite request intended to sync directories after directory operations
1064	(E.g. rename). This might not work on all operating systems or have any	1318	(E.g. rename). This might not work on all operating systems or have any
1065	specific effect, but usually it makes sure that directory changes get	1319	specific effect, but usually it makes sure that directory changes get
…		…
1096	};	1350	};
1097		1351
1098	$grp	1352	$grp
1099	}	1353	}
1100		1354
1101	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1355	=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1102		1356
1103	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1357	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1104	scalars (see the C<IO::AIO::mmap> function, although it also works on data	1358	scalars (see the C<IO::AIO::mmap> function, although it also works on data
1105	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the	1359	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1106	scalar must only be modified in-place while an aio operation is pending on	1360	scalar must only be modified in-place while an aio operation is pending on
…		…
1108		1362
1109	It calls the C<msync> function of your OS, if available, with the memory	1363	It calls the C<msync> function of your OS, if available, with the memory
1110	area starting at C<$offset> in the string and ending C<$length> bytes	1364	area starting at C<$offset> in the string and ending C<$length> bytes
1111	later. If C<$length> is negative, counts from the end, and if C<$length>	1365	later. If C<$length> is negative, counts from the end, and if C<$length>
1112	is C<undef>, then it goes till the end of the string. The flags can be	1366	is C<undef>, then it goes till the end of the string. The flags can be
1113	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and	1367	either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1114	C<IO::AIO::MS_SYNC>.	1368	C<IO::AIO::MS_INVALIDATE>.
1115		1369
1116	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1370	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1117		1371
1118	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1372	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1119	scalars.	1373	scalars.
1120		1374
1121	It touches (reads or writes) all memory pages in the specified	1375	It touches (reads or writes) all memory pages in the specified
1122	range inside the scalar. All caveats and parameters are the same	1376	range inside the scalar. All caveats and parameters are the same
1123	as for C<aio_msync>, above, except for flags, which must be either	1377	as for C<aio_msync>, above, except for flags, which must be either
1124	C<0> (which reads all pages and ensures they are instantiated) or	1378	C<0> (which reads all pages and ensures they are instantiated) or
1125	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1379	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1126	writing an octet from it, which dirties the page).	1380	writing an octet from it, which dirties the page).
1127		1381
1128	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1382	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1129		1383
1130	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1384	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1161	documented under L<MISCELLANEOUS FUNCTIONS>.	1415	documented under L<MISCELLANEOUS FUNCTIONS>.
1162		1416
1163	Example: asynchronously lock all current and future pages into memory.	1417	Example: asynchronously lock all current and future pages into memory.
1164		1418
1165	aio_mlockall IO::AIO::MCL_FUTURE;	1419	aio_mlockall IO::AIO::MCL_FUTURE;
		1420
		1421	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1422
		1423	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1424	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1425	the ioctl is not available on your OS, then this request will fail with
		1426	C<ENOSYS>.
		1427
		1428	C<$start> is the starting offset to query extents for, C<$length> is the
		1429	size of the range to query - if it is C<undef>, then the whole file will
		1430	be queried.
		1431
		1432	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1433	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1434	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1435	the data portion.
		1436
		1437	C<$count> is the maximum number of extent records to return. If it is
		1438	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1439	case, if it is C<0>, then the callback receives the number of extents
		1440	instead of the extents themselves (which is unreliable, see below).
		1441
		1442	If an error occurs, the callback receives no arguments. The special
		1443	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1444
		1445	Otherwise, the callback receives an array reference with extent
		1446	structures. Each extent structure is an array reference itself, with the
		1447	following members:
		1448
		1449	[$logical, $physical, $length, $flags]
		1450
		1451	Flags is any combination of the following flag values (typically either C<0>
		1452	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1453
		1454	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1455	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1456	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1457	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1458	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1459	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1460
		1461	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1462	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1463	it to return all extents of a range for files with large number of
		1464	extents. The code works around all these issues if C<$count> is undef.
1166		1465
1167	=item aio_group $callback->(...)	1466	=item aio_group $callback->(...)
1168		1467
1169	This is a very special aio request: Instead of doing something, it is a	1468	This is a very special aio request: Instead of doing something, it is a
1170	container for other aio requests, which is useful if you want to bundle	1469	container for other aio requests, which is useful if you want to bundle
…		…
1207	like sleep and file handle readable/writable, the overhead this creates is	1506	like sleep and file handle readable/writable, the overhead this creates is
1208	immense (it blocks a thread for a long time) so do not use this function	1507	immense (it blocks a thread for a long time) so do not use this function
1209	except to put your application under artificial I/O pressure.	1508	except to put your application under artificial I/O pressure.
1210		1509
1211	=back	1510	=back
		1511
		1512
		1513	=head2 IO::AIO::WD - multiple working directories
		1514
		1515	Your process only has one current working directory, which is used by all
		1516	threads. This makes it hard to use relative paths (some other component
		1517	could call C<chdir> at any time, and it is hard to control when the path
		1518	will be used by IO::AIO).
		1519
		1520	One solution for this is to always use absolute paths. This usually works,
		1521	but can be quite slow (the kernel has to walk the whole path on every
		1522	access), and can also be a hassle to implement.
		1523
		1524	Newer POSIX systems have a number of functions (openat, fdopendir,
		1525	futimensat and so on) that make it possible to specify working directories
		1526	per operation.
		1527
		1528	For portability, and because the clowns who "designed", or shall I write,
		1529	perpetrated this new interface were obviously half-drunk, this abstraction
		1530	cannot be perfect, though.
		1531
		1532	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1533	object. This object stores the canonicalised, absolute version of the
		1534	path, and on systems that allow it, also a directory file descriptor.
		1535
		1536	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1537	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1538	object and a pathname instead (or the IO::AIO::WD object alone, which
		1539	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1540	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1541	to that IO::AIO::WD object.
		1542
		1543	For example, to get a wd object for F</etc> and then stat F<passwd>
		1544	inside, you would write:
		1545
		1546	aio_wd "/etc", sub {
		1547	my $etcdir = shift;
		1548
		1549	# although $etcdir can be undef on error, there is generally no reason
		1550	# to check for errors here, as aio_stat will fail with ENOENT
		1551	# when $etcdir is undef.
		1552
		1553	aio_stat [$etcdir, "passwd"], sub {
		1554	# yay
		1555	};
		1556	};
		1557
		1558	The fact that C<aio_wd> is a request and not a normal function shows that
		1559	creating an IO::AIO::WD object is itself a potentially blocking operation,
		1560	which is why it is done asynchronously.
		1561
		1562	To stat the directory obtained with C<aio_wd> above, one could write
		1563	either of the following three request calls:
		1564
		1565	aio_lstat "/etc" , sub { ... # pathname as normal string
		1566	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1567	aio_lstat $wd , sub { ... # shorthand for the previous
		1568
		1569	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1570	object and the pathname string, so you could write the following without
		1571	causing any issues due to C<$path> getting reused:
		1572
		1573	my $path = [$wd, undef];
		1574
		1575	for my $name (qw(abc def ghi)) {
		1576	$path->[1] = $name;
		1577	aio_stat $path, sub {
		1578	# ...
		1579	};
		1580	}
		1581
		1582	There are some caveats: when directories get renamed (or deleted), the
		1583	pathname string doesn't change, so will point to the new directory (or
		1584	nowhere at all), while the directory fd, if available on the system,
		1585	will still point to the original directory. Most functions accepting a
		1586	pathname will use the directory fd on newer systems, and the string on
		1587	older systems. Some functions (such as realpath) will always rely on the
		1588	string form of the pathname.
		1589
		1590	So this functionality is mainly useful to get some protection against
		1591	C<chdir>, to easily get an absolute path out of a relative path for future
		1592	reference, and to speed up doing many operations in the same directory
		1593	(e.g. when stat'ing all files in a directory).
		1594
		1595	The following functions implement this working directory abstraction:
		1596
		1597	=over 4
		1598
		1599	=item aio_wd $pathname, $callback->($wd)
		1600
		1601	Asynchonously canonicalise the given pathname and convert it to an
		1602	IO::AIO::WD object representing it. If possible and supported on the
		1603	system, also open a directory fd to speed up pathname resolution relative
		1604	to this working directory.
		1605
		1606	If something goes wrong, then C<undef> is passwd to the callback instead
		1607	of a working directory object and C<$!> is set appropriately. Since
		1608	passing C<undef> as working directory component of a pathname fails the
		1609	request with C<ENOENT>, there is often no need for error checking in the
		1610	C<aio_wd> callback, as future requests using the value will fail in the
		1611	expected way.
		1612
		1613	=item IO::AIO::CWD
		1614
		1615	This is a compiletime constant (object) that represents the process
		1616	current working directory.
		1617
		1618	Specifying this object as working directory object for a pathname is as if
		1619	the pathname would be specified directly, without a directory object. For
		1620	example, these calls are functionally identical:
		1621
		1622	aio_stat "somefile", sub { ... };
		1623	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1624
		1625	=back
		1626
		1627	To recover the path associated with an IO::AIO::WD object, you can use
		1628	C<aio_realpath>:
		1629
		1630	aio_realpath $wd, sub {
		1631	warn "path is $_[0]\n";
		1632	};
		1633
		1634	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1635	sometimes, fall back to using an absolue path.
1212		1636
1213	=head2 IO::AIO::REQ CLASS	1637	=head2 IO::AIO::REQ CLASS
1214		1638
1215	All non-aggregate C<aio_*> functions return an object of this class when	1639	All non-aggregate C<aio_*> functions return an object of this class when
1216	called in non-void context.	1640	called in non-void context.
…		…
1334		1758
1335	Sets a feeder/generator on this group: every group can have an attached	1759	Sets a feeder/generator on this group: every group can have an attached
1336	generator that generates requests if idle. The idea behind this is that,	1760	generator that generates requests if idle. The idea behind this is that,
1337	although you could just queue as many requests as you want in a group,	1761	although you could just queue as many requests as you want in a group,
1338	this might starve other requests for a potentially long time. For example,	1762	this might starve other requests for a potentially long time. For example,
1339	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1763	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1340	delaying any later requests for a long time.	1764	requests, delaying any later requests for a long time.
1341		1765
1342	To avoid this, and allow incremental generation of requests, you can	1766	To avoid this, and allow incremental generation of requests, you can
1343	instead a group and set a feeder on it that generates those requests. The	1767	instead a group and set a feeder on it that generates those requests. The
1344	feed callback will be called whenever there are few enough (see C<limit>,	1768	feed callback will be called whenever there are few enough (see C<limit>,
1345	below) requests active in the group itself and is expected to queue more	1769	below) requests active in the group itself and is expected to queue more
…		…
1394		1818
1395	See C<poll_cb> for an example.	1819	See C<poll_cb> for an example.
1396		1820
1397	=item IO::AIO::poll_cb	1821	=item IO::AIO::poll_cb
1398		1822
1399	Process some outstanding events on the result pipe. You have to call this	1823	Process some requests that have reached the result phase (i.e. they have
1400	regularly. Returns C<0> if all events could be processed, or C<-1> if it	1824	been executed but the results are not yet reported). You have to call
1401	returned earlier for whatever reason. Returns immediately when no events	1825	this "regularly" to finish outstanding requests.
1402	are outstanding. The amount of events processed depends on the settings of
1403	C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1404		1826
		1827	Returns C<0> if all events could be processed (or there were no
		1828	events to process), or C<-1> if it returned earlier for whatever
		1829	reason. Returns immediately when no events are outstanding. The amount
		1830	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
		1831	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
		1832
1405	If not all requests were processed for whatever reason, the filehandle	1833	If not all requests were processed for whatever reason, the poll file
1406	will still be ready when C<poll_cb> returns, so normally you don't have to	1834	descriptor will still be ready when C<poll_cb> returns, so normally you
1407	do anything special to have it called later.	1835	don't have to do anything special to have it called later.
		1836
		1837	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1838	ready, it can be beneficial to call this function from loops which submit
		1839	a lot of requests, to make sure the results get processed when they become
		1840	available and not just when the loop is finished and the event loop takes
		1841	over again. This function returns very fast when there are no outstanding
		1842	requests.
1408		1843
1409	Example: Install an Event watcher that automatically calls	1844	Example: Install an Event watcher that automatically calls
1410	IO::AIO::poll_cb with high priority (more examples can be found in the	1845	IO::AIO::poll_cb with high priority (more examples can be found in the
1411	SYNOPSIS section, at the top of this document):	1846	SYNOPSIS section, at the top of this document):
1412		1847
…		…
1414	poll => 'r', async => 1,	1849	poll => 'r', async => 1,
1415	cb => \&IO::AIO::poll_cb);	1850	cb => \&IO::AIO::poll_cb);
1416		1851
1417	=item IO::AIO::poll_wait	1852	=item IO::AIO::poll_wait
1418		1853
1419	If there are any outstanding requests and none of them in the result	1854	Wait until either at least one request is in the result phase or no
1420	phase, wait till the result filehandle becomes ready for reading (simply	1855	requests are outstanding anymore.
1421	does a C<select> on the filehandle. This is useful if you want to	1856
1422	synchronously wait for some requests to finish).	1857	This is useful if you want to synchronously wait for some requests to
		1858	become ready, without actually handling them.
1423		1859
1424	See C<nreqs> for an example.	1860	See C<nreqs> for an example.
1425		1861
1426	=item IO::AIO::poll	1862	=item IO::AIO::poll
1427		1863
…		…
1514		1950
1515	Under normal circumstances you don't need to call this function.	1951	Under normal circumstances you don't need to call this function.
1516		1952
1517	=item IO::AIO::max_idle $nthreads	1953	=item IO::AIO::max_idle $nthreads
1518		1954
1519	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1955	Limit the number of threads (default: 4) that are allowed to idle
1520	threads that did not get a request to process within 10 seconds). That	1956	(i.e., threads that did not get a request to process within the idle
1521	means if a thread becomes idle while C<$nthreads> other threads are also	1957	timeout (default: 10 seconds). That means if a thread becomes idle while
1522	idle, it will free its resources and exit.	1958	C<$nthreads> other threads are also idle, it will free its resources and
		1959	exit.
1523		1960
1524	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1961	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1525	to allow for extremely high load situations, but want to free resources	1962	to allow for extremely high load situations, but want to free resources
1526	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1963	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1527		1964
1528	The default is probably ok in most situations, especially if thread	1965	The default is probably ok in most situations, especially if thread
1529	creation is fast. If thread creation is very slow on your system you might	1966	creation is fast. If thread creation is very slow on your system you might
1530	want to use larger values.	1967	want to use larger values.
1531		1968
		1969	=item IO::AIO::idle_timeout $seconds
		1970
		1971	Sets the minimum idle timeout (default 10) after which worker threads are
		1972	allowed to exit. SEe C<IO::AIO::max_idle>.
		1973
1532	=item IO::AIO::max_outstanding $maxreqs	1974	=item IO::AIO::max_outstanding $maxreqs
		1975
		1976	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1977	you do queue up more than this number of requests, the next call to
		1978	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1979	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1980	longer exceeded.
		1981
		1982	In other words, this setting does not enforce a queue limit, but can be
		1983	used to make poll functions block if the limit is exceeded.
1533		1984
1534	This is a very bad function to use in interactive programs because it	1985	This is a very bad function to use in interactive programs because it
1535	blocks, and a bad way to reduce concurrency because it is inexact: Better	1986	blocks, and a bad way to reduce concurrency because it is inexact: Better
1536	use an C<aio_group> together with a feed callback.	1987	use an C<aio_group> together with a feed callback.
1537		1988
1538	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1989	Its main use is in scripts without an event loop - when you want to stat
1539	do queue up more than this number of requests, the next call to the	1990	a lot of files, you can write somehting like this:
1540	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1541	function will block until the limit is no longer exceeded.
1542		1991
1543	The default value is very large, so there is no practical limit on the	1992	IO::AIO::max_outstanding 32;
1544	number of outstanding requests.
1545		1993
1546	You can still queue as many requests as you want. Therefore,	1994	for my $path (...) {
1547	C<max_outstanding> is mainly useful in simple scripts (with low values) or	1995	aio_stat $path , ...;
1548	as a stop gap to shield against fatal memory overflow (with large values).	1996	IO::AIO::poll_cb;
		1997	}
		1998
		1999	IO::AIO::flush;
		2000
		2001	The call to C<poll_cb> inside the loop will normally return instantly, but
		2002	as soon as more thna C<32> reqeusts are in-flight, it will block until
		2003	some requests have been handled. This keeps the loop from pushing a large
		2004	number of C<aio_stat> requests onto the queue.
		2005
		2006	The default value for C<max_outstanding> is very large, so there is no
		2007	practical limit on the number of outstanding requests.
1549		2008
1550	=back	2009	=back
1551		2010
1552	=head3 STATISTICAL INFORMATION	2011	=head3 STATISTICAL INFORMATION
1553		2012
…		…
1575		2034
1576	=back	2035	=back
1577		2036
1578	=head3 MISCELLANEOUS FUNCTIONS	2037	=head3 MISCELLANEOUS FUNCTIONS
1579		2038
1580	IO::AIO implements some functions that might be useful, but are not	2039	IO::AIO implements some functions that are useful when you want to use
1581	asynchronous.	2040	some "Advanced I/O" function not available to in Perl, without going the
		2041	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2042	counterpart.
1582		2043
1583	=over 4	2044	=over 4
1584		2045
1585	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2046	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1586		2047
…		…
1593		2054
1594	=item IO::AIO::fadvise $fh, $offset, $len, $advice	2055	=item IO::AIO::fadvise $fh, $offset, $len, $advice
1595		2056
1596	Simply calls the C<posix_fadvise> function (see its	2057	Simply calls the C<posix_fadvise> function (see its
1597	manpage for details). The following advice constants are	2058	manpage for details). The following advice constants are
1598	avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,	2059	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1599	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,	2060	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1600	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.	2061	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1601		2062
1602	On systems that do not implement C<posix_fadvise>, this function returns	2063	On systems that do not implement C<posix_fadvise>, this function returns
1603	ENOSYS, otherwise the return value of C<posix_fadvise>.	2064	ENOSYS, otherwise the return value of C<posix_fadvise>.
1604		2065
1605	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2066	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1606		2067
1607	Simply calls the C<posix_madvise> function (see its	2068	Simply calls the C<posix_madvise> function (see its
1608	manpage for details). The following advice constants are	2069	manpage for details). The following advice constants are
1609	avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2070	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1610	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2071	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
		2072	C<IO::AIO::MADV_FREE>.
		2073
		2074	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2075	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2076	will be reduced to fit into the C<$scalar>.
1611		2077
1612	On systems that do not implement C<posix_madvise>, this function returns	2078	On systems that do not implement C<posix_madvise>, this function returns
1613	ENOSYS, otherwise the return value of C<posix_madvise>.	2079	ENOSYS, otherwise the return value of C<posix_madvise>.
1614		2080
1615	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2081	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1616		2082
1617	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2083	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1618	$scalar (see its manpage for details). The following protect	2084	$scalar (see its manpage for details). The following protect
1619	constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2085	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1620	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2086	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		2087
		2088	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2089	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2090	will be reduced to fit into the C<$scalar>.
1621		2091
1622	On systems that do not implement C<mprotect>, this function returns	2092	On systems that do not implement C<mprotect>, this function returns
1623	ENOSYS, otherwise the return value of C<mprotect>.	2093	ENOSYS, otherwise the return value of C<mprotect>.
1624		2094
1625	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2095	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1626		2096
1627	Memory-maps a file (or anonymous memory range) and attaches it to the	2097	Memory-maps a file (or anonymous memory range) and attaches it to the
1628	given C<$scalar>, which will act like a string scalar.	2098	given C<$scalar>, which will act like a string scalar. Returns true on
		2099	success, and false otherwise.
1629		2100
		2101	The scalar must exist, but its contents do not matter - this means you
		2102	cannot use a nonexistant array or hash element. When in doubt, C<undef>
		2103	the scalar first.
		2104
1630	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2105	The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1631	change the string length, and most read-only operations such as copying it	2106	which don't change the string length, and most read-only operations such
1632	or searching it with regexes and so on.	2107	as copying it or searching it with regexes and so on.
1633		2108
1634	Anything else is unsafe and will, at best, result in memory leaks.	2109	Anything else is unsafe and will, at best, result in memory leaks.
1635		2110
1636	The memory map associated with the C<$scalar> is automatically removed	2111	The memory map associated with the C<$scalar> is automatically removed
1637	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or	2112	when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1638	C<IO::AIO::munmap> functions are called.	2113	or C<IO::AIO::munmap> functions are called on it.
1639		2114
1640	This calls the C<mmap>(2) function internally. See your system's manual	2115	This calls the C<mmap>(2) function internally. See your system's manual
1641	page for details on the C<$length>, C<$prot> and C<$flags> parameters.	2116	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1642		2117
1643	The C<$length> must be larger than zero and smaller than the actual	2118	The C<$length> must be larger than zero and smaller than the actual
1644	filesize.	2119	filesize.
1645		2120
1646	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2121	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1647	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2122	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1648		2123
1649	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2124	C<$flags> can be a combination of
1650	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2125	C<IO::AIO::MAP_SHARED> or
1651	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2126	C<IO::AIO::MAP_PRIVATE>,
		2127	or a number of system-specific flags (when not available, the are C<0>):
1652	(which is set to C<MAP_ANON> if your system only provides this	2128	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1653	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2129	C<IO::AIO::MAP_LOCKED>,
1654	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2130	C<IO::AIO::MAP_NORESERVE>,
		2131	C<IO::AIO::MAP_POPULATE>,
1655	C<IO::AIO::MAP_NONBLOCK>	2132	C<IO::AIO::MAP_NONBLOCK>,
		2133	C<IO::AIO::MAP_FIXED>,
		2134	C<IO::AIO::MAP_GROWSDOWN>,
		2135	C<IO::AIO::MAP_32BIT>,
		2136	C<IO::AIO::MAP_HUGETLB> or
		2137	C<IO::AIO::MAP_STACK>.
1656		2138
1657	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2139	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1658		2140
1659	C<$offset> is the offset from the start of the file - it generally must be	2141	C<$offset> is the offset from the start of the file - it generally must be
1660	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2142	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
1685		2167
1686	Calls the C<munlockall> function.	2168	Calls the C<munlockall> function.
1687		2169
1688	On systems that do not implement C<munlockall>, this function returns	2170	On systems that do not implement C<munlockall>, this function returns
1689	ENOSYS, otherwise the return value of C<munlockall>.	2171	ENOSYS, otherwise the return value of C<munlockall>.
		2172
		2173	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2174
		2175	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2176	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2177	should be the file offset.
		2178
		2179	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2180	silently corrupt the data in this case.
		2181
		2182	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2183	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2184	C<IO::AIO::SPLICE_F_GIFT>.
		2185
		2186	See the C<splice(2)> manpage for details.
		2187
		2188	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2189
		2190	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2191	description for C<IO::AIO::splice> above for details.
		2192
		2193	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2194
		2195	Attempts to query or change the pipe buffer size. Obviously works only
		2196	on pipes, and currently works only on GNU/Linux systems, and fails with
		2197	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2198	size on other systems, drop me a note.
		2199
		2200	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2201
		2202	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2203	C<$flags> is missing or C<0>, then this should be the same as a call to
		2204	perl's built-in C<pipe> function and create a new pipe, and works on
		2205	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2206	(..., 4096, O_BINARY)>.
		2207
		2208	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2209	the given flags (Linux 2.6.27, glibc 2.9).
		2210
		2211	On success, the read and write file handles are returned.
		2212
		2213	On error, nothing will be returned. If the pipe2 syscall is missing and
		2214	C<$flags> is non-zero, fails with C<ENOSYS>.
		2215
		2216	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2217	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2218	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1690		2219
1691	=back	2220	=back
1692		2221
1693	=cut	2222	=cut
1694		2223
…		…
1729	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>	2258	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1730	\&IO::AIO::poll_cb);	2259	\&IO::AIO::poll_cb);
1731		2260
1732	=head2 FORK BEHAVIOUR	2261	=head2 FORK BEHAVIOUR
1733		2262
1734	This module should do "the right thing" when the process using it forks:	2263	Usage of pthreads in a program changes the semantics of fork
		2264	considerably. Specifically, only async-safe functions can be called after
		2265	fork. Perl doesn't know about this, so in general, you cannot call fork
		2266	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2267	pthreads, so this applies, but many other extensions and (for inexplicable
		2268	reasons) perl itself often is linked against pthreads, so this limitation
		2269	applies to quite a lot of perls.
1735		2270
1736	Before the fork, IO::AIO enters a quiescent state where no requests	2271	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1737	can be added in other threads and no results will be processed. After	2272	only works in the process that loaded it. Forking is fully supported, but
1738	the fork the parent simply leaves the quiescent state and continues	2273	using IO::AIO in the child is not.
1739	request/result processing, while the child frees the request/result queue
1740	(so that the requests started before the fork will only be handled in the
1741	parent). Threads will be started on demand until the limit set in the
1742	parent process has been reached again.
1743		2274
1744	In short: the parent will, after a short pause, continue as if fork had	2275	You might get around by not I<using> IO::AIO before (or after)
1745	not been called, while the child will act as if IO::AIO has not been used	2276	forking. You could also try to call the L<IO::AIO::reinit> function in the
1746	yet.	2277	child:
		2278
		2279	=over 4
		2280
		2281	=item IO::AIO::reinit
		2282
		2283	Abandons all current requests and I/O threads and simply reinitialises all
		2284	data structures. This is not an operation supported by any standards, but
		2285	happens to work on GNU/Linux and some newer BSD systems.
		2286
		2287	The only reasonable use for this function is to call it after forking, if
		2288	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2289	the process will result in undefined behaviour. Calling it at any time
		2290	will also result in any undefined (by POSIX) behaviour.
		2291
		2292	=back
1747		2293
1748	=head2 MEMORY USAGE	2294	=head2 MEMORY USAGE
1749		2295
1750	Per-request usage:	2296	Per-request usage:
1751		2297

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.185 by root, Sat Dec 11 19:06:07 2010 UTC vs. Revision 1.269 by root, Tue Jun 6 04:29:35 2017 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.185 by root, Sat Dec 11 19:06:07 2010 UTC vs.
Revision 1.269 by root, Tue Jun 6 04:29:35 2017 UTC