ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.112 by root, Tue Sep 11 08:25:16 2007 UTC vs.
Revision 1.263 by root, Tue Jul 12 20:46:33 2016 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
9	aio_open "/etc/passwd", O_RDONLY, 0, sub {	9	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10	my $fh = shift	10	my $fh = shift
11	or die "/etc/passwd: $!";	11	or die "/etc/passwd: $!";
12	...	12	...
13	};	13	};
14		14
…		…
26	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
27		27
28	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
29	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
30		30
31	# AnyEvent integration
32	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35	# Event integration
36	Event->io (fd => IO::AIO::poll_fileno,
37	poll => 'r',
38	cb => \&IO::AIO::poll_cb);
39
40	# Glib/Gtk2 integration
41	add_watch Glib::IO IO::AIO::poll_fileno,
42	in => sub { IO::AIO::poll_cb; 1 };
43
44	# Tk integration
45	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
46	readable => \&IO::AIO::poll_cb);
47
48	# Danga::Socket integration
49	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
50	\&IO::AIO::poll_cb);
51
52	=head1 DESCRIPTION	31	=head1 DESCRIPTION
53		32
54	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
55	operating system supports.	34	operating system supports. It is implemented as an interface to C<libeio>
		35	(L<http://software.schmorp.de/pkg/libeio.html>).
56		36
57	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
58	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
59	will still block, but you can do something else in the meantime. This	39	will still block, but you can do something else in the meantime. This
60	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
64	on a RAID volume or over NFS when you do a number of stat operations	44	on a RAID volume or over NFS when you do a number of stat operations
65	concurrently.	45	concurrently.
66		46
67	While most of this works on all types of file descriptors (for	47	While most of this works on all types of file descriptors (for
68	example sockets), using these functions on file descriptors that	48	example sockets), using these functions on file descriptors that
69	support nonblocking operation (again, sockets, pipes etc.) is very	49	support nonblocking operation (again, sockets, pipes etc.) is
70	inefficient. Use an event loop for that (such as the L<Event|Event>	50	very inefficient. Use an event loop for that (such as the L<EV>
71	module): IO::AIO will naturally fit into such an event loop itself.	51	module): IO::AIO will naturally fit into such an event loop itself.
72		52
73	In this version, a number of threads are started that execute your	53	In this version, a number of threads are started that execute your
74	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
75	in perl, and the threads created by this module will not be visible	55	in perl, and the threads created by this module will not be visible
…		…
85	yourself, always call C<poll_cb> from within the same thread, or never	65	yourself, always call C<poll_cb> from within the same thread, or never
86	call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
87		67
88	=head2 EXAMPLE	68	=head2 EXAMPLE
89		69
90	This is a simple example that uses the Event module and loads	70	This is a simple example that uses the EV module and loads
91	F</etc/passwd> asynchronously:	71	F</etc/passwd> asynchronously:
92		72
93	use Fcntl;
94	use Event;	73	use EV;
95	use IO::AIO;	74	use IO::AIO;
96		75
97	# register the IO::AIO callback with Event	76	# register the IO::AIO callback with EV
98	Event->io (fd => IO::AIO::poll_fileno,	77	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
99	poll => 'r',
100	cb => \&IO::AIO::poll_cb);
101		78
102	# queue the request to open /etc/passwd	79	# queue the request to open /etc/passwd
103	aio_open "/etc/passwd", O_RDONLY, 0, sub {	80	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
104	my $fh = shift	81	my $fh = shift
105	or die "error while opening: $!";	82	or die "error while opening: $!";
106		83
107	# stat'ing filehandles is generally non-blocking	84	# stat'ing filehandles is generally non-blocking
108	my $size = -s $fh;	85	my $size = -s $fh;
…		…
117		94
118	# file contents now in $contents	95	# file contents now in $contents
119	print $contents;	96	print $contents;
120		97
121	# exit event loop and program	98	# exit event loop and program
122	Event::unloop;	99	EV::break;
123	};	100	};
124	};	101	};
125		102
126	# possibly queue up other requests, or open GUI windows,	103	# possibly queue up other requests, or open GUI windows,
127	# check for sockets etc. etc.	104	# check for sockets etc. etc.
128		105
129	# process events as long as there are some:	106	# process events as long as there are some:
130	Event::loop;	107	EV::run;
131		108
132	=head1 REQUEST ANATOMY AND LIFETIME	109	=head1 REQUEST ANATOMY AND LIFETIME
133		110
134	Every C<aio_*> function creates a request. which is a C data structure not	111	Every C<aio_*> function creates a request. which is a C data structure not
135	directly visible to Perl.	112	directly visible to Perl.
…		…
183		160
184	=cut	161	=cut
185		162
186	package IO::AIO;	163	package IO::AIO;
187		164
188	no warnings;	165	use Carp ();
189	use strict 'vars';	166
		167	use common::sense;
190		168
191	use base 'Exporter';	169	use base 'Exporter';
192		170
193	BEGIN {	171	BEGIN {
194	our $VERSION = '2.4';	172	our $VERSION = 4.34;
195		173
196	our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat	174	our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
197	aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink	175	aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
198	aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link	176	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
		177	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
		178	aio_pathsync aio_readahead aio_fiemap aio_allocate
		179	aio_rename aio_link aio_move aio_copy aio_group
199	aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir	180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200	aio_chown aio_chmod aio_utime aio_truncate);	181	aio_chmod aio_utime aio_truncate
		182	aio_msync aio_mtouch aio_mlock aio_mlockall
		183	aio_statvfs
		184	aio_wd);
		185
201	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));	186	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	187	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203	min_parallel max_parallel max_idle	188	min_parallel max_parallel max_idle idle_timeout
204	nreqs nready npending nthreads	189	nreqs nready npending nthreads
205	max_poll_time max_poll_reqs);	190	max_poll_time max_poll_reqs
		191	sendfile fadvise madvise
		192	mmap munmap munlock munlockall);
		193
		194	push @AIO_REQ, qw(aio_busy); # not exported
206		195
207	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	196	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208		197
209	require XSLoader;	198	require XSLoader;
210	XSLoader::load ("IO::AIO", $VERSION);	199	XSLoader::load ("IO::AIO", $VERSION);
211	}	200	}
212		201
213	=head1 FUNCTIONS	202	=head1 FUNCTIONS
214		203
215	=head2 AIO REQUEST FUNCTIONS	204	=head2 QUICK OVERVIEW
		205
		206	This section simply lists the prototypes most of the functions for
		207	quick reference. See the following sections for function-by-function
		208	documentation.
		209
		210	aio_wd $pathname, $callback->($wd)
		211	aio_open $pathname, $flags, $mode, $callback->($fh)
		212	aio_close $fh, $callback->($status)
		213	aio_seek $fh,$offset,$whence, $callback->($offs)
		214	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		215	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		216	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		217	aio_readahead $fh,$offset,$length, $callback->($retval)
		218	aio_stat $fh_or_path, $callback->($status)
		219	aio_lstat $fh, $callback->($status)
		220	aio_statvfs $fh_or_path, $callback->($statvfs)
		221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		223	aio_chmod $fh_or_path, $mode, $callback->($status)
		224	aio_truncate $fh_or_path, $offset, $callback->($status)
		225	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		226	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		227	aio_unlink $pathname, $callback->($status)
		228	aio_mknod $pathname, $mode, $dev, $callback->($status)
		229	aio_link $srcpath, $dstpath, $callback->($status)
		230	aio_symlink $srcpath, $dstpath, $callback->($status)
		231	aio_readlink $pathname, $callback->($link)
		232	aio_realpath $pathname, $callback->($path)
		233	aio_rename $srcpath, $dstpath, $callback->($status)
		234	aio_mkdir $pathname, $mode, $callback->($status)
		235	aio_rmdir $pathname, $callback->($status)
		236	aio_readdir $pathname, $callback->($entries)
		237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		238	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		239	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		240	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
		241	aio_load $pathname, $data, $callback->($status)
		242	aio_copy $srcpath, $dstpath, $callback->($status)
		243	aio_move $srcpath, $dstpath, $callback->($status)
		244	aio_rmtree $pathname, $callback->($status)
		245	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		246	aio_ioctl $fh, $request, $buf, $callback->($status)
		247	aio_sync $callback->($status)
		248	aio_syncfs $fh, $callback->($status)
		249	aio_fsync $fh, $callback->($status)
		250	aio_fdatasync $fh, $callback->($status)
		251	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		252	aio_pathsync $pathname, $callback->($status)
		253	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		254	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		255	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		256	aio_mlockall $flags, $callback->($status)
		257	aio_group $callback->(...)
		258	aio_nop $callback->()
		259
		260	$prev_pri = aioreq_pri [$pri]
		261	aioreq_nice $pri_adjust
		262
		263	IO::AIO::poll_wait
		264	IO::AIO::poll_cb
		265	IO::AIO::poll
		266	IO::AIO::flush
		267	IO::AIO::max_poll_reqs $nreqs
		268	IO::AIO::max_poll_time $seconds
		269	IO::AIO::min_parallel $nthreads
		270	IO::AIO::max_parallel $nthreads
		271	IO::AIO::max_idle $nthreads
		272	IO::AIO::idle_timeout $seconds
		273	IO::AIO::max_outstanding $maxreqs
		274	IO::AIO::nreqs
		275	IO::AIO::nready
		276	IO::AIO::npending
		277
		278	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		279	IO::AIO::fadvise $fh, $offset, $len, $advice
		280	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		281	IO::AIO::munmap $scalar
		282	IO::AIO::madvise $scalar, $offset, $length, $advice
		283	IO::AIO::mprotect $scalar, $offset, $length, $protect
		284	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		285	IO::AIO::munlockall
		286
		287	=head2 API NOTES
216		288
217	All the C<aio_*> calls are more or less thin wrappers around the syscall	289	All the C<aio_*> calls are more or less thin wrappers around the syscall
218	with the same name (sans C<aio_>). The arguments are similar or identical,	290	with the same name (sans C<aio_>). The arguments are similar or identical,
219	and they all accept an additional (and optional) C<$callback> argument	291	and they all accept an additional (and optional) C<$callback> argument
220	which must be a code reference. This code reference will get called with	292	which must be a code reference. This code reference will be called after
221	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	293	the syscall has been executed in an asynchronous fashion. The results
222	perl, which usually delivers "false") as it's sole argument when the given	294	of the request will be passed as arguments to the callback (and, if an
223	syscall has been executed asynchronously.	295	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		296	most syscalls return C<-1> on error, unlike perl, which usually delivers
		297	"false").
		298
		299	Some requests (such as C<aio_readdir>) pass the actual results and
		300	communicate failures by passing C<undef>.
