ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.85 by root, Sat Oct 28 01:40:30 2006 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) = @_;	10	my $fh = shift
		11	or die "/etc/passwd: $!";
11	...	12	...
12	};	13	};
13		14
14	aio_unlink "/tmp/file", sub { };	15	aio_unlink "/tmp/file", sub { };
15		16
…		…
25	$req->cancel; # cancel request if still in queue	26	$req->cancel; # cancel request if still in queue
26		27
27	my $grp = aio_group sub { print "all stats done\n" };	28	my $grp = aio_group sub { print "all stats done\n" };
28	add $grp aio_stat "..." for ...;	29	add $grp aio_stat "..." for ...;
29		30
30	# AnyEvent integration
31	open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
32	my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
33
34	# Event integration
35	Event->io (fd => IO::AIO::poll_fileno,
36	poll => 'r',
37	cb => \&IO::AIO::poll_cb);
38
39	# Glib/Gtk2 integration
40	add_watch Glib::IO IO::AIO::poll_fileno,
41	in => sub { IO::AIO::poll_cb; 1 };
42
43	# Tk integration
44	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
45	readable => \&IO::AIO::poll_cb);
46
47	# Danga::Socket integration
48	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
49	\&IO::AIO::poll_cb);
50
51	=head1 DESCRIPTION	31	=head1 DESCRIPTION
52		32
53	This module implements asynchronous I/O using whatever means your	33	This module implements asynchronous I/O using whatever means your
54	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>).
55		36
56	Asynchronous means that operations that can normally block your program	37	Asynchronous means that operations that can normally block your program
57	(e.g. reading from disk) will be done asynchronously: the operation	38	(e.g. reading from disk) will be done asynchronously: the operation
58	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
59	is extremely useful for programs that need to stay interactive even	40	is extremely useful for programs that need to stay interactive even
…		…
61	etc.), but can also be used to easily do operations in parallel that are	42	etc.), but can also be used to easily do operations in parallel that are
62	normally done sequentially, e.g. stat'ing many files, which is much faster	43	normally done sequentially, e.g. stat'ing many files, which is much faster
63	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
64	concurrently.	45	concurrently.
65		46
66	While this works on all types of file descriptors (for example sockets),	47	While most of this works on all types of file descriptors (for
67	using these functions on file descriptors that support nonblocking	48	example sockets), using these functions on file descriptors that
68	operation (again, sockets, pipes etc.) is very inefficient. Use an event	49	support nonblocking operation (again, sockets, pipes etc.) is
69	loop for that (such as the L<Event|Event> module): IO::AIO will naturally	50	very inefficient. Use an event loop for that (such as the L<EV>
70	fit into such an event loop itself.	51	module): IO::AIO will naturally fit into such an event loop itself.
71		52
72	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
73	requests and signal their completion. You don't need thread support	54	requests and signal their completion. You don't need thread support
74	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
75	to perl. In the future, this module might make use of the native aio	56	to perl. In the future, this module might make use of the native aio
…		…
77	not well-supported or restricted (GNU/Linux doesn't allow them on normal	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
78	files currently, for example), and they would only support aio_read and	59	files currently, for example), and they would only support aio_read and
79	aio_write, so the remaining functionality would have to be implemented	60	aio_write, so the remaining functionality would have to be implemented
80	using threads anyway.	61	using threads anyway.
81		62
82	Although the module will work with in the presence of other (Perl-)	63	Although the module will work in the presence of other (Perl-) threads,
83	threads, it is currently not reentrant in any way, so use appropriate	64	it is currently not reentrant in any way, so use appropriate locking
84	locking yourself, always call C<poll_cb> from within the same thread, or	65	yourself, always call C<poll_cb> from within the same thread, or never
85	never call C<poll_cb> (or other C<aio_> functions) recursively.	66	call C<poll_cb> (or other C<aio_> functions) recursively.
		67
		68	=head2 EXAMPLE
		69
		70	This is a simple example that uses the EV module and loads
		71	F</etc/passwd> asynchronously:
		72
		73	use EV;
		74	use IO::AIO;
		75
		76	# register the IO::AIO callback with EV
		77	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		78
		79	# queue the request to open /etc/passwd
		80	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
		81	my $fh = shift
		82	or die "error while opening: $!";
		83
		84	# stat'ing filehandles is generally non-blocking
		85	my $size = -s $fh;
		86
		87	# queue a request to read the file
		88	my $contents;
		89	aio_read $fh, 0, $size, $contents, 0, sub {
		90	$_[0] == $size
		91	or die "short read: $!";
		92
		93	close $fh;
		94
		95	# file contents now in $contents
		96	print $contents;
		97
		98	# exit event loop and program
		99	EV::break;
		100	};
		101	};
		102
		103	# possibly queue up other requests, or open GUI windows,
		104	# check for sockets etc. etc.
		105
		106	# process events as long as there are some:
		107	EV::run;
86		108
87	=head1 REQUEST ANATOMY AND LIFETIME	109	=head1 REQUEST ANATOMY AND LIFETIME
88		110
89	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
90	directly visible to Perl.	112	directly visible to Perl.
…		…
132	Request has reached the end of its lifetime and holds no resources anymore	154	Request has reached the end of its lifetime and holds no resources anymore
133	(except possibly for the Perl object, but its connection to the actual	155	(except possibly for the Perl object, but its connection to the actual
134	aio request is severed and calling its methods will either do nothing or	156	aio request is severed and calling its methods will either do nothing or
135	result in a runtime error).	157	result in a runtime error).
136		158
		159	=back
		160
137	=cut	161	=cut
138		162
139	package IO::AIO;	163	package IO::AIO;
140		164
141	no warnings;	165	use Carp ();
142	use strict 'vars';	166
		167	use common::sense;