224		301
225	All functions expecting a filehandle keep a copy of the filehandle	302	All functions expecting a filehandle keep a copy of the filehandle
226	internally until the request has finished.	303	internally until the request has finished.
227		304
228	All functions return request objects of type L<IO::AIO::REQ> that allow	305	All functions return request objects of type L<IO::AIO::REQ> that allow
229	further manipulation of those requests while they are in-flight.	306	further manipulation of those requests while they are in-flight.
230		307
231	The pathnames you pass to these routines I<must> be absolute and	308	The pathnames you pass to these routines I<should> be absolute. The
232	encoded as octets. The reason for the former is that at the time the	309	reason for this is that at the time the request is being executed, the
233	request is being executed, the current working directory could have	310	current working directory could have changed. Alternatively, you can
234	changed. Alternatively, you can make sure that you never change the	311	make sure that you never change the current working directory anywhere
235	current working directory anywhere in the program and then use relative	312	in the program and then use relative paths. You can also take advantage
236	paths.	313	of IO::AIOs working directory abstraction, that lets you specify paths
		314	relative to some previously-opened "working directory object" - see the
		315	description of the C<IO::AIO::WD> class later in this document.
237		316
238	To encode pathnames as octets, either make sure you either: a) always pass	317	To encode pathnames as octets, either make sure you either: a) always pass
239	in filenames you got from outside (command line, readdir etc.) without	318	in filenames you got from outside (command line, readdir etc.) without
240	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	319	tinkering, b) are in your native filesystem encoding, c) use the Encode
241	your pathnames to the locale (or other) encoding in effect in the user	320	module and encode your pathnames to the locale (or other) encoding in
242	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	321	effect in the user environment, d) use Glib::filename_from_unicode on
243	use something else to ensure your scalar has the correct contents.	322	unicode filenames or e) use something else to ensure your scalar has the
		323	correct contents.
244		324
245	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	325	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246	handles correctly wether it is set or not.	326	handles correctly whether it is set or not.
		327
		328	=head2 AIO REQUEST FUNCTIONS
247		329
248	=over 4	330	=over 4
249		331
250	=item $prev_pri = aioreq_pri [$pri]	332	=item $prev_pri = aioreq_pri [$pri]
251		333
…		…
281		363
282		364
283	=item aio_open $pathname, $flags, $mode, $callback->($fh)	365	=item aio_open $pathname, $flags, $mode, $callback->($fh)
284		366
285	Asynchronously open or create a file and call the callback with a newly	367	Asynchronously open or create a file and call the callback with a newly
286	created filehandle for the file.	368	created filehandle for the file (or C<undef> in case of an error).
287		369
288	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	370	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
289	for an explanation.	371	for an explanation.
290		372
291	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	373	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
298	by the umask in effect then the request is being executed, so better never	380	by the umask in effect then the request is being executed, so better never
299	change the umask.	381	change the umask.
300		382
301	Example:	383	Example:
302		384
303	aio_open "/etc/passwd", O_RDONLY, 0, sub {	385	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
304	if ($_[0]) {	386	if ($_[0]) {
305	print "open successful, fh is $_[0]\n";	387	print "open successful, fh is $_[0]\n";
306	...	388	...
307	} else {	389	} else {
308	die "open failed: $!\n";	390	die "open failed: $!\n";
309	}	391	}
310	};	392	};
311		393
		394	In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
		395	C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
		396	following POSIX and non-POSIX constants are available (missing ones on
		397	your system are, as usual, C<0>):
		398
		399	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
		400	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
		401	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
		402
312		403
313	=item aio_close $fh, $callback->($status)	404	=item aio_close $fh, $callback->($status)
314		405
315	Asynchronously close a file and call the callback with the result	406	Asynchronously close a file and call the callback with the result
316	code. I<WARNING:> although accepted, you should not pass in a perl	407	code.
317	filehandle here, as perl will likely close the file descriptor another
318	time when the filehandle is destroyed. Normally, you can safely call perls
319	C<close> or just let filehandles go out of scope.
320		408
321	This is supposed to be a bug in the API, so that might change. It's	409	Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322	therefore best to avoid this function.	410	closing the file descriptor associated with the filehandle itself.
323		411
		412	Therefore, C<aio_close> will not close the filehandle - instead it will
		413	use dup2 to overwrite the file descriptor with the write-end of a pipe
		414	(the pipe fd will be created on demand and will be cached).
		415
		416	Or in other words: the file descriptor will be closed, but it will not be
		417	free for reuse until the perl filehandle is closed.
		418
		419	=cut
		420
		421	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		422
		423	Seeks the filehandle to the new C<$offset>, similarly to perl's
		424	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		425	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		426	C<IO::AIO::SEEK_END>).
		427
		428	The resulting absolute offset will be passed to the callback, or C<-1> in
		429	case of an error.
		430
		431	In theory, the C<$whence> constants could be different than the
		432	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		433	so don't panic.
		434
		435	As a GNU/Linux (and maybe Solaris) extension, also the constants
		436	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		437	could be found. No guarantees about suitability for use in C<aio_seek> or
		438	Perl's C<sysseek> can be made though, although I would naively assume they
		439	"just work".
324		440
325	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	441	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326		442
327	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	443	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328		444
329	Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>	445	Reads or writes C<$length> bytes from or to the specified C<$fh> and
330	into the scalar given by C<$data> and offset C<$dataoffset> and calls the	446	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
331	callback without the actual number of bytes read (or -1 on error, just	447	and calls the callback without the actual number of bytes read (or -1 on
332	like the syscall).	448	error, just like the syscall).
		449
		450	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
		451	offset plus the actual number of bytes read.
333		452
334	If C<$offset> is undefined, then the current file descriptor offset will	453	If C<$offset> is undefined, then the current file descriptor offset will
335	be used (and updated), otherwise the file descriptor offset will not be	454	be used (and updated), otherwise the file descriptor offset will not be
336	changed by these calls.	455	changed by these calls.
337		456
338	If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.	457	If C<$length> is undefined in C<aio_write>, use the remaining length of
		458	C<$data>.
339		459
340	If C<$dataoffset> is less than zero, it will be counted from the end of	460	If C<$dataoffset> is less than zero, it will be counted from the end of
341	C<$data>.	461	C<$data>.
342		462
343	The C<$data> scalar I<MUST NOT> be modified in any way while the request	463	The C<$data> scalar I<MUST NOT> be modified in any way while the request
…		…
357		477
358	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts	478	Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
359	reading at byte offset C<$in_offset>, and starts writing at the current	479	reading at byte offset C<$in_offset>, and starts writing at the current
360	file offset of C<$out_fh>. Because of that, it is not safe to issue more	480	file offset of C<$out_fh>. Because of that, it is not safe to issue more
361	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each	481	than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
362	other.	482	other. The same C<$in_fh> works fine though, as this function does not
		483	move or use the file offset of C<$in_fh>.