143		168
144	use base 'Exporter';	169	use base 'Exporter';
145		170
146	BEGIN {	171	BEGIN {
147	our $VERSION = '2.0';	172	our $VERSION = 4.34;
148		173
149	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
150	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
151	aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move	176	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
152	aio_copy aio_group aio_nop aio_mknod);	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
		180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
		181	aio_chmod aio_utime aio_truncate
		182	aio_msync aio_mtouch aio_mlock aio_mlockall
		183	aio_statvfs
		184	aio_wd);
		185
153	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	186	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
154	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	187	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
155	min_parallel max_parallel nreqs nready npending);	188	min_parallel max_parallel max_idle idle_timeout
		189	nreqs nready npending nthreads
		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
156		195
157	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	196	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
158		197
159	require XSLoader;	198	require XSLoader;
160	XSLoader::load ("IO::AIO", $VERSION);	199	XSLoader::load ("IO::AIO", $VERSION);
161	}	200	}
162		201
163	=head1 FUNCTIONS	202	=head1 FUNCTIONS
164		203
165	=head2 AIO 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
166		288
167	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
168	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,
169	and they all accept an additional (and optional) C<$callback> argument	291	and they all accept an additional (and optional) C<$callback> argument
170	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
171	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
172	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
173	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>.
174		301
175	All functions expecting a filehandle keep a copy of the filehandle	302	All functions expecting a filehandle keep a copy of the filehandle
176	internally until the request has finished.	303	internally until the request has finished.
177		304
178	All requests return objects of type L<IO::AIO::REQ> that allow further	305	All functions return request objects of type L<IO::AIO::REQ> that allow
179	manipulation of those requests while they are in-flight.	306	further manipulation of those requests while they are in-flight.
180		307
181	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
182	encoded in byte form. 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
183	request is being executed, the current working directory could have	310	current working directory could have changed. Alternatively, you can
184	changed. Alternatively, you can make sure that you never change the	311	make sure that you never change the current working directory anywhere
185	current working directory.	312	in the program and then use relative paths. You can also take advantage
		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.
186		316
187	To encode pathnames to byte form, either make sure you either: a)	317	To encode pathnames as octets, either make sure you either: a) always pass
188	always pass in filenames you got from outside (command line, readdir	318	in filenames you got from outside (command line, readdir etc.) without
189	etc.), 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
190	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
191	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
192	use something else.	322	unicode filenames or e) use something else to ensure your scalar has the
		323	correct contents.
		324
		325	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
		326	handles correctly whether it is set or not.
		327
		328	=head2 AIO REQUEST FUNCTIONS
193		329
194	=over 4	330	=over 4
195		331
196	=item $prev_pri = aioreq_pri [$pri]	332	=item $prev_pri = aioreq_pri [$pri]
197		333
…		…
217	aio_read $_[0], ..., sub {	353	aio_read $_[0], ..., sub {
218	...	354	...
219	};	355	};
220	};	356	};
221		357
		358
222	=item aioreq_nice $pri_adjust	359	=item aioreq_nice $pri_adjust
223		360
224	Similar to C<aioreq_pri>, but subtracts the given value from the current	361	Similar to C<aioreq_pri>, but subtracts the given value from the current
225	priority, so effects are cumulative.	362	priority, so the effect is cumulative.
		363
226		364
227	=item aio_open $pathname, $flags, $mode, $callback->($fh)	365	=item aio_open $pathname, $flags, $mode, $callback->($fh)
228		366
229	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
230	created filehandle for the file.	368	created filehandle for the file (or C<undef> in case of an error).
231		369
232	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,
233	for an explanation.	371	for an explanation.
234		372
235	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
236	list. They are the same as used by C<sysopen>.	374	list. They are the same as used by C<sysopen>.
237		375
238	Likewise, C<$mode> specifies the mode of the newly created file, if it	376	Likewise, C<$mode> specifies the mode of the newly created file, if it
239	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	377	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
240	except that it is mandatory (i.e. use C<0> if you don't create new files,	378	except that it is mandatory (i.e. use C<0> if you don't create new files,
241	and C<0666> or C<0777> if you do).	379	and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
		380	by the umask in effect then the request is being executed, so better never
		381	change the umask.
242		382
243	Example:	383	Example:
244		384
245	aio_open "/etc/passwd", O_RDONLY, 0, sub {	385	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
246	if ($_[0]) {	386	if ($_[0]) {
247	print "open successful, fh is $_[0]\n";	387	print "open successful, fh is $_[0]\n";
248	...	388	...
249	} else {	389	} else {
250	die "open failed: $!\n";	390	die "open failed: $!\n";
251	}	391	}
252	};	392	};
253		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
		403
254	=item aio_close $fh, $callback->($status)	404	=item aio_close $fh, $callback->($status)
255		405
256	Asynchronously close a file and call the callback with the result	406	Asynchronously close a file and call the callback with the result
257	code. I<WARNING:> although accepted, you should not pass in a perl	407	code.
258	filehandle here, as perl will likely close the file descriptor another
259	time when the filehandle is destroyed. Normally, you can safely call perls
260	C<close> or just let filehandles go out of scope.
261		408
262	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
263	therefore best to avoid this function.	410	closing the file descriptor associated with the filehandle itself.
		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".
264		440
265	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	441	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
266		442
267	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	443	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
268		444
269	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
270	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>
271	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
272	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.
		452
		453	If C<$offset> is undefined, then the current file descriptor offset will
		454	be used (and updated), otherwise the file descriptor offset will not be
		455	changed by these calls.
		456
		457	If C<$length> is undefined in C<aio_write>, use the remaining length of
		458	C<$data>.
		459
		460	If C<$dataoffset> is less than zero, it will be counted from the end of
		461	C<$data>.