363		484
		485	Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
		486	are written, and there is no way to find out how many more bytes have been
		487	read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
		488	number of bytes written to C<$out_fh>. Only if the result value equals
		489	C<$length> one can assume that C<$length> bytes have been read.
		490
		491	Unlike with other C<aio_> functions, it makes a lot of sense to use
		492	C<aio_sendfile> on non-blocking sockets, as long as one end (typically
		493	the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
		494	the socket I/O will be non-blocking. Note, however, that you can run
		495	into a trap where C<aio_sendfile> reads some data with readahead, then
		496	fails to write all data, and when the socket is ready the next time, the
		497	data in the cache is already lost, forcing C<aio_sendfile> to again hit
		498	the disk. Explicit C<aio_read> + C<aio_write> let's you better control
		499	resource usage.
		500
364	This call tries to make use of a native C<sendfile> syscall to provide	501	This call tries to make use of a native C<sendfile>-like syscall to
365	zero-copy operation. For this to work, C<$out_fh> should refer to a	502	provide zero-copy operation. For this to work, C<$out_fh> should refer to
366	socket, and C<$in_fh> should refer to mmap'able file.	503	a socket, and C<$in_fh> should refer to an mmap'able file.
367		504
368	If the native sendfile call fails or is not implemented, it will be	505	If a native sendfile cannot be found or it fails with C<ENOSYS>,
369	emulated, so you can call C<aio_sendfile> on any type of filehandle	506	C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
		507	C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
370	regardless of the limitations of the operating system.	508	type of filehandle regardless of the limitations of the operating system.
371		509
372	Please note, however, that C<aio_sendfile> can read more bytes from	510	As native sendfile syscalls (as practically any non-POSIX interface hacked
373	C<$in_fh> than are written, and there is no way to find out how many	511	together in a hurry to improve benchmark numbers) tend to be rather buggy
374	bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only	512	on many systems, this implementation tries to work around some known bugs
375	provides the number of bytes written to C<$out_fh>. Only if the result	513	in Linux and FreeBSD kernels (probably others, too), but that might fail,
376	value equals C<$length> one can assume that C<$length> bytes have been	514	so you really really should check the return value of C<aio_sendfile> -
377	read.	515	fewer bytes than expected might have been transferred.
378		516
379		517
380	=item aio_readahead $fh,$offset,$length, $callback->($retval)	518	=item aio_readahead $fh,$offset,$length, $callback->($retval)
381		519
382	C<aio_readahead> populates the page cache with data from a file so that	520	C<aio_readahead> populates the page cache with data from a file so that
…		…
386	whole pages, so that offset is effectively rounded down to a page boundary	524	whole pages, so that offset is effectively rounded down to a page boundary
387	and bytes are read up to the next page boundary greater than or equal to	525	and bytes are read up to the next page boundary greater than or equal to
388	(off-set+length). C<aio_readahead> does not read beyond the end of the	526	(off-set+length). C<aio_readahead> does not read beyond the end of the
389	file. The current file offset of the file is left unchanged.	527	file. The current file offset of the file is left unchanged.
390		528
391	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	529	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
392	emulated by simply reading the data, which would have a similar effect.	530	be emulated by simply reading the data, which would have a similar effect.
393		531
394		532
395	=item aio_stat $fh_or_path, $callback->($status)	533	=item aio_stat $fh_or_path, $callback->($status)
396		534
397	=item aio_lstat $fh, $callback->($status)	535	=item aio_lstat $fh, $callback->($status)
…		…
404	for an explanation.	542	for an explanation.
405		543
406	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	544	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
407	error when stat'ing a large file, the results will be silently truncated	545	error when stat'ing a large file, the results will be silently truncated
408	unless perl itself is compiled with large file support.	546	unless perl itself is compiled with large file support.
		547
		548	To help interpret the mode and dev/rdev stat values, IO::AIO offers the
		549	following constants and functions (if not implemented, the constants will
		550	be C<0> and the functions will either C<croak> or fall back on traditional
		551	behaviour).
		552
		553	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
		554	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
		555	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
409		556
410	Example: Print the length of F</etc/passwd>:	557	Example: Print the length of F</etc/passwd>:
411		558
412	aio_stat "/etc/passwd", sub {	559	aio_stat "/etc/passwd", sub {
413	$_[0] and die "stat failed: $!";	560	$_[0] and die "stat failed: $!";
414	print "size is ", -s _, "\n";	561	print "size is ", -s _, "\n";
415	};	562	};
416		563
417		564
		565	=item aio_statvfs $fh_or_path, $callback->($statvfs)
		566
		567	Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
		568	whether a file handle or path was passed.
		569
		570	On success, the callback is passed a hash reference with the following
		571	members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
		572	C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
		573	is passed.
		574
		575	The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
		576	C<ST_NOSUID>.
		577
		578	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		579	their correct value when available, or to C<0> on systems that do
		580	not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
		581	C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
		582	C<ST_NODIRATIME> and C<ST_RELATIME>.
		583
		584	Example: stat C</wd> and dump out the data if successful.
		585
		586	aio_statvfs "/wd", sub {
		587	my $f = $_[0]
		588	or die "statvfs: $!";
		589
		590	use Data::Dumper;
		591	say Dumper $f;
		592	};
		593
		594	# result:
		595	{
		596	bsize => 1024,
		597	bfree => 4333064312,
		598	blocks => 10253828096,
		599	files => 2050765568,
		600	flag => 4096,
		601	favail => 2042092649,
		602	bavail => 4333064312,
		603	ffree => 2042092649,
		604	namemax => 255,
		605	frsize => 1024,
		606	fsid => 1810
		607	}
		608
		609	Here is a (likely partial - send me updates!) list of fsid values used by
		610	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		611
		612	0x0000adf5 adfs
		613	0x0000adff affs
		614	0x5346414f afs
		615	0x09041934 anon-inode filesystem
		616	0x00000187 autofs
		617	0x42465331 befs
		618	0x1badface bfs
		619	0x42494e4d binfmt_misc
		620	0x9123683e btrfs
		621	0x0027e0eb cgroupfs
		622	0xff534d42 cifs
		623	0x73757245 coda
		624	0x012ff7b7 coh
		625	0x28cd3d45 cramfs
		626	0x453dcd28 cramfs-wend (wrong endianness)
		627	0x64626720 debugfs
		628	0x00001373 devfs
		629	0x00001cd1 devpts
		630	0x0000f15f ecryptfs
		631	0x00414a53 efs
		632	0x0000137d ext
		633	0x0000ef53 ext2/ext3/ext4
		634	0x0000ef51 ext2
		635	0xf2f52010 f2fs
		636	0x00004006 fat
		637	0x65735546 fuseblk
		638	0x65735543 fusectl
		639	0x0bad1dea futexfs
		640	0x01161970 gfs2
		641	0x47504653 gpfs
		642	0x00004244 hfs
		643	0xf995e849 hpfs
		644	0x00c0ffee hostfs
		645	0x958458f6 hugetlbfs
		646	0x2bad1dea inotifyfs
		647	0x00009660 isofs
		648	0x000072b6 jffs2
		649	0x3153464a jfs
		650	0x6b414653 k-afs
		651	0x0bd00bd0 lustre
		652	0x0000137f minix
		653	0x0000138f minix 30 char names
		654	0x00002468 minix v2
		655	0x00002478 minix v2 30 char names
		656	0x00004d5a minix v3
		657	0x19800202 mqueue
		658	0x00004d44 msdos
		659	0x0000564c novell
		660	0x00006969 nfs
		661	0x6e667364 nfsd
		662	0x00003434 nilfs
		663	0x5346544e ntfs
		664	0x00009fa1 openprom
		665	0x7461636F ocfs2
		666	0x00009fa0 proc
		667	0x6165676c pstorefs
		668	0x0000002f qnx4
		669	0x68191122 qnx6
		670	0x858458f6 ramfs
		671	0x52654973 reiserfs
		672	0x00007275 romfs
		673	0x67596969 rpc_pipefs
		674	0x73636673 securityfs
		675	0xf97cff8c selinux
		676	0x0000517b smb
		677	0x534f434b sockfs
		678	0x73717368 squashfs
		679	0x62656572 sysfs
		680	0x012ff7b6 sysv2
		681	0x012ff7b5 sysv4
		682	0x01021994 tmpfs
		683	0x15013346 udf
		684	0x00011954 ufs
		685	0x54190100 ufs byteswapped
		686	0x00009fa2 usbdevfs
		687	0x01021997 v9fs
		688	0xa501fcf5 vxfs
		689	0xabba1974 xenfs
		690	0x012ff7b4 xenix
		691	0x58465342 xfs
		692	0x012fd16d xia
		693
418	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	694	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
419		695
420	Works like perl's C<utime> function (including the special case of $atime	696	Works like perl's C<utime> function (including the special case of $atime
421	and $mtime being undef). Fractional times are supported if the underlying	697	and $mtime being undef). Fractional times are supported if the underlying
422	syscalls support them.	698	syscalls support them.
…		…
449	=item aio_truncate $fh_or_path, $offset, $callback->($status)	725	=item aio_truncate $fh_or_path, $offset, $callback->($status)
450		726
451	Works like truncate(2) or ftruncate(2).	727	Works like truncate(2) or ftruncate(2).
452		728
453		729
		730	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		731
		732	Allocates or frees disk space according to the C<$mode> argument. See the
		733	linux C<fallocate> documentation for details.
		734
		735	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		736	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
		737	to deallocate a file range.
		738
		739	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		740	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
		741	your L<fallocate(2)> manpage).
		742
		743	The file system block size used by C<fallocate> is presumably the
		744	C<f_bsize> returned by C<statvfs>.
		745
		746	If C<fallocate> isn't available or cannot be emulated (currently no
		747	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		748
		749
454	=item aio_chmod $fh_or_path, $mode, $callback->($status)	750	=item aio_chmod $fh_or_path, $mode, $callback->($status)
455		751
456	Works like perl's C<chmod> function.	752	Works like perl's C<chmod> function.
457		753
458		754
…		…
460		756
461	Asynchronously unlink (delete) a file and call the callback with the	757	Asynchronously unlink (delete) a file and call the callback with the
462	result code.	758	result code.
463		759
464		760
465	=item aio_mknod $path, $mode, $dev, $callback->($status)	761	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
466		762
467	[EXPERIMENTAL]	763	[EXPERIMENTAL]
468		764
469	Asynchronously create a device node (or fifo). See mknod(2).	765	Asynchronously create a device node (or fifo). See mknod(2).
470		766
471	The only (POSIX-) portable way of calling this function is:	767	The only (POSIX-) portable way of calling this function is:
472		768
473	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	769	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
474		770
		771	See C<aio_stat> for info about some potentially helpful extra constants
		772	and functions.
475		773
476	=item aio_link $srcpath, $dstpath, $callback->($status)	774	=item aio_link $srcpath, $dstpath, $callback->($status)
477		775
478	Asynchronously create a new link to the existing object at C<$srcpath> at	776	Asynchronously create a new link to the existing object at C<$srcpath> at
479	the path C<$dstpath> and call the callback with the result code.	777	the path C<$dstpath> and call the callback with the result code.
…		…
483		781
484	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	782	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
485	the path C<$dstpath> and call the callback with the result code.	783	the path C<$dstpath> and call the callback with the result code.
486		784
487		785
488	=item aio_readlink $path, $callback->($link)	786	=item aio_readlink $pathname, $callback->($link)
489		787
490	Asynchronously read the symlink specified by C<$path> and pass it to	788	Asynchronously read the symlink specified by C<$path> and pass it to
491	the callback. If an error occurs, nothing or undef gets passed to the	789	the callback. If an error occurs, nothing or undef gets passed to the
492	callback.	790	callback.
493		791
494		792
		793	=item aio_realpath $pathname, $callback->($path)
		794
		795	Asynchronously make the path absolute and resolve any symlinks in
		796	C<$path>. The resulting path only consists of directories (same as
		797	L<Cwd::realpath>).
		798
		799	This request can be used to get the absolute path of the current working
		800	directory by passing it a path of F<.> (a single dot).
		801
		802
495	=item aio_rename $srcpath, $dstpath, $callback->($status)	803	=item aio_rename $srcpath, $dstpath, $callback->($status)
496		804
497	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	805	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
498	rename(2) and call the callback with the result code.	806	rename(2) and call the callback with the result code.
		807
		808	On systems that support the AIO::WD working directory abstraction
		809	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		810	of failing, C<rename> is called on the absolute path of C<$wd>.
499		811
500		812
501	=item aio_mkdir $pathname, $mode, $callback->($status)	813	=item aio_mkdir $pathname, $mode, $callback->($status)
502		814
503	Asynchronously mkdir (create) a directory and call the callback with	815	Asynchronously mkdir (create) a directory and call the callback with
…		…
508	=item aio_rmdir $pathname, $callback->($status)	820	=item aio_rmdir $pathname, $callback->($status)
509		821
510	Asynchronously rmdir (delete) a directory and call the callback with the	822	Asynchronously rmdir (delete) a directory and call the callback with the
511	result code.	823	result code.
512		824
		825	On systems that support the AIO::WD working directory abstraction
		826	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		827	C<rmdir> is called on the absolute path of C<$wd>.
		828
513		829
514	=item aio_readdir $pathname, $callback->($entries)	830	=item aio_readdir $pathname, $callback->($entries)
515		831
516	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	832	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
517	directory (i.e. opendir + readdir + closedir). The entries will not be	833	directory (i.e. opendir + readdir + closedir). The entries will not be
518	sorted, and will B<NOT> include the C<.> and C<..> entries.	834	sorted, and will B<NOT> include the C<.> and C<..> entries.
519		835
520	The callback a single argument which is either C<undef> or an array-ref	836	The callback is passed a single argument which is either C<undef> or an
521	with the filenames.	837	array-ref with the filenames.
522		838
523		839
		840	=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		841
		842	Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
		843	tune behaviour and output format. In case of an error, C<$entries> will be
		844	C<undef>.
		845
		846	The flags are a combination of the following constants, ORed together (the
		847	flags will also be passed to the callback, possibly modified):
		848
		849	=over 4
		850
		851	=item IO::AIO::READDIR_DENTS
		852
		853	When this flag is off, then the callback gets an arrayref consisting of
		854	names only (as with C<aio_readdir>), otherwise it gets an arrayref with
		855	C<[$name, $type, $inode]> arrayrefs, each describing a single directory
		856	entry in more detail.
		857
		858	C<$name> is the name of the entry.
		859
		860	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
		861
		862	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
		863	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
		864	C<IO::AIO::DT_WHT>.
		865
		866	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
		867	know, you have to run stat yourself. Also, for speed reasons, the C<$type>
		868	scalars are read-only: you can not modify them.
		869
		870	C<$inode> is the inode number (which might not be exact on systems with 64
		871	bit inode numbers and 32 bit perls). This field has unspecified content on
		872	systems that do not deliver the inode information.
		873
		874	=item IO::AIO::READDIR_DIRS_FIRST
		875
		876	When this flag is set, then the names will be returned in an order where
		877	likely directories come first, in optimal stat order. This is useful when
		878	you need to quickly find directories, or you want to find all directories
		879	while avoiding to stat() each entry.
		880
		881	If the system returns type information in readdir, then this is used
		882	to find directories directly. Otherwise, likely directories are names
		883	beginning with ".", or otherwise names with no dots, of which names with
		884	short names are tried first.
		885
		886	=item IO::AIO::READDIR_STAT_ORDER
		887
		888	When this flag is set, then the names will be returned in an order
		889	suitable for stat()'ing each one. That is, when you plan to stat()
		890	all files in the given directory, then the returned order will likely
		891	be fastest.
		892
		893	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
		894	the likely dirs come first, resulting in a less optimal stat order.
		895
		896	=item IO::AIO::READDIR_FOUND_UNKNOWN
		897
		898	This flag should not be set when calling C<aio_readdirx>. Instead, it
		899	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
		900	C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
		901	C<$type>'s are known, which can be used to speed up some algorithms.
		902
		903	=back
		904
		905
524	=item aio_load $path, $data, $callback->($status)	906	=item aio_load $pathname, $data, $callback->($status)
525		907
526	This is a composite request that tries to fully load the given file into	908	This is a composite request that tries to fully load the given file into
527	memory. Status is the same as with aio_read.	909	memory. Status is the same as with aio_read.
528		910
529	=cut	911	=cut
530		912
531	sub aio_load($$;$) {	913	sub aio_load($$;$) {
532	aio_block {
533	my ($path, undef, $cb) = @_;	914	my ($path, undef, $cb) = @_;
534	my $data = \$_[1];	915	my $data = \$_[1];
535		916
536	my $pri = aioreq_pri;	917	my $pri = aioreq_pri;
537	my $grp = aio_group $cb;	918	my $grp = aio_group $cb;
		919
		920	aioreq_pri $pri;
		921	add $grp aio_open $path, O_RDONLY, 0, sub {
		922	my $fh = shift
		923	or return $grp->result (-1);
538		924
539	aioreq_pri $pri;	925	aioreq_pri $pri;
540	add $grp aio_open $path, O_RDONLY, 0, sub {
541	my $fh = shift
542	or return $grp->result (-1);
543
544	aioreq_pri $pri;
545	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {	926	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
546	$grp->result ($_[0]);	927	$grp->result ($_[0]);
547	};
548	};	928	};
549
550	$grp
551	}	929	};
		930
		931	$grp
552	}	932	}
553		933
554	=item aio_copy $srcpath, $dstpath, $callback->($status)	934	=item aio_copy $srcpath, $dstpath, $callback->($status)
555		935
556	Try to copy the I<file> (directories not supported as either source or	936	Try to copy the I<file> (directories not supported as either source or
557	destination) from C<$srcpath> to C<$dstpath> and call the callback with	937	destination) from C<$srcpath> to C<$dstpath> and call the callback with
558	the C<0> (error) or C<-1> ok.	938	a status of C<0> (ok) or C<-1> (error, see C<$!>).
559		939
560	This is a composite request that it creates the destination file with	940	This is a composite request that creates the destination file with
561	mode 0200 and copies the contents of the source file into it using	941	mode 0200 and copies the contents of the source file into it using
562	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	942	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
563	uid/gid, in that order.	943	uid/gid, in that order.
564		944
565	If an error occurs, the partial destination file will be unlinked, if	945	If an error occurs, the partial destination file will be unlinked, if
…		…
567	errors are being ignored.	947	errors are being ignored.
568		948
569	=cut	949	=cut
570		950
571	sub aio_copy($$;$) {	951	sub aio_copy($$;$) {
572	aio_block {
573	my ($src, $dst, $cb) = @_;	952	my ($src, $dst, $cb) = @_;
574		953
575	my $pri = aioreq_pri;	954	my $pri = aioreq_pri;
576	my $grp = aio_group $cb;	955	my $grp = aio_group $cb;
577		956
578	aioreq_pri $pri;	957	aioreq_pri $pri;
579	add $grp aio_open $src, O_RDONLY, 0, sub {	958	add $grp aio_open $src, O_RDONLY, 0, sub {
580	if (my $src_fh = $_[0]) {	959	if (my $src_fh = $_[0]) {
581	my @stat = stat $src_fh;	960	my @stat = stat $src_fh; # hmm, might block over nfs?
582		961
583	aioreq_pri $pri;	962	aioreq_pri $pri;
584	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {	963	add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
585	if (my $dst_fh = $_[0]) {	964	if (my $dst_fh = $_[0]) {
586	aioreq_pri $pri;	965	aioreq_pri $pri;
587	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {	966	add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
588	if ($_[0] == $stat[7]) {	967	if ($_[0] == $stat[7]) {
589	$grp->result (0);	968	$grp->result (0);
590	close $src_fh;	969	close $src_fh;
591		970
592	# those should not normally block. should. should.
593	utime $stat[8], $stat[9], $dst;
594	chmod $stat[2] & 07777, $dst_fh;
595	chown $stat[4], $stat[5], $dst_fh;
596	close $dst_fh;
597	} else {	971	my $ch = sub {
598	$grp->result (-1);
599	close $src_fh;
600	close $dst_fh;
601
602	aioreq $pri;	972	aioreq_pri $pri;
		973	add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
		974	aioreq_pri $pri;
		975	add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
		976	aioreq_pri $pri;
603	add $grp aio_unlink $dst;	977	add $grp aio_close $dst_fh;
		978	}
		979	};
604	}	980	};
		981
		982	aioreq_pri $pri;
		983	add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
		984	if ($_[0] < 0 && $! == ENOSYS) {
		985	aioreq_pri $pri;
		986	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
		987	} else {
		988	$ch->();
		989	}
		990	};
		991	} else {
		992	$grp->result (-1);
		993	close $src_fh;
		994	close $dst_fh;
		995
		996	aioreq $pri;
		997	add $grp aio_unlink $dst;
605	};	998	}
606	} else {
607	$grp->result (-1);
608	}	999	};
		1000	} else {
		1001	$grp->result (-1);
609	},	1002	}
610
611	} else {
612	$grp->result (-1);
613	}	1003	},
		1004
		1005	} else {
		1006	$grp->result (-1);
614	};	1007	}
615
616	$grp
617	}	1008	};
		1009
		1010	$grp
618	}	1011	}
619		1012
620	=item aio_move $srcpath, $dstpath, $callback->($status)	1013	=item aio_move $srcpath, $dstpath, $callback->($status)
621		1014
622	Try to move the I<file> (directories not supported as either source or	1015	Try to move the I<file> (directories not supported as either source or
623	destination) from C<$srcpath> to C<$dstpath> and call the callback with	1016	destination) from C<$srcpath> to C<$dstpath> and call the callback with
624	the C<0> (error) or C<-1> ok.	1017	a status of C<0> (ok) or C<-1> (error, see C<$!>).
625		1018
626	This is a composite request that tries to rename(2) the file first. If	1019	This is a composite request that tries to rename(2) the file first; if
627	rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if	1020	rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
628	that is successful, unlinking the C<$srcpath>.	1021	that is successful, unlinks the C<$srcpath>.
629		1022
630	=cut	1023	=cut
631		1024
632	sub aio_move($$;$) {	1025	sub aio_move($$;$) {
633	aio_block {
634	my ($src, $dst, $cb) = @_;	1026	my ($src, $dst, $cb) = @_;
635		1027
636	my $pri = aioreq_pri;	1028	my $pri = aioreq_pri;
637	my $grp = aio_group $cb;	1029	my $grp = aio_group $cb;
638		1030
639	aioreq_pri $pri;	1031	aioreq_pri $pri;
640	add $grp aio_rename $src, $dst, sub {	1032	add $grp aio_rename $src, $dst, sub {
641	if ($_[0] && $! == EXDEV) {	1033	if ($_[0] && $! == EXDEV) {
642	aioreq_pri $pri;	1034	aioreq_pri $pri;
643	add $grp aio_copy $src, $dst, sub {	1035	add $grp aio_copy $src, $dst, sub {
644	$grp->result ($_[0]);
645
646	if (!$_[0]) {
647	aioreq_pri $pri;
648	add $grp aio_unlink $src;
649	}
650	};
651	} else {
652	$grp->result ($_[0]);	1036	$grp->result ($_[0]);
		1037
		1038	unless ($_[0]) {
		1039	aioreq_pri $pri;
		1040	add $grp aio_unlink $src;
		1041	}
653	}	1042	};
		1043	} else {
		1044	$grp->result ($_[0]);
654	};	1045	}
655
656	$grp
657	}	1046	};
		1047
		1048	$grp
658	}	1049	}
659		1050
660	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1051	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
661		1052
662	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1053	Scans a directory (similar to C<aio_readdir>) but additionally tries to
663	efficiently separate the entries of directory C<$path> into two sets of	1054	efficiently separate the entries of directory C<$path> into two sets of
664	names, directories you can recurse into (directories), and ones you cannot	1055	names, directories you can recurse into (directories), and ones you cannot
665	recurse into (everything else, including symlinks to directories).	1056	recurse into (everything else, including symlinks to directories).
…		…
682		1073
683	Implementation notes.	1074	Implementation notes.
684		1075
685	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.	1076	The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
686		1077
		1078	If readdir returns file type information, then this is used directly to
		1079	find directories.
		1080