273		462
274	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
275	is outstanding. Modifying it can result in segfaults or WW3 (if the	464	is outstanding. Modifying it can result in segfaults or World War III (if
276	necessary/optional hardware is installed).	465	the necessary/optional hardware is installed).
277		466
278	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at	467	Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
279	offset C<0> within the scalar:	468	offset C<0> within the scalar:
280		469
281	aio_read $fh, 7, 15, $buffer, 0, sub {	470	aio_read $fh, 7, 15, $buffer, 0, sub {
282	$_[0] > 0 or die "read error: $!";	471	$_[0] > 0 or die "read error: $!";
283	print "read $_[0] bytes: <$buffer>\n";	472	print "read $_[0] bytes: <$buffer>\n";
284	};	473	};
285		474
		475
286	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	476	=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
287		477
288	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
289	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
290	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
291	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
292	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>.
293		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
294	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
295	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
296	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.
297		504
298	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>,
299	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
300	regardless of the limitations of the operating system.	508	type of filehandle regardless of the limitations of the operating system.
301		509
302	Please note, however, that C<aio_sendfile> can read more bytes from	510	As native sendfile syscalls (as practically any non-POSIX interface hacked
303	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
304	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
305	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,
306	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> -
307	read.	515	fewer bytes than expected might have been transferred.
		516
308		517
309	=item aio_readahead $fh,$offset,$length, $callback->($retval)	518	=item aio_readahead $fh,$offset,$length, $callback->($retval)
310		519
311	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
312	subsequent reads from that file will not block on disk I/O. The C<$offset>	521	subsequent reads from that file will not block on disk I/O. The C<$offset>
…		…
315	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
316	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
317	(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
318	file. The current file offset of the file is left unchanged.	527	file. The current file offset of the file is left unchanged.
319		528
320	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
321	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.
		531
322		532
323	=item aio_stat $fh_or_path, $callback->($status)	533	=item aio_stat $fh_or_path, $callback->($status)
324		534
325	=item aio_lstat $fh, $callback->($status)	535	=item aio_lstat $fh, $callback->($status)
326		536
…		…
332	for an explanation.	542	for an explanation.
333		543
334	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
335	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
336	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>.
337		556
338	Example: Print the length of F</etc/passwd>:	557	Example: Print the length of F</etc/passwd>:
339		558
340	aio_stat "/etc/passwd", sub {	559	aio_stat "/etc/passwd", sub {
341	$_[0] and die "stat failed: $!";	560	$_[0] and die "stat failed: $!";
342	print "size is ", -s _, "\n";	561	print "size is ", -s _, "\n";
343	};	562	};
344		563
		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
		694	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		695
		696	Works like perl's C<utime> function (including the special case of $atime
		697	and $mtime being undef). Fractional times are supported if the underlying
		698	syscalls support them.
		699
		700	When called with a pathname, uses utimes(2) if available, otherwise
		701	utime(2). If called on a file descriptor, uses futimes(2) if available,
		702	otherwise returns ENOSYS, so this is not portable.
		703
		704	Examples:
		705
		706	# set atime and mtime to current time (basically touch(1)):
		707	aio_utime "path", undef, undef;
		708	# set atime to current time and mtime to beginning of the epoch:
		709	aio_utime "path", time, undef; # undef==0
		710
		711
		712	=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		713
		714	Works like perl's C<chown> function, except that C<undef> for either $uid
		715	or $gid is being interpreted as "do not change" (but -1 can also be used).
		716
		717	Examples:
		718
		719	# same as "chown root path" in the shell:
		720	aio_chown "path", 0, -1;
		721	# same as above:
		722	aio_chown "path", 0, undef;
		723
		724
		725	=item aio_truncate $fh_or_path, $offset, $callback->($status)
		726
		727	Works like truncate(2) or ftruncate(2).
		728
		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
		750	=item aio_chmod $fh_or_path, $mode, $callback->($status)
		751
		752	Works like perl's C<chmod> function.
		753
		754
345	=item aio_unlink $pathname, $callback->($status)	755	=item aio_unlink $pathname, $callback->($status)
346		756
347	Asynchronously unlink (delete) a file and call the callback with the	757	Asynchronously unlink (delete) a file and call the callback with the
348	result code.	758	result code.
349		759
		760
350	=item aio_mknod $path, $mode, $dev, $callback->($status)	761	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
		762
		763	[EXPERIMENTAL]
351		764
352	Asynchronously create a device node (or fifo). See mknod(2).	765	Asynchronously create a device node (or fifo). See mknod(2).
353		766
354	The only portable (POSIX) way of calling this function is:	767	The only (POSIX-) portable way of calling this function is:
355		768
356	aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...	769	aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
		770
		771	See C<aio_stat> for info about some potentially helpful extra constants
		772	and functions.
357		773
358	=item aio_link $srcpath, $dstpath, $callback->($status)	774	=item aio_link $srcpath, $dstpath, $callback->($status)
359		775
360	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
361	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.
362		778
		779
363	=item aio_symlink $srcpath, $dstpath, $callback->($status)	780	=item aio_symlink $srcpath, $dstpath, $callback->($status)
364		781
365	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
366	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.
367		784
		785
		786	=item aio_readlink $pathname, $callback->($link)
		787
		788	Asynchronously read the symlink specified by C<$path> and pass it to
		789	the callback. If an error occurs, nothing or undef gets passed to the
		790	callback.
		791
		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
368	=item aio_rename $srcpath, $dstpath, $callback->($status)	803	=item aio_rename $srcpath, $dstpath, $callback->($status)
369		804
370	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
371	rename(2) and call the callback with the result code.	806	rename(2) and call the callback with the result code.
372		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>.
		811
		812
		813	=item aio_mkdir $pathname, $mode, $callback->($status)
		814
		815	Asynchronously mkdir (create) a directory and call the callback with
		816	the result code. C<$mode> will be modified by the umask at the time the
		817	request is executed, so do not change your umask.
		818
		819
373	=item aio_rmdir $pathname, $callback->($status)	820	=item aio_rmdir $pathname, $callback->($status)
374		821
375	Asynchronously rmdir (delete) a directory and call the callback with the	822	Asynchronously rmdir (delete) a directory and call the callback with the
376	result code.	823	result code.
		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
377		829
378	=item aio_readdir $pathname, $callback->($entries)	830	=item aio_readdir $pathname, $callback->($entries)
379		831
380	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
381	directory (i.e. opendir + readdir + closedir). The entries will not be	833	directory (i.e. opendir + readdir + closedir). The entries will not be
382	sorted, and will B<NOT> include the C<.> and C<..> entries.	834	sorted, and will B<NOT> include the C<.> and C<..> entries.
383		835
384	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
385	with the filenames.	837	array-ref with the filenames.
		838
		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
		906	=item aio_load $pathname, $data, $callback->($status)
		907
		908	This is a composite request that tries to fully load the given file into
		909	memory. Status is the same as with aio_read.
		910
		911	=cut
		912
		913	sub aio_load($$;$) {
		914	my ($path, undef, $cb) = @_;
		915	my $data = \$_[1];
		916
		917	my $pri = aioreq_pri;
		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);
		924
		925	aioreq_pri $pri;
		926	add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
		927	$grp->result ($_[0]);
		928	};
		929	};
		930
		931	$grp
		932	}