687	After reading the directory, the modification time, size etc. of the	1081	Otherwise, after reading the directory, the modification time, size etc.
688	directory before and after the readdir is checked, and if they match (and	1082	of the directory before and after the readdir is checked, and if they
689	isn't the current time), the link count will be used to decide how many	1083	match (and isn't the current time), the link count will be used to decide
690	entries are directories (if >= 2). Otherwise, no knowledge of the number	1084	how many entries are directories (if >= 2). Otherwise, no knowledge of the
691	of subdirectories will be assumed.	1085	number of subdirectories will be assumed.
692		1086
693	Then entries will be sorted into likely directories (everything without	1087	Then entries will be sorted into likely directories a non-initial dot
694	a non-initial dot currently) and likely non-directories (everything	1088	currently) and likely non-directories (see C<aio_readdirx>). Then every
695	else). Then every entry plus an appended C</.> will be C<stat>'ed,	1089	entry plus an appended C</.> will be C<stat>'ed, likely directories first,
696	likely directories first. If that succeeds, it assumes that the entry	1090	in order of their inode numbers. If that succeeds, it assumes that the
697	is a directory or a symlink to directory (which will be checked	1091	entry is a directory or a symlink to directory (which will be checked
698	seperately). This is often faster than stat'ing the entry itself because	1092	separately). This is often faster than stat'ing the entry itself because
699	filesystems might detect the type of the entry without reading the inode	1093	filesystems might detect the type of the entry without reading the inode
700	data (e.g. ext2fs filetype feature).	1094	data (e.g. ext2fs filetype feature), even on systems that cannot return
		1095	the filetype information on readdir.
701		1096
702	If the known number of directories (link count - 2) has been reached, the	1097	If the known number of directories (link count - 2) has been reached, the
703	rest of the entries is assumed to be non-directories.	1098	rest of the entries is assumed to be non-directories.
704		1099
705	This only works with certainty on POSIX (= UNIX) filesystems, which	1100	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
710	directory counting heuristic.	1105	directory counting heuristic.
711		1106
712	=cut	1107	=cut
713		1108
714	sub aio_scandir($$;$) {	1109	sub aio_scandir($$;$) {
715	aio_block {
716	my ($path, $maxreq, $cb) = @_;	1110	my ($path, $maxreq, $cb) = @_;
717		1111
718	my $pri = aioreq_pri;	1112	my $pri = aioreq_pri;
719		1113
720	my $grp = aio_group $cb;	1114	my $grp = aio_group $cb;
721		1115
722	$maxreq = 4 if $maxreq <= 0;	1116	$maxreq = 4 if $maxreq <= 0;
		1117
		1118	# get a wd object
		1119	aioreq_pri $pri;
		1120	add $grp aio_wd $path, sub {
		1121	$_[0]
		1122	or return $grp->result ();
		1123
		1124	my $wd = [shift, "."];
723		1125
724	# stat once	1126	# stat once
725	aioreq_pri $pri;	1127	aioreq_pri $pri;
726	add $grp aio_stat $path, sub {	1128	add $grp aio_stat $wd, sub {
727	return $grp->result () if $_[0];	1129	return $grp->result () if $_[0];
728	my $now = time;	1130	my $now = time;
729	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1131	my $hash1 = join ":", (stat _)[0,1,3,7,9];
730		1132
731	# read the directory entries	1133	# read the directory entries
732	aioreq_pri $pri;	1134	aioreq_pri $pri;
733	add $grp aio_readdir $path, sub {	1135	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
734	my $entries = shift	1136	my $entries = shift
735	or return $grp->result ();	1137	or return $grp->result ();
736		1138
737	# stat the dir another time	1139	# stat the dir another time
738	aioreq_pri $pri;	1140	aioreq_pri $pri;
739	add $grp aio_stat $path, sub {	1141	add $grp aio_stat $wd, sub {
740	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1142	my $hash2 = join ":", (stat _)[0,1,3,7,9];
741		1143
742	my $ndirs;	1144	my $ndirs;
743		1145
744	# take the slow route if anything looks fishy	1146	# take the slow route if anything looks fishy
745	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1147	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
746	$ndirs = -1;	1148	$ndirs = -1;
747	} else {	1149	} else {
748	# if nlink == 2, we are finished	1150	# if nlink == 2, we are finished
749	# on non-posix-fs's, we rely on nlink < 2	1151	# for non-posix-fs's, we rely on nlink < 2
750	$ndirs = (stat _)[3] - 2	1152	$ndirs = (stat _)[3] - 2
751	or return $grp->result ([], $entries);	1153	or return $grp->result ([], $entries);
752	}	1154	}
753		1155
754	# sort into likely dirs and likely nondirs
755	# dirs == files without ".", short entries first
756	$entries = [map $_->[0],
757	sort { $b->[1] cmp $a->[1] }
758	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
759	@$entries];
760
761	my (@dirs, @nondirs);	1156	my (@dirs, @nondirs);
762		1157
763	my $statgrp = add $grp aio_group sub {	1158	my $statgrp = add $grp aio_group sub {
764	$grp->result (\@dirs, \@nondirs);	1159	$grp->result (\@dirs, \@nondirs);
765	};	1160	};
766		1161
767	limit $statgrp $maxreq;	1162	limit $statgrp $maxreq;
768	feed $statgrp sub {	1163	feed $statgrp sub {
769	return unless @$entries;	1164	return unless @$entries;
770	my $entry = pop @$entries;	1165	my $entry = shift @$entries;
771		1166
772	aioreq_pri $pri;	1167	aioreq_pri $pri;
		1168	$wd->[1] = "$entry/.";
773	add $statgrp aio_stat "$path/$entry/.", sub {	1169	add $statgrp aio_stat $wd, sub {
774	if ($_[0] < 0) {	1170	if ($_[0] < 0) {
775	push @nondirs, $entry;	1171	push @nondirs, $entry;
776	} else {	1172	} else {
777	# need to check for real directory	1173	# need to check for real directory
778	aioreq_pri $pri;	1174	aioreq_pri $pri;
		1175	$wd->[1] = $entry;
779	add $statgrp aio_lstat "$path/$entry", sub {	1176	add $statgrp aio_lstat $wd, sub {
780	if (-d _) {	1177	if (-d _) {
781	push @dirs, $entry;	1178	push @dirs, $entry;
782		1179
783	unless (--$ndirs) {	1180	unless (--$ndirs) {
784	push @nondirs, @$entries;	1181	push @nondirs, @$entries;
…		…
792	};	1189	};
793	};	1190	};
794	};	1191	};
795	};	1192	};
796	};	1193	};
797
798	$grp
799	}	1194	};
		1195
		1196	$grp
800	}	1197	}
801		1198
802	=item aio_rmtree $path, $callback->($status)	1199	=item aio_rmtree $pathname, $callback->($status)
803		1200
804	Delete a directory tree starting (and including) C<$path>, return the	1201	Delete a directory tree starting (and including) C<$path>, return the
805	status of the final C<rmdir> only. This is a composite request that	1202	status of the final C<rmdir> only. This is a composite request that
806	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1203	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
807	everything else.	1204	everything else.
808		1205
809	=cut	1206	=cut
810		1207
811	sub aio_rmtree;	1208	sub aio_rmtree;
812	sub aio_rmtree($;$) {	1209	sub aio_rmtree($;$) {
813	aio_block {
814	my ($path, $cb) = @_;	1210	my ($path, $cb) = @_;
815		1211
816	my $pri = aioreq_pri;	1212	my $pri = aioreq_pri;
817	my $grp = aio_group $cb;	1213	my $grp = aio_group $cb;
818		1214
819	aioreq_pri $pri;	1215	aioreq_pri $pri;
820	add $grp aio_scandir $path, 0, sub {	1216	add $grp aio_scandir $path, 0, sub {
821	my ($dirs, $nondirs) = @_;	1217	my ($dirs, $nondirs) = @_;
822		1218
823	my $dirgrp = aio_group sub {	1219	my $dirgrp = aio_group sub {
824	add $grp aio_rmdir $path, sub {	1220	add $grp aio_rmdir $path, sub {
825	$grp->result ($_[0]);	1221	$grp->result ($_[0]);
826	};
827	};	1222	};
828
829	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
830	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
831
832	add $grp $dirgrp;
833	};	1223	};
834		1224
835	$grp	1225	(aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
		1226	(aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
		1227
		1228	add $grp $dirgrp;
836	}	1229	};
		1230
		1231	$grp
837	}	1232	}
		1233
		1234	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1235
		1236	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1237
		1238	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1239	they execute asynchronously and pass the return value to the callback.
		1240
		1241	Both calls can be used for a lot of things, some of which make more sense
		1242	to run asynchronously in their own thread, while some others make less
		1243	sense. For example, calls that block waiting for external events, such
		1244	as locking, will also lock down an I/O thread while it is waiting, which
		1245	can deadlock the whole I/O system. At the same time, there might be no
		1246	alternative to using a thread to wait.
		1247
		1248	So in general, you should only use these calls for things that do
		1249	(filesystem) I/O, not for things that wait for other events (network,
		1250	other processes), although if you are careful and know what you are doing,
		1251	you still can.
		1252
		1253	=item aio_sync $callback->($status)
		1254
		1255	Asynchronously call sync and call the callback when finished.
838		1256
839	=item aio_fsync $fh, $callback->($status)	1257	=item aio_fsync $fh, $callback->($status)
840		1258
841	Asynchronously call fsync on the given filehandle and call the callback	1259	Asynchronously call fsync on the given filehandle and call the callback
842	with the fsync result code.	1260	with the fsync result code.
…		…
846	Asynchronously call fdatasync on the given filehandle and call the	1264	Asynchronously call fdatasync on the given filehandle and call the
847	callback with the fdatasync result code.	1265	callback with the fdatasync result code.
848		1266
849	If this call isn't available because your OS lacks it or it couldn't be	1267	If this call isn't available because your OS lacks it or it couldn't be
850	detected, it will be emulated by calling C<fsync> instead.	1268	detected, it will be emulated by calling C<fsync> instead.
		1269
		1270	=item aio_syncfs $fh, $callback->($status)
		1271
		1272	Asynchronously call the syncfs syscall to sync the filesystem associated
		1273	to the given filehandle and call the callback with the syncfs result
		1274	code. If syncfs is not available, calls sync(), but returns C<-1> and sets
		1275	errno to C<ENOSYS> nevertheless.
		1276
		1277	=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		1278
		1279	Sync the data portion of the file specified by C<$offset> and C<$length>
		1280	to disk (but NOT the metadata), by calling the Linux-specific
		1281	sync_file_range call. If sync_file_range is not available or it returns
		1282	ENOSYS, then fdatasync or fsync is being substituted.
		1283
		1284	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
		1285	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
		1286	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
		1287	manpage for details.
		1288
		1289	=item aio_pathsync $pathname, $callback->($status)
		1290
		1291	This request tries to open, fsync and close the given path. This is a
		1292	composite request intended to sync directories after directory operations
		1293	(E.g. rename). This might not work on all operating systems or have any
		1294	specific effect, but usually it makes sure that directory changes get
		1295	written to disc. It works for anything that can be opened for read-only,
		1296	not just directories.
		1297
		1298	Future versions of this function might fall back to other methods when
		1299	C<fsync> on the directory fails (such as calling C<sync>).
		1300
		1301	Passes C<0> when everything went ok, and C<-1> on error.
		1302
		1303	=cut
		1304
		1305	sub aio_pathsync($;$) {
		1306	my ($path, $cb) = @_;
		1307
		1308	my $pri = aioreq_pri;
		1309	my $grp = aio_group $cb;
		1310
		1311	aioreq_pri $pri;
		1312	add $grp aio_open $path, O_RDONLY, 0, sub {
		1313	my ($fh) = @_;
		1314	if ($fh) {
		1315	aioreq_pri $pri;
		1316	add $grp aio_fsync $fh, sub {
		1317	$grp->result ($_[0]);
		1318
		1319	aioreq_pri $pri;
		1320	add $grp aio_close $fh;
		1321	};
		1322	} else {
		1323	$grp->result (-1);
		1324	}
		1325	};
		1326
		1327	$grp
		1328	}
		1329
		1330	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1331
		1332	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
		1333	scalars (see the C<IO::AIO::mmap> function, although it also works on data
		1334	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
		1335	scalar must only be modified in-place while an aio operation is pending on
		1336	it).
		1337
		1338	It calls the C<msync> function of your OS, if available, with the memory
		1339	area starting at C<$offset> in the string and ending C<$length> bytes
		1340	later. If C<$length> is negative, counts from the end, and if C<$length>
		1341	is C<undef>, then it goes till the end of the string. The flags can be
		1342	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
		1343	C<IO::AIO::MS_SYNC>.
		1344
		1345	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		1346
		1347	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1348	scalars.
		1349
		1350	It touches (reads or writes) all memory pages in the specified
		1351	range inside the scalar. All caveats and parameters are the same
		1352	as for C<aio_msync>, above, except for flags, which must be either
		1353	C<0> (which reads all pages and ensures they are instantiated) or
		1354	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
		1355	writing an octet from it, which dirties the page).
		1356
		1357	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		1358
		1359	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
		1360	scalars.
		1361
		1362	It reads in all the pages of the underlying storage into memory (if any)
		1363	and locks them, so they are not getting swapped/paged out or removed.
		1364
		1365	If C<$length> is undefined, then the scalar will be locked till the end.
		1366
		1367	On systems that do not implement C<mlock>, this function returns C<-1>
		1368	and sets errno to C<ENOSYS>.
		1369
		1370	Note that the corresponding C<munlock> is synchronous and is
		1371	documented under L<MISCELLANEOUS FUNCTIONS>.
		1372
		1373	Example: open a file, mmap and mlock it - both will be undone when
		1374	C<$data> gets destroyed.
		1375
		1376	open my $fh, "<", $path or die "$path: $!";
		1377	my $data;
		1378	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		1379	aio_mlock $data; # mlock in background
		1380
		1381	=item aio_mlockall $flags, $callback->($status)
		1382
		1383	Calls the C<mlockall> function with the given C<$flags> (a combination of
		1384	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
		1385
		1386	On systems that do not implement C<mlockall>, this function returns C<-1>
		1387	and sets errno to C<ENOSYS>.
		1388
		1389	Note that the corresponding C<munlockall> is synchronous and is
		1390	documented under L<MISCELLANEOUS FUNCTIONS>.
		1391
		1392	Example: asynchronously lock all current and future pages into memory.
		1393
		1394	aio_mlockall IO::AIO::MCL_FUTURE;
		1395
		1396	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1397
		1398	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1399	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1400	the ioctl is not available on your OS, then this request will fail with
		1401	C<ENOSYS>.
		1402
		1403	C<$start> is the starting offset to query extents for, C<$length> is the
		1404	size of the range to query - if it is C<undef>, then the whole file will
		1405	be queried.
		1406
		1407	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1408	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1409	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1410	the data portion.
		1411
		1412	C<$count> is the maximum number of extent records to return. If it is
		1413	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1414	case, if it is C<0>, then the callback receives the number of extents
		1415	instead of the extents themselves (which is unreliable, see below).
		1416
		1417	If an error occurs, the callback receives no arguments. The special
		1418	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1419
		1420	Otherwise, the callback receives an array reference with extent
		1421	structures. Each extent structure is an array reference itself, with the
		1422	following members:
		1423
		1424	[$logical, $physical, $length, $flags]
		1425
		1426	Flags is any combination of the following flag values (typically either C<0>
		1427	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1428
		1429	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1430	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1431	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1432	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1433	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1434	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1435
		1436	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1437	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1438	it to return all extents of a range for files with large number of
		1439	extents. The code works around all these issues if C<$count> is undef.
851		1440
852	=item aio_group $callback->(...)	1441	=item aio_group $callback->(...)
853		1442
854	This is a very special aio request: Instead of doing something, it is a	1443	This is a very special aio request: Instead of doing something, it is a
855	container for other aio requests, which is useful if you want to bundle	1444	container for other aio requests, which is useful if you want to bundle
…		…
893	immense (it blocks a thread for a long time) so do not use this function	1482	immense (it blocks a thread for a long time) so do not use this function
894	except to put your application under artificial I/O pressure.	1483	except to put your application under artificial I/O pressure.
895		1484
896	=back	1485	=back
897		1486
		1487
		1488	=head2 IO::AIO::WD - multiple working directories
		1489
		1490	Your process only has one current working directory, which is used by all
		1491	threads. This makes it hard to use relative paths (some other component
		1492	could call C<chdir> at any time, and it is hard to control when the path
		1493	will be used by IO::AIO).
		1494
		1495	One solution for this is to always use absolute paths. This usually works,
		1496	but can be quite slow (the kernel has to walk the whole path on every
		1497	access), and can also be a hassle to implement.
		1498
		1499	Newer POSIX systems have a number of functions (openat, fdopendir,
		1500	futimensat and so on) that make it possible to specify working directories
		1501	per operation.
		1502
		1503	For portability, and because the clowns who "designed", or shall I write,
		1504	perpetrated this new interface were obviously half-drunk, this abstraction
		1505	cannot be perfect, though.
		1506
		1507	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1508	object. This object stores the canonicalised, absolute version of the
		1509	path, and on systems that allow it, also a directory file descriptor.
		1510
		1511	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1512	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1513	object and a pathname instead (or the IO::AIO::WD object alone, which
		1514	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1515	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1516	to that IO::AIO::WD object.
		1517
		1518	For example, to get a wd object for F</etc> and then stat F<passwd>
		1519	inside, you would write:
		1520
		1521	aio_wd "/etc", sub {
		1522	my $etcdir = shift;
		1523
		1524	# although $etcdir can be undef on error, there is generally no reason
		1525	# to check for errors here, as aio_stat will fail with ENOENT
		1526	# when $etcdir is undef.
		1527
		1528	aio_stat [$etcdir, "passwd"], sub {
		1529	# yay
		1530	};
		1531	};
		1532
		1533	The fact that C<aio_wd> is a request and not a normal function shows that
		1534	creating an IO::AIO::WD object is itself a potentially blocking operation,
		1535	which is why it is done asynchronously.
		1536
		1537	To stat the directory obtained with C<aio_wd> above, one could write
		1538	either of the following three request calls:
		1539
		1540	aio_lstat "/etc" , sub { ... # pathname as normal string
		1541	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1542	aio_lstat $wd , sub { ... # shorthand for the previous
		1543
		1544	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1545	object and the pathname string, so you could write the following without
		1546	causing any issues due to C<$path> getting reused:
		1547
		1548	my $path = [$wd, undef];
		1549
		1550	for my $name (qw(abc def ghi)) {
		1551	$path->[1] = $name;
		1552	aio_stat $path, sub {
		1553	# ...
		1554	};
		1555	}
		1556
		1557	There are some caveats: when directories get renamed (or deleted), the
		1558	pathname string doesn't change, so will point to the new directory (or
		1559	nowhere at all), while the directory fd, if available on the system,
		1560	will still point to the original directory. Most functions accepting a
		1561	pathname will use the directory fd on newer systems, and the string on
		1562	older systems. Some functions (such as realpath) will always rely on the
		1563	string form of the pathname.
		1564
		1565	So this functionality is mainly useful to get some protection against
		1566	C<chdir>, to easily get an absolute path out of a relative path for future
		1567	reference, and to speed up doing many operations in the same directory
		1568	(e.g. when stat'ing all files in a directory).
		1569
		1570	The following functions implement this working directory abstraction:
		1571
		1572	=over 4
		1573
		1574	=item aio_wd $pathname, $callback->($wd)
		1575
		1576	Asynchonously canonicalise the given pathname and convert it to an
		1577	IO::AIO::WD object representing it. If possible and supported on the
		1578	system, also open a directory fd to speed up pathname resolution relative
		1579	to this working directory.
		1580
		1581	If something goes wrong, then C<undef> is passwd to the callback instead
		1582	of a working directory object and C<$!> is set appropriately. Since
		1583	passing C<undef> as working directory component of a pathname fails the
		1584	request with C<ENOENT>, there is often no need for error checking in the
		1585	C<aio_wd> callback, as future requests using the value will fail in the
		1586	expected way.
		1587
		1588	=item IO::AIO::CWD
		1589
		1590	This is a compiletime constant (object) that represents the process
		1591	current working directory.
		1592
		1593	Specifying this object as working directory object for a pathname is as if
		1594	the pathname would be specified directly, without a directory object. For
		1595	example, these calls are functionally identical:
		1596
		1597	aio_stat "somefile", sub { ... };
		1598	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1599
		1600	=back
		1601
		1602	To recover the path associated with an IO::AIO::WD object, you can use
		1603	C<aio_realpath>:
		1604
		1605	aio_realpath $wd, sub {
		1606	warn "path is $_[0]\n";
		1607	};
		1608
		1609	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1610	sometimes, fall back to using an absolue path.
		1611
898	=head2 IO::AIO::REQ CLASS	1612	=head2 IO::AIO::REQ CLASS
899		1613
900	All non-aggregate C<aio_*> functions return an object of this class when	1614	All non-aggregate C<aio_*> functions return an object of this class when
901	called in non-void context.	1615	called in non-void context.
902		1616
…		…
905	=item cancel $req	1619	=item cancel $req
906		1620
907	Cancels the request, if possible. Has the effect of skipping execution	1621	Cancels the request, if possible. Has the effect of skipping execution
908	when entering the B<execute> state and skipping calling the callback when	1622	when entering the B<execute> state and skipping calling the callback when
909	entering the the B<result> state, but will leave the request otherwise	1623	entering the the B<result> state, but will leave the request otherwise
910	untouched. That means that requests that currently execute will not be	1624	untouched (with the exception of readdir). That means that requests that
911	stopped and resources held by the request will not be freed prematurely.	1625	currently execute will not be stopped and resources held by the request
		1626	will not be freed prematurely.
912		1627
913	=item cb $req $callback->(...)	1628	=item cb $req $callback->(...)
914		1629
915	Replace (or simply set) the callback registered to the request.	1630	Replace (or simply set) the callback registered to the request.
916		1631
…		…
967	Their lifetime, simplified, looks like this: when they are empty, they	1682	Their lifetime, simplified, looks like this: when they are empty, they
968	will finish very quickly. If they contain only requests that are in the	1683	will finish very quickly. If they contain only requests that are in the
969	C<done> state, they will also finish. Otherwise they will continue to	1684	C<done> state, they will also finish. Otherwise they will continue to
970	exist.	1685	exist.
971		1686
972	That means after creating a group you have some time to add requests. And	1687	That means after creating a group you have some time to add requests
973	in the callbacks of those requests, you can add further requests to the	1688	(precisely before the callback has been invoked, which is only done within
974	group. And only when all those requests have finished will the the group	1689	the C<poll_cb>). And in the callbacks of those requests, you can add
975	itself finish.	1690	further requests to the group. And only when all those requests have
		1691	finished will the the group itself finish.
976		1692
977	=over 4	1693	=over 4
978		1694
979	=item add $grp ...	1695	=item add $grp ...
980		1696
…		…
989	=item $grp->cancel_subs	1705	=item $grp->cancel_subs
990		1706
991	Cancel all subrequests and clears any feeder, but not the group request	1707	Cancel all subrequests and clears any feeder, but not the group request
992	itself. Useful when you queued a lot of events but got a result early.	1708	itself. Useful when you queued a lot of events but got a result early.
993		1709
		1710	The group request will finish normally (you cannot add requests to the
		1711	group).
		1712
994	=item $grp->result (...)	1713	=item $grp->result (...)
995		1714
996	Set the result value(s) that will be passed to the group callback when all	1715	Set the result value(s) that will be passed to the group callback when all
997	subrequests have finished and set thre groups errno to the current value	1716	subrequests have finished and set the groups errno to the current value
998	of errno (just like calling C<errno> without an error number). By default,	1717	of errno (just like calling C<errno> without an error number). By default,
999	no argument will be passed and errno is zero.	1718	no argument will be passed and errno is zero.
1000		1719
1001	=item $grp->errno ([$errno])	1720	=item $grp->errno ([$errno])
1002		1721
…		…
1013	=item feed $grp $callback->($grp)	1732	=item feed $grp $callback->($grp)
1014		1733
1015	Sets a feeder/generator on this group: every group can have an attached	1734	Sets a feeder/generator on this group: every group can have an attached
1016	generator that generates requests if idle. The idea behind this is that,	1735	generator that generates requests if idle. The idea behind this is that,
1017	although you could just queue as many requests as you want in a group,	1736	although you could just queue as many requests as you want in a group,
1018	this might starve other requests for a potentially long time. For	1737	this might starve other requests for a potentially long time. For example,
1019	example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>	1738	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1020	requests, delaying any later requests for a long time.	1739	requests, delaying any later requests for a long time.
1021		1740
1022	To avoid this, and allow incremental generation of requests, you can	1741	To avoid this, and allow incremental generation of requests, you can
1023	instead a group and set a feeder on it that generates those requests. The	1742	instead a group and set a feeder on it that generates those requests. The
1024	feed callback will be called whenever there are few enough (see C<limit>,	1743	feed callback will be called whenever there are few enough (see C<limit>,
…		…
1029	not impose any limits).	1748	not impose any limits).
1030		1749
1031	If the feed does not queue more requests when called, it will be	1750	If the feed does not queue more requests when called, it will be
1032	automatically removed from the group.	1751	automatically removed from the group.
1033		1752
1034	If the feed limit is C<0>, it will be set to C<2> automatically.	1753	If the feed limit is C<0> when this method is called, it will be set to
		1754	C<2> automatically.
1035		1755
1036	Example:	1756	Example:
1037		1757
1038	# stat all files in @files, but only ever use four aio requests concurrently:	1758	# stat all files in @files, but only ever use four aio requests concurrently:
1039		1759
…		…
1051	Sets the feeder limit for the group: The feeder will be called whenever	1771	Sets the feeder limit for the group: The feeder will be called whenever
1052	the group contains less than this many requests.	1772	the group contains less than this many requests.
1053		1773
1054	Setting the limit to C<0> will pause the feeding process.	1774	Setting the limit to C<0> will pause the feeding process.
1055		1775
		1776	The default value for the limit is C<0>, but note that setting a feeder
		1777	automatically bumps it up to C<2>.
		1778
1056	=back	1779	=back
1057		1780
1058	=head2 SUPPORT FUNCTIONS	1781	=head2 SUPPORT FUNCTIONS
1059		1782
1060	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1783	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
…		…
1062	=over 4	1785	=over 4
1063		1786
1064	=item $fileno = IO::AIO::poll_fileno	1787	=item $fileno = IO::AIO::poll_fileno
1065		1788
1066	Return the I<request result pipe file descriptor>. This filehandle must be	1789	Return the I<request result pipe file descriptor>. This filehandle must be
1067	polled for reading by some mechanism outside this module (e.g. Event or	1790	polled for reading by some mechanism outside this module (e.g. EV, Glib,
1068	select, see below or the SYNOPSIS). If the pipe becomes readable you have	1791	select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1069	to call C<poll_cb> to check the results.	1792	you have to call C<poll_cb> to check the results.
1070		1793
1071	See C<poll_cb> for an example.	1794	See C<poll_cb> for an example.
1072		1795
1073	=item IO::AIO::poll_cb	1796	=item IO::AIO::poll_cb
1074		1797
1075	Process some outstanding events on the result pipe. You have to call this	1798	Process some requests that have reached the result phase (i.e. they have
1076	regularly. Returns the number of events processed. Returns immediately	1799	been executed but the results are not yet reported). You have to call
1077	when no events are outstanding. The amount of events processed depends on	1800	this "regularly" to finish outstanding requests.
1078	the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1079		1801
		1802	Returns C<0> if all events could be processed (or there were no
		1803	events to process), or C<-1> if it returned earlier for whatever
		1804	reason. Returns immediately when no events are outstanding. The amount
		1805	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
		1806	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
		1807
1080	If not all requests were processed for whatever reason, the filehandle	1808	If not all requests were processed for whatever reason, the poll file
1081	will still be ready when C<poll_cb> returns.	1809	descriptor will still be ready when C<poll_cb> returns, so normally you
		1810	don't have to do anything special to have it called later.
		1811
		1812	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
		1813	ready, it can be beneficial to call this function from loops which submit
		1814	a lot of requests, to make sure the results get processed when they become
		1815	available and not just when the loop is finished and the event loop takes
		1816	over again. This function returns very fast when there are no outstanding
		1817	requests.
1082		1818
1083	Example: Install an Event watcher that automatically calls	1819	Example: Install an Event watcher that automatically calls
1084	IO::AIO::poll_cb with high priority:	1820	IO::AIO::poll_cb with high priority (more examples can be found in the
		1821	SYNOPSIS section, at the top of this document):
1085		1822
1086	Event->io (fd => IO::AIO::poll_fileno,	1823	Event->io (fd => IO::AIO::poll_fileno,
1087	poll => 'r', async => 1,	1824	poll => 'r', async => 1,
1088	cb => \&IO::AIO::poll_cb);	1825	cb => \&IO::AIO::poll_cb);
		1826
		1827	=item IO::AIO::poll_wait
		1828
		1829	Wait until either at least one request is in the result phase or no
		1830	requests are outstanding anymore.
		1831
		1832	This is useful if you want to synchronously wait for some requests to
		1833	become ready, without actually handling them.
		1834
		1835	See C<nreqs> for an example.
		1836
		1837	=item IO::AIO::poll
		1838
		1839	Waits until some requests have been handled.
		1840
		1841	Returns the number of requests processed, but is otherwise strictly
		1842	equivalent to:
		1843
		1844	IO::AIO::poll_wait, IO::AIO::poll_cb
		1845
		1846	=item IO::AIO::flush
		1847
		1848	Wait till all outstanding AIO requests have been handled.
		1849
		1850	Strictly equivalent to:
		1851
		1852	IO::AIO::poll_wait, IO::AIO::poll_cb
		1853	while IO::AIO::nreqs;
1089		1854
1090	=item IO::AIO::max_poll_reqs $nreqs	1855	=item IO::AIO::max_poll_reqs $nreqs
1091		1856
1092	=item IO::AIO::max_poll_time $seconds	1857	=item IO::AIO::max_poll_time $seconds
1093		1858
…		…
1118	# use a low priority so other tasks have priority	1883	# use a low priority so other tasks have priority
1119	Event->io (fd => IO::AIO::poll_fileno,	1884	Event->io (fd => IO::AIO::poll_fileno,
1120	poll => 'r', nice => 1,	1885	poll => 'r', nice => 1,
1121	cb => &IO::AIO::poll_cb);	1886	cb => &IO::AIO::poll_cb);
1122		1887
1123	=item IO::AIO::poll_wait
1124
1125	If there are any outstanding requests and none of them in the result
1126	phase, wait till the result filehandle becomes ready for reading (simply
1127	does a C<select> on the filehandle. This is useful if you want to
1128	synchronously wait for some requests to finish).
1129
1130	See C<nreqs> for an example.
1131
1132	=item IO::AIO::poll
1133
1134	Waits until some requests have been handled.
1135
1136	Returns the number of requests processed, but is otherwise strictly
1137	equivalent to:
1138
1139	IO::AIO::poll_wait, IO::AIO::poll_cb
1140
1141	=item IO::AIO::flush
1142
1143	Wait till all outstanding AIO requests have been handled.
1144
1145	Strictly equivalent to:
1146
1147	IO::AIO::poll_wait, IO::AIO::poll_cb
1148	while IO::AIO::nreqs;
1149
1150	=back	1888	=back
1151		1889
1152	=head3 CONTROLLING THE NUMBER OF THREADS	1890	=head3 CONTROLLING THE NUMBER OF THREADS
1153		1891
1154	=over	1892	=over
…		…
1187		1925
1188	Under normal circumstances you don't need to call this function.	1926	Under normal circumstances you don't need to call this function.
1189		1927
1190	=item IO::AIO::max_idle $nthreads	1928	=item IO::AIO::max_idle $nthreads
1191		1929
1192	Limit the number of threads (default: 4) that are allowed to idle (i.e.,	1930	Limit the number of threads (default: 4) that are allowed to idle
1193	threads that did not get a request to process within 10 seconds). That	1931	(i.e., threads that did not get a request to process within the idle
1194	means if a thread becomes idle while C<$nthreads> other threads are also	1932	timeout (default: 10 seconds). That means if a thread becomes idle while
1195	idle, it will free its resources and exit.	1933	C<$nthreads> other threads are also idle, it will free its resources and
		1934	exit.
1196		1935
1197	This is useful when you allow a large number of threads (e.g. 100 or 1000)	1936	This is useful when you allow a large number of threads (e.g. 100 or 1000)
1198	to allow for extremely high load situations, but want to free resources	1937	to allow for extremely high load situations, but want to free resources
1199	under normal circumstances (1000 threads can easily consume 30MB of RAM).	1938	under normal circumstances (1000 threads can easily consume 30MB of RAM).
1200		1939
1201	The default is probably ok in most situations, especially if thread	1940	The default is probably ok in most situations, especially if thread
1202	creation is fast. If thread creation is very slow on your system you might	1941	creation is fast. If thread creation is very slow on your system you might
1203	want to use larger values.	1942	want to use larger values.
1204		1943
		1944	=item IO::AIO::idle_timeout $seconds
		1945
		1946	Sets the minimum idle timeout (default 10) after which worker threads are
		1947	allowed to exit. SEe C<IO::AIO::max_idle>.
		1948
1205	=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs	1949	=item IO::AIO::max_outstanding $maxreqs
		1950
		1951	Sets the maximum number of outstanding requests to C<$nreqs>. If
		1952	you do queue up more than this number of requests, the next call to
		1953	C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
		1954	C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
		1955	longer exceeded.
		1956
		1957	In other words, this setting does not enforce a queue limit, but can be
		1958	used to make poll functions block if the limit is exceeded.
1206		1959
1207	This is a very bad function to use in interactive programs because it	1960	This is a very bad function to use in interactive programs because it
1208	blocks, and a bad way to reduce concurrency because it is inexact: Better	1961	blocks, and a bad way to reduce concurrency because it is inexact: Better
1209	use an C<aio_group> together with a feed callback.	1962	use an C<aio_group> together with a feed callback.
1210		1963
1211	Sets the maximum number of outstanding requests to C<$nreqs>. If you	1964	Its main use is in scripts without an event loop - when you want to stat
1212	to queue up more than this number of requests, the next call to the	1965	a lot of files, you can write somehting like this:
1213	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1214	function will block until the limit is no longer exceeded.
1215		1966
1216	The default value is very large, so there is no practical limit on the	1967	IO::AIO::max_outstanding 32;
1217	number of outstanding requests.
1218		1968
1219	You can still queue as many requests as you want. Therefore,	1969	for my $path (...) {
1220	C<max_oustsanding> is mainly useful in simple scripts (with low values) or	1970	aio_stat $path , ...;
1221	as a stop gap to shield against fatal memory overflow (with large values).	1971	IO::AIO::poll_cb;
		1972	}
		1973
		1974	IO::AIO::flush;
		1975
		1976	The call to C<poll_cb> inside the loop will normally return instantly, but
		1977	as soon as more thna C<32> reqeusts are in-flight, it will block until
		1978	some requests have been handled. This keeps the loop from pushing a large
		1979	number of C<aio_stat> requests onto the queue.
		1980
		1981	The default value for C<max_outstanding> is very large, so there is no
		1982	practical limit on the number of outstanding requests.
1222		1983
1223	=back	1984	=back
1224		1985
1225	=head3 STATISTICAL INFORMATION	1986	=head3 STATISTICAL INFORMATION
1226		1987
…		…
1246	Returns the number of requests currently in the pending state (executed,	2007	Returns the number of requests currently in the pending state (executed,
1247	but not yet processed by poll_cb).	2008	but not yet processed by poll_cb).
1248		2009
1249	=back	2010	=back
1250		2011
		2012	=head3 MISCELLANEOUS FUNCTIONS
		2013
		2014	IO::AIO implements some functions that are useful when you want to use
		2015	some "Advanced I/O" function not available to in Perl, without going the
		2016	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2017	counterpart.
		2018
		2019	=over 4
		2020
		2021	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
		2022
		2023	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
		2024	but is blocking (this makes most sense if you know the input data is
		2025	likely cached already and the output filehandle is set to non-blocking
		2026	operations).
		2027
		2028	Returns the number of bytes copied, or C<-1> on error.
		2029
		2030	=item IO::AIO::fadvise $fh, $offset, $len, $advice
		2031
		2032	Simply calls the C<posix_fadvise> function (see its
		2033	manpage for details). The following advice constants are
		2034	available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
		2035	C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
		2036	C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
		2037
		2038	On systems that do not implement C<posix_fadvise>, this function returns
		2039	ENOSYS, otherwise the return value of C<posix_fadvise>.
		2040
		2041	=item IO::AIO::madvise $scalar, $offset, $len, $advice
		2042
		2043	Simply calls the C<posix_madvise> function (see its
		2044	manpage for details). The following advice constants are
		2045	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
		2046	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
		2047	C<IO::AIO::MADV_FREE>.
		2048
		2049	On systems that do not implement C<posix_madvise>, this function returns
		2050	ENOSYS, otherwise the return value of C<posix_madvise>.
		2051
		2052	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
		2053
		2054	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
		2055	$scalar (see its manpage for details). The following protect
		2056	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
		2057	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
		2058
		2059	On systems that do not implement C<mprotect>, this function returns
		2060	ENOSYS, otherwise the return value of C<mprotect>.
		2061
		2062	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		2063
		2064	Memory-maps a file (or anonymous memory range) and attaches it to the
		2065	given C<$scalar>, which will act like a string scalar. Returns true on
		2066	success, and false otherwise.
		2067
		2068	The only operations allowed on the scalar are C<substr>/C<vec> that don't
		2069	change the string length, and most read-only operations such as copying it
		2070	or searching it with regexes and so on.
		2071
		2072	Anything else is unsafe and will, at best, result in memory leaks.
		2073
		2074	The memory map associated with the C<$scalar> is automatically removed
		2075	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
		2076	C<IO::AIO::munmap> functions are called.
		2077
		2078	This calls the C<mmap>(2) function internally. See your system's manual
		2079	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
		2080
		2081	The C<$length> must be larger than zero and smaller than the actual
		2082	filesize.
		2083
		2084	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
		2085	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
		2086
		2087	C<$flags> can be a combination of
		2088	C<IO::AIO::MAP_SHARED> or
		2089	C<IO::AIO::MAP_PRIVATE>,
		2090	or a number of system-specific flags (when not available, the are C<0>):
		2091	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
		2092	C<IO::AIO::MAP_LOCKED>,
		2093	C<IO::AIO::MAP_NORESERVE>,
		2094	C<IO::AIO::MAP_POPULATE>,
		2095	C<IO::AIO::MAP_NONBLOCK>,
		2096	C<IO::AIO::MAP_FIXED>,
		2097	C<IO::AIO::MAP_GROWSDOWN>,
		2098	C<IO::AIO::MAP_32BIT>,
		2099	C<IO::AIO::MAP_HUGETLB> or
		2100	C<IO::AIO::MAP_STACK>.
		2101
		2102	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
		2103
		2104	C<$offset> is the offset from the start of the file - it generally must be
		2105	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
		2106
		2107	Example:
		2108
		2109	use Digest::MD5;
		2110	use IO::AIO;
		2111
		2112	open my $fh, "<verybigfile"
		2113	or die "$!";
		2114
		2115	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		2116	or die "verybigfile: $!";
		2117
		2118	my $fast_md5 = md5 $data;
		2119
		2120	=item IO::AIO::munmap $scalar
		2121
		2122	Removes a previous mmap and undefines the C<$scalar>.
		2123
		2124	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
		2125
		2126	Calls the C<munlock> function, undoing the effects of a previous
		2127	C<aio_mlock> call (see its description for details).
		2128
		2129	=item IO::AIO::munlockall
		2130
		2131	Calls the C<munlockall> function.
		2132
		2133	On systems that do not implement C<munlockall>, this function returns
		2134	ENOSYS, otherwise the return value of C<munlockall>.
		2135
		2136	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2137
		2138	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2139	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2140	should be the file offset.
		2141
		2142	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2143	silently corrupt the data in this case.
		2144
		2145	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2146	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2147	C<IO::AIO::SPLICE_F_GIFT>.
		2148
		2149	See the C<splice(2)> manpage for details.
		2150
		2151	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2152
		2153	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2154	description for C<IO::AIO::splice> above for details.
		2155
		2156	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2157
		2158	Attempts to query or change the pipe buffer size. Obviously works only
		2159	on pipes, and currently works only on GNU/Linux systems, and fails with
		2160	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2161	size on other systems, drop me a note.
		2162
		2163	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2164
		2165	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2166	C<$flags> is missing or C<0>, then this should be the same as a call to
		2167	perl's built-in C<pipe> function and create a new pipe, and works on
		2168	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2169	(..., 4096, O_BINARY)>.
		2170
		2171	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2172	the given flags (Linux 2.6.27, glibc 2.9).
		2173
		2174	On success, the read and write file handles are returned.
		2175
		2176	On error, nothing will be returned. If the pipe2 syscall is missing and
		2177	C<$flags> is non-zero, fails with C<ENOSYS>.
		2178
		2179	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2180	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2181	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2182
		2183	=back
		2184
1251	=cut	2185	=cut
1252		2186
1253	# support function to convert a fd into a perl filehandle
1254	sub _fd2fh {
1255	return undef if $_[0] < 0;
1256
1257	# try to generate nice filehandles
1258	my $sym = "IO::AIO::fd#$_[0]";
1259	local *$sym;
1260
1261	open *$sym, "+<&=$_[0]" # usually works under any unix
1262	or open *$sym, "<&=$_[0]" # cygwin needs this
1263	or open *$sym, ">&=$_[0]" # or this
1264	or return undef;
1265
1266	*$sym
1267	}
1268
1269	min_parallel 8;	2187	min_parallel 8;
1270		2188
1271	END { flush }	2189	END { flush }
1272		2190
1273	1;	2191	1;
1274		2192
		2193	=head1 EVENT LOOP INTEGRATION
		2194
		2195	It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
		2196	automatically into many event loops:
		2197
		2198	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		2199	use AnyEvent::AIO;
		2200
		2201	You can also integrate IO::AIO manually into many event loops, here are
		2202	some examples of how to do this:
		2203
		2204	# EV integration
		2205	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		2206
		2207	# Event integration
		2208	Event->io (fd => IO::AIO::poll_fileno,
		2209	poll => 'r',
		2210	cb => \&IO::AIO::poll_cb);
		2211
		2212	# Glib/Gtk2 integration
		2213	add_watch Glib::IO IO::AIO::poll_fileno,
		2214	in => sub { IO::AIO::poll_cb; 1 };
		2215
		2216	# Tk integration
		2217	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		2218	readable => \&IO::AIO::poll_cb);
		2219
		2220	# Danga::Socket integration
		2221	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		2222	\&IO::AIO::poll_cb);
		2223
1275	=head2 FORK BEHAVIOUR	2224	=head2 FORK BEHAVIOUR
1276		2225
1277	This module should do "the right thing" when the process using it forks:	2226	Usage of pthreads in a program changes the semantics of fork
		2227	considerably. Specifically, only async-safe functions can be called after
		2228	fork. Perl doesn't know about this, so in general, you cannot call fork
		2229	with defined behaviour in perl if pthreads are involved. IO::AIO uses
		2230	pthreads, so this applies, but many other extensions and (for inexplicable
		2231	reasons) perl itself often is linked against pthreads, so this limitation
		2232	applies to quite a lot of perls.
1278		2233
1279	Before the fork, IO::AIO enters a quiescent state where no requests	2234	This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1280	can be added in other threads and no results will be processed. After	2235	only works in the process that loaded it. Forking is fully supported, but
1281	the fork the parent simply leaves the quiescent state and continues	2236	using IO::AIO in the child is not.
1282	request/result processing, while the child frees the request/result queue
1283	(so that the requests started before the fork will only be handled in the
1284	parent). Threads will be started on demand until the limit set in the
1285	parent process has been reached again.
1286		2237
1287	In short: the parent will, after a short pause, continue as if fork had	2238	You might get around by not I<using> IO::AIO before (or after)
1288	not been called, while the child will act as if IO::AIO has not been used	2239	forking. You could also try to call the L<IO::AIO::reinit> function in the
1289	yet.	2240	child:
		2241
		2242	=over 4
		2243
		2244	=item IO::AIO::reinit
		2245
		2246	Abandons all current requests and I/O threads and simply reinitialises all
		2247	data structures. This is not an operation supported by any standards, but
		2248	happens to work on GNU/Linux and some newer BSD systems.
		2249
		2250	The only reasonable use for this function is to call it after forking, if
		2251	C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
		2252	the process will result in undefined behaviour. Calling it at any time
		2253	will also result in any undefined (by POSIX) behaviour.
		2254
		2255	=back
1290		2256
1291	=head2 MEMORY USAGE	2257	=head2 MEMORY USAGE
1292		2258
1293	Per-request usage:	2259	Per-request usage:
1294		2260
…		…
1311		2277
1312	Known bugs will be fixed in the next release.	2278	Known bugs will be fixed in the next release.
1313		2279
1314	=head1 SEE ALSO	2280	=head1 SEE ALSO
1315		2281
1316	L<Coro::AIO>.	2282	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		2283	more natural syntax.
1317		2284
1318	=head1 AUTHOR	2285	=head1 AUTHOR
1319		2286
1320	Marc Lehmann <schmorp@schmorp.de>	2287	Marc Lehmann <schmorp@schmorp.de>
1321	http://home.schmorp.de/	2288	http://home.schmorp.de/

Diff Legend

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