386		933
387	=item aio_copy $srcpath, $dstpath, $callback->($status)	934	=item aio_copy $srcpath, $dstpath, $callback->($status)
388		935
389	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
390	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
391	the C<0> (error) or C<-1> ok.	938	a status of C<0> (ok) or C<-1> (error, see C<$!>).
392		939
393	This is a composite request that it creates the destination file with	940	This is a composite request that creates the destination file with
394	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
395	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	942	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
396	uid/gid, in that order.	943	uid/gid, in that order.
397		944
398	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
…		…
408	my $grp = aio_group $cb;	955	my $grp = aio_group $cb;
409		956
410	aioreq_pri $pri;	957	aioreq_pri $pri;
411	add $grp aio_open $src, O_RDONLY, 0, sub {	958	add $grp aio_open $src, O_RDONLY, 0, sub {
412	if (my $src_fh = $_[0]) {	959	if (my $src_fh = $_[0]) {
413	my @stat = stat $src_fh;	960	my @stat = stat $src_fh; # hmm, might block over nfs?
414		961
415	aioreq_pri $pri;	962	aioreq_pri $pri;
416	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 {
417	if (my $dst_fh = $_[0]) {	964	if (my $dst_fh = $_[0]) {
418	aioreq_pri $pri;	965	aioreq_pri $pri;
419	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 {
420	if ($_[0] == $stat[7]) {	967	if ($_[0] == $stat[7]) {
421	$grp->result (0);	968	$grp->result (0);
422	close $src_fh;	969	close $src_fh;
423		970
424	# those should not normally block. should. should.	971	my $ch = sub {
		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;
		977	add $grp aio_close $dst_fh;
		978	}
		979	};
		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;
425	utime $stat[8], $stat[9], $dst;	986	add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
426	chmod $stat[2] & 07777, $dst_fh;	987	} else {
427	chown $stat[4], $stat[5], $dst_fh;	988	$ch->();
		989	}
428	close $dst_fh;	990	};
429	} else {	991	} else {
430	$grp->result (-1);	992	$grp->result (-1);
431	close $src_fh;	993	close $src_fh;
432	close $dst_fh;	994	close $dst_fh;
433		995
…		…
450		1012
451	=item aio_move $srcpath, $dstpath, $callback->($status)	1013	=item aio_move $srcpath, $dstpath, $callback->($status)
452		1014
453	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
454	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
455	the C<0> (error) or C<-1> ok.	1017	a status of C<0> (ok) or C<-1> (error, see C<$!>).
456		1018
457	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
458	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
459	that is successful, unlinking the C<$srcpath>.	1021	that is successful, unlinks the C<$srcpath>.
460		1022
461	=cut	1023	=cut
462		1024
463	sub aio_move($$;$) {	1025	sub aio_move($$;$) {
464	my ($src, $dst, $cb) = @_;	1026	my ($src, $dst, $cb) = @_;
…		…
471	if ($_[0] && $! == EXDEV) {	1033	if ($_[0] && $! == EXDEV) {
472	aioreq_pri $pri;	1034	aioreq_pri $pri;
473	add $grp aio_copy $src, $dst, sub {	1035	add $grp aio_copy $src, $dst, sub {
474	$grp->result ($_[0]);	1036	$grp->result ($_[0]);
475		1037
476	if (!$_[0]) {	1038	unless ($_[0]) {
477	aioreq_pri $pri;	1039	aioreq_pri $pri;
478	add $grp aio_unlink $src;	1040	add $grp aio_unlink $src;
479	}	1041	}
480	};	1042	};
481	} else {	1043	} else {
…		…
484	};	1046	};
485		1047
486	$grp	1048	$grp
487	}	1049	}
488		1050
489	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1051	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
490		1052
491	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
492	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
493	names, directories you can recurse into (directories), and ones you cannot	1055	names, directories you can recurse into (directories), and ones you cannot
494	recurse into (everything else, including symlinks to directories).	1056	recurse into (everything else, including symlinks to directories).
…		…
511		1073
512	Implementation notes.	1074	Implementation notes.
513		1075
514	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.
515		1077
		1078	If readdir returns file type information, then this is used directly to
		1079	find directories.
		1080
516	After reading the directory, the modification time, size etc. of the	1081	Otherwise, after reading the directory, the modification time, size etc.
517	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
518	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
519	entries are directories (if >= 2). Otherwise, no knowledge of the number	1084	how many entries are directories (if >= 2). Otherwise, no knowledge of the
520	of subdirectories will be assumed.	1085	number of subdirectories will be assumed.
521		1086
522	Then entries will be sorted into likely directories (everything without	1087	Then entries will be sorted into likely directories a non-initial dot
523	a non-initial dot currently) and likely non-directories (everything	1088	currently) and likely non-directories (see C<aio_readdirx>). Then every
524	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,
525	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
526	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
527	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
528	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
529	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.
530		1096
531	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
532	rest of the entries is assumed to be non-directories.	1098	rest of the entries is assumed to be non-directories.
533		1099
534	This only works with certainty on POSIX (= UNIX) filesystems, which	1100	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
538	as those tend to return 0 or 1 as link counts, which disables the	1104	as those tend to return 0 or 1 as link counts, which disables the
539	directory counting heuristic.	1105	directory counting heuristic.
540		1106
541	=cut	1107	=cut
542		1108
543	sub aio_scandir($$$) {	1109	sub aio_scandir($$;$) {
544	my ($path, $maxreq, $cb) = @_;	1110	my ($path, $maxreq, $cb) = @_;
545		1111
546	my $pri = aioreq_pri;	1112	my $pri = aioreq_pri;
547		1113
548	my $grp = aio_group $cb;	1114	my $grp = aio_group $cb;
549		1115
550	$maxreq = 4 if $maxreq <= 0;	1116	$maxreq = 4 if $maxreq <= 0;
551		1117
552	# stat once	1118	# get a wd object
553	aioreq_pri $pri;	1119	aioreq_pri $pri;
554	add $grp aio_stat $path, sub {	1120	add $grp aio_wd $path, sub {
		1121	$_[0]
555	return $grp->result () if $_[0];	1122	or return $grp->result ();
556	my $now = time;
557	my $hash1 = join ":", (stat _)[0,1,3,7,9];
558		1123
559	# read the directory entries	1124	my $wd = [shift, "."];
		1125
		1126	# stat once
560	aioreq_pri $pri;	1127	aioreq_pri $pri;
561	add $grp aio_readdir $path, sub {	1128	add $grp aio_stat $wd, sub {
562	my $entries = shift
563	or return $grp->result ();	1129	return $grp->result () if $_[0];
		1130	my $now = time;
		1131	my $hash1 = join ":", (stat _)[0,1,3,7,9];
564		1132
565	# stat the dir another time	1133	# read the directory entries
566	aioreq_pri $pri;	1134	aioreq_pri $pri;
		1135	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1136	my $entries = shift
		1137	or return $grp->result ();
		1138
		1139	# stat the dir another time
		1140	aioreq_pri $pri;
567	add $grp aio_stat $path, sub {	1141	add $grp aio_stat $wd, sub {
568	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1142	my $hash2 = join ":", (stat _)[0,1,3,7,9];
569		1143
570	my $ndirs;	1144	my $ndirs;
571		1145
572	# take the slow route if anything looks fishy	1146	# take the slow route if anything looks fishy
573	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1147	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
574	$ndirs = -1;	1148	$ndirs = -1;
575	} else {	1149	} else {
576	# if nlink == 2, we are finished	1150	# if nlink == 2, we are finished
577	# on non-posix-fs's, we rely on nlink < 2	1151	# for non-posix-fs's, we rely on nlink < 2
578	$ndirs = (stat _)[3] - 2	1152	$ndirs = (stat _)[3] - 2
579	or return $grp->result ([], $entries);	1153	or return $grp->result ([], $entries);
580	}	1154	}
581		1155
582	# sort into likely dirs and likely nondirs
583	# dirs == files without ".", short entries first
584	$entries = [map $_->[0],
585	sort { $b->[1] cmp $a->[1] }
586	map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
587	@$entries];
588
589	my (@dirs, @nondirs);	1156	my (@dirs, @nondirs);
590		1157
591	my $statgrp = add $grp aio_group sub {	1158	my $statgrp = add $grp aio_group sub {
592	$grp->result (\@dirs, \@nondirs);	1159	$grp->result (\@dirs, \@nondirs);
593	};	1160	};
594		1161
595	limit $statgrp $maxreq;	1162	limit $statgrp $maxreq;
596	feed $statgrp sub {	1163	feed $statgrp sub {
597	return unless @$entries;	1164	return unless @$entries;
598	my $entry = pop @$entries;	1165	my $entry = shift @$entries;
599		1166
600	aioreq_pri $pri;	1167	aioreq_pri $pri;
		1168	$wd->[1] = "$entry/.";
601	add $statgrp aio_stat "$path/$entry/.", sub {	1169	add $statgrp aio_stat $wd, sub {
602	if ($_[0] < 0) {	1170	if ($_[0] < 0) {
603	push @nondirs, $entry;	1171	push @nondirs, $entry;
604	} else {	1172	} else {
605	# need to check for real directory	1173	# need to check for real directory
606	aioreq_pri $pri;	1174	aioreq_pri $pri;
		1175	$wd->[1] = $entry;
607	add $statgrp aio_lstat "$path/$entry", sub {	1176	add $statgrp aio_lstat $wd, sub {
608	if (-d _) {	1177	if (-d _) {
609	push @dirs, $entry;	1178	push @dirs, $entry;
610		1179
611	unless (--$ndirs) {	1180	unless (--$ndirs) {
612	push @nondirs, @$entries;	1181	push @nondirs, @$entries;
613	feed $statgrp;	1182	feed $statgrp;
		1183	}
		1184	} else {
		1185	push @nondirs, $entry;
614	}	1186	}
615	} else {
616	push @nondirs, $entry;
617	}	1187	}
618	}	1188	}
619	}	1189	};
620	};	1190	};
621	};	1191	};
622	};	1192	};
623	};	1193	};
624	};	1194	};
625		1195
626	$grp	1196	$grp
627	}	1197	}
628		1198
		1199	=item aio_rmtree $pathname, $callback->($status)
		1200
		1201	Delete a directory tree starting (and including) C<$path>, return the
		1202	status of the final C<rmdir> only. This is a composite request that
		1203	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
		1204	everything else.
		1205
		1206	=cut
		1207
		1208	sub aio_rmtree;
		1209	sub aio_rmtree($;$) {
		1210	my ($path, $cb) = @_;
		1211
		1212	my $pri = aioreq_pri;
		1213	my $grp = aio_group $cb;
		1214
		1215	aioreq_pri $pri;
		1216	add $grp aio_scandir $path, 0, sub {
		1217	my ($dirs, $nondirs) = @_;
		1218
		1219	my $dirgrp = aio_group sub {
		1220	add $grp aio_rmdir $path, sub {
		1221	$grp->result ($_[0]);
		1222	};
		1223	};
		1224
		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;
		1229	};
		1230
		1231	$grp
		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.
		1256
629	=item aio_fsync $fh, $callback->($status)	1257	=item aio_fsync $fh, $callback->($status)
630		1258
631	Asynchronously call fsync on the given filehandle and call the callback	1259	Asynchronously call fsync on the given filehandle and call the callback
632	with the fsync result code.	1260	with the fsync result code.
633		1261
…		…
636	Asynchronously call fdatasync on the given filehandle and call the	1264	Asynchronously call fdatasync on the given filehandle and call the
637	callback with the fdatasync result code.	1265	callback with the fdatasync result code.
638		1266
639	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
640	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.
641		1440
642	=item aio_group $callback->(...)	1441	=item aio_group $callback->(...)
643		1442
644	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
645	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
…		…
683	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
684	except to put your application under artificial I/O pressure.	1483	except to put your application under artificial I/O pressure.
685		1484
686	=back	1485	=back
687		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
688	=head2 IO::AIO::REQ CLASS	1612	=head2 IO::AIO::REQ CLASS
689		1613
690	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
691	called in non-void context.	1615	called in non-void context.
692		1616
…		…
695	=item cancel $req	1619	=item cancel $req
696		1620
697	Cancels the request, if possible. Has the effect of skipping execution	1621	Cancels the request, if possible. Has the effect of skipping execution
698	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
699	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
700	untouched. That means that requests that currently execute will not be	1624	untouched (with the exception of readdir). That means that requests that
701	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.
702		1627
703	=item cb $req $callback->(...)	1628	=item cb $req $callback->(...)
704		1629
705	Replace (or simply set) the callback registered to the request.	1630	Replace (or simply set) the callback registered to the request.
706		1631
…		…
757	Their lifetime, simplified, looks like this: when they are empty, they	1682	Their lifetime, simplified, looks like this: when they are empty, they
758	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
759	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
760	exist.	1685	exist.
761		1686
762	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
763	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
764	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
765	itself finish.	1690	further requests to the group. And only when all those requests have
		1691	finished will the the group itself finish.
766		1692
767	=over 4	1693	=over 4
768		1694
769	=item add $grp ...	1695	=item add $grp ...
770		1696
…		…
779	=item $grp->cancel_subs	1705	=item $grp->cancel_subs
780		1706
781	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
782	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.
783		1709
		1710	The group request will finish normally (you cannot add requests to the
		1711	group).
		1712
784	=item $grp->result (...)	1713	=item $grp->result (...)
785		1714
786	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
787	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
788	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,
789	no argument will be passed and errno is zero.	1718	no argument will be passed and errno is zero.
790		1719
791	=item $grp->errno ([$errno])	1720	=item $grp->errno ([$errno])
792		1721
…		…
803	=item feed $grp $callback->($grp)	1732	=item feed $grp $callback->($grp)
804		1733
805	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
806	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,
807	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,
808	this might starve other requests for a potentially long time. For	1737	this might starve other requests for a potentially long time. For example,
809	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>
810	requests, delaying any later requests for a long time.	1739	requests, delaying any later requests for a long time.
811		1740
812	To avoid this, and allow incremental generation of requests, you can	1741	To avoid this, and allow incremental generation of requests, you can
813	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
814	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>,
…		…
819	not impose any limits).	1748	not impose any limits).
820		1749
821	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
822	automatically removed from the group.	1751	automatically removed from the group.
823		1752
824	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.
825		1755
826	Example:	1756	Example:
827		1757
828	# 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:
829		1759
…		…
841	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
842	the group contains less than this many requests.	1772	the group contains less than this many requests.
843		1773
844	Setting the limit to C<0> will pause the feeding process.	1774	Setting the limit to C<0> will pause the feeding process.
845		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
846	=back	1779	=back
847		1780
848	=head2 SUPPORT FUNCTIONS	1781	=head2 SUPPORT FUNCTIONS
849		1782
		1783	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
		1784
850	=over 4	1785	=over 4
851		1786
852	=item $fileno = IO::AIO::poll_fileno	1787	=item $fileno = IO::AIO::poll_fileno
853		1788
854	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
855	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,
856	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
857	to call C<poll_cb> to check the results.	1792	you have to call C<poll_cb> to check the results.
858		1793
859	See C<poll_cb> for an example.	1794	See C<poll_cb> for an example.
860		1795
861	=item IO::AIO::poll_cb	1796	=item IO::AIO::poll_cb
862		1797
863	Process all 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
864	regularly. Returns the number of events processed. Returns immediately	1799	been executed but the results are not yet reported). You have to call
865	when no events are outstanding.	1800	this "regularly" to finish outstanding requests.
866		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
867	If not all requests were processed for whatever reason, the filehandle	1808	If not all requests were processed for whatever reason, the poll file
868	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.
869		1818
870	Example: Install an Event watcher that automatically calls	1819	Example: Install an Event watcher that automatically calls
871	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):
872		1822
873	Event->io (fd => IO::AIO::poll_fileno,	1823	Event->io (fd => IO::AIO::poll_fileno,
874	poll => 'r', async => 1,	1824	poll => 'r', async => 1,
875	cb => \&IO::AIO::poll_cb);	1825	cb => \&IO::AIO::poll_cb);
876		1826
877	=item IO::AIO::poll_some $max_requests	1827	=item IO::AIO::poll_wait
878		1828
879	Similar to C<poll_cb>, but only processes up to C<$max_requests> requests	1829	Wait until either at least one request is in the result phase or no
880	at a time.	1830	requests are outstanding anymore.
881		1831
882	Useful if you want to ensure some level of interactiveness when perl is	1832	This is useful if you want to synchronously wait for some requests to
883	not fast enough to process all requests in time.	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;
		1854
		1855	=item IO::AIO::max_poll_reqs $nreqs
		1856
		1857	=item IO::AIO::max_poll_time $seconds
		1858
		1859	These set the maximum number of requests (default C<0>, meaning infinity)
		1860	that are being processed by C<IO::AIO::poll_cb> in one call, respectively
		1861	the maximum amount of time (default C<0>, meaning infinity) spent in
		1862	C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
		1863	of time C<poll_cb> is allowed to use).
		1864
		1865	Setting C<max_poll_time> to a non-zero value creates an overhead of one
		1866	syscall per request processed, which is not normally a problem unless your
		1867	callbacks are really really fast or your OS is really really slow (I am
		1868	not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
		1869
		1870	Setting these is useful if you want to ensure some level of
		1871	interactiveness when perl is not fast enough to process all requests in
		1872	time.
		1873
		1874	For interactive programs, values such as C<0.01> to C<0.1> should be fine.
884		1875
885	Example: Install an Event watcher that automatically calls	1876	Example: Install an Event watcher that automatically calls
886	IO::AIO::poll_some with low priority, to ensure that other parts of the	1877	IO::AIO::poll_cb with low priority, to ensure that other parts of the
887	program get the CPU sometimes even under high AIO load.	1878	program get the CPU sometimes even under high AIO load.
888		1879
		1880	# try not to spend much more than 0.1s in poll_cb
		1881	IO::AIO::max_poll_time 0.1;
		1882
		1883	# use a low priority so other tasks have priority
889	Event->io (fd => IO::AIO::poll_fileno,	1884	Event->io (fd => IO::AIO::poll_fileno,
890	poll => 'r', nice => 1,	1885	poll => 'r', nice => 1,
891	cb => sub { IO::AIO::poll_some 256 });	1886	cb => &IO::AIO::poll_cb);
892		1887
893	=item IO::AIO::poll_wait	1888	=back
894		1889
895	Wait till the result filehandle becomes ready for reading (simply does a	1890	=head3 CONTROLLING THE NUMBER OF THREADS
896	C<select> on the filehandle. This is useful if you want to synchronously wait
897	for some requests to finish).
898		1891
899	See C<nreqs> for an example.	1892	=over
900
901	=item IO::AIO::nreqs
902
903	Returns the number of requests currently in the ready, execute or pending
904	states (i.e. for which their callback has not been invoked yet).
905
906	Example: wait till there are no outstanding requests anymore:
907
908	IO::AIO::poll_wait, IO::AIO::poll_cb
909	while IO::AIO::nreqs;
910
911	=item IO::AIO::nready
912
913	Returns the number of requests currently in the ready state (not yet
914	executed).
915
916	=item IO::AIO::npending
917
918	Returns the number of requests currently in the pending state (executed,
919	but not yet processed by poll_cb).
920
921	=item IO::AIO::flush
922
923	Wait till all outstanding AIO requests have been handled.
924
925	Strictly equivalent to:
926
927	IO::AIO::poll_wait, IO::AIO::poll_cb
928	while IO::AIO::nreqs;
929
930	=item IO::AIO::poll
931
932	Waits until some requests have been handled.
933
934	Strictly equivalent to:
935
936	IO::AIO::poll_wait, IO::AIO::poll_cb
937	if IO::AIO::nreqs;
938		1893
939	=item IO::AIO::min_parallel $nthreads	1894	=item IO::AIO::min_parallel $nthreads
940		1895
941	Set the minimum number of AIO threads to C<$nthreads>. The current	1896	Set the minimum number of AIO threads to C<$nthreads>. The current
942	default is C<8>, which means eight asynchronous operations can execute	1897	default is C<8>, which means eight asynchronous operations can execute
943	concurrently at any one time (the number of outstanding requests,	1898	concurrently at any one time (the number of outstanding requests,
944	however, is unlimited).	1899	however, is unlimited).
945		1900
946	IO::AIO starts threads only on demand, when an AIO request is queued and	1901	IO::AIO starts threads only on demand, when an AIO request is queued and
947	no free thread exists.	1902	no free thread exists. Please note that queueing up a hundred requests can
		1903	create demand for a hundred threads, even if it turns out that everything
		1904	is in the cache and could have been processed faster by a single thread.
948		1905
949	It is recommended to keep the number of threads relatively low, as some	1906	It is recommended to keep the number of threads relatively low, as some
950	Linux kernel versions will scale negatively with the number of threads	1907	Linux kernel versions will scale negatively with the number of threads
951	(higher parallelity => MUCH higher latency). With current Linux 2.6	1908	(higher parallelity => MUCH higher latency). With current Linux 2.6
952	versions, 4-32 threads should be fine.	1909	versions, 4-32 threads should be fine.
…		…
966	This module automatically runs C<max_parallel 0> at program end, to ensure	1923	This module automatically runs C<max_parallel 0> at program end, to ensure
967	that all threads are killed and that there are no outstanding requests.	1924	that all threads are killed and that there are no outstanding requests.
968		1925
969	Under normal circumstances you don't need to call this function.	1926	Under normal circumstances you don't need to call this function.
970		1927
		1928	=item IO::AIO::max_idle $nthreads
		1929
		1930	Limit the number of threads (default: 4) that are allowed to idle
		1931	(i.e., threads that did not get a request to process within the idle
		1932	timeout (default: 10 seconds). That means if a thread becomes idle while
		1933	C<$nthreads> other threads are also idle, it will free its resources and
		1934	exit.
		1935
		1936	This is useful when you allow a large number of threads (e.g. 100 or 1000)
		1937	to allow for extremely high load situations, but want to free resources
		1938	under normal circumstances (1000 threads can easily consume 30MB of RAM).
		1939
		1940	The default is probably ok in most situations, especially if thread
		1941	creation is fast. If thread creation is very slow on your system you might
		1942	want to use larger values.
		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
971	=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.
972		1959
973	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
974	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
975	use an C<aio_group> together with a feed callback.	1962	use an C<aio_group> together with a feed callback.
976		1963
977	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
978	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:
979	C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
980	function will block until the limit is no longer exceeded.
981		1966
982	The default value is very large, so there is no practical limit on the	1967	IO::AIO::max_outstanding 32;
983	number of outstanding requests.
984		1968
985	You can still queue as many requests as you want. Therefore,	1969	for my $path (...) {
986	C<max_oustsanding> is mainly useful in simple scripts (with low values) or	1970	aio_stat $path , ...;
987	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.
988		1983
989	=back	1984	=back
990		1985
		1986	=head3 STATISTICAL INFORMATION
		1987
		1988	=over
		1989
		1990	=item IO::AIO::nreqs
		1991
		1992	Returns the number of requests currently in the ready, execute or pending
		1993	states (i.e. for which their callback has not been invoked yet).
		1994
		1995	Example: wait till there are no outstanding requests anymore:
		1996
		1997	IO::AIO::poll_wait, IO::AIO::poll_cb
		1998	while IO::AIO::nreqs;
		1999
		2000	=item IO::AIO::nready
		2001
		2002	Returns the number of requests currently in the ready state (not yet
		2003	executed).
		2004
		2005	=item IO::AIO::npending
		2006
		2007	Returns the number of requests currently in the pending state (executed,
		2008	but not yet processed by poll_cb).
		2009
		2010	=back
		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
991	=cut	2185	=cut
992		2186
993	# support function to convert a fd into a perl filehandle
994	sub _fd2fh {
995	return undef if $_[0] < 0;
996
997	# try to generate nice filehandles
998	my $sym = "IO::AIO::fd#$_[0]";
999	local *$sym;
1000
1001	open *$sym, "+<&=$_[0]" # usually works under any unix
1002	or open *$sym, "<&=$_[0]" # cygwin needs this
1003	or open *$sym, ">&=$_[0]" # or this
1004	or return undef;
1005
1006	*$sym
1007	}
1008
1009	min_parallel 8;	2187	min_parallel 8;
1010		2188
1011	END {	2189	END { flush }
1012	min_parallel 1;
1013	flush;
1014	};
1015		2190
1016	1;	2191	1;
1017		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
1018	=head2 FORK BEHAVIOUR	2224	=head2 FORK BEHAVIOUR
1019		2225
1020	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.
1021		2233
1022	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
1023	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
1024	the fork the parent simply leaves the quiescent state and continues	2236	using IO::AIO in the child is not.
1025	request/result processing, while the child frees the request/result queue
1026	(so that the requests started before the fork will only be handled in the
1027	parent). Threads will be started on demand until the limit set in the
1028	parent process has been reached again.
1029		2237
1030	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)
1031	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
1032	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
1033		2256
1034	=head2 MEMORY USAGE	2257	=head2 MEMORY USAGE
1035		2258
1036	Per-request usage:	2259	Per-request usage:
1037		2260
…		…
1039	bytes of memory. In addition, stat requests need a stat buffer (possibly	2262	bytes of memory. In addition, stat requests need a stat buffer (possibly
1040	a few hundred bytes), readdir requires a result buffer and so on. Perl	2263	a few hundred bytes), readdir requires a result buffer and so on. Perl
1041	scalars and other data passed into aio requests will also be locked and	2264	scalars and other data passed into aio requests will also be locked and
1042	will consume memory till the request has entered the done state.	2265	will consume memory till the request has entered the done state.
1043		2266
1044	This is now awfully much, so queuing lots of requests is not usually a	2267	This is not awfully much, so queuing lots of requests is not usually a
1045	problem.	2268	problem.
1046		2269
1047	Per-thread usage:	2270	Per-thread usage:
1048		2271
1049	In the execution phase, some aio requests require more memory for	2272	In the execution phase, some aio requests require more memory for
…		…
1054		2277
1055	Known bugs will be fixed in the next release.	2278	Known bugs will be fixed in the next release.
1056		2279
1057	=head1 SEE ALSO	2280	=head1 SEE ALSO
1058		2281
1059	L<Coro::AIO>.	2282	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
		2283	more natural syntax.
1060		2284
1061	=head1 AUTHOR	2285	=head1 AUTHOR
1062		2286
1063	Marc Lehmann <schmorp@schmorp.de>	2287	Marc Lehmann <schmorp@schmorp.de>
1064	http://home.schmorp.de/	2288	http://home.schmorp.de/

Diff Legend

